Line data Source code
1 : use std::{
2 : panic::AssertUnwindSafe,
3 : sync::{
4 : atomic::{AtomicBool, AtomicU32, AtomicU8, Ordering},
5 : mpsc, Arc, OnceLock,
6 : },
7 : thread::JoinHandle,
8 : };
9 :
10 : use tracing::{debug, error, trace};
11 :
12 : use crate::time::Timing;
13 :
14 : /// Stores status of the running threads. Threads are registered in the runtime upon creation
15 : /// and deregistered upon termination.
16 : pub struct Runtime {
17 : // stores handles to all threads that are currently running
18 : threads: Vec<ThreadHandle>,
19 : // stores current time and pending wakeups
20 : clock: Arc<Timing>,
21 : // thread counter
22 : thread_counter: AtomicU32,
23 : // Thread step counter -- how many times all threads has been actually
24 : // stepped (note that all world/time/executor/thread have slightly different
25 : // meaning of steps). For observability.
26 : pub step_counter: u64,
27 : }
28 :
29 : impl Runtime {
30 : /// Init new runtime, no running threads.
31 528 : pub fn new(clock: Arc<Timing>) -> Self {
32 528 : Self {
33 528 : threads: Vec::new(),
34 528 : clock,
35 528 : thread_counter: AtomicU32::new(0),
36 528 : step_counter: 0,
37 528 : }
38 528 : }
39 :
40 : /// Spawn a new thread and register it in the runtime.
41 19842 : pub fn spawn<F>(&mut self, f: F) -> ExternalHandle
42 19842 : where
43 19842 : F: FnOnce() + Send + 'static,
44 19842 : {
45 19842 : let (tx, rx) = mpsc::channel();
46 19842 :
47 19842 : let clock = self.clock.clone();
48 19842 : let tid = self.thread_counter.fetch_add(1, Ordering::SeqCst);
49 19842 : debug!("spawning thread-{}", tid);
50 :
51 19842 : let join = std::thread::spawn(move || {
52 19842 : let _guard = tracing::info_span!("", tid).entered();
53 19842 :
54 19842 : let res = std::panic::catch_unwind(AssertUnwindSafe(|| {
55 19842 : with_thread_context(|ctx| {
56 19842 : assert!(ctx.clock.set(clock).is_ok());
57 19842 : ctx.id.store(tid, Ordering::SeqCst);
58 19842 : tx.send(ctx.clone()).expect("failed to send thread context");
59 19842 : // suspend thread to put it to `threads` in sleeping state
60 19842 : ctx.yield_me(0);
61 19842 : });
62 19842 :
63 19842 : // start user-provided function
64 19842 : f();
65 19842 : }));
66 19842 : debug!("thread finished");
67 :
68 19784 : if let Err(e) = res {
69 19764 : with_thread_context(|ctx| {
70 19764 : if !ctx.allow_panic.load(std::sync::atomic::Ordering::SeqCst) {
71 0 : error!("thread panicked, terminating the process: {:?}", e);
72 0 : std::process::exit(1);
73 19764 : }
74 19764 :
75 19764 : debug!("thread panicked: {:?}", e);
76 19764 : let mut result = ctx.result.lock();
77 19764 : if result.0 == -1 {
78 19334 : *result = (256, format!("thread panicked: {:?}", e));
79 19334 : }
80 19764 : });
81 19764 : }
82 :
83 19784 : with_thread_context(|ctx| {
84 19784 : ctx.finish_me();
85 19784 : });
86 19842 : });
87 19842 :
88 19842 : let ctx = rx.recv().expect("failed to receive thread context");
89 19842 : let handle = ThreadHandle::new(ctx.clone(), join);
90 19842 :
91 19842 : self.threads.push(handle);
92 19842 :
93 19842 : ExternalHandle { ctx }
94 19842 : }
95 :
96 : /// Returns true if there are any unfinished activity, such as running thread or pending events.
97 : /// Otherwise returns false, which means all threads are blocked forever.
98 413732 : pub fn step(&mut self) -> bool {
99 413732 : trace!("runtime step");
100 :
101 : // have we run any thread?
102 413732 : let mut ran = false;
103 413732 :
104 2064953 : self.threads.retain(|thread: &ThreadHandle| {
105 2064953 : let res = thread.ctx.wakeup.compare_exchange(
106 2064953 : PENDING_WAKEUP,
107 2064953 : NO_WAKEUP,
108 2064953 : Ordering::SeqCst,
109 2064953 : Ordering::SeqCst,
110 2064953 : );
111 2064953 : if res.is_err() {
112 : // thread has no pending wakeups, leaving as is
113 1779994 : return true;
114 284959 : }
115 284959 : ran = true;
116 284959 :
117 284959 : trace!("entering thread-{}", thread.ctx.tid());
118 284959 : let status = thread.step();
119 284959 : self.step_counter += 1;
120 284959 : trace!(
121 0 : "out of thread-{} with status {:?}",
122 0 : thread.ctx.tid(),
123 : status
124 : );
125 :
126 284959 : if status == Status::Sleep {
127 265175 : true
128 : } else {
129 19784 : trace!("thread has finished");
130 : // removing the thread from the list
131 19784 : false
132 : }
133 2064953 : });
134 413732 :
135 413732 : if !ran {
136 218322 : trace!("no threads were run, stepping clock");
137 218322 : if let Some(ctx_to_wake) = self.clock.step() {
138 217774 : trace!("waking up thread-{}", ctx_to_wake.tid());
139 217774 : ctx_to_wake.inc_wake();
140 : } else {
141 548 : return false;
142 : }
143 195410 : }
144 :
145 413184 : true
146 413732 : }
147 :
148 : /// Kill all threads. This is done by setting a flag in each thread context and waking it up.
149 1008 : pub fn crash_all_threads(&mut self) {
150 2871 : for thread in self.threads.iter() {
151 2871 : thread.ctx.crash_stop();
152 2871 : }
153 :
154 : // all threads should be finished after a few steps
155 1512 : while !self.threads.is_empty() {
156 504 : self.step();
157 504 : }
158 1008 : }
159 : }
160 :
161 : impl Drop for Runtime {
162 503 : fn drop(&mut self) {
163 503 : debug!("dropping the runtime");
164 503 : self.crash_all_threads();
165 503 : }
166 : }
167 :
168 : #[derive(Clone)]
169 : pub struct ExternalHandle {
170 : ctx: Arc<ThreadContext>,
171 : }
172 :
173 : impl ExternalHandle {
174 : /// Returns true if thread has finished execution.
175 428278 : pub fn is_finished(&self) -> bool {
176 428278 : let status = self.ctx.mutex.lock();
177 428278 : *status == Status::Finished
178 428278 : }
179 :
180 : /// Returns exitcode and message, which is available after thread has finished execution.
181 422 : pub fn result(&self) -> (i32, String) {
182 422 : let result = self.ctx.result.lock();
183 422 : result.clone()
184 422 : }
185 :
186 : /// Returns thread id.
187 14 : pub fn id(&self) -> u32 {
188 14 : self.ctx.id.load(Ordering::SeqCst)
189 14 : }
190 :
191 : /// Sets a flag to crash thread on the next wakeup.
192 16822 : pub fn crash_stop(&self) {
193 16822 : self.ctx.crash_stop();
194 16822 : }
195 : }
196 :
197 : struct ThreadHandle {
198 : ctx: Arc<ThreadContext>,
199 : _join: JoinHandle<()>,
200 : }
201 :
202 : impl ThreadHandle {
203 : /// Create a new [`ThreadHandle`] and wait until thread will enter [`Status::Sleep`] state.
204 19842 : fn new(ctx: Arc<ThreadContext>, join: JoinHandle<()>) -> Self {
205 19842 : let mut status = ctx.mutex.lock();
206 : // wait until thread will go into the first yield
207 19927 : while *status != Status::Sleep {
208 85 : ctx.condvar.wait(&mut status);
209 85 : }
210 19842 : drop(status);
211 19842 :
212 19842 : Self { ctx, _join: join }
213 19842 : }
214 :
215 : /// Allows thread to execute one step of its execution.
216 : /// Returns [`Status`] of the thread after the step.
217 284959 : fn step(&self) -> Status {
218 284959 : let mut status = self.ctx.mutex.lock();
219 284959 : assert!(matches!(*status, Status::Sleep));
220 :
221 284959 : *status = Status::Running;
222 284959 : self.ctx.condvar.notify_all();
223 :
224 569918 : while *status == Status::Running {
225 284959 : self.ctx.condvar.wait(&mut status);
226 284959 : }
227 :
228 284959 : *status
229 284959 : }
230 : }
231 :
232 : #[derive(Clone, Copy, Debug, PartialEq, Eq)]
233 : enum Status {
234 : /// Thread is running.
235 : Running,
236 : /// Waiting for event to complete, will be resumed by the executor step, once wakeup flag is set.
237 : Sleep,
238 : /// Thread finished execution.
239 : Finished,
240 : }
241 :
242 : const NO_WAKEUP: u8 = 0;
243 : const PENDING_WAKEUP: u8 = 1;
244 :
245 : pub struct ThreadContext {
246 : id: AtomicU32,
247 : // used to block thread until it is woken up
248 : mutex: parking_lot::Mutex<Status>,
249 : condvar: parking_lot::Condvar,
250 : // used as a flag to indicate runtime that thread is ready to be woken up
251 : wakeup: AtomicU8,
252 : clock: OnceLock<Arc<Timing>>,
253 : // execution result, set by exit() call
254 : result: parking_lot::Mutex<(i32, String)>,
255 : // determines if process should be killed on receiving panic
256 : allow_panic: AtomicBool,
257 : // acts as a signal that thread should crash itself on the next wakeup
258 : crash_request: AtomicBool,
259 : }
260 :
261 : impl ThreadContext {
262 20370 : pub(crate) fn new() -> Self {
263 20370 : Self {
264 20370 : id: AtomicU32::new(0),
265 20370 : mutex: parking_lot::Mutex::new(Status::Running),
266 20370 : condvar: parking_lot::Condvar::new(),
267 20370 : wakeup: AtomicU8::new(NO_WAKEUP),
268 20370 : clock: OnceLock::new(),
269 20370 : result: parking_lot::Mutex::new((-1, String::new())),
270 20370 : allow_panic: AtomicBool::new(false),
271 20370 : crash_request: AtomicBool::new(false),
272 20370 : }
273 20370 : }
274 : }
275 :
276 : // Functions for executor to control thread execution.
277 : impl ThreadContext {
278 : /// Set atomic flag to indicate that thread is ready to be woken up.
279 680032 : fn inc_wake(&self) {
280 680032 : self.wakeup.store(PENDING_WAKEUP, Ordering::SeqCst);
281 680032 : }
282 :
283 : /// Internal function used for event queues.
284 179520 : pub(crate) fn schedule_wakeup(self: &Arc<Self>, after_ms: u64) {
285 179520 : self.clock
286 179520 : .get()
287 179520 : .unwrap()
288 179520 : .schedule_wakeup(after_ms, self.clone());
289 179520 : }
290 :
291 1 : fn tid(&self) -> u32 {
292 1 : self.id.load(Ordering::SeqCst)
293 1 : }
294 :
295 19693 : fn crash_stop(&self) {
296 19693 : let status = self.mutex.lock();
297 19693 : if *status == Status::Finished {
298 8 : debug!(
299 0 : "trying to crash thread-{}, which is already finished",
300 0 : self.tid()
301 : );
302 8 : return;
303 19685 : }
304 19685 : assert!(matches!(*status, Status::Sleep));
305 19685 : drop(status);
306 19685 :
307 19685 : self.allow_panic.store(true, Ordering::SeqCst);
308 19685 : self.crash_request.store(true, Ordering::SeqCst);
309 19685 : // set a wakeup
310 19685 : self.inc_wake();
311 : // it will panic on the next wakeup
312 19693 : }
313 : }
314 :
315 : // Internal functions.
316 : impl ThreadContext {
317 : /// Blocks thread until it's woken up by the executor. If `after_ms` is 0, is will be
318 : /// woken on the next step. If `after_ms` > 0, wakeup is scheduled after that time.
319 : /// Otherwise wakeup is not scheduled inside `yield_me`, and should be arranged before
320 : /// calling this function.
321 285017 : fn yield_me(self: &Arc<Self>, after_ms: i64) {
322 285017 : let mut status = self.mutex.lock();
323 285017 : assert!(matches!(*status, Status::Running));
324 :
325 285017 : match after_ms.cmp(&0) {
326 236455 : std::cmp::Ordering::Less => {
327 236455 : // block until something wakes us up
328 236455 : }
329 21397 : std::cmp::Ordering::Equal => {
330 21397 : // tell executor that we are ready to be woken up
331 21397 : self.inc_wake();
332 21397 : }
333 27165 : std::cmp::Ordering::Greater => {
334 27165 : // schedule wakeup
335 27165 : self.clock
336 27165 : .get()
337 27165 : .unwrap()
338 27165 : .schedule_wakeup(after_ms as u64, self.clone());
339 27165 : }
340 : }
341 :
342 285017 : *status = Status::Sleep;
343 285017 : self.condvar.notify_all();
344 :
345 : // wait until executor wakes us up
346 570034 : while *status != Status::Running {
347 285017 : self.condvar.wait(&mut status);
348 285017 : }
349 :
350 285017 : if self.crash_request.load(Ordering::SeqCst) {
351 19334 : panic!("crashed by request");
352 265683 : }
353 265683 : }
354 :
355 : /// Called only once, exactly before thread finishes execution.
356 19784 : fn finish_me(&self) {
357 19784 : let mut status = self.mutex.lock();
358 19784 : assert!(matches!(*status, Status::Running));
359 :
360 19784 : *status = Status::Finished;
361 19784 : {
362 19784 : let mut result = self.result.lock();
363 19784 : if result.0 == -1 {
364 20 : *result = (0, "finished normally".to_owned());
365 19764 : }
366 : }
367 19784 : self.condvar.notify_all();
368 19784 : }
369 : }
370 :
371 : /// Invokes the given closure with a reference to the current thread [`ThreadContext`].
372 : #[inline(always)]
373 1874902 : fn with_thread_context<T>(f: impl FnOnce(&Arc<ThreadContext>) -> T) -> T {
374 1874902 : thread_local!(static THREAD_DATA: Arc<ThreadContext> = Arc::new(ThreadContext::new()));
375 1874902 : THREAD_DATA.with(f)
376 1874902 : }
377 :
378 : /// Waker is used to wake up threads that are blocked on condition.
379 : /// It keeps track of contexts [`Arc<ThreadContext>`] and can increment the counter
380 : /// of several contexts to send a notification.
381 : pub struct Waker {
382 : // contexts that are waiting for a notification
383 : contexts: parking_lot::Mutex<smallvec::SmallVec<[Arc<ThreadContext>; 8]>>,
384 : }
385 :
386 : impl Default for Waker {
387 0 : fn default() -> Self {
388 0 : Self::new()
389 0 : }
390 : }
391 :
392 : impl Waker {
393 80962 : pub fn new() -> Self {
394 80962 : Self {
395 80962 : contexts: parking_lot::Mutex::new(smallvec::SmallVec::new()),
396 80962 : }
397 80962 : }
398 :
399 : /// Subscribe current thread to receive a wake notification later.
400 837030 : pub fn wake_me_later(&self) {
401 837030 : with_thread_context(|ctx| {
402 837030 : self.contexts.lock().push(ctx.clone());
403 837030 : });
404 837030 : }
405 :
406 : /// Wake up all threads that are waiting for a notification and clear the list.
407 124944 : pub fn wake_all(&self) {
408 124944 : let mut v = self.contexts.lock();
409 421176 : for ctx in v.iter() {
410 421176 : ctx.inc_wake();
411 421176 : }
412 124944 : v.clear();
413 124944 : }
414 : }
415 :
416 : /// See [`ThreadContext::yield_me`].
417 265175 : pub fn yield_me(after_ms: i64) {
418 265175 : with_thread_context(|ctx| ctx.yield_me(after_ms))
419 265175 : }
420 :
421 : /// Get current time.
422 712349 : pub fn now() -> u64 {
423 712349 : with_thread_context(|ctx| ctx.clock.get().unwrap().now())
424 712349 : }
425 :
426 430 : pub fn exit(code: i32, msg: String) {
427 430 : with_thread_context(|ctx| {
428 430 : ctx.allow_panic.store(true, Ordering::SeqCst);
429 430 : let mut result = ctx.result.lock();
430 430 : *result = (code, msg);
431 430 : panic!("exit");
432 430 : });
433 430 : }
434 :
435 528 : pub(crate) fn get_thread_ctx() -> Arc<ThreadContext> {
436 528 : with_thread_context(|ctx| ctx.clone())
437 528 : }
438 :
439 : /// Trait for polling channels until they have something.
440 : pub trait PollSome {
441 : /// Schedule wakeup for message arrival.
442 : fn wake_me(&self);
443 :
444 : /// Check if channel has a ready message.
445 : fn has_some(&self) -> bool;
446 : }
447 :
448 : /// Blocks current thread until one of the channels has a ready message. Returns
449 : /// index of the channel that has a message. If timeout is reached, returns None.
450 : ///
451 : /// Negative timeout means block forever. Zero timeout means check channels and return
452 : /// immediately. Positive timeout means block until timeout is reached.
453 106028 : pub fn epoll_chans(chans: &[Box<dyn PollSome>], timeout: i64) -> Option<usize> {
454 106028 : let deadline = if timeout < 0 {
455 77480 : 0
456 : } else {
457 28548 : now() + timeout as u64
458 : };
459 :
460 : loop {
461 1033824 : for chan in chans {
462 834158 : chan.wake_me()
463 : }
464 :
465 670537 : for (i, chan) in chans.iter().enumerate() {
466 670537 : if chan.has_some() {
467 84856 : return Some(i);
468 585681 : }
469 : }
470 :
471 96395 : if timeout < 0 {
472 66473 : // block until wakeup
473 66473 : yield_me(-1);
474 66473 : } else {
475 29922 : let current_time = now();
476 29922 : if current_time >= deadline {
477 2757 : return None;
478 27165 : }
479 27165 :
480 27165 : yield_me((deadline - current_time) as i64);
481 : }
482 : }
483 87613 : }
|
