diff options
Diffstat (limited to 'lib/geom/stripe')
| -rw-r--r-- | lib/geom/stripe/Makefile | 5 | ||||
| -rw-r--r-- | lib/geom/stripe/Makefile.depend | 16 | ||||
| -rw-r--r-- | lib/geom/stripe/geom_stripe.c | 285 | ||||
| -rw-r--r-- | lib/geom/stripe/gstripe.8 | 240 |
4 files changed, 546 insertions, 0 deletions
diff --git a/lib/geom/stripe/Makefile b/lib/geom/stripe/Makefile new file mode 100644 index 000000000000..762df5f3c872 --- /dev/null +++ b/lib/geom/stripe/Makefile @@ -0,0 +1,5 @@ +PACKAGE=geom + +GEOM_CLASS= stripe + +.include <bsd.lib.mk> diff --git a/lib/geom/stripe/Makefile.depend b/lib/geom/stripe/Makefile.depend new file mode 100644 index 000000000000..0dd05cace3c0 --- /dev/null +++ b/lib/geom/stripe/Makefile.depend @@ -0,0 +1,16 @@ +# Autogenerated - do NOT edit! + +DIRDEPS = \ + include \ + include/xlocale \ + lib/${CSU_DIR} \ + lib/libc \ + lib/libcompiler_rt \ + lib/libgeom \ + + +.include <dirdeps.mk> + +.if ${DEP_RELDIR} == ${_DEP_RELDIR} +# local dependencies - needed for -jN in clean tree +.endif diff --git a/lib/geom/stripe/geom_stripe.c b/lib/geom/stripe/geom_stripe.c new file mode 100644 index 000000000000..da3a726db370 --- /dev/null +++ b/lib/geom/stripe/geom_stripe.c @@ -0,0 +1,285 @@ +/*- + * SPDX-License-Identifier: BSD-2-Clause + * + * Copyright (c) 2004-2005 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/param.h> +#include <errno.h> +#include <paths.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> +#include <string.h> +#include <strings.h> +#include <assert.h> +#include <libgeom.h> +#include <geom/stripe/g_stripe.h> + +#include "core/geom.h" +#include "misc/subr.h" + + +uint32_t lib_version = G_LIB_VERSION; +uint32_t version = G_STRIPE_VERSION; + +#define GSTRIPE_STRIPESIZE "65536" + +static void stripe_main(struct gctl_req *req, unsigned flags); +static void stripe_clear(struct gctl_req *req); +static void stripe_dump(struct gctl_req *req); +static void stripe_label(struct gctl_req *req); + +struct g_command class_commands[] = { + { "clear", G_FLAG_VERBOSE, stripe_main, G_NULL_OPTS, + "[-v] prov ..." + }, + { "create", G_FLAG_VERBOSE | G_FLAG_LOADKLD, NULL, + { + { 's', "stripesize", GSTRIPE_STRIPESIZE, G_TYPE_NUMBER }, + G_OPT_SENTINEL + }, + "[-v] [-s stripesize] name prov prov ..." + }, + { "destroy", G_FLAG_VERBOSE, NULL, + { + { 'f', "force", NULL, G_TYPE_BOOL }, + G_OPT_SENTINEL + }, + "[-fv] name ..." + }, + { "dump", 0, stripe_main, G_NULL_OPTS, + "prov ..." + }, + { "label", G_FLAG_VERBOSE | G_FLAG_LOADKLD, stripe_main, + { + { 'h', "hardcode", NULL, G_TYPE_BOOL }, + { 's', "stripesize", GSTRIPE_STRIPESIZE, G_TYPE_NUMBER }, + G_OPT_SENTINEL + }, + "[-hv] [-s stripesize] name prov prov ..." + }, + { "stop", G_FLAG_VERBOSE, NULL, + { + { 'f', "force", NULL, G_TYPE_BOOL }, + G_OPT_SENTINEL + }, + "[-fv] name ..." + }, + G_CMD_SENTINEL +}; + +static int verbose = 0; + +static void +stripe_main(struct gctl_req *req, unsigned flags) +{ + const char *name; + + if ((flags & G_FLAG_VERBOSE) != 0) + verbose = 1; + + name = gctl_get_ascii(req, "verb"); + if (name == NULL) { + gctl_error(req, "No '%s' argument.", "verb"); + return; + } + if (strcmp(name, "label") == 0) + stripe_label(req); + else if (strcmp(name, "clear") == 0) + stripe_clear(req); + else if (strcmp(name, "dump") == 0) + stripe_dump(req); + else + gctl_error(req, "Unknown command: %s.", name); +} + +static void +stripe_label(struct gctl_req *req) +{ + struct g_stripe_metadata md; + intmax_t stripesize; + off_t compsize, msize; + u_char sector[512]; + unsigned ssize, secsize; + const char *name; + int error, i, nargs, hardcode; + + bzero(sector, sizeof(sector)); + nargs = gctl_get_int(req, "nargs"); + if (nargs < 3) { + gctl_error(req, "Too few arguments."); + return; + } + hardcode = gctl_get_int(req, "hardcode"); + + /* + * Clear last sector first to spoil all components if device exists. + */ + compsize = 0; + secsize = 0; + for (i = 1; i < nargs; i++) { + name = gctl_get_ascii(req, "arg%d", i); + msize = g_get_mediasize(name); + ssize = g_get_sectorsize(name); + if (msize == 0 || ssize == 0) { + gctl_error(req, "Can't get informations about %s: %s.", + name, strerror(errno)); + return; + } + msize -= ssize; + if (compsize == 0 || (compsize > 0 && msize < compsize)) + compsize = msize; + if (secsize == 0) + secsize = ssize; + else + secsize = g_lcm(secsize, ssize); + + 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_STRIPE_MAGIC, sizeof(md.md_magic)); + md.md_version = G_STRIPE_VERSION; + name = gctl_get_ascii(req, "arg0"); + strlcpy(md.md_name, name, sizeof(md.md_name)); + md.md_id = arc4random(); + md.md_all = nargs - 1; + stripesize = gctl_get_intmax(req, "stripesize"); + if ((stripesize % secsize) != 0) { + gctl_error(req, "Stripesize should be multiple of %u.", + secsize); + return; + } + md.md_stripesize = stripesize; + + /* + * Ok, store metadata. + */ + for (i = 1; i < nargs; i++) { + name = gctl_get_ascii(req, "arg%d", i); + msize = g_get_mediasize(name); + ssize = g_get_sectorsize(name); + if (compsize < msize - ssize) { + fprintf(stderr, + "warning: %s: only %jd bytes from %jd bytes used.\n", + name, (intmax_t)compsize, (intmax_t)(msize - ssize)); + } + + md.md_no = i - 1; + md.md_provsize = msize; + if (!hardcode) + bzero(md.md_provider, sizeof(md.md_provider)); + else { + if (strncmp(name, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0) + name += sizeof(_PATH_DEV) - 1; + strlcpy(md.md_provider, name, sizeof(md.md_provider)); + } + stripe_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 fully done."); + continue; + } + if (verbose) + printf("Metadata value stored on %s.\n", name); + } +} + +static void +stripe_clear(struct gctl_req *req) +{ + const char *name; + int error, i, nargs; + + nargs = gctl_get_int(req, "nargs"); + if (nargs < 1) { + gctl_error(req, "Too few arguments."); + return; + } + + for (i = 0; i < nargs; i++) { + name = gctl_get_ascii(req, "arg%d", i); + error = g_metadata_clear(name, G_STRIPE_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); + } +} + +static void +stripe_metadata_dump(const struct g_stripe_metadata *md) +{ + + printf(" Magic string: %s\n", md->md_magic); + printf(" Metadata version: %u\n", (u_int)md->md_version); + printf(" Device name: %s\n", md->md_name); + printf(" Device ID: %u\n", (u_int)md->md_id); + printf(" Disk number: %u\n", (u_int)md->md_no); + printf("Total number of disks: %u\n", (u_int)md->md_all); + printf(" Stripe size: %u\n", (u_int)md->md_stripesize); + printf(" Hardcoded provider: %s\n", md->md_provider); +} + +static void +stripe_dump(struct gctl_req *req) +{ + struct g_stripe_metadata md, tmpmd; + const char *name; + int error, i, nargs; + + nargs = gctl_get_int(req, "nargs"); + if (nargs < 1) { + gctl_error(req, "Too few arguments."); + return; + } + + for (i = 0; i < nargs; i++) { + name = gctl_get_ascii(req, "arg%d", i); + error = g_metadata_read(name, (u_char *)&tmpmd, sizeof(tmpmd), + G_STRIPE_MAGIC); + if (error != 0) { + fprintf(stderr, "Can't read metadata from %s: %s.\n", + name, strerror(error)); + gctl_error(req, "Not fully done."); + continue; + } + stripe_metadata_decode((u_char *)&tmpmd, &md); + printf("Metadata on %s:\n", name); + stripe_metadata_dump(&md); + printf("\n"); + } +} diff --git a/lib/geom/stripe/gstripe.8 b/lib/geom/stripe/gstripe.8 new file mode 100644 index 000000000000..6fd486355a2e --- /dev/null +++ b/lib/geom/stripe/gstripe.8 @@ -0,0 +1,240 @@ +.\" Copyright (c) 2004-2005 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. +.\" +.Dd January 23, 2025 +.Dt GSTRIPE 8 +.Os +.Sh NAME +.Nm gstripe +.Nd "control utility for striped devices" +.Sh SYNOPSIS +.Nm +.Cm create +.Op Fl v +.Op Fl s Ar stripesize +.Ar name +.Ar prov prov ... +.Nm +.Cm destroy +.Op Fl fv +.Ar name ... +.Nm +.Cm label +.Op Fl hv +.Op Fl s Ar stripesize +.Ar name +.Ar prov prov ... +.Nm +.Cm stop +.Op Fl fv +.Ar name ... +.Nm +.Cm clear +.Op Fl v +.Ar prov ... +.Nm +.Cm dump +.Ar prov ... +.Nm +.Cm list +.Nm +.Cm status +.Nm +.Cm load +.Nm +.Cm unload +.Sh DESCRIPTION +The +.Nm +utility is used for setting up a stripe on two or more disks. +The striped device can be configured using two different methods: +.Dq manual +or +.Dq automatic . +When using the +.Dq manual +method, no metadata are stored on the devices, so the striped +device has to be configured by hand every time it is needed. +The +.Dq automatic +method uses on-disk metadata to detect devices. +Once devices are labeled, they will be automatically detected and +configured. +.Pp +The first argument to +.Nm +indicates an action to be performed: +.Bl -tag -width ".Cm destroy" +.It Cm create +Set up a striped device from the given devices with specified +.Ar name . +This is the +.Dq manual +method and the stripe will not exist after a reboot (see +.Sx DESCRIPTION +above). +The kernel module +.Pa geom_stripe.ko +will be loaded if it is not loaded already. +.It Cm label +Set up a striped device from the given devices with the specified +.Ar name . +This is the +.Dq automatic +method, where metadata are stored in every device's last sector. +The kernel module +.Pa geom_stripe.ko +will be loaded if it is not loaded already. +.It Cm stop +Turn off an existing striped device by its +.Ar name . +This command does not touch on-disk metadata! +.It Cm destroy +Same as +.Cm stop . +.It Cm clear +Clear metadata on the given devices. +.It Cm dump +Dump metadata stored on the given devices. +.It Cm list +See +.Xr geom 8 . +.It Cm status +See +.Xr geom 8 . +.It Cm load +See +.Xr geom 8 . +.It Cm unload +See +.Xr geom 8 . +.El +.Pp +Additional options: +.Bl -tag -width ".Fl s Ar stripesize" +.It Fl f +Force the removal of the specified striped device. +.It Fl h +Hardcode providers' names in metadata. +.It Fl s Ar stripesize +Specifies size of stripe block in bytes. +The +.Ar stripesize +must be a multiple of the largest sector size of all the providers. +.It Fl v +Be more verbose. +.El +.Sh SYSCTL VARIABLES +The following +.Xr sysctl 8 +variables can be used to control the behavior of the +.Nm STRIPE +GEOM class. +The default value is shown next to each variable. +.Bl -tag -width indent +.It Va kern.geom.stripe.debug : No 0 +Debug level of the +.Nm STRIPE +GEOM class. +This can be set to a number between 0 and 3 inclusive. +If set to 0 minimal debug information is printed, and if set to 3 the +maximum amount of debug information is printed. +.It Va kern.geom.stripe.fast : No 0 +If set to a non-zero value enable +.Dq "fast mode" +instead of the normal +.Dq "economic mode" . +Compared to +.Dq "economic mode" , +.Dq "fast mode" +uses more memory, but it is much faster for smaller stripe sizes. +If enough memory cannot be allocated, +.Nm STRIPE +will fall back to +.Dq "economic mode" . +.It Va kern.geom.stripe.maxmem : No 13107200 +Maximum amount of memory that can be consumed by +.Dq "fast mode" +(in bytes). +This +.Xr sysctl 8 +variable is read-only and can only be set as a tunable in +.Xr loader.conf 5 . +.It Va kern.geom.stripe.fast_failed +A count of how many times +.Dq "fast mode" +has failed due to an insufficient amount of memory. +If this value is large, you should consider increasing the +.Va kern.geom.stripe.maxmem +value. +.El +.Sh EXIT STATUS +Exit status is 0 on success, and 1 if the command fails. +.Sh EXAMPLES +The following example shows how to set up a striped device from four disks with a +128KB stripe size for automatic configuration, +create a file system on it, +and mount it: +.Bd -literal -offset indent +gstripe label -v -s 131072 data /dev/da0 /dev/da1 /dev/da2 /dev/da3 +newfs /dev/stripe/data +mount /dev/stripe/data /mnt +[...] +umount /mnt +gstripe stop data +gstripe unload +.Ed +.Sh COMPATIBILITY +The +.Nm +interleave is in number of bytes, +unlike +.Xr ccdconfig 8 +which use the number of sectors. +A +.Xr ccdconfig 8 +.Ar ileave +of +.Ql 128 +is 64 KB (128 512B sectors). +The same stripe interleave would be specified as +.Ql 65536 +for +.Nm . +.Sh SEE ALSO +.Xr geom 4 , +.Xr loader.conf 5 , +.Xr ccdconfig 8 , +.Xr geom 8 , +.Xr mount 8 , +.Xr newfs 8 , +.Xr sysctl 8 , +.Xr umount 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 5.3 . +.Sh AUTHORS +.An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org |