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 <sys/param.h>
36 #include <sys/fcntl.h>
37 #include <sys/imgact.h>
38 #include <sys/imgact_elf.h>
39 #include <sys/kernel.h>
41 #include <sys/malloc.h>
42 #include <sys/mutex.h>
44 #include <sys/namei.h>
45 #include <sys/pioctl.h>
47 #include <sys/procfs.h>
48 #include <sys/resourcevar.h>
49 #include <sys/systm.h>
50 #include <sys/signalvar.h>
53 #include <sys/syscall.h>
54 #include <sys/sysctl.h>
55 #include <sys/sysent.h>
56 #include <sys/vnode.h>
59 #include <vm/vm_kern.h>
60 #include <vm/vm_param.h>
62 #include <vm/vm_map.h>
63 #include <vm/vm_object.h>
64 #include <vm/vm_extern.h>
66 #include <machine/elf.h>
67 #include <machine/md_var.h>
69 #define OLD_EI_BRAND 8
71 static int __elfN(check_header)(const Elf_Ehdr *hdr);
72 static Elf_Brandinfo *__elfN(get_brandinfo)(const Elf_Ehdr *hdr,
74 static int __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
75 u_long *entry, size_t pagesize);
76 static int __elfN(load_section)(struct proc *p,
77 struct vmspace *vmspace, struct vnode *vp, vm_object_t object,
78 vm_offset_t offset, caddr_t vmaddr, size_t memsz, size_t filsz,
79 vm_prot_t prot, size_t pagesize);
80 static int __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp);
82 SYSCTL_NODE(_kern, OID_AUTO, __CONCAT(elf, __ELF_WORD_SIZE), CTLFLAG_RW, 0,
85 int __elfN(fallback_brand) = -1;
86 SYSCTL_INT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO,
87 fallback_brand, CTLFLAG_RW, &__elfN(fallback_brand), 0,
88 __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE)) " brand of last resort");
89 TUNABLE_INT("kern.elf" __XSTRING(__ELF_WORD_SIZE) ".fallback_brand",
90 &__elfN(fallback_brand));
92 static int elf_trace = 0;
93 SYSCTL_INT(_debug, OID_AUTO, __elfN(trace), CTLFLAG_RW, &elf_trace, 0, "");
95 static int elf_legacy_coredump = 0;
96 SYSCTL_INT(_debug, OID_AUTO, __elfN(legacy_coredump), CTLFLAG_RW,
97 &elf_legacy_coredump, 0, "");
99 static Elf_Brandinfo *elf_brand_list[MAX_BRANDS];
102 __elfN(insert_brand_entry)(Elf_Brandinfo *entry)
106 for (i = 0; i < MAX_BRANDS; i++) {
107 if (elf_brand_list[i] == NULL) {
108 elf_brand_list[i] = entry;
118 __elfN(remove_brand_entry)(Elf_Brandinfo *entry)
122 for (i = 0; i < MAX_BRANDS; i++) {
123 if (elf_brand_list[i] == entry) {
124 elf_brand_list[i] = NULL;
134 __elfN(brand_inuse)(Elf_Brandinfo *entry)
139 sx_slock(&allproc_lock);
140 LIST_FOREACH(p, &allproc, p_list) {
141 if (p->p_sysent == entry->sysvec) {
146 sx_sunlock(&allproc_lock);
151 static Elf_Brandinfo *
152 __elfN(get_brandinfo)(const Elf_Ehdr *hdr, const char *interp)
158 * We support three types of branding -- (1) the ELF EI_OSABI field
159 * that SCO added to the ELF spec, (2) FreeBSD 3.x's traditional string
160 * branding w/in the ELF header, and (3) path of the `interp_path'
161 * field. We should also look for an ".note.ABI-tag" ELF section now
162 * in all Linux ELF binaries, FreeBSD 4.1+, and some NetBSD ones.
165 /* If the executable has a brand, search for it in the brand list. */
166 for (i = 0; i < MAX_BRANDS; i++) {
167 bi = elf_brand_list[i];
168 if (bi != NULL && hdr->e_machine == bi->machine &&
169 (hdr->e_ident[EI_OSABI] == bi->brand ||
170 strncmp((const char *)&hdr->e_ident[OLD_EI_BRAND],
171 bi->compat_3_brand, strlen(bi->compat_3_brand)) == 0))
175 /* Lacking a known brand, search for a recognized interpreter. */
176 if (interp != NULL) {
177 for (i = 0; i < MAX_BRANDS; i++) {
178 bi = elf_brand_list[i];
179 if (bi != NULL && hdr->e_machine == bi->machine &&
180 strcmp(interp, bi->interp_path) == 0)
185 /* Lacking a recognized interpreter, try the default brand */
186 for (i = 0; i < MAX_BRANDS; i++) {
187 bi = elf_brand_list[i];
188 if (bi != NULL && hdr->e_machine == bi->machine &&
189 __elfN(fallback_brand) == bi->brand)
196 __elfN(check_header)(const Elf_Ehdr *hdr)
202 hdr->e_ident[EI_CLASS] != ELF_TARG_CLASS ||
203 hdr->e_ident[EI_DATA] != ELF_TARG_DATA ||
204 hdr->e_ident[EI_VERSION] != EV_CURRENT ||
205 hdr->e_phentsize != sizeof(Elf_Phdr) ||
206 hdr->e_version != ELF_TARG_VER)
210 * Make sure we have at least one brand for this machine.
213 for (i = 0; i < MAX_BRANDS; i++) {
214 bi = elf_brand_list[i];
215 if (bi != NULL && bi->machine == hdr->e_machine)
225 __elfN(map_partial)(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
226 vm_offset_t start, vm_offset_t end, vm_prot_t prot,
231 vm_offset_t data_buf = 0;
234 * Create the page if it doesn't exist yet. Ignore errors.
237 vm_map_insert(map, NULL, 0, trunc_page(start), round_page(end), max,
242 * Find the page from the underlying object.
245 vm_object_reference(object);
246 rv = vm_map_find(exec_map,
254 MAP_COPY_ON_WRITE | MAP_PREFAULT_PARTIAL);
255 if (rv != KERN_SUCCESS) {
256 vm_object_deallocate(object);
260 off = offset - trunc_page(offset);
261 error = copyout((caddr_t)data_buf + off, (caddr_t)start,
263 vm_map_remove(exec_map, data_buf, data_buf + PAGE_SIZE);
265 return (KERN_FAILURE);
269 return (KERN_SUCCESS);
273 __elfN(map_insert)(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
274 vm_offset_t start, vm_offset_t end, vm_prot_t prot,
275 vm_prot_t max, int cow)
277 vm_offset_t data_buf, off;
281 if (start != trunc_page(start)) {
282 rv = __elfN(map_partial)(map, object, offset, start,
283 round_page(start), prot, max);
286 offset += round_page(start) - start;
287 start = round_page(start);
289 if (end != round_page(end)) {
290 rv = __elfN(map_partial)(map, object, offset +
291 trunc_page(end) - start, trunc_page(end), end, prot, max);
294 end = trunc_page(end);
297 if (offset & PAGE_MASK) {
299 * The mapping is not page aligned. This means we have
300 * to copy the data. Sigh.
302 rv = vm_map_find(map, 0, 0, &start, end - start,
303 FALSE, prot, max, 0);
307 while (start < end) {
308 vm_object_reference(object);
309 rv = vm_map_find(exec_map,
318 | MAP_PREFAULT_PARTIAL));
319 if (rv != KERN_SUCCESS) {
320 vm_object_deallocate(object);
323 off = offset - trunc_page(offset);
327 error = copyout((caddr_t)data_buf + off,
329 vm_map_remove(exec_map, data_buf,
330 data_buf + 2 * PAGE_SIZE);
332 return (KERN_FAILURE);
339 rv = vm_map_insert(map, object, offset, start, end,
345 return (KERN_SUCCESS);
350 __elfN(load_section)(struct proc *p, struct vmspace *vmspace,
351 struct vnode *vp, vm_object_t object, vm_offset_t offset,
352 caddr_t vmaddr, size_t memsz, size_t filsz, vm_prot_t prot,
356 vm_offset_t map_addr;
359 vm_offset_t file_addr;
360 vm_offset_t data_buf = 0;
365 * It's necessary to fail if the filsz + offset taken from the
366 * header is greater than the actual file pager object's size.
367 * If we were to allow this, then the vm_map_find() below would
368 * walk right off the end of the file object and into the ether.
370 * While I'm here, might as well check for something else that
371 * is invalid: filsz cannot be greater than memsz.
373 if ((off_t)filsz + offset > object->un_pager.vnp.vnp_size ||
375 uprintf("elf_load_section: truncated ELF file\n");
379 #define trunc_page_ps(va, ps) ((va) & ~(ps - 1))
380 #define round_page_ps(va, ps) (((va) + (ps - 1)) & ~(ps - 1))
382 map_addr = trunc_page_ps((vm_offset_t)vmaddr, pagesize);
383 file_addr = trunc_page_ps(offset, pagesize);
386 * We have two choices. We can either clear the data in the last page
387 * of an oversized mapping, or we can start the anon mapping a page
388 * early and copy the initialized data into that first page. We
389 * choose the second..
392 map_len = trunc_page_ps(offset + filsz, pagesize) - file_addr;
394 map_len = round_page_ps(offset + filsz, pagesize) - file_addr;
397 vm_object_reference(object);
399 /* cow flags: don't dump readonly sections in core */
400 cow = MAP_COPY_ON_WRITE | MAP_PREFAULT |
401 (prot & VM_PROT_WRITE ? 0 : MAP_DISABLE_COREDUMP);
403 rv = __elfN(map_insert)(&vmspace->vm_map,
405 file_addr, /* file offset */
406 map_addr, /* virtual start */
407 map_addr + map_len,/* virtual end */
411 if (rv != KERN_SUCCESS) {
412 vm_object_deallocate(object);
416 /* we can stop now if we've covered it all */
417 if (memsz == filsz) {
424 * We have to get the remaining bit of the file into the first part
425 * of the oversized map segment. This is normally because the .data
426 * segment in the file is extended to provide bss. It's a neat idea
427 * to try and save a page, but it's a pain in the behind to implement.
429 copy_len = (offset + filsz) - trunc_page_ps(offset + filsz, pagesize);
430 map_addr = trunc_page_ps((vm_offset_t)vmaddr + filsz, pagesize);
431 map_len = round_page_ps((vm_offset_t)vmaddr + memsz, pagesize) -
434 /* This had damn well better be true! */
436 rv = __elfN(map_insert)(&vmspace->vm_map, NULL, 0, map_addr,
437 map_addr + map_len, VM_PROT_ALL, VM_PROT_ALL, 0);
438 if (rv != KERN_SUCCESS) {
445 vm_object_reference(object);
446 rv = vm_map_find(exec_map,
448 trunc_page(offset + filsz),
454 MAP_COPY_ON_WRITE | MAP_PREFAULT_PARTIAL);
455 if (rv != KERN_SUCCESS) {
456 vm_object_deallocate(object);
460 /* send the page fragment to user space */
461 off = trunc_page_ps(offset + filsz, pagesize) -
462 trunc_page(offset + filsz);
463 error = copyout((caddr_t)data_buf + off, (caddr_t)map_addr,
465 vm_map_remove(exec_map, data_buf, data_buf + PAGE_SIZE);
472 * set it to the specified protection.
473 * XXX had better undo the damage from pasting over the cracks here!
475 vm_map_protect(&vmspace->vm_map, trunc_page(map_addr),
476 round_page(map_addr + map_len), prot, FALSE);
482 * Load the file "file" into memory. It may be either a shared object
485 * The "addr" reference parameter is in/out. On entry, it specifies
486 * the address where a shared object should be loaded. If the file is
487 * an executable, this value is ignored. On exit, "addr" specifies
488 * where the file was actually loaded.
490 * The "entry" reference parameter is out only. On exit, it specifies
491 * the entry point for the loaded file.
494 __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
495 u_long *entry, size_t pagesize)
500 struct image_params image_params;
502 const Elf_Ehdr *hdr = NULL;
503 const Elf_Phdr *phdr = NULL;
504 struct nameidata *nd;
505 struct vmspace *vmspace = p->p_vmspace;
507 struct image_params *imgp;
510 u_long base_addr = 0;
511 int error, i, numsegs;
513 if (curthread->td_proc != p)
514 panic("elf_load_file - thread"); /* XXXKSE DIAGNOSTIC */
516 tempdata = malloc(sizeof(*tempdata), M_TEMP, M_WAITOK);
518 attr = &tempdata->attr;
519 imgp = &tempdata->image_params;
522 * Initialize part of the common data
526 imgp->firstpage = NULL;
527 imgp->image_header = NULL;
529 imgp->execlabel = NULL;
532 NDINIT(nd, LOOKUP, LOCKLEAF|FOLLOW, UIO_SYSSPACE, file, curthread);
534 if ((error = namei(nd)) != 0) {
538 NDFREE(nd, NDF_ONLY_PNBUF);
539 imgp->vp = nd->ni_vp;
542 * Check permissions, modes, uid, etc on the file, and "open" it.
544 error = exec_check_permissions(imgp);
546 VOP_UNLOCK(nd->ni_vp, 0, curthread); /* XXXKSE */
550 error = exec_map_first_page(imgp);
552 * Also make certain that the interpreter stays the same, so set
553 * its VV_TEXT flag, too.
556 nd->ni_vp->v_vflag |= VV_TEXT;
558 imgp->object = nd->ni_vp->v_object;
559 vm_object_reference(imgp->object);
561 VOP_UNLOCK(nd->ni_vp, 0, curthread); /* XXXKSE */
565 hdr = (const Elf_Ehdr *)imgp->image_header;
566 if ((error = __elfN(check_header)(hdr)) != 0)
568 if (hdr->e_type == ET_DYN)
570 else if (hdr->e_type == ET_EXEC)
577 /* Only support headers that fit within first page for now */
578 /* (multiplication of two Elf_Half fields will not overflow) */
579 if ((hdr->e_phoff > PAGE_SIZE) ||
580 (hdr->e_phentsize * hdr->e_phnum) > PAGE_SIZE - hdr->e_phoff) {
585 phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
587 for (i = 0, numsegs = 0; i < hdr->e_phnum; i++) {
588 if (phdr[i].p_type == PT_LOAD) { /* Loadable segment */
590 if (phdr[i].p_flags & PF_X)
591 prot |= VM_PROT_EXECUTE;
592 if (phdr[i].p_flags & PF_W)
593 prot |= VM_PROT_WRITE;
594 if (phdr[i].p_flags & PF_R)
595 prot |= VM_PROT_READ;
597 if ((error = __elfN(load_section)(p, vmspace,
598 nd->ni_vp, imgp->object, phdr[i].p_offset,
599 (caddr_t)(uintptr_t)phdr[i].p_vaddr + rbase,
600 phdr[i].p_memsz, phdr[i].p_filesz, prot,
604 * Establish the base address if this is the
608 base_addr = trunc_page(phdr[i].p_vaddr +
614 *entry = (unsigned long)hdr->e_entry + rbase;
618 exec_unmap_first_page(imgp);
620 vm_object_deallocate(imgp->object);
625 free(tempdata, M_TEMP);
631 __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp)
633 const Elf_Ehdr *hdr = (const Elf_Ehdr *)imgp->image_header;
634 const Elf_Phdr *phdr;
635 Elf_Auxargs *elf_auxargs = NULL;
636 struct vmspace *vmspace;
638 u_long text_size = 0, data_size = 0, total_size = 0;
639 u_long text_addr = 0, data_addr = 0;
640 u_long seg_size, seg_addr;
641 u_long addr, entry = 0, proghdr = 0;
643 const char *interp = NULL;
644 Elf_Brandinfo *brand_info;
646 struct thread *td = curthread;
647 struct sysentvec *sv;
650 * Do we have a valid ELF header ?
652 if (__elfN(check_header)(hdr) != 0 || hdr->e_type != ET_EXEC)
656 * From here on down, we return an errno, not -1, as we've
657 * detected an ELF file.
660 if ((hdr->e_phoff > PAGE_SIZE) ||
661 (hdr->e_phoff + hdr->e_phentsize * hdr->e_phnum) > PAGE_SIZE) {
662 /* Only support headers in first page for now */
665 phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
668 * From this point on, we may have resources that need to be freed.
671 VOP_UNLOCK(imgp->vp, 0, td);
673 for (i = 0; i < hdr->e_phnum; i++) {
674 switch (phdr[i].p_type) {
675 case PT_INTERP: /* Path to interpreter */
676 if (phdr[i].p_filesz > MAXPATHLEN ||
677 phdr[i].p_offset + phdr[i].p_filesz > PAGE_SIZE) {
681 interp = imgp->image_header + phdr[i].p_offset;
688 brand_info = __elfN(get_brandinfo)(hdr, interp);
689 if (brand_info == NULL) {
690 uprintf("ELF binary type \"%u\" not known.\n",
691 hdr->e_ident[EI_OSABI]);
695 sv = brand_info->sysvec;
696 if (interp != NULL && brand_info->interp_newpath != NULL)
697 interp = brand_info->interp_newpath;
699 exec_new_vmspace(imgp, sv);
701 vmspace = imgp->proc->p_vmspace;
703 for (i = 0; i < hdr->e_phnum; i++) {
704 switch (phdr[i].p_type) {
705 case PT_LOAD: /* Loadable segment */
707 if (phdr[i].p_flags & PF_X)
708 prot |= VM_PROT_EXECUTE;
709 if (phdr[i].p_flags & PF_W)
710 prot |= VM_PROT_WRITE;
711 if (phdr[i].p_flags & PF_R)
712 prot |= VM_PROT_READ;
714 #if defined(__ia64__) && __ELF_WORD_SIZE == 32 && defined(IA32_ME_HARDER)
716 * Some x86 binaries assume read == executable,
717 * notably the M3 runtime and therefore cvsup
719 if (prot & VM_PROT_READ)
720 prot |= VM_PROT_EXECUTE;
723 if ((error = __elfN(load_section)(imgp->proc, vmspace,
724 imgp->vp, imgp->object, phdr[i].p_offset,
725 (caddr_t)(uintptr_t)phdr[i].p_vaddr,
726 phdr[i].p_memsz, phdr[i].p_filesz, prot,
727 sv->sv_pagesize)) != 0)
731 * If this segment contains the program headers,
732 * remember their virtual address for the AT_PHDR
733 * aux entry. Static binaries don't usually include
736 if (phdr[i].p_offset == 0 &&
737 hdr->e_phoff + hdr->e_phnum * hdr->e_phentsize
739 proghdr = phdr[i].p_vaddr + hdr->e_phoff;
741 seg_addr = trunc_page(phdr[i].p_vaddr);
742 seg_size = round_page(phdr[i].p_memsz +
743 phdr[i].p_vaddr - seg_addr);
746 * Is this .text or .data? We can't use
747 * VM_PROT_WRITE or VM_PROT_EXEC, it breaks the
748 * alpha terribly and possibly does other bad
749 * things so we stick to the old way of figuring
750 * it out: If the segment contains the program
751 * entry point, it's a text segment, otherwise it
754 * Note that obreak() assumes that data_addr +
755 * data_size == end of data load area, and the ELF
756 * file format expects segments to be sorted by
757 * address. If multiple data segments exist, the
758 * last one will be used.
760 if (hdr->e_entry >= phdr[i].p_vaddr &&
761 hdr->e_entry < (phdr[i].p_vaddr +
763 text_size = seg_size;
764 text_addr = seg_addr;
765 entry = (u_long)hdr->e_entry;
767 data_size = seg_size;
768 data_addr = seg_addr;
770 total_size += seg_size;
772 case PT_PHDR: /* Program header table info */
773 proghdr = phdr[i].p_vaddr;
780 if (data_addr == 0 && data_size == 0) {
781 data_addr = text_addr;
782 data_size = text_size;
786 * Check limits. It should be safe to check the
787 * limits after loading the segments since we do
788 * not actually fault in all the segments pages.
790 PROC_LOCK(imgp->proc);
791 if (data_size > lim_cur(imgp->proc, RLIMIT_DATA) ||
792 text_size > maxtsiz ||
793 total_size > lim_cur(imgp->proc, RLIMIT_VMEM)) {
794 PROC_UNLOCK(imgp->proc);
799 vmspace->vm_tsize = text_size >> PAGE_SHIFT;
800 vmspace->vm_taddr = (caddr_t)(uintptr_t)text_addr;
801 vmspace->vm_dsize = data_size >> PAGE_SHIFT;
802 vmspace->vm_daddr = (caddr_t)(uintptr_t)data_addr;
805 * We load the dynamic linker where a userland call
806 * to mmap(0, ...) would put it. The rationale behind this
807 * calculation is that it leaves room for the heap to grow to
808 * its maximum allowed size.
810 addr = round_page((vm_offset_t)imgp->proc->p_vmspace->vm_daddr +
811 lim_max(imgp->proc, RLIMIT_DATA));
812 PROC_UNLOCK(imgp->proc);
814 imgp->entry_addr = entry;
816 imgp->proc->p_sysent = sv;
817 if (interp != NULL && brand_info->emul_path != NULL &&
818 brand_info->emul_path[0] != '\0') {
819 path = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
820 snprintf(path, MAXPATHLEN, "%s%s", brand_info->emul_path,
822 error = __elfN(load_file)(imgp->proc, path, &addr,
823 &imgp->entry_addr, sv->sv_pagesize);
828 if (interp != NULL) {
829 error = __elfN(load_file)(imgp->proc, interp, &addr,
830 &imgp->entry_addr, sv->sv_pagesize);
832 uprintf("ELF interpreter %s not found\n", interp);
838 * Construct auxargs table (used by the fixup routine)
840 elf_auxargs = malloc(sizeof(Elf_Auxargs), M_TEMP, M_WAITOK);
841 elf_auxargs->execfd = -1;
842 elf_auxargs->phdr = proghdr;
843 elf_auxargs->phent = hdr->e_phentsize;
844 elf_auxargs->phnum = hdr->e_phnum;
845 elf_auxargs->pagesz = PAGE_SIZE;
846 elf_auxargs->base = addr;
847 elf_auxargs->flags = 0;
848 elf_auxargs->entry = entry;
849 elf_auxargs->trace = elf_trace;
851 imgp->auxargs = elf_auxargs;
852 imgp->interpreted = 0;
855 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY, td);
859 #define suword __CONCAT(suword, __ELF_WORD_SIZE)
862 __elfN(freebsd_fixup)(register_t **stack_base, struct image_params *imgp)
864 Elf_Auxargs *args = (Elf_Auxargs *)imgp->auxargs;
868 base = (Elf_Addr *)*stack_base;
869 pos = base + (imgp->args->argc + imgp->args->envc + 2);
872 AUXARGS_ENTRY(pos, AT_DEBUG, 1);
874 if (args->execfd != -1) {
875 AUXARGS_ENTRY(pos, AT_EXECFD, args->execfd);
877 AUXARGS_ENTRY(pos, AT_PHDR, args->phdr);
878 AUXARGS_ENTRY(pos, AT_PHENT, args->phent);
879 AUXARGS_ENTRY(pos, AT_PHNUM, args->phnum);
880 AUXARGS_ENTRY(pos, AT_PAGESZ, args->pagesz);
881 AUXARGS_ENTRY(pos, AT_FLAGS, args->flags);
882 AUXARGS_ENTRY(pos, AT_ENTRY, args->entry);
883 AUXARGS_ENTRY(pos, AT_BASE, args->base);
884 AUXARGS_ENTRY(pos, AT_NULL, 0);
886 free(imgp->auxargs, M_TEMP);
887 imgp->auxargs = NULL;
890 suword(base, (long)imgp->args->argc);
891 *stack_base = (register_t *)base;
896 * Code for generating ELF core dumps.
899 typedef void (*segment_callback)(vm_map_entry_t, void *);
901 /* Closure for cb_put_phdr(). */
902 struct phdr_closure {
903 Elf_Phdr *phdr; /* Program header to fill in */
904 Elf_Off offset; /* Offset of segment in core file */
907 /* Closure for cb_size_segment(). */
908 struct sseg_closure {
909 int count; /* Count of writable segments. */
910 size_t size; /* Total size of all writable segments. */
913 static void cb_put_phdr(vm_map_entry_t, void *);
914 static void cb_size_segment(vm_map_entry_t, void *);
915 static void each_writable_segment(struct thread *, segment_callback, void *);
916 static int __elfN(corehdr)(struct thread *, struct vnode *, struct ucred *,
917 int, void *, size_t);
918 static void __elfN(puthdr)(struct thread *, void *, size_t *, int);
919 static void __elfN(putnote)(void *, size_t *, const char *, int,
920 const void *, size_t);
922 extern int osreldate;
925 __elfN(coredump)(td, vp, limit)
930 struct ucred *cred = td->td_ucred;
932 struct sseg_closure seginfo;
936 /* Size the program segments. */
939 each_writable_segment(td, cb_size_segment, &seginfo);
942 * Calculate the size of the core file header area by making
943 * a dry run of generating it. Nothing is written, but the
944 * size is calculated.
947 __elfN(puthdr)(td, (void *)NULL, &hdrsize, seginfo.count);
949 if (hdrsize + seginfo.size >= limit)
953 * Allocate memory for building the header, fill it up,
956 hdr = malloc(hdrsize, M_TEMP, M_WAITOK);
960 error = __elfN(corehdr)(td, vp, cred, seginfo.count, hdr, hdrsize);
962 /* Write the contents of all of the writable segments. */
968 php = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr)) + 1;
970 for (i = 0; i < seginfo.count; i++) {
971 error = vn_rdwr_inchunks(UIO_WRITE, vp,
972 (caddr_t)(uintptr_t)php->p_vaddr,
973 php->p_filesz, offset, UIO_USERSPACE,
974 IO_UNIT | IO_DIRECT, cred, NOCRED, NULL,
975 curthread); /* XXXKSE */
978 offset += php->p_filesz;
988 * A callback for each_writable_segment() to write out the segment's
989 * program header entry.
992 cb_put_phdr(entry, closure)
993 vm_map_entry_t entry;
996 struct phdr_closure *phc = (struct phdr_closure *)closure;
997 Elf_Phdr *phdr = phc->phdr;
999 phc->offset = round_page(phc->offset);
1001 phdr->p_type = PT_LOAD;
1002 phdr->p_offset = phc->offset;
1003 phdr->p_vaddr = entry->start;
1005 phdr->p_filesz = phdr->p_memsz = entry->end - entry->start;
1006 phdr->p_align = PAGE_SIZE;
1008 if (entry->protection & VM_PROT_READ)
1009 phdr->p_flags |= PF_R;
1010 if (entry->protection & VM_PROT_WRITE)
1011 phdr->p_flags |= PF_W;
1012 if (entry->protection & VM_PROT_EXECUTE)
1013 phdr->p_flags |= PF_X;
1015 phc->offset += phdr->p_filesz;
1020 * A callback for each_writable_segment() to gather information about
1021 * the number of segments and their total size.
1024 cb_size_segment(entry, closure)
1025 vm_map_entry_t entry;
1028 struct sseg_closure *ssc = (struct sseg_closure *)closure;
1031 ssc->size += entry->end - entry->start;
1035 * For each writable segment in the process's memory map, call the given
1036 * function with a pointer to the map entry and some arbitrary
1037 * caller-supplied data.
1040 each_writable_segment(td, func, closure)
1042 segment_callback func;
1045 struct proc *p = td->td_proc;
1046 vm_map_t map = &p->p_vmspace->vm_map;
1047 vm_map_entry_t entry;
1049 for (entry = map->header.next; entry != &map->header;
1050 entry = entry->next) {
1054 * Don't dump inaccessible mappings, deal with legacy
1057 * Note that read-only segments related to the elf binary
1058 * are marked MAP_ENTRY_NOCOREDUMP now so we no longer
1059 * need to arbitrarily ignore such segments.
1061 if (elf_legacy_coredump) {
1062 if ((entry->protection & VM_PROT_RW) != VM_PROT_RW)
1065 if ((entry->protection & VM_PROT_ALL) == 0)
1070 * Dont include memory segment in the coredump if
1071 * MAP_NOCORE is set in mmap(2) or MADV_NOCORE in
1072 * madvise(2). Do not dump submaps (i.e. parts of the
1075 if (entry->eflags & (MAP_ENTRY_NOCOREDUMP|MAP_ENTRY_IS_SUB_MAP))
1078 if ((obj = entry->object.vm_object) == NULL)
1081 /* Find the deepest backing object. */
1082 while (obj->backing_object != NULL)
1083 obj = obj->backing_object;
1085 /* Ignore memory-mapped devices and such things. */
1086 if (obj->type != OBJT_DEFAULT &&
1087 obj->type != OBJT_SWAP &&
1088 obj->type != OBJT_VNODE)
1091 (*func)(entry, closure);
1096 * Write the core file header to the file, including padding up to
1097 * the page boundary.
1100 __elfN(corehdr)(td, vp, cred, numsegs, hdr, hdrsize)
1110 /* Fill in the header. */
1111 bzero(hdr, hdrsize);
1113 __elfN(puthdr)(td, hdr, &off, numsegs);
1115 /* Write it to the core file. */
1116 return (vn_rdwr_inchunks(UIO_WRITE, vp, hdr, hdrsize, (off_t)0,
1117 UIO_SYSSPACE, IO_UNIT | IO_DIRECT, cred, NOCRED, NULL,
1122 __elfN(puthdr)(struct thread *td, void *dst, size_t *off, int numsegs)
1126 prfpregset_t fpregset;
1130 prfpregset_t *fpregset;
1134 size_t ehoff, noteoff, notesz, phoff;
1139 *off += sizeof(Elf_Ehdr);
1142 *off += (numsegs + 1) * sizeof(Elf_Phdr);
1146 * Don't allocate space for the notes if we're just calculating
1147 * the size of the header. We also don't collect the data.
1150 tempdata = malloc(sizeof(*tempdata), M_TEMP, M_ZERO|M_WAITOK);
1151 status = &tempdata->status;
1152 fpregset = &tempdata->fpregset;
1153 psinfo = &tempdata->psinfo;
1162 psinfo->pr_version = PRPSINFO_VERSION;
1163 psinfo->pr_psinfosz = sizeof(prpsinfo_t);
1164 strlcpy(psinfo->pr_fname, p->p_comm, sizeof(psinfo->pr_fname));
1166 * XXX - We don't fill in the command line arguments properly
1169 strlcpy(psinfo->pr_psargs, p->p_comm,
1170 sizeof(psinfo->pr_psargs));
1172 __elfN(putnote)(dst, off, "FreeBSD", NT_PRPSINFO, psinfo,
1176 * To have the debugger select the right thread (LWP) as the initial
1177 * thread, we dump the state of the thread passed to us in td first.
1178 * This is the thread that causes the core dump and thus likely to
1179 * be the right thread one wants to have selected in the debugger.
1182 while (thr != NULL) {
1184 status->pr_version = PRSTATUS_VERSION;
1185 status->pr_statussz = sizeof(prstatus_t);
1186 status->pr_gregsetsz = sizeof(gregset_t);
1187 status->pr_fpregsetsz = sizeof(fpregset_t);
1188 status->pr_osreldate = osreldate;
1189 status->pr_cursig = p->p_sig;
1190 status->pr_pid = thr->td_tid;
1191 fill_regs(thr, &status->pr_reg);
1192 fill_fpregs(thr, fpregset);
1194 __elfN(putnote)(dst, off, "FreeBSD", NT_PRSTATUS, status,
1196 __elfN(putnote)(dst, off, "FreeBSD", NT_FPREGSET, fpregset,
1199 * Allow for MD specific notes, as well as any MD
1200 * specific preparations for writing MI notes.
1202 __elfN(dump_thread)(thr, dst, off);
1204 thr = (thr == td) ? TAILQ_FIRST(&p->p_threads) :
1205 TAILQ_NEXT(thr, td_plist);
1207 thr = TAILQ_NEXT(thr, td_plist);
1210 notesz = *off - noteoff;
1213 free(tempdata, M_TEMP);
1215 /* Align up to a page boundary for the program segments. */
1216 *off = round_page(*off);
1221 struct phdr_closure phc;
1224 * Fill in the ELF header.
1226 ehdr = (Elf_Ehdr *)((char *)dst + ehoff);
1227 ehdr->e_ident[EI_MAG0] = ELFMAG0;
1228 ehdr->e_ident[EI_MAG1] = ELFMAG1;
1229 ehdr->e_ident[EI_MAG2] = ELFMAG2;
1230 ehdr->e_ident[EI_MAG3] = ELFMAG3;
1231 ehdr->e_ident[EI_CLASS] = ELF_CLASS;
1232 ehdr->e_ident[EI_DATA] = ELF_DATA;
1233 ehdr->e_ident[EI_VERSION] = EV_CURRENT;
1234 ehdr->e_ident[EI_OSABI] = ELFOSABI_FREEBSD;
1235 ehdr->e_ident[EI_ABIVERSION] = 0;
1236 ehdr->e_ident[EI_PAD] = 0;
1237 ehdr->e_type = ET_CORE;
1238 ehdr->e_machine = ELF_ARCH;
1239 ehdr->e_version = EV_CURRENT;
1241 ehdr->e_phoff = phoff;
1243 ehdr->e_ehsize = sizeof(Elf_Ehdr);
1244 ehdr->e_phentsize = sizeof(Elf_Phdr);
1245 ehdr->e_phnum = numsegs + 1;
1246 ehdr->e_shentsize = sizeof(Elf_Shdr);
1248 ehdr->e_shstrndx = SHN_UNDEF;
1251 * Fill in the program header entries.
1253 phdr = (Elf_Phdr *)((char *)dst + phoff);
1255 /* The note segement. */
1256 phdr->p_type = PT_NOTE;
1257 phdr->p_offset = noteoff;
1260 phdr->p_filesz = notesz;
1266 /* All the writable segments from the program. */
1269 each_writable_segment(td, cb_put_phdr, &phc);
1274 __elfN(putnote)(void *dst, size_t *off, const char *name, int type,
1275 const void *desc, size_t descsz)
1279 note.n_namesz = strlen(name) + 1;
1280 note.n_descsz = descsz;
1283 bcopy(¬e, (char *)dst + *off, sizeof note);
1284 *off += sizeof note;
1286 bcopy(name, (char *)dst + *off, note.n_namesz);
1287 *off += roundup2(note.n_namesz, sizeof(Elf_Size));
1289 bcopy(desc, (char *)dst + *off, note.n_descsz);
1290 *off += roundup2(note.n_descsz, sizeof(Elf_Size));
1294 * Tell kern_execve.c about it, with a little help from the linker.
1296 static struct execsw __elfN(execsw) = {
1297 __CONCAT(exec_, __elfN(imgact)),
1298 __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE))
1300 EXEC_SET(__CONCAT(elf, __ELF_WORD_SIZE), __elfN(execsw));