os_netbsd.cpp

   1 /*
   2  * os_netbsd.cpp
   3  *
   4  * Home page of code is: http://smartmontools.sourceforge.net
   5  *
   6  * Copyright (C) 2003-8 Sergey Svishchev <smartmontools-support@lists.sourceforge.net>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2, or (at your option)
  11  * any later version.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * (for example COPYING); if not, write to the Free
  15  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  16  *
  17  */
  18
  19 #include "config.h"
  20 #include "int64.h"
  21 #include "atacmds.h"
  22 #include "scsicmds.h"
  23 #include "utility.h"
  24 #include "os_netbsd.h"
  25 #include <unistd.h>
  26
  27 const char *os_XXXX_c_cvsid = "$Id: os_netbsd.cpp,v 1.24 2008/03/04 22:09:47 ballen4705 Exp $" \
  28 ATACMDS_H_CVSID CONFIG_H_CVSID INT64_H_CVSID OS_NETBSD_H_CVSID SCSICMDS_H_CVSID UTILITY_H_CVSID;
  29
  30 /* global variable holding byte count of allocated memory */
  31 extern long long bytes;
  32
  33 enum warnings {
  34   BAD_SMART, NO_3WARE, MAX_MSG
  35 };
  36
  37 /* Utility function for printing warnings */
  38 void
  39 printwarning(int msgNo, const char *extra)
  40 {
  41   static int printed[] = {0, 0};
  42   static const char *message[] = {
  43     "Error: SMART Status command failed.\nPlease get assistance from \n" PACKAGE_HOMEPAGE "\nRegister values returned from SMART Status command are:\n",
  44     PACKAGE_STRING " does not currently support twe(4) and twa(4) devices (3ware Escalade, Apache)\n",
  45   };
  46
  47   if (msgNo >= 0 && msgNo <= MAX_MSG) {
  48     if (!printed[msgNo]) {
  49       printed[msgNo] = 1;
  50       pout("%s", message[msgNo]);
  51       if (extra)
  52         pout("%s", extra);
  53     }
  54   }
  55   return;
  56 }
  57
  58 static const char *net_dev_prefix = "/dev/";
  59 static const char *net_dev_ata_disk = "wd";
  60 static const char *net_dev_scsi_disk = "sd";
  61 static const char *net_dev_scsi_tape = "enrst";
  62
  63 /* Guess device type (ATA or SCSI) based on device name */
  64 int
  65 guess_device_type(const char *dev_name)
  66 {
  67   int len;
  68   int dev_prefix_len = strlen(net_dev_prefix);
  69
  70   if (!dev_name || !(len = strlen(dev_name)))
  71     return CONTROLLER_UNKNOWN;
  72
  73   if (!strncmp(net_dev_prefix, dev_name, dev_prefix_len)) {
  74     if (len <= dev_prefix_len)
  75       return CONTROLLER_UNKNOWN;
  76     else
  77       dev_name += dev_prefix_len;
  78   }
  79   if (!strncmp(net_dev_ata_disk, dev_name, strlen(net_dev_ata_disk)))
  80     return CONTROLLER_ATA;
  81
  82   if (!strncmp(net_dev_scsi_disk, dev_name, strlen(net_dev_scsi_disk)))
  83     return CONTROLLER_SCSI;
  84
  85   if (!strncmp(net_dev_scsi_tape, dev_name, strlen(net_dev_scsi_tape)))
  86     return CONTROLLER_SCSI;
  87
  88   return CONTROLLER_UNKNOWN;
  89 }
  90
  91 int
  92 get_dev_names(char ***names, const char *prefix)
  93 {
  94   char *disknames, *p, **mp;
  95   int n = 0;
  96   int sysctl_mib[2];
  97   size_t sysctl_len;
  98
  99   *names = NULL;
 100
 101   sysctl_mib[0] = CTL_HW;
 102   sysctl_mib[1] = HW_DISKNAMES;
 103   if (-1 == sysctl(sysctl_mib, 2, NULL, &sysctl_len, NULL, 0)) {
 104     pout("Failed to get value of sysctl `hw.disknames'\n");
 105     return -1;
 106   }
 107   if (!(disknames = (char *)malloc(sysctl_len))) {
 108     pout("Out of memory constructing scan device list\n");
 109     return -1;
 110   }
 111   if (-1 == sysctl(sysctl_mib, 2, disknames, &sysctl_len, NULL, 0)) {
 112     pout("Failed to get value of sysctl `hw.disknames'\n");
 113     return -1;
 114   }
 115   if (!(mp = (char **) calloc(strlen(disknames) / 2, sizeof(char *)))) {
 116     pout("Out of memory constructing scan device list\n");
 117     return -1;
 118   }
 119   for (p = strtok(disknames, " "); p; p = strtok(NULL, " ")) {
 120     if (strncmp(p, prefix, strlen(prefix))) {
 121       continue;
 122     }
 123     mp[n] = (char *)malloc(strlen(net_dev_prefix) + strlen(p) + 2);
 124     if (!mp[n]) {
 125       pout("Out of memory constructing scan device list\n");
 126       return -1;
 127     }
 128     sprintf(mp[n], "%s%s%c", net_dev_prefix, p, 'a' + getrawpartition());
 129     bytes += strlen(mp[n]) + 1;
 130     n++;
 131   }
 132
 133   mp = (char **)realloc(mp, n * (sizeof(char *)));
 134   bytes += (n) * (sizeof(char *));
 135   *names = mp;
 136   return n;
 137 }
 138
 139 int
 140 make_device_names(char ***devlist, const char *name)
 141 {
 142   if (!strcmp(name, "SCSI"))
 143     return get_dev_names(devlist, net_dev_scsi_disk);
 144   else if (!strcmp(name, "ATA"))
 145     return get_dev_names(devlist, net_dev_ata_disk);
 146   else
 147     return 0;
 148 }
 149
 150 int
 151 deviceopen(const char *pathname, char *type)
 152 {
 153   if (!strcmp(type, "SCSI")) {
 154     int fd = open(pathname, O_RDWR | O_NONBLOCK);
 155     if (fd < 0 && errno == EROFS)
 156       fd = open(pathname, O_RDONLY | O_NONBLOCK);
 157     return fd;
 158   } else if (!strcmp(type, "ATA"))
 159     return open(pathname, O_RDWR | O_NONBLOCK);
 160   else
 161     return -1;
 162 }
 163
 164 int
 165 deviceclose(int fd)
 166 {
 167   return close(fd);
 168 }
 169
 170 int
 171 marvell_command_interface(int fd, smart_command_set command, int select, char *data)
 172 { return -1; }
 173
 174 int
 175 highpoint_command_interface(int fd, smart_command_set command, int select, char *data)
 176 { return -1; }
 177
 178 int
 179 ata_command_interface(int fd, smart_command_set command, int select, char *data)
 180 {
 181   struct atareq req;
 182   unsigned char inbuf[DEV_BSIZE];
 183   int retval, copydata = 0;
 184
 185   memset(&req, 0, sizeof(req));
 186   req.timeout = 1000;
 187
 188   memset(&inbuf, 0, sizeof(inbuf));
 189
 190   switch (command) {
 191   case READ_VALUES:
 192     req.flags = ATACMD_READ;
 193     req.features = WDSM_RD_DATA;
 194     req.command = WDCC_SMART;
 195     req.databuf = (char *)inbuf;
 196     req.datalen = sizeof(inbuf);
 197     req.cylinder = WDSMART_CYL;
 198     copydata = 1;
 199     break;
 200   case READ_THRESHOLDS:
 201     req.flags = ATACMD_READ;
 202     req.features = WDSM_RD_THRESHOLDS;
 203     req.command = WDCC_SMART;
 204     req.databuf = (char *)inbuf;
 205     req.datalen = sizeof(inbuf);
 206     req.cylinder = WDSMART_CYL;
 207     copydata = 1;
 208     break;
 209   case READ_LOG:
 210     req.flags = ATACMD_READ;
 211     req.features = ATA_SMART_READ_LOG_SECTOR;   /* XXX missing from wdcreg.h */
 212     req.command = WDCC_SMART;
 213     req.databuf = (char *)inbuf;
 214     req.datalen = sizeof(inbuf);
 215     req.cylinder = WDSMART_CYL;
 216     req.sec_num = select;
 217     req.sec_count = 1;
 218     copydata = 1;
 219     break;
 220   case WRITE_LOG:
 221     memcpy(inbuf, data, 512);
 222     req.flags = ATACMD_WRITE;
 223     req.features = ATA_SMART_WRITE_LOG_SECTOR;  /* XXX missing from wdcreg.h */
 224     req.command = WDCC_SMART;
 225     req.databuf = (char *)inbuf;
 226     req.datalen = sizeof(inbuf);
 227     req.cylinder = WDSMART_CYL;
 228     req.sec_num = select;
 229     req.sec_count = 1;
 230     break;
 231   case IDENTIFY:
 232     req.flags = ATACMD_READ;
 233     req.command = WDCC_IDENTIFY;
 234     req.databuf = (char *)inbuf;
 235     req.datalen = sizeof(inbuf);
 236     copydata = 1;
 237     break;
 238   case PIDENTIFY:
 239     req.flags = ATACMD_READ;
 240     req.command = ATAPI_IDENTIFY_DEVICE;
 241     req.databuf = (char *)inbuf;
 242     req.datalen = sizeof(inbuf);
 243     copydata = 1;
 244     break;
 245   case ENABLE:
 246     req.flags = ATACMD_READREG;
 247     req.features = WDSM_ENABLE_OPS;
 248     req.command = WDCC_SMART;
 249     req.cylinder = WDSMART_CYL;
 250     break;
 251   case DISABLE:
 252     req.flags = ATACMD_READREG;
 253     req.features = WDSM_DISABLE_OPS;
 254     req.command = WDCC_SMART;
 255     req.cylinder = WDSMART_CYL;
 256     break;
 257   case AUTO_OFFLINE:
 258     /* NOTE: According to ATAPI 4 and UP, this command is obsolete */
 259     req.flags = ATACMD_READREG;
 260     req.features = ATA_SMART_AUTO_OFFLINE;      /* XXX missing from wdcreg.h */
 261     req.command = WDCC_SMART;
 262     req.cylinder = WDSMART_CYL;
 263     req.sec_count = select;
 264     break;
 265   case AUTOSAVE:
 266     req.flags = ATACMD_READREG;
 267     req.features = ATA_SMART_AUTOSAVE;  /* XXX missing from wdcreg.h */
 268     req.command = WDCC_SMART;
 269     req.cylinder = WDSMART_CYL;
 270     req.sec_count = select;
 271     break;
 272   case IMMEDIATE_OFFLINE:
 273     /* NOTE: According to ATAPI 4 and UP, this command is obsolete */
 274     req.flags = ATACMD_READREG;
 275     req.features = ATA_SMART_IMMEDIATE_OFFLINE; /* XXX missing from wdcreg.h */
 276     req.command = WDCC_SMART;
 277     req.cylinder = WDSMART_CYL;
 278     req.sec_num = select;
 279     req.sec_count = 1;
 280     break;
 281   case STATUS:          /* should return 0 if SMART is enabled at all */
 282   case STATUS_CHECK:    /* should return 0 if disk's health is ok */
 283     req.flags = ATACMD_READREG;
 284     req.features = WDSM_STATUS;
 285     req.command = WDCC_SMART;
 286     req.cylinder = WDSMART_CYL;
 287     break;
 288   case CHECK_POWER_MODE:
 289     req.flags = ATACMD_READREG;
 290     req.command = WDCC_CHECK_PWR;
 291     break;
 292   default:
 293     pout("Unrecognized command %d in ata_command_interface()\n", command);
 294     errno = ENOSYS;
 295     return -1;
 296   }
 297
 298   if (command == STATUS_CHECK || command == AUTOSAVE || command == AUTO_OFFLINE) {
 299     char buf[512];
 300
 301     unsigned const short normal = WDSMART_CYL, failed = 0x2cf4;
 302
 303     if ((retval = ioctl(fd, ATAIOCCOMMAND, &req))) {
 304       perror("Failed command");
 305       return -1;
 306     }
 307     if (req.retsts != ATACMD_OK) {
 308       return -1;
 309     }
 310     /* Cyl low and Cyl high unchanged means "Good SMART status" */
 311     if (req.cylinder == normal)
 312       return 0;
 313
 314     /* These values mean "Bad SMART status" */
 315     if (req.cylinder == failed)
 316       return 1;
 317
 318     /* We haven't gotten output that makes sense;
 319      * print out some debugging info */
 320     snprintf(buf, sizeof(buf),
 321       "CMD=0x%02x\nFR =0x%02x\nNS =0x%02x\nSC =0x%02x\nCL =0x%02x\nCH =0x%02x\nRETURN =0x%04x\n",
 322       (int) req.command, (int) req.features, (int) req.sec_count, (int) req.sec_num,
 323       (int) (le16toh(req.cylinder) & 0xff), (int) ((le16toh(req.cylinder) >> 8) & 0xff),
 324       (int) req.error);
 325     printwarning(BAD_SMART, buf);
 326     return 0;
 327   }
 328
 329   if ((retval = ioctl(fd, ATAIOCCOMMAND, &req))) {
 330     perror("Failed command");
 331     return -1;
 332   }
 333   if (req.retsts != ATACMD_OK) {
 334     return -1;
 335   }
 336
 337   if (command == CHECK_POWER_MODE)
 338     data[0] = req.sec_count;
 339
 340   if (copydata)
 341     memcpy(data, inbuf, 512);
 342
 343   return 0;
 344 }
 345
 346 int
 347 escalade_command_interface(int fd, int disknum, int escalade_type, smart_command_set command, int select, char *data)
 348 {
 349   printwarning(NO_3WARE, NULL);
 350   return -1;
 351 }
 352
 353 int
 354 do_scsi_cmnd_io(int fd, struct scsi_cmnd_io * iop, int report)
 355 {
 356   struct scsireq sc;
 357
 358   if (report > 0) {
 359     size_t k;
 360
 361     const unsigned char *ucp = iop->cmnd;
 362     const char *np;
 363
 364     np = scsi_get_opcode_name(ucp[0]);
 365     pout(" [%s: ", np ? np : "<unknown opcode>");
 366     for (k = 0; k < iop->cmnd_len; ++k)
 367       pout("%02x ", ucp[k]);
 368     if ((report > 1) &&
 369       (DXFER_TO_DEVICE == iop->dxfer_dir) && (iop->dxferp)) {
 370       int trunc = (iop->dxfer_len > 256) ? 1 : 0;
 371
 372       pout("]\n  Outgoing data, len=%d%s:\n", (int) iop->dxfer_len,
 373         (trunc ? " [only first 256 bytes shown]" : ""));
 374       dStrHex(iop->dxferp, (trunc ? 256 : iop->dxfer_len), 1);
 375     } else
 376       pout("]");
 377   }
 378   memset(&sc, 0, sizeof(sc));
 379   memcpy(sc.cmd, iop->cmnd, iop->cmnd_len);
 380   sc.cmdlen = iop->cmnd_len;
 381   sc.databuf = (char *)iop->dxferp;
 382   sc.datalen = iop->dxfer_len;
 383   sc.senselen = iop->max_sense_len;
 384   sc.timeout = iop->timeout == 0 ? 60000 : (1000 * iop->timeout);
 385   sc.flags =
 386     (iop->dxfer_dir == DXFER_NONE ? SCCMD_READ :
 387     (iop->dxfer_dir == DXFER_FROM_DEVICE ? SCCMD_READ : SCCMD_WRITE));
 388
 389   if (ioctl(fd, SCIOCCOMMAND, &sc) < 0) {
 390     warn("error sending SCSI ccb");
 391     return -1;
 392   }
 393   iop->resid = sc.datalen - sc.datalen_used;
 394   iop->scsi_status = sc.status;
 395   if (iop->sensep) {
 396     memcpy(iop->sensep, sc.sense, sc.senselen_used);
 397     iop->resp_sense_len = sc.senselen_used;
 398   }
 399   if (report > 0) {
 400     int trunc;
 401
 402     pout("  status=0\n");
 403     trunc = (iop->dxfer_len > 256) ? 1 : 0;
 404
 405     pout("  Incoming data, len=%d%s:\n", (int) iop->dxfer_len,
 406       (trunc ? " [only first 256 bytes shown]" : ""));
 407     dStrHex(iop->dxferp, (trunc ? 256 : iop->dxfer_len), 1);
 408   }
 409   switch (sc.retsts) {
 410     case SCCMD_OK:
 411       return 0;
 412     case SCCMD_TIMEOUT:
 413       return -ETIMEDOUT;
 414     case SCCMD_BUSY:
 415       return -EBUSY;
 416     default:
 417       return -EIO;
 418   }
 419 }
 420
 421 /* print examples for smartctl */
 422 void
 423 print_smartctl_examples()
 424 {
 425   char p;
 426
 427   p = 'a' + getrawpartition();
 428   printf("=================================================== SMARTCTL EXAMPLES =====\n\n");
 429 #ifdef HAVE_GETOPT_LONG
 430   printf(
 431     "  smartctl -a /dev/wd0%c                      (Prints all SMART information)\n\n"
 432     "  smartctl --smart=on --offlineauto=on --saveauto=on /dev/wd0%c\n"
 433     "                                              (Enables SMART on first disk)\n\n"
 434     "  smartctl -t long /dev/wd0%c             (Executes extended disk self-test)\n\n"
 435     "  smartctl --attributes --log=selftest --quietmode=errorsonly /dev/wd0%c\n"
 436     "                                      (Prints Self-Test & Attribute errors)\n",
 437     p, p, p, p
 438     );
 439 #else
 440   printf(
 441     "  smartctl -a /dev/wd0%c                     (Prints all SMART information)\n"
 442     "  smartctl -s on -o on -S on /dev/wd0%c        (Enables SMART on first disk)\n"
 443     "  smartctl -t long /dev/wd0%c            (Executes extended disk self-test)\n"
 444     "  smartctl -A -l selftest -q errorsonly /dev/wd0%c"
 445     "                                      (Prints Self-Test & Attribute errors)\n",
 446     p, p, p, p
 447     );
 448 #endif
 449   return;
 450 }