sys/kern/imgact_elf.c

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