#!/usr/bin/perl # # dpkg-shlibdeps # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . use strict; use warnings; use POSIX qw(:errno_h :signal_h); use Cwd qw(realpath); use File::Basename qw(dirname); use Dpkg; use Dpkg::Gettext; use Dpkg::ErrorHandling; use Dpkg::Path qw(relative_to_pkg_root guess_pkg_root_dir check_files_are_the_same); use Dpkg::Version; use Dpkg::Shlibs qw(find_library @librarypaths); use Dpkg::Shlibs::Objdump; use Dpkg::Shlibs::SymbolFile; use Dpkg::Arch qw(get_host_arch); use Dpkg::Deps; use Dpkg::Control::Info; use Dpkg::Control::Fields; use constant { WARN_SYM_NOT_FOUND => 1, WARN_DEP_AVOIDABLE => 2, WARN_NOT_NEEDED => 4, }; # By increasing importance my @depfields = qw(Suggests Recommends Depends Pre-Depends); my $i = 0; my %depstrength = map { $_ => $i++ } @depfields; textdomain("dpkg-dev"); my $shlibsoverride = '/etc/dpkg/shlibs.override'; my $shlibsdefault = '/etc/dpkg/shlibs.default'; my $shlibslocal = 'debian/shlibs.local'; my $packagetype = 'deb'; my $dependencyfield = 'Depends'; my $varlistfile = 'debian/substvars'; my $varnameprefix = 'shlibs'; my $ignore_missing_info = 0; my $warnings = 3; my $debug = 0; my @exclude = (); my @pkg_dir_to_search = (); my $host_arch = get_host_arch(); my (@pkg_shlibs, @pkg_symbols, @pkg_root_dirs); if (-d "debian") { push @pkg_symbols, ; push @pkg_shlibs, ; my %uniq = map { guess_pkg_root_dir($_) => 1 } (@pkg_symbols, @pkg_shlibs); push @pkg_root_dirs, keys %uniq; } my ($stdout, %exec); foreach (@ARGV) { if (m/^-T(.*)$/) { $varlistfile = $1; } elsif (m/^-p(\w[-:0-9A-Za-z]*)$/) { $varnameprefix = $1; } elsif (m/^-L(.*)$/) { $shlibslocal = $1; } elsif (m/^-S(.*)$/) { push @pkg_dir_to_search, $1; } elsif (m/^-O$/) { $stdout = 1; } elsif (m/^-(h|-help)$/) { usage(); exit(0); } elsif (m/^--version$/) { version(); exit(0); } elsif (m/^--admindir=(.*)$/) { $admindir = $1; -d $admindir || error(_g("administrative directory '%s' does not exist"), $admindir); } elsif (m/^-d(.*)$/) { $dependencyfield = field_capitalize($1); defined($depstrength{$dependencyfield}) || warning(_g("unrecognised dependency field \`%s'"), $dependencyfield); } elsif (m/^-e(.*)$/) { if (exists $exec{$1}) { # Affect the binary to the most important field if ($depstrength{$dependencyfield} > $depstrength{$exec{$1}}) { $exec{$1} = $dependencyfield; } } else { $exec{$1} = $dependencyfield; } } elsif (m/^--ignore-missing-info$/) { $ignore_missing_info = 1; } elsif (m/^--warnings=(\d+)$/) { $warnings = $1; } elsif (m/^-t(.*)$/) { $packagetype = $1; } elsif (m/^-v$/) { $debug++; } elsif (m/^-x(.*)$/) { push @exclude, $1; } elsif (m/^-/) { usageerr(_g("unknown option \`%s'"), $_); } else { if (exists $exec{$_}) { # Affect the binary to the most important field if ($depstrength{$dependencyfield} > $depstrength{$exec{$_}}) { $exec{$_} = $dependencyfield; } } else { $exec{$_} = $dependencyfield; } } } scalar keys %exec || usageerr(_g("need at least one executable")); my $control = Dpkg::Control::Info->new(); my $fields = $control->get_source(); my $build_depends = defined($fields->{"Build-Depends"}) ? $fields->{"Build-Depends"} : ""; my $build_deps = deps_parse($build_depends, reduce_arch => 1); my %dependencies; my %shlibs; # Statictics on soname seen in the whole run (with multiple analysis of # binaries) my %global_soname_notfound; my %global_soname_used; my %global_soname_needed; # Symfile and objdump caches my %symfile_cache; my %objdump_cache; my %symfile_has_soname_cache; my $cur_field; foreach my $file (keys %exec) { $cur_field = $exec{$file}; print ">> Scanning $file (for $cur_field field)\n" if $debug; my $obj = Dpkg::Shlibs::Objdump::Object->new($file); my @sonames = $obj->get_needed_libraries; # Load symbols files for all needed libraries (identified by SONAME) my %libfiles; my %altlibfiles; my %soname_notfound; my %alt_soname; foreach my $soname (@sonames) { my $lib = my_find_library($soname, $obj->{RPATH}, $obj->{format}, $file); unless (defined $lib) { $soname_notfound{$soname} = 1; $global_soname_notfound{$soname} = 1; my $msg = _g("couldn't find library %s needed by %s (ELF format: '%s'; RPATH: '%s').\n" . "Note: libraries are not searched in other binary packages " . "that do not have any shlibs or symbols file.\nTo help dpkg-shlibdeps " . "find private libraries, you might need to set LD_LIBRARY_PATH."); if (scalar(split_soname($soname))) { error($msg, $soname, $file, $obj->{format}, join(":", @{$obj->{RPATH}})); } else { warning($msg, $soname, $file, $obj->{format}, join(":", @{$obj->{RPATH}})); } next; } $libfiles{$lib} = $soname; my $reallib = realpath($lib); if ($reallib ne $lib) { $altlibfiles{$reallib} = $soname; } print "Library $soname found in $lib\n" if $debug; } my $file2pkg = find_packages(keys %libfiles, keys %altlibfiles); my $symfile = Dpkg::Shlibs::SymbolFile->new(); my $dumplibs_wo_symfile = Dpkg::Shlibs::Objdump->new(); my @soname_wo_symfile; foreach my $lib (keys %libfiles) { my $soname = $libfiles{$lib}; if (not scalar(grep { $_ ne '' } @{$file2pkg->{$lib}})) { # The path of the library as calculated is not the # official path of a packaged file, try to fallback on # on the realpath() first, maybe this one is part of a package my $reallib = realpath($lib); if (exists $file2pkg->{$reallib}) { $file2pkg->{$lib} = $file2pkg->{$reallib}; } } if (not scalar(grep { $_ ne '' } @{$file2pkg->{$lib}})) { # If the library is really not available in an installed package, # it's because it's in the process of being built # Empty package name will lead to consideration of symbols # file from the package being built only $file2pkg->{$lib} = [""]; print "No associated package found for $lib\n" if $debug; } # Load symbols/shlibs files from packages providing libraries foreach my $pkg (@{$file2pkg->{$lib}}) { my $symfile_path; my $haslocaldep = 0; if (-e $shlibslocal and defined(extract_from_shlibs($soname, $shlibslocal))) { $haslocaldep = 1; } if ($packagetype eq "deb" and not $haslocaldep) { # Use fine-grained dependencies only on real deb # and only if the dependency is not provided by shlibs.local $symfile_path = find_symbols_file($pkg, $soname, $lib); } if (defined($symfile_path)) { # Load symbol information print "Using symbols file $symfile_path for $soname\n" if $debug; unless (exists $symfile_cache{$symfile_path}) { $symfile_cache{$symfile_path} = Dpkg::Shlibs::SymbolFile->new(file => $symfile_path); } $symfile->merge_object_from_symfile($symfile_cache{$symfile_path}, $soname); } if (defined($symfile_path) && $symfile->has_object($soname)) { # Initialize dependencies with the smallest minimal version # of all symbols (unversioned dependency is not ok as the # library might not have always been available in the # package and we really need it) my $dep = $symfile->get_dependency($soname); my $minver = $symfile->get_smallest_version($soname) || ''; foreach my $subdep (split /\s*,\s*/, $dep) { if (not exists $dependencies{$cur_field}{$subdep}) { $dependencies{$cur_field}{$subdep} = Dpkg::Version->new($minver); print " Initialize dependency ($subdep) with minimal " . "version ($minver)\n" if $debug > 1; } } } else { # No symbol file found, fall back to standard shlibs print "Using shlibs+objdump for $soname (file $lib)\n" if $debug; unless (exists $objdump_cache{$lib}) { $objdump_cache{$lib} = Dpkg::Shlibs::Objdump::Object->new($lib); } my $libobj = $objdump_cache{$lib}; my $id = $dumplibs_wo_symfile->add_object($libobj); if (($id ne $soname) and ($id ne $lib)) { warning(_g("%s has an unexpected SONAME (%s)"), $lib, $id); $alt_soname{$id} = $soname; } push @soname_wo_symfile, $soname; # Only try to generate a dependency for libraries with a SONAME if ($libobj->is_public_library() and not add_shlibs_dep($soname, $pkg, $lib)) { # This failure is fairly new, try to be kind by # ignoring as many cases that can be safely ignored my $ignore = 0; # 1/ when the lib and the binary are in the same # package my $root_file = guess_pkg_root_dir($file); my $root_lib = guess_pkg_root_dir($lib); $ignore++ if defined $root_file and defined $root_lib and check_files_are_the_same($root_file, $root_lib); # 2/ when the lib is not versioned and can't be # handled by shlibs $ignore++ unless scalar(split_soname($soname)); # 3/ when we have been asked to do so $ignore++ if $ignore_missing_info; error(_g("no dependency information found for %s " . "(used by %s)."), $lib, $file) unless $ignore; } } } } # Scan all undefined symbols of the binary and resolve to a # dependency my %soname_used; foreach (@sonames) { # Initialize statistics $soname_used{$_} = 0; $global_soname_used{$_} = 0 unless exists $global_soname_used{$_}; if (exists $global_soname_needed{$_}) { push @{$global_soname_needed{$_}}, $file; } else { $global_soname_needed{$_} = [ $file ]; } } my $nb_warnings = 0; my $nb_skipped_warnings = 0; # Disable warnings about missing symbols when we have not been able to # find all libs my $disable_warnings = scalar(keys(%soname_notfound)); my $in_public_dir = 1; if (my $relname = relative_to_pkg_root($file)) { my $parent_dir = "/" . dirname($relname); $in_public_dir = (grep { $parent_dir eq $_ } @librarypaths) ? 1 : 0; } else { warning(_g("binaries to analyze should already be " . "installed in their package's directory.")); } print "Analyzing all undefined symbols\n" if $debug > 1; foreach my $sym ($obj->get_undefined_dynamic_symbols()) { my $name = $sym->{name}; if ($sym->{version}) { $name .= "\@$sym->{version}"; } else { $name .= "\@Base"; } print " Looking up symbol $name\n" if $debug > 1; my %symdep = $symfile->lookup_symbol($name, \@sonames); if (keys %symdep) { my $depends = $symfile->get_dependency($symdep{soname}, $symdep{symbol}{dep_id}); print " Found in symbols file of $symdep{soname} (minver: " . "$symdep{symbol}{minver}, dep: $depends)\n" if $debug > 1; $soname_used{$symdep{soname}}++; $global_soname_used{$symdep{soname}}++; if (exists $alt_soname{$symdep{soname}}) { # Also count usage on alternate soname $soname_used{$alt_soname{$symdep{soname}}}++; $global_soname_used{$alt_soname{$symdep{soname}}}++; } update_dependency_version($depends, $symdep{symbol}{minver}); } else { my $syminfo = $dumplibs_wo_symfile->locate_symbol($name); if (not defined($syminfo)) { print " Not found\n" if $debug > 1; next unless ($warnings & WARN_SYM_NOT_FOUND); next if $disable_warnings; # Complain about missing symbols only for executables # and public libraries if ($obj->is_executable() or $obj->is_public_library()) { my $print_name = $name; # Drop the default suffix for readability $print_name =~ s/\@Base$//; unless ($sym->{weak}) { if ($debug or ($in_public_dir and $nb_warnings < 10) or (!$in_public_dir and $nb_warnings < 1)) { if ($in_public_dir) { warning(_g("symbol %s used by %s found in none of the " . "libraries."), $print_name, $file); } else { warning(_g("%s contains an unresolvable reference to " . "symbol %s: it's probably a plugin."), $file, $print_name); } $nb_warnings++; } else { $nb_skipped_warnings++; } } } } else { print " Found in $syminfo->{soname} ($syminfo->{objid})\n" if $debug > 1; if (exists $alt_soname{$syminfo->{soname}}) { # Also count usage on alternate soname $soname_used{$alt_soname{$syminfo->{soname}}}++; $global_soname_used{$alt_soname{$syminfo->{soname}}}++; } $soname_used{$syminfo->{soname}}++; $global_soname_used{$syminfo->{soname}}++; } } } warning(P_("%d similar warning has been skipped (use -v to see it).", "%d other similar warnings have been skipped (use -v to see " . "them all).", $nb_skipped_warnings), $nb_skipped_warnings) if $nb_skipped_warnings; foreach my $soname (@sonames) { # Adjust minimal version of dependencies with information # extracted from build-dependencies my $dev_pkg = $symfile->get_field($soname, 'Build-Depends-Package'); if (defined $dev_pkg) { print "Updating dependencies of $soname with build-dependencies\n" if $debug; my $minver = get_min_version_from_deps($build_deps, $dev_pkg); if (defined $minver) { foreach my $dep ($symfile->get_dependencies($soname)) { update_dependency_version($dep, $minver, 1); print " Minimal version of $dep updated with $minver\n" if $debug; } } else { print " No minimal version found in $dev_pkg build-dependency\n" if $debug; } } # Warn about un-NEEDED libraries unless ($soname_notfound{$soname} or $soname_used{$soname}) { # Ignore warning for libm.so.6 if also linked against libstdc++ next if ($soname =~ /^libm\.so\.\d+$/ and scalar grep(/^libstdc\+\+\.so\.\d+/, @sonames)); next unless ($warnings & WARN_NOT_NEEDED); warning(_g("%s shouldn't be linked with %s (it uses none of its " . "symbols)."), $file, $soname); } } } # Warn of unneeded libraries at the "package" level (i.e. over all # binaries that we have inspected) foreach my $soname (keys %global_soname_needed) { unless ($global_soname_notfound{$soname} or $global_soname_used{$soname}) { next if ($soname =~ /^libm\.so\.\d+$/ and scalar( grep(/^libstdc\+\+\.so\.\d+/, keys %global_soname_needed))); next unless ($warnings & WARN_DEP_AVOIDABLE); warning(_g("dependency on %s could be avoided if \"%s\" were not " . "uselessly linked against it (they use none of its " . "symbols)."), $soname, join(" ", @{$global_soname_needed{$soname}})); } } # Open substvars file my $fh; if ($stdout) { $fh = \*STDOUT; } else { open(NEW, ">", "$varlistfile.new") || syserr(_g("open new substvars file \`%s'"), "$varlistfile.new"); if (-e $varlistfile) { open(OLD, "<", $varlistfile) || syserr(_g("open old varlist file \`%s' for reading"), $varlistfile); foreach my $entry (grep { not m/^\Q$varnameprefix\E:/ } ()) { print(NEW $entry) || syserr(_g("copy old entry to new varlist file \`%s'"), "$varlistfile.new"); } close(OLD); } $fh = \*NEW; } # Write out the shlibs substvars my %depseen; sub filter_deps { my ($dep, $field) = @_; # Skip dependencies on excluded packages foreach my $exc (@exclude) { return 0 if $dep =~ /^\s*\Q$exc\E\b/; } # Don't include dependencies if they are already # mentionned in a higher priority field if (not exists($depseen{$dep})) { $depseen{$dep} = $dependencies{$field}{$dep}; return 1; } else { # Since dependencies can be versionned, we have to # verify if the dependency is stronger than the # previously seen one my $stronger; if ($depseen{$dep} eq $dependencies{$field}{$dep}) { # If both versions are the same (possibly unversionned) $stronger = 0; } elsif ($dependencies{$field}{$dep} eq '') { $stronger = 0; # If the dep is unversionned } elsif ($depseen{$dep} eq '') { $stronger = 1; # If the dep seen is unversionned } elsif (version_compare_relation($depseen{$dep}, REL_GT, $dependencies{$field}{$dep})) { # The version of the dep seen is stronger... $stronger = 0; } else { $stronger = 1; } $depseen{$dep} = $dependencies{$field}{$dep} if $stronger; return $stronger; } } foreach my $field (reverse @depfields) { my $dep = ""; if (exists $dependencies{$field} and scalar keys %{$dependencies{$field}}) { $dep = join ", ", map { # Translate dependency templates into real dependencies if ($dependencies{$field}{$_}) { s/#MINVER#/(>= $dependencies{$field}{$_})/g; } else { s/#MINVER#//g; } s/\s+/ /g; $_; } grep { filter_deps($_, $field) } keys %{$dependencies{$field}}; } if ($dep) { my $obj = deps_parse($dep); error(_g("invalid dependency got generated: %s"), $dep) unless defined $obj; $obj->sort(); print $fh "$varnameprefix:$field=$obj\n"; } } # Replace old file by new one if (!$stdout) { close($fh); rename("$varlistfile.new",$varlistfile) || syserr(_g("install new varlist file \`%s'"), $varlistfile); } ## ## Functions ## sub version { printf _g("Debian %s version %s.\n"), $progname, $version; printf _g(" Copyright (C) 1996 Ian Jackson. Copyright (C) 2000 Wichert Akkerman. Copyright (C) 2006 Frank Lichtenheld. Copyright (C) 2007 Raphael Hertzog. "); printf _g(" This is free software; see the GNU General Public License version 2 or later for copying conditions. There is NO warranty. "); } sub usage { printf _g( "Usage: %s [