runact 1.3.3

A Rust-native actor runtime with BEAM-style processes
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
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
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
# Runact Async Runtime Boundary

## Goal

Define a strict architectural boundary for Runact.

Runact is a lightweight actor/runtime system inspired by BEAM, implemented in Rust. It should provide concurrency, scheduling, task lifecycle, supervision, cancellation, and resource management without becoming a complete application-level async ecosystem.

The core principle is:

> **Runact schedules asynchronous work; I/O libraries define asynchronous work.**

---

# 1. What Runact Owns

Runact owns the execution and lifecycle of concurrent work.

### Actor Runtime

* Actor creation
* Actor lifecycle
* Actor mailbox
* Typed messages
* Bounded mailboxes
* Backpressure
* Actor scheduling
* Cooperative yielding
* Actor supervision
* Panic isolation
* Actor restart/stop policies

### Async Task Runtime

Runact should provide a small native task abstraction based on standard Rust futures.

Own:

* Task creation
* Task IDs
* Task lifecycle
* Future polling
* Waker integration
* Task scheduling
* Task cancellation
* Task handles
* Task groups
* Task supervision
* Runtime shutdown
* Fairness between tasks
* Bounded task concurrency

Use standard Rust primitives:

```rust
Future
Poll
Waker
Context
Pin
```

Do NOT invent a new async programming model.

---

# 2. Compute Runtime

CPU-heavy work must be separated from ordinary async tasks.

Runact owns:

```text
ComputePool
```

Examples:

* parsing
* indexing
* syntax analysis
* compression
* hashing
* large calculations
* CPU-heavy AI preprocessing
* expensive transformations

API concept:

```rust
runtime.compute().spawn(|| {
    expensive_calculation()
});
```

CPU-heavy work must never monopolize actor workers or async workers.

---

# 3. Timers

Runact owns runtime timers.

Provide primitives such as:

```rust
Runtime::sleep(duration)
Runtime::timeout(duration, future)
```

Start with a simple correct timer implementation.

A timer wheel can be introduced later if profiling demonstrates the need.

---

# 4. Cancellation

Cancellation is a Runact responsibility.

Provide:

```rust
CancellationToken
```

Conceptually:

```rust
let token = CancellationToken::new();

token.cancel();
token.is_cancelled();
```

Cancellation must be cooperative.

Never forcibly kill arbitrary Rust threads or tasks.

---

# 5. Structured Concurrency

Runact should provide task groups.

Example:

```text
Workspace
   └── TaskGroup
       ├── indexing task
       ├── search task
       ├── LSP task
       └── AI task
```

When the workspace closes:

```text
Workspace closing
      ↓
Cancel TaskGroup
      ↓
Wait for tasks
      ↓
Release resources
```

This prevents orphaned background tasks.

---

# 6. What Runact Does NOT Own

Runact must NOT become an application-level networking framework.

Do NOT put these inside Runact core:

```text
HTTP
HTTPS
WebSocket
TLS
DNS
HTTP client
HTTP server
FTP
SSH
SMTP
Database protocols
LSP protocol
Git protocol
```

These belong to specialized libraries.

For example:

```text
reqwest       → HTTP
tokio-tungstenite → WebSocket
rustls        → TLS
trust-dns     → DNS
sqlx          → database
tower         → service middleware
```

Runact should execute their asynchronous operations where possible, rather than reimplementing them.

---

# 7. Critical Async Boundary

The architectural boundary should look like this:

```text
                 RUNACT
┌──────────────────────────────────────────┐
│                                          │
│  Actors                                  │
│  Scheduler                               │
│  Async Tasks                             │
│  Future Polling                          │
│  Wakers                                  │
│  Cancellation                            │
│  Task Groups                             │
│  Timers                                  │
│  Supervision                             │
│  Compute Pool                            │
│  Backpressure                            │
│  Shutdown                                │
│                                          │
└───────────────────┬──────────────────────┘
                    │
                    │ Future / Waker / TaskHandle
                    │
                    ▼
          ASYNC I/O BOUNDARY
                    │
                    ▼
┌──────────────────────────────────────────┐
│          External Libraries              │
│                                          │
│ HTTP                                     │
│ WebSocket                                │
│ TLS                                      │
│ DNS                                      │
│ Filesystem                               │
│ Database                                 │
│ LSP                                      │
│ Git                                      │
└──────────────────────────────────────────┘
```

Runact provides execution.

Libraries provide protocols and I/O implementations.

---

# 8. Tokio Boundary

Do NOT make Tokio a fundamental dependency of Runact core initially.

However, Runact must acknowledge an important fact:

> Polling a Tokio-based future from Runact does not automatically provide the Tokio runtime/reactor that some libraries require.

Therefore, external async ecosystems need adapters.

Architecture:

```text
PaperOS
   │
   ▼
Runact
   │
   ├── Native Runact tasks
   │
   └── Runtime Adapter
          │
          ▼
       Tokio
          │
          ├── HTTP
          ├── WebSocket
          └── other Tokio-based I/O
```

The adapter isolates Tokio from the Runact core.

---

# 9. What Belongs Where

Runact core provides:

```text
TCP networking (TcpListener, TcpStream, Reactor)
Process management (spawn, stdin/stdout/stderr)
```

These are fundamental runtime primitives. TCP is the lowest-level network primitive; process management is required for AI agents and system integration.

Avoid application-level protocols in Runact core:

```text
HTTP
WebSocket
TLS
DNS
```

These belong to specialized libraries or higher-level crates (e.g., `runact-web`).

Instead expose generic execution APIs:

```rust
runtime.spawn_task(future)
runtime.compute().spawn(job)
Runtime::sleep(duration)
Runtime::timeout(duration, future)
```

Example:

```rust
let task = runtime.spawn_task(async move {
    let response = http_client.get(url).send().await?;
    Ok::<_, Error>(response)
});
```

The HTTP client belongs to the HTTP library.

Runact only manages execution and lifecycle.

---

# 10. Actor + Async Integration

Actors should NOT fundamentally become async actors.

Use this model:

```text
                 Actor
                   │
          receives message
                   │
                   ▼
             Start I/O Task
                   │
                   ▼
          Actor continues work
                   │
                   │
             async I/O
                   │
                   ▼
          Task completes
                   │
                   ▼
          Send result message
                   │
                   ▼
                Actor
```

Example:

```rust
Actor receives:

FetchDocument
       ↓
spawn async task
       ↓
actor remains schedulable
       ↓
HTTP request waiting
       ↓
HTTP completes
       ↓
DocumentFetched(result)
       ↓
actor processes result
```

An actor must not block an actor worker while waiting for I/O.

---

# 11. Async Task Lifecycle

Use an explicit lifecycle:

```text
Created
   ↓
Scheduled
   ↓
Running
   ↓
Waiting
   │
   └──────────────┐
                  │ wake
                  ▼
               Runnable
                  │
                  ▼
               Running
                  │
                  ▼
              Completed
```

Failure:

```text
Running → Failed
```

Cancellation:

```text
Running
   ↓
Cancelling
   ↓
Cancelled
```

A pending task must consume essentially no worker execution time.

---

# 12. Waker Integration

Runact must implement a Runact-specific Waker.

When a future returns:

```rust
Poll::Pending
```

the task is not continuously polled.

The Waker marks the task runnable and schedules it again.

Conceptually:

```text
Future
  │
  └── Poll::Pending
          ↓
        Waker
          ↓
   mark task runnable
          ↓
      scheduler
          ↓
       worker
          ↓
     poll again
```

Prevent duplicate scheduling using an atomic task state or equivalent mechanism.

---

# 13. Worker Separation

Runact should logically separate:

```text
Actor Workers
Async Workers
Compute Workers
```

Conceptually:

```text
             Scheduler
          /      |       \
         /       |        \
    Actors     Async     Compute
     pool       pool       pool
```

The exact implementation may evolve.

The important invariant is:

> CPU-heavy work must not starve actors or asynchronous I/O tasks.

---

# 14. Backpressure

Runact must not encourage unlimited task creation.

Bad:

```rust
for item in millions {
    runtime.spawn_task(process(item));
}
```

without any concurrency bound.

Prefer:

```text
Input
  ↓
Bounded queue
  ↓
Limited concurrent tasks
  ↓
Results
```

Backpressure should exist at:

* actor mailboxes
* task queues
* compute queues
* external work submission

---

# 15. Shutdown

Runtime shutdown must be structured.

Recommended order:

```text
Stop accepting new work
        ↓
Cancel task groups
        ↓
Stop actors
        ↓
Wait for async tasks
        ↓
Stop async workers
        ↓
Stop compute workers
        ↓
Release runtime resources
```

Support shutdown deadlines so one broken task cannot keep the entire runtime alive forever.

---

# 16. Error and Panic Isolation

Actor panic:

```text
Actor panic
    ↓
Supervisor
    ↓
Restart / Stop / Escalate
```

Async task failure should remain attached to the task handle/group.

Compute job failure must not crash unrelated runtime workers.

The runtime itself should remain alive when an individual actor/task/job fails.

---

# 17. Public API Direction

Keep the public API small.

Target concepts:

```rust
Runtime
Actor
ActorRef
Task
TaskHandle
TaskGroup
CancellationToken
ComputePool
```

Runtime methods may include:

```rust
Runtime::new()
Runtime::spawn()
Runtime::spawn_task()
Runtime::compute()
Runtime::sleep()
Runtime::timeout()
TaskGroup::new()
Runtime::shutdown()
```

Avoid exposing internal scheduler structures.

---

# 18. PaperOS Relationship

PaperOS uses Runact as its execution foundation.

Architecture:

```text
                 PaperOS
┌──────────────────────────────────────────┐
│                                          │
│ Editor                                   │
│ Terminal                                 │
│ Filesystem                               │
│ Git                                      │
│ LSP                                      │
│ Search                                   │
│ AI                                       │
│ Database                                 │
│ Extensions                               │
│                                          │
└────────────────────┬─────────────────────┘
                     │
                     ▼
                  Runact
┌──────────────────────────────────────────┐
│ Actors                                   │
│ Tasks                                    │
│ Scheduler                                │
│ Cancellation                             │
│ Timers                                   │
│ Supervision                              │
│ Compute                                  │
└────────────────────┬─────────────────────┘
                     │
                     ▼
             External Libraries
```

PaperOS owns application-level services.

Runact owns concurrency and lifecycle.

---

# 19. Core Design Rule

When deciding whether something belongs in Runact, ask:

> "Is this about executing and managing concurrent work, or is it about implementing a particular application protocol?"

If it is about:

```text
scheduling
lifecycle
cancellation
supervision
tasks
actors
timers
fairness
backpressure
compute
```

it probably belongs in Runact.

If it is about:

```text
HTTP
TLS
WebSocket
DNS
Git
SQL
LSP
SSH
```

it belongs outside Runact.

---

# 20. Implementation Strategy

Do NOT attempt to build a complete async ecosystem.

Implement in this order:

### Phase 1 — Future Task

Implement:

```text
Task
TaskHandle
Executor
Future polling
```

### Phase 2 — Waker

Implement:

```text
Runact Waker
Runnable queue
Wake deduplication
```

### Phase 3 — Scheduler Integration

Integrate async tasks with the Runact scheduler.

### Phase 4 — Cancellation

Implement:

```text
CancellationToken
Task cancellation
```

### Phase 5 — Timers

Implement:

```text
sleep()
timeout()
```

### Phase 6 — Actor Integration

Allow actors to spawn async tasks and receive results as messages.

### Phase 7 — Task Groups

Implement structured concurrency.

### Phase 8 — Compute Pool

Separate CPU-heavy work from normal async execution.

### Phase 9 — Runtime Adapters

Create optional adapters for external runtimes such as Tokio when required by external libraries.

---

# 21. Tests

At minimum test:

```text
Future completion
Future Pending → Wake → Resume
Multiple tasks
Task cancellation
Task timeout
Timer accuracy
Task groups
Actor + async integration
Actor panic isolation
Compute isolation
Runtime shutdown
Backpressure
10,000+ tasks
100,000+ wakeups
Mixed actor/task workloads
```

Stress test the scheduler under mixed workloads.

---

# 22. Architectural Invariants

The canonical invariant set is in [Architecture](architecture.md) §35. The async-runtime-relevant invariants are:

1. Runact core does not implement HTTP.
2. Runact core does not implement WebSocket.
3. Runact core does not implement TLS.
4. Runact core does not implement DNS.
5. Runact core does not depend fundamentally on Tokio.
6. Runact executes standard Rust futures.
7. Pending futures consume no worker execution time.
8. Actors do not block while waiting for asynchronous I/O.
9. CPU-heavy work runs outside normal async/actor workers.
10. Cancellation is cooperative.
11. Task lifecycle is observable.
12. Runtime shutdown is structured.
13. External I/O libraries remain replaceable.

See [Architecture §35](architecture.md#35-architectural-invariants) for the full set (27 invariants).

---

# Final Principle

Runact should be:

> **A concurrency and lifecycle runtime, not an application framework.**

The clean boundary is:

```text
Actors
Tasks
Schedulers
Wakers
Timers
Cancellation
Supervision
Compute
Backpressure
Lifecycle
        ↓
   RUNACT BOUNDARY
        ↓
Future / Waker / Adapter
        ↓
HTTP / WebSocket / TLS / DNS / DB / LSP / Git
```

Keep Runact small.

Do not recreate Tokio.

Do not recreate BEAM.

Build the smallest Rust-native runtime that gives PaperOS and future projects a strong actor/task/concurrency foundation.

## See Also

- [Architecture]architecture.md — Full architectural document with runtime model, invariants, and development order
- [ADR-0003: Native Async Runtime]adr/0003-native-async-runtime.md — Rationale for a native Future executor without a Tokio core dependency
- [Runtime]runtime.md — Top-level Runtime API, RequestHandle, RuntimeConfig, RuntimeStats
- [Scheduler]scheduler.md — BEAM-style scheduler with work stealing
- [Vision]vision.md — Design priorities and long-term evolution