sg_logs: add --vendor=VP; sg_vpd: improve handling of unknown pages; other fixes

git-svn-id: svn://localhost/trunk@710 6180dd3e-e324-4e3e-922d-17de1ae2f315

Author: doug-gilbert

ChangeLog

@@ -2,7 +2,7 @@ Each utility has its own version number, date of last change and
 some description at the top of its ".c" file. All utilities in the main
 directory have their own "man" pages. There is also a sg3_utils man page.
 
-Changelog for sg3_utils-1.43 [20160528] [svn: r708]
+Changelog for sg3_utils-1.43 [20160531] [svn: r710]
   - sg_bg_ctl: new Background control command (spc4r08)
   - sg_senddiag: add --timeout=SEC option
   - sg_sanitize: add --timeout=SEC option
@@ -16,9 +16,9 @@ Changelog for sg3_utils-1.43 [20160528] [svn: r708]
     - accept and output on request "quad dashed" format
   - sg_logs: fix volume statistics lpage when subpage
     is zero (ssc5r02a); decode mount history log parameter
+    - add --vendor=VP and '--pdt=DT' options
     - decode Requested recovery, TapeAlert response, and
       Service buffer information lpages for tape
-    - add '--pdt=DT' option
     - add min+max 'mounted' temperature and rel. humidity
       fields to Environmental reporting lpage (spc5r10)
   - sg_inq: fix potential unbounded loop in --export
@@ -28,6 +28,7 @@ Changelog for sg3_utils-1.43 [20160528] [svn: r708]
     - add --force option to bypass checking supported
       vpd pages page and fetch requested page directly
   - sg_vpd: 3 party copy VPD page improvements
+    - improve handling of unknown pages
   - sg_reassign+sg_write_same: fix ULONG_MAX problem
   - sg_rdac: add sanity checks for -f=lun value
   - sg_turs+sg_requests: make both accept '--num=NUM'

doc/sg_logs.8

@@ -1,21 +1,32 @@
-.TH SG_LOGS "8" "March 2016" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_LOGS "8" "May 2016" "sg3_utils\-1.43" SG3_UTILS
 .SH NAME
 sg_logs \- access log pages with SCSI LOG SENSE command
 .SH SYNOPSIS
 .B sg_logs
-[\fI\-\-All\fR] [\fI\-\-all\fR] [\fI\-\-brief\fR] [\fI\-\-control=PC\fR]
-[\fI\-\-enumerate\fR] [\fI\-\-enum_vendor\fR] [\fI\-\-filter=FL\fR]
-[\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-in=FN\fR] [\fI\-\-list\fR]
-[\fI\-\-maxlen=LEN\fR] [\fI\-\-name\fR] [\fI\-\-no_inq\fR] [\fI\-\-page=PG\fR]
-[\fI\-\-paramp=PP\fR] [\fI\-\-pcb\fR] [\fI\-\-ppc\fR] [\fI\-\-pdt=DT\fR]
-[\fI\-\-raw\fR] [\fI\-\-readonly\fR] [\fI\-\-reset\fR] [\fI\-\-select\fR]
+[\fI\-\-All\fR] [\fI\-\-all\fR] [\fI\-\-brief\fR] [\fI\-\-filter=FL\fR]
+[\fI\-\-hex\fR] [\fI\-\-list\fR] [\fI\-\-maxlen=LEN\fR] [\fI\-\-name\fR]
+[\fI\-\-no_inq\fR] [\fI\-\-page=PG\fR] [\fI\-\-paramp=PP\fR] [\fI\-\-pcb\fR]
+[\fI\-\-ppc\fR] [\fI\-\-pdt=DT\fR] [\fI\-\-raw\fR] [\fI\-\-readonly\fR]
 [\fI\-\-sp\fR] [\fI\-\-temperature\fR] [\fI\-\-transport\fR]
-[\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
+[\fI\-\-vendor=VP\fR] [\fI\-\-verbose\fR] \fIDEVICE\fR
+.PP
+.B sg_logs 
+[\fI\-\-brief\fR] [\fI\-\-filter=FL\fR] [\fI\-\-hex\fR] \fI\-\-in=FN\fR
+[\fI\-\-name\fR] [\fI\-\-pdt=DT\fR] [\fI\-\-raw\fR] [\fI\-\-vendor=VP\fR]
+.PP
+.B sg_logs
+[\fI\-\-control=PC\fR] [\fI\-\-in=FN\fR] [\fI\-\-page=PG\fR] [\fI\-\-raw\fR]
+[\fI\-\-reset\fR] \fI\-\-select\fR [\fI\-\-sp\fR] [\fI\-\-verbose\fR]
+\fIDEVICE\fR
+.PP
+.B sg_logs
+[\fI\-\-enumerate\fR] [\fI\-\-filter=FL\fR] [\fI\-\-help\fR]
+[\fI\-\-vendor=VP\fR] [\fI\-\-version\fR]
 .PP
 .B sg_logs
 [\fI\-a\fR] [\fI\-A\fR] [\fI\-b\fR] [\fI\-D=DT\fR] [\fI\-c=PC\fR] [\fI\-e\fR]
-[\fI\-E\fR] [\fI\-f=FL\fR] [\fI\-h\fR] [\fI\-H\fR] [\fI\-i=FN\fR] [\fI\-l\fR]
-[\fI\-L\fR] [\fI\-m=LEN\fR] [\fI\-n\fR] [\fI\-p=PG\fR] [\fI\-paramp=PP\fR]
+[\fI\-f=FL\fR] [\fI\-h\fR] [\fI\-H\fR] [\fI\-i=FN\fR] [\fI\-l\fR] [\fI\-L\fR]
+[\fI\-m=LEN\fR] [\fI\-M=VP\fR] [\fI\-n\fR] [\fI\-p=PG\fR] [\fI\-paramp=PP\fR]
 [\fI\-pcb\fR] [\fI\-ppc\fR] [\fI\-r\fR] [\fI\-R\fR] [\fI\-select\fR]
 [\fI\-sp\fR] [\fI\-t\fR] [\fI\-T\fR] [\fI\-v\fR] [\fI\-V\fR] [\fI\-?\fR]
 [\fI\-x\fR] \fIDEVICE\fR
@@ -24,17 +35,22 @@ sg_logs \- access log pages with SCSI LOG SENSE command
 .PP
 This utility sends a SCSI LOG SENSE command to the \fIDEVICE\fR and then
 outputs the response. The LOG SENSE command is used to fetch log pages. Known
-log pages can be decoded. When the \fI\-\-reset\fR and/or \fI\-\-select\fR
-option is given then a SCSI LOG SELECT command is issued.
+log pages can be decoded. Alternatively when the \fI\-\-reset\fR and/or
+\fI\-\-select\fR option is given then a SCSI LOG SELECT command is issued.
 .PP
 In SPC\-4 revision 5 a subpage code was introduced to both the LOG SENSE and
 LOG SELECT command. At the same time a page code field was introduced to the
 to the LOG SELECT command. The log subpage code can range from 0 to 255 (0xff)
 inclusive. The subpage code value 255 can be thought of as a wildcard.
 .PP
-This utility supports two command line syntaxes, the preferred one is shown
-first in the synopsis and explained in this section. A later section on the
-old command line syntax outlines the second group of options.
+The SYNOPSIS section above is divided into five forms. The first form
+shows the options that can be used to send a LOG SENSE command to the
+\fIDEVICE\fR and decode its response. The second form fetches data from a
+file (named \fIFN\fR) and decodes it as if it were a response from a LOG
+SENSE command. The third form shows the options that can be used to send a
+LOG SELECT command. The fourth form groups various management options.
+The last form shows the older, deprecated command line interface which is
+maintaimed for backward compatibility.
 .SH OPTIONS
 Arguments to long options are mandatory for short options as well.
 .TP
@@ -83,20 +99,16 @@ the numeric order.
 The \fI\-\-filter=FL\fR and \fI\-\-verbose\fR options modify the output
 of the enumeration.
 .TP
-\fB\-E\fR, \fB\-\-enum_vendor\fR
-this option is used to output information held in internal tables about
-known vendor specific log pages including their names and acronyms.
-.TP
 \fB\-f\fR, \fB\-\-filter\fR=\fIFL\fR
 \fIFL\fR is either a parameter code when \fIDEVICE\fR is given, or a
 peripheral device type (pdt) (or other) if \fI\-\-enumerate\fR is given.
 .br
 In the parameter code case \fIFL\fR is a value between 0 and 65535 (0xffff)
-and only the parameter section matching that code is output.
-The \fB\-\-hex\fR option outputs log parameter in hexadecimal rather than
-decoding it. If the \fB\-\-hex\fR option is used twice then the leading
-address on each line of hex is removed. If the \fB\-\-raw\fR option is
-given then the log parameter is output in binary.
+and only the parameter section matching that code is output. If the
+\fB\-\-hex\fR option is given the log parameter is output in hexadecimal
+rather than decoding it. If the \fB\-\-hex\fR option is used twice then the
+leading address on each line of hex is removed. If the \fB\-\-raw\fR option
+is given then the log parameter is output in binary.
 Most log pages contain one or more log parameters. Examples of those that
 don't are those pages that list supported log pages.
 .br
@@ -259,6 +271,21 @@ may also have the current temperature (especially on older disks).
 outputs the transport ('Protocol specific port') log page. Equivalent to
 setting '\-\-page=18h'.
 .TP
+\fB\-M\fR, \fB\-\-vendor\fR=\fIVP\fR
+where \fIVP\fR is a vendor (e.g. "sea" for Seagate) or product (group)
+acronym (e.g. "lto5" for the 5th generation LTO (tape) consortium). Either
+the whole log page is vendor specific (e.g. page numbers 0x30 to 0x3f) or
+part of a T10 defined log page is vendor specific. For example SPC\-5
+defines parameter code 0x0 of page 0x2f (the Informational Exceptions log
+page) and states that the remaining parameter codes (i.e. 0x1 to 0xffff)
+are vendor specific. Using a \fIVP\fR of "xxx" will list the available
+acronyms.
+.br
+If this option is used with \fI\-\-page=PG\fR and \fIPG\fR is an acronym
+then this option is ignored. If \fIPG\fR is a number (e.g. 0xc0) then
+\fIVP\fR is used to choose the which vendor specific page (e.g. sharing
+page number 0xc0) to decode.
+.TP
 \fB\-v\fR, \fB\-\-verbose\fR
 increase level of verbosity. When used with \fI\-\-enumerate\fR, in the
 list of known log page names, those that have no associated decode logic
@@ -344,10 +371,6 @@ Equivalent to \fI\-\-control=PC\fR in the main description.
 enumerate internal tables to show information about known log pages.
 Equivalent to \fI\-\-enumerate\fR in the main description.
 .TP
-\fB\-E\fR
-enumerate internal tables to show information about known vendor specific
-log pages. Equivalent to \fI\-\-enum_vendor\fR in the main description.
-.TP
 \fB\-h\fR
 suppresses decoding of known log sense pages and prints out the
 response in hex instead.
@@ -375,6 +398,9 @@ interpreted as all that is available. \fILEN\fR is decimal unless it has
 a leading '0x' or trailing 'h'.  Equivalent to \fI\-\-maxlen=LEN\fR in
 the main description.
 .TP
+\fB\-M\fR=\fIVP\fR
+Equivalent to \fI\-\-vendor=VP\fR in the main description.
+.TP
 \fB\-n\fR
 Equivalent to \fI\-\-name\fR in the main description.
 .TP

doc/sg_vpd.8

@@ -1,12 +1,12 @@
-.TH SG_VPD "8" "April 2016" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_VPD "8" "May 2016" "sg3_utils\-1.43" SG3_UTILS
 .SH NAME
 sg_vpd \- fetch SCSI VPD page and/or decode its response
 .SH SYNOPSIS
 .B sg_vpd
-[\fI\-\-all\fR] [\fI\-\-enumerate\fR] [\fI\-\-help\fR] [\fI\-\-hex\fR]
-[\fI\-\-ident\fR] [\fI\-\-inhex=FN\fR] [\fI\-\-long\fR] [\fI\-\-maxlen=LEN\fR]
-[\fI\-\-page=PG\fR] [\fI\-\-quiet\fR] [\fI\-\-raw\fR] [\fI\-\-vendor=VP\fR]
-[\fI\-\-force\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] [\fIDEVICE\fR]
+[\fI\-\-all\fR] [\fI\-\-enumerate\fR] [\fI\-\-force\fR] [\fI\-\-help\fR]
+[\fI\-\-hex\fR] [\fI\-\-ident\fR] [\fI\-\-inhex=FN\fR] [\fI\-\-long\fR]
+[\fI\-\-maxlen=LEN\fR] [\fI\-\-page=PG\fR] [\fI\-\-quiet\fR] [\fI\-\-raw\fR]
+[\fI\-\-vendor=VP\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] [\fIDEVICE\fR]
 .SH DESCRIPTION
 .\" Add any additional description here
 .PP

src/sg_inq.c

@@ -43,7 +43,7 @@
 #include "sg_unaligned.h"
 #include "sg_pr2serr.h"
 
-static const char * version_str = "1.62 20160510";    /* SPC-5 rev 10 */
+static const char * version_str = "1.63 20160531";    /* SPC-5 rev 10 */
 
 /* INQUIRY notes:
  * It is recommended that the initial allocation length given to a
@@ -3087,7 +3087,7 @@ vpd_fetch_page_from_dev(int sg_fd, unsigned char * rp, int page,
 static int
 fetch_unit_serial_num(int sg_fd, char * obuff, int obuff_len, int verbose)
 {
-    int len, k, res;
+    int len, k, res, c;
     unsigned char b[DEF_ALLOC_LEN];
 
     memset(b, 0xff, 4); /* guard against empty response */
@@ -3097,10 +3097,15 @@ fetch_unit_serial_num(int sg_fd, char * obuff, int obuff_len, int verbose)
         len -= 4;
         len = (len < (obuff_len - 1)) ? len : (obuff_len - 1);
         if (len > 0) {
-            /* replace non-printable ASCII characters with space */
-            for (k = 0; k < len; ++k)
-                obuff[k] = isprint(b[4 + k]) ? b[4 + k] : ' ';
-            obuff[len] = '\0';
+            /* replace non-printable characters (except NULL) with space */
+            for (k = 0; k < len; ++k) {
+                c = b[4 + k];
+                if (c)
+                    obuff[k] = isprint(c) ? c : ' ';
+                else
+                    break;
+            }
+            obuff[k] = '\0';
             return 0;
         } else {
             if (verbose > 2)