2 * Copyright (c) 2007 Sandvine Incorporated
3 * Copyright (c) 1998 John D. Polstra
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/endian.h>
32 #include <sys/param.h>
33 #include <sys/procfs.h>
34 #include <sys/ptrace.h>
35 #include <sys/queue.h>
36 #include <sys/linker_set.h>
38 #include <sys/sysctl.h>
41 #include <machine/elf.h>
42 #include <vm/vm_param.h>
45 #include <vm/vm_map.h>
61 * Code for generating ELF core dumps.
64 typedef void (*segment_callback)(vm_map_entry_t, void *);
66 /* Closure for cb_put_phdr(). */
68 Elf_Phdr *phdr; /* Program header to fill in */
69 Elf_Off offset; /* Offset of segment in core file */
72 /* Closure for cb_size_segment(). */
74 int count; /* Count of writable segments. */
75 size_t size; /* Total size of all writable segments. */
78 #ifdef ELFCORE_COMPAT_32
79 typedef struct fpreg32 elfcore_fpregset_t;
80 typedef struct reg32 elfcore_gregset_t;
81 typedef struct prpsinfo32 elfcore_prpsinfo_t;
82 typedef struct prstatus32 elfcore_prstatus_t;
83 static void elf_convert_gregset(elfcore_gregset_t *rd, struct reg *rs);
84 static void elf_convert_fpregset(elfcore_fpregset_t *rd, struct fpreg *rs);
86 typedef fpregset_t elfcore_fpregset_t;
87 typedef gregset_t elfcore_gregset_t;
88 typedef prpsinfo_t elfcore_prpsinfo_t;
89 typedef prstatus_t elfcore_prstatus_t;
90 #define elf_convert_gregset(d,s) *d = *s
91 #define elf_convert_fpregset(d,s) *d = *s
94 typedef void* (*notefunc_t)(void *, size_t *);
96 static void cb_put_phdr(vm_map_entry_t, void *);
97 static void cb_size_segment(vm_map_entry_t, void *);
98 static void each_writable_segment(vm_map_entry_t, segment_callback,
100 static void elf_detach(void); /* atexit() handler. */
101 static void *elf_note_fpregset(void *, size_t *);
102 static void *elf_note_prpsinfo(void *, size_t *);
103 static void *elf_note_prstatus(void *, size_t *);
104 static void *elf_note_thrmisc(void *, size_t *);
105 #if defined(__i386__) || defined(__amd64__)
106 static void *elf_note_x86_xstate(void *, size_t *);
108 #if defined(__powerpc__)
109 static void *elf_note_powerpc_vmx(void *, size_t *);
111 static void *elf_note_procstat_auxv(void *, size_t *);
112 static void *elf_note_procstat_files(void *, size_t *);
113 static void *elf_note_procstat_groups(void *, size_t *);
114 static void *elf_note_procstat_osrel(void *, size_t *);
115 static void *elf_note_procstat_proc(void *, size_t *);
116 static void *elf_note_procstat_psstrings(void *, size_t *);
117 static void *elf_note_procstat_rlimit(void *, size_t *);
118 static void *elf_note_procstat_umask(void *, size_t *);
119 static void *elf_note_procstat_vmmap(void *, size_t *);
120 static void elf_puthdr(pid_t, vm_map_entry_t, void *, size_t, size_t, size_t,
122 static void elf_putnote(int, notefunc_t, void *, struct sbuf *);
123 static void elf_putnotes(pid_t, struct sbuf *, size_t *);
124 static void freemap(vm_map_entry_t);
125 static vm_map_entry_t readmap(pid_t);
126 static void *procstat_sysctl(void *, int, size_t, size_t *sizep);
128 static pid_t g_pid; /* Pid being dumped, global for elf_detach */
131 elf_ident(int efd, pid_t pid __unused, char *binfile __unused)
137 cnt = read(efd, &hdr, sizeof(hdr));
138 if (cnt != sizeof(hdr))
142 switch (hdr.e_ident[EI_DATA]) {
144 machine = le16toh(hdr.e_machine);
147 machine = be16toh(hdr.e_machine);
152 if (!ELF_MACHINE_OK(machine))
164 ptrace(PT_DETACH, g_pid, (caddr_t)1, 0);
168 * Write an ELF coredump for the given pid to the given fd.
171 elf_coredump(int efd __unused, int fd, pid_t pid)
174 struct sseg_closure seginfo;
177 size_t hdrsize, notesz, segoff;
182 /* Attach to process to dump. */
184 if (atexit(elf_detach) != 0)
187 ptrace(PT_ATTACH, pid, NULL, 0);
190 if (waitpid(pid, NULL, 0) == -1)
193 /* Get the program's memory map. */
196 /* Size the program segments. */
199 each_writable_segment(map, cb_size_segment, &seginfo);
202 * Build the header and the notes using sbuf and write to the file.
204 sb = sbuf_new_auto();
205 hdrsize = sizeof(Elf_Ehdr) + sizeof(Elf_Phdr) * (1 + seginfo.count);
206 /* Start header + notes section. */
207 sbuf_start_section(sb, NULL);
208 /* Make empty header subsection. */
209 sbuf_start_section(sb, &old_len);
211 sbuf_end_section(sb, old_len, hdrsize, 0);
213 elf_putnotes(pid, sb, ¬esz);
214 /* Align up to a page boundary for the program segments. */
215 sbuf_end_section(sb, -1, PAGE_SIZE, 0);
216 if (sbuf_finish(sb) != 0)
217 err(1, "sbuf_finish");
219 segoff = sbuf_len(sb);
220 /* Fill in the header. */
221 elf_puthdr(pid, map, hdr, hdrsize, notesz, segoff, seginfo.count);
223 n = write(fd, hdr, segoff);
227 errx(1, "short write");
229 /* Write the contents of all of the writable segments. */
230 php = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr)) + 1;
231 for (i = 0; i < seginfo.count; i++) {
232 struct ptrace_io_desc iorequest;
233 uintmax_t nleft = php->p_filesz;
235 iorequest.piod_op = PIOD_READ_D;
236 iorequest.piod_offs = (caddr_t)(uintptr_t)php->p_vaddr;
242 if (nleft > sizeof(buf))
246 iorequest.piod_addr = buf;
247 iorequest.piod_len = nwant;
248 ptrace(PT_IO, pid, (caddr_t)&iorequest, 0);
249 ngot = iorequest.piod_len;
250 if ((size_t)ngot < nwant)
251 errx(1, "short read wanted %zu, got %zd",
253 ngot = write(fd, buf, nwant);
255 err(1, "write of segment %d failed", i);
256 if ((size_t)ngot != nwant)
257 errx(1, "short write");
259 iorequest.piod_offs += ngot;
268 * A callback for each_writable_segment() to write out the segment's
269 * program header entry.
272 cb_put_phdr(vm_map_entry_t entry, void *closure)
274 struct phdr_closure *phc = (struct phdr_closure *)closure;
275 Elf_Phdr *phdr = phc->phdr;
277 phc->offset = round_page(phc->offset);
279 phdr->p_type = PT_LOAD;
280 phdr->p_offset = phc->offset;
281 phdr->p_vaddr = entry->start;
283 phdr->p_filesz = phdr->p_memsz = entry->end - entry->start;
284 phdr->p_align = PAGE_SIZE;
286 if (entry->protection & VM_PROT_READ)
287 phdr->p_flags |= PF_R;
288 if (entry->protection & VM_PROT_WRITE)
289 phdr->p_flags |= PF_W;
290 if (entry->protection & VM_PROT_EXECUTE)
291 phdr->p_flags |= PF_X;
293 phc->offset += phdr->p_filesz;
298 * A callback for each_writable_segment() to gather information about
299 * the number of segments and their total size.
302 cb_size_segment(vm_map_entry_t entry, void *closure)
304 struct sseg_closure *ssc = (struct sseg_closure *)closure;
307 ssc->size += entry->end - entry->start;
311 * For each segment in the given memory map, call the given function
312 * with a pointer to the map entry and some arbitrary caller-supplied
316 each_writable_segment(vm_map_entry_t map, segment_callback func, void *closure)
318 vm_map_entry_t entry;
320 for (entry = map; entry != NULL; entry = entry->next)
321 (*func)(entry, closure);
325 elf_putnotes(pid_t pid, struct sbuf *sb, size_t *sizep)
328 size_t threads, old_len;
333 threads = ptrace(PT_GETNUMLWPS, pid, NULL, 0);
335 err(1, "PT_GETNUMLWPS");
336 tids = malloc(threads * sizeof(*tids));
338 errx(1, "out of memory");
340 ptrace(PT_GETLWPLIST, pid, (void *)tids, threads);
342 err(1, "PT_GETLWPLIST");
344 sbuf_start_section(sb, &old_len);
345 elf_putnote(NT_PRPSINFO, elf_note_prpsinfo, &pid, sb);
347 for (i = 0; i < threads; ++i) {
348 elf_putnote(NT_PRSTATUS, elf_note_prstatus, tids + i, sb);
349 elf_putnote(NT_FPREGSET, elf_note_fpregset, tids + i, sb);
350 elf_putnote(NT_THRMISC, elf_note_thrmisc, tids + i, sb);
351 #if defined(__i386__) || defined(__amd64__)
352 elf_putnote(NT_X86_XSTATE, elf_note_x86_xstate, tids + i, sb);
354 #if defined(__powerpc__)
355 elf_putnote(NT_PPC_VMX, elf_note_powerpc_vmx, tids + i, sb);
359 #ifndef ELFCORE_COMPAT_32
360 elf_putnote(NT_PROCSTAT_PROC, elf_note_procstat_proc, &pid, sb);
361 elf_putnote(NT_PROCSTAT_FILES, elf_note_procstat_files, &pid, sb);
362 elf_putnote(NT_PROCSTAT_VMMAP, elf_note_procstat_vmmap, &pid, sb);
363 elf_putnote(NT_PROCSTAT_GROUPS, elf_note_procstat_groups, &pid, sb);
364 elf_putnote(NT_PROCSTAT_UMASK, elf_note_procstat_umask, &pid, sb);
365 elf_putnote(NT_PROCSTAT_RLIMIT, elf_note_procstat_rlimit, &pid, sb);
366 elf_putnote(NT_PROCSTAT_OSREL, elf_note_procstat_osrel, &pid, sb);
367 elf_putnote(NT_PROCSTAT_PSSTRINGS, elf_note_procstat_psstrings, &pid,
369 elf_putnote(NT_PROCSTAT_AUXV, elf_note_procstat_auxv, &pid, sb);
372 size = sbuf_end_section(sb, old_len, 1, 0);
374 err(1, "sbuf_end_section");
380 * Emit one note section to sbuf.
383 elf_putnote(int type, notefunc_t notefunc, void *arg, struct sbuf *sb)
390 desc = notefunc(arg, &descsz);
391 note.n_namesz = 8; /* strlen("FreeBSD") + 1 */
392 note.n_descsz = descsz;
395 sbuf_bcat(sb, ¬e, sizeof(note));
396 sbuf_start_section(sb, &old_len);
397 sbuf_bcat(sb, "FreeBSD", note.n_namesz);
398 sbuf_end_section(sb, old_len, sizeof(Elf32_Size), 0);
401 sbuf_start_section(sb, &old_len);
402 sbuf_bcat(sb, desc, descsz);
403 sbuf_end_section(sb, old_len, sizeof(Elf32_Size), 0);
408 * Generate the ELF coredump header.
411 elf_puthdr(pid_t pid, vm_map_entry_t map, void *hdr, size_t hdrsize,
412 size_t notesz, size_t segoff, int numsegs)
416 struct phdr_closure phc;
418 ehdr = (Elf_Ehdr *)hdr;
419 phdr = (Elf_Phdr *)((char *)hdr + sizeof(Elf_Ehdr));
421 ehdr->e_ident[EI_MAG0] = ELFMAG0;
422 ehdr->e_ident[EI_MAG1] = ELFMAG1;
423 ehdr->e_ident[EI_MAG2] = ELFMAG2;
424 ehdr->e_ident[EI_MAG3] = ELFMAG3;
425 ehdr->e_ident[EI_CLASS] = ELF_CLASS;
426 ehdr->e_ident[EI_DATA] = ELF_DATA;
427 ehdr->e_ident[EI_VERSION] = EV_CURRENT;
428 ehdr->e_ident[EI_OSABI] = ELFOSABI_FREEBSD;
429 ehdr->e_ident[EI_ABIVERSION] = 0;
430 ehdr->e_ident[EI_PAD] = 0;
431 ehdr->e_type = ET_CORE;
432 ehdr->e_machine = ELF_ARCH;
433 ehdr->e_version = EV_CURRENT;
435 ehdr->e_phoff = sizeof(Elf_Ehdr);
437 ehdr->e_ehsize = sizeof(Elf_Ehdr);
438 ehdr->e_phentsize = sizeof(Elf_Phdr);
439 ehdr->e_phnum = numsegs + 1;
440 ehdr->e_shentsize = sizeof(Elf_Shdr);
442 ehdr->e_shstrndx = SHN_UNDEF;
445 * Fill in the program header entries.
448 /* The note segement. */
449 phdr->p_type = PT_NOTE;
450 phdr->p_offset = hdrsize;
453 phdr->p_filesz = notesz;
455 phdr->p_flags = PF_R;
456 phdr->p_align = sizeof(Elf32_Size);
459 /* All the writable segments from the program. */
462 each_writable_segment(map, cb_put_phdr, &phc);
466 * Free the memory map.
469 freemap(vm_map_entry_t map)
472 while (map != NULL) {
473 vm_map_entry_t next = map->next;
480 * Read the process's memory map using kinfo_getvmmap(), and return a list of
481 * VM map entries. Only the non-device read/writable segments are
482 * returned. The map entries in the list aren't fully filled in; only
483 * the items we need are present.
485 static vm_map_entry_t
488 vm_map_entry_t ent, *linkp, map;
489 struct kinfo_vmentry *vmentl, *kve;
492 vmentl = kinfo_getvmmap(pid, &nitems);
494 err(1, "cannot retrieve mappings for %u process", pid);
498 for (i = 0; i < nitems; i++) {
502 * Ignore 'malformed' segments or ones representing memory
503 * mapping with MAP_NOCORE on.
504 * If the 'full' support is disabled, just dump the most
505 * meaningful data segments.
507 if ((kve->kve_protection & KVME_PROT_READ) == 0 ||
508 (kve->kve_flags & KVME_FLAG_NOCOREDUMP) != 0 ||
509 kve->kve_type == KVME_TYPE_DEAD ||
510 kve->kve_type == KVME_TYPE_UNKNOWN ||
511 ((pflags & PFLAGS_FULL) == 0 &&
512 kve->kve_type != KVME_TYPE_DEFAULT &&
513 kve->kve_type != KVME_TYPE_VNODE &&
514 kve->kve_type != KVME_TYPE_SWAP &&
515 kve->kve_type != KVME_TYPE_PHYS))
518 ent = calloc(1, sizeof(*ent));
520 errx(1, "out of memory");
521 ent->start = (vm_offset_t)kve->kve_start;
522 ent->end = (vm_offset_t)kve->kve_end;
523 ent->protection = VM_PROT_READ | VM_PROT_WRITE;
524 if ((kve->kve_protection & KVME_PROT_EXEC) != 0)
525 ent->protection |= VM_PROT_EXECUTE;
535 * Miscellaneous note out functions.
539 elf_note_prpsinfo(void *arg, size_t *sizep)
542 elfcore_prpsinfo_t *psinfo;
543 struct kinfo_proc kip;
548 psinfo = calloc(1, sizeof(*psinfo));
550 errx(1, "out of memory");
551 psinfo->pr_version = PRPSINFO_VERSION;
552 psinfo->pr_psinfosz = sizeof(*psinfo);
556 name[2] = KERN_PROC_PID;
559 if (sysctl(name, 4, &kip, &len, NULL, 0) == -1)
560 err(1, "kern.proc.pid.%u", pid);
561 if (kip.ki_pid != pid)
562 err(1, "kern.proc.pid.%u", pid);
563 strncpy(psinfo->pr_fname, kip.ki_comm, MAXCOMLEN);
564 strncpy(psinfo->pr_psargs, psinfo->pr_fname, PRARGSZ);
566 *sizep = sizeof(*psinfo);
571 elf_note_prstatus(void *arg, size_t *sizep)
574 elfcore_prstatus_t *status;
577 tid = *(lwpid_t *)arg;
578 status = calloc(1, sizeof(*status));
580 errx(1, "out of memory");
581 status->pr_version = PRSTATUS_VERSION;
582 status->pr_statussz = sizeof(*status);
583 status->pr_gregsetsz = sizeof(elfcore_gregset_t);
584 status->pr_fpregsetsz = sizeof(elfcore_fpregset_t);
585 status->pr_osreldate = __FreeBSD_version;
586 status->pr_pid = tid;
587 ptrace(PT_GETREGS, tid, (void *)&greg, 0);
588 elf_convert_gregset(&status->pr_reg, &greg);
590 *sizep = sizeof(*status);
595 elf_note_fpregset(void *arg, size_t *sizep)
598 elfcore_fpregset_t *fpregset;
601 tid = *(lwpid_t *)arg;
602 fpregset = calloc(1, sizeof(*fpregset));
603 if (fpregset == NULL)
604 errx(1, "out of memory");
605 ptrace(PT_GETFPREGS, tid, (void *)&fpreg, 0);
606 elf_convert_fpregset(fpregset, &fpreg);
608 *sizep = sizeof(*fpregset);
613 elf_note_thrmisc(void *arg, size_t *sizep)
616 struct ptrace_lwpinfo lwpinfo;
619 tid = *(lwpid_t *)arg;
620 thrmisc = calloc(1, sizeof(*thrmisc));
622 errx(1, "out of memory");
623 ptrace(PT_LWPINFO, tid, (void *)&lwpinfo,
625 memset(&thrmisc->_pad, 0, sizeof(thrmisc->_pad));
626 strcpy(thrmisc->pr_tname, lwpinfo.pl_tdname);
628 *sizep = sizeof(*thrmisc);
632 #if defined(__i386__) || defined(__amd64__)
634 elf_note_x86_xstate(void *arg, size_t *sizep)
638 static bool xsave_checked = false;
639 static struct ptrace_xstate_info info;
641 tid = *(lwpid_t *)arg;
642 if (!xsave_checked) {
643 if (ptrace(PT_GETXSTATE_INFO, tid, (void *)&info,
646 xsave_checked = true;
648 if (info.xsave_len == 0) {
652 xstate = calloc(1, info.xsave_len);
653 ptrace(PT_GETXSTATE, tid, xstate, 0);
654 *(uint64_t *)(xstate + X86_XSTATE_XCR0_OFFSET) = info.xsave_mask;
655 *sizep = info.xsave_len;
660 #if defined(__powerpc__)
662 elf_note_powerpc_vmx(void *arg, size_t *sizep)
666 static bool has_vmx = true;
669 tid = *(lwpid_t *)arg;
671 if (ptrace(PT_GETVRREGS, tid, (void *)&info,
679 vmx = calloc(1, sizeof(*vmx));
680 memcpy(vmx, &info, sizeof(*vmx));
681 *sizep = sizeof(*vmx);
687 procstat_sysctl(void *arg, int what, size_t structsz, size_t *sizep)
691 int name[4], structsize;
695 structsize = structsz;
701 if (sysctl(name, 4, NULL, &len, NULL, 0) == -1)
702 err(1, "kern.proc.%d.%u", what, pid);
703 buf = calloc(1, sizeof(structsize) + len * 4 / 3);
705 errx(1, "out of memory");
706 bcopy(&structsize, buf, sizeof(structsize));
707 p = (char *)buf + sizeof(structsize);
708 if (sysctl(name, 4, p, &len, NULL, 0) == -1)
709 err(1, "kern.proc.%d.%u", what, pid);
711 *sizep = sizeof(structsize) + len;
716 elf_note_procstat_proc(void *arg, size_t *sizep)
719 return (procstat_sysctl(arg, KERN_PROC_PID | KERN_PROC_INC_THREAD,
720 sizeof(struct kinfo_proc), sizep));
724 elf_note_procstat_files(void *arg, size_t *sizep)
727 return (procstat_sysctl(arg, KERN_PROC_FILEDESC,
728 sizeof(struct kinfo_file), sizep));
732 elf_note_procstat_vmmap(void *arg, size_t *sizep)
735 return (procstat_sysctl(arg, KERN_PROC_VMMAP,
736 sizeof(struct kinfo_vmentry), sizep));
740 elf_note_procstat_groups(void *arg, size_t *sizep)
743 return (procstat_sysctl(arg, KERN_PROC_GROUPS, sizeof(gid_t), sizep));
747 elf_note_procstat_umask(void *arg, size_t *sizep)
750 return (procstat_sysctl(arg, KERN_PROC_UMASK, sizeof(u_short), sizep));
754 elf_note_procstat_osrel(void *arg, size_t *sizep)
757 return (procstat_sysctl(arg, KERN_PROC_OSREL, sizeof(int), sizep));
761 elf_note_procstat_psstrings(void *arg, size_t *sizep)
764 return (procstat_sysctl(arg, KERN_PROC_PS_STRINGS,
765 sizeof(vm_offset_t), sizep));
769 elf_note_procstat_auxv(void *arg, size_t *sizep)
772 return (procstat_sysctl(arg, KERN_PROC_AUXV,
773 sizeof(Elf_Auxinfo), sizep));
777 elf_note_procstat_rlimit(void *arg, size_t *sizep)
781 int i, name[5], structsize;
785 structsize = sizeof(struct rlimit) * RLIM_NLIMITS;
786 buf = calloc(1, sizeof(structsize) + structsize);
788 errx(1, "out of memory");
789 bcopy(&structsize, buf, sizeof(structsize));
790 p = (char *)buf + sizeof(structsize);
793 name[2] = KERN_PROC_RLIMIT;
795 len = sizeof(struct rlimit);
796 for (i = 0; i < RLIM_NLIMITS; i++) {
798 if (sysctl(name, 5, p, &len, NULL, 0) == -1)
799 err(1, "kern.proc.rlimit.%u", pid);
800 if (len != sizeof(struct rlimit))
801 errx(1, "kern.proc.rlimit.%u: short read", pid);
805 *sizep = sizeof(structsize) + structsize;
809 struct dumpers __elfN(dump) = { elf_ident, elf_coredump };
810 TEXT_SET(dumpset, __elfN(dump));