12 #include "abg-internal.h"
20 #include <elfutils/libdwfl.h>
28 ABG_BEGIN_EXPORT_DECLARATIONS
36 using namespace elf_helpers;
51 find_alt_dwarf_debug_info_link(Dwfl_Module *elf_module,
52 string &alt_file_name)
55 Dwarf *dwarf = dwfl_module_getdwarf(elf_module, &bias);
56 Elf *elf = dwarf_getelf(dwarf);
57 GElf_Ehdr ehmem, *elf_header;
58 elf_header = gelf_getehdr(elf, &ehmem);
61 while ((section = elf_nextscn(elf, section)) != 0)
63 GElf_Shdr header_mem, *header;
64 header = gelf_getshdr(section, &header_mem);
65 if (header->sh_type != SHT_PROGBITS)
68 const char *section_name = elf_strptr(elf,
69 elf_header->e_shstrndx,
74 size_t buildid_len = 0;
76 && strcmp(section_name,
".gnu_debugaltlink") == 0)
78 Elf_Data *data = elf_getdata(section, 0);
79 if (data != 0 && data->d_size != 0)
81 alt_name = (
char*) data->d_buf;
82 char *end_of_alt_name =
83 (
char *) memchr(alt_name,
'\0', data->d_size);
84 buildid_len = data->d_size - (end_of_alt_name - alt_name + 1);
87 buildid = end_of_alt_name + 1;
93 if (buildid == 0 || alt_name == 0)
96 alt_file_name = alt_name;
127 find_alt_dwarf_debug_info_path(
const vector<char**> root_dirs,
128 const string &alt_file_name,
129 string &alt_file_path)
131 if (alt_file_name.empty())
141 for (vector<char**>::const_iterator i = root_dirs.begin();
142 i != root_dirs.end();
178 find_alt_dwarf_debug_info(Dwfl_Module *elf_module,
179 const vector<char**> debug_root_dirs,
180 string& alt_file_name,
187 find_alt_dwarf_debug_info_link(elf_module, alt_file_name);
189 #ifdef LIBDW_HAS_DWARF_GETALT
193 Dwarf* dwarf = dwfl_module_getdwarf(elf_module, &bias);
194 result = dwarf_getalt(dwarf);
201 const char *file_name = 0;
202 void **user_data = 0;
203 Dwarf_Addr low_addr = 0;
206 file_name = dwfl_module_info(elf_module, &user_data,
207 &low_addr, 0, 0, 0, 0, 0);
209 alt_fd = dwfl_standard_find_debuginfo(elf_module, user_data,
214 result = dwarf_begin(alt_fd, DWARF_C_READ);
224 string alt_file_path;
225 if (!find_alt_dwarf_debug_info_path(debug_root_dirs,
233 alt_fd = open(alt_file_path.c_str(), O_RDONLY);
236 result = dwarf_begin(alt_fd, DWARF_C_READ);
238 #ifdef LIBDW_HAS_DWARF_GETALT
240 Dwarf* dwarf = dwfl_module_getdwarf(elf_module, &bias);
241 dwarf_setalt(dwarf, result);
252 Elf* elf_handle =
nullptr;
253 Elf_Scn* symtab_section =
nullptr;
254 string elf_architecture;
255 vector<string> dt_needed;
258 mutable symtab_reader::symtab_sptr symt;
260 vector<char**> debug_info_root_paths;
263 Dwfl_Callbacks offline_callbacks;
266 dwfl_sptr dwfl_handle;
268 Dwfl_Module* elf_module =
nullptr;
270 Dwarf* dwarf_handle =
nullptr;
275 Dwarf* alt_dwarf_handle =
nullptr;
276 string alt_dwarf_path;
277 int alt_dwarf_fd = 0;
278 Elf_Scn* ctf_section =
nullptr;
280 Elf* alt_ctf_handle =
nullptr;
281 Elf_Scn* alt_ctf_section =
nullptr;
282 Elf_Scn* btf_section =
nullptr;
284 priv(
reader& reeder,
const std::string& elf_path,
285 const vector<char**>& debug_info_roots)
294 clear_alt_dwarf_debug_info_data();
295 clear_alt_ctf_debug_info_data();
303 initialize(
const vector<char**>& debug_info_roots)
305 clear_alt_dwarf_debug_info_data();
306 clear_alt_ctf_debug_info_data();
308 elf_handle =
nullptr;
309 symtab_section =
nullptr;
310 elf_architecture.clear();
313 debug_info_root_paths = debug_info_roots;
314 memset(&offline_callbacks, 0,
sizeof(offline_callbacks));
316 elf_module =
nullptr;
317 dwarf_handle =
nullptr;
318 alt_dwarf_handle =
nullptr;
319 alt_dwarf_path.clear();
321 ctf_section =
nullptr;
322 alt_ctf_section =
nullptr;
323 alt_ctf_handle =
nullptr;
333 crack_open_elf_file()
336 elf_helpers::initialize_dwfl_callbacks(offline_callbacks,
337 debug_info_root_paths.empty()
339 : debug_info_root_paths.front());
342 dwfl_handle = elf_helpers::create_new_dwfl_handle(offline_callbacks);
348 dwfl_report_offline(dwfl_handle.get(),
349 basename(const_cast<char*>(elf_path.c_str())),
350 elf_path.c_str(), -1);
351 dwfl_report_end(dwfl_handle.get(), 0, 0);
357 elf_handle = dwfl_module_getelf(elf_module, &bias);
369 find_alt_dwarf_debug_info(Dwfl_Module* elf_module,
370 string& alt_file_name,
374 result = elf::find_alt_dwarf_debug_info(elf_module,
375 debug_info_root_paths,
376 alt_file_name, alt_fd);
382 clear_alt_dwarf_debug_info_data()
386 if (alt_dwarf_handle)
388 dwarf_end(alt_dwarf_handle);
389 alt_dwarf_handle =
nullptr;
394 alt_dwarf_path.clear();
401 locate_dwarf_debug_info()
411 dwarf_handle = dwfl_module_getdwarf(elf_module, &bias);
415 for (vector<char**>::const_iterator i = debug_info_root_paths.begin();
416 dwarf_handle == 0 && i != debug_info_root_paths.end();
419 offline_callbacks.debuginfo_path = *i;
420 dwarf_handle = dwfl_module_getdwarf(elf_module, &bias);
423 alt_dwarf_handle = find_alt_dwarf_debug_info(elf_module,
430 clear_alt_ctf_debug_info_data()
439 elf_end(alt_ctf_handle);
440 alt_ctf_handle =
nullptr;
449 locate_alt_ctf_debug_info()
455 elf_helpers::find_section(elf_handle,
462 && (data = elf_getdata(section,
nullptr))
463 && data->d_size != 0)
464 name = (
char *) data->d_buf;
469 std::string file_path;
473 if ((alt_ctf_fd = open(file_path.c_str(), O_RDONLY)) == -1)
476 if ((alt_ctf_handle = elf_begin(alt_ctf_fd,
478 nullptr)) ==
nullptr)
483 elf_helpers::find_section(alt_ctf_handle,
".ctf", SHT_PROGBITS);
494 locate_ctf_debug_info()
498 ctf_section = elf_helpers::find_section_by_name(elf_handle,
".ctf");
499 if (ctf_section ==
nullptr)
501 locate_alt_ctf_debug_info();
502 ctf_section = alt_ctf_section;
515 reader::reader(
const string& elf_path,
516 const vector<char**>& debug_info_roots,
519 priv_(
new priv(*
this, elf_path, debug_info_roots))
521 priv_->crack_open_elf_file();
522 priv_->locate_dwarf_debug_info();
523 priv_->locate_ctf_debug_info();
542 const vector<char**>& debug_info_roots)
545 corpus_path(elf_path);
546 priv_->initialize(debug_info_roots);
547 priv_->crack_open_elf_file();
548 priv_->locate_dwarf_debug_info();
549 priv_->locate_ctf_debug_info();
571 const vector<char**>&
572 reader::debug_info_root_paths()
const
573 {
return priv_->debug_info_root_paths;}
579 const Dwfl_Callbacks&
580 reader::dwfl_offline_callbacks()
const
581 {
return priv_->offline_callbacks;}
588 reader::dwfl_offline_callbacks()
589 {
return priv_->offline_callbacks;}
597 reader::elf_handle()
const
598 {
return priv_->elf_handle;}
606 reader::dwarf_debug_info()
const
607 {
return priv_->dwarf_handle;}
613 reader::has_dwarf_debug_info()
const
614 {
return ((priv_->dwarf_handle !=
nullptr)
615 || (priv_->alt_dwarf_handle !=
nullptr));}
621 reader::has_ctf_debug_info()
const
622 {
return (priv_->ctf_section !=
nullptr);}
628 reader::has_btf_debug_info()
const
629 {
return (priv_->btf_section !=
nullptr);}
641 reader::alternate_dwarf_debug_info()
const
642 {
return priv_->alt_dwarf_handle;}
653 reader::alternate_dwarf_debug_info_path()
const
654 {
return priv_->alt_dwarf_path;}
669 reader::refers_to_alt_debug_info(
string& alt_di_path)
const
671 if (!alternate_dwarf_debug_info_path().empty())
673 alt_di_path = alternate_dwarf_debug_info_path();
684 reader::find_symbol_table_section()
const
686 if (!priv_->symtab_section)
687 priv_->symtab_section =
688 elf_helpers::find_symbol_table_section(elf_handle());
689 return priv_->symtab_section;
694 reader::reset_symbol_table_section()
695 {priv_->symtab_section =
nullptr;}
701 reader::find_ctf_section()
const
703 if (priv_->ctf_section ==
nullptr)
704 priv_->locate_ctf_debug_info();
706 if (priv_->ctf_section)
707 return priv_->ctf_section;
709 return priv_->alt_ctf_section;
718 reader::find_alternate_ctf_section()
const
720 if (priv_->alt_ctf_section ==
nullptr)
721 priv_->locate_alt_ctf_debug_info();
723 return priv_->alt_ctf_section;
731 reader::find_btf_section()
const
733 if (priv_->btf_section ==
nullptr)
735 elf_helpers::find_section(priv_->elf_handle,
736 ".BTF", SHT_PROGBITS);
737 return priv_->btf_section;
743 const vector<string>&
744 reader::dt_needed()
const
745 {
return priv_->dt_needed;}
753 reader::elf_architecture()
const
754 {
return priv_->elf_architecture;}
763 symtab_reader::symtab_sptr&
764 reader::symtab()
const
770 (elf_handle(), options().env,
775 std::cerr <<
"Symbol table of '" << corpus_path()
776 <<
"' could not be loaded\n";
789 reader::function_symbol_is_exported(GElf_Addr symbol_address)
const
795 if (!symbol->is_function() || !symbol->is_public())
798 address_set_sptr set;
799 bool looking_at_linux_kernel_binary =
800 load_in_linux_kernel_mode() && elf_helpers::is_linux_kernel(elf_handle());
802 if (looking_at_linux_kernel_binary)
804 if (symbol->is_in_ksymtab())
821 reader::variable_symbol_is_exported(GElf_Addr symbol_address)
const
827 if (!symbol->is_variable() || !symbol->is_public())
830 address_set_sptr set;
831 bool looking_at_linux_kernel_binary =
832 load_in_linux_kernel_mode() && elf_helpers::is_linux_kernel(elf_handle());
834 if (looking_at_linux_kernel_binary)
836 if (symbol->is_in_ksymtab())
850 reader::function_symbol_is_exported(
const string& name)
const
852 const elf_symbols& syms = symtab()->lookup_symbol(name);
855 if (s->is_function() && s->is_public())
857 bool looking_at_linux_kernel_binary =
858 (load_in_linux_kernel_mode()
859 && elf_helpers::is_linux_kernel(elf_handle()));
861 if (looking_at_linux_kernel_binary)
863 if (s->is_in_ksymtab())
880 reader::variable_symbol_is_exported(
const string& name)
const
882 const elf_symbols& syms = symtab()->lookup_symbol(name);
885 if (s->is_variable() && s->is_public())
887 bool looking_at_linux_kernel_binary =
888 (load_in_linux_kernel_mode()
889 && elf_helpers::is_linux_kernel(elf_handle()));
891 if (looking_at_linux_kernel_binary)
893 if (s->is_in_ksymtab())
904 reader::load_dt_soname_and_needed()
906 elf_helpers::lookup_data_tag_from_dynamic_segment(elf_handle(),
910 vector<string> dt_tag_data;
911 elf_helpers::lookup_data_tag_from_dynamic_segment(elf_handle(),
914 if (!dt_tag_data.empty())
915 dt_soname(dt_tag_data[0]);
921 reader::load_elf_architecture()
927 GElf_Ehdr* elf_header = gelf_getehdr(elf_handle(), &eh_mem);
929 priv_->elf_architecture =
930 elf_helpers::e_machine_to_string(elf_header->e_machine);
939 reader::load_elf_properties()
944 load_dt_soname_and_needed();
945 load_elf_architecture();
965 status = STATUS_UNKNOWN;
968 origin |= corpus::ELF_ORIGIN;
969 if (is_linux_kernel(elf_handle()))
970 origin |= corpus::LINUX_KERNEL_BINARY_ORIGIN;
973 load_elf_properties();
981 status |= STATUS_NO_SYMBOLS_FOUND | STATUS_OK;
993 if ((origin & abigail::ir::corpus::DWARF_ORIGIN)
994 && !has_dwarf_debug_info())
995 status |= STATUS_DEBUG_INFO_NOT_FOUND;
996 else if ((origin & abigail::ir::corpus::CTF_ORIGIN)
997 && !has_ctf_debug_info())
998 status |= STATUS_DEBUG_INFO_NOT_FOUND;
1000 status |= STATUS_OK;
1024 elf_file_type(Elf* elf)
1027 GElf_Ehdr *header = gelf_getehdr (elf, &ehdr_mem);
1028 vector<string> dt_debug_data;
1030 switch (header->e_type)
1033 if (lookup_data_tag_from_dynamic_segment(elf, DT_DEBUG, dt_debug_data))
1059 int fd = open(path.c_str(), O_RDONLY);
1063 elf_version (EV_CURRENT);
1064 Elf *elf = elf_begin (fd, ELF_C_READ_MMAP, NULL);
1065 type = elf_file_type(elf);
bool is_elf_symbol_suppressed(const fe_iface &fe, const elf_symbol_sptr &symbol)
Test if an ELF symbol is suppressed by at least one of the suppression specifications associated with...
The base class of all libabigail front-ends: The Front End Interface.
void set_needed(const vector< string > &)
Setter of the needed property of the corpus.
void set_architecture_name(const string &)
Setter for the architecture name of the corpus.
This is the abstraction of a set of translation units (themselves seen as bundles of unitary abi arte...
status
The status of the fe_iface::read_corpus call.
void set_soname(const string &)
Setter for the soname property of the corpus.
A normal executable binary.
This contains the declarations for the symtab reader.
An unknown kind of binary.
std::vector< elf_symbol_sptr > elf_symbols
Convenience typedef for a vector of elf_symbol.
A Position Independant Executable binary.
Toplevel namespace for libabigail.
const vector< char ** > & debug_info_root_paths() const
Getter of the vector of directory paths to look into for split debug information files.
bool get_type_of_elf_file(const string &path, elf::elf_type &type)
Get the type of a given elf type.
origin
This abstracts where the corpus comes from. That is, either it has been read from the native xml form...
This is an abstraction of the set of resources necessary to manage several aspects of the internal re...
This contains the private implementation of the suppression engine of libabigail. ...
shared_ptr< elf_symbol > elf_symbol_sptr
A convenience typedef for a shared pointer to elf_symbol.
#define ABG_ASSERT(cond)
This is a wrapper around the 'assert' glibc call. It allows for its argument to have side effects...
This is the interface an ELF reader.
This file contains the declarations for the fe_iface a.k.a "Front End Interface". ...
bool get_soname_of_elf_file(const string &path, string &soname)
Get the SONAME property of a designated ELF file.
A dynamic shared object, a.k.a shared library binary.
const std::string & corpus_path() const
Getter of the path to the file which an ABI corpus is to be created for.
void set_origin(origin)
Setter for the origin of the corpus.
static symtab_ptr load(Elf *elf_handle, const ir::environment &env, symbol_predicate is_suppressed=NULL)
Construct a symtab object and instantiate it from an ELF handle. Also pass in the ir::environment we ...
This contains a set of ELF utilities used by the dwarf reader.
origin get_origin() const
Getter for the origin of the corpus.
void set_symtab(symtab_reader::symtab_sptr)
Setter for the symtab object.
virtual void initialize(const std::string &corpus_path)
Re-initialize the current Front End.
elf_type
The kind of ELF file we are looking at.