xref: /freebsd/usr.sbin/mptutil/mpt_volume.c (revision 1670a1c2a47d10ecccd001970b859caf93cd3b6e)
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 <sys/errno.h>
36 #include <err.h>
37 #include <libutil.h>
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <string.h>
41 #include <unistd.h>
42 #include <ctype.h>
43 #include "mptutil.h"
44 
45 MPT_TABLE(top, volume);
46 
47 const char *
48 mpt_volstate(U8 State)
49 {
50 	static char buf[16];
51 
52 	switch (State) {
53 	case MPI_RAIDVOL0_STATUS_STATE_OPTIMAL:
54 		return ("OPTIMAL");
55 	case MPI_RAIDVOL0_STATUS_STATE_DEGRADED:
56 		return ("DEGRADED");
57 	case MPI_RAIDVOL0_STATUS_STATE_FAILED:
58 		return ("FAILED");
59 	case MPI_RAIDVOL0_STATUS_STATE_MISSING:
60 		return ("MISSING");
61 	default:
62 		sprintf(buf, "VSTATE 0x%02x", State);
63 		return (buf);
64 	}
65 }
66 
67 static int
68 volume_name(int ac, char **av)
69 {
70 	CONFIG_PAGE_RAID_VOL_1 *vnames;
71 	U8 VolumeBus, VolumeID;
72 	int fd;
73 
74 	if (ac != 3) {
75 		warnx("name: volume and name required");
76 		return (EINVAL);
77 	}
78 
79 	if (strlen(av[2]) >= sizeof(vnames->Name)) {
80 		warnx("name: new name is too long");
81 		return (ENOSPC);
82 	}
83 
84 	fd = mpt_open(mpt_unit);
85 	if (fd < 0) {
86 		warn("mpt_open");
87 		return (errno);
88 	}
89 
90 	if (mpt_lookup_volume(fd, av[1], &VolumeBus, &VolumeID) < 0) {
91 		warn("Invalid volume: %s", av[1]);
92 		return (errno);
93 	}
94 
95 	vnames = mpt_vol_names(fd, VolumeBus, VolumeID, NULL);
96 	if (vnames == NULL) {
97 		warn("Failed to fetch volume names");
98 		return (errno);
99 	}
100 
101 	if (vnames->Header.PageType != MPI_CONFIG_PAGEATTR_CHANGEABLE) {
102 		warnx("Volume name is read only");
103 		return (EOPNOTSUPP);
104 	}
105 	printf("mpt%u changing volume %s name from \"%s\" to \"%s\"\n",
106 	    mpt_unit, mpt_volume_name(VolumeBus, VolumeID), vnames->Name,
107 	    av[2]);
108 	bzero(vnames->Name, sizeof(vnames->Name));
109 	strcpy(vnames->Name, av[2]);
110 
111 	if (mpt_write_config_page(fd, vnames, NULL) < 0) {
112 		warn("Failed to set volume name");
113 		return (errno);
114 	}
115 
116 	free(vnames);
117 	close(fd);
118 
119 	return (0);
120 }
121 MPT_COMMAND(top, name, volume_name);
122 
123 static int
124 volume_status(int ac, char **av)
125 {
126 	MPI_RAID_VOL_INDICATOR prog;
127 	RAID_VOL0_STATUS VolumeStatus;
128 	uint64_t total, remaining;
129 	float pct;
130 	U8 VolumeBus, VolumeID;
131 	int fd;
132 
133 	if (ac != 2) {
134 		warnx("volume status: %s", ac > 2 ? "extra arguments" :
135 		    "volume required");
136 		return (EINVAL);
137 	}
138 
139 	fd = mpt_open(mpt_unit);
140 	if (fd < 0) {
141 		warn("mpt_open");
142 		return (errno);
143 	}
144 
145 	if (mpt_lookup_volume(fd, av[1], &VolumeBus, &VolumeID) < 0) {
146 		warn("Invalid volume: %s", av[1]);
147 		return (errno);
148 	}
149 
150 	if (mpt_raid_action(fd, MPI_RAID_ACTION_INDICATOR_STRUCT, VolumeBus,
151 	    VolumeID, 0, 0, NULL, 0, &VolumeStatus, (U32 *)&prog, sizeof(prog),
152 	    NULL, NULL, 0) < 0) {
153 		warn("Fetching volume status failed");
154 		return (errno);
155 	}
156 
157 	printf("Volume %s status:\n", mpt_volume_name(VolumeBus, VolumeID));
158 	printf("    state: %s\n", mpt_volstate(VolumeStatus.State));
159 	printf("    flags:");
160 	if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_ENABLED)
161 		printf(" ENABLED");
162 	else
163 		printf(" DISABLED");
164 	if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_QUIESCED)
165 		printf(", QUIESCED");
166 	if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_RESYNC_IN_PROGRESS)
167 		printf(", REBUILDING");
168 	if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_VOLUME_INACTIVE)
169 		printf(", INACTIVE");
170 	if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_BAD_BLOCK_TABLE_FULL)
171 		printf(", BAD BLOCK TABLE FULL");
172 	printf("\n");
173 	if (VolumeStatus.Flags & MPI_RAIDVOL0_STATUS_FLAG_RESYNC_IN_PROGRESS) {
174 		total = (uint64_t)prog.TotalBlocks.High << 32 |
175 		    prog.TotalBlocks.Low;
176 		remaining = (uint64_t)prog.BlocksRemaining.High << 32 |
177 		    prog.BlocksRemaining.Low;
178 		pct = (float)(total - remaining) * 100 / total;
179 		printf("   resync: %.2f%% complete\n", pct);
180 	}
181 
182 	close(fd);
183 	return (0);
184 }
185 MPT_COMMAND(volume, status, volume_status);
186 
187 static int
188 volume_cache(int ac, char **av)
189 {
190 	CONFIG_PAGE_RAID_VOL_0 *volume;
191 	U32 Settings, NewSettings;
192 	U8 VolumeBus, VolumeID;
193 	char *s1;
194 	int fd;
195 
196 	if (ac != 3) {
197 		warnx("volume cache: %s", ac > 3 ? "extra arguments" :
198 		    "volume required");
199 		return (EINVAL);
200 	}
201 
202         for (s1 = av[2]; *s1 != '\0'; s1++)
203                 *s1 = tolower(*s1);
204 	if ((strcmp(av[2], "enable")) && (strcmp(av[2], "enabled")) &&
205 	    (strcmp(av[2], "disable")) && (strcmp(av[2], "disabled"))) {
206 		warnx("volume cache: invalid flag, must be 'enable' or 'disable'\n");
207 		return (EINVAL);
208 	}
209 
210 	fd = mpt_open(mpt_unit);
211 	if (fd < 0) {
212 		warn("mpt_open");
213 		return (errno);
214 	}
215 
216 	if (mpt_lookup_volume(fd, av[1], &VolumeBus, &VolumeID) < 0) {
217 		warn("Invalid volume: %s", av[1]);
218 		return (errno);
219 	}
220 
221 	volume = mpt_vol_info(fd, VolumeBus, VolumeID, NULL);
222 	if (volume == NULL)
223 		return (-1);
224 
225 	Settings = volume->VolumeSettings.Settings;
226 
227 	NewSettings = Settings;
228 	if (strncmp(av[2], "enable", sizeof("enable")) == 0)
229 		NewSettings |= 0x01;
230 	if (strncmp(av[2], "disable", sizeof("disable")) == 0)
231 		NewSettings &= ~0x01;
232 
233 	if (NewSettings == Settings) {
234 		warnx("volume cache unchanged\n");
235 		close(fd);
236 		return (0);
237 	}
238 
239 	volume->VolumeSettings.Settings = NewSettings;
240 	if (mpt_raid_action(fd, MPI_RAID_ACTION_CHANGE_VOLUME_SETTINGS,
241 	    VolumeBus, VolumeID, 0, *(U32 *)&volume->VolumeSettings, NULL, 0,
242 	    NULL, NULL, 0, NULL, NULL, 0) < 0)
243 		warnx("volume cache change failed, errno= %d\n", errno);
244 
245 	close(fd);
246 	return (0);
247 }
248 MPT_COMMAND(volume, cache, volume_cache);
249