1 /* fileline.c -- Get file and line number information in a backtrace.
2 Copyright (C) 2012-2014 Free Software Foundation, Inc.
3 Written by Ian Lance Taylor, Google.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are
9 (1) Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
12 (2) Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in
14 the documentation and/or other materials provided with the
17 (3) The name of the author may not be used to
18 endorse or promote products derived from this software without
19 specific prior written permission.
21 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
25 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 POSSIBILITY OF SUCH DAMAGE. */
35 #include <sys/types.h>
40 #include <unistd.h> // For access()
42 #include "backtrace.h"
45 #ifndef HAVE_GETEXECNAME
46 #define getexecname() NULL
49 /* Initialize the fileline information from the executable. Returns 1
50 on success, 0 on failure. */
53 fileline_initialize (struct backtrace_state *state,
54 backtrace_error_callback error_callback, void *data)
61 failed = state->fileline_initialization_failed;
63 failed = backtrace_atomic_load_int (&state->fileline_initialization_failed);
67 error_callback (data, "failed to read executable information", -1);
72 fileline_fn = state->fileline_fn;
74 fileline_fn = backtrace_atomic_load_pointer (&state->fileline_fn);
75 if (fileline_fn != NULL)
78 /* We have not initialized the information. Do it now. */
81 for (pass = 0; pass < 4; ++pass)
86 filename = state->filename;
89 filename = getexecname ();
92 filename = "/proc/self/exe";
95 filename = "/proc/curproc/file";
101 /* If we've got a filename and the file exists, break. */
102 if (filename && filename[0] && (access(filename, F_OK) == 0))
110 if (state->filename != NULL)
111 error_callback (data, state->filename, ENOENT);
113 error_callback (data,
114 "libbacktrace could not find executable to open",
121 if (!backtrace_initialize (state, filename, 0, 1, error_callback, data,
128 if (!state->threaded)
129 state->fileline_initialization_failed = 1;
131 backtrace_atomic_store_int (&state->fileline_initialization_failed, 1);
135 if (!state->threaded)
136 state->fileline_fn = fileline_fn;
139 backtrace_atomic_store_pointer (&state->fileline_fn, fileline_fn);
141 /* Note that if two threads initialize at once, one of the data
142 sets may be leaked. */
148 /* Return the debug filename with dwarf debug information (or NULL if not found). */
151 backtrace_get_debug_filename (struct backtrace_state *state)
153 return state ? state->debug_filename : NULL;
156 /* Initialize the fileline information from a user specified filename. Returns 1
157 on success, 0 on failure. */
160 backtrace_fileline_initialize (struct backtrace_state *state, uintptr_t base_address, int is_exe,
161 backtrace_error_callback error_callback, void *data)
164 fileline fileline_fn;
166 if (!state->threaded)
167 failed = state->fileline_initialization_failed;
169 failed = backtrace_atomic_load_int (&state->fileline_initialization_failed);
173 error_callback (data, "failed to read executable information", -1);
177 if (!state->threaded)
178 fileline_fn = state->fileline_fn;
180 fileline_fn = backtrace_atomic_load_pointer (&state->fileline_fn);
181 if (fileline_fn != NULL)
184 /* We have not initialized information. Do it now. */
185 /* For this function, we need a filename and base address. */
187 if (!state->filename || !base_address)
189 error_callback (data, state->filename, ENOENT);
194 if (!backtrace_initialize (state, state->filename, base_address, is_exe,
195 error_callback, data, &fileline_fn))
201 if (!state->threaded)
202 state->fileline_initialization_failed = 1;
204 backtrace_atomic_store_int (&state->fileline_initialization_failed, 1);
208 if (!state->threaded)
209 state->fileline_fn = fileline_fn;
212 backtrace_atomic_store_pointer (&state->fileline_fn, fileline_fn);
214 /* Note that if two threads initialize at once, one of the data
215 sets may be leaked. */
220 /* Given a PC, find the file name, line number, and function name. */
223 backtrace_pcinfo (struct backtrace_state *state, uintptr_t pc,
224 backtrace_full_callback callback,
225 backtrace_error_callback error_callback, void *data)
227 if (!fileline_initialize (state, error_callback, data))
230 if (state->fileline_initialization_failed)
233 return state->fileline_fn (state, pc, callback, error_callback, data);
236 /* Given a PC, find the symbol for it, and its value. */
239 backtrace_syminfo (struct backtrace_state *state, uintptr_t pc,
240 backtrace_syminfo_callback callback,
241 backtrace_error_callback error_callback, void *data)
243 if (!fileline_initialize (state, error_callback, data))
246 if (state->fileline_initialization_failed)
249 state->syminfo_fn (state, pc, callback, error_callback, data);