MFC: r287473

  Add the new sesutil(8) utility for managing SCSI Enclosure Services (SES) device.

MFC: r287493
  Fix iteration bug

MFC: r287485, r287494, r287992
  Please the angry gcc 4.2 gods

MFC: r287988
  Improve and expand sesutil(8)

  Return an error if no matching device is found
  Locate can address a slot, in addition to a drive
  Added fault, similar to locate but blinks a different LED
  Added the map command, lists all devices connected to the SES controller
  Added the status command, overall status of the SES controller

MFC: r292092
  sesutil: fix map not printing the status of the LED device in an array

MFC: r292093
  sesutil: pass the correct element type when printing the SES map

MFC: r292121
  sesutil: Add extra information specific to some SES devices to sesutil map

MFC: r292122
  Fix sesutil locate when a sesid is passed to locate command

MFC: r292262
  Show the enclosure name and id in sesutil map

Relnotes:	yes
Sponsored by:	Gandi.net
Sponsored by:	ScaleEngine Inc.

1 files changed, 390 insertions, 54 deletions

diff --git a/usr.sbin/sesutil/sesutil.c b/usr.sbin/sesutil/sesutil.c
index 1b38143..0f04c07 100644
--- a/usr.sbin/sesutil/sesutil.c
+++ b/usr.sbin/sesutil/sesutil.c
@@ -1,5 +1,7 @@
 /*-
  * Copyright (c) 2015 Baptiste Daroussin <bapt@FreeBSD.org>
+ * Copyright (c) 2015 Allan Jude <allanjude@FreeBSD.org>
+ * Copyright (c) 2000 by Matthew Jacob
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -29,10 +31,13 @@ __FBSDID("$FreeBSD$");
 
 #include <sys/param.h>
 #include <sys/ioctl.h>
+#include <sys/types.h>
+#include <sys/sbuf.h>
 
 #include <err.h>
 #include <errno.h>
 #include <fcntl.h>
+#include <getopt.h>
 #include <glob.h>
 #include <stdbool.h>
 #include <stddef.h>
@@ -45,21 +50,66 @@ __FBSDID("$FreeBSD$");
 #include <cam/scsi/scsi_all.h>
 #include <cam/scsi/scsi_enc.h>
 
+#include "eltsub.h"
+
+static int encstatus(int argc, char **argv);
+static int fault(int argc, char **argv);
 static int locate(int argc, char **argv);
+static int objmap(int argc, char **argv);
+static int sesled(int argc, char **argv, bool fault);
 
 static struct command {
 	const char *name;
+	const char *param;
 	const char *desc;
 	int (*exec)(int argc, char **argv);
 } cmds[] = {
-	{ "locate", "Change the state of the external LED associated with a"
-	    " disk", locate} ,
+	{ "fault",
+	    "(<disk>|<sesid>|all) (on|off)",
+	    "Change the state of the fault LED associated with a disk",
+	    fault },
+	{ "locate",
+	    "(<disk>|<sesid>|all) (on|off)",
+	    "Change the state of the locate LED associated with a disk",
+	    locate },
+	{ "map", "",
+	    "Print a map of the devices managed by the enclosure", objmap } ,
+	{ "status", "", "Print the status of the enclosure",
+	    encstatus },
 };
 
 static const int nbcmds = nitems(cmds);
+static const char *uflag;
 
 static void
-do_locate(int fd, unsigned int idx, bool onoff)
+usage(FILE *out, const char *subcmd)
+{
+	int i;
+
+	if (subcmd == NULL) {
+		fprintf(out, "Usage: %s [-u /dev/ses<N>] <command> [options]\n",
+		    getprogname());
+		fprintf(out, "Commands supported:\n");
+	}
+	for (i = 0; i < nbcmds; i++) {
+		if (subcmd != NULL) {
+			if (strcmp(subcmd, cmds[i].name) == 0) {
+				fprintf(out, "Usage: %s %s [-u /dev/ses<N>] "
+				    "%s\n\t%s\n", getprogname(), subcmd,
+				    cmds[i].param, cmds[i].desc);
+				break;
+			}
+			continue;
+		}
+		fprintf(out, "    %-12s%s\n\t\t%s\n\n", cmds[i].name,
+		    cmds[i].param, cmds[i].desc);
+	}
+
+	exit(EXIT_FAILURE);
+}
+
+static void
+do_led(int fd, unsigned int idx, bool onoff, bool setfault)
 {
 	encioc_elm_status_t o;
 
@@ -69,10 +119,11 @@ do_locate(int fd, unsigned int idx, bool onoff)
 		err(EXIT_FAILURE, "ENCIOC_GETELMSTAT");
 	}
 	o.cstat[0] |= 0x80;
-	if (onoff)
-		o.cstat[2] |= 0x02;
-	else
-		o.cstat[2] &= 0xfd;
+	if (onoff) {
+		o.cstat[2] |= (setfault ? 0x20 : 0x02);
+	} else {
+		o.cstat[2] &= (setfault ? 0xdf : 0xfd);
+	}
 
 	if (ioctl(fd, ENCIOC_SETELMSTAT, (caddr_t) &o) < 0) {
 		close(fd);
@@ -87,39 +138,54 @@ disk_match(const char *devnames, const char *disk, size_t len)
 
 	dname = devnames;
 	while ((dname = strstr(dname, disk)) != NULL) {
-		if (dname[len] == '\0' || dname[len] == ',')
+		if (dname[len] == '\0' || dname[len] == ',') {
 			return (true);
+		}
 		dname++;
 	}
+
 	return (false);
 }
 
 static int
-locate(int argc, char **argv)
+sesled(int argc, char **argv, bool setfault)
 {
 	encioc_elm_devnames_t objdn;
 	encioc_element_t *objp;
 	glob_t g;
-	char *disk;
-	size_t len, i;
-	int fd, nobj, j;
-	bool all = false;
-	bool onoff;
-
-	if (argc != 2) {
-		errx(EXIT_FAILURE, "usage: %s locate [disk] [on|off]",
-		    getprogname());
+	char *disk, *endptr;
+	size_t len, i, ndisks;
+	int fd;
+	unsigned int nobj, j, sesid;
+	bool all, isses, onoff;
+
+	isses = false;
+	all = false;
+	onoff = false;
+
+	if (argc != 3) {
+		usage(stderr, (setfault ? "fault" : "locate"));
 	}
 
-	disk = argv[0];
+	disk = argv[1];
 
-	if (strcmp(argv[1], "on") == 0) {
+	sesid = strtoul(disk, &endptr, 10);
+	if (*endptr == '\0') {
+		endptr = strrchr(uflag, '*');
+		if (endptr != NULL && *endptr == '*') {
+			warnx("Must specifying a SES device (-u) to use a SES "
+			    "id# to identify a disk");
+			usage(stderr, (setfault ? "fault" : "locate"));
+		}
+		isses = true;
+	}
+
+	if (strcmp(argv[2], "on") == 0) {
 		onoff = true;
-	} else if (strcmp(argv[1], "off") == 0) {
+	} else if (strcmp(argv[2], "off") == 0) {
 		onoff = false;
 	} else {
-		errx(EXIT_FAILURE, "usage: %s locate [disk] [on|off]",
-		    getprogname());
+		usage(stderr, (setfault ? "fault" : "locate"));
 	}
 
 	if (strcmp(disk, "all") == 0) {
@@ -128,97 +194,367 @@ locate(int argc, char **argv)
 	len = strlen(disk);
 
 	/* Get the list of ses devices */
-	if (glob("/dev/ses[0-9]*", 0, NULL, &g) == GLOB_NOMATCH) {
+	if (glob((uflag != NULL ? uflag : "/dev/ses[0-9]*"), 0, NULL, &g) ==
+	    GLOB_NOMATCH) {
 		globfree(&g);
 		errx(EXIT_FAILURE, "No SES devices found");
 	}
+
+	ndisks = 0;
 	for (i = 0; i < g.gl_pathc; i++) {
 		/* ensure we only got numbers after ses */
 		if (strspn(g.gl_pathv[i] + 8, "0123456789") !=
-		    strlen(g.gl_pathv[i] + 8))
+		    strlen(g.gl_pathv[i] + 8)) {
 			continue;
+		}
 		if ((fd = open(g.gl_pathv[i], O_RDWR)) < 0) {
-			if (errno == EACCES)
-				err(EXIT_FAILURE, "enable to access SES device");
-			break;
+			/*
+			 * Don't treat non-access errors as critical if we are
+			 * accessing all devices
+			 */
+			if (errno == EACCES && g.gl_pathc > 1) {
+				err(EXIT_FAILURE, "unable to access SES device");
+			}
+			warn("unable to access SES device: %s", g.gl_pathv[i]);
+			continue;
 		}
 
-		if (ioctl(fd, ENCIOC_GETNELM, (caddr_t) &nobj) < 0)
+		if (ioctl(fd, ENCIOC_GETNELM, (caddr_t) &nobj) < 0) {
+			close(fd);
 			err(EXIT_FAILURE, "ENCIOC_GETNELM");
+		}
 
 		objp = calloc(nobj, sizeof(encioc_element_t));
-		if (objp == NULL)
+		if (objp == NULL) {
+			close(fd);
 			err(EXIT_FAILURE, "calloc()");
+		}
 
-		if (ioctl(fd, ENCIOC_GETELMMAP, (caddr_t) objp) < 0)
+		if (ioctl(fd, ENCIOC_GETELMMAP, (caddr_t) objp) < 0) {
+			close(fd);
 			err(EXIT_FAILURE, "ENCIOC_GETELMMAP");
+		}
 
+		if (isses) {
+			if (sesid > nobj) {
+				close(fd);
+				errx(EXIT_FAILURE,
+				     "Requested SES ID does not exist");
+			}
+			do_led(fd, sesid, onoff, setfault);
+			ndisks++;
+			close(fd);
+			break;
+		}
 		for (j = 0; j < nobj; j++) {
 			memset(&objdn, 0, sizeof(objdn));
 			objdn.elm_idx = objp[j].elm_idx;
 			objdn.elm_names_size = 128;
 			objdn.elm_devnames = calloc(128, sizeof(char));
-			if (objdn.elm_devnames == NULL)
+			if (objdn.elm_devnames == NULL) {
+				close(fd);
 				err(EXIT_FAILURE, "calloc()");
+			}
 			if (ioctl(fd, ENCIOC_GETELMDEVNAMES,
-			    (caddr_t) &objdn) <0)
+			    (caddr_t) &objdn) <0) {
 				continue;
+			}
 			if (objdn.elm_names_len > 0) {
 				if (all) {
-					do_locate(fd, objdn.elm_idx, onoff);
+					do_led(fd, objdn.elm_idx,
+					    onoff, setfault);
 					continue;
 				}
 				if (disk_match(objdn.elm_devnames, disk, len)) {
-					do_locate(fd, objdn.elm_idx, onoff);
+					do_led(fd, objdn.elm_idx,
+					    onoff, setfault);
+					ndisks++;
 					break;
 				}
 			}
-		}	
+		}
 		close(fd);
 	}
 	globfree(&g);
+	if (ndisks == 0 && all == false) {
+		errx(EXIT_FAILURE, "Count not find the SES id of device '%s'",
+		    disk);
+	}
 
 	return (EXIT_SUCCESS);
 }
 
-static void
-usage(FILE *out)
+static int
+locate(int argc, char **argv)
 {
-	int i;
 
-	fprintf(out, "Usage: %s [command] [options]\n", getprogname());
-	fprintf(out, "Commands supported:\n");
-	for (i = 0; i < nbcmds; i++)
-		fprintf(out, "\t%-15s%s\n", cmds[i].name, cmds[i].desc);
+	return (sesled(argc, argv, false));
+}
+
+static int
+fault(int argc, char **argv)
+{
+
+	return (sesled(argc, argv, true));
+}
+
+static int
+objmap(int argc, char **argv __unused)
+{
+	struct sbuf *extra;
+	encioc_string_t stri;
+	encioc_elm_devnames_t e_devname;
+	encioc_elm_status_t e_status;
+	encioc_elm_desc_t e_desc;
+	encioc_element_t *e_ptr;
+	glob_t g;
+	int fd;
+	unsigned int j, nobj;
+	size_t i;
+	char str[32];
+
+	if (argc != 1) {
+		usage(stderr, "map");
+	}
+
+	/* Get the list of ses devices */
+	if (glob(uflag, 0, NULL, &g) == GLOB_NOMATCH) {
+		globfree(&g);
+		errx(EXIT_FAILURE, "No SES devices found");
+	}
+	for (i = 0; i < g.gl_pathc; i++) {
+		/* ensure we only got numbers after ses */
+		if (strspn(g.gl_pathv[i] + 8, "0123456789") !=
+		    strlen(g.gl_pathv[i] + 8)) {
+			continue;
+		}
+		if ((fd = open(g.gl_pathv[i], O_RDWR)) < 0) {
+			/*
+			 * Don't treat non-access errors as critical if we are
+			 * accessing all devices
+			 */
+			if (errno == EACCES && g.gl_pathc > 1) {
+				err(EXIT_FAILURE, "unable to access SES device");
+			}
+			warn("unable to access SES device: %s", g.gl_pathv[i]);
+			continue;
+		}
+
+		if (ioctl(fd, ENCIOC_GETNELM, (caddr_t) &nobj) < 0) {
+			close(fd);
+			err(EXIT_FAILURE, "ENCIOC_GETNELM");
+		}
+
+		e_ptr = calloc(nobj, sizeof(encioc_element_t));
+		if (e_ptr == NULL) {
+			close(fd);
+			err(EXIT_FAILURE, "calloc()");
+		}
+
+		if (ioctl(fd, ENCIOC_GETELMMAP, (caddr_t) e_ptr) < 0) {
+			close(fd);
+			err(EXIT_FAILURE, "ENCIOC_GETELMMAP");
+		}
+
+		printf("%s:\n", g.gl_pathv[i] + 5);
+		stri.bufsiz = sizeof(str);
+		stri.buf = &str[0];
+		if (ioctl(fd, ENCIOC_GETENCNAME, (caddr_t) &stri) == 0)
+			printf("\tEnclosure Name: %s\n", stri.buf);
+		stri.bufsiz = sizeof(str);
+		stri.buf = &str[0];
+		if (ioctl(fd, ENCIOC_GETENCID, (caddr_t) &stri) == 0)
+			printf("\tEnclosure ID: %s\n", stri.buf);
+
+		for (j = 0; j < nobj; j++) {
+			/* Get the status of the element */
+			memset(&e_status, 0, sizeof(e_status));
+			e_status.elm_idx = e_ptr[j].elm_idx;
+			if (ioctl(fd, ENCIOC_GETELMSTAT,
+			    (caddr_t) &e_status) < 0) {
+				close(fd);
+				err(EXIT_FAILURE, "ENCIOC_GETELMSTAT");
+			}
+			/* Get the description of the element */
+			memset(&e_desc, 0, sizeof(e_desc));
+			e_desc.elm_idx = e_ptr[j].elm_idx;
+			e_desc.elm_desc_len = UINT16_MAX;
+			e_desc.elm_desc_str = calloc(UINT16_MAX, sizeof(char));
+			if (e_desc.elm_desc_str == NULL) {
+				close(fd);
+				err(EXIT_FAILURE, "calloc()");
+			}
+			if (ioctl(fd, ENCIOC_GETELMDESC,
+			    (caddr_t) &e_desc) < 0) {
+				close(fd);
+				err(EXIT_FAILURE, "ENCIOC_GETELMDESC");
+			}
+			/* Get the device name(s) of the element */
+			memset(&e_devname, 0, sizeof(e_devname));
+			e_devname.elm_idx = e_ptr[j].elm_idx;
+			e_devname.elm_names_size = 128;
+			e_devname.elm_devnames = calloc(128, sizeof(char));
+			if (e_devname.elm_devnames == NULL) {
+				close(fd);
+				err(EXIT_FAILURE, "calloc()");
+			}
+			if (ioctl(fd, ENCIOC_GETELMDEVNAMES,
+			    (caddr_t) &e_devname) <0) {
+				/* We don't care if this fails */
+				e_devname.elm_devnames[0] = '\0';
+			}
+			printf("\tElement %u, Type: %s\n", e_ptr[j].elm_idx,
+			    geteltnm(e_ptr[j].elm_type));
+			printf("\t\tStatus: %s (0x%02x 0x%02x 0x%02x 0x%02x)\n",
+			    scode2ascii(e_status.cstat[0]), e_status.cstat[0],
+			    e_status.cstat[1], e_status.cstat[2],
+			    e_status.cstat[3]);
+			if (e_desc.elm_desc_len > 0) {
+				printf("\t\tDescription: %s\n",
+				    e_desc.elm_desc_str);
+			}
+			if (e_devname.elm_names_len > 0) {
+				printf("\t\tDevice Names: %s\n",
+				    e_devname.elm_devnames);
+			}
+			extra = stat2sbuf(e_ptr[j].elm_type, e_status.cstat);
+			if (sbuf_len(extra) > 0) {
+				printf("\t\tExtra status:\n%s",
+				   sbuf_data(extra));
+			}
+			sbuf_delete(extra);
+			free(e_devname.elm_devnames);
+		}
+		close(fd);
+	}
+	globfree(&g);
+
+	return (EXIT_SUCCESS);
+}
+
+static int
+encstatus(int argc, char **argv __unused)
+{
+	glob_t g;
+	int fd, status;
+	size_t i, e;
+	u_char estat;
+
+	status = 0;
+	if (argc != 1) {
+		usage(stderr, "status");
+	}
+
+	/* Get the list of ses devices */
+	if (glob(uflag, 0, NULL, &g) == GLOB_NOMATCH) {
+		globfree(&g);
+		errx(EXIT_FAILURE, "No SES devices found");
+	}
+	for (i = 0; i < g.gl_pathc; i++) {
+		/* ensure we only got numbers after ses */
+		if (strspn(g.gl_pathv[i] + 8, "0123456789") !=
+		    strlen(g.gl_pathv[i] + 8)) {
+			continue;
+		}
+		if ((fd = open(g.gl_pathv[i], O_RDWR)) < 0) {
+			/*
+			 * Don't treat non-access errors as critical if we are
+			 * accessing all devices
+			 */
+			if (errno == EACCES && g.gl_pathc > 1) {
+				err(EXIT_FAILURE, "unable to access SES device");
+			}
+			warn("unable to access SES device: %s", g.gl_pathv[i]);
+			continue;
+		}
+
+		if (ioctl(fd, ENCIOC_GETENCSTAT, (caddr_t) &estat) < 0) {
+			close(fd);
+			err(EXIT_FAILURE, "ENCIOC_GETENCSTAT");
+		}
+
+		printf("%s: ", g.gl_pathv[i] + 5);
+		e = 0;
+		if (estat == 0) {
+			if (status == 0) {
+				status = 1;
+			}
+			printf("OK");
+		} else {
+			if (estat & SES_ENCSTAT_INFO) {
+				printf("INFO");
+				e++;
+			}
+			if (estat & SES_ENCSTAT_NONCRITICAL) {
+				if (e)
+					printf(",");
+				printf("NONCRITICAL");
+				e++;
+			}
+			if (estat & SES_ENCSTAT_CRITICAL) {
+				if (e)
+					printf(",");
+				printf("CRITICAL");
+				e++;
+				status = -1;
+			}
+			if (estat & SES_ENCSTAT_UNRECOV) {
+				if (e)
+					printf(",");
+				printf("UNRECOV");
+				e++;
+				status = -1;
+			}
+		}
+		printf("\n");
+
+		close(fd);
+	}
+	globfree(&g);
+
+	if (status == 1) {
+		return (EXIT_SUCCESS);
+	} else {
+		return (EXIT_FAILURE);
+	}
 }
 
 int
 main(int argc, char **argv)
 {
-	int i;
+	int i, ch;
 	struct command *cmd = NULL;
 
-	if (argc < 2) {
+	uflag = "/dev/ses[0-9]*";
+	while ((ch = getopt_long(argc, argv, "u:", NULL, NULL)) != -1) {
+		switch (ch) {
+		case 'u':
+			uflag = optarg;
+			break;
+		case '?':
+		default:
+			usage(stderr, NULL);
+		}
+	}
+	argc -= optind;
+	argv += optind;
+
+	if (argc < 1) {
 		warnx("Missing command");
-		usage(stderr);
-		return (EXIT_FAILURE);
+		usage(stderr, NULL);
 	}
 
 	for (i = 0; i < nbcmds; i++) {
-		if (strcmp(argv[1], cmds[i].name) == 0) {
+		if (strcmp(argv[0], cmds[i].name) == 0) {
 			cmd = &cmds[i];
 			break;
 		}
 	}
 
 	if (cmd == NULL) {
-		warnx("unknown command %s", argv[1]);
-		usage(stderr);
-		return (EXIT_FAILURE);
+		warnx("unknown command %s", argv[0]);
+		usage(stderr, NULL);
 	}
 
-	argc-=2;
-	argv+=2;
-
 	return (cmd->exec(argc, argv));
 }