1 /* Core dump and executable file functions below target vector, for GDB.
3 Copyright (C) 1986-1987, 1989, 1991-2001, 2003-2012 Free Software
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "arch-utils.h"
23 #include "gdb_string.h"
27 #ifdef HAVE_SYS_FILE_H
28 #include <sys/file.h> /* needed for F_OK and friends */
30 #include "frame.h" /* required by inferior.h */
37 #include "gdbthread.h"
42 #include "readline/readline.h"
43 #include "gdb_assert.h"
44 #include "exceptions.h"
46 #include "filenames.h"
47 #include "progspace.h"
55 /* List of all available core_fns. On gdb startup, each core file
56 register reader calls deprecated_add_core_fns() to register
57 information on each core format it is prepared to read. */
59 static struct core_fns *core_file_fns = NULL;
61 /* The core_fns for a core file handler that is prepared to read the
62 core file currently open on core_bfd. */
64 static struct core_fns *core_vec = NULL;
66 /* FIXME: kettenis/20031023: Eventually this variable should
69 struct gdbarch *core_gdbarch = NULL;
71 /* Per-core data. Currently, only the section table. Note that these
72 target sections are *not* mapped in the current address spaces' set
73 of target sections --- those should come only from pure executable
74 or shared library bfds. The core bfd sections are an
75 implementation detail of the core target, just like ptrace is for
76 unix child targets. */
77 static struct target_section_table *core_data;
79 static void core_files_info (struct target_ops *);
81 static struct core_fns *sniff_core_bfd (bfd *);
83 static int gdb_check_format (bfd *);
85 static void core_open (char *, int);
87 static void core_detach (struct target_ops *ops, char *, int);
89 static void core_close (int);
91 static void core_close_cleanup (void *ignore);
93 static void add_to_thread_list (bfd *, asection *, void *);
95 static void init_core_ops (void);
97 void _initialize_corelow (void);
99 static struct target_ops core_ops;
101 /* An arbitrary identifier for the core inferior. */
102 #define CORELOW_PID 1
104 /* Link a new core_fns into the global core_file_fns list. Called on
105 gdb startup by the _initialize routine in each core file register
106 reader, to register information about each format the reader is
107 prepared to handle. */
110 deprecated_add_core_fns (struct core_fns *cf)
112 cf->next = core_file_fns;
116 /* The default function that core file handlers can use to examine a
117 core file BFD and decide whether or not to accept the job of
118 reading the core file. */
121 default_core_sniffer (struct core_fns *our_fns, bfd *abfd)
125 result = (bfd_get_flavour (abfd) == our_fns -> core_flavour);
129 /* Walk through the list of core functions to find a set that can
130 handle the core file open on ABFD. Returns pointer to set that is
133 static struct core_fns *
134 sniff_core_bfd (bfd *abfd)
137 struct core_fns *yummy = NULL;
140 /* Don't sniff if we have support for register sets in
142 if (core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
145 for (cf = core_file_fns; cf != NULL; cf = cf->next)
147 if (cf->core_sniffer (cf, abfd))
155 warning (_("\"%s\": ambiguous core format, %d handlers match"),
156 bfd_get_filename (abfd), matches);
158 else if (matches == 0)
159 error (_("\"%s\": no core file handler recognizes format"),
160 bfd_get_filename (abfd));
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
193 stack spaces as empty. */
196 core_close (int quitting)
202 int pid = ptid_get_pid (inferior_ptid);
203 inferior_ptid = null_ptid; /* Avoid confusion from thread
206 exit_inferior_silent (pid);
208 /* Clear out solib state while the bfd is still open. See
209 comments in clear_solib in solib.c. */
214 xfree (core_data->sections);
219 gdb_bfd_unref (core_bfd);
227 core_close_cleanup (void *ignore)
229 core_close (0/*ignored*/);
232 /* Look for sections whose names start with `.reg/' so that we can
233 extract the list of threads in a core file. */
236 add_to_thread_list (bfd *abfd, asection *asect, void *reg_sect_arg)
241 asection *reg_sect = (asection *) reg_sect_arg;
243 struct inferior *inf;
245 if (strncmp (bfd_section_name (abfd, asect), ".reg/", 5) != 0)
248 core_tid = atoi (bfd_section_name (abfd, asect) + 5);
250 pid = bfd_core_file_pid (core_bfd);
259 inf = current_inferior ();
262 inferior_appeared (inf, pid);
263 inf->fake_pid_p = fake_pid_p;
266 ptid = ptid_build (pid, lwpid, 0);
270 /* Warning, Will Robinson, looking at BFD private data! */
273 && asect->filepos == reg_sect->filepos) /* Did we find .reg? */
274 inferior_ptid = ptid; /* Yes, make it current. */
277 /* This routine opens and sets up the core file bfd. */
280 core_open (char *filename, int from_tty)
284 struct cleanup *old_chain;
289 volatile struct gdb_exception except;
291 target_preopen (from_tty);
295 error (_("No core file specified. (Use `detach' "
296 "to stop debugging a core file.)"));
298 error (_("No core file specified."));
301 filename = tilde_expand (filename);
302 if (!IS_ABSOLUTE_PATH (filename))
304 temp = concat (current_directory, "/",
305 filename, (char *) NULL);
310 old_chain = make_cleanup (xfree, filename);
312 flags = O_BINARY | O_LARGEFILE;
317 scratch_chan = open (filename, flags, 0);
318 if (scratch_chan < 0)
319 perror_with_name (filename);
321 temp_bfd = bfd_fopen (filename, gnutarget,
322 write_files ? FOPEN_RUB : FOPEN_RB,
324 gdb_bfd_ref (temp_bfd);
325 if (temp_bfd == NULL)
326 perror_with_name (filename);
328 gdb_bfd_stash_filename (temp_bfd);
330 if (!bfd_check_format (temp_bfd, bfd_core)
331 && !gdb_check_format (temp_bfd))
333 /* Do it after the err msg */
334 /* FIXME: should be checking for errors from bfd_close (for one
335 thing, on error it does not free all the storage associated
337 make_cleanup_bfd_unref (temp_bfd);
338 error (_("\"%s\" is not a core dump: %s"),
339 filename, bfd_errmsg (bfd_get_error ()));
342 /* Looks semi-reasonable. Toss the old core file and work on the
345 do_cleanups (old_chain);
346 unpush_target (&core_ops);
348 old_chain = make_cleanup (core_close_cleanup, 0 /*ignore*/);
350 /* FIXME: kettenis/20031023: This is very dangerous. The
351 CORE_GDBARCH that results from this call may very well be
352 different from CURRENT_GDBARCH. However, its methods may only
353 work if it is selected as the current architecture, because they
354 rely on swapped data (see gdbarch.c). We should get rid of that
356 core_gdbarch = gdbarch_from_bfd (core_bfd);
358 /* Find a suitable core file handler to munch on core_bfd */
359 core_vec = sniff_core_bfd (core_bfd);
363 core_data = XZALLOC (struct target_section_table);
365 /* Find the data section */
366 if (build_section_table (core_bfd,
367 &core_data->sections,
368 &core_data->sections_end))
369 error (_("\"%s\": Can't find sections: %s"),
370 bfd_get_filename (core_bfd), bfd_errmsg (bfd_get_error ()));
372 /* If we have no exec file, try to set the architecture from the
373 core file. We don't do this unconditionally since an exec file
374 typically contains more information that helps us determine the
375 architecture than a core file. */
377 set_gdbarch_from_file (core_bfd);
379 push_target (&core_ops);
380 discard_cleanups (old_chain);
382 /* Do this before acknowledging the inferior, so if
383 post_create_inferior throws (can happen easilly if you're loading
384 a core file with the wrong exec), we aren't left with threads
385 from the previous inferior. */
388 inferior_ptid = null_ptid;
390 /* Need to flush the register cache (and the frame cache) from a
391 previous debug session. If inferior_ptid ends up the same as the
392 last debug session --- e.g., b foo; run; gcore core1; step; gcore
393 core2; core core1; core core2 --- then there's potential for
394 get_current_regcache to return the cached regcache of the
395 previous session, and the frame cache being stale. */
396 registers_changed ();
398 /* Build up thread list from BFD sections, and possibly set the
399 current thread to the .reg/NN section matching the .reg
401 bfd_map_over_sections (core_bfd, add_to_thread_list,
402 bfd_get_section_by_name (core_bfd, ".reg"));
404 if (ptid_equal (inferior_ptid, null_ptid))
406 /* Either we found no .reg/NN section, and hence we have a
407 non-threaded core (single-threaded, from gdb's perspective),
408 or for some reason add_to_thread_list couldn't determine
409 which was the "main" thread. The latter case shouldn't
410 usually happen, but we're dealing with input here, which can
411 always be broken in different ways. */
412 struct thread_info *thread = first_thread_of_process (-1);
416 inferior_appeared (current_inferior (), CORELOW_PID);
417 inferior_ptid = pid_to_ptid (CORELOW_PID);
418 add_thread_silent (inferior_ptid);
421 switch_to_thread (thread->ptid);
424 post_create_inferior (&core_ops, from_tty);
426 /* Now go through the target stack looking for threads since there
427 may be a thread_stratum target loaded on top of target core by
428 now. The layer above should claim threads found in the BFD
430 TRY_CATCH (except, RETURN_MASK_ERROR)
432 target_find_new_threads ();
435 if (except.reason < 0)
436 exception_print (gdb_stderr, except);
438 p = bfd_core_file_failing_command (core_bfd);
440 printf_filtered (_("Core was generated by `%s'.\n"), p);
442 siggy = bfd_core_file_failing_signal (core_bfd);
445 /* If we don't have a CORE_GDBARCH to work with, assume a native
446 core (map gdb_signal from host signals). If we do have
447 CORE_GDBARCH to work with, but no gdb_signal_from_target
448 implementation for that gdbarch, as a fallback measure,
449 assume the host signal mapping. It'll be correct for native
450 cores, but most likely incorrect for cross-cores. */
451 enum gdb_signal sig = (core_gdbarch != NULL
452 && gdbarch_gdb_signal_from_target_p (core_gdbarch)
453 ? gdbarch_gdb_signal_from_target (core_gdbarch,
455 : gdb_signal_from_host (siggy));
457 printf_filtered (_("Program terminated with signal %d, %s.\n"),
458 siggy, gdb_signal_to_string (sig));
461 /* Fetch all registers from core file. */
462 target_fetch_registers (get_current_regcache (), -1);
464 /* Now, set up the frame cache, and print the top of stack. */
465 reinit_frame_cache ();
466 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
470 core_detach (struct target_ops *ops, char *args, int from_tty)
473 error (_("Too many arguments"));
475 reinit_frame_cache ();
477 printf_filtered (_("No core file now.\n"));
480 #ifdef DEPRECATED_IBM6000_TARGET
482 /* Resize the core memory's section table, by NUM_ADDED. Returns a
483 pointer into the first new slot. This will not be necessary when
484 the rs6000 target is converted to use the standard solib
487 struct target_section *
488 deprecated_core_resize_section_table (int num_added)
492 old_count = resize_section_table (core_data, num_added);
493 return core_data->sections + old_count;
498 /* Try to retrieve registers from a section in core_bfd, and supply
499 them to core_vec->core_read_registers, as the register set numbered
502 If inferior_ptid's lwp member is zero, do the single-threaded
503 thing: look for a section named NAME. If inferior_ptid's lwp
504 member is non-zero, do the multi-threaded thing: look for a section
505 named "NAME/LWP", where LWP is the shortest ASCII decimal
506 representation of inferior_ptid's lwp member.
508 HUMAN_NAME is a human-readable name for the kind of registers the
509 NAME section contains, for use in error messages.
511 If REQUIRED is non-zero, print an error if the core file doesn't
512 have a section by the appropriate name. Otherwise, just do
516 get_core_register_section (struct regcache *regcache,
519 const char *human_name,
522 static char *section_name = NULL;
523 struct bfd_section *section;
527 xfree (section_name);
529 if (ptid_get_lwp (inferior_ptid))
530 section_name = xstrprintf ("%s/%ld", name,
531 ptid_get_lwp (inferior_ptid));
533 section_name = xstrdup (name);
535 section = bfd_get_section_by_name (core_bfd, section_name);
539 warning (_("Couldn't find %s registers in core file."),
544 size = bfd_section_size (core_bfd, section);
545 contents = alloca (size);
546 if (! bfd_get_section_contents (core_bfd, section, contents,
549 warning (_("Couldn't read %s registers from `%s' section in core file."),
554 if (core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
556 const struct regset *regset;
558 regset = gdbarch_regset_from_core_section (core_gdbarch,
563 warning (_("Couldn't recognize %s registers in core file."),
568 regset->supply_regset (regset, regcache, -1, contents, size);
572 gdb_assert (core_vec);
573 core_vec->core_read_registers (regcache, contents, size, which,
575 bfd_section_vma (core_bfd, section)));
579 /* Get the registers out of a core file. This is the machine-
580 independent part. Fetch_core_registers is the machine-dependent
581 part, typically implemented in the xm-file for each
584 /* We just get all the registers, so we don't use regno. */
587 get_core_registers (struct target_ops *ops,
588 struct regcache *regcache, int regno)
590 struct core_regset_section *sect_list;
593 if (!(core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
594 && (core_vec == NULL || core_vec->core_read_registers == NULL))
596 fprintf_filtered (gdb_stderr,
597 "Can't fetch registers from this type of core file\n");
601 sect_list = gdbarch_core_regset_sections (get_regcache_arch (regcache));
603 while (sect_list->sect_name != NULL)
605 if (strcmp (sect_list->sect_name, ".reg") == 0)
606 get_core_register_section (regcache, sect_list->sect_name,
607 0, sect_list->human_name, 1);
608 else if (strcmp (sect_list->sect_name, ".reg2") == 0)
609 get_core_register_section (regcache, sect_list->sect_name,
610 2, sect_list->human_name, 0);
612 get_core_register_section (regcache, sect_list->sect_name,
613 3, sect_list->human_name, 0);
620 get_core_register_section (regcache,
621 ".reg", 0, "general-purpose", 1);
622 get_core_register_section (regcache,
623 ".reg2", 2, "floating-point", 0);
626 /* Mark all registers not found in the core as unavailable. */
627 for (i = 0; i < gdbarch_num_regs (get_regcache_arch (regcache)); i++)
628 if (regcache_register_status (regcache, i) == REG_UNKNOWN)
629 regcache_raw_supply (regcache, i, NULL);
633 core_files_info (struct target_ops *t)
635 print_section_info (core_data, core_bfd);
648 add_to_spuid_list (bfd *abfd, asection *asect, void *list_p)
650 struct spuid_list *list = list_p;
651 enum bfd_endian byte_order
652 = bfd_big_endian (abfd) ? BFD_ENDIAN_BIG : BFD_ENDIAN_LITTLE;
655 sscanf (bfd_section_name (abfd, asect), "SPU/%d/regs%n", &fd, &pos);
659 if (list->pos >= list->offset && list->pos + 4 <= list->offset + list->len)
661 store_unsigned_integer (list->buf + list->pos - list->offset,
669 core_xfer_partial (struct target_ops *ops, enum target_object object,
670 const char *annex, gdb_byte *readbuf,
671 const gdb_byte *writebuf, ULONGEST offset,
676 case TARGET_OBJECT_MEMORY:
677 return section_table_xfer_memory_partial (readbuf, writebuf,
680 core_data->sections_end,
683 case TARGET_OBJECT_AUXV:
686 /* When the aux vector is stored in core file, BFD
687 represents this with a fake section called ".auxv". */
689 struct bfd_section *section;
692 section = bfd_get_section_by_name (core_bfd, ".auxv");
696 size = bfd_section_size (core_bfd, section);
703 && !bfd_get_section_contents (core_bfd, section, readbuf,
704 (file_ptr) offset, size))
706 warning (_("Couldn't read NT_AUXV note in core file."));
714 case TARGET_OBJECT_WCOOKIE:
717 /* When the StackGhost cookie is stored in core file, BFD
718 represents this with a fake section called
721 struct bfd_section *section;
724 section = bfd_get_section_by_name (core_bfd, ".wcookie");
728 size = bfd_section_size (core_bfd, section);
735 && !bfd_get_section_contents (core_bfd, section, readbuf,
736 (file_ptr) offset, size))
738 warning (_("Couldn't read StackGhost cookie in core file."));
746 case TARGET_OBJECT_LIBRARIES:
748 && gdbarch_core_xfer_shared_libraries_p (core_gdbarch))
753 gdbarch_core_xfer_shared_libraries (core_gdbarch,
754 readbuf, offset, len);
758 case TARGET_OBJECT_SPU:
759 if (readbuf && annex)
761 /* When the SPU contexts are stored in a core file, BFD
762 represents this with a fake section called
765 struct bfd_section *section;
767 char sectionstr[100];
769 xsnprintf (sectionstr, sizeof sectionstr, "SPU/%s", annex);
771 section = bfd_get_section_by_name (core_bfd, sectionstr);
775 size = bfd_section_size (core_bfd, section);
782 && !bfd_get_section_contents (core_bfd, section, readbuf,
783 (file_ptr) offset, size))
785 warning (_("Couldn't read SPU section in core file."));
793 /* NULL annex requests list of all present spuids. */
794 struct spuid_list list;
797 list.offset = offset;
801 bfd_map_over_sections (core_bfd, add_to_spuid_list, &list);
807 if (ops->beneath != NULL)
808 return ops->beneath->to_xfer_partial (ops->beneath, object,
810 writebuf, offset, len);
816 /* If mourn is being called in all the right places, this could be say
817 `gdb internal error' (since generic_mourn calls
818 breakpoint_init_inferior). */
821 ignore (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
827 /* Okay, let's be honest: threads gleaned from a core file aren't
828 exactly lively, are they? On the other hand, if we don't claim
829 that each & every one is alive, then we don't get any of them
830 to appear in an "info thread" command, which is quite a useful
834 core_thread_alive (struct target_ops *ops, ptid_t ptid)
839 /* Ask the current architecture what it knows about this core file.
840 That will be used, in turn, to pick a better architecture. This
841 wrapper could be avoided if targets got a chance to specialize
844 static const struct target_desc *
845 core_read_description (struct target_ops *target)
847 if (core_gdbarch && gdbarch_core_read_description_p (core_gdbarch))
848 return gdbarch_core_read_description (core_gdbarch,
855 core_pid_to_str (struct target_ops *ops, ptid_t ptid)
858 struct inferior *inf;
861 /* The preferred way is to have a gdbarch/OS specific
864 && gdbarch_core_pid_to_str_p (core_gdbarch))
865 return gdbarch_core_pid_to_str (core_gdbarch, ptid);
867 /* Otherwise, if we don't have one, we'll just fallback to
868 "process", with normal_pid_to_str. */
870 /* Try the LWPID field first. */
871 pid = ptid_get_lwp (ptid);
873 return normal_pid_to_str (pid_to_ptid (pid));
875 /* Otherwise, this isn't a "threaded" core -- use the PID field, but
876 only if it isn't a fake PID. */
877 inf = find_inferior_pid (ptid_get_pid (ptid));
878 if (inf != NULL && !inf->fake_pid_p)
879 return normal_pid_to_str (ptid);
881 /* No luck. We simply don't have a valid PID to print. */
882 xsnprintf (buf, sizeof buf, "<main task>");
887 core_has_memory (struct target_ops *ops)
889 return (core_bfd != NULL);
893 core_has_stack (struct target_ops *ops)
895 return (core_bfd != NULL);
899 core_has_registers (struct target_ops *ops)
901 return (core_bfd != NULL);
904 /* Fill in core_ops with its defined operations and properties. */
909 core_ops.to_shortname = "core";
910 core_ops.to_longname = "Local core dump file";
912 "Use a core file as a target. Specify the filename of the core file.";
913 core_ops.to_open = core_open;
914 core_ops.to_close = core_close;
915 core_ops.to_attach = find_default_attach;
916 core_ops.to_detach = core_detach;
917 core_ops.to_fetch_registers = get_core_registers;
918 core_ops.to_xfer_partial = core_xfer_partial;
919 core_ops.to_files_info = core_files_info;
920 core_ops.to_insert_breakpoint = ignore;
921 core_ops.to_remove_breakpoint = ignore;
922 core_ops.to_create_inferior = find_default_create_inferior;
923 core_ops.to_thread_alive = core_thread_alive;
924 core_ops.to_read_description = core_read_description;
925 core_ops.to_pid_to_str = core_pid_to_str;
926 core_ops.to_stratum = process_stratum;
927 core_ops.to_has_memory = core_has_memory;
928 core_ops.to_has_stack = core_has_stack;
929 core_ops.to_has_registers = core_has_registers;
930 core_ops.to_magic = OPS_MAGIC;
933 internal_error (__FILE__, __LINE__,
934 _("init_core_ops: core target already exists (\"%s\")."),
935 core_target->to_longname);
936 core_target = &core_ops;
940 _initialize_corelow (void)
944 add_target (&core_ops);