Changeset 28025 in vbox for trunk/include/VBox

Timestamp:

Apr 7, 2010 6:37:43 AM (15 years ago)

Author:

vboxsync

Message:

intnet, VBoxNet*, network device & drivers: GSO preps.

Location:

trunk/include/VBox

Files:

• intnet.h (modified) (11 diffs)
• intnetinline.h (modified) (13 diffs)
• pdmnetinline.h (added)
• types.h (modified) (3 diffs)

trunk/include/VBox/intnet.h

@@ -4 +4 @@
 
 /*
- * Copyright (C) 2006-2007 Sun Microsystems, Inc.
+ * Copyright (C) 2006-2010 Sun Microsystems, Inc.
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -197 +197 @@
 
 /**
- * The packet header.
+ * The frame header.
  *
  * The header is intentionally 8 bytes long. It will always
@@ -208 +208 @@
 {
     /** Header type. This is currently serving as a magic, it
-     * can be extended later to encode special command packets and stuff. */
+     * can be extended later to encode special command frames and stuff. */
     uint16_t        u16Type;
     /** The size of the frame. */
@@ -219 +219 @@
 AssertCompileSize(INTNETHDR, 8);
 AssertCompileSizeAlignment(INTNETBUF, sizeof(INTNETHDR));
-/** Pointer to a packet header.*/
+/** Pointer to a frame header.*/
 typedef INTNETHDR *PINTNETHDR;
-/** Pointer to a const packet header.*/
+/** Pointer to a const frame header.*/
 typedef INTNETHDR const *PCINTNETHDR;
 
-/** The alignment of a packet header. */
+/** The alignment of a frame header. */
 #define INTNETHDR_ALIGNMENT         sizeof(INTNETHDR)
 AssertCompile(sizeof(INTNETHDR) == INTNETHDR_ALIGNMENT);
 AssertCompile(INTNETHDR_ALIGNMENT <= INTNETRINGBUF_ALIGNMENT);
 
-/** INTNETHDR::u16Type value for normal frames. */
+/** @name Frame types (INTNETHDR::u16Type).
+ * @{ */
+/** Normal frames. */
 #define INTNETHDR_TYPE_FRAME        0x2442
-/** INTNETHDR::u16Type value for padding frames. */
+/** Padding frames. */
 #define INTNETHDR_TYPE_PADDING      0x3553
+/** Generic segment offload frames.
+ * The frame starts with a PDMNETWORKGSO structure which is followed by the
+ * header template and data. */
+#define INTNETHDR_TYPE_GSO          0x4664
+AssertCompileSize(PDMNETWORKGSO, 8);
+/** @}  */
 
 /**
@@ -242 +250 @@
         AssertPtr(pHdr); \
         Assert(RT_ALIGN_PT(pHdr, INTNETHDR_ALIGNMENT, INTNETHDR *) == pHdr); \
-        Assert((pHdr)->u16Type == INTNETHDR_TYPE_FRAME || (pHdr)->u16Type == INTNETHDR_TYPE_PADDING); \
+        Assert(   (pHdr)->u16Type == INTNETHDR_TYPE_FRAME \
+               || (pHdr)->u16Type == INTNETHDR_TYPE_GSO \
+               || (pHdr)->u16Type == INTNETHDR_TYPE_PADDING); \
         { \
             uintptr_t const offHdr   = (uintptr_t)pHdr - (uintptr_t)pRingBuf; \
@@ -269 +279 @@
     uint32_t        cb;
 } INTNETSEG;
-/** Pointer to a internal networking packet segment. */
+/** Pointer to a internal networking frame segment. */
 typedef INTNETSEG *PINTNETSEG;
-/** Pointer to a internal networking packet segment. */
+/** Pointer to a internal networking frame segment. */
 typedef INTNETSEG const *PCINTNETSEG;
 
@@ -283 +293 @@
 {
     /** Owner data, don't touch! */
-    void           *pvOwnerData;
+    void               *pvOwnerData;
     /** User data. */
-    void           *pvUserData;
+    void               *pvUserData;
     /** User data 2 in case anyone needs it. */
-    void           *pvUserData2;
+    void               *pvUserData2;
+    /** GSO context information, set the type to invalid if not relevant. */
+    PDMNETWORKGSO       GsoCtx;
     /** The total length of the scatter gather list. */
-    uint32_t        cbTotal;
+    uint32_t            cbTotal;
     /** The number of users (references).
      * This is used by the SGRelease code to decide when it can be freed. */
-    uint16_t volatile cUsers;
+    uint16_t volatile   cUsers;
     /** Flags, see INTNETSG_FLAGS_* */
-    uint16_t volatile fFlags;
+    uint16_t volatile   fFlags;
+#if ARCH_BITS == 64
+    /** Alignment padding. */
+    uint16_t            uPadding;
+#endif
     /** The number of segments allocated. */
-    uint16_t        cSegsAlloc;
+    uint16_t            cSegsAlloc;
     /** The number of segments actually used. */
-    uint16_t        cSegsUsed;
+    uint16_t            cSegsUsed;
     /** Variable sized list of segments. */
-    INTNETSEG       aSegs[1];
+    INTNETSEG           aSegs[1];
 } INTNETSG;
+AssertCompileSizeAlignment(INTNETSG, 8);
 /** Pointer to a scatter / gather list. */
 typedef INTNETSG *PINTNETSG;
@@ -326 +343 @@
 
 
-/** @name Direction (packet source or destination)
+/** @name Direction (frame source or destination)
  * @{ */
 /** To/From the wire. */
@@ -509 +526 @@
      *
      * This method must be called before disconnecting and releasing the
-     * object in order to prevent racing incoming/outgoing packets and
-     * device enabling/disabling.
+     * object in order to prevent racing incoming/outgoing frames and device
+     * enabling/disabling.
      *
      * @returns IPRT status code (see RTSemEventWait).
@@ -573 +590 @@
      * Transmit a frame.
      *
-     * @return  VBox status code. Error generally means we'll drop the packet.
+     * @return  VBox status code. Error generally means we'll drop the frame.
      * @param   pIfPort     Pointer to this structure.
      * @param   pSG         Pointer to the (scatter /) gather structure for the frame.
@@ -997 +1014 @@
  * @param   hIf         The interface handle.
  * @param   pSession    The caller's session.
- * @param   pvFrame     Pointer to the frame. Optional, please don't use.
- * @param   cbFrame     Size of the frame. Optional, please don't use.
- */
-INTNETR0DECL(int) INTNETR0IfSend(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, const void *pvFrame, unsigned cbFrame);
+ */
+INTNETR0DECL(int) INTNETR0IfSend(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession);
 
 /**

trunk/include/VBox/intnetinline.h

@@ -4 +4 @@
  *
  * This is all inlined because it's too tedious to create 2-3 libraries to
- * contain it all.  Requires C++ since variables and code is mixed as usual.
+ * contain it all.  Large parts of this header is only accessible from C++
+ * sources because of mixed code and variables.
  */
 
@@ -35 +36 @@
 #define ___VBox_intnetinline_h
 
-#ifndef __cplusplus
-# error "C++ only header."
-#endif
-
 #include <VBox/intnet.h>
 #include <iprt/string.h>
@@ -46 +43 @@
 
 
+
+/**
+ * Valid internal networking frame type.
+ *
+ * @returns  true / false.
+ * @param   u16Type             The frame type to check.
+ */
+DECLINLINE(bool) INETNETIsValidFrameType(uint16_t u16Type)
+{
+    if (RT_LIKELY(   u16Type == INTNETHDR_TYPE_FRAME
+                  || u16Type == INTNETHDR_TYPE_GSO
+                  || u16Type == INTNETHDR_TYPE_PADDING))
+        return true;
+    return false;
+}
+
+
+/**
+ * Partly initializes a scatter / gather buffer, leaving the segments to the
+ * caller.
+ *
+ * @returns Pointer to the start of the frame.
+ * @param   pSG         Pointer to the scatter / gather structure.
+ * @param   cbTotal     The total size.
+ * @param   cSegs       The number of segments.
+ * @param   cSegsUsed   The number of used segments.
+ */
+DECLINLINE(void) INTNETSgInitTempSegs(PINTNETSG pSG, uint32_t cbTotal, unsigned cSegs, unsigned cSegsUsed)
+{
+    pSG->pvOwnerData    = NULL;
+    pSG->pvUserData     = NULL;
+    pSG->pvUserData2    = NULL;
+    pSG->cbTotal        = cbTotal;
+    pSG->cUsers         = 1;
+    pSG->fFlags         = INTNETSG_FLAGS_TEMP;
+    pSG->GsoCtx.u8Type  = (uint8_t)PDMNETWORKGSOTYPE_INVALID;
+    pSG->GsoCtx.cbHdrs  = 0;
+    pSG->GsoCtx.cbMaxSeg= 0;
+    pSG->GsoCtx.offHdr1 = 0;
+    pSG->GsoCtx.cbHdr1  = 0;
+    pSG->GsoCtx.offHdr2 = 0;
+    pSG->GsoCtx.cbHdr2  = 0;
+#if ARCH_BITS == 64
+    pSG->uPadding       = 0;
+#endif
+    pSG->cSegsAlloc     = (uint16_t)cSegs;
+    Assert(pSG->cSegsAlloc == cSegs);
+    pSG->cSegsUsed      = (uint16_t)cSegsUsed;
+    Assert(pSG->cSegsUsed == cSegsUsed);
+    Assert(cSegs >= cSegsUsed);
+}
+
+
+/**
+ * Partly initializes a scatter / gather buffer w/ GSO, leaving the segments to
+ * the caller.
+ *
+ * @returns Pointer to the start of the frame.
+ * @param   pSG         Pointer to the scatter / gather structure.
+ * @param   cbTotal     The total size.
+ * @param   cSegs       The number of segments.
+ * @param   cSegsUsed   The number of used segments.
+ * @param   pGso        The GSO context.
+ */
+DECLINLINE(void) INTNETSgInitTempSegsGso(PINTNETSG pSG, uint32_t cbTotal, unsigned cSegs,
+                                         unsigned cSegsUsed, PCPDMNETWORKGSO pGso)
+{
+    pSG->pvOwnerData    = NULL;
+    pSG->pvUserData     = NULL;
+    pSG->pvUserData2    = NULL;
+    pSG->cbTotal        = cbTotal;
+    pSG->cUsers         = 1;
+    pSG->fFlags         = INTNETSG_FLAGS_TEMP;
+    pSG->GsoCtx.u8Type  = pGso->u8Type;
+    pSG->GsoCtx.cbHdrs  = pGso->cbHdrs;
+    pSG->GsoCtx.cbMaxSeg= pGso->cbMaxSeg;
+    pSG->GsoCtx.offHdr1 = pGso->offHdr1;
+    pSG->GsoCtx.cbHdr1  = pGso->cbHdr1;
+    pSG->GsoCtx.offHdr2 = pGso->offHdr2;
+    pSG->GsoCtx.cbHdr2  = pGso->cbHdr2;
+#if ARCH_BITS == 64
+    pSG->uPadding       = 0;
+#endif
+    pSG->cSegsAlloc     = (uint16_t)cSegs;
+    Assert(pSG->cSegsAlloc == cSegs);
+    pSG->cSegsUsed      = (uint16_t)cSegsUsed;
+    Assert(pSG->cSegsUsed == cSegsUsed);
+    Assert(cSegs >= cSegsUsed);
+}
+
+
+
+/**
+ * Initializes a scatter / gather buffer describing a simple linear buffer.
+ *
+ * @returns Pointer to the start of the frame.
+ * @param   pSG         Pointer to the scatter / gather structure.
+ * @param   pvFrame     Pointer to the frame
+ * @param   cbFrame     The size of the frame.
+ */
+DECLINLINE(void) INTNETSgInitTemp(PINTNETSG pSG, void *pvFrame, uint32_t cbFrame)
+{
+    INTNETSgInitTempSegs(pSG, cbFrame, 1, 1);
+    pSG->aSegs[0].Phys  = NIL_RTHCPHYS;
+    pSG->aSegs[0].pv    = pvFrame;
+    pSG->aSegs[0].cb    = cbFrame;
+}
+
+/**
+ * Initializes a scatter / gather buffer describing a simple linear buffer.
+ *
+ * @returns Pointer to the start of the frame.
+ * @param   pSG         Pointer to the scatter / gather structure.
+ * @param   pvFrame     Pointer to the frame
+ * @param   cbFrame     The size of the frame.
+ * @param   pGso        The GSO context.
+ */
+DECLINLINE(void) INTNETSgInitTempGso(PINTNETSG pSG, void *pvFrame, uint32_t cbFrame, PCPDMNETWORKGSO pGso)
+{
+    INTNETSgInitTempSegsGso(pSG, cbFrame, 1, 1, pGso);
+    pSG->aSegs[0].Phys  = NIL_RTHCPHYS;
+    pSG->aSegs[0].pv    = pvFrame;
+    pSG->aSegs[0].cb    = cbFrame;
+}
+
+#ifdef __cplusplus
+
 /**
  * Get the amount of space available for writing.
@@ -120 +244 @@
 #ifdef VBOX_STRICT
     const uintptr_t off = (uintptr_t)pu8 - (uintptr_t)pBuf;
-    Assert(pHdr->u16Type == INTNETHDR_TYPE_FRAME || pHdr->u16Type == INTNETHDR_TYPE_PADDING);
+    Assert(INETNETIsValidFrameType(pHdr->u16Type));
     Assert(off < pBuf->cbBuf);
     Assert(off + pHdr->cbFrame <= pBuf->cbBuf);
@@ -130 +254 @@
 
 /**
+ * Calculates the pointer to the GSO context.
+ *
+ * ASSUMES the frame is a GSO frame.
+ *
+ * The GSO context is immediately followed by the headers and payload.  The size
+ * is INTNETBUF::cbFrame - sizeof(PDMNETWORKGSO).
+ *
+ * @returns Pointer to the GSO context.
+ * @param   pHdr        Pointer to the packet header
+ * @param   pBuf        The buffer the header is within. Only used in strict builds.
+ */
+DECLINLINE(PPDMNETWORKGSO) INTNETHdrGetGsoContext(PCINTNETHDR pHdr, PCINTNETBUF pBuf)
+{
+    PPDMNETWORKGSO pGso = (PPDMNETWORKGSO)((uint8_t *)pHdr + pHdr->offFrame);
+#ifdef VBOX_STRICT
+    const uintptr_t off = (uintptr_t)pGso - (uintptr_t)pBuf;
+    Assert(pHdr->u16Type == INTNETHDR_TYPE_GSO);
+    Assert(off < pBuf->cbBuf);
+    Assert(off + pHdr->cbFrame <= pBuf->cbBuf);
+#endif
+    NOREF(pBuf);
+    return pGso;
+}
+
+
+/**
  * Skips to the next (read) frame in the buffer.
  *
@@ -141 +291 @@
     Assert(offReadOld <  pRingBuf->offEnd);
     Assert(RT_ALIGN_PT(pHdr, INTNETHDR_ALIGNMENT, INTNETHDR *) == pHdr);
-    Assert(pHdr->u16Type == INTNETHDR_TYPE_FRAME || pHdr->u16Type == INTNETHDR_TYPE_PADDING);
+    Assert(INETNETIsValidFrameType(pHdr->u16Type));
 
     /* skip the frame */
@@ -168 +318 @@
  * @param   ppvFrame            Where to return the frame pointer.
  */
-DECLINLINE(int) INTNETRingAllocateFrame(PINTNETRINGBUF pRingBuf, uint32_t cbFrame, PINTNETHDR *ppHdr, void **ppvFrame)
+DECLINLINE(int) intnetRingAllocateFrameInternal(PINTNETRINGBUF pRingBuf, uint32_t cbFrame, uint16_t u16Type,
+                                                PINTNETHDR *ppHdr, void **ppvFrame)
 {
     /*
@@ -194 +345 @@
 
             PINTNETHDR pHdr = (PINTNETHDR)((uint8_t *)pRingBuf + offWriteInt);
-            pHdr->u16Type  = INTNETHDR_TYPE_FRAME;
+            pHdr->u16Type  = u16Type;
             pHdr->cbFrame  = (uint16_t)cbFrame; Assert(pHdr->cbFrame == cbFrame);
             pHdr->offFrame = sizeof(INTNETHDR);
@@ -215 +366 @@
 
             PINTNETHDR pHdr = (PINTNETHDR)((uint8_t *)pRingBuf + offWriteInt);
-            pHdr->u16Type  = INTNETHDR_TYPE_FRAME;
+            pHdr->u16Type  = u16Type;
             pHdr->cbFrame  = (uint16_t)cbFrame; Assert(pHdr->cbFrame == cbFrame);
             pHdr->offFrame = pRingBuf->offStart - offWriteInt;
@@ -235 +386 @@
 
         PINTNETHDR pHdr = (PINTNETHDR)((uint8_t *)pRingBuf + offWriteInt);
-        pHdr->u16Type  = INTNETHDR_TYPE_FRAME;
+        pHdr->u16Type  = u16Type;
         pHdr->cbFrame  = (uint16_t)cbFrame; Assert(pHdr->cbFrame == cbFrame);
         pHdr->offFrame = sizeof(INTNETHDR);
@@ -247 +398 @@
     STAM_REL_COUNTER_INC(&pRingBuf->cOverflows);
     return VERR_BUFFER_OVERFLOW;
+}
+
+
+/**
+ * Allocates a normal frame in the specified ring.
+ *
+ * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
+ * @param   pRingBuf            The ring buffer.
+ * @param   cbFrame             The frame size.
+ * @param   ppHdr               Where to return the frame header.
+ *                              Don't touch this!
+ * @param   ppvFrame            Where to return the frame pointer.
+ */
+DECLINLINE(int) INTNETRingAllocateFrame(PINTNETRINGBUF pRingBuf, uint32_t cbFrame, PINTNETHDR *ppHdr, void **ppvFrame)
+{
+    return intnetRingAllocateFrameInternal(pRingBuf, cbFrame, INTNETHDR_TYPE_FRAME, ppHdr, ppvFrame);
+}
+
+
+/**
+ * Allocates a GSO frame in the specified ring.
+ *
+ * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
+ * @param   pRingBuf            The ring buffer.
+ * @param   cbFrame             The frame size.
+ * @param   pGso                Pointer to the GSO context.
+ * @param   ppHdr               Where to return the frame header.
+ *                              Don't touch this!
+ * @param   ppvFrame            Where to return the frame pointer.
+ */
+DECLINLINE(int) INTNETRingAllocateGsoFrame(PINTNETRINGBUF pRingBuf, uint32_t cbFrame, PCPDMNETWORKGSO pGso,
+                                           PINTNETHDR *ppHdr, void **ppvFrame)
+{
+    void *pvFrame;
+    int rc = intnetRingAllocateFrameInternal(pRingBuf, cbFrame + sizeof(*pGso), INTNETHDR_TYPE_GSO, ppHdr, &pvFrame);
+    if (RT_SUCCESS(rc))
+    {
+        PPDMNETWORKGSO pGsoCopy = (PPDMNETWORKGSO)pvFrame;
+        *pGsoCopy = *pGso;
+        *ppvFrame = pGsoCopy + 1;
+    }
+    return rc;
 }
 
@@ -492 +685 @@
 
 
-
 /**
  * Initializes a buffer structure.
@@ -535 +727 @@
 }
 
+#endif /* __cplusplus */
+
 #endif
 

trunk/include/VBox/types.h

@@ -746 +746 @@
     /** TCP/IPv4. */
     PDMNETWORKGSOTYPE_IPV4_TCP,
-#if 0 /* later */
     /** TCP/IPv6. */
     PDMNETWORKGSOTYPE_IPV6_TCP,
@@ -753 +752 @@
     /** UDP/IPv6. */
     PDMNETWORKGSOTYPE_IPV6_UDP,
-    /** IPv6 over IPv4 tunneling. */
-    PDMNETWORKGSOTYPE_IPV4_TCPV6,
     /** TCP/IPv6 over IPv4 tunneling.
      * The header offsets and sizes relates to IPv4 and TCP, the IPv6 header is
      * figured out as needed.
      * @todo Needs checking against facts, this is just an outline of the idea. */
-    PDMNETWORKGSOTYPE_IPV4_TCPV6_TCP,
+    PDMNETWORKGSOTYPE_IPV4_IPV6_TCP,
     /** UDP/IPv6 over IPv4 tunneling.
      * The header offsets and sizes relates to IPv4 and UDP, the IPv6 header is
      * figured out as needed.
      * @todo Needs checking against facts, this is just an outline of the idea. */
-    PDMNETWORKGSOTYPE_IPV4_TCPV6_UDP,
-#endif
+    PDMNETWORKGSOTYPE_IPV4_IPV6_UDP,
     /** The end of valid GSO types. */
     PDMNETWORKGSOTYPE_END
@@ -790 +786 @@
     uint16_t            cbMaxSeg;
 
-    /** Offset of the first header (IPv4 / IPv6). */
+    /** Offset of the first header (IPv4 / IPv6).  0 if not not needed. */
     uint8_t             offHdr1;
-    /** The size of the first header (IPv4 / IPv6). */
+    /** The size of the first header (IPv4 / IPv6).  0 if not not needed. */
     uint8_t             cbHdr1;
 
-    /** Offset of the second header (TCP / UDP). */
+    /** Offset of the second header (TCP / UDP).  0 if not not needed. */
     uint8_t             offHdr2;
-    /** The size of the second header (TCP / UDP). */
+    /** The size of the second header (TCP / UDP).  0 if not not needed. */
     uint8_t             cbHdr2;
 } PDMNETWORKGSO;