celox 0.4.1

Celox HDL Simulator
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

pub mod veryl_sim;
pub mod veryl_sv;

#[path = "../fixtures/veryl_std.rs"]
#[allow(dead_code)]
pub mod veryl_std;

/// Generates native, cranelift, wasm, interpreter, and Veryl reference tests,
/// plus an SV frontend test when the `systemverilog` feature is enabled.
///
/// The `interp` arm calls `build_interpreter()`, which executes every
/// execution unit on the Tier-0 SIR interpreter against the same memory
/// image ABI as the compiled backends.
///
/// ```rust
/// all_backends! {
///     fn test_a(sim) {
///         @build Simulator::builder(r#"..."#, "Top");
///         assert_eq!(sim.get(sim.signal("o")), 1u8.into());
///     }
/// }
/// ```
macro_rules! all_backends {
    // ── internal: add #[ignore] when a backend is in the ignore list ──
    (@with_ignore native; (); { $($item:tt)* }) => { $($item)* };
    (@with_ignore native; (native $(, $rest:ident)*); { $($item:tt)* }) => {
        #[ignore]
        $($item)*
    };
    (@with_ignore native; ($first:ident $(, $rest:ident)*); { $($item:tt)* }) => {
        all_backends!(@with_ignore native; ($($rest),*); { $($item)* });
    };

    (@with_ignore cranelift; (); { $($item:tt)* }) => { $($item)* };
    (@with_ignore cranelift; (cranelift $(, $rest:ident)*); { $($item:tt)* }) => {
        #[ignore]
        $($item)*
    };
    (@with_ignore cranelift; ($first:ident $(, $rest:ident)*); { $($item:tt)* }) => {
        all_backends!(@with_ignore cranelift; ($($rest),*); { $($item)* });
    };

    (@with_ignore wasm; (); { $($item:tt)* }) => { $($item)* };
    (@with_ignore wasm; (wasm $(, $rest:ident)*); { $($item:tt)* }) => {
        #[ignore]
        $($item)*
    };
    (@with_ignore wasm; ($first:ident $(, $rest:ident)*); { $($item:tt)* }) => {
        all_backends!(@with_ignore wasm; ($($rest),*); { $($item)* });
    };

    (@with_ignore sv; (); { $($item:tt)* }) => { $($item)* };
    (@with_ignore sv; (sv $(, $rest:ident)*); { $($item:tt)* }) => {
        #[ignore]
        $($item)*
    };
    (@with_ignore sv; ($first:ident $(, $rest:ident)*); { $($item:tt)* }) => {
        all_backends!(@with_ignore sv; ($($rest),*); { $($item)* });
    };

    (@with_ignore veryl; (); { $($item:tt)* }) => { $($item)* };
    (@with_ignore veryl; (veryl $(, $rest:ident)*); { $($item:tt)* }) => {
        #[ignore]
        $($item)*
    };
    (@with_ignore veryl; ($first:ident $(, $rest:ident)*); { $($item:tt)* }) => {
        all_backends!(@with_ignore veryl; ($($rest),*); { $($item)* });
    };

    (@with_ignore interp; (); { $($item:tt)* }) => { $($item)* };
    (@with_ignore interp; (interp $(, $rest:ident)*); { $($item:tt)* }) => {
        #[ignore]
        $($item)*
    };
    (@with_ignore interp; ($first:ident $(, $rest:ident)*); { $($item:tt)* }) => {
        all_backends!(@with_ignore interp; ($($rest),*); { $($item)* });
    };

    // ── internal: emit the SV frontend test ─────────────────────────
    (@sv_fn
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        ignore_list { $ignore_list:tt }
        setup { $($setup:tt)* }
        build { $builder:expr }
        body { $($body:tt)* }
    ) => {
        all_backends!(@with_ignore sv; $ignore_list; {
            #[cfg(feature = "systemverilog")]
            #[test]
            $(#[$meta])*
            #[allow(unused_mut, unused_variables)]
            fn sv() {
                $($setup)*
                let __builder = { $builder };
                let __emitted = test_utils::veryl_sv::emit_veryl_sources(__builder.sources());
                let __sv_sources = __emitted.as_sv_sources();
                let mut $sim = celox::Simulator::from_sv_sources(
                    __sv_sources,
                    __builder.top(),
                )
                .four_state(__builder.four_state_enabled())
                .build()
                .unwrap();
                $($body)*
            }
        });
    };

    // ── internal: emit the Veryl reference test ─────────────────────
    (@veryl_fn
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        ignore_list { $ignore_list:tt }
        emit
        setup { $($setup:tt)* }
        build { $builder:expr }
        body { $($body:tt)* }
    ) => {
        all_backends!(@with_ignore veryl; $ignore_list; {
            #[test]
            $(#[$meta])*
            #[allow(unused_mut, unused_variables)]
            fn veryl() {
                $($setup)*
                let __builder = { $builder };
                let mut $sim = test_utils::veryl_sim::build_veryl_adapter(
                    __builder.sources(),
                    __builder.top(),
                    __builder.four_state_enabled(),
                );
                $($body)*
            }
        });
    };
    (@veryl_fn
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        ignore_list { $ignore_list:tt }
        skip
        setup { $($setup:tt)* }
        build { $builder:expr }
        body { $($body:tt)* }
    ) => {};

    // ── internal: generate each backend ─────────────────────────────
    (@impl
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        ignore_list { $ignore_list:tt }
        veryl_mode { $veryl_mode:ident }
        setup { $($setup:tt)* }
        build { $builder:expr }
        body { $($body:tt)* }
    ) => {
        mod $name {
            use super::*;

            all_backends!(@with_ignore native; $ignore_list; {
                #[test]
                #[cfg(any(
                    target_arch = "x86_64",
                    target_arch = "aarch64"
                ))]
                $(#[$meta])*
                #[allow(unused_mut, unused_variables)]
                fn native() {
                    $($setup)*
                    let mut $sim = { $builder }.build_native().unwrap();
                    $($body)*
                }
            });

            all_backends!(@with_ignore cranelift; $ignore_list; {
                #[test]
                $(#[$meta])*
                #[allow(unused_mut, unused_variables)]
                fn cranelift() {
                    $($setup)*
                    let mut $sim = { $builder }.build_cranelift().unwrap();
                    $($body)*
                }
            });

            all_backends!(@with_ignore wasm; $ignore_list; {
                #[test]
                $(#[$meta])*
                #[allow(unused_mut, unused_variables)]
                fn wasm() {
                    $($setup)*
                    let mut $sim = { $builder }.build_wasm().unwrap();
                    $($body)*
                }
            });

            all_backends!(@with_ignore interp; $ignore_list; {
                #[test]
                $(#[$meta])*
                #[allow(unused_mut, unused_variables)]
                fn interp() {
                    $($setup)*
                    let mut $sim = { $builder }.build_interpreter().unwrap();
                    $($body)*
                }
            });

            all_backends!(@sv_fn
                $(#[$meta])* fn $name ($sim)
                ignore_list { $ignore_list }
                setup { $($setup)* }
                build { $builder }
                body { $($body)* }
            );

            all_backends!(@veryl_fn
                $(#[$meta])* fn $name ($sim)
                ignore_list { $ignore_list }
                $veryl_mode
                setup { $($setup)* }
                build { $builder }
                body { $($body)* }
            );
        }
    };

    // ── internal: dispatch per body shape ───────────────────────────

    // @omit_veryl + @ignore_on + @setup + @build
    (@dispatch
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        { @omit_veryl; @ignore_on $ignore_list:tt; @setup { $($setup:tt)* } @build $builder:expr; $($body:tt)* }
    ) => {
        all_backends!(@impl
            $(#[$meta])* fn $name ($sim)
            ignore_list { $ignore_list }
            veryl_mode { skip }
            setup { $($setup)* }
            build { $builder }
            body { $($body)* }
        );
    };

    // @omit_veryl + @ignore_on + @build (no setup)
    (@dispatch
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        { @omit_veryl; @ignore_on $ignore_list:tt; @build $builder:expr; $($body:tt)* }
    ) => {
        all_backends!(@impl
            $(#[$meta])* fn $name ($sim)
            ignore_list { $ignore_list }
            veryl_mode { skip }
            setup { }
            build { $builder }
            body { $($body)* }
        );
    };

    // @omit_veryl + @setup + @build
    (@dispatch
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        { @omit_veryl; @setup { $($setup:tt)* } @build $builder:expr; $($body:tt)* }
    ) => {
        all_backends!(@impl
            $(#[$meta])* fn $name ($sim)
            ignore_list { () }
            veryl_mode { skip }
            setup { $($setup)* }
            build { $builder }
            body { $($body)* }
        );
    };

    // @omit_veryl + @build (no setup)
    (@dispatch
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        { @omit_veryl; @build $builder:expr; $($body:tt)* }
    ) => {
        all_backends!(@impl
            $(#[$meta])* fn $name ($sim)
            ignore_list { () }
            veryl_mode { skip }
            setup { }
            build { $builder }
            body { $($body)* }
        );
    };

    // @ignore_on + @setup + @build
    (@dispatch
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        { @ignore_on $ignore_list:tt; @setup { $($setup:tt)* } @build $builder:expr; $($body:tt)* }
    ) => {
        all_backends!(@impl
            $(#[$meta])* fn $name ($sim)
            ignore_list { $ignore_list }
            veryl_mode { emit }
            setup { $($setup)* }
            build { $builder }
            body { $($body)* }
        );
    };

    // @ignore_on + @build (no setup)
    (@dispatch
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        { @ignore_on $ignore_list:tt; @build $builder:expr; $($body:tt)* }
    ) => {
        all_backends!(@impl
            $(#[$meta])* fn $name ($sim)
            ignore_list { $ignore_list }
            veryl_mode { emit }
            setup { }
            build { $builder }
            body { $($body)* }
        );
    };

    // @setup + @build (no ignore)
    (@dispatch
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        { @setup { $($setup:tt)* } @build $builder:expr; $($body:tt)* }
    ) => {
        all_backends!(@impl
            $(#[$meta])* fn $name ($sim)
            ignore_list { () }
            veryl_mode { emit }
            setup { $($setup)* }
            build { $builder }
            body { $($body)* }
        );
    };

    // @build only (no ignore, no setup)
    (@dispatch
        $(#[$meta:meta])* fn $name:ident ($sim:ident)
        { @build $builder:expr; $($body:tt)* }
    ) => {
        all_backends!(@impl
            $(#[$meta])* fn $name ($sim)
            ignore_list { () }
            veryl_mode { emit }
            setup { }
            build { $builder }
            body { $($body)* }
        );
    };

    // ── entry point ─────────────────────────────────────────────────
    ($(
        $(#[$meta:meta])*
        fn $name:ident($sim:ident) $body:tt
    )*) => {$(
        all_backends!(@dispatch
            $(#[$meta])* fn $name ($sim) $body
        );
    )*};
}