testcase to check for bad symbol name prefixes

This checks the main libs that would be directly or indirectly linked
against the users executable (libmpi.so, libmpi_mpifh.so, libmpi_usempi.so,
libopen-rte, libopen-pal) using "nm" and looking for symbols without ompi_
opal_ mpi_ etc prefixes.

Signed-off-by: Mark Allen <[email protected]>

Author: markalle

configure.ac

@@ -22,7 +22,7 @@
 # Copyright (c) 2013-2017 Intel, Inc.  All rights reserved.
 # Copyright (c) 2014-2016 Research Organization for Information Science
 #                         and Technology (RIST). All rights reserved.
-# Copyright (c) 2016      IBM Corporation.  All rights reserved.
+# Copyright (c) 2016-2017 IBM Corporation.  All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
@@ -1426,6 +1426,7 @@ AC_CONFIG_FILES([
     test/support/Makefile
     test/threads/Makefile
     test/util/Makefile
+    test/symbol_name/Makefile
 ])
 m4_ifdef([project_ompi], [AC_CONFIG_FILES([test/monitoring/Makefile])])
 

test/Makefile.am

@@ -13,6 +13,7 @@
 # Copyright (c) 2010      Cisco Systems, Inc. All rights reserved.
 # Copyright (c) 2015-2016 Research Organization for Information Science
 #                         and Technology (RIST). All rights reserved.
+# Copyright (c) 2017      IBM Corporation. All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
@@ -21,7 +22,7 @@
 #
 
 # support needs to be first for dependencies
-SUBDIRS = support asm class threads datatype util dss
+SUBDIRS = support asm class threads datatype util dss symbol_name
 if PROJECT_OMPI
 SUBDIRS += monitoring
 endif

test/symbol_name/Makefile.am

@@ -0,0 +1,12 @@
+#
+# Copyright (c) 2017      IBM Corporation. All rights reserved.
+# $COPYRIGHT$
+#
+# Additional copyrights may follow
+#
+# $HEADER$
+#
+
+TESTS = nmcheck_prefix
+
+AM_TESTS_ENVIRONMENT = MYBASE='$(top_builddir)'; OMPI_LIBMPI_NAME=@OMPI_LIBMPI_NAME@; export MYBASE OMPI_LIBMPI_NAME;

test/symbol_name/nmcheck_prefix

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# Copyright (c) 2017      IBM Corporation. All rights reserved.
+
+
+# if there's no perl, skip the test
+perl -v > /dev/null 2>&1
+if [ $? -ne 0 ] ; then exit 0 ; fi
+
+perl nmcheck_prefix.pl

test/symbol_name/nmcheck_prefix.pl

@@ -0,0 +1,112 @@
+#!/usr/bin/perl
+
+# Copyright (c) 2017      IBM Corporation. All rights reserved.
+
+# env var MYBASE should be the top dir where ompi/ opal/ orte/ test/ etc live.
+# env var OMPI_LIBMPI_NAME should be @OMPI_LIBMPI_NAME@ from automake
+#
+# Most likely the libs we want to check are
+#     ompi/.libs/lib<mpi>.so
+#     ompi/mpi/fortran/mpif-h/.libs/lib<mpi>_mpifh.so
+#     ompi/mpi/fortran/use-mpi-tkr/.libs/lib<mpi>_usempi.so
+#     orte/.libs/libopen-rte.so
+#     opal/.libs/libopen-pal.so
+# but I hate to assume those are the locations, so I'll use 'find' and
+# test whatever ".so"s are found.
+
+@libs = ();
+$mpi = $ENV{OMPI_LIBMPI_NAME};
+for $name (
+    "lib${mpi}.so",
+    "lib${mpi}_mpifh.so",
+    "lib${mpi}_usempi.so",
+    "libopen-rte.so",
+    "libopen-pal.so" )
+{
+    for $loc (split(/\n/, `find $ENV{MYBASE} -name $name`)) {
+        push @libs, $loc;
+    }
+}
+
+print "Checking for bad symbol names in the main libs:\n";
+$isbad = 0;
+for $lib (@libs) {
+    print "checking $lib\n";
+    check_lib_for_bad_exports($lib);
+}
+if ($isbad) { exit(-1); }
+exit(0);
+
+
+sub check_lib_for_bad_exports {
+    my $lib = $_[0];
+    my @symbols;
+    my $s;
+
+    @symbols = get_nm($lib, 'all');
+
+    # grep to get rid of symbol prefixes that are considered acceptable,
+    # leaving behind anything bad:
+    @symbols = grep(!/^ompi_/i, @symbols);
+    @symbols = grep(!/^opal_/i, @symbols);
+    @symbols = grep(!/^orte_/i, @symbols);
+    @symbols = grep(!/^orted_/i, @symbols);
+    @symbols = grep(!/^mpi_/i, @symbols);
+    @symbols = grep(!/^pmpi_/i, @symbols);
+    @symbols = grep(!/^pmix_/i, @symbols);
+    @symbols = grep(!/^mpit_/, @symbols);
+    @symbols = grep(!/^ompit_/, @symbols);
+    @symbols = grep(!/^MPIR_/, @symbols);
+    @symbols = grep(!/^MPIX_/, @symbols);
+    @symbols = grep(!/^mpidbg_dll_locations$/, @symbols);
+    @symbols = grep(!/^mpimsgq_dll_locations$/, @symbols);
+
+    @symbols = grep(!/^mca_/, @symbols); # I'm tempted to call these bad
+    @symbols = grep(!/^netpatterns_/, @symbols); # I'm tempted to call these bad
+
+    @symbols = grep(!/^_fini$/, @symbols);
+    @symbols = grep(!/^_init$/, @symbols);
+    @symbols = grep(!/^_edata$/, @symbols);
+    @symbols = grep(!/^_end$/, @symbols);
+    @symbols = grep(!/^__bss_start$/, @symbols);
+    @symbols = grep(!/^__malloc_initialize_hook$/, @symbols);
+
+    # This is another section I'm not confident about, I'm not
+    # familiar with libevent so for now I'm giving everything related
+    # to it a pass. I'd like to change all these to opal_event_* but
+    # not without confirmation from someone else first.
+    @symbols = grep(!/^_event_debug_mode_on$/, @symbols);
+    @symbols = grep(!/^event_enable_debug_output$/, @symbols);
+    @symbols = grep(!/^event_global_current_base_$/, @symbols);
+    @symbols = grep(!/^event_module_include$/, @symbols);
+    @symbols = grep(!/^eventops$/, @symbols);
+
+    for $s (@symbols) {
+        print "    $s\n";
+        $isbad = 1;
+    }
+}
+
+# get_nm /path/to/some/libfoo.so <func|wfunc|all>
+
+sub get_nm {
+    my $lib = $_[0];
+    my $mode = $_[1];
+    my $pattern;
+    my $cmd;
+    my @tmp;
+
+    $pattern = " [TWBCDVR] ";
+    if ($mode eq 'func') { $pattern = " [T] "; }
+    if ($mode eq 'wfunc') { $pattern = " [W] "; }
+
+    $cmd = "nm $lib";
+    $cmd = "$cmd | grep \"$pattern\"";
+    $cmd = "$cmd | sed -e 's/  *\$//' -e 's/.* //'";
+
+    @tmp = split(/\n/, qx#$cmd#);
+    @tmp = sort(@tmp);
+
+    return(@tmp);
+}
+