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 = gdb_bfd_fopen (filename, gnutarget,
322 write_files ? FOPEN_RUB : FOPEN_RB,
324 if (temp_bfd == NULL)
325 perror_with_name (filename);
327 if (!bfd_check_format (temp_bfd, bfd_core)
328 && !gdb_check_format (temp_bfd))
330 /* Do it after the err msg */
331 /* FIXME: should be checking for errors from bfd_close (for one
332 thing, on error it does not free all the storage associated
334 make_cleanup_bfd_unref (temp_bfd);
335 error (_("\"%s\" is not a core dump: %s"),
336 filename, bfd_errmsg (bfd_get_error ()));
339 /* Looks semi-reasonable. Toss the old core file and work on the
342 do_cleanups (old_chain);
343 unpush_target (&core_ops);
345 old_chain = make_cleanup (core_close_cleanup, 0 /*ignore*/);
347 core_gdbarch = gdbarch_from_bfd (core_bfd);
349 /* Find a suitable core file handler to munch on core_bfd */
350 core_vec = sniff_core_bfd (core_bfd);
354 core_data = XZALLOC (struct target_section_table);
356 /* Find the data section */
357 if (build_section_table (core_bfd,
358 &core_data->sections,
359 &core_data->sections_end))
360 error (_("\"%s\": Can't find sections: %s"),
361 bfd_get_filename (core_bfd), bfd_errmsg (bfd_get_error ()));
363 /* If we have no exec file, try to set the architecture from the
364 core file. We don't do this unconditionally since an exec file
365 typically contains more information that helps us determine the
366 architecture than a core file. */
368 set_gdbarch_from_file (core_bfd);
370 push_target (&core_ops);
371 discard_cleanups (old_chain);
373 /* Do this before acknowledging the inferior, so if
374 post_create_inferior throws (can happen easilly if you're loading
375 a core file with the wrong exec), we aren't left with threads
376 from the previous inferior. */
379 inferior_ptid = null_ptid;
381 /* Need to flush the register cache (and the frame cache) from a
382 previous debug session. If inferior_ptid ends up the same as the
383 last debug session --- e.g., b foo; run; gcore core1; step; gcore
384 core2; core core1; core core2 --- then there's potential for
385 get_current_regcache to return the cached regcache of the
386 previous session, and the frame cache being stale. */
387 registers_changed ();
389 /* Build up thread list from BFD sections, and possibly set the
390 current thread to the .reg/NN section matching the .reg
392 bfd_map_over_sections (core_bfd, add_to_thread_list,
393 bfd_get_section_by_name (core_bfd, ".reg"));
395 if (ptid_equal (inferior_ptid, null_ptid))
397 /* Either we found no .reg/NN section, and hence we have a
398 non-threaded core (single-threaded, from gdb's perspective),
399 or for some reason add_to_thread_list couldn't determine
400 which was the "main" thread. The latter case shouldn't
401 usually happen, but we're dealing with input here, which can
402 always be broken in different ways. */
403 struct thread_info *thread = first_thread_of_process (-1);
407 inferior_appeared (current_inferior (), CORELOW_PID);
408 inferior_ptid = pid_to_ptid (CORELOW_PID);
409 add_thread_silent (inferior_ptid);
412 switch_to_thread (thread->ptid);
415 post_create_inferior (&core_ops, from_tty);
417 /* Now go through the target stack looking for threads since there
418 may be a thread_stratum target loaded on top of target core by
419 now. The layer above should claim threads found in the BFD
421 TRY_CATCH (except, RETURN_MASK_ERROR)
423 target_find_new_threads ();
426 if (except.reason < 0)
427 exception_print (gdb_stderr, except);
429 p = bfd_core_file_failing_command (core_bfd);
431 printf_filtered (_("Core was generated by `%s'.\n"), p);
433 siggy = bfd_core_file_failing_signal (core_bfd);
436 /* If we don't have a CORE_GDBARCH to work with, assume a native
437 core (map gdb_signal from host signals). If we do have
438 CORE_GDBARCH to work with, but no gdb_signal_from_target
439 implementation for that gdbarch, as a fallback measure,
440 assume the host signal mapping. It'll be correct for native
441 cores, but most likely incorrect for cross-cores. */
442 enum gdb_signal sig = (core_gdbarch != NULL
443 && gdbarch_gdb_signal_from_target_p (core_gdbarch)
444 ? gdbarch_gdb_signal_from_target (core_gdbarch,
446 : gdb_signal_from_host (siggy));
448 printf_filtered (_("Program terminated with signal %d, %s.\n"),
449 siggy, gdb_signal_to_string (sig));
452 /* Fetch all registers from core file. */
453 target_fetch_registers (get_current_regcache (), -1);
455 /* Now, set up the frame cache, and print the top of stack. */
456 reinit_frame_cache ();
457 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
461 core_detach (struct target_ops *ops, char *args, int from_tty)
464 error (_("Too many arguments"));
466 reinit_frame_cache ();
468 printf_filtered (_("No core file now.\n"));
471 #ifdef DEPRECATED_IBM6000_TARGET
473 /* Resize the core memory's section table, by NUM_ADDED. Returns a
474 pointer into the first new slot. This will not be necessary when
475 the rs6000 target is converted to use the standard solib
478 struct target_section *
479 deprecated_core_resize_section_table (int num_added)
483 old_count = resize_section_table (core_data, num_added);
484 return core_data->sections + old_count;
489 /* Try to retrieve registers from a section in core_bfd, and supply
490 them to core_vec->core_read_registers, as the register set numbered
493 If inferior_ptid's lwp member is zero, do the single-threaded
494 thing: look for a section named NAME. If inferior_ptid's lwp
495 member is non-zero, do the multi-threaded thing: look for a section
496 named "NAME/LWP", where LWP is the shortest ASCII decimal
497 representation of inferior_ptid's lwp member.
499 HUMAN_NAME is a human-readable name for the kind of registers the
500 NAME section contains, for use in error messages.
502 If REQUIRED is non-zero, print an error if the core file doesn't
503 have a section by the appropriate name. Otherwise, just do
507 get_core_register_section (struct regcache *regcache,
510 const char *human_name,
513 static char *section_name = NULL;
514 struct bfd_section *section;
518 xfree (section_name);
520 if (ptid_get_lwp (inferior_ptid))
521 section_name = xstrprintf ("%s/%ld", name,
522 ptid_get_lwp (inferior_ptid));
524 section_name = xstrdup (name);
526 section = bfd_get_section_by_name (core_bfd, section_name);
530 warning (_("Couldn't find %s registers in core file."),
535 size = bfd_section_size (core_bfd, section);
536 contents = alloca (size);
537 if (! bfd_get_section_contents (core_bfd, section, contents,
540 warning (_("Couldn't read %s registers from `%s' section in core file."),
545 if (core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
547 const struct regset *regset;
549 regset = gdbarch_regset_from_core_section (core_gdbarch,
554 warning (_("Couldn't recognize %s registers in core file."),
559 regset->supply_regset (regset, regcache, -1, contents, size);
563 gdb_assert (core_vec);
564 core_vec->core_read_registers (regcache, contents, size, which,
566 bfd_section_vma (core_bfd, section)));
570 /* Get the registers out of a core file. This is the machine-
571 independent part. Fetch_core_registers is the machine-dependent
572 part, typically implemented in the xm-file for each
575 /* We just get all the registers, so we don't use regno. */
578 get_core_registers (struct target_ops *ops,
579 struct regcache *regcache, int regno)
581 struct core_regset_section *sect_list;
584 if (!(core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
585 && (core_vec == NULL || core_vec->core_read_registers == NULL))
587 fprintf_filtered (gdb_stderr,
588 "Can't fetch registers from this type of core file\n");
592 sect_list = gdbarch_core_regset_sections (get_regcache_arch (regcache));
594 while (sect_list->sect_name != NULL)
596 if (strcmp (sect_list->sect_name, ".reg") == 0)
597 get_core_register_section (regcache, sect_list->sect_name,
598 0, sect_list->human_name, 1);
599 else if (strcmp (sect_list->sect_name, ".reg2") == 0)
600 get_core_register_section (regcache, sect_list->sect_name,
601 2, sect_list->human_name, 0);
603 get_core_register_section (regcache, sect_list->sect_name,
604 3, sect_list->human_name, 0);
611 get_core_register_section (regcache,
612 ".reg", 0, "general-purpose", 1);
613 get_core_register_section (regcache,
614 ".reg2", 2, "floating-point", 0);
617 /* Mark all registers not found in the core as unavailable. */
618 for (i = 0; i < gdbarch_num_regs (get_regcache_arch (regcache)); i++)
619 if (regcache_register_status (regcache, i) == REG_UNKNOWN)
620 regcache_raw_supply (regcache, i, NULL);
624 core_files_info (struct target_ops *t)
626 print_section_info (core_data, core_bfd);
639 add_to_spuid_list (bfd *abfd, asection *asect, void *list_p)
641 struct spuid_list *list = list_p;
642 enum bfd_endian byte_order
643 = bfd_big_endian (abfd) ? BFD_ENDIAN_BIG : BFD_ENDIAN_LITTLE;
646 sscanf (bfd_section_name (abfd, asect), "SPU/%d/regs%n", &fd, &pos);
650 if (list->pos >= list->offset && list->pos + 4 <= list->offset + list->len)
652 store_unsigned_integer (list->buf + list->pos - list->offset,
660 core_xfer_partial (struct target_ops *ops, enum target_object object,
661 const char *annex, gdb_byte *readbuf,
662 const gdb_byte *writebuf, ULONGEST offset,
667 case TARGET_OBJECT_MEMORY:
668 return section_table_xfer_memory_partial (readbuf, writebuf,
671 core_data->sections_end,
674 case TARGET_OBJECT_AUXV:
677 /* When the aux vector is stored in core file, BFD
678 represents this with a fake section called ".auxv". */
680 struct bfd_section *section;
683 section = bfd_get_section_by_name (core_bfd, ".auxv");
687 size = bfd_section_size (core_bfd, section);
694 && !bfd_get_section_contents (core_bfd, section, readbuf,
695 (file_ptr) offset, size))
697 warning (_("Couldn't read NT_AUXV note in core file."));
705 case TARGET_OBJECT_WCOOKIE:
708 /* When the StackGhost cookie is stored in core file, BFD
709 represents this with a fake section called
712 struct bfd_section *section;
715 section = bfd_get_section_by_name (core_bfd, ".wcookie");
719 size = bfd_section_size (core_bfd, section);
726 && !bfd_get_section_contents (core_bfd, section, readbuf,
727 (file_ptr) offset, size))
729 warning (_("Couldn't read StackGhost cookie in core file."));
737 case TARGET_OBJECT_LIBRARIES:
739 && gdbarch_core_xfer_shared_libraries_p (core_gdbarch))
744 gdbarch_core_xfer_shared_libraries (core_gdbarch,
745 readbuf, offset, len);
749 case TARGET_OBJECT_SPU:
750 if (readbuf && annex)
752 /* When the SPU contexts are stored in a core file, BFD
753 represents this with a fake section called
756 struct bfd_section *section;
758 char sectionstr[100];
760 xsnprintf (sectionstr, sizeof sectionstr, "SPU/%s", annex);
762 section = bfd_get_section_by_name (core_bfd, sectionstr);
766 size = bfd_section_size (core_bfd, section);
773 && !bfd_get_section_contents (core_bfd, section, readbuf,
774 (file_ptr) offset, size))
776 warning (_("Couldn't read SPU section in core file."));
784 /* NULL annex requests list of all present spuids. */
785 struct spuid_list list;
788 list.offset = offset;
792 bfd_map_over_sections (core_bfd, add_to_spuid_list, &list);
798 if (ops->beneath != NULL)
799 return ops->beneath->to_xfer_partial (ops->beneath, object,
801 writebuf, offset, len);
807 /* If mourn is being called in all the right places, this could be say
808 `gdb internal error' (since generic_mourn calls
809 breakpoint_init_inferior). */
812 ignore (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
818 /* Okay, let's be honest: threads gleaned from a core file aren't
819 exactly lively, are they? On the other hand, if we don't claim
820 that each & every one is alive, then we don't get any of them
821 to appear in an "info thread" command, which is quite a useful
825 core_thread_alive (struct target_ops *ops, ptid_t ptid)
830 /* Ask the current architecture what it knows about this core file.
831 That will be used, in turn, to pick a better architecture. This
832 wrapper could be avoided if targets got a chance to specialize
835 static const struct target_desc *
836 core_read_description (struct target_ops *target)
838 if (core_gdbarch && gdbarch_core_read_description_p (core_gdbarch))
839 return gdbarch_core_read_description (core_gdbarch,
846 core_pid_to_str (struct target_ops *ops, ptid_t ptid)
849 struct inferior *inf;
852 /* The preferred way is to have a gdbarch/OS specific
855 && gdbarch_core_pid_to_str_p (core_gdbarch))
856 return gdbarch_core_pid_to_str (core_gdbarch, ptid);
858 /* Otherwise, if we don't have one, we'll just fallback to
859 "process", with normal_pid_to_str. */
861 /* Try the LWPID field first. */
862 pid = ptid_get_lwp (ptid);
864 return normal_pid_to_str (pid_to_ptid (pid));
866 /* Otherwise, this isn't a "threaded" core -- use the PID field, but
867 only if it isn't a fake PID. */
868 inf = find_inferior_pid (ptid_get_pid (ptid));
869 if (inf != NULL && !inf->fake_pid_p)
870 return normal_pid_to_str (ptid);
872 /* No luck. We simply don't have a valid PID to print. */
873 xsnprintf (buf, sizeof buf, "<main task>");
878 core_has_memory (struct target_ops *ops)
880 return (core_bfd != NULL);
884 core_has_stack (struct target_ops *ops)
886 return (core_bfd != NULL);
890 core_has_registers (struct target_ops *ops)
892 return (core_bfd != NULL);
895 /* Fill in core_ops with its defined operations and properties. */
900 core_ops.to_shortname = "core";
901 core_ops.to_longname = "Local core dump file";
903 "Use a core file as a target. Specify the filename of the core file.";
904 core_ops.to_open = core_open;
905 core_ops.to_close = core_close;
906 core_ops.to_attach = find_default_attach;
907 core_ops.to_detach = core_detach;
908 core_ops.to_fetch_registers = get_core_registers;
909 core_ops.to_xfer_partial = core_xfer_partial;
910 core_ops.to_files_info = core_files_info;
911 core_ops.to_insert_breakpoint = ignore;
912 core_ops.to_remove_breakpoint = ignore;
913 core_ops.to_create_inferior = find_default_create_inferior;
914 core_ops.to_thread_alive = core_thread_alive;
915 core_ops.to_read_description = core_read_description;
916 core_ops.to_pid_to_str = core_pid_to_str;
917 core_ops.to_stratum = process_stratum;
918 core_ops.to_has_memory = core_has_memory;
919 core_ops.to_has_stack = core_has_stack;
920 core_ops.to_has_registers = core_has_registers;
921 core_ops.to_magic = OPS_MAGIC;
924 internal_error (__FILE__, __LINE__,
925 _("init_core_ops: core target already exists (\"%s\")."),
926 core_target->to_longname);
927 core_target = &core_ops;
931 _initialize_corelow (void)
935 add_target (&core_ops);