1 /* fileline.c -- Get file and line number information in a backtrace.
2 Copyright (C) 2012-2023 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>
42 #if defined (HAVE_KERN_PROC_ARGS) || defined (HAVE_KERN_PROC)
43 #include <sys/sysctl.h>
46 #ifdef HAVE_MACH_O_DYLD_H
47 #include <mach-o/dyld.h>
50 #include "backtrace.h"
53 #ifndef HAVE_GETEXECNAME
54 #define getexecname() NULL
57 #if !defined (HAVE_KERN_PROC_ARGS) && !defined (HAVE_KERN_PROC)
59 #define sysctl_exec_name1(state, error_callback, data) NULL
60 #define sysctl_exec_name2(state, error_callback, data) NULL
62 #else /* defined (HAVE_KERN_PROC_ARGS) || |defined (HAVE_KERN_PROC) */
65 sysctl_exec_name (struct backtrace_state
*state
,
66 int mib0
, int mib1
, int mib2
, int mib3
,
67 backtrace_error_callback error_callback
, void *data
)
79 if (sysctl (mib
, 4, NULL
, &len
, NULL
, 0) < 0)
81 name
= (char *) backtrace_alloc (state
, len
, error_callback
, data
);
85 if (sysctl (mib
, 4, name
, &rlen
, NULL
, 0) < 0)
87 backtrace_free (state
, name
, len
, error_callback
, data
);
93 #ifdef HAVE_KERN_PROC_ARGS
96 sysctl_exec_name1 (struct backtrace_state
*state
,
97 backtrace_error_callback error_callback
, void *data
)
99 /* This variant is used on NetBSD. */
100 return sysctl_exec_name (state
, CTL_KERN
, KERN_PROC_ARGS
, -1,
101 KERN_PROC_PATHNAME
, error_callback
, data
);
106 #define sysctl_exec_name1(state, error_callback, data) NULL
110 #ifdef HAVE_KERN_PROC
113 sysctl_exec_name2 (struct backtrace_state
*state
,
114 backtrace_error_callback error_callback
, void *data
)
116 /* This variant is used on FreeBSD. */
117 return sysctl_exec_name (state
, CTL_KERN
, KERN_PROC
, KERN_PROC_PATHNAME
, -1,
118 error_callback
, data
);
123 #define sysctl_exec_name2(state, error_callback, data) NULL
127 #endif /* defined (HAVE_KERN_PROC_ARGS) || |defined (HAVE_KERN_PROC) */
129 #ifdef HAVE_MACH_O_DYLD_H
132 macho_get_executable_path (struct backtrace_state
*state
,
133 backtrace_error_callback error_callback
, void *data
)
139 if (_NSGetExecutablePath (NULL
, &len
) == 0)
141 name
= (char *) backtrace_alloc (state
, len
, error_callback
, data
);
144 if (_NSGetExecutablePath (name
, &len
) != 0)
146 backtrace_free (state
, name
, len
, error_callback
, data
);
152 #else /* !defined (HAVE_MACH_O_DYLD_H) */
154 #define macho_get_executable_path(state, error_callback, data) NULL
156 #endif /* !defined (HAVE_MACH_O_DYLD_H) */
158 #if HAVE_DECL__PGMPTR
160 #define windows_executable_filename() _pgmptr
162 #else /* !HAVE_DECL__PGMPTR */
164 #define windows_executable_filename() NULL
166 #endif /* !HAVE_DECL__PGMPTR */
168 /* Initialize the fileline information from the executable. Returns 1
169 on success, 0 on failure. */
172 fileline_initialize (struct backtrace_state
*state
,
173 backtrace_error_callback error_callback
, void *data
)
176 fileline fileline_fn
;
178 int called_error_callback
;
180 const char *filename
;
183 if (!state
->threaded
)
184 failed
= state
->fileline_initialization_failed
;
186 failed
= backtrace_atomic_load_int (&state
->fileline_initialization_failed
);
190 error_callback (data
, "failed to read executable information", -1);
194 if (!state
->threaded
)
195 fileline_fn
= state
->fileline_fn
;
197 fileline_fn
= backtrace_atomic_load_pointer (&state
->fileline_fn
);
198 if (fileline_fn
!= NULL
)
201 /* We have not initialized the information. Do it now. */
204 called_error_callback
= 0;
205 for (pass
= 0; pass
< 9; ++pass
)
212 filename
= state
->filename
;
215 filename
= getexecname ();
218 /* Test this before /proc/self/exe, as the latter exists but points
219 to the wine binary (and thus doesn't work). */
220 filename
= windows_executable_filename ();
223 filename
= "/proc/self/exe";
226 filename
= "/proc/curproc/file";
229 snprintf (buf
, sizeof (buf
), "/proc/%ld/object/a.out",
234 filename
= sysctl_exec_name1 (state
, error_callback
, data
);
237 filename
= sysctl_exec_name2 (state
, error_callback
, data
);
240 filename
= macho_get_executable_path (state
, error_callback
, data
);
246 if (filename
== NULL
)
249 descriptor
= backtrace_open (filename
, error_callback
, data
,
251 if (descriptor
< 0 && !does_not_exist
)
253 called_error_callback
= 1;
262 if (!called_error_callback
)
264 if (state
->filename
!= NULL
)
265 error_callback (data
, state
->filename
, ENOENT
);
267 error_callback (data
,
268 "libbacktrace could not find executable to open",
276 if (!backtrace_initialize (state
, filename
, descriptor
, error_callback
,
283 if (!state
->threaded
)
284 state
->fileline_initialization_failed
= 1;
286 backtrace_atomic_store_int (&state
->fileline_initialization_failed
, 1);
290 if (!state
->threaded
)
291 state
->fileline_fn
= fileline_fn
;
294 backtrace_atomic_store_pointer (&state
->fileline_fn
, fileline_fn
);
296 /* Note that if two threads initialize at once, one of the data
297 sets may be leaked. */
303 /* Given a PC, find the file name, line number, and function name. */
306 backtrace_pcinfo (struct backtrace_state
*state
, uintptr_t pc
,
307 backtrace_full_callback callback
,
308 backtrace_error_callback error_callback
, void *data
)
310 if (!fileline_initialize (state
, error_callback
, data
))
313 if (state
->fileline_initialization_failed
)
316 return state
->fileline_fn (state
, pc
, callback
, error_callback
, data
);
319 /* Given a PC, find the symbol for it, and its value. */
322 backtrace_syminfo (struct backtrace_state
*state
, uintptr_t pc
,
323 backtrace_syminfo_callback callback
,
324 backtrace_error_callback error_callback
, void *data
)
326 if (!fileline_initialize (state
, error_callback
, data
))
329 if (state
->fileline_initialization_failed
)
332 state
->syminfo_fn (state
, pc
, callback
, error_callback
, data
);
336 /* A backtrace_syminfo_callback that can call into a
337 backtrace_full_callback, used when we have a symbol table but no
341 backtrace_syminfo_to_full_callback (void *data
, uintptr_t pc
,
343 uintptr_t symval ATTRIBUTE_UNUSED
,
344 uintptr_t symsize ATTRIBUTE_UNUSED
)
346 struct backtrace_call_full
*bdata
= (struct backtrace_call_full
*) data
;
348 bdata
->ret
= bdata
->full_callback (bdata
->full_data
, pc
, NULL
, 0, symname
);
351 /* An error callback that corresponds to
352 backtrace_syminfo_to_full_callback. */
355 backtrace_syminfo_to_full_error_callback (void *data
, const char *msg
,
358 struct backtrace_call_full
*bdata
= (struct backtrace_call_full
*) data
;
360 bdata
->full_error_callback (bdata
->full_data
, msg
, errnum
);