Skip to contentSkip to conversation

sg_xcopy: Improve the code for building a CSCD descriptor

PATCH In review Bart Van Assche 2 participants 2 messages Sep 2, 2021 – Sep 4, 2021 SCSI

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sg_xcopy: Improve the code for building a CSCD descriptor

Since the maximum length of the designator field in an identification CSCD descriptor is 20 bytes, accept designators with a length of up to 20 bytes.

Since the upper four bits of byte 4 in a CSCD descriptor are reserved, use mask 0x0f instead of 0x1f for that byte.

Since the upper two bits of byte 5 in a CSCD descriptor are reserved, use mask 0x3f for that byte.

Compile-tested only.

Cc Eitan Cohen <[email protected]>
Cc Hannes Reinecke <[email protected]>
---
 src/sg_xcopy.c | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)
src/sg_xcopy.c +9 -8
index e691a73ef4c9..dff565a2eab8 100644
@@ -1075,27 +1075,27 @@ desc_from_vpd_id(int sg_fd, uint8_t *desc, int desc_len,
         if (verbose > 2)
             pr2serr("    Desc %d: assoc %u desig %u len %d\n", off, assoc,
                     desig, i_len);
-        /* Descriptor must be less than 16 bytes */
-        if (i_len > 16)
+        /* Designator length must be <= 20. */
+        if (i_len > 20)
             continue;
-        if (desig == 3) {
+        if (desig == /*NAA=*/3) {
             best = bp;
             best_len = i_len;
             break;
         }
-        if (desig == 2) {
+        if (desig == /*EUI64=*/2) {
             if (!best || f_desig < 2) {
                 best = bp;
                 best_len = i_len;
                 f_desig = 2;
             }
-        } else if (desig == 1) {
+        } else if (desig == /*T10*/1) {
             if (!best || f_desig == 0) {
                 best = bp;
                 best_len = i_len;
                 f_desig = desig;
             }
-        } else if (desig == 0) {
+        } else if (desig == /*vend.spec.=*/0) {
             if (!best) {
                 best = bp;
                 best_len = i_len;
@@ -1108,9 +1108,10 @@ desc_from_vpd_id(int sg_fd, uint8_t *desc, int desc_len,
             decode_designation_descriptor(best, best_len);
         if (best_len + 4 < desc_len) {
             memset(desc, 0, 32);
-            desc[0] = 0xe4;
+            desc[0] = 0xe4; /* Identification Descriptor */
             memcpy(desc + 4, best, best_len + 4);
-            desc[4] &= 0x1f;
+            desc[4] &= 0x0f; /* code set */
+	    desc[5] &= 0x3f; /* association and designator type */
             if (pad)
                 desc[28] = 0x4;
             sg_put_unaligned_be24((uint32_t)block_size, desc + 29);
#1 lore raw
Quoted 10 lines · Bart Van Assche

Since the maximum length of the designator field in an identification CSCD descriptor is 20 bytes, accept designators with a length of up to 20 bytes.

Since the upper four bits of byte 4 in a CSCD descriptor are reserved, use mask 0x0f instead of 0x1f for that byte.

Since the upper two bits of byte 5 in a CSCD descriptor are reserved, use mask 0x3f for that byte.

Compile-tested only.

Looks good and Hannes didn't object so it has been applied to my upstream version which is mirrored at: https://github.com/doug-gilbert/sg3_utils

My ddpt package tries to be an "all-in-one" copy using pass-through solution. The "all-in-one" utility has the same name as the package plus there are two helpers: ddptctl and ddpt_sgl. It also does the same "LID1" Extended Copy as sg_xcopy plus the Microsoft inspired ODX which relies on the Populate Token and Write Using Token (SBC-3,4,5) SCSI commands. It shares the same CSCD identification descriptor code as sg_xcopy so it needs the same fix. That is now done, see: https://github.com/doug-gilbert/ddpt
Recent extensions to ddpt include generalizing skip= and seek= operands to take scatter gather lists (i.e. gather on the IFILE side, scatter on the OFILE side). Also invocations like this:
ddpt iflag=pt if=/dev/nvme0n1 bs=512 of=img.bin
issue NVME commands to that IFILE (via a SNTL).

BTW FreeNAS has a decent ODX (server side) implementation and probably parts of Extended Copy as well.

Doug Gilbert

Quoted 59 lines
Cc Eitan Cohen <[email protected]>
Cc Hannes Reinecke <[email protected]>
---
  src/sg_xcopy.c | 17 +++++++++--------
  1 file changed, 9 insertions(+), 8 deletions(-)
src/sg_xcopy.c +9 -8
index e691a73ef4c9..dff565a2eab8 100644
@@ -1075,27 +1075,27 @@ desc_from_vpd_id(int sg_fd, uint8_t *desc, int desc_len,
          if (verbose > 2)
              pr2serr("    Desc %d: assoc %u desig %u len %d\n", off, assoc,
                      desig, i_len);
-        /* Descriptor must be less than 16 bytes */
-        if (i_len > 16)
+        /* Designator length must be <= 20. */
+        if (i_len > 20)
              continue;
-        if (desig == 3) {
+        if (desig == /*NAA=*/3) {
              best = bp;
              best_len = i_len;
              break;
          }
-        if (desig == 2) {
+        if (desig == /*EUI64=*/2) {
              if (!best || f_desig < 2) {
                  best = bp;
                  best_len = i_len;
                  f_desig = 2;
              }
-        } else if (desig == 1) {
+        } else if (desig == /*T10*/1) {
              if (!best || f_desig == 0) {
                  best = bp;
                  best_len = i_len;
                  f_desig = desig;
              }
-        } else if (desig == 0) {
+        } else if (desig == /*vend.spec.=*/0) {
              if (!best) {
                  best = bp;
                  best_len = i_len;
@@ -1108,9 +1108,10 @@ desc_from_vpd_id(int sg_fd, uint8_t *desc, int desc_len,
              decode_designation_descriptor(best, best_len);
          if (best_len + 4 < desc_len) {
              memset(desc, 0, 32);
-            desc[0] = 0xe4;
+            desc[0] = 0xe4; /* Identification Descriptor */
              memcpy(desc + 4, best, best_len + 4);
-            desc[4] &= 0x1f;
+            desc[4] &= 0x0f; /* code set */
+	    desc[5] &= 0x3f; /* association and designator type */
              if (pad)
                  desc[28] = 0x4;
              sg_put_unaligned_be24((uint32_t)block_size, desc + 29);