dbg.h@ 59294

Last change on this file since 59294 was 58111, checked in by vboxsync, 9 years ago
include,misc: More Doxygen grouping adjustments.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 37.3 KB

Line
1	/** @file
2	* Debugger Interfaces. (VBoxDbg)
3	*
4	* This header covers all external interfaces of the Debugger module.
5	* However, it does not cover the DBGF interface since that part of the
6	* VMM. Use dbgf.h for that.
7	*/
8
9	/*
10	* Copyright (C) 2006-2015 Oracle Corporation
11	*
12	* This file is part of VirtualBox Open Source Edition (OSE), as
13	* available from http://www.virtualbox.org. This file is free software;
14	* you can redistribute it and/or modify it under the terms of the GNU
15	* General Public License (GPL) as published by the Free Software
16	* Foundation, in version 2 as it comes in the "COPYING" file of the
17	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
18	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19	*
20	* The contents of this file may alternatively be used under the terms
21	* of the Common Development and Distribution License Version 1.0
22	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
23	* VirtualBox OSE distribution, in which case the provisions of the
24	* CDDL are applicable instead of those of the GPL.
25	*
26	* You may elect to license modified versions of this file under the
27	* terms and conditions of either the GPL or the CDDL or both.
28	*/
29
30	#ifndef ___VBox_dbg_h
31	#define ___VBox_dbg_h
32
33	#include <VBox/cdefs.h>
34	#include <VBox/types.h>
35	#include <VBox/vmm/dbgf.h>
36
37	#include <iprt/stdarg.h>
38	#ifdef IN_RING3
39	# include <iprt/err.h>
40	#endif
41
42	RT_C_DECLS_BEGIN
43
44
45
46	/** @defgroup grp_dbg The VirtualBox Debugger
47	* @{
48	*/
49
50	#ifdef IN_RING3 /* The debugger stuff is ring-3 only. */
51
52	/** @defgroup grp_dbgc The Debugger Console API
53	* @{
54	*/
55
56	/** @def VBOX_WITH_DEBUGGER
57	* The build is with debugger module. Test if this is defined before registering
58	* external debugger commands. This is normally defined in Config.kmk.
59	*/
60	#ifdef DOXYGEN_RUNNING
61	# define VBOX_WITH_DEBUGGER
62	#endif
63
64
65	/**
66	* DBGC variable category.
67	*
68	* Used to describe an argument to a command or function and a functions
69	* return value.
70	*/
71	typedef enum DBGCVARCAT
72	{
73	/** Any type is fine. */
74	DBGCVAR_CAT_ANY = 0,
75	/** Any kind of pointer or number. */
76	DBGCVAR_CAT_POINTER_NUMBER,
77	/** Any kind of pointer or number, no range. */
78	DBGCVAR_CAT_POINTER_NUMBER_NO_RANGE,
79	/** Any kind of pointer. */
80	DBGCVAR_CAT_POINTER,
81	/** Any kind of pointer with no range option. */
82	DBGCVAR_CAT_POINTER_NO_RANGE,
83	/** GC pointer. */
84	DBGCVAR_CAT_GC_POINTER,
85	/** GC pointer with no range option. */
86	DBGCVAR_CAT_GC_POINTER_NO_RANGE,
87	/** Numeric argument. */
88	DBGCVAR_CAT_NUMBER,
89	/** Numeric argument with no range option. */
90	DBGCVAR_CAT_NUMBER_NO_RANGE,
91	/** String. */
92	DBGCVAR_CAT_STRING,
93	/** Symbol. */
94	DBGCVAR_CAT_SYMBOL,
95	/** Option. */
96	DBGCVAR_CAT_OPTION,
97	/** Option + string. */
98	DBGCVAR_CAT_OPTION_STRING,
99	/** Option + number. */
100	DBGCVAR_CAT_OPTION_NUMBER
101	} DBGCVARCAT;
102
103
104	/**
105	* DBGC variable type.
106	*/
107	typedef enum DBGCVARTYPE
108	{
109	/** unknown... */
110	DBGCVAR_TYPE_UNKNOWN = 0,
111	/** Flat GC pointer. */
112	DBGCVAR_TYPE_GC_FLAT,
113	/** Segmented GC pointer. */
114	DBGCVAR_TYPE_GC_FAR,
115	/** Physical GC pointer. */
116	DBGCVAR_TYPE_GC_PHYS,
117	/** Flat HC pointer. */
118	DBGCVAR_TYPE_HC_FLAT,
119	/** Physical HC pointer. */
120	DBGCVAR_TYPE_HC_PHYS,
121	/** Number. */
122	DBGCVAR_TYPE_NUMBER,
123	/** String. */
124	DBGCVAR_TYPE_STRING,
125	/** Symbol. */
126	DBGCVAR_TYPE_SYMBOL,
127	/** Special type used when querying symbols. */
128	DBGCVAR_TYPE_ANY
129	} DBGCVARTYPE;
130
131	/** @todo Rename to DBGCVAR_IS_xyz. */
132
133	/** Checks if the specified variable type is of a pointer persuasion. */
134	#define DBGCVAR_ISPOINTER(enmType) ((enmType) >= DBGCVAR_TYPE_GC_FLAT && enmType <= DBGCVAR_TYPE_HC_PHYS)
135	/** Checks if the specified variable type is of a pointer persuasion. */
136	#define DBGCVAR_IS_FAR_PTR(enmType) ((enmType) == DBGCVAR_TYPE_GC_FAR)
137	/** Checks if the specified variable type is of a pointer persuasion and of the guest context sort. */
138	#define DBGCVAR_ISGCPOINTER(enmType) ((enmType) >= DBGCVAR_TYPE_GC_FLAT && (enmType) <= DBGCVAR_TYPE_GC_PHYS)
139	/** Checks if the specified variable type is of a pointer persuasion and of the host context sort. */
140	#define DBGCVAR_ISHCPOINTER(enmType) ((enmType) >= DBGCVAR_TYPE_HC_FLAT && (enmType) <= DBGCVAR_TYPE_HC_PHYS)
141
142
143	/**
144	* DBGC variable range type.
145	*/
146	typedef enum DBGCVARRANGETYPE
147	{
148	/** No range appliable or no range specified. */
149	DBGCVAR_RANGE_NONE = 0,
150	/** Number of elements. */
151	DBGCVAR_RANGE_ELEMENTS,
152	/** Number of bytes. */
153	DBGCVAR_RANGE_BYTES
154	} DBGCVARRANGETYPE;
155
156
157	/**
158	* Variable descriptor.
159	*/
160	typedef struct DBGCVARDESC
161	{
162	/** The minimal number of times this argument may occur.
163	* Use 0 here to inidicate that the argument is optional. */
164	unsigned cTimesMin;
165	/** Maximum number of occurrences.
166	* Use ~0 here to indicate infinite. */
167	unsigned cTimesMax;
168	/** Argument category. */
169	DBGCVARCAT enmCategory;
170	/** Flags, DBGCVD_FLAGS_* */
171	unsigned fFlags;
172	/** Argument name. */
173	const char *pszName;
174	/** Argument name. */
175	const char *pszDescription;
176	} DBGCVARDESC;
177	/** Pointer to an argument descriptor. */
178	typedef DBGCVARDESC *PDBGCVARDESC;
179	/** Pointer to a const argument descriptor. */
180	typedef const DBGCVARDESC *PCDBGCVARDESC;
181
182	/** Variable descriptor flags.
183	* @{ */
184	/** Indicates that the variable depends on the previous being present. */
185	#define DBGCVD_FLAGS_DEP_PREV RT_BIT(1)
186	/** @} */
187
188
189	/**
190	* DBGC variable.
191	*/
192	typedef struct DBGCVAR
193	{
194	/** Pointer to the argument descriptor. */
195	PCDBGCVARDESC pDesc;
196	/** Pointer to the next argument. */
197	struct DBGCVAR *pNext;
198
199	/** Argument type. */
200	DBGCVARTYPE enmType;
201	/** Type specific. */
202	union
203	{
204	/** Flat GC Address. (DBGCVAR_TYPE_GC_FLAT) */
205	RTGCPTR GCFlat;
206	/** Far (16:32) GC Address. (DBGCVAR_TYPE_GC_FAR) */
207	RTFAR32 GCFar;
208	/** Physical GC Address. (DBGCVAR_TYPE_GC_PHYS) */
209	RTGCPHYS GCPhys;
210	/** Flat HC Address. (DBGCVAR_TYPE_HC_FLAT) */
211	void *pvHCFlat;
212	/** Physical GC Address. (DBGCVAR_TYPE_HC_PHYS) */
213	RTHCPHYS HCPhys;
214	/** String. (DBGCVAR_TYPE_STRING)
215	* The basic idea is the the this is a pointer to the expression we're
216	* parsing, so no messing with freeing. */
217	const char *pszString;
218	/** Number. (DBGCVAR_TYPE_NUMBER) */
219	uint64_t u64Number;
220	} u;
221
222	/** Range type. */
223	DBGCVARRANGETYPE enmRangeType;
224	/** Range. The use of the content depends on the enmRangeType. */
225	uint64_t u64Range;
226	} DBGCVAR;
227	/** Pointer to a command argument. */
228	typedef DBGCVAR *PDBGCVAR;
229	/** Pointer to a const command argument. */
230	typedef const DBGCVAR *PCDBGCVAR;
231
232
233	/**
234	* Macro for initializing a DBGC variable with defaults.
235	* The result is an unknown variable type without any range.
236	*/
237	#define DBGCVAR_INIT(pVar) \
238	do { \
239	(pVar)->pDesc = NULL;\
240	(pVar)->pNext = NULL; \
241	(pVar)->enmType = DBGCVAR_TYPE_UNKNOWN; \
242	(pVar)->u.u64Number = 0; \
243	(pVar)->enmRangeType = DBGCVAR_RANGE_NONE; \
244	(pVar)->u64Range = 0; \
245	} while (0)
246
247	/**
248	* Macro for initializing a DBGC variable with a HC physical address.
249	*/
250	#define DBGCVAR_INIT_HC_PHYS(pVar, Phys) \
251	do { \
252	DBGCVAR_INIT(pVar); \
253	(pVar)->enmType = DBGCVAR_TYPE_HC_PHYS; \
254	(pVar)->u.HCPhys = (Phys); \
255	} while (0)
256
257	/**
258	* Macro for initializing a DBGC variable with a HC flat address.
259	*/
260	#define DBGCVAR_INIT_HC_FLAT(pVar, Flat) \
261	do { \
262	DBGCVAR_INIT(pVar); \
263	(pVar)->enmType = DBGCVAR_TYPE_HC_FLAT; \
264	(pVar)->u.pvHCFlat = (Flat); \
265	} while (0)
266
267	/**
268	* Macro for initializing a DBGC variable with a GC physical address.
269	*/
270	#define DBGCVAR_INIT_GC_PHYS(pVar, Phys) \
271	do { \
272	DBGCVAR_INIT(pVar); \
273	(pVar)->enmType = DBGCVAR_TYPE_GC_PHYS; \
274	(pVar)->u.GCPhys = (Phys); \
275	} while (0)
276
277	/**
278	* Macro for initializing a DBGC variable with a GC flat address.
279	*/
280	#define DBGCVAR_INIT_GC_FLAT(pVar, Flat) \
281	do { \
282	DBGCVAR_INIT(pVar); \
283	(pVar)->enmType = DBGCVAR_TYPE_GC_FLAT; \
284	(pVar)->u.GCFlat = (Flat); \
285	} while (0)
286
287	/**
288	* Macro for initializing a DBGC variable with a GC flat address.
289	*/
290	#define DBGCVAR_INIT_GC_FLAT_BYTE_RANGE(pVar, Flat, cbRange) \
291	do { \
292	DBGCVAR_INIT(pVar); \
293	(pVar)->enmType = DBGCVAR_TYPE_GC_FLAT; \
294	(pVar)->u.GCFlat = (Flat); \
295	DBGCVAR_SET_RANGE(pVar, DBGCVAR_RANGE_BYTES, cbRange); \
296	} while (0)
297
298	/**
299	* Macro for initializing a DBGC variable with a GC far address.
300	*/
301	#define DBGCVAR_INIT_GC_FAR(pVar, _sel, _off) \
302	do { \
303	DBGCVAR_INIT(pVar); \
304	(pVar)->enmType = DBGCVAR_TYPE_GC_FAR; \
305	(pVar)->u.GCFar.sel = (_sel); \
306	(pVar)->u.GCFar.off = (_off); \
307	} while (0)
308
309	/**
310	* Macro for initializing a DBGC variable with a number.
311	*/
312	#define DBGCVAR_INIT_NUMBER(pVar, Value) \
313	do { \
314	DBGCVAR_INIT(pVar); \
315	(pVar)->enmType = DBGCVAR_TYPE_NUMBER; \
316	(pVar)->u.u64Number = (Value); \
317	} while (0)
318
319	/**
320	* Macro for initializing a DBGC variable with a string.
321	*/
322	#define DBGCVAR_INIT_STRING(pVar, a_pszString) \
323	do { \
324	DBGCVAR_INIT(pVar); \
325	(pVar)->enmType = DBGCVAR_TYPE_STRING; \
326	(pVar)->enmRangeType = DBGCVAR_RANGE_BYTES; \
327	(pVar)->u.pszString = (a_pszString); \
328	(pVar)->u64Range = strlen(a_pszString); \
329	} while (0)
330
331
332	/**
333	* Macro for initializing a DBGC variable with a symbol.
334	*/
335	#define DBGCVAR_INIT_SYMBOL(pVar, a_pszSymbol) \
336	do { \
337	DBGCVAR_INIT(pVar); \
338	(pVar)->enmType = DBGCVAR_TYPE_SYMBOL; \
339	(pVar)->enmRangeType = DBGCVAR_RANGE_BYTES; \
340	(pVar)->u.pszString = (a_pszSymbol); \
341	(pVar)->u64Range = strlen(a_pszSymbol); \
342	} while (0)
343
344
345	/**
346	* Macro for setting the range of a DBGC variable.
347	* @param pVar The variable.
348	* @param _enmRangeType The range type.
349	* @param Value The range length value.
350	*/
351	#define DBGCVAR_SET_RANGE(pVar, _enmRangeType, Value) \
352	do { \
353	(pVar)->enmRangeType = (_enmRangeType); \
354	(pVar)->u64Range = (Value); \
355	} while (0)
356
357
358	/**
359	* Macro for setting the range of a DBGC variable.
360	* @param a_pVar The variable.
361	* @param a_cbRange The range, in bytes.
362	*/
363	#define DBGCVAR_SET_BYTE_RANGE(a_pVar, a_cbRange) \
364	DBGCVAR_SET_RANGE(a_pVar, DBGCVAR_RANGE_BYTES, a_cbRange)
365
366
367	/**
368	* Macro for resetting the range a DBGC variable.
369	* @param a_pVar The variable.
370	*/
371	#define DBGCVAR_ZAP_RANGE(a_pVar) \
372	do { \
373	(a_pVar)->enmRangeType = DBGCVAR_RANGE_NONE; \
374	(a_pVar)->u64Range = 0; \
375	} while (0)
376
377
378	/**
379	* Macro for assigning one DBGC variable to another.
380	* @param a_pResult The result (target) variable.
381	* @param a_pVar The source variable.
382	*/
383	#define DBGCVAR_ASSIGN(a_pResult, a_pVar) \
384	do { \
385	(a_pResult) = (a_pVar); \
386	} while (0)
387
388
389	/** Pointer to a command descriptor. */
390	typedef struct DBGCCMD *PDBGCCMD;
391	/** Pointer to a const command descriptor. */
392	typedef const struct DBGCCMD *PCDBGCCMD;
393
394	/** Pointer to a function descriptor. */
395	typedef struct DBGCFUNC *PDBGCFUNC;
396	/** Pointer to a const function descriptor. */
397	typedef const struct DBGCFUNC *PCDBGCFUNC;
398
399	/** Pointer to helper functions for commands. */
400	typedef struct DBGCCMDHLP *PDBGCCMDHLP;
401
402
403	/**
404	* Helper functions for commands.
405	*/
406	typedef struct DBGCCMDHLP
407	{
408	/** Magic value (DBGCCMDHLP_MAGIC). */
409	uint32_t u32Magic;
410
411	/**
412	* Command helper for writing formatted text to the debug console.
413	*
414	* @returns VBox status.
415	* @param pCmdHlp Pointer to the command callback structure.
416	* @param pcb Where to store the number of bytes written.
417	* @param pszFormat The format string. This may use all IPRT extensions as
418	* well as the debugger ones.
419	* @param ... Arguments specified in the format string.
420	*/
421	DECLCALLBACKMEMBER(int, pfnPrintf)(PDBGCCMDHLP pCmdHlp, size_t *pcbWritten,
422	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
423
424	/**
425	* Command helper for writing formatted text to the debug console.
426	*
427	* @returns VBox status.
428	* @param pCmdHlp Pointer to the command callback structure.
429	* @param pcb Where to store the number of bytes written.
430	* @param pszFormat The format string. This may use all IPRT extensions as
431	* well as the debugger ones.
432	* @param args Arguments specified in the format string.
433	*/
434	DECLCALLBACKMEMBER(int, pfnPrintfV)(PDBGCCMDHLP pCmdHlp, size_t *pcbWritten,
435	const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(3, 0);
436
437	/**
438	* Command helper for formatting a string with debugger format specifiers.
439	*
440	* @returns The number of bytes written.
441	* @param pCmdHlp Pointer to the command callback structure.
442	* @param pszBuf The output buffer.
443	* @param cbBuf The size of the output buffer.
444	* @param pszFormat The format string. This may use all IPRT extensions as
445	* well as the debugger ones.
446	* @param ... Arguments specified in the format string.
447	*/
448	DECLCALLBACKMEMBER(size_t, pfnStrPrintf)(PDBGCCMDHLP pCmdHlp, char *pszBuf, size_t cbBuf,
449	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5);
450
451	/**
452	* Command helper for formatting a string with debugger format specifiers.
453	*
454	* @returns The number of bytes written.
455	* @param pCmdHlp Pointer to the command callback structure.
456	* @param pszBuf The output buffer.
457	* @param cbBuf The size of the output buffer.
458	* @param pszFormat The format string. This may use all IPRT extensions as
459	* well as the debugger ones.
460	* @param va Arguments specified in the format string.
461	*/
462	DECLCALLBACKMEMBER(size_t, pfnStrPrintfV)(PDBGCCMDHLP pCmdHlp, char *pszBuf, size_t cbBuf,
463	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(4, 0);
464
465	/**
466	* Command helper for formatting and error message for a VBox status code.
467	*
468	* @returns VBox status code appropriate to return from a command.
469	* @param pCmdHlp Pointer to the command callback structure.
470	* @param rc The VBox status code.
471	* @param pszFormat Format string for additional messages. Can be NULL.
472	* @param ... Format arguments, optional.
473	*/
474	DECLCALLBACKMEMBER(int, pfnVBoxError)(PDBGCCMDHLP pCmdHlp, int rc, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
475
476	/**
477	* Command helper for formatting and error message for a VBox status code.
478	*
479	* @returns VBox status code appropriate to return from a command.
480	* @param pCmdHlp Pointer to the command callback structure.
481	* @param rc The VBox status code.
482	* @param pcb Where to store the number of bytes written.
483	* @param pszFormat Format string for additional messages. Can be NULL.
484	* @param args Format arguments, optional.
485	*/
486	DECLCALLBACKMEMBER(int, pfnVBoxErrorV)(PDBGCCMDHLP pCmdHlp, int rc,
487	const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(3, 0);
488
489	/**
490	* Command helper for reading memory specified by a DBGC variable.
491	*
492	* @returns VBox status code appropriate to return from a command.
493	* @param pCmdHlp Pointer to the command callback structure.
494	* @param pvBuffer Where to store the read data.
495	* @param cbRead Number of bytes to read.
496	* @param pVarPointer DBGC variable specifying where to start reading.
497	* @param pcbRead Where to store the number of bytes actually read.
498	* This optional, but it's useful when read GC virtual memory where a
499	* page in the requested range might not be present.
500	* If not specified not-present failure or end of a HC physical page
501	* will cause failure.
502	*/
503	DECLCALLBACKMEMBER(int, pfnMemRead)(PDBGCCMDHLP pCmdHlp, void pvBuffer, size_t cbRead, PCDBGCVAR pVarPointer, size_t pcbRead);
504
505	/**
506	* Command helper for writing memory specified by a DBGC variable.
507	*
508	* @returns VBox status code appropriate to return from a command.
509	* @param pCmdHlp Pointer to the command callback structure.
510	* @param pvBuffer What to write.
511	* @param cbWrite Number of bytes to write.
512	* @param pVarPointer DBGC variable specifying where to start reading.
513	* @param pcbWritten Where to store the number of bytes written.
514	* This is optional. If NULL be aware that some of the buffer
515	* might have been written to the specified address.
516	*/
517	DECLCALLBACKMEMBER(int, pfnMemWrite)(PDBGCCMDHLP pCmdHlp, const void pvBuffer, size_t cbWrite, PCDBGCVAR pVarPointer, size_t pcbWritten);
518
519	/**
520	* Executes command an expression.
521	* (Hopefully the parser and functions are fully reentrant.)
522	*
523	* @returns VBox status code appropriate to return from a command.
524	* @param pCmdHlp Pointer to the command callback structure.
525	* @param pszExpr The expression. Format string with the format DBGC extensions.
526	* @param ... Format arguments.
527	*/
528	DECLCALLBACKMEMBER(int, pfnExec)(PDBGCCMDHLP pCmdHlp, const char *pszExpr, ...) RT_IPRT_FORMAT_ATTR(2, 3);
529
530	/**
531	* Evaluates an expression.
532	* (Hopefully the parser and functions are fully reentrant.)
533	*
534	* @returns VBox status code appropriate to return from a command.
535	* @param pCmdHlp Pointer to the command callback structure.
536	* @param pResult Where to store the result.
537	* @param pszExpr The expression. Format string with the format DBGC extensions.
538	* @param va Format arguments.
539	*/
540	DECLCALLBACKMEMBER(int, pfnEvalV)(PDBGCCMDHLP pCmdHlp, PDBGCVAR pResult,
541	const char *pszExpr, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
542
543	/**
544	* Print an error and fail the current command.
545	*
546	* @returns VBox status code to pass upwards.
547	*
548	* @param pCmdHlp Pointer to the command callback structure.
549	* @param pCmd The failing command.
550	* @param pszFormat The error message format string.
551	* @param va Format arguments.
552	*/
553	DECLCALLBACKMEMBER(int, pfnFailV)(PDBGCCMDHLP pCmdHlp, PCDBGCCMD pCmd,
554	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
555
556	/**
557	* Print an error and fail the current command.
558	*
559	* @returns VBox status code to pass upwards.
560	*
561	* @param pCmdHlp Pointer to the command callback structure.
562	* @param pCmd The failing command.
563	* @param rc The status code indicating the failure. This will
564	* be appended to the message after a colon (': ').
565	* @param pszFormat The error message format string.
566	* @param va Format arguments.
567	*
568	* @see DBGCCmdHlpFailRc
569	*/
570	DECLCALLBACKMEMBER(int, pfnFailRcV)(PDBGCCMDHLP pCmdHlp, PCDBGCCMD pCmd, int rc,
571	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(4, 0);
572
573	/**
574	* Parser error.
575	*
576	* @returns VBox status code to pass upwards.
577	*
578	* @param pCmdHlp Pointer to the command callback structure.
579	* @param pCmd The failing command, can be NULL but shouldn't.
580	* @param iArg The offending argument, -1 when lazy.
581	* @param pszExpr The expression.
582	* @param iLine The line number.
583	*/
584	DECLCALLBACKMEMBER(int, pfnParserError)(PDBGCCMDHLP pCmdHlp, PCDBGCCMD pCmd, int iArg, const char *pszExpr, unsigned iLine);
585
586	/**
587	* Converts a DBGC variable to a DBGF address structure.
588	*
589	* @returns VBox status code.
590	* @param pCmdHlp Pointer to the command callback structure.
591	* @param pVar The variable to convert.
592	* @param pAddress The target address.
593	*/
594	DECLCALLBACKMEMBER(int, pfnVarToDbgfAddr)(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, PDBGFADDRESS pAddress);
595
596	/**
597	* Converts a DBGF address structure to a DBGC variable.
598	*
599	* @returns VBox status code.
600	* @param pCmdHlp Pointer to the command callback structure.
601	* @param pAddress The source address.
602	* @param pResult The result variable.
603	*/
604	DECLCALLBACKMEMBER(int, pfnVarFromDbgfAddr)(PDBGCCMDHLP pCmdHlp, PCDBGFADDRESS pAddress, PDBGCVAR pResult);
605
606	/**
607	* Converts a DBGC variable to a 64-bit number.
608	*
609	* @returns VBox status code.
610	* @param pCmdHlp Pointer to the command callback structure.
611	* @param pVar The variable to convert.
612	* @param pu64Number Where to store the number.
613	*/
614	DECLCALLBACKMEMBER(int, pfnVarToNumber)(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, uint64_t *pu64Number);
615
616	/**
617	* Converts a DBGC variable to a boolean.
618	*
619	* @returns VBox status code.
620	* @param pCmdHlp Pointer to the command callback structure.
621	* @param pVar The variable to convert.
622	* @param pf Where to store the boolean.
623	*/
624	DECLCALLBACKMEMBER(int, pfnVarToBool)(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, bool *pf);
625
626	/**
627	* Get the range of a variable in bytes, resolving symbols if necessary.
628	*
629	* @returns VBox status code.
630	* @param pCmdHlp Pointer to the command callback structure.
631	* @param pVar The variable to convert.
632	* @param cbElement Conversion factor for element ranges.
633	* @param cbDefault The default range.
634	* @param pcbRange The length of the range.
635	*/
636	DECLCALLBACKMEMBER(int, pfnVarGetRange)(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, uint64_t cbElement, uint64_t cbDefault,
637	uint64_t *pcbRange);
638
639	/**
640	* Converts a variable to one with the specified type.
641	*
642	* This preserves the range.
643	*
644	* @returns VBox status code.
645	* @param pCmdHlp Pointer to the command callback structure.
646	* @param pVar The variable to convert.
647	* @param enmToType The target type.
648	* @param fConvSyms If @c true, then attempt to resolve symbols.
649	* @param pResult The output variable. Can be the same as @a pVar.
650	*/
651	DECLCALLBACKMEMBER(int, pfnVarConvert)(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, DBGCVARTYPE enmToType, bool fConvSyms,
652	PDBGCVAR pResult);
653
654	/**
655	* Gets a DBGF output helper that directs the output to the debugger
656	* console.
657	*
658	* @returns Pointer to the helper structure.
659	* @param pCmdHlp Pointer to the command callback structure.
660	*/
661	DECLCALLBACKMEMBER(PCDBGFINFOHLP, pfnGetDbgfOutputHlp)(PDBGCCMDHLP pCmdHlp);
662
663	/**
664	* Gets the ID currently selected CPU.
665	*
666	* @returns Current CPU ID.
667	* @param pCmdHlp Pointer to the command callback structure.
668	*/
669	DECLCALLBACKMEMBER(VMCPUID, pfnGetCurrentCpu)(PDBGCCMDHLP pCmdHlp);
670
671	/**
672	* Gets the mode the currently selected CPU is running in, in the current
673	* context.
674	*
675	* @returns Current CPU mode.
676	* @param pCmdHlp Pointer to the command callback structure.
677	*/
678	DECLCALLBACKMEMBER(CPUMMODE, pfnGetCpuMode)(PDBGCCMDHLP pCmdHlp);
679
680	/** End marker (DBGCCMDHLP_MAGIC). */
681	uint32_t u32EndMarker;
682	} DBGCCMDHLP;
683
684	/** Magic value for DBGCCMDHLP::u32Magic. (Fyodor Mikhaylovich Dostoyevsky) */
685	#define DBGCCMDHLP_MAGIC UINT32_C(18211111)
686
687
688	#ifdef IN_RING3
689
690	/**
691	* Command helper for writing formatted text to the debug console.
692	*
693	* @returns VBox status.
694	* @param pCmdHlp Pointer to the command callback structure.
695	* @param pszFormat The format string. This may use all IPRT extensions as
696	* well as the debugger ones.
697	* @param ... Arguments specified in the format string.
698	*/
699	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(2, 3) DBGCCmdHlpPrintf(PDBGCCMDHLP pCmdHlp, const char *pszFormat, ...)
700	{
701	va_list va;
702	int rc;
703
704	va_start(va, pszFormat);
705	rc = pCmdHlp->pfnPrintfV(pCmdHlp, NULL, pszFormat, va);
706	va_end(va);
707
708	return rc;
709	}
710
711
712	/**
713	* @copydoc DBGCCMDHLP::pfnStrPrintf
714	*/
715	DECLINLINE(size_t) RT_IPRT_FORMAT_ATTR(4, 5) DBGCCmdHlpStrPrintf(PDBGCCMDHLP pCmdHlp, char *pszBuf, size_t cbBuf,
716	const char *pszFormat, ...)
717	{
718	va_list va;
719	size_t cch;
720
721	va_start(va, pszFormat);
722	cch = pCmdHlp->pfnStrPrintfV(pCmdHlp, pszBuf, cbBuf, pszFormat, va);
723	va_end(va);
724
725	return cch;
726	}
727
728	/**
729	* @copydoc DBGCCMDHLP::pfnVBoxError
730	*/
731	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(3, 4) DBGCCmdHlpVBoxError(PDBGCCMDHLP pCmdHlp, int rc, const char *pszFormat, ...)
732	{
733	va_list va;
734
735	va_start(va, pszFormat);
736	rc = pCmdHlp->pfnVBoxErrorV(pCmdHlp, rc, pszFormat, va);
737	va_end(va);
738
739	return rc;
740	}
741
742	/**
743	* @copydoc DBGCCMDHLP::pfnMemRead
744	*/
745	DECLINLINE(int) DBGCCmdHlpMemRead(PDBGCCMDHLP pCmdHlp, void pvBuffer, size_t cbRead, PCDBGCVAR pVarPointer, size_t pcbRead)
746	{
747	return pCmdHlp->pfnMemRead(pCmdHlp, pvBuffer, cbRead, pVarPointer, pcbRead);
748	}
749
750	/**
751	* Evaluates an expression.
752	* (Hopefully the parser and functions are fully reentrant.)
753	*
754	* @returns VBox status code appropriate to return from a command.
755	* @param pCmdHlp Pointer to the command callback structure.
756	* @param pResult Where to store the result.
757	* @param pszExpr The expression. Format string with the format DBGC extensions.
758	* @param ... Format arguments.
759	*/
760	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(3, 4) DBGCCmdHlpEval(PDBGCCMDHLP pCmdHlp, PDBGCVAR pResult, const char *pszExpr, ...)
761	{
762	va_list va;
763	int rc;
764
765	va_start(va, pszExpr);
766	rc = pCmdHlp->pfnEvalV(pCmdHlp, pResult, pszExpr, va);
767	va_end(va);
768
769	return rc;
770	}
771
772	/**
773	* Print an error and fail the current command.
774	*
775	* @returns VBox status code to pass upwards.
776	*
777	* @param pCmdHlp Pointer to the command callback structure.
778	* @param pCmd The failing command.
779	* @param pszFormat The error message format string.
780	* @param ... Format arguments.
781	*/
782	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(3, 4) DBGCCmdHlpFail(PDBGCCMDHLP pCmdHlp, PCDBGCCMD pCmd, const char *pszFormat, ...)
783	{
784	va_list va;
785	int rc;
786
787	va_start(va, pszFormat);
788	rc = pCmdHlp->pfnFailV(pCmdHlp, pCmd, pszFormat, va);
789	va_end(va);
790
791	return rc;
792	}
793
794	/**
795	* Print an error and fail the current command.
796	*
797	* Usage example:
798	* @code
799	int rc = VMMR3Something(pVM);
800	if (RT_FAILURE(rc))
801	return DBGCCmdHlpFailRc(pCmdHlp, pCmd, rc, "VMMR3Something");
802	return VINF_SUCCESS;
803	* @endcode
804	*
805	* @returns VBox status code to pass upwards.
806	*
807	* @param pCmdHlp Pointer to the command callback structure.
808	* @param pCmd The failing command.
809	* @param rc The status code indicating the failure.
810	* @param pszFormat The error message format string.
811	* @param ... Format arguments.
812	*/
813	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 5) DBGCCmdHlpFailRc(PDBGCCMDHLP pCmdHlp, PCDBGCCMD pCmd, int rc,
814	const char *pszFormat, ...)
815	{
816	va_list va;
817
818	va_start(va, pszFormat);
819	rc = pCmdHlp->pfnFailRcV(pCmdHlp, pCmd, rc, pszFormat, va);
820	va_end(va);
821
822	return rc;
823	}
824
825	/**
826	* @copydoc DBGCCMDHLP::pfnParserError
827	*/
828	DECLINLINE(int) DBGCCmdHlpParserError(PDBGCCMDHLP pCmdHlp, PCDBGCCMD pCmd, int iArg, const char *pszExpr, unsigned iLine)
829	{
830	return pCmdHlp->pfnParserError(pCmdHlp, pCmd, iArg, pszExpr, iLine);
831	}
832
833	/** Assert+return like macro for checking parser sanity.
834	* Returns with failure if the precodition is not met. */
835	#define DBGC_CMDHLP_ASSERT_PARSER_RET(pCmdHlp, pCmd, iArg, expr) \
836	do { \
837	if (!(expr)) \
838	return DBGCCmdHlpParserError(pCmdHlp, pCmd, iArg, #expr, __LINE__); \
839	} while (0)
840
841	/** Assert+return like macro that the VM handle is present.
842	* Returns with failure if the VM handle is NIL. */
843	#define DBGC_CMDHLP_REQ_UVM_RET(pCmdHlp, pCmd, pUVM) \
844	do { \
845	if (!(pUVM)) \
846	return DBGCCmdHlpFail(pCmdHlp, pCmd, "No VM selected"); \
847	} while (0)
848
849	/**
850	* @copydoc DBGCCMDHLP::pfnVarToDbgfAddr
851	*/
852	DECLINLINE(int) DBGCCmdHlpVarToDbgfAddr(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, PDBGFADDRESS pAddress)
853	{
854	return pCmdHlp->pfnVarToDbgfAddr(pCmdHlp, pVar, pAddress);
855	}
856
857	/**
858	* @copydoc DBGCCMDHLP::pfnVarFromDbgfAddr
859	*/
860	DECLINLINE(int) DBGCCmdHlpVarFromDbgfAddr(PDBGCCMDHLP pCmdHlp, PCDBGFADDRESS pAddress, PDBGCVAR pResult)
861	{
862	return pCmdHlp->pfnVarFromDbgfAddr(pCmdHlp, pAddress, pResult);
863	}
864
865	/**
866	* Converts an variable to a flat address.
867	*
868	* @returns VBox status code.
869	* @param pCmdHlp Pointer to the command callback structure.
870	* @param pVar The variable to convert.
871	* @param pFlatPtr Where to store the flat address.
872	*/
873	DECLINLINE(int) DBGCCmdHlpVarToFlatAddr(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, PRTGCPTR pFlatPtr)
874	{
875	DBGFADDRESS Addr;
876	int rc = pCmdHlp->pfnVarToDbgfAddr(pCmdHlp, pVar, &Addr);
877	if (RT_SUCCESS(rc))
878	*pFlatPtr = Addr.FlatPtr;
879	return rc;
880	}
881
882	/**
883	* @copydoc DBGCCMDHLP::pfnVarToNumber
884	*/
885	DECLINLINE(int) DBGCCmdHlpVarToNumber(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, uint64_t *pu64Number)
886	{
887	return pCmdHlp->pfnVarToNumber(pCmdHlp, pVar, pu64Number);
888	}
889
890	/**
891	* @copydoc DBGCCMDHLP::pfnVarToBool
892	*/
893	DECLINLINE(int) DBGCCmdHlpVarToBool(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, bool *pf)
894	{
895	return pCmdHlp->pfnVarToBool(pCmdHlp, pVar, pf);
896	}
897
898	/**
899	* @copydoc DBGCCMDHLP::pfnVarGetRange
900	*/
901	DECLINLINE(int) DBGCCmdHlpVarGetRange(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, uint64_t cbElement, uint64_t cbDefault, uint64_t *pcbRange)
902	{
903	return pCmdHlp->pfnVarGetRange(pCmdHlp, pVar, cbElement, cbDefault, pcbRange);
904	}
905
906	/**
907	* @copydoc DBGCCMDHLP::pfnVarConvert
908	*/
909	DECLINLINE(int) DBGCCmdHlpConvert(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, DBGCVARTYPE enmToType, bool fConvSyms, PDBGCVAR pResult)
910	{
911	return pCmdHlp->pfnVarConvert(pCmdHlp, pVar, enmToType, fConvSyms, pResult);
912	}
913
914	/**
915	* @copydoc DBGCCMDHLP::pfnGetDbgfOutputHlp
916	*/
917	DECLINLINE(PCDBGFINFOHLP) DBGCCmdHlpGetDbgfOutputHlp(PDBGCCMDHLP pCmdHlp)
918	{
919	return pCmdHlp->pfnGetDbgfOutputHlp(pCmdHlp);
920	}
921
922	/**
923	* @copydoc DBGCCMDHLP::pfnGetCurrentCpu
924	*/
925	DECLINLINE(VMCPUID) DBGCCmdHlpGetCurrentCpu(PDBGCCMDHLP pCmdHlp)
926	{
927	return pCmdHlp->pfnGetCurrentCpu(pCmdHlp);
928	}
929
930	/**
931	* @copydoc DBGCCMDHLP::pfnGetCpuMode
932	*/
933	DECLINLINE(CPUMMODE) DBGCCmdHlpGetCpuMode(PDBGCCMDHLP pCmdHlp)
934	{
935	return pCmdHlp->pfnGetCpuMode(pCmdHlp);
936	}
937
938	#endif /* IN_RING3 */
939
940
941
942	/**
943	* Command handler.
944	*
945	* The console will call the handler for a command once it's finished
946	* parsing the user input. The command handler function is responsible
947	* for executing the command itself.
948	*
949	* @returns VBox status.
950	* @param pCmd Pointer to the command descriptor (as registered).
951	* @param pCmdHlp Pointer to command helper functions.
952	* @param pUVM The user mode VM handle, can in theory be NULL.
953	* @param paArgs Pointer to (readonly) array of arguments.
954	* @param cArgs Number of arguments in the array.
955	*/
956	typedef DECLCALLBACK(int) FNDBGCCMD(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PUVM pUVM, PCDBGCVAR paArgs, unsigned cArgs);
957	/** Pointer to a FNDBGCCMD() function. */
958	typedef FNDBGCCMD *PFNDBGCCMD;
959
960	/**
961	* DBGC command descriptor.
962	*/
963	typedef struct DBGCCMD
964	{
965	/** Command string. */
966	const char *pszCmd;
967	/** Minimum number of arguments. */
968	unsigned cArgsMin;
969	/** Max number of arguments. */
970	unsigned cArgsMax;
971	/** Argument descriptors (array). */
972	PCDBGCVARDESC paArgDescs;
973	/** Number of argument descriptors. */
974	unsigned cArgDescs;
975	/** flags. (reserved for now) */
976	unsigned fFlags;
977	/** Handler function. */
978	PFNDBGCCMD pfnHandler;
979	/** Command syntax. */
980	const char *pszSyntax;
981	/** Command description. */
982	const char *pszDescription;
983	} DBGCCMD;
984
985	/** DBGCCMD Flags.
986	* @{
987	*/
988	/** @} */
989
990
991	/**
992	* Function handler.
993	*
994	* The console will call the handler for a command once it's finished
995	* parsing the user input. The command handler function is responsible
996	* for executing the command itself.
997	*
998	* @returns VBox status.
999	* @param pCmd Pointer to the command descriptor (as registered).
1000	* @param pCmdHlp Pointer to command helper functions.
1001	* @param pUVM The user mode VM handle, can in theory be NULL.
1002	* @param paArgs Pointer to (readonly) array of arguments.
1003	* @param cArgs Number of arguments in the array.
1004	* @param pResult Where to return the result.
1005	*/
1006	typedef DECLCALLBACK(int) FNDBGCFUNC(PCDBGCFUNC pFunc, PDBGCCMDHLP pCmdHlp, PUVM pUVM, PCDBGCVAR paArgs, unsigned cArgs,
1007	PDBGCVAR pResult);
1008	/** Pointer to a FNDBGCFUNC() function. */
1009	typedef FNDBGCFUNC *PFNDBGCFUNC;
1010
1011	/**
1012	* DBGC function descriptor.
1013	*/
1014	typedef struct DBGCFUNC
1015	{
1016	/** Command string. */
1017	const char *pszFuncNm;
1018	/** Minimum number of arguments. */
1019	unsigned cArgsMin;
1020	/** Max number of arguments. */
1021	unsigned cArgsMax;
1022	/** Argument descriptors (array). */
1023	PCDBGCVARDESC paArgDescs;
1024	/** Number of argument descriptors. */
1025	unsigned cArgDescs;
1026	/** flags. (reserved for now) */
1027	unsigned fFlags;
1028	/** Handler function. */
1029	PFNDBGCFUNC pfnHandler;
1030	/** Function syntax. */
1031	const char *pszSyntax;
1032	/** Function description. */
1033	const char *pszDescription;
1034	} DBGCFUNC;
1035
1036
1037
1038	/** Pointer to a DBGC backend. */
1039	typedef struct DBGCBACK *PDBGCBACK;
1040
1041	/**
1042	* Checks if there is input.
1043	*
1044	* @returns true if there is input ready.
1045	* @returns false if there not input ready.
1046	* @param pBack Pointer to the backend structure supplied by
1047	* the backend. The backend can use this to find
1048	* it's instance data.
1049	* @param cMillies Number of milliseconds to wait on input data.
1050	*/
1051	typedef DECLCALLBACK(bool) FNDBGCBACKINPUT(PDBGCBACK pBack, uint32_t cMillies);
1052	/** Pointer to a FNDBGCBACKINPUT() callback. */
1053	typedef FNDBGCBACKINPUT *PFNDBGCBACKINPUT;
1054
1055	/**
1056	* Read input.
1057	*
1058	* @returns VBox status code.
1059	* @param pBack Pointer to the backend structure supplied by
1060	* the backend. The backend can use this to find
1061	* it's instance data.
1062	* @param pvBuf Where to put the bytes we read.
1063	* @param cbBuf Maximum nymber of bytes to read.
1064	* @param pcbRead Where to store the number of bytes actually read.
1065	* If NULL the entire buffer must be filled for a
1066	* successful return.
1067	*/
1068	typedef DECLCALLBACK(int) FNDBGCBACKREAD(PDBGCBACK pBack, void pvBuf, size_t cbBuf, size_t pcbRead);
1069	/** Pointer to a FNDBGCBACKREAD() callback. */
1070	typedef FNDBGCBACKREAD *PFNDBGCBACKREAD;
1071
1072	/**
1073	* Write (output).
1074	*
1075	* @returns VBox status code.
1076	* @param pBack Pointer to the backend structure supplied by
1077	* the backend. The backend can use this to find
1078	* it's instance data.
1079	* @param pvBuf What to write.
1080	* @param cbBuf Number of bytes to write.
1081	* @param pcbWritten Where to store the number of bytes actually written.
1082	* If NULL the entire buffer must be successfully written.
1083	*/
1084	typedef DECLCALLBACK(int) FNDBGCBACKWRITE(PDBGCBACK pBack, const void pvBuf, size_t cbBuf, size_t pcbWritten);
1085	/** Pointer to a FNDBGCBACKWRITE() callback. */
1086	typedef FNDBGCBACKWRITE *PFNDBGCBACKWRITE;
1087
1088	/**
1089	* Ready / busy notification.
1090	*
1091	* @param pBack Pointer to the backend structure supplied by
1092	* the backend. The backend can use this to find
1093	* it's instance data.
1094	* @param fReady Whether it's ready (true) or busy (false).
1095	*/
1096	typedef DECLCALLBACK(void) FNDBGCBACKSETREADY(PDBGCBACK pBack, bool fReady);
1097	/** Pointer to a FNDBGCBACKSETREADY() callback. */
1098	typedef FNDBGCBACKSETREADY *PFNDBGCBACKSETREADY;
1099
1100
1101	/**
1102	* The communication backend provides the console with a number of callbacks
1103	* which can be used
1104	*/
1105	typedef struct DBGCBACK
1106	{
1107	/** Check for input. */
1108	PFNDBGCBACKINPUT pfnInput;
1109	/** Read input. */
1110	PFNDBGCBACKREAD pfnRead;
1111	/** Write output. */
1112	PFNDBGCBACKWRITE pfnWrite;
1113	/** Ready / busy notification. */
1114	PFNDBGCBACKSETREADY pfnSetReady;
1115	} DBGCBACK;
1116
1117	DBGDECL(int) DBGCCreate(PUVM pUVM, PDBGCBACK pBack, unsigned fFlags);
1118	DBGDECL(int) DBGCRegisterCommands(PCDBGCCMD paCommands, unsigned cCommands);
1119	DBGDECL(int) DBGCDeregisterCommands(PCDBGCCMD paCommands, unsigned cCommands);
1120	DBGDECL(int) DBGCTcpCreate(PUVM pUVM, void **ppvUser);
1121	DBGDECL(int) DBGCTcpTerminate(PUVM pUVM, void *pvData);
1122
1123	/** @} */
1124
1125	#endif /* IN_RING3 */
1126
1127	/** @} */
1128	RT_C_DECLS_END
1129
1130	#endif

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/dbg.h@ 59294

Download in other formats: