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
// Copyright (c) 2026 Austin Han <austinhan1024@gmail.com>
//
// This file is part of RocksGraph.
//
// RocksGraph is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// RocksGraph is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with RocksGraph. If not, see <https://www.gnu.org/licenses/>.
use crate::types::PIPELINE_PRODUCE_SIZE;
use std::rc::Rc;
use smallvec::SmallVec;
use crate::engine::volcano::steps::traits::ExplainNode;
use crate::{
engine::{
context::GraphCtx,
traverser::Traverser,
volcano::steps::traits::{CoreStep, StepRef},
},
types::{error::StoreError, prop_key::LABEL_KEY_ID, CanonicalKey, GValue, Primitive, PrimitivePredicate},
};
/// Sentinel `label_id` an unregistered label name resolves to (see `PhysicalPlanBuilder`'s
/// `LogicalStep::HasLabel` arm) — guaranteed to never equal a real one, since real ids are
/// non-negative (`LabelId` is `u16`, cast up to `i32` here to share `Primitive::Int32` with the
/// runtime value being compared against).
pub(crate) const UNRESOLVED_LABEL_ID: i32 = -1;
/// A physical step that filters traversers based on the label of the element they carry.
#[derive(Debug)]
pub struct HasLabelStep {
// ── Upstream link ──
upstream: Option<StepRef>,
// ── Static/Fixed configuration ──
/// Predicate over the element's label id in the *vertex* namespace — resolved from the
/// user's label name(s) once at build time (see `PhysicalPlanBuilder`), so `produce()` never
/// needs to touch the schema.
vertex_pred: PrimitivePredicate,
/// Predicate over the element's label id in the *edge* namespace. Separate from
/// `vertex_pred` because vertex and edge labels are independent id spaces — the same name
/// can resolve to different ids (or be registered in only one namespace).
edge_pred: PrimitivePredicate,
}
/// Creates a new `HasLabelStep` with the vertex- and edge-namespace label-id predicates.
impl HasLabelStep {
pub fn new(vertex_pred: PrimitivePredicate, edge_pred: PrimitivePredicate) -> Self {
Self { upstream: None, vertex_pred, edge_pred }
}
}
impl CoreStep for HasLabelStep {
fn add_upper(&mut self, upstream: StepRef) {
// Sets the upstream step for this filter.
self.upstream = Some(upstream);
}
fn produce(
&mut self,
ctx: &mut dyn GraphCtx,
) -> Result<Option<SmallVec<[Rc<Traverser>; PIPELINE_PRODUCE_SIZE]>>, StoreError> {
// Produces traversers whose element's label id matches the resolved predicate — a plain
// integer comparison, no schema lookup needed.
let Some(upstream) = self.upstream.as_ref() else { return Ok(None) };
let mut batch = SmallVec::with_capacity(PIPELINE_PRODUCE_SIZE);
while batch.len() < PIPELINE_PRODUCE_SIZE {
let Some(t) = upstream.next(ctx)? else { break };
let matched = match &t.value {
GValue::Vertex(vk) => {
let Some(Primitive::Int32(lb)) = ctx.get_value(&CanonicalKey::Vertex(*vk), LABEL_KEY_ID)? else {
return Err(StoreError::CorruptData("vertex label_id missing or not Int32"));
};
self.vertex_pred.evaluate(&Primitive::Int32(lb))
}
GValue::Edge(ek) => self.edge_pred.evaluate(&Primitive::Int32(ek.label_id)),
_ => false,
};
if matched {
batch.push(t);
}
}
if batch.is_empty() {
Ok(None)
} else {
Ok(Some(batch))
}
}
fn reset(&mut self) {
// Resets the state of this step and its upstream.
if let Some(up) = &self.upstream {
up.reset();
}
}
fn upper(&self) -> Option<StepRef> {
// Returns a clone of the upstream step reference.
self.upstream.clone()
}
fn explain(&self) -> ExplainNode {
let params = vec![("vertex_pred", format!("{:?}", self.vertex_pred))];
ExplainNode::new("HasLabelStep").with_params(params)
}
}