This is an automated email from the git hooks/post-receive script. guillem pushed a commit to branch master in repository dpkg.
View the commit online: https://git.dpkg.org/cgit/dpkg/dpkg.git/commit/?id=de218c8fa0ff58fe28735104a5ad10f3999e0470 commit de218c8fa0ff58fe28735104a5ad10f3999e0470 Author: Guillem Jover <[email protected]> AuthorDate: Sat Jun 20 00:21:16 2020 +0200 Dpkg::Shlibs::SymbolFile: Avoid blacklist and whitelist terms While the terms whitelist and blacklist do not have an etymology with racial connotations, they still attribute positive and negative connotations to these colors for terms that are not explicitly descriptive of what they mean. We can use instead terms that are more descriptive, and have no negative connotations. Explicitly spell out that this is about internal symbols, and whether we allow them to appear in symbol files. Even though there do not appear to be users for the old directives in Debian, we will still do an ordered transition with deprecation warnings in case private and/or third-party users are affected. --- debian/changelog | 1 + man/deb-src-symbols.pod | 17 +++-- man/deb-symbols.pod | 13 ++-- scripts/Dpkg/Shlibs/SymbolFile.pm | 47 +++++++++---- scripts/Makefile.am | 10 +-- scripts/t/Dpkg_Shlibs.t | 80 +++++++++++----------- .../{objdump.blacklisted => objdump.internal} | 4 +- scripts/t/Dpkg_Shlibs/symbols.blacklist-filter | 3 - scripts/t/Dpkg_Shlibs/symbols.blacklist-groups | 4 -- scripts/t/Dpkg_Shlibs/symbols.blacklist-ignore | 3 - .../{symbols.blacklisted => symbols.internal} | 0 scripts/t/Dpkg_Shlibs/symbols.internal-allow | 3 + .../t/Dpkg_Shlibs/symbols.internal-allow-groups | 4 ++ scripts/t/Dpkg_Shlibs/symbols.internal-filter | 3 + 14 files changed, 111 insertions(+), 81 deletions(-) diff --git a/debian/changelog b/debian/changelog index a33b1b524..d4107d01b 100644 --- a/debian/changelog +++ b/debian/changelog @@ -47,6 +47,7 @@ dpkg (1.20.1) UNRELEASED; urgency=medium - Dpkg::Vendor::Debian: Detect merged-usr-via-symlinks also with absolute pathnames. Reported by Adam Borowski <[email protected]>. - Dpkg::Build::Info: Avoid whitelist in function name. + - Dpkg::Shlibs::SymbolFile: Avoid blacklist and whitelist terms. * Documentation: - man: Fix misused two-fonts macros. Thanks to Bjarni Ingi Gislason <[email protected]>. Closes: #955028 diff --git a/man/deb-src-symbols.pod b/man/deb-src-symbols.pod index bf183705e..ccb4da34e 100644 --- a/man/deb-src-symbols.pod +++ b/man/deb-src-symbols.pod @@ -166,14 +166,19 @@ Multiple restrictions can be chained. (arch-bits=32|arch-endian=little)32bit_le_symbol@Base 1.0 -=item B<ignore-blacklist> +=item B<allow-internal> -dpkg-gensymbols has an internal blacklist of symbols that should not +dpkg-gensymbols has a list of internal symbols that should not appear in symbols files as they are usually only side-effects of -implementation details of the toolchain. If for some reason, you really -want one of those symbols to be included in the symbols file, you should -tag the symbol with B<ignore-blacklist>. It can be necessary for -some low level toolchain libraries like “libgcc”. +implementation details of the toolchain (since dpkg 1.20.1). +If for some reason, you really want one of those symbols to be included in +the symbols file, you should tag the symbol with B<allow-internal>. +It can be necessary for some low level toolchain libraries like “libgcc”. + +=item B<ignore-blacklist> + +A deprecated alias for B<allow-internal> (since dpkg 1.20.1, +supported since dpkg 1.15.3). =item B<c++> diff --git a/man/deb-symbols.pod b/man/deb-symbols.pod index 9293c6b84..fb9ee9846 100644 --- a/man/deb-symbols.pod +++ b/man/deb-symbols.pod @@ -78,16 +78,21 @@ This field will override any B<Build-Depends-Package> field present, and is mostly useful with “-dev” packages and metapackages depending on these, say for a transition period. -=item B<Ignore-Blacklist-Groups> +=item B<Allow-Internal-Symbol-Groups> -It indicates what blacklist groups should be ignored, as a whitespace +It indicates what internal symbol groups should be ignored, as a whitespace separated list, so that the symbols contained in those groups get -included in the output file (since dpkg 1.17.6). +included in the output file (since dpkg 1.20.1). This should only be necessary for toolchain -packages providing those blacklisted symbols. The available groups are +packages providing those internal symbols. The available groups are system dependent, for ELF and GNU-based systems these are B<aeabi> and B<gomp>. +=item B<Ignore-Blacklist-Groups> + +A deprecated alias for B<Allow-Internal-Symbol-Groups> (since dpkg 1.20.1, +supported since dpkg 1.17.6). + =back =head1 EXAMPLES diff --git a/scripts/Dpkg/Shlibs/SymbolFile.pm b/scripts/Dpkg/Shlibs/SymbolFile.pm index 4b1c7ef50..d492055b4 100644 --- a/scripts/Dpkg/Shlibs/SymbolFile.pm +++ b/scripts/Dpkg/Shlibs/SymbolFile.pm @@ -34,7 +34,7 @@ use parent qw(Dpkg::Interface::Storable); no if $Dpkg::Version::VERSION ge '1.02', warnings => qw(Dpkg::Version::semantic_change::overload::bool); -my %blacklist = ( +my %internal_symbol = ( __bss_end__ => 1, # arm __bss_end => 1, # arm _bss_end__ => 1, # arm @@ -66,18 +66,18 @@ my %blacklist = ( for my $i (14 .. 31) { # Many powerpc specific symbols - $blacklist{"_restfpr_$i"} = 1; - $blacklist{"_restfpr_$i\_x"} = 1; - $blacklist{"_restgpr_$i"} = 1; - $blacklist{"_restgpr_$i\_x"} = 1; - $blacklist{"_savefpr_$i"} = 1; - $blacklist{"_savegpr_$i"} = 1; + $internal_symbol{"_restfpr_$i"} = 1; + $internal_symbol{"_restfpr_$i\_x"} = 1; + $internal_symbol{"_restgpr_$i"} = 1; + $internal_symbol{"_restgpr_$i\_x"} = 1; + $internal_symbol{"_savefpr_$i"} = 1; + $internal_symbol{"_savegpr_$i"} = 1; } -sub symbol_is_blacklisted { +sub symbol_is_internal { my ($symbol, $include_groups) = @_; - return 1 if exists $blacklist{$symbol}; + return 1 if exists $internal_symbol{$symbol}; # The ARM Embedded ABI spec states symbols under this namespace as # possibly appearing in output objects. @@ -400,8 +400,7 @@ sub find_matching_pattern { # merge_symbols($object, $minver) # Needs $Objdump->get_object($soname) as parameter -# Don't merge blacklisted symbols related to the internal (arch-specific) -# machinery +# Do not merge symbols found in the list of (arch-specific) internal symbols. sub merge_symbols { my ($self, $object, $minver) = @_; @@ -410,7 +409,15 @@ sub merge_symbols { unless $soname; my %include_groups = (); - my $groups = $self->get_field($soname, 'Ignore-Blacklist-Groups'); + my $groups = $self->get_field($soname, 'Allow-Internal-Symbol-Groups'); + if (not defined $groups) { + $groups = $self->get_field($soname, 'Ignore-Blacklist-Groups'); + if (defined $groups) { + warnings::warnif('deprecated', + 'symbols file field "Ignore-Blacklist-Groups" is deprecated, ' . + 'use "Allow-Internal-Symbol-Groups" instead'); + } + } if (defined $groups) { $include_groups{$_} = 1 foreach (split ' ', $groups); } @@ -420,8 +427,20 @@ sub merge_symbols { my $name = $sym->{name} . '@' . ($sym->{version} ? $sym->{version} : 'Base'); my $symobj = $self->lookup_symbol($name, $soname); - if (symbol_is_blacklisted($sym->{name}, \%include_groups)) { - next unless (defined $symobj and $symobj->has_tag('ignore-blacklist')); + if (symbol_is_internal($sym->{name}, \%include_groups)) { + next unless defined $symobj; + + if ($symobj->has_tag('allow-internal')) { + # Allow the symbol. + } elsif ($symobj->has_tag('ignore-blacklist')) { + # Allow the symbol and warn. + warnings::warnif('deprecated', + 'symbol tag "ignore-blacklist" is deprecated, ' . + 'use "allow-internal" instead'); + } else { + # Ignore the symbol. + next; + } } $dynsyms{$name} = $sym; } diff --git a/scripts/Makefile.am b/scripts/Makefile.am index d7b7d856e..c71d902dc 100644 --- a/scripts/Makefile.am +++ b/scripts/Makefile.am @@ -266,10 +266,10 @@ test_data = \ t/Dpkg_OpenPGP/package_1.0.orig.tar \ t/Dpkg_OpenPGP/package_1.0.orig.tar.asc \ t/Dpkg_OpenPGP/package_1.0.orig.tar.sig \ - t/Dpkg_Shlibs/symbols.blacklisted \ - t/Dpkg_Shlibs/symbols.blacklist-groups \ - t/Dpkg_Shlibs/symbols.blacklist-filter \ - t/Dpkg_Shlibs/symbols.blacklist-ignore \ + t/Dpkg_Shlibs/symbols.internal \ + t/Dpkg_Shlibs/symbols.internal-allow \ + t/Dpkg_Shlibs/symbols.internal-allow-groups \ + t/Dpkg_Shlibs/symbols.internal-filter \ t/Dpkg_Shlibs/symbols.fake-1 \ t/Dpkg_Shlibs/symbols.fake-2 \ t/Dpkg_Shlibs/symbols.fake-3 \ @@ -291,7 +291,7 @@ test_data = \ t/Dpkg_Shlibs/objdump.basictags-amd64 \ t/Dpkg_Shlibs/objdump.basictags-i386 \ t/Dpkg_Shlibs/objdump.basictags-mips \ - t/Dpkg_Shlibs/objdump.blacklisted \ + t/Dpkg_Shlibs/objdump.internal \ t/Dpkg_Shlibs/objdump.patterns \ t/Dpkg_Shlibs/objdump.glib-ia64 \ t/Dpkg_Shlibs/objdump.libc6-2.3 \ diff --git a/scripts/t/Dpkg_Shlibs.t b/scripts/t/Dpkg_Shlibs.t index a2b892d74..c1d24d3e7 100644 --- a/scripts/t/Dpkg_Shlibs.t +++ b/scripts/t/Dpkg_Shlibs.t @@ -161,7 +161,7 @@ ok( $sym_file->get_new_symbols($sym_file_old), 'has new symbols' ); ok( $sym_file_old->get_lost_symbols($sym_file), 'has lost symbols' ); is( $sym_file_old->lookup_symbol('__bss_start@Base', ['libc.so.6']), - undef, 'internal symbols are blacklisted' ); + undef, 'internal symbols are ignored' ); %tmp = $sym_file->lookup_symbol('_errno@GLIBC_2.0', ['libc.so.6'], 1); isa_ok($tmp{symbol}, 'Dpkg::Shlibs::Symbol'); @@ -205,84 +205,84 @@ sub save_load_test { save_load_test( $sym_file, 'save -> load' ); -# Test ignoring blacklisted symbols -open $objdump, '<', "$datadir/objdump.blacklisted" - or die "objdump.blacklisted: $!"; +# Test ignoring internal symbols +open $objdump, '<', "$datadir/objdump.internal" + or die "objdump.internal: $!"; $obj->reset(); $obj->parse_objdump_output($objdump); close $objdump; -# Do not ignore any blacklist -$sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.blacklist-filter"); +# Do not ignore any internal symbols +$sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.internal-filter"); $sym_file->merge_symbols($obj, '100.MISSING'); -$sym = $sym_file->lookup_symbol('symbol@Base', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('symbol@Base', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol@Base', minver => '1.0', dep_id => 0, deprecated => 0), - 'symbol unaffected w/o ignoring blacklists'); + 'symbol unaffected w/o including internal symbols'); -$sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libblacklisted.so.0']); -is($sym, undef, 'gomp symbol omitted while filtering on blacklists'); +$sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libinternal.so.0']); +is($sym, undef, 'gomp symbol omitted while filtering internal symbols'); -$sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libblacklisted.so.0']); -is($sym, undef, 'known aeabi symbol omitted while filtering on blacklists'); +$sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libinternal.so.0']); +is($sym, undef, 'known aeabi symbol omitted while filtering internal symbols'); -$sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libblacklisted.so.0']); -is($sym, undef, 'unknown aeabi symbol omitted while filtering on blacklists'); +$sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libinternal.so.0']); +is($sym, undef, 'unknown aeabi symbol omitted while filtering internal symbols'); -# Ignore blacklists using the ignore-blacklists symbol tag -$sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.blacklist-ignore"); +# Include internal symbols using the allow-internal tag. +$sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.internal-allow"); $sym_file->merge_symbols($obj, '100.MISSING'); -$sym = $sym_file->lookup_symbol('symbol@Base', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('symbol@Base', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol@Base', minver => '1.0', dep_id => 0, deprecated => 0), - 'symbol unaffected while ignoring blacklists via symbol tag'); + 'symbol unaffected while including internal symbols via symbol tag'); -$sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '.gomp_critical_user_foo@Base', minver => '2.0', dep_id => 0, deprecated => 0, - tags => { 'ignore-blacklist' => undef }, - tagorder => [ 'ignore-blacklist' ]), - 'blacklisted gomp symbol included via symbol tag'); + tags => { 'allow-internal' => undef }, + tagorder => [ 'allow-internal' ]), + 'internal gomp symbol included via symbol tag'); -$sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__aeabi_lcmp@GCC_3.0', minver => '3.0', dep_id => 0, deprecated => 0, - tags => { 'ignore-blacklist' => undef }, - tagorder => [ 'ignore-blacklist' ]), - 'blacklisted known aeabi symbol included via symbol tag'); + tags => { 'allow-internal' => undef }, + tagorder => [ 'allow-internal' ]), + 'internal known aeabi symbol included via symbol tag'); -$sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__aeabi_unknown@GCC_4.0', minver => '4.0', dep_id => 0, deprecated => 0, - tags => { 'ignore-blacklist' => undef }, - tagorder => [ 'ignore-blacklist' ]), - 'blacklisted unknown aeabi symbol omitted via symbol tag'); + tags => { 'allow-internal' => undef }, + tagorder => [ 'allow-internal' ]), + 'internal unknown aeabi symbol omitted via symbol tag'); -# Ignore blacklists using the Ignore-Blacklist-Groups field -$sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.blacklist-groups"); +# Include internal symbols using the Allow-Internal-Symbol-Groups field +$sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.internal-allow-groups"); $sym_file->merge_symbols($obj, '100.MISSING'); -$sym = $sym_file->lookup_symbol('symbol@Base', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('symbol@Base', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol@Base', minver => '1.0', dep_id => 0, deprecated => 0), - 'symbol unaffected w/o ignoring blacklists'); + 'symbol unaffected w/o including internal symbols'); -$sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '.gomp_critical_user_foo@Base', minver => '2.0', dep_id => 0, deprecated => 0), - 'blacklisted gomp symbol included via library field'); + 'internal gomp symbol included via library field'); -$sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__aeabi_lcmp@GCC_3.0', minver => '3.0', dep_id => 0, deprecated => 0), - 'blacklisted known aeabi symbol included via library field'); + 'internal known aeabi symbol included via library field'); -$sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libblacklisted.so.0']); +$sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libinternal.so.0']); is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__aeabi_unknown@GCC_4.0', minver => '4.0', dep_id => 0, deprecated => 0), - 'blacklisted unknown aeabi symbol included via library field'); + 'internal unknown aeabi symbol included via library field'); # Test include mechanism of SymbolFile diff --git a/scripts/t/Dpkg_Shlibs/objdump.blacklisted b/scripts/t/Dpkg_Shlibs/objdump.internal similarity index 82% rename from scripts/t/Dpkg_Shlibs/objdump.blacklisted rename to scripts/t/Dpkg_Shlibs/objdump.internal index 2db4e7507..c492a54e2 100644 --- a/scripts/t/Dpkg_Shlibs/objdump.blacklisted +++ b/scripts/t/Dpkg_Shlibs/objdump.internal @@ -1,11 +1,11 @@ -libblacklisted.so.0: file format elf32-littlearm +libinternal.so.0: file format elf32-littlearm architecture: arm, flags 0x00000150: HAS_SYMS, DYNAMIC, D_PAGED start address 0x0000f668 Dynamic Section: - SONAME libblacklisted.so.0 + SONAME libinternal.so.0 DYNAMIC SYMBOL TABLE: 00018ef4 g DF .text 00000008 Base .gomp_critical_user_foo diff --git a/scripts/t/Dpkg_Shlibs/symbols.blacklist-filter b/scripts/t/Dpkg_Shlibs/symbols.blacklist-filter deleted file mode 100644 index f66ab2311..000000000 --- a/scripts/t/Dpkg_Shlibs/symbols.blacklist-filter +++ /dev/null @@ -1,3 +0,0 @@ -libblacklisted.so.0 libblacklisted0 #MINVER# -#include "symbols.blacklisted" - symbol@Base 1.0 diff --git a/scripts/t/Dpkg_Shlibs/symbols.blacklist-groups b/scripts/t/Dpkg_Shlibs/symbols.blacklist-groups deleted file mode 100644 index 4d3f270e9..000000000 --- a/scripts/t/Dpkg_Shlibs/symbols.blacklist-groups +++ /dev/null @@ -1,4 +0,0 @@ -libblacklisted.so.0 libblacklisted0 #MINVER# -* Ignore-Blacklist-Groups: aeabi gomp -#include "symbols.blacklisted" - symbol@Base 1.0 diff --git a/scripts/t/Dpkg_Shlibs/symbols.blacklist-ignore b/scripts/t/Dpkg_Shlibs/symbols.blacklist-ignore deleted file mode 100644 index 9879c12dd..000000000 --- a/scripts/t/Dpkg_Shlibs/symbols.blacklist-ignore +++ /dev/null @@ -1,3 +0,0 @@ -libblacklisted.so.0 libblacklisted0 #MINVER# -(ignore-blacklist)#include "symbols.blacklisted" - symbol@Base 1.0 diff --git a/scripts/t/Dpkg_Shlibs/symbols.blacklisted b/scripts/t/Dpkg_Shlibs/symbols.internal similarity index 100% rename from scripts/t/Dpkg_Shlibs/symbols.blacklisted rename to scripts/t/Dpkg_Shlibs/symbols.internal diff --git a/scripts/t/Dpkg_Shlibs/symbols.internal-allow b/scripts/t/Dpkg_Shlibs/symbols.internal-allow new file mode 100644 index 000000000..ea40815d7 --- /dev/null +++ b/scripts/t/Dpkg_Shlibs/symbols.internal-allow @@ -0,0 +1,3 @@ +libinternal.so.0 libinternal0 #MINVER# +(allow-internal)#include "symbols.internal" + symbol@Base 1.0 diff --git a/scripts/t/Dpkg_Shlibs/symbols.internal-allow-groups b/scripts/t/Dpkg_Shlibs/symbols.internal-allow-groups new file mode 100644 index 000000000..e4492ecb5 --- /dev/null +++ b/scripts/t/Dpkg_Shlibs/symbols.internal-allow-groups @@ -0,0 +1,4 @@ +libinternal.so.0 libinternal0 #MINVER# +* Allow-Internal-Symbol-Groups: aeabi gomp +#include "symbols.internal" + symbol@Base 1.0 diff --git a/scripts/t/Dpkg_Shlibs/symbols.internal-filter b/scripts/t/Dpkg_Shlibs/symbols.internal-filter new file mode 100644 index 000000000..26e902fa4 --- /dev/null +++ b/scripts/t/Dpkg_Shlibs/symbols.internal-filter @@ -0,0 +1,3 @@ +libinternal.so.0 libinternal0 #MINVER# +#include "symbols.internal" + symbol@Base 1.0 -- Dpkg.Org's dpkg
