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