check_rtime.pl revision 148434217c040ea38dc844384f6ba68d9b325906
#!/usr/perl5/bin/perl -w
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#
# Copyright 2009 Sun Microsystems, Inc. All rights reserved.
# Use is subject to license terms.
#
#
#
# Check ELF information.
#
# This script descends a directory hierarchy inspecting ELF dynamic executables
# and shared objects. The general theme is to verify that common Makefile rules
# have been used to build these objects. Typical failures occur when Makefile
# rules are re-invented rather than being inherited from "cmd/lib" Makefiles.
#
# As always, a number of components don't follow the rules, and these are
# excluded to reduce this scripts output. Pathnames used for this exclusion
# assume this script is being run over a "proto" area. The -a (all) option
# skips any exclusions.
#
# By default any file that has conditions that should be reported is first
# listed and then each condition follows. The -o (one-line) option produces a
# more terse output which is better for sorting/diffing with "nightly".
#
# NOTE: missing dependencies, symbols or versions are reported by running the
# file through ldd(1). As objects within a proto area are built to exist in a
# base system, standard use of ldd(1) will bind any objects to dependencies
# that exist in the base system. It is frequently the case that newer objects
# exist in the proto area that are required to satisfy other objects
# dependencies, and without using these newer objects an ldd(1) will produce
# misleading error messages. To compensate for this, the -d option (or the
# existence of the CODEMSG_WS/ROOT environment variables) cause the creation of
# alternative dependency mappings via crle(1) configuration files that establish
# any proto shared objects as alternatives to their base system location. Thus
# ldd(1) can be executed against these configuration files so that objects in a
# proto area bind to their dependencies in the same proto area.
# Define all global variables (required for strict)
use vars qw($SkipDirs $SkipFiles $SkipTextrelFiles $SkipDirectBindFiles);
use vars qw($SkipUndefFiles $SkipUnusedDeps);
use vars qw($SkipStabFiles $SkipNoExStkFiles $SkipCrleConf);
use vars qw($SkipUnusedSearchPath $SkipUnrefObject $SkipUnusedObject);
use vars qw($Prog $Mach $Isalist $Env $Ena64 $Tmpdir $Error $Gnuc);
use vars qw($UnusedPaths $LddNoU $Crle32 $Crle64 $Conf32 $Conf64);
use vars qw($SkipDirectBindDirs $SkipInterps $SkipSymSort $OldDeps %opt);
use strict;
# Define any directories we should skip completely.
$SkipDirs = qr{
usr/lib/devfsadm | # 4382889
usr/lib/libc | # optimized libc
usr/lib/rcm | # 4426119
usr/perl5 | # alan's taking care of these :-)
usr/src # no need to look at shipped source
}x;
# Define any files we should skip completely.
$SkipFiles = qr{ ^(?:
lddstub | # lddstub has no dependencies
geniconvtbl\.so | # 4384329
libssagent\.so\.1 | # 4328854
libpsvcplugin_psr\.so\.1 | # 4385799
libpsvcpolicy_psr\.so\.1 | # " "
libpsvcpolicy\.so\.1 | # " "
picl_slm\.so | # " "
mod_ipp\.so | # Apache loadable module
fptest | # USIII specific extns. cause ldd noise on USII bld. m/c
grub
)$
}x;
# Define any files that are allowed text relocations.
$SkipTextrelFiles = qr{ ^(?:
unix | # kernel models are non-pic
mdb # relocations against __RTC (dbx)
)$
}x;
# Define any directories or files that are allowed to have no direct bound
# symbols
$SkipDirectBindDirs = qr{
usr/ucb
}x;
$SkipDirectBindFiles = qr{ ^(?:
unix |
sbcp |
libproc.so.1 |
libnisdb.so.2
)$
}x;
# Define any files that are allowed undefined references.
$SkipUndefFiles = qr{ ^(?:
libsvm\.so\.1 | # libspmicommon.so.1 lacking
libnisdb\.so\.2 # C++
)$
}x;
# Define any files that have unused dependencies.
$SkipUnusedDeps = qr{
lib/picl/plugins/ | # require devtree dependencies
/lib/libp # profile libc makes libm an unused
}x; # dependency of standard libc
# Define any objects that always look unused.
$SkipUnusedObject = qr{
/libm_hwcap[0-9]+\.so\.2 # libm.so.2 dependency
}x;
# Define any files that should contain debugging information.
$SkipStabFiles = qr{ ^(?:
unix
)$
}x;
# Define any files that don't require a non-executable stack definition.
$SkipNoExStkFiles = qr{ ^(?:
forth |
unix |
multiboot
)$
}x;
# Identify any files that should be skipped when building a crle(1)
# configuration file. As the hwcap libraries can be loop-back mounted onto
# libc, these can confuse crle(1) because of their identical dev/inode.
$SkipCrleConf = qr{
lib/libc/libc_hwcap
}x;
# Skip "unused search path=" ldd(1) diagnostics.
$SkipUnusedSearchPath = qr{
/usr/lib/fs/autofs.*\ from\ .automountd | # dlopen()
/etc/ppp/plugins.*\ from\ .*pppd | # dlopen()
/usr/lib/inet/ppp.*\ from\ .*pppd | # dlopen()
/usr/sfw/lib.*\ from\ .*libipsecutil.so.1 | # dlopen()
/usr/platform/.*rsmlib.*\ from\ .*librsm.so.2 | # dlopen()
\$ORIGIN.*\ from\ .*fcode.so | # dlopen()
/opt/VRTSvxvm/lib.*\ from\ .*libdiskmgt\.so\.1 | # dlopen()
/usr/platform/.*\ from\ .*/usr/platform | # picl
/usr/lib/picl/.*\ from\ .*/usr/platform | # picl
/usr/platform/.*\ from\ .*/usr/lib/picl | # picl
/usr/lib/smbsrv.*\ from\ .*libsmb\.so\.1 | # future needs
/usr/lib/mps/secv1.*\ from\ .*libnss3\.so | # non-OSNet
/usr/lib/mps.*\ from\ .*libnss3\.so | # non-OSNet
/usr/sfw/lib.*\ from\ .*libdbus-1\.so\.3 | # non-OSNet
/usr/sfw/lib.*\ from\ .*libdbus-glib-1\.so\.2 | # non-OSNet
/usr/sfw/lib.*\ from\ .*libglib-2\.0\.so\.0 | # non-OSNet
/usr/X11/lib.*\ from\ .*libglib-2\.0\.so\.0 | # non-OSNet
/usr/sfw/lib.*\ from\ .*libgobject-2\.0\.so\.0 | # non-OSNet
/usr/X11/lib.*\ from\ .*libgobject-2\.0\.so\.0 | # non-OSNet
/usr/sfw/lib.*\ from\ .*libcrypto\.so\.0\.9\.8 | # non-OSNet
/usr/sfw/lib.*\ from\ .*libnetsnmp\.so\.5 | # non-OSNet
/usr/sfw/lib.*\ from\ .*libgcc_s\.so\.1 | # non-OSNet
/usr.*\ from\ .*tst\.gcc\.exe | # gcc built
/usr/postgres/8.3/lib.*\ from\ .*libpq\.so\.5 | # non-OSNET
/usr/sfw/lib.*\ from\ .*libpq\.so\.5 # non-OSNET
}x;
# Skip "unreferenced object=" ldd(1) diagnostics.
$SkipUnrefObject = qr{
/libmapmalloc\.so\.1;\ unused\ dependency\ of | # interposer
/libstdc\+\+\.so\.6;\ unused\ dependency\ of | # gcc build
/libm\.so\.2.*\ of\ .*libstdc\+\+\.so\.6 | # gcc build
/lib.*\ of\ .*/lib/picl/plugins/ | # picl
/lib.*\ of\ .*libcimapi\.so | # non-OSNET
/lib.*\ of\ .*libjvm\.so | # non-OSNET
/lib.*\ of\ .*libnetsnmp\.so\.5 | # non-OSNET
/lib.*\ of\ .*libnetsnmpagent\.so\.5 | # non-OSNET
/lib.*\ of\ .*libnetsnmpmibs\.so\.5 | # non-OSNET
/lib.*\ of\ .*libnetsnmphelpers\.so\.5 | # non-OSNET
/lib.*\ of\ .*libnspr4\.so | # non-OSNET
/lib.*\ of\ .*libsoftokn3\.so | # non-OSNET
/lib.*\ of\ .*libspmicommon\.so\.1 | # non-OSNET
/lib.*\ of\ .*libspmocommon\.so\.1 | # non-OSNET
/lib.*\ of\ .*libssl3\.so | # non-OSNET
/lib.*\ of\ .*libxml2\.so\.2 | # non-OSNET
/lib.*\ of\ .*libxslt\.so\.1 | # non-OSNET
/lib.*\ of\ .*libpq\.so\.4 | # non-OSNET
/lib.*\ of\ .*libpython2\.4\.so\.1\.0 # non-OSNET
}x;
# Define any files that should only have unused (ldd -u) processing.
$UnusedPaths = qr{
ucb/shutdown # libucb interposes on libc and makes
# dependencies on libc seem unnecessary
}x;
# Define interpreters we should ignore.
$SkipInterps = qr{
misc/krtld |
misc/amd64/krtld |
misc/sparcv9/krtld
}x;
# Catch libintl and libw, although ld(1) will bind to these and thus determine
# they're needed, their content was moved into libc as of on297 build 7.
# libthread and libpthread were completely moved into libc as of on10 build 53.
# libdl was moved into libc as of on10 build 49. librt and libaio were moved
# into libc as of Nevada build 44.
$OldDeps = qr{ ^(?:
libintl\.so\.1 |
libw\.so\.1 |
libthread\.so\.1 |
libpthread\.so\.1 |
libdl\.so\.1 |
librt\.so\.1 |
libaio\.so\.1
)$
}x;
# Files for which we skip checking of duplicate addresses in the
# symbol sort sections. Such exceptions should be rare --- most code will
# not have duplicate addresses, since it takes assember or a "#pragma weak"
# to do such aliasing in C. C++ is different: The compiler generates aliases
# for implementation reasons, and the mangled names used to encode argument
# and return value types are difficult to handle well in mapfiles.
# Furthermore, the Sun compiler and gcc use different and incompatible
# name mangling conventions. Since ON must be buildable by either, we
# would have to maintain two sets of mapfiles for each such object.
# C++ use is rare in ON, so this is not worth pursuing.
#
$SkipSymSort = qr{ ^.*(?:
opt/SUNWdtrt/tst/common/pid/tst.weak2.exe | # DTrace test
lib/amd64/libnsl\.so\.1 | # C++
lib/sparcv9/libnsl\.so\.1 | # C++
lib/sparcv9/libfru\.so\.1 | # C++
usr/lib/sgml/nsgmls | # C++
usr/lib/lms | # C++
ld\.so\.1 | # libc_pic.a user
lib/libsun_fc\.so\.1 | # C++
lib/amd64/libsun_fc\.so\.1 | # C++
lib/sparcv9/libsun_fc\.so\.1 # C++
)$
}x;
use Getopt::Std;
# -----------------------------------------------------------------------------
# Reliably compare two OS revisions. Arguments are <ver1> <op> <ver2>.
# <op> is the string form of a normal numeric comparison operator.
sub cmp_os_ver {
my @ver1 = split(/\./, $_[0]);
my $op = $_[1];
my @ver2 = split(/\./, $_[2]);
push @ver2, ("0") x $#ver1 - $#ver2;
push @ver1, ("0") x $#ver2 - $#ver1;
my $diff = 0;
while (@ver1 || @ver2) {
if (($diff = shift(@ver1) - shift(@ver2)) != 0) {
last;
}
}
return (eval "$diff $op 0" ? 1 : 0);
}
# This script relies on ldd returning output reflecting only the binary
# contents. But if LD_PRELOAD* environment variables are present, libraries
# named by them will also appear in the output, disrupting our analysis.
# So, before we get too far, scrub the environment.
delete($ENV{LD_PRELOAD});
delete($ENV{LD_PRELOAD_32});
delete($ENV{LD_PRELOAD_64});
# Establish a program name for any error diagnostics.
chomp($Prog = `basename $0`);
# Determine what machinery is available.
$Mach = `uname -p`;
$Isalist = `isalist`;
$Env = "";
if ($Mach =~ /sparc/) {
if ($Isalist =~ /sparcv9/) {
$Ena64 = "ok";
}
} elsif ($Mach =~ /i386/) {
if ($Isalist =~ /amd64/) {
$Ena64 = "ok";
}
}
# Check that we have arguments.
if ((getopts('ad:imosv', \%opt) == 0) || ($#ARGV == -1)) {
print "usage: $Prog [-a] [-d depdir] [-m] [-o] [-s] file | dir, ...\n";
print "\t[-a]\t\tprocess all files (ignore any exception lists)\n";
print "\t[-d dir]\testablish dependencies from under directory\n";
print "\t[-i]\t\tproduce dynamic table entry information\n";
print "\t[-m]\t\tprocess mcs(1) comments\n";
print "\t[-o]\t\tproduce one-liner output (prefixed with pathname)\n";
print "\t[-s]\t\tprocess .stab and .symtab entries\n";
print "\t[-v]\t\tprocess version definition entries\n";
exit 1;
} else {
my($Proto);
if ($opt{d}) {
# User specified dependency directory - make sure it exists.
if (! -d $opt{d}) {
print "$Prog: $opt{d} is not a directory\n";
exit 1;
}
$Proto = $opt{d};
} elsif ($ENV{CODEMGR_WS}) {
my($Root);
# Without a user specified dependency directory see if we're
# part of a codemanager workspace and if a proto area exists.
if (($Root = $ENV{ROOT}) && (-d $Root)) {
$Proto = $Root;
}
}
if (!($Tmpdir = $ENV{TMPDIR}) || (! -d $Tmpdir)) {
$Tmpdir = "/tmp";
}
# Determine whether this is a __GNUC build. If so, unused search path
# processing is disabled.
if (defined $ENV{__GNUC}) {
$Gnuc = 1;
} else {
$Gnuc = 0;
}
# Look for dependencies under $Proto.
if ($Proto) {
# To support alternative dependency mapping we'll need ldd(1)'s
# -e option. This is relatively new (s81_30), so make sure
# ldd(1) is capable before gathering any dependency information.
if (system('ldd -e /usr/lib/lddstub 2> /dev/null')) {
print "ldd: does not support -e, unable to ";
print "create alternative dependency mappingings.\n";
print "ldd: option added under 4390308 (s81_30).\n\n";
} else {
# Gather dependencies and construct a alternative
# dependency mapping via a crle(1) configuration file.
GetDeps($Proto, "/");
GenConf();
}
}
# To support unreferenced dependency detection we'll need ldd(1)'s -U
# option. This is relatively new (4638070), and if not available we
# can still fall back to -u. Even with this option, don't use -U with
# releases prior to 5.10 as the cleanup for -U use only got integrated
# into 5.10 under 4642023. Note, that nightly doesn't typically set a
# RELEASE from the standard <env> files. Users who wish to disable use
# of ldd(1)'s -U should set (or uncomment) RELEASE in their <env> file
# if using nightly, or otherwise establish it in their environment.
if (system('ldd -U /usr/lib/lddstub 2> /dev/null')) {
$LddNoU = 1;
} else {
my($Release);
if (($Release = $ENV{RELEASE}) &&
(cmp_os_ver($Release, "<", "5.10"))) {
$LddNoU = 1;
} else {
$LddNoU = 0;
}
}
# For each argument determine if we're dealing with a file or directory.
foreach my $Arg (@ARGV) {
# Ignore symbolic links.
if (-l $Arg) {
next;
}
if (!stat($Arg)) {
next;
}
# Process simple files.
if (-f _) {
my($RelPath) = $Arg;
my($File) = $Arg;
my($Secure) = 0;
$RelPath =~ s!^.*/!./!;
$File =~ s!^.*/!!;
if (-u _ || -g _) {
$Secure = 1;
}
ProcFile($Arg, $RelPath, $File, $Secure);
next;
}
# Process directories.
if (-d _) {
ProcDir($Arg, ".");
next;
}
print "$Arg is not a file or directory\n";
$Error = 1;
}
# Cleanup
CleanUp();
}
$Error = 0;
# Clean up any temporary files.
sub CleanUp {
if ($Crle64) {
unlink $Crle64;
}
if ($Conf64) {
unlink $Conf64;
}
if ($Crle32) {
unlink $Crle32;
}
if ($Conf32) {
unlink $Conf32;
}
}
# Create an output message, either a one-liner (under -o) or preceded by the
# files relative pathname as a title.
sub OutMsg {
my($Ttl, $Path, $Msg) = @_;
if ($opt{o}) {
$Msg =~ s/^[ \t]*//;
print "$Path: $Msg\n";
} else {
if ($Ttl eq 0) {
print "==== $Path ====\n";
}
print "$Msg\n";
}
}
# Determine whether this a ELF dynamic object and if so investigate its runtime
# attributes.
sub ProcFile {
my($FullPath, $RelPath, $File, $Secure) = @_;
my(@Elf, @Ldd, $Dyn, $Intp, $Dll, $Ttl, $Sym, $Interp, $Stack);
my($Sun, $Relsz, $Pltsz, $Tex, $Stab, $Strip, $Lddopt, $SymSort);
my($Val, $Header, $SkipLdd, $IsX86, $RWX, $UnDep);
my($HasDirectBinding, $HasVerdef);
# Ignore symbolic links.
if (-l $FullPath) {
return;
}
$Ttl = 0;
@Ldd = 0;
# Determine whether we have access to inspect the file.
if (!(-r $FullPath)) {
OutMsg($Ttl++, $RelPath,
"\tunable to inspect file: permission denied");
return;
}
# Determine if this is a file we don't care about.
if (!$opt{a}) {
if ($File =~ $SkipFiles) {
return;
}
}
# Determine whether we have a executable (static or dynamic) or a
# shared object.
@Elf = split(/\n/, `elfdump -epdicyv $FullPath 2>&1`);
$Dyn = $Intp = $Dll = $Stack = $IsX86 = $RWX = 0;
$Interp = 1;
$Header = 'None';
foreach my $Line (@Elf) {
# If we have an invalid file type (which we can tell from the
# first line), or we're processing an archive, bail.
if ($Header eq 'None') {
if (($Line =~ /invalid file/) ||
($Line =~ /$FullPath(.*):/)) {
return;
}
}
if ($Line =~ /^ELF Header/) {
$Header = 'Ehdr';
} elsif ($Line =~ /^Program Header/) {
$Header = 'Phdr';
$RWX = 0;
} elsif ($Line =~ /^Interpreter/) {
$Header = 'Intp';
} elsif ($Line =~ /^Dynamic Section/) {
# A dynamic section indicates we're a dynamic object
# (this makes sure we don't check static executables).
$Dyn = 1;
} elsif (($Header eq 'Ehdr') && ($Line =~ /e_type:/)) {
# The e_type field indicates whether this file is a
# shared object (ET_DYN) or an executable (ET_EXEC).
if ($Line =~ /ET_DYN/) {
$Dll = 1;
} elsif ($Line !~ /ET_EXEC/) {
return;
}
} elsif (($Header eq 'Ehdr') && ($Line =~ /ei_class:/)) {
# If we encounter a 64-bit object, but we're not running
# on a 64-bit system, suppress calling ldd(1).
if (($Line =~ /ELFCLASS64/) && !$Ena64) {
$SkipLdd = 1;
}
} elsif (($Header eq 'Ehdr') && ($Line =~ /e_machine:/)) {
# If it's a X86 object, we need to enforce RW- data.
if (($Line =~ /(EM_AMD64|EM_386)/)) {
$IsX86 = 1;
}
} elsif (($Header eq 'Phdr') &&
($Line =~ /\[ PF_X PF_W PF_R \]/)) {
# RWX segment seen.
$RWX = 1;
} elsif (($Header eq 'Phdr') &&
($Line =~ /\[ PT_LOAD \]/ && $RWX && $IsX86)) {
# Seen an RWX PT_LOAD segment.
if ($File !~ $SkipNoExStkFiles) {
OutMsg($Ttl++, $RelPath,
"\tapplication requires non-executable " .
"data\t<no -Mmapfile_noexdata?>");
}
} elsif (($Header eq 'Phdr') &&
($Line =~ /\[ PT_SUNWSTACK \]/)) {
# This object defines a non-executable stack.
$Stack = 1;
} elsif (($Header eq 'Intp') && !$opt{a} &&
($Line =~ $SkipInterps)) {
# This object defines an interpretor we should skip.
$Interp = 0;
}
}
# Determine whether this ELF executable or shared object has a
# conforming mcs(1) comment section. If the correct $(POST_PROCESS)
# macros are used, only a 3 or 4 line .comment section should exist
# containing one or two "@(#)SunOS" identifying comments (one comment
# for a non-debug build, and two for a debug build). The results of
# the following split should be three or four lines, the last empty
# line being discarded by the split.
if ($opt{m}) {
my(@Mcs, $Con, $Dev);
@Mcs = split(/\n/, `mcs -p $FullPath 2>&1`);
$Con = $Dev = $Val = 0;
foreach my $Line (@Mcs) {
$Val++;
if (($Val == 3) && ($Line !~ /^@\(#\)SunOS/)) {
$Con = 1;
last;
}
if (($Val == 4) && ($Line =~ /^@\(#\)SunOS/)) {
$Dev = 1;
next;
}
if (($Dev == 0) && ($Val == 4)) {
$Con = 1;
last;
}
if (($Dev == 1) && ($Val == 5)) {
$Con = 1;
last;
}
}
if ($opt{m} && ($Con == 1)) {
OutMsg($Ttl++, $RelPath,
"\tnon-conforming mcs(1) comment\t<no \$(POST_PROCESS)?>");
}
}
# Applications should contain a non-executable stack definition.
if (($Dll == 0) && ($Stack == 0)) {
if (!$opt{a}) {
if ($File =~ $SkipNoExStkFiles) {
goto DYN;
}
}
OutMsg($Ttl++, $RelPath,
"\tapplication requires non-executable stack\t<no -Mmapfile_noexstk?>");
}
DYN:
# Having caught any static executables in the mcs(1) check and non-
# executable stack definition check, continue with dynamic objects
# from now on.
if ($Dyn eq 0) {
return;
}
# Only use ldd unless we've encountered an interpreter that should
# be skipped.
if (!$SkipLdd && $Interp) {
my $LDDFullPath = $FullPath;
if ($Secure) {
# The execution of a secure application over an nfs file
# system mounted nosuid will result in warning messages
# being sent to /var/adm/messages. As this type of
# environment can occur with root builds, move the file
# being investigated to a safe place first. In addition
# remove its secure permission so that it can be
# influenced by any alternative dependency mappings.
my($TmpPath) = "$Tmpdir/$File";
system('cp', $LDDFullPath, $TmpPath);
chmod 0777, $TmpPath;
$LDDFullPath = $TmpPath;
}
# Use ldd(1) to determine the objects relocatability and use.
# By default look for all unreferenced dependencies. However,
# some objects have legitimate dependencies that they do not
# reference.
if ($LddNoU || ($RelPath =~ $UnusedPaths)) {
$Lddopt = "-ru";
} else {
$Lddopt = "-rU";
}
@Ldd = split(/\n/, `ldd $Lddopt $Env $LDDFullPath 2>&1`);
if ($Secure) {
unlink $LDDFullPath;
}
}
$Val = 0;
$Sym = 5;
$UnDep = 1;
foreach my $Line (@Ldd) {
if ($Val == 0) {
$Val = 1;
# Make sure ldd(1) worked. One possible failure is that
# this is an old ldd(1) prior to -e addition (4390308).
if ($Line =~ /usage:/) {
$Line =~ s/$/\t<old ldd(1)?>/;
OutMsg($Ttl++, $RelPath, $Line);
last;
} elsif ($Line =~ /execution failed/) {
OutMsg($Ttl++, $RelPath, $Line);
last;
}
# It's possible this binary can't be executed, ie. we've
# found a sparc binary while running on an intel system,
# or a sparcv9 binary on a sparcv7/8 system.
if ($Line =~ /wrong class/) {
OutMsg($Ttl++, $RelPath,
"\thas wrong class or data encoding");
next;
}
# Historically, ldd(1) likes executable objects to have
# their execute bit set. Note that this test isn't
# applied unless the -a option is in effect, as any
# non-executable files are skipped by default to reduce
# the cost of running this script.
if ($Line =~ /not executable/) {
OutMsg($Ttl++, $RelPath,
"\tis not executable");
next;
}
}
# Look for "file" or "versions" that aren't found. Note that
# these lines will occur before we find any symbol referencing
# errors.
if (($Sym == 5) && ($Line =~ /not found\)/)) {
if ($Line =~ /file not found\)/) {
$Line =~ s/$/\t<no -zdefs?>/;
}
OutMsg($Ttl++, $RelPath, $Line);
next;
}
# Look for relocations whose symbols can't be found. Note, we
# only print out the first 5 relocations for any file as this
# output can be excessive.
if ($Sym && ($Line =~ /symbol not found/)) {
# Determine if this file is allowed undefined
# references.
if ($Sym == 5) {
if (!$opt{a}) {
if ($File =~ $SkipUndefFiles) {
$Sym = 0;
next;
}
}
}
if ($Sym-- == 1) {
if (!$opt{o}) {
OutMsg($Ttl++, $RelPath,
"\tcontinued ...");
}
next;
}
# Just print the symbol name.
$Line =~ s/$/\t<no -zdefs?>/;
OutMsg($Ttl++, $RelPath, $Line);
next;
}
# Look for any unused search paths.
if ($Line =~ /unused search path=/) {
# Note, skip this comparison for __GNUC builds, as the
# gnu compilers insert numerous unused search paths.
if ($Gnuc == 1) {
next;
}
if (!$opt{a}) {
if ($Line =~ $SkipUnusedSearchPath) {
next;
}
}
if ($Secure) {
$Line =~ s!$Tmpdir/!!;
}
$Line =~ s/^[ \t]*(.*)/\t$1\t<remove search path?>/;
OutMsg($Ttl++, $RelPath, $Line);
next;
}
# Look for unreferenced dependencies. Note, if any unreferenced
# objects are ignored, then set $UnDep so as to suppress any
# associated unused-object messages.
if ($Line =~ /unreferenced object=/) {
if (!$opt{a}) {
if ($Line =~ $SkipUnrefObject) {
$UnDep = 0;
next;
}
}
if ($Secure) {
$Line =~ s!$Tmpdir/!!;
}
$Line =~ s/^[ \t]*(.*)/\t$1\t<remove lib or -zignore?>/;
OutMsg($Ttl++, $RelPath, $Line);
next;
}
# Look for any unused dependencies.
if ($UnDep && ($Line =~ /unused/)) {
if (!$opt{a}) {
if ($RelPath =~ $SkipUnusedDeps) {
next;
}
if ($Line =~ $SkipUnusedObject) {
next;
}
}
if ($Secure) {
$Line =~ s!$Tmpdir/!!;
}
$Line =~ s/^[ \t]*(.*)/\t$1\t<remove lib or -zignore?>/;
OutMsg($Ttl++, $RelPath, $Line);
next;
}
}
# Reuse the elfdump(1) data to investigate additional dynamic linking
# information.
$Sun = $Relsz = $Pltsz = $Dyn = $Stab = $SymSort = 0;
$Tex = $Strip = 1;
$HasDirectBinding = 0;
$HasVerdef = 0;
$Header = 'None';
ELF: foreach my $Line (@Elf) {
# We're only interested in the section headers and the dynamic
# section.
if ($Line =~ /^Section Header/) {
$Header = 'Shdr';
if (($Sun == 0) && ($Line =~ /\.SUNW_reloc/)) {
# This object has a combined relocation section.
$Sun = 1;
} elsif (($Stab == 0) && ($Line =~ /\.stab/)) {
# This object contain .stabs sections
$Stab = 1;
} elsif (($SymSort == 0) &&
($Line =~ /\.SUNW_dyn(sym)|(tls)sort/)) {
# This object contains a symbol sort section
$SymSort = 1;
}
if (($Strip == 1) && ($Line =~ /\.symtab/)) {
# This object contains a complete symbol table.
$Strip = 0;
}
next;
} elsif ($Line =~ /^Dynamic Section/) {
$Header = 'Dyn';
next;
} elsif ($Line =~ /^Syminfo Section/) {
$Header = 'Syminfo';
next;
} elsif ($Line =~ /^Version Definition Section/) {
$HasVerdef = 1;
next;
} elsif (($Header ne 'Dyn') && ($Header ne 'Syminfo')) {
next;
}
# Look into the Syminfo section.
# Does this object have at least one Directly Bound symbol?
if (($Header eq 'Syminfo')) {
my(@Symword);
if ($HasDirectBinding == 1) {
next;
}
@Symword = split(' ', $Line);
if (!defined($Symword[1])) {
next;
}
if ($Symword[1] =~ /B/) {
$HasDirectBinding = 1;
}
next;
}
# Does this object contain text relocations.
if ($Tex && ($Line =~ /TEXTREL/)) {
# Determine if this file is allowed text relocations.
if (!$opt{a}) {
if ($File =~ $SkipTextrelFiles) {
$Tex = 0;
next ELF;
}
}
OutMsg($Ttl++, $RelPath,
"\tTEXTREL .dynamic tag\t\t\t<no -Kpic?>");
$Tex = 0;
next;
}
# Does this file have any relocation sections (there are a few
# psr libraries with no relocations at all, thus a .SUNW_reloc
# section won't exist either).
if (($Relsz == 0) && ($Line =~ / RELA?SZ/)) {
$Relsz = hex((split(' ', $Line))[2]);
next;
}
# Does this file have any plt relocations. If the plt size is
# equivalent to the total relocation size then we don't have
# any relocations suitable for combining into a .SUNW_reloc
# section.
if (($Pltsz == 0) && ($Line =~ / PLTRELSZ/)) {
$Pltsz = hex((split(' ', $Line))[2]);
next;
}
# Does this object have any dependencies.
if ($Line =~ /NEEDED/) {
my($Need) = (split(' ', $Line))[3];
if ($Need =~ $OldDeps) {
# Catch any old (unnecessary) dependencies.
OutMsg($Ttl++, $RelPath,
"\tNEEDED=$Need\t<dependency no longer necessary>");
} elsif ($opt{i}) {
# Under the -i (information) option print out
# any useful dynamic entries.
OutMsg($Ttl++, $RelPath, "\tNEEDED=$Need");
}
next;
}
# Is this object built with -B direct flag on?
if ($Line =~ / DIRECT /) {
$HasDirectBinding = 1;
}
# Does this object specify a runpath.
if ($opt{i} && ($Line =~ /RPATH/)) {
my($Rpath) = (split(' ', $Line))[3];
OutMsg($Ttl++, $RelPath, "\tRPATH=$Rpath");
next;
}
}
# A shared object, that contains non-plt relocations, should have a
# combined relocation section indicating it was built with -z combreloc.
if ($Dll && $Relsz && ($Relsz != $Pltsz) && ($Sun == 0)) {
OutMsg($Ttl++, $RelPath,
"\tSUNW_reloc section missing\t\t<no -zcombreloc?>");
}
# No objects released to a customer should have any .stabs sections
# remaining, they should be stripped.
if ($opt{s} && $Stab) {
if (!$opt{a}) {
if ($File =~ $SkipStabFiles) {
goto DONESTAB;
}
}
OutMsg($Ttl++, $RelPath,
"\tdebugging sections should be deleted\t<no strip -x?>");
}
# Identify an object that is not built with either -B direct or
# -z direct.
if (($RelPath =~ $SkipDirectBindDirs) ||
($File =~ $SkipDirectBindFiles)) {
goto DONESTAB;
}
if ($Relsz && ($HasDirectBinding == 0)) {
OutMsg($Ttl++, $RelPath,
"\tobject has no direct bindings\t<no -B direct or -z direct?>");
}
DONESTAB:
# All objects should have a full symbol table to provide complete
# debugging stack traces.
if ($Strip) {
OutMsg($Ttl++, $RelPath,
"\tsymbol table should not be stripped\t<remove -s?>");
}
# If there are symbol sort sections in this object, report on
# any that have duplicate addresses.
ProcSymSort($FullPath, $RelPath, \$Ttl) if $SymSort;
# If -v was specified, and the object has a version definition
# section, generate output showing each public symbol and the
# version it belongs to.
ProcVerdef($FullPath, $RelPath, \$Ttl) if $HasVerdef && $opt{v};
}
## ProcSymSortOutMsg(RefTtl, RelPath, secname, addr, names...)
#
# Call OutMsg for a duplicate address error in a symbol sort
# section
#
sub ProcSymSortOutMsg {
my($RefTtl, $RelPath, $secname, $addr, @names) = @_;
OutMsg($$RefTtl++, $RelPath,
"$secname: duplicate $addr: ". join(', ', @names));
}
## ProcSymSort(FullPath, RelPath)
#
# Examine the symbol sort sections for the given object and report
# on any duplicate addresses found. Ideally, mapfile directives
# should be used when building objects that have multiple symbols
# with the same address so that only one of them appears in the sort
# section. This saves space, reduces user confusion, and ensures that
# libproc and debuggers always display public names instead of symbols
# that are merely implementation details.
#
sub ProcSymSort {
my($FullPath, $RelPath, $RefTtl) = @_;
# If this object is exempt from checking, return quietly
return if ($FullPath =~ $SkipSymSort);
open(SORT, "elfdump -S $FullPath|") ||
die "$Prog: Unable to execute elfdump (symbol sort sections)\n";
my $line;
my $last_addr;
my @dups = ();
my $secname;
while ($line = <SORT>) {
chomp $line;
next if ($line eq '');
# If this is a header line, pick up the section name
if ($line =~ /^Symbol Sort Section:\s+([^\s]+)\s+/) {
$secname = $1;
# Every new section is followed by a column header line
$line = <SORT>; # Toss header line
# Flush anything left from previous section
ProcSymSortOutMsg($RefTtl, $RelPath, $secname,
$last_addr, @dups) if (scalar(@dups) > 1);
# Reset variables for new sort section
$last_addr = '';
@dups = ();
next;
}
# Process symbol line
my @fields = split /\s+/, $line;
my $new_addr = $fields[2];
my $new_type = $fields[8];
my $new_name = $fields[9];
if ($new_type eq 'UNDEF') {
OutMsg($RefTtl++, $RelPath,
"$secname: unexpected UNDEF symbol " .
"(link-editor error): $new_name");
next;
}
if ($new_addr eq $last_addr) {
push @dups, $new_name;
} else {
ProcSymSortOutMsg($RefTtl, $RelPath, $secname,
$last_addr, @dups) if (scalar(@dups) > 1);
@dups = ( $new_name );
$last_addr = $new_addr;
}
}
ProcSymSortOutMsg($RefTtl, $RelPath, $secname, $last_addr, @dups)
if (scalar(@dups) > 1);
close SORT;
}
## ProcVerdef(FullPath, RelPath)
#
# Examine the version definition section for the given object and report
# each public symbol along with the version it belongs to.
#
sub ProcVerdef {
my($FullPath, $RelPath, $RefTtl) = @_;
my $line;
my $cur_ver = '';
my $tab = $opt{o} ? '' : "\t";
# pvs -dov provides information about the versioning hierarchy
# in the file. Lines are of the format:
# path - version[XXX];
# where [XXX] indicates optional information, such as flags
# or inherited versions.
#
# Private versions are allowed to change freely, so ignore them.
open(PVS, "pvs -dov $FullPath|") ||
die "$Prog: Unable to execute pvs (version definition section)\n";
while ($line = <PVS>) {
chomp $line;
if ($line =~ /^[^\s]+\s+-\s+([^;]+)/) {
my $ver = $1;
next if $ver =~ /private/i;
OutMsg($$RefTtl++, $RelPath, "${tab}VERDEF=$ver");
}
}
close PVS;
# pvs -dos lists the symbols assigned to each version definition.
# Lines are of the format:
# path - version: symbol;
# path - version: symbol (size);
# where the (size) is added to data items, but not for functions.
# We strip off the size, if present.
open(PVS, "pvs -dos $FullPath|") ||
die "$Prog: Unable to execute pvs (version definition section)\n";
while ($line = <PVS>) {
chomp $line;
if ($line =~ /^[^\s]+\s+-\s+([^:]+):\s*([^\s;]+)/) {
my $ver = $1;
my $sym = $2;
next if $ver =~ /private/i;
if ($opt{o}) {
OutMsg($$RefTtl++, $RelPath,
"VERSION=$ver, SYMBOL=$sym");
} else {
if ($cur_ver ne $ver) {
OutMsg($$RefTtl++, $RelPath, "\tVERSION=$ver");
$cur_ver = $ver;
}
OutMsg($$RefTtl++, $RelPath, "\t\tSYMBOL=$sym");
}
}
}
close PVS;
}
sub ProcDir {
my($FullDir, $RelDir) = @_;
my($NewFull, $NewRel);
# Determine if this is a directory we don't care about.
if (!$opt{a}) {
if ($RelDir =~ $SkipDirs) {
return;
}
}
# Open the directory and read each entry, omit files starting with "."
if (opendir(DIR, $FullDir)) {
foreach my $Entry (readdir(DIR)) {
if ($Entry =~ /^\./) {
next;
}
$NewFull = "$FullDir/$Entry";
# Ignore symlinks.
if (-l $NewFull) {
next;
}
if (!stat($NewFull)) {
next;
}
$NewRel = "$RelDir/$Entry";
# Descend into and process any directories.
if (-d _) {
ProcDir($NewFull, $NewRel);
next;
}
# Typically dynamic objects are executable, so we can
# reduce the overall cost of this script (a lot!) by
# screening out non-executables here, rather than pass
# them to file(1) later. However, it has been known
# for shared objects to be mistakenly left non-
# executable, so with -a let all files through so that
# this requirement can be verified (see ProcFile()).
if (!$opt{a}) {
if (! -x _) {
next;
}
}
# Process any standard files.
if (-f _) {
my($Secure) = 0;
if (-u _ || -g _) {
$Secure = 1;
}
ProcFile($NewFull, $NewRel, $Entry, $Secure);
next;
}
}
closedir(DIR);
}
}
# Create a crle(1) script for any 64-bit dependencies we locate. A runtime
# configuration file will be generated to establish alternative dependency
# mappings for all these dependencies.
sub Entercrle64 {
my($FullDir, $RelDir, $Entry) = @_;
if (!$Crle64) {
# Create and initialize the script if is doesn't already exit.
$Crle64 = "$Tmpdir/$Prog.crle64.$$";
open(CRLE64, "> $Crle64") ||
die "$Prog: open failed: $Crle64: $!";
print CRLE64 "#!/bin/sh\ncrle -64\\\n";
}
print CRLE64 "\t-o $FullDir -a $RelDir/$Entry \\\n";
}
# Create a crle(1) script for any 32-bit dependencies we locate. A runtime
# configuration file will be generated to establish alternative dependency
# mappings for all these dependencies.
sub Entercrle32 {
my($FullDir, $RelDir, $Entry) = @_;
if (!$Crle32) {
# Create and initialize the script if is doesn't already exit.
$Crle32 = "$Tmpdir/$Prog.crle32.$$";
open(CRLE32, "> $Crle32") ||
die "$Prog: open failed: $Crle32: $!";
print CRLE32 "#!/bin/sh\ncrle \\\n";
}
print CRLE32 "\t-o $FullDir -a $RelDir/$Entry \\\n";
}
# Having finished gathering dependencies, complete any crle(1) scripts and
# execute them to generate the associated runtime configuration files. In
# addition establish the environment variable required to pass the configuration
# files to ldd(1).
sub GenConf {
if ($Crle64) {
$Conf64 = "$Tmpdir/$Prog.conf64.$$";
print CRLE64 "\t-c $Conf64\n";
chmod 0755, $Crle64;
close CRLE64;
if (system($Crle64)) {
undef $Conf64;
}
}
if ($Crle32) {
$Conf32 = "$Tmpdir/$Prog.conf32.$$";
print CRLE32 "\t-c $Conf32\n";
chmod 0755, $Crle32;
close CRLE32;
if (system($Crle32)) {
undef $Conf32;
}
}
if ($Crle64 && $Conf64 && $Crle32 && $Conf32) {
$Env = "-e LD_FLAGS=config_64=$Conf64,config_32=$Conf32";
} elsif ($Crle64 && $Conf64) {
$Env = "-e LD_FLAGS=config_64=$Conf64";
} elsif ($Crle32 && $Conf32) {
$Env = "-e LD_FLAGS=config_32=$Conf32";
}
}
# Recurse through a directory hierarchy looking for appropriate dependencies.
sub GetDeps {
my($FullDir, $RelDir) = @_;
my($NewFull);
# Open the directory and read each entry, omit files starting with "."
if (opendir(DIR, $FullDir)) {
foreach my $Entry (readdir(DIR)) {
if ($Entry =~ /^\./) {
next;
}
$NewFull = "$FullDir/$Entry";
# We need to follow links so that any dependencies
# are expressed in all their available forms.
# Bail on symlinks like 32 -> .
if (-l $NewFull) {
if (readlink($NewFull) =~ /^\.$/) {
next;
}
}
if (!stat($NewFull)) {
next;
}
if (!$opt{a}) {
if ($NewFull =~ $SkipCrleConf) {
next;
}
}
# If this is a directory descend into it.
if (-d _) {
my($NewRel);
if ($RelDir =~ /^\/$/) {
$NewRel = "$RelDir$Entry";
} else {
$NewRel = "$RelDir/$Entry";
}
GetDeps($NewFull, $NewRel);
next;
}
# If this is a regular file determine if its a
# valid ELF dependency.
if (-f _) {
my($File);
# Typically shared object dependencies end with
# ".so" or ".so.?", hence we can reduce the cost
# of this script (a lot!) by screening out files
# that don't follow this pattern.
if (!$opt{a}) {
if ($Entry !~ /\.so(?:\.\d+)*$/) {
next;
}
}
$File = `file $NewFull`;
if ($File !~ /dynamic lib/) {
next;
}
if ($File =~ /32-bit/) {
Entercrle32($FullDir, $RelDir, $Entry);
} elsif ($Ena64) {
Entercrle64($FullDir, $RelDir, $Entry);
}
next;
}
}
closedir(DIR);
}
}
exit $Error