Changeset 3249

Timestamp:

01/31/11 20:33:37 (2 years ago)

Author:

chrfranke

Message:

smartctl: Print help message if no option is specified (ticket #39).
Don't issue any other ATA command if only '-n POWERMODE' is specified.

Location:

trunk/smartmontools

Files:

• CHANGELOG (modified) (1 diff)
• ataprint.cpp (modified) (6 diffs)
• scsiprint.cpp (modified) (16 diffs)
• smartctl.8.in (modified) (3 diffs)

trunk/smartmontools/CHANGELOG

@@ -41 +41 @@
 <DEVELOPERS: ADDITIONS TO THE CHANGE LOG GO JUST BELOW HERE, PLEASE>
 
+  [CF] smartctl: Print help message if no option is specified (ticket #39).
+       Don't issue any other ATA command if only '-n POWERMODE' is specified.
+
   [CF] smartd: Output multiple lines via separate syslog(3) calls
        (ticket #135).

trunk/smartmontools/ataprint.cpp

@@ -1762 +1762 @@
 int ataPrintMain (ata_device * device, const ata_print_options & options)
 {
-  int returnval = 0;
-
   // If requested, check power mode first
   const char * powername = 0;
@@ -1773 +1771 @@
       case -1:
         if (errno == ENOSYS) {
-          pout("CHECK POWER STATUS not implemented, ignoring -n Option\n"); break;
+          pout("CHECK POWER MODE not implemented, ignoring -n option\n"); break;
         }
         powername = "SLEEP";   powerlimit = 2;
@@ -1784 +1782 @@
         powername = "ACTIVE or IDLE"; break;
       default:
-        pout("CHECK POWER STATUS returned %d, not ATA compliant, ignoring -n Option\n", powermode);
+        pout("CHECK POWER MODE returned unknown value 0x%02x, ignoring -n option\n", powermode);
         break;
     }
@@ -1825 +1823 @@
   );
 
+  // SMART and GP log directories needed ?
+  bool need_smart_logdir = options.smart_logdir;
+
+  bool need_gp_logdir  = (
+          options.gp_logdir
+       || options.smart_ext_error_log
+       || options.smart_ext_selftest_log
+       || options.sataphy
+  );
+
+  unsigned i;
+  for (i = 0; i < options.log_requests.size(); i++) {
+    if (options.log_requests[i].gpl)
+      need_gp_logdir = true;
+    else
+      need_smart_logdir = true;
+  }
+
+  // SCT commands needed ?
+  bool need_sct_support = (
+          options.sct_temp_sts
+       || options.sct_temp_hist
+       || options.sct_temp_int
+       || options.sct_erc_get
+       || options.sct_erc_set
+  );
+
+  // Exit if no further options specified
+  if (!(   options.drive_info || need_smart_support
+        || need_smart_logdir  || need_gp_logdir
+        || need_sct_support                        )) {
+    if (powername)
+      pout("Device is in %s mode\n", powername);
+    else
+      pout("ATA device successfully opened\n\n"
+           "Use 'smartctl -a' (or '-x') to print SMART (and more) information\n\n");
+    return 0;
+  }
+
   // Start by getting Drive ID information.  We need this, to know if SMART is supported.
+  int returnval = 0;
   ata_identify_device drive; memset(&drive, 0, sizeof(drive));
   int retid = ataReadHDIdentity(device,&drive);
@@ -2147 +2185 @@
   }
 
-  // SMART and GP log directories needed?
-  bool need_smart_logdir = (
-          options.smart_logdir
-          // If GP Log is supported use smart log directory for
-          // error and selftest log support check.
-       || (   isGeneralPurposeLoggingCapable(&drive)
-           && (   options.smart_error_log || options.smart_selftest_log
-               || options.retry_error_log || options.retry_selftest_log))
-  );
-
-  bool need_gp_logdir  = (
-          options.gp_logdir
-       || options.smart_ext_error_log
-       || options.smart_ext_selftest_log
-       || options.sataphy
-  );
-
-  unsigned i;
-  for (i = 0; i < options.log_requests.size(); i++) {
-    if (options.log_requests[i].gpl)
-      need_gp_logdir = true;
-    else
-      need_smart_logdir = true;
-  }
+  // If GP Log is supported use smart log directory for
+  // error and selftest log support check.
+  if (   isGeneralPurposeLoggingCapable(&drive)
+      && (   options.smart_error_log || options.smart_selftest_log
+          || options.retry_error_log || options.retry_selftest_log))
+    need_smart_logdir = true;
 
   ata_smart_log_directory smartlogdir_buf, gplogdir_buf;
@@ -2375 +2395 @@
   // SCT commands
   bool sct_ok = false;
-  if (   options.sct_temp_sts || options.sct_temp_hist || options.sct_temp_int
-      || options.sct_erc_get  || options.sct_erc_set                          ) {
+  if (need_sct_support) {
     if (!isSCTCapable(&drive)) {
       pout("Warning: device does not support SCT Commands\n");

trunk/smartmontools/scsiprint.cpp

@@ -1571 +1571 @@
     int res, durationSec;
 
+    bool any_output = options.drive_info;
+
     res = scsiGetDriveInfo(device, &peripheral_type, options.drive_info);
     if (res) {
@@ -1577 +1579 @@
         else
             failuretest(MANDATORY_CMD, returnval |= FAILID);
+        any_output = true;
     }
 
@@ -1582 +1585 @@
         if (scsiSmartEnable(device))
             failuretest(MANDATORY_CMD, returnval |= FAILSMART);
+        any_output = true;
     }
 
@@ -1587 +1591 @@
         if (scsiSmartDisable(device))
             failuretest(MANDATORY_CMD,returnval |= FAILSMART);
+        any_output = true;
     }
     
@@ -1594 +1599 @@
         failuretest(OPTIONAL_CMD,returnval |= FAILSMART);
       }
+      any_output = true;
     }
     
@@ -1601 +1607 @@
         failuretest(OPTIONAL_CMD,returnval |= FAILSMART);
       }
+      any_output = true;
     }
     
@@ -1624 +1631 @@
             }
         }
+        any_output = true;
     }   
     if (options.smart_vendor_attrib) {
@@ -1642 +1650 @@
                 scsiPrintSeagateFactoryLPage(device);
         }
+        any_output = true;
     }
     if (options.smart_error_log) {
@@ -1650 +1659 @@
             pout("\n[GLTSD (Global Logging Target Save Disable) set. "
                  "Enable Save with '-S on']\n");
+        any_output = true;
     }
     if (options.smart_selftest_log) {
@@ -1663 +1673 @@
         if (0 != res)
             failuretest(OPTIONAL_CMD, returnval|=res);
+        any_output = true;
     }
     if (options.smart_background_log) {
@@ -1676 +1687 @@
         if (0 != res)
             failuretest(OPTIONAL_CMD, returnval|=res);
+        any_output = true;
     }
     if (options.smart_default_selftest) {
@@ -1681 +1693 @@
             return returnval | FAILSMART;
         pout("Default Self Test Successful\n");
+        any_output = true;
     }
     if (options.smart_short_cap_selftest) {
@@ -1686 +1699 @@
             return returnval | FAILSMART;
         pout("Short Foreground Self Test Successful\n");
+        any_output = true;
     }
     if (options.smart_short_selftest) {
@@ -1692 +1706 @@
         pout("Short Background Self Test has begun\n");
         pout("Use smartctl -X to abort test\n");
+        any_output = true;
     }
     if (options.smart_extend_selftest) {
@@ -1707 +1722 @@
         }
         pout("Use smartctl -X to abort test\n");        
+        any_output = true;
     }
     if (options.smart_extend_cap_selftest) {
@@ -1717 +1733 @@
             return returnval | FAILSMART;
         pout("Self Test returned without error\n");
+        any_output = true;
     }           
     if (options.sasphy) {
         if (scsiPrintSasPhy(device, options.sasphy_reset))
             return returnval | FAILSMART;
+        any_output = true;
     }           
+
+    if (!any_output)
+      pout("SCSI device successfully opened\n\n"
+           "Use 'smartctl -a' (or '-x') to print SMART (and more) information\n\n");
+
     return returnval;
 }

trunk/smartmontools/smartctl.8.in

@@ -544 +544 @@
 checks when the device is in a low\-power mode. It may be used to prevent
 a disk from being spun\-up by \fBsmartctl\fP. The power mode is ignored by
-default. The allowed values of POWERMODE are:
+default.  A nonzero exit status is returned if the device is in one of the
+specified low\-power modes (see RETURN VALUES below).
+
+Note: If this option is used it may also be necessary to specify the device
+type with the \'-d\' option.  Otherwise the device may spin up due to
+commands issued during device type autodetection.
+
+The valid arguments to this option are:
 
 .I never
@@ -1671 +1678 @@
 .B smartctl \-a /dev/sdb
 .fi
-Print a large amount of SMART information for drive /dev/sda . This may
+Print a large amount of SMART information for drive /dev/sdb . This may
 be a SCSI disk or an ATA (SATA) disk.
 .PP
@@ -1803 +1810 @@
 .TP
 .B Bit 1:
-Device open failed, or device did not return an IDENTIFY DEVICE structure. 
+Device open failed, device did not return an IDENTIFY DEVICE structure,
+or device is in a low-power mode (see \'\-n\' option above).
 .TP
 .B Bit 2: