Subversion Repositories HelenOS

Rev

Rev 3016 | Rev 3026 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2894 svoboda 1
/*
2
 * Copyright (c) 2008 Jiri Svoboda
3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
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
15
 *   derived from this software without specific prior written permission.
16
 *
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
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
2801 svoboda 29
/** @addtogroup generic
30
 * @{
31
 */
32
/** @file
33
 */
34
 
35
#ifndef KERN_UDEBUG_H_
36
#define KERN_UDEBUG_H_
37
 
3014 svoboda 38
#include <ipc/ipc.h>
39
 
2812 svoboda 40
typedef enum { /* udebug_method_t */
41
 
42
/** Start debugging the recipient.
43
 * Causes all threads in the receiving task to stop. When they
44
 * are all stoped, an answer with retval 0 is generated.
45
 */
46
UDEBUG_M_BEGIN = 1,
47
 
48
/** Finish debugging the recipient.
49
 * Answers all pending GO and GUARD messages.
50
 */
51
UDEBUG_M_END,
52
 
2899 svoboda 53
/** Set which events should be captured.
54
 */
55
UDEBUG_M_SET_EVMASK,
56
 
2812 svoboda 57
/** Make sure the debugged task is still there.
58
 * This message is answered when the debugged task dies
59
 * or the debugging session ends.
60
 */
61
UDEBUG_M_GUARD,
62
 
63
/** Run a thread until a debugging event occurs.
64
 * This message is answered when the thread stops
65
 * in a debugging event.
66
 *
67
 * - ARG2 - id of the thread to run
68
 */
69
UDEBUG_M_GO,
70
 
71
/** Stop a thread being debugged.
72
 * Creates a special STOP event in the thread, causing
73
 * it to answer a pending GO message (if any).
74
 */
75
UDEBUG_M_STOP,
76
 
77
/** Read arguments of a syscall.
78
 *
79
 * - ARG2 - thread identification
80
 * - ARG3 - destination address in the caller's address space
81
 *
82
 */
83
UDEBUG_M_ARGS_READ,
84
 
2817 svoboda 85
/** Read thread's userspace register state (istate_t).
86
 *
87
 * - ARG2 - thread identification
88
 * - ARG3 - destination address in the caller's address space
89
 *
90
 * or, on error, retval will be
91
 * - ENOENT - thread does not exist
92
 * - EBUSY - register state not available
93
 */
94
UDEBUG_M_REGS_READ,
95
 
96
/** Write thread's userspace register state (istate_t).
97
 *
98
 * - ARG2 - thread identification
99
 * - ARG3 - source address in the caller's address space
100
 *
101
 * or, on error, retval will be
102
 * - ENOENT - thread does not exist
103
 * - EBUSY - register state not available
104
 */
105
UDEBUG_M_REGS_WRITE,
106
 
2812 svoboda 107
/** Read the list of the debugged tasks's threads.
108
 *
109
 * - ARG2 - destination address in the caller's address space
110
 * - ARG3 - size of receiving buffer in bytes
111
 *
112
 * The kernel fills the buffer with a series of sysarg_t values
113
 * (thread ids). On answer, the kernel will set:
114
 *
2885 svoboda 115
 * - ARG2 - number of bytes that were actually copied
116
 * - ARG3 - number of bytes of the complete data
2812 svoboda 117
 *
118
 */
119
UDEBUG_M_THREAD_READ,
120
 
2818 svoboda 121
/** Read the debugged tasks's memory.
2812 svoboda 122
 *
123
 * - ARG2 - destination address in the caller's address space
124
 * - ARG3 - source address in the recipient's address space
125
 * - ARG4 - size of receiving buffer in bytes
126
 *
127
 */
2818 svoboda 128
UDEBUG_M_MEM_READ,
2812 svoboda 129
 
2818 svoboda 130
/** Write the debugged tasks's memory.
131
 *
132
 * - ARG2 - source address in the caller's address space
133
 * - ARG3 - destination address in the recipient's address space
134
 * - ARG4 - size of receiving buffer in bytes
135
 *
136
 */
137
UDEBUG_M_MEM_WRITE
138
 
139
 
2812 svoboda 140
} udebug_method_t;
141
 
2838 svoboda 142
 
2805 svoboda 143
typedef enum {
2866 svoboda 144
    UDEBUG_EVENT_FINISHED = 1/**< Debuging session has finished */
2898 svoboda 145
    UDEBUG_EVENT_STOP,      /**< Stopped on DEBUG_STOP request */
2901 svoboda 146
    UDEBUG_EVENT_SYSCALL_B,     /**< Before beginning syscall execution */
147
    UDEBUG_EVENT_SYSCALL_E,     /**< After finishing syscall execution */
2903 svoboda 148
    UDEBUG_EVENT_THREAD_B,      /**< The task created a new thread */
149
    UDEBUG_EVENT_THREAD_E,      /**< A thread exited */
2921 svoboda 150
    UDEBUG_EVENT_BREAKPOINT,    /**< Breakpoint instruction executed */
151
    UDEBUG_EVENT_TRAP       /**< Single-step trap */
2805 svoboda 152
} udebug_event_t;
153
 
2899 svoboda 154
#define UDEBUG_EVMASK(event) (1 << ((event) - 1))
155
 
156
typedef enum {
157
    UDEBUG_EM_FINISHED  = UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED),
158
    UDEBUG_EM_STOP      = UDEBUG_EVMASK(UDEBUG_EVENT_STOP),
2901 svoboda 159
    UDEBUG_EM_SYSCALL_B = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_B),
160
    UDEBUG_EM_SYSCALL_E = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_E),
2903 svoboda 161
    UDEBUG_EM_THREAD_B  = UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_B),
162
    UDEBUG_EM_THREAD_E  = UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_E),
2918 svoboda 163
    UDEBUG_EM_BREAKPOINT    = UDEBUG_EVMASK(UDEBUG_EVENT_BREAKPOINT),
2921 svoboda 164
    UDEBUG_EM_TRAP      = UDEBUG_EVMASK(UDEBUG_EVENT_TRAP),
2899 svoboda 165
    UDEBUG_EM_ALL       =
166
        UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED) |
167
        UDEBUG_EVMASK(UDEBUG_EVENT_STOP) |
2901 svoboda 168
        UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_B) |
169
        UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_E) |
2903 svoboda 170
        UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_B) |
2918 svoboda 171
        UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_E) |
2921 svoboda 172
        UDEBUG_EVMASK(UDEBUG_EVENT_BREAKPOINT) |
173
        UDEBUG_EVMASK(UDEBUG_EVENT_TRAP)
2899 svoboda 174
} udebug_evmask_t;
175
 
2812 svoboda 176
#ifdef KERNEL
177
 
3016 svoboda 178
#include <synch/mutex.h>
179
 
2825 svoboda 180
typedef enum {
181
    /** Task is not being debugged */
182
    UDEBUG_TS_INACTIVE,
183
    /** BEGIN operation in progress (waiting for threads to stop) */
184
    UDEBUG_TS_BEGINNING,
185
    /** Debugger fully connected */
186
    UDEBUG_TS_ACTIVE,
187
    /** Task is shutting down, no more debug activities allowed */
188
    UDEBUG_TS_SHUTDOWN
189
} udebug_task_state_t;
190
 
3014 svoboda 191
/** Debugging part of task_t structure.
192
 */
193
typedef struct {
3016 svoboda 194
    /** Synchronize debug ops on this task / access to this structure */
195
    mutex_t lock;
196
 
3014 svoboda 197
    udebug_task_state_t dt_state;
198
    call_t *begin_call;
199
    int not_stoppable_count;
200
    struct task *debugger;
201
    udebug_evmask_t evmask;
202
} udebug_task_t;
203
 
3018 svoboda 204
/** Debugging part of thread_t structure.
205
 */
206
typedef struct {
207
    /** Synchronize debug ops on this thread / access to this structure */
208
    SPINLOCK_DECLARE(lock);
209
 
210
    waitq_t go_wq;
211
    call_t *go_call;
212
    unative_t syscall_args[6];
213
    istate_t *uspace_state;
214
    bool in_before_thread_runs;
215
 
216
    /** What type of event are we stopped in or 0 if none */
217
    udebug_event_t cur_event;  
218
    bool stop;
219
    bool stoppable;
220
    bool debug_active; /**< In a debugging session */
221
} udebug_thread_t;
222
 
2870 svoboda 223
struct task;
224
struct thread;
225
 
3014 svoboda 226
void udebug_task_init(udebug_task_t *ut);
3018 svoboda 227
void udebug_thread_initialize(udebug_thread_t *ut);
3014 svoboda 228
 
2805 svoboda 229
void udebug_syscall_event(unative_t a1, unative_t a2, unative_t a3,
2901 svoboda 230
    unative_t a4, unative_t a5, unative_t a6, unative_t id, unative_t rc,
231
    bool end_variant);
2867 svoboda 232
 
2903 svoboda 233
void udebug_thread_b_event(struct thread *t);
234
void udebug_thread_e_event(void);
235
 
2804 svoboda 236
void udebug_stoppable_begin(void);
237
void udebug_stoppable_end(void);
2801 svoboda 238
 
3015 svoboda 239
void udebug_before_thread_runs(void);
240
 
2918 svoboda 241
void udebug_breakpoint_event(uintptr_t addr);
2921 svoboda 242
void udebug_trap_event(uintptr_t addr);
2918 svoboda 243
 
2870 svoboda 244
int udebug_task_cleanup(struct task *ta);
245
 
2801 svoboda 246
#endif
247
 
2812 svoboda 248
#endif
249
 
2801 svoboda 250
/** @}
251
 */