Merge branch 'main' into feature/tagged-pointer

This reverts commit a318362d25.

.cspell.json

@@ -1,11 +1,19 @@
 {
   "words": [
+    "autogen",
+    "autotools",
+    "bdwgc",
+    "canonicalize",
+    "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: |
-          cd examples
-          ./test.sh
+      - run: 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,6 +23,7 @@ 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,7 +1,9 @@
 [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 = "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/tagged_pointer/Cargo.toml

@@ -0,0 +1,9 @@
+[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

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

src/lib.rs

@@ -42,19 +42,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 +79,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 +96,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),