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"
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
61 core 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 /* Per-core data. Currently, only the section table. Note that these
71 target sections are *not* mapped in the current address spaces' set
72 of target sections --- those should come only from pure executable
73 or shared library bfds. The core bfd sections are an
74 implementation detail of the core target, just like ptrace is for
75 unix child targets. */
76 static struct target_section_table *core_data;
78 static void core_files_info (struct target_ops *);
80 static struct core_fns *sniff_core_bfd (bfd *);
82 static int gdb_check_format (bfd *);
84 static void core_open (char *, int);
86 static void core_detach (struct target_ops *ops, char *, int);
88 static void core_close (int);
90 static void core_close_cleanup (void *ignore);
92 static void add_to_thread_list (bfd *, asection *, void *);
94 static void init_core_ops (void);
96 void _initialize_corelow (void);
98 static struct target_ops core_ops;
100 /* An arbitrary identifier for the core inferior. */
101 #define CORELOW_PID 1
103 /* Link a new core_fns into the global core_file_fns list. Called on
104 gdb startup by the _initialize routine in each core file register
105 reader, to register information about each format the reader is
106 prepared to handle. */
109 deprecated_add_core_fns (struct core_fns *cf)
111 cf->next = core_file_fns;
115 /* The default function that core file handlers can use to examine a
116 core file BFD and decide whether or not to accept the job of
117 reading the core file. */
120 default_core_sniffer (struct core_fns *our_fns, bfd *abfd)
124 result = (bfd_get_flavour (abfd) == our_fns -> core_flavour);
128 /* Walk through the list of core functions to find a set that can
129 handle the core file open on ABFD. Returns pointer to set that is
132 static struct core_fns *
133 sniff_core_bfd (bfd *abfd)
136 struct core_fns *yummy = NULL;
139 /* Don't sniff if we have support for register sets in
141 if (core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
144 for (cf = core_file_fns; cf != NULL; cf = cf->next)
146 if (cf->core_sniffer (cf, abfd))
154 warning (_("\"%s\": ambiguous core format, %d handlers match"),
155 bfd_get_filename (abfd), matches);
157 else if (matches == 0)
158 error (_("\"%s\": no core file handler recognizes format"),
159 bfd_get_filename (abfd));
164 /* The default is to reject every core file format we see. Either
165 BFD has to recognize it, or we have to provide a function in the
166 core file handler that recognizes it. */
169 default_check_format (bfd *abfd)
174 /* Attempt to recognize core file formats that BFD rejects. */
177 gdb_check_format (bfd *abfd)
181 for (cf = core_file_fns; cf != NULL; cf = cf->next)
183 if (cf->check_format (abfd))
191 /* Discard all vestiges of any previous core file and mark data and
192 stack spaces as empty. */
195 core_close (int quitting)
201 int pid = ptid_get_pid (inferior_ptid);
202 inferior_ptid = null_ptid; /* Avoid confusion from thread
205 exit_inferior_silent (pid);
207 /* Clear out solib state while the bfd is still open. See
208 comments in clear_solib in solib.c. */
213 xfree (core_data->sections);
218 name = bfd_get_filename (core_bfd);
219 gdb_bfd_close_or_warn (core_bfd);
228 core_close_cleanup (void *ignore)
230 core_close (0/*ignored*/);
233 /* Look for sections whose names start with `.reg/' so that we can
234 extract the list of threads in a core file. */
237 add_to_thread_list (bfd *abfd, asection *asect, void *reg_sect_arg)
242 asection *reg_sect = (asection *) reg_sect_arg;
244 struct inferior *inf;
246 if (strncmp (bfd_section_name (abfd, asect), ".reg/", 5) != 0)
249 core_tid = atoi (bfd_section_name (abfd, asect) + 5);
251 pid = bfd_core_file_pid (core_bfd);
260 inf = current_inferior ();
263 inferior_appeared (inf, pid);
264 inf->fake_pid_p = fake_pid_p;
267 ptid = ptid_build (pid, lwpid, 0);
271 /* Warning, Will Robinson, looking at BFD private data! */
274 && asect->filepos == reg_sect->filepos) /* Did we find .reg? */
275 inferior_ptid = ptid; /* Yes, make it current. */
278 /* This routine opens and sets up the core file bfd. */
281 core_open (char *filename, int from_tty)
285 struct cleanup *old_chain;
290 volatile struct gdb_exception except;
292 target_preopen (from_tty);
296 error (_("No core file specified. (Use `detach' "
297 "to stop debugging a core file.)"));
299 error (_("No core file specified."));
302 filename = tilde_expand (filename);
303 if (!IS_ABSOLUTE_PATH (filename))
305 temp = concat (current_directory, "/",
306 filename, (char *) NULL);
311 old_chain = make_cleanup (xfree, filename);
313 flags = O_BINARY | O_LARGEFILE;
318 scratch_chan = open (filename, flags, 0);
319 if (scratch_chan < 0)
320 perror_with_name (filename);
322 temp_bfd = bfd_fopen (filename, gnutarget,
323 write_files ? FOPEN_RUB : FOPEN_RB,
325 if (temp_bfd == NULL)
326 perror_with_name (filename);
328 if (!bfd_check_format (temp_bfd, bfd_core)
329 && !gdb_check_format (temp_bfd))
331 /* Do it after the err msg */
332 /* FIXME: should be checking for errors from bfd_close (for one
333 thing, on error it does not free all the storage associated
335 make_cleanup_bfd_close (temp_bfd);
336 error (_("\"%s\" is not a core dump: %s"),
337 filename, bfd_errmsg (bfd_get_error ()));
340 /* Looks semi-reasonable. Toss the old core file and work on the
343 discard_cleanups (old_chain); /* Don't free filename any more */
344 unpush_target (&core_ops);
346 old_chain = make_cleanup (core_close_cleanup, 0 /*ignore*/);
348 /* FIXME: kettenis/20031023: This is very dangerous. The
349 CORE_GDBARCH that results from this call may very well be
350 different from CURRENT_GDBARCH. However, its methods may only
351 work if it is selected as the current architecture, because they
352 rely on swapped data (see gdbarch.c). We should get rid of that
354 core_gdbarch = gdbarch_from_bfd (core_bfd);
356 /* Find a suitable core file handler to munch on core_bfd */
357 core_vec = sniff_core_bfd (core_bfd);
361 core_data = XZALLOC (struct target_section_table);
363 /* Find the data section */
364 if (build_section_table (core_bfd,
365 &core_data->sections,
366 &core_data->sections_end))
367 error (_("\"%s\": Can't find sections: %s"),
368 bfd_get_filename (core_bfd), bfd_errmsg (bfd_get_error ()));
370 /* If we have no exec file, try to set the architecture from the
371 core file. We don't do this unconditionally since an exec file
372 typically contains more information that helps us determine the
373 architecture than a core file. */
375 set_gdbarch_from_file (core_bfd);
377 push_target (&core_ops);
378 discard_cleanups (old_chain);
380 /* Do this before acknowledging the inferior, so if
381 post_create_inferior throws (can happen easilly if you're loading
382 a core file with the wrong exec), we aren't left with threads
383 from the previous inferior. */
386 inferior_ptid = null_ptid;
388 /* Need to flush the register cache (and the frame cache) from a
389 previous debug session. If inferior_ptid ends up the same as the
390 last debug session --- e.g., b foo; run; gcore core1; step; gcore
391 core2; core core1; core core2 --- then there's potential for
392 get_current_regcache to return the cached regcache of the
393 previous session, and the frame cache being stale. */
394 registers_changed ();
396 /* Build up thread list from BFD sections, and possibly set the
397 current thread to the .reg/NN section matching the .reg
399 bfd_map_over_sections (core_bfd, add_to_thread_list,
400 bfd_get_section_by_name (core_bfd, ".reg"));
402 if (ptid_equal (inferior_ptid, null_ptid))
404 /* Either we found no .reg/NN section, and hence we have a
405 non-threaded core (single-threaded, from gdb's perspective),
406 or for some reason add_to_thread_list couldn't determine
407 which was the "main" thread. The latter case shouldn't
408 usually happen, but we're dealing with input here, which can
409 always be broken in different ways. */
410 struct thread_info *thread = first_thread_of_process (-1);
414 inferior_appeared (current_inferior (), CORELOW_PID);
415 inferior_ptid = pid_to_ptid (CORELOW_PID);
416 add_thread_silent (inferior_ptid);
419 switch_to_thread (thread->ptid);
422 post_create_inferior (&core_ops, from_tty);
424 /* Now go through the target stack looking for threads since there
425 may be a thread_stratum target loaded on top of target core by
426 now. The layer above should claim threads found in the BFD
428 TRY_CATCH (except, RETURN_MASK_ERROR)
430 target_find_new_threads ();
433 if (except.reason < 0)
434 exception_print (gdb_stderr, except);
436 p = bfd_core_file_failing_command (core_bfd);
438 printf_filtered (_("Core was generated by `%s'.\n"), p);
440 siggy = bfd_core_file_failing_signal (core_bfd);
443 /* NOTE: target_signal_from_host() converts a target signal
444 value into gdb's internal signal value. Unfortunately gdb's
445 internal value is called ``target_signal'' and this function
446 got the name ..._from_host(). */
447 enum target_signal sig = (core_gdbarch != NULL
448 ? gdbarch_target_signal_from_host (core_gdbarch,
450 : target_signal_from_host (siggy));
452 printf_filtered (_("Program terminated with signal %d, %s.\n"),
453 siggy, target_signal_to_string (sig));
456 /* Fetch all registers from core file. */
457 target_fetch_registers (get_current_regcache (), -1);
459 /* Now, set up the frame cache, and print the top of stack. */
460 reinit_frame_cache ();
461 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
465 core_detach (struct target_ops *ops, char *args, int from_tty)
468 error (_("Too many arguments"));
470 reinit_frame_cache ();
472 printf_filtered (_("No core file now.\n"));
475 #ifdef DEPRECATED_IBM6000_TARGET
477 /* Resize the core memory's section table, by NUM_ADDED. Returns a
478 pointer into the first new slot. This will not be necessary when
479 the rs6000 target is converted to use the standard solib
482 struct target_section *
483 deprecated_core_resize_section_table (int num_added)
487 old_count = resize_section_table (core_data, num_added);
488 return core_data->sections + old_count;
493 /* Try to retrieve registers from a section in core_bfd, and supply
494 them to core_vec->core_read_registers, as the register set numbered
497 If inferior_ptid's lwp member is zero, do the single-threaded
498 thing: look for a section named NAME. If inferior_ptid's lwp
499 member is non-zero, do the multi-threaded thing: look for a section
500 named "NAME/LWP", where LWP is the shortest ASCII decimal
501 representation of inferior_ptid's lwp member.
503 HUMAN_NAME is a human-readable name for the kind of registers the
504 NAME section contains, for use in error messages.
506 If REQUIRED is non-zero, print an error if the core file doesn't
507 have a section by the appropriate name. Otherwise, just do
511 get_core_register_section (struct regcache *regcache,
514 const char *human_name,
517 static char *section_name = NULL;
518 struct bfd_section *section;
522 xfree (section_name);
524 if (ptid_get_lwp (inferior_ptid))
525 section_name = xstrprintf ("%s/%ld", name,
526 ptid_get_lwp (inferior_ptid));
528 section_name = xstrdup (name);
530 section = bfd_get_section_by_name (core_bfd, section_name);
534 warning (_("Couldn't find %s registers in core file."),
539 size = bfd_section_size (core_bfd, section);
540 contents = alloca (size);
541 if (! bfd_get_section_contents (core_bfd, section, contents,
544 warning (_("Couldn't read %s registers from `%s' section in core file."),
549 if (core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
551 const struct regset *regset;
553 regset = gdbarch_regset_from_core_section (core_gdbarch,
558 warning (_("Couldn't recognize %s registers in core file."),
563 regset->supply_regset (regset, regcache, -1, contents, size);
567 gdb_assert (core_vec);
568 core_vec->core_read_registers (regcache, contents, size, which,
570 bfd_section_vma (core_bfd, section)));
574 /* Get the registers out of a core file. This is the machine-
575 independent part. Fetch_core_registers is the machine-dependent
576 part, typically implemented in the xm-file for each
579 /* We just get all the registers, so we don't use regno. */
582 get_core_registers (struct target_ops *ops,
583 struct regcache *regcache, int regno)
585 struct core_regset_section *sect_list;
588 if (!(core_gdbarch && gdbarch_regset_from_core_section_p (core_gdbarch))
589 && (core_vec == NULL || core_vec->core_read_registers == NULL))
591 fprintf_filtered (gdb_stderr,
592 "Can't fetch registers from this type of core file\n");
596 sect_list = gdbarch_core_regset_sections (get_regcache_arch (regcache));
598 while (sect_list->sect_name != NULL)
600 if (strcmp (sect_list->sect_name, ".reg") == 0)
601 get_core_register_section (regcache, sect_list->sect_name,
602 0, sect_list->human_name, 1);
603 else if (strcmp (sect_list->sect_name, ".reg2") == 0)
604 get_core_register_section (regcache, sect_list->sect_name,
605 2, sect_list->human_name, 0);
607 get_core_register_section (regcache, sect_list->sect_name,
608 3, sect_list->human_name, 0);
615 get_core_register_section (regcache,
616 ".reg", 0, "general-purpose", 1);
617 get_core_register_section (regcache,
618 ".reg2", 2, "floating-point", 0);
621 /* Mark all registers not found in the core as unavailable. */
622 for (i = 0; i < gdbarch_num_regs (get_regcache_arch (regcache)); i++)
623 if (regcache_register_status (regcache, i) == REG_UNKNOWN)
624 regcache_raw_supply (regcache, i, NULL);
628 core_files_info (struct target_ops *t)
630 print_section_info (core_data, core_bfd);
643 add_to_spuid_list (bfd *abfd, asection *asect, void *list_p)
645 struct spuid_list *list = list_p;
646 enum bfd_endian byte_order
647 = bfd_big_endian (abfd) ? BFD_ENDIAN_BIG : BFD_ENDIAN_LITTLE;
650 sscanf (bfd_section_name (abfd, asect), "SPU/%d/regs%n", &fd, &pos);
654 if (list->pos >= list->offset && list->pos + 4 <= list->offset + list->len)
656 store_unsigned_integer (list->buf + list->pos - list->offset,
664 core_xfer_partial (struct target_ops *ops, enum target_object object,
665 const char *annex, gdb_byte *readbuf,
666 const gdb_byte *writebuf, ULONGEST offset,
671 case TARGET_OBJECT_MEMORY:
672 return section_table_xfer_memory_partial (readbuf, writebuf,
675 core_data->sections_end,
678 case TARGET_OBJECT_AUXV:
681 /* When the aux vector is stored in core file, BFD
682 represents this with a fake section called ".auxv". */
684 struct bfd_section *section;
687 section = bfd_get_section_by_name (core_bfd, ".auxv");
691 size = bfd_section_size (core_bfd, section);
698 && !bfd_get_section_contents (core_bfd, section, readbuf,
699 (file_ptr) offset, size))
701 warning (_("Couldn't read NT_AUXV note in core file."));
709 case TARGET_OBJECT_WCOOKIE:
712 /* When the StackGhost cookie is stored in core file, BFD
713 represents this with a fake section called
716 struct bfd_section *section;
719 section = bfd_get_section_by_name (core_bfd, ".wcookie");
723 size = bfd_section_size (core_bfd, section);
730 && !bfd_get_section_contents (core_bfd, section, readbuf,
731 (file_ptr) offset, size))
733 warning (_("Couldn't read StackGhost cookie in core file."));
741 case TARGET_OBJECT_LIBRARIES:
743 && gdbarch_core_xfer_shared_libraries_p (core_gdbarch))
748 gdbarch_core_xfer_shared_libraries (core_gdbarch,
749 readbuf, offset, len);
753 case TARGET_OBJECT_SPU:
754 if (readbuf && annex)
756 /* When the SPU contexts are stored in a core file, BFD
757 represents this with a fake section called
760 struct bfd_section *section;
762 char sectionstr[100];
764 xsnprintf (sectionstr, sizeof sectionstr, "SPU/%s", annex);
766 section = bfd_get_section_by_name (core_bfd, sectionstr);
770 size = bfd_section_size (core_bfd, section);
777 && !bfd_get_section_contents (core_bfd, section, readbuf,
778 (file_ptr) offset, size))
780 warning (_("Couldn't read SPU section in core file."));
788 /* NULL annex requests list of all present spuids. */
789 struct spuid_list list;
792 list.offset = offset;
796 bfd_map_over_sections (core_bfd, add_to_spuid_list, &list);
802 if (ops->beneath != NULL)
803 return ops->beneath->to_xfer_partial (ops->beneath, object,
805 writebuf, offset, len);
811 /* If mourn is being called in all the right places, this could be say
812 `gdb internal error' (since generic_mourn calls
813 breakpoint_init_inferior). */
816 ignore (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
822 /* Okay, let's be honest: threads gleaned from a core file aren't
823 exactly lively, are they? On the other hand, if we don't claim
824 that each & every one is alive, then we don't get any of them
825 to appear in an "info thread" command, which is quite a useful
829 core_thread_alive (struct target_ops *ops, ptid_t ptid)
834 /* Ask the current architecture what it knows about this core file.
835 That will be used, in turn, to pick a better architecture. This
836 wrapper could be avoided if targets got a chance to specialize
839 static const struct target_desc *
840 core_read_description (struct target_ops *target)
842 if (core_gdbarch && gdbarch_core_read_description_p (core_gdbarch))
843 return gdbarch_core_read_description (core_gdbarch,
850 core_pid_to_str (struct target_ops *ops, ptid_t ptid)
853 struct inferior *inf;
856 /* The preferred way is to have a gdbarch/OS specific
859 && gdbarch_core_pid_to_str_p (core_gdbarch))
860 return gdbarch_core_pid_to_str (core_gdbarch, ptid);
862 /* Otherwise, if we don't have one, we'll just fallback to
863 "process", with normal_pid_to_str. */
865 /* Try the LWPID field first. */
866 pid = ptid_get_lwp (ptid);
868 return normal_pid_to_str (pid_to_ptid (pid));
870 /* Otherwise, this isn't a "threaded" core -- use the PID field, but
871 only if it isn't a fake PID. */
872 inf = find_inferior_pid (ptid_get_pid (ptid));
873 if (inf != NULL && !inf->fake_pid_p)
874 return normal_pid_to_str (ptid);
876 /* No luck. We simply don't have a valid PID to print. */
877 xsnprintf (buf, sizeof buf, "<main task>");
882 core_has_memory (struct target_ops *ops)
884 return (core_bfd != NULL);
888 core_has_stack (struct target_ops *ops)
890 return (core_bfd != NULL);
894 core_has_registers (struct target_ops *ops)
896 return (core_bfd != NULL);
899 /* Fill in core_ops with its defined operations and properties. */
904 core_ops.to_shortname = "core";
905 core_ops.to_longname = "Local core dump file";
907 "Use a core file as a target. Specify the filename of the core file.";
908 core_ops.to_open = core_open;
909 core_ops.to_close = core_close;
910 core_ops.to_attach = find_default_attach;
911 core_ops.to_detach = core_detach;
912 core_ops.to_fetch_registers = get_core_registers;
913 core_ops.to_xfer_partial = core_xfer_partial;
914 core_ops.to_files_info = core_files_info;
915 core_ops.to_insert_breakpoint = ignore;
916 core_ops.to_remove_breakpoint = ignore;
917 core_ops.to_create_inferior = find_default_create_inferior;
918 core_ops.to_thread_alive = core_thread_alive;
919 core_ops.to_read_description = core_read_description;
920 core_ops.to_pid_to_str = core_pid_to_str;
921 core_ops.to_stratum = process_stratum;
922 core_ops.to_has_memory = core_has_memory;
923 core_ops.to_has_stack = core_has_stack;
924 core_ops.to_has_registers = core_has_registers;
925 core_ops.to_magic = OPS_MAGIC;
928 internal_error (__FILE__, __LINE__,
929 _("init_core_ops: core target already exists (\"%s\")."),
930 core_target->to_longname);
931 core_target = &core_ops;
935 _initialize_corelow (void)
939 add_target (&core_ops);