2 /*--------------------------------------------------------------------*/
3 /*--- Dumping core. coredump-elf.c ---*/
4 /*--------------------------------------------------------------------*/
7 This file is part of Valgrind, a dynamic binary instrumentation
10 Copyright (C) 2000-2010 Julian Seward
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of the
16 License, or (at your option) any later version.
18 This program is distributed in the hope that it will be useful, but
19 WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
28 The GNU General Public License is contained in the file COPYING.
31 #if defined(VGO_linux)
33 #include "pub_core_basics.h"
34 #include "pub_core_vki.h"
35 #include "pub_core_aspacehl.h"
36 #include "pub_core_aspacemgr.h"
37 #include "pub_core_libcbase.h"
38 #include "pub_core_machine.h"
39 #include "pub_core_coredump.h"
40 #include "pub_core_libcprint.h"
41 #include "pub_core_libcfile.h" // VG_(close) et al
42 #include "pub_core_libcproc.h" // VG_(geteuid), VG_(getegid)
43 #include "pub_core_libcassert.h" // VG_(exit), vg_assert
44 #include "pub_core_mallocfree.h" // VG_(malloc), VG_(free)
45 #include "pub_core_threadstate.h"
46 #include "pub_core_xarray.h"
47 #include "pub_core_clientstate.h"
48 #include "pub_core_options.h"
53 Generate a standard ELF core file corresponding to the client state
54 at the time of a crash.
58 #define NT_PRXFPREG 0x46e62b7f /* copied from gdb5.1/include/elf/common.h */
59 #endif /* NT_PRXFPREG */
62 #define ESZ(x) Elf64_##x
63 #elif VG_WORDSIZE == 4
64 #define ESZ(x) Elf32_##x
66 #error VG_WORDSIZE needs to ==4 or ==8
69 /* If true, then this Segment may be mentioned in the core */
70 static Bool may_dump(const NSegment *seg)
72 if (seg->kind == SkAnonC ||
73 seg->kind == SkShmC ||
74 (seg->kind == SkFileC &&
75 !VKI_S_ISCHR(seg->mode) && !VKI_S_ISBLK(seg->mode)))
81 /* If true, then this Segment's contents will be in the core */
82 static Bool should_dump(const NSegment *seg)
84 return may_dump(seg); // && seg->hasW;
87 static void fill_ehdr(ESZ(Ehdr) *ehdr, Int num_phdrs)
89 VG_(memset)(ehdr, 0, sizeof(*ehdr));
91 VG_(memcpy)(ehdr->e_ident, ELFMAG, SELFMAG);
92 ehdr->e_ident[EI_CLASS] = VG_ELF_CLASS;
93 ehdr->e_ident[EI_DATA] = VG_ELF_DATA2XXX;
94 ehdr->e_ident[EI_VERSION] = EV_CURRENT;
96 ehdr->e_type = ET_CORE;
97 ehdr->e_machine = VG_ELF_MACHINE;
98 ehdr->e_version = EV_CURRENT;
100 ehdr->e_phoff = sizeof(ESZ(Ehdr));
103 ehdr->e_ehsize = sizeof(ESZ(Ehdr));
104 ehdr->e_phentsize = sizeof(ESZ(Phdr));
105 ehdr->e_phnum = num_phdrs;
106 ehdr->e_shentsize = 0;
108 ehdr->e_shstrndx = 0;
112 static void fill_phdr(ESZ(Phdr) *phdr, const NSegment *seg, UInt off, Bool write)
114 SizeT len = seg->end - seg->start;
116 write = write && should_dump(seg);
118 VG_(memset)(phdr, 0, sizeof(*phdr));
120 phdr->p_type = PT_LOAD;
121 phdr->p_offset = off;
122 phdr->p_vaddr = seg->start;
124 phdr->p_filesz = write ? len : 0;
129 phdr->p_flags |= PF_R;
131 phdr->p_flags |= PF_W;
133 phdr->p_flags |= PF_X;
135 phdr->p_align = VKI_PAGE_SIZE;
144 static UInt note_size(const struct note *n)
146 return sizeof(ESZ(Nhdr)) + VG_ROUNDUP(VG_(strlen)(n->name)+1, 4) + VG_ROUNDUP(n->note.n_descsz, 4);
149 static void add_note(struct note **list, const Char *name, UInt type, const void *data, UInt datasz)
151 Int namelen = VG_(strlen)(name)+1;
152 Int notelen = sizeof(struct note) +
153 VG_ROUNDUP(namelen, 4) +
154 VG_ROUNDUP(datasz, 4);
155 struct note *n = VG_(arena_malloc)(VG_AR_CORE, "coredump-elf.an.1", notelen);
157 VG_(memset)(n, 0, notelen);
162 n->note.n_type = type;
163 n->note.n_namesz = namelen;
164 n->note.n_descsz = datasz;
166 VG_(memcpy)(n->name, name, namelen);
167 VG_(memcpy)(n->name+VG_ROUNDUP(namelen,4), data, datasz);
170 static void write_note(Int fd, const struct note *n)
172 VG_(write)(fd, &n->note, note_size(n));
175 static void fill_prpsinfo(const ThreadState *tst, struct vki_elf_prpsinfo *prpsinfo)
177 static Char name[VKI_PATH_MAX];
179 VG_(memset)(prpsinfo, 0, sizeof(*prpsinfo));
181 switch(tst->status) {
184 prpsinfo->pr_sname = 'R';
188 prpsinfo->pr_sname = 'S';
192 prpsinfo->pr_sname = 'Z';
197 prpsinfo->pr_sname = '?';
201 prpsinfo->pr_uid = 0;
202 prpsinfo->pr_gid = 0;
204 if (VG_(resolve_filename)(VG_(cl_exec_fd), name, VKI_PATH_MAX)) {
205 Char *n = name+VG_(strlen)(name)-1;
207 while (n > name && *n != '/')
212 VG_(strncpy)(prpsinfo->pr_fname, n, sizeof(prpsinfo->pr_fname));
216 static void fill_prstatus(const ThreadState *tst,
217 struct vki_elf_prstatus *prs,
218 const vki_siginfo_t *si)
220 struct vki_user_regs_struct *regs;
221 ThreadArchState* arch = (ThreadArchState*)&tst->arch;
223 VG_(memset)(prs, 0, sizeof(*prs));
225 prs->pr_info.si_signo = si->si_signo;
226 prs->pr_info.si_code = si->si_code;
227 prs->pr_info.si_errno = 0;
229 prs->pr_cursig = si->si_signo;
231 prs->pr_pid = tst->os_state.lwpid;
233 prs->pr_pgrp = VG_(getpgrp)();
234 prs->pr_sid = VG_(getpgrp)();
236 regs = (struct vki_user_regs_struct *)prs->pr_reg;
238 vg_assert(sizeof(*regs) == sizeof(prs->pr_reg));
240 #if defined(VGP_x86_linux)
241 regs->eflags = LibVEX_GuestX86_get_eflags( &arch->vex );
242 regs->esp = arch->vex.guest_ESP;
243 regs->eip = arch->vex.guest_EIP;
245 regs->ebx = arch->vex.guest_EBX;
246 regs->ecx = arch->vex.guest_ECX;
247 regs->edx = arch->vex.guest_EDX;
248 regs->esi = arch->vex.guest_ESI;
249 regs->edi = arch->vex.guest_EDI;
250 regs->ebp = arch->vex.guest_EBP;
251 regs->eax = arch->vex.guest_EAX;
253 regs->cs = arch->vex.guest_CS;
254 regs->ds = arch->vex.guest_DS;
255 regs->ss = arch->vex.guest_SS;
256 regs->es = arch->vex.guest_ES;
257 regs->fs = arch->vex.guest_FS;
258 regs->gs = arch->vex.guest_GS;
260 #elif defined(VGP_amd64_linux)
261 regs->eflags = LibVEX_GuestAMD64_get_rflags( &((ThreadArchState*)arch)->vex );
262 regs->rsp = arch->vex.guest_RSP;
263 regs->rip = arch->vex.guest_RIP;
265 regs->rbx = arch->vex.guest_RBX;
266 regs->rcx = arch->vex.guest_RCX;
267 regs->rdx = arch->vex.guest_RDX;
268 regs->rsi = arch->vex.guest_RSI;
269 regs->rdi = arch->vex.guest_RDI;
270 regs->rbp = arch->vex.guest_RBP;
271 regs->rax = arch->vex.guest_RAX;
272 regs->r8 = arch->vex.guest_R8;
273 regs->r9 = arch->vex.guest_R9;
274 regs->r10 = arch->vex.guest_R10;
275 regs->r11 = arch->vex.guest_R11;
276 regs->r12 = arch->vex.guest_R12;
277 regs->r13 = arch->vex.guest_R13;
278 regs->r14 = arch->vex.guest_R14;
279 regs->r15 = arch->vex.guest_R15;
281 //:: regs->cs = arch->vex.guest_CS;
282 //:: regs->fs = arch->vex.guest_FS;
283 //:: regs->gs = arch->vex.guest_GS;
285 #elif defined(VGP_ppc32_linux)
286 # define DO(n) regs->gpr[n] = arch->vex.guest_GPR##n
287 DO(0); DO(1); DO(2); DO(3); DO(4); DO(5); DO(6); DO(7);
288 DO(8); DO(9); DO(10); DO(11); DO(12); DO(13); DO(14); DO(15);
289 DO(16); DO(17); DO(18); DO(19); DO(20); DO(21); DO(22); DO(23);
290 DO(24); DO(25); DO(26); DO(27); DO(28); DO(29); DO(30); DO(31);
293 regs->nip = arch->vex.guest_CIA;
294 regs->msr = 0xf032; /* pretty arbitrary */
295 regs->orig_gpr3 = arch->vex.guest_GPR3;
296 regs->ctr = arch->vex.guest_CTR;
297 regs->link = arch->vex.guest_LR;
298 regs->xer = LibVEX_GuestPPC32_get_XER( &((ThreadArchState*)arch)->vex );
299 regs->ccr = LibVEX_GuestPPC32_get_CR( &((ThreadArchState*)arch)->vex );
302 regs->dar = 0; /* should be fault address? */
306 #elif defined(VGP_ppc64_linux)
307 # define DO(n) regs->gpr[n] = arch->vex.guest_GPR##n
308 DO(0); DO(1); DO(2); DO(3); DO(4); DO(5); DO(6); DO(7);
309 DO(8); DO(9); DO(10); DO(11); DO(12); DO(13); DO(14); DO(15);
310 DO(16); DO(17); DO(18); DO(19); DO(20); DO(21); DO(22); DO(23);
311 DO(24); DO(25); DO(26); DO(27); DO(28); DO(29); DO(30); DO(31);
314 regs->nip = arch->vex.guest_CIA;
315 regs->msr = 0xf032; /* pretty arbitrary */
316 regs->orig_gpr3 = arch->vex.guest_GPR3;
317 regs->ctr = arch->vex.guest_CTR;
318 regs->link = arch->vex.guest_LR;
319 regs->xer = LibVEX_GuestPPC64_get_XER( &((ThreadArchState*)arch)->vex );
320 regs->ccr = LibVEX_GuestPPC64_get_CR( &((ThreadArchState*)arch)->vex );
323 regs->dar = 0; /* should be fault address? */
327 #elif defined(VGP_arm_linux)
328 regs->ARM_r0 = arch->vex.guest_R0;
329 regs->ARM_r1 = arch->vex.guest_R1;
330 regs->ARM_r2 = arch->vex.guest_R2;
331 regs->ARM_r3 = arch->vex.guest_R3;
332 regs->ARM_r4 = arch->vex.guest_R4;
333 regs->ARM_r5 = arch->vex.guest_R5;
334 regs->ARM_r6 = arch->vex.guest_R6;
335 regs->ARM_r7 = arch->vex.guest_R7;
336 regs->ARM_r8 = arch->vex.guest_R8;
337 regs->ARM_r9 = arch->vex.guest_R9;
338 regs->ARM_r10 = arch->vex.guest_R10;
339 regs->ARM_fp = arch->vex.guest_R11;
340 regs->ARM_ip = arch->vex.guest_R12;
341 regs->ARM_sp = arch->vex.guest_R13;
342 regs->ARM_lr = arch->vex.guest_R14;
343 regs->ARM_pc = arch->vex.guest_R15;
344 regs->ARM_cpsr = LibVEX_GuestARM_get_cpsr( &((ThreadArchState*)arch)->vex );
347 # error Unknown ELF platform
351 static void fill_fpu(const ThreadState *tst, vki_elf_fpregset_t *fpu)
353 __attribute__((unused))
354 ThreadArchState* arch = (ThreadArchState*)&tst->arch;
356 #if defined(VGP_x86_linux)
357 //:: static void fill_fpu(vki_elf_fpregset_t *fpu, const Char *from)
359 //:: if (VG_(have_ssestate)) {
363 //:: /* This is what the kernel does */
364 //:: VG_(memcpy)(fpu, from, 7*sizeof(long));
366 //:: to = (UShort *)&fpu->st_space[0];
367 //:: from += 18 * sizeof(UShort);
369 //:: for (i = 0; i < 8; i++, to += 5, from += 8)
370 //:: VG_(memcpy)(to, from, 5*sizeof(UShort));
372 //:: VG_(memcpy)(fpu, from, sizeof(*fpu));
375 //:: fill_fpu(fpu, (const Char *)&arch->m_sse);
377 #elif defined(VGP_amd64_linux)
385 //:: fpu->mxcsr_mask = ?;
386 //:: fpu->st_space = ?;
388 # define DO(n) VG_(memcpy)(fpu->xmm_space + n * 4, &arch->vex.guest_XMM##n, sizeof(arch->vex.guest_XMM##n))
389 DO(0); DO(1); DO(2); DO(3); DO(4); DO(5); DO(6); DO(7);
390 DO(8); DO(9); DO(10); DO(11); DO(12); DO(13); DO(14); DO(15);
393 VG_(memset)(fpu->padding, 0, sizeof(fpu->padding));
395 #elif defined(VGP_ppc32_linux)
396 /* The guest state has the FPR fields declared as ULongs, so need
397 to fish out the values without converting them. */
398 # define DO(n) (*fpu)[n] = *(double*)(&arch->vex.guest_FPR##n)
399 DO(0); DO(1); DO(2); DO(3); DO(4); DO(5); DO(6); DO(7);
400 DO(8); DO(9); DO(10); DO(11); DO(12); DO(13); DO(14); DO(15);
401 DO(16); DO(17); DO(18); DO(19); DO(20); DO(21); DO(22); DO(23);
402 DO(24); DO(25); DO(26); DO(27); DO(28); DO(29); DO(30); DO(31);
405 #elif defined(VGP_ppc64_linux)
406 /* The guest state has the FPR fields declared as ULongs, so need
407 to fish out the values without converting them. */
408 # define DO(n) (*fpu)[n] = *(double*)(&arch->vex.guest_FPR##n)
409 DO(0); DO(1); DO(2); DO(3); DO(4); DO(5); DO(6); DO(7);
410 DO(8); DO(9); DO(10); DO(11); DO(12); DO(13); DO(14); DO(15);
411 DO(16); DO(17); DO(18); DO(19); DO(20); DO(21); DO(22); DO(23);
412 DO(24); DO(25); DO(26); DO(27); DO(28); DO(29); DO(30); DO(31);
415 #elif defined(VGP_arm_linux)
419 # error Unknown ELF platform
423 #if defined(VGP_x86_linux)
424 static void fill_xfpu(const ThreadState *tst, vki_elf_fpxregset_t *xfpu)
426 ThreadArchState* arch = (ThreadArchState*)&tst->arch;
436 //:: xfpu->mxcsr = ?;
438 //:: xfpu->st_space = ?;
440 # define DO(n) VG_(memcpy)(xfpu->xmm_space + n * 4, &arch->vex.guest_XMM##n, sizeof(arch->vex.guest_XMM##n))
441 DO(0); DO(1); DO(2); DO(3); DO(4); DO(5); DO(6); DO(7);
444 VG_(memset)(xfpu->padding, 0, sizeof(xfpu->padding));
449 void make_elf_coredump(ThreadId tid, const vki_siginfo_t *si, UInt max_size)
452 Char *basename = "vgcore";
456 NSegment const * seg;
462 struct note *notelist, *note;
464 struct vki_elf_prpsinfo prpsinfo;
465 struct vki_elf_prstatus prstatus;
469 if (VG_(clo_log_fname_expanded) != NULL) {
471 basename = VG_(expand_file_name)(
472 "--log-file (while creating core filename)",
473 VG_(clo_log_fname_expanded));
478 buf = VG_(malloc)( "coredump-elf.mec.1",
479 VG_(strlen)(coreext) + VG_(strlen)(basename)
480 + 100/*for the two %ds. */ );
487 VG_(sprintf)(buf, "%s%s.%d",
488 basename, coreext, VG_(getpid)());
490 VG_(sprintf)(buf, "%s%s.%d.%d",
491 basename, coreext, VG_(getpid)(), seq);
494 sres = VG_(open)(buf,
495 VKI_O_CREAT|VKI_O_WRONLY|VKI_O_EXCL|VKI_O_TRUNC,
496 VKI_S_IRUSR|VKI_S_IWUSR);
497 if (!sr_isError(sres)) {
498 core_fd = sr_Res(sres);
502 if (sr_isError(sres) && sr_Err(sres) != VKI_EEXIST)
503 return; /* can't create file */
506 /* Get the segments */
507 seg_starts = VG_(get_segment_starts)(&n_seg_starts);
509 /* First, count how many memory segments to dump */
510 num_phdrs = 1; /* start with notes */
511 for(i = 0; i < n_seg_starts; i++) {
512 if (!may_dump(VG_(am_find_nsegment(seg_starts[i]))))
518 fill_ehdr(&ehdr, num_phdrs);
522 /* Second, work out their layout */
523 phdrs = VG_(arena_malloc)(VG_AR_CORE, "coredump-elf.mec.1",
524 sizeof(*phdrs) * num_phdrs);
526 for(i = 1; i < VG_N_THREADS; i++) {
527 vki_elf_fpregset_t fpu;
529 if (VG_(threads)[i].status == VgTs_Empty)
532 #if defined(VGP_x86_linux)
534 vki_elf_fpxregset_t xfpu;
535 fill_xfpu(&VG_(threads)[i], &xfpu);
536 add_note(¬elist, "LINUX", NT_PRXFPREG, &xfpu, sizeof(xfpu));
540 fill_fpu(&VG_(threads)[i], &fpu);
541 add_note(¬elist, "CORE", NT_FPREGSET, &fpu, sizeof(fpu));
543 fill_prstatus(&VG_(threads)[i], &prstatus, si);
544 add_note(¬elist, "CORE", NT_PRSTATUS, &prstatus, sizeof(prstatus));
547 fill_prpsinfo(&VG_(threads)[tid], &prpsinfo);
548 add_note(¬elist, "CORE", NT_PRPSINFO, &prpsinfo, sizeof(prpsinfo));
550 for(note = notelist, notesz = 0; note != NULL; note = note->next)
551 notesz += note_size(note);
553 off = sizeof(ehdr) + sizeof(*phdrs) * num_phdrs;
555 phdrs[0].p_type = PT_NOTE;
556 phdrs[0].p_offset = off;
557 phdrs[0].p_vaddr = 0;
558 phdrs[0].p_paddr = 0;
559 phdrs[0].p_filesz = notesz;
560 phdrs[0].p_memsz = 0;
561 phdrs[0].p_flags = 0;
562 phdrs[0].p_align = 0;
566 off = VG_PGROUNDUP(off);
568 for(i = 0, idx = 1; i < n_seg_starts; i++) {
569 seg = VG_(am_find_nsegment(seg_starts[i]));
574 fill_phdr(&phdrs[idx], seg, off, (seg->end - seg->start + off) < max_size);
576 off += phdrs[idx].p_filesz;
581 /* write everything out */
582 VG_(write)(core_fd, &ehdr, sizeof(ehdr));
583 VG_(write)(core_fd, phdrs, sizeof(*phdrs) * num_phdrs);
585 for(note = notelist; note != NULL; note = note->next)
586 write_note(core_fd, note);
588 VG_(lseek)(core_fd, phdrs[1].p_offset, VKI_SEEK_SET);
590 for(i = 0, idx = 1; i < n_seg_starts; i++) {
591 seg = VG_(am_find_nsegment(seg_starts[i]));
593 if (!should_dump(seg))
596 if (phdrs[idx].p_filesz > 0) {
597 vg_assert(VG_(lseek)(core_fd, phdrs[idx].p_offset, VKI_SEEK_SET) == phdrs[idx].p_offset);
598 vg_assert(seg->end - seg->start >= phdrs[idx].p_filesz);
600 (void)VG_(write)(core_fd, (void *)seg->start, phdrs[idx].p_filesz);
605 VG_(free)(seg_starts);
610 void VG_(make_coredump)(ThreadId tid, const vki_siginfo_t *si, UInt max_size)
612 make_elf_coredump(tid, si, max_size);
615 #endif // defined(VGO_linux)
617 /*--------------------------------------------------------------------*/
619 /*--------------------------------------------------------------------*/