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, 2009, 2010,
5 2011 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"
48 #include "progspace.h"
56 /* List of all available core_fns. On gdb startup, each core file
57 register reader calls deprecated_add_core_fns() to register
58 information on each core format it is prepared to read. */
60 static struct core_fns
*core_file_fns
= NULL
;
62 /* The core_fns for a core file handler that is prepared to read the
63 core file currently open on core_bfd. */
65 static struct core_fns
*core_vec
= NULL
;
67 /* FIXME: kettenis/20031023: Eventually this variable should
70 struct gdbarch
*core_gdbarch
= NULL
;
72 /* Per-core data. Currently, only the section table. Note that these
73 target sections are *not* mapped in the current address spaces' set
74 of target sections --- those should come only from pure executable
75 or shared library bfds. The core bfd sections are an
76 implementation detail of the core target, just like ptrace is for
77 unix child targets. */
78 static struct target_section_table
*core_data
;
80 /* True if we needed to fake the pid of the loaded core inferior. */
81 static int core_has_fake_pid
= 0;
83 static void core_files_info (struct target_ops
*);
85 static struct core_fns
*sniff_core_bfd (bfd
*);
87 static int gdb_check_format (bfd
*);
89 static void core_open (char *, int);
91 static void core_detach (struct target_ops
*ops
, char *, int);
93 static void core_close (int);
95 static void core_close_cleanup (void *ignore
);
97 static void add_to_thread_list (bfd
*, asection
*, void *);
99 static void init_core_ops (void);
101 void _initialize_corelow (void);
103 static struct target_ops core_ops
;
105 /* An arbitrary identifier for the core inferior. */
106 #define CORELOW_PID 1
108 /* Link a new core_fns into the global core_file_fns list. Called on
109 gdb startup by the _initialize routine in each core file register
110 reader, to register information about each format the reader is
111 prepared to handle. */
114 deprecated_add_core_fns (struct core_fns
*cf
)
116 cf
->next
= core_file_fns
;
120 /* The default function that core file handlers can use to examine a
121 core file BFD and decide whether or not to accept the job of
122 reading the core file. */
125 default_core_sniffer (struct core_fns
*our_fns
, bfd
*abfd
)
129 result
= (bfd_get_flavour (abfd
) == our_fns
-> core_flavour
);
133 /* Walk through the list of core functions to find a set that can
134 handle the core file open on ABFD. Default to the first one in the
135 list if nothing matches. Returns pointer to set that is
138 static struct core_fns
*
139 sniff_core_bfd (bfd
*abfd
)
142 struct core_fns
*yummy
= NULL
;
145 /* Don't sniff if we have support for register sets in
147 if (core_gdbarch
&& gdbarch_regset_from_core_section_p (core_gdbarch
))
150 for (cf
= core_file_fns
; cf
!= NULL
; cf
= cf
->next
)
152 if (cf
->core_sniffer (cf
, abfd
))
160 warning (_("\"%s\": ambiguous core format, %d handlers match"),
161 bfd_get_filename (abfd
), matches
);
163 else if (matches
== 0)
165 warning (_("\"%s\": no core file handler "
166 "recognizes format, using default"),
167 bfd_get_filename (abfd
));
171 yummy
= core_file_fns
;
176 /* The default is to reject every core file format we see. Either
177 BFD has to recognize it, or we have to provide a function in the
178 core file handler that recognizes it. */
181 default_check_format (bfd
*abfd
)
186 /* Attempt to recognize core file formats that BFD rejects. */
189 gdb_check_format (bfd
*abfd
)
193 for (cf
= core_file_fns
; cf
!= NULL
; cf
= cf
->next
)
195 if (cf
->check_format (abfd
))
203 /* Discard all vestiges of any previous core file and mark data and
204 stack spaces as empty. */
207 core_close (int quitting
)
213 int pid
= ptid_get_pid (inferior_ptid
);
214 inferior_ptid
= null_ptid
; /* Avoid confusion from thread
216 exit_inferior_silent (pid
);
218 /* Clear out solib state while the bfd is still open. See
219 comments in clear_solib in solib.c. */
222 xfree (core_data
->sections
);
225 core_has_fake_pid
= 0;
227 name
= bfd_get_filename (core_bfd
);
228 gdb_bfd_close_or_warn (core_bfd
);
237 core_close_cleanup (void *ignore
)
239 core_close (0/*ignored*/);
242 /* Look for sections whose names start with `.reg/' so that we can
243 extract the list of threads in a core file. */
246 add_to_thread_list (bfd
*abfd
, asection
*asect
, void *reg_sect_arg
)
251 asection
*reg_sect
= (asection
*) reg_sect_arg
;
253 if (strncmp (bfd_section_name (abfd
, asect
), ".reg/", 5) != 0)
256 core_tid
= atoi (bfd_section_name (abfd
, asect
) + 5);
258 pid
= bfd_core_file_pid (core_bfd
);
261 core_has_fake_pid
= 1;
267 if (current_inferior ()->pid
== 0)
268 inferior_appeared (current_inferior (), pid
);
270 ptid
= ptid_build (pid
, lwpid
, 0);
274 /* Warning, Will Robinson, looking at BFD private data! */
277 && asect
->filepos
== reg_sect
->filepos
) /* Did we find .reg? */
278 inferior_ptid
= ptid
; /* Yes, make it current. */
281 /* This routine opens and sets up the core file bfd. */
284 core_open (char *filename
, int from_tty
)
288 struct cleanup
*old_chain
;
294 target_preopen (from_tty
);
298 error (_("No core file specified. (Use `detach' "
299 "to stop debugging a core file.)"));
301 error (_("No core file specified."));
304 filename
= tilde_expand (filename
);
305 if (!IS_ABSOLUTE_PATH (filename
))
307 temp
= concat (current_directory
, "/",
308 filename
, (char *) NULL
);
313 old_chain
= make_cleanup (xfree
, filename
);
315 flags
= O_BINARY
| O_LARGEFILE
;
320 scratch_chan
= open (filename
, flags
, 0);
321 if (scratch_chan
< 0)
322 perror_with_name (filename
);
324 temp_bfd
= bfd_fopen (filename
, gnutarget
,
325 write_files
? FOPEN_RUB
: FOPEN_RB
,
327 if (temp_bfd
== NULL
)
328 perror_with_name (filename
);
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_close (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 discard_cleanups (old_chain
); /* Don't free filename any more */
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
;
389 core_has_fake_pid
= 0;
391 /* Need to flush the register cache (and the frame cache) from a
392 previous debug session. If inferior_ptid ends up the same as the
393 last debug session --- e.g., b foo; run; gcore core1; step; gcore
394 core2; core core1; core core2 --- then there's potential for
395 get_current_regcache to return the cached regcache of the
396 previous session, and the frame cache being stale. */
397 registers_changed ();
399 /* Build up thread list from BFD sections, and possibly set the
400 current thread to the .reg/NN section matching the .reg
402 bfd_map_over_sections (core_bfd
, add_to_thread_list
,
403 bfd_get_section_by_name (core_bfd
, ".reg"));
405 if (ptid_equal (inferior_ptid
, null_ptid
))
407 /* Either we found no .reg/NN section, and hence we have a
408 non-threaded core (single-threaded, from gdb's perspective),
409 or for some reason add_to_thread_list couldn't determine
410 which was the "main" thread. The latter case shouldn't
411 usually happen, but we're dealing with input here, which can
412 always be broken in different ways. */
413 struct thread_info
*thread
= first_thread_of_process (-1);
417 inferior_appeared (current_inferior (), CORELOW_PID
);
418 inferior_ptid
= pid_to_ptid (CORELOW_PID
);
419 add_thread_silent (inferior_ptid
);
422 switch_to_thread (thread
->ptid
);
425 post_create_inferior (&core_ops
, from_tty
);
427 /* Now go through the target stack looking for threads since there
428 may be a thread_stratum target loaded on top of target core by
429 now. The layer above should claim threads found in the BFD
431 target_find_new_threads ();
433 p
= bfd_core_file_failing_command (core_bfd
);
435 printf_filtered (_("Core was generated by `%s'.\n"), p
);
437 siggy
= bfd_core_file_failing_signal (core_bfd
);
440 /* NOTE: target_signal_from_host() converts a target signal
441 value into gdb's internal signal value. Unfortunately gdb's
442 internal value is called ``target_signal'' and this function
443 got the name ..._from_host(). */
444 enum target_signal sig
= (core_gdbarch
!= NULL
445 ? gdbarch_target_signal_from_host (core_gdbarch
,
447 : target_signal_from_host (siggy
));
449 printf_filtered (_("Program terminated with signal %d, %s.\n"),
450 siggy
, target_signal_to_string (sig
));
453 /* Fetch all registers from core file. */
454 target_fetch_registers (get_current_regcache (), -1);
456 /* Now, set up the frame cache, and print the top of stack. */
457 reinit_frame_cache ();
458 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
);
462 core_detach (struct target_ops
*ops
, char *args
, int from_tty
)
465 error (_("Too many arguments"));
467 reinit_frame_cache ();
469 printf_filtered (_("No core file now.\n"));
472 #ifdef DEPRECATED_IBM6000_TARGET
474 /* Resize the core memory's section table, by NUM_ADDED. Returns a
475 pointer into the first new slot. This will not be necessary when
476 the rs6000 target is converted to use the standard solib
479 struct target_section
*
480 deprecated_core_resize_section_table (int num_added
)
484 old_count
= resize_section_table (core_data
, num_added
);
485 return core_data
->sections
+ old_count
;
490 /* Try to retrieve registers from a section in core_bfd, and supply
491 them to core_vec->core_read_registers, as the register set numbered
494 If inferior_ptid's lwp member is zero, do the single-threaded
495 thing: look for a section named NAME. If inferior_ptid's lwp
496 member is non-zero, do the multi-threaded thing: look for a section
497 named "NAME/LWP", where LWP is the shortest ASCII decimal
498 representation of inferior_ptid's lwp member.
500 HUMAN_NAME is a human-readable name for the kind of registers the
501 NAME section contains, for use in error messages.
503 If REQUIRED is non-zero, print an error if the core file doesn't
504 have a section by the appropriate name. Otherwise, just do
508 get_core_register_section (struct regcache
*regcache
,
511 const char *human_name
,
514 static char *section_name
= NULL
;
515 struct bfd_section
*section
;
519 xfree (section_name
);
521 if (ptid_get_lwp (inferior_ptid
))
522 section_name
= xstrprintf ("%s/%ld", name
,
523 ptid_get_lwp (inferior_ptid
));
525 section_name
= xstrdup (name
);
527 section
= bfd_get_section_by_name (core_bfd
, section_name
);
531 warning (_("Couldn't find %s registers in core file."),
536 size
= bfd_section_size (core_bfd
, section
);
537 contents
= alloca (size
);
538 if (! bfd_get_section_contents (core_bfd
, section
, contents
,
541 warning (_("Couldn't read %s registers from `%s' section in core file."),
546 if (core_gdbarch
&& gdbarch_regset_from_core_section_p (core_gdbarch
))
548 const struct regset
*regset
;
550 regset
= gdbarch_regset_from_core_section (core_gdbarch
,
555 warning (_("Couldn't recognize %s registers in core file."),
560 regset
->supply_regset (regset
, regcache
, -1, contents
, size
);
564 gdb_assert (core_vec
);
565 core_vec
->core_read_registers (regcache
, contents
, size
, which
,
567 bfd_section_vma (core_bfd
, section
)));
571 /* Get the registers out of a core file. This is the machine-
572 independent part. Fetch_core_registers is the machine-dependent
573 part, typically implemented in the xm-file for each
576 /* We just get all the registers, so we don't use regno. */
579 get_core_registers (struct target_ops
*ops
,
580 struct regcache
*regcache
, int regno
)
582 struct core_regset_section
*sect_list
;
585 if (!(core_gdbarch
&& gdbarch_regset_from_core_section_p (core_gdbarch
))
586 && (core_vec
== NULL
|| core_vec
->core_read_registers
== NULL
))
588 fprintf_filtered (gdb_stderr
,
589 "Can't fetch registers from this type of core file\n");
593 sect_list
= gdbarch_core_regset_sections (get_regcache_arch (regcache
));
595 while (sect_list
->sect_name
!= NULL
)
597 if (strcmp (sect_list
->sect_name
, ".reg") == 0)
598 get_core_register_section (regcache
, sect_list
->sect_name
,
599 0, sect_list
->human_name
, 1);
600 else if (strcmp (sect_list
->sect_name
, ".reg2") == 0)
601 get_core_register_section (regcache
, sect_list
->sect_name
,
602 2, sect_list
->human_name
, 0);
604 get_core_register_section (regcache
, sect_list
->sect_name
,
605 3, sect_list
->human_name
, 0);
612 get_core_register_section (regcache
,
613 ".reg", 0, "general-purpose", 1);
614 get_core_register_section (regcache
,
615 ".reg2", 2, "floating-point", 0);
618 /* Mark all registers not found in the core as unavailable. */
619 for (i
= 0; i
< gdbarch_num_regs (get_regcache_arch (regcache
)); i
++)
620 if (regcache_register_status (regcache
, i
) == REG_UNKNOWN
)
621 regcache_raw_supply (regcache
, i
, NULL
);
625 core_files_info (struct target_ops
*t
)
627 print_section_info (core_data
, core_bfd
);
640 add_to_spuid_list (bfd
*abfd
, asection
*asect
, void *list_p
)
642 struct spuid_list
*list
= list_p
;
643 enum bfd_endian byte_order
644 = bfd_big_endian (abfd
) ? BFD_ENDIAN_BIG
: BFD_ENDIAN_LITTLE
;
647 sscanf (bfd_section_name (abfd
, asect
), "SPU/%d/regs%n", &fd
, &pos
);
651 if (list
->pos
>= list
->offset
&& list
->pos
+ 4 <= list
->offset
+ list
->len
)
653 store_unsigned_integer (list
->buf
+ list
->pos
- list
->offset
,
661 core_xfer_partial (struct target_ops
*ops
, enum target_object object
,
662 const char *annex
, gdb_byte
*readbuf
,
663 const gdb_byte
*writebuf
, ULONGEST offset
,
668 case TARGET_OBJECT_MEMORY
:
669 return section_table_xfer_memory_partial (readbuf
, writebuf
,
672 core_data
->sections_end
,
675 case TARGET_OBJECT_AUXV
:
678 /* When the aux vector is stored in core file, BFD
679 represents this with a fake section called ".auxv". */
681 struct bfd_section
*section
;
684 section
= bfd_get_section_by_name (core_bfd
, ".auxv");
688 size
= bfd_section_size (core_bfd
, section
);
695 && !bfd_get_section_contents (core_bfd
, section
, readbuf
,
696 (file_ptr
) offset
, size
))
698 warning (_("Couldn't read NT_AUXV note in core file."));
706 case TARGET_OBJECT_WCOOKIE
:
709 /* When the StackGhost cookie is stored in core file, BFD
710 represents this with a fake section called
713 struct bfd_section
*section
;
716 section
= bfd_get_section_by_name (core_bfd
, ".wcookie");
720 size
= bfd_section_size (core_bfd
, section
);
727 && !bfd_get_section_contents (core_bfd
, section
, readbuf
,
728 (file_ptr
) offset
, size
))
730 warning (_("Couldn't read StackGhost cookie in core file."));
738 case TARGET_OBJECT_LIBRARIES
:
740 && gdbarch_core_xfer_shared_libraries_p (core_gdbarch
))
745 gdbarch_core_xfer_shared_libraries (core_gdbarch
,
746 readbuf
, offset
, len
);
750 case TARGET_OBJECT_SPU
:
751 if (readbuf
&& annex
)
753 /* When the SPU contexts are stored in a core file, BFD
754 represents this with a fake section called
757 struct bfd_section
*section
;
759 char sectionstr
[100];
761 xsnprintf (sectionstr
, sizeof sectionstr
, "SPU/%s", annex
);
763 section
= bfd_get_section_by_name (core_bfd
, sectionstr
);
767 size
= bfd_section_size (core_bfd
, section
);
774 && !bfd_get_section_contents (core_bfd
, section
, readbuf
,
775 (file_ptr
) offset
, size
))
777 warning (_("Couldn't read SPU section in core file."));
785 /* NULL annex requests list of all present spuids. */
786 struct spuid_list list
;
789 list
.offset
= offset
;
793 bfd_map_over_sections (core_bfd
, add_to_spuid_list
, &list
);
799 if (ops
->beneath
!= NULL
)
800 return ops
->beneath
->to_xfer_partial (ops
->beneath
, object
,
802 writebuf
, offset
, len
);
808 /* If mourn is being called in all the right places, this could be say
809 `gdb internal error' (since generic_mourn calls
810 breakpoint_init_inferior). */
813 ignore (struct gdbarch
*gdbarch
, struct bp_target_info
*bp_tgt
)
819 /* Okay, let's be honest: threads gleaned from a core file aren't
820 exactly lively, are they? On the other hand, if we don't claim
821 that each & every one is alive, then we don't get any of them
822 to appear in an "info thread" command, which is quite a useful
826 core_thread_alive (struct target_ops
*ops
, ptid_t ptid
)
831 /* Ask the current architecture what it knows about this core file.
832 That will be used, in turn, to pick a better architecture. This
833 wrapper could be avoided if targets got a chance to specialize
836 static const struct target_desc
*
837 core_read_description (struct target_ops
*target
)
839 if (core_gdbarch
&& gdbarch_core_read_description_p (core_gdbarch
))
840 return gdbarch_core_read_description (core_gdbarch
,
847 core_pid_to_str (struct target_ops
*ops
, ptid_t ptid
)
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 if (!core_has_fake_pid
)
869 return normal_pid_to_str (ptid
);
871 /* No luck. We simply don't have a valid PID to print. */
872 xsnprintf (buf
, sizeof buf
, "<main task>");
877 core_has_memory (struct target_ops
*ops
)
879 return (core_bfd
!= NULL
);
883 core_has_stack (struct target_ops
*ops
)
885 return (core_bfd
!= NULL
);
889 core_has_registers (struct target_ops
*ops
)
891 return (core_bfd
!= NULL
);
894 /* Fill in core_ops with its defined operations and properties. */
899 core_ops
.to_shortname
= "core";
900 core_ops
.to_longname
= "Local core dump file";
902 "Use a core file as a target. Specify the filename of the core file.";
903 core_ops
.to_open
= core_open
;
904 core_ops
.to_close
= core_close
;
905 core_ops
.to_attach
= find_default_attach
;
906 core_ops
.to_detach
= core_detach
;
907 core_ops
.to_fetch_registers
= get_core_registers
;
908 core_ops
.to_xfer_partial
= core_xfer_partial
;
909 core_ops
.to_files_info
= core_files_info
;
910 core_ops
.to_insert_breakpoint
= ignore
;
911 core_ops
.to_remove_breakpoint
= ignore
;
912 core_ops
.to_create_inferior
= find_default_create_inferior
;
913 core_ops
.to_thread_alive
= core_thread_alive
;
914 core_ops
.to_read_description
= core_read_description
;
915 core_ops
.to_pid_to_str
= core_pid_to_str
;
916 core_ops
.to_stratum
= process_stratum
;
917 core_ops
.to_has_memory
= core_has_memory
;
918 core_ops
.to_has_stack
= core_has_stack
;
919 core_ops
.to_has_registers
= core_has_registers
;
920 core_ops
.to_magic
= OPS_MAGIC
;
923 internal_error (__FILE__
, __LINE__
,
924 _("init_core_ops: core target already exists (\"%s\")."),
925 core_target
->to_longname
);
926 core_target
= &core_ops
;
930 _initialize_corelow (void)
934 add_target (&core_ops
);