tracelog-decoder-plugin.h

Last change on this file was 104974, checked in by vboxsync, 5 months ago
Devices/Trace: Updates to the TPM trace decoding, bugref:10701 [missing files]
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 19.3 KB

Line
1	/** @file
2	* IPRT: Tracelog decoder plugin API for RTTraceLogTool.
3	*/
4
5	/*
6	* Copyright (C) 2024 Oracle and/or its affiliates.
7	*
8	* This file is part of VirtualBox base platform packages, as
9	* available from https://www.virtualbox.org.
10	*
11	* This program is free software; you can redistribute it and/or
12	* modify it under the terms of the GNU General Public License
13	* as published by the Free Software Foundation, in version 3 of the
14	* License.
15	*
16	* This program is distributed in the hope that it will be useful, but
17	* WITHOUT ANY WARRANTY; without even the implied warranty of
18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19	* General Public License for more details.
20	*
21	* You should have received a copy of the GNU General Public License
22	* along with this program; if not, see <https://www.gnu.org/licenses>.
23	*
24	* The contents of this file may alternatively be used under the terms
25	* of the Common Development and Distribution License Version 1.0
26	* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27	* in the VirtualBox distribution, in which case the provisions of the
28	* CDDL are applicable instead of those of the GPL.
29	*
30	* You may elect to license modified versions of this file under the
31	* terms and conditions of either the GPL or the CDDL or both.
32	*
33	* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34	*/
35
36	#ifndef IPRT_INCLUDED_tracelog_decoder_plugin_h
37	#define IPRT_INCLUDED_tracelog_decoder_plugin_h
38	#ifndef RT_WITHOUT_PRAGMA_ONCE
39	# pragma once
40	#endif
41
42	#include <iprt/cdefs.h>
43	#include <iprt/tracelog.h>
44	#include <iprt/types.h>
45
46
47	/** Pointer to helper functions for decoders. */
48	typedef struct RTTRACELOGDECODERHLP *PRTTRACELOGDECODERHLP;
49
50
51	/**
52	* Decoder state free callback.
53	*
54	* @param pHlp Pointer to the callback structure.
55	* @param pvState Pointer to the decoder state.
56	*/
57	typedef DECLCALLBACKTYPE(void, FNTRACELOGDECODERSTATEFREE,(PRTTRACELOGDECODERHLP pHlp, void *pvState));
58	/** Pointer to an event decode callback. */
59	typedef FNTRACELOGDECODERSTATEFREE *PFNTRACELOGDECODERSTATEFREE;
60
61
62	/** The integer value should be dumped as a hex number instead. */
63	#define RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_HEX RT_BIT_32(0)
64	/** The hexdump should be dumped as an inline string (Rhxs). */
65	#define RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_HEX_DUMP_STR RT_BIT_32(1)
66
67
68	/**
69	* An enum entry for the struct builder.
70	*/
71	typedef struct RTTRACELOGDECODERSTRUCTBLDENUM
72	{
73	/** The raw enum value. */
74	uint64_t u64EnumVal;
75	/** String version of the enum value. */
76	const char *pszString;
77	/** Some opaque user data not used by RTTRACELOGDECODERHLP::pfnStructBldAddEnum. */
78	uintptr_t uPtrUser;
79	} RTTRACELOGDECODERSTRUCTBLDENUM;
80	/** Pointer to a struct build enum entry. */
81	typedef RTTRACELOGDECODERSTRUCTBLDENUM *PRTTRACELOGDECODERSTRUCTBLDENUM;
82	/** Pointer to a const struct build enum entry. */
83	typedef const RTTRACELOGDECODERSTRUCTBLDENUM *PCRTTRACELOGDECODERSTRUCTBLDENUM;
84
85
86	/** Initializes a enum entry, extended version. */
87	#define RT_TRACELOG_DECODER_STRUCT_BLD_ENUM_INIT_EX(a_enmVal, a_uPtrUser) \
88	{ a_enmVal, #a_enmVal, a_uPtrUser }
89	/** Initializes a enum entry, extended version. */
90	#define RT_TRACELOG_DECODER_STRUCT_BLD_ENUM_INIT(a_enmVal) \
91	{ a_enmVal, #a_enmVal, 0 }
92	/** Terminates an enum value to descriptor table. */
93	#define RT_TRACELOG_DECODER_STRUCT_BLD_ENUM_TERM \
94	{ 0, NULL, 0 }
95
96
97	/**
98	* Helper functions for decoders.
99	*/
100	typedef struct RTTRACELOGDECODERHLP
101	{
102	/** Magic value (RTTRACELOGDECODERHLP_MAGIC). */
103	uint32_t u32Magic;
104
105	/**
106	* Helper for writing formatted text to the output.
107	*
108	* @returns IPRT status.
109	* @param pHlp Pointer to the callback structure.
110	* @param pszFormat The format string. This may use all IPRT extensions as
111	* well as the debugger ones.
112	* @param ... Arguments specified in the format string.
113	*/
114	DECLCALLBACKMEMBER(int, pfnPrintf, (PRTTRACELOGDECODERHLP pHlp, const char *pszFormat, ...)) RT_IPRT_FORMAT_ATTR(2, 3);
115
116
117	/**
118	* Helper for writing formatted error message to the output.
119	*
120	* @returns IPRT status.
121	* @param pHlp Pointer to the callback structure.
122	* @param pszFormat The format string. This may use all IPRT extensions as
123	* well as the debugger ones.
124	* @param ... Arguments specified in the format string.
125	*/
126	DECLCALLBACKMEMBER(int, pfnErrorMsg, (PRTTRACELOGDECODERHLP pHlp, const char *pszFormat, ...)) RT_IPRT_FORMAT_ATTR(2, 3);
127
128
129	/** @name Decoder state related callbacks.
130	* @{ */
131
132	/**
133	* Creates a new decoder state and associates it with the given helper structure.
134	*
135	* @returns IPRT status.
136	* @param pHlp Pointer to the callback structure.
137	* @param cbState Size of the state in bytes.
138	* @param pfnFree Callback which is called before the decoder state is freed to give the decoder
139	* a chance to do some necessary cleanup, optional.
140	* @param ppvState Where to return the pointer to the state on success.
141	*
142	* @note This will destroy and free any previously created decoder state as there can be only one currently for
143	* a decoder.
144	*/
145	DECLCALLBACKMEMBER(int, pfnDecoderStateCreate, (PRTTRACELOGDECODERHLP pHlp, size_t cbState, PFNTRACELOGDECODERSTATEFREE pfnFree,
146	void **ppvState));
147
148
149	/**
150	* Destroys any currently attached decoder state.
151	*
152	* @param pHlp Pointer to the callback structure.
153	*/
154	DECLCALLBACKMEMBER(void, pfnDecoderStateDestroy, (PRTTRACELOGDECODERHLP pHlp));
155
156
157	/**
158	* Returns any decoder state created previously with RTTRACELOGDECODERHLP::pfnDecoderStateCreate().
159	*
160	* @returns Pointer to the decoder state or NULL if none was created yet.
161	* @param pHlp Pointer to the callback structure.
162	*/
163	DECLCALLBACKMEMBER(void*, pfnDecoderStateGet, (PRTTRACELOGDECODERHLP pHlp));
164
165	/** @} */
166
167	/** @name Structure builder callbacks.
168	* @{ */
169
170	/**
171	* Begins a new (sub-)structure with the given name.
172	*
173	* @returns IPRT status code.
174	* @param pHlp Pointer to the callback structure.
175	* @param pszName Name of the structure.
176	*/
177	DECLCALLBACKMEMBER(int, pfnStructBldBegin, (PRTTRACELOGDECODERHLP pHlp, const char *pszName));
178
179
180	/**
181	* Ends the current (sub-)structure and returns to the parent.
182	*
183	* @returns IPRT status code.
184	* @param pHlp Pointer to the callback structure.
185	*/
186	DECLCALLBACKMEMBER(int, pfnStructBldEnd, (PRTTRACELOGDECODERHLP pHlp));
187
188
189	/**
190	* Adds a boolean member to the current (sub-)structure with the given name and value.
191	*
192	* @returns IPRT status code.
193	* @param pHlp Pointer to the callback structure.
194	* @param pszName Name of the member.
195	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
196	* @param f The boolean value to record.
197	*/
198	DECLCALLBACKMEMBER(int, pfnStructBldAddBool, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, bool f));
199
200
201	/**
202	* Adds an unsigned byte (uint8_t) member to the current (sub-)structure with the given name and value.
203	*
204	* @returns IPRT status code.
205	* @param pHlp Pointer to the callback structure.
206	* @param pszName Name of the member.
207	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
208	* @param u8 The value to record.
209	*/
210	DECLCALLBACKMEMBER(int, pfnStructBldAddU8, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, uint8_t u8));
211
212
213	/**
214	* Adds an unsigned 16-bit (uint16_t) member to the current (sub-)structure with the given name and value.
215	*
216	* @returns IPRT status code.
217	* @param pHlp Pointer to the callback structure.
218	* @param pszName Name of the member.
219	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
220	* @param u16 The value to record.
221	*/
222	DECLCALLBACKMEMBER(int, pfnStructBldAddU16, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, uint16_t u16));
223
224
225	/**
226	* Adds an unsigned 32-bit (uint32_t) member to the current (sub-)structure with the given name and value.
227	*
228	* @returns IPRT status code.
229	* @param pHlp Pointer to the callback structure.
230	* @param pszName Name of the member.
231	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
232	* @param u32 The value to record.
233	*/
234	DECLCALLBACKMEMBER(int, pfnStructBldAddU32, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, uint32_t u32));
235
236
237	/**
238	* Adds an unsigned 64-bit (uint64_t) member to the current (sub-)structure with the given name and value.
239	*
240	* @returns IPRT status code.
241	* @param pHlp Pointer to the callback structure.
242	* @param pszName Name of the member.
243	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
244	* @param u64 The value to record.
245	*/
246	DECLCALLBACKMEMBER(int, pfnStructBldAddU64, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, uint64_t u64));
247
248
249	/**
250	* Adds a signed byte (int8_t) member to the current (sub-)structure with the given name and value.
251	*
252	* @returns IPRT status code.
253	* @param pHlp Pointer to the callback structure.
254	* @param pszName Name of the member.
255	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
256	* @param i8 The value to record.
257	*/
258	DECLCALLBACKMEMBER(int, pfnStructBldAddS8, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, int8_t i8));
259
260
261	/**
262	* Adds a signed 16-bit (int16_t) member to the current (sub-)structure with the given name and value.
263	*
264	* @returns IPRT status code.
265	* @param pHlp Pointer to the callback structure.
266	* @param pszName Name of the member.
267	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
268	* @param i16 The value to record.
269	*/
270	DECLCALLBACKMEMBER(int, pfnStructBldAddS16, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, int16_t i16));
271
272
273	/**
274	* Adds a signed 32-bit (int32_t) member to the current (sub-)structure with the given name and value.
275	*
276	* @returns IPRT status code.
277	* @param pHlp Pointer to the callback structure.
278	* @param pszName Name of the member.
279	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
280	* @param i32 The value to record.
281	*/
282	DECLCALLBACKMEMBER(int, pfnStructBldAddS32, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, int32_t i32));
283
284
285	/**
286	* Adds a signed 64-bit (int64_t) member to the current (sub-)structure with the given name and value.
287	*
288	* @returns IPRT status code.
289	* @param pHlp Pointer to the callback structure.
290	* @param pszName Name of the member.
291	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
292	* @param i32 The value to record.
293	*/
294	DECLCALLBACKMEMBER(int, pfnStructBldAddS64, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, int64_t i64));
295
296
297	/**
298	* Adds a string member to the current (sub-)structure with the given name and string.
299	*
300	* @returns IPRT status code.
301	* @param pHlp Pointer to the callback structure.
302	* @param pszName Name of the member.
303	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
304	* @param pszStr The string to add.
305	*/
306	DECLCALLBACKMEMBER(int, pfnStructBldAddStr, (PRTTRACELOGDECODERHLP pHlp, const char pszName, uint32_t fFlags, const char pszStr));
307
308
309	/**
310	* Adds a data buffer member to the current (sub-)structure with the given name and content.
311	*
312	* @returns IPRT status code.
313	* @param pHlp Pointer to the callback structure.
314	* @param pszName Name of the member.
315	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
316	* @param pb The buffer to add.
317	* @param cb Size of the buffer in bytes.
318	*/
319	DECLCALLBACKMEMBER(int, pfnStructBldAddBuf, (PRTTRACELOGDECODERHLP pHlp, const char pszName, uint32_t fFlags, const uint8_t pb, size_t cb));
320
321
322	/**
323	* Adds a enum member to the current (sub-)structure with the given name and value.
324	*
325	* @returns IPRT status code.
326	* @param pHlp Pointer to the callback structure.
327	* @param pszName Name of the member.
328	* @param fFlags Combination of RTTRACELOG_DECODER_HLP_STRUCT_BLD_F_XXX.
329	* @param cBits Size of the enum data type in bits.
330	* @param paEnums Pointer to an erray of enum entries mapping a value to the description.
331	*/
332	DECLCALLBACKMEMBER(int, pfnStructBldAddEnum, (PRTTRACELOGDECODERHLP pHlp, const char *pszName, uint32_t fFlags, uint8_t cBits,
333	PCRTTRACELOGDECODERSTRUCTBLDENUM paEnums, uint64_t u64Val));
334
335	/**
336	* Begins a new array member in the current (sub-)structure with the given name.
337	*
338	* @returns IPRT status code.
339	* @param pHlp Pointer to the callback structure.
340	* @param pszName Name of the array member.
341	*/
342	DECLCALLBACKMEMBER(int, pfnStructBldArrayBegin, (PRTTRACELOGDECODERHLP pHlp, const char *pszName));
343
344
345	/**
346	* Ends the current array member in the current (sub-)structure.
347	*
348	* @returns IPRT status code.
349	* @param pHlp Pointer to the callback structure.
350	*/
351	DECLCALLBACKMEMBER(int, pfnStructBldArrayEnd, (PRTTRACELOGDECODERHLP pHlp));
352
353	/** @} */
354
355	/** End marker (DBGCCMDHLP_MAGIC). */
356	uint32_t u32EndMarker;
357	} RTTRACELOGDECODERHLP;
358
359	/** Magic value for RTTRACELOGDECODERHLP::u32Magic and RTTRACELOGDECODERHLP::u32EndMarker. (Bernhard-Viktor Christoph-Carl von Buelow) */
360	#define DBGCCMDHLP_MAGIC UINT32_C(0x19231112)
361
362
363	/** Makes a IPRT tracelog decoder structure version out of an unique magic value and major &
364	* minor version numbers.
365	*
366	* @returns 32-bit structure version number.
367	*
368	* @param uMagic 16-bit magic value. This must be unique.
369	* @param uMajor 12-bit major version number. Structures with different
370	* major numbers are not compatible.
371	* @param uMinor 4-bit minor version number. When only the minor version
372	* differs, the structures will be 100% backwards
373	* compatible.
374	*/
375	#define RT_TRACELOG_DECODER_VERSION_MAKE(uMagic, uMajor, uMinor) \
376	( ((uint32_t)(uMagic) << 16) \| ((uint32_t)((uMajor) & 0xff) << 4) \| ((uint32_t)((uMinor) & 0xf) << 0) )
377
378	/** Checks if @a uVerMagic1 is compatible with @a uVerMagic2.
379	*
380	* @returns true / false.
381	* @param uVerMagic1 Typically the runtime version of the struct. This must
382	* have the same magic and major version as @a uVerMagic2
383	* and the minor version must be greater or equal to that
384	* of @a uVerMagic2.
385	* @param uVerMagic2 Typically the version the code was compiled against.
386	*
387	* @remarks The parameters will be referenced more than once.
388	*/
389	#define RT_TRACELOG_DECODER_VERSION_ARE_COMPATIBLE(uVerMagic1, uVerMagic2) \
390	( (uVerMagic1) == (uVerMagic2) \
391	\|\| ( (uVerMagic1) >= (uVerMagic2) \
392	&& ((uVerMagic1) & UINT32_C(0xfffffff0)) == ((uVerMagic2) & UINT32_C(0xfffffff0)) ) \
393	)
394
395
396	/**
397	* Decoder callback for an event.
398	*
399	* @returns IPRT status code.
400	* @param pHlp The decoder helper callback table.
401	* @param idDecodeEvt Event decoder ID given in RTTRACELOGDECODEEVT::idDecodeEvt for the particular event ID.
402	* @param hTraceLogEvt The tracelog event handle called for decoding.
403	* @param pEvtDesc The event descriptor.
404	* @param paVals Pointer to the array of values.
405	* @param cVals Number of values in the array.
406	*/
407	typedef DECLCALLBACKTYPE(int, FNTRACELOGDECODEREVENTDECODE,(PRTTRACELOGDECODERHLP pHlp, uint32_t idDecodeEvt,
408	RTTRACELOGRDREVT hTraceLogEvt, PCRTTRACELOGEVTDESC pEvtDesc,
409	PRTTRACELOGEVTVAL paVals, uint32_t cVals));
410	/** Pointer to an event decode callback. */
411	typedef FNTRACELOGDECODEREVENTDECODE *PFNTRACELOGDECODEREVENTDECODE;
412
413
414	/**
415	* Event decoder entry.
416	*/
417	typedef struct RTTRACELOGDECODEEVT
418	{
419	/** The event ID name. */
420	const char *pszEvtId;
421	/** The decoder event ID ordinal to pass to in the decode callback for
422	* faster lookup. */
423	uint32_t idDecodeEvt;
424	} RTTRACELOGDECODEEVT;
425	/** Pointer to an event decoder entry. */
426	typedef RTTRACELOGDECODEEVT *PRTTRACELOGDECODEEVT;
427	/** Pointer to a const event decoder entry. */
428	typedef const RTTRACELOGDECODEEVT *PCRTTRACELOGDECODEEVT;
429
430
431	/**
432	* A decoder registration structure.
433	*/
434	typedef struct RTTRACELOGDECODERREG
435	{
436	/** Decoder name. */
437	const char *pszName;
438	/** Decoder description. */
439	const char *pszDesc;
440	/** The event IDs to register the decoder for. */
441	PCRTTRACELOGDECODEEVT paEvtIds;
442	/** The decode callback. */
443	PFNTRACELOGDECODEREVENTDECODE pfnDecode;
444	} RTTRACELOGDECODERREG;
445	/** Pointer to a decoder registration structure. */
446	typedef RTTRACELOGDECODERREG *PRTTRACELOGDECODERREG;
447	/** Pointer to a const decoder registration structure. */
448	typedef const RTTRACELOGDECODERREG *PCRTTRACELOGDECODERREG;
449
450
451	/**
452	* Decoder register callbacks structure.
453	*/
454	typedef struct RTTRACELOGDECODERREGISTER
455	{
456	/** Interface version.
457	* This is set to RT_TRACELOG_DECODERREG_CB_VERSION. */
458	uint32_t u32Version;
459
460	/**
461	* Registers a new decoders.
462	*
463	* @returns VBox status code.
464	* @param pvUser Opaque user data given in the plugin load callback.
465	* @param paDecoders Pointer to an array of decoders to register.
466	* @param cDecoders Number of entries in the array.
467	*/
468	DECLR3CALLBACKMEMBER(int, pfnRegisterDecoders, (void *pvUser, PCRTTRACELOGDECODERREG paDecoders, uint32_t cDecoders));
469
470	} RTTRACELOGDECODERREGISTER;
471	/** Pointer to a backend register callbacks structure. */
472	typedef RTTRACELOGDECODERREGISTER *PRTTRACELOGDECODERREGISTER;
473
474	/** Current version of the RTTRACELOGDECODERREGISTER structure. */
475	#define RT_TRACELOG_DECODERREG_CB_VERSION RT_TRACELOG_DECODER_VERSION_MAKE(0xfeed, 1, 0)
476
477	/**
478	* Initialization entry point called by the tracelog layer when
479	* a plugin is loaded.
480	*
481	* @returns IPRT status code.
482	* @param pvUser Opaque user data passed in the register callbacks.
483	* @param pRegisterCallbacks Pointer to the register callbacks structure.
484	*/
485	typedef DECLCALLBACKTYPE(int, FNTRACELOGDECODERPLUGINLOAD,(void *pvUser, PRTTRACELOGDECODERREGISTER pRegisterCallbacks));
486	typedef FNTRACELOGDECODERPLUGINLOAD *PFNTRACELOGDECODERPLUGINLOAD;
487	#define RT_TRACELOG_DECODER_PLUGIN_LOAD "RTTraceLogDecoderLoad"
488
489	#endif /* !IPRT_INCLUDED_tracelog_decoder_plugin_h */

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

source: vbox/trunk/include/iprt/tracelog-decoder-plugin.h

Download in other formats: