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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

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::CustomFunctionId;
use crate::plan::execution::graph::{
    CustomFunctionLocal, CustomListLocalId, CustomLocal, ParamLocal, TupleLocalId,
};
use crate::plan::execution::type_::CustomConstructorId;

pub(crate) enum CustomInstruction {
    Construct {
        constructor: CustomConstructorId,
        fields: Box<[ParamLocal]>,
    },
    Constant(ConstantId<CustomLocal>),
    Call {
        function: CustomFunctionId,
        args: Box<[ParamLocal]>,
        site: crate::plan::HostCallSite,
    },
    FunctionCall {
        function: CustomFunctionLocal,
        args: Box<[ParamLocal]>,
        site: crate::plan::HostCallSite,
    },
    TupleIndex {
        tuple: TupleLocalId,
        index: usize,
    },
    CustomField {
        source: CustomLocal,
        index: usize,
    },
    ListIndex {
        list: CustomListLocalId,
        index: usize,
    },
}

impl Explain for CustomInstruction {
    fn write_explanation(&self, context: &mut ExplainContext<'_, '_>) {
        let output = context.output();
        match self {
            CustomInstruction::Construct {
                constructor,
                fields,
            } => {
                output.push_str("custom.construct custom_type#");
                output.push_str(&constructor.type_id().index().to_string());
                output.push_str(".constructor#");
                output.push_str(&constructor.index().to_string());
                output.push_str(" fields=");
                write_local_labels(output, fields);
            }
            CustomInstruction::Constant(id) => write_constant(output, "custom", *id),
            CustomInstruction::Call { function, args, .. } => {
                write_call(output, "custom.call", function, args);
            }
            CustomInstruction::FunctionCall { function, args, .. } => {
                write_function_call(output, "custom.function_call", function, args);
            }
            CustomInstruction::TupleIndex { tuple, index } => {
                write_projection(output, "custom.tuple_index", tuple, *index);
            }
            CustomInstruction::CustomField { source, index } => {
                write_projection(output, "custom.custom_field", source, *index);
            }
            CustomInstruction::ListIndex { list, index } => {
                write_projection(output, "custom.list_index", list, *index);
            }
        }
    }
}

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

    #[test]
    fn writes_custom_construction() {
        let source = r#"
pub type Boxed { Boxed(Int) }
pub fn main() { Boxed(1) }
"#;
        let expected = "custom.construct custom_type#0.constructor#0 fields=[%int#0]";

        assert_explanation(source, expected);
    }

    #[test]
    fn writes_custom_constants_calls_and_projections() {
        let source = r#"
pub type Boxed {
  Boxed(Int)
}

pub type Holder {
  Holder(value: Boxed)
}

const saved = Boxed(0)

fn custom_value(value: Boxed) { value }
fn custom_values(values: List(Boxed)) { values }

pub fn main() {
  let function = custom_value
  let values = custom_values([Boxed(1)])
  let selected = case values {
    [value, ..] -> value
    _ -> Boxed(2)
  }
  let tuple = #(Boxed(3))
  let holder = Holder(Boxed(4))
  let ignored = #(
    saved,
    custom_value(Boxed(5)),
    function(Boxed(6)),
    tuple.0,
    holder.value,
  )
  selected
}
"#;
        let expected = concat!(
            "custom.construct custom_type#0.constructor#0 fields=[%int#0] | ",
            "custom.list_index %list.custom#0 index=0 | ",
            "custom.construct custom_type#0.constructor#0 fields=[%int#0] | ",
            "custom.construct custom_type#0.constructor#0 fields=[%int#1] | ",
            "custom.construct custom_type#1.constructor#0 fields=[%custom#2] | ",
            "constant.custom#0 | ",
            "custom.construct custom_type#0.constructor#0 fields=[%int#2] | ",
            "custom.call custom#1 args=[%custom#5] | ",
            "custom.construct custom_type#0.constructor#0 fields=[%int#3] | ",
            "custom.function_call %function.custom#0 args=[%custom#7] | ",
            "custom.tuple_index %tuple#0 index=0 | ",
            "custom.custom_field %custom#3 index=0 | ",
            "custom.construct custom_type#0.constructor#0 fields=[%int#0]",
        );

        assert_explanation(source, expected);
    }

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