dbg.h@ 47791

Last change on this file since 47791 was 46165, checked in by vboxsync, 12 years ago
Made dSYM-bundle loading work as well as line numbers in the stack traces (when possible).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 62.0 KB

Line
1	/* $Id: dbg.h 46165 2013-05-19 19:07:50Z vboxsync $ */
2	/** @file
3	* IPRT - Debugging Routines.
4	*/
5
6	/*
7	* Copyright (C) 2008-2012 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27	#ifndef ___iprt_dbg_h
28	#define ___iprt_dbg_h
29
30	#include <iprt/types.h>
31	#include <iprt/stdarg.h>
32	#include <iprt/ldr.h>
33
34	RT_C_DECLS_BEGIN
35
36	# ifdef IN_RING3
37
38	/** @defgroup grp_rt_dbg RTDbg - Debugging Routines
39	* @ingroup grp_rt
40	* @{
41	*/
42
43
44	/** Debug segment index. */
45	typedef uint32_t RTDBGSEGIDX;
46	/** Pointer to a debug segment index. */
47	typedef RTDBGSEGIDX *PRTDBGSEGIDX;
48	/** Pointer to a const debug segment index. */
49	typedef RTDBGSEGIDX const *PCRTDBGSEGIDX;
50	/** NIL debug segment index. */
51	#define NIL_RTDBGSEGIDX UINT32_C(0xffffffff)
52	/** The last normal segment index. */
53	#define RTDBGSEGIDX_LAST UINT32_C(0xffffffef)
54	/** Special segment index that indicates that the offset is a relative
55	* virtual address (RVA). I.e. an offset from the start of the module. */
56	#define RTDBGSEGIDX_RVA UINT32_C(0xfffffff0)
57	/** Special segment index that indicates that the offset is a absolute. */
58	#define RTDBGSEGIDX_ABS UINT32_C(0xfffffff1)
59	/** The last valid special segment index. */
60	#define RTDBGSEGIDX_SPECIAL_LAST RTDBGSEGIDX_ABS
61	/** The last valid special segment index. */
62	#define RTDBGSEGIDX_SPECIAL_FIRST (RTDBGSEGIDX_LAST + 1U)
63
64
65
66	/** @name RTDBGSYMADDR_FLAGS_XXX
67	* Flags used when looking up a symbol by address.
68	* @{ */
69	/** Less or equal address. (default) */
70	#define RTDBGSYMADDR_FLAGS_LESS_OR_EQUAL UINT32_C(0)
71	/** Greater or equal address. */
72	#define RTDBGSYMADDR_FLAGS_GREATER_OR_EQUAL UINT32_C(1)
73	/** Mask of valid flags. */
74	#define RTDBGSYMADDR_FLAGS_VALID_MASK UINT32_C(1)
75	/** @} */
76
77
78	/** Max length (including '\\0') of a segment name. */
79	#define RTDBG_SEGMENT_NAME_LENGTH (128 - 8 - 8 - 8 - 4 - 4)
80
81	/**
82	* Debug module segment.
83	*/
84	typedef struct RTDBGSEGMENT
85	{
86	/** The load address.
87	* RTUINTPTR_MAX if not applicable. */
88	RTUINTPTR Address;
89	/** The image relative virtual address of the segment.
90	* RTUINTPTR_MAX if not applicable. */
91	RTUINTPTR uRva;
92	/** The segment size. */
93	RTUINTPTR cb;
94	/** The segment flags. (reserved) */
95	uint32_t fFlags;
96	/** The segment index. */
97	RTDBGSEGIDX iSeg;
98	/** Symbol name. */
99	char szName[RTDBG_SEGMENT_NAME_LENGTH];
100	} RTDBGSEGMENT;
101	/** Pointer to a debug module segment. */
102	typedef RTDBGSEGMENT *PRTDBGSEGMENT;
103	/** Pointer to a const debug module segment. */
104	typedef RTDBGSEGMENT const *PCRTDBGSEGMENT;
105
106
107
108	/** Max length (including '\\0') of a symbol name. */
109	#define RTDBG_SYMBOL_NAME_LENGTH (384 - 8 - 8 - 8 - 4 - 4 - 8)
110
111	/**
112	* Debug symbol.
113	*/
114	typedef struct RTDBGSYMBOL
115	{
116	/** Symbol value (address).
117	* This depends a bit who you ask. It will be the same as offSeg when you
118	* as RTDbgMod, but the mapping address if you ask RTDbgAs. */
119	RTUINTPTR Value;
120	/** Symbol size. */
121	RTUINTPTR cb;
122	/** Offset into the segment specified by iSeg. */
123	RTUINTPTR offSeg;
124	/** Segment number. */
125	RTDBGSEGIDX iSeg;
126	/** Symbol Flags. (reserved). */
127	uint32_t fFlags;
128	/** Symbol ordinal.
129	* This is set to UINT32_MAX if the ordinals aren't supported. */
130	uint32_t iOrdinal;
131	/** Symbol name. */
132	char szName[RTDBG_SYMBOL_NAME_LENGTH];
133	} RTDBGSYMBOL;
134	/** Pointer to debug symbol. */
135	typedef RTDBGSYMBOL *PRTDBGSYMBOL;
136	/** Pointer to const debug symbol. */
137	typedef const RTDBGSYMBOL *PCRTDBGSYMBOL;
138
139	/**
140	* Allocate a new symbol structure.
141	*
142	* @returns Pointer to a new structure on success, NULL on failure.
143	*/
144	RTDECL(PRTDBGSYMBOL) RTDbgSymbolAlloc(void);
145
146	/**
147	* Duplicates a symbol structure.
148	*
149	* @returns Pointer to duplicate on success, NULL on failure.
150	*
151	* @param pSymInfo The symbol info to duplicate.
152	*/
153	RTDECL(PRTDBGSYMBOL) RTDbgSymbolDup(PCRTDBGSYMBOL pSymInfo);
154
155	/**
156	* Free a symbol structure previously allocated by a RTDbg method.
157	*
158	* @param pSymInfo The symbol info to free. NULL is ignored.
159	*/
160	RTDECL(void) RTDbgSymbolFree(PRTDBGSYMBOL pSymInfo);
161
162
163	/** Max length (including '\\0') of a debug info file name. */
164	#define RTDBG_FILE_NAME_LENGTH (260)
165
166
167	/**
168	* Debug line number information.
169	*/
170	typedef struct RTDBGLINE
171	{
172	/** Address.
173	* This depends a bit who you ask. It will be the same as offSeg when you
174	* as RTDbgMod, but the mapping address if you ask RTDbgAs. */
175	RTUINTPTR Address;
176	/** Offset into the segment specified by iSeg. */
177	RTUINTPTR offSeg;
178	/** Segment number. */
179	RTDBGSEGIDX iSeg;
180	/** Line number. */
181	uint32_t uLineNo;
182	/** Symbol ordinal.
183	* This is set to UINT32_MAX if the ordinals aren't supported. */
184	uint32_t iOrdinal;
185	/** Filename. */
186	char szFilename[RTDBG_FILE_NAME_LENGTH];
187	} RTDBGLINE;
188	/** Pointer to debug line number. */
189	typedef RTDBGLINE *PRTDBGLINE;
190	/** Pointer to const debug line number. */
191	typedef const RTDBGLINE *PCRTDBGLINE;
192
193	/**
194	* Allocate a new line number structure.
195	*
196	* @returns Pointer to a new structure on success, NULL on failure.
197	*/
198	RTDECL(PRTDBGLINE) RTDbgLineAlloc(void);
199
200	/**
201	* Duplicates a line number structure.
202	*
203	* @returns Pointer to duplicate on success, NULL on failure.
204	*
205	* @param pLine The line number to duplicate.
206	*/
207	RTDECL(PRTDBGLINE) RTDbgLineDup(PCRTDBGLINE pLine);
208
209	/**
210	* Free a line number structure previously allocated by a RTDbg method.
211	*
212	* @param pLine The line number to free. NULL is ignored.
213	*/
214	RTDECL(void) RTDbgLineFree(PRTDBGLINE pLine);
215
216
217	/** @defgroup grp_rt_dbgcfg RTDbgCfg - Debugging Configuration
218	*
219	* The settings used when loading and processing debug info is kept in a
220	* RTDBGCFG instance since it's generally shared for a whole debugging session
221	* and anyhow would be a major pain to pass as individual parameters to each
222	* call. The debugging config API not only keeps the settings information but
223	* also provide APIs for making use of it, and in some cases, like for instance
224	* symbol severs, retriving and maintaining it.
225	*
226	* @todo Work in progress - APIs are still missing, adding when needed.
227	*
228	* @{
229	*/
230
231	/** Debugging configuration handle. */
232	typedef struct RTDBGCFGINT *RTDBGCFG;
233	/** Pointer to a debugging configuration handle. */
234	typedef RTDBGCFG *PRTDBGCFG;
235	/** NIL debug configuration handle. */
236	#define NIL_RTDBGCFG ((RTDBGCFG)0)
237
238	/** @name RTDBGCFG_FLAGS_XXX - Debugging configuration flags.
239	* @{ */
240	/** Use deferred loading. */
241	#define RTDBGCFG_FLAGS_DEFERRED RT_BIT_64(0)
242	/** Don't use the symbol server (http). */
243	#define RTDBGCFG_FLAGS_NO_SYM_SRV RT_BIT_64(1)
244	/** Don't use system search paths.
245	* On windows this means not using _NT_ALT_SYMBOL_PATH, _NT_SYMBOL_PATH,
246	* _NT_SOURCE_PATH, and _NT_EXECUTABLE_PATH.
247	* On other systems the effect has yet to be determined. */
248	#define RTDBGCFG_FLAGS_NO_SYSTEM_PATHS RT_BIT_64(2)
249	/** Don't search the debug and image paths recursively. */
250	#define RTDBGCFG_FLAGS_NO_RECURSIV_SEARCH RT_BIT_64(3)
251	/** Don't search the source paths recursively. */
252	#define RTDBGCFG_FLAGS_NO_RECURSIV_SRC_SEARCH RT_BIT_64(4)
253	/** @} */
254
255	/**
256	* Debugging configuration properties.
257	*
258	* The search paths are using the DOS convention of semicolon as separator
259	* character. The the special 'srv' + asterisk syntax known from the windows
260	* debugger search paths are also supported to some extent, as is 'cache' +
261	* asterisk.
262	*/
263	typedef enum RTDBGCFGPROP
264	{
265	/** The customary invalid 0 value. */
266	RTDBGCFGPROP_INVALID = 0,
267	/** RTDBGCFG_FLAGS_XXX.
268	* Env: _FLAGS
269	* The environment variable can be specified as a unsigned value or one or more
270	* mnemonics separated by spaces. */
271	RTDBGCFGPROP_FLAGS,
272	/** List of paths to search for symbol files and images.
273	* Env: _PATH */
274	RTDBGCFGPROP_PATH,
275	/** List of symbol file suffixes (semicolon separated).
276	* Env: _SUFFIXES */
277	RTDBGCFGPROP_SUFFIXES,
278	/** List of paths to search for source files.
279	* Env: _SRC_PATH */
280	RTDBGCFGPROP_SRC_PATH,
281	/** End of valid values. */
282	RTDBGCFGPROP_END,
283	/** The customary 32-bit type hack. */
284	RTDBGCFGPROP_32BIT_HACK = 0x7fffffff
285	} RTDBGCFGPROP;
286
287	/**
288	* Configuration property change operation.
289	*/
290	typedef enum RTDBGCFGOP
291	{
292	/** Customary invalid 0 value. */
293	RTDBGCFGOP_INVALID = 0,
294	/** Replace the current value with the given one. */
295	RTDBGCFGOP_SET,
296	/** Append the given value to the existing one. For integer values this is
297	* considered a bitwise OR operation. */
298	RTDBGCFGOP_APPEND,
299	/** Prepend the given value to the existing one. For integer values this is
300	* considered a bitwise OR operation. */
301	RTDBGCFGOP_PREPEND,
302	/** Removes the value from the existing one. For interger values the value is
303	* complemented and ANDed with the existing one, clearing all the specified
304	* flags/bits. */
305	RTDBGCFGOP_REMOVE,
306	/** End of valid values. */
307	RTDBGCFGOP_END,
308	/** Customary 32-bit type hack. */
309	RTDBGCFGOP_32BIT_HACK = 0x7fffffff
310	} RTDBGCFGOP;
311
312
313
314	/**
315	* Initializes a debugging configuration.
316	*
317	* @returns IPRT status code.
318	* @param phDbgCfg Where to return the configuration handle.
319	* @param pszEnvVarPrefix The environment variable prefix. If NULL, the
320	* environment is not consulted.
321	* @param fNativePaths Whether to pick up native paths from the
322	* environment.
323	*
324	* @sa RTDbgCfgChangeString, RTDbgCfgChangeUInt.
325	*/
326	RTDECL(int) RTDbgCfgCreate(PRTDBGCFG phDbgCfg, const char *pszEnvVarPrefix, bool fNativePaths);
327
328	/**
329	* Retains a new reference to a debugging config.
330	*
331	* @returns New reference count.
332	* UINT32_MAX is returned if the handle is invalid (asserted).
333	* @param hDbgCfg The config handle.
334	*/
335	RTDECL(uint32_t) RTDbgCfgRetain(RTDBGCFG hDbgCfg);
336
337	/**
338	* Releases a references to a debugging config.
339	*
340	* @returns New reference count, if 0 the config was freed. UINT32_MAX is
341	* returned if the handle is invalid (asserted).
342	* @param hDbgCfg The config handle.
343	*/
344	RTDECL(uint32_t) RTDbgCfgRelease(RTDBGCFG hDbgCfg);
345
346	/**
347	* Changes a property value by string.
348	*
349	* For string values the string is used more or less as given. For integer
350	* values and flags, it can contains both values (ORed together) or property
351	* specific mnemonics (ORed / ~ANDed).
352	*
353	* @returns IPRT status code.
354	* @retval VERR_DBG_CFG_INVALID_VALUE
355	* @param hDbgCfg The debugging configuration handle.
356	* @param enmProp The property to change.
357	* @param enmOp How to change the property.
358	* @param pszValue The property value to apply.
359	*/
360	RTDECL(int) RTDbgCfgChangeString(RTDBGCFG hDbgCfg, RTDBGCFGPROP enmProp, RTDBGCFGOP enmOp, const char *pszValue);
361
362	/**
363	* Changes a property value by unsigned integer (64-bit).
364	*
365	* This can only be applied to integer and flag properties.
366	*
367	* @returns IPRT status code.
368	* @retval VERR_DBG_CFG_NOT_UINT_PROP
369	* @param hDbgCfg The debugging configuration handle.
370	* @param enmProp The property to change.
371	* @param enmOp How to change the property.
372	* @param uValue The property value to apply.
373	*/
374	RTDECL(int) RTDbgCfgChangeUInt(RTDBGCFG hDbgCfg, RTDBGCFGPROP enmProp, RTDBGCFGOP enmOp, uint64_t uValue);
375
376	/**
377	* Query a property value as string.
378	*
379	* Integer and flags properties are returned as a list of mnemonics if possible,
380	* otherwise as simple hex values.
381	*
382	* @returns IPRT status code.
383	* @retval VERR_BUFFER_OVERFLOW if there isn't sufficient buffer space. Nothing
384	* is written.
385	* @param hDbgCfg The debugging configuration handle.
386	* @param enmProp The property to change.
387	* @param pszValue The output buffer.
388	* @param cbValue The size of the output buffer.
389	*/
390	RTDECL(int) RTDbgCfgQueryString(RTDBGCFG hDbgCfg, RTDBGCFGPROP enmProp, char *pszValue, size_t cbValue);
391
392	/**
393	* Query a property value as unsigned integer (64-bit).
394	*
395	* Only integer and flags properties can be queried this way.
396	*
397	* @returns IPRT status code.
398	* @retval VERR_DBG_CFG_NOT_UINT_PROP
399	* @param hDbgCfg The debugging configuration handle.
400	* @param enmProp The property to change.
401	* @param puValue Where to return the value.
402	*/
403	RTDECL(int) RTDbgCfgQueryUInt(RTDBGCFG hDbgCfg, RTDBGCFGPROP enmProp, uint64_t *puValue);
404
405	/**
406	* Log callback.
407	*
408	* @param hDbgCfg The debug config instance.
409	* @param iLevel The message level.
410	* @param pszMsg The message.
411	* @param pvUser User argument.
412	*/
413	typedef DECLCALLBACK(void) FNRTDBGCFGLOG(RTDBGCFG hDbgCfg, uint32_t iLevel, const char pszMsg, void pvUser);
414	/** Pointer to a log callback. */
415	typedef FNRTDBGCFGLOG *PFNRTDBGCFGLOG;
416
417	/**
418	* Sets the log callback for the configuration.
419	*
420	* This will fail if there is already a log callback present, unless pfnCallback
421	* is NULL.
422	*
423	* @returns IPRT status code.
424	* @param hDbgCfg The debugging configuration handle.
425	* @param pfnCallback The callback function. NULL to unset.
426	* @param pvUser The user argument.
427	*/
428	RTDECL(int) RTDbgCfgSetLogCallback(RTDBGCFG hDbgCfg, PFNRTDBGCFGLOG pfnCallback, void *pvUser);
429
430	/**
431	* Callback used by the RTDbgCfgOpen function to try out a file that was found.
432	*
433	* @returns On statuses other than VINF_CALLBACK_RETURN and
434	* VERR_CALLBACK_RETURN the search will continue till the end of the
435	* list. These status codes will not necessarily be propagated to the
436	* caller in any consistent manner.
437	* @retval VINF_CALLBACK_RETURN if successuflly opened the file and it's time
438	* to return
439	* @retval VERR_CALLBACK_RETURN if we shouldn't stop searching.
440	*
441	* @param hDbgCfg The debugging configuration handle.
442	* @param pszFilename The path to the file that should be tried out.
443	* @param pvUser1 First user parameter.
444	* @param pvUser2 Second user parameter.
445	*/
446	typedef DECLCALLBACK(int) FNDBGCFGOPEN(RTDBGCFG hDbgCfg, const char pszFilename, void pvUser1, void *pvUser2);
447	/** Pointer to a open-file callback used to the RTDbgCfgOpen functions. */
448	typedef FNDBGCFGOPEN *PFNDBGCFGOPEN;
449
450
451	RTDECL(int) RTDbgCfgOpenPeImage(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp,
452	PFNDBGCFGOPEN pfnCallback, void pvUser1, void pvUser2);
453	RTDECL(int) RTDbgCfgOpenPdb70(RTDBGCFG hDbgCfg, const char *pszFilename, PCRTUUID pUuid, uint32_t uAge,
454	PFNDBGCFGOPEN pfnCallback, void pvUser1, void pvUser2);
455	RTDECL(int) RTDbgCfgOpenPdb20(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp, uint32_t uAge,
456	PFNDBGCFGOPEN pfnCallback, void pvUser1, void pvUser2);
457	RTDECL(int) RTDbgCfgOpenDbg(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp,
458	PFNDBGCFGOPEN pfnCallback, void pvUser1, void pvUser2);
459	RTDECL(int) RTDbgCfgOpenDwo(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t uCrc32,
460	PFNDBGCFGOPEN pfnCallback, void pvUser1, void pvUser2);
461
462	RTDECL(int) RTDbgCfgOpenDsymBundle(RTDBGCFG hDbgCfg, const char *pszFilename, PCRTUUID pUuid,
463	PFNDBGCFGOPEN pfnCallback, void pvUser1, void pvUser2);
464
465
466	/** @} */
467
468
469	/** @defgroup grp_rt_dbgas RTDbgAs - Debug Address Space
470	* @{
471	*/
472
473	/**
474	* Creates an empty address space.
475	*
476	* @returns IPRT status code.
477	*
478	* @param phDbgAs Where to store the address space handle on success.
479	* @param FirstAddr The first address in the address space.
480	* @param LastAddr The last address in the address space.
481	* @param pszName The name of the address space.
482	*/
483	RTDECL(int) RTDbgAsCreate(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszName);
484
485	/**
486	* Variant of RTDbgAsCreate that takes a name format string.
487	*
488	* @returns IPRT status code.
489	*
490	* @param phDbgAs Where to store the address space handle on success.
491	* @param FirstAddr The first address in the address space.
492	* @param LastAddr The last address in the address space.
493	* @param pszNameFmt The name format of the address space.
494	* @param va Format arguments.
495	*/
496	RTDECL(int) RTDbgAsCreateV(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszNameFmt, va_list va);
497
498	/**
499	* Variant of RTDbgAsCreate that takes a name format string.
500	*
501	* @returns IPRT status code.
502	*
503	* @param phDbgAs Where to store the address space handle on success.
504	* @param FirstAddr The first address in the address space.
505	* @param LastAddr The last address in the address space.
506	* @param pszNameFmt The name format of the address space.
507	* @param ... Format arguments.
508	*/
509	RTDECL(int) RTDbgAsCreateF(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszNameFmt, ...);
510
511	/**
512	* Retains a reference to the address space.
513	*
514	* @returns New reference count, UINT32_MAX on invalid handle (asserted).
515	*
516	* @param hDbgAs The address space handle.
517	*
518	* @remarks Will not take any locks.
519	*/
520	RTDECL(uint32_t) RTDbgAsRetain(RTDBGAS hDbgAs);
521
522	/**
523	* Release a reference to the address space.
524	*
525	* When the reference count reaches zero, the address space is destroyed.
526	* That means unlinking all the modules it currently contains, potentially
527	* causing some or all of them to be destroyed as they are managed by
528	* reference counting.
529	*
530	* @returns New reference count, UINT32_MAX on invalid handle (asserted).
531	*
532	* @param hDbgAs The address space handle. The NIL handle is quietly
533	* ignored and 0 is returned.
534	*
535	* @remarks Will not take any locks.
536	*/
537	RTDECL(uint32_t) RTDbgAsRelease(RTDBGAS hDbgAs);
538
539	/**
540	* Locks the address space for exclusive access.
541	*
542	* @returns IRPT status code
543	* @param hDbgAs The address space handle.
544	*/
545	RTDECL(int) RTDbgAsLockExcl(RTDBGAS hDbgAs);
546
547	/**
548	* Counters the actions of one RTDbgAsUnlockExcl call.
549	*
550	* @returns IRPT status code
551	* @param hDbgAs The address space handle.
552	*/
553	RTDECL(int) RTDbgAsUnlockExcl(RTDBGAS hDbgAs);
554
555	/**
556	* Gets the name of an address space.
557	*
558	* @returns read only address space name.
559	* NULL if hDbgAs is invalid.
560	*
561	* @param hDbgAs The address space handle.
562	*
563	* @remarks Will not take any locks.
564	*/
565	RTDECL(const char *) RTDbgAsName(RTDBGAS hDbgAs);
566
567	/**
568	* Gets the first address in an address space.
569	*
570	* @returns The address.
571	* 0 if hDbgAs is invalid.
572	*
573	* @param hDbgAs The address space handle.
574	*
575	* @remarks Will not take any locks.
576	*/
577	RTDECL(RTUINTPTR) RTDbgAsFirstAddr(RTDBGAS hDbgAs);
578
579	/**
580	* Gets the last address in an address space.
581	*
582	* @returns The address.
583	* 0 if hDbgAs is invalid.
584	*
585	* @param hDbgAs The address space handle.
586	*
587	* @remarks Will not take any locks.
588	*/
589	RTDECL(RTUINTPTR) RTDbgAsLastAddr(RTDBGAS hDbgAs);
590
591	/**
592	* Gets the number of modules in the address space.
593	*
594	* This can be used together with RTDbgAsModuleByIndex
595	* to enumerate the modules.
596	*
597	* @returns The number of modules.
598	*
599	* @param hDbgAs The address space handle.
600	*
601	* @remarks Will not take any locks.
602	*/
603	RTDECL(uint32_t) RTDbgAsModuleCount(RTDBGAS hDbgAs);
604
605	/** @name Flags for RTDbgAsModuleLink and RTDbgAsModuleLinkSeg
606	* @{ */
607	/** Replace all conflicting module.
608	* (The conflicting modules will be removed the address space and their
609	* references released.) */
610	#define RTDBGASLINK_FLAGS_REPLACE RT_BIT_32(0)
611	/** Mask containing the valid flags. */
612	#define RTDBGASLINK_FLAGS_VALID_MASK UINT32_C(0x00000001)
613	/** @} */
614
615	/**
616	* Links a module into the address space at the give address.
617	*
618	* The size of the mapping is determined using RTDbgModImageSize().
619	*
620	* @returns IPRT status code.
621	* @retval VERR_OUT_OF_RANGE if the specified address will put the module
622	* outside the address space.
623	* @retval VERR_ADDRESS_CONFLICT if the mapping clashes with existing mappings.
624	*
625	* @param hDbgAs The address space handle.
626	* @param hDbgMod The module handle of the module to be linked in.
627	* @param ImageAddr The address to link the module at.
628	* @param fFlags See RTDBGASLINK_FLAGS_*.
629	*/
630	RTDECL(int) RTDbgAsModuleLink(RTDBGAS hDbgAs, RTDBGMOD hDbgMod, RTUINTPTR ImageAddr, uint32_t fFlags);
631
632	/**
633	* Links a segment into the address space at the give address.
634	*
635	* The size of the mapping is determined using RTDbgModSegmentSize().
636	*
637	* @returns IPRT status code.
638	* @retval VERR_OUT_OF_RANGE if the specified address will put the module
639	* outside the address space.
640	* @retval VERR_ADDRESS_CONFLICT if the mapping clashes with existing mappings.
641	*
642	* @param hDbgAs The address space handle.
643	* @param hDbgMod The module handle.
644	* @param iSeg The segment number (0-based) of the segment to be
645	* linked in.
646	* @param SegAddr The address to link the segment at.
647	* @param fFlags See RTDBGASLINK_FLAGS_*.
648	*/
649	RTDECL(int) RTDbgAsModuleLinkSeg(RTDBGAS hDbgAs, RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR SegAddr, uint32_t fFlags);
650
651	/**
652	* Unlinks all the mappings of a module from the address space.
653	*
654	* @returns IPRT status code.
655	* @retval VERR_NOT_FOUND if the module wasn't found.
656	*
657	* @param hDbgAs The address space handle.
658	* @param hDbgMod The module handle of the module to be unlinked.
659	*/
660	RTDECL(int) RTDbgAsModuleUnlink(RTDBGAS hDbgAs, RTDBGMOD hDbgMod);
661
662	/**
663	* Unlinks the mapping at the specified address.
664	*
665	* @returns IPRT status code.
666	* @retval VERR_NOT_FOUND if no module or segment is mapped at that address.
667	*
668	* @param hDbgAs The address space handle.
669	* @param Addr The address within the mapping to be unlinked.
670	*/
671	RTDECL(int) RTDbgAsModuleUnlinkByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr);
672
673	/**
674	* Get a the handle of a module in the address space by is index.
675	*
676	* @returns A retained handle to the specified module. The caller must release
677	* the returned reference.
678	* NIL_RTDBGMOD if invalid index or handle.
679	*
680	* @param hDbgAs The address space handle.
681	* @param iModule The index of the module to get.
682	*
683	* @remarks The module indexes may change after calls to RTDbgAsModuleLink,
684	* RTDbgAsModuleLinkSeg, RTDbgAsModuleUnlink and
685	* RTDbgAsModuleUnlinkByAddr.
686	*/
687	RTDECL(RTDBGMOD) RTDbgAsModuleByIndex(RTDBGAS hDbgAs, uint32_t iModule);
688
689	/**
690	* Queries mapping module information by handle.
691	*
692	* @returns IPRT status code.
693	* @retval VERR_NOT_FOUND if no mapping was found at the specified address.
694	*
695	* @param hDbgAs The address space handle.
696	* @param Addr Address within the mapping of the module or segment.
697	* @param phMod Where to the return the retained module handle.
698	* Optional.
699	* @param pAddr Where to return the base address of the mapping.
700	* Optional.
701	* @param piSeg Where to return the segment index. This is set to
702	* NIL if the entire module is mapped as a single
703	* mapping. Optional.
704	*/
705	RTDECL(int) RTDbgAsModuleByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTDBGMOD phMod, PRTUINTPTR pAddr, PRTDBGSEGIDX piSeg);
706
707	/**
708	* Queries mapping module information by name.
709	*
710	* @returns IPRT status code.
711	* @retval VERR_NOT_FOUND if no mapping was found at the specified address.
712	* @retval VERR_OUT_OF_RANGE if the name index was out of range.
713	*
714	* @param hDbgAs The address space handle.
715	* @param pszName The module name.
716	* @param iName There can be more than one module by the same name
717	* in an address space. This argument indicates which
718	* is meant. (0 based)
719	* @param phMod Where to the return the retained module handle.
720	*/
721	RTDECL(int) RTDbgAsModuleByName(RTDBGAS hDbgAs, const char *pszName, uint32_t iName, PRTDBGMOD phMod);
722
723	/**
724	* Information about a mapping.
725	*
726	* This is used by RTDbgAsModuleGetMapByIndex.
727	*/
728	typedef struct RTDBGASMAPINFO
729	{
730	/** The mapping address. */
731	RTUINTPTR Address;
732	/** The segment mapped there.
733	* This is NIL_RTDBGSEGIDX if the entire module image is mapped here. */
734	RTDBGSEGIDX iSeg;
735	} RTDBGASMAPINFO;
736	/** Pointer to info about an address space mapping. */
737	typedef RTDBGASMAPINFO *PRTDBGASMAPINFO;
738	/** Pointer to const info about an address space mapping. */
739	typedef RTDBGASMAPINFO const *PCRTDBGASMAPINFO;
740
741	/**
742	* Queries mapping information for a module given by index.
743	*
744	* @returns IRPT status code.
745	* @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
746	* @retval VERR_OUT_OF_RANGE if the name index was out of range.
747	* @retval VINF_BUFFER_OVERFLOW if the array is too small and the returned
748	* information is incomplete.
749	*
750	* @param hDbgAs The address space handle.
751	* @param iModule The index of the module to get.
752	* @param paMappings Where to return the mapping information. The buffer
753	* size is given by *pcMappings.
754	* @param pcMappings IN: Size of the paMappings array. OUT: The number of
755	* entries returned.
756	* @param fFlags Flags for reserved for future use. MBZ.
757	*
758	* @remarks See remarks for RTDbgAsModuleByIndex regarding the volatility of the
759	* iModule parameter.
760	*/
761	RTDECL(int) RTDbgAsModuleQueryMapByIndex(RTDBGAS hDbgAs, uint32_t iModule, PRTDBGASMAPINFO paMappings, uint32_t *pcMappings, uint32_t fFlags);
762
763	/**
764	* Adds a symbol to a module in the address space.
765	*
766	* @returns IPRT status code. See RTDbgModSymbolAdd for more specific ones.
767	* @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
768	* @retval VERR_NOT_FOUND if no module was found at the specified address.
769	* @retval VERR_NOT_SUPPORTED if the module interpret doesn't support adding
770	* custom symbols.
771	*
772	* @param hDbgAs The address space handle.
773	* @param pszSymbol The symbol name.
774	* @param Addr The address of the symbol.
775	* @param cb The size of the symbol.
776	* @param fFlags Symbol flags.
777	* @param piOrdinal Where to return the symbol ordinal on success. If
778	* the interpreter doesn't do ordinals, this will be set to
779	* UINT32_MAX. Optional
780	*/
781	RTDECL(int) RTDbgAsSymbolAdd(RTDBGAS hDbgAs, const char pszSymbol, RTUINTPTR Addr, RTUINTPTR cb, uint32_t fFlags, uint32_t piOrdinal);
782
783	/**
784	* Query a symbol by address.
785	*
786	* @returns IPRT status code. See RTDbgModSymbolAddr for more specific ones.
787	* @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
788	* @retval VERR_NOT_FOUND if the address couldn't be mapped to a module.
789	* @retval VERR_INVALID_PARAMETER if incorrect flags.
790	*
791	* @param hDbgAs The address space handle.
792	* @param Addr The address which closest symbol is requested.
793	* @param fFlags Symbol search flags, see RTDBGSYMADDR_FLAGS_XXX.
794	* @param poffDisp Where to return the distance between the symbol
795	* and address. Optional.
796	* @param pSymbol Where to return the symbol info.
797	* @param phMod Where to return the module handle. Optional.
798	*/
799	RTDECL(int) RTDbgAsSymbolByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, uint32_t fFlags,
800	PRTINTPTR poffDisp, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod);
801
802	/**
803	* Query a symbol by address.
804	*
805	* @returns IPRT status code. See RTDbgModSymbolAddrA for more specific ones.
806	* @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
807	* @retval VERR_NOT_FOUND if the address couldn't be mapped to a module.
808	* @retval VERR_INVALID_PARAMETER if incorrect flags.
809	*
810	* @param hDbgAs The address space handle.
811	* @param Addr The address which closest symbol is requested.
812	* @param fFlags Symbol search flags, see RTDBGSYMADDR_FLAGS_XXX.
813	* @param poffDisp Where to return the distance between the symbol
814	* and address. Optional.
815	* @param ppSymInfo Where to return the pointer to the allocated symbol
816	* info. Always set. Free with RTDbgSymbolFree.
817	* @param phMod Where to return the module handle. Optional.
818	*/
819	RTDECL(int) RTDbgAsSymbolByAddrA(RTDBGAS hDbgAs, RTUINTPTR Addr, uint32_t fFlags,
820	PRTINTPTR poffDisp, PRTDBGSYMBOL *ppSymInfo, PRTDBGMOD phMod);
821
822	/**
823	* Query a symbol by name.
824	*
825	* @returns IPRT status code.
826	* @retval VERR_SYMBOL_NOT_FOUND if not found.
827	*
828	* @param hDbgAs The address space handle.
829	* @param pszSymbol The symbol name. It is possible to limit the scope
830	* of the search by prefixing the symbol with a module
831	* name pattern followed by a bang (!) character.
832	* RTStrSimplePatternNMatch is used for the matching.
833	* @param pSymbol Where to return the symbol info.
834	* @param phMod Where to return the module handle. Optional.
835	*/
836	RTDECL(int) RTDbgAsSymbolByName(RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod);
837
838	/**
839	* Query a symbol by name, allocating the returned symbol structure.
840	*
841	* @returns IPRT status code.
842	* @retval VERR_SYMBOL_NOT_FOUND if not found.
843	*
844	* @param hDbgAs The address space handle.
845	* @param pszSymbol The symbol name. See RTDbgAsSymbolByName for more.
846	* @param ppSymbol Where to return the pointer to the allocated
847	* symbol info. Always set. Free with RTDbgSymbolFree.
848	* @param phMod Where to return the module handle. Optional.
849	*/
850	RTDECL(int) RTDbgAsSymbolByNameA(RTDBGAS hDbgAs, const char pszSymbol, PRTDBGSYMBOL ppSymbol, PRTDBGMOD phMod);
851
852	/**
853	* Adds a line number to a module in the address space.
854	*
855	* @returns IPRT status code. See RTDbgModLineAdd for more specific ones.
856	* @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
857	* @retval VERR_NOT_FOUND if no module was found at the specified address.
858	* @retval VERR_NOT_SUPPORTED if the module interpret doesn't support adding
859	* custom symbols.
860	*
861	* @param hDbgAs The address space handle.
862	* @param pszFile The file name.
863	* @param uLineNo The line number.
864	* @param Addr The address of the symbol.
865	* @param piOrdinal Where to return the line number ordinal on success.
866	* If the interpreter doesn't do ordinals, this will be
867	* set to UINT32_MAX. Optional.
868	*/
869	RTDECL(int) RTDbgAsLineAdd(RTDBGAS hDbgAs, const char pszFile, uint32_t uLineNo, RTUINTPTR Addr, uint32_t piOrdinal);
870
871	/**
872	* Query a line number by address.
873	*
874	* @returns IPRT status code. See RTDbgModLineAddrA for more specific ones.
875	* @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
876	* @retval VERR_NOT_FOUND if the address couldn't be mapped to a module.
877	*
878	* @param hDbgAs The address space handle.
879	* @param Addr The address which closest symbol is requested.
880	* @param poffDisp Where to return the distance between the line
881	* number and address.
882	* @param pLine Where to return the line number information.
883	* @param phMod Where to return the module handle. Optional.
884	*/
885	RTDECL(int) RTDbgAsLineByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGLINE pLine, PRTDBGMOD phMod);
886
887	/**
888	* Query a line number by address.
889	*
890	* @returns IPRT status code. See RTDbgModLineAddrA for more specific ones.
891	* @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
892	* @retval VERR_NOT_FOUND if the address couldn't be mapped to a module.
893	*
894	* @param hDbgAs The address space handle.
895	* @param Addr The address which closest symbol is requested.
896	* @param poffDisp Where to return the distance between the line
897	* number and address.
898	* @param ppLine Where to return the pointer to the allocated line
899	* number info. Always set. Free with RTDbgLineFree.
900	* @param phMod Where to return the module handle. Optional.
901	*/
902	RTDECL(int) RTDbgAsLineByAddrA(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGLINE *ppLine, PRTDBGMOD phMod);
903
904	/** @todo Missing some bits here. */
905
906	/** @} */
907
908
909	/** @defgroup grp_rt_dbgmod RTDbgMod - Debug Module Interpreter
910	* @{
911	*/
912
913	/**
914	* Creates a module based on the default debug info container.
915	*
916	* This can be used to manually load a module and its symbol. The primary user
917	* group is the debug info interpreters, which use this API to create an
918	* efficient debug info container behind the scenes and forward all queries to
919	* it once the info has been loaded.
920	*
921	* @returns IPRT status code.
922	*
923	* @param phDbgMod Where to return the module handle.
924	* @param pszName The name of the module (mandatory).
925	* @param cbSeg The size of initial segment. If zero, segments will
926	* have to be added manually using RTDbgModSegmentAdd.
927	* @param fFlags Flags reserved for future extensions, MBZ for now.
928	*/
929	RTDECL(int) RTDbgModCreate(PRTDBGMOD phDbgMod, const char *pszName, RTUINTPTR cbSeg, uint32_t fFlags);
930
931	RTDECL(int) RTDbgModCreateFromImage(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName,
932	RTLDRARCH enmArch, RTDBGCFG hDbgCfg);
933	RTDECL(int) RTDbgModCreateFromMap(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName, RTUINTPTR uSubtrahend,
934	RTDBGCFG hDbgCfg);
935	RTDECL(int) RTDbgModCreateFromPeImage(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName, RTLDRMOD hLdrMod,
936	uint32_t cbImage, uint32_t uTimeDateStamp, RTDBGCFG hDbgCfg);
937	RTDECL(int) RTDbgModCreateFromDbg(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName, uint32_t cbImage,
938	uint32_t uTimeDateStamp, RTDBGCFG hDbgCfg);
939	RTDECL(int) RTDbgModCreateFromPdb(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName, uint32_t cbImage,
940	PCRTUUID pUuid, uint32_t Age, RTDBGCFG hDbgCfg);
941	RTDECL(int) RTDbgModCreateFromDwo(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName, uint32_t cbImage,
942	uint32_t uCrc32, RTDBGCFG hDbgCfg);
943
944
945	/**
946	* Retains another reference to the module.
947	*
948	* @returns New reference count, UINT32_MAX on invalid handle (asserted).
949	*
950	* @param hDbgMod The module handle.
951	*
952	* @remarks Will not take any locks.
953	*/
954	RTDECL(uint32_t) RTDbgModRetain(RTDBGMOD hDbgMod);
955
956	/**
957	* Release a reference to the module.
958	*
959	* When the reference count reaches zero, the module is destroyed.
960	*
961	* @returns New reference count, UINT32_MAX on invalid handle (asserted).
962	*
963	* @param hDbgMod The module handle. The NIL handle is quietly ignored
964	* and 0 is returned.
965	*
966	* @remarks Will not take any locks.
967	*/
968	RTDECL(uint32_t) RTDbgModRelease(RTDBGMOD hDbgMod);
969
970	/**
971	* Removes all content from the debug module (container), optionally only
972	* leaving segments and image size intact.
973	*
974	* This is only possible on container modules, i.e. created by RTDbgModCreate().
975	*
976	* @returns IPRT status code.
977	* @param hDbgMod The module handle.
978	* @param fLeaveSegments Whether to leave segments (and image size) as is.
979	*/
980	RTDECL(int) RTDbgModRemoveAll(RTDBGMOD hDbgMod, bool fLeaveSegments);
981
982	/**
983	* Gets the module name.
984	*
985	* @returns Pointer to a read only string containing the name.
986	*
987	* @param hDbgMod The module handle.
988	*/
989	RTDECL(const char *) RTDbgModName(RTDBGMOD hDbgMod);
990
991	/**
992	* Gets the name of the debug info file we're using.
993	*
994	* @returns Pointer to a read only string containing the filename, NULL if we
995	* don't use one.
996	*
997	* @param hDbgMod The module handle.
998	*/
999	RTDECL(const char *) RTDbgModDebugFile(RTDBGMOD hDbgMod);
1000
1001	/**
1002	* Gets the image filename (as specified by the user).
1003	*
1004	* @returns Pointer to a read only string containing the filename.
1005	*
1006	* @param hDbgMod The module handle.
1007	*/
1008	RTDECL(const char *) RTDbgModImageFile(RTDBGMOD hDbgMod);
1009
1010	/**
1011	* Gets the image filename actually used if it differs from RTDbgModImageFile.
1012	*
1013	* @returns Pointer to a read only string containing the filename, NULL if same
1014	* as RTDBgModImageFile.
1015	*
1016	* @param hDbgMod The module handle.
1017	*/
1018	RTDECL(const char *) RTDbgModImageFileUsed(RTDBGMOD hDbgMod);
1019
1020	/**
1021	* Checks if the loading of the debug info has been postponed.
1022	*
1023	* @returns true if postponed, false if not or invalid handle.
1024	* @param hDbgMod The module handle.
1025	*/
1026	RTDECL(bool) RTDbgModIsDeferred(RTDBGMOD hDbgMod);
1027
1028	/**
1029	* Checks if the debug info is exports only.
1030	*
1031	* @returns true if exports only, false if not or invalid handle.
1032	* @param hDbgMod The module handle.
1033	*/
1034	RTDECL(bool) RTDbgModIsExports(RTDBGMOD hDbgMod);
1035
1036	/**
1037	* Converts an image relative address to a segment:offset address.
1038	*
1039	* @returns Segment index on success.
1040	* NIL_RTDBGSEGIDX is returned if the module handle or the RVA are
1041	* invalid.
1042	*
1043	* @param hDbgMod The module handle.
1044	* @param uRva The image relative address to convert.
1045	* @param poffSeg Where to return the segment offset. Optional.
1046	*/
1047	RTDECL(RTDBGSEGIDX) RTDbgModRvaToSegOff(RTDBGMOD hDbgMod, RTUINTPTR uRva, PRTUINTPTR poffSeg);
1048
1049	/**
1050	* Image size when mapped if segments are mapped adjacently.
1051	*
1052	* For ELF, PE, and Mach-O images this is (usually) a natural query, for LX and
1053	* NE and such it's a bit odder and the answer may not make much sense for them.
1054	*
1055	* @returns Image mapped size.
1056	* RTUINTPTR_MAX is returned if the handle is invalid.
1057	*
1058	* @param hDbgMod The module handle.
1059	*/
1060	RTDECL(RTUINTPTR) RTDbgModImageSize(RTDBGMOD hDbgMod);
1061
1062	/**
1063	* Gets the module tag value if any.
1064	*
1065	* @returns The tag. 0 if hDbgMod is invalid.
1066	*
1067	* @param hDbgMod The module handle.
1068	*/
1069	RTDECL(uint64_t) RTDbgModGetTag(RTDBGMOD hDbgMod);
1070
1071	/**
1072	* Tags or untags the module.
1073	*
1074	* @returns IPRT status code.
1075	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1076	*
1077	* @param hDbgMod The module handle.
1078	* @param uTag The tag value. The convention is that 0 is no tag
1079	* and any other value means it's tagged. It's adviced
1080	* to use some kind of unique number like an address
1081	* (global or string cache for instance) to avoid
1082	* collisions with other users
1083	*/
1084	RTDECL(int) RTDbgModSetTag(RTDBGMOD hDbgMod, uint64_t uTag);
1085
1086
1087	/**
1088	* Adds a segment to the module. Optional feature.
1089	*
1090	* This method is intended used for manually constructing debug info for a
1091	* module. The main usage is from other debug info interpreters that want to
1092	* avoid writing a debug info database and instead uses the standard container
1093	* behind the scenes.
1094	*
1095	* @returns IPRT status code.
1096	* @retval VERR_NOT_SUPPORTED if this feature isn't support by the debug info
1097	* interpreter. This is a common return code.
1098	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1099	* @retval VERR_DBG_ADDRESS_WRAP if uRva+cb wraps around.
1100	* @retval VERR_DBG_SEGMENT_NAME_OUT_OF_RANGE if pszName is too short or long.
1101	* @retval VERR_INVALID_PARAMETER if fFlags contains undefined flags.
1102	* @retval VERR_DBG_SPECIAL_SEGMENT if *piSeg is a special segment.
1103	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if *piSeg doesn't meet expectations.
1104	*
1105	* @param hDbgMod The module handle.
1106	* @param uRva The image relative address of the segment.
1107	* @param cb The size of the segment.
1108	* @param pszName The segment name. Does not normally need to be
1109	* unique, although this is somewhat up to the
1110	* debug interpreter to decide.
1111	* @param fFlags Segment flags. Reserved for future used, MBZ.
1112	* @param piSeg The segment index or NIL_RTDBGSEGIDX on input.
1113	* The assigned segment index on successful return.
1114	* Optional.
1115	*/
1116	RTDECL(int) RTDbgModSegmentAdd(RTDBGMOD hDbgMod, RTUINTPTR uRva, RTUINTPTR cb, const char *pszName,
1117	uint32_t fFlags, PRTDBGSEGIDX piSeg);
1118
1119	/**
1120	* Gets the number of segments in the module.
1121	*
1122	* This is can be used to determine the range which can be passed to
1123	* RTDbgModSegmentByIndex and derivates.
1124	*
1125	* @returns The segment relative address.
1126	* NIL_RTDBGSEGIDX if the handle is invalid.
1127	*
1128	* @param hDbgMod The module handle.
1129	*/
1130	RTDECL(RTDBGSEGIDX) RTDbgModSegmentCount(RTDBGMOD hDbgMod);
1131
1132	/**
1133	* Query information about a segment.
1134	*
1135	* This can be used together with RTDbgModSegmentCount to enumerate segments.
1136	* The index starts a 0 and stops one below RTDbgModSegmentCount.
1137	*
1138	* @returns IPRT status code.
1139	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if iSeg is too high.
1140	* @retval VERR_DBG_SPECIAL_SEGMENT if iSeg indicates a special segment.
1141	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1142	*
1143	* @param hDbgMod The module handle.
1144	* @param iSeg The segment index. No special segments.
1145	* @param pSegInfo Where to return the segment info. The
1146	* RTDBGSEGMENT::Address member will be set to
1147	* RTUINTPTR_MAX or the load address used at link time.
1148	*/
1149	RTDECL(int) RTDbgModSegmentByIndex(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, PRTDBGSEGMENT pSegInfo);
1150
1151	/**
1152	* Gets the size of a segment.
1153	*
1154	* This is a just a wrapper around RTDbgModSegmentByIndex.
1155	*
1156	* @returns The segment size.
1157	* RTUINTPTR_MAX is returned if either the handle and segment index are
1158	* invalid.
1159	*
1160	* @param hDbgMod The module handle.
1161	* @param iSeg The segment index. RTDBGSEGIDX_ABS is not allowed.
1162	* If RTDBGSEGIDX_RVA is used, the functions returns
1163	* the same value as RTDbgModImageSize.
1164	*/
1165	RTDECL(RTUINTPTR) RTDbgModSegmentSize(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg);
1166
1167	/**
1168	* Gets the image relative address of a segment.
1169	*
1170	* This is a just a wrapper around RTDbgModSegmentByIndex.
1171	*
1172	* @returns The segment relative address.
1173	* RTUINTPTR_MAX is returned if either the handle and segment index are
1174	* invalid.
1175	*
1176	* @param hDbgMod The module handle.
1177	* @param iSeg The segment index. No special segment indexes
1178	* allowed (asserted).
1179	*/
1180	RTDECL(RTUINTPTR) RTDbgModSegmentRva(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg);
1181
1182
1183	/**
1184	* Adds a line number to the module.
1185	*
1186	* @returns IPRT status code.
1187	* @retval VERR_NOT_SUPPORTED if the module interpret doesn't support adding
1188	* custom symbols. This is a common place occurrence.
1189	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1190	* @retval VERR_DBG_SYMBOL_NAME_OUT_OF_RANGE if the symbol name is too long or
1191	* short.
1192	* @retval VERR_DBG_INVALID_RVA if an image relative address is specified and
1193	* it's not inside any of the segments defined by the module.
1194	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if the segment index isn't valid.
1195	* @retval VERR_DBG_INVALID_SEGMENT_OFFSET if the segment offset is beyond the
1196	* end of the segment.
1197	* @retval VERR_DBG_ADDRESS_WRAP if off+cb wraps around.
1198	* @retval VERR_INVALID_PARAMETER if the symbol flags sets undefined bits.
1199	*
1200	* @param hDbgMod The module handle.
1201	* @param pszSymbol The symbol name.
1202	* @param iSeg The segment index.
1203	* @param off The segment offset.
1204	* @param cb The size of the symbol. Can be zero, although this
1205	* may depend somewhat on the debug interpreter.
1206	* @param fFlags Symbol flags. Reserved for the future, MBZ.
1207	* @param piOrdinal Where to return the symbol ordinal on success. If
1208	* the interpreter doesn't do ordinals, this will be set to
1209	* UINT32_MAX. Optional.
1210	*/
1211	RTDECL(int) RTDbgModSymbolAdd(RTDBGMOD hDbgMod, const char *pszSymbol, RTDBGSEGIDX iSeg, RTUINTPTR off,
1212	RTUINTPTR cb, uint32_t fFlags, uint32_t *piOrdinal);
1213
1214	/**
1215	* Gets the symbol count.
1216	*
1217	* This can be used together wtih RTDbgModSymbolByOrdinal or
1218	* RTDbgModSymbolByOrdinalA to enumerate all the symbols.
1219	*
1220	* @returns The number of symbols in the module.
1221	* UINT32_MAX is returned if the module handle is invalid or some other
1222	* error occurs.
1223	*
1224	* @param hDbgMod The module handle.
1225	*/
1226	RTDECL(uint32_t) RTDbgModSymbolCount(RTDBGMOD hDbgMod);
1227
1228	/**
1229	* Queries symbol information by ordinal number.
1230	*
1231	* @returns IPRT status code.
1232	* @retval VERR_SYMBOL_NOT_FOUND if there is no symbol at the given number.
1233	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
1234	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1235	* @retval VERR_NOT_SUPPORTED if lookup by ordinal is not supported.
1236	*
1237	* @param hDbgMod The module handle.
1238	* @param iOrdinal The symbol ordinal number. 0-based. The highest
1239	* number is RTDbgModSymbolCount() - 1.
1240	* @param pSymInfo Where to store the symbol information.
1241	*/
1242	RTDECL(int) RTDbgModSymbolByOrdinal(RTDBGMOD hDbgMod, uint32_t iOrdinal, PRTDBGSYMBOL pSymInfo);
1243
1244	/**
1245	* Queries symbol information by ordinal number.
1246	*
1247	* @returns IPRT status code.
1248	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
1249	* @retval VERR_NOT_SUPPORTED if lookup by ordinal is not supported.
1250	* @retval VERR_SYMBOL_NOT_FOUND if there is no symbol at the given number.
1251	* @retval VERR_NO_MEMORY if RTDbgSymbolAlloc fails.
1252	*
1253	* @param hDbgMod The module handle.
1254	* @param iOrdinal The symbol ordinal number. 0-based. The highest
1255	* number is RTDbgModSymbolCount() - 1.
1256	* @param ppSymInfo Where to store the pointer to the returned
1257	* symbol information. Always set. Free with
1258	* RTDbgSymbolFree.
1259	*/
1260	RTDECL(int) RTDbgModSymbolByOrdinalA(RTDBGMOD hDbgMod, uint32_t iOrdinal, PRTDBGSYMBOL *ppSymInfo);
1261
1262	/**
1263	* Queries symbol information by address.
1264	*
1265	* The returned symbol is what the debug info interpreter considers the symbol
1266	* most applicable to the specified address. This usually means a symbol with an
1267	* address equal or lower than the requested.
1268	*
1269	* @returns IPRT status code.
1270	* @retval VERR_SYMBOL_NOT_FOUND if no suitable symbol was found.
1271	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
1272	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1273	* @retval VERR_DBG_INVALID_RVA if an image relative address is specified and
1274	* it's not inside any of the segments defined by the module.
1275	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if the segment index isn't valid.
1276	* @retval VERR_DBG_INVALID_SEGMENT_OFFSET if the segment offset is beyond the
1277	* end of the segment.
1278	* @retval VERR_INVALID_PARAMETER if incorrect flags.
1279	*
1280	* @param hDbgMod The module handle.
1281	* @param iSeg The segment number.
1282	* @param off The offset into the segment.
1283	* @param fFlags Symbol search flags, see RTDBGSYMADDR_FLAGS_XXX.
1284	* @param poffDisp Where to store the distance between the
1285	* specified address and the returned symbol.
1286	* Optional.
1287	* @param pSymInfo Where to store the symbol information.
1288	*/
1289	RTDECL(int) RTDbgModSymbolByAddr(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, uint32_t fFlags,
1290	PRTINTPTR poffDisp, PRTDBGSYMBOL pSymInfo);
1291
1292	/**
1293	* Queries symbol information by address.
1294	*
1295	* The returned symbol is what the debug info interpreter considers the symbol
1296	* most applicable to the specified address. This usually means a symbol with an
1297	* address equal or lower than the requested.
1298	*
1299	* @returns IPRT status code.
1300	* @retval VERR_SYMBOL_NOT_FOUND if no suitable symbol was found.
1301	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
1302	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1303	* @retval VERR_DBG_INVALID_RVA if an image relative address is specified and
1304	* it's not inside any of the segments defined by the module.
1305	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if the segment index isn't valid.
1306	* @retval VERR_DBG_INVALID_SEGMENT_OFFSET if the segment offset is beyond the
1307	* end of the segment.
1308	* @retval VERR_NO_MEMORY if RTDbgSymbolAlloc fails.
1309	* @retval VERR_INVALID_PARAMETER if incorrect flags.
1310	*
1311	* @param hDbgMod The module handle.
1312	* @param iSeg The segment index.
1313	* @param off The offset into the segment.
1314	* @param fFlags Symbol search flags, see RTDBGSYMADDR_FLAGS_XXX.
1315	* @param poffDisp Where to store the distance between the
1316	* specified address and the returned symbol. Optional.
1317	* @param ppSymInfo Where to store the pointer to the returned
1318	* symbol information. Always set. Free with
1319	* RTDbgSymbolFree.
1320	*/
1321	RTDECL(int) RTDbgModSymbolByAddrA(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, uint32_t fFlags,
1322	PRTINTPTR poffDisp, PRTDBGSYMBOL *ppSymInfo);
1323
1324	/**
1325	* Queries symbol information by symbol name.
1326	*
1327	* @returns IPRT status code.
1328	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
1329	* @retval VERR_SYMBOL_NOT_FOUND if no suitable symbol was found.
1330	* @retval VERR_DBG_SYMBOL_NAME_OUT_OF_RANGE if the symbol name is too long or
1331	* short.
1332	*
1333	* @param hDbgMod The module handle.
1334	* @param pszSymbol The symbol name.
1335	* @param pSymInfo Where to store the symbol information.
1336	*/
1337	RTDECL(int) RTDbgModSymbolByName(RTDBGMOD hDbgMod, const char *pszSymbol, PRTDBGSYMBOL pSymInfo);
1338
1339	/**
1340	* Queries symbol information by symbol name.
1341	*
1342	* @returns IPRT status code.
1343	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
1344	* @retval VERR_SYMBOL_NOT_FOUND if no suitable symbol was found.
1345	* @retval VERR_DBG_SYMBOL_NAME_OUT_OF_RANGE if the symbol name is too long or
1346	* short.
1347	* @retval VERR_NO_MEMORY if RTDbgSymbolAlloc fails.
1348	*
1349	* @param hDbgMod The module handle.
1350	* @param pszSymbol The symbol name.
1351	* @param ppSymInfo Where to store the pointer to the returned
1352	* symbol information. Always set. Free with
1353	* RTDbgSymbolFree.
1354	*/
1355	RTDECL(int) RTDbgModSymbolByNameA(RTDBGMOD hDbgMod, const char pszSymbol, PRTDBGSYMBOL ppSymInfo);
1356
1357	/**
1358	* Adds a line number to the module.
1359	*
1360	* @returns IPRT status code.
1361	* @retval VERR_NOT_SUPPORTED if the module interpret doesn't support adding
1362	* custom symbols. This should be consider a normal response.
1363	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1364	* @retval VERR_DBG_FILE_NAME_OUT_OF_RANGE if the file name is too longer or
1365	* empty.
1366	* @retval VERR_DBG_INVALID_RVA if an image relative address is specified and
1367	* it's not inside any of the segments defined by the module.
1368	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if the segment index isn't valid.
1369	* @retval VERR_DBG_INVALID_SEGMENT_OFFSET if the segment offset is beyond the
1370	* end of the segment.
1371	* @retval VERR_INVALID_PARAMETER if the line number flags sets undefined bits.
1372	*
1373	* @param hDbgMod The module handle.
1374	* @param pszFile The file name.
1375	* @param uLineNo The line number.
1376	* @param iSeg The segment index.
1377	* @param off The segment offset.
1378	* @param piOrdinal Where to return the line number ordinal on
1379	* success. If the interpreter doesn't do ordinals,
1380	* this will be set to UINT32_MAX. Optional.
1381	*/
1382	RTDECL(int) RTDbgModLineAdd(RTDBGMOD hDbgMod, const char *pszFile, uint32_t uLineNo,
1383	RTDBGSEGIDX iSeg, RTUINTPTR off, uint32_t *piOrdinal);
1384
1385	/**
1386	* Gets the line number count.
1387	*
1388	* This can be used together wtih RTDbgModLineByOrdinal or RTDbgModSymbolByLineA
1389	* to enumerate all the line number information.
1390	*
1391	* @returns The number of line numbers in the module.
1392	* UINT32_MAX is returned if the module handle is invalid or some other
1393	* error occurs.
1394	*
1395	* @param hDbgMod The module handle.
1396	*/
1397	RTDECL(uint32_t) RTDbgModLineCount(RTDBGMOD hDbgMod);
1398
1399	/**
1400	* Queries line number information by ordinal number.
1401	*
1402	* This can be used to enumerate the line numbers for the module. Use
1403	* RTDbgModLineCount() to figure the end of the ordinals.
1404	*
1405	* @returns IPRT status code.
1406	* @retval VERR_DBG_NO_LINE_NUMBERS if there aren't any line numbers.
1407	* @retval VERR_DBG_LINE_NOT_FOUND if there is no line number with that
1408	* ordinal.
1409	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1410
1411	* @param hDbgMod The module handle.
1412	* @param iOrdinal The line number ordinal number.
1413	* @param pLineInfo Where to store the information about the line
1414	* number.
1415	*/
1416	RTDECL(int) RTDbgModLineByOrdinal(RTDBGMOD hDbgMod, uint32_t iOrdinal, PRTDBGLINE pLineInfo);
1417
1418	/**
1419	* Queries line number information by ordinal number.
1420	*
1421	* This can be used to enumerate the line numbers for the module. Use
1422	* RTDbgModLineCount() to figure the end of the ordinals.
1423	*
1424	* @returns IPRT status code.
1425	* @retval VERR_DBG_NO_LINE_NUMBERS if there aren't any line numbers.
1426	* @retval VERR_DBG_LINE_NOT_FOUND if there is no line number with that
1427	* ordinal.
1428	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1429	* @retval VERR_NO_MEMORY if RTDbgLineAlloc fails.
1430	*
1431	* @param hDbgMod The module handle.
1432	* @param iOrdinal The line number ordinal number.
1433	* @param ppLineInfo Where to store the pointer to the returned line
1434	* number information. Always set. Free with
1435	* RTDbgLineFree.
1436	*/
1437	RTDECL(int) RTDbgModLineByOrdinalA(RTDBGMOD hDbgMod, uint32_t iOrdinal, PRTDBGLINE *ppLineInfo);
1438
1439	/**
1440	* Queries line number information by address.
1441	*
1442	* The returned line number is what the debug info interpreter considers the
1443	* one most applicable to the specified address. This usually means a line
1444	* number with an address equal or lower than the requested.
1445	*
1446	* @returns IPRT status code.
1447	* @retval VERR_DBG_NO_LINE_NUMBERS if there aren't any line numbers.
1448	* @retval VERR_DBG_LINE_NOT_FOUND if no suitable line number was found.
1449	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1450	* @retval VERR_DBG_INVALID_RVA if an image relative address is specified and
1451	* it's not inside any of the segments defined by the module.
1452	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if the segment index isn't valid.
1453	* @retval VERR_DBG_INVALID_SEGMENT_OFFSET if the segment offset is beyond the
1454	* end of the segment.
1455	*
1456	* @param hDbgMod The module handle.
1457	* @param iSeg The segment number.
1458	* @param off The offset into the segment.
1459	* @param poffDisp Where to store the distance between the
1460	* specified address and the returned symbol.
1461	* Optional.
1462	* @param pLineInfo Where to store the line number information.
1463	*/
1464	RTDECL(int) RTDbgModLineByAddr(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE pLineInfo);
1465
1466	/**
1467	* Queries line number information by address.
1468	*
1469	* The returned line number is what the debug info interpreter considers the
1470	* one most applicable to the specified address. This usually means a line
1471	* number with an address equal or lower than the requested.
1472	*
1473	* @returns IPRT status code.
1474	* @retval VERR_DBG_NO_LINE_NUMBERS if there aren't any line numbers.
1475	* @retval VERR_DBG_LINE_NOT_FOUND if no suitable line number was found.
1476	* @retval VERR_INVALID_HANDLE if hDbgMod is invalid.
1477	* @retval VERR_DBG_INVALID_RVA if an image relative address is specified and
1478	* it's not inside any of the segments defined by the module.
1479	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if the segment index isn't valid.
1480	* @retval VERR_DBG_INVALID_SEGMENT_OFFSET if the segment offset is beyond the
1481	* end of the segment.
1482	* @retval VERR_NO_MEMORY if RTDbgLineAlloc fails.
1483	*
1484	* @param hDbgMod The module handle.
1485	* @param iSeg The segment number.
1486	* @param off The offset into the segment.
1487	* @param poffDisp Where to store the distance between the
1488	* specified address and the returned symbol.
1489	* Optional.
1490	* @param ppLineInfo Where to store the pointer to the returned line
1491	* number information. Always set. Free with
1492	* RTDbgLineFree.
1493	*/
1494	RTDECL(int) RTDbgModLineByAddrA(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE *ppLineInfo);
1495	/** @} */
1496
1497	# endif /* IN_RING3 */
1498
1499
1500	/** @name Kernel Debug Info API
1501	*
1502	* This is a specialized API for obtaining symbols and structure information
1503	* about the running kernel. It is relatively OS specific. Its purpose and
1504	* operation is doesn't map all that well onto RTDbgMod, so a few dedicated
1505	* functions was created for it.
1506	*
1507	* @{ */
1508
1509	/** Handle to the kernel debug info. */
1510	typedef struct RTDBGKRNLINFOINT *RTDBGKRNLINFO;
1511	/** Pointer to a kernel debug info handle. */
1512	typedef RTDBGKRNLINFO *PRTDBGKRNLINFO;
1513	/** Nil kernel debug info handle. */
1514	#define NIL_RTDBGKRNLINFO ((RTDBGKRNLINFO)0)
1515
1516	/**
1517	* Opens the kernel debug info.
1518	*
1519	* @returns IPRT status code. Can fail for any number of reasons.
1520	*
1521	* @param phKrnlInfo Where to return the kernel debug info handle on
1522	* success.
1523	* @param fFlags Flags reserved for future use. Must be zero.
1524	*/
1525	RTR0DECL(int) RTR0DbgKrnlInfoOpen(PRTDBGKRNLINFO phKrnlInfo, uint32_t fFlags);
1526
1527	/**
1528	* Retains a reference to the kernel debug info handle.
1529	*
1530	* @returns New reference count, UINT32_MAX on invalid handle (asserted).
1531	* @param hKrnlInfo The kernel info handle.
1532	*/
1533	RTR0DECL(uint32_t) RTR0DbgKrnlInfoRetain(RTDBGKRNLINFO hKrnlInfo);
1534
1535
1536	/**
1537	* Releases a reference to the kernel debug info handle, destroying it when the
1538	* counter reaches zero.
1539	*
1540	* @returns New reference count, UINT32_MAX on invalid handle (asserted).
1541	* @param hKrnlInfo The kernel info handle. NIL_RTDBGKRNLINFO is
1542	* quietly ignored.
1543	*/
1544	RTR0DECL(uint32_t) RTR0DbgKrnlInfoRelease(RTDBGKRNLINFO hKrnlInfo);
1545
1546	/**
1547	* Queries the offset (in bytes) of a member of a kernel structure.
1548	*
1549	* @returns IPRT status code.
1550	* @retval VINF_SUCCESS and offset at @a poffMember.
1551	* @retval VERR_NOT_FOUND if the structure or the member was not found.
1552	* @retval VERR_INVALID_HANDLE if hKrnlInfo is bad.
1553	* @retval VERR_INVALID_POINTER if any of the pointers are bad.
1554	*
1555	* @param hKrnlInfo The kernel info handle.
1556	* @param pszStructure The structure name.
1557	* @param pszMember The member name.
1558	* @param poffMember Where to return the offset.
1559	*/
1560	RTR0DECL(int) RTR0DbgKrnlInfoQueryMember(RTDBGKRNLINFO hKrnlInfo, const char *pszStructure,
1561	const char pszMember, size_t poffMember);
1562
1563
1564	/**
1565	* Queries the value (usually the address) of a kernel symbol.
1566	*
1567	* This may go looking for the symbol in other modules, in which case it will
1568	* always check the kernel symbol table first.
1569	*
1570	* @returns IPRT status code.
1571	* @retval VINF_SUCCESS and value at @a ppvSymbol.
1572	* @retval VERR_SYMBOL_NOT_FOUND
1573	* @retval VERR_INVALID_HANDLE if hKrnlInfo is bad.
1574	* @retval VERR_INVALID_POINTER if any of the pointers are bad.
1575	*
1576	* @param hKrnlInfo The kernel info handle.
1577	* @param pszModule Reserved for future extensions. Pass NULL.
1578	* @param pszSymbol The C name of the symbol.
1579	* @param ppvSymbol Where to return the symbol value, passing NULL is
1580	* OK. This may be modified even on failure, in
1581	* particular, it will be set to NULL when
1582	* VERR_SYMBOL_NOT_FOUND is returned.
1583	*
1584	* @sa RTLdrGetSymbol.
1585	*/
1586	RTR0DECL(int) RTR0DbgKrnlInfoQuerySymbol(RTDBGKRNLINFO hKrnlInfo, const char *pszModule,
1587	const char pszSymbol, void *ppvSymbol);
1588	/** @} */
1589
1590	/** @} */
1591
1592	RT_C_DECLS_END
1593
1594	#endif
1595

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

source: vbox/trunk/include/iprt/dbg.h@ 47791

Download in other formats: