Changeset 50304 in vbox for trunk/src

Timestamp:

Jan 31, 2014 5:45:25 PM (11 years ago)

Author:

vboxsync

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

91987

Message:

iSCSI: Add option to dump malformed response packets

File:

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

trunk/src/VBox/Storage/ISCSI.cpp ¶

@@ -569 +569 @@
     /** Flag whether to use the host IP stack or DevINIP. */
     bool                fHostIP;
+    /** Flag whether to dump malformed packets in the release log. */
+    bool                fDumpMalformedPackets;
 
     /** Head of request queue */
@@ -629 +631 @@
 static const char *s_iscsiConfigDefaultHostIPStack = "1";
 
+/** Default dump malformed packet configuration value. */
+static const char *s_iscsiConfigDefaultDumpMalformedPackets = "0";
+
 /** Description of all accepted config parameters. */
 static const VDCONFIGINFO s_iscsiConfigInfo[] =
 {
-    { "TargetName",         NULL,                               VDCFGVALUETYPE_STRING,  VD_CFGKEY_MANDATORY },
+    { "TargetName",           NULL,                                      VDCFGVALUETYPE_STRING,  VD_CFGKEY_MANDATORY },
     /* LUN is defined of string type to handle the "enc" prefix. */
-    { "LUN",                s_iscsiConfigDefaultLUN,            VDCFGVALUETYPE_STRING,  VD_CFGKEY_MANDATORY },
-    { "TargetAddress",      NULL,                               VDCFGVALUETYPE_STRING,  VD_CFGKEY_MANDATORY },
-    { "InitiatorName",      NULL,                               VDCFGVALUETYPE_STRING,  0 },
-    { "InitiatorUsername",  NULL,                               VDCFGVALUETYPE_STRING,  0 },
-    { "InitiatorSecret",    NULL,                               VDCFGVALUETYPE_BYTES,   0 },
-    { "TargetUsername",     NULL,                               VDCFGVALUETYPE_STRING,  VD_CFGKEY_EXPERT },
-    { "TargetSecret",       NULL,                               VDCFGVALUETYPE_BYTES,   VD_CFGKEY_EXPERT },
-    { "WriteSplit",         s_iscsiConfigDefaultWriteSplit,     VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
-    { "Timeout",            s_iscsiConfigDefaultTimeout,        VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
-    { "HostIPStack",        s_iscsiConfigDefaultHostIPStack,    VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
-    { NULL,                 NULL,                               VDCFGVALUETYPE_INTEGER, 0 }
+    { "LUN",                  s_iscsiConfigDefaultLUN,                   VDCFGVALUETYPE_STRING,  VD_CFGKEY_MANDATORY },
+    { "TargetAddress",        NULL,                                      VDCFGVALUETYPE_STRING,  VD_CFGKEY_MANDATORY },
+    { "InitiatorName",        NULL,                                      VDCFGVALUETYPE_STRING,  0 },
+    { "InitiatorUsername",    NULL,                                      VDCFGVALUETYPE_STRING,  0 },
+    { "InitiatorSecret",      NULL,                                      VDCFGVALUETYPE_BYTES,   0 },
+    { "TargetUsername",       NULL,                                      VDCFGVALUETYPE_STRING,  VD_CFGKEY_EXPERT },
+    { "TargetSecret",         NULL,                                      VDCFGVALUETYPE_BYTES,   VD_CFGKEY_EXPERT },
+    { "WriteSplit",           s_iscsiConfigDefaultWriteSplit,            VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
+    { "Timeout",              s_iscsiConfigDefaultTimeout,               VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
+    { "HostIPStack",          s_iscsiConfigDefaultHostIPStack,           VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
+    { "DumpMalformedPackets", s_iscsiConfigDefaultDumpMalformedPackets,  VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
+    { NULL,                   NULL,                                      VDCFGVALUETYPE_INTEGER, 0 }
 };
 
@@ -801 +807 @@
 
     return pIScsiCmdHead;
+}
+
+/**
+ * Dumps an iSCSI packet if enabled.
+ *
+ * @returns nothing.
+ * @param   pImage         The iSCSI image instance data.
+ * @param   paISCSISegs    Pointer to the segments array.
+ * @param   cnISCSISegs    Number of segments in the array.
+ * @param   rc             Status code for this packet.
+ * @param   fRequest       Flag whether this is request or response packet.
+ */
+static void iscsiDumpPacket(PISCSIIMAGE pImage, PISCSIREQ paISCSISegs, unsigned cnISCSISegs, int rc, bool fRequest)
+{
+    if (pImage->fDumpMalformedPackets)
+    {
+        LogRel(("iSCSI{%s}: Dumping %s packet completed with status code %Rrc\n", pImage->pszTargetName, fRequest ? "request" : "response", rc));
+        for (unsigned i = 0; i < cnISCSISegs; i++)
+        {
+            if (paISCSISegs[i].cbSeg)
+            {
+                LogRel(("iSCSI{%s}: Segment %u, size %zu\n"
+                        "%.*Rhxd\n",
+                        pImage->pszTargetName, i, paISCSISegs[i].cbSeg,
+                        paISCSISegs[i].cbSeg, paISCSISegs[i].pcvSeg));
+            }
+        }
+    }
 }
 
@@ -1654 +1688 @@
     {
         /*
+         * Dump the last request and response of we are supposed to do so and there is a request
+         * or response.
+         */
+        if (cnISCSIReq)
+            iscsiDumpPacket(pImage, aISCSIReq, cnISCSIReq, VINF_SUCCESS, true /* fRequest */);
+
+        if (cnISCSIRes)
+            iscsiDumpPacket(pImage, (PISCSIREQ)aISCSIRes, cnISCSIRes, rc, false /* fRequest */);
+
+        /*
          * Close connection to target.
          */
@@ -1665 +1709 @@
 
     LogFlowFunc(("returning %Rrc\n", rc));
-    LogRel(("iSCSI: login to target %s %s\n", pImage->pszTargetName, RT_SUCCESS(rc) ? "successful" : "failed"));
+    LogRel(("iSCSI: login to target %s %s (%Rrc)\n", pImage->pszTargetName, RT_SUCCESS(rc) ? "successful" : "failed", rc));
     return rc;
 }
@@ -2122 +2166 @@
             rc = iscsiValidatePDU(&aResBuf, 1);
             if (RT_FAILURE(rc))
+            {
+                iscsiDumpPacket(pImage, (PISCSIREQ)&aResBuf, 1, rc, false /* fRequest */);
                 continue;
+            }
             cmd = (ISCSIOPCODE)(RT_N2H_U32(pcvResSeg[0]) & ISCSIOP_MASK);
             switch (cmd)
@@ -2143 +2190 @@
                 default:
                     rc = VERR_PARSE_ERROR;
+                    iscsiDumpPacket(pImage, (PISCSIREQ)&aResBuf, 1, rc, false /* fRequest */);
             }
             if (RT_FAILURE(rc))
@@ -2161 +2209 @@
                 {
                     rc = VERR_PARSE_ERROR;
+                    iscsiDumpPacket(pImage, (PISCSIREQ)&aResBuf, 1, rc, false /* fRequest */);
                     continue;
                 }
@@ -2445 +2494 @@
                 default:
                     rc = VERR_PARSE_ERROR;
+                    iscsiDumpPacket(pImage, (PISCSIREQ)paRes, cnRes, rc, false /* fRequest */);
             }
 
@@ -2462 +2512 @@
                 else
                 {
-                   rc = VERR_PARSE_ERROR;
-                   break;
+                    rc = VERR_PARSE_ERROR;
+                    iscsiDumpPacket(pImage, (PISCSIREQ)paRes, cnRes, rc, false /* fRequest */);
+                    break;
                 }
             }
@@ -2534 +2585 @@
         } while (0);
     }
+    else
+        iscsiDumpPacket(pImage, (PISCSIREQ)paRes, cnRes, rc, false /* fRequest */);
 
     return rc;
@@ -2847 +2900 @@
     {
         LogRel(("iSCSI: Received malformed PDU from target %s (rc=%Rrc), ignoring\n", pImage->pszTargetName, rc));
+        iscsiDumpPacket(pImage, (PISCSIREQ)paRes, cnRes, rc, false /* fRequest */);
         rc = VINF_SUCCESS;
     }
@@ -3765 +3819 @@
     uint32_t uWriteSplitDef = 0;
     uint32_t uTimeoutDef = 0;
-    uint64_t uHostIPTmp = 0;
-    bool fHostIPDef = 0;
+    uint64_t uCfgTmp = 0;
+    bool fHostIPDef = false;
+    bool fDumpMalformedPacketsDef = false;
     rc = RTStrToUInt32Full(s_iscsiConfigDefaultWriteSplit, 0, &uWriteSplitDef);
     AssertRC(rc);
     rc = RTStrToUInt32Full(s_iscsiConfigDefaultTimeout, 0, &uTimeoutDef);
     AssertRC(rc);
-    rc = RTStrToUInt64Full(s_iscsiConfigDefaultHostIPStack, 0, &uHostIPTmp);
+    rc = RTStrToUInt64Full(s_iscsiConfigDefaultHostIPStack, 0, &uCfgTmp);
     AssertRC(rc);
-    fHostIPDef = !!uHostIPTmp;
+    fHostIPDef = RT_BOOL(uCfgTmp);
+
+    rc = RTStrToUInt64Full(s_iscsiConfigDefaultDumpMalformedPackets, 0, &uCfgTmp);
+    AssertRC(rc);
+    fDumpMalformedPacketsDef = RT_BOOL(uCfgTmp);
 
     pImage->uOpenFlags      = uOpenFlags;
@@ -3841 +3900 @@
                            "WriteSplit\0"
                            "Timeout\0"
-                           "HostIPStack\0"))
+                           "HostIPStack\0"
+                           "DumpMalformedPackets\0"))
     {
         rc = vdIfError(pImage->pIfError, VERR_VD_ISCSI_UNKNOWN_CFG_VALUES, RT_SRC_POS, N_("iSCSI: configuration error: unknown configuration keys present"));
@@ -4000 +4060 @@
     {
         rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read HostIPStack as boolean"));
+        goto out;
+    }
+
+    rc = VDCFGQueryBoolDef(pImage->pIfConfig,
+                           "DumpMalformedPackets", &pImage->fDumpMalformedPackets,
+                           fDumpMalformedPacketsDef);
+    if (RT_FAILURE(rc))
+    {
+        rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read DumpMalformedPackets as boolean"));
         goto out;
     }