Changeset 86386 in vbox

Timestamp:

Oct 1, 2020 2:42:09 PM (4 years ago)

Author:

vboxsync

Message:

IPRT/RTTraceLogRdrDestroy: Free pending events, ignore NIL (iprt protocol) and verify magic. latter applied to other APIs too. bugref:9841

File:

• trunk/src/VBox/Runtime/common/log/tracelogreader.cpp (modified) (11 diffs)

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

@@ -52 +52 @@
 *   Structures and Typedefs                                                                                                      *
 *********************************************************************************************************************************/
-
 /** Pointer to a trace log reader instance. */
 typedef struct RTTRACELOGRDRINT *PRTTRACELOGRDRINT;
@@ -102 +101 @@
 {
     /** List node for the global list of events. */
-    RTLISTANCHOR                NdGlob;
+    RTLISTNODE                  NdGlob;
     /** The trace log reader instance the event belongs to. */
     PRTTRACELOGRDRINT           pRdr;
@@ -120 +119 @@
     size_t                      cbEvtData;
     /** Event data, variable in size. */
-    uint8_t                     abEvtData[1];
+    RT_FLEXIBLE_ARRAY_EXTENSION
+    uint8_t                     abEvtData[RT_FLEXIBLE_ARRAY];
 } RTTRACELOGRDREVTINT;
 /** Pointer to a trace log reader event. */
@@ -150 +150 @@
     RTTRACELOGEVTDESC           EvtDesc;
     /** Array of event item descriptors, variable in size. */
-    RTTRACELOGEVTITEMDESC       aEvtItemDesc[1];
+    RT_FLEXIBLE_ARRAY_EXTENSION
+    RTTRACELOGEVTITEMDESC       aEvtItemDesc[RT_FLEXIBLE_ARRAY];
 } RTTRACELOGRDREVTDESC;
 
@@ -179 +180 @@
     /** Pointer to the description if set. */
     const char                  *pszDesc;
-    /** List of received events. */
+    /** List of received events (PRTTRACELOGRDREVTINT::NdGlob). */
     RTLISTANCHOR                LstEvts;
     /** Number of event descriptors known. */
@@ -1005 +1006 @@
                 /** @todo Group handling and parenting. */
 
-                pThis->pEvtCur = pEvt;
                 size_t cbEvtDataRecv = pEvtStrm->cRawEvtDataSz * pThis->cbTypeSize + pEvtStrm->cbEvtData;
                 if (cbEvtDataRecv)
+                {
+                    pThis->pEvtCur = pEvt;
                     rc = rtTraceLogRdrStateAdvance(pThis, RTTRACELOGRDRSTATE_RECV_EVT_DATA, cbEvtDataRecv);
+                }
                 else
                 {
@@ -1607 +1610 @@
 RTDECL(int) RTTraceLogRdrDestroy(RTTRACELOGRDR hTraceLogRdr)
 {
+    if (hTraceLogRdr == NIL_RTTRACELOGRDR)
+        return VINF_SUCCESS;
     PRTTRACELOGRDRINT pThis = hTraceLogRdr;
     AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
+    AssertReturn(pThis->u32Magic == RTTRACELOGRDR_MAGIC, VERR_INVALID_HANDLE);
 
     pThis->u32Magic = RTTRACELOGRDR_MAGIC_DEAD;
-    pThis->pfnStreamClose(pThis->pvUser);
+    int rc = pThis->pfnStreamClose(pThis->pvUser);
+    AssertRC(rc);
+
     for (unsigned i = 0; i < pThis->cEvtDescsCur; i++)
         RTMemFree(pThis->papEvtDescs[i]);
     if (pThis->papEvtDescs)
+    {
         RTMemFree(pThis->papEvtDescs);
+        pThis->papEvtDescs = NULL;
+    }
+
+    if (pThis->pEvtCur)
+    {
+        RTMemFree(pThis->pEvtCur);
+        pThis->pEvtCur = NULL;
+    }
+
+    PRTTRACELOGRDREVTINT pCur, pNext;
+    RTListForEachSafe(&pThis->LstEvts, pCur, pNext, RTTRACELOGRDREVTINT, NdGlob)
+    {
+        RTMemFree(pCur);
+    }
+
     RTSemMutexDestroy(pThis->hMtx);
+    pThis->hMtx = NIL_RTSEMMUTEX;
+
     RTMemFree(pThis->pbScratch);
+    pThis->pbScratch = NULL;
+
     RTStrCacheDestroy(pThis->hStrCache);
+    pThis->hStrCache = NIL_RTSTRCACHE;
+
     RTMemFree(pThis);
     return VINF_SUCCESS;
@@ -1628 +1658 @@
     PRTTRACELOGRDRINT pThis = hTraceLogRdr;
     AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
+    AssertReturn(pThis->u32Magic == RTTRACELOGRDR_MAGIC, VERR_INVALID_HANDLE);
     AssertPtrReturn(penmEvt, VERR_INVALID_POINTER);
 
@@ -1659 +1690 @@
     PRTTRACELOGRDRINT pThis = hTraceLogRdr;
     AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
+    AssertReturn(pThis->u32Magic == RTTRACELOGRDR_MAGIC, VERR_INVALID_HANDLE);
     AssertPtrReturn(phRdrEvt, VERR_INVALID_POINTER);
 
@@ -1677 +1709 @@
     PRTTRACELOGRDRINT pThis = hTraceLogRdr;
     AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
+    AssertReturn(pThis->u32Magic == RTTRACELOGRDR_MAGIC, VERR_INVALID_HANDLE);
     AssertPtrReturn(phIt, VERR_INVALID_POINTER);
 
@@ -1701 +1734 @@
     PRTTRACELOGRDRINT pThis = hTraceLogRdr;
     AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
+    AssertReturn(pThis->u32Magic == RTTRACELOGRDR_MAGIC, VERR_INVALID_HANDLE);
     AssertPtrReturn(paMapDesc, VERR_INVALID_PARAMETER);
     AssertPtrReturn(ppaEvtHdr, VERR_INVALID_POINTER);