dbgmod.cpp@ 72778

Last change on this file since 72778 was 69111, checked in by vboxsync, 7 years ago
(C) year
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 66.9 KB

Line
1	/* $Id: dbgmod.cpp 69111 2017-10-17 14:26:02Z vboxsync $ */
2	/** @file
3	* IPRT - Debug Module Interpreter.
4	*/
5
6	/*
7	* Copyright (C) 2009-2017 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
28	/*********************************************************************************************************************************
29	* Header Files *
30	*********************************************************************************************************************************/
31	#define LOG_GROUP RTLOGGROUP_DBG
32	#include <iprt/dbg.h>
33	#include "internal/iprt.h"
34
35	#include <iprt/alloca.h>
36	#include <iprt/asm.h>
37	#include <iprt/assert.h>
38	#include <iprt/avl.h>
39	#include <iprt/err.h>
40	#include <iprt/initterm.h>
41	#include <iprt/log.h>
42	#include <iprt/mem.h>
43	#include <iprt/once.h>
44	#include <iprt/param.h>
45	#include <iprt/path.h>
46	#include <iprt/semaphore.h>
47	#include <iprt/strcache.h>
48	#include <iprt/string.h>
49	#include <iprt/uuid.h>
50	#include "internal/dbgmod.h"
51	#include "internal/magics.h"
52
53
54	/*********************************************************************************************************************************
55	* Structures and Typedefs *
56	*********************************************************************************************************************************/
57	/** Debug info interpreter registration record. */
58	typedef struct RTDBGMODREGDBG
59	{
60	/** Pointer to the next record. */
61	struct RTDBGMODREGDBG *pNext;
62	/** Pointer to the virtual function table for the interpreter. */
63	PCRTDBGMODVTDBG pVt;
64	/** Usage counter. */
65	uint32_t volatile cUsers;
66	} RTDBGMODREGDBG;
67	typedef RTDBGMODREGDBG *PRTDBGMODREGDBG;
68
69	/** Image interpreter registration record. */
70	typedef struct RTDBGMODREGIMG
71	{
72	/** Pointer to the next record. */
73	struct RTDBGMODREGIMG *pNext;
74	/** Pointer to the virtual function table for the interpreter. */
75	PCRTDBGMODVTIMG pVt;
76	/** Usage counter. */
77	uint32_t volatile cUsers;
78	} RTDBGMODREGIMG;
79	typedef RTDBGMODREGIMG *PRTDBGMODREGIMG;
80
81
82	/*********************************************************************************************************************************
83	* Defined Constants And Macros *
84	*********************************************************************************************************************************/
85	/** Validates a debug module handle and returns rc if not valid. */
86	#define RTDBGMOD_VALID_RETURN_RC(pDbgMod, rc) \
87	do { \
88	AssertPtrReturn((pDbgMod), (rc)); \
89	AssertReturn((pDbgMod)->u32Magic == RTDBGMOD_MAGIC, (rc)); \
90	AssertReturn((pDbgMod)->cRefs > 0, (rc)); \
91	} while (0)
92
93	/** Locks the debug module. */
94	#define RTDBGMOD_LOCK(pDbgMod) \
95	do { \
96	int rcLock = RTCritSectEnter(&(pDbgMod)->CritSect); \
97	AssertRC(rcLock); \
98	} while (0)
99
100	/** Unlocks the debug module. */
101	#define RTDBGMOD_UNLOCK(pDbgMod) \
102	do { \
103	int rcLock = RTCritSectLeave(&(pDbgMod)->CritSect); \
104	AssertRC(rcLock); \
105	} while (0)
106
107
108	/*********************************************************************************************************************************
109	* Global Variables *
110	*********************************************************************************************************************************/
111	/** Init once object for lazy registration of the built-in image and debug
112	* info interpreters. */
113	static RTONCE g_rtDbgModOnce = RTONCE_INITIALIZER;
114	/** Read/Write semaphore protecting the list of registered interpreters. */
115	static RTSEMRW g_hDbgModRWSem = NIL_RTSEMRW;
116	/** List of registered image interpreters. */
117	static PRTDBGMODREGIMG g_pImgHead;
118	/** List of registered debug infor interpreters. */
119	static PRTDBGMODREGDBG g_pDbgHead;
120	/** String cache for the debug info interpreters.
121	* RTSTRCACHE is thread safe. */
122	DECLHIDDEN(RTSTRCACHE) g_hDbgModStrCache = NIL_RTSTRCACHE;
123
124
125
126
127
128	/**
129	* Cleanup debug info interpreter globals.
130	*
131	* @param enmReason The cause of the termination.
132	* @param iStatus The meaning of this depends on enmReason.
133	* @param pvUser User argument, unused.
134	*/
135	static DECLCALLBACK(void) rtDbgModTermCallback(RTTERMREASON enmReason, int32_t iStatus, void *pvUser)
136	{
137	NOREF(iStatus); NOREF(pvUser);
138	if (enmReason == RTTERMREASON_UNLOAD)
139	{
140	RTSemRWDestroy(g_hDbgModRWSem);
141	g_hDbgModRWSem = NIL_RTSEMRW;
142
143	RTStrCacheDestroy(g_hDbgModStrCache);
144	g_hDbgModStrCache = NIL_RTSTRCACHE;
145
146	PRTDBGMODREGDBG pDbg = g_pDbgHead;
147	g_pDbgHead = NULL;
148	while (pDbg)
149	{
150	PRTDBGMODREGDBG pNext = pDbg->pNext;
151	AssertMsg(pDbg->cUsers == 0, ("%#x %s\n", pDbg->cUsers, pDbg->pVt->pszName));
152	RTMemFree(pDbg);
153	pDbg = pNext;
154	}
155
156	PRTDBGMODREGIMG pImg = g_pImgHead;
157	g_pImgHead = NULL;
158	while (pImg)
159	{
160	PRTDBGMODREGIMG pNext = pImg->pNext;
161	AssertMsg(pImg->cUsers == 0, ("%#x %s\n", pImg->cUsers, pImg->pVt->pszName));
162	RTMemFree(pImg);
163	pImg = pNext;
164	}
165	}
166	}
167
168
169	/**
170	* Internal worker for register a debug interpreter.
171	*
172	* Called while owning the write lock or when locking isn't required.
173	*
174	* @returns IPRT status code.
175	* @retval VERR_NO_MEMORY
176	* @retval VERR_ALREADY_EXISTS
177	*
178	* @param pVt The virtual function table of the debug
179	* module interpreter.
180	*/
181	static int rtDbgModDebugInterpreterRegister(PCRTDBGMODVTDBG pVt)
182	{
183	/*
184	* Search or duplicate registration.
185	*/
186	PRTDBGMODREGDBG pPrev = NULL;
187	for (PRTDBGMODREGDBG pCur = g_pDbgHead; pCur; pCur = pCur->pNext)
188	{
189	if (pCur->pVt == pVt)
190	return VERR_ALREADY_EXISTS;
191	if (!strcmp(pCur->pVt->pszName, pVt->pszName))
192	return VERR_ALREADY_EXISTS;
193	pPrev = pCur;
194	}
195
196	/*
197	* Create a new record and add it to the end of the list.
198	*/
199	PRTDBGMODREGDBG pReg = (PRTDBGMODREGDBG)RTMemAlloc(sizeof(*pReg));
200	if (!pReg)
201	return VERR_NO_MEMORY;
202	pReg->pVt = pVt;
203	pReg->cUsers = 0;
204	pReg->pNext = NULL;
205	if (pPrev)
206	pPrev->pNext = pReg;
207	else
208	g_pDbgHead = pReg;
209	return VINF_SUCCESS;
210	}
211
212
213	/**
214	* Internal worker for register a image interpreter.
215	*
216	* Called while owning the write lock or when locking isn't required.
217	*
218	* @returns IPRT status code.
219	* @retval VERR_NO_MEMORY
220	* @retval VERR_ALREADY_EXISTS
221	*
222	* @param pVt The virtual function table of the image
223	* interpreter.
224	*/
225	static int rtDbgModImageInterpreterRegister(PCRTDBGMODVTIMG pVt)
226	{
227	/*
228	* Search or duplicate registration.
229	*/
230	PRTDBGMODREGIMG pPrev = NULL;
231	for (PRTDBGMODREGIMG pCur = g_pImgHead; pCur; pCur = pCur->pNext)
232	{
233	if (pCur->pVt == pVt)
234	return VERR_ALREADY_EXISTS;
235	if (!strcmp(pCur->pVt->pszName, pVt->pszName))
236	return VERR_ALREADY_EXISTS;
237	pPrev = pCur;
238	}
239
240	/*
241	* Create a new record and add it to the end of the list.
242	*/
243	PRTDBGMODREGIMG pReg = (PRTDBGMODREGIMG)RTMemAlloc(sizeof(*pReg));
244	if (!pReg)
245	return VERR_NO_MEMORY;
246	pReg->pVt = pVt;
247	pReg->cUsers = 0;
248	pReg->pNext = NULL;
249	if (pPrev)
250	pPrev->pNext = pReg;
251	else
252	g_pImgHead = pReg;
253	return VINF_SUCCESS;
254	}
255
256
257	/**
258	* Do-once callback that initializes the read/write semaphore and registers
259	* the built-in interpreters.
260	*
261	* @returns IPRT status code.
262	* @param pvUser NULL.
263	*/
264	static DECLCALLBACK(int) rtDbgModInitOnce(void *pvUser)
265	{
266	NOREF(pvUser);
267
268	/*
269	* Create the semaphore and string cache.
270	*/
271	int rc = RTSemRWCreate(&g_hDbgModRWSem);
272	AssertRCReturn(rc, rc);
273
274	rc = RTStrCacheCreate(&g_hDbgModStrCache, "RTDBGMOD");
275	if (RT_SUCCESS(rc))
276	{
277	/*
278	* Register the interpreters.
279	*/
280	rc = rtDbgModDebugInterpreterRegister(&g_rtDbgModVtDbgNm);
281	if (RT_SUCCESS(rc))
282	rc = rtDbgModDebugInterpreterRegister(&g_rtDbgModVtDbgDwarf);
283	if (RT_SUCCESS(rc))
284	rc = rtDbgModDebugInterpreterRegister(&g_rtDbgModVtDbgCodeView);
285	#ifdef RT_OS_WINDOWS
286	if (RT_SUCCESS(rc))
287	rc = rtDbgModDebugInterpreterRegister(&g_rtDbgModVtDbgDbgHelp);
288	#endif
289	if (RT_SUCCESS(rc))
290	rc = rtDbgModImageInterpreterRegister(&g_rtDbgModVtImgLdr);
291	if (RT_SUCCESS(rc))
292	{
293	/*
294	* Finally, register the IPRT cleanup callback.
295	*/
296	rc = RTTermRegisterCallback(rtDbgModTermCallback, NULL);
297	if (RT_SUCCESS(rc))
298	return VINF_SUCCESS;
299
300	/* bail out: use the termination callback. */
301	}
302	}
303	else
304	g_hDbgModStrCache = NIL_RTSTRCACHE;
305	rtDbgModTermCallback(RTTERMREASON_UNLOAD, 0, NULL);
306	return rc;
307	}
308
309
310	/**
311	* Performs lazy init of our global variables.
312	* @returns IPRT status code.
313	*/
314	DECLINLINE(int) rtDbgModLazyInit(void)
315	{
316	return RTOnce(&g_rtDbgModOnce, rtDbgModInitOnce, NULL);
317	}
318
319
320	RTDECL(int) RTDbgModCreate(PRTDBGMOD phDbgMod, const char *pszName, RTUINTPTR cbSeg, uint32_t fFlags)
321	{
322	/*
323	* Input validation and lazy initialization.
324	*/
325	AssertPtrReturn(phDbgMod, VERR_INVALID_POINTER);
326	*phDbgMod = NIL_RTDBGMOD;
327	AssertPtrReturn(pszName, VERR_INVALID_POINTER);
328	AssertReturn(*pszName, VERR_INVALID_PARAMETER);
329	AssertReturn(fFlags == 0 \|\| fFlags == RTDBGMOD_F_NOT_DEFERRED, VERR_INVALID_PARAMETER);
330
331	int rc = rtDbgModLazyInit();
332	if (RT_FAILURE(rc))
333	return rc;
334
335	/*
336	* Allocate a new module instance.
337	*/
338	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)RTMemAllocZ(sizeof(*pDbgMod));
339	if (!pDbgMod)
340	return VERR_NO_MEMORY;
341	pDbgMod->u32Magic = RTDBGMOD_MAGIC;
342	pDbgMod->cRefs = 1;
343	rc = RTCritSectInit(&pDbgMod->CritSect);
344	if (RT_SUCCESS(rc))
345	{
346	pDbgMod->pszImgFileSpecified = RTStrCacheEnter(g_hDbgModStrCache, pszName);
347	pDbgMod->pszName = RTStrCacheEnterLower(g_hDbgModStrCache, RTPathFilenameEx(pszName, RTPATH_STR_F_STYLE_DOS));
348	if (pDbgMod->pszName)
349	{
350	rc = rtDbgModContainerCreate(pDbgMod, cbSeg);
351	if (RT_SUCCESS(rc))
352	{
353	*phDbgMod = pDbgMod;
354	return rc;
355	}
356	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFile);
357	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszName);
358	}
359	RTCritSectDelete(&pDbgMod->CritSect);
360	}
361
362	RTMemFree(pDbgMod);
363	return rc;
364	}
365	RT_EXPORT_SYMBOL(RTDbgModCreate);
366
367
368	RTDECL(int) RTDbgModCreateFromMap(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName,
369	RTUINTPTR uSubtrahend, RTDBGCFG hDbgCfg)
370	{
371	RT_NOREF_PV(hDbgCfg);
372
373	/*
374	* Input validation and lazy initialization.
375	*/
376	AssertPtrReturn(phDbgMod, VERR_INVALID_POINTER);
377	*phDbgMod = NIL_RTDBGMOD;
378	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
379	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
380	AssertPtrNullReturn(pszName, VERR_INVALID_POINTER);
381	AssertReturn(uSubtrahend == 0, VERR_NOT_IMPLEMENTED); /** @todo implement uSubtrahend. */
382
383	int rc = rtDbgModLazyInit();
384	if (RT_FAILURE(rc))
385	return rc;
386
387	if (!pszName)
388	pszName = RTPathFilenameEx(pszFilename, RTPATH_STR_F_STYLE_DOS);
389
390	/*
391	* Allocate a new module instance.
392	*/
393	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)RTMemAllocZ(sizeof(*pDbgMod));
394	if (!pDbgMod)
395	return VERR_NO_MEMORY;
396	pDbgMod->u32Magic = RTDBGMOD_MAGIC;
397	pDbgMod->cRefs = 1;
398	rc = RTCritSectInit(&pDbgMod->CritSect);
399	if (RT_SUCCESS(rc))
400	{
401	pDbgMod->pszName = RTStrCacheEnterLower(g_hDbgModStrCache, pszName);
402	if (pDbgMod->pszName)
403	{
404	pDbgMod->pszDbgFile = RTStrCacheEnter(g_hDbgModStrCache, pszFilename);
405	if (pDbgMod->pszDbgFile)
406	{
407	/*
408	* Try the map file readers.
409	*/
410	rc = RTSemRWRequestRead(g_hDbgModRWSem, RT_INDEFINITE_WAIT);
411	if (RT_SUCCESS(rc))
412	{
413	rc = VERR_DBG_NO_MATCHING_INTERPRETER;
414	for (PRTDBGMODREGDBG pCur = g_pDbgHead; pCur; pCur = pCur->pNext)
415	{
416	if (pCur->pVt->fSupports & RT_DBGTYPE_MAP)
417	{
418	pDbgMod->pDbgVt = pCur->pVt;
419	pDbgMod->pvDbgPriv = NULL;
420	rc = pCur->pVt->pfnTryOpen(pDbgMod, RTLDRARCH_WHATEVER);
421	if (RT_SUCCESS(rc))
422	{
423	ASMAtomicIncU32(&pCur->cUsers);
424	RTSemRWReleaseRead(g_hDbgModRWSem);
425
426	*phDbgMod = pDbgMod;
427	return rc;
428	}
429	}
430	}
431
432	/* bail out */
433	RTSemRWReleaseRead(g_hDbgModRWSem);
434	}
435	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszName);
436	}
437	else
438	rc = VERR_NO_STR_MEMORY;
439	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszDbgFile);
440	}
441	else
442	rc = VERR_NO_STR_MEMORY;
443	RTCritSectDelete(&pDbgMod->CritSect);
444	}
445
446	RTMemFree(pDbgMod);
447	return rc;
448	}
449	RT_EXPORT_SYMBOL(RTDbgModCreateFromMap);
450
451
452
453	/*
454	*
455	* E x e c u t a b l e I m a g e F i l e s
456	* E x e c u t a b l e I m a g e F i l e s
457	* E x e c u t a b l e I m a g e F i l e s
458	*
459	*/
460
461
462	/**
463	* Opens debug information for an image.
464	*
465	* @returns IPRT status code
466	* @param pDbgMod The debug module structure.
467	*
468	* @note This will generally not look for debug info stored in external
469	* files. rtDbgModFromPeImageExtDbgInfoCallback can help with that.
470	*/
471	static int rtDbgModOpenDebugInfoInsideImage(PRTDBGMODINT pDbgMod)
472	{
473	AssertReturn(!pDbgMod->pDbgVt, VERR_DBG_MOD_IPE);
474	AssertReturn(pDbgMod->pImgVt, VERR_DBG_MOD_IPE);
475
476	int rc = RTSemRWRequestRead(g_hDbgModRWSem, RT_INDEFINITE_WAIT);
477	if (RT_SUCCESS(rc))
478	{
479	for (PRTDBGMODREGDBG pDbg = g_pDbgHead; pDbg; pDbg = pDbg->pNext)
480	{
481	pDbgMod->pDbgVt = pDbg->pVt;
482	pDbgMod->pvDbgPriv = NULL;
483	rc = pDbg->pVt->pfnTryOpen(pDbgMod, pDbgMod->pImgVt->pfnGetArch(pDbgMod));
484	if (RT_SUCCESS(rc))
485	{
486	/*
487	* That's it!
488	*/
489	ASMAtomicIncU32(&pDbg->cUsers);
490	RTSemRWReleaseRead(g_hDbgModRWSem);
491	return VINF_SUCCESS;
492	}
493
494	pDbgMod->pDbgVt = NULL;
495	Assert(pDbgMod->pvDbgPriv == NULL);
496	}
497	RTSemRWReleaseRead(g_hDbgModRWSem);
498	}
499
500	return VERR_DBG_NO_MATCHING_INTERPRETER;
501	}
502
503
504	/** @callback_method_impl{FNRTDBGCFGOPEN} */
505	static DECLCALLBACK(int) rtDbgModExtDbgInfoOpenCallback(RTDBGCFG hDbgCfg, const char pszFilename, void pvUser1, void *pvUser2)
506	{
507	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)pvUser1;
508	PCRTLDRDBGINFO pDbgInfo = (PCRTLDRDBGINFO)pvUser2;
509	RT_NOREF_PV(pDbgInfo); /** @todo consider a more direct search for a interpreter. */
510	RT_NOREF_PV(hDbgCfg);
511
512	Assert(!pDbgMod->pDbgVt);
513	Assert(!pDbgMod->pvDbgPriv);
514	Assert(!pDbgMod->pszDbgFile);
515	Assert(pDbgMod->pImgVt);
516
517	/*
518	* Set the debug file name and try possible interpreters.
519	*/
520	pDbgMod->pszDbgFile = RTStrCacheEnter(g_hDbgModStrCache, pszFilename);
521
522	int rc = RTSemRWRequestRead(g_hDbgModRWSem, RT_INDEFINITE_WAIT);
523	if (RT_SUCCESS(rc))
524	{
525	for (PRTDBGMODREGDBG pDbg = g_pDbgHead; pDbg; pDbg = pDbg->pNext)
526	{
527	pDbgMod->pDbgVt = pDbg->pVt;
528	pDbgMod->pvDbgPriv = NULL;
529	rc = pDbg->pVt->pfnTryOpen(pDbgMod, pDbgMod->pImgVt->pfnGetArch(pDbgMod));
530	if (RT_SUCCESS(rc))
531	{
532	/*
533	* Got it!
534	*/
535	ASMAtomicIncU32(&pDbg->cUsers);
536	RTSemRWReleaseRead(g_hDbgModRWSem);
537	return VINF_CALLBACK_RETURN;
538	}
539
540	pDbgMod->pDbgVt = NULL;
541	Assert(pDbgMod->pvDbgPriv == NULL);
542	}
543	RTSemRWReleaseRead(g_hDbgModRWSem);
544	}
545
546	/* No joy. */
547	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszDbgFile);
548	pDbgMod->pszDbgFile = NULL;
549	return rc;
550	}
551
552
553	/**
554	* Argument package used by rtDbgModOpenDebugInfoExternalToImage.
555	*/
556	typedef struct RTDBGMODOPENDIETI
557	{
558	PRTDBGMODINT pDbgMod;
559	RTDBGCFG hDbgCfg;
560	} RTDBGMODOPENDIETI;
561
562
563	/** @callback_method_impl{FNRTLDRENUMDBG} */
564	static DECLCALLBACK(int)
565	rtDbgModOpenDebugInfoExternalToImageCallback(RTLDRMOD hLdrMod, PCRTLDRDBGINFO pDbgInfo, void *pvUser)
566	{
567	RTDBGMODOPENDIETI pArgs = (RTDBGMODOPENDIETI )pvUser;
568	RT_NOREF_PV(hLdrMod);
569
570	Assert(pDbgInfo->enmType > RTLDRDBGINFOTYPE_INVALID && pDbgInfo->enmType < RTLDRDBGINFOTYPE_END);
571	const char *pszExtFile = pDbgInfo->pszExtFile;
572	if (!pszExtFile)
573	{
574	/*
575	* If a external debug type comes without a file name, calculate a
576	* likely debug filename for it. (Hack for NT4 drivers.)
577	*/
578	const char *pszExt = NULL;
579	if (pDbgInfo->enmType == RTLDRDBGINFOTYPE_CODEVIEW_DBG)
580	pszExt = ".dbg";
581	else if ( pDbgInfo->enmType == RTLDRDBGINFOTYPE_CODEVIEW_PDB20
582	\|\| pDbgInfo->enmType == RTLDRDBGINFOTYPE_CODEVIEW_PDB70)
583	pszExt = ".pdb";
584	if (pszExt && pArgs->pDbgMod->pszName)
585	{
586	size_t cchName = strlen(pArgs->pDbgMod->pszName);
587	char psz = (char )alloca(cchName + strlen(pszExt) + 1);
588	if (psz)
589	{
590	memcpy(psz, pArgs->pDbgMod->pszName, cchName + 1);
591	RTPathStripSuffix(psz);
592	pszExtFile = strcat(psz, pszExt);
593	}
594	}
595
596	if (!pszExtFile)
597	{
598	Log2(("rtDbgModOpenDebugInfoExternalToImageCallback: enmType=%d\n", pDbgInfo->enmType));
599	return VINF_SUCCESS;
600	}
601	}
602
603	/*
604	* Switch on type and call the appropriate search function.
605	*/
606	int rc;
607	switch (pDbgInfo->enmType)
608	{
609	case RTLDRDBGINFOTYPE_CODEVIEW_PDB70:
610	rc = RTDbgCfgOpenPdb70(pArgs->hDbgCfg, pszExtFile,
611	&pDbgInfo->u.Pdb70.Uuid,
612	pDbgInfo->u.Pdb70.uAge,
613	rtDbgModExtDbgInfoOpenCallback, pArgs->pDbgMod, (void *)pDbgInfo);
614	break;
615
616	case RTLDRDBGINFOTYPE_CODEVIEW_PDB20:
617	rc = RTDbgCfgOpenPdb20(pArgs->hDbgCfg, pszExtFile,
618	pDbgInfo->u.Pdb20.cbImage,
619	pDbgInfo->u.Pdb20.uTimestamp,
620	pDbgInfo->u.Pdb20.uAge,
621	rtDbgModExtDbgInfoOpenCallback, pArgs->pDbgMod, (void *)pDbgInfo);
622	break;
623
624	case RTLDRDBGINFOTYPE_CODEVIEW_DBG:
625	rc = RTDbgCfgOpenDbg(pArgs->hDbgCfg, pszExtFile,
626	pDbgInfo->u.Dbg.cbImage,
627	pDbgInfo->u.Dbg.uTimestamp,
628	rtDbgModExtDbgInfoOpenCallback, pArgs->pDbgMod, (void *)pDbgInfo);
629	break;
630
631	case RTLDRDBGINFOTYPE_DWARF_DWO:
632	rc = RTDbgCfgOpenDwo(pArgs->hDbgCfg, pszExtFile,
633	pDbgInfo->u.Dwo.uCrc32,
634	rtDbgModExtDbgInfoOpenCallback, pArgs->pDbgMod, (void *)pDbgInfo);
635	break;
636
637	default:
638	Log(("rtDbgModOpenDebugInfoExternalToImageCallback: Don't know how to handle enmType=%d and pszFileExt=%s\n",
639	pDbgInfo->enmType, pszExtFile));
640	return VERR_DBG_TODO;
641	}
642	if (RT_SUCCESS(rc))
643	{
644	LogFlow(("RTDbgMod: Successfully opened external debug info '%s' for '%s'\n",
645	pArgs->pDbgMod->pszDbgFile, pArgs->pDbgMod->pszImgFile));
646	return VINF_CALLBACK_RETURN;
647	}
648	Log(("rtDbgModOpenDebugInfoExternalToImageCallback: '%s' (enmType=%d) for '%s' -> %Rrc\n",
649	pszExtFile, pDbgInfo->enmType, pArgs->pDbgMod->pszImgFile, rc));
650	return rc;
651	}
652
653
654	/**
655	* Opens debug info listed in the image that is stored in a separate file.
656	*
657	* @returns IPRT status code
658	* @param pDbgMod The debug module.
659	* @param hDbgCfg The debug config. Can be NIL.
660	*/
661	static int rtDbgModOpenDebugInfoExternalToImage(PRTDBGMODINT pDbgMod, RTDBGCFG hDbgCfg)
662	{
663	Assert(!pDbgMod->pDbgVt);
664
665	RTDBGMODOPENDIETI Args;
666	Args.pDbgMod = pDbgMod;
667	Args.hDbgCfg = hDbgCfg;
668	int rc = pDbgMod->pImgVt->pfnEnumDbgInfo(pDbgMod, rtDbgModOpenDebugInfoExternalToImageCallback, &Args);
669	if (RT_SUCCESS(rc) && pDbgMod->pDbgVt)
670	return VINF_SUCCESS;
671
672	LogFlow(("rtDbgModOpenDebugInfoExternalToImage: rc=%Rrc\n", rc));
673	return VERR_NOT_FOUND;
674	}
675
676
677	/** @callback_method_impl{FNRTDBGCFGOPEN} */
678	static DECLCALLBACK(int) rtDbgModExtDbgInfoOpenCallback2(RTDBGCFG hDbgCfg, const char pszFilename, void pvUser1, void *pvUser2)
679	{
680	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)pvUser1;
681	RT_NOREF_PV(pvUser2); /** @todo image matching string or smth. */
682	RT_NOREF_PV(hDbgCfg);
683
684	Assert(!pDbgMod->pDbgVt);
685	Assert(!pDbgMod->pvDbgPriv);
686	Assert(!pDbgMod->pszDbgFile);
687	Assert(pDbgMod->pImgVt);
688
689	/*
690	* Set the debug file name and try possible interpreters.
691	*/
692	pDbgMod->pszDbgFile = RTStrCacheEnter(g_hDbgModStrCache, pszFilename);
693
694	int rc = RTSemRWRequestRead(g_hDbgModRWSem, RT_INDEFINITE_WAIT);
695	if (RT_SUCCESS(rc))
696	{
697	for (PRTDBGMODREGDBG pDbg = g_pDbgHead; pDbg; pDbg = pDbg->pNext)
698	{
699	pDbgMod->pDbgVt = pDbg->pVt;
700	pDbgMod->pvDbgPriv = NULL;
701	rc = pDbg->pVt->pfnTryOpen(pDbgMod, pDbgMod->pImgVt->pfnGetArch(pDbgMod));
702	if (RT_SUCCESS(rc))
703	{
704	/*
705	* Got it!
706	*/
707	ASMAtomicIncU32(&pDbg->cUsers);
708	RTSemRWReleaseRead(g_hDbgModRWSem);
709	return VINF_CALLBACK_RETURN;
710	}
711	pDbgMod->pDbgVt = NULL;
712	Assert(pDbgMod->pvDbgPriv == NULL);
713	}
714	}
715
716	/* No joy. */
717	RTSemRWReleaseRead(g_hDbgModRWSem);
718	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszDbgFile);
719	pDbgMod->pszDbgFile = NULL;
720	return rc;
721	}
722
723
724	/**
725	* Opens external debug info that is not listed in the image.
726	*
727	* @returns IPRT status code
728	* @param pDbgMod The debug module.
729	* @param hDbgCfg The debug config. Can be NIL.
730	*/
731	static int rtDbgModOpenDebugInfoExternalToImage2(PRTDBGMODINT pDbgMod, RTDBGCFG hDbgCfg)
732	{
733	int rc;
734	Assert(!pDbgMod->pDbgVt);
735	Assert(pDbgMod->pImgVt);
736
737	/*
738	* Figure out what to search for based on the image format.
739	*/
740	const char *pszzExts = NULL;
741	RTLDRFMT enmFmt = pDbgMod->pImgVt->pfnGetFormat(pDbgMod);
742	switch (enmFmt)
743	{
744	case RTLDRFMT_MACHO:
745	{
746	RTUUID Uuid;
747	PRTUUID pUuid = &Uuid;
748	rc = pDbgMod->pImgVt->pfnQueryProp(pDbgMod, RTLDRPROP_UUID, &Uuid, sizeof(Uuid));
749	if (RT_FAILURE(rc))
750	pUuid = NULL;
751
752	rc = RTDbgCfgOpenDsymBundle(hDbgCfg, pDbgMod->pszImgFile, pUuid,
753	rtDbgModExtDbgInfoOpenCallback2, pDbgMod, NULL /pvUser2/);
754	if (RT_SUCCESS(rc))
755	return VINF_SUCCESS;
756	break;
757	}
758
759	#if 0 /* Will be links in the image if these apply. .map readers for PE or ELF we don't have. */
760	case RTLDRFMT_ELF:
761	pszzExts = ".debug\0.dwo\0";
762	break;
763	case RTLDRFMT_PE:
764	pszzExts = ".map\0";
765	break;
766	#endif
767	#if 0 /* Haven't implemented .sym or .map file readers for OS/2 yet. */
768	case RTLDRFMT_LX:
769	pszzExts = ".sym\0.map\0";
770	break;
771	#endif
772	default:
773	rc = VERR_NOT_IMPLEMENTED;
774	break;
775	}
776
777	NOREF(pszzExts);
778	#if 0 /* Later */
779	if (pszzExts)
780	{
781
782	}
783	#endif
784
785	LogFlow(("rtDbgModOpenDebugInfoExternalToImage2: rc=%Rrc\n", rc));
786	return VERR_NOT_FOUND;
787	}
788
789
790	RTDECL(int) RTDbgModCreateFromImage(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName,
791	RTLDRARCH enmArch, RTDBGCFG hDbgCfg)
792	{
793	/*
794	* Input validation and lazy initialization.
795	*/
796	AssertPtrReturn(phDbgMod, VERR_INVALID_POINTER);
797	*phDbgMod = NIL_RTDBGMOD;
798	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
799	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
800	AssertPtrNullReturn(pszName, VERR_INVALID_POINTER);
801	AssertReturn(enmArch > RTLDRARCH_INVALID && enmArch < RTLDRARCH_END, VERR_INVALID_PARAMETER);
802
803	int rc = rtDbgModLazyInit();
804	if (RT_FAILURE(rc))
805	return rc;
806
807	if (!pszName)
808	pszName = RTPathFilenameEx(pszFilename, RTPATH_STR_F_STYLE_DOS);
809
810	/*
811	* Allocate a new module instance.
812	*/
813	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)RTMemAllocZ(sizeof(*pDbgMod));
814	if (!pDbgMod)
815	return VERR_NO_MEMORY;
816	pDbgMod->u32Magic = RTDBGMOD_MAGIC;
817	pDbgMod->cRefs = 1;
818	rc = RTCritSectInit(&pDbgMod->CritSect);
819	if (RT_SUCCESS(rc))
820	{
821	pDbgMod->pszName = RTStrCacheEnterLower(g_hDbgModStrCache, pszName);
822	if (pDbgMod->pszName)
823	{
824	pDbgMod->pszImgFile = RTStrCacheEnter(g_hDbgModStrCache, pszFilename);
825	if (pDbgMod->pszImgFile)
826	{
827	RTStrCacheRetain(pDbgMod->pszImgFile);
828	pDbgMod->pszImgFileSpecified = pDbgMod->pszImgFile;
829
830	/*
831	* Find an image reader which groks the file.
832	*/
833	rc = RTSemRWRequestRead(g_hDbgModRWSem, RT_INDEFINITE_WAIT);
834	if (RT_SUCCESS(rc))
835	{
836	rc = VERR_DBG_NO_MATCHING_INTERPRETER;
837	PRTDBGMODREGIMG pImg;
838	for (pImg = g_pImgHead; pImg; pImg = pImg->pNext)
839	{
840	pDbgMod->pImgVt = pImg->pVt;
841	pDbgMod->pvImgPriv = NULL;
842	/** @todo need to specify some arch stuff here. */
843	rc = pImg->pVt->pfnTryOpen(pDbgMod, enmArch);
844	if (RT_SUCCESS(rc))
845	{
846	/*
847	* Image detected, but found no debug info we were
848	* able to understand.
849	*/
850	/** @todo some generic way of matching image and debug info, flexible signature
851	* of some kind. Apple uses UUIDs, microsoft uses a UUID+age or a
852	* size+timestamp, and GNU a CRC32 (last time I checked). */
853	rc = rtDbgModOpenDebugInfoExternalToImage(pDbgMod, hDbgCfg);
854	if (RT_FAILURE(rc))
855	rc = rtDbgModOpenDebugInfoInsideImage(pDbgMod);
856	if (RT_FAILURE(rc))
857	rc = rtDbgModOpenDebugInfoExternalToImage2(pDbgMod, hDbgCfg);
858	if (RT_FAILURE(rc))
859	rc = rtDbgModCreateForExports(pDbgMod);
860	if (RT_SUCCESS(rc))
861	{
862	/*
863	* We're done!
864	*/
865	ASMAtomicIncU32(&pImg->cUsers);
866	RTSemRWReleaseRead(g_hDbgModRWSem);
867
868	*phDbgMod = pDbgMod;
869	return VINF_SUCCESS;
870	}
871
872	/* Failed, close up the shop. */
873	pDbgMod->pImgVt->pfnClose(pDbgMod);
874	pDbgMod->pImgVt = NULL;
875	pDbgMod->pvImgPriv = NULL;
876	break;
877	}
878	}
879
880	/*
881	* Could it be a file containing raw debug info?
882	*/
883	if (!pImg)
884	{
885	pDbgMod->pImgVt = NULL;
886	pDbgMod->pvImgPriv = NULL;
887	pDbgMod->pszDbgFile = pDbgMod->pszImgFile;
888	pDbgMod->pszImgFile = NULL;
889
890	for (PRTDBGMODREGDBG pDbg = g_pDbgHead; pDbg; pDbg = pDbg->pNext)
891	{
892	pDbgMod->pDbgVt = pDbg->pVt;
893	pDbgMod->pvDbgPriv = NULL;
894	rc = pDbg->pVt->pfnTryOpen(pDbgMod, enmArch);
895	if (RT_SUCCESS(rc))
896	{
897	/*
898	* That's it!
899	*/
900	ASMAtomicIncU32(&pDbg->cUsers);
901	RTSemRWReleaseRead(g_hDbgModRWSem);
902
903	*phDbgMod = pDbgMod;
904	return rc;
905	}
906	}
907
908	pDbgMod->pszImgFile = pDbgMod->pszDbgFile;
909	pDbgMod->pszDbgFile = NULL;
910	}
911
912	/* bail out */
913	RTSemRWReleaseRead(g_hDbgModRWSem);
914	}
915	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFileSpecified);
916	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFile);
917	}
918	else
919	rc = VERR_NO_STR_MEMORY;
920	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszName);
921	}
922	else
923	rc = VERR_NO_STR_MEMORY;
924	RTCritSectDelete(&pDbgMod->CritSect);
925	}
926
927	RTMemFree(pDbgMod);
928	return rc;
929	}
930	RT_EXPORT_SYMBOL(RTDbgModCreateFromImage);
931
932
933
934
935
936	/*
937	*
938	* P E I M A G E
939	* P E I M A G E
940	* P E I M A G E
941	*
942	*/
943
944
945
946	/** @callback_method_impl{FNRTDBGCFGOPEN} */
947	static DECLCALLBACK(int) rtDbgModFromPeImageOpenCallback(RTDBGCFG hDbgCfg, const char pszFilename, void pvUser1, void *pvUser2)
948	{
949	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)pvUser1;
950	PRTDBGMODDEFERRED pDeferred = (PRTDBGMODDEFERRED)pvUser2;
951	LogFlow(("rtDbgModFromPeImageOpenCallback: %s\n", pszFilename));
952	RT_NOREF_PV(hDbgCfg);
953
954	Assert(pDbgMod->pImgVt == NULL);
955	Assert(pDbgMod->pvImgPriv == NULL);
956	Assert(pDbgMod->pDbgVt == NULL);
957	Assert(pDbgMod->pvDbgPriv == NULL);
958
959	/*
960	* Replace the image file name while probing it.
961	*/
962	const char *pszNewImgFile = RTStrCacheEnter(g_hDbgModStrCache, pszFilename);
963	if (!pszNewImgFile)
964	return VERR_NO_STR_MEMORY;
965	const char *pszOldImgFile = pDbgMod->pszImgFile;
966	pDbgMod->pszImgFile = pszNewImgFile;
967
968	/*
969	* Find an image reader which groks the file.
970	*/
971	int rc = RTSemRWRequestRead(g_hDbgModRWSem, RT_INDEFINITE_WAIT);
972	if (RT_SUCCESS(rc))
973	{
974	rc = VERR_DBG_NO_MATCHING_INTERPRETER;
975	PRTDBGMODREGIMG pImg;
976	for (pImg = g_pImgHead; pImg; pImg = pImg->pNext)
977	{
978	pDbgMod->pImgVt = pImg->pVt;
979	pDbgMod->pvImgPriv = NULL;
980	rc = pImg->pVt->pfnTryOpen(pDbgMod, RTLDRARCH_WHATEVER);
981	if (RT_SUCCESS(rc))
982	break;
983	pDbgMod->pImgVt = NULL;
984	Assert(pDbgMod->pvImgPriv == NULL);
985	}
986	RTSemRWReleaseRead(g_hDbgModRWSem);
987	if (RT_SUCCESS(rc))
988	{
989	/*
990	* Check the deferred info.
991	*/
992	RTUINTPTR cbImage = pDbgMod->pImgVt->pfnImageSize(pDbgMod);
993	if ( pDeferred->cbImage == 0
994	\|\| pDeferred->cbImage == cbImage)
995	{
996	uint32_t uTimestamp = pDeferred->u.PeImage.uTimestamp; /** @todo add method for getting the timestamp. */
997	if ( pDeferred->u.PeImage.uTimestamp == 0
998	\|\| pDeferred->u.PeImage.uTimestamp == uTimestamp)
999	{
1000	Log(("RTDbgMod: Found matching PE image '%s'\n", pszFilename));
1001
1002	/*
1003	* We found the executable image we need, now go find any
1004	* debug info associated with it. For PE images, this is
1005	* generally found in an external file, so we do a sweep
1006	* for that first.
1007	*
1008	* Then try open debug inside the module, and finally
1009	* falling back on exports.
1010	*/
1011	rc = rtDbgModOpenDebugInfoExternalToImage(pDbgMod, pDeferred->hDbgCfg);
1012	if (RT_FAILURE(rc))
1013	rc = rtDbgModOpenDebugInfoInsideImage(pDbgMod);
1014	if (RT_FAILURE(rc))
1015	rc = rtDbgModCreateForExports(pDbgMod);
1016	if (RT_SUCCESS(rc))
1017	{
1018	RTStrCacheRelease(g_hDbgModStrCache, pszOldImgFile);
1019	return VINF_CALLBACK_RETURN;
1020	}
1021
1022	/* Something bad happened, just give up. */
1023	Log(("rtDbgModFromPeImageOpenCallback: rtDbgModCreateForExports failed: %Rrc\n", rc));
1024	}
1025	else
1026	{
1027	LogFlow(("rtDbgModFromPeImageOpenCallback: uTimestamp mismatch (found %#x, expected %#x) - %s\n",
1028	uTimestamp, pDeferred->u.PeImage.uTimestamp, pszFilename));
1029	rc = VERR_DBG_FILE_MISMATCH;
1030	}
1031	}
1032	else
1033	{
1034	LogFlow(("rtDbgModFromPeImageOpenCallback: cbImage mismatch (found %#x, expected %#x) - %s\n",
1035	cbImage, pDeferred->cbImage, pszFilename));
1036	rc = VERR_DBG_FILE_MISMATCH;
1037	}
1038
1039	pDbgMod->pImgVt->pfnClose(pDbgMod);
1040	pDbgMod->pImgVt = NULL;
1041	pDbgMod->pvImgPriv = NULL;
1042	}
1043	else
1044	LogFlow(("rtDbgModFromPeImageOpenCallback: Failed %Rrc - %s\n", rc, pszFilename));
1045	}
1046
1047	/* Restore image name. */
1048	pDbgMod->pszImgFile = pszOldImgFile;
1049	RTStrCacheRelease(g_hDbgModStrCache, pszNewImgFile);
1050	return rc;
1051	}
1052
1053
1054	/** @callback_method_impl{FNRTDBGMODDEFERRED} */
1055	static DECLCALLBACK(int) rtDbgModFromPeImageDeferredCallback(PRTDBGMODINT pDbgMod, PRTDBGMODDEFERRED pDeferred)
1056	{
1057	int rc;
1058
1059	Assert(pDbgMod->pszImgFile);
1060	if (!pDbgMod->pImgVt)
1061	rc = RTDbgCfgOpenPeImage(pDeferred->hDbgCfg, pDbgMod->pszImgFile,
1062	pDeferred->cbImage, pDeferred->u.PeImage.uTimestamp,
1063	rtDbgModFromPeImageOpenCallback, pDbgMod, pDeferred);
1064	else
1065	{
1066	rc = rtDbgModOpenDebugInfoExternalToImage(pDbgMod, pDeferred->hDbgCfg);
1067	if (RT_FAILURE(rc))
1068	rc = rtDbgModOpenDebugInfoInsideImage(pDbgMod);
1069	if (RT_FAILURE(rc))
1070	rc = rtDbgModCreateForExports(pDbgMod);
1071	}
1072	return rc;
1073	}
1074
1075
1076	RTDECL(int) RTDbgModCreateFromPeImage(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName, RTLDRMOD hLdrMod,
1077	uint32_t cbImage, uint32_t uTimestamp, RTDBGCFG hDbgCfg)
1078	{
1079	/*
1080	* Input validation and lazy initialization.
1081	*/
1082	AssertPtrReturn(phDbgMod, VERR_INVALID_POINTER);
1083	*phDbgMod = NIL_RTDBGMOD;
1084	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1085	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
1086	if (!pszName)
1087	pszName = RTPathFilenameEx(pszFilename, RTPATH_STR_F_STYLE_DOS);
1088	AssertPtrReturn(pszName, VERR_INVALID_POINTER);
1089	AssertReturn(hLdrMod == NIL_RTLDRMOD \|\| RTLdrSize(hLdrMod) != ~(size_t)0, VERR_INVALID_HANDLE);
1090
1091	int rc = rtDbgModLazyInit();
1092	if (RT_FAILURE(rc))
1093	return rc;
1094
1095	uint64_t fDbgCfg = 0;
1096	if (hDbgCfg)
1097	{
1098	rc = RTDbgCfgQueryUInt(hDbgCfg, RTDBGCFGPROP_FLAGS, &fDbgCfg);
1099	AssertRCReturn(rc, rc);
1100	}
1101
1102	/*
1103	* Allocate a new module instance.
1104	*/
1105	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)RTMemAllocZ(sizeof(*pDbgMod));
1106	if (!pDbgMod)
1107	return VERR_NO_MEMORY;
1108	pDbgMod->u32Magic = RTDBGMOD_MAGIC;
1109	pDbgMod->cRefs = 1;
1110	rc = RTCritSectInit(&pDbgMod->CritSect);
1111	if (RT_SUCCESS(rc))
1112	{
1113	pDbgMod->pszName = RTStrCacheEnterLower(g_hDbgModStrCache, pszName);
1114	if (pDbgMod->pszName)
1115	{
1116	pDbgMod->pszImgFile = RTStrCacheEnter(g_hDbgModStrCache, pszFilename);
1117	if (pDbgMod->pszImgFile)
1118	{
1119	RTStrCacheRetain(pDbgMod->pszImgFile);
1120	pDbgMod->pszImgFileSpecified = pDbgMod->pszImgFile;
1121
1122	/*
1123	* If we have a loader module, we must instantiate the loader
1124	* side of things regardless of the deferred setting.
1125	*/
1126	if (hLdrMod != NIL_RTLDRMOD)
1127	{
1128	if (!cbImage)
1129	cbImage = (uint32_t)RTLdrSize(hLdrMod);
1130	pDbgMod->pImgVt = &g_rtDbgModVtImgLdr;
1131
1132	rc = rtDbgModLdrOpenFromHandle(pDbgMod, hLdrMod);
1133	}
1134	if (RT_SUCCESS(rc))
1135	{
1136	/*
1137	* Do it now or procrastinate?
1138	*/
1139	if (!(fDbgCfg & RTDBGCFG_FLAGS_DEFERRED) \|\| !cbImage)
1140	{
1141	RTDBGMODDEFERRED Deferred;
1142	Deferred.cbImage = cbImage;
1143	Deferred.hDbgCfg = hDbgCfg;
1144	Deferred.u.PeImage.uTimestamp = uTimestamp;
1145	rc = rtDbgModFromPeImageDeferredCallback(pDbgMod, &Deferred);
1146	}
1147	else
1148	{
1149	PRTDBGMODDEFERRED pDeferred;
1150	rc = rtDbgModDeferredCreate(pDbgMod, rtDbgModFromPeImageDeferredCallback, cbImage, hDbgCfg, 0,
1151	&pDeferred);
1152	if (RT_SUCCESS(rc))
1153	pDeferred->u.PeImage.uTimestamp = uTimestamp;
1154	}
1155	if (RT_SUCCESS(rc))
1156	{
1157	*phDbgMod = pDbgMod;
1158	return VINF_SUCCESS;
1159	}
1160
1161	/* Failed, bail out. */
1162	if (hLdrMod != NIL_RTLDRMOD)
1163	{
1164	Assert(pDbgMod->pImgVt);
1165	pDbgMod->pImgVt->pfnClose(pDbgMod);
1166	}
1167	}
1168	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszName);
1169	}
1170	else
1171	rc = VERR_NO_STR_MEMORY;
1172	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFileSpecified);
1173	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFile);
1174	}
1175	else
1176	rc = VERR_NO_STR_MEMORY;
1177	RTCritSectDelete(&pDbgMod->CritSect);
1178	}
1179
1180	RTMemFree(pDbgMod);
1181	return rc;
1182	}
1183	RT_EXPORT_SYMBOL(RTDbgModCreateFromPeImage);
1184
1185
1186
1187
1188	/*
1189	*
1190	* M a c h - O I M A G E
1191	* M a c h - O I M A G E
1192	* M a c h - O I M A G E
1193	*
1194	*/
1195
1196
1197	/**
1198	* Argument package used when opening Mach-O images and .dSYMs files.
1199	*/
1200	typedef struct RTDBGMODMACHOARGS
1201	{
1202	/** For use more internal use in file locator callbacks. */
1203	RTLDRARCH enmArch;
1204	/** For use more internal use in file locator callbacks. */
1205	PCRTUUID pUuid;
1206	/** For use more internal use in file locator callbacks. */
1207	bool fOpenImage;
1208	} RTDBGMODMACHOARGS;
1209	/** Pointer to a const segment package. */
1210	typedef RTDBGMODMACHOARGS const *PCRTDBGMODMACHOARGS;
1211
1212
1213
1214	/** @callback_method_impl{FNRTDBGCFGOPEN} */
1215	static DECLCALLBACK(int)
1216	rtDbgModFromMachOImageOpenDsymMachOCallback(RTDBGCFG hDbgCfg, const char pszFilename, void pvUser1, void *pvUser2)
1217	{
1218	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)pvUser1;
1219	PCRTDBGMODMACHOARGS pArgs = (PCRTDBGMODMACHOARGS)pvUser2;
1220	RT_NOREF_PV(hDbgCfg);
1221
1222	Assert(!pDbgMod->pDbgVt);
1223	Assert(!pDbgMod->pvDbgPriv);
1224	Assert(!pDbgMod->pszDbgFile);
1225	Assert(!pDbgMod->pImgVt);
1226	Assert(!pDbgMod->pvDbgPriv);
1227	Assert(pDbgMod->pszImgFile);
1228	Assert(pDbgMod->pszImgFileSpecified);
1229
1230	const char *pszImgFileOrg = pDbgMod->pszImgFile;
1231	pDbgMod->pszImgFile = RTStrCacheEnter(g_hDbgModStrCache, pszFilename);
1232	if (!pDbgMod->pszImgFile)
1233	return VERR_NO_STR_MEMORY;
1234	RTStrCacheRetain(pDbgMod->pszImgFile);
1235	pDbgMod->pszDbgFile = pDbgMod->pszImgFile;
1236
1237	/*
1238	* Try image interpreters as the dwarf file inside the dSYM bundle is a
1239	* Mach-O file with dwarf debug sections insides it and no code or data.
1240	*/
1241	int rc = RTSemRWRequestRead(g_hDbgModRWSem, RT_INDEFINITE_WAIT);
1242	if (RT_SUCCESS(rc))
1243	{
1244	rc = VERR_DBG_NO_MATCHING_INTERPRETER;
1245	PRTDBGMODREGIMG pImg;
1246	for (pImg = g_pImgHead; pImg; pImg = pImg->pNext)
1247	{
1248	pDbgMod->pImgVt = pImg->pVt;
1249	pDbgMod->pvImgPriv = NULL;
1250	rc = pImg->pVt->pfnTryOpen(pDbgMod, pArgs->enmArch);
1251	if (RT_SUCCESS(rc))
1252	break;
1253	pDbgMod->pImgVt = NULL;
1254	Assert(pDbgMod->pvImgPriv == NULL);
1255	}
1256
1257	if (RT_SUCCESS(rc))
1258	{
1259	/*
1260	* Check the UUID if one was given.
1261	*/
1262	if (pArgs->pUuid)
1263	{
1264	RTUUID UuidOpened;
1265	rc = pDbgMod->pImgVt->pfnQueryProp(pDbgMod, RTLDRPROP_UUID, &UuidOpened, sizeof(UuidOpened));
1266	if (RT_SUCCESS(rc))
1267	{
1268	if (RTUuidCompare(&UuidOpened, pArgs->pUuid) != 0)
1269	rc = VERR_DBG_FILE_MISMATCH;
1270	}
1271	else if (rc == VERR_NOT_FOUND \|\| rc == VERR_NOT_IMPLEMENTED)
1272	rc = VERR_DBG_FILE_MISMATCH;
1273	}
1274	if (RT_SUCCESS(rc))
1275	{
1276	/*
1277	* Pass it to the DWARF reader(s). Careful to restrict this or
1278	* the dbghelp wrapper may end up being overly helpful.
1279	*/
1280	for (PRTDBGMODREGDBG pDbg = g_pDbgHead; pDbg; pDbg = pDbg->pNext)
1281	{
1282	if (pDbg->pVt->fSupports & (RT_DBGTYPE_DWARF \| RT_DBGTYPE_STABS \| RT_DBGTYPE_WATCOM))
1283
1284	{
1285	pDbgMod->pDbgVt = pDbg->pVt;
1286	pDbgMod->pvDbgPriv = NULL;
1287	rc = pDbg->pVt->pfnTryOpen(pDbgMod, pDbgMod->pImgVt->pfnGetArch(pDbgMod));
1288	if (RT_SUCCESS(rc))
1289	{
1290	/*
1291	* Got it!
1292	*/
1293	ASMAtomicIncU32(&pDbg->cUsers);
1294	RTSemRWReleaseRead(g_hDbgModRWSem);
1295	RTStrCacheRelease(g_hDbgModStrCache, pszImgFileOrg);
1296	return VINF_CALLBACK_RETURN;
1297	}
1298	pDbgMod->pDbgVt = NULL;
1299	Assert(pDbgMod->pvDbgPriv == NULL);
1300	}
1301	}
1302
1303	/*
1304	* Likely fallback for when opening image.
1305	*/
1306	if (pArgs->fOpenImage)
1307	{
1308	rc = rtDbgModCreateForExports(pDbgMod);
1309	if (RT_SUCCESS(rc))
1310	{
1311	/*
1312	* Done.
1313	*/
1314	RTSemRWReleaseRead(g_hDbgModRWSem);
1315	RTStrCacheRelease(g_hDbgModStrCache, pszImgFileOrg);
1316	return VINF_CALLBACK_RETURN;
1317	}
1318	}
1319	}
1320
1321	pDbgMod->pImgVt->pfnClose(pDbgMod);
1322	pDbgMod->pImgVt = NULL;
1323	pDbgMod->pvImgPriv = NULL;
1324	}
1325	}
1326
1327	/* No joy. */
1328	RTSemRWReleaseRead(g_hDbgModRWSem);
1329	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFile);
1330	pDbgMod->pszImgFile = pszImgFileOrg;
1331	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszDbgFile);
1332	pDbgMod->pszDbgFile = NULL;
1333	return rc;
1334	}
1335
1336
1337	static int rtDbgModFromMachOImageWorker(PRTDBGMODINT pDbgMod, RTLDRARCH enmArch, uint32_t cbImage,
1338	uint32_t cSegs, PCRTDBGSEGMENT paSegs, PCRTUUID pUuid, RTDBGCFG hDbgCfg)
1339	{
1340	RT_NOREF_PV(cbImage); RT_NOREF_PV(cSegs); RT_NOREF_PV(paSegs);
1341
1342	RTDBGMODMACHOARGS Args;
1343	Args.enmArch = enmArch;
1344	Args.pUuid = pUuid && RTUuidIsNull(pUuid) ? pUuid : NULL;
1345	Args.fOpenImage = false;
1346
1347	/*
1348	* Search for the .dSYM bundle first, since that's generally all we need.
1349	*/
1350	int rc = RTDbgCfgOpenDsymBundle(hDbgCfg, pDbgMod->pszImgFile, pUuid,
1351	rtDbgModFromMachOImageOpenDsymMachOCallback, pDbgMod, &Args);
1352	if (RT_FAILURE(rc))
1353	{
1354	/*
1355	* If we cannot get at the .dSYM, try the executable image.
1356	*/
1357	Args.fOpenImage = true;
1358	rc = RTDbgCfgOpenMachOImage(hDbgCfg, pDbgMod->pszImgFile, pUuid,
1359	rtDbgModFromMachOImageOpenDsymMachOCallback, pDbgMod, &Args);
1360	}
1361	return rc;
1362	}
1363
1364
1365	/** @callback_method_impl{FNRTDBGMODDEFERRED} */
1366	static DECLCALLBACK(int) rtDbgModFromMachOImageDeferredCallback(PRTDBGMODINT pDbgMod, PRTDBGMODDEFERRED pDeferred)
1367	{
1368	return rtDbgModFromMachOImageWorker(pDbgMod, pDeferred->u.MachO.enmArch, pDeferred->cbImage,
1369	pDeferred->u.MachO.cSegs, pDeferred->u.MachO.aSegs,
1370	&pDeferred->u.MachO.Uuid, pDeferred->hDbgCfg);
1371	}
1372
1373
1374	RTDECL(int) RTDbgModCreateFromMachOImage(PRTDBGMOD phDbgMod, const char pszFilename, const char pszName,
1375	RTLDRARCH enmArch, uint32_t cbImage, uint32_t cSegs, PCRTDBGSEGMENT paSegs,
1376	PCRTUUID pUuid, RTDBGCFG hDbgCfg, uint32_t fFlags)
1377	{
1378	/*
1379	* Input validation and lazy initialization.
1380	*/
1381	AssertPtrReturn(phDbgMod, VERR_INVALID_POINTER);
1382	*phDbgMod = NIL_RTDBGMOD;
1383	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1384	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
1385	if (!pszName)
1386	pszName = RTPathFilenameEx(pszFilename, RTPATH_STR_F_STYLE_HOST);
1387	AssertPtrReturn(pszName, VERR_INVALID_POINTER);
1388	if (cSegs)
1389	{
1390	AssertReturn(cSegs < 1024, VERR_INVALID_PARAMETER);
1391	AssertPtrReturn(paSegs, VERR_INVALID_POINTER);
1392	AssertReturn(!cbImage, VERR_INVALID_PARAMETER);
1393	}
1394	AssertReturn(cbImage \|\| cSegs, VERR_INVALID_PARAMETER);
1395	AssertPtrNullReturn(pUuid, VERR_INVALID_POINTER);
1396	AssertReturn(!(fFlags & ~(RTDBGMOD_F_NOT_DEFERRED)), VERR_INVALID_PARAMETER);
1397
1398	int rc = rtDbgModLazyInit();
1399	if (RT_FAILURE(rc))
1400	return rc;
1401
1402	uint64_t fDbgCfg = 0;
1403	if (hDbgCfg)
1404	{
1405	rc = RTDbgCfgQueryUInt(hDbgCfg, RTDBGCFGPROP_FLAGS, &fDbgCfg);
1406	AssertRCReturn(rc, rc);
1407	}
1408
1409	/*
1410	* Allocate a new module instance.
1411	*/
1412	PRTDBGMODINT pDbgMod = (PRTDBGMODINT)RTMemAllocZ(sizeof(*pDbgMod));
1413	if (!pDbgMod)
1414	return VERR_NO_MEMORY;
1415	pDbgMod->u32Magic = RTDBGMOD_MAGIC;
1416	pDbgMod->cRefs = 1;
1417	rc = RTCritSectInit(&pDbgMod->CritSect);
1418	if (RT_SUCCESS(rc))
1419	{
1420	pDbgMod->pszName = RTStrCacheEnterLower(g_hDbgModStrCache, pszName);
1421	if (pDbgMod->pszName)
1422	{
1423	pDbgMod->pszImgFile = RTStrCacheEnter(g_hDbgModStrCache, pszFilename);
1424	if (pDbgMod->pszImgFile)
1425	{
1426	RTStrCacheRetain(pDbgMod->pszImgFile);
1427	pDbgMod->pszImgFileSpecified = pDbgMod->pszImgFile;
1428
1429	/*
1430	* Load it immediately?
1431	*/
1432	if ( !(fDbgCfg & RTDBGCFG_FLAGS_DEFERRED)
1433	\|\| cSegs /* for the time being. */
1434	\|\| (!cbImage && !cSegs)
1435	\|\| (fFlags & RTDBGMOD_F_NOT_DEFERRED) )
1436	rc = rtDbgModFromMachOImageWorker(pDbgMod, enmArch, cbImage, cSegs, paSegs, pUuid, hDbgCfg);
1437	else
1438	{
1439	/*
1440	* Procrastinate. Need image size atm.
1441	*/
1442	PRTDBGMODDEFERRED pDeferred;
1443	rc = rtDbgModDeferredCreate(pDbgMod, rtDbgModFromMachOImageDeferredCallback, cbImage, hDbgCfg,
1444	RT_OFFSETOF(RTDBGMODDEFERRED, u.MachO.aSegs[cSegs]),
1445	&pDeferred);
1446	if (RT_SUCCESS(rc))
1447	{
1448	pDeferred->u.MachO.Uuid = *pUuid;
1449	pDeferred->u.MachO.enmArch = enmArch;
1450	pDeferred->u.MachO.cSegs = cSegs;
1451	if (cSegs)
1452	memcpy(&pDeferred->u.MachO.aSegs, paSegs, cSegs * sizeof(paSegs[0]));
1453	}
1454	}
1455	if (RT_SUCCESS(rc))
1456	{
1457	*phDbgMod = pDbgMod;
1458	return VINF_SUCCESS;
1459	}
1460
1461	/* Failed, bail out. */
1462	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszName);
1463	}
1464	else
1465	rc = VERR_NO_STR_MEMORY;
1466	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFileSpecified);
1467	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFile);
1468	}
1469	else
1470	rc = VERR_NO_STR_MEMORY;
1471	RTCritSectDelete(&pDbgMod->CritSect);
1472	}
1473
1474	RTMemFree(pDbgMod);
1475	return rc;
1476	}
1477
1478
1479
1480	RT_EXPORT_SYMBOL(RTDbgModCreateFromMachOImage);
1481
1482
1483
1484	/**
1485	* Destroys an module after the reference count has reached zero.
1486	*
1487	* @param pDbgMod The module instance.
1488	*/
1489	static void rtDbgModDestroy(PRTDBGMODINT pDbgMod)
1490	{
1491	/*
1492	* Close the debug info interpreter first, then the image interpret.
1493	*/
1494	RTCritSectEnter(&pDbgMod->CritSect); /* paranoia */
1495
1496	if (pDbgMod->pDbgVt)
1497	{
1498	pDbgMod->pDbgVt->pfnClose(pDbgMod);
1499	pDbgMod->pDbgVt = NULL;
1500	pDbgMod->pvDbgPriv = NULL;
1501	}
1502
1503	if (pDbgMod->pImgVt)
1504	{
1505	pDbgMod->pImgVt->pfnClose(pDbgMod);
1506	pDbgMod->pImgVt = NULL;
1507	pDbgMod->pvImgPriv = NULL;
1508	}
1509
1510	/*
1511	* Free the resources.
1512	*/
1513	ASMAtomicWriteU32(&pDbgMod->u32Magic, ~RTDBGMOD_MAGIC);
1514	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszName);
1515	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFile);
1516	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszImgFileSpecified);
1517	RTStrCacheRelease(g_hDbgModStrCache, pDbgMod->pszDbgFile);
1518	RTCritSectLeave(&pDbgMod->CritSect); /* paranoia */
1519	RTCritSectDelete(&pDbgMod->CritSect);
1520	RTMemFree(pDbgMod);
1521	}
1522
1523
1524	RTDECL(uint32_t) RTDbgModRetain(RTDBGMOD hDbgMod)
1525	{
1526	PRTDBGMODINT pDbgMod = hDbgMod;
1527	RTDBGMOD_VALID_RETURN_RC(pDbgMod, UINT32_MAX);
1528	return ASMAtomicIncU32(&pDbgMod->cRefs);
1529	}
1530	RT_EXPORT_SYMBOL(RTDbgModRetain);
1531
1532
1533	RTDECL(uint32_t) RTDbgModRelease(RTDBGMOD hDbgMod)
1534	{
1535	if (hDbgMod == NIL_RTDBGMOD)
1536	return 0;
1537	PRTDBGMODINT pDbgMod = hDbgMod;
1538	RTDBGMOD_VALID_RETURN_RC(pDbgMod, UINT32_MAX);
1539
1540	uint32_t cRefs = ASMAtomicDecU32(&pDbgMod->cRefs);
1541	if (!cRefs)
1542	rtDbgModDestroy(pDbgMod);
1543	return cRefs;
1544	}
1545	RT_EXPORT_SYMBOL(RTDbgModRelease);
1546
1547
1548	RTDECL(const char *) RTDbgModName(RTDBGMOD hDbgMod)
1549	{
1550	PRTDBGMODINT pDbgMod = hDbgMod;
1551	RTDBGMOD_VALID_RETURN_RC(pDbgMod, NULL);
1552	return pDbgMod->pszName;
1553	}
1554	RT_EXPORT_SYMBOL(RTDbgModName);
1555
1556
1557	RTDECL(const char *) RTDbgModDebugFile(RTDBGMOD hDbgMod)
1558	{
1559	PRTDBGMODINT pDbgMod = hDbgMod;
1560	RTDBGMOD_VALID_RETURN_RC(pDbgMod, NULL);
1561	if (pDbgMod->fDeferred \|\| pDbgMod->fExports)
1562	return NULL;
1563	return pDbgMod->pszDbgFile;
1564	}
1565	RT_EXPORT_SYMBOL(RTDbgModDebugFile);
1566
1567
1568	RTDECL(const char *) RTDbgModImageFile(RTDBGMOD hDbgMod)
1569	{
1570	PRTDBGMODINT pDbgMod = hDbgMod;
1571	RTDBGMOD_VALID_RETURN_RC(pDbgMod, NULL);
1572	return pDbgMod->pszImgFileSpecified;
1573	}
1574	RT_EXPORT_SYMBOL(RTDbgModImageFile);
1575
1576
1577	RTDECL(const char *) RTDbgModImageFileUsed(RTDBGMOD hDbgMod)
1578	{
1579	PRTDBGMODINT pDbgMod = hDbgMod;
1580	RTDBGMOD_VALID_RETURN_RC(pDbgMod, NULL);
1581	return pDbgMod->pszImgFile == pDbgMod->pszImgFileSpecified ? NULL : pDbgMod->pszImgFile;
1582	}
1583	RT_EXPORT_SYMBOL(RTDbgModImageFileUsed);
1584
1585
1586	RTDECL(bool) RTDbgModIsDeferred(RTDBGMOD hDbgMod)
1587	{
1588	PRTDBGMODINT pDbgMod = hDbgMod;
1589	RTDBGMOD_VALID_RETURN_RC(pDbgMod, false);
1590	return pDbgMod->fDeferred;
1591	}
1592
1593
1594	RTDECL(bool) RTDbgModIsExports(RTDBGMOD hDbgMod)
1595	{
1596	PRTDBGMODINT pDbgMod = hDbgMod;
1597	RTDBGMOD_VALID_RETURN_RC(pDbgMod, false);
1598	return pDbgMod->fExports;
1599	}
1600
1601
1602	RTDECL(int) RTDbgModRemoveAll(RTDBGMOD hDbgMod, bool fLeaveSegments)
1603	{
1604	PRTDBGMODINT pDbgMod = hDbgMod;
1605	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1606
1607	RTDBGMOD_LOCK(pDbgMod);
1608
1609	/* Only possible on container modules. */
1610	int rc = VINF_SUCCESS;
1611	if (pDbgMod->pDbgVt != &g_rtDbgModVtDbgContainer)
1612	{
1613	if (fLeaveSegments)
1614	{
1615	rc = rtDbgModContainer_LineRemoveAll(pDbgMod);
1616	if (RT_SUCCESS(rc))
1617	rc = rtDbgModContainer_SymbolRemoveAll(pDbgMod);
1618	}
1619	else
1620	rc = rtDbgModContainer_RemoveAll(pDbgMod);
1621	}
1622	else
1623	rc = VERR_ACCESS_DENIED;
1624
1625	RTDBGMOD_UNLOCK(pDbgMod);
1626	return rc;
1627	}
1628
1629
1630	RTDECL(RTDBGSEGIDX) RTDbgModRvaToSegOff(RTDBGMOD hDbgMod, RTUINTPTR uRva, PRTUINTPTR poffSeg)
1631	{
1632	PRTDBGMODINT pDbgMod = hDbgMod;
1633	RTDBGMOD_VALID_RETURN_RC(pDbgMod, NIL_RTDBGSEGIDX);
1634	RTDBGMOD_LOCK(pDbgMod);
1635
1636	RTDBGSEGIDX iSeg = pDbgMod->pDbgVt->pfnRvaToSegOff(pDbgMod, uRva, poffSeg);
1637
1638	RTDBGMOD_UNLOCK(pDbgMod);
1639	return iSeg;
1640	}
1641	RT_EXPORT_SYMBOL(RTDbgModRvaToSegOff);
1642
1643
1644	RTDECL(RTUINTPTR) RTDbgModImageSize(RTDBGMOD hDbgMod)
1645	{
1646	PRTDBGMODINT pDbgMod = hDbgMod;
1647	RTDBGMOD_VALID_RETURN_RC(pDbgMod, RTUINTPTR_MAX);
1648	RTDBGMOD_LOCK(pDbgMod);
1649
1650	RTUINTPTR cbImage = pDbgMod->pDbgVt->pfnImageSize(pDbgMod);
1651
1652	RTDBGMOD_UNLOCK(pDbgMod);
1653	return cbImage;
1654	}
1655	RT_EXPORT_SYMBOL(RTDbgModImageSize);
1656
1657
1658	RTDECL(uint64_t) RTDbgModGetTag(RTDBGMOD hDbgMod)
1659	{
1660	PRTDBGMODINT pDbgMod = hDbgMod;
1661	RTDBGMOD_VALID_RETURN_RC(pDbgMod, 0);
1662	return pDbgMod->uTag;
1663	}
1664	RT_EXPORT_SYMBOL(RTDbgModGetTag);
1665
1666
1667	RTDECL(int) RTDbgModSetTag(RTDBGMOD hDbgMod, uint64_t uTag)
1668	{
1669	PRTDBGMODINT pDbgMod = hDbgMod;
1670	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1671	RTDBGMOD_LOCK(pDbgMod);
1672
1673	pDbgMod->uTag = uTag;
1674
1675	RTDBGMOD_UNLOCK(pDbgMod);
1676	return VINF_SUCCESS;
1677	}
1678	RT_EXPORT_SYMBOL(RTDbgModSetTag);
1679
1680
1681	RTDECL(int) RTDbgModSegmentAdd(RTDBGMOD hDbgMod, RTUINTPTR uRva, RTUINTPTR cb, const char *pszName,
1682	uint32_t fFlags, PRTDBGSEGIDX piSeg)
1683	{
1684	/*
1685	* Validate input.
1686	*/
1687	PRTDBGMODINT pDbgMod = hDbgMod;
1688	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1689	AssertMsgReturn(uRva + cb >= uRva, ("uRva=%RTptr cb=%RTptr\n", uRva, cb), VERR_DBG_ADDRESS_WRAP);
1690	Assert(*pszName);
1691	size_t cchName = strlen(pszName);
1692	AssertReturn(cchName > 0, VERR_DBG_SEGMENT_NAME_OUT_OF_RANGE);
1693	AssertReturn(cchName < RTDBG_SEGMENT_NAME_LENGTH, VERR_DBG_SEGMENT_NAME_OUT_OF_RANGE);
1694	AssertMsgReturn(!fFlags, ("%#x\n", fFlags), VERR_INVALID_PARAMETER);
1695	AssertPtrNull(piSeg);
1696	AssertMsgReturn(!piSeg \|\| piSeg == NIL_RTDBGSEGIDX \|\| piSeg <= RTDBGSEGIDX_LAST, ("%#x\n", *piSeg), VERR_DBG_SPECIAL_SEGMENT);
1697
1698	/*
1699	* Do the deed.
1700	*/
1701	RTDBGMOD_LOCK(pDbgMod);
1702	int rc = pDbgMod->pDbgVt->pfnSegmentAdd(pDbgMod, uRva, cb, pszName, cchName, fFlags, piSeg);
1703	RTDBGMOD_UNLOCK(pDbgMod);
1704
1705	return rc;
1706
1707	}
1708	RT_EXPORT_SYMBOL(RTDbgModSegmentAdd);
1709
1710
1711	RTDECL(RTDBGSEGIDX) RTDbgModSegmentCount(RTDBGMOD hDbgMod)
1712	{
1713	PRTDBGMODINT pDbgMod = hDbgMod;
1714	RTDBGMOD_VALID_RETURN_RC(pDbgMod, NIL_RTDBGSEGIDX);
1715	RTDBGMOD_LOCK(pDbgMod);
1716
1717	RTDBGSEGIDX cSegs = pDbgMod->pDbgVt->pfnSegmentCount(pDbgMod);
1718
1719	RTDBGMOD_UNLOCK(pDbgMod);
1720	return cSegs;
1721	}
1722	RT_EXPORT_SYMBOL(RTDbgModSegmentCount);
1723
1724
1725	RTDECL(int) RTDbgModSegmentByIndex(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, PRTDBGSEGMENT pSegInfo)
1726	{
1727	AssertMsgReturn(iSeg <= RTDBGSEGIDX_LAST, ("%#x\n", iSeg), VERR_DBG_SPECIAL_SEGMENT);
1728	PRTDBGMODINT pDbgMod = hDbgMod;
1729	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1730	RTDBGMOD_LOCK(pDbgMod);
1731
1732	int rc = pDbgMod->pDbgVt->pfnSegmentByIndex(pDbgMod, iSeg, pSegInfo);
1733
1734	RTDBGMOD_UNLOCK(pDbgMod);
1735	return rc;
1736	}
1737	RT_EXPORT_SYMBOL(RTDbgModSegmentByIndex);
1738
1739
1740	RTDECL(RTUINTPTR) RTDbgModSegmentSize(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg)
1741	{
1742	if (iSeg == RTDBGSEGIDX_RVA)
1743	return RTDbgModImageSize(hDbgMod);
1744	RTDBGSEGMENT SegInfo;
1745	int rc = RTDbgModSegmentByIndex(hDbgMod, iSeg, &SegInfo);
1746	return RT_SUCCESS(rc) ? SegInfo.cb : RTUINTPTR_MAX;
1747	}
1748	RT_EXPORT_SYMBOL(RTDbgModSegmentSize);
1749
1750
1751	RTDECL(RTUINTPTR) RTDbgModSegmentRva(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg)
1752	{
1753	RTDBGSEGMENT SegInfo;
1754	int rc = RTDbgModSegmentByIndex(hDbgMod, iSeg, &SegInfo);
1755	return RT_SUCCESS(rc) ? SegInfo.uRva : RTUINTPTR_MAX;
1756	}
1757	RT_EXPORT_SYMBOL(RTDbgModSegmentRva);
1758
1759
1760	RTDECL(int) RTDbgModSymbolAdd(RTDBGMOD hDbgMod, const char *pszSymbol, RTDBGSEGIDX iSeg, RTUINTPTR off,
1761	RTUINTPTR cb, uint32_t fFlags, uint32_t *piOrdinal)
1762	{
1763	/*
1764	* Validate input.
1765	*/
1766	PRTDBGMODINT pDbgMod = hDbgMod;
1767	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1768	AssertPtrReturn(pszSymbol, VERR_INVALID_POINTER);
1769	size_t cchSymbol = strlen(pszSymbol);
1770	AssertReturn(cchSymbol, VERR_DBG_SYMBOL_NAME_OUT_OF_RANGE);
1771	AssertReturn(cchSymbol < RTDBG_SYMBOL_NAME_LENGTH, VERR_DBG_SYMBOL_NAME_OUT_OF_RANGE);
1772	AssertMsgReturn( iSeg <= RTDBGSEGIDX_LAST
1773	\|\| ( iSeg >= RTDBGSEGIDX_SPECIAL_FIRST
1774	&& iSeg <= RTDBGSEGIDX_SPECIAL_LAST),
1775	("%#x\n", iSeg),
1776	VERR_DBG_INVALID_SEGMENT_INDEX);
1777	AssertMsgReturn(off + cb >= off, ("off=%RTptr cb=%RTptr\n", off, cb), VERR_DBG_ADDRESS_WRAP);
1778	AssertReturn(!fFlags, VERR_INVALID_PARAMETER); /* currently reserved. */
1779
1780	RTDBGMOD_LOCK(pDbgMod);
1781
1782	/*
1783	* Convert RVAs.
1784	*/
1785	if (iSeg == RTDBGSEGIDX_RVA)
1786	{
1787	iSeg = pDbgMod->pDbgVt->pfnRvaToSegOff(pDbgMod, off, &off);
1788	if (iSeg == NIL_RTDBGSEGIDX)
1789	{
1790	RTDBGMOD_UNLOCK(pDbgMod);
1791	return VERR_DBG_INVALID_RVA;
1792	}
1793	}
1794
1795	/*
1796	* Get down to business.
1797	*/
1798	int rc = pDbgMod->pDbgVt->pfnSymbolAdd(pDbgMod, pszSymbol, cchSymbol, iSeg, off, cb, fFlags, piOrdinal);
1799
1800	RTDBGMOD_UNLOCK(pDbgMod);
1801	return rc;
1802	}
1803	RT_EXPORT_SYMBOL(RTDbgModSymbolAdd);
1804
1805
1806	RTDECL(uint32_t) RTDbgModSymbolCount(RTDBGMOD hDbgMod)
1807	{
1808	PRTDBGMODINT pDbgMod = hDbgMod;
1809	RTDBGMOD_VALID_RETURN_RC(pDbgMod, UINT32_MAX);
1810	RTDBGMOD_LOCK(pDbgMod);
1811
1812	uint32_t cSymbols = pDbgMod->pDbgVt->pfnSymbolCount(pDbgMod);
1813
1814	RTDBGMOD_UNLOCK(pDbgMod);
1815	return cSymbols;
1816	}
1817	RT_EXPORT_SYMBOL(RTDbgModSymbolCount);
1818
1819
1820	RTDECL(int) RTDbgModSymbolByOrdinal(RTDBGMOD hDbgMod, uint32_t iOrdinal, PRTDBGSYMBOL pSymInfo)
1821	{
1822	PRTDBGMODINT pDbgMod = hDbgMod;
1823	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1824	RTDBGMOD_LOCK(pDbgMod);
1825
1826	int rc = pDbgMod->pDbgVt->pfnSymbolByOrdinal(pDbgMod, iOrdinal, pSymInfo);
1827
1828	RTDBGMOD_UNLOCK(pDbgMod);
1829	return rc;
1830	}
1831	RT_EXPORT_SYMBOL(RTDbgModSymbolByOrdinal);
1832
1833
1834	RTDECL(int) RTDbgModSymbolByOrdinalA(RTDBGMOD hDbgMod, uint32_t iOrdinal, PRTDBGSYMBOL *ppSymInfo)
1835	{
1836	AssertPtr(ppSymInfo);
1837	*ppSymInfo = NULL;
1838
1839	PRTDBGSYMBOL pSymInfo = RTDbgSymbolAlloc();
1840	if (!pSymInfo)
1841	return VERR_NO_MEMORY;
1842
1843	int rc = RTDbgModSymbolByOrdinal(hDbgMod, iOrdinal, pSymInfo);
1844
1845	if (RT_SUCCESS(rc))
1846	*ppSymInfo = pSymInfo;
1847	else
1848	RTDbgSymbolFree(pSymInfo);
1849	return rc;
1850	}
1851	RT_EXPORT_SYMBOL(RTDbgModSymbolByOrdinalA);
1852
1853
1854	RTDECL(int) RTDbgModSymbolByAddr(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, uint32_t fFlags,
1855	PRTINTPTR poffDisp, PRTDBGSYMBOL pSymInfo)
1856	{
1857	/*
1858	* Validate input.
1859	*/
1860	PRTDBGMODINT pDbgMod = hDbgMod;
1861	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1862	AssertPtrNull(poffDisp);
1863	AssertPtr(pSymInfo);
1864	AssertReturn(!(fFlags & ~RTDBGSYMADDR_FLAGS_VALID_MASK), VERR_INVALID_PARAMETER);
1865
1866	RTDBGMOD_LOCK(pDbgMod);
1867
1868	/*
1869	* Convert RVAs.
1870	*/
1871	if (iSeg == RTDBGSEGIDX_RVA)
1872	{
1873	iSeg = pDbgMod->pDbgVt->pfnRvaToSegOff(pDbgMod, off, &off);
1874	if (iSeg == NIL_RTDBGSEGIDX)
1875	{
1876	RTDBGMOD_UNLOCK(pDbgMod);
1877	return VERR_DBG_INVALID_RVA;
1878	}
1879	}
1880
1881	/*
1882	* Get down to business.
1883	*/
1884	int rc = pDbgMod->pDbgVt->pfnSymbolByAddr(pDbgMod, iSeg, off, fFlags, poffDisp, pSymInfo);
1885
1886	RTDBGMOD_UNLOCK(pDbgMod);
1887	return rc;
1888	}
1889	RT_EXPORT_SYMBOL(RTDbgModSymbolByAddr);
1890
1891
1892	RTDECL(int) RTDbgModSymbolByAddrA(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, uint32_t fFlags,
1893	PRTINTPTR poffDisp, PRTDBGSYMBOL *ppSymInfo)
1894	{
1895	AssertPtr(ppSymInfo);
1896	*ppSymInfo = NULL;
1897
1898	PRTDBGSYMBOL pSymInfo = RTDbgSymbolAlloc();
1899	if (!pSymInfo)
1900	return VERR_NO_MEMORY;
1901
1902	int rc = RTDbgModSymbolByAddr(hDbgMod, iSeg, off, fFlags, poffDisp, pSymInfo);
1903
1904	if (RT_SUCCESS(rc))
1905	*ppSymInfo = pSymInfo;
1906	else
1907	RTDbgSymbolFree(pSymInfo);
1908	return rc;
1909	}
1910	RT_EXPORT_SYMBOL(RTDbgModSymbolByAddrA);
1911
1912
1913	RTDECL(int) RTDbgModSymbolByName(RTDBGMOD hDbgMod, const char *pszSymbol, PRTDBGSYMBOL pSymInfo)
1914	{
1915	/*
1916	* Validate input.
1917	*/
1918	PRTDBGMODINT pDbgMod = hDbgMod;
1919	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1920	AssertPtr(pszSymbol);
1921	size_t cchSymbol = strlen(pszSymbol);
1922	AssertReturn(cchSymbol, VERR_DBG_SYMBOL_NAME_OUT_OF_RANGE);
1923	AssertReturn(cchSymbol < RTDBG_SYMBOL_NAME_LENGTH, VERR_DBG_SYMBOL_NAME_OUT_OF_RANGE);
1924	AssertPtr(pSymInfo);
1925
1926	/*
1927	* Make the query.
1928	*/
1929	RTDBGMOD_LOCK(pDbgMod);
1930	int rc = pDbgMod->pDbgVt->pfnSymbolByName(pDbgMod, pszSymbol, cchSymbol, pSymInfo);
1931	RTDBGMOD_UNLOCK(pDbgMod);
1932
1933	return rc;
1934	}
1935	RT_EXPORT_SYMBOL(RTDbgModSymbolByName);
1936
1937
1938	RTDECL(int) RTDbgModSymbolByNameA(RTDBGMOD hDbgMod, const char pszSymbol, PRTDBGSYMBOL ppSymInfo)
1939	{
1940	AssertPtr(ppSymInfo);
1941	*ppSymInfo = NULL;
1942
1943	PRTDBGSYMBOL pSymInfo = RTDbgSymbolAlloc();
1944	if (!pSymInfo)
1945	return VERR_NO_MEMORY;
1946
1947	int rc = RTDbgModSymbolByName(hDbgMod, pszSymbol, pSymInfo);
1948
1949	if (RT_SUCCESS(rc))
1950	*ppSymInfo = pSymInfo;
1951	else
1952	RTDbgSymbolFree(pSymInfo);
1953	return rc;
1954	}
1955	RT_EXPORT_SYMBOL(RTDbgModSymbolByNameA);
1956
1957
1958	RTDECL(int) RTDbgModLineAdd(RTDBGMOD hDbgMod, const char *pszFile, uint32_t uLineNo,
1959	RTDBGSEGIDX iSeg, RTUINTPTR off, uint32_t *piOrdinal)
1960	{
1961	/*
1962	* Validate input.
1963	*/
1964	PRTDBGMODINT pDbgMod = hDbgMod;
1965	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
1966	AssertPtr(pszFile);
1967	size_t cchFile = strlen(pszFile);
1968	AssertReturn(cchFile, VERR_DBG_FILE_NAME_OUT_OF_RANGE);
1969	AssertReturn(cchFile < RTDBG_FILE_NAME_LENGTH, VERR_DBG_FILE_NAME_OUT_OF_RANGE);
1970	AssertMsgReturn( iSeg <= RTDBGSEGIDX_LAST
1971	\|\| iSeg == RTDBGSEGIDX_RVA,
1972	("%#x\n", iSeg),
1973	VERR_DBG_INVALID_SEGMENT_INDEX);
1974	AssertReturn(uLineNo > 0 && uLineNo < UINT32_MAX, VERR_INVALID_PARAMETER);
1975
1976	RTDBGMOD_LOCK(pDbgMod);
1977
1978	/*
1979	* Convert RVAs.
1980	*/
1981	if (iSeg == RTDBGSEGIDX_RVA)
1982	{
1983	iSeg = pDbgMod->pDbgVt->pfnRvaToSegOff(pDbgMod, off, &off);
1984	if (iSeg == NIL_RTDBGSEGIDX)
1985	{
1986	RTDBGMOD_UNLOCK(pDbgMod);
1987	return VERR_DBG_INVALID_RVA;
1988	}
1989	}
1990
1991	/*
1992	* Get down to business.
1993	*/
1994	int rc = pDbgMod->pDbgVt->pfnLineAdd(pDbgMod, pszFile, cchFile, uLineNo, iSeg, off, piOrdinal);
1995
1996	RTDBGMOD_UNLOCK(pDbgMod);
1997	return rc;
1998	}
1999	RT_EXPORT_SYMBOL(RTDbgModLineAdd);
2000
2001
2002	RTDECL(uint32_t) RTDbgModLineCount(RTDBGMOD hDbgMod)
2003	{
2004	PRTDBGMODINT pDbgMod = hDbgMod;
2005	RTDBGMOD_VALID_RETURN_RC(pDbgMod, UINT32_MAX);
2006	RTDBGMOD_LOCK(pDbgMod);
2007
2008	uint32_t cLineNumbers = pDbgMod->pDbgVt->pfnLineCount(pDbgMod);
2009
2010	RTDBGMOD_UNLOCK(pDbgMod);
2011	return cLineNumbers;
2012	}
2013	RT_EXPORT_SYMBOL(RTDbgModLineCount);
2014
2015
2016	RTDECL(int) RTDbgModLineByOrdinal(RTDBGMOD hDbgMod, uint32_t iOrdinal, PRTDBGLINE pLineInfo)
2017	{
2018	PRTDBGMODINT pDbgMod = hDbgMod;
2019	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
2020	RTDBGMOD_LOCK(pDbgMod);
2021
2022	int rc = pDbgMod->pDbgVt->pfnLineByOrdinal(pDbgMod, iOrdinal, pLineInfo);
2023
2024	RTDBGMOD_UNLOCK(pDbgMod);
2025	return rc;
2026	}
2027	RT_EXPORT_SYMBOL(RTDbgModLineByOrdinal);
2028
2029
2030	RTDECL(int) RTDbgModLineByOrdinalA(RTDBGMOD hDbgMod, uint32_t iOrdinal, PRTDBGLINE *ppLineInfo)
2031	{
2032	AssertPtr(ppLineInfo);
2033	*ppLineInfo = NULL;
2034
2035	PRTDBGLINE pLineInfo = RTDbgLineAlloc();
2036	if (!pLineInfo)
2037	return VERR_NO_MEMORY;
2038
2039	int rc = RTDbgModLineByOrdinal(hDbgMod, iOrdinal, pLineInfo);
2040
2041	if (RT_SUCCESS(rc))
2042	*ppLineInfo = pLineInfo;
2043	else
2044	RTDbgLineFree(pLineInfo);
2045	return rc;
2046	}
2047	RT_EXPORT_SYMBOL(RTDbgModLineByOrdinalA);
2048
2049
2050	RTDECL(int) RTDbgModLineByAddr(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE pLineInfo)
2051	{
2052	/*
2053	* Validate input.
2054	*/
2055	PRTDBGMODINT pDbgMod = hDbgMod;
2056	RTDBGMOD_VALID_RETURN_RC(pDbgMod, VERR_INVALID_HANDLE);
2057	AssertPtrNull(poffDisp);
2058	AssertPtr(pLineInfo);
2059
2060	RTDBGMOD_LOCK(pDbgMod);
2061
2062	/*
2063	* Convert RVAs.
2064	*/
2065	if (iSeg == RTDBGSEGIDX_RVA)
2066	{
2067	iSeg = pDbgMod->pDbgVt->pfnRvaToSegOff(pDbgMod, off, &off);
2068	if (iSeg == NIL_RTDBGSEGIDX)
2069	{
2070	RTDBGMOD_UNLOCK(pDbgMod);
2071	return VERR_DBG_INVALID_RVA;
2072	}
2073	}
2074
2075	int rc = pDbgMod->pDbgVt->pfnLineByAddr(pDbgMod, iSeg, off, poffDisp, pLineInfo);
2076
2077	RTDBGMOD_UNLOCK(pDbgMod);
2078	return rc;
2079	}
2080	RT_EXPORT_SYMBOL(RTDbgModLineByAddr);
2081
2082
2083	RTDECL(int) RTDbgModLineByAddrA(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE *ppLineInfo)
2084	{
2085	AssertPtr(ppLineInfo);
2086	*ppLineInfo = NULL;
2087
2088	PRTDBGLINE pLineInfo = RTDbgLineAlloc();
2089	if (!pLineInfo)
2090	return VERR_NO_MEMORY;
2091
2092	int rc = RTDbgModLineByAddr(hDbgMod, iSeg, off, poffDisp, pLineInfo);
2093
2094	if (RT_SUCCESS(rc))
2095	*ppLineInfo = pLineInfo;
2096	else
2097	RTDbgLineFree(pLineInfo);
2098	return rc;
2099	}
2100	RT_EXPORT_SYMBOL(RTDbgModLineByAddrA);
2101

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

source: vbox/trunk/src/VBox/Runtime/common/dbg/dbgmod.cpp@ 72778

Download in other formats: