Replace home-grown list iteration with methods from sys/queue.h
[dragonfly.git] / sys / kern / kern_linker.c
1 /*-
2  * Copyright (c) 1997 Doug Rabson
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  * $FreeBSD: src/sys/kern/kern_linker.c,v 1.41.2.3 2001/11/21 17:50:35 luigi Exp $
27  * $DragonFly: src/sys/kern/kern_linker.c,v 1.42 2008/01/10 10:31:48 matthias Exp $
28  */
29
30 #include "opt_ddb.h"
31
32 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/systm.h>
35 #include <sys/malloc.h>
36 #include <sys/sysproto.h>
37 #include <sys/sysent.h>
38 #include <sys/proc.h>
39 #include <sys/lock.h>
40 #include <sys/module.h>
41 #include <sys/queue.h>
42 #include <sys/linker.h>
43 #include <sys/fcntl.h>
44 #include <sys/libkern.h>
45 #include <sys/nlookup.h>
46 #include <sys/vnode.h>
47 #include <sys/sysctl.h>
48
49 #include <vm/vm_zone.h>
50
51 #ifdef _KERNEL_VIRTUAL
52 #include <dlfcn.h>
53 #endif
54
55 #ifdef KLD_DEBUG
56 int kld_debug = 0;
57 #endif
58
59 /* Metadata from the static kernel */
60 SET_DECLARE(modmetadata_set, struct mod_metadata);
61 MALLOC_DEFINE(M_LINKER, "kld", "kernel linker");
62
63 linker_file_t linker_current_file;
64 linker_file_t linker_kernel_file;
65
66 static struct lock lock;        /* lock for the file list */
67 static linker_class_list_t classes;
68 static linker_file_list_t linker_files;
69 static int next_file_id = 1;
70
71 static void
72 linker_init(void* arg)
73 {
74     lockinit(&lock, "klink", 0, 0);
75     TAILQ_INIT(&classes);
76     TAILQ_INIT(&linker_files);
77 }
78
79 SYSINIT(linker, SI_BOOT2_KLD, SI_ORDER_FIRST, linker_init, 0);
80
81 int
82 linker_add_class(const char* desc, void* priv,
83                  struct linker_class_ops* ops)
84 {
85     linker_class_t lc;
86
87     lc = kmalloc(sizeof(struct linker_class), M_LINKER, M_NOWAIT | M_ZERO);
88     if (!lc)
89         return ENOMEM;
90
91     lc->desc = desc;
92     lc->priv = priv;
93     lc->ops = ops;
94     TAILQ_INSERT_HEAD(&classes, lc, link);
95
96     return 0;
97 }
98
99 static int
100 linker_file_sysinit(linker_file_t lf)
101 {
102     struct sysinit** start, ** stop;
103     struct sysinit** sipp;
104     struct sysinit** xipp;
105     struct sysinit* save;
106     const moduledata_t *moddata;
107     int error;
108
109     KLD_DPF(FILE, ("linker_file_sysinit: calling SYSINITs for %s\n",
110                    lf->filename));
111
112     if (linker_file_lookup_set(lf, "sysinit_set", &start, &stop, NULL) != 0)
113         return 0; /* XXX is this correct ? No sysinit ? */
114
115     /* HACK ALERT! */
116     for (sipp = start; sipp < stop; sipp++) {
117         if ((*sipp)->func == module_register_init) {
118             moddata = (*sipp)->udata;
119             error = module_register(moddata, lf);
120             if (error) {
121                 kprintf("linker_file_sysinit \"%s\" failed to register! %d\n",
122                     lf->filename, error);
123                 return error;
124             }
125         }
126     }
127             
128     /*
129      * Perform a bubble sort of the system initialization objects by
130      * their subsystem (primary key) and order (secondary key).
131      *
132      * Since some things care about execution order, this is the
133      * operation which ensures continued function.
134      */
135     for (sipp = start; sipp < stop; sipp++) {
136         for (xipp = sipp + 1; xipp < stop; xipp++) {
137             if ((*sipp)->subsystem < (*xipp)->subsystem ||
138                  ((*sipp)->subsystem == (*xipp)->subsystem &&
139                   (*sipp)->order <= (*xipp)->order))
140                 continue;       /* skip*/
141             save = *sipp;
142             *sipp = *xipp;
143             *xipp = save;
144         }
145     }
146
147
148     /*
149      * Traverse the (now) ordered list of system initialization tasks.
150      * Perform each task, and continue on to the next task.
151      */
152     for (sipp = start; sipp < stop; sipp++) {
153         if ((*sipp)->subsystem == SI_SPECIAL_DUMMY)
154             continue;   /* skip dummy task(s)*/
155
156         /* Call function */
157         (*((*sipp)->func))((*sipp)->udata);
158     }
159     return 0; /* no errors */
160 }
161
162 static void
163 linker_file_sysuninit(linker_file_t lf)
164 {
165     struct sysinit** start, ** stop;
166     struct sysinit** sipp;
167     struct sysinit** xipp;
168     struct sysinit* save;
169
170     KLD_DPF(FILE, ("linker_file_sysuninit: calling SYSUNINITs for %s\n",
171                    lf->filename));
172
173     if (linker_file_lookup_set(lf, "sysuninit_set", &start, &stop, NULL) != 0)
174         return;
175
176     /*
177      * Perform a reverse bubble sort of the system initialization objects
178      * by their subsystem (primary key) and order (secondary key).
179      *
180      * Since some things care about execution order, this is the
181      * operation which ensures continued function.
182      */
183     for (sipp = start; sipp < stop; sipp++) {
184         for (xipp = sipp + 1; xipp < stop; xipp++) {
185             if ((*sipp)->subsystem > (*xipp)->subsystem ||
186                  ((*sipp)->subsystem == (*xipp)->subsystem &&
187                   (*sipp)->order >= (*xipp)->order))
188                 continue;       /* skip*/
189             save = *sipp;
190             *sipp = *xipp;
191             *xipp = save;
192         }
193     }
194
195
196     /*
197      * Traverse the (now) ordered list of system initialization tasks.
198      * Perform each task, and continue on to the next task.
199      */
200     for (sipp = start; sipp < stop; sipp++) {
201         if ((*sipp)->subsystem == SI_SPECIAL_DUMMY)
202             continue;   /* skip dummy task(s)*/
203
204         /* Call function */
205         (*((*sipp)->func))((*sipp)->udata);
206     }
207 }
208
209 static void
210 linker_file_register_sysctls(linker_file_t lf)
211 {
212     struct sysctl_oid **start, **stop, **oidp;
213
214     KLD_DPF(FILE, ("linker_file_register_sysctls: registering SYSCTLs for %s\n",
215                    lf->filename));
216
217     if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
218         return;
219     for (oidp = start; oidp < stop; oidp++)
220         sysctl_register_oid(*oidp);
221 }
222
223 static void
224 linker_file_unregister_sysctls(linker_file_t lf)
225 {
226     struct sysctl_oid **start, **stop, **oidp;
227
228     KLD_DPF(FILE, ("linker_file_unregister_sysctls: registering SYSCTLs for %s\n",
229                    lf->filename));
230
231     if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
232         return;
233     for (oidp = start; oidp < stop; oidp++)
234         sysctl_unregister_oid(*oidp);
235 }
236
237 int
238 linker_load_file(const char* filename, linker_file_t* result)
239 {
240     linker_class_t lc;
241     linker_file_t lf;
242     int foundfile, error = 0;
243     char *koname = NULL;
244
245     /* Refuse to load modules if securelevel raised */
246     if (securelevel > 0 || kernel_mem_readonly)
247         return EPERM; 
248
249     lf = linker_find_file_by_name(filename);
250     if (lf) {
251         KLD_DPF(FILE, ("linker_load_file: file %s is already loaded, incrementing refs\n", filename));
252         *result = lf;
253         lf->refs++;
254         goto out;
255     }
256     if (find_mod_metadata(filename)) {
257         if (linker_kernel_file)
258             ++linker_kernel_file->refs;
259         *result = linker_kernel_file;
260         goto out;
261     }
262
263     koname = kmalloc(strlen(filename) + 4, M_LINKER, M_WAITOK);
264     ksprintf(koname, "%s.ko", filename);
265     lf = NULL;
266     foundfile = 0;
267     TAILQ_FOREACH(lc, &classes, link) {
268         KLD_DPF(FILE, ("linker_load_file: trying to load %s as %s\n",
269                        filename, lc->desc));
270
271         error = lc->ops->load_file(koname, &lf);        /* First with .ko */
272         if (lf == NULL && error == ENOENT)
273             error = lc->ops->load_file(filename, &lf);  /* Then try without */
274         /*
275          * If we got something other than ENOENT, then it exists but we cannot
276          * load it for some other reason.
277          */
278         if (error != ENOENT)
279             foundfile = 1;
280         if (lf) {
281             linker_file_register_sysctls(lf);
282             error = linker_file_sysinit(lf);
283
284             *result = lf;
285             goto out;
286         }
287     }
288     /*
289      * Less than ideal, but tells the user whether it failed to load or
290      * the module was not found.
291      */
292     if (foundfile) {
293             /*
294              * Format not recognized or otherwise unloadable.
295              * When loading a module that is statically built into
296              * the kernel EEXIST percolates back up as the return
297              * value.  Preserve this so that apps can recognize this
298              * special case.
299              */
300             if (error != EEXIST)
301                     error = ENOEXEC;
302     } else {
303         error = ENOENT;         /* Nothing found */
304     }
305
306 out:
307     if (koname)
308         kfree(koname, M_LINKER);
309     return error;
310 }
311
312 linker_file_t
313 linker_find_file_by_name(const char* filename)
314 {
315     linker_file_t lf = 0;
316     char *koname;
317     int i;
318
319     for (i = strlen(filename); i > 0 && filename[i-1] != '/'; --i)
320         ;
321     filename += i;
322
323     koname = kmalloc(strlen(filename) + 4, M_LINKER, M_WAITOK);
324     ksprintf(koname, "%s.ko", filename);
325
326     lockmgr(&lock, LK_SHARED);
327     TAILQ_FOREACH(lf, &linker_files, link) {
328         if (!strcmp(lf->filename, koname))
329             break;
330         if (!strcmp(lf->filename, filename))
331             break;
332     }
333     lockmgr(&lock, LK_RELEASE);
334
335     if (koname)
336         kfree(koname, M_LINKER);
337     return lf;
338 }
339
340 linker_file_t
341 linker_find_file_by_id(int fileid)
342 {
343     linker_file_t lf = 0;
344
345     lockmgr(&lock, LK_SHARED);
346     TAILQ_FOREACH(lf, &linker_files, link)
347         if (lf->id == fileid)
348             break;
349     lockmgr(&lock, LK_RELEASE);
350
351     return lf;
352 }
353
354 linker_file_t
355 linker_make_file(const char* pathname, void* priv, struct linker_file_ops* ops)
356 {
357     linker_file_t lf = 0;
358     int namelen;
359     const char *filename;
360
361     filename = rindex(pathname, '/');
362     if (filename && filename[1])
363         filename++;
364     else
365         filename = pathname;
366
367     KLD_DPF(FILE, ("linker_make_file: new file, filename=%s\n", filename));
368     lockmgr(&lock, LK_EXCLUSIVE);
369     namelen = strlen(filename) + 1;
370     lf = kmalloc(sizeof(struct linker_file) + namelen, M_LINKER, M_WAITOK);
371     bzero(lf, sizeof(*lf));
372
373     lf->refs = 1;
374     lf->userrefs = 0;
375     lf->flags = 0;
376     lf->filename = (char*) (lf + 1);
377     strcpy(lf->filename, filename);
378     lf->id = next_file_id++;
379     lf->ndeps = 0;
380     lf->deps = NULL;
381     STAILQ_INIT(&lf->common);
382     TAILQ_INIT(&lf->modules);
383
384     lf->priv = priv;
385     lf->ops = ops;
386     TAILQ_INSERT_TAIL(&linker_files, lf, link);
387
388     lockmgr(&lock, LK_RELEASE);
389     return lf;
390 }
391
392 int
393 linker_file_unload(linker_file_t file)
394 {
395     module_t mod, next;
396     struct common_symbol* cp;
397     int error = 0;
398     int i;
399
400     /* Refuse to unload modules if securelevel raised */
401     if (securelevel > 0 || kernel_mem_readonly)
402         return EPERM; 
403
404     KLD_DPF(FILE, ("linker_file_unload: lf->refs=%d\n", file->refs));
405     lockmgr(&lock, LK_EXCLUSIVE);
406     if (file->refs == 1) {
407         KLD_DPF(FILE, ("linker_file_unload: file is unloading, informing modules\n"));
408         /*
409          * Temporarily bump file->refs to prevent recursive unloading
410          */
411         ++file->refs;
412
413         /*
414          * Inform any modules associated with this file.
415          */
416         mod = TAILQ_FIRST(&file->modules);
417         while (mod) {
418             /*
419              * Give the module a chance to veto the unload.  Note that the
420              * act of unloading the module may cause other modules in the
421              * same file list to be unloaded recursively.
422              */
423             if ((error = module_unload(mod)) != 0) {
424                 KLD_DPF(FILE, ("linker_file_unload: module %x vetoes unload\n",
425                                mod));
426                 lockmgr(&lock, LK_RELEASE);
427                 file->refs--;
428                 goto out;
429             }
430
431             /*
432              * Recursive relationships may prevent the release from
433              * immediately removing the module, or may remove other
434              * modules in the list.
435              */
436             next = module_getfnext(mod);
437             module_release(mod);
438             mod = next;
439         }
440
441         /*
442          * Since we intend to destroy the file structure, we expect all
443          * modules to have been removed by now.
444          */
445         for (mod = TAILQ_FIRST(&file->modules); 
446              mod; 
447              mod = module_getfnext(mod)
448         ) {
449             kprintf("linker_file_unload: module %p still has refs!\n", mod);
450         }
451         --file->refs;
452     }
453
454     file->refs--;
455     if (file->refs > 0) {
456         lockmgr(&lock, LK_RELEASE);
457         goto out;
458     }
459
460     /* Don't try to run SYSUNINITs if we are unloaded due to a link error */
461     if (file->flags & LINKER_FILE_LINKED) {
462         linker_file_sysuninit(file);
463         linker_file_unregister_sysctls(file);
464     }
465
466     TAILQ_REMOVE(&linker_files, file, link);
467     lockmgr(&lock, LK_RELEASE);
468
469     for (i = 0; i < file->ndeps; i++)
470         linker_file_unload(file->deps[i]);
471     kfree(file->deps, M_LINKER);
472
473     for (cp = STAILQ_FIRST(&file->common); cp;
474          cp = STAILQ_FIRST(&file->common)) {
475         STAILQ_REMOVE(&file->common, cp, common_symbol, link);
476         kfree(cp, M_LINKER);
477     }
478
479     file->ops->unload(file);
480     kfree(file, M_LINKER);
481
482 out:
483     return error;
484 }
485
486 int
487 linker_file_add_dependancy(linker_file_t file, linker_file_t dep)
488 {
489     linker_file_t* newdeps;
490
491     newdeps = kmalloc((file->ndeps + 1) * sizeof(linker_file_t*),
492                      M_LINKER, M_WAITOK | M_ZERO);
493
494     if (file->deps) {
495         bcopy(file->deps, newdeps, file->ndeps * sizeof(linker_file_t*));
496         kfree(file->deps, M_LINKER);
497     }
498     file->deps = newdeps;
499     file->deps[file->ndeps] = dep;
500     file->ndeps++;
501
502     return 0;
503 }
504
505 /*
506  * Locate a linker set and its contents.
507  * This is a helper function to avoid linker_if.h exposure elsewhere.
508  * Note: firstp and lastp are really void ***
509  */
510 int
511 linker_file_lookup_set(linker_file_t file, const char *name,
512                       void *firstp, void *lastp, int *countp)
513 {
514     return file->ops->lookup_set(file, name, firstp, lastp, countp);
515 }
516
517 int
518 linker_file_lookup_symbol(linker_file_t file, const char* name, int deps, caddr_t *raddr)
519 {
520     c_linker_sym_t sym;
521     linker_symval_t symval;
522     linker_file_t lf;
523     size_t common_size = 0;
524     int i;
525
526     KLD_DPF(SYM, ("linker_file_lookup_symbol: file=%x, name=%s, deps=%d\n",
527                   file, name, deps));
528
529     if (file->ops->lookup_symbol(file, name, &sym) == 0) {
530         file->ops->symbol_values(file, sym, &symval);
531
532         /*
533          * XXX Assume a common symbol if its value is 0 and it has a non-zero
534          * size, otherwise it could be an absolute symbol with a value of 0.
535          */
536         if (symval.value == 0 && symval.size != 0) {
537             /*
538              * For commons, first look them up in the dependancies and
539              * only allocate space if not found there.
540              */
541             common_size = symval.size;
542         } else {
543             KLD_DPF(SYM, ("linker_file_lookup_symbol: symbol.value=%x\n", symval.value));
544             *raddr = symval.value;
545             return 0;
546         }
547     }
548     if (deps) {
549         for (i = 0; i < file->ndeps; i++) {
550             if (linker_file_lookup_symbol(file->deps[i], name, 0, raddr) == 0) {
551                 KLD_DPF(SYM, ("linker_file_lookup_symbol: deps value=%x\n", *raddr));
552                 return 0;
553             }
554         }
555
556         /* If we have not found it in the dependencies, search globally */
557         TAILQ_FOREACH(lf, &linker_files, link) {
558             /* But skip the current file if it's on the list */
559             if (lf == file)
560                 continue;
561             /* And skip the files we searched above */
562             for (i = 0; i < file->ndeps; i++)
563                 if (lf == file->deps[i])
564                     break;
565             if (i < file->ndeps)
566                 continue;
567             if (linker_file_lookup_symbol(lf, name, 0, raddr) == 0) {
568                 KLD_DPF(SYM, ("linker_file_lookup_symbol: global value=%x\n", *raddr));
569                 return 0;
570             }
571         }
572     }
573
574     if (common_size > 0) {
575         /*
576          * This is a common symbol which was not found in the
577          * dependancies.  We maintain a simple common symbol table in
578          * the file object.
579          */
580         struct common_symbol* cp;
581
582         STAILQ_FOREACH(cp, &file->common, link)
583             if (!strcmp(cp->name, name)) {
584                 KLD_DPF(SYM, ("linker_file_lookup_symbol: old common value=%x\n", cp->address));
585                 *raddr = cp->address;
586                 return 0;
587             }
588
589         /*
590          * Round the symbol size up to align.
591          */
592         common_size = (common_size + sizeof(int) - 1) & -sizeof(int);
593         cp = kmalloc(sizeof(struct common_symbol)
594                     + common_size
595                     + strlen(name) + 1,
596                     M_LINKER, M_WAITOK | M_ZERO);
597
598         cp->address = (caddr_t) (cp + 1);
599         cp->name = cp->address + common_size;
600         strcpy(cp->name, name);
601         bzero(cp->address, common_size);
602         STAILQ_INSERT_TAIL(&file->common, cp, link);
603
604         KLD_DPF(SYM, ("linker_file_lookup_symbol: new common value=%x\n", cp->address));
605         *raddr = cp->address;
606         return 0;
607     }
608
609 #ifdef _KERNEL_VIRTUAL
610     *raddr = dlsym(RTLD_NEXT, name);
611     if (*raddr != NULL) {
612         KLD_DPF(SYM, ("linker_file_lookup_symbol: found dlsym=%x\n", *raddr));
613         return 0;
614     }
615 #endif
616
617     KLD_DPF(SYM, ("linker_file_lookup_symbol: fail\n"));
618     return ENOENT;
619 }
620
621 #ifdef DDB
622 /*
623  * DDB Helpers.  DDB has to look across multiple files with their own
624  * symbol tables and string tables.
625  *
626  * Note that we do not obey list locking protocols here.  We really don't
627  * need DDB to hang because somebody's got the lock held.  We'll take the
628  * chance that the files list is inconsistant instead.
629  */
630
631 int
632 linker_ddb_lookup(const char *symstr, c_linker_sym_t *sym)
633 {
634     linker_file_t lf;
635
636     TAILQ_FOREACH(lf, &linker_files, link) {
637         if (lf->ops->lookup_symbol(lf, symstr, sym) == 0)
638             return 0;
639     }
640     return ENOENT;
641 }
642
643 int
644 linker_ddb_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
645 {
646     linker_file_t lf;
647     u_long off = (uintptr_t)value;
648     u_long diff, bestdiff;
649     c_linker_sym_t best;
650     c_linker_sym_t es;
651
652     best = 0;
653     bestdiff = off;
654     TAILQ_FOREACH(lf, &linker_files, link) {
655         if (lf->ops->search_symbol(lf, value, &es, &diff) != 0)
656             continue;
657         if (es != 0 && diff < bestdiff) {
658             best = es;
659             bestdiff = diff;
660         }
661         if (bestdiff == 0)
662             break;
663     }
664     if (best) {
665         *sym = best;
666         *diffp = bestdiff;
667         return 0;
668     } else {
669         *sym = 0;
670         *diffp = off;
671         return ENOENT;
672     }
673 }
674
675 int
676 linker_ddb_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
677 {
678     linker_file_t lf;
679
680     TAILQ_FOREACH(lf, &linker_files, link) {
681         if (lf->ops->symbol_values(lf, sym, symval) == 0)
682             return 0;
683     }
684     return ENOENT;
685 }
686
687 #endif
688
689 /*
690  * Syscalls.
691  */
692
693 int
694 sys_kldload(struct kldload_args *uap)
695 {
696     struct thread *td = curthread;
697     char* filename = NULL, *modulename;
698     linker_file_t lf;
699     int error = 0;
700
701     uap->sysmsg_result = -1;
702
703     if (securelevel > 0 || kernel_mem_readonly) /* redundant, but that's OK */
704         return EPERM;
705
706     if ((error = suser(td)) != 0)
707         return error;
708
709     filename = kmalloc(MAXPATHLEN, M_TEMP, M_WAITOK);
710     if ((error = copyinstr(uap->file, filename, MAXPATHLEN, NULL)) != 0)
711         goto out;
712
713     /* Can't load more than one module with the same name */
714     modulename = rindex(filename, '/');
715     if (modulename == NULL)
716         modulename = filename;
717     else
718         modulename++;
719     if (linker_find_file_by_name(modulename)) {
720         error = EEXIST;
721         goto out;
722     }
723
724     if ((error = linker_load_file(filename, &lf)) != 0)
725         goto out;
726
727     lf->userrefs++;
728     uap->sysmsg_result = lf->id;
729
730 out:
731     if (filename)
732         kfree(filename, M_TEMP);
733     return error;
734 }
735
736 int
737 sys_kldunload(struct kldunload_args *uap)
738 {
739     struct thread *td = curthread;
740     linker_file_t lf;
741     int error = 0;
742
743     if (securelevel > 0 || kernel_mem_readonly) /* redundant, but that's OK */
744         return EPERM;
745
746     if ((error = suser(td)) != 0)
747         return error;
748
749     lf = linker_find_file_by_id(uap->fileid);
750     if (lf) {
751         KLD_DPF(FILE, ("kldunload: lf->userrefs=%d\n", lf->userrefs));
752         if (lf->userrefs == 0) {
753             kprintf("linkerunload: attempt to unload file that was loaded by the kernel\n");
754             error = EBUSY;
755             goto out;
756         }
757         lf->userrefs--;
758         error = linker_file_unload(lf);
759         if (error)
760             lf->userrefs++;
761     } else
762         error = ENOENT;
763
764 out:
765     return error;
766 }
767
768 int
769 sys_kldfind(struct kldfind_args *uap)
770 {
771     char *filename = NULL, *modulename;
772     linker_file_t lf;
773     int error = 0;
774
775     uap->sysmsg_result = -1;
776
777     filename = kmalloc(MAXPATHLEN, M_TEMP, M_WAITOK);
778     if ((error = copyinstr(uap->file, filename, MAXPATHLEN, NULL)) != 0)
779         goto out;
780
781     modulename = rindex(filename, '/');
782     if (modulename == NULL)
783         modulename = filename;
784
785     lf = linker_find_file_by_name(modulename);
786     if (lf)
787         uap->sysmsg_result = lf->id;
788     else
789         error = ENOENT;
790
791 out:
792     if (filename)
793         kfree(filename, M_TEMP);
794     return error;
795 }
796
797 int
798 sys_kldnext(struct kldnext_args *uap)
799 {
800     linker_file_t lf;
801     int error = 0;
802
803     if (uap->fileid == 0) {
804         if (TAILQ_FIRST(&linker_files))
805             uap->sysmsg_result = TAILQ_FIRST(&linker_files)->id;
806         else
807             uap->sysmsg_result = 0;
808         return 0;
809     }
810
811     lf = linker_find_file_by_id(uap->fileid);
812     if (lf) {
813         if (TAILQ_NEXT(lf, link))
814             uap->sysmsg_result = TAILQ_NEXT(lf, link)->id;
815         else
816             uap->sysmsg_result = 0;
817     } else
818         error = ENOENT;
819
820     return error;
821 }
822
823 int
824 sys_kldstat(struct kldstat_args *uap)
825 {
826     linker_file_t lf;
827     int error = 0;
828     int version;
829     struct kld_file_stat* stat;
830     int namelen;
831
832     lf = linker_find_file_by_id(uap->fileid);
833     if (!lf) {
834         error = ENOENT;
835         goto out;
836     }
837
838     stat = uap->stat;
839
840     /*
841      * Check the version of the user's structure.
842      */
843     if ((error = copyin(&stat->version, &version, sizeof(version))) != 0)
844         goto out;
845     if (version != sizeof(struct kld_file_stat)) {
846         error = EINVAL;
847         goto out;
848     }
849
850     namelen = strlen(lf->filename) + 1;
851     if (namelen > MAXPATHLEN)
852         namelen = MAXPATHLEN;
853     if ((error = copyout(lf->filename, &stat->name[0], namelen)) != 0)
854         goto out;
855     if ((error = copyout(&lf->refs, &stat->refs, sizeof(int))) != 0)
856         goto out;
857     if ((error = copyout(&lf->id, &stat->id, sizeof(int))) != 0)
858         goto out;
859     if ((error = copyout(&lf->address, &stat->address, sizeof(caddr_t))) != 0)
860         goto out;
861     if ((error = copyout(&lf->size, &stat->size, sizeof(size_t))) != 0)
862         goto out;
863
864     uap->sysmsg_result = 0;
865
866 out:
867     return error;
868 }
869
870 int
871 sys_kldfirstmod(struct kldfirstmod_args *uap)
872 {
873     linker_file_t lf;
874     int error = 0;
875
876     lf = linker_find_file_by_id(uap->fileid);
877     if (lf) {
878         if (TAILQ_FIRST(&lf->modules))
879             uap->sysmsg_result = module_getid(TAILQ_FIRST(&lf->modules));
880         else
881             uap->sysmsg_result = 0;
882     } else
883         error = ENOENT;
884
885     return error;
886 }
887
888 int
889 sys_kldsym(struct kldsym_args *uap)
890 {
891     char *symstr = NULL;
892     c_linker_sym_t sym;
893     linker_symval_t symval;
894     linker_file_t lf;
895     struct kld_sym_lookup lookup;
896     int error = 0;
897
898     if ((error = copyin(uap->data, &lookup, sizeof(lookup))) != 0)
899         goto out;
900     if (lookup.version != sizeof(lookup) || uap->cmd != KLDSYM_LOOKUP) {
901         error = EINVAL;
902         goto out;
903     }
904
905     symstr = kmalloc(MAXPATHLEN, M_TEMP, M_WAITOK);
906     if ((error = copyinstr(lookup.symname, symstr, MAXPATHLEN, NULL)) != 0)
907         goto out;
908
909     if (uap->fileid != 0) {
910         lf = linker_find_file_by_id(uap->fileid);
911         if (lf == NULL) {
912             error = ENOENT;
913             goto out;
914         }
915         if (lf->ops->lookup_symbol(lf, symstr, &sym) == 0 &&
916             lf->ops->symbol_values(lf, sym, &symval) == 0) {
917             lookup.symvalue = (uintptr_t)symval.value;
918             lookup.symsize = symval.size;
919             error = copyout(&lookup, uap->data, sizeof(lookup));
920         } else
921             error = ENOENT;
922     } else {
923         TAILQ_FOREACH(lf, &linker_files, link) {
924             if (lf->ops->lookup_symbol(lf, symstr, &sym) == 0 &&
925                 lf->ops->symbol_values(lf, sym, &symval) == 0) {
926                 lookup.symvalue = (uintptr_t)symval.value;
927                 lookup.symsize = symval.size;
928                 error = copyout(&lookup, uap->data, sizeof(lookup));
929                 break;
930             }
931         }
932         if (!lf)
933             error = ENOENT;
934     }
935 out:
936     if (symstr)
937         kfree(symstr, M_TEMP);
938     return error;
939 }
940
941 /*
942  * Look for module metadata in the static kernel
943  */
944 struct mod_metadata *
945 find_mod_metadata(const char *modname)
946 {
947     int len;
948     struct mod_metadata **mdp;
949     struct mod_metadata *mdt;
950
951     /*
952      * Strip path prefixes and any dot extension.  MDT_MODULE names
953      * are just the module name without a path or ".ko".
954      */
955     for (len = strlen(modname) - 1; len >= 0; --len) {
956         if (modname[len] == '/')
957             break;
958     }
959     modname += len + 1;
960     for (len = 0; modname[len] && modname[len] != '.'; ++len)
961         ;
962
963     /*
964      * Look for the module declaration
965      */
966     SET_FOREACH(mdp, modmetadata_set) {
967         mdt = *mdp;
968         if (mdt->md_type != MDT_MODULE)
969             continue;
970         if (strlen(mdt->md_cval) == len &&
971             strncmp(mdt->md_cval, modname, len) == 0) {
972             return(mdt);
973         }
974     }
975     return(NULL);
976 }
977
978 /*
979  * Preloaded module support
980  */
981 static void
982 linker_preload(void* arg)
983 {
984     caddr_t             modptr;
985     char                *modname;
986     char                *modtype;
987     linker_file_t       lf;
988     linker_class_t      lc;
989     int                 error;
990     struct sysinit      **sipp;
991     const moduledata_t  *moddata;
992     struct sysinit      **si_start, **si_stop;
993
994     modptr = NULL;
995     while ((modptr = preload_search_next_name(modptr)) != NULL) {
996         modname = (char *)preload_search_info(modptr, MODINFO_NAME);
997         modtype = (char *)preload_search_info(modptr, MODINFO_TYPE);
998         if (modname == NULL) {
999             kprintf("Preloaded module at %p does not have a name!\n", modptr);
1000             continue;
1001         }
1002         if (modtype == NULL) {
1003             kprintf("Preloaded module at %p does not have a type!\n", modptr);
1004             continue;
1005         }
1006
1007         /*
1008          * This is a hack at the moment, but what's in FreeBSD-5 is even 
1009          * worse so I'd rather the hack.
1010          */
1011         kprintf("Preloaded %s \"%s\" at %p", modtype, modname, modptr);
1012         if (find_mod_metadata(modname)) {
1013             kprintf(" (ignored, already in static kernel)\n");
1014             continue;
1015         }
1016         kprintf(".\n");
1017
1018         lf = linker_find_file_by_name(modname);
1019         if (lf) {
1020             lf->refs++;
1021             lf->userrefs++;
1022             continue;
1023         }
1024         lf = NULL;
1025         TAILQ_FOREACH(lc, &classes, link) {
1026             error = lc->ops->load_file(modname, &lf);
1027             if (error) {
1028                 lf = NULL;
1029                 break;
1030             }
1031         }
1032         if (lf) {
1033             lf->userrefs++;
1034
1035             if (linker_file_lookup_set(lf, "sysinit_set", &si_start, &si_stop, NULL) == 0) {
1036                 /* HACK ALERT!
1037                  * This is to set the sysinit moduledata so that the module
1038                  * can attach itself to the correct containing file.
1039                  * The sysinit could be run at *any* time.
1040                  */
1041                 for (sipp = si_start; sipp < si_stop; sipp++) {
1042                     if ((*sipp)->func == module_register_init) {
1043                         moddata = (*sipp)->udata;
1044                         error = module_register(moddata, lf);
1045                         if (error)
1046                             kprintf("Preloaded %s \"%s\" failed to register: %d\n",
1047                                 modtype, modname, error);
1048                     }
1049                 }
1050                 sysinit_add(si_start, si_stop);
1051             }
1052             linker_file_register_sysctls(lf);
1053         }
1054     }
1055 }
1056
1057 SYSINIT(preload, SI_BOOT2_KLD, SI_ORDER_MIDDLE, linker_preload, 0);
1058
1059 /*
1060  * Search for a not-loaded module by name.
1061  *
1062  * Modules may be found in the following locations:
1063  *
1064  * - preloaded (result is just the module name)
1065  * - on disk (result is full path to module)
1066  *
1067  * If the module name is qualified in any way (contains path, etc.)
1068  * the we simply return a copy of it.
1069  *
1070  * The search path can be manipulated via sysctl.  Note that we use the ';'
1071  * character as a separator to be consistent with the bootloader.
1072  */
1073
1074 static char linker_path[MAXPATHLEN] = "/;/boot;/modules";
1075
1076 SYSCTL_STRING(_kern, OID_AUTO, module_path, CTLFLAG_RW, linker_path,
1077               sizeof(linker_path), "module load search path");
1078 TUNABLE_STR("module_path", linker_path, sizeof(linker_path));
1079
1080 static char *
1081 linker_strdup(const char *str)
1082 {
1083     char        *result;
1084
1085     result = kmalloc(strlen(str) + 1, M_LINKER, M_WAITOK);
1086     strcpy(result, str);
1087     return(result);
1088 }
1089
1090 char *
1091 linker_search_path(const char *name)
1092 {
1093     struct nlookupdata  nd;
1094     char                *cp, *ep, *result;
1095     size_t              name_len, prefix_len;
1096     int                 sep;
1097     int                 error;
1098     enum vtype          type;
1099
1100     /* qualified at all? */
1101     if (index(name, '/'))
1102         return(linker_strdup(name));
1103
1104     /* traverse the linker path */
1105     cp = linker_path;
1106     name_len = strlen(name);
1107     for (;;) {
1108
1109         /* find the end of this component */
1110         for (ep = cp; (*ep != 0) && (*ep != ';'); ep++)
1111             ;
1112         prefix_len = ep - cp;
1113         /* if this component doesn't end with a slash, add one */
1114         if (ep == cp || *(ep - 1) != '/')
1115             sep = 1;
1116         else
1117             sep = 0;
1118
1119         /*
1120          * +2 : possible separator, plus terminator.
1121          */
1122         result = kmalloc(prefix_len + name_len + 2, M_LINKER, M_WAITOK);
1123
1124         strncpy(result, cp, prefix_len);
1125         if (sep)
1126             result[prefix_len++] = '/';
1127         strcpy(result + prefix_len, name);
1128
1129         /*
1130          * Attempt to open the file, and return the path if we succeed and it's
1131          * a regular file.
1132          */
1133         error = nlookup_init(&nd, result, UIO_SYSSPACE, NLC_FOLLOW|NLC_LOCKVP);
1134         if (error == 0)
1135             error = vn_open(&nd, NULL, FREAD, 0);
1136         if (error == 0) {
1137             type = nd.nl_open_vp->v_type;
1138             if (type == VREG) {
1139                 nlookup_done(&nd);
1140                 return (result);
1141             }
1142         }
1143         nlookup_done(&nd);
1144         kfree(result, M_LINKER);
1145
1146         if (*ep == 0)
1147             break;
1148         cp = ep + 1;
1149     }
1150     return(NULL);
1151 }