Refactor

Bumps [vendor/bdwgc](https://github.com/ivmai/bdwgc) from `5f6df10` to
`71f838e`.
<details>
<summary>Commits</summary>
<ul>
<li><a
href="71f838eb6e"><code>71f838e</code></a>
Add debug logging to GC_clear_exclusion_table and
GC_exclude_static_roots</li>
<li><a
href="0b35c12b3f"><code>0b35c12</code></a>
Allow GC_push_roots to work even when no exclusions registered</li>
<li><a
href="a06340cc0b"><code>a06340c</code></a>
Fix GC_excl_table overrun on overflow in GC_exclude_static_roots</li>
<li><a
href="0a65033c4a"><code>0a65033</code></a>
Fix overlapping region assertion in mark_some if malloc redirect on
Linux</li>
<li><a
href="18e5b12da8"><code>18e5b12</code></a>
Clear GC_thread_key thread-local value on unregistering the thread</li>
<li><a
href="cd465f79c5"><code>cd465f7</code></a>
Fix GC_unregister_my_thread call before GC functions usage</li>
<li>See full diff in <a
href="5f6df10a93...71f838eb6e">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 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,11 @@
+{
+  "words": [
+    "dealloc",
+    "finalizer",
+    "gcollect",
+    "libc",
+    "realloc",
+    "repr",
+    "stackbottom"
+  ]
+}

.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@v3
+        with:
+          submodules: true
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo clippy -- -D warnings
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: cargo fmt -- --check
+  spell-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: streetsidesoftware/cspell-action@main
+        with:
+          files: "**/*.{md,rs}"
+  readme:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: lycheeverse/lychee-action@v1
+        with:
+          fail: true

.github/workflows/test.yaml

@@ -1,30 +1,41 @@
 name: test
 on:
-  - push
+  push:
+    branches:
+      - main
+  pull_request:
 jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo build
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         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@v3
         with:
-          command: build
-      - uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: -- --check
-      - uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-      - uses: actions-rs/audit-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          submodules: true
+      - uses: Swatinem/rust-cache@v2
       - run: |
           cd examples
           ./test.sh
-      - run: |
-          git clean -dfx
-          cargo build --no-default-features --features cmake
+  cmake:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          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.5"
 authors = [
   "swgillespie <sean.william.g@gmail.com>",
   "Yota Toyama <raviqqe@gmail.com>",

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;
 
@@ -26,6 +29,14 @@ extern "C" {
     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;
@@ -45,9 +56,7 @@ impl Allocator {
     }
 
     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"));
@@ -60,7 +69,7 @@ impl Allocator {
 
     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,
             },
@@ -70,6 +79,27 @@ impl Allocator {
     pub unsafe fn unregister_current_thread() {
         GC_unregister_my_thread()
     }
+
+    pub fn force_collect() {
+        unsafe { GC_gcollect() }
+    }
+
+    pub unsafe fn register_finalizer<F: FnOnce(*mut c_void) + 'static>(
+        ptr: *const c_void,
+        finalizer: F,
+    ) {
+        extern "C" fn finalize<F: FnOnce(*mut c_void)>(ptr: *mut c_void, data: *mut c_void) {
+            (unsafe { Box::from_raw(data as *mut F) })(ptr)
+        }
+
+        GC_register_finalizer(
+            ptr,
+            finalize::<F>,
+            Box::into_raw(Box::new(finalizer)) as *const _,
+            null(),
+            null(),
+        );
+    }
 }
 
 unsafe impl GlobalAlloc for Allocator {