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="e8c073d786"><code>e8c073d</code></a>
Group char-width fields together in GC_arrays</li>
<li><a
href="2fa18d27aa"><code>2fa18d2</code></a>
AppVeyor: Test enable_dynamic_pointer_mask option</li>
<li><a
href="8756a504c0"><code>8756a50</code></a>
Travis CI: Test with --enable-dynamic-pointer-mask</li>
<li><a
href="57828b3c2b"><code>57828b3</code></a>
Support pointer mask/shift set at runtime</li>
<li><a
href="2ea5267d04"><code>2ea5267</code></a>
Remove unneeded cast to word in GC_PUSH_ONE_HEAP/STACK</li>
<li><a
href="c685131672"><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="4ae9dcd894...e8c073d786">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

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

.github/dependabot.yml

@@ -1,5 +1,9 @@
 version: 2
 updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
   - package-ecosystem: cargo
     directory: /
     schedule:

.github/mergify.yml

@@ -3,5 +3,9 @@ pull_request_rules:
     conditions:
       - author=dependabot[bot]
     actions:
-      merge:
+      queue:
+        name: default
         method: squash
+queue_rules:
+  - name: default
+    conditions: []

.github/workflows/lint.yaml

@@ -0,0 +1,34 @@
+name: lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo clippy -- -D warnings
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: cargo fmt -- --check
+  spell-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: streetsidesoftware/cspell-action@main
+        with:
+          files: "**/*.{md,rs}"
+  readme:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: lycheeverse/lychee-action@v1
+        with:
+          fail: true

.github/workflows/test.yaml

@@ -1,30 +1,39 @@
 name: test
 on:
-  - push
+  push:
+    branches:
+      - main
+  pull_request:
 jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo build
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: actions-rs/toolchain@v1
-      - uses: actions-rs/cargo@v1
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo test
+  examples:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
         with:
-          command: build
-      - uses: actions-rs/cargo@v1
+          submodules: true
+      - uses: Swatinem/rust-cache@v2
+      - run: examples/test.sh
+  cmake:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
         with:
-          command: fmt
-          args: -- --check
-      - uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-      - uses: actions-rs/audit-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - run: |
-          cd examples
-          ./test.sh
-      - run: |
-          git clean -dfx
-          cargo build --no-default-features --features cmake
+          submodules: true
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo build --no-default-features --features cmake

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "bdwgc-alloc"
 description = "impl GlobalAlloc for bdwgc"
-version = "0.6.3"
+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
-do
-	target/debug/$(dirname $cargo_file) &
+for cargo_file in */Cargo.toml; do
+  cargo run --bin $(dirname $cargo_file) &
   pid=$!
-	sleep 10
+  sleep 20
   kill $pid
 done

src/error.rs

@@ -1,3 +1,8 @@
+use std::{
+    error,
+    fmt::{self, Display, Formatter},
+};
+
 #[derive(Debug)]
 pub struct Error {
     description: &'static str,
@@ -9,13 +14,13 @@ impl Error {
     }
 }
 
-impl std::fmt::Display for Error {
-    fn fmt(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
+impl Display for Error {
+    fn fmt(&self, formatter: &mut Formatter) -> fmt::Result {
         write!(formatter, "{}", self.description)
     }
 }
 
-impl std::error::Error for Error {
+impl error::Error for Error {
     fn description(&self) -> &str {
         self.description
     }

src/lib.rs

@@ -1,9 +1,12 @@
-extern crate libc;
+#![doc = include_str!("../README.md")]
+
+extern crate alloc;
 
 mod error;
 
+use alloc::alloc::{GlobalAlloc, Layout};
+use core::ptr::null;
 use libc::{c_int, c_void, size_t};
-use std::alloc::{GlobalAlloc, Layout};
 
 const GC_SUCCESS: c_int = 0;
 
@@ -22,32 +25,51 @@ 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);
     fn GC_unregister_my_thread();
+    fn GC_gcollect();
+    fn GC_register_finalizer(
+        ptr: *const c_void,
+        finalizer: extern "C" fn(*mut c_void, *mut c_void),
+        client_data: *const c_void,
+        opt_old_finalizer: *const c_void,
+        opt_old_client_data: *const c_void,
+    ) -> *mut c_void;
 }
 
 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: std::ptr::null(),
-        };
+        let mut base = GcStackBase { mem_base: null() };
 
         if GC_get_stack_base(&mut base) != GC_SUCCESS {
             return Err(error::Error::new("failed to get stack base"));
@@ -58,23 +80,54 @@ 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(
-            std::ptr::null(),
+            null(),
             &GcStackBase {
                 mem_base: bottom as *const libc::c_void,
             },
         )
     }
 
+    /// 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),
+        client_data: *const c_void,
+    ) {
+        GC_register_finalizer(ptr, finalizer, client_data, null(), null());
+    }
 }
 
 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) {