1 /* Generate a core file for the inferior process.
2 Copyright 2001, 2002 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
26 #include <sys/procfs.h>
30 static char *default_gcore_target (void);
31 static enum bfd_architecture default_gcore_arch (void);
32 static unsigned long default_gcore_mach (void);
33 static int gcore_memory_sections (bfd *);
35 /* Function: gcore_command
36 Generate a core file from the inferior process. */
39 gcore_command (char *args, int from_tty)
41 struct cleanup *old_chain;
42 char *corefilename, corefilename_buffer[40];
45 void *note_data = NULL;
48 /* No use generating a corefile without a target process. */
49 if (!(target_has_execution))
56 /* Default corefile name is "core.PID". */
57 sprintf (corefilename_buffer, "core.%d", PIDGET (inferior_ptid));
58 corefilename = corefilename_buffer;
62 fprintf_filtered (gdb_stdout,
63 "Opening corefile '%s' for output.\n", corefilename);
65 /* Open the output file. */
66 if (!(obfd = bfd_openw (corefilename, NULL /*default_gcore_target ()*/)))
68 error ("Failed to open '%s' for output.", corefilename);
71 /* Need a cleanup that will close the file (FIXME: delete it?). */
72 old_chain = make_cleanup_bfd_close (obfd);
74 bfd_set_format (obfd, bfd_core);
75 bfd_set_arch_mach (obfd, default_gcore_arch (), default_gcore_mach ());
77 /* An external target method must build the notes section. */
78 note_data = (char *) target_make_corefile_notes (obfd, ¬e_size);
80 /* Create the note section. */
81 if (note_data != NULL && note_size != 0)
83 if ((note_sec = bfd_make_section_anyway (obfd, "note0")) == NULL)
84 error ("Failed to create 'note' section for corefile: %s",
85 bfd_errmsg (bfd_get_error ()));
87 bfd_set_section_vma (obfd, note_sec, 0);
88 bfd_set_section_flags (obfd, note_sec,
89 SEC_HAS_CONTENTS | SEC_READONLY | SEC_ALLOC);
90 bfd_set_section_alignment (obfd, note_sec, 0);
91 bfd_set_section_size (obfd, note_sec, note_size);
94 /* Now create the memory/load sections. */
95 if (gcore_memory_sections (obfd) == 0)
96 error ("gcore: failed to get corefile memory sections from target.");
98 /* Write out the contents of the note section. */
99 if (note_data != NULL && note_size != 0)
101 if (!bfd_set_section_contents (obfd, note_sec, note_data, 0, note_size))
103 warning ("writing note section (%s)",
104 bfd_errmsg (bfd_get_error ()));
109 fprintf_filtered (gdb_stdout,
110 "Saved corefile %s\n", corefilename);
112 /* Clean-ups will close the output file and free malloc memory. */
113 do_cleanups (old_chain);
118 default_gcore_mach (void)
120 #ifdef TARGET_ARCHITECTURE
121 const struct bfd_arch_info * bfdarch = TARGET_ARCHITECTURE;
124 return bfdarch->mach;
126 if (exec_bfd == NULL)
127 error ("Can't find default bfd machine type (need execfile).");
129 return bfd_get_mach (exec_bfd);
132 static enum bfd_architecture
133 default_gcore_arch (void)
135 #ifdef TARGET_ARCHITECTURE
136 const struct bfd_arch_info * bfdarch = TARGET_ARCHITECTURE;
139 return bfdarch->arch;
141 if (exec_bfd == NULL)
142 error ("Can't find bfd architecture for corefile (need execfile).");
144 return bfd_get_arch (exec_bfd);
148 default_gcore_target (void)
150 /* FIXME -- this may only work for ELF targets. */
151 if (exec_bfd == NULL)
152 error ("Can't find default bfd target for corefile (need execfile).");
154 return bfd_get_target (exec_bfd);
158 * Default method for stack segment (preemptable by target).
161 static int (*override_derive_stack_segment) (bfd_vma *, bfd_vma *);
164 preempt_derive_stack_segment (int (*override_func) (bfd_vma *, bfd_vma *))
166 override_derive_stack_segment = override_func;
169 /* Function: default_derive_stack_segment
170 Derive a reasonable stack segment by unwinding the target stack.
172 Returns 0 for failure, 1 for success. */
175 default_derive_stack_segment (bfd_vma *bottom, bfd_vma *top)
178 struct frame_info *fi, *tmp_fi;
180 if (bottom == NULL || top == NULL)
181 return 0; /* Paranoia. */
183 if (!target_has_stack || !target_has_registers)
184 return 0; /* Can't succeed without stack and registers. */
186 if ((fi = get_current_frame ()) == NULL)
187 return 0; /* Can't succeed without current frame. */
189 /* Save frame pointer of TOS frame. */
191 /* If current stack pointer is more "inner", use that instead. */
192 if (INNER_THAN (read_sp (), *top))
195 /* Find prev-most frame. */
196 while ((tmp_fi = get_prev_frame (fi)) != NULL)
199 /* Save frame pointer of prev-most frame. */
202 /* Now canonicalize their order, so that 'bottom' is a lower address
203 (as opposed to a lower stack frame). */
211 return 1; /* success */
215 derive_stack_segment (bfd_vma *bottom, bfd_vma *top)
217 if (override_derive_stack_segment)
218 return override_derive_stack_segment (bottom, top);
220 return default_derive_stack_segment (bottom, top);
224 * Default method for heap segment (preemptable by target).
227 static int (*override_derive_heap_segment) (bfd *, bfd_vma *, bfd_vma *);
230 preempt_derive_heap_segment (int (*override_func) (bfd *,
231 bfd_vma *, bfd_vma *))
233 override_derive_heap_segment = override_func;
236 /* Function: default_derive_heap_segment
237 Derive a reasonable heap segment by looking at sbrk and
238 the static data sections.
240 Returns 0 for failure, 1 for success. */
243 default_derive_heap_segment (bfd *abfd, bfd_vma *bottom, bfd_vma *top)
245 bfd_vma top_of_data_memory = 0;
246 bfd_vma top_of_heap = 0;
247 bfd_size_type sec_size;
248 struct value *zero, *sbrk;
252 if (bottom == NULL || top == NULL)
253 return 0; /* Paranoia. */
255 if (!target_has_execution)
256 return 0; /* This function depends on being able
257 to call a function in the inferior. */
259 /* Assumption: link map is arranged as follows (low to high addresses):
261 data sections (including bss)
265 for (sec = abfd->sections; sec; sec = sec->next)
267 if (bfd_get_section_flags (abfd, sec) & SEC_DATA ||
268 strcmp (".bss", bfd_get_section_name (abfd, sec)) == 0)
270 sec_vaddr = bfd_get_section_vma (abfd, sec);
271 sec_size = bfd_get_section_size_before_reloc (sec);
272 if (sec_vaddr + sec_size > top_of_data_memory)
273 top_of_data_memory = sec_vaddr + sec_size;
276 /* Now get the top-of-heap by calling sbrk in the inferior. */
277 if ((sbrk = find_function_in_inferior ("sbrk")) == NULL)
279 if ((zero = value_from_longest (builtin_type_int, (LONGEST) 0)) == NULL)
281 if ((sbrk = call_function_by_hand (sbrk, 1, &zero)) == NULL)
283 top_of_heap = value_as_long (sbrk);
285 /* Return results. */
286 if (top_of_heap > top_of_data_memory)
288 *bottom = top_of_data_memory;
290 return 1; /* success */
293 return 0; /* No additional heap space needs to be saved. */
297 derive_heap_segment (bfd *abfd, bfd_vma *bottom, bfd_vma *top)
299 if (override_derive_heap_segment)
300 return override_derive_heap_segment (abfd, bottom, top);
302 return default_derive_heap_segment (abfd, bottom, top);
307 make_output_phdrs (bfd *obfd, asection *osec, void *ignored)
312 /* FIXME: these constants may only be applicable for ELF. */
313 if (strncmp (osec->name, "load", 4) == 0)
318 p_flags |= PF_R; /* Segment is readable. */
319 if (!(bfd_get_section_flags (obfd, osec) & SEC_READONLY))
320 p_flags |= PF_W; /* Segment is writable. */
321 if (bfd_get_section_flags (obfd, osec) & SEC_CODE)
322 p_flags |= PF_X; /* Segment is executable. */
324 bfd_record_phdr (obfd, p_type, 1, p_flags, 0, 0,
329 make_mem_sec (bfd *obfd,
333 unsigned int alignment)
337 if ((osec = bfd_make_section_anyway (obfd, "load")) == NULL)
339 warning ("Couldn't make gcore segment: %s",
340 bfd_errmsg (bfd_get_error ()));
346 fprintf_filtered (gdb_stdout,
347 "Save segment, %ld bytes at 0x%s\n",
348 size, paddr_nz (addr));
351 bfd_set_section_size (obfd, osec, size);
352 bfd_set_section_vma (obfd, osec, addr);
353 osec->lma = 0; /* FIXME: there should be a macro for this! */
354 bfd_set_section_alignment (obfd, osec, alignment);
355 bfd_set_section_flags (obfd, osec,
356 flags | SEC_LOAD | SEC_ALLOC | SEC_HAS_CONTENTS);
361 gcore_create_callback (CORE_ADDR vaddr,
363 int read, int write, int exec,
370 flags |= SEC_READONLY;
371 /* Set size == zero for readonly sections. */
383 return ((make_mem_sec ((bfd *) data, vaddr, size, flags, 0)) == NULL);
387 objfile_find_memory_regions (int (*func) (CORE_ADDR,
393 /* Use objfile data to create memory sections. */
394 struct objfile *objfile;
395 struct obj_section *objsec;
396 bfd_vma temp_bottom, temp_top;
398 /* Call callback function for each objfile section. */
399 ALL_OBJSECTIONS (objfile, objsec)
401 bfd *ibfd = objfile->obfd;
402 asection *isec = objsec->the_bfd_section;
403 flagword flags = bfd_get_section_flags (ibfd, isec);
406 if ((flags & SEC_ALLOC) || (flags & SEC_LOAD))
408 int size = bfd_section_size (ibfd, isec);
411 if ((ret = (*func) (objsec->addr,
412 bfd_section_size (ibfd, isec),
413 1, /* All sections will be readable. */
414 (flags & SEC_READONLY) == 0, /* writable */
415 (flags & SEC_CODE) != 0, /* executable */
421 /* Make a stack segment. */
422 if (derive_stack_segment (&temp_bottom, &temp_top))
423 (*func) (temp_bottom,
424 temp_top - temp_bottom,
425 1, /* Stack section will be readable */
426 1, /* Stack section will be writable */
427 0, /* Stack section will not be executable */
430 /* Make a heap segment. */
431 if (derive_heap_segment (exec_bfd, &temp_bottom, &temp_top))
432 (*func) (temp_bottom,
433 temp_top - temp_bottom,
434 1, /* Heap section will be readable */
435 1, /* Heap section will be writable */
436 0, /* Heap section will not be executable */
442 gcore_copy_callback (bfd *obfd, asection *osec, void *ignored)
444 bfd_size_type size = bfd_section_size (obfd, osec);
445 struct cleanup *old_chain = NULL;
449 return; /* Read-only sections are marked as zero-size.
450 We don't have to copy their contents. */
451 if (strncmp ("load", bfd_get_section_name (obfd, osec), 4) != 0)
452 return; /* Only interested in "load" sections. */
454 if ((memhunk = xmalloc (size)) == NULL)
455 error ("Not enough memory to create corefile.");
456 old_chain = make_cleanup (xfree, memhunk);
458 if (target_read_memory (bfd_section_vma (obfd, osec),
460 warning ("Memory read failed for corefile section, %ld bytes at 0x%s\n",
461 (long) size, paddr (bfd_section_vma (obfd, osec)));
462 if (!bfd_set_section_contents (obfd, osec, memhunk, 0, size))
463 warning ("Failed to write corefile contents (%s).",
464 bfd_errmsg (bfd_get_error ()));
466 do_cleanups (old_chain); /* frees the xmalloc buffer */
470 gcore_memory_sections (bfd *obfd)
472 if (target_find_memory_regions (gcore_create_callback, obfd) != 0)
473 return 0; /* FIXME error return/msg? */
475 /* Record phdrs for section-to-segment mapping. */
476 bfd_map_over_sections (obfd, make_output_phdrs, NULL);
478 /* Copy memory region contents. */
479 bfd_map_over_sections (obfd, gcore_copy_callback, NULL);
481 return 1; /* success */
485 _initialize_gcore (void)
487 add_com ("generate-core-file", class_files, gcore_command,
488 "Save a core file with the current state of the debugged process.\n\
489 Argument is optional filename. Default filename is 'core.<process_id>'.");
491 add_com_alias ("gcore", "generate-core-file", class_files, 1);
492 exec_set_find_memory_regions (objfile_find_memory_regions);