Changeset 71492 in vbox

Timestamp:

Mar 24, 2018 10:23:10 PM (7 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

121464

Message:

Runtime: Introduce RTTraceLog* API for creating and parsing binary trace log files. The format and API is designed with the

following goals in mind:

1. Allow streaming the data via network or write it to a file.
2. Embed the structure of the traced data into the log allowing arbitrary structured data to be embedded without requiring adaptions on the parsing side.
3. Allow grouping of traced data belonging together to easily follow chains of events later on.
4. Trace events can have a parent assigned to check where an event originally originated from.
5. Low overhead on the creation side.

The current state implements the absolute basics on the creation and parsing side and is work in progress. This will
be used later on in the device emulation fuzzer to capture device and examine device states and changes.

Location:

trunk

Files:

• include/iprt/formats/tracelog.h (added)
• include/iprt/mangling.h (modified) (1 diff)
• include/iprt/tracelog.h (added)
• src/VBox/Runtime/Makefile.kmk (modified) (1 diff)
• src/VBox/Runtime/common/log/tracelogreader.cpp (added)
• src/VBox/Runtime/common/log/tracelogwriter.cpp (added)
• src/VBox/Runtime/include/internal/magics.h (modified) (2 diffs)
• src/VBox/Runtime/testcase/Makefile.kmk (modified) (2 diffs)
• src/VBox/Runtime/testcase/tstRTTraceLog.cpp (added)
• src/VBox/Runtime/tools/Makefile.kmk (modified) (1 diff)
• src/VBox/Runtime/tools/RTTraceLogTool.cpp (added)

trunk/include/iprt/mangling.h

@@ -2368 +2368 @@
 # define RTTraceBufRetain                               RT_MANGLER(RTTraceBufRetain)
 # define RTTraceGetDefaultBuf                           RT_MANGLER(RTTraceGetDefaultBuf)
+# define RTTraceLogRdrCreate                            RT_MANGLER(RTTraceLogRdrCreate)
+# define RTTraceLogRdrCreateFromFile                    RT_MANGLER(RTTraceLogRdrCreateFromFile)
+# define RTTraceLogRdrDestroy                           RT_MANGLER(RTTraceLogRdrDestroy)
+# define RTTraceLogRdrEvtFillVals                       RT_MANGLER(RTTraceLogRdrEvtFillVals)
+# define RTTraceLogRdrEvtGetDesc                        RT_MANGLER(RTTraceLogRdrEvtGetDesc)
+# define RTTraceLogRdrEvtGetSeqNo                       RT_MANGLER(RTTraceLogRdrEvtGetSeqNo)
+# define RTTraceLogRdrEvtGetTs                          RT_MANGLER(RTTraceLogRdrEvtGetTs)
+# define RTTraceLogRdrEvtIsGrouped                      RT_MANGLER(RTTraceLogRdrEvtIsGrouped)
+# define RTTraceLogRdrEvtPoll                           RT_MANGLER(RTTraceLogRdrEvtPoll)
+# define RTTraceLogRdrEvtQueryVal                       RT_MANGLER(RTTraceLogRdrEvtQueryVal)
+# define RTTraceLogRdrIteratorFree                      RT_MANGLER(RTTraceLogRdrIteratorFree)
+# define RTTraceLogRdrIteratorNext                      RT_MANGLER(RTTraceLogRdrIteratorNext)
+# define RTTraceLogRdrIteratorQueryEvent                RT_MANGLER(RTTraceLogRdrIteratorQueryEvent)
+# define RTTraceLogRdrQueryIterator                     RT_MANGLER(RTTraceLogRdrQueryIterator)
+# define RTTraceLogRdrQueryLastEvt                      RT_MANGLER(RTTraceLogRdrQueryLastEvt)
+# define RTTraceLogWrAddEvtDesc                         RT_MANGLER(RTTraceLogWrAddEvtDesc)
+# define RTTraceLogWrCreate                             RT_MANGLER(RTTraceLogWrCreate)
+# define RTTraceLogWrCreateFile                         RT_MANGLER(RTTraceLogWrCreateFile)
+# define RTTraceLogWrCreateTcpClient                    RT_MANGLER(RTTraceLogWrCreateTcpClient)
+# define RTTraceLogWrCreateTcpServer                    RT_MANGLER(RTTraceLogWrCreateTcpServer)
+# define RTTraceLogWrDestroy                            RT_MANGLER(RTTraceLogWrDestroy)
+# define RTTraceLogWrEvtAdd                             RT_MANGLER(RTTraceLogWrEvtAdd)
+# define RTTraceLogWrEvtAddSg                           RT_MANGLER(RTTraceLogWrEvtAddSg)
 # define RTTraceSetDefaultBuf                           RT_MANGLER(RTTraceSetDefaultBuf)
 # define RTUdpCreateClientSocket                        RT_MANGLER(RTUdpCreateClientSocket)

trunk/src/VBox/Runtime/Makefile.kmk

@@ -451 +451 @@
         common/log/tracebuf.cpp \
         common/log/tracedefault.cpp \
+        common/log/tracelogreader.cpp \
+        common/log/tracelogwriter.cpp \
         common/math/bignum.cpp \
         common/misc/RTAssertMsg1Weak.cpp \

trunk/src/VBox/Runtime/include/internal/magics.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2007-2017 Oracle Corporation
+ * Copyright (C) 2007-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -217 +217 @@
 /** Magic value of RTTRACEBUFINT::u32Magic after the final release. */
 #define RTTRACEBUF_MAGIC_DEAD           UINT32_C(0x19500121)
+/** The value of RTTRACELOGRDRINT::u32Magic. (John Michael Scalzi) */
+#define RTTRACELOGRDR_MAGIC             UINT32_C(0x19690510)
+/** The value of RTTRACELOGRDRINT::u32Magic after RTTraceLogRdrDestroy(). */
+#define RTTRACELOGRDR_MAGIC_DEAD        (~RTTRACELOGRDR_MAGIC)
+/** The value of RTTRACELOGWRINT::u32Magic. (Herbert George Wells) */
+#define RTTRACELOGWR_MAGIC              UINT32_C(0x18660921)
+/** The value of RTTRACELOGWRINT::u32Magic after RTTraceLogWrDestroy(). */
+#define RTTRACELOGWR_MAGIC_DEAD         UINT32_C(0x19460813)
 /** The value of RTVFSOBJINTERNAL::u32Magic. (Yasunari Kawabata) */
 #define RTVFSOBJ_MAGIC                  UINT32_C(0x18990614)

trunk/src/VBox/Runtime/testcase/Makefile.kmk

@@ -135 +135 @@
         tstRTThreadExecutionTime \
         tstRTTime \
+        tstRTTraceLog \
         tstTime-2 \
         tstTime-3 \
@@ -661 +662 @@
 tstRTTime_SOURCES = tstRTTime.cpp
 
+tstRTTraceLog_TEMPLATE = VBOXR3TSTEXE
+tstRTTraceLog_SOURCES = tstRTTraceLog.cpp
+
 tstTime-2_TEMPLATE = VBOXR3TSTEXE
 tstTime-2_SOURCES = tstTime-2.cpp

trunk/src/VBox/Runtime/tools/Makefile.kmk

@@ -179 +179 @@
  RTSignTool_LIBS = $(PATH_STAGE_LIB)/SUPR3$(VBOX_SUFF_LIB)
 
+ # RTTraceLogTool - Trace log collection and dissection tool.
+ PROGRAMS += RTTraceLogTool
+ RTTraceLogTool_TEMPLATE = VBoxR3Tool
+ RTTraceLogTool_SOURCES = RTTraceLogTool.cpp
+
  if1of ($(KBUILD_TARGET), darwin linux solaris win)
   # RTKrnlModInfo - our lsmod/kextstat clone (for testing the RTKrnlMod code).