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