Changeset 26917 in vbox for trunk/src/VBox/Devices

Timestamp:

Mar 1, 2010 2:55:10 PM (15 years ago)

Author:

vboxsync

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

58201

Message:

Storage/iSCSI: implement automatically setting InitiatorName and ISID to globally unique values

File:

• trunk/src/VBox/Devices/Storage/ISCSIHDDCore.cpp (modified) (15 diffs)

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2009 Sun Microsystems, Inc.
+ * Copyright (C) 2006-2010 Sun Microsystems, Inc.
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -330 +330 @@
     /** Size of volume in sectors. */
     uint64_t            cVolume;
-    /** Total volume size in bytes. Easiert that multiplying the above values all the time. */
+    /** Total volume size in bytes. Easier that multiplying the above values all the time. */
     uint64_t            cbSize;
 
@@ -371 +371 @@
     /** Timeout for read operations on the TCP connection (in milliseconds). */
     uint32_t            uReadTimeout;
+    /** Flag whether to automatically generate the initiator name. */
+    bool                fAutomaticInitiatorName;
     /** Flag whether to use the host IP stack or DevINIP. */
     bool                fHostIP;
@@ -450 +452 @@
 *******************************************************************************/
 
-/** Counter for getting unique instance IDs. */
-static uint32_t s_u32iscsiID = 0;
+/** Default initiator basename. */
+static const char *s_iscsiDefaultInitiatorBasename = "iqn.2009-08.com.sun.virtualbox.initiator";
 
 /** Default LUN. */
 static const char *s_iscsiConfigDefaultLUN = "0";
-
-/** Default initiator name. */
-static const char *s_iscsiConfigDefaultInitiatorName = "iqn.2009-08.com.sun.virtualbox.initiator";
 
 /** Default timeout, 10 seconds. */
@@ -475 +474 @@
     { "LUN",                s_iscsiConfigDefaultLUN,            VDCFGVALUETYPE_STRING,  VD_CFGKEY_MANDATORY },
     { "TargetAddress",      NULL,                               VDCFGVALUETYPE_STRING,  VD_CFGKEY_MANDATORY },
-    { "InitiatorName",      s_iscsiConfigDefaultInitiatorName,  VDCFGVALUETYPE_STRING,  0 },
+    { "InitiatorName",      NULL,                               VDCFGVALUETYPE_STRING,  0 },
     { "InitiatorUsername",  NULL,                               VDCFGVALUETYPE_STRING,  0 },
     { "InitiatorSecret",    NULL,                               VDCFGVALUETYPE_BYTES,   0 },
@@ -533 +532 @@
 
 
+static int iscsiTransportConnect(PISCSIIMAGE pImage)
+{
+    int rc;
+    if (!pImage->pszHostname)
+        return VERR_NET_DEST_ADDRESS_REQUIRED;
+
+    rc = pImage->pInterfaceNetCallbacks->pfnClientConnect(pImage->pszHostname, pImage->uPort, &pImage->Socket);
+    if (RT_UNLIKELY(   RT_FAILURE(rc)
+                    && (   rc == VERR_NET_CONNECTION_REFUSED
+                        || rc == VERR_NET_CONNECTION_RESET
+                        || rc == VERR_NET_UNREACHABLE
+                        || rc == VERR_NET_HOST_UNREACHABLE
+                        || rc == VERR_NET_CONNECTION_TIMED_OUT)))
+    {
+        /* Standardize return value for no connection. */
+        return VERR_NET_CONNECTION_REFUSED;
+    }
+
+    /* Make initiator name and ISID unique on this host. */
+    RTNETADDR LocalAddr;
+    rc = pImage->pInterfaceNetCallbacks->pfnGetLocalAddress(pImage->Socket,
+                                                            &LocalAddr);
+    if (RT_FAILURE(rc))
+        return rc;
+    if (   LocalAddr.uPort == RTNETADDR_PORT_NA
+        || LocalAddr.uPort > 65535)
+        return VERR_NET_ADDRESS_FAMILY_NOT_SUPPORTED;
+    pImage->ISID &= ~65535ULL;
+    pImage->ISID |= LocalAddr.uPort;
+    /* Eliminate the port so that it isn't included below. */
+    LocalAddr.uPort = RTNETADDR_PORT_NA;
+    if (pImage->fAutomaticInitiatorName)
+    {
+        if (pImage->pszInitiatorName)
+            RTStrFree(pImage->pszInitiatorName);
+        RTStrAPrintf(&pImage->pszInitiatorName, "%s:01:%RTnaddr",
+                     s_iscsiDefaultInitiatorBasename, &LocalAddr);
+        if (!pImage->pszInitiatorName)
+            return VERR_NO_MEMORY;
+    }
+    return VINF_SUCCESS;
+}
+
+
 static int iscsiTransportRead(PISCSIIMAGE pImage, PISCSIRES paResponse, unsigned int cnResponse)
 {
@@ -543 +586 @@
     if (pImage->Socket == NIL_RTSOCKET)
     {
-        /* Attempt to reconnect if the connection was previously broken. */
-        if (pImage->pszHostname != NULL)
-        {
-            rc = pImage->pInterfaceNetCallbacks->pfnClientConnect(pImage->pszHostname, pImage->uPort, &pImage->Socket);
-            if (RT_UNLIKELY(   RT_FAILURE(rc)
-                            && (   rc == VERR_NET_CONNECTION_REFUSED
-                                || rc == VERR_NET_CONNECTION_RESET
-                                || rc == VERR_NET_UNREACHABLE
-                                || rc == VERR_NET_HOST_UNREACHABLE
-                                || rc == VERR_NET_CONNECTION_TIMED_OUT)))
-            {
-                /* Standardize return value for no connection. */
-                rc = VERR_NET_CONNECTION_REFUSED;
-            }
-        }
+        /* Reconnecting makes no sense in this case, as there will be nothing
+         * to receive. We would just run into a timeout. */
+        rc = VERR_BROKEN_PIPE;
     }
 
@@ -679 +710 @@
     {
         /* Attempt to reconnect if the connection was previously broken. */
-        if (pImage->pszHostname != NULL)
-        {
-            rc = pImage->pInterfaceNetCallbacks->pfnClientConnect(pImage->pszHostname, pImage->uPort, &pImage->Socket);
-            if (RT_UNLIKELY(   RT_FAILURE(rc)
-                            && (   rc == VERR_NET_CONNECTION_REFUSED
-                                || rc == VERR_NET_CONNECTION_RESET
-                                || rc == VERR_NET_UNREACHABLE
-                                || rc == VERR_NET_HOST_UNREACHABLE
-                                || rc == VERR_NET_CONNECTION_TIMED_OUT)))
-            {
-                /* Standardize return value for no connection. */
-                rc = VERR_NET_CONNECTION_REFUSED;
-            }
-        }
+        rc = iscsiTransportConnect(pImage);
     }
 
@@ -822 +840 @@
     }
 
-    if (RT_FAILURE(rc))
+    if (RT_SUCCESS(rc))
+    {
+        if (pImage->Socket == NIL_RTSOCKET)
+            rc = iscsiTransportConnect(pImage);
+    }
+    else
     {
         if (pImage->pszHostname)
@@ -832 +855 @@
     }
 
-    /* Note that in this implementation the actual connection establishment is
-     * delayed until a PDU is read or written. */
     LogFlowFunc(("returns %Rrc\n", rc));
     return rc;
@@ -917 +938 @@
 
 restart:
+    if (pImage->Socket == NIL_RTSOCKET)
+        rc = iscsiTransportOpen(pImage);
+
     pImage->state = ISCSISTATE_IN_LOGIN;
     pImage->ITT = 1;
@@ -2230 +2254 @@
     if (pImage->pszInitiatorName)
     {
-        RTMemFree(pImage->pszInitiatorName);
+        if (pImage->fAutomaticInitiatorName)
+            RTStrFree(pImage->pszInitiatorName);
+        else
+            RTMemFree(pImage->pszInitiatorName);
         pImage->pszInitiatorName = NULL;
     }
@@ -2309 +2336 @@
     }
 
-    pImage->ISID            = 0x800000000000ULL | 0x001234560000ULL | (0x00000000cba0ULL + ASMAtomicIncU32(&s_u32iscsiID));
+    /* This ISID will be adjusted later to make it unique on this host. */
+    pImage->ISID            = 0x800000000000ULL | 0x001234560000ULL;
     pImage->cISCSIRetries   = 10;
     pImage->state           = ISCSISTATE_FREE;
@@ -2342 +2370 @@
         goto out;
     }
-    rc = VDCFGQueryStringAllocDef(pImage->pInterfaceConfigCallbacks,
-                                  pImage->pInterfaceConfig->pvUser,
-                                  "InitiatorName", &pImage->pszInitiatorName,
-                                  s_iscsiConfigDefaultInitiatorName);
+    rc = VDCFGQueryStringAlloc(pImage->pInterfaceConfigCallbacks,
+                               pImage->pInterfaceConfig->pvUser,
+                               "InitiatorName", &pImage->pszInitiatorName);
+    if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
+    {
+        pImage->fAutomaticInitiatorName = true;
+        rc = VINF_SUCCESS;
+    }
     if (RT_FAILURE(rc))
     {
@@ -2491 +2523 @@
 
     /*
-     * Establish the iSCSI transport connection.
+     * Attach to the iSCSI target. This implicitly establishes the iSCSI
+     * transport connection.
      */
-    rc = iscsiTransportOpen(pImage);
-    if (RT_SUCCESS(rc))
-        rc = iscsiAttach(pImage);
+    rc = iscsiAttach(pImage);
 
     if (RT_FAILURE(rc))