sys/geom/label/g_label.c

   1 /*-
   2  * Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  *
  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
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/param.h>
  31 #include <sys/systm.h>
  32 #include <sys/kernel.h>
  33 #include <sys/module.h>
  34 #include <sys/lock.h>
  35 #include <sys/mutex.h>
  36 #include <sys/bio.h>
  37 #include <sys/sysctl.h>
  38 #include <sys/malloc.h>
  39 #include <sys/libkern.h>
  40 #include <geom/geom.h>
  41 #include <geom/geom_slice.h>
  42 #include <geom/label/g_label.h>
  43
  44
  45 SYSCTL_DECL(_kern_geom);
  46 SYSCTL_NODE(_kern_geom, OID_AUTO, label, CTLFLAG_RW, 0, "GEOM_LABEL stuff");
  47 u_int g_label_debug = 0;
  48 TUNABLE_INT("kern.geom.label.debug", &g_label_debug);
  49 SYSCTL_UINT(_kern_geom_label, OID_AUTO, debug, CTLFLAG_RW, &g_label_debug, 0,
  50     "Debug level");
  51
  52 static int g_label_destroy_geom(struct gctl_req *req, struct g_class *mp,
  53     struct g_geom *gp);
  54 static int g_label_destroy(struct g_geom *gp, boolean_t force);
  55 static struct g_geom *g_label_taste(struct g_class *mp, struct g_provider *pp,
  56     int flags __unused);
  57 static void g_label_config(struct gctl_req *req, struct g_class *mp,
  58     const char *verb);
  59
  60 struct g_class g_label_class = {
  61         .name = G_LABEL_CLASS_NAME,
  62         .version = G_VERSION,
  63         .ctlreq = g_label_config,
  64         .taste = g_label_taste,
  65         .destroy_geom = g_label_destroy_geom
  66 };
  67
  68 /*
  69  * To add a new file system where you want to look for volume labels,
  70  * you have to:
  71  * 1. Add a file g_label_<file system>.c which implements labels recognition.
  72  * 2. Add an 'extern const struct g_label_desc g_label_<file system>;' into
  73  *    g_label.h file.
  74  * 3. Add an element to the table below '&g_label_<file system>,'.
  75  * 4. Add your file to sys/conf/files.
  76  * 5. Add your file to sys/modules/geom/geom_label/Makefile.
  77  * 6. Add your file system to manual page sbin/geom/class/label/glabel.8.
  78  */
  79 const struct g_label_desc *g_labels[] = {
  80         &g_label_ufs_id,
  81         &g_label_ufs_volume,
  82         &g_label_iso9660,
  83         &g_label_msdosfs,
  84         &g_label_ext2fs,
  85         &g_label_reiserfs,
  86         &g_label_ntfs,
  87         &g_label_gpt,
  88         &g_label_gpt_uuid,
  89         NULL
  90 };
  91
  92
  93 static int
  94 g_label_destroy_geom(struct gctl_req *req __unused, struct g_class *mp,
  95     struct g_geom *gp __unused)
  96 {
  97
  98         /*
  99          * XXX: Unloading a class which is using geom_slice:1.56 is currently
 100          * XXX: broken, so we deny unloading when we have geoms.
 101          */
 102         return (EOPNOTSUPP);
 103 }
 104
 105 static void
 106 g_label_orphan(struct g_consumer *cp)
 107 {
 108
 109         G_LABEL_DEBUG(1, "Label %s removed.",
 110             LIST_FIRST(&cp->geom->provider)->name);
 111         g_slice_orphan(cp);
 112 }
 113
 114 static void
 115 g_label_spoiled(struct g_consumer *cp)
 116 {
 117
 118         G_LABEL_DEBUG(1, "Label %s removed.",
 119             LIST_FIRST(&cp->geom->provider)->name);
 120         g_slice_spoiled(cp);
 121 }
 122
 123 static int
 124 g_label_is_name_ok(const char *label)
 125 {
 126         const char *s;
 127
 128         /* Check is the label starts from ../ */
 129         if (strncmp(label, "../", 3) == 0)
 130                 return (0);
 131         /* Check is the label contains /../ */
 132         if (strstr(label, "/../") != NULL)
 133                 return (0);
 134         /* Check is the label ends at ../ */
 135         if ((s = strstr(label, "/..")) != NULL && s[3] == '\0')
 136                 return (0);
 137         return (1);
 138 }
 139
 140 static struct g_geom *
 141 g_label_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp,
 142     const char *label, const char *dir, off_t mediasize)
 143 {
 144         struct g_geom *gp;
 145         struct g_provider *pp2;
 146         struct g_consumer *cp;
 147         char name[64];
 148
 149         g_topology_assert();
 150
 151         if (!g_label_is_name_ok(label)) {
 152                 G_LABEL_DEBUG(0, "%s contains suspicious label, skipping.",
 153                     pp->name);
 154                 G_LABEL_DEBUG(1, "%s suspicious label is: %s", pp->name, label);
 155                 return (NULL);
 156         }
 157         gp = NULL;
 158         cp = NULL;
 159         snprintf(name, sizeof(name), "%s/%s", dir, label);
 160         LIST_FOREACH(gp, &mp->geom, geom) {
 161                 pp2 = LIST_FIRST(&gp->provider);
 162                 if (pp2 == NULL)
 163                         continue;
 164                 if (strcmp(pp2->name, name) == 0) {
 165                         G_LABEL_DEBUG(1, "Label %s(%s) already exists (%s).",
 166                             label, name, pp->name);
 167                         if (req != NULL) {
 168                                 gctl_error(req, "Provider %s already exists.",
 169                                     name);
 170                         }
 171                         return (NULL);
 172                 }
 173         }
 174         gp = g_slice_new(mp, 1, pp, &cp, NULL, 0, NULL);
 175         if (gp == NULL) {
 176                 G_LABEL_DEBUG(0, "Cannot create slice %s.", label);
 177                 if (req != NULL)
 178                         gctl_error(req, "Cannot create slice %s.", label);
 179                 return (NULL);
 180         }
 181         gp->orphan = g_label_orphan;
 182         gp->spoiled = g_label_spoiled;
 183         g_access(cp, -1, 0, 0);
 184         g_slice_config(gp, 0, G_SLICE_CONFIG_SET, (off_t)0, mediasize,
 185             pp->sectorsize, name);
 186         G_LABEL_DEBUG(1, "Label for provider %s is %s.", pp->name, name);
 187         return (gp);
 188 }
 189
 190 static int
 191 g_label_destroy(struct g_geom *gp, boolean_t force)
 192 {
 193         struct g_provider *pp;
 194
 195         g_topology_assert();
 196         pp = LIST_FIRST(&gp->provider);
 197         if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
 198                 if (force) {
 199                         G_LABEL_DEBUG(0, "Provider %s is still open, so it "
 200                             "can't be definitely removed.", pp->name);
 201                 } else {
 202                         G_LABEL_DEBUG(1,
 203                             "Provider %s is still open (r%dw%de%d).", pp->name,
 204                             pp->acr, pp->acw, pp->ace);
 205                         return (EBUSY);
 206                 }
 207         } else {
 208                 G_LABEL_DEBUG(1, "Label %s removed.",
 209                     LIST_FIRST(&gp->provider)->name);
 210         }
 211         g_slice_spoiled(LIST_FIRST(&gp->consumer));
 212         return (0);
 213 }
 214
 215 static int
 216 g_label_read_metadata(struct g_consumer *cp, struct g_label_metadata *md)
 217 {
 218         struct g_provider *pp;
 219         u_char *buf;
 220         int error;
 221
 222         g_topology_assert();
 223
 224         pp = cp->provider;
 225         g_topology_unlock();
 226         buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
 227             &error);
 228         g_topology_lock();
 229         if (buf == NULL)
 230                 return (error);
 231         /* Decode metadata. */
 232         label_metadata_decode(buf, md);
 233         g_free(buf);
 234
 235         return (0);
 236 }
 237
 238 static void
 239 g_label_orphan_taste(struct g_consumer *cp __unused)
 240 {
 241
 242         KASSERT(1 == 0, ("%s called?", __func__));
 243 }
 244
 245 static void
 246 g_label_start_taste(struct bio *bp __unused)
 247 {
 248
 249         KASSERT(1 == 0, ("%s called?", __func__));
 250 }
 251
 252 static int
 253 g_label_access_taste(struct g_provider *pp __unused, int dr __unused,
 254     int dw __unused, int de __unused)
 255 {
 256
 257         KASSERT(1 == 0, ("%s called", __func__));
 258         return (EOPNOTSUPP);
 259 }
 260
 261 static struct g_geom *
 262 g_label_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
 263 {
 264         struct g_label_metadata md;
 265         struct g_consumer *cp;
 266         struct g_geom *gp;
 267         int i;
 268
 269         g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
 270         g_topology_assert();
 271
 272         G_LABEL_DEBUG(2, "Tasting %s.", pp->name);
 273
 274         /* Skip providers that are already open for writing. */
 275         if (pp->acw > 0)
 276                 return (NULL);
 277
 278         if (strcmp(pp->geom->class->name, mp->name) == 0)
 279                 return (NULL);
 280
 281         gp = g_new_geomf(mp, "label:taste");
 282         gp->start = g_label_start_taste;
 283         gp->access = g_label_access_taste;
 284         gp->orphan = g_label_orphan_taste;
 285         cp = g_new_consumer(gp);
 286         g_attach(cp, pp);
 287         if (g_access(cp, 1, 0, 0) != 0)
 288                 goto end;
 289         do {
 290                 if (g_label_read_metadata(cp, &md) != 0)
 291                         break;
 292                 if (strcmp(md.md_magic, G_LABEL_MAGIC) != 0)
 293                         break;
 294                 if (md.md_version > G_LABEL_VERSION) {
 295                         printf("geom_label.ko module is too old to handle %s.\n",
 296                             pp->name);
 297                         break;
 298                 }
 299
 300                 /*
 301                  * Backward compatibility:
 302                  */
 303                 /*
 304                  * There was no md_provsize field in earlier versions of
 305                  * metadata.
 306                  */
 307                 if (md.md_version < 2)
 308                         md.md_provsize = pp->mediasize;
 309
 310                 if (md.md_provsize != pp->mediasize)
 311                         break;
 312
 313                 g_label_create(NULL, mp, pp, md.md_label, G_LABEL_DIR,
 314                     pp->mediasize - pp->sectorsize);
 315         } while (0);
 316         for (i = 0; g_labels[i] != NULL; i++) {
 317                 char label[64];
 318
 319                 g_topology_unlock();
 320                 g_labels[i]->ld_taste(cp, label, sizeof(label));
 321                 g_topology_lock();
 322                 if (label[0] == '\0')
 323                         continue;
 324                 g_label_create(NULL, mp, pp, label, g_labels[i]->ld_dir,
 325                     pp->mediasize);
 326         }
 327         g_access(cp, -1, 0, 0);
 328 end:
 329         g_detach(cp);
 330         g_destroy_consumer(cp);
 331         g_destroy_geom(gp);
 332         return (NULL);
 333 }
 334
 335 static void
 336 g_label_ctl_create(struct gctl_req *req, struct g_class *mp)
 337 {
 338         struct g_provider *pp;
 339         const char *name;
 340         int *nargs;
 341
 342         g_topology_assert();
 343
 344         nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
 345         if (nargs == NULL) {
 346                 gctl_error(req, "No '%s' argument", "nargs");
 347                 return;
 348         }
 349         if (*nargs != 2) {
 350                 gctl_error(req, "Invalid number of argument.");
 351                 return;
 352         }
 353         /*
 354          * arg1 is the name of provider.
 355          */
 356         name = gctl_get_asciiparam(req, "arg1");
 357         if (name == NULL) {
 358                 gctl_error(req, "No 'arg%d' argument", 1);
 359                 return;
 360         }
 361         if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
 362                 name += strlen("/dev/");
 363         pp = g_provider_by_name(name);
 364         if (pp == NULL) {
 365                 G_LABEL_DEBUG(1, "Provider %s is invalid.", name);
 366                 gctl_error(req, "Provider %s is invalid.", name);
 367                 return;
 368         }
 369         /*
 370          * arg0 is the label.
 371          */
 372         name = gctl_get_asciiparam(req, "arg0");
 373         if (name == NULL) {
 374                 gctl_error(req, "No 'arg%d' argument", 0);
 375                 return;
 376         }
 377         g_label_create(req, mp, pp, name, G_LABEL_DIR, pp->mediasize);
 378 }
 379
 380 static const char *
 381 g_label_skip_dir(const char *name)
 382 {
 383         char path[64];
 384         u_int i;
 385
 386         if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
 387                 name += strlen("/dev/");
 388         if (strncmp(name, G_LABEL_DIR "/", strlen(G_LABEL_DIR "/")) == 0)
 389                 name += strlen(G_LABEL_DIR "/");
 390         for (i = 0; g_labels[i] != NULL; i++) {
 391                 snprintf(path, sizeof(path), "%s/", g_labels[i]->ld_dir);
 392                 if (strncmp(name, path, strlen(path)) == 0) {
 393                         name += strlen(path);
 394                         break;
 395                 }
 396         }
 397         return (name);
 398 }
 399
 400 static struct g_geom *
 401 g_label_find_geom(struct g_class *mp, const char *name)
 402 {
 403         struct g_geom *gp;
 404         struct g_provider *pp;
 405         const char *pname;
 406
 407         name = g_label_skip_dir(name);
 408         LIST_FOREACH(gp, &mp->geom, geom) {
 409                 pp = LIST_FIRST(&gp->provider);
 410                 pname = g_label_skip_dir(pp->name);
 411                 if (strcmp(pname, name) == 0)
 412                         return (gp);
 413         }
 414         return (NULL);
 415 }
 416
 417 static void
 418 g_label_ctl_destroy(struct gctl_req *req, struct g_class *mp)
 419 {
 420         int *nargs, *force, error, i;
 421         struct g_geom *gp;
 422         const char *name;
 423         char param[16];
 424
 425         g_topology_assert();
 426
 427         nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
 428         if (nargs == NULL) {
 429                 gctl_error(req, "No '%s' argument", "nargs");
 430                 return;
 431         }
 432         if (*nargs <= 0) {
 433                 gctl_error(req, "Missing device(s).");
 434                 return;
 435         }
 436         force = gctl_get_paraml(req, "force", sizeof(*force));
 437         if (force == NULL) {
 438                 gctl_error(req, "No 'force' argument");
 439                 return;
 440         }
 441
 442         for (i = 0; i < *nargs; i++) {
 443                 snprintf(param, sizeof(param), "arg%d", i);
 444                 name = gctl_get_asciiparam(req, param);
 445                 if (name == NULL) {
 446                         gctl_error(req, "No 'arg%d' argument", i);
 447                         return;
 448                 }
 449                 gp = g_label_find_geom(mp, name);
 450                 if (gp == NULL) {
 451                         G_LABEL_DEBUG(1, "Label %s is invalid.", name);
 452                         gctl_error(req, "Label %s is invalid.", name);
 453                         return;
 454                 }
 455                 error = g_label_destroy(gp, *force);
 456                 if (error != 0) {
 457                         gctl_error(req, "Cannot destroy label %s (error=%d).",
 458                             LIST_FIRST(&gp->provider)->name, error);
 459                         return;
 460                 }
 461         }
 462 }
 463
 464 static void
 465 g_label_config(struct gctl_req *req, struct g_class *mp, const char *verb)
 466 {
 467         uint32_t *version;
 468
 469         g_topology_assert();
 470
 471         version = gctl_get_paraml(req, "version", sizeof(*version));
 472         if (version == NULL) {
 473                 gctl_error(req, "No '%s' argument.", "version");
 474                 return;
 475         }
 476         if (*version != G_LABEL_VERSION) {
 477                 gctl_error(req, "Userland and kernel parts are out of sync.");
 478                 return;
 479         }
 480
 481         if (strcmp(verb, "create") == 0) {
 482                 g_label_ctl_create(req, mp);
 483                 return;
 484         } else if (strcmp(verb, "destroy") == 0 ||
 485             strcmp(verb, "stop") == 0) {
 486                 g_label_ctl_destroy(req, mp);
 487                 return;
 488         }
 489
 490         gctl_error(req, "Unknown verb.");
 491 }
 492
 493 DECLARE_GEOM_CLASS(g_label_class, g_label);