sys/kern/imgact_elf.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2017 Dell EMC
   5  * Copyright (c) 2000-2001, 2003 David O'Brien
   6  * Copyright (c) 1995-1996 Søren Schmidt
   7  * Copyright (c) 1996 Peter Wemm
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer
  15  *    in this position and unchanged.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. The name of the author may not be used to endorse or promote products
  20  *    derived from this software without specific prior written permission
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36
  37 #include "opt_capsicum.h"
  38
  39 #include <sys/param.h>
  40 #include <sys/capsicum.h>
  41 #include <sys/compressor.h>
  42 #include <sys/exec.h>
  43 #include <sys/fcntl.h>
  44 #include <sys/imgact.h>
  45 #include <sys/imgact_elf.h>
  46 #include <sys/jail.h>
  47 #include <sys/kernel.h>
  48 #include <sys/lock.h>
  49 #include <sys/malloc.h>
  50 #include <sys/mount.h>
  51 #include <sys/mman.h>
  52 #include <sys/namei.h>
  53 #include <sys/proc.h>
  54 #include <sys/procfs.h>
  55 #include <sys/ptrace.h>
  56 #include <sys/racct.h>
  57 #include <sys/reg.h>
  58 #include <sys/resourcevar.h>
  59 #include <sys/rwlock.h>
  60 #include <sys/sbuf.h>
  61 #include <sys/sf_buf.h>
  62 #include <sys/smp.h>
  63 #include <sys/systm.h>
  64 #include <sys/signalvar.h>
  65 #include <sys/stat.h>
  66 #include <sys/sx.h>
  67 #include <sys/syscall.h>
  68 #include <sys/sysctl.h>
  69 #include <sys/sysent.h>
  70 #include <sys/vnode.h>
  71 #include <sys/syslog.h>
  72 #include <sys/eventhandler.h>
  73 #include <sys/user.h>
  74
  75 #include <vm/vm.h>
  76 #include <vm/vm_kern.h>
  77 #include <vm/vm_param.h>
  78 #include <vm/pmap.h>
  79 #include <vm/vm_map.h>
  80 #include <vm/vm_object.h>
  81 #include <vm/vm_extern.h>
  82
  83 #include <machine/elf.h>
  84 #include <machine/md_var.h>
  85
  86 #define ELF_NOTE_ROUNDSIZE      4
  87 #define OLD_EI_BRAND    8
  88
  89 static int __elfN(check_header)(const Elf_Ehdr *hdr);
  90 static Elf_Brandinfo *__elfN(get_brandinfo)(struct image_params *imgp,
  91     const char *interp, int32_t *osrel, uint32_t *fctl0);
  92 static int __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
  93     u_long *entry);
  94 static int __elfN(load_section)(struct image_params *imgp, vm_ooffset_t offset,
  95     caddr_t vmaddr, size_t memsz, size_t filsz, vm_prot_t prot);
  96 static int __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp);
  97 static bool __elfN(freebsd_trans_osrel)(const Elf_Note *note,
  98     int32_t *osrel);
  99 static bool kfreebsd_trans_osrel(const Elf_Note *note, int32_t *osrel);
 100 static bool __elfN(check_note)(struct image_params *imgp,
 101     Elf_Brandnote *checknote, int32_t *osrel, bool *has_fctl0,
 102     uint32_t *fctl0);
 103 static vm_prot_t __elfN(trans_prot)(Elf_Word);
 104 static Elf_Word __elfN(untrans_prot)(vm_prot_t);
 105
 106 SYSCTL_NODE(_kern, OID_AUTO, __CONCAT(elf, __ELF_WORD_SIZE),
 107     CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
 108     "");
 109
 110 int __elfN(fallback_brand) = -1;
 111 SYSCTL_INT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO,
 112     fallback_brand, CTLFLAG_RWTUN, &__elfN(fallback_brand), 0,
 113     __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE)) " brand of last resort");
 114
 115 static int elf_legacy_coredump = 0;
 116 SYSCTL_INT(_debug, OID_AUTO, __elfN(legacy_coredump), CTLFLAG_RW,
 117     &elf_legacy_coredump, 0,
 118     "include all and only RW pages in core dumps");
 119
 120 int __elfN(nxstack) =
 121 #if defined(__amd64__) || defined(__powerpc64__) /* both 64 and 32 bit */ || \
 122     (defined(__arm__) && __ARM_ARCH >= 7) || defined(__aarch64__) || \
 123     defined(__riscv)
 124         1;
 125 #else
 126         0;
 127 #endif
 128 SYSCTL_INT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO,
 129     nxstack, CTLFLAG_RW, &__elfN(nxstack), 0,
 130     __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE)) ": enable non-executable stack");
 131
 132 #if defined(__amd64__)
 133 static int __elfN(vdso) = 1;
 134 SYSCTL_INT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO,
 135     vdso, CTLFLAG_RWTUN, &__elfN(vdso), 0,
 136     __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE)) ": enable vdso preloading");
 137 #else
 138 static int __elfN(vdso) = 0;
 139 #endif
 140
 141 #if __ELF_WORD_SIZE == 32 && (defined(__amd64__) || defined(__i386__))
 142 int i386_read_exec = 0;
 143 SYSCTL_INT(_kern_elf32, OID_AUTO, read_exec, CTLFLAG_RW, &i386_read_exec, 0,
 144     "enable execution from readable segments");
 145 #endif
 146
 147 static u_long __elfN(pie_base) = ET_DYN_LOAD_ADDR;
 148 static int
 149 sysctl_pie_base(SYSCTL_HANDLER_ARGS)
 150 {
 151         u_long val;
 152         int error;
 153
 154         val = __elfN(pie_base);
 155         error = sysctl_handle_long(oidp, &val, 0, req);
 156         if (error != 0 || req->newptr == NULL)
 157                 return (error);
 158         if ((val & PAGE_MASK) != 0)
 159                 return (EINVAL);
 160         __elfN(pie_base) = val;
 161         return (0);
 162 }
 163 SYSCTL_PROC(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO, pie_base,
 164     CTLTYPE_ULONG | CTLFLAG_MPSAFE | CTLFLAG_RW, NULL, 0,
 165     sysctl_pie_base, "LU",
 166     "PIE load base without randomization");
 167
 168 SYSCTL_NODE(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO, aslr,
 169     CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
 170     "");
 171 #define ASLR_NODE_OID   __CONCAT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), _aslr)
 172
 173 /*
 174  * While for 64-bit machines ASLR works properly, there are
 175  * still some problems when using 32-bit architectures. For this
 176  * reason ASLR is only enabled by default when running native
 177  * 64-bit non-PIE executables.
 178  */
 179 static int __elfN(aslr_enabled) = __ELF_WORD_SIZE == 64;
 180 SYSCTL_INT(ASLR_NODE_OID, OID_AUTO, enable, CTLFLAG_RWTUN,
 181     &__elfN(aslr_enabled), 0,
 182     __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE))
 183     ": enable address map randomization");
 184
 185 /*
 186  * Enable ASLR only for 64-bit PIE binaries by default.
 187  */
 188 static int __elfN(pie_aslr_enabled) = __ELF_WORD_SIZE == 64;
 189 SYSCTL_INT(ASLR_NODE_OID, OID_AUTO, pie_enable, CTLFLAG_RWTUN,
 190     &__elfN(pie_aslr_enabled), 0,
 191     __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE))
 192     ": enable address map randomization for PIE binaries");
 193
 194 /*
 195  * Sbrk is now deprecated and it can be assumed, that in most
 196  * cases it will not be used anyway. This setting is valid only
 197  * for the ASLR enabled and allows for utilizing the bss grow region.
 198  */
 199 static int __elfN(aslr_honor_sbrk) = 0;
 200 SYSCTL_INT(ASLR_NODE_OID, OID_AUTO, honor_sbrk, CTLFLAG_RW,
 201     &__elfN(aslr_honor_sbrk), 0,
 202     __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE)) ": assume sbrk is used");
 203
 204 static int __elfN(aslr_stack_gap) = 3;
 205 SYSCTL_INT(ASLR_NODE_OID, OID_AUTO, stack_gap, CTLFLAG_RW,
 206     &__elfN(aslr_stack_gap), 0,
 207     __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE))
 208     ": maximum percentage of main stack to waste on a random gap");
 209
 210 static int __elfN(sigfastblock) = 1;
 211 SYSCTL_INT(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO, sigfastblock,
 212     CTLFLAG_RWTUN, &__elfN(sigfastblock), 0,
 213     "enable sigfastblock for new processes");
 214
 215 static bool __elfN(allow_wx) = true;
 216 SYSCTL_BOOL(__CONCAT(_kern_elf, __ELF_WORD_SIZE), OID_AUTO, allow_wx,
 217     CTLFLAG_RWTUN, &__elfN(allow_wx), 0,
 218     "Allow pages to be mapped simultaneously writable and executable");
 219
 220 static Elf_Brandinfo *elf_brand_list[MAX_BRANDS];
 221
 222 #define aligned(a, t)   (rounddown2((u_long)(a), sizeof(t)) == (u_long)(a))
 223
 224 Elf_Brandnote __elfN(freebsd_brandnote) = {
 225         .hdr.n_namesz   = sizeof(FREEBSD_ABI_VENDOR),
 226         .hdr.n_descsz   = sizeof(int32_t),
 227         .hdr.n_type     = NT_FREEBSD_ABI_TAG,
 228         .vendor         = FREEBSD_ABI_VENDOR,
 229         .flags          = BN_TRANSLATE_OSREL,
 230         .trans_osrel    = __elfN(freebsd_trans_osrel)
 231 };
 232
 233 static bool
 234 __elfN(freebsd_trans_osrel)(const Elf_Note *note, int32_t *osrel)
 235 {
 236         uintptr_t p;
 237
 238         p = (uintptr_t)(note + 1);
 239         p += roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE);
 240         *osrel = *(const int32_t *)(p);
 241
 242         return (true);
 243 }
 244
 245 static const char GNU_ABI_VENDOR[] = "GNU";
 246 static int GNU_KFREEBSD_ABI_DESC = 3;
 247
 248 Elf_Brandnote __elfN(kfreebsd_brandnote) = {
 249         .hdr.n_namesz   = sizeof(GNU_ABI_VENDOR),
 250         .hdr.n_descsz   = 16,   /* XXX at least 16 */
 251         .hdr.n_type     = 1,
 252         .vendor         = GNU_ABI_VENDOR,
 253         .flags          = BN_TRANSLATE_OSREL,
 254         .trans_osrel    = kfreebsd_trans_osrel
 255 };
 256
 257 static bool
 258 kfreebsd_trans_osrel(const Elf_Note *note, int32_t *osrel)
 259 {
 260         const Elf32_Word *desc;
 261         uintptr_t p;
 262
 263         p = (uintptr_t)(note + 1);
 264         p += roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE);
 265
 266         desc = (const Elf32_Word *)p;
 267         if (desc[0] != GNU_KFREEBSD_ABI_DESC)
 268                 return (false);
 269
 270         /*
 271          * Debian GNU/kFreeBSD embed the earliest compatible kernel version
 272          * (__FreeBSD_version: <major><two digit minor>Rxx) in the LSB way.
 273          */
 274         *osrel = desc[1] * 100000 + desc[2] * 1000 + desc[3];
 275
 276         return (true);
 277 }
 278
 279 int
 280 __elfN(insert_brand_entry)(Elf_Brandinfo *entry)
 281 {
 282         int i;
 283
 284         for (i = 0; i < MAX_BRANDS; i++) {
 285                 if (elf_brand_list[i] == NULL) {
 286                         elf_brand_list[i] = entry;
 287                         break;
 288                 }
 289         }
 290         if (i == MAX_BRANDS) {
 291                 printf("WARNING: %s: could not insert brandinfo entry: %p\n",
 292                         __func__, entry);
 293                 return (-1);
 294         }
 295         return (0);
 296 }
 297
 298 int
 299 __elfN(remove_brand_entry)(Elf_Brandinfo *entry)
 300 {
 301         int i;
 302
 303         for (i = 0; i < MAX_BRANDS; i++) {
 304                 if (elf_brand_list[i] == entry) {
 305                         elf_brand_list[i] = NULL;
 306                         break;
 307                 }
 308         }
 309         if (i == MAX_BRANDS)
 310                 return (-1);
 311         return (0);
 312 }
 313
 314 bool
 315 __elfN(brand_inuse)(Elf_Brandinfo *entry)
 316 {
 317         struct proc *p;
 318         bool rval = false;
 319
 320         sx_slock(&allproc_lock);
 321         FOREACH_PROC_IN_SYSTEM(p) {
 322                 if (p->p_sysent == entry->sysvec) {
 323                         rval = true;
 324                         break;
 325                 }
 326         }
 327         sx_sunlock(&allproc_lock);
 328
 329         return (rval);
 330 }
 331
 332 static Elf_Brandinfo *
 333 __elfN(get_brandinfo)(struct image_params *imgp, const char *interp,
 334     int32_t *osrel, uint32_t *fctl0)
 335 {
 336         const Elf_Ehdr *hdr = (const Elf_Ehdr *)imgp->image_header;
 337         Elf_Brandinfo *bi, *bi_m;
 338         bool ret, has_fctl0;
 339         int i, interp_name_len;
 340
 341         interp_name_len = interp != NULL ? strlen(interp) + 1 : 0;
 342
 343         /*
 344          * We support four types of branding -- (1) the ELF EI_OSABI field
 345          * that SCO added to the ELF spec, (2) FreeBSD 3.x's traditional string
 346          * branding w/in the ELF header, (3) path of the `interp_path'
 347          * field, and (4) the ".note.ABI-tag" ELF section.
 348          */
 349
 350         /* Look for an ".note.ABI-tag" ELF section */
 351         bi_m = NULL;
 352         for (i = 0; i < MAX_BRANDS; i++) {
 353                 bi = elf_brand_list[i];
 354                 if (bi == NULL)
 355                         continue;
 356                 if (interp != NULL && (bi->flags & BI_BRAND_ONLY_STATIC) != 0)
 357                         continue;
 358                 if (hdr->e_machine == bi->machine && (bi->flags &
 359                     (BI_BRAND_NOTE|BI_BRAND_NOTE_MANDATORY)) != 0) {
 360                         has_fctl0 = false;
 361                         *fctl0 = 0;
 362                         *osrel = 0;
 363                         ret = __elfN(check_note)(imgp, bi->brand_note, osrel,
 364                             &has_fctl0, fctl0);
 365                         /* Give brand a chance to veto check_note's guess */
 366                         if (ret && bi->header_supported) {
 367                                 ret = bi->header_supported(imgp, osrel,
 368                                     has_fctl0 ? fctl0 : NULL);
 369                         }
 370                         /*
 371                          * If note checker claimed the binary, but the
 372                          * interpreter path in the image does not
 373                          * match default one for the brand, try to
 374                          * search for other brands with the same
 375                          * interpreter.  Either there is better brand
 376                          * with the right interpreter, or, failing
 377                          * this, we return first brand which accepted
 378                          * our note and, optionally, header.
 379                          */
 380                         if (ret && bi_m == NULL && interp != NULL &&
 381                             (bi->interp_path == NULL ||
 382                             (strlen(bi->interp_path) + 1 != interp_name_len ||
 383                             strncmp(interp, bi->interp_path, interp_name_len)
 384                             != 0))) {
 385                                 bi_m = bi;
 386                                 ret = 0;
 387                         }
 388                         if (ret)
 389                                 return (bi);
 390                 }
 391         }
 392         if (bi_m != NULL)
 393                 return (bi_m);
 394
 395         /* If the executable has a brand, search for it in the brand list. */
 396         for (i = 0; i < MAX_BRANDS; i++) {
 397                 bi = elf_brand_list[i];
 398                 if (bi == NULL || (bi->flags & BI_BRAND_NOTE_MANDATORY) != 0 ||
 399                     (interp != NULL && (bi->flags & BI_BRAND_ONLY_STATIC) != 0))
 400                         continue;
 401                 if (hdr->e_machine == bi->machine &&
 402                     (hdr->e_ident[EI_OSABI] == bi->brand ||
 403                     (bi->compat_3_brand != NULL &&
 404                     strcmp((const char *)&hdr->e_ident[OLD_EI_BRAND],
 405                     bi->compat_3_brand) == 0))) {
 406                         /* Looks good, but give brand a chance to veto */
 407                         if (bi->header_supported == NULL ||
 408                             bi->header_supported(imgp, NULL, NULL)) {
 409                                 /*
 410                                  * Again, prefer strictly matching
 411                                  * interpreter path.
 412                                  */
 413                                 if (interp_name_len == 0 &&
 414                                     bi->interp_path == NULL)
 415                                         return (bi);
 416                                 if (bi->interp_path != NULL &&
 417                                     strlen(bi->interp_path) + 1 ==
 418                                     interp_name_len && strncmp(interp,
 419                                     bi->interp_path, interp_name_len) == 0)
 420                                         return (bi);
 421                                 if (bi_m == NULL)
 422                                         bi_m = bi;
 423                         }
 424                 }
 425         }
 426         if (bi_m != NULL)
 427                 return (bi_m);
 428
 429         /* No known brand, see if the header is recognized by any brand */
 430         for (i = 0; i < MAX_BRANDS; i++) {
 431                 bi = elf_brand_list[i];
 432                 if (bi == NULL || bi->flags & BI_BRAND_NOTE_MANDATORY ||
 433                     bi->header_supported == NULL)
 434                         continue;
 435                 if (hdr->e_machine == bi->machine) {
 436                         ret = bi->header_supported(imgp, NULL, NULL);
 437                         if (ret)
 438                                 return (bi);
 439                 }
 440         }
 441
 442         /* Lacking a known brand, search for a recognized interpreter. */
 443         if (interp != NULL) {
 444                 for (i = 0; i < MAX_BRANDS; i++) {
 445                         bi = elf_brand_list[i];
 446                         if (bi == NULL || (bi->flags &
 447                             (BI_BRAND_NOTE_MANDATORY | BI_BRAND_ONLY_STATIC))
 448                             != 0)
 449                                 continue;
 450                         if (hdr->e_machine == bi->machine &&
 451                             bi->interp_path != NULL &&
 452                             /* ELF image p_filesz includes terminating zero */
 453                             strlen(bi->interp_path) + 1 == interp_name_len &&
 454                             strncmp(interp, bi->interp_path, interp_name_len)
 455                             == 0 && (bi->header_supported == NULL ||
 456                             bi->header_supported(imgp, NULL, NULL)))
 457                                 return (bi);
 458                 }
 459         }
 460
 461         /* Lacking a recognized interpreter, try the default brand */
 462         for (i = 0; i < MAX_BRANDS; i++) {
 463                 bi = elf_brand_list[i];
 464                 if (bi == NULL || (bi->flags & BI_BRAND_NOTE_MANDATORY) != 0 ||
 465                     (interp != NULL && (bi->flags & BI_BRAND_ONLY_STATIC) != 0))
 466                         continue;
 467                 if (hdr->e_machine == bi->machine &&
 468                     __elfN(fallback_brand) == bi->brand &&
 469                     (bi->header_supported == NULL ||
 470                     bi->header_supported(imgp, NULL, NULL)))
 471                         return (bi);
 472         }
 473         return (NULL);
 474 }
 475
 476 static bool
 477 __elfN(phdr_in_zero_page)(const Elf_Ehdr *hdr)
 478 {
 479         return (hdr->e_phoff <= PAGE_SIZE &&
 480             (u_int)hdr->e_phentsize * hdr->e_phnum <= PAGE_SIZE - hdr->e_phoff);
 481 }
 482
 483 static int
 484 __elfN(check_header)(const Elf_Ehdr *hdr)
 485 {
 486         Elf_Brandinfo *bi;
 487         int i;
 488
 489         if (!IS_ELF(*hdr) ||
 490             hdr->e_ident[EI_CLASS] != ELF_TARG_CLASS ||
 491             hdr->e_ident[EI_DATA] != ELF_TARG_DATA ||
 492             hdr->e_ident[EI_VERSION] != EV_CURRENT ||
 493             hdr->e_phentsize != sizeof(Elf_Phdr) ||
 494             hdr->e_version != ELF_TARG_VER)
 495                 return (ENOEXEC);
 496
 497         /*
 498          * Make sure we have at least one brand for this machine.
 499          */
 500
 501         for (i = 0; i < MAX_BRANDS; i++) {
 502                 bi = elf_brand_list[i];
 503                 if (bi != NULL && bi->machine == hdr->e_machine)
 504                         break;
 505         }
 506         if (i == MAX_BRANDS)
 507                 return (ENOEXEC);
 508
 509         return (0);
 510 }
 511
 512 static int
 513 __elfN(map_partial)(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
 514     vm_offset_t start, vm_offset_t end, vm_prot_t prot)
 515 {
 516         struct sf_buf *sf;
 517         int error;
 518         vm_offset_t off;
 519
 520         /*
 521          * Create the page if it doesn't exist yet. Ignore errors.
 522          */
 523         vm_map_fixed(map, NULL, 0, trunc_page(start), round_page(end) -
 524             trunc_page(start), VM_PROT_ALL, VM_PROT_ALL, MAP_CHECK_EXCL);
 525
 526         /*
 527          * Find the page from the underlying object.
 528          */
 529         if (object != NULL) {
 530                 sf = vm_imgact_map_page(object, offset);
 531                 if (sf == NULL)
 532                         return (KERN_FAILURE);
 533                 off = offset - trunc_page(offset);
 534                 error = copyout((caddr_t)sf_buf_kva(sf) + off, (caddr_t)start,
 535                     end - start);
 536                 vm_imgact_unmap_page(sf);
 537                 if (error != 0)
 538                         return (KERN_FAILURE);
 539         }
 540
 541         return (KERN_SUCCESS);
 542 }
 543
 544 static int
 545 __elfN(map_insert)(struct image_params *imgp, vm_map_t map, vm_object_t object,
 546     vm_ooffset_t offset, vm_offset_t start, vm_offset_t end, vm_prot_t prot,
 547     int cow)
 548 {
 549         struct sf_buf *sf;
 550         vm_offset_t off;
 551         vm_size_t sz;
 552         int error, locked, rv;
 553
 554         if (start != trunc_page(start)) {
 555                 rv = __elfN(map_partial)(map, object, offset, start,
 556                     round_page(start), prot);
 557                 if (rv != KERN_SUCCESS)
 558                         return (rv);
 559                 offset += round_page(start) - start;
 560                 start = round_page(start);
 561         }
 562         if (end != round_page(end)) {
 563                 rv = __elfN(map_partial)(map, object, offset +
 564                     trunc_page(end) - start, trunc_page(end), end, prot);
 565                 if (rv != KERN_SUCCESS)
 566                         return (rv);
 567                 end = trunc_page(end);
 568         }
 569         if (start >= end)
 570                 return (KERN_SUCCESS);
 571         if ((offset & PAGE_MASK) != 0) {
 572                 /*
 573                  * The mapping is not page aligned.  This means that we have
 574                  * to copy the data.
 575                  */
 576                 rv = vm_map_fixed(map, NULL, 0, start, end - start,
 577                     prot | VM_PROT_WRITE, VM_PROT_ALL, MAP_CHECK_EXCL);
 578                 if (rv != KERN_SUCCESS)
 579                         return (rv);
 580                 if (object == NULL)
 581                         return (KERN_SUCCESS);
 582                 for (; start < end; start += sz) {
 583                         sf = vm_imgact_map_page(object, offset);
 584                         if (sf == NULL)
 585                                 return (KERN_FAILURE);
 586                         off = offset - trunc_page(offset);
 587                         sz = end - start;
 588                         if (sz > PAGE_SIZE - off)
 589                                 sz = PAGE_SIZE - off;
 590                         error = copyout((caddr_t)sf_buf_kva(sf) + off,
 591                             (caddr_t)start, sz);
 592                         vm_imgact_unmap_page(sf);
 593                         if (error != 0)
 594                                 return (KERN_FAILURE);
 595                         offset += sz;
 596                 }
 597         } else {
 598                 vm_object_reference(object);
 599                 rv = vm_map_fixed(map, object, offset, start, end - start,
 600                     prot, VM_PROT_ALL, cow | MAP_CHECK_EXCL |
 601                     (object != NULL ? MAP_VN_EXEC : 0));
 602                 if (rv != KERN_SUCCESS) {
 603                         locked = VOP_ISLOCKED(imgp->vp);
 604                         VOP_UNLOCK(imgp->vp);
 605                         vm_object_deallocate(object);
 606                         vn_lock(imgp->vp, locked | LK_RETRY);
 607                         return (rv);
 608                 } else if (object != NULL) {
 609                         MPASS(imgp->vp->v_object == object);
 610                         VOP_SET_TEXT_CHECKED(imgp->vp);
 611                 }
 612         }
 613         return (KERN_SUCCESS);
 614 }
 615
 616 static int
 617 __elfN(load_section)(struct image_params *imgp, vm_ooffset_t offset,
 618     caddr_t vmaddr, size_t memsz, size_t filsz, vm_prot_t prot)
 619 {
 620         struct sf_buf *sf;
 621         size_t map_len;
 622         vm_map_t map;
 623         vm_object_t object;
 624         vm_offset_t map_addr;
 625         int error, rv, cow;
 626         size_t copy_len;
 627         vm_ooffset_t file_addr;
 628
 629         /*
 630          * It's necessary to fail if the filsz + offset taken from the
 631          * header is greater than the actual file pager object's size.
 632          * If we were to allow this, then the vm_map_find() below would
 633          * walk right off the end of the file object and into the ether.
 634          *
 635          * While I'm here, might as well check for something else that
 636          * is invalid: filsz cannot be greater than memsz.
 637          */
 638         if ((filsz != 0 && (off_t)filsz + offset > imgp->attr->va_size) ||
 639             filsz > memsz) {
 640                 uprintf("elf_load_section: truncated ELF file\n");
 641                 return (ENOEXEC);
 642         }
 643
 644         object = imgp->object;
 645         map = &imgp->proc->p_vmspace->vm_map;
 646         map_addr = trunc_page((vm_offset_t)vmaddr);
 647         file_addr = trunc_page(offset);
 648
 649         /*
 650          * We have two choices.  We can either clear the data in the last page
 651          * of an oversized mapping, or we can start the anon mapping a page
 652          * early and copy the initialized data into that first page.  We
 653          * choose the second.
 654          */
 655         if (filsz == 0)
 656                 map_len = 0;
 657         else if (memsz > filsz)
 658                 map_len = trunc_page(offset + filsz) - file_addr;
 659         else
 660                 map_len = round_page(offset + filsz) - file_addr;
 661
 662         if (map_len != 0) {
 663                 /* cow flags: don't dump readonly sections in core */
 664                 cow = MAP_COPY_ON_WRITE | MAP_PREFAULT |
 665                     (prot & VM_PROT_WRITE ? 0 : MAP_DISABLE_COREDUMP);
 666
 667                 rv = __elfN(map_insert)(imgp, map, object, file_addr,
 668                     map_addr, map_addr + map_len, prot, cow);
 669                 if (rv != KERN_SUCCESS)
 670                         return (EINVAL);
 671
 672                 /* we can stop now if we've covered it all */
 673                 if (memsz == filsz)
 674                         return (0);
 675         }
 676
 677         /*
 678          * We have to get the remaining bit of the file into the first part
 679          * of the oversized map segment.  This is normally because the .data
 680          * segment in the file is extended to provide bss.  It's a neat idea
 681          * to try and save a page, but it's a pain in the behind to implement.
 682          */
 683         copy_len = filsz == 0 ? 0 : (offset + filsz) - trunc_page(offset +
 684             filsz);
 685         map_addr = trunc_page((vm_offset_t)vmaddr + filsz);
 686         map_len = round_page((vm_offset_t)vmaddr + memsz) - map_addr;
 687
 688         /* This had damn well better be true! */
 689         if (map_len != 0) {
 690                 rv = __elfN(map_insert)(imgp, map, NULL, 0, map_addr,
 691                     map_addr + map_len, prot, 0);
 692                 if (rv != KERN_SUCCESS)
 693                         return (EINVAL);
 694         }
 695
 696         if (copy_len != 0) {
 697                 sf = vm_imgact_map_page(object, offset + filsz);
 698                 if (sf == NULL)
 699                         return (EIO);
 700
 701                 /* send the page fragment to user space */
 702                 error = copyout((caddr_t)sf_buf_kva(sf), (caddr_t)map_addr,
 703                     copy_len);
 704                 vm_imgact_unmap_page(sf);
 705                 if (error != 0)
 706                         return (error);
 707         }
 708
 709         /*
 710          * Remove write access to the page if it was only granted by map_insert
 711          * to allow copyout.
 712          */
 713         if ((prot & VM_PROT_WRITE) == 0)
 714                 vm_map_protect(map, trunc_page(map_addr), round_page(map_addr +
 715                     map_len), prot, 0, VM_MAP_PROTECT_SET_PROT);
 716
 717         return (0);
 718 }
 719
 720 static int
 721 __elfN(load_sections)(struct image_params *imgp, const Elf_Ehdr *hdr,
 722     const Elf_Phdr *phdr, u_long rbase, u_long *base_addrp)
 723 {
 724         vm_prot_t prot;
 725         u_long base_addr;
 726         bool first;
 727         int error, i;
 728
 729         ASSERT_VOP_LOCKED(imgp->vp, __func__);
 730
 731         base_addr = 0;
 732         first = true;
 733
 734         for (i = 0; i < hdr->e_phnum; i++) {
 735                 if (phdr[i].p_type != PT_LOAD || phdr[i].p_memsz == 0)
 736                         continue;
 737
 738                 /* Loadable segment */
 739                 prot = __elfN(trans_prot)(phdr[i].p_flags);
 740                 error = __elfN(load_section)(imgp, phdr[i].p_offset,
 741                     (caddr_t)(uintptr_t)phdr[i].p_vaddr + rbase,
 742                     phdr[i].p_memsz, phdr[i].p_filesz, prot);
 743                 if (error != 0)
 744                         return (error);
 745
 746                 /*
 747                  * Establish the base address if this is the first segment.
 748                  */
 749                 if (first) {
 750                         base_addr = trunc_page(phdr[i].p_vaddr + rbase);
 751                         first = false;
 752                 }
 753         }
 754
 755         if (base_addrp != NULL)
 756                 *base_addrp = base_addr;
 757
 758         return (0);
 759 }
 760
 761 /*
 762  * Load the file "file" into memory.  It may be either a shared object
 763  * or an executable.
 764  *
 765  * The "addr" reference parameter is in/out.  On entry, it specifies
 766  * the address where a shared object should be loaded.  If the file is
 767  * an executable, this value is ignored.  On exit, "addr" specifies
 768  * where the file was actually loaded.
 769  *
 770  * The "entry" reference parameter is out only.  On exit, it specifies
 771  * the entry point for the loaded file.
 772  */
 773 static int
 774 __elfN(load_file)(struct proc *p, const char *file, u_long *addr,
 775         u_long *entry)
 776 {
 777         struct {
 778                 struct nameidata nd;
 779                 struct vattr attr;
 780                 struct image_params image_params;
 781         } *tempdata;
 782         const Elf_Ehdr *hdr = NULL;
 783         const Elf_Phdr *phdr = NULL;
 784         struct nameidata *nd;
 785         struct vattr *attr;
 786         struct image_params *imgp;
 787         u_long rbase;
 788         u_long base_addr = 0;
 789         int error;
 790
 791 #ifdef CAPABILITY_MODE
 792         /*
 793          * XXXJA: This check can go away once we are sufficiently confident
 794          * that the checks in namei() are correct.
 795          */
 796         if (IN_CAPABILITY_MODE(curthread))
 797                 return (ECAPMODE);
 798 #endif
 799
 800         tempdata = malloc(sizeof(*tempdata), M_TEMP, M_WAITOK | M_ZERO);
 801         nd = &tempdata->nd;
 802         attr = &tempdata->attr;
 803         imgp = &tempdata->image_params;
 804
 805         /*
 806          * Initialize part of the common data
 807          */
 808         imgp->proc = p;
 809         imgp->attr = attr;
 810
 811         NDINIT(nd, LOOKUP, ISOPEN | FOLLOW | LOCKSHARED | LOCKLEAF,
 812             UIO_SYSSPACE, file);
 813         if ((error = namei(nd)) != 0) {
 814                 nd->ni_vp = NULL;
 815                 goto fail;
 816         }
 817         NDFREE(nd, NDF_ONLY_PNBUF);
 818         imgp->vp = nd->ni_vp;
 819
 820         /*
 821          * Check permissions, modes, uid, etc on the file, and "open" it.
 822          */
 823         error = exec_check_permissions(imgp);
 824         if (error)
 825                 goto fail;
 826
 827         error = exec_map_first_page(imgp);
 828         if (error)
 829                 goto fail;
 830
 831         imgp->object = nd->ni_vp->v_object;
 832
 833         hdr = (const Elf_Ehdr *)imgp->image_header;
 834         if ((error = __elfN(check_header)(hdr)) != 0)
 835                 goto fail;
 836         if (hdr->e_type == ET_DYN)
 837                 rbase = *addr;
 838         else if (hdr->e_type == ET_EXEC)
 839                 rbase = 0;
 840         else {
 841                 error = ENOEXEC;
 842                 goto fail;
 843         }
 844
 845         /* Only support headers that fit within first page for now      */
 846         if (!__elfN(phdr_in_zero_page)(hdr)) {
 847                 error = ENOEXEC;
 848                 goto fail;
 849         }
 850
 851         phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
 852         if (!aligned(phdr, Elf_Addr)) {
 853                 error = ENOEXEC;
 854                 goto fail;
 855         }
 856
 857         error = __elfN(load_sections)(imgp, hdr, phdr, rbase, &base_addr);
 858         if (error != 0)
 859                 goto fail;
 860
 861         *addr = base_addr;
 862         *entry = (unsigned long)hdr->e_entry + rbase;
 863
 864 fail:
 865         if (imgp->firstpage)
 866                 exec_unmap_first_page(imgp);
 867
 868         if (nd->ni_vp) {
 869                 if (imgp->textset)
 870                         VOP_UNSET_TEXT_CHECKED(nd->ni_vp);
 871                 vput(nd->ni_vp);
 872         }
 873         free(tempdata, M_TEMP);
 874
 875         return (error);
 876 }
 877
 878 /*
 879  * Select randomized valid address in the map map, between minv and
 880  * maxv, with specified alignment.  The [minv, maxv) range must belong
 881  * to the map.  Note that function only allocates the address, it is
 882  * up to caller to clamp maxv in a way that the final allocation
 883  * length fit into the map.
 884  *
 885  * Result is returned in *resp, error code indicates that arguments
 886  * did not pass sanity checks for overflow and range correctness.
 887  */
 888 static int
 889 __CONCAT(rnd_, __elfN(base))(vm_map_t map, u_long minv, u_long maxv,
 890     u_int align, u_long *resp)
 891 {
 892         u_long rbase, res;
 893
 894         MPASS(vm_map_min(map) <= minv);
 895
 896         if (minv >= maxv || minv + align >= maxv || maxv > vm_map_max(map)) {
 897                 uprintf("Invalid ELF segments layout\n");
 898                 return (ENOEXEC);
 899         }
 900
 901         arc4rand(&rbase, sizeof(rbase), 0);
 902         res = roundup(minv, (u_long)align) + rbase % (maxv - minv);
 903         res &= ~((u_long)align - 1);
 904         if (res >= maxv)
 905                 res -= align;
 906
 907         KASSERT(res >= minv,
 908             ("res %#lx < minv %#lx, maxv %#lx rbase %#lx",
 909             res, minv, maxv, rbase));
 910         KASSERT(res < maxv,
 911             ("res %#lx > maxv %#lx, minv %#lx rbase %#lx",
 912             res, maxv, minv, rbase));
 913
 914         *resp = res;
 915         return (0);
 916 }
 917
 918 static int
 919 __elfN(enforce_limits)(struct image_params *imgp, const Elf_Ehdr *hdr,
 920     const Elf_Phdr *phdr, u_long et_dyn_addr)
 921 {
 922         struct vmspace *vmspace;
 923         const char *err_str;
 924         u_long text_size, data_size, total_size, text_addr, data_addr;
 925         u_long seg_size, seg_addr;
 926         int i;
 927
 928         err_str = NULL;
 929         text_size = data_size = total_size = text_addr = data_addr = 0;
 930
 931         for (i = 0; i < hdr->e_phnum; i++) {
 932                 if (phdr[i].p_type != PT_LOAD || phdr[i].p_memsz == 0)
 933                         continue;
 934
 935                 seg_addr = trunc_page(phdr[i].p_vaddr + et_dyn_addr);
 936                 seg_size = round_page(phdr[i].p_memsz +
 937                     phdr[i].p_vaddr + et_dyn_addr - seg_addr);
 938
 939                 /*
 940                  * Make the largest executable segment the official
 941                  * text segment and all others data.
 942                  *
 943                  * Note that obreak() assumes that data_addr + data_size == end
 944                  * of data load area, and the ELF file format expects segments
 945                  * to be sorted by address.  If multiple data segments exist,
 946                  * the last one will be used.
 947                  */
 948
 949                 if ((phdr[i].p_flags & PF_X) != 0 && text_size < seg_size) {
 950                         text_size = seg_size;
 951                         text_addr = seg_addr;
 952                 } else {
 953                         data_size = seg_size;
 954                         data_addr = seg_addr;
 955                 }
 956                 total_size += seg_size;
 957         }
 958
 959         if (data_addr == 0 && data_size == 0) {
 960                 data_addr = text_addr;
 961                 data_size = text_size;
 962         }
 963
 964         /*
 965          * Check limits.  It should be safe to check the
 966          * limits after loading the segments since we do
 967          * not actually fault in all the segments pages.
 968          */
 969         PROC_LOCK(imgp->proc);
 970         if (data_size > lim_cur_proc(imgp->proc, RLIMIT_DATA))
 971                 err_str = "Data segment size exceeds process limit";
 972         else if (text_size > maxtsiz)
 973                 err_str = "Text segment size exceeds system limit";
 974         else if (total_size > lim_cur_proc(imgp->proc, RLIMIT_VMEM))
 975                 err_str = "Total segment size exceeds process limit";
 976         else if (racct_set(imgp->proc, RACCT_DATA, data_size) != 0)
 977                 err_str = "Data segment size exceeds resource limit";
 978         else if (racct_set(imgp->proc, RACCT_VMEM, total_size) != 0)
 979                 err_str = "Total segment size exceeds resource limit";
 980         PROC_UNLOCK(imgp->proc);
 981         if (err_str != NULL) {
 982                 uprintf("%s\n", err_str);
 983                 return (ENOMEM);
 984         }
 985
 986         vmspace = imgp->proc->p_vmspace;
 987         vmspace->vm_tsize = text_size >> PAGE_SHIFT;
 988         vmspace->vm_taddr = (caddr_t)(uintptr_t)text_addr;
 989         vmspace->vm_dsize = data_size >> PAGE_SHIFT;
 990         vmspace->vm_daddr = (caddr_t)(uintptr_t)data_addr;
 991
 992         return (0);
 993 }
 994
 995 static int
 996 __elfN(get_interp)(struct image_params *imgp, const Elf_Phdr *phdr,
 997     char **interpp, bool *free_interpp)
 998 {
 999         struct thread *td;
1000         char *interp;
1001         int error, interp_name_len;
1002
1003         KASSERT(phdr->p_type == PT_INTERP,
1004             ("%s: p_type %u != PT_INTERP", __func__, phdr->p_type));
1005         ASSERT_VOP_LOCKED(imgp->vp, __func__);
1006
1007         td = curthread;
1008
1009         /* Path to interpreter */
1010         if (phdr->p_filesz < 2 || phdr->p_filesz > MAXPATHLEN) {
1011                 uprintf("Invalid PT_INTERP\n");
1012                 return (ENOEXEC);
1013         }
1014
1015         interp_name_len = phdr->p_filesz;
1016         if (phdr->p_offset > PAGE_SIZE ||
1017             interp_name_len > PAGE_SIZE - phdr->p_offset) {
1018                 /*
1019                  * The vnode lock might be needed by the pagedaemon to
1020                  * clean pages owned by the vnode.  Do not allow sleep
1021                  * waiting for memory with the vnode locked, instead
1022                  * try non-sleepable allocation first, and if it
1023                  * fails, go to the slow path were we drop the lock
1024                  * and do M_WAITOK.  A text reference prevents
1025                  * modifications to the vnode content.
1026                  */
1027                 interp = malloc(interp_name_len + 1, M_TEMP, M_NOWAIT);
1028                 if (interp == NULL) {
1029                         VOP_UNLOCK(imgp->vp);
1030                         interp = malloc(interp_name_len + 1, M_TEMP, M_WAITOK);
1031                         vn_lock(imgp->vp, LK_SHARED | LK_RETRY);
1032                 }
1033
1034                 error = vn_rdwr(UIO_READ, imgp->vp, interp,
1035                     interp_name_len, phdr->p_offset,
1036                     UIO_SYSSPACE, IO_NODELOCKED, td->td_ucred,
1037                     NOCRED, NULL, td);
1038                 if (error != 0) {
1039                         free(interp, M_TEMP);
1040                         uprintf("i/o error PT_INTERP %d\n", error);
1041                         return (error);
1042                 }
1043                 interp[interp_name_len] = '\0';
1044
1045                 *interpp = interp;
1046                 *free_interpp = true;
1047                 return (0);
1048         }
1049
1050         interp = __DECONST(char *, imgp->image_header) + phdr->p_offset;
1051         if (interp[interp_name_len - 1] != '\0') {
1052                 uprintf("Invalid PT_INTERP\n");
1053                 return (ENOEXEC);
1054         }
1055
1056         *interpp = interp;
1057         *free_interpp = false;
1058         return (0);
1059 }
1060
1061 static int
1062 __elfN(load_interp)(struct image_params *imgp, const Elf_Brandinfo *brand_info,
1063     const char *interp, u_long *addr, u_long *entry)
1064 {
1065         char *path;
1066         int error;
1067
1068         if (brand_info->emul_path != NULL &&
1069             brand_info->emul_path[0] != '\0') {
1070                 path = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1071                 snprintf(path, MAXPATHLEN, "%s%s",
1072                     brand_info->emul_path, interp);
1073                 error = __elfN(load_file)(imgp->proc, path, addr, entry);
1074                 free(path, M_TEMP);
1075                 if (error == 0)
1076                         return (0);
1077         }
1078
1079         if (brand_info->interp_newpath != NULL &&
1080             (brand_info->interp_path == NULL ||
1081             strcmp(interp, brand_info->interp_path) == 0)) {
1082                 error = __elfN(load_file)(imgp->proc,
1083                     brand_info->interp_newpath, addr, entry);
1084                 if (error == 0)
1085                         return (0);
1086         }
1087
1088         error = __elfN(load_file)(imgp->proc, interp, addr, entry);
1089         if (error == 0)
1090                 return (0);
1091
1092         uprintf("ELF interpreter %s not found, error %d\n", interp, error);
1093         return (error);
1094 }
1095
1096 /*
1097  * Impossible et_dyn_addr initial value indicating that the real base
1098  * must be calculated later with some randomization applied.
1099  */
1100 #define ET_DYN_ADDR_RAND        1
1101
1102 static int
1103 __CONCAT(exec_, __elfN(imgact))(struct image_params *imgp)
1104 {
1105         struct thread *td;
1106         const Elf_Ehdr *hdr;
1107         const Elf_Phdr *phdr;
1108         Elf_Auxargs *elf_auxargs;
1109         struct vmspace *vmspace;
1110         vm_map_t map;
1111         char *interp;
1112         Elf_Brandinfo *brand_info;
1113         struct sysentvec *sv;
1114         u_long addr, baddr, et_dyn_addr, entry, proghdr;
1115         u_long maxalign, maxsalign, mapsz, maxv, maxv1;
1116         uint32_t fctl0;
1117         int32_t osrel;
1118         bool free_interp;
1119         int error, i, n;
1120
1121         hdr = (const Elf_Ehdr *)imgp->image_header;
1122
1123         /*
1124          * Do we have a valid ELF header ?
1125          *
1126          * Only allow ET_EXEC & ET_DYN here, reject ET_DYN later
1127          * if particular brand doesn't support it.
1128          */
1129         if (__elfN(check_header)(hdr) != 0 ||
1130             (hdr->e_type != ET_EXEC && hdr->e_type != ET_DYN))
1131                 return (-1);
1132
1133         /*
1134          * From here on down, we return an errno, not -1, as we've
1135          * detected an ELF file.
1136          */
1137
1138         if (!__elfN(phdr_in_zero_page)(hdr)) {
1139                 uprintf("Program headers not in the first page\n");
1140                 return (ENOEXEC);
1141         }
1142         phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
1143         if (!aligned(phdr, Elf_Addr)) {
1144                 uprintf("Unaligned program headers\n");
1145                 return (ENOEXEC);
1146         }
1147
1148         n = error = 0;
1149         baddr = 0;
1150         osrel = 0;
1151         fctl0 = 0;
1152         entry = proghdr = 0;
1153         interp = NULL;
1154         free_interp = false;
1155         td = curthread;
1156
1157         /*
1158          * Somewhat arbitrary, limit accepted max alignment for the
1159          * loadable segment to the max supported superpage size. Too
1160          * large alignment requests are not useful and are indicators
1161          * of corrupted or outright malicious binary.
1162          */
1163         maxalign = PAGE_SIZE;
1164         maxsalign = PAGE_SIZE * 1024;
1165         for (i = MAXPAGESIZES - 1; i > 0; i--) {
1166                 if (pagesizes[i] > maxsalign)
1167                         maxsalign = pagesizes[i];
1168         }
1169
1170         mapsz = 0;
1171
1172         for (i = 0; i < hdr->e_phnum; i++) {
1173                 switch (phdr[i].p_type) {
1174                 case PT_LOAD:
1175                         if (n == 0)
1176                                 baddr = phdr[i].p_vaddr;
1177                         if (!powerof2(phdr[i].p_align) ||
1178                             phdr[i].p_align > maxsalign) {
1179                                 uprintf("Invalid segment alignment\n");
1180                                 error = ENOEXEC;
1181                                 goto ret;
1182                         }
1183                         if (phdr[i].p_align > maxalign)
1184                                 maxalign = phdr[i].p_align;
1185                         mapsz += phdr[i].p_memsz;
1186                         n++;
1187
1188                         /*
1189                          * If this segment contains the program headers,
1190                          * remember their virtual address for the AT_PHDR
1191                          * aux entry. Static binaries don't usually include
1192                          * a PT_PHDR entry.
1193                          */
1194                         if (phdr[i].p_offset == 0 &&
1195                             hdr->e_phoff + hdr->e_phnum * hdr->e_phentsize <=
1196                             phdr[i].p_filesz)
1197                                 proghdr = phdr[i].p_vaddr + hdr->e_phoff;
1198                         break;
1199                 case PT_INTERP:
1200                         /* Path to interpreter */
1201                         if (interp != NULL) {
1202                                 uprintf("Multiple PT_INTERP headers\n");
1203                                 error = ENOEXEC;
1204                                 goto ret;
1205                         }
1206                         error = __elfN(get_interp)(imgp, &phdr[i], &interp,
1207                             &free_interp);
1208                         if (error != 0)
1209                                 goto ret;
1210                         break;
1211                 case PT_GNU_STACK:
1212                         if (__elfN(nxstack))
1213                                 imgp->stack_prot =
1214                                     __elfN(trans_prot)(phdr[i].p_flags);
1215                         imgp->stack_sz = phdr[i].p_memsz;
1216                         break;
1217                 case PT_PHDR:   /* Program header table info */
1218                         proghdr = phdr[i].p_vaddr;
1219                         break;
1220                 }
1221         }
1222
1223         brand_info = __elfN(get_brandinfo)(imgp, interp, &osrel, &fctl0);
1224         if (brand_info == NULL) {
1225                 uprintf("ELF binary type \"%u\" not known.\n",
1226                     hdr->e_ident[EI_OSABI]);
1227                 error = ENOEXEC;
1228                 goto ret;
1229         }
1230         sv = brand_info->sysvec;
1231         et_dyn_addr = 0;
1232         if (hdr->e_type == ET_DYN) {
1233                 if ((brand_info->flags & BI_CAN_EXEC_DYN) == 0) {
1234                         uprintf("Cannot execute shared object\n");
1235                         error = ENOEXEC;
1236                         goto ret;
1237                 }
1238                 /*
1239                  * Honour the base load address from the dso if it is
1240                  * non-zero for some reason.
1241                  */
1242                 if (baddr == 0) {
1243                         if ((sv->sv_flags & SV_ASLR) == 0 ||
1244                             (fctl0 & NT_FREEBSD_FCTL_ASLR_DISABLE) != 0)
1245                                 et_dyn_addr = __elfN(pie_base);
1246                         else if ((__elfN(pie_aslr_enabled) &&
1247                             (imgp->proc->p_flag2 & P2_ASLR_DISABLE) == 0) ||
1248                             (imgp->proc->p_flag2 & P2_ASLR_ENABLE) != 0)
1249                                 et_dyn_addr = ET_DYN_ADDR_RAND;
1250                         else
1251                                 et_dyn_addr = __elfN(pie_base);
1252                 }
1253         }
1254
1255         /*
1256          * Avoid a possible deadlock if the current address space is destroyed
1257          * and that address space maps the locked vnode.  In the common case,
1258          * the locked vnode's v_usecount is decremented but remains greater
1259          * than zero.  Consequently, the vnode lock is not needed by vrele().
1260          * However, in cases where the vnode lock is external, such as nullfs,
1261          * v_usecount may become zero.
1262          *
1263          * The VV_TEXT flag prevents modifications to the executable while
1264          * the vnode is unlocked.
1265          */
1266         VOP_UNLOCK(imgp->vp);
1267
1268         /*
1269          * Decide whether to enable randomization of user mappings.
1270          * First, reset user preferences for the setid binaries.
1271          * Then, account for the support of the randomization by the
1272          * ABI, by user preferences, and make special treatment for
1273          * PIE binaries.
1274          */
1275         if (imgp->credential_setid) {
1276                 PROC_LOCK(imgp->proc);
1277                 imgp->proc->p_flag2 &= ~(P2_ASLR_ENABLE | P2_ASLR_DISABLE |
1278                     P2_WXORX_DISABLE | P2_WXORX_ENABLE_EXEC);
1279                 PROC_UNLOCK(imgp->proc);
1280         }
1281         if ((sv->sv_flags & SV_ASLR) == 0 ||
1282             (imgp->proc->p_flag2 & P2_ASLR_DISABLE) != 0 ||
1283             (fctl0 & NT_FREEBSD_FCTL_ASLR_DISABLE) != 0) {
1284                 KASSERT(et_dyn_addr != ET_DYN_ADDR_RAND,
1285                     ("et_dyn_addr == RAND and !ASLR"));
1286         } else if ((imgp->proc->p_flag2 & P2_ASLR_ENABLE) != 0 ||
1287             (__elfN(aslr_enabled) && hdr->e_type == ET_EXEC) ||
1288             et_dyn_addr == ET_DYN_ADDR_RAND) {
1289                 imgp->map_flags |= MAP_ASLR;
1290                 /*
1291                  * If user does not care about sbrk, utilize the bss
1292                  * grow region for mappings as well.  We can select
1293                  * the base for the image anywere and still not suffer
1294                  * from the fragmentation.
1295                  */
1296                 if (!__elfN(aslr_honor_sbrk) ||
1297                     (imgp->proc->p_flag2 & P2_ASLR_IGNSTART) != 0)
1298                         imgp->map_flags |= MAP_ASLR_IGNSTART;
1299         }
1300
1301         if ((!__elfN(allow_wx) && (fctl0 & NT_FREEBSD_FCTL_WXNEEDED) == 0 &&
1302             (imgp->proc->p_flag2 & P2_WXORX_DISABLE) == 0) ||
1303             (imgp->proc->p_flag2 & P2_WXORX_ENABLE_EXEC) != 0)
1304                 imgp->map_flags |= MAP_WXORX;
1305
1306         error = exec_new_vmspace(imgp, sv);
1307         vmspace = imgp->proc->p_vmspace;
1308         map = &vmspace->vm_map;
1309
1310         imgp->proc->p_sysent = sv;
1311         imgp->proc->p_elf_brandinfo = brand_info;
1312
1313         maxv = vm_map_max(map) - lim_max(td, RLIMIT_STACK);
1314         if (error == 0 && et_dyn_addr == ET_DYN_ADDR_RAND) {
1315                 KASSERT((map->flags & MAP_ASLR) != 0,
1316                     ("ET_DYN_ADDR_RAND but !MAP_ASLR"));
1317                 error = __CONCAT(rnd_, __elfN(base))(map,
1318                     vm_map_min(map) + mapsz + lim_max(td, RLIMIT_DATA),
1319                     /* reserve half of the address space to interpreter */
1320                     maxv / 2, maxalign, &et_dyn_addr);
1321         }
1322
1323         vn_lock(imgp->vp, LK_SHARED | LK_RETRY);
1324         if (error != 0)
1325                 goto ret;
1326
1327         error = __elfN(load_sections)(imgp, hdr, phdr, et_dyn_addr, NULL);
1328         if (error != 0)
1329                 goto ret;
1330
1331         error = __elfN(enforce_limits)(imgp, hdr, phdr, et_dyn_addr);
1332         if (error != 0)
1333                 goto ret;
1334
1335         entry = (u_long)hdr->e_entry + et_dyn_addr;
1336
1337         /*
1338          * We load the dynamic linker where a userland call
1339          * to mmap(0, ...) would put it.  The rationale behind this
1340          * calculation is that it leaves room for the heap to grow to
1341          * its maximum allowed size.
1342          */
1343         addr = round_page((vm_offset_t)vmspace->vm_daddr + lim_max(td,
1344             RLIMIT_DATA));
1345         if ((map->flags & MAP_ASLR) != 0) {
1346                 maxv1 = maxv / 2 + addr / 2;
1347                 error = __CONCAT(rnd_, __elfN(base))(map, addr, maxv1,
1348                     (MAXPAGESIZES > 1 && pagesizes[1] != 0) ?
1349                     pagesizes[1] : pagesizes[0], &map->anon_loc);
1350                 if (error != 0)
1351                         goto ret;
1352         } else {
1353                 map->anon_loc = addr;
1354         }
1355
1356         imgp->entry_addr = entry;
1357
1358         if (interp != NULL) {
1359                 VOP_UNLOCK(imgp->vp);
1360                 if ((map->flags & MAP_ASLR) != 0) {
1361                         /* Assume that interpreter fits into 1/4 of AS */
1362                         maxv1 = maxv / 2 + addr / 2;
1363                         error = __CONCAT(rnd_, __elfN(base))(map, addr,
1364                             maxv1, PAGE_SIZE, &addr);
1365                 }
1366                 if (error == 0) {
1367                         error = __elfN(load_interp)(imgp, brand_info, interp,
1368                             &addr, &imgp->entry_addr);
1369                 }
1370                 vn_lock(imgp->vp, LK_SHARED | LK_RETRY);
1371                 if (error != 0)
1372                         goto ret;
1373         } else
1374                 addr = et_dyn_addr;
1375
1376         /*
1377          * Construct auxargs table (used by the copyout_auxargs routine)
1378          */
1379         elf_auxargs = malloc(sizeof(Elf_Auxargs), M_TEMP, M_NOWAIT);
1380         if (elf_auxargs == NULL) {
1381                 VOP_UNLOCK(imgp->vp);
1382                 elf_auxargs = malloc(sizeof(Elf_Auxargs), M_TEMP, M_WAITOK);
1383                 vn_lock(imgp->vp, LK_SHARED | LK_RETRY);
1384         }
1385         elf_auxargs->execfd = -1;
1386         elf_auxargs->phdr = proghdr + et_dyn_addr;
1387         elf_auxargs->phent = hdr->e_phentsize;
1388         elf_auxargs->phnum = hdr->e_phnum;
1389         elf_auxargs->pagesz = PAGE_SIZE;
1390         elf_auxargs->base = addr;
1391         elf_auxargs->flags = 0;
1392         elf_auxargs->entry = entry;
1393         elf_auxargs->hdr_eflags = hdr->e_flags;
1394
1395         imgp->auxargs = elf_auxargs;
1396         imgp->interpreted = 0;
1397         imgp->reloc_base = addr;
1398         imgp->proc->p_osrel = osrel;
1399         imgp->proc->p_fctl0 = fctl0;
1400         imgp->proc->p_elf_flags = hdr->e_flags;
1401
1402 ret:
1403         ASSERT_VOP_LOCKED(imgp->vp, "skipped relock");
1404         if (free_interp)
1405                 free(interp, M_TEMP);
1406         return (error);
1407 }
1408
1409 #define elf_suword __CONCAT(suword, __ELF_WORD_SIZE)
1410
1411 int
1412 __elfN(freebsd_copyout_auxargs)(struct image_params *imgp, uintptr_t base)
1413 {
1414         Elf_Auxargs *args = (Elf_Auxargs *)imgp->auxargs;
1415         Elf_Auxinfo *argarray, *pos;
1416         int error;
1417
1418         argarray = pos = malloc(AT_COUNT * sizeof(*pos), M_TEMP,
1419             M_WAITOK | M_ZERO);
1420
1421         if (args->execfd != -1)
1422                 AUXARGS_ENTRY(pos, AT_EXECFD, args->execfd);
1423         AUXARGS_ENTRY(pos, AT_PHDR, args->phdr);
1424         AUXARGS_ENTRY(pos, AT_PHENT, args->phent);
1425         AUXARGS_ENTRY(pos, AT_PHNUM, args->phnum);
1426         AUXARGS_ENTRY(pos, AT_PAGESZ, args->pagesz);
1427         AUXARGS_ENTRY(pos, AT_FLAGS, args->flags);
1428         AUXARGS_ENTRY(pos, AT_ENTRY, args->entry);
1429         AUXARGS_ENTRY(pos, AT_BASE, args->base);
1430         AUXARGS_ENTRY(pos, AT_EHDRFLAGS, args->hdr_eflags);
1431         if (imgp->execpathp != 0)
1432                 AUXARGS_ENTRY_PTR(pos, AT_EXECPATH, imgp->execpathp);
1433         AUXARGS_ENTRY(pos, AT_OSRELDATE,
1434             imgp->proc->p_ucred->cr_prison->pr_osreldate);
1435         if (imgp->canary != 0) {
1436                 AUXARGS_ENTRY_PTR(pos, AT_CANARY, imgp->canary);
1437                 AUXARGS_ENTRY(pos, AT_CANARYLEN, imgp->canarylen);
1438         }
1439         AUXARGS_ENTRY(pos, AT_NCPUS, mp_ncpus);
1440         if (imgp->pagesizes != 0) {
1441                 AUXARGS_ENTRY_PTR(pos, AT_PAGESIZES, imgp->pagesizes);
1442                 AUXARGS_ENTRY(pos, AT_PAGESIZESLEN, imgp->pagesizeslen);
1443         }
1444         if (imgp->sysent->sv_timekeep_base != 0) {
1445                 AUXARGS_ENTRY(pos, AT_TIMEKEEP,
1446                     imgp->sysent->sv_timekeep_base);
1447         }
1448         AUXARGS_ENTRY(pos, AT_STACKPROT, imgp->sysent->sv_shared_page_obj
1449             != NULL && imgp->stack_prot != 0 ? imgp->stack_prot :
1450             imgp->sysent->sv_stackprot);
1451         if (imgp->sysent->sv_hwcap != NULL)
1452                 AUXARGS_ENTRY(pos, AT_HWCAP, *imgp->sysent->sv_hwcap);
1453         if (imgp->sysent->sv_hwcap2 != NULL)
1454                 AUXARGS_ENTRY(pos, AT_HWCAP2, *imgp->sysent->sv_hwcap2);
1455         AUXARGS_ENTRY(pos, AT_BSDFLAGS, __elfN(sigfastblock) ?
1456             ELF_BSDF_SIGFASTBLK : 0);
1457         AUXARGS_ENTRY(pos, AT_ARGC, imgp->args->argc);
1458         AUXARGS_ENTRY_PTR(pos, AT_ARGV, imgp->argv);
1459         AUXARGS_ENTRY(pos, AT_ENVC, imgp->args->envc);
1460         AUXARGS_ENTRY_PTR(pos, AT_ENVV, imgp->envv);
1461         AUXARGS_ENTRY_PTR(pos, AT_PS_STRINGS, imgp->ps_strings);
1462         if (imgp->sysent->sv_fxrng_gen_base != 0)
1463                 AUXARGS_ENTRY(pos, AT_FXRNG, imgp->sysent->sv_fxrng_gen_base);
1464         if (imgp->sysent->sv_vdso_base != 0 && __elfN(vdso) != 0)
1465                 AUXARGS_ENTRY(pos, AT_KPRELOAD, imgp->sysent->sv_vdso_base);
1466         AUXARGS_ENTRY(pos, AT_NULL, 0);
1467
1468         free(imgp->auxargs, M_TEMP);
1469         imgp->auxargs = NULL;
1470         KASSERT(pos - argarray <= AT_COUNT, ("Too many auxargs"));
1471
1472         error = copyout(argarray, (void *)base, sizeof(*argarray) * AT_COUNT);
1473         free(argarray, M_TEMP);
1474         return (error);
1475 }
1476
1477 int
1478 __elfN(freebsd_fixup)(uintptr_t *stack_base, struct image_params *imgp)
1479 {
1480         Elf_Addr *base;
1481
1482         base = (Elf_Addr *)*stack_base;
1483         base--;
1484         if (elf_suword(base, imgp->args->argc) == -1)
1485                 return (EFAULT);
1486         *stack_base = (uintptr_t)base;
1487         return (0);
1488 }
1489
1490 /*
1491  * Code for generating ELF core dumps.
1492  */
1493
1494 typedef void (*segment_callback)(vm_map_entry_t, void *);
1495
1496 /* Closure for cb_put_phdr(). */
1497 struct phdr_closure {
1498         Elf_Phdr *phdr;         /* Program header to fill in */
1499         Elf_Off offset;         /* Offset of segment in core file */
1500 };
1501
1502 struct note_info {
1503         int             type;           /* Note type. */
1504         outfunc_t       outfunc;        /* Output function. */
1505         void            *outarg;        /* Argument for the output function. */
1506         size_t          outsize;        /* Output size. */
1507         TAILQ_ENTRY(note_info) link;    /* Link to the next note info. */
1508 };
1509
1510 TAILQ_HEAD(note_info_list, note_info);
1511
1512 extern int compress_user_cores;
1513 extern int compress_user_cores_level;
1514
1515 static void cb_put_phdr(vm_map_entry_t, void *);
1516 static void cb_size_segment(vm_map_entry_t, void *);
1517 static void each_dumpable_segment(struct thread *, segment_callback, void *,
1518     int);
1519 static int __elfN(corehdr)(struct coredump_params *, int, void *, size_t,
1520     struct note_info_list *, size_t, int);
1521 static void __elfN(putnote)(struct thread *td, struct note_info *, struct sbuf *);
1522
1523 static void __elfN(note_fpregset)(void *, struct sbuf *, size_t *);
1524 static void __elfN(note_prpsinfo)(void *, struct sbuf *, size_t *);
1525 static void __elfN(note_prstatus)(void *, struct sbuf *, size_t *);
1526 static void __elfN(note_threadmd)(void *, struct sbuf *, size_t *);
1527 static void __elfN(note_thrmisc)(void *, struct sbuf *, size_t *);
1528 static void __elfN(note_ptlwpinfo)(void *, struct sbuf *, size_t *);
1529 static void __elfN(note_procstat_auxv)(void *, struct sbuf *, size_t *);
1530 static void __elfN(note_procstat_proc)(void *, struct sbuf *, size_t *);
1531 static void __elfN(note_procstat_psstrings)(void *, struct sbuf *, size_t *);
1532 static void note_procstat_files(void *, struct sbuf *, size_t *);
1533 static void note_procstat_groups(void *, struct sbuf *, size_t *);
1534 static void note_procstat_osrel(void *, struct sbuf *, size_t *);
1535 static void note_procstat_rlimit(void *, struct sbuf *, size_t *);
1536 static void note_procstat_umask(void *, struct sbuf *, size_t *);
1537 static void note_procstat_vmmap(void *, struct sbuf *, size_t *);
1538
1539 static int
1540 core_compressed_write(void *base, size_t len, off_t offset, void *arg)
1541 {
1542
1543         return (core_write((struct coredump_params *)arg, base, len, offset,
1544             UIO_SYSSPACE, NULL));
1545 }
1546
1547 int
1548 __elfN(coredump)(struct thread *td, struct vnode *vp, off_t limit, int flags)
1549 {
1550         struct ucred *cred = td->td_ucred;
1551         int compm, error = 0;
1552         struct sseg_closure seginfo;
1553         struct note_info_list notelst;
1554         struct coredump_params params;
1555         struct note_info *ninfo;
1556         void *hdr, *tmpbuf;
1557         size_t hdrsize, notesz, coresize;
1558
1559         hdr = NULL;
1560         tmpbuf = NULL;
1561         TAILQ_INIT(&notelst);
1562
1563         /* Size the program segments. */
1564         __elfN(size_segments)(td, &seginfo, flags);
1565
1566         /*
1567          * Collect info about the core file header area.
1568          */
1569         hdrsize = sizeof(Elf_Ehdr) + sizeof(Elf_Phdr) * (1 + seginfo.count);
1570         if (seginfo.count + 1 >= PN_XNUM)
1571                 hdrsize += sizeof(Elf_Shdr);
1572         td->td_proc->p_sysent->sv_elf_core_prepare_notes(td, &notelst, &notesz);
1573         coresize = round_page(hdrsize + notesz) + seginfo.size;
1574
1575         /* Set up core dump parameters. */
1576         params.offset = 0;
1577         params.active_cred = cred;
1578         params.file_cred = NOCRED;
1579         params.td = td;
1580         params.vp = vp;
1581         params.comp = NULL;
1582
1583 #ifdef RACCT
1584         if (racct_enable) {
1585                 PROC_LOCK(td->td_proc);
1586                 error = racct_add(td->td_proc, RACCT_CORE, coresize);
1587                 PROC_UNLOCK(td->td_proc);
1588                 if (error != 0) {
1589                         error = EFAULT;
1590                         goto done;
1591                 }
1592         }
1593 #endif
1594         if (coresize >= limit) {
1595                 error = EFAULT;
1596                 goto done;
1597         }
1598
1599         /* Create a compression stream if necessary. */
1600         compm = compress_user_cores;
1601         if ((flags & (SVC_PT_COREDUMP | SVC_NOCOMPRESS)) == SVC_PT_COREDUMP &&
1602             compm == 0)
1603                 compm = COMPRESS_GZIP;
1604         if (compm != 0) {
1605                 params.comp = compressor_init(core_compressed_write,
1606                     compm, CORE_BUF_SIZE,
1607                     compress_user_cores_level, &params);
1608                 if (params.comp == NULL) {
1609                         error = EFAULT;
1610                         goto done;
1611                 }
1612                 tmpbuf = malloc(CORE_BUF_SIZE, M_TEMP, M_WAITOK | M_ZERO);
1613         }
1614
1615         /*
1616          * Allocate memory for building the header, fill it up,
1617          * and write it out following the notes.
1618          */
1619         hdr = malloc(hdrsize, M_TEMP, M_WAITOK);
1620         error = __elfN(corehdr)(&params, seginfo.count, hdr, hdrsize, &notelst,
1621             notesz, flags);
1622
1623         /* Write the contents of all of the writable segments. */
1624         if (error == 0) {
1625                 Elf_Phdr *php;
1626                 off_t offset;
1627                 int i;
1628
1629                 php = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr)) + 1;
1630                 offset = round_page(hdrsize + notesz);
1631                 for (i = 0; i < seginfo.count; i++) {
1632                         error = core_output((char *)(uintptr_t)php->p_vaddr,
1633                             php->p_filesz, offset, &params, tmpbuf);
1634                         if (error != 0)
1635                                 break;
1636                         offset += php->p_filesz;
1637                         php++;
1638                 }
1639                 if (error == 0 && params.comp != NULL)
1640                         error = compressor_flush(params.comp);
1641         }
1642         if (error) {
1643                 log(LOG_WARNING,
1644                     "Failed to write core file for process %s (error %d)\n",
1645                     curproc->p_comm, error);
1646         }
1647
1648 done:
1649         free(tmpbuf, M_TEMP);
1650         if (params.comp != NULL)
1651                 compressor_fini(params.comp);
1652         while ((ninfo = TAILQ_FIRST(&notelst)) != NULL) {
1653                 TAILQ_REMOVE(&notelst, ninfo, link);
1654                 free(ninfo, M_TEMP);
1655         }
1656         if (hdr != NULL)
1657                 free(hdr, M_TEMP);
1658
1659         return (error);
1660 }
1661
1662 /*
1663  * A callback for each_dumpable_segment() to write out the segment's
1664  * program header entry.
1665  */
1666 static void
1667 cb_put_phdr(vm_map_entry_t entry, void *closure)
1668 {
1669         struct phdr_closure *phc = (struct phdr_closure *)closure;
1670         Elf_Phdr *phdr = phc->phdr;
1671
1672         phc->offset = round_page(phc->offset);
1673
1674         phdr->p_type = PT_LOAD;
1675         phdr->p_offset = phc->offset;
1676         phdr->p_vaddr = entry->start;
1677         phdr->p_paddr = 0;
1678         phdr->p_filesz = phdr->p_memsz = entry->end - entry->start;
1679         phdr->p_align = PAGE_SIZE;
1680         phdr->p_flags = __elfN(untrans_prot)(entry->protection);
1681
1682         phc->offset += phdr->p_filesz;
1683         phc->phdr++;
1684 }
1685
1686 /*
1687  * A callback for each_dumpable_segment() to gather information about
1688  * the number of segments and their total size.
1689  */
1690 static void
1691 cb_size_segment(vm_map_entry_t entry, void *closure)
1692 {
1693         struct sseg_closure *ssc = (struct sseg_closure *)closure;
1694
1695         ssc->count++;
1696         ssc->size += entry->end - entry->start;
1697 }
1698
1699 void
1700 __elfN(size_segments)(struct thread *td, struct sseg_closure *seginfo,
1701     int flags)
1702 {
1703         seginfo->count = 0;
1704         seginfo->size = 0;
1705
1706         each_dumpable_segment(td, cb_size_segment, seginfo, flags);
1707 }
1708
1709 /*
1710  * For each writable segment in the process's memory map, call the given
1711  * function with a pointer to the map entry and some arbitrary
1712  * caller-supplied data.
1713  */
1714 static void
1715 each_dumpable_segment(struct thread *td, segment_callback func, void *closure,
1716     int flags)
1717 {
1718         struct proc *p = td->td_proc;
1719         vm_map_t map = &p->p_vmspace->vm_map;
1720         vm_map_entry_t entry;
1721         vm_object_t backing_object, object;
1722         bool ignore_entry;
1723
1724         vm_map_lock_read(map);
1725         VM_MAP_ENTRY_FOREACH(entry, map) {
1726                 /*
1727                  * Don't dump inaccessible mappings, deal with legacy
1728                  * coredump mode.
1729                  *
1730                  * Note that read-only segments related to the elf binary
1731                  * are marked MAP_ENTRY_NOCOREDUMP now so we no longer
1732                  * need to arbitrarily ignore such segments.
1733                  */
1734                 if ((flags & SVC_ALL) == 0) {
1735                         if (elf_legacy_coredump) {
1736                                 if ((entry->protection & VM_PROT_RW) !=
1737                                     VM_PROT_RW)
1738                                         continue;
1739                         } else {
1740                                 if ((entry->protection & VM_PROT_ALL) == 0)
1741                                         continue;
1742                         }
1743                 }
1744
1745                 /*
1746                  * Dont include memory segment in the coredump if
1747                  * MAP_NOCORE is set in mmap(2) or MADV_NOCORE in
1748                  * madvise(2).  Do not dump submaps (i.e. parts of the
1749                  * kernel map).
1750                  */
1751                 if ((entry->eflags & MAP_ENTRY_IS_SUB_MAP) != 0)
1752                         continue;
1753                 if ((entry->eflags & MAP_ENTRY_NOCOREDUMP) != 0 &&
1754                     (flags & SVC_ALL) == 0)
1755                         continue;
1756                 if ((object = entry->object.vm_object) == NULL)
1757                         continue;
1758
1759                 /* Ignore memory-mapped devices and such things. */
1760                 VM_OBJECT_RLOCK(object);
1761                 while ((backing_object = object->backing_object) != NULL) {
1762                         VM_OBJECT_RLOCK(backing_object);
1763                         VM_OBJECT_RUNLOCK(object);
1764                         object = backing_object;
1765                 }
1766                 ignore_entry = (object->flags & OBJ_FICTITIOUS) != 0;
1767                 VM_OBJECT_RUNLOCK(object);
1768                 if (ignore_entry)
1769                         continue;
1770
1771                 (*func)(entry, closure);
1772         }
1773         vm_map_unlock_read(map);
1774 }
1775
1776 /*
1777  * Write the core file header to the file, including padding up to
1778  * the page boundary.
1779  */
1780 static int
1781 __elfN(corehdr)(struct coredump_params *p, int numsegs, void *hdr,
1782     size_t hdrsize, struct note_info_list *notelst, size_t notesz,
1783     int flags)
1784 {
1785         struct note_info *ninfo;
1786         struct sbuf *sb;
1787         int error;
1788
1789         /* Fill in the header. */
1790         bzero(hdr, hdrsize);
1791         __elfN(puthdr)(p->td, hdr, hdrsize, numsegs, notesz, flags);
1792
1793         sb = sbuf_new(NULL, NULL, CORE_BUF_SIZE, SBUF_FIXEDLEN);
1794         sbuf_set_drain(sb, sbuf_drain_core_output, p);
1795         sbuf_start_section(sb, NULL);
1796         sbuf_bcat(sb, hdr, hdrsize);
1797         TAILQ_FOREACH(ninfo, notelst, link)
1798             __elfN(putnote)(p->td, ninfo, sb);
1799         /* Align up to a page boundary for the program segments. */
1800         sbuf_end_section(sb, -1, PAGE_SIZE, 0);
1801         error = sbuf_finish(sb);
1802         sbuf_delete(sb);
1803
1804         return (error);
1805 }
1806
1807 void
1808 __elfN(prepare_notes)(struct thread *td, struct note_info_list *list,
1809     size_t *sizep)
1810 {
1811         struct proc *p;
1812         struct thread *thr;
1813         size_t size;
1814
1815         p = td->td_proc;
1816         size = 0;
1817
1818         size += __elfN(register_note)(td, list, NT_PRPSINFO, __elfN(note_prpsinfo), p);
1819
1820         /*
1821          * To have the debugger select the right thread (LWP) as the initial
1822          * thread, we dump the state of the thread passed to us in td first.
1823          * This is the thread that causes the core dump and thus likely to
1824          * be the right thread one wants to have selected in the debugger.
1825          */
1826         thr = td;
1827         while (thr != NULL) {
1828                 size += __elfN(register_note)(td, list, NT_PRSTATUS,
1829                     __elfN(note_prstatus), thr);
1830                 size += __elfN(register_note)(td, list, NT_FPREGSET,
1831                     __elfN(note_fpregset), thr);
1832                 size += __elfN(register_note)(td, list, NT_THRMISC,
1833                     __elfN(note_thrmisc), thr);
1834                 size += __elfN(register_note)(td, list, NT_PTLWPINFO,
1835                     __elfN(note_ptlwpinfo), thr);
1836                 size += __elfN(register_note)(td, list, -1,
1837                     __elfN(note_threadmd), thr);
1838
1839                 thr = thr == td ? TAILQ_FIRST(&p->p_threads) :
1840                     TAILQ_NEXT(thr, td_plist);
1841                 if (thr == td)
1842                         thr = TAILQ_NEXT(thr, td_plist);
1843         }
1844
1845         size += __elfN(register_note)(td, list, NT_PROCSTAT_PROC,
1846             __elfN(note_procstat_proc), p);
1847         size += __elfN(register_note)(td, list, NT_PROCSTAT_FILES,
1848             note_procstat_files, p);
1849         size += __elfN(register_note)(td, list, NT_PROCSTAT_VMMAP,
1850             note_procstat_vmmap, p);
1851         size += __elfN(register_note)(td, list, NT_PROCSTAT_GROUPS,
1852             note_procstat_groups, p);
1853         size += __elfN(register_note)(td, list, NT_PROCSTAT_UMASK,
1854             note_procstat_umask, p);
1855         size += __elfN(register_note)(td, list, NT_PROCSTAT_RLIMIT,
1856             note_procstat_rlimit, p);
1857         size += __elfN(register_note)(td, list, NT_PROCSTAT_OSREL,
1858             note_procstat_osrel, p);
1859         size += __elfN(register_note)(td, list, NT_PROCSTAT_PSSTRINGS,
1860             __elfN(note_procstat_psstrings), p);
1861         size += __elfN(register_note)(td, list, NT_PROCSTAT_AUXV,
1862             __elfN(note_procstat_auxv), p);
1863
1864         *sizep = size;
1865 }
1866
1867 void
1868 __elfN(puthdr)(struct thread *td, void *hdr, size_t hdrsize, int numsegs,
1869     size_t notesz, int flags)
1870 {
1871         Elf_Ehdr *ehdr;
1872         Elf_Phdr *phdr;
1873         Elf_Shdr *shdr;
1874         struct phdr_closure phc;
1875         Elf_Brandinfo *bi;
1876
1877         ehdr = (Elf_Ehdr *)hdr;
1878         bi = td->td_proc->p_elf_brandinfo;
1879
1880         ehdr->e_ident[EI_MAG0] = ELFMAG0;
1881         ehdr->e_ident[EI_MAG1] = ELFMAG1;
1882         ehdr->e_ident[EI_MAG2] = ELFMAG2;
1883         ehdr->e_ident[EI_MAG3] = ELFMAG3;
1884         ehdr->e_ident[EI_CLASS] = ELF_CLASS;
1885         ehdr->e_ident[EI_DATA] = ELF_DATA;
1886         ehdr->e_ident[EI_VERSION] = EV_CURRENT;
1887         ehdr->e_ident[EI_OSABI] = td->td_proc->p_sysent->sv_elf_core_osabi;
1888         ehdr->e_ident[EI_ABIVERSION] = 0;
1889         ehdr->e_ident[EI_PAD] = 0;
1890         ehdr->e_type = ET_CORE;
1891         ehdr->e_machine = bi->machine;
1892         ehdr->e_version = EV_CURRENT;
1893         ehdr->e_entry = 0;
1894         ehdr->e_phoff = sizeof(Elf_Ehdr);
1895         ehdr->e_flags = td->td_proc->p_elf_flags;
1896         ehdr->e_ehsize = sizeof(Elf_Ehdr);
1897         ehdr->e_phentsize = sizeof(Elf_Phdr);
1898         ehdr->e_shentsize = sizeof(Elf_Shdr);
1899         ehdr->e_shstrndx = SHN_UNDEF;
1900         if (numsegs + 1 < PN_XNUM) {
1901                 ehdr->e_phnum = numsegs + 1;
1902                 ehdr->e_shnum = 0;
1903         } else {
1904                 ehdr->e_phnum = PN_XNUM;
1905                 ehdr->e_shnum = 1;
1906
1907                 ehdr->e_shoff = ehdr->e_phoff +
1908                     (numsegs + 1) * ehdr->e_phentsize;
1909                 KASSERT(ehdr->e_shoff == hdrsize - sizeof(Elf_Shdr),
1910                     ("e_shoff: %zu, hdrsize - shdr: %zu",
1911                      (size_t)ehdr->e_shoff, hdrsize - sizeof(Elf_Shdr)));
1912
1913                 shdr = (Elf_Shdr *)((char *)hdr + ehdr->e_shoff);
1914                 memset(shdr, 0, sizeof(*shdr));
1915                 /*
1916                  * A special first section is used to hold large segment and
1917                  * section counts.  This was proposed by Sun Microsystems in
1918                  * Solaris and has been adopted by Linux; the standard ELF
1919                  * tools are already familiar with the technique.
1920                  *
1921                  * See table 7-7 of the Solaris "Linker and Libraries Guide"
1922                  * (or 12-7 depending on the version of the document) for more
1923                  * details.
1924                  */
1925                 shdr->sh_type = SHT_NULL;
1926                 shdr->sh_size = ehdr->e_shnum;
1927                 shdr->sh_link = ehdr->e_shstrndx;
1928                 shdr->sh_info = numsegs + 1;
1929         }
1930
1931         /*
1932          * Fill in the program header entries.
1933          */
1934         phdr = (Elf_Phdr *)((char *)hdr + ehdr->e_phoff);
1935
1936         /* The note segement. */
1937         phdr->p_type = PT_NOTE;
1938         phdr->p_offset = hdrsize;
1939         phdr->p_vaddr = 0;
1940         phdr->p_paddr = 0;
1941         phdr->p_filesz = notesz;
1942         phdr->p_memsz = 0;
1943         phdr->p_flags = PF_R;
1944         phdr->p_align = ELF_NOTE_ROUNDSIZE;
1945         phdr++;
1946
1947         /* All the writable segments from the program. */
1948         phc.phdr = phdr;
1949         phc.offset = round_page(hdrsize + notesz);
1950         each_dumpable_segment(td, cb_put_phdr, &phc, flags);
1951 }
1952
1953 size_t
1954 __elfN(register_note)(struct thread *td, struct note_info_list *list,
1955     int type, outfunc_t out, void *arg)
1956 {
1957         const struct sysentvec *sv;
1958         struct note_info *ninfo;
1959         size_t size, notesize;
1960
1961         sv = td->td_proc->p_sysent;
1962         size = 0;
1963         out(arg, NULL, &size);
1964         ninfo = malloc(sizeof(*ninfo), M_TEMP, M_ZERO | M_WAITOK);
1965         ninfo->type = type;
1966         ninfo->outfunc = out;
1967         ninfo->outarg = arg;
1968         ninfo->outsize = size;
1969         TAILQ_INSERT_TAIL(list, ninfo, link);
1970
1971         if (type == -1)
1972                 return (size);
1973
1974         notesize = sizeof(Elf_Note) +           /* note header */
1975             roundup2(strlen(sv->sv_elf_core_abi_vendor) + 1, ELF_NOTE_ROUNDSIZE) +
1976                                                 /* note name */
1977             roundup2(size, ELF_NOTE_ROUNDSIZE); /* note description */
1978
1979         return (notesize);
1980 }
1981
1982 static size_t
1983 append_note_data(const void *src, void *dst, size_t len)
1984 {
1985         size_t padded_len;
1986
1987         padded_len = roundup2(len, ELF_NOTE_ROUNDSIZE);
1988         if (dst != NULL) {
1989                 bcopy(src, dst, len);
1990                 bzero((char *)dst + len, padded_len - len);
1991         }
1992         return (padded_len);
1993 }
1994
1995 size_t
1996 __elfN(populate_note)(int type, void *src, void *dst, size_t size, void **descp)
1997 {
1998         Elf_Note *note;
1999         char *buf;
2000         size_t notesize;
2001
2002         buf = dst;
2003         if (buf != NULL) {
2004                 note = (Elf_Note *)buf;
2005                 note->n_namesz = sizeof(FREEBSD_ABI_VENDOR);
2006                 note->n_descsz = size;
2007                 note->n_type = type;
2008                 buf += sizeof(*note);
2009                 buf += append_note_data(FREEBSD_ABI_VENDOR, buf,
2010                     sizeof(FREEBSD_ABI_VENDOR));
2011                 append_note_data(src, buf, size);
2012                 if (descp != NULL)
2013                         *descp = buf;
2014         }
2015
2016         notesize = sizeof(Elf_Note) +           /* note header */
2017             roundup2(sizeof(FREEBSD_ABI_VENDOR), ELF_NOTE_ROUNDSIZE) +
2018                                                 /* note name */
2019             roundup2(size, ELF_NOTE_ROUNDSIZE); /* note description */
2020
2021         return (notesize);
2022 }
2023
2024 static void
2025 __elfN(putnote)(struct thread *td, struct note_info *ninfo, struct sbuf *sb)
2026 {
2027         Elf_Note note;
2028         const struct sysentvec *sv;
2029         ssize_t old_len, sect_len;
2030         size_t new_len, descsz, i;
2031
2032         if (ninfo->type == -1) {
2033                 ninfo->outfunc(ninfo->outarg, sb, &ninfo->outsize);
2034                 return;
2035         }
2036
2037         sv = td->td_proc->p_sysent;
2038
2039         note.n_namesz = strlen(sv->sv_elf_core_abi_vendor) + 1;
2040         note.n_descsz = ninfo->outsize;
2041         note.n_type = ninfo->type;
2042
2043         sbuf_bcat(sb, &note, sizeof(note));
2044         sbuf_start_section(sb, &old_len);
2045         sbuf_bcat(sb, sv->sv_elf_core_abi_vendor,
2046             strlen(sv->sv_elf_core_abi_vendor) + 1);
2047         sbuf_end_section(sb, old_len, ELF_NOTE_ROUNDSIZE, 0);
2048         if (note.n_descsz == 0)
2049                 return;
2050         sbuf_start_section(sb, &old_len);
2051         ninfo->outfunc(ninfo->outarg, sb, &ninfo->outsize);
2052         sect_len = sbuf_end_section(sb, old_len, ELF_NOTE_ROUNDSIZE, 0);
2053         if (sect_len < 0)
2054                 return;
2055
2056         new_len = (size_t)sect_len;
2057         descsz = roundup(note.n_descsz, ELF_NOTE_ROUNDSIZE);
2058         if (new_len < descsz) {
2059                 /*
2060                  * It is expected that individual note emitters will correctly
2061                  * predict their expected output size and fill up to that size
2062                  * themselves, padding in a format-specific way if needed.
2063                  * However, in case they don't, just do it here with zeros.
2064                  */
2065                 for (i = 0; i < descsz - new_len; i++)
2066                         sbuf_putc(sb, 0);
2067         } else if (new_len > descsz) {
2068                 /*
2069                  * We can't always truncate sb -- we may have drained some
2070                  * of it already.
2071                  */
2072                 KASSERT(new_len == descsz, ("%s: Note type %u changed as we "
2073                     "read it (%zu > %zu).  Since it is longer than "
2074                     "expected, this coredump's notes are corrupt.  THIS "
2075                     "IS A BUG in the note_procstat routine for type %u.\n",
2076                     __func__, (unsigned)note.n_type, new_len, descsz,
2077                     (unsigned)note.n_type));
2078         }
2079 }
2080
2081 /*
2082  * Miscellaneous note out functions.
2083  */
2084
2085 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
2086 #include <compat/freebsd32/freebsd32.h>
2087 #include <compat/freebsd32/freebsd32_signal.h>
2088
2089 typedef struct prstatus32 elf_prstatus_t;
2090 typedef struct prpsinfo32 elf_prpsinfo_t;
2091 typedef struct fpreg32 elf_prfpregset_t;
2092 typedef struct fpreg32 elf_fpregset_t;
2093 typedef struct reg32 elf_gregset_t;
2094 typedef struct thrmisc32 elf_thrmisc_t;
2095 #define ELF_KERN_PROC_MASK      KERN_PROC_MASK32
2096 typedef struct kinfo_proc32 elf_kinfo_proc_t;
2097 typedef uint32_t elf_ps_strings_t;
2098 #else
2099 typedef prstatus_t elf_prstatus_t;
2100 typedef prpsinfo_t elf_prpsinfo_t;
2101 typedef prfpregset_t elf_prfpregset_t;
2102 typedef prfpregset_t elf_fpregset_t;
2103 typedef gregset_t elf_gregset_t;
2104 typedef thrmisc_t elf_thrmisc_t;
2105 #define ELF_KERN_PROC_MASK      0
2106 typedef struct kinfo_proc elf_kinfo_proc_t;
2107 typedef vm_offset_t elf_ps_strings_t;
2108 #endif
2109
2110 static void
2111 __elfN(note_prpsinfo)(void *arg, struct sbuf *sb, size_t *sizep)
2112 {
2113         struct sbuf sbarg;
2114         size_t len;
2115         char *cp, *end;
2116         struct proc *p;
2117         elf_prpsinfo_t *psinfo;
2118         int error;
2119
2120         p = arg;
2121         if (sb != NULL) {
2122                 KASSERT(*sizep == sizeof(*psinfo), ("invalid size"));
2123                 psinfo = malloc(sizeof(*psinfo), M_TEMP, M_ZERO | M_WAITOK);
2124                 psinfo->pr_version = PRPSINFO_VERSION;
2125                 psinfo->pr_psinfosz = sizeof(elf_prpsinfo_t);
2126                 strlcpy(psinfo->pr_fname, p->p_comm, sizeof(psinfo->pr_fname));
2127                 PROC_LOCK(p);
2128                 if (p->p_args != NULL) {
2129                         len = sizeof(psinfo->pr_psargs) - 1;
2130                         if (len > p->p_args->ar_length)
2131                                 len = p->p_args->ar_length;
2132                         memcpy(psinfo->pr_psargs, p->p_args->ar_args, len);
2133                         PROC_UNLOCK(p);
2134                         error = 0;
2135                 } else {
2136                         _PHOLD(p);
2137                         PROC_UNLOCK(p);
2138                         sbuf_new(&sbarg, psinfo->pr_psargs,
2139                             sizeof(psinfo->pr_psargs), SBUF_FIXEDLEN);
2140                         error = proc_getargv(curthread, p, &sbarg);
2141                         PRELE(p);
2142                         if (sbuf_finish(&sbarg) == 0)
2143                                 len = sbuf_len(&sbarg) - 1;
2144                         else
2145                                 len = sizeof(psinfo->pr_psargs) - 1;
2146                         sbuf_delete(&sbarg);
2147                 }
2148                 if (error || len == 0)
2149                         strlcpy(psinfo->pr_psargs, p->p_comm,
2150                             sizeof(psinfo->pr_psargs));
2151                 else {
2152                         KASSERT(len < sizeof(psinfo->pr_psargs),
2153                             ("len is too long: %zu vs %zu", len,
2154                             sizeof(psinfo->pr_psargs)));
2155                         cp = psinfo->pr_psargs;
2156                         end = cp + len - 1;
2157                         for (;;) {
2158                                 cp = memchr(cp, '\0', end - cp);
2159                                 if (cp == NULL)
2160                                         break;
2161                                 *cp = ' ';
2162                         }
2163                 }
2164                 psinfo->pr_pid = p->p_pid;
2165                 sbuf_bcat(sb, psinfo, sizeof(*psinfo));
2166                 free(psinfo, M_TEMP);
2167         }
2168         *sizep = sizeof(*psinfo);
2169 }
2170
2171 static void
2172 __elfN(note_prstatus)(void *arg, struct sbuf *sb, size_t *sizep)
2173 {
2174         struct thread *td;
2175         elf_prstatus_t *status;
2176
2177         td = arg;
2178         if (sb != NULL) {
2179                 KASSERT(*sizep == sizeof(*status), ("invalid size"));
2180                 status = malloc(sizeof(*status), M_TEMP, M_ZERO | M_WAITOK);
2181                 status->pr_version = PRSTATUS_VERSION;
2182                 status->pr_statussz = sizeof(elf_prstatus_t);
2183                 status->pr_gregsetsz = sizeof(elf_gregset_t);
2184                 status->pr_fpregsetsz = sizeof(elf_fpregset_t);
2185                 status->pr_osreldate = osreldate;
2186                 status->pr_cursig = td->td_proc->p_sig;
2187                 status->pr_pid = td->td_tid;
2188 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
2189                 fill_regs32(td, &status->pr_reg);
2190 #else
2191                 fill_regs(td, &status->pr_reg);
2192 #endif
2193                 sbuf_bcat(sb, status, sizeof(*status));
2194                 free(status, M_TEMP);
2195         }
2196         *sizep = sizeof(*status);
2197 }
2198
2199 static void
2200 __elfN(note_fpregset)(void *arg, struct sbuf *sb, size_t *sizep)
2201 {
2202         struct thread *td;
2203         elf_prfpregset_t *fpregset;
2204
2205         td = arg;
2206         if (sb != NULL) {
2207                 KASSERT(*sizep == sizeof(*fpregset), ("invalid size"));
2208                 fpregset = malloc(sizeof(*fpregset), M_TEMP, M_ZERO | M_WAITOK);
2209 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
2210                 fill_fpregs32(td, fpregset);
2211 #else
2212                 fill_fpregs(td, fpregset);
2213 #endif
2214                 sbuf_bcat(sb, fpregset, sizeof(*fpregset));
2215                 free(fpregset, M_TEMP);
2216         }
2217         *sizep = sizeof(*fpregset);
2218 }
2219
2220 static void
2221 __elfN(note_thrmisc)(void *arg, struct sbuf *sb, size_t *sizep)
2222 {
2223         struct thread *td;
2224         elf_thrmisc_t thrmisc;
2225
2226         td = arg;
2227         if (sb != NULL) {
2228                 KASSERT(*sizep == sizeof(thrmisc), ("invalid size"));
2229                 bzero(&thrmisc, sizeof(thrmisc));
2230                 strcpy(thrmisc.pr_tname, td->td_name);
2231                 sbuf_bcat(sb, &thrmisc, sizeof(thrmisc));
2232         }
2233         *sizep = sizeof(thrmisc);
2234 }
2235
2236 static void
2237 __elfN(note_ptlwpinfo)(void *arg, struct sbuf *sb, size_t *sizep)
2238 {
2239         struct thread *td;
2240         size_t size;
2241         int structsize;
2242 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
2243         struct ptrace_lwpinfo32 pl;
2244 #else
2245         struct ptrace_lwpinfo pl;
2246 #endif
2247
2248         td = arg;
2249         size = sizeof(structsize) + sizeof(pl);
2250         if (sb != NULL) {
2251                 KASSERT(*sizep == size, ("invalid size"));
2252                 structsize = sizeof(pl);
2253                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2254                 bzero(&pl, sizeof(pl));
2255                 pl.pl_lwpid = td->td_tid;
2256                 pl.pl_event = PL_EVENT_NONE;
2257                 pl.pl_sigmask = td->td_sigmask;
2258                 pl.pl_siglist = td->td_siglist;
2259                 if (td->td_si.si_signo != 0) {
2260                         pl.pl_event = PL_EVENT_SIGNAL;
2261                         pl.pl_flags |= PL_FLAG_SI;
2262 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
2263                         siginfo_to_siginfo32(&td->td_si, &pl.pl_siginfo);
2264 #else
2265                         pl.pl_siginfo = td->td_si;
2266 #endif
2267                 }
2268                 strcpy(pl.pl_tdname, td->td_name);
2269                 /* XXX TODO: supply more information in struct ptrace_lwpinfo*/
2270                 sbuf_bcat(sb, &pl, sizeof(pl));
2271         }
2272         *sizep = size;
2273 }
2274
2275 /*
2276  * Allow for MD specific notes, as well as any MD
2277  * specific preparations for writing MI notes.
2278  */
2279 static void
2280 __elfN(note_threadmd)(void *arg, struct sbuf *sb, size_t *sizep)
2281 {
2282         struct thread *td;
2283         void *buf;
2284         size_t size;
2285
2286         td = (struct thread *)arg;
2287         size = *sizep;
2288         if (size != 0 && sb != NULL)
2289                 buf = malloc(size, M_TEMP, M_ZERO | M_WAITOK);
2290         else
2291                 buf = NULL;
2292         size = 0;
2293         __elfN(dump_thread)(td, buf, &size);
2294         KASSERT(sb == NULL || *sizep == size, ("invalid size"));
2295         if (size != 0 && sb != NULL)
2296                 sbuf_bcat(sb, buf, size);
2297         free(buf, M_TEMP);
2298         *sizep = size;
2299 }
2300
2301 #ifdef KINFO_PROC_SIZE
2302 CTASSERT(sizeof(struct kinfo_proc) == KINFO_PROC_SIZE);
2303 #endif
2304
2305 static void
2306 __elfN(note_procstat_proc)(void *arg, struct sbuf *sb, size_t *sizep)
2307 {
2308         struct proc *p;
2309         size_t size;
2310         int structsize;
2311
2312         p = arg;
2313         size = sizeof(structsize) + p->p_numthreads *
2314             sizeof(elf_kinfo_proc_t);
2315
2316         if (sb != NULL) {
2317                 KASSERT(*sizep == size, ("invalid size"));
2318                 structsize = sizeof(elf_kinfo_proc_t);
2319                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2320                 sx_slock(&proctree_lock);
2321                 PROC_LOCK(p);
2322                 kern_proc_out(p, sb, ELF_KERN_PROC_MASK);
2323                 sx_sunlock(&proctree_lock);
2324         }
2325         *sizep = size;
2326 }
2327
2328 #ifdef KINFO_FILE_SIZE
2329 CTASSERT(sizeof(struct kinfo_file) == KINFO_FILE_SIZE);
2330 #endif
2331
2332 static void
2333 note_procstat_files(void *arg, struct sbuf *sb, size_t *sizep)
2334 {
2335         struct proc *p;
2336         size_t size, sect_sz, i;
2337         ssize_t start_len, sect_len;
2338         int structsize, filedesc_flags;
2339
2340         if (coredump_pack_fileinfo)
2341                 filedesc_flags = KERN_FILEDESC_PACK_KINFO;
2342         else
2343                 filedesc_flags = 0;
2344
2345         p = arg;
2346         structsize = sizeof(struct kinfo_file);
2347         if (sb == NULL) {
2348                 size = 0;
2349                 sb = sbuf_new(NULL, NULL, 128, SBUF_FIXEDLEN);
2350                 sbuf_set_drain(sb, sbuf_count_drain, &size);
2351                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2352                 PROC_LOCK(p);
2353                 kern_proc_filedesc_out(p, sb, -1, filedesc_flags);
2354                 sbuf_finish(sb);
2355                 sbuf_delete(sb);
2356                 *sizep = size;
2357         } else {
2358                 sbuf_start_section(sb, &start_len);
2359
2360                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2361                 PROC_LOCK(p);
2362                 kern_proc_filedesc_out(p, sb, *sizep - sizeof(structsize),
2363                     filedesc_flags);
2364
2365                 sect_len = sbuf_end_section(sb, start_len, 0, 0);
2366                 if (sect_len < 0)
2367                         return;
2368                 sect_sz = sect_len;
2369
2370                 KASSERT(sect_sz <= *sizep,
2371                     ("kern_proc_filedesc_out did not respect maxlen; "
2372                      "requested %zu, got %zu", *sizep - sizeof(structsize),
2373                      sect_sz - sizeof(structsize)));
2374
2375                 for (i = 0; i < *sizep - sect_sz && sb->s_error == 0; i++)
2376                         sbuf_putc(sb, 0);
2377         }
2378 }
2379
2380 #ifdef KINFO_VMENTRY_SIZE
2381 CTASSERT(sizeof(struct kinfo_vmentry) == KINFO_VMENTRY_SIZE);
2382 #endif
2383
2384 static void
2385 note_procstat_vmmap(void *arg, struct sbuf *sb, size_t *sizep)
2386 {
2387         struct proc *p;
2388         size_t size;
2389         int structsize, vmmap_flags;
2390
2391         if (coredump_pack_vmmapinfo)
2392                 vmmap_flags = KERN_VMMAP_PACK_KINFO;
2393         else
2394                 vmmap_flags = 0;
2395
2396         p = arg;
2397         structsize = sizeof(struct kinfo_vmentry);
2398         if (sb == NULL) {
2399                 size = 0;
2400                 sb = sbuf_new(NULL, NULL, 128, SBUF_FIXEDLEN);
2401                 sbuf_set_drain(sb, sbuf_count_drain, &size);
2402                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2403                 PROC_LOCK(p);
2404                 kern_proc_vmmap_out(p, sb, -1, vmmap_flags);
2405                 sbuf_finish(sb);
2406                 sbuf_delete(sb);
2407                 *sizep = size;
2408         } else {
2409                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2410                 PROC_LOCK(p);
2411                 kern_proc_vmmap_out(p, sb, *sizep - sizeof(structsize),
2412                     vmmap_flags);
2413         }
2414 }
2415
2416 static void
2417 note_procstat_groups(void *arg, struct sbuf *sb, size_t *sizep)
2418 {
2419         struct proc *p;
2420         size_t size;
2421         int structsize;
2422
2423         p = arg;
2424         size = sizeof(structsize) + p->p_ucred->cr_ngroups * sizeof(gid_t);
2425         if (sb != NULL) {
2426                 KASSERT(*sizep == size, ("invalid size"));
2427                 structsize = sizeof(gid_t);
2428                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2429                 sbuf_bcat(sb, p->p_ucred->cr_groups, p->p_ucred->cr_ngroups *
2430                     sizeof(gid_t));
2431         }
2432         *sizep = size;
2433 }
2434
2435 static void
2436 note_procstat_umask(void *arg, struct sbuf *sb, size_t *sizep)
2437 {
2438         struct proc *p;
2439         size_t size;
2440         int structsize;
2441
2442         p = arg;
2443         size = sizeof(structsize) + sizeof(p->p_pd->pd_cmask);
2444         if (sb != NULL) {
2445                 KASSERT(*sizep == size, ("invalid size"));
2446                 structsize = sizeof(p->p_pd->pd_cmask);
2447                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2448                 sbuf_bcat(sb, &p->p_pd->pd_cmask, sizeof(p->p_pd->pd_cmask));
2449         }
2450         *sizep = size;
2451 }
2452
2453 static void
2454 note_procstat_rlimit(void *arg, struct sbuf *sb, size_t *sizep)
2455 {
2456         struct proc *p;
2457         struct rlimit rlim[RLIM_NLIMITS];
2458         size_t size;
2459         int structsize, i;
2460
2461         p = arg;
2462         size = sizeof(structsize) + sizeof(rlim);
2463         if (sb != NULL) {
2464                 KASSERT(*sizep == size, ("invalid size"));
2465                 structsize = sizeof(rlim);
2466                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2467                 PROC_LOCK(p);
2468                 for (i = 0; i < RLIM_NLIMITS; i++)
2469                         lim_rlimit_proc(p, i, &rlim[i]);
2470                 PROC_UNLOCK(p);
2471                 sbuf_bcat(sb, rlim, sizeof(rlim));
2472         }
2473         *sizep = size;
2474 }
2475
2476 static void
2477 note_procstat_osrel(void *arg, struct sbuf *sb, size_t *sizep)
2478 {
2479         struct proc *p;
2480         size_t size;
2481         int structsize;
2482
2483         p = arg;
2484         size = sizeof(structsize) + sizeof(p->p_osrel);
2485         if (sb != NULL) {
2486                 KASSERT(*sizep == size, ("invalid size"));
2487                 structsize = sizeof(p->p_osrel);
2488                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2489                 sbuf_bcat(sb, &p->p_osrel, sizeof(p->p_osrel));
2490         }
2491         *sizep = size;
2492 }
2493
2494 static void
2495 __elfN(note_procstat_psstrings)(void *arg, struct sbuf *sb, size_t *sizep)
2496 {
2497         struct proc *p;
2498         elf_ps_strings_t ps_strings;
2499         size_t size;
2500         int structsize;
2501
2502         p = arg;
2503         size = sizeof(structsize) + sizeof(ps_strings);
2504         if (sb != NULL) {
2505                 KASSERT(*sizep == size, ("invalid size"));
2506                 structsize = sizeof(ps_strings);
2507 #if defined(COMPAT_FREEBSD32) && __ELF_WORD_SIZE == 32
2508                 ps_strings = PTROUT(p->p_sysent->sv_psstrings);
2509 #else
2510                 ps_strings = p->p_sysent->sv_psstrings;
2511 #endif
2512                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2513                 sbuf_bcat(sb, &ps_strings, sizeof(ps_strings));
2514         }
2515         *sizep = size;
2516 }
2517
2518 static void
2519 __elfN(note_procstat_auxv)(void *arg, struct sbuf *sb, size_t *sizep)
2520 {
2521         struct proc *p;
2522         size_t size;
2523         int structsize;
2524
2525         p = arg;
2526         if (sb == NULL) {
2527                 size = 0;
2528                 sb = sbuf_new(NULL, NULL, AT_COUNT * sizeof(Elf_Auxinfo),
2529                     SBUF_FIXEDLEN);
2530                 sbuf_set_drain(sb, sbuf_count_drain, &size);
2531                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2532                 PHOLD(p);
2533                 proc_getauxv(curthread, p, sb);
2534                 PRELE(p);
2535                 sbuf_finish(sb);
2536                 sbuf_delete(sb);
2537                 *sizep = size;
2538         } else {
2539                 structsize = sizeof(Elf_Auxinfo);
2540                 sbuf_bcat(sb, &structsize, sizeof(structsize));
2541                 PHOLD(p);
2542                 proc_getauxv(curthread, p, sb);
2543                 PRELE(p);
2544         }
2545 }
2546
2547 static bool
2548 __elfN(parse_notes)(struct image_params *imgp, Elf_Note *checknote,
2549     const char *note_vendor, const Elf_Phdr *pnote,
2550     bool (*cb)(const Elf_Note *, void *, bool *), void *cb_arg)
2551 {
2552         const Elf_Note *note, *note0, *note_end;
2553         const char *note_name;
2554         char *buf;
2555         int i, error;
2556         bool res;
2557
2558         /* We need some limit, might as well use PAGE_SIZE. */
2559         if (pnote == NULL || pnote->p_filesz > PAGE_SIZE)
2560                 return (false);
2561         ASSERT_VOP_LOCKED(imgp->vp, "parse_notes");
2562         if (pnote->p_offset > PAGE_SIZE ||
2563             pnote->p_filesz > PAGE_SIZE - pnote->p_offset) {
2564                 buf = malloc(pnote->p_filesz, M_TEMP, M_NOWAIT);
2565                 if (buf == NULL) {
2566                         VOP_UNLOCK(imgp->vp);
2567                         buf = malloc(pnote->p_filesz, M_TEMP, M_WAITOK);
2568                         vn_lock(imgp->vp, LK_SHARED | LK_RETRY);
2569                 }
2570                 error = vn_rdwr(UIO_READ, imgp->vp, buf, pnote->p_filesz,
2571                     pnote->p_offset, UIO_SYSSPACE, IO_NODELOCKED,
2572                     curthread->td_ucred, NOCRED, NULL, curthread);
2573                 if (error != 0) {
2574                         uprintf("i/o error PT_NOTE\n");
2575                         goto retf;
2576                 }
2577                 note = note0 = (const Elf_Note *)buf;
2578                 note_end = (const Elf_Note *)(buf + pnote->p_filesz);
2579         } else {
2580                 note = note0 = (const Elf_Note *)(imgp->image_header +
2581                     pnote->p_offset);
2582                 note_end = (const Elf_Note *)(imgp->image_header +
2583                     pnote->p_offset + pnote->p_filesz);
2584                 buf = NULL;
2585         }
2586         for (i = 0; i < 100 && note >= note0 && note < note_end; i++) {
2587                 if (!aligned(note, Elf32_Addr) || (const char *)note_end -
2588                     (const char *)note < sizeof(Elf_Note)) {
2589                         goto retf;
2590                 }
2591                 if (note->n_namesz != checknote->n_namesz ||
2592                     note->n_descsz != checknote->n_descsz ||
2593                     note->n_type != checknote->n_type)
2594                         goto nextnote;
2595                 note_name = (const char *)(note + 1);
2596                 if (note_name + checknote->n_namesz >=
2597                     (const char *)note_end || strncmp(note_vendor,
2598                     note_name, checknote->n_namesz) != 0)
2599                         goto nextnote;
2600
2601                 if (cb(note, cb_arg, &res))
2602                         goto ret;
2603 nextnote:
2604                 note = (const Elf_Note *)((const char *)(note + 1) +
2605                     roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE) +
2606                     roundup2(note->n_descsz, ELF_NOTE_ROUNDSIZE));
2607         }
2608 retf:
2609         res = false;
2610 ret:
2611         free(buf, M_TEMP);
2612         return (res);
2613 }
2614
2615 struct brandnote_cb_arg {
2616         Elf_Brandnote *brandnote;
2617         int32_t *osrel;
2618 };
2619
2620 static bool
2621 brandnote_cb(const Elf_Note *note, void *arg0, bool *res)
2622 {
2623         struct brandnote_cb_arg *arg;
2624
2625         arg = arg0;
2626
2627         /*
2628          * Fetch the osreldate for binary from the ELF OSABI-note if
2629          * necessary.
2630          */
2631         *res = (arg->brandnote->flags & BN_TRANSLATE_OSREL) != 0 &&
2632             arg->brandnote->trans_osrel != NULL ?
2633             arg->brandnote->trans_osrel(note, arg->osrel) : true;
2634
2635         return (true);
2636 }
2637
2638 static Elf_Note fctl_note = {
2639         .n_namesz = sizeof(FREEBSD_ABI_VENDOR),
2640         .n_descsz = sizeof(uint32_t),
2641         .n_type = NT_FREEBSD_FEATURE_CTL,
2642 };
2643
2644 struct fctl_cb_arg {
2645         bool *has_fctl0;
2646         uint32_t *fctl0;
2647 };
2648
2649 static bool
2650 note_fctl_cb(const Elf_Note *note, void *arg0, bool *res)
2651 {
2652         struct fctl_cb_arg *arg;
2653         const Elf32_Word *desc;
2654         uintptr_t p;
2655
2656         arg = arg0;
2657         p = (uintptr_t)(note + 1);
2658         p += roundup2(note->n_namesz, ELF_NOTE_ROUNDSIZE);
2659         desc = (const Elf32_Word *)p;
2660         *arg->has_fctl0 = true;
2661         *arg->fctl0 = desc[0];
2662         *res = true;
2663         return (true);
2664 }
2665
2666 /*
2667  * Try to find the appropriate ABI-note section for checknote, fetch
2668  * the osreldate and feature control flags for binary from the ELF
2669  * OSABI-note.  Only the first page of the image is searched, the same
2670  * as for headers.
2671  */
2672 static bool
2673 __elfN(check_note)(struct image_params *imgp, Elf_Brandnote *brandnote,
2674     int32_t *osrel, bool *has_fctl0, uint32_t *fctl0)
2675 {
2676         const Elf_Phdr *phdr;
2677         const Elf_Ehdr *hdr;
2678         struct brandnote_cb_arg b_arg;
2679         struct fctl_cb_arg f_arg;
2680         int i, j;
2681
2682         hdr = (const Elf_Ehdr *)imgp->image_header;
2683         phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
2684         b_arg.brandnote = brandnote;
2685         b_arg.osrel = osrel;
2686         f_arg.has_fctl0 = has_fctl0;
2687         f_arg.fctl0 = fctl0;
2688
2689         for (i = 0; i < hdr->e_phnum; i++) {
2690                 if (phdr[i].p_type == PT_NOTE && __elfN(parse_notes)(imgp,
2691                     &brandnote->hdr, brandnote->vendor, &phdr[i], brandnote_cb,
2692                     &b_arg)) {
2693                         for (j = 0; j < hdr->e_phnum; j++) {
2694                                 if (phdr[j].p_type == PT_NOTE &&
2695                                     __elfN(parse_notes)(imgp, &fctl_note,
2696                                     FREEBSD_ABI_VENDOR, &phdr[j],
2697                                     note_fctl_cb, &f_arg))
2698                                         break;
2699                         }
2700                         return (true);
2701                 }
2702         }
2703         return (false);
2704
2705 }
2706
2707 /*
2708  * Tell kern_execve.c about it, with a little help from the linker.
2709  */
2710 static struct execsw __elfN(execsw) = {
2711         .ex_imgact = __CONCAT(exec_, __elfN(imgact)),
2712         .ex_name = __XSTRING(__CONCAT(ELF, __ELF_WORD_SIZE))
2713 };
2714 EXEC_SET(__CONCAT(elf, __ELF_WORD_SIZE), __elfN(execsw));
2715
2716 static vm_prot_t
2717 __elfN(trans_prot)(Elf_Word flags)
2718 {
2719         vm_prot_t prot;
2720
2721         prot = 0;
2722         if (flags & PF_X)
2723                 prot |= VM_PROT_EXECUTE;
2724         if (flags & PF_W)
2725                 prot |= VM_PROT_WRITE;
2726         if (flags & PF_R)
2727                 prot |= VM_PROT_READ;
2728 #if __ELF_WORD_SIZE == 32 && (defined(__amd64__) || defined(__i386__))
2729         if (i386_read_exec && (flags & PF_R))
2730                 prot |= VM_PROT_EXECUTE;
2731 #endif
2732         return (prot);
2733 }
2734
2735 static Elf_Word
2736 __elfN(untrans_prot)(vm_prot_t prot)
2737 {
2738         Elf_Word flags;
2739
2740         flags = 0;
2741         if (prot & VM_PROT_EXECUTE)
2742                 flags |= PF_X;
2743         if (prot & VM_PROT_READ)
2744                 flags |= PF_R;
2745         if (prot & VM_PROT_WRITE)
2746                 flags |= PF_W;
2747         return (flags);
2748 }
2749
2750 vm_size_t
2751 __elfN(stackgap)(struct image_params *imgp, uintptr_t *stack_base)
2752 {
2753         uintptr_t range, rbase, gap;
2754         int pct;
2755
2756         pct = __elfN(aslr_stack_gap);
2757         if (pct == 0)
2758                 return (0);
2759         if (pct > 50)
2760                 pct = 50;
2761         range = imgp->eff_stack_sz * pct / 100;
2762         arc4rand(&rbase, sizeof(rbase), 0);
2763         gap = rbase % range;
2764         gap &= ~(sizeof(u_long) - 1);
2765         *stack_base -= gap;
2766         return (gap);
2767 }