Changeset 90974 in vbox for trunk/src/VBox/Runtime/common

Timestamp:

Aug 28, 2021 12:45:58 PM (4 years ago)

Author:

vboxsync

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

146613

Message:

IPRT/log,VMM: Changed RTLogBulkWrite to take a before/after marker texts. Fixed buffer switching bug in rtlogFlush where we would write terminator to the previous buffer instead of the next. bugref:10086

File:

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

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

@@ -279 +279 @@
 static FNRTLOGPHASEMSG rtlogPhaseMsgNormal;
 #endif
+static void rtlogLoggerExFLocked(PRTLOGGERINTERNAL pLoggerInt, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
 
 
@@ -2984 +2985 @@
  * @returns IRPT status code.
  * @param   pLogger             The logger instance (NULL for default logger).
+ * @param   pszBefore           Text to log before the bulk text.  Optional.
  * @param   pch                 Pointer to the block of bulk log text to write.
  * @param   cch                 Size of the block of bulk log text to write.
- */
-RTDECL(int) RTLogBulkWrite(PRTLOGGER pLogger, const char *pch, size_t cch)
+ * @param   pszAfter            Text to log after the bulk text.  Optional.
+ */
+RTDECL(int) RTLogBulkWrite(PRTLOGGER pLogger, const char *pszBefore, const char *pch, size_t cch, const char *pszAfter)
 {
     PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger;
@@ -2998 +3001 @@
     if (RT_SUCCESS(rc))
     {
-        /*
-         * Do the copying.
-         */
-        while (cch > 0)
-        {
-            PRTLOGBUFFERDESC const  pBufDesc = pLoggerInt->pBufDesc;
-            char * const            pchBuf   = pBufDesc->pchBuf;
-            uint32_t const          cbBuf    = pBufDesc->cbBuf;
-            uint32_t                offBuf   = pBufDesc->offBuf;
-            if (cch + 1 < cbBuf - offBuf)
+        if (cch > 0)
+        {
+            /*
+             * Heading/marker.
+             */
+            if (pszBefore)
+                rtlogLoggerExFLocked(pLoggerInt, RTLOGGRPFLAGS_LEVEL_1, UINT32_MAX, "%s", pszBefore);
+
+            /*
+             * Do the copying.
+             */
+            do
             {
-                memcpy(&pchBuf[offBuf], pch, cch);
-                offBuf += (uint32_t)cch;
-                pchBuf[offBuf] = '\0';
-                pBufDesc->offBuf = offBuf;
-                if (pBufDesc->pAux)
-                    pBufDesc->pAux->offBuf = offBuf;
-                if (!(pLoggerInt->fDestFlags & RTLOGFLAGS_BUFFERED))
-                    rtlogFlush(pLoggerInt, false /*fNeedSpace*/);
-                break;
-            }
-
-            /* Not enough space. */
-            if (offBuf + 1 < cbBuf)
-            {
-                uint32_t cbToCopy = cbBuf - offBuf - 1;
-                memcpy(&pchBuf[offBuf], pch, cbToCopy);
-                offBuf += cbToCopy;
-                pchBuf[offBuf] = '\0';
-                pBufDesc->offBuf = offBuf;
-                if (pBufDesc->pAux)
-                    pBufDesc->pAux->offBuf = offBuf;
-                pch += cbToCopy;
-                cch -= cbToCopy;
-            }
-
-            rtlogFlush(pLoggerInt, false /*fNeedSpace*/);
+                PRTLOGBUFFERDESC const  pBufDesc = pLoggerInt->pBufDesc;
+                char * const            pchBuf   = pBufDesc->pchBuf;
+                uint32_t const          cbBuf    = pBufDesc->cbBuf;
+                uint32_t                offBuf   = pBufDesc->offBuf;
+                if (cch + 1 < cbBuf - offBuf)
+                {
+                    memcpy(&pchBuf[offBuf], pch, cch);
+                    offBuf += (uint32_t)cch;
+                    pchBuf[offBuf] = '\0';
+                    pBufDesc->offBuf = offBuf;
+                    if (pBufDesc->pAux)
+                        pBufDesc->pAux->offBuf = offBuf;
+                    if (!(pLoggerInt->fDestFlags & RTLOGFLAGS_BUFFERED))
+                        rtlogFlush(pLoggerInt, false /*fNeedSpace*/);
+                    break;
+                }
+
+                /* Not enough space. */
+                if (offBuf + 1 < cbBuf)
+                {
+                    uint32_t cbToCopy = cbBuf - offBuf - 1;
+                    memcpy(&pchBuf[offBuf], pch, cbToCopy);
+                    offBuf += cbToCopy;
+                    pchBuf[offBuf] = '\0';
+                    pBufDesc->offBuf = offBuf;
+                    if (pBufDesc->pAux)
+                        pBufDesc->pAux->offBuf = offBuf;
+                    pch += cbToCopy;
+                    cch -= cbToCopy;
+                }
+
+                rtlogFlush(pLoggerInt, false /*fNeedSpace*/);
+            } while (cch > 0);
+
+            /*
+             * Footer/marker.
+             */
+            if (pszAfter)
+                rtlogLoggerExFLocked(pLoggerInt, RTLOGGRPFLAGS_LEVEL_1, UINT32_MAX, "%s", pszAfter);
         }
 
@@ -3109 +3127 @@
     PRTLOGBUFFERDESC    pBufDesc   = pLoggerInt->pBufDesc;
     uint32_t            cchToFlush = pBufDesc->offBuf;
-    char * const        pchToFlush = pBufDesc->pchBuf;
+    char *              pchToFlush = pBufDesc->pchBuf;
     uint32_t const      cbBuf      = pBufDesc->cbBuf;
     Assert(pBufDesc->u32Magic == RTLOGBUFFERDESC_MAGIC);
@@ -3199 +3217 @@
                 pLoggerInt->idxBufDesc = (uint8_t)idxBufDesc;
                 pLoggerInt->pBufDesc   = pBufDesc = &pLoggerInt->paBufDescs[idxBufDesc];
+                pchToFlush = pBufDesc->pchBuf;
             }
         }