diff options
Diffstat (limited to 'sbin/geom/class')
| -rw-r--r-- | sbin/geom/class/Makefile | 1 | ||||
| -rw-r--r-- | sbin/geom/class/label/Makefile | 7 | ||||
| -rw-r--r-- | sbin/geom/class/label/geom_label.c | 187 | ||||
| -rw-r--r-- | sbin/geom/class/label/glabel.8 | 182 |
4 files changed, 377 insertions, 0 deletions
diff --git a/sbin/geom/class/Makefile b/sbin/geom/class/Makefile index 71edcf7..7044661 100644 --- a/sbin/geom/class/Makefile +++ b/sbin/geom/class/Makefile @@ -1,6 +1,7 @@ # $FreeBSD$ SUBDIR= concat +SUBDIR+=label SUBDIR+=nop SUBDIR+=stripe diff --git a/sbin/geom/class/label/Makefile b/sbin/geom/class/label/Makefile new file mode 100644 index 0000000..cba7ac6 --- /dev/null +++ b/sbin/geom/class/label/Makefile @@ -0,0 +1,7 @@ +# $FreeBSD$ + +.PATH: ${.CURDIR}/../../misc + +CLASS= label + +.include <bsd.lib.mk> diff --git a/sbin/geom/class/label/geom_label.c b/sbin/geom/class/label/geom_label.c new file mode 100644 index 0000000..bbd6e7f --- /dev/null +++ b/sbin/geom/class/label/geom_label.c @@ -0,0 +1,187 @@ +/*- + * Copyright (c) 2004 Pawel Jakub Dawidek <pjd@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 AUTHORS 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 AUTHORS 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. + */ + +#include <sys/cdefs.h> +__FBSDID("$FreeBSD$"); + +#include <sys/param.h> +#include <errno.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <strings.h> +#include <assert.h> +#include <libgeom.h> +#include <geom/label/g_label.h> + +#include "core/geom.h" +#include "misc/subr.h" + + +uint32_t lib_version = G_LIB_VERSION; +uint32_t version = G_LABEL_VERSION; + +static void label_main(struct gctl_req *req, unsigned flags); +static void label_label(struct gctl_req *req); +static void label_clear(struct gctl_req *req); + +struct g_command class_commands[] = { + { "create", G_FLAG_VERBOSE | G_FLAG_LOADKLD, NULL, G_NULL_OPTS }, + { "destroy", G_FLAG_VERBOSE, NULL, + { + { 'f', "force", NULL, G_TYPE_NONE }, + G_OPT_SENTINEL + } + }, + { "label", G_FLAG_VERBOSE | G_FLAG_LOADKLD, label_main, G_NULL_OPTS }, + { "clear", G_FLAG_VERBOSE, label_main, G_NULL_OPTS }, + G_CMD_SENTINEL +}; + +static int verbose = 0; + + +void usage(const char *name); +void +usage(const char *name) +{ + + fprintf(stderr, "usage: %s create [-v] <name> <dev>\n", name); + fprintf(stderr, " %s destroy [-fv] <name> [name2 [...]]\n", name); + fprintf(stderr, " %s label [-v] <name> <dev>\n", name); + fprintf(stderr, " %s clear [-v] <dev1> [dev2 [...]]\n", name); +} + +static void +label_main(struct gctl_req *req, unsigned flags) +{ + const char *name; + + if ((flags & G_FLAG_VERBOSE) != 0) + verbose = 1; + + name = gctl_get_asciiparam(req, "verb"); + if (name == NULL) { + gctl_error(req, "No '%s' argument.", "verb"); + return; + } + if (strcmp(name, "label") == 0) + label_label(req); + else if (strcmp(name, "clear") == 0) + label_clear(req); + else + gctl_error(req, "Unknown command: %s.", name); +} + +static void +label_label(struct gctl_req *req) +{ + struct g_label_metadata md; + const char *name, *label; + u_char sector[512]; + int *nargs, error; + + nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); + if (nargs == NULL) { + gctl_error(req, "No '%s' argument.", "nargs"); + return; + } + if (*nargs != 2) { + gctl_error(req, "Invalid number of arguments."); + return; + } + + /* + * Clear last sector first to spoil all components if device exists. + */ + name = gctl_get_asciiparam(req, "arg1"); + if (name == NULL) { + gctl_error(req, "No 'arg%u' argument.", 1); + return; + } + error = g_metadata_clear(name, NULL); + if (error != 0) { + gctl_error(req, "Can't store metadata on %s: %s.", name, + strerror(error)); + return; + } + + strlcpy(md.md_magic, G_LABEL_MAGIC, sizeof(md.md_magic)); + md.md_version = G_LABEL_VERSION; + label = gctl_get_asciiparam(req, "arg0"); + if (label == NULL) { + gctl_error(req, "No 'arg%u' argument.", 0); + return; + } + strlcpy(md.md_label, label, sizeof(md.md_label)); + + /* + * Ok, store metadata. + */ + label_metadata_encode(&md, sector); + error = g_metadata_store(name, sector, sizeof(sector)); + if (error != 0) { + fprintf(stderr, "Can't store metadata on %s: %s.\n", name, + strerror(error)); + gctl_error(req, "Not done."); + } + if (verbose) + printf("Metadata value stored on %s.\n", name); +} + +static void +label_clear(struct gctl_req *req) +{ + const char *name; + char param[16]; + unsigned i; + int *nargs, error; + + nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); + if (nargs == NULL) { + gctl_error(req, "No '%s' argument.", "nargs"); + return; + } + if (*nargs < 1) { + gctl_error(req, "Too few arguments."); + return; + } + + for (i = 0; i < (unsigned)*nargs; i++) { + snprintf(param, sizeof(param), "arg%u", i); + name = gctl_get_asciiparam(req, param); + + error = g_metadata_clear(name, G_LABEL_MAGIC); + if (error != 0) { + fprintf(stderr, "Can't clear metadata on %s: %s.\n", + name, strerror(error)); + gctl_error(req, "Not fully done."); + continue; + } + if (verbose) + printf("Metadata cleared on %s.\n", name); + } +} diff --git a/sbin/geom/class/label/glabel.8 b/sbin/geom/class/label/glabel.8 new file mode 100644 index 0000000..8f94505 --- /dev/null +++ b/sbin/geom/class/label/glabel.8 @@ -0,0 +1,182 @@ +.\" Copyright (c) 2004 Pawel Jakub Dawidek <pjd@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 AUTHORS 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 AUTHORS 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 Jul 2, 2004 +.Dt GLABEL 8 +.Os +.Sh NAME +.Nm glabel +.Nd "disk labelization control utility" +.Sh SYNOPSIS +.Nm +.Cm create +.Op Fl v +.Ar name +.Ar dev +.Nm +.Cm label +.Op Fl v +.Ar name +.Ar dev +.Nm +.Cm destroy +.Op Fl fv +.Ar name +.Op Ar name Op Ar ... +.Nm +.Cm clear +.Op Fl v +.Ar dev +.Op Ar dev Op Ar ... +.Nm +.Cm list +.Op Ar prov Op Ar ... +.Nm +.Cm load +.Op Fl v +.Nm +.Cm unload +.Op Fl v +.Sh DESCRIPTION +The +.Nm +utility is used for GEOM providers labelization. +A label can be setup on a GEOM provider in two ways: +.Dq manual +or +.Dq automatic . +When using the +.Dq manual +method, no metadata are stored on the devices, so a label has to be configured +by hand every time it is needed. +The +.Dq automatic +method use on-disk metadata to store label and detect it automatically in the +future. +.Pp +This class also provide volume label detection for file systems. +Those labels cannot be set with +.Nm , +but must be set with the appropriate file system utility, e.g. for UFS +the file system label is set with +.Xr tunefs 8 . +Currently supported file systems are: +.Pp +.Bl -bullet -offset indent -compact +.It +UFS1 (directory +.Pa /dev/ufs/ ) . +.It +UFS2 (directory +.Pa /dev/ufs/ ) . +.It +MSDOSFS (FAT12, FAT16, FAT32) (directory +.Pa /dev/msdosfs/ ) . +.It +CD ISO9660 (directory +.Pa /dev/iso9660/ ) . +.El +.Pp +Non file-system labels are created in the directory +.Pa /dev/label/ . +.Pp +The first argument to +.Nm +indicates an action to be performed: +.Bl -tag -width ".Cm destroy" +.It Cm create +Create temporary label +.Ar name +for the given provider. +This is the +.Dq manual +method. +The kernel module +.Pa geom_label.ko +will be loaded if it is not loaded already. +.It Cm label +Setup a label +.Ar name +for the given provider. +This is the +.Dq automatic +method, where metadata are stored in provider's last sector. +The kernel module +.Pa geom_label.ko +will be loaded if it is not loaded already. +.It Cm destroy +Turn off the given labels by its +.Ar name . +.It Cm clear +Clear metadata on the given devices. +.It Cm list +List all currently configured devices, or list the given devices. +.It Cm load +Load +.Pa geom_label.ko +kernel module. +.It Cm unload +Unload +.Pa geom_label.ko +kernel module. +.El +.Pp +Additional options: +.Bl -tag -width indent +.It Fl f +Force the removal of the specified labels. +.It Fl v +Be more verbose. +.El +.Sh EXAMPLES +The following example shows how to setup a label for disk da2, +create a file system on it, and mount it: +.Bd -literal -offset indent +glabel label -v usr /dev/da2 +newfs /dev/label/usr +mount /dev/label/usr /usr +.Ed +.Pp +The next example shows how to setup a label for a UFS file system: +.Bd -literal -offset indent +tunefs -L data /dev/da4s1a +mount /dev/ufs/data /mnt/data +.Ed +.Sh DIAGNOSTICS +Exit status is 0 on success, and 1 if the command fails. +.Sh SEE ALSO +.Xr geom 4 , +.Xr geom 8 , +.Xr mount 8 , +.Xr newfs 8 , +.Xr tunefs 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 5.3 . +.Sh AUTHORS +.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org |
