wirm 3.0.1

A lightweight WebAssembly Transformation Library for the Component Model
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

use crate::ir::types::{Instructions, InstrumentationMode};
use std::panic::{catch_unwind, UnwindSafe};
use wasmparser::{BlockType, Operator};

#[test]
fn test_block_alt_unsupported_ops() {
    run_check_panics(
        NON_SPECIAL_OPERATORS,
        InstrumentationMode::BlockAlt,
        "block alternate",
    );
    run_check_panics(
        BRANCHING_OPERATORS,
        InstrumentationMode::BlockAlt,
        "block alternate",
    );
}
#[test]
fn test_block_alt_supported_ops() {
    run_check_works(BLOCK_STYLE_OPERATORS, InstrumentationMode::BlockAlt);
}

#[test]
fn test_block_entry_unsupported_ops() {
    run_check_panics(
        NON_SPECIAL_OPERATORS,
        InstrumentationMode::BlockEntry,
        "block entry",
    );
    run_check_panics(
        BRANCHING_OPERATORS,
        InstrumentationMode::BlockEntry,
        "block entry",
    );
}
#[test]
fn test_block_entry_supported_ops() {
    run_check_works(BLOCK_STYLE_OPERATORS, InstrumentationMode::BlockEntry);
}

#[test]
fn test_block_exit_unsupported_ops() {
    run_check_panics(
        NON_SPECIAL_OPERATORS,
        InstrumentationMode::BlockExit,
        "block exit",
    );
    run_check_panics(
        BRANCHING_OPERATORS,
        InstrumentationMode::BlockExit,
        "block exit",
    );
}
#[test]
fn test_block_exit_supported_ops() {
    run_check_works(BLOCK_STYLE_OPERATORS, InstrumentationMode::BlockExit);
}

#[test]
fn test_semantic_after_unsupported_ops() {
    run_check_panics(
        NON_SPECIAL_OPERATORS,
        InstrumentationMode::SemanticAfter,
        "semantic after",
    );
}
#[test]
fn test_semantic_after_supported_ops() {
    run_check_works(BLOCK_STYLE_OPERATORS, InstrumentationMode::SemanticAfter);
    run_check_works(BRANCHING_OPERATORS, InstrumentationMode::SemanticAfter);
}

// ==== HELPER FUNCTIONS ====

pub fn run_check_works(operators: &[Operator], mode: InstrumentationMode) {
    for op in operators {
        assert!(check_instr_op(op, mode));
    }
}

pub fn run_check_panics(operators: &[Operator], mode: InstrumentationMode, mode_name: &str) {
    for op in operators {
        let str = format!(
            "Cannot apply {mode_name} instrumentation mode to op type: {:?}",
            op
        );
        assert_panics_with_message(
            || {
                check_instr_op(op, mode);
            },
            str.as_str(),
        )
    }
}

pub fn assert_panics_with_message(func: impl FnOnce() + UnwindSafe, msg: &str) {
    let err = catch_unwind(func).expect_err("Didn't panic!");

    let chk = |panic_msg: &'_ str| {
        if !panic_msg.contains(msg) {
            panic!(
                "Expected a panic message containing `{}`; got: `{}`.",
                msg, panic_msg
            );
        }
    };

    err.downcast::<String>()
        .map(|s| chk(&s))
        .or_else(|err| err.downcast::<&str>().map(|s| chk(*s)))
        .expect("Unexpected panic type!");
}

fn check_instr_op(op: &Operator, mode: InstrumentationMode) -> bool {
    let mut instr = Instructions::new(vec![(op.clone(), 0)], 0, false);
    instr.set_current_mode(0, mode);
    instr.add_instr(0, Operator::Nop); // should OR should not panic!
    true
}

// non-exhaustive
const NON_SPECIAL_OPERATORS: &[Operator] = &[
    Operator::Unreachable,
    Operator::Nop,
    Operator::Throw { tag_index: 0 },
    Operator::End,
    Operator::Return,
    Operator::Call { function_index: 0 },
    Operator::CallIndirect {
        type_index: 0,
        table_index: 0,
    },
];

const BRANCHING_OPERATORS: &[Operator] = &[
    Operator::Br { relative_depth: 0 },
    Operator::BrIf { relative_depth: 0 },
    // Operator::BrTable { targets: BrTable } // todo unsure how to do this init logic
    // Operator::BrOnCast {
    //     relative_depth: 0,
    //     from_ref_type: (),
    //     to_ref_type: (),
    // },
    // Operator::BrOnCastFail {
    //     relative_depth: 0,
    //     from_ref_type: (),
    //     to_ref_type: (),
    // },
    Operator::BrOnNull { relative_depth: 0 },
    Operator::BrOnNonNull { relative_depth: 0 },
];

const BLOCK_STYLE_OPERATORS: &[Operator] = &[
    Operator::Block {
        blockty: BlockType::Empty,
    },
    Operator::Loop {
        blockty: BlockType::Empty,
    },
    Operator::If {
        blockty: BlockType::Empty,
    },
    Operator::Else,
];