update

Author: tgross35

ci/run.sh

@@ -54,9 +54,20 @@ update_rlib_paths() {
     fi
 }
 
+run_with_rlibs() {
+    if [ -d /builtins-target ]; then
+        rlib_paths=( /builtins-target/"${target}"/debug/deps/libcompiler_builtins-*.rlib )
+    else
+        rlib_paths=( target/"${target}"/debug/deps/libcompiler_builtins-*.rlib )
+    fi
+
+    "$@" "${rlib_paths[@]}"
+}
+
 # Remove any existing artifacts from previous tests that don't set #![compiler_builtins]
-update_rlib_paths
-rm -f "${rlib_paths[@]}"
+# update_rlib_paths
+# rm -f "${rlib_paths[@]}"
+run_with_rlibs rm -f
 
 cargo build --target "$target"
 cargo build --target "$target" --release
@@ -67,64 +78,9 @@ cargo build --target "$target" --release --features no-asm
 cargo build --target "$target" --features no-f16-f128
 cargo build --target "$target" --release --features no-f16-f128
 
-PREFIX=${target//unknown-/}-
-case "$target" in
-    armv7-*)
-        PREFIX=arm-linux-gnueabihf-
-        ;;
-    thumb*)
-        PREFIX=arm-none-eabi-
-        ;;
-    *86*-*)
-        PREFIX=
-        ;;
-esac
-
-NM=$(find "$(rustc --print sysroot)" \( -name llvm-nm -o -name llvm-nm.exe \) )
-if [ "$NM" = "" ]; then
-  NM="${PREFIX}nm"
-fi
-
-# i686-pc-windows-gnu tools have a dependency on some DLLs, so run it with
-# rustup run to ensure that those are in PATH.
-TOOLCHAIN="$(rustup show active-toolchain | sed 's/ (default)//')"
-if [[ "$TOOLCHAIN" == *i686-pc-windows-gnu ]]; then
-  NM="rustup run $TOOLCHAIN $NM"
-fi
-
 # Look out for duplicated symbols when we include the compiler-rt (C) implementation
-update_rlib_paths
-
-for rlib in "${rlib_paths[@]}"; do
-    set +x
-    echo "================================================================"
-    echo "checking $rlib for duplicate symbols"
-    echo "================================================================"
-    set -x
-    
-    duplicates_found=0
-
-    # NOTE On i586, It's normal that the get_pc_thunk symbol appears several
-    # times so ignore it
-    $NM -g --defined-only "$rlib" 2>&1 |
-      sort |
-      uniq -d |
-      grep -v __x86.get_pc_thunk --quiet |
-      grep 'T __' && duplicates_found=1
-
-    if [ "$duplicates_found" != 0 ]; then
-        echo "error: found duplicate symbols"
-        exit 1
-    else
-        echo "success; no duplicate symbols found"
-    fi
-done
-
-$NM -AUg "${rlib_paths[@]}"
-
-cargo run -p symbol-check -- check-duplicates "${rlib_paths[@]}"
-
-rm -f "${rlib_paths[@]}"
+run_with_rlibs cargo run -p symbol-check -- check-duplicates
+run_with_rlibs rm -f
 
 build_intrinsics_test() {
     cargo build --target "$target" -v --package builtins-test-intrinsics "$@"
@@ -144,35 +100,4 @@ CARGO_PROFILE_RELEASE_LTO=true \
     cargo build --target "$target" --package builtins-test-intrinsics --release
 
 # Ensure no references to any symbols from core
-update_rlib_paths
-for rlib in "${rlib_paths[@]}"; do
-    set +x
-    echo "================================================================"
-    echo "checking $rlib for references to core"
-    echo "================================================================"
-    set -x
-
-    tmpdir="${CARGO_TARGET_DIR:-target}/tmp"
-    test -d "$tmpdir" || mkdir "$tmpdir"
-    defined="$tmpdir/defined_symbols.txt"
-    undefined="$tmpdir/defined_symbols.txt"
-
-    $NM --quiet -U "$rlib" | grep 'T _ZN4core' | awk '{print $3}' | sort | uniq > "$defined"
-    $NM --quiet -u "$rlib" | grep 'U _ZN4core' | awk '{print $2}' | sort | uniq > "$undefined"
-    grep_has_results=0
-    grep -v -F -x -f "$defined" "$undefined" && grep_has_results=1
-
-    if [ "$target" = "powerpc64-unknown-linux-gnu" ]; then
-        echo "FIXME: powerpc64 fails these tests"
-    elif [ "$grep_has_results" != 0 ]; then
-        echo "error: found unexpected references to core"
-        exit 1
-    else
-        echo "success; no references to core found"
-    fi
-done
-
-
-cargo run -p symbol-check -- check-core-syms "${rlib_paths[@]}"
-
-true
+run_with_rlibs cargo run -p symbol-check -- check-core-syms

crates/symbol-check/src/main.rs

@@ -4,16 +4,18 @@
 use object::read::archive::{ArchiveFile, ArchiveMember};
 use object::{Object, ObjectSymbol, Symbol, SymbolKind, SymbolScope, SymbolSection};
 use std::collections::{BTreeMap, BTreeSet};
-use std::fs;
-use std::path::Path;
+use std::{fs, path::Path};
 
 const USAGE: &str = "Usage:
 
-    symbol-check check-duplicates PATHS...
-    symbol-check check-core-syms PATHS...
-";
+    symbol-check check-duplicates ARCHIVE ...
+    symbol-check check-core-syms ARCHIVE ...
+
+Note that multiple archives may be specified but they are checked independently
+rather than as a group.";
 
 fn main() {
+    // Create a `&str` vec so we can match on it.
     let args = std::env::args().collect::<Vec<_>>();
     let args_ref = args.iter().map(String::as_str).collect::<Vec<_>>();
 
@@ -73,8 +75,8 @@ fn verify_no_duplicates(path: impl AsRef<Path>) {
     let mut dups = Vec::new();
 
     for_each_symbol(path, |sym, member| {
+        // Only check defined globals
         if !sym.is_global() || sym.is_undefined() {
-            // Only check defined globals
             return;
         }
 
@@ -91,18 +93,20 @@ fn verify_no_duplicates(path: impl AsRef<Path>) {
     });
 
     if cfg!(windows) {
+        // Ignore literal constants
         let allowed_dup_pfx = ["__real@", "__xmm@"];
         dups.retain(|sym| !allowed_dup_pfx.iter().any(|pfx| sym.name.starts_with(pfx)));
     }
 
     if !dups.is_empty() {
         dups.sort_unstable_by(|a, b| a.name.cmp(&b.name));
-        panic!("Found duplicate symbols: {dups:#?}");
+        panic!("found duplicate symbols: {dups:#?}");
     }
 
     println!("success: no duplicate symbols found");
 }
 
+/// Ensure that there are no references to symbols from `core` that aren't also (somehow) defined.
 fn verify_core_symbols(path: impl AsRef<Path>) {
     println!(
         "Checking for references to core at {}",
@@ -113,6 +117,7 @@ fn verify_core_symbols(path: impl AsRef<Path>) {
     let mut undefined = Vec::new();
 
     for_each_symbol(path, |sym, member| {
+        // Find only symbols from `core`
         if !sym.name().unwrap().contains("_ZN4core") {
             return;
         }
@@ -125,27 +130,25 @@ fn verify_core_symbols(path: impl AsRef<Path>) {
         }
     });
 
+    // Discard any symbols that are defined somewhere in the archive
     undefined.retain(|sym| !defined.contains(&sym.name));
 
     if !undefined.is_empty() {
         undefined.sort_unstable_by(|a, b| a.name.cmp(&b.name));
-        panic!("Found undefined symbols from `core`: {undefined:#?}");
+        panic!("found undefined symbols from core: {undefined:#?}");
     }
 
     println!("success: no undefined references to core found");
 }
 
 /// For a given archive path, do something with each symbol.
 fn for_each_symbol(path: impl AsRef<Path>, mut f: impl FnMut(Symbol, &ArchiveMember)) {
-    let archive_data = fs::read(path).expect("reading file failed");
-    let x = ArchiveFile::parse(archive_data.as_slice()).expect("archive parse failed");
-    for member in x.members() {
-        let member = member.unwrap();
-        let data = member.data(&*archive_data).unwrap();
-        let obj = object::File::parse(data).expect("object parse failed");
-
-        for sym in obj.symbols() {
-            f(sym, &member);
-        }
+    let data = fs::read(path).expect("reading file failed");
+    let archive = ArchiveFile::parse(data.as_slice()).expect("archive parse failed");
+    for member in archive.members() {
+        let member = member.expect("failed to access member");
+        let obj_data = member.data(&*data).expect("failed to access object");
+        let obj = object::File::parse(obj_data).expect("failed to parse object");
+        obj.symbols().for_each(|sym| f(sym, &member));
     }
 }