dependency and code updates

Jesterhearts · Jesterhearts · commit e84d1f2bcd93 · 2025-06-25T17:05:22.000-07:00
update dependencies (including syn, petgraph, indexmap, criterion, etc.), and modernize Cargo.toml formatting
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
 # tracing-rc
-[![Tests](https://img.shields.io/github/workflow/status/Jesterhearts/tracing-rc/Tests?event=push&style=for-the-badge&label=Tests&logo=github)](https://github.com/Jesterhearts/tracing-rc/actions)
 [![Crate](https://img.shields.io/crates/v/tracing-rc.svg?style=for-the-badge)](https://crates.io/crates/tracing-rc)
 [![Docs](https://img.shields.io/docsrs/tracing-rc?style=for-the-badge)](https://docs.rs/tracing-rc)
 
@@ -41,19 +40,19 @@ In order for this crate to be sound and present a safe `Trace` trait, the collec
 cause undefined behavior in any of the scenarios outlined. In order to accomplish this, the
 collector does the following:
 1. Items that are waiting for collection or have been visited during tracing are given an extra
-   strong or weak reference to make sure the memory remains allocated and the data it contains remains valid
-   even if strong references are dropped during traversal.
+   strong or weak reference to make sure the memory remains allocated and the data it contains
+   remains valid even if strong references are dropped during traversal.
 2. Reference counts for traced items are not decremented by the collector during traversal (this is
    a difference from e.g. Bacon-Rajan which originally inspired this crate). The collector instead
    keeps a count of the number of times it reached each pointer through tracing, and then compares
    that count against the strong count for each pointer it traced to decide if the item is dead.
 3. Before dropping any values, the collector marks the object dead. During this process, bugs in the
-   `Trace` implementation may cause the collector to believe a dead value is still alive
-   (causing a leak) or a live value is dead (making it inaccessible, but leaving the gc pointer
-   valid). Safe code is unable to access dead values (it will panic or return Option::None), and
-   cannot restore the live state of a dead object. Values are never temporarily dead, the collector
-   only marks them dead after it has fully determined that it is a valid candidate for collection
-   (all strong refs are from members of its cycle).
+   `Trace` implementation may cause the collector to believe a dead value is still alive (causing a
+   leak) or a live value is dead (making it inaccessible, but leaving the gc pointer valid). Safe
+   code is unable to access dead values (it will panic or return Option::None), and cannot restore
+   the live state of a dead object. Values are never temporarily dead, the collector only marks them
+   dead after it has fully determined that it is a valid candidate for collection (all strong refs
+   are from members of its cycle).
 4. After the full set of traced objects has been marked, the collector begins dropping the inner
    data of objects it believes to be dead, after checking if there are any oustanding borrows
    (immutable or mutable). This drop _does not_ and _can not_ free the memory for the gc pointer,
@@ -64,8 +63,8 @@ collector does the following:
    reference to the `Gc` value, and its memory will be cleaned up. If there are remaining
    references, its memory will be cleaned up when the oustanding references fall out of scope.
  
-There are a decent number number of tests designed to exercise each of these scenarios included, and all
-of these tests pass miri (barring leaks for intentionally misbehaved code).
+There are a decent number number of tests designed to exercise each of these scenarios included, and
+all of these tests pass miri (barring leaks for intentionally misbehaved code).
 
 # Example
 ```rs
diff --git a/rustfmt.toml b/rustfmt.toml
@@ -1,7 +1,7 @@
-wrap_comments = true
-comment_width = 100
-group_imports = "StdExternalCrate"
-imports_layout = "Vertical"
-imports_granularity = "Crate"
+wrap_comments               = true
+comment_width               = 100
+group_imports               = "StdExternalCrate"
+imports_layout              = "Vertical"
+imports_granularity         = "Crate"
 format_code_in_doc_comments = true
-reorder_impl_items = true
+reorder_impl_items          = true
diff --git a/tracing-rc-bench/Cargo.toml b/tracing-rc-bench/Cargo.toml
@@ -1,20 +1,20 @@
 [package]
-name = "tracing-rc-bench"
+name    = "tracing-rc-bench"
 version = "0.1.0"
 publish = false
 edition = "2021"
 
 [dependencies]
-criterion = '^0.3'
+criterion = '^0.6'
 
 [dependencies.tracing-rc]
-path = "../tracing-rc"
+path     = "../tracing-rc"
 features = [ "sync" ]
 
 [[bench]]
-name = "minimal_gc"
+name    = "minimal_gc"
 harness = false
 
 [[bench]]
-name = "cycle_collection"
-harness = false
+name    = "cycle_collection"
+harness = false
diff --git a/tracing-rc-bench/benches/cycle_collection.rs b/tracing-rc-bench/benches/cycle_collection.rs
@@ -1,10 +1,12 @@
-use std::time::{
-    Duration,
-    Instant,
+use std::{
+    hint::black_box,
+    time::{
+        Duration,
+        Instant,
+    },
 };
 
 use criterion::{
-    black_box,
     criterion_group,
     criterion_main,
     BenchmarkId,
diff --git a/tracing-rc-bench/benches/minimal_gc.rs b/tracing-rc-bench/benches/minimal_gc.rs
@@ -1,4 +1,5 @@
 use std::{
+    hint::black_box,
     rc::Rc,
     time::{
         Duration,
@@ -7,7 +8,6 @@ use std::{
 };
 
 use criterion::{
-    black_box,
     criterion_group,
     criterion_main,
     BenchmarkId,
diff --git a/tracing-rc-derive/Cargo.toml b/tracing-rc-derive/Cargo.toml
@@ -1,26 +1,26 @@
 [package]
-name = "tracing-rc-derive"
+name        = "tracing-rc-derive"
 description = "Attribute macros for tracing-rc"
-version = "0.1.1"
-edition = "2021"
-license = "MIT OR Apache-2.0"
-repository = "https://github.com/Jesterhearts/tracing-rc"
+version     = "0.2.0"
+edition     = "2021"
+license     = "MIT OR Apache-2.0"
+repository  = "https://github.com/Jesterhearts/tracing-rc"
 
 [lib]
 proc-macro = true
 
 [features]
-sync = []
+sync = [  ]
 
 [dependencies]
-proc-macro2 = '^1.0'
-quote = '^1.0'
-syn = '^1.0'
-synstructure = '^0.12'
+proc-macro2  = '^1.0'
+quote        = '^1.0'
+syn          = '^2.0'
+synstructure = '^0.13'
 
 [dev-dependencies]
 trybuild = '^1.0'
 
 [dev-dependencies.tracing-rc]
-path = "../tracing-rc"
-features = [ "sync" ]
+path     = "../tracing-rc"
+features = [ "sync" ]
diff --git a/tracing-rc-derive/src/lib.rs b/tracing-rc-derive/src/lib.rs
@@ -20,7 +20,7 @@ fn filter_default_and_ignored_fields(
         let mut should_keep = true;
 
         for attr in bi.ast().attrs.iter() {
-            should_keep = if attr.path.is_ident(TRACE_FIELD_IDENT) {
+            should_keep = if attr.path().is_ident(TRACE_FIELD_IDENT) {
                 match attr.parse_args() {
                     Err(_) => true,
                     Ok(syn::Meta::Path(path)) => {
@@ -70,7 +70,7 @@ fn filter_specific_fields(specific_fields: &mut synstructure::Structure) -> bool
     let mut has_specific_field = false;
     specific_fields.filter(|bi| {
         if bi.ast().attrs.iter().any(|attr| {
-            attr.path.is_ident(TRACE_FIELD_IDENT) && attr.parse_args::<syn::Meta>().is_err()
+            attr.path().is_ident(TRACE_FIELD_IDENT) && attr.parse_args::<syn::Meta>().is_err()
         }) {
             has_specific_field = true;
             true
diff --git a/tracing-rc-fuzz/Cargo.toml b/tracing-rc-fuzz/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "tracing-rc-fuzz"
-version = "0.1.0"
+name    = "tracing-rc-fuzz"
+version = "0.2.0"
 authors = [ "Automatically generated" ]
 publish = false
 edition = "2021"
@@ -9,10 +9,10 @@ edition = "2021"
 cargo-fuzz = true
 
 [dependencies]
-arbitrary = { version = '1', features = [ "derive" ] }
-indoc = '^1.0'
+arbitrary     = { version = '1', features = [ "derive" ] }
+indoc         = '2'
 libfuzzer-sys = '0.4'
-petgraph = '^0.6'
+petgraph      = '0.8'
 
 [dependencies.tracing-rc]
 path = "../tracing-rc"
@@ -25,4 +25,4 @@ members = [ "." ]
 name = "random_graph"
 path = "fuzz_targets/random_graph.rs"
 test = false
-doc = false
+doc  = false
diff --git a/tracing-rc/Cargo.toml b/tracing-rc/Cargo.toml
@@ -1,41 +1,34 @@
 [package]
-name = "tracing-rc"
+name        = "tracing-rc"
 description = "Cycle-aware reference-counted pointers with a safe, simple api"
-version = "0.1.3"
-edition = "2021"
-license = "MIT OR Apache-2.0"
-repository = "https://github.com/Jesterhearts/tracing-rc"
-readme = "../README.md"
+version     = "0.2.0"
+edition     = "2021"
+license     = "MIT OR Apache-2.0"
+repository  = "https://github.com/Jesterhearts/tracing-rc"
+readme      = "../README.md"
 
 [features]
-default = [ "proc_macro" ]
+default    = [ "proc_macro" ]
 proc_macro = [ "tracing-rc-derive" ]
-sync = [ "atomic", "once_cell", "dashmap", "parking_lot", "tracing-rc-derive/sync" ]
+sync       = [ "atomic", "bytemuck", "once_cell", "dashmap", "parking_lot", "tracing-rc-derive/sync" ]
+# Enables the nightly `doc_auto_cfg` feature.
+ENABLE_DOC_AUTO_CFG = [  ]
 
 [dependencies]
-indexmap = '^1.0'
-petgraph = '^0.6'
+atomic            = { version = '0.6', optional = true }
+bytemuck          = { version = "1", optional = true, features = [ "derive" ] }
+dashmap           = { version = '6', optional = true }
+indexmap          = '2'
+once_cell         = { version = '1', optional = true }
+parking_lot       = { version = '0.12', optional = true }
+petgraph          = '0.8'
+tracing-rc-derive = { path = "../tracing-rc-derive", version = "0.2.0", optional = true }
 
-[dependencies.atomic]
-version = '^0.5'
-optional = true
-
-[dependencies.dashmap]
-version = '^5.0'
-optional = true
-
-[dependencies.once_cell]
-version = '^1.0'
-optional = true
-
-[dependencies.parking_lot]
-version = '^0.11'
-optional = true
+[dev-dependencies]
+pretty_assertions = '1'
 
-[dependencies.tracing-rc-derive]
-path = "../tracing-rc-derive"
-version = '^0.1.1'
-optional = true
+[build-dependencies]
+rustc_version = '0.4'
 
-[dev-dependencies]
-pretty_assertions = '^1.0'
+[package.metadata.docs.rs]
+all-features = true
diff --git a/tracing-rc/build.rs b/tracing-rc/build.rs
@@ -0,0 +1,13 @@
+use rustc_version::{
+    version_meta,
+    Channel,
+};
+
+fn main() {
+    println!("cargo::rustc-check-cfg=cfg(ENABLE_DOC_AUTO_CFG)");
+    let enable_doc_auto_cfg = match version_meta().unwrap().channel {
+        Channel::Nightly => "ENABLE_DOC_AUTO_CFG",
+        _ => "DISABLE_DOC_AUTO_CFG",
+    };
+    println!("cargo:rustc-cfg={}", enable_doc_auto_cfg);
+}
diff --git a/tracing-rc/src/lib.rs b/tracing-rc/src/lib.rs
@@ -73,18 +73,20 @@
 //! # }
 //! ```
 
+#![cfg_attr(all(doc, ENABLE_DOC_AUTO_CFG), feature(doc_auto_cfg))]
+
 /// A non-sync cycle-collecting reference-counted smart pointer.
 pub mod rc;
 
 #[cfg(feature = "sync")]
 /// An atomic cycle-collecting reference-counted smart pointer.
 pub mod sync;
 
-#[cfg(feature = "sync")]
-/// Proc macro for deriving [`sync::Trace`](crate::sync::Trace).
+#[cfg(all(feature = "sync", feature = "proc_macro"))]
+/// Proc macro for deriving [`sync::Trace`].
 pub use tracing_rc_derive::SyncTrace;
 #[cfg(feature = "proc_macro")]
-/// Proc macro for deriving [`Trace`](crate::rc::Trace).
+/// Proc macro for deriving [`Trace`].
 pub use tracing_rc_derive::Trace;
 
 /// Controls the style of collection carried out.
diff --git a/tracing-rc/src/rc/collector.rs b/tracing-rc/src/rc/collector.rs
@@ -54,7 +54,7 @@ pub struct GcVisitor<'cycle> {
 impl GcVisitor<'_> {
     /// Visit an owned [`Gc`] node.
     pub fn visit_node<T: Trace + 'static>(&mut self, node: &Gc<T>) {
-        (self.visitor)(node.ptr.clone());
+        (self.visitor)(node.ptr.clone() as Rc<_>);
     }
 }
 
@@ -138,7 +138,7 @@ fn collect_old_gen() {
     // Iterate over all nodes reachable from the old gen tracking them in the list of all
     // traced nodes.
     // We iterate over the initial list of nodes here, since all new nodes are added afterwards.
-    for node_ix in (0..connectivity_graph.node_count()).map(GraphIndex::from) {
+    for node_ix in 0..connectivity_graph.node_count() {
         match traced_nodes.get_index(node_ix).unwrap().0.status.get() {
             Status::Live | Status::Dead => {
                 // We'll collect it later if it a new strong reference was created and added
diff --git a/tracing-rc/src/sync/collector.rs b/tracing-rc/src/sync/collector.rs
@@ -68,7 +68,7 @@ pub struct GcVisitor<'cycle> {
 impl GcVisitor<'_> {
     /// Visit an owned [`Agc`] node.
     pub fn visit_node<T: Trace + 'static>(&mut self, node: &Agc<T>) {
-        (self.visitor)(node.ptr.clone());
+        (self.visitor)(node.ptr.clone() as Arc<_>);
     }
 }
 
diff --git a/tracing-rc/src/sync/mod.rs b/tracing-rc/src/sync/mod.rs
@@ -1,10 +1,14 @@
 use std::{
     mem::ManuallyDrop,
     ops::Deref,
-    sync::Arc,
+    sync::{
+        Arc,
+        Weak,
+    },
 };
 
 use atomic::Atomic;
+use bytemuck::NoUninit;
 use parking_lot::{
     RwLock,
     RwLockReadGuard,
@@ -16,7 +20,7 @@ use parking_lot::{
 ///
 /// 1. The reference count of traced objects. This may change at any time.
 /// 2. The graph of child components. This may be altered any time a reference is access outside the
-/// collector.
+///    collector.
 /// 3. The status of the object. This may change at any time.
 ///
 /// If we decide an object is live, it is pretty safe to mark all of its children live since we
@@ -79,7 +83,8 @@ impl<T: ?Sized> Deref for Ref<'_, T> {
     }
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, NoUninit)]
+#[repr(i8)]
 enum Status {
     /// The node has had its refcount incremented recently or a mutable/immutable borrow checked
     /// out and is definitely alive.
@@ -206,7 +211,7 @@ where
     }
 
     fn node(&self) -> WeakNode {
-        let inner_ptr = Arc::downgrade(&self.ptr);
+        let inner_ptr = Arc::downgrade(&self.ptr) as Weak<_>;
         WeakNode { inner_ptr }
     }
 }
diff --git a/tracing-rc/tests/bad_tracing/rc.rs b/tracing-rc/tests/bad_tracing/rc.rs
@@ -99,7 +99,7 @@ fn drop_acyclic_value_during_trace() {
 
 #[test]
 fn retain_value_during_trace() {
-    thread_local! { static SMUGGLE: RefCell<Option<Gc<Extra>>> = RefCell::new(None) };
+    thread_local! { static SMUGGLE: RefCell<Option<Gc<Extra>>> = const { RefCell::new(None) } };
 
     #[derive(Debug)]
     struct Extra {
diff --git a/tracing-rc/tests/rc/necromancy.rs b/tracing-rc/tests/rc/necromancy.rs
