src/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         struct sg_io_v4 io_v4;
 326         struct sg_io_hdr io_hdr;
 327         int retry = 3; /* rather random */
 328         int retval;
 329
 330         if (buflen > SCSI_INQ_BUFF_LEN) {
 331                 info(udev, "buflen %d too long\n", buflen);
 332                 return -1;
 333         }
 334
 335 resend:
 336         dbg(udev, "%s evpd %d, page 0x%x\n", dev_scsi->kernel, evpd, page);
 337
 338         if (dev_scsi->use_sg == 4) {
 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                 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
 352                 io_hdr.interface_id = 'S';
 353                 io_hdr.cmd_len = sizeof(inq_cmd);
 354                 io_hdr.mx_sb_len = sizeof(sense);
 355                 io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
 356                 io_hdr.dxfer_len = buflen;
 357                 io_hdr.dxferp = buf;
 358                 io_hdr.cmdp = inq_cmd;
 359                 io_hdr.sbp = sense;
 360                 io_hdr.timeout = DEF_TIMEOUT;
 361                 io_buf = (void *)&io_hdr;
 362         }
 363
 364         retval = ioctl(fd, SG_IO, io_buf);
 365         if (retval < 0) {
 366                 if ((errno == EINVAL || errno == ENOSYS) && dev_scsi->use_sg == 4) {
 367                         dev_scsi->use_sg = 3;
 368                         goto resend;
 369                 }
 370                 info(udev, "%s: ioctl failed: %s\n", dev_scsi->kernel, strerror(errno));
 371                 goto error;
 372         }
 373
 374         if (dev_scsi->use_sg == 4)
 375                 retval = sg_err_category4(udev, io_buf);
 376         else
 377                 retval = sg_err_category3(udev, io_buf);
 378
 379         switch (retval) {
 380                 case SG_ERR_CAT_NOTSUPPORTED:
 381                         buf[1] = 0;
 382                         /* Fallthrough */
 383                 case SG_ERR_CAT_CLEAN:
 384                 case SG_ERR_CAT_RECOVERED:
 385                         retval = 0;
 386                         break;
 387
 388                 default:
 389                         if (dev_scsi->use_sg == 4)
 390                                 retval = scsi_dump_v4(udev, dev_scsi, io_buf);
 391                         else
 392                                 retval = scsi_dump(udev, dev_scsi, io_buf);
 393         }
 394
 395         if (!retval) {
 396                 retval = buflen;
 397         } else if (retval > 0) {
 398                 if (--retry > 0) {
 399                         dbg(udev, "%s: Retrying ...\n", dev_scsi->kernel);
 400                         goto resend;
 401                 }
 402                 retval = -1;
 403         }
 404
 405 error:
 406         if (retval < 0)
 407                 info(udev, "%s: Unable to get INQUIRY vpd %d page 0x%x.\n",
 408                     dev_scsi->kernel, evpd, page);
 409
 410         return retval;
 411 }
 412
 413 /* Get list of supported EVPD pages */
 414 static int do_scsi_page0_inquiry(struct udev *udev,
 415                                  struct scsi_id_device *dev_scsi, int fd,
 416                                  unsigned char *buffer, unsigned int len)
 417 {
 418         int retval;
 419
 420         memset(buffer, 0, len);
 421         retval = scsi_inquiry(udev, dev_scsi, fd, 1, 0x0, buffer, len);
 422         if (retval < 0)
 423                 return 1;
 424
 425         if (buffer[1] != 0) {
 426                 info(udev, "%s: page 0 not available.\n", dev_scsi->kernel);
 427                 return 1;
 428         }
 429         if (buffer[3] > len) {
 430                 info(udev, "%s: page 0 buffer too long %d\n", dev_scsi->kernel,         buffer[3]);
 431                 return 1;
 432         }
 433
 434         /*
 435          * Following check is based on code once included in the 2.5.x
 436          * kernel.
 437          *
 438          * Some ill behaved devices return the standard inquiry here
 439          * rather than the evpd data, snoop the data to verify.
 440          */
 441         if (buffer[3] > MODEL_LENGTH) {
 442                 /*
 443                  * If the vendor id appears in the page assume the page is
 444                  * invalid.
 445                  */
 446                 if (!strncmp((char *)&buffer[VENDOR_LENGTH], dev_scsi->vendor, VENDOR_LENGTH)) {
 447                         info(udev, "%s: invalid page0 data\n", dev_scsi->kernel);
 448                         return 1;
 449                 }
 450         }
 451         return 0;
 452 }
 453
 454 /*
 455  * The caller checks that serial is long enough to include the vendor +
 456  * model.
 457  */
 458 static int prepend_vendor_model(struct udev *udev,
 459                                 struct scsi_id_device *dev_scsi, char *serial)
 460 {
 461         int ind;
 462
 463         strncpy(serial, dev_scsi->vendor, VENDOR_LENGTH);
 464         strncat(serial, dev_scsi->model, MODEL_LENGTH);
 465         ind = strlen(serial);
 466
 467         /*
 468          * This is not a complete check, since we are using strncat/cpy
 469          * above, ind will never be too large.
 470          */
 471         if (ind != (VENDOR_LENGTH + MODEL_LENGTH)) {
 472                 info(udev, "%s: expected length %d, got length %d\n",
 473                      dev_scsi->kernel, (VENDOR_LENGTH + MODEL_LENGTH), ind);
 474                 return -1;
 475         }
 476         return ind;
 477 }
 478
 479 /**
 480  * check_fill_0x83_id - check the page 0x83 id, if OK allocate and fill
 481  * serial number.
 482  **/
 483 static int check_fill_0x83_id(struct udev *udev,
 484                               struct scsi_id_device *dev_scsi,
 485                               unsigned char *page_83,
 486                               const struct scsi_id_search_values
 487                               *id_search, char *serial, char *serial_short,
 488                               int max_len, char *wwn,
 489                               char *wwn_vendor_extension, char *tgpt_group)
 490 {
 491         int i, j, s, len;
 492
 493         /*
 494          * ASSOCIATION must be with the device (value 0)
 495          * or with the target port for SCSI_ID_TGTPORT
 496          */
 497         if ((page_83[1] & 0x30) == 0x10) {
 498                 if (id_search->id_type != SCSI_ID_TGTGROUP)
 499                         return 1;
 500         } else if ((page_83[1] & 0x30) != 0) {
 501                 return 1;
 502         }
 503
 504         if ((page_83[1] & 0x0f) != id_search->id_type)
 505                 return 1;
 506
 507         /*
 508          * Possibly check NAA sub-type.
 509          */
 510         if ((id_search->naa_type != SCSI_ID_NAA_DONT_CARE) &&
 511             (id_search->naa_type != (page_83[4] & 0xf0) >> 4))
 512                 return 1;
 513
 514         /*
 515          * Check for matching code set - ASCII or BINARY.
 516          */
 517         if ((page_83[0] & 0x0f) != id_search->code_set)
 518                 return 1;
 519
 520         /*
 521          * page_83[3]: identifier length
 522          */
 523         len = page_83[3];
 524         if ((page_83[0] & 0x0f) != SCSI_ID_ASCII)
 525                 /*
 526                  * If not ASCII, use two bytes for each binary value.
 527                  */
 528                 len *= 2;
 529
 530         /*
 531          * Add one byte for the NUL termination, and one for the id_type.
 532          */
 533         len += 2;
 534         if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
 535                 len += VENDOR_LENGTH + MODEL_LENGTH;
 536
 537         if (max_len < len) {
 538                 info(udev, "%s: length %d too short - need %d\n",
 539                     dev_scsi->kernel, max_len, len);
 540                 return 1;
 541         }
 542
 543         if (id_search->id_type == SCSI_ID_TGTGROUP && tgpt_group != NULL) {
 544                 unsigned int group;
 545
 546                 group = ((unsigned int)page_83[6] << 8) | page_83[7];
 547                 sprintf(tgpt_group,"%x", group);
 548                 return 1;
 549         }
 550
 551         serial[0] = hex_str[id_search->id_type];
 552
 553         /*
 554          * For SCSI_ID_VENDOR_SPECIFIC prepend the vendor and model before
 555          * the id since it is not unique across all vendors and models,
 556          * this differs from SCSI_ID_T10_VENDOR, where the vendor is
 557          * included in the identifier.
 558          */
 559         if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
 560                 if (prepend_vendor_model(udev, dev_scsi, &serial[1]) < 0) {
 561                         dbg(udev, "prepend failed\n");
 562                         return 1;
 563                 }
 564
 565         i = 4; /* offset to the start of the identifier */
 566         s = j = strlen(serial);
 567         if ((page_83[0] & 0x0f) == SCSI_ID_ASCII) {
 568                 /*
 569                  * ASCII descriptor.
 570                  */
 571                 while (i < (4 + page_83[3]))
 572                         serial[j++] = page_83[i++];
 573         } else {
 574                 /*
 575                  * Binary descriptor, convert to ASCII, using two bytes of
 576                  * ASCII for each byte in the page_83.
 577                  */
 578                 while (i < (4 + page_83[3])) {
 579                         serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
 580                         serial[j++] = hex_str[page_83[i] & 0x0f];
 581                         i++;
 582                 }
 583         }
 584
 585         strcpy(serial_short, &serial[s]);
 586
 587         if (id_search->id_type == SCSI_ID_NAA && wwn != NULL) {
 588                 strncpy(wwn, &serial[s], 16);
 589                 if (wwn_vendor_extension != NULL) {
 590                         strncpy(wwn_vendor_extension, &serial[s + 16], 16);
 591                 }
 592         }
 593
 594         return 0;
 595 }
 596
 597 /* Extract the raw binary from VPD 0x83 pre-SPC devices */
 598 static int check_fill_0x83_prespc3(struct udev *udev,
 599                                    struct scsi_id_device *dev_scsi,
 600                                    unsigned char *page_83,
 601                                    const struct scsi_id_search_values
 602                                    *id_search, char *serial, char *serial_short, int max_len)
 603 {
 604         int i, j;
 605
 606         dbg(udev, "using pre-spc3-83 for %s\n", dev_scsi->kernel);
 607         serial[0] = hex_str[id_search->id_type];
 608         /* serial has been memset to zero before */
 609         j = strlen(serial);        /* j = 1; */
 610
 611         for (i = 0; (i < page_83[3]) && (j < max_len-3); ++i) {
 612                 serial[j++] = hex_str[(page_83[4+i] & 0xf0) >> 4];
 613                 serial[j++] = hex_str[ page_83[4+i] & 0x0f];
 614         }
 615         serial[max_len-1] = 0;
 616         strncpy(serial_short, serial, max_len-1);
 617         return 0;
 618 }
 619
 620
 621 /* Get device identification VPD page */
 622 static int do_scsi_page83_inquiry(struct udev *udev,
 623                                   struct scsi_id_device *dev_scsi, int fd,
 624                                   char *serial, char *serial_short, int len,
 625                                   char *unit_serial_number, char *wwn,
 626                                   char *wwn_vendor_extension, char *tgpt_group)
 627 {
 628         int retval;
 629         unsigned int id_ind, j;
 630         unsigned char page_83[SCSI_INQ_BUFF_LEN];
 631
 632         /* also pick up the page 80 serial number */
 633         do_scsi_page80_inquiry(udev, dev_scsi, fd, NULL, unit_serial_number, MAX_SERIAL_LEN);
 634
 635         memset(page_83, 0, SCSI_INQ_BUFF_LEN);
 636         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_83, page_83,
 637                               SCSI_INQ_BUFF_LEN);
 638         if (retval < 0)
 639                 return 1;
 640
 641         if (page_83[1] != PAGE_83) {
 642                 info(udev, "%s: Invalid page 0x83\n", dev_scsi->kernel);
 643                 return 1;
 644         }
 645
 646         /*
 647          * XXX Some devices (IBM 3542) return all spaces for an identifier if
 648          * the LUN is not actually configured. This leads to identifiers of
 649          * the form: "1            ".
 650          */
 651
 652         /*
 653          * Model 4, 5, and (some) model 6 EMC Symmetrix devices return
 654          * a page 83 reply according to SCSI-2 format instead of SPC-2/3.
 655          *
 656          * The SCSI-2 page 83 format returns an IEEE WWN in binary
 657          * encoded hexi-decimal in the 16 bytes following the initial
 658          * 4-byte page 83 reply header.
 659          *
 660          * Both the SPC-2 and SPC-3 formats return an IEEE WWN as part
 661          * of an Identification descriptor.  The 3rd byte of the first
 662          * Identification descriptor is a reserved (BSZ) byte field.
 663          *
 664          * Reference the 7th byte of the page 83 reply to determine
 665          * whether the reply is compliant with SCSI-2 or SPC-2/3
 666          * specifications.  A zero value in the 7th byte indicates
 667          * an SPC-2/3 conformant reply, (i.e., the reserved field of the
 668          * first Identification descriptor).  This byte will be non-zero
 669          * for a SCSI-2 conformant page 83 reply from these EMC
 670          * Symmetrix models since the 7th byte of the reply corresponds
 671          * to the 4th and 5th nibbles of the 6-byte OUI for EMC, that is,
 672          * 0x006048.
 673          */
 674
 675         if (page_83[6] != 0)
 676                 return check_fill_0x83_prespc3(udev,
 677                                                dev_scsi, page_83, id_search_list,
 678                                                serial, serial_short, len);
 679
 680         /*
 681          * Search for a match in the prioritized id_search_list - since WWN ids
 682          * come first we can pick up the WWN in check_fill_0x83_id().
 683          */
 684         for (id_ind = 0;
 685              id_ind < sizeof(id_search_list)/sizeof(id_search_list[0]);
 686              id_ind++) {
 687                 /*
 688                  * Examine each descriptor returned. There is normally only
 689                  * one or a small number of descriptors.
 690                  */
 691                 for (j = 4; j <= (unsigned int)page_83[3] + 3; j += page_83[j + 3] + 4) {
 692                         retval = check_fill_0x83_id(udev,
 693                                                     dev_scsi, &page_83[j],
 694                                                     &id_search_list[id_ind],
 695                                                     serial, serial_short, len,
 696                                                     wwn, wwn_vendor_extension,
 697                                                     tgpt_group);
 698                         dbg(udev, "%s id desc %d/%d/%d\n", dev_scsi->kernel,
 699                                 id_search_list[id_ind].id_type,
 700                                 id_search_list[id_ind].naa_type,
 701                                 id_search_list[id_ind].code_set);
 702                         if (!retval) {
 703                                 dbg(udev, "  used\n");
 704                                 return retval;
 705                         } else if (retval < 0) {
 706                                 dbg(udev, "  failed\n");
 707                                 return retval;
 708                         } else {
 709                                 dbg(udev, "  not used\n");
 710                         }
 711                 }
 712         }
 713         return 1;
 714 }
 715
 716 /*
 717  * Get device identification VPD page for older SCSI-2 device which is not
 718  * compliant with either SPC-2 or SPC-3 format.
 719  *
 720  * Return the hard coded error code value 2 if the page 83 reply is not
 721  * conformant to the SCSI-2 format.
 722  */
 723 static int do_scsi_page83_prespc3_inquiry(struct udev *udev,
 724                                           struct scsi_id_device *dev_scsi, int fd,
 725                                           char *serial, char *serial_short, int len)
 726 {
 727         int retval;
 728         int i, j;
 729         unsigned char page_83[SCSI_INQ_BUFF_LEN];
 730
 731         memset(page_83, 0, SCSI_INQ_BUFF_LEN);
 732         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_83, page_83, SCSI_INQ_BUFF_LEN);
 733         if (retval < 0)
 734                 return 1;
 735
 736         if (page_83[1] != PAGE_83) {
 737                 info(udev, "%s: Invalid page 0x83\n", dev_scsi->kernel);
 738                 return 1;
 739         }
 740         /*
 741          * Model 4, 5, and (some) model 6 EMC Symmetrix devices return
 742          * a page 83 reply according to SCSI-2 format instead of SPC-2/3.
 743          *
 744          * The SCSI-2 page 83 format returns an IEEE WWN in binary
 745          * encoded hexi-decimal in the 16 bytes following the initial
 746          * 4-byte page 83 reply header.
 747          *
 748          * Both the SPC-2 and SPC-3 formats return an IEEE WWN as part
 749          * of an Identification descriptor.  The 3rd byte of the first
 750          * Identification descriptor is a reserved (BSZ) byte field.
 751          *
 752          * Reference the 7th byte of the page 83 reply to determine
 753          * whether the reply is compliant with SCSI-2 or SPC-2/3
 754          * specifications.  A zero value in the 7th byte indicates
 755          * an SPC-2/3 conformant reply, (i.e., the reserved field of the
 756          * first Identification descriptor).  This byte will be non-zero
 757          * for a SCSI-2 conformant page 83 reply from these EMC
 758          * Symmetrix models since the 7th byte of the reply corresponds
 759          * to the 4th and 5th nibbles of the 6-byte OUI for EMC, that is,
 760          * 0x006048.
 761          */
 762         if (page_83[6] == 0)
 763                 return 2;
 764
 765         serial[0] = hex_str[id_search_list[0].id_type];
 766         /*
 767          * The first four bytes contain data, not a descriptor.
 768          */
 769         i = 4;
 770         j = strlen(serial);
 771         /*
 772          * Binary descriptor, convert to ASCII,
 773          * using two bytes of ASCII for each byte
 774          * in the page_83.
 775          */
 776         while (i < (page_83[3]+4)) {
 777                 serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
 778                 serial[j++] = hex_str[page_83[i] & 0x0f];
 779                 i++;
 780         }
 781         dbg(udev, "using pre-spc3-83 for %s\n", dev_scsi->kernel);
 782         return 0;
 783 }
 784
 785 /* Get unit serial number VPD page */
 786 static int do_scsi_page80_inquiry(struct udev *udev,
 787                                   struct scsi_id_device *dev_scsi, int fd,
 788                                   char *serial, char *serial_short, int max_len)
 789 {
 790         int retval;
 791         int ser_ind;
 792         int i;
 793         int len;
 794         unsigned char buf[SCSI_INQ_BUFF_LEN];
 795
 796         memset(buf, 0, SCSI_INQ_BUFF_LEN);
 797         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_80, buf, SCSI_INQ_BUFF_LEN);
 798         if (retval < 0)
 799                 return retval;
 800
 801         if (buf[1] != PAGE_80) {
 802                 info(udev, "%s: Invalid page 0x80\n", dev_scsi->kernel);
 803                 return 1;
 804         }
 805
 806         len = 1 + VENDOR_LENGTH + MODEL_LENGTH + buf[3];
 807         if (max_len < len) {
 808                 info(udev, "%s: length %d too short - need %d\n",
 809                      dev_scsi->kernel, max_len, len);
 810                 return 1;
 811         }
 812         /*
 813          * Prepend 'S' to avoid unlikely collision with page 0x83 vendor
 814          * specific type where we prepend '0' + vendor + model.
 815          */
 816         len = buf[3];
 817         if (serial != NULL) {
 818                 serial[0] = 'S';
 819                 ser_ind = prepend_vendor_model(udev, dev_scsi, &serial[1]);
 820                 if (ser_ind < 0)
 821                         return 1;
 822                 for (i = 4; i < len + 4; i++, ser_ind++)
 823                         serial[ser_ind] = buf[i];
 824         }
 825         if (serial_short != NULL) {
 826                 memcpy(serial_short, &buf[4], len);
 827                 serial_short[len] = '\0';
 828         }
 829         return 0;
 830 }
 831
 832 int scsi_std_inquiry(struct udev *udev,
 833                      struct scsi_id_device *dev_scsi, const char *devname)
 834 {
 835         int fd;
 836         unsigned char buf[SCSI_INQ_BUFF_LEN];
 837         struct stat statbuf;
 838         int err = 0;
 839
 840         dbg(udev, "opening %s\n", devname);
 841         fd = open(devname, O_RDONLY | O_NONBLOCK);
 842         if (fd < 0) {
 843                 info(udev, "scsi_id: cannot open %s: %s\n",
 844                      devname, strerror(errno));
 845                 return 1;
 846         }
 847
 848         if (fstat(fd, &statbuf) < 0) {
 849                 info(udev, "scsi_id: cannot stat %s: %s\n",
 850                      devname, strerror(errno));
 851                 err = 2;
 852                 goto out;
 853         }
 854         sprintf(dev_scsi->kernel,"%d:%d", major(statbuf.st_rdev),
 855                 minor(statbuf.st_rdev));
 856
 857         memset(buf, 0, SCSI_INQ_BUFF_LEN);
 858         err = scsi_inquiry(udev, dev_scsi, fd, 0, 0, buf, SCSI_INQ_BUFF_LEN);
 859         if (err < 0)
 860                 goto out;
 861
 862         err = 0;
 863         memcpy(dev_scsi->vendor, buf + 8, 8);
 864         dev_scsi->vendor[8] = '\0';
 865         memcpy(dev_scsi->model, buf + 16, 16);
 866         dev_scsi->model[16] = '\0';
 867         memcpy(dev_scsi->revision, buf + 32, 4);
 868         dev_scsi->revision[4] = '\0';
 869         sprintf(dev_scsi->type,"%x", buf[0] & 0x1f);
 870
 871 out:
 872         close(fd);
 873         return err;
 874 }
 875
 876 int scsi_get_serial(struct udev *udev,
 877                     struct scsi_id_device *dev_scsi, const char *devname,
 878                     int page_code, int len)
 879 {
 880         unsigned char page0[SCSI_INQ_BUFF_LEN];
 881         int fd = -1;
 882         int cnt;
 883         int ind;
 884         int retval;
 885
 886         memset(dev_scsi->serial, 0, len);
 887         dbg(udev, "opening %s\n", devname);
 888         srand((unsigned int)getpid());
 889         for (cnt = 20; cnt > 0; cnt--) {
 890                 struct timespec duration;
 891
 892                 fd = open(devname, O_RDONLY | O_NONBLOCK);
 893                 if (fd >= 0 || errno != EBUSY)
 894                         break;
 895                 duration.tv_sec = 0;
 896                 duration.tv_nsec = (200 * 1000 * 1000) + (rand() % 100 * 1000 * 1000);
 897                 nanosleep(&duration, NULL);
 898         }
 899         if (fd < 0)
 900                 return 1;
 901
 902         if (page_code == PAGE_80) {
 903                 if (do_scsi_page80_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len)) {
 904                         retval = 1;
 905                         goto completed;
 906                 } else  {
 907                         retval = 0;
 908                         goto completed;
 909                 }
 910         } else if (page_code == PAGE_83) {
 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, dev_scsi->tgpt_group)) {
 912                         retval = 1;
 913                         goto completed;
 914                 } else  {
 915                         retval = 0;
 916                         goto completed;
 917                 }
 918         } else if (page_code == PAGE_83_PRE_SPC3) {
 919                 retval = do_scsi_page83_prespc3_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len);
 920                 if (retval) {
 921                         /*
 922                          * Fallback to servicing a SPC-2/3 compliant page 83
 923                          * inquiry if the page 83 reply format does not
 924                          * conform to pre-SPC3 expectations.
 925                          */
 926                         if (retval == 2) {
 927                                 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)) {
 928                                         retval = 1;
 929                                         goto completed;
 930                                 } else  {
 931                                         retval = 0;
 932                                         goto completed;
 933                                 }
 934                         }
 935                         else {
 936                                 retval = 1;
 937                                 goto completed;
 938                         }
 939                 } else  {
 940                         retval = 0;
 941                         goto completed;
 942                 }
 943         } else if (page_code != 0x00) {
 944                 info(udev, "%s: unsupported page code 0x%d\n", dev_scsi->kernel, page_code);
 945                 return 1;
 946         }
 947
 948         /*
 949          * Get page 0, the page of the pages. By default, try from best to
 950          * worst of supported pages: 0x83 then 0x80.
 951          */
 952         if (do_scsi_page0_inquiry(udev, dev_scsi, fd, page0, SCSI_INQ_BUFF_LEN)) {
 953                 /*
 954                  * Don't try anything else. Black list if a specific page
 955                  * should be used for this vendor+model, or maybe have an
 956                  * optional fall-back to page 0x80 or page 0x83.
 957                  */
 958                 retval = 1;
 959                 goto completed;
 960         }
 961
 962         dbg(udev, "%s: Checking page0\n", dev_scsi->kernel);
 963
 964         for (ind = 4; ind <= page0[3] + 3; ind++)
 965                 if (page0[ind] == PAGE_83)
 966                         if (!do_scsi_page83_inquiry(udev, dev_scsi, fd,
 967                                                     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)) {
 968                                 /*
 969                                  * Success
 970                                  */
 971                                 retval = 0;
 972                                 goto completed;
 973                         }
 974
 975         for (ind = 4; ind <= page0[3] + 3; ind++)
 976                 if (page0[ind] == PAGE_80)
 977                         if (!do_scsi_page80_inquiry(udev, dev_scsi, fd,
 978                                                     dev_scsi->serial, dev_scsi->serial_short, len)) {
 979                                 /*
 980                                  * Success
 981                                  */
 982                                 retval = 0;
 983                                 goto completed;
 984                         }
 985         retval = 1;
 986
 987 completed:
 988         close(fd);
 989         return retval;
 990 }