Changeset 20853 in vbox for trunk

Timestamp:

Jun 23, 2009 4:31:12 PM (16 years ago)

Author:

vboxsync

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

48996

Message:

IPRT: Added custom prefix callback to the logger.

Location:

trunk

Files:

• include/iprt/log.h (modified) (6 diffs)
• src/VBox/Runtime/common/log/log.cpp (modified) (5 diffs)

trunk/include/iprt/log.h

@@ -183 +183 @@
  */
 typedef DECLCALLBACK(void) FNRTLOGFLUSH(PRTLOGGER pLogger);
-/** Pointer to logger function. */
+/** Pointer to flush function. */
 typedef FNRTLOGFLUSH *PFNRTLOGFLUSH;
 
@@ -194 +194 @@
 /** Pointer to logger function. */
 typedef RCPTRTYPE(FNRTLOGFLUSHGC *) PFNRTLOGFLUSHGC;
+
+/**
+ * Custom log prefix callback.
+ *
+ *
+ * @returns The number of chars written.
+ *
+ * @param   pLogger     Pointer to the logger instance.
+ * @param   pchBuf      Output buffer pointer.
+ *                      No need to terminate the output.
+ * @param   cchBuf      The size of the output buffer.
+ * @param   pvUser      The user argument.
+ */
+typedef DECLCALLBACK(size_t) FNRTLOGPREFIX(PRTLOGGER pLogger, char *pchBuf, size_t cchBuf, void *pvUser);
+/** Pointer to prefix callback function. */
+typedef FNRTLOGPREFIX *PFNRTLOGPREFIX;
+
 
 
@@ -253 +270 @@
     /** Pointer to the flush function. */
     PFNRTLOGFLUSH           pfnFlush;
+    /** Custom prefix callback. */
+    PFNRTLOGPREFIX          pfnPrefix;
+    /** Prefix callback argument. */
+    void                   *pvPrefixUserArg;
     /** Mutex. */
     RTSEMFASTMUTEX          MutexSem;
@@ -283 +304 @@
 #define RTLOGGER_MAGIC      0x19281207
 
-#endif
+#endif /* !IN_RC */
 
 
@@ -323 +344 @@
     /** New lines should be prefixed with thread name. */
     RTLOGFLAGS_PREFIX_THREAD        = 0x00800000,
-    /** New lines should be prefixed with the VCPU id. */
-    RTLOGFLAGS_PREFIX_VCPU          = 0x01000000,
+    /** New lines should be prefixed with data from a custom callback. */
+    RTLOGFLAGS_PREFIX_CUSTOM        = 0x01000000,
     /** New lines should be prefixed with formatted timestamp since program start. */
     RTLOGFLAGS_PREFIX_TIME_PROG     = 0x04000000,
@@ -1403 +1424 @@
 
 /**
+ * Sets the custom prefix callback.
+ *
+ * @returns IPRT status code.
+ * @param   pLogger     The logger instance.
+ * @param   pfnCallback The callback.
+ * @param   pvUser      The user argument for the callback.
+ *  */
+RTDECL(int) RTLogSetCustomPrefixCallback(PRTLOGGER pLogger, PFNRTLOGPREFIX pfnCallback, void *pvUser);
+
+/**
  * Copies the group settings and flags from logger instance to another.
  *

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

@@ -933 +933 @@
         rtlogUnlock(pDstLogger);
     }
+}
+
+
+/**
+ * Sets the custom prefix callback.
+ *
+ * @returns IPRT status code.
+ * @param   pLogger     The logger instance.
+ * @param   pfnCallback The callback.
+ * @param   pvUser      The user argument for the callback.
+ *  */
+RTDECL(int) RTLogSetCustomPrefixCallback(PRTLOGGER pLogger, PFNRTLOGPREFIX pfnCallback, void *pvUser)
+{
+    /*
+     * Resolve defaults.
+     */
+    if (!pLogger)
+    {
+        pLogger = RTLogDefaultInstance();
+        if (!pLogger)
+            return VINF_SUCCESS;
+    }
+    AssertReturn(pLogger->u32Magic == RTLOGGER_MAGIC, VERR_INVALID_MAGIC);
+
+    /*
+     * Do the work.
+     */
+    rtlogLock(pLogger);
+    pLogger->pvPrefixUserArg = pvUser;
+    pLogger->pfnPrefix       = pfnCallback;
+    rtlogUnlock(pLogger);
+
+    return VINF_SUCCESS;
 }
 
@@ -1275 +1308 @@
             { "tid",          sizeof("tid"         ) - 1,   RTLOGFLAGS_PREFIX_TID,          false },
             { "thread",       sizeof("thread"      ) - 1,   RTLOGFLAGS_PREFIX_THREAD,       false },
+            { "custom",       sizeof("custom"      ) - 1,   RTLOGFLAGS_PREFIX_CUSTOM,       false },
             { "timeprog",     sizeof("timeprog"    ) - 1,   RTLOGFLAGS_PREFIX_TIME_PROG,    false },
             { "time",         sizeof("time"        ) - 1,   RTLOGFLAGS_PREFIX_TIME,         false },
@@ -1933 +1967 @@
                 /*
                  * Flush the buffer if there isn't enough room for the maximum prefix config.
-                 * Max is 224, add a couple of extra bytes.
+                 * Max is 256, add a couple of extra bytes.
                  */
-                if (cb < 224 + 16)
+                if (cb < 256 + 16)
                 {
                     rtlogFlush(pLogger);
@@ -2084 +2118 @@
                     const char *pszName = RTThreadSelfName();
 #elif defined IN_RC
-                    const char *pszName = "EMT-GC";
+                    const char *pszName = "EMT-RC";
 #else
-                    const char *pszName = "EMT-R0";
+                    const char *pszName = "R0";
 #endif
                     size_t cch = 0;
@@ -2110 +2144 @@
                     *psz++ = ' ';                                                               /* +17 */
                 }
+#ifndef IN_RC
+                if (    (pLogger->fFlags & RTLOGFLAGS_PREFIX_CUSTOM)
+                    &&  pLogger->pfnPrefix)
+                {
+                    psz += pLogger->pfnPrefix(pLogger, psz, 31, pLogger->pvPrefixUserArg);
+                    *psz++ = ' ';                                                               /* +32 */
+                }
+#endif
                 if (pLogger->fFlags & RTLOGFLAGS_PREFIX_LOCK_COUNTS)
                 {