grafeo-common 0.5.41

Common types, memory allocators, and utilities for Grafeo
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! Memory usage breakdown types for graph store components.
//!
//! These types live in grafeo-common so both grafeo-core (which implements
//! the estimations) and grafeo-engine (which aggregates them) can use them.

use serde::{Deserialize, Serialize};

/// Memory used by the graph store (nodes, edges, properties).
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StoreMemory {
    /// Total store memory.
    pub total_bytes: usize,
    /// Node record storage (hash map buckets + `NodeRecord` data).
    pub nodes_bytes: usize,
    /// Edge record storage (hash map buckets + `EdgeRecord` data).
    pub edges_bytes: usize,
    /// Node property columns.
    pub node_properties_bytes: usize,
    /// Edge property columns.
    pub edge_properties_bytes: usize,
    /// Number of property columns (node + edge).
    pub property_column_count: usize,
}

impl StoreMemory {
    /// Recomputes `total_bytes` from child values.
    pub fn compute_total(&mut self) {
        self.total_bytes = self.nodes_bytes
            + self.edges_bytes
            + self.node_properties_bytes
            + self.edge_properties_bytes;
    }
}

/// Memory used by index structures.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct IndexMemory {
    /// Total index memory.
    pub total_bytes: usize,
    /// Forward adjacency lists.
    pub forward_adjacency_bytes: usize,
    /// Backward adjacency lists (0 if disabled).
    pub backward_adjacency_bytes: usize,
    /// Label index (label_id -> node set).
    pub label_index_bytes: usize,
    /// Node-to-labels reverse index.
    pub node_labels_bytes: usize,
    /// Property value indexes.
    pub property_index_bytes: usize,
    /// Per-index breakdown for vector indexes.
    pub vector_indexes: Vec<NamedMemory>,
    /// Per-index breakdown for text indexes.
    pub text_indexes: Vec<NamedMemory>,
}

impl IndexMemory {
    /// Recomputes `total_bytes` from child values.
    pub fn compute_total(&mut self) {
        self.total_bytes = self.forward_adjacency_bytes
            + self.backward_adjacency_bytes
            + self.label_index_bytes
            + self.node_labels_bytes
            + self.property_index_bytes
            + self.vector_indexes.iter().map(|v| v.bytes).sum::<usize>()
            + self.text_indexes.iter().map(|t| t.bytes).sum::<usize>();
    }
}

/// Memory usage for a named component (e.g., a specific index).
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct NamedMemory {
    /// Component name.
    pub name: String,
    /// Estimated heap bytes.
    pub bytes: usize,
    /// Number of items.
    pub item_count: usize,
}

/// MVCC versioning overhead.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct MvccMemory {
    /// Total MVCC overhead.
    pub total_bytes: usize,
    /// Version chain overhead for nodes.
    pub node_version_chains_bytes: usize,
    /// Version chain overhead for edges.
    pub edge_version_chains_bytes: usize,
    /// Average version chain depth.
    pub average_chain_depth: f64,
    /// Maximum version chain depth seen.
    pub max_chain_depth: usize,
}

impl MvccMemory {
    /// Recomputes `total_bytes` from child values.
    pub fn compute_total(&mut self) {
        self.total_bytes = self.node_version_chains_bytes + self.edge_version_chains_bytes;
    }
}

/// Memory used by label/edge type registries.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StringPoolMemory {
    /// Total bytes for label/type registries.
    pub total_bytes: usize,
    /// Label registry (names + ID maps).
    pub label_registry_bytes: usize,
    /// Edge type registry (names + ID maps).
    pub edge_type_registry_bytes: usize,
    /// Number of interned labels.
    pub label_count: usize,
    /// Number of interned edge types.
    pub edge_type_count: usize,
}

impl StringPoolMemory {
    /// Recomputes `total_bytes` from child values.
    pub fn compute_total(&mut self) {
        self.total_bytes = self.label_registry_bytes + self.edge_type_registry_bytes;
    }
}