shape-jit 0.3.2

Tiered JIT compiler (Cranelift) for the Shape virtual machine
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
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242

//! Control Flow FFI Symbol Registration
//!
//! This module handles registration and declaration of control flow FFI symbols
//! for the JIT compiler, including function calls, iterations, and array operations.

use cranelift::prelude::*;
use cranelift_jit::JITBuilder;
use cranelift_jit::JITModule;
use cranelift_module::{FuncId, Linkage, Module};
use std::collections::HashMap;

use super::super::ffi::call_method::jit_call_method;
use super::super::ffi::control::{
    jit_call_foreign, jit_call_foreign_dynamic, jit_call_foreign_native, jit_call_foreign_native_0,
    jit_call_foreign_native_1, jit_call_foreign_native_2, jit_call_foreign_native_3,
    jit_call_foreign_native_4, jit_call_foreign_native_5, jit_call_foreign_native_6,
    jit_call_foreign_native_7, jit_call_foreign_native_8, jit_call_function, jit_call_value,
    jit_control_every, jit_control_filter, jit_control_find, jit_control_find_index,
    jit_control_fold, jit_control_foreach, jit_control_map, jit_control_reduce, jit_control_some,
};
use super::super::ffi::iterator::{jit_iter_done, jit_iter_next};

/// Register control flow FFI symbols with the JIT builder
pub fn register_control_symbols(builder: &mut JITBuilder) {
    builder.symbol("jit_call_function", jit_call_function as *const u8);
    builder.symbol("jit_call_value", jit_call_value as *const u8);
    builder.symbol("jit_call_foreign", jit_call_foreign as *const u8);
    builder.symbol(
        "jit_call_foreign_native",
        jit_call_foreign_native as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_dynamic",
        jit_call_foreign_dynamic as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_0",
        jit_call_foreign_native_0 as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_1",
        jit_call_foreign_native_1 as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_2",
        jit_call_foreign_native_2 as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_3",
        jit_call_foreign_native_3 as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_4",
        jit_call_foreign_native_4 as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_5",
        jit_call_foreign_native_5 as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_6",
        jit_call_foreign_native_6 as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_7",
        jit_call_foreign_native_7 as *const u8,
    );
    builder.symbol(
        "jit_call_foreign_native_8",
        jit_call_foreign_native_8 as *const u8,
    );
    builder.symbol("jit_iter_next", jit_iter_next as *const u8);
    builder.symbol("jit_iter_done", jit_iter_done as *const u8);
    builder.symbol("jit_call_method", jit_call_method as *const u8);
    builder.symbol("jit_control_fold", jit_control_fold as *const u8);
    builder.symbol("jit_control_reduce", jit_control_reduce as *const u8);
    builder.symbol("jit_control_map", jit_control_map as *const u8);
    builder.symbol("jit_control_filter", jit_control_filter as *const u8);
    builder.symbol("jit_control_foreach", jit_control_foreach as *const u8);
    builder.symbol("jit_control_find", jit_control_find as *const u8);
    builder.symbol(
        "jit_control_find_index",
        jit_control_find_index as *const u8,
    );
    builder.symbol("jit_control_some", jit_control_some as *const u8);
    builder.symbol("jit_control_every", jit_control_every as *const u8);
}

/// Declare control flow FFI function signatures in the module
pub fn declare_control_functions(module: &mut JITModule, ffi_funcs: &mut HashMap<String, FuncId>) {
    // jit_call_function(ctx: *mut JITContext, function_id: u16, args: *const u64, arg_count: usize) -> u64
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.params.push(AbiParam::new(types::I16)); // function_id (u16)
        sig.params.push(AbiParam::new(types::I64)); // args (deprecated, pass null)
        sig.params.push(AbiParam::new(types::I64)); // arg_count
        sig.returns.push(AbiParam::new(types::I64)); // result
        let func_id = module
            .declare_function("jit_call_function", Linkage::Import, &sig)
            .expect("Failed to declare jit_call_function");
        ffi_funcs.insert("jit_call_function".to_string(), func_id);
    }

    // jit_call_value(ctx: *mut JITContext) -> u64
    // Reads callee and args from ctx.stack
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.returns.push(AbiParam::new(types::I64)); // result
        let func_id = module
            .declare_function("jit_call_value", Linkage::Import, &sig)
            .expect("Failed to declare jit_call_value");
        ffi_funcs.insert("jit_call_value".to_string(), func_id);
    }

    // jit_call_foreign(ctx: *mut JITContext, foreign_idx: u32, arg_count: usize) -> u64
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.params.push(AbiParam::new(types::I32)); // foreign_idx
        sig.params.push(AbiParam::new(types::I64)); // arg_count
        sig.returns.push(AbiParam::new(types::I64)); // result
        let func_id = module
            .declare_function("jit_call_foreign", Linkage::Import, &sig)
            .expect("Failed to declare jit_call_foreign");
        ffi_funcs.insert("jit_call_foreign".to_string(), func_id);
    }

    // jit_call_foreign_native(ctx: *mut JITContext, foreign_idx: u32, arg_count: usize) -> u64
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.params.push(AbiParam::new(types::I32)); // foreign_idx
        sig.params.push(AbiParam::new(types::I64)); // arg_count
        sig.returns.push(AbiParam::new(types::I64)); // result
        let func_id = module
            .declare_function("jit_call_foreign_native", Linkage::Import, &sig)
            .expect("Failed to declare jit_call_foreign_native");
        ffi_funcs.insert("jit_call_foreign_native".to_string(), func_id);
    }

    // jit_call_foreign_dynamic(ctx: *mut JITContext, foreign_idx: u32, arg_count: usize) -> u64
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.params.push(AbiParam::new(types::I32)); // foreign_idx
        sig.params.push(AbiParam::new(types::I64)); // arg_count
        sig.returns.push(AbiParam::new(types::I64)); // result
        let func_id = module
            .declare_function("jit_call_foreign_dynamic", Linkage::Import, &sig)
            .expect("Failed to declare jit_call_foreign_dynamic");
        ffi_funcs.insert("jit_call_foreign_dynamic".to_string(), func_id);
    }

    // Arity-specialized native calls:
    // jit_call_foreign_native_N(ctx: *mut JITContext, foreign_idx: u32, arg0: u64, ... argN-1: u64) -> u64
    for arity in 0..=8usize {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.params.push(AbiParam::new(types::I32)); // foreign_idx
        for _ in 0..arity {
            sig.params.push(AbiParam::new(types::I64)); // arg_i (NaN-boxed)
        }
        sig.returns.push(AbiParam::new(types::I64)); // result
        let name = format!("jit_call_foreign_native_{arity}");
        let func_id = module
            .declare_function(&name, Linkage::Import, &sig)
            .unwrap_or_else(|_| panic!("Failed to declare {}", name));
        ffi_funcs.insert(name, func_id);
    }

    // jit_iter_next(arr_bits: u64, index: i64) -> u64
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // arr_bits
        sig.params.push(AbiParam::new(types::I64)); // index
        sig.returns.push(AbiParam::new(types::I64)); // result
        let func_id = module
            .declare_function("jit_iter_next", Linkage::Import, &sig)
            .expect("Failed to declare jit_iter_next");
        ffi_funcs.insert("jit_iter_next".to_string(), func_id);
    }

    // jit_iter_done(arr_bits: u64, index: i64) -> u64
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // arr_bits
        sig.params.push(AbiParam::new(types::I64)); // index
        sig.returns.push(AbiParam::new(types::I64)); // result
        let func_id = module
            .declare_function("jit_iter_done", Linkage::Import, &sig)
            .expect("Failed to declare jit_iter_done");
        ffi_funcs.insert("jit_iter_done".to_string(), func_id);
    }

    // jit_call_method(ctx: *mut JITContext, stack_count: usize) -> u64
    // Reads receiver, method_name, and args from ctx.stack
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.params.push(AbiParam::new(types::I64)); // stack_count
        sig.returns.push(AbiParam::new(types::I64)); // result
        let func_id = module
            .declare_function("jit_call_method", Linkage::Import, &sig)
            .expect("Failed to declare jit_call_method");
        ffi_funcs.insert("jit_call_method".to_string(), func_id);
    }

    // Control flow functions (ctx) -> u64
    // jit_control_fold, jit_control_reduce, jit_control_map, jit_control_filter, etc.
    for name in [
        "jit_control_fold",
        "jit_control_reduce",
        "jit_control_map",
        "jit_control_filter",
        "jit_control_find",
        "jit_control_find_index",
        "jit_control_some",
        "jit_control_every",
    ] {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.returns.push(AbiParam::new(types::I64));
        let func_id = module
            .declare_function(name, Linkage::Import, &sig)
            .unwrap_or_else(|_| panic!("Failed to declare {}", name));
        ffi_funcs.insert(name.to_string(), func_id);
    }

    // jit_control_foreach(ctx, count) -> u64
    {
        let mut sig = module.make_signature();
        sig.params.push(AbiParam::new(types::I64)); // ctx
        sig.params.push(AbiParam::new(types::I64)); // count
        sig.returns.push(AbiParam::new(types::I64));
        let func_id = module
            .declare_function("jit_control_foreach", Linkage::Import, &sig)
            .expect("Failed to declare jit_control_foreach");
        ffi_funcs.insert("jit_control_foreach".to_string(), func_id);
    }
}