usr.sbin/mptutil/mpt_cam.c

   1 /*-
   2  * Copyright (c) 2008 Yahoo!, Inc.
   3  * All rights reserved.
   4  * Written by: John Baldwin <jhb@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Neither the name of the author nor the names of any co-contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __RCSID("$FreeBSD$");
  33
  34 #include <sys/param.h>
  35 #include <err.h>
  36 #include <errno.h>
  37 #include <fcntl.h>
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41
  42 #include <camlib.h>
  43 #include <cam/scsi/scsi_message.h>
  44 #include <cam/scsi/scsi_pass.h>
  45
  46 #include "mptutil.h"
  47
  48 static int xptfd;
  49
  50 static int
  51 xpt_open(void)
  52 {
  53
  54         if (xptfd == 0)
  55                 xptfd = open(XPT_DEVICE, O_RDWR);
  56         return (xptfd);
  57 }
  58
  59 /* Fetch the path id of bus 0 for the opened mpt controller. */
  60 static int
  61 fetch_path_id(path_id_t *path_id)
  62 {
  63         struct bus_match_pattern *b;
  64         union ccb ccb;
  65         size_t bufsize;
  66         int error;
  67
  68         if (xpt_open() < 0)
  69                 return (ENXIO);
  70
  71         /* First, find the path id of bus 0 for this mpt controller. */
  72         bzero(&ccb, sizeof(ccb));
  73
  74         ccb.ccb_h.func_code = XPT_DEV_MATCH;
  75
  76         bufsize = sizeof(struct dev_match_result) * 1;
  77         ccb.cdm.num_matches = 0;
  78         ccb.cdm.match_buf_len = bufsize;
  79         ccb.cdm.matches = calloc(1, bufsize);
  80
  81         bufsize = sizeof(struct dev_match_pattern) * 1;
  82         ccb.cdm.num_patterns = 1;
  83         ccb.cdm.pattern_buf_len = bufsize;
  84         ccb.cdm.patterns = calloc(1, bufsize);
  85
  86         /* Match mptX bus 0. */
  87         ccb.cdm.patterns[0].type = DEV_MATCH_BUS;
  88         b = &ccb.cdm.patterns[0].pattern.bus_pattern;
  89         snprintf(b->dev_name, sizeof(b->dev_name), "mpt");
  90         b->unit_number = mpt_unit;
  91         b->bus_id = 0;
  92         b->flags = BUS_MATCH_NAME | BUS_MATCH_UNIT | BUS_MATCH_BUS_ID;
  93
  94         if (ioctl(xptfd, CAMIOCOMMAND, &ccb) < 0) {
  95                 error = errno;
  96                 free(ccb.cdm.matches);
  97                 free(ccb.cdm.patterns);
  98                 return (error);
  99         }
 100         free(ccb.cdm.patterns);
 101
 102         if (((ccb.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) ||
 103             (ccb.cdm.status != CAM_DEV_MATCH_LAST)) {
 104                 warnx("fetch_path_id got CAM error %#x, CDM error %d\n",
 105                     ccb.ccb_h.status, ccb.cdm.status);
 106                 free(ccb.cdm.matches);
 107                 return (EIO);
 108         }
 109
 110         /* We should have exactly 1 match for the bus. */
 111         if (ccb.cdm.num_matches != 1 ||
 112             ccb.cdm.matches[0].type != DEV_MATCH_BUS) {
 113                 free(ccb.cdm.matches);
 114                 return (ENOENT);
 115         }
 116         *path_id = ccb.cdm.matches[0].result.bus_result.path_id;
 117         free(ccb.cdm.matches);
 118         return (0);
 119 }
 120
 121 int
 122 mpt_query_disk(U8 VolumeBus, U8 VolumeID, struct mpt_query_disk *qd)
 123 {
 124         struct periph_match_pattern *p;
 125         struct periph_match_result *r;
 126         union ccb ccb;
 127         path_id_t path_id;
 128         size_t bufsize;
 129         int error;
 130
 131         /* mpt(4) only handles devices on bus 0. */
 132         if (VolumeBus != 0)
 133                 return (ENXIO);
 134
 135         if (xpt_open() < 0)
 136                 return (ENXIO);
 137
 138         /* Find the path ID of bus 0. */
 139         error = fetch_path_id(&path_id);
 140         if (error)
 141                 return (error);
 142
 143         bzero(&ccb, sizeof(ccb));
 144
 145         ccb.ccb_h.func_code = XPT_DEV_MATCH;
 146         ccb.ccb_h.path_id = CAM_XPT_PATH_ID;
 147         ccb.ccb_h.target_id = CAM_TARGET_WILDCARD;
 148         ccb.ccb_h.target_lun = CAM_LUN_WILDCARD;
 149
 150         bufsize = sizeof(struct dev_match_result) * 5;
 151         ccb.cdm.num_matches = 0;
 152         ccb.cdm.match_buf_len = bufsize;
 153         ccb.cdm.matches = calloc(1, bufsize);
 154
 155         bufsize = sizeof(struct dev_match_pattern) * 1;
 156         ccb.cdm.num_patterns = 1;
 157         ccb.cdm.pattern_buf_len = bufsize;
 158         ccb.cdm.patterns = calloc(1, bufsize);
 159
 160         /* Look for a "da" device at the specified target and lun. */
 161         ccb.cdm.patterns[0].type = DEV_MATCH_PERIPH;
 162         p = &ccb.cdm.patterns[0].pattern.periph_pattern;
 163         p->path_id = path_id;
 164         snprintf(p->periph_name, sizeof(p->periph_name), "da");
 165         p->target_id = VolumeID;
 166         p->flags = PERIPH_MATCH_PATH | PERIPH_MATCH_NAME | PERIPH_MATCH_TARGET;
 167
 168         if (ioctl(xptfd, CAMIOCOMMAND, &ccb) < 0) {
 169                 error = errno;
 170                 free(ccb.cdm.matches);
 171                 free(ccb.cdm.patterns);
 172                 return (error);
 173         }
 174         free(ccb.cdm.patterns);
 175
 176         if (((ccb.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) ||
 177             (ccb.cdm.status != CAM_DEV_MATCH_LAST)) {
 178                 warnx("mpt_query_disk got CAM error %#x, CDM error %d\n",
 179                     ccb.ccb_h.status, ccb.cdm.status);
 180                 free(ccb.cdm.matches);
 181                 return (EIO);
 182         }
 183
 184         /*
 185          * We should have exactly 1 match for the peripheral.
 186          * However, if we don't get a match, don't print an error
 187          * message and return ENOENT.
 188          */
 189         if (ccb.cdm.num_matches == 0) {
 190                 free(ccb.cdm.matches);
 191                 return (ENOENT);
 192         }
 193         if (ccb.cdm.num_matches != 1) {
 194                 warnx("mpt_query_disk got %d matches, expected 1",
 195                     ccb.cdm.num_matches);
 196                 free(ccb.cdm.matches);
 197                 return (EIO);
 198         }
 199         if (ccb.cdm.matches[0].type != DEV_MATCH_PERIPH) {
 200                 warnx("mpt_query_disk got wrong CAM match");
 201                 free(ccb.cdm.matches);
 202                 return (EIO);
 203         }
 204
 205         /* Copy out the data. */
 206         r = &ccb.cdm.matches[1].result.periph_result;
 207         snprintf(qd->devname, sizeof(qd->devname), "%s%d", r->periph_name,
 208             r->unit_number);
 209         free(ccb.cdm.matches);
 210
 211         return (0);
 212 }
 213
 214 static int
 215 periph_is_volume(CONFIG_PAGE_IOC_2 *ioc2, struct periph_match_result *r)
 216 {
 217         CONFIG_PAGE_IOC_2_RAID_VOL *vol;
 218         int i;
 219
 220         if (ioc2 == NULL)
 221                 return (0);
 222         vol = ioc2->RaidVolume;
 223         for (i = 0; i < ioc2->NumActiveVolumes; vol++, i++) {
 224                 if (vol->VolumeBus == 0 && vol->VolumeID == r->target_id)
 225                         return (1);
 226         }
 227         return (0);
 228 }
 229
 230 /* Much borrowed from scsireadcapacity() in src/sbin/camcontrol/camcontrol.c. */
 231 static int
 232 fetch_scsi_capacity(struct cam_device *dev, struct mpt_standalone_disk *disk)
 233 {
 234         struct scsi_read_capacity_data rcap;
 235         struct scsi_read_capacity_data_long rcaplong;
 236         union ccb *ccb;
 237         int error;
 238
 239         ccb = cam_getccb(dev);
 240         if (ccb == NULL)
 241                 return (ENOMEM);
 242
 243         /* Zero the rest of the ccb. */
 244         CCB_CLEAR_ALL_EXCEPT_HDR(&ccb->csio);
 245
 246         scsi_read_capacity(&ccb->csio, 1, NULL, MSG_SIMPLE_Q_TAG, &rcap,
 247             SSD_FULL_SIZE, 5000);
 248
 249         /* Disable freezing the device queue */
 250         ccb->ccb_h.flags |= CAM_DEV_QFRZDIS;
 251
 252         if (cam_send_ccb(dev, ccb) < 0) {
 253                 error = errno;
 254                 cam_freeccb(ccb);
 255                 return (error);
 256         }
 257
 258         if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
 259                 cam_freeccb(ccb);
 260                 return (EIO);
 261         }
 262
 263         /*
 264          * A last block of 2^32-1 means that the true capacity is over 2TB,
 265          * and we need to issue the long READ CAPACITY to get the real
 266          * capacity.  Otherwise, we're all set.
 267          */
 268         if (scsi_4btoul(rcap.addr) != 0xffffffff) {
 269                 disk->maxlba = scsi_4btoul(rcap.addr);
 270                 cam_freeccb(ccb);
 271                 return (0);
 272         }
 273
 274         /* Zero the rest of the ccb. */
 275         CCB_CLEAR_ALL_EXCEPT_HDR(&ccb->csio);
 276
 277         scsi_read_capacity_16(&ccb->csio, 1, NULL, MSG_SIMPLE_Q_TAG, 0, 0, 0,
 278             (uint8_t *)&rcaplong, sizeof(rcaplong), SSD_FULL_SIZE, 5000);
 279
 280         /* Disable freezing the device queue */
 281         ccb->ccb_h.flags |= CAM_DEV_QFRZDIS;
 282
 283         if (cam_send_ccb(dev, ccb) < 0) {
 284                 error = errno;
 285                 cam_freeccb(ccb);
 286                 return (error);
 287         }
 288
 289         if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
 290                 cam_freeccb(ccb);
 291                 return (EIO);
 292         }
 293         cam_freeccb(ccb);
 294
 295         disk->maxlba = scsi_8btou64(rcaplong.addr);
 296         return (0);
 297 }
 298
 299 /* Borrowed heavily from scsi_all.c:scsi_print_inquiry(). */
 300 static void
 301 format_scsi_inquiry(struct mpt_standalone_disk *disk,
 302     struct scsi_inquiry_data *inq_data)
 303 {
 304         char vendor[16], product[48], revision[16], rstr[12];
 305
 306         if (SID_QUAL_IS_VENDOR_UNIQUE(inq_data))
 307                 return;
 308         if (SID_TYPE(inq_data) != T_DIRECT)
 309                 return;
 310         if (SID_QUAL(inq_data) != SID_QUAL_LU_CONNECTED)
 311                 return;
 312
 313         cam_strvis(vendor, inq_data->vendor, sizeof(inq_data->vendor),
 314             sizeof(vendor));
 315         cam_strvis(product, inq_data->product, sizeof(inq_data->product),
 316             sizeof(product));
 317         cam_strvis(revision, inq_data->revision, sizeof(inq_data->revision),
 318             sizeof(revision));
 319
 320         /* Hack for SATA disks, no idea how to tell speed. */
 321         if (strcmp(vendor, "ATA") == 0) {
 322                 snprintf(disk->inqstring, sizeof(disk->inqstring),
 323                     "<%s %s> SATA", product, revision);
 324                 return;
 325         }
 326
 327         switch (SID_ANSI_REV(inq_data)) {
 328         case SCSI_REV_CCS:
 329                 strcpy(rstr, "SCSI-CCS");
 330                 break;
 331         case 5:
 332                 strcpy(rstr, "SAS");
 333                 break;
 334         default:
 335                 snprintf(rstr, sizeof (rstr), "SCSI-%d",
 336                     SID_ANSI_REV(inq_data));
 337                 break;
 338         }
 339         snprintf(disk->inqstring, sizeof(disk->inqstring), "<%s %s %s> %s",
 340             vendor, product, revision, rstr);
 341 }
 342
 343 /* Much borrowed from scsiinquiry() in src/sbin/camcontrol/camcontrol.c. */
 344 static int
 345 fetch_scsi_inquiry(struct cam_device *dev, struct mpt_standalone_disk *disk)
 346 {
 347         struct scsi_inquiry_data *inq_buf;
 348         union ccb *ccb;
 349         int error;
 350
 351         ccb = cam_getccb(dev);
 352         if (ccb == NULL)
 353                 return (ENOMEM);
 354
 355         /* Zero the rest of the ccb. */
 356         CCB_CLEAR_ALL_EXCEPT_HDR(&ccb->csio);
 357
 358         inq_buf = calloc(1, sizeof(*inq_buf));
 359         if (inq_buf == NULL) {
 360                 cam_freeccb(ccb);
 361                 return (ENOMEM);
 362         }
 363         scsi_inquiry(&ccb->csio, 1, NULL, MSG_SIMPLE_Q_TAG, (void *)inq_buf,
 364             SHORT_INQUIRY_LENGTH, 0, 0, SSD_FULL_SIZE, 5000);
 365
 366         /* Disable freezing the device queue */
 367         ccb->ccb_h.flags |= CAM_DEV_QFRZDIS;
 368
 369         if (cam_send_ccb(dev, ccb) < 0) {
 370                 error = errno;
 371                 free(inq_buf);
 372                 cam_freeccb(ccb);
 373                 return (error);
 374         }
 375
 376         if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
 377                 free(inq_buf);
 378                 cam_freeccb(ccb);
 379                 return (EIO);
 380         }
 381
 382         cam_freeccb(ccb);
 383         format_scsi_inquiry(disk, inq_buf);
 384         free(inq_buf);
 385         return (0);
 386 }
 387
 388 int
 389 mpt_fetch_disks(int fd, int *ndisks, struct mpt_standalone_disk **disksp)
 390 {
 391         CONFIG_PAGE_IOC_2 *ioc2;
 392         struct mpt_standalone_disk *disks;
 393         struct periph_match_pattern *p;
 394         struct periph_match_result *r;
 395         struct cam_device *dev;
 396         union ccb ccb;
 397         path_id_t path_id;
 398         size_t bufsize;
 399         int count, error;
 400         uint32_t i;
 401
 402         if (xpt_open() < 0)
 403                 return (ENXIO);
 404
 405         error = fetch_path_id(&path_id);
 406         if (error)
 407                 return (error);
 408
 409         for (count = 100;; count+= 100) {
 410                 /* Try to fetch 'count' disks in one go. */
 411                 bzero(&ccb, sizeof(ccb));
 412
 413                 ccb.ccb_h.func_code = XPT_DEV_MATCH;
 414
 415                 bufsize = sizeof(struct dev_match_result) * (count + 1);
 416                 ccb.cdm.num_matches = 0;
 417                 ccb.cdm.match_buf_len = bufsize;
 418                 ccb.cdm.matches = calloc(1, bufsize);
 419
 420                 bufsize = sizeof(struct dev_match_pattern) * 1;
 421                 ccb.cdm.num_patterns = 1;
 422                 ccb.cdm.pattern_buf_len = bufsize;
 423                 ccb.cdm.patterns = calloc(1, bufsize);
 424
 425                 /* Match any "da" peripherals. */
 426                 ccb.cdm.patterns[0].type = DEV_MATCH_PERIPH;
 427                 p = &ccb.cdm.patterns[0].pattern.periph_pattern;
 428                 p->path_id = path_id;
 429                 snprintf(p->periph_name, sizeof(p->periph_name), "da");
 430                 p->flags = PERIPH_MATCH_PATH | PERIPH_MATCH_NAME;
 431
 432                 if (ioctl(xptfd, CAMIOCOMMAND, &ccb) < 0) {
 433                         error = errno;
 434                         free(ccb.cdm.matches);
 435                         free(ccb.cdm.patterns);
 436                         return (error);
 437                 }
 438                 free(ccb.cdm.patterns);
 439
 440                 /* Check for CCB errors. */
 441                 if ((ccb.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
 442                         free(ccb.cdm.matches);
 443                         return (EIO);
 444                 }
 445
 446                 /* If we need a longer list, try again. */
 447                 if (ccb.cdm.status == CAM_DEV_MATCH_MORE) {
 448                         free(ccb.cdm.matches);
 449                         continue;
 450                 }
 451
 452                 /* If we got an error, abort. */
 453                 if (ccb.cdm.status != CAM_DEV_MATCH_LAST) {
 454                         free(ccb.cdm.matches);
 455                         return (EIO);
 456                 }
 457                 break;
 458         }
 459
 460         /* Shortcut if we don't have any "da" devices. */
 461         if (ccb.cdm.num_matches == 0) {
 462                 free(ccb.cdm.matches);
 463                 *ndisks = 0;
 464                 *disksp = NULL;
 465                 return (0);
 466         }
 467
 468         /* We should have N matches, 1 for each "da" device. */
 469         for (i = 0; i < ccb.cdm.num_matches; i++) {
 470                 if (ccb.cdm.matches[i].type != DEV_MATCH_PERIPH) {
 471                         warnx("mpt_fetch_disks got wrong CAM matches");
 472                         free(ccb.cdm.matches);
 473                         return (EIO);
 474                 }
 475         }
 476
 477         /*
 478          * Some of the "da" peripherals may be for RAID volumes, so
 479          * fetch the IOC 2 page (list of RAID volumes) so we can
 480          * exclude them from the list.
 481          */
 482         ioc2 = mpt_read_ioc_page(fd, 2, NULL);
 483         if (ioc2 == NULL)
 484                 return (errno);
 485         disks = calloc(ccb.cdm.num_matches, sizeof(*disks));
 486         count = 0;
 487         for (i = 0; i < ccb.cdm.num_matches; i++) {
 488                 r = &ccb.cdm.matches[i].result.periph_result;
 489                 if (periph_is_volume(ioc2, r))
 490                         continue;
 491                 disks[count].bus = 0;
 492                 disks[count].target = r->target_id;
 493                 snprintf(disks[count].devname, sizeof(disks[count].devname),
 494                     "%s%d", r->periph_name, r->unit_number);
 495
 496                 dev = cam_open_device(disks[count].devname, O_RDWR);
 497                 if (dev != NULL) {
 498                         fetch_scsi_capacity(dev, &disks[count]);
 499                         fetch_scsi_inquiry(dev, &disks[count]);
 500                         cam_close_device(dev);
 501                 }
 502                 count++;
 503         }
 504         free(ccb.cdm.matches);
 505         free(ioc2);
 506
 507         *ndisks = count;
 508         *disksp = disks;
 509         return (0);
 510 }
 511
 512 /*
 513  * Instruct the mpt(4) device to rescan its busses to find new devices
 514  * such as disks whose RAID physdisk page was removed or volumes that
 515  * were created.  If id is -1, the entire bus is rescanned.
 516  * Otherwise, only devices at the specified ID are rescanned.  If bus
 517  * is -1, then all busses are scanned instead of the specified bus.
 518  * Note that currently, only bus 0 is supported.
 519  */
 520 int
 521 mpt_rescan_bus(int bus, int id)
 522 {
 523         union ccb ccb;
 524         path_id_t path_id;
 525         int error;
 526
 527         /* mpt(4) only handles devices on bus 0. */
 528         if (bus != -1 && bus != 0)
 529                 return (EINVAL);
 530
 531         if (xpt_open() < 0)
 532                 return (ENXIO);
 533
 534         error = fetch_path_id(&path_id);
 535         if (error)
 536                 return (error);
 537
 538         /* Perform the actual rescan. */
 539         bzero(&ccb, sizeof(ccb));
 540         ccb.ccb_h.path_id = path_id;
 541         if (id == -1) {
 542                 ccb.ccb_h.func_code = XPT_SCAN_BUS;
 543                 ccb.ccb_h.target_id = CAM_TARGET_WILDCARD;
 544                 ccb.ccb_h.target_lun = CAM_LUN_WILDCARD;
 545                 ccb.ccb_h.timeout = 5000;
 546         } else {
 547                 ccb.ccb_h.func_code = XPT_SCAN_LUN;
 548                 ccb.ccb_h.target_id = id;
 549                 ccb.ccb_h.target_lun = 0;
 550         }
 551         ccb.crcn.flags = CAM_FLAG_NONE;
 552
 553         /* Run this at a low priority. */
 554         ccb.ccb_h.pinfo.priority = 5;
 555
 556         if (ioctl(xptfd, CAMIOCOMMAND, &ccb) == -1)
 557                 return (errno);
 558
 559         if ((ccb.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
 560                 warnx("mpt_rescan_bus rescan got CAM error %#x\n",
 561                     ccb.ccb_h.status & CAM_STATUS_MASK);
 562                 return (EIO);
 563         }
 564
 565         return (0);
 566 }