dbg.h@ 46050

Last change on this file since 46050 was 46050, checked in by vboxsync, 12 years ago
More symbol work
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 59.3 KB

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

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

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

Download in other formats: