Changeset 14526 in vbox for trunk/include

Timestamp:

Nov 24, 2008 3:16:01 PM (16 years ago)

Author:

vboxsync

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

39814

Message:

Devices/Storage: iSCSI stuff, including bringing IntNet support back to life. Should build, but otherwise untested.

File:

• trunk/include/VBox/VBoxHDD-new.h (modified) (20 diffs)

trunk/include/VBox/VBoxHDD-new.h

@@ -216 +216 @@
  * provide the mandatory configuration parts this way. */
 #define VD_CAP_CONFIG               RT_BIT(7)
+/** The backend uses the network stack interface. The caller has to provide
+ * the appropriate interface. */
+#define VD_CAP_TCPNET               RT_BIT(8)
 /** @}*/
 
@@ -233 +236 @@
     /** Interface for configuration information. Per-image. */
     VDINTERFACETYPE_CONFIG,
+    /** Interface for TCP network stack. Per-disk. */
+    VDINTERFACETYPE_TCPNET,
     /** invalid interface. */
     VDINTERFACETYPE_INVALID
@@ -252 +257 @@
     /** Opaque user data which is passed on every call. */
     void               *pvUser;
-    /** Pointer to the function call table of the interface. 
+    /** Pointer to the function call table of the interface.
      *  As this is opaque this must be casted to the right interface
      *  struct defined below based on the interface type in enmInterface. */
@@ -288 +293 @@
         AssertMsgBreak(pVDIfs->cbSize == sizeof(VDINTERFACE),
                        ("cbSize=%u\n", pVDIfs->cbSize));
-                       
+
         if (pVDIfs->enmInterface == enmInterface)
             return pVDIfs;
@@ -395 +400 @@
 }
 
-/** 
+/**
  * Completion callback which is called by the interface owner
  * to inform the backend that a task finished.
@@ -455 +460 @@
      * @param   pcbWritten      Where to store how many bytes where actually written.
      */
-    DECLR3CALLBACKMEMBER(int, pfnWrite, (void *pvUser, void *pStorage, uint64_t uOffset, 
+    DECLR3CALLBACKMEMBER(int, pfnWrite, (void *pvUser, void *pStorage, uint64_t uOffset,
                                          size_t cbWrite, const void *pvBuf, size_t *pcbWritten));
 
@@ -469 +474 @@
      * @param   pcbRead         Where to store how many bytes where actually read.
      */
-    DECLR3CALLBACKMEMBER(int, pfnRead, (void *pvUser, void *pStorage, uint64_t uOffset, 
+    DECLR3CALLBACKMEMBER(int, pfnRead, (void *pvUser, void *pStorage, uint64_t uOffset,
                                         size_t cbRead, void *pvBuf, size_t *pcbRead));
 
@@ -492 +497 @@
      * @param   ppTask         Where to store the opaque task handle.
      */
-    DECLR3CALLBACKMEMBER(int, pfnPrepareRead, (void *pvUser, void *pStorage, uint64_t uOffset, 
+    DECLR3CALLBACKMEMBER(int, pfnPrepareRead, (void *pvUser, void *pStorage, uint64_t uOffset,
                                                void *pvBuf, size_t cbRead, void **ppTask));
 
@@ -506 +511 @@
      * @param   ppTask         Where to store the opaque task handle.
      */
-    DECLR3CALLBACKMEMBER(int, pfnPrepareWrite, (void *pvUser, void *pStorage, uint64_t uOffset, 
+    DECLR3CALLBACKMEMBER(int, pfnPrepareWrite, (void *pvUser, void *pStorage, uint64_t uOffset,
                                                 void *pvBuf, size_t cbWrite, void **ppTask));
 
@@ -550 +555 @@
 /**
  * Progress notification interface
- * 
+ *
  * Per-operation. Optional.
  */
@@ -687 +692 @@
 DECLINLINE(PVDINTERFACECONFIG) VDGetInterfaceConfig(PVDINTERFACE pInterface)
 {
-    /* Check that the interface descriptor is a progress interface. */
+    /* Check that the interface descriptor is a config interface. */
     AssertMsgReturn(   (pInterface->enmInterface == VDINTERFACETYPE_CONFIG)
                     && (pInterface->cbSize == sizeof(VDINTERFACE)),
@@ -705 +710 @@
  * Query configuration, validates that the values are within a set of valid names.
  *
- * @returns true if all names are found in pszzAllowed.
- * @returns false if not.
+ * @return  true if all names are found in pszzAllowed.
+ * @return  false if not.
  * @param   pCfgIf      Pointer to configuration callback table.
  * @param   pNode       The node which values should be examined.
@@ -721 +726 @@
 /**
  * Query configuration, unsigned 64-bit integer value with default.
- * 
+ *
  * @return  VBox status code.
  * @param   pCfgIf      Pointer to configuration callback table.
@@ -738 +743 @@
 /**
  * Query configuration, unsigned 32-bit integer value with default.
- * 
+ *
  * @return  VBox status code.
  * @param   pCfgIf      Pointer to configuration callback table.
@@ -764 +769 @@
 /**
  * Query configuration, bool value with default.
- * 
+ *
  * @return  VBox status code.
  * @param   pCfgIf      Pointer to configuration callback table.
@@ -786 +791 @@
  * Query configuration, dynamically allocated (RTMemAlloc) zero terminated
  * character value.
- * 
+ *
  * @return  VBox status code.
  * @param   pCfgIf      Pointer to configuration callback table.
@@ -821 +826 @@
  * Query configuration, dynamically allocated (RTMemAlloc) zero terminated
  * character value with default.
- * 
+ *
  * @return  VBox status code.
  * @param   pCfgIf      Pointer to configuration callback table.
@@ -862 +867 @@
 /**
  * Query configuration, dynamically allocated (RTMemAlloc) byte string value.
- * 
+ *
  * @return  VBox status code.
  * @param   pCfgIf      Pointer to configuration callback table.
@@ -898 +903 @@
 
 
+/**
+ * TCP network stack interface
+ *
+ * Per-disk. Mandatory for backends which have the VD_CAP_TCPNET bit set.
+ */
+typedef struct VDINTERFACETCPNET
+{
+    /**
+     * Size of the configuration interface.
+     */
+    uint32_t    cbSize;
+
+    /**
+     * Interface type.
+     */
+    VDINTERFACETYPE enmInterface;
+
+    /**
+     * Connect as a client to a TCP port.
+     *
+     * @return  iprt status code.
+     * @param   pszAddress      The address to connect to.
+     * @param   uPort           The port to connect to.
+     * @param   pSock           Where to store the handle to the established connect
+ion.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnClientConnect, (const char *pszAddress, uint32_t uPort, PRTSOCKET pSock));
+
+    /**
+     * Close a TCP connection.
+     *
+     * @return  iprt status code.
+     * @param   Sock            Socket descriptor.
+ion.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnClientClose, (RTSOCKET Sock));
+
+    /**
+     * Socket I/O multiplexing.
+     * Checks if the socket is ready for reading.
+     *
+     * @return  iprt status code.
+     * @param   Sock        Socket descriptor.
+     * @param   cMillies    Number of milliseconds to wait for the socket.
+     *                      Use RT_INDEFINITE_WAIT to wait for ever.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnSelectOne, (RTSOCKET Sock, unsigned cMillies));
+
+    /**
+     * Receive data from a socket.
+     *
+     * @return  iprt status code.
+     * @param   Sock        Socket descriptor.
+     * @param   pvBuffer    Where to put the data we read.
+     * @param   cbBuffer    Read buffer size.
+     * @param   pcbRead     Number of bytes read.
+     *                      If NULL the entire buffer will be filled upon successful return.
+     *                      If not NULL a partial read can be done successfully.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnRead, (RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead));
+
+    /**
+     * Send data from a socket.
+     *
+     * @return  iprt status code.
+     * @param   Sock        Socket descriptor.
+     * @param   pvBuffer    Buffer to write data to socket.
+     * @param   cbBuffer    How much to write.
+     * @param   pcbRead     Number of bytes read.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnWrite, (RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer));
+
+    /**
+     * Flush socket write buffers.
+     *
+     * @return  iprt status code.
+     * @param   Sock        Socket descriptor.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnFlush, (RTSOCKET Sock));
+
+} VDINTERFACETCPNET, *PVDINTERFACETCPNET;
+
+/**
+ * Get TCP network stack interface from opaque callback table.
+ *
+ * @return Pointer to the callback table.
+ * @param  pInterface Pointer to the interface descriptor.
+ */
+DECLINLINE(PVDINTERFACETCPNET) VDGetInterfaceTcpNet(PVDINTERFACE pInterface)
+{
+    /* Check that the interface descriptor is a TCP network stack interface. */
+    AssertMsgReturn(   (pInterface->enmInterface == VDINTERFACETYPE_TCPNET)
+                    && (pInterface->cbSize == sizeof(VDINTERFACE)),
+                    ("Not a TCP network stack interface"), NULL);
+
+    PVDINTERFACETCPNET pInterfaceTcpNet = (PVDINTERFACETCPNET)pInterface->pCallbacks;
+
+    /* Do basic checks. */
+    AssertMsgReturn(   (pInterfaceTcpNet->cbSize == sizeof(VDINTERFACETCPNET))
+                    && (pInterfaceTcpNet->enmInterface == VDINTERFACETYPE_TCPNET),
+                    ("A non TCP network stack callback table attached to a TCP network stack interface descriptor\n"), NULL);
+
+    return pInterfaceTcpNet;
+}
+
+
 /** @name Configuration interface key handling flags.
  * @{
@@ -1495 +1606 @@
  * @param   pvUser          User data which is passed on completion
  */
-VBOXDDU_DECL(int) VDAsyncRead(PVBOXHDD pDisk, uint64_t uOffset, size_t cbRead, 
+VBOXDDU_DECL(int) VDAsyncRead(PVBOXHDD pDisk, uint64_t uOffset, size_t cbRead,
                               PPDMDATASEG paSeg, unsigned cSeg,
                               void *pvUser);