1use crate::query::plan::{
6 AggregateOp, DistinctOp, ExpandDirection, ExpandOp, FilterOp, JoinOp, JoinType, LimitOp,
7 LogicalOperator, MultiWayJoinOp, NodeScanOp, ProjectOp, ReturnOp, SkipOp, SortOp, VectorJoinOp,
8 VectorScanOp,
9};
10use std::collections::HashMap;
11
12#[derive(Debug, Clone, Copy, PartialEq)]
16pub struct Cost {
17 pub cpu: f64,
19 pub io: f64,
21 pub memory: f64,
23 pub network: f64,
25}
26
27impl Cost {
28 #[must_use]
30 pub fn zero() -> Self {
31 Self {
32 cpu: 0.0,
33 io: 0.0,
34 memory: 0.0,
35 network: 0.0,
36 }
37 }
38
39 #[must_use]
41 pub fn cpu(cpu: f64) -> Self {
42 Self {
43 cpu,
44 io: 0.0,
45 memory: 0.0,
46 network: 0.0,
47 }
48 }
49
50 #[must_use]
52 pub fn with_io(mut self, io: f64) -> Self {
53 self.io = io;
54 self
55 }
56
57 #[must_use]
59 pub fn with_memory(mut self, memory: f64) -> Self {
60 self.memory = memory;
61 self
62 }
63
64 #[must_use]
68 pub fn total(&self) -> f64 {
69 self.cpu + self.io * 10.0 + self.memory * 0.1 + self.network * 100.0
70 }
71
72 #[must_use]
74 pub fn total_weighted(&self, cpu_weight: f64, io_weight: f64, mem_weight: f64) -> f64 {
75 self.cpu * cpu_weight + self.io * io_weight + self.memory * mem_weight
76 }
77}
78
79impl std::ops::Add for Cost {
80 type Output = Self;
81
82 fn add(self, other: Self) -> Self {
83 Self {
84 cpu: self.cpu + other.cpu,
85 io: self.io + other.io,
86 memory: self.memory + other.memory,
87 network: self.network + other.network,
88 }
89 }
90}
91
92impl std::ops::AddAssign for Cost {
93 fn add_assign(&mut self, other: Self) {
94 self.cpu += other.cpu;
95 self.io += other.io;
96 self.memory += other.memory;
97 self.network += other.network;
98 }
99}
100
101pub struct CostModel {
109 cpu_tuple_cost: f64,
111 hash_lookup_cost: f64,
113 sort_comparison_cost: f64,
115 avg_tuple_size: f64,
117 page_size: f64,
119 avg_fanout: f64,
121 edge_type_degrees: HashMap<String, (f64, f64)>,
123 label_cardinalities: HashMap<String, u64>,
125 total_nodes: u64,
127 total_edges: u64,
129}
130
131impl CostModel {
132 #[must_use]
134 pub fn new() -> Self {
135 Self {
136 cpu_tuple_cost: 0.01,
137 hash_lookup_cost: 0.03,
138 sort_comparison_cost: 0.02,
139 avg_tuple_size: 100.0,
140 page_size: 8192.0,
141 avg_fanout: 10.0,
142 edge_type_degrees: HashMap::new(),
143 label_cardinalities: HashMap::new(),
144 total_nodes: 0,
145 total_edges: 0,
146 }
147 }
148
149 #[must_use]
151 pub fn with_avg_fanout(mut self, avg_fanout: f64) -> Self {
152 self.avg_fanout = if avg_fanout > 0.0 { avg_fanout } else { 10.0 };
153 self
154 }
155
156 #[must_use]
160 pub fn with_edge_type_degrees(mut self, degrees: HashMap<String, (f64, f64)>) -> Self {
161 self.edge_type_degrees = degrees;
162 self
163 }
164
165 #[must_use]
167 pub fn with_label_cardinalities(mut self, cardinalities: HashMap<String, u64>) -> Self {
168 self.label_cardinalities = cardinalities;
169 self
170 }
171
172 #[must_use]
174 pub fn with_graph_totals(mut self, total_nodes: u64, total_edges: u64) -> Self {
175 self.total_nodes = total_nodes;
176 self.total_edges = total_edges;
177 self
178 }
179
180 fn fanout_for_expand(&self, expand: &ExpandOp) -> f64 {
185 if expand.edge_types.is_empty() {
186 return self.avg_fanout;
187 }
188
189 let mut total_fanout = 0.0;
190 let mut all_found = true;
191
192 for edge_type in &expand.edge_types {
193 if let Some(&(out_deg, in_deg)) = self.edge_type_degrees.get(edge_type) {
194 total_fanout += match expand.direction {
195 ExpandDirection::Outgoing => out_deg,
196 ExpandDirection::Incoming => in_deg,
197 ExpandDirection::Both => out_deg + in_deg,
198 };
199 } else {
200 all_found = false;
201 break;
202 }
203 }
204
205 if all_found {
206 total_fanout
207 } else {
208 self.avg_fanout
209 }
210 }
211
212 #[must_use]
214 pub fn estimate(&self, op: &LogicalOperator, cardinality: f64) -> Cost {
215 match op {
216 LogicalOperator::NodeScan(scan) => self.node_scan_cost(scan, cardinality),
217 LogicalOperator::Filter(filter) => self.filter_cost(filter, cardinality),
218 LogicalOperator::Project(project) => self.project_cost(project, cardinality),
219 LogicalOperator::Expand(expand) => self.expand_cost(expand, cardinality),
220 LogicalOperator::Join(join) => self.join_cost(join, cardinality),
221 LogicalOperator::Aggregate(agg) => self.aggregate_cost(agg, cardinality),
222 LogicalOperator::Sort(sort) => self.sort_cost(sort, cardinality),
223 LogicalOperator::Distinct(distinct) => self.distinct_cost(distinct, cardinality),
224 LogicalOperator::Limit(limit) => self.limit_cost(limit, cardinality),
225 LogicalOperator::Skip(skip) => self.skip_cost(skip, cardinality),
226 LogicalOperator::Return(ret) => self.return_cost(ret, cardinality),
227 LogicalOperator::Empty => Cost::zero(),
228 LogicalOperator::VectorScan(scan) => self.vector_scan_cost(scan, cardinality),
229 LogicalOperator::VectorJoin(join) => self.vector_join_cost(join, cardinality),
230 LogicalOperator::MultiWayJoin(mwj) => self.multi_way_join_cost(mwj, cardinality),
231 _ => Cost::cpu(cardinality * self.cpu_tuple_cost),
232 }
233 }
234
235 fn node_scan_cost(&self, scan: &NodeScanOp, cardinality: f64) -> Cost {
241 let scan_size = if let Some(label) = &scan.label {
243 self.label_cardinalities
244 .get(label)
245 .map_or(cardinality, |&count| count as f64)
246 } else if self.total_nodes > 0 {
247 self.total_nodes as f64
248 } else {
249 cardinality
250 };
251 let pages = (scan_size * self.avg_tuple_size) / self.page_size;
252 Cost::cpu(cardinality * self.cpu_tuple_cost).with_io(pages)
254 }
255
256 fn filter_cost(&self, _filter: &FilterOp, cardinality: f64) -> Cost {
258 Cost::cpu(cardinality * self.cpu_tuple_cost * 1.5)
260 }
261
262 fn project_cost(&self, project: &ProjectOp, cardinality: f64) -> Cost {
264 let expr_count = project.projections.len() as f64;
266 Cost::cpu(cardinality * self.cpu_tuple_cost * expr_count)
267 }
268
269 fn expand_cost(&self, expand: &ExpandOp, cardinality: f64) -> Cost {
274 let fanout = self.fanout_for_expand(expand);
275 let lookup_cost = cardinality * self.hash_lookup_cost;
277 let output_cost = cardinality * fanout * self.cpu_tuple_cost;
279 Cost::cpu(lookup_cost + output_cost)
280 }
281
282 fn join_cost(&self, join: &JoinOp, cardinality: f64) -> Cost {
287 self.join_cost_with_children(join, cardinality, None, None)
288 }
289
290 fn join_cost_with_children(
292 &self,
293 join: &JoinOp,
294 cardinality: f64,
295 left_cardinality: Option<f64>,
296 right_cardinality: Option<f64>,
297 ) -> Cost {
298 match join.join_type {
299 JoinType::Cross => Cost::cpu(cardinality * self.cpu_tuple_cost),
300 JoinType::Inner | JoinType::Left | JoinType::Right | JoinType::Full => {
301 let build_cardinality = left_cardinality.unwrap_or_else(|| cardinality.sqrt());
303 let probe_cardinality = right_cardinality.unwrap_or_else(|| cardinality.sqrt());
304
305 let build_cost = build_cardinality * self.hash_lookup_cost;
306 let memory_cost = build_cardinality * self.avg_tuple_size;
307 let probe_cost = probe_cardinality * self.hash_lookup_cost;
308 let output_cost = cardinality * self.cpu_tuple_cost;
309
310 Cost::cpu(build_cost + probe_cost + output_cost).with_memory(memory_cost)
311 }
312 JoinType::Semi | JoinType::Anti => {
313 let build_cardinality = left_cardinality.unwrap_or_else(|| cardinality.sqrt());
314 let probe_cardinality = right_cardinality.unwrap_or_else(|| cardinality.sqrt());
315
316 let build_cost = build_cardinality * self.hash_lookup_cost;
317 let probe_cost = probe_cardinality * self.hash_lookup_cost;
318
319 Cost::cpu(build_cost + probe_cost)
320 .with_memory(build_cardinality * self.avg_tuple_size)
321 }
322 }
323 }
324
325 fn multi_way_join_cost(&self, mwj: &MultiWayJoinOp, cardinality: f64) -> Cost {
330 let n = mwj.inputs.len();
331 if n == 0 {
332 return Cost::zero();
333 }
334 let per_input = cardinality.powf(1.0 / n as f64).max(1.0);
337 let cardinalities: Vec<f64> = (0..n).map(|_| per_input).collect();
338 self.leapfrog_join_cost(n, &cardinalities, cardinality)
339 }
340
341 fn aggregate_cost(&self, agg: &AggregateOp, cardinality: f64) -> Cost {
343 let hash_cost = cardinality * self.hash_lookup_cost;
345
346 let agg_count = agg.aggregates.len() as f64;
348 let agg_cost = cardinality * self.cpu_tuple_cost * agg_count;
349
350 let distinct_groups = (cardinality / 10.0).max(1.0); let memory_cost = distinct_groups * self.avg_tuple_size;
353
354 Cost::cpu(hash_cost + agg_cost).with_memory(memory_cost)
355 }
356
357 fn sort_cost(&self, sort: &SortOp, cardinality: f64) -> Cost {
359 if cardinality <= 1.0 {
360 return Cost::zero();
361 }
362
363 let comparisons = cardinality * cardinality.log2();
365 let key_count = sort.keys.len() as f64;
366
367 let memory_cost = cardinality * self.avg_tuple_size;
369
370 Cost::cpu(comparisons * self.sort_comparison_cost * key_count).with_memory(memory_cost)
371 }
372
373 fn distinct_cost(&self, _distinct: &DistinctOp, cardinality: f64) -> Cost {
375 let hash_cost = cardinality * self.hash_lookup_cost;
377 let memory_cost = cardinality * self.avg_tuple_size * 0.5; Cost::cpu(hash_cost).with_memory(memory_cost)
380 }
381
382 fn limit_cost(&self, limit: &LimitOp, _cardinality: f64) -> Cost {
384 Cost::cpu(limit.count.estimate() * self.cpu_tuple_cost * 0.1)
386 }
387
388 fn skip_cost(&self, skip: &SkipOp, _cardinality: f64) -> Cost {
390 Cost::cpu(skip.count.estimate() * self.cpu_tuple_cost)
392 }
393
394 fn return_cost(&self, ret: &ReturnOp, cardinality: f64) -> Cost {
396 let expr_count = ret.items.len() as f64;
398 Cost::cpu(cardinality * self.cpu_tuple_cost * expr_count)
399 }
400
401 fn vector_scan_cost(&self, scan: &VectorScanOp, cardinality: f64) -> Cost {
406 let k = scan.k as f64;
408
409 let ef = 64.0;
412 let n = cardinality.max(1.0);
413 let search_cost = if scan.index_name.is_some() {
414 ef * n.ln() * self.cpu_tuple_cost * 10.0 } else {
417 n * self.cpu_tuple_cost * 10.0
419 };
420
421 let memory = k * self.avg_tuple_size * 2.0;
423
424 Cost::cpu(search_cost).with_memory(memory)
425 }
426
427 fn vector_join_cost(&self, join: &VectorJoinOp, cardinality: f64) -> Cost {
431 let k = join.k as f64;
432
433 let per_row_search_cost = if join.index_name.is_some() {
436 let ef = 64.0;
438 let n = cardinality.max(1.0);
439 ef * n.ln() * self.cpu_tuple_cost * 10.0
440 } else {
441 cardinality * self.cpu_tuple_cost * 10.0
443 };
444
445 let input_cardinality = (cardinality / k).max(1.0);
448 let total_search_cost = input_cardinality * per_row_search_cost;
449
450 let memory = cardinality * self.avg_tuple_size;
452
453 Cost::cpu(total_search_cost).with_memory(memory)
454 }
455
456 #[must_use]
462 pub fn estimate_tree(
463 &self,
464 op: &LogicalOperator,
465 card_estimator: &super::CardinalityEstimator,
466 ) -> Cost {
467 self.estimate_tree_inner(op, card_estimator)
468 }
469
470 fn estimate_tree_inner(
471 &self,
472 op: &LogicalOperator,
473 card_est: &super::CardinalityEstimator,
474 ) -> Cost {
475 let cardinality = card_est.estimate(op);
476
477 match op {
478 LogicalOperator::NodeScan(scan) => self.node_scan_cost(scan, cardinality),
479 LogicalOperator::Filter(filter) => {
480 let child_cost = self.estimate_tree_inner(&filter.input, card_est);
481 child_cost + self.filter_cost(filter, cardinality)
482 }
483 LogicalOperator::Project(project) => {
484 let child_cost = self.estimate_tree_inner(&project.input, card_est);
485 child_cost + self.project_cost(project, cardinality)
486 }
487 LogicalOperator::Expand(expand) => {
488 let child_cost = self.estimate_tree_inner(&expand.input, card_est);
489 child_cost + self.expand_cost(expand, cardinality)
490 }
491 LogicalOperator::Join(join) => {
492 let left_cost = self.estimate_tree_inner(&join.left, card_est);
493 let right_cost = self.estimate_tree_inner(&join.right, card_est);
494 let left_card = card_est.estimate(&join.left);
495 let right_card = card_est.estimate(&join.right);
496 let join_cost = self.join_cost_with_children(
497 join,
498 cardinality,
499 Some(left_card),
500 Some(right_card),
501 );
502 left_cost + right_cost + join_cost
503 }
504 LogicalOperator::Aggregate(agg) => {
505 let child_cost = self.estimate_tree_inner(&agg.input, card_est);
506 child_cost + self.aggregate_cost(agg, cardinality)
507 }
508 LogicalOperator::Sort(sort) => {
509 let child_cost = self.estimate_tree_inner(&sort.input, card_est);
510 child_cost + self.sort_cost(sort, cardinality)
511 }
512 LogicalOperator::Distinct(distinct) => {
513 let child_cost = self.estimate_tree_inner(&distinct.input, card_est);
514 child_cost + self.distinct_cost(distinct, cardinality)
515 }
516 LogicalOperator::Limit(limit) => {
517 let child_cost = self.estimate_tree_inner(&limit.input, card_est);
518 child_cost + self.limit_cost(limit, cardinality)
519 }
520 LogicalOperator::Skip(skip) => {
521 let child_cost = self.estimate_tree_inner(&skip.input, card_est);
522 child_cost + self.skip_cost(skip, cardinality)
523 }
524 LogicalOperator::Return(ret) => {
525 let child_cost = self.estimate_tree_inner(&ret.input, card_est);
526 child_cost + self.return_cost(ret, cardinality)
527 }
528 LogicalOperator::VectorScan(scan) => self.vector_scan_cost(scan, cardinality),
529 LogicalOperator::VectorJoin(join) => {
530 let child_cost = self.estimate_tree_inner(&join.input, card_est);
531 child_cost + self.vector_join_cost(join, cardinality)
532 }
533 LogicalOperator::MultiWayJoin(mwj) => {
534 let mut children_cost = Cost::zero();
535 for input in &mwj.inputs {
536 children_cost += self.estimate_tree_inner(input, card_est);
537 }
538 children_cost + self.multi_way_join_cost(mwj, cardinality)
539 }
540 LogicalOperator::Empty => Cost::zero(),
541 _ => Cost::cpu(cardinality * self.cpu_tuple_cost),
542 }
543 }
544
545 #[must_use]
547 pub fn cheaper<'a>(&self, a: &'a Cost, b: &'a Cost) -> &'a Cost {
548 if a.total() <= b.total() { a } else { b }
549 }
550
551 #[must_use]
567 pub fn leapfrog_join_cost(
568 &self,
569 num_relations: usize,
570 cardinalities: &[f64],
571 output_cardinality: f64,
572 ) -> Cost {
573 if cardinalities.is_empty() {
574 return Cost::zero();
575 }
576
577 let total_input: f64 = cardinalities.iter().sum();
578 let min_card = cardinalities.iter().copied().fold(f64::INFINITY, f64::min);
579
580 let materialize_cost = total_input * self.cpu_tuple_cost * 2.0; let seek_cost = if min_card > 1.0 {
585 output_cardinality * (num_relations as f64) * min_card.log2() * self.hash_lookup_cost
586 } else {
587 output_cardinality * self.cpu_tuple_cost
588 };
589
590 let output_cost = output_cardinality * self.cpu_tuple_cost;
592
593 let memory = total_input * self.avg_tuple_size * 2.0;
595
596 Cost::cpu(materialize_cost + seek_cost + output_cost).with_memory(memory)
597 }
598
599 #[must_use]
603 pub fn prefer_leapfrog_join(
604 &self,
605 num_relations: usize,
606 cardinalities: &[f64],
607 output_cardinality: f64,
608 ) -> bool {
609 if num_relations < 3 || cardinalities.len() < 3 {
610 return false;
612 }
613
614 let leapfrog_cost =
615 self.leapfrog_join_cost(num_relations, cardinalities, output_cardinality);
616
617 let mut hash_cascade_cost = Cost::zero();
621 let mut intermediate_cardinality = cardinalities[0];
622
623 for card in &cardinalities[1..] {
624 let join_output = (intermediate_cardinality * card).sqrt(); let join = JoinOp {
627 left: Box::new(LogicalOperator::Empty),
628 right: Box::new(LogicalOperator::Empty),
629 join_type: JoinType::Inner,
630 conditions: vec![],
631 };
632 hash_cascade_cost += self.join_cost(&join, join_output);
633 intermediate_cardinality = join_output;
634 }
635
636 leapfrog_cost.total() < hash_cascade_cost.total()
637 }
638
639 #[must_use]
647 pub fn factorized_benefit(&self, avg_fanout: f64, num_hops: usize) -> f64 {
648 if num_hops <= 1 || avg_fanout <= 1.0 {
649 return 1.0; }
651
652 let full_size = avg_fanout.powi(num_hops as i32);
658 let factorized_size = if avg_fanout > 1.0 {
659 (avg_fanout.powi(num_hops as i32 + 1) - 1.0) / (avg_fanout - 1.0)
660 } else {
661 num_hops as f64
662 };
663
664 (factorized_size / full_size).min(1.0)
665 }
666}
667
668impl Default for CostModel {
669 fn default() -> Self {
670 Self::new()
671 }
672}
673
674#[cfg(test)]
675mod tests {
676 use super::*;
677 use crate::query::plan::{
678 AggregateExpr, AggregateFunction, ExpandDirection, JoinCondition, LogicalExpression,
679 PathMode, Projection, ReturnItem, SortOrder,
680 };
681
682 #[test]
683 fn test_cost_addition() {
684 let a = Cost::cpu(10.0).with_io(5.0);
685 let b = Cost::cpu(20.0).with_memory(100.0);
686 let c = a + b;
687
688 assert!((c.cpu - 30.0).abs() < 0.001);
689 assert!((c.io - 5.0).abs() < 0.001);
690 assert!((c.memory - 100.0).abs() < 0.001);
691 }
692
693 #[test]
694 fn test_cost_total() {
695 let cost = Cost::cpu(10.0).with_io(1.0).with_memory(100.0);
696 assert!((cost.total() - 30.0).abs() < 0.001);
698 }
699
700 #[test]
701 fn test_cost_model_node_scan() {
702 let model = CostModel::new();
703 let scan = NodeScanOp {
704 variable: "n".to_string(),
705 label: Some("Person".to_string()),
706 input: None,
707 };
708 let cost = model.node_scan_cost(&scan, 1000.0);
709
710 assert!(cost.cpu > 0.0);
711 assert!(cost.io > 0.0);
712 }
713
714 #[test]
715 fn test_cost_model_sort() {
716 let model = CostModel::new();
717 let sort = SortOp {
718 keys: vec![],
719 input: Box::new(LogicalOperator::Empty),
720 };
721
722 let cost_100 = model.sort_cost(&sort, 100.0);
723 let cost_1000 = model.sort_cost(&sort, 1000.0);
724
725 assert!(cost_1000.total() > cost_100.total());
727 }
728
729 #[test]
730 fn test_cost_zero() {
731 let cost = Cost::zero();
732 assert!((cost.cpu).abs() < 0.001);
733 assert!((cost.io).abs() < 0.001);
734 assert!((cost.memory).abs() < 0.001);
735 assert!((cost.network).abs() < 0.001);
736 assert!((cost.total()).abs() < 0.001);
737 }
738
739 #[test]
740 fn test_cost_add_assign() {
741 let mut cost = Cost::cpu(10.0);
742 cost += Cost::cpu(5.0).with_io(2.0);
743 assert!((cost.cpu - 15.0).abs() < 0.001);
744 assert!((cost.io - 2.0).abs() < 0.001);
745 }
746
747 #[test]
748 fn test_cost_total_weighted() {
749 let cost = Cost::cpu(10.0).with_io(2.0).with_memory(100.0);
750 let total = cost.total_weighted(2.0, 5.0, 0.5);
752 assert!((total - 80.0).abs() < 0.001);
753 }
754
755 #[test]
756 fn test_cost_model_filter() {
757 let model = CostModel::new();
758 let filter = FilterOp {
759 predicate: LogicalExpression::Literal(grafeo_common::types::Value::Bool(true)),
760 input: Box::new(LogicalOperator::Empty),
761 pushdown_hint: None,
762 };
763 let cost = model.filter_cost(&filter, 1000.0);
764
765 assert!(cost.cpu > 0.0);
767 assert!((cost.io).abs() < 0.001);
768 }
769
770 #[test]
771 fn test_cost_model_project() {
772 let model = CostModel::new();
773 let project = ProjectOp {
774 projections: vec![
775 Projection {
776 expression: LogicalExpression::Variable("a".to_string()),
777 alias: None,
778 },
779 Projection {
780 expression: LogicalExpression::Variable("b".to_string()),
781 alias: None,
782 },
783 ],
784 input: Box::new(LogicalOperator::Empty),
785 };
786 let cost = model.project_cost(&project, 1000.0);
787
788 assert!(cost.cpu > 0.0);
790 }
791
792 #[test]
793 fn test_cost_model_expand() {
794 let model = CostModel::new();
795 let expand = ExpandOp {
796 from_variable: "a".to_string(),
797 to_variable: "b".to_string(),
798 edge_variable: None,
799 direction: ExpandDirection::Outgoing,
800 edge_types: vec![],
801 min_hops: 1,
802 max_hops: Some(1),
803 input: Box::new(LogicalOperator::Empty),
804 path_alias: None,
805 path_mode: PathMode::Walk,
806 };
807 let cost = model.expand_cost(&expand, 1000.0);
808
809 assert!(cost.cpu > 0.0);
811 }
812
813 #[test]
814 fn test_cost_model_expand_with_edge_type_stats() {
815 let mut degrees = std::collections::HashMap::new();
816 degrees.insert("KNOWS".to_string(), (5.0, 5.0)); degrees.insert("WORKS_AT".to_string(), (1.0, 50.0)); let model = CostModel::new().with_edge_type_degrees(degrees);
820
821 let knows_out = ExpandOp {
823 from_variable: "a".to_string(),
824 to_variable: "b".to_string(),
825 edge_variable: None,
826 direction: ExpandDirection::Outgoing,
827 edge_types: vec!["KNOWS".to_string()],
828 min_hops: 1,
829 max_hops: Some(1),
830 input: Box::new(LogicalOperator::Empty),
831 path_alias: None,
832 path_mode: PathMode::Walk,
833 };
834 let cost_knows = model.expand_cost(&knows_out, 1000.0);
835
836 let works_out = ExpandOp {
838 from_variable: "a".to_string(),
839 to_variable: "b".to_string(),
840 edge_variable: None,
841 direction: ExpandDirection::Outgoing,
842 edge_types: vec!["WORKS_AT".to_string()],
843 min_hops: 1,
844 max_hops: Some(1),
845 input: Box::new(LogicalOperator::Empty),
846 path_alias: None,
847 path_mode: PathMode::Walk,
848 };
849 let cost_works = model.expand_cost(&works_out, 1000.0);
850
851 assert!(
853 cost_knows.cpu > cost_works.cpu,
854 "KNOWS(5) should cost more than WORKS_AT(1)"
855 );
856
857 let works_in = ExpandOp {
859 from_variable: "c".to_string(),
860 to_variable: "p".to_string(),
861 edge_variable: None,
862 direction: ExpandDirection::Incoming,
863 edge_types: vec!["WORKS_AT".to_string()],
864 min_hops: 1,
865 max_hops: Some(1),
866 input: Box::new(LogicalOperator::Empty),
867 path_alias: None,
868 path_mode: PathMode::Walk,
869 };
870 let cost_works_in = model.expand_cost(&works_in, 1000.0);
871
872 assert!(
874 cost_works_in.cpu > cost_knows.cpu,
875 "Incoming WORKS_AT(50) should cost more than KNOWS(5)"
876 );
877 }
878
879 #[test]
880 fn test_cost_model_expand_unknown_edge_type_uses_global_fanout() {
881 let model = CostModel::new().with_avg_fanout(7.0);
882 let expand = ExpandOp {
883 from_variable: "a".to_string(),
884 to_variable: "b".to_string(),
885 edge_variable: None,
886 direction: ExpandDirection::Outgoing,
887 edge_types: vec!["UNKNOWN_TYPE".to_string()],
888 min_hops: 1,
889 max_hops: Some(1),
890 input: Box::new(LogicalOperator::Empty),
891 path_alias: None,
892 path_mode: PathMode::Walk,
893 };
894 let cost_unknown = model.expand_cost(&expand, 1000.0);
895
896 let expand_no_type = ExpandOp {
898 from_variable: "a".to_string(),
899 to_variable: "b".to_string(),
900 edge_variable: None,
901 direction: ExpandDirection::Outgoing,
902 edge_types: vec![],
903 min_hops: 1,
904 max_hops: Some(1),
905 input: Box::new(LogicalOperator::Empty),
906 path_alias: None,
907 path_mode: PathMode::Walk,
908 };
909 let cost_no_type = model.expand_cost(&expand_no_type, 1000.0);
910
911 assert!(
913 (cost_unknown.cpu - cost_no_type.cpu).abs() < 0.001,
914 "Unknown edge type should use global fanout"
915 );
916 }
917
918 #[test]
919 fn test_cost_model_hash_join() {
920 let model = CostModel::new();
921 let join = JoinOp {
922 left: Box::new(LogicalOperator::Empty),
923 right: Box::new(LogicalOperator::Empty),
924 join_type: JoinType::Inner,
925 conditions: vec![JoinCondition {
926 left: LogicalExpression::Variable("a".to_string()),
927 right: LogicalExpression::Variable("b".to_string()),
928 }],
929 };
930 let cost = model.join_cost(&join, 10000.0);
931
932 assert!(cost.cpu > 0.0);
934 assert!(cost.memory > 0.0);
935 }
936
937 #[test]
938 fn test_cost_model_cross_join() {
939 let model = CostModel::new();
940 let join = JoinOp {
941 left: Box::new(LogicalOperator::Empty),
942 right: Box::new(LogicalOperator::Empty),
943 join_type: JoinType::Cross,
944 conditions: vec![],
945 };
946 let cost = model.join_cost(&join, 1000000.0);
947
948 assert!(cost.cpu > 0.0);
950 }
951
952 #[test]
953 fn test_cost_model_semi_join() {
954 let model = CostModel::new();
955 let join = JoinOp {
956 left: Box::new(LogicalOperator::Empty),
957 right: Box::new(LogicalOperator::Empty),
958 join_type: JoinType::Semi,
959 conditions: vec![],
960 };
961 let cost_semi = model.join_cost(&join, 1000.0);
962
963 let inner_join = JoinOp {
964 left: Box::new(LogicalOperator::Empty),
965 right: Box::new(LogicalOperator::Empty),
966 join_type: JoinType::Inner,
967 conditions: vec![],
968 };
969 let cost_inner = model.join_cost(&inner_join, 1000.0);
970
971 assert!(cost_semi.cpu > 0.0);
973 assert!(cost_inner.cpu > 0.0);
974 }
975
976 #[test]
977 fn test_cost_model_aggregate() {
978 let model = CostModel::new();
979 let agg = AggregateOp {
980 group_by: vec![],
981 aggregates: vec![
982 AggregateExpr {
983 function: AggregateFunction::Count,
984 expression: None,
985 expression2: None,
986 distinct: false,
987 alias: Some("cnt".to_string()),
988 percentile: None,
989 separator: None,
990 },
991 AggregateExpr {
992 function: AggregateFunction::Sum,
993 expression: Some(LogicalExpression::Variable("x".to_string())),
994 expression2: None,
995 distinct: false,
996 alias: Some("total".to_string()),
997 percentile: None,
998 separator: None,
999 },
1000 ],
1001 input: Box::new(LogicalOperator::Empty),
1002 having: None,
1003 };
1004 let cost = model.aggregate_cost(&agg, 1000.0);
1005
1006 assert!(cost.cpu > 0.0);
1008 assert!(cost.memory > 0.0);
1009 }
1010
1011 #[test]
1012 fn test_cost_model_distinct() {
1013 let model = CostModel::new();
1014 let distinct = DistinctOp {
1015 input: Box::new(LogicalOperator::Empty),
1016 columns: None,
1017 };
1018 let cost = model.distinct_cost(&distinct, 1000.0);
1019
1020 assert!(cost.cpu > 0.0);
1022 assert!(cost.memory > 0.0);
1023 }
1024
1025 #[test]
1026 fn test_cost_model_limit() {
1027 let model = CostModel::new();
1028 let limit = LimitOp {
1029 count: 10.into(),
1030 input: Box::new(LogicalOperator::Empty),
1031 };
1032 let cost = model.limit_cost(&limit, 1000.0);
1033
1034 assert!(cost.cpu > 0.0);
1036 assert!(cost.cpu < 1.0); }
1038
1039 #[test]
1040 fn test_cost_model_skip() {
1041 let model = CostModel::new();
1042 let skip = SkipOp {
1043 count: 100.into(),
1044 input: Box::new(LogicalOperator::Empty),
1045 };
1046 let cost = model.skip_cost(&skip, 1000.0);
1047
1048 assert!(cost.cpu > 0.0);
1050 }
1051
1052 #[test]
1053 fn test_cost_model_return() {
1054 let model = CostModel::new();
1055 let ret = ReturnOp {
1056 items: vec![
1057 ReturnItem {
1058 expression: LogicalExpression::Variable("a".to_string()),
1059 alias: None,
1060 },
1061 ReturnItem {
1062 expression: LogicalExpression::Variable("b".to_string()),
1063 alias: None,
1064 },
1065 ],
1066 distinct: false,
1067 input: Box::new(LogicalOperator::Empty),
1068 };
1069 let cost = model.return_cost(&ret, 1000.0);
1070
1071 assert!(cost.cpu > 0.0);
1073 }
1074
1075 #[test]
1076 fn test_cost_cheaper() {
1077 let model = CostModel::new();
1078 let cheap = Cost::cpu(10.0);
1079 let expensive = Cost::cpu(100.0);
1080
1081 assert_eq!(model.cheaper(&cheap, &expensive).total(), cheap.total());
1082 assert_eq!(model.cheaper(&expensive, &cheap).total(), cheap.total());
1083 }
1084
1085 #[test]
1086 fn test_cost_comparison_prefers_lower_total() {
1087 let model = CostModel::new();
1088 let cpu_heavy = Cost::cpu(100.0).with_io(1.0);
1090 let io_heavy = Cost::cpu(10.0).with_io(20.0);
1092
1093 assert!(cpu_heavy.total() < io_heavy.total());
1095 assert_eq!(
1096 model.cheaper(&cpu_heavy, &io_heavy).total(),
1097 cpu_heavy.total()
1098 );
1099 }
1100
1101 #[test]
1102 fn test_cost_model_sort_with_keys() {
1103 let model = CostModel::new();
1104 let sort_single = SortOp {
1105 keys: vec![crate::query::plan::SortKey {
1106 expression: LogicalExpression::Variable("a".to_string()),
1107 order: SortOrder::Ascending,
1108 nulls: None,
1109 }],
1110 input: Box::new(LogicalOperator::Empty),
1111 };
1112 let sort_multi = SortOp {
1113 keys: vec![
1114 crate::query::plan::SortKey {
1115 expression: LogicalExpression::Variable("a".to_string()),
1116 order: SortOrder::Ascending,
1117 nulls: None,
1118 },
1119 crate::query::plan::SortKey {
1120 expression: LogicalExpression::Variable("b".to_string()),
1121 order: SortOrder::Descending,
1122 nulls: None,
1123 },
1124 ],
1125 input: Box::new(LogicalOperator::Empty),
1126 };
1127
1128 let cost_single = model.sort_cost(&sort_single, 1000.0);
1129 let cost_multi = model.sort_cost(&sort_multi, 1000.0);
1130
1131 assert!(cost_multi.cpu > cost_single.cpu);
1133 }
1134
1135 #[test]
1136 fn test_cost_model_empty_operator() {
1137 let model = CostModel::new();
1138 let cost = model.estimate(&LogicalOperator::Empty, 0.0);
1139 assert!((cost.total()).abs() < 0.001);
1140 }
1141
1142 #[test]
1143 fn test_cost_model_default() {
1144 let model = CostModel::default();
1145 let scan = NodeScanOp {
1146 variable: "n".to_string(),
1147 label: None,
1148 input: None,
1149 };
1150 let cost = model.estimate(&LogicalOperator::NodeScan(scan), 100.0);
1151 assert!(cost.total() > 0.0);
1152 }
1153
1154 #[test]
1155 fn test_leapfrog_join_cost() {
1156 let model = CostModel::new();
1157
1158 let cardinalities = vec![1000.0, 1000.0, 1000.0];
1160 let cost = model.leapfrog_join_cost(3, &cardinalities, 100.0);
1161
1162 assert!(cost.cpu > 0.0);
1164 assert!(cost.memory > 0.0);
1166 }
1167
1168 #[test]
1169 fn test_leapfrog_join_cost_empty() {
1170 let model = CostModel::new();
1171 let cost = model.leapfrog_join_cost(0, &[], 0.0);
1172 assert!((cost.total()).abs() < 0.001);
1173 }
1174
1175 #[test]
1176 fn test_prefer_leapfrog_join_for_triangles() {
1177 let model = CostModel::new();
1178
1179 let cardinalities = vec![10000.0, 10000.0, 10000.0];
1181 let output = 1000.0;
1182
1183 let leapfrog_cost = model.leapfrog_join_cost(3, &cardinalities, output);
1184
1185 assert!(leapfrog_cost.cpu > 0.0);
1187 assert!(leapfrog_cost.memory > 0.0);
1188
1189 let _prefer = model.prefer_leapfrog_join(3, &cardinalities, output);
1192 }
1194
1195 #[test]
1196 fn test_prefer_leapfrog_join_binary_case() {
1197 let model = CostModel::new();
1198
1199 let cardinalities = vec![1000.0, 1000.0];
1201 let prefer = model.prefer_leapfrog_join(2, &cardinalities, 500.0);
1202 assert!(!prefer, "Binary joins should use hash join, not leapfrog");
1203 }
1204
1205 #[test]
1206 fn test_factorized_benefit_single_hop() {
1207 let model = CostModel::new();
1208
1209 let benefit = model.factorized_benefit(10.0, 1);
1211 assert!(
1212 (benefit - 1.0).abs() < 0.001,
1213 "Single hop should have no benefit"
1214 );
1215 }
1216
1217 #[test]
1218 fn test_factorized_benefit_multi_hop() {
1219 let model = CostModel::new();
1220
1221 let benefit = model.factorized_benefit(10.0, 3);
1223
1224 assert!(benefit <= 1.0, "Benefit should be <= 1.0");
1228 assert!(benefit > 0.0, "Benefit should be positive");
1229 }
1230
1231 #[test]
1232 fn test_factorized_benefit_low_fanout() {
1233 let model = CostModel::new();
1234
1235 let benefit = model.factorized_benefit(1.5, 2);
1237 assert!(
1238 benefit <= 1.0,
1239 "Low fanout still benefits from factorization"
1240 );
1241 }
1242
1243 #[test]
1244 fn test_node_scan_uses_label_cardinality_for_io() {
1245 let mut label_cards = std::collections::HashMap::new();
1246 label_cards.insert("Person".to_string(), 500_u64);
1247 label_cards.insert("Company".to_string(), 50_u64);
1248
1249 let model = CostModel::new()
1250 .with_label_cardinalities(label_cards)
1251 .with_graph_totals(550, 1000);
1252
1253 let person_scan = NodeScanOp {
1254 variable: "n".to_string(),
1255 label: Some("Person".to_string()),
1256 input: None,
1257 };
1258 let company_scan = NodeScanOp {
1259 variable: "n".to_string(),
1260 label: Some("Company".to_string()),
1261 input: None,
1262 };
1263
1264 let person_cost = model.node_scan_cost(&person_scan, 500.0);
1265 let company_cost = model.node_scan_cost(&company_scan, 50.0);
1266
1267 assert!(
1269 person_cost.io > company_cost.io * 5.0,
1270 "Person ({}) should have much higher IO than Company ({})",
1271 person_cost.io,
1272 company_cost.io
1273 );
1274 }
1275
1276 #[test]
1277 fn test_node_scan_unlabeled_uses_total_nodes() {
1278 let model = CostModel::new().with_graph_totals(10_000, 50_000);
1279
1280 let scan = NodeScanOp {
1281 variable: "n".to_string(),
1282 label: None,
1283 input: None,
1284 };
1285
1286 let cost = model.node_scan_cost(&scan, 10_000.0);
1287 let expected_pages = (10_000.0 * 100.0) / 8192.0;
1288 assert!(
1289 (cost.io - expected_pages).abs() < 0.1,
1290 "Unlabeled scan should use total_nodes for IO: got {}, expected {}",
1291 cost.io,
1292 expected_pages
1293 );
1294 }
1295
1296 #[test]
1297 fn test_join_cost_with_actual_child_cardinalities() {
1298 let model = CostModel::new();
1299 let join = JoinOp {
1300 left: Box::new(LogicalOperator::Empty),
1301 right: Box::new(LogicalOperator::Empty),
1302 join_type: JoinType::Inner,
1303 conditions: vec![JoinCondition {
1304 left: LogicalExpression::Variable("a".to_string()),
1305 right: LogicalExpression::Variable("b".to_string()),
1306 }],
1307 };
1308
1309 let cost_actual = model.join_cost_with_children(&join, 500.0, Some(100.0), Some(10_000.0));
1311
1312 let cost_sqrt = model.join_cost(&join, 500.0);
1314
1315 assert!(
1319 cost_actual.cpu > cost_sqrt.cpu,
1320 "Actual child cardinalities ({}) should produce different cost than sqrt fallback ({})",
1321 cost_actual.cpu,
1322 cost_sqrt.cpu
1323 );
1324 }
1325
1326 #[test]
1327 fn test_expand_multi_edge_types() {
1328 let mut degrees = std::collections::HashMap::new();
1329 degrees.insert("KNOWS".to_string(), (5.0, 5.0));
1330 degrees.insert("FOLLOWS".to_string(), (20.0, 100.0));
1331
1332 let model = CostModel::new().with_edge_type_degrees(degrees);
1333
1334 let multi_expand = ExpandOp {
1336 from_variable: "a".to_string(),
1337 to_variable: "b".to_string(),
1338 edge_variable: None,
1339 direction: ExpandDirection::Outgoing,
1340 edge_types: vec!["KNOWS".to_string(), "FOLLOWS".to_string()],
1341 min_hops: 1,
1342 max_hops: Some(1),
1343 input: Box::new(LogicalOperator::Empty),
1344 path_alias: None,
1345 path_mode: PathMode::Walk,
1346 };
1347 let multi_cost = model.expand_cost(&multi_expand, 100.0);
1348
1349 let single_expand = ExpandOp {
1351 from_variable: "a".to_string(),
1352 to_variable: "b".to_string(),
1353 edge_variable: None,
1354 direction: ExpandDirection::Outgoing,
1355 edge_types: vec!["KNOWS".to_string()],
1356 min_hops: 1,
1357 max_hops: Some(1),
1358 input: Box::new(LogicalOperator::Empty),
1359 path_alias: None,
1360 path_mode: PathMode::Walk,
1361 };
1362 let single_cost = model.expand_cost(&single_expand, 100.0);
1363
1364 assert!(
1366 multi_cost.cpu > single_cost.cpu * 3.0,
1367 "Multi-type fanout ({}) should be much higher than single-type ({})",
1368 multi_cost.cpu,
1369 single_cost.cpu
1370 );
1371 }
1372
1373 #[test]
1374 fn test_recursive_tree_cost() {
1375 use crate::query::optimizer::CardinalityEstimator;
1376
1377 let mut label_cards = std::collections::HashMap::new();
1378 label_cards.insert("Person".to_string(), 1000_u64);
1379
1380 let model = CostModel::new()
1381 .with_label_cardinalities(label_cards)
1382 .with_graph_totals(1000, 5000)
1383 .with_avg_fanout(5.0);
1384
1385 let mut card_est = CardinalityEstimator::new();
1386 card_est.add_table_stats("Person", crate::query::optimizer::TableStats::new(1000));
1387
1388 let plan = LogicalOperator::Return(ReturnOp {
1390 items: vec![ReturnItem {
1391 expression: LogicalExpression::Variable("n".to_string()),
1392 alias: None,
1393 }],
1394 distinct: false,
1395 input: Box::new(LogicalOperator::Filter(FilterOp {
1396 predicate: LogicalExpression::Binary {
1397 left: Box::new(LogicalExpression::Property {
1398 variable: "n".to_string(),
1399 property: "age".to_string(),
1400 }),
1401 op: crate::query::plan::BinaryOp::Gt,
1402 right: Box::new(LogicalExpression::Literal(
1403 grafeo_common::types::Value::Int64(30),
1404 )),
1405 },
1406 input: Box::new(LogicalOperator::NodeScan(NodeScanOp {
1407 variable: "n".to_string(),
1408 label: Some("Person".to_string()),
1409 input: None,
1410 })),
1411 pushdown_hint: None,
1412 })),
1413 });
1414
1415 let tree_cost = model.estimate_tree(&plan, &card_est);
1416
1417 assert!(tree_cost.cpu > 0.0, "Tree should have CPU cost");
1419 assert!(tree_cost.io > 0.0, "Tree should have IO cost from scan");
1420
1421 let root_only_card = card_est.estimate(&plan);
1423 let root_only_cost = model.estimate(&plan, root_only_card);
1424
1425 assert!(
1427 tree_cost.total() > root_only_cost.total(),
1428 "Recursive tree cost ({}) should exceed root-only cost ({})",
1429 tree_cost.total(),
1430 root_only_cost.total()
1431 );
1432 }
1433
1434 #[test]
1435 fn test_statistics_driven_vs_default_cost() {
1436 let default_model = CostModel::new();
1437
1438 let mut label_cards = std::collections::HashMap::new();
1439 label_cards.insert("Person".to_string(), 100_u64);
1440 let stats_model = CostModel::new()
1441 .with_label_cardinalities(label_cards)
1442 .with_graph_totals(100, 500);
1443
1444 let scan = NodeScanOp {
1446 variable: "n".to_string(),
1447 label: Some("Person".to_string()),
1448 input: None,
1449 };
1450
1451 let default_cost = default_model.node_scan_cost(&scan, 100.0);
1452 let stats_cost = stats_model.node_scan_cost(&scan, 100.0);
1453
1454 assert!(
1458 (default_cost.io - stats_cost.io).abs() < 0.1,
1459 "When cardinality matches label size, costs should be similar"
1460 );
1461 }
1462}