Updated Makefile and README.md

runtimeverification · Jan 24, 2025 · 2608687 · 2608687
1 parent 86e9316
commit 2608687
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 133 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -25,36 +25,12 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha }}
           submodules: recursive
 
-      - name: "Set up nightly Rust" # https://github.com/rust-lang/rustup/issues/3409
-        uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: nightly-2024-08-28
-
-      - name: 'Set up tree for rust dependency'
-        run: make setup
-
-      - name: 'Cache smir_pretty and rustc'
-        uses: Swatinem/rust-cache@v2
-        with:
-          workspaces: |
-            .
-            deps/rust/src
-          cache-directories: |
-            target
-            deps/rust/src/build
-            deps/rust/src/target
-
-      - name: 'Build smir_pretty and its rustc dependency'
+      - name: 'Build smir_pretty'
         run: | # rustc bootstrap checks this and refuses stage 1 in "CI"
           export GITHUB_ACTIONS="in denial" && \
           echo "GITHUB_ACTIONS = ${GITHUB_ACTIONS}" && \
-          make build_all
+          cargo build
 
       - name: 'Run smir integration tests'
         run: |
-          make integration-test
-
-      - name: 'Clean up toolchain'
-        if: always()
-        run: |
-          make rustup-clear-toolchain
+          make integration-test
diff --git a/Makefile b/Makefile
@@ -1,115 +1,13 @@
-TARGET ?= debug
-STAGE  ?= 1
-ifneq (0, $(shell test "${STAGE}" -gt 0 2>/dev/null; echo "$$?"))
-$(error STAGE must be set to a number greater than 0)
-endif
-ifneq (${TARGET}, $(filter ${TARGET},debug release))
-$(error TARGET must be set to one of debug/release)
-endif
-RUST_DIR=${CURDIR}/deps/rust
-STAGE_FILE=${RUST_DIR}/stage
-RUST_SRC=${RUST_DIR}/src
-RUST_ARCH=$(shell "${PWD}"/rustc_arch.sh)
-RUST_BUILD_DIR=${RUST_SRC}/build/${RUST_ARCH}
-RUST_INSTALL_DIR=${RUST_BUILD_DIR}/stage${STAGE}
-RUST_LIB_DIR=${RUST_INSTALL_DIR}/lib
-RUST_DEP_DIR=${RUST_BUILD_DIR}/stage1-rustc/${RUST_ARCH}/release/deps
-TARGET_DEP_DIR=${CURDIR}/target/${TARGET}/deps
-TEMP_DIR=${RUST_DIR}/temp
-#############################################
-# depend on the rust compiler
-RUST_REPO=https://github.com/rust-lang/rust
-# tip of the `beta` branch on 2025-01-14
-RUST_BRANCH=beta
-RUST_COMMIT=fe9b975
-#############################################
-TOOLCHAIN_NAME=smir_pretty
-RELEASE_FLAG=
-ifeq (${TARGET}, release)
-RELEASE_FLAG=--release
-endif
-
-default: build
-
-build_all: rust_build rust_set_toolchain build
-
-setup: rust_clone
-
-update: ${RUST_SRC}
-	cd "${RUST_SRC}"; git fetch origin; git checkout ${RUST_COMMIT}
-
-build:
-	cargo build ${RELEASE_FLAG}
-
-clean:
-	cd "${RUST_SRC}" && ./x.py clean
-	-rm -r "${TEMP_DIR}"
-	-rm -r "${RUST_DIR}"/tests
-	-rm -r ./target
-
-distclean:
-	cd "${RUST_SRC}" && git clean -dffx
-	-rm -r "${TEMP_DIR}"
-	-rm -r "${RUST_DIR}"/tests
-	-rm -r ./target
-
-# this clean removes old backup files which accumulate and lead to slow build times
-prebuild_clean: ${RUST_SRC}
-	-find -name '*.old' -delete
-	-rm -r "${TEMP_DIR}"
-
-# NOTE: a deeper clone depth is needed for the build process
-rust_clone:
-	git clone --depth 70 --single-branch --branch "${RUST_BRANCH}" "${RUST_REPO}" "${RUST_SRC}" && \
-	cd "${RUST_SRC}" && \
-	git checkout ${RUST_COMMIT}
-
-
-# rust_build for linking against custom rustc is involved
-#
-# 1. core rust compiler must be built via ./x.py build/install (we also build the test harness here)
-# 2. rustc-dev component must be installed (./x.py build/install does _not_ handle, must be done manually)
-# 3. HACK(only for ./x.py install) we copy required libraries to the libdir
-# 4. finally, use rustup to create custom toolchain
-
-rust_build: ${RUST_SRC} prebuild_clean
-	cd "${RUST_SRC}"; ./x.py build src/tools/compiletest
-	cd "${RUST_SRC}"; ./x.py build --stage ${STAGE} --set rust.debug-logging=true compiler/rustc library/std
-	cd "${RUST_SRC}"; ./x.py dist --set rust.debug-logging=true rustc-dev
-	mkdir -p "${TEMP_DIR}"
-	cd "${RUST_SRC}"; tar xf ./build/dist/rustc-dev*tar.gz -C "${TEMP_DIR}"
-	"${TEMP_DIR}"/rustc-dev*/install.sh --prefix="${RUST_INSTALL_DIR}" --sysconfdir="${RUST_INSTALL_DIR}" > "${RUST_DIR}"/rustc-dev-install.log 2>&1
-
-rust_lib_copy:
-	cd "${RUST_LIB_DIR}"; cp libLLVM* rustlib/*/lib/
-
-rust_set_toolchain: ${RUST_LIB_DIR}
-	rustup toolchain link "${TOOLCHAIN_NAME}" "${RUST_INSTALL_DIR}"
-	rustup override set "${TOOLCHAIN_NAME}"
-	echo ${STAGE} > ${STAGE_FILE}
-
-.PHONY: rustup-clear-toolchain
-rustup-clear-toolchain:
-	rustup override unset
-	rustup override unset --nonexistent
-	rustup toolchain uninstall "${TOOLCHAIN_NAME}"
-
-generate_ui_tests:
-	mkdir -p "${RUST_DIR}"/tests
-	cd "${RUST_SRC}"; ./get_runpass.sh tests/ui > "${RUST_DIR}"/tests_ui_sources
-	-cd "${RUST_SRC}"; ./ui_compiletest.sh "${RUST_SRC}" "${RUST_DIR}"/tests/ui/upstream "${RUST_DIR}"/tests_ui_sources --pass check --force-rerun 2>&1 > "${RUST_DIR}"/tests_ui_upstream.log
-	-cd "${RUST_SRC}"; RUST_BIN="${PWD}"/run.sh ./ui_compiletest.sh "${RUST_SRC}" "${RUST_DIR}"/tests/ui/smir "${RUST_DIR}"/tests_ui_sources --pass check --force-rerun 2>&1 > "${RUST_DIR}"/tests_ui_smir.log
-
 TESTDIR=$(CURDIR)/tests/integration/programs
 
 .PHONY: integration-test
 integration-test: TESTS     ?= $(shell find $(TESTDIR) -type f -name "*.rs")
-integration-test: SMIR      ?= $(CURDIR)/run.sh -Z no-codegen
+integration-test: SMIR      ?= cargo run -- "-Zno-codegen"
 # override this to tweak how expectations are formatted
 integration-test: NORMALIZE ?= jq -S -e -f $(TESTDIR)/../normalise-filter.jq
 # override this to re-make golden files
 integration-test: DIFF      ?= | diff -
-integration-test: build
+integration-test:
 	errors=""; \
 	report() { echo "$$1: $$2"; errors="$$errors\n$$1: $$2"; }; \
 	for rust in ${TESTS}; do \

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ cargo build
 
 NOTE: requries [rustup](https://www.rust-lang.org/tools/install)
 
-The `build.rs` script will ensure that the correct version of rust and the required components are installed and defaulted.
+The `build.rs` script will ensure that the correct version of rust and the required components are installed and defaulted. What `rustup` commands are run can be seen by adding verbosity flag `-vv` to `cargo`.
 
 ## Usage
 
@@ -19,7 +19,7 @@ The options that this tool accepts are identical to `rustc`.
 To generate stable MIR output without building a binary, you can invoke the tool as follows:
 
 ```shell
-cargo run <crate_root>
+cargo run -- <rustc_flags> <path_from_crate_root>
 ```
 
 There are a few environment variables that can be set to control the tools output: