1 /* Core dump and executable file functions below target vector, for GDB.
3 Copyright (C) 1986-2013 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "arch-utils.h"
22 #include "gdb_string.h"
26 #ifdef HAVE_SYS_FILE_H
27 #include <sys/file.h> /* needed for F_OK and friends */
29 #include "frame.h" /* required by inferior.h */
36 #include "gdbthread.h"
41 #include "readline/readline.h"
42 #include "gdb_assert.h"
43 #include "exceptions.h"
45 #include "filenames.h"
46 #include "progspace.h"
49 #include "completer.h"
50 #include "filestuff.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 static void core_files_info (struct target_ops
*);
82 static struct core_fns
*sniff_core_bfd (bfd
*);
84 static int gdb_check_format (bfd
*);
86 static void core_open (char *, int);
88 static void core_detach (struct target_ops
*ops
, char *, int);
90 static void core_close (void);
92 static void core_close_cleanup (void *ignore
);
94 static void add_to_thread_list (bfd
*, asection
*, void *);
96 static void init_core_ops (void);
98 void _initialize_corelow (void);
100 static struct target_ops core_ops
;
102 /* An arbitrary identifier for the core inferior. */
103 #define CORELOW_PID 1
105 /* Link a new core_fns into the global core_file_fns list. Called on
106 gdb startup by the _initialize routine in each core file register
107 reader, to register information about each format the reader is
108 prepared to handle. */
111 deprecated_add_core_fns (struct core_fns
*cf
)
113 cf
->next
= core_file_fns
;
117 /* The default function that core file handlers can use to examine a
118 core file BFD and decide whether or not to accept the job of
119 reading the core file. */
122 default_core_sniffer (struct core_fns
*our_fns
, bfd
*abfd
)
126 result
= (bfd_get_flavour (abfd
) == our_fns
-> core_flavour
);
130 /* Walk through the list of core functions to find a set that can
131 handle the core file open on ABFD. Returns pointer to set that is
134 static struct core_fns
*
135 sniff_core_bfd (bfd
*abfd
)
138 struct core_fns
*yummy
= NULL
;
141 /* Don't sniff if we have support for register sets in
143 if (core_gdbarch
&& gdbarch_regset_from_core_section_p (core_gdbarch
))
146 for (cf
= core_file_fns
; cf
!= NULL
; cf
= cf
->next
)
148 if (cf
->core_sniffer (cf
, abfd
))
156 warning (_("\"%s\": ambiguous core format, %d handlers match"),
157 bfd_get_filename (abfd
), matches
);
159 else if (matches
== 0)
160 error (_("\"%s\": no core file handler recognizes format"),
161 bfd_get_filename (abfd
));
166 /* The default is to reject every core file format we see. Either
167 BFD has to recognize it, or we have to provide a function in the
168 core file handler that recognizes it. */
171 default_check_format (bfd
*abfd
)
176 /* Attempt to recognize core file formats that BFD rejects. */
179 gdb_check_format (bfd
*abfd
)
183 for (cf
= core_file_fns
; cf
!= NULL
; cf
= cf
->next
)
185 if (cf
->check_format (abfd
))
193 /* Discard all vestiges of any previous core file and mark data and
194 stack spaces as empty. */
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 gdb_bfd_unref (core_bfd
);
226 core_close_cleanup (void *ignore
)
231 /* Look for sections whose names start with `.reg/' so that we can
232 extract the list of threads in a core file. */
235 add_to_thread_list (bfd
*abfd
, asection
*asect
, void *reg_sect_arg
)
240 asection
*reg_sect
= (asection
*) reg_sect_arg
;
242 struct inferior
*inf
;
244 if (strncmp (bfd_section_name (abfd
, asect
), ".reg/", 5) != 0)
247 core_tid
= atoi (bfd_section_name (abfd
, asect
) + 5);
249 pid
= bfd_core_file_pid (core_bfd
);
258 inf
= current_inferior ();
261 inferior_appeared (inf
, pid
);
262 inf
->fake_pid_p
= fake_pid_p
;
265 ptid
= ptid_build (pid
, lwpid
, 0);
269 /* Warning, Will Robinson, looking at BFD private data! */
272 && asect
->filepos
== reg_sect
->filepos
) /* Did we find .reg? */
273 inferior_ptid
= ptid
; /* Yes, make it current. */
276 /* This routine opens and sets up the core file bfd. */
279 core_open (char *filename
, int from_tty
)
283 struct cleanup
*old_chain
;
288 volatile struct gdb_exception except
;
290 target_preopen (from_tty
);
294 error (_("No core file specified. (Use `detach' "
295 "to stop debugging a core file.)"));
297 error (_("No core file specified."));
300 filename
= tilde_expand (filename
);
301 if (!IS_ABSOLUTE_PATH (filename
))
303 temp
= concat (current_directory
, "/",
304 filename
, (char *) NULL
);
309 old_chain
= make_cleanup (xfree
, filename
);
311 flags
= O_BINARY
| O_LARGEFILE
;
316 scratch_chan
= gdb_open_cloexec (filename
, flags
, 0);
317 if (scratch_chan
< 0)
318 perror_with_name (filename
);
320 temp_bfd
= gdb_bfd_fopen (filename
, gnutarget
,
321 write_files
? FOPEN_RUB
: FOPEN_RB
,
323 if (temp_bfd
== NULL
)
324 perror_with_name (filename
);
326 if (!bfd_check_format (temp_bfd
, bfd_core
)
327 && !gdb_check_format (temp_bfd
))
329 /* Do it after the err msg */
330 /* FIXME: should be checking for errors from bfd_close (for one
331 thing, on error it does not free all the storage associated
333 make_cleanup_bfd_unref (temp_bfd
);
334 error (_("\"%s\" is not a core dump: %s"),
335 filename
, bfd_errmsg (bfd_get_error ()));
338 /* Looks semi-reasonable. Toss the old core file and work on the
341 do_cleanups (old_chain
);
342 unpush_target (&core_ops
);
344 old_chain
= make_cleanup (core_close_cleanup
, 0 /*ignore*/);
346 core_gdbarch
= gdbarch_from_bfd (core_bfd
);
348 /* Find a suitable core file handler to munch on core_bfd */
349 core_vec
= sniff_core_bfd (core_bfd
);
353 core_data
= XZALLOC (struct target_section_table
);
355 /* Find the data section */
356 if (build_section_table (core_bfd
,
357 &core_data
->sections
,
358 &core_data
->sections_end
))
359 error (_("\"%s\": Can't find sections: %s"),
360 bfd_get_filename (core_bfd
), bfd_errmsg (bfd_get_error ()));
362 /* If we have no exec file, try to set the architecture from the
363 core file. We don't do this unconditionally since an exec file
364 typically contains more information that helps us determine the
365 architecture than a core file. */
367 set_gdbarch_from_file (core_bfd
);
369 push_target (&core_ops
);
370 discard_cleanups (old_chain
);
372 /* Do this before acknowledging the inferior, so if
373 post_create_inferior throws (can happen easilly if you're loading
374 a core file with the wrong exec), we aren't left with threads
375 from the previous inferior. */
378 inferior_ptid
= null_ptid
;
380 /* Need to flush the register cache (and the frame cache) from a
381 previous debug session. If inferior_ptid ends up the same as the
382 last debug session --- e.g., b foo; run; gcore core1; step; gcore
383 core2; core core1; core core2 --- then there's potential for
384 get_current_regcache to return the cached regcache of the
385 previous session, and the frame cache being stale. */
386 registers_changed ();
388 /* Build up thread list from BFD sections, and possibly set the
389 current thread to the .reg/NN section matching the .reg
391 bfd_map_over_sections (core_bfd
, add_to_thread_list
,
392 bfd_get_section_by_name (core_bfd
, ".reg"));
394 if (ptid_equal (inferior_ptid
, null_ptid
))
396 /* Either we found no .reg/NN section, and hence we have a
397 non-threaded core (single-threaded, from gdb's perspective),
398 or for some reason add_to_thread_list couldn't determine
399 which was the "main" thread. The latter case shouldn't
400 usually happen, but we're dealing with input here, which can
401 always be broken in different ways. */
402 struct thread_info
*thread
= first_thread_of_process (-1);
406 inferior_appeared (current_inferior (), CORELOW_PID
);
407 inferior_ptid
= pid_to_ptid (CORELOW_PID
);
408 add_thread_silent (inferior_ptid
);
411 switch_to_thread (thread
->ptid
);
414 post_create_inferior (&core_ops
, from_tty
);
416 /* Now go through the target stack looking for threads since there
417 may be a thread_stratum target loaded on top of target core by
418 now. The layer above should claim threads found in the BFD
420 TRY_CATCH (except
, RETURN_MASK_ERROR
)
422 target_find_new_threads ();
425 if (except
.reason
< 0)
426 exception_print (gdb_stderr
, except
);
428 p
= bfd_core_file_failing_command (core_bfd
);
430 printf_filtered (_("Core was generated by `%s'.\n"), p
);
432 siggy
= bfd_core_file_failing_signal (core_bfd
);
435 /* If we don't have a CORE_GDBARCH to work with, assume a native
436 core (map gdb_signal from host signals). If we do have
437 CORE_GDBARCH to work with, but no gdb_signal_from_target
438 implementation for that gdbarch, as a fallback measure,
439 assume the host signal mapping. It'll be correct for native
440 cores, but most likely incorrect for cross-cores. */
441 enum gdb_signal sig
= (core_gdbarch
!= NULL
442 && gdbarch_gdb_signal_from_target_p (core_gdbarch
)
443 ? gdbarch_gdb_signal_from_target (core_gdbarch
,
445 : gdb_signal_from_host (siggy
));
447 printf_filtered (_("Program terminated with signal %d, %s.\n"),
448 siggy
, gdb_signal_to_string (sig
));
451 /* Fetch all registers from core file. */
452 target_fetch_registers (get_current_regcache (), -1);
454 /* Now, set up the frame cache, and print the top of stack. */
455 reinit_frame_cache ();
456 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
);
460 core_detach (struct target_ops
*ops
, char *args
, int from_tty
)
463 error (_("Too many arguments"));
465 reinit_frame_cache ();
467 printf_filtered (_("No core file now.\n"));
470 #ifdef DEPRECATED_IBM6000_TARGET
472 /* Resize the core memory's section table, by NUM_ADDED. Returns a
473 pointer into the first new slot. This will not be necessary when
474 the rs6000 target is converted to use the standard solib
477 struct target_section
*
478 deprecated_core_resize_section_table (int num_added
)
482 old_count
= resize_section_table (core_data
, num_added
);
483 return core_data
->sections
+ old_count
;
488 /* Try to retrieve registers from a section in core_bfd, and supply
489 them to core_vec->core_read_registers, as the register set numbered
492 If inferior_ptid's lwp member is zero, do the single-threaded
493 thing: look for a section named NAME. If inferior_ptid's lwp
494 member is non-zero, do the multi-threaded thing: look for a section
495 named "NAME/LWP", where LWP is the shortest ASCII decimal
496 representation of inferior_ptid's lwp member.
498 HUMAN_NAME is a human-readable name for the kind of registers the
499 NAME section contains, for use in error messages.
501 If REQUIRED is non-zero, print an error if the core file doesn't
502 have a section by the appropriate name. Otherwise, just do
506 get_core_register_section (struct regcache
*regcache
,
509 const char *human_name
,
512 static char *section_name
= NULL
;
513 struct bfd_section
*section
;
517 xfree (section_name
);
519 if (ptid_get_lwp (inferior_ptid
))
520 section_name
= xstrprintf ("%s/%ld", name
,
521 ptid_get_lwp (inferior_ptid
));
523 section_name
= xstrdup (name
);
525 section
= bfd_get_section_by_name (core_bfd
, section_name
);
529 warning (_("Couldn't find %s registers in core file."),
534 size
= bfd_section_size (core_bfd
, section
);
535 contents
= alloca (size
);
536 if (! bfd_get_section_contents (core_bfd
, section
, contents
,
539 warning (_("Couldn't read %s registers from `%s' section in core file."),
544 if (core_gdbarch
&& gdbarch_regset_from_core_section_p (core_gdbarch
))
546 const struct regset
*regset
;
548 regset
= gdbarch_regset_from_core_section (core_gdbarch
,
553 warning (_("Couldn't recognize %s registers in core file."),
558 regset
->supply_regset (regset
, regcache
, -1, contents
, size
);
562 gdb_assert (core_vec
);
563 core_vec
->core_read_registers (regcache
, contents
, size
, which
,
565 bfd_section_vma (core_bfd
, section
)));
569 /* Get the registers out of a core file. This is the machine-
570 independent part. Fetch_core_registers is the machine-dependent
571 part, typically implemented in the xm-file for each
574 /* We just get all the registers, so we don't use regno. */
577 get_core_registers (struct target_ops
*ops
,
578 struct regcache
*regcache
, int regno
)
580 struct core_regset_section
*sect_list
;
583 if (!(core_gdbarch
&& gdbarch_regset_from_core_section_p (core_gdbarch
))
584 && (core_vec
== NULL
|| core_vec
->core_read_registers
== NULL
))
586 fprintf_filtered (gdb_stderr
,
587 "Can't fetch registers from this type of core file\n");
591 sect_list
= gdbarch_core_regset_sections (get_regcache_arch (regcache
));
593 while (sect_list
->sect_name
!= NULL
)
595 if (strcmp (sect_list
->sect_name
, ".reg") == 0)
596 get_core_register_section (regcache
, sect_list
->sect_name
,
597 0, sect_list
->human_name
, 1);
598 else if (strcmp (sect_list
->sect_name
, ".reg2") == 0)
599 get_core_register_section (regcache
, sect_list
->sect_name
,
600 2, sect_list
->human_name
, 0);
602 get_core_register_section (regcache
, sect_list
->sect_name
,
603 3, sect_list
->human_name
, 0);
610 get_core_register_section (regcache
,
611 ".reg", 0, "general-purpose", 1);
612 get_core_register_section (regcache
,
613 ".reg2", 2, "floating-point", 0);
616 /* Mark all registers not found in the core as unavailable. */
617 for (i
= 0; i
< gdbarch_num_regs (get_regcache_arch (regcache
)); i
++)
618 if (regcache_register_status (regcache
, i
) == REG_UNKNOWN
)
619 regcache_raw_supply (regcache
, i
, NULL
);
623 core_files_info (struct target_ops
*t
)
625 print_section_info (core_data
, core_bfd
);
638 add_to_spuid_list (bfd
*abfd
, asection
*asect
, void *list_p
)
640 struct spuid_list
*list
= list_p
;
641 enum bfd_endian byte_order
642 = bfd_big_endian (abfd
) ? BFD_ENDIAN_BIG
: BFD_ENDIAN_LITTLE
;
645 sscanf (bfd_section_name (abfd
, asect
), "SPU/%d/regs%n", &fd
, &pos
);
649 if (list
->pos
>= list
->offset
&& list
->pos
+ 4 <= list
->offset
+ list
->len
)
651 store_unsigned_integer (list
->buf
+ list
->pos
- list
->offset
,
658 /* Read siginfo data from the core, if possible. Returns -1 on
659 failure. Otherwise, returns the number of bytes read. ABFD is the
660 core file's BFD; READBUF, OFFSET, and LEN are all as specified by
661 the to_xfer_partial interface. */
664 get_core_siginfo (bfd
*abfd
, gdb_byte
*readbuf
, ULONGEST offset
, LONGEST len
)
668 const char *name
= ".note.linuxcore.siginfo";
670 if (ptid_get_lwp (inferior_ptid
))
671 section_name
= xstrprintf ("%s/%ld", name
,
672 ptid_get_lwp (inferior_ptid
));
674 section_name
= xstrdup (name
);
676 section
= bfd_get_section_by_name (abfd
, section_name
);
677 xfree (section_name
);
681 if (!bfd_get_section_contents (abfd
, section
, readbuf
, offset
, len
))
688 core_xfer_partial (struct target_ops
*ops
, enum target_object object
,
689 const char *annex
, gdb_byte
*readbuf
,
690 const gdb_byte
*writebuf
, ULONGEST offset
,
695 case TARGET_OBJECT_MEMORY
:
696 return section_table_xfer_memory_partial (readbuf
, writebuf
,
699 core_data
->sections_end
,
702 case TARGET_OBJECT_AUXV
:
705 /* When the aux vector is stored in core file, BFD
706 represents this with a fake section called ".auxv". */
708 struct bfd_section
*section
;
711 section
= bfd_get_section_by_name (core_bfd
, ".auxv");
715 size
= bfd_section_size (core_bfd
, section
);
722 && !bfd_get_section_contents (core_bfd
, section
, readbuf
,
723 (file_ptr
) offset
, size
))
725 warning (_("Couldn't read NT_AUXV note in core file."));
733 case TARGET_OBJECT_WCOOKIE
:
736 /* When the StackGhost cookie is stored in core file, BFD
737 represents this with a fake section called
740 struct bfd_section
*section
;
743 section
= bfd_get_section_by_name (core_bfd
, ".wcookie");
747 size
= bfd_section_size (core_bfd
, section
);
754 && !bfd_get_section_contents (core_bfd
, section
, readbuf
,
755 (file_ptr
) offset
, size
))
757 warning (_("Couldn't read StackGhost cookie in core file."));
765 case TARGET_OBJECT_LIBRARIES
:
767 && gdbarch_core_xfer_shared_libraries_p (core_gdbarch
))
772 gdbarch_core_xfer_shared_libraries (core_gdbarch
,
773 readbuf
, offset
, len
);
777 case TARGET_OBJECT_SPU
:
778 if (readbuf
&& annex
)
780 /* When the SPU contexts are stored in a core file, BFD
781 represents this with a fake section called
784 struct bfd_section
*section
;
786 char sectionstr
[100];
788 xsnprintf (sectionstr
, sizeof sectionstr
, "SPU/%s", annex
);
790 section
= bfd_get_section_by_name (core_bfd
, sectionstr
);
794 size
= bfd_section_size (core_bfd
, section
);
801 && !bfd_get_section_contents (core_bfd
, section
, readbuf
,
802 (file_ptr
) offset
, size
))
804 warning (_("Couldn't read SPU section in core file."));
812 /* NULL annex requests list of all present spuids. */
813 struct spuid_list list
;
816 list
.offset
= offset
;
820 bfd_map_over_sections (core_bfd
, add_to_spuid_list
, &list
);
825 case TARGET_OBJECT_SIGNAL_INFO
:
827 return get_core_siginfo (core_bfd
, readbuf
, offset
, len
);
831 if (ops
->beneath
!= NULL
)
832 return ops
->beneath
->to_xfer_partial (ops
->beneath
, object
,
834 writebuf
, offset
, len
);
840 /* If mourn is being called in all the right places, this could be say
841 `gdb internal error' (since generic_mourn calls
842 breakpoint_init_inferior). */
845 ignore (struct gdbarch
*gdbarch
, struct bp_target_info
*bp_tgt
)
851 /* Okay, let's be honest: threads gleaned from a core file aren't
852 exactly lively, are they? On the other hand, if we don't claim
853 that each & every one is alive, then we don't get any of them
854 to appear in an "info thread" command, which is quite a useful
858 core_thread_alive (struct target_ops
*ops
, ptid_t ptid
)
863 /* Ask the current architecture what it knows about this core file.
864 That will be used, in turn, to pick a better architecture. This
865 wrapper could be avoided if targets got a chance to specialize
868 static const struct target_desc
*
869 core_read_description (struct target_ops
*target
)
871 if (core_gdbarch
&& gdbarch_core_read_description_p (core_gdbarch
))
872 return gdbarch_core_read_description (core_gdbarch
,
879 core_pid_to_str (struct target_ops
*ops
, ptid_t ptid
)
882 struct inferior
*inf
;
885 /* The preferred way is to have a gdbarch/OS specific
888 && gdbarch_core_pid_to_str_p (core_gdbarch
))
889 return gdbarch_core_pid_to_str (core_gdbarch
, ptid
);
891 /* Otherwise, if we don't have one, we'll just fallback to
892 "process", with normal_pid_to_str. */
894 /* Try the LWPID field first. */
895 pid
= ptid_get_lwp (ptid
);
897 return normal_pid_to_str (pid_to_ptid (pid
));
899 /* Otherwise, this isn't a "threaded" core -- use the PID field, but
900 only if it isn't a fake PID. */
901 inf
= find_inferior_pid (ptid_get_pid (ptid
));
902 if (inf
!= NULL
&& !inf
->fake_pid_p
)
903 return normal_pid_to_str (ptid
);
905 /* No luck. We simply don't have a valid PID to print. */
906 xsnprintf (buf
, sizeof buf
, "<main task>");
911 core_has_memory (struct target_ops
*ops
)
913 return (core_bfd
!= NULL
);
917 core_has_stack (struct target_ops
*ops
)
919 return (core_bfd
!= NULL
);
923 core_has_registers (struct target_ops
*ops
)
925 return (core_bfd
!= NULL
);
928 /* Implement the to_info_proc method. */
931 core_info_proc (struct target_ops
*ops
, char *args
, enum info_proc_what request
)
933 struct gdbarch
*gdbarch
= get_current_arch ();
935 /* Since this is the core file target, call the 'core_info_proc'
936 method on gdbarch, not 'info_proc'. */
937 if (gdbarch_core_info_proc_p (gdbarch
))
938 gdbarch_core_info_proc (gdbarch
, args
, request
);
941 /* Fill in core_ops with its defined operations and properties. */
946 core_ops
.to_shortname
= "core";
947 core_ops
.to_longname
= "Local core dump file";
949 "Use a core file as a target. Specify the filename of the core file.";
950 core_ops
.to_open
= core_open
;
951 core_ops
.to_close
= core_close
;
952 core_ops
.to_attach
= find_default_attach
;
953 core_ops
.to_detach
= core_detach
;
954 core_ops
.to_fetch_registers
= get_core_registers
;
955 core_ops
.to_xfer_partial
= core_xfer_partial
;
956 core_ops
.to_files_info
= core_files_info
;
957 core_ops
.to_insert_breakpoint
= ignore
;
958 core_ops
.to_remove_breakpoint
= ignore
;
959 core_ops
.to_create_inferior
= find_default_create_inferior
;
960 core_ops
.to_thread_alive
= core_thread_alive
;
961 core_ops
.to_read_description
= core_read_description
;
962 core_ops
.to_pid_to_str
= core_pid_to_str
;
963 core_ops
.to_stratum
= process_stratum
;
964 core_ops
.to_has_memory
= core_has_memory
;
965 core_ops
.to_has_stack
= core_has_stack
;
966 core_ops
.to_has_registers
= core_has_registers
;
967 core_ops
.to_info_proc
= core_info_proc
;
968 core_ops
.to_magic
= OPS_MAGIC
;
971 internal_error (__FILE__
, __LINE__
,
972 _("init_core_ops: core target already exists (\"%s\")."),
973 core_target
->to_longname
);
974 core_target
= &core_ops
;
978 _initialize_corelow (void)
982 add_target_with_completer (&core_ops
, filename_completer
);