Merge branch 'main' into chore/pointer-mask

Bumps [vendor/bdwgc](https://github.com/ivmai/bdwgc) from `4ae9dcd` to
`e8c073d`.
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/ivmai/bdwgc/commit/e8c073d786948dd522fa96c9c42d1a362836e1c8"><code>e8c073d</code></a>
Group char-width fields together in GC_arrays</li>
<li><a
href="https://github.com/ivmai/bdwgc/commit/2fa18d27aa3032cf15eade0242f658ffb68dcf47"><code>2fa18d2</code></a>
AppVeyor: Test enable_dynamic_pointer_mask option</li>
<li><a
href="https://github.com/ivmai/bdwgc/commit/8756a504c09cc9c7037457c2163b1a2222c3d8d4"><code>8756a50</code></a>
Travis CI: Test with --enable-dynamic-pointer-mask</li>
<li><a
href="https://github.com/ivmai/bdwgc/commit/57828b3c2b7e811abd6bb1ba37060eb456b3824e"><code>57828b3</code></a>
Support pointer mask/shift set at runtime</li>
<li><a
href="https://github.com/ivmai/bdwgc/commit/2ea5267d042b7f9fd97dd506e24b47c297d155ca"><code>2ea5267</code></a>
Remove unneeded cast to word in GC_PUSH_ONE_HEAP/STACK</li>
<li><a
href="https://github.com/ivmai/bdwgc/commit/c68513167276d8deb8fe3e6286c525f58102fba7"><code>c685131</code></a>
Turn on MAKE_BACK_GRAPH for all Linux architectures in cmake and
configure</li>
<li>See full diff in <a
href="https://github.com/ivmai/bdwgc/compare/4ae9dcd8945e5a43b84375631e48e4fafd443a36...e8c073d786948dd522fa96c9c42d1a362836e1c8">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.cspell.json

@@ -1,11 +1,18 @@
 {
   "words": [
+    "autogen",
+    "autotools",
+    "bdwgc",
+    "cflag",
     "dealloc",
     "finalizer",
     "gcollect",
+    "libatomic",
     "libc",
     "realloc",
     "repr",
-    "stackbottom"
+    "rustc",
+    "stackbottom",
+    "unregisters"
   ]
 }

.github/workflows/lint.yaml

@@ -8,7 +8,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2
@@ -16,19 +16,19 @@ jobs:
   format:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: cargo fmt -- --check
   spell-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: streetsidesoftware/cspell-action@main
         with:
           files: "**/*.{md,rs}"
   readme:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: lycheeverse/lychee-action@v1
         with:
           fail: true

.github/workflows/test.yaml

@@ -8,7 +8,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2
@@ -16,7 +16,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2
@@ -24,17 +24,15 @@ jobs:
   examples:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2
-      - run: |
+      - run: examples/test.sh
-          cd examples
-          ./test.sh
   cmake:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "bdwgc-alloc"
 description = "impl GlobalAlloc for bdwgc"
-version = "0.6.6"
+version = "0.6.7"
 authors = [
   "swgillespie <sean.william.g@gmail.com>",
   "Yota Toyama <raviqqe@gmail.com>",
@@ -9,7 +9,6 @@ authors = [
 repository = "https://github.com/raviqqe/bdwgc-alloc"
 edition = "2021"
 license = "MIT"
-build = "build.rs"
 
 [features]
 default = ["autotools"]

build.rs

@@ -23,7 +23,7 @@ fn main() {
 
     let dst = autotools::Config::new(LIB_GC_DIR)
         .cflag(format!(
-            "-I{} -L/lib/x86_64-linux-gnu -lpthread -fPIC",
+            "-I{} -L/lib/x86_64-linux-gnu -lpthread -fPIC -D POINTER_MASK=0x7",
             dst.join("include").display()
         ))
         .build();
@@ -59,7 +59,10 @@ fn main() {
     let dst = Config::new(LIB_GC_DIR)
         .profile("Release")
         .define("BUILD_SHARED_LIBS", "FALSE")
-        .cflag(format!("-I{}", libatomic_include_path))
+        .cflag(format!(
+            "-I{} -DPOINTER_MASK=0x7",
+            libatomic_include_path, foo
+        ))
         .build();
 
     println!(

examples/Cargo.toml

@@ -1,4 +1,5 @@
 [workspace]
+resolver = "2"
 members = [
   "dynamic_threads",
   "free_by_borrow",

examples/dynamic_threads/Cargo.toml

@@ -2,7 +2,7 @@
 name = "dynamic_threads"
 version = "0.1.0"
 authors = ["Yota Toyama <raviqqe@gmail.com>"]
-edition = "2018"
+edition = "2021"
 publish = false
 
 [dependencies]

examples/dynamic_threads/src/main.rs

@@ -1,5 +1,3 @@
-extern crate bdwgc_alloc;
-
 use bdwgc_alloc::Allocator;
 use std::alloc::Layout;
 
@@ -14,7 +12,7 @@ fn main() {
             unsafe { Allocator::register_current_thread().unwrap() }
 
             for _ in 0..100 {
-                unsafe { std::alloc::alloc(Layout::from_size_align(2 ^ 8, 8).unwrap()) };
+                let _ = unsafe { std::alloc::alloc(Layout::from_size_align(2 ^ 8, 8).unwrap()) };
             }
 
             unsafe { Allocator::unregister_current_thread() }

examples/free_by_borrow/Cargo.toml

@@ -2,7 +2,7 @@
 name = "free_by_borrow"
 version = "0.1.0"
 authors = ["Yota Toyama <raviqqe@gmail.com>"]
-edition = "2018"
+edition = "2021"
 publish = false
 
 [dependencies]

examples/free_by_borrow/src/main.rs

@@ -1,5 +1,3 @@
-extern crate bdwgc_alloc;
-
 use bdwgc_alloc::Allocator;
 
 #[global_allocator]

examples/free_by_gc/Cargo.toml

@@ -2,7 +2,7 @@
 name = "free_by_gc"
 version = "0.1.0"
 authors = ["Yota Toyama <raviqqe@gmail.com>"]
-edition = "2018"
+edition = "2021"
 publish = false
 
 [dependencies]

examples/free_by_gc/src/main.rs

@@ -1,5 +1,3 @@
-extern crate bdwgc_alloc;
-
 use bdwgc_alloc::Allocator;
 use std::alloc::Layout;
 
@@ -10,6 +8,6 @@ fn main() {
     unsafe { Allocator::initialize() }
 
     loop {
-        unsafe { std::alloc::alloc(Layout::from_size_align(2 ^ 8, 8).unwrap()) };
+        let _ = unsafe { std::alloc::alloc(Layout::from_size_align(2 ^ 8, 8).unwrap()) };
     }
 }

examples/static_threads/Cargo.toml

@@ -2,7 +2,7 @@
 name = "static_threads"
 version = "0.1.0"
 authors = ["Yota Toyama <raviqqe@gmail.com>"]
-edition = "2018"
+edition = "2021"
 publish = false
 
 [dependencies]

examples/static_threads/src/main.rs

@@ -1,5 +1,3 @@
-extern crate bdwgc_alloc;
-
 use bdwgc_alloc::Allocator;
 use std::alloc::Layout;
 
@@ -13,7 +11,7 @@ fn main() {
         unsafe { Allocator::register_current_thread().unwrap() }
 
         loop {
-            unsafe { std::alloc::alloc(Layout::from_size_align(2 ^ 8, 8).unwrap()) };
+            let _ = unsafe { std::alloc::alloc(Layout::from_size_align(2 ^ 8, 8).unwrap()) };
         }
     });
 

examples/test.sh

@@ -2,12 +2,11 @@
 
 set -ex
 
-cargo build
+cd $(dirname $0)
 
-for cargo_file in */Cargo.toml
+for cargo_file in */Cargo.toml; do
-do
+  cargo run --bin $(dirname $cargo_file) &
-	target/debug/$(dirname $cargo_file) &
   pid=$!
-	sleep 10
+  sleep 20
   kill $pid
 done

src/lib.rs

@@ -25,6 +25,7 @@ extern "C" {
     fn GC_get_stack_base(stack_base: *mut GcStackBase) -> c_int;
     fn GC_init();
     fn GC_malloc(size: size_t) -> *mut c_void;
+    fn GC_memalign(align: size_t, size: size_t) -> *mut c_void;
     fn GC_realloc(ptr: *mut c_void, size: size_t) -> *mut c_void;
     fn GC_register_my_thread(stack_base: *const GcStackBase) -> c_int;
     fn GC_set_stackbottom(thread: *const c_void, stack_bottom: *const GcStackBase);
@@ -42,19 +43,31 @@ extern "C" {
 pub struct Allocator;
 
 impl Allocator {
+    /// Locks a collector.
     pub fn lock() {
         unsafe { GC_alloc_lock() }
     }
 
+    /// Unlocks a collector.
     pub fn unlock() {
         unsafe { GC_alloc_unlock() }
     }
 
+    /// Initializes a collector.
+    ///
+    /// # Safety
+    ///
+    /// This function must be called in a main thread.
     pub unsafe fn initialize() {
         GC_init();
         GC_allow_register_threads();
     }
 
+    /// Registers a current thread to a collector.
+    ///
+    /// # Safety
+    ///
+    /// This function must not be called in a main thread.
     pub unsafe fn register_current_thread() -> Result<(), error::Error> {
         let mut base = GcStackBase { mem_base: null() };
 
@@ -67,6 +80,14 @@ impl Allocator {
         Ok(())
     }
 
+    /// Sets a bottom of a stack.
+    ///
+    /// You do not have to call this function in most cases.
+    /// A collector detects the bottom on initialization automatically.
+    ///
+    /// # Safety
+    ///
+    /// The bottom address must be valid.
     pub unsafe fn set_stack_bottom(bottom: *const u8) {
         GC_set_stackbottom(
             null(),
@@ -76,14 +97,25 @@ impl Allocator {
         )
     }
 
+    /// Unregisters a current thread from a collector.
+    ///
+    /// # Safety
+    ///
+    /// The thread must be registered already.
     pub unsafe fn unregister_current_thread() {
         GC_unregister_my_thread()
     }
 
+    /// Runs a garbage collection forcibly.
     pub fn force_collect() {
         unsafe { GC_gcollect() }
     }
 
+    /// Registers a finalizer of an object.
+    ///
+    /// # Safety
+    ///
+    /// The given finalizer must not be null and handle pointers properly.
     pub unsafe fn register_finalizer(
         ptr: *const c_void,
         finalizer: extern "C" fn(*mut c_void, *mut c_void),
@@ -95,7 +127,7 @@ impl Allocator {
 
 unsafe impl GlobalAlloc for Allocator {
     unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
-        GC_malloc(layout.size()) as *mut u8
+        GC_memalign(layout.align(), layout.size()) as *mut u8
     }
 
     unsafe fn dealloc(&self, ptr: *mut u8, _layout: Layout) {