switch to latest stable toolchain 1.83.0

CI script, makefile and docs are updated.

Signed-off-by: Jiaqi Gao <[email protected]>

Author: gaojiaqi7

.github/workflows/devtools.yml

@@ -11,8 +11,7 @@ name: Devtools
 
 env:
   AS: nasm
-  STABLE_RUST_TOOLCHAIN: 1.75.0
-  NIGHTLY_RUST_TOOLCHAIN: nightly-2023-12-31
+  RUST_TOOLCHAIN: 1.83.0
   TOOLCHAIN_PROFILE: minimal
 
 jobs:
@@ -44,12 +43,7 @@ jobs:
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: ${{ env.STABLE_RUST_TOOLCHAIN }}
-
-      - name: Install nightly toolchain
-        uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: ${{ env.NIGHTLY_RUST_TOOLCHAIN }}
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
 
       - name: Preparation work
         run: make preparation

.github/workflows/format.yml

@@ -6,6 +6,7 @@ env:
   AS: nasm
   AR: llvm-ar
   CC: clang
+  RUST_TOOLCHAIN: 1.83.0
 
 jobs:
   clippy:
@@ -30,7 +31,7 @@ jobs:
       - name: Install toolchain with clippy available
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: nightly-2023-12-31
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
           components: clippy
 
       - name: Add target
@@ -65,7 +66,7 @@ jobs:
       - name: Install toolchain with rustfmt available
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: nightly-2023-12-31
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
           components: rustfmt
 
       - name: Preparation Work

.github/workflows/fuzz.yml

@@ -13,7 +13,7 @@ env:
   AS: nasm
   AR_x86_64_unknown_none: llvm-ar
   CC_x86_64_unknown_none: clang
-  RUST_TOOLCHAIN: nightly-2023-12-31
+  RUST_TOOLCHAIN: nightly
   TOOLCHAIN_PROFILE: minimal
 
 jobs:
@@ -33,20 +33,18 @@ jobs:
           submodules: recursive
       - uses: dtolnay/rust-toolchain@stable
         with:
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
           components: rust-src, llvm-tools-preview
-
-      - name: Run cargo install cargo-xbuild
-        run: cargo install cargo-xbuild
 
       - name: install NASM
         uses: ilammy/setup-nasm@v1
 
       - name: Install AFL (Linux)
-        run: cargo install cargo-afl
+        run: cargo +nightly install cargo-afl
         if: runner.os == 'Linux'
 
       - name: Install Cargo-Fuzz (Linux)
-        run: cargo +stable install cargo-fuzz
+        run: cargo install cargo-fuzz
         if: runner.os == 'Linux'
 
       - name: Preparation work

.github/workflows/integration-tdx.yml

@@ -11,7 +11,7 @@ name: Integration Test on TDX Server
 
 env:
   AS: nasm
-  RUST_TOOLCHAIN: nightly-2023-12-31
+  RUST_TOOLCHAIN: 1.83.0
   TOOLCHAIN_PROFILE: minimal
 
 jobs:
@@ -36,8 +36,8 @@ jobs:
       - name: Install toolchain
         run: bash sh_script/update_toolchain.sh ${{ env.RUST_TOOLCHAIN }}
 
-      - name: Run cargo install cargo-xbuild
-        run: cargo install cargo-xbuild
+      - name: Add `x86_64-unknown-none` target
+        run: rustup target add x86_64-unknown-none
 
       - name: Preparation Work
         run: bash sh_script/preparation.sh

.github/workflows/integration.yml

@@ -47,8 +47,8 @@ jobs:
           toolchain: ${{ env.RUST_TOOLCHAIN }}
           components: rust-src, llvm-tools-preview
 
-      - name: Run cargo install cargo-xbuild
-        run: cargo install cargo-xbuild
+      - name: Add `x86_64-unknown-none` target
+        run: rustup target add x86_64-unknown-none --toolchain ${{ env.RUST_TOOLCHAIN }}
 
       # install QEMU
       - name: Install QEMU (Linux)

.github/workflows/library.yml

@@ -11,8 +11,7 @@ name: Library Crates
 
 env:
   AS: nasm
-  STABLE_RUST_TOOLCHAIN: 1.75.0
-  NIGHTLY_RUST_TOOLCHAIN: nightly-2023-12-31
+  RUST_TOOLCHAIN: 1.83.0
   TOOLCHAIN_PROFILE: minimal
 
 jobs:
@@ -37,15 +36,10 @@ jobs:
       - name: install NASM
         uses: ilammy/setup-nasm@v1
 
-      - name: Install stable toolchain
+      - name: Install rust toolchain
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: ${{ env.STABLE_RUST_TOOLCHAIN }}
-
-      - name: Install nightly toolchain
-        uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: ${{ env.NIGHTLY_RUST_TOOLCHAIN }}
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
 
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -82,15 +76,10 @@ jobs:
       - name: install NASM
         uses: ilammy/setup-nasm@v1
 
-      - name: Install stable toolchain
-        uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: ${{ env.STABLE_RUST_TOOLCHAIN }}
-
-      - name: Install nightly toolchain
+      - name: Install rust toolchain
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: ${{ env.NIGHTLY_RUST_TOOLCHAIN }}
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
 
       - name: Checkout sources
         uses: actions/checkout@v4

.github/workflows/main.yml

@@ -15,7 +15,7 @@ env:
   CC_x86_64_unknown_linux_gnu: clang
   AR_x86_64_unknown_none: llvm-ar
   CC_x86_64_unknown_none: clang
-  RUST_TOOLCHAIN: nightly-2023-12-31
+  RUST_TOOLCHAIN: 1.83.0
   TOOLCHAIN_PROFILE: minimal
 
 jobs:
@@ -51,8 +51,8 @@ jobs:
           toolchain: ${{ env.RUST_TOOLCHAIN }}
           components: rust-src
 
-      - name: Run cargo install cargo-xbuild
-        run: cargo install cargo-xbuild
+      - name: Add `x86_64-unknown-none` target
+        run: rustup target add x86_64-unknown-none
 
       - name: Preparation Work
         run: bash sh_script/preparation.sh
@@ -61,10 +61,10 @@ jobs:
         run: make test 
 
       - name: Build Release TdShim
-        run: cargo xbuild -p td-shim --target x86_64-unknown-none --release --features=main,tdx
+        run: cargo build -p td-shim --target x86_64-unknown-none --release --features=main,tdx
 
       - name: Build Debug TdShim
-        run: cargo xbuild -p td-shim --target x86_64-unknown-none --features=main,tdx --no-default-features
+        run: cargo build -p td-shim --target x86_64-unknown-none --features=main,tdx --no-default-features
 
       - name: Build td-shim-tools
         run: |

.github/workflows/release.yaml

@@ -2,7 +2,7 @@ name: Release TD-shim
 on: create
 
 env:
-  RUST_TOOLCHAIN: nightly-2023-12-31
+  RUST_TOOLCHAIN: 1.83.0
   TOOLCHAIN_PROFILE: minimal
 
 jobs:
@@ -33,8 +33,8 @@ jobs:
           toolchain: ${{ env.RUST_TOOLCHAIN }}
           components: rust-src
 
-      - name: Run cargo install cargo-xbuild
-        run: cargo install cargo-xbuild
+      - name: Add `x86_64-unknown-none` target
+        run: rustup target add x86_64-unknown-none
 
       - name: Preparation Work
         run: make preparation

Makefile

@@ -1,5 +1,5 @@
 export CARGO=cargo
-export STABLE_TOOLCHAIN:=1.75.0
+export STABLE_TOOLCHAIN:=1.83.0
 export NIGHTLY_TOOLCHAIN:=nightly-2023-12-31
 export BUILD_TYPE:=release
 export PREFIX:=/usr/local
@@ -11,8 +11,7 @@ else
 	export BUILD_TYPE_FLAG=
 endif
 
-GENERIC_LIB_CRATES = td-layout td-logger td-shim-interface td-loader cc-measurement
-NIGHTLY_LIB_CRATES = td-exception td-paging tdx-tdcall
+LIB_CRATES = td-layout td-logger td-shim-interface td-loader cc-measurement td-exception td-paging tdx-tdcall
 SHIM_CRATES = td-shim td-payload
 TEST_CRATES = test-td-exception test-td-paging
 TOOL_CRATES = td-shim-tools
@@ -51,7 +50,7 @@ uninstall-devtools: uninstall-subdir-devtools $(TOOL_CRATES:%=uninstall-devtool-
 .PHONY: tools-devtools
 tools-devtools: tools-subdir-devtools
 
-install-devtool-%: nightly-build-%
+install-devtool-%:
 	mkdir -p ${TOPDIR}/devtools/bin
 	${CARGO} install --bins --target-dir ${TOPDIR}/devtools/bin/ --path $(patsubst install-devtool-%,%,$@)
 
@@ -71,13 +70,13 @@ afl-test: afl_test
 libfuzzer-test: libfuzzer_test
 
 # Targets for library crates
-lib-build: $(GENERIC_LIB_CRATES:%=build-%) $(NIGHTLY_LIB_CRATES:%=nightly-build-%)
+lib-build: $(LIB_CRATES:%=build-%)
 
-lib-check: $(GENERIC_LIB_CRATES:%=check-%) $(NIGHTLY_LIB_CRATES:%=nightly-check-%)
+lib-check: $(LIB_CRATES:%=check-%)
 
-lib-test: $(GENERIC_LIB_CRATES:%=test-%) $(NIGHTLY_LIB_CRATES:%=nightly-test-%)
+lib-test: $(LIB_CRATES:%=test-%)
 
-lib-clean: $(GENERIC_LIB_CRATES:%=clean-%) $(NIGHTLY_LIB_CRATES:%=nightly-clean-%)
+lib-clean: $(LIB_CRATES:%=clean-%)
 
 # Targets for integration test crates
 integration-build: $(TEST_CRATES:%=integration-build-%)
@@ -90,13 +89,13 @@ integration-clean: $(TEST_CRATES:%=integration-clean-%)
 
 # Target for crates which should be compiled with `x86_64-unknown-none` target
 none-build-%:
-	${CARGO} +${NIGHTLY_TOOLCHAIN} xbuild --target x86_64-unknown-none -p $(patsubst none-build-%,%,$@) ${BUILD_TYPE_FLAG}
+	${CARGO} +${STABLE_TOOLCHAIN} build --target x86_64-unknown-none -p $(patsubst none-build-%,%,$@) ${BUILD_TYPE_FLAG}
 
 none-check-%:
-	 ${CARGO} +${NIGHTLY_TOOLCHAIN}xcheck --target x86_64-unknown-none -p $(patsubst none-check-%,%,$@) ${BUILD_TYPE_FLAG}
+	 ${CARGO} +${STABLE_TOOLCHAIN} check --target x86_64-unknown-none -p $(patsubst none-check-%,%,$@) ${BUILD_TYPE_FLAG}
 
 none-clean-%:
-	${CARGO} +${NIGHTLY_TOOLCHAIN} clean --target x86_64-unknown-none -p $(patsubst none-clean-%,%,$@) ${BUILD_TYPE_FLAG}
+	${CARGO} +${STABLE_TOOLCHAIN} clean --target x86_64-unknown-none -p $(patsubst none-clean-%,%,$@) ${BUILD_TYPE_FLAG}
 
 # Target for integration test crates which should be compiled with `x86_64-custom.json` target
 integration-build-%:
@@ -122,20 +121,7 @@ clean-%:
 	${CARGO} +${STABLE_TOOLCHAIN} clean -p $(patsubst clean-%,%,$@) ${BUILD_TYPE_FLAG}
 
 test-%:
-	${CARGO} +${NIGHTLY_TOOLCHAIN} test -p $(patsubst test-%,%,$@) ${BUILD_TYPE_FLAG}
-
-# Targets for normal library/binary crates
-nightly-build-%:
-	${CARGO} +${NIGHTLY_TOOLCHAIN} build -p $(patsubst nightly-build-%,%,$@) ${BUILD_TYPE_FLAG}
-
-nightly-check-%:
-	${CARGO} +${NIGHTLY_TOOLCHAIN} check -p $(patsubst nightly-check-%,%,$@) ${BUILD_TYPE_FLAG}
-
-nightly-clean-%:
-	${CARGO} +${NIGHTLY_TOOLCHAIN} clean -p $(patsubst nightly-clean-%,%,$@) ${BUILD_TYPE_FLAG}
-
-nightly-test-%:
-	${CARGO} +${NIGHTLY_TOOLCHAIN} test -p $(patsubst nightly-test-%,%,$@) ${BUILD_TYPE_FLAG}
+	${CARGO} +${STABLE_TOOLCHAIN} test -p $(patsubst test-%,%,$@) ${BUILD_TYPE_FLAG}
 
 # Targets for subdirectories
 build-subdir-%:

README.md

@@ -57,18 +57,13 @@ The threat model analysis is at [td-shim threat model](doc/threat_model.md).
 
 1. Install [RUST](https://www.rust-lang.org/)
 
-please use nightly-2023-12-31.
-
-NOTE: We need install nightly version because we use cargo-xbuild.
-
-1.1. Install xbuild
+please use 1.83.0.
 
 ```
-cargo install cargo-xbuild
+curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain 1.83.0
+rustup target add x86_64-unknown-none
 ```
 
-Please reinstall cargo-xbuild, after you update the rust toolchain.
-
 2. Install [NASM](https://www.nasm.us/)
 
 Please make sure nasm can be found in PATH.
@@ -121,27 +116,27 @@ cargo image --example-payload --release
 Build TdShim to launch a payload support Linux Boot Protocol
 
 ```
-cargo xbuild -p td-shim --target x86_64-unknown-none --release --features=main,tdx
+cargo build -p td-shim --target x86_64-unknown-none --release --features=main,tdx
 cargo run -p td-shim-tools --bin td-shim-ld --features=linker -- target/x86_64-unknown-none/release/ResetVector.bin target/x86_64-unknown-none/release/td-shim -o target/release/final.bin
 ```
 
 Build TdShim to launch a executable payload
 
 ```
-cargo xbuild -p td-shim --target x86_64-unknown-none --release --features=main,tdx --no-default-features
+cargo build -p td-shim --target x86_64-unknown-none --release --features=main,tdx --no-default-features
 ```
 
 Build Elf format payload
 
 ```
-cargo xbuild -p td-payload --target x86_64-unknown-none --release --bin example --features=tdx,start,cet-shstk,stack-guard
+cargo build -p td-payload --target x86_64-unknown-none --release --bin example --features=tdx,start,cet-shstk,stack-guard
 cargo run -p td-shim-tools --bin td-shim-ld -- target/x86_64-unknown-none/release/ResetVector.bin target/x86_64-unknown-none/release/td-shim -t executable -p target/x86_64-unknown-none/release/example -o target/release/final-elf.bin
 ```
 
 To build the debug TdShim, please use `dev-opt` profile to build `td-shim` binary. For example:
 
 ```
-cargo xbuild -p td-shim --target x86_64-unknown-none --profile dev-opt --features=main,tdx
+cargo build -p td-shim --target x86_64-unknown-none --profile dev-opt --features=main,tdx
 cargo run -p td-shim-tools --bin td-shim-ld --features=linker -- target/x86_64-unknown-none/dev-opt/ResetVector.bin target/x86_64-unknown-none/dev-opt/td-shim -o target/debug/final.bin
 ```
 

devtools/Makefile

@@ -1,19 +1,19 @@
 build:
 	${CARGO} +${STABLE_TOOLCHAIN} build ${BUILD_TYPE_FLAG} -p td-layout-config
-	${CARGO} +${NIGHTLY_TOOLCHAIN} build ${BUILD_TYPE_FLAG} -p td-benchmark
-	${CARGO} +${NIGHTLY_TOOLCHAIN} build ${BUILD_TYPE_FLAG} -p test-runner-client
+	${CARGO} +${STABLE_TOOLCHAIN} build ${BUILD_TYPE_FLAG} -p td-benchmark
+	${CARGO} +${STABLE_TOOLCHAIN} build ${BUILD_TYPE_FLAG} -p test-runner-client
 	${CARGO} +${STABLE_TOOLCHAIN} build ${BUILD_TYPE_FLAG} -p test-runner-server
 
 check:
 	${CARGO} +${STABLE_TOOLCHAIN} check ${BUILD_TYPE_FLAG} -p td-layout-config
-	${CARGO} +${NIGHTLY_TOOLCHAIN} check ${BUILD_TYPE_FLAG} -p td-benchmark
-	${CARGO} +${NIGHTLY_TOOLCHAIN} check ${BUILD_TYPE_FLAG} -p test-runner-client
+	${CARGO} +${STABLE_TOOLCHAIN} check ${BUILD_TYPE_FLAG} -p td-benchmark
+	${CARGO} +${STABLE_TOOLCHAIN} check ${BUILD_TYPE_FLAG} -p test-runner-client
 	${CARGO} +${STABLE_TOOLCHAIN} check ${BUILD_TYPE_FLAG} -p test-runner-server
 
 clean:
 	${CARGO} +${STABLE_TOOLCHAIN} clean ${BUILD_TYPE_FLAG} -p td-layout-config
-	${CARGO} +${NIGHTLY_TOOLCHAIN} clean ${BUILD_TYPE_FLAG} -p td-benchmark
-	${CARGO} +${NIGHTLY_TOOLCHAIN} clean ${BUILD_TYPE_FLAG} -p test-runner-client
+	${CARGO} +${STABLE_TOOLCHAIN} clean ${BUILD_TYPE_FLAG} -p td-benchmark
+	${CARGO} +${STABLE_TOOLCHAIN} clean ${BUILD_TYPE_FLAG} -p test-runner-client
 	${CARGO} +${STABLE_TOOLCHAIN} clean ${BUILD_TYPE_FLAG} -p test-runner-server
 
 install:

devtools/dev_container/Dockerfile

@@ -17,18 +17,16 @@ RUN apt-get update && \
     && apt-get clean && rm -rf /var/lib/apt/lists/*
 
 # Install rustup and a fixed version of Rust.
-RUN curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain nightly-2023-12-31
-RUN rustup toolchain install 1.75.0
+RUN curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain 1.83.0
 RUN rustup component add rust-src
 RUN rustup component add llvm-tools-preview
 COPY cargo_config /root/.cargo/config
 RUN cargo install cargo-xbuild
 
 # Install fuzzing tools
-# The rust version used now is nightly-2021-08-20, the latest cargo-fuzz needs to be upgraded to the rust version, and nightly-2021-08-20 can use cargo-fuzz 0.10.2 . 
 # For more information, please see doc/fuzzing.md.
 RUN cargo install cargo-afl
-RUN cargo install cargo-fuzz --version 0.10.2
+RUN cargo install cargo-fuzz --version 0.12.0
 
 # Install rudra
 RUN rustup component add rustc-dev