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