Branch data Line data Source code
1 : : /* Internal definitions for libdwfl.
2 : : Copyright (C) 2005-2015, 2018, 2024 Red Hat, Inc.
3 : : This file is part of elfutils.
4 : :
5 : : This file is free software; you can redistribute it and/or modify
6 : : it under the terms of either
7 : :
8 : : * the GNU Lesser General Public License as published by the Free
9 : : Software Foundation; either version 3 of the License, or (at
10 : : your option) any later version
11 : :
12 : : or
13 : :
14 : : * the GNU General Public License as published by the Free
15 : : Software Foundation; either version 2 of the License, or (at
16 : : your option) any later version
17 : :
18 : : or both in parallel, as here.
19 : :
20 : : elfutils is distributed in the hope that it will be useful, but
21 : : WITHOUT ANY WARRANTY; without even the implied warranty of
22 : : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 : : General Public License for more details.
24 : :
25 : : You should have received copies of the GNU General Public License and
26 : : the GNU Lesser General Public License along with this program. If
27 : : not, see <http://www.gnu.org/licenses/>. */
28 : :
29 : : #ifndef _LIBDWFLP_H
30 : : #define _LIBDWFLP_H 1
31 : :
32 : : #include <libdwfl.h>
33 : : #include <libebl.h>
34 : : #include <assert.h>
35 : : #include <dirent.h>
36 : : #include <errno.h>
37 : : #include <stdbool.h>
38 : : #include <stdlib.h>
39 : : #include <string.h>
40 : :
41 : : #include "libdwP.h" /* We need its INTDECLs. */
42 : : #include "libdwelfP.h"
43 : : #include "eu-search.h"
44 : :
45 : : typedef struct Dwfl_Process Dwfl_Process;
46 : :
47 : : #define DWFL_ERRORS \
48 : : DWFL_ERROR (NOERROR, N_("no error")) \
49 : : DWFL_ERROR (UNKNOWN_ERROR, N_("unknown error")) \
50 : : DWFL_ERROR (NOMEM, N_("out of memory")) \
51 : : DWFL_ERROR (ERRNO, N_("See errno")) \
52 : : DWFL_ERROR (LIBELF, N_("See elf_errno")) \
53 : : DWFL_ERROR (LIBDW, N_("See dwarf_errno")) \
54 : : DWFL_ERROR (LIBEBL, N_("See ebl_errno (XXX missing)")) \
55 : : DWFL_ERROR (ZLIB, N_("gzip decompression failed")) \
56 : : DWFL_ERROR (BZLIB, N_("bzip2 decompression failed")) \
57 : : DWFL_ERROR (LZMA, N_("LZMA decompression failed")) \
58 : : DWFL_ERROR (ZSTD, N_("zstd decompression failed")) \
59 : : DWFL_ERROR (UNKNOWN_MACHINE, N_("no support library found for machine")) \
60 : : DWFL_ERROR (NOREL, N_("Callbacks missing for ET_REL file")) \
61 : : DWFL_ERROR (BADRELTYPE, N_("Unsupported relocation type")) \
62 : : DWFL_ERROR (BADRELOFF, N_("r_offset is bogus")) \
63 : : DWFL_ERROR (BADSTROFF, N_("offset out of range")) \
64 : : DWFL_ERROR (RELUNDEF, N_("relocation refers to undefined symbol")) \
65 : : DWFL_ERROR (CB, N_("Callback returned failure")) \
66 : : DWFL_ERROR (NO_DWARF, N_("No DWARF information found")) \
67 : : DWFL_ERROR (NO_SYMTAB, N_("No symbol table found")) \
68 : : DWFL_ERROR (NO_PHDR, N_("No ELF program headers")) \
69 : : DWFL_ERROR (OVERLAP, N_("address range overlaps an existing module")) \
70 : : DWFL_ERROR (ADDR_OUTOFRANGE, N_("address out of range")) \
71 : : DWFL_ERROR (NO_MATCH, N_("no matching address range")) \
72 : : DWFL_ERROR (TRUNCATED, N_("image truncated")) \
73 : : DWFL_ERROR (ALREADY_ELF, N_("ELF file opened")) \
74 : : DWFL_ERROR (BADELF, N_("not a valid ELF file")) \
75 : : DWFL_ERROR (WEIRD_TYPE, N_("cannot handle DWARF type description")) \
76 : : DWFL_ERROR (WRONG_ID_ELF, N_("ELF file does not match build ID")) \
77 : : DWFL_ERROR (BAD_PRELINK, N_("corrupt .gnu.prelink_undo section data")) \
78 : : DWFL_ERROR (LIBEBL_BAD, N_("Internal error due to ebl")) \
79 : : DWFL_ERROR (CORE_MISSING, N_("Missing data in core file")) \
80 : : DWFL_ERROR (INVALID_REGISTER, N_("Invalid register")) \
81 : : DWFL_ERROR (REGISTER_VAL_UNKNOWN, N_("Unknown register value")) \
82 : : DWFL_ERROR (PROCESS_MEMORY_READ, N_("Error reading process memory")) \
83 : : DWFL_ERROR (PROCESS_NO_ARCH, N_("Couldn't find architecture of any ELF")) \
84 : : DWFL_ERROR (PARSE_PROC, N_("Error parsing /proc filesystem")) \
85 : : DWFL_ERROR (INVALID_DWARF, N_("Invalid DWARF")) \
86 : : DWFL_ERROR (UNSUPPORTED_DWARF, N_("Unsupported DWARF")) \
87 : : DWFL_ERROR (NEXT_THREAD_FAIL, N_("Unable to find more threads")) \
88 : : DWFL_ERROR (ATTACH_STATE_CONFLICT, N_("Dwfl already has attached state")) \
89 : : DWFL_ERROR (NO_ATTACH_STATE, N_("Dwfl has no attached state")) \
90 : : DWFL_ERROR (NO_UNWIND, N_("Unwinding not supported for this architecture")) \
91 : : DWFL_ERROR (INVALID_ARGUMENT, N_("Invalid argument")) \
92 : : DWFL_ERROR (NO_CORE_FILE, N_("Not an ET_CORE ELF file"))
93 : :
94 : : #define DWFL_ERROR(name, text) DWFL_E_##name,
95 : : typedef enum { DWFL_ERRORS DWFL_E_NUM } Dwfl_Error;
96 : : #undef DWFL_ERROR
97 : :
98 : : #define OTHER_ERROR(name) ((unsigned int) DWFL_E_##name << 16)
99 : : #define DWFL_E(name, errno) (OTHER_ERROR (name) | (errno))
100 : :
101 : : extern int __libdwfl_canon_error (Dwfl_Error) internal_function;
102 : : extern void __libdwfl_seterrno (Dwfl_Error) internal_function;
103 : :
104 : : /* Resources we might keep for the user about the core file that the
105 : : Dwfl might have been created from. Can currently only be set
106 : : through std-argp. */
107 : : struct Dwfl_User_Core
108 : : {
109 : : char *executable_for_core; /* --executable if --core was specified. */
110 : : Elf *core; /* non-NULL if we need to free it. */
111 : : int fd; /* close if >= 0. */
112 : : };
113 : :
114 : : struct Dwfl
115 : : {
116 : : const Dwfl_Callbacks *callbacks;
117 : : #ifdef ENABLE_LIBDEBUGINFOD
118 : : debuginfod_client *debuginfod;
119 : : #endif
120 : : Dwfl_Module *modulelist; /* List in order used by full traversals. */
121 : :
122 : : Dwfl_Process *process;
123 : : Dwfl_Error attacherr; /* Previous error attaching process. */
124 : :
125 : : GElf_Addr offline_next_address;
126 : :
127 : : GElf_Addr segment_align; /* Smallest granularity of segments. */
128 : :
129 : : /* Binary search table in three parallel malloc'd arrays. */
130 : : size_t lookup_elts; /* Elements in use. */
131 : : size_t lookup_alloc; /* Elements allococated. */
132 : : GElf_Addr *lookup_addr; /* Start address of segment. */
133 : : Dwfl_Module **lookup_module; /* Module associated with segment, or null. */
134 : : int *lookup_segndx; /* User segment index, or -1. */
135 : : int next_segndx;
136 : :
137 : : struct Dwfl_User_Core *user_core;
138 : : char *sysroot; /* sysroot, or NULL to search standard system
139 : : paths */
140 : : };
141 : :
142 : : #define OFFLINE_REDZONE 0x10000
143 : :
144 : : struct dwfl_file
145 : : {
146 : : char *name;
147 : : int fd;
148 : : bool valid; /* The build ID note has been matched. */
149 : : bool relocated; /* Partial relocation of all sections done. */
150 : :
151 : : Elf *elf;
152 : :
153 : : /* This is the lowest p_vaddr in this ELF file, aligned to p_align.
154 : : For a file without phdrs, this is zero. */
155 : : GElf_Addr vaddr;
156 : :
157 : : /* This is an address chosen for synchronization between the main file
158 : : and the debug file. See dwfl_module_getdwarf.c for how it's chosen. */
159 : : GElf_Addr address_sync;
160 : : };
161 : :
162 : : struct Dwfl_Module
163 : : {
164 : : Dwfl *dwfl;
165 : : struct Dwfl_Module *next; /* Link on Dwfl.modulelist. */
166 : :
167 : : void *userdata;
168 : :
169 : : char *name; /* Iterator name for this module. */
170 : : GElf_Addr low_addr, high_addr;
171 : :
172 : : struct dwfl_file main, debug, aux_sym;
173 : : GElf_Addr main_bias;
174 : : Ebl *ebl;
175 : : GElf_Half e_type; /* GElf_Ehdr.e_type cache. */
176 : : Dwfl_Error elferr; /* Previous failure to open main file. */
177 : :
178 : : struct dwfl_relocation *reloc_info; /* Relocatable sections. */
179 : :
180 : : struct dwfl_file *symfile; /* Either main or debug. */
181 : : Elf_Data *symdata; /* Data in the ELF symbol table section. */
182 : : Elf_Data *aux_symdata; /* Data in the auxiliary ELF symbol table. */
183 : : size_t syments; /* sh_size / sh_entsize of that section. */
184 : : size_t aux_syments; /* sh_size / sh_entsize of aux_sym section. */
185 : : int first_global; /* Index of first global symbol of table. */
186 : : int aux_first_global; /* Index of first global of aux_sym table. */
187 : : Elf_Data *symstrdata; /* Data for its string table. */
188 : : Elf_Data *aux_symstrdata; /* Data for aux_sym string table. */
189 : : Elf_Data *symxndxdata; /* Data in the extended section index table. */
190 : : Elf_Data *aux_symxndxdata; /* Data in the extended auxiliary table. */
191 : :
192 : : char *elfpath; /* The path where we found the main Elf. */
193 : :
194 : : Dwarf *dw; /* libdw handle for its debugging info. */
195 : : Dwarf *alt; /* Dwarf used for dwarf_setalt, or NULL. */
196 : : int alt_fd; /* descriptor, only valid when alt != NULL. */
197 : : Elf *alt_elf; /* Elf for alt Dwarf. */
198 : :
199 : : Dwfl_Error symerr; /* Previous failure to load symbols. */
200 : : Dwfl_Error dwerr; /* Previous failure to load DWARF. */
201 : :
202 : : /* Known CU's in this module. */
203 : : struct dwfl_cu *first_cu, **cu;
204 : :
205 : : search_tree lazy_cu_tree; /* Table indexed by Dwarf_Off of CU. */
206 : :
207 : : struct dwfl_arange *aranges; /* Mapping of addresses in module to CUs. */
208 : :
209 : : void *build_id_bits; /* malloc'd copy of build ID bits. */
210 : : GElf_Addr build_id_vaddr; /* Address where they reside, 0 if unknown. */
211 : : int build_id_len; /* -1 for prior failure, 0 if unset. */
212 : :
213 : : unsigned int ncu;
214 : : unsigned int lazycu; /* Possible users, deleted when none left. */
215 : : unsigned int naranges;
216 : :
217 : : Dwarf_CFI *dwarf_cfi; /* Cached DWARF CFI for this module. */
218 : : Dwarf_CFI *eh_cfi; /* Cached EH CFI for this module. */
219 : :
220 : : int segment; /* Index of first segment table entry. */
221 : : bool gc; /* Mark/sweep flag. */
222 : : bool is_executable; /* Use Dwfl::executable_for_core? */
223 : : };
224 : :
225 : : /* This holds information common for all the threads/tasks/TIDs of one process
226 : : for backtraces. */
227 : :
228 : : struct Dwfl_Process
229 : : {
230 : : struct Dwfl *dwfl;
231 : : pid_t pid;
232 : : const Dwfl_Thread_Callbacks *callbacks;
233 : : void *callbacks_arg;
234 : : struct ebl *ebl;
235 : : bool ebl_close:1;
236 : : };
237 : :
238 : : /* See its typedef in libdwfl.h. */
239 : :
240 : : struct Dwfl_Thread
241 : : {
242 : : Dwfl_Process *process;
243 : : pid_t tid;
244 : : /* Bottom (innermost) frame while we're initializing, NULL afterwards. */
245 : : Dwfl_Frame *unwound;
246 : : void *callbacks_arg;
247 : :
248 : : /* Data for handling AARCH64 (currently limited to demangling PAC from
249 : : return addresses). */
250 : : struct {
251 : : Dwarf_Addr pauth_insn_mask;
252 : : } aarch64;
253 : : };
254 : :
255 : : /* See its typedef in libdwfl.h. */
256 : :
257 : : struct Dwfl_Frame
258 : : {
259 : : Dwfl_Thread *thread;
260 : : /* Previous (outer) frame. */
261 : : Dwfl_Frame *unwound;
262 : : bool signal_frame : 1;
263 : : bool initial_frame : 1;
264 : : enum
265 : : {
266 : : /* This structure is still being initialized or there was an error
267 : : initializing it. */
268 : : DWFL_FRAME_STATE_ERROR,
269 : : /* PC field is valid. */
270 : : DWFL_FRAME_STATE_PC_SET,
271 : : /* PC field is undefined, this means the next (inner) frame was the
272 : : outermost frame. */
273 : : DWFL_FRAME_STATE_PC_UNDEFINED
274 : : } pc_state;
275 : : Dwfl_Unwound_Source unwound_source;
276 : : /* Either initialized from appropriate REGS element or on some archs
277 : : initialized separately as the return address has no DWARF register. */
278 : : Dwarf_Addr pc;
279 : : /* (1 << X) bitmask where 0 <= X < ebl_frame_nregs. */
280 : : uint64_t regs_set[3];
281 : : /* REGS array size is ebl_frame_nregs.
282 : : REGS_SET tells which of the REGS are valid. */
283 : : Dwarf_Addr regs[];
284 : : };
285 : :
286 : : /* Fetch value from Dwfl_Frame->regs indexed by DWARF REGNO. The
287 : : function returns 0 on success, -1 on error (invalid DWARF register
288 : : number), 1 if the value of the register in the frame is unknown.
289 : : Even on error, no error code is set. */
290 : : int __libdwfl_frame_reg_get (Dwfl_Frame *state, unsigned regno,
291 : : Dwarf_Addr *val)
292 : : internal_function;
293 : :
294 : : /* Store value to Dwfl_Frame->regs indexed by DWARF REGNO.
295 : : No error code is set if the function returns FALSE. */
296 : : bool __libdwfl_frame_reg_set (Dwfl_Frame *state, unsigned regno,
297 : : Dwarf_Addr val)
298 : : internal_function;
299 : :
300 : : /* Information cached about each CU in Dwfl_Module.dw. */
301 : : struct dwfl_cu
302 : : {
303 : : /* This caches libdw information about the CU. It's also the
304 : : address passed back to users, so we take advantage of the
305 : : fact that it's placed first to cast back. */
306 : : Dwarf_Die die;
307 : :
308 : : Dwfl_Module *mod; /* Pointer back to containing module. */
309 : :
310 : : struct dwfl_cu *next; /* CU immediately following in the file. */
311 : :
312 : : struct Dwfl_Lines *lines;
313 : : };
314 : :
315 : : struct Dwfl_Lines
316 : : {
317 : : struct dwfl_cu *cu;
318 : :
319 : : /* This is what the opaque Dwfl_Line * pointers we pass to users are.
320 : : We need to recover pointers to our struct dwfl_cu and a record in
321 : : libdw's Dwarf_Line table. To minimize the memory used in addition
322 : : to libdw's Dwarf_Lines buffer, we just point to our own index in
323 : : this table, and have one pointer back to the CU. The indices here
324 : : match those in libdw's Dwarf_CU.lines->info table. */
325 : : struct Dwfl_Line
326 : : {
327 : : unsigned int idx; /* My index in the dwfl_cu.lines table. */
328 : : } idx[0];
329 : : };
330 : :
331 : : static inline struct dwfl_cu *
332 : 2502068 : dwfl_linecu_inline (const Dwfl_Line *line)
333 : : {
334 [ + + - - : 2500806 : const struct Dwfl_Lines *lines = ((const void *) line
- - + + +
+ + - ]
335 : 2502068 : - offsetof (struct Dwfl_Lines,
336 : : idx[line->idx]));
337 [ + + ]: 2500806 : return lines->cu;
338 : : }
339 : : #define dwfl_linecu dwfl_linecu_inline
340 : :
341 : : static inline GElf_Addr
342 : 34400966 : dwfl_adjusted_address (Dwfl_Module *mod, GElf_Addr addr)
343 : : {
344 [ # # ]: 34400966 : return addr + mod->main_bias;
345 : : }
346 : :
347 : : static inline GElf_Addr
348 : 200956 : dwfl_deadjust_address (Dwfl_Module *mod, GElf_Addr addr)
349 : : {
350 : 200956 : return addr - mod->main_bias;
351 : : }
352 : :
353 : : static inline Dwarf_Addr
354 : 1682580 : dwfl_adjusted_dwarf_addr (Dwfl_Module *mod, Dwarf_Addr addr)
355 : : {
356 : 1682580 : return dwfl_adjusted_address (mod, (addr
357 : 1682580 : - mod->debug.address_sync
358 : 1682580 : + mod->main.address_sync));
359 : : }
360 : :
361 : : static inline Dwarf_Addr
362 : 904 : dwfl_deadjust_dwarf_addr (Dwfl_Module *mod, Dwarf_Addr addr)
363 : : {
364 : 904 : return (dwfl_deadjust_address (mod, addr)
365 : 904 : - mod->main.address_sync
366 : 904 : + mod->debug.address_sync);
367 : : }
368 : :
369 : : static inline Dwarf_Addr
370 : 44470 : dwfl_adjusted_aux_sym_addr (Dwfl_Module *mod, Dwarf_Addr addr)
371 : : {
372 : 44470 : return dwfl_adjusted_address (mod, (addr
373 : 44470 : - mod->aux_sym.address_sync
374 : 44470 : + mod->main.address_sync));
375 : : }
376 : :
377 : : static inline Dwarf_Addr
378 : 0 : dwfl_deadjust_aux_sym_addr (Dwfl_Module *mod, Dwarf_Addr addr)
379 : : {
380 : 0 : return (dwfl_deadjust_address (mod, addr)
381 : 0 : - mod->main.address_sync
382 : 0 : + mod->aux_sym.address_sync);
383 : : }
384 : :
385 : : static inline GElf_Addr
386 : 33024794 : dwfl_adjusted_st_value (Dwfl_Module *mod, Elf *symelf, GElf_Addr addr)
387 : : {
388 [ + + ]: 33024794 : if (symelf == mod->main.elf)
389 : 32588556 : return dwfl_adjusted_address (mod, addr);
390 [ + + ]: 436238 : if (symelf == mod->debug.elf)
391 : 391768 : return dwfl_adjusted_dwarf_addr (mod, addr);
392 : 44470 : return dwfl_adjusted_aux_sym_addr (mod, addr);
393 : : }
394 : :
395 : : static inline GElf_Addr
396 : 200052 : dwfl_deadjust_st_value (Dwfl_Module *mod, Elf *symelf, GElf_Addr addr)
397 : : {
398 [ + - ]: 200052 : if (symelf == mod->main.elf)
399 : 200052 : return dwfl_deadjust_address (mod, addr);
400 [ # # ]: 0 : if (symelf == mod->debug.elf)
401 : 0 : return dwfl_deadjust_dwarf_addr (mod, addr);
402 : 0 : return dwfl_deadjust_aux_sym_addr (mod, addr);
403 : : }
404 : :
405 : : /* This describes a contiguous address range that lies in a single CU.
406 : : We condense runs of Dwarf_Arange entries for the same CU into this. */
407 : : struct dwfl_arange
408 : : {
409 : : struct dwfl_cu *cu;
410 : : size_t arange; /* Index in Dwarf_Aranges. */
411 : : };
412 : :
413 : : #define __LIBDWFL_REMOTE_MEM_CACHE_SIZE 4096
414 : : /* Structure for caching remote memory reads as used by __libdwfl_pid_arg. */
415 : : struct __libdwfl_remote_mem_cache
416 : : {
417 : : Dwarf_Addr addr; /* Remote address. */
418 : : Dwarf_Off len; /* Zero if cleared, otherwise likely 4K. */
419 : : unsigned char buf[__LIBDWFL_REMOTE_MEM_CACHE_SIZE]; /* The actual cache. */
420 : : };
421 : :
422 : : /* Structure used for keeping track of ptrace attaching a thread.
423 : : Shared by linux-pid-attach and linux-proc-maps. If it has been setup
424 : : then get the instance through __libdwfl_get_pid_arg. */
425 : : struct __libdwfl_pid_arg
426 : : {
427 : : /* /proc/PID/task/. */
428 : : DIR *dir;
429 : : /* Elf for /proc/PID/exe. Set to NULL if it couldn't be opened. */
430 : : Elf *elf;
431 : : /* Remote memory cache, NULL if there is no memory cached.
432 : : Should be cleared on detachment (because that makes the thread
433 : : runnable and the cache invalid). */
434 : : struct __libdwfl_remote_mem_cache *mem_cache;
435 : : /* fd for /proc/PID/exe. Set to -1 if it couldn't be opened. */
436 : : int elf_fd;
437 : : /* It is 0 if not used. */
438 : : pid_t tid_attached;
439 : : /* Valid only if TID_ATTACHED is not zero. */
440 : : bool tid_was_stopped;
441 : : /* True if threads are ptrace stopped by caller. */
442 : : bool assume_ptrace_stopped;
443 : : };
444 : :
445 : : /* If DWfl is not NULL and a Dwfl_Process has been setup that has
446 : : Dwfl_Thread_Callbacks set to pid_thread_callbacks, then return the
447 : : callbacks_arg, which will be a struct __libdwfl_pid_arg. Otherwise
448 : : returns NULL. */
449 : : extern struct __libdwfl_pid_arg *__libdwfl_get_pid_arg (Dwfl *dwfl)
450 : : internal_function;
451 : :
452 : : /* Makes sure the given tid is attached. On success returns true and
453 : : sets tid_was_stopped. */
454 : : extern bool __libdwfl_ptrace_attach (pid_t tid, bool *tid_was_stoppedp)
455 : : internal_function;
456 : :
457 : : /* Detaches a tid that was attached through
458 : : __libdwfl_ptrace_attach. Must be given the tid_was_stopped as set
459 : : by __libdwfl_ptrace_attach. */
460 : : extern void __libdwfl_ptrace_detach (pid_t tid, bool tid_was_stopped)
461 : : internal_function;
462 : :
463 : :
464 : : /* Internal wrapper for old dwfl_module_getsym and new dwfl_module_getsym_info.
465 : : adjust_st_value set to true returns adjusted SYM st_value, set to false
466 : : it will not adjust SYM at all, but does match against resolved *ADDR. */
467 : : extern const char *__libdwfl_getsym (Dwfl_Module *mod, int ndx, GElf_Sym *sym,
468 : : GElf_Addr *addr, GElf_Word *shndxp,
469 : : Elf **elfp, Dwarf_Addr *biasp,
470 : : bool *resolved, bool adjust_st_value)
471 : : internal_function;
472 : :
473 : : extern void __libdwfl_module_free (Dwfl_Module *mod) internal_function;
474 : :
475 : : /* Find the main ELF file, update MOD->elferr and/or MOD->main.elf. */
476 : : extern void __libdwfl_getelf (Dwfl_Module *mod) internal_function;
477 : :
478 : : /* Process relocations in debugging sections in an ET_REL file.
479 : : FILE must be opened with ELF_C_READ_MMAP_PRIVATE or ELF_C_READ,
480 : : to make it possible to relocate the data in place (or ELF_C_RDWR or
481 : : ELF_C_RDWR_MMAP if you intend to modify the Elf file on disk). After
482 : : this, dwarf_begin_elf on FILE will read the relocated data.
483 : :
484 : : When DEBUG is false, apply partial relocation to all sections. */
485 : : extern Dwfl_Error __libdwfl_relocate (Dwfl_Module *mod, Elf *file, bool debug)
486 : : internal_function;
487 : :
488 : : /* Find the section index in mod->main.elf that contains the given
489 : : *ADDR. Adjusts *ADDR to be section relative on success, returns
490 : : SHN_UNDEF on failure. */
491 : : extern size_t __libdwfl_find_section_ndx (Dwfl_Module *mod, Dwarf_Addr *addr)
492 : : internal_function;
493 : :
494 : : /* Process (simple) relocations in arbitrary section TSCN of an ET_REL file.
495 : : RELOCSCN is SHT_REL or SHT_RELA and TSCN is its sh_info target section. */
496 : : extern Dwfl_Error __libdwfl_relocate_section (Dwfl_Module *mod, Elf *relocated,
497 : : Elf_Scn *relocscn, Elf_Scn *tscn,
498 : : bool partial)
499 : : internal_function;
500 : :
501 : : /* Adjust *VALUE from section-relative to absolute.
502 : : MOD->dwfl->callbacks->section_address is called to determine the actual
503 : : address of a loaded section. */
504 : : extern Dwfl_Error __libdwfl_relocate_value (Dwfl_Module *mod, Elf *elf,
505 : : size_t *shstrndx_cache,
506 : : Elf32_Word shndx,
507 : : GElf_Addr *value)
508 : : internal_function;
509 : :
510 : : /* Ensure that MOD->ebl is set up. */
511 : : extern Dwfl_Error __libdwfl_module_getebl (Dwfl_Module *mod) internal_function;
512 : :
513 : : /* Install a new Dwarf_CFI in *SLOT (MOD->eh_cfi or MOD->dwarf_cfi). */
514 : : extern Dwarf_CFI *__libdwfl_set_cfi (Dwfl_Module *mod, Dwarf_CFI **slot,
515 : : Dwarf_CFI *cfi)
516 : : internal_function;
517 : :
518 : : /* Iterate through all the CU's in the module. Start by passing a null
519 : : LASTCU, and then pass the last *CU returned. Success return with null
520 : : *CU no more CUs. */
521 : : extern Dwfl_Error __libdwfl_nextcu (Dwfl_Module *mod, struct dwfl_cu *lastcu,
522 : : struct dwfl_cu **cu) internal_function;
523 : :
524 : : /* Find the CU by address. */
525 : : extern Dwfl_Error __libdwfl_addrcu (Dwfl_Module *mod, Dwarf_Addr addr,
526 : : struct dwfl_cu **cu) internal_function;
527 : :
528 : : /* Ensure that CU->lines (and CU->cu->lines) is set up. */
529 : : extern Dwfl_Error __libdwfl_cu_getsrclines (struct dwfl_cu *cu)
530 : : internal_function;
531 : :
532 : : /* Look in ELF for an NT_GNU_BUILD_ID note. Store it to BUILD_ID_BITS,
533 : : its vaddr in ELF to BUILD_ID_VADDR (it is unrelocated, even if MOD is not
534 : : NULL) and store length to BUILD_ID_LEN. Returns -1 for errors, 1 if it was
535 : : stored and 0 if no note is found. MOD may be NULL, MOD must be non-NULL
536 : : only if ELF is ET_REL. */
537 : : extern int __libdwfl_find_elf_build_id (Dwfl_Module *mod, Elf *elf,
538 : : const void **build_id_bits,
539 : : GElf_Addr *build_id_elfaddr,
540 : : int *build_id_len)
541 : : internal_function;
542 : :
543 : : /* Look in ELF for an NT_GNU_BUILD_ID note. If SET is true, store it
544 : : in MOD and return its length. If SET is false, instead compare it
545 : : to that stored in MOD and return 2 if they match, 1 if they do not.
546 : : Returns -1 for errors, 0 if no note is found. */
547 : : extern int __libdwfl_find_build_id (Dwfl_Module *mod, bool set, Elf *elf)
548 : : internal_function;
549 : :
550 : : /* Open a main or debuginfo file by its build ID, returns the fd. */
551 : : extern int __libdwfl_open_mod_by_build_id (Dwfl_Module *mod, bool debug,
552 : : char **file_name) internal_function;
553 : :
554 : : /* Same, but takes an explicit build_id, can also be used for alt debug. */
555 : : extern int __libdwfl_open_by_build_id (Dwfl_Module *mod, bool debug,
556 : : char **file_name, const size_t id_len,
557 : : const uint8_t *id) internal_function;
558 : :
559 : : extern uint32_t __libdwfl_crc32 (uint32_t crc, unsigned char *buf, size_t len)
560 : : attribute_hidden;
561 : : extern int __libdwfl_crc32_file (int fd, uint32_t *resp) attribute_hidden;
562 : :
563 : :
564 : : /* Given ELF and some parameters return TRUE if the *P return value parameters
565 : : have been successfully filled in. Any of the *P parameters can be NULL. */
566 : : extern bool __libdwfl_elf_address_range (Elf *elf, GElf_Addr base,
567 : : bool add_p_vaddr, bool sanity,
568 : : GElf_Addr *vaddrp,
569 : : GElf_Addr *address_syncp,
570 : : GElf_Addr *startp, GElf_Addr *endp,
571 : : GElf_Addr *biasp, GElf_Half *e_typep)
572 : : internal_function;
573 : :
574 : : /* Meat of dwfl_report_elf, given elf_begin just called.
575 : : Consumes ELF on success, not on failure. */
576 : : extern Dwfl_Module *__libdwfl_report_elf (Dwfl *dwfl, const char *name,
577 : : const char *file_name, int fd,
578 : : Elf *elf, GElf_Addr base,
579 : : bool add_p_vaddr, bool sanity)
580 : : internal_function;
581 : :
582 : : /* Meat of dwfl_report_offline. */
583 : : extern Dwfl_Module *__libdwfl_report_offline (Dwfl *dwfl, const char *name,
584 : : const char *file_name,
585 : : int fd, bool closefd,
586 : : int (*predicate) (const char *,
587 : : const char *))
588 : : internal_function;
589 : :
590 : : /* Free PROCESS. Unlink and free also any structures it references. */
591 : : extern void __libdwfl_process_free (Dwfl_Process *process)
592 : : internal_function;
593 : :
594 : : /* Update STATE->unwound for the unwound frame.
595 : : On error STATE->unwound == NULL
596 : : or STATE->unwound->pc_state == DWFL_FRAME_STATE_ERROR;
597 : : in such case dwfl_errno () is set.
598 : : If STATE->unwound->pc_state == DWFL_FRAME_STATE_PC_UNDEFINED
599 : : then STATE was the last valid frame. */
600 : : extern void __libdwfl_frame_unwind (Dwfl_Frame *state)
601 : : internal_function;
602 : :
603 : : /* Align segment START downwards or END upwards addresses according to DWFL. */
604 : : extern GElf_Addr __libdwfl_segment_start (Dwfl *dwfl, GElf_Addr start)
605 : : internal_function;
606 : : extern GElf_Addr __libdwfl_segment_end (Dwfl *dwfl, GElf_Addr end)
607 : : internal_function;
608 : :
609 : : /* Decompression wrappers: decompress whole file into memory. */
610 : : extern Dwfl_Error __libdw_gunzip (int fd, off_t start_offset,
611 : : void *mapped, size_t mapped_size,
612 : : void **whole, size_t *whole_size)
613 : : internal_function;
614 : : extern Dwfl_Error __libdw_bunzip2 (int fd, off_t start_offset,
615 : : void *mapped, size_t mapped_size,
616 : : void **whole, size_t *whole_size)
617 : : internal_function;
618 : : extern Dwfl_Error __libdw_unlzma (int fd, off_t start_offset,
619 : : void *mapped, size_t mapped_size,
620 : : void **whole, size_t *whole_size)
621 : : internal_function;
622 : : extern Dwfl_Error __libdw_unzstd (int fd, off_t start_offset,
623 : : void *mapped, size_t mapped_size,
624 : : void **whole, size_t *whole_size)
625 : : internal_function;
626 : :
627 : : /* Skip the image header before a file image: updates *START_OFFSET. */
628 : : extern Dwfl_Error __libdw_image_header (int fd, off_t *start_offset,
629 : : void *mapped, size_t mapped_size)
630 : : internal_function;
631 : :
632 : : /* Open Elf handle on *FDP. This handles decompression and checks
633 : : elf_kind. Succeed only for ELF_K_ELF, or also ELF_K_AR if ARCHIVE_OK.
634 : : Returns DWFL_E_NOERROR and sets *ELFP on success, resets *FDP to -1 if
635 : : it's no longer used. Resets *FDP on failure too iff CLOSE_ON_FAIL. */
636 : : extern Dwfl_Error __libdw_open_file (int *fdp, Elf **elfp,
637 : : bool close_on_fail, bool archive_ok)
638 : : internal_function;
639 : :
640 : : /* Same as __libdw_open_file, but opens Elf handle from memory region. */
641 : : extern Dwfl_Error __libdw_open_elf_memory (char *data, size_t size, Elf **elfp,
642 : : bool archive_ok)
643 : : internal_function;
644 : :
645 : : /* Same as __libdw_open_file, but never closes the given file
646 : : descriptor and ELF_K_AR is always an acceptable type. */
647 : : extern Dwfl_Error __libdw_open_elf (int fd, Elf **elfp) internal_function;
648 : :
649 : : /* Fetch PT_DYNAMIC P_VADDR from ELF and store it to *VADDRP. Return success.
650 : : *VADDRP is not modified if the function fails. */
651 : : extern bool __libdwfl_dynamic_vaddr_get (Elf *elf, GElf_Addr *vaddrp)
652 : : internal_function;
653 : :
654 : : #ifdef ENABLE_LIBDEBUGINFOD
655 : : /* Internal interface to libdebuginfod (if installed). */
656 : : int
657 : : __libdwfl_debuginfod_find_executable (Dwfl *dwfl,
658 : : const unsigned char *build_id_bits,
659 : : size_t build_id_len);
660 : : int
661 : : __libdwfl_debuginfod_find_debuginfo (Dwfl *dwfl,
662 : : const unsigned char *build_id_bits,
663 : : size_t build_id_len);
664 : : void
665 : : __libdwfl_debuginfod_end (debuginfod_client *c);
666 : : #endif
667 : :
668 : :
669 : : /* These are working nicely for --core, but are not ready to be
670 : : exported interfaces quite yet. */
671 : :
672 : : /* Type of callback function ...
673 : : */
674 : : typedef bool Dwfl_Memory_Callback (Dwfl *dwfl, int segndx,
675 : : void **buffer, size_t *buffer_available,
676 : : GElf_Addr vaddr, size_t minread, void *arg);
677 : :
678 : : /* Type of callback function ...
679 : : */
680 : : typedef bool Dwfl_Module_Callback (Dwfl_Module *mod, void **userdata,
681 : : const char *name, Dwarf_Addr base,
682 : : void **buffer, size_t *buffer_available,
683 : : GElf_Off cost, GElf_Off worthwhile,
684 : : GElf_Off whole, GElf_Off contiguous,
685 : : void *arg, Elf **elfp);
686 : :
687 : : /* One shared library (or executable) info from DT_DEBUG link map. */
688 : : struct r_debug_info_module
689 : : {
690 : : struct r_debug_info_module *next;
691 : : /* FD is -1 iff ELF is NULL. */
692 : : int fd;
693 : : Elf *elf;
694 : : GElf_Addr l_ld;
695 : : /* START and END are both zero if not valid. */
696 : : GElf_Addr start, end;
697 : : bool disk_file_has_build_id;
698 : : char name[0];
699 : : };
700 : :
701 : : /* Information gathered from DT_DEBUG by dwfl_link_map_report hinted to
702 : : dwfl_segment_report_module. */
703 : : struct r_debug_info
704 : : {
705 : : struct r_debug_info_module *module;
706 : : };
707 : :
708 : : /* ...
709 : : */
710 : : extern int dwfl_segment_report_module (Dwfl *dwfl, int ndx, const char *name,
711 : : const char *executable,
712 : : Dwfl_Memory_Callback *memory_callback,
713 : : void *memory_callback_arg,
714 : : Dwfl_Module_Callback *read_eagerly,
715 : : void *read_eagerly_arg,
716 : : size_t maxread,
717 : : const void *note_file,
718 : : size_t note_file_size,
719 : : const struct r_debug_info *r_debug_info);
720 : :
721 : : /* Report a module for entry in the dynamic linker's struct link_map list.
722 : : For each link_map entry, if an existing module resides at its address,
723 : : this just modifies that module's name and suggested file name. If
724 : : no such module exists, this calls dwfl_report_elf on the l_name string.
725 : :
726 : : If AUXV is not null, it points to AUXV_SIZE bytes of auxiliary vector
727 : : data as contained in an NT_AUXV note or read from a /proc/pid/auxv
728 : : file. When this is available, it guides the search. If AUXV is null
729 : : or the memory it points to is not accessible, then this search can
730 : : only find where to begin if the correct executable file was
731 : : previously reported and preloaded as with dwfl_report_elf.
732 : :
733 : : Fill in R_DEBUG_INFO if it is not NULL. It should be cleared by the
734 : : caller, this function does not touch fields it does not need to modify.
735 : : If R_DEBUG_INFO is not NULL then no modules get added to DWFL, caller
736 : : has to add them from filled in R_DEBUG_INFO.
737 : :
738 : : Returns the number of modules found, or -1 for errors. */
739 : : extern int dwfl_link_map_report (Dwfl *dwfl, const void *auxv, size_t auxv_size,
740 : : Dwfl_Memory_Callback *memory_callback,
741 : : void *memory_callback_arg,
742 : : struct r_debug_info *r_debug_info);
743 : :
744 : :
745 : : /* Avoid PLT entries. */
746 : : INTDECL (dwfl_begin)
747 : : INTDECL (dwfl_errmsg)
748 : : INTDECL (dwfl_errno)
749 : : INTDECL (dwfl_addrmodule)
750 : : INTDECL (dwfl_addrsegment)
751 : : INTDECL (dwfl_addrdwarf)
752 : : INTDECL (dwfl_addrdie)
753 : : INTDECL (dwfl_core_file_attach)
754 : : INTDECL (dwfl_core_file_report)
755 : : INTDECL (dwfl_getmodules)
756 : : INTDECL (dwfl_module_addrdie)
757 : : INTDECL (dwfl_module_address_section)
758 : : INTDECL (dwfl_module_addrinfo)
759 : : INTDECL (dwfl_module_addrsym)
760 : : INTDECL (dwfl_module_build_id)
761 : : INTDECL (dwfl_module_getdwarf)
762 : : INTDECL (dwfl_module_getelf)
763 : : INTDECL (dwfl_module_getsym)
764 : : INTDECL (dwfl_module_getsym_info)
765 : : INTDECL (dwfl_module_getsymtab)
766 : : INTDECL (dwfl_module_getsymtab_first_global)
767 : : INTDECL (dwfl_module_getsrc)
768 : : INTDECL (dwfl_module_report_build_id)
769 : : INTDECL (dwfl_report_elf)
770 : : INTDECL (dwfl_report_begin)
771 : : INTDECL (dwfl_report_begin_add)
772 : : INTDECL (dwfl_report_module)
773 : : INTDECL (dwfl_report_segment)
774 : : INTDECL (dwfl_report_offline)
775 : : INTDECL (dwfl_report_offline_memory)
776 : : INTDECL (dwfl_report_end)
777 : : INTDECL (dwfl_build_id_find_elf)
778 : : INTDECL (dwfl_build_id_find_debuginfo)
779 : : INTDECL (dwfl_standard_find_debuginfo)
780 : : INTDECL (dwfl_link_map_report)
781 : : INTDECL (dwfl_linux_kernel_find_elf)
782 : : INTDECL (dwfl_linux_kernel_module_section_address)
783 : : INTDECL (dwfl_linux_proc_attach)
784 : : INTDECL (dwfl_linux_proc_report)
785 : : INTDECL (dwfl_linux_proc_maps_report)
786 : : INTDECL (dwfl_linux_proc_find_elf)
787 : : INTDECL (dwfl_linux_kernel_report_kernel)
788 : : INTDECL (dwfl_linux_kernel_report_modules)
789 : : INTDECL (dwfl_linux_kernel_report_offline)
790 : : INTDECL (dwfl_offline_section_address)
791 : : INTDECL (dwfl_module_relocate_address)
792 : : INTDECL (dwfl_module_dwarf_cfi)
793 : : INTDECL (dwfl_module_eh_cfi)
794 : : INTDECL (dwfl_attach_state)
795 : : INTDECL (dwfl_pid)
796 : : INTDECL (dwfl_thread_dwfl)
797 : : INTDECL (dwfl_thread_tid)
798 : : INTDECL (dwfl_frame_thread)
799 : : INTDECL (dwfl_frame_unwound_source)
800 : : INTDECL (dwfl_unwound_source_str)
801 : : INTDECL (dwfl_thread_state_registers)
802 : : INTDECL (dwfl_thread_state_register_pc)
803 : : INTDECL (dwfl_getthread_frames)
804 : : INTDECL (dwfl_getthreads)
805 : : INTDECL (dwfl_thread_getframes)
806 : : INTDECL (dwfl_frame_pc)
807 : : INTDECL (dwfl_frame_reg)
808 : : INTDECL (dwfl_get_debuginfod_client)
809 : :
810 : : /* Leading arguments standard to callbacks passed a Dwfl_Module. */
811 : : #define MODCB_ARGS(mod) (mod), &(mod)->userdata, (mod)->name, (mod)->low_addr
812 : : #define CBFAIL (errno ? DWFL_E (ERRNO, errno) : DWFL_E_CB);
813 : :
814 : :
815 : : /* The default used by dwfl_standard_find_debuginfo. */
816 : : #define DEFAULT_DEBUGINFO_PATH ":.debug:/usr/lib/debug"
817 : :
818 : :
819 : : #endif /* libdwflP.h */
|
