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

Timestamp:

Nov 19, 2017 12:49:36 PM (7 years ago)

Author:

vboxsync

Message:

Changed RTLogCreateEx[V] to take a RTERRINFO pointer rather than plain char * and size_t. Turned out a several callers didn't actually make use of the error message even.

File:

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

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

@@ -228 +228 @@
 #endif
 #ifdef IN_RING3
-static int  rtR3LogOpenFileDestination(PRTLOGGER pLogger, char *pszErrorMsg, size_t cchErrorMsg);
+static int  rtR3LogOpenFileDestination(PRTLOGGER pLogger, PRTERRINFO pErrInfo);
 #endif
 #ifndef IN_RC
@@ -781 +781 @@
                            uint32_t fDestFlags, PFNRTLOGPHASE pfnPhase, uint32_t cHistory,
                            uint64_t cbHistoryFileMax, uint32_t cSecsHistoryTimeSlot,
-                           char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, va_list args)
+                           PRTERRINFO pErrInfo, const char *pszFilenameFmt, va_list args)
 {
     int         rc;
@@ -791 +791 @@
      * Validate input.
      */
-    if (    (cGroups && !papszGroups)
-        ||  !VALID_PTR(ppLogger) )
+    if (   (cGroups && !papszGroups)
+        || !VALID_PTR(ppLogger) )
     {
         AssertMsgFailed(("Invalid parameters!\n"));
@@ -798 +798 @@
     }
     *ppLogger = NULL;
-
-    if (pszErrorMsg)
-        RTStrPrintf(pszErrorMsg, cchErrorMsg, N_("unknown error"));
 
     AssertMsgReturn(cHistory < _1M, ("%#x", cHistory), VERR_OUT_OF_RANGE);
@@ -882 +879 @@
         else
         {
+            rc = VERR_NO_MEMORY;
 #  ifdef RT_OS_LINUX
-            if (pszErrorMsg) /* Most probably SELinux causing trouble since the larger RTMemAlloc succeeded. */
-                RTStrPrintf(pszErrorMsg, cchErrorMsg, N_("mmap(PROT_WRITE | PROT_EXEC) failed -- SELinux?"));
+                /* Most probably SELinux causing trouble since the larger RTMemAlloc succeeded. */
+            RTErrInfoSet(rc, N_("mmap(PROT_WRITE | PROT_EXEC) failed -- SELinux?"));
 #  endif
-            rc = VERR_NO_MEMORY;
         }
         if (RT_SUCCESS(rc))
@@ -948 +945 @@
 # ifdef IN_RING3
             if ((pLogger->fDestFlags & (RTLOGDEST_FILE | RTLOGDEST_F_DELAY_FILE)) == RTLOGDEST_FILE)
-                rc = rtR3LogOpenFileDestination(pLogger, pszErrorMsg, cchErrorMsg);
+                rc = rtR3LogOpenFileDestination(pLogger, pErrInfo);
 # endif
 
@@ -984 +981 @@
                 }
 
-                if (pszErrorMsg)
-                    RTStrPrintf(pszErrorMsg, cchErrorMsg, N_("failed to create semaphore"));
+                RTErrInfoSet(pErrInfo, rc, N_("failed to create semaphore"));
             }
 # ifdef IN_RING3
@@ -1016 +1012 @@
     rc = RTLogCreateExV(ppLogger, fFlags, pszGroupSettings, pszEnvVarBase, cGroups, papszGroups,
                         fDestFlags, NULL /*pfnPhase*/, 0 /*cHistory*/, 0 /*cbHistoryFileMax*/, 0 /*cSecsHistoryTimeSlot*/,
-                        NULL /*pszErrorMsg*/, 0 /*cchErrorMsg*/, pszFilenameFmt, args);
+                        NULL /*pErrInfo*/, pszFilenameFmt, args);
     va_end(args);
     return rc;
@@ -1027 +1023 @@
                           uint32_t fDestFlags, PFNRTLOGPHASE pfnPhase, uint32_t cHistory,
                           uint64_t cbHistoryFileMax, uint32_t cSecsHistoryTimeSlot,
-                          char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, ...)
+                          PRTERRINFO pErrInfo, const char *pszFilenameFmt, ...)
 {
     va_list args;
@@ -1035 +1031 @@
     rc = RTLogCreateExV(ppLogger, fFlags, pszGroupSettings, pszEnvVarBase, cGroups, papszGroups,
                         fDestFlags, pfnPhase, cHistory, cbHistoryFileMax, cSecsHistoryTimeSlot,
-                        pszErrorMsg, cchErrorMsg, pszFilenameFmt, args);
+                        pErrInfo, pszFilenameFmt, args);
     va_end(args);
     return rc;
@@ -2458 +2454 @@
                 && pLogger->pInt->hFile == NIL_RTFILE)
             {
-                rc = rtR3LogOpenFileDestination(pLogger, NULL, 0);
+                rc = rtR3LogOpenFileDestination(pLogger, pErrInfo);
                 if (RT_SUCCESS(rc))
                     rtlogFlush(pLogger, false /*fNeedSpace*/);
@@ -3174 +3170 @@
  *
  * @param   pLogger         The logger instance to update. NULL is not allowed!
- * @param   pszErrorMsg     A buffer which is filled with an error message if
- *                          something fails.  May be NULL.
- * @param   cchErrorMsg     The size of the error message buffer.
- */
-static int rtlogFileOpen(PRTLOGGER pLogger, char *pszErrorMsg, size_t cchErrorMsg)
+ * @param   pErrInfo        Where to return extended error information.
+ *                          Optional.
+ */
+static int rtlogFileOpen(PRTLOGGER pLogger, PRTERRINFO pErrInfo)
 {
     uint32_t fOpen = RTFILE_O_WRITE | RTFILE_O_DENY_NONE;
@@ -3211 +3206 @@
     {
         pLogger->pInt->hFile = NIL_RTFILE;
-        if (pszErrorMsg)
-            RTStrPrintf(pszErrorMsg, cchErrorMsg, N_("could not open file '%s' (fOpen=%#x)"), pLogger->pInt->szFilename, fOpen);
+        RTErrInfoSetF(pErrInfo, rc, N_("could not open file '%s' (fOpen=%#x)"), pLogger->pInt->szFilename, fOpen);
     }
     return rc;
@@ -3228 +3222 @@
  *                      called from RTLogCreateExV.  Prevents pfnPhase from
  *                      being called.
- */
-static void rtlogRotate(PRTLOGGER pLogger, uint32_t uTimeSlot, bool fFirst)
+ * @param   pErrInfo    Where to return extended error information. Optional.
+ */
+static void rtlogRotate(PRTLOGGER pLogger, uint32_t uTimeSlot, bool fFirst, PRTERRINFO pErrInfo)
 {
     /* Suppress rotating empty log files simply because the time elapsed. */
@@ -3321 +3316 @@
     pLogger->pInt->cbHistoryFileWritten = 0;
     pLogger->pInt->uHistoryTimeSlotStart = uTimeSlot;
-    rtlogFileOpen(pLogger, NULL, 0);
+    rtlogFileOpen(pLogger, pErrInfo);
 
     /*
@@ -3349 +3344 @@
  * @returns IPRT status code.
  * @param   pLogger             The logger.
- * @param   pszErrorMsg         Where to return error info. Optional.
- * @param   cchErrorMsg         Size of @a pszErrorMsg buffer.
- */
-static int rtR3LogOpenFileDestination(PRTLOGGER pLogger, char *pszErrorMsg, size_t cchErrorMsg)
+ * @param   pErrInfo            Where to return extended error information.
+ *                              Optional.
+ */
+static int rtR3LogOpenFileDestination(PRTLOGGER pLogger, PRTERRINFO pErrInfo)
 {
     int rc;
     if (pLogger->fFlags & RTLOGFLAGS_APPEND)
     {
-        rc = rtlogFileOpen(pLogger, pszErrorMsg, cchErrorMsg);
+        rc = rtlogFileOpen(pLogger, pErrInfo);
 
         /* Rotate in case of appending to a too big log file,
            otherwise this simply doesn't do anything. */
-        rtlogRotate(pLogger, 0, true /* fFirst */);
+        rtlogRotate(pLogger, 0, true /* fFirst */, pErrInfo);
     }
     else
@@ -3367 +3362 @@
         /* Force rotation if it is configured. */
         pLogger->pInt->cbHistoryFileWritten = UINT64_MAX;
-        rtlogRotate(pLogger, 0, true /* fFirst */);
+        rtlogRotate(pLogger, 0, true /* fFirst */, pErrInfo);
 
         /* If the file is not open then rotation is not set up. */
@@ -3373 +3368 @@
         {
             pLogger->pInt->cbHistoryFileWritten = 0;
-            rc = rtlogFileOpen(pLogger, pszErrorMsg, cchErrorMsg);
+            rc = rtlogFileOpen(pLogger, pErrInfo);
         }
         else
@@ -3481 +3476 @@
         if (   (pLogger->fDestFlags & RTLOGDEST_FILE)
             && pLogger->pInt->cHistory)
-            rtlogRotate(pLogger, RTTimeProgramSecTS() / pLogger->pInt->cSecsHistoryTimeSlot, false /* fFirst */);
+            rtlogRotate(pLogger, RTTimeProgramSecTS() / pLogger->pInt->cSecsHistoryTimeSlot, false /*fFirst*/, NULL /*pErrInfo*/);
 #endif
     }