use std::collections::HashMap;
use serde::{Deserialize, Serialize};
use super::super::node::id::NodeId;
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct MacroNodeMetadata {
pub macro_generated: Option<bool>,
pub macro_source: Option<String>,
pub cfg_condition: Option<String>,
pub cfg_active: Option<bool>,
pub proc_macro_kind: Option<ProcMacroFunctionKind>,
pub expansion_cached: Option<bool>,
pub unresolved_attributes: Vec<String>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ProcMacroFunctionKind {
Derive,
Attribute,
FunctionLike,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ClasspathNodeMetadata {
pub coordinates: Option<String>,
pub jar_path: String,
pub fqn: String,
pub is_direct_dependency: bool,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum NodeMetadata {
Macro(MacroNodeMetadata),
Classpath(ClasspathNodeMetadata),
Synthetic,
}
const NODE_METADATA_MACRO: u8 = 0;
const NODE_METADATA_CLASSPATH: u8 = 1;
const NODE_METADATA_SYNTHETIC: u8 = 2;
#[derive(Debug, Clone, Default)]
pub struct NodeMetadataStore {
entries: HashMap<(u32, u64), NodeMetadata>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
struct NodeMetadataEntryV7 {
index: u32,
generation: u64,
kind: u8,
macro_data: Option<MacroNodeMetadata>,
classpath_data: Option<ClasspathNodeMetadata>,
}
impl Serialize for NodeMetadataStore {
fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
let entries: Vec<NodeMetadataEntryV7> = self
.entries
.iter()
.map(|(&(index, generation), metadata)| match metadata {
NodeMetadata::Macro(m) => NodeMetadataEntryV7 {
index,
generation,
kind: NODE_METADATA_MACRO,
macro_data: Some(m.clone()),
classpath_data: None,
},
NodeMetadata::Classpath(c) => NodeMetadataEntryV7 {
index,
generation,
kind: NODE_METADATA_CLASSPATH,
macro_data: None,
classpath_data: Some(c.clone()),
},
NodeMetadata::Synthetic => NodeMetadataEntryV7 {
index,
generation,
kind: NODE_METADATA_SYNTHETIC,
macro_data: None,
classpath_data: None,
},
})
.collect();
entries.serialize(serializer)
}
}
impl<'de> Deserialize<'de> for NodeMetadataStore {
fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
let entries: Vec<NodeMetadataEntryV7> = Vec::deserialize(deserializer)?;
let mut map = HashMap::with_capacity(entries.len());
for e in entries {
let metadata = match e.kind {
NODE_METADATA_CLASSPATH => {
let data = e.classpath_data.ok_or_else(|| {
serde::de::Error::custom(
"missing classpath_data for Classpath metadata entry",
)
})?;
NodeMetadata::Classpath(data)
}
NODE_METADATA_SYNTHETIC => NodeMetadata::Synthetic,
_ => {
let data = e.macro_data.unwrap_or_default();
NodeMetadata::Macro(data)
}
};
map.insert((e.index, e.generation), metadata);
}
Ok(Self { entries: map })
}
}
impl NodeMetadataStore {
#[must_use]
pub fn new() -> Self {
Self::default()
}
#[must_use]
pub fn get(&self, node_id: NodeId) -> Option<&MacroNodeMetadata> {
match self.entries.get(&(node_id.index(), node_id.generation()))? {
NodeMetadata::Macro(m) => Some(m),
NodeMetadata::Classpath(_) | NodeMetadata::Synthetic => None,
}
}
#[must_use]
pub fn get_metadata(&self, node_id: NodeId) -> Option<&NodeMetadata> {
self.entries.get(&(node_id.index(), node_id.generation()))
}
#[must_use]
pub fn get_mut(&mut self, node_id: NodeId) -> Option<&mut MacroNodeMetadata> {
match self
.entries
.get_mut(&(node_id.index(), node_id.generation()))?
{
NodeMetadata::Macro(m) => Some(m),
NodeMetadata::Classpath(_) | NodeMetadata::Synthetic => None,
}
}
pub fn insert(&mut self, node_id: NodeId, metadata: MacroNodeMetadata) {
self.entries.insert(
(node_id.index(), node_id.generation()),
NodeMetadata::Macro(metadata),
);
}
pub fn insert_metadata(&mut self, node_id: NodeId, metadata: NodeMetadata) {
self.entries
.insert((node_id.index(), node_id.generation()), metadata);
}
pub fn mark_synthetic(&mut self, node_id: NodeId) {
self.entries.insert(
(node_id.index(), node_id.generation()),
NodeMetadata::Synthetic,
);
}
#[must_use]
pub fn is_synthetic(&self, node_id: NodeId) -> bool {
matches!(
self.entries.get(&(node_id.index(), node_id.generation())),
Some(NodeMetadata::Synthetic)
)
}
pub fn get_or_insert_default(&mut self, node_id: NodeId) -> &mut MacroNodeMetadata {
let entry = self
.entries
.entry((node_id.index(), node_id.generation()))
.or_insert_with(|| NodeMetadata::Macro(MacroNodeMetadata::default()));
match entry {
NodeMetadata::Macro(m) => m,
NodeMetadata::Classpath(_) => {
panic!("get_or_insert_default called on a Classpath metadata entry")
}
NodeMetadata::Synthetic => {
panic!("get_or_insert_default called on a Synthetic metadata entry")
}
}
}
pub fn remove(&mut self, node_id: NodeId) -> Option<MacroNodeMetadata> {
match self
.entries
.remove(&(node_id.index(), node_id.generation()))?
{
NodeMetadata::Macro(m) => Some(m),
NodeMetadata::Classpath(_) | NodeMetadata::Synthetic => None,
}
}
pub fn remove_metadata(&mut self, node_id: NodeId) -> Option<NodeMetadata> {
self.entries
.remove(&(node_id.index(), node_id.generation()))
}
#[must_use]
pub fn len(&self) -> usize {
self.entries.len()
}
#[must_use]
pub fn is_empty(&self) -> bool {
self.entries.is_empty()
}
pub fn iter(&self) -> impl Iterator<Item = ((u32, u64), &MacroNodeMetadata)> {
self.entries.iter().filter_map(|(&k, v)| match v {
NodeMetadata::Macro(m) => Some((k, m)),
NodeMetadata::Classpath(_) | NodeMetadata::Synthetic => None,
})
}
pub fn iter_all(&self) -> impl Iterator<Item = ((u32, u64), &NodeMetadata)> {
self.entries.iter().map(|(&k, v)| (k, v))
}
pub fn merge(&mut self, other: &NodeMetadataStore) {
for (&key, value) in &other.entries {
self.entries.insert(key, value.clone());
}
}
#[allow(dead_code)]
pub(crate) fn retain_entries<F>(&mut self, mut keep: F)
where
F: FnMut(u32, u64) -> bool,
{
self.entries
.retain(|&(index, generation), _meta| keep(index, generation));
}
}
impl PartialEq for NodeMetadataStore {
fn eq(&self, other: &Self) -> bool {
self.entries == other.entries
}
}
impl Eq for NodeMetadataStore {}
impl crate::graph::unified::memory::GraphMemorySize for NodeMetadataStore {
fn heap_bytes(&self) -> usize {
use crate::graph::unified::memory::HASHMAP_ENTRY_OVERHEAD;
let base = self.entries.capacity()
* (std::mem::size_of::<(u32, u64)>()
+ std::mem::size_of::<NodeMetadata>()
+ HASHMAP_ENTRY_OVERHEAD);
let inner: usize = self
.entries
.values()
.map(|meta| match meta {
NodeMetadata::Macro(m) => {
m.macro_source.as_ref().map_or(0, String::capacity)
+ m.cfg_condition.as_ref().map_or(0, String::capacity)
+ m.unresolved_attributes
.iter()
.map(String::capacity)
.sum::<usize>()
+ m.unresolved_attributes.capacity() * std::mem::size_of::<String>()
}
NodeMetadata::Classpath(c) => {
c.coordinates.as_ref().map_or(0, String::capacity)
+ c.jar_path.capacity()
+ c.fqn.capacity()
}
NodeMetadata::Synthetic => 0,
})
.sum();
base + inner
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_metadata_store_basic_operations() {
let mut store = NodeMetadataStore::new();
assert!(store.is_empty());
assert_eq!(store.len(), 0);
let node = NodeId::new(5, 1);
let metadata = MacroNodeMetadata {
macro_generated: Some(true),
macro_source: Some("derive_Debug".to_string()),
..Default::default()
};
store.insert(node, metadata.clone());
assert_eq!(store.len(), 1);
assert!(!store.is_empty());
let retrieved = store.get(node).unwrap();
assert_eq!(retrieved.macro_generated, Some(true));
assert_eq!(retrieved.macro_source.as_deref(), Some("derive_Debug"));
}
#[test]
fn test_metadata_full_nodeid_key() {
let mut store = NodeMetadataStore::new();
let node_gen1 = NodeId::new(5, 1);
let node_gen2 = NodeId::new(5, 2);
store.insert(
node_gen1,
MacroNodeMetadata {
macro_generated: Some(true),
..Default::default()
},
);
assert!(store.get(node_gen2).is_none());
assert!(store.get(node_gen1).is_some());
}
#[test]
fn test_metadata_slot_reuse_no_stale_data() {
let mut store = NodeMetadataStore::new();
let old_node = NodeId::new(5, 1);
store.insert(
old_node,
MacroNodeMetadata {
cfg_condition: Some("test".to_string()),
..Default::default()
},
);
let new_node = NodeId::new(5, 2);
assert!(store.get(new_node).is_none());
assert_eq!(
store.get(old_node).unwrap().cfg_condition.as_deref(),
Some("test")
);
}
#[test]
fn test_metadata_store_postcard_roundtrip() {
let mut store = NodeMetadataStore::new();
store.insert(
NodeId::new(1, 0),
MacroNodeMetadata {
macro_generated: Some(true),
macro_source: Some("derive_Debug".to_string()),
cfg_condition: Some("test".to_string()),
cfg_active: Some(true),
proc_macro_kind: Some(ProcMacroFunctionKind::Derive),
expansion_cached: Some(false),
unresolved_attributes: vec!["my_attr".to_string()],
},
);
store.insert(
NodeId::new(42, 3),
MacroNodeMetadata {
cfg_condition: Some("feature = \"serde\"".to_string()),
..Default::default()
},
);
let bytes = postcard::to_allocvec(&store).expect("serialize");
let deserialized: NodeMetadataStore = postcard::from_bytes(&bytes).expect("deserialize");
assert_eq!(store, deserialized);
}
#[test]
fn test_empty_metadata_store_zero_overhead() {
let store = NodeMetadataStore::new();
let bytes = postcard::to_allocvec(&store).expect("serialize");
assert!(
bytes.len() <= 2,
"Empty store should serialize to minimal bytes, got {} bytes",
bytes.len()
);
}
#[test]
fn test_metadata_store_merge() {
let mut store1 = NodeMetadataStore::new();
let mut store2 = NodeMetadataStore::new();
store1.insert(
NodeId::new(1, 0),
MacroNodeMetadata {
macro_generated: Some(true),
..Default::default()
},
);
store2.insert(
NodeId::new(2, 0),
MacroNodeMetadata {
cfg_condition: Some("test".to_string()),
..Default::default()
},
);
store1.merge(&store2);
assert_eq!(store1.len(), 2);
assert!(store1.get(NodeId::new(1, 0)).is_some());
assert!(store1.get(NodeId::new(2, 0)).is_some());
}
#[test]
fn test_proc_macro_function_kind_serde() {
let kinds = [
ProcMacroFunctionKind::Derive,
ProcMacroFunctionKind::Attribute,
ProcMacroFunctionKind::FunctionLike,
];
for kind in kinds {
let bytes = postcard::to_allocvec(&kind).expect("serialize");
let deserialized: ProcMacroFunctionKind =
postcard::from_bytes(&bytes).expect("deserialize");
assert_eq!(kind, deserialized);
}
}
#[test]
fn test_metadata_get_or_insert_default() {
let mut store = NodeMetadataStore::new();
let node = NodeId::new(10, 0);
let meta = store.get_or_insert_default(node);
meta.cfg_condition = Some("test".to_string());
let meta = store.get(node).unwrap();
assert_eq!(meta.cfg_condition.as_deref(), Some("test"));
}
#[test]
fn test_metadata_remove() {
let mut store = NodeMetadataStore::new();
let node = NodeId::new(1, 0);
store.insert(
node,
MacroNodeMetadata {
macro_generated: Some(true),
..Default::default()
},
);
assert!(store.get(node).is_some());
let removed = store.remove(node);
assert!(removed.is_some());
assert!(store.get(node).is_none());
assert!(store.is_empty());
}
#[test]
fn test_metadata_store_large_scale() {
let mut store = NodeMetadataStore::new();
for i in 0..10_000u32 {
store.insert(
NodeId::new(i, 0),
MacroNodeMetadata {
cfg_condition: Some(format!("feature_{i}")),
..Default::default()
},
);
}
assert_eq!(store.len(), 10_000);
assert!(store.get(NodeId::new(0, 0)).is_some());
assert!(store.get(NodeId::new(5_000, 0)).is_some());
assert!(store.get(NodeId::new(9_999, 0)).is_some());
assert!(store.get(NodeId::new(10_000, 0)).is_none());
let bytes = postcard::to_allocvec(&store).expect("serialize");
let deserialized: NodeMetadataStore = postcard::from_bytes(&bytes).expect("deserialize");
assert_eq!(store, deserialized);
}
#[test]
fn test_classpath_metadata_insert_and_get() {
let mut store = NodeMetadataStore::new();
let node = NodeId::new(100, 0);
let cp_meta = ClasspathNodeMetadata {
coordinates: Some("com.google.guava:guava:33.0.0".to_string()),
jar_path: "/home/user/.m2/repository/guava-33.0.0.jar".to_string(),
fqn: "com.google.common.collect.ImmutableList".to_string(),
is_direct_dependency: true,
};
store.insert_metadata(node, NodeMetadata::Classpath(cp_meta.clone()));
assert_eq!(store.len(), 1);
assert!(store.get(node).is_none());
let retrieved = store.get_metadata(node).unwrap();
match retrieved {
NodeMetadata::Classpath(cp) => {
assert_eq!(cp.fqn, "com.google.common.collect.ImmutableList");
assert_eq!(
cp.coordinates.as_deref(),
Some("com.google.guava:guava:33.0.0")
);
assert!(cp.is_direct_dependency);
}
NodeMetadata::Macro(_) => panic!("expected Classpath variant"),
NodeMetadata::Synthetic => panic!("expected Classpath variant, got Synthetic"),
}
}
#[test]
fn test_classpath_metadata_postcard_roundtrip() {
let mut store = NodeMetadataStore::new();
store.insert(
NodeId::new(1, 0),
MacroNodeMetadata {
macro_generated: Some(true),
..Default::default()
},
);
store.insert_metadata(
NodeId::new(2, 0),
NodeMetadata::Classpath(ClasspathNodeMetadata {
coordinates: Some("org.slf4j:slf4j-api:2.0.0".to_string()),
jar_path: "slf4j-api-2.0.0.jar".to_string(),
fqn: "org.slf4j.Logger".to_string(),
is_direct_dependency: false,
}),
);
let bytes = postcard::to_allocvec(&store).expect("serialize");
let deserialized: NodeMetadataStore = postcard::from_bytes(&bytes).expect("deserialize");
assert_eq!(store, deserialized);
assert_eq!(deserialized.len(), 2);
assert!(deserialized.get(NodeId::new(1, 0)).is_some());
let cp = deserialized.get_metadata(NodeId::new(2, 0)).unwrap();
assert!(matches!(cp, NodeMetadata::Classpath(_)));
}
#[test]
fn test_node_metadata_store_json_roundtrip() {
let mut store = NodeMetadataStore::new();
store.insert(
NodeId::new(1, 0),
MacroNodeMetadata {
macro_generated: Some(true),
macro_source: Some("serde_derive".to_string()),
..Default::default()
},
);
store.insert_metadata(
NodeId::new(2, 0),
NodeMetadata::Classpath(ClasspathNodeMetadata {
coordinates: None,
jar_path: "rt.jar".to_string(),
fqn: "java.lang.String".to_string(),
is_direct_dependency: true,
}),
);
let json = serde_json::to_string(&store).unwrap();
let deserialized: NodeMetadataStore = serde_json::from_str(&json).unwrap();
assert_eq!(store, deserialized);
}
#[test]
fn test_iter_all_includes_both_types() {
let mut store = NodeMetadataStore::new();
store.insert(
NodeId::new(1, 0),
MacroNodeMetadata {
macro_generated: Some(true),
..Default::default()
},
);
store.insert_metadata(
NodeId::new(2, 0),
NodeMetadata::Classpath(ClasspathNodeMetadata {
coordinates: None,
jar_path: "test.jar".to_string(),
fqn: "com.example.Test".to_string(),
is_direct_dependency: true,
}),
);
let macro_entries: Vec<_> = store.iter().collect();
assert_eq!(macro_entries.len(), 1);
let all_entries: Vec<_> = store.iter_all().collect();
assert_eq!(all_entries.len(), 2);
}
#[test]
fn test_remove_metadata_classpath() {
let mut store = NodeMetadataStore::new();
let node = NodeId::new(50, 0);
store.insert_metadata(
node,
NodeMetadata::Classpath(ClasspathNodeMetadata {
coordinates: None,
jar_path: "test.jar".to_string(),
fqn: "Test".to_string(),
is_direct_dependency: true,
}),
);
assert_eq!(store.len(), 1);
let removed = store.remove(node);
assert!(removed.is_none());
assert!(store.is_empty());
}
#[test]
fn synthetic_mark_and_query() {
let mut store = NodeMetadataStore::new();
let node = NodeId::new(7, 1);
assert!(!store.is_synthetic(node), "missing entry must report false");
store.mark_synthetic(node);
assert!(store.is_synthetic(node));
assert_eq!(store.len(), 1);
assert!(store.get(node).is_none());
assert!(matches!(
store.get_metadata(node),
Some(NodeMetadata::Synthetic),
));
let stale = NodeId::new(7, 2);
assert!(!store.is_synthetic(stale));
}
#[test]
fn synthetic_replaces_other_variants() {
let mut store = NodeMetadataStore::new();
let node = NodeId::new(11, 1);
store.insert(
node,
MacroNodeMetadata {
cfg_condition: Some("test".to_string()),
..Default::default()
},
);
assert!(store.get(node).is_some());
store.mark_synthetic(node);
assert!(store.is_synthetic(node));
assert!(store.get(node).is_none());
assert_eq!(store.len(), 1);
}
#[test]
fn synthetic_postcard_roundtrip_preserves_v10_wire_shape() {
let mut store = NodeMetadataStore::new();
store.insert(
NodeId::new(1, 0),
MacroNodeMetadata {
macro_generated: Some(true),
..Default::default()
},
);
store.insert_metadata(
NodeId::new(2, 0),
NodeMetadata::Classpath(ClasspathNodeMetadata {
coordinates: None,
jar_path: "x.jar".to_string(),
fqn: "com.example.X".to_string(),
is_direct_dependency: true,
}),
);
store.mark_synthetic(NodeId::new(3, 0));
store.mark_synthetic(NodeId::new(99, 5));
let bytes = postcard::to_allocvec(&store).expect("serialize");
let decoded: NodeMetadataStore = postcard::from_bytes(&bytes).expect("deserialize");
assert_eq!(store, decoded);
assert_eq!(decoded.len(), 4);
assert!(decoded.is_synthetic(NodeId::new(3, 0)));
assert!(decoded.is_synthetic(NodeId::new(99, 5)));
assert!(matches!(
decoded.get_metadata(NodeId::new(2, 0)),
Some(NodeMetadata::Classpath(_))
));
assert!(matches!(
decoded.get_metadata(NodeId::new(1, 0)),
Some(NodeMetadata::Macro(_))
));
}
#[test]
fn synthetic_v10_legacy_snapshot_decodes_without_synthetic_entries() {
let mut legacy = NodeMetadataStore::new();
legacy.insert(
NodeId::new(1, 0),
MacroNodeMetadata {
macro_generated: Some(true),
..Default::default()
},
);
legacy.insert_metadata(
NodeId::new(2, 0),
NodeMetadata::Classpath(ClasspathNodeMetadata {
coordinates: None,
jar_path: "y.jar".to_string(),
fqn: "com.example.Y".to_string(),
is_direct_dependency: false,
}),
);
let bytes = postcard::to_allocvec(&legacy).expect("serialize");
let decoded: NodeMetadataStore = postcard::from_bytes(&bytes).expect("deserialize");
assert_eq!(legacy, decoded);
assert!(!decoded.is_synthetic(NodeId::new(1, 0)));
assert!(!decoded.is_synthetic(NodeId::new(2, 0)));
assert_eq!(decoded.len(), 2);
}
#[test]
fn test_remove_metadata_typed() {
let mut store = NodeMetadataStore::new();
let node = NodeId::new(50, 0);
store.insert_metadata(
node,
NodeMetadata::Classpath(ClasspathNodeMetadata {
coordinates: None,
jar_path: "test.jar".to_string(),
fqn: "Test".to_string(),
is_direct_dependency: true,
}),
);
let removed = store.remove_metadata(node);
assert!(matches!(removed, Some(NodeMetadata::Classpath(_))));
assert!(store.is_empty());
}
}