Changeset 58089 in vbox for trunk

Timestamp:

Oct 7, 2015 12:33:00 PM (9 years ago)

Author:

vboxsync

Message:

VBoxGuest,VBoxService,Doxyfile.Core: fixes.

Location:

trunk

Files:

• Doxyfile.Core (modified) (2 diffs)
• src/VBox/Additions/common/VBoxGuest/VBoxGuest-linux.c (modified) (3 diffs)
• src/VBox/Additions/common/VBoxGuest/VBoxGuest-os2.cpp (modified) (1 diff)
• src/VBox/Additions/common/VBoxGuest/VBoxGuest-win.cpp (modified) (1 diff)
• src/VBox/Additions/common/VBoxGuest/VBoxGuest.cpp (modified) (5 diffs)
• src/VBox/Additions/common/VBoxGuest/VBoxGuestIDC-unix.c.h (modified) (1 diff)
• src/VBox/Additions/common/VBoxGuest/VBoxGuestInternal.h (modified) (2 diffs)
• src/VBox/Additions/common/VBoxService/VBoxServiceControlProcess.cpp (modified) (5 diffs)
• src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp (modified) (1 diff)
• src/VBox/Additions/common/VBoxService/VBoxServicePageSharing.cpp (modified) (1 diff)
• src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp (modified) (1 diff)
• src/VBox/Additions/common/VBoxService/VBoxServiceUtils.cpp (modified) (2 diffs)
• src/VBox/Additions/common/VBoxService/VBoxServiceVMInfo-win.cpp (modified) (4 diffs)

trunk/Doxyfile.Core

@@ -444 +444 @@
     RT_C_DECLS_END \
     RT_C_DECLS_BEGIN \
-    VBOX \
+    VBOX=1 \
+    RT_STRICT=1 \
+    VBOX_STRICT=1 \
+    __cplusplus=1 \
+    ARCH_BITS=HC_ARCH_BITS \
+    R3_ARCH_BITS=HC_ARCH_BITS \
+    R0_ARCH_BITS=HC_ARCH_BITS \
+    RTDECL(type)=type \
+    RT_EXPORT_SYMBOL(name)= \
+    \
+    RT_SRC_POS=1 \
+    RT_SRC_POS_ARGS=SRC_POS \
+    "RT_SRC_POS_DECL=int SRC_POS" \
+    \
+    RT_IPRT_FORMAT_ATTR(a,b)= \
+    RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a,b)= \
+    RT_NO_THROW_PROTO=
+
+# decl and calling conventions.
+PREDEFINED += \
+    "DECLINLINE(type)=inline type" \
+    DECL_FORCE_INLINE(type)=DECLINLINE(type) \
+    DECL_NO_INLINE(type)=type \
+    DECLCALLBACK(type)=type \
+    DECLEXPORT(type)=type \
+    DECLIMPORT(type)=type \
+    DECLHIDDEN(type)=type \
+    DECL_HIDDEN_CONST(type)=type \
+    DECLASM(type)=type \
+    DECLNORETURN(type)=type \
+    VBOXCALL= \
+    RTCALL= 
+# context hacks.
+PREDEFINED            += RCPTRTYPE(RCType)=RCType
+PREDEFINED            += R3PTRTYPE(R3Type)=R3Type
+PREDEFINED            += R0PTRTYPE(R0Type)=R0Type
+PREDEFINED            += HCPTRTYPE(HCType)=HCType
+PREDEFINED            += R3R0PTRTYPE(R3R0Type)=R3R0Type
+# Compile assertion hacks.
+PREDEFINED            += \
     AssertCompileNS(expr) \
     AssertCompile(expr) \
@@ -458 +497 @@
     AssertCompileMembersSameSize(type1, member1, type2, member2) \
     AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)
-
-# context hacks.
-PREDEFINED            += RCPTRTYPE(RCType)=RCType
-PREDEFINED            += R3PTRTYPE(R3Type)=R3Type
-PREDEFINED            += R0PTRTYPE(R0Type)=R0Type
-PREDEFINED            += HCPTRTYPE(HCType)=HCType
-PREDEFINED            += R3R0PTRTYPE(R3R0Type)=R3R0Type
-# Compile assertion hacks.
-PREDEFINED            += \
-    AssertCompile(expr) \
-    AssertCompileSize(a,b) \
-    AssertCompileSizeAlignment(a,b) \
-    AssertCompileMemberSizeAlignment(a,b,c) \
-    AssertCompileMemberAlignment(a,b,c) \
-    AssertCompileMemberOffset(a,b,c) \
-    AssertCompile2MemberOffsets(a,b,c)
 # COM/XPCOM hacks.
 PREDEFINED            += STDMETHODIMP=HRESULT

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuest-linux.c

@@ -56 +56 @@
 /** The device name. */
 #define DEVICE_NAME             "vboxguest"
-/** The device name for the device node open to everyone.. */
+/** The device name for the device node open to everyone. */
 #define DEVICE_NAME_USER        "vboxuser"
 /** The name of the PCI driver */
@@ -334 +334 @@
  * @param   iIrq            The IRQ number.
  * @param   pvDevId         The device ID, a pointer to g_DevExt.
- * @param   pvRegs          Register set. Removed in 2.6.19.
- */
-#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 19)
-static irqreturn_t vboxguestLinuxISR(int iIrrq, void *pvDevId)
+ * @param   pRegs           Register set. Removed in 2.6.19.
+ */
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 19) && !defined(DOXYGEN_RUNNING)
+static irqreturn_t vboxguestLinuxISR(int iIrq, void *pvDevId)
 #else
-static irqreturn_t vboxguestLinuxISR(int iIrrq, void *pvDevId, struct pt_regs *pRegs)
+static irqreturn_t vboxguestLinuxISR(int iIrq, void *pvDevId, struct pt_regs *pRegs)
 #endif
 {
@@ -742 +742 @@
  * Device I/O Control entry point.
  *
+ * @param   pInode      Associated inode pointer.
  * @param   pFilp       Associated file pointer.
  * @param   uCmd        The function specified to ioctl().

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuest-os2.cpp

@@ -224 +224 @@
  * @returns VBox status code.
  * @retval  VERR_VERSION_MISMATCH       The VMMDev memory didn't meet our expectations.
- *
- * @param   pDevExt     The device extension.
  */
 static int vboxGuestOS2MapMemory(void)

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuest-win.cpp

@@ -555 +555 @@
  * Do not delete DevExt here.
  *
- * @param   pDrvObj     Driver object.
+ * @param   pDevObj     Device object.
  */
 NTSTATUS vbgdNtCleanup(PDEVICE_OBJECT pDevObj)

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuest.cpp

@@ -502 +502 @@
  * @returns VBox status code.
  * @param   pDevExt         The device extension.
- * @param   pSession        The session.
  * @param   cBalloonChunks  The new size of the balloon in chunks of 1MB.
  * @param   pfHandleInR3    Where to return the handle-in-ring3 indicator
@@ -727 +726 @@
  *
  * @param   pDevExt     The device extension.
- * @param   pDevExt     The session.  Can be NULL at unload.
+ * @param   pSession    The session.  Can be NULL at unload.
  */
 static void vgdrvCloseMemBalloon(PVBOXGUESTDEVEXT pDevExt, PVBOXGUESTSESSION pSession)
@@ -1768 +1767 @@
  *
  * @returns VINF_SUCCESS or VERR_PERMISSION_DENIED.
+ * @param   pDevExt             The device extension.
  * @param   pSession            The calling session.
  * @param   enmType             The request type.
@@ -2459 +2459 @@
  * @param   cbData              Size of the buffer.
  * @param   pcbDataReturned     Where to store the amount of returned data. Can be NULL.
+ * @param   fUserSession        Copy of VBOXGUESTSESSION::fUserSession for the
+ *                              call.  True normal user, false root user.
  */
 static int vgdrvIoCtl_Log(PVBOXGUESTDEVEXT pDevExt, const char *pch, size_t cbData, size_t *pcbDataReturned, bool fUserSession)
@@ -2956 +2958 @@
  *
  * @returns VBox status code.
- * @param   fMask       The new mask.
+ * @param   pDevExt             The device extension.
+ * @param   pReq                The request.
  */
 static int vgdrvUpdateCapabilitiesOnHostWithReqAndLock(PVBOXGUESTDEVEXT pDevExt, VMMDevReqGuestCapabilities2 *pReq)

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuestIDC-unix.c.h

@@ -98 +98 @@
  *
  * @returns VBox error code.
- * @param   pvState             Opaque pointer to the session object.
+ * @param   pvSession           Opaque pointer to the session object.
  */
 DECLEXPORT(int) VBOXCALL VBoxGuestIDCClose(void *pvSession)

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuestInternal.h

@@ -37 +37 @@
 #include <VBox/VBoxGuestLib.h>
 
-/** @def VBOXGUEST_USE_WAKE_UP_LIST
+/** @def VBOXGUEST_USE_DEFERRED_WAKE_UP
  * Defer wake-up of waiting thread when defined. */
 #if defined(RT_OS_DARWIN) || defined(RT_OS_SOLARIS) || defined(RT_OS_WINDOWS) || defined(DOXYGEN_RUNNING)
@@ -88 +88 @@
 typedef struct VBOXGUESTMEMBALLOON
 {
-    /** Mutex protecting the members below from concurrent access.. */
+    /** Mutex protecting the members below from concurrent access. */
     RTSEMFASTMUTEX              hMtx;
     /** The current number of chunks in the balloon. */

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlProcess.cpp

@@ -224 +224 @@
  * @return  IPRT status code.
  * @param   pProcess            Process to wait shutting down for.
- * @param   RTMSINTERVAL        Timeout in ms to wait for shutdown.
+ * @param   msTimeout           Timeout in ms to wait for shutdown.
  * @param   prc                 Where to store the thread's return code.
  *                              Optional.
@@ -280 +280 @@
  *
  * @return  IPRT status code.
- * @param   hPollSet            The polling set.
+ * @param   pProcess            The process which input pipe we close.
  * @param   phStdInW            The standard input pipe handle.
  */
@@ -1405 +1405 @@
  *
  * @return  IPRT status code.
- * @param   PVBOXSERVICECTRLPROCESS         Guest process.
+ * @param   pProcess        The process we're servicing and monitoring.
  */
 static int vgsvcGstCtrlProcessProcessWorker(PVBOXSERVICECTRLPROCESS pProcess)
@@ -1719 +1719 @@
  *
  * @return IPRT status code.
- * @param  RTTHREAD             Pointer to the thread's data.
- * @param  void*                User-supplied argument pointer.
- *
- */
-static DECLCALLBACK(int) vgsvcGstCtrlProcessThread(RTTHREAD ThreadSelf, void *pvUser)
-{
-    PVBOXSERVICECTRLPROCESS pProcess = (VBOXSERVICECTRLPROCESS*)pvUser;
+ * @param  hThreadSelf      The thread handle.
+ * @param  pvUser           Pointer to a VBOXSERVICECTRLPROCESS structure.
+ *
+ */
+static DECLCALLBACK(int) vgsvcGstCtrlProcessThread(RTTHREAD hThreadSelf, void *pvUser)
+{
+    PVBOXSERVICECTRLPROCESS pProcess = (PVBOXSERVICECTRLPROCESS)pvUser;
     AssertPtrReturn(pProcess, VERR_INVALID_POINTER);
     return vgsvcGstCtrlProcessProcessWorker(pProcess);
@@ -1748 +1748 @@
  * @param   pStartupInfo                Startup info.
  * @param   uContextID                  Context ID to associate the process to start with.
-
  */
 int VGSvcGstCtrlProcessStart(const PVBOXSERVICECTRLSESSION pSession,

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp

@@ -1592 +1592 @@
  *
  * @return  VBox status code.
+ * @param   pSession            The guest session.
  * @param   pbAllowed           True if starting (another) guest process
  *                              is allowed, false if not.

trunk/src/VBox/Additions/common/VBoxService/VBoxServicePageSharing.cpp

@@ -300 +300 @@
 /**
  * Inspect all loaded modules for the specified process
+ *
  * @param   dwProcessId     Process id
+ * @param   ppNewTree       The module tree we're assembling from modules found
+ *                          in this process.  Modules found are moved from
+ *                          g_pKnownModuleTree or created new.
  */
 static void vgsvcPageSharingInspectModules(DWORD dwProcessId, PAVLPVNODECORE *ppNewTree)

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp

@@ -967 +967 @@
 
 /**
- * Report the result of a vbox_mktemp operation - either errors to stderr (not
- * machine-readable) or everything to stdout as <name>\0<rc>\0 (machine-
- * readable format).  The message may optionally contain a '%s' for the file
- * name and an %Rrc for the result code in that order.  In future a "verbose"
- * flag may be added, without which nothing will be output in non-machine-
- * readable mode.  Sets prc if rc is a non-success code.
+ * Report the result of a vbox_mktemp operation.
+ *
+ * Either errors to stderr (not machine-readable) or everything to stdout as
+ * {name}\0{rc}\0 (machine- readable format).  The message may optionally
+ * contain a '%s' for the file name and an %Rrc for the result code in that
+ * order.  In future a "verbose" flag may be added, without which nothing will
+ * be output in non-machine- readable mode.  Sets prc if rc is a non-success
+ * code.
  */
 static void toolboxMkTempReport(const char *pcszMessage, const char *pcszFile,

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceUtils.cpp

@@ -269 +269 @@
  * @returns VBox status code.
  * @param   pszFilename         ASCII & ANSI & UTF-8 compliant name.
+ * @param   pdwMajor            Where to return the major version number.
+ * @param   pdwMinor            Where to return the minor version number.
+ * @param   pdwBuildNumber      Where to return the build number.
+ * @param   pdwRevisionNumber   Where to return the revision number.
  */
 static int vgsvcUtilGetFileVersion(const char *pszFilename, PDWORD pdwMajor, PDWORD pdwMinor, PDWORD pdwBuildNumber,
@@ -347 +351 @@
  *
  * @param   pszPath         The base path.
- * @param   pszFilaname     The filename.
+ * @param   pszFilename     The filename.
  * @param   pszVersion      Where to return the version string.
  * @param   cbVersion       The size of the version string buffer. This MUST be

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceVMInfo-win.cpp

@@ -607 +607 @@
  * vgsvcVMInfoWinProcessesEnumerate() before.
  *
- * @param   paProcs     What
+ * @param   cProcs      Number of processes in paProcs.
+ * @param   paProcs     The process array.
  */
 static void vgsvcVMInfoWinProcessesFree(DWORD cProcs, PVBOXSERVICEVMINFOPROC paProcs)
 {
     for (DWORD i = 0; i < cProcs; i++)
-    {
         if (paProcs[i].pSid)
         {
@@ -618 +618 @@
             paProcs[i].pSid = NULL;
         }
-
-    }
     RTMemFree(paProcs);
 }
@@ -627 +625 @@
  *
  * @returns Number of processes found for a specified session.
- * @param   pSession        The current user's SID.
- * @param   paProcs         The process snapshot.
- * @param   cProcs          The number of processes in the snaphot.
- * @param   puSession       Looked up session number.  Optional.
+ * @param   pSession            The current user's SID.
+ * @param   paProcs             The process snapshot.
+ * @param   cProcs              The number of processes in the snaphot.
+ * @param   puTerminalSession   Where to return terminal session number.
+ *                              Optional.
  */
-static uint32_t vgsvcVMInfoWinSessionHasProcesses(PLUID pSession,
-                                                  PVBOXSERVICEVMINFOPROC const paProcs, DWORD cProcs, PULONG puTerminalSession)
+static uint32_t vgsvcVMInfoWinSessionHasProcesses(PLUID pSession, PVBOXSERVICEVMINFOPROC const paProcs, DWORD cProcs,
+                                                  PULONG puTerminalSession)
 {
     if (!pSession)
@@ -1063 +1062 @@
  *
  * @returns VBox status code.
- * @param   pCachce         Property cache to use for storing some of the lookup
+ * @param   pCache          Property cache to use for storing some of the lookup
  *                          data in between calls.
  * @param   ppszUserList    Where to store the user list (separated by commas).