sys/kern/imgact_elf.c

   1 /*-
   2  * Copyright (c) 1995-1996 Søren Schmidt
   3  * Copyright (c) 1996 Peter Wemm
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer
  11  *    in this position and unchanged.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software withough specific prior written permission
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * $FreeBSD: src/sys/kern/imgact_elf.c,v 1.73.2.13 2002/12/28 19:49:41 dillon Exp $
  30  * $DragonFly: src/sys/kern/imgact_elf.c,v 1.55 2008/08/17 17:21:36 nth Exp $
  31  */
  32
  33 #include <sys/param.h>
  34 #include <sys/exec.h>
  35 #include <sys/fcntl.h>
  36 #include <sys/file.h>
  37 #include <sys/imgact.h>
  38 #include <sys/imgact_elf.h>
  39 #include <sys/kernel.h>
  40 #include <sys/malloc.h>
  41 #include <sys/mman.h>
  42 #include <sys/systm.h>
  43 #include <sys/proc.h>
  44 #include <sys/nlookup.h>
  45 #include <sys/pioctl.h>
  46 #include <sys/procfs.h>
  47 #include <sys/resourcevar.h>
  48 #include <sys/signalvar.h>
  49 #include <sys/stat.h>
  50 #include <sys/syscall.h>
  51 #include <sys/sysctl.h>
  52 #include <sys/sysent.h>
  53 #include <sys/vnode.h>
  54 #include <sys/eventhandler.h>
  55
  56 #include <cpu/lwbuf.h>
  57
  58 #include <vm/vm.h>
  59 #include <vm/vm_kern.h>
  60 #include <vm/vm_param.h>
  61 #include <vm/pmap.h>
  62 #include <sys/lock.h>
  63 #include <vm/vm_map.h>
  64 #include <vm/vm_object.h>
  65 #include <vm/vm_extern.h>
  66
  67 #include <machine/elf.h>
  68 #include <machine/md_var.h>
  69 #include <sys/mount.h>
  70 #include <sys/ckpt.h>
  71 #define OLD_EI_BRAND    8
  72
  73 __ElfType(Brandinfo);
  74 __ElfType(Auxargs);
  75
  76 static int elf_check_header (const Elf_Ehdr *hdr);
  77 static int elf_freebsd_fixup (register_t **stack_base,
  78     struct image_params *imgp);
  79 static int elf_load_file (struct proc *p, const char *file, u_long *addr,
  80     u_long *entry);
  81 static int elf_load_section (struct proc *p,
  82     struct vmspace *vmspace, struct vnode *vp,
  83     vm_offset_t offset, caddr_t vmaddr, size_t memsz, size_t filsz,
  84     vm_prot_t prot);
  85 static int exec_elf_imgact (struct image_params *imgp);
  86
  87 static int elf_trace = 0;
  88 SYSCTL_INT(_debug, OID_AUTO, elf_trace, CTLFLAG_RW, &elf_trace, 0, "");
  89 static int elf_legacy_coredump = 0;
  90 SYSCTL_INT(_debug, OID_AUTO, elf_legacy_coredump, CTLFLAG_RW,
  91     &elf_legacy_coredump, 0, "");
  92
  93 static int dragonfly_match_abi_note(const Elf_Note *);
  94 static int freebsd_match_abi_note(const Elf_Note *);
  95
  96 static struct sysentvec elf_freebsd_sysvec = {
  97         SYS_MAXSYSCALL,
  98         sysent,
  99         -1,
 100         0,
 101         0,
 102         0,
 103         0,
 104         0,
 105         elf_freebsd_fixup,
 106         sendsig,
 107         sigcode,
 108         &szsigcode,
 109         0,
 110         "FreeBSD ELF",
 111         elf_coredump,
 112         NULL,
 113         MINSIGSTKSZ
 114 };
 115
 116 static Elf_Brandinfo freebsd_brand_info = {
 117                                                 ELFOSABI_FREEBSD,
 118                                                 "FreeBSD",
 119                                                 freebsd_match_abi_note,
 120                                                 "",
 121                                                 "/usr/libexec/ld-elf.so.1",
 122                                                 &elf_freebsd_sysvec
 123                                           };
 124
 125 static Elf_Brandinfo dragonfly_brand_info = {
 126                                                 ELFOSABI_NONE,
 127                                                 "DragonFly",
 128                                                 dragonfly_match_abi_note,
 129                                                 "",
 130                                                 "/usr/libexec/ld-elf.so.2",
 131                                                 &elf_freebsd_sysvec
 132                                           };
 133
 134 static Elf_Brandinfo *elf_brand_list[MAX_BRANDS] = {
 135                                                         &dragonfly_brand_info,
 136                                                         &freebsd_brand_info,
 137                                                         NULL, NULL, NULL,
 138                                                         NULL, NULL, NULL
 139                                                     };
 140
 141 static int
 142 freebsd_match_abi_note(const Elf_Note *abi_note)
 143 {
 144         const char *abi_name = (const char *)
 145             ((const uint8_t *)abi_note + sizeof(*abi_note));
 146
 147         if (abi_note->n_namesz != sizeof("FreeBSD"))
 148                 return(FALSE);
 149         if (memcmp(abi_name, "FreeBSD", sizeof("FreeBSD")))
 150                 return(FALSE);
 151         return(TRUE);
 152 }
 153
 154 static int
 155 dragonfly_match_abi_note(const Elf_Note *abi_note)
 156 {
 157         const char *abi_name = (const char *)
 158             ((const uint8_t *)abi_note + sizeof(*abi_note));
 159
 160         if (abi_note->n_namesz != sizeof("DragonFly"))
 161                 return(FALSE);
 162         if (memcmp(abi_name, "DragonFly", sizeof("DragonFly")))
 163                 return(FALSE);
 164         return(TRUE);
 165 }
 166
 167 int
 168 elf_insert_brand_entry(Elf_Brandinfo *entry)
 169 {
 170         int i;
 171
 172         for (i=1; i<MAX_BRANDS; i++) {
 173                 if (elf_brand_list[i] == NULL) {
 174                         elf_brand_list[i] = entry;
 175                         break;
 176                 }
 177         }
 178         if (i == MAX_BRANDS)
 179                 return -1;
 180         return 0;
 181 }
 182
 183 int
 184 elf_remove_brand_entry(Elf_Brandinfo *entry)
 185 {
 186         int i;
 187
 188         for (i=1; i<MAX_BRANDS; i++) {
 189                 if (elf_brand_list[i] == entry) {
 190                         elf_brand_list[i] = NULL;
 191                         break;
 192                 }
 193         }
 194         if (i == MAX_BRANDS)
 195                 return -1;
 196         return 0;
 197 }
 198
 199 /*
 200  * Check if an elf brand is being used anywhere in the system.
 201  *
 202  * Used by the linux emulation module unloader.  This isn't safe from
 203  * races.
 204  */
 205 struct elf_brand_inuse_info {
 206         int rval;
 207         Elf_Brandinfo *entry;
 208 };
 209
 210 static int elf_brand_inuse_callback(struct proc *p, void *data);
 211
 212 int
 213 elf_brand_inuse(Elf_Brandinfo *entry)
 214 {
 215         struct elf_brand_inuse_info info;
 216
 217         info.rval = FALSE;
 218         info.entry = entry;
 219         allproc_scan(elf_brand_inuse_callback, entry);
 220         return (info.rval);
 221 }
 222
 223 static
 224 int
 225 elf_brand_inuse_callback(struct proc *p, void *data)
 226 {
 227         struct elf_brand_inuse_info *info = data;
 228
 229         if (p->p_sysent == info->entry->sysvec) {
 230                 info->rval = TRUE;
 231                 return(-1);
 232         }
 233         return(0);
 234 }
 235
 236 static int
 237 elf_check_header(const Elf_Ehdr *hdr)
 238 {
 239         if (!IS_ELF(*hdr) ||
 240             hdr->e_ident[EI_CLASS] != ELF_TARG_CLASS ||
 241             hdr->e_ident[EI_DATA] != ELF_TARG_DATA ||
 242             hdr->e_ident[EI_VERSION] != EV_CURRENT ||
 243             hdr->e_phentsize != sizeof(Elf_Phdr) ||
 244             hdr->e_ehsize != sizeof(Elf_Ehdr) ||
 245             hdr->e_version != ELF_TARG_VER)
 246                 return ENOEXEC;
 247
 248         if (!ELF_MACHINE_OK(hdr->e_machine))
 249                 return ENOEXEC;
 250
 251         return 0;
 252 }
 253
 254 static Elf_Brandinfo *
 255 elf_check_abi_note(struct image_params *imgp, const Elf_Phdr *ph)
 256 {
 257         Elf_Brandinfo *match = NULL;
 258         const Elf_Note *tmp_note;
 259         struct lwbuf *lwb;
 260         const char *page;
 261         char *data = NULL;
 262         Elf_Off off;
 263         size_t firstoff;
 264         size_t len;
 265         size_t firstlen;
 266
 267         len = ph->p_filesz;
 268         off = ph->p_offset;
 269
 270         firstoff = off & PAGE_MASK;
 271         firstlen = PAGE_SIZE - firstoff;
 272
 273         if (len < sizeof(Elf_Note) || len > PAGE_SIZE)
 274                 return NULL; /* ENOEXEC? */
 275
 276         if (exec_map_page(imgp, off >> PAGE_SHIFT, &lwb, &page))
 277                 return NULL;
 278
 279         /*
 280          * Crosses page boundary?  Is that allowed?
 281          */
 282         if (firstlen < len) {
 283                 data = kmalloc(len, M_TEMP, M_WAITOK);
 284
 285                 bcopy(page + firstoff, data, firstlen);
 286
 287                 exec_unmap_page(lwb);
 288                 if (exec_map_page(imgp, (off >> PAGE_SHIFT) + 1, &lwb, &page)) {
 289                         kfree(data, M_TEMP);
 290                         return NULL;
 291                 }
 292                 bcopy(page, data + firstlen, len - firstlen);
 293                 tmp_note = (void *)data;
 294         } else {
 295                 tmp_note = (const void *)(page + firstoff);
 296         }
 297
 298         while (len >= sizeof(Elf_Note)) {
 299                 int i;
 300                 size_t nlen = roundup(tmp_note->n_namesz, sizeof(Elf_Word)) +
 301                               roundup(tmp_note->n_descsz, sizeof(Elf_Word)) +
 302                               sizeof(Elf_Note);
 303
 304                 if (nlen > len)
 305                         break;
 306
 307                 if (tmp_note->n_type != 1)
 308                         goto next;
 309
 310                 for (i = 0; i < MAX_BRANDS; i++) {
 311                         Elf_Brandinfo *bi = elf_brand_list[i];
 312
 313                         if (bi != NULL && bi->match_abi_note != NULL &&
 314                             bi->match_abi_note(tmp_note)) {
 315                                 match = bi;
 316                                 break;
 317                         }
 318                 }
 319
 320                 if (match != NULL)
 321                         break;
 322
 323 next:
 324                 len -= nlen;
 325                 tmp_note += nlen;
 326         }
 327
 328         if (data != NULL)
 329                 kfree(data, M_TEMP);
 330         exec_unmap_page(lwb);
 331
 332         return (match);
 333 }
 334
 335 static int
 336 elf_load_section(struct proc *p, struct vmspace *vmspace, struct vnode *vp,
 337                  vm_offset_t offset, caddr_t vmaddr, size_t memsz,
 338                  size_t filsz, vm_prot_t prot)
 339 {
 340         size_t map_len;
 341         vm_offset_t map_addr;
 342         int error, rv, cow;
 343         int count;
 344         size_t copy_len;
 345         vm_object_t object;
 346         vm_offset_t file_addr;
 347
 348         object = vp->v_object;
 349         error = 0;
 350
 351         /*
 352          * It's necessary to fail if the filsz + offset taken from the
 353          * header is greater than the actual file pager object's size.
 354          * If we were to allow this, then the vm_map_find() below would
 355          * walk right off the end of the file object and into the ether.
 356          *
 357          * While I'm here, might as well check for something else that
 358          * is invalid: filsz cannot be greater than memsz.
 359          */
 360         if ((off_t)filsz + offset > vp->v_filesize || filsz > memsz) {
 361                 uprintf("elf_load_section: truncated ELF file\n");
 362                 return (ENOEXEC);
 363         }
 364
 365         map_addr = trunc_page((vm_offset_t)vmaddr);
 366         file_addr = trunc_page(offset);
 367
 368         /*
 369          * We have two choices.  We can either clear the data in the last page
 370          * of an oversized mapping, or we can start the anon mapping a page
 371          * early and copy the initialized data into that first page.  We
 372          * choose the second..
 373          */
 374         if (memsz > filsz)
 375                 map_len = trunc_page(offset+filsz) - file_addr;
 376         else
 377                 map_len = round_page(offset+filsz) - file_addr;
 378
 379         if (map_len != 0) {
 380                 vm_object_reference(object);
 381
 382                 /* cow flags: don't dump readonly sections in core */
 383                 cow = MAP_COPY_ON_WRITE | MAP_PREFAULT |
 384                     (prot & VM_PROT_WRITE ? 0 : MAP_DISABLE_COREDUMP);
 385
 386                 count = vm_map_entry_reserve(MAP_RESERVE_COUNT);
 387                 vm_map_lock(&vmspace->vm_map);
 388                 rv = vm_map_insert(&vmspace->vm_map, &count,
 389                                       object,
 390                                       file_addr,        /* file offset */
 391                                       map_addr,         /* virtual start */
 392                                       map_addr + map_len,/* virtual end */
 393                                       VM_MAPTYPE_NORMAL,
 394                                       prot, VM_PROT_ALL,
 395                                       cow);
 396                 vm_map_unlock(&vmspace->vm_map);
 397                 vm_map_entry_release(count);
 398                 if (rv != KERN_SUCCESS) {
 399                         vm_object_deallocate(object);
 400                         return EINVAL;
 401                 }
 402
 403                 /* we can stop now if we've covered it all */
 404                 if (memsz == filsz) {
 405                         return 0;
 406                 }
 407         }
 408
 409
 410         /*
 411          * We have to get the remaining bit of the file into the first part
 412          * of the oversized map segment.  This is normally because the .data
 413          * segment in the file is extended to provide bss.  It's a neat idea
 414          * to try and save a page, but it's a pain in the behind to implement.
 415          */
 416         copy_len = (offset + filsz) - trunc_page(offset + filsz);
 417         map_addr = trunc_page((vm_offset_t)vmaddr + filsz);
 418         map_len = round_page((vm_offset_t)vmaddr + memsz) - map_addr;
 419
 420         /* This had damn well better be true! */
 421         if (map_len != 0) {
 422                 count = vm_map_entry_reserve(MAP_RESERVE_COUNT);
 423                 vm_map_lock(&vmspace->vm_map);
 424                 rv = vm_map_insert(&vmspace->vm_map, &count,
 425                                         NULL, 0,
 426                                         map_addr, map_addr + map_len,
 427                                         VM_MAPTYPE_NORMAL,
 428                                         VM_PROT_ALL, VM_PROT_ALL,
 429                                         0);
 430                 vm_map_unlock(&vmspace->vm_map);
 431                 vm_map_entry_release(count);
 432                 if (rv != KERN_SUCCESS) {
 433                         return EINVAL;
 434                 }
 435         }
 436
 437         if (copy_len != 0) {
 438                 vm_page_t m;
 439                 struct lwbuf *lwb;
 440
 441                 m = vm_fault_object_page(object, trunc_page(offset + filsz),
 442                                          VM_PROT_READ, 0, &error);
 443                 if (m) {
 444                         lwb = lwbuf_alloc(m);
 445                         error = copyout((caddr_t)lwbuf_kva(lwb),
 446                                         (caddr_t)map_addr, copy_len);
 447                         lwbuf_free(lwb);
 448                         vm_page_unhold(m);
 449                 }
 450                 if (error) {
 451                         return (error);
 452                 }
 453         }
 454
 455         /*
 456          * set it to the specified protection
 457          */
 458         vm_map_protect(&vmspace->vm_map, map_addr, map_addr + map_len,  prot,
 459                        FALSE);
 460
 461         return error;
 462 }
 463
 464 /*
 465  * Load the file "file" into memory.  It may be either a shared object
 466  * or an executable.
 467  *
 468  * The "addr" reference parameter is in/out.  On entry, it specifies
 469  * the address where a shared object should be loaded.  If the file is
 470  * an executable, this value is ignored.  On exit, "addr" specifies
 471  * where the file was actually loaded.
 472  *
 473  * The "entry" reference parameter is out only.  On exit, it specifies
 474  * the entry point for the loaded file.
 475  */
 476 static int
 477 elf_load_file(struct proc *p, const char *file, u_long *addr, u_long *entry)
 478 {
 479         struct {
 480                 struct nlookupdata nd;
 481                 struct vattr attr;
 482                 struct image_params image_params;
 483         } *tempdata;
 484         const Elf_Ehdr *hdr = NULL;
 485         const Elf_Phdr *phdr = NULL;
 486         struct nlookupdata *nd;
 487         struct vmspace *vmspace = p->p_vmspace;
 488         struct vattr *attr;
 489         struct image_params *imgp;
 490         vm_prot_t prot;
 491         u_long rbase;
 492         u_long base_addr = 0;
 493         int error, i, numsegs;
 494
 495         tempdata = kmalloc(sizeof(*tempdata), M_TEMP, M_WAITOK);
 496         nd = &tempdata->nd;
 497         attr = &tempdata->attr;
 498         imgp = &tempdata->image_params;
 499
 500         /*
 501          * Initialize part of the common data
 502          */
 503         imgp->proc = p;
 504         imgp->attr = attr;
 505         imgp->firstpage = NULL;
 506         imgp->image_header = NULL;
 507         imgp->vp = NULL;
 508
 509         error = nlookup_init(nd, file, UIO_SYSSPACE, NLC_FOLLOW);
 510         if (error == 0)
 511                 error = nlookup(nd);
 512         if (error == 0)
 513                 error = cache_vget(&nd->nl_nch, nd->nl_cred, LK_EXCLUSIVE, &imgp->vp);
 514         nlookup_done(nd);
 515         if (error)
 516                 goto fail;
 517
 518         /*
 519          * Check permissions, modes, uid, etc on the file, and "open" it.
 520          */
 521         error = exec_check_permissions(imgp);
 522         if (error) {
 523                 vn_unlock(imgp->vp);
 524                 goto fail;
 525         }
 526
 527         error = exec_map_first_page(imgp);
 528         /*
 529          * Also make certain that the interpreter stays the same, so set
 530          * its VTEXT flag, too.
 531          */
 532         if (error == 0)
 533                 vsetflags(imgp->vp, VTEXT);
 534         vn_unlock(imgp->vp);
 535         if (error)
 536                 goto fail;
 537
 538         hdr = (const Elf_Ehdr *)imgp->image_header;
 539         if ((error = elf_check_header(hdr)) != 0)
 540                 goto fail;
 541         if (hdr->e_type == ET_DYN)
 542                 rbase = *addr;
 543         else if (hdr->e_type == ET_EXEC)
 544                 rbase = 0;
 545         else {
 546                 error = ENOEXEC;
 547                 goto fail;
 548         }
 549
 550         /* Only support headers that fit within first page for now
 551          * (multiplication of two Elf_Half fields will not overflow) */
 552         if ((hdr->e_phoff > PAGE_SIZE) ||
 553             (hdr->e_phentsize * hdr->e_phnum) > PAGE_SIZE - hdr->e_phoff) {
 554                 error = ENOEXEC;
 555                 goto fail;
 556         }
 557
 558         phdr = (const Elf_Phdr *)(imgp->image_header + hdr->e_phoff);
 559
 560         for (i = 0, numsegs = 0; i < hdr->e_phnum; i++) {
 561                 if (phdr[i].p_type == PT_LOAD) {        /* Loadable segment */
 562                         prot = 0;
 563                         if (phdr[i].p_flags & PF_X)
 564                                 prot |= VM_PROT_EXECUTE;
 565                         if (phdr[i].p_flags & PF_W)
 566                                 prot |= VM_PROT_WRITE;
 567                         if (phdr[i].p_flags & PF_R)
 568                                 prot |= VM_PROT_READ;
 569
 570                         error = elf_load_section(
 571                                     p, vmspace, imgp->vp,
 572                                     phdr[i].p_offset,
 573                                     (caddr_t)phdr[i].p_vaddr +
 574                                     rbase,
 575                                     phdr[i].p_memsz,
 576                                     phdr[i].p_filesz, prot);
 577                         if (error != 0)
 578                                 goto fail;
 579                         /*
 580                          * Establish the base address if this is the
 581                          * first segment.
 582                          */
 583                         if (numsegs == 0)
 584                                 base_addr = trunc_page(phdr[i].p_vaddr + rbase);
 585                         numsegs++;
 586                 }
 587         }
 588         *addr = base_addr;
 589         *entry=(unsigned long)hdr->e_entry + rbase;
 590
 591 fail:
 592         if (imgp->firstpage)
 593                 exec_unmap_first_page(imgp);
 594         if (imgp->vp) {
 595                 vrele(imgp->vp);
 596                 imgp->vp = NULL;
 597         }
 598         kfree(tempdata, M_TEMP);
 599
 600         return error;
 601 }
 602
 603 /*
 604  * non static, as it can be overridden by start_init()
 605  */
 606 int fallback_elf_brand = -1;
 607 SYSCTL_INT(_kern, OID_AUTO, fallback_elf_brand, CTLFLAG_RW,
 608                 &fallback_elf_brand, -1,
 609                 "ELF brand of last resort");
 610
 611 static int can_exec_dyn = 1;
 612 SYSCTL_INT(_kern, OID_AUTO, elf_exec_dyn, CTLFLAG_RW,
 613                 &can_exec_dyn, 1,
 614                 "ELF: can exec shared libraries");
 615
 616 static int
 617 exec_elf_imgact(struct image_params *imgp)
 618 {
 619         const Elf_Ehdr *hdr = (const Elf_Ehdr *) imgp->image_header;
 620         const Elf_Phdr *phdr;
 621         Elf_Auxargs *elf_auxargs = NULL;
 622         struct vmspace *vmspace;
 623         vm_prot_t prot;
 624         u_long text_size = 0, data_size = 0, total_size = 0;
 625         u_long text_addr = 0, data_addr = 0;
 626         u_long seg_size, seg_addr;
 627         u_long addr, entry = 0, proghdr = 0;
 628         int error, i;
 629         const char *interp = NULL;
 630         const Elf_Note *abi_note = NULL;
 631         Elf_Brandinfo *brand_info = NULL;
 632         char *path;
 633
 634         error = 0;
 635
 636         /*
 637          * Do we have a valid ELF header ?
 638          * We allow execution of ET_EXEC and, if kern.elf_exec_dyn is 1, ET_DYN.
 639          */
 640         if (elf_check_header(hdr) != 0 ||
 641             (hdr->e_type != ET_EXEC && (!can_exec_dyn || hdr->e_type != ET_DYN)))
 642                 return -1;
 643
 644         /*
 645          * From here on down, we return an errno, not -1, as we've
 646          * detected an ELF file.
 647          */
 648
 649         if ((hdr->e_phoff > PAGE_SIZE) ||
 650             (hdr->e_phoff + hdr->e_phentsize * hdr->e_phnum) > PAGE_SIZE) {
 651                 /* Only support headers in first page for now */
 652                 return ENOEXEC;
 653         }
 654         phdr = (const Elf_Phdr*)(imgp->image_header + hdr->e_phoff);
 655
 656         /*
 657          * From this point on, we may have resources that need to be freed.
 658          */
 659
 660         exec_new_vmspace(imgp, NULL);
 661
 662         /*
 663          * Yeah, I'm paranoid.  There is every reason in the world to get
 664          * VTEXT now since from here on out, there are places we can have
 665          * a context switch.  Better safe than sorry; I really don't want
 666          * the file to change while it's being loaded.
 667          */
 668         vsetflags(imgp->vp, VTEXT);
 669
 670         vmspace = imgp->proc->p_vmspace;
 671
 672         for (i = 0; i < hdr->e_phnum; i++) {
 673                 switch(phdr[i].p_type) {
 674
 675                 case PT_LOAD:   /* Loadable segment */
 676                         prot = 0;
 677                         if (phdr[i].p_flags & PF_X)
 678                                 prot |= VM_PROT_EXECUTE;
 679                         if (phdr[i].p_flags & PF_W)
 680                                 prot |= VM_PROT_WRITE;
 681                         if (phdr[i].p_flags & PF_R)
 682                                 prot |= VM_PROT_READ;
 683
 684                         if ((error = elf_load_section(imgp->proc,
 685                                                      vmspace, imgp->vp,
 686                                                      phdr[i].p_offset,
 687                                                      (caddr_t)phdr[i].p_vaddr,
 688                                                      phdr[i].p_memsz,
 689                                                      phdr[i].p_filesz, prot)) != 0)
 690                                 goto fail;
 691
 692                         /*
 693                          * If this segment contains the program headers,
 694                          * remember their virtual address for the AT_PHDR
 695                          * aux entry. Static binaries don't usually include
 696                          * a PT_PHDR entry.
 697                          */
 698                         if (phdr[i].p_offset == 0 &&
 699                             hdr->e_phoff + hdr->e_phnum * hdr->e_phentsize
 700                                 <= phdr[i].p_filesz)
 701                                 proghdr = phdr[i].p_vaddr + hdr->e_phoff;
 702
 703                         seg_addr = trunc_page(phdr[i].p_vaddr);
 704                         seg_size = round_page(phdr[i].p_memsz +
 705                                 phdr[i].p_vaddr - seg_addr);
 706
 707                         /*
 708                          * Is this .text or .data?  We can't use
 709                          * VM_PROT_WRITE or VM_PROT_EXEC, it breaks the
 710                          * alpha terribly and possibly does other bad
 711                          * things so we stick to the old way of figuring
 712                          * it out:  If the segment contains the program
 713                          * entry point, it's a text segment, otherwise it
 714                          * is a data segment.
 715                          *
 716                          * Note that obreak() assumes that data_addr +
 717                          * data_size == end of data load area, and the ELF
 718                          * file format expects segments to be sorted by
 719                          * address.  If multiple data segments exist, the
 720                          * last one will be used.
 721                          */
 722                         if (hdr->e_entry >= phdr[i].p_vaddr &&
 723                             hdr->e_entry < (phdr[i].p_vaddr +
 724                             phdr[i].p_memsz)) {
 725                                 text_size = seg_size;
 726                                 text_addr = seg_addr;
 727                                 entry = (u_long)hdr->e_entry;
 728                         } else {
 729                                 data_size = seg_size;
 730                                 data_addr = seg_addr;
 731                         }
 732                         total_size += seg_size;
 733
 734                         /*
 735                          * Check limits.  It should be safe to check the
 736                          * limits after loading the segment since we do
 737                          * not actually fault in all the segment's pages.
 738                          */
 739                         if (data_size >
 740                             imgp->proc->p_rlimit[RLIMIT_DATA].rlim_cur ||
 741                             text_size > maxtsiz ||
 742                             total_size >
 743                             imgp->proc->p_rlimit[RLIMIT_VMEM].rlim_cur) {
 744                                 error = ENOMEM;
 745                                 goto fail;
 746                         }
 747                         break;
 748                 case PT_INTERP: /* Path to interpreter */
 749                         if (phdr[i].p_filesz > MAXPATHLEN ||
 750                             phdr[i].p_offset + phdr[i].p_filesz > PAGE_SIZE) {
 751                                 error = ENOEXEC;
 752                                 goto fail;
 753                         }
 754                         interp = imgp->image_header + phdr[i].p_offset;
 755                         break;
 756                 case PT_NOTE:   /* Check for .note.ABI-tag */
 757                         if (brand_info == NULL)
 758                                 brand_info = elf_check_abi_note(imgp, &phdr[i]);
 759                         break;
 760                 case PT_PHDR:   /* Program header table info */
 761                         proghdr = phdr[i].p_vaddr;
 762                         break;
 763                 default:
 764                         break;
 765                 }
 766         }
 767
 768         vmspace->vm_tsize = text_size >> PAGE_SHIFT;
 769         vmspace->vm_taddr = (caddr_t)(uintptr_t)text_addr;
 770         vmspace->vm_dsize = data_size >> PAGE_SHIFT;
 771         vmspace->vm_daddr = (caddr_t)(uintptr_t)data_addr;
 772
 773         addr = ELF_RTLD_ADDR(vmspace);
 774
 775         imgp->entry_addr = entry;
 776
 777         /* We support three types of branding -- (1) the ELF EI_OSABI field
 778          * that SCO added to the ELF spec, (2) FreeBSD 3.x's traditional string
 779          * branding w/in the ELF header, and (3) path of the `interp_path'
 780          * field.  We should also look for an ".note.ABI-tag" ELF section now
 781          * in all Linux ELF binaries, FreeBSD 4.1+, and some NetBSD ones.
 782          */
 783
 784         /* If the executable has a brand, search for it in the brand list. */
 785         if (brand_info == NULL && hdr->e_ident[EI_OSABI] != ELFOSABI_NONE) {
 786                 for (i = 0;  i < MAX_BRANDS;  i++) {
 787                         Elf_Brandinfo *bi = elf_brand_list[i];
 788
 789                         if (bi != NULL &&
 790                             (hdr->e_ident[EI_OSABI] == bi->brand
 791                             || 0 ==
 792                             strncmp((const char *)&hdr->e_ident[OLD_EI_BRAND],
 793                             bi->compat_3_brand, strlen(bi->compat_3_brand)))) {
 794                                 brand_info = bi;
 795                                 break;
 796                         }
 797                 }
 798         }
 799
 800         /* Search for a recognized ABI. */
 801         if (brand_info == NULL && abi_note != NULL) {
 802         }
 803
 804         /*
 805          * ELFOSABI_NONE == ELFOSABI_SYSV, so a SYSV binary misses all
 806          * checks so far, since it is neither branded nor does it have
 807          * an ABI note.  If the EI_OSABI field is ELFOSABI_NONE, assume
 808          * it is svr4 and look for an entry in the elf_brand_list with
 809          * match_abi_note == NULL.
 810          */
 811         if (brand_info == NULL && hdr->e_ident[EI_OSABI] == ELFOSABI_NONE) {
 812                 for (i = 0; i < MAX_BRANDS; i++) {
 813                         Elf_Brandinfo *bi = elf_brand_list[i];
 814
 815                         if (bi != NULL && bi->match_abi_note == NULL &&
 816                             ELFOSABI_SYSV == bi->brand) {
 817                                 brand_info = bi;
 818                                 break;
 819                         }
 820                 }
 821         }
 822
 823         /* Lacking a recognized ABI, search for a recognized interpreter. */
 824         if (brand_info == NULL && interp != NULL) {
 825                 for (i = 0;  i < MAX_BRANDS;  i++) {
 826                         Elf_Brandinfo *bi = elf_brand_list[i];
 827
 828                         if (bi != NULL &&
 829                             strcmp(interp, bi->interp_path) == 0) {
 830                                 brand_info = bi;
 831                                 break;
 832                         }
 833                 }
 834         }
 835
 836         /* Lacking a recognized interpreter, try the default brand */
 837         if (brand_info == NULL) {
 838                 for (i = 0; i < MAX_BRANDS; i++) {
 839                         Elf_Brandinfo *bi = elf_brand_list[i];
 840
 841                         if (bi != NULL && fallback_elf_brand == bi->brand) {
 842                                 brand_info = bi;
 843                                 break;
 844                         }
 845                 }
 846         }
 847
 848         if (brand_info == NULL) {
 849                 uprintf("ELF binary type \"%u\" not known.\n",
 850                     hdr->e_ident[EI_OSABI]);
 851                 error = ENOEXEC;
 852                 goto fail;
 853         }
 854
 855         imgp->proc->p_sysent = brand_info->sysvec;
 856         EVENTHANDLER_INVOKE(process_exec, imgp);
 857
 858         if (interp != NULL) {
 859                 path = kmalloc(MAXPATHLEN, M_TEMP, M_WAITOK);
 860                 ksnprintf(path, MAXPATHLEN, "%s%s",
 861                          brand_info->emul_path, interp);
 862                 if ((error = elf_load_file(imgp->proc, path, &addr,
 863                                            &imgp->entry_addr)) != 0) {
 864                         if ((error = elf_load_file(imgp->proc, interp, &addr,
 865                                                    &imgp->entry_addr)) != 0) {
 866                                 uprintf("ELF interpreter %s not found\n", path);
 867                                 kfree(path, M_TEMP);
 868                                 goto fail;
 869                         }
 870                 }
 871                 kfree(path, M_TEMP);
 872         } else {
 873                 addr = 0;
 874         }
 875
 876         /*
 877          * Construct auxargs table (used by the fixup routine)
 878          */
 879         elf_auxargs = kmalloc(sizeof(Elf_Auxargs), M_TEMP, M_WAITOK);
 880         elf_auxargs->execfd = -1;
 881         elf_auxargs->phdr = proghdr;
 882         elf_auxargs->phent = hdr->e_phentsize;
 883         elf_auxargs->phnum = hdr->e_phnum;
 884         elf_auxargs->pagesz = PAGE_SIZE;
 885         elf_auxargs->base = addr;
 886         elf_auxargs->flags = 0;
 887         elf_auxargs->entry = entry;
 888         elf_auxargs->trace = elf_trace;
 889
 890         imgp->auxargs = elf_auxargs;
 891         imgp->interpreted = 0;
 892
 893 fail:
 894         return error;
 895 }
 896
 897 static int
 898 elf_freebsd_fixup(register_t **stack_base, struct image_params *imgp)
 899 {
 900         Elf_Auxargs *args = (Elf_Auxargs *)imgp->auxargs;
 901         register_t *pos;
 902
 903         pos = *stack_base + (imgp->args->argc + imgp->args->envc + 2);
 904
 905         if (args->trace) {
 906                 AUXARGS_ENTRY(pos, AT_DEBUG, 1);
 907         }
 908         if (args->execfd != -1) {
 909                 AUXARGS_ENTRY(pos, AT_EXECFD, args->execfd);
 910         }
 911         AUXARGS_ENTRY(pos, AT_PHDR, args->phdr);
 912         AUXARGS_ENTRY(pos, AT_PHENT, args->phent);
 913         AUXARGS_ENTRY(pos, AT_PHNUM, args->phnum);
 914         AUXARGS_ENTRY(pos, AT_PAGESZ, args->pagesz);
 915         AUXARGS_ENTRY(pos, AT_FLAGS, args->flags);
 916         AUXARGS_ENTRY(pos, AT_ENTRY, args->entry);
 917         AUXARGS_ENTRY(pos, AT_BASE, args->base);
 918         AUXARGS_ENTRY(pos, AT_NULL, 0);
 919
 920         kfree(imgp->auxargs, M_TEMP);
 921         imgp->auxargs = NULL;
 922
 923         (*stack_base)--;
 924         suword(*stack_base, (long) imgp->args->argc);
 925         return 0;
 926 }
 927
 928 /*
 929  * Code for generating ELF core dumps.
 930  */
 931
 932 typedef int (*segment_callback) (vm_map_entry_t, void *);
 933
 934 /* Closure for cb_put_phdr(). */
 935 struct phdr_closure {
 936         Elf_Phdr *phdr;         /* Program header to fill in (incremented) */
 937         Elf_Phdr *phdr_max;     /* Pointer bound for error check */
 938         Elf_Off offset;         /* Offset of segment in core file */
 939 };
 940
 941 /* Closure for cb_size_segment(). */
 942 struct sseg_closure {
 943         int count;              /* Count of writable segments. */
 944         size_t vsize;           /* Total size of all writable segments. */
 945 };
 946
 947 /* Closure for cb_put_fp(). */
 948 struct fp_closure {
 949         struct vn_hdr *vnh;
 950         struct vn_hdr *vnh_max;
 951         int count;
 952         struct stat *sb;
 953 };
 954
 955 typedef struct elf_buf {
 956         char    *buf;
 957         size_t  off;
 958         size_t  off_max;
 959 } *elf_buf_t;
 960
 961 static void *target_reserve(elf_buf_t target, size_t bytes, int *error);
 962
 963 static int cb_put_phdr (vm_map_entry_t, void *);
 964 static int cb_size_segment (vm_map_entry_t, void *);
 965 static int cb_fpcount_segment(vm_map_entry_t, void *);
 966 static int cb_put_fp(vm_map_entry_t, void *);
 967
 968
 969 static int each_segment (struct proc *, segment_callback, void *, int);
 970 static int elf_corehdr (struct lwp *, int, struct file *, struct ucred *,
 971                         int, elf_buf_t);
 972 enum putmode { WRITE, DRYRUN };
 973 static int elf_puthdr (struct lwp *, elf_buf_t, int sig, enum putmode,
 974                         int, struct file *);
 975 static int elf_putallnotes(struct lwp *, elf_buf_t, int, enum putmode);
 976 static int elf_putnote (elf_buf_t, const char *, int, const void *, size_t);
 977
 978 static int elf_putsigs(struct lwp *, elf_buf_t);
 979 static int elf_puttextvp(struct proc *, elf_buf_t);
 980 static int elf_putfiles(struct proc *, elf_buf_t, struct file *);
 981
 982 extern int osreldate;
 983
 984 int
 985 elf_coredump(struct lwp *lp, int sig, struct vnode *vp, off_t limit)
 986 {
 987         struct file *fp;
 988         int error;
 989
 990         if ((error = falloc(NULL, &fp, NULL)) != 0)
 991                 return (error);
 992         fsetcred(fp, lp->lwp_proc->p_ucred);
 993
 994         /*
 995          * XXX fixme.
 996          */
 997         fp->f_type = DTYPE_VNODE;
 998         fp->f_flag = O_CREAT|O_WRONLY|O_NOFOLLOW;
 999         fp->f_ops = &vnode_fileops;
1000         fp->f_data = vp;
1001         vn_unlock(vp);
1002
1003         error = generic_elf_coredump(lp, sig, fp, limit);
1004
1005         fp->f_type = 0;
1006         fp->f_flag = 0;
1007         fp->f_ops = &badfileops;
1008         fp->f_data = NULL;
1009         fdrop(fp);
1010         return (error);
1011 }
1012
1013 int
1014 generic_elf_coredump(struct lwp *lp, int sig, struct file *fp, off_t limit)
1015 {
1016         struct proc *p = lp->lwp_proc;
1017         struct ucred *cred = p->p_ucred;
1018         int error = 0;
1019         struct sseg_closure seginfo;
1020         struct elf_buf target;
1021
1022         if (!fp)
1023                 kprintf("can't dump core - null fp\n");
1024
1025         /*
1026          * Size the program segments
1027          */
1028         seginfo.count = 0;
1029         seginfo.vsize = 0;
1030         each_segment(p, cb_size_segment, &seginfo, 1);
1031
1032         /*
1033          * Calculate the size of the core file header area by making
1034          * a dry run of generating it.  Nothing is written, but the
1035          * size is calculated.
1036          */
1037         bzero(&target, sizeof(target));
1038         elf_puthdr(lp, &target, sig, DRYRUN, seginfo.count, fp);
1039
1040         if (target.off + seginfo.vsize >= limit)
1041                 return (EFAULT);
1042
1043         /*
1044          * Allocate memory for building the header, fill it up,
1045          * and write it out.
1046          */
1047         target.off_max = target.off;
1048         target.off = 0;
1049         target.buf = kmalloc(target.off_max, M_TEMP, M_WAITOK|M_ZERO);
1050
1051         error = elf_corehdr(lp, sig, fp, cred, seginfo.count, &target);
1052
1053         /* Write the contents of all of the writable segments. */
1054         if (error == 0) {
1055                 Elf_Phdr *php;
1056                 int i;
1057                 ssize_t nbytes;
1058
1059                 php = (Elf_Phdr *)(target.buf + sizeof(Elf_Ehdr)) + 1;
1060                 for (i = 0; i < seginfo.count; i++) {
1061                         error = fp_write(fp, (caddr_t)php->p_vaddr,
1062                                         php->p_filesz, &nbytes, UIO_USERSPACE);
1063                         if (error != 0)
1064                                 break;
1065                         php++;
1066                 }
1067         }
1068         kfree(target.buf, M_TEMP);
1069
1070         return error;
1071 }
1072
1073 /*
1074  * A callback for each_segment() to write out the segment's
1075  * program header entry.
1076  */
1077 static int
1078 cb_put_phdr(vm_map_entry_t entry, void *closure)
1079 {
1080         struct phdr_closure *phc = closure;
1081         Elf_Phdr *phdr = phc->phdr;
1082
1083         if (phc->phdr == phc->phdr_max)
1084                 return EINVAL;
1085
1086         phc->offset = round_page(phc->offset);
1087
1088         phdr->p_type = PT_LOAD;
1089         phdr->p_offset = phc->offset;
1090         phdr->p_vaddr = entry->start;
1091         phdr->p_paddr = 0;
1092         phdr->p_filesz = phdr->p_memsz = entry->end - entry->start;
1093         phdr->p_align = PAGE_SIZE;
1094         phdr->p_flags = 0;
1095         if (entry->protection & VM_PROT_READ)
1096                 phdr->p_flags |= PF_R;
1097         if (entry->protection & VM_PROT_WRITE)
1098                 phdr->p_flags |= PF_W;
1099         if (entry->protection & VM_PROT_EXECUTE)
1100                 phdr->p_flags |= PF_X;
1101
1102         phc->offset += phdr->p_filesz;
1103         ++phc->phdr;
1104         return 0;
1105 }
1106
1107 /*
1108  * A callback for each_writable_segment() to gather information about
1109  * the number of segments and their total size.
1110  */
1111 static int
1112 cb_size_segment(vm_map_entry_t entry, void *closure)
1113 {
1114         struct sseg_closure *ssc = closure;
1115
1116         ++ssc->count;
1117         ssc->vsize += entry->end - entry->start;
1118         return 0;
1119 }
1120
1121 /*
1122  * A callback for each_segment() to gather information about
1123  * the number of text segments.
1124  */
1125 static int
1126 cb_fpcount_segment(vm_map_entry_t entry, void *closure)
1127 {
1128         int *count = closure;
1129         struct vnode *vp;
1130
1131         if (entry->object.vm_object->type == OBJT_VNODE) {
1132                 vp = (struct vnode *)entry->object.vm_object->handle;
1133                 if ((vp->v_flag & VCKPT) && curproc->p_textvp == vp)
1134                         return 0;
1135                 ++*count;
1136         }
1137         return 0;
1138 }
1139
1140 static int
1141 cb_put_fp(vm_map_entry_t entry, void *closure)
1142 {
1143         struct fp_closure *fpc = closure;
1144         struct vn_hdr *vnh = fpc->vnh;
1145         Elf_Phdr *phdr = &vnh->vnh_phdr;
1146         struct vnode *vp;
1147         int error;
1148
1149         /*
1150          * If an entry represents a vnode then write out a file handle.
1151          *
1152          * If we are checkpointing a checkpoint-restored program we do
1153          * NOT record the filehandle for the old checkpoint vnode (which
1154          * is mapped all over the place).  Instead we rely on the fact
1155          * that a checkpoint-restored program does not mmap() the checkpt
1156          * vnode NOCORE, so its contents will be written out to the
1157          * new checkpoint file.  This is necessary because the 'old'
1158          * checkpoint file is typically destroyed when a new one is created
1159          * and thus cannot be used to restore the new checkpoint.
1160          *
1161          * Theoretically we could create a chain of checkpoint files and
1162          * operate the checkpointing operation kinda like an incremental
1163          * checkpoint, but a checkpoint restore would then likely wind up
1164          * referencing many prior checkpoint files and that is a bit over
1165          * the top for the purpose of the checkpoint API.
1166          */
1167         if (entry->object.vm_object->type == OBJT_VNODE) {
1168                 vp = (struct vnode *)entry->object.vm_object->handle;
1169                 if ((vp->v_flag & VCKPT) && curproc->p_textvp == vp)
1170                         return 0;
1171                 if (vnh == fpc->vnh_max)
1172                         return EINVAL;
1173
1174                 if (vp->v_mount)
1175                         vnh->vnh_fh.fh_fsid = vp->v_mount->mnt_stat.f_fsid;
1176                 error = VFS_VPTOFH(vp, &vnh->vnh_fh.fh_fid);
1177                 if (error) {
1178                         char *freepath, *fullpath;
1179
1180                         if (vn_fullpath(curproc, vp, &fullpath, &freepath, 0)) {
1181                                 kprintf("Warning: coredump, error %d: cannot store file handle for vnode %p\n", error, vp);
1182                         } else {
1183                                 kprintf("Warning: coredump, error %d: cannot store file handle for %s\n", error, fullpath);
1184                                 kfree(freepath, M_TEMP);
1185                         }
1186                         error = 0;
1187                 }
1188
1189                 phdr->p_type = PT_LOAD;
1190                 phdr->p_offset = 0;        /* not written to core */
1191                 phdr->p_vaddr = entry->start;
1192                 phdr->p_paddr = 0;
1193                 phdr->p_filesz = phdr->p_memsz = entry->end - entry->start;
1194                 phdr->p_align = PAGE_SIZE;
1195                 phdr->p_flags = 0;
1196                 if (entry->protection & VM_PROT_READ)
1197                         phdr->p_flags |= PF_R;
1198                 if (entry->protection & VM_PROT_WRITE)
1199                         phdr->p_flags |= PF_W;
1200                 if (entry->protection & VM_PROT_EXECUTE)
1201                         phdr->p_flags |= PF_X;
1202                 ++fpc->vnh;
1203                 ++fpc->count;
1204         }
1205         return 0;
1206 }
1207
1208 /*
1209  * For each writable segment in the process's memory map, call the given
1210  * function with a pointer to the map entry and some arbitrary
1211  * caller-supplied data.
1212  */
1213 static int
1214 each_segment(struct proc *p, segment_callback func, void *closure, int writable)
1215 {
1216         int error = 0;
1217         vm_map_t map = &p->p_vmspace->vm_map;
1218         vm_map_entry_t entry;
1219
1220         for (entry = map->header.next; error == 0 && entry != &map->header;
1221             entry = entry->next) {
1222                 vm_object_t obj;
1223
1224                 /*
1225                  * Don't dump inaccessible mappings, deal with legacy
1226                  * coredump mode.
1227                  *
1228                  * Note that read-only segments related to the elf binary
1229                  * are marked MAP_ENTRY_NOCOREDUMP now so we no longer
1230                  * need to arbitrarily ignore such segments.
1231                  */
1232                 if (elf_legacy_coredump) {
1233                         if (writable && (entry->protection & VM_PROT_RW) != VM_PROT_RW)
1234                                 continue;
1235                 } else {
1236                         if (writable && (entry->protection & VM_PROT_ALL) == 0)
1237                                 continue;
1238                 }
1239
1240                 /*
1241                  * Dont include memory segment in the coredump if
1242                  * MAP_NOCORE is set in mmap(2) or MADV_NOCORE in
1243                  * madvise(2).
1244                  *
1245                  * Currently we only dump normal VM object maps.  We do
1246                  * not dump submaps or virtual page tables.
1247                  */
1248                 if (writable && (entry->eflags & MAP_ENTRY_NOCOREDUMP))
1249                         continue;
1250                 if (entry->maptype != VM_MAPTYPE_NORMAL)
1251                         continue;
1252                 if ((obj = entry->object.vm_object) == NULL)
1253                         continue;
1254
1255                 /* Find the deepest backing object. */
1256                 while (obj->backing_object != NULL)
1257                         obj = obj->backing_object;
1258
1259                 /* Ignore memory-mapped devices and such things. */
1260                 if (obj->type != OBJT_DEFAULT &&
1261                     obj->type != OBJT_SWAP &&
1262                     obj->type != OBJT_VNODE)
1263                         continue;
1264
1265                 error = (*func)(entry, closure);
1266         }
1267         return error;
1268 }
1269
1270 static
1271 void *
1272 target_reserve(elf_buf_t target, size_t bytes, int *error)
1273 {
1274     void *res = NULL;
1275
1276     if (target->buf) {
1277             if (target->off + bytes > target->off_max)
1278                     *error = EINVAL;
1279             else
1280                     res = target->buf + target->off;
1281     }
1282     target->off += bytes;
1283     return (res);
1284 }
1285
1286 /*
1287  * Write the core file header to the file, including padding up to
1288  * the page boundary.
1289  */
1290 static int
1291 elf_corehdr(struct lwp *lp, int sig, struct file *fp, struct ucred *cred,
1292             int numsegs, elf_buf_t target)
1293 {
1294         int error;
1295         ssize_t nbytes;
1296
1297         /*
1298          * Fill in the header.  The fp is passed so we can detect and flag
1299          * a checkpoint file pointer within the core file itself, because
1300          * it may not be restored from the same file handle.
1301          */
1302         error = elf_puthdr(lp, target, sig, WRITE, numsegs, fp);
1303
1304         /* Write it to the core file. */
1305         if (error == 0) {
1306                 error = fp_write(fp, target->buf, target->off, &nbytes,
1307                                  UIO_SYSSPACE);
1308         }
1309         return error;
1310 }
1311
1312 static int
1313 elf_puthdr(struct lwp *lp, elf_buf_t target, int sig, enum putmode mode,
1314     int numsegs, struct file *fp)
1315 {
1316         struct proc *p = lp->lwp_proc;
1317         int error = 0;
1318         size_t phoff;
1319         size_t noteoff;
1320         size_t notesz;
1321         Elf_Ehdr *ehdr;
1322         Elf_Phdr *phdr;
1323
1324         ehdr = target_reserve(target, sizeof(Elf_Ehdr), &error);
1325
1326         phoff = target->off;
1327         phdr = target_reserve(target, (numsegs + 1) * sizeof(Elf_Phdr), &error);
1328
1329         noteoff = target->off;
1330         if (error == 0)
1331                 elf_putallnotes(lp, target, sig, mode);
1332         notesz = target->off - noteoff;
1333
1334         /*
1335          * put extra cruft for dumping process state here
1336          *  - we really want it be before all the program
1337          *    mappings
1338          *  - we just need to update the offset accordingly
1339          *    and GDB will be none the wiser.
1340          */
1341         if (error == 0)
1342                 error = elf_puttextvp(p, target);
1343         if (error == 0)
1344                 error = elf_putsigs(lp, target);
1345         if (error == 0)
1346                 error = elf_putfiles(p, target, fp);
1347
1348         /*
1349          * Align up to a page boundary for the program segments.  The
1350          * actual data will be written to the outptu file, not to elf_buf_t,
1351          * so we do not have to do any further bounds checking.
1352          */
1353         target->off = round_page(target->off);
1354         if (error == 0 && ehdr != NULL) {
1355                 /*
1356                  * Fill in the ELF header.
1357                  */
1358                 ehdr->e_ident[EI_MAG0] = ELFMAG0;
1359                 ehdr->e_ident[EI_MAG1] = ELFMAG1;
1360                 ehdr->e_ident[EI_MAG2] = ELFMAG2;
1361                 ehdr->e_ident[EI_MAG3] = ELFMAG3;
1362                 ehdr->e_ident[EI_CLASS] = ELF_CLASS;
1363                 ehdr->e_ident[EI_DATA] = ELF_DATA;
1364                 ehdr->e_ident[EI_VERSION] = EV_CURRENT;
1365                 ehdr->e_ident[EI_OSABI] = ELFOSABI_NONE;
1366                 ehdr->e_ident[EI_ABIVERSION] = 0;
1367                 ehdr->e_ident[EI_PAD] = 0;
1368                 ehdr->e_type = ET_CORE;
1369                 ehdr->e_machine = ELF_ARCH;
1370                 ehdr->e_version = EV_CURRENT;
1371                 ehdr->e_entry = 0;
1372                 ehdr->e_phoff = phoff;
1373                 ehdr->e_flags = 0;
1374                 ehdr->e_ehsize = sizeof(Elf_Ehdr);
1375                 ehdr->e_phentsize = sizeof(Elf_Phdr);
1376                 ehdr->e_phnum = numsegs + 1;
1377                 ehdr->e_shentsize = sizeof(Elf_Shdr);
1378                 ehdr->e_shnum = 0;
1379                 ehdr->e_shstrndx = SHN_UNDEF;
1380         }
1381         if (error == 0 && phdr != NULL) {
1382                 /*
1383                  * Fill in the program header entries.
1384                  */
1385                 struct phdr_closure phc;
1386
1387                 /* The note segement. */
1388                 phdr->p_type = PT_NOTE;
1389                 phdr->p_offset = noteoff;
1390                 phdr->p_vaddr = 0;
1391                 phdr->p_paddr = 0;
1392                 phdr->p_filesz = notesz;
1393                 phdr->p_memsz = 0;
1394                 phdr->p_flags = 0;
1395                 phdr->p_align = 0;
1396                 ++phdr;
1397
1398                 /* All the writable segments from the program. */
1399                 phc.phdr = phdr;
1400                 phc.phdr_max = phdr + numsegs;
1401                 phc.offset = target->off;
1402                 each_segment(p, cb_put_phdr, &phc, 1);
1403         }
1404         return (error);
1405 }
1406
1407 /*
1408  * Append core dump notes to target ELF buffer or simply update target size
1409  * if dryrun selected.
1410  */
1411 static int
1412 elf_putallnotes(struct lwp *corelp, elf_buf_t target, int sig,
1413     enum putmode mode)
1414 {
1415         struct proc *p = corelp->lwp_proc;
1416         int error;
1417         struct {
1418                 prstatus_t status;
1419                 prfpregset_t fpregs;
1420                 prpsinfo_t psinfo;
1421         } *tmpdata;
1422         prstatus_t *status;
1423         prfpregset_t *fpregs;
1424         prpsinfo_t *psinfo;
1425         struct lwp *lp;
1426
1427         /*
1428          * Allocate temporary storage for notes on heap to avoid stack overflow.
1429          */
1430         if (mode != DRYRUN) {
1431                 tmpdata = kmalloc(sizeof(*tmpdata), M_TEMP, M_ZERO | M_WAITOK);
1432                 status = &tmpdata->status;
1433                 fpregs = &tmpdata->fpregs;
1434                 psinfo = &tmpdata->psinfo;
1435         } else {
1436                 tmpdata = NULL;
1437                 status = NULL;
1438                 fpregs = NULL;
1439                 psinfo = NULL;
1440         }
1441
1442         /*
1443          * Append LWP-agnostic note.
1444          */
1445         if (mode != DRYRUN) {
1446                 psinfo->pr_version = PRPSINFO_VERSION;
1447                 psinfo->pr_psinfosz = sizeof(prpsinfo_t);
1448                 strncpy(psinfo->pr_fname, p->p_comm,
1449                         sizeof(psinfo->pr_fname) - 1);
1450                 /*
1451                  * XXX - We don't fill in the command line arguments
1452                  * properly yet.
1453                  */
1454                 strncpy(psinfo->pr_psargs, p->p_comm, PRARGSZ);
1455         }
1456         error =
1457             elf_putnote(target, "CORE", NT_PRPSINFO, psinfo, sizeof *psinfo);
1458         if (error)
1459                 goto exit;
1460
1461         /*
1462          * Append first note for LWP that triggered core so that it is
1463          * the selected one when the debugger starts.
1464          */
1465         if (mode != DRYRUN) {
1466                 status->pr_version = PRSTATUS_VERSION;
1467                 status->pr_statussz = sizeof(prstatus_t);
1468                 status->pr_gregsetsz = sizeof(gregset_t);
1469                 status->pr_fpregsetsz = sizeof(fpregset_t);
1470                 status->pr_osreldate = osreldate;
1471                 status->pr_cursig = sig;
1472                 /*
1473                  * XXX GDB needs unique pr_pid for each LWP and does not
1474                  * not support pr_pid==0 but lwp_tid can be 0, so hack unique
1475                  * value.
1476                  */
1477                 status->pr_pid = corelp->lwp_tid;
1478                 fill_regs(corelp, &status->pr_reg);
1479                 fill_fpregs(corelp, fpregs);
1480         }
1481         error =
1482             elf_putnote(target, "CORE", NT_PRSTATUS, status, sizeof *status);
1483         if (error)
1484                 goto exit;
1485         error =
1486             elf_putnote(target, "CORE", NT_FPREGSET, fpregs, sizeof *fpregs);
1487         if (error)
1488                 goto exit;
1489
1490         /*
1491          * Then append notes for other LWPs.
1492          */
1493         FOREACH_LWP_IN_PROC(lp, p) {
1494                 if (lp == corelp)
1495                         continue;
1496                 /* skip lwps being created */
1497                 if (lp->lwp_thread == NULL)
1498                         continue;
1499                 if (mode != DRYRUN) {
1500                         status->pr_pid = lp->lwp_tid;
1501                         fill_regs(lp, &status->pr_reg);
1502                         fill_fpregs(lp, fpregs);
1503                 }
1504                 error = elf_putnote(target, "CORE", NT_PRSTATUS,
1505                                         status, sizeof *status);
1506                 if (error)
1507                         goto exit;
1508                 error = elf_putnote(target, "CORE", NT_FPREGSET,
1509                                         fpregs, sizeof *fpregs);
1510                 if (error)
1511                         goto exit;
1512         }
1513
1514 exit:
1515         if (tmpdata != NULL)
1516                 kfree(tmpdata, M_TEMP);
1517         return (error);
1518 }
1519
1520 /*
1521  * Generate a note sub-structure.
1522  *
1523  * NOTE: 4-byte alignment.
1524  */
1525 static int
1526 elf_putnote(elf_buf_t target, const char *name, int type,
1527             const void *desc, size_t descsz)
1528 {
1529         int error = 0;
1530         char *dst;
1531         Elf_Note note;
1532
1533         note.n_namesz = strlen(name) + 1;
1534         note.n_descsz = descsz;
1535         note.n_type = type;
1536         dst = target_reserve(target, sizeof(note), &error);
1537         if (dst != NULL)
1538                 bcopy(&note, dst, sizeof note);
1539         dst = target_reserve(target, note.n_namesz, &error);
1540         if (dst != NULL)
1541                 bcopy(name, dst, note.n_namesz);
1542         target->off = roundup2(target->off, sizeof(Elf_Word));
1543         dst = target_reserve(target, note.n_descsz, &error);
1544         if (dst != NULL)
1545                 bcopy(desc, dst, note.n_descsz);
1546         target->off = roundup2(target->off, sizeof(Elf_Word));
1547         return(error);
1548 }
1549
1550
1551 static int
1552 elf_putsigs(struct lwp *lp, elf_buf_t target)
1553 {
1554         /* XXX lwp handle more than one lwp */
1555         struct proc *p = lp->lwp_proc;
1556         int error = 0;
1557         struct ckpt_siginfo *csi;
1558
1559         csi = target_reserve(target, sizeof(struct ckpt_siginfo), &error);
1560         if (csi) {
1561                 csi->csi_ckptpisz = sizeof(struct ckpt_siginfo);
1562                 bcopy(p->p_sigacts, &csi->csi_sigacts, sizeof(*p->p_sigacts));
1563                 bcopy(&p->p_realtimer, &csi->csi_itimerval, sizeof(struct itimerval));
1564                 bcopy(&lp->lwp_sigmask, &csi->csi_sigmask,
1565                         sizeof(sigset_t));
1566                 csi->csi_sigparent = p->p_sigparent;
1567         }
1568         return(error);
1569 }
1570
1571 static int
1572 elf_putfiles(struct proc *p, elf_buf_t target, struct file *ckfp)
1573 {
1574         int error = 0;
1575         int i;
1576         struct ckpt_filehdr *cfh = NULL;
1577         struct ckpt_fileinfo *cfi;
1578         struct file *fp;
1579         struct vnode *vp;
1580         /*
1581          * the duplicated loop is gross, but it was the only way
1582          * to eliminate uninitialized variable warnings
1583          */
1584         cfh = target_reserve(target, sizeof(struct ckpt_filehdr), &error);
1585         if (cfh) {
1586                 cfh->cfh_nfiles = 0;
1587         }
1588
1589         /*
1590          * ignore STDIN/STDERR/STDOUT.
1591          */
1592         for (i = 3; error == 0 && i < p->p_fd->fd_nfiles; i++) {
1593                 fp = holdfp(p->p_fd, i, -1);
1594                 if (fp == NULL)
1595                         continue;
1596                 /*
1597                  * XXX Only checkpoint vnodes for now.
1598                  */
1599                 if (fp->f_type != DTYPE_VNODE) {
1600                         fdrop(fp);
1601                         continue;
1602                 }
1603                 cfi = target_reserve(target, sizeof(struct ckpt_fileinfo),
1604                                         &error);
1605                 if (cfi == NULL) {
1606                         fdrop(fp);
1607                         continue;
1608                 }
1609                 cfi->cfi_index = -1;
1610                 cfi->cfi_type = fp->f_type;
1611                 cfi->cfi_flags = fp->f_flag;
1612                 cfi->cfi_offset = fp->f_offset;
1613                 cfi->cfi_ckflags = 0;
1614
1615                 if (fp == ckfp)
1616                         cfi->cfi_ckflags |= CKFIF_ISCKPTFD;
1617                 /* f_count and f_msgcount should not be saved/restored */
1618                 /* XXX save cred info */
1619
1620                 switch(fp->f_type) {
1621                 case DTYPE_VNODE:
1622                         vp = (struct vnode *)fp->f_data;
1623                         /*
1624                          * it looks like a bug in ptrace is marking
1625                          * a non-vnode as a vnode - until we find the
1626                          * root cause this will at least prevent
1627                          * further panics from truss
1628                          */
1629                         if (vp == NULL || vp->v_mount == NULL)
1630                                 break;
1631                         cfh->cfh_nfiles++;
1632                         cfi->cfi_index = i;
1633                         cfi->cfi_fh.fh_fsid = vp->v_mount->mnt_stat.f_fsid;
1634                         error = VFS_VPTOFH(vp, &cfi->cfi_fh.fh_fid);
1635                         break;
1636                 default:
1637                         break;
1638                 }
1639                 fdrop(fp);
1640         }
1641         return(error);
1642 }
1643
1644 static int
1645 elf_puttextvp(struct proc *p, elf_buf_t target)
1646 {
1647         int error = 0;
1648         int *vn_count;
1649         struct fp_closure fpc;
1650         struct ckpt_vminfo *vminfo;
1651
1652         vminfo = target_reserve(target, sizeof(struct ckpt_vminfo), &error);
1653         if (vminfo != NULL) {
1654                 vminfo->cvm_dsize = p->p_vmspace->vm_dsize;
1655                 vminfo->cvm_tsize = p->p_vmspace->vm_tsize;
1656                 vminfo->cvm_daddr = p->p_vmspace->vm_daddr;
1657                 vminfo->cvm_taddr = p->p_vmspace->vm_taddr;
1658         }
1659
1660         fpc.count = 0;
1661         vn_count = target_reserve(target, sizeof(int), &error);
1662         if (target->buf != NULL) {
1663                 fpc.vnh = (struct vn_hdr *)(target->buf + target->off);
1664                 fpc.vnh_max = fpc.vnh +
1665                         (target->off_max - target->off) / sizeof(struct vn_hdr);
1666                 error = each_segment(p, cb_put_fp, &fpc, 0);
1667                 if (vn_count)
1668                         *vn_count = fpc.count;
1669         } else {
1670                 error = each_segment(p, cb_fpcount_segment, &fpc.count, 0);
1671         }
1672         target->off += fpc.count * sizeof(struct vn_hdr);
1673         return(error);
1674 }
1675
1676
1677 /*
1678  * Tell kern_execve.c about it, with a little help from the linker.
1679  */
1680 static struct execsw elf_execsw = {exec_elf_imgact, "ELF"};
1681 EXEC_SET_ORDERED(elf, elf_execsw, SI_ORDER_FIRST);