xref: /openbsd-src/gnu/usr.bin/binutils-2.17/bfd/doc/core.texi (revision 3d8817e467ea46cf4772788d6804dd293abfb01a)
1*3d8817e4Smiod@section Core files
2*3d8817e4Smiod
3*3d8817e4Smiod
4*3d8817e4Smiod@subsection Core file functions
5*3d8817e4Smiod
6*3d8817e4Smiod
7*3d8817e4Smiod@strong{Description}@*
8*3d8817e4SmiodThese are functions pertaining to core files.
9*3d8817e4Smiod
10*3d8817e4Smiod@findex bfd_core_file_failing_command
11*3d8817e4Smiod@subsubsection @code{bfd_core_file_failing_command}
12*3d8817e4Smiod@strong{Synopsis}
13*3d8817e4Smiod@example
14*3d8817e4Smiodconst char *bfd_core_file_failing_command (bfd *abfd);
15*3d8817e4Smiod@end example
16*3d8817e4Smiod@strong{Description}@*
17*3d8817e4SmiodReturn a read-only string explaining which program was running
18*3d8817e4Smiodwhen it failed and produced the core file @var{abfd}.
19*3d8817e4Smiod
20*3d8817e4Smiod@findex bfd_core_file_failing_signal
21*3d8817e4Smiod@subsubsection @code{bfd_core_file_failing_signal}
22*3d8817e4Smiod@strong{Synopsis}
23*3d8817e4Smiod@example
24*3d8817e4Smiodint bfd_core_file_failing_signal (bfd *abfd);
25*3d8817e4Smiod@end example
26*3d8817e4Smiod@strong{Description}@*
27*3d8817e4SmiodReturns the signal number which caused the core dump which
28*3d8817e4Smiodgenerated the file the BFD @var{abfd} is attached to.
29*3d8817e4Smiod
30*3d8817e4Smiod@findex core_file_matches_executable_p
31*3d8817e4Smiod@subsubsection @code{core_file_matches_executable_p}
32*3d8817e4Smiod@strong{Synopsis}
33*3d8817e4Smiod@example
34*3d8817e4Smiodbfd_boolean core_file_matches_executable_p
35*3d8817e4Smiod   (bfd *core_bfd, bfd *exec_bfd);
36*3d8817e4Smiod@end example
37*3d8817e4Smiod@strong{Description}@*
38*3d8817e4SmiodReturn @code{TRUE} if the core file attached to @var{core_bfd}
39*3d8817e4Smiodwas generated by a run of the executable file attached to
40*3d8817e4Smiod@var{exec_bfd}, @code{FALSE} otherwise.
41*3d8817e4Smiod
42*3d8817e4Smiod@findex generic_core_file_matches_executable_p
43*3d8817e4Smiod@subsubsection @code{generic_core_file_matches_executable_p}
44*3d8817e4Smiod@strong{Synopsis}
45*3d8817e4Smiod@example
46*3d8817e4Smiodbfd_boolean generic_core_file_matches_executable_p
47*3d8817e4Smiod   (bfd *core_bfd, bfd *exec_bfd);
48*3d8817e4Smiod@end example
49*3d8817e4Smiod@strong{Description}@*
50*3d8817e4SmiodReturn TRUE if the core file attached to @var{core_bfd}
51*3d8817e4Smiodwas generated by a run of the executable file attached
52*3d8817e4Smiodto @var{exec_bfd}.  The match is based on executable
53*3d8817e4Smiodbasenames only.
54*3d8817e4Smiod
55*3d8817e4SmiodNote: When not able to determine the core file failing
56*3d8817e4Smiodcommand or the executable name, we still return TRUE even
57*3d8817e4Smiodthough we're not sure that core file and executable match.
58*3d8817e4SmiodThis is to avoid generating a false warning in situations
59*3d8817e4Smiodwhere we really don't know whether they match or not.
60*3d8817e4Smiod
61