Merge pull request #486 from rust-osdev/master

merge master into next

Author: Freax13

.github/workflows/build.yml

@@ -13,6 +13,10 @@ on:
 permissions:
   contents: read
 
+env:
+  RUSTFLAGS: -Dwarnings
+  RUSTDOCFLAGS: -Dwarnings
+
 jobs:
   stable:
     name: "Test MSRV and Stable Features"
@@ -24,100 +28,45 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: ${{ matrix.rust }}
-          override: true
-      - name: Run cargo build for stable
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --no-default-features --features instructions
-      - name: Run cargo build for stable without instructions
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --no-default-features
-      - name: Run cargo doc for stable
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: --no-default-features --features instructions
-      - name: Run cargo doc for stable without instructions
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: --no-default-features
-      - name: Run cargo test for stable
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --no-default-features --features instructions
-      - name: Run cargo test for stable without instructions
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --no-default-features
+      - run: cargo build --no-default-features --features instructions
+      - run: cargo build --no-default-features
+      - run: cargo doc --no-default-features --features instructions
+      - run: cargo doc --no-default-features
+      - run: cargo test --no-default-features --features instructions
+      - run: cargo test --no-default-features
 
   test:
     name: "Test"
 
     strategy:
       fail-fast: false
       matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
+        platform: [ubuntu-latest, macos-12, macos-latest, windows-latest]
 
     runs-on: ${{ matrix.platform }}
     timeout-minutes: 15
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@nightly
         with:
-          profile: minimal
-          toolchain: nightly
-          override: true
-          target: x86_64-unknown-linux-musl
-
-      - name: "Print Rust Version"
-        run: |
-          rustc -Vv
-          cargo -Vv
+          targets: x86_64-unknown-linux-musl, i686-unknown-linux-gnu, thumbv7em-none-eabihf
 
-      - name: "Run cargo build"
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
+      - run: cargo build
 
-      - name: "Run cargo doc"
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
+      - run: cargo doc
 
-      - name: "Run cargo build on musl"
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --target x86_64-unknown-linux-musl
+      - run: cargo build --target x86_64-unknown-linux-musl
         if: runner.os == 'Linux'
 
-      - name: "Run cargo test"
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
+      - run: cargo test
 
-      - name: "Run cargo test on musl"
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --target x86_64-unknown-linux-musl
+      - run: cargo test --target x86_64-unknown-linux-musl
         if: runner.os == 'Linux'
 
-      - name: "Install Rustup Targets"
-        run: |
-          rustup target add i686-unknown-linux-gnu
-          rustup target add thumbv7em-none-eabihf
       - name: "Build on non x86_64 platforms"
         run: |
           cargo build --target i686-unknown-linux-gnu --no-default-features --features nightly
@@ -134,6 +83,9 @@ jobs:
     runs-on: ${{ matrix.platform }}
     timeout-minutes: 15
 
+    env:
+      RUSTFLAGS: -Crelocation-model=static -Dwarnings
+
     steps:
       - name: "Checkout Repository"
         uses: actions/checkout@v4
@@ -148,15 +100,10 @@ jobs:
         run: echo "$GITHUB_WORKSPACE/binaries/bin" >> $GITHUB_PATH
         shell: bash
 
-      - name: "Install Rustup Components"
-        uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@nightly
         with:
-          toolchain: nightly
-          override: true
-          profile: minimal
-          components: rust-src, llvm-tools-preview
-      - name: "Install cargo-xbuild"
-        run: cargo install cargo-xbuild --debug --root binaries
+          targets: x86_64-unknown-none
+          components: rust-src, llvm-tools
       - name: "Install bootimage"
         run: cargo install bootimage --debug --root binaries
 
@@ -184,7 +131,7 @@ jobs:
         run: qemu-system-x86_64 --version
 
       - name: "Run Test Framework"
-        run: cargo xtest
+        run: cargo test
         shell: bash
         working-directory: "testing"
 
@@ -194,32 +141,21 @@ jobs:
     timeout-minutes: 2
     steps:
       - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@nightly
         with:
-          toolchain: nightly
-          override: true
-          profile: minimal
           components: rustfmt
-      - uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+      - run: cargo fmt --all -- --check
 
   clippy:
     name: "Clippy"
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@nightly
         with:
-          toolchain: nightly
-          override: true
-          profile: minimal
           components: clippy
-      - uses: actions-rs/cargo@v1
-        with:
-          command: clippy
+      - run: cargo clippy
 
   semver-checks:
     name: Semver Checks
@@ -233,3 +169,13 @@ jobs:
       - run: cargo install cargo-semver-checks --locked
       - name: Check semver
         run: cargo +stable semver-checks check-release
+
+  kani:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: "kani"
+          cache-targets: false
+      - uses: model-checking/kani-github-action@v1.1

Cargo.toml

@@ -15,7 +15,7 @@ license = "MIT/Apache-2.0"
 name = "x86_64"
 readme = "README.md"
 repository = "https://github.com/rust-osdev/x86_64"
-version = "0.15.0-beta"
+version = "0.15.1"
 edition = "2018"
 rust-version = "1.59" # Needed to support inline asm and default const generics
 
@@ -47,3 +47,6 @@ pre-release-commit-message = "Bump version to {{version}}"
 push = false
 publish = false
 tag = false
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(kani)'] }

Changelog.md

@@ -1,6 +1,22 @@
 # Unreleased
 
-# 0.15.0-beta – 2024-02-08
+# 0.15.1 – 2024-03-19
+
+## New Features
+
+- [add constructor for `InterruptStackFrameValue`](https://github.com/rust-osdev/x86_64/pull/467)
+- [add `Cr3::write_pcid_no_flush`](https://github.com/rust-osdev/x86_64/pull/472)
+
+## Fixes
+
+- [properly jump the address gap in CleanUp](https://github.com/rust-osdev/x86_64/pull/469)
+
+## Other Improvements
+
+- [added help on update_flags to get flags](https://github.com/rust-osdev/x86_64/pull/465)
+- [expose DEBUG_STR more directly](https://github.com/rust-osdev/x86_64/pull/471)
+
+# 0.15.0 – 2024-03-04
 
 ## Breaking changes
 
@@ -26,16 +42,36 @@
 
 ## New Features
 
-- [Add `HandlerFuncType` trait](https://github.com/rust-osdev/x86_64/pull/439)
+- [implement `Step` for `PageTableIndex`](https://github.com/rust-osdev/x86_64/pull/464)
 
 ## Fixes
 
 - [fix typo in docs](https://github.com/rust-osdev/x86_64/pull/265)
 - [activate `feature(asm_const)`](https://github.com/rust-osdev/x86_64/pull/320)
 - [gdt: Check that MAX is in range](https://github.com/rust-osdev/x86_64/pull/365)
-- [fix `Page::from_page_table_indices`](https://github.com/rust-osdev/x86_64/pull/398)
 
-# 0.14.11 – 2023-09-15
+## Other Improvements
+
+- [allow inlining Step methods](https://github.com/rust-osdev/x86_64/pull/464)
+- [constify more `Page` and `PageTableIndex` functions](https://github.com/rust-osdev/x86_64/pull/464)
+
+# 0.14.12 – 2023-02-09
+
+## New Features
+
+- [Add `HandlerFuncType` trait](https://github.com/rust-osdev/x86_64/pull/439)
+- [Support `VirtAddr::from_ptr` for `T: ?Sized`](https://github.com/rust-osdev/x86_64/pull/442)
+- [Expose `Cr3::write_raw`](https://github.com/rust-osdev/x86_64/pull/445)
+
+## Fixes
+
+- [Use synchronizing assembly for `interrupts::enable`/`disable`](https://github.com/rust-osdev/x86_64/pull/440)
+
+## Other Improvements
+
+- [Optimize `Page::from_page_table_indices`](https://github.com/rust-osdev/x86_64/pull/456)
+
+# 0.14.11 – 2022-09-15
 
 ## New Features
 

rust-toolchain

@@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"

rust-toolchain.toml

@@ -1,22 +1,20 @@
 import json
 import subprocess
 import tomllib
-from urllib.request import urlopen
+import urllib.request
 
 with open("Cargo.toml", "rb") as f:
     cargo_toml = tomllib.load(f)
 crate_version = cargo_toml["package"]["version"]
 print("Detected crate version " + crate_version)
 
-api_url = "https://crates.io/api/v1/crates/x86_64/" + crate_version
-version_data = json.loads(urlopen(api_url).read())
-
-if "version" in version_data:
-    version = version_data["version"]
-    assert (version["crate"] == "x86_64")
-    assert (version["num"] == crate_version)
-    print("Version " + crate_version + " already exists on crates.io")
-
+index_url = "https://index.crates.io/x8/6_/x86_64"
+for line in urllib.request.urlopen(index_url):
+    version_info = json.loads(line)
+    assert (version_info["name"] == "x86_64")
+    if version_info["vers"] == crate_version:
+        print("Version " + crate_version + " already exists on crates.io")
+        break
 else:
     print("Could not find version " + crate_version +
           " on crates.io; creating a new release")