VBoxTpG.cpp@ 46556

Last change on this file since 46556 was 46556, checked in by vboxsync, 11 years ago
build fix
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 94.4 KB

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

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

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

Download in other formats: