2 * Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/mutex.h>
39 #include <sys/ctype.h>
40 #include <sys/malloc.h>
41 #include <sys/libkern.h>
43 #include <sys/sysctl.h>
44 #include <geom/geom.h>
45 #include <geom/geom_slice.h>
46 #include <geom/label/g_label.h>
48 FEATURE(geom_label, "GEOM labeling support");
50 SYSCTL_DECL(_kern_geom);
51 SYSCTL_NODE(_kern_geom, OID_AUTO, label, CTLFLAG_RW, 0, "GEOM_LABEL stuff");
52 u_int g_label_debug = 0;
53 SYSCTL_UINT(_kern_geom_label, OID_AUTO, debug, CTLFLAG_RWTUN, &g_label_debug, 0,
56 static int g_label_destroy_geom(struct gctl_req *req, struct g_class *mp,
58 static int g_label_destroy(struct g_geom *gp, boolean_t force);
59 static struct g_geom *g_label_taste(struct g_class *mp, struct g_provider *pp,
61 static void g_label_config(struct gctl_req *req, struct g_class *mp,
64 struct g_class g_label_class = {
65 .name = G_LABEL_CLASS_NAME,
67 .ctlreq = g_label_config,
68 .taste = g_label_taste,
69 .destroy_geom = g_label_destroy_geom
73 * To add a new file system where you want to look for volume labels,
75 * 1. Add a file g_label_<file system>.c which implements labels recognition.
76 * 2. Add an 'extern const struct g_label_desc g_label_<file system>;' into
78 * 3. Add an element to the table below '&g_label_<file system>,'.
79 * 4. Add your file to sys/conf/files.
80 * 5. Add your file to sys/modules/geom/geom_label/Makefile.
81 * 6. Add your file system to manual page sbin/geom/class/label/glabel.8.
83 const struct g_label_desc *g_labels[] = {
101 g_label_destroy_geom(struct gctl_req *req __unused, struct g_class *mp,
102 struct g_geom *gp __unused)
106 * XXX: Unloading a class which is using geom_slice:1.56 is currently
107 * XXX: broken, so we deny unloading when we have geoms.
113 g_label_orphan(struct g_consumer *cp)
116 G_LABEL_DEBUG(1, "Label %s removed.",
117 LIST_FIRST(&cp->geom->provider)->name);
122 g_label_spoiled(struct g_consumer *cp)
125 G_LABEL_DEBUG(1, "Label %s removed.",
126 LIST_FIRST(&cp->geom->provider)->name);
131 g_label_resize(struct g_consumer *cp)
134 G_LABEL_DEBUG(1, "Label %s resized.",
135 LIST_FIRST(&cp->geom->provider)->name);
137 g_slice_config(cp->geom, 0, G_SLICE_CONFIG_FORCE, (off_t)0,
138 cp->provider->mediasize, cp->provider->sectorsize, "notused");
142 g_label_is_name_ok(const char *label)
146 /* Check if the label starts from ../ */
147 if (strncmp(label, "../", 3) == 0)
149 /* Check if the label contains /../ */
150 if (strstr(label, "/../") != NULL)
152 /* Check if the label ends at ../ */
153 if ((s = strstr(label, "/..")) != NULL && s[3] == '\0')
159 g_label_mangle_name(char *label, size_t size)
164 sb = sbuf_new(NULL, NULL, size, SBUF_FIXEDLEN);
165 for (c = label; *c != '\0'; c++) {
166 if (!isprint(*c) || isspace(*c) || *c =='"' || *c == '%')
167 sbuf_printf(sb, "%%%02X", *c);
171 if (sbuf_finish(sb) != 0)
174 strlcpy(label, sbuf_data(sb), size);
178 static struct g_geom *
179 g_label_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp,
180 const char *label, const char *dir, off_t mediasize)
183 struct g_provider *pp2;
184 struct g_consumer *cp;
189 if (!g_label_is_name_ok(label)) {
190 G_LABEL_DEBUG(0, "%s contains suspicious label, skipping.",
192 G_LABEL_DEBUG(1, "%s suspicious label is: %s", pp->name, label);
194 gctl_error(req, "Label name %s is invalid.", label);
199 snprintf(name, sizeof(name), "%s/%s", dir, label);
200 LIST_FOREACH(gp, &mp->geom, geom) {
201 pp2 = LIST_FIRST(&gp->provider);
204 if ((pp2->flags & G_PF_ORPHAN) != 0)
206 if (strcmp(pp2->name, name) == 0) {
207 G_LABEL_DEBUG(1, "Label %s(%s) already exists (%s).",
208 label, name, pp->name);
210 gctl_error(req, "Provider %s already exists.",
216 gp = g_slice_new(mp, 1, pp, &cp, NULL, 0, NULL);
218 G_LABEL_DEBUG(0, "Cannot create slice %s.", label);
220 gctl_error(req, "Cannot create slice %s.", label);
223 gp->orphan = g_label_orphan;
224 gp->spoiled = g_label_spoiled;
225 gp->resize = g_label_resize;
226 g_access(cp, -1, 0, 0);
227 g_slice_config(gp, 0, G_SLICE_CONFIG_SET, (off_t)0, mediasize,
228 pp->sectorsize, "%s", name);
229 G_LABEL_DEBUG(1, "Label for provider %s is %s.", pp->name, name);
234 g_label_destroy(struct g_geom *gp, boolean_t force)
236 struct g_provider *pp;
239 pp = LIST_FIRST(&gp->provider);
240 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
242 G_LABEL_DEBUG(0, "Provider %s is still open, so it "
243 "can't be definitely removed.", pp->name);
246 "Provider %s is still open (r%dw%de%d).", pp->name,
247 pp->acr, pp->acw, pp->ace);
250 } else if (pp != NULL)
251 G_LABEL_DEBUG(1, "Label %s removed.", pp->name);
252 g_slice_spoiled(LIST_FIRST(&gp->consumer));
257 g_label_read_metadata(struct g_consumer *cp, struct g_label_metadata *md)
259 struct g_provider *pp;
267 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
272 /* Decode metadata. */
273 label_metadata_decode(buf, md);
280 g_label_orphan_taste(struct g_consumer *cp __unused)
283 KASSERT(1 == 0, ("%s called?", __func__));
287 g_label_start_taste(struct bio *bp __unused)
290 KASSERT(1 == 0, ("%s called?", __func__));
294 g_label_access_taste(struct g_provider *pp __unused, int dr __unused,
295 int dw __unused, int de __unused)
298 KASSERT(1 == 0, ("%s called", __func__));
302 static struct g_geom *
303 g_label_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
305 struct g_label_metadata md;
306 struct g_consumer *cp;
310 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
313 G_LABEL_DEBUG(2, "Tasting %s.", pp->name);
315 /* Skip providers that are already open for writing. */
319 if (strcmp(pp->geom->class->name, mp->name) == 0)
322 gp = g_new_geomf(mp, "label:taste");
323 gp->start = g_label_start_taste;
324 gp->access = g_label_access_taste;
325 gp->orphan = g_label_orphan_taste;
326 cp = g_new_consumer(gp);
328 if (g_access(cp, 1, 0, 0) != 0)
331 if (g_label_read_metadata(cp, &md) != 0)
333 if (strcmp(md.md_magic, G_LABEL_MAGIC) != 0)
335 if (md.md_version > G_LABEL_VERSION) {
336 printf("geom_label.ko module is too old to handle %s.\n",
342 * Backward compatibility:
345 * There was no md_provsize field in earlier versions of
348 if (md.md_version < 2)
349 md.md_provsize = pp->mediasize;
351 if (md.md_provsize != pp->mediasize)
354 g_label_create(NULL, mp, pp, md.md_label, G_LABEL_DIR,
355 pp->mediasize - pp->sectorsize);
357 for (i = 0; g_labels[i] != NULL; i++) {
360 if (g_labels[i]->ld_enabled == 0)
363 g_labels[i]->ld_taste(cp, label, sizeof(label));
364 g_label_mangle_name(label, sizeof(label));
366 if (label[0] == '\0')
368 g_label_create(NULL, mp, pp, label, g_labels[i]->ld_dir,
371 g_access(cp, -1, 0, 0);
374 g_destroy_consumer(cp);
380 g_label_ctl_create(struct gctl_req *req, struct g_class *mp)
382 struct g_provider *pp;
388 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
390 gctl_error(req, "No '%s' argument", "nargs");
394 gctl_error(req, "Invalid number of arguments.");
398 * arg1 is the name of provider.
400 name = gctl_get_asciiparam(req, "arg1");
402 gctl_error(req, "No 'arg%d' argument", 1);
405 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
406 name += strlen("/dev/");
407 pp = g_provider_by_name(name);
409 G_LABEL_DEBUG(1, "Provider %s is invalid.", name);
410 gctl_error(req, "Provider %s is invalid.", name);
416 name = gctl_get_asciiparam(req, "arg0");
418 gctl_error(req, "No 'arg%d' argument", 0);
421 g_label_create(req, mp, pp, name, G_LABEL_DIR, pp->mediasize);
425 g_label_skip_dir(const char *name)
430 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
431 name += strlen("/dev/");
432 if (strncmp(name, G_LABEL_DIR "/", strlen(G_LABEL_DIR "/")) == 0)
433 name += strlen(G_LABEL_DIR "/");
434 for (i = 0; g_labels[i] != NULL; i++) {
435 snprintf(path, sizeof(path), "%s/", g_labels[i]->ld_dir);
436 if (strncmp(name, path, strlen(path)) == 0) {
437 name += strlen(path);
444 static struct g_geom *
445 g_label_find_geom(struct g_class *mp, const char *name)
448 struct g_provider *pp;
451 name = g_label_skip_dir(name);
452 LIST_FOREACH(gp, &mp->geom, geom) {
453 pp = LIST_FIRST(&gp->provider);
454 pname = g_label_skip_dir(pp->name);
455 if (strcmp(pname, name) == 0)
462 g_label_ctl_destroy(struct gctl_req *req, struct g_class *mp)
464 int *nargs, *force, error, i;
471 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
473 gctl_error(req, "No '%s' argument", "nargs");
477 gctl_error(req, "Missing device(s).");
480 force = gctl_get_paraml(req, "force", sizeof(*force));
482 gctl_error(req, "No 'force' argument");
486 for (i = 0; i < *nargs; i++) {
487 snprintf(param, sizeof(param), "arg%d", i);
488 name = gctl_get_asciiparam(req, param);
490 gctl_error(req, "No 'arg%d' argument", i);
493 gp = g_label_find_geom(mp, name);
495 G_LABEL_DEBUG(1, "Label %s is invalid.", name);
496 gctl_error(req, "Label %s is invalid.", name);
499 error = g_label_destroy(gp, *force);
501 gctl_error(req, "Cannot destroy label %s (error=%d).",
502 LIST_FIRST(&gp->provider)->name, error);
509 g_label_config(struct gctl_req *req, struct g_class *mp, const char *verb)
515 version = gctl_get_paraml(req, "version", sizeof(*version));
516 if (version == NULL) {
517 gctl_error(req, "No '%s' argument.", "version");
520 if (*version != G_LABEL_VERSION) {
521 gctl_error(req, "Userland and kernel parts are out of sync.");
525 if (strcmp(verb, "create") == 0) {
526 g_label_ctl_create(req, mp);
528 } else if (strcmp(verb, "destroy") == 0 ||
529 strcmp(verb, "stop") == 0) {
530 g_label_ctl_destroy(req, mp);
534 gctl_error(req, "Unknown verb.");
537 DECLARE_GEOM_CLASS(g_label_class, g_label);