test.sh

#!/usr/bin/env bash

# TODO(antoyo): rewrite to cargo-make (or just) or something like that to only rebuild the sysroot when needed?

set -e
#set -x

flags=
gcc_master_branch=1
channel="debug"
funcs=()
build_only=0
nb_parts=0
current_part=0
use_system_gcc=0
use_backend=0
cargo_target_dir=""

export CHANNEL='debug'

while [[ $# -gt 0 ]]; do
    case $1 in
        --release)
            codegen_channel=release
            channel="release"
            export CHANNEL='release'
            shift
            ;;
        --release-sysroot)
            sysroot_channel="--release"
            shift
            ;;
        --no-default-features)
            gcc_master_branch=0
            flags="$flags --no-default-features"
            shift
            ;;
        --features)
            shift
            flags="$flags --features $1"
            shift
            ;;
        "--test-rustc")
            funcs+=(test_rustc)
            shift
            ;;
        "--test-successful-rustc")
            funcs+=(test_successful_rustc)
            shift
            ;;
        "--test-failing-rustc")
            funcs+=(test_failing_rustc)
            shift
            ;;

        "--test-libcore")
            funcs+=(test_libcore)
            shift
            ;;

        "--clean-ui-tests")
            funcs+=(clean_ui_tests)
            shift
            ;;
        "--clean")
            funcs+=(clean)
            shift
            ;;

        "--std-tests")
            funcs+=(std_tests)
            shift
            ;;

        "--asm-tests")
            funcs+=(asm_tests)
            shift
            ;;

        "--extended-tests")
            funcs+=(extended_sysroot_tests)
            shift
            ;;
        "--extended-rand-tests")
            funcs+=(extended_rand_tests)
            shift
            ;;
        "--extended-regex-example-tests")
            funcs+=(extended_regex_example_tests)
            shift
            ;;
        "--extended-regex-tests")
            funcs+=(extended_regex_tests)
            shift
            ;;

        "--mini-tests")
            funcs+=(mini_tests)
            shift
            ;;

        "--build-sysroot")
            funcs+=(build_sysroot)
            shift
            ;;
        "--build")
            build_only=1
            shift
            ;;
        "--use-system-gcc")
            use_system_gcc=1
            shift
            ;;
        "--use-backend")
            use_backend=1
            shift
            export BUILTIN_BACKEND=$1
            shift
            ;;
        "--out-dir")
            shift
            export CARGO_TARGET_DIR=$1
            cargo_target_dir=$1
            shift
            ;;
        "--nb-parts")
            shift
            nb_parts=$1
            shift
            ;;
        "--current-part")
            shift
            current_part=$1
            shift
            ;;
        *)
            echo "Unknown option $1"
            exit 1
            ;;
    esac
done

if [ -f ./gcc_path ]; then
    export GCC_PATH=$(cat gcc_path)
elif (( $use_system_gcc == 1 )); then
    echo 'Using system GCC'
else
    echo 'Please put the path to your custom build of libgccjit in the file `gcc_path`, see Readme.md for details'
    exit 1
fi

export LD_LIBRARY_PATH="$GCC_PATH"
export LIBRARY_PATH="$GCC_PATH"

if [[ $use_backend == 0 ]]; then
    if [[ $channel == "release" ]]; then
        CARGO_INCREMENTAL=1 cargo rustc --release $flags
    else
        echo $LD_LIBRARY_PATH
        cargo rustc $flags
    fi
fi

if (( $build_only == 1 )); then
    echo "Since it's 'build-only', exiting..."
    exit
fi

source config.sh

function clean() {
    rm -r $cargo_target_dir || true
    mkdir -p $cargo_target_dir/gccjit
}

function mini_tests() {
    echo "[BUILD] mini_core"
    crate_types="lib,dylib"

    if [[ "$HOST_TRIPLE" != "$TARGET_TRIPLE" ]]; then
        crate_types="lib"
    fi

    $RUST_CMD example/mini_core.rs --crate-name mini_core --crate-type $crate_types --target $TARGET_TRIPLE

    echo "[BUILD] example"
    $RUST_CMD example/example.rs --crate-type lib --target $TARGET_TRIPLE

    echo "[AOT] mini_core_hello_world"
    $RUST_CMD example/mini_core_hello_world.rs --crate-name mini_core_hello_world --crate-type bin -g --target $TARGET_TRIPLE
    $RUN_WRAPPER $cargo_target_dir/mini_core_hello_world abc bcd
}

function build_sysroot() {
    echo "[BUILD] sysroot"
    time ./build_sysroot/build_sysroot.sh $sysroot_channel
}

# TODO(GuillaumeGomez): when rewriting in Rust, refactor with the code in tests/lang_tests_common.rs if possible.
function run_in_vm() {
    vm_parent_dir=${CG_GCC_VM_DIR:-$(pwd)}
    vm_dir=vm
    exe=$1
    exe_filename=$(basename $exe)
    vm_home_dir=$vm_parent_dir/$vm_dir/home
    vm_exe_path=$vm_home_dir/$exe_filename
    inside_vm_exe_path=/home/$exe_filename
    sudo cp $exe $vm_exe_path

    shift
    pushd $vm_parent_dir
    sudo chroot $vm_dir qemu-m68k-static $inside_vm_exe_path $@
    popd
}

function std_tests() {
    echo "[AOT] arbitrary_self_types_pointers_and_wrappers"
    $RUST_CMD example/arbitrary_self_types_pointers_and_wrappers.rs --crate-name arbitrary_self_types_pointers_and_wrappers --crate-type bin --target $TARGET_TRIPLE
    $RUN_WRAPPER $cargo_target_dir/arbitrary_self_types_pointers_and_wrappers

    echo "[AOT] alloc_system"
    $RUST_CMD example/alloc_system.rs --crate-type lib --target "$TARGET_TRIPLE"

    # FIXME: doesn't work on m68k.
    if [[ "$HOST_TRIPLE" == "$TARGET_TRIPLE" ]]; then
        echo "[AOT] alloc_example"
        $RUST_CMD example/alloc_example.rs --crate-type bin --target $TARGET_TRIPLE
        $RUN_WRAPPER $cargo_target_dir/alloc_example
    fi

    echo "[AOT] dst_field_align"
    # FIXME(antoyo): Re-add -Zmir-opt-level=2 once rust-lang/rust#67529 is fixed.
    $RUST_CMD example/dst-field-align.rs --crate-name dst_field_align --crate-type bin --target $TARGET_TRIPLE
    $RUN_WRAPPER $cargo_target_dir/dst_field_align || (echo $?; false)

    echo "[AOT] std_example"
    std_flags="--cfg feature=\"master\""
    if (( $gcc_master_branch == 0 )); then
        std_flags=""
    fi
    $RUST_CMD example/std_example.rs --crate-type bin --target $TARGET_TRIPLE $std_flags
    $RUN_WRAPPER $cargo_target_dir/std_example --target $TARGET_TRIPLE

    echo "[AOT] subslice-patterns-const-eval"
    $RUST_CMD example/subslice-patterns-const-eval.rs --crate-type bin $TEST_FLAGS --target $TARGET_TRIPLE
    $RUN_WRAPPER $cargo_target_dir/subslice-patterns-const-eval

    echo "[AOT] track-caller-attribute"
    $RUST_CMD example/track-caller-attribute.rs --crate-type bin $TEST_FLAGS --target $TARGET_TRIPLE
    $RUN_WRAPPER $cargo_target_dir/track-caller-attribute

    echo "[BUILD] mod_bench"
    $RUST_CMD example/mod_bench.rs --crate-type bin --target $TARGET_TRIPLE
}

function setup_rustc() {
    rust_toolchain=$(cat rust-toolchain | grep channel | sed 's/channel = "\(.*\)"/\1/')

    git clone https://github.com/rust-lang/rust.git || true
    cd rust
    git fetch
    git checkout $($RUSTC -V | cut -d' ' -f3 | tr -d '(')
    export RUSTFLAGS=

    rm config.toml || true

    cat > config.toml <<EOF
change-id = 115898

[rust]
codegen-backends = []
deny-warnings = false
verbose-tests = true

[build]
cargo = "$(rustup which cargo)"
local-rebuild = true
rustc = "$HOME/.rustup/toolchains/$rust_toolchain-$HOST_TRIPLE/bin/rustc"

[target.x86_64-unknown-linux-gnu]
llvm-filecheck = "`which FileCheck-10 || which FileCheck-11 || which FileCheck-12 || which FileCheck-13 || which FileCheck-14`"

[llvm]
download-ci-llvm = false
EOF

    $RUSTC -V | cut -d' ' -f3 | tr -d '('
    git checkout $($RUSTC -V | cut -d' ' -f3 | tr -d '(') tests
}

function asm_tests() {
    setup_rustc

    echo "[TEST] rustc asm test suite"
    RUSTC_ARGS="-Zpanic-abort-tests -Csymbol-mangling-version=v0 -Zcodegen-backend="$(pwd)"/../target/"$CHANNEL"/librustc_codegen_gcc."$dylib_ext" --sysroot "$(pwd)"/../build_sysroot/sysroot -Cpanic=abort"
    COMPILETEST_FORCE_STAGE0=1 ./x.py test --run always --stage 0 tests/assembly/asm --rustc-args "$RUSTC_ARGS"
}

# FIXME(antoyo): linker gives multiple definitions error on Linux
#echo "[BUILD] sysroot in release mode"
#./build_sysroot/build_sysroot.sh --release

function test_libcore() {
    pushd build_sysroot/sysroot_src/library/core/tests
    echo "[TEST] libcore"
    rm -r ./target || true
    ../../../../../cargo.sh test
    popd
}

#echo
#echo "[BENCH COMPILE] mod_bench"

#COMPILE_MOD_BENCH_INLINE="$RUSTC example/mod_bench.rs --crate-type bin -Zmir-opt-level=3 -O --crate-name mod_bench_inline"
#COMPILE_MOD_BENCH_LLVM_0="rustc example/mod_bench.rs --crate-type bin -Copt-level=0 -o $cargo_target_dir/mod_bench_llvm_0 -Cpanic=abort"
#COMPILE_MOD_BENCH_LLVM_1="rustc example/mod_bench.rs --crate-type bin -Copt-level=1 -o $cargo_target_dir/mod_bench_llvm_1 -Cpanic=abort"
#COMPILE_MOD_BENCH_LLVM_2="rustc example/mod_bench.rs --crate-type bin -Copt-level=2 -o $cargo_target_dir/mod_bench_llvm_2 -Cpanic=abort"
#COMPILE_MOD_BENCH_LLVM_3="rustc example/mod_bench.rs --crate-type bin -Copt-level=3 -o $cargo_target_dir/mod_bench_llvm_3 -Cpanic=abort"

## Use 100 runs, because a single compilations doesn't take more than ~150ms, so it isn't very slow
#hyperfine --runs ${COMPILE_RUNS:-100} "$COMPILE_MOD_BENCH_INLINE" "$COMPILE_MOD_BENCH_LLVM_0" "$COMPILE_MOD_BENCH_LLVM_1" "$COMPILE_MOD_BENCH_LLVM_2" "$COMPILE_MOD_BENCH_LLVM_3"

#echo
#echo "[BENCH RUN] mod_bench"
#hyperfine --runs ${RUN_RUNS:-10} $cargo_target_dir/mod_bench{,_inline} $cargo_target_dir/mod_bench_llvm_*

function extended_rand_tests() {
    if (( $gcc_master_branch == 0 )); then
        return
    fi

    pushd rand
    cargo clean
    echo "[TEST] rust-random/rand"
    ../cargo.sh test --workspace
    popd
}

function extended_regex_example_tests() {
    if (( $gcc_master_branch == 0 )); then
        return
    fi

    pushd regex
    echo "[TEST] rust-lang/regex example shootout-regex-dna"
    cargo clean
    export CG_RUSTFLAGS="--cap-lints warn" # newer aho_corasick versions throw a deprecation warning
    # Make sure `[codegen mono items] start` doesn't poison the diff
    ../cargo.sh build --example shootout-regex-dna
    cat examples/regexdna-input.txt \
        | ../cargo.sh run --example shootout-regex-dna \
        | grep -v "Spawned thread" > res.txt
    diff -u res.txt examples/regexdna-output.txt
    popd
}

function extended_regex_tests() {
    if (( $gcc_master_branch == 0 )); then
        return
    fi

    pushd regex
    echo "[TEST] rust-lang/regex tests"
    export CG_RUSTFLAGS="--cap-lints warn" # newer aho_corasick versions throw a deprecation warning
    ../cargo.sh test --tests -- --exclude-should-panic --test-threads 1 -Zunstable-options -q
    popd
}

function extended_sysroot_tests() {
    #pushd simple-raytracer
    #echo "[BENCH COMPILE] ebobby/simple-raytracer"
    #hyperfine --runs "${RUN_RUNS:-10}" --warmup 1 --prepare "cargo clean" \
    #"RUSTC=rustc RUSTFLAGS='' cargo build" \
    #"../cargo.sh build"

    #echo "[BENCH RUN] ebobby/simple-raytracer"
    #cp ./target/debug/main ./raytracer_cg_gcc
    #hyperfine --runs "${RUN_RUNS:-10}" ./raytracer_cg_llvm ./raytracer_cg_gcc
    #popd

    extended_rand_tests
    extended_regex_example_tests
    extended_regex_tests
}

function test_rustc() {
    echo
    echo "[TEST] rust-lang/rust"

    setup_rustc

    for test in $(rg -i --files-with-matches "//(\[\w+\])?~|// error-pattern:|// build-fail|// run-fail|-Cllvm-args" tests/ui); do
      rm $test
    done
    rm tests/ui/consts/const_cmp_type_id.rs
    rm tests/ui/consts/issue-73976-monomorphic.rs

    git checkout -- tests/ui/issues/auxiliary/issue-3136-a.rs # contains //~ERROR, but shouldn't be removed

    rm -r tests/ui/{abi*,extern/,unsized-locals/,proc-macro/,threads-sendsync/,borrowck/,test*,consts/issue-miri-1910.rs} || true
    rm tests/ui/mir/mir_heavy_promoted.rs # this test is oom-killed in the CI.
    # Tests generating errors.
    rm tests/ui/consts/issue-94675.rs
    for test in $(rg --files-with-matches "thread" tests/ui); do
      rm $test
    done
    git checkout tests/ui/type-alias-impl-trait/auxiliary/cross_crate_ice.rs
    git checkout tests/ui/type-alias-impl-trait/auxiliary/cross_crate_ice2.rs
    git checkout tests/ui/macros/rfc-2011-nicer-assert-messages/auxiliary/common.rs
    git checkout tests/ui/imports/ambiguous-1.rs
    git checkout tests/ui/imports/ambiguous-4-extern.rs
    git checkout tests/ui/entry-point/auxiliary/bad_main_functions.rs

    RUSTC_ARGS="$TEST_FLAGS -Csymbol-mangling-version=v0 -Zcodegen-backend="$(pwd)"/../target/"$CHANNEL"/librustc_codegen_gcc."$dylib_ext" --sysroot "$(pwd)"/../build_sysroot/sysroot"

    if [ $# -eq 0 ]; then
        # No argument supplied to the function. Doing nothing.
        echo "No argument provided. Keeping all UI tests"
    elif [ $1 = "0" ]; then
        # Removing the failing tests.
        xargs -a ../failing-ui-tests.txt -d'\n' rm
    else
        # Removing all tests.
        find tests/ui -type f -name '*.rs' -not -path '*/auxiliary/*' -delete
        # Putting back only the failing ones.
        xargs -a ../failing-ui-tests.txt -d'\n' git checkout --
    fi

    if [ $nb_parts -gt 0 ]; then
        echo "Splitting ui_test into $nb_parts parts (and running part $current_part)"
        find tests/ui -type f -name '*.rs' -not -path "*/auxiliary/*" > ui_tests
        # To ensure it'll be always the same sub files, we sort the content.
        sort ui_tests -o ui_tests
        count=$((`wc -l < ui_tests` / $nb_parts))
        # We increment the number of tests by one because if this is an odd number, we would skip
        # one test.
        count=$((count + 1))
        split -d -l $count -a 1 ui_tests ui_tests.split
        # Removing all tests.
        find tests/ui -type f -name '*.rs' -not -path "*/auxiliary/*" -delete
        # Putting back only the ones we want to test.
        xargs -a "ui_tests.split$current_part" -d'\n' git checkout --
    fi

    echo "[TEST] rustc test suite"
    COMPILETEST_FORCE_STAGE0=1 ./x.py test --run always --stage 0 tests/ui/ --rustc-args "$RUSTC_ARGS" # --target $TARGET_TRIPLE
}

function test_failing_rustc() {
    test_rustc "1"
}

function test_successful_rustc() {
    test_rustc "0"
}

function clean_ui_tests() {
    find rust/build/x86_64-unknown-linux-gnu/test/ui/ -name stamp -delete
}

function all() {
    clean
    mini_tests
    build_sysroot
    std_tests
    #asm_tests
    test_libcore
    extended_sysroot_tests
    test_rustc
}

if [ ${#funcs[@]} -eq 0 ]; then
    echo "No command passed, running '--all'..."
    all
else
    for t in ${funcs[@]}; do
        $t
    done
fi