mfiutil.c revision 249257 
1/*-
2 * Copyright (c) 2008, 2009 Yahoo!, Inc.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. The names of the authors may not be used to endorse or promote
14 *    products derived from this software without specific prior written
15 *    permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: head/usr.sbin/mfiutil/mfiutil.c 249257 2013-04-08 17:46:45Z markj $
30 */
31
32#include <sys/errno.h>
33#include <err.h>
34#include <stdio.h>
35#include <stdlib.h>
36#include <string.h>
37#include <unistd.h>
38#include "mfiutil.h"
39
40SET_DECLARE(MFI_DATASET(top), struct mfiutil_command);
41
42MFI_TABLE(top, start);
43MFI_TABLE(top, stop);
44MFI_TABLE(top, abort);
45
46int mfi_unit;
47u_int mfi_opts;
48static int fw_name_width, fw_version_width, fw_date_width, fw_time_width;
49
50static void
51usage(void)
52{
53
54	fprintf(stderr, "usage: mfiutil [-de] [-u unit] <command> ...\n\n");
55	fprintf(stderr, "Commands include:\n");
56	fprintf(stderr, "    version\n");
57	fprintf(stderr, "    show adapter              - display controller information\n");
58	fprintf(stderr, "    show battery              - display battery information\n");
59	fprintf(stderr, "    show config               - display RAID configuration\n");
60	fprintf(stderr, "    show drives               - list physical drives\n");
61	fprintf(stderr, "    show events               - display event log\n");
62	fprintf(stderr, "    show firmware             - list firmware images\n");
63	fprintf(stderr, "    show logstate             - display event log sequence numbers\n");
64	fprintf(stderr, "    show volumes              - list logical volumes\n");
65	fprintf(stderr, "    show patrol               - display patrol read status\n");
66	fprintf(stderr, "    show progress             - display status of active operations\n");
67	fprintf(stderr, "    fail <drive>              - fail a physical drive\n");
68	fprintf(stderr, "    good <drive>              - mark a bad physical drive as good\n");
69	fprintf(stderr, "    rebuild <drive>           - mark failed drive ready for rebuild\n");
70	fprintf(stderr, "    drive progress <drive>    - display status of active operations\n");
71	fprintf(stderr, "    drive clear <drive> <start|stop> - clear a drive with all 0x00\n");
72	fprintf(stderr, "    start rebuild <drive>\n");
73	fprintf(stderr, "    abort rebuild <drive>\n");
74	fprintf(stderr, "    locate <drive> <on|off>   - toggle drive LED\n");
75	fprintf(stderr, "    cache <volume> [command [setting]]\n");
76	fprintf(stderr, "    name <volume> <name>\n");
77	fprintf(stderr, "    volume progress <volume>  - display status of active operations\n");
78	fprintf(stderr, "    clear                     - clear volume configuration\n");
79	fprintf(stderr, "    create <type> [-v] <drive>[,<drive>[,...]] [<drive>[,<drive>[,...]]\n");
80	fprintf(stderr, "    delete <volume>\n");
81	fprintf(stderr, "    add <drive> [volume]      - add a hot spare\n");
82	fprintf(stderr, "    remove <drive>            - remove a hot spare\n");
83	fprintf(stderr, "    patrol <disable|auto|manual> [interval [start]]\n");
84	fprintf(stderr, "    start patrol              - start a patrol read\n");
85	fprintf(stderr, "    stop patrol               - stop a patrol read\n");
86	fprintf(stderr, "    flash <firmware>\n");
87	fprintf(stderr, "    start learn               - start a BBU relearn\n");
88	fprintf(stderr, "    bbu <setting> <value>     - set BBU properties\n");
89#ifdef DEBUG
90	fprintf(stderr, "    debug                     - debug 'show config'\n");
91	fprintf(stderr, "    dump                      - display 'saved' config\n");
92#endif
93	exit(1);
94}
95
96static int
97version(int ac __unused, char **av __unused)
98{
99
100	printf("mfiutil version 1.0.14");
101#ifdef DEBUG
102	printf(" (DEBUG)");
103#endif
104	printf("\n");
105	return (0);
106}
107MFI_COMMAND(top, version, version);
108
109int
110main(int ac, char **av)
111{
112	struct mfiutil_command **cmd;
113	int ch;
114
115	while ((ch = getopt(ac, av, "deu:")) != -1) {
116		switch (ch) {
117		case 'd':
118			mfi_opts |= MFI_DNAME_DEVICE_ID;
119			break;
120		case 'e':
121			mfi_opts |= MFI_DNAME_ES;
122			break;
123		case 'u':
124			mfi_unit = atoi(optarg);
125			break;
126		case '?':
127			usage();
128		}
129	}
130
131	av += optind;
132	ac -= optind;
133
134	/* getopt() eats av[0], so we can't use mfi_table_handler() directly. */
135	if (ac == 0)
136		usage();
137
138	SET_FOREACH(cmd, MFI_DATASET(top)) {
139		if (strcmp((*cmd)->name, av[0]) == 0) {
140			if ((*cmd)->handler(ac, av))
141				return (1);
142			else
143				return (0);
144		}
145	}
146	warnx("Unknown command %s.", av[0]);
147	return (1);
148}
149
150void
151scan_firmware(struct mfi_info_component *comp)
152{
153	int len;
154
155	len = strlen(comp->name);
156	if (fw_name_width < len)
157		fw_name_width = len;
158	len = strlen(comp->version);
159	if (fw_version_width < len)
160		fw_version_width = len;
161	len = strlen(comp->build_date);
162	if (fw_date_width < len)
163		fw_date_width = len;
164	len = strlen(comp->build_time);
165	if (fw_time_width < len)
166		fw_time_width = len;
167}
168
169void
170display_firmware(struct mfi_info_component *comp, const char *tag)
171{
172
173	printf("%-*s  %-*s  %-*s  %-*s  %s\n", fw_name_width, comp->name,
174	    fw_version_width, comp->version, fw_date_width, comp->build_date,
175	    fw_time_width, comp->build_time, tag);
176}
177