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