d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a new sesutil(8) utility

Browse Source 
This is an utility for managing SCSI Enclosure Services (SES) device.

For now only one command is supported "locate" which will change the test of the
external LED associated to a given disk.

Usage if the following:
sesutil locate disk [on|off]

Disk can be a device name: "da12" or a special keyword: "all".

Reviewed by:	mav
MFC after:	1 month
Relnotes:	yes
Sponsored by:	gandi.net
Differential Revision:	https://reviews.freebsd.org/D3544
This commit is contained in:
Baptiste Daroussin 2015-09-05 00:06:01 +00:00
parent 74f40e9c30
commit cddcb2599f
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=287473
4 changed files with 305 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
usr.sbin/Makefile
View File

@ -74,6 +74,7 @@ SUBDIR= adduser \
rtprio \
service \
services_mkdb \
sesutil \
setfib \
setfmac \
setpmac \

6
usr.sbin/sesutil/Makefile Normal file
View File

@ -0,0 +1,6 @@
# $FreeBSD$
PROG= sesutil
MAN= sesutil.8
.include <bsd.prog.mk>

73
usr.sbin/sesutil/sesutil.8 Normal file
View File

@ -0,0 +1,73 @@
.\" Copyright (c) 2015 Baptiste Daroussin <bapt@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd September 1, 2015
.Dt SESUTIL 8
.Os
.Sh NAME
.Nm sesutil
.Nd Utility for managing SCSI Enclosure Services (SES) device
.Sh SYNOPSIS
.Nm
.Cm locate Ar disk Bq on|off
.Sh DESCRIPTION
The
.Nm
utility can be used to modify various parameter on SCSI Enclosure Services
(SES) device.
.Pp
List of supported commands:
.Bl -tag -width indent
.It Cm locate Ar disk Bq on|off
Change the state of the external LED associated with
.Ar disk .
.Ar disk
can be the device name of the disk, like
.Cm da12 ,
or
.Cm all .
to indicate all disks attached to SES controllers.
.El
.Sh EXAMPLES
Turn off all external LEDs:
.Pp
.Dl Nm Cm locate all off
.Pp
Turn on the external LED of drive
.Pa da15 :
.Pp
.Dl Nm Cm locate da15 on
.Sh SEE ALSO
.Xr ses 4
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 11.0 .
.Sh AUTHORS
The
.Nm utility was written by
.An Baptiste Daroussin Aq Mt bapt@FreeBSD.org .

225
usr.sbin/sesutil/sesutil.c Normal file
View File

@ -0,0 +1,225 @@
/*-
* Copyright (c) 2015 Baptiste Daroussin <bapt@FreeBSD.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer
* in this position and unchanged.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/param.h>
#include <sys/ioctl.h>
#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <glob.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <cam/scsi/scsi_all.h>
#include <cam/scsi/scsi_enc.h>
static int locate(int argc, char **argv);
static struct command {
const char *name;
const char *desc;
int (*exec)(int argc, char **argv);
} cmds[] = {
{ "locate", "Change the state of the external LED associated with a"
" disk", locate} ,
};
static const int nbcmds = nitems(cmds);
static void
do_locate(int fd, unsigned int idx, bool onoff)
{
encioc_elm_status_t o;
o.elm_idx = idx;
if (ioctl(fd, ENCIOC_GETELMSTAT, (caddr_t) &o) < 0) {
close(fd);
err(EXIT_FAILURE, "ENCIOC_GETELMSTAT");
}
o.cstat[0] |= 0x80;
if (onoff)
o.cstat[2] |= 0x02;
else
o.cstat[2] &= 0xfd;
if (ioctl(fd, ENCIOC_SETELMSTAT, (caddr_t) &o) < 0) {
close(fd);
err(EXIT_FAILURE, "ENCIOC_SETELMSTAT");
}
}
static bool
disk_match(const char *devnames, const char *disk, size_t len)
{
const char *devname;
devname = devnames;
while ((devname = strstr(devname, disk)) != NULL) {
if (devname[len] == '\0' || devname[len] == ',')
return (true);
devname++;
}
return (false);
}
static int
locate(int argc, char **argv)
{
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 locate;
if (argc != 2) {
errx(EXIT_FAILURE, "usage: %s locate [disk] [on|off]",
getprogname());
}
disk = argv[0];
if (strcmp(argv[1], "on") == 0) {
locate = true;
} else if (strcmp(argv[1], "off") == 0) {
locate = false;
} else {
errx(EXIT_FAILURE, "usage: %s locate [disk] [on|off]",
getprogname());
}
if (strcmp(disk, "all") == 0) {
all = true;
}
len = strlen(disk);
/* Get the list of ses devices */
if (glob("/dev/ses[0-9]*", 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) {
if (errno == EACCES)
err(EXIT_FAILURE, "enable to access SES device");
break;
}
if (ioctl(fd, ENCIOC_GETNELM, (caddr_t) &nobj) < 0)
err(EXIT_FAILURE, "ENCIOC_GETNELM");
objp = calloc(nobj, sizeof(encioc_element_t));
if (objp == NULL)
err(EXIT_FAILURE, "calloc()");
if (ioctl(fd, ENCIOC_GETELMMAP, (caddr_t) objp) < 0)
err(EXIT_FAILURE, "ENCIOC_GETELMMAP");
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)
err(EXIT_FAILURE, "calloc()");
if (ioctl(fd, ENCIOC_GETELMDEVNAMES,
(caddr_t) &objdn) <0)
continue;
if (objdn.elm_names_len > 0) {
if (all) {
do_locate(fd, objdn.elm_idx, locate);
continue;
}
if (disk_match(objdn.elm_devnames, disk, len)) {
do_locate(fd, objdn.elm_idx, locate);
break;
}
}
}
close(fd);
i++;
}
globfree(&g);
return (EXIT_SUCCESS);
}
static void
usage(FILE *out)
{
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);
}
int
main(int argc, char **argv)
{
int i;
struct command *cmd = NULL;
if (argc < 2) {
warnx("Missing command");
usage(stderr);
return (EXIT_FAILURE);
}
for (i = 0; i < nbcmds; i++) {
if (strcmp(argv[1], cmds[i].name) == 0) {
cmd = &cmds[i];
break;
}
}
if (cmd == NULL) {
warnx("unknown command %s", argv[1]);
usage(stderr);
return (EXIT_FAILURE);
}
argc-=2;
argv+=2;
return (cmd->exec(argc, argv));
}