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