2 * Copyright (c) 2000 David O'Brien
3 * Copyright (c) 1995-1996 Søren Schmidt
4 * Copyright (c) 1996 Peter Wemm
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer
12 * in this position and unchanged.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include "opt_compat.h"
36 #include <sys/param.h>
38 #include <sys/fcntl.h>
39 #include <sys/imgact.h>
40 #include <sys/imgact_elf.h>
41 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44 #include <sys/mount.h>
45 #include <sys/mutex.h>
47 #include <sys/namei.h>
48 #include <sys/pioctl.h>
50 #include <sys/procfs.h>
51 #include <sys/resourcevar.h>
52 #include <sys/sf_buf.h>
53 #include <sys/systm.h>
54 #include <sys/signalvar.h>
57 #include <sys/syscall.h>
58 #include <sys/sysctl.h>
59 #include <sys/sysent.h>
60 #include <sys/vnode.h>
63 #include <vm/vm_kern.h>
64 #include <vm/vm_param.h>
66 #include <vm/vm_map.h>
67 #include <vm/vm_object.h>
68 #include <vm/vm_extern.h>
70 #include <machine/elf.h>
71 #include <machine/md_var.h>
73 #if defined(COMPAT_IA32) && __ELF_WORD_SIZE == 32
74 #include <machine/fpu.h>
75 #include <compat/ia32/ia32_reg.h>
78 #define OLD_EI_BRAND 8
80 static int __elfN(check_header)(const Elf_Ehdr *hdr);
81 static Elf_Brandinfo *__elfN(get_brandinfo)(struct image_params *imgp,
82 const char *interp, int32_t *osrel);
83 static int __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
84 u_long *entry, size_t pagesize);
85 static int __elfN(load_section)(struct vmspace *vmspace, vm_object_t object,
86 vm_offset_t offset, caddr_t vmaddr, size_t memsz, size_t filsz,
87 vm_prot_t prot, size_t pagesize);
88 static int __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp);
89 static boolean_t __elfN(freebsd_trans_osrel)(const Elf_Note *note,
91 static boolean_t kfreebsd_trans_osrel(const Elf_Note *note, int32_t *osrel);
92 static boolean_t __elfN(check_note)(struct image_params *imgp,
93 Elf_Brandnote *checknote, int32_t *osrel);
95 SYSCTL_NODE(_kern, OID_AUTO, __CONCAT(elf, __ELF_WORD_SIZE), CTLFLAG_RW, 0,
98 int __elfN(fallback_brand) = -1;
99 SYSCTL_INT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO,
100 fallback_brand, CTLFLAG_RW, &__elfN(fallback_brand), 0,
101 __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE)) " brand of last resort");
102 TUNABLE_INT("kern.elf" __XSTRING(__ELF_WORD_SIZE) ".fallback_brand",
103 &__elfN(fallback_brand));
105 static int elf_legacy_coredump = 0;
106 SYSCTL_INT(_debug, OID_AUTO, __elfN(legacy_coredump), CTLFLAG_RW,
107 &elf_legacy_coredump, 0, "");
109 static Elf_Brandinfo *elf_brand_list[MAX_BRANDS];
111 #define trunc_page_ps(va, ps) ((va) & ~(ps - 1))
112 #define round_page_ps(va, ps) (((va) + (ps - 1)) & ~(ps - 1))
113 #define aligned(a, t) (trunc_page_ps((u_long)(a), sizeof(t)) == (u_long)(a))
115 static const char FREEBSD_ABI_VENDOR[] = "FreeBSD";
117 Elf_Brandnote __elfN(freebsd_brandnote) = {
118 .hdr.n_namesz = sizeof(FREEBSD_ABI_VENDOR),
119 .hdr.n_descsz = sizeof(int32_t),
121 .vendor = FREEBSD_ABI_VENDOR,
122 .flags = BN_TRANSLATE_OSREL,
123 .trans_osrel = __elfN(freebsd_trans_osrel)
127 __elfN(freebsd_trans_osrel)(const Elf_Note *note, int32_t *osrel)
131 p = (uintptr_t)(note + 1);
132 p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
133 *osrel = *(const int32_t *)(p);
138 static const char GNU_ABI_VENDOR[] = "GNU";
139 static int GNU_KFREEBSD_ABI_DESC = 3;
141 Elf_Brandnote __elfN(kfreebsd_brandnote) = {
142 .hdr.n_namesz = sizeof(GNU_ABI_VENDOR),
143 .hdr.n_descsz = 16, /* XXX at least 16 */
145 .vendor = GNU_ABI_VENDOR,
146 .flags = BN_TRANSLATE_OSREL,
147 .trans_osrel = kfreebsd_trans_osrel
151 kfreebsd_trans_osrel(const Elf_Note *note, int32_t *osrel)
153 const Elf32_Word *desc;
156 p = (uintptr_t)(note + 1);
157 p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
159 desc = (const Elf32_Word *)p;
160 if (desc[0] != GNU_KFREEBSD_ABI_DESC)
164 * Debian GNU/kFreeBSD embed the earliest compatible kernel version
165 * (__FreeBSD_version: <major><two digit minor>Rxx) in the LSB way.
167 *osrel = desc[1] * 100000 + desc[2] * 1000 + desc[3];
173 __elfN(insert_brand_entry)(Elf_Brandinfo *entry)
177 for (i = 0; i < MAX_BRANDS; i++) {
178 if (elf_brand_list[i] == NULL) {
179 elf_brand_list[i] = entry;
189 __elfN(remove_brand_entry)(Elf_Brandinfo *entry)
193 for (i = 0; i < MAX_BRANDS; i++) {
194 if (elf_brand_list[i] == entry) {
195 elf_brand_list[i] = NULL;
205 __elfN(brand_inuse)(Elf_Brandinfo *entry)
210 sx_slock(&allproc_lock);
211 FOREACH_PROC_IN_SYSTEM(p) {
212 if (p->p_sysent == entry->sysvec) {
217 sx_sunlock(&allproc_lock);
222 static Elf_Brandinfo *
223 __elfN(get_brandinfo)(struct image_params *imgp, const char *interp,
226 const Elf_Ehdr *hdr = (const Elf_Ehdr *)imgp->image_header;
232 * We support four types of branding -- (1) the ELF EI_OSABI field
233 * that SCO added to the ELF spec, (2) FreeBSD 3.x's traditional string
234 * branding w/in the ELF header, (3) path of the `interp_path'
235 * field, and (4) the ".note.ABI-tag" ELF section.
238 /* Look for an ".note.ABI-tag" ELF section */
239 for (i = 0; i < MAX_BRANDS; i++) {
240 bi = elf_brand_list[i];
243 if (hdr->e_machine == bi->machine && (bi->flags &
244 (BI_BRAND_NOTE|BI_BRAND_NOTE_MANDATORY)) != 0) {
245 ret = __elfN(check_note)(imgp, bi->brand_note, osrel);
251 /* If the executable has a brand, search for it in the brand list. */
252 for (i = 0; i < MAX_BRANDS; i++) {
253 bi = elf_brand_list[i];
254 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY)
256 if (hdr->e_machine == bi->machine &&
257 (hdr->e_ident[EI_OSABI] == bi->brand ||
258 strncmp((const char *)&hdr->e_ident[OLD_EI_BRAND],
259 bi->compat_3_brand, strlen(bi->compat_3_brand)) == 0))
263 /* Lacking a known brand, search for a recognized interpreter. */
264 if (interp != NULL) {
265 for (i = 0; i < MAX_BRANDS; i++) {
266 bi = elf_brand_list[i];
267 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY)
269 if (hdr->e_machine == bi->machine &&
270 strcmp(interp, bi->interp_path) == 0)
275 /* Lacking a recognized interpreter, try the default brand */
276 for (i = 0; i < MAX_BRANDS; i++) {
277 bi = elf_brand_list[i];
278 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY)
280 if (hdr->e_machine == bi->machine &&
281 __elfN(fallback_brand) == bi->brand)
288 __elfN(check_header)(const Elf_Ehdr *hdr)
294 hdr->e_ident[EI_CLASS] != ELF_TARG_CLASS ||
295 hdr->e_ident[EI_DATA] != ELF_TARG_DATA ||
296 hdr->e_ident[EI_VERSION] != EV_CURRENT ||
297 hdr->e_phentsize != sizeof(Elf_Phdr) ||
298 hdr->e_version != ELF_TARG_VER)
302 * Make sure we have at least one brand for this machine.
305 for (i = 0; i < MAX_BRANDS; i++) {
306 bi = elf_brand_list[i];
307 if (bi != NULL && bi->machine == hdr->e_machine)
317 __elfN(map_partial)(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
318 vm_offset_t start, vm_offset_t end, vm_prot_t prot)
325 * Create the page if it doesn't exist yet. Ignore errors.
328 vm_map_insert(map, NULL, 0, trunc_page(start), round_page(end),
329 VM_PROT_ALL, VM_PROT_ALL, 0);
333 * Find the page from the underlying object.
336 sf = vm_imgact_map_page(object, offset);
338 return (KERN_FAILURE);
339 off = offset - trunc_page(offset);
340 error = copyout((caddr_t)sf_buf_kva(sf) + off, (caddr_t)start,
342 vm_imgact_unmap_page(sf);
344 return (KERN_FAILURE);
348 return (KERN_SUCCESS);
352 __elfN(map_insert)(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
353 vm_offset_t start, vm_offset_t end, vm_prot_t prot, int cow)
360 if (start != trunc_page(start)) {
361 rv = __elfN(map_partial)(map, object, offset, start,
362 round_page(start), prot);
365 offset += round_page(start) - start;
366 start = round_page(start);
368 if (end != round_page(end)) {
369 rv = __elfN(map_partial)(map, object, offset +
370 trunc_page(end) - start, trunc_page(end), end, prot);
373 end = trunc_page(end);
376 if (offset & PAGE_MASK) {
378 * The mapping is not page aligned. This means we have
379 * to copy the data. Sigh.
381 rv = vm_map_find(map, NULL, 0, &start, end - start,
382 FALSE, prot | VM_PROT_WRITE, VM_PROT_ALL, 0);
386 return (KERN_SUCCESS);
387 for (; start < end; start += sz) {
388 sf = vm_imgact_map_page(object, offset);
390 return (KERN_FAILURE);
391 off = offset - trunc_page(offset);
393 if (sz > PAGE_SIZE - off)
394 sz = PAGE_SIZE - off;
395 error = copyout((caddr_t)sf_buf_kva(sf) + off,
397 vm_imgact_unmap_page(sf);
399 return (KERN_FAILURE);
405 vm_object_reference(object);
407 rv = vm_map_insert(map, object, offset, start, end,
408 prot, VM_PROT_ALL, cow);
410 if (rv != KERN_SUCCESS)
411 vm_object_deallocate(object);
415 return (KERN_SUCCESS);
420 __elfN(load_section)(struct vmspace *vmspace,
421 vm_object_t object, vm_offset_t offset,
422 caddr_t vmaddr, size_t memsz, size_t filsz, vm_prot_t prot,
427 vm_offset_t map_addr;
430 vm_offset_t file_addr;
433 * It's necessary to fail if the filsz + offset taken from the
434 * header is greater than the actual file pager object's size.
435 * If we were to allow this, then the vm_map_find() below would
436 * walk right off the end of the file object and into the ether.
438 * While I'm here, might as well check for something else that
439 * is invalid: filsz cannot be greater than memsz.
441 if ((off_t)filsz + offset > object->un_pager.vnp.vnp_size ||
443 uprintf("elf_load_section: truncated ELF file\n");
447 map_addr = trunc_page_ps((vm_offset_t)vmaddr, pagesize);
448 file_addr = trunc_page_ps(offset, pagesize);
451 * We have two choices. We can either clear the data in the last page
452 * of an oversized mapping, or we can start the anon mapping a page
453 * early and copy the initialized data into that first page. We
454 * choose the second..
457 map_len = trunc_page_ps(offset + filsz, pagesize) - file_addr;
459 map_len = round_page_ps(offset + filsz, pagesize) - file_addr;
462 /* cow flags: don't dump readonly sections in core */
463 cow = MAP_COPY_ON_WRITE | MAP_PREFAULT |
464 (prot & VM_PROT_WRITE ? 0 : MAP_DISABLE_COREDUMP);
466 rv = __elfN(map_insert)(&vmspace->vm_map,
468 file_addr, /* file offset */
469 map_addr, /* virtual start */
470 map_addr + map_len,/* virtual end */
473 if (rv != KERN_SUCCESS)
476 /* we can stop now if we've covered it all */
477 if (memsz == filsz) {
484 * We have to get the remaining bit of the file into the first part
485 * of the oversized map segment. This is normally because the .data
486 * segment in the file is extended to provide bss. It's a neat idea
487 * to try and save a page, but it's a pain in the behind to implement.
489 copy_len = (offset + filsz) - trunc_page_ps(offset + filsz, pagesize);
490 map_addr = trunc_page_ps((vm_offset_t)vmaddr + filsz, pagesize);
491 map_len = round_page_ps((vm_offset_t)vmaddr + memsz, pagesize) -
494 /* This had damn well better be true! */
496 rv = __elfN(map_insert)(&vmspace->vm_map, NULL, 0, map_addr,
497 map_addr + map_len, VM_PROT_ALL, 0);
498 if (rv != KERN_SUCCESS) {
506 sf = vm_imgact_map_page(object, offset + filsz);
510 /* send the page fragment to user space */
511 off = trunc_page_ps(offset + filsz, pagesize) -
512 trunc_page(offset + filsz);
513 error = copyout((caddr_t)sf_buf_kva(sf) + off,
514 (caddr_t)map_addr, copy_len);
515 vm_imgact_unmap_page(sf);
522 * set it to the specified protection.
523 * XXX had better undo the damage from pasting over the cracks here!
525 vm_map_protect(&vmspace->vm_map, trunc_page(map_addr),
526 round_page(map_addr + map_len), prot, FALSE);
532 * Load the file "file" into memory. It may be either a shared object
535 * The "addr" reference parameter is in/out. On entry, it specifies
536 * the address where a shared object should be loaded. If the file is
537 * an executable, this value is ignored. On exit, "addr" specifies
538 * where the file was actually loaded.
540 * The "entry" reference parameter is out only. On exit, it specifies
541 * the entry point for the loaded file.
544 __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
545 u_long *entry, size_t pagesize)
550 struct image_params image_params;
552 const Elf_Ehdr *hdr = NULL;
553 const Elf_Phdr *phdr = NULL;
554 struct nameidata *nd;
555 struct vmspace *vmspace = p->p_vmspace;
557 struct image_params *imgp;
560 u_long base_addr = 0;
561 int vfslocked, error, i, numsegs;
563 tempdata = malloc(sizeof(*tempdata), M_TEMP, M_WAITOK);
565 attr = &tempdata->attr;
566 imgp = &tempdata->image_params;
569 * Initialize part of the common data
573 imgp->firstpage = NULL;
574 imgp->image_header = NULL;
576 imgp->execlabel = NULL;
578 NDINIT(nd, LOOKUP, MPSAFE|LOCKLEAF|FOLLOW, UIO_SYSSPACE, file,
581 if ((error = namei(nd)) != 0) {
585 vfslocked = NDHASGIANT(nd);
586 NDFREE(nd, NDF_ONLY_PNBUF);
587 imgp->vp = nd->ni_vp;
590 * Check permissions, modes, uid, etc on the file, and "open" it.
592 error = exec_check_permissions(imgp);
596 error = exec_map_first_page(imgp);
601 * Also make certain that the interpreter stays the same, so set
602 * its VV_TEXT flag, too.
604 nd->ni_vp->v_vflag |= VV_TEXT;
606 imgp->object = nd->ni_vp->v_object;
608 hdr = (const Elf_Ehdr *)imgp->image_header;
609 if ((error = __elfN(check_header)(hdr)) != 0)
611 if (hdr->e_type == ET_DYN)
613 else if (hdr->e_type == ET_EXEC)
620 /* Only support headers that fit within first page for now */
621 /* (multiplication of two Elf_Half fields will not overflow) */
622 if ((hdr->e_phoff > PAGE_SIZE) ||
623 (hdr->e_phentsize * hdr->e_phnum) > PAGE_SIZE - hdr->e_phoff) {
628 phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
629 if (!aligned(phdr, Elf_Addr)) {
634 for (i = 0, numsegs = 0; i < hdr->e_phnum; i++) {
635 if (phdr[i].p_type == PT_LOAD && phdr[i].p_memsz != 0) {
636 /* Loadable segment */
638 if (phdr[i].p_flags & PF_X)
639 prot |= VM_PROT_EXECUTE;
640 if (phdr[i].p_flags & PF_W)
641 prot |= VM_PROT_WRITE;
642 if (phdr[i].p_flags & PF_R)
643 prot |= VM_PROT_READ;
645 if ((error = __elfN(load_section)(vmspace,
646 imgp->object, phdr[i].p_offset,
647 (caddr_t)(uintptr_t)phdr[i].p_vaddr + rbase,
648 phdr[i].p_memsz, phdr[i].p_filesz, prot,
652 * Establish the base address if this is the
656 base_addr = trunc_page(phdr[i].p_vaddr +
662 *entry = (unsigned long)hdr->e_entry + rbase;
666 exec_unmap_first_page(imgp);
671 VFS_UNLOCK_GIANT(vfslocked);
672 free(tempdata, M_TEMP);
678 __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp)
680 const Elf_Ehdr *hdr = (const Elf_Ehdr *)imgp->image_header;
681 const Elf_Phdr *phdr;
682 Elf_Auxargs *elf_auxargs;
683 struct vmspace *vmspace;
685 u_long text_size = 0, data_size = 0, total_size = 0;
686 u_long text_addr = 0, data_addr = 0;
687 u_long seg_size, seg_addr;
688 u_long addr, entry = 0, proghdr = 0;
691 const char *interp = NULL, *newinterp = NULL;
692 Elf_Brandinfo *brand_info;
694 struct sysentvec *sv;
697 * Do we have a valid ELF header ?
699 * Only allow ET_EXEC & ET_DYN here, reject ET_DYN later
700 * if particular brand doesn't support it.
702 if (__elfN(check_header)(hdr) != 0 ||
703 (hdr->e_type != ET_EXEC && hdr->e_type != ET_DYN))
707 * From here on down, we return an errno, not -1, as we've
708 * detected an ELF file.
711 if ((hdr->e_phoff > PAGE_SIZE) ||
712 (hdr->e_phoff + hdr->e_phentsize * hdr->e_phnum) > PAGE_SIZE) {
713 /* Only support headers in first page for now */
716 phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
717 if (!aligned(phdr, Elf_Addr))
719 for (i = 0; i < hdr->e_phnum; i++) {
720 if (phdr[i].p_type == PT_INTERP) {
721 /* Path to interpreter */
722 if (phdr[i].p_filesz > MAXPATHLEN ||
723 phdr[i].p_offset + phdr[i].p_filesz > PAGE_SIZE)
725 interp = imgp->image_header + phdr[i].p_offset;
730 brand_info = __elfN(get_brandinfo)(imgp, interp, &osrel);
731 if (brand_info == NULL) {
732 uprintf("ELF binary type \"%u\" not known.\n",
733 hdr->e_ident[EI_OSABI]);
736 if (hdr->e_type == ET_DYN &&
737 (brand_info->flags & BI_CAN_EXEC_DYN) == 0)
739 sv = brand_info->sysvec;
740 if (interp != NULL && brand_info->interp_newpath != NULL)
741 newinterp = brand_info->interp_newpath;
744 * Avoid a possible deadlock if the current address space is destroyed
745 * and that address space maps the locked vnode. In the common case,
746 * the locked vnode's v_usecount is decremented but remains greater
747 * than zero. Consequently, the vnode lock is not needed by vrele().
748 * However, in cases where the vnode lock is external, such as nullfs,
749 * v_usecount may become zero.
751 VOP_UNLOCK(imgp->vp, 0);
753 error = exec_new_vmspace(imgp, sv);
754 imgp->proc->p_sysent = sv;
756 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
760 vmspace = imgp->proc->p_vmspace;
762 for (i = 0; i < hdr->e_phnum; i++) {
763 switch (phdr[i].p_type) {
764 case PT_LOAD: /* Loadable segment */
765 if (phdr[i].p_memsz == 0)
768 if (phdr[i].p_flags & PF_X)
769 prot |= VM_PROT_EXECUTE;
770 if (phdr[i].p_flags & PF_W)
771 prot |= VM_PROT_WRITE;
772 if (phdr[i].p_flags & PF_R)
773 prot |= VM_PROT_READ;
775 #if defined(__ia64__) && __ELF_WORD_SIZE == 32 && defined(IA32_ME_HARDER)
777 * Some x86 binaries assume read == executable,
778 * notably the M3 runtime and therefore cvsup
780 if (prot & VM_PROT_READ)
781 prot |= VM_PROT_EXECUTE;
784 if ((error = __elfN(load_section)(vmspace,
785 imgp->object, phdr[i].p_offset,
786 (caddr_t)(uintptr_t)phdr[i].p_vaddr,
787 phdr[i].p_memsz, phdr[i].p_filesz, prot,
788 sv->sv_pagesize)) != 0)
792 * If this segment contains the program headers,
793 * remember their virtual address for the AT_PHDR
794 * aux entry. Static binaries don't usually include
797 if (phdr[i].p_offset == 0 &&
798 hdr->e_phoff + hdr->e_phnum * hdr->e_phentsize
800 proghdr = phdr[i].p_vaddr + hdr->e_phoff;
802 seg_addr = trunc_page(phdr[i].p_vaddr);
803 seg_size = round_page(phdr[i].p_memsz +
804 phdr[i].p_vaddr - seg_addr);
807 * Is this .text or .data? We can't use
808 * VM_PROT_WRITE or VM_PROT_EXEC, it breaks the
809 * alpha terribly and possibly does other bad
810 * things so we stick to the old way of figuring
811 * it out: If the segment contains the program
812 * entry point, it's a text segment, otherwise it
815 * Note that obreak() assumes that data_addr +
816 * data_size == end of data load area, and the ELF
817 * file format expects segments to be sorted by
818 * address. If multiple data segments exist, the
819 * last one will be used.
821 if (hdr->e_entry >= phdr[i].p_vaddr &&
822 hdr->e_entry < (phdr[i].p_vaddr +
824 text_size = seg_size;
825 text_addr = seg_addr;
826 entry = (u_long)hdr->e_entry;
828 data_size = seg_size;
829 data_addr = seg_addr;
831 total_size += seg_size;
833 case PT_PHDR: /* Program header table info */
834 proghdr = phdr[i].p_vaddr;
841 if (data_addr == 0 && data_size == 0) {
842 data_addr = text_addr;
843 data_size = text_size;
847 * Check limits. It should be safe to check the
848 * limits after loading the segments since we do
849 * not actually fault in all the segments pages.
851 PROC_LOCK(imgp->proc);
852 if (data_size > lim_cur(imgp->proc, RLIMIT_DATA) ||
853 text_size > maxtsiz ||
854 total_size > lim_cur(imgp->proc, RLIMIT_VMEM)) {
855 PROC_UNLOCK(imgp->proc);
859 vmspace->vm_tsize = text_size >> PAGE_SHIFT;
860 vmspace->vm_taddr = (caddr_t)(uintptr_t)text_addr;
861 vmspace->vm_dsize = data_size >> PAGE_SHIFT;
862 vmspace->vm_daddr = (caddr_t)(uintptr_t)data_addr;
865 * We load the dynamic linker where a userland call
866 * to mmap(0, ...) would put it. The rationale behind this
867 * calculation is that it leaves room for the heap to grow to
868 * its maximum allowed size.
870 addr = round_page((vm_offset_t)imgp->proc->p_vmspace->vm_daddr +
871 lim_max(imgp->proc, RLIMIT_DATA));
872 PROC_UNLOCK(imgp->proc);
874 imgp->entry_addr = entry;
876 if (interp != NULL) {
877 int have_interp = FALSE;
878 VOP_UNLOCK(imgp->vp, 0);
879 if (brand_info->emul_path != NULL &&
880 brand_info->emul_path[0] != '\0') {
881 path = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
882 snprintf(path, MAXPATHLEN, "%s%s",
883 brand_info->emul_path, interp);
884 error = __elfN(load_file)(imgp->proc, path, &addr,
885 &imgp->entry_addr, sv->sv_pagesize);
890 if (!have_interp && newinterp != NULL) {
891 error = __elfN(load_file)(imgp->proc, newinterp, &addr,
892 &imgp->entry_addr, sv->sv_pagesize);
897 error = __elfN(load_file)(imgp->proc, interp, &addr,
898 &imgp->entry_addr, sv->sv_pagesize);
900 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
902 uprintf("ELF interpreter %s not found\n", interp);
909 * Construct auxargs table (used by the fixup routine)
911 elf_auxargs = malloc(sizeof(Elf_Auxargs), M_TEMP, M_WAITOK);
912 elf_auxargs->execfd = -1;
913 elf_auxargs->phdr = proghdr;
914 elf_auxargs->phent = hdr->e_phentsize;
915 elf_auxargs->phnum = hdr->e_phnum;
916 elf_auxargs->pagesz = PAGE_SIZE;
917 elf_auxargs->base = addr;
918 elf_auxargs->flags = 0;
919 elf_auxargs->entry = entry;
921 imgp->auxargs = elf_auxargs;
922 imgp->interpreted = 0;
923 imgp->proc->p_osrel = osrel;
928 #define suword __CONCAT(suword, __ELF_WORD_SIZE)
931 __elfN(freebsd_fixup)(register_t **stack_base, struct image_params *imgp)
933 Elf_Auxargs *args = (Elf_Auxargs *)imgp->auxargs;
937 base = (Elf_Addr *)*stack_base;
938 pos = base + (imgp->args->argc + imgp->args->envc + 2);
940 if (args->execfd != -1)
941 AUXARGS_ENTRY(pos, AT_EXECFD, args->execfd);
942 AUXARGS_ENTRY(pos, AT_PHDR, args->phdr);
943 AUXARGS_ENTRY(pos, AT_PHENT, args->phent);
944 AUXARGS_ENTRY(pos, AT_PHNUM, args->phnum);
945 AUXARGS_ENTRY(pos, AT_PAGESZ, args->pagesz);
946 AUXARGS_ENTRY(pos, AT_FLAGS, args->flags);
947 AUXARGS_ENTRY(pos, AT_ENTRY, args->entry);
948 AUXARGS_ENTRY(pos, AT_BASE, args->base);
949 if (imgp->execpathp != 0)
950 AUXARGS_ENTRY(pos, AT_EXECPATH, imgp->execpathp);
951 AUXARGS_ENTRY(pos, AT_NULL, 0);
953 free(imgp->auxargs, M_TEMP);
954 imgp->auxargs = NULL;
957 suword(base, (long)imgp->args->argc);
958 *stack_base = (register_t *)base;
963 * Code for generating ELF core dumps.
966 typedef void (*segment_callback)(vm_map_entry_t, void *);
968 /* Closure for cb_put_phdr(). */
969 struct phdr_closure {
970 Elf_Phdr *phdr; /* Program header to fill in */
971 Elf_Off offset; /* Offset of segment in core file */
974 /* Closure for cb_size_segment(). */
975 struct sseg_closure {
976 int count; /* Count of writable segments. */
977 size_t size; /* Total size of all writable segments. */
980 static void cb_put_phdr(vm_map_entry_t, void *);
981 static void cb_size_segment(vm_map_entry_t, void *);
982 static void each_writable_segment(struct thread *, segment_callback, void *);
983 static int __elfN(corehdr)(struct thread *, struct vnode *, struct ucred *,
984 int, void *, size_t);
985 static void __elfN(puthdr)(struct thread *, void *, size_t *, int);
986 static void __elfN(putnote)(void *, size_t *, const char *, int,
987 const void *, size_t);
990 __elfN(coredump)(td, vp, limit)
995 struct ucred *cred = td->td_ucred;
997 struct sseg_closure seginfo;
1001 /* Size the program segments. */
1004 each_writable_segment(td, cb_size_segment, &seginfo);
1007 * Calculate the size of the core file header area by making
1008 * a dry run of generating it. Nothing is written, but the
1009 * size is calculated.
1012 __elfN(puthdr)(td, (void *)NULL, &hdrsize, seginfo.count);
1014 if (hdrsize + seginfo.size >= limit)
1018 * Allocate memory for building the header, fill it up,
1021 hdr = malloc(hdrsize, M_TEMP, M_WAITOK);
1025 error = __elfN(corehdr)(td, vp, cred, seginfo.count, hdr, hdrsize);
1027 /* Write the contents of all of the writable segments. */
1033 php = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr)) + 1;
1035 for (i = 0; i < seginfo.count; i++) {
1036 error = vn_rdwr_inchunks(UIO_WRITE, vp,
1037 (caddr_t)(uintptr_t)php->p_vaddr,
1038 php->p_filesz, offset, UIO_USERSPACE,
1039 IO_UNIT | IO_DIRECT, cred, NOCRED, NULL,
1043 offset += php->p_filesz;
1053 * A callback for each_writable_segment() to write out the segment's
1054 * program header entry.
1057 cb_put_phdr(entry, closure)
1058 vm_map_entry_t entry;
1061 struct phdr_closure *phc = (struct phdr_closure *)closure;
1062 Elf_Phdr *phdr = phc->phdr;
1064 phc->offset = round_page(phc->offset);
1066 phdr->p_type = PT_LOAD;
1067 phdr->p_offset = phc->offset;
1068 phdr->p_vaddr = entry->start;
1070 phdr->p_filesz = phdr->p_memsz = entry->end - entry->start;
1071 phdr->p_align = PAGE_SIZE;
1073 if (entry->protection & VM_PROT_READ)
1074 phdr->p_flags |= PF_R;
1075 if (entry->protection & VM_PROT_WRITE)
1076 phdr->p_flags |= PF_W;
1077 if (entry->protection & VM_PROT_EXECUTE)
1078 phdr->p_flags |= PF_X;
1080 phc->offset += phdr->p_filesz;
1085 * A callback for each_writable_segment() to gather information about
1086 * the number of segments and their total size.
1089 cb_size_segment(entry, closure)
1090 vm_map_entry_t entry;
1093 struct sseg_closure *ssc = (struct sseg_closure *)closure;
1096 ssc->size += entry->end - entry->start;
1100 * For each writable segment in the process's memory map, call the given
1101 * function with a pointer to the map entry and some arbitrary
1102 * caller-supplied data.
1105 each_writable_segment(td, func, closure)
1107 segment_callback func;
1110 struct proc *p = td->td_proc;
1111 vm_map_t map = &p->p_vmspace->vm_map;
1112 vm_map_entry_t entry;
1113 vm_object_t backing_object, object;
1114 boolean_t ignore_entry;
1116 vm_map_lock_read(map);
1117 for (entry = map->header.next; entry != &map->header;
1118 entry = entry->next) {
1120 * Don't dump inaccessible mappings, deal with legacy
1123 * Note that read-only segments related to the elf binary
1124 * are marked MAP_ENTRY_NOCOREDUMP now so we no longer
1125 * need to arbitrarily ignore such segments.
1127 if (elf_legacy_coredump) {
1128 if ((entry->protection & VM_PROT_RW) != VM_PROT_RW)
1131 if ((entry->protection & VM_PROT_ALL) == 0)
1136 * Dont include memory segment in the coredump if
1137 * MAP_NOCORE is set in mmap(2) or MADV_NOCORE in
1138 * madvise(2). Do not dump submaps (i.e. parts of the
1141 if (entry->eflags & (MAP_ENTRY_NOCOREDUMP|MAP_ENTRY_IS_SUB_MAP))
1144 if ((object = entry->object.vm_object) == NULL)
1147 /* Ignore memory-mapped devices and such things. */
1148 VM_OBJECT_LOCK(object);
1149 while ((backing_object = object->backing_object) != NULL) {
1150 VM_OBJECT_LOCK(backing_object);
1151 VM_OBJECT_UNLOCK(object);
1152 object = backing_object;
1154 ignore_entry = object->type != OBJT_DEFAULT &&
1155 object->type != OBJT_SWAP && object->type != OBJT_VNODE;
1156 VM_OBJECT_UNLOCK(object);
1160 (*func)(entry, closure);
1162 vm_map_unlock_read(map);
1166 * Write the core file header to the file, including padding up to
1167 * the page boundary.
1170 __elfN(corehdr)(td, vp, cred, numsegs, hdr, hdrsize)
1180 /* Fill in the header. */
1181 bzero(hdr, hdrsize);
1183 __elfN(puthdr)(td, hdr, &off, numsegs);
1185 /* Write it to the core file. */
1186 return (vn_rdwr_inchunks(UIO_WRITE, vp, hdr, hdrsize, (off_t)0,
1187 UIO_SYSSPACE, IO_UNIT | IO_DIRECT, cred, NOCRED, NULL,
1191 #if defined(COMPAT_IA32) && __ELF_WORD_SIZE == 32
1192 typedef struct prstatus32 elf_prstatus_t;
1193 typedef struct prpsinfo32 elf_prpsinfo_t;
1194 typedef struct fpreg32 elf_prfpregset_t;
1195 typedef struct fpreg32 elf_fpregset_t;
1196 typedef struct reg32 elf_gregset_t;
1198 typedef prstatus_t elf_prstatus_t;
1199 typedef prpsinfo_t elf_prpsinfo_t;
1200 typedef prfpregset_t elf_prfpregset_t;
1201 typedef prfpregset_t elf_fpregset_t;
1202 typedef gregset_t elf_gregset_t;
1206 __elfN(puthdr)(struct thread *td, void *dst, size_t *off, int numsegs)
1209 elf_prstatus_t status;
1210 elf_prfpregset_t fpregset;
1211 elf_prpsinfo_t psinfo;
1213 elf_prstatus_t *status;
1214 elf_prfpregset_t *fpregset;
1215 elf_prpsinfo_t *psinfo;
1218 size_t ehoff, noteoff, notesz, phoff;
1223 *off += sizeof(Elf_Ehdr);
1226 *off += (numsegs + 1) * sizeof(Elf_Phdr);
1230 * Don't allocate space for the notes if we're just calculating
1231 * the size of the header. We also don't collect the data.
1234 tempdata = malloc(sizeof(*tempdata), M_TEMP, M_ZERO|M_WAITOK);
1235 status = &tempdata->status;
1236 fpregset = &tempdata->fpregset;
1237 psinfo = &tempdata->psinfo;
1246 psinfo->pr_version = PRPSINFO_VERSION;
1247 psinfo->pr_psinfosz = sizeof(elf_prpsinfo_t);
1248 strlcpy(psinfo->pr_fname, p->p_comm, sizeof(psinfo->pr_fname));
1250 * XXX - We don't fill in the command line arguments properly
1253 strlcpy(psinfo->pr_psargs, p->p_comm,
1254 sizeof(psinfo->pr_psargs));
1256 __elfN(putnote)(dst, off, "FreeBSD", NT_PRPSINFO, psinfo,
1260 * To have the debugger select the right thread (LWP) as the initial
1261 * thread, we dump the state of the thread passed to us in td first.
1262 * This is the thread that causes the core dump and thus likely to
1263 * be the right thread one wants to have selected in the debugger.
1266 while (thr != NULL) {
1268 status->pr_version = PRSTATUS_VERSION;
1269 status->pr_statussz = sizeof(elf_prstatus_t);
1270 status->pr_gregsetsz = sizeof(elf_gregset_t);
1271 status->pr_fpregsetsz = sizeof(elf_fpregset_t);
1272 status->pr_osreldate = osreldate;
1273 status->pr_cursig = p->p_sig;
1274 status->pr_pid = thr->td_tid;
1275 #if defined(COMPAT_IA32) && __ELF_WORD_SIZE == 32
1276 fill_regs32(thr, &status->pr_reg);
1277 fill_fpregs32(thr, fpregset);
1279 fill_regs(thr, &status->pr_reg);
1280 fill_fpregs(thr, fpregset);
1283 __elfN(putnote)(dst, off, "FreeBSD", NT_PRSTATUS, status,
1285 __elfN(putnote)(dst, off, "FreeBSD", NT_FPREGSET, fpregset,
1288 * Allow for MD specific notes, as well as any MD
1289 * specific preparations for writing MI notes.
1291 __elfN(dump_thread)(thr, dst, off);
1293 thr = (thr == td) ? TAILQ_FIRST(&p->p_threads) :
1294 TAILQ_NEXT(thr, td_plist);
1296 thr = TAILQ_NEXT(thr, td_plist);
1299 notesz = *off - noteoff;
1302 free(tempdata, M_TEMP);
1304 /* Align up to a page boundary for the program segments. */
1305 *off = round_page(*off);
1310 struct phdr_closure phc;
1313 * Fill in the ELF header.
1315 ehdr = (Elf_Ehdr *)((char *)dst + ehoff);
1316 ehdr->e_ident[EI_MAG0] = ELFMAG0;
1317 ehdr->e_ident[EI_MAG1] = ELFMAG1;
1318 ehdr->e_ident[EI_MAG2] = ELFMAG2;
1319 ehdr->e_ident[EI_MAG3] = ELFMAG3;
1320 ehdr->e_ident[EI_CLASS] = ELF_CLASS;
1321 ehdr->e_ident[EI_DATA] = ELF_DATA;
1322 ehdr->e_ident[EI_VERSION] = EV_CURRENT;
1323 ehdr->e_ident[EI_OSABI] = ELFOSABI_FREEBSD;
1324 ehdr->e_ident[EI_ABIVERSION] = 0;
1325 ehdr->e_ident[EI_PAD] = 0;
1326 ehdr->e_type = ET_CORE;
1327 #if defined(COMPAT_IA32) && __ELF_WORD_SIZE == 32
1328 ehdr->e_machine = EM_386;
1330 ehdr->e_machine = ELF_ARCH;
1332 ehdr->e_version = EV_CURRENT;
1334 ehdr->e_phoff = phoff;
1336 ehdr->e_ehsize = sizeof(Elf_Ehdr);
1337 ehdr->e_phentsize = sizeof(Elf_Phdr);
1338 ehdr->e_phnum = numsegs + 1;
1339 ehdr->e_shentsize = sizeof(Elf_Shdr);
1341 ehdr->e_shstrndx = SHN_UNDEF;
1344 * Fill in the program header entries.
1346 phdr = (Elf_Phdr *)((char *)dst + phoff);
1348 /* The note segement. */
1349 phdr->p_type = PT_NOTE;
1350 phdr->p_offset = noteoff;
1353 phdr->p_filesz = notesz;
1359 /* All the writable segments from the program. */
1362 each_writable_segment(td, cb_put_phdr, &phc);
1367 __elfN(putnote)(void *dst, size_t *off, const char *name, int type,
1368 const void *desc, size_t descsz)
1372 note.n_namesz = strlen(name) + 1;
1373 note.n_descsz = descsz;
1376 bcopy(¬e, (char *)dst + *off, sizeof note);
1377 *off += sizeof note;
1379 bcopy(name, (char *)dst + *off, note.n_namesz);
1380 *off += roundup2(note.n_namesz, sizeof(Elf_Size));
1382 bcopy(desc, (char *)dst + *off, note.n_descsz);
1383 *off += roundup2(note.n_descsz, sizeof(Elf_Size));
1387 * Try to find the appropriate ABI-note section for checknote,
1388 * fetch the osreldate for binary from the ELF OSABI-note. Only the
1389 * first page of the image is searched, the same as for headers.
1392 __elfN(check_note)(struct image_params *imgp, Elf_Brandnote *checknote,
1395 const Elf_Note *note, *note0, *note_end;
1396 const Elf_Phdr *phdr, *pnote;
1397 const Elf_Ehdr *hdr;
1398 const char *note_name;
1402 hdr = (const Elf_Ehdr *)imgp->image_header;
1403 phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
1405 for (i = 0; i < hdr->e_phnum; i++) {
1406 if (phdr[i].p_type == PT_NOTE) {
1412 if (pnote == NULL || pnote->p_offset >= PAGE_SIZE ||
1413 pnote->p_offset + pnote->p_filesz >= PAGE_SIZE)
1416 note = note0 = (const Elf_Note *)(imgp->image_header + pnote->p_offset);
1417 note_end = (const Elf_Note *)(imgp->image_header +
1418 pnote->p_offset + pnote->p_filesz);
1419 for (i = 0; i < 100 && note >= note0 && note < note_end; i++) {
1420 if (!aligned(note, Elf32_Addr))
1422 if (note->n_namesz != checknote->hdr.n_namesz ||
1423 note->n_descsz != checknote->hdr.n_descsz ||
1424 note->n_type != checknote->hdr.n_type)
1426 note_name = (const char *)(note + 1);
1427 if (strncmp(checknote->vendor, note_name,
1428 checknote->hdr.n_namesz) != 0)
1432 * Fetch the osreldate for binary
1433 * from the ELF OSABI-note if necessary.
1435 if ((checknote->flags & BN_TRANSLATE_OSREL) != 0 &&
1436 checknote->trans_osrel != NULL)
1437 return (checknote->trans_osrel(note, osrel));
1441 note = (const Elf_Note *)((const char *)(note + 1) +
1442 roundup2(note->n_namesz, sizeof(Elf32_Addr)) +
1443 roundup2(note->n_descsz, sizeof(Elf32_Addr)));
1450 * Tell kern_execve.c about it, with a little help from the linker.
1452 static struct execsw __elfN(execsw) = {
1453 __CONCAT(exec_, __elfN(imgact)),
1454 __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE))
1456 EXEC_SET(__CONCAT(elf, __ELF_WORD_SIZE), __elfN(execsw));