Changeset 72309 in vbox

Timestamp:

May 24, 2018 7:23:34 AM (7 years ago)

Author:

vboxsync

Message:

Runtime/tracelogwriter.cpp: Add methods taking a list of event data items

Location:

trunk

Files:

• include/iprt/mangling.h (modified) (1 diff)
• include/iprt/tracelog.h (modified) (1 diff)
• src/VBox/Runtime/common/log/tracelogwriter.cpp (modified) (5 diffs)

trunk/include/iprt/mangling.h

@@ -2393 +2393 @@
 # define RTTraceLogWrDestroy                            RT_MANGLER(RTTraceLogWrDestroy)
 # define RTTraceLogWrEvtAdd                             RT_MANGLER(RTTraceLogWrEvtAdd)
+# define RTTraceLogWrEvtAddL                            RT_MANGLER(RTTraceLogWrEvtAddL)
+# define RTTraceLogWrEvtAddLV                           RT_MANGLER(RTTraceLogWrEvtAddLV)
 # define RTTraceLogWrEvtAddSg                           RT_MANGLER(RTTraceLogWrEvtAddSg)
 # define RTTraceSetDefaultBuf                           RT_MANGLER(RTTraceSetDefaultBuf)

trunk/include/iprt/tracelog.h

@@ -413 +413 @@
 
 /**
+ * Adds a new event to the trace log - list variant.
+ *
+ * @returns IPRT status code.
+ * @param   hTraceLogWr         The trace log writer instance handle.
+ * @param   pEvtDesc            The event descriptor used for formatting the data.
+ * @param   fFlags              Flags to use for this event.
+ * @param   uGrpId              A unique group ID for grouped events.
+ * @param   uParentGrpId        A parent group ID this event originated from.
+ * @param   va                  The event data as single items as described by the descriptor.
+ *
+ * @note The event descriptor is keyed by the pointer for faster lookup in subsequent calls,
+ *       so don't free after this method finishes.
+ */
+RTDECL(int) RTTraceLogWrEvtAddLV(RTTRACELOGWR hTraceLogWr, PCRTTRACELOGEVTDESC pEvtDesc, uint32_t fFlags,
+                                 RTTRACELOGEVTGRPID uGrpId, RTTRACELOGEVTGRPID uParentGrpId, va_list va);
+
+
+/**
+ * Adds a new event to the trace log - list variant.
+ *
+ * @returns IPRT status code.
+ * @param   hTraceLogWr         The trace log writer instance handle.
+ * @param   pEvtDesc            The event descriptor used for formatting the data.
+ * @param   fFlags              Flags to use for this event.
+ * @param   uGrpId              A unique group ID for grouped events.
+ * @param   uParentGrpId        A parent group ID this event originated from.
+ * @param   ...                 The event data as single items as described by the descriptor.
+ *
+ * @note The event descriptor is keyed by the pointer for faster lookup in subsequent calls,
+ *       so don't free after this method finishes.
+ */
+RTDECL(int) RTTraceLogWrEvtAddL(RTTRACELOGWR hTraceLogWr, PCRTTRACELOGEVTDESC pEvtDesc, uint32_t fFlags,
+                                RTTRACELOGEVTGRPID uGrpId, RTTRACELOGEVTGRPID uParentGrpId, ...);
+
+
+/**
  * Creates a new trace log reader instance.
  *

trunk/src/VBox/Runtime/common/log/tracelogwriter.cpp

@@ -67 +67 @@
     /** Number of non static raw binary items in the descriptor. */
     uint32_t                    cRawDataNonStatic;
+    /** Pointer to the scratch event data buffer when adding events. */
+    uint8_t                     *pbEvt;
     /** Embedded event descriptor. */
     RTTRACELOGEVTDESC           EvtDesc;
@@ -354 +356 @@
 
         pEvtDescInt->cbEvtData = cbEvtData;
+        if (cbEvtData)
+        {
+            pEvtDescInt->pbEvt = (uint8_t *)RTMemAllocZ(cbEvtData);
+            if (!pEvtDescInt->pbEvt)
+            {
+                RTMemFree(pEvtDescInt);
+                pEvtDescInt = NULL;
+            }
+        }
     }
 
@@ -514 +525 @@
 static DECLCALLBACK(int) rtTraceLogWrEvtDescsDestroy(PAVLPVNODECORE pCore, void *pvParam)
 {
+    PRTTRACELOGWREVTDESC pEvtDesc = (PRTTRACELOGWREVTDESC)pCore;
     RT_NOREF(pvParam);
 
-    RTMemFree(pCore);
+    RTMemFree(pEvtDesc->pbEvt);
+    RTMemFree(pEvtDesc);
     return VINF_SUCCESS;
 }
@@ -609 +622 @@
 
 /**
+ * Fills a given buffer with the given event data as described in the given descriptor.
+ *
+ * @returns IPRT status code.
+ * @param   pThis               The trace log writer instance.
+ * @param   pEvtDescInt         Pointer to the internal event descriptor.
+ * @param   pb                  The byte buffer to fill.
+ * @param   va                  The event data.
+ */
+static int rtTraceLogWrEvtFill(PRTTRACELOGWRINT pThis, PRTTRACELOGWREVTDESC pEvtDescInt, uint8_t *pb, va_list va)
+{
+    int rc = VINF_SUCCESS;
+    uint8_t *pbCur = pb;
+
+    RT_NOREF(pThis);
+
+    for (unsigned i = 0; i < pEvtDescInt->EvtDesc.cEvtItems; i++)
+    {
+        PCRTTRACELOGEVTITEMDESC pEvtItemDesc = &pEvtDescInt->EvtDesc.paEvtItemDesc[i];
+
+        size_t cbItem = rtTraceLogWrGetEvtItemDataSz(pEvtItemDesc);
+        switch (cbItem)
+        {
+            case sizeof(uint8_t):
+                *pbCur++ = va_arg(va, /*uint8_t*/ unsigned);
+                break;
+            case sizeof(uint16_t):
+                *(uint16_t *)pbCur = va_arg(va, /*uint16_t*/ unsigned);
+                pbCur += sizeof(uint16_t);
+                break;
+            case sizeof(uint32_t):
+                *(uint32_t *)pbCur = va_arg(va, uint32_t);
+                pbCur += sizeof(uint32_t);
+                break;
+            case sizeof(uint64_t):
+                *(uint64_t *)pbCur = va_arg(va, uint64_t);
+                pbCur += sizeof(uint64_t);
+                break;
+            default:
+                /* Some raw data item. */
+                Assert(pEvtItemDesc->enmType == RTTRACELOGTYPE_RAWDATA);
+                if (cbItem != 0)
+                {
+                    /* Static raw data. */
+                    void *pvSrc = va_arg(va, void *);
+                    memcpy(pbCur, pvSrc, cbItem);
+                    pbCur += cbItem;
+                }
+                else
+                {
+                    AssertMsgFailed(("Not implemented!\n"));
+                    rc = VERR_NOT_IMPLEMENTED;
+                }
+        }
+    }
+
+    return rc;
+}
+
+
+/**
  * @copydoc FNRTTRACELOGWRSTREAM
  */
@@ -843 +916 @@
 }
 
+
+RTDECL(int) RTTraceLogWrEvtAddLV(RTTRACELOGWR hTraceLogWr, PCRTTRACELOGEVTDESC pEvtDesc, uint32_t fFlags,
+                                 RTTRACELOGEVTGRPID uGrpId, RTTRACELOGEVTGRPID uParentGrpId, va_list va)
+{
+    PRTTRACELOGWRINT pThis = hTraceLogWr;
+    AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
+
+    int rc = VINF_SUCCESS;
+    PRTTRACELOGWREVTDESC pEvtDescInt = rtTraceLogWrEvtDescGetInternal(pThis, pEvtDesc);
+    if (RT_UNLIKELY(!pEvtDescInt))
+        rc = rtTraceLogWrEvtDescAdd(pThis, pEvtDesc, &pEvtDescInt);
+
+    if (   RT_SUCCESS(rc)
+        && VALID_PTR(pEvtDescInt))
+    {
+        TRACELOGEVT Evt;
+        size_t cbEvtData = rtTraceLogWrEvtInit(&Evt, pEvtDescInt, fFlags, uGrpId, uParentGrpId, NULL);
+
+        if (cbEvtData)
+            rc = rtTraceLogWrEvtFill(pThis, pEvtDescInt, pEvtDescInt->pbEvt, va);
+        if (RT_SUCCESS(rc))
+            rc = rtTraceLogWrEvtStream(pThis, &Evt, pEvtDescInt->pbEvt, cbEvtData, NULL);
+    }
+
+    return rc;
+}
+
+
+RTDECL(int) RTTraceLogWrEvtAddL(RTTRACELOGWR hTraceLogWr, PCRTTRACELOGEVTDESC pEvtDesc, uint32_t fFlags,
+                                RTTRACELOGEVTGRPID uGrpId, RTTRACELOGEVTGRPID uParentGrpId, ...)
+{
+    va_list va;
+    va_start(va, uParentGrpId);
+    int rc = RTTraceLogWrEvtAddLV(hTraceLogWr, pEvtDesc, fFlags, uGrpId, uParentGrpId, va);
+    va_end(va);
+    return rc;
+}
+