Fully synchronize sys/boot from FreeBSD-5.x, but add / to the module path
[dragonfly.git] / sys / kern / link_aout.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/link_aout.c,v 1.26 1999/12/24 15:33:36 bde Exp $
27  * $DragonFly: src/sys/kern/link_aout.c,v 1.8 2003/11/10 06:12:13 dillon Exp $
28  */
29
30 #ifndef __alpha__
31
32 #define FREEBSD_AOUT    1
33
34 #include <sys/param.h>
35 #include <sys/kernel.h>
36 #include <sys/systm.h>
37 #include <sys/types.h>
38 #include <sys/malloc.h>
39 #include <sys/proc.h>
40 #include <sys/namei.h>
41 #include <sys/fcntl.h>
42 #include <sys/vnode.h>
43 #include <sys/linker.h>
44
45 #include <vm/vm_zone.h>
46
47 #ifndef __ELF__
48 #include <vm/vm.h>
49 #include <vm/pmap.h>
50 #include <machine/vmparam.h>
51 #endif
52
53 #include <machine/exec.h>
54 #include <sys/imgact_aout.h>
55 #include <machine/reloc.h>
56 #define _AOUT_INCLUDE_
57 #include <sys/nlist_aout.h>
58 #include <sys/link_aout.h>
59
60 static int              link_aout_load_module(const char*, linker_file_t*);
61
62 static int              link_aout_load_file(const char*, linker_file_t*);
63
64 static int              link_aout_lookup_symbol(linker_file_t, const char*,
65                                                 c_linker_sym_t*);
66 static int              link_aout_symbol_values(linker_file_t file, c_linker_sym_t sym,
67                                                 linker_symval_t* symval);
68 static int              link_aout_search_symbol(linker_file_t lf, caddr_t value,
69                                                 c_linker_sym_t* sym, long* diffp);
70 static void             link_aout_unload_file(linker_file_t);
71 static void             link_aout_unload_module(linker_file_t);
72 static int              link_aout_lookup_set(linker_file_t lf, const char *name,
73                                 void ***startp, void ***stopp, int *countp);
74
75 static struct linker_class_ops link_aout_class_ops = {
76     link_aout_load_module,
77 };
78
79 static struct linker_file_ops link_aout_file_ops = {
80     link_aout_lookup_symbol,
81     link_aout_symbol_values,
82     link_aout_search_symbol,
83     link_aout_unload_file,
84     link_aout_lookup_set
85 };
86 static struct linker_file_ops link_aout_module_ops = {
87     link_aout_lookup_symbol,
88     link_aout_symbol_values,
89     link_aout_search_symbol,
90     link_aout_unload_module,
91     link_aout_lookup_set
92 };
93
94 typedef struct aout_file {
95     char*               address;        /* Load address */
96     struct _dynamic*    dynamic;        /* Symbol table etc. */
97 } *aout_file_t;
98
99 static int              load_dependancies(linker_file_t lf);
100 static int              relocate_file(linker_file_t lf);
101
102 /*
103  * The kernel symbol table starts here.
104  */
105 extern struct _dynamic _DYNAMIC;
106
107 static void
108 link_aout_init(void* arg)
109 {
110 #ifndef __ELF__
111     struct _dynamic* dp = &_DYNAMIC;
112 #endif
113
114     linker_add_class("a.out", NULL, &link_aout_class_ops);
115
116 #ifndef __ELF__
117     if (dp) {
118         aout_file_t af;
119
120         af = malloc(sizeof(struct aout_file), M_LINKER, M_NOWAIT);
121         if (af == NULL)
122             panic("link_aout_init: Can't create linker structures for kernel");
123         bzero(af, sizeof(*af));
124
125         af->address = 0;
126         af->dynamic = dp;
127         linker_kernel_file =
128             linker_make_file(kernelname, af, &link_aout_file_ops);
129         if (linker_kernel_file == NULL)
130             panic("link_aout_init: Can't create linker structures for kernel");
131         linker_kernel_file->address = (caddr_t) KERNBASE;
132         linker_kernel_file->size = -(long)linker_kernel_file->address;
133         linker_current_file = linker_kernel_file;
134         linker_kernel_file->flags |= LINKER_FILE_LINKED;
135     }
136 #endif
137 }
138
139 SYSINIT(link_aout, SI_SUB_KLD, SI_ORDER_THIRD, link_aout_init, 0);
140
141 static int
142 link_aout_load_module(const char* filename, linker_file_t* result)
143 {
144     caddr_t             modptr, baseptr;
145     char                *type;
146     struct exec         *ehdr;
147     aout_file_t         af;
148     linker_file_t       lf;
149     int                 error;
150     
151     /* Look to see if we have the module preloaded. */
152     if ((modptr = preload_search_by_name(filename)) == NULL)
153         return(link_aout_load_file(filename, result));
154
155     /* It's preloaded, check we can handle it and collect information. */
156     if (((type = (char *)preload_search_info(modptr, MODINFO_TYPE)) == NULL) ||
157         strcmp(type, "a.out module") ||
158         ((baseptr = preload_search_info(modptr, MODINFO_ADDR)) == NULL) ||
159         ((ehdr = (struct exec *)preload_search_info(modptr, MODINFO_METADATA | MODINFOMD_AOUTEXEC)) == NULL))
160         return(0);                      /* we can't handle this */
161
162     /* Looks like we can handle this one */
163     af = malloc(sizeof(struct aout_file), M_LINKER, M_WAITOK);
164     bzero(af, sizeof(*af));
165     af->address = baseptr;
166
167     /* Assume _DYNAMIC is the first data item. */
168     af->dynamic = (struct _dynamic*)(af->address + ehdr->a_text);
169     if (af->dynamic->d_version != LD_VERSION_BSD) {
170         free(af, M_LINKER);
171         return(0);                      /* we can't handle this */
172     }
173     af->dynamic->d_un.d_sdt = (struct section_dispatch_table *)
174         ((char *)af->dynamic->d_un.d_sdt + (vm_offset_t)af->address);
175
176     /* Register with kld */
177     lf = linker_make_file(filename, af, &link_aout_module_ops);
178     if (lf == NULL) {
179         free(af, M_LINKER);
180         return(ENOMEM);
181     }
182     lf->address = af->address;
183     lf->size = ehdr->a_text + ehdr->a_data + ehdr->a_bss;
184
185     /* Try to load dependancies */
186     if (((error = load_dependancies(lf)) != 0) ||
187         ((error = relocate_file(lf)) != 0)) {
188         linker_file_unload(lf);
189         return(error);
190     }
191     lf->flags |= LINKER_FILE_LINKED;
192     *result = lf;
193     return(0);
194 }
195
196 static int
197 link_aout_load_file(const char* filename, linker_file_t* result)
198 {
199     struct nameidata nd;
200     struct thread *td = curthread;
201     struct proc *p = td->td_proc;
202     int error = 0;
203     int resid;
204     struct exec header;
205     aout_file_t af;
206     linker_file_t lf;
207     char *pathname;
208
209     KKASSERT(p != NULL);
210
211     pathname = linker_search_path(filename);
212     if (pathname == NULL)
213         return ENOENT;
214     NDINIT(&nd, NAMEI_LOOKUP, CNP_FOLLOW, UIO_SYSSPACE, pathname, td);
215     error = vn_open(&nd, FREAD, 0);
216     free(pathname, M_LINKER);
217     if (error)
218         return error;
219     NDFREE(&nd, NDF_ONLY_PNBUF);
220
221     /*
222      * Read the a.out header from the file.
223      */
224     error = vn_rdwr(UIO_READ, nd.ni_vp, (void*) &header, sizeof header, 0,
225                     UIO_SYSSPACE, IO_NODELOCKED, p->p_ucred, &resid, td);
226     if (error)
227         goto out;
228
229     if (N_BADMAG(header) || !(N_GETFLAG(header) & EX_DYNAMIC))
230         goto out;
231
232     /*
233      * We have an a.out file, so make some space to read it in.
234      */
235     af = malloc(sizeof(struct aout_file), M_LINKER, M_WAITOK);
236     bzero(af, sizeof(*af));
237     af->address = malloc(header.a_text + header.a_data + header.a_bss,
238                          M_LINKER, M_WAITOK);
239     
240     /*
241      * Read the text and data sections and zero the bss.
242      */
243     error = vn_rdwr(UIO_READ, nd.ni_vp, (void*) af->address,
244                     header.a_text + header.a_data, 0,
245                     UIO_SYSSPACE, IO_NODELOCKED, p->p_ucred, &resid, td);
246     if (error)
247         goto out;
248     bzero(af->address + header.a_text + header.a_data, header.a_bss);
249
250     /*
251      * Assume _DYNAMIC is the first data item.
252      */
253     af->dynamic = (struct _dynamic*) (af->address + header.a_text);
254     if (af->dynamic->d_version != LD_VERSION_BSD) {
255         free(af->address, M_LINKER);
256         free(af, M_LINKER);
257         goto out;
258     }
259     af->dynamic->d_un.d_sdt = (struct section_dispatch_table *)
260         ((char *)af->dynamic->d_un.d_sdt + (vm_offset_t)af->address);
261
262     lf = linker_make_file(filename, af, &link_aout_file_ops);
263     if (lf == NULL) {
264         free(af->address, M_LINKER);
265         free(af, M_LINKER);
266         error = ENOMEM;
267         goto out;
268     }
269     lf->address = af->address;
270     lf->size = header.a_text + header.a_data + header.a_bss;
271
272     if ((error = load_dependancies(lf)) != 0
273         || (error = relocate_file(lf)) != 0) {
274         linker_file_unload(lf);
275         goto out;
276     }
277
278     lf->flags |= LINKER_FILE_LINKED;
279     *result = lf;
280
281 out:
282     VOP_UNLOCK(nd.ni_vp, 0, td);
283     vn_close(nd.ni_vp, FREAD, td);
284
285     return error;
286 }
287
288 static void
289 link_aout_unload_file(linker_file_t file)
290 {
291     aout_file_t af = file->priv;
292
293     if (af) {
294         if (af->address)
295             free(af->address, M_LINKER);
296         free(af, M_LINKER);
297     }
298 }
299
300 static void
301 link_aout_unload_module(linker_file_t file)
302 {
303     aout_file_t af = file->priv;
304
305     if (af)
306         free(af, M_LINKER);
307     if (file->filename)
308         preload_delete_name(file->filename);
309 }
310
311 #define AOUT_RELOC(af, type, off) (type*) ((af)->address + (off))
312
313 static int
314 load_dependancies(linker_file_t lf)
315 {
316     aout_file_t af = lf->priv;
317     linker_file_t lfdep;
318     long off;
319     struct sod* sodp;
320     char* name;
321     char* filename = 0;
322     int error = 0;
323
324     /*
325      * All files are dependant on /kernel.
326      */
327     if (linker_kernel_file) {
328         linker_kernel_file->refs++;
329         linker_file_add_dependancy(lf, linker_kernel_file);
330     }
331
332     off = LD_NEED(af->dynamic);
333
334     /*
335      * Load the dependancies.
336      */
337     while (off != 0) {
338         sodp = AOUT_RELOC(af, struct sod, off);
339         name = AOUT_RELOC(af, char, sodp->sod_name);
340
341         error = linker_load_file(name, &lfdep);
342         if (error)
343             goto out;
344         error = linker_file_add_dependancy(lf, lfdep);
345         if (error)
346             goto out;
347         off = sodp->sod_next;
348     }
349
350 out:
351     if (filename)
352         free(filename, M_TEMP);
353     return error;
354 }
355
356 /*
357  * XXX i386 dependant.
358  */
359 static long
360 read_relocation(struct relocation_info* r, char* addr)
361 {
362     int length = r->r_length;
363     if (length == 0)
364         return *(u_char*) addr;
365     else if (length == 1)
366         return *(u_short*) addr;
367     else if (length == 2)
368         return *(u_int*) addr;
369     else
370         printf("link_aout: unsupported relocation size %d\n", r->r_length);
371     return 0;
372 }
373
374 static void
375 write_relocation(struct relocation_info* r, char* addr, long value)
376 {
377     int length = r->r_length;
378     if (length == 0)
379         *(u_char*) addr = value;
380     else if (length == 1)
381         *(u_short*) addr = value;
382     else if (length == 2)
383         *(u_int*) addr = value;
384     else
385         printf("link_aout: unsupported relocation size %d\n", r->r_length);
386 }
387
388 static int
389 relocate_file(linker_file_t lf)
390 {
391     aout_file_t af = lf->priv;
392     struct relocation_info* rel;
393     struct relocation_info* erel;
394     struct relocation_info* r;
395     struct nzlist* symbolbase;
396     char* stringbase;
397     struct nzlist* np;
398     char* sym;
399     long relocation;
400
401     rel = AOUT_RELOC(af, struct relocation_info, LD_REL(af->dynamic));
402     erel = AOUT_RELOC(af, struct relocation_info,
403                       LD_REL(af->dynamic) + LD_RELSZ(af->dynamic));
404     symbolbase = AOUT_RELOC(af, struct nzlist, LD_SYMBOL(af->dynamic));
405     stringbase = AOUT_RELOC(af, char, LD_STRINGS(af->dynamic));
406
407     for (r = rel; r < erel; r++) {
408         char* addr;
409
410         if (r->r_address == 0)
411             break;
412
413         addr = AOUT_RELOC(af, char, r->r_address);
414         if (r->r_extern) {
415             np = &symbolbase[r->r_symbolnum];
416             sym = &stringbase[np->nz_strx];
417
418             if (sym[0] != '_') {
419                 printf("link_aout: bad symbol name %s\n", sym);
420                 printf("link_aout: symbol %s not found\n", sym);
421                 return ENOENT;
422             } else {
423                 if (linker_file_lookup_symbol(lf, sym + 1,
424                     (np->nz_type != (N_SETV+N_EXT)), (caddr_t *)&relocation)) {
425                         printf("link_aout: symbol %s not found\n", sym);
426                         return ENOENT;
427                 }
428             }
429             
430             relocation += read_relocation(r, addr);
431
432             if (r->r_jmptable) {
433                 printf("link_aout: can't cope with jump table relocations\n");
434                 continue;
435             }
436
437             if (r->r_pcrel)
438                 relocation -= (intptr_t) af->address;
439
440             if (r->r_copy) {
441                 printf("link_aout: can't cope with copy relocations\n");
442                 continue;
443             }
444             
445             write_relocation(r, addr, relocation);
446         } else {
447             write_relocation(r, addr,
448                              (intptr_t)(read_relocation(r, addr) + af->address));
449         }
450         
451     }
452
453     return 0;
454 }
455
456 static long
457 symbol_hash_value(aout_file_t af, const char* name)
458 {
459     long hashval;
460     const char* p;
461
462     hashval = '_';              /* fake a starting '_' for C symbols */
463     for (p = name; *p; p++)
464         hashval = (hashval << 1) + *p;
465
466     return (hashval & 0x7fffffff) % LD_BUCKETS(af->dynamic);
467 }
468
469 int
470 link_aout_lookup_symbol(linker_file_t file, const char* name,
471                         c_linker_sym_t* sym)
472 {
473     aout_file_t af = file->priv;
474     long hashval;
475     struct rrs_hash* hashbase;
476     struct nzlist* symbolbase;
477     char* stringbase;
478     struct rrs_hash* hp;
479     struct nzlist* np;
480     char* cp;
481
482     if (LD_BUCKETS(af->dynamic) == 0)
483         return 0;
484
485     hashbase = AOUT_RELOC(af, struct rrs_hash, LD_HASH(af->dynamic));
486     symbolbase = AOUT_RELOC(af, struct nzlist, LD_SYMBOL(af->dynamic));
487     stringbase = AOUT_RELOC(af, char, LD_STRINGS(af->dynamic));
488
489 restart:
490     hashval = symbol_hash_value(af, name);
491     hp = &hashbase[hashval];
492     if (hp->rh_symbolnum == -1)
493         return ENOENT;
494
495     while (hp) {
496         np = (struct nzlist *) &symbolbase[hp->rh_symbolnum];
497         cp = stringbase + np->nz_strx;
498         /*
499          * Note: we fake the leading '_' for C symbols.
500          */
501         if (cp[0] == '_' && !strcmp(cp + 1, name))
502             break;
503
504         if (hp->rh_next == 0)
505             hp = NULL;
506         else
507             hp = &hashbase[hp->rh_next];
508     }
509
510     if (hp == NULL)
511         /*
512          * Not found.
513          */
514         return ENOENT;
515
516     /*
517      * Check for an aliased symbol, whatever that is.
518      */
519     if (np->nz_type == N_INDR+N_EXT) {
520         name = stringbase + (++np)->nz_strx + 1; /* +1 for '_' */
521         goto restart;
522     }
523
524     /*
525      * Check this is an actual definition of the symbol.
526      */
527     if (np->nz_value == 0)
528         return ENOENT;
529
530     if (np->nz_type == N_UNDF+N_EXT && np->nz_value != 0) {
531         if (np->nz_other == AUX_FUNC)
532             /* weak function */
533             return ENOENT;
534     }
535
536     *sym = (linker_sym_t) np;
537
538     return 0;
539 }
540
541
542 static int
543 link_aout_symbol_values(linker_file_t file, c_linker_sym_t sym,
544                         linker_symval_t* symval)
545 {
546     aout_file_t af = file->priv;
547     const struct nzlist* np = (const struct nzlist*) sym;
548     char* stringbase;
549     long numsym = LD_STABSZ(af->dynamic) / sizeof(struct nzlist);
550     struct nzlist *symbase;
551
552     /* Is it one of ours?  It could be another module... */
553     symbase = AOUT_RELOC(af, struct nzlist, LD_SYMBOL(af->dynamic));
554     if (np < symbase)
555         return ENOENT;
556     if ((np - symbase) > numsym)
557         return ENOENT;
558
559     stringbase = AOUT_RELOC(af, char, LD_STRINGS(af->dynamic));
560
561     symval->name = stringbase + np->nz_strx + 1; /* +1 for '_' */
562     if (np->nz_type == N_UNDF+N_EXT && np->nz_value != 0) {
563         symval->value = 0;
564         symval->size = np->nz_value;
565     } else {
566         symval->value = AOUT_RELOC(af, char, np->nz_value);
567         symval->size = np->nz_size;
568     }
569     return 0;
570 }
571
572 static int
573 link_aout_search_symbol(linker_file_t lf, caddr_t value,
574                         c_linker_sym_t* sym, long* diffp)
575 {
576         aout_file_t af = lf->priv;
577         u_long off = (uintptr_t) (void *) value;
578         u_long diff = off;
579         u_long sp_nz_value;
580         struct nzlist* sp;
581         struct nzlist* ep;
582         struct nzlist* best = 0;
583
584         for (sp = AOUT_RELOC(af, struct nzlist, LD_SYMBOL(af->dynamic)),
585                  ep = (struct nzlist *) ((caddr_t) sp + LD_STABSZ(af->dynamic));
586              sp < ep; sp++) {
587                 if (sp->nz_name == 0)
588                         continue;
589                 sp_nz_value = sp->nz_value + (uintptr_t) (void *) af->address;
590                 if (off >= sp_nz_value) {
591                         if (off - sp_nz_value < diff) {
592                                 diff = off - sp_nz_value;
593                                 best = sp;
594                                 if (diff == 0)
595                                         break;
596                         } else if (off - sp_nz_value == diff) {
597                                 best = sp;
598                         }
599                 }
600         }
601         if (best == 0)
602                 *diffp = off;
603         else
604                 *diffp = diff;
605         *sym = (linker_sym_t) best;
606
607         return 0;
608 }
609
610 /*
611  * Look up a linker set on an a.out + gnu LD system.
612  */
613
614 struct generic_linker_set {
615         int     ls_length;
616         void    *ls_items[1];
617 };
618
619 static int
620 link_aout_lookup_set(linker_file_t lf, const char *name,
621                     void ***startp, void ***stopp, int *countp)
622 {
623         c_linker_sym_t sym;
624         linker_symval_t symval;
625         void **start, **stop;
626         int error, count;
627         struct generic_linker_set *setp;
628
629         error = link_aout_lookup_symbol(lf, name, &sym);
630         if (error)
631                return error;
632         link_aout_symbol_values(lf, sym, &symval);
633         if (symval.value == 0)
634                return ESRCH;
635         setp = (struct generic_linker_set *)symval.value;
636         count = setp->ls_length;
637         start = &setp->ls_items[0];
638         stop = &setp->ls_items[count];
639         if (startp)
640                *startp = start;
641         if (stopp)
642                *stopp = stop;
643         if (countp)
644                *countp = count;
645         return 0;
646 }
647
648 #endif /* !__alpha__ */
649