extras/scsi_id/scsi_serial.c

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