Changeset 30468 in vbox

Timestamp:

Jun 28, 2010 1:58:04 PM (15 years ago)

Author:

vboxsync

Message:

IPRT:

• Corrected RTSGBUF member names.
• Corrected RTSgBufInit parameter names.
• Don't use AssertReturnVoid (and variations) in RTSgBuf* as there the result is that we use uninitialized structures. Better to crash and burn in IPRT then.
• Added RTSocketSgWriteL/LV and RTTcpSgWriteL/LV for lazy guys like me.
• RTSocketSgWrite doesn't need a do {} while (0).

Location:

trunk

Files:

• include/iprt/sg.h (modified) (2 diffs)
• include/iprt/socket.h (modified) (1 diff)
• include/iprt/tcp.h (modified) (1 diff)
• src/VBox/Devices/Storage/DrvVD.cpp (modified) (1 diff)
• src/VBox/Runtime/common/misc/sg.cpp (modified) (5 diffs)
• src/VBox/Runtime/r3/socket.cpp (modified) (3 diffs)
• src/VBox/Runtime/r3/tcp.cpp (modified) (1 diff)

trunk/include/iprt/sg.h

@@ -56 +56 @@
 {
     /** Pointer to the scatter/gather array. */
-    PCRTSGSEG pcaSeg;
+    PCRTSGSEG paSegs;
     /** Number of segments. */
-    unsigned  cSeg;
+    unsigned  cSegs;
     /** Current segment we are in. */
     unsigned  idxSeg;
     /** Pointer to the current segment start. */
-    void     *pvSegCurr;
+    void     *pvSegCur;
     /** Number of bytes left in the current buffer. */
     size_t    cbSegLeft;
@@ -78 +78 @@
  * @returns nothing.
  * @param   pSgBuf    Pointer to the S/G buffer to initialize.
- * @param   pcaSeg    Pointer to the start of the segment array.
- * @param   cSeg      Number of segments in the array.
- */
-RTDECL(void) RTSgBufInit(PRTSGBUF pSgBuf, PCRTSGSEG pcaSeg, unsigned cSeg);
+ * @param   paSegs    Pointer to the start of the segment array.
+ * @param   cSegs     Number of segments in the array.
+ */
+RTDECL(void) RTSgBufInit(PRTSGBUF pSgBuf, PCRTSGSEG paSegs, unsigned cSegs);
 
 /**

trunk/include/iprt/socket.h

@@ -188 +188 @@
 RTDECL(int) RTSocketSgWrite(RTSOCKET hSocket, PCRTSGBUF pSgBuf);
 
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
+ * for lazy coders.  The "L" in the function name is short for "list" just like
+ * in the execl libc API.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          ellipsis.
+ * @param   ...             Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t).  Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTDECL(int) RTSocketSgWriteL(RTSOCKET hSocket, size_t cSegs, ...);
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
+ * for lazy coders.  The "L" in the function name is short for "list" just like
+ * in the execl libc API.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          argument list.
+ * @param   va              Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t).  Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTDECL(int) RTSocketSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va);
+
 /** @} */
 RT_C_DECLS_END

trunk/include/iprt/tcp.h

@@ -292 +292 @@
 RTR3DECL(int)  RTTcpSgWrite(RTSOCKET Sock, PCRTSGBUF pSgBuf);
 
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
+ * for lazy coders.  The "L" in the function name is short for "list" just like
+ * in the execl libc API.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          ellipsis.
+ * @param   ...             Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t).  Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTR3DECL(int) RTTcpSgWriteL(RTSOCKET hSocket, size_t cSegs, ...);
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
+ * for lazy coders.  The "L" in the function name is short for "list" just like
+ * in the execl libc API.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          argument list.
+ * @param   va              Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t). Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTR3DECL(int) RTTcpSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va);
+
 /** @} */
 RT_C_DECLS_END

trunk/src/VBox/Devices/Storage/DrvVD.cpp

@@ -740 +740 @@
     /* This is an extremely crude emulation, however it's good enough
      * for our iSCSI code. INIP has no sendmsg(). */
-    for (unsigned i = 0; i < pSgBuf->cSeg; i++)
-    {
-        rc = drvvdINIPWrite(Sock, pSgBuf->pcaSeg[i].pvSeg,
-                            pSgBuf->pcaSeg[i].cbSeg);
+    for (unsigned i = 0; i < pSgBuf->cSegs; i++)
+    {
+        rc = drvvdINIPWrite(Sock, pSgBuf->paSegs[i].pvSeg,
+                            pSgBuf->paSegs[i].cbSeg);
         if (RT_FAILURE(rc))
             break;

trunk/src/VBox/Runtime/common/misc/sg.cpp

@@ -37 +37 @@
 {
     size_t cbData = RT_MIN(*pcbData, pSgBuf->cbSegLeft);
-    void *pvBuf = pSgBuf->pvSegCurr;
+    void *pvBuf = pSgBuf->pvSegCur;
 
     pSgBuf->cbSegLeft -= cbData;
@@ -46 +46 @@
         pSgBuf->idxSeg++;
 
-        if (RT_UNLIKELY(pSgBuf->idxSeg == pSgBuf->cSeg))
+        if (RT_UNLIKELY(pSgBuf->idxSeg == pSgBuf->cSegs))
         {
             pSgBuf->cbSegLeft = 0;
-            pSgBuf->pvSegCurr = NULL;
+            pSgBuf->pvSegCur  = NULL;
         }
         else
         {
-            pSgBuf->pvSegCurr = pSgBuf->pcaSeg[pSgBuf->idxSeg].pvSeg;
-            pSgBuf->cbSegLeft = pSgBuf->pcaSeg[pSgBuf->idxSeg].cbSeg;
+            pSgBuf->pvSegCur  = pSgBuf->paSegs[pSgBuf->idxSeg].pvSeg;
+            pSgBuf->cbSegLeft = pSgBuf->paSegs[pSgBuf->idxSeg].cbSeg;
         }
 
@@ -60 +60 @@
     }
     else
-        pSgBuf->pvSegCurr = (void *)((uintptr_t)pSgBuf->pvSegCurr + cbData);
+        pSgBuf->pvSegCur = (uint8_t *)pSgBuf->pvSegCur + cbData;
 
     return pvBuf;
@@ -66 +66 @@
 
 
-RTDECL(void) RTSgBufInit(PRTSGBUF pSgBuf, PCRTSGSEG pcaSeg, unsigned cSeg)
+RTDECL(void) RTSgBufInit(PRTSGBUF pSgBuf, PCRTSGSEG paSegs, unsigned cSegs)
+{
+    AssertPtr(pSgBuf);
+    AssertPtr(paSegs);
+    Assert(cSegs > 0);
+
+    pSgBuf->paSegs    = paSegs;
+    pSgBuf->cSegs     = cSegs;
+    pSgBuf->idxSeg    = 0;
+    pSgBuf->pvSegCur  = paSegs[0].pvSeg;
+    pSgBuf->cbSegLeft = paSegs[0].cbSeg;
+}
+
+
+RTDECL(void) RTSgBufReset(PRTSGBUF pSgBuf)
 {
     AssertPtrReturnVoid(pSgBuf);
-    AssertPtrReturnVoid(pcaSeg);
-    AssertReturnVoid(cSeg > 0);
-
-    pSgBuf->pcaSeg    = pcaSeg;
-    pSgBuf->cSeg      = cSeg;
+
     pSgBuf->idxSeg    = 0;
-    pSgBuf->pvSegCurr = pcaSeg[0].pvSeg;
-    pSgBuf->cbSegLeft = pcaSeg[0].cbSeg;
-}
-
-
-RTDECL(void) RTSgBufReset(PRTSGBUF pSgBuf)
-{
-    AssertPtrReturnVoid(pSgBuf);
-
-    pSgBuf->idxSeg    = 0;
-    pSgBuf->pvSegCurr = pSgBuf->pcaSeg[0].pvSeg;
-    pSgBuf->cbSegLeft = pSgBuf->pcaSeg[0].cbSeg;
+    pSgBuf->pvSegCur  = pSgBuf->paSegs[0].pvSeg;
+    pSgBuf->cbSegLeft = pSgBuf->paSegs[0].cbSeg;
 }
 
@@ -92 +92 @@
 RTDECL(void) RTSgBufClone(PRTSGBUF pSgBufTo, PCRTSGBUF pSgBufFrom)
 {
-    AssertPtrReturnVoid(pSgBufTo);
-    AssertPtrReturnVoid(pSgBufFrom);
-
-    pSgBufTo->pcaSeg    = pSgBufFrom->pcaSeg;
-    pSgBufTo->cSeg      = pSgBufFrom->cSeg;
+    AssertPtr(pSgBufTo);
+    AssertPtr(pSgBufFrom);
+
+    pSgBufTo->paSegs    = pSgBufFrom->paSegs;
+    pSgBufTo->cSegs     = pSgBufFrom->cSegs;
     pSgBufTo->idxSeg    = pSgBufFrom->idxSeg;
-    pSgBufTo->pvSegCurr = pSgBufFrom->pvSegCurr;
+    pSgBufTo->pvSegCur  = pSgBufFrom->pvSegCur;
     pSgBufTo->cbSegLeft = pSgBufFrom->cbSegLeft;
 }

trunk/src/VBox/Runtime/r3/socket.cpp

@@ -52 +52 @@
 #include <iprt/socket.h>
 
+#include <iprt/alloca.h>
 #include <iprt/asm.h>
 #include <iprt/assert.h>
@@ -586 +587 @@
     AssertReturn(pThis->u32Magic == RTSOCKET_MAGIC, VERR_INVALID_HANDLE);
     AssertPtrReturn(pSgBuf, VERR_INVALID_PARAMETER);
-    AssertReturn(pSgBuf->cSeg > 0, VERR_INVALID_PARAMETER);
+    AssertReturn(pSgBuf->cSegs > 0, VERR_INVALID_PARAMETER);
     AssertReturn(rtSocketTryLock(pThis), VERR_CONCURRENT_ACCESS);
 
@@ -592 +593 @@
      * Construct message descriptor (translate pSgBuf) and send it.
      */
-    int rc = VINF_SUCCESS;
-    do
-    {
-#ifdef RT_OS_WINDOWS
-        AssertCompileSize(WSABUF, sizeof(RTSGSEG));
-        AssertCompileMemberSize(WSABUF, buf, RT_SIZEOFMEMB(RTSGSEG, pvSeg));
-
-        LPWSABUF paMsg = (LPWSABUF)RTMemTmpAllocZ(pSgBuf->cSeg * sizeof(WSABUF));
-        AssertPtrBreakStmt(paMsg, rc = VERR_NO_MEMORY);
-        for (unsigned i = 0; i < pSgBuf->cSeg; i++)
+    int rc = VERR_NO_TMP_MEMORY;
+#ifdef RT_OS_WINDOWS
+    AssertCompileSize(WSABUF, sizeof(RTSGSEG));
+    AssertCompileMemberSize(WSABUF, buf, RT_SIZEOFMEMB(RTSGSEG, pvSeg));
+
+    LPWSABUF paMsg = (LPWSABUF)RTMemTmpAllocZ(pSgBuf->cSegs * sizeof(WSABUF));
+    if (paMsg)
+    {
+        for (unsigned i = 0; i < pSgBuf->cSegs; i++)
         {
-            paMsg[i].buf = (char *)pSgBuf->pcaSeg[i].pvSeg;
-            paMsg[i].len = (u_long)pSgBuf->pcaSeg[i].cbSeg;
+            paMsg[i].buf = (char *)pSgBuf->paSegs[i].pvSeg;
+            paMsg[i].len = (u_long)pSgBuf->paSegs[i].cbSeg;
         }
 
         DWORD dwSent;
-        int hrc = WSASend(pThis->hNative, paMsg, pSgBuf->cSeg, &dwSent,
+        int hrc = WSASend(pThis->hNative, paMsg, pSgBuf->cSegs, &dwSent,
                           MSG_NOSIGNAL, NULL, NULL);
-        ssize_t cbWritten;
         if (!hrc)
+            rc = VINF_SUCCESS;
+/** @todo check for incomplete writes */
+        else
+            rc = rtSocketError();
+
+        RTMemTmpFree(paMsg);
+    }
+
+#else  /* !RT_OS_WINDOWS */
+    AssertCompileSize(struct iovec, sizeof(RTSGSEG));
+    AssertCompileMemberSize(struct iovec, iov_base, RT_SIZEOFMEMB(RTSGSEG, pvSeg));
+    AssertCompileMemberSize(struct iovec, iov_len,  RT_SIZEOFMEMB(RTSGSEG, cbSeg));
+
+    struct iovec *paMsg = (struct iovec *)RTMemTmpAllocZ(pSgBuf->cSegs * sizeof(struct iovec));
+    if (paMsg)
+    {
+        for (unsigned i = 0; i < pSgBuf->cSegs; i++)
         {
-            /* avoid overflowing ssize_t, the exact value isn't important */
-            cbWritten = RT_MIN(dwSent, INT_MAX);
+            paMsg[i].iov_base = pSgBuf->paSegs[i].pvSeg;
+            paMsg[i].iov_len  = pSgBuf->paSegs[i].cbSeg;
         }
-        else
-            cbWritten = -1;
-#else
-        AssertCompileSize(struct iovec, sizeof(RTSGSEG));
-        AssertCompileMemberSize(struct iovec, iov_base, RT_SIZEOFMEMB(RTSGSEG, pvSeg));
-        AssertCompileMemberSize(struct iovec, iov_len, RT_SIZEOFMEMB(RTSGSEG, cbSeg));
-
-        struct iovec *paMsg = (struct iovec *)RTMemTmpAllocZ(pSgBuf->cSeg * sizeof(struct iovec));
-        AssertPtrBreakStmt(paMsg, rc = VERR_NO_MEMORY);
-        for (unsigned i = 0; i < pSgBuf->cSeg; i++)
-        {
-            paMsg[i].iov_base = pSgBuf->pcaSeg[i].pvSeg;
-            paMsg[i].iov_len = pSgBuf->pcaSeg[i].cbSeg;
-        }
 
         struct msghdr msgHdr;
-        memset(&msgHdr, '\0', sizeof(msgHdr));
-        msgHdr.msg_iov = paMsg;
-        msgHdr.msg_iovlen = pSgBuf->cSeg;
+        RT_ZERO(msgHdr);
+        msgHdr.msg_iov    = paMsg;
+        msgHdr.msg_iovlen = pSgBuf->cSegs;
         ssize_t cbWritten = sendmsg(pThis->hNative, &msgHdr, MSG_NOSIGNAL);
-#endif
-
-        RTMemTmpFree(paMsg);
         if (RT_LIKELY(cbWritten >= 0))
             rc = VINF_SUCCESS;
+/** @todo check for incomplete writes */
         else
             rc = rtSocketError();
-    } while (0);
+
+        RTMemTmpFree(paMsg);
+    }
+#endif /* !RT_OS_WINDOWS */
 
     rtSocketUnlock(pThis);
     return rc;
+}
+
+
+RTDECL(int) RTSocketSgWriteL(RTSOCKET hSocket, size_t cSegs, ...)
+{
+    va_list va;
+    va_start(va, cSegs);
+    int rc = RTSocketSgWriteLV(hSocket, cSegs, va);
+    va_end(va);
+    return rc;
+}
+
+
+RTDECL(int) RTSocketSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va)
+{
+    /*
+     * Set up a S/G segment array + buffer on the stack and pass it
+     * on to RTSocketSgWrite.
+     */
+    Assert(cSegs <= 16);
+    PRTSGSEG paSegs = (PRTSGSEG)alloca(cSegs * sizeof(RTSGSEG));
+    AssertReturn(paSegs, VERR_NO_TMP_MEMORY);
+    for (size_t i = 0; i < cSegs; i++)
+    {
+        paSegs[i].pvSeg = va_arg(va, void *);
+        paSegs[i].cbSeg = va_arg(va, size_t);
+    }
+
+    RTSGBUF SgBuf;
+    RTSgBufInit(&SgBuf, paSegs, cSegs);
+    return RTSocketSgWrite(hSocket, &SgBuf);
 }
 

trunk/src/VBox/Runtime/r3/tcp.cpp

@@ -1020 +1020 @@
 }
 
+
+RTR3DECL(int) RTTcpSgWriteL(RTSOCKET hSocket, size_t cSegs, ...)
+{
+    va_list va;
+    va_start(va, cSegs);
+    int rc = RTSocketSgWriteLV(hSocket, cSegs, va);
+    va_end(va);
+    return rc;
+}
+
+
+RTR3DECL(int) RTTcpSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va)
+{
+    return RTSocketSgWriteLV(hSocket, cSegs, va);
+}
+