1 /* Core dump and executable file functions below target vector, for GDB.
3 Copyright (C) 1986, 1987, 1989, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4 1998, 1999, 2000, 2001, 2003, 2004, 2005, 2006, 2007, 2008
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "arch-utils.h"
24 #include "gdb_string.h"
28 #ifdef HAVE_SYS_FILE_H
29 #include <sys/file.h> /* needed for F_OK and friends */
31 #include "frame.h" /* required by inferior.h */
38 #include "gdbthread.h"
43 #include "readline/readline.h"
44 #include "gdb_assert.h"
45 #include "exceptions.h"
47 #include "filenames.h"
54 /* List of all available core_fns. On gdb startup, each core file
55 register reader calls deprecated_add_core_fns() to register
56 information on each core format it is prepared to read. */
58 static struct core_fns *core_file_fns = NULL;
60 /* The core_fns for a core file handler that is prepared to read the core
61 file currently open on core_bfd. */
63 static struct core_fns *core_vec = NULL;
65 /* FIXME: kettenis/20031023: Eventually this variable should
68 struct gdbarch *core_gdbarch = NULL;
70 static void core_files_info (struct target_ops *);
72 static struct core_fns *sniff_core_bfd (bfd *);
74 static int gdb_check_format (bfd *);
76 static void core_open (char *, int);
78 static void core_detach (char *, int);
80 static void core_close (int);
82 static void core_close_cleanup (void *ignore);
84 static void get_core_registers (struct regcache *, int);
86 static void add_to_thread_list (bfd *, asection *, void *);
88 static int core_file_thread_alive (ptid_t tid);
90 static void init_core_ops (void);
92 void _initialize_corelow (void);
94 struct target_ops core_ops;
96 /* An arbitrary identifier for the core inferior. */
99 /* Link a new core_fns into the global core_file_fns list. Called on gdb
100 startup by the _initialize routine in each core file register reader, to
101 register information about each format the the reader is prepared to
105 deprecated_add_core_fns (struct core_fns *cf)
107 cf->next = core_file_fns;
111 /* The default function that core file handlers can use to examine a
112 core file BFD and decide whether or not to accept the job of
113 reading the core file. */
116 default_core_sniffer (struct core_fns *our_fns, bfd *abfd)
120 result = (bfd_get_flavour (abfd) == our_fns -> core_flavour);
124 /* Walk through the list of core functions to find a set that can
125 handle the core file open on ABFD. Default to the first one in the
126 list if nothing matches. Returns pointer to set that is
129 static struct core_fns *
130 sniff_core_bfd (bfd *abfd)
133 struct core_fns *yummy = NULL;
136 /* Don't sniff if we have support for register sets in CORE_GDBARCH. */
137 if (core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
140 for (cf = core_file_fns; cf != NULL; cf = cf->next)
142 if (cf->core_sniffer (cf, abfd))
150 warning (_("\"%s\": ambiguous core format, %d handlers match"),
151 bfd_get_filename (abfd), matches);
153 else if (matches == 0)
155 warning (_("\"%s\": no core file handler recognizes format, using default"),
156 bfd_get_filename (abfd));
160 yummy = core_file_fns;
165 /* The default is to reject every core file format we see. Either
166 BFD has to recognize it, or we have to provide a function in the
167 core file handler that recognizes it. */
170 default_check_format (bfd *abfd)
175 /* Attempt to recognize core file formats that BFD rejects. */
178 gdb_check_format (bfd *abfd)
182 for (cf = core_file_fns; cf != NULL; cf = cf->next)
184 if (cf->check_format (abfd))
192 /* Discard all vestiges of any previous core file and mark data and stack
196 core_close (int quitting)
202 inferior_ptid = null_ptid; /* Avoid confusion from thread stuff */
203 delete_inferior_silent (CORELOW_PID);
205 /* Clear out solib state while the bfd is still open. See
206 comments in clear_solib in solib.c. */
209 name = bfd_get_filename (core_bfd);
210 if (!bfd_close (core_bfd))
211 warning (_("cannot close \"%s\": %s"),
212 name, bfd_errmsg (bfd_get_error ()));
215 if (core_ops.to_sections)
217 xfree (core_ops.to_sections);
218 core_ops.to_sections = NULL;
219 core_ops.to_sections_end = NULL;
227 core_close_cleanup (void *ignore)
229 core_close (0/*ignored*/);
232 /* Look for sections whose names start with `.reg/' so that we can extract the
233 list of threads in a core file. */
236 add_to_thread_list (bfd *abfd, asection *asect, void *reg_sect_arg)
240 asection *reg_sect = (asection *) reg_sect_arg;
242 if (strncmp (bfd_section_name (abfd, asect), ".reg/", 5) != 0)
245 thread_id = atoi (bfd_section_name (abfd, asect) + 5);
247 ptid = ptid_build (ptid_get_pid (inferior_ptid), thread_id, 0);
249 if (ptid_get_lwp (inferior_ptid) == 0)
250 /* The main thread has already been added before getting here, and
251 this is the first time we hear about a thread id. Assume this
252 is the main thread. */
253 thread_change_ptid (inferior_ptid, ptid);
255 /* Nope, really a new thread. */
258 /* Warning, Will Robinson, looking at BFD private data! */
261 && asect->filepos == reg_sect->filepos) /* Did we find .reg? */
262 inferior_ptid = ptid; /* Yes, make it current */
265 /* This routine opens and sets up the core file bfd. */
268 core_open (char *filename, int from_tty)
272 struct cleanup *old_chain;
277 int corelow_pid = CORELOW_PID;
279 target_preopen (from_tty);
283 error (_("No core file specified. (Use `detach' to stop debugging a core file.)"));
285 error (_("No core file specified."));
288 filename = tilde_expand (filename);
289 if (!IS_ABSOLUTE_PATH(filename))
291 temp = concat (current_directory, "/", filename, (char *)NULL);
296 old_chain = make_cleanup (xfree, filename);
298 flags = O_BINARY | O_LARGEFILE;
303 scratch_chan = open (filename, flags, 0);
304 if (scratch_chan < 0)
305 perror_with_name (filename);
307 temp_bfd = bfd_fopen (filename, gnutarget,
308 write_files ? FOPEN_RUB : FOPEN_RB,
310 if (temp_bfd == NULL)
311 perror_with_name (filename);
313 if (!bfd_check_format (temp_bfd, bfd_core) &&
314 !gdb_check_format (temp_bfd))
316 /* Do it after the err msg */
317 /* FIXME: should be checking for errors from bfd_close (for one thing,
318 on error it does not free all the storage associated with the
320 make_cleanup_bfd_close (temp_bfd);
321 error (_("\"%s\" is not a core dump: %s"),
322 filename, bfd_errmsg (bfd_get_error ()));
325 /* Looks semi-reasonable. Toss the old core file and work on the new. */
327 discard_cleanups (old_chain); /* Don't free filename any more */
328 unpush_target (&core_ops);
330 old_chain = make_cleanup (core_close_cleanup, 0 /*ignore*/);
332 /* FIXME: kettenis/20031023: This is very dangerous. The
333 CORE_GDBARCH that results from this call may very well be
334 different from CURRENT_GDBARCH. However, its methods may only
335 work if it is selected as the current architecture, because they
336 rely on swapped data (see gdbarch.c). We should get rid of that
338 core_gdbarch = gdbarch_from_bfd (core_bfd);
340 /* Find a suitable core file handler to munch on core_bfd */
341 core_vec = sniff_core_bfd (core_bfd);
345 /* Find the data section */
346 if (build_section_table (core_bfd, &core_ops.to_sections,
347 &core_ops.to_sections_end))
348 error (_("\"%s\": Can't find sections: %s"),
349 bfd_get_filename (core_bfd), bfd_errmsg (bfd_get_error ()));
351 /* If we have no exec file, try to set the architecture from the
352 core file. We don't do this unconditionally since an exec file
353 typically contains more information that helps us determine the
354 architecture than a core file. */
356 set_gdbarch_from_file (core_bfd);
358 push_target (&core_ops);
359 discard_cleanups (old_chain);
361 add_inferior_silent (corelow_pid);
363 /* Do this before acknowledging the inferior, so if
364 post_create_inferior throws (can happen easilly if you're loading
365 a core file with the wrong exec), we aren't left with threads
366 from the previous inferior. */
369 /* Set INFERIOR_PTID early, so an upper layer can rely on it being
370 set while in the target_find_new_threads call below. */
371 inferior_ptid = pid_to_ptid (corelow_pid);
373 /* Assume ST --- Add a main task. We'll later detect when we go
375 add_thread_silent (inferior_ptid);
377 /* This is done first, before anything has a chance to query the
378 inferior for information such as symbols. */
379 post_create_inferior (&core_ops, from_tty);
381 /* Build up thread list from BFD sections, and possibly set the
382 current thread to the .reg/NN section matching the .reg
384 bfd_map_over_sections (core_bfd, add_to_thread_list,
385 bfd_get_section_by_name (core_bfd, ".reg"));
387 /* Now go through the target stack looking for threads since there
388 may be a thread_stratum target loaded on top of target core by
389 now. The layer above should claim threads found in the BFD
391 target_find_new_threads ();
393 p = bfd_core_file_failing_command (core_bfd);
395 printf_filtered (_("Core was generated by `%s'.\n"), p);
397 siggy = bfd_core_file_failing_signal (core_bfd);
399 /* NOTE: target_signal_from_host() converts a target signal value
400 into gdb's internal signal value. Unfortunately gdb's internal
401 value is called ``target_signal'' and this function got the
402 name ..._from_host(). */
403 printf_filtered (_("Program terminated with signal %d, %s.\n"), siggy,
404 target_signal_to_string (
405 gdbarch_target_signal_from_host (core_gdbarch, siggy)));
407 /* Fetch all registers from core file. */
408 target_fetch_registers (get_current_regcache (), -1);
410 /* Now, set up the frame cache, and print the top of stack. */
411 reinit_frame_cache ();
412 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
416 core_detach (char *args, int from_tty)
419 error (_("Too many arguments"));
420 unpush_target (&core_ops);
421 reinit_frame_cache ();
423 printf_filtered (_("No core file now.\n"));
427 /* Try to retrieve registers from a section in core_bfd, and supply
428 them to core_vec->core_read_registers, as the register set numbered
431 If inferior_ptid's lwp member is zero, do the single-threaded
432 thing: look for a section named NAME. If inferior_ptid's lwp
433 member is non-zero, do the multi-threaded thing: look for a section
434 named "NAME/LWP", where LWP is the shortest ASCII decimal
435 representation of inferior_ptid's lwp member.
437 HUMAN_NAME is a human-readable name for the kind of registers the
438 NAME section contains, for use in error messages.
440 If REQUIRED is non-zero, print an error if the core file doesn't
441 have a section by the appropriate name. Otherwise, just do nothing. */
444 get_core_register_section (struct regcache *regcache,
450 static char *section_name = NULL;
451 struct bfd_section *section;
455 xfree (section_name);
456 if (ptid_get_lwp (inferior_ptid))
457 section_name = xstrprintf ("%s/%ld", name, ptid_get_lwp (inferior_ptid));
459 section_name = xstrdup (name);
461 section = bfd_get_section_by_name (core_bfd, section_name);
465 warning (_("Couldn't find %s registers in core file."), human_name);
469 size = bfd_section_size (core_bfd, section);
470 contents = alloca (size);
471 if (! bfd_get_section_contents (core_bfd, section, contents,
474 warning (_("Couldn't read %s registers from `%s' section in core file."),
479 if (core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
481 const struct regset *regset;
483 regset = gdbarch_regset_from_core_section (core_gdbarch, name, size);
487 warning (_("Couldn't recognize %s registers in core file."),
492 regset->supply_regset (regset, regcache, -1, contents, size);
496 gdb_assert (core_vec);
497 core_vec->core_read_registers (regcache, contents, size, which,
499 bfd_section_vma (core_bfd, section)));
503 /* Get the registers out of a core file. This is the machine-
504 independent part. Fetch_core_registers is the machine-dependent
505 part, typically implemented in the xm-file for each architecture. */
507 /* We just get all the registers, so we don't use regno. */
510 get_core_registers (struct regcache *regcache, int regno)
514 if (!(core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
515 && (core_vec == NULL || core_vec->core_read_registers == NULL))
517 fprintf_filtered (gdb_stderr,
518 "Can't fetch registers from this type of core file\n");
522 get_core_register_section (regcache,
523 ".reg", 0, "general-purpose", 1);
524 get_core_register_section (regcache,
525 ".reg2", 2, "floating-point", 0);
526 get_core_register_section (regcache,
527 ".reg-xfp", 3, "extended floating-point", 0);
528 get_core_register_section (regcache,
529 ".reg-ppc-vmx", 3, "ppc Altivec", 0);
530 get_core_register_section (regcache,
531 ".reg-ppc-vsx", 4, "POWER7 VSX", 0);
533 /* Supply dummy value for all registers not found in the core. */
534 for (i = 0; i < gdbarch_num_regs (get_regcache_arch (regcache)); i++)
535 if (!regcache_valid_p (regcache, i))
536 regcache_raw_supply (regcache, i, NULL);
540 core_files_info (struct target_ops *t)
542 print_section_info (t, core_bfd);
546 core_xfer_partial (struct target_ops *ops, enum target_object object,
547 const char *annex, gdb_byte *readbuf,
548 const gdb_byte *writebuf, ULONGEST offset, LONGEST len)
552 case TARGET_OBJECT_MEMORY:
554 return (*ops->deprecated_xfer_memory) (offset, readbuf,
555 len, 0/*read*/, NULL, ops);
557 return (*ops->deprecated_xfer_memory) (offset, (gdb_byte *) writebuf,
558 len, 1/*write*/, NULL, ops);
561 case TARGET_OBJECT_AUXV:
564 /* When the aux vector is stored in core file, BFD
565 represents this with a fake section called ".auxv". */
567 struct bfd_section *section;
571 section = bfd_get_section_by_name (core_bfd, ".auxv");
575 size = bfd_section_size (core_bfd, section);
582 && !bfd_get_section_contents (core_bfd, section, readbuf,
583 (file_ptr) offset, size))
585 warning (_("Couldn't read NT_AUXV note in core file."));
593 case TARGET_OBJECT_WCOOKIE:
596 /* When the StackGhost cookie is stored in core file, BFD
597 represents this with a fake section called ".wcookie". */
599 struct bfd_section *section;
603 section = bfd_get_section_by_name (core_bfd, ".wcookie");
607 size = bfd_section_size (core_bfd, section);
614 && !bfd_get_section_contents (core_bfd, section, readbuf,
615 (file_ptr) offset, size))
617 warning (_("Couldn't read StackGhost cookie in core file."));
625 case TARGET_OBJECT_LIBRARIES:
627 && gdbarch_core_xfer_shared_libraries_p (core_gdbarch))
632 gdbarch_core_xfer_shared_libraries (core_gdbarch,
633 readbuf, offset, len);
638 if (ops->beneath != NULL)
639 return ops->beneath->to_xfer_partial (ops->beneath, object, annex,
640 readbuf, writebuf, offset, len);
646 /* If mourn is being called in all the right places, this could be say
647 `gdb internal error' (since generic_mourn calls breakpoint_init_inferior). */
650 ignore (struct bp_target_info *bp_tgt)
656 /* Okay, let's be honest: threads gleaned from a core file aren't
657 exactly lively, are they? On the other hand, if we don't claim
658 that each & every one is alive, then we don't get any of them
659 to appear in an "info thread" command, which is quite a useful
663 core_file_thread_alive (ptid_t tid)
668 /* Ask the current architecture what it knows about this core file.
669 That will be used, in turn, to pick a better architecture. This
670 wrapper could be avoided if targets got a chance to specialize
673 static const struct target_desc *
674 core_read_description (struct target_ops *target)
676 if (gdbarch_core_read_description_p (current_gdbarch))
677 return gdbarch_core_read_description (current_gdbarch, target, core_bfd);
683 core_pid_to_str (ptid_t ptid)
687 if (ptid_get_lwp (ptid) == 0)
688 xsnprintf (buf, sizeof buf, "<main task>");
690 xsnprintf (buf, sizeof buf, "Thread %ld", ptid_get_lwp (ptid));
695 /* Fill in core_ops with its defined operations and properties. */
700 core_ops.to_shortname = "core";
701 core_ops.to_longname = "Local core dump file";
703 "Use a core file as a target. Specify the filename of the core file.";
704 core_ops.to_open = core_open;
705 core_ops.to_close = core_close;
706 core_ops.to_attach = find_default_attach;
707 core_ops.to_detach = core_detach;
708 core_ops.to_fetch_registers = get_core_registers;
709 core_ops.to_xfer_partial = core_xfer_partial;
710 core_ops.deprecated_xfer_memory = xfer_memory;
711 core_ops.to_files_info = core_files_info;
712 core_ops.to_insert_breakpoint = ignore;
713 core_ops.to_remove_breakpoint = ignore;
714 core_ops.to_create_inferior = find_default_create_inferior;
715 core_ops.to_thread_alive = core_file_thread_alive;
716 core_ops.to_read_description = core_read_description;
717 core_ops.to_pid_to_str = core_pid_to_str;
718 core_ops.to_stratum = core_stratum;
719 core_ops.to_has_memory = 1;
720 core_ops.to_has_stack = 1;
721 core_ops.to_has_registers = 1;
722 core_ops.to_magic = OPS_MAGIC;
725 /* non-zero if we should not do the add_target call in
726 _initialize_corelow; not initialized (i.e., bss) so that
727 the target can initialize it (i.e., data) if appropriate.
728 This needs to be set at compile time because we don't know
729 for sure whether the target's initialize routine is called
730 before us or after us. */
731 int coreops_suppress_target;
734 _initialize_corelow (void)
738 if (!coreops_suppress_target)
739 add_target (&core_ops);