Refactor

.cspell.json

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

.github/workflows/lint.yaml

@@ -8,7 +8,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2
@@ -16,19 +16,19 @@ jobs:
   format:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - run: cargo fmt -- --check
   spell-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - uses: streetsidesoftware/cspell-action@main
         with:
           files: "**/*.{md,rs}"
   readme:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - 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@v4
+      - uses: actions/checkout@v3
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2
@@ -16,7 +16,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2
@@ -24,15 +24,17 @@ jobs:
   examples:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           submodules: true
       - uses: Swatinem/rust-cache@v2
-      - run: examples/test.sh
+      - run: |
+          cd examples
+          ./test.sh
   cmake:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         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.7"
+version = "0.6.5"
 authors = [
   "swgillespie <sean.william.g@gmail.com>",
   "Yota Toyama <raviqqe@gmail.com>",
@@ -9,6 +9,7 @@ authors = [
 repository = "https://github.com/raviqqe/bdwgc-alloc"
 edition = "2021"
 license = "MIT"
+build = "build.rs"
 
 [features]
 default = ["autotools"]

build.rs

@@ -23,7 +23,6 @@ fn main() {
 
     let dst = autotools::Config::new(LIB_GC_DIR)
         .cflag(format!(
-            // spell-checker: disable-next-line
             "-I{} -L/lib/x86_64-linux-gnu -lpthread -fPIC",
             dst.join("include").display()
         ))

examples/Cargo.toml

@@ -1,9 +1,7 @@
 [workspace]
-resolver = "2"
 members = [
   "dynamic_threads",
   "free_by_borrow",
   "free_by_gc",
   "static_threads",
-  "tagged_pointer",
 ]

examples/dynamic_threads/Cargo.toml

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

examples/dynamic_threads/src/main.rs

@@ -1,3 +1,5 @@
+extern crate bdwgc_alloc;
+
 use bdwgc_alloc::Allocator;
 use std::alloc::Layout;
 
@@ -12,7 +14,7 @@ fn main() {
             unsafe { Allocator::register_current_thread().unwrap() }
 
             for _ in 0..100 {
-                let _ = unsafe { std::alloc::alloc(Layout::from_size_align(2 ^ 8, 8).unwrap()) };
+                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 = "2021"
+edition = "2018"
 publish = false
 
 [dependencies]

examples/free_by_borrow/src/main.rs

@@ -1,3 +1,5 @@
+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 = "2021"
+edition = "2018"
 publish = false
 
 [dependencies]

examples/free_by_gc/src/main.rs

@@ -1,3 +1,5 @@
+extern crate bdwgc_alloc;
+
 use bdwgc_alloc::Allocator;
 use std::alloc::Layout;
 
@@ -8,6 +10,6 @@ fn main() {
     unsafe { Allocator::initialize() }
 
     loop {
-        let _ = unsafe { std::alloc::alloc(Layout::from_size_align(2 ^ 8, 8).unwrap()) };
+        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 = "2021"
+edition = "2018"
 publish = false
 
 [dependencies]

examples/static_threads/src/main.rs

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

examples/tagged_pointer/Cargo.toml

@@ -1,9 +0,0 @@
-[package]
-name = "tagged_pointer"
-version = "0.1.0"
-authors = ["Yota Toyama <raviqqe@gmail.com>"]
-edition = "2021"
-publish = false
-
-[dependencies]
-bdwgc-alloc = { path = "../.." }

examples/tagged_pointer/src/main.rs

@@ -1,27 +0,0 @@
-use bdwgc_alloc::Allocator;
-use std::alloc::{alloc, Layout};
-
-const BITS: usize = usize::MAX << 48 | 0x7;
-
-#[global_allocator]
-static GLOBAL_ALLOCATOR: Allocator = Allocator;
-
-fn main() {
-    unsafe { Allocator::initialize() }
-
-    loop {
-        let x = allocate();
-        unsafe { *x = 42 };
-        let x = x as usize | BITS;
-
-        assert_eq!(x & BITS, BITS);
-
-        Allocator::force_collect();
-
-        assert_eq!(unsafe { *((x & !BITS) as *mut usize) }, 42);
-    }
-}
-
-fn allocate() -> *mut usize {
-    (unsafe { alloc(Layout::from_size_align(1 << 8, 8).unwrap()) }) as *mut usize
-}

examples/test.sh

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

src/lib.rs

@@ -42,31 +42,19 @@ 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() };
 
@@ -79,14 +67,6 @@ 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(),
@@ -96,31 +76,29 @@ 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(
+    pub unsafe fn register_finalizer<F: FnOnce(*mut c_void) + 'static>(
         ptr: *const c_void,
-        finalizer: extern "C" fn(*mut c_void, *mut c_void),
-        client_data: *const c_void,
+        finalizer: F,
     ) {
-        GC_register_finalizer(ptr, finalizer, client_data, null(), null());
+        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(),
+        );
     }
 }