seq-runtime 5.6.1

Runtime library for the Seq programming language
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
use super::*;
use crate::scheduler::{spawn_strand, wait_all_strands};
use std::sync::atomic::{AtomicBool, AtomicI64, Ordering};

#[test]
fn test_make_channel() {
    unsafe {
        let stack = crate::stack::alloc_test_stack();
        let stack = make_channel(stack);

        // Should have Channel on stack
        let (_stack, value) = pop(stack);
        assert!(matches!(value, Value::Channel(_)));
    }
}

#[test]
fn test_send_receive() {
    unsafe {
        // Create a channel
        let mut stack = crate::stack::alloc_test_stack();
        stack = make_channel(stack);

        // Get channel (but keep it on stack for receive via dup-like pattern)
        let (_empty_stack, channel_value) = pop(stack);

        // Push value to send, then channel
        let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(42));
        stack = push(stack, channel_value.clone());
        stack = send(stack);

        // Check send succeeded
        let (stack, send_success) = pop(stack);
        assert_eq!(send_success, Value::Bool(true));

        // Receive value
        let mut stack = push(stack, channel_value);
        stack = receive(stack);

        // Check receive succeeded and got correct value
        let (stack, recv_success) = pop(stack);
        let (_stack, received) = pop(stack);
        assert_eq!(recv_success, Value::Bool(true));
        assert_eq!(received, Value::Int(42));
    }
}

#[test]
fn test_channel_dup_sharing() {
    // Verify that duplicating a channel shares the same underlying sender/receiver
    unsafe {
        let mut stack = crate::stack::alloc_test_stack();
        stack = make_channel(stack);

        let (_, ch1) = pop(stack);
        let ch2 = ch1.clone(); // Simulates dup

        // Send on ch1
        let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(99));
        stack = push(stack, ch1);
        stack = send(stack);

        // Pop send success flag
        let (stack, _) = pop(stack);

        // Receive on ch2
        let mut stack = push(stack, ch2);
        stack = receive(stack);

        // Pop success flag then value
        let (stack, _) = pop(stack);
        let (_, received) = pop(stack);
        assert_eq!(received, Value::Int(99));
    }
}

#[test]
fn test_multiple_sends_receives() {
    unsafe {
        // Create a channel
        let mut stack = crate::stack::alloc_test_stack();
        stack = make_channel(stack);
        let (_, channel_value) = pop(stack);

        // Send multiple values
        for i in 1..=5 {
            let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(i));
            stack = push(stack, channel_value.clone());
            stack = send(stack);
            let (_, success) = pop(stack);
            assert_eq!(success, Value::Bool(true));
        }

        // Receive them back in order
        for i in 1..=5 {
            let mut stack = push(crate::stack::alloc_test_stack(), channel_value.clone());
            stack = receive(stack);
            let (stack, success) = pop(stack);
            let (_, received) = pop(stack);
            assert_eq!(success, Value::Bool(true));
            assert_eq!(received, Value::Int(i));
        }
    }
}

#[test]
fn test_close_channel() {
    unsafe {
        // Create and close a channel
        let mut stack = crate::stack::alloc_test_stack();
        stack = make_channel(stack);

        let _stack = close_channel(stack);
    }
}

#[test]
fn test_arena_string_send_between_strands() {
    // Verify that arena-allocated strings are properly cloned to global storage
    unsafe {
        static CHANNEL_PTR: AtomicI64 = AtomicI64::new(0);
        static VERIFIED: AtomicBool = AtomicBool::new(false);

        // Create a channel
        let mut stack = crate::stack::alloc_test_stack();
        stack = make_channel(stack);
        let (_, channel_value) = pop(stack);

        // Store channel pointer for strands (hacky but works for test)
        let ch_ptr = match &channel_value {
            Value::Channel(arc) => Arc::as_ptr(arc) as i64,
            _ => panic!("Expected Channel"),
        };
        CHANNEL_PTR.store(ch_ptr, Ordering::Release);

        // Keep the Arc alive
        std::mem::forget(channel_value.clone());

        // Sender strand
        extern "C" fn sender(_stack: Stack) -> Stack {
            use crate::seqstring::arena_string;
            use crate::value::ChannelData;

            unsafe {
                let ch_ptr = CHANNEL_PTR.load(Ordering::Acquire) as *const ChannelData;
                let channel = Arc::from_raw(ch_ptr);
                let channel_clone = Arc::clone(&channel);
                std::mem::forget(channel); // Don't drop

                // Create arena string (fast path)
                let msg = arena_string("Arena message!");
                assert!(!msg.is_global(), "Should be arena-allocated initially");

                // Send through channel
                let stack = push(crate::stack::alloc_test_stack(), Value::String(msg));
                let stack = push(stack, Value::Channel(channel_clone));
                let stack = send(stack);
                // Pop success flag (we trust it worked for this test)
                let (stack, _) = pop(stack);
                stack
            }
        }

        // Receiver strand
        extern "C" fn receiver(_stack: Stack) -> Stack {
            use crate::value::ChannelData;

            unsafe {
                let ch_ptr = CHANNEL_PTR.load(Ordering::Acquire) as *const ChannelData;
                let channel = Arc::from_raw(ch_ptr);
                let channel_clone = Arc::clone(&channel);
                std::mem::forget(channel); // Don't drop

                let mut stack = push(
                    crate::stack::alloc_test_stack(),
                    Value::Channel(channel_clone),
                );
                stack = receive(stack);
                // Pop success flag first
                let (stack, _) = pop(stack);
                let (_, msg_val) = pop(stack);

                match msg_val {
                    Value::String(s) => {
                        assert_eq!(s.as_str(), "Arena message!");
                        assert!(s.is_global(), "Received string should be global");
                        VERIFIED.store(true, Ordering::Release);
                    }
                    _ => panic!("Expected String"),
                }

                std::ptr::null_mut()
            }
        }

        spawn_strand(sender);
        spawn_strand(receiver);
        wait_all_strands();

        assert!(
            VERIFIED.load(Ordering::Acquire),
            "Receiver should have verified"
        );
    }
}

#[test]
fn test_send_success() {
    unsafe {
        let mut stack = crate::stack::alloc_test_stack();
        stack = make_channel(stack);
        let (_, channel_value) = pop(stack);

        // Send value
        let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(42));
        stack = push(stack, channel_value.clone());
        stack = send(stack);

        // Should return success (true)
        let (stack, result) = pop(stack);
        assert_eq!(result, Value::Bool(true));

        // Receive to verify
        let mut stack = push(stack, channel_value);
        stack = receive(stack);
        let (stack, success) = pop(stack);
        let (_, received) = pop(stack);
        assert_eq!(success, Value::Bool(true));
        assert_eq!(received, Value::Int(42));
    }
}

#[test]
fn test_send_wrong_type() {
    unsafe {
        // Try to send with Int instead of Channel
        let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(42));
        stack = push(stack, Value::Int(999)); // Wrong type
        stack = send(stack);

        // Should return failure (false)
        let (_stack, result) = pop(stack);
        assert_eq!(result, Value::Bool(false));
    }
}

#[test]
fn test_receive_success() {
    unsafe {
        let mut stack = crate::stack::alloc_test_stack();
        stack = make_channel(stack);
        let (_, channel_value) = pop(stack);

        // Send value
        let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(42));
        stack = push(stack, channel_value.clone());
        stack = send(stack);
        let (_, _) = pop(stack); // pop send success

        // Receive
        let mut stack = push(crate::stack::alloc_test_stack(), channel_value);
        stack = receive(stack);

        // Should return (value, true)
        let (stack, success) = pop(stack);
        let (_stack, value) = pop(stack);
        assert_eq!(success, Value::Bool(true));
        assert_eq!(value, Value::Int(42));
    }
}

#[test]
fn test_receive_wrong_type() {
    unsafe {
        // Try to receive with Int instead of Channel
        let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(999));
        stack = receive(stack);

        // Should return (0, false)
        let (stack, success) = pop(stack);
        let (_stack, value) = pop(stack);
        assert_eq!(success, Value::Bool(false));
        assert_eq!(value, Value::Int(0));
    }
}

#[test]
fn test_mpmc_concurrent_receivers() {
    // Verify that multiple receivers work with MPMC
    unsafe {
        const NUM_MESSAGES: i64 = 100;
        const NUM_RECEIVERS: usize = 4;

        static RECEIVER_COUNTS: [AtomicI64; 4] = [
            AtomicI64::new(0),
            AtomicI64::new(0),
            AtomicI64::new(0),
            AtomicI64::new(0),
        ];
        static CHANNEL_PTR: AtomicI64 = AtomicI64::new(0);

        // Reset counters
        for counter in &RECEIVER_COUNTS {
            counter.store(0, Ordering::SeqCst);
        }

        // Create channel
        let mut stack = crate::stack::alloc_test_stack();
        stack = make_channel(stack);
        let (_, channel_value) = pop(stack);

        let ch_ptr = match &channel_value {
            Value::Channel(arc) => Arc::as_ptr(arc) as i64,
            _ => panic!("Expected Channel"),
        };
        CHANNEL_PTR.store(ch_ptr, Ordering::SeqCst);

        // Keep Arc alive
        for _ in 0..(NUM_RECEIVERS + 1) {
            std::mem::forget(channel_value.clone());
        }

        fn make_receiver(idx: usize) -> extern "C" fn(Stack) -> Stack {
            match idx {
                0 => receiver_0,
                1 => receiver_1,
                2 => receiver_2,
                3 => receiver_3,
                _ => panic!("Invalid receiver index"),
            }
        }

        extern "C" fn receiver_0(stack: Stack) -> Stack {
            receive_loop(0, stack)
        }
        extern "C" fn receiver_1(stack: Stack) -> Stack {
            receive_loop(1, stack)
        }
        extern "C" fn receiver_2(stack: Stack) -> Stack {
            receive_loop(2, stack)
        }
        extern "C" fn receiver_3(stack: Stack) -> Stack {
            receive_loop(3, stack)
        }

        fn receive_loop(idx: usize, _stack: Stack) -> Stack {
            use crate::value::ChannelData;
            unsafe {
                let ch_ptr = CHANNEL_PTR.load(Ordering::SeqCst) as *const ChannelData;
                let channel = Arc::from_raw(ch_ptr);
                let channel_clone = Arc::clone(&channel);
                std::mem::forget(channel);

                loop {
                    let mut stack = push(
                        crate::stack::alloc_test_stack(),
                        Value::Channel(channel_clone.clone()),
                    );
                    stack = receive(stack);
                    let (stack, success) = pop(stack);
                    let (_, value) = pop(stack);

                    match (success, value) {
                        (Value::Bool(true), Value::Int(v)) => {
                            if v < 0 {
                                break; // Sentinel
                            }
                            RECEIVER_COUNTS[idx].fetch_add(1, Ordering::SeqCst);
                        }
                        _ => break,
                    }
                    may::coroutine::yield_now();
                }
                std::ptr::null_mut()
            }
        }

        // Spawn receivers
        for i in 0..NUM_RECEIVERS {
            spawn_strand(make_receiver(i));
        }

        std::thread::sleep(std::time::Duration::from_millis(10));

        // Send messages
        for i in 0..NUM_MESSAGES {
            let ch_ptr = CHANNEL_PTR.load(Ordering::SeqCst) as *const ChannelData;
            let channel = Arc::from_raw(ch_ptr);
            let channel_clone = Arc::clone(&channel);
            std::mem::forget(channel);

            let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(i));
            stack = push(stack, Value::Channel(channel_clone));
            let _ = send(stack);
        }

        // Send sentinels
        for _ in 0..NUM_RECEIVERS {
            let ch_ptr = CHANNEL_PTR.load(Ordering::SeqCst) as *const ChannelData;
            let channel = Arc::from_raw(ch_ptr);
            let channel_clone = Arc::clone(&channel);
            std::mem::forget(channel);

            let mut stack = push(crate::stack::alloc_test_stack(), Value::Int(-1));
            stack = push(stack, Value::Channel(channel_clone));
            let _ = send(stack);
        }

        wait_all_strands();

        let total_received: i64 = RECEIVER_COUNTS
            .iter()
            .map(|c| c.load(Ordering::SeqCst))
            .sum();
        assert_eq!(total_received, NUM_MESSAGES);

        let active_receivers = RECEIVER_COUNTS
            .iter()
            .filter(|c| c.load(Ordering::SeqCst) > 0)
            .count();
        assert!(active_receivers >= 2, "Messages should be distributed");
    }
}