3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 2 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <https://www.gnu.org/licenses/>.
20 use Test::Dpkg qw(:needs :paths);
24 test_needs_module('IO::String');
28 use Dpkg::Path qw(find_command);
30 use_ok('Dpkg::Shlibs');
36 my $datadir = test_get_data_path('t/Dpkg_Shlibs');
41 # XXX: Keep as long as we support the deprecated LD_LIBRARY_PATH.
42 local $ENV{LD_LIBRARY_PATH} = '/test-env';
44 Dpkg::Shlibs::add_library_dir('/test-a');
45 @librarypaths = Dpkg::Shlibs::get_library_paths();
46 is($librarypaths[0], '/test-a', 'add_library_dir() does not get lost');
48 Dpkg::Shlibs::add_library_dir('/test-b');
49 @librarypaths = Dpkg::Shlibs::get_library_paths();
50 is_deeply([ @librarypaths[0, 1] ] , [ '/test-a', '/test-b' ],
51 'add_library_dir() prepends');
54 Dpkg::Shlibs::blank_library_paths();
56 # We want relative paths inside the ld.so.conf fragments to work, and $srcdir
57 # is usually a relative path, so let's temporarily switch directory.
58 # XXX: An alternative would be to make parse_ldso_conf relative path aware.
60 test_needs_srcdir_switch();
61 Dpkg::Shlibs::parse_ldso_conf('t/Dpkg_Shlibs/ld.so.conf');
64 @librarypaths = Dpkg::Shlibs::get_library_paths();
65 is_deeply(\@librarypaths,
66 [ qw(/nonexistent32 /nonexistent/lib64
67 /usr/local/lib /nonexistent/lib128) ], 'parsed library paths');
69 use_ok('Dpkg::Shlibs::Objdump');
71 my $obj = Dpkg::Shlibs::Objdump::Object->new;
73 open my $objdump, '<', "$datadir/objdump.dbd-pg"
74 or die "$datadir/objdump.dbd-pg: $!";
75 $obj->parse_objdump_output($objdump);
77 ok(!$obj->is_public_library(), 'Pg.so is not a public library');
78 ok(!$obj->is_executable(), 'Pg.so is not an executable');
80 open $objdump, '<', "$datadir/objdump.ls"
81 or die "$datadir/objdump.ls: $!";
83 $obj->parse_objdump_output($objdump);
85 ok(!$obj->is_public_library(), 'ls is not a public library');
86 ok($obj->is_executable(), 'ls is an executable');
88 my $sym = $obj->get_symbol('optarg@GLIBC_2.0');
89 ok($sym, 'optarg@GLIBC_2.0 exists');
90 ok(!$sym->{defined}, 'R_*_COPY relocations are taken into account');
92 open $objdump, '<', "$datadir/objdump.space"
93 or die "$datadir/objdump.space: $!";
95 $obj->parse_objdump_output($objdump);
98 # Non-regression test for #506139
99 $sym = $obj->get_symbol('singlespace');
100 ok($sym, 'version less symbol separated by a single space are correctly parsed');
102 open $objdump, '<', "$datadir/objdump.libc6-2.6"
103 or die "$datadir/objdump.libc6-2.6: $!";
105 $obj->parse_objdump_output($objdump);
108 ok($obj->is_public_library(), 'libc6 is a public library');
109 ok(!$obj->is_executable(), 'libc6 is not an executable');
111 is($obj->{SONAME}, 'libc.so.6', 'SONAME');
112 is($obj->{HASH}, '0x13d99c', 'HASH');
113 is($obj->{GNU_HASH}, '0x194', 'GNU_HASH');
114 is($obj->{format}, 'elf32-i386', 'format');
115 is_deeply($obj->{flags}, { DYNAMIC => 1, HAS_SYMS => 1, D_PAGED => 1 }, 'flags');
116 is_deeply($obj->{NEEDED}, [ 'ld-linux.so.2' ], 'NEEDED');
117 is_deeply([ $obj->get_needed_libraries ], [ 'ld-linux.so.2' ], 'NEEDED');
119 $sym = $obj->get_symbol('_sys_nerr@GLIBC_2.3');
120 is_deeply( $sym, { name => '_sys_nerr', version => 'GLIBC_2.3',
121 soname => 'libc.so.6', objid => 'libc.so.6',
122 section => '.rodata', dynamic => 1,
123 debug => '', type => 'O', weak => '',
124 local => '', global => 1, visibility => '',
125 hidden => 1, defined => 1 }, 'Symbol' );
126 $sym = $obj->get_symbol('_IO_stdin_used');
127 is_deeply( $sym, { name => '_IO_stdin_used', version => '',
128 soname => 'libc.so.6', objid => 'libc.so.6',
129 section => '*UND*', dynamic => 1,
130 debug => '', type => ' ', weak => 1,
131 local => '', global => '', visibility => '',
132 hidden => '', defined => '' }, 'Symbol 2' );
134 my @syms = $obj->get_exported_dynamic_symbols;
135 is( scalar @syms, 2231, 'defined && dynamic' );
136 @syms = $obj->get_undefined_dynamic_symbols;
137 is( scalar @syms, 9, 'undefined && dynamic' );
140 my $obj_old = Dpkg::Shlibs::Objdump::Object->new;
142 open $objdump, '<', "$datadir/objdump.libc6-2.3"
143 or die "$datadir/objdump.libc6-2.3: $!";
144 $obj_old->parse_objdump_output($objdump);
148 use_ok('Dpkg::Shlibs::SymbolFile');
149 use_ok('Dpkg::Shlibs::Symbol');
151 my $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbol_file.tmp");
152 my $sym_file_dup = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbol_file.tmp");
153 my $sym_file_old = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbol_file.tmp");
155 $sym_file->merge_symbols($obj_old, '2.3.6.ds1-13');
156 $sym_file_old->merge_symbols($obj_old, '2.3.6.ds1-13');
158 ok( $sym_file->has_object('libc.so.6'), 'SONAME in sym file' );
160 $sym_file->merge_symbols($obj, '2.6-1');
162 ok( $sym_file->get_new_symbols($sym_file_old), 'has new symbols' );
163 ok( $sym_file_old->get_lost_symbols($sym_file), 'has lost symbols' );
165 is( $sym_file_old->lookup_symbol('__bss_start@Base', ['libc.so.6']),
166 undef, 'internal symbols are blacklisted' );
168 %tmp = $sym_file->lookup_symbol('_errno@GLIBC_2.0', ['libc.so.6'], 1);
169 isa_ok($tmp{symbol}, 'Dpkg::Shlibs::Symbol');
170 is_deeply(\%tmp, { symbol => Dpkg::Shlibs::Symbol->new(symbol => '_errno@GLIBC_2.0',
171 minver => '2.3.6.ds1-13', dep_id => 0,
172 deprecated => '2.6-1'), soname => 'libc.so.6' },
173 'deprecated symbol');
176 my $pat = $sym_file_old->create_symbol('*@GLIBC_PRIVATE 2.3.6.wildcard');
177 $sym_file_old->add_symbol($pat, 'libc.so.6');
178 $sym_file_old->merge_symbols($obj, '2.6-1');
179 $sym = $sym_file_old->lookup_symbol('__nss_services_lookup@GLIBC_PRIVATE', 'libc.so.6');
180 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__nss_services_lookup@GLIBC_PRIVATE',
181 minver => '2.3.6.wildcard', dep_id => 0, deprecated => 0,
182 tags => { symver => undef, optional => undef },
183 tagorder => [ 'symver', 'optional' ],
184 matching_pattern => $pat ), 'wildcarded symbol');
188 use File::Basename qw(basename);
191 my ($symfile, $comment, @opts) = @_;
193 my $save_file = File::Temp->new();
194 $symfile->save($save_file->filename, @opts);
195 my $dup = Dpkg::Shlibs::SymbolFile->new(file => $save_file->filename);
196 # Force sync of non-stored attributes
197 $dup->{file} = $symfile->{file};
198 $dup->{arch} = $symfile->{arch};
200 is_deeply($dup, $symfile, $comment);
201 if (-f $symfile->{file}) {
202 is(system('diff', '-u', $symfile->{file}, $save_file->filename), 0,
203 basename($symfile->{file}) . ' dumped identical');
207 save_load_test( $sym_file, 'save -> load' );
210 # Test ignoring blacklisted symbols
211 open $objdump, '<', "$datadir/objdump.blacklisted"
212 or die "objdump.blacklisted: $!";
214 $obj->parse_objdump_output($objdump);
217 # Do not ignore any blacklist
218 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.blacklist-filter");
219 $sym_file->merge_symbols($obj, '100.MISSING');
221 $sym = $sym_file->lookup_symbol('symbol@Base', ['libblacklisted.so.0']);
222 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol@Base',
223 minver => '1.0', dep_id => 0, deprecated => 0),
224 'symbol unaffected w/o ignoring blacklists');
226 $sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libblacklisted.so.0']);
227 is($sym, undef, 'gomp symbol omitted while filtering on blacklists');
229 $sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libblacklisted.so.0']);
230 is($sym, undef, 'known aeabi symbol omitted while filtering on blacklists');
232 $sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libblacklisted.so.0']);
233 is($sym, undef, 'unknown aeabi symbol omitted while filtering on blacklists');
235 # Ignore blacklists using the ignore-blacklists symbol tag
236 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.blacklist-ignore");
237 $sym_file->merge_symbols($obj, '100.MISSING');
239 $sym = $sym_file->lookup_symbol('symbol@Base', ['libblacklisted.so.0']);
240 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol@Base',
241 minver => '1.0', dep_id => 0, deprecated => 0),
242 'symbol unaffected while ignoring blacklists via symbol tag');
244 $sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libblacklisted.so.0']);
245 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '.gomp_critical_user_foo@Base',
246 minver => '2.0', dep_id => 0, deprecated => 0,
247 tags => { 'ignore-blacklist' => undef },
248 tagorder => [ 'ignore-blacklist' ]),
249 'blacklisted gomp symbol included via symbol tag');
251 $sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libblacklisted.so.0']);
252 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__aeabi_lcmp@GCC_3.0',
253 minver => '3.0', dep_id => 0, deprecated => 0,
254 tags => { 'ignore-blacklist' => undef },
255 tagorder => [ 'ignore-blacklist' ]),
256 'blacklisted known aeabi symbol included via symbol tag');
258 $sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libblacklisted.so.0']);
259 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__aeabi_unknown@GCC_4.0',
260 minver => '4.0', dep_id => 0, deprecated => 0,
261 tags => { 'ignore-blacklist' => undef },
262 tagorder => [ 'ignore-blacklist' ]),
263 'blacklisted unknown aeabi symbol omitted via symbol tag');
265 # Ignore blacklists using the Ignore-Blacklist-Groups field
266 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.blacklist-groups");
267 $sym_file->merge_symbols($obj, '100.MISSING');
269 $sym = $sym_file->lookup_symbol('symbol@Base', ['libblacklisted.so.0']);
270 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol@Base',
271 minver => '1.0', dep_id => 0, deprecated => 0),
272 'symbol unaffected w/o ignoring blacklists');
274 $sym = $sym_file->lookup_symbol('.gomp_critical_user_foo@Base', ['libblacklisted.so.0']);
275 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '.gomp_critical_user_foo@Base',
276 minver => '2.0', dep_id => 0, deprecated => 0),
277 'blacklisted gomp symbol included via library field');
279 $sym = $sym_file->lookup_symbol('__aeabi_lcmp@GCC_3.0', ['libblacklisted.so.0']);
280 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__aeabi_lcmp@GCC_3.0',
281 minver => '3.0', dep_id => 0, deprecated => 0),
282 'blacklisted known aeabi symbol included via library field');
284 $sym = $sym_file->lookup_symbol('__aeabi_unknown@GCC_4.0', ['libblacklisted.so.0']);
285 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => '__aeabi_unknown@GCC_4.0',
286 minver => '4.0', dep_id => 0, deprecated => 0),
287 'blacklisted unknown aeabi symbol included via library field');
290 # Test include mechanism of SymbolFile
291 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.include-1");
293 $sym = $sym_file->lookup_symbol('symbol_before@Base', ['libfake.so.1']);
294 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol_before@Base',
295 minver => '0.9', dep_id => 0, deprecated => 0),
296 'symbol before include not lost');
298 $sym = $sym_file->lookup_symbol('symbol_after@Base', ['libfake.so.1']);
299 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol_after@Base',
300 minver => '1.1', dep_id => 0, deprecated => 0),
301 'symbol after include not lost');
303 $sym = $sym_file->lookup_symbol('symbol1_fake1@Base', ['libfake.so.1']);
304 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol1_fake1@Base',
305 minver => '1.0', dep_id => 0, deprecated => 0),
306 'overrides order with #include');
308 $sym = $sym_file->lookup_symbol('symbol3_fake1@Base', ['libfake.so.1']);
309 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol3_fake1@Base',
310 minver => '0', dep_id => 0, deprecated => 0),
311 'overrides order with #include');
313 is($sym_file->get_smallest_version('libfake.so.1'), '0',
314 'get_smallest_version with null version');
316 $sym = $sym_file->lookup_symbol('symbol_in_libdivert@Base', ['libdivert.so.1']);
317 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol_in_libdivert@Base',
318 minver => '1.0~beta1', dep_id => 0, deprecated => 0),
319 '#include can change current object');
321 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.include-2");
323 $sym = $sym_file->lookup_symbol('symbol1_fake2@Base', ['libfake.so.1']);
324 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol1_fake2@Base',
325 minver => '1.0', dep_id => 1, deprecated => 0),
326 'overrides order with circular #include');
328 is($sym_file->get_smallest_version('libfake.so.1'), '1.0',
329 'get_smallest_version');
332 my $io = IO::String->new();
333 $sym_file->output($io, package => 'libfake1');
334 is(${$io->string_ref()},
335 'libfake.so.1 libfake1 #MINVER#
337 * Build-Depends-Package: libfake-dev
338 symbol1_fake2@Base 1.0 1
339 symbol2_fake2@Base 1.0
340 symbol3_fake2@Base 1.1
341 ', "Dump of $datadir/symbols.include-2");
344 # Check parsing of objdump output on ia64 (local symbols
345 # without versions and with visibility attribute)
346 $obj = Dpkg::Shlibs::Objdump::Object->new;
348 open $objdump, '<', "$datadir/objdump.glib-ia64"
349 or die "$datadir/objdump.glib-ia64: $!";
350 $obj->parse_objdump_output($objdump);
353 $sym = $obj->get_symbol('IA__g_free');
354 is_deeply( $sym, { name => 'IA__g_free', version => '',
355 soname => 'libglib-2.0.so.0', objid => 'libglib-2.0.so.0',
356 section => '.text', dynamic => 1,
357 debug => '', type => 'F', weak => '',
358 local => 1, global => '', visibility => 'hidden',
359 hidden => '', defined => 1 },
360 'symbol with visibility without version' );
362 # Check parsing of objdump output when symbol names contain spaces
363 $obj = Dpkg::Shlibs::Objdump::Object->new;
365 open $objdump, '<', "$datadir/objdump.spacesyms"
366 or die "$datadir/objdump.spacesyms: $!";
367 $obj->parse_objdump_output($objdump);
371 my ($name, $version, $visibility) = @_;
374 $sym = $obj->get_symbol($name . "@" . $version);
375 is_deeply($sym, { name => $name, version => $version,
376 soname => 'libspacesyms.so.1',
377 objid => 'libspacesyms.so.1',
378 section => '.text', dynamic => 1,
379 debug => '', type => 'F', weak => '',
380 local => '', global => 1, visibility => $visibility,
381 hidden => '', defined => 1 }, $name);
382 ok(defined $obj->{dynrelocs}{$name}, "dynreloc found for $name");
385 check_spacesym('symdefaultvernospacedefault', 'Base');
386 check_spacesym('symdefaultvernospaceprotected', 'Base', 'protected');
387 check_spacesym('symlongvernospacedefault', 'VERY_LONG_VERSION_1');
388 check_spacesym('symlongvernospaceprotected', 'VERY_LONG_VERSION_1', 'protected');
389 check_spacesym('symshortvernospacedefault', 'V1');
390 check_spacesym('symshortvernospaceprotected', 'V1', 'protected');
391 check_spacesym('symdefaultverSPA CEdefault', 'Base');
392 check_spacesym('symdefaultverSPA CEprotected', 'Base', 'protected');
393 check_spacesym('symlongverSPA CEdefault', 'VERY_LONG_VERSION_1');
394 check_spacesym('symlongverSPA CEprotected', 'VERY_LONG_VERSION_1', 'protected');
395 check_spacesym('symshortverSPA CEdefault', 'V1');
396 check_spacesym('symshortverSPA CEprotected', 'V1', 'protected');
398 ####### Test symbol tagging support ######
402 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/basictags.symbols", arch => 'amd64');
403 save_load_test($sym_file, 'template save -> load', template_mode => 1);
405 # Dumping in non-template mode (amd64) (test for arch tags)
406 $io = IO::String->new();
407 $sym_file->output($io);
408 is(${$io->string_ref()},
409 'libbasictags.so.1 libbasictags1 #MINVER#
410 | libbasictags1 (>= 1.1)
411 symbol11_optional@Base 1.1 1
412 symbol21_amd64@Base 2.1
414 symbol26_little@Base 2.6
415 symbol31_randomtag@Base 3.1
416 symbol51_untagged@Base 5.1
417 ', 'template vs. non-template on amd64');
419 # Dumping in non-template mode (mips) (test for arch tags)
420 $io = IO::String->new();
421 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/basictags.symbols", arch => 'mips');
422 $sym_file->output($io);
423 is(${$io->string_ref()},
424 'libbasictags.so.1 libbasictags1 #MINVER#
425 | libbasictags1 (>= 1.1)
426 symbol11_optional@Base 1.1 1
427 symbol23_mips@Base 2.3
429 symbol27_big@Base 2.7
430 symbol31_randomtag@Base 3.1
431 symbol42_mips_and_optional@Base 4.2
432 symbol51_untagged@Base 5.1
433 ', 'template vs. non-template on mips');
435 # Dumping in non-template mode (i386) (test for arch tags)
436 $io = IO::String->new();
437 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/basictags.symbols", arch => 'i386');
438 $sym_file_dup = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/basictags.symbols", arch => 'i386');
439 $sym_file->output($io);
440 is(${$io->string_ref()},
441 'libbasictags.so.1 libbasictags1 #MINVER#
442 | libbasictags1 (>= 1.1)
443 symbol11_optional@Base 1.1 1
444 symbol22_i386@Base 2.2
446 symbol26_little@Base 2.6
447 symbol28_little_32@Base 2.8
448 symbol31_randomtag@Base 3.1
449 symbol41_i386_and_optional@Base 4.1
450 symbol51_untagged@Base 5.1
451 ', 'template vs. non-template on i386');
453 ok (defined $sym_file->{objects}{'libbasictags.so.1'}{syms}{'symbol21_amd64@Base'},
454 'syms keys are symbol names without quotes');
457 my $tags_obj_i386 = Dpkg::Shlibs::Objdump::Object->new();
458 open $objdump, '<', "$datadir/objdump.basictags-i386"
459 or die "$datadir/objdump.basictags-i386: $!";
460 $tags_obj_i386->parse_objdump_output($objdump);
462 $sym_file->merge_symbols($tags_obj_i386, '100.MISSING');
463 is_deeply($sym_file, $sym_file_dup, 'is objdump.basictags-i386 and basictags.symbols in sync');
465 my $tags_obj_amd64 = Dpkg::Shlibs::Objdump::Object->new();
466 open $objdump, '<', "$datadir/objdump.basictags-amd64"
467 or die "$datadir/objdump.basictags-amd64: $!";
468 $tags_obj_amd64->parse_objdump_output($objdump);
471 # Merge/get_{new,lost} tests for optional tag:
473 my $symbol11 = $tags_obj_i386->get_symbol('symbol11_optional@Base');
474 delete $tags_obj_i386->{dynsyms}{'symbol11_optional@Base'};
475 $sym_file->merge_symbols($tags_obj_i386, '100.MISSING');
477 $sym = $sym_file->lookup_symbol('symbol11_optional@Base', ['libbasictags.so.1'], 1);
478 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol11_optional@Base',
479 symbol_templ => 'symbol11_optional@Base',
480 minver => '1.1', dep_id => 1, deprecated => '100.MISSING',
481 tags => { optional => undef }, tagorder => [ 'optional' ]),
482 'disappered optional symbol gets deprecated');
484 $sym_file->merge_symbols($tags_obj_i386, '101.MISSING');
485 $sym = $sym_file->lookup_symbol('symbol11_optional@Base', ['libbasictags.so.1'], 1);
486 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol11_optional@Base',
487 symbol_templ => 'symbol11_optional@Base',
488 minver => '1.1', dep_id => 1, deprecated => '101.MISSING',
489 tags => { optional => undef }, tagorder => [ 'optional' ]),
490 'deprecated text of MISSING optional symbol gets rebumped each merge');
492 is( scalar($sym_file->get_lost_symbols($sym_file_dup)), 0, 'missing optional symbol is not LOST');
494 # - reappeared (undeprecate, minver should be 1.1, not 100.MISSED)
495 $tags_obj_i386->add_dynamic_symbol($symbol11);
496 $sym_file->merge_symbols($tags_obj_i386, '100.MISSING');
497 $sym = $sym_file->lookup_symbol('symbol11_optional@Base', ['libbasictags.so.1']);
498 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol11_optional@Base',
499 symbol_templ => 'symbol11_optional@Base',
500 minver => '1.1', dep_id => 1, deprecated => 0,
501 tags => { optional => undef }, tagorder => [ 'optional' ]),
502 'reappeared optional symbol gets undeprecated + minver');
503 is( scalar($sym_file->get_lost_symbols($sym_file_dup) +
504 $sym_file->get_new_symbols($sym_file_dup)), 0, 'reappeared optional symbol: neither NEW nor LOST');
506 # Merge/get_{new,lost} tests for arch tag:
507 # - arch specific appears on wrong arch: 'arch' tag should be removed
508 my $symbol21 = $tags_obj_amd64->get_symbol('symbol21_amd64@Base');
509 $tags_obj_i386->add_dynamic_symbol($symbol21);
510 $sym_file->merge_symbols($tags_obj_i386, '100.MISSING');
511 $sym = $sym_file->lookup_symbol('symbol21_amd64@Base', ['libbasictags.so.1']);
512 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol21_amd64@Base',
513 symbol_templ => 'symbol21_amd64@Base', symbol_quoted => "'",
514 minver => '2.1', dep_id => 0, deprecated => 0),
515 'symbol appears on foreign arch, arch tag should be removed');
516 @tmp = map { $_->{symbol}->get_symbolname() } $sym_file->get_new_symbols($sym_file_dup);
517 is_deeply( \@tmp, [ 'symbol21_amd64@Base' ], 'symbol from foreign arch is NEW');
518 is( $sym->get_symbolspec(1), ' symbol21_amd64@Base 2.1', 'no tags => no quotes in the symbol name' );
520 # - arch specific symbol disappears
521 delete $tags_obj_i386->{dynsyms}{'symbol22_i386@Base'};
522 delete $tags_obj_i386->{dynsyms}{'symbol24_32@Base'};
523 delete $tags_obj_i386->{dynsyms}{'symbol26_little@Base'};
524 delete $tags_obj_i386->{dynsyms}{'symbol28_little_32@Base'};
525 delete $tags_obj_i386->{dynsyms}{'symbol41_i386_and_optional@Base'};
526 $sym_file->merge_symbols($tags_obj_i386, '100.MISSING');
528 $sym = $sym_file->lookup_symbol('symbol22_i386@Base', ['libbasictags.so.1'], 1);
529 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol22_i386@Base',
530 symbol_templ => 'symbol22_i386@Base',
531 minver => '2.2', dep_id => 0, deprecated => '100.MISSING',
532 tags => { arch => '!amd64 !ia64 !mips' },
533 tagorder => [ 'arch' ]),
534 'disappeared arch specific symbol gets deprecated');
535 $sym = $sym_file->lookup_symbol('symbol24_32@Base', ['libbasictags.so.1'], 1);
536 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol24_32@Base',
537 symbol_templ => 'symbol24_32@Base',
538 minver => '2.4', dep_id => 0, deprecated => '100.MISSING',
539 tags => { 'arch-bits' => '32' },
540 tagorder => [ 'arch-bits' ]),
541 'disappeared arch bits specific symbol gets deprecated');
542 $sym = $sym_file->lookup_symbol('symbol26_little@Base', ['libbasictags.so.1'], 1);
543 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol26_little@Base',
544 symbol_templ => 'symbol26_little@Base',
545 minver => '2.6', dep_id => 0, deprecated => '100.MISSING',
546 tags => { 'arch-endian' => 'little' },
547 tagorder => [ 'arch-endian' ]),
548 'disappeared arch endian specific symbol gets deprecated');
549 $sym = $sym_file->lookup_symbol('symbol28_little_32@Base', ['libbasictags.so.1'], 1);
550 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol28_little_32@Base',
551 symbol_templ => 'symbol28_little_32@Base',
552 minver => '2.8', dep_id => 0, deprecated => '100.MISSING',
553 tags => { 'arch-bits' => '32', 'arch-endian' => 'little' },
554 tagorder => [ 'arch-bits', 'arch-endian' ]),
555 'disappeared arch bits and endian specific symbol gets deprecated');
556 $sym = $sym_file->lookup_symbol('symbol41_i386_and_optional@Base', ['libbasictags.so.1'], 1);
557 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol41_i386_and_optional@Base',
558 symbol_templ => 'symbol41_i386_and_optional@Base',
559 symbol_quoted => '"',
560 minver => '4.1', dep_id => 0, deprecated => '100.MISSING',
561 tags => { arch => 'i386', optional => 'reason' },
562 tagorder => [ 'arch', 'optional' ]),
563 'disappeared optional arch specific symbol gets deprecated');
564 @tmp = sort map { $_->{symbol}->get_symbolname() } $sym_file->get_lost_symbols($sym_file_dup);
565 is_deeply(\@tmp, [ 'symbol22_i386@Base', 'symbol24_32@Base',
566 'symbol26_little@Base', 'symbol28_little_32@Base' ],
567 "missing arch specific is LOST, but optional arch specific isn't");
569 # Tests for tagged #includes
570 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/symbols.include-3", arch => 'i386');
571 $sym = $sym_file->lookup_symbol('symbol2_fake1@Base', ['libbasictags.so.2']);
572 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol2_fake1@Base',
574 tags => { optional => undef, 'random tag' => 'random value' },
575 tagorder => [ 'optional', 'random tag' ] ),
576 'symbols from #included file inherits tags');
577 $sym = $sym_file->lookup_symbol('symbol41_i386_and_optional@Base', ['libbasictags.so.1']);
578 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol41_i386_and_optional@Base',
579 symbol_templ => 'symbol41_i386_and_optional@Base',
580 symbol_quoted => '"',
582 tags => { optional => 'reason', t => 'v', arch => 'i386' },
583 tagorder => [ 'optional', 't', 'arch' ]),
584 'symbols in #included file can override tag values');
585 $sym = $sym_file->lookup_symbol('symbol51_untagged@Base', ['libbasictags.so.1']);
586 is_deeply($sym, Dpkg::Shlibs::Symbol->new(symbol => 'symbol51_untagged@Base',
588 tags => { optional => 'from parent', t => 'v' },
589 tagorder => [ 'optional', 't' ]),
590 'symbols are properly cloned when #including');
592 # Test Symbol::clone()
593 $sym = Dpkg::Shlibs::Symbol->new(symbol => 'foobar', testfield => 1, teststruct => { foo => 1 });
594 $tmp = $sym->clone();
595 $tmp->{teststruct}{foo} = 3;
596 $tmp->{testfield} = 3;
597 is ( $sym->{teststruct}{foo}, 1, 'original field "foo" not changed' );
598 is ( $sym->{testfield}, 1, 'original field "testfield" not changed' );
600 ############ Test symbol patterns ###########
604 skip 'c++filt not available', 41 if not find_command('c++filt');
606 sub load_patterns_obj {
607 $obj = Dpkg::Shlibs::Objdump::Object->new();
608 open $objdump, '<', "$datadir/objdump.patterns"
609 or die "$datadir/objdump.patterns: $!";
610 $obj->parse_objdump_output($objdump);
615 sub load_patterns_symbols {
616 $sym_file = Dpkg::Shlibs::SymbolFile->new(file => "$datadir/patterns.symbols");
621 $sym_file_dup = load_patterns_symbols();
622 load_patterns_symbols();
624 save_load_test($sym_file, 'save -> load test of patterns template', template_mode => 1);
626 isnt( $sym_file->get_patterns('libpatterns.so.1') , 0,
627 'patterns.symbols has patterns');
629 $sym_file->merge_symbols($obj, '100.MISSING');
631 @tmp = map { $_->get_symbolname() } $sym_file->get_lost_symbols($sym_file_dup);
632 is_deeply(\@tmp, [], 'no LOST symbols if all patterns matched.');
633 @tmp = map { $_->get_symbolname() } $sym_file->get_new_symbols($sym_file_dup);
634 is_deeply(\@tmp, [], 'no NEW symbols if all patterns matched.');
636 # Pattern resolution order: aliases (c++, symver), generic
637 $sym = $sym_file->lookup_symbol('SYMVER_1@SYMVER_1', 'libpatterns.so.1');
638 is($sym->{minver}, '1', 'specific SYMVER_1 symbol');
640 $sym = $sym_file->lookup_symbol('_ZN3NSB6Symver14symver_method1Ev@SYMVER_1', 'libpatterns.so.1');
641 is($sym->{minver}, '1.method1', 'specific symbol preferred over pattern');
643 $sym = $sym_file->lookup_symbol('_ZN3NSB6Symver14symver_method2Ev@SYMVER_1', 'libpatterns.so.1');
644 is($sym->{minver}, '1.method2', 'c++ alias pattern preferred over generic pattern');
645 is($sym->get_pattern()->get_symbolname(), 'NSB::Symver::symver_method2()@SYMVER_1',
646 'c++ alias pattern preferred over generic pattern, on demangled name');
648 $sym = $sym_file->lookup_symbol('_ZN3NSB6SymverD1Ev@SYMVER_1', 'libpatterns.so.1');
649 is ( $sym->{minver}, '1.generic', 'generic (c++ & symver) pattern covers the rest (destructor)' );
650 ok($sym->get_pattern()->equals($sym_file->create_symbol('(c++|symver)SYMVER_1 1.generic')),
651 'generic (c++ & symver) pattern covers the rest (destructor), compared');
653 # Test old style wildcard support
654 load_patterns_symbols();
655 $sym = $sym_file->create_symbol('*@SYMVEROPT_2 2');
656 ok($sym->is_optional(), 'Old style wildcard is optional');
657 is($sym->get_alias_type(), 'symver', 'old style wildcard is a symver pattern');
658 is($sym->get_symbolname(), 'SYMVEROPT_2', 'wildcard pattern got renamed');
660 $pat = $sym_file->lookup_pattern('(symver|optional)SYMVEROPT_2', 'libpatterns.so.1');
661 $sym->{symbol_templ} = $pat->{symbol_templ};
662 is_deeply($pat, $sym, 'old style wildcard is the same as (symver|optional)');
664 # Get rid of all SymverOptional symbols
665 foreach my $tmp (keys %{$obj->{dynsyms}}) {
666 delete $obj->{dynsyms}{$tmp} if ($tmp =~ /SymverOptional/);
668 $sym_file->merge_symbols($obj, '100.MISSING');
669 is_deeply ( [ map { $_->get_symbolname() } $pat->get_pattern_matches() ],
670 [], 'old style wildcard matches nothing.');
671 is($pat->{deprecated}, '100.MISSING', 'old style wildcard gets deprecated.');
672 @tmp = map { $_->{symbol}->get_symbolname() } $sym_file->get_lost_symbols($sym_file_dup);
673 is_deeply(\@tmp, [], 'but old style wildcard is not LOST.');
675 # 'Internal' pattern covers all internal symbols
677 @tmp = grep { $_->get_symbolname() =~ /Internal/ } $sym_file->get_symbols('libpatterns.so.1');
678 $sym = $sym_file->create_symbol('(regex|c++)^_Z(T[ISV])?N3NSA6ClassA8Internal.*@Base$ 1.internal');
679 $pat = $sym_file->lookup_pattern($sym, 'libpatterns.so.1');
680 is_deeply ([ sort $pat->get_pattern_matches() ], [ sort @tmp ],
681 'Pattern covers all internal symbols');
682 is($tmp[0]->{minver}, '1.internal', 'internal pattern covers first symbol');
684 # Lookup private pattern
685 my @private_symnames = sort qw(
686 _ZN3NSA6ClassA7Private11privmethod1Ei@Base
687 _ZN3NSA6ClassA7Private11privmethod2Ei@Base
688 _ZN3NSA6ClassA7PrivateC1Ev@Base
689 _ZN3NSA6ClassA7PrivateC2Ev@Base
690 _ZN3NSA6ClassA7PrivateD0Ev@Base
691 _ZN3NSA6ClassA7PrivateD1Ev@Base
692 _ZN3NSA6ClassA7PrivateD2Ev@Base
693 _ZTIN3NSA6ClassA7PrivateE@Base
694 _ZTSN3NSA6ClassA7PrivateE@Base
695 _ZTVN3NSA6ClassA7PrivateE@Base
697 $sym = $sym_file->create_symbol('(c++|regex|optional)NSA::ClassA::Private(::.*)?@Base 1');
698 $pat = $sym_file->lookup_pattern($sym, 'libpatterns.so.1');
699 isnt( $pat, undef, 'pattern for private class has been found' );
700 is_deeply( [ sort map { $_->get_symbolname() } $pat->get_pattern_matches() ],
701 \@private_symnames, 'private pattern matched expected symbols');
702 ok( ($pat->get_pattern_matches())[0]->is_optional(),
703 'private symbol is optional like its pattern');
704 ok( $sym_file->lookup_symbol(($pat->get_pattern_matches())[0], 'libpatterns.so.1'),
705 'lookup_symbol() finds symbols matched by pattern (after merge)');
707 # Get rid of a private symbol, it should not be lost
708 delete $obj->{dynsyms}{$private_symnames[0]};
709 load_patterns_symbols();
710 $sym_file->merge_symbols($obj, '100.MISSING');
712 $pat = $sym_file->lookup_pattern($sym, 'libpatterns.so.1');
713 @tmp = map { $_->{symbol}->get_symbolname() } $sym_file->get_lost_symbols($sym_file_dup);
714 is_deeply(\@tmp, [], 'no LOST symbols when got rid of patterned optional symbol.');
715 ok(!$pat->{deprecated}, 'there are still matches, pattern is not deprecated.');
717 # Get rid of all private symbols, the pattern should be deprecated.
718 foreach my $tmp (@private_symnames) {
719 delete $obj->{dynsyms}{$tmp};
721 load_patterns_symbols();
722 $sym_file->merge_symbols($obj, '100.MISSING');
724 $pat = $sym_file->lookup_pattern($sym, 'libpatterns.so.1', 1);
725 @tmp = $sym_file->get_lost_symbols($sym_file_dup);
726 is_deeply( \@tmp, [ ],
727 'All private symbols gone, but pattern is not LOST because it is optional.');
728 is( $pat->{deprecated}, '100.MISSING',
729 'All private symbols gone - pattern deprecated.');
731 # Internal symbols. All covered by the pattern?
732 @tmp = grep { $_->get_symbolname() =~ /Internal/ } values %{$sym_file->{objects}{'libpatterns.so.1'}{syms}};
733 $sym = $sym_file->create_symbol('(regex|c++)^_Z(T[ISV])?N3NSA6ClassA8Internal.*@Base$ 1.internal');
734 $pat = $sym_file->lookup_pattern($sym, 'libpatterns.so.1');
735 is_deeply ([ sort $pat->get_pattern_matches() ], [ sort @tmp ],
736 'Pattern covers all internal symbols');
737 is($tmp[0]->{minver}, '1.internal', 'internal pattern covers first symbol');
739 # Delete matches of the non-optional pattern
740 $sym = $sym_file->create_symbol('(c++)"non-virtual thunk to NSB::ClassD::generate_vt(char const*) const@Base" 1');
741 $pat = $sym_file->lookup_pattern($sym, 'libpatterns.so.1');
742 isnt( $pat, undef, 'lookup_pattern() finds alias-based pattern' );
744 is(scalar($pat->get_pattern_matches()), 2, 'two matches for the generate_vt pattern');
745 foreach my $tmp ($pat->get_pattern_matches()) {
746 delete $obj->{dynsyms}{$tmp->get_symbolname()};
748 load_patterns_symbols();
749 $sym_file->merge_symbols($obj, '100.MISSING');
751 $pat = $sym_file->lookup_pattern($sym, 'libpatterns.so.1', 1);
752 @tmp = map { scalar $sym_file->lookup_pattern($_->{symbol}, 'libpatterns.so.1', 1) }
753 $sym_file->get_lost_symbols($sym_file_dup);
754 is_deeply(\@tmp, [ $pat ], 'No matches - generate_vt() pattern is LOST.');
755 is( $pat->{deprecated}, '100.MISSING',
756 'No matches - generate_vt() pattern is deprecated.');
758 # Pattern undeprecation when matches are discovered
760 load_patterns_symbols();
762 $pat = $sym_file_dup->lookup_pattern($sym, 'libpatterns.so.1');
763 $pat->{deprecated} = '0.1-1';
764 $pat = $sym_file->lookup_pattern($sym, 'libpatterns.so.1');
765 $pat->{deprecated} = '0.1-1';
767 $sym_file->merge_symbols($obj, '100.FOUND');
768 ok( ! $pat->{deprecated},
769 'Previously deprecated pattern with matches got undeprecated');
770 is( $pat->{minver}, '100.FOUND',
771 'Previously deprecated pattern with matches got minver bumped');
772 @tmp = map { $_->{symbol}->get_symbolspec(1) } $sym_file->get_new_symbols($sym_file_dup);
773 is_deeply( \@tmp, [ $pat->get_symbolspec(1) ],
774 'Previously deprecated pattern with matches is NEW. Matches themselves are not NEW.');
775 foreach my $sym ($pat->get_pattern_matches()) {
776 ok(!$sym->{deprecated}, $sym->get_symbolname() . ': not deprecated');
777 is($sym->{minver}, '100.FOUND', $sym->get_symbolname() . ': version bumped');