mirror of
git://sourceware.org/git/libabigail.git
synced 2024-12-14 05:54:50 +00:00
103a6eb94f
Symbols of pretty much all member functions of types that are meant to
be "private" to translation units that contribute to libabigail.so
were exported because we didn't do much to prevent that.
This patch starts controlling the set of symbols that are exported.
By default, symbols of any entity declared in a translation unit that
contributes to libabigail.so are hidden by default. Only symbols of
entities declared in public headers (headers in include/*.h) are
exported.
There are many ways to achieve that. This patch chooses to avoid
cluttering declarations of entities in the public header by adding
__attribute__((visibility="default")) to every declared type of
function in there.
Rather, the patch uses "#pragma GCC visibility push(default)" before
entities declared on those headers. By doing so, all those entities
have their symbol marked as "visible" by the compiler. Once the
header are #included, the #pragma GCC visibility pop" is used, so that
anything else has its symbol be hidden from that point on.
Note that for ease of maintenance the patch uses the macros
ABG_BEGIN_EXPORT_DECLARATIONS and ABG_END_EXPORT_DECLARATIONS rather
than using the pragma directive directly.
I believe this is a more elegant way of handling visibility, compared
to cluttering every single declaration in public headers with a
"__attribute__((visibility=("default")))" or with a macro which
expands to it.
This reduces the the set of symbols exported by libabigail.so from
20000+ to less than 5000.
* VISIBILITY: New documentation about this visiblity business.
* CONTRIBUTING: Update the "contributing guide" to refer to symbol
visibility issues.
* configure.ac: Define a variable VISIBILITY_FLAGS that is set to
the -fvisibility=hidden flag to pass to GCC, when its available.
* src/Makefile.am: Add VISIBILITY to source distribution. Also
add COMPILING and COMMIT-LOG-GUIDELINES that were missing.
* src/Makefile.am: Use the new $(VISIBILITY_FLAGS) when buiding
the library.
* tests/Makefile.am: Use the new $(VISIBILITY_FLAGS) when buiding
tests.
* tools/Makefile.am: Use the new $(VISIBILITY_FLAGS) when buiding
tools.
* src/abg-comp-filter.cc: Enclose inclusion of public headers in
ABG_BEGIN_EXPORT_DECLARATIONS and ABG_END_EXPORT_DECLARATIONS to
export the symbols of entities declared in there.
* src/abg-comparison.cc: Likewise.
* src/abg-config.cc: Likewise.
* src/abg-corpus.cc: Likewise.
* src/abg-diff-utils.cc: Likewise.
* src/abg-dwarf-reader.cc: Likewise.
* src/abg-hash.cc: Likewise.
* src/abg-ini.cc: Likewise.
* src/abg-ir.cc: Likewise.
* src/abg-libxml-utils.cc: Likewise.
* src/abg-libzip-utils.cc: Likewise.
* src/abg-reader.cc: Likewise.
* src/abg-suppression.cc: Likewise.
* src/abg-tools-utils.cc: Likewise.
* src/abg-traverse.cc: Likewise.
* src/abg-viz-common.cc: Likewise.
* src/abg-viz-dot.cc: Likewise.
* src/abg-viz-svg.cc: Likewise.
* src/abg-workers.cc: Likewise.
* src/abg-writer.cc: Likewise.
Signed-off-by: Dodji Seketeli <dodji@redhat.com>
69 lines
2.5 KiB
Plaintext
69 lines
2.5 KiB
Plaintext
PLEASE READ ALL OF THIS FILE, ESPECIALLY IF YOU ARE DEFINING A NEW
|
|
PUBLIC HEADER IN LIBABIGAIL.
|
|
|
|
How symbols that are exported are controlled in libabigail
|
|
==========================================================
|
|
|
|
We try to limit the number of ELF symbols that are exported by the
|
|
libabigail.so shared library. We call this symbols visibility
|
|
control.
|
|
|
|
As GNU/Linux is our development platform, we control symbol visibility
|
|
by using the visibility support of the G++ compiler.
|
|
|
|
How to do so is properly explained at https://gcc.gnu.org/wiki/Visibility.
|
|
|
|
All symbols are hidden by default
|
|
=================================
|
|
|
|
When building translation units that make up the libabigail.so shared
|
|
library, G++ is invoked with the -fvisibility=hidden directive. Which
|
|
instructs it to make symbols of functions and global variables
|
|
*locally* defined in the shared library, *NOT* exported (or global).
|
|
|
|
Exporting symbols of entities declared in public headers
|
|
========================================================
|
|
|
|
In a translation unit that is part of the libabigail.so shared
|
|
library, before including a header file that is a public libabigail
|
|
header (e.g, abg-ir.h), one need to declare:
|
|
|
|
#include "abg-internal.h"
|
|
ABG_BEGIN_EXPORT_DECLARATIONS
|
|
|
|
then all the public header files inclusion (using #include directives)
|
|
follow. At the end of these public header files inclusion, one need
|
|
to declare:
|
|
|
|
ABG_END_EXPORT_DECLARATIONS
|
|
|
|
|
|
The ABG_BEGIN_EXPORT_DECLARATIONS is a macro defined in abg-internal.h
|
|
which expands to:
|
|
|
|
#pragma GCC visibility push(default)
|
|
|
|
This instructs G++ to export the symbol of all global functions and
|
|
variables definitions that are declared from that point on.
|
|
|
|
The ABG_END_EXPORT_DECLARATIONS is a macro defined in abg-internal.h
|
|
which expands to:
|
|
|
|
#pragma GCC visibility pop
|
|
|
|
It instructs G++ to stop exporting symbols of global functions and
|
|
variable definition from that point on.
|
|
|
|
In practice, the pair ABG_BEGIN_EXPORT_DECLARATIONS,
|
|
ABG_END_EXPORT_DECLARATIONS allows us to only export symbols of
|
|
global functions and variables declared in the block denoted by these
|
|
two macros. Symbols of anything else that is declared outside of that block
|
|
are going to be hidden, thanks to the -fvisibility=hidden option
|
|
passed to G++.
|
|
|
|
So whenever you are defining a new header file with declarations that
|
|
ought to be part of the API of libabigail, the *definition* file which
|
|
defines the declarations of the header file must use
|
|
the ABG_BEGIN_EXPORT_DECLARATIONS and ABG_END_EXPORT_DECLARATIONS
|
|
macro to include the public header.
|