sys/kern/kern_linker.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1997-2000 Doug Rabson
   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 AUTHOR 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 AUTHOR 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_ddb.h"
  33 #include "opt_kld.h"
  34 #include "opt_hwpmc_hooks.h"
  35
  36 #include <sys/param.h>
  37 #include <sys/kernel.h>
  38 #include <sys/systm.h>
  39 #include <sys/malloc.h>
  40 #include <sys/sysproto.h>
  41 #include <sys/sysent.h>
  42 #include <sys/priv.h>
  43 #include <sys/proc.h>
  44 #include <sys/lock.h>
  45 #include <sys/mutex.h>
  46 #include <sys/sx.h>
  47 #include <sys/module.h>
  48 #include <sys/mount.h>
  49 #include <sys/linker.h>
  50 #include <sys/eventhandler.h>
  51 #include <sys/fcntl.h>
  52 #include <sys/jail.h>
  53 #include <sys/libkern.h>
  54 #include <sys/namei.h>
  55 #include <sys/vnode.h>
  56 #include <sys/syscallsubr.h>
  57 #include <sys/sysctl.h>
  58
  59 #ifdef DDB
  60 #include <ddb/ddb.h>
  61 #endif
  62
  63 #include <net/vnet.h>
  64
  65 #include <security/mac/mac_framework.h>
  66
  67 #include "linker_if.h"
  68
  69 #ifdef HWPMC_HOOKS
  70 #include <sys/pmckern.h>
  71 #endif
  72
  73 #ifdef KLD_DEBUG
  74 int kld_debug = 0;
  75 SYSCTL_INT(_debug, OID_AUTO, kld_debug, CTLFLAG_RWTUN,
  76     &kld_debug, 0, "Set various levels of KLD debug");
  77 #endif
  78
  79 /* These variables are used by kernel debuggers to enumerate loaded files. */
  80 const int kld_off_address = offsetof(struct linker_file, address);
  81 const int kld_off_filename = offsetof(struct linker_file, filename);
  82 const int kld_off_pathname = offsetof(struct linker_file, pathname);
  83 const int kld_off_next = offsetof(struct linker_file, link.tqe_next);
  84
  85 /*
  86  * static char *linker_search_path(const char *name, struct mod_depend
  87  * *verinfo);
  88  */
  89 static const char       *linker_basename(const char *path);
  90
  91 /*
  92  * Find a currently loaded file given its filename.
  93  */
  94 static linker_file_t linker_find_file_by_name(const char* _filename);
  95
  96 /*
  97  * Find a currently loaded file given its file id.
  98  */
  99 static linker_file_t linker_find_file_by_id(int _fileid);
 100
 101 /* Metadata from the static kernel */
 102 SET_DECLARE(modmetadata_set, struct mod_metadata);
 103
 104 MALLOC_DEFINE(M_LINKER, "linker", "kernel linker");
 105
 106 linker_file_t linker_kernel_file;
 107
 108 static struct sx kld_sx;        /* kernel linker lock */
 109 static bool kld_busy;
 110
 111 /*
 112  * Load counter used by clients to determine if a linker file has been
 113  * re-loaded. This counter is incremented for each file load.
 114  */
 115 static int loadcnt;
 116
 117 static linker_class_list_t classes;
 118 static linker_file_list_t linker_files;
 119 static int next_file_id = 1;
 120 static int linker_no_more_classes = 0;
 121
 122 #define LINKER_GET_NEXT_FILE_ID(a) do {                                 \
 123         linker_file_t lftmp;                                            \
 124                                                                         \
 125         if (!cold)                                                      \
 126                 sx_assert(&kld_sx, SA_XLOCKED);                         \
 127 retry:                                                                  \
 128         TAILQ_FOREACH(lftmp, &linker_files, link) {                     \
 129                 if (next_file_id == lftmp->id) {                        \
 130                         next_file_id++;                                 \
 131                         goto retry;                                     \
 132                 }                                                       \
 133         }                                                               \
 134         (a) = next_file_id;                                             \
 135 } while (0)
 136
 137 /* XXX wrong name; we're looking at version provision tags here, not modules */
 138 typedef TAILQ_HEAD(, modlist) modlisthead_t;
 139 struct modlist {
 140         TAILQ_ENTRY(modlist) link;      /* chain together all modules */
 141         linker_file_t   container;
 142         const char      *name;
 143         int             version;
 144 };
 145 typedef struct modlist *modlist_t;
 146 static modlisthead_t found_modules;
 147
 148 static int      linker_file_add_dependency(linker_file_t file,
 149                     linker_file_t dep);
 150 static caddr_t  linker_file_lookup_symbol_internal(linker_file_t file,
 151                     const char* name, int deps);
 152 static int      linker_load_module(const char *kldname,
 153                     const char *modname, struct linker_file *parent,
 154                     const struct mod_depend *verinfo, struct linker_file **lfpp);
 155 static modlist_t modlist_lookup2(const char *name, const struct mod_depend *verinfo);
 156
 157 static void
 158 linker_init(void *arg)
 159 {
 160
 161         sx_init(&kld_sx, "kernel linker");
 162         TAILQ_INIT(&classes);
 163         TAILQ_INIT(&linker_files);
 164 }
 165
 166 SYSINIT(linker, SI_SUB_KLD, SI_ORDER_FIRST, linker_init, NULL);
 167
 168 static void
 169 linker_stop_class_add(void *arg)
 170 {
 171
 172         linker_no_more_classes = 1;
 173 }
 174
 175 SYSINIT(linker_class, SI_SUB_KLD, SI_ORDER_ANY, linker_stop_class_add, NULL);
 176
 177 int
 178 linker_add_class(linker_class_t lc)
 179 {
 180
 181         /*
 182          * We disallow any class registration past SI_ORDER_ANY
 183          * of SI_SUB_KLD.  We bump the reference count to keep the
 184          * ops from being freed.
 185          */
 186         if (linker_no_more_classes == 1)
 187                 return (EPERM);
 188         kobj_class_compile((kobj_class_t) lc);
 189         ((kobj_class_t)lc)->refs++;     /* XXX: kobj_mtx */
 190         TAILQ_INSERT_TAIL(&classes, lc, link);
 191         return (0);
 192 }
 193
 194 static void
 195 linker_file_sysinit(linker_file_t lf)
 196 {
 197         struct sysinit **start, **stop, **sipp, **xipp, *save;
 198
 199         KLD_DPF(FILE, ("linker_file_sysinit: calling SYSINITs for %s\n",
 200             lf->filename));
 201
 202         sx_assert(&kld_sx, SA_XLOCKED);
 203
 204         if (linker_file_lookup_set(lf, "sysinit_set", &start, &stop, NULL) != 0)
 205                 return;
 206         /*
 207          * Perform a bubble sort of the system initialization objects by
 208          * their subsystem (primary key) and order (secondary key).
 209          *
 210          * Since some things care about execution order, this is the operation
 211          * which ensures continued function.
 212          */
 213         for (sipp = start; sipp < stop; sipp++) {
 214                 for (xipp = sipp + 1; xipp < stop; xipp++) {
 215                         if ((*sipp)->subsystem < (*xipp)->subsystem ||
 216                             ((*sipp)->subsystem == (*xipp)->subsystem &&
 217                             (*sipp)->order <= (*xipp)->order))
 218                                 continue;       /* skip */
 219                         save = *sipp;
 220                         *sipp = *xipp;
 221                         *xipp = save;
 222                 }
 223         }
 224
 225         /*
 226          * Traverse the (now) ordered list of system initialization tasks.
 227          * Perform each task, and continue on to the next task.
 228          */
 229         sx_xunlock(&kld_sx);
 230         mtx_lock(&Giant);
 231         for (sipp = start; sipp < stop; sipp++) {
 232                 if ((*sipp)->subsystem == SI_SUB_DUMMY)
 233                         continue;       /* skip dummy task(s) */
 234
 235                 /* Call function */
 236                 (*((*sipp)->func)) ((*sipp)->udata);
 237         }
 238         mtx_unlock(&Giant);
 239         sx_xlock(&kld_sx);
 240 }
 241
 242 static void
 243 linker_file_sysuninit(linker_file_t lf)
 244 {
 245         struct sysinit **start, **stop, **sipp, **xipp, *save;
 246
 247         KLD_DPF(FILE, ("linker_file_sysuninit: calling SYSUNINITs for %s\n",
 248             lf->filename));
 249
 250         sx_assert(&kld_sx, SA_XLOCKED);
 251
 252         if (linker_file_lookup_set(lf, "sysuninit_set", &start, &stop,
 253             NULL) != 0)
 254                 return;
 255
 256         /*
 257          * Perform a reverse bubble sort of the system initialization objects
 258          * by their subsystem (primary key) and order (secondary key).
 259          *
 260          * Since some things care about execution order, this is the operation
 261          * which ensures continued function.
 262          */
 263         for (sipp = start; sipp < stop; sipp++) {
 264                 for (xipp = sipp + 1; xipp < stop; xipp++) {
 265                         if ((*sipp)->subsystem > (*xipp)->subsystem ||
 266                             ((*sipp)->subsystem == (*xipp)->subsystem &&
 267                             (*sipp)->order >= (*xipp)->order))
 268                                 continue;       /* skip */
 269                         save = *sipp;
 270                         *sipp = *xipp;
 271                         *xipp = save;
 272                 }
 273         }
 274
 275         /*
 276          * Traverse the (now) ordered list of system initialization tasks.
 277          * Perform each task, and continue on to the next task.
 278          */
 279         sx_xunlock(&kld_sx);
 280         mtx_lock(&Giant);
 281         for (sipp = start; sipp < stop; sipp++) {
 282                 if ((*sipp)->subsystem == SI_SUB_DUMMY)
 283                         continue;       /* skip dummy task(s) */
 284
 285                 /* Call function */
 286                 (*((*sipp)->func)) ((*sipp)->udata);
 287         }
 288         mtx_unlock(&Giant);
 289         sx_xlock(&kld_sx);
 290 }
 291
 292 static void
 293 linker_file_register_sysctls(linker_file_t lf, bool enable)
 294 {
 295         struct sysctl_oid **start, **stop, **oidp;
 296
 297         KLD_DPF(FILE,
 298             ("linker_file_register_sysctls: registering SYSCTLs for %s\n",
 299             lf->filename));
 300
 301         sx_assert(&kld_sx, SA_XLOCKED);
 302
 303         if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
 304                 return;
 305
 306         sx_xunlock(&kld_sx);
 307         sysctl_wlock();
 308         for (oidp = start; oidp < stop; oidp++) {
 309                 if (enable)
 310                         sysctl_register_oid(*oidp);
 311                 else
 312                         sysctl_register_disabled_oid(*oidp);
 313         }
 314         sysctl_wunlock();
 315         sx_xlock(&kld_sx);
 316 }
 317
 318 static void
 319 linker_file_enable_sysctls(linker_file_t lf)
 320 {
 321         struct sysctl_oid **start, **stop, **oidp;
 322
 323         KLD_DPF(FILE,
 324             ("linker_file_enable_sysctls: enable SYSCTLs for %s\n",
 325             lf->filename));
 326
 327         sx_assert(&kld_sx, SA_XLOCKED);
 328
 329         if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
 330                 return;
 331
 332         sx_xunlock(&kld_sx);
 333         sysctl_wlock();
 334         for (oidp = start; oidp < stop; oidp++)
 335                 sysctl_enable_oid(*oidp);
 336         sysctl_wunlock();
 337         sx_xlock(&kld_sx);
 338 }
 339
 340 static void
 341 linker_file_unregister_sysctls(linker_file_t lf)
 342 {
 343         struct sysctl_oid **start, **stop, **oidp;
 344
 345         KLD_DPF(FILE, ("linker_file_unregister_sysctls: unregistering SYSCTLs"
 346             " for %s\n", lf->filename));
 347
 348         sx_assert(&kld_sx, SA_XLOCKED);
 349
 350         if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
 351                 return;
 352
 353         sx_xunlock(&kld_sx);
 354         sysctl_wlock();
 355         for (oidp = start; oidp < stop; oidp++)
 356                 sysctl_unregister_oid(*oidp);
 357         sysctl_wunlock();
 358         sx_xlock(&kld_sx);
 359 }
 360
 361 static int
 362 linker_file_register_modules(linker_file_t lf)
 363 {
 364         struct mod_metadata **start, **stop, **mdp;
 365         const moduledata_t *moddata;
 366         int first_error, error;
 367
 368         KLD_DPF(FILE, ("linker_file_register_modules: registering modules"
 369             " in %s\n", lf->filename));
 370
 371         sx_assert(&kld_sx, SA_XLOCKED);
 372
 373         if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop, NULL) != 0) {
 374                 /*
 375                  * This fallback should be unnecessary, but if we get booted
 376                  * from boot2 instead of loader and we are missing our
 377                  * metadata then we have to try the best we can.
 378                  */
 379                 if (lf == linker_kernel_file) {
 380                         start = SET_BEGIN(modmetadata_set);
 381                         stop = SET_LIMIT(modmetadata_set);
 382                 } else
 383                         return (0);
 384         }
 385         first_error = 0;
 386         for (mdp = start; mdp < stop; mdp++) {
 387                 if ((*mdp)->md_type != MDT_MODULE)
 388                         continue;
 389                 moddata = (*mdp)->md_data;
 390                 KLD_DPF(FILE, ("Registering module %s in %s\n",
 391                     moddata->name, lf->filename));
 392                 error = module_register(moddata, lf);
 393                 if (error) {
 394                         printf("Module %s failed to register: %d\n",
 395                             moddata->name, error);
 396                         if (first_error == 0)
 397                                 first_error = error;
 398                 }
 399         }
 400         return (first_error);
 401 }
 402
 403 static void
 404 linker_init_kernel_modules(void)
 405 {
 406
 407         sx_xlock(&kld_sx);
 408         linker_file_register_modules(linker_kernel_file);
 409         sx_xunlock(&kld_sx);
 410 }
 411
 412 SYSINIT(linker_kernel, SI_SUB_KLD, SI_ORDER_ANY, linker_init_kernel_modules,
 413     NULL);
 414
 415 static int
 416 linker_load_file(const char *filename, linker_file_t *result)
 417 {
 418         linker_class_t lc;
 419         linker_file_t lf;
 420         int foundfile, error, modules;
 421
 422         /* Refuse to load modules if securelevel raised */
 423         if (prison0.pr_securelevel > 0)
 424                 return (EPERM);
 425
 426         sx_assert(&kld_sx, SA_XLOCKED);
 427         lf = linker_find_file_by_name(filename);
 428         if (lf) {
 429                 KLD_DPF(FILE, ("linker_load_file: file %s is already loaded,"
 430                     " incrementing refs\n", filename));
 431                 *result = lf;
 432                 lf->refs++;
 433                 return (0);
 434         }
 435         foundfile = 0;
 436         error = 0;
 437
 438         /*
 439          * We do not need to protect (lock) classes here because there is
 440          * no class registration past startup (SI_SUB_KLD, SI_ORDER_ANY)
 441          * and there is no class deregistration mechanism at this time.
 442          */
 443         TAILQ_FOREACH(lc, &classes, link) {
 444                 KLD_DPF(FILE, ("linker_load_file: trying to load %s\n",
 445                     filename));
 446                 error = LINKER_LOAD_FILE(lc, filename, &lf);
 447                 /*
 448                  * If we got something other than ENOENT, then it exists but
 449                  * we cannot load it for some other reason.
 450                  */
 451                 if (error != ENOENT)
 452                         foundfile = 1;
 453                 if (lf) {
 454                         error = linker_file_register_modules(lf);
 455                         if (error == EEXIST) {
 456                                 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
 457                                 return (error);
 458                         }
 459                         modules = !TAILQ_EMPTY(&lf->modules);
 460                         linker_file_register_sysctls(lf, false);
 461                         linker_file_sysinit(lf);
 462                         lf->flags |= LINKER_FILE_LINKED;
 463
 464                         /*
 465                          * If all of the modules in this file failed
 466                          * to load, unload the file and return an
 467                          * error of ENOEXEC.
 468                          */
 469                         if (modules && TAILQ_EMPTY(&lf->modules)) {
 470                                 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
 471                                 return (ENOEXEC);
 472                         }
 473                         linker_file_enable_sysctls(lf);
 474                         EVENTHANDLER_INVOKE(kld_load, lf);
 475                         *result = lf;
 476                         return (0);
 477                 }
 478         }
 479         /*
 480          * Less than ideal, but tells the user whether it failed to load or
 481          * the module was not found.
 482          */
 483         if (foundfile) {
 484                 /*
 485                  * If the file type has not been recognized by the last try
 486                  * printout a message before to fail.
 487                  */
 488                 if (error == ENOSYS)
 489                         printf("%s: %s - unsupported file type\n",
 490                             __func__, filename);
 491
 492                 /*
 493                  * Format not recognized or otherwise unloadable.
 494                  * When loading a module that is statically built into
 495                  * the kernel EEXIST percolates back up as the return
 496                  * value.  Preserve this so that apps like sysinstall
 497                  * can recognize this special case and not post bogus
 498                  * dialog boxes.
 499                  */
 500                 if (error != EEXIST)
 501                         error = ENOEXEC;
 502         } else
 503                 error = ENOENT;         /* Nothing found */
 504         return (error);
 505 }
 506
 507 int
 508 linker_reference_module(const char *modname, struct mod_depend *verinfo,
 509     linker_file_t *result)
 510 {
 511         modlist_t mod;
 512         int error;
 513
 514         sx_xlock(&kld_sx);
 515         if ((mod = modlist_lookup2(modname, verinfo)) != NULL) {
 516                 *result = mod->container;
 517                 (*result)->refs++;
 518                 sx_xunlock(&kld_sx);
 519                 return (0);
 520         }
 521
 522         error = linker_load_module(NULL, modname, NULL, verinfo, result);
 523         sx_xunlock(&kld_sx);
 524         return (error);
 525 }
 526
 527 int
 528 linker_release_module(const char *modname, struct mod_depend *verinfo,
 529     linker_file_t lf)
 530 {
 531         modlist_t mod;
 532         int error;
 533
 534         sx_xlock(&kld_sx);
 535         if (lf == NULL) {
 536                 KASSERT(modname != NULL,
 537                     ("linker_release_module: no file or name"));
 538                 mod = modlist_lookup2(modname, verinfo);
 539                 if (mod == NULL) {
 540                         sx_xunlock(&kld_sx);
 541                         return (ESRCH);
 542                 }
 543                 lf = mod->container;
 544         } else
 545                 KASSERT(modname == NULL && verinfo == NULL,
 546                     ("linker_release_module: both file and name"));
 547         error = linker_file_unload(lf, LINKER_UNLOAD_NORMAL);
 548         sx_xunlock(&kld_sx);
 549         return (error);
 550 }
 551
 552 static linker_file_t
 553 linker_find_file_by_name(const char *filename)
 554 {
 555         linker_file_t lf;
 556         char *koname;
 557
 558         koname = malloc(strlen(filename) + 4, M_LINKER, M_WAITOK);
 559         sprintf(koname, "%s.ko", filename);
 560
 561         sx_assert(&kld_sx, SA_XLOCKED);
 562         TAILQ_FOREACH(lf, &linker_files, link) {
 563                 if (strcmp(lf->filename, koname) == 0)
 564                         break;
 565                 if (strcmp(lf->filename, filename) == 0)
 566                         break;
 567         }
 568         free(koname, M_LINKER);
 569         return (lf);
 570 }
 571
 572 static linker_file_t
 573 linker_find_file_by_id(int fileid)
 574 {
 575         linker_file_t lf;
 576
 577         sx_assert(&kld_sx, SA_XLOCKED);
 578         TAILQ_FOREACH(lf, &linker_files, link)
 579                 if (lf->id == fileid && lf->flags & LINKER_FILE_LINKED)
 580                         break;
 581         return (lf);
 582 }
 583
 584 int
 585 linker_file_foreach(linker_predicate_t *predicate, void *context)
 586 {
 587         linker_file_t lf;
 588         int retval = 0;
 589
 590         sx_xlock(&kld_sx);
 591         TAILQ_FOREACH(lf, &linker_files, link) {
 592                 retval = predicate(lf, context);
 593                 if (retval != 0)
 594                         break;
 595         }
 596         sx_xunlock(&kld_sx);
 597         return (retval);
 598 }
 599
 600 linker_file_t
 601 linker_make_file(const char *pathname, linker_class_t lc)
 602 {
 603         linker_file_t lf;
 604         const char *filename;
 605
 606         if (!cold)
 607                 sx_assert(&kld_sx, SA_XLOCKED);
 608         filename = linker_basename(pathname);
 609
 610         KLD_DPF(FILE, ("linker_make_file: new file, filename='%s' for pathname='%s'\n", filename, pathname));
 611         lf = (linker_file_t)kobj_create((kobj_class_t)lc, M_LINKER, M_WAITOK);
 612         if (lf == NULL)
 613                 return (NULL);
 614         lf->ctors_addr = 0;
 615         lf->ctors_size = 0;
 616         lf->dtors_addr = 0;
 617         lf->dtors_size = 0;
 618         lf->refs = 1;
 619         lf->userrefs = 0;
 620         lf->flags = 0;
 621         lf->filename = strdup(filename, M_LINKER);
 622         lf->pathname = strdup(pathname, M_LINKER);
 623         LINKER_GET_NEXT_FILE_ID(lf->id);
 624         lf->ndeps = 0;
 625         lf->deps = NULL;
 626         lf->loadcnt = ++loadcnt;
 627 #ifdef __arm__
 628         lf->exidx_addr = 0;
 629         lf->exidx_size = 0;
 630 #endif
 631         STAILQ_INIT(&lf->common);
 632         TAILQ_INIT(&lf->modules);
 633         TAILQ_INSERT_TAIL(&linker_files, lf, link);
 634         return (lf);
 635 }
 636
 637 int
 638 linker_file_unload(linker_file_t file, int flags)
 639 {
 640         module_t mod, next;
 641         modlist_t ml, nextml;
 642         struct common_symbol *cp;
 643         int error, i;
 644
 645         /* Refuse to unload modules if securelevel raised. */
 646         if (prison0.pr_securelevel > 0)
 647                 return (EPERM);
 648
 649         sx_assert(&kld_sx, SA_XLOCKED);
 650         KLD_DPF(FILE, ("linker_file_unload: lf->refs=%d\n", file->refs));
 651
 652         /* Easy case of just dropping a reference. */
 653         if (file->refs > 1) {
 654                 file->refs--;
 655                 return (0);
 656         }
 657
 658         /* Give eventhandlers a chance to prevent the unload. */
 659         error = 0;
 660         EVENTHANDLER_INVOKE(kld_unload_try, file, &error);
 661         if (error != 0)
 662                 return (EBUSY);
 663
 664         KLD_DPF(FILE, ("linker_file_unload: file is unloading,"
 665             " informing modules\n"));
 666
 667         /*
 668          * Quiesce all the modules to give them a chance to veto the unload.
 669          */
 670         MOD_SLOCK;
 671         for (mod = TAILQ_FIRST(&file->modules); mod;
 672              mod = module_getfnext(mod)) {
 673                 error = module_quiesce(mod);
 674                 if (error != 0 && flags != LINKER_UNLOAD_FORCE) {
 675                         KLD_DPF(FILE, ("linker_file_unload: module %s"
 676                             " vetoed unload\n", module_getname(mod)));
 677                         /*
 678                          * XXX: Do we need to tell all the quiesced modules
 679                          * that they can resume work now via a new module
 680                          * event?
 681                          */
 682                         MOD_SUNLOCK;
 683                         return (error);
 684                 }
 685         }
 686         MOD_SUNLOCK;
 687
 688         /*
 689          * Inform any modules associated with this file that they are
 690          * being unloaded.
 691          */
 692         MOD_XLOCK;
 693         for (mod = TAILQ_FIRST(&file->modules); mod; mod = next) {
 694                 next = module_getfnext(mod);
 695                 MOD_XUNLOCK;
 696
 697                 /*
 698                  * Give the module a chance to veto the unload.
 699                  */
 700                 if ((error = module_unload(mod)) != 0) {
 701 #ifdef KLD_DEBUG
 702                         MOD_SLOCK;
 703                         KLD_DPF(FILE, ("linker_file_unload: module %s"
 704                             " failed unload\n", module_getname(mod)));
 705                         MOD_SUNLOCK;
 706 #endif
 707                         return (error);
 708                 }
 709                 MOD_XLOCK;
 710                 module_release(mod);
 711         }
 712         MOD_XUNLOCK;
 713
 714         TAILQ_FOREACH_SAFE(ml, &found_modules, link, nextml) {
 715                 if (ml->container == file) {
 716                         TAILQ_REMOVE(&found_modules, ml, link);
 717                         free(ml, M_LINKER);
 718                 }
 719         }
 720
 721         /*
 722          * Don't try to run SYSUNINITs if we are unloaded due to a
 723          * link error.
 724          */
 725         if (file->flags & LINKER_FILE_LINKED) {
 726                 file->flags &= ~LINKER_FILE_LINKED;
 727                 linker_file_unregister_sysctls(file);
 728                 linker_file_sysuninit(file);
 729         }
 730         TAILQ_REMOVE(&linker_files, file, link);
 731
 732         if (file->deps) {
 733                 for (i = 0; i < file->ndeps; i++)
 734                         linker_file_unload(file->deps[i], flags);
 735                 free(file->deps, M_LINKER);
 736                 file->deps = NULL;
 737         }
 738         while ((cp = STAILQ_FIRST(&file->common)) != NULL) {
 739                 STAILQ_REMOVE_HEAD(&file->common, link);
 740                 free(cp, M_LINKER);
 741         }
 742
 743         LINKER_UNLOAD(file);
 744
 745         EVENTHANDLER_INVOKE(kld_unload, file->filename, file->address,
 746             file->size);
 747
 748         if (file->filename) {
 749                 free(file->filename, M_LINKER);
 750                 file->filename = NULL;
 751         }
 752         if (file->pathname) {
 753                 free(file->pathname, M_LINKER);
 754                 file->pathname = NULL;
 755         }
 756         kobj_delete((kobj_t) file, M_LINKER);
 757         return (0);
 758 }
 759
 760 int
 761 linker_ctf_get(linker_file_t file, linker_ctf_t *lc)
 762 {
 763         return (LINKER_CTF_GET(file, lc));
 764 }
 765
 766 static int
 767 linker_file_add_dependency(linker_file_t file, linker_file_t dep)
 768 {
 769         linker_file_t *newdeps;
 770
 771         sx_assert(&kld_sx, SA_XLOCKED);
 772         file->deps = realloc(file->deps, (file->ndeps + 1) * sizeof(*newdeps),
 773             M_LINKER, M_WAITOK | M_ZERO);
 774         file->deps[file->ndeps] = dep;
 775         file->ndeps++;
 776         KLD_DPF(FILE, ("linker_file_add_dependency:"
 777             " adding %s as dependency for %s\n",
 778             dep->filename, file->filename));
 779         return (0);
 780 }
 781
 782 /*
 783  * Locate a linker set and its contents.  This is a helper function to avoid
 784  * linker_if.h exposure elsewhere.  Note: firstp and lastp are really void **.
 785  * This function is used in this file so we can avoid having lots of (void **)
 786  * casts.
 787  */
 788 int
 789 linker_file_lookup_set(linker_file_t file, const char *name,
 790     void *firstp, void *lastp, int *countp)
 791 {
 792
 793         sx_assert(&kld_sx, SA_LOCKED);
 794         return (LINKER_LOOKUP_SET(file, name, firstp, lastp, countp));
 795 }
 796
 797 /*
 798  * List all functions in a file.
 799  */
 800 int
 801 linker_file_function_listall(linker_file_t lf,
 802     linker_function_nameval_callback_t callback_func, void *arg)
 803 {
 804         return (LINKER_EACH_FUNCTION_NAMEVAL(lf, callback_func, arg));
 805 }
 806
 807 caddr_t
 808 linker_file_lookup_symbol(linker_file_t file, const char *name, int deps)
 809 {
 810         caddr_t sym;
 811         int locked;
 812
 813         locked = sx_xlocked(&kld_sx);
 814         if (!locked)
 815                 sx_xlock(&kld_sx);
 816         sym = linker_file_lookup_symbol_internal(file, name, deps);
 817         if (!locked)
 818                 sx_xunlock(&kld_sx);
 819         return (sym);
 820 }
 821
 822 static caddr_t
 823 linker_file_lookup_symbol_internal(linker_file_t file, const char *name,
 824     int deps)
 825 {
 826         c_linker_sym_t sym;
 827         linker_symval_t symval;
 828         caddr_t address;
 829         size_t common_size = 0;
 830         int i;
 831
 832         sx_assert(&kld_sx, SA_XLOCKED);
 833         KLD_DPF(SYM, ("linker_file_lookup_symbol: file=%p, name=%s, deps=%d\n",
 834             file, name, deps));
 835
 836         if (LINKER_LOOKUP_SYMBOL(file, name, &sym) == 0) {
 837                 LINKER_SYMBOL_VALUES(file, sym, &symval);
 838                 if (symval.value == 0)
 839                         /*
 840                          * For commons, first look them up in the
 841                          * dependencies and only allocate space if not found
 842                          * there.
 843                          */
 844                         common_size = symval.size;
 845                 else {
 846                         KLD_DPF(SYM, ("linker_file_lookup_symbol: symbol"
 847                             ".value=%p\n", symval.value));
 848                         return (symval.value);
 849                 }
 850         }
 851         if (deps) {
 852                 for (i = 0; i < file->ndeps; i++) {
 853                         address = linker_file_lookup_symbol_internal(
 854                             file->deps[i], name, 0);
 855                         if (address) {
 856                                 KLD_DPF(SYM, ("linker_file_lookup_symbol:"
 857                                     " deps value=%p\n", address));
 858                                 return (address);
 859                         }
 860                 }
 861         }
 862         if (common_size > 0) {
 863                 /*
 864                  * This is a common symbol which was not found in the
 865                  * dependencies.  We maintain a simple common symbol table in
 866                  * the file object.
 867                  */
 868                 struct common_symbol *cp;
 869
 870                 STAILQ_FOREACH(cp, &file->common, link) {
 871                         if (strcmp(cp->name, name) == 0) {
 872                                 KLD_DPF(SYM, ("linker_file_lookup_symbol:"
 873                                     " old common value=%p\n", cp->address));
 874                                 return (cp->address);
 875                         }
 876                 }
 877                 /*
 878                  * Round the symbol size up to align.
 879                  */
 880                 common_size = (common_size + sizeof(int) - 1) & -sizeof(int);
 881                 cp = malloc(sizeof(struct common_symbol)
 882                     + common_size + strlen(name) + 1, M_LINKER,
 883                     M_WAITOK | M_ZERO);
 884                 cp->address = (caddr_t)(cp + 1);
 885                 cp->name = cp->address + common_size;
 886                 strcpy(cp->name, name);
 887                 bzero(cp->address, common_size);
 888                 STAILQ_INSERT_TAIL(&file->common, cp, link);
 889
 890                 KLD_DPF(SYM, ("linker_file_lookup_symbol: new common"
 891                     " value=%p\n", cp->address));
 892                 return (cp->address);
 893         }
 894         KLD_DPF(SYM, ("linker_file_lookup_symbol: fail\n"));
 895         return (0);
 896 }
 897
 898 /*
 899  * Both DDB and stack(9) rely on the kernel linker to provide forward and
 900  * backward lookup of symbols.  However, DDB and sometimes stack(9) need to
 901  * do this in a lockfree manner.  We provide a set of internal helper
 902  * routines to perform these operations without locks, and then wrappers that
 903  * optionally lock.
 904  *
 905  * linker_debug_lookup() is ifdef DDB as currently it's only used by DDB.
 906  */
 907 #ifdef DDB
 908 static int
 909 linker_debug_lookup(const char *symstr, c_linker_sym_t *sym)
 910 {
 911         linker_file_t lf;
 912
 913         TAILQ_FOREACH(lf, &linker_files, link) {
 914                 if (LINKER_LOOKUP_SYMBOL(lf, symstr, sym) == 0)
 915                         return (0);
 916         }
 917         return (ENOENT);
 918 }
 919 #endif
 920
 921 static int
 922 linker_debug_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
 923 {
 924         linker_file_t lf;
 925         c_linker_sym_t best, es;
 926         u_long diff, bestdiff, off;
 927
 928         best = 0;
 929         off = (uintptr_t)value;
 930         bestdiff = off;
 931         TAILQ_FOREACH(lf, &linker_files, link) {
 932                 if (LINKER_SEARCH_SYMBOL(lf, value, &es, &diff) != 0)
 933                         continue;
 934                 if (es != 0 && diff < bestdiff) {
 935                         best = es;
 936                         bestdiff = diff;
 937                 }
 938                 if (bestdiff == 0)
 939                         break;
 940         }
 941         if (best) {
 942                 *sym = best;
 943                 *diffp = bestdiff;
 944                 return (0);
 945         } else {
 946                 *sym = 0;
 947                 *diffp = off;
 948                 return (ENOENT);
 949         }
 950 }
 951
 952 static int
 953 linker_debug_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
 954 {
 955         linker_file_t lf;
 956
 957         TAILQ_FOREACH(lf, &linker_files, link) {
 958                 if (LINKER_SYMBOL_VALUES(lf, sym, symval) == 0)
 959                         return (0);
 960         }
 961         return (ENOENT);
 962 }
 963
 964 static int
 965 linker_debug_search_symbol_name(caddr_t value, char *buf, u_int buflen,
 966     long *offset)
 967 {
 968         linker_symval_t symval;
 969         c_linker_sym_t sym;
 970         int error;
 971
 972         *offset = 0;
 973         error = linker_debug_search_symbol(value, &sym, offset);
 974         if (error)
 975                 return (error);
 976         error = linker_debug_symbol_values(sym, &symval);
 977         if (error)
 978                 return (error);
 979         strlcpy(buf, symval.name, buflen);
 980         return (0);
 981 }
 982
 983 /*
 984  * DDB Helpers.  DDB has to look across multiple files with their own symbol
 985  * tables and string tables.
 986  *
 987  * Note that we do not obey list locking protocols here.  We really don't need
 988  * DDB to hang because somebody's got the lock held.  We'll take the chance
 989  * that the files list is inconsistent instead.
 990  */
 991 #ifdef DDB
 992 int
 993 linker_ddb_lookup(const char *symstr, c_linker_sym_t *sym)
 994 {
 995
 996         return (linker_debug_lookup(symstr, sym));
 997 }
 998 #endif
 999
1000 int
1001 linker_ddb_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
1002 {
1003
1004         return (linker_debug_search_symbol(value, sym, diffp));
1005 }
1006
1007 int
1008 linker_ddb_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
1009 {
1010
1011         return (linker_debug_symbol_values(sym, symval));
1012 }
1013
1014 int
1015 linker_ddb_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1016     long *offset)
1017 {
1018
1019         return (linker_debug_search_symbol_name(value, buf, buflen, offset));
1020 }
1021
1022 /*
1023  * stack(9) helper for non-debugging environemnts.  Unlike DDB helpers, we do
1024  * obey locking protocols, and offer a significantly less complex interface.
1025  */
1026 int
1027 linker_search_symbol_name_flags(caddr_t value, char *buf, u_int buflen,
1028     long *offset, int flags)
1029 {
1030         int error;
1031
1032         KASSERT((flags & (M_NOWAIT | M_WAITOK)) != 0 &&
1033             (flags & (M_NOWAIT | M_WAITOK)) != (M_NOWAIT | M_WAITOK),
1034             ("%s: bad flags: 0x%x", __func__, flags));
1035
1036         if (flags & M_NOWAIT) {
1037                 if (!sx_try_slock(&kld_sx))
1038                         return (EWOULDBLOCK);
1039         } else
1040                 sx_slock(&kld_sx);
1041
1042         error = linker_debug_search_symbol_name(value, buf, buflen, offset);
1043         sx_sunlock(&kld_sx);
1044         return (error);
1045 }
1046
1047 int
1048 linker_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1049     long *offset)
1050 {
1051
1052         return (linker_search_symbol_name_flags(value, buf, buflen, offset,
1053             M_WAITOK));
1054 }
1055
1056 int
1057 linker_kldload_busy(int flags)
1058 {
1059         int error;
1060
1061         MPASS((flags & ~(LINKER_UB_UNLOCK | LINKER_UB_LOCKED |
1062             LINKER_UB_PCATCH)) == 0);
1063         if ((flags & LINKER_UB_LOCKED) != 0)
1064                 sx_assert(&kld_sx, SA_XLOCKED);
1065
1066         if ((flags & LINKER_UB_LOCKED) == 0)
1067                 sx_xlock(&kld_sx);
1068         while (kld_busy) {
1069                 error = sx_sleep(&kld_busy, &kld_sx,
1070                     (flags & LINKER_UB_PCATCH) != 0 ? PCATCH : 0,
1071                     "kldbusy", 0);
1072                 if (error != 0) {
1073                         if ((flags & LINKER_UB_UNLOCK) != 0)
1074                                 sx_xunlock(&kld_sx);
1075                         return (error);
1076                 }
1077         }
1078         kld_busy = true;
1079         if ((flags & LINKER_UB_UNLOCK) != 0)
1080                 sx_xunlock(&kld_sx);
1081         return (0);
1082 }
1083
1084 void
1085 linker_kldload_unbusy(int flags)
1086 {
1087         MPASS((flags & ~LINKER_UB_LOCKED) == 0);
1088         if ((flags & LINKER_UB_LOCKED) != 0)
1089                 sx_assert(&kld_sx, SA_XLOCKED);
1090
1091         if ((flags & LINKER_UB_LOCKED) == 0)
1092                 sx_xlock(&kld_sx);
1093         MPASS(kld_busy);
1094         kld_busy = false;
1095         wakeup(&kld_busy);
1096         sx_xunlock(&kld_sx);
1097 }
1098
1099 /*
1100  * Syscalls.
1101  */
1102 int
1103 kern_kldload(struct thread *td, const char *file, int *fileid)
1104 {
1105         const char *kldname, *modname;
1106         linker_file_t lf;
1107         int error;
1108
1109         if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1110                 return (error);
1111
1112         if ((error = priv_check(td, PRIV_KLD_LOAD)) != 0)
1113                 return (error);
1114
1115         /*
1116          * If file does not contain a qualified name or any dot in it
1117          * (kldname.ko, or kldname.ver.ko) treat it as an interface
1118          * name.
1119          */
1120         if (strchr(file, '/') || strchr(file, '.')) {
1121                 kldname = file;
1122                 modname = NULL;
1123         } else {
1124                 kldname = NULL;
1125                 modname = file;
1126         }
1127
1128         error = linker_kldload_busy(LINKER_UB_PCATCH);
1129         if (error != 0) {
1130                 sx_xunlock(&kld_sx);
1131                 return (error);
1132         }
1133
1134         /*
1135          * It is possible that kldloaded module will attach a new ifnet,
1136          * so vnet context must be set when this ocurs.
1137          */
1138         CURVNET_SET(TD_TO_VNET(td));
1139
1140         error = linker_load_module(kldname, modname, NULL, NULL, &lf);
1141         CURVNET_RESTORE();
1142
1143         if (error == 0) {
1144                 lf->userrefs++;
1145                 if (fileid != NULL)
1146                         *fileid = lf->id;
1147         }
1148         linker_kldload_unbusy(LINKER_UB_LOCKED);
1149         return (error);
1150 }
1151
1152 int
1153 sys_kldload(struct thread *td, struct kldload_args *uap)
1154 {
1155         char *pathname = NULL;
1156         int error, fileid;
1157
1158         td->td_retval[0] = -1;
1159
1160         pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1161         error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL);
1162         if (error == 0) {
1163                 error = kern_kldload(td, pathname, &fileid);
1164                 if (error == 0)
1165                         td->td_retval[0] = fileid;
1166         }
1167         free(pathname, M_TEMP);
1168         return (error);
1169 }
1170
1171 int
1172 kern_kldunload(struct thread *td, int fileid, int flags)
1173 {
1174         linker_file_t lf;
1175         int error = 0;
1176
1177         if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1178                 return (error);
1179
1180         if ((error = priv_check(td, PRIV_KLD_UNLOAD)) != 0)
1181                 return (error);
1182
1183         error = linker_kldload_busy(LINKER_UB_PCATCH);
1184         if (error != 0) {
1185                 sx_xunlock(&kld_sx);
1186                 return (error);
1187         }
1188
1189         CURVNET_SET(TD_TO_VNET(td));
1190         lf = linker_find_file_by_id(fileid);
1191         if (lf) {
1192                 KLD_DPF(FILE, ("kldunload: lf->userrefs=%d\n", lf->userrefs));
1193
1194                 if (lf->userrefs == 0) {
1195                         /*
1196                          * XXX: maybe LINKER_UNLOAD_FORCE should override ?
1197                          */
1198                         printf("kldunload: attempt to unload file that was"
1199                             " loaded by the kernel\n");
1200                         error = EBUSY;
1201                 } else {
1202                         lf->userrefs--;
1203                         error = linker_file_unload(lf, flags);
1204                         if (error)
1205                                 lf->userrefs++;
1206                 }
1207         } else
1208                 error = ENOENT;
1209         CURVNET_RESTORE();
1210         linker_kldload_unbusy(LINKER_UB_LOCKED);
1211         return (error);
1212 }
1213
1214 int
1215 sys_kldunload(struct thread *td, struct kldunload_args *uap)
1216 {
1217
1218         return (kern_kldunload(td, uap->fileid, LINKER_UNLOAD_NORMAL));
1219 }
1220
1221 int
1222 sys_kldunloadf(struct thread *td, struct kldunloadf_args *uap)
1223 {
1224
1225         if (uap->flags != LINKER_UNLOAD_NORMAL &&
1226             uap->flags != LINKER_UNLOAD_FORCE)
1227                 return (EINVAL);
1228         return (kern_kldunload(td, uap->fileid, uap->flags));
1229 }
1230
1231 int
1232 sys_kldfind(struct thread *td, struct kldfind_args *uap)
1233 {
1234         char *pathname;
1235         const char *filename;
1236         linker_file_t lf;
1237         int error;
1238
1239 #ifdef MAC
1240         error = mac_kld_check_stat(td->td_ucred);
1241         if (error)
1242                 return (error);
1243 #endif
1244
1245         td->td_retval[0] = -1;
1246
1247         pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1248         if ((error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL)) != 0)
1249                 goto out;
1250
1251         filename = linker_basename(pathname);
1252         sx_xlock(&kld_sx);
1253         lf = linker_find_file_by_name(filename);
1254         if (lf)
1255                 td->td_retval[0] = lf->id;
1256         else
1257                 error = ENOENT;
1258         sx_xunlock(&kld_sx);
1259 out:
1260         free(pathname, M_TEMP);
1261         return (error);
1262 }
1263
1264 int
1265 sys_kldnext(struct thread *td, struct kldnext_args *uap)
1266 {
1267         linker_file_t lf;
1268         int error = 0;
1269
1270 #ifdef MAC
1271         error = mac_kld_check_stat(td->td_ucred);
1272         if (error)
1273                 return (error);
1274 #endif
1275
1276         sx_xlock(&kld_sx);
1277         if (uap->fileid == 0)
1278                 lf = TAILQ_FIRST(&linker_files);
1279         else {
1280                 lf = linker_find_file_by_id(uap->fileid);
1281                 if (lf == NULL) {
1282                         error = ENOENT;
1283                         goto out;
1284                 }
1285                 lf = TAILQ_NEXT(lf, link);
1286         }
1287
1288         /* Skip partially loaded files. */
1289         while (lf != NULL && !(lf->flags & LINKER_FILE_LINKED))
1290                 lf = TAILQ_NEXT(lf, link);
1291
1292         if (lf)
1293                 td->td_retval[0] = lf->id;
1294         else
1295                 td->td_retval[0] = 0;
1296 out:
1297         sx_xunlock(&kld_sx);
1298         return (error);
1299 }
1300
1301 int
1302 sys_kldstat(struct thread *td, struct kldstat_args *uap)
1303 {
1304         struct kld_file_stat *stat;
1305         int error, version;
1306
1307         /*
1308          * Check the version of the user's structure.
1309          */
1310         if ((error = copyin(&uap->stat->version, &version, sizeof(version)))
1311             != 0)
1312                 return (error);
1313         if (version != sizeof(struct kld_file_stat_1) &&
1314             version != sizeof(struct kld_file_stat))
1315                 return (EINVAL);
1316
1317         stat = malloc(sizeof(*stat), M_TEMP, M_WAITOK | M_ZERO);
1318         error = kern_kldstat(td, uap->fileid, stat);
1319         if (error == 0)
1320                 error = copyout(stat, uap->stat, version);
1321         free(stat, M_TEMP);
1322         return (error);
1323 }
1324
1325 int
1326 kern_kldstat(struct thread *td, int fileid, struct kld_file_stat *stat)
1327 {
1328         linker_file_t lf;
1329         int namelen;
1330 #ifdef MAC
1331         int error;
1332
1333         error = mac_kld_check_stat(td->td_ucred);
1334         if (error)
1335                 return (error);
1336 #endif
1337
1338         sx_xlock(&kld_sx);
1339         lf = linker_find_file_by_id(fileid);
1340         if (lf == NULL) {
1341                 sx_xunlock(&kld_sx);
1342                 return (ENOENT);
1343         }
1344
1345         /* Version 1 fields: */
1346         namelen = strlen(lf->filename) + 1;
1347         if (namelen > sizeof(stat->name))
1348                 namelen = sizeof(stat->name);
1349         bcopy(lf->filename, &stat->name[0], namelen);
1350         stat->refs = lf->refs;
1351         stat->id = lf->id;
1352         stat->address = lf->address;
1353         stat->size = lf->size;
1354         /* Version 2 fields: */
1355         namelen = strlen(lf->pathname) + 1;
1356         if (namelen > sizeof(stat->pathname))
1357                 namelen = sizeof(stat->pathname);
1358         bcopy(lf->pathname, &stat->pathname[0], namelen);
1359         sx_xunlock(&kld_sx);
1360
1361         td->td_retval[0] = 0;
1362         return (0);
1363 }
1364
1365 #ifdef DDB
1366 DB_COMMAND(kldstat, db_kldstat)
1367 {
1368         linker_file_t lf;
1369
1370 #define POINTER_WIDTH   ((int)(sizeof(void *) * 2 + 2))
1371         db_printf("Id Refs Address%*c Size     Name\n", POINTER_WIDTH - 7, ' ');
1372 #undef  POINTER_WIDTH
1373         TAILQ_FOREACH(lf, &linker_files, link) {
1374                 if (db_pager_quit)
1375                         return;
1376                 db_printf("%2d %4d %p %-8zx %s\n", lf->id, lf->refs,
1377                     lf->address, lf->size, lf->filename);
1378         }
1379 }
1380 #endif /* DDB */
1381
1382 int
1383 sys_kldfirstmod(struct thread *td, struct kldfirstmod_args *uap)
1384 {
1385         linker_file_t lf;
1386         module_t mp;
1387         int error = 0;
1388
1389 #ifdef MAC
1390         error = mac_kld_check_stat(td->td_ucred);
1391         if (error)
1392                 return (error);
1393 #endif
1394
1395         sx_xlock(&kld_sx);
1396         lf = linker_find_file_by_id(uap->fileid);
1397         if (lf) {
1398                 MOD_SLOCK;
1399                 mp = TAILQ_FIRST(&lf->modules);
1400                 if (mp != NULL)
1401                         td->td_retval[0] = module_getid(mp);
1402                 else
1403                         td->td_retval[0] = 0;
1404                 MOD_SUNLOCK;
1405         } else
1406                 error = ENOENT;
1407         sx_xunlock(&kld_sx);
1408         return (error);
1409 }
1410
1411 int
1412 sys_kldsym(struct thread *td, struct kldsym_args *uap)
1413 {
1414         char *symstr = NULL;
1415         c_linker_sym_t sym;
1416         linker_symval_t symval;
1417         linker_file_t lf;
1418         struct kld_sym_lookup lookup;
1419         int error = 0;
1420
1421 #ifdef MAC
1422         error = mac_kld_check_stat(td->td_ucred);
1423         if (error)
1424                 return (error);
1425 #endif
1426
1427         if ((error = copyin(uap->data, &lookup, sizeof(lookup))) != 0)
1428                 return (error);
1429         if (lookup.version != sizeof(lookup) ||
1430             uap->cmd != KLDSYM_LOOKUP)
1431                 return (EINVAL);
1432         symstr = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1433         if ((error = copyinstr(lookup.symname, symstr, MAXPATHLEN, NULL)) != 0)
1434                 goto out;
1435         sx_xlock(&kld_sx);
1436         if (uap->fileid != 0) {
1437                 lf = linker_find_file_by_id(uap->fileid);
1438                 if (lf == NULL)
1439                         error = ENOENT;
1440                 else if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1441                     LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1442                         lookup.symvalue = (uintptr_t) symval.value;
1443                         lookup.symsize = symval.size;
1444                         error = copyout(&lookup, uap->data, sizeof(lookup));
1445                 } else
1446                         error = ENOENT;
1447         } else {
1448                 TAILQ_FOREACH(lf, &linker_files, link) {
1449                         if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1450                             LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1451                                 lookup.symvalue = (uintptr_t)symval.value;
1452                                 lookup.symsize = symval.size;
1453                                 error = copyout(&lookup, uap->data,
1454                                     sizeof(lookup));
1455                                 break;
1456                         }
1457                 }
1458                 if (lf == NULL)
1459                         error = ENOENT;
1460         }
1461         sx_xunlock(&kld_sx);
1462 out:
1463         free(symstr, M_TEMP);
1464         return (error);
1465 }
1466
1467 /*
1468  * Preloaded module support
1469  */
1470
1471 static modlist_t
1472 modlist_lookup(const char *name, int ver)
1473 {
1474         modlist_t mod;
1475
1476         TAILQ_FOREACH(mod, &found_modules, link) {
1477                 if (strcmp(mod->name, name) == 0 &&
1478                     (ver == 0 || mod->version == ver))
1479                         return (mod);
1480         }
1481         return (NULL);
1482 }
1483
1484 static modlist_t
1485 modlist_lookup2(const char *name, const struct mod_depend *verinfo)
1486 {
1487         modlist_t mod, bestmod;
1488         int ver;
1489
1490         if (verinfo == NULL)
1491                 return (modlist_lookup(name, 0));
1492         bestmod = NULL;
1493         TAILQ_FOREACH(mod, &found_modules, link) {
1494                 if (strcmp(mod->name, name) != 0)
1495                         continue;
1496                 ver = mod->version;
1497                 if (ver == verinfo->md_ver_preferred)
1498                         return (mod);
1499                 if (ver >= verinfo->md_ver_minimum &&
1500                     ver <= verinfo->md_ver_maximum &&
1501                     (bestmod == NULL || ver > bestmod->version))
1502                         bestmod = mod;
1503         }
1504         return (bestmod);
1505 }
1506
1507 static modlist_t
1508 modlist_newmodule(const char *modname, int version, linker_file_t container)
1509 {
1510         modlist_t mod;
1511
1512         mod = malloc(sizeof(struct modlist), M_LINKER, M_NOWAIT | M_ZERO);
1513         if (mod == NULL)
1514                 panic("no memory for module list");
1515         mod->container = container;
1516         mod->name = modname;
1517         mod->version = version;
1518         TAILQ_INSERT_TAIL(&found_modules, mod, link);
1519         return (mod);
1520 }
1521
1522 static void
1523 linker_addmodules(linker_file_t lf, struct mod_metadata **start,
1524     struct mod_metadata **stop, int preload)
1525 {
1526         struct mod_metadata *mp, **mdp;
1527         const char *modname;
1528         int ver;
1529
1530         for (mdp = start; mdp < stop; mdp++) {
1531                 mp = *mdp;
1532                 if (mp->md_type != MDT_VERSION)
1533                         continue;
1534                 modname = mp->md_cval;
1535                 ver = ((const struct mod_version *)mp->md_data)->mv_version;
1536                 if (modlist_lookup(modname, ver) != NULL) {
1537                         printf("module %s already present!\n", modname);
1538                         /* XXX what can we do? this is a build error. :-( */
1539                         continue;
1540                 }
1541                 modlist_newmodule(modname, ver, lf);
1542         }
1543 }
1544
1545 static void
1546 linker_preload(void *arg)
1547 {
1548         caddr_t modptr;
1549         const char *modname, *nmodname;
1550         char *modtype;
1551         linker_file_t lf, nlf;
1552         linker_class_t lc;
1553         int error;
1554         linker_file_list_t loaded_files;
1555         linker_file_list_t depended_files;
1556         struct mod_metadata *mp, *nmp;
1557         struct mod_metadata **start, **stop, **mdp, **nmdp;
1558         const struct mod_depend *verinfo;
1559         int nver;
1560         int resolves;
1561         modlist_t mod;
1562         struct sysinit **si_start, **si_stop;
1563
1564         TAILQ_INIT(&loaded_files);
1565         TAILQ_INIT(&depended_files);
1566         TAILQ_INIT(&found_modules);
1567         error = 0;
1568
1569         modptr = NULL;
1570         sx_xlock(&kld_sx);
1571         while ((modptr = preload_search_next_name(modptr)) != NULL) {
1572                 modname = (char *)preload_search_info(modptr, MODINFO_NAME);
1573                 modtype = (char *)preload_search_info(modptr, MODINFO_TYPE);
1574                 if (modname == NULL) {
1575                         printf("Preloaded module at %p does not have a"
1576                             " name!\n", modptr);
1577                         continue;
1578                 }
1579                 if (modtype == NULL) {
1580                         printf("Preloaded module at %p does not have a type!\n",
1581                             modptr);
1582                         continue;
1583                 }
1584                 if (bootverbose)
1585                         printf("Preloaded %s \"%s\" at %p.\n", modtype, modname,
1586                             modptr);
1587                 lf = NULL;
1588                 TAILQ_FOREACH(lc, &classes, link) {
1589                         error = LINKER_LINK_PRELOAD(lc, modname, &lf);
1590                         if (!error)
1591                                 break;
1592                         lf = NULL;
1593                 }
1594                 if (lf)
1595                         TAILQ_INSERT_TAIL(&loaded_files, lf, loaded);
1596         }
1597
1598         /*
1599          * First get a list of stuff in the kernel.
1600          */
1601         if (linker_file_lookup_set(linker_kernel_file, MDT_SETNAME, &start,
1602             &stop, NULL) == 0)
1603                 linker_addmodules(linker_kernel_file, start, stop, 1);
1604
1605         /*
1606          * This is a once-off kinky bubble sort to resolve relocation
1607          * dependency requirements.
1608          */
1609 restart:
1610         TAILQ_FOREACH(lf, &loaded_files, loaded) {
1611                 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1612                     &stop, NULL);
1613                 /*
1614                  * First, look to see if we would successfully link with this
1615                  * stuff.
1616                  */
1617                 resolves = 1;   /* unless we know otherwise */
1618                 if (!error) {
1619                         for (mdp = start; mdp < stop; mdp++) {
1620                                 mp = *mdp;
1621                                 if (mp->md_type != MDT_DEPEND)
1622                                         continue;
1623                                 modname = mp->md_cval;
1624                                 verinfo = mp->md_data;
1625                                 for (nmdp = start; nmdp < stop; nmdp++) {
1626                                         nmp = *nmdp;
1627                                         if (nmp->md_type != MDT_VERSION)
1628                                                 continue;
1629                                         nmodname = nmp->md_cval;
1630                                         if (strcmp(modname, nmodname) == 0)
1631                                                 break;
1632                                 }
1633                                 if (nmdp < stop)   /* it's a self reference */
1634                                         continue;
1635
1636                                 /*
1637                                  * ok, the module isn't here yet, we
1638                                  * are not finished
1639                                  */
1640                                 if (modlist_lookup2(modname, verinfo) == NULL)
1641                                         resolves = 0;
1642                         }
1643                 }
1644                 /*
1645                  * OK, if we found our modules, we can link.  So, "provide"
1646                  * the modules inside and add it to the end of the link order
1647                  * list.
1648                  */
1649                 if (resolves) {
1650                         if (!error) {
1651                                 for (mdp = start; mdp < stop; mdp++) {
1652                                         mp = *mdp;
1653                                         if (mp->md_type != MDT_VERSION)
1654                                                 continue;
1655                                         modname = mp->md_cval;
1656                                         nver = ((const struct mod_version *)
1657                                             mp->md_data)->mv_version;
1658                                         if (modlist_lookup(modname,
1659                                             nver) != NULL) {
1660                                                 printf("module %s already"
1661                                                     " present!\n", modname);
1662                                                 TAILQ_REMOVE(&loaded_files,
1663                                                     lf, loaded);
1664                                                 linker_file_unload(lf,
1665                                                     LINKER_UNLOAD_FORCE);
1666                                                 /* we changed tailq next ptr */
1667                                                 goto restart;
1668                                         }
1669                                         modlist_newmodule(modname, nver, lf);
1670                                 }
1671                         }
1672                         TAILQ_REMOVE(&loaded_files, lf, loaded);
1673                         TAILQ_INSERT_TAIL(&depended_files, lf, loaded);
1674                         /*
1675                          * Since we provided modules, we need to restart the
1676                          * sort so that the previous files that depend on us
1677                          * have a chance. Also, we've busted the tailq next
1678                          * pointer with the REMOVE.
1679                          */
1680                         goto restart;
1681                 }
1682         }
1683
1684         /*
1685          * At this point, we check to see what could not be resolved..
1686          */
1687         while ((lf = TAILQ_FIRST(&loaded_files)) != NULL) {
1688                 TAILQ_REMOVE(&loaded_files, lf, loaded);
1689                 printf("KLD file %s is missing dependencies\n", lf->filename);
1690                 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1691         }
1692
1693         /*
1694          * We made it. Finish off the linking in the order we determined.
1695          */
1696         TAILQ_FOREACH_SAFE(lf, &depended_files, loaded, nlf) {
1697                 if (linker_kernel_file) {
1698                         linker_kernel_file->refs++;
1699                         error = linker_file_add_dependency(lf,
1700                             linker_kernel_file);
1701                         if (error)
1702                                 panic("cannot add dependency");
1703                 }
1704                 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1705                     &stop, NULL);
1706                 if (!error) {
1707                         for (mdp = start; mdp < stop; mdp++) {
1708                                 mp = *mdp;
1709                                 if (mp->md_type != MDT_DEPEND)
1710                                         continue;
1711                                 modname = mp->md_cval;
1712                                 verinfo = mp->md_data;
1713                                 mod = modlist_lookup2(modname, verinfo);
1714                                 if (mod == NULL) {
1715                                         printf("KLD file %s - cannot find "
1716                                             "dependency \"%s\"\n",
1717                                             lf->filename, modname);
1718                                         goto fail;
1719                                 }
1720                                 /* Don't count self-dependencies */
1721                                 if (lf == mod->container)
1722                                         continue;
1723                                 mod->container->refs++;
1724                                 error = linker_file_add_dependency(lf,
1725                                     mod->container);
1726                                 if (error)
1727                                         panic("cannot add dependency");
1728                         }
1729                 }
1730                 /*
1731                  * Now do relocation etc using the symbol search paths
1732                  * established by the dependencies
1733                  */
1734                 error = LINKER_LINK_PRELOAD_FINISH(lf);
1735                 if (error) {
1736                         printf("KLD file %s - could not finalize loading\n",
1737                             lf->filename);
1738                         goto fail;
1739                 }
1740                 linker_file_register_modules(lf);
1741                 if (!TAILQ_EMPTY(&lf->modules))
1742                         lf->flags |= LINKER_FILE_MODULES;
1743                 if (linker_file_lookup_set(lf, "sysinit_set", &si_start,
1744                     &si_stop, NULL) == 0)
1745                         sysinit_add(si_start, si_stop);
1746                 linker_file_register_sysctls(lf, true);
1747                 lf->flags |= LINKER_FILE_LINKED;
1748                 continue;
1749 fail:
1750                 TAILQ_REMOVE(&depended_files, lf, loaded);
1751                 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1752         }
1753         sx_xunlock(&kld_sx);
1754         /* woohoo! we made it! */
1755 }
1756
1757 SYSINIT(preload, SI_SUB_KLD, SI_ORDER_MIDDLE, linker_preload, NULL);
1758
1759 /*
1760  * Handle preload files that failed to load any modules.
1761  */
1762 static void
1763 linker_preload_finish(void *arg)
1764 {
1765         linker_file_t lf, nlf;
1766
1767         sx_xlock(&kld_sx);
1768         TAILQ_FOREACH_SAFE(lf, &linker_files, link, nlf) {
1769                 /*
1770                  * If all of the modules in this file failed to load, unload
1771                  * the file and return an error of ENOEXEC.  (Parity with
1772                  * linker_load_file.)
1773                  */
1774                 if ((lf->flags & LINKER_FILE_MODULES) != 0 &&
1775                     TAILQ_EMPTY(&lf->modules)) {
1776                         linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1777                         continue;
1778                 }
1779
1780                 lf->flags &= ~LINKER_FILE_MODULES;
1781                 lf->userrefs++; /* so we can (try to) kldunload it */
1782         }
1783         sx_xunlock(&kld_sx);
1784 }
1785
1786 /*
1787  * Attempt to run after all DECLARE_MODULE SYSINITs.  Unfortunately they can be
1788  * scheduled at any subsystem and order, so run this as late as possible.  init
1789  * becomes runnable in SI_SUB_KTHREAD_INIT, so go slightly before that.
1790  */
1791 SYSINIT(preload_finish, SI_SUB_KTHREAD_INIT - 100, SI_ORDER_MIDDLE,
1792     linker_preload_finish, NULL);
1793
1794 /*
1795  * Search for a not-loaded module by name.
1796  *
1797  * Modules may be found in the following locations:
1798  *
1799  * - preloaded (result is just the module name) - on disk (result is full path
1800  * to module)
1801  *
1802  * If the module name is qualified in any way (contains path, etc.) the we
1803  * simply return a copy of it.
1804  *
1805  * The search path can be manipulated via sysctl.  Note that we use the ';'
1806  * character as a separator to be consistent with the bootloader.
1807  */
1808
1809 static char linker_hintfile[] = "linker.hints";
1810 static char linker_path[MAXPATHLEN] = "/boot/kernel;/boot/modules";
1811
1812 SYSCTL_STRING(_kern, OID_AUTO, module_path, CTLFLAG_RWTUN, linker_path,
1813     sizeof(linker_path), "module load search path");
1814
1815 TUNABLE_STR("module_path", linker_path, sizeof(linker_path));
1816
1817 static const char * const linker_ext_list[] = {
1818         "",
1819         ".ko",
1820         NULL
1821 };
1822
1823 /*
1824  * Check if file actually exists either with or without extension listed in
1825  * the linker_ext_list. (probably should be generic for the rest of the
1826  * kernel)
1827  */
1828 static char *
1829 linker_lookup_file(const char *path, int pathlen, const char *name,
1830     int namelen, struct vattr *vap)
1831 {
1832         struct nameidata nd;
1833         struct thread *td = curthread;  /* XXX */
1834         const char * const *cpp, *sep;
1835         char *result;
1836         int error, len, extlen, reclen, flags;
1837         enum vtype type;
1838
1839         extlen = 0;
1840         for (cpp = linker_ext_list; *cpp; cpp++) {
1841                 len = strlen(*cpp);
1842                 if (len > extlen)
1843                         extlen = len;
1844         }
1845         extlen++;               /* trailing '\0' */
1846         sep = (path[pathlen - 1] != '/') ? "/" : "";
1847
1848         reclen = pathlen + strlen(sep) + namelen + extlen + 1;
1849         result = malloc(reclen, M_LINKER, M_WAITOK);
1850         for (cpp = linker_ext_list; *cpp; cpp++) {
1851                 snprintf(result, reclen, "%.*s%s%.*s%s", pathlen, path, sep,
1852                     namelen, name, *cpp);
1853                 /*
1854                  * Attempt to open the file, and return the path if
1855                  * we succeed and it's a regular file.
1856                  */
1857                 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, result, td);
1858                 flags = FREAD;
1859                 error = vn_open(&nd, &flags, 0, NULL);
1860                 if (error == 0) {
1861                         NDFREE(&nd, NDF_ONLY_PNBUF);
1862                         type = nd.ni_vp->v_type;
1863                         if (vap)
1864                                 VOP_GETATTR(nd.ni_vp, vap, td->td_ucred);
1865                         VOP_UNLOCK(nd.ni_vp);
1866                         vn_close(nd.ni_vp, FREAD, td->td_ucred, td);
1867                         if (type == VREG)
1868                                 return (result);
1869                 }
1870         }
1871         free(result, M_LINKER);
1872         return (NULL);
1873 }
1874
1875 #define INT_ALIGN(base, ptr)    ptr =                                   \
1876         (base) + roundup2((ptr) - (base), sizeof(int))
1877
1878 /*
1879  * Lookup KLD which contains requested module in the "linker.hints" file. If
1880  * version specification is available, then try to find the best KLD.
1881  * Otherwise just find the latest one.
1882  */
1883 static char *
1884 linker_hints_lookup(const char *path, int pathlen, const char *modname,
1885     int modnamelen, const struct mod_depend *verinfo)
1886 {
1887         struct thread *td = curthread;  /* XXX */
1888         struct ucred *cred = td ? td->td_ucred : NULL;
1889         struct nameidata nd;
1890         struct vattr vattr, mattr;
1891         const char *best, *sep;
1892         u_char *hints = NULL;
1893         u_char *cp, *recptr, *bufend, *result, *pathbuf;
1894         int error, ival, bestver, *intp, found, flags, clen, blen;
1895         ssize_t reclen;
1896
1897         result = NULL;
1898         bestver = found = 0;
1899
1900         sep = (path[pathlen - 1] != '/') ? "/" : "";
1901         reclen = imax(modnamelen, strlen(linker_hintfile)) + pathlen +
1902             strlen(sep) + 1;
1903         pathbuf = malloc(reclen, M_LINKER, M_WAITOK);
1904         snprintf(pathbuf, reclen, "%.*s%s%s", pathlen, path, sep,
1905             linker_hintfile);
1906
1907         NDINIT(&nd, LOOKUP, NOFOLLOW, UIO_SYSSPACE, pathbuf, td);
1908         flags = FREAD;
1909         error = vn_open(&nd, &flags, 0, NULL);
1910         if (error)
1911                 goto bad;
1912         NDFREE(&nd, NDF_ONLY_PNBUF);
1913         if (nd.ni_vp->v_type != VREG)
1914                 goto bad;
1915         best = cp = NULL;
1916         error = VOP_GETATTR(nd.ni_vp, &vattr, cred);
1917         if (error)
1918                 goto bad;
1919         /*
1920          * XXX: we need to limit this number to some reasonable value
1921          */
1922         if (vattr.va_size > LINKER_HINTS_MAX) {
1923                 printf("linker.hints file too large %ld\n", (long)vattr.va_size);
1924                 goto bad;
1925         }
1926         hints = malloc(vattr.va_size, M_TEMP, M_WAITOK);
1927         error = vn_rdwr(UIO_READ, nd.ni_vp, (caddr_t)hints, vattr.va_size, 0,
1928             UIO_SYSSPACE, IO_NODELOCKED, cred, NOCRED, &reclen, td);
1929         if (error)
1930                 goto bad;
1931         VOP_UNLOCK(nd.ni_vp);
1932         vn_close(nd.ni_vp, FREAD, cred, td);
1933         nd.ni_vp = NULL;
1934         if (reclen != 0) {
1935                 printf("can't read %zd\n", reclen);
1936                 goto bad;
1937         }
1938         intp = (int *)hints;
1939         ival = *intp++;
1940         if (ival != LINKER_HINTS_VERSION) {
1941                 printf("linker.hints file version mismatch %d\n", ival);
1942                 goto bad;
1943         }
1944         bufend = hints + vattr.va_size;
1945         recptr = (u_char *)intp;
1946         clen = blen = 0;
1947         while (recptr < bufend && !found) {
1948                 intp = (int *)recptr;
1949                 reclen = *intp++;
1950                 ival = *intp++;
1951                 cp = (char *)intp;
1952                 switch (ival) {
1953                 case MDT_VERSION:
1954                         clen = *cp++;
1955                         if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
1956                                 break;
1957                         cp += clen;
1958                         INT_ALIGN(hints, cp);
1959                         ival = *(int *)cp;
1960                         cp += sizeof(int);
1961                         clen = *cp++;
1962                         if (verinfo == NULL ||
1963                             ival == verinfo->md_ver_preferred) {
1964                                 found = 1;
1965                                 break;
1966                         }
1967                         if (ival >= verinfo->md_ver_minimum &&
1968                             ival <= verinfo->md_ver_maximum &&
1969                             ival > bestver) {
1970                                 bestver = ival;
1971                                 best = cp;
1972                                 blen = clen;
1973                         }
1974                         break;
1975                 default:
1976                         break;
1977                 }
1978                 recptr += reclen + sizeof(int);
1979         }
1980         /*
1981          * Finally check if KLD is in the place
1982          */
1983         if (found)
1984                 result = linker_lookup_file(path, pathlen, cp, clen, &mattr);
1985         else if (best)
1986                 result = linker_lookup_file(path, pathlen, best, blen, &mattr);
1987
1988         /*
1989          * KLD is newer than hints file. What we should do now?
1990          */
1991         if (result && timespeccmp(&mattr.va_mtime, &vattr.va_mtime, >))
1992                 printf("warning: KLD '%s' is newer than the linker.hints"
1993                     " file\n", result);
1994 bad:
1995         free(pathbuf, M_LINKER);
1996         if (hints)
1997                 free(hints, M_TEMP);
1998         if (nd.ni_vp != NULL) {
1999                 VOP_UNLOCK(nd.ni_vp);
2000                 vn_close(nd.ni_vp, FREAD, cred, td);
2001         }
2002         /*
2003          * If nothing found or hints is absent - fallback to the old
2004          * way by using "kldname[.ko]" as module name.
2005          */
2006         if (!found && !bestver && result == NULL)
2007                 result = linker_lookup_file(path, pathlen, modname,
2008                     modnamelen, NULL);
2009         return (result);
2010 }
2011
2012 /*
2013  * Lookup KLD which contains requested module in the all directories.
2014  */
2015 static char *
2016 linker_search_module(const char *modname, int modnamelen,
2017     const struct mod_depend *verinfo)
2018 {
2019         char *cp, *ep, *result;
2020
2021         /*
2022          * traverse the linker path
2023          */
2024         for (cp = linker_path; *cp; cp = ep + 1) {
2025                 /* find the end of this component */
2026                 for (ep = cp; (*ep != 0) && (*ep != ';'); ep++);
2027                 result = linker_hints_lookup(cp, ep - cp, modname,
2028                     modnamelen, verinfo);
2029                 if (result != NULL)
2030                         return (result);
2031                 if (*ep == 0)
2032                         break;
2033         }
2034         return (NULL);
2035 }
2036
2037 /*
2038  * Search for module in all directories listed in the linker_path.
2039  */
2040 static char *
2041 linker_search_kld(const char *name)
2042 {
2043         char *cp, *ep, *result;
2044         int len;
2045
2046         /* qualified at all? */
2047         if (strchr(name, '/'))
2048                 return (strdup(name, M_LINKER));
2049
2050         /* traverse the linker path */
2051         len = strlen(name);
2052         for (ep = linker_path; *ep; ep++) {
2053                 cp = ep;
2054                 /* find the end of this component */
2055                 for (; *ep != 0 && *ep != ';'; ep++);
2056                 result = linker_lookup_file(cp, ep - cp, name, len, NULL);
2057                 if (result != NULL)
2058                         return (result);
2059         }
2060         return (NULL);
2061 }
2062
2063 static const char *
2064 linker_basename(const char *path)
2065 {
2066         const char *filename;
2067
2068         filename = strrchr(path, '/');
2069         if (filename == NULL)
2070                 return path;
2071         if (filename[1])
2072                 filename++;
2073         return (filename);
2074 }
2075
2076 #ifdef HWPMC_HOOKS
2077 /*
2078  * Inform hwpmc about the set of kernel modules currently loaded.
2079  */
2080 void *
2081 linker_hwpmc_list_objects(void)
2082 {
2083         linker_file_t lf;
2084         struct pmckern_map_in *kobase;
2085         int i, nmappings;
2086
2087         nmappings = 0;
2088         sx_slock(&kld_sx);
2089         TAILQ_FOREACH(lf, &linker_files, link)
2090                 nmappings++;
2091
2092         /* Allocate nmappings + 1 entries. */
2093         kobase = malloc((nmappings + 1) * sizeof(struct pmckern_map_in),
2094             M_LINKER, M_WAITOK | M_ZERO);
2095         i = 0;
2096         TAILQ_FOREACH(lf, &linker_files, link) {
2097                 /* Save the info for this linker file. */
2098                 kobase[i].pm_file = lf->filename;
2099                 kobase[i].pm_address = (uintptr_t)lf->address;
2100                 i++;
2101         }
2102         sx_sunlock(&kld_sx);
2103
2104         KASSERT(i > 0, ("linker_hpwmc_list_objects: no kernel objects?"));
2105
2106         /* The last entry of the malloced area comprises of all zeros. */
2107         KASSERT(kobase[i].pm_file == NULL,
2108             ("linker_hwpmc_list_objects: last object not NULL"));
2109
2110         return ((void *)kobase);
2111 }
2112 #endif
2113
2114 /* check if root file system is not mounted */
2115 static bool
2116 linker_root_mounted(void)
2117 {
2118         struct pwd *pwd;
2119         bool ret;
2120
2121         if (rootvnode == NULL)
2122                 return (false);
2123
2124         pwd = pwd_hold(curthread);
2125         ret = pwd->pwd_rdir != NULL;
2126         pwd_drop(pwd);
2127         return (ret);
2128 }
2129
2130 /*
2131  * Find a file which contains given module and load it, if "parent" is not
2132  * NULL, register a reference to it.
2133  */
2134 static int
2135 linker_load_module(const char *kldname, const char *modname,
2136     struct linker_file *parent, const struct mod_depend *verinfo,
2137     struct linker_file **lfpp)
2138 {
2139         linker_file_t lfdep;
2140         const char *filename;
2141         char *pathname;
2142         int error;
2143
2144         sx_assert(&kld_sx, SA_XLOCKED);
2145         if (modname == NULL) {
2146                 /*
2147                  * We have to load KLD
2148                  */
2149                 KASSERT(verinfo == NULL, ("linker_load_module: verinfo"
2150                     " is not NULL"));
2151                 if (!linker_root_mounted())
2152                         return (ENXIO);
2153                 pathname = linker_search_kld(kldname);
2154         } else {
2155                 if (modlist_lookup2(modname, verinfo) != NULL)
2156                         return (EEXIST);
2157                 if (!linker_root_mounted())
2158                         return (ENXIO);
2159                 if (kldname != NULL)
2160                         pathname = strdup(kldname, M_LINKER);
2161                 else
2162                         /*
2163                          * Need to find a KLD with required module
2164                          */
2165                         pathname = linker_search_module(modname,
2166                             strlen(modname), verinfo);
2167         }
2168         if (pathname == NULL)
2169                 return (ENOENT);
2170
2171         /*
2172          * Can't load more than one file with the same basename XXX:
2173          * Actually it should be possible to have multiple KLDs with
2174          * the same basename but different path because they can
2175          * provide different versions of the same modules.
2176          */
2177         filename = linker_basename(pathname);
2178         if (linker_find_file_by_name(filename))
2179                 error = EEXIST;
2180         else do {
2181                 error = linker_load_file(pathname, &lfdep);
2182                 if (error)
2183                         break;
2184                 if (modname && verinfo &&
2185                     modlist_lookup2(modname, verinfo) == NULL) {
2186                         linker_file_unload(lfdep, LINKER_UNLOAD_FORCE);
2187                         error = ENOENT;
2188                         break;
2189                 }
2190                 if (parent) {
2191                         error = linker_file_add_dependency(parent, lfdep);
2192                         if (error)
2193                                 break;
2194                 }
2195                 if (lfpp)
2196                         *lfpp = lfdep;
2197         } while (0);
2198         free(pathname, M_LINKER);
2199         return (error);
2200 }
2201
2202 /*
2203  * This routine is responsible for finding dependencies of userland initiated
2204  * kldload(2)'s of files.
2205  */
2206 int
2207 linker_load_dependencies(linker_file_t lf)
2208 {
2209         linker_file_t lfdep;
2210         struct mod_metadata **start, **stop, **mdp, **nmdp;
2211         struct mod_metadata *mp, *nmp;
2212         const struct mod_depend *verinfo;
2213         modlist_t mod;
2214         const char *modname, *nmodname;
2215         int ver, error = 0;
2216
2217         /*
2218          * All files are dependent on /kernel.
2219          */
2220         sx_assert(&kld_sx, SA_XLOCKED);
2221         if (linker_kernel_file) {
2222                 linker_kernel_file->refs++;
2223                 error = linker_file_add_dependency(lf, linker_kernel_file);
2224                 if (error)
2225                         return (error);
2226         }
2227         if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop,
2228             NULL) != 0)
2229                 return (0);
2230         for (mdp = start; mdp < stop; mdp++) {
2231                 mp = *mdp;
2232                 if (mp->md_type != MDT_VERSION)
2233                         continue;
2234                 modname = mp->md_cval;
2235                 ver = ((const struct mod_version *)mp->md_data)->mv_version;
2236                 mod = modlist_lookup(modname, ver);
2237                 if (mod != NULL) {
2238                         printf("interface %s.%d already present in the KLD"
2239                             " '%s'!\n", modname, ver,
2240                             mod->container->filename);
2241                         return (EEXIST);
2242                 }
2243         }
2244
2245         for (mdp = start; mdp < stop; mdp++) {
2246                 mp = *mdp;
2247                 if (mp->md_type != MDT_DEPEND)
2248                         continue;
2249                 modname = mp->md_cval;
2250                 verinfo = mp->md_data;
2251                 nmodname = NULL;
2252                 for (nmdp = start; nmdp < stop; nmdp++) {
2253                         nmp = *nmdp;
2254                         if (nmp->md_type != MDT_VERSION)
2255                                 continue;
2256                         nmodname = nmp->md_cval;
2257                         if (strcmp(modname, nmodname) == 0)
2258                                 break;
2259                 }
2260                 if (nmdp < stop)/* early exit, it's a self reference */
2261                         continue;
2262                 mod = modlist_lookup2(modname, verinfo);
2263                 if (mod) {      /* woohoo, it's loaded already */
2264                         lfdep = mod->container;
2265                         lfdep->refs++;
2266                         error = linker_file_add_dependency(lf, lfdep);
2267                         if (error)
2268                                 break;
2269                         continue;
2270                 }
2271                 error = linker_load_module(NULL, modname, lf, verinfo, NULL);
2272                 if (error) {
2273                         printf("KLD %s: depends on %s - not available or"
2274                             " version mismatch\n", lf->filename, modname);
2275                         break;
2276                 }
2277         }
2278
2279         if (error)
2280                 return (error);
2281         linker_addmodules(lf, start, stop, 0);
2282         return (error);
2283 }
2284
2285 static int
2286 sysctl_kern_function_list_iterate(const char *name, void *opaque)
2287 {
2288         struct sysctl_req *req;
2289
2290         req = opaque;
2291         return (SYSCTL_OUT(req, name, strlen(name) + 1));
2292 }
2293
2294 /*
2295  * Export a nul-separated, double-nul-terminated list of all function names
2296  * in the kernel.
2297  */
2298 static int
2299 sysctl_kern_function_list(SYSCTL_HANDLER_ARGS)
2300 {
2301         linker_file_t lf;
2302         int error;
2303
2304 #ifdef MAC
2305         error = mac_kld_check_stat(req->td->td_ucred);
2306         if (error)
2307                 return (error);
2308 #endif
2309         error = sysctl_wire_old_buffer(req, 0);
2310         if (error != 0)
2311                 return (error);
2312         sx_xlock(&kld_sx);
2313         TAILQ_FOREACH(lf, &linker_files, link) {
2314                 error = LINKER_EACH_FUNCTION_NAME(lf,
2315                     sysctl_kern_function_list_iterate, req);
2316                 if (error) {
2317                         sx_xunlock(&kld_sx);
2318                         return (error);
2319                 }
2320         }
2321         sx_xunlock(&kld_sx);
2322         return (SYSCTL_OUT(req, "", 1));
2323 }
2324
2325 SYSCTL_PROC(_kern, OID_AUTO, function_list,
2326     CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, 0,
2327     sysctl_kern_function_list, "",
2328     "kernel function list");