Changeset 3086

Timestamp:

06/11/07 10:43:47 (2 years ago)

Author:

vboxsync

Message:

introduced RTLogCreateEx and RTLogCreateExV to be able to pass an error string back to the caller

Files:

• trunk/include/iprt/log.h (modified) (1 diff)
• trunk/src/VBox/Frontends/VBoxBFE/VBoxBFE.cpp (modified) (2 diffs)
• trunk/src/VBox/Main/ConsoleImpl.cpp (modified) (2 diffs)
• trunk/src/VBox/Runtime/log.cpp (modified) (6 diffs)

trunk/include/iprt/log.h

@@ -1087 +1087 @@
-
-/**
+ * Create a logger instance.
+ *
+ * @returns iprt status code.
+ *
+ * @param   ppLogger            Where to store the logger instance.
+ * @param   fFlags              Logger instance flags, a combination of the RTLOGFLAGS_* values.
+ * @param   pszGroupSettings    The initial group settings.
+ * @param   pszEnvVarBase       Base name for the environment variables for this instance.
+ * @param   cGroups             Number of groups in the array.
+ * @param   papszGroups         Pointer to array of groups. This must stick around for the life of the
+ *                              logger instance.
+ * @param   fDestFlags          The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
+ * @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.
+ * @param   pszFilenameFmt      Log filename format string. Standard RTStrFormat().
+ * @param   ...                 Format arguments.
+ */
+RTDECL(int) RTLogCreateEx(PRTLOGGER *ppLogger, RTUINT fFlags, const char *pszGroupSettings,
+                          const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
+                          RTUINT fDestFlags, char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, ...);
+
+/**
+ * Create a logger instance.
+ *
+ * @returns iprt status code.
+ *
+ * @param   ppLogger            Where to store the logger instance.
+ * @param   fFlags              Logger instance flags, a combination of the RTLOGFLAGS_* values.
+ * @param   pszGroupSettings    The initial group settings.
+ * @param   pszEnvVarBase       Base name for the environment variables for this instance.
+ * @param   cGroups             Number of groups in the array.
+ * @param   papszGroups         Pointer to array of groups. This must stick around for the life of the
+ *                              logger instance.
+ * @param   fDestFlags          The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
+ * @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.
+ * @param   pszFilenameFmt      Log filename format string. Standard RTStrFormat().
+ * @param   args                Format arguments.
+ */
+RTDECL(int) RTLogCreateExV(PRTLOGGER *ppLogger, RTUINT fFlags, const char *pszGroupSettings,
+                           const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
+                           RTUINT fDestFlags, char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, va_list args);
+
+/**
- * Create a logger instance for singled threaded ring-0 usage.
- *

trunk/src/VBox/Frontends/VBoxBFE/VBoxBFE.cpp

@@ -935 +935 @@
-    {
-        static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
+        static char szError[RTPATH_MAX + 128] = "";
-        PRTLOGGER pLogger;
-
-
-RTLOGDEST_FILE
+Ex
+  
+  RTLOGDEST_FILE, szError, sizeof(szError)
-        if (VBOX_SUCCESS(rc2))
-        {
@@ -954 +955 @@
-            RTLogRelSetDefaultInstance(pLogger);
-        }
+        else
+            RTPrintf("Could not open release log (%s)\n", szError);
-    }
-

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -6555 +6555 @@
-        fFlags |= RTLOGFLAGS_USECRLF;
-#endif /* __WIN__ */
-
-
-
+
+
+
+
-        if (VBOX_SUCCESS(vrc))
-        {
@@ -6576 +6577 @@
-        {
-            hrc = setError (E_FAIL,
-
-
+
-            break;
-        }

trunk/src/VBox/Runtime/log.cpp

@@ -165 +165 @@
-#ifndef IN_GC
-/**
-
+, comprehensive version
- *
- * @returns iprt status code.
@@ -177 +177 @@
- *                              logger instance.
- * @param   fDestFlags          The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
+ * @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.
- * @param   pszFilenameFmt      Log filename format string. Standard RTStrFormat().
- * @param   ...                 Format arguments.
- */
-
-
-RTUINT fDestFlags, const char *pszFilenameFmt, ...
+ExV
+   
+   RTUINT fDestFlags, char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, va_list args
-{
-    /*
@@ -250 +252 @@
-            if (pszFilenameFmt)
-            {
-                va_list args;
-                va_start(args, pszFilenameFmt);
-                RTStrPrintfV(pLogger->pszFilename, RTPATH_MAX, pszFilenameFmt, args);
-                va_end(args);
-                pLogger->fDestFlags |= RTLOGDEST_FILE;
-            }
@@ -398 +397 @@
-#ifdef IN_RING3
-            if (pLogger->fDestFlags & RTLOGDEST_FILE)
+            {
-                rc = RTFileOpen(&pLogger->File, pLogger->pszFilename,
-                                RTFILE_O_WRITE | RTFILE_O_CREATE_REPLACE | RTFILE_O_DENY_WRITE);
+                if (RT_FAILURE(rc))
+                    RTStrPrintf(pszErrorMsg, cchErrorMsg, "could not open file '%s'", pLogger->pszFilename);
+            }
-#endif  /* IN_RING3 */
-
@@ -413 +416 @@
-                    return VINF_SUCCESS;
-                }
+                else
+                    RTStrPrintf(pszErrorMsg, cchErrorMsg, "failed to create sempahore");
-            }
-#ifdef IN_RING3
@@ -429 +434 @@
-}
-
+/**
+ * Create a logger instance.
+ *
+ * @returns iprt status code.
+ *
+ * @param   ppLogger            Where to store the logger instance.
+ * @param   fFlags              Logger instance flags, a combination of the RTLOGFLAGS_* values.
+ * @param   pszGroupSettings    The initial group settings.
+ * @param   pszEnvVarBase       Base name for the environment variables for this instance.
+ * @param   cGroups             Number of groups in the array.
+ * @param   papszGroups         Pointer to array of groups. This must stick around for the life of the
+ *                              logger instance.
+ * @param   fDestFlags          The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
+ * @param   pszFilenameFmt      Log filename format string. Standard RTStrFormat().
+ * @param   ...                 Format arguments.
+ */
+RTDECL(int) RTLogCreate(PRTLOGGER *ppLogger, RTUINT fFlags, const char *pszGroupSettings,
+                        const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
+                        RTUINT fDestFlags, const char *pszFilenameFmt, ...)
+{
+    va_list args;
+    int rc;
+
+    va_start(args, pszFilenameFmt);
+    rc = RTLogCreateExV(ppLogger, fFlags, pszGroupSettings, pszEnvVarBase, cGroups, papszGroups, fDestFlags, NULL, 0, pszFilenameFmt, args);
+    va_end(args);
+    return rc;
+}
+
+/**
+ * Create a logger instance.
+ *
+ * @returns iprt status code.
+ *
+ * @param   ppLogger            Where to store the logger instance.
+ * @param   fFlags              Logger instance flags, a combination of the RTLOGFLAGS_* values.
+ * @param   pszGroupSettings    The initial group settings.
+ * @param   pszEnvVarBase       Base name for the environment variables for this instance.
+ * @param   cGroups             Number of groups in the array.
+ * @param   papszGroups         Pointer to array of groups. This must stick around for the life of the
+ *                              logger instance.
+ * @param   fDestFlags          The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
+ * @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.
+ * @param   pszFilenameFmt      Log filename format string. Standard RTStrFormat().
+ * @param   ...                 Format arguments.
+ */
+RTDECL(int) RTLogCreateEx(PRTLOGGER *ppLogger, RTUINT fFlags, const char *pszGroupSettings,
+                          const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
+                          RTUINT fDestFlags,  char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, ...)
+{
+    va_list args;
+    int rc;
+
+    va_start(args, pszFilenameFmt);
+    rc = RTLogCreateExV(ppLogger, fFlags, pszGroupSettings, pszEnvVarBase, cGroups, papszGroups, fDestFlags, pszErrorMsg, cchErrorMsg, pszFilenameFmt, args);
+    va_end(args);
+    return rc;
+}
-
-/**