usr.sbin/mptutil/mpt_volume.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2008 Yahoo!, Inc.
   5  * All rights reserved.
   6  * Written by: John Baldwin <jhb@FreeBSD.org>
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __RCSID("$FreeBSD$");
  35
  36 #include <sys/param.h>
  37 #include <sys/errno.h>
  38 #include <err.h>
  39 #include <libutil.h>
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <unistd.h>
  44 #include <ctype.h>
  45 #include "mptutil.h"
  46
  47 MPT_TABLE(top, volume);
  48
  49 const char *
  50 mpt_volstate(U8 State)
  51 {
  52         static char buf[16];
  53
  54         switch (State) {
  55         case MPI_RAIDVOL0_STATUS_STATE_OPTIMAL:
  56                 return ("OPTIMAL");
  57         case MPI_RAIDVOL0_STATUS_STATE_DEGRADED:
  58                 return ("DEGRADED");
  59         case MPI_RAIDVOL0_STATUS_STATE_FAILED:
  60                 return ("FAILED");
  61         case MPI_RAIDVOL0_STATUS_STATE_MISSING:
  62                 return ("MISSING");
  63         default:
  64                 sprintf(buf, "VSTATE 0x%02x", State);
  65                 return (buf);
  66         }
  67 }
  68
  69 static int
  70 volume_name(int ac, char **av)
  71 {
  72         CONFIG_PAGE_RAID_VOL_1 *vnames;
  73         U8 VolumeBus, VolumeID;
  74         int error, fd;
  75
  76         if (ac != 3) {
  77                 warnx("name: volume and name required");
  78                 return (EINVAL);
  79         }
  80
  81         if (strlen(av[2]) >= sizeof(vnames->Name)) {
  82                 warnx("name: new name is too long");
  83                 return (ENOSPC);
  84         }
  85
  86         fd = mpt_open(mpt_unit);
  87         if (fd < 0) {
  88                 error = errno;
  89                 warn("mpt_open");
  90                 return (error);
  91         }
  92
  93         error = mpt_lookup_volume(fd, av[1], &VolumeBus, &VolumeID);
  94         if (error) {
  95                 warnc(error, "Invalid volume: %s", av[1]);
  96                 return (error);
  97         }
  98
  99         vnames = mpt_vol_names(fd, VolumeBus, VolumeID, NULL);
 100         if (vnames == NULL) {
 101                 error = errno;
 102                 warn("Failed to fetch volume names");
 103                 close(fd);
 104                 return (error);
 105         }
 106
 107         if (vnames->Header.PageType != MPI_CONFIG_PAGEATTR_CHANGEABLE) {
 108                 warnx("Volume name is read only");
 109                 free(vnames);
 110                 close(fd);
 111                 return (EOPNOTSUPP);
 112         }
 113         printf("mpt%u changing volume %s name from \"%s\" to \"%s\"\n",
 114             mpt_unit, mpt_volume_name(VolumeBus, VolumeID), vnames->Name,
 115             av[2]);
 116         bzero(vnames->Name, sizeof(vnames->Name));
 117         strcpy(vnames->Name, av[2]);
 118
 119         if (mpt_write_config_page(fd, vnames, NULL) < 0) {
 120                 error = errno;
 121                 warn("Failed to set volume name");
 122                 free(vnames);
 123                 close(fd);
 124                 return (error);
 125         }
 126
 127         free(vnames);
 128         close(fd);
 129
 130         return (0);
 131 }
 132 MPT_COMMAND(top, name, volume_name);
 133
 134 static int
 135 volume_status(int ac, char **av)
 136 {
 137         MPI_RAID_VOL_INDICATOR prog;
 138         RAID_VOL0_STATUS VolumeStatus;
 139         uint64_t total, remaining;
 140         float pct;
 141         U8 VolumeBus, VolumeID;
 142         int error, fd;
 143
 144         if (ac != 2) {
 145                 warnx("volume status: %s", ac > 2 ? "extra arguments" :
 146                     "volume required");
 147                 return (EINVAL);
 148         }
 149
 150         fd = mpt_open(mpt_unit);
 151         if (fd < 0) {
 152                 error = errno;
 153                 warn("mpt_open");
 154                 return (error);
 155         }
 156
 157         error = mpt_lookup_volume(fd, av[1], &VolumeBus, &VolumeID);
 158         if (error) {
 159                 warnc(error, "Invalid volume: %s", av[1]);
 160                 close(fd);
 161                 return (error);
 162         }
 163
 164         error = mpt_raid_action(fd, MPI_RAID_ACTION_INDICATOR_STRUCT, VolumeBus,
 165             VolumeID, 0, 0, NULL, 0, &VolumeStatus, (U32 *)&prog, sizeof(prog),
 166             NULL, NULL, 0);
 167         if (error) {
 168                 warnc(error, "Fetching volume status failed");
 169                 close(fd);
 170                 return (error);
 171         }
 172
 173         printf("Volume %s status:\n", mpt_volume_name(VolumeBus, VolumeID));
 174         printf("    state: %s\n", mpt_volstate(VolumeStatus.State));
 175         printf("    flags:");
 176         if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_ENABLED)
 177                 printf(" ENABLED");
 178         else
 179                 printf(" DISABLED");
 180         if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_QUIESCED)
 181                 printf(", QUIESCED");
 182         if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_RESYNC_IN_PROGRESS)
 183                 printf(", REBUILDING");
 184         if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_VOLUME_INACTIVE)
 185                 printf(", INACTIVE");
 186         if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_BAD_BLOCK_TABLE_FULL)
 187                 printf(", BAD BLOCK TABLE FULL");
 188         printf("\n");
 189         if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_RESYNC_IN_PROGRESS) {
 190                 total = (uint64_t)prog.TotalBlocks.High << 32 |
 191                     prog.TotalBlocks.Low;
 192                 remaining = (uint64_t)prog.BlocksRemaining.High << 32 |
 193                     prog.BlocksRemaining.Low;
 194                 pct = (float)(total - remaining) * 100 / total;
 195                 printf("   resync: %.2f%% complete\n", pct);
 196         }
 197
 198         close(fd);
 199         return (0);
 200 }
 201 MPT_COMMAND(volume, status, volume_status);
 202
 203 static int
 204 volume_cache(int ac, char **av)
 205 {
 206         CONFIG_PAGE_RAID_VOL_0 *volume;
 207         U32 Settings, NewSettings;
 208         U8 VolumeBus, VolumeID;
 209         char *s1;
 210         int error, fd;
 211
 212         if (ac != 3) {
 213                 warnx("volume cache: %s", ac > 3 ? "extra arguments" :
 214                     "missing arguments");
 215                 return (EINVAL);
 216         }
 217
 218         for (s1 = av[2]; *s1 != '\0'; s1++)
 219                 *s1 = tolower(*s1);
 220         if ((strcmp(av[2], "enable")) && (strcmp(av[2], "enabled")) &&
 221             (strcmp(av[2], "disable")) && (strcmp(av[2], "disabled"))) {
 222                 warnx("volume cache: invalid flag, must be 'enable' or 'disable'\n");
 223                 return (EINVAL);
 224         }
 225
 226         fd = mpt_open(mpt_unit);
 227         if (fd < 0) {
 228                 error = errno;
 229                 warn("mpt_open");
 230                 return (error);
 231         }
 232
 233         error = mpt_lookup_volume(fd, av[1], &VolumeBus, &VolumeID);
 234         if (error) {
 235                 warnc(error, "Invalid volume: %s", av[1]);
 236                 close(fd);
 237                 return (error);
 238         }
 239
 240         volume = mpt_vol_info(fd, VolumeBus, VolumeID, NULL);
 241         if (volume == NULL) {
 242                 close(fd);
 243                 return (errno);
 244         }
 245
 246         Settings = volume->VolumeSettings.Settings;
 247
 248         NewSettings = Settings;
 249         if (strncmp(av[2], "enable", sizeof("enable")) == 0)
 250                 NewSettings |= 0x01;
 251         if (strncmp(av[2], "disable", sizeof("disable")) == 0)
 252                 NewSettings &= ~0x01;
 253
 254         if (NewSettings == Settings) {
 255                 warnx("volume cache unchanged");
 256                 free(volume);
 257                 close(fd);
 258                 return (0);
 259         }
 260
 261         volume->VolumeSettings.Settings = NewSettings;
 262         error = mpt_raid_action(fd, MPI_RAID_ACTION_CHANGE_VOLUME_SETTINGS,
 263             VolumeBus, VolumeID, 0, *(U32 *)&volume->VolumeSettings, NULL, 0,
 264             NULL, NULL, 0, NULL, NULL, 0);
 265         if (error)
 266                 warnc(error, "volume cache change failed");
 267
 268         close(fd);
 269         return (error);
 270 }
 271 MPT_COMMAND(volume, cache, volume_cache);