extras/scsi_id/scsi_serial.c

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