shelly-shell 0.5.3

A Rust based Unix style shell with a typed and structured language syntax.
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
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631

use std::{
    any::Any,
    io::Cursor,
    pin::Pin,
    sync::{
        Arc, Mutex as StorageMutex, Weak,
        atomic::{AtomicBool, AtomicU64, AtomicUsize, Ordering},
    },
};

use tokio::{
    io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt},
    sync::{Mutex, Notify},
};

use crate::{
    language::data::{io::Bytes, native_value::NativeData},
    runtime::tasks::NativeFault,
};

type Readable = Pin<Box<dyn AsyncRead + Send>>;
type Writable = Pin<Box<dyn AsyncWrite + Send>>;
static NEXT_LEASE: AtomicU64 = AtomicU64::new(1);
static READ_LEASES: AtomicUsize = AtomicUsize::new(0);

pub struct Control
{
    pub closed: Arc<AtomicBool>,
    pub wake: Notify,
    storage: StorageMutex<Vec<Weak<dyn Storage>>>,
}

trait Storage: Send + Sync
{
    fn release(&self);
}

impl Control
{
    pub fn new() -> Arc<Self>
    {
        Arc::new(Self {
            closed: Arc::new(AtomicBool::new(false)),
            wake: Notify::new(),
            storage: StorageMutex::new(Vec::new()),
        })
    }
    pub fn close(&self)
    {
        self.closed.store(true, Ordering::Release);
        self.wake.notify_waiters();
        for storage in self
            .storage
            .lock()
            .unwrap()
            .iter()
            .filter_map(Weak::upgrade)
        {
            storage.release();
        }
    }
    fn register(&self, storage: Arc<dyn Storage>)
    {
        self.storage.lock().unwrap().push(Arc::downgrade(&storage));
    }
}

pub struct ReaderState
{
    pub control: Arc<Control>,
    pub source: Mutex<Option<Readable>>,
    busy: AtomicBool,
    eof: AtomicBool,
    consumer: AtomicU64,
}

pub struct ReadLease
{
    id: u64,
    state: Weak<ReaderState>,
    active: AtomicBool,
    wake: Notify,
}

impl ReadLease
{
    fn release(&self)
    {
        if self.active.swap(false, Ordering::AcqRel)
        {
            if let Some(state) = self.state.upgrade()
            {
                let _ = state.consumer.compare_exchange(
                    self.id,
                    0,
                    Ordering::AcqRel,
                    Ordering::Acquire,
                );
            }
            self.wake.notify_waiters();
            READ_LEASES.fetch_sub(1, Ordering::AcqRel);
        }
    }
}
impl Drop for ReadLease
{
    fn drop(&mut self)
    {
        self.release();
    }
}

#[derive(Clone)]
pub struct Reader(pub Arc<ReaderState>, Option<Arc<ReadLease>>, bool);

pub struct WriterState
{
    pub control: Arc<Control>,
    pub sink: Mutex<Option<Writable>>,
    ended: AtomicBool,
    busy: AtomicBool,
    consumer: AtomicU64,
}

#[derive(Clone)]
pub struct Writer(pub Arc<WriterState>, Option<Arc<WriteLease>>, bool);

pub struct WriteLease
{
    id: u64,
    state: Weak<WriterState>,
    active: AtomicBool,
    wake: Notify,
}
impl WriteLease
{
    fn release(&self)
    {
        if self.active.swap(false, Ordering::AcqRel)
        {
            if let Some(state) = self.state.upgrade()
            {
                let _ = state.consumer.compare_exchange(
                    self.id,
                    0,
                    Ordering::AcqRel,
                    Ordering::Acquire,
                );
            }
            self.wake.notify_waiters();
            READ_LEASES.fetch_sub(1, Ordering::AcqRel);
        }
    }
}
impl Drop for WriteLease
{
    fn drop(&mut self)
    {
        self.release();
    }
}

struct Busy<'a>(&'a AtomicBool);
impl Drop for Busy<'_>
{
    fn drop(&mut self)
    {
        self.0.store(false, Ordering::Release);
    }
}

impl Storage for ReaderState
{
    fn release(&self)
    {
        if let Ok(mut storage) = self.source.try_lock()
        {
            storage.take();
        }
    }
}
impl Storage for WriterState
{
    fn release(&self)
    {
        if let Ok(mut storage) = self.sink.try_lock()
        {
            storage.take();
        }
    }
}

struct ReleaseClosed<'a>(&'a Control, &'a dyn Storage);
impl Drop for ReleaseClosed<'_>
{
    fn drop(&mut self)
    {
        if self.0.closed.load(Ordering::Acquire)
        {
            self.1.release();
        }
    }
}

impl Reader
{
    pub fn new(source: impl AsyncRead + Send + 'static, control: Arc<Control>) -> Self
    {
        let state = Arc::new(ReaderState {
            control: control.clone(),
            source: Mutex::new(Some(Box::pin(source))),
            busy: AtomicBool::new(false),
            eof: AtomicBool::new(false),
            consumer: AtomicU64::new(0),
        });
        control.register(state.clone());
        Self(state, None, false)
    }
    pub fn memory(bytes: Bytes) -> Self
    {
        Self::new(Cursor::new(bytes.0), Control::new())
    }
    pub fn close(&self)
    {
        if let Some(lease) = &self.1
        {
            if self.2
            {
                lease.release();
            }
            return;
        }
        self.close_underlying();
    }
    pub fn close_underlying(&self)
    {
        self.0.control.close();
        if let Ok(mut source) = self.0.source.try_lock()
        {
            source.take();
        }
    }
    pub fn leased(&self) -> Result<Self, NativeFault>
    {
        if let Some(lease) = &self.1
        {
            if !lease.active.load(Ordering::Acquire)
            {
                return Err(NativeFault::new("LeaseError", "Reader lease has expired"));
            }
            return Ok(Self(self.0.clone(), self.1.clone(), false));
        }
        if READ_LEASES.fetch_add(1, Ordering::AcqRel) >= 256
        {
            READ_LEASES.fetch_sub(1, Ordering::AcqRel);
            return Err(NativeFault::new(
                "LimitError",
                "Too many active reader leases",
            ));
        }
        let id = NEXT_LEASE.fetch_add(1, Ordering::Relaxed);
        if self
            .0
            .consumer
            .compare_exchange(0, id, Ordering::AcqRel, Ordering::Acquire)
            .is_err()
        {
            READ_LEASES.fetch_sub(1, Ordering::AcqRel);
            return Err(NativeFault::new(
                "LeaseError",
                "Reader already has a consumer",
            ));
        }
        Ok(Self(
            self.0.clone(),
            Some(Arc::new(ReadLease {
                id,
                state: Arc::downgrade(&self.0),
                active: AtomicBool::new(true),
                wake: Notify::new(),
            })),
            true,
        ))
    }
    pub fn borrowed(&self) -> Self
    {
        Self(self.0.clone(), self.1.clone(), false)
    }
    pub async fn read(&self, maximum: usize) -> Result<Option<Bytes>, NativeFault>
    {
        let id = self
            .1
            .as_ref()
            .filter(|lease| lease.active.load(Ordering::Acquire))
            .map_or(0, |lease| lease.id);
        if self.0.consumer.load(Ordering::Acquire) != id || self.1.is_some() && id == 0
        {
            return Err(NativeFault::new(
                "LeaseError",
                "Reader is reserved by another consumer",
            ));
        }
        if self.0.control.closed.load(Ordering::Acquire)
        {
            return Err(NativeFault::new("ClosedError", "Reader is closed"));
        }
        if self.0.eof.load(Ordering::Acquire)
        {
            return Ok(None);
        }
        if self.0.busy.swap(true, Ordering::AcqRel)
        {
            return Err(NativeFault::new(
                "LeaseError",
                "Reader already has a consumer",
            ));
        }
        let _busy = Busy(&self.0.busy);
        let _release = ReleaseClosed(&self.0.control, self.0.as_ref());
        let cancelled = self.0.control.wake.notified();
        tokio::pin!(cancelled);
        cancelled.as_mut().enable();
        if self.0.control.closed.load(Ordering::Acquire)
        {
            return Err(NativeFault::new("ClosedError", "Reader is closed"));
        }
        let lease_cancelled = async {
            if let Some(lease) = &self.1
            {
                let notified = lease.wake.notified();
                tokio::pin!(notified);
                notified.as_mut().enable();
                if lease.active.load(Ordering::Acquire)
                {
                    notified.await;
                }
            }
            else
            {
                std::future::pending::<()>().await;
            }
        };
        let mut storage = self.0.source.lock().await;
        let source = storage
            .as_mut()
            .ok_or_else(|| NativeFault::new("ClosedError", "Reader is closed"))?;
        let mut buffer = vec![0; maximum];
        let count = tokio::select! {
            count = source.read(&mut buffer) => count.map_err(|error|
                NativeFault::io("ReadError", error))?,
            _ = &mut cancelled => return Err(NativeFault::new("CancelledError", "Reader closed during read")),
            _ = lease_cancelled => return Err(NativeFault::new("CancelledError", "Reader lease released during read")),
        };
        if count == 0
        {
            self.0.eof.store(true, Ordering::Release);
            // Taking storage here releases file and transport handles at EOF.
            storage.take();
            return Ok(None);
        }
        buffer.truncate(count);
        Ok(Some(Bytes(buffer.into())))
    }
}

impl Writer
{
    pub fn new(sink: impl AsyncWrite + Send + 'static, control: Arc<Control>) -> Self
    {
        let state = Arc::new(WriterState {
            control: control.clone(),
            sink: Mutex::new(Some(Box::pin(sink))),
            ended: AtomicBool::new(false),
            busy: AtomicBool::new(false),
            consumer: AtomicU64::new(0),
        });
        control.register(state.clone());
        Self(state, None, false)
    }
    pub fn close(&self)
    {
        if let Some(lease) = &self.1
        {
            if self.2
            {
                lease.release();
            }
            return;
        }
        self.close_underlying();
    }
    pub fn close_underlying(&self)
    {
        self.0.control.close();
        if let Ok(mut sink) = self.0.sink.try_lock()
        {
            sink.take();
        }
    }
    pub fn leased(&self) -> Result<Self, NativeFault>
    {
        if let Some(lease) = &self.1
        {
            if !lease.active.load(Ordering::Acquire)
            {
                return Err(NativeFault::new("LeaseError", "Writer lease has expired"));
            }
            return Ok(Self(self.0.clone(), self.1.clone(), false));
        }
        if READ_LEASES.fetch_add(1, Ordering::AcqRel) >= 256
        {
            READ_LEASES.fetch_sub(1, Ordering::AcqRel);
            return Err(NativeFault::new("LimitError", "Too many active I/O leases"));
        }
        let id = NEXT_LEASE.fetch_add(1, Ordering::Relaxed);
        if self
            .0
            .consumer
            .compare_exchange(0, id, Ordering::AcqRel, Ordering::Acquire)
            .is_err()
        {
            READ_LEASES.fetch_sub(1, Ordering::AcqRel);
            return Err(NativeFault::new(
                "LeaseError",
                "Writer already has a producer",
            ));
        }
        Ok(Self(
            self.0.clone(),
            Some(Arc::new(WriteLease {
                id,
                state: Arc::downgrade(&self.0),
                active: AtomicBool::new(true),
                wake: Notify::new(),
            })),
            true,
        ))
    }
    fn check_lease(&self) -> Result<(), NativeFault>
    {
        let id = self
            .1
            .as_ref()
            .filter(|lease| lease.active.load(Ordering::Acquire))
            .map_or(0, |lease| lease.id);
        if self.0.consumer.load(Ordering::Acquire) != id || self.1.is_some() && id == 0
        {
            return Err(NativeFault::new(
                "LeaseError",
                "Writer is reserved by another producer",
            ));
        }
        Ok(())
    }
    pub async fn shutdown(&self) -> Result<(), NativeFault>
    {
        if self.0.ended.load(Ordering::Acquire)
        {
            return Ok(());
        }
        self.check_lease()?;
        if self.0.busy.swap(true, Ordering::AcqRel)
        {
            return Err(NativeFault::new(
                "LeaseError",
                "Writer already has a producer",
            ));
        }
        let _busy = Busy(&self.0.busy);
        let mut storage = self.0.sink.lock().await;
        if let Some(sink) = storage.as_mut()
        {
            tokio::select! {
                result = sink.shutdown() => result.map_err(|error| NativeFault::io("WriteError", error))?,
                _ = self.0.control.wake.notified() =>
                    return Err(NativeFault::new("CancelledError", "Write shutdown cancelled")),
            }
        }
        self.0.ended.store(true, Ordering::Release);
        storage.take();
        Ok(())
    }
    pub async fn write(&self, bytes: Bytes) -> Result<usize, NativeFault>
    {
        self.check_lease()?;
        if self.0.ended.load(Ordering::Acquire)
        {
            return Err(NativeFault::new(
                "ClosedError",
                "Write side has been shut down",
            ));
        }
        if self.0.control.closed.load(Ordering::Acquire)
        {
            return Err(NativeFault::new("ClosedError", "Writer is closed"));
        }
        if self.0.busy.swap(true, Ordering::AcqRel)
        {
            return Err(NativeFault::new(
                "LeaseError",
                "Writer already has a producer",
            ));
        }
        let _busy = Busy(&self.0.busy);
        let _release = ReleaseClosed(&self.0.control, self.0.as_ref());
        let cancelled = self.0.control.wake.notified();
        tokio::pin!(cancelled);
        cancelled.as_mut().enable();
        if self.0.control.closed.load(Ordering::Acquire)
        {
            return Err(NativeFault::new("ClosedError", "Writer is closed"));
        }
        let lease_cancelled = async {
            if let Some(lease) = &self.1
            {
                let notified = lease.wake.notified();
                tokio::pin!(notified);
                notified.as_mut().enable();
                if lease.active.load(Ordering::Acquire)
                {
                    notified.await;
                }
            }
            else
            {
                std::future::pending::<()>().await;
            }
        };
        let mut sink = self.0.sink.lock().await;
        let sink = sink
            .as_mut()
            .ok_or_else(|| NativeFault::new("ClosedError", "Writer is closed"))?;
        tokio::select! {
            result = async { sink.write_all(&bytes.0).await?; sink.flush().await } => result.map_err(|error|
                NativeFault::io("WriteError", error))?,
            _ = &mut cancelled => return Err(NativeFault::new("CancelledError", "Writer closed during write")),
            _ = lease_cancelled => return Err(NativeFault::new("CancelledError", "Writer lease released during write")),
        };
        Ok(bytes.0.len())
    }
    pub async fn flush(&self) -> Result<(), NativeFault>
    {
        self.check_lease()?;
        if self.0.ended.load(Ordering::Acquire)
        {
            return Err(NativeFault::new(
                "ClosedError",
                "Write side has been shut down",
            ));
        }
        if self.0.control.closed.load(Ordering::Acquire)
        {
            return Err(NativeFault::new("ClosedError", "Writer is closed"));
        }
        if self.0.busy.swap(true, Ordering::AcqRel)
        {
            return Err(NativeFault::new(
                "LeaseError",
                "Writer already has a producer",
            ));
        }
        let _busy = Busy(&self.0.busy);
        let _release = ReleaseClosed(&self.0.control, self.0.as_ref());
        let lease_cancelled = async {
            if let Some(lease) = &self.1
            {
                let notified = lease.wake.notified();
                tokio::pin!(notified);
                notified.as_mut().enable();
                if lease.active.load(Ordering::Acquire)
                {
                    notified.await;
                }
            }
            else
            {
                std::future::pending::<()>().await;
            }
        };
        let mut sink = self.0.sink.lock().await;
        let sink = sink
            .as_mut()
            .ok_or_else(|| NativeFault::new("ClosedError", "Writer is closed"))?;
        tokio::select! {
            result = sink.flush() => result.map_err(|error| NativeFault::io("WriteError", error)),
            _ = self.0.control.wake.notified() => Err(NativeFault::new("CancelledError", "Writer closed during flush")),
            _ = lease_cancelled => Err(NativeFault::new("CancelledError", "Writer lease released during flush")),
        }
    }
}

impl NativeData for Reader
{
    fn type_name(&self) -> &'static str
    {
        "__io_Reader"
    }
    fn display(&self) -> String
    {
        "<Reader>".into()
    }
    fn as_any(&self) -> &dyn Any
    {
        self
    }
    fn key(&self) -> Option<Vec<u8>>
    {
        Some((Arc::as_ptr(&self.0) as usize).to_ne_bytes().to_vec())
    }
}

impl NativeData for Writer
{
    fn type_name(&self) -> &'static str
    {
        "__io_Writer"
    }
    fn display(&self) -> String
    {
        "<Writer>".into()
    }
    fn as_any(&self) -> &dyn Any
    {
        self
    }
    fn key(&self) -> Option<Vec<u8>>
    {
        Some((Arc::as_ptr(&self.0) as usize).to_ne_bytes().to_vec())
    }
}