facet-format 0.44.6

Core Serializer/Deserializer traits for facet's next-generation format architecture with JIT compilation support
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
use cranelift::codegen::ir::{AbiParam, SigRef};
use cranelift::prelude::*;
use cranelift_jit::JITModule;
use cranelift_module::{FuncId, Linkage, Module};

use facet_core::{Shape, Type, UserType};

use super::super::format::{JitCursor, JitFormat, make_c_sig};
use super::super::helpers;
use super::super::jit_debug;
use super::{PositionalFieldKind, ShapeMemo, T2_ERR_UNSUPPORTED, classify_positional_field};

/// Helper to emit scalar field parsing with error handling and storage for enum variants.
///
/// Similar to the struct helper, but handles enum-specific block sealing requirements.
/// Returns the success block that subsequent code should continue from.
#[allow(clippy::too_many_arguments)]
fn emit_parse_and_store_scalar_for_enum<F: JitFormat>(
    format: &F,
    module: &mut JITModule,
    builder: &mut FunctionBuilder,
    cursor: &mut JitCursor,
    field_kind: &PositionalFieldKind,
    dest_ptr: Value,
    err_var: Variable,
    error_block: Block,
    conditional_seal_block: Option<Block>,
    seal_store_block: bool,
    write_string_sig_ref: SigRef,
    write_string_ptr: Value,
) -> Option<Block> {
    let pointer_type = cursor.ptr_type;

    match field_kind {
        PositionalFieldKind::Bool => {
            let (val, err) = format.emit_parse_bool(module, builder, cursor);
            builder.def_var(err_var, err);
            let ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
            let store = builder.create_block();
            builder.ins().brif(ok, store, &[], error_block, &[]);
            if let Some(block) = conditional_seal_block {
                builder.seal_block(block);
            }
            builder.switch_to_block(store);
            if seal_store_block {
                builder.seal_block(store);
            }
            builder.ins().store(MemFlags::trusted(), val, dest_ptr, 0);
            Some(store)
        }
        PositionalFieldKind::U8 => {
            let (val, err) = format.emit_parse_u8(module, builder, cursor);
            builder.def_var(err_var, err);
            let ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
            let store = builder.create_block();
            builder.ins().brif(ok, store, &[], error_block, &[]);
            if let Some(block) = conditional_seal_block {
                builder.seal_block(block);
            }
            builder.switch_to_block(store);
            if seal_store_block {
                builder.seal_block(store);
            }
            builder.ins().store(MemFlags::trusted(), val, dest_ptr, 0);
            Some(store)
        }
        PositionalFieldKind::I8 => {
            let (val_i64, err) = format.emit_parse_i64(module, builder, cursor);
            builder.def_var(err_var, err);
            let ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
            let store = builder.create_block();
            builder.ins().brif(ok, store, &[], error_block, &[]);
            if let Some(block) = conditional_seal_block {
                builder.seal_block(block);
            }
            builder.switch_to_block(store);
            if seal_store_block {
                builder.seal_block(store);
            }
            let val = builder.ins().ireduce(types::I8, val_i64);
            builder.ins().store(MemFlags::trusted(), val, dest_ptr, 0);
            Some(store)
        }
        PositionalFieldKind::I64(scalar_type) => {
            use facet_core::ScalarType;
            let (val_i64, err) = format.emit_parse_i64(module, builder, cursor);
            builder.def_var(err_var, err);
            let ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
            let store = builder.create_block();
            builder.ins().brif(ok, store, &[], error_block, &[]);
            if let Some(block) = conditional_seal_block {
                builder.seal_block(block);
            }
            builder.switch_to_block(store);
            if seal_store_block {
                builder.seal_block(store);
            }
            let val = match scalar_type {
                ScalarType::I8 => builder.ins().ireduce(types::I8, val_i64),
                ScalarType::I16 => builder.ins().ireduce(types::I16, val_i64),
                ScalarType::I32 => builder.ins().ireduce(types::I32, val_i64),
                _ => val_i64,
            };
            builder.ins().store(MemFlags::trusted(), val, dest_ptr, 0);
            Some(store)
        }
        PositionalFieldKind::U64(scalar_type) => {
            use facet_core::ScalarType;
            let (val_u64, err) = format.emit_parse_u64(module, builder, cursor);
            builder.def_var(err_var, err);
            let ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
            let store = builder.create_block();
            builder.ins().brif(ok, store, &[], error_block, &[]);
            if let Some(block) = conditional_seal_block {
                builder.seal_block(block);
            }
            builder.switch_to_block(store);
            if seal_store_block {
                builder.seal_block(store);
            }
            let val = match scalar_type {
                ScalarType::U16 => builder.ins().ireduce(types::I16, val_u64),
                ScalarType::U32 => builder.ins().ireduce(types::I32, val_u64),
                _ => val_u64,
            };
            builder.ins().store(MemFlags::trusted(), val, dest_ptr, 0);
            Some(store)
        }
        PositionalFieldKind::F32 => {
            let (val_f32, err) = format.emit_parse_f32(module, builder, cursor);
            builder.def_var(err_var, err);
            let ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
            let store = builder.create_block();
            builder.ins().brif(ok, store, &[], error_block, &[]);
            if let Some(block) = conditional_seal_block {
                builder.seal_block(block);
            }
            builder.switch_to_block(store);
            if seal_store_block {
                builder.seal_block(store);
            }
            builder
                .ins()
                .store(MemFlags::trusted(), val_f32, dest_ptr, 0);
            Some(store)
        }
        PositionalFieldKind::F64 => {
            let (val_f64, err) = format.emit_parse_f64(module, builder, cursor);
            builder.def_var(err_var, err);
            let ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
            let store = builder.create_block();
            builder.ins().brif(ok, store, &[], error_block, &[]);
            if let Some(block) = conditional_seal_block {
                builder.seal_block(block);
            }
            builder.switch_to_block(store);
            if seal_store_block {
                builder.seal_block(store);
            }
            builder
                .ins()
                .store(MemFlags::trusted(), val_f64, dest_ptr, 0);
            Some(store)
        }
        PositionalFieldKind::String => {
            let (string_value, err) = format.emit_parse_string(module, builder, cursor);
            builder.def_var(err_var, err);
            let ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
            let store = builder.create_block();
            builder.ins().brif(ok, store, &[], error_block, &[]);
            if let Some(block) = conditional_seal_block {
                builder.seal_block(block);
            }
            builder.switch_to_block(store);
            if seal_store_block {
                builder.seal_block(store);
            }
            let zero_offset = builder.ins().iconst(pointer_type, 0);
            builder.ins().call_indirect(
                write_string_sig_ref,
                write_string_ptr,
                &[
                    dest_ptr,
                    zero_offset,
                    string_value.ptr,
                    string_value.len,
                    string_value.cap,
                    string_value.owned,
                ],
            );
            Some(store)
        }
        _ => None, // Non-scalar types not supported by this helper
    }
}

/// Compile a top-level enum deserializer for positional formats (e.g., postcard).
///
/// Positional enums:
/// - Discriminant encoded as varint (u64)
/// - Followed immediately by variant data fields
/// - No map/object wrapper (unlike JSON format)
///
/// This function generates code to:
/// 1. Parse discriminant from input stream
/// 2. Dispatch to correct variant handler
/// 3. Store discriminant to output memory
/// 4. Parse variant payload fields
///
/// Returns `Some(FuncId)` if compilation succeeds, `None` if the enum is incompatible.
pub(crate) fn compile_enum_positional_deserializer<F: JitFormat>(
    module: &mut JITModule,
    shape: &'static Shape,
    memo: &mut ShapeMemo,
) -> Option<FuncId> {
    jit_debug!("compile_enum_positional_deserializer ENTRY");

    // Check memo first - return cached FuncId if already compiled
    let shape_ptr = shape as *const Shape;
    if let Some(&func_id) = memo.get(&shape_ptr) {
        jit_debug!(
            "compile_enum_positional_deserializer: using memoized FuncId for shape {:p}",
            shape
        );
        return Some(func_id);
    }

    // Extract enum definition from shape
    let Type::User(UserType::Enum(enum_def)) = &shape.ty else {
        jit_debug!("Shape is not an enum");
        return None;
    };

    jit_debug!(
        "Compiling positional enum with {} variants",
        enum_def.variants.len()
    );

    let pointer_type = module.target_config().pointer_type();

    // Function signature: fn(input_ptr, len, pos, out, scratch) -> isize
    // Same as struct deserializer - returns new position or -1 on error
    let mut sig = make_c_sig(module);
    sig.params.push(AbiParam::new(pointer_type)); // input_ptr
    sig.params.push(AbiParam::new(pointer_type)); // len
    sig.params.push(AbiParam::new(pointer_type)); // pos
    sig.params.push(AbiParam::new(pointer_type)); // out (where to write enum)
    sig.params.push(AbiParam::new(pointer_type)); // scratch (for error messages)
    sig.returns.push(AbiParam::new(pointer_type)); // new_pos or -1 on error

    // Create unique function name based on shape address
    let func_name = format!(
        "jit_deserialize_positional_enum_{:x}",
        shape as *const _ as usize
    );

    let func_id = match module.declare_function(&func_name, Linkage::Export, &sig) {
        Ok(id) => id,
        Err(e) => {
            jit_debug!("declare_function('{}') failed: {:?}", func_name, e);
            return None;
        }
    };

    // Insert into memo immediately to handle recursive types
    memo.insert(shape_ptr, func_id);
    jit_debug!("Function declared, starting IR generation");

    let mut ctx = module.make_context();
    ctx.func.signature = sig;

    let mut builder_ctx = FunctionBuilderContext::new();
    {
        let mut builder = FunctionBuilder::new(&mut ctx.func, &mut builder_ctx);

        // Create entry block
        let entry_block = builder.create_block();
        builder.append_block_params_for_function_params(entry_block);
        builder.switch_to_block(entry_block);
        builder.seal_block(entry_block);

        // Extract function parameters
        let params = builder.block_params(entry_block);
        let input_ptr = params[0];
        let len = params[1];
        let initial_pos = params[2];
        let out_ptr = params[3];
        let _scratch_ptr = params[4]; // Reserved for error messages

        // Create variables for position tracking and error handling
        let pos_var = builder.declare_var(pointer_type);
        let err_var = builder.declare_var(types::I32);
        builder.def_var(pos_var, initial_pos);
        let zero_err = builder.ins().iconst(types::I32, 0);
        builder.def_var(err_var, zero_err);

        // Create error block (returns -1 on error)
        let error = builder.create_block();

        // Create format instance for parsing
        let format = F::default();

        // Step 1: Parse discriminant as varint (u64)
        let mut cursor = JitCursor {
            input_ptr,
            len,
            pos: pos_var,
            ptr_type: pointer_type,
            scratch_ptr: _scratch_ptr,
        };

        let (discriminant, err) = format.emit_parse_u64(module, &mut builder, &mut cursor);
        builder.def_var(err_var, err);
        let is_ok = builder.ins().icmp_imm(IntCC::Equal, err, 0);
        let disc_ok_block = builder.create_block();
        builder.ins().brif(is_ok, disc_ok_block, &[], error, &[]);

        builder.switch_to_block(disc_ok_block);

        // Step 2: Create blocks for variant dispatch
        let mut variant_blocks: Vec<_> = (0..enum_def.variants.len())
            .map(|_| builder.create_block())
            .collect();
        let invalid_discriminant_block = builder.create_block();
        let after_variant_block = builder.create_block();

        // Step 3: Dispatch on discriminant using if-then-else chain
        let mut current_check_block = disc_ok_block;
        for (i, variant) in enum_def.variants.iter().enumerate() {
            let disc_val = match variant.discriminant {
                Some(v) => v as u64,
                None => {
                    jit_debug!("Variant '{}' has no discriminant value", variant.name);
                    return None;
                }
            };

            let matches = builder
                .ins()
                .icmp_imm(IntCC::Equal, discriminant, disc_val as i64);

            let next_check_block = if i < enum_def.variants.len() - 1 {
                builder.create_block()
            } else {
                invalid_discriminant_block
            };

            builder
                .ins()
                .brif(matches, variant_blocks[i], &[], next_check_block, &[]);
            builder.seal_block(current_check_block);

            if i < enum_def.variants.len() - 1 {
                builder.switch_to_block(next_check_block);
                current_check_block = next_check_block;
            }
        }

        // Step 4: Generate code for each variant
        for (i, variant) in enum_def.variants.iter().enumerate() {
            builder.switch_to_block(variant_blocks[i]);

            // Store discriminant to output memory (at base of enum)
            let disc_val = variant.discriminant.unwrap();
            match enum_def.enum_repr {
                facet_core::EnumRepr::U8 | facet_core::EnumRepr::I8 => {
                    let disc_i8 = builder.ins().iconst(types::I8, disc_val);
                    builder
                        .ins()
                        .store(MemFlags::trusted(), disc_i8, out_ptr, 0);
                }
                facet_core::EnumRepr::U16 | facet_core::EnumRepr::I16 => {
                    let disc_i16 = builder.ins().iconst(types::I16, disc_val);
                    builder
                        .ins()
                        .store(MemFlags::trusted(), disc_i16, out_ptr, 0);
                }
                facet_core::EnumRepr::U32 | facet_core::EnumRepr::I32 => {
                    let disc_i32 = builder.ins().iconst(types::I32, disc_val);
                    builder
                        .ins()
                        .store(MemFlags::trusted(), disc_i32, out_ptr, 0);
                }
                facet_core::EnumRepr::U64
                | facet_core::EnumRepr::I64
                | facet_core::EnumRepr::USize
                | facet_core::EnumRepr::ISize => {
                    let disc_i64 = builder.ins().iconst(types::I64, disc_val);
                    builder
                        .ins()
                        .store(MemFlags::trusted(), disc_i64, out_ptr, 0);
                }
                facet_core::EnumRepr::Rust => {
                    jit_debug!(
                        "Variant '{}' uses default Rust repr (not supported)",
                        variant.name
                    );
                    return None;
                }
                facet_core::EnumRepr::RustNPO => {
                    jit_debug!(
                        "Variant '{}' uses RustNPO repr (not yet supported)",
                        variant.name
                    );
                    return None;
                }
            }

            // Parse variant data based on variant kind
            use facet_core::StructKind;
            match variant.data.kind {
                StructKind::Unit => {
                    // No data to parse for unit variants
                    builder.ins().jump(after_variant_block, &[]);
                    builder.seal_block(variant_blocks[i]);
                }
                StructKind::TupleStruct | StructKind::Struct | StructKind::Tuple => {
                    // Setup write_string helper for scalar parsing
                    let write_string_sig = {
                        let mut s = make_c_sig(module);
                        s.params.push(AbiParam::new(pointer_type)); // dest
                        s.params.push(AbiParam::new(pointer_type)); // offset
                        s.params.push(AbiParam::new(pointer_type)); // ptr
                        s.params.push(AbiParam::new(pointer_type)); // len
                        s.params.push(AbiParam::new(pointer_type)); // cap
                        s.params.push(AbiParam::new(types::I8)); // owned
                        s
                    };
                    let write_string_sig_ref = builder.import_signature(write_string_sig);
                    let write_string_ptr = builder
                        .ins()
                        .iconst(pointer_type, helpers::jit_write_string as *const u8 as i64);

                    // Parse each field in the variant's data
                    let mut sealed_initial = false;
                    for field in variant.data.fields {
                        let field_shape = field.shape.get();
                        let field_kind = classify_positional_field(field_shape)?;

                        // Calculate absolute pointer to this field
                        let field_offset = builder.ins().iconst(pointer_type, field.offset as i64);
                        let variant_field_ptr = builder.ins().iadd(out_ptr, field_offset);

                        // Parse based on field kind using helper for scalar types
                        if let Some(store_block) = emit_parse_and_store_scalar_for_enum(
                            &format,
                            module,
                            &mut builder,
                            &mut cursor,
                            &field_kind,
                            variant_field_ptr,
                            err_var,
                            error,
                            if !sealed_initial {
                                Some(variant_blocks[i])
                            } else {
                                None
                            },
                            true, // seal_store_block
                            write_string_sig_ref,
                            write_string_ptr,
                        ) {
                            variant_blocks[i] = store_block;
                            sealed_initial = true;
                        } else {
                            // Complex types not yet supported in enum variants
                            jit_debug!(
                                "Variant '{}' field '{}' has complex type (not yet supported for top-level enum variants)",
                                variant.name,
                                field.name
                            );
                            return None;
                        }
                    }

                    builder.ins().jump(after_variant_block, &[]);
                }
            }
        }

        // Invalid discriminant error block
        builder.switch_to_block(invalid_discriminant_block);
        builder.seal_block(invalid_discriminant_block);
        let invalid_err = builder.ins().iconst(types::I32, T2_ERR_UNSUPPORTED as i64);
        builder.def_var(err_var, invalid_err);
        builder.ins().jump(error, &[]);

        // After variant block - success path
        builder.switch_to_block(after_variant_block);
        builder.seal_block(after_variant_block);
        let final_pos = builder.use_var(pos_var);
        builder.ins().return_(&[final_pos]);

        // Error block - return -1
        builder.switch_to_block(error);
        builder.seal_block(error);
        let minus_one = builder.ins().iconst(pointer_type, -1);
        builder.ins().return_(&[minus_one]);

        builder.finalize();
    }

    // Define the function in the module
    if let Err(e) = module.define_function(func_id, &mut ctx) {
        jit_debug!("define_function failed: {:?}", e);
        return None;
    }

    jit_debug!("compile_enum_positional_deserializer SUCCESS");
    Some(func_id)
}