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

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

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/generic/include/udebug/udebug.h @ 3684 – Rev 2921