Changeset 75547 in vbox for trunk/include

Timestamp:

Nov 18, 2018 4:50:34 AM (6 years ago)

Author:

vboxsync

Message:

VBoxGuest: Added an IDC interface for faster HGCM calls (VBGL_IOCTL_IDC_HGCM_FAST_CALL, VbglR0HGCMFastCall). This expects the caller to construct a valid call and only concerns itself with issuing it to the host and waiting for the result to arrive. bugref:9172

Location:

trunk/include/VBox

Files:

• VBoxGuest.h (modified) (6 diffs)
• VBoxGuestLib.h (modified) (5 diffs)

trunk/include/VBox/VBoxGuest.h

@@ -52 +52 @@
  *
  * - I/O controls for user and/or kernel mode starts at 0.
- * - IDC specific requests descends from 127.
+ * - IDC specific requests descends from 63.
  * - Bits 7 and 6 are currently reserved for future hacks.
  *
@@ -285 +285 @@
 /** @} */
 
-
 #ifdef VBOX_WITH_HGCM
+
 /** @name VBGL_IOCTL_HGCM_CONNECT
  * Connect to a HGCM service.
@@ -344 +344 @@
 /** @name VBGL_IOCTL_HGCM_CALL, VBGL_IOCTL_HGCM_CALL_WITH_USER_DATA
  *
- * Make a call to a HGCM servicesure.  There are several variations here.
+ * Make a call to a HGCM service.  There are several variations here.
  *
  * The VBGL_IOCTL_HGCM_CALL_WITH_USER_DATA variation is for other drivers (like
@@ -360 +360 @@
 # define VBGL_IOCTL_HGCM_CALL_WITH_USER_DATA(a_cb)  VBGL_IOCTL_CODE_SIZE(8, (a_cb))
 /** @} */
+
+
+/** @name VBGL_IOCTL_IDC_HGCM_FAST_CALL
+ *
+ * Variant of VBGL_IOCTL_HGCM_CALL for drivers that submits the request as-is to
+ * the host and handles the waiting, the caller does all the rest.
+ *
+ * @note ring-0 only.
+ * @note Size is not encoded in the I/O control code.
+ * @{
+ */
+#define VBGL_IOCTL_IDC_HGCM_FAST_CALL               VBGL_IOCTL_CODE_SIZE(62, sizeof(VBGLIOCIDCHGCMFASTCALL))
+#define VBGL_IOCTL_IDC_HGCM_FAST_CALL_SIZE(a_cb)    (a_cb)
+#define VBGL_IOCTL_IDC_HGCM_FAST_CALL_SIZE_IN(a_cb) (a_cb)
+#define VBGL_IOCTL_IDC_HGCM_FAST_CALL_SIZE_OUT(a_cb) (a_cb)
+#pragma pack(4) /* Want it to fit nicely with the 44 byte VMMDevHGCMCall and optimally align 64-bit parameters structures.  */
+typedef struct VBGLIOCIDCHGCMFASTCALL
+{
+    /** The header. */
+    VBGLREQHDR      Hdr;
+    /** The physical address of the following VMMDevHGCMCall structure. */
+    RTGCPHYS32      GCPhysReq;
+    /** Set if interruptible. */
+    bool            fInterruptible;
+    /** Reserved. */
+    uint8_t         abReserved0[3];
+    uint64_t        uTimestamp[2];
+    uint8_t         abReserved1[4];
+    /* After this structure follows a VMMDevHGCMCall strcuture (44 bytes), then
+       zero or more HGCMFunctionParameter structures (12 or 16 bytes), and finally
+       page lists and embedded buffers. */
+} VBGLIOCIDCHGCMFASTCALL, RT_FAR *PVBGLIOCIDCHGCMFASTCALL;
+#pragma pack()
+AssertCompileSize(VBGLIOCIDCHGCMFASTCALL, /* 24 + 4 + 1 + 3 + 2*8 + 4 = 0x34 (52) = */ 0x34);
+
+/**
+ * Macro for initializing VBGLIOCIDCHGCMFASTCALL and the following
+ * VMMDevHGCMCall structures.
+ *
+ * @param   a_pHdr      The request header to initialize.
+ * @param   a_HdrPhys   The 32-bit physical address corresponding to @a a_pHdr.
+ * @param   a_pCall     Pointer to the VMMDevHGCMCall structure.
+ * @param   a_idClient  The HGCM client ID.
+ * @param   a_uFunction The HGCM function number.
+ * @param   a_cParms    The number of parameters following @a a_pCall.
+ * @param   a_cbReq     The size of the whole request.
+ */
+#define VBGLIOCIDCHGCMFASTCALL_INIT(a_pHdr, a_HdrPhys, a_pCall, a_idClient, a_uFunction, a_cParms, a_cbReq) \
+    do { \
+        Assert((uintptr_t)(a_pHdr) + sizeof(VBGLIOCIDCHGCMFASTCALL) == (uintptr_t)(a_pCall)); \
+        VBGLREQHDR_INIT_EX(&(a_pHdr)->Hdr, a_cbReq, a_cbReq); \
+        pReq->Hdr.GCPhysReq      = (a_HdrPhys) + sizeof(VBGLIOCIDCHGCMFASTCALL); \
+        pReq->Hdr.fInterruptible = false; \
+        \
+        (a_pCall)->header.header.size       = (a_cbReq) - sizeof(VBGLIOCIDCHGCMFASTCALL); \
+        (a_pCall)->header.header.version    = VBGLREQHDR_VERSION; \
+        (a_pCall)->header.header.requestType= (ARCH_BITS == 32 ? VMMDevReq_HGCMCall32 : VMMDevReq_HGCMCall64); \
+        (a_pCall)->header.header.rc         = VERR_INTERNAL_ERROR; \
+        (a_pCall)->header.header.reserved1  = 0; \
+        (a_pCall)->header.header.fRequestor = VMMDEV_REQUESTOR_KERNEL        | VMMDEV_REQUESTOR_USR_DRV_OTHER \
+                                            | VMMDEV_REQUESTOR_CON_DONT_KNOW | VMMDEV_REQUESTOR_TRUST_NOT_GIVEN; \
+        (a_pCall)->header.fu32Flags         = 0; \
+        (a_pCall)->header.result            = VERR_INTERNAL_ERROR; \
+        (a_pCall)->u32ClientID              = (a_idClient); \
+        (a_pCall)->u32Function              = (a_uFunction); \
+        (a_pCall)->cParms                   = (a_cParms); \
+    } while (0)
+
+
+/** @} */
+
 #endif /* VBOX_WITH_HGCM */
 
@@ -798 +869 @@
  *
  * @note ring-0 only.
+ * @{
  */
 #define VBGL_IOCTL_IDC_CONNECT                      VBGL_IOCTL_CODE_SIZE(63, VBGL_IOCTL_IDC_CONNECT_SIZE)
@@ -859 +931 @@
  *
  * @note ring-0 only.
+ * @{
  */
 #define VBGL_IOCTL_IDC_DISCONNECT                   VBGL_IOCTL_CODE_SIZE(62, VBGL_IOCTL_IDC_DISCONNECT_SIZE)

trunk/include/VBox/VBoxGuestLib.h

@@ -212 +212 @@
 # ifdef VBOX_WITH_HGCM
 struct VBGLIOCHGCMCALL;
+struct VBGLIOCIDCHGCMFASTCALL;
 
 #  ifdef VBGL_VBOXGUEST
@@ -325 +326 @@
 #  else  /* !VBGL_VBOXGUEST */
 
+#ifndef VBGL_VBOXGUEST
+/** @internal  */
+typedef struct VBGLHGCMHANDLEDATA
+{
+    uint32_t fAllocated;
+    VBGLIDCHANDLE IdcHandle;
+} VBGLHGCMHANDLEDATA;
+#else
 struct VBGLHGCMHANDLEDATA;
+#endif
+
 typedef struct VBGLHGCMHANDLEDATA *VBGLHGCMHANDLE;
 
@@ -382 +393 @@
  * @return VBox status code.
  */
-DECLR0VBGL(int) VbglR0HGCMCallRaw(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL*pData, uint32_t cbData);
+DECLR0VBGL(int) VbglR0HGCMCallRaw(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
 
 /**
@@ -394 +405 @@
  *         or the HGCM status code (pData->Hdr.rc).
  */
-DECLR0VBGL(int) VbglR0HGCMCall(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL*pData, uint32_t cbData);
+DECLR0VBGL(int) VbglR0HGCMCall(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
 
 /**
@@ -406 +417 @@
  * @return VBox status code.
  */
-DECLR0VBGL(int) VbglR0HGCMCallUserDataRaw(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL*pData, uint32_t cbData);
+DECLR0VBGL(int) VbglR0HGCMCallUserDataRaw(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
+
+/**
+ * Call to a service, w/o any repacking and buffer locking in VBoxGuest,
+ * returning the only request related status code (not HGCM).
+ *
+ * The driver only submits the request and waits for completion, nothing else.
+ *
+ * @param   hHandle     The connection handle.
+ * @param   pCallReq    The call request.  Will be passed directly to the host.
+ * @param   cbCallReq   The size of the whole call request.
+ *
+ * @return VBox status code.
+ *
+ * @remarks The result of the HGCM call is found in
+ *          @a pCallReq->HgcmCallReq.header.result on a successful return.  The
+ *          @a pCallReq->Hdr.rc and @a pCallReq->HgcmCallReq.header.header.rc
+ *          fields are the same as the return value and can safely be ignored.
+ */
+DECLR0VBGL(int) VbglR0HGCMFastCall(VBGLHGCMHANDLE hHandle, struct VBGLIOCIDCHGCMFASTCALL *pCallReq, uint32_t cbCallReq);
 
 /** @} */