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