1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include "opt_geom.h" 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/kernel.h> 37 #include <sys/module.h> 38 #include <sys/lock.h> 39 #include <sys/mutex.h> 40 #include <sys/bio.h> 41 #include <sys/ctype.h> 42 #include <sys/malloc.h> 43 #include <sys/libkern.h> 44 #include <sys/sbuf.h> 45 #include <sys/stddef.h> 46 #include <sys/sysctl.h> 47 #include <geom/geom.h> 48 #include <geom/geom_slice.h> 49 #include <geom/label/g_label.h> 50 51 FEATURE(geom_label, "GEOM labeling support"); 52 53 SYSCTL_DECL(_kern_geom); 54 SYSCTL_NODE(_kern_geom, OID_AUTO, label, CTLFLAG_RW, 0, "GEOM_LABEL stuff"); 55 u_int g_label_debug = 0; 56 SYSCTL_UINT(_kern_geom_label, OID_AUTO, debug, CTLFLAG_RWTUN, &g_label_debug, 0, 57 "Debug level"); 58 59 static int g_label_destroy_geom(struct gctl_req *req, struct g_class *mp, 60 struct g_geom *gp); 61 static int g_label_destroy(struct g_geom *gp, boolean_t force); 62 static struct g_geom *g_label_taste(struct g_class *mp, struct g_provider *pp, 63 int flags __unused); 64 static void g_label_config(struct gctl_req *req, struct g_class *mp, 65 const char *verb); 66 67 struct g_class g_label_class = { 68 .name = G_LABEL_CLASS_NAME, 69 .version = G_VERSION, 70 .ctlreq = g_label_config, 71 .taste = g_label_taste, 72 .destroy_geom = g_label_destroy_geom 73 }; 74 75 /* 76 * To add a new file system where you want to look for volume labels, 77 * you have to: 78 * 1. Add a file g_label_<file system>.c which implements labels recognition. 79 * 2. Add an 'extern const struct g_label_desc g_label_<file system>;' into 80 * g_label.h file. 81 * 3. Add an element to the table below '&g_label_<file system>,'. 82 * 4. Add your file to sys/conf/files. 83 * 5. Add your file to sys/modules/geom/geom_label/Makefile. 84 * 6. Add your file system to manual page sbin/geom/class/label/glabel.8. 85 */ 86 const struct g_label_desc *g_labels[] = { 87 &g_label_gpt, 88 &g_label_gpt_uuid, 89 #ifdef GEOM_LABEL 90 &g_label_ufs_id, 91 &g_label_ufs_volume, 92 &g_label_iso9660, 93 &g_label_msdosfs, 94 &g_label_ext2fs, 95 &g_label_reiserfs, 96 &g_label_ntfs, 97 &g_label_disk_ident, 98 #endif 99 NULL 100 }; 101 102 void 103 g_label_rtrim(char *label, size_t size) 104 { 105 ptrdiff_t i; 106 107 for (i = size - 1; i >= 0; i--) { 108 if (label[i] == '\0') 109 continue; 110 else if (label[i] == ' ') 111 label[i] = '\0'; 112 else 113 break; 114 } 115 } 116 117 static int 118 g_label_destroy_geom(struct gctl_req *req __unused, struct g_class *mp, 119 struct g_geom *gp __unused) 120 { 121 122 /* 123 * XXX: Unloading a class which is using geom_slice:1.56 is currently 124 * XXX: broken, so we deny unloading when we have geoms. 125 */ 126 return (EOPNOTSUPP); 127 } 128 129 static void 130 g_label_orphan(struct g_consumer *cp) 131 { 132 133 G_LABEL_DEBUG(1, "Label %s removed.", 134 LIST_FIRST(&cp->geom->provider)->name); 135 g_slice_orphan(cp); 136 } 137 138 static void 139 g_label_spoiled(struct g_consumer *cp) 140 { 141 142 G_LABEL_DEBUG(1, "Label %s removed.", 143 LIST_FIRST(&cp->geom->provider)->name); 144 g_slice_spoiled(cp); 145 } 146 147 static void 148 g_label_resize(struct g_consumer *cp) 149 { 150 151 G_LABEL_DEBUG(1, "Label %s resized.", 152 LIST_FIRST(&cp->geom->provider)->name); 153 154 g_slice_config(cp->geom, 0, G_SLICE_CONFIG_FORCE, (off_t)0, 155 cp->provider->mediasize, cp->provider->sectorsize, "notused"); 156 } 157 158 static int 159 g_label_is_name_ok(const char *label) 160 { 161 const char *s; 162 163 /* Check if the label starts from ../ */ 164 if (strncmp(label, "../", 3) == 0) 165 return (0); 166 /* Check if the label contains /../ */ 167 if (strstr(label, "/../") != NULL) 168 return (0); 169 /* Check if the label ends at ../ */ 170 if ((s = strstr(label, "/..")) != NULL && s[3] == '\0') 171 return (0); 172 return (1); 173 } 174 175 static void 176 g_label_mangle_name(char *label, size_t size) 177 { 178 struct sbuf *sb; 179 const u_char *c; 180 181 sb = sbuf_new(NULL, NULL, size, SBUF_FIXEDLEN); 182 for (c = label; *c != '\0'; c++) { 183 if (!isprint(*c) || isspace(*c) || *c =='"' || *c == '%') 184 sbuf_printf(sb, "%%%02X", *c); 185 else 186 sbuf_putc(sb, *c); 187 } 188 if (sbuf_finish(sb) != 0) 189 label[0] = '\0'; 190 else 191 strlcpy(label, sbuf_data(sb), size); 192 sbuf_delete(sb); 193 } 194 195 static struct g_geom * 196 g_label_create(struct gctl_req *req, struct g_class *mp, struct g_provider *pp, 197 const char *label, const char *dir, off_t mediasize) 198 { 199 struct g_geom *gp; 200 struct g_provider *pp2; 201 struct g_consumer *cp; 202 char name[64]; 203 204 g_topology_assert(); 205 206 if (!g_label_is_name_ok(label)) { 207 G_LABEL_DEBUG(0, "%s contains suspicious label, skipping.", 208 pp->name); 209 G_LABEL_DEBUG(1, "%s suspicious label is: %s", pp->name, label); 210 if (req != NULL) 211 gctl_error(req, "Label name %s is invalid.", label); 212 return (NULL); 213 } 214 gp = NULL; 215 cp = NULL; 216 snprintf(name, sizeof(name), "%s/%s", dir, label); 217 LIST_FOREACH(gp, &mp->geom, geom) { 218 pp2 = LIST_FIRST(&gp->provider); 219 if (pp2 == NULL) 220 continue; 221 if ((pp2->flags & G_PF_ORPHAN) != 0) 222 continue; 223 if (strcmp(pp2->name, name) == 0) { 224 G_LABEL_DEBUG(1, "Label %s(%s) already exists (%s).", 225 label, name, pp->name); 226 if (req != NULL) { 227 gctl_error(req, "Provider %s already exists.", 228 name); 229 } 230 return (NULL); 231 } 232 } 233 gp = g_slice_new(mp, 1, pp, &cp, NULL, 0, NULL); 234 if (gp == NULL) { 235 G_LABEL_DEBUG(0, "Cannot create slice %s.", label); 236 if (req != NULL) 237 gctl_error(req, "Cannot create slice %s.", label); 238 return (NULL); 239 } 240 gp->orphan = g_label_orphan; 241 gp->spoiled = g_label_spoiled; 242 gp->resize = g_label_resize; 243 g_access(cp, -1, 0, 0); 244 g_slice_config(gp, 0, G_SLICE_CONFIG_SET, (off_t)0, mediasize, 245 pp->sectorsize, "%s", name); 246 G_LABEL_DEBUG(1, "Label for provider %s is %s.", pp->name, name); 247 return (gp); 248 } 249 250 static int 251 g_label_destroy(struct g_geom *gp, boolean_t force) 252 { 253 struct g_provider *pp; 254 255 g_topology_assert(); 256 pp = LIST_FIRST(&gp->provider); 257 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) { 258 if (force) { 259 G_LABEL_DEBUG(0, "Provider %s is still open, so it " 260 "can't be definitely removed.", pp->name); 261 } else { 262 G_LABEL_DEBUG(1, 263 "Provider %s is still open (r%dw%de%d).", pp->name, 264 pp->acr, pp->acw, pp->ace); 265 return (EBUSY); 266 } 267 } else if (pp != NULL) 268 G_LABEL_DEBUG(1, "Label %s removed.", pp->name); 269 g_slice_spoiled(LIST_FIRST(&gp->consumer)); 270 return (0); 271 } 272 273 static int 274 g_label_read_metadata(struct g_consumer *cp, struct g_label_metadata *md) 275 { 276 struct g_provider *pp; 277 u_char *buf; 278 int error; 279 280 g_topology_assert(); 281 282 pp = cp->provider; 283 g_topology_unlock(); 284 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize, 285 &error); 286 g_topology_lock(); 287 if (buf == NULL) 288 return (error); 289 /* Decode metadata. */ 290 label_metadata_decode(buf, md); 291 g_free(buf); 292 293 return (0); 294 } 295 296 static void 297 g_label_orphan_taste(struct g_consumer *cp __unused) 298 { 299 300 KASSERT(1 == 0, ("%s called?", __func__)); 301 } 302 303 static void 304 g_label_start_taste(struct bio *bp __unused) 305 { 306 307 KASSERT(1 == 0, ("%s called?", __func__)); 308 } 309 310 static int 311 g_label_access_taste(struct g_provider *pp __unused, int dr __unused, 312 int dw __unused, int de __unused) 313 { 314 315 KASSERT(1 == 0, ("%s called", __func__)); 316 return (EOPNOTSUPP); 317 } 318 319 static struct g_geom * 320 g_label_taste(struct g_class *mp, struct g_provider *pp, int flags __unused) 321 { 322 struct g_label_metadata md; 323 struct g_consumer *cp; 324 struct g_geom *gp; 325 int i; 326 327 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name); 328 g_topology_assert(); 329 330 G_LABEL_DEBUG(2, "Tasting %s.", pp->name); 331 332 /* Skip providers that are already open for writing. */ 333 if (pp->acw > 0) 334 return (NULL); 335 336 if (strcmp(pp->geom->class->name, mp->name) == 0) 337 return (NULL); 338 339 gp = g_new_geomf(mp, "label:taste"); 340 gp->start = g_label_start_taste; 341 gp->access = g_label_access_taste; 342 gp->orphan = g_label_orphan_taste; 343 cp = g_new_consumer(gp); 344 g_attach(cp, pp); 345 if (g_access(cp, 1, 0, 0) != 0) 346 goto end; 347 do { 348 if (g_label_read_metadata(cp, &md) != 0) 349 break; 350 if (strcmp(md.md_magic, G_LABEL_MAGIC) != 0) 351 break; 352 if (md.md_version > G_LABEL_VERSION) { 353 printf("geom_label.ko module is too old to handle %s.\n", 354 pp->name); 355 break; 356 } 357 358 /* 359 * Backward compatibility: 360 */ 361 /* 362 * There was no md_provsize field in earlier versions of 363 * metadata. 364 */ 365 if (md.md_version < 2) 366 md.md_provsize = pp->mediasize; 367 368 if (md.md_provsize != pp->mediasize) 369 break; 370 371 g_label_create(NULL, mp, pp, md.md_label, G_LABEL_DIR, 372 pp->mediasize - pp->sectorsize); 373 } while (0); 374 for (i = 0; g_labels[i] != NULL; i++) { 375 char label[128]; 376 377 if (g_labels[i]->ld_enabled == 0) 378 continue; 379 g_topology_unlock(); 380 g_labels[i]->ld_taste(cp, label, sizeof(label)); 381 g_label_mangle_name(label, sizeof(label)); 382 g_topology_lock(); 383 if (label[0] == '\0') 384 continue; 385 g_label_create(NULL, mp, pp, label, g_labels[i]->ld_dir, 386 pp->mediasize); 387 } 388 g_access(cp, -1, 0, 0); 389 end: 390 g_detach(cp); 391 g_destroy_consumer(cp); 392 g_destroy_geom(gp); 393 return (NULL); 394 } 395 396 static void 397 g_label_ctl_create(struct gctl_req *req, struct g_class *mp) 398 { 399 struct g_provider *pp; 400 const char *name; 401 int *nargs; 402 403 g_topology_assert(); 404 405 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 406 if (nargs == NULL) { 407 gctl_error(req, "No '%s' argument", "nargs"); 408 return; 409 } 410 if (*nargs != 2) { 411 gctl_error(req, "Invalid number of arguments."); 412 return; 413 } 414 /* 415 * arg1 is the name of provider. 416 */ 417 name = gctl_get_asciiparam(req, "arg1"); 418 if (name == NULL) { 419 gctl_error(req, "No 'arg%d' argument", 1); 420 return; 421 } 422 if (strncmp(name, "/dev/", strlen("/dev/")) == 0) 423 name += strlen("/dev/"); 424 pp = g_provider_by_name(name); 425 if (pp == NULL) { 426 G_LABEL_DEBUG(1, "Provider %s is invalid.", name); 427 gctl_error(req, "Provider %s is invalid.", name); 428 return; 429 } 430 /* 431 * arg0 is the label. 432 */ 433 name = gctl_get_asciiparam(req, "arg0"); 434 if (name == NULL) { 435 gctl_error(req, "No 'arg%d' argument", 0); 436 return; 437 } 438 g_label_create(req, mp, pp, name, G_LABEL_DIR, pp->mediasize); 439 } 440 441 static const char * 442 g_label_skip_dir(const char *name) 443 { 444 char path[64]; 445 u_int i; 446 447 if (strncmp(name, "/dev/", strlen("/dev/")) == 0) 448 name += strlen("/dev/"); 449 if (strncmp(name, G_LABEL_DIR "/", strlen(G_LABEL_DIR "/")) == 0) 450 name += strlen(G_LABEL_DIR "/"); 451 for (i = 0; g_labels[i] != NULL; i++) { 452 snprintf(path, sizeof(path), "%s/", g_labels[i]->ld_dir); 453 if (strncmp(name, path, strlen(path)) == 0) { 454 name += strlen(path); 455 break; 456 } 457 } 458 return (name); 459 } 460 461 static struct g_geom * 462 g_label_find_geom(struct g_class *mp, const char *name) 463 { 464 struct g_geom *gp; 465 struct g_provider *pp; 466 const char *pname; 467 468 name = g_label_skip_dir(name); 469 LIST_FOREACH(gp, &mp->geom, geom) { 470 pp = LIST_FIRST(&gp->provider); 471 pname = g_label_skip_dir(pp->name); 472 if (strcmp(pname, name) == 0) 473 return (gp); 474 } 475 return (NULL); 476 } 477 478 static void 479 g_label_ctl_destroy(struct gctl_req *req, struct g_class *mp) 480 { 481 int *nargs, *force, error, i; 482 struct g_geom *gp; 483 const char *name; 484 char param[16]; 485 486 g_topology_assert(); 487 488 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs)); 489 if (nargs == NULL) { 490 gctl_error(req, "No '%s' argument", "nargs"); 491 return; 492 } 493 if (*nargs <= 0) { 494 gctl_error(req, "Missing device(s)."); 495 return; 496 } 497 force = gctl_get_paraml(req, "force", sizeof(*force)); 498 if (force == NULL) { 499 gctl_error(req, "No 'force' argument"); 500 return; 501 } 502 503 for (i = 0; i < *nargs; i++) { 504 snprintf(param, sizeof(param), "arg%d", i); 505 name = gctl_get_asciiparam(req, param); 506 if (name == NULL) { 507 gctl_error(req, "No 'arg%d' argument", i); 508 return; 509 } 510 gp = g_label_find_geom(mp, name); 511 if (gp == NULL) { 512 G_LABEL_DEBUG(1, "Label %s is invalid.", name); 513 gctl_error(req, "Label %s is invalid.", name); 514 return; 515 } 516 error = g_label_destroy(gp, *force); 517 if (error != 0) { 518 gctl_error(req, "Cannot destroy label %s (error=%d).", 519 LIST_FIRST(&gp->provider)->name, error); 520 return; 521 } 522 } 523 } 524 525 static void 526 g_label_config(struct gctl_req *req, struct g_class *mp, const char *verb) 527 { 528 uint32_t *version; 529 530 g_topology_assert(); 531 532 version = gctl_get_paraml(req, "version", sizeof(*version)); 533 if (version == NULL) { 534 gctl_error(req, "No '%s' argument.", "version"); 535 return; 536 } 537 if (*version != G_LABEL_VERSION) { 538 gctl_error(req, "Userland and kernel parts are out of sync."); 539 return; 540 } 541 542 if (strcmp(verb, "create") == 0) { 543 g_label_ctl_create(req, mp); 544 return; 545 } else if (strcmp(verb, "destroy") == 0 || 546 strcmp(verb, "stop") == 0) { 547 g_label_ctl_destroy(req, mp); 548 return; 549 } 550 551 gctl_error(req, "Unknown verb."); 552 } 553 554 DECLARE_GEOM_CLASS(g_label_class, g_label); 555