websocat 4.0.0-alpha3

Command-line client for web sockets, like netcat/curl/socat for ws://.
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
use std::{
    ops::Range,
    sync::{Arc, Mutex},
    task::{ready, Context, Poll},
};

use futures::{future::OptionFuture, FutureExt};
use rhai::{Dynamic, Engine, NativeCallContext};
use tokio::io::AsyncWriteExt;
use tracing::{debug, debug_span, error, field, warn, Instrument, Span};

use crate::scenario_executor::{
    types::{
        BufferFlag, BufferFlags, DatagramRead, DatagramWrite, Handle, StreamRead, StreamSocket,
        StreamWrite, Task,
    },
    utils1::{ExtractHandleOrFail, HandleExt2, MyOptionFuture, PacketWriteExt, TaskHandleExt},
};

use super::{types::DatagramSocket, utils1::RhResult};

//@ Forward unframed bytes from source to sink
fn copy_bytes(
    //@ buffer size to use for copying
    bufsize: i64,
    //@ stream source to read from
    from: Handle<StreamRead>,
    //@ stream sink to write to
    to: Handle<StreamWrite>,
    //@ task that finishes when forwarding finishes or exists with an error
) -> Handle<Task> {
    let span = debug_span!("copy_bytes", f = field::Empty, t = field::Empty);
    debug!(parent: &span, "node created");
    async move {
        let (f, t) = (from.lut(), to.lut());

        if let Some(f) = f.as_ref() {
            span.record("f", tracing::field::debug(f));
        }
        if let Some(t) = t.as_ref() {
            span.record("t", tracing::field::debug(t));
        }

        debug!(parent: &span, "node started");

        if let (Some(mut r), Some(mut w)) = (f, t) {
            if !r.prefix.is_empty() {
                match w
                    .writer
                    .write_all_buf(&mut r.prefix)
                    .instrument(span.clone())
                    .await
                {
                    Ok(()) => debug!(parent: &span, "prefix_written"),
                    Err(e) => {
                        error!(parent: &span, error=%e, "error writing prefix");
                        return;
                    }
                }
            }

            let mut rb = tokio::io::BufReader::with_capacity(bufsize as usize, r.reader);
            let fut = copy_buf_and_shutdown(&mut rb, &mut w.writer);

            let fut = fut.instrument(span.clone());

            match fut.await {
                Ok(x) => debug!(parent: &span, nbytes=x, "finished"),
                Err(e) => {
                    error!(parent: &span, error=%e, "error copying bytes");
                }
            }
        } else {
            debug!(parent: &span, "no operation");
        }
    }
    .wrap_noerr()
}

struct ForwardingDirection<R, W> {
    r: R,
    w: W,
    bufsize: usize,
}
struct ForwardingChoiceOutcome<R, W> {
    d: Option<ForwardingDirection<R, W>>,
    unneeded_r: Option<R>,
    unneeded_w: Option<W>,
}
impl<R, W> ForwardingChoiceOutcome<R, W> {
    fn decide(r: Option<R>, w: Option<W>, enabled: bool, bufsize: usize) -> Self {
        match (enabled, r, w) {
            (true, Some(r), Some(w)) => Self {
                d: Some(ForwardingDirection { r, w, bufsize }),
                unneeded_r: None,
                unneeded_w: None,
            },
            (true, r, w) => {
                warn!("Incomplete socket specified");
                Self {
                    d: None,
                    unneeded_r: r,
                    unneeded_w: w,
                }
            }
            (false, r, w) => Self {
                d: None,
                unneeded_r: r,
                unneeded_w: w,
            },
        }
    }
}

pub async fn copy_buf_and_shutdown<'a, R, W>(
    reader: &'a mut R,
    writer: &'a mut W,
) -> std::io::Result<u64>
where
    R: tokio::io::AsyncBufRead + Unpin + ?Sized,
    W: tokio::io::AsyncWrite + Unpin + ?Sized,
{
    let ret = tokio::io::copy_buf(reader, writer).await;
    debug!("Data copying phase finished. Shutting down the writer.");
    writer.shutdown().await?;
    ret
}

//@ Copy bytes between two stream-oriented sockets
fn exchange_bytes(
    ctx: NativeCallContext,
    opts: Dynamic,
    s1: Handle<StreamSocket>,
    s2: Handle<StreamSocket>,
) -> RhResult<Handle<Task>> {
    let span = debug_span!("exchange_bytes", s1 = field::Empty, s2 = field::Empty);

    #[derive(serde::Deserialize)]
    struct ExchangeBytesOpts {
        //@ Transfer data only from s1 to s2
        #[serde(default)]
        pub unidirectional: bool,

        //@ Transfer data only from s2 to s1
        #[serde(default)]
        pub unidirectional_reverse: bool,

        //@ abort one transfer direction when the other reached EOF
        #[serde(default)]
        pub exit_on_eof: bool,

        //@ keep inactive transfer direction handles open
        #[serde(default)]
        pub unidirectional_late_drop: bool,

        //@ allocate this amount of buffers for transfer from s1 to s2
        pub buffer_size_forward: Option<usize>,

        //@ allocate this amount of buffers for transfer from s2 to s1
        pub buffer_size_reverse: Option<usize>,
    }
    let s1 = ctx.lutbar(s1)?;
    let s2 = ctx.lutbar(s2)?;
    let opts: ExchangeBytesOpts = rhai::serde::from_dynamic(&opts)?;
    debug!(parent: &span, "node created");
    Ok(async move {
        span.record("s1", tracing::field::debug(&s1));
        span.record("s2", tracing::field::debug(&s2));

        debug!(parent: &span, "node started");

        let c1 = s1.close;
        let c2 = s2.close;

        let bufsize_forward = opts.buffer_size_forward.unwrap_or(8192);
        let bufsize_reverse = opts.buffer_size_reverse.unwrap_or(8192);
        let dir1 = ForwardingChoiceOutcome::decide(
            s1.read,
            s2.write,
            !opts.unidirectional_reverse,
            bufsize_forward,
        );
        let dir2 = ForwardingChoiceOutcome::decide(
            s2.read,
            s1.write,
            !opts.unidirectional,
            bufsize_reverse,
        );

        let late_writers_shutdown = if !opts.unidirectional_late_drop {
            if let Some(x) = dir1.unneeded_r {
                drop(x)
            }
            if let Some(x) = dir2.unneeded_r {
                drop(x)
            }
            if let Some(mut x) = dir1.unneeded_w {
                let _ = x.writer.shutdown().await;
                drop(x)
            }
            if let Some(mut x) = dir2.unneeded_w {
                let _ = x.writer.shutdown().await;
                drop(x)
            }
            (None, None)
        } else {
            (dir1.unneeded_w, dir2.unneeded_w)
        };

        let mut s1;
        let mut s2;
        let mut rb1;
        let mut rb2;
        let mut w1;
        let mut w2;
        let mut copier_duplex: OptionFuture<_> = None.into();
        let mut copier_duplex_present = false;
        let mut copier1: OptionFuture<_> = None.into();
        let mut copier1_present = false;
        let mut copier2: OptionFuture<_> = None.into();
        let mut copier2_present = false;
        let hangup1_present = c1.is_some();
        let hangup1: OptionFuture<_> = c1.into();
        let hangup2_present = c2.is_some();
        let hangup2: OptionFuture<_> = c2.into();
        let mut skip_whole = false;

        match (dir1.d, dir2.d) {
            (Some(d1), Some(d2)) => {
                if !opts.exit_on_eof {
                    s1 = tokio::io::join(d1.r, d2.w.writer);
                    s2 = tokio::io::join(d2.r, d1.w.writer);
                    copier_duplex = Some(
                        tokio::io::copy_bidirectional_with_sizes(
                            &mut s1, &mut s2, d1.bufsize, d2.bufsize,
                        )
                        .instrument(span.clone()),
                    )
                    .into();
                    copier_duplex_present = true;
                } else {
                    rb1 = tokio::io::BufReader::with_capacity(d1.bufsize, d1.r);
                    rb2 = tokio::io::BufReader::with_capacity(d2.bufsize, d2.r);
                    w2 = d1.w.writer;
                    w1 = d2.w.writer;
                    copier1 = Some(copy_buf_and_shutdown(&mut rb1, &mut w2)).into();
                    copier1_present = true;
                    copier2 = Some(copy_buf_and_shutdown(&mut rb2, &mut w1)).into();
                    copier2_present = true;
                }
            }
            (None, Some(d)) | (Some(d), None) => {
                rb1 = tokio::io::BufReader::with_capacity(d.bufsize, d.r);
                w2 = d.w.writer;
                copier1 = Some(copy_buf_and_shutdown(&mut rb1, &mut w2)).into();
                copier1_present = true;
            }
            (None, None) => skip_whole = true,
        }

        if !skip_whole {
            tokio::select! {
                Some(ret) = copier_duplex, if copier_duplex_present  => {
                    match ret {
                        Ok((n1,n2)) => debug!(parent: &span, nbytes1=n1, nbytes2=n2, "finished"),
                        Err(e) =>  debug!(parent: &span, error=%e, "error"),
                    }
                }
                Some(ret) = copier1, if copier1_present  => {
                    match ret {
                        Ok(n) => debug!(parent: &span, nbytes1=n, "finished"),
                        Err(e) =>  debug!(parent: &span, error=%e, "error"),
                    }
                }
                Some(ret) = copier2, if copier2_present  => {
                    match ret {
                        Ok(n) => debug!(parent: &span, nbytes2=n, "finished"),
                        Err(e) =>  debug!(parent: &span, error=%e, "error"),
                    }
                }
                Some(()) = hangup1, if hangup1_present => {
                    debug!(parent: &span, "hangup1");
                }
                Some(()) = hangup2, if hangup2_present => {
                    debug!(parent: &span, "hangup1");
                }
            }
        }

        if let Some(mut x) = late_writers_shutdown.0 {
            debug!(parent: &span, "shutting down writer1");
            let _ = x.writer.shutdown().await;
            drop(x);
            debug!(parent: &span, "shutdown complete 1");
        }
        if let Some(mut x) = late_writers_shutdown.1 {
            debug!(parent: &span, "shutting down writer2");
            let _ = x.writer.shutdown().await;
            drop(x);
            debug!(parent: &span, "shutdown complete 2");
        }
    }
    .wrap_noerr())
}

#[derive(Clone)]
enum Phase {
    ReadFromStream,
    WriteToSink(Range<usize>),
}
struct CopyPackets {
    r: DatagramRead,
    w: DatagramWrite,
    first_poll: bool,
    span: tracing::Span,
    phase: Phase,
    flags: BufferFlags,
    buffer: Box<[u8]>,
    counter: u64,
}

impl CopyPackets {
    fn new(r: DatagramRead, w: DatagramWrite, span: Span, buffer_size: usize) -> CopyPackets {
        let b = vec![0u8; buffer_size].into_boxed_slice();

        let phase = Phase::ReadFromStream;
        let flags = crate::scenario_executor::types::BufferFlags::default();

        CopyPackets {
            r,
            w,
            first_poll: true,
            span,
            phase,
            flags,
            buffer: b,
            counter: 0,
        }
    }
}

impl std::future::Future for CopyPackets {
    type Output = u64;

    fn poll(self: std::pin::Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<u64> {
        let this = self.get_mut();

        if this.first_poll {
            this.first_poll = false;
            debug!(parent: &this.span, "node started");
        }

        loop {
            match this.phase.clone() {
                Phase::ReadFromStream => {
                    match ready!(crate::scenario_executor::types::PacketRead::poll_read(
                        this.r.src.as_mut(),
                        cx,
                        &mut this.buffer[..],
                    )) {
                        Ok(f) => {
                            this.flags = f.flags;
                            this.phase = Phase::WriteToSink(f.buffer_subset);
                        }
                        Err(e) => {
                            error!(parent: &this.span, "error reading from stream: {e}");
                            return Poll::Ready(this.counter);
                        }
                    }
                }
                Phase::WriteToSink(range) => {
                    match ready!(crate::scenario_executor::types::PacketWrite::poll_write(
                        this.w.snk.as_mut(),
                        cx,
                        &mut this.buffer[range],
                        this.flags,
                    )) {
                        Ok(()) => {
                            if this.flags.contains(BufferFlag::Eof) {
                                debug!(parent: &this.span, "finished");
                                return Poll::Ready(this.counter);
                            }
                            this.phase = Phase::ReadFromStream;
                            this.counter += 1;
                        }
                        Err(e) => {
                            error!(parent: &this.span, "error writing to sink: {e}");
                            return Poll::Ready(this.counter);
                        }
                    }
                }
            };
        }
    }
}

//@ Copy packets from one datagram stream (half-socket) to a datagram sink.
fn copy_packets(
    bufsize: i64,
    from: Handle<DatagramRead>,
    to: Handle<DatagramWrite>,
) -> Handle<Task> {
    let span = debug_span!("copy_packets");
    debug!(parent: &span, "node created");
    let (f, t) = (from.lut(), to.lut());

    if let (Some(f), Some(t)) = (f.as_ref(), t.as_ref()) {
        debug!(parent: &span, ?f, ?t, "streams");
    }

    if let (Some(r), Some(w)) = (f, t) {
        CopyPackets::new(r, w, span, bufsize as usize)
            .map(|npkts| debug!(npkts, "finished copying packets"))
            .wrap_noerr()
    } else {
        warn!(parent: &span, "Nothing to copy");
        Arc::new(Mutex::new(None))
    }
}

//@ Exchange packets between two datagram-oriented sockets
fn exchange_packets(
    ctx: NativeCallContext,
    opts: Dynamic,
    s1: Handle<DatagramSocket>,
    s2: Handle<DatagramSocket>,
) -> RhResult<Handle<Task>> {
    let span = debug_span!("exchange_packets",);

    #[derive(serde::Deserialize)]
    struct ExchangePacketsOpts {
        //@ Transfer data only from s1 to s2
        #[serde(default)]
        pub unidirectional: bool,

        //@ Transfer data only from s2 to s1
        #[serde(default)]
        pub unidirectional_reverse: bool,

        //@ abort one transfer direction when the other reached EOF
        #[serde(default)]
        pub exit_on_eof: bool,

        //@ keep inactive transfer direction handles open
        #[serde(default)]
        pub unidirectional_late_drop: bool,

        //@ allocate this amount of buffers for transfer from s1 to s2
        pub buffer_size_forward: Option<usize>,

        //@ allocate this amount of buffers for transfer from s2 to s1
        pub buffer_size_reverse: Option<usize>,
    }
    let s1 = ctx.lutbar(s1)?;
    let s2 = ctx.lutbar(s2)?;
    let opts: ExchangePacketsOpts = rhai::serde::from_dynamic(&opts)?;
    debug!(parent: &span, "node created");
    Ok(async move {
        span.record("s1", tracing::field::debug(&s1));
        span.record("s2", tracing::field::debug(&s2));

        debug!(parent: &span, "node started");

        let c1 = s1.close;
        let c2 = s2.close;

        let bufsize_forward = opts.buffer_size_forward.unwrap_or(32768);
        let bufsize_reverse = opts.buffer_size_reverse.unwrap_or(32768);
        let dir1 = ForwardingChoiceOutcome::decide(
            s1.read,
            s2.write,
            !opts.unidirectional_reverse,
            bufsize_forward,
        );
        let dir2 = ForwardingChoiceOutcome::decide(
            s2.read,
            s1.write,
            !opts.unidirectional,
            bufsize_reverse,
        );

        let late_writers_shutdown = if !opts.unidirectional_late_drop {
            if let Some(x) = dir1.unneeded_r {
                drop(x)
            }
            if let Some(x) = dir2.unneeded_r {
                drop(x)
            }
            if let Some(mut x) = dir1.unneeded_w {
                let _ = x.snk.as_mut().send_eof().await;
                drop(x)
            }
            if let Some(mut x) = dir2.unneeded_w {
                let _ = x.snk.as_mut().send_eof().await;
                drop(x)
            }
            (None, None)
        } else {
            (dir1.unneeded_w, dir2.unneeded_w)
        };

        let copier1_;
        let copier2_;
        let mut copier_duplex: MyOptionFuture<_> = None.into();
        let mut copier_duplex_present = false;
        let mut copier1: MyOptionFuture<_> = None.into();
        let mut copier1_present = false;
        let mut copier2: MyOptionFuture<_> = None.into();
        let mut copier2_present = false;
        let hangup1_present = c1.is_some();
        let hangup1: MyOptionFuture<_> = c1.into();
        let hangup2_present = c2.is_some();
        let hangup2: MyOptionFuture<_> = c2.into();
        let mut skip_whole = false;
        let mut need_copier1_shutdown = false;
        let mut need_copier2_shutdown = false;

        match (dir1.d, dir2.d) {
            (Some(d1), Some(d2)) => {
                copier1_ = CopyPackets::new(d1.r, d1.w, span.clone(), d1.bufsize);
                copier2_ = CopyPackets::new(d2.r, d2.w, span.clone(), d2.bufsize);
                if !opts.exit_on_eof {
                    let both_copiers = futures::future::join(copier1_, copier2_);

                    copier_duplex = Some(both_copiers).into();
                    copier_duplex_present = true;
                } else {
                    copier1 = Some(copier1_).into();
                    copier1_present = true;
                    copier2 = Some(copier2_).into();
                    copier2_present = true;
                }
            }
            (None, Some(d)) | (Some(d), None) => {
                copier1_ = CopyPackets::new(d.r, d.w, span.clone(), d.bufsize);
                copier1 = Some(copier1_).into();
                copier1_present = true;
            }
            (None, None) => skip_whole = true,
        }

        if !skip_whole {
            tokio::select! {
                Some((n1, n2)) = copier_duplex, if copier_duplex_present  => {
                    debug!(parent: &span, npkts1=n1, npkts2=n2, "finished")
                }
                Some(n) = &mut copier1, if copier1_present  => {
                   debug!(parent: &span, npkts1=n, "finished");
                   need_copier2_shutdown = true;
                }
                Some(n) = &mut copier2, if copier2_present  => {
                   debug!(parent: &span, npkts2=n, "finished");
                   need_copier1_shutdown = true;
                }
                Some(()) = hangup1, if hangup1_present => {
                    debug!(parent: &span, "hangup1");
                }
                Some(()) = hangup2, if hangup2_present => {
                    debug!(parent: &span, "hangup1");
                }
            }
        }

        if need_copier1_shutdown && copier1_present {
            debug!("Shutting down sink 1");
            let mut c = copier1.take().unwrap();
            let _ = c.w.snk.as_mut().send_eof().await;
        }
        if need_copier2_shutdown && copier2_present {
            debug!("Shutting down sink 2");
            let mut c = copier2.take().unwrap();
            let _ = c.w.snk.as_mut().send_eof().await;
        }

        if let Some(mut x) = late_writers_shutdown.0 {
            let _ = x.snk.as_mut().send_eof().await;
            drop(x)
        }
        if let Some(mut x) = late_writers_shutdown.1 {
            let _ = x.snk.as_mut().send_eof().await;
            drop(x)
        }
    }
    .wrap_noerr())
}

pub fn register(engine: &mut Engine) {
    engine.register_fn("copy_bytes", copy_bytes);
    engine.register_fn("exchange_bytes", exchange_bytes);
    engine.register_fn("copy_packets", copy_packets);
    engine.register_fn("exchange_packets", exchange_packets);
}