Rev 2898 | Rev 2903 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 2898 | Rev 2899 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2008 Jiri Svoboda |
2 | * Copyright (c) 2008 Jiri Svoboda |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
13 | * documentation and/or other materials provided with the distribution. |
14 | * - The name of the author may not be used to endorse or promote products |
14 | * - The name of the author may not be used to endorse or promote products |
15 | * derived from this software without specific prior written permission. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup generic |
29 | /** @addtogroup generic |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | /** @file |
32 | /** @file |
33 | */ |
33 | */ |
34 | 34 | ||
35 | #ifndef KERN_UDEBUG_H_ |
35 | #ifndef KERN_UDEBUG_H_ |
36 | #define KERN_UDEBUG_H_ |
36 | #define KERN_UDEBUG_H_ |
37 | 37 | ||
38 | typedef enum { /* udebug_method_t */ |
38 | typedef enum { /* udebug_method_t */ |
39 | 39 | ||
40 | /** Start debugging the recipient. |
40 | /** Start debugging the recipient. |
41 | * Causes all threads in the receiving task to stop. When they |
41 | * Causes all threads in the receiving task to stop. When they |
42 | * are all stoped, an answer with retval 0 is generated. |
42 | * are all stoped, an answer with retval 0 is generated. |
43 | */ |
43 | */ |
44 | UDEBUG_M_BEGIN = 1, |
44 | UDEBUG_M_BEGIN = 1, |
45 | 45 | ||
46 | /** Finish debugging the recipient. |
46 | /** Finish debugging the recipient. |
47 | * Answers all pending GO and GUARD messages. |
47 | * Answers all pending GO and GUARD messages. |
48 | */ |
48 | */ |
49 | UDEBUG_M_END, |
49 | UDEBUG_M_END, |
50 | 50 | ||
- | 51 | /** Set which events should be captured. |
|
- | 52 | */ |
|
- | 53 | UDEBUG_M_SET_EVMASK, |
|
- | 54 | ||
51 | /** Make sure the debugged task is still there. |
55 | /** Make sure the debugged task is still there. |
52 | * This message is answered when the debugged task dies |
56 | * This message is answered when the debugged task dies |
53 | * or the debugging session ends. |
57 | * or the debugging session ends. |
54 | */ |
58 | */ |
55 | UDEBUG_M_GUARD, |
59 | UDEBUG_M_GUARD, |
56 | 60 | ||
57 | /** Run a thread until a debugging event occurs. |
61 | /** Run a thread until a debugging event occurs. |
58 | * This message is answered when the thread stops |
62 | * This message is answered when the thread stops |
59 | * in a debugging event. |
63 | * in a debugging event. |
60 | * |
64 | * |
61 | * - ARG2 - id of the thread to run |
65 | * - ARG2 - id of the thread to run |
62 | */ |
66 | */ |
63 | UDEBUG_M_GO, |
67 | UDEBUG_M_GO, |
64 | 68 | ||
65 | /** Stop a thread being debugged. |
69 | /** Stop a thread being debugged. |
66 | * Creates a special STOP event in the thread, causing |
70 | * Creates a special STOP event in the thread, causing |
67 | * it to answer a pending GO message (if any). |
71 | * it to answer a pending GO message (if any). |
68 | */ |
72 | */ |
69 | UDEBUG_M_STOP, |
73 | UDEBUG_M_STOP, |
70 | 74 | ||
71 | /** Read arguments of a syscall. |
75 | /** Read arguments of a syscall. |
72 | * |
76 | * |
73 | * - ARG2 - thread identification |
77 | * - ARG2 - thread identification |
74 | * - ARG3 - destination address in the caller's address space |
78 | * - ARG3 - destination address in the caller's address space |
75 | * |
79 | * |
76 | */ |
80 | */ |
77 | UDEBUG_M_ARGS_READ, |
81 | UDEBUG_M_ARGS_READ, |
78 | 82 | ||
79 | /** Read thread's userspace register state (istate_t). |
83 | /** Read thread's userspace register state (istate_t). |
80 | * |
84 | * |
81 | * - ARG2 - thread identification |
85 | * - ARG2 - thread identification |
82 | * - ARG3 - destination address in the caller's address space |
86 | * - ARG3 - destination address in the caller's address space |
83 | * - ARG4 - size of receiving buffer in bytes |
87 | * - ARG4 - size of receiving buffer in bytes |
84 | * |
88 | * |
85 | * on answer, the kernel will set: |
89 | * on answer, the kernel will set: |
86 | * |
90 | * |
87 | * - ARG1 - actual size in bytes of data read |
91 | * - ARG1 - actual size in bytes of data read |
88 | * - ARG2 - total size in bytes of data available |
92 | * - ARG2 - total size in bytes of data available |
89 | * |
93 | * |
90 | * or, on error, retval will be |
94 | * or, on error, retval will be |
91 | * - ENOENT - thread does not exist |
95 | * - ENOENT - thread does not exist |
92 | * - EBUSY - register state not available |
96 | * - EBUSY - register state not available |
93 | */ |
97 | */ |
94 | UDEBUG_M_REGS_READ, |
98 | UDEBUG_M_REGS_READ, |
95 | 99 | ||
96 | /** Write thread's userspace register state (istate_t). |
100 | /** Write thread's userspace register state (istate_t). |
97 | * |
101 | * |
98 | * - ARG2 - thread identification |
102 | * - ARG2 - thread identification |
99 | * - ARG3 - source address in the caller's address space |
103 | * - ARG3 - source address in the caller's address space |
100 | * - ARG4 - size of source data in bytes |
104 | * - ARG4 - size of source data in bytes |
101 | * |
105 | * |
102 | * on answer, the kernel will set: |
106 | * on answer, the kernel will set: |
103 | * |
107 | * |
104 | * - ARG1 - actual size in bytes of data copied |
108 | * - ARG1 - actual size in bytes of data copied |
105 | * - ARG2 - max size in bytes that could have been copied |
109 | * - ARG2 - max size in bytes that could have been copied |
106 | * |
110 | * |
107 | * or, on error, retval will be |
111 | * or, on error, retval will be |
108 | * - ENOENT - thread does not exist |
112 | * - ENOENT - thread does not exist |
109 | * - EBUSY - register state not available |
113 | * - EBUSY - register state not available |
110 | */ |
114 | */ |
111 | UDEBUG_M_REGS_WRITE, |
115 | UDEBUG_M_REGS_WRITE, |
112 | 116 | ||
113 | /** Read the list of the debugged tasks's threads. |
117 | /** Read the list of the debugged tasks's threads. |
114 | * |
118 | * |
115 | * - ARG2 - destination address in the caller's address space |
119 | * - ARG2 - destination address in the caller's address space |
116 | * - ARG3 - size of receiving buffer in bytes |
120 | * - ARG3 - size of receiving buffer in bytes |
117 | * |
121 | * |
118 | * The kernel fills the buffer with a series of sysarg_t values |
122 | * The kernel fills the buffer with a series of sysarg_t values |
119 | * (thread ids). On answer, the kernel will set: |
123 | * (thread ids). On answer, the kernel will set: |
120 | * |
124 | * |
121 | * - ARG2 - number of bytes that were actually copied |
125 | * - ARG2 - number of bytes that were actually copied |
122 | * - ARG3 - number of bytes of the complete data |
126 | * - ARG3 - number of bytes of the complete data |
123 | * |
127 | * |
124 | */ |
128 | */ |
125 | UDEBUG_M_THREAD_READ, |
129 | UDEBUG_M_THREAD_READ, |
126 | 130 | ||
127 | /** Read the debugged tasks's memory. |
131 | /** Read the debugged tasks's memory. |
128 | * |
132 | * |
129 | * - ARG2 - destination address in the caller's address space |
133 | * - ARG2 - destination address in the caller's address space |
130 | * - ARG3 - source address in the recipient's address space |
134 | * - ARG3 - source address in the recipient's address space |
131 | * - ARG4 - size of receiving buffer in bytes |
135 | * - ARG4 - size of receiving buffer in bytes |
132 | * |
136 | * |
133 | */ |
137 | */ |
134 | UDEBUG_M_MEM_READ, |
138 | UDEBUG_M_MEM_READ, |
135 | 139 | ||
136 | /** Write the debugged tasks's memory. |
140 | /** Write the debugged tasks's memory. |
137 | * |
141 | * |
138 | * - ARG2 - source address in the caller's address space |
142 | * - ARG2 - source address in the caller's address space |
139 | * - ARG3 - destination address in the recipient's address space |
143 | * - ARG3 - destination address in the recipient's address space |
140 | * - ARG4 - size of receiving buffer in bytes |
144 | * - ARG4 - size of receiving buffer in bytes |
141 | * |
145 | * |
142 | */ |
146 | */ |
143 | UDEBUG_M_MEM_WRITE |
147 | UDEBUG_M_MEM_WRITE |
144 | 148 | ||
145 | 149 | ||
146 | } udebug_method_t; |
150 | } udebug_method_t; |
147 | 151 | ||
148 | 152 | ||
149 | typedef enum { |
153 | typedef enum { |
150 | UDEBUG_EVENT_FINISHED = 1, /**< Debuging session has finished */ |
154 | UDEBUG_EVENT_FINISHED = 1, /**< Debuging session has finished */ |
151 | UDEBUG_EVENT_STOP, /**< Stopped on DEBUG_STOP request */ |
155 | UDEBUG_EVENT_STOP, /**< Stopped on DEBUG_STOP request */ |
152 | UDEBUG_EVENT_SYSCALL, /**< A syscall has been executed */ |
156 | UDEBUG_EVENT_SYSCALL, /**< A syscall has been executed */ |
153 | UDEBUG_EVENT_NEW_THREAD /**< The task created a new thread */ |
157 | UDEBUG_EVENT_NEW_THREAD /**< The task created a new thread */ |
154 | } udebug_event_t; |
158 | } udebug_event_t; |
155 | 159 | ||
- | 160 | #define UDEBUG_EVMASK(event) (1 << ((event) - 1)) |
|
- | 161 | ||
- | 162 | typedef enum { |
|
- | 163 | UDEBUG_EM_FINISHED = UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED), |
|
- | 164 | UDEBUG_EM_STOP = UDEBUG_EVMASK(UDEBUG_EVENT_STOP), |
|
- | 165 | UDEBUG_EM_SYSCALL = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL), |
|
- | 166 | UDEBUG_EM_NEW_THREAD = UDEBUG_EVMASK(UDEBUG_EVENT_NEW_THREAD), |
|
- | 167 | UDEBUG_EM_ALL = |
|
- | 168 | UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED) | |
|
- | 169 | UDEBUG_EVMASK(UDEBUG_EVENT_STOP) | |
|
- | 170 | UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL) | |
|
- | 171 | UDEBUG_EVMASK(UDEBUG_EVENT_NEW_THREAD) |
|
- | 172 | } udebug_evmask_t; |
|
- | 173 | ||
156 | #ifdef KERNEL |
174 | #ifdef KERNEL |
157 | 175 | ||
158 | typedef enum { |
176 | typedef enum { |
159 | /** Task is not being debugged */ |
177 | /** Task is not being debugged */ |
160 | UDEBUG_TS_INACTIVE, |
178 | UDEBUG_TS_INACTIVE, |
161 | /** BEGIN operation in progress (waiting for threads to stop) */ |
179 | /** BEGIN operation in progress (waiting for threads to stop) */ |
162 | UDEBUG_TS_BEGINNING, |
180 | UDEBUG_TS_BEGINNING, |
163 | /** Debugger fully connected */ |
181 | /** Debugger fully connected */ |
164 | UDEBUG_TS_ACTIVE, |
182 | UDEBUG_TS_ACTIVE, |
165 | /** Task is shutting down, no more debug activities allowed */ |
183 | /** Task is shutting down, no more debug activities allowed */ |
166 | UDEBUG_TS_SHUTDOWN |
184 | UDEBUG_TS_SHUTDOWN |
167 | } udebug_task_state_t; |
185 | } udebug_task_state_t; |
168 | 186 | ||
169 | struct task; |
187 | struct task; |
170 | struct thread; |
188 | struct thread; |
171 | 189 | ||
172 | void udebug_syscall_event(unative_t a1, unative_t a2, unative_t a3, |
190 | void udebug_syscall_event(unative_t a1, unative_t a2, unative_t a3, |
173 | unative_t a4, unative_t a5, unative_t a6, unative_t id, unative_t rc); |
191 | unative_t a4, unative_t a5, unative_t a6, unative_t id, unative_t rc); |
174 | void udebug_new_thread_event(struct thread *t); |
192 | void udebug_new_thread_event(struct thread *t); |
175 | 193 | ||
176 | void udebug_stoppable_begin(void); |
194 | void udebug_stoppable_begin(void); |
177 | void udebug_stoppable_end(void); |
195 | void udebug_stoppable_end(void); |
178 | 196 | ||
179 | int udebug_task_cleanup(struct task *ta); |
197 | int udebug_task_cleanup(struct task *ta); |
180 | 198 | ||
181 | #endif |
199 | #endif |
182 | 200 | ||
183 | #endif |
201 | #endif |
184 | 202 | ||
185 | /** @} |
203 | /** @} |
186 | */ |
204 | */ |
187 | 205 |