subr_kobj.c revision 1.19 1 /* $NetBSD: subr_kobj.c,v 1.19 2008/05/20 14:11:55 ad Exp $ */
2
3 /*-
4 * Copyright (c) 2008 The NetBSD Foundation, Inc.
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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /*-
30 * Copyright (c) 1998-2000 Doug Rabson
31 * Copyright (c) 2004 Peter Wemm
32 * All rights reserved.
33 *
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
36 * are met:
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * SUCH DAMAGE.
54 */
55
56 /*
57 * Kernel loader for ELF objects.
58 *
59 * TODO: adjust kmem_alloc() calls to avoid needless fragmentation.
60 */
61
62 #include "opt_modular.h"
63
64 #include <sys/cdefs.h>
65 __KERNEL_RCSID(0, "$NetBSD: subr_kobj.c,v 1.19 2008/05/20 14:11:55 ad Exp $");
66
67 #define ELFSIZE ARCH_ELFSIZE
68
69 #include <sys/systm.h>
70 #include <sys/kobj.h>
71 #include <sys/errno.h>
72
73 #ifdef MODULAR
74
75 #include <sys/param.h>
76 #include <sys/kernel.h>
77 #include <sys/kmem.h>
78 #include <sys/proc.h>
79 #include <sys/namei.h>
80 #include <sys/vnode.h>
81 #include <sys/fcntl.h>
82 #include <sys/ksyms.h>
83 #include <sys/lkm.h>
84 #include <sys/exec.h>
85 #include <sys/exec_elf.h>
86
87 #include <machine/stdarg.h>
88
89 #include <uvm/uvm_extern.h>
90
91
92 typedef struct {
93 void *addr;
94 Elf_Off size;
95 int flags;
96 int sec; /* Original section */
97 const char *name;
98 } progent_t;
99
100 typedef struct {
101 Elf_Rel *rel;
102 int nrel;
103 int sec;
104 size_t size;
105 } relent_t;
106
107 typedef struct {
108 Elf_Rela *rela;
109 int nrela;
110 int sec;
111 size_t size;
112 } relaent_t;
113
114 typedef enum kobjtype {
115 KT_UNSET,
116 KT_VNODE,
117 KT_MEMORY
118 } kobjtype_t;
119
120 struct kobj {
121 char ko_name[MAXLKMNAME];
122 kobjtype_t ko_type;
123 void *ko_source;
124 ssize_t ko_memsize;
125 vaddr_t ko_address; /* Relocation address */
126 Elf_Shdr *ko_shdr;
127 progent_t *ko_progtab;
128 relaent_t *ko_relatab;
129 relent_t *ko_reltab;
130 Elf_Sym *ko_symtab; /* Symbol table */
131 char *ko_strtab; /* String table */
132 char *ko_shstrtab; /* Section name string table */
133 size_t ko_size; /* Size of text/data/bss */
134 size_t ko_symcnt; /* Number of symbols */
135 size_t ko_strtabsz; /* Number of bytes in string table */
136 size_t ko_shstrtabsz; /* Number of bytes in scn str table */
137 size_t ko_shdrsz;
138 int ko_nrel;
139 int ko_nrela;
140 int ko_nprogtab;
141 bool ko_ksyms;
142 bool ko_loaded;
143 };
144
145 static int kobj_relocate(kobj_t, bool);
146 static void kobj_error(const char *, ...);
147 static int kobj_read(kobj_t, void **, size_t, off_t);
148 static int kobj_read_bits(kobj_t, void *, size_t, off_t);
149 static void kobj_jettison(kobj_t);
150 static void kobj_free(kobj_t, void *, size_t);
151 static void kobj_close(kobj_t);
152 static int kobj_load(kobj_t);
153
154 extern struct vm_map *lkm_map;
155
156 /*
157 * kobj_load_file:
158 *
159 * Load an object located in the file system.
160 */
161 int
162 kobj_load_file(kobj_t *kop, const char *filename, const char *base)
163 {
164 struct nameidata nd;
165 kauth_cred_t cred;
166 char *path;
167 int error;
168 kobj_t ko;
169
170 cred = kauth_cred_get();
171
172 ko = kmem_zalloc(sizeof(*ko), KM_SLEEP);
173 if (ko == NULL) {
174 return ENOMEM;
175 }
176
177 if (curproc == &proc0) {
178 error = ENOENT;
179 } else {
180 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, filename);
181 error = vn_open(&nd, FREAD, 0);
182 }
183 if (error != 0) {
184 if (error != ENOENT) {
185 goto out;
186 }
187 path = PNBUF_GET();
188 snprintf(path, MAXPATHLEN - 1, "%s/%s/%s.kmod", base,
189 filename, filename);
190 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, path);
191 error = vn_open(&nd, FREAD, 0);
192 if (error != 0) {
193 strlcat(path, ".o", MAXPATHLEN);
194 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, path);
195 error = vn_open(&nd, FREAD, 0);
196 }
197 PNBUF_PUT(path);
198 if (error != 0) {
199 goto out;
200 }
201 }
202
203 out:
204 if (error != 0) {
205 kmem_free(ko, sizeof(*ko));
206 return error;
207 }
208
209 ko->ko_type = KT_VNODE;
210 ko->ko_source = nd.ni_vp;
211 *kop = ko;
212 return kobj_load(ko);
213 }
214
215 /*
216 * kobj_load_mem:
217 *
218 * Load an object already resident in memory. If size is not -1,
219 * the complete size of the object is known.
220 */
221 int
222 kobj_load_mem(kobj_t *kop, void *base, ssize_t size)
223 {
224 kobj_t ko;
225
226 ko = kmem_zalloc(sizeof(*ko), KM_SLEEP);
227 if (ko == NULL) {
228 return ENOMEM;
229 }
230
231 ko->ko_type = KT_MEMORY;
232 ko->ko_source = base;
233 ko->ko_memsize = size;
234 *kop = ko;
235 return kobj_load(ko);
236 }
237
238 /*
239 * kobj_close:
240 *
241 * Close an open ELF object.
242 */
243 static void
244 kobj_close(kobj_t ko)
245 {
246
247 if (ko->ko_source == NULL) {
248 return;
249 }
250
251 switch (ko->ko_type) {
252 case KT_VNODE:
253 VOP_UNLOCK(ko->ko_source, 0);
254 vn_close(ko->ko_source, FREAD, kauth_cred_get());
255 break;
256 case KT_MEMORY:
257 /* nothing */
258 break;
259 default:
260 panic("kobj_close: unknown type");
261 break;
262 }
263
264 ko->ko_source = NULL;
265 }
266
267 /*
268 * kobj_load:
269 *
270 * Load an ELF object and prepare to link into the running kernel
271 * image.
272 */
273 static int
274 kobj_load(kobj_t ko)
275 {
276 Elf_Ehdr *hdr;
277 Elf_Shdr *shdr;
278 Elf_Sym *es;
279 vaddr_t mapbase;
280 size_t mapsize;
281 int error;
282 int symtabindex;
283 int symstrindex;
284 int nsym;
285 int pb, rl, ra;
286 int alignmask;
287 int i, j;
288 void *addr;
289
290 KASSERT(ko->ko_type != KT_UNSET);
291 KASSERT(ko->ko_source != NULL);
292
293 shdr = NULL;
294 mapsize = 0;
295 error = 0;
296 hdr = NULL;
297
298 /*
299 * Read the elf header from the file.
300 */
301 error = kobj_read(ko, (void **)&hdr, sizeof(*hdr), 0);
302 if (error != 0)
303 goto out;
304 if (memcmp(hdr->e_ident, ELFMAG, SELFMAG) != 0) {
305 kobj_error("not an ELF object");
306 error = ENOEXEC;
307 goto out;
308 }
309
310 if (hdr->e_ident[EI_VERSION] != EV_CURRENT ||
311 hdr->e_version != EV_CURRENT) {
312 kobj_error("unsupported file version");
313 error = ENOEXEC;
314 goto out;
315 }
316 if (hdr->e_type != ET_REL) {
317 kobj_error("unsupported file type");
318 error = ENOEXEC;
319 goto out;
320 }
321 switch (hdr->e_machine) {
322 #if ELFSIZE == 32
323 ELF32_MACHDEP_ID_CASES
324 #else
325 ELF64_MACHDEP_ID_CASES
326 #endif
327 default:
328 kobj_error("unsupported machine");
329 error = ENOEXEC;
330 goto out;
331 }
332
333 ko->ko_nprogtab = 0;
334 ko->ko_shdr = 0;
335 ko->ko_nrel = 0;
336 ko->ko_nrela = 0;
337
338 /*
339 * Allocate and read in the section header.
340 */
341 ko->ko_shdrsz = hdr->e_shnum * hdr->e_shentsize;
342 if (ko->ko_shdrsz == 0 || hdr->e_shoff == 0 ||
343 hdr->e_shentsize != sizeof(Elf_Shdr)) {
344 error = ENOEXEC;
345 goto out;
346 }
347 error = kobj_read(ko, (void **)&shdr, ko->ko_shdrsz, hdr->e_shoff);
348 if (error != 0) {
349 goto out;
350 }
351 ko->ko_shdr = shdr;
352
353 /*
354 * Scan the section header for information and table sizing.
355 */
356 nsym = 0;
357 symtabindex = -1;
358 symstrindex = -1;
359 for (i = 0; i < hdr->e_shnum; i++) {
360 switch (shdr[i].sh_type) {
361 case SHT_PROGBITS:
362 case SHT_NOBITS:
363 ko->ko_nprogtab++;
364 break;
365 case SHT_SYMTAB:
366 nsym++;
367 symtabindex = i;
368 symstrindex = shdr[i].sh_link;
369 break;
370 case SHT_REL:
371 ko->ko_nrel++;
372 break;
373 case SHT_RELA:
374 ko->ko_nrela++;
375 break;
376 case SHT_STRTAB:
377 break;
378 }
379 }
380 if (ko->ko_nprogtab == 0) {
381 kobj_error("file has no contents");
382 error = ENOEXEC;
383 goto out;
384 }
385 if (nsym != 1) {
386 /* Only allow one symbol table for now */
387 kobj_error("file has no valid symbol table");
388 error = ENOEXEC;
389 goto out;
390 }
391 if (symstrindex < 0 || symstrindex > hdr->e_shnum ||
392 shdr[symstrindex].sh_type != SHT_STRTAB) {
393 kobj_error("file has invalid symbol strings");
394 error = ENOEXEC;
395 goto out;
396 }
397
398 /*
399 * Allocate space for tracking the load chunks.
400 */
401 if (ko->ko_nprogtab != 0) {
402 ko->ko_progtab = kmem_zalloc(ko->ko_nprogtab *
403 sizeof(*ko->ko_progtab), KM_SLEEP);
404 if (ko->ko_progtab == NULL) {
405 error = ENOMEM;
406 goto out;
407 }
408 }
409 if (ko->ko_nrel != 0) {
410 ko->ko_reltab = kmem_zalloc(ko->ko_nrel *
411 sizeof(*ko->ko_reltab), KM_SLEEP);
412 if (ko->ko_reltab == NULL) {
413 error = ENOMEM;
414 goto out;
415 }
416 }
417 if (ko->ko_nrela != 0) {
418 ko->ko_relatab = kmem_zalloc(ko->ko_nrela *
419 sizeof(*ko->ko_relatab), KM_SLEEP);
420 if (ko->ko_relatab == NULL) {
421 error = ENOMEM;
422 goto out;
423 }
424 }
425 if (symtabindex == -1) {
426 kobj_error("lost symbol table index");
427 goto out;
428 }
429
430 /*
431 * Allocate space for and load the symbol table.
432 */
433 ko->ko_symcnt = shdr[symtabindex].sh_size / sizeof(Elf_Sym);
434 if (ko->ko_symcnt == 0) {
435 kobj_error("no symbol table");
436 goto out;
437 }
438 error = kobj_read(ko, (void **)&ko->ko_symtab,
439 ko->ko_symcnt * sizeof(Elf_Sym),
440 shdr[symtabindex].sh_offset);
441 if (error != 0) {
442 goto out;
443 }
444
445 /*
446 * Allocate space for and load the symbol strings.
447 */
448 ko->ko_strtabsz = shdr[symstrindex].sh_size;
449 if (ko->ko_strtabsz == 0) {
450 kobj_error("no symbol strings");
451 goto out;
452 }
453 error = kobj_read(ko, (void *)&ko->ko_strtab, ko->ko_strtabsz,
454 shdr[symstrindex].sh_offset);
455 if (error != 0) {
456 goto out;
457 }
458
459 /*
460 * Do we have a string table for the section names?
461 */
462 if (hdr->e_shstrndx != 0 && shdr[hdr->e_shstrndx].sh_size != 0 &&
463 shdr[hdr->e_shstrndx].sh_type == SHT_STRTAB) {
464 ko->ko_shstrtabsz = shdr[hdr->e_shstrndx].sh_size;
465 error = kobj_read(ko, (void *)&ko->ko_shstrtab,
466 shdr[hdr->e_shstrndx].sh_size,
467 shdr[hdr->e_shstrndx].sh_offset);
468 if (error != 0) {
469 goto out;
470 }
471 }
472
473 /*
474 * Size up code/data(progbits) and bss(nobits).
475 */
476 alignmask = 0;
477 mapbase = 0;
478 for (i = 0; i < hdr->e_shnum; i++) {
479 switch (shdr[i].sh_type) {
480 case SHT_PROGBITS:
481 case SHT_NOBITS:
482 if (mapbase == 0)
483 mapbase = shdr[i].sh_offset;
484 alignmask = shdr[i].sh_addralign - 1;
485 mapsize += alignmask;
486 mapsize &= ~alignmask;
487 mapsize += shdr[i].sh_size;
488 break;
489 }
490 }
491
492 /*
493 * We know how much space we need for the text/data/bss/etc.
494 * This stuff needs to be in a single chunk so that profiling etc
495 * can get the bounds and gdb can associate offsets with modules.
496 */
497 if (mapsize == 0) {
498 kobj_error("no text/data/bss");
499 goto out;
500 }
501 if (ko->ko_type == KT_MEMORY) {
502 mapbase += (vaddr_t)ko->ko_source;
503 } else {
504 mapbase = uvm_km_alloc(lkm_map, round_page(mapsize),
505 0, UVM_KMF_WIRED | UVM_KMF_EXEC);
506 if (mapbase == 0) {
507 error = ENOMEM;
508 goto out;
509 }
510 }
511 ko->ko_address = mapbase;
512 ko->ko_size = mapsize;
513
514 /*
515 * Now load code/data(progbits), zero bss(nobits), allocate space
516 * for and load relocs
517 */
518 pb = 0;
519 rl = 0;
520 ra = 0;
521 alignmask = 0;
522 for (i = 0; i < hdr->e_shnum; i++) {
523 switch (shdr[i].sh_type) {
524 case SHT_PROGBITS:
525 case SHT_NOBITS:
526 alignmask = shdr[i].sh_addralign - 1;
527 if (ko->ko_type == KT_MEMORY) {
528 addr = (void *)(shdr[i].sh_offset +
529 (vaddr_t)ko->ko_source);
530 if (((vaddr_t)addr & alignmask) != 0) {
531 kobj_error("section %d not aligned\n",
532 i);
533 goto out;
534 }
535 } else {
536 mapbase += alignmask;
537 mapbase &= ~alignmask;
538 addr = (void *)mapbase;
539 mapbase += shdr[i].sh_size;
540 }
541 ko->ko_progtab[pb].addr = addr;
542 if (shdr[i].sh_type == SHT_PROGBITS) {
543 ko->ko_progtab[pb].name = "<<PROGBITS>>";
544 error = kobj_read_bits(ko, addr,
545 shdr[i].sh_size, shdr[i].sh_offset);
546 if (error != 0) {
547 goto out;
548 }
549 } else if (ko->ko_type == KT_MEMORY &&
550 shdr[i].sh_size != 0) {
551 kobj_error("non-loadable BSS section in "
552 "pre-loaded module");
553 error = EINVAL;
554 goto out;
555 } else {
556 ko->ko_progtab[pb].name = "<<NOBITS>>";
557 memset(addr, 0, shdr[i].sh_size);
558 }
559 ko->ko_progtab[pb].size = shdr[i].sh_size;
560 ko->ko_progtab[pb].sec = i;
561 if (ko->ko_shstrtab != NULL && shdr[i].sh_name != 0) {
562 ko->ko_progtab[pb].name =
563 ko->ko_shstrtab + shdr[i].sh_name;
564 }
565
566 /* Update all symbol values with the offset. */
567 for (j = 0; j < ko->ko_symcnt; j++) {
568 es = &ko->ko_symtab[j];
569 if (es->st_shndx != i) {
570 continue;
571 }
572 es->st_value += (Elf_Addr)addr;
573 }
574 pb++;
575 break;
576 case SHT_REL:
577 ko->ko_reltab[rl].size = shdr[i].sh_size;
578 ko->ko_reltab[rl].size -=
579 shdr[i].sh_size % sizeof(Elf_Rel);
580 if (ko->ko_reltab[rl].size != 0) {
581 ko->ko_reltab[rl].nrel =
582 shdr[i].sh_size / sizeof(Elf_Rel);
583 ko->ko_reltab[rl].sec = shdr[i].sh_info;
584 error = kobj_read(ko,
585 (void **)&ko->ko_reltab[rl].rel,
586 ko->ko_reltab[rl].size,
587 shdr[i].sh_offset);
588 if (error != 0) {
589 goto out;
590 }
591 }
592 rl++;
593 break;
594 case SHT_RELA:
595 ko->ko_relatab[ra].size = shdr[i].sh_size;
596 ko->ko_relatab[ra].size -=
597 shdr[i].sh_size % sizeof(Elf_Rela);
598 if (ko->ko_relatab[ra].size != 0) {
599 ko->ko_relatab[ra].nrela =
600 shdr[i].sh_size / sizeof(Elf_Rela);
601 ko->ko_relatab[ra].sec = shdr[i].sh_info;
602 error = kobj_read(ko,
603 (void **)&ko->ko_relatab[ra].rela,
604 shdr[i].sh_size,
605 shdr[i].sh_offset);
606 if (error != 0) {
607 goto out;
608 }
609 }
610 ra++;
611 break;
612 default:
613 break;
614 }
615 }
616 if (pb != ko->ko_nprogtab) {
617 panic("lost progbits");
618 }
619 if (rl != ko->ko_nrel) {
620 panic("lost rel");
621 }
622 if (ra != ko->ko_nrela) {
623 panic("lost rela");
624 }
625 if (ko->ko_type != KT_MEMORY && mapbase != ko->ko_address + mapsize) {
626 panic("mapbase 0x%lx != address %lx + mapsize %ld (0x%lx)\n",
627 (long)mapbase, (long)ko->ko_address, (long)mapsize,
628 (long)ko->ko_address + mapsize);
629 }
630
631 /*
632 * Perform local relocations only. Relocations relating to global
633 * symbols will be done by kobj_affix().
634 */
635 error = kobj_relocate(ko, true);
636 out:
637 if (hdr != NULL) {
638 kobj_free(ko, hdr, sizeof(*hdr));
639 }
640 kobj_close(ko);
641 if (error != 0) {
642 kobj_unload(ko);
643 }
644
645 return error;
646 }
647
648 /*
649 * kobj_unload:
650 *
651 * Unload an object previously loaded by kobj_load().
652 */
653 void
654 kobj_unload(kobj_t ko)
655 {
656 int error;
657
658 kobj_close(ko);
659 kobj_jettison(ko);
660
661 /*
662 * Notify MD code that a module has been unloaded.
663 */
664 if (ko->ko_loaded) {
665 error = kobj_machdep(ko, (void *)ko->ko_address, ko->ko_size,
666 false);
667 if (error != 0) {
668 kobj_error("machine dependent deinit failed");
669 }
670 }
671 if (ko->ko_address != 0 && ko->ko_type != KT_MEMORY) {
672 uvm_km_free(lkm_map, ko->ko_address, round_page(ko->ko_size),
673 UVM_KMF_WIRED);
674 }
675 if (ko->ko_ksyms == true) {
676 ksyms_delsymtab(ko->ko_name);
677 }
678 if (ko->ko_symtab != NULL) {
679 kobj_free(ko, ko->ko_symtab, ko->ko_symcnt * sizeof(Elf_Sym));
680 }
681 if (ko->ko_strtab != NULL) {
682 kobj_free(ko, ko->ko_strtab, ko->ko_strtabsz);
683 }
684 if (ko->ko_progtab != NULL) {
685 kobj_free(ko, ko->ko_progtab, ko->ko_nprogtab *
686 sizeof(*ko->ko_progtab));
687 ko->ko_progtab = NULL;
688 }
689 if (ko->ko_shstrtab) {
690 kobj_free(ko, ko->ko_shstrtab, ko->ko_shstrtabsz);
691 ko->ko_shstrtab = NULL;
692 }
693
694 kmem_free(ko, sizeof(*ko));
695 }
696
697 /*
698 * kobj_stat:
699 *
700 * Return size and load address of an object.
701 */
702 void
703 kobj_stat(kobj_t ko, vaddr_t *address, size_t *size)
704 {
705
706 if (address != NULL) {
707 *address = ko->ko_address;
708 }
709 if (size != NULL) {
710 *size = ko->ko_size;
711 }
712 }
713
714 /*
715 * kobj_affix:
716 *
717 * Set an object's name and perform global relocs. May only be
718 * called after the module and any requisite modules are loaded.
719 */
720 int
721 kobj_affix(kobj_t ko, const char *name)
722 {
723 int error;
724
725 KASSERT(ko->ko_ksyms == false);
726 KASSERT(ko->ko_loaded == false);
727
728 strlcpy(ko->ko_name, name, sizeof(ko->ko_name));
729
730 /* Now that we know the name, register the symbol table. */
731 error = ksyms_addsymtab(ko->ko_name, ko->ko_symtab, ko->ko_symcnt *
732 sizeof(Elf_Sym), ko->ko_strtab, ko->ko_strtabsz);
733 if (error != 0) {
734 kobj_error("unable to register module symbol table");
735 } else {
736 ko->ko_ksyms = true;
737 /* Now do global relocations. */
738 error = kobj_relocate(ko, false);
739 }
740
741 /* Jettison unneeded memory post-link. */
742 kobj_jettison(ko);
743
744 /* Notify MD code that a module has been loaded. */
745 if (error == 0) {
746 error = kobj_machdep(ko, (void *)ko->ko_address, ko->ko_size,
747 true);
748 if (error != 0) {
749 kobj_error("machine dependent init failed");
750 }
751 ko->ko_loaded = true;
752 }
753
754 /* If there was an error, destroy the whole object. */
755 if (error != 0) {
756 kobj_unload(ko);
757 }
758
759 return error;
760 }
761
762 /*
763 * kobj_find_section:
764 *
765 * Given a section name, search the loaded object and return
766 * virtual address if present and loaded.
767 */
768 int
769 kobj_find_section(kobj_t ko, const char *name, void **addr, size_t *size)
770 {
771 int i;
772
773 KASSERT(ko->ko_progtab != NULL);
774
775 for (i = 0; i < ko->ko_nprogtab; i++) {
776 if (strcmp(ko->ko_progtab[i].name, name) == 0) {
777 if (addr != NULL) {
778 *addr = ko->ko_progtab[i].addr;
779 }
780 if (size != NULL) {
781 *size = ko->ko_progtab[i].size;
782 }
783 return 0;
784 }
785 }
786
787 return ENOENT;
788 }
789
790 /*
791 * kobj_jettison:
792 *
793 * Release object data not needed after performing relocations.
794 */
795 static void
796 kobj_jettison(kobj_t ko)
797 {
798 int i;
799
800 for (i = 0; i < ko->ko_nrel; i++) {
801 if (ko->ko_reltab[i].rel) {
802 kobj_free(ko, ko->ko_reltab[i].rel,
803 ko->ko_reltab[i].size);
804 }
805 }
806 for (i = 0; i < ko->ko_nrela; i++) {
807 if (ko->ko_relatab[i].rela) {
808 kobj_free(ko, ko->ko_relatab[i].rela,
809 ko->ko_relatab[i].size);
810 }
811 }
812 if (ko->ko_reltab != NULL) {
813 kobj_free(ko, ko->ko_reltab, ko->ko_nrel *
814 sizeof(*ko->ko_reltab));
815 ko->ko_reltab = NULL;
816 ko->ko_nrel = 0;
817 }
818 if (ko->ko_relatab != NULL) {
819 kobj_free(ko, ko->ko_relatab, ko->ko_nrela *
820 sizeof(*ko->ko_relatab));
821 ko->ko_relatab = NULL;
822 ko->ko_nrela = 0;
823 }
824 if (ko->ko_shdr != NULL) {
825 kobj_free(ko, ko->ko_shdr, ko->ko_shdrsz);
826 ko->ko_shdr = NULL;
827 }
828 }
829
830 /*
831 * kobj_sym_lookup:
832 *
833 * Symbol lookup function to be used when the symbol index
834 * is known (ie during relocation).
835 */
836 uintptr_t
837 kobj_sym_lookup(kobj_t ko, uintptr_t symidx)
838 {
839 const Elf_Sym *sym;
840 const char *symbol;
841 int error;
842 u_long addr;
843
844 /* Don't even try to lookup the symbol if the index is bogus. */
845 if (symidx >= ko->ko_symcnt)
846 return 0;
847
848 sym = ko->ko_symtab + symidx;
849
850 /* Quick answer if there is a definition included. */
851 if (sym->st_shndx != SHN_UNDEF) {
852 return sym->st_value;
853 }
854
855 /* If we get here, then it is undefined and needs a lookup. */
856 switch (ELF_ST_BIND(sym->st_info)) {
857 case STB_LOCAL:
858 /* Local, but undefined? huh? */
859 kobj_error("local symbol undefined");
860 return 0;
861
862 case STB_GLOBAL:
863 /* Relative to Data or Function name */
864 symbol = ko->ko_strtab + sym->st_name;
865
866 /* Force a lookup failure if the symbol name is bogus. */
867 if (*symbol == 0) {
868 kobj_error("bad symbol name");
869 return 0;
870 }
871
872 error = ksyms_getval(NULL, symbol, &addr, KSYMS_ANY);
873 if (error != 0) {
874 kobj_error("symbol `%s' not found", symbol);
875 return (uintptr_t)0;
876 }
877 return (uintptr_t)addr;
878
879 case STB_WEAK:
880 kobj_error("weak symbols not supported\n");
881 return 0;
882
883 default:
884 return 0;
885 }
886 }
887
888 /*
889 * kobj_findbase:
890 *
891 * Return base address of the given section.
892 */
893 static uintptr_t
894 kobj_findbase(kobj_t ko, int sec)
895 {
896 int i;
897
898 for (i = 0; i < ko->ko_nprogtab; i++) {
899 if (sec == ko->ko_progtab[i].sec) {
900 return (uintptr_t)ko->ko_progtab[i].addr;
901 }
902 }
903 return 0;
904 }
905
906 /*
907 * kobj_relocate:
908 *
909 * Resolve relocations for the loaded object.
910 */
911 static int
912 kobj_relocate(kobj_t ko, bool local)
913 {
914 const Elf_Rel *rellim;
915 const Elf_Rel *rel;
916 const Elf_Rela *relalim;
917 const Elf_Rela *rela;
918 const Elf_Sym *sym;
919 uintptr_t base;
920 int i, error;
921 uintptr_t symidx;
922
923 /*
924 * Perform relocations without addend if there are any.
925 */
926 for (i = 0; i < ko->ko_nrel; i++) {
927 rel = ko->ko_reltab[i].rel;
928 if (rel == NULL) {
929 continue;
930 }
931 rellim = rel + ko->ko_reltab[i].nrel;
932 base = kobj_findbase(ko, ko->ko_reltab[i].sec);
933 if (base == 0) {
934 panic("lost base for e_reltab");
935 }
936 for (; rel < rellim; rel++) {
937 symidx = ELF_R_SYM(rel->r_info);
938 if (symidx >= ko->ko_symcnt) {
939 continue;
940 }
941 sym = ko->ko_symtab + symidx;
942 if (local != (ELF_ST_BIND(sym->st_info) == STB_LOCAL)) {
943 continue;
944 }
945 error = kobj_reloc(ko, base, rel, false, local);
946 if (error != 0) {
947 return ENOENT;
948 }
949 }
950 }
951
952 /*
953 * Perform relocations with addend if there are any.
954 */
955 for (i = 0; i < ko->ko_nrela; i++) {
956 rela = ko->ko_relatab[i].rela;
957 if (rela == NULL) {
958 continue;
959 }
960 relalim = rela + ko->ko_relatab[i].nrela;
961 base = kobj_findbase(ko, ko->ko_relatab[i].sec);
962 if (base == 0) {
963 panic("lost base for e_relatab");
964 }
965 for (; rela < relalim; rela++) {
966 symidx = ELF_R_SYM(rela->r_info);
967 if (symidx >= ko->ko_symcnt) {
968 continue;
969 }
970 sym = ko->ko_symtab + symidx;
971 if (local != (ELF_ST_BIND(sym->st_info) == STB_LOCAL)) {
972 continue;
973 }
974 error = kobj_reloc(ko, base, rela, true, local);
975 if (error != 0) {
976 return ENOENT;
977 }
978 }
979 }
980
981 return 0;
982 }
983
984 /*
985 * kobj_error:
986 *
987 * Utility function: log an error.
988 */
989 static void
990 kobj_error(const char *fmt, ...)
991 {
992 va_list ap;
993
994 va_start(ap, fmt);
995 printf("WARNING: linker error: ");
996 vprintf(fmt, ap);
997 printf("\n");
998 va_end(ap);
999 }
1000
1001 /*
1002 * kobj_read:
1003 *
1004 * Utility function: read from the object.
1005 */
1006 static int
1007 kobj_read(kobj_t ko, void **basep, size_t size, off_t off)
1008 {
1009 size_t resid;
1010 void *base;
1011 int error;
1012
1013 KASSERT(ko->ko_source != NULL);
1014
1015 switch (ko->ko_type) {
1016 case KT_VNODE:
1017 base = kmem_alloc(size, KM_SLEEP);
1018 if (base == NULL) {
1019 error = ENOMEM;
1020 break;
1021 }
1022 error = vn_rdwr(UIO_READ, ko->ko_source, base, size, off,
1023 UIO_SYSSPACE, IO_NODELOCKED, curlwp->l_cred, &resid,
1024 curlwp);
1025 if (error == 0 && resid != 0) {
1026 kmem_free(base, size);
1027 error = EINVAL;
1028 }
1029 break;
1030 case KT_MEMORY:
1031 if (ko->ko_memsize != -1 && off + size > ko->ko_memsize) {
1032 kobj_error("kobj_read: preloaded object short");
1033 error = EINVAL;
1034 base = NULL;
1035 } else {
1036 base = (uint8_t *)ko->ko_source + off;
1037 error = 0;
1038 }
1039 break;
1040 default:
1041 panic("kobj_read: invalid type");
1042 }
1043
1044 *basep = base;
1045 return error;
1046 }
1047
1048 /*
1049 * kobj_read_bits:
1050 *
1051 * Utility function: load a section from the object.
1052 */
1053 static int
1054 kobj_read_bits(kobj_t ko, void *base, size_t size, off_t off)
1055 {
1056 size_t resid;
1057 int error;
1058
1059 KASSERT(ko->ko_source != NULL);
1060
1061 switch (ko->ko_type) {
1062 case KT_VNODE:
1063 KASSERT((uintptr_t)base >= (uintptr_t)ko->ko_address);
1064 KASSERT((uintptr_t)base + size <=
1065 (uintptr_t)ko->ko_address + ko->ko_size);
1066 error = vn_rdwr(UIO_READ, ko->ko_source, base, size, off,
1067 UIO_SYSSPACE, IO_NODELOCKED, curlwp->l_cred, &resid,
1068 curlwp);
1069 if (error == 0 && resid != 0) {
1070 error = EINVAL;
1071 }
1072 break;
1073 case KT_MEMORY:
1074 if (ko->ko_memsize != -1 && off + size > ko->ko_memsize) {
1075 kobj_error("kobj_read_bits: preloaded object short");
1076 error = EINVAL;
1077 } else if ((uint8_t *)base != (uint8_t *)ko->ko_source + off) {
1078 kobj_error("kobj_read_bits: object not aligned");
1079 kobj_error("source=%p base=%p off=%d size=%zd",
1080 ko->ko_source, base, (int)off, size);
1081 error = EINVAL;
1082 } else {
1083 /* Nothing to do. Loading in-situ. */
1084 error = 0;
1085 }
1086 break;
1087 default:
1088 panic("kobj_read: invalid type");
1089 }
1090
1091 return error;
1092 }
1093
1094 /*
1095 * kobj_free:
1096 *
1097 * Utility function: free memory if it was allocated from the heap.
1098 */
1099 static void
1100 kobj_free(kobj_t ko, void *base, size_t size)
1101 {
1102
1103 if (ko->ko_type != KT_MEMORY)
1104 kmem_free(base, size);
1105 }
1106
1107 #else /* MODULAR */
1108
1109 int
1110 kobj_load_file(kobj_t *kop, const char *name)
1111 {
1112
1113 return ENOSYS;
1114 }
1115
1116 int
1117 kobj_load_mem(kobj_t *kop, void *base, ssize_t size)
1118 {
1119
1120 return ENOSYS;
1121 }
1122
1123 void
1124 kobj_unload(kobj_t ko)
1125 {
1126
1127 panic("not modular");
1128 }
1129
1130 void
1131 kobj_stat(kobj_t ko, vaddr_t *base, size_t *size)
1132 {
1133
1134 panic("not modular");
1135 }
1136
1137 int
1138 kobj_affix(kobj_t ko, const char *name)
1139 {
1140
1141 panic("not modular");
1142 }
1143
1144 int
1145 kobj_find_section(kobj_t ko, const char *name, void **addr, size_t *size)
1146 {
1147
1148 panic("not modular");
1149 }
1150
1151 #endif /* MODULAR */
1152