stand/common/module.c

   1 /*-
   2  * Copyright (c) 1998 Michael Smith <msmith@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 AUTHOR 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 AUTHOR 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 /*
  31  * file/module function dispatcher, support, etc.
  32  */
  33
  34 #include <stand.h>
  35 #include <string.h>
  36 #include <sys/param.h>
  37 #include <sys/linker.h>
  38 #include <sys/module.h>
  39 #include <sys/queue.h>
  40 #include <sys/stdint.h>
  41
  42 #include "bootstrap.h"
  43
  44 #define MDIR_REMOVED    0x0001
  45 #define MDIR_NOHINTS    0x0002
  46
  47 struct moduledir {
  48         char    *d_path;        /* path of modules directory */
  49         u_char  *d_hints;       /* content of linker.hints file */
  50         int     d_hintsz;       /* size of hints data */
  51         int     d_flags;
  52         STAILQ_ENTRY(moduledir) d_link;
  53 };
  54
  55 static int                      file_load(char *filename, vm_offset_t dest, struct preloaded_file **result);
  56 static int                      file_load_dependencies(struct preloaded_file *base_mod);
  57 static char *                   file_search(const char *name, char **extlist);
  58 static struct kernel_module *   file_findmodule(struct preloaded_file *fp, char *modname, struct mod_depend *verinfo);
  59 static int                      file_havepath(const char *name);
  60 static char                     *mod_searchmodule(char *name, struct mod_depend *verinfo);
  61 static void                     file_insert_tail(struct preloaded_file *mp);
  62 struct file_metadata*           metadata_next(struct file_metadata *base_mp, int type);
  63 static void                     moduledir_readhints(struct moduledir *mdp);
  64 static void                     moduledir_rebuild(void);
  65
  66 /* load address should be tweaked by first module loaded (kernel) */
  67 static vm_offset_t      loadaddr = 0;
  68
  69 #if defined(LOADER_FDT_SUPPORT)
  70 static const char       *default_searchpath =
  71     "/boot/kernel;/boot/modules;/boot/dtb";
  72 #else
  73 static const char       *default_searchpath ="/boot/kernel;/boot/modules";
  74 #endif
  75
  76 static STAILQ_HEAD(, moduledir) moduledir_list = STAILQ_HEAD_INITIALIZER(moduledir_list);
  77
  78 struct preloaded_file *preloaded_files = NULL;
  79
  80 static char *kld_ext_list[] = {
  81     ".ko",
  82     "",
  83     ".debug",
  84     NULL
  85 };
  86
  87
  88 /*
  89  * load an object, either a disk file or code module.
  90  *
  91  * To load a file, the syntax is:
  92  *
  93  * load -t <type> <path>
  94  *
  95  * code modules are loaded as:
  96  *
  97  * load <path> <options>
  98  */
  99
 100 COMMAND_SET(load, "load", "load a kernel or module", command_load);
 101
 102 static int
 103 command_load(int argc, char *argv[])
 104 {
 105         struct preloaded_file *fp;
 106         char    *typestr;
 107         char    *prefix;
 108         char    *skip;
 109         int             dflag, dofile, dokld, ch, error;
 110
 111         dflag = dokld = dofile = 0;
 112         optind = 1;
 113         optreset = 1;
 114         typestr = NULL;
 115         if (argc == 1) {
 116                 command_errmsg = "no filename specified";
 117                 return (CMD_CRIT);
 118         }
 119         prefix = skip = NULL;
 120         while ((ch = getopt(argc, argv, "dkp:s:t:")) != -1) {
 121                 switch(ch) {
 122                 case 'd':
 123                         dflag++;
 124                         break;
 125                 case 'k':
 126                         dokld = 1;
 127                         break;
 128                 case 'p':
 129                         prefix = optarg;
 130                         break;
 131                 case 's':
 132                         skip = optarg;
 133                         break;
 134                 case 't':
 135                         typestr = optarg;
 136                         dofile = 1;
 137                         break;
 138                 case '?':
 139                 default:
 140                         /* getopt has already reported an error */
 141                         return (CMD_OK);
 142                 }
 143         }
 144         argv += (optind - 1);
 145         argc -= (optind - 1);
 146
 147         /*
 148          * Request to load a raw file?
 149          */
 150         if (dofile) {
 151                 if ((argc != 2) || (typestr == NULL) || (*typestr == 0)) {
 152                         command_errmsg = "invalid load type";
 153                         return (CMD_CRIT);
 154                 }
 155
 156 #ifdef LOADER_VERIEXEC
 157                 if (strncmp(typestr, "manifest", 8) == 0) {
 158                         if (dflag > 0)
 159                                 ve_debug_set(dflag);
 160                         return (load_manifest(argv[1], prefix, skip, NULL));
 161                 }
 162 #ifdef LOADER_VERIEXEC_PASS_MANIFEST
 163                 if (strncmp(typestr, "pass_manifest", 13) == 0) {
 164                         if (dflag > 0)
 165                                 ve_debug_set(dflag);
 166                     return (pass_manifest(argv[1], prefix));
 167                 }
 168 #endif
 169 #endif
 170
 171                 fp = file_findfile(argv[1], typestr);
 172                 if (fp) {
 173                         snprintf(command_errbuf, sizeof(command_errbuf),
 174                           "warning: file '%s' already loaded", argv[1]);
 175                         return (CMD_WARN);
 176                 }
 177
 178                 if (file_loadraw(argv[1], typestr, 1) != NULL)
 179                         return (CMD_OK);
 180
 181                 /* Failing to load mfs_root is never going to end well! */
 182                 if (strcmp("mfs_root", typestr) == 0)
 183                         return (CMD_FATAL);
 184
 185                 return (CMD_ERROR);
 186         }
 187         /*
 188          * Do we have explicit KLD load ?
 189          */
 190         if (dokld || file_havepath(argv[1])) {
 191                 error = mod_loadkld(argv[1], argc - 2, argv + 2);
 192                 if (error == EEXIST) {
 193                         snprintf(command_errbuf, sizeof(command_errbuf),
 194                           "warning: KLD '%s' already loaded", argv[1]);
 195                         return (CMD_WARN);
 196                 }
 197
 198                 return (error == 0 ? CMD_OK : CMD_CRIT);
 199         }
 200         /*
 201          * Looks like a request for a module.
 202          */
 203         error = mod_load(argv[1], NULL, argc - 2, argv + 2);
 204         if (error == EEXIST) {
 205                 snprintf(command_errbuf, sizeof(command_errbuf),
 206                   "warning: module '%s' already loaded", argv[1]);
 207                 return (CMD_WARN);
 208         }
 209
 210         return (error == 0 ? CMD_OK : CMD_CRIT);
 211 }
 212
 213 #ifdef LOADER_GELI_SUPPORT
 214 COMMAND_SET(load_geli, "load_geli", "load a geli key", command_load_geli);
 215
 216 static int
 217 command_load_geli(int argc, char *argv[])
 218 {
 219         char    typestr[80];
 220         char    *cp;
 221         int             ch, num;
 222
 223         if (argc < 3) {
 224                 command_errmsg = "usage is [-n key#] <prov> <file>";
 225                 return(CMD_ERROR);
 226         }
 227
 228         num = 0;
 229         optind = 1;
 230         optreset = 1;
 231         while ((ch = getopt(argc, argv, "n:")) != -1) {
 232                 switch(ch) {
 233                 case 'n':
 234                         num = strtol(optarg, &cp, 0);
 235                         if (cp == optarg) {
 236                                 snprintf(command_errbuf, sizeof(command_errbuf),
 237                                   "bad key index '%s'", optarg);
 238                                 return(CMD_ERROR);
 239                         }
 240                         break;
 241                 case '?':
 242                 default:
 243                         /* getopt has already reported an error */
 244                         return(CMD_OK);
 245                 }
 246         }
 247         argv += (optind - 1);
 248         argc -= (optind - 1);
 249         sprintf(typestr, "%s:geli_keyfile%d", argv[1], num);
 250         return (file_loadraw(argv[2], typestr, 1) ? CMD_OK : CMD_ERROR);
 251 }
 252 #endif
 253
 254 void
 255 unload(void)
 256 {
 257         struct preloaded_file *fp;
 258
 259         while (preloaded_files != NULL) {
 260                 fp = preloaded_files;
 261                 preloaded_files = preloaded_files->f_next;
 262                 file_discard(fp);
 263         }
 264         loadaddr = 0;
 265         unsetenv("kernelname");
 266 }
 267
 268 COMMAND_SET(unload, "unload", "unload all modules", command_unload);
 269
 270 static int
 271 command_unload(int argc, char *argv[])
 272 {
 273         unload();
 274         return(CMD_OK);
 275 }
 276
 277 COMMAND_SET(lsmod, "lsmod", "list loaded modules", command_lsmod);
 278
 279 static int
 280 command_lsmod(int argc, char *argv[])
 281 {
 282         struct preloaded_file   *fp;
 283         struct kernel_module    *mp;
 284         struct file_metadata    *md;
 285         char                    lbuf[80];
 286         int                             ch, verbose, ret = 0;
 287
 288         verbose = 0;
 289         optind = 1;
 290         optreset = 1;
 291         while ((ch = getopt(argc, argv, "v")) != -1) {
 292                 switch(ch) {
 293                 case 'v':
 294                         verbose = 1;
 295                         break;
 296                 case '?':
 297                 default:
 298                         /* getopt has already reported an error */
 299                         return(CMD_OK);
 300                 }
 301         }
 302
 303         pager_open();
 304         for (fp = preloaded_files; fp; fp = fp->f_next) {
 305                 snprintf(lbuf, sizeof(lbuf), " %p: ", (void *) fp->f_addr);
 306                 pager_output(lbuf);
 307                 pager_output(fp->f_name);
 308                 snprintf(lbuf, sizeof(lbuf), " (%s, 0x%lx)\n", fp->f_type,
 309                   (long)fp->f_size);
 310                 if (pager_output(lbuf))
 311                         break;
 312                 if (fp->f_args != NULL) {
 313                         pager_output("    args: ");
 314                         pager_output(fp->f_args);
 315                         if (pager_output("\n"))
 316                                 break;
 317                 }
 318                 if (fp->f_modules) {
 319                         pager_output("  modules: ");
 320                         for (mp = fp->f_modules; mp; mp = mp->m_next) {
 321                                 snprintf(lbuf, sizeof(lbuf), "%s.%d ", mp->m_name,
 322                                   mp->m_version);
 323                                 pager_output(lbuf);
 324                         }
 325                         if (pager_output("\n"))
 326                                 break;
 327                 }
 328                 if (verbose) {
 329                         /* XXX could add some formatting smarts here to display some better */
 330                         for (md = fp->f_metadata; md != NULL; md = md->md_next) {
 331                                 snprintf(lbuf, sizeof(lbuf), "      0x%04x, 0x%lx\n",
 332                                   md->md_type, (long) md->md_size);
 333                                 if (pager_output(lbuf))
 334                                         break;
 335                         }
 336                 }
 337                 if (ret)
 338                         break;
 339         }
 340         pager_close();
 341         return(CMD_OK);
 342 }
 343
 344 /*
 345  * File level interface, functions file_*
 346  */
 347 int
 348 file_load(char *filename, vm_offset_t dest, struct preloaded_file **result)
 349 {
 350         static int last_file_format = 0;
 351         struct preloaded_file *fp;
 352         int error;
 353         int i;
 354
 355         if (archsw.arch_loadaddr != NULL)
 356                 dest = archsw.arch_loadaddr(LOAD_RAW, filename, dest);
 357
 358         error = EFTYPE;
 359         for (i = last_file_format, fp = NULL;
 360              file_formats[i] && fp == NULL; i++) {
 361                 error = (file_formats[i]->l_load)(filename, dest, &fp);
 362                 if (error == 0) {
 363                         fp->f_loader = last_file_format = i; /* remember the loader */
 364                         *result = fp;
 365                         break;
 366                 } else if (last_file_format == i && i != 0) {
 367                         /* Restart from the beginning */
 368                         i = -1;
 369                         last_file_format = 0;
 370                         fp = NULL;
 371                         continue;
 372                 }
 373                 if (error == EFTYPE)
 374                         continue;               /* Unknown to this handler? */
 375                 if (error) {
 376                         snprintf(command_errbuf, sizeof(command_errbuf),
 377                           "can't load file '%s': %s", filename, strerror(error));
 378                         break;
 379                 }
 380         }
 381         return (error);
 382 }
 383
 384 static int
 385 file_load_dependencies(struct preloaded_file *base_file)
 386 {
 387         struct file_metadata *md;
 388         struct preloaded_file *fp;
 389         struct mod_depend *verinfo;
 390         struct kernel_module *mp;
 391         char *dmodname;
 392         int error;
 393
 394         md = file_findmetadata(base_file, MODINFOMD_DEPLIST);
 395         if (md == NULL)
 396                 return (0);
 397         error = 0;
 398         do {
 399                 verinfo = (struct mod_depend*)md->md_data;
 400                 dmodname = (char *)(verinfo + 1);
 401                 if (file_findmodule(NULL, dmodname, verinfo) == NULL) {
 402                         printf("loading required module '%s'\n", dmodname);
 403                         error = mod_load(dmodname, verinfo, 0, NULL);
 404                         if (error)
 405                                 break;
 406                         /*
 407                          * If module loaded via kld name which isn't listed
 408                          * in the linker.hints file, we should check if it have
 409                          * required version.
 410                          */
 411                         mp = file_findmodule(NULL, dmodname, verinfo);
 412                         if (mp == NULL) {
 413                                 snprintf(command_errbuf, sizeof(command_errbuf),
 414                                   "module '%s' exists but with wrong version", dmodname);
 415                                 error = ENOENT;
 416                                 break;
 417                         }
 418                 }
 419                 md = metadata_next(md, MODINFOMD_DEPLIST);
 420         } while (md);
 421         if (!error)
 422                 return (0);
 423         /* Load failed; discard everything */
 424         while (base_file != NULL) {
 425                 fp = base_file;
 426                 base_file = base_file->f_next;
 427                 file_discard(fp);
 428         }
 429         return (error);
 430 }
 431
 432 /*
 433  * We've been asked to load (fname) as (type), so just suck it in,
 434  * no arguments or anything.
 435  */
 436 struct preloaded_file *
 437 file_loadraw(const char *fname, char *type, int insert)
 438 {
 439         struct preloaded_file   *fp;
 440         char                    *name;
 441         int                             fd, got;
 442         vm_offset_t                     laddr;
 443
 444         /* We can't load first */
 445         if ((file_findfile(NULL, NULL)) == NULL) {
 446                 command_errmsg = "can't load file before kernel";
 447                 return(NULL);
 448         }
 449
 450         /* locate the file on the load path */
 451         name = file_search(fname, NULL);
 452         if (name == NULL) {
 453                 snprintf(command_errbuf, sizeof(command_errbuf),
 454                   "can't find '%s'", fname);
 455                 return(NULL);
 456         }
 457
 458         if ((fd = open(name, O_RDONLY)) < 0) {
 459                 snprintf(command_errbuf, sizeof(command_errbuf),
 460                   "can't open '%s': %s", name, strerror(errno));
 461                 free(name);
 462                 return(NULL);
 463         }
 464
 465 #ifdef LOADER_VERIEXEC
 466         if (verify_file(fd, name, 0, VE_MUST) < 0) {
 467                 sprintf(command_errbuf, "can't verify '%s'", name);
 468                 free(name);
 469                 close(fd);
 470                 return(NULL);
 471         }
 472 #endif
 473
 474         if (archsw.arch_loadaddr != NULL)
 475                 loadaddr = archsw.arch_loadaddr(LOAD_RAW, name, loadaddr);
 476
 477         printf("%s ", name);
 478
 479         laddr = loadaddr;
 480         for (;;) {
 481                 /* read in 4k chunks; size is not really important */
 482                 got = archsw.arch_readin(fd, laddr, 4096);
 483                 if (got == 0)                           /* end of file */
 484                         break;
 485                 if (got < 0) {                          /* error */
 486                         snprintf(command_errbuf, sizeof(command_errbuf),
 487                           "error reading '%s': %s", name, strerror(errno));
 488                         free(name);
 489                         close(fd);
 490                         return(NULL);
 491                 }
 492                 laddr += got;
 493         }
 494
 495         printf("size=%#jx\n", (uintmax_t)(laddr - loadaddr));
 496
 497         /* Looks OK so far; create & populate control structure */
 498         fp = file_alloc();
 499         fp->f_name = strdup(name);
 500         fp->f_type = strdup(type);
 501         fp->f_args = NULL;
 502         fp->f_metadata = NULL;
 503         fp->f_loader = -1;
 504         fp->f_addr = loadaddr;
 505         fp->f_size = laddr - loadaddr;
 506
 507         /* recognise space consumption */
 508         loadaddr = laddr;
 509
 510         /* Add to the list of loaded files */
 511         if (insert != 0)
 512                 file_insert_tail(fp);
 513         close(fd);
 514         return(fp);
 515 }
 516
 517 /*
 518  * Load the module (name), pass it (argc),(argv), add container file
 519  * to the list of loaded files.
 520  * If module is already loaded just assign new argc/argv.
 521  */
 522 int
 523 mod_load(char *modname, struct mod_depend *verinfo, int argc, char *argv[])
 524 {
 525         struct kernel_module    *mp;
 526         int                             err;
 527         char                    *filename;
 528
 529         if (file_havepath(modname)) {
 530                 printf("Warning: mod_load() called instead of mod_loadkld() for module '%s'\n", modname);
 531                 return (mod_loadkld(modname, argc, argv));
 532         }
 533         /* see if module is already loaded */
 534         mp = file_findmodule(NULL, modname, verinfo);
 535         if (mp) {
 536 #ifdef moduleargs
 537                 free(mp->m_args);
 538                 mp->m_args = unargv(argc, argv);
 539 #endif
 540                 snprintf(command_errbuf, sizeof(command_errbuf),
 541                   "warning: module '%s' already loaded", mp->m_name);
 542                 return (0);
 543         }
 544         /* locate file with the module on the search path */
 545         filename = mod_searchmodule(modname, verinfo);
 546         if (filename == NULL) {
 547                 snprintf(command_errbuf, sizeof(command_errbuf),
 548                   "can't find '%s'", modname);
 549                 return (ENOENT);
 550         }
 551         err = mod_loadkld(filename, argc, argv);
 552         return (err);
 553 }
 554
 555 /*
 556  * Load specified KLD. If path is omitted, then try to locate it via
 557  * search path.
 558  */
 559 int
 560 mod_loadkld(const char *kldname, int argc, char *argv[])
 561 {
 562         struct preloaded_file   *fp, *last_file;
 563         int                             err;
 564         char                    *filename;
 565
 566         /*
 567          * Get fully qualified KLD name
 568          */
 569         filename = file_search(kldname, kld_ext_list);
 570         if (filename == NULL) {
 571                 snprintf(command_errbuf, sizeof(command_errbuf),
 572                   "can't find '%s'", kldname);
 573                 return (ENOENT);
 574         }
 575         /*
 576          * Check if KLD already loaded
 577          */
 578         fp = file_findfile(filename, NULL);
 579         if (fp) {
 580                 snprintf(command_errbuf, sizeof(command_errbuf),
 581                   "warning: KLD '%s' already loaded", filename);
 582                 free(filename);
 583                 return (0);
 584         }
 585         for (last_file = preloaded_files;
 586              last_file != NULL && last_file->f_next != NULL;
 587              last_file = last_file->f_next)
 588                 ;
 589
 590         do {
 591                 err = file_load(filename, loadaddr, &fp);
 592                 if (err)
 593                         break;
 594                 fp->f_args = unargv(argc, argv);
 595                 loadaddr = fp->f_addr + fp->f_size;
 596                 file_insert_tail(fp);           /* Add to the list of loaded files */
 597                 if (file_load_dependencies(fp) != 0) {
 598                         err = ENOENT;
 599                         last_file->f_next = NULL;
 600                         loadaddr = last_file->f_addr + last_file->f_size;
 601                         fp = NULL;
 602                         break;
 603                 }
 604         } while(0);
 605         if (err == EFTYPE) {
 606                 snprintf(command_errbuf, sizeof(command_errbuf),
 607                   "don't know how to load module '%s'", filename);
 608         }
 609         if (err && fp)
 610                 file_discard(fp);
 611         free(filename);
 612         return (err);
 613 }
 614
 615 /*
 616  * Find a file matching (name) and (type).
 617  * NULL may be passed as a wildcard to either.
 618  */
 619 struct preloaded_file *
 620 file_findfile(const char *name, const char *type)
 621 {
 622         struct preloaded_file *fp;
 623
 624         for (fp = preloaded_files; fp != NULL; fp = fp->f_next) {
 625                 if (((name == NULL) || !strcmp(name, fp->f_name)) &&
 626                   ((type == NULL) || !strcmp(type, fp->f_type)))
 627                         break;
 628         }
 629         return (fp);
 630 }
 631
 632 /*
 633  * Find a module matching (name) inside of given file.
 634  * NULL may be passed as a wildcard.
 635  */
 636 struct kernel_module *
 637 file_findmodule(struct preloaded_file *fp, char *modname,
 638         struct mod_depend *verinfo)
 639 {
 640         struct kernel_module *mp, *best;
 641         int bestver, mver;
 642
 643         if (fp == NULL) {
 644                 for (fp = preloaded_files; fp; fp = fp->f_next) {
 645                         mp = file_findmodule(fp, modname, verinfo);
 646                         if (mp)
 647                                 return (mp);
 648                 }
 649                 return (NULL);
 650         }
 651         best = NULL;
 652         bestver = 0;
 653         for (mp = fp->f_modules; mp; mp = mp->m_next) {
 654                 if (strcmp(modname, mp->m_name) == 0) {
 655                         if (verinfo == NULL)
 656                                 return (mp);
 657                         mver = mp->m_version;
 658                         if (mver == verinfo->md_ver_preferred)
 659                                 return (mp);
 660                         if (mver >= verinfo->md_ver_minimum &&
 661                           mver <= verinfo->md_ver_maximum &&
 662                           mver > bestver) {
 663                                 best = mp;
 664                                 bestver = mver;
 665                         }
 666                 }
 667         }
 668         return (best);
 669 }
 670 /*
 671  * Make a copy of (size) bytes of data from (p), and associate them as
 672  * metadata of (type) to the module (mp).
 673  */
 674 void
 675 file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p)
 676 {
 677         struct file_metadata    *md;
 678
 679         md = malloc(sizeof(struct file_metadata) - sizeof(md->md_data) + size);
 680         if (md != NULL) {
 681                 md->md_size = size;
 682                 md->md_type = type;
 683                 bcopy(p, md->md_data, size);
 684                 md->md_next = fp->f_metadata;
 685         }
 686         fp->f_metadata = md;
 687 }
 688
 689 /*
 690  * Find a metadata object of (type) associated with the file (fp)
 691  */
 692 struct file_metadata *
 693 file_findmetadata(struct preloaded_file *fp, int type)
 694 {
 695         struct file_metadata *md;
 696
 697         for (md = fp->f_metadata; md != NULL; md = md->md_next)
 698                 if (md->md_type == type)
 699                         break;
 700         return(md);
 701 }
 702
 703 /*
 704  * Remove all metadata from the file.
 705  */
 706 void
 707 file_removemetadata(struct preloaded_file *fp)
 708 {
 709         struct file_metadata *md, *next;
 710
 711         for (md = fp->f_metadata; md != NULL; md = next)
 712         {
 713                 next = md->md_next;
 714                 free(md);
 715         }
 716         fp->f_metadata = NULL;
 717 }
 718
 719 struct file_metadata *
 720 metadata_next(struct file_metadata *md, int type)
 721 {
 722
 723         if (md == NULL)
 724                 return (NULL);
 725         while((md = md->md_next) != NULL)
 726                 if (md->md_type == type)
 727                         break;
 728         return (md);
 729 }
 730
 731 static char *emptyextlist[] = { "", NULL };
 732
 733 /*
 734  * Check if the given file is in place and return full path to it.
 735  */
 736 static char *
 737 file_lookup(const char *path, const char *name, int namelen, char **extlist)
 738 {
 739         struct stat     st;
 740         char    *result, *cp, **cpp;
 741         int             pathlen, extlen, len;
 742
 743         pathlen = strlen(path);
 744         extlen = 0;
 745         if (extlist == NULL)
 746                 extlist = emptyextlist;
 747         for (cpp = extlist; *cpp; cpp++) {
 748                 len = strlen(*cpp);
 749                 if (len > extlen)
 750                         extlen = len;
 751         }
 752         result = malloc(pathlen + namelen + extlen + 2);
 753         if (result == NULL)
 754                 return (NULL);
 755         bcopy(path, result, pathlen);
 756         if (pathlen > 0 && result[pathlen - 1] != '/')
 757                 result[pathlen++] = '/';
 758         cp = result + pathlen;
 759         bcopy(name, cp, namelen);
 760         cp += namelen;
 761         for (cpp = extlist; *cpp; cpp++) {
 762                 strcpy(cp, *cpp);
 763                 if (stat(result, &st) == 0 && S_ISREG(st.st_mode))
 764                         return result;
 765         }
 766         free(result);
 767         return NULL;
 768 }
 769
 770 /*
 771  * Check if file name have any qualifiers
 772  */
 773 static int
 774 file_havepath(const char *name)
 775 {
 776         const char              *cp;
 777
 778         archsw.arch_getdev(NULL, name, &cp);
 779         return (cp != name || strchr(name, '/') != NULL);
 780 }
 781
 782 /*
 783  * Attempt to find the file (name) on the module searchpath.
 784  * If (name) is qualified in any way, we simply check it and
 785  * return it or NULL.  If it is not qualified, then we attempt
 786  * to construct a path using entries in the environment variable
 787  * module_path.
 788  *
 789  * The path we return a pointer to need never be freed, as we manage
 790  * it internally.
 791  */
 792 static char *
 793 file_search(const char *name, char **extlist)
 794 {
 795         struct moduledir        *mdp;
 796         struct stat             sb;
 797         char            *result;
 798         int                     namelen;
 799
 800         /* Don't look for nothing */
 801         if (name == NULL)
 802                 return(NULL);
 803
 804         if (*name == 0)
 805                 return(strdup(name));
 806
 807         if (file_havepath(name)) {
 808                 /* Qualified, so just see if it exists */
 809                 if (stat(name, &sb) == 0)
 810                         return(strdup(name));
 811                 return(NULL);
 812         }
 813         moduledir_rebuild();
 814         result = NULL;
 815         namelen = strlen(name);
 816         STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
 817                 result = file_lookup(mdp->d_path, name, namelen, extlist);
 818                 if (result)
 819                         break;
 820         }
 821         return(result);
 822 }
 823
 824 #define INT_ALIGN(base, ptr)    ptr = \
 825         (base) + roundup2((ptr) - (base), sizeof(int))
 826
 827 static char *
 828 mod_search_hints(struct moduledir *mdp, const char *modname,
 829         struct mod_depend *verinfo)
 830 {
 831         u_char  *cp, *recptr, *bufend, *best;
 832         char    *result;
 833         int             *intp, bestver, blen, clen, found, ival, modnamelen, reclen;
 834
 835         moduledir_readhints(mdp);
 836         modnamelen = strlen(modname);
 837         found = 0;
 838         result = NULL;
 839         bestver = 0;
 840         if (mdp->d_hints == NULL)
 841                 goto bad;
 842         recptr = mdp->d_hints;
 843         bufend = recptr + mdp->d_hintsz;
 844         clen = blen = 0;
 845         best = cp = NULL;
 846         while (recptr < bufend && !found) {
 847                 intp = (int*)recptr;
 848                 reclen = *intp++;
 849                 ival = *intp++;
 850                 cp = (u_char*)intp;
 851                 switch (ival) {
 852                 case MDT_VERSION:
 853                         clen = *cp++;
 854                         if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
 855                                 break;
 856                         cp += clen;
 857                         INT_ALIGN(mdp->d_hints, cp);
 858                         ival = *(int*)cp;
 859                         cp += sizeof(int);
 860                         clen = *cp++;
 861                         if (verinfo == NULL || ival == verinfo->md_ver_preferred) {
 862                                 found = 1;
 863                                 break;
 864                         }
 865                         if (ival >= verinfo->md_ver_minimum &&
 866                           ival <= verinfo->md_ver_maximum &&
 867                           ival > bestver) {
 868                                 bestver = ival;
 869                                 best = cp;
 870                                 blen = clen;
 871                         }
 872                         break;
 873                 default:
 874                         break;
 875                 }
 876                 recptr += reclen + sizeof(int);
 877         }
 878         /*
 879          * Finally check if KLD is in the place
 880          */
 881         if (found)
 882                 result = file_lookup(mdp->d_path, (const char *)cp, clen, NULL);
 883         else if (best)
 884                 result = file_lookup(mdp->d_path, (const char *)best, blen, NULL);
 885 bad:
 886         /*
 887          * If nothing found or hints is absent - fallback to the old way
 888          * by using "kldname[.ko]" as module name.
 889          */
 890         if (!found && !bestver && result == NULL)
 891                 result = file_lookup(mdp->d_path, modname, modnamelen, kld_ext_list);
 892         return result;
 893 }
 894
 895 /*
 896  * Attempt to locate the file containing the module (name)
 897  */
 898 static char *
 899 mod_searchmodule(char *name, struct mod_depend *verinfo)
 900 {
 901         struct  moduledir *mdp;
 902         char    *result;
 903
 904         moduledir_rebuild();
 905         /*
 906          * Now we ready to lookup module in the given directories
 907          */
 908         result = NULL;
 909         STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
 910                 result = mod_search_hints(mdp, name, verinfo);
 911                 if (result)
 912                         break;
 913         }
 914
 915         return(result);
 916 }
 917
 918 int
 919 file_addmodule(struct preloaded_file *fp, char *modname, int version,
 920         struct kernel_module **newmp)
 921 {
 922         struct kernel_module *mp;
 923         struct mod_depend mdepend;
 924
 925         bzero(&mdepend, sizeof(mdepend));
 926         mdepend.md_ver_preferred = version;
 927         mp = file_findmodule(fp, modname, &mdepend);
 928         if (mp)
 929                 return (EEXIST);
 930         mp = calloc(1, sizeof(struct kernel_module));
 931         if (mp == NULL)
 932                 return (ENOMEM);
 933         mp->m_name = strdup(modname);
 934         if (mp->m_name == NULL) {
 935                 free(mp);
 936                 return (ENOMEM);
 937         }
 938         mp->m_version = version;
 939         mp->m_fp = fp;
 940         mp->m_next = fp->f_modules;
 941         fp->f_modules = mp;
 942         if (newmp)
 943                 *newmp = mp;
 944         return (0);
 945 }
 946
 947 /*
 948  * Throw a file away
 949  */
 950 void
 951 file_discard(struct preloaded_file *fp)
 952 {
 953         struct file_metadata    *md, *md1;
 954         struct kernel_module    *mp, *mp1;
 955         if (fp == NULL)
 956                 return;
 957         md = fp->f_metadata;
 958         while (md) {
 959                 md1 = md;
 960                 md = md->md_next;
 961                 free(md1);
 962         }
 963         mp = fp->f_modules;
 964         while (mp) {
 965                 free(mp->m_name);
 966                 mp1 = mp;
 967                 mp = mp->m_next;
 968                 free(mp1);
 969         }
 970         free(fp->f_name);
 971         free(fp->f_type);
 972         free(fp->f_args);
 973         free(fp);
 974 }
 975
 976 /*
 977  * Allocate a new file; must be used instead of malloc()
 978  * to ensure safe initialisation.
 979  */
 980 struct preloaded_file *
 981 file_alloc(void)
 982 {
 983
 984         return (calloc(1, sizeof(struct preloaded_file)));
 985 }
 986
 987 /*
 988  * Add a module to the chain
 989  */
 990 static void
 991 file_insert_tail(struct preloaded_file *fp)
 992 {
 993         struct preloaded_file   *cm;
 994
 995         /* Append to list of loaded file */
 996         fp->f_next = NULL;
 997         if (preloaded_files == NULL) {
 998                 preloaded_files = fp;
 999         } else {
1000                 for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next)
1001                         ;
1002                 cm->f_next = fp;
1003         }
1004 }
1005
1006 static char *
1007 moduledir_fullpath(struct moduledir *mdp, const char *fname)
1008 {
1009         char *cp;
1010
1011         cp = malloc(strlen(mdp->d_path) + strlen(fname) + 2);
1012         if (cp == NULL)
1013                 return NULL;
1014         strcpy(cp, mdp->d_path);
1015         strcat(cp, "/");
1016         strcat(cp, fname);
1017         return (cp);
1018 }
1019
1020 /*
1021  * Read linker.hints file into memory performing some sanity checks.
1022  */
1023 static void
1024 moduledir_readhints(struct moduledir *mdp)
1025 {
1026         struct stat     st;
1027         char    *path;
1028         int             fd, size, version;
1029
1030         if (mdp->d_hints != NULL || (mdp->d_flags & MDIR_NOHINTS))
1031                 return;
1032         path = moduledir_fullpath(mdp, "linker.hints");
1033         if (stat(path, &st) != 0 ||
1034           st.st_size < (ssize_t)(sizeof(version) + sizeof(int)) ||
1035           st.st_size > LINKER_HINTS_MAX || (fd = open(path, O_RDONLY)) < 0) {
1036                 free(path);
1037                 mdp->d_flags |= MDIR_NOHINTS;
1038                 return;
1039         }
1040         free(path);
1041         size = read(fd, &version, sizeof(version));
1042         if (size != sizeof(version) || version != LINKER_HINTS_VERSION)
1043                 goto bad;
1044         size = st.st_size - size;
1045         mdp->d_hints = malloc(size);
1046         if (mdp->d_hints == NULL)
1047                 goto bad;
1048         if (read(fd, mdp->d_hints, size) != size)
1049                 goto bad;
1050         mdp->d_hintsz = size;
1051         close(fd);
1052         return;
1053 bad:
1054         close(fd);
1055         free(mdp->d_hints);
1056         mdp->d_hints = NULL;
1057         mdp->d_flags |= MDIR_NOHINTS;
1058         return;
1059 }
1060
1061 /*
1062  * Extract directories from the ';' separated list, remove duplicates.
1063  */
1064 static void
1065 moduledir_rebuild(void)
1066 {
1067         struct  moduledir *mdp, *mtmp;
1068         const char      *path, *cp, *ep;
1069         size_t  cplen;
1070
1071         path = getenv("module_path");
1072         if (path == NULL)
1073                 path = default_searchpath;
1074         /*
1075          * Rebuild list of module directories if it changed
1076          */
1077         STAILQ_FOREACH(mdp, &moduledir_list, d_link)
1078                 mdp->d_flags |= MDIR_REMOVED;
1079
1080         for (ep = path; *ep != 0;  ep++) {
1081                 cp = ep;
1082                 for (; *ep != 0 && *ep != ';'; ep++)
1083                         ;
1084                 /*
1085                  * Ignore trailing slashes
1086                  */
1087                 for (cplen = ep - cp; cplen > 1 && cp[cplen - 1] == '/'; cplen--)
1088                         ;
1089                 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1090                         if (strlen(mdp->d_path) != cplen ||     bcmp(cp, mdp->d_path, cplen) != 0)
1091                                 continue;
1092                         mdp->d_flags &= ~MDIR_REMOVED;
1093                         break;
1094                 }
1095                 if (mdp == NULL) {
1096                         mdp = malloc(sizeof(*mdp) + cplen + 1);
1097                         if (mdp == NULL)
1098                                 return;
1099                         mdp->d_path = (char*)(mdp + 1);
1100                         bcopy(cp, mdp->d_path, cplen);
1101                         mdp->d_path[cplen] = 0;
1102                         mdp->d_hints = NULL;
1103                         mdp->d_flags = 0;
1104                         STAILQ_INSERT_TAIL(&moduledir_list, mdp, d_link);
1105                 }
1106                 if (*ep == 0)
1107                         break;
1108         }
1109         /*
1110          * Delete unused directories if any
1111          */
1112         mdp = STAILQ_FIRST(&moduledir_list);
1113         while (mdp) {
1114                 if ((mdp->d_flags & MDIR_REMOVED) == 0) {
1115                         mdp = STAILQ_NEXT(mdp, d_link);
1116                 } else {
1117                         free(mdp->d_hints);
1118                         mtmp = mdp;
1119                         mdp = STAILQ_NEXT(mdp, d_link);
1120                         STAILQ_REMOVE(&moduledir_list, mtmp, moduledir, d_link);
1121                         free(mtmp);
1122                 }
1123         }
1124         return;
1125 }