VBoxTpG.cpp@ 53426

Last change on this file since 53426 was 47518, checked in by vboxsync, 11 years ago
Found more details, extended the hack a little to be on the safe side (hopefully).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 94.5 KB

Line
1	/* $Id: VBoxTpG.cpp 47518 2013-08-02 00:26:46Z vboxsync $ */
2	/** @file
3	* VBox Build Tool - VBox Tracepoint Generator.
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
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 47518 2013-08-02 00:26:46Z 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.5', 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	,
741	iProvider, pProvider->pszName,
742	strtabGetOff(pProvider->pszName),
743	pProvider->iFirstProbe,
744	pProvider->cProbes,
745	pProvider->AttrSelf.enmCode, pProvider->AttrSelf.enmData, pProvider->AttrSelf.enmDataDep,
746	pProvider->AttrModules.enmCode, pProvider->AttrModules.enmData, pProvider->AttrModules.enmDataDep,
747	pProvider->AttrFunctions.enmCode, pProvider->AttrFunctions.enmData, pProvider->AttrFunctions.enmDataDep,
748	pProvider->AttrName.enmCode, pProvider->AttrName.enmData, pProvider->AttrName.enmDataDep,
749	pProvider->AttrArguments.enmCode, pProvider->AttrArguments.enmData, pProvider->AttrArguments.enmDataDep);
750	iProvider++;
751	}
752	ScmStreamPrintf(pStrm, "VTG_GLOBAL g_aVTGProviders_End, data\n");
753
754	/*
755	* Declare the probe enable flags.
756	*
757	* These must be placed at the end so they'll end up adjacent to the probe
758	* locations. This is important for reducing the amount of memory we need
759	* to lock down for user mode modules.
760	*/
761	ScmStreamPrintf(pStrm,
762	";\n"
763	"; Probe enabled flags.\n"
764	";\n"
765	"ALIGNDATA(16)\n"
766	"VTG_GLOBAL g_acVTGProbeEnabled, data\n"
767	);
768	uint32_t cProbes = 0;
769	RTListForEach(&g_ProviderHead, pProvider, VTGPROVIDER, ListEntry)
770	{
771	RTListForEach(&pProvider->ProbeHead, pProbe, VTGPROBE, ListEntry)
772	{
773	ScmStreamPrintf(pStrm,
774	"VTG_GLOBAL g_cVTGProbeEnabled_%s_%s, data\n"
775	" dd 0\n",
776	pProvider->pszName, pProbe->pszMangledName);
777	cProbes++;
778	}
779	}
780	ScmStreamPrintf(pStrm, "VTG_GLOBAL g_acVTGProbeEnabled_End, data\n");
781	if (cProbes >= _32K)
782	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Too many probes: %u (max %u)", cProbes, _32K - 1);
783
784
785	/*
786	* Emit code for the stub functions.
787	*/
788	bool const fWin64 = g_cBits == 64 && (!strcmp(g_pszAssemblerFmtVal, "win64") \|\| !strcmp(g_pszAssemblerFmtVal, "pe64"));
789	bool const fElf = !strcmp(g_pszAssemblerFmtVal, "elf32") \|\| !strcmp(g_pszAssemblerFmtVal, "elf64");
790	ScmStreamPrintf(pStrm,
791	"\n"
792	";\n"
793	"; Prob stubs.\n"
794	";\n"
795	"BEGINCODE\n"
796	);
797	if (g_fProbeFnImported)
798	ScmStreamPrintf(pStrm,
799	"EXTERN_IMP2 %s\n"
800	"BEGINCODE ; EXTERN_IMP2 changes section\n",
801	g_pszProbeFnName);
802	else
803	ScmStreamPrintf(pStrm, "extern NAME(%s)\n", g_pszProbeFnName);
804
805	RTListForEach(&g_ProviderHead, pProvider, VTGPROVIDER, ListEntry)
806	{
807	RTListForEach(&pProvider->ProbeHead, pProbe, VTGPROBE, ListEntry)
808	{
809	ScmStreamPrintf(pStrm,
810	"\n"
811	"VTG_GLOBAL VTGProbeStub_%s_%s, function; (VBOXTPGPROBELOC pVTGProbeLoc",
812	pProvider->pszName, pProbe->pszMangledName);
813	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
814	{
815	ScmStreamPrintf(pStrm, ", %s %s", pArg->pszTracerType, pArg->pszName);
816	}
817	ScmStreamPrintf(pStrm,
818	");\n");
819
820	/*
821	* Check if the probe in question is enabled.
822	*/
823	if (g_cBits == 32)
824	ScmStreamPrintf(pStrm,
825	" mov eax, [esp + 4]\n"
826	" test byte [eax+3], 0x80 ; fEnabled == true?\n"
827	" jz .return ; jump on false\n");
828	else if (fWin64)
829	ScmStreamPrintf(pStrm,
830	" test byte [rcx+3], 0x80 ; fEnabled == true?\n"
831	" jz .return ; jump on false\n");
832	else
833	ScmStreamPrintf(pStrm,
834	" test byte [rdi+3], 0x80 ; fEnabled == true?\n"
835	" jz .return ; jump on false\n");
836
837	/*
838	* Jump to the fire-probe function.
839	*/
840	if (g_cBits == 32)
841	ScmStreamPrintf(pStrm, g_fPic && fElf ?
842	" jmp %s wrt ..plt\n"
843	: g_fProbeFnImported ?
844	" mov ecx, IMP2(%s)\n"
845	" jmp ecx\n"
846	:
847	" jmp NAME(%s)\n"
848	, g_pszProbeFnName);
849	else
850	ScmStreamPrintf(pStrm, g_fPic && fElf ?
851	" jmp [rel %s wrt ..got]\n"
852	: g_fProbeFnImported ?
853	" jmp IMP2(%s)\n"
854	:
855	" jmp NAME(%s)\n"
856	, g_pszProbeFnName);
857
858	ScmStreamPrintf(pStrm,
859	".return:\n"
860	" ret ; The probe was disabled, return\n"
861	"\n");
862	}
863	}
864
865	return RTEXITCODE_SUCCESS;
866	}
867
868
869	static RTEXITCODE generateObject(const char pszOutput, const char pszTempAsm)
870	{
871	if (!pszTempAsm)
872	{
873	size_t cch = strlen(pszOutput);
874	char psz = (char )alloca(cch + sizeof(".asm"));
875	memcpy(psz, pszOutput, cch);
876	memcpy(psz + cch, ".asm", sizeof(".asm"));
877	pszTempAsm = psz;
878	}
879
880	RTEXITCODE rcExit = generateFile(pszTempAsm, "assembly", generateAssembly);
881	if (rcExit == RTEXITCODE_SUCCESS)
882	rcExit = generateInvokeAssembler(pszOutput, pszTempAsm);
883	RTFileDelete(pszTempAsm);
884	return rcExit;
885	}
886
887
888	static RTEXITCODE generateProbeDefineName(char pszBuf, size_t cbBuf, const char pszProvider, const char *pszProbe)
889	{
890	size_t cbMax = strlen(pszProvider) + 1 + strlen(pszProbe) + 1;
891	if (cbMax > cbBuf \|\| cbMax > 80)
892	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Probe '%s' in provider '%s' ends up with a too long defined\n", pszProbe, pszProvider);
893
894	while (*pszProvider)
895	pszBuf++ = RT_C_TO_UPPER(pszProvider++);
896
897	*pszBuf++ = '_';
898
899	while (*pszProbe)
900	{
901	if (pszProbe[0] == '_' && pszProbe[1] == '_')
902	pszProbe++;
903	pszBuf++ = RT_C_TO_UPPER(pszProbe++);
904	}
905
906	*pszBuf = '\0';
907	return RTEXITCODE_SUCCESS;
908	}
909
910
911	/**
912	* Called via generateFile to generate the header file.
913	*
914	* @returns Exit code status.
915	* @param pStrm The output stream.
916	*/
917	static RTEXITCODE generateHeader(PSCMSTREAM pStrm)
918	{
919	/*
920	* Calc the double inclusion blocker define and then write the file header.
921	*/
922	char szTmp[4096];
923	const char *pszName = RTPathFilename(g_pszScript);
924	size_t cchName = strlen(pszName);
925	if (cchName >= sizeof(szTmp) - 64)
926	return RTMsgErrorExit(RTEXITCODE_FAILURE, "File name is too long '%s'", pszName);
927	szTmp[0] = '_';
928	szTmp[1] = '_';
929	szTmp[2] = '_';
930	memcpy(&szTmp[3], pszName, cchName);
931	szTmp[3 + cchName + 0] = '_';
932	szTmp[3 + cchName + 1] = '_';
933	szTmp[3 + cchName + 2] = '_';
934	szTmp[3 + cchName + 3] = '\0';
935	char *psz = &szTmp[3];
936	while (*psz)
937	{
938	if (!RT_C_IS_ALNUM(psz) && psz != '_')
939	*psz = '_';
940	psz++;
941	}
942
943	ScmStreamPrintf(pStrm,
944	"/* $Id: VBoxTpG.cpp 47518 2013-08-02 00:26:46Z vboxsync $ */\n"
945	"/** @file\n"
946	" * Automatically generated from %s. Do NOT edit!\n"
947	" */\n"
948	"\n"
949	"#ifndef %s\n"
950	"#define %s\n"
951	"\n"
952	"#include <VBox/VBoxTpG.h>\n"
953	"\n"
954	"#ifndef %s\n"
955	"# error \"Expected '%s' to be defined\"\n"
956	"#endif\n"
957	"\n"
958	"RT_C_DECLS_BEGIN\n"
959	"\n"
960	"#ifdef VBOX_WITH_DTRACE\n"
961	"\n"
962	"# ifdef _MSC_VER\n"
963	"# pragma data_seg(VTG_LOC_SECT)\n"
964	"# pragma data_seg()\n"
965	"# endif\n"
966	"\n"
967	,
968	g_pszScript,
969	szTmp,
970	szTmp,
971	g_pszContextDefine,
972	g_pszContextDefine);
973
974	/*
975	* Declare data, code and macros for each probe.
976	*/
977	PVTGPROVIDER pProv;
978	PVTGPROBE pProbe;
979	PVTGARG pArg;
980	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
981	{
982	RTListForEach(&pProv->ProbeHead, pProbe, VTGPROBE, ListEntry)
983	{
984	PVTGARG const pFirstArg = RTListGetFirst(&pProbe->ArgHead, VTGARG, ListEntry);
985
986	ScmStreamPrintf(pStrm,
987	"extern uint32_t g_cVTGProbeEnabled_%s_%s;\n"
988	"extern VTGDESCPROBE g_VTGProbeData_%s_%s;\n"
989	"DECLASM(void) VTGProbeStub_%s_%s(PVTGPROBELOC",
990	pProv->pszName, pProbe->pszMangledName,
991	pProv->pszName, pProbe->pszMangledName,
992	pProv->pszName, pProbe->pszMangledName);
993	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
994	{
995	ScmStreamPrintf(pStrm, ", %s", pArg->pszCtxType);
996	}
997	generateProbeDefineName(szTmp, sizeof(szTmp), pProv->pszName, pProbe->pszMangledName);
998	ScmStreamPrintf(pStrm,
999	");\n"
1000	"# define %s_ENABLED() \\\n"
1001	" (RT_UNLIKELY(g_cVTGProbeEnabled_%s_%s)) \n"
1002	"# define %s("
1003	, szTmp,
1004	pProv->pszName, pProbe->pszMangledName,
1005	szTmp);
1006	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1007	{
1008	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1009	ScmStreamPrintf(pStrm, "%s", pArg->pszName);
1010	else
1011	ScmStreamPrintf(pStrm, ", %s", pArg->pszName);
1012	}
1013	ScmStreamPrintf(pStrm,
1014	") \\\n"
1015	" do { \\\n"
1016	" if (RT_UNLIKELY(g_cVTGProbeEnabled_%s_%s)) \\\n"
1017	" { \\\n"
1018	" VTG_DECL_VTGPROBELOC(s_VTGProbeLoc) = \\\n"
1019	" { __LINE__, 0, 0, __FUNCTION__, &g_VTGProbeData_%s_%s }; \\\n"
1020	" VTGProbeStub_%s_%s(&s_VTGProbeLoc",
1021	pProv->pszName, pProbe->pszMangledName,
1022	pProv->pszName, pProbe->pszMangledName,
1023	pProv->pszName, pProbe->pszMangledName);
1024	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1025	{
1026	ScmStreamPrintf(pStrm, pArg->pszArgPassingFmt, pArg->pszName);
1027	}
1028	ScmStreamPrintf(pStrm,
1029	"); \\\n"
1030	" } \\\n"
1031	" { \\\n" );
1032	uint32_t iArg = 0;
1033	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1034	{
1035	if ((pArg->fType & (VTG_TYPE_FIXED_SIZED \| VTG_TYPE_AUTO_CONV_PTR)) == VTG_TYPE_FIXED_SIZED)
1036	ScmStreamPrintf(pStrm,
1037	" AssertCompile(sizeof(%s) == %u); \\\n"
1038	" AssertCompile(sizeof(%s) <= %u); \\\n",
1039	pArg->pszTracerType, pArg->fType & VTG_TYPE_SIZE_MASK,
1040	pArg->pszName, pArg->fType & VTG_TYPE_SIZE_MASK);
1041	else if (pArg->fType & (VTG_TYPE_POINTER \| VTG_TYPE_HC_ARCH_SIZED))
1042	ScmStreamPrintf(pStrm,
1043	" AssertCompile(sizeof(%s) <= sizeof(uintptr_t)); \\\n"
1044	" AssertCompile(sizeof(%s) <= sizeof(uintptr_t)); \\\n",
1045	pArg->pszName,
1046	pArg->pszTracerType);
1047	iArg++;
1048	}
1049	ScmStreamPrintf(pStrm,
1050	" } \\\n"
1051	" } while (0)\n"
1052	"\n");
1053	}
1054	}
1055
1056	ScmStreamPrintf(pStrm,
1057	"\n"
1058	"#else\n"
1059	"\n");
1060	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1061	{
1062	RTListForEach(&pProv->ProbeHead, pProbe, VTGPROBE, ListEntry)
1063	{
1064	generateProbeDefineName(szTmp, sizeof(szTmp), pProv->pszName, pProbe->pszMangledName);
1065	ScmStreamPrintf(pStrm,
1066	"# define %s_ENABLED() (false)\n"
1067	"# define %s("
1068	, szTmp, szTmp);
1069	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1070	{
1071	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1072	ScmStreamPrintf(pStrm, "%s", pArg->pszName);
1073	else
1074	ScmStreamPrintf(pStrm, ", %s", pArg->pszName);
1075	}
1076	ScmStreamPrintf(pStrm,
1077	") do { } while (0)\n");
1078	}
1079	}
1080
1081	ScmStreamWrite(pStrm, RT_STR_TUPLE("\n"
1082	"#endif\n"
1083	"\n"
1084	"RT_C_DECLS_END\n"
1085	"#endif\n"));
1086	return RTEXITCODE_SUCCESS;
1087	}
1088
1089
1090	/**
1091	* Called via generateFile to generate the wrapper header file.
1092	*
1093	* @returns Exit code status.
1094	* @param pStrm The output stream.
1095	*/
1096	static RTEXITCODE generateWrapperHeader(PSCMSTREAM pStrm)
1097	{
1098	/*
1099	* Calc the double inclusion blocker define and then write the file header.
1100	*/
1101	char szTmp[4096];
1102	const char *pszName = RTPathFilename(g_pszScript);
1103	size_t cchName = strlen(pszName);
1104	if (cchName >= sizeof(szTmp) - 64)
1105	return RTMsgErrorExit(RTEXITCODE_FAILURE, "File name is too long '%s'", pszName);
1106	szTmp[0] = '_';
1107	szTmp[1] = '_';
1108	szTmp[2] = '_';
1109	memcpy(&szTmp[3], pszName, cchName);
1110	strcpy(&szTmp[3 + cchName ], "___WRAPPER___");
1111	char *psz = &szTmp[3];
1112	while (*psz)
1113	{
1114	if (!RT_C_IS_ALNUM(psz) && psz != '_')
1115	*psz = '_';
1116	psz++;
1117	}
1118
1119	ScmStreamPrintf(pStrm,
1120	"/* $Id: VBoxTpG.cpp 47518 2013-08-02 00:26:46Z vboxsync $ */\n"
1121	"/** @file\n"
1122	" * Automatically generated from %s. Do NOT edit!\n"
1123	" */\n"
1124	"\n"
1125	"#ifndef %s\n"
1126	"#define %s\n"
1127	"\n"
1128	"#include <VBox/VBoxTpG.h>\n"
1129	"\n"
1130	"#ifndef %s\n"
1131	"# error \"Expected '%s' to be defined\"\n"
1132	"#endif\n"
1133	"\n"
1134	"#ifdef VBOX_WITH_DTRACE\n"
1135	"\n"
1136	,
1137	g_pszScript,
1138	szTmp,
1139	szTmp,
1140	g_pszContextDefine,
1141	g_pszContextDefine);
1142
1143	/*
1144	* Declare macros for each probe.
1145	*/
1146	PVTGPROVIDER pProv;
1147	PVTGPROBE pProbe;
1148	PVTGARG pArg;
1149	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1150	{
1151	RTListForEach(&pProv->ProbeHead, pProbe, VTGPROBE, ListEntry)
1152	{
1153	PVTGARG const pFirstArg = RTListGetFirst(&pProbe->ArgHead, VTGARG, ListEntry);
1154
1155	generateProbeDefineName(szTmp, sizeof(szTmp), pProv->pszName, pProbe->pszMangledName);
1156	ScmStreamPrintf(pStrm,
1157	"# define %s("
1158	, szTmp);
1159	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1160	{
1161	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1162	ScmStreamPrintf(pStrm, "%s", pArg->pszName);
1163	else
1164	ScmStreamPrintf(pStrm, ", %s", pArg->pszName);
1165	}
1166	ScmStreamPrintf(pStrm,
1167	") \\\n"
1168	" do { \\\n"
1169	" if (RT_UNLIKELY(%s_ENABLED())) \\\n"
1170	" { \\\n"
1171	" %s_ORIGINAL("
1172	, szTmp, szTmp);
1173	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1174	{
1175	const char *pszFmt = pArg->pszArgPassingFmt;
1176	if (pArg->fType & VTG_TYPE_AUTO_CONV_PTR)
1177	{
1178	/* Casting is required. ASSUMES sizeof(RTR0PTR) == sizeof(RTR3PTR) - safe! */
1179	pszFmt += sizeof(", ") - 1;
1180	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1181	ScmStreamPrintf(pStrm, "(%s)%M", pArg->pszTracerType, pszFmt, pArg->pszName);
1182	else
1183	ScmStreamPrintf(pStrm, ", (%s)%M", pArg->pszTracerType, pszFmt, pArg->pszName);
1184	}
1185	else
1186	{
1187	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1188	ScmStreamPrintf(pStrm, pArg->pszArgPassingFmt + sizeof(", ") - 1, pArg->pszName);
1189	else
1190	ScmStreamPrintf(pStrm, pArg->pszArgPassingFmt, pArg->pszName);
1191	}
1192	}
1193	ScmStreamPrintf(pStrm,
1194	"); \\\n"
1195	" } \\\n"
1196	" } while (0)\n"
1197	"\n");
1198	}
1199	}
1200
1201	ScmStreamPrintf(pStrm,
1202	"\n"
1203	"#else\n"
1204	"\n");
1205	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1206	{
1207	RTListForEach(&pProv->ProbeHead, pProbe, VTGPROBE, ListEntry)
1208	{
1209	generateProbeDefineName(szTmp, sizeof(szTmp), pProv->pszName, pProbe->pszMangledName);
1210	ScmStreamPrintf(pStrm,
1211	"# define %s("
1212	, szTmp);
1213	RTListForEach(&pProbe->ArgHead, pArg, VTGARG, ListEntry)
1214	{
1215	if (RTListNodeIsFirst(&pProbe->ArgHead, &pArg->ListEntry))
1216	ScmStreamPrintf(pStrm, "%s", pArg->pszName);
1217	else
1218	ScmStreamPrintf(pStrm, ", %s", pArg->pszName);
1219	}
1220	ScmStreamPrintf(pStrm,
1221	") do { } while (0)\n");
1222	}
1223	}
1224
1225	ScmStreamWrite(pStrm, RT_STR_TUPLE("\n"
1226	"#endif\n"
1227	"\n"
1228	"#endif\n"));
1229	return RTEXITCODE_SUCCESS;
1230	}
1231
1232
1233	/**
1234	* Parser error with line and position.
1235	*
1236	* @returns RTEXITCODE_FAILURE.
1237	* @param pStrm The stream.
1238	* @param cb The offset from the current position to the
1239	* point of failure.
1240	* @param pszMsg The message to display.
1241	*/
1242	static RTEXITCODE parseError(PSCMSTREAM pStrm, size_t cb, const char *pszMsg)
1243	{
1244	if (cb)
1245	ScmStreamSeekRelative(pStrm, -(ssize_t)cb);
1246	size_t const off = ScmStreamTell(pStrm);
1247	size_t const iLine = ScmStreamTellLine(pStrm);
1248	ScmStreamSeekByLine(pStrm, iLine);
1249	size_t const offLine = ScmStreamTell(pStrm);
1250
1251	RTPrintf("%s:%d:%zd: error: %s.\n", g_pszScript, iLine + 1, off - offLine + 1, pszMsg);
1252
1253	size_t cchLine;
1254	SCMEOL enmEof;
1255	const char *pszLine = ScmStreamGetLineByNo(pStrm, iLine, &cchLine, &enmEof);
1256	if (pszLine)
1257	RTPrintf(" %.*s\n"
1258	" %*s^\n",
1259	cchLine, pszLine, off - offLine, "");
1260	return RTEXITCODE_FAILURE;
1261	}
1262
1263
1264	/**
1265	* Parser error with line and position.
1266	*
1267	* @returns RTEXITCODE_FAILURE.
1268	* @param pStrm The stream.
1269	* @param cb The offset from the current position to the
1270	* point of failure.
1271	* @param pszMsg The message to display.
1272	*/
1273	static RTEXITCODE parseErrorAbs(PSCMSTREAM pStrm, size_t off, const char *pszMsg)
1274	{
1275	ScmStreamSeekAbsolute(pStrm, off);
1276	return parseError(pStrm, 0, pszMsg);
1277	}
1278
1279	/**
1280	* Handles a C++ one line comment.
1281	*
1282	* @returns Exit code.
1283	* @param pStrm The stream.
1284	*/
1285	static RTEXITCODE parseOneLineComment(PSCMSTREAM pStrm)
1286	{
1287	ScmStreamSeekByLine(pStrm, ScmStreamTellLine(pStrm) + 1);
1288	return RTEXITCODE_SUCCESS;
1289	}
1290
1291	/**
1292	* Handles a multi-line C/C++ comment.
1293	*
1294	* @returns Exit code.
1295	* @param pStrm The stream.
1296	*/
1297	static RTEXITCODE parseMultiLineComment(PSCMSTREAM pStrm)
1298	{
1299	unsigned ch;
1300	while ((ch = ScmStreamGetCh(pStrm)) != ~(unsigned)0)
1301	{
1302	if (ch == '*')
1303	{
1304	do
1305	ch = ScmStreamGetCh(pStrm);
1306	while (ch == '*');
1307	if (ch == '/')
1308	return RTEXITCODE_SUCCESS;
1309	}
1310	}
1311
1312	parseError(pStrm, 1, "Expected end of comment, got end of file");
1313	return RTEXITCODE_FAILURE;
1314	}
1315
1316
1317	/**
1318	* Skips spaces and comments.
1319	*
1320	* @returns RTEXITCODE_SUCCESS or RTEXITCODE_FAILURE.
1321	* @param pStrm The stream..
1322	*/
1323	static RTEXITCODE parseSkipSpacesAndComments(PSCMSTREAM pStrm)
1324	{
1325	unsigned ch;
1326	while ((ch = ScmStreamPeekCh(pStrm)) != ~(unsigned)0)
1327	{
1328	if (!RT_C_IS_SPACE(ch) && ch != '/')
1329	return RTEXITCODE_SUCCESS;
1330	unsigned ch2 = ScmStreamGetCh(pStrm); AssertBreak(ch == ch2); NOREF(ch2);
1331	if (ch == '/')
1332	{
1333	ch = ScmStreamGetCh(pStrm);
1334	RTEXITCODE rcExit;
1335	if (ch == '*')
1336	rcExit = parseMultiLineComment(pStrm);
1337	else if (ch == '/')
1338	rcExit = parseOneLineComment(pStrm);
1339	else
1340	rcExit = parseError(pStrm, 2, "Unexpected character");
1341	if (rcExit != RTEXITCODE_SUCCESS)
1342	return rcExit;
1343	}
1344	}
1345
1346	return parseError(pStrm, 0, "Unexpected end of file");
1347	}
1348
1349
1350	/**
1351	* Skips spaces and comments, returning the next character.
1352	*
1353	* @returns Next non-space-non-comment character. ~(unsigned)0 on EOF or
1354	* failure.
1355	* @param pStrm The stream.
1356	*/
1357	static unsigned parseGetNextNonSpaceNonCommentCh(PSCMSTREAM pStrm)
1358	{
1359	unsigned ch;
1360	while ((ch = ScmStreamGetCh(pStrm)) != ~(unsigned)0)
1361	{
1362	if (!RT_C_IS_SPACE(ch) && ch != '/')
1363	return ch;
1364	if (ch == '/')
1365	{
1366	ch = ScmStreamGetCh(pStrm);
1367	RTEXITCODE rcExit;
1368	if (ch == '*')
1369	rcExit = parseMultiLineComment(pStrm);
1370	else if (ch == '/')
1371	rcExit = parseOneLineComment(pStrm);
1372	else
1373	rcExit = parseError(pStrm, 2, "Unexpected character");
1374	if (rcExit != RTEXITCODE_SUCCESS)
1375	return ~(unsigned)0;
1376	}
1377	}
1378
1379	parseError(pStrm, 0, "Unexpected end of file");
1380	return ~(unsigned)0;
1381	}
1382
1383
1384	/**
1385	* Get the next non-space-non-comment character on a preprocessor line.
1386	*
1387	* @returns The next character. On error message and ~(unsigned)0.
1388	* @param pStrm The stream.
1389	*/
1390	static unsigned parseGetNextNonSpaceNonCommentChOnPpLine(PSCMSTREAM pStrm)
1391	{
1392	size_t off = ScmStreamTell(pStrm) - 1;
1393	unsigned ch;
1394	while ((ch = ScmStreamGetCh(pStrm)) != ~(unsigned)0)
1395	{
1396	if (RT_C_IS_SPACE(ch))
1397	{
1398	if (ch == '\n' \|\| ch == '\r')
1399	{
1400	parseErrorAbs(pStrm, off, "Invalid preprocessor statement");
1401	break;
1402	}
1403	}
1404	else if (ch == '\\')
1405	{
1406	size_t off2 = ScmStreamTell(pStrm) - 1;
1407	ch = ScmStreamGetCh(pStrm);
1408	if (ch == '\r')
1409	ch = ScmStreamGetCh(pStrm);
1410	if (ch != '\n')
1411	{
1412	parseErrorAbs(pStrm, off2, "Expected new line");
1413	break;
1414	}
1415	}
1416	else
1417	return ch;
1418	}
1419	return ~(unsigned)0;
1420	}
1421
1422
1423
1424	/**
1425	* Skips spaces and comments.
1426	*
1427	* @returns Same as ScmStreamCGetWord
1428	* @param pStrm The stream..
1429	* @param pcchWord Where to return the length.
1430	*/
1431	static const char parseGetNextCWord(PSCMSTREAM pStrm, size_t pcchWord)
1432	{
1433	if (parseSkipSpacesAndComments(pStrm) != RTEXITCODE_SUCCESS)
1434	return NULL;
1435	return ScmStreamCGetWord(pStrm, pcchWord);
1436	}
1437
1438
1439
1440	/**
1441	* Parses interface stability.
1442	*
1443	* @returns Interface stability if parsed correctly, otherwise error message and
1444	* kVTGStability_Invalid.
1445	* @param pStrm The stream.
1446	* @param ch The first character in the stability spec.
1447	*/
1448	static kVTGStability parseStability(PSCMSTREAM pStrm, unsigned ch)
1449	{
1450	switch (ch)
1451	{
1452	case 'E':
1453	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("External")))
1454	return kVTGStability_External;
1455	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Evolving")))
1456	return kVTGStability_Evolving;
1457	break;
1458	case 'I':
1459	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Internal")))
1460	return kVTGStability_Internal;
1461	break;
1462	case 'O':
1463	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Obsolete")))
1464	return kVTGStability_Obsolete;
1465	break;
1466	case 'P':
1467	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Private")))
1468	return kVTGStability_Private;
1469	break;
1470	case 'S':
1471	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Stable")))
1472	return kVTGStability_Stable;
1473	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Standard")))
1474	return kVTGStability_Standard;
1475	break;
1476	case 'U':
1477	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Unstable")))
1478	return kVTGStability_Unstable;
1479	break;
1480	}
1481	parseError(pStrm, 1, "Unknown stability specifier");
1482	return kVTGStability_Invalid;
1483	}
1484
1485
1486	/**
1487	* Parses data depndency class.
1488	*
1489	* @returns Data dependency class if parsed correctly, otherwise error message
1490	* and kVTGClass_Invalid.
1491	* @param pStrm The stream.
1492	* @param ch The first character in the stability spec.
1493	*/
1494	static kVTGClass parseDataDepClass(PSCMSTREAM pStrm, unsigned ch)
1495	{
1496	switch (ch)
1497	{
1498	case 'C':
1499	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Common")))
1500	return kVTGClass_Common;
1501	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Cpu")))
1502	return kVTGClass_Cpu;
1503	break;
1504	case 'G':
1505	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Group")))
1506	return kVTGClass_Group;
1507	break;
1508	case 'I':
1509	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Isa")))
1510	return kVTGClass_Isa;
1511	break;
1512	case 'P':
1513	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Platform")))
1514	return kVTGClass_Platform;
1515	break;
1516	case 'U':
1517	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("Unknown")))
1518	return kVTGClass_Unknown;
1519	break;
1520	}
1521	parseError(pStrm, 1, "Unknown data dependency class specifier");
1522	return kVTGClass_Invalid;
1523	}
1524
1525	/**
1526	* Parses a pragma D attributes statement.
1527	*
1528	* @returns Suitable exit code, errors message already written on failure.
1529	* @param pStrm The stream.
1530	*/
1531	static RTEXITCODE parsePragmaDAttributes(PSCMSTREAM pStrm)
1532	{
1533	/*
1534	* "CodeStability/DataStability/DataDepClass" - no spaces allowed.
1535	*/
1536	unsigned ch = parseGetNextNonSpaceNonCommentChOnPpLine(pStrm);
1537	if (ch == ~(unsigned)0)
1538	return RTEXITCODE_FAILURE;
1539
1540	kVTGStability enmCode = parseStability(pStrm, ch);
1541	if (enmCode == kVTGStability_Invalid)
1542	return RTEXITCODE_FAILURE;
1543	ch = ScmStreamGetCh(pStrm);
1544	if (ch != '/')
1545	return parseError(pStrm, 1, "Expected '/' following the code stability specifier");
1546
1547	kVTGStability enmData = parseStability(pStrm, ScmStreamGetCh(pStrm));
1548	if (enmData == kVTGStability_Invalid)
1549	return RTEXITCODE_FAILURE;
1550	ch = ScmStreamGetCh(pStrm);
1551	if (ch != '/')
1552	return parseError(pStrm, 1, "Expected '/' following the data stability specifier");
1553
1554	kVTGClass enmDataDep = parseDataDepClass(pStrm, ScmStreamGetCh(pStrm));
1555	if (enmDataDep == kVTGClass_Invalid)
1556	return RTEXITCODE_FAILURE;
1557
1558	/*
1559	* Expecting 'provider' followed by the name of an provider defined earlier.
1560	*/
1561	ch = parseGetNextNonSpaceNonCommentChOnPpLine(pStrm);
1562	if (ch == ~(unsigned)0)
1563	return RTEXITCODE_FAILURE;
1564	if (ch != 'p' \|\| !ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("provider")))
1565	return parseError(pStrm, 1, "Expected 'provider'");
1566
1567	size_t cchName;
1568	const char *pszName = parseGetNextCWord(pStrm, &cchName);
1569	if (!pszName)
1570	return parseError(pStrm, 1, "Expected provider name");
1571
1572	PVTGPROVIDER pProv;
1573	RTListForEach(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry)
1574	{
1575	if ( !strncmp(pProv->pszName, pszName, cchName)
1576	&& pProv->pszName[cchName] == '\0')
1577	break;
1578	}
1579	if (RTListNodeIsDummy(&g_ProviderHead, pProv, VTGPROVIDER, ListEntry))
1580	return parseError(pStrm, cchName, "Provider not found");
1581
1582	/*
1583	* Which aspect of the provider?
1584	*/
1585	size_t cchAspect;
1586	const char *pszAspect = parseGetNextCWord(pStrm, &cchAspect);
1587	if (!pszAspect)
1588	return parseError(pStrm, 1, "Expected provider aspect");
1589
1590	PVTGATTRS pAttrs;
1591	if (cchAspect == 8 && !memcmp(pszAspect, "provider", 8))
1592	pAttrs = &pProv->AttrSelf;
1593	else if (cchAspect == 8 && !memcmp(pszAspect, "function", 8))
1594	pAttrs = &pProv->AttrFunctions;
1595	else if (cchAspect == 6 && !memcmp(pszAspect, "module", 6))
1596	pAttrs = &pProv->AttrModules;
1597	else if (cchAspect == 4 && !memcmp(pszAspect, "name", 4))
1598	pAttrs = &pProv->AttrName;
1599	else if (cchAspect == 4 && !memcmp(pszAspect, "args", 4))
1600	pAttrs = &pProv->AttrArguments;
1601	else
1602	return parseError(pStrm, cchAspect, "Unknown aspect");
1603
1604	if (pAttrs->enmCode != kVTGStability_Invalid)
1605	return parseError(pStrm, cchAspect, "You have already specified these attributes");
1606
1607	pAttrs->enmCode = enmCode;
1608	pAttrs->enmData = enmData;
1609	pAttrs->enmDataDep = enmDataDep;
1610	return RTEXITCODE_SUCCESS;
1611	}
1612
1613	/**
1614	* Parses a D pragma statement.
1615	*
1616	* @returns Suitable exit code, errors message already written on failure.
1617	* @param pStrm The stream.
1618	*/
1619	static RTEXITCODE parsePragma(PSCMSTREAM pStrm)
1620	{
1621	RTEXITCODE rcExit;
1622	unsigned ch = parseGetNextNonSpaceNonCommentChOnPpLine(pStrm);
1623	if (ch == ~(unsigned)0)
1624	rcExit = RTEXITCODE_FAILURE;
1625	else if (ch == 'D' && ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("D")))
1626	{
1627	ch = parseGetNextNonSpaceNonCommentChOnPpLine(pStrm);
1628	if (ch == ~(unsigned)0)
1629	rcExit = RTEXITCODE_FAILURE;
1630	else if (ch == 'a' && ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("attributes")))
1631	rcExit = parsePragmaDAttributes(pStrm);
1632	else
1633	rcExit = parseError(pStrm, 1, "Unknown pragma D");
1634	}
1635	else
1636	rcExit = parseError(pStrm, 1, "Unknown pragma");
1637	return rcExit;
1638	}
1639
1640
1641	/**
1642	* Classifies the given type expression.
1643	*
1644	* @return Type flags.
1645	* @param pszType The type expression.
1646	*/
1647	static uint32_t parseTypeExpression(const char *pszType)
1648	{
1649	size_t cchType = strlen(pszType);
1650	#define MY_STRMATCH(a_sz) (cchType == sizeof(a_sz) - 1 && !memcmp(a_sz, pszType, sizeof(a_sz) - 1))
1651
1652	/*
1653	* Try detect pointers.
1654	*/
1655	if (pszType[cchType - 1] == '*') return VTG_TYPE_POINTER;
1656	if (pszType[cchType - 1] == '&')
1657	{
1658	RTMsgWarning("Please avoid using references like '%s' for probe arguments!", pszType);
1659	return VTG_TYPE_POINTER;
1660	}
1661
1662	/*
1663	* Standard integer types and IPRT variants.
1664	* It's important that we catch all types larger than 32-bit here or we'll
1665	* screw up the probe argument handling.
1666	*/
1667	if (MY_STRMATCH("int")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_SIGNED;
1668	if (MY_STRMATCH("uintptr_t")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_UNSIGNED;
1669	if (MY_STRMATCH("intptr_t")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_SIGNED;
1670
1671	//if (MY_STRMATCH("uint128_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint128_t) \| VTG_TYPE_UNSIGNED;
1672	if (MY_STRMATCH("uint64_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint64_t) \| VTG_TYPE_UNSIGNED;
1673	if (MY_STRMATCH("uint32_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint32_t) \| VTG_TYPE_UNSIGNED;
1674	if (MY_STRMATCH("uint16_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint16_t) \| VTG_TYPE_UNSIGNED;
1675	if (MY_STRMATCH("uint8_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint8_t) \| VTG_TYPE_UNSIGNED;
1676
1677	//if (MY_STRMATCH("int128_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int128_t) \| VTG_TYPE_SIGNED;
1678	if (MY_STRMATCH("int64_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int64_t) \| VTG_TYPE_SIGNED;
1679	if (MY_STRMATCH("int32_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int32_t) \| VTG_TYPE_SIGNED;
1680	if (MY_STRMATCH("int16_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int16_t) \| VTG_TYPE_SIGNED;
1681	if (MY_STRMATCH("int8_t")) return VTG_TYPE_FIXED_SIZED \| sizeof(int8_t) \| VTG_TYPE_SIGNED;
1682
1683	if (MY_STRMATCH("RTUINT64U")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint64_t) \| VTG_TYPE_UNSIGNED;
1684	if (MY_STRMATCH("RTUINT32U")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint32_t) \| VTG_TYPE_UNSIGNED;
1685	if (MY_STRMATCH("RTUINT16U")) return VTG_TYPE_FIXED_SIZED \| sizeof(uint16_t) \| VTG_TYPE_UNSIGNED;
1686
1687	if (MY_STRMATCH("RTMSINTERVAL")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTMSINTERVAL) \| VTG_TYPE_UNSIGNED;
1688	if (MY_STRMATCH("RTTIMESPEC")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTTIMESPEC) \| VTG_TYPE_SIGNED;
1689	if (MY_STRMATCH("RTPROCESS")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTPROCESS) \| VTG_TYPE_UNSIGNED;
1690	if (MY_STRMATCH("RTHCPHYS")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTHCPHYS) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_PHYS;
1691
1692	if (MY_STRMATCH("RTR3PTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3;
1693	if (MY_STRMATCH("RTR0PTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R0;
1694	if (MY_STRMATCH("RTRCPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_RC;
1695	if (MY_STRMATCH("RTHCPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0;
1696
1697	if (MY_STRMATCH("RTR3UINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_UNSIGNED;
1698	if (MY_STRMATCH("RTR0UINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R0 \| VTG_TYPE_UNSIGNED;
1699	if (MY_STRMATCH("RTRCUINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_RC \| VTG_TYPE_UNSIGNED;
1700	if (MY_STRMATCH("RTHCUINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_UNSIGNED;
1701
1702	if (MY_STRMATCH("RTR3INTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_SIGNED;
1703	if (MY_STRMATCH("RTR0INTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R0 \| VTG_TYPE_SIGNED;
1704	if (MY_STRMATCH("RTRCINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_RC \| VTG_TYPE_SIGNED;
1705	if (MY_STRMATCH("RTHCINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_SIGNED;
1706
1707	if (MY_STRMATCH("RTUINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_CTX_RC \| VTG_TYPE_UNSIGNED;
1708	if (MY_STRMATCH("RTINTPTR")) return VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_CTX_RC \| VTG_TYPE_SIGNED;
1709
1710	if (MY_STRMATCH("RTHCUINTREG")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_CTX_R3 \| VTG_TYPE_CTX_R0 \| VTG_TYPE_UNSIGNED;
1711	if (MY_STRMATCH("RTR3UINTREG")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_CTX_R3 \| VTG_TYPE_UNSIGNED;
1712	if (MY_STRMATCH("RTR0UINTREG")) return VTG_TYPE_HC_ARCH_SIZED \| VTG_TYPE_CTX_R3 \| VTG_TYPE_UNSIGNED;
1713
1714	if (MY_STRMATCH("RTGCUINTREG")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCUINTREG) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_CTX_GST;
1715	if (MY_STRMATCH("RTGCPTR")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPTR) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_CTX_GST;
1716	if (MY_STRMATCH("RTGCINTPTR")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCUINTPTR) \| VTG_TYPE_SIGNED \| VTG_TYPE_CTX_GST;
1717	if (MY_STRMATCH("RTGCPTR32")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPTR32) \| VTG_TYPE_SIGNED \| VTG_TYPE_CTX_GST;
1718	if (MY_STRMATCH("RTGCPTR64")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPTR64) \| VTG_TYPE_SIGNED \| VTG_TYPE_CTX_GST;
1719	if (MY_STRMATCH("RTGCPHYS")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPHYS) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_PHYS \| VTG_TYPE_CTX_GST;
1720	if (MY_STRMATCH("RTGCPHYS32")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPHYS32) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_PHYS \| VTG_TYPE_CTX_GST;
1721	if (MY_STRMATCH("RTGCPHYS64")) return VTG_TYPE_FIXED_SIZED \| sizeof(RTGCPHYS64) \| VTG_TYPE_UNSIGNED \| VTG_TYPE_PHYS \| VTG_TYPE_CTX_GST;
1722
1723	/*
1724	* The special VBox types.
1725	*/
1726	if (MY_STRMATCH("PVM")) return VTG_TYPE_POINTER;
1727	if (MY_STRMATCH("PVMCPU")) return VTG_TYPE_POINTER;
1728	if (MY_STRMATCH("PCPUMCTX")) return VTG_TYPE_POINTER;
1729
1730	/*
1731	* Preaching time.
1732	*/
1733	if ( MY_STRMATCH("unsigned long")
1734	\|\| MY_STRMATCH("unsigned long long")
1735	\|\| MY_STRMATCH("signed long")
1736	\|\| MY_STRMATCH("signed long long")
1737	\|\| MY_STRMATCH("long")
1738	\|\| MY_STRMATCH("long long")
1739	\|\| MY_STRMATCH("char")
1740	\|\| MY_STRMATCH("signed char")
1741	\|\| MY_STRMATCH("unsigned char")
1742	\|\| MY_STRMATCH("double")
1743	\|\| MY_STRMATCH("long double")
1744	\|\| MY_STRMATCH("float")
1745	)
1746	{
1747	RTMsgError("Please do NOT use the type '%s' for probe arguments!", pszType);
1748	g_cTypeErrors++;
1749	return 0;
1750	}
1751
1752	if ( MY_STRMATCH("unsigned")
1753	\|\| MY_STRMATCH("signed")
1754	\|\| MY_STRMATCH("signed int")
1755	\|\| MY_STRMATCH("unsigned int")
1756	\|\| MY_STRMATCH("short")
1757	\|\| MY_STRMATCH("signed short")
1758	\|\| MY_STRMATCH("unsigned short")
1759	)
1760	RTMsgWarning("Please avoid using the type '%s' for probe arguments!", pszType);
1761	if (MY_STRMATCH("unsigned")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_UNSIGNED;
1762	if (MY_STRMATCH("unsigned int")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_UNSIGNED;
1763	if (MY_STRMATCH("signed")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_SIGNED;
1764	if (MY_STRMATCH("signed int")) return VTG_TYPE_FIXED_SIZED \| sizeof(int) \| VTG_TYPE_SIGNED;
1765	if (MY_STRMATCH("short")) return VTG_TYPE_FIXED_SIZED \| sizeof(short) \| VTG_TYPE_SIGNED;
1766	if (MY_STRMATCH("signed short")) return VTG_TYPE_FIXED_SIZED \| sizeof(short) \| VTG_TYPE_SIGNED;
1767	if (MY_STRMATCH("unsigned short")) return VTG_TYPE_FIXED_SIZED \| sizeof(short) \| VTG_TYPE_UNSIGNED;
1768
1769	/*
1770	* What we haven't caught by now is either unknown to us or wrong.
1771	*/
1772	if (pszType[0] == 'P')
1773	{
1774	RTMsgError("Type '%s' looks like a pointer typedef, please do NOT use those "
1775	"but rather the non-pointer typedef or struct with '*'",
1776	pszType);
1777	g_cTypeErrors++;
1778	return VTG_TYPE_POINTER;
1779	}
1780
1781	RTMsgError("Don't know '%s' - please change or fix VBoxTpG", pszType);
1782	g_cTypeErrors++;
1783
1784	#undef MY_STRCMP
1785	return 0;
1786	}
1787
1788
1789	/**
1790	* Initializes the members of an argument.
1791	*
1792	* @returns RTEXITCODE_SUCCESS or RTEXITCODE_FAILURE+msg.
1793	* @param pProbe The probe.
1794	* @param pArg The argument.
1795	* @param pStrm The input stream (for errors).
1796	* @param pchType The type.
1797	* @param cchType The type length.
1798	* @param pchName The name.
1799	* @param cchName The name length.
1800	*/
1801	static RTEXITCODE parseInitArgument(PVTGPROBE pProbe, PVTGARG pArg, PSCMSTREAM pStrm,
1802	char pchType, size_t cchType, char pchName, size_t cchName)
1803	{
1804	Assert(!pArg->pszName); Assert(!pArg->pszTracerType); Assert(!pArg->pszCtxType); Assert(!pArg->fType);
1805
1806	pArg->pszArgPassingFmt = ", %s";
1807	pArg->pszName = RTStrDupN(pchName, cchName);
1808	pArg->pszTracerType = strtabInsertN(pchType, cchType);
1809	if (!pArg->pszTracerType \|\| !pArg->pszName)
1810	return parseError(pStrm, 1, "Out of memory");
1811	pArg->fType = parseTypeExpression(pArg->pszTracerType);
1812
1813	if ( (pArg->fType & VTG_TYPE_POINTER)
1814	&& !(g_fTypeContext & VTG_TYPE_CTX_R0) )
1815	{
1816	pArg->fType &= ~VTG_TYPE_POINTER;
1817	if ( !strcmp(pArg->pszTracerType, "struct VM *") \|\| !strcmp(pArg->pszTracerType, "PVM")
1818	\|\| !strcmp(pArg->pszTracerType, "struct VMCPU *") \|\| !strcmp(pArg->pszTracerType, "PVMCPU")
1819	\|\| !strcmp(pArg->pszTracerType, "struct CPUMCTX *") \|\| !strcmp(pArg->pszTracerType, "PCPUMCTX")
1820	)
1821	{
1822	pArg->fType \|= VTG_TYPE_CTX_POINTER \| VTG_TYPE_CTX_R0
1823	\| VTG_TYPE_FIXED_SIZED \| (g_cHostBits / 8)
1824	\| VTG_TYPE_AUTO_CONV_PTR;
1825	pArg->pszCtxType = RTStrDup("RTR0PTR");
1826
1827	if (!strcmp(pArg->pszTracerType, "struct VM *") \|\| !strcmp(pArg->pszTracerType, "PVM"))
1828	pArg->pszArgPassingFmt = ", VTG_VM_TO_R0(%s)";
1829	else if (!strcmp(pArg->pszTracerType, "struct VMCPU *") \|\| !strcmp(pArg->pszTracerType, "PVMCPU"))
1830	pArg->pszArgPassingFmt = ", VTG_VMCPU_TO_R0(%s)";
1831	else
1832	{
1833	PVTGARG pFirstArg = RTListGetFirst(&pProbe->ArgHead, VTGARG, ListEntry);
1834	if ( !pFirstArg
1835	\|\| pFirstArg == pArg
1836	\|\| strcmp(pFirstArg->pszName, "a_pVCpu")
1837	\|\| ( strcmp(pFirstArg->pszTracerType, "struct VMCPU *")
1838	&& strcmp(pFirstArg->pszTracerType, "PVMCPU *")) )
1839	return parseError(pStrm, 1, "The automatic ring-0 pointer conversion requires 'a_pVCpu' with type 'struct VMCPU *' as the first argument");
1840
1841	if (!strcmp(pArg->pszTracerType, "struct CPUMCTX *")\|\| !strcmp(pArg->pszTracerType, "PCPUMCTX"))
1842	pArg->pszArgPassingFmt = ", VTG_CPUMCTX_TO_R0(a_pVCpu, %s)";
1843	else
1844	pArg->pszArgPassingFmt = ", VBoxTpG-Is-Buggy!!";
1845	}
1846	}
1847	else
1848	{
1849	pArg->fType \|= VTG_TYPE_CTX_POINTER \| g_fTypeContext \| VTG_TYPE_FIXED_SIZED \| (g_cBits / 8);
1850	pArg->pszCtxType = RTStrDupN(pchType, cchType);
1851	}
1852	}
1853	else
1854	pArg->pszCtxType = RTStrDupN(pchType, cchType);
1855	if (!pArg->pszCtxType)
1856	return parseError(pStrm, 1, "Out of memory");
1857
1858	return RTEXITCODE_SUCCESS;
1859	}
1860
1861
1862	/**
1863	* Unmangles the probe name.
1864	*
1865	* This involves translating double underscore to dash.
1866	*
1867	* @returns Pointer to the unmangled name in the string table.
1868	* @param pszMangled The mangled name.
1869	*/
1870	static const char parseUnmangleProbeName(const char pszMangled)
1871	{
1872	size_t cchMangled = strlen(pszMangled);
1873	char pszTmp = (char )alloca(cchMangled + 2);
1874	const char *pszSrc = pszMangled;
1875	char *pszDst = pszTmp;
1876
1877	while (*pszSrc)
1878	{
1879	if (pszSrc[0] == '_' && pszSrc[1] == '_' && pszSrc[2] != '_')
1880	{
1881	*pszDst++ = '-';
1882	pszSrc += 2;
1883	}
1884	else
1885	pszDst++ = pszSrc++;
1886	}
1887	*pszDst = '\0';
1888
1889	return strtabInsertN(pszTmp, pszDst - pszTmp);
1890	}
1891
1892
1893	/**
1894	* Parses a D probe statement.
1895	*
1896	* @returns Suitable exit code, errors message already written on failure.
1897	* @param pStrm The stream.
1898	* @param pProv The provider being parsed.
1899	*/
1900	static RTEXITCODE parseProbe(PSCMSTREAM pStrm, PVTGPROVIDER pProv)
1901	{
1902	/*
1903	* Next up is a name followed by an opening parenthesis.
1904	*/
1905	size_t cchProbe;
1906	const char *pszProbe = parseGetNextCWord(pStrm, &cchProbe);
1907	if (!pszProbe)
1908	return parseError(pStrm, 1, "Expected a probe name starting with an alphabetical character");
1909	unsigned ch = parseGetNextNonSpaceNonCommentCh(pStrm);
1910	if (ch != '(')
1911	return parseError(pStrm, 1, "Expected '(' after the probe name");
1912
1913	/*
1914	* Create a probe instance.
1915	*/
1916	PVTGPROBE pProbe = (PVTGPROBE)RTMemAllocZ(sizeof(*pProbe));
1917	if (!pProbe)
1918	return parseError(pStrm, 0, "Out of memory");
1919	RTListInit(&pProbe->ArgHead);
1920	RTListAppend(&pProv->ProbeHead, &pProbe->ListEntry);
1921	pProbe->offArgList = UINT32_MAX;
1922	pProbe->pszMangledName = RTStrDupN(pszProbe, cchProbe);
1923	if (!pProbe->pszMangledName)
1924	return parseError(pStrm, 0, "Out of memory");
1925	pProbe->pszUnmangledName = parseUnmangleProbeName(pProbe->pszMangledName);
1926	if (!pProbe->pszUnmangledName)
1927	return parseError(pStrm, 0, "Out of memory");
1928
1929	/*
1930	* Parse loop for the argument.
1931	*/
1932	PVTGARG pArg = NULL;
1933	size_t cchName = 0;
1934	size_t cchArg = 0;
1935	char szArg[4096];
1936	for (;;)
1937	{
1938	ch = parseGetNextNonSpaceNonCommentCh(pStrm);
1939	switch (ch)
1940	{
1941	case ')':
1942	case ',':
1943	{
1944	/* commit the argument */
1945	if (pArg)
1946	{
1947	if (!cchName)
1948	return parseError(pStrm, 1, "Argument has no name");
1949	if (cchArg - cchName - 1 >= 128)
1950	return parseError(pStrm, 1, "Argument type too long");
1951	RTEXITCODE rcExit = parseInitArgument(pProbe, pArg, pStrm,
1952	szArg, cchArg - cchName - 1,
1953	&szArg[cchArg - cchName], cchName);
1954	if (rcExit != RTEXITCODE_SUCCESS)
1955	return rcExit;
1956	if (VTG_TYPE_IS_LARGE(pArg->fType))
1957	pProbe->fHaveLargeArgs = true;
1958	pArg = NULL;
1959	cchName = cchArg = 0;
1960	}
1961	if (ch == ')')
1962	{
1963	size_t off = ScmStreamTell(pStrm);
1964	ch = parseGetNextNonSpaceNonCommentCh(pStrm);
1965	if (ch != ';')
1966	return parseErrorAbs(pStrm, off, "Expected ';'");
1967	return RTEXITCODE_SUCCESS;
1968	}
1969	break;
1970	}
1971
1972	default:
1973	{
1974	size_t cchWord;
1975	const char *pszWord = ScmStreamCGetWordM1(pStrm, &cchWord);
1976	if (!pszWord)
1977	return parseError(pStrm, 0, "Expected argument");
1978	if (!pArg)
1979	{
1980	pArg = (PVTGARG)RTMemAllocZ(sizeof(*pArg));
1981	if (!pArg)
1982	return parseError(pStrm, 1, "Out of memory");
1983	RTListAppend(&pProbe->ArgHead, &pArg->ListEntry);
1984	pProbe->cArgs++;
1985
1986	if (cchWord + 1 > sizeof(szArg))
1987	return parseError(pStrm, 1, "Too long parameter declaration");
1988	memcpy(szArg, pszWord, cchWord);
1989	szArg[cchWord] = '\0';
1990	cchArg = cchWord;
1991	cchName = 0;
1992	}
1993	else
1994	{
1995	if (cchArg + 1 + cchWord + 1 > sizeof(szArg))
1996	return parseError(pStrm, 1, "Too long parameter declaration");
1997
1998	szArg[cchArg++] = ' ';
1999	memcpy(&szArg[cchArg], pszWord, cchWord);
2000	cchArg += cchWord;
2001	szArg[cchArg] = '\0';
2002	cchName = cchWord;
2003	}
2004	break;
2005	}
2006
2007	case '*':
2008	{
2009	if (!pArg)
2010	return parseError(pStrm, 1, "A parameter type does not start with an asterix");
2011	if (cchArg + sizeof(" *") >= sizeof(szArg))
2012	return parseError(pStrm, 1, "Too long parameter declaration");
2013	szArg[cchArg++] = ' ';
2014	szArg[cchArg++] = '*';
2015	szArg[cchArg ] = '\0';
2016	cchName = 0;
2017	break;
2018	}
2019
2020	case ~(unsigned)0:
2021	return parseError(pStrm, 0, "Missing closing ')' on probe");
2022	}
2023	}
2024	}
2025
2026	/**
2027	* Parses a D provider statement.
2028	*
2029	* @returns Suitable exit code, errors message already written on failure.
2030	* @param pStrm The stream.
2031	*/
2032	static RTEXITCODE parseProvider(PSCMSTREAM pStrm)
2033	{
2034	/*
2035	* Next up is a name followed by a curly bracket. Ignore comments.
2036	*/
2037	RTEXITCODE rcExit = parseSkipSpacesAndComments(pStrm);
2038	if (rcExit != RTEXITCODE_SUCCESS)
2039	return parseError(pStrm, 1, "Expected a provider name starting with an alphabetical character");
2040	size_t cchName;
2041	const char *pszName = ScmStreamCGetWord(pStrm, &cchName);
2042	if (!pszName)
2043	return parseError(pStrm, 0, "Bad provider name");
2044	if (RT_C_IS_DIGIT(pszName[cchName - 1]))
2045	return parseError(pStrm, 1, "A provider name cannot end with digit");
2046
2047	unsigned ch = parseGetNextNonSpaceNonCommentCh(pStrm);
2048	if (ch != '{')
2049	return parseError(pStrm, 1, "Expected '{' after the provider name");
2050
2051	/*
2052	* Create a provider instance.
2053	*/
2054	PVTGPROVIDER pProv = (PVTGPROVIDER)RTMemAllocZ(sizeof(*pProv));
2055	if (!pProv)
2056	return parseError(pStrm, 0, "Out of memory");
2057	RTListInit(&pProv->ProbeHead);
2058	RTListAppend(&g_ProviderHead, &pProv->ListEntry);
2059	pProv->pszName = strtabInsertN(pszName, cchName);
2060	if (!pProv->pszName)
2061	return parseError(pStrm, 0, "Out of memory");
2062
2063	/*
2064	* Parse loop.
2065	*/
2066	for (;;)
2067	{
2068	ch = parseGetNextNonSpaceNonCommentCh(pStrm);
2069	switch (ch)
2070	{
2071	case 'p':
2072	if (ScmStreamCMatchingWordM1(pStrm, RT_STR_TUPLE("probe")))
2073	rcExit = parseProbe(pStrm, pProv);
2074	else
2075	rcExit = parseError(pStrm, 1, "Unexpected character");
2076	break;
2077
2078	case '}':
2079	{
2080	size_t off = ScmStreamTell(pStrm);
2081	ch = parseGetNextNonSpaceNonCommentCh(pStrm);
2082	if (ch == ';')
2083	return RTEXITCODE_SUCCESS;
2084	rcExit = parseErrorAbs(pStrm, off, "Expected ';'");
2085	break;
2086	}
2087
2088	case ~(unsigned)0:
2089	rcExit = parseError(pStrm, 0, "Missing closing '}' on provider");
2090	break;
2091
2092	default:
2093	rcExit = parseError(pStrm, 1, "Unexpected character");
2094	break;
2095	}
2096	if (rcExit != RTEXITCODE_SUCCESS)
2097	return rcExit;
2098	}
2099	}
2100
2101
2102	static RTEXITCODE parseScript(const char *pszScript)
2103	{
2104	SCMSTREAM Strm;
2105	int rc = ScmStreamInitForReading(&Strm, pszScript);
2106	if (RT_FAILURE(rc))
2107	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to open & read '%s' into memory: %Rrc", pszScript, rc);
2108	if (g_cVerbosity > 0)
2109	RTMsgInfo("Parsing '%s'...", pszScript);
2110
2111	RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
2112	unsigned ch;
2113	while ((ch = ScmStreamGetCh(&Strm)) != ~(unsigned)0)
2114	{
2115	if (RT_C_IS_SPACE(ch))
2116	continue;
2117	switch (ch)
2118	{
2119	case '/':
2120	ch = ScmStreamGetCh(&Strm);
2121	if (ch == '*')
2122	rcExit = parseMultiLineComment(&Strm);
2123	else if (ch == '/')
2124	rcExit = parseOneLineComment(&Strm);
2125	else
2126	rcExit = parseError(&Strm, 2, "Unexpected character");
2127	break;
2128
2129	case 'p':
2130	if (ScmStreamCMatchingWordM1(&Strm, RT_STR_TUPLE("provider")))
2131	rcExit = parseProvider(&Strm);
2132	else
2133	rcExit = parseError(&Strm, 1, "Unexpected character");
2134	break;
2135
2136	case '#':
2137	{
2138	ch = parseGetNextNonSpaceNonCommentChOnPpLine(&Strm);
2139	if (ch == ~(unsigned)0)
2140	rcExit = RTEXITCODE_FAILURE;
2141	else if (ch == 'p' && ScmStreamCMatchingWordM1(&Strm, RT_STR_TUPLE("pragma")))
2142	rcExit = parsePragma(&Strm);
2143	else
2144	rcExit = parseError(&Strm, 1, "Unsupported preprocessor directive");
2145	break;
2146	}
2147
2148	default:
2149	rcExit = parseError(&Strm, 1, "Unexpected character");
2150	break;
2151	}
2152	if (rcExit != RTEXITCODE_SUCCESS)
2153	return rcExit;
2154	}
2155
2156	ScmStreamDelete(&Strm);
2157	if (g_cVerbosity > 0 && rcExit == RTEXITCODE_SUCCESS)
2158	RTMsgInfo("Successfully parsed '%s'.", pszScript);
2159	return rcExit;
2160	}
2161
2162
2163	/**
2164	* Parses the arguments.
2165	*/
2166	static RTEXITCODE parseArguments(int argc, char **argv)
2167	{
2168	/*
2169	* Set / Adjust defaults.
2170	*/
2171	int rc = RTPathAbs(g_pszAssemblerIncVal, g_szAssemblerIncVal, sizeof(g_szAssemblerIncVal) - 1);
2172	if (RT_FAILURE(rc))
2173	return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTPathAbs failed: %Rrc", rc);
2174	strcat(g_szAssemblerIncVal, "/");
2175	g_pszAssemblerIncVal = g_szAssemblerIncVal;
2176
2177	/*
2178	* Option config.
2179	*/
2180	enum
2181	{
2182	kVBoxTpGOpt_32Bit = 1000,
2183	kVBoxTpGOpt_64Bit,
2184	kVBoxTpGOpt_GenerateWrapperHeader,
2185	kVBoxTpGOpt_Assembler,
2186	kVBoxTpGOpt_AssemblerFmtOpt,
2187	kVBoxTpGOpt_AssemblerFmtVal,
2188	kVBoxTpGOpt_AssemblerOutputOpt,
2189	kVBoxTpGOpt_AssemblerOption,
2190	kVBoxTpGOpt_Pic,
2191	kVBoxTpGOpt_ProbeFnName,
2192	kVBoxTpGOpt_ProbeFnImported,
2193	kVBoxTpGOpt_ProbeFnNotImported,
2194	kVBoxTpGOpt_Host32Bit,
2195	kVBoxTpGOpt_Host64Bit,
2196	kVBoxTpGOpt_RawModeContext,
2197	kVBoxTpGOpt_Ring0Context,
2198	kVBoxTpGOpt_Ring0ContextAgnostic,
2199	kVBoxTpGOpt_Ring3Context,
2200	kVBoxTpGOpt_End
2201	};
2202
2203	static RTGETOPTDEF const s_aOpts[] =
2204	{
2205	/* dtrace w/ long options */
2206	{ "-32", kVBoxTpGOpt_32Bit, RTGETOPT_REQ_NOTHING },
2207	{ "-64", kVBoxTpGOpt_64Bit, RTGETOPT_REQ_NOTHING },
2208	{ "--apply-cpp", 'C', RTGETOPT_REQ_NOTHING },
2209	{ "--generate-obj", 'G', RTGETOPT_REQ_NOTHING },
2210	{ "--generate-header", 'h', RTGETOPT_REQ_NOTHING },
2211	{ "--output", 'o', RTGETOPT_REQ_STRING },
2212	{ "--script", 's', RTGETOPT_REQ_STRING },
2213	{ "--verbose", 'v', RTGETOPT_REQ_NOTHING },
2214	/* our stuff */
2215	{ "--generate-wrapper-header", kVBoxTpGOpt_GenerateWrapperHeader, RTGETOPT_REQ_NOTHING },
2216	{ "--assembler", kVBoxTpGOpt_Assembler, RTGETOPT_REQ_STRING },
2217	{ "--assembler-fmt-opt", kVBoxTpGOpt_AssemblerFmtOpt, RTGETOPT_REQ_STRING },
2218	{ "--assembler-fmt-val", kVBoxTpGOpt_AssemblerFmtVal, RTGETOPT_REQ_STRING },
2219	{ "--assembler-output-opt", kVBoxTpGOpt_AssemblerOutputOpt, RTGETOPT_REQ_STRING },
2220	{ "--assembler-option", kVBoxTpGOpt_AssemblerOption, RTGETOPT_REQ_STRING },
2221	{ "--pic", kVBoxTpGOpt_Pic, RTGETOPT_REQ_NOTHING },
2222	{ "--probe-fn-name", kVBoxTpGOpt_ProbeFnName, RTGETOPT_REQ_STRING },
2223	{ "--probe-fn-imported", kVBoxTpGOpt_ProbeFnImported, RTGETOPT_REQ_NOTHING },
2224	{ "--probe-fn-not-imported", kVBoxTpGOpt_ProbeFnNotImported, RTGETOPT_REQ_NOTHING },
2225	{ "--host-32-bit", kVBoxTpGOpt_Host32Bit, RTGETOPT_REQ_NOTHING },
2226	{ "--host-64-bit", kVBoxTpGOpt_Host64Bit, RTGETOPT_REQ_NOTHING },
2227	{ "--raw-mode-context", kVBoxTpGOpt_RawModeContext, RTGETOPT_REQ_NOTHING },
2228	{ "--ring-0-context", kVBoxTpGOpt_Ring0Context, RTGETOPT_REQ_NOTHING },
2229	{ "--ring-0-context-agnostic", kVBoxTpGOpt_Ring0ContextAgnostic, RTGETOPT_REQ_NOTHING },
2230	{ "--ring-3-context", kVBoxTpGOpt_Ring3Context, RTGETOPT_REQ_NOTHING },
2231	/** @todo We're missing a bunch of assembler options! */
2232	};
2233
2234	RTGETOPTUNION ValueUnion;
2235	RTGETOPTSTATE GetOptState;
2236	rc = RTGetOptInit(&GetOptState, argc, argv, &s_aOpts[0], RT_ELEMENTS(s_aOpts), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2237	AssertReleaseRCReturn(rc, RTEXITCODE_FAILURE);
2238
2239	/*
2240	* Process the options.
2241	*/
2242	while ((rc = RTGetOpt(&GetOptState, &ValueUnion)) != 0)
2243	{
2244	switch (rc)
2245	{
2246	/*
2247	* DTrace compatible options.
2248	*/
2249	case kVBoxTpGOpt_32Bit:
2250	g_cHostBits = g_cBits = 32;
2251	g_pszAssemblerFmtVal = g_szAssemblerFmtVal32;
2252	break;
2253
2254	case kVBoxTpGOpt_64Bit:
2255	g_cHostBits = g_cBits = 64;
2256	g_pszAssemblerFmtVal = g_szAssemblerFmtVal64;
2257	break;
2258
2259	case 'C':
2260	g_fApplyCpp = true;
2261	RTMsgWarning("Ignoring the -C option - no preprocessing of the D script will be performed");
2262	break;
2263
2264	case 'G':
2265	if ( g_enmAction != kVBoxTpGAction_Nothing
2266	&& g_enmAction != kVBoxTpGAction_GenerateObject)
2267	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "-G does not mix with -h or --generate-wrapper-header");
2268	g_enmAction = kVBoxTpGAction_GenerateObject;
2269	break;
2270
2271	case 'h':
2272	if (!strcmp(GetOptState.pDef->pszLong, "--generate-header"))
2273	{
2274	if ( g_enmAction != kVBoxTpGAction_Nothing
2275	&& g_enmAction != kVBoxTpGAction_GenerateHeader)
2276	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "-h does not mix with -G or --generate-wrapper-header");
2277	g_enmAction = kVBoxTpGAction_GenerateHeader;
2278	}
2279	else
2280	{
2281	/* --help or similar */
2282	RTPrintf("VirtualBox Tracepoint Generator\n"
2283	"\n"
2284	"Usage: %s [options]\n"
2285	"\n"
2286	"Options:\n", RTProcShortName());
2287	for (size_t i = 0; i < RT_ELEMENTS(s_aOpts); i++)
2288	if ((unsigned)s_aOpts[i].iShort < 128)
2289	RTPrintf(" -%c,%s\n", s_aOpts[i].iShort, s_aOpts[i].pszLong);
2290	else
2291	RTPrintf(" %s\n", s_aOpts[i].pszLong);
2292	return RTEXITCODE_SUCCESS;
2293	}
2294	break;
2295
2296	case 'o':
2297	if (g_pszOutput)
2298	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Output file is already set to '%s'", g_pszOutput);
2299	g_pszOutput = ValueUnion.psz;
2300	break;
2301
2302	case 's':
2303	if (g_pszScript)
2304	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Script file is already set to '%s'", g_pszScript);
2305	g_pszScript = ValueUnion.psz;
2306	break;
2307
2308	case 'v':
2309	g_cVerbosity++;
2310	break;
2311
2312	case 'V':
2313	{
2314	/* The following is assuming that svn does it's job here. */
2315	static const char s_szRev[] = "$Revision: 47518 $";
2316	const char *psz = RTStrStripL(strchr(s_szRev, ' '));
2317	RTPrintf("r%.*s\n", strchr(psz, ' ') - psz, psz);
2318	return RTEXITCODE_SUCCESS;
2319	}
2320
2321	case VINF_GETOPT_NOT_OPTION:
2322	if (g_enmAction == kVBoxTpGAction_GenerateObject)
2323	break; /* object files, ignore them. */
2324	return RTGetOptPrintError(rc, &ValueUnion);
2325
2326
2327	/*
2328	* Our options.
2329	*/
2330	case kVBoxTpGOpt_GenerateWrapperHeader:
2331	if ( g_enmAction != kVBoxTpGAction_Nothing
2332	&& g_enmAction != kVBoxTpGAction_GenerateWrapperHeader)
2333	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--generate-wrapper-header does not mix with -h or -G");
2334	g_enmAction = kVBoxTpGAction_GenerateWrapperHeader;
2335	break;
2336
2337	case kVBoxTpGOpt_Assembler:
2338	g_pszAssembler = ValueUnion.psz;
2339	break;
2340
2341	case kVBoxTpGOpt_AssemblerFmtOpt:
2342	g_pszAssemblerFmtOpt = ValueUnion.psz;
2343	break;
2344
2345	case kVBoxTpGOpt_AssemblerFmtVal:
2346	g_pszAssemblerFmtVal = ValueUnion.psz;
2347	break;
2348
2349	case kVBoxTpGOpt_AssemblerOutputOpt:
2350	g_pszAssemblerOutputOpt = ValueUnion.psz;
2351	break;
2352
2353	case kVBoxTpGOpt_AssemblerOption:
2354	if (g_cAssemblerOptions >= RT_ELEMENTS(g_apszAssemblerOptions))
2355	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Too many assembly options (max %u)", RT_ELEMENTS(g_apszAssemblerOptions));
2356	g_apszAssemblerOptions[g_cAssemblerOptions] = ValueUnion.psz;
2357	g_cAssemblerOptions++;
2358	break;
2359
2360	case kVBoxTpGOpt_Pic:
2361	g_fPic = true;
2362	break;
2363
2364	case kVBoxTpGOpt_ProbeFnName:
2365	g_pszProbeFnName = ValueUnion.psz;
2366	break;
2367
2368	case kVBoxTpGOpt_ProbeFnImported:
2369	g_fProbeFnImported = true;
2370	break;
2371
2372	case kVBoxTpGOpt_ProbeFnNotImported:
2373	g_fProbeFnImported = false;
2374	break;
2375
2376	case kVBoxTpGOpt_Host32Bit:
2377	g_cHostBits = 32;
2378	break;
2379
2380	case kVBoxTpGOpt_Host64Bit:
2381	g_cHostBits = 64;
2382	break;
2383
2384	case kVBoxTpGOpt_RawModeContext:
2385	g_fTypeContext = VTG_TYPE_CTX_RC;
2386	g_pszContextDefine = "IN_RC";
2387	g_pszContextDefine2 = NULL;
2388	break;
2389
2390	case kVBoxTpGOpt_Ring0Context:
2391	g_fTypeContext = VTG_TYPE_CTX_R0;
2392	g_pszContextDefine = "IN_RING0";
2393	g_pszContextDefine2 = NULL;
2394	break;
2395
2396	case kVBoxTpGOpt_Ring0ContextAgnostic:
2397	g_fTypeContext = VTG_TYPE_CTX_R0;
2398	g_pszContextDefine = "IN_RING0_AGNOSTIC";
2399	g_pszContextDefine2 = "IN_RING0";
2400	break;
2401
2402	case kVBoxTpGOpt_Ring3Context:
2403	g_fTypeContext = VTG_TYPE_CTX_R3;
2404	g_pszContextDefine = "IN_RING3";
2405	g_pszContextDefine2 = NULL;
2406	break;
2407
2408
2409	/*
2410	* Errors and bugs.
2411	*/
2412	default:
2413	return RTGetOptPrintError(rc, &ValueUnion);
2414	}
2415	}
2416
2417	/*
2418	* Check that we've got all we need.
2419	*/
2420	if (g_enmAction == kVBoxTpGAction_Nothing)
2421	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No action specified (-h, -G or --generate-wrapper-header)");
2422	if (!g_pszScript)
2423	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No script file specified (-s)");
2424	if (!g_pszOutput)
2425	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No output file specified (-o)");
2426
2427	return RTEXITCODE_SUCCESS;
2428	}
2429
2430
2431	int main(int argc, char **argv)
2432	{
2433	int rc = RTR3InitExe(argc, &argv, 0);
2434	if (RT_FAILURE(rc))
2435	return 1;
2436
2437	RTEXITCODE rcExit = parseArguments(argc, argv);
2438	if (rcExit == RTEXITCODE_SUCCESS)
2439	{
2440	/*
2441	* Parse the script.
2442	*/
2443	RTListInit(&g_ProviderHead);
2444	rcExit = parseScript(g_pszScript);
2445	if (rcExit == RTEXITCODE_SUCCESS)
2446	{
2447	/*
2448	* Take action.
2449	*/
2450	if (g_enmAction == kVBoxTpGAction_GenerateHeader)
2451	rcExit = generateFile(g_pszOutput, "header", generateHeader);
2452	else if (g_enmAction == kVBoxTpGAction_GenerateWrapperHeader)
2453	rcExit = generateFile(g_pszOutput, "wrapper header", generateWrapperHeader);
2454	else
2455	rcExit = generateObject(g_pszOutput, g_pszTempAsm);
2456	}
2457	}
2458
2459	if (rcExit == RTEXITCODE_SUCCESS && g_cTypeErrors > 0)
2460	rcExit = RTEXITCODE_FAILURE;
2461	return rcExit;
2462	}
2463

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

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

Download in other formats: