]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/kern/imgact_elf.c
MFC r315157:
[FreeBSD/FreeBSD.git] / sys / kern / imgact_elf.c
1 /*-
2  * Copyright (c) 2000 David O'Brien
3  * Copyright (c) 1995-1996 Søren Schmidt
4  * Copyright (c) 1996 Peter Wemm
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer
12  *    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
18  *
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.
29  */
30
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33
34 #include "opt_capsicum.h"
35 #include "opt_compat.h"
36 #include "opt_gzio.h"
37
38 #include <sys/param.h>
39 #include <sys/capsicum.h>
40 #include <sys/exec.h>
41 #include <sys/fcntl.h>
42 #include <sys/gzio.h>
43 #include <sys/imgact.h>
44 #include <sys/imgact_elf.h>
45 #include <sys/jail.h>
46 #include <sys/kernel.h>
47 #include <sys/lock.h>
48 #include <sys/malloc.h>
49 #include <sys/mount.h>
50 #include <sys/mman.h>
51 #include <sys/namei.h>
52 #include <sys/pioctl.h>
53 #include <sys/proc.h>
54 #include <sys/procfs.h>
55 #include <sys/racct.h>
56 #include <sys/resourcevar.h>
57 #include <sys/rwlock.h>
58 #include <sys/sbuf.h>
59 #include <sys/sf_buf.h>
60 #include <sys/smp.h>
61 #include <sys/systm.h>
62 #include <sys/signalvar.h>
63 #include <sys/stat.h>
64 #include <sys/sx.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>
71 #include <sys/user.h>
72
73 #include <vm/vm.h>
74 #include <vm/vm_kern.h>
75 #include <vm/vm_param.h>
76 #include <vm/pmap.h>
77 #include <vm/vm_map.h>
78 #include <vm/vm_object.h>
79 #include <vm/vm_extern.h>
80
81 #include <machine/elf.h>
82 #include <machine/md_var.h>
83
84 #define ELF_NOTE_ROUNDSIZE      4
85 #define OLD_EI_BRAND    8
86
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,
94     size_t pagesize);
95 static int __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp);
96 static boolean_t __elfN(freebsd_trans_osrel)(const Elf_Note *note,
97     int32_t *osrel);
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);
103
104 SYSCTL_NODE(_kern, OID_AUTO, __CONCAT(elf, __ELF_WORD_SIZE), CTLFLAG_RW, 0,
105     "");
106
107 #define CORE_BUF_SIZE   (16 * 1024)
108
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");
113
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");
118
119 int __elfN(nxstack) =
120 #if defined(__amd64__) || defined(__powerpc64__) /* both 64 and 32 bit */ || \
121     (defined(__arm__) && __ARM_ARCH >= 7) || defined(__aarch64__)
122         1;
123 #else
124         0;
125 #endif
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");
129
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");
135 #endif
136 #endif
137
138 static Elf_Brandinfo *elf_brand_list[MAX_BRANDS];
139
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))
143
144 static const char FREEBSD_ABI_VENDOR[] = "FreeBSD";
145
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)
153 };
154
155 static boolean_t
156 __elfN(freebsd_trans_osrel)(const Elf_Note *note, int32_t *osrel)
157 {
158         uintptr_t p;
159
160         p = (uintptr_t)(note + 1);
161         p += roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE);
162         *osrel = *(const int32_t *)(p);
163
164         return (TRUE);
165 }
166
167 static const char GNU_ABI_VENDOR[] = "GNU";
168 static int GNU_KFREEBSD_ABI_DESC = 3;
169
170 Elf_Brandnote __elfN(kfreebsd_brandnote) = {
171         .hdr.n_namesz   = sizeof(GNU_ABI_VENDOR),
172         .hdr.n_descsz   = 16,   /* XXX at least 16 */
173         .hdr.n_type     = 1,
174         .vendor         = GNU_ABI_VENDOR,
175         .flags          = BN_TRANSLATE_OSREL,
176         .trans_osrel    = kfreebsd_trans_osrel
177 };
178
179 static boolean_t
180 kfreebsd_trans_osrel(const Elf_Note *note, int32_t *osrel)
181 {
182         const Elf32_Word *desc;
183         uintptr_t p;
184
185         p = (uintptr_t)(note + 1);
186         p += roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE);
187
188         desc = (const Elf32_Word *)p;
189         if (desc[0] != GNU_KFREEBSD_ABI_DESC)
190                 return (FALSE);
191
192         /*
193          * Debian GNU/kFreeBSD embed the earliest compatible kernel version
194          * (__FreeBSD_version: <major><two digit minor>Rxx) in the LSB way.
195          */
196         *osrel = desc[1] * 100000 + desc[2] * 1000 + desc[3];
197
198         return (TRUE);
199 }
200
201 int
202 __elfN(insert_brand_entry)(Elf_Brandinfo *entry)
203 {
204         int i;
205
206         for (i = 0; i < MAX_BRANDS; i++) {
207                 if (elf_brand_list[i] == NULL) {
208                         elf_brand_list[i] = entry;
209                         break;
210                 }
211         }
212         if (i == MAX_BRANDS) {
213                 printf("WARNING: %s: could not insert brandinfo entry: %p\n",
214                         __func__, entry);
215                 return (-1);
216         }
217         return (0);
218 }
219
220 int
221 __elfN(remove_brand_entry)(Elf_Brandinfo *entry)
222 {
223         int i;
224
225         for (i = 0; i < MAX_BRANDS; i++) {
226                 if (elf_brand_list[i] == entry) {
227                         elf_brand_list[i] = NULL;
228                         break;
229                 }
230         }
231         if (i == MAX_BRANDS)
232                 return (-1);
233         return (0);
234 }
235
236 int
237 __elfN(brand_inuse)(Elf_Brandinfo *entry)
238 {
239         struct proc *p;
240         int rval = FALSE;
241
242         sx_slock(&allproc_lock);
243         FOREACH_PROC_IN_SYSTEM(p) {
244                 if (p->p_sysent == entry->sysvec) {
245                         rval = TRUE;
246                         break;
247                 }
248         }
249         sx_sunlock(&allproc_lock);
250
251         return (rval);
252 }
253
254 static Elf_Brandinfo *
255 __elfN(get_brandinfo)(struct image_params *imgp, const char *interp,
256     int interp_name_len, int32_t *osrel)
257 {
258         const Elf_Ehdr *hdr = (const Elf_Ehdr *)imgp->image_header;
259         Elf_Brandinfo *bi, *bi_m;
260         boolean_t ret;
261         int i;
262
263         /*
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.
268          */
269
270         /* Look for an ".note.ABI-tag" ELF section */
271         bi_m = NULL;
272         for (i = 0; i < MAX_BRANDS; i++) {
273                 bi = elf_brand_list[i];
274                 if (bi == NULL)
275                         continue;
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);
282                         /*
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.
291                          */
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)) {
295                                 bi_m = bi;
296                                 ret = 0;
297                         }
298                         if (ret)
299                                 return (bi);
300                 }
301         }
302         if (bi_m != NULL)
303                 return (bi_m);
304
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)
309                         continue;
310                 if (hdr->e_machine == bi->machine &&
311                     (hdr->e_ident[EI_OSABI] == bi->brand ||
312                     strcmp((const char *)&hdr->e_ident[OLD_EI_BRAND],
313                     bi->compat_3_brand) == 0)) {
314                         /* Looks good, but give brand a chance to veto */
315                         if (!bi->header_supported ||
316                             bi->header_supported(imgp)) {
317                                 /*
318                                  * Again, prefer strictly matching
319                                  * interpreter path.
320                                  */
321                                 if (strlen(bi->interp_path) + 1 ==
322                                     interp_name_len && strncmp(interp,
323                                     bi->interp_path, interp_name_len) == 0)
324                                         return (bi);
325                                 if (bi_m == NULL)
326                                         bi_m = bi;
327                         }
328                 }
329         }
330         if (bi_m != NULL)
331                 return (bi_m);
332
333         /* No known brand, see if the header is recognized by any brand */
334         for (i = 0; i < MAX_BRANDS; i++) {
335                 bi = elf_brand_list[i];
336                 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY ||
337                     bi->header_supported == NULL)
338                         continue;
339                 if (hdr->e_machine == bi->machine) {
340                         ret = bi->header_supported(imgp);
341                         if (ret)
342                                 return (bi);
343                 }
344         }
345
346         /* Lacking a known brand, search for a recognized interpreter. */
347         if (interp != NULL) {
348                 for (i = 0; i < MAX_BRANDS; i++) {
349                         bi = elf_brand_list[i];
350                         if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY)
351                                 continue;
352                         if (hdr->e_machine == bi->machine &&
353                             /* ELF image p_filesz includes terminating zero */
354                             strlen(bi->interp_path) + 1 == interp_name_len &&
355                             strncmp(interp, bi->interp_path, interp_name_len)
356                             == 0)
357                                 return (bi);
358                 }
359         }
360
361         /* Lacking a recognized interpreter, try the default brand */
362         for (i = 0; i < MAX_BRANDS; i++) {
363                 bi = elf_brand_list[i];
364                 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY)
365                         continue;
366                 if (hdr->e_machine == bi->machine &&
367                     __elfN(fallback_brand) == bi->brand)
368                         return (bi);
369         }
370         return (NULL);
371 }
372
373 static int
374 __elfN(check_header)(const Elf_Ehdr *hdr)
375 {
376         Elf_Brandinfo *bi;
377         int i;
378
379         if (!IS_ELF(*hdr) ||
380             hdr->e_ident[EI_CLASS] != ELF_TARG_CLASS ||
381             hdr->e_ident[EI_DATA] != ELF_TARG_DATA ||
382             hdr->e_ident[EI_VERSION] != EV_CURRENT ||
383             hdr->e_phentsize != sizeof(Elf_Phdr) ||
384             hdr->e_version != ELF_TARG_VER)
385                 return (ENOEXEC);
386
387         /*
388          * Make sure we have at least one brand for this machine.
389          */
390
391         for (i = 0; i < MAX_BRANDS; i++) {
392                 bi = elf_brand_list[i];
393                 if (bi != NULL && bi->machine == hdr->e_machine)
394                         break;
395         }
396         if (i == MAX_BRANDS)
397                 return (ENOEXEC);
398
399         return (0);
400 }
401
402 static int
403 __elfN(map_partial)(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
404     vm_offset_t start, vm_offset_t end, vm_prot_t prot)
405 {
406         struct sf_buf *sf;
407         int error;
408         vm_offset_t off;
409
410         /*
411          * Create the page if it doesn't exist yet. Ignore errors.
412          */
413         vm_map_fixed(map, NULL, 0, trunc_page(start), round_page(end) -
414             trunc_page(start), VM_PROT_ALL, VM_PROT_ALL, MAP_CHECK_EXCL);
415
416         /*
417          * Find the page from the underlying object.
418          */
419         if (object != NULL) {
420                 sf = vm_imgact_map_page(object, offset);
421                 if (sf == NULL)
422                         return (KERN_FAILURE);
423                 off = offset - trunc_page(offset);
424                 error = copyout((caddr_t)sf_buf_kva(sf) + off, (caddr_t)start,
425                     end - start);
426                 vm_imgact_unmap_page(sf);
427                 if (error != 0)
428                         return (KERN_FAILURE);
429         }
430
431         return (KERN_SUCCESS);
432 }
433
434 static int
435 __elfN(map_insert)(struct image_params *imgp, vm_map_t map, vm_object_t object,
436     vm_ooffset_t offset, vm_offset_t start, vm_offset_t end, vm_prot_t prot,
437     int cow)
438 {
439         struct sf_buf *sf;
440         vm_offset_t off;
441         vm_size_t sz;
442         int error, locked, rv;
443
444         if (start != trunc_page(start)) {
445                 rv = __elfN(map_partial)(map, object, offset, start,
446                     round_page(start), prot);
447                 if (rv != KERN_SUCCESS)
448                         return (rv);
449                 offset += round_page(start) - start;
450                 start = round_page(start);
451         }
452         if (end != round_page(end)) {
453                 rv = __elfN(map_partial)(map, object, offset +
454                     trunc_page(end) - start, trunc_page(end), end, prot);
455                 if (rv != KERN_SUCCESS)
456                         return (rv);
457                 end = trunc_page(end);
458         }
459         if (start >= end)
460                 return (KERN_SUCCESS);
461         if ((offset & PAGE_MASK) != 0) {
462                 /*
463                  * The mapping is not page aligned.  This means that we have
464                  * to copy the data.
465                  */
466                 rv = vm_map_fixed(map, NULL, 0, start, end - start,
467                     prot | VM_PROT_WRITE, VM_PROT_ALL, MAP_CHECK_EXCL);
468                 if (rv != KERN_SUCCESS)
469                         return (rv);
470                 if (object == NULL)
471                         return (KERN_SUCCESS);
472                 for (; start < end; start += sz) {
473                         sf = vm_imgact_map_page(object, offset);
474                         if (sf == NULL)
475                                 return (KERN_FAILURE);
476                         off = offset - trunc_page(offset);
477                         sz = end - start;
478                         if (sz > PAGE_SIZE - off)
479                                 sz = PAGE_SIZE - off;
480                         error = copyout((caddr_t)sf_buf_kva(sf) + off,
481                             (caddr_t)start, sz);
482                         vm_imgact_unmap_page(sf);
483                         if (error != 0)
484                                 return (KERN_FAILURE);
485                         offset += sz;
486                 }
487         } else {
488                 vm_object_reference(object);
489                 rv = vm_map_fixed(map, object, offset, start, end - start,
490                     prot, VM_PROT_ALL, cow | MAP_CHECK_EXCL);
491                 if (rv != KERN_SUCCESS) {
492                         locked = VOP_ISLOCKED(imgp->vp);
493                         VOP_UNLOCK(imgp->vp, 0);
494                         vm_object_deallocate(object);
495                         vn_lock(imgp->vp, locked | LK_RETRY);
496                         return (rv);
497                 }
498         }
499         return (KERN_SUCCESS);
500 }
501
502 static int
503 __elfN(load_section)(struct image_params *imgp, vm_ooffset_t offset,
504     caddr_t vmaddr, size_t memsz, size_t filsz, vm_prot_t prot,
505     size_t pagesize)
506 {
507         struct sf_buf *sf;
508         size_t map_len;
509         vm_map_t map;
510         vm_object_t object;
511         vm_offset_t off, map_addr;
512         int error, rv, cow;
513         size_t copy_len;
514         vm_ooffset_t file_addr;
515
516         /*
517          * It's necessary to fail if the filsz + offset taken from the
518          * header is greater than the actual file pager object's size.
519          * If we were to allow this, then the vm_map_find() below would
520          * walk right off the end of the file object and into the ether.
521          *
522          * While I'm here, might as well check for something else that
523          * is invalid: filsz cannot be greater than memsz.
524          */
525         if ((filsz != 0 && (off_t)filsz + offset > imgp->attr->va_size) ||
526             filsz > memsz) {
527                 uprintf("elf_load_section: truncated ELF file\n");
528                 return (ENOEXEC);
529         }
530
531         object = imgp->object;
532         map = &imgp->proc->p_vmspace->vm_map;
533         map_addr = trunc_page_ps((vm_offset_t)vmaddr, pagesize);
534         file_addr = trunc_page_ps(offset, pagesize);
535
536         /*
537          * We have two choices.  We can either clear the data in the last page
538          * of an oversized mapping, or we can start the anon mapping a page
539          * early and copy the initialized data into that first page.  We
540          * choose the second.
541          */
542         if (filsz == 0)
543                 map_len = 0;
544         else if (memsz > filsz)
545                 map_len = trunc_page_ps(offset + filsz, pagesize) - file_addr;
546         else
547                 map_len = round_page_ps(offset + filsz, pagesize) - file_addr;
548
549         if (map_len != 0) {
550                 /* cow flags: don't dump readonly sections in core */
551                 cow = MAP_COPY_ON_WRITE | MAP_PREFAULT |
552                     (prot & VM_PROT_WRITE ? 0 : MAP_DISABLE_COREDUMP);
553
554                 rv = __elfN(map_insert)(imgp, map,
555                                       object,
556                                       file_addr,        /* file offset */
557                                       map_addr,         /* virtual start */
558                                       map_addr + map_len,/* virtual end */
559                                       prot,
560                                       cow);
561                 if (rv != KERN_SUCCESS)
562                         return (EINVAL);
563
564                 /* we can stop now if we've covered it all */
565                 if (memsz == filsz)
566                         return (0);
567         }
568
569
570         /*
571          * We have to get the remaining bit of the file into the first part
572          * of the oversized map segment.  This is normally because the .data
573          * segment in the file is extended to provide bss.  It's a neat idea
574          * to try and save a page, but it's a pain in the behind to implement.
575          */
576         copy_len = filsz == 0 ? 0 : (offset + filsz) - trunc_page_ps(offset +
577             filsz, pagesize);
578         map_addr = trunc_page_ps((vm_offset_t)vmaddr + filsz, pagesize);
579         map_len = round_page_ps((vm_offset_t)vmaddr + memsz, pagesize) -
580             map_addr;
581
582         /* This had damn well better be true! */
583         if (map_len != 0) {
584                 rv = __elfN(map_insert)(imgp, map, NULL, 0, map_addr,
585                     map_addr + map_len, VM_PROT_ALL, 0);
586                 if (rv != KERN_SUCCESS)
587                         return (EINVAL);
588         }
589
590         if (copy_len != 0) {
591                 sf = vm_imgact_map_page(object, offset + filsz);
592                 if (sf == NULL)
593                         return (EIO);
594
595                 /* send the page fragment to user space */
596                 off = trunc_page_ps(offset + filsz, pagesize) -
597                     trunc_page(offset + filsz);
598                 error = copyout((caddr_t)sf_buf_kva(sf) + off,
599                     (caddr_t)map_addr, copy_len);
600                 vm_imgact_unmap_page(sf);
601                 if (error != 0)
602                         return (error);
603         }
604
605         /*
606          * set it to the specified protection.
607          */
608         vm_map_protect(map, trunc_page(map_addr), round_page(map_addr +
609             map_len), prot, FALSE);
610
611         return (0);
612 }
613
614 /*
615  * Load the file "file" into memory.  It may be either a shared object
616  * or an executable.
617  *
618  * The "addr" reference parameter is in/out.  On entry, it specifies
619  * the address where a shared object should be loaded.  If the file is
620  * an executable, this value is ignored.  On exit, "addr" specifies
621  * where the file was actually loaded.
622  *
623  * The "entry" reference parameter is out only.  On exit, it specifies
624  * the entry point for the loaded file.
625  */
626 static int
627 __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
628         u_long *entry, size_t pagesize)
629 {
630         struct {
631                 struct nameidata nd;
632                 struct vattr attr;
633                 struct image_params image_params;
634         } *tempdata;
635         const Elf_Ehdr *hdr = NULL;
636         const Elf_Phdr *phdr = NULL;
637         struct nameidata *nd;
638         struct vattr *attr;
639         struct image_params *imgp;
640         vm_prot_t prot;
641         u_long rbase;
642         u_long base_addr = 0;
643         int error, i, numsegs;
644
645 #ifdef CAPABILITY_MODE
646         /*
647          * XXXJA: This check can go away once we are sufficiently confident
648          * that the checks in namei() are correct.
649          */
650         if (IN_CAPABILITY_MODE(curthread))
651                 return (ECAPMODE);
652 #endif
653
654         tempdata = malloc(sizeof(*tempdata), M_TEMP, M_WAITOK);
655         nd = &tempdata->nd;
656         attr = &tempdata->attr;
657         imgp = &tempdata->image_params;
658
659         /*
660          * Initialize part of the common data
661          */
662         imgp->proc = p;
663         imgp->attr = attr;
664         imgp->firstpage = NULL;
665         imgp->image_header = NULL;
666         imgp->object = NULL;
667         imgp->execlabel = NULL;
668
669         NDINIT(nd, LOOKUP, LOCKLEAF | FOLLOW, UIO_SYSSPACE, file, curthread);
670         if ((error = namei(nd)) != 0) {
671                 nd->ni_vp = NULL;
672                 goto fail;
673         }
674         NDFREE(nd, NDF_ONLY_PNBUF);
675         imgp->vp = nd->ni_vp;
676
677         /*
678          * Check permissions, modes, uid, etc on the file, and "open" it.
679          */
680         error = exec_check_permissions(imgp);
681         if (error)
682                 goto fail;
683
684         error = exec_map_first_page(imgp);
685         if (error)
686                 goto fail;
687
688         /*
689          * Also make certain that the interpreter stays the same, so set
690          * its VV_TEXT flag, too.
691          */
692         VOP_SET_TEXT(nd->ni_vp);
693
694         imgp->object = nd->ni_vp->v_object;
695
696         hdr = (const Elf_Ehdr *)imgp->image_header;
697         if ((error = __elfN(check_header)(hdr)) != 0)
698                 goto fail;
699         if (hdr->e_type == ET_DYN)
700                 rbase = *addr;
701         else if (hdr->e_type == ET_EXEC)
702                 rbase = 0;
703         else {
704                 error = ENOEXEC;
705                 goto fail;
706         }
707
708         /* Only support headers that fit within first page for now      */
709         if ((hdr->e_phoff > PAGE_SIZE) ||
710             (u_int)hdr->e_phentsize * hdr->e_phnum > PAGE_SIZE - hdr->e_phoff) {
711                 error = ENOEXEC;
712                 goto fail;
713         }
714
715         phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
716         if (!aligned(phdr, Elf_Addr)) {
717                 error = ENOEXEC;
718                 goto fail;
719         }
720
721         for (i = 0, numsegs = 0; i < hdr->e_phnum; i++) {
722                 if (phdr[i].p_type == PT_LOAD && phdr[i].p_memsz != 0) {
723                         /* Loadable segment */
724                         prot = __elfN(trans_prot)(phdr[i].p_flags);
725                         error = __elfN(load_section)(imgp, phdr[i].p_offset,
726                             (caddr_t)(uintptr_t)phdr[i].p_vaddr + rbase,
727                             phdr[i].p_memsz, phdr[i].p_filesz, prot, pagesize);
728                         if (error != 0)
729                                 goto fail;
730                         /*
731                          * Establish the base address if this is the
732                          * first segment.
733                          */
734                         if (numsegs == 0)
735                                 base_addr = trunc_page(phdr[i].p_vaddr +
736                                     rbase);
737                         numsegs++;
738                 }
739         }
740         *addr = base_addr;
741         *entry = (unsigned long)hdr->e_entry + rbase;
742
743 fail:
744         if (imgp->firstpage)
745                 exec_unmap_first_page(imgp);
746
747         if (nd->ni_vp)
748                 vput(nd->ni_vp);
749
750         free(tempdata, M_TEMP);
751
752         return (error);
753 }
754
755 static int
756 __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp)
757 {
758         struct thread *td;
759         const Elf_Ehdr *hdr;
760         const Elf_Phdr *phdr;
761         Elf_Auxargs *elf_auxargs;
762         struct vmspace *vmspace;
763         const char *err_str, *newinterp;
764         char *interp, *interp_buf, *path;
765         Elf_Brandinfo *brand_info;
766         struct sysentvec *sv;
767         vm_prot_t prot;
768         u_long text_size, data_size, total_size, text_addr, data_addr;
769         u_long seg_size, seg_addr, addr, baddr, et_dyn_addr, entry, proghdr;
770         int32_t osrel;
771         int error, i, n, interp_name_len, have_interp;
772
773         hdr = (const Elf_Ehdr *)imgp->image_header;
774
775         /*
776          * Do we have a valid ELF header ?
777          *
778          * Only allow ET_EXEC & ET_DYN here, reject ET_DYN later
779          * if particular brand doesn't support it.
780          */
781         if (__elfN(check_header)(hdr) != 0 ||
782             (hdr->e_type != ET_EXEC && hdr->e_type != ET_DYN))
783                 return (-1);
784
785         /*
786          * From here on down, we return an errno, not -1, as we've
787          * detected an ELF file.
788          */
789
790         if ((hdr->e_phoff > PAGE_SIZE) ||
791             (u_int)hdr->e_phentsize * hdr->e_phnum > PAGE_SIZE - hdr->e_phoff) {
792                 /* Only support headers in first page for now */
793                 uprintf("Program headers not in the first page\n");
794                 return (ENOEXEC);
795         }
796         phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff); 
797         if (!aligned(phdr, Elf_Addr)) {
798                 uprintf("Unaligned program headers\n");
799                 return (ENOEXEC);
800         }
801
802         n = error = 0;
803         baddr = 0;
804         osrel = 0;
805         text_size = data_size = total_size = text_addr = data_addr = 0;
806         entry = proghdr = 0;
807         interp_name_len = 0;
808         err_str = newinterp = NULL;
809         interp = interp_buf = NULL;
810         td = curthread;
811
812         for (i = 0; i < hdr->e_phnum; i++) {
813                 switch (phdr[i].p_type) {
814                 case PT_LOAD:
815                         if (n == 0)
816                                 baddr = phdr[i].p_vaddr;
817                         n++;
818                         break;
819                 case PT_INTERP:
820                         /* Path to interpreter */
821                         if (phdr[i].p_filesz > MAXPATHLEN) {
822                                 uprintf("Invalid PT_INTERP\n");
823                                 error = ENOEXEC;
824                                 goto ret;
825                         }
826                         if (interp != NULL) {
827                                 uprintf("Multiple PT_INTERP headers\n");
828                                 error = ENOEXEC;
829                                 goto ret;
830                         }
831                         interp_name_len = phdr[i].p_filesz;
832                         if (phdr[i].p_offset > PAGE_SIZE ||
833                             interp_name_len > PAGE_SIZE - phdr[i].p_offset) {
834                                 VOP_UNLOCK(imgp->vp, 0);
835                                 interp_buf = malloc(interp_name_len + 1, M_TEMP,
836                                     M_WAITOK);
837                                 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
838                                 error = vn_rdwr(UIO_READ, imgp->vp, interp_buf,
839                                     interp_name_len, phdr[i].p_offset,
840                                     UIO_SYSSPACE, IO_NODELOCKED, td->td_ucred,
841                                     NOCRED, NULL, td);
842                                 if (error != 0) {
843                                         uprintf("i/o error PT_INTERP\n");
844                                         goto ret;
845                                 }
846                                 interp_buf[interp_name_len] = '\0';
847                                 interp = interp_buf;
848                         } else {
849                                 interp = __DECONST(char *, imgp->image_header) +
850                                     phdr[i].p_offset;
851                         }
852                         break;
853                 case PT_GNU_STACK:
854                         if (__elfN(nxstack))
855                                 imgp->stack_prot =
856                                     __elfN(trans_prot)(phdr[i].p_flags);
857                         imgp->stack_sz = phdr[i].p_memsz;
858                         break;
859                 }
860         }
861
862         brand_info = __elfN(get_brandinfo)(imgp, interp, interp_name_len,
863             &osrel);
864         if (brand_info == NULL) {
865                 uprintf("ELF binary type \"%u\" not known.\n",
866                     hdr->e_ident[EI_OSABI]);
867                 error = ENOEXEC;
868                 goto ret;
869         }
870         if (hdr->e_type == ET_DYN) {
871                 if ((brand_info->flags & BI_CAN_EXEC_DYN) == 0) {
872                         uprintf("Cannot execute shared object\n");
873                         error = ENOEXEC;
874                         goto ret;
875                 }
876                 /*
877                  * Honour the base load address from the dso if it is
878                  * non-zero for some reason.
879                  */
880                 if (baddr == 0)
881                         et_dyn_addr = ET_DYN_LOAD_ADDR;
882                 else
883                         et_dyn_addr = 0;
884         } else
885                 et_dyn_addr = 0;
886         sv = brand_info->sysvec;
887         if (interp != NULL && brand_info->interp_newpath != NULL)
888                 newinterp = brand_info->interp_newpath;
889
890         /*
891          * Avoid a possible deadlock if the current address space is destroyed
892          * and that address space maps the locked vnode.  In the common case,
893          * the locked vnode's v_usecount is decremented but remains greater
894          * than zero.  Consequently, the vnode lock is not needed by vrele().
895          * However, in cases where the vnode lock is external, such as nullfs,
896          * v_usecount may become zero.
897          *
898          * The VV_TEXT flag prevents modifications to the executable while
899          * the vnode is unlocked.
900          */
901         VOP_UNLOCK(imgp->vp, 0);
902
903         error = exec_new_vmspace(imgp, sv);
904         imgp->proc->p_sysent = sv;
905
906         vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
907         if (error != 0)
908                 goto ret;
909
910         for (i = 0; i < hdr->e_phnum; i++) {
911                 switch (phdr[i].p_type) {
912                 case PT_LOAD:   /* Loadable segment */
913                         if (phdr[i].p_memsz == 0)
914                                 break;
915                         prot = __elfN(trans_prot)(phdr[i].p_flags);
916                         error = __elfN(load_section)(imgp, phdr[i].p_offset,
917                             (caddr_t)(uintptr_t)phdr[i].p_vaddr + et_dyn_addr,
918                             phdr[i].p_memsz, phdr[i].p_filesz, prot,
919                             sv->sv_pagesize);
920                         if (error != 0)
921                                 goto ret;
922
923                         /*
924                          * If this segment contains the program headers,
925                          * remember their virtual address for the AT_PHDR
926                          * aux entry. Static binaries don't usually include
927                          * a PT_PHDR entry.
928                          */
929                         if (phdr[i].p_offset == 0 &&
930                             hdr->e_phoff + hdr->e_phnum * hdr->e_phentsize
931                                 <= phdr[i].p_filesz)
932                                 proghdr = phdr[i].p_vaddr + hdr->e_phoff +
933                                     et_dyn_addr;
934
935                         seg_addr = trunc_page(phdr[i].p_vaddr + et_dyn_addr);
936                         seg_size = round_page(phdr[i].p_memsz +
937                             phdr[i].p_vaddr + et_dyn_addr - seg_addr);
938
939                         /*
940                          * Make the largest executable segment the official
941                          * text segment and all others data.
942                          *
943                          * Note that obreak() assumes that data_addr + 
944                          * data_size == end of data load area, and the ELF
945                          * file format expects segments to be sorted by
946                          * address.  If multiple data segments exist, the
947                          * last one will be used.
948                          */
949
950                         if (phdr[i].p_flags & PF_X && text_size < seg_size) {
951                                 text_size = seg_size;
952                                 text_addr = seg_addr;
953                         } else {
954                                 data_size = seg_size;
955                                 data_addr = seg_addr;
956                         }
957                         total_size += seg_size;
958                         break;
959                 case PT_PHDR:   /* Program header table info */
960                         proghdr = phdr[i].p_vaddr + et_dyn_addr;
961                         break;
962                 default:
963                         break;
964                 }
965         }
966         
967         if (data_addr == 0 && data_size == 0) {
968                 data_addr = text_addr;
969                 data_size = text_size;
970         }
971
972         entry = (u_long)hdr->e_entry + et_dyn_addr;
973
974         /*
975          * Check limits.  It should be safe to check the
976          * limits after loading the segments since we do
977          * not actually fault in all the segments pages.
978          */
979         PROC_LOCK(imgp->proc);
980         if (data_size > lim_cur_proc(imgp->proc, RLIMIT_DATA))
981                 err_str = "Data segment size exceeds process limit";
982         else if (text_size > maxtsiz)
983                 err_str = "Text segment size exceeds system limit";
984         else if (total_size > lim_cur_proc(imgp->proc, RLIMIT_VMEM))
985                 err_str = "Total segment size exceeds process limit";
986         else if (racct_set(imgp->proc, RACCT_DATA, data_size) != 0)
987                 err_str = "Data segment size exceeds resource limit";
988         else if (racct_set(imgp->proc, RACCT_VMEM, total_size) != 0)
989                 err_str = "Total segment size exceeds resource limit";
990         if (err_str != NULL) {
991                 PROC_UNLOCK(imgp->proc);
992                 uprintf("%s\n", err_str);
993                 error = ENOMEM;
994                 goto ret;
995         }
996
997         vmspace = imgp->proc->p_vmspace;
998         vmspace->vm_tsize = text_size >> PAGE_SHIFT;
999         vmspace->vm_taddr = (caddr_t)(uintptr_t)text_addr;
1000         vmspace->vm_dsize = data_size >> PAGE_SHIFT;
1001         vmspace->vm_daddr = (caddr_t)(uintptr_t)data_addr;
1002
1003         /*
1004          * We load the dynamic linker where a userland call
1005          * to mmap(0, ...) would put it.  The rationale behind this
1006          * calculation is that it leaves room for the heap to grow to
1007          * its maximum allowed size.
1008          */
1009         addr = round_page((vm_offset_t)vmspace->vm_daddr + lim_max(td,
1010             RLIMIT_DATA));
1011         PROC_UNLOCK(imgp->proc);
1012
1013         imgp->entry_addr = entry;
1014
1015         if (interp != NULL) {
1016                 have_interp = FALSE;
1017                 VOP_UNLOCK(imgp->vp, 0);
1018                 if (brand_info->emul_path != NULL &&
1019                     brand_info->emul_path[0] != '\0') {
1020                         path = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1021                         snprintf(path, MAXPATHLEN, "%s%s",
1022                             brand_info->emul_path, interp);
1023                         error = __elfN(load_file)(imgp->proc, path, &addr,
1024                             &imgp->entry_addr, sv->sv_pagesize);
1025                         free(path, M_TEMP);
1026                         if (error == 0)
1027                                 have_interp = TRUE;
1028                 }
1029                 if (!have_interp && newinterp != NULL &&
1030                     (brand_info->interp_path == NULL ||
1031                     strcmp(interp, brand_info->interp_path) == 0)) {
1032                         error = __elfN(load_file)(imgp->proc, newinterp, &addr,
1033                             &imgp->entry_addr, sv->sv_pagesize);
1034                         if (error == 0)
1035                                 have_interp = TRUE;
1036                 }
1037                 if (!have_interp) {
1038                         error = __elfN(load_file)(imgp->proc, interp, &addr,
1039                             &imgp->entry_addr, sv->sv_pagesize);
1040                 }
1041                 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
1042                 if (error != 0) {
1043                         uprintf("ELF interpreter %s not found, error %d\n",
1044                             interp, error);
1045                         goto ret;
1046                 }
1047         } else
1048                 addr = et_dyn_addr;
1049
1050         /*
1051          * Construct auxargs table (used by the fixup routine)
1052          */
1053         elf_auxargs = malloc(sizeof(Elf_Auxargs), M_TEMP, M_WAITOK);
1054         elf_auxargs->execfd = -1;
1055         elf_auxargs->phdr = proghdr;
1056         elf_auxargs->phent = hdr->e_phentsize;
1057         elf_auxargs->phnum = hdr->e_phnum;
1058         elf_auxargs->pagesz = PAGE_SIZE;
1059         elf_auxargs->base = addr;
1060         elf_auxargs->flags = 0;
1061         elf_auxargs->entry = entry;
1062         elf_auxargs->hdr_eflags = hdr->e_flags;
1063
1064         imgp->auxargs = elf_auxargs;
1065         imgp->interpreted = 0;
1066         imgp->reloc_base = addr;
1067         imgp->proc->p_osrel = osrel;
1068
1069  ret:
1070         free(interp_buf, M_TEMP);
1071         return (error);
1072 }
1073
1074 #define suword __CONCAT(suword, __ELF_WORD_SIZE)
1075
1076 int
1077 __elfN(freebsd_fixup)(register_t **stack_base, struct image_params *imgp)
1078 {
1079         Elf_Auxargs *args = (Elf_Auxargs *)imgp->auxargs;
1080         Elf_Addr *base;
1081         Elf_Addr *pos;
1082
1083         base = (Elf_Addr *)*stack_base;
1084         pos = base + (imgp->args->argc + imgp->args->envc + 2);
1085
1086         if (args->execfd != -1)
1087                 AUXARGS_ENTRY(pos, AT_EXECFD, args->execfd);
1088         AUXARGS_ENTRY(pos, AT_PHDR, args->phdr);
1089         AUXARGS_ENTRY(pos, AT_PHENT, args->phent);
1090         AUXARGS_ENTRY(pos, AT_PHNUM, args->phnum);
1091         AUXARGS_ENTRY(pos, AT_PAGESZ, args->pagesz);
1092         AUXARGS_ENTRY(pos, AT_FLAGS, args->flags);
1093         AUXARGS_ENTRY(pos, AT_ENTRY, args->entry);
1094         AUXARGS_ENTRY(pos, AT_BASE, args->base);
1095 #ifdef AT_EHDRFLAGS
1096         AUXARGS_ENTRY(pos, AT_EHDRFLAGS, args->hdr_eflags);
1097 #endif
1098         if (imgp->execpathp != 0)
1099                 AUXARGS_ENTRY(pos, AT_EXECPATH, imgp->execpathp);
1100         AUXARGS_ENTRY(pos, AT_OSRELDATE,
1101             imgp->proc->p_ucred->cr_prison->pr_osreldate);
1102         if (imgp->canary != 0) {
1103                 AUXARGS_ENTRY(pos, AT_CANARY, imgp->canary);
1104                 AUXARGS_ENTRY(pos, AT_CANARYLEN, imgp->canarylen);
1105         }
1106         AUXARGS_ENTRY(pos, AT_NCPUS, mp_ncpus);
1107         if (imgp->pagesizes != 0) {
1108                 AUXARGS_ENTRY(pos, AT_PAGESIZES, imgp->pagesizes);
1109                 AUXARGS_ENTRY(pos, AT_PAGESIZESLEN, imgp->pagesizeslen);
1110         }
1111         if (imgp->sysent->sv_timekeep_base != 0) {
1112                 AUXARGS_ENTRY(pos, AT_TIMEKEEP,
1113                     imgp->sysent->sv_timekeep_base);
1114         }
1115         AUXARGS_ENTRY(pos, AT_STACKPROT, imgp->sysent->sv_shared_page_obj
1116             != NULL && imgp->stack_prot != 0 ? imgp->stack_prot :
1117             imgp->sysent->sv_stackprot);
1118         AUXARGS_ENTRY(pos, AT_NULL, 0);
1119
1120         free(imgp->auxargs, M_TEMP);
1121         imgp->auxargs = NULL;
1122
1123         base--;
1124         suword(base, (long)imgp->args->argc);
1125         *stack_base = (register_t *)base;
1126         return (0);
1127 }
1128
1129 /*
1130  * Code for generating ELF core dumps.
1131  */
1132
1133 typedef void (*segment_callback)(vm_map_entry_t, void *);
1134
1135 /* Closure for cb_put_phdr(). */
1136 struct phdr_closure {
1137         Elf_Phdr *phdr;         /* Program header to fill in */
1138         Elf_Off offset;         /* Offset of segment in core file */
1139 };
1140
1141 /* Closure for cb_size_segment(). */
1142 struct sseg_closure {
1143         int count;              /* Count of writable segments. */
1144         size_t size;            /* Total size of all writable segments. */
1145 };
1146
1147 typedef void (*outfunc_t)(void *, struct sbuf *, size_t *);
1148
1149 struct note_info {
1150         int             type;           /* Note type. */
1151         outfunc_t       outfunc;        /* Output function. */
1152         void            *outarg;        /* Argument for the output function. */
1153         size_t          outsize;        /* Output size. */
1154         TAILQ_ENTRY(note_info) link;    /* Link to the next note info. */
1155 };
1156
1157 TAILQ_HEAD(note_info_list, note_info);
1158
1159 /* Coredump output parameters. */
1160 struct coredump_params {
1161         off_t           offset;
1162         struct ucred    *active_cred;
1163         struct ucred    *file_cred;
1164         struct thread   *td;
1165         struct vnode    *vp;
1166         struct gzio_stream *gzs;
1167 };
1168
1169 static void cb_put_phdr(vm_map_entry_t, void *);
1170 static void cb_size_segment(vm_map_entry_t, void *);
1171 static int core_write(struct coredump_params *, const void *, size_t, off_t,
1172     enum uio_seg);
1173 static void each_writable_segment(struct thread *, segment_callback, void *);
1174 static int __elfN(corehdr)(struct coredump_params *, int, void *, size_t,
1175     struct note_info_list *, size_t);
1176 static void __elfN(prepare_notes)(struct thread *, struct note_info_list *,
1177     size_t *);
1178 static void __elfN(puthdr)(struct thread *, void *, size_t, int, size_t);
1179 static void __elfN(putnote)(struct note_info *, struct sbuf *);
1180 static size_t register_note(struct note_info_list *, int, outfunc_t, void *);
1181 static int sbuf_drain_core_output(void *, const char *, int);
1182 static int sbuf_drain_count(void *arg, const char *data, int len);
1183
1184 static void __elfN(note_fpregset)(void *, struct sbuf *, size_t *);
1185 static void __elfN(note_prpsinfo)(void *, struct sbuf *, size_t *);
1186 static void __elfN(note_prstatus)(void *, struct sbuf *, size_t *);
1187 static void __elfN(note_threadmd)(void *, struct sbuf *, size_t *);
1188 static void __elfN(note_thrmisc)(void *, struct sbuf *, size_t *);
1189 static void __elfN(note_procstat_auxv)(void *, struct sbuf *, size_t *);
1190 static void __elfN(note_procstat_proc)(void *, struct sbuf *, size_t *);
1191 static void __elfN(note_procstat_psstrings)(void *, struct sbuf *, size_t *);
1192 static void note_procstat_files(void *, struct sbuf *, size_t *);
1193 static void note_procstat_groups(void *, struct sbuf *, size_t *);
1194 static void note_procstat_osrel(void *, struct sbuf *, size_t *);
1195 static void note_procstat_rlimit(void *, struct sbuf *, size_t *);
1196 static void note_procstat_umask(void *, struct sbuf *, size_t *);
1197 static void note_procstat_vmmap(void *, struct sbuf *, size_t *);
1198
1199 #ifdef GZIO
1200 extern int compress_user_cores_gzlevel;
1201
1202 /*
1203  * Write out a core segment to the compression stream.
1204  */
1205 static int
1206 compress_chunk(struct coredump_params *p, char *base, char *buf, u_int len)
1207 {
1208         u_int chunk_len;
1209         int error;
1210
1211         while (len > 0) {
1212                 chunk_len = MIN(len, CORE_BUF_SIZE);
1213
1214                 /*
1215                  * We can get EFAULT error here.
1216                  * In that case zero out the current chunk of the segment.
1217                  */
1218                 error = copyin(base, buf, chunk_len);
1219                 if (error != 0)
1220                         bzero(buf, chunk_len);
1221                 error = gzio_write(p->gzs, buf, chunk_len);
1222                 if (error != 0)
1223                         break;
1224                 base += chunk_len;
1225                 len -= chunk_len;
1226         }
1227         return (error);
1228 }
1229
1230 static int
1231 core_gz_write(void *base, size_t len, off_t offset, void *arg)
1232 {
1233
1234         return (core_write((struct coredump_params *)arg, base, len, offset,
1235             UIO_SYSSPACE));
1236 }
1237 #endif /* GZIO */
1238
1239 static int
1240 core_write(struct coredump_params *p, const void *base, size_t len,
1241     off_t offset, enum uio_seg seg)
1242 {
1243
1244         return (vn_rdwr_inchunks(UIO_WRITE, p->vp, __DECONST(void *, base),
1245             len, offset, seg, IO_UNIT | IO_DIRECT | IO_RANGELOCKED,
1246             p->active_cred, p->file_cred, NULL, p->td));
1247 }
1248
1249 static int
1250 core_output(void *base, size_t len, off_t offset, struct coredump_params *p,
1251     void *tmpbuf)
1252 {
1253         int error;
1254
1255 #ifdef GZIO
1256         if (p->gzs != NULL)
1257                 return (compress_chunk(p, base, tmpbuf, len));
1258 #endif
1259         /*
1260          * EFAULT is a non-fatal error that we can get, for example,
1261          * if the segment is backed by a file but extends beyond its
1262          * end.
1263          */
1264         error = core_write(p, base, len, offset, UIO_USERSPACE);
1265         if (error == EFAULT) {
1266                 log(LOG_WARNING, "Failed to fully fault in a core file segment "
1267                     "at VA %p with size 0x%zx to be written at offset 0x%jx "
1268                     "for process %s\n", base, len, offset, curproc->p_comm);
1269
1270                 /*
1271                  * Write a "real" zero byte at the end of the target region
1272                  * in the case this is the last segment.
1273                  * The intermediate space will be implicitly zero-filled.
1274                  */
1275                 error = core_write(p, zero_region, 1, offset + len - 1,
1276                     UIO_SYSSPACE);
1277         }
1278         return (error);
1279 }
1280
1281 /*
1282  * Drain into a core file.
1283  */
1284 static int
1285 sbuf_drain_core_output(void *arg, const char *data, int len)
1286 {
1287         struct coredump_params *p;
1288         int error, locked;
1289
1290         p = (struct coredump_params *)arg;
1291
1292         /*
1293          * Some kern_proc out routines that print to this sbuf may
1294          * call us with the process lock held. Draining with the
1295          * non-sleepable lock held is unsafe. The lock is needed for
1296          * those routines when dumping a live process. In our case we
1297          * can safely release the lock before draining and acquire
1298          * again after.
1299          */
1300         locked = PROC_LOCKED(p->td->td_proc);
1301         if (locked)
1302                 PROC_UNLOCK(p->td->td_proc);
1303 #ifdef GZIO
1304         if (p->gzs != NULL)
1305                 error = gzio_write(p->gzs, __DECONST(char *, data), len);
1306         else
1307 #endif
1308                 error = core_write(p, __DECONST(void *, data), len, p->offset,
1309                     UIO_SYSSPACE);
1310         if (locked)
1311                 PROC_LOCK(p->td->td_proc);
1312         if (error != 0)
1313                 return (-error);
1314         p->offset += len;
1315         return (len);
1316 }
1317
1318 /*
1319  * Drain into a counter.
1320  */
1321 static int
1322 sbuf_drain_count(void *arg, const char *data __unused, int len)
1323 {
1324         size_t *sizep;
1325
1326         sizep = (size_t *)arg;
1327         *sizep += len;
1328         return (len);
1329 }
1330
1331 int
1332 __elfN(coredump)(struct thread *td, struct vnode *vp, off_t limit, int flags)
1333 {
1334         struct ucred *cred = td->td_ucred;
1335         int error = 0;
1336         struct sseg_closure seginfo;
1337         struct note_info_list notelst;
1338         struct coredump_params params;
1339         struct note_info *ninfo;
1340         void *hdr, *tmpbuf;
1341         size_t hdrsize, notesz, coresize;
1342 #ifdef GZIO
1343         boolean_t compress;
1344
1345         compress = (flags & IMGACT_CORE_COMPRESS) != 0;
1346 #endif
1347         hdr = NULL;
1348         tmpbuf = NULL;
1349         TAILQ_INIT(&notelst);
1350
1351         /* Size the program segments. */
1352         seginfo.count = 0;
1353         seginfo.size = 0;
1354         each_writable_segment(td, cb_size_segment, &seginfo);
1355
1356         /*
1357          * Collect info about the core file header area.
1358          */
1359         hdrsize = sizeof(Elf_Ehdr) + sizeof(Elf_Phdr) * (1 + seginfo.count);
1360         __elfN(prepare_notes)(td, &notelst, &notesz);
1361         coresize = round_page(hdrsize + notesz) + seginfo.size;
1362
1363         /* Set up core dump parameters. */
1364         params.offset = 0;
1365         params.active_cred = cred;
1366         params.file_cred = NOCRED;
1367         params.td = td;
1368         params.vp = vp;
1369         params.gzs = NULL;
1370
1371 #ifdef RACCT
1372         if (racct_enable) {
1373                 PROC_LOCK(td->td_proc);
1374                 error = racct_add(td->td_proc, RACCT_CORE, coresize);
1375                 PROC_UNLOCK(td->td_proc);
1376                 if (error != 0) {
1377                         error = EFAULT;
1378                         goto done;
1379                 }
1380         }
1381 #endif
1382         if (coresize >= limit) {
1383                 error = EFAULT;
1384                 goto done;
1385         }
1386
1387 #ifdef GZIO
1388         /* Create a compression stream if necessary. */
1389         if (compress) {
1390                 params.gzs = gzio_init(core_gz_write, GZIO_DEFLATE,
1391                     CORE_BUF_SIZE, compress_user_cores_gzlevel, &params);
1392                 if (params.gzs == NULL) {
1393                         error = EFAULT;
1394                         goto done;
1395                 }
1396                 tmpbuf = malloc(CORE_BUF_SIZE, M_TEMP, M_WAITOK | M_ZERO);
1397         }
1398 #endif
1399
1400         /*
1401          * Allocate memory for building the header, fill it up,
1402          * and write it out following the notes.
1403          */
1404         hdr = malloc(hdrsize, M_TEMP, M_WAITOK);
1405         error = __elfN(corehdr)(&params, seginfo.count, hdr, hdrsize, &notelst,
1406             notesz);
1407
1408         /* Write the contents of all of the writable segments. */
1409         if (error == 0) {
1410                 Elf_Phdr *php;
1411                 off_t offset;
1412                 int i;
1413
1414                 php = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr)) + 1;
1415                 offset = round_page(hdrsize + notesz);
1416                 for (i = 0; i < seginfo.count; i++) {
1417                         error = core_output((caddr_t)(uintptr_t)php->p_vaddr,
1418                             php->p_filesz, offset, &params, tmpbuf);
1419                         if (error != 0)
1420                                 break;
1421                         offset += php->p_filesz;
1422                         php++;
1423                 }
1424 #ifdef GZIO
1425                 if (error == 0 && compress)
1426                         error = gzio_flush(params.gzs);
1427 #endif
1428         }
1429         if (error) {
1430                 log(LOG_WARNING,
1431                     "Failed to write core file for process %s (error %d)\n",
1432                     curproc->p_comm, error);
1433         }
1434
1435 done:
1436 #ifdef GZIO
1437         if (compress) {
1438                 free(tmpbuf, M_TEMP);
1439                 if (params.gzs != NULL)
1440                         gzio_fini(params.gzs);
1441         }
1442 #endif
1443         while ((ninfo = TAILQ_FIRST(&notelst)) != NULL) {
1444                 TAILQ_REMOVE(&notelst, ninfo, link);
1445                 free(ninfo, M_TEMP);
1446         }
1447         if (hdr != NULL)
1448                 free(hdr, M_TEMP);
1449
1450         return (error);
1451 }
1452
1453 /*
1454  * A callback for each_writable_segment() to write out the segment's
1455  * program header entry.
1456  */
1457 static void
1458 cb_put_phdr(entry, closure)
1459         vm_map_entry_t entry;
1460         void *closure;
1461 {
1462         struct phdr_closure *phc = (struct phdr_closure *)closure;
1463         Elf_Phdr *phdr = phc->phdr;
1464
1465         phc->offset = round_page(phc->offset);
1466
1467         phdr->p_type = PT_LOAD;
1468         phdr->p_offset = phc->offset;
1469         phdr->p_vaddr = entry->start;
1470         phdr->p_paddr = 0;
1471         phdr->p_filesz = phdr->p_memsz = entry->end - entry->start;
1472         phdr->p_align = PAGE_SIZE;
1473         phdr->p_flags = __elfN(untrans_prot)(entry->protection);
1474
1475         phc->offset += phdr->p_filesz;
1476         phc->phdr++;
1477 }
1478
1479 /*
1480  * A callback for each_writable_segment() to gather information about
1481  * the number of segments and their total size.
1482  */
1483 static void
1484 cb_size_segment(entry, closure)
1485         vm_map_entry_t entry;
1486         void *closure;
1487 {
1488         struct sseg_closure *ssc = (struct sseg_closure *)closure;
1489
1490         ssc->count++;
1491         ssc->size += entry->end - entry->start;
1492 }
1493
1494 /*
1495  * For each writable segment in the process's memory map, call the given
1496  * function with a pointer to the map entry and some arbitrary
1497  * caller-supplied data.
1498  */
1499 static void
1500 each_writable_segment(td, func, closure)
1501         struct thread *td;
1502         segment_callback func;
1503         void *closure;
1504 {
1505         struct proc *p = td->td_proc;
1506         vm_map_t map = &p->p_vmspace->vm_map;
1507         vm_map_entry_t entry;
1508         vm_object_t backing_object, object;
1509         boolean_t ignore_entry;
1510
1511         vm_map_lock_read(map);
1512         for (entry = map->header.next; entry != &map->header;
1513             entry = entry->next) {
1514                 /*
1515                  * Don't dump inaccessible mappings, deal with legacy
1516                  * coredump mode.
1517                  *
1518                  * Note that read-only segments related to the elf binary
1519                  * are marked MAP_ENTRY_NOCOREDUMP now so we no longer
1520                  * need to arbitrarily ignore such segments.
1521                  */
1522                 if (elf_legacy_coredump) {
1523                         if ((entry->protection & VM_PROT_RW) != VM_PROT_RW)
1524                                 continue;
1525                 } else {
1526                         if ((entry->protection & VM_PROT_ALL) == 0)
1527                                 continue;
1528                 }
1529
1530                 /*
1531                  * Dont include memory segment in the coredump if
1532                  * MAP_NOCORE is set in mmap(2) or MADV_NOCORE in
1533                  * madvise(2).  Do not dump submaps (i.e. parts of the
1534                  * kernel map).
1535                  */
1536                 if (entry->eflags & (MAP_ENTRY_NOCOREDUMP|MAP_ENTRY_IS_SUB_MAP))
1537                         continue;
1538
1539                 if ((object = entry->object.vm_object) == NULL)
1540                         continue;
1541
1542                 /* Ignore memory-mapped devices and such things. */
1543                 VM_OBJECT_RLOCK(object);
1544                 while ((backing_object = object->backing_object) != NULL) {
1545                         VM_OBJECT_RLOCK(backing_object);
1546                         VM_OBJECT_RUNLOCK(object);
1547                         object = backing_object;
1548                 }
1549                 ignore_entry = object->type != OBJT_DEFAULT &&
1550                     object->type != OBJT_SWAP && object->type != OBJT_VNODE &&
1551                     object->type != OBJT_PHYS;
1552                 VM_OBJECT_RUNLOCK(object);
1553                 if (ignore_entry)
1554                         continue;
1555
1556                 (*func)(entry, closure);
1557         }
1558         vm_map_unlock_read(map);
1559 }
1560
1561 /*
1562  * Write the core file header to the file, including padding up to
1563  * the page boundary.
1564  */
1565 static int
1566 __elfN(corehdr)(struct coredump_params *p, int numsegs, void *hdr,
1567     size_t hdrsize, struct note_info_list *notelst, size_t notesz)
1568 {
1569         struct note_info *ninfo;
1570         struct sbuf *sb;
1571         int error;
1572
1573         /* Fill in the header. */
1574         bzero(hdr, hdrsize);
1575         __elfN(puthdr)(p->td, hdr, hdrsize, numsegs, notesz);
1576
1577         sb = sbuf_new(NULL, NULL, CORE_BUF_SIZE, SBUF_FIXEDLEN);
1578         sbuf_set_drain(sb, sbuf_drain_core_output, p);
1579         sbuf_start_section(sb, NULL);
1580         sbuf_bcat(sb, hdr, hdrsize);
1581         TAILQ_FOREACH(ninfo, notelst, link)
1582             __elfN(putnote)(ninfo, sb);
1583         /* Align up to a page boundary for the program segments. */
1584         sbuf_end_section(sb, -1, PAGE_SIZE, 0);
1585         error = sbuf_finish(sb);
1586         sbuf_delete(sb);
1587
1588         return (error);
1589 }
1590
1591 static void
1592 __elfN(prepare_notes)(struct thread *td, struct note_info_list *list,
1593     size_t *sizep)
1594 {
1595         struct proc *p;
1596         struct thread *thr;
1597         size_t size;
1598
1599         p = td->td_proc;
1600         size = 0;
1601
1602         size += register_note(list, NT_PRPSINFO, __elfN(note_prpsinfo), p);
1603
1604         /*
1605          * To have the debugger select the right thread (LWP) as the initial
1606          * thread, we dump the state of the thread passed to us in td first.
1607          * This is the thread that causes the core dump and thus likely to
1608          * be the right thread one wants to have selected in the debugger.
1609          */
1610         thr = td;
1611         while (thr != NULL) {
1612                 size += register_note(list, NT_PRSTATUS,
1613                     __elfN(note_prstatus), thr);
1614                 size += register_note(list, NT_FPREGSET,
1615                     __elfN(note_fpregset), thr);
1616                 size += register_note(list, NT_THRMISC,
1617                     __elfN(note_thrmisc), thr);
1618                 size += register_note(list, -1,
1619                     __elfN(note_threadmd), thr);
1620
1621                 thr = (thr == td) ? TAILQ_FIRST(&p->p_threads) :
1622                     TAILQ_NEXT(thr, td_plist);
1623                 if (thr == td)
1624                         thr = TAILQ_NEXT(thr, td_plist);
1625         }
1626
1627         size += register_note(list, NT_PROCSTAT_PROC,
1628             __elfN(note_procstat_proc), p);
1629         size += register_note(list, NT_PROCSTAT_FILES,
1630             note_procstat_files, p);
1631         size += register_note(list, NT_PROCSTAT_VMMAP,
1632             note_procstat_vmmap, p);
1633         size += register_note(list, NT_PROCSTAT_GROUPS,
1634             note_procstat_groups, p);
1635         size += register_note(list, NT_PROCSTAT_UMASK,
1636             note_procstat_umask, p);
1637         size += register_note(list, NT_PROCSTAT_RLIMIT,
1638             note_procstat_rlimit, p);
1639         size += register_note(list, NT_PROCSTAT_OSREL,
1640             note_procstat_osrel, p);
1641         size += register_note(list, NT_PROCSTAT_PSSTRINGS,
1642             __elfN(note_procstat_psstrings), p);
1643         size += register_note(list, NT_PROCSTAT_AUXV,
1644             __elfN(note_procstat_auxv), p);
1645
1646         *sizep = size;
1647 }
1648
1649 static void
1650 __elfN(puthdr)(struct thread *td, void *hdr, size_t hdrsize, int numsegs,
1651     size_t notesz)
1652 {
1653         Elf_Ehdr *ehdr;
1654         Elf_Phdr *phdr;
1655         struct phdr_closure phc;
1656
1657         ehdr = (Elf_Ehdr *)hdr;
1658         phdr = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr));
1659
1660         ehdr->e_ident[EI_MAG0] = ELFMAG0;
1661         ehdr->e_ident[EI_MAG1] = ELFMAG1;
1662         ehdr->e_ident[EI_MAG2] = ELFMAG2;
1663         ehdr->e_ident[EI_MAG3] = ELFMAG3;
1664         ehdr->e_ident[EI_CLASS] = ELF_CLASS;
1665         ehdr->e_ident[EI_DATA] = ELF_DATA;
1666         ehdr->e_ident[EI_VERSION] = EV_CURRENT;
1667         ehdr->e_ident[EI_OSABI] = ELFOSABI_FREEBSD;
1668         ehdr->e_ident[EI_ABIVERSION] = 0;
1669         ehdr->e_ident[EI_PAD] = 0;
1670         ehdr->e_type = ET_CORE;
1671 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
1672         ehdr->e_machine = ELF_ARCH32;
1673 #else
1674         ehdr->e_machine = ELF_ARCH;
1675 #endif
1676         ehdr->e_version = EV_CURRENT;
1677         ehdr->e_entry = 0;
1678         ehdr->e_phoff = sizeof(Elf_Ehdr);
1679         ehdr->e_flags = 0;
1680         ehdr->e_ehsize = sizeof(Elf_Ehdr);
1681         ehdr->e_phentsize = sizeof(Elf_Phdr);
1682         ehdr->e_phnum = numsegs + 1;
1683         ehdr->e_shentsize = sizeof(Elf_Shdr);
1684         ehdr->e_shnum = 0;
1685         ehdr->e_shstrndx = SHN_UNDEF;
1686
1687         /*
1688          * Fill in the program header entries.
1689          */
1690
1691         /* The note segement. */
1692         phdr->p_type = PT_NOTE;
1693         phdr->p_offset = hdrsize;
1694         phdr->p_vaddr = 0;
1695         phdr->p_paddr = 0;
1696         phdr->p_filesz = notesz;
1697         phdr->p_memsz = 0;
1698         phdr->p_flags = PF_R;
1699         phdr->p_align = ELF_NOTE_ROUNDSIZE;
1700         phdr++;
1701
1702         /* All the writable segments from the program. */
1703         phc.phdr = phdr;
1704         phc.offset = round_page(hdrsize + notesz);
1705         each_writable_segment(td, cb_put_phdr, &phc);
1706 }
1707
1708 static size_t
1709 register_note(struct note_info_list *list, int type, outfunc_t out, void *arg)
1710 {
1711         struct note_info *ninfo;
1712         size_t size, notesize;
1713
1714         size = 0;
1715         out(arg, NULL, &size);
1716         ninfo = malloc(sizeof(*ninfo), M_TEMP, M_ZERO | M_WAITOK);
1717         ninfo->type = type;
1718         ninfo->outfunc = out;
1719         ninfo->outarg = arg;
1720         ninfo->outsize = size;
1721         TAILQ_INSERT_TAIL(list, ninfo, link);
1722
1723         if (type == -1)
1724                 return (size);
1725
1726         notesize = sizeof(Elf_Note) +           /* note header */
1727             roundup2(sizeof(FREEBSD_ABI_VENDOR), ELF_NOTE_ROUNDSIZE) +
1728                                                 /* note name */
1729             roundup2(size, ELF_NOTE_ROUNDSIZE); /* note description */
1730
1731         return (notesize);
1732 }
1733
1734 static size_t
1735 append_note_data(const void *src, void *dst, size_t len)
1736 {
1737         size_t padded_len;
1738
1739         padded_len = roundup2(len, ELF_NOTE_ROUNDSIZE);
1740         if (dst != NULL) {
1741                 bcopy(src, dst, len);
1742                 bzero((char *)dst + len, padded_len - len);
1743         }
1744         return (padded_len);
1745 }
1746
1747 size_t
1748 __elfN(populate_note)(int type, void *src, void *dst, size_t size, void **descp)
1749 {
1750         Elf_Note *note;
1751         char *buf;
1752         size_t notesize;
1753
1754         buf = dst;
1755         if (buf != NULL) {
1756                 note = (Elf_Note *)buf;
1757                 note->n_namesz = sizeof(FREEBSD_ABI_VENDOR);
1758                 note->n_descsz = size;
1759                 note->n_type = type;
1760                 buf += sizeof(*note);
1761                 buf += append_note_data(FREEBSD_ABI_VENDOR, buf,
1762                     sizeof(FREEBSD_ABI_VENDOR));
1763                 append_note_data(src, buf, size);
1764                 if (descp != NULL)
1765                         *descp = buf;
1766         }
1767
1768         notesize = sizeof(Elf_Note) +           /* note header */
1769             roundup2(sizeof(FREEBSD_ABI_VENDOR), ELF_NOTE_ROUNDSIZE) +
1770                                                 /* note name */
1771             roundup2(size, ELF_NOTE_ROUNDSIZE); /* note description */
1772
1773         return (notesize);
1774 }
1775
1776 static void
1777 __elfN(putnote)(struct note_info *ninfo, struct sbuf *sb)
1778 {
1779         Elf_Note note;
1780         ssize_t old_len, sect_len;
1781         size_t new_len, descsz, i;
1782
1783         if (ninfo->type == -1) {
1784                 ninfo->outfunc(ninfo->outarg, sb, &ninfo->outsize);
1785                 return;
1786         }
1787
1788         note.n_namesz = sizeof(FREEBSD_ABI_VENDOR);
1789         note.n_descsz = ninfo->outsize;
1790         note.n_type = ninfo->type;
1791
1792         sbuf_bcat(sb, &note, sizeof(note));
1793         sbuf_start_section(sb, &old_len);
1794         sbuf_bcat(sb, FREEBSD_ABI_VENDOR, sizeof(FREEBSD_ABI_VENDOR));
1795         sbuf_end_section(sb, old_len, ELF_NOTE_ROUNDSIZE, 0);
1796         if (note.n_descsz == 0)
1797                 return;
1798         sbuf_start_section(sb, &old_len);
1799         ninfo->outfunc(ninfo->outarg, sb, &ninfo->outsize);
1800         sect_len = sbuf_end_section(sb, old_len, ELF_NOTE_ROUNDSIZE, 0);
1801         if (sect_len < 0)
1802                 return;
1803
1804         new_len = (size_t)sect_len;
1805         descsz = roundup(note.n_descsz, ELF_NOTE_ROUNDSIZE);
1806         if (new_len < descsz) {
1807                 /*
1808                  * It is expected that individual note emitters will correctly
1809                  * predict their expected output size and fill up to that size
1810                  * themselves, padding in a format-specific way if needed.
1811                  * However, in case they don't, just do it here with zeros.
1812                  */
1813                 for (i = 0; i < descsz - new_len; i++)
1814                         sbuf_putc(sb, 0);
1815         } else if (new_len > descsz) {
1816                 /*
1817                  * We can't always truncate sb -- we may have drained some
1818                  * of it already.
1819                  */
1820                 KASSERT(new_len == descsz, ("%s: Note type %u changed as we "
1821                     "read it (%zu > %zu).  Since it is longer than "
1822                     "expected, this coredump's notes are corrupt.  THIS "
1823                     "IS A BUG in the note_procstat routine for type %u.\n",
1824                     __func__, (unsigned)note.n_type, new_len, descsz,
1825                     (unsigned)note.n_type));
1826         }
1827 }
1828
1829 /*
1830  * Miscellaneous note out functions.
1831  */
1832
1833 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
1834 #include <compat/freebsd32/freebsd32.h>
1835
1836 typedef struct prstatus32 elf_prstatus_t;
1837 typedef struct prpsinfo32 elf_prpsinfo_t;
1838 typedef struct fpreg32 elf_prfpregset_t;
1839 typedef struct fpreg32 elf_fpregset_t;
1840 typedef struct reg32 elf_gregset_t;
1841 typedef struct thrmisc32 elf_thrmisc_t;
1842 #define ELF_KERN_PROC_MASK      KERN_PROC_MASK32
1843 typedef struct kinfo_proc32 elf_kinfo_proc_t;
1844 typedef uint32_t elf_ps_strings_t;
1845 #else
1846 typedef prstatus_t elf_prstatus_t;
1847 typedef prpsinfo_t elf_prpsinfo_t;
1848 typedef prfpregset_t elf_prfpregset_t;
1849 typedef prfpregset_t elf_fpregset_t;
1850 typedef gregset_t elf_gregset_t;
1851 typedef thrmisc_t elf_thrmisc_t;
1852 #define ELF_KERN_PROC_MASK      0
1853 typedef struct kinfo_proc elf_kinfo_proc_t;
1854 typedef vm_offset_t elf_ps_strings_t;
1855 #endif
1856
1857 static void
1858 __elfN(note_prpsinfo)(void *arg, struct sbuf *sb, size_t *sizep)
1859 {
1860         struct sbuf sbarg;
1861         size_t len;
1862         char *cp, *end;
1863         struct proc *p;
1864         elf_prpsinfo_t *psinfo;
1865         int error;
1866
1867         p = (struct proc *)arg;
1868         if (sb != NULL) {
1869                 KASSERT(*sizep == sizeof(*psinfo), ("invalid size"));
1870                 psinfo = malloc(sizeof(*psinfo), M_TEMP, M_ZERO | M_WAITOK);
1871                 psinfo->pr_version = PRPSINFO_VERSION;
1872                 psinfo->pr_psinfosz = sizeof(elf_prpsinfo_t);
1873                 strlcpy(psinfo->pr_fname, p->p_comm, sizeof(psinfo->pr_fname));
1874                 PROC_LOCK(p);
1875                 if (p->p_args != NULL) {
1876                         len = sizeof(psinfo->pr_psargs) - 1;
1877                         if (len > p->p_args->ar_length)
1878                                 len = p->p_args->ar_length;
1879                         memcpy(psinfo->pr_psargs, p->p_args->ar_args, len);
1880                         PROC_UNLOCK(p);
1881                         error = 0;
1882                 } else {
1883                         _PHOLD(p);
1884                         PROC_UNLOCK(p);
1885                         sbuf_new(&sbarg, psinfo->pr_psargs,
1886                             sizeof(psinfo->pr_psargs), SBUF_FIXEDLEN);
1887                         error = proc_getargv(curthread, p, &sbarg);
1888                         PRELE(p);
1889                         if (sbuf_finish(&sbarg) == 0)
1890                                 len = sbuf_len(&sbarg) - 1;
1891                         else
1892                                 len = sizeof(psinfo->pr_psargs) - 1;
1893                         sbuf_delete(&sbarg);
1894                 }
1895                 if (error || len == 0)
1896                         strlcpy(psinfo->pr_psargs, p->p_comm,
1897                             sizeof(psinfo->pr_psargs));
1898                 else {
1899                         KASSERT(len < sizeof(psinfo->pr_psargs),
1900                             ("len is too long: %zu vs %zu", len,
1901                             sizeof(psinfo->pr_psargs)));
1902                         cp = psinfo->pr_psargs;
1903                         end = cp + len - 1;
1904                         for (;;) {
1905                                 cp = memchr(cp, '\0', end - cp);
1906                                 if (cp == NULL)
1907                                         break;
1908                                 *cp = ' ';
1909                         }
1910                 }
1911                 psinfo->pr_pid = p->p_pid;
1912                 sbuf_bcat(sb, psinfo, sizeof(*psinfo));
1913                 free(psinfo, M_TEMP);
1914         }
1915         *sizep = sizeof(*psinfo);
1916 }
1917
1918 static void
1919 __elfN(note_prstatus)(void *arg, struct sbuf *sb, size_t *sizep)
1920 {
1921         struct thread *td;
1922         elf_prstatus_t *status;
1923
1924         td = (struct thread *)arg;
1925         if (sb != NULL) {
1926                 KASSERT(*sizep == sizeof(*status), ("invalid size"));
1927                 status = malloc(sizeof(*status), M_TEMP, M_ZERO | M_WAITOK);
1928                 status->pr_version = PRSTATUS_VERSION;
1929                 status->pr_statussz = sizeof(elf_prstatus_t);
1930                 status->pr_gregsetsz = sizeof(elf_gregset_t);
1931                 status->pr_fpregsetsz = sizeof(elf_fpregset_t);
1932                 status->pr_osreldate = osreldate;
1933                 status->pr_cursig = td->td_proc->p_sig;
1934                 status->pr_pid = td->td_tid;
1935 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
1936                 fill_regs32(td, &status->pr_reg);
1937 #else
1938                 fill_regs(td, &status->pr_reg);
1939 #endif
1940                 sbuf_bcat(sb, status, sizeof(*status));
1941                 free(status, M_TEMP);
1942         }
1943         *sizep = sizeof(*status);
1944 }
1945
1946 static void
1947 __elfN(note_fpregset)(void *arg, struct sbuf *sb, size_t *sizep)
1948 {
1949         struct thread *td;
1950         elf_prfpregset_t *fpregset;
1951
1952         td = (struct thread *)arg;
1953         if (sb != NULL) {
1954                 KASSERT(*sizep == sizeof(*fpregset), ("invalid size"));
1955                 fpregset = malloc(sizeof(*fpregset), M_TEMP, M_ZERO | M_WAITOK);
1956 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
1957                 fill_fpregs32(td, fpregset);
1958 #else
1959                 fill_fpregs(td, fpregset);
1960 #endif
1961                 sbuf_bcat(sb, fpregset, sizeof(*fpregset));
1962                 free(fpregset, M_TEMP);
1963         }
1964         *sizep = sizeof(*fpregset);
1965 }
1966
1967 static void
1968 __elfN(note_thrmisc)(void *arg, struct sbuf *sb, size_t *sizep)
1969 {
1970         struct thread *td;
1971         elf_thrmisc_t thrmisc;
1972
1973         td = (struct thread *)arg;
1974         if (sb != NULL) {
1975                 KASSERT(*sizep == sizeof(thrmisc), ("invalid size"));
1976                 bzero(&thrmisc._pad, sizeof(thrmisc._pad));
1977                 strcpy(thrmisc.pr_tname, td->td_name);
1978                 sbuf_bcat(sb, &thrmisc, sizeof(thrmisc));
1979         }
1980         *sizep = sizeof(thrmisc);
1981 }
1982
1983 /*
1984  * Allow for MD specific notes, as well as any MD
1985  * specific preparations for writing MI notes.
1986  */
1987 static void
1988 __elfN(note_threadmd)(void *arg, struct sbuf *sb, size_t *sizep)
1989 {
1990         struct thread *td;
1991         void *buf;
1992         size_t size;
1993
1994         td = (struct thread *)arg;
1995         size = *sizep;
1996         if (size != 0 && sb != NULL)
1997                 buf = malloc(size, M_TEMP, M_ZERO | M_WAITOK);
1998         else
1999                 buf = NULL;
2000         size = 0;
2001         __elfN(dump_thread)(td, buf, &size);
2002         KASSERT(sb == NULL || *sizep == size, ("invalid size"));
2003         if (size != 0 && sb != NULL)
2004                 sbuf_bcat(sb, buf, size);
2005         free(buf, M_TEMP);
2006         *sizep = size;
2007 }
2008
2009 #ifdef KINFO_PROC_SIZE
2010 CTASSERT(sizeof(struct kinfo_proc) == KINFO_PROC_SIZE);
2011 #endif
2012
2013 static void
2014 __elfN(note_procstat_proc)(void *arg, struct sbuf *sb, size_t *sizep)
2015 {
2016         struct proc *p;
2017         size_t size;
2018         int structsize;
2019
2020         p = (struct proc *)arg;
2021         size = sizeof(structsize) + p->p_numthreads *
2022             sizeof(elf_kinfo_proc_t);
2023
2024         if (sb != NULL) {
2025                 KASSERT(*sizep == size, ("invalid size"));
2026                 structsize = sizeof(elf_kinfo_proc_t);
2027                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2028                 sx_slock(&proctree_lock);
2029                 PROC_LOCK(p);
2030                 kern_proc_out(p, sb, ELF_KERN_PROC_MASK);
2031                 sx_sunlock(&proctree_lock);
2032         }
2033         *sizep = size;
2034 }
2035
2036 #ifdef KINFO_FILE_SIZE
2037 CTASSERT(sizeof(struct kinfo_file) == KINFO_FILE_SIZE);
2038 #endif
2039
2040 static void
2041 note_procstat_files(void *arg, struct sbuf *sb, size_t *sizep)
2042 {
2043         struct proc *p;
2044         size_t size, sect_sz, i;
2045         ssize_t start_len, sect_len;
2046         int structsize, filedesc_flags;
2047
2048         if (coredump_pack_fileinfo)
2049                 filedesc_flags = KERN_FILEDESC_PACK_KINFO;
2050         else
2051                 filedesc_flags = 0;
2052
2053         p = (struct proc *)arg;
2054         structsize = sizeof(struct kinfo_file);
2055         if (sb == NULL) {
2056                 size = 0;
2057                 sb = sbuf_new(NULL, NULL, 128, SBUF_FIXEDLEN);
2058                 sbuf_set_drain(sb, sbuf_drain_count, &size);
2059                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2060                 PROC_LOCK(p);
2061                 kern_proc_filedesc_out(p, sb, -1, filedesc_flags);
2062                 sbuf_finish(sb);
2063                 sbuf_delete(sb);
2064                 *sizep = size;
2065         } else {
2066                 sbuf_start_section(sb, &start_len);
2067
2068                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2069                 PROC_LOCK(p);
2070                 kern_proc_filedesc_out(p, sb, *sizep - sizeof(structsize),
2071                     filedesc_flags);
2072
2073                 sect_len = sbuf_end_section(sb, start_len, 0, 0);
2074                 if (sect_len < 0)
2075                         return;
2076                 sect_sz = sect_len;
2077
2078                 KASSERT(sect_sz <= *sizep,
2079                     ("kern_proc_filedesc_out did not respect maxlen; "
2080                      "requested %zu, got %zu", *sizep - sizeof(structsize),
2081                      sect_sz - sizeof(structsize)));
2082
2083                 for (i = 0; i < *sizep - sect_sz && sb->s_error == 0; i++)
2084                         sbuf_putc(sb, 0);
2085         }
2086 }
2087
2088 #ifdef KINFO_VMENTRY_SIZE
2089 CTASSERT(sizeof(struct kinfo_vmentry) == KINFO_VMENTRY_SIZE);
2090 #endif
2091
2092 static void
2093 note_procstat_vmmap(void *arg, struct sbuf *sb, size_t *sizep)
2094 {
2095         struct proc *p;
2096         size_t size;
2097         int structsize, vmmap_flags;
2098
2099         if (coredump_pack_vmmapinfo)
2100                 vmmap_flags = KERN_VMMAP_PACK_KINFO;
2101         else
2102                 vmmap_flags = 0;
2103
2104         p = (struct proc *)arg;
2105         structsize = sizeof(struct kinfo_vmentry);
2106         if (sb == NULL) {
2107                 size = 0;
2108                 sb = sbuf_new(NULL, NULL, 128, SBUF_FIXEDLEN);
2109                 sbuf_set_drain(sb, sbuf_drain_count, &size);
2110                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2111                 PROC_LOCK(p);
2112                 kern_proc_vmmap_out(p, sb, -1, vmmap_flags);
2113                 sbuf_finish(sb);
2114                 sbuf_delete(sb);
2115                 *sizep = size;
2116         } else {
2117                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2118                 PROC_LOCK(p);
2119                 kern_proc_vmmap_out(p, sb, *sizep - sizeof(structsize),
2120                     vmmap_flags);
2121         }
2122 }
2123
2124 static void
2125 note_procstat_groups(void *arg, struct sbuf *sb, size_t *sizep)
2126 {
2127         struct proc *p;
2128         size_t size;
2129         int structsize;
2130
2131         p = (struct proc *)arg;
2132         size = sizeof(structsize) + p->p_ucred->cr_ngroups * sizeof(gid_t);
2133         if (sb != NULL) {
2134                 KASSERT(*sizep == size, ("invalid size"));
2135                 structsize = sizeof(gid_t);
2136                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2137                 sbuf_bcat(sb, p->p_ucred->cr_groups, p->p_ucred->cr_ngroups *
2138                     sizeof(gid_t));
2139         }
2140         *sizep = size;
2141 }
2142
2143 static void
2144 note_procstat_umask(void *arg, struct sbuf *sb, size_t *sizep)
2145 {
2146         struct proc *p;
2147         size_t size;
2148         int structsize;
2149
2150         p = (struct proc *)arg;
2151         size = sizeof(structsize) + sizeof(p->p_fd->fd_cmask);
2152         if (sb != NULL) {
2153                 KASSERT(*sizep == size, ("invalid size"));
2154                 structsize = sizeof(p->p_fd->fd_cmask);
2155                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2156                 sbuf_bcat(sb, &p->p_fd->fd_cmask, sizeof(p->p_fd->fd_cmask));
2157         }
2158         *sizep = size;
2159 }
2160
2161 static void
2162 note_procstat_rlimit(void *arg, struct sbuf *sb, size_t *sizep)
2163 {
2164         struct proc *p;
2165         struct rlimit rlim[RLIM_NLIMITS];
2166         size_t size;
2167         int structsize, i;
2168
2169         p = (struct proc *)arg;
2170         size = sizeof(structsize) + sizeof(rlim);
2171         if (sb != NULL) {
2172                 KASSERT(*sizep == size, ("invalid size"));
2173                 structsize = sizeof(rlim);
2174                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2175                 PROC_LOCK(p);
2176                 for (i = 0; i < RLIM_NLIMITS; i++)
2177                         lim_rlimit_proc(p, i, &rlim[i]);
2178                 PROC_UNLOCK(p);
2179                 sbuf_bcat(sb, rlim, sizeof(rlim));
2180         }
2181         *sizep = size;
2182 }
2183
2184 static void
2185 note_procstat_osrel(void *arg, struct sbuf *sb, size_t *sizep)
2186 {
2187         struct proc *p;
2188         size_t size;
2189         int structsize;
2190
2191         p = (struct proc *)arg;
2192         size = sizeof(structsize) + sizeof(p->p_osrel);
2193         if (sb != NULL) {
2194                 KASSERT(*sizep == size, ("invalid size"));
2195                 structsize = sizeof(p->p_osrel);
2196                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2197                 sbuf_bcat(sb, &p->p_osrel, sizeof(p->p_osrel));
2198         }
2199         *sizep = size;
2200 }
2201
2202 static void
2203 __elfN(note_procstat_psstrings)(void *arg, struct sbuf *sb, size_t *sizep)
2204 {
2205         struct proc *p;
2206         elf_ps_strings_t ps_strings;
2207         size_t size;
2208         int structsize;
2209
2210         p = (struct proc *)arg;
2211         size = sizeof(structsize) + sizeof(ps_strings);
2212         if (sb != NULL) {
2213                 KASSERT(*sizep == size, ("invalid size"));
2214                 structsize = sizeof(ps_strings);
2215 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
2216                 ps_strings = PTROUT(p->p_sysent->sv_psstrings);
2217 #else
2218                 ps_strings = p->p_sysent->sv_psstrings;
2219 #endif
2220                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2221                 sbuf_bcat(sb, &ps_strings, sizeof(ps_strings));
2222         }
2223         *sizep = size;
2224 }
2225
2226 static void
2227 __elfN(note_procstat_auxv)(void *arg, struct sbuf *sb, size_t *sizep)
2228 {
2229         struct proc *p;
2230         size_t size;
2231         int structsize;
2232
2233         p = (struct proc *)arg;
2234         if (sb == NULL) {
2235                 size = 0;
2236                 sb = sbuf_new(NULL, NULL, 128, SBUF_FIXEDLEN);
2237                 sbuf_set_drain(sb, sbuf_drain_count, &size);
2238                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2239                 PHOLD(p);
2240                 proc_getauxv(curthread, p, sb);
2241                 PRELE(p);
2242                 sbuf_finish(sb);
2243                 sbuf_delete(sb);
2244                 *sizep = size;
2245         } else {
2246                 structsize = sizeof(Elf_Auxinfo);
2247                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2248                 PHOLD(p);
2249                 proc_getauxv(curthread, p, sb);
2250                 PRELE(p);
2251         }
2252 }
2253
2254 static boolean_t
2255 __elfN(parse_notes)(struct image_params *imgp, Elf_Brandnote *checknote,
2256     int32_t *osrel, const Elf_Phdr *pnote)
2257 {
2258         const Elf_Note *note, *note0, *note_end;
2259         const char *note_name;
2260         char *buf;
2261         int i, error;
2262         boolean_t res;
2263
2264         /* We need some limit, might as well use PAGE_SIZE. */
2265         if (pnote == NULL || pnote->p_filesz > PAGE_SIZE)
2266                 return (FALSE);
2267         ASSERT_VOP_LOCKED(imgp->vp, "parse_notes");
2268         if (pnote->p_offset > PAGE_SIZE ||
2269             pnote->p_filesz > PAGE_SIZE - pnote->p_offset) {
2270                 VOP_UNLOCK(imgp->vp, 0);
2271                 buf = malloc(pnote->p_filesz, M_TEMP, M_WAITOK);
2272                 vn_lock(imgp->vp, LK_EXCLUSIVE | LK_RETRY);
2273                 error = vn_rdwr(UIO_READ, imgp->vp, buf, pnote->p_filesz,
2274                     pnote->p_offset, UIO_SYSSPACE, IO_NODELOCKED,
2275                     curthread->td_ucred, NOCRED, NULL, curthread);
2276                 if (error != 0) {
2277                         uprintf("i/o error PT_NOTE\n");
2278                         res = FALSE;
2279                         goto ret;
2280                 }
2281                 note = note0 = (const Elf_Note *)buf;
2282                 note_end = (const Elf_Note *)(buf + pnote->p_filesz);
2283         } else {
2284                 note = note0 = (const Elf_Note *)(imgp->image_header +
2285                     pnote->p_offset);
2286                 note_end = (const Elf_Note *)(imgp->image_header +
2287                     pnote->p_offset + pnote->p_filesz);
2288                 buf = NULL;
2289         }
2290         for (i = 0; i < 100 && note >= note0 && note < note_end; i++) {
2291                 if (!aligned(note, Elf32_Addr) || (const char *)note_end -
2292                     (const char *)note < sizeof(Elf_Note)) {
2293                         res = FALSE;
2294                         goto ret;
2295                 }
2296                 if (note->n_namesz != checknote->hdr.n_namesz ||
2297                     note->n_descsz != checknote->hdr.n_descsz ||
2298                     note->n_type != checknote->hdr.n_type)
2299                         goto nextnote;
2300                 note_name = (const char *)(note + 1);
2301                 if (note_name + checknote->hdr.n_namesz >=
2302                     (const char *)note_end || strncmp(checknote->vendor,
2303                     note_name, checknote->hdr.n_namesz) != 0)
2304                         goto nextnote;
2305
2306                 /*
2307                  * Fetch the osreldate for binary
2308                  * from the ELF OSABI-note if necessary.
2309                  */
2310                 if ((checknote->flags & BN_TRANSLATE_OSREL) != 0 &&
2311                     checknote->trans_osrel != NULL) {
2312                         res = checknote->trans_osrel(note, osrel);
2313                         goto ret;
2314                 }
2315                 res = TRUE;
2316                 goto ret;
2317 nextnote:
2318                 note = (const Elf_Note *)((const char *)(note + 1) +
2319                     roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE) +
2320                     roundup2(note->n_descsz, ELF_NOTE_ROUNDSIZE));
2321         }
2322         res = FALSE;
2323 ret:
2324         free(buf, M_TEMP);
2325         return (res);
2326 }
2327
2328 /*
2329  * Try to find the appropriate ABI-note section for checknote,
2330  * fetch the osreldate for binary from the ELF OSABI-note. Only the
2331  * first page of the image is searched, the same as for headers.
2332  */
2333 static boolean_t
2334 __elfN(check_note)(struct image_params *imgp, Elf_Brandnote *checknote,
2335     int32_t *osrel)
2336 {
2337         const Elf_Phdr *phdr;
2338         const Elf_Ehdr *hdr;
2339         int i;
2340
2341         hdr = (const Elf_Ehdr *)imgp->image_header;
2342         phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
2343
2344         for (i = 0; i < hdr->e_phnum; i++) {
2345                 if (phdr[i].p_type == PT_NOTE &&
2346                     __elfN(parse_notes)(imgp, checknote, osrel, &phdr[i]))
2347                         return (TRUE);
2348         }
2349         return (FALSE);
2350
2351 }
2352
2353 /*
2354  * Tell kern_execve.c about it, with a little help from the linker.
2355  */
2356 static struct execsw __elfN(execsw) = {
2357         __CONCAT(exec_, __elfN(imgact)),
2358         __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE))
2359 };
2360 EXEC_SET(__CONCAT(elf, __ELF_WORD_SIZE), __elfN(execsw));
2361
2362 static vm_prot_t
2363 __elfN(trans_prot)(Elf_Word flags)
2364 {
2365         vm_prot_t prot;
2366
2367         prot = 0;
2368         if (flags & PF_X)
2369                 prot |= VM_PROT_EXECUTE;
2370         if (flags & PF_W)
2371                 prot |= VM_PROT_WRITE;
2372         if (flags & PF_R)
2373                 prot |= VM_PROT_READ;
2374 #if __ELF_WORD_SIZE == 32
2375 #if defined(__amd64__)
2376         if (i386_read_exec && (flags & PF_R))
2377                 prot |= VM_PROT_EXECUTE;
2378 #endif
2379 #endif
2380         return (prot);
2381 }
2382
2383 static Elf_Word
2384 __elfN(untrans_prot)(vm_prot_t prot)
2385 {
2386         Elf_Word flags;
2387
2388         flags = 0;
2389         if (prot & VM_PROT_EXECUTE)
2390                 flags |= PF_X;
2391         if (prot & VM_PROT_READ)
2392                 flags |= PF_R;
2393         if (prot & VM_PROT_WRITE)
2394                 flags |= PF_W;
2395         return (flags);
2396 }