geam 0.1.1

Experimental Rust-embedded execution runtime for typed Gleam programs
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use super::super::super::value::write_local_labels;
use super::{write_call, write_constant, write_function_call, write_projection};
use crate::plan::execution::constant::ConstantId;
use crate::plan::execution::explain::{Explain, ExplainContext};
use crate::plan::execution::function::TupleFunctionId;
use crate::plan::execution::graph::{
    CustomLocal, ParamLocal, TupleFunctionLocalId, TupleListLocalId, TupleLocalId,
};

pub(crate) enum TupleInstruction {
    Value(Box<[ParamLocal]>),
    Constant(ConstantId<TupleLocalId>),
    Call {
        function: TupleFunctionId,
        args: Box<[ParamLocal]>,
        site: crate::plan::HostCallSite,
    },
    FunctionCall {
        function: TupleFunctionLocalId,
        args: Box<[ParamLocal]>,
        site: crate::plan::HostCallSite,
    },
    TupleIndex {
        tuple: TupleLocalId,
        index: usize,
    },
    CustomField {
        source: CustomLocal,
        index: usize,
    },
    ListIndex {
        list: TupleListLocalId,
        index: usize,
    },
}

impl Explain for TupleInstruction {
    fn write_explanation(&self, context: &mut ExplainContext<'_, '_>) {
        let output = context.output();
        match self {
            TupleInstruction::Value(elements) => {
                output.push_str("tuple.value elements=");
                write_local_labels(output, elements);
            }
            TupleInstruction::Constant(id) => write_constant(output, "tuple", *id),
            TupleInstruction::Call { function, args, .. } => {
                write_call(output, "tuple.call", function, args);
            }
            TupleInstruction::FunctionCall { function, args, .. } => {
                write_function_call(output, "tuple.function_call", function, args);
            }
            TupleInstruction::TupleIndex { tuple, index } => {
                write_projection(output, "tuple.tuple_index", tuple, *index);
            }
            TupleInstruction::CustomField { source, index } => {
                write_projection(output, "tuple.custom_field", source, *index);
            }
            TupleInstruction::ListIndex { list, index } => {
                write_projection(output, "tuple.list_index", list, *index);
            }
        }
    }
}

#[cfg(test)]
mod explain_tests {
    use crate::plan::execution::explain;
    use crate::plan::execution::function::TupleFunctionId;
    use crate::plan::execution::graph::ProfiledInstructionKind;

    #[test]
    fn writes_tuple_construction() {
        let source = "pub fn main() { #(1, True) }";
        let expected = "tuple.value elements=[%int#0, %bool#0]";

        assert_explanation(source, expected);
    }

    #[test]
    fn writes_tuple_constants_calls_and_projections() {
        let source = r#"
const saved = #(0)

pub type Holder {
  Holder(value: #(Int))
}

fn tuple_value(value: #(Int)) { value }
fn tuple_values(values: List(#(Int))) { values }

pub fn main() {
  let function = tuple_value
  let values = tuple_values([#(1)])
  let selected = case values {
    [value, ..] -> value
    _ -> #(2)
  }
  let nested = #(#(3))
  let holder = Holder(#(4))
  let ignored = #(
    saved,
    tuple_value(#(5)),
    function(#(6)),
    nested.0,
    holder.value,
  )
  selected
}
"#;
        let expected = concat!(
            "tuple.value elements=[%int#0] | tuple.list_index %list.tuple#0 index=0 | ",
            "tuple.value elements=[%int#0] | tuple.value elements=[%tuple#1] | ",
            "tuple.value elements=[%int#1] | constant.tuple#0 | ",
            "tuple.value elements=[%int#2] | tuple.call tuple#1 args=[%tuple#5] | ",
            "tuple.value elements=[%int#3] | ",
            "tuple.function_call %function.tuple#0 args=[%tuple#7] | ",
            "tuple.tuple_index %tuple#2 index=0 | tuple.custom_field %custom#0 index=0 | ",
            "tuple.value elements=[%tuple#4, %tuple#6, %tuple#8, %tuple#9, %tuple#10] | ",
            "tuple.value elements=[%int#0]",
        );

        assert_explanation(source, expected);
    }

    fn assert_explanation(source: &str, expected: &str) {
        explain::assert_rendered(source, expected, |plan, output| {
            let graph = plan.tuple_function(TupleFunctionId(0)).body().block_graph();
            let mut first = true;
            for instruction in graph.blocks().iter().flat_map(|block| block.instructions()) {
                if let ProfiledInstructionKind::Tuple(instruction) = instruction.kind() {
                    if first {
                        first = false;
                    } else {
                        output.push_str(" | ");
                    }
                    let mut context = explain::ExplainContext::new(plan, output);
                    context.write(instruction);
                }
            }
        });
    }
}