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/malloc.h>
38 #include <sys/libkern.h>
39 #include <sys/sysctl.h>
40 #include <geom/geom.h>
41 #include <geom/geom_slice.h>
42 #include <geom/label/g_label.h>
44 FEATURE(geom_label, "GEOM labeling support");
46 SYSCTL_DECL(_kern_geom);
47 SYSCTL_NODE(_kern_geom, OID_AUTO, label, CTLFLAG_RW, 0, "GEOM_LABEL stuff");
48 u_int g_label_debug = 0;
49 TUNABLE_INT("kern.geom.label.debug", &g_label_debug);
50 SYSCTL_UINT(_kern_geom_label, OID_AUTO, debug, CTLFLAG_RW, &g_label_debug, 0,
53 static int g_label_destroy_geom(struct gctl_req *req, struct g_class *mp,
55 static int g_label_destroy(struct g_geom *gp, boolean_t force);
56 static struct g_geom *g_label_taste(struct g_class *mp, struct g_provider *pp,
58 static void g_label_config(struct gctl_req *req, struct g_class *mp,
61 struct g_class g_label_class = {
62 .name = G_LABEL_CLASS_NAME,
64 .ctlreq = g_label_config,
65 .taste = g_label_taste,
66 .destroy_geom = g_label_destroy_geom
70 * To add a new file system where you want to look for volume labels,
72 * 1. Add a file g_label_<file system>.c which implements labels recognition.
73 * 2. Add an 'extern const struct g_label_desc g_label_<file system>;' into
75 * 3. Add an element to the table below '&g_label_<file system>,'.
76 * 4. Add your file to sys/conf/files.
77 * 5. Add your file to sys/modules/geom/geom_label/Makefile.
78 * 6. Add your file system to manual page sbin/geom/class/label/glabel.8.
80 const struct g_label_desc *g_labels[] = {
95 g_label_destroy_geom(struct gctl_req *req __unused, struct g_class *mp,
96 struct g_geom *gp __unused)
100 * XXX: Unloading a class which is using geom_slice:1.56 is currently
101 * XXX: broken, so we deny unloading when we have geoms.
107 g_label_orphan(struct g_consumer *cp)
110 G_LABEL_DEBUG(1, "Label %s removed.",
111 LIST_FIRST(&cp->geom->provider)->name);
116 g_label_spoiled(struct g_consumer *cp)
119 G_LABEL_DEBUG(1, "Label %s removed.",
120 LIST_FIRST(&cp->geom->provider)->name);
125 g_label_is_name_ok(const char *label)
129 /* Check if the label starts from ../ */
130 if (strncmp(label, "../", 3) == 0)
132 /* Check if the label contains /../ */
133 if (strstr(label, "/../") != NULL)
135 /* Check if the label ends at ../ */
136 if ((s = strstr(label, "/..")) != NULL && s[3] == '\0')
141 static struct g_geom *
142 g_label_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp,
143 const char *label, const char *dir, off_t mediasize)
146 struct g_provider *pp2;
147 struct g_consumer *cp;
152 if (!g_label_is_name_ok(label)) {
153 G_LABEL_DEBUG(0, "%s contains suspicious label, skipping.",
155 G_LABEL_DEBUG(1, "%s suspicious label is: %s", pp->name, label);
157 gctl_error(req, "Label name %s is invalid.", label);
162 snprintf(name, sizeof(name), "%s/%s", dir, label);
163 LIST_FOREACH(gp, &mp->geom, geom) {
164 pp2 = LIST_FIRST(&gp->provider);
167 if ((pp2->flags & G_PF_ORPHAN) != 0)
169 if (strcmp(pp2->name, name) == 0) {
170 G_LABEL_DEBUG(1, "Label %s(%s) already exists (%s).",
171 label, name, pp->name);
173 gctl_error(req, "Provider %s already exists.",
179 gp = g_slice_new(mp, 1, pp, &cp, NULL, 0, NULL);
181 G_LABEL_DEBUG(0, "Cannot create slice %s.", label);
183 gctl_error(req, "Cannot create slice %s.", label);
186 gp->orphan = g_label_orphan;
187 gp->spoiled = g_label_spoiled;
188 g_access(cp, -1, 0, 0);
189 g_slice_config(gp, 0, G_SLICE_CONFIG_SET, (off_t)0, mediasize,
190 pp->sectorsize, "%s", name);
191 G_LABEL_DEBUG(1, "Label for provider %s is %s.", pp->name, name);
196 g_label_destroy(struct g_geom *gp, boolean_t force)
198 struct g_provider *pp;
201 pp = LIST_FIRST(&gp->provider);
202 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
204 G_LABEL_DEBUG(0, "Provider %s is still open, so it "
205 "can't be definitely removed.", pp->name);
208 "Provider %s is still open (r%dw%de%d).", pp->name,
209 pp->acr, pp->acw, pp->ace);
212 } else if (pp != NULL)
213 G_LABEL_DEBUG(1, "Label %s removed.", pp->name);
214 g_slice_spoiled(LIST_FIRST(&gp->consumer));
219 g_label_read_metadata(struct g_consumer *cp, struct g_label_metadata *md)
221 struct g_provider *pp;
229 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
234 /* Decode metadata. */
235 label_metadata_decode(buf, md);
242 g_label_orphan_taste(struct g_consumer *cp __unused)
245 KASSERT(1 == 0, ("%s called?", __func__));
249 g_label_start_taste(struct bio *bp __unused)
252 KASSERT(1 == 0, ("%s called?", __func__));
256 g_label_access_taste(struct g_provider *pp __unused, int dr __unused,
257 int dw __unused, int de __unused)
260 KASSERT(1 == 0, ("%s called", __func__));
264 static struct g_geom *
265 g_label_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
267 struct g_label_metadata md;
268 struct g_consumer *cp;
272 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
275 G_LABEL_DEBUG(2, "Tasting %s.", pp->name);
277 /* Skip providers that are already open for writing. */
281 if (strcmp(pp->geom->class->name, mp->name) == 0)
284 gp = g_new_geomf(mp, "label:taste");
285 gp->start = g_label_start_taste;
286 gp->access = g_label_access_taste;
287 gp->orphan = g_label_orphan_taste;
288 cp = g_new_consumer(gp);
290 if (g_access(cp, 1, 0, 0) != 0)
293 if (g_label_read_metadata(cp, &md) != 0)
295 if (strcmp(md.md_magic, G_LABEL_MAGIC) != 0)
297 if (md.md_version > G_LABEL_VERSION) {
298 printf("geom_label.ko module is too old to handle %s.\n",
304 * Backward compatibility:
307 * There was no md_provsize field in earlier versions of
310 if (md.md_version < 2)
311 md.md_provsize = pp->mediasize;
313 if (md.md_provsize != pp->mediasize)
316 g_label_create(NULL, mp, pp, md.md_label, G_LABEL_DIR,
317 pp->mediasize - pp->sectorsize);
319 for (i = 0; g_labels[i] != NULL; i++) {
322 if (g_labels[i]->ld_enabled == 0)
325 g_labels[i]->ld_taste(cp, label, sizeof(label));
327 if (label[0] == '\0')
329 g_label_create(NULL, mp, pp, label, g_labels[i]->ld_dir,
332 g_access(cp, -1, 0, 0);
335 g_destroy_consumer(cp);
341 g_label_ctl_create(struct gctl_req *req, struct g_class *mp)
343 struct g_provider *pp;
349 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
351 gctl_error(req, "No '%s' argument", "nargs");
355 gctl_error(req, "Invalid number of arguments.");
359 * arg1 is the name of provider.
361 name = gctl_get_asciiparam(req, "arg1");
363 gctl_error(req, "No 'arg%d' argument", 1);
366 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
367 name += strlen("/dev/");
368 pp = g_provider_by_name(name);
370 G_LABEL_DEBUG(1, "Provider %s is invalid.", name);
371 gctl_error(req, "Provider %s is invalid.", name);
377 name = gctl_get_asciiparam(req, "arg0");
379 gctl_error(req, "No 'arg%d' argument", 0);
382 g_label_create(req, mp, pp, name, G_LABEL_DIR, pp->mediasize);
386 g_label_skip_dir(const char *name)
391 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
392 name += strlen("/dev/");
393 if (strncmp(name, G_LABEL_DIR "/", strlen(G_LABEL_DIR "/")) == 0)
394 name += strlen(G_LABEL_DIR "/");
395 for (i = 0; g_labels[i] != NULL; i++) {
396 snprintf(path, sizeof(path), "%s/", g_labels[i]->ld_dir);
397 if (strncmp(name, path, strlen(path)) == 0) {
398 name += strlen(path);
405 static struct g_geom *
406 g_label_find_geom(struct g_class *mp, const char *name)
409 struct g_provider *pp;
412 name = g_label_skip_dir(name);
413 LIST_FOREACH(gp, &mp->geom, geom) {
414 pp = LIST_FIRST(&gp->provider);
415 pname = g_label_skip_dir(pp->name);
416 if (strcmp(pname, name) == 0)
423 g_label_ctl_destroy(struct gctl_req *req, struct g_class *mp)
425 int *nargs, *force, error, i;
432 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
434 gctl_error(req, "No '%s' argument", "nargs");
438 gctl_error(req, "Missing device(s).");
441 force = gctl_get_paraml(req, "force", sizeof(*force));
443 gctl_error(req, "No 'force' argument");
447 for (i = 0; i < *nargs; i++) {
448 snprintf(param, sizeof(param), "arg%d", i);
449 name = gctl_get_asciiparam(req, param);
451 gctl_error(req, "No 'arg%d' argument", i);
454 gp = g_label_find_geom(mp, name);
456 G_LABEL_DEBUG(1, "Label %s is invalid.", name);
457 gctl_error(req, "Label %s is invalid.", name);
460 error = g_label_destroy(gp, *force);
462 gctl_error(req, "Cannot destroy label %s (error=%d).",
463 LIST_FIRST(&gp->provider)->name, error);
470 g_label_config(struct gctl_req *req, struct g_class *mp, const char *verb)
476 version = gctl_get_paraml(req, "version", sizeof(*version));
477 if (version == NULL) {
478 gctl_error(req, "No '%s' argument.", "version");
481 if (*version != G_LABEL_VERSION) {
482 gctl_error(req, "Userland and kernel parts are out of sync.");
486 if (strcmp(verb, "create") == 0) {
487 g_label_ctl_create(req, mp);
489 } else if (strcmp(verb, "destroy") == 0 ||
490 strcmp(verb, "stop") == 0) {
491 g_label_ctl_destroy(req, mp);
495 gctl_error(req, "Unknown verb.");
498 DECLARE_GEOM_CLASS(g_label_class, g_label);