Subversion Repositories HelenOS

Rev

Rev 2919 | Rev 3014 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 2919 Rev 2921
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.
51
/** Set which events should be captured.
52
 */
52
 */
53
UDEBUG_M_SET_EVMASK,
53
UDEBUG_M_SET_EVMASK,
54
 
54
 
55
/** Make sure the debugged task is still there.
55
/** Make sure the debugged task is still there.
56
 * This message is answered when the debugged task dies
56
 * This message is answered when the debugged task dies
57
 * or the debugging session ends.
57
 * or the debugging session ends.
58
 */
58
 */
59
UDEBUG_M_GUARD,
59
UDEBUG_M_GUARD,
60
 
60
 
61
/** Run a thread until a debugging event occurs.
61
/** Run a thread until a debugging event occurs.
62
 * This message is answered when the thread stops
62
 * This message is answered when the thread stops
63
 * in a debugging event.
63
 * in a debugging event.
64
 *
64
 *
65
 * - ARG2 - id of the thread to run
65
 * - ARG2 - id of the thread to run
66
 */
66
 */
67
UDEBUG_M_GO,
67
UDEBUG_M_GO,
68
 
68
 
69
/** Stop a thread being debugged.
69
/** Stop a thread being debugged.
70
 * Creates a special STOP event in the thread, causing
70
 * Creates a special STOP event in the thread, causing
71
 * it to answer a pending GO message (if any).
71
 * it to answer a pending GO message (if any).
72
 */
72
 */
73
UDEBUG_M_STOP,
73
UDEBUG_M_STOP,
74
 
74
 
75
/** Read arguments of a syscall.
75
/** Read arguments of a syscall.
76
 *
76
 *
77
 * - ARG2 - thread identification
77
 * - ARG2 - thread identification
78
 * - ARG3 - destination address in the caller's address space
78
 * - ARG3 - destination address in the caller's address space
79
 *
79
 *
80
 */
80
 */
81
UDEBUG_M_ARGS_READ,
81
UDEBUG_M_ARGS_READ,
82
 
82
 
83
/** Read thread's userspace register state (istate_t).
83
/** Read thread's userspace register state (istate_t).
84
 *
84
 *
85
 * - ARG2 - thread identification
85
 * - ARG2 - thread identification
86
 * - ARG3 - destination address in the caller's address space
86
 * - ARG3 - destination address in the caller's address space
87
 *
87
 *
88
 * or, on error, retval will be
88
 * or, on error, retval will be
89
 * - ENOENT - thread does not exist
89
 * - ENOENT - thread does not exist
90
 * - EBUSY - register state not available
90
 * - EBUSY - register state not available
91
 */
91
 */
92
UDEBUG_M_REGS_READ,
92
UDEBUG_M_REGS_READ,
93
 
93
 
94
/** Write thread's userspace register state (istate_t).
94
/** Write thread's userspace register state (istate_t).
95
 *
95
 *
96
 * - ARG2 - thread identification
96
 * - ARG2 - thread identification
97
 * - ARG3 - source address in the caller's address space
97
 * - ARG3 - source address in the caller's address space
98
 *
98
 *
99
 * or, on error, retval will be
99
 * or, on error, retval will be
100
 * - ENOENT - thread does not exist
100
 * - ENOENT - thread does not exist
101
 * - EBUSY - register state not available
101
 * - EBUSY - register state not available
102
 */
102
 */
103
UDEBUG_M_REGS_WRITE,
103
UDEBUG_M_REGS_WRITE,
104
 
104
 
105
/** Read the list of the debugged tasks's threads.
105
/** Read the list of the debugged tasks's threads.
106
 *
106
 *
107
 * - ARG2 - destination address in the caller's address space
107
 * - ARG2 - destination address in the caller's address space
108
 * - ARG3 - size of receiving buffer in bytes
108
 * - ARG3 - size of receiving buffer in bytes
109
 *
109
 *
110
 * The kernel fills the buffer with a series of sysarg_t values
110
 * The kernel fills the buffer with a series of sysarg_t values
111
 * (thread ids). On answer, the kernel will set:
111
 * (thread ids). On answer, the kernel will set:
112
 *
112
 *
113
 * - ARG2 - number of bytes that were actually copied
113
 * - ARG2 - number of bytes that were actually copied
114
 * - ARG3 - number of bytes of the complete data
114
 * - ARG3 - number of bytes of the complete data
115
 *
115
 *
116
 */
116
 */
117
UDEBUG_M_THREAD_READ,
117
UDEBUG_M_THREAD_READ,
118
 
118
 
119
/** Read the debugged tasks's memory.
119
/** Read the debugged tasks's memory.
120
 *
120
 *
121
 * - ARG2 - destination address in the caller's address space
121
 * - ARG2 - destination address in the caller's address space
122
 * - ARG3 - source address in the recipient's address space
122
 * - ARG3 - source address in the recipient's address space
123
 * - ARG4 - size of receiving buffer in bytes
123
 * - ARG4 - size of receiving buffer in bytes
124
 *
124
 *
125
 */
125
 */
126
UDEBUG_M_MEM_READ,
126
UDEBUG_M_MEM_READ,
127
 
127
 
128
/** Write the debugged tasks's memory.
128
/** Write the debugged tasks's memory.
129
 *
129
 *
130
 * - ARG2 - source address in the caller's address space
130
 * - ARG2 - source address in the caller's address space
131
 * - ARG3 - destination address in the recipient's address space
131
 * - ARG3 - destination address in the recipient's address space
132
 * - ARG4 - size of receiving buffer in bytes
132
 * - ARG4 - size of receiving buffer in bytes
133
 *
133
 *
134
 */
134
 */
135
UDEBUG_M_MEM_WRITE
135
UDEBUG_M_MEM_WRITE
136
 
136
 
137
 
137
 
138
} udebug_method_t;
138
} udebug_method_t;
139
 
139
 
140
               
140
               
141
typedef enum {
141
typedef enum {
142
    UDEBUG_EVENT_FINISHED = 1/**< Debuging session has finished */
142
    UDEBUG_EVENT_FINISHED = 1/**< Debuging session has finished */
143
    UDEBUG_EVENT_STOP,      /**< Stopped on DEBUG_STOP request */
143
    UDEBUG_EVENT_STOP,      /**< Stopped on DEBUG_STOP request */
144
    UDEBUG_EVENT_SYSCALL_B,     /**< Before beginning syscall execution */
144
    UDEBUG_EVENT_SYSCALL_B,     /**< Before beginning syscall execution */
145
    UDEBUG_EVENT_SYSCALL_E,     /**< After finishing syscall execution */
145
    UDEBUG_EVENT_SYSCALL_E,     /**< After finishing syscall execution */
146
    UDEBUG_EVENT_THREAD_B,      /**< The task created a new thread */
146
    UDEBUG_EVENT_THREAD_B,      /**< The task created a new thread */
147
    UDEBUG_EVENT_THREAD_E,      /**< A thread exited */
147
    UDEBUG_EVENT_THREAD_E,      /**< A thread exited */
148
    UDEBUG_EVENT_BREAKPOINT     /**< Breakpoint instruction executed */
148
    UDEBUG_EVENT_BREAKPOINT,    /**< Breakpoint instruction executed */
-
 
149
    UDEBUG_EVENT_TRAP       /**< Single-step trap */
149
} udebug_event_t;
150
} udebug_event_t;
150
 
151
 
151
#define UDEBUG_EVMASK(event) (1 << ((event) - 1))
152
#define UDEBUG_EVMASK(event) (1 << ((event) - 1))
152
 
153
 
153
typedef enum {
154
typedef enum {
154
    UDEBUG_EM_FINISHED  = UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED),
155
    UDEBUG_EM_FINISHED  = UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED),
155
    UDEBUG_EM_STOP      = UDEBUG_EVMASK(UDEBUG_EVENT_STOP),
156
    UDEBUG_EM_STOP      = UDEBUG_EVMASK(UDEBUG_EVENT_STOP),
156
    UDEBUG_EM_SYSCALL_B = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_B),
157
    UDEBUG_EM_SYSCALL_B = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_B),
157
    UDEBUG_EM_SYSCALL_E = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_E),
158
    UDEBUG_EM_SYSCALL_E = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_E),
158
    UDEBUG_EM_THREAD_B  = UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_B),
159
    UDEBUG_EM_THREAD_B  = UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_B),
159
    UDEBUG_EM_THREAD_E  = UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_E),
160
    UDEBUG_EM_THREAD_E  = UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_E),
160
    UDEBUG_EM_BREAKPOINT    = UDEBUG_EVMASK(UDEBUG_EVENT_BREAKPOINT),
161
    UDEBUG_EM_BREAKPOINT    = UDEBUG_EVMASK(UDEBUG_EVENT_BREAKPOINT),
-
 
162
    UDEBUG_EM_TRAP      = UDEBUG_EVMASK(UDEBUG_EVENT_TRAP),
161
    UDEBUG_EM_ALL       =
163
    UDEBUG_EM_ALL       =
162
        UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED) |
164
        UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED) |
163
        UDEBUG_EVMASK(UDEBUG_EVENT_STOP) |
165
        UDEBUG_EVMASK(UDEBUG_EVENT_STOP) |
164
        UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_B) |
166
        UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_B) |
165
        UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_E) |
167
        UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_E) |
166
        UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_B) |
168
        UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_B) |
167
        UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_E) |
169
        UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_E) |
168
        UDEBUG_EVMASK(UDEBUG_EVENT_BREAKPOINT)
170
        UDEBUG_EVMASK(UDEBUG_EVENT_BREAKPOINT) |
-
 
171
        UDEBUG_EVMASK(UDEBUG_EVENT_TRAP)
169
} udebug_evmask_t;
172
} udebug_evmask_t;
170
 
173
 
171
#ifdef KERNEL
174
#ifdef KERNEL
172
 
175
 
173
typedef enum {
176
typedef enum {
174
    /** Task is not being debugged */
177
    /** Task is not being debugged */
175
    UDEBUG_TS_INACTIVE,
178
    UDEBUG_TS_INACTIVE,
176
    /** BEGIN operation in progress (waiting for threads to stop) */
179
    /** BEGIN operation in progress (waiting for threads to stop) */
177
    UDEBUG_TS_BEGINNING,
180
    UDEBUG_TS_BEGINNING,
178
    /** Debugger fully connected */
181
    /** Debugger fully connected */
179
    UDEBUG_TS_ACTIVE,
182
    UDEBUG_TS_ACTIVE,
180
    /** Task is shutting down, no more debug activities allowed */
183
    /** Task is shutting down, no more debug activities allowed */
181
    UDEBUG_TS_SHUTDOWN
184
    UDEBUG_TS_SHUTDOWN
182
} udebug_task_state_t;
185
} udebug_task_state_t;
183
 
186
 
184
struct task;
187
struct task;
185
struct thread;
188
struct thread;
186
 
189
 
187
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,
188
    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,
189
    bool end_variant);
192
    bool end_variant);
190
 
193
 
191
void udebug_thread_b_event(struct thread *t);
194
void udebug_thread_b_event(struct thread *t);
192
void udebug_thread_e_event(void);
195
void udebug_thread_e_event(void);
193
 
196
 
194
void udebug_stoppable_begin(void);
197
void udebug_stoppable_begin(void);
195
void udebug_stoppable_end(void);
198
void udebug_stoppable_end(void);
196
 
199
 
197
void udebug_breakpoint_event(uintptr_t addr);
200
void udebug_breakpoint_event(uintptr_t addr);
-
 
201
void udebug_trap_event(uintptr_t addr);
198
 
202
 
199
int udebug_task_cleanup(struct task *ta);
203
int udebug_task_cleanup(struct task *ta);
200
 
204
 
201
#endif
205
#endif
202
 
206
 
203
#endif
207
#endif
204
 
208
 
205
/** @}
209
/** @}
206
 */
210
 */
207
 
211