Changeset 4860 in vbox

Timestamp:

Sep 17, 2007 3:45:24 PM (17 years ago)

Author:

vboxsync

Message:

Activated the full backdoor logger in release builds of the Linux Guest Additions kernel modules

Location:

trunk

Files:

• include/iprt/log.h (modified) (1 diff)
• src/VBox/Additions/common/VBoxGuestLib/VBoxGuestLog.h (modified) (1 diff)
• src/VBox/Additions/linux/module/Makefile.module (modified) (2 diffs)
• src/VBox/Additions/linux/module/vboxmod.c (modified) (5 diffs)
• src/VBox/Additions/linux/sharedfolders/dirops.c (modified) (4 diffs)
• src/VBox/Additions/linux/sharedfolders/regops.c (modified) (7 diffs)
• src/VBox/Additions/linux/sharedfolders/utils.c (modified) (5 diffs)
• src/VBox/Additions/linux/sharedfolders/vfsmod.c (modified) (7 diffs)
• src/VBox/Runtime/VBox/logbackdoor.cpp (modified) (1 diff)

trunk/include/iprt/log.h

@@ -529 +529 @@
     do {  LogTrace(); LogFlow(m); } while (0)
 
+/** @def LogFunc
+ * Level 1 logging inside C/C++ functions.
+ * Prepends the given log message with the function name followed by a semicolon
+ * and space.
+ * @param m    log message in format <tt>("string\n" [, args])</tt>
+ * @todo use a Log macro with a variable argument list (requires MSVC8) to
+ * join two separate Log* calls and make this op atomic
+ */
+#define LogFunc(m) \
+    do { Log(("%s: ", __PRETTY_FUNCTION__)); Log(m); } while (0)
+
+/** @def LogThisFunc
+ * The same as LogFunc but for class functions (methods): the resulting log
+ * line is additionally perpended with a hex value of |this| pointer.
+ * @param m    log message in format <tt>("string\n" [, args])</tt>
+ * @todo use a Log macro with a variable argument list (requires MSVC8) to
+ * join two separate Log* calls and make this op atomic
+ */
+#define LogThisFunc(m) \
+    do { Log(("{%p} %s: ", this, __PRETTY_FUNCTION__)); Log(m); } while (0)
+
 /** @def LogFlowFunc
  * Macro to log the execution flow inside C/C++ functions.

trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestLog.h

@@ -22 +22 @@
 #if defined(RT_OS_LINUX)
 
-/* Since I don't know the background for the stuff below, I prefer not to change
-   it.  I don't need it or want it for backdoor logging inside the Linux
-   Guest Additions kernel modules though. */
+/* Since I don't know the background for the stuff below, I prefer not to
+   change it.  I don't need it or want it for backdoor logging inside the
+   Linux Guest Additions kernel modules though. */
 # include <VBox/log.h>
-# define LogRelPrint(a) \
-      do { \
-          RTLogWriteUser (a, strlen(a)); \
-      } while (0)
-
-# define LogRelPrintQuote(a) \
-      do { \
-          LogRelPrint (#a); \
-      } while (0)
-
-# define LogRelPrintFunc(a) \
-      do { \
-          LogRelPrint (__PRETTY_FUNCTION__); \
-          LogRelPrint (": "); \
-          LogRelPrint (a); \
-      } while (0)
-
-# define LogFunc(a) \
-      do { \
-          Log(("%s: ", __PRETTY_FUNCTION__)); \
-          Log(a); \
-      } while (0)
 
 #else  /* RT_OS_LINUX not defined */

trunk/src/VBox/Additions/linux/module/Makefile.module

@@ -33 +33 @@
         udivdi3.o \
         umoddi3.o \
-        qdivrem.o
-ifeq ($(BUILD_TYPE),debug)
-OBJS  += \
+        qdivrem.o \
         logbackdoor.o \
         logformat.o \
@@ -41 +39 @@
         strformatrt.o \
         strformat-vbox.o
-endif
 
 ifneq ($(MAKECMDGOALS),clean)

trunk/src/VBox/Additions/linux/module/vboxmod.c

@@ -25 +25 @@
 #include <VBox/log.h>
 
-#define VERSION "0.5"
-
 MODULE_DESCRIPTION("VirtualBox Guest Additions for Linux Module");
 MODULE_AUTHOR("innotek GmbH");
@@ -38 +36 @@
                         const char *pszFile, const char *pszFunction)
 {
-    elog("!!Assertion Failed!!\n"
-         "Expression: %s\n"
-         "Location  : %s(%d) %s\n",
-         pszExpr, pszFile, uLine, pszFunction);
     Log(("!!Assertion Failed!!\n"
          "Expression: %s\n"
@@ -58 +52 @@
     vsnprintf(msg, sizeof(msg) - 1, pszFormat, ap);
     msg[sizeof(msg) - 1] = '\0';
-    elog("%s", msg);
     Log(("%s", msg));
     va_end(ap);
@@ -69 +62 @@
 }
 EXPORT_SYMBOL(RTAssertDoBreakpoint);
-#if !defined(DEBUG) && defined(IN_MODULE)
-/** Write a string to the backdoor logger. */
-RTDECL(void) RTLogWriteUser(const char *pch, size_t cb)
-{
-    const uint8_t *pu8;
-    for (pu8 = (const uint8_t *)pch; cb-- > 0; pu8++)
-        ASMOutU8(RTLOG_DEBUG_PORT, *pu8);
-    /** @todo a rep outs could be more efficient, I don't know...
-     * @code
-     * __asm {
-     *      mov     ecx, [cb]
-     *      mov     esi, [pch]
-     *      mov     dx, RTLOG_DEFAULT_PORT
-     *      rep outsb
-     * }
-     * @endcode
-     */
-}
-EXPORT_SYMBOL(RTLogWriteUser);
-#endif /* DEBUG not defined and IN_MODULE defined */
 
 /** device extension structure (we only support one device instance) */
@@ -670 +643 @@
     VMMDevReportGuestInfo *infoReq = NULL;
 
-    printk(KERN_INFO "vboxadd: initializing version %s\n", VERSION);
+    printk(KERN_INFO "vboxadd: initializing version %s\n", VBOX_VERSION_STRING);
+    LogRel(("Starting VirtualBox Guest Additions version %s\n",
+            VBOX_VERSION_STRING));
 
     if (vboxadd_cmc_init ())

trunk/src/VBox/Additions/linux/sharedfolders/dirops.c

@@ -42 +42 @@
 
         if (!sf_d) {
-                LogRelPrintFunc("could not allocate directory info for");
-                LogRelPrint(sf_i->path->String.utf8);
-                LogRelPrint("\n");
+                LogRelFunc(("could not allocate directory info for %s\n",
+                            sf_i->path->String.utf8));
                 return -ENOMEM;
         }
@@ -211 +210 @@
                 fake_ino = sanity;
                 if (sanity - fake_ino) {
-                        LogRelPrintFunc("can not compute ino\n");
+                        LogRelFunc(("can not compute ino\n"));
                         return -EINVAL;
                 }
@@ -286 +285 @@
                 sf_new_i = kmalloc (sizeof (*sf_new_i), GFP_KERNEL);
                 if (!sf_new_i) {
-                        LogRelPrintFunc("could not allocate memory for new inode info\n");
+                        LogRelFunc(("could not allocate memory for new inode info\n"));
                         err = -ENOMEM;
                         goto fail1;
@@ -337 +336 @@
         sf_new_i = kmalloc (sizeof (*sf_new_i), GFP_KERNEL);
         if (!sf_new_i) {
-                LogRelPrintFunc("could not allocate inode info.  caller=");
-                LogRelPrint(caller);
-                LogRelPrint("\n");
+                LogRelFunc(("could not allocate inode info.  caller=%s\n", caller));
                 err = -ENOMEM;
                 goto fail0;

trunk/src/VBox/Additions/linux/sharedfolders/regops.c

@@ -65 +65 @@
         tmp = kmalloc (CHUNK_SIZE, GFP_KERNEL);
         if (!tmp) {
-                LogRelPrintFunc("could not allocate bounce buffer memory ");
-                LogRelPrintQuote(CHUNK_SIZE);
-                LogRelPrint(" bytes\n");
+                LogRelFunc(("could not allocate bounce buffer memory %d bytes\n", CHUNK_SIZE));
                 return -ENOMEM;
         }
@@ -137 +135 @@
         tmp = kmalloc (CHUNK_SIZE, GFP_KERNEL);
         if (!tmp) {
-                LogRelPrintFunc("could not allocate bounce buffer memory ");
-                LogRelPrintQuote(CHUNK_SIZE);
-                LogRelPrint("bytes\n");
+                LogRelFunc(("could not allocate bounce buffer memory %d\n", CHUNK_SIZE));
                 return -ENOMEM;
         }
@@ -205 +201 @@
         sf_r = kmalloc (sizeof (*sf_r), GFP_KERNEL);
         if (!sf_r) {
-                LogRelPrintFunc("could not allocate reg info\n");
+                LogRelFunc(("could not allocate reg info\n"));
                 return -ENOMEM;
         }
@@ -223 +219 @@
                 /* We ignore O_EXCL, as the Linux kernel seems to call create
                    beforehand itself, so O_EXCL should always fail. */
-//                if (file->f_flags & O_EXCL) {
-//                        LogFunc(("O_EXCL set\n"));
-//                        params.CreateFlags |= SHFL_CF_ACT_FAIL_IF_EXISTS;
-//                }
-//                else {
-                        /* O_TRUNC combined with O_EXCL is undefined. */
-                        if (file->f_flags & O_TRUNC) {
-                                LogFunc(("O_TRUNC set\n"));
-                                params.CreateFlags |= SHFL_CF_ACT_OVERWRITE_IF_EXISTS;
-                        }
-                        else {
-                                params.CreateFlags |= SHFL_CF_ACT_OPEN_IF_EXISTS;
-                        }
-//                }
+                if (file->f_flags & O_TRUNC) {
+                        LogFunc(("O_TRUNC set\n"));
+                        params.CreateFlags |= SHFL_CF_ACT_OVERWRITE_IF_EXISTS;
+                }
+                else {
+                        params.CreateFlags |= SHFL_CF_ACT_OPEN_IF_EXISTS;
+                }
         }
         else {
@@ -248 +237 @@
         if (!(params.CreateFlags & SHFL_CF_ACCESS_READWRITE)) {
                 switch (file->f_flags & O_ACCMODE) {
-                        case O_RDONLY:
-                                params.CreateFlags |= SHFL_CF_ACCESS_READ;
-                                break;
-
-                        case O_WRONLY:
-                                params.CreateFlags |= SHFL_CF_ACCESS_WRITE;
-                                break;
-
-                        case O_RDWR:
-                                params.CreateFlags |= SHFL_CF_ACCESS_READWRITE;
-                                break;
-
-                        default:
-                                BUG ();
+                case O_RDONLY:
+                        params.CreateFlags |= SHFL_CF_ACCESS_READ;
+                        break;
+
+                case O_WRONLY:
+                        params.CreateFlags |= SHFL_CF_ACCESS_WRITE;
+                        break;
+
+                case O_RDWR:
+                        params.CreateFlags |= SHFL_CF_ACCESS_READWRITE;
+                        break;
+
+                default:
+                        BUG ();
                 }
         }
@@ -273 +262 @@
                          file->f_flags, params.CreateFlags, rc));
                 kfree (sf_r);
-                return -EPROTO;
+                return -RTErrConvertToErrno(rc);
         }
 
@@ -347 +336 @@
         page = alloc_page (GFP_HIGHUSER);
         if (!page) {
-                LogRelPrintFunc("failed to allocate page\n");
+                LogRelFunc(("failed to allocate page\n"));
                 SET_TYPE (VM_FAULT_OOM);
                 return NOPAGE_OOM;

trunk/src/VBox/Additions/linux/sharedfolders/utils.c

@@ -251 +251 @@
         tmp = kmalloc (shflstring_len, GFP_KERNEL);
         if (!tmp) {
-                LogRelPrintFunc("kmalloc failed, caller=");
-                LogRelPrint(caller);
+                LogRelFunc(("kmalloc failed, caller=%s\n", caller));
                 return -ENOMEM;
         }
@@ -419 +418 @@
         b = kmalloc (sizeof (*b), GFP_KERNEL);
         if (!b) {
-                LogRelPrintFunc("could not alloc directory buffer\n");
+                LogRelFunc(("could not alloc directory buffer\n"));
                 return NULL;
         }
@@ -430 +429 @@
         if (!b->buf) {
                 kfree (b);
-                LogRelPrintFunc("could not alloc directory buffer storage\n");
+                LogRelFunc(("could not alloc directory buffer storage\n"));
                 return NULL;
         }
@@ -480 +479 @@
         p = kmalloc (sizeof (*p), GFP_KERNEL);
         if (!p) {
-                LogRelPrintFunc("could not alloc directory info\n");
+                LogRelFunc(("could not alloc directory info\n"));
                 return NULL;
         }
@@ -536 +535 @@
                         if (!b) {
                                 err = -ENOMEM;
-                                LogRelPrintFunc("could not alloc directory buffer\n");
+                                LogRelFunc(("could not alloc directory buffer\n"));
                                 goto fail1;
                         }

trunk/src/VBox/Additions/linux/sharedfolders/vfsmod.c

@@ -73 +73 @@
         if (!sf_g) {
                 err = -ENOMEM;
-                LogRelPrintFunc("could not allocate memory for global info\n");
+                LogRelFunc(("could not allocate memory for global info\n"));
                 goto fail0;
         }
@@ -91 +91 @@
         if (!str_name) {
                 err = -ENOMEM;
-                LogRelPrintFunc("could not allocate memory for host name\n");
+                LogRelFunc(("could not allocate memory for host name\n"));
                 goto fail1;
         }
@@ -196 +196 @@
         if (!sf_i) {
                 err = -ENOMEM;
-                LogRelPrintFunc ("could not allocate memory for root inode info\n");
+                LogRelFunc (("could not allocate memory for root inode info\n"));
                 goto fail1;
         }
@@ -203 +203 @@
         if (!sf_i->path) {
                 err = -ENOMEM;
-                LogRelPrintFunc ("could not allocate memory for root inode path\n");
+                LogRelFunc (("could not allocate memory for root inode path\n"));
                 goto fail2;
         }
@@ -418 +418 @@
         rc = vboxInit ();
         if (VBOX_FAILURE (rc)) {
-                LogRelPrintFunc ("vboxInit failed\n");
-                Log (("rc=%d\n", rc));
+                LogRelFunc (("vboxInit failed, rc=%d\n", rc));
                 goto fail0;
         }
@@ -425 +424 @@
         rc = vboxConnect (&client_handle);
         if (VBOX_FAILURE (rc)) {
-                LogRelPrintFunc ("vboxConnect failed\n");
-                Log (("rc=%d\n", rc));
+                LogRelFunc (("vboxConnect failed, rc=%d\n", rc));
                 goto fail1;
         }
@@ -432 +430 @@
         rc = vboxCallSetUtf8 (&client_handle);
         if (VBOX_FAILURE (rc)) {
-                LogRelPrintFunc ("vboxCallSetUtf8 failed\n");
-                Log (("rc=%d\n", rc));
+                LogRelFunc (("vboxCallSetUtf8 failed, rc=%d\n", rc));
                 goto fail2;
         }

trunk/src/VBox/Runtime/VBox/logbackdoor.cpp

@@ -84 +84 @@
  */
 # include <linux/module.h>
-# ifdef DEBUG
-/* We only export the full logging infrastructure to the guest kernel
-   modules in debug builds. */
 EXPORT_SYMBOL(RTLogBackdoorPrintf);
-# endif
 EXPORT_SYMBOL(RTLogWriteUser);
 #endif /* RT_OS_LINUX && IN_MODULE */
-