This is the abstraction of a set of translation units (themselves seen as bundles of unitary abi artefacts like types and decls) bundled together as a corpus. A corpus is thus the Application binary interface of a program, a library or just a set of modules put together. More...

#include <abg-corpus.h>

Inheritance diagram for corpus:

[legend]

Classes
class	exported_decls_builder
	Abstracts the building of the set of exported variables and functions. More...

struct	priv
	The private data of the corpus type. More...

Public Types
typedef shared_ptr< exported_decls_builder >	exported_decls_builder_sptr
	Convenience typedef for shared_ptr<exported_decls_builder>. More...

typedef vector< function_decl * >	functions
	Convenience typedef for std::vector<abigail::ir::function_decl*> More...

enum	origin { ARTIFICIAL_ORIGIN , NATIVE_XML_ORIGIN , ELF_ORIGIN , DWARF_ORIGIN , CTF_ORIGIN , BTF_ORIGIN , LINUX_KERNEL_BINARY_ORIGIN }
	This abstracts where the corpus comes from. That is, either it has been read from the native xml format, from DWARF or built artificially using the library's API. More...

typedef vector< string >	strings_type
	A convenience typedef for std::vector<string>. More...

typedef vector< var_decl * >	variables
	Convenience typedef for std::vector<abigail::ir::var_decl*> More...

Public Member Functions
	corpus (const ir::environment &, const string &path="")
	Constructor of the corpus type. More...

void	add (const translation_unit_sptr &)
	Add a translation unit to the current ABI Corpus. More...

bool	do_log () const
	Test if logging was requested. More...

void	do_log (bool)
	Request logging, or not. More...

void	drop_translation_units ()
	Erase the translation units contained in this in-memory object. More...

const translation_unit_sptr	find_translation_unit (const string &path) const
	Find the translation unit that has a given path. More...

const string &	get_architecture_name () const
	Getter for the architecture name of the corpus. More...

const environment &	get_environment () const
	Getter of the enviroment of the corpus. More...

exported_decls_builder_sptr	get_exported_decls_builder () const
	Getter for the object that is responsible for determining what decls ought to be in the set of exported decls. More...

string &	get_format_major_version_number () const
	Getter of the major version number of the abixml serialization format. More...

string &	get_format_minor_version_number () const
	Getter of the minor version number of the abixml serialization format. More...

virtual const string_elf_symbols_map_type &	get_fun_symbol_map () const
	Getter for the function symbols map. More...

virtual const functions &	get_functions () const
	Return the functions public decl table of the current corpus. More...

corpus_group *	get_group ()
	Getter of the group this corpus belongs to. More...

const corpus_group *	get_group () const
	Getter of the group this corpus is a member of. More...

const vector< string > &	get_needed () const
	Getter of the needed property of the corpus. More...

origin	get_origin () const
	Getter for the origin of the corpus. More...

string &	get_path () const
	Get the file path associated to the corpus file. More...

vector< string > &	get_regex_patterns_of_fns_to_keep ()
	Accessor for the regex patterns describing the functions to keep into the public decl table. The other functions not matches by these regexes are dropped from the public decl table. More...

const vector< string > &	get_regex_patterns_of_fns_to_keep () const
	Accessor for the regex patterns describing the functions to keep into the public decl table. The other functions not matches by these regexes are dropped from the public decl table. More...

vector< string > &	get_regex_patterns_of_fns_to_suppress ()
	Accessor for the regex patterns describing the functions to drop from the public decl table. More...

const vector< string > &	get_regex_patterns_of_fns_to_suppress () const
	Accessor for the regex patterns describing the functions to drop from the public decl table. More...

vector< string > &	get_regex_patterns_of_vars_to_keep ()
	Accessor for the regex patterns describing the variables to keep into the public decl table. The other variables not matches by these regexes are dropped from the public decl table. More...

const vector< string > &	get_regex_patterns_of_vars_to_keep () const
	Accessor for the regex patterns describing the variables to keep into the public decl table. The other variables not matches by these regexes are dropped from the public decl table. More...

vector< string > &	get_regex_patterns_of_vars_to_suppress ()
	Accessor for the regex patterns describing the variables to drop from the public decl table. More...

const vector< string > &	get_regex_patterns_of_vars_to_suppress () const
	Accessor for the regex patterns describing the variables to drop from the public decl table. More...

const string &	get_soname ()
	Getter for the soname property of the corpus. More...

virtual const elf_symbols &	get_sorted_fun_symbols () const
	Return a sorted vector of function symbols for this corpus. More...

const elf_symbols &	get_sorted_undefined_fun_symbols () const
	Getter for a sorted vector of the function symbols undefined in this corpus. More...

const elf_symbols &	get_sorted_undefined_var_symbols () const
	Getter for a sorted vector of the variable symbols undefined in this corpus. More...

virtual const elf_symbols &	get_sorted_var_symbols () const
	Getter for the sorted vector of variable symbols for this corpus. More...

vector< string > &	get_sym_ids_of_fns_to_keep ()
	Getter for the vector of function symbol IDs to keep. More...

const vector< string > &	get_sym_ids_of_fns_to_keep () const
	Getter for the vector of function symbol IDs to keep. More...

vector< string > &	get_sym_ids_of_vars_to_keep ()
	Getter for the vector of variable symbol IDs to keep. More...

const vector< string > &	get_sym_ids_of_vars_to_keep () const
	Getter for the vector of variable symbol IDs to keep. More...

const symtab_reader::symtab_sptr &	get_symtab () const
	Getter for the symtab object. More...

const translation_units &	get_translation_units () const
	Return the list of translation units of the current corpus. More...

type_maps &	get_type_per_loc_map ()
	Get the maps that associate a location string to a certain kind of type. More...

const type_maps &	get_type_per_loc_map () const
	Get the maps that associate a location string to a certain kind of type. More...

type_maps &	get_types ()
	Get the maps that associate a name to a certain kind of type. More...

const type_maps &	get_types () const
	Get the maps that associate a name to a certain kind of type. More...

const vector< type_base_wptr > &	get_types_not_reachable_from_public_interfaces () const
	Getter of a sorted vector of the types that are NOT reachable from public interfaces. More...

const string_elf_symbols_map_type &	get_undefined_fun_symbol_map () const
	Getter for the map of function symbols that are undefined in this corpus. More...

const string_elf_symbols_map_type &	get_undefined_var_symbol_map () const
	Getter for the map of variable symbols that are undefined in this corpus. More...

virtual const elf_symbols &	get_unreferenced_function_symbols () const
	Getter of the set of function symbols that are not referenced by any function exported by the current corpus. More...

virtual const elf_symbols &	get_unreferenced_variable_symbols () const
	Getter of the set of variable symbols that are not referenced by any variable exported by the current corpus. More...

virtual const string_elf_symbols_map_type &	get_var_symbol_map () const
	Getter for the variable symbols map. More...

virtual const variables &	get_variables () const
	Return the public decl table of the global variables of the current corpus. More...

virtual bool	is_empty () const
	Tests if the corpus is empty from an ABI surface perspective. I.e. if all of these criteria are true: More...

const elf_symbol_sptr	lookup_function_symbol (const elf_symbol &symbol) const
	Look in the function symbols map for a symbol with the same name and version as a given symbol. More...

const elf_symbol_sptr	lookup_function_symbol (const string &n) const
	Look in the function symbols map for a symbol with a given name. More...

const elf_symbol_sptr	lookup_function_symbol (const string &symbol_name, const elf_symbol::version &version) const
	Look in the function symbols map for a symbol with a given name. More...

const std::unordered_set< function_decl * > *	lookup_functions (const string &id) const
	Lookup the function which has a given function ID. More...

const elf_symbol_sptr	lookup_variable_symbol (const elf_symbol &symbol) const
	Look in the variable symbols map for a symbol with the same name and version as a given symbol. More...

const elf_symbol_sptr	lookup_variable_symbol (const string &n) const
	Look in the variable symbols map for a symbol with a given name. More...

const elf_symbol_sptr	lookup_variable_symbol (const string &symbol_name, const elf_symbol::version &version) const
	Look in the variable symbols map for a symbol with a given name. More...

void	maybe_drop_some_exported_decls ()
	After the set of exported functions and variables have been built, consider all the tunables that control that set and see if some functions need to be removed from that set; if so, remove them. More...

bool	operator== (const corpus &) const
	Compare the current corpus against another one. More...

void	record_type_as_reachable_from_public_interfaces (const type_base &)
	Record a type as being reachable from public interfaces (global functions and variables). More...

virtual bool	recording_types_reachable_from_public_interface_supported ()
	Test if the recording of reachable types (and thus, indirectly, the recording of non-reachable types) is activated for the current corpus. More...

void	set_architecture_name (const string &)
	Setter for the architecture name of the corpus. More...

void	set_format_major_version_number (const string &)
	Setter of the major version number of the abixml serialization format. More...

void	set_format_minor_version_number (const string &)
	Setter of the minor version number of the abixml serialization format. More...

void	set_needed (const vector< string > &)
	Setter of the needed property of the corpus. More...

void	set_origin (origin)
	Setter for the origin of the corpus. More...

void	set_path (const string &)
	Set the file path associated to the corpus file. More...

void	set_soname (const string &)
	Setter for the soname property of the corpus. More...

void	set_symtab (symtab_reader::symtab_sptr)
	Setter for the symtab object. More...

void	sort_functions ()
	Sort the set of functions exported by this corpus. More...

void	sort_variables ()
	Sort the set of variables exported by this corpus. More...

bool	type_is_reachable_from_public_interfaces (const type_base &) const
	Test if a type is reachable from public interfaces (global functions and variables). More...

Public Attributes
std::unique_ptr< priv >	priv_

Friends
class	corpus_group

class	type_base

Detailed Description

This is the abstraction of a set of translation units (themselves seen as bundles of unitary abi artefacts like types and decls) bundled together as a corpus. A corpus is thus the Application binary interface of a program, a library or just a set of modules put together.

Definition at line 24 of file abg-corpus.h.

Member Typedef Documentation

◆ exported_decls_builder_sptr

typedef shared_ptr<exported_decls_builder> exported_decls_builder_sptr

Convenience typedef for shared_ptr<exported_decls_builder>.

Definition at line 39 of file abg-corpus.h.

◆ functions

typedef vector<function_decl*> functions

Convenience typedef for std::vector<abigail::ir::function_decl*>

Definition at line 31 of file abg-corpus.h.

◆ strings_type

typedef vector<string> strings_type

A convenience typedef for std::vector<string>.

Definition at line 28 of file abg-corpus.h.

◆ variables

typedef vector<var_decl*> variables

Convenience typedef for std::vector<abigail::ir::var_decl*>

Definition at line 34 of file abg-corpus.h.

Member Enumeration Documentation

◆ origin

enum origin

This abstracts where the corpus comes from. That is, either it has been read from the native xml format, from DWARF or built artificially using the library's API.

Definition at line 44 of file abg-corpus.h.

Constructor & Destructor Documentation

◆ corpus()

corpus	(	const ir::environment &	env,
		const string &	path = `""`
	)

Constructor of the corpus type.

Parameters

env	the environment of the corpus.
path	the path to the file containing the ABI corpus.

Definition at line 643 of file abg-corpus.cc.

Member Function Documentation

◆ add()

void add ( const translation_unit_sptr & tu )

Add a translation unit to the current ABI Corpus.

Note that two translation units with the same path (as returned by translation_unit::get_path) cannot be added to the same corpus. If that happens, the library aborts.

Parameters

tu	the new translation unit to add.

Definition at line 680 of file abg-corpus.cc.

◆ do_log() [1/2]

bool do_log ( ) const

Test if logging was requested.

Returns: true iff logging was requested.

Definition at line 662 of file abg-corpus.cc.

◆ do_log() [2/2]

void do_log ( bool f )

Request logging, or not.

Parameters

f	true iff logging is requested.

Definition at line 669 of file abg-corpus.cc.

◆ drop_translation_units()

void drop_translation_units ( )

Erase the translation units contained in this in-memory object.

Note that the on-disk archive file that contains the serialized representation of this object is not modified.

Definition at line 725 of file abg-corpus.cc.

◆ find_translation_unit()

const translation_unit_sptr find_translation_unit ( const string & path ) const

Find the translation unit that has a given path.

Parameters

path	the path of the translation unit to look for.

Returns: the translation unit found, if any. Otherwise, return nil.

Definition at line 710 of file abg-corpus.cc.

◆ get_architecture_name()

const string & get_architecture_name ( ) const

Getter for the architecture name of the corpus.

This property is meaningful for e.g, corpora built from ELF shared library files. In that case, this is a string representation of the Elf{32,64}_Ehdr::e_machine field.

Returns: the architecture name string.

Definition at line 1006 of file abg-corpus.cc.

◆ get_environment()

const environment & get_environment ( ) const

Getter of the enviroment of the corpus.

Returns: the environment of this corpus.

Definition at line 655 of file abg-corpus.cc.

◆ get_exported_decls_builder()

corpus::exported_decls_builder_sptr get_exported_decls_builder ( ) const

Getter for the object that is responsible for determining what decls ought to be in the set of exported decls.

The object does have methods to add the decls to the set of exported decls, right at the place where the corpus expects it, so that there is no unnecessary copying involved.

Returns: a (smart) pointer to the instance of corpus::exported_decls_builder that is responsible for determine what decls ought to be in the set of exported decls.

Definition at line 1577 of file abg-corpus.cc.

◆ get_format_major_version_number()

string & get_format_major_version_number ( ) const

Getter of the major version number of the abixml serialization format.

Returns: the major version number of the abixml format.

Definition at line 900 of file abg-corpus.cc.

◆ get_format_minor_version_number()

string & get_format_minor_version_number ( ) const

Getter of the minor version number of the abixml serialization format.

Returns: the minor version number of the abixml serialization format.

Definition at line 917 of file abg-corpus.cc.

◆ get_fun_symbol_map()

const string_elf_symbols_map_type & get_fun_symbol_map ( ) const

virtual

Getter for the function symbols map.

Returns: a reference to the function symbols map.

Reimplemented in corpus_group.

Definition at line 1090 of file abg-corpus.cc.

◆ get_functions()

const corpus::functions & get_functions ( ) const

virtual

Return the functions public decl table of the current corpus.

The function public decl tables is a vector of all the functions and member functions found in the current corpus.

Note that the caller can suppress some functions from the vector supplying regular expressions describing the set of functions she want to see removed from the public decl table by populating the vector of regular expressions returned by corpus::get_regex_patterns_of_fns_to_suppress().

Returns: the vector of functions of the public decl table. The functions are sorted using their mangled name or name if they don't have mangle names.

Reimplemented in corpus_group.

Definition at line 1322 of file abg-corpus.cc.

◆ get_group() [1/2]

corpus_group * get_group ( )

Getter of the group this corpus belongs to.

Returns: the group this corpus belong to, or nil if it's not part of any corpus_group.

Definition at line 857 of file abg-corpus.cc.

◆ get_group() [2/2]

const corpus_group * get_group ( ) const

Getter of the group this corpus is a member of.

Returns: the group this corpus is a member of, or nil if it's not part of any corpus_group.

Definition at line 849 of file abg-corpus.cc.

◆ get_needed()

const vector< string > & get_needed ( ) const

Getter of the needed property of the corpus.

This property is meaningful for, e.g, corpora built from ELF shared library files. In that case, this is a vector of names of dependencies of the ELF shared library file.

Returns: the vector of dependencies needed by this corpus.

Definition at line 961 of file abg-corpus.cc.

◆ get_origin()

corpus::origin get_origin ( ) const

Getter for the origin of the corpus.

Returns: the origin of the corpus.

Definition at line 885 of file abg-corpus.cc.

◆ get_path()

string & get_path ( ) const

Get the file path associated to the corpus file.

A subsequent call to corpus::read will deserialize the content of the abi file expected at this path; likewise, a call to corpus::write will serialize the translation units contained in the corpus object into the on-disk file at this path.

Returns: the file path associated to the current corpus.

Definition at line 938 of file abg-corpus.cc.

◆ get_regex_patterns_of_fns_to_keep() [1/2]

vector< string > & get_regex_patterns_of_fns_to_keep ( )

Accessor for the regex patterns describing the functions to keep into the public decl table. The other functions not matches by these regexes are dropped from the public decl table.

Returns: the regex patterns describing the functions to keep into the public decl table.

Definition at line 1459 of file abg-corpus.cc.

◆ get_regex_patterns_of_fns_to_keep() [2/2]

const vector< string > & get_regex_patterns_of_fns_to_keep ( ) const

Accessor for the regex patterns describing the functions to keep into the public decl table. The other functions not matches by these regexes are dropped from the public decl table.

Returns: the regex patterns describing the functions to keep into the public decl table.

Definition at line 1469 of file abg-corpus.cc.

◆ get_regex_patterns_of_fns_to_suppress() [1/2]

vector< string > & get_regex_patterns_of_fns_to_suppress ( )

Accessor for the regex patterns describing the functions to drop from the public decl table.

Returns: the regex patterns describing the functions to drop from the public decl table.

Definition at line 1422 of file abg-corpus.cc.

◆ get_regex_patterns_of_fns_to_suppress() [2/2]

const vector< string > & get_regex_patterns_of_fns_to_suppress ( ) const

Accessor for the regex patterns describing the functions to drop from the public decl table.

Returns: the regex patterns describing the functions to drop from the public decl table.

Definition at line 1431 of file abg-corpus.cc.

◆ get_regex_patterns_of_vars_to_keep() [1/2]

vector< string > & get_regex_patterns_of_vars_to_keep ( )

Accessor for the regex patterns describing the variables to keep into the public decl table. The other variables not matches by these regexes are dropped from the public decl table.

Returns: the regex patterns describing the variables to keep into the public decl table.

Definition at line 1499 of file abg-corpus.cc.

◆ get_regex_patterns_of_vars_to_keep() [2/2]

const vector< string > & get_regex_patterns_of_vars_to_keep ( ) const

Accessor for the regex patterns describing the variables to keep into the public decl table. The other variables not matches by these regexes are dropped from the public decl table.

Returns: the regex patterns describing the variables to keep into the public decl table.

Definition at line 1509 of file abg-corpus.cc.

◆ get_regex_patterns_of_vars_to_suppress() [1/2]

vector< string > & get_regex_patterns_of_vars_to_suppress ( )

Accessor for the regex patterns describing the variables to drop from the public decl table.

Returns: the regex patterns describing the variables to drop from the public decl table.

Definition at line 1440 of file abg-corpus.cc.

◆ get_regex_patterns_of_vars_to_suppress() [2/2]

const vector< string > & get_regex_patterns_of_vars_to_suppress ( ) const

Accessor for the regex patterns describing the variables to drop from the public decl table.

Returns: the regex patterns describing the variables to drop from the public decl table.

Definition at line 1449 of file abg-corpus.cc.

◆ get_soname()

const string & get_soname ( )

Getter for the soname property of the corpus.

This property is meaningful for, e.g, corpora built from ELF shared library files. In that case, this is the shared object name exported by the shared library.

Returns: the soname property of the corpus.

Definition at line 984 of file abg-corpus.cc.

◆ get_sorted_fun_symbols()

const elf_symbols & get_sorted_fun_symbols ( ) const

virtual

Return a sorted vector of function symbols for this corpus.

Note that the first time this function is called, the symbols are sorted and cached. Subsequent invocations of this function return the cached vector that was built previously.

Returns: the sorted list of function symbols.

Reimplemented in corpus_group.

Definition at line 1111 of file abg-corpus.cc.

◆ get_sorted_undefined_fun_symbols()

const elf_symbols & get_sorted_undefined_fun_symbols ( ) const

Getter for a sorted vector of the function symbols undefined in this corpus.

Returns: a vector of the function symbols undefined in this corpus, sorted by name and then version.

Definition at line 1120 of file abg-corpus.cc.

◆ get_sorted_undefined_var_symbols()

const elf_symbols & get_sorted_undefined_var_symbols ( ) const

Getter for a sorted vector of the variable symbols undefined in this corpus.

Returns: a vector of the variable symbols undefined in this corpus, sorted by name and then version.

Definition at line 1140 of file abg-corpus.cc.

◆ get_sorted_var_symbols()

const elf_symbols & get_sorted_var_symbols ( ) const

virtual

Getter for the sorted vector of variable symbols for this corpus.

Note that the first time this function is called, it computes the sorted vector, caches the result and returns it. Subsequent invocations of this function just return the cached vector.

Returns: the sorted vector of variable symbols for this corpus.

Reimplemented in corpus_group.

Definition at line 1131 of file abg-corpus.cc.

◆ get_sym_ids_of_fns_to_keep() [1/2]

vector< string > & get_sym_ids_of_fns_to_keep ( )

Getter for the vector of function symbol IDs to keep.

A symbol ID is a string made of the name of the symbol and its version, separated by one or two '@'.

Returns: a vector of IDs of function symbols to keep.

Definition at line 1479 of file abg-corpus.cc.

◆ get_sym_ids_of_fns_to_keep() [2/2]

const vector< string > & get_sym_ids_of_fns_to_keep ( ) const

Getter for the vector of function symbol IDs to keep.

A symbol ID is a string made of the name of the symbol and its version, separated by one or two '@'.

Returns: a vector of IDs of function symbols to keep.

Definition at line 1489 of file abg-corpus.cc.

◆ get_sym_ids_of_vars_to_keep() [1/2]

vector< string > & get_sym_ids_of_vars_to_keep ( )

Getter for the vector of variable symbol IDs to keep.

A symbol ID is a string made of the name of the symbol and its version, separated by one or two '@'.

Returns: a vector of IDs of variable symbols to keep.

Definition at line 1519 of file abg-corpus.cc.

◆ get_sym_ids_of_vars_to_keep() [2/2]

const vector< string > & get_sym_ids_of_vars_to_keep ( ) const

Getter for the vector of variable symbol IDs to keep.

A symbol ID is a string made of the name of the symbol and its version, separated by one or two '@'.

Returns: a vector of IDs of variable symbols to keep.

Definition at line 1529 of file abg-corpus.cc.

◆ get_symtab()

const symtab_reader::symtab_sptr & get_symtab ( ) const

Getter for the symtab object.

Returns: a shared pointer to the symtab object

Definition at line 1083 of file abg-corpus.cc.

◆ get_translation_units()

const translation_units & get_translation_units ( ) const

Return the list of translation units of the current corpus.

Returns: the list of translation units of the current corpus.

Definition at line 700 of file abg-corpus.cc.

◆ get_type_per_loc_map() [1/2]

type_maps & get_type_per_loc_map ( )

Get the maps that associate a location string to a certain kind of type.

The location string is the result of the invocation to the function abigail::ir::location::expand(). It has the form "file.c:4:1", with 'file.c' being the file name, '4' being the line number and '1' being the column number.

Returns: the maps.

Definition at line 841 of file abg-corpus.cc.

◆ get_type_per_loc_map() [2/2]

const type_maps & get_type_per_loc_map ( ) const

Get the maps that associate a location string to a certain kind of type.

The location string is the result of the invocation to the function abigail::ir::location::expand(). It has the form "file.c:4:1", with 'file.c' being the file name, '4' being the line number and '1' being the column number.

Returns: the maps.

Definition at line 753 of file abg-corpus.cc.

◆ get_types() [1/2]

type_maps & get_types ( )

Get the maps that associate a name to a certain kind of type.

Returns: the maps that associate a name to a certain kind of type.

Definition at line 732 of file abg-corpus.cc.

◆ get_types() [2/2]

const type_maps & get_types ( ) const

Get the maps that associate a name to a certain kind of type.

Returns: the maps that associate a name to a certain kind of type.

Definition at line 740 of file abg-corpus.cc.

◆ get_types_not_reachable_from_public_interfaces()

const vector< type_base_wptr > & get_types_not_reachable_from_public_interfaces ( ) const

Getter of a sorted vector of the types that are *NOT* reachable from public interfaces.

Note that for this to be non-empty, the libabigail reader that analyzed the input (be it a binary or an abixml file) must have be configured to load types that are not reachable from public interfaces.

Returns: a reference to a vector of sorted types NON reachable from public interfaces.

Definition at line 812 of file abg-corpus.cc.

◆ get_undefined_fun_symbol_map()

const string_elf_symbols_map_type & get_undefined_fun_symbol_map ( ) const

Getter for the map of function symbols that are undefined in this corpus.

Returns: the map of function symbols not defined in this corpus. The key of the map is the name of the function symbol. The value is a vector of all the function symbols that have the same name.

Definition at line 1100 of file abg-corpus.cc.

◆ get_undefined_var_symbol_map()

const string_elf_symbols_map_type & get_undefined_var_symbol_map ( ) const

Getter for the map of variable symbols that are undefined in this corpus.

Returns: the map of variable symbols not defined in this corpus. The key of the map is the name of the variable symbol. The value is a vector of all the variable symbols that have the same name.

Definition at line 1157 of file abg-corpus.cc.

◆ get_unreferenced_function_symbols()

const elf_symbols & get_unreferenced_function_symbols ( ) const

virtual

Getter of the set of function symbols that are not referenced by any function exported by the current corpus.

When the corpus has been created from an ELF library or program, this function returns the set of function symbols not referenced by any debug information.

Returns: the vector of function symbols not referenced by any function exported by the current corpus.

Reimplemented in corpus_group.

Definition at line 1400 of file abg-corpus.cc.

◆ get_unreferenced_variable_symbols()

const elf_symbols & get_unreferenced_variable_symbols ( ) const

virtual

Getter of the set of variable symbols that are not referenced by any variable exported by the current corpus.

When the corpus has been created from an ELF library or program, this function returns the set of variable symbols not referenced by any debug information.

Returns: the vector of variable symbols not referenced by any variable exported by the current corpus.

Reimplemented in corpus_group.

Definition at line 1413 of file abg-corpus.cc.

◆ get_var_symbol_map()

const string_elf_symbols_map_type & get_var_symbol_map ( ) const

virtual

Getter for the variable symbols map.

Returns: a reference to the variabl symbols map.

Reimplemented in corpus_group.

Definition at line 1147 of file abg-corpus.cc.

◆ get_variables()

const corpus::variables & get_variables ( ) const

virtual

Return the public decl table of the global variables of the current corpus.

The variable public decls table is a vector of all the public global variables and static member variables found in the current corpus.

Note that the caller can suppress some variables from the vector supplying regular expressions describing the set of variables she wants to see removed from the public decl table by populating the vector of regular expressions returned by corpus::get_regex_patterns_of_fns_to_suppress().

Returns: the vector of variables of the public decl table. The variables are sorted using their name.

Reimplemented in corpus_group.

Definition at line 1376 of file abg-corpus.cc.

◆ is_empty()

bool is_empty ( ) const

virtual

Tests if the corpus is empty from an ABI surface perspective. I.e. if all of these criteria are true:

all translation units (members) are empty
the maps function and variable symbols are not having entries
for shared libraries:
- the soname is empty
- there are no DT_NEEDED entries

Returns: true if the corpus contains no translation unit.

Reimplemented in corpus_group.

Definition at line 1030 of file abg-corpus.cc.

◆ lookup_function_symbol() [1/3]

const elf_symbol_sptr lookup_function_symbol ( const elf_symbol & symbol ) const

Look in the function symbols map for a symbol with the same name and version as a given symbol.

Parameters

symbol the symbol to look for.

return the symbol with the same name and version as symbol.

Definition at line 1253 of file abg-corpus.cc.

◆ lookup_function_symbol() [2/3]

const elf_symbol_sptr lookup_function_symbol ( const string & n ) const

Look in the function symbols map for a symbol with a given name.

Parameters

n	the name of the symbol to look for.

return the first symbol with the name n.

Definition at line 1166 of file abg-corpus.cc.

◆ lookup_function_symbol() [3/3]

const elf_symbol_sptr lookup_function_symbol	(	const string &	symbol_name,
		const elf_symbol::version &	version
	)		const

Look in the function symbols map for a symbol with a given name.

Parameters

symbol_name	the name of the symbol to look for.
version	the version of the symbol to look for.

return the symbol with name symbol_name and with version version, or nil if no symbol has been found with that name and version.

Definition at line 1232 of file abg-corpus.cc.

◆ lookup_functions()

const std::unordered_set< function_decl * > * lookup_functions ( const string & id ) const

Lookup the function which has a given function ID.

Note that there can have been several functions with the same ID. This is because debug info can declare the same function in several different translation units. Normally, all these function should be equal. But still, this function returns all these functions.

Parameters

id	the ID of the function to lookup. This ID must be either the result of invoking function::get_id() of elf_symbol::get_id_string().

Returns: the vector functions which ID is id, or nil if no function with that ID was found.

Definition at line 1340 of file abg-corpus.cc.

◆ lookup_variable_symbol() [1/3]

const elf_symbol_sptr lookup_variable_symbol ( const elf_symbol & symbol ) const

Look in the variable symbols map for a symbol with the same name and version as a given symbol.

Parameters

symbol the symbol to look for.

return the symbol with the same name and version as symbol.

Definition at line 1304 of file abg-corpus.cc.

◆ lookup_variable_symbol() [2/3]

const elf_symbol_sptr lookup_variable_symbol ( const string & n ) const

Look in the variable symbols map for a symbol with a given name.

Parameters

n	the name of the symbol to look for.

return the first symbol with the name n.

Definition at line 1262 of file abg-corpus.cc.

◆ lookup_variable_symbol() [3/3]

const elf_symbol_sptr lookup_variable_symbol	(	const string &	symbol_name,
		const elf_symbol::version &	version
	)		const

Look in the variable symbols map for a symbol with a given name.

Parameters

symbol_name	the name of the symbol to look for.
symbol_version	the version of the symbol to look for.

return the first symbol with the name symbol_name and with version version.

Definition at line 1283 of file abg-corpus.cc.

◆ maybe_drop_some_exported_decls()

void maybe_drop_some_exported_decls ( )

After the set of exported functions and variables have been built, consider all the tunables that control that set and see if some functions need to be removed from that set; if so, remove them.

Definition at line 1536 of file abg-corpus.cc.

◆ operator==()

bool operator== ( const corpus & other ) const

Compare the current corpus against another one.

Parameters

other the other corpus to compare against.

Returns: true if the two corpus are equal, false otherwise.

Definition at line 1057 of file abg-corpus.cc.

◆ record_type_as_reachable_from_public_interfaces()

void record_type_as_reachable_from_public_interfaces ( const type_base & t )

Record a type as being reachable from public interfaces (global functions and variables).

Parameters

t	the type to record as reachable.

Definition at line 774 of file abg-corpus.cc.

◆ recording_types_reachable_from_public_interface_supported()

bool recording_types_reachable_from_public_interface_supported ( )

virtual

Test if the recording of reachable types (and thus, indirectly, the recording of non-reachable types) is activated for the current corpus.

Returns: true iff the recording of reachable types is activated for the current corpus.

Reimplemented in corpus_group.

Definition at line 763 of file abg-corpus.cc.

◆ set_architecture_name()

void set_architecture_name ( const string & arch )

Setter for the architecture name of the corpus.

This property is meaningful for e.g, corpora built from ELF shared library files. In that case, this is a string representation of the Elf{32,64}_Ehdr::e_machine field.

Parameters

arch	the architecture name string.

Definition at line 1017 of file abg-corpus.cc.

◆ set_format_major_version_number()

void set_format_major_version_number ( const string & maj )

Setter of the major version number of the abixml serialization format.

Parameters

maj	the new major version numberof the abixml format.

Definition at line 908 of file abg-corpus.cc.

◆ set_format_minor_version_number()

void set_format_minor_version_number ( const string & min )

Setter of the minor version number of the abixml serialization format.

Parameters

min	the new minor version number of the abixml serialization format.

Definition at line 926 of file abg-corpus.cc.

◆ set_needed()

void set_needed ( const vector< string > & needed )

Setter of the needed property of the corpus.

This property is meaningful for, e.g, corpora built from ELF shared library files. In that case, this is a vector of names of dependencies of the ELF shared library file.

Parameters

needed the new vector of dependencies needed by this corpus.

Definition at line 973 of file abg-corpus.cc.

◆ set_origin()

void set_origin ( origin o )

Setter for the origin of the corpus.

Parameters

o	the new origin for the corpus.

Definition at line 892 of file abg-corpus.cc.

◆ set_path()

void set_path ( const string & path )

Set the file path associated to the corpus file.

A subsequent call to corpus::read will deserialize the content of the abi file expected at this path; likewise, a call to corpus::write will serialize the translation units contained in the corpus object into the on-disk file at this path.

Parameters

path	the new file path to assciate to the current corpus.

Definition at line 950 of file abg-corpus.cc.

◆ set_soname()

void set_soname ( const string & soname )

Setter for the soname property of the corpus.

This property is meaningful for, e.g, corpora built from ELF shared library files. In that case, this is the shared object name exported by the shared library.

Parameters

soname the new soname property of the corpus.

Definition at line 995 of file abg-corpus.cc.

◆ set_symtab()

void set_symtab ( symtab_reader::symtab_sptr symtab )

Setter for the symtab object.

Parameters

symtab a shared pointer to the new symtab object

Definition at line 1076 of file abg-corpus.cc.

◆ sort_functions()

void sort_functions ( )

Sort the set of functions exported by this corpus.

Normally, you shouldn't be calling this as the code that creates the corpus for you should do it for you too.

Definition at line 1354 of file abg-corpus.cc.

◆ sort_variables()

void sort_variables ( )

Sort the set of variables exported by this corpus.

Normally, you shouldn't be calling this as the code that creates the corpus for you should do it for you too.

Definition at line 1384 of file abg-corpus.cc.

◆ type_is_reachable_from_public_interfaces()

bool type_is_reachable_from_public_interfaces ( const type_base & t ) const

Test if a type is reachable from public interfaces (global functions and variables).

For a type to be considered reachable from public interfaces, it must have been previously marked as such by calling corpus::record_type_as_reachable_from_public_interfaces.

Parameters

t	the type to test for.

Returns: true iff t is reachable from public interfaces.

Definition at line 792 of file abg-corpus.cc.

The documentation for this class was generated from the following files:

/home/builder/shared/snapshots/worker/libabigail-snapshots-html-doc/build/include/abg-corpus.h
/home/builder/shared/snapshots/worker/libabigail-snapshots-html-doc/build/src/abg-corpus.cc

Classes

Public Types

Public Member Functions

Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ exported_decls_builder_sptr

◆ functions

◆ strings_type

◆ variables

Member Enumeration Documentation

◆ origin

Constructor & Destructor Documentation

◆ corpus()

Member Function Documentation

◆ add()

◆ do_log() [1/2]

◆ do_log() [2/2]

◆ drop_translation_units()

◆ find_translation_unit()

◆ get_architecture_name()

◆ get_environment()

◆ get_exported_decls_builder()

◆ get_format_major_version_number()

◆ get_format_minor_version_number()

◆ get_fun_symbol_map()

◆ get_functions()

◆ get_group() [1/2]

◆ get_group() [2/2]

◆ get_needed()

◆ get_origin()

◆ get_path()

◆ get_regex_patterns_of_fns_to_keep() [1/2]

◆ get_regex_patterns_of_fns_to_keep() [2/2]

◆ get_regex_patterns_of_fns_to_suppress() [1/2]

◆ get_regex_patterns_of_fns_to_suppress() [2/2]

◆ get_regex_patterns_of_vars_to_keep() [1/2]

◆ get_regex_patterns_of_vars_to_keep() [2/2]

◆ get_regex_patterns_of_vars_to_suppress() [1/2]

◆ get_regex_patterns_of_vars_to_suppress() [2/2]

◆ get_soname()

◆ get_sorted_fun_symbols()

◆ get_sorted_undefined_fun_symbols()

◆ get_sorted_undefined_var_symbols()

◆ get_sorted_var_symbols()

◆ get_sym_ids_of_fns_to_keep() [1/2]

◆ get_sym_ids_of_fns_to_keep() [2/2]

◆ get_sym_ids_of_vars_to_keep() [1/2]

◆ get_sym_ids_of_vars_to_keep() [2/2]

◆ get_symtab()

◆ get_translation_units()

◆ get_type_per_loc_map() [1/2]

◆ get_type_per_loc_map() [2/2]

◆ get_types() [1/2]

◆ get_types() [2/2]

◆ get_types_not_reachable_from_public_interfaces()

◆ get_undefined_fun_symbol_map()

◆ get_undefined_var_symbol_map()

◆ get_unreferenced_function_symbols()

◆ get_unreferenced_variable_symbols()

◆ get_var_symbol_map()

◆ get_variables()

◆ is_empty()

◆ lookup_function_symbol() [1/3]

◆ lookup_function_symbol() [2/3]

◆ lookup_function_symbol() [3/3]

◆ lookup_functions()

◆ lookup_variable_symbol() [1/3]

◆ lookup_variable_symbol() [2/3]

◆ lookup_variable_symbol() [3/3]

◆ maybe_drop_some_exported_decls()

◆ operator==()

◆ record_type_as_reachable_from_public_interfaces()

◆ recording_types_reachable_from_public_interface_supported()

◆ set_architecture_name()

◆ set_format_major_version_number()

◆ set_format_minor_version_number()

◆ set_needed()

◆ set_origin()