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_capsicum.h"
35 #include "opt_compat.h"
38 #include <sys/param.h>
39 #include <sys/capsicum.h>
41 #include <sys/fcntl.h>
43 #include <sys/imgact.h>
44 #include <sys/imgact_elf.h>
46 #include <sys/kernel.h>
48 #include <sys/malloc.h>
49 #include <sys/mount.h>
51 #include <sys/namei.h>
52 #include <sys/pioctl.h>
54 #include <sys/procfs.h>
55 #include <sys/racct.h>
56 #include <sys/resourcevar.h>
57 #include <sys/rwlock.h>
59 #include <sys/sf_buf.h>
61 #include <sys/systm.h>
62 #include <sys/signalvar.h>
65 #include <sys/syscall.h>
66 #include <sys/sysctl.h>
67 #include <sys/sysent.h>
68 #include <sys/vnode.h>
69 #include <sys/syslog.h>
70 #include <sys/eventhandler.h>
74 #include <vm/vm_kern.h>
75 #include <vm/vm_param.h>
77 #include <vm/vm_map.h>
78 #include <vm/vm_object.h>
79 #include <vm/vm_extern.h>
81 #include <machine/elf.h>
82 #include <machine/md_var.h>
84 #define ELF_NOTE_ROUNDSIZE 4
85 #define OLD_EI_BRAND 8
87 static int __elfN(check_header)(const Elf_Ehdr *hdr);
88 static Elf_Brandinfo *__elfN(get_brandinfo)(struct image_params *imgp,
89 const char *interp, int interp_name_len, int32_t *osrel);
90 static int __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
91 u_long *entry, size_t pagesize);
92 static int __elfN(load_section)(struct image_params *imgp, vm_ooffset_t offset,
93 caddr_t vmaddr, size_t memsz, size_t filsz, vm_prot_t prot,
95 static int __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp);
96 static boolean_t __elfN(freebsd_trans_osrel)(const Elf_Note *note,
98 static boolean_t kfreebsd_trans_osrel(const Elf_Note *note, int32_t *osrel);
99 static boolean_t __elfN(check_note)(struct image_params *imgp,
100 Elf_Brandnote *checknote, int32_t *osrel);
101 static vm_prot_t __elfN(trans_prot)(Elf_Word);
102 static Elf_Word __elfN(untrans_prot)(vm_prot_t);
104 SYSCTL_NODE(_kern, OID_AUTO, __CONCAT(elf, __ELF_WORD_SIZE), CTLFLAG_RW, 0,
107 #define CORE_BUF_SIZE (16 * 1024)
109 int __elfN(fallback_brand) = -1;
110 SYSCTL_INT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO,
111 fallback_brand, CTLFLAG_RWTUN, &__elfN(fallback_brand), 0,
112 __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE)) " brand of last resort");
114 static int elf_legacy_coredump = 0;
115 SYSCTL_INT(_debug, OID_AUTO, __elfN(legacy_coredump), CTLFLAG_RW,
116 &elf_legacy_coredump, 0,
117 "include all and only RW pages in core dumps");
119 int __elfN(nxstack) =
120 #if defined(__amd64__) || defined(__powerpc64__) /* both 64 and 32 bit */ || \
121 (defined(__arm__) && __ARM_ARCH >= 7) || defined(__aarch64__)
126 SYSCTL_INT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO,
127 nxstack, CTLFLAG_RW, &__elfN(nxstack), 0,
128 __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE)) ": enable non-executable stack");
130 #if __ELF_WORD_SIZE == 32
131 #if defined(__amd64__)
132 int i386_read_exec = 0;
133 SYSCTL_INT(_kern_elf32, OID_AUTO, read_exec, CTLFLAG_RW, &i386_read_exec, 0,
134 "enable execution from readable segments");
138 static Elf_Brandinfo *elf_brand_list[MAX_BRANDS];
140 #define trunc_page_ps(va, ps) rounddown2(va, ps)
141 #define round_page_ps(va, ps) roundup2(va, ps)
142 #define aligned(a, t) (trunc_page_ps((u_long)(a), sizeof(t)) == (u_long)(a))
144 static const char FREEBSD_ABI_VENDOR[] = "FreeBSD";
146 Elf_Brandnote __elfN(freebsd_brandnote) = {
147 .hdr.n_namesz = sizeof(FREEBSD_ABI_VENDOR),
148 .hdr.n_descsz = sizeof(int32_t),
149 .hdr.n_type = NT_FREEBSD_ABI_TAG,
150 .vendor = FREEBSD_ABI_VENDOR,
151 .flags = BN_TRANSLATE_OSREL,
152 .trans_osrel = __elfN(freebsd_trans_osrel)
156 __elfN(freebsd_trans_osrel)(const Elf_Note *note, int32_t *osrel)
160 p = (uintptr_t)(note + 1);
161 p += roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE);
162 *osrel = *(const int32_t *)(p);
167 static const char GNU_ABI_VENDOR[] = "GNU";
168 static int GNU_KFREEBSD_ABI_DESC = 3;
170 Elf_Brandnote __elfN(kfreebsd_brandnote) = {
171 .hdr.n_namesz = sizeof(GNU_ABI_VENDOR),
172 .hdr.n_descsz = 16, /* XXX at least 16 */
174 .vendor = GNU_ABI_VENDOR,
175 .flags = BN_TRANSLATE_OSREL,
176 .trans_osrel = kfreebsd_trans_osrel
180 kfreebsd_trans_osrel(const Elf_Note *note, int32_t *osrel)
182 const Elf32_Word *desc;
185 p = (uintptr_t)(note + 1);
186 p += roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE);
188 desc = (const Elf32_Word *)p;
189 if (desc[0] != GNU_KFREEBSD_ABI_DESC)
193 * Debian GNU/kFreeBSD embed the earliest compatible kernel version
194 * (__FreeBSD_version: <major><two digit minor>Rxx) in the LSB way.
196 *osrel = desc[1] * 100000 + desc[2] * 1000 + desc[3];
202 __elfN(insert_brand_entry)(Elf_Brandinfo *entry)
206 for (i = 0; i < MAX_BRANDS; i++) {
207 if (elf_brand_list[i] == NULL) {
208 elf_brand_list[i] = entry;
212 if (i == MAX_BRANDS) {
213 printf("WARNING: %s: could not insert brandinfo entry: %p\n",
221 __elfN(remove_brand_entry)(Elf_Brandinfo *entry)
225 for (i = 0; i < MAX_BRANDS; i++) {
226 if (elf_brand_list[i] == entry) {
227 elf_brand_list[i] = NULL;
237 __elfN(brand_inuse)(Elf_Brandinfo *entry)
242 sx_slock(&allproc_lock);
243 FOREACH_PROC_IN_SYSTEM(p) {
244 if (p->p_sysent == entry->sysvec) {
249 sx_sunlock(&allproc_lock);
254 static Elf_Brandinfo *
255 __elfN(get_brandinfo)(struct image_params *imgp, const char *interp,
256 int interp_name_len, int32_t *osrel)
258 const Elf_Ehdr *hdr = (const Elf_Ehdr *)imgp->image_header;
259 Elf_Brandinfo *bi, *bi_m;
264 * We support four types of branding -- (1) the ELF EI_OSABI field
265 * that SCO added to the ELF spec, (2) FreeBSD 3.x's traditional string
266 * branding w/in the ELF header, (3) path of the `interp_path'
267 * field, and (4) the ".note.ABI-tag" ELF section.
270 /* Look for an ".note.ABI-tag" ELF section */
272 for (i = 0; i < MAX_BRANDS; i++) {
273 bi = elf_brand_list[i];
276 if (hdr->e_machine == bi->machine && (bi->flags &
277 (BI_BRAND_NOTE|BI_BRAND_NOTE_MANDATORY)) != 0) {
278 ret = __elfN(check_note)(imgp, bi->brand_note, osrel);
279 /* Give brand a chance to veto check_note's guess */
280 if (ret && bi->header_supported)
281 ret = bi->header_supported(imgp);
283 * If note checker claimed the binary, but the
284 * interpreter path in the image does not
285 * match default one for the brand, try to
286 * search for other brands with the same
287 * interpreter. Either there is better brand
288 * with the right interpreter, or, failing
289 * this, we return first brand which accepted
290 * our note and, optionally, header.
292 if (ret && bi_m == NULL && (strlen(bi->interp_path) +
293 1 != interp_name_len || strncmp(interp,
294 bi->interp_path, interp_name_len) != 0)) {
305 /* If the executable has a brand, search for it in the brand list. */
306 for (i = 0; i < MAX_BRANDS; i++) {
307 bi = elf_brand_list[i];
308 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY)
310 if (hdr->e_machine == bi->machine &&
311 (hdr->e_ident[EI_OSABI] == bi->brand ||
312 (bi->compat_3_brand != NULL &&
313 strcmp((const char *)&hdr->e_ident[OLD_EI_BRAND],
314 bi->compat_3_brand) == 0))) {
315 /* Looks good, but give brand a chance to veto */
316 if (!bi->header_supported ||
317 bi->header_supported(imgp)) {
319 * Again, prefer strictly matching
322 if (strlen(bi->interp_path) + 1 ==
323 interp_name_len && strncmp(interp,
324 bi->interp_path, interp_name_len) == 0)
334 /* No known brand, see if the header is recognized by any brand */
335 for (i = 0; i < MAX_BRANDS; i++) {
336 bi = elf_brand_list[i];
337 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY ||
338 bi->header_supported == NULL)
340 if (hdr->e_machine == bi->machine) {
341 ret = bi->header_supported(imgp);
347 /* Lacking a known brand, search for a recognized interpreter. */
348 if (interp != NULL) {
349 for (i = 0; i < MAX_BRANDS; i++) {
350 bi = elf_brand_list[i];
351 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY)
353 if (hdr->e_machine == bi->machine &&
354 /* ELF image p_filesz includes terminating zero */
355 strlen(bi->interp_path) + 1 == interp_name_len &&
356 strncmp(interp, bi->interp_path, interp_name_len)
362 /* Lacking a recognized interpreter, try the default brand */
363 for (i = 0; i < MAX_BRANDS; i++) {
364 bi = elf_brand_list[i];
365 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY)
367 if (hdr->e_machine == bi->machine &&
368 __elfN(fallback_brand) == bi->brand)
375 __elfN(check_header)(const Elf_Ehdr *hdr)
381 hdr->e_ident[EI_CLASS] != ELF_TARG_CLASS ||
382 hdr->e_ident[EI_DATA] != ELF_TARG_DATA ||
383 hdr->e_ident[EI_VERSION] != EV_CURRENT ||
384 hdr->e_phentsize != sizeof(Elf_Phdr) ||
385 hdr->e_version != ELF_TARG_VER)
389 * Make sure we have at least one brand for this machine.
392 for (i = 0; i < MAX_BRANDS; i++) {
393 bi = elf_brand_list[i];
394 if (bi != NULL && bi->machine == hdr->e_machine)
404 __elfN(map_partial)(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
405 vm_offset_t start, vm_offset_t end, vm_prot_t prot)
412 * Create the page if it doesn't exist yet. Ignore errors.
414 vm_map_fixed(map, NULL, 0, trunc_page(start), round_page(end) -
415 trunc_page(start), VM_PROT_ALL, VM_PROT_ALL, MAP_CHECK_EXCL);
418 * Find the page from the underlying object.
420 if (object != NULL) {
421 sf = vm_imgact_map_page(object, offset);
423 return (KERN_FAILURE);
424 off = offset - trunc_page(offset);
425 error = copyout((caddr_t)sf_buf_kva(sf) + off, (caddr_t)start,
427 vm_imgact_unmap_page(sf);
429 return (KERN_FAILURE);
432 return (KERN_SUCCESS);
436 __elfN(map_insert)(struct image_params *imgp, vm_map_t map, vm_object_t object,
437 vm_ooffset_t offset, vm_offset_t start, vm_offset_t end, vm_prot_t prot,
443 int error, locked, rv;
445 if (start != trunc_page(start)) {
446 rv = __elfN(map_partial)(map, object, offset, start,
447 round_page(start), prot);
448 if (rv != KERN_SUCCESS)
450 offset += round_page(start) - start;
451 start = round_page(start);
453 if (end != round_page(end)) {
454 rv = __elfN(map_partial)(map, object, offset +
455 trunc_page(end) - start, trunc_page(end), end, prot);
456 if (rv != KERN_SUCCESS)
458 end = trunc_page(end);
461 return (KERN_SUCCESS);
462 if ((offset & PAGE_MASK) != 0) {
464 * The mapping is not page aligned. This means that we have
467 rv = vm_map_fixed(map, NULL, 0, start, end - start,
468 prot | VM_PROT_WRITE, VM_PROT_ALL, MAP_CHECK_EXCL);
469 if (rv != KERN_SUCCESS)
472 return (KERN_SUCCESS);
473 for (; start < end; start += sz) {
474 sf = vm_imgact_map_page(object, offset);
476 return (KERN_FAILURE);
477 off = offset - trunc_page(offset);
479 if (sz > PAGE_SIZE - off)
480 sz = PAGE_SIZE - off;
481 error = copyout((caddr_t)sf_buf_kva(sf) + off,
483 vm_imgact_unmap_page(sf);
485 return (KERN_FAILURE);
489 vm_object_reference(object);
490 rv = vm_map_fixed(map, object, offset, start, end - start,
491 prot, VM_PROT_ALL, cow | MAP_CHECK_EXCL);
492 if (rv != KERN_SUCCESS) {
493 locked = VOP_ISLOCKED(imgp->vp);
494 VOP_UNLOCK(imgp->vp, 0);
495 vm_object_deallocate(object);
496 vn_lock(imgp->vp, locked | LK_RETRY);
500 return (KERN_SUCCESS);
504 __elfN(load_section)(struct image_params *imgp, vm_ooffset_t offset,
505 caddr_t vmaddr, size_t memsz, size_t filsz, vm_prot_t prot,
512 vm_offset_t off, map_addr;
515 vm_ooffset_t file_addr;
518 * It's necessary to fail if the filsz + offset taken from the
519 * header is greater than the actual file pager object's size.
520 * If we were to allow this, then the vm_map_find() below would
521 * walk right off the end of the file object and into the ether.
523 * While I'm here, might as well check for something else that
524 * is invalid: filsz cannot be greater than memsz.
526 if ((filsz != 0 && (off_t)filsz + offset > imgp->attr->va_size) ||
528 uprintf("elf_load_section: truncated ELF file\n");
532 object = imgp->object;
533 map = &imgp->proc->p_vmspace->vm_map;
534 map_addr = trunc_page_ps((vm_offset_t)vmaddr, pagesize);
535 file_addr = trunc_page_ps(offset, pagesize);
538 * We have two choices. We can either clear the data in the last page
539 * of an oversized mapping, or we can start the anon mapping a page
540 * early and copy the initialized data into that first page. We
545 else if (memsz > filsz)
546 map_len = trunc_page_ps(offset + filsz, pagesize) - file_addr;
548 map_len = round_page_ps(offset + filsz, pagesize) - file_addr;
551 /* cow flags: don't dump readonly sections in core */
552 cow = MAP_COPY_ON_WRITE | MAP_PREFAULT |
553 (prot & VM_PROT_WRITE ? 0 : MAP_DISABLE_COREDUMP);
555 rv = __elfN(map_insert)(imgp, map,
557 file_addr, /* file offset */
558 map_addr, /* virtual start */
559 map_addr + map_len,/* virtual end */
562 if (rv != KERN_SUCCESS)
565 /* we can stop now if we've covered it all */
572 * We have to get the remaining bit of the file into the first part
573 * of the oversized map segment. This is normally because the .data
574 * segment in the file is extended to provide bss. It's a neat idea
575 * to try and save a page, but it's a pain in the behind to implement.
577 copy_len = filsz == 0 ? 0 : (offset + filsz) - trunc_page_ps(offset +
579 map_addr = trunc_page_ps((vm_offset_t)vmaddr + filsz, pagesize);
580 map_len = round_page_ps((vm_offset_t)vmaddr + memsz, pagesize) -
583 /* This had damn well better be true! */
585 rv = __elfN(map_insert)(imgp, map, NULL, 0, map_addr,
586 map_addr + map_len, VM_PROT_ALL, 0);
587 if (rv != KERN_SUCCESS)
592 sf = vm_imgact_map_page(object, offset + filsz);
596 /* send the page fragment to user space */
597 off = trunc_page_ps(offset + filsz, pagesize) -
598 trunc_page(offset + filsz);
599 error = copyout((caddr_t)sf_buf_kva(sf) + off,
600 (caddr_t)map_addr, copy_len);
601 vm_imgact_unmap_page(sf);
607 * set it to the specified protection.
609 vm_map_protect(map, trunc_page(map_addr), round_page(map_addr +
610 map_len), prot, FALSE);
616 * Load the file "file" into memory. It may be either a shared object
619 * The "addr" reference parameter is in/out. On entry, it specifies
620 * the address where a shared object should be loaded. If the file is
621 * an executable, this value is ignored. On exit, "addr" specifies
622 * where the file was actually loaded.
624 * The "entry" reference parameter is out only. On exit, it specifies
625 * the entry point for the loaded file.
628 __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
629 u_long *entry, size_t pagesize)
634 struct image_params image_params;
636 const Elf_Ehdr *hdr = NULL;
637 const Elf_Phdr *phdr = NULL;
638 struct nameidata *nd;
640 struct image_params *imgp;
643 u_long base_addr = 0;
644 int error, i, numsegs;
646 #ifdef CAPABILITY_MODE
648 * XXXJA: This check can go away once we are sufficiently confident
649 * that the checks in namei() are correct.
651 if (IN_CAPABILITY_MODE(curthread))
655 tempdata = malloc(sizeof(*tempdata), M_TEMP, M_WAITOK);
657 attr = &tempdata->attr;
658 imgp = &tempdata->image_params;
661 * Initialize part of the common data
665 imgp->firstpage = NULL;
666 imgp->image_header = NULL;
668 imgp->execlabel = NULL;
670 NDINIT(nd, LOOKUP, LOCKLEAF | FOLLOW, UIO_SYSSPACE, file, curthread);
671 if ((error = namei(nd)) != 0) {
675 NDFREE(nd, NDF_ONLY_PNBUF);
676 imgp->vp = nd->ni_vp;
679 * Check permissions, modes, uid, etc on the file, and "open" it.
681 error = exec_check_permissions(imgp);
685 error = exec_map_first_page(imgp);
690 * Also make certain that the interpreter stays the same, so set
691 * its VV_TEXT flag, too.
693 VOP_SET_TEXT(nd->ni_vp);
695 imgp->object = nd->ni_vp->v_object;
697 hdr = (const Elf_Ehdr *)imgp->image_header;
698 if ((error = __elfN(check_header)(hdr)) != 0)
700 if (hdr->e_type == ET_DYN)
702 else if (hdr->e_type == ET_EXEC)
709 /* Only support headers that fit within first page for now */
710 if ((hdr->e_phoff > PAGE_SIZE) ||
711 (u_int)hdr->e_phentsize * hdr->e_phnum > PAGE_SIZE - hdr->e_phoff) {
716 phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
717 if (!aligned(phdr, Elf_Addr)) {
722 for (i = 0, numsegs = 0; i < hdr->e_phnum; i++) {
723 if (phdr[i].p_type == PT_LOAD && phdr[i].p_memsz != 0) {
724 /* Loadable segment */
725 prot = __elfN(trans_prot)(phdr[i].p_flags);
726 error = __elfN(load_section)(imgp, phdr[i].p_offset,
727 (caddr_t)(uintptr_t)phdr[i].p_vaddr + rbase,
728 phdr[i].p_memsz, phdr[i].p_filesz, prot, pagesize);
732 * Establish the base address if this is the
736 base_addr = trunc_page(phdr[i].p_vaddr +
742 *entry = (unsigned long)hdr->e_entry + rbase;
746 exec_unmap_first_page(imgp);
751 free(tempdata, M_TEMP);
757 __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp)
761 const Elf_Phdr *phdr;
762 Elf_Auxargs *elf_auxargs;
763 struct vmspace *vmspace;
764 const char *err_str, *newinterp;
765 char *interp, *interp_buf, *path;
766 Elf_Brandinfo *brand_info;
767 struct sysentvec *sv;
769 u_long text_size, data_size, total_size, text_addr, data_addr;
770 u_long seg_size, seg_addr, addr, baddr, et_dyn_addr, entry, proghdr;
772 int error, i, n, interp_name_len, have_interp;
774 hdr = (const Elf_Ehdr *)imgp->image_header;
777 * Do we have a valid ELF header ?
779 * Only allow ET_EXEC & ET_DYN here, reject ET_DYN later
780 * if particular brand doesn't support it.
782 if (__elfN(check_header)(hdr) != 0 ||
783 (hdr->e_type != ET_EXEC && hdr->e_type != ET_DYN))
787 * From here on down, we return an errno, not -1, as we've
788 * detected an ELF file.
791 if ((hdr->e_phoff > PAGE_SIZE) ||
792 (u_int)hdr->e_phentsize * hdr->e_phnum > PAGE_SIZE - hdr->e_phoff) {
793 /* Only support headers in first page for now */
794 uprintf("Program headers not in the first page\n");
797 phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
798 if (!aligned(phdr, Elf_Addr)) {
799 uprintf("Unaligned program headers\n");
806 text_size = data_size = total_size = text_addr = data_addr = 0;
809 err_str = newinterp = NULL;
810 interp = interp_buf = NULL;
813 for (i = 0; i < hdr->e_phnum; i++) {
814 switch (phdr[i].p_type) {
817 baddr = phdr[i].p_vaddr;
821 /* Path to interpreter */
822 if (phdr[i].p_filesz > MAXPATHLEN) {
823 uprintf("Invalid PT_INTERP\n");
827 if (interp != NULL) {
828 uprintf("Multiple PT_INTERP headers\n");
832 interp_name_len = phdr[i].p_filesz;
833 if (phdr[i].p_offset > PAGE_SIZE ||
834 interp_name_len > PAGE_SIZE - phdr[i].p_offset) {
835 VOP_UNLOCK(imgp->vp, 0);
836 interp_buf = malloc(interp_name_len + 1, M_TEMP,
838 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
839 error = vn_rdwr(UIO_READ, imgp->vp, interp_buf,
840 interp_name_len, phdr[i].p_offset,
841 UIO_SYSSPACE, IO_NODELOCKED, td->td_ucred,
844 uprintf("i/o error PT_INTERP\n");
847 interp_buf[interp_name_len] = '\0';
850 interp = __DECONST(char *, imgp->image_header) +
857 __elfN(trans_prot)(phdr[i].p_flags);
858 imgp->stack_sz = phdr[i].p_memsz;
863 brand_info = __elfN(get_brandinfo)(imgp, interp, interp_name_len,
865 if (brand_info == NULL) {
866 uprintf("ELF binary type \"%u\" not known.\n",
867 hdr->e_ident[EI_OSABI]);
871 if (hdr->e_type == ET_DYN) {
872 if ((brand_info->flags & BI_CAN_EXEC_DYN) == 0) {
873 uprintf("Cannot execute shared object\n");
878 * Honour the base load address from the dso if it is
879 * non-zero for some reason.
882 et_dyn_addr = ET_DYN_LOAD_ADDR;
887 sv = brand_info->sysvec;
888 if (interp != NULL && brand_info->interp_newpath != NULL)
889 newinterp = brand_info->interp_newpath;
892 * Avoid a possible deadlock if the current address space is destroyed
893 * and that address space maps the locked vnode. In the common case,
894 * the locked vnode's v_usecount is decremented but remains greater
895 * than zero. Consequently, the vnode lock is not needed by vrele().
896 * However, in cases where the vnode lock is external, such as nullfs,
897 * v_usecount may become zero.
899 * The VV_TEXT flag prevents modifications to the executable while
900 * the vnode is unlocked.
902 VOP_UNLOCK(imgp->vp, 0);
904 error = exec_new_vmspace(imgp, sv);
905 imgp->proc->p_sysent = sv;
907 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
911 for (i = 0; i < hdr->e_phnum; i++) {
912 switch (phdr[i].p_type) {
913 case PT_LOAD: /* Loadable segment */
914 if (phdr[i].p_memsz == 0)
916 prot = __elfN(trans_prot)(phdr[i].p_flags);
917 error = __elfN(load_section)(imgp, phdr[i].p_offset,
918 (caddr_t)(uintptr_t)phdr[i].p_vaddr + et_dyn_addr,
919 phdr[i].p_memsz, phdr[i].p_filesz, prot,
925 * If this segment contains the program headers,
926 * remember their virtual address for the AT_PHDR
927 * aux entry. Static binaries don't usually include
930 if (phdr[i].p_offset == 0 &&
931 hdr->e_phoff + hdr->e_phnum * hdr->e_phentsize
933 proghdr = phdr[i].p_vaddr + hdr->e_phoff +
936 seg_addr = trunc_page(phdr[i].p_vaddr + et_dyn_addr);
937 seg_size = round_page(phdr[i].p_memsz +
938 phdr[i].p_vaddr + et_dyn_addr - seg_addr);
941 * Make the largest executable segment the official
942 * text segment and all others data.
944 * Note that obreak() assumes that data_addr +
945 * data_size == end of data load area, and the ELF
946 * file format expects segments to be sorted by
947 * address. If multiple data segments exist, the
948 * last one will be used.
951 if (phdr[i].p_flags & PF_X && text_size < seg_size) {
952 text_size = seg_size;
953 text_addr = seg_addr;
955 data_size = seg_size;
956 data_addr = seg_addr;
958 total_size += seg_size;
960 case PT_PHDR: /* Program header table info */
961 proghdr = phdr[i].p_vaddr + et_dyn_addr;
968 if (data_addr == 0 && data_size == 0) {
969 data_addr = text_addr;
970 data_size = text_size;
973 entry = (u_long)hdr->e_entry + et_dyn_addr;
976 * Check limits. It should be safe to check the
977 * limits after loading the segments since we do
978 * not actually fault in all the segments pages.
980 PROC_LOCK(imgp->proc);
981 if (data_size > lim_cur_proc(imgp->proc, RLIMIT_DATA))
982 err_str = "Data segment size exceeds process limit";
983 else if (text_size > maxtsiz)
984 err_str = "Text segment size exceeds system limit";
985 else if (total_size > lim_cur_proc(imgp->proc, RLIMIT_VMEM))
986 err_str = "Total segment size exceeds process limit";
987 else if (racct_set(imgp->proc, RACCT_DATA, data_size) != 0)
988 err_str = "Data segment size exceeds resource limit";
989 else if (racct_set(imgp->proc, RACCT_VMEM, total_size) != 0)
990 err_str = "Total segment size exceeds resource limit";
991 if (err_str != NULL) {
992 PROC_UNLOCK(imgp->proc);
993 uprintf("%s\n", err_str);
998 vmspace = imgp->proc->p_vmspace;
999 vmspace->vm_tsize = text_size >> PAGE_SHIFT;
1000 vmspace->vm_taddr = (caddr_t)(uintptr_t)text_addr;
1001 vmspace->vm_dsize = data_size >> PAGE_SHIFT;
1002 vmspace->vm_daddr = (caddr_t)(uintptr_t)data_addr;
1005 * We load the dynamic linker where a userland call
1006 * to mmap(0, ...) would put it. The rationale behind this
1007 * calculation is that it leaves room for the heap to grow to
1008 * its maximum allowed size.
1010 addr = round_page((vm_offset_t)vmspace->vm_daddr + lim_max(td,
1012 PROC_UNLOCK(imgp->proc);
1014 imgp->entry_addr = entry;
1016 if (interp != NULL) {
1017 have_interp = FALSE;
1018 VOP_UNLOCK(imgp->vp, 0);
1019 if (brand_info->emul_path != NULL &&
1020 brand_info->emul_path[0] != '\0') {
1021 path = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1022 snprintf(path, MAXPATHLEN, "%s%s",
1023 brand_info->emul_path, interp);
1024 error = __elfN(load_file)(imgp->proc, path, &addr,
1025 &imgp->entry_addr, sv->sv_pagesize);
1030 if (!have_interp && newinterp != NULL &&
1031 (brand_info->interp_path == NULL ||
1032 strcmp(interp, brand_info->interp_path) == 0)) {
1033 error = __elfN(load_file)(imgp->proc, newinterp, &addr,
1034 &imgp->entry_addr, sv->sv_pagesize);
1039 error = __elfN(load_file)(imgp->proc, interp, &addr,
1040 &imgp->entry_addr, sv->sv_pagesize);
1042 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
1044 uprintf("ELF interpreter %s not found, error %d\n",
1052 * Construct auxargs table (used by the fixup routine)
1054 elf_auxargs = malloc(sizeof(Elf_Auxargs), M_TEMP, M_WAITOK);
1055 elf_auxargs->execfd = -1;
1056 elf_auxargs->phdr = proghdr;
1057 elf_auxargs->phent = hdr->e_phentsize;
1058 elf_auxargs->phnum = hdr->e_phnum;
1059 elf_auxargs->pagesz = PAGE_SIZE;
1060 elf_auxargs->base = addr;
1061 elf_auxargs->flags = 0;
1062 elf_auxargs->entry = entry;
1063 elf_auxargs->hdr_eflags = hdr->e_flags;
1065 imgp->auxargs = elf_auxargs;
1066 imgp->interpreted = 0;
1067 imgp->reloc_base = addr;
1068 imgp->proc->p_osrel = osrel;
1071 free(interp_buf, M_TEMP);
1075 #define suword __CONCAT(suword, __ELF_WORD_SIZE)
1078 __elfN(freebsd_fixup)(register_t **stack_base, struct image_params *imgp)
1080 Elf_Auxargs *args = (Elf_Auxargs *)imgp->auxargs;
1084 base = (Elf_Addr *)*stack_base;
1085 pos = base + (imgp->args->argc + imgp->args->envc + 2);
1087 if (args->execfd != -1)
1088 AUXARGS_ENTRY(pos, AT_EXECFD, args->execfd);
1089 AUXARGS_ENTRY(pos, AT_PHDR, args->phdr);
1090 AUXARGS_ENTRY(pos, AT_PHENT, args->phent);
1091 AUXARGS_ENTRY(pos, AT_PHNUM, args->phnum);
1092 AUXARGS_ENTRY(pos, AT_PAGESZ, args->pagesz);
1093 AUXARGS_ENTRY(pos, AT_FLAGS, args->flags);
1094 AUXARGS_ENTRY(pos, AT_ENTRY, args->entry);
1095 AUXARGS_ENTRY(pos, AT_BASE, args->base);
1097 AUXARGS_ENTRY(pos, AT_EHDRFLAGS, args->hdr_eflags);
1099 if (imgp->execpathp != 0)
1100 AUXARGS_ENTRY(pos, AT_EXECPATH, imgp->execpathp);
1101 AUXARGS_ENTRY(pos, AT_OSRELDATE,
1102 imgp->proc->p_ucred->cr_prison->pr_osreldate);
1103 if (imgp->canary != 0) {
1104 AUXARGS_ENTRY(pos, AT_CANARY, imgp->canary);
1105 AUXARGS_ENTRY(pos, AT_CANARYLEN, imgp->canarylen);
1107 AUXARGS_ENTRY(pos, AT_NCPUS, mp_ncpus);
1108 if (imgp->pagesizes != 0) {
1109 AUXARGS_ENTRY(pos, AT_PAGESIZES, imgp->pagesizes);
1110 AUXARGS_ENTRY(pos, AT_PAGESIZESLEN, imgp->pagesizeslen);
1112 if (imgp->sysent->sv_timekeep_base != 0) {
1113 AUXARGS_ENTRY(pos, AT_TIMEKEEP,
1114 imgp->sysent->sv_timekeep_base);
1116 AUXARGS_ENTRY(pos, AT_STACKPROT, imgp->sysent->sv_shared_page_obj
1117 != NULL && imgp->stack_prot != 0 ? imgp->stack_prot :
1118 imgp->sysent->sv_stackprot);
1119 AUXARGS_ENTRY(pos, AT_NULL, 0);
1121 free(imgp->auxargs, M_TEMP);
1122 imgp->auxargs = NULL;
1125 suword(base, (long)imgp->args->argc);
1126 *stack_base = (register_t *)base;
1131 * Code for generating ELF core dumps.
1134 typedef void (*segment_callback)(vm_map_entry_t, void *);
1136 /* Closure for cb_put_phdr(). */
1137 struct phdr_closure {
1138 Elf_Phdr *phdr; /* Program header to fill in */
1139 Elf_Off offset; /* Offset of segment in core file */
1142 /* Closure for cb_size_segment(). */
1143 struct sseg_closure {
1144 int count; /* Count of writable segments. */
1145 size_t size; /* Total size of all writable segments. */
1148 typedef void (*outfunc_t)(void *, struct sbuf *, size_t *);
1151 int type; /* Note type. */
1152 outfunc_t outfunc; /* Output function. */
1153 void *outarg; /* Argument for the output function. */
1154 size_t outsize; /* Output size. */
1155 TAILQ_ENTRY(note_info) link; /* Link to the next note info. */
1158 TAILQ_HEAD(note_info_list, note_info);
1160 /* Coredump output parameters. */
1161 struct coredump_params {
1163 struct ucred *active_cred;
1164 struct ucred *file_cred;
1167 struct gzio_stream *gzs;
1170 static void cb_put_phdr(vm_map_entry_t, void *);
1171 static void cb_size_segment(vm_map_entry_t, void *);
1172 static int core_write(struct coredump_params *, const void *, size_t, off_t,
1174 static void each_writable_segment(struct thread *, segment_callback, void *);
1175 static int __elfN(corehdr)(struct coredump_params *, int, void *, size_t,
1176 struct note_info_list *, size_t);
1177 static void __elfN(prepare_notes)(struct thread *, struct note_info_list *,
1179 static void __elfN(puthdr)(struct thread *, void *, size_t, int, size_t);
1180 static void __elfN(putnote)(struct note_info *, struct sbuf *);
1181 static size_t register_note(struct note_info_list *, int, outfunc_t, void *);
1182 static int sbuf_drain_core_output(void *, const char *, int);
1183 static int sbuf_drain_count(void *arg, const char *data, int len);
1185 static void __elfN(note_fpregset)(void *, struct sbuf *, size_t *);
1186 static void __elfN(note_prpsinfo)(void *, struct sbuf *, size_t *);
1187 static void __elfN(note_prstatus)(void *, struct sbuf *, size_t *);
1188 static void __elfN(note_threadmd)(void *, struct sbuf *, size_t *);
1189 static void __elfN(note_thrmisc)(void *, struct sbuf *, size_t *);
1190 static void __elfN(note_procstat_auxv)(void *, struct sbuf *, size_t *);
1191 static void __elfN(note_procstat_proc)(void *, struct sbuf *, size_t *);
1192 static void __elfN(note_procstat_psstrings)(void *, struct sbuf *, size_t *);
1193 static void note_procstat_files(void *, struct sbuf *, size_t *);
1194 static void note_procstat_groups(void *, struct sbuf *, size_t *);
1195 static void note_procstat_osrel(void *, struct sbuf *, size_t *);
1196 static void note_procstat_rlimit(void *, struct sbuf *, size_t *);
1197 static void note_procstat_umask(void *, struct sbuf *, size_t *);
1198 static void note_procstat_vmmap(void *, struct sbuf *, size_t *);
1201 extern int compress_user_cores_gzlevel;
1204 * Write out a core segment to the compression stream.
1207 compress_chunk(struct coredump_params *p, char *base, char *buf, u_int len)
1213 chunk_len = MIN(len, CORE_BUF_SIZE);
1216 * We can get EFAULT error here.
1217 * In that case zero out the current chunk of the segment.
1219 error = copyin(base, buf, chunk_len);
1221 bzero(buf, chunk_len);
1222 error = gzio_write(p->gzs, buf, chunk_len);
1232 core_gz_write(void *base, size_t len, off_t offset, void *arg)
1235 return (core_write((struct coredump_params *)arg, base, len, offset,
1241 core_write(struct coredump_params *p, const void *base, size_t len,
1242 off_t offset, enum uio_seg seg)
1245 return (vn_rdwr_inchunks(UIO_WRITE, p->vp, __DECONST(void *, base),
1246 len, offset, seg, IO_UNIT | IO_DIRECT | IO_RANGELOCKED,
1247 p->active_cred, p->file_cred, NULL, p->td));
1251 core_output(void *base, size_t len, off_t offset, struct coredump_params *p,
1258 return (compress_chunk(p, base, tmpbuf, len));
1261 * EFAULT is a non-fatal error that we can get, for example,
1262 * if the segment is backed by a file but extends beyond its
1265 error = core_write(p, base, len, offset, UIO_USERSPACE);
1266 if (error == EFAULT) {
1267 log(LOG_WARNING, "Failed to fully fault in a core file segment "
1268 "at VA %p with size 0x%zx to be written at offset 0x%jx "
1269 "for process %s\n", base, len, offset, curproc->p_comm);
1272 * Write a "real" zero byte at the end of the target region
1273 * in the case this is the last segment.
1274 * The intermediate space will be implicitly zero-filled.
1276 error = core_write(p, zero_region, 1, offset + len - 1,
1283 * Drain into a core file.
1286 sbuf_drain_core_output(void *arg, const char *data, int len)
1288 struct coredump_params *p;
1291 p = (struct coredump_params *)arg;
1294 * Some kern_proc out routines that print to this sbuf may
1295 * call us with the process lock held. Draining with the
1296 * non-sleepable lock held is unsafe. The lock is needed for
1297 * those routines when dumping a live process. In our case we
1298 * can safely release the lock before draining and acquire
1301 locked = PROC_LOCKED(p->td->td_proc);
1303 PROC_UNLOCK(p->td->td_proc);
1306 error = gzio_write(p->gzs, __DECONST(char *, data), len);
1309 error = core_write(p, __DECONST(void *, data), len, p->offset,
1312 PROC_LOCK(p->td->td_proc);
1320 * Drain into a counter.
1323 sbuf_drain_count(void *arg, const char *data __unused, int len)
1327 sizep = (size_t *)arg;
1333 __elfN(coredump)(struct thread *td, struct vnode *vp, off_t limit, int flags)
1335 struct ucred *cred = td->td_ucred;
1337 struct sseg_closure seginfo;
1338 struct note_info_list notelst;
1339 struct coredump_params params;
1340 struct note_info *ninfo;
1342 size_t hdrsize, notesz, coresize;
1346 compress = (flags & IMGACT_CORE_COMPRESS) != 0;
1350 TAILQ_INIT(¬elst);
1352 /* Size the program segments. */
1355 each_writable_segment(td, cb_size_segment, &seginfo);
1358 * Collect info about the core file header area.
1360 hdrsize = sizeof(Elf_Ehdr) + sizeof(Elf_Phdr) * (1 + seginfo.count);
1361 __elfN(prepare_notes)(td, ¬elst, ¬esz);
1362 coresize = round_page(hdrsize + notesz) + seginfo.size;
1364 /* Set up core dump parameters. */
1366 params.active_cred = cred;
1367 params.file_cred = NOCRED;
1374 PROC_LOCK(td->td_proc);
1375 error = racct_add(td->td_proc, RACCT_CORE, coresize);
1376 PROC_UNLOCK(td->td_proc);
1383 if (coresize >= limit) {
1389 /* Create a compression stream if necessary. */
1391 params.gzs = gzio_init(core_gz_write, GZIO_DEFLATE,
1392 CORE_BUF_SIZE, compress_user_cores_gzlevel, ¶ms);
1393 if (params.gzs == NULL) {
1397 tmpbuf = malloc(CORE_BUF_SIZE, M_TEMP, M_WAITOK | M_ZERO);
1402 * Allocate memory for building the header, fill it up,
1403 * and write it out following the notes.
1405 hdr = malloc(hdrsize, M_TEMP, M_WAITOK);
1406 error = __elfN(corehdr)(¶ms, seginfo.count, hdr, hdrsize, ¬elst,
1409 /* Write the contents of all of the writable segments. */
1415 php = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr)) + 1;
1416 offset = round_page(hdrsize + notesz);
1417 for (i = 0; i < seginfo.count; i++) {
1418 error = core_output((caddr_t)(uintptr_t)php->p_vaddr,
1419 php->p_filesz, offset, ¶ms, tmpbuf);
1422 offset += php->p_filesz;
1426 if (error == 0 && compress)
1427 error = gzio_flush(params.gzs);
1432 "Failed to write core file for process %s (error %d)\n",
1433 curproc->p_comm, error);
1439 free(tmpbuf, M_TEMP);
1440 if (params.gzs != NULL)
1441 gzio_fini(params.gzs);
1444 while ((ninfo = TAILQ_FIRST(¬elst)) != NULL) {
1445 TAILQ_REMOVE(¬elst, ninfo, link);
1446 free(ninfo, M_TEMP);
1455 * A callback for each_writable_segment() to write out the segment's
1456 * program header entry.
1459 cb_put_phdr(entry, closure)
1460 vm_map_entry_t entry;
1463 struct phdr_closure *phc = (struct phdr_closure *)closure;
1464 Elf_Phdr *phdr = phc->phdr;
1466 phc->offset = round_page(phc->offset);
1468 phdr->p_type = PT_LOAD;
1469 phdr->p_offset = phc->offset;
1470 phdr->p_vaddr = entry->start;
1472 phdr->p_filesz = phdr->p_memsz = entry->end - entry->start;
1473 phdr->p_align = PAGE_SIZE;
1474 phdr->p_flags = __elfN(untrans_prot)(entry->protection);
1476 phc->offset += phdr->p_filesz;
1481 * A callback for each_writable_segment() to gather information about
1482 * the number of segments and their total size.
1485 cb_size_segment(entry, closure)
1486 vm_map_entry_t entry;
1489 struct sseg_closure *ssc = (struct sseg_closure *)closure;
1492 ssc->size += entry->end - entry->start;
1496 * For each writable segment in the process's memory map, call the given
1497 * function with a pointer to the map entry and some arbitrary
1498 * caller-supplied data.
1501 each_writable_segment(td, func, closure)
1503 segment_callback func;
1506 struct proc *p = td->td_proc;
1507 vm_map_t map = &p->p_vmspace->vm_map;
1508 vm_map_entry_t entry;
1509 vm_object_t backing_object, object;
1510 boolean_t ignore_entry;
1512 vm_map_lock_read(map);
1513 for (entry = map->header.next; entry != &map->header;
1514 entry = entry->next) {
1516 * Don't dump inaccessible mappings, deal with legacy
1519 * Note that read-only segments related to the elf binary
1520 * are marked MAP_ENTRY_NOCOREDUMP now so we no longer
1521 * need to arbitrarily ignore such segments.
1523 if (elf_legacy_coredump) {
1524 if ((entry->protection & VM_PROT_RW) != VM_PROT_RW)
1527 if ((entry->protection & VM_PROT_ALL) == 0)
1532 * Dont include memory segment in the coredump if
1533 * MAP_NOCORE is set in mmap(2) or MADV_NOCORE in
1534 * madvise(2). Do not dump submaps (i.e. parts of the
1537 if (entry->eflags & (MAP_ENTRY_NOCOREDUMP|MAP_ENTRY_IS_SUB_MAP))
1540 if ((object = entry->object.vm_object) == NULL)
1543 /* Ignore memory-mapped devices and such things. */
1544 VM_OBJECT_RLOCK(object);
1545 while ((backing_object = object->backing_object) != NULL) {
1546 VM_OBJECT_RLOCK(backing_object);
1547 VM_OBJECT_RUNLOCK(object);
1548 object = backing_object;
1550 ignore_entry = object->type != OBJT_DEFAULT &&
1551 object->type != OBJT_SWAP && object->type != OBJT_VNODE &&
1552 object->type != OBJT_PHYS;
1553 VM_OBJECT_RUNLOCK(object);
1557 (*func)(entry, closure);
1559 vm_map_unlock_read(map);
1563 * Write the core file header to the file, including padding up to
1564 * the page boundary.
1567 __elfN(corehdr)(struct coredump_params *p, int numsegs, void *hdr,
1568 size_t hdrsize, struct note_info_list *notelst, size_t notesz)
1570 struct note_info *ninfo;
1574 /* Fill in the header. */
1575 bzero(hdr, hdrsize);
1576 __elfN(puthdr)(p->td, hdr, hdrsize, numsegs, notesz);
1578 sb = sbuf_new(NULL, NULL, CORE_BUF_SIZE, SBUF_FIXEDLEN);
1579 sbuf_set_drain(sb, sbuf_drain_core_output, p);
1580 sbuf_start_section(sb, NULL);
1581 sbuf_bcat(sb, hdr, hdrsize);
1582 TAILQ_FOREACH(ninfo, notelst, link)
1583 __elfN(putnote)(ninfo, sb);
1584 /* Align up to a page boundary for the program segments. */
1585 sbuf_end_section(sb, -1, PAGE_SIZE, 0);
1586 error = sbuf_finish(sb);
1593 __elfN(prepare_notes)(struct thread *td, struct note_info_list *list,
1603 size += register_note(list, NT_PRPSINFO, __elfN(note_prpsinfo), p);
1606 * To have the debugger select the right thread (LWP) as the initial
1607 * thread, we dump the state of the thread passed to us in td first.
1608 * This is the thread that causes the core dump and thus likely to
1609 * be the right thread one wants to have selected in the debugger.
1612 while (thr != NULL) {
1613 size += register_note(list, NT_PRSTATUS,
1614 __elfN(note_prstatus), thr);
1615 size += register_note(list, NT_FPREGSET,
1616 __elfN(note_fpregset), thr);
1617 size += register_note(list, NT_THRMISC,
1618 __elfN(note_thrmisc), thr);
1619 size += register_note(list, -1,
1620 __elfN(note_threadmd), thr);
1622 thr = (thr == td) ? TAILQ_FIRST(&p->p_threads) :
1623 TAILQ_NEXT(thr, td_plist);
1625 thr = TAILQ_NEXT(thr, td_plist);
1628 size += register_note(list, NT_PROCSTAT_PROC,
1629 __elfN(note_procstat_proc), p);
1630 size += register_note(list, NT_PROCSTAT_FILES,
1631 note_procstat_files, p);
1632 size += register_note(list, NT_PROCSTAT_VMMAP,
1633 note_procstat_vmmap, p);
1634 size += register_note(list, NT_PROCSTAT_GROUPS,
1635 note_procstat_groups, p);
1636 size += register_note(list, NT_PROCSTAT_UMASK,
1637 note_procstat_umask, p);
1638 size += register_note(list, NT_PROCSTAT_RLIMIT,
1639 note_procstat_rlimit, p);
1640 size += register_note(list, NT_PROCSTAT_OSREL,
1641 note_procstat_osrel, p);
1642 size += register_note(list, NT_PROCSTAT_PSSTRINGS,
1643 __elfN(note_procstat_psstrings), p);
1644 size += register_note(list, NT_PROCSTAT_AUXV,
1645 __elfN(note_procstat_auxv), p);
1651 __elfN(puthdr)(struct thread *td, void *hdr, size_t hdrsize, int numsegs,
1656 struct phdr_closure phc;
1658 ehdr = (Elf_Ehdr *)hdr;
1659 phdr = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr));
1661 ehdr->e_ident[EI_MAG0] = ELFMAG0;
1662 ehdr->e_ident[EI_MAG1] = ELFMAG1;
1663 ehdr->e_ident[EI_MAG2] = ELFMAG2;
1664 ehdr->e_ident[EI_MAG3] = ELFMAG3;
1665 ehdr->e_ident[EI_CLASS] = ELF_CLASS;
1666 ehdr->e_ident[EI_DATA] = ELF_DATA;
1667 ehdr->e_ident[EI_VERSION] = EV_CURRENT;
1668 ehdr->e_ident[EI_OSABI] = ELFOSABI_FREEBSD;
1669 ehdr->e_ident[EI_ABIVERSION] = 0;
1670 ehdr->e_ident[EI_PAD] = 0;
1671 ehdr->e_type = ET_CORE;
1672 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
1673 ehdr->e_machine = ELF_ARCH32;
1675 ehdr->e_machine = ELF_ARCH;
1677 ehdr->e_version = EV_CURRENT;
1679 ehdr->e_phoff = sizeof(Elf_Ehdr);
1681 ehdr->e_ehsize = sizeof(Elf_Ehdr);
1682 ehdr->e_phentsize = sizeof(Elf_Phdr);
1683 ehdr->e_phnum = numsegs + 1;
1684 ehdr->e_shentsize = sizeof(Elf_Shdr);
1686 ehdr->e_shstrndx = SHN_UNDEF;
1689 * Fill in the program header entries.
1692 /* The note segement. */
1693 phdr->p_type = PT_NOTE;
1694 phdr->p_offset = hdrsize;
1697 phdr->p_filesz = notesz;
1699 phdr->p_flags = PF_R;
1700 phdr->p_align = ELF_NOTE_ROUNDSIZE;
1703 /* All the writable segments from the program. */
1705 phc.offset = round_page(hdrsize + notesz);
1706 each_writable_segment(td, cb_put_phdr, &phc);
1710 register_note(struct note_info_list *list, int type, outfunc_t out, void *arg)
1712 struct note_info *ninfo;
1713 size_t size, notesize;
1716 out(arg, NULL, &size);
1717 ninfo = malloc(sizeof(*ninfo), M_TEMP, M_ZERO | M_WAITOK);
1719 ninfo->outfunc = out;
1720 ninfo->outarg = arg;
1721 ninfo->outsize = size;
1722 TAILQ_INSERT_TAIL(list, ninfo, link);
1727 notesize = sizeof(Elf_Note) + /* note header */
1728 roundup2(sizeof(FREEBSD_ABI_VENDOR), ELF_NOTE_ROUNDSIZE) +
1730 roundup2(size, ELF_NOTE_ROUNDSIZE); /* note description */
1736 append_note_data(const void *src, void *dst, size_t len)
1740 padded_len = roundup2(len, ELF_NOTE_ROUNDSIZE);
1742 bcopy(src, dst, len);
1743 bzero((char *)dst + len, padded_len - len);
1745 return (padded_len);
1749 __elfN(populate_note)(int type, void *src, void *dst, size_t size, void **descp)
1757 note = (Elf_Note *)buf;
1758 note->n_namesz = sizeof(FREEBSD_ABI_VENDOR);
1759 note->n_descsz = size;
1760 note->n_type = type;
1761 buf += sizeof(*note);
1762 buf += append_note_data(FREEBSD_ABI_VENDOR, buf,
1763 sizeof(FREEBSD_ABI_VENDOR));
1764 append_note_data(src, buf, size);
1769 notesize = sizeof(Elf_Note) + /* note header */
1770 roundup2(sizeof(FREEBSD_ABI_VENDOR), ELF_NOTE_ROUNDSIZE) +
1772 roundup2(size, ELF_NOTE_ROUNDSIZE); /* note description */
1778 __elfN(putnote)(struct note_info *ninfo, struct sbuf *sb)
1781 ssize_t old_len, sect_len;
1782 size_t new_len, descsz, i;
1784 if (ninfo->type == -1) {
1785 ninfo->outfunc(ninfo->outarg, sb, &ninfo->outsize);
1789 note.n_namesz = sizeof(FREEBSD_ABI_VENDOR);
1790 note.n_descsz = ninfo->outsize;
1791 note.n_type = ninfo->type;
1793 sbuf_bcat(sb, ¬e, sizeof(note));
1794 sbuf_start_section(sb, &old_len);
1795 sbuf_bcat(sb, FREEBSD_ABI_VENDOR, sizeof(FREEBSD_ABI_VENDOR));
1796 sbuf_end_section(sb, old_len, ELF_NOTE_ROUNDSIZE, 0);
1797 if (note.n_descsz == 0)
1799 sbuf_start_section(sb, &old_len);
1800 ninfo->outfunc(ninfo->outarg, sb, &ninfo->outsize);
1801 sect_len = sbuf_end_section(sb, old_len, ELF_NOTE_ROUNDSIZE, 0);
1805 new_len = (size_t)sect_len;
1806 descsz = roundup(note.n_descsz, ELF_NOTE_ROUNDSIZE);
1807 if (new_len < descsz) {
1809 * It is expected that individual note emitters will correctly
1810 * predict their expected output size and fill up to that size
1811 * themselves, padding in a format-specific way if needed.
1812 * However, in case they don't, just do it here with zeros.
1814 for (i = 0; i < descsz - new_len; i++)
1816 } else if (new_len > descsz) {
1818 * We can't always truncate sb -- we may have drained some
1821 KASSERT(new_len == descsz, ("%s: Note type %u changed as we "
1822 "read it (%zu > %zu). Since it is longer than "
1823 "expected, this coredump's notes are corrupt. THIS "
1824 "IS A BUG in the note_procstat routine for type %u.\n",
1825 __func__, (unsigned)note.n_type, new_len, descsz,
1826 (unsigned)note.n_type));
1831 * Miscellaneous note out functions.
1834 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
1835 #include <compat/freebsd32/freebsd32.h>
1837 typedef struct prstatus32 elf_prstatus_t;
1838 typedef struct prpsinfo32 elf_prpsinfo_t;
1839 typedef struct fpreg32 elf_prfpregset_t;
1840 typedef struct fpreg32 elf_fpregset_t;
1841 typedef struct reg32 elf_gregset_t;
1842 typedef struct thrmisc32 elf_thrmisc_t;
1843 #define ELF_KERN_PROC_MASK KERN_PROC_MASK32
1844 typedef struct kinfo_proc32 elf_kinfo_proc_t;
1845 typedef uint32_t elf_ps_strings_t;
1847 typedef prstatus_t elf_prstatus_t;
1848 typedef prpsinfo_t elf_prpsinfo_t;
1849 typedef prfpregset_t elf_prfpregset_t;
1850 typedef prfpregset_t elf_fpregset_t;
1851 typedef gregset_t elf_gregset_t;
1852 typedef thrmisc_t elf_thrmisc_t;
1853 #define ELF_KERN_PROC_MASK 0
1854 typedef struct kinfo_proc elf_kinfo_proc_t;
1855 typedef vm_offset_t elf_ps_strings_t;
1859 __elfN(note_prpsinfo)(void *arg, struct sbuf *sb, size_t *sizep)
1865 elf_prpsinfo_t *psinfo;
1868 p = (struct proc *)arg;
1870 KASSERT(*sizep == sizeof(*psinfo), ("invalid size"));
1871 psinfo = malloc(sizeof(*psinfo), M_TEMP, M_ZERO | M_WAITOK);
1872 psinfo->pr_version = PRPSINFO_VERSION;
1873 psinfo->pr_psinfosz = sizeof(elf_prpsinfo_t);
1874 strlcpy(psinfo->pr_fname, p->p_comm, sizeof(psinfo->pr_fname));
1876 if (p->p_args != NULL) {
1877 len = sizeof(psinfo->pr_psargs) - 1;
1878 if (len > p->p_args->ar_length)
1879 len = p->p_args->ar_length;
1880 memcpy(psinfo->pr_psargs, p->p_args->ar_args, len);
1886 sbuf_new(&sbarg, psinfo->pr_psargs,
1887 sizeof(psinfo->pr_psargs), SBUF_FIXEDLEN);
1888 error = proc_getargv(curthread, p, &sbarg);
1890 if (sbuf_finish(&sbarg) == 0)
1891 len = sbuf_len(&sbarg) - 1;
1893 len = sizeof(psinfo->pr_psargs) - 1;
1894 sbuf_delete(&sbarg);
1896 if (error || len == 0)
1897 strlcpy(psinfo->pr_psargs, p->p_comm,
1898 sizeof(psinfo->pr_psargs));
1900 KASSERT(len < sizeof(psinfo->pr_psargs),
1901 ("len is too long: %zu vs %zu", len,
1902 sizeof(psinfo->pr_psargs)));
1903 cp = psinfo->pr_psargs;
1906 cp = memchr(cp, '\0', end - cp);
1912 psinfo->pr_pid = p->p_pid;
1913 sbuf_bcat(sb, psinfo, sizeof(*psinfo));
1914 free(psinfo, M_TEMP);
1916 *sizep = sizeof(*psinfo);
1920 __elfN(note_prstatus)(void *arg, struct sbuf *sb, size_t *sizep)
1923 elf_prstatus_t *status;
1925 td = (struct thread *)arg;
1927 KASSERT(*sizep == sizeof(*status), ("invalid size"));
1928 status = malloc(sizeof(*status), M_TEMP, M_ZERO | M_WAITOK);
1929 status->pr_version = PRSTATUS_VERSION;
1930 status->pr_statussz = sizeof(elf_prstatus_t);
1931 status->pr_gregsetsz = sizeof(elf_gregset_t);
1932 status->pr_fpregsetsz = sizeof(elf_fpregset_t);
1933 status->pr_osreldate = osreldate;
1934 status->pr_cursig = td->td_proc->p_sig;
1935 status->pr_pid = td->td_tid;
1936 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
1937 fill_regs32(td, &status->pr_reg);
1939 fill_regs(td, &status->pr_reg);
1941 sbuf_bcat(sb, status, sizeof(*status));
1942 free(status, M_TEMP);
1944 *sizep = sizeof(*status);
1948 __elfN(note_fpregset)(void *arg, struct sbuf *sb, size_t *sizep)
1951 elf_prfpregset_t *fpregset;
1953 td = (struct thread *)arg;
1955 KASSERT(*sizep == sizeof(*fpregset), ("invalid size"));
1956 fpregset = malloc(sizeof(*fpregset), M_TEMP, M_ZERO | M_WAITOK);
1957 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
1958 fill_fpregs32(td, fpregset);
1960 fill_fpregs(td, fpregset);
1962 sbuf_bcat(sb, fpregset, sizeof(*fpregset));
1963 free(fpregset, M_TEMP);
1965 *sizep = sizeof(*fpregset);
1969 __elfN(note_thrmisc)(void *arg, struct sbuf *sb, size_t *sizep)
1972 elf_thrmisc_t thrmisc;
1974 td = (struct thread *)arg;
1976 KASSERT(*sizep == sizeof(thrmisc), ("invalid size"));
1977 bzero(&thrmisc._pad, sizeof(thrmisc._pad));
1978 strcpy(thrmisc.pr_tname, td->td_name);
1979 sbuf_bcat(sb, &thrmisc, sizeof(thrmisc));
1981 *sizep = sizeof(thrmisc);
1985 * Allow for MD specific notes, as well as any MD
1986 * specific preparations for writing MI notes.
1989 __elfN(note_threadmd)(void *arg, struct sbuf *sb, size_t *sizep)
1995 td = (struct thread *)arg;
1997 if (size != 0 && sb != NULL)
1998 buf = malloc(size, M_TEMP, M_ZERO | M_WAITOK);
2002 __elfN(dump_thread)(td, buf, &size);
2003 KASSERT(sb == NULL || *sizep == size, ("invalid size"));
2004 if (size != 0 && sb != NULL)
2005 sbuf_bcat(sb, buf, size);
2010 #ifdef KINFO_PROC_SIZE
2011 CTASSERT(sizeof(struct kinfo_proc) == KINFO_PROC_SIZE);
2015 __elfN(note_procstat_proc)(void *arg, struct sbuf *sb, size_t *sizep)
2021 p = (struct proc *)arg;
2022 size = sizeof(structsize) + p->p_numthreads *
2023 sizeof(elf_kinfo_proc_t);
2026 KASSERT(*sizep == size, ("invalid size"));
2027 structsize = sizeof(elf_kinfo_proc_t);
2028 sbuf_bcat(sb, &structsize, sizeof(structsize));
2029 sx_slock(&proctree_lock);
2031 kern_proc_out(p, sb, ELF_KERN_PROC_MASK);
2032 sx_sunlock(&proctree_lock);
2037 #ifdef KINFO_FILE_SIZE
2038 CTASSERT(sizeof(struct kinfo_file) == KINFO_FILE_SIZE);
2042 note_procstat_files(void *arg, struct sbuf *sb, size_t *sizep)
2045 size_t size, sect_sz, i;
2046 ssize_t start_len, sect_len;
2047 int structsize, filedesc_flags;
2049 if (coredump_pack_fileinfo)
2050 filedesc_flags = KERN_FILEDESC_PACK_KINFO;
2054 p = (struct proc *)arg;
2055 structsize = sizeof(struct kinfo_file);
2058 sb = sbuf_new(NULL, NULL, 128, SBUF_FIXEDLEN);
2059 sbuf_set_drain(sb, sbuf_drain_count, &size);
2060 sbuf_bcat(sb, &structsize, sizeof(structsize));
2062 kern_proc_filedesc_out(p, sb, -1, filedesc_flags);
2067 sbuf_start_section(sb, &start_len);
2069 sbuf_bcat(sb, &structsize, sizeof(structsize));
2071 kern_proc_filedesc_out(p, sb, *sizep - sizeof(structsize),
2074 sect_len = sbuf_end_section(sb, start_len, 0, 0);
2079 KASSERT(sect_sz <= *sizep,
2080 ("kern_proc_filedesc_out did not respect maxlen; "
2081 "requested %zu, got %zu", *sizep - sizeof(structsize),
2082 sect_sz - sizeof(structsize)));
2084 for (i = 0; i < *sizep - sect_sz && sb->s_error == 0; i++)
2089 #ifdef KINFO_VMENTRY_SIZE
2090 CTASSERT(sizeof(struct kinfo_vmentry) == KINFO_VMENTRY_SIZE);
2094 note_procstat_vmmap(void *arg, struct sbuf *sb, size_t *sizep)
2098 int structsize, vmmap_flags;
2100 if (coredump_pack_vmmapinfo)
2101 vmmap_flags = KERN_VMMAP_PACK_KINFO;
2105 p = (struct proc *)arg;
2106 structsize = sizeof(struct kinfo_vmentry);
2109 sb = sbuf_new(NULL, NULL, 128, SBUF_FIXEDLEN);
2110 sbuf_set_drain(sb, sbuf_drain_count, &size);
2111 sbuf_bcat(sb, &structsize, sizeof(structsize));
2113 kern_proc_vmmap_out(p, sb, -1, vmmap_flags);
2118 sbuf_bcat(sb, &structsize, sizeof(structsize));
2120 kern_proc_vmmap_out(p, sb, *sizep - sizeof(structsize),
2126 note_procstat_groups(void *arg, struct sbuf *sb, size_t *sizep)
2132 p = (struct proc *)arg;
2133 size = sizeof(structsize) + p->p_ucred->cr_ngroups * sizeof(gid_t);
2135 KASSERT(*sizep == size, ("invalid size"));
2136 structsize = sizeof(gid_t);
2137 sbuf_bcat(sb, &structsize, sizeof(structsize));
2138 sbuf_bcat(sb, p->p_ucred->cr_groups, p->p_ucred->cr_ngroups *
2145 note_procstat_umask(void *arg, struct sbuf *sb, size_t *sizep)
2151 p = (struct proc *)arg;
2152 size = sizeof(structsize) + sizeof(p->p_fd->fd_cmask);
2154 KASSERT(*sizep == size, ("invalid size"));
2155 structsize = sizeof(p->p_fd->fd_cmask);
2156 sbuf_bcat(sb, &structsize, sizeof(structsize));
2157 sbuf_bcat(sb, &p->p_fd->fd_cmask, sizeof(p->p_fd->fd_cmask));
2163 note_procstat_rlimit(void *arg, struct sbuf *sb, size_t *sizep)
2166 struct rlimit rlim[RLIM_NLIMITS];
2170 p = (struct proc *)arg;
2171 size = sizeof(structsize) + sizeof(rlim);
2173 KASSERT(*sizep == size, ("invalid size"));
2174 structsize = sizeof(rlim);
2175 sbuf_bcat(sb, &structsize, sizeof(structsize));
2177 for (i = 0; i < RLIM_NLIMITS; i++)
2178 lim_rlimit_proc(p, i, &rlim[i]);
2180 sbuf_bcat(sb, rlim, sizeof(rlim));
2186 note_procstat_osrel(void *arg, struct sbuf *sb, size_t *sizep)
2192 p = (struct proc *)arg;
2193 size = sizeof(structsize) + sizeof(p->p_osrel);
2195 KASSERT(*sizep == size, ("invalid size"));
2196 structsize = sizeof(p->p_osrel);
2197 sbuf_bcat(sb, &structsize, sizeof(structsize));
2198 sbuf_bcat(sb, &p->p_osrel, sizeof(p->p_osrel));
2204 __elfN(note_procstat_psstrings)(void *arg, struct sbuf *sb, size_t *sizep)
2207 elf_ps_strings_t ps_strings;
2211 p = (struct proc *)arg;
2212 size = sizeof(structsize) + sizeof(ps_strings);
2214 KASSERT(*sizep == size, ("invalid size"));
2215 structsize = sizeof(ps_strings);
2216 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
2217 ps_strings = PTROUT(p->p_sysent->sv_psstrings);
2219 ps_strings = p->p_sysent->sv_psstrings;
2221 sbuf_bcat(sb, &structsize, sizeof(structsize));
2222 sbuf_bcat(sb, &ps_strings, sizeof(ps_strings));
2228 __elfN(note_procstat_auxv)(void *arg, struct sbuf *sb, size_t *sizep)
2234 p = (struct proc *)arg;
2237 sb = sbuf_new(NULL, NULL, 128, SBUF_FIXEDLEN);
2238 sbuf_set_drain(sb, sbuf_drain_count, &size);
2239 sbuf_bcat(sb, &structsize, sizeof(structsize));
2241 proc_getauxv(curthread, p, sb);
2247 structsize = sizeof(Elf_Auxinfo);
2248 sbuf_bcat(sb, &structsize, sizeof(structsize));
2250 proc_getauxv(curthread, p, sb);
2256 __elfN(parse_notes)(struct image_params *imgp, Elf_Brandnote *checknote,
2257 int32_t *osrel, const Elf_Phdr *pnote)
2259 const Elf_Note *note, *note0, *note_end;
2260 const char *note_name;
2265 /* We need some limit, might as well use PAGE_SIZE. */
2266 if (pnote == NULL || pnote->p_filesz > PAGE_SIZE)
2268 ASSERT_VOP_LOCKED(imgp->vp, "parse_notes");
2269 if (pnote->p_offset > PAGE_SIZE ||
2270 pnote->p_filesz > PAGE_SIZE - pnote->p_offset) {
2271 VOP_UNLOCK(imgp->vp, 0);
2272 buf = malloc(pnote->p_filesz, M_TEMP, M_WAITOK);
2273 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
2274 error = vn_rdwr(UIO_READ, imgp->vp, buf, pnote->p_filesz,
2275 pnote->p_offset, UIO_SYSSPACE, IO_NODELOCKED,
2276 curthread->td_ucred, NOCRED, NULL, curthread);
2278 uprintf("i/o error PT_NOTE\n");
2282 note = note0 = (const Elf_Note *)buf;
2283 note_end = (const Elf_Note *)(buf + pnote->p_filesz);
2285 note = note0 = (const Elf_Note *)(imgp->image_header +
2287 note_end = (const Elf_Note *)(imgp->image_header +
2288 pnote->p_offset + pnote->p_filesz);
2291 for (i = 0; i < 100 && note >= note0 && note < note_end; i++) {
2292 if (!aligned(note, Elf32_Addr) || (const char *)note_end -
2293 (const char *)note < sizeof(Elf_Note)) {
2297 if (note->n_namesz != checknote->hdr.n_namesz ||
2298 note->n_descsz != checknote->hdr.n_descsz ||
2299 note->n_type != checknote->hdr.n_type)
2301 note_name = (const char *)(note + 1);
2302 if (note_name + checknote->hdr.n_namesz >=
2303 (const char *)note_end || strncmp(checknote->vendor,
2304 note_name, checknote->hdr.n_namesz) != 0)
2308 * Fetch the osreldate for binary
2309 * from the ELF OSABI-note if necessary.
2311 if ((checknote->flags & BN_TRANSLATE_OSREL) != 0 &&
2312 checknote->trans_osrel != NULL) {
2313 res = checknote->trans_osrel(note, osrel);
2319 note = (const Elf_Note *)((const char *)(note + 1) +
2320 roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE) +
2321 roundup2(note->n_descsz, ELF_NOTE_ROUNDSIZE));
2330 * Try to find the appropriate ABI-note section for checknote,
2331 * fetch the osreldate for binary from the ELF OSABI-note. Only the
2332 * first page of the image is searched, the same as for headers.
2335 __elfN(check_note)(struct image_params *imgp, Elf_Brandnote *checknote,
2338 const Elf_Phdr *phdr;
2339 const Elf_Ehdr *hdr;
2342 hdr = (const Elf_Ehdr *)imgp->image_header;
2343 phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
2345 for (i = 0; i < hdr->e_phnum; i++) {
2346 if (phdr[i].p_type == PT_NOTE &&
2347 __elfN(parse_notes)(imgp, checknote, osrel, &phdr[i]))
2355 * Tell kern_execve.c about it, with a little help from the linker.
2357 static struct execsw __elfN(execsw) = {
2358 __CONCAT(exec_, __elfN(imgact)),
2359 __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE))
2361 EXEC_SET(__CONCAT(elf, __ELF_WORD_SIZE), __elfN(execsw));
2364 __elfN(trans_prot)(Elf_Word flags)
2370 prot |= VM_PROT_EXECUTE;
2372 prot |= VM_PROT_WRITE;
2374 prot |= VM_PROT_READ;
2375 #if __ELF_WORD_SIZE == 32
2376 #if defined(__amd64__)
2377 if (i386_read_exec && (flags & PF_R))
2378 prot |= VM_PROT_EXECUTE;
2385 __elfN(untrans_prot)(vm_prot_t prot)
2390 if (prot & VM_PROT_EXECUTE)
2392 if (prot & VM_PROT_READ)
2394 if (prot & VM_PROT_WRITE)