module.c revision 294058
1192067Snwhitehorn/*- 2192067Snwhitehorn * Copyright (c) 1998 Michael Smith <msmith@freebsd.org> 3192067Snwhitehorn * All rights reserved. 4192067Snwhitehorn * 5192067Snwhitehorn * Redistribution and use in source and binary forms, with or without 6192067Snwhitehorn * modification, are permitted provided that the following conditions 7192067Snwhitehorn * are met: 8192067Snwhitehorn * 1. Redistributions of source code must retain the above copyright 9192067Snwhitehorn * notice, this list of conditions and the following disclaimer. 10192067Snwhitehorn * 2. Redistributions in binary form must reproduce the above copyright 11192067Snwhitehorn * notice, this list of conditions and the following disclaimer in the 12192067Snwhitehorn * documentation and/or other materials provided with the distribution. 13192067Snwhitehorn * 14192067Snwhitehorn * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15192067Snwhitehorn * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16192067Snwhitehorn * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17192067Snwhitehorn * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18192067Snwhitehorn * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19192067Snwhitehorn * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20192067Snwhitehorn * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21192067Snwhitehorn * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22192067Snwhitehorn * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23192067Snwhitehorn * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24192067Snwhitehorn * SUCH DAMAGE. 25192067Snwhitehorn */ 26192067Snwhitehorn 27192067Snwhitehorn#include <sys/cdefs.h> 28192067Snwhitehorn__FBSDID("$FreeBSD: head/sys/boot/common/module.c 294058 2016-01-15 00:55:36Z smh $"); 29192067Snwhitehorn 30192067Snwhitehorn/* 31192067Snwhitehorn * file/module function dispatcher, support, etc. 32192067Snwhitehorn */ 33192067Snwhitehorn 34192067Snwhitehorn#include <stand.h> 35192067Snwhitehorn#include <string.h> 36192067Snwhitehorn#include <sys/param.h> 37192067Snwhitehorn#include <sys/linker.h> 38192067Snwhitehorn#include <sys/module.h> 39192067Snwhitehorn#include <sys/queue.h> 40192067Snwhitehorn#include <sys/stdint.h> 41192067Snwhitehorn 42192067Snwhitehorn#include "bootstrap.h" 43192067Snwhitehorn 44192067Snwhitehorn#define MDIR_REMOVED 0x0001 45192067Snwhitehorn#define MDIR_NOHINTS 0x0002 46192067Snwhitehorn 47209908Srajstruct moduledir { 48209908Sraj char *d_path; /* path of modules directory */ 49209908Sraj u_char *d_hints; /* content of linker.hints file */ 50209908Sraj int d_hintsz; /* size of hints data */ 51209908Sraj int d_flags; 52192067Snwhitehorn STAILQ_ENTRY(moduledir) d_link; 53192067Snwhitehorn}; 54192067Snwhitehorn 55192067Snwhitehornstatic int file_load(char *filename, vm_offset_t dest, struct preloaded_file **result); 56192532Srajstatic int file_load_dependencies(struct preloaded_file *base_mod); 57192532Srajstatic char * file_search(const char *name, char **extlist); 58192532Srajstatic struct kernel_module * file_findmodule(struct preloaded_file *fp, char *modname, struct mod_depend *verinfo); 59192532Srajstatic int file_havepath(const char *name); 60192532Srajstatic char *mod_searchmodule(char *name, struct mod_depend *verinfo); 61192532Srajstatic void file_insert_tail(struct preloaded_file *mp); 62193492Srajstruct file_metadata* metadata_next(struct file_metadata *base_mp, int type); 63192067Snwhitehornstatic void moduledir_readhints(struct moduledir *mdp); 64192067Snwhitehornstatic void moduledir_rebuild(void); 65192067Snwhitehorn 66192067Snwhitehorn/* load address should be tweaked by first module loaded (kernel) */ 67192067Snwhitehornstatic vm_offset_t loadaddr = 0; 68192067Snwhitehorn 69192067Snwhitehorn#if defined(LOADER_FDT_SUPPORT) 70192067Snwhitehornstatic const char *default_searchpath = 71192067Snwhitehorn "/boot/kernel;/boot/modules;/boot/dtb"; 72192067Snwhitehorn#else 73212054Snwhitehornstatic const char *default_searchpath ="/boot/kernel;/boot/modules"; 74212054Snwhitehorn#endif 75192067Snwhitehorn 76192067Snwhitehornstatic STAILQ_HEAD(, moduledir) moduledir_list = STAILQ_HEAD_INITIALIZER(moduledir_list); 77192067Snwhitehorn 78192067Snwhitehornstruct preloaded_file *preloaded_files = NULL; 79192067Snwhitehorn 80192067Snwhitehornstatic char *kld_ext_list[] = { 81192067Snwhitehorn ".ko", 82192067Snwhitehorn "", 83192067Snwhitehorn ".debug", 84192067Snwhitehorn NULL 85212054Snwhitehorn}; 86212054Snwhitehorn 87192067Snwhitehorn 88192067Snwhitehorn/* 89192067Snwhitehorn * load an object, either a disk file or code module. 90192067Snwhitehorn * 91192067Snwhitehorn * To load a file, the syntax is: 92192067Snwhitehorn * 93192067Snwhitehorn * load -t <type> <path> 94192067Snwhitehorn * 95192067Snwhitehorn * code modules are loaded as: 96192067Snwhitehorn * 97192067Snwhitehorn * load <path> <options> 98192067Snwhitehorn */ 99192067Snwhitehorn 100192067SnwhitehornCOMMAND_SET(load, "load", "load a kernel or module", command_load); 101209908Sraj 102209908Srajstatic int 103192067Snwhitehorncommand_load(int argc, char *argv[]) 104193492Sraj{ 105193492Sraj struct preloaded_file *fp; 106193492Sraj char *typestr; 107193492Sraj int dofile, dokld, ch, error; 108193492Sraj 109193492Sraj dokld = dofile = 0; 110209908Sraj optind = 1; 111209908Sraj optreset = 1; 112209908Sraj typestr = NULL; 113209908Sraj if (argc == 1) { 114209908Sraj command_errmsg = "no filename specified"; 115209908Sraj return (CMD_CRIT); 116209908Sraj } 117209908Sraj while ((ch = getopt(argc, argv, "kt:")) != -1) { 118209908Sraj switch(ch) { 119209908Sraj case 'k': 120209908Sraj dokld = 1; 121209908Sraj break; 122209908Sraj case 't': 123209908Sraj typestr = optarg; 124209908Sraj dofile = 1; 125209908Sraj break; 126209908Sraj case '?': 127192067Snwhitehorn default: 128192067Snwhitehorn /* getopt has already reported an error */ 129192067Snwhitehorn return (CMD_OK); 130192067Snwhitehorn } 131192067Snwhitehorn } 132192067Snwhitehorn argv += (optind - 1); 133192067Snwhitehorn argc -= (optind - 1); 134192067Snwhitehorn 135192067Snwhitehorn /* 136192067Snwhitehorn * Request to load a raw file? 137209908Sraj */ 138209908Sraj if (dofile) { 139192067Snwhitehorn if ((argc != 2) || (typestr == NULL) || (*typestr == 0)) { 140209908Sraj command_errmsg = "invalid load type"; 141209908Sraj return (CMD_CRIT); 142209908Sraj } 143209908Sraj 144209908Sraj fp = file_findfile(argv[1], typestr); 145209908Sraj if (fp) { 146209908Sraj sprintf(command_errbuf, "warning: file '%s' already loaded", argv[1]); 147209908Sraj return (CMD_WARN); 148209908Sraj } 149209908Sraj 150192067Snwhitehorn if (file_loadraw(argv[1], typestr, 1) != NULL) 151192067Snwhitehorn return (CMD_OK); 152192067Snwhitehorn 153192067Snwhitehorn /* Failing to load mfs_root is never going to end well! */ 154192067Snwhitehorn if (strcmp("mfs_root", typestr) == 0) 155192067Snwhitehorn return (CMD_FATAL); 156192067Snwhitehorn 157192067Snwhitehorn return (CMD_ERROR); 158192067Snwhitehorn } 159192067Snwhitehorn /* 160192067Snwhitehorn * Do we have explicit KLD load ? 161192067Snwhitehorn */ 162192067Snwhitehorn if (dokld || file_havepath(argv[1])) { 163192067Snwhitehorn error = mod_loadkld(argv[1], argc - 2, argv + 2); 164209908Sraj if (error == EEXIST) { 165209908Sraj sprintf(command_errbuf, "warning: KLD '%s' already loaded", argv[1]); 166192067Snwhitehorn return (CMD_WARN); 167209908Sraj } 168209908Sraj 169209908Sraj return (error == 0 ? CMD_OK : CMD_CRIT); 170209908Sraj } 171209908Sraj /* 172209908Sraj * Looks like a request for a module. 173209908Sraj */ 174209908Sraj error = mod_load(argv[1], NULL, argc - 2, argv + 2); 175209908Sraj if (error == EEXIST) { 176192067Snwhitehorn sprintf(command_errbuf, "warning: module '%s' already loaded", argv[1]); 177192067Snwhitehorn return (CMD_WARN); 178192067Snwhitehorn } 179192067Snwhitehorn 180209908Sraj return (error == 0 ? CMD_OK : CMD_CRIT); 181209908Sraj} 182192067Snwhitehorn 183192067SnwhitehornCOMMAND_SET(load_geli, "load_geli", "load a geli key", command_load_geli); 184192067Snwhitehorn 185192067Snwhitehornstatic int 186192067Snwhitehorncommand_load_geli(int argc, char *argv[]) 187192067Snwhitehorn{ 188192067Snwhitehorn char typestr[80]; 189192067Snwhitehorn char *cp; 190192067Snwhitehorn int ch, num; 191192067Snwhitehorn 192192067Snwhitehorn if (argc < 3) { 193192067Snwhitehorn command_errmsg = "usage is [-n key#] <prov> <file>"; 194192067Snwhitehorn return(CMD_ERROR); 195192067Snwhitehorn } 196192067Snwhitehorn 197192067Snwhitehorn num = 0; 198192067Snwhitehorn optind = 1; 199192067Snwhitehorn optreset = 1; 200192067Snwhitehorn while ((ch = getopt(argc, argv, "n:")) != -1) { 201192067Snwhitehorn switch(ch) { 202192067Snwhitehorn case 'n': 203192067Snwhitehorn num = strtol(optarg, &cp, 0); 204192067Snwhitehorn if (cp == optarg) { 205192067Snwhitehorn sprintf(command_errbuf, "bad key index '%s'", optarg); 206193492Sraj return(CMD_ERROR); 207192067Snwhitehorn } 208192067Snwhitehorn break; 209192067Snwhitehorn case '?': 210192067Snwhitehorn default: 211192067Snwhitehorn /* getopt has already reported an error */ 212192067Snwhitehorn return(CMD_OK); 213192067Snwhitehorn } 214192067Snwhitehorn } 215192067Snwhitehorn argv += (optind - 1); 216192067Snwhitehorn argc -= (optind - 1); 217192067Snwhitehorn sprintf(typestr, "%s:geli_keyfile%d", argv[1], num); 218192067Snwhitehorn return (file_loadraw(argv[2], typestr, 1) ? CMD_OK : CMD_ERROR); 219192067Snwhitehorn} 220192067Snwhitehorn 221192067Snwhitehornvoid 222192067Snwhitehornunload(void) 223192067Snwhitehorn{ 224192067Snwhitehorn struct preloaded_file *fp; 225192067Snwhitehorn 226192067Snwhitehorn while (preloaded_files != NULL) { 227192067Snwhitehorn fp = preloaded_files; 228192067Snwhitehorn preloaded_files = preloaded_files->f_next; 229192067Snwhitehorn file_discard(fp); 230192532Sraj } 231192532Sraj loadaddr = 0; 232192532Sraj unsetenv("kernelname"); 233192067Snwhitehorn} 234192532Sraj 235192532SrajCOMMAND_SET(unload, "unload", "unload all modules", command_unload); 236192532Sraj 237192532Srajstatic int 238192532Srajcommand_unload(int argc, char *argv[]) 239192532Sraj{ 240192532Sraj unload(); 241192532Sraj return(CMD_OK); 242192532Sraj} 243192532Sraj 244192532SrajCOMMAND_SET(lsmod, "lsmod", "list loaded modules", command_lsmod); 245192532Sraj 246192532Srajstatic int 247192532Srajcommand_lsmod(int argc, char *argv[]) 248192532Sraj{ 249192532Sraj struct preloaded_file *fp; 250192532Sraj struct kernel_module *mp; 251192532Sraj struct file_metadata *md; 252192532Sraj char lbuf[80]; 253192532Sraj int ch, verbose; 254192532Sraj 255192532Sraj verbose = 0; 256192532Sraj optind = 1; 257192532Sraj optreset = 1; 258192532Sraj while ((ch = getopt(argc, argv, "v")) != -1) { 259192532Sraj switch(ch) { 260192532Sraj case 'v': 261192532Sraj verbose = 1; 262192532Sraj break; 263192067Snwhitehorn case '?': 264192067Snwhitehorn default: 265192532Sraj /* getopt has already reported an error */ 266192067Snwhitehorn return(CMD_OK); 267212054Snwhitehorn } 268212054Snwhitehorn } 269212054Snwhitehorn 270212054Snwhitehorn pager_open(); 271212054Snwhitehorn for (fp = preloaded_files; fp; fp = fp->f_next) { 272212054Snwhitehorn sprintf(lbuf, " %p: ", (void *) fp->f_addr); 273212054Snwhitehorn pager_output(lbuf); 274212054Snwhitehorn pager_output(fp->f_name); 275212054Snwhitehorn sprintf(lbuf, " (%s, 0x%lx)\n", fp->f_type, (long)fp->f_size); 276212054Snwhitehorn pager_output(lbuf); 277212054Snwhitehorn if (fp->f_args != NULL) { 278212054Snwhitehorn pager_output(" args: "); 279212054Snwhitehorn pager_output(fp->f_args); 280212054Snwhitehorn pager_output("\n"); 281212054Snwhitehorn } 282212054Snwhitehorn if (fp->f_modules) { 283212054Snwhitehorn pager_output(" modules: "); 284212054Snwhitehorn for (mp = fp->f_modules; mp; mp = mp->m_next) { 285212054Snwhitehorn sprintf(lbuf, "%s.%d ", mp->m_name, mp->m_version); 286212054Snwhitehorn pager_output(lbuf); 287212054Snwhitehorn } 288212054Snwhitehorn pager_output("\n"); 289212054Snwhitehorn } 290212054Snwhitehorn if (verbose) { 291212054Snwhitehorn /* XXX could add some formatting smarts here to display some better */ 292212054Snwhitehorn for (md = fp->f_metadata; md != NULL; md = md->md_next) { 293212054Snwhitehorn sprintf(lbuf, " 0x%04x, 0x%lx\n", md->md_type, (long) md->md_size); 294 pager_output(lbuf); 295 } 296 } 297 } 298 pager_close(); 299 return(CMD_OK); 300} 301 302/* 303 * File level interface, functions file_* 304 */ 305int 306file_load(char *filename, vm_offset_t dest, struct preloaded_file **result) 307{ 308 static int last_file_format = 0; 309 struct preloaded_file *fp; 310 int error; 311 int i; 312 313 if (archsw.arch_loadaddr != NULL) 314 dest = archsw.arch_loadaddr(LOAD_RAW, filename, dest); 315 316 error = EFTYPE; 317 for (i = last_file_format, fp = NULL; 318 file_formats[i] && fp == NULL; i++) { 319 error = (file_formats[i]->l_load)(filename, dest, &fp); 320 if (error == 0) { 321 fp->f_loader = last_file_format = i; /* remember the loader */ 322 *result = fp; 323 break; 324 } else if (last_file_format == i && i != 0) { 325 /* Restart from the beginning */ 326 i = -1; 327 last_file_format = 0; 328 fp = NULL; 329 continue; 330 } 331 if (error == EFTYPE) 332 continue; /* Unknown to this handler? */ 333 if (error) { 334 sprintf(command_errbuf, "can't load file '%s': %s", 335 filename, strerror(error)); 336 break; 337 } 338 } 339 return (error); 340} 341 342static int 343file_load_dependencies(struct preloaded_file *base_file) 344{ 345 struct file_metadata *md; 346 struct preloaded_file *fp; 347 struct mod_depend *verinfo; 348 struct kernel_module *mp; 349 char *dmodname; 350 int error; 351 352 md = file_findmetadata(base_file, MODINFOMD_DEPLIST); 353 if (md == NULL) 354 return (0); 355 error = 0; 356 do { 357 verinfo = (struct mod_depend*)md->md_data; 358 dmodname = (char *)(verinfo + 1); 359 if (file_findmodule(NULL, dmodname, verinfo) == NULL) { 360 printf("loading required module '%s'\n", dmodname); 361 error = mod_load(dmodname, verinfo, 0, NULL); 362 if (error) 363 break; 364 /* 365 * If module loaded via kld name which isn't listed 366 * in the linker.hints file, we should check if it have 367 * required version. 368 */ 369 mp = file_findmodule(NULL, dmodname, verinfo); 370 if (mp == NULL) { 371 sprintf(command_errbuf, "module '%s' exists but with wrong version", 372 dmodname); 373 error = ENOENT; 374 break; 375 } 376 } 377 md = metadata_next(md, MODINFOMD_DEPLIST); 378 } while (md); 379 if (!error) 380 return (0); 381 /* Load failed; discard everything */ 382 while (base_file != NULL) { 383 fp = base_file; 384 base_file = base_file->f_next; 385 file_discard(fp); 386 } 387 return (error); 388} 389 390/* 391 * We've been asked to load (fname) as (type), so just suck it in, 392 * no arguments or anything. 393 */ 394struct preloaded_file * 395file_loadraw(const char *fname, char *type, int insert) 396{ 397 struct preloaded_file *fp; 398 char *name; 399 int fd, got; 400 vm_offset_t laddr; 401 402 /* We can't load first */ 403 if ((file_findfile(NULL, NULL)) == NULL) { 404 command_errmsg = "can't load file before kernel"; 405 return(NULL); 406 } 407 408 /* locate the file on the load path */ 409 name = file_search(fname, NULL); 410 if (name == NULL) { 411 sprintf(command_errbuf, "can't find '%s'", fname); 412 return(NULL); 413 } 414 415 if ((fd = open(name, O_RDONLY)) < 0) { 416 sprintf(command_errbuf, "can't open '%s': %s", name, strerror(errno)); 417 free(name); 418 return(NULL); 419 } 420 421 if (archsw.arch_loadaddr != NULL) 422 loadaddr = archsw.arch_loadaddr(LOAD_RAW, name, loadaddr); 423 424 printf("%s ", name); 425 426 laddr = loadaddr; 427 for (;;) { 428 /* read in 4k chunks; size is not really important */ 429 got = archsw.arch_readin(fd, laddr, 4096); 430 if (got == 0) /* end of file */ 431 break; 432 if (got < 0) { /* error */ 433 sprintf(command_errbuf, "error reading '%s': %s", name, strerror(errno)); 434 free(name); 435 close(fd); 436 return(NULL); 437 } 438 laddr += got; 439 } 440 441 printf("size=%#jx\n", (uintmax_t)(laddr - loadaddr)); 442 443 /* Looks OK so far; create & populate control structure */ 444 fp = file_alloc(); 445 fp->f_name = strdup(name); 446 fp->f_type = strdup(type); 447 fp->f_args = NULL; 448 fp->f_metadata = NULL; 449 fp->f_loader = -1; 450 fp->f_addr = loadaddr; 451 fp->f_size = laddr - loadaddr; 452 453 /* recognise space consumption */ 454 loadaddr = laddr; 455 456 /* Add to the list of loaded files */ 457 if (insert != 0) 458 file_insert_tail(fp); 459 close(fd); 460 return(fp); 461} 462 463/* 464 * Load the module (name), pass it (argc),(argv), add container file 465 * to the list of loaded files. 466 * If module is already loaded just assign new argc/argv. 467 */ 468int 469mod_load(char *modname, struct mod_depend *verinfo, int argc, char *argv[]) 470{ 471 struct kernel_module *mp; 472 int err; 473 char *filename; 474 475 if (file_havepath(modname)) { 476 printf("Warning: mod_load() called instead of mod_loadkld() for module '%s'\n", modname); 477 return (mod_loadkld(modname, argc, argv)); 478 } 479 /* see if module is already loaded */ 480 mp = file_findmodule(NULL, modname, verinfo); 481 if (mp) { 482#ifdef moduleargs 483 if (mp->m_args) 484 free(mp->m_args); 485 mp->m_args = unargv(argc, argv); 486#endif 487 sprintf(command_errbuf, "warning: module '%s' already loaded", mp->m_name); 488 return (0); 489 } 490 /* locate file with the module on the search path */ 491 filename = mod_searchmodule(modname, verinfo); 492 if (filename == NULL) { 493 sprintf(command_errbuf, "can't find '%s'", modname); 494 return (ENOENT); 495 } 496 err = mod_loadkld(filename, argc, argv); 497 return (err); 498} 499 500/* 501 * Load specified KLD. If path is omitted, then try to locate it via 502 * search path. 503 */ 504int 505mod_loadkld(const char *kldname, int argc, char *argv[]) 506{ 507 struct preloaded_file *fp, *last_file; 508 int err; 509 char *filename; 510 511 /* 512 * Get fully qualified KLD name 513 */ 514 filename = file_search(kldname, kld_ext_list); 515 if (filename == NULL) { 516 sprintf(command_errbuf, "can't find '%s'", kldname); 517 return (ENOENT); 518 } 519 /* 520 * Check if KLD already loaded 521 */ 522 fp = file_findfile(filename, NULL); 523 if (fp) { 524 sprintf(command_errbuf, "warning: KLD '%s' already loaded", filename); 525 free(filename); 526 return (0); 527 } 528 for (last_file = preloaded_files; 529 last_file != NULL && last_file->f_next != NULL; 530 last_file = last_file->f_next) 531 ; 532 533 do { 534 err = file_load(filename, loadaddr, &fp); 535 if (err) 536 break; 537 fp->f_args = unargv(argc, argv); 538 loadaddr = fp->f_addr + fp->f_size; 539 file_insert_tail(fp); /* Add to the list of loaded files */ 540 if (file_load_dependencies(fp) != 0) { 541 err = ENOENT; 542 last_file->f_next = NULL; 543 loadaddr = last_file->f_addr + last_file->f_size; 544 fp = NULL; 545 break; 546 } 547 } while(0); 548 if (err == EFTYPE) 549 sprintf(command_errbuf, "don't know how to load module '%s'", filename); 550 if (err && fp) 551 file_discard(fp); 552 free(filename); 553 return (err); 554} 555 556/* 557 * Find a file matching (name) and (type). 558 * NULL may be passed as a wildcard to either. 559 */ 560struct preloaded_file * 561file_findfile(const char *name, const char *type) 562{ 563 struct preloaded_file *fp; 564 565 for (fp = preloaded_files; fp != NULL; fp = fp->f_next) { 566 if (((name == NULL) || !strcmp(name, fp->f_name)) && 567 ((type == NULL) || !strcmp(type, fp->f_type))) 568 break; 569 } 570 return (fp); 571} 572 573/* 574 * Find a module matching (name) inside of given file. 575 * NULL may be passed as a wildcard. 576 */ 577struct kernel_module * 578file_findmodule(struct preloaded_file *fp, char *modname, 579 struct mod_depend *verinfo) 580{ 581 struct kernel_module *mp, *best; 582 int bestver, mver; 583 584 if (fp == NULL) { 585 for (fp = preloaded_files; fp; fp = fp->f_next) { 586 mp = file_findmodule(fp, modname, verinfo); 587 if (mp) 588 return (mp); 589 } 590 return (NULL); 591 } 592 best = NULL; 593 bestver = 0; 594 for (mp = fp->f_modules; mp; mp = mp->m_next) { 595 if (strcmp(modname, mp->m_name) == 0) { 596 if (verinfo == NULL) 597 return (mp); 598 mver = mp->m_version; 599 if (mver == verinfo->md_ver_preferred) 600 return (mp); 601 if (mver >= verinfo->md_ver_minimum && 602 mver <= verinfo->md_ver_maximum && 603 mver > bestver) { 604 best = mp; 605 bestver = mver; 606 } 607 } 608 } 609 return (best); 610} 611/* 612 * Make a copy of (size) bytes of data from (p), and associate them as 613 * metadata of (type) to the module (mp). 614 */ 615void 616file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p) 617{ 618 struct file_metadata *md; 619 620 md = malloc(sizeof(struct file_metadata) - sizeof(md->md_data) + size); 621 md->md_size = size; 622 md->md_type = type; 623 bcopy(p, md->md_data, size); 624 md->md_next = fp->f_metadata; 625 fp->f_metadata = md; 626} 627 628/* 629 * Find a metadata object of (type) associated with the file (fp) 630 */ 631struct file_metadata * 632file_findmetadata(struct preloaded_file *fp, int type) 633{ 634 struct file_metadata *md; 635 636 for (md = fp->f_metadata; md != NULL; md = md->md_next) 637 if (md->md_type == type) 638 break; 639 return(md); 640} 641 642struct file_metadata * 643metadata_next(struct file_metadata *md, int type) 644{ 645 if (md == NULL) 646 return (NULL); 647 while((md = md->md_next) != NULL) 648 if (md->md_type == type) 649 break; 650 return (md); 651} 652 653static char *emptyextlist[] = { "", NULL }; 654 655/* 656 * Check if the given file is in place and return full path to it. 657 */ 658static char * 659file_lookup(const char *path, const char *name, int namelen, char **extlist) 660{ 661 struct stat st; 662 char *result, *cp, **cpp; 663 int pathlen, extlen, len; 664 665 pathlen = strlen(path); 666 extlen = 0; 667 if (extlist == NULL) 668 extlist = emptyextlist; 669 for (cpp = extlist; *cpp; cpp++) { 670 len = strlen(*cpp); 671 if (len > extlen) 672 extlen = len; 673 } 674 result = malloc(pathlen + namelen + extlen + 2); 675 if (result == NULL) 676 return (NULL); 677 bcopy(path, result, pathlen); 678 if (pathlen > 0 && result[pathlen - 1] != '/') 679 result[pathlen++] = '/'; 680 cp = result + pathlen; 681 bcopy(name, cp, namelen); 682 cp += namelen; 683 for (cpp = extlist; *cpp; cpp++) { 684 strcpy(cp, *cpp); 685 if (stat(result, &st) == 0 && S_ISREG(st.st_mode)) 686 return result; 687 } 688 free(result); 689 return NULL; 690} 691 692/* 693 * Check if file name have any qualifiers 694 */ 695static int 696file_havepath(const char *name) 697{ 698 const char *cp; 699 700 archsw.arch_getdev(NULL, name, &cp); 701 return (cp != name || strchr(name, '/') != NULL); 702} 703 704/* 705 * Attempt to find the file (name) on the module searchpath. 706 * If (name) is qualified in any way, we simply check it and 707 * return it or NULL. If it is not qualified, then we attempt 708 * to construct a path using entries in the environment variable 709 * module_path. 710 * 711 * The path we return a pointer to need never be freed, as we manage 712 * it internally. 713 */ 714static char * 715file_search(const char *name, char **extlist) 716{ 717 struct moduledir *mdp; 718 struct stat sb; 719 char *result; 720 int namelen; 721 722 /* Don't look for nothing */ 723 if (name == NULL) 724 return(NULL); 725 726 if (*name == 0) 727 return(strdup(name)); 728 729 if (file_havepath(name)) { 730 /* Qualified, so just see if it exists */ 731 if (stat(name, &sb) == 0) 732 return(strdup(name)); 733 return(NULL); 734 } 735 moduledir_rebuild(); 736 result = NULL; 737 namelen = strlen(name); 738 STAILQ_FOREACH(mdp, &moduledir_list, d_link) { 739 result = file_lookup(mdp->d_path, name, namelen, extlist); 740 if (result) 741 break; 742 } 743 return(result); 744} 745 746#define INT_ALIGN(base, ptr) ptr = \ 747 (base) + (((ptr) - (base) + sizeof(int) - 1) & ~(sizeof(int) - 1)) 748 749static char * 750mod_search_hints(struct moduledir *mdp, const char *modname, 751 struct mod_depend *verinfo) 752{ 753 u_char *cp, *recptr, *bufend, *best; 754 char *result; 755 int *intp, bestver, blen, clen, found, ival, modnamelen, reclen; 756 757 moduledir_readhints(mdp); 758 modnamelen = strlen(modname); 759 found = 0; 760 result = NULL; 761 bestver = 0; 762 if (mdp->d_hints == NULL) 763 goto bad; 764 recptr = mdp->d_hints; 765 bufend = recptr + mdp->d_hintsz; 766 clen = blen = 0; 767 best = cp = NULL; 768 while (recptr < bufend && !found) { 769 intp = (int*)recptr; 770 reclen = *intp++; 771 ival = *intp++; 772 cp = (char*)intp; 773 switch (ival) { 774 case MDT_VERSION: 775 clen = *cp++; 776 if (clen != modnamelen || bcmp(cp, modname, clen) != 0) 777 break; 778 cp += clen; 779 INT_ALIGN(mdp->d_hints, cp); 780 ival = *(int*)cp; 781 cp += sizeof(int); 782 clen = *cp++; 783 if (verinfo == NULL || ival == verinfo->md_ver_preferred) { 784 found = 1; 785 break; 786 } 787 if (ival >= verinfo->md_ver_minimum && 788 ival <= verinfo->md_ver_maximum && 789 ival > bestver) { 790 bestver = ival; 791 best = cp; 792 blen = clen; 793 } 794 break; 795 default: 796 break; 797 } 798 recptr += reclen + sizeof(int); 799 } 800 /* 801 * Finally check if KLD is in the place 802 */ 803 if (found) 804 result = file_lookup(mdp->d_path, cp, clen, NULL); 805 else if (best) 806 result = file_lookup(mdp->d_path, best, blen, NULL); 807bad: 808 /* 809 * If nothing found or hints is absent - fallback to the old way 810 * by using "kldname[.ko]" as module name. 811 */ 812 if (!found && !bestver && result == NULL) 813 result = file_lookup(mdp->d_path, modname, modnamelen, kld_ext_list); 814 return result; 815} 816 817/* 818 * Attempt to locate the file containing the module (name) 819 */ 820static char * 821mod_searchmodule(char *name, struct mod_depend *verinfo) 822{ 823 struct moduledir *mdp; 824 char *result; 825 826 moduledir_rebuild(); 827 /* 828 * Now we ready to lookup module in the given directories 829 */ 830 result = NULL; 831 STAILQ_FOREACH(mdp, &moduledir_list, d_link) { 832 result = mod_search_hints(mdp, name, verinfo); 833 if (result) 834 break; 835 } 836 837 return(result); 838} 839 840int 841file_addmodule(struct preloaded_file *fp, char *modname, int version, 842 struct kernel_module **newmp) 843{ 844 struct kernel_module *mp; 845 struct mod_depend mdepend; 846 847 bzero(&mdepend, sizeof(mdepend)); 848 mdepend.md_ver_preferred = version; 849 mp = file_findmodule(fp, modname, &mdepend); 850 if (mp) 851 return (EEXIST); 852 mp = malloc(sizeof(struct kernel_module)); 853 if (mp == NULL) 854 return (ENOMEM); 855 bzero(mp, sizeof(struct kernel_module)); 856 mp->m_name = strdup(modname); 857 mp->m_version = version; 858 mp->m_fp = fp; 859 mp->m_next = fp->f_modules; 860 fp->f_modules = mp; 861 if (newmp) 862 *newmp = mp; 863 return (0); 864} 865 866/* 867 * Throw a file away 868 */ 869void 870file_discard(struct preloaded_file *fp) 871{ 872 struct file_metadata *md, *md1; 873 struct kernel_module *mp, *mp1; 874 if (fp == NULL) 875 return; 876 md = fp->f_metadata; 877 while (md) { 878 md1 = md; 879 md = md->md_next; 880 free(md1); 881 } 882 mp = fp->f_modules; 883 while (mp) { 884 if (mp->m_name) 885 free(mp->m_name); 886 mp1 = mp; 887 mp = mp->m_next; 888 free(mp1); 889 } 890 if (fp->f_name != NULL) 891 free(fp->f_name); 892 if (fp->f_type != NULL) 893 free(fp->f_type); 894 if (fp->f_args != NULL) 895 free(fp->f_args); 896 free(fp); 897} 898 899/* 900 * Allocate a new file; must be used instead of malloc() 901 * to ensure safe initialisation. 902 */ 903struct preloaded_file * 904file_alloc(void) 905{ 906 struct preloaded_file *fp; 907 908 if ((fp = malloc(sizeof(struct preloaded_file))) != NULL) { 909 bzero(fp, sizeof(struct preloaded_file)); 910 } 911 return (fp); 912} 913 914/* 915 * Add a module to the chain 916 */ 917static void 918file_insert_tail(struct preloaded_file *fp) 919{ 920 struct preloaded_file *cm; 921 922 /* Append to list of loaded file */ 923 fp->f_next = NULL; 924 if (preloaded_files == NULL) { 925 preloaded_files = fp; 926 } else { 927 for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next) 928 ; 929 cm->f_next = fp; 930 } 931} 932 933static char * 934moduledir_fullpath(struct moduledir *mdp, const char *fname) 935{ 936 char *cp; 937 938 cp = malloc(strlen(mdp->d_path) + strlen(fname) + 2); 939 if (cp == NULL) 940 return NULL; 941 strcpy(cp, mdp->d_path); 942 strcat(cp, "/"); 943 strcat(cp, fname); 944 return (cp); 945} 946 947/* 948 * Read linker.hints file into memory performing some sanity checks. 949 */ 950static void 951moduledir_readhints(struct moduledir *mdp) 952{ 953 struct stat st; 954 char *path; 955 int fd, size, version; 956 957 if (mdp->d_hints != NULL || (mdp->d_flags & MDIR_NOHINTS)) 958 return; 959 path = moduledir_fullpath(mdp, "linker.hints"); 960 if (stat(path, &st) != 0 || 961 st.st_size < (ssize_t)(sizeof(version) + sizeof(int)) || 962 st.st_size > LINKER_HINTS_MAX || (fd = open(path, O_RDONLY)) < 0) { 963 free(path); 964 mdp->d_flags |= MDIR_NOHINTS; 965 return; 966 } 967 free(path); 968 size = read(fd, &version, sizeof(version)); 969 if (size != sizeof(version) || version != LINKER_HINTS_VERSION) 970 goto bad; 971 size = st.st_size - size; 972 mdp->d_hints = malloc(size); 973 if (mdp->d_hints == NULL) 974 goto bad; 975 if (read(fd, mdp->d_hints, size) != size) 976 goto bad; 977 mdp->d_hintsz = size; 978 close(fd); 979 return; 980bad: 981 close(fd); 982 if (mdp->d_hints) { 983 free(mdp->d_hints); 984 mdp->d_hints = NULL; 985 } 986 mdp->d_flags |= MDIR_NOHINTS; 987 return; 988} 989 990/* 991 * Extract directories from the ';' separated list, remove duplicates. 992 */ 993static void 994moduledir_rebuild(void) 995{ 996 struct moduledir *mdp, *mtmp; 997 const char *path, *cp, *ep; 998 size_t cplen; 999 1000 path = getenv("module_path"); 1001 if (path == NULL) 1002 path = default_searchpath; 1003 /* 1004 * Rebuild list of module directories if it changed 1005 */ 1006 STAILQ_FOREACH(mdp, &moduledir_list, d_link) 1007 mdp->d_flags |= MDIR_REMOVED; 1008 1009 for (ep = path; *ep != 0; ep++) { 1010 cp = ep; 1011 for (; *ep != 0 && *ep != ';'; ep++) 1012 ; 1013 /* 1014 * Ignore trailing slashes 1015 */ 1016 for (cplen = ep - cp; cplen > 1 && cp[cplen - 1] == '/'; cplen--) 1017 ; 1018 STAILQ_FOREACH(mdp, &moduledir_list, d_link) { 1019 if (strlen(mdp->d_path) != cplen || bcmp(cp, mdp->d_path, cplen) != 0) 1020 continue; 1021 mdp->d_flags &= ~MDIR_REMOVED; 1022 break; 1023 } 1024 if (mdp == NULL) { 1025 mdp = malloc(sizeof(*mdp) + cplen + 1); 1026 if (mdp == NULL) 1027 return; 1028 mdp->d_path = (char*)(mdp + 1); 1029 bcopy(cp, mdp->d_path, cplen); 1030 mdp->d_path[cplen] = 0; 1031 mdp->d_hints = NULL; 1032 mdp->d_flags = 0; 1033 STAILQ_INSERT_TAIL(&moduledir_list, mdp, d_link); 1034 } 1035 if (*ep == 0) 1036 break; 1037 } 1038 /* 1039 * Delete unused directories if any 1040 */ 1041 mdp = STAILQ_FIRST(&moduledir_list); 1042 while (mdp) { 1043 if ((mdp->d_flags & MDIR_REMOVED) == 0) { 1044 mdp = STAILQ_NEXT(mdp, d_link); 1045 } else { 1046 if (mdp->d_hints) 1047 free(mdp->d_hints); 1048 mtmp = mdp; 1049 mdp = STAILQ_NEXT(mdp, d_link); 1050 STAILQ_REMOVE(&moduledir_list, mtmp, moduledir, d_link); 1051 free(mtmp); 1052 } 1053 } 1054 return; 1055} 1056