Merge pull request #62 from jamesmunns/james-miri

Refactor with Cursor-based API, and passing Miri tests

Author: phil-opp

.github/workflows/build.yml

@@ -10,6 +10,27 @@ on:
     - cron: '40 5 * * *'   # every day at 5:40
   pull_request:
 
+env:
+  # disable incremental compilation.
+  #
+  # incremental compilation is useful as part of an edit-build-test-edit cycle,
+  # as it lets the compiler avoid recompiling code that hasn't changed. however,
+  # on CI, we're not making small edits; we're almost always building the entire
+  # project from scratch. thus, incremental compilation on CI actually
+  # introduces *additional* overhead to support making future builds
+  # faster...but no future builds will ever occur in any given CI environment.
+  #
+  # see https://matklad.github.io/2021/09/04/fast-rust-builds.html#ci-workflow
+  # for details.
+  CARGO_INCREMENTAL: 0
+  # allow more retries for network requests in cargo (downloading crates) and
+  # rustup (installing toolchains). this should help to reduce flaky CI failures
+  # from transient network timeouts or other issues.
+  CARGO_NET_RETRY: 10
+  RUSTUP_MAX_RETRIES: 10
+  # don't emit giant backtraces in the CI logs.
+  RUST_BACKTRACE: short
+
 jobs:
   test:
     name: "Test"
@@ -110,6 +131,16 @@ jobs:
     - name: "Run cargo test with `use_spin_nightly` feature"
       run: cargo test --features use_spin_nightly
 
+  test_miri:
+    name: "Miri tests"
+    runs-on: ubuntu-latest
+    env:
+      MIRIFLAGS: "-Zmiri-disable-isolation -Zmiri-strict-provenance -Zmiri-tag-raw-pointers -Zmiri-ignore-leaks"
+    steps:
+    - uses: actions/checkout@v1
+    - run: rustup toolchain install nightly --profile minimal --component rust-src miri
+    - run: cargo +nightly miri test --all-features
+
   check_formatting:
     name: "Check Formatting"
     runs-on: ubuntu-latest

Changelog.md

@@ -1,5 +1,11 @@
 # Unreleased
 
+- Changed constructor to take `*mut u8` instead of `usize` ([#62])
+    - NOTE: Breaking API change - will require 0.10.0 release
+- Reworked internals to pass Miri tests ([#62])
+
+[#62]: https://github.com/phil-opp/linked-list-allocator/pull/62
+
 # 0.9.1 – 2021-10-17
 
 - Add safe constructor and initialization for `Heap` ([#55](https://github.com/phil-opp/linked-list-allocator/pull/55))