extras/scsi_id/scsi_serial.c

   1 /*
   2  * Copyright (C) IBM Corp. 2003
   3  *
   4  * Author:
   5  *      Patrick Mansfield<patmans@us.ibm.com>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify it
   8  *      under the terms of the GNU General Public License as published by the
   9  *      Free Software Foundation version 2 of the License.
  10  */
  11
  12 #include <sys/types.h>
  13 #include <sys/ioctl.h>
  14 #include <sys/stat.h>
  15 #include <stdio.h>
  16 #include <errno.h>
  17 #include <string.h>
  18 #include <fcntl.h>
  19 #include <stdlib.h>
  20 #include <unistd.h>
  21 #include <syslog.h>
  22 #include <time.h>
  23 #include <inttypes.h>
  24 #include <scsi/scsi.h>
  25 #include <scsi/sg.h>
  26 #include <linux/types.h>
  27 #include <linux/bsg.h>
  28
  29 #include "libudev.h"
  30 #include "libudev-private.h"
  31 #include "scsi.h"
  32 #include "scsi_id.h"
  33
  34 /*
  35  * A priority based list of id, naa, and binary/ascii for the identifier
  36  * descriptor in VPD page 0x83.
  37  *
  38  * Brute force search for a match starting with the first value in the
  39  * following id_search_list. This is not a performance issue, since there
  40  * is normally one or some small number of descriptors.
  41  */
  42 static const struct scsi_id_search_values id_search_list[] = {
  43         { SCSI_ID_NAA,  SCSI_ID_NAA_IEEE_REG_EXTENDED,  SCSI_ID_BINARY },
  44         { SCSI_ID_NAA,  SCSI_ID_NAA_IEEE_REG_EXTENDED,  SCSI_ID_ASCII },
  45         { SCSI_ID_NAA,  SCSI_ID_NAA_IEEE_REG,   SCSI_ID_BINARY },
  46         { SCSI_ID_NAA,  SCSI_ID_NAA_IEEE_REG,   SCSI_ID_ASCII },
  47         /*
  48          * Devices already exist using NAA values that are now marked
  49          * reserved. These should not conflict with other values, or it is
  50          * a bug in the device. As long as we find the IEEE extended one
  51          * first, we really don't care what other ones are used. Using
  52          * don't care here means that a device that returns multiple
  53          * non-IEEE descriptors in a random order will get different
  54          * names.
  55          */
  56         { SCSI_ID_NAA,  SCSI_ID_NAA_DONT_CARE,  SCSI_ID_BINARY },
  57         { SCSI_ID_NAA,  SCSI_ID_NAA_DONT_CARE,  SCSI_ID_ASCII },
  58         { SCSI_ID_EUI_64,       SCSI_ID_NAA_DONT_CARE,  SCSI_ID_BINARY },
  59         { SCSI_ID_EUI_64,       SCSI_ID_NAA_DONT_CARE,  SCSI_ID_ASCII },
  60         { SCSI_ID_T10_VENDOR,   SCSI_ID_NAA_DONT_CARE,  SCSI_ID_BINARY },
  61         { SCSI_ID_T10_VENDOR,   SCSI_ID_NAA_DONT_CARE,  SCSI_ID_ASCII },
  62         { SCSI_ID_VENDOR_SPECIFIC,      SCSI_ID_NAA_DONT_CARE,  SCSI_ID_BINARY },
  63         { SCSI_ID_VENDOR_SPECIFIC,      SCSI_ID_NAA_DONT_CARE,  SCSI_ID_ASCII },
  64 };
  65
  66 static const char hex_str[]="0123456789abcdef";
  67
  68 /*
  69  * Values returned in the result/status, only the ones used by the code
  70  * are used here.
  71  */
  72
  73 #define DID_NO_CONNECT                  0x01    /* Unable to connect before timeout */
  74 #define DID_BUS_BUSY                    0x02    /* Bus remain busy until timeout */
  75 #define DID_TIME_OUT                    0x03    /* Timed out for some other reason */
  76 #define DRIVER_TIMEOUT                  0x06
  77 #define DRIVER_SENSE                    0x08    /* Sense_buffer has been set */
  78
  79 /* The following "category" function returns one of the following */
  80 #define SG_ERR_CAT_CLEAN                0       /* No errors or other information */
  81 #define SG_ERR_CAT_MEDIA_CHANGED        1       /* interpreted from sense buffer */
  82 #define SG_ERR_CAT_RESET                2       /* interpreted from sense buffer */
  83 #define SG_ERR_CAT_TIMEOUT              3
  84 #define SG_ERR_CAT_RECOVERED            4       /* Successful command after recovered err */
  85 #define SG_ERR_CAT_NOTSUPPORTED         5       /* Illegal / unsupported command */
  86 #define SG_ERR_CAT_SENSE                98      /* Something else in the sense buffer */
  87 #define SG_ERR_CAT_OTHER                99      /* Some other error/warning */
  88
  89 static int do_scsi_page80_inquiry(struct udev *udev,
  90                                   struct scsi_id_device *dev_scsi, int fd,
  91                                   char *serial, char *serial_short, int max_len);
  92
  93 static int sg_err_category_new(struct udev *udev,
  94                                int scsi_status, int msg_status, int
  95                                host_status, int driver_status, const
  96                                unsigned char *sense_buffer, int sb_len)
  97 {
  98         scsi_status &= 0x7e;
  99
 100         /*
 101          * XXX change to return only two values - failed or OK.
 102          */
 103
 104         if (!scsi_status && !host_status && !driver_status)
 105                 return SG_ERR_CAT_CLEAN;
 106
 107         if ((scsi_status == SCSI_CHECK_CONDITION) ||
 108             (scsi_status == SCSI_COMMAND_TERMINATED) ||
 109             ((driver_status & 0xf) == DRIVER_SENSE)) {
 110                 if (sense_buffer && (sb_len > 2)) {
 111                         int sense_key;
 112                         unsigned char asc;
 113
 114                         if (sense_buffer[0] & 0x2) {
 115                                 sense_key = sense_buffer[1] & 0xf;
 116                                 asc = sense_buffer[2];
 117                         } else {
 118                                 sense_key = sense_buffer[2] & 0xf;
 119                                 asc = (sb_len > 12) ? sense_buffer[12] : 0;
 120                         }
 121
 122                         if (sense_key == RECOVERED_ERROR)
 123                                 return SG_ERR_CAT_RECOVERED;
 124                         else if (sense_key == UNIT_ATTENTION) {
 125                                 if (0x28 == asc)
 126                                         return SG_ERR_CAT_MEDIA_CHANGED;
 127                                 if (0x29 == asc)
 128                                         return SG_ERR_CAT_RESET;
 129                         } else if (sense_key == ILLEGAL_REQUEST) {
 130                                 return SG_ERR_CAT_NOTSUPPORTED;
 131                         }
 132                 }
 133                 return SG_ERR_CAT_SENSE;
 134         }
 135         if (!host_status) {
 136                 if ((host_status == DID_NO_CONNECT) ||
 137                     (host_status == DID_BUS_BUSY) ||
 138                     (host_status == DID_TIME_OUT))
 139                         return SG_ERR_CAT_TIMEOUT;
 140         }
 141         if (!driver_status) {
 142                 if (driver_status == DRIVER_TIMEOUT)
 143                         return SG_ERR_CAT_TIMEOUT;
 144         }
 145         return SG_ERR_CAT_OTHER;
 146 }
 147
 148 static int sg_err_category3(struct udev *udev, struct sg_io_hdr *hp)
 149 {
 150         return sg_err_category_new(udev,
 151                                    hp->status, hp->msg_status,
 152                                    hp->host_status, hp->driver_status,
 153                                    hp->sbp, hp->sb_len_wr);
 154 }
 155
 156 static int sg_err_category4(struct udev *udev, struct sg_io_v4 *hp)
 157 {
 158         return sg_err_category_new(udev, hp->device_status, 0,
 159                                    hp->transport_status, hp->driver_status,
 160                                    (unsigned char *)(uintptr_t)hp->response,
 161                                    hp->response_len);
 162 }
 163
 164 static int scsi_dump_sense(struct udev *udev,
 165                            struct scsi_id_device *dev_scsi,
 166                            unsigned char *sense_buffer, int sb_len)
 167 {
 168         int s;
 169         int code;
 170         int sense_class;
 171         int sense_key;
 172         int asc, ascq;
 173 #ifdef DUMP_SENSE
 174         char out_buffer[256];
 175         int i, j;
 176 #endif
 177
 178         /*
 179          * Figure out and print the sense key, asc and ascq.
 180          *
 181          * If you want to suppress these for a particular drive model, add
 182          * a black list entry in the scsi_id config file.
 183          *
 184          * XXX We probably need to: lookup the sense/asc/ascq in a retry
 185          * table, and if found return 1 (after dumping the sense, asc, and
 186          * ascq). So, if/when we get something like a power on/reset,
 187          * we'll retry the command.
 188          */
 189
 190         dbg(udev, "got check condition\n");
 191
 192         if (sb_len < 1) {
 193                 info(udev, "%s: sense buffer empty\n", dev_scsi->kernel);
 194                 return -1;
 195         }
 196
 197         sense_class = (sense_buffer[0] >> 4) & 0x07;
 198         code = sense_buffer[0] & 0xf;
 199
 200         if (sense_class == 7) {
 201                 /*
 202                  * extended sense data.
 203                  */
 204                 s = sense_buffer[7] + 8;
 205                 if (sb_len < s) {
 206                         info(udev, "%s: sense buffer too small %d bytes, %d bytes too short\n",
 207                             dev_scsi->kernel, sb_len, s - sb_len);
 208                         return -1;
 209                 }
 210                 if ((code == 0x0) || (code == 0x1)) {
 211                         sense_key = sense_buffer[2] & 0xf;
 212                         if (s < 14) {
 213                                 /*
 214                                  * Possible?
 215                                  */
 216                                 info(udev, "%s: sense result too" " small %d bytes\n",
 217                                     dev_scsi->kernel, s);
 218                                 return -1;
 219                         }
 220                         asc = sense_buffer[12];
 221                         ascq = sense_buffer[13];
 222                 } else if ((code == 0x2) || (code == 0x3)) {
 223                         sense_key = sense_buffer[1] & 0xf;
 224                         asc = sense_buffer[2];
 225                         ascq = sense_buffer[3];
 226                 } else {
 227                         info(udev, "%s: invalid sense code 0x%x\n",
 228                             dev_scsi->kernel, code);
 229                         return -1;
 230                 }
 231                 info(udev, "%s: sense key 0x%x ASC 0x%x ASCQ 0x%x\n",
 232                     dev_scsi->kernel, sense_key, asc, ascq);
 233         } else {
 234                 if (sb_len < 4) {
 235                         info(udev, "%s: sense buffer too small %d bytes, %d bytes too short\n",
 236                             dev_scsi->kernel, sb_len, 4 - sb_len);
 237                         return -1;
 238                 }
 239
 240                 if (sense_buffer[0] < 15)
 241                         info(udev, "%s: old sense key: 0x%x\n", dev_scsi->kernel, sense_buffer[0] & 0x0f);
 242                 else
 243                         info(udev, "%s: sense = %2x %2x\n",
 244                             dev_scsi->kernel, sense_buffer[0], sense_buffer[2]);
 245                 info(udev, "%s: non-extended sense class %d code 0x%0x\n",
 246                     dev_scsi->kernel, sense_class, code);
 247
 248         }
 249
 250 #ifdef DUMP_SENSE
 251         for (i = 0, j = 0; (i < s) && (j < 254); i++) {
 252                 dbg(udev, "i %d, j %d\n", i, j);
 253                 out_buffer[j++] = hex_str[(sense_buffer[i] & 0xf0) >> 4];
 254                 out_buffer[j++] = hex_str[sense_buffer[i] & 0x0f];
 255                 out_buffer[j++] = ' ';
 256         }
 257         out_buffer[j] = '\0';
 258         info(udev, "%s: sense dump:\n", dev_scsi->kernel);
 259         info(udev, "%s: %s\n", dev_scsi->kernel, out_buffer);
 260
 261 #endif
 262         return -1;
 263 }
 264
 265 static int scsi_dump(struct udev *udev,
 266                      struct scsi_id_device *dev_scsi, struct sg_io_hdr *io)
 267 {
 268         if (!io->status && !io->host_status && !io->msg_status &&
 269             !io->driver_status) {
 270                 /*
 271                  * Impossible, should not be called.
 272                  */
 273                 info(udev, "%s: called with no error\n", __FUNCTION__);
 274                 return -1;
 275         }
 276
 277         info(udev, "%s: sg_io failed status 0x%x 0x%x 0x%x 0x%x\n",
 278             dev_scsi->kernel, io->driver_status, io->host_status, io->msg_status, io->status);
 279         if (io->status == SCSI_CHECK_CONDITION)
 280                 return scsi_dump_sense(udev, dev_scsi, io->sbp, io->sb_len_wr);
 281         else
 282                 return -1;
 283 }
 284
 285 static int scsi_dump_v4(struct udev *udev,
 286                         struct scsi_id_device *dev_scsi, struct sg_io_v4 *io)
 287 {
 288         if (!io->device_status && !io->transport_status &&
 289             !io->driver_status) {
 290                 /*
 291                  * Impossible, should not be called.
 292                  */
 293                 info(udev, "%s: called with no error\n", __FUNCTION__);
 294                 return -1;
 295         }
 296
 297         info(udev, "%s: sg_io failed status 0x%x 0x%x 0x%x\n",
 298             dev_scsi->kernel, io->driver_status, io->transport_status,
 299              io->device_status);
 300         if (io->device_status == SCSI_CHECK_CONDITION)
 301                 return scsi_dump_sense(udev, dev_scsi, (unsigned char *)(uintptr_t)io->response,
 302                                        io->response_len);
 303         else
 304                 return -1;
 305 }
 306
 307 static int scsi_inquiry(struct udev *udev,
 308                         struct scsi_id_device *dev_scsi, int fd,
 309                         unsigned char evpd, unsigned char page,
 310                         unsigned char *buf, unsigned int buflen)
 311 {
 312         unsigned char inq_cmd[INQUIRY_CMDLEN] =
 313                 { INQUIRY_CMD, evpd, page, 0, buflen, 0 };
 314         unsigned char sense[SENSE_BUFF_LEN];
 315         void *io_buf;
 316         int retval;
 317         int retry = 3; /* rather random */
 318
 319         if (buflen > SCSI_INQ_BUFF_LEN) {
 320                 info(udev, "buflen %d too long\n", buflen);
 321                 return -1;
 322         }
 323
 324 resend:
 325         dbg(udev, "%s evpd %d, page 0x%x\n", dev_scsi->kernel, evpd, page);
 326
 327         if (dev_scsi->use_sg == 4) {
 328                 struct sg_io_v4 io_v4;
 329
 330                 memset(&io_v4, 0, sizeof(struct sg_io_v4));
 331                 io_v4.guard = 'Q';
 332                 io_v4.protocol = BSG_PROTOCOL_SCSI;
 333                 io_v4.subprotocol = BSG_SUB_PROTOCOL_SCSI_CMD;
 334                 io_v4.request_len = sizeof(inq_cmd);
 335                 io_v4.request = (uintptr_t)inq_cmd;
 336                 io_v4.max_response_len = sizeof(sense);
 337                 io_v4.response = (uintptr_t)sense;
 338                 io_v4.din_xfer_len = buflen;
 339                 io_v4.din_xferp = (uintptr_t)buf;
 340                 io_buf = (void *)&io_v4;
 341         } else {
 342                 struct sg_io_hdr io_hdr;
 343
 344                 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
 345                 io_hdr.interface_id = 'S';
 346                 io_hdr.cmd_len = sizeof(inq_cmd);
 347                 io_hdr.mx_sb_len = sizeof(sense);
 348                 io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
 349                 io_hdr.dxfer_len = buflen;
 350                 io_hdr.dxferp = buf;
 351                 io_hdr.cmdp = inq_cmd;
 352                 io_hdr.sbp = sense;
 353                 io_hdr.timeout = DEF_TIMEOUT;
 354                 io_buf = (void *)&io_hdr;
 355         }
 356
 357         retval = ioctl(fd, SG_IO, io_buf);
 358         if (retval < 0) {
 359                 if ((errno == EINVAL || errno == ENOSYS) && dev_scsi->use_sg == 4) {
 360                         dev_scsi->use_sg = 3;
 361                         goto resend;
 362                 }
 363                 info(udev, "%s: ioctl failed: %s\n", dev_scsi->kernel, strerror(errno));
 364                 goto error;
 365         }
 366
 367         if (dev_scsi->use_sg == 4)
 368                 retval = sg_err_category4(udev, io_buf);
 369         else
 370                 retval = sg_err_category3(udev, io_buf);
 371
 372         switch (retval) {
 373                 case SG_ERR_CAT_NOTSUPPORTED:
 374                         buf[1] = 0;
 375                         /* Fallthrough */
 376                 case SG_ERR_CAT_CLEAN:
 377                 case SG_ERR_CAT_RECOVERED:
 378                         retval = 0;
 379                         break;
 380
 381                 default:
 382                         if (dev_scsi->use_sg == 4)
 383                                 retval = scsi_dump_v4(udev, dev_scsi, io_buf);
 384                         else
 385                                 retval = scsi_dump(udev, dev_scsi, io_buf);
 386         }
 387
 388         if (!retval) {
 389                 retval = buflen;
 390         } else if (retval > 0) {
 391                 if (--retry > 0) {
 392                         dbg(udev, "%s: Retrying ...\n", dev_scsi->kernel);
 393                         goto resend;
 394                 }
 395                 retval = -1;
 396         }
 397
 398 error:
 399         if (retval < 0)
 400                 info(udev, "%s: Unable to get INQUIRY vpd %d page 0x%x.\n",
 401                     dev_scsi->kernel, evpd, page);
 402
 403         return retval;
 404 }
 405
 406 /* Get list of supported EVPD pages */
 407 static int do_scsi_page0_inquiry(struct udev *udev,
 408                                  struct scsi_id_device *dev_scsi, int fd,
 409                                  unsigned char *buffer, unsigned int len)
 410 {
 411         int retval;
 412
 413         memset(buffer, 0, len);
 414         retval = scsi_inquiry(udev, dev_scsi, fd, 1, 0x0, buffer, len);
 415         if (retval < 0)
 416                 return 1;
 417
 418         if (buffer[1] != 0) {
 419                 info(udev, "%s: page 0 not available.\n", dev_scsi->kernel);
 420                 return 1;
 421         }
 422         if (buffer[3] > len) {
 423                 info(udev, "%s: page 0 buffer too long %d\n", dev_scsi->kernel,  buffer[3]);
 424                 return 1;
 425         }
 426
 427         /*
 428          * Following check is based on code once included in the 2.5.x
 429          * kernel.
 430          *
 431          * Some ill behaved devices return the standard inquiry here
 432          * rather than the evpd data, snoop the data to verify.
 433          */
 434         if (buffer[3] > MODEL_LENGTH) {
 435                 /*
 436                  * If the vendor id appears in the page assume the page is
 437                  * invalid.
 438                  */
 439                 if (!strncmp((char *)&buffer[VENDOR_LENGTH], dev_scsi->vendor, VENDOR_LENGTH)) {
 440                         info(udev, "%s: invalid page0 data\n", dev_scsi->kernel);
 441                         return 1;
 442                 }
 443         }
 444         return 0;
 445 }
 446
 447 /*
 448  * The caller checks that serial is long enough to include the vendor +
 449  * model.
 450  */
 451 static int prepend_vendor_model(struct udev *udev,
 452                                 struct scsi_id_device *dev_scsi, char *serial)
 453 {
 454         int ind;
 455
 456         strncpy(serial, dev_scsi->vendor, VENDOR_LENGTH);
 457         strncat(serial, dev_scsi->model, MODEL_LENGTH);
 458         ind = strlen(serial);
 459
 460         /*
 461          * This is not a complete check, since we are using strncat/cpy
 462          * above, ind will never be too large.
 463          */
 464         if (ind != (VENDOR_LENGTH + MODEL_LENGTH)) {
 465                 info(udev, "%s: expected length %d, got length %d\n",
 466                      dev_scsi->kernel, (VENDOR_LENGTH + MODEL_LENGTH), ind);
 467                 return -1;
 468         }
 469         return ind;
 470 }
 471
 472 /**
 473  * check_fill_0x83_id - check the page 0x83 id, if OK allocate and fill
 474  * serial number.
 475  **/
 476 static int check_fill_0x83_id(struct udev *udev,
 477                               struct scsi_id_device *dev_scsi,
 478                               unsigned char *page_83,
 479                               const struct scsi_id_search_values
 480                               *id_search, char *serial, char *serial_short, int max_len,
 481                               char *wwn,
 482                               char *wwn_vendor_extension)
 483 {
 484         int i, j, s, len;
 485
 486         /*
 487          * ASSOCIATION must be with the device (value 0)
 488          */
 489         if ((page_83[1] & 0x30) != 0)
 490                 return 1;
 491
 492         if ((page_83[1] & 0x0f) != id_search->id_type)
 493                 return 1;
 494
 495         /*
 496          * Possibly check NAA sub-type.
 497          */
 498         if ((id_search->naa_type != SCSI_ID_NAA_DONT_CARE) &&
 499             (id_search->naa_type != (page_83[4] & 0xf0) >> 4))
 500                 return 1;
 501
 502         /*
 503          * Check for matching code set - ASCII or BINARY.
 504          */
 505         if ((page_83[0] & 0x0f) != id_search->code_set)
 506                 return 1;
 507
 508         /*
 509          * page_83[3]: identifier length
 510          */
 511         len = page_83[3];
 512         if ((page_83[0] & 0x0f) != SCSI_ID_ASCII)
 513                 /*
 514                  * If not ASCII, use two bytes for each binary value.
 515                  */
 516                 len *= 2;
 517
 518         /*
 519          * Add one byte for the NUL termination, and one for the id_type.
 520          */
 521         len += 2;
 522         if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
 523                 len += VENDOR_LENGTH + MODEL_LENGTH;
 524
 525         if (max_len < len) {
 526                 info(udev, "%s: length %d too short - need %d\n",
 527                     dev_scsi->kernel, max_len, len);
 528                 return 1;
 529         }
 530
 531         serial[0] = hex_str[id_search->id_type];
 532
 533         /*
 534          * For SCSI_ID_VENDOR_SPECIFIC prepend the vendor and model before
 535          * the id since it is not unique across all vendors and models,
 536          * this differs from SCSI_ID_T10_VENDOR, where the vendor is
 537          * included in the identifier.
 538          */
 539         if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
 540                 if (prepend_vendor_model(udev, dev_scsi, &serial[1]) < 0) {
 541                         dbg(udev, "prepend failed\n");
 542                         return 1;
 543                 }
 544
 545         i = 4; /* offset to the start of the identifier */
 546         s = j = strlen(serial);
 547         if ((page_83[0] & 0x0f) == SCSI_ID_ASCII) {
 548                 /*
 549                  * ASCII descriptor.
 550                  */
 551                 while (i < (4 + page_83[3]))
 552                         serial[j++] = page_83[i++];
 553         } else {
 554                 /*
 555                  * Binary descriptor, convert to ASCII, using two bytes of
 556                  * ASCII for each byte in the page_83.
 557                  */
 558                 while (i < (4 + page_83[3])) {
 559                         serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
 560                         serial[j++] = hex_str[page_83[i] & 0x0f];
 561                         i++;
 562                 }
 563         }
 564
 565         strcpy(serial_short, &serial[s]);
 566
 567         if (id_search->id_type == SCSI_ID_NAA && wwn != NULL) {
 568                 strncpy(wwn, &serial[s], 16);
 569                 if (wwn_vendor_extension != NULL) {
 570                         strncpy(wwn_vendor_extension, &serial[s + 16], 16);
 571                 }
 572         }
 573         return 0;
 574 }
 575
 576 /* Extract the raw binary from VPD 0x83 pre-SPC devices */
 577 static int check_fill_0x83_prespc3(struct udev *udev,
 578                                    struct scsi_id_device *dev_scsi,
 579                                    unsigned char *page_83,
 580                                    const struct scsi_id_search_values
 581                                    *id_search, char *serial, char *serial_short, int max_len)
 582 {
 583         int i, j;
 584
 585         dbg(udev, "using pre-spc3-83 for %s\n", dev_scsi->kernel);
 586         serial[0] = hex_str[id_search->id_type];
 587         /* serial has been memset to zero before */
 588         j = strlen(serial);     /* j = 1; */
 589
 590         for (i = 0; (i < page_83[3]) && (j < max_len-3); ++i) {
 591                 serial[j++] = hex_str[(page_83[4+i] & 0xf0) >> 4];
 592                 serial[j++] = hex_str[ page_83[4+i] & 0x0f];
 593         }
 594         serial[max_len-1] = 0;
 595         strncpy(serial_short, serial, max_len-1);
 596         return 0;
 597 }
 598
 599
 600 /* Get device identification VPD page */
 601 static int do_scsi_page83_inquiry(struct udev *udev,
 602                                   struct scsi_id_device *dev_scsi, int fd,
 603                                   char *serial, char *serial_short, int len,
 604                                   char *unit_serial_number, char *wwn,
 605                                   char *wwn_vendor_extension)
 606 {
 607         int retval;
 608         unsigned int id_ind, j;
 609         unsigned char page_83[SCSI_INQ_BUFF_LEN];
 610
 611         /* also pick up the page 80 serial number */
 612         do_scsi_page80_inquiry(udev, dev_scsi, fd, NULL, unit_serial_number, MAX_SERIAL_LEN);
 613
 614         memset(page_83, 0, SCSI_INQ_BUFF_LEN);
 615         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_83, page_83,
 616                               SCSI_INQ_BUFF_LEN);
 617         if (retval < 0)
 618                 return 1;
 619
 620         if (page_83[1] != PAGE_83) {
 621                 info(udev, "%s: Invalid page 0x83\n", dev_scsi->kernel);
 622                 return 1;
 623         }
 624
 625         /*
 626          * XXX Some devices (IBM 3542) return all spaces for an identifier if
 627          * the LUN is not actually configured. This leads to identifiers of
 628          * the form: "1            ".
 629          */
 630
 631         /*
 632          * Model 4, 5, and (some) model 6 EMC Symmetrix devices return
 633          * a page 83 reply according to SCSI-2 format instead of SPC-2/3.
 634          *
 635          * The SCSI-2 page 83 format returns an IEEE WWN in binary
 636          * encoded hexi-decimal in the 16 bytes following the initial
 637          * 4-byte page 83 reply header.
 638          *
 639          * Both the SPC-2 and SPC-3 formats return an IEEE WWN as part
 640          * of an Identification descriptor.  The 3rd byte of the first
 641          * Identification descriptor is a reserved (BSZ) byte field.
 642          *
 643          * Reference the 7th byte of the page 83 reply to determine
 644          * whether the reply is compliant with SCSI-2 or SPC-2/3
 645          * specifications.  A zero value in the 7th byte indicates
 646          * an SPC-2/3 conformant reply, (i.e., the reserved field of the
 647          * first Identification descriptor).  This byte will be non-zero
 648          * for a SCSI-2 conformant page 83 reply from these EMC
 649          * Symmetrix models since the 7th byte of the reply corresponds
 650          * to the 4th and 5th nibbles of the 6-byte OUI for EMC, that is,
 651          * 0x006048.
 652          */
 653
 654         if (page_83[6] != 0)
 655                 return check_fill_0x83_prespc3(udev,
 656                                                dev_scsi, page_83, id_search_list,
 657                                                serial, serial_short, len);
 658
 659         /*
 660          * Search for a match in the prioritized id_search_list - since WWN ids
 661          * come first we can pick up the WWN in check_fill_0x83_id().
 662          */
 663         for (id_ind = 0;
 664              id_ind < sizeof(id_search_list)/sizeof(id_search_list[0]);
 665              id_ind++) {
 666                 /*
 667                  * Examine each descriptor returned. There is normally only
 668                  * one or a small number of descriptors.
 669                  */
 670                 for (j = 4; j <= (unsigned int)page_83[3] + 3; j += page_83[j + 3] + 4) {
 671                         retval = check_fill_0x83_id(udev,
 672                                                     dev_scsi, &page_83[j],
 673                                                     &id_search_list[id_ind],
 674                                                     serial, serial_short, len,
 675                                                     wwn,
 676                                                     wwn_vendor_extension);
 677                         dbg(udev, "%s id desc %d/%d/%d\n", dev_scsi->kernel,
 678                                 id_search_list[id_ind].id_type,
 679                                 id_search_list[id_ind].naa_type,
 680                                 id_search_list[id_ind].code_set);
 681                         if (!retval) {
 682                                 dbg(udev, "  used\n");
 683                                 return retval;
 684                         } else if (retval < 0) {
 685                                 dbg(udev, "  failed\n");
 686                                 return retval;
 687                         } else {
 688                                 dbg(udev, "  not used\n");
 689                         }
 690                 }
 691         }
 692         return 1;
 693 }
 694
 695 /*
 696  * Get device identification VPD page for older SCSI-2 device which is not
 697  * compliant with either SPC-2 or SPC-3 format.
 698  *
 699  * Return the hard coded error code value 2 if the page 83 reply is not
 700  * conformant to the SCSI-2 format.
 701  */
 702 static int do_scsi_page83_prespc3_inquiry(struct udev *udev,
 703                                           struct scsi_id_device *dev_scsi, int fd,
 704                                           char *serial, char *serial_short, int len)
 705 {
 706         int retval;
 707         int i, j;
 708         unsigned char page_83[SCSI_INQ_BUFF_LEN];
 709
 710         memset(page_83, 0, SCSI_INQ_BUFF_LEN);
 711         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_83, page_83, SCSI_INQ_BUFF_LEN);
 712         if (retval < 0)
 713                 return 1;
 714
 715         if (page_83[1] != PAGE_83) {
 716                 info(udev, "%s: Invalid page 0x83\n", dev_scsi->kernel);
 717                 return 1;
 718         }
 719         /*
 720          * Model 4, 5, and (some) model 6 EMC Symmetrix devices return
 721          * a page 83 reply according to SCSI-2 format instead of SPC-2/3.
 722          *
 723          * The SCSI-2 page 83 format returns an IEEE WWN in binary
 724          * encoded hexi-decimal in the 16 bytes following the initial
 725          * 4-byte page 83 reply header.
 726          *
 727          * Both the SPC-2 and SPC-3 formats return an IEEE WWN as part
 728          * of an Identification descriptor.  The 3rd byte of the first
 729          * Identification descriptor is a reserved (BSZ) byte field.
 730          *
 731          * Reference the 7th byte of the page 83 reply to determine
 732          * whether the reply is compliant with SCSI-2 or SPC-2/3
 733          * specifications.  A zero value in the 7th byte indicates
 734          * an SPC-2/3 conformant reply, (i.e., the reserved field of the
 735          * first Identification descriptor).  This byte will be non-zero
 736          * for a SCSI-2 conformant page 83 reply from these EMC
 737          * Symmetrix models since the 7th byte of the reply corresponds
 738          * to the 4th and 5th nibbles of the 6-byte OUI for EMC, that is,
 739          * 0x006048.
 740          */
 741         if (page_83[6] == 0)
 742                 return 2;
 743
 744         serial[0] = hex_str[id_search_list[0].id_type];
 745         /*
 746          * The first four bytes contain data, not a descriptor.
 747          */
 748         i = 4;
 749         j = strlen(serial);
 750         /*
 751          * Binary descriptor, convert to ASCII,
 752          * using two bytes of ASCII for each byte
 753          * in the page_83.
 754          */
 755         while (i < (page_83[3]+4)) {
 756                 serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
 757                 serial[j++] = hex_str[page_83[i] & 0x0f];
 758                 i++;
 759         }
 760         dbg(udev, "using pre-spc3-83 for %s\n", dev_scsi->kernel);
 761         return 0;
 762 }
 763
 764 /* Get unit serial number VPD page */
 765 static int do_scsi_page80_inquiry(struct udev *udev,
 766                                   struct scsi_id_device *dev_scsi, int fd,
 767                                   char *serial, char *serial_short, int max_len)
 768 {
 769         int retval;
 770         int ser_ind;
 771         int i;
 772         int len;
 773         unsigned char buf[SCSI_INQ_BUFF_LEN];
 774
 775         memset(buf, 0, SCSI_INQ_BUFF_LEN);
 776         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_80, buf, SCSI_INQ_BUFF_LEN);
 777         if (retval < 0)
 778                 return retval;
 779
 780         if (buf[1] != PAGE_80) {
 781                 info(udev, "%s: Invalid page 0x80\n", dev_scsi->kernel);
 782                 return 1;
 783         }
 784
 785         len = 1 + VENDOR_LENGTH + MODEL_LENGTH + buf[3];
 786         if (max_len < len) {
 787                 info(udev, "%s: length %d too short - need %d\n",
 788                      dev_scsi->kernel, max_len, len);
 789                 return 1;
 790         }
 791         /*
 792          * Prepend 'S' to avoid unlikely collision with page 0x83 vendor
 793          * specific type where we prepend '0' + vendor + model.
 794          */
 795         len = buf[3];
 796         if (serial != NULL) {
 797                 serial[0] = 'S';
 798                 ser_ind = prepend_vendor_model(udev, dev_scsi, &serial[1]);
 799                 if (ser_ind < 0)
 800                         return 1;
 801                 for (i = 4; i < len + 4; i++, ser_ind++)
 802                         serial[ser_ind] = buf[i];
 803         }
 804         if (serial_short != NULL) {
 805                 memcpy(serial_short, &buf[4], len);
 806                 serial_short[len] = '\0';
 807         }
 808         return 0;
 809 }
 810
 811 int scsi_std_inquiry(struct udev *udev,
 812                      struct scsi_id_device *dev_scsi, const char *devname)
 813 {
 814         int fd;
 815         unsigned char buf[SCSI_INQ_BUFF_LEN];
 816         struct stat statbuf;
 817         int err = 0;
 818
 819         dbg(udev, "opening %s\n", devname);
 820         fd = open(devname, O_RDONLY | O_NONBLOCK);
 821         if (fd < 0) {
 822                 info(udev, "scsi_id: cannot open %s: %s\n",
 823                      devname, strerror(errno));
 824                 return 1;
 825         }
 826
 827         if (fstat(fd, &statbuf) < 0) {
 828                 info(udev, "scsi_id: cannot stat %s: %s\n",
 829                      devname, strerror(errno));
 830                 err = 2;
 831                 goto out;
 832         }
 833         sprintf(dev_scsi->kernel,"%d:%d", major(statbuf.st_rdev),
 834                 minor(statbuf.st_rdev));
 835
 836         memset(buf, 0, SCSI_INQ_BUFF_LEN);
 837         err = scsi_inquiry(udev, dev_scsi, fd, 0, 0, buf, SCSI_INQ_BUFF_LEN);
 838         if (err < 0)
 839                 goto out;
 840
 841         err = 0;
 842         memcpy(dev_scsi->vendor, buf + 8, 8);
 843         dev_scsi->vendor[8] = '\0';
 844         memcpy(dev_scsi->model, buf + 16, 16);
 845         dev_scsi->model[16] = '\0';
 846         memcpy(dev_scsi->revision, buf + 32, 4);
 847         dev_scsi->revision[4] = '\0';
 848         sprintf(dev_scsi->type,"%x", buf[0] & 0x1f);
 849
 850 out:
 851         close(fd);
 852         return err;
 853 }
 854
 855 int scsi_get_serial(struct udev *udev,
 856                     struct scsi_id_device *dev_scsi, const char *devname,
 857                     int page_code, int len)
 858 {
 859         unsigned char page0[SCSI_INQ_BUFF_LEN];
 860         int fd = -1;
 861         int cnt;
 862         int ind;
 863         int retval;
 864
 865         memset(dev_scsi->serial, 0, len);
 866         dbg(udev, "opening %s\n", devname);
 867         srand((unsigned int)getpid());
 868         for (cnt = 20; cnt > 0; cnt--) {
 869                 struct timespec duration;
 870
 871                 fd = open(devname, O_RDONLY | O_NONBLOCK);
 872                 if (fd >= 0 || errno != EBUSY)
 873                         break;
 874                 duration.tv_sec = 0;
 875                 duration.tv_nsec = (200 * 1000 * 1000) + (rand() % 100 * 1000 * 1000);
 876                 nanosleep(&duration, NULL);
 877         }
 878         if (fd < 0)
 879                 return 1;
 880
 881         if (page_code == PAGE_80) {
 882                 if (do_scsi_page80_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len)) {
 883                         retval = 1;
 884                         goto completed;
 885                 } else  {
 886                         retval = 0;
 887                         goto completed;
 888                 }
 889         } else if (page_code == PAGE_83) {
 890                 if (do_scsi_page83_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len, dev_scsi->unit_serial_number, dev_scsi->wwn, dev_scsi->wwn_vendor_extension)) {
 891                         retval = 1;
 892                         goto completed;
 893                 } else  {
 894                         retval = 0;
 895                         goto completed;
 896                 }
 897         } else if (page_code == PAGE_83_PRE_SPC3) {
 898                 retval = do_scsi_page83_prespc3_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len);
 899                 if (retval) {
 900                         /*
 901                          * Fallback to servicing a SPC-2/3 compliant page 83
 902                          * inquiry if the page 83 reply format does not
 903                          * conform to pre-SPC3 expectations.
 904                          */
 905                         if (retval == 2) {
 906                                 if (do_scsi_page83_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len, dev_scsi->unit_serial_number, dev_scsi->wwn, dev_scsi->wwn_vendor_extension)) {
 907                                         retval = 1;
 908                                         goto completed;
 909                                 } else  {
 910                                         retval = 0;
 911                                         goto completed;
 912                                 }
 913                         }
 914                         else {
 915                                 retval = 1;
 916                                 goto completed;
 917                         }
 918                 } else  {
 919                         retval = 0;
 920                         goto completed;
 921                 }
 922         } else if (page_code != 0x00) {
 923                 info(udev, "%s: unsupported page code 0x%d\n", dev_scsi->kernel, page_code);
 924                 return 1;
 925         }
 926
 927         /*
 928          * Get page 0, the page of the pages. By default, try from best to
 929          * worst of supported pages: 0x83 then 0x80.
 930          */
 931         if (do_scsi_page0_inquiry(udev, dev_scsi, fd, page0, SCSI_INQ_BUFF_LEN)) {
 932                 /*
 933                  * Don't try anything else. Black list if a specific page
 934                  * should be used for this vendor+model, or maybe have an
 935                  * optional fall-back to page 0x80 or page 0x83.
 936                  */
 937                 retval = 1;
 938                 goto completed;
 939         }
 940
 941         dbg(udev, "%s: Checking page0\n", dev_scsi->kernel);
 942
 943         for (ind = 4; ind <= page0[3] + 3; ind++)
 944                 if (page0[ind] == PAGE_83)
 945                         if (!do_scsi_page83_inquiry(udev, dev_scsi, fd,
 946                                                     dev_scsi->serial, dev_scsi->serial_short, len, dev_scsi->unit_serial_number, dev_scsi->wwn, dev_scsi->wwn_vendor_extension)) {
 947                                 /*
 948                                  * Success
 949                                  */
 950                                 retval = 0;
 951                                 goto completed;
 952                         }
 953
 954         for (ind = 4; ind <= page0[3] + 3; ind++)
 955                 if (page0[ind] == PAGE_80)
 956                         if (!do_scsi_page80_inquiry(udev, dev_scsi, fd,
 957                                                     dev_scsi->serial, dev_scsi->serial_short, len)) {
 958                                 /*
 959                                  * Success
 960                                  */
 961                                 retval = 0;
 962                                 goto completed;
 963                         }
 964         retval = 1;
 965
 966 completed:
 967         close(fd);
 968         return retval;
 969 }