Merge branch 'main' into feature/tagged-pointer

This reverts commit a318362d25.

.cspell.json

@@ -5,7 +5,6 @@
     "bdwgc",
     "canonicalize",
     "cflag",
-    "clippy",
     "dealloc",
     "finalizer",
     "gcollect",
@@ -15,7 +14,6 @@
     "repr",
     "rustc",
     "stackbottom",
-    "swatinem",
     "unregisters"
   ]
 }

.github/mergify.yml

@@ -0,0 +1,11 @@
+pull_request_rules:
+  - name: dependabot
+    conditions:
+      - author=dependabot[bot]
+    actions:
+      queue:
+        name: default
+        method: squash
+queue_rules:
+  - name: default
+    conditions: []

.github/workflows/dependabot.yaml

@@ -1,13 +0,0 @@
-name: dependabot
-on: pull_request
-permissions:
-  contents: write
-  pull-requests: write
-jobs:
-  merge:
-    runs-on: ubuntu-latest
-    if: github.actor == 'dependabot[bot]'
-    steps:
-      - run: gh pr merge --auto --squash ${{ github.event.pull_request.html_url }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint.yaml

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

.github/workflows/release.yaml

@@ -1,29 +0,0 @@
-name: release
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-concurrency:
-  group: release-${{ github.ref }}
-  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
-jobs:
-  release:
-    permissions:
-      id-token: write
-    runs-on: ubuntu-latest
-    environment: ${{ github.ref == 'refs/heads/main' && 'release' || '' }}
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          submodules: true
-      - uses: swatinem/rust-cache@v2
-      - run: cargo install cargo-workspaces
-      - uses: rust-lang/crates-io-auth-action@v1
-        id: auth
-        if: github.ref == 'refs/heads/main'
-      - run: >
-          cargo workspaces publish -y --from-git --no-verify
-          ${{ github.ref != 'refs/heads/main' && '--dry-run' || '' }}
-        env:
-          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}

.github/workflows/test.yaml

@@ -8,32 +8,32 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: swatinem/rust-cache@v2
+      - uses: Swatinem/rust-cache@v2
       - run: cargo build
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: swatinem/rust-cache@v2
+      - uses: Swatinem/rust-cache@v2
       - run: cargo test
   examples:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: swatinem/rust-cache@v2
-      - run: tools/example_test.sh
+      - uses: Swatinem/rust-cache@v2
+      - run: examples/test.sh
   cmake:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: swatinem/rust-cache@v2
+      - uses: Swatinem/rust-cache@v2
       - run: cargo build --no-default-features --features cmake

.gitignore

@@ -1,2 +1,2 @@
-.cargo_cache
+*.lock
 target

.gitmodules

@@ -1,6 +1,6 @@
 [submodule "vendor/bdwgc"]
 	path = vendor/bdwgc
-	url = https://github.com/bdwgc/bdwgc
+	url = https://github.com/ivmai/bdwgc
 [submodule "vendor/libatomic_ops"]
 	path = vendor/libatomic_ops
-	url = https://github.com/bdwgc/libatomic_ops
+	url = https://github.com/ivmai/libatomic_ops

Cargo.lock

@@ -1,86 +0,0 @@
-# This file is automatically @generated by Cargo.
-# It is not intended for manual editing.
-version = 4
-
-[[package]]
-name = "autotools"
-version = "0.2.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ef941527c41b0fc0dd48511a8154cd5fc7e29200a0ff8b7203c5d777dbc795cf"
-dependencies = [
- "cc",
-]
-
-[[package]]
-name = "bdwgc-alloc"
-version = "0.6.13"
-dependencies = [
- "autotools",
- "cmake",
- "libc",
-]
-
-[[package]]
-name = "cc"
-version = "1.2.49"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "90583009037521a116abf44494efecd645ba48b6622457080f080b85544e2215"
-dependencies = [
- "find-msvc-tools",
- "shlex",
-]
-
-[[package]]
-name = "cmake"
-version = "0.1.58"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c0f78a02292a74a88ac736019ab962ece0bc380e3f977bf72e376c5d78ff0678"
-dependencies = [
- "cc",
-]
-
-[[package]]
-name = "dynamic_threads"
-version = "0.1.0"
-dependencies = [
- "bdwgc-alloc",
-]
-
-[[package]]
-name = "find-msvc-tools"
-version = "0.1.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3a3076410a55c90011c298b04d0cfa770b00fa04e1e3c97d3f6c9de105a03844"
-
-[[package]]
-name = "free_by_borrow"
-version = "0.1.0"
-dependencies = [
- "bdwgc-alloc",
-]
-
-[[package]]
-name = "free_by_gc"
-version = "0.1.0"
-dependencies = [
- "bdwgc-alloc",
-]
-
-[[package]]
-name = "libc"
-version = "0.2.186"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
-
-[[package]]
-name = "shlex"
-version = "1.3.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
-
-[[package]]
-name = "static_threads"
-version = "0.1.0"
-dependencies = [
- "bdwgc-alloc",
-]

Cargo.toml

@@ -1,29 +1,21 @@
 [package]
 name = "bdwgc-alloc"
-version = "0.6.13"
-edition = "2024"
 description = "impl GlobalAlloc for bdwgc"
+version = "0.6.7"
+authors = [
+  "swgillespie <sean.william.g@gmail.com>",
+  "Yota Toyama <raviqqe@gmail.com>",
+]
 repository = "https://github.com/raviqqe/bdwgc-alloc"
+edition = "2021"
 license = "MIT"
-categories = ["api-bindings", "memory-management", "no-std", "no-std::no-alloc"]
-
-[workspace]
-resolver = "3"
-members = ["examples/*"]
-
-[dependencies]
-libc = "0.2.186"
-
-[build-dependencies]
-autotools = { version = "0.2.7", optional = true }
-cmake = { version = "0.1.58", optional = true }
 
 [features]
 default = ["autotools"]
 
-[lints.clippy]
-alloc_instead_of_core = "deny"
-dbg_macro = "deny"
-missing_const_for_fn = "deny"
-std_instead_of_alloc = "deny"
-std_instead_of_core = "deny"
+[dependencies]
+libc = "0.2"
+
+[build-dependencies]
+autotools = { version = "0.2", optional = true }
+cmake = { version = "0.1", optional = true }

README.md

@@ -1,8 +1,8 @@
-# bdwgc-rust
+# bdwgc-alloc
 
-[![GitHub Action](https://img.shields.io/github/actions/workflow/status/bdwgc/bdwgc-rust/test.yaml?branch=main&style=flat-square)](https://github.com/bdwgc/bdwgc-rust/actions)
+[![GitHub Action](https://img.shields.io/github/actions/workflow/status/raviqqe/bdwgc-alloc/test.yaml?branch=main&style=flat-square)](https://github.com/raviqqe/bdwgc-alloc/actions)
 [![Crate](https://img.shields.io/crates/v/bdwgc-alloc.svg?style=flat-square)](https://crates.io/crates/bdwgc-alloc)
-[![License](https://img.shields.io/github/license/bdwgc/bdwgc-rust.svg?style=flat-square)](LICENSE)
+[![License](https://img.shields.io/github/license/raviqqe/bdwgc-alloc.svg?style=flat-square)](LICENSE)
 
 [`GlobalAlloc`](https://doc.rust-lang.org/std/alloc/trait.GlobalAlloc.html) implementation for [`bdwgc`][bdwgc], the conservative garbage collector.
 
@@ -22,4 +22,4 @@ cargo build --no-default-features --features cmake
 
 [MIT](LICENSE)
 
-[bdwgc]: https://github.com/bdwgc/bdwgc
+[bdwgc]: https://github.com/ivmai/bdwgc

build.rs

@@ -6,7 +6,7 @@ fn main() {
     for dir in &[LIB_ATOMIC_OPS_DIR, LIB_GC_DIR] {
         std::process::Command::new("sh")
             .arg("-c")
-            .arg(format!("cd {dir} && ./autogen.sh"))
+            .arg(format!("cd {} && ./autogen.sh", dir))
             .output()
             .unwrap();
     }
@@ -38,7 +38,7 @@ fn main() {
     for dir in &[LIB_ATOMIC_OPS_DIR, LIB_GC_DIR] {
         std::process::Command::new("sh")
             .arg("-c")
-            .arg(format!("cd {dir} && git clean -dfx"))
+            .arg(format!("cd {} && git clean -dfx", dir))
             .output()
             .unwrap();
     }
@@ -59,7 +59,7 @@ fn main() {
 
     let dst = Config::new(LIB_GC_DIR)
         .profile("Release")
-        .define("GC_BUILD_SHARED_LIBS", "FALSE")
+        .define("BUILD_SHARED_LIBS", "FALSE")
         .cflag(format!("-I{}", libatomic_include_path))
         .build();
 

examples/Cargo.toml

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

examples/dynamic_threads/Cargo.toml

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

examples/free_by_borrow/Cargo.toml

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

examples/free_by_gc/Cargo.toml

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

examples/static_threads/Cargo.toml

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

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

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+set -ex
+
+cd $(dirname $0)
+
+for cargo_file in */Cargo.toml; do
+  cargo run --bin $(dirname $cargo_file) &
+  pid=$!
+  sleep 20
+  kill $pid
+done

rust-toolchain

@@ -0,0 +1 @@
+stable

rust-toolchain.toml

@@ -1,3 +0,0 @@
-[toolchain]
-channel = "stable"
-components = ["clippy", "rustfmt", "rust-analyzer", "rust-src"]

src/error.rs

@@ -1,4 +1,4 @@
-use core::{
+use std::{
     error,
     fmt::{self, Display, Formatter},
 };
@@ -9,7 +9,7 @@ pub struct Error {
 }
 
 impl Error {
-    pub const fn new(description: &'static str) -> Error {
+    pub fn new(description: &'static str) -> Error {
         Error { description }
     }
 }

src/lib.rs

@@ -1,9 +1,10 @@
 #![doc = include_str!("../README.md")]
-#![no_std]
+
+extern crate alloc;
 
 mod error;
 
-use core::alloc::{GlobalAlloc, Layout};
+use alloc::alloc::{GlobalAlloc, Layout};
 use core::ptr::null;
 use libc::{c_int, c_void, size_t};
 
@@ -16,7 +17,7 @@ struct GcStackBase {
 }
 
 #[link(name = "gc", kind = "static")]
-unsafe extern "C" {
+extern "C" {
     fn GC_allow_register_threads();
     fn GC_alloc_lock();
     fn GC_alloc_unlock();
@@ -57,10 +58,8 @@ impl Allocator {
     ///
     /// This function must be called in a main thread.
     pub unsafe fn initialize() {
-        unsafe {
-            GC_init();
-            GC_allow_register_threads();
-        }
+        GC_init();
+        GC_allow_register_threads();
     }
 
     /// Registers a current thread to a collector.
@@ -71,9 +70,9 @@ impl Allocator {
     pub unsafe fn register_current_thread() -> Result<(), error::Error> {
         let mut base = GcStackBase { mem_base: null() };
 
-        if unsafe { GC_get_stack_base(&mut base) } != GC_SUCCESS {
+        if GC_get_stack_base(&mut base) != GC_SUCCESS {
             return Err(error::Error::new("failed to get stack base"));
-        } else if unsafe { GC_register_my_thread(&base) } != GC_SUCCESS {
+        } else if GC_register_my_thread(&base) != GC_SUCCESS {
             return Err(error::Error::new("failed to register a thread for GC"));
         }
 
@@ -89,14 +88,12 @@ impl Allocator {
     ///
     /// The bottom address must be valid.
     pub unsafe fn set_stack_bottom(bottom: *const u8) {
-        unsafe {
-            GC_set_stackbottom(
-                null(),
-                &GcStackBase {
-                    mem_base: bottom as *const libc::c_void,
-                },
-            )
-        }
+        GC_set_stackbottom(
+            null(),
+            &GcStackBase {
+                mem_base: bottom as *const libc::c_void,
+            },
+        )
     }
 
     /// Unregisters a current thread from a collector.
@@ -105,7 +102,7 @@ impl Allocator {
     ///
     /// The thread must be registered already.
     pub unsafe fn unregister_current_thread() {
-        unsafe { GC_unregister_my_thread() }
+        GC_unregister_my_thread()
     }
 
     /// Runs a garbage collection forcibly.
@@ -123,20 +120,20 @@ impl Allocator {
         finalizer: extern "C" fn(*mut c_void, *mut c_void),
         client_data: *const c_void,
     ) {
-        unsafe { GC_register_finalizer(ptr, finalizer, client_data, null(), null()) };
+        GC_register_finalizer(ptr, finalizer, client_data, null(), null());
     }
 }
 
 unsafe impl GlobalAlloc for Allocator {
     unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
-        (unsafe { GC_malloc(layout.size()) }) as *mut u8
+        GC_malloc(layout.size()) as *mut u8
     }
 
     unsafe fn dealloc(&self, ptr: *mut u8, _layout: Layout) {
-        unsafe { GC_free(ptr as *mut c_void) }
+        GC_free(ptr as *mut c_void)
     }
 
     unsafe fn realloc(&self, ptr: *mut u8, _layout: Layout, size: usize) -> *mut u8 {
-        (unsafe { GC_realloc(ptr as *mut c_void, size) }) as *mut u8
+        GC_realloc(ptr as *mut c_void, size) as *mut u8
     }
 }

tools/example_test.sh

@@ -1,20 +0,0 @@
-#!/bin/sh
-
-set -ex
-
-duration=20
-
-cd $(dirname $0)/..
-
-for directory in $(ls examples); do
-  (
-    cd examples/$directory
-
-    cargo build
-    cargo run &
-
-    pid=$!
-    sleep $duration
-    kill $pid
-  )
-done