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$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
35 #include <sys/mutex.h>
37 #include <sys/ctype.h>
38 #include <sys/malloc.h>
39 #include <sys/libkern.h>
41 #include <sys/sysctl.h>
42 #include <geom/geom.h>
43 #include <geom/geom_slice.h>
44 #include <geom/label/g_label.h>
46 FEATURE(geom_label, "GEOM labeling support");
48 SYSCTL_DECL(_kern_geom);
49 SYSCTL_NODE(_kern_geom, OID_AUTO, label, CTLFLAG_RW, 0, "GEOM_LABEL stuff");
50 u_int g_label_debug = 0;
51 TUNABLE_INT("kern.geom.label.debug", &g_label_debug);
52 SYSCTL_UINT(_kern_geom_label, OID_AUTO, debug, CTLFLAG_RW, &g_label_debug, 0,
55 static int g_label_destroy_geom(struct gctl_req *req, struct g_class *mp,
57 static int g_label_destroy(struct g_geom *gp, boolean_t force);
58 static struct g_geom *g_label_taste(struct g_class *mp, struct g_provider *pp,
60 static void g_label_config(struct gctl_req *req, struct g_class *mp,
63 struct g_class g_label_class = {
64 .name = G_LABEL_CLASS_NAME,
66 .ctlreq = g_label_config,
67 .taste = g_label_taste,
68 .destroy_geom = g_label_destroy_geom
72 * To add a new file system where you want to look for volume labels,
74 * 1. Add a file g_label_<file system>.c which implements labels recognition.
75 * 2. Add an 'extern const struct g_label_desc g_label_<file system>;' into
77 * 3. Add an element to the table below '&g_label_<file system>,'.
78 * 4. Add your file to sys/conf/files.
79 * 5. Add your file to sys/modules/geom/geom_label/Makefile.
80 * 6. Add your file system to manual page sbin/geom/class/label/glabel.8.
82 const struct g_label_desc *g_labels[] = {
97 g_label_destroy_geom(struct gctl_req *req __unused, struct g_class *mp,
98 struct g_geom *gp __unused)
102 * XXX: Unloading a class which is using geom_slice:1.56 is currently
103 * XXX: broken, so we deny unloading when we have geoms.
109 g_label_orphan(struct g_consumer *cp)
112 G_LABEL_DEBUG(1, "Label %s removed.",
113 LIST_FIRST(&cp->geom->provider)->name);
118 g_label_spoiled(struct g_consumer *cp)
121 G_LABEL_DEBUG(1, "Label %s removed.",
122 LIST_FIRST(&cp->geom->provider)->name);
127 g_label_is_name_ok(const char *label)
131 /* Check if the label starts from ../ */
132 if (strncmp(label, "../", 3) == 0)
134 /* Check if the label contains /../ */
135 if (strstr(label, "/../") != NULL)
137 /* Check if the label ends at ../ */
138 if ((s = strstr(label, "/..")) != NULL && s[3] == '\0')
144 g_label_mangle_name(char *label, size_t size)
149 sb = sbuf_new(NULL, NULL, size, SBUF_FIXEDLEN);
150 for (c = label; *c != '\0'; c++) {
151 if (!isprint(*c) || isspace(*c) || *c =='"' || *c == '%')
152 sbuf_printf(sb, "%%%02X", *c);
156 if (sbuf_finish(sb) != 0)
159 strlcpy(label, sbuf_data(sb), size);
163 static struct g_geom *
164 g_label_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp,
165 const char *label, const char *dir, off_t mediasize)
168 struct g_provider *pp2;
169 struct g_consumer *cp;
174 if (!g_label_is_name_ok(label)) {
175 G_LABEL_DEBUG(0, "%s contains suspicious label, skipping.",
177 G_LABEL_DEBUG(1, "%s suspicious label is: %s", pp->name, label);
179 gctl_error(req, "Label name %s is invalid.", label);
184 snprintf(name, sizeof(name), "%s/%s", dir, label);
185 LIST_FOREACH(gp, &mp->geom, geom) {
186 pp2 = LIST_FIRST(&gp->provider);
189 if ((pp2->flags & G_PF_ORPHAN) != 0)
191 if (strcmp(pp2->name, name) == 0) {
192 G_LABEL_DEBUG(1, "Label %s(%s) already exists (%s).",
193 label, name, pp->name);
195 gctl_error(req, "Provider %s already exists.",
201 gp = g_slice_new(mp, 1, pp, &cp, NULL, 0, NULL);
203 G_LABEL_DEBUG(0, "Cannot create slice %s.", label);
205 gctl_error(req, "Cannot create slice %s.", label);
208 gp->orphan = g_label_orphan;
209 gp->spoiled = g_label_spoiled;
210 g_access(cp, -1, 0, 0);
211 g_slice_config(gp, 0, G_SLICE_CONFIG_SET, (off_t)0, mediasize,
212 pp->sectorsize, "%s", name);
213 G_LABEL_DEBUG(1, "Label for provider %s is %s.", pp->name, name);
218 g_label_destroy(struct g_geom *gp, boolean_t force)
220 struct g_provider *pp;
223 pp = LIST_FIRST(&gp->provider);
224 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
226 G_LABEL_DEBUG(0, "Provider %s is still open, so it "
227 "can't be definitely removed.", pp->name);
230 "Provider %s is still open (r%dw%de%d).", pp->name,
231 pp->acr, pp->acw, pp->ace);
234 } else if (pp != NULL)
235 G_LABEL_DEBUG(1, "Label %s removed.", pp->name);
236 g_slice_spoiled(LIST_FIRST(&gp->consumer));
241 g_label_read_metadata(struct g_consumer *cp, struct g_label_metadata *md)
243 struct g_provider *pp;
251 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
256 /* Decode metadata. */
257 label_metadata_decode(buf, md);
264 g_label_orphan_taste(struct g_consumer *cp __unused)
267 KASSERT(1 == 0, ("%s called?", __func__));
271 g_label_start_taste(struct bio *bp __unused)
274 KASSERT(1 == 0, ("%s called?", __func__));
278 g_label_access_taste(struct g_provider *pp __unused, int dr __unused,
279 int dw __unused, int de __unused)
282 KASSERT(1 == 0, ("%s called", __func__));
286 static struct g_geom *
287 g_label_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
289 struct g_label_metadata md;
290 struct g_consumer *cp;
294 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
297 G_LABEL_DEBUG(2, "Tasting %s.", pp->name);
299 /* Skip providers that are already open for writing. */
303 if (strcmp(pp->geom->class->name, mp->name) == 0)
306 gp = g_new_geomf(mp, "label:taste");
307 gp->start = g_label_start_taste;
308 gp->access = g_label_access_taste;
309 gp->orphan = g_label_orphan_taste;
310 cp = g_new_consumer(gp);
312 if (g_access(cp, 1, 0, 0) != 0)
315 if (g_label_read_metadata(cp, &md) != 0)
317 if (strcmp(md.md_magic, G_LABEL_MAGIC) != 0)
319 if (md.md_version > G_LABEL_VERSION) {
320 printf("geom_label.ko module is too old to handle %s.\n",
326 * Backward compatibility:
329 * There was no md_provsize field in earlier versions of
332 if (md.md_version < 2)
333 md.md_provsize = pp->mediasize;
335 if (md.md_provsize != pp->mediasize)
338 g_label_create(NULL, mp, pp, md.md_label, G_LABEL_DIR,
339 pp->mediasize - pp->sectorsize);
341 for (i = 0; g_labels[i] != NULL; i++) {
344 if (g_labels[i]->ld_enabled == 0)
347 g_labels[i]->ld_taste(cp, label, sizeof(label));
348 g_label_mangle_name(label, sizeof(label));
350 if (label[0] == '\0')
352 g_label_create(NULL, mp, pp, label, g_labels[i]->ld_dir,
355 g_access(cp, -1, 0, 0);
358 g_destroy_consumer(cp);
364 g_label_ctl_create(struct gctl_req *req, struct g_class *mp)
366 struct g_provider *pp;
372 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
374 gctl_error(req, "No '%s' argument", "nargs");
378 gctl_error(req, "Invalid number of arguments.");
382 * arg1 is the name of provider.
384 name = gctl_get_asciiparam(req, "arg1");
386 gctl_error(req, "No 'arg%d' argument", 1);
389 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
390 name += strlen("/dev/");
391 pp = g_provider_by_name(name);
393 G_LABEL_DEBUG(1, "Provider %s is invalid.", name);
394 gctl_error(req, "Provider %s is invalid.", name);
400 name = gctl_get_asciiparam(req, "arg0");
402 gctl_error(req, "No 'arg%d' argument", 0);
405 g_label_create(req, mp, pp, name, G_LABEL_DIR, pp->mediasize);
409 g_label_skip_dir(const char *name)
414 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
415 name += strlen("/dev/");
416 if (strncmp(name, G_LABEL_DIR "/", strlen(G_LABEL_DIR "/")) == 0)
417 name += strlen(G_LABEL_DIR "/");
418 for (i = 0; g_labels[i] != NULL; i++) {
419 snprintf(path, sizeof(path), "%s/", g_labels[i]->ld_dir);
420 if (strncmp(name, path, strlen(path)) == 0) {
421 name += strlen(path);
428 static struct g_geom *
429 g_label_find_geom(struct g_class *mp, const char *name)
432 struct g_provider *pp;
435 name = g_label_skip_dir(name);
436 LIST_FOREACH(gp, &mp->geom, geom) {
437 pp = LIST_FIRST(&gp->provider);
438 pname = g_label_skip_dir(pp->name);
439 if (strcmp(pname, name) == 0)
446 g_label_ctl_destroy(struct gctl_req *req, struct g_class *mp)
448 int *nargs, *force, error, i;
455 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
457 gctl_error(req, "No '%s' argument", "nargs");
461 gctl_error(req, "Missing device(s).");
464 force = gctl_get_paraml(req, "force", sizeof(*force));
466 gctl_error(req, "No 'force' argument");
470 for (i = 0; i < *nargs; i++) {
471 snprintf(param, sizeof(param), "arg%d", i);
472 name = gctl_get_asciiparam(req, param);
474 gctl_error(req, "No 'arg%d' argument", i);
477 gp = g_label_find_geom(mp, name);
479 G_LABEL_DEBUG(1, "Label %s is invalid.", name);
480 gctl_error(req, "Label %s is invalid.", name);
483 error = g_label_destroy(gp, *force);
485 gctl_error(req, "Cannot destroy label %s (error=%d).",
486 LIST_FIRST(&gp->provider)->name, error);
493 g_label_config(struct gctl_req *req, struct g_class *mp, const char *verb)
499 version = gctl_get_paraml(req, "version", sizeof(*version));
500 if (version == NULL) {
501 gctl_error(req, "No '%s' argument.", "version");
504 if (*version != G_LABEL_VERSION) {
505 gctl_error(req, "Userland and kernel parts are out of sync.");
509 if (strcmp(verb, "create") == 0) {
510 g_label_ctl_create(req, mp);
512 } else if (strcmp(verb, "destroy") == 0 ||
513 strcmp(verb, "stop") == 0) {
514 g_label_ctl_destroy(req, mp);
518 gctl_error(req, "Unknown verb.");
521 DECLARE_GEOM_CLASS(g_label_class, g_label);