SUPDrv-dtrace.cpp@ 40867

Last change on this file since 40867 was 40867, checked in by vboxsync, 13 years ago
A couple of tracing bug fixes.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 27.2 KB

Line
1	/* $Id: SUPDrv-dtrace.cpp 40867 2012-04-11 10:53:53Z vboxsync $ */
2	/** @file
3	* VBoxDrv - The VirtualBox Support Driver - DTrace Provider.
4	*/
5
6	/*
7	* Copyright (C) 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
28	/*******************************************************************************
29	* Header Files *
30	*******************************************************************************/
31	#define LOG_GROUP LOG_GROUP_SUP_DRV
32	#include "SUPDrvInternal.h"
33
34	#include <VBox/err.h>
35	#include <VBox/log.h>
36	#include <VBox/VBoxTpG.h>
37
38	#include <iprt/assert.h>
39	#include <iprt/ctype.h>
40	#include <iprt/mem.h>
41	#include <iprt/errno.h>
42	#ifdef RT_OS_DARWIN
43	# include <iprt/dbg.h>
44	#endif
45
46	#ifdef RT_OS_DARWIN
47	# include VBOX_PATH_MACOSX_DTRACE_H
48	#else
49	# include <sys/dtrace.h>
50	#endif
51
52
53	/*******************************************************************************
54	* Structures and Typedefs *
55	*******************************************************************************/
56	/* Seems there is some return code difference here. Keep the return code and
57	case it to whatever the host desires. */
58	#ifdef RT_OS_DARWIN
59	typedef void FNPOPS_ENABLE(void , dtrace_id_t, void );
60	#else
61	typedef int FNPOPS_ENABLE(void , dtrace_id_t, void );
62	#endif
63
64
65	/**
66	* Stack data planted before calling dtrace_probe so that we can easily find the
67	* stack argument later.
68	*/
69	typedef struct SUPDRVDTSTACKDATA
70	{
71	/** Eyecatcher no. 1 (SUPDRVDT_STACK_DATA_MAGIC2). */
72	uint32_t u32Magic1;
73	/** Eyecatcher no. 2 (SUPDRVDT_STACK_DATA_MAGIC2). */
74	uint32_t u32Magic2;
75	/** Pointer to the stack arguments of a probe function call. */
76	uintptr_t *pauStackArgs;
77	/** Pointer to this structure.
78	* This is the final bit of integrity checking. */
79	struct SUPDRVDTSTACKDATA *pSelf;
80	} SUPDRVDTSTACKDATA;
81	/** Pointer to the on-stack thread specific data. */
82	typedef SUPDRVDTSTACKDATA *PSUPDRVDTSTACKDATA;
83
84
85	/*******************************************************************************
86	* Defined Constants And Macros *
87	*******************************************************************************/
88	/** The first magic value. */
89	#define SUPDRVDT_STACK_DATA_MAGIC1 RT_MAKE_U32_FROM_U8('S', 'U', 'P', 'D')
90	/** The second magic value. */
91	#define SUPDRVDT_STACK_DATA_MAGIC2 RT_MAKE_U32_FROM_U8('D', 'T', 'r', 'c')
92
93	/** The alignment of the stack data.
94	* The data doesn't require more than sizeof(uintptr_t) alignment, but the
95	* greater alignment the quicker lookup. */
96	#define SUPDRVDT_STACK_DATA_ALIGN 32
97
98	/** Plants the stack data. */
99	#define SUPDRVDT_SETUP_STACK_DATA() \
100	uint8_t abBlob[sizeof(SUPDRVDTSTACKDATA) + SUPDRVDT_STACK_DATA_ALIGN - 1]; \
101	PSUPDRVDTSTACKDATA pStackData = (PSUPDRVDTSTACKDATA)( (uintptr_t)&abBlob[SUPDRVDT_STACK_DATA_ALIGN - 1] \
102	& ~(uintptr_t)(SUPDRVDT_STACK_DATA_ALIGN - 1)); \
103	pStackData->u32Magic1 = SUPDRVDT_STACK_DATA_MAGIC1; \
104	pStackData->u32Magic2 = SUPDRVDT_STACK_DATA_MAGIC2; \
105	pStackData->pSelf = pStackData
106
107	/** Passifies the stack data and frees up resource held within it. */
108	#define SUPDRVDT_CLEAR_STACK_DATA() \
109	do \
110	{ \
111	pStackData->u32Magic1 = 0; \
112	pStackData->u32Magic2 = 0; \
113	pStackData->pSelf = NULL; \
114	} while (0)
115
116	/** Simple SUPR0Printf-style logging. */
117	#if 0 /def DEBUG_bird/
118	# define LOG_DTRACE(a) SUPR0Printf a
119	#else
120	# define LOG_DTRACE(a) do { } while (0)
121	#endif
122
123
124	/*******************************************************************************
125	* Global Variables *
126	*******************************************************************************/
127	#ifdef RT_OS_DARWIN
128	/** @name DTrace kernel interface used on Darwin
129	* @{ */
130	static void (* g_pfnDTraceProbeFire)(dtrace_id_t, uint64_t, uint64_t, uint64_t, uint64_t, uint64_t);
131	static dtrace_id_t (* g_pfnDTraceProbeCreate)(dtrace_provider_id_t, const char , const char , const char , int, void );
132	static dtrace_id_t (* g_pfnDTraceProbeLookup)(dtrace_provider_id_t, const char , const char , const char *);
133	static int (* g_pfnDTraceProviderRegister)(const char , const dtrace_pattr_t , uint32_t, /cred_t/ void *,
134	const dtrace_pops_t , void , dtrace_provider_id_t *);
135	static void (* g_pfnDTraceProviderInvalidate)(dtrace_provider_id_t);
136	static int (* g_pfnDTraceProviderUnregister)(dtrace_provider_id_t);
137
138	#define dtrace_probe g_pfnDTraceProbeFire
139	#define dtrace_probe_create g_pfnDTraceProbeCreate
140	#define dtrace_probe_lookup g_pfnDTraceProbeLookup
141	#define dtrace_register g_pfnDTraceProviderRegister
142	#define dtrace_invalidate g_pfnDTraceProviderInvalidate
143	#define dtrace_unregister g_pfnDTraceProviderUnregister
144
145	/** @} */
146	#endif
147
148
149	/*
150	*
151	* Helpers for handling VTG structures.
152	* Helpers for handling VTG structures.
153	* Helpers for handling VTG structures.
154	*
155	*/
156
157
158
159	/**
160	* Converts an attribute from VTG description speak to DTrace.
161	*
162	* @param pDtAttr The DTrace attribute (dst).
163	* @param pVtgAttr The VTG attribute descriptor (src).
164	*/
165	static void vboxDtVtgConvAttr(dtrace_attribute_t *pDtAttr, PCVTGDESCATTR pVtgAttr)
166	{
167	pDtAttr->dtat_name = pVtgAttr->u8Code - 1;
168	pDtAttr->dtat_data = pVtgAttr->u8Data - 1;
169	pDtAttr->dtat_class = pVtgAttr->u8DataDep - 1;
170	}
171
172	/**
173	* Gets a string from the string table.
174	*
175	* @returns Pointer to the string.
176	* @param pVtgHdr The VTG object header.
177	* @param offStrTab The string table offset.
178	*/
179	static const char *vboxDtVtgGetString(PVTGOBJHDR pVtgHdr, uint32_t offStrTab)
180	{
181	Assert(offStrTab < pVtgHdr->cbStrTab);
182	return &pVtgHdr->pachStrTab[offStrTab];
183	}
184
185
186
187	/*
188	*
189	* DTrace Provider Interface.
190	* DTrace Provider Interface.
191	* DTrace Provider Interface.
192	*
193	*/
194
195
196	/**
197	* @callback_method_impl{dtrace_pops_t,dtps_provide}
198	*/
199	static void supdrvDtPOps_Provide(void pvProv, const dtrace_probedesc_t pDtProbeDesc)
200	{
201	PSUPDRVVDTPROVIDERCORE pProv = (PSUPDRVVDTPROVIDERCORE)pvProv;
202	AssertPtrReturnVoid(pProv);
203	LOG_DTRACE(("supdrvDtPOps_Provide: %p / %p pDtProbeDesc=%p\n", pProv, pProv->TracerData.DTrace.idProvider, pDtProbeDesc));
204	AssertPtrReturnVoid(pProv->pHdr);
205	PVTGPROBELOC pProbeLoc = pProv->pHdr->paProbLocs;
206	AssertPtrReturnVoid(pProbeLoc);
207	PVTGPROBELOC pProbeLocEnd = pProv->pHdr->paProbLocsEnd;
208	AssertPtrReturnVoid(pProbeLocEnd);
209	dtrace_provider_id_t idProvider = pProv->TracerData.DTrace.idProvider;
210	AssertPtrReturnVoid(idProvider);
211	size_t const cbFnNmBuf = _4K + _1K;
212	char *pszFnNmBuf;
213	uint16_t idxProv;
214
215	if (pDtProbeDesc)
216	return; /* We don't generate probes, so never mind these requests. */
217
218	if (pProv->TracerData.DTrace.fZombie)
219	return;
220
221	if (pProv->TracerData.DTrace.cProvidedProbes >= pProbeLocEnd - pProbeLoc)
222	return;
223
224	/* Need a buffer for extracting the function names and mangling them in
225	case of collision. */
226	pszFnNmBuf = (char *)RTMemAlloc(cbFnNmBuf);
227	if (!pszFnNmBuf)
228	return;
229
230	/*
231	* Itereate the probe location list and register all probes related to
232	* this provider.
233	*/
234	idxProv = (uint16_t)(&pProv->pHdr->paProviders[0] - pProv->pDesc);
235	while ((uintptr_t)pProbeLoc < (uintptr_t)pProbeLocEnd)
236	{
237	PVTGDESCPROBE pProbeDesc = (PVTGDESCPROBE)pProbeLoc->pbProbe;
238	if ( pProbeDesc->idxProvider == idxProv
239	&& pProbeLoc->idProbe == UINT32_MAX)
240	{
241	/* The function name normally needs to be stripped since we're
242	using C++ compilers for most of the code. ASSUMES nobody are
243	brave/stupid enough to use function pointer returns without
244	typedef'ing properly them. */
245	const char *pszPrbName = vboxDtVtgGetString(pProv->pHdr, pProbeDesc->offName);
246	const char *pszFunc = pProbeLoc->pszFunction;
247	const char *psz = strchr(pProbeLoc->pszFunction, '(');
248	size_t cch;
249	if (psz)
250	{
251	/* skip blanks preceeding the parameter parenthesis. */
252	while ( (uintptr_t)psz > (uintptr_t)pProbeLoc->pszFunction
253	&& RT_C_IS_BLANK(psz[-1]))
254	psz--;
255
256	/* Find the start of the function name. */
257	pszFunc = psz - 1;
258	while ((uintptr_t)pszFunc > (uintptr_t)pProbeLoc->pszFunction)
259	{
260	char ch = pszFunc[-1];
261	if (!RT_C_IS_ALNUM(ch) && ch != '_' && ch != ':')
262	break;
263	pszFunc--;
264	}
265	cch = psz - pszFunc;
266	}
267	else
268	cch = strlen(pszFunc);
269	RTStrCopyEx(pszFnNmBuf, cbFnNmBuf, pszFunc, cch);
270
271	/* Look up the probe, if we have one in the same function, mangle
272	the function name a little to avoid having to deal with having
273	multiple location entries with the same probe ID. (lazy bird) */
274	Assert(pProbeLoc->idProbe == UINT32_MAX);
275	if (dtrace_probe_lookup(idProvider, pProv->pszModName, pszFnNmBuf, pszPrbName) != DTRACE_IDNONE)
276	{
277	RTStrPrintf(pszFnNmBuf+cch, cbFnNmBuf - cch, "-%u", pProbeLoc->uLine);
278	if (dtrace_probe_lookup(idProvider, pProv->pszModName, pszFnNmBuf, pszPrbName) != DTRACE_IDNONE)
279	{
280	unsigned iOrd = 2;
281	while (iOrd < 128)
282	{
283	RTStrPrintf(pszFnNmBuf+cch, cbFnNmBuf - cch, "-%u-%u", pProbeLoc->uLine, iOrd);
284	if (dtrace_probe_lookup(idProvider, pProv->pszModName, pszFnNmBuf, pszPrbName) == DTRACE_IDNONE)
285	break;
286	iOrd++;
287	}
288	if (iOrd >= 128)
289	{
290	LogRel(("VBoxDrv: More than 128 duplicate probe location instances %s at line %u in function %s [%s], probe %s\n",
291	pProbeLoc->uLine, pProbeLoc->pszFunction, pszFnNmBuf, pszPrbName));
292	continue;
293	}
294	}
295	}
296
297	/* Create the probe. */
298	AssertCompile(sizeof(pProbeLoc->idProbe) == sizeof(dtrace_id_t));
299	pProbeLoc->idProbe = dtrace_probe_create(idProvider, pProv->pszModName, pszFnNmBuf, pszPrbName,
300	1 /aframes/, pProbeLoc);
301	pProv->TracerData.DTrace.cProvidedProbes++;
302	}
303
304	pProbeLoc++;
305	}
306
307	RTMemFree(pszFnNmBuf);
308	LOG_DTRACE(("supdrvDtPOps_Provide: returns\n"));
309	}
310
311
312	/**
313	* @callback_method_impl{dtrace_pops_t,dtps_enable}
314	*/
315	static int supdrvDtPOps_Enable(void pvProv, dtrace_id_t idProbe, void pvProbe)
316	{
317	PSUPDRVVDTPROVIDERCORE pProv = (PSUPDRVVDTPROVIDERCORE)pvProv;
318	AssertPtrReturn(pProv, EINVAL);
319	LOG_DTRACE(("supdrvDtPOps_Enable: %p / %p - %#x / %p\n", pProv, pProv->TracerData.DTrace.idProvider, idProbe, pvProbe));
320	AssertPtrReturn(pvProbe, EINVAL);
321	AssertPtrReturn(pProv->TracerData.DTrace.idProvider, EINVAL);
322
323	if (!pProv->TracerData.DTrace.fZombie)
324	{
325	PVTGPROBELOC pProbeLoc = (PVTGPROBELOC)pvProbe;
326	PVTGDESCPROBE pProbeDesc = (PVTGDESCPROBE)pProbeLoc->pbProbe;
327
328	if (!pProbeLoc->fEnabled)
329	{
330	pProbeLoc->fEnabled = 1;
331	if (ASMAtomicIncU32(&pProbeDesc->u32User) == 1)
332	pProv->pHdr->pafProbeEnabled[pProbeDesc->idxEnabled] = 1;
333	}
334	}
335
336	return 0;
337	}
338
339
340	/**
341	* @callback_method_impl{dtrace_pops_t,dtps_disable}
342	*/
343	static void supdrvDtPOps_Disable(void pvProv, dtrace_id_t idProbe, void pvProbe)
344	{
345	PSUPDRVVDTPROVIDERCORE pProv = (PSUPDRVVDTPROVIDERCORE)pvProv;
346	AssertPtrReturnVoid(pProv);
347	LOG_DTRACE(("supdrvDtPOps_Disable: %p / %p - %#x / %p\n", pProv, pProv->TracerData.DTrace.idProvider, idProbe, pvProbe));
348	AssertPtrReturnVoid(pvProbe);
349	AssertPtrReturnVoid(pProv->TracerData.DTrace.idProvider);
350
351	if (!pProv->TracerData.DTrace.fZombie)
352	{
353	PVTGPROBELOC pProbeLoc = (PVTGPROBELOC)pvProbe;
354	PVTGDESCPROBE pProbeDesc = (PVTGDESCPROBE)pProbeLoc->pbProbe;
355	AssertPtrReturnVoid(pProbeDesc);
356
357	if (pProbeLoc->fEnabled)
358	{
359	pProbeLoc->fEnabled = 0;
360	if (ASMAtomicDecU32(&pProbeDesc->u32User) == 0)
361	pProv->pHdr->pafProbeEnabled[pProbeDesc->idxEnabled] = 0;
362	}
363	}
364	}
365
366
367	/**
368	* @callback_method_impl{dtrace_pops_t,dtps_getargdesc}
369	*/
370	static void supdrvDtPOps_GetArgDesc(void pvProv, dtrace_id_t idProbe, void pvProbe,
371	dtrace_argdesc_t *pArgDesc)
372	{
373	PSUPDRVVDTPROVIDERCORE pProv = (PSUPDRVVDTPROVIDERCORE)pvProv;
374	unsigned uArg = pArgDesc->dtargd_ndx;
375
376	pArgDesc->dtargd_ndx = DTRACE_ARGNONE;
377	AssertPtrReturnVoid(pProv);
378	LOG_DTRACE(("supdrvDtPOps_GetArgDesc: %p / %p - %#x / %p uArg=%d\n", pProv, pProv->TracerData.DTrace.idProvider, idProbe, pvProbe, uArg));
379	AssertPtrReturnVoid(pvProbe);
380	AssertPtrReturnVoid(pProv->TracerData.DTrace.idProvider);
381
382	if (!pProv->TracerData.DTrace.fZombie)
383	{
384	PVTGPROBELOC pProbeLoc = (PVTGPROBELOC)pvProbe;
385	PVTGDESCPROBE pProbeDesc = (PVTGDESCPROBE)pProbeLoc->pbProbe;
386	AssertPtrReturnVoid(pProbeDesc);
387	AssertPtrReturnVoid(pProv->pHdr);
388	PVTGDESCARGLIST pArgList = (PVTGDESCARGLIST)((uintptr_t)pProv->pHdr->paArgLists + pProbeDesc->offArgList);
389	AssertPtrReturnVoid(pArgList);
390
391	Assert(pProbeDesc->offArgList < pProv->pHdr->cbArgLists);
392	if (pArgList->cArgs > uArg)
393	{
394	const char *pszType = vboxDtVtgGetString(pProv->pHdr, pArgList->aArgs[uArg].offType);
395	size_t cchType = strlen(pszType);
396	if (cchType < sizeof(pArgDesc->dtargd_native))
397	{
398	memcpy(pArgDesc->dtargd_native, pszType, cchType + 1);
399	/** @todo mapping */
400	pArgDesc->dtargd_ndx = uArg;
401	LOG_DTRACE(("supdrvDtPOps_GetArgVal: returns dtargd_native = %s\n", pArgDesc->dtargd_native));
402	return;
403	}
404	}
405	}
406	}
407
408
409	/**
410	* @callback_method_impl{dtrace_pops_t,dtps_getargval}
411	*
412	*
413	* We just cook our own stuff here, using a stack marker for finding the
414	* required information. That's more reliable than subjecting oneself to the
415	* solaris bugs and 32-bit apple peculiarities.
416	*
417	*
418	* @remarks Solaris Bug
419	*
420	* dtrace_getarg on AMD64 has a different opinion about how to use the cFrames
421	* argument than dtrace_caller() and/or dtrace_getpcstack(), at least when the
422	* probe is fired by dtrace_probe() the way we do.
423	*
424	* Setting aframes to 1 when calling dtrace_probe_create gives me the right
425	* arguments, but the wrong 'caller'. Since I cannot do anything about
426	* 'caller', the only solution is this hack.
427	*
428	* Not sure why the Solaris guys hasn't seen this issue before, but maybe there
429	* isn't anyone using the default argument getter path for ring-0 dtrace_probe()
430	* calls, SDT surely isn't.
431	*
432	* @todo File a solaris bug on dtrace_probe() + dtrace_getarg().
433	*
434	*
435	* @remarks 32-bit XNU (Apple)
436	*
437	* The dtrace_probe arguments are 64-bit unsigned integers instead of uintptr_t,
438	* so we need to make an extra call.
439	*
440	*/
441	static uint64_t supdrvDtPOps_GetArgVal(void pvProv, dtrace_id_t idProbe, void pvProbe,
442	int iArg, int cFrames)
443	{
444	PSUPDRVVDTPROVIDERCORE pProv = (PSUPDRVVDTPROVIDERCORE)pvProv;
445	AssertPtrReturn(pProv, UINT64_MAX);
446	LOG_DTRACE(("supdrvDtPOps_GetArgVal: %p / %p - %#x / %p iArg=%d cFrames=%u\n", pProv, pProv->TracerData.DTrace.idProvider, idProbe, pvProbe, iArg, cFrames));
447	AssertReturn(iArg >= 5, UINT64_MAX);
448	AssertPtrReturn(pvProbe, UINT64_MAX);
449	AssertReturn(!pProv->TracerData.DTrace.fZombie, UINT64_MAX);
450	AssertPtrReturn(pProv->TracerData.DTrace.idProvider, UINT64_MAX);
451
452	/* Locate the caller of probe_dtrace, . */
453	int volatile iDummy = 1; /* use this to get the stack address. */
454	PSUPDRVDTSTACKDATA pData = (PSUPDRVDTSTACKDATA)( ((uintptr_t)&iDummy + SUPDRVDT_STACK_DATA_ALIGN - 1)
455	& ~(uintptr_t)(SUPDRVDT_STACK_DATA_ALIGN - 1));
456	for (;;)
457	{
458	if ( pData->u32Magic1 == SUPDRVDT_STACK_DATA_MAGIC1
459	&& pData->u32Magic2 == SUPDRVDT_STACK_DATA_MAGIC2
460	&& pData->pSelf == pData)
461	break;
462	pData = (PSUPDRVDTSTACKDATA)((uintptr_t)pData + SUPDRVDT_STACK_DATA_ALIGN);
463	}
464
465	/* Get the stack data. */
466	LOG_DTRACE(("supdrvDtPOps_GetArgVal: returns %#llx\n", (uint64_t)pData->pauStackArgs[iArg - 5]));
467	return pData->pauStackArgs[iArg - 5];
468	}
469
470
471	/**
472	* @callback_method_impl{dtrace_pops_t,dtps_destroy}
473	*/
474	static void supdrvDtPOps_Destroy(void pvProv, dtrace_id_t idProbe, void pvProbe)
475	{
476	PSUPDRVVDTPROVIDERCORE pProv = (PSUPDRVVDTPROVIDERCORE)pvProv;
477	AssertPtrReturnVoid(pProv);
478	LOG_DTRACE(("supdrvDtPOps_Destroy: %p / %p - %#x / %p\n", pProv, pProv->TracerData.DTrace.idProvider, idProbe, pvProbe));
479	AssertReturnVoid(pProv->TracerData.DTrace.cProvidedProbes > 0);
480	AssertPtrReturnVoid(pProv->TracerData.DTrace.idProvider);
481
482	if (!pProv->TracerData.DTrace.fZombie)
483	{
484	PVTGPROBELOC pProbeLoc = (PVTGPROBELOC)pvProbe;
485	AssertPtrReturnVoid(pProbeLoc);
486	AssertPtrReturnVoid(pProbeLoc->pszFunction);
487	Assert(!pProbeLoc->fEnabled);
488	AssertReturnVoid(pProbeLoc->idProbe == idProbe);
489
490	pProbeLoc->idProbe = UINT32_MAX;
491	}
492	pProv->TracerData.DTrace.cProvidedProbes--;
493	}
494
495
496
497	/**
498	* DTrace provider method table.
499	*/
500	static const dtrace_pops_t g_vboxDtVtgProvOps =
501	{
502	/* .dtps_provide = */ supdrvDtPOps_Provide,
503	/* .dtps_provide_module = */ NULL,
504	/* .dtps_enable = / (FNPOPS_ENABLE )supdrvDtPOps_Enable,
505	/* .dtps_disable = */ supdrvDtPOps_Disable,
506	/* .dtps_suspend = */ NULL,
507	/* .dtps_resume = */ NULL,
508	/* .dtps_getargdesc = */ supdrvDtPOps_GetArgDesc,
509	/* .dtps_getargval = */ supdrvDtPOps_GetArgVal,
510	/* .dtps_usermode = */ NULL,
511	/* .dtps_destroy = */ supdrvDtPOps_Destroy
512	};
513
514
515
516
517	/*
518	*
519	* Support Driver Tracer Interface.
520	* Support Driver Tracer Interface.
521	* Support Driver Tracer Interface.
522	*
523	*/
524
525
526
527	/**
528	* interface_method_impl{SUPDRVTRACERREG,pfnProbeFireUser}
529	*/
530	static DECLCALLBACK(void) supdrvDtTOps_ProbeFireKernel(struct VTGPROBELOC *pVtgProbeLoc, uintptr_t uArg0, uintptr_t uArg1, uintptr_t uArg2,
531	uintptr_t uArg3, uintptr_t uArg4)
532	{
533	AssertPtrReturnVoid(pVtgProbeLoc);
534	LOG_DTRACE(("supdrvDtTOps_ProbeFireKernel: %p / %p\n", pVtgProbeLoc, pVtgProbeLoc->idProbe));
535	AssertPtrReturnVoid(pVtgProbeLoc->pbProbe);
536	AssertPtrReturnVoid(pVtgProbeLoc->pszFunction);
537
538	SUPDRVDT_SETUP_STACK_DATA();
539
540	pStackData->pauStackArgs = &uArg4 + 1;
541	dtrace_probe(pVtgProbeLoc->idProbe, uArg0, uArg1, uArg2, uArg3, uArg4);
542
543	SUPDRVDT_CLEAR_STACK_DATA();
544	LOG_DTRACE(("supdrvDtTOps_ProbeFireKernel: returns\n"));
545	}
546
547
548	/**
549	* interface_method_impl{SUPDRVTRACERREG,pfnProbeFireUser}
550	*/
551	static DECLCALLBACK(void) supdrvDtTOps_ProbeFireUser(PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, PCSUPDRVTRACERUSRCTX pCtx)
552	{
553	NOREF(pThis); NOREF(pSession); NOREF(pCtx);
554	return;
555	}
556
557
558	/**
559	* interface_method_impl{SUPDRVTRACERREG,pfnTracerOpen}
560	*/
561	static DECLCALLBACK(int) supdrvDtTOps_TracerOpen(PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uint32_t uCookie,
562	uintptr_t uArg, uintptr_t *puSessionData)
563	{
564	NOREF(pThis); NOREF(pSession); NOREF(uCookie); NOREF(uArg);
565	*puSessionData = 0;
566	return VERR_NOT_SUPPORTED;
567	}
568
569
570	/**
571	* interface_method_impl{SUPDRVTRACERREG,pfnTracerClose}
572	*/
573	static DECLCALLBACK(int) supdrvDtTOps_TracerIoCtl(PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uintptr_t uSessionData,
574	uintptr_t uCmd, uintptr_t uArg, int32_t *piRetVal)
575	{
576	NOREF(pThis); NOREF(pSession); NOREF(uSessionData);
577	NOREF(uCmd); NOREF(uArg); NOREF(piRetVal);
578	return VERR_NOT_SUPPORTED;
579	}
580
581
582	/**
583	* interface_method_impl{SUPDRVTRACERREG,pfnTracerClose}
584	*/
585	static DECLCALLBACK(void) supdrvDtTOps_TracerClose(PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uintptr_t uSessionData)
586	{
587	NOREF(pThis); NOREF(pSession); NOREF(uSessionData);
588	return;
589	}
590
591
592	/**
593	* interface_method_impl{SUPDRVTRACERREG,pfnProviderRegister}
594	*/
595	static DECLCALLBACK(int) supdrvDtTOps_ProviderRegister(PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore)
596	{
597	LOG_DTRACE(("supdrvDtTOps_ProviderRegister: %p %s/%s\n", pThis, pCore->pszModName, pCore->pszName));
598	AssertReturn(pCore->TracerData.DTrace.idProvider == UINT32_MAX \|\| pCore->TracerData.DTrace.idProvider == 0,
599	VERR_INTERNAL_ERROR_3);
600
601	PVTGDESCPROVIDER pDesc = pCore->pDesc;
602	dtrace_pattr_t DtAttrs;
603	vboxDtVtgConvAttr(&DtAttrs.dtpa_provider, &pDesc->AttrSelf);
604	vboxDtVtgConvAttr(&DtAttrs.dtpa_mod, &pDesc->AttrModules);
605	vboxDtVtgConvAttr(&DtAttrs.dtpa_func, &pDesc->AttrFunctions);
606	vboxDtVtgConvAttr(&DtAttrs.dtpa_name, &pDesc->AttrNames);
607	vboxDtVtgConvAttr(&DtAttrs.dtpa_args, &pDesc->AttrArguments);
608
609	/* Note! DTrace may call us back before dtrace_register returns, so we
610	have to point it to pCore->TracerData.DTrace.idProvider. */
611	int rc = dtrace_register(pCore->pszName,
612	&DtAttrs,
613	DTRACE_PRIV_KERNEL,
614	NULL /* cred */,
615	&g_vboxDtVtgProvOps,
616	pCore,
617	&pCore->TracerData.DTrace.idProvider);
618	LOG_DTRACE(("supdrvDtTOps_ProviderRegister: idProvider=%p\n", pCore->TracerData.DTrace.idProvider));
619	if (!rc)
620	{
621	Assert(pCore->TracerData.DTrace.idProvider != UINT32_MAX && pCore->TracerData.DTrace.idProvider != 0);
622	AssertPtr(pCore->TracerData.DTrace.idProvider);
623	rc = VINF_SUCCESS;
624	}
625	else
626	{
627	pCore->TracerData.DTrace.idProvider = UINT32_MAX;
628	rc = RTErrConvertFromErrno(rc);
629	}
630
631	LOG_DTRACE(("supdrvDtTOps_ProviderRegister: returns %Rrc\n", rc));
632	return rc;
633	}
634
635
636	/**
637	* interface_method_impl{SUPDRVTRACERREG,pfnProviderDeregister}
638	*/
639	static DECLCALLBACK(int) supdrvDtTOps_ProviderDeregister(PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore)
640	{
641	uintptr_t idProvider = pCore->TracerData.DTrace.idProvider;
642	LOG_DTRACE(("supdrvDtTOps_ProviderDeregister: %p / %p\n", pThis, idProvider));
643	AssertPtrReturn(idProvider, VERR_INTERNAL_ERROR_3);
644	AssertReturn(idProvider != UINT32_MAX && idProvider != 0, VERR_INTERNAL_ERROR_4);
645
646	dtrace_invalidate(idProvider);
647	int rc = dtrace_unregister(idProvider);
648	if (!rc)
649	{
650	pCore->TracerData.DTrace.idProvider = UINT32_MAX;
651	rc = VINF_SUCCESS;
652	}
653	else
654	{
655	AssertMsg(rc == EBUSY, ("%d\n", rc));
656	pCore->TracerData.DTrace.fZombie = true;
657	rc = VERR_TRY_AGAIN;
658	}
659
660	LOG_DTRACE(("supdrvDtTOps_ProviderDeregister: returns %Rrc\n", rc));
661	return rc;
662	}
663
664
665	/**
666	* interface_method_impl{SUPDRVTRACERREG,pfnProviderDeregisterZombie}
667	*/
668	static DECLCALLBACK(int) supdrvDtTOps_ProviderDeregisterZombie(PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore)
669	{
670	uintptr_t idProvider = pCore->TracerData.DTrace.idProvider;
671	LOG_DTRACE(("supdrvDtTOps_ProviderDeregisterZombie: %p / %p\n", pThis, idProvider));
672	AssertPtrReturn(idProvider, VERR_INTERNAL_ERROR_3);
673	AssertReturn(idProvider != UINT32_MAX && idProvider != 0, VERR_INTERNAL_ERROR_4);
674	Assert(pCore->TracerData.DTrace.fZombie);
675
676	int rc = dtrace_unregister(idProvider);
677	if (!rc)
678	{
679	pCore->TracerData.DTrace.idProvider = UINT32_MAX;
680	rc = VINF_SUCCESS;
681	}
682	else
683	{
684	AssertMsg(rc == EBUSY, ("%d\n", rc));
685	rc = VERR_TRY_AGAIN;
686	}
687
688	LOG_DTRACE(("supdrvDtTOps_ProviderDeregisterZombie: returns %Rrc\n", rc));
689	return rc;
690	}
691
692
693
694	/**
695	* The tracer registration record of the VBox DTrace implementation
696	*/
697	static SUPDRVTRACERREG g_supdrvDTraceReg =
698	{
699	SUPDRVTRACERREG_MAGIC,
700	SUPDRVTRACERREG_VERSION,
701	supdrvDtTOps_ProbeFireKernel,
702	supdrvDtTOps_ProbeFireUser,
703	supdrvDtTOps_TracerOpen,
704	supdrvDtTOps_TracerIoCtl,
705	supdrvDtTOps_TracerClose,
706	supdrvDtTOps_ProviderRegister,
707	supdrvDtTOps_ProviderDeregister,
708	supdrvDtTOps_ProviderDeregisterZombie,
709	SUPDRVTRACERREG_MAGIC
710	};
711
712
713
714	/**
715	* Module initialization code.
716	*
717	* @param hMod Opque module handle.
718	*/
719	const SUPDRVTRACERREG * VBOXCALL supdrvDTraceInit(void)
720	{
721	#ifdef RT_OS_DARWIN
722	/*
723	* Resolve the kernel symbols we need.
724	*/
725	RTDBGKRNLINFO hKrnlInfo;
726	int rc = RTR0DbgKrnlInfoOpen(&hKrnlInfo, 0);
727	if (RT_FAILURE(rc))
728	{
729	SUPR0Printf("supdrvDTraceInit: RTR0DbgKrnlInfoOpen failed with rc=%d.\n", rc);
730	return NULL;
731	}
732
733	static const struct
734	{
735	const char *pszName;
736	PFNRT *ppfn;
737	} s_aDTraceFunctions[] =
738	{
739	{ "dtrace_probe", (PFNRT*)&dtrace_probe },
740	{ "dtrace_probe_create", (PFNRT*)&dtrace_probe_create },
741	{ "dtrace_probe_lookup", (PFNRT*)&dtrace_probe_lookup },
742	{ "dtrace_register", (PFNRT*)&dtrace_register },
743	{ "dtrace_invalidate", (PFNRT*)&dtrace_invalidate },
744	{ "dtrace_unregister", (PFNRT*)&dtrace_unregister },
745	};
746	for (unsigned i = 0; i < RT_ELEMENTS(s_aDTraceFunctions); i++)
747	{
748	rc = RTR0DbgKrnlInfoQuerySymbol(hKrnlInfo, NULL, s_aDTraceFunctions[i].pszName,
749	(void **)s_aDTraceFunctions[i].ppfn);
750	if (RT_FAILURE(rc))
751	{
752	SUPR0Printf("supdrvDTraceInit: Failed to resolved '%s' (rc=%Rrc, i=%u).\n", s_aDTraceFunctions[i].pszName, rc, i);
753	break;
754	}
755	}
756
757	RTR0DbgKrnlInfoRelease(hKrnlInfo);
758	if (RT_FAILURE(rc))
759	return NULL;
760	#endif
761
762	return &g_supdrvDTraceReg;
763	}
764
765	#ifndef VBOX_WITH_NATIVE_DTRACE_R0DRV
766	# error "VBOX_WITH_NATIVE_DTRACE_R0DRV is not defined as it should"
767	#endif
768

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

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPDrv-dtrace.cpp@ 40867

Download in other formats: