usr.sbin/mptutil/mpt_drive.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  * $FreeBSD: src/usr.sbin/mptutil/mpt_drive.c,v 1.2 2010/11/09 19:28:06 jhb Exp $
  31  */
  32
  33 #include <sys/param.h>
  34 #include <sys/errno.h>
  35 #include <ctype.h>
  36 #include <err.h>
  37 #include <libutil.h>
  38 #include <limits.h>
  39 #include <stdio.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42 #include <strings.h>
  43 #include <unistd.h>
  44
  45 #include <camlib.h>
  46 #include <cam/scsi/scsi_all.h>
  47
  48 #include "mptutil.h"
  49
  50 const char *
  51 mpt_pdstate(CONFIG_PAGE_RAID_PHYS_DISK_0 *info)
  52 {
  53         static char buf[16];
  54
  55         switch (info->PhysDiskStatus.State) {
  56         case MPI_PHYSDISK0_STATUS_ONLINE:
  57                 if ((info->PhysDiskStatus.Flags &
  58                     MPI_PHYSDISK0_STATUS_FLAG_OUT_OF_SYNC) &&
  59                     info->PhysDiskSettings.HotSparePool == 0)
  60                         return ("REBUILD");
  61                 else
  62                         return ("ONLINE");
  63         case MPI_PHYSDISK0_STATUS_MISSING:
  64                 return ("MISSING");
  65         case MPI_PHYSDISK0_STATUS_NOT_COMPATIBLE:
  66                 return ("NOT COMPATIBLE");
  67         case MPI_PHYSDISK0_STATUS_FAILED:
  68                 return ("FAILED");
  69         case MPI_PHYSDISK0_STATUS_INITIALIZING:
  70                 return ("INITIALIZING");
  71         case MPI_PHYSDISK0_STATUS_OFFLINE_REQUESTED:
  72                 return ("OFFLINE REQUESTED");
  73         case MPI_PHYSDISK0_STATUS_FAILED_REQUESTED:
  74                 return ("FAILED REQUESTED");
  75         case MPI_PHYSDISK0_STATUS_OTHER_OFFLINE:
  76                 return ("OTHER OFFLINE");
  77         default:
  78                 sprintf(buf, "PSTATE 0x%02x", info->PhysDiskStatus.State);
  79                 return (buf);
  80         }
  81 }
  82
  83 /*
  84  * There are several ways to enumerate physical disks.  Unfortunately,
  85  * none of them are truly complete, so we have to build a union of all of
  86  * them.  Specifically:
  87  *
  88  * - IOC2 : This gives us a list of volumes, and by walking the volumes we
  89  *          can enumerate all of the drives attached to volumes including
  90  *          online drives and failed drives.
  91  * - IOC3 : This gives us a list of all online physical drives including
  92  *          drives that are not part of a volume nor a spare drive.  It
  93  *          does not include any failed drives.
  94  * - IOC5 : This gives us a list of all spare drives including failed
  95  *          spares.
  96  *
  97  * The specific edge cases are that 1) a failed volume member can only be
  98  * found via IOC2, 2) a drive that is neither a volume member nor a spare
  99  * can only be found via IOC3, and 3) a failed spare can only be found via
 100  * IOC5.
 101  *
 102  * To handle this, walk all of the three lists and use the following
 103  * routine to add each drive encountered.  It quietly succeeds if the
 104  * drive is already present in the list.  It also sorts the list as it
 105  * inserts new drives.
 106  */
 107 static int
 108 mpt_pd_insert(int fd, struct mpt_drive_list *list, U8 PhysDiskNum)
 109 {
 110         int i, j;
 111
 112         /*
 113          * First, do a simple linear search to see if we have already
 114          * seen this drive.
 115          */
 116         for (i = 0; i < list->ndrives; i++) {
 117                 if (list->drives[i]->PhysDiskNum == PhysDiskNum)
 118                         return (0);
 119                 if (list->drives[i]->PhysDiskNum > PhysDiskNum)
 120                         break;
 121         }
 122
 123         /*
 124          * 'i' is our slot for the 'new' drive.  Make room and then
 125          * read the drive info.
 126          */
 127         for (j = list->ndrives - 1; j >= i; j--)
 128                 list->drives[j + 1] = list->drives[j];
 129         list->drives[i] = mpt_pd_info(fd, PhysDiskNum, NULL);
 130         if (list->drives[i] == NULL)
 131                 return (errno);
 132         list->ndrives++;
 133         return (0);
 134 }
 135
 136 struct mpt_drive_list *
 137 mpt_pd_list(int fd)
 138 {
 139         CONFIG_PAGE_IOC_2 *ioc2;
 140         CONFIG_PAGE_IOC_2_RAID_VOL *vol;
 141         CONFIG_PAGE_RAID_VOL_0 **volumes;
 142         RAID_VOL0_PHYS_DISK *rdisk;
 143         CONFIG_PAGE_IOC_3 *ioc3;
 144         IOC_3_PHYS_DISK *disk;
 145         CONFIG_PAGE_IOC_5 *ioc5;
 146         IOC_5_HOT_SPARE *spare;
 147         struct mpt_drive_list *list;
 148         int count, error, i, j;
 149
 150         ioc2 = mpt_read_ioc_page(fd, 2, NULL);
 151         if (ioc2 == NULL) {
 152                 error = errno;
 153                 warn("Failed to fetch volume list");
 154                 errno = error;
 155                 return (NULL);
 156         }
 157
 158         ioc3 = mpt_read_ioc_page(fd, 3, NULL);
 159         if (ioc3 == NULL) {
 160                 error = errno;
 161                 warn("Failed to fetch drive list");
 162                 free(ioc2);
 163                 errno = error;
 164                 return (NULL);
 165         }
 166
 167         ioc5 = mpt_read_ioc_page(fd, 5, NULL);
 168         if (ioc5 == NULL) {
 169                 error = errno;
 170                 warn("Failed to fetch spare list");
 171                 free(ioc3);
 172                 free(ioc2);
 173                 errno = error;
 174                 return (NULL);
 175         }
 176
 177         /*
 178          * Go ahead and read the info for all the volumes.  For this
 179          * pass we figure out how many physical drives there are.
 180          */
 181         volumes = malloc(sizeof(*volumes) * ioc2->NumActiveVolumes);
 182         count = 0;
 183         vol = ioc2->RaidVolume;
 184         for (i = 0; i < ioc2->NumActiveVolumes; vol++, i++) {
 185                 volumes[i] = mpt_vol_info(fd, vol->VolumeBus, vol->VolumeID,
 186                     NULL);
 187                 if (volumes[i] == NULL) {
 188                         error = errno;
 189                         warn("Failed to read volume info");
 190                         errno = error;
 191                         return (NULL);
 192                 }
 193                 count += volumes[i]->NumPhysDisks;
 194         }
 195         count += ioc3->NumPhysDisks;
 196         count += ioc5->NumHotSpares;
 197
 198         /* Walk the various lists enumerating drives. */
 199         list = malloc(sizeof(*list) + sizeof(CONFIG_PAGE_RAID_PHYS_DISK_0) *
 200             count);
 201         list->ndrives = 0;
 202
 203         for (i = 0; i < ioc2->NumActiveVolumes; i++) {
 204                 rdisk = volumes[i]->PhysDisk;
 205                 for (j = 0; j < volumes[i]->NumPhysDisks; rdisk++, j++)
 206                         if (mpt_pd_insert(fd, list, rdisk->PhysDiskNum) < 0)
 207                                 return (NULL);
 208                 free(volumes[i]);
 209         }
 210         free(ioc2);
 211         free(volumes);
 212
 213         spare = ioc5->HotSpare;
 214         for (i = 0; i < ioc5->NumHotSpares; spare++, i++)
 215                 if (mpt_pd_insert(fd, list, spare->PhysDiskNum) < 0)
 216                         return (NULL);
 217         free(ioc5);
 218
 219         disk = ioc3->PhysDisk;
 220         for (i = 0; i < ioc3->NumPhysDisks; disk++, i++)
 221                 if (mpt_pd_insert(fd, list, disk->PhysDiskNum) < 0)
 222                         return (NULL);
 223         free(ioc3);
 224
 225         return (list);
 226 }
 227
 228 void
 229 mpt_free_pd_list(struct mpt_drive_list *list)
 230 {
 231         int i;
 232
 233         for (i = 0; i < list->ndrives; i++)
 234                 free(list->drives[i]);
 235         free(list);
 236 }
 237
 238 int
 239 mpt_lookup_drive(struct mpt_drive_list *list, const char *drive,
 240     U8 *PhysDiskNum)
 241 {
 242         long val;
 243         uint8_t bus, id;
 244         char *cp;
 245
 246         /* Look for a raw device id first. */
 247         val = strtol(drive, &cp, 0);
 248         if (*cp == '\0') {
 249                 if (val < 0 || val > 0xff)
 250                         goto bad;
 251                 *PhysDiskNum = val;
 252                 return (0);
 253         }
 254
 255         /* Look for a <bus>:<id> string. */
 256         if (*cp == ':') {
 257                 if (val < 0 || val > 0xff)
 258                         goto bad;
 259                 bus = val;
 260                 val = strtol(cp + 1, &cp, 0);
 261                 if (*cp != '\0')
 262                         goto bad;
 263                 if (val < 0 || val > 0xff)
 264                         goto bad;
 265                 id = val;
 266
 267                 for (val = 0; val < list->ndrives; val++) {
 268                         if (list->drives[val]->PhysDiskBus == bus &&
 269                             list->drives[val]->PhysDiskID == id) {
 270                                 *PhysDiskNum = list->drives[val]->PhysDiskNum;
 271                                 return (0);
 272                         }
 273                 }
 274                 return (ENOENT);
 275         }
 276
 277 bad:
 278         return (EINVAL);
 279 }
 280
 281 /* Borrowed heavily from scsi_all.c:scsi_print_inquiry(). */
 282 const char *
 283 mpt_pd_inq_string(CONFIG_PAGE_RAID_PHYS_DISK_0 *pd_info)
 284 {
 285         RAID_PHYS_DISK0_INQUIRY_DATA *inq_data;
 286         u_char vendor[9], product[17], revision[5];
 287         static char inq_string[64];
 288
 289         inq_data = &pd_info->InquiryData;
 290         cam_strvis(vendor, inq_data->VendorID, sizeof(inq_data->VendorID),
 291             sizeof(vendor));
 292         cam_strvis(product, inq_data->ProductID, sizeof(inq_data->ProductID),
 293             sizeof(product));
 294         cam_strvis(revision, inq_data->ProductRevLevel,
 295             sizeof(inq_data->ProductRevLevel), sizeof(revision));
 296
 297         /* Total hack. */
 298         if (strcmp(vendor, "ATA") == 0)
 299                 snprintf(inq_string, sizeof(inq_string), "<%s %s> SATA",
 300                     product, revision);
 301         else
 302                 snprintf(inq_string, sizeof(inq_string), "<%s %s %s> SAS",
 303                     vendor, product, revision);
 304         return (inq_string);
 305 }
 306
 307 /* Helper function to set a drive to a given state. */
 308 static int
 309 drive_set_state(char *drive, U8 Action, U8 State, const char *name)
 310 {
 311         CONFIG_PAGE_RAID_PHYS_DISK_0 *info;
 312         struct mpt_drive_list *list;
 313         U8 PhysDiskNum;
 314         int error, fd;
 315
 316         fd = mpt_open(mpt_unit);
 317         if (fd < 0) {
 318                 error = errno;
 319                 warn("mpt_open");
 320                 return (error);
 321         }
 322
 323         list = mpt_pd_list(fd);
 324         if (list == NULL)
 325                 return (errno);
 326
 327         if (mpt_lookup_drive(list, drive, &PhysDiskNum) < 0) {
 328                 error = errno;
 329                 warn("Failed to find drive %s", drive);
 330                 return (error);
 331         }
 332         mpt_free_pd_list(list);
 333
 334         /* Get the info for this drive. */
 335         info = mpt_pd_info(fd, PhysDiskNum, NULL);
 336         if (info == NULL) {
 337                 error = errno;
 338                 warn("Failed to fetch info for drive %u", PhysDiskNum);
 339                 return (error);
 340         }
 341
 342         /* Try to change the state. */
 343         if (info->PhysDiskStatus.State == State) {
 344                 warnx("Drive %u is already in the desired state", PhysDiskNum);
 345                 return (EINVAL);
 346         }
 347
 348         error = mpt_raid_action(fd, Action, 0, 0, PhysDiskNum, 0, NULL, 0, NULL,
 349             NULL, 0, NULL, NULL, 0);
 350         if (error) {
 351                 warnc(error, "Failed to set drive %u to %s", PhysDiskNum, name);
 352                 return (error);
 353         }
 354
 355         free(info);
 356         close(fd);
 357
 358         return (0);
 359 }
 360
 361 static int
 362 fail_drive(int ac, char **av)
 363 {
 364
 365         if (ac != 2) {
 366                 warnx("fail: %s", ac > 2 ? "extra arguments" :
 367                     "drive required");
 368                 return (EINVAL);
 369         }
 370
 371         return (drive_set_state(av[1], MPI_RAID_ACTION_FAIL_PHYSDISK,
 372             MPI_PHYSDISK0_STATUS_FAILED_REQUESTED, "FAILED"));
 373 }
 374 MPT_COMMAND(top, fail, fail_drive);
 375
 376 static int
 377 online_drive(int ac, char **av)
 378 {
 379
 380         if (ac != 2) {
 381                 warnx("online: %s", ac > 2 ? "extra arguments" :
 382                     "drive required");
 383                 return (EINVAL);
 384         }
 385
 386         return (drive_set_state(av[1], MPI_RAID_ACTION_PHYSDISK_ONLINE,
 387             MPI_PHYSDISK0_STATUS_ONLINE, "ONLINE"));
 388 }
 389 MPT_COMMAND(top, online, online_drive);
 390
 391 static int
 392 offline_drive(int ac, char **av)
 393 {
 394
 395         if (ac != 2) {
 396                 warnx("offline: %s", ac > 2 ? "extra arguments" :
 397                     "drive required");
 398                 return (EINVAL);
 399         }
 400
 401         return (drive_set_state(av[1], MPI_RAID_ACTION_PHYSDISK_OFFLINE,
 402             MPI_PHYSDISK0_STATUS_OFFLINE_REQUESTED, "OFFLINE"));
 403 }
 404 MPT_COMMAND(top, offline, offline_drive);