Changeset 89500 in vbox for trunk/include/VBox/vmm

Timestamp:

Jun 4, 2021 10:30:47 AM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

144857

Message:

Audio: Changed PDMAUDIOHOSTDEV::szName into a pszName so we don't have to truncate anything. Made PDMAudioHostDevAlloc capable of allocating both pszName and pszId as part of the device allocation. bugref:9890

Location:

trunk/include/VBox/vmm

Files:

• pdmaudiohostenuminline.h (modified) (7 diffs)
• pdmaudioifs.h (modified) (5 diffs)

trunk/include/VBox/vmm/pdmaudiohostenuminline.h

@@ -62 +62 @@
  *                  the PDMAUDIOHOSTDEV structure and appends additional data
  *                  after it in its private structure.
- */
-DECLINLINE(PPDMAUDIOHOSTDEV) PDMAudioHostDevAlloc(size_t cb)
+ * @param   cbName  The number of bytes to allocate for the name field
+ *                  (including the terminator). Pass zero if RTStrAlloc and
+ *                  friends will be used.
+ * @param   cbId    The number of bytes to allocate for the ID field. Pass
+ *                  zero if RTStrAlloc and friends will be used.
+ */
+DECLINLINE(PPDMAUDIOHOSTDEV) PDMAudioHostDevAlloc(size_t cb, size_t cbName, size_t cbId)
 {
     AssertReturn(cb >= sizeof(PDMAUDIOHOSTDEV), NULL);
     AssertReturn(cb < _4M, NULL);
-
-    PPDMAUDIOHOSTDEV pDev = (PPDMAUDIOHOSTDEV)RTMemAllocZ(RT_ALIGN_Z(cb, 64));
+    AssertReturn(cbName < _4K, NULL);
+    AssertReturn(cbId < _16K, NULL);
+
+    PPDMAUDIOHOSTDEV pDev = (PPDMAUDIOHOSTDEV)RTMemAllocZ(RT_ALIGN_Z(cb + cbName + cbId, 64));
     if (pDev)
     {
-        pDev->uMagic = PDMAUDIOHOSTDEV_MAGIC;
-        pDev->cbSelf = (uint32_t)cb;
+        pDev->uMagic  = PDMAUDIOHOSTDEV_MAGIC;
+        pDev->cbSelf  = (uint32_t)cb;
         RTListInit(&pDev->ListEntry);
-
-        //pDev->cMaxInputChannels  = 0;
-        //pDev->cMaxOutputChannels = 0;
+        if (cbName)
+            pDev->pszName = (char *)pDev + cb;
+        if (cbId)
+            pDev->pszId   = (char *)pDev + cb + cbName;
     }
     return pDev;
@@ -94 +102 @@
         pDev->cbSelf = 0;
 
+        if (pDev->fFlags & PDMAUDIOHOSTDEV_F_NAME_ALLOC)
+        {
+            RTStrFree(pDev->pszName);
+            pDev->pszName = NULL;
+        }
+
         if (pDev->fFlags & PDMAUDIOHOSTDEV_F_ID_ALLOC)
         {
@@ -120 +134 @@
     AssertReturn(cbToDup >= sizeof(*pDev), NULL);
 
-    PPDMAUDIOHOSTDEV pDevDup = PDMAudioHostDevAlloc(cbToDup);
+    PPDMAUDIOHOSTDEV pDevDup = PDMAudioHostDevAlloc(cbToDup, 0, 0);
     if (pDevDup)
     {
@@ -126 +140 @@
         RTListInit(&pDevDup->ListEntry);
         pDevDup->cbSelf = cbToDup;
+
+        if (pDev->pszName)
+        {
+            uintptr_t off;
+            if (   (pDevDup->fFlags & PDMAUDIOHOSTDEV_F_NAME_ALLOC)
+                || (off = (uintptr_t)pDev->pszName - (uintptr_t)pDev) >= pDevDup->cbSelf)
+            {
+                pDevDup->fFlags |= PDMAUDIOHOSTDEV_F_NAME_ALLOC;
+                pDevDup->pszName = RTStrDup(pDev->pszName);
+                AssertReturnStmt(pDevDup->pszName, PDMAudioHostDevFree(pDevDup), NULL);
+            }
+            else
+                pDevDup->pszName = (char *)pDevDup + off;
+        }
+
         if (pDev->pszId)
         {
-            pDevDup->fFlags |= PDMAUDIOHOSTDEV_F_ID_ALLOC;
-            pDevDup->pszId   = RTStrDup(pDev->pszId);
-            AssertReturnStmt(pDevDup->pszId, RTMemFree(pDevDup), NULL);
+            uintptr_t off;
+            if (   (pDevDup->fFlags & PDMAUDIOHOSTDEV_F_ID_ALLOC)
+                || (off = (uintptr_t)pDev->pszId - (uintptr_t)pDev) >= pDevDup->cbSelf)
+            {
+                pDevDup->fFlags |= PDMAUDIOHOSTDEV_F_ID_ALLOC;
+                pDevDup->pszId   = RTStrDup(pDev->pszId);
+                AssertReturnStmt(pDevDup->pszId, PDMAudioHostDevFree(pDevDup), NULL);
+            }
+            else
+                pDevDup->pszId = (char *)pDevDup + off;
         }
     }
@@ -334 +370 @@
 /** The max string length for all PDMAUDIOHOSTDEV_F_XXX.
  * @sa PDMAudioHostDevFlagsToString */
-#define PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN sizeof("DEFAULT_OUT DEFAULT_IN HOTPLUG BUGGY IGNORE LOCKED DEAD ID_ALLOC NO_DUP ")
+#define PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN sizeof("DEFAULT_OUT DEFAULT_IN HOTPLUG BUGGY IGNORE LOCKED DEAD NAME_ALLOC ID_ALLOC NO_DUP ")
 
 /**
@@ -356 +392 @@
         { RT_STR_TUPLE("LOCKED "),      PDMAUDIOHOSTDEV_F_LOCKED  },
         { RT_STR_TUPLE("DEAD "),        PDMAUDIOHOSTDEV_F_DEAD    },
-        { RT_STR_TUPLE("ID_ALLOC "),    PDMAUDIOHOSTDEV_F_ID_ALLOC  },
+        { RT_STR_TUPLE("NAME_ALLOC "),  PDMAUDIOHOSTDEV_F_NAME_ALLOC },
+        { RT_STR_TUPLE("ID_ALLOC "),    PDMAUDIOHOSTDEV_F_ID_ALLOC },
         { RT_STR_TUPLE("NO_DUP "),      PDMAUDIOHOSTDEV_F_NO_DUP  },
     };
@@ -398 +435 @@
         {
             char szFlags[PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN];
-            LogFunc(("Device '%s':\n", pDev->szName));
+            LogFunc(("Device '%s':\n", pDev->pszName));
+            LogFunc(("  ID              = %s\n",             pDev->pszId ? pDev->pszId : "<none>"));
             LogFunc(("  Usage           = %s\n",             PDMAudioDirGetName(pDev->enmUsage)));
             LogFunc(("  Flags           = %s\n",             PDMAudioHostDevFlagsToString(szFlags, pDev->fFlags)));

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -291 +291 @@
 /** The device is present but not in an alive state (dead). */
 #define PDMAUDIOHOSTDEV_F_DEAD              RT_BIT_32(6)
+/** Set if the PDMAUDIOHOSTDEV::pszName is allocated. */
+#define PDMAUDIOHOSTDEV_F_NAME_ALLOC        RT_BIT_32(29)
 /** Set if the PDMAUDIOHOSTDEV::pszId is allocated. */
 #define PDMAUDIOHOSTDEV_F_ID_ALLOC          RT_BIT_32(30)
@@ -342 +344 @@
     /** Maximum number of output audio channels the device supports. */
     uint8_t             cMaxOutputChannels;
-    uint8_t             abAlignment[ARCH_BITS == 32 ? 2 + 12 : 2];
+    uint8_t             abAlignment[ARCH_BITS == 32 ? 2 + 8 : 2 + 8];
     /** Backend specific device identifier, can be NULL, used to select device.
      * This can either point into some non-public part of this structure or to a
@@ -349 +351 @@
      * @sa PDMIHOSTAUDIO::pfnSetDevice */
     char               *pszId;
-    /** Friendly name of the device, if any. Could be truncated. */
-    char                szName[64];
+    /** The friendly device name. */
+    char               *pszName;
 } PDMAUDIOHOSTDEV;
 AssertCompileSizeAlignment(PDMAUDIOHOSTDEV, 16);
@@ -359 +361 @@
 
 /** Magic value for PDMAUDIOHOSTDEV.  */
-#define PDMAUDIOHOSTDEV_MAGIC       PDM_VERSION_MAKE(0xa0d0, 2, 0)
+#define PDMAUDIOHOSTDEV_MAGIC       PDM_VERSION_MAKE(0xa0d0, 3, 0)
 
 
@@ -1387 +1389 @@
 
 /** PDMIHOSTAUDIO interface ID. */
-#define PDMIHOSTAUDIO_IID                           "147dedd7-cac1-469b-b545-335dbe90abf6"
+#define PDMIHOSTAUDIO_IID                           "2d57627f-6f47-4669-a2fa-93a5f1cb6e51"