dbgmod.h@ 53401

Last change on this file since 53401 was 49061, checked in by vboxsync, 11 years ago
More Mach-O symbol hacking.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 25.7 KB

Line
1	/* $Id: dbgmod.h 49061 2013-10-11 20:15:59Z vboxsync $ */
2	/** @file
3	* IPRT - Internal Header for RTDbgMod and the associated interpreters.
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 ___internal_dbgmod_h
28	#define ___internal_dbgmod_h
29
30	#include <iprt/types.h>
31	#include <iprt/critsect.h>
32	#include <iprt/ldr.h> /* for PFNRTLDRENUMDBG */
33	#include "internal/magics.h"
34
35	RT_C_DECLS_BEGIN
36
37	/** @addtogroup grp_rt_dbgmod
38	* @internal
39	* @{
40	*/
41
42
43	/** Pointer to the internal module structure. */
44	typedef struct RTDBGMODINT *PRTDBGMODINT;
45
46	/**
47	* Virtual method table for executable image interpreters.
48	*/
49	typedef struct RTDBGMODVTIMG
50	{
51	/** Magic number (RTDBGMODVTIMG_MAGIC). */
52	uint32_t u32Magic;
53	/** Reserved. */
54	uint32_t fReserved;
55	/** The name of the interpreter. */
56	const char *pszName;
57
58	/**
59	* Try open the image.
60	*
61	* This combines probing and opening.
62	*
63	* @returns IPRT status code. No informational returns defined.
64	*
65	* @param pMod Pointer to the module that is being opened.
66	*
67	* The RTDBGMOD::pszDbgFile member will point to
68	* the filename of any debug info we're aware of
69	* on input. Also, or alternatively, it is expected
70	* that the interpreter will look for debug info in
71	* the executable image file when present and that it
72	* may ask the image interpreter for this when it's
73	* around.
74	*
75	* Upon successful return the method is expected to
76	* initialize pImgOps and pvImgPriv.
77	* @param enmArch The desired architecture.
78	*/
79	DECLCALLBACKMEMBER(int, pfnTryOpen)(PRTDBGMODINT pMod, RTLDRARCH enmArch);
80
81	/**
82	* Close the interpreter, freeing all associated resources.
83	*
84	* The caller sets the pDbgOps and pvDbgPriv RTDBGMOD members
85	* to NULL upon return.
86	*
87	* @param pMod Pointer to the module structure.
88	*/
89	DECLCALLBACKMEMBER(int, pfnClose)(PRTDBGMODINT pMod);
90
91	/**
92	* Enumerate the debug info contained in the executable image.
93	*
94	* Identical to RTLdrEnumDbgInfo.
95	*
96	* @returns IPRT status code or whatever pfnCallback returns.
97	*
98	* @param pMod Pointer to the module structure.
99	* @param pfnCallback The callback function. Ignore the module
100	* handle argument!
101	* @param pvUser The user argument.
102	*/
103	DECLCALLBACKMEMBER(int, pfnEnumDbgInfo)(PRTDBGMODINT pMod, PFNRTLDRENUMDBG pfnCallback, void *pvUser);
104
105	/**
106	* Enumerate the segments in the executable image.
107	*
108	* Identical to RTLdrEnumSegments.
109	*
110	* @returns IPRT status code or whatever pfnCallback returns.
111	*
112	* @param pMod Pointer to the module structure.
113	* @param pfnCallback The callback function. Ignore the module
114	* handle argument!
115	* @param pvUser The user argument.
116	*/
117	DECLCALLBACKMEMBER(int, pfnEnumSegments)(PRTDBGMODINT pMod, PFNRTLDRENUMSEGS pfnCallback, void *pvUser);
118
119	/**
120	* Enumerates the symbols exported by the module.
121	*
122	* @returns iprt status code, which might have been returned by pfnCallback.
123	* @param pMod Pointer to the module structure.
124	* @param fFlags Flags indicating what to return and such.
125	* @param BaseAddress The image base addressto use when calculating the
126	* symbol values.
127	* @param pfnCallback The callback function which each symbol is to be fed
128	* to.
129	* @param pvUser User argument to pass to the enumerator.
130	*/
131	DECLCALLBACKMEMBER(int, pfnEnumSymbols)(PRTDBGMODINT pMod, uint32_t fFlags, RTLDRADDR BaseAddress,
132	PFNRTLDRENUMSYMS pfnCallback, void *pvUser);
133
134	/**
135	* Gets the size of the loaded image.
136	*
137	* Identical to RTLdrSize.
138	*
139	* @returns The size in bytes, RTUINTPTR_MAX on failure.
140	*
141	* @param pMod Pointer to the module structure.
142	*/
143	DECLCALLBACKMEMBER(RTUINTPTR, pfnImageSize)(PRTDBGMODINT pMod);
144
145	/**
146	* Converts a link address to a segment:offset address (RVA included).
147	*
148	* @returns IPRT status code.
149	*
150	* @param pMod Pointer to the module structure.
151	* @param LinkAddress The link address to convert.
152	* @param piSeg The segment index.
153	* @param poffSeg Where to return the segment offset.
154	*/
155	DECLCALLBACKMEMBER(int, pfnLinkAddressToSegOffset)(PRTDBGMODINT pMod, RTLDRADDR LinkAddress,
156	PRTDBGSEGIDX piSeg, PRTLDRADDR poffSeg);
157
158	/**
159	* Converts an image relative virtual address to a segment:offset.
160	*
161	* @returns IPRT status code.
162	*
163	* @param pMod Pointer to the loader module structure.
164	* @param Rva The RVA to convert.
165	* @param piSeg The segment index.
166	* @param poffSeg Where to return the segment offset.
167	*/
168	DECLCALLBACKMEMBER(int, pfnRvaToSegOffset)(PRTDBGMODINT pMod, RTLDRADDR Rva, uint32_t *piSeg, PRTLDRADDR poffSeg);
169
170	/**
171	* Creates a read-only mapping of a part of the image file.
172	*
173	* @returns IPRT status code and *ppvMap set on success.
174	*
175	* @param pMod Pointer to the module structure.
176	* @param iDbgInfo The debug info ordinal number if the request
177	* corresponds exactly to a debug info part from
178	* pfnEnumDbgInfo. Otherwise, pass UINT32_MAX.
179	* @param off The offset into the image file.
180	* @param cb The number of bytes to map.
181	* @param ppvMap Where to return the mapping address on success.
182	*
183	* @remarks Fixups will only be applied if @a iDbgInfo is specified.
184	*/
185	DECLCALLBACKMEMBER(int, pfnMapPart)(PRTDBGMODINT pMod, uint32_t iDbgInfo, RTFOFF off, size_t cb, void const **ppvMap);
186
187	/**
188	* Unmaps memory previously mapped by pfnMapPart.
189	*
190	* @returns IPRT status code, *ppvMap set to NULL on success.
191	*
192	* @param pMod Pointer to the module structure.
193	* @param cb The size of the mapping.
194	* @param ppvMap The mapping address on input, NULL on
195	* successful return.
196	*/
197	DECLCALLBACKMEMBER(int, pfnUnmapPart)(PRTDBGMODINT pMod, size_t cb, void const **ppvMap);
198
199	/**
200	* Reads data from the image file.
201	*
202	* @returns IPRT status code, *ppvMap set to NULL on success.
203	*
204	* @param pMod Pointer to the module structure.
205	* @param iDbgInfoHint The debug info ordinal number hint, pass UINT32_MAX
206	* if not know or sure.
207	* @param off The offset into the image file.
208	* @param pvBuf The buffer to read into.
209	* @param cb The number of bytes to read.
210	*/
211	DECLCALLBACKMEMBER(int, pfnReadAt)(PRTDBGMODINT pMod, uint32_t iDbgInfoHint, RTFOFF off, void *pvBuf, size_t cb);
212
213	/**
214	* Gets the image format.
215	*
216	* @returns Valid image format on success, RTLDRFMT_INVALID if not supported.
217	* @param pMod Pointer to the module structure.
218	*/
219	DECLCALLBACKMEMBER(RTLDRFMT, pfnGetFormat)(PRTDBGMODINT pMod);
220
221	/**
222	* Gets the image architecture.
223	*
224	* @returns Valid image architecutre on success, RTLDRARCH_WHATEVER if not
225	* supported.
226	* @param pMod Pointer to the module structure.
227	*/
228	DECLCALLBACKMEMBER(RTLDRARCH, pfnGetArch)(PRTDBGMODINT pMod);
229
230	/**
231	* Generic method for querying image properties.
232	*
233	* @returns IPRT status code.
234	* @param pMod Pointer to the module structure.
235	* @param enmLdrProp The property to query.
236	* @param pvBuf Pointer to the return buffer.
237	* @param cbBuf The size of the return buffer.
238	* @sa RTLdrQueryProp
239	*/
240	DECLCALLBACKMEMBER(int, pfnQueryProp)(PRTDBGMODINT pMod, RTLDRPROP enmProp, void *pvBuf, size_t cbBuf);
241
242	/** For catching initialization errors (RTDBGMODVTIMG_MAGIC). */
243	uint32_t u32EndMagic;
244	} RTDBGMODVTIMG;
245	/** Pointer to a const RTDBGMODVTIMG. */
246	typedef RTDBGMODVTIMG const *PCRTDBGMODVTIMG;
247
248
249	/**
250	* Virtual method table for debug info interpreters.
251	*/
252	typedef struct RTDBGMODVTDBG
253	{
254	/** Magic number (RTDBGMODVTDBG_MAGIC). */
255	uint32_t u32Magic;
256	/** Mask of supported debug info types, see grp_rt_dbg_type.
257	* Used to speed up the search for a suitable interpreter. */
258	uint32_t fSupports;
259	/** The name of the interpreter. */
260	const char *pszName;
261
262	/**
263	* Try open the image.
264	*
265	* This combines probing and opening.
266	*
267	* @returns IPRT status code. No informational returns defined.
268	*
269	* @param pMod Pointer to the module that is being opened.
270	*
271	* The RTDBGMOD::pszDbgFile member will point to
272	* the filename of any debug info we're aware of
273	* on input. Also, or alternatively, it is expected
274	* that the interpreter will look for debug info in
275	* the executable image file when present and that it
276	* may ask the image interpreter for this when it's
277	* around.
278	*
279	* Upon successful return the method is expected to
280	* initialize pDbgOps and pvDbgPriv.
281	* @param enmArch The desired architecture.
282	*/
283	DECLCALLBACKMEMBER(int, pfnTryOpen)(PRTDBGMODINT pMod, RTLDRARCH enmArch);
284
285	/**
286	* Close the interpreter, freeing all associated resources.
287	*
288	* The caller sets the pDbgOps and pvDbgPriv RTDBGMOD members
289	* to NULL upon return.
290	*
291	* @param pMod Pointer to the module structure.
292	*/
293	DECLCALLBACKMEMBER(int, pfnClose)(PRTDBGMODINT pMod);
294
295
296
297	/**
298	* Converts an image relative virtual address address to a segmented address.
299	*
300	* @returns Segment index on success, NIL_RTDBGSEGIDX on failure.
301	* @param pMod Pointer to the module structure.
302	* @param uRva The image relative address to convert.
303	* @param poffSeg Where to return the segment offset. Optional.
304	*/
305	DECLCALLBACKMEMBER(RTDBGSEGIDX, pfnRvaToSegOff)(PRTDBGMODINT pMod, RTUINTPTR uRva, PRTUINTPTR poffSeg);
306
307	/**
308	* Image size when mapped if segments are mapped adjacently.
309	*
310	* For ELF, PE, and Mach-O images this is (usually) a natural query, for LX and
311	* NE and such it's a bit odder and the answer may not make much sense for them.
312	*
313	* @returns Image mapped size.
314	* @param pMod Pointer to the module structure.
315	*/
316	DECLCALLBACKMEMBER(RTUINTPTR, pfnImageSize)(PRTDBGMODINT pMod);
317
318
319
320	/**
321	* Adds a segment to the module (optional).
322	*
323	* @returns IPRT status code.
324	* @retval VERR_NOT_SUPPORTED if the interpreter doesn't support this feature.
325	* @retval VERR_DBG_SEGMENT_INDEX_CONFLICT if the segment index exists already.
326	*
327	* @param pMod Pointer to the module structure.
328	* @param uRva The segment image relative address.
329	* @param cb The segment size.
330	* @param pszName The segment name.
331	* @param cchName The length of the segment name.
332	* @param fFlags Segment flags.
333	* @param piSeg The segment index or NIL_RTDBGSEGIDX on input.
334	* The assigned segment index on successful return.
335	* Optional.
336	*/
337	DECLCALLBACKMEMBER(int, pfnSegmentAdd)(PRTDBGMODINT pMod, RTUINTPTR uRva, RTUINTPTR cb, const char *pszName, size_t cchName,
338	uint32_t fFlags, PRTDBGSEGIDX piSeg);
339
340	/**
341	* Gets the segment count.
342	*
343	* @returns Number of segments.
344	* @retval NIL_RTDBGSEGIDX if unknown.
345	*
346	* @param pMod Pointer to the module structure.
347	*/
348	DECLCALLBACKMEMBER(RTDBGSEGIDX, pfnSegmentCount)(PRTDBGMODINT pMod);
349
350	/**
351	* Gets information about a segment.
352	*
353	* @returns IPRT status code.
354	* @retval VERR_DBG_INVALID_SEGMENT_INDEX if iSeg is too high.
355	*
356	* @param pMod Pointer to the module structure.
357	* @param iSeg The segment.
358	* @param pSegInfo Where to store the segment information.
359	*/
360	DECLCALLBACKMEMBER(int, pfnSegmentByIndex)(PRTDBGMODINT pMod, RTDBGSEGIDX iSeg, PRTDBGSEGMENT pSegInfo);
361
362
363
364	/**
365	* Adds a symbol to the module (optional).
366	*
367	* @returns IPRT code.
368	* @retval VERR_NOT_SUPPORTED if the interpreter doesn't support this feature.
369	*
370	* @param pMod Pointer to the module structure.
371	* @param pszSymbol The symbol name.
372	* @param cchSymbol The length for the symbol name.
373	* @param iSeg The segment number (0-based). RTDBGMOD_SEG_RVA can be used.
374	* @param off The offset into the segment.
375	* @param cb The area covered by the symbol. 0 is fine.
376	* @param fFlags Flags.
377	* @param piOrdinal Where to return the symbol ordinal on success. If the
378	* interpreter doesn't do ordinals, this will be set to
379	* UINT32_MAX. Optional
380	*/
381	DECLCALLBACKMEMBER(int, pfnSymbolAdd)(PRTDBGMODINT pMod, const char *pszSymbol, size_t cchSymbol,
382	uint32_t iSeg, RTUINTPTR off, RTUINTPTR cb, uint32_t fFlags,
383	uint32_t *piOrdinal);
384
385	/**
386	* Gets the number of symbols in the module.
387	*
388	* This is used for figuring out the max value to pass to pfnSymbolByIndex among
389	* other things.
390	*
391	* @returns The number of symbols, UINT32_MAX if not known/supported.
392	*
393	* @param pMod Pointer to the module structure.
394	*/
395	DECLCALLBACKMEMBER(uint32_t, pfnSymbolCount)(PRTDBGMODINT pMod);
396
397	/**
398	* Queries symbol information by ordinal number.
399	*
400	* @returns IPRT status code.
401	* @retval VINF_SUCCESS on success, no informational status code.
402	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
403	* @retval VERR_NOT_SUPPORTED if lookup by ordinal is not supported.
404	* @retval VERR_SYMBOL_NOT_FOUND if there is no symbol at that index.
405	*
406	* @param pMod Pointer to the module structure.
407	* @param iOrdinal The symbol ordinal number.
408	* @param pSymInfo Where to store the symbol information.
409	*/
410	DECLCALLBACKMEMBER(int, pfnSymbolByOrdinal)(PRTDBGMODINT pMod, uint32_t iOrdinal, PRTDBGSYMBOL pSymInfo);
411
412	/**
413	* Queries symbol information by symbol name.
414	*
415	* @returns IPRT status code.
416	* @retval VINF_SUCCESS on success, no informational status code.
417	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
418	* @retval VERR_SYMBOL_NOT_FOUND if no suitable symbol was found.
419	*
420	* @param pMod Pointer to the module structure.
421	* @param pszSymbol The symbol name.
422	* @param cchSymbol The length of the symbol name.
423	* @param pSymInfo Where to store the symbol information.
424	*/
425	DECLCALLBACKMEMBER(int, pfnSymbolByName)(PRTDBGMODINT pMod, const char *pszSymbol, size_t cchSymbol, PRTDBGSYMBOL pSymInfo);
426
427	/**
428	* Queries symbol information by address.
429	*
430	* The returned symbol is what the debug info interpreter considers the symbol
431	* most applicable to the specified address. This usually means a symbol with an
432	* address equal or lower than the requested.
433	*
434	* @returns IPRT status code.
435	* @retval VINF_SUCCESS on success, no informational status code.
436	* @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
437	* @retval VERR_SYMBOL_NOT_FOUND if no suitable symbol was found.
438	*
439	* @param pMod Pointer to the module structure.
440	* @param iSeg The segment number (0-based) or RTDBGSEGIDX_ABS.
441	* @param off The offset into the segment.
442	* @param fFlags Symbol search flags, see RTDBGSYMADDR_FLAGS_XXX.
443	* @param poffDisp Where to store the distance between the specified address
444	* and the returned symbol. Optional.
445	* @param pSymInfo Where to store the symbol information.
446	*/
447	DECLCALLBACKMEMBER(int, pfnSymbolByAddr)(PRTDBGMODINT pMod, uint32_t iSeg, RTUINTPTR off, uint32_t fFlags,
448	PRTINTPTR poffDisp, PRTDBGSYMBOL pSymInfo);
449
450
451
452	/**
453	* Adds a line number to the module (optional).
454	*
455	* @returns IPRT status code.
456	* @retval VERR_NOT_SUPPORTED if the interpreter doesn't support this feature.
457	*
458	* @param pMod Pointer to the module structure.
459	* @param pszFile The filename.
460	* @param cchFile The length of the filename.
461	* @param uLineNo The line number.
462	* @param iSeg The segment number (0-based).
463	* @param off The offset into the segment.
464	* @param piOrdinal Where to return the line number ordinal on success. If
465	* the interpreter doesn't do ordinals, this will be set to
466	* UINT32_MAX. Optional
467	*/
468	DECLCALLBACKMEMBER(int, pfnLineAdd)(PRTDBGMODINT pMod, const char *pszFile, size_t cchFile, uint32_t uLineNo,
469	uint32_t iSeg, RTUINTPTR off, uint32_t *piOrdinal);
470
471	/**
472	* Gets the number of line numbers in the module.
473	*
474	* @returns The number or UINT32_MAX if not known/supported.
475	*
476	* @param pMod Pointer to the module structure.
477	*/
478	DECLCALLBACKMEMBER(uint32_t, pfnLineCount)(PRTDBGMODINT pMod);
479
480	/**
481	* Queries line number information by ordinal number.
482	*
483	* @returns IPRT status code.
484	* @retval VINF_SUCCESS on success, no informational status code.
485	* @retval VERR_DBG_NO_LINE_NUMBERS if there aren't any line numbers.
486	* @retval VERR_DBG_LINE_NOT_FOUND if there is no line number with that
487	* ordinal.
488	*
489	* @param pMod Pointer to the module structure.
490	* @param iOrdinal The line number ordinal number.
491	* @param pLineInfo Where to store the information about the line number.
492	*/
493	DECLCALLBACKMEMBER(int, pfnLineByOrdinal)(PRTDBGMODINT pMod, uint32_t iOrdinal, PRTDBGLINE pLineInfo);
494
495	/**
496	* Queries line number information by address.
497	*
498	* @returns IPRT status code.
499	* @retval VINF_SUCCESS on success, no informational status code.
500	* @retval VERR_DBG_NO_LINE_NUMBERS if there aren't any line numbers.
501	* @retval VERR_DBG_LINE_NOT_FOUND if no suitable line number was found.
502	*
503	* @param pMod Pointer to the module structure.
504	* @param iSeg The segment number (0-based) or RTDBGSEGIDX_ABS.
505	* @param off The offset into the segment.
506	* @param poffDisp Where to store the distance between the specified address
507	* and the returned line number. Optional.
508	* @param pLineInfo Where to store the information about the closest line
509	* number.
510	*/
511	DECLCALLBACKMEMBER(int, pfnLineByAddr)(PRTDBGMODINT pMod, uint32_t iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE pLineInfo);
512
513
514	/** For catching initialization errors (RTDBGMODVTDBG_MAGIC). */
515	uint32_t u32EndMagic;
516	} RTDBGMODVTDBG;
517	/** Pointer to a const RTDBGMODVTDBG. */
518	typedef RTDBGMODVTDBG const *PCRTDBGMODVTDBG;
519
520
521	/**
522	* Deferred loading callback.
523	*
524	* @returns IPRT status code. On success the necessary method tables should be
525	* installed in @a pMod.
526	* @param pMod Pointer to the debug module structure.
527	* @param pDeferred The deferred load data.
528	*/
529	typedef DECLCALLBACK(int) FNRTDBGMODDEFERRED(PRTDBGMODINT pMod, struct RTDBGMODDEFERRED *pDeferred);
530	/** Pointer to a deferred loading callback. */
531	typedef FNRTDBGMODDEFERRED *PFNRTDBGMODDEFERRED;
532
533
534	/**
535	* Structure pointed to by pvDbgPriv and/or pvImgPriv when
536	* g_rtDbgModVtDbgDeferred and/or g_rtDbgModVtImgDeferred are being used.
537	*/
538	typedef struct RTDBGMODDEFERRED
539	{
540	/** The image size.
541	* Deferred loading is almost pointless without knowing the module size, as
542	* it cannot be mapped (correctly) without it. */
543	RTUINTPTR cbImage;
544	/** Reference counter. */
545	uint32_t volatile cRefs;
546	/** The configuration instance (referenced), can be NIL. */
547	RTDBGCFG hDbgCfg;
548	/** Performs deferred loading of the module. */
549	PFNRTDBGMODDEFERRED pfnDeferred;
550	/** Callback specific data. */
551	union
552	{
553	struct
554	{
555	/** The time/date stamp of the executable image and codeview file. */
556	uint32_t uTimestamp;
557	} PeImage,
558	OldCodeView;
559
560	struct
561	{
562	/** The PDB uuid. */
563	RTUUID Uuid;
564	/** The PDB age. */
565	uint32_t uAge;
566	} NewCodeview;
567
568	struct
569	{
570	/** The CRC-32 value found in the .gnu_debuglink section. */
571	uint32_t uCrc32;
572	} GnuDebugLink;
573
574	struct
575	{
576	/** The image UUID. */
577	RTUUID Uuid;
578	/** Image architecture. */
579	RTLDRARCH enmArch;
580	/** Number of segment mappings. */
581	uint32_t cSegs;
582	/** Segment mappings. */
583	RTDBGSEGMENT aSegs[1];
584	} MachO;
585	} u;
586	} RTDBGMODDEFERRED;
587	/** Pointer to the deferred loading data. */
588	typedef RTDBGMODDEFERRED *PRTDBGMODDEFERRED;
589
590
591	/**
592	* Debug module structure.
593	*/
594	typedef struct RTDBGMODINT
595	{
596	/** Magic value (RTDBGMOD_MAGIC). */
597	uint32_t u32Magic;
598	/** The number of reference there are to this module.
599	* This is used to perform automatic cleanup and sharing. */
600	uint32_t volatile cRefs;
601	/** The module tag. */
602	uint64_t uTag;
603
604	/** When set, the loading of the image and debug info (including locating any
605	* external files), will not have taken place yet. */
606	uint32_t fDeferred : 1;
607	/** Set if deferred loading failed. */
608	uint32_t fDeferredFailed : 1;
609	/** Set if the debug info is based on image exports and segments. */
610	uint32_t fExports : 1;
611	/** Alignment padding. */
612	uint32_t fPadding1 : 29;
613	#if ARCH_BITS == 64
614	uint32_t u32Padding2;
615	#endif
616
617	/** The module name (short). */
618	char const *pszName;
619	/** The image file specified by the user. Can be NULL. */
620	char const *pszImgFileSpecified;
621	/** The module filename. Can be NULL. */
622	char const *pszImgFile;
623	/** The debug info file (if external). Can be NULL. */
624	char const *pszDbgFile;
625
626	/** The method table for the executable image interpreter. */
627	PCRTDBGMODVTIMG pImgVt;
628	/** Pointer to the private data of the executable image interpreter. */
629	void *pvImgPriv;
630
631	/** The method table for the debug info interpreter. */
632	PCRTDBGMODVTDBG pDbgVt;
633	/** Pointer to the private data of the debug info interpreter. */
634	void *pvDbgPriv;
635
636	/** Critical section serializing access to the module. */
637	RTCRITSECT CritSect;
638	} RTDBGMODINT;
639	/** Pointer to an debug module structure. */
640	typedef RTDBGMODINT *PRTDBGMODINT;
641
642
643	extern DECLHIDDEN(RTSTRCACHE) g_hDbgModStrCache;
644	extern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgCodeView;
645	extern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgDwarf;
646	extern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgNm;
647	#ifdef RT_OS_WINDOWS
648	extern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgDbgHelp;
649	#endif
650	extern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgDeferred;
651	extern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgContainer;
652
653	extern DECLHIDDEN(RTDBGMODVTIMG const) g_rtDbgModVtImgLdr;
654	extern DECLHIDDEN(RTDBGMODVTIMG const) g_rtDbgModVtImgDeferred;
655
656	DECLHIDDEN(int) rtDbgModContainerCreate(PRTDBGMODINT pMod, RTUINTPTR cbSeg);
657	DECLHIDDEN(int) rtDbgModContainer_SymbolRemoveAll(PRTDBGMODINT pMod);
658	DECLHIDDEN(int) rtDbgModContainer_LineRemoveAll(PRTDBGMODINT pMod);
659	DECLHIDDEN(int) rtDbgModContainer_RemoveAll(PRTDBGMODINT pMod);
660
661	DECLHIDDEN(int) rtDbgModCreateForExports(PRTDBGMODINT pDbgMod);
662	DECLHIDDEN(int) rtDbgModDeferredCreate(PRTDBGMODINT pDbgMod, PFNRTDBGMODDEFERRED pfnDeferred, RTUINTPTR cbImage,
663	RTDBGCFG hDbgCfg, size_t cbDeferred, PRTDBGMODDEFERRED *ppDeferred);
664
665	DECLHIDDEN(int) rtDbgModLdrOpenFromHandle(PRTDBGMODINT pDbgMod, RTLDRMOD hLdrMod);
666
667	/** @} */
668
669	RT_C_DECLS_END
670
671	#endif
672

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

source: vbox/trunk/src/VBox/Runtime/include/internal/dbgmod.h@ 53401

Download in other formats: