Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
3438 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
 
29
/** @addtogroup generic
30
 * @{
31
 */
32
/** @file
33
 */
34
 
35
#ifndef KERN_UDEBUG_H_
36
#define KERN_UDEBUG_H_
37
 
38
#include <ipc/ipc.h>
39
 
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
 
53
/** Set which events should be captured.
54
 */
55
UDEBUG_M_SET_EVMASK,
56
 
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
 
85
/** Read the list of the debugged tasks's threads.
86
 *
87
 * - ARG2 - destination address in the caller's address space
88
 * - ARG3 - size of receiving buffer in bytes
89
 *
90
 * The kernel fills the buffer with a series of sysarg_t values
91
 * (thread ids). On answer, the kernel will set:
92
 *
93
 * - ARG2 - number of bytes that were actually copied
94
 * - ARG3 - number of bytes of the complete data
95
 *
96
 */
97
UDEBUG_M_THREAD_READ,
98
 
99
/** Read the debugged tasks's memory.
100
 *
101
 * - ARG2 - destination address in the caller's address space
102
 * - ARG3 - source address in the recipient's address space
103
 * - ARG4 - size of receiving buffer in bytes
104
 *
105
 */
106
UDEBUG_M_MEM_READ,
107
 
108
} udebug_method_t;
109
 
110
 
111
typedef enum {
112
    UDEBUG_EVENT_FINISHED = 1/**< Debuging session has finished */
113
    UDEBUG_EVENT_STOP,      /**< Stopped on DEBUG_STOP request */
114
    UDEBUG_EVENT_SYSCALL_B,     /**< Before beginning syscall execution */
115
    UDEBUG_EVENT_SYSCALL_E,     /**< After finishing syscall execution */
116
    UDEBUG_EVENT_THREAD_B,      /**< The task created a new thread */
117
    UDEBUG_EVENT_THREAD_E       /**< A thread exited */
118
} udebug_event_t;
119
 
120
#define UDEBUG_EVMASK(event) (1 << ((event) - 1))
121
 
122
typedef enum {
123
    UDEBUG_EM_FINISHED  = UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED),
124
    UDEBUG_EM_STOP      = UDEBUG_EVMASK(UDEBUG_EVENT_STOP),
125
    UDEBUG_EM_SYSCALL_B = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_B),
126
    UDEBUG_EM_SYSCALL_E = UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_E),
127
    UDEBUG_EM_THREAD_B  = UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_B),
128
    UDEBUG_EM_THREAD_E  = UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_E),
129
    UDEBUG_EM_ALL       =
130
        UDEBUG_EVMASK(UDEBUG_EVENT_FINISHED) |
131
        UDEBUG_EVMASK(UDEBUG_EVENT_STOP) |
132
        UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_B) |
133
        UDEBUG_EVMASK(UDEBUG_EVENT_SYSCALL_E) |
134
        UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_B) |
135
        UDEBUG_EVMASK(UDEBUG_EVENT_THREAD_E)
136
} udebug_evmask_t;
137
 
138
#ifdef KERNEL
139
 
140
#include <synch/mutex.h>
141
#include <arch/interrupt.h>
142
#include <atomic.h>
143
 
144
typedef enum {
145
    /** Task is not being debugged */
146
    UDEBUG_TS_INACTIVE,
147
    /** BEGIN operation in progress (waiting for threads to stop) */
148
    UDEBUG_TS_BEGINNING,
149
    /** Debugger fully connected */
150
    UDEBUG_TS_ACTIVE,
151
    /** Task is shutting down, no more debug activities allowed */
152
    UDEBUG_TS_SHUTDOWN
153
} udebug_task_state_t;
154
 
155
/** Debugging part of task_t structure.
156
 */
157
typedef struct {
158
    /** Synchronize debug ops on this task / access to this structure */
159
    mutex_t lock;
160
    char *lock_owner;
161
 
162
    udebug_task_state_t dt_state;
163
    call_t *begin_call;
164
    int not_stoppable_count;
165
    struct task *debugger;
166
    udebug_evmask_t evmask;
167
} udebug_task_t;
168
 
169
/** Debugging part of thread_t structure.
170
 */
171
typedef struct {
172
    /**
173
     * Prevent deadlock with udebug_before_thread_runs() in interrupt
174
     * handler, without actually disabling interrupts.
175
     * ==0 means "unlocked", >0 means "locked"
176
     */
177
    atomic_t int_lock;
178
 
179
    /** Synchronize debug ops on this thread / access to this structure */
180
    mutex_t lock;
181
 
182
    waitq_t go_wq;
183
    call_t *go_call;
184
    unative_t syscall_args[6];
185
 
186
    /** What type of event are we stopped in or 0 if none */
187
    udebug_event_t cur_event;  
188
    bool stop;
189
    bool stoppable;
190
    bool debug_active; /**< In a debugging session */
191
} udebug_thread_t;
192
 
193
struct task;
194
struct thread;
195
 
196
void udebug_task_init(udebug_task_t *ut);
197
void udebug_thread_initialize(udebug_thread_t *ut);
198
 
199
void udebug_syscall_event(unative_t a1, unative_t a2, unative_t a3,
200
    unative_t a4, unative_t a5, unative_t a6, unative_t id, unative_t rc,
201
    bool end_variant);
202
 
203
void udebug_thread_b_event(struct thread *t);
204
void udebug_thread_e_event(void);
205
 
206
void udebug_stoppable_begin(void);
207
void udebug_stoppable_end(void);
208
 
209
void udebug_before_thread_runs(void);
210
 
211
int udebug_task_cleanup(struct task *ta);
212
 
213
#endif
214
 
215
#endif
216
 
217
/** @}
218
 */