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