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