VBoxTpG.cpp@ 58976

Last change on this file since 58976 was 58976, checked in by vboxsync, 9 years ago
VBoxTpG,SUPDrv: Extended VTGDESCPROVIDER again to facilitate HM in ring-0; major support driver version bump.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 97.4 KB

Line
1	/* $Id: VBoxTpG.cpp 58976 2015-12-03 21:42:04Z vboxsync $ */
2	/** @file
3	* VBox Build Tool - VBox Tracepoint Generator.
4	*/
5
6	/*
7	* Copyright (C) 2012-2015 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
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#include <VBox/VBoxTpG.h>
23
24	#include <iprt/alloca.h>
25	#include <iprt/assert.h>
26	#include <iprt/ctype.h>
27	#include <iprt/env.h>
28	#include <iprt/err.h>
29	#include <iprt/file.h>
30	#include <iprt/getopt.h>
31	#include <iprt/initterm.h>
32	#include <iprt/list.h>
33	#include <iprt/mem.h>
34	#include <iprt/message.h>
35	#include <iprt/path.h>
36	#include <iprt/process.h>
37	#include <iprt/stream.h>
38	#include <iprt/string.h>
39	#include <iprt/uuid.h>
40
41	#include "scmstream.h"
42
43
44	/*********************************************************************************************************************************
45	* Structures and Typedefs *
46	*********************************************************************************************************************************/
47
48	typedef struct VTGATTRS
49	{
50	kVTGStability enmCode;
51	kVTGStability enmData;
52	kVTGClass enmDataDep;
53	} VTGATTRS;
54	typedef VTGATTRS *PVTGATTRS;
55
56
57	typedef struct VTGARG
58	{
59	RTLISTNODE ListEntry;
60	/** The argument name. (heap) */
61	char *pszName;
62	/** The type presented to the tracer (in string table). */
63	const char *pszTracerType;
64	/** The argument type used in the probe method in that context. (heap) */
65	char *pszCtxType;
66	/** Argument passing format string. First and only argument is the name.
67	* (const string) */
68	const char *pszArgPassingFmt;
69	/** The type flags. */
70	uint32_t fType;
71	} VTGARG;
72	typedef VTGARG *PVTGARG;
73
74	typedef struct VTGPROBE
75	{
76	RTLISTNODE ListEntry;
77	char *pszMangledName;
78	const char *pszUnmangledName;
79	RTLISTANCHOR ArgHead;
80	uint32_t cArgs;
81	bool fHaveLargeArgs;
82	uint32_t offArgList;
83	uint32_t iProbe;
84	} VTGPROBE;
85	typedef VTGPROBE *PVTGPROBE;
86
87	typedef struct VTGPROVIDER
88	{
89	RTLISTNODE ListEntry;
90	const char *pszName;
91
92	uint16_t iFirstProbe;
93	uint16_t cProbes;
94
95	VTGATTRS AttrSelf;
96	VTGATTRS AttrModules;
97	VTGATTRS AttrFunctions;
98	VTGATTRS AttrName;
99	VTGATTRS AttrArguments;
100
101	RTLISTANCHOR ProbeHead;
102	} VTGPROVIDER;
103	typedef VTGPROVIDER *PVTGPROVIDER;
104
105	/**
106	* A string table string.
107	*/
108	typedef struct VTGSTRING
109	{
110	/** The string space core. */
111	RTSTRSPACECORE Core;
112	/** The string table offset. */
113	uint32_t offStrTab;
114	/** The actual string. */
115	char szString[1];
116	} VTGSTRING;
117	typedef VTGSTRING *PVTGSTRING;
118
119
120	/*********************************************************************************************************************************
121	* Global Variables *
122	*********************************************************************************************************************************/
123	/** The string space organizing the string table strings. Each node is a VTGSTRING. */
124	static RTSTRSPACE g_StrSpace = NULL;
125	/** Used by the string table enumerator to set VTGSTRING::offStrTab. */
126	static uint32_t g_offStrTab;
127	/** List of providers created by the parser. */
128	static RTLISTANCHOR g_ProviderHead;
129	/** The number of type errors. */
130	static uint32_t g_cTypeErrors = 0;
131
132
133	/** @name Options
134	* @{ */
135	static enum
136	{
137	kVBoxTpGAction_Nothing,
138	kVBoxTpGAction_GenerateHeader,
139	kVBoxTpGAction_GenerateWrapperHeader,
140	kVBoxTpGAction_GenerateObject
141	} g_enmAction = kVBoxTpGAction_Nothing;
142	static uint32_t g_cBits = HC_ARCH_BITS;
143	static uint32_t g_cHostBits = HC_ARCH_BITS;
144	static uint32_t g_fTypeContext = VTG_TYPE_CTX_R0;
145	static const char *g_pszContextDefine = "IN_RING0";
146	static const char *g_pszContextDefine2 = NULL;
147	static bool g_fApplyCpp = false;
148	static uint32_t g_cVerbosity = 0;
149	static const char *g_pszOutput = NULL;
150	static const char *g_pszScript = NULL;
151	static const char *g_pszTempAsm = NULL;
152	#ifdef RT_OS_DARWIN
153	static const char *g_pszAssembler = "yasm";
154	static const char *g_pszAssemblerFmtOpt = "-f";
155	static const char g_szAssemblerFmtVal32[] = "macho32";
156	static const char g_szAssemblerFmtVal64[] = "macho64";
157	static const char g_szAssemblerOsDef[] = "RT_OS_DARWIN";
158	#elif defined(RT_OS_OS2)
159	static const char *pszAssembler = "nasm.exe";
160	static const char *pszAssemblerFmtOpt = "-f";
161	static const char g_szAssemblerFmtVal32[] = "obj";
162	static const char g_szAssemblerFmtVal64[] = "elf64";
163	static const char g_szAssemblerOsDef[] = "RT_OS_OS2";
164	#elif defined(RT_OS_WINDOWS)
165	static const char *g_pszAssembler = "yasm.exe";
166	static const char *g_pszAssemblerFmtOpt = "-f";
167	static const char g_szAssemblerFmtVal32[] = "win32";
168	static const char g_szAssemblerFmtVal64[] = "win64";
169	static const char g_szAssemblerOsDef[] = "RT_OS_WINDOWS";
170	#else
171	static const char *g_pszAssembler = "yasm";
172	static const char *g_pszAssemblerFmtOpt = "-f";
173	static const char g_szAssemblerFmtVal32[] = "elf32";
174	static const char g_szAssemblerFmtVal64[] = "elf64";
175	# ifdef RT_OS_FREEBSD
176	static const char g_szAssemblerOsDef[] = "RT_OS_FREEBSD";
177	# elif defined(RT_OS_NETBSD)
178	static const char g_szAssemblerOsDef[] = "RT_OS_NETBSD";
179	# elif defined(RT_OS_OPENBSD)
180	static const char g_szAssemblerOsDef[] = "RT_OS_OPENBSD";
181	# elif defined(RT_OS_LINUX)
182	static const char g_szAssemblerOsDef[] = "RT_OS_LINUX";
183	# elif defined(RT_OS_SOLARIS)
184	static const char g_szAssemblerOsDef[] = "RT_OS_SOLARIS";
185	# else
186	# error "Port me!"
187	# endif
188	#endif
189	static const char *g_pszAssemblerFmtVal = RT_CONCAT(g_szAssemblerFmtVal, HC_ARCH_BITS);
190	static const char *g_pszAssemblerDefOpt = "-D";
191	static const char *g_pszAssemblerIncOpt = "-I";
192	static char g_szAssemblerIncVal[RTPATH_MAX];
193	static const char *g_pszAssemblerIncVal = __FILE__ "/../../../include/";
194	static const char *g_pszAssemblerOutputOpt = "-o";
195	static unsigned g_cAssemblerOptions = 0;
196	static const char *g_apszAssemblerOptions[32];
197	static const char *g_pszProbeFnName = "SUPR0TracerFireProbe";
198	static bool g_fProbeFnImported = true;
199	static bool g_fPic = false;
200	/** @} */
201
202
203
204
205	/**
206	* Inserts a string into the string table, reusing any matching existing string
207	* if possible.
208	*
209	* @returns Read only string.
210	* @param pch The string to insert (need not be terminated).
211	* @param cch The length of the string.
212	*/
213	static const char strtabInsertN(const char pch, size_t cch)
214	{
215	PVTGSTRING pStr = (PVTGSTRING)RTStrSpaceGetN(&g_StrSpace, pch, cch);
216	if (pStr)
217	return pStr->szString;
218
219	/*
220	* Create a new entry.
221	*/
222	pStr = (PVTGSTRING)RTMemAlloc(RT_OFFSETOF(VTGSTRING, szString[cch + 1]));
223	if (!pStr)
224	return NULL;
225
226	pStr->Core.pszString = pStr->szString;
227	memcpy(pStr->szString, pch, cch);
228	pStr->szString[cch] = '\0';
229	pStr->offStrTab = UINT32_MAX;
230
231	bool fRc = RTStrSpaceInsert(&g_StrSpace, &pStr->Core);
232	Assert(fRc); NOREF(fRc);
233	return pStr->szString;
234	}
235
236
237	/**
238	* Retrieves the string table offset of the given string table string.
239	*
240	* @returns String table offset.
241	* @param pszStrTabString The string table string.
242	*/
243	static uint32_t strtabGetOff(const char *pszStrTabString)
244	{
245	PVTGSTRING pStr = RT_FROM_MEMBER(pszStrTabString, VTGSTRING, szString[0]);
246	Assert(pStr->Core.pszString == pszStrTabString);
247	return pStr->offStrTab;
248	}
249
250
251	/**
252	* Invokes the assembler.
253	*
254	* @returns Exit code.
255	* @param pszOutput The output file.
256	* @param pszTempAsm The source file.
257	*/
258	static RTEXITCODE generateInvokeAssembler(const char pszOutput, const char pszTempAsm)
259	{
260	const char *apszArgs[64];
261	unsigned iArg = 0;
262
263	apszArgs[iArg++] = g_pszAssembler;
264	apszArgs[iArg++] = g_pszAssemblerFmtOpt;
265	apszArgs[iArg++] = g_pszAssemblerFmtVal;
266	apszArgs[iArg++] = g_pszAssemblerDefOpt;
267	if (!strcmp(g_pszAssemblerFmtVal, "macho32") \|\| !strcmp(g_pszAssemblerFmtVal, "macho64"))
268	apszArgs[iArg++] = "ASM_FORMAT_MACHO";
269	else if (!strcmp(g_pszAssemblerFmtVal, "obj") \|\| !strcmp(g_pszAssemblerFmtVal, "omf"))
270	apszArgs[iArg++] = "ASM_FORMAT_OMF";
271	else if ( !strcmp(g_pszAssemblerFmtVal, "win32")
272	\|\| !strcmp(g_pszAssemblerFmtVal, "win64")
273	\|\| !strcmp(g_pszAssemblerFmtVal, "pe32")
274	\|\| !strcmp(g_pszAssemblerFmtVal, "pe64")
275	\|\| !strcmp(g_pszAssemblerFmtVal, "pe") )
276	apszArgs[iArg++] = "ASM_FORMAT_PE";
277	else if ( !strcmp(g_pszAssemblerFmtVal, "elf32")
278	\|\| !strcmp(g_pszAssemblerFmtVal, "elf64")
279	\|\| !strcmp(g_pszAssemblerFmtVal, "elf"))
280	apszArgs[iArg++] = "ASM_FORMAT_ELF";
281	else
282	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Unknown assembler format '%s'", g_pszAssemblerFmtVal);
283	apszArgs[iArg++] = g_pszAssemblerDefOpt;
284	if (g_cBits == 32)
285	apszArgs[iArg++] = "ARCH_BITS=32";
286	else
287	apszArgs[iArg++] = "ARCH_BITS=64";
288	apszArgs[iArg++] = g_pszAssemblerDefOpt;
289	if (g_cHostBits == 32)
290	apszArgs[iArg++] = "HC_ARCH_BITS=32";
291	else
292	apszArgs[iArg++] = "HC_ARCH_BITS=64";
293	apszArgs[iArg++] = g_pszAssemblerDefOpt;
294	if (g_cBits == 32)
295	apszArgs[iArg++] = "RT_ARCH_X86";
296	else
297	apszArgs[iArg++] = "RT_ARCH_AMD64";
298	apszArgs[iArg++] = g_pszAssemblerDefOpt;
299	apszArgs[iArg++] = g_pszContextDefine;
300	if (g_pszContextDefine2)
301	{
302	apszArgs[iArg++] = g_pszAssemblerDefOpt;
303	apszArgs[iArg++] = g_pszContextDefine2;
304	}
305	if (g_szAssemblerOsDef[0])
306	{
307	apszArgs[iArg++] = g_pszAssemblerDefOpt;
308	apszArgs[iArg++] = g_szAssemblerOsDef;
309	}
310	apszArgs[iArg++] = g_pszAssemblerIncOpt;
311	apszArgs[iArg++] = g_pszAssemblerIncVal;
312	apszArgs[iArg++] = g_pszAssemblerOutputOpt;
313	apszArgs[iArg++] = pszOutput;
314	for (unsigned i = 0; i < g_cAssemblerOptions; i++)
315	apszArgs[iArg++] = g_apszAssemblerOptions[i];
316	apszArgs[iArg++] = pszTempAsm;
317	apszArgs[iArg] = NULL;
318	Assert(iArg <= RT_ELEMENTS(apszArgs));
319
320	if (g_cVerbosity > 1)
321	{
322	RTMsgInfo("Starting assmbler '%s' with arguments:\n", g_pszAssembler);
323	for (unsigned i = 0; i < iArg; i++)
324	RTMsgInfo(" #%02u: '%s'\n", i, apszArgs[i]);
325	}
326
327	RTPROCESS hProc;
328	int rc = RTProcCreate(apszArgs[0], apszArgs, RTENV_DEFAULT, RTPROC_FLAGS_SEARCH_PATH, &hProc);
329	if (RT_FAILURE(rc))
330	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to start '%s' (assembler): %Rrc", apszArgs[0], rc);
331
332	RTPROCSTATUS Status;
333	rc = RTProcWait(hProc, RTPROCWAIT_FLAGS_BLOCK, &Status);
334	if (RT_FAILURE(rc))
335	{
336	RTProcTerminate(hProc);
337	return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTProcWait failed: %Rrc", rc);
338	}
339	if (Status.enmReason == RTPROCEXITREASON_SIGNAL)
340	return RTMsgErrorExit(RTEXITCODE_FAILURE, "The assembler failed: signal %d", Status.iStatus);
341	if (Status.enmReason != RTPROCEXITREASON_NORMAL)
342	return RTMsgErrorExit(RTEXITCODE_FAILURE, "The assembler failed: abend");
343	if (Status.iStatus != 0)
344	return RTMsgErrorExit((RTEXITCODE)Status.iStatus, "The assembler failed: exit code %d", Status.iStatus);
345
346	return RTEXITCODE_SUCCESS;
347	}
348
349
350	/**
351	* Worker that does the boring bits when generating a file.
352	*
353	* @returns Exit code.
354	* @param pszOutput The name of the output file.
355	* @param pszWhat What kind of file it is.
356	* @param pfnGenerator The callback function that provides the contents
357	* of the file.
358	*/
359	static RTEXITCODE generateFile(const char pszOutput, const char pszWhat,
360	RTEXITCODE (*pfnGenerator)(PSCMSTREAM))
361	{
362	SCMSTREAM Strm;
363	int rc = ScmStreamInitForWriting(&Strm, NULL);
364	if (RT_FAILURE(rc))
365	return RTMsgErrorExit(RTEXITCODE_FAILURE, "ScmStreamInitForWriting returned %Rrc when generating the %s file",
366	rc, pszWhat);
367
368	RTEXITCODE rcExit = pfnGenerator(&Strm);
369	if (RT_FAILURE(ScmStreamGetStatus(&Strm)))
370	rcExit = RTMsgErrorExit(RTEXITCODE_FAILURE, "Stream error %Rrc generating the %s file",
371	ScmStreamGetStatus(&Strm), pszWhat);
372	if (rcExit == RTEXITCODE_SUCCESS)
373	{
374	rc = ScmStreamWriteToFile(&Strm, "%s", pszOutput);
375	if (RT_FAILURE(rc))
376	rcExit = RTMsgErrorExit(RTEXITCODE_FAILURE, "ScmStreamWriteToFile returned %Rrc when writing '%s' (%s)",
377	rc, pszOutput, pszWhat);
378	if (rcExit == RTEXITCODE_SUCCESS)
379	{
380	if (g_cVerbosity > 0)
381	RTMsgInfo("Successfully generated '%s'.", pszOutput);
382	if (g_cVerbosity > 1)
383	{
384	RTMsgInfo("================ %s - start ================", pszWhat);
385	ScmStreamRewindForReading(&Strm);
386	const char *pszLine;
387	size_t cchLine;
388	SCMEOL enmEol;
389	while ((pszLine = ScmStreamGetLine(&Strm, &cchLine, &enmEol)) != NULL)
390	RTPrintf("%.*s\n", cchLine, pszLine);
391	RTMsgInfo("================ %s - end ================", pszWhat);
392	}
393	}
394	}
395	ScmStreamDelete(&Strm);
396	return rcExit;
397	}
398
399
400	/**
401	* @callback_method_impl{FNRTSTRSPACECALLBACK, Writes the string table strings.}
402	*/
403	static DECLCALLBACK(int) generateAssemblyStrTabCallback(PRTSTRSPACECORE pStr, void *pvUser)
404	{
405	PVTGSTRING pVtgStr = (PVTGSTRING)pStr;
406	PSCMSTREAM pStrm = (PSCMSTREAM)pvUser;
407
408	pVtgStr->offStrTab = g_offStrTab;
409	g_offStrTab += (uint32_t)pVtgStr->Core.cchString + 1;
410
411	ScmStreamPrintf(pStrm,
412	" db '%s', 0 ; off=%u len=%zu\n",
413	pVtgStr->szString, pVtgStr->offStrTab, pVtgStr->Core.cchString);
414	return VINF_SUCCESS;
415	}
416
417
418	/**
419	* Generate assembly source that can be turned into an object file.
420	*
421	* (This is a generateFile callback.)
422	*
423	* @returns Exit code.
424	* @param pStrm The output stream.
425	*/
426	static RTEXITCODE generateAssembly(PSCMSTREAM pStrm)
427	{
428	PVTGPROVIDER pProvider;
429	PVTGPROBE pProbe;
430	PVTGARG pArg;
431
432
433	if (g_cVerbosity > 0)
434	RTMsgInfo("Generating assembly code...");
435
436	/*
437	* Write the file header.
438	*/
439	ScmStreamPrintf(pStrm,
440	"; $Id: VBoxTpG.cpp 58976 2015-12-03 21:42:04Z vboxsync $ \n"
441	";; @file\n"
442	"; Automatically generated from %s. Do NOT edit!\n"
443	";\n"
444	"\n"
445	"%%include \"iprt/asmdefs.mac\"\n"
446	"\n"
447	"\n"
448	";"
449	"; We put all the data in a dedicated section / segment.\n"
450	";\n"
451	"; In order to find the probe location specifiers, we do the necessary\n"
452	"; trickery here, ASSUMING that this object comes in first in the link\n"
453	"; editing process.\n"
454	";\n"
455	"%%ifdef ASM_FORMAT_OMF\n"
456	" %%macro VTG_GLOBAL 2\n"
457	" global NAME(%%1)\n"
458	" NAME(%%1):\n"
459	" %%endmacro\n"
460	" segment VTG.Obj public CLASS=VTG align=4096 use32\n"
461	"\n"
462	"%%elifdef ASM_FORMAT_MACHO\n"
463	" %%macro VTG_GLOBAL 2\n"
464	" global NAME(%%1)\n"
465	" NAME(%%1):\n"
466	" %%endmacro\n"
467	" %%ifdef IN_RING3\n"
468	" %%define VTG_NEW_MACHO_LINKER\n"
469	" %%elif ARCH_BITS == 64\n"
470	" %%define VTG_NEW_MACHO_LINKER\n"
471	" %%elifdef IN_RING0_AGNOSTIC\n"
472	" %%define VTG_NEW_MACHO_LINKER\n"
473	" %%endif\n"
474	" %%ifdef VTG_NEW_MACHO_LINKER\n"
475	" ; Section order hack!\n"
476	" ; With the ld64-97.17 linker there was a problem with it determining the section\n"
477	" ; order based on symbol references. The references to the start and end of the\n"
478	" ; __VTGPrLc section forced it in front of __VTGObj, we want __VTGObj first.\n"
479	" extern section$start$__VTG$__VTGObj\n"
480	" extern section$end$__VTG$__VTGObj\n"
481	" %%else\n"
482	" ; Creating 32-bit kext of the type MH_OBJECT. No fancy section end/start symbols handy.\n"
483	" [section __VTG __VTGObj align=16]\n"
484	"VTG_GLOBAL g_aVTGObj_LinkerPleaseNoticeMe, data\n"
485	" [section __VTG __VTGPrLc.Begin align=16]\n"
486	" dq 0, 0 ; Paranoia, related to the fudge below.\n"
487	"VTG_GLOBAL g_aVTGPrLc, data\n"
488	" [section __VTG __VTGPrLc align=16]\n"
489	"VTG_GLOBAL g_aVTGPrLc_LinkerPleaseNoticeMe, data\n"
490	" [section __VTG __VTGPrLc.End align=16]\n"
491	"VTG_GLOBAL g_aVTGPrLc_End, data\n"
492	" dq 0, 0 ; Fudge to work around unidentified linker where it would otherwise generate\n"
493	" ; a fix up of the first dword in __VTGPrLc.Begin despite the fact that it were\n"
494	" ; an empty section with nothing whatsoever to fix up.\n"
495	" %%endif\n"
496	" [section __VTG __VTGObj]\n"
497	"\n"
498	"%%elifdef ASM_FORMAT_PE\n"
499	" %%macro VTG_GLOBAL 2\n"
500	" global NAME(%%1)\n"
501	" NAME(%%1):\n"
502	" %%endmacro\n"
503	" [section VTGPrLc.Begin data align=64]\n"
504	/" times 16 db 0xcc\n"/
505	"VTG_GLOBAL g_aVTGPrLc, data\n"
506	" [section VTGPrLc.Data data align=4]\n"
507	" [section VTGPrLc.End data align=4]\n"
508	"VTG_GLOBAL g_aVTGPrLc_End, data\n"
509	/" times 16 db 0xcc\n"/
510	" [section VTGObj data align=32]\n"
511	"\n"
512	"%%elifdef ASM_FORMAT_ELF\n"
513	" %%macro VTG_GLOBAL 2\n"
514	" global NAME(%%1):%%2 hidden\n"
515	" NAME(%%1):\n"
516	" %%endmacro\n"
517	" [section .VTGData progbits alloc noexec write align=4096]\n"
518	" [section .VTGPrLc.Begin progbits alloc noexec write align=32]\n"
519	" dd 0,0,0,0, 0,0,0,0\n"
520	"VTG_GLOBAL g_aVTGPrLc, data\n"
521	" [section .VTGPrLc progbits alloc noexec write align=1]\n"
522	" [section .VTGPrLc.End progbits alloc noexec write align=1]\n"
523	"VTG_GLOBAL g_aVTGPrLc_End, data\n"
524	" dd 0,0,0,0, 0,0,0,0\n"
525	" [section .VTGData]\n"
526	"\n"
527	"%%else\n"
528	" %%error \"ASM_FORMAT_XXX is not defined\"\n"
529	"%%endif\n"
530	"\n"
531	"\n"
532	"VTG_GLOBAL g_VTGObjHeader, data\n"
533	" ;0 1 2 3\n"
534	" ;012345678901234567890123456789012\n"
535	" db 'VTG Object Header v1.7', 0, 0\n"
536	" dd %u\n"
537	" dd NAME(g_acVTGProbeEnabled_End) - NAME(g_VTGObjHeader)\n"
538	" dd NAME(g_achVTGStringTable) - NAME(g_VTGObjHeader)\n"
539	" dd NAME(g_achVTGStringTable_End) - NAME(g_achVTGStringTable)\n"
540	" dd NAME(g_aVTGArgLists) - NAME(g_VTGObjHeader)\n"
541	" dd NAME(g_aVTGArgLists_End) - NAME(g_aVTGArgLists)\n"
542	" dd NAME(g_aVTGProbes) - NAME(g_VTGObjHeader)\n"
543	" dd NAME(g_aVTGProbes_End) - NAME(g_aVTGProbes)\n"
544	" dd NAME(g_aVTGProviders) - NAME(g_VTGObjHeader)\n"
545	" dd NAME(g_aVTGProviders_End) - NAME(g_aVTGProviders)\n"
546	" dd NAME(g_acVTGProbeEnabled) - NAME(g_VTGObjHeader)\n"
547	" dd NAME(g_acVTGProbeEnabled_End) - NAME(g_acVTGProbeEnabled)\n"
548	" dd 0\n"
549	" dd 0\n"
550	"%%ifdef VTG_NEW_MACHO_LINKER\n"
551	" extern section$start$__VTG$__VTGPrLc\n"
552	" RTCCPTR_DEF section$start$__VTG$__VTGPrLc\n"
553	" %%if ARCH_BITS == 32\n"
554	" dd 0\n"
555	" %%endif\n"
556	" extern section$end$__VTG$__VTGPrLc\n"
557	" RTCCPTR_DEF section$end$__VTG$__VTGPrLc\n"
558	" %%if ARCH_BITS == 32\n"
559	" dd 0\n"
560	" %%endif\n"
561	"%%else\n"
562	" RTCCPTR_DEF NAME(g_aVTGPrLc)\n"
563	" %%if ARCH_BITS == 32\n"
564	" dd 0\n"
565	" %%endif\n"
566	" RTCCPTR_DEF NAME(g_aVTGPrLc_End)\n"
567	" %%if ARCH_BITS == 32\n"
568	" dd 0\n"
569	" %%endif\n"
570	"%%endif\n"
571	,
572	g_pszScript, g_cBits);
573	RTUUID Uuid;
574	int rc = RTUuidCreate(&Uuid);
575	if (RT_FAILURE(rc))
576	return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTUuidCreate failed: %Rrc", rc);
577	ScmStreamPrintf(pStrm,
578	" dd 0%08xh, 0%08xh, 0%08xh, 0%08xh\n"
579	"%%ifdef VTG_NEW_MACHO_LINKER\n"
580	" RTCCPTR_DEF section$start$__VTG$__VTGObj\n"
581	" %%if ARCH_BITS == 32\n"
582	" dd 0\n"
583	" %%endif\n"
584	"%%else\n"
585	" dd 0, 0\n"
586	"%%endif\n"
587	" dd 0, 0\n"
588	, Uuid.au32[0], Uuid.au32[1], Uuid.au32[2], Uuid.au32[3]);
589
590	/*
591	* Dump the string table before we start using the strings.
592	*/
593	ScmStreamPrintf(pStrm,
594	"\n"
595	";\n"
596	"; The string table.\n"
597	";\n"
598	"VTG_GLOBAL g_achVTGStringTable, data\n");
599	g_offStrTab = 0;
600	RTStrSpaceEnumerate(&g_StrSpace, generateAssemblyStrTabCallback, pStrm);
601	ScmStreamPrintf(pStrm,
602	"VTG_GLOBAL g_achVTGStringTable_End, data\n");
603
604	/*
605	* Write out the argument lists before we use them.
606	*/
607	ScmStreamPrintf(pStrm,
608	"\n"
609	";\n"
610	"; The argument lists.\n"
611	";\n"
612	"ALIGNDATA(16)\n"
613	"VTG_GLOBAL g_aVTGArgLists, data\n");
614	uint32_t off = 0;
615	RTListForEach(&g_ProviderHead, pProvider, VTGPROVIDER, ListEntry)
616	{
617	RTListForEach(&pProvider->ProbeHead, pProbe, VTGPROBE, ListEntry)
618	{
619	if (pProbe->offArgList != UINT32_MAX)
620	continue;
621
622	/* Write it. */
623	pProbe->offArgList = off;
624	ScmStreamPrintf(pStrm,
625	" ; off=%u\n"
626	" db %2u ; Argument count\n"
627	" db %u ; fHaveLargeArgs\n"
628	" db 0, 0 ; Reserved\n"
629	, off, pProbe->cArgs, (int)pProbe->fHaveLargeArgs);
630	off += 4;
631	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
632	{
633	ScmStreamPrintf(pStrm,
634	" dd %8u ; type '%s' (name '%s')\n"
635	" dd 0%08xh ; type flags\n",
636	strtabGetOff(pArg->pszTracerType), pArg->pszTracerType, pArg->pszName,
637	pArg->fType);
638	off += 8;
639	}
640
641	/* Look for matching argument lists (lazy bird walks the whole list). */
642	PVTGPROVIDER pProv2;
643	RTListForEach(&g_ProviderHead, pProv2, VTGPROVIDER, ListEntry)
644	{
645	PVTGPROBE pProbe2;
646	RTListForEach(&pProvider->ProbeHead, pProbe2, VTGPROBE, ListEntry)
647	{
648	if (pProbe2->offArgList != UINT32_MAX)
649	continue;
650	if (pProbe2->cArgs != pProbe->cArgs)
651	continue;
652
653	PVTGARG pArg2;
654	pArg = RTListNodeGetNext(&pProbe->ArgHead, VTGARG, ListEntry);
655	pArg2 = RTListNodeGetNext(&pProbe2->ArgHead, VTGARG, ListEntry);
656	int32_t cArgs = pProbe->cArgs;
657	while ( cArgs-- > 0
658	&& pArg2->pszTracerType == pArg->pszTracerType
659	&& pArg2->fType == pArg->fType)
660	{
661	pArg = RTListNodeGetNext(&pArg->ListEntry, VTGARG, ListEntry);
662	pArg2 = RTListNodeGetNext(&pArg2->ListEntry, VTGARG, ListEntry);
663	}
664	if (cArgs >= 0)
665	continue;
666	pProbe2->offArgList = pProbe->offArgList;
667	}
668	}
669	}
670	}
671	ScmStreamPrintf(pStrm,
672	"VTG_GLOBAL g_aVTGArgLists_End, data\n");
673
674
675	/*
676	* Probe definitions.
677	*/
678	ScmStreamPrintf(pStrm,
679	"\n"
680	";\n"
681	"; Prob definitions.\n"
682	";\n"
683	"ALIGNDATA(16)\n"
684	"VTG_GLOBAL g_aVTGProbes, data\n"
685	"\n");
686	uint32_t iProvider = 0;
687	uint32_t iProbe = 0;
688	RTListForEach(&g_ProviderHead, pProvider, VTGPROVIDER, ListEntry)
689	{
690	pProvider->iFirstProbe = iProbe;
691	RTListForEach(&pProvider->ProbeHead, pProbe, VTGPROBE, ListEntry)
692	{
693	ScmStreamPrintf(pStrm,
694	"VTG_GLOBAL g_VTGProbeData_%s_%s, data ; idx=#%4u\n"
695	" dd %6u ; offName\n"
696	" dd %6u ; offArgList\n"
697	" dw (NAME(g_cVTGProbeEnabled_%s_%s) - NAME(g_acVTGProbeEnabled)) / 4 ; idxEnabled\n"
698	" dw %6u ; idxProvider\n"
699	" dd NAME(g_VTGObjHeader) - NAME(g_VTGProbeData_%s_%s) ; offObjHdr\n"
700	,
701	pProvider->pszName, pProbe->pszMangledName, iProbe,
702	strtabGetOff(pProbe->pszUnmangledName),
703	pProbe->offArgList,
704	pProvider->pszName, pProbe->pszMangledName,
705	iProvider,
706	pProvider->pszName, pProbe->pszMangledName
707	);
708	pProbe->iProbe = iProbe;
709	iProbe++;
710	}
711	pProvider->cProbes = iProbe - pProvider->iFirstProbe;
712	iProvider++;
713	}
714	ScmStreamPrintf(pStrm, "VTG_GLOBAL g_aVTGProbes_End, data\n");
715
716	/*
717	* The provider data.
718	*/
719	ScmStreamPrintf(pStrm,
720	"\n"
721	";\n"
722	"; Provider data.\n"
723	";\n"
724	"ALIGNDATA(16)\n"
725	"VTG_GLOBAL g_aVTGProviders, data\n");
726	iProvider = 0;
727	RTListForEach(&g_ProviderHead, pProvider, VTGPROVIDER, ListEntry)
728	{
729	ScmStreamPrintf(pStrm,
730	" ; idx=#%4u - %s\n"
731	" dd %6u ; name\n"
732	" dw %6u ; index of first probe\n"
733	" dw %6u ; count of probes\n"
734	" db %d, %d, %d ; AttrSelf\n"
735	" db %d, %d, %d ; AttrModules\n"
736	" db %d, %d, %d ; AttrFunctions\n"
737	" db %d, %d, %d ; AttrName\n"
738	" db %d, %d, %d ; AttrArguments\n"
739	" db 0 ; reserved\n"
740	"VTG_GLOBAL g_cVTGProviderProbesEnabled_%s, data\n"
741	" dd 0\n"
742	"VTG_GLOBAL g_cVTGProviderSettingsSeqNo_%s, data\n"
743	" dd 0\n"
744	,
745	iProvider, pProvider->pszName,
746	strtabGetOff(pProvider->pszName),
747	pProvider->iFirstProbe,
748	pProvider->cProbes,
749	pProvider->AttrSelf.enmCode, pProvider->AttrSelf.enmData, pProvider->AttrSelf.enmDataDep,
750	pProvider->AttrModules.enmCode, pProvider->AttrModules.enmData, pProvider->AttrModules.enmDataDep,
751	pProvider->AttrFunctions.enmCode, pProvider->AttrFunctions.enmData, pProvider->AttrFunctions.enmDataDep,
752	pProvider->AttrName.enmCode, pProvider->AttrName.enmData, pProvider->AttrName.enmDataDep,
753	pProvider->AttrArguments.enmCode, pProvider->AttrArguments.enmData, pProvider->AttrArguments.enmDataDep,
754	pProvider->pszName,
755	pProvider->pszName);
756	iProvider++;
757	}
758	ScmStreamPrintf(pStrm, "VTG_GLOBAL g_aVTGProviders_End, data\n");
759
760	/*
761	* Declare the probe enable flags.
762	*
763	* These must be placed at the end so they'll end up adjacent to the probe
764	* locations. This is important for reducing the amount of memory we need
765	* to lock down for user mode modules.
766	*/
767	ScmStreamPrintf(pStrm,
768	";\n"
769	"; Probe enabled flags.\n"
770	";\n"
771	"ALIGNDATA(16)\n"
772	"VTG_GLOBAL g_acVTGProbeEnabled, data\n"
773	);
774	uint32_t cProbes = 0;
775	RTListForEach(&g_ProviderHead, pProvider, VTGPROVIDER, ListEntry)
776	{
777	RTListForEach(&pProvider->ProbeHead, pProbe, VTGPROBE, ListEntry)
778	{
779	ScmStreamPrintf(pStrm,
780	"VTG_GLOBAL g_cVTGProbeEnabled_%s_%s, data\n"
781	" dd 0\n",
782	pProvider->pszName, pProbe->pszMangledName);
783	cProbes++;
784	}
785	}
786	ScmStreamPrintf(pStrm, "VTG_GLOBAL g_acVTGProbeEnabled_End, data\n");
787	if (cProbes >= _32K)
788	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Too many probes: %u (max %u)", cProbes, _32K - 1);
789
790
791	/*
792	* Emit code for the stub functions.
793	*/
794	bool const fWin64 = g_cBits == 64 && (!strcmp(g_pszAssemblerFmtVal, "win64") \|\| !strcmp(g_pszAssemblerFmtVal, "pe64"));
795	bool const fElf = !strcmp(g_pszAssemblerFmtVal, "elf32") \|\| !strcmp(g_pszAssemblerFmtVal, "elf64");
796	ScmStreamPrintf(pStrm,
797	"\n"
798	";\n"
799	"; Prob stubs.\n"
800	";\n"
801	"BEGINCODE\n"
802	);
803	if (g_fProbeFnImported)
804	ScmStreamPrintf(pStrm,
805	"EXTERN_IMP2 %s\n"
806	"BEGINCODE ; EXTERN_IMP2 changes section\n",
807	g_pszProbeFnName);
808	else
809	ScmStreamPrintf(pStrm, "extern NAME(%s)\n", g_pszProbeFnName);
810
811	RTListForEach(&g_ProviderHead, pProvider, VTGPROVIDER, ListEntry)
812	{
813	RTListForEach(&pProvider->ProbeHead, pProbe, VTGPROBE, ListEntry)
814	{
815	ScmStreamPrintf(pStrm,
816	"\n"
817	"VTG_GLOBAL VTGProbeStub_%s_%s, function; (VBOXTPGPROBELOC pVTGProbeLoc",
818	pProvider->pszName, pProbe->pszMangledName);
819	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
820	{
821	ScmStreamPrintf(pStrm, ", %s %s", pArg->pszTracerType, pArg->pszName);
822	}
823	ScmStreamPrintf(pStrm,
824	");\n");
825
826	/*
827	* Check if the probe in question is enabled.
828	*/
829	if (g_cBits == 32)
830	ScmStreamPrintf(pStrm,
831	" mov eax, [esp + 4]\n"
832	" test byte [eax+3], 0x80 ; fEnabled == true?\n"
833	" jz .return ; jump on false\n");
834	else if (fWin64)
835	ScmStreamPrintf(pStrm,
836	" test byte [rcx+3], 0x80 ; fEnabled == true?\n"
837	" jz .return ; jump on false\n");
838	else
839	ScmStreamPrintf(pStrm,
840	" test byte [rdi+3], 0x80 ; fEnabled == true?\n"
841	" jz .return ; jump on false\n");
842
843	/*
844	* Jump to the fire-probe function.
845	*/
846	if (g_cBits == 32)
847	ScmStreamPrintf(pStrm, g_fPic && fElf ?
848	" jmp %s wrt ..plt\n"
849	: g_fProbeFnImported ?
850	" mov ecx, IMP2(%s)\n"
851	" jmp ecx\n"
852	:
853	" jmp NAME(%s)\n"
854	, g_pszProbeFnName);
855	else
856	ScmStreamPrintf(pStrm, g_fPic && fElf ?
857	" jmp [rel %s wrt ..got]\n"
858	: g_fProbeFnImported ?
859	" jmp IMP2(%s)\n"
860	:
861	" jmp NAME(%s)\n"
862	, g_pszProbeFnName);
863
864	ScmStreamPrintf(pStrm,
865	".return:\n"
866	" ret ; The probe was disabled, return\n"
867	"\n");
868	}
869	}
870
871	return RTEXITCODE_SUCCESS;
872	}
873
874
875	static RTEXITCODE generateObject(const char pszOutput, const char pszTempAsm)
876	{
877	if (!pszTempAsm)
878	{
879	size_t cch = strlen(pszOutput);
880	char psz = (char )alloca(cch + sizeof(".asm"));
881	memcpy(psz, pszOutput, cch);
882	memcpy(psz + cch, ".asm", sizeof(".asm"));
883	pszTempAsm = psz;
884	}
885
886	RTEXITCODE rcExit = generateFile(pszTempAsm, "assembly", generateAssembly);
887	if (rcExit == RTEXITCODE_SUCCESS)
888	rcExit = generateInvokeAssembler(pszOutput, pszTempAsm);
889	RTFileDelete(pszTempAsm);
890	return rcExit;
891	}
892
893
894	static RTEXITCODE generateProbeDefineName(char pszBuf, size_t cbBuf, const char pszProvider, const char *pszProbe)
895	{
896	size_t cbMax = strlen(pszProvider) + 1 + strlen(pszProbe) + 1;
897	if (cbMax > cbBuf \|\| cbMax > 80)
898	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Probe '%s' in provider '%s' ends up with a too long defined\n", pszProbe, pszProvider);
899
900	while (*pszProvider)
901	pszBuf++ = RT_C_TO_UPPER(pszProvider++);
902
903	*pszBuf++ = '_';
904
905	while (*pszProbe)
906	{
907	if (pszProbe[0] == '_' && pszProbe[1] == '_')
908	pszProbe++;
909	pszBuf++ = RT_C_TO_UPPER(pszProbe++);
910	}
911
912	*pszBuf = '\0';
913	return RTEXITCODE_SUCCESS;
914	}
915
916
917	static RTEXITCODE generateProviderDefineName(char pszBuf, size_t cbBuf, const char pszProvider)
918	{
919	size_t cbMax = strlen(pszProvider) + 1;
920	if (cbMax > cbBuf \|\| cbMax > 80)
921	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Provider '%s' ends up with a too long defined\n", pszProvider);
922
923	while (*pszProvider)
924	pszBuf++ = RT_C_TO_UPPER(pszProvider++);
925
926	*pszBuf = '\0';
927	return RTEXITCODE_SUCCESS;
928	}
929
930
931	/**
932	* Called via generateFile to generate the header file.
933	*
934	* @returns Exit code status.
935	* @param pStrm The output stream.
936	*/
937	static RTEXITCODE generateHeader(PSCMSTREAM pStrm)
938	{
939	/*
940	* Calc the double inclusion blocker define and then write the file header.
941	*/
942	char szTmp[4096];
943	const char *pszName = RTPathFilename(g_pszScript);
944	size_t cchName = strlen(pszName);
945	if (cchName >= sizeof(szTmp) - 64)
946	return RTMsgErrorExit(RTEXITCODE_FAILURE, "File name is too long '%s'", pszName);
947	szTmp[0] = '_';
948	szTmp[1] = '_';
949	szTmp[2] = '_';
950	memcpy(&szTmp[3], pszName, cchName);
951	szTmp[3 + cchName + 0] = '_';
952	szTmp[3 + cchName + 1] = '_';
953	szTmp[3 + cchName + 2] = '_';
954	szTmp[3 + cchName + 3] = '\0';
955	char *psz = &szTmp[3];
956	while (*psz)
957	{
958	if (!RT_C_IS_ALNUM(psz) && psz != '_')
959	*psz = '_';
960	psz++;
961	}
962
963	ScmStreamPrintf(pStrm,
964	"/* $Id: VBoxTpG.cpp 58976 2015-12-03 21:42:04Z vboxsync $ */\n"
965	"/** @file\n"
966	" * Automatically generated from %s. Do NOT edit!\n"
967	" */\n"
968	"\n"
969	"#ifndef %s\n"
970	"#define %s\n"
971	"\n"
972	"#include <VBox/VBoxTpG.h>\n"
973	"\n"
974	"#ifndef %s\n"
975	"# error \"Expected '%s' to be defined\"\n"
976	"#endif\n"
977	"\n"
978	"RT_C_DECLS_BEGIN\n"
979	"\n"
980	"#ifdef VBOX_WITH_DTRACE\n"
981	"\n"
982	"# ifdef _MSC_VER\n"
983	"# pragma data_seg(VTG_LOC_SECT)\n"
984	"# pragma data_seg()\n"
985	"# endif\n"
986	"\n"
987	,
988	g_pszScript,
989	szTmp,
990	szTmp,
991	g_pszContextDefine,
992	g_pszContextDefine);
993
994	/*
995	* Declare data, code and macros for each probe.
996	*/
997	PVTGPROVIDER pProv;
998	PVTGPROBE pProbe;
999	PVTGARG pArg;
1000	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1001	{
1002	/* This macro is not available in ring-3 because we don't have
1003	anything similar available for native dtrace. */
1004	ScmStreamPrintf(pStrm, "\n\n");
1005	if (g_fTypeContext != VTG_TYPE_CTX_R3)
1006	{
1007	generateProviderDefineName(szTmp, sizeof(szTmp), pProv->pszName);
1008	ScmStreamPrintf(pStrm,
1009	"extern uint32_t const volatile g_cVTGProviderProbesEnabled_%s;\n"
1010	"# define %s_ANY_PROBES_ENABLED() \\\n"
1011	" (RT_UNLIKELY(g_cVTGProviderProbesEnabled_%s != 0))\n"
1012	"extern uint32_t const volatile g_cVTGProviderSettingsSeqNo_%s;\n"
1013	"# define %s_GET_SETTINGS_SEQ_NO() (g_cVTGProviderSettingsSeqNo_%s)\n"
1014	"\n",
1015	pProv->pszName,
1016	szTmp, pProv->pszName,
1017	pProv->pszName,
1018	szTmp, pProv->pszName);
1019	}
1020
1021	RTListForEach(&pProv->ProbeHead, pProbe, VTGPROBE, ListEntry)
1022	{
1023	PVTGARG const pFirstArg = RTListGetFirst(&pProbe->ArgHead, VTGARG, ListEntry);
1024
1025	ScmStreamPrintf(pStrm,
1026	"extern uint32_t g_cVTGProbeEnabled_%s_%s;\n"
1027	"extern VTGDESCPROBE g_VTGProbeData_%s_%s;\n"
1028	"DECLASM(void) VTGProbeStub_%s_%s(PVTGPROBELOC",
1029	pProv->pszName, pProbe->pszMangledName,
1030	pProv->pszName, pProbe->pszMangledName,
1031	pProv->pszName, pProbe->pszMangledName);
1032	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1033	{
1034	ScmStreamPrintf(pStrm, ", %s", pArg->pszCtxType);
1035	}
1036	generateProbeDefineName(szTmp, sizeof(szTmp), pProv->pszName, pProbe->pszMangledName);
1037	ScmStreamPrintf(pStrm,
1038	");\n"
1039	"# define %s_ENABLED() (RT_UNLIKELY(g_cVTGProbeEnabled_%s_%s != 0))\n"
1040	"# define %s_ENABLED_RAW() (g_cVTGProbeEnabled_%s_%s)\n"
1041	"# define %s("
1042	,
1043	szTmp, pProv->pszName, pProbe->pszMangledName,
1044	szTmp, pProv->pszName, pProbe->pszMangledName,
1045	szTmp);
1046	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1047	{
1048	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1049	ScmStreamPrintf(pStrm, "%s", pArg->pszName);
1050	else
1051	ScmStreamPrintf(pStrm, ", %s", pArg->pszName);
1052	}
1053	ScmStreamPrintf(pStrm,
1054	") \\\n"
1055	" do { \\\n"
1056	" if (RT_UNLIKELY(g_cVTGProbeEnabled_%s_%s)) \\\n"
1057	" { \\\n"
1058	" VTG_DECL_VTGPROBELOC(s_VTGProbeLoc) = \\\n"
1059	" { __LINE__, 0, 0, __FUNCTION__, &g_VTGProbeData_%s_%s }; \\\n"
1060	" VTGProbeStub_%s_%s(&s_VTGProbeLoc",
1061	pProv->pszName, pProbe->pszMangledName,
1062	pProv->pszName, pProbe->pszMangledName,
1063	pProv->pszName, pProbe->pszMangledName);
1064	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1065	{
1066	ScmStreamPrintf(pStrm, pArg->pszArgPassingFmt, pArg->pszName);
1067	}
1068	ScmStreamPrintf(pStrm,
1069	"); \\\n"
1070	" } \\\n"
1071	" { \\\n" );
1072	uint32_t iArg = 0;
1073	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1074	{
1075	if ((pArg->fType & (VTG_TYPE_FIXED_SIZED \| VTG_TYPE_AUTO_CONV_PTR)) == VTG_TYPE_FIXED_SIZED)
1076	ScmStreamPrintf(pStrm,
1077	" AssertCompile(sizeof(%s) == %u); \\\n"
1078	" AssertCompile(sizeof(%s) <= %u); \\\n",
1079	pArg->pszTracerType, pArg->fType & VTG_TYPE_SIZE_MASK,
1080	pArg->pszName, pArg->fType & VTG_TYPE_SIZE_MASK);
1081	else if (pArg->fType & (VTG_TYPE_POINTER \| VTG_TYPE_HC_ARCH_SIZED))
1082	ScmStreamPrintf(pStrm,
1083	" AssertCompile(sizeof(%s) <= sizeof(uintptr_t)); \\\n"
1084	" AssertCompile(sizeof(%s) <= sizeof(uintptr_t)); \\\n",
1085	pArg->pszName,
1086	pArg->pszTracerType);
1087	iArg++;
1088	}
1089	ScmStreamPrintf(pStrm,
1090	" } \\\n"
1091	" } while (0)\n"
1092	"\n");
1093	}
1094	}
1095
1096	ScmStreamPrintf(pStrm,
1097	"\n"
1098	"#else\n"
1099	"\n");
1100	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1101	{
1102	RTListForEach(&pProv->ProbeHead, pProbe, VTGPROBE, ListEntry)
1103	{
1104	generateProbeDefineName(szTmp, sizeof(szTmp), pProv->pszName, pProbe->pszMangledName);
1105	ScmStreamPrintf(pStrm,
1106	"# define %s_ENABLED() (false)\n"
1107	"# define %s("
1108	, szTmp, szTmp);
1109	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1110	{
1111	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1112	ScmStreamPrintf(pStrm, "%s", pArg->pszName);
1113	else
1114	ScmStreamPrintf(pStrm, ", %s", pArg->pszName);
1115	}
1116	ScmStreamPrintf(pStrm,
1117	") do { } while (0)\n");
1118	}
1119	}
1120
1121	ScmStreamWrite(pStrm, RT_STR_TUPLE("\n"
1122	"#endif\n"
1123	"\n"
1124	"RT_C_DECLS_END\n"
1125	"#endif\n"));
1126	return RTEXITCODE_SUCCESS;
1127	}
1128
1129
1130	/**
1131	* Called via generateFile to generate the wrapper header file.
1132	*
1133	* @returns Exit code status.
1134	* @param pStrm The output stream.
1135	*/
1136	static RTEXITCODE generateWrapperHeader(PSCMSTREAM pStrm)
1137	{
1138	/*
1139	* Calc the double inclusion blocker define and then write the file header.
1140	*/
1141	char szTmp[4096];
1142	const char *pszName = RTPathFilename(g_pszScript);
1143	size_t cchName = strlen(pszName);
1144	if (cchName >= sizeof(szTmp) - 64)
1145	return RTMsgErrorExit(RTEXITCODE_FAILURE, "File name is too long '%s'", pszName);
1146	szTmp[0] = '_';
1147	szTmp[1] = '_';
1148	szTmp[2] = '_';
1149	memcpy(&szTmp[3], pszName, cchName);
1150	strcpy(&szTmp[3 + cchName ], "___WRAPPER___");
1151	char *psz = &szTmp[3];
1152	while (*psz)
1153	{
1154	if (!RT_C_IS_ALNUM(psz) && psz != '_')
1155	*psz = '_';
1156	psz++;
1157	}
1158
1159	ScmStreamPrintf(pStrm,
1160	"/* $Id: VBoxTpG.cpp 58976 2015-12-03 21:42:04Z vboxsync $ */\n"
1161	"/** @file\n"
1162	" * Automatically generated from %s. Do NOT edit!\n"
1163	" */\n"
1164	"\n"
1165	"#ifndef %s\n"
1166	"#define %s\n"
1167	"\n"
1168	"#include <VBox/VBoxTpG.h>\n"
1169	"\n"
1170	"#ifndef %s\n"
1171	"# error \"Expected '%s' to be defined\"\n"
1172	"#endif\n"
1173	"\n"
1174	"#ifdef VBOX_WITH_DTRACE\n"
1175	"\n"
1176	,
1177	g_pszScript,
1178	szTmp,
1179	szTmp,
1180	g_pszContextDefine,
1181	g_pszContextDefine);
1182
1183	/*
1184	* Declare macros for each probe.
1185	*/
1186	PVTGPROVIDER pProv;
1187	PVTGPROBE pProbe;
1188	PVTGARG pArg;
1189	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1190	{
1191	RTListForEach(&pProv->ProbeHead, pProbe, VTGPROBE, ListEntry)
1192	{
1193	PVTGARG const pFirstArg = RTListGetFirst(&pProbe->ArgHead, VTGARG, ListEntry);
1194
1195	generateProbeDefineName(szTmp, sizeof(szTmp), pProv->pszName, pProbe->pszMangledName);
1196	ScmStreamPrintf(pStrm,
1197	"# define %s("
1198	, szTmp);
1199	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1200	{
1201	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1202	ScmStreamPrintf(pStrm, "%s", pArg->pszName);
1203	else
1204	ScmStreamPrintf(pStrm, ", %s", pArg->pszName);
1205	}
1206	ScmStreamPrintf(pStrm,
1207	") \\\n"
1208	" do { \\\n"
1209	" if (RT_UNLIKELY(%s_ENABLED())) \\\n"
1210	" { \\\n"
1211	" %s_ORIGINAL("
1212	, szTmp, szTmp);
1213	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1214	{
1215	const char *pszFmt = pArg->pszArgPassingFmt;
1216	if (pArg->fType & VTG_TYPE_AUTO_CONV_PTR)
1217	{
1218	/* Casting is required. ASSUMES sizeof(RTR0PTR) == sizeof(RTR3PTR) - safe! */
1219	pszFmt += sizeof(", ") - 1;
1220	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1221	ScmStreamPrintf(pStrm, "(%s)%M", pArg->pszTracerType, pszFmt, pArg->pszName);
1222	else
1223	ScmStreamPrintf(pStrm, ", (%s)%M", pArg->pszTracerType, pszFmt, pArg->pszName);
1224	}
1225	else if (pArg->fType & VTG_TYPE_CONST_CHAR_PTR)
1226	{
1227	/* Casting from 'const char ' (probe) to 'char ' (dtrace) is required to shut up warnings. */
1228	pszFmt += sizeof(", ") - 1;
1229	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1230	ScmStreamPrintf(pStrm, "(char *)%M", pszFmt, pArg->pszName);
1231	else
1232	ScmStreamPrintf(pStrm, ", (char *)%M", pszFmt, pArg->pszName);
1233	}
1234	else
1235	{
1236	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1237	ScmStreamPrintf(pStrm, pArg->pszArgPassingFmt + sizeof(", ") - 1, pArg->pszName);
1238	else
1239	ScmStreamPrintf(pStrm, pArg->pszArgPassingFmt, pArg->pszName);
1240	}
1241	}
1242	ScmStreamPrintf(pStrm,
1243	"); \\\n"
1244	" } \\\n"
1245	" } while (0)\n"
1246	"\n");
1247	}
1248	}
1249
1250	ScmStreamPrintf(pStrm,
1251	"\n"
1252	"#else\n"
1253	"\n");
1254	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1255	{
1256	RTListForEach(&pProv->ProbeHead, pProbe, VTGPROBE, ListEntry)
1257	{
1258	generateProbeDefineName(szTmp, sizeof(szTmp), pProv->pszName, pProbe->pszMangledName);
1259	ScmStreamPrintf(pStrm,
1260	"# define %s("
1261	, szTmp);
1262	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1263	{
1264	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1265	ScmStreamPrintf(pStrm, "%s", pArg->pszName);
1266	else
1267	ScmStreamPrintf(pStrm, ", %s", pArg->pszName);
1268	}
1269	ScmStreamPrintf(pStrm,
1270	") do { } while (0)\n");
1271	}
1272	}
1273
1274	ScmStreamWrite(pStrm, RT_STR_TUPLE("\n"
1275	"#endif\n"
1276	"\n"
1277	"#endif\n"));
1278	return RTEXITCODE_SUCCESS;
1279	}
1280
1281
1282	/**
1283	* Parser error with line and position.
1284	*
1285	* @returns RTEXITCODE_FAILURE.
1286	* @param pStrm The stream.
1287	* @param cb The offset from the current position to the
1288	* point of failure.
1289	* @param pszMsg The message to display.
1290	*/
1291	static RTEXITCODE parseError(PSCMSTREAM pStrm, size_t cb, const char *pszMsg)
1292	{
1293	if (cb)
1294	ScmStreamSeekRelative(pStrm, -(ssize_t)cb);
1295	size_t const off = ScmStreamTell(pStrm);
1296	size_t const iLine = ScmStreamTellLine(pStrm);
1297	ScmStreamSeekByLine(pStrm, iLine);
1298	size_t const offLine = ScmStreamTell(pStrm);
1299
1300	RTPrintf("%s:%d:%zd: error: %s.\n", g_pszScript, iLine + 1, off - offLine + 1, pszMsg);
1301
1302	size_t cchLine;
1303	SCMEOL enmEof;
1304	const char *pszLine = ScmStreamGetLineByNo(pStrm, iLine, &cchLine, &enmEof);
1305	if (pszLine)
1306	RTPrintf(" %.*s\n"
1307	" %*s^\n",
1308	cchLine, pszLine, off - offLine, "");
1309	return RTEXITCODE_FAILURE;
1310	}
1311
1312
1313	/**
1314	* Parser error with line and position.
1315	*
1316	* @returns RTEXITCODE_FAILURE.
1317	* @param pStrm The stream.
1318	* @param cb The offset from the current position to the
1319	* point of failure.
1320	* @param pszMsg The message to display.
1321	*/
1322	static RTEXITCODE parseErrorAbs(PSCMSTREAM pStrm, size_t off, const char *pszMsg)
1323	{
1324	ScmStreamSeekAbsolute(pStrm, off);
1325	return parseError(pStrm, 0, pszMsg);
1326	}
1327
1328
1329	/**
1330	* Handles a C++ one line comment.
1331	*
1332	* @returns Exit code.
1333	* @param pStrm The stream.
1334	*/
1335	static RTEXITCODE parseOneLineComment(PSCMSTREAM pStrm)
1336	{
1337	ScmStreamSeekByLine(pStrm, ScmStreamTellLine(pStrm) + 1);
1338	return RTEXITCODE_SUCCESS;
1339	}
1340
1341
1342	/**
1343	* Handles a multi-line C/C++ comment.
1344	*
1345	* @returns Exit code.
1346	* @param pStrm The stream.
1347	*/
1348	static RTEXITCODE parseMultiLineComment(PSCMSTREAM pStrm)
1349	{
1350	unsigned ch;
1351	while ((ch = ScmStreamGetCh(pStrm)) != ~(unsigned)0)
1352	{
1353	if (ch == '*')
1354	{
1355	do
1356	ch = ScmStreamGetCh(pStrm);
1357	while (ch == '*');
1358	if (ch == '/')
1359	return RTEXITCODE_SUCCESS;
1360	}
1361	}
1362
1363	parseError(pStrm, 1, "Expected end of comment, got end of file");
1364	return RTEXITCODE_FAILURE;
1365	}
1366
1367
1368	/**
1369	* Skips spaces and comments.
1370	*
1371	* @returns RTEXITCODE_SUCCESS or RTEXITCODE_FAILURE.
1372	* @param pStrm The stream..
1373	*/
1374	static RTEXITCODE parseSkipSpacesAndComments(PSCMSTREAM pStrm)
1375	{
1376	unsigned ch;
1377	while ((ch = ScmStreamPeekCh(pStrm)) != ~(unsigned)0)
1378	{
1379	if (!RT_C_IS_SPACE(ch) && ch != '/')
1380	return RTEXITCODE_SUCCESS;
1381	unsigned ch2 = ScmStreamGetCh(pStrm); AssertBreak(ch == ch2); NOREF(ch2);
1382	if (ch == '/')
1383	{
1384	ch = ScmStreamGetCh(pStrm);
1385	RTEXITCODE rcExit;
1386	if (ch == '*')
1387	rcExit = parseMultiLineComment(pStrm);
1388	else if (ch == '/')
1389	rcExit = parseOneLineComment(pStrm);
1390	else
1391	rcExit = parseError(pStrm, 2, "Unexpected character");
1392	if (rcExit != RTEXITCODE_SUCCESS)
1393	return rcExit;
1394	}
1395	}
1396
1397	return parseError(pStrm, 0, "Unexpected end of file");
1398	}
1399
1400
1401	/**
1402	* Skips spaces and comments, returning the next character.
1403	*
1404	* @returns Next non-space-non-comment character. ~(unsigned)0 on EOF or
1405	* failure.
1406	* @param pStrm The stream.
1407	*/
1408	static unsigned parseGetNextNonSpaceNonCommentCh(PSCMSTREAM pStrm)
1409	{
1410	unsigned ch;
1411	while ((ch = ScmStreamGetCh(pStrm)) != ~(unsigned)0)
1412	{
1413	if (!RT_C_IS_SPACE(ch) && ch != '/')
1414	return ch;
1415	if (ch == '/')
1416	{
1417	ch = ScmStreamGetCh(pStrm);
1418	RTEXITCODE rcExit;
1419	if (ch == '*')
1420	rcExit = parseMultiLineComment(pStrm);
1421	else if (ch == '/')
1422	rcExit = parseOneLineComment(pStrm);
1423	else
1424	rcExit = parseError(pStrm, 2, "Unexpected character");
1425	if (rcExit != RTEXITCODE_SUCCESS)
1426	return ~(unsigned)0;
1427	}
1428	}
1429
1430	parseError(pStrm, 0, "Unexpected end of file");
1431	return ~(unsigned)0;
1432	}
1433
1434
1435	/**
1436	* Get the next non-space-non-comment character on a preprocessor line.
1437	*
1438	* @returns The next character. On error message and ~(unsigned)0.
1439	* @param pStrm The stream.
1440	*/
1441	static unsigned parseGetNextNonSpaceNonCommentChOnPpLine(PSCMSTREAM pStrm)
1442	{
1443	size_t off = ScmStreamTell(pStrm) - 1;
1444	unsigned ch;
1445	while ((ch = ScmStreamGetCh(pStrm)) != ~(unsigned)0)
1446	{
1447	if (RT_C_IS_SPACE(ch))
1448	{
1449	if (ch == '\n' \|\| ch == '\r')
1450	{
1451	parseErrorAbs(pStrm, off, "Invalid preprocessor statement");
1452	break;
1453	}
1454	}
1455	else if (ch == '\\')
1456	{
1457	size_t off2 = ScmStreamTell(pStrm) - 1;
1458	ch = ScmStreamGetCh(pStrm);
1459	if (ch == '\r')
1460	ch = ScmStreamGetCh(pStrm);
1461	if (ch != '\n')
1462	{
1463	parseErrorAbs(pStrm, off2, "Expected new line");
1464	break;
1465	}
1466	}
1467	else
1468	return ch;
1469	}
1470	return ~(unsigned)0;
1471	}
1472
1473
1474
1475	/**
1476	* Skips spaces and comments.
1477	*
1478	* @returns Same as ScmStreamCGetWord
1479	* @param pStrm The stream..
1480	* @param pcchWord Where to return the length.
1481	*/
1482	static const char parseGetNextCWord(PSCMSTREAM pStrm, size_t pcchWord)
1483	{
1484	if (parseSkipSpacesAndComments(pStrm) != RTEXITCODE_SUCCESS)
1485	return NULL;
1486	return ScmStreamCGetWord(pStrm, pcchWord);
1487	}
1488
1489
1490
1491	/**
1492	* Parses interface stability.
1493	*
1494	* @returns Interface stability if parsed correctly, otherwise error message and
1495	* kVTGStability_Invalid.
1496	* @param pStrm The stream.
1497	* @param ch The first character in the stability spec.
1498	*/
1499	static kVTGStability parseStability(PSCMSTREAM pStrm, unsigned ch)
1500	{
1501	switch (ch)
1502	{
1503	case 'E':
1504	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("External")))
1505	return kVTGStability_External;
1506	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Evolving")))
1507	return kVTGStability_Evolving;
1508	break;
1509	case 'I':
1510	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Internal")))
1511	return kVTGStability_Internal;
1512	break;
1513	case 'O':
1514	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Obsolete")))
1515	return kVTGStability_Obsolete;
1516	break;
1517	case 'P':
1518	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Private")))
1519	return kVTGStability_Private;
1520	break;
1521	case 'S':
1522	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Stable")))
1523	return kVTGStability_Stable;
1524	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Standard")))
1525	return kVTGStability_Standard;
1526	break;
1527	case 'U':
1528	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Unstable")))
1529	return kVTGStability_Unstable;
1530	break;
1531	}
1532	parseError(pStrm, 1, "Unknown stability specifier");
1533	return kVTGStability_Invalid;
1534	}
1535
1536
1537	/**
1538	* Parses data depndency class.
1539	*
1540	* @returns Data dependency class if parsed correctly, otherwise error message
1541	* and kVTGClass_Invalid.
1542	* @param pStrm The stream.
1543	* @param ch The first character in the stability spec.
1544	*/
1545	static kVTGClass parseDataDepClass(PSCMSTREAM pStrm, unsigned ch)
1546	{
1547	switch (ch)
1548	{
1549	case 'C':
1550	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Common")))
1551	return kVTGClass_Common;
1552	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Cpu")))
1553	return kVTGClass_Cpu;
1554	break;
1555	case 'G':
1556	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Group")))
1557	return kVTGClass_Group;
1558	break;
1559	case 'I':
1560	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Isa")))
1561	return kVTGClass_Isa;
1562	break;
1563	case 'P':
1564	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Platform")))
1565	return kVTGClass_Platform;
1566	break;
1567	case 'U':
1568	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Unknown")))
1569	return kVTGClass_Unknown;
1570	break;
1571	}
1572	parseError(pStrm, 1, "Unknown data dependency class specifier");
1573	return kVTGClass_Invalid;
1574	}
1575
1576	/**
1577	* Parses a pragma D attributes statement.
1578	*
1579	* @returns Suitable exit code, errors message already written on failure.
1580	* @param pStrm The stream.
1581	*/
1582	static RTEXITCODE parsePragmaDAttributes(PSCMSTREAM pStrm)
1583	{
1584	/*
1585	* "CodeStability/DataStability/DataDepClass" - no spaces allowed.
1586	*/
1587	unsigned ch = parseGetNextNonSpaceNonCommentChOnPpLine(pStrm);
1588	if (ch == ~(unsigned)0)
1589	return RTEXITCODE_FAILURE;
1590
1591	kVTGStability enmCode = parseStability(pStrm, ch);
1592	if (enmCode == kVTGStability_Invalid)
1593	return RTEXITCODE_FAILURE;
1594	ch = ScmStreamGetCh(pStrm);
1595	if (ch != '/')
1596	return parseError(pStrm, 1, "Expected '/' following the code stability specifier");
1597
1598	kVTGStability enmData = parseStability(pStrm, ScmStreamGetCh(pStrm));
1599	if (enmData == kVTGStability_Invalid)
1600	return RTEXITCODE_FAILURE;
1601	ch = ScmStreamGetCh(pStrm);
1602	if (ch != '/')
1603	return parseError(pStrm, 1, "Expected '/' following the data stability specifier");
1604
1605	kVTGClass enmDataDep = parseDataDepClass(pStrm, ScmStreamGetCh(pStrm));
1606	if (enmDataDep == kVTGClass_Invalid)
1607	return RTEXITCODE_FAILURE;
1608
1609	/*
1610	* Expecting 'provider' followed by the name of an provider defined earlier.
1611	*/
1612	ch = parseGetNextNonSpaceNonCommentChOnPpLine(pStrm);
1613	if (ch == ~(unsigned)0)
1614	return RTEXITCODE_FAILURE;
1615	if (ch != 'p' \|\| !ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("provider")))
1616	return parseError(pStrm, 1, "Expected 'provider'");
1617
1618	size_t cchName;
1619	const char *pszName = parseGetNextCWord(pStrm, &cchName);
1620	if (!pszName)
1621	return parseError(pStrm, 1, "Expected provider name");
1622
1623	PVTGPROVIDER pProv;
1624	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1625	{
1626	if ( !strncmp(pProv->pszName, pszName, cchName)
1627	&& pProv->pszName[cchName] == '\0')
1628	break;
1629	}
1630	if (RTListNodeIsDummy(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry))
1631	return parseError(pStrm, cchName, "Provider not found");
1632
1633	/*
1634	* Which aspect of the provider?
1635	*/
1636	size_t cchAspect;
1637	const char *pszAspect = parseGetNextCWord(pStrm, &cchAspect);
1638	if (!pszAspect)
1639	return parseError(pStrm, 1, "Expected provider aspect");
1640
1641	PVTGATTRS pAttrs;
1642	if (cchAspect == 8 && !memcmp(pszAspect, "provider", 8))
1643	pAttrs = &pProv->AttrSelf;
1644	else if (cchAspect == 8 && !memcmp(pszAspect, "function", 8))
1645	pAttrs = &pProv->AttrFunctions;
1646	else if (cchAspect == 6 && !memcmp(pszAspect, "module", 6))
1647	pAttrs = &pProv->AttrModules;
1648	else if (cchAspect == 4 && !memcmp(pszAspect, "name", 4))
1649	pAttrs = &pProv->AttrName;
1650	else if (cchAspect == 4 && !memcmp(pszAspect, "args", 4))
1651	pAttrs = &pProv->AttrArguments;
1652	else
1653	return parseError(pStrm, cchAspect, "Unknown aspect");
1654
1655	if (pAttrs->enmCode != kVTGStability_Invalid)
1656	return parseError(pStrm, cchAspect, "You have already specified these attributes");
1657
1658	pAttrs->enmCode = enmCode;
1659	pAttrs->enmData = enmData;
1660	pAttrs->enmDataDep = enmDataDep;
1661	return RTEXITCODE_SUCCESS;
1662	}
1663
1664	/**
1665	* Parses a D pragma statement.
1666	*
1667	* @returns Suitable exit code, errors message already written on failure.
1668	* @param pStrm The stream.
1669	*/
1670	static RTEXITCODE parsePragma(PSCMSTREAM pStrm)
1671	{
1672	RTEXITCODE rcExit;
1673	unsigned ch = parseGetNextNonSpaceNonCommentChOnPpLine(pStrm);
1674	if (ch == ~(unsigned)0)
1675	rcExit = RTEXITCODE_FAILURE;
1676	else if (ch == 'D' && ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("D")))
1677	{
1678	ch = parseGetNextNonSpaceNonCommentChOnPpLine(pStrm);
1679	if (ch == ~(unsigned)0)
1680	rcExit = RTEXITCODE_FAILURE;
1681	else if (ch == 'a' && ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("attributes")))
1682	rcExit = parsePragmaDAttributes(pStrm);
1683	else
1684	rcExit = parseError(pStrm, 1, "Unknown pragma D");
1685	}
1686	else
1687	rcExit = parseError(pStrm, 1, "Unknown pragma");
1688	return rcExit;
1689	}
1690
1691
1692	/**
1693	* Classifies the given type expression.
1694	*
1695	* @return Type flags.
1696	* @param pszType The type expression.
1697	*/
1698	static uint32_t parseTypeExpression(const char *pszType)
1699	{
1700	size_t cchType = strlen(pszType);
1701	#define MY_STRMATCH(a_sz) (cchType == sizeof(a_sz) - 1 && !memcmp(a_sz, pszType, sizeof(a_sz) - 1))
1702
1703	/*
1704	* Try detect pointers.
1705	*/
1706	if (pszType[cchType - 1] == '*')
1707	{
1708	if (MY_STRMATCH("const char *")) return VTG_TYPE_POINTER \| VTG_TYPE_CONST_CHAR_PTR;
1709	return VTG_TYPE_POINTER;
1710	}
1711	if (pszType[cchType - 1] == '&')
1712	{
1713	RTMsgWarning("Please avoid using references like '%s' for probe arguments!", pszType);
1714	return VTG_TYPE_POINTER;
1715	}
1716
1717	/*
1718	* Standard integer types and IPRT variants.
1719	* It's important that we catch all types larger than 32-bit here or we'll
1720	* screw up the probe argument handling.
1721	*/
1722	if (MY_STRMATCH("int")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_SIGNED;
1723	if (MY_STRMATCH("uintptr_t")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_UNSIGNED;
1724	if (MY_STRMATCH("intptr_t")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_SIGNED;
1725
1726	//if (MY_STRMATCH("uint128_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint128_t) \| VTG_TYPE_UNSIGNED;
1727	if (MY_STRMATCH("uint64_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint64_t) \| VTG_TYPE_UNSIGNED;
1728	if (MY_STRMATCH("uint32_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint32_t) \| VTG_TYPE_UNSIGNED;
1729	if (MY_STRMATCH("uint16_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint16_t) \| VTG_TYPE_UNSIGNED;
1730	if (MY_STRMATCH("uint8_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint8_t) \| VTG_TYPE_UNSIGNED;
1731
1732	//if (MY_STRMATCH("int128_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int128_t) \| VTG_TYPE_SIGNED;
1733	if (MY_STRMATCH("int64_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int64_t) \| VTG_TYPE_SIGNED;
1734	if (MY_STRMATCH("int32_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int32_t) \| VTG_TYPE_SIGNED;
1735	if (MY_STRMATCH("int16_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int16_t) \| VTG_TYPE_SIGNED;
1736	if (MY_STRMATCH("int8_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int8_t) \| VTG_TYPE_SIGNED;
1737
1738	if (MY_STRMATCH("RTUINT64U")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint64_t) \| VTG_TYPE_UNSIGNED;
1739	if (MY_STRMATCH("RTUINT32U")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint32_t) \| VTG_TYPE_UNSIGNED;
1740	if (MY_STRMATCH("RTUINT16U")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint16_t) \| VTG_TYPE_UNSIGNED;
1741
1742	if (MY_STRMATCH("RTMSINTERVAL")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTMSINTERVAL) \| VTG_TYPE_UNSIGNED;
1743	if (MY_STRMATCH("RTTIMESPEC")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTTIMESPEC) \| VTG_TYPE_SIGNED;
1744	if (MY_STRMATCH("RTPROCESS")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTPROCESS) \| VTG_TYPE_UNSIGNED;
1745	if (MY_STRMATCH("RTHCPHYS")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTHCPHYS) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_PHYS;
1746
1747	if (MY_STRMATCH("RTR3PTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3;
1748	if (MY_STRMATCH("RTR0PTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R0;
1749	if (MY_STRMATCH("RTRCPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_RC;
1750	if (MY_STRMATCH("RTHCPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0;
1751
1752	if (MY_STRMATCH("RTR3UINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_UNSIGNED;
1753	if (MY_STRMATCH("RTR0UINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R0 \| VTG_TYPE_UNSIGNED;
1754	if (MY_STRMATCH("RTRCUINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_RC \| VTG_TYPE_UNSIGNED;
1755	if (MY_STRMATCH("RTHCUINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_UNSIGNED;
1756
1757	if (MY_STRMATCH("RTR3INTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_SIGNED;
1758	if (MY_STRMATCH("RTR0INTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R0 \| VTG_TYPE_SIGNED;
1759	if (MY_STRMATCH("RTRCINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_RC \| VTG_TYPE_SIGNED;
1760	if (MY_STRMATCH("RTHCINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_SIGNED;
1761
1762	if (MY_STRMATCH("RTUINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_CTX_RC \| VTG_TYPE_UNSIGNED;
1763	if (MY_STRMATCH("RTINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_CTX_RC \| VTG_TYPE_SIGNED;
1764
1765	if (MY_STRMATCH("RTHCUINTREG")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_UNSIGNED;
1766	if (MY_STRMATCH("RTR3UINTREG")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_CTX_R3 \| VTG_TYPE_UNSIGNED;
1767	if (MY_STRMATCH("RTR0UINTREG")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_CTX_R3 \| VTG_TYPE_UNSIGNED;
1768
1769	if (MY_STRMATCH("RTGCUINTREG")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCUINTREG) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_CTX_GST;
1770	if (MY_STRMATCH("RTGCPTR")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPTR) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_CTX_GST;
1771	if (MY_STRMATCH("RTGCINTPTR")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCUINTPTR) \| VTG_TYPE_SIGNED \| VTG_TYPE_CTX_GST;
1772	if (MY_STRMATCH("RTGCPTR32")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPTR32) \| VTG_TYPE_SIGNED \| VTG_TYPE_CTX_GST;
1773	if (MY_STRMATCH("RTGCPTR64")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPTR64) \| VTG_TYPE_SIGNED \| VTG_TYPE_CTX_GST;
1774	if (MY_STRMATCH("RTGCPHYS")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPHYS) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_PHYS \| VTG_TYPE_CTX_GST;
1775	if (MY_STRMATCH("RTGCPHYS32")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPHYS32) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_PHYS \| VTG_TYPE_CTX_GST;
1776	if (MY_STRMATCH("RTGCPHYS64")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPHYS64) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_PHYS \| VTG_TYPE_CTX_GST;
1777
1778	/*
1779	* The special VBox types.
1780	*/
1781	if (MY_STRMATCH("PVM")) return VTG_TYPE_POINTER;
1782	if (MY_STRMATCH("PVMCPU")) return VTG_TYPE_POINTER;
1783	if (MY_STRMATCH("PCPUMCTX")) return VTG_TYPE_POINTER;
1784
1785	/*
1786	* Preaching time.
1787	*/
1788	if ( MY_STRMATCH("unsigned long")
1789	\|\| MY_STRMATCH("unsigned long long")
1790	\|\| MY_STRMATCH("signed long")
1791	\|\| MY_STRMATCH("signed long long")
1792	\|\| MY_STRMATCH("long")
1793	\|\| MY_STRMATCH("long long")
1794	\|\| MY_STRMATCH("char")
1795	\|\| MY_STRMATCH("signed char")
1796	\|\| MY_STRMATCH("unsigned char")
1797	\|\| MY_STRMATCH("double")
1798	\|\| MY_STRMATCH("long double")
1799	\|\| MY_STRMATCH("float")
1800	)
1801	{
1802	RTMsgError("Please do NOT use the type '%s' for probe arguments!", pszType);
1803	g_cTypeErrors++;
1804	return 0;
1805	}
1806
1807	if ( MY_STRMATCH("unsigned")
1808	\|\| MY_STRMATCH("signed")
1809	\|\| MY_STRMATCH("signed int")
1810	\|\| MY_STRMATCH("unsigned int")
1811	\|\| MY_STRMATCH("short")
1812	\|\| MY_STRMATCH("signed short")
1813	\|\| MY_STRMATCH("unsigned short")
1814	)
1815	RTMsgWarning("Please avoid using the type '%s' for probe arguments!", pszType);
1816	if (MY_STRMATCH("unsigned")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_UNSIGNED;
1817	if (MY_STRMATCH("unsigned int")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_UNSIGNED;
1818	if (MY_STRMATCH("signed")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_SIGNED;
1819	if (MY_STRMATCH("signed int")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_SIGNED;
1820	if (MY_STRMATCH("short")) return VTG_TYPE_FIXED_SIZED \| sizeof(short) \| VTG_TYPE_SIGNED;
1821	if (MY_STRMATCH("signed short")) return VTG_TYPE_FIXED_SIZED \| sizeof(short) \| VTG_TYPE_SIGNED;
1822	if (MY_STRMATCH("unsigned short")) return VTG_TYPE_FIXED_SIZED \| sizeof(short) \| VTG_TYPE_UNSIGNED;
1823
1824	/*
1825	* What we haven't caught by now is either unknown to us or wrong.
1826	*/
1827	if (pszType[0] == 'P')
1828	{
1829	RTMsgError("Type '%s' looks like a pointer typedef, please do NOT use those "
1830	"but rather the non-pointer typedef or struct with '*'",
1831	pszType);
1832	g_cTypeErrors++;
1833	return VTG_TYPE_POINTER;
1834	}
1835
1836	RTMsgError("Don't know '%s' - please change or fix VBoxTpG", pszType);
1837	g_cTypeErrors++;
1838
1839	#undef MY_STRCMP
1840	return 0;
1841	}
1842
1843
1844	/**
1845	* Initializes the members of an argument.
1846	*
1847	* @returns RTEXITCODE_SUCCESS or RTEXITCODE_FAILURE+msg.
1848	* @param pProbe The probe.
1849	* @param pArg The argument.
1850	* @param pStrm The input stream (for errors).
1851	* @param pchType The type.
1852	* @param cchType The type length.
1853	* @param pchName The name.
1854	* @param cchName The name length.
1855	*/
1856	static RTEXITCODE parseInitArgument(PVTGPROBE pProbe, PVTGARG pArg, PSCMSTREAM pStrm,
1857	char pchType, size_t cchType, char pchName, size_t cchName)
1858	{
1859	Assert(!pArg->pszName); Assert(!pArg->pszTracerType); Assert(!pArg->pszCtxType); Assert(!pArg->fType);
1860
1861	pArg->pszArgPassingFmt = ", %s";
1862	pArg->pszName = RTStrDupN(pchName, cchName);
1863	pArg->pszTracerType = strtabInsertN(pchType, cchType);
1864	if (!pArg->pszTracerType \|\| !pArg->pszName)
1865	return parseError(pStrm, 1, "Out of memory");
1866	pArg->fType = parseTypeExpression(pArg->pszTracerType);
1867
1868	if ( (pArg->fType & VTG_TYPE_POINTER)
1869	&& !(g_fTypeContext & VTG_TYPE_CTX_R0) )
1870	{
1871	pArg->fType &= ~VTG_TYPE_POINTER;
1872	if ( !strcmp(pArg->pszTracerType, "struct VM *") \|\| !strcmp(pArg->pszTracerType, "PVM")
1873	\|\| !strcmp(pArg->pszTracerType, "struct VMCPU *") \|\| !strcmp(pArg->pszTracerType, "PVMCPU")
1874	\|\| !strcmp(pArg->pszTracerType, "struct CPUMCTX *") \|\| !strcmp(pArg->pszTracerType, "PCPUMCTX")
1875	)
1876	{
1877	pArg->fType \|= VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R0
1878	\| VTG_TYPE_FIXED_SIZED \| (g_cHostBits / 8)
1879	\| VTG_TYPE_AUTO_CONV_PTR;
1880	pArg->pszCtxType = RTStrDup("RTR0PTR");
1881
1882	if (!strcmp(pArg->pszTracerType, "struct VM *") \|\| !strcmp(pArg->pszTracerType, "PVM"))
1883	pArg->pszArgPassingFmt = ", VTG_VM_TO_R0(%s)";
1884	else if (!strcmp(pArg->pszTracerType, "struct VMCPU *") \|\| !strcmp(pArg->pszTracerType, "PVMCPU"))
1885	pArg->pszArgPassingFmt = ", VTG_VMCPU_TO_R0(%s)";
1886	else
1887	{
1888	PVTGARG pFirstArg = RTListGetFirst(&pProbe->ArgHead, VTGARG, ListEntry);
1889	if ( !pFirstArg
1890	\|\| pFirstArg == pArg
1891	\|\| strcmp(pFirstArg->pszName, "a_pVCpu")
1892	\|\| ( strcmp(pFirstArg->pszTracerType, "struct VMCPU *")
1893	&& strcmp(pFirstArg->pszTracerType, "PVMCPU *")) )
1894	return parseError(pStrm, 1, "The automatic ring-0 pointer conversion requires 'a_pVCpu' with type 'struct VMCPU *' as the first argument");
1895
1896	if (!strcmp(pArg->pszTracerType, "struct CPUMCTX *")\|\| !strcmp(pArg->pszTracerType, "PCPUMCTX"))
1897	pArg->pszArgPassingFmt = ", VTG_CPUMCTX_TO_R0(a_pVCpu, %s)";
1898	else
1899	pArg->pszArgPassingFmt = ", VBoxTpG-Is-Buggy!!";
1900	}
1901	}
1902	else
1903	{
1904	pArg->fType \|= VTG_TYPE_CTX_POINTER \| g_fTypeContext \| VTG_TYPE_FIXED_SIZED \| (g_cBits / 8);
1905	pArg->pszCtxType = RTStrDupN(pchType, cchType);
1906	}
1907	}
1908	else
1909	pArg->pszCtxType = RTStrDupN(pchType, cchType);
1910	if (!pArg->pszCtxType)
1911	return parseError(pStrm, 1, "Out of memory");
1912
1913	return RTEXITCODE_SUCCESS;
1914	}
1915
1916
1917	/**
1918	* Unmangles the probe name.
1919	*
1920	* This involves translating double underscore to dash.
1921	*
1922	* @returns Pointer to the unmangled name in the string table.
1923	* @param pszMangled The mangled name.
1924	*/
1925	static const char parseUnmangleProbeName(const char pszMangled)
1926	{
1927	size_t cchMangled = strlen(pszMangled);
1928	char pszTmp = (char )alloca(cchMangled + 2);
1929	const char *pszSrc = pszMangled;
1930	char *pszDst = pszTmp;
1931
1932	while (*pszSrc)
1933	{
1934	if (pszSrc[0] == '_' && pszSrc[1] == '_' && pszSrc[2] != '_')
1935	{
1936	*pszDst++ = '-';
1937	pszSrc += 2;
1938	}
1939	else
1940	pszDst++ = pszSrc++;
1941	}
1942	*pszDst = '\0';
1943
1944	return strtabInsertN(pszTmp, pszDst - pszTmp);
1945	}
1946
1947
1948	/**
1949	* Parses a D probe statement.
1950	*
1951	* @returns Suitable exit code, errors message already written on failure.
1952	* @param pStrm The stream.
1953	* @param pProv The provider being parsed.
1954	*/
1955	static RTEXITCODE parseProbe(PSCMSTREAM pStrm, PVTGPROVIDER pProv)
1956	{
1957	/*
1958	* Next up is a name followed by an opening parenthesis.
1959	*/
1960	size_t cchProbe;
1961	const char *pszProbe = parseGetNextCWord(pStrm, &cchProbe);
1962	if (!pszProbe)
1963	return parseError(pStrm, 1, "Expected a probe name starting with an alphabetical character");
1964	unsigned ch = parseGetNextNonSpaceNonCommentCh(pStrm);
1965	if (ch != '(')
1966	return parseError(pStrm, 1, "Expected '(' after the probe name");
1967
1968	/*
1969	* Create a probe instance.
1970	*/
1971	PVTGPROBE pProbe = (PVTGPROBE)RTMemAllocZ(sizeof(*pProbe));
1972	if (!pProbe)
1973	return parseError(pStrm, 0, "Out of memory");
1974	RTListInit(&pProbe->ArgHead);
1975	RTListAppend(&pProv->ProbeHead, &pProbe->ListEntry);
1976	pProbe->offArgList = UINT32_MAX;
1977	pProbe->pszMangledName = RTStrDupN(pszProbe, cchProbe);
1978	if (!pProbe->pszMangledName)
1979	return parseError(pStrm, 0, "Out of memory");
1980	pProbe->pszUnmangledName = parseUnmangleProbeName(pProbe->pszMangledName);
1981	if (!pProbe->pszUnmangledName)
1982	return parseError(pStrm, 0, "Out of memory");
1983
1984	/*
1985	* Parse loop for the argument.
1986	*/
1987	PVTGARG pArg = NULL;
1988	size_t cchName = 0;
1989	size_t cchArg = 0;
1990	char szArg[4096];
1991	for (;;)
1992	{
1993	ch = parseGetNextNonSpaceNonCommentCh(pStrm);
1994	switch (ch)
1995	{
1996	case ')':
1997	case ',':
1998	{
1999	/* commit the argument */
2000	if (pArg)
2001	{
2002	if (!cchName)
2003	return parseError(pStrm, 1, "Argument has no name");
2004	if (cchArg - cchName - 1 >= 128)
2005	return parseError(pStrm, 1, "Argument type too long");
2006	RTEXITCODE rcExit = parseInitArgument(pProbe, pArg, pStrm,
2007	szArg, cchArg - cchName - 1,
2008	&szArg[cchArg - cchName], cchName);
2009	if (rcExit != RTEXITCODE_SUCCESS)
2010	return rcExit;
2011	if (VTG_TYPE_IS_LARGE(pArg->fType))
2012	pProbe->fHaveLargeArgs = true;
2013	pArg = NULL;
2014	cchName = cchArg = 0;
2015	}
2016	if (ch == ')')
2017	{
2018	size_t off = ScmStreamTell(pStrm);
2019	ch = parseGetNextNonSpaceNonCommentCh(pStrm);
2020	if (ch != ';')
2021	return parseErrorAbs(pStrm, off, "Expected ';'");
2022	return RTEXITCODE_SUCCESS;
2023	}
2024	break;
2025	}
2026
2027	default:
2028	{
2029	size_t cchWord;
2030	const char *pszWord = ScmStreamCGetWordM1(pStrm, &cchWord);
2031	if (!pszWord)
2032	return parseError(pStrm, 0, "Expected argument");
2033	if (!pArg)
2034	{
2035	pArg = (PVTGARG)RTMemAllocZ(sizeof(*pArg));
2036	if (!pArg)
2037	return parseError(pStrm, 1, "Out of memory");
2038	RTListAppend(&pProbe->ArgHead, &pArg->ListEntry);
2039	pProbe->cArgs++;
2040
2041	if (cchWord + 1 > sizeof(szArg))
2042	return parseError(pStrm, 1, "Too long parameter declaration");
2043	memcpy(szArg, pszWord, cchWord);
2044	szArg[cchWord] = '\0';
2045	cchArg = cchWord;
2046	cchName = 0;
2047	}
2048	else
2049	{
2050	if (cchArg + 1 + cchWord + 1 > sizeof(szArg))
2051	return parseError(pStrm, 1, "Too long parameter declaration");
2052
2053	szArg[cchArg++] = ' ';
2054	memcpy(&szArg[cchArg], pszWord, cchWord);
2055	cchArg += cchWord;
2056	szArg[cchArg] = '\0';
2057	cchName = cchWord;
2058	}
2059	break;
2060	}
2061
2062	case '*':
2063	{
2064	if (!pArg)
2065	return parseError(pStrm, 1, "A parameter type does not start with an asterix");
2066	if (cchArg + sizeof(" *") >= sizeof(szArg))
2067	return parseError(pStrm, 1, "Too long parameter declaration");
2068	szArg[cchArg++] = ' ';
2069	szArg[cchArg++] = '*';
2070	szArg[cchArg ] = '\0';
2071	cchName = 0;
2072	break;
2073	}
2074
2075	case ~(unsigned)0:
2076	return parseError(pStrm, 0, "Missing closing ')' on probe");
2077	}
2078	}
2079	}
2080
2081	/**
2082	* Parses a D provider statement.
2083	*
2084	* @returns Suitable exit code, errors message already written on failure.
2085	* @param pStrm The stream.
2086	*/
2087	static RTEXITCODE parseProvider(PSCMSTREAM pStrm)
2088	{
2089	/*
2090	* Next up is a name followed by a curly bracket. Ignore comments.
2091	*/
2092	RTEXITCODE rcExit = parseSkipSpacesAndComments(pStrm);
2093	if (rcExit != RTEXITCODE_SUCCESS)
2094	return parseError(pStrm, 1, "Expected a provider name starting with an alphabetical character");
2095	size_t cchName;
2096	const char *pszName = ScmStreamCGetWord(pStrm, &cchName);
2097	if (!pszName)
2098	return parseError(pStrm, 0, "Bad provider name");
2099	if (RT_C_IS_DIGIT(pszName[cchName - 1]))
2100	return parseError(pStrm, 1, "A provider name cannot end with digit");
2101
2102	unsigned ch = parseGetNextNonSpaceNonCommentCh(pStrm);
2103	if (ch != '{')
2104	return parseError(pStrm, 1, "Expected '{' after the provider name");
2105
2106	/*
2107	* Create a provider instance.
2108	*/
2109	PVTGPROVIDER pProv = (PVTGPROVIDER)RTMemAllocZ(sizeof(*pProv));
2110	if (!pProv)
2111	return parseError(pStrm, 0, "Out of memory");
2112	RTListInit(&pProv->ProbeHead);
2113	RTListAppend(&g_ProviderHead, &pProv->ListEntry);
2114	pProv->pszName = strtabInsertN(pszName, cchName);
2115	if (!pProv->pszName)
2116	return parseError(pStrm, 0, "Out of memory");
2117
2118	/*
2119	* Parse loop.
2120	*/
2121	for (;;)
2122	{
2123	ch = parseGetNextNonSpaceNonCommentCh(pStrm);
2124	switch (ch)
2125	{
2126	case 'p':
2127	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("probe")))
2128	rcExit = parseProbe(pStrm, pProv);
2129	else
2130	rcExit = parseError(pStrm, 1, "Unexpected character");
2131	break;
2132
2133	case '}':
2134	{
2135	size_t off = ScmStreamTell(pStrm);
2136	ch = parseGetNextNonSpaceNonCommentCh(pStrm);
2137	if (ch == ';')
2138	return RTEXITCODE_SUCCESS;
2139	rcExit = parseErrorAbs(pStrm, off, "Expected ';'");
2140	break;
2141	}
2142
2143	case ~(unsigned)0:
2144	rcExit = parseError(pStrm, 0, "Missing closing '}' on provider");
2145	break;
2146
2147	default:
2148	rcExit = parseError(pStrm, 1, "Unexpected character");
2149	break;
2150	}
2151	if (rcExit != RTEXITCODE_SUCCESS)
2152	return rcExit;
2153	}
2154	}
2155
2156
2157	static RTEXITCODE parseScript(const char *pszScript)
2158	{
2159	SCMSTREAM Strm;
2160	int rc = ScmStreamInitForReading(&Strm, pszScript);
2161	if (RT_FAILURE(rc))
2162	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to open & read '%s' into memory: %Rrc", pszScript, rc);
2163	if (g_cVerbosity > 0)
2164	RTMsgInfo("Parsing '%s'...", pszScript);
2165
2166	RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
2167	unsigned ch;
2168	while ((ch = ScmStreamGetCh(&Strm)) != ~(unsigned)0)
2169	{
2170	if (RT_C_IS_SPACE(ch))
2171	continue;
2172	switch (ch)
2173	{
2174	case '/':
2175	ch = ScmStreamGetCh(&Strm);
2176	if (ch == '*')
2177	rcExit = parseMultiLineComment(&Strm);
2178	else if (ch == '/')
2179	rcExit = parseOneLineComment(&Strm);
2180	else
2181	rcExit = parseError(&Strm, 2, "Unexpected character");
2182	break;
2183
2184	case 'p':
2185	if (ScmStreamCMatchingWordM1(&Strm, RT_STR_TUPLE("provider")))
2186	rcExit = parseProvider(&Strm);
2187	else
2188	rcExit = parseError(&Strm, 1, "Unexpected character");
2189	break;
2190
2191	case '#':
2192	{
2193	ch = parseGetNextNonSpaceNonCommentChOnPpLine(&Strm);
2194	if (ch == ~(unsigned)0)
2195	rcExit = RTEXITCODE_FAILURE;
2196	else if (ch == 'p' && ScmStreamCMatchingWordM1(&Strm, RT_STR_TUPLE("pragma")))
2197	rcExit = parsePragma(&Strm);
2198	else
2199	rcExit = parseError(&Strm, 1, "Unsupported preprocessor directive");
2200	break;
2201	}
2202
2203	default:
2204	rcExit = parseError(&Strm, 1, "Unexpected character");
2205	break;
2206	}
2207	if (rcExit != RTEXITCODE_SUCCESS)
2208	return rcExit;
2209	}
2210
2211	ScmStreamDelete(&Strm);
2212	if (g_cVerbosity > 0 && rcExit == RTEXITCODE_SUCCESS)
2213	RTMsgInfo("Successfully parsed '%s'.", pszScript);
2214	return rcExit;
2215	}
2216
2217
2218	/**
2219	* Parses the arguments.
2220	*/
2221	static RTEXITCODE parseArguments(int argc, char **argv)
2222	{
2223	/*
2224	* Set / Adjust defaults.
2225	*/
2226	int rc = RTPathAbs(g_pszAssemblerIncVal, g_szAssemblerIncVal, sizeof(g_szAssemblerIncVal) - 1);
2227	if (RT_FAILURE(rc))
2228	return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTPathAbs failed: %Rrc", rc);
2229	strcat(g_szAssemblerIncVal, "/");
2230	g_pszAssemblerIncVal = g_szAssemblerIncVal;
2231
2232	/*
2233	* Option config.
2234	*/
2235	enum
2236	{
2237	kVBoxTpGOpt_32Bit = 1000,
2238	kVBoxTpGOpt_64Bit,
2239	kVBoxTpGOpt_GenerateWrapperHeader,
2240	kVBoxTpGOpt_Assembler,
2241	kVBoxTpGOpt_AssemblerFmtOpt,
2242	kVBoxTpGOpt_AssemblerFmtVal,
2243	kVBoxTpGOpt_AssemblerOutputOpt,
2244	kVBoxTpGOpt_AssemblerOption,
2245	kVBoxTpGOpt_Pic,
2246	kVBoxTpGOpt_ProbeFnName,
2247	kVBoxTpGOpt_ProbeFnImported,
2248	kVBoxTpGOpt_ProbeFnNotImported,
2249	kVBoxTpGOpt_Host32Bit,
2250	kVBoxTpGOpt_Host64Bit,
2251	kVBoxTpGOpt_RawModeContext,
2252	kVBoxTpGOpt_Ring0Context,
2253	kVBoxTpGOpt_Ring0ContextAgnostic,
2254	kVBoxTpGOpt_Ring3Context,
2255	kVBoxTpGOpt_End
2256	};
2257
2258	static RTGETOPTDEF const s_aOpts[] =
2259	{
2260	/* dtrace w/ long options */
2261	{ "-32", kVBoxTpGOpt_32Bit, RTGETOPT_REQ_NOTHING },
2262	{ "-64", kVBoxTpGOpt_64Bit, RTGETOPT_REQ_NOTHING },
2263	{ "--apply-cpp", 'C', RTGETOPT_REQ_NOTHING },
2264	{ "--generate-obj", 'G', RTGETOPT_REQ_NOTHING },
2265	{ "--generate-header", 'h', RTGETOPT_REQ_NOTHING },
2266	{ "--output", 'o', RTGETOPT_REQ_STRING },
2267	{ "--script", 's', RTGETOPT_REQ_STRING },
2268	{ "--verbose", 'v', RTGETOPT_REQ_NOTHING },
2269	/* our stuff */
2270	{ "--generate-wrapper-header", kVBoxTpGOpt_GenerateWrapperHeader, RTGETOPT_REQ_NOTHING },
2271	{ "--assembler", kVBoxTpGOpt_Assembler, RTGETOPT_REQ_STRING },
2272	{ "--assembler-fmt-opt", kVBoxTpGOpt_AssemblerFmtOpt, RTGETOPT_REQ_STRING },
2273	{ "--assembler-fmt-val", kVBoxTpGOpt_AssemblerFmtVal, RTGETOPT_REQ_STRING },
2274	{ "--assembler-output-opt", kVBoxTpGOpt_AssemblerOutputOpt, RTGETOPT_REQ_STRING },
2275	{ "--assembler-option", kVBoxTpGOpt_AssemblerOption, RTGETOPT_REQ_STRING },
2276	{ "--pic", kVBoxTpGOpt_Pic, RTGETOPT_REQ_NOTHING },
2277	{ "--probe-fn-name", kVBoxTpGOpt_ProbeFnName, RTGETOPT_REQ_STRING },
2278	{ "--probe-fn-imported", kVBoxTpGOpt_ProbeFnImported, RTGETOPT_REQ_NOTHING },
2279	{ "--probe-fn-not-imported", kVBoxTpGOpt_ProbeFnNotImported, RTGETOPT_REQ_NOTHING },
2280	{ "--host-32-bit", kVBoxTpGOpt_Host32Bit, RTGETOPT_REQ_NOTHING },
2281	{ "--host-64-bit", kVBoxTpGOpt_Host64Bit, RTGETOPT_REQ_NOTHING },
2282	{ "--raw-mode-context", kVBoxTpGOpt_RawModeContext, RTGETOPT_REQ_NOTHING },
2283	{ "--ring-0-context", kVBoxTpGOpt_Ring0Context, RTGETOPT_REQ_NOTHING },
2284	{ "--ring-0-context-agnostic", kVBoxTpGOpt_Ring0ContextAgnostic, RTGETOPT_REQ_NOTHING },
2285	{ "--ring-3-context", kVBoxTpGOpt_Ring3Context, RTGETOPT_REQ_NOTHING },
2286	/** @todo We're missing a bunch of assembler options! */
2287	};
2288
2289	RTGETOPTUNION ValueUnion;
2290	RTGETOPTSTATE GetOptState;
2291	rc = RTGetOptInit(&GetOptState, argc, argv, &s_aOpts[0], RT_ELEMENTS(s_aOpts), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2292	AssertReleaseRCReturn(rc, RTEXITCODE_FAILURE);
2293
2294	/*
2295	* Process the options.
2296	*/
2297	while ((rc = RTGetOpt(&GetOptState, &ValueUnion)) != 0)
2298	{
2299	switch (rc)
2300	{
2301	/*
2302	* DTrace compatible options.
2303	*/
2304	case kVBoxTpGOpt_32Bit:
2305	g_cHostBits = g_cBits = 32;
2306	g_pszAssemblerFmtVal = g_szAssemblerFmtVal32;
2307	break;
2308
2309	case kVBoxTpGOpt_64Bit:
2310	g_cHostBits = g_cBits = 64;
2311	g_pszAssemblerFmtVal = g_szAssemblerFmtVal64;
2312	break;
2313
2314	case 'C':
2315	g_fApplyCpp = true;
2316	RTMsgWarning("Ignoring the -C option - no preprocessing of the D script will be performed");
2317	break;
2318
2319	case 'G':
2320	if ( g_enmAction != kVBoxTpGAction_Nothing
2321	&& g_enmAction != kVBoxTpGAction_GenerateObject)
2322	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "-G does not mix with -h or --generate-wrapper-header");
2323	g_enmAction = kVBoxTpGAction_GenerateObject;
2324	break;
2325
2326	case 'h':
2327	if (!strcmp(GetOptState.pDef->pszLong, "--generate-header"))
2328	{
2329	if ( g_enmAction != kVBoxTpGAction_Nothing
2330	&& g_enmAction != kVBoxTpGAction_GenerateHeader)
2331	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "-h does not mix with -G or --generate-wrapper-header");
2332	g_enmAction = kVBoxTpGAction_GenerateHeader;
2333	}
2334	else
2335	{
2336	/* --help or similar */
2337	RTPrintf("VirtualBox Tracepoint Generator\n"
2338	"\n"
2339	"Usage: %s [options]\n"
2340	"\n"
2341	"Options:\n", RTProcShortName());
2342	for (size_t i = 0; i < RT_ELEMENTS(s_aOpts); i++)
2343	if ((unsigned)s_aOpts[i].iShort < 128)
2344	RTPrintf(" -%c,%s\n", s_aOpts[i].iShort, s_aOpts[i].pszLong);
2345	else
2346	RTPrintf(" %s\n", s_aOpts[i].pszLong);
2347	return RTEXITCODE_SUCCESS;
2348	}
2349	break;
2350
2351	case 'o':
2352	if (g_pszOutput)
2353	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Output file is already set to '%s'", g_pszOutput);
2354	g_pszOutput = ValueUnion.psz;
2355	break;
2356
2357	case 's':
2358	if (g_pszScript)
2359	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Script file is already set to '%s'", g_pszScript);
2360	g_pszScript = ValueUnion.psz;
2361	break;
2362
2363	case 'v':
2364	g_cVerbosity++;
2365	break;
2366
2367	case 'V':
2368	{
2369	/* The following is assuming that svn does it's job here. */
2370	static const char s_szRev[] = "$Revision: 58976 $";
2371	const char *psz = RTStrStripL(strchr(s_szRev, ' '));
2372	RTPrintf("r%.*s\n", strchr(psz, ' ') - psz, psz);
2373	return RTEXITCODE_SUCCESS;
2374	}
2375
2376	case VINF_GETOPT_NOT_OPTION:
2377	if (g_enmAction == kVBoxTpGAction_GenerateObject)
2378	break; /* object files, ignore them. */
2379	return RTGetOptPrintError(rc, &ValueUnion);
2380
2381
2382	/*
2383	* Our options.
2384	*/
2385	case kVBoxTpGOpt_GenerateWrapperHeader:
2386	if ( g_enmAction != kVBoxTpGAction_Nothing
2387	&& g_enmAction != kVBoxTpGAction_GenerateWrapperHeader)
2388	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--generate-wrapper-header does not mix with -h or -G");
2389	g_enmAction = kVBoxTpGAction_GenerateWrapperHeader;
2390	break;
2391
2392	case kVBoxTpGOpt_Assembler:
2393	g_pszAssembler = ValueUnion.psz;
2394	break;
2395
2396	case kVBoxTpGOpt_AssemblerFmtOpt:
2397	g_pszAssemblerFmtOpt = ValueUnion.psz;
2398	break;
2399
2400	case kVBoxTpGOpt_AssemblerFmtVal:
2401	g_pszAssemblerFmtVal = ValueUnion.psz;
2402	break;
2403
2404	case kVBoxTpGOpt_AssemblerOutputOpt:
2405	g_pszAssemblerOutputOpt = ValueUnion.psz;
2406	break;
2407
2408	case kVBoxTpGOpt_AssemblerOption:
2409	if (g_cAssemblerOptions >= RT_ELEMENTS(g_apszAssemblerOptions))
2410	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Too many assembly options (max %u)", RT_ELEMENTS(g_apszAssemblerOptions));
2411	g_apszAssemblerOptions[g_cAssemblerOptions] = ValueUnion.psz;
2412	g_cAssemblerOptions++;
2413	break;
2414
2415	case kVBoxTpGOpt_Pic:
2416	g_fPic = true;
2417	break;
2418
2419	case kVBoxTpGOpt_ProbeFnName:
2420	g_pszProbeFnName = ValueUnion.psz;
2421	break;
2422
2423	case kVBoxTpGOpt_ProbeFnImported:
2424	g_fProbeFnImported = true;
2425	break;
2426
2427	case kVBoxTpGOpt_ProbeFnNotImported:
2428	g_fProbeFnImported = false;
2429	break;
2430
2431	case kVBoxTpGOpt_Host32Bit:
2432	g_cHostBits = 32;
2433	break;
2434
2435	case kVBoxTpGOpt_Host64Bit:
2436	g_cHostBits = 64;
2437	break;
2438
2439	case kVBoxTpGOpt_RawModeContext:
2440	g_fTypeContext = VTG_TYPE_CTX_RC;
2441	g_pszContextDefine = "IN_RC";
2442	g_pszContextDefine2 = NULL;
2443	break;
2444
2445	case kVBoxTpGOpt_Ring0Context:
2446	g_fTypeContext = VTG_TYPE_CTX_R0;
2447	g_pszContextDefine = "IN_RING0";
2448	g_pszContextDefine2 = NULL;
2449	break;
2450
2451	case kVBoxTpGOpt_Ring0ContextAgnostic:
2452	g_fTypeContext = VTG_TYPE_CTX_R0;
2453	g_pszContextDefine = "IN_RING0_AGNOSTIC";
2454	g_pszContextDefine2 = "IN_RING0";
2455	break;
2456
2457	case kVBoxTpGOpt_Ring3Context:
2458	g_fTypeContext = VTG_TYPE_CTX_R3;
2459	g_pszContextDefine = "IN_RING3";
2460	g_pszContextDefine2 = NULL;
2461	break;
2462
2463
2464	/*
2465	* Errors and bugs.
2466	*/
2467	default:
2468	return RTGetOptPrintError(rc, &ValueUnion);
2469	}
2470	}
2471
2472	/*
2473	* Check that we've got all we need.
2474	*/
2475	if (g_enmAction == kVBoxTpGAction_Nothing)
2476	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No action specified (-h, -G or --generate-wrapper-header)");
2477	if (!g_pszScript)
2478	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No script file specified (-s)");
2479	if (!g_pszOutput)
2480	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No output file specified (-o)");
2481
2482	return RTEXITCODE_SUCCESS;
2483	}
2484
2485
2486	int main(int argc, char **argv)
2487	{
2488	int rc = RTR3InitExe(argc, &argv, 0);
2489	if (RT_FAILURE(rc))
2490	return 1;
2491
2492	RTEXITCODE rcExit = parseArguments(argc, argv);
2493	if (rcExit == RTEXITCODE_SUCCESS)
2494	{
2495	/*
2496	* Parse the script.
2497	*/
2498	RTListInit(&g_ProviderHead);
2499	rcExit = parseScript(g_pszScript);
2500	if (rcExit == RTEXITCODE_SUCCESS)
2501	{
2502	/*
2503	* Take action.
2504	*/
2505	if (g_enmAction == kVBoxTpGAction_GenerateHeader)
2506	rcExit = generateFile(g_pszOutput, "header", generateHeader);
2507	else if (g_enmAction == kVBoxTpGAction_GenerateWrapperHeader)
2508	rcExit = generateFile(g_pszOutput, "wrapper header", generateWrapperHeader);
2509	else
2510	rcExit = generateObject(g_pszOutput, g_pszTempAsm);
2511	}
2512	}
2513
2514	if (rcExit == RTEXITCODE_SUCCESS && g_cTypeErrors > 0)
2515	rcExit = RTEXITCODE_FAILURE;
2516	return rcExit;
2517	}
2518

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

source: vbox/trunk/src/bldprogs/VBoxTpG.cpp@ 58976

Download in other formats: