WebSVN – HelenOS – Diff – /branches/tracing/kernel/generic/include/udebug/udebug.h


/** @addtogroup generic
 * @{
 */
/** @file
 */
 
#ifndef KERN_UDEBUG_H_
#define KERN_UDEBUG_H_
 
typedef enum { /* udebug_method_t */
 
/** Start debugging the recipient.
 * Causes all threads in the receiving task to stop. When they
 * are all stoped, an answer with retval 0 is generated.
 */
UDEBUG_M_BEGIN = 1,
 
/** Finish debugging the recipient.
 * Answers all pending GO and GUARD messages.
 */
UDEBUG_M_END,
 
/** Make sure the debugged task is still there.
 * This message is answered when the debugged task dies
 * or the debugging session ends.
 */
UDEBUG_M_GUARD,
 
/** Run a thread until a debugging event occurs.
 * This message is answered when the thread stops
 * in a debugging event.
 *
 * - ARG2 - id of the thread to run
 */
UDEBUG_M_GO,
 
/** Stop a thread being debugged.
 * Creates a special STOP event in the thread, causing
 * it to answer a pending GO message (if any).
 */
UDEBUG_M_STOP,
 
/** Read arguments of a syscall.
 *
 * - ARG2 - thread identification
 * - ARG3 - destination address in the caller's address space
 
 *
 
 
 
 */
UDEBUG_M_ARGS_READ,
 
/** Read thread's userspace register state (istate_t).
 *
 * - ARG2 - thread identification
 * - ARG3 - destination address in the caller's address space
 * - ARG4 - size of receiving buffer in bytes
 *
 * on answer, the kernel will set:
 *
 * - ARG1 - actual size in bytes of data read
 * - ARG2 - total size in bytes of data available
 *
 * or, on error, retval will be
 * - ENOENT - thread does not exist
 * - EBUSY - register state not available
 */
UDEBUG_M_REGS_READ,
 
/** Write thread's userspace register state (istate_t).
 *
 * - ARG2 - thread identification
 * - ARG3 - source address in the caller's address space
 * - ARG4 - size of source data in bytes
 *
 * on answer, the kernel will set:
 *
 * - ARG1 - actual size in bytes of data copied
 * - ARG2 - max size in bytes that could have been copied
 *
 * or, on error, retval will be
 * - ENOENT - thread does not exist
 * - EBUSY - register state not available
 */
UDEBUG_M_REGS_WRITE,
 
/** Read the list of the debugged tasks's threads.
 *
 * - ARG2 - destination address in the caller's address space
 * - ARG3 - size of receiving buffer in bytes
 *
 * The kernel fills the buffer with a series of sysarg_t values
 * (thread ids). On answer, the kernel will set:
 *
 * - ARG1 - number of bytes that were actually copied
 * - ARG2 - number of bytes of the complete data
 *
 */
UDEBUG_M_THREAD_READ,
 
/** Read the debugged tasks's memory.
 *
 * - ARG2 - destination address in the caller's address space
 * - ARG3 - source address in the recipient's address space
 * - ARG4 - size of receiving buffer in bytes
 *
 */
UDEBUG_M_MEM_READ,
 
/** Write the debugged tasks's memory.
 *
 * - ARG2 - source address in the caller's address space
 * - ARG3 - destination address in the recipient's address space
 * - ARG4 - size of receiving buffer in bytes
 *
 */
UDEBUG_M_MEM_WRITE
 
 
} udebug_method_t;
 
 
typedef enum {
    UDEBUG_EVENT_SYSCALL
} udebug_event_t;
 
#ifdef KERNEL
 
typedef enum {
    /** Task is not being debugged */
    UDEBUG_TS_INACTIVE,
    /** BEGIN operation in progress (waiting for threads to stop) */
    UDEBUG_TS_BEGINNING,
    /** Debugger fully connected */
    UDEBUG_TS_ACTIVE,
    /** Task is shutting down, no more debug activities allowed */
    UDEBUG_TS_SHUTDOWN
} udebug_task_state_t;
 
void udebug_syscall_event(unative_t a1, unative_t a2, unative_t a3,
    unative_t a4, unative_t a5, unative_t a6, unative_t id, unative_t rc);
void udebug_stoppable_begin(void);
void udebug_stoppable_end(void);
 
#endif
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/generic/include/udebug/udebug.h @ 2847 – Rev 2825 → 2833

Rev 2825		Rev 2833
1	/** @addtogroup generic	1	/** @addtogroup generic
2	* @{	2	* @{
3	*/	3	*/
4	/** @file	4	/** @file
5	*/	5	*/
6		6
7	#ifndef KERN_UDEBUG_H_	7	#ifndef KERN_UDEBUG_H_
8	#define KERN_UDEBUG_H_	8	#define KERN_UDEBUG_H_
9		9
10	typedef enum { /* udebug_method_t */	10	typedef enum { /* udebug_method_t */
11		11
12	/** Start debugging the recipient.	12	/** Start debugging the recipient.
13	* Causes all threads in the receiving task to stop. When they	13	* Causes all threads in the receiving task to stop. When they
14	* are all stoped, an answer with retval 0 is generated.	14	* are all stoped, an answer with retval 0 is generated.
15	*/	15	*/
16	UDEBUG_M_BEGIN = 1,	16	UDEBUG_M_BEGIN = 1,
17		17
18	/** Finish debugging the recipient.	18	/** Finish debugging the recipient.
19	* Answers all pending GO and GUARD messages.	19	* Answers all pending GO and GUARD messages.
20	*/	20	*/
21	UDEBUG_M_END,	21	UDEBUG_M_END,
22		22
23	/** Make sure the debugged task is still there.	23	/** Make sure the debugged task is still there.
24	* This message is answered when the debugged task dies	24	* This message is answered when the debugged task dies
25	* or the debugging session ends.	25	* or the debugging session ends.
26	*/	26	*/
27	UDEBUG_M_GUARD,	27	UDEBUG_M_GUARD,
28		28
29	/** Run a thread until a debugging event occurs.	29	/** Run a thread until a debugging event occurs.
30	* This message is answered when the thread stops	30	* This message is answered when the thread stops
31	* in a debugging event.	31	* in a debugging event.
32	*	32	*
33	* - ARG2 - id of the thread to run	33	* - ARG2 - id of the thread to run
34	*/	34	*/
35	UDEBUG_M_GO,	35	UDEBUG_M_GO,
36		36
37	/** Stop a thread being debugged.	37	/** Stop a thread being debugged.
38	* Creates a special STOP event in the thread, causing	38	* Creates a special STOP event in the thread, causing
39	* it to answer a pending GO message (if any).	39	* it to answer a pending GO message (if any).
40	*/	40	*/
41	UDEBUG_M_STOP,	41	UDEBUG_M_STOP,
42		42
43	/** Read arguments of a syscall.	43	/** Read arguments of a syscall.
44	*	44	*
45	* - ARG2 - thread identification	45	* - ARG2 - thread identification
46	* - ARG3 - destination address in the caller's address space	46	* - ARG3 - destination address in the caller's address space
47	* - ARG4 - size of receiving buffer in bytes	-
48	*	47	*
49	* on answer, the kernel will set:	-
50	*	-
51	* - ARG1 - actual size in bytes of data read	-
52	*/	48	*/
53	UDEBUG_M_ARGS_READ,	49	UDEBUG_M_ARGS_READ,
54		50
55	/** Read thread's userspace register state (istate_t).	51	/** Read thread's userspace register state (istate_t).
56	*	52	*
57	* - ARG2 - thread identification	53	* - ARG2 - thread identification
58	* - ARG3 - destination address in the caller's address space	54	* - ARG3 - destination address in the caller's address space
59	* - ARG4 - size of receiving buffer in bytes	55	* - ARG4 - size of receiving buffer in bytes
60	*	56	*
61	* on answer, the kernel will set:	57	* on answer, the kernel will set:
62	*	58	*
63	* - ARG1 - actual size in bytes of data read	59	* - ARG1 - actual size in bytes of data read
64	* - ARG2 - total size in bytes of data available	60	* - ARG2 - total size in bytes of data available
65	*	61	*
66	* or, on error, retval will be	62	* or, on error, retval will be
67	* - ENOENT - thread does not exist	63	* - ENOENT - thread does not exist
68	* - EBUSY - register state not available	64	* - EBUSY - register state not available
69	*/	65	*/
70	UDEBUG_M_REGS_READ,	66	UDEBUG_M_REGS_READ,
71		67
72	/** Write thread's userspace register state (istate_t).	68	/** Write thread's userspace register state (istate_t).
73	*	69	*
74	* - ARG2 - thread identification	70	* - ARG2 - thread identification
75	* - ARG3 - source address in the caller's address space	71	* - ARG3 - source address in the caller's address space
76	* - ARG4 - size of source data in bytes	72	* - ARG4 - size of source data in bytes
77	*	73	*
78	* on answer, the kernel will set:	74	* on answer, the kernel will set:
79	*	75	*
80	* - ARG1 - actual size in bytes of data copied	76	* - ARG1 - actual size in bytes of data copied
81	* - ARG2 - max size in bytes that could have been copied	77	* - ARG2 - max size in bytes that could have been copied
82	*	78	*
83	* or, on error, retval will be	79	* or, on error, retval will be
84	* - ENOENT - thread does not exist	80	* - ENOENT - thread does not exist
85	* - EBUSY - register state not available	81	* - EBUSY - register state not available
86	*/	82	*/
87	UDEBUG_M_REGS_WRITE,	83	UDEBUG_M_REGS_WRITE,
88		84
89	/** Read the list of the debugged tasks's threads.	85	/** Read the list of the debugged tasks's threads.
90	*	86	*
91	* - ARG2 - destination address in the caller's address space	87	* - ARG2 - destination address in the caller's address space
92	* - ARG3 - size of receiving buffer in bytes	88	* - ARG3 - size of receiving buffer in bytes
93	*	89	*
94	* The kernel fills the buffer with a series of sysarg_t values	90	* The kernel fills the buffer with a series of sysarg_t values
95	* (thread ids). On answer, the kernel will set:	91	* (thread ids). On answer, the kernel will set:
96	*	92	*
97	* - ARG1 - number of bytes that were actually copied	93	* - ARG1 - number of bytes that were actually copied
98	* - ARG2 - number of bytes of the complete data	94	* - ARG2 - number of bytes of the complete data
99	*	95	*
100	*/	96	*/
101	UDEBUG_M_THREAD_READ,	97	UDEBUG_M_THREAD_READ,
102		98
103	/** Read the debugged tasks's memory.	99	/** Read the debugged tasks's memory.
104	*	100	*
105	* - ARG2 - destination address in the caller's address space	101	* - ARG2 - destination address in the caller's address space
106	* - ARG3 - source address in the recipient's address space	102	* - ARG3 - source address in the recipient's address space
107	* - ARG4 - size of receiving buffer in bytes	103	* - ARG4 - size of receiving buffer in bytes
108	*	104	*
109	*/	105	*/
110	UDEBUG_M_MEM_READ,	106	UDEBUG_M_MEM_READ,
111		107
112	/** Write the debugged tasks's memory.	108	/** Write the debugged tasks's memory.
113	*	109	*
114	* - ARG2 - source address in the caller's address space	110	* - ARG2 - source address in the caller's address space
115	* - ARG3 - destination address in the recipient's address space	111	* - ARG3 - destination address in the recipient's address space
116	* - ARG4 - size of receiving buffer in bytes	112	* - ARG4 - size of receiving buffer in bytes
117	*	113	*
118	*/	114	*/
119	UDEBUG_M_MEM_WRITE	115	UDEBUG_M_MEM_WRITE
120		116
121		117
122	} udebug_method_t;	118	} udebug_method_t;
123		119
124		120
125	typedef enum {	121	typedef enum {
126	UDEBUG_EVENT_SYSCALL	122	UDEBUG_EVENT_SYSCALL
127	} udebug_event_t;	123	} udebug_event_t;
128		124
129	#ifdef KERNEL	125	#ifdef KERNEL
130		126
131	typedef enum {	127	typedef enum {
132	/** Task is not being debugged */	128	/** Task is not being debugged */
133	UDEBUG_TS_INACTIVE,	129	UDEBUG_TS_INACTIVE,
134	/** BEGIN operation in progress (waiting for threads to stop) */	130	/** BEGIN operation in progress (waiting for threads to stop) */
135	UDEBUG_TS_BEGINNING,	131	UDEBUG_TS_BEGINNING,
136	/** Debugger fully connected */	132	/** Debugger fully connected */
137	UDEBUG_TS_ACTIVE,	133	UDEBUG_TS_ACTIVE,
138	/** Task is shutting down, no more debug activities allowed */	134	/** Task is shutting down, no more debug activities allowed */
139	UDEBUG_TS_SHUTDOWN	135	UDEBUG_TS_SHUTDOWN
140	} udebug_task_state_t;	136	} udebug_task_state_t;
141		137
142	void udebug_syscall_event(unative_t a1, unative_t a2, unative_t a3,	138	void udebug_syscall_event(unative_t a1, unative_t a2, unative_t a3,
143	unative_t a4, unative_t a5, unative_t a6, unative_t id, unative_t rc);	139	unative_t a4, unative_t a5, unative_t a6, unative_t id, unative_t rc);
144	void udebug_stoppable_begin(void);	140	void udebug_stoppable_begin(void);
145	void udebug_stoppable_end(void);	141	void udebug_stoppable_end(void);
146		142
147	#endif	143	#endif
148		144
149	#endif	145	#endif
150		146
151	/** @}	147	/** @}
152	*/	148	*/
153		149