sys/kern/imgact_elf.c

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