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 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
//! A system for polling an array of tasks forever, plus `Notify` and other
//! scheduling tools.
//!
//! **Note:** for our purposes, a _task_ is an independent top-level future
//! managed by the scheduler polling loop. There are a fixed set of tasks,
//! provided to the scheduler at startup. This is distinct from the casual use
//! of "task" to mean a piece of code that runs concurrently with other code;
//! we'll use the term "concurrent process" for this. The fixed set of tasks
//! managed by the scheduler can execute an _arbitrary number_ of concurrent
//! processes.
//!
//! # Scheduler entry point
//!
//! The mechanism for "starting the OS" is [`run_tasks`].
//!
//! # Time
//!
//! (Note: as of 0.3 the timekeeping features are only compiled in if the
//! `systick` feature is present, which it is by default. It turns out the
//! operating system can still be quite useful without it!)
//!
//! The executor uses the timekeeping provided by the [`time`][crate::time]
//! module to enable tasks to be woken at particular times. [`sleep_until`]
//! produces a future that resolves at a particular time, while [`sleep_for`]
//! expresses the time relative to the current time.
//!
//! Those functions can also be used to apply a timeout to any operation; see
//! [`sleep_until`] for more details.
//!
//! For the common case of needing to do an operation periodically, consider
//! [`every_until`] or [`PeriodicGate`], which try to minimize jitter and drift.
//!
//! # Interrupts, wait, and notify
//!
//! So, you've given the OS an array of tasks that need to each be polled
//! forever. The OS could simply poll every task in a big loop (a pattern known
//! in embedded development as a "superloop"), but this has some problems:
//!
//! 1. By constantly checking whether each task can make progress, we keep the
//! CPU running full-tilt, burning power needlessly.
//!
//! 2. Because any given task may have to wait for *every other task* to be
//! polled before it gets control, the minimum response latency to events is
//! increased, possibly by a lot.
//!
//! We can do better.
//!
//! There are, in practice, two reasons why a task might yield.
//!
//! 1. Because it wants to leave room for other tasks to execute during a
//! long-running operation. In this case, we actually *do* want to come right
//! back and poll the task. (To do this, use [`yield_cpu`].)
//!
//! 2. Because it is waiting for an event -- a particular timer tick, an
//! interrupt from a peripheral, a signal from another task, etc. In this
//! case, we don't need to poll the task again *until that event occurs.*
//!
//! The OS tracks a *wake bit* per task. When this bit is set, it means that
//! the task should be polled. Each time through the outer poll loop, the OS
//! will determine which tasks have their wake bits set, *clear the wake bits*,
//! and then poll the tasks.
//!
//! (Tasks might be polled even when their bit isn't set -- this is a waste of
//! energy, but is also something that Rust `Future`s are expected to tolerate.
//! Giving the OS some slack on this dramatically simplifies the implementation.
//! However, the OS tries to poll the smallest feasible set of tasks each time
//! it polls.)
//!
//! The need to set and check wake bits is embodied by the [`Notify`] type,
//! which provides a kind of event broadcast. Tasks can subscribe to a `Notify`,
//! and when it is signaled, all subscribed tasks get their wake bits set.
//!
//! `Notify` is very low level -- the more pleasant abstractions of
//! [`spsc::Queue`][crate::spsc], [`mutex`][crate::mutex], and
//! [`sleep_until`]/[`sleep_for`] are built on top of it. However, `Notify` is
//! the only OS facility that's safe to use from interrupt service routines,
//! making it an ideal way to wake tasks when hardware events occur. See the
//! [`Notify`] docs for an example of using this to handle events from a UART.
//!
//! # Building your own task notification mechanism
//!
//! If `Notify` doesn't meet your needs, you can use the [`wake_task_by_index`]
//! and [`wake_tasks_by_mask`] functions to explicitly wake one or more tasks.
//! Because tasks are required to tolerate spurious wakeups, both of these
//! functions are safe: spamming tasks with wakeup requests merely wastes
//! energy and time.
//!
//! Both of these functions expose the fact that the scheduler tracks wake bits
//! in a single `usize`. When waking a task with index 0 (mask `1 << 0`), we're
//! actually waking any task where `index % 32 == 0`. Very complex systems with
//! greater than 32 top-level tasks will thus experience more spurious wakeups.
//! The advantage of this "lossy" technique is that wake bit manipulation is
//! very, very cheap, and can be done entirely with processor atomic operations.
//!
//! # Idle behavior
//!
//! When no tasks have their wake bits set, the default behavior is to idle the
//! processor using the `WFI` instruction. You can override this behavior by
//! starting the scheduler with [`run_tasks_with_idle`] or (if you're using
//! preemption, below) [`run_tasks_with_preemption_and_idle`], which let you
//! substitute a custom "idle hook" to execute when no tasks are ready.
//!
//! A common use for such an idle hook is to toggle a pin to indicate CPU usage
//! on a logic analyzer, or feed a watchdog.
//!
//! # Adding preemption
//!
//! By default, the scheduler does not preempt task code: task poll routines are
//! run cooperatively, and ISRs are allowed only in between polls. This
//! increases interrupt response latency, because if an event occurs while
//! polling tasks, all polling must complete before the ISR is run. However, it
//! makes the program much easier to reason about, because code is simply never
//! preempted.
//!
//! Applications can change this by starting the scheduler with
//! [`run_tasks_with_preemption`] or [`run_tasks_with_preemption_and_idle`].
//! These entry points let you set a _preemption policy_, which allows ISRs
//! above some priority level to preempt task code. (Tasks still cannot preempt
//! one another.)
use core::convert::Infallible;
use core::future::Future;
use core::mem;
use core::ops::{Add, AddAssign};
use core::pin::Pin;
use core::sync::atomic::{AtomicUsize, Ordering};
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};
use crate::cheap_assert;
use crate::atomic::{AtomicExt, AtomicArithExt};
#[cfg(feature = "systick")]
use crate::list::List;
use crate::time::Millis;
#[cfg(feature = "systick")]
use crate::time::TickTime;
#[cfg(feature = "systick")]
use core::sync::atomic::AtomicPtr;
#[cfg(feature = "systick")]
use core::time::Duration;
/// Accumulates bitmasks from wakers as they are invoked. The executor
/// atomically checks and clears this at each iteration.
static WAKE_BITS: AtomicUsize = AtomicUsize::new(0);
/// Computes the wake bit mask for the task with the given index, which is
/// equivalent to `1 << (index % USIZE_BITS)`.
const fn wake_mask_for_index(index: usize) -> usize {
// Lossy as-cast used here because rotate_left implies a mod by small power
// of 2 (32, 64) and `as u32` implies mod by 2**32, which doesn't change the
// result.
1_usize.rotate_left(index as u32)
}
/// VTable for our wakers. Our wakers store a task notification bitmask in their
/// "pointer" member, and atomically OR it into `WAKE_BITS` when invoked.
static VTABLE: RawWakerVTable = RawWakerVTable::new(
// clone
|p| RawWaker::new(p, &VTABLE),
// wake
|p| wake_tasks_by_mask(p as usize),
// wake_by_ref
|p| wake_tasks_by_mask(p as usize),
// drop
|_| (),
);
/// Produces a `Waker` that will wake *at least* task `index` on invocation.
///
/// Technically, this will wake any task `n` where `n % 32 == index % 32`.
fn waker_for_task(index: usize) -> Waker {
let mask = wake_mask_for_index(index);
// Safety: Waker::from_raw is unsafe because bad things happen if the
// combination of this particular pointer and the functions in the vtable
// don't meet the Waker contract or are incompatible. In our case, our
// vtable functions are actually entirely safe, since we're passing an
// integer as a pointer.
unsafe {
Waker::from_raw(RawWaker::new(mask as *const (), &VTABLE))
}
}
/// Exploits our known Waker structure to extract the notification mask from a
/// Waker.
///
/// If this is applied to a Waker that isn't from this executor (specifically,
/// one not generated by `waker_for_task`), this will cause spurious and almost
/// certainly incorrect wakeups. Currently I don't feel like that risk is great
/// enough to mark ths unsafe -- it can't violate *memory* safety for certain.
///
/// In practice this function compiles down to a single inlined load
/// instruction.
fn extract_mask(waker: &Waker) -> usize {
// Determine whether the pointer member comes first or second within the
// representation of RawWaker. This is currently compile-time simplified
// and goes away.
//
// Safety: we are using `transmute` to inspect the raw composition of a
// Waker. That direction is safe -- it's a fancy version of casting a
// pointer to an integer. Transmuting the _other_ direction would be very
// unsafe.
let ptr_first = unsafe {
let (cell0, _) = mem::transmute::<_, (usize, usize)>(
Waker::from_raw(RawWaker::new(
1234 as *const (),
&VTABLE,
))
);
cell0 == 1234usize
};
// Safety: at the moment, `Waker` consists exactly of a `*const ()` and a
// `&'static RawWakerVTable` (or equivalent pointer), and this is unlikely
// to change. We've already verified above that we can find the parameter
// word, which is what we care about. Extracting it cannot violate memory
// safety, since we're just reading initialized memory.
let waker: *const Waker = waker;
unsafe {
let parts = &*(waker as *const (usize, usize));
if ptr_first {
parts.0
} else {
parts.1
}
}
}
/// Used to construct wakers do nothing, as a placeholder.
static NOOP_VTABLE: RawWakerVTable = RawWakerVTable::new(
|x| RawWaker::new(x, &NOOP_VTABLE), // clone
|_| (), // wake
|_| (), // wake_by_ref
|_| (), // drop
);
/// Returns a [`Waker`] that doesn't do anything and costs nothing to `clone`.
/// This is useful as a placeholder before a *real* `Waker` becomes available.
/// You probably don't need this unless you're building your own wake lists.
pub fn noop_waker() -> Waker {
// Safety: Waker::from_raw is unsafe because the Waker can do weird and
// destructive stuff if either the pointer, or the vtable functions, don't
// meet its contract. Our no-op functions _trivially_ meet its contract.
unsafe {
Waker::from_raw(RawWaker::new(core::ptr::null(), &NOOP_VTABLE))
}
}
/// Polls `future` in a context where the `Waker` will signal the task with
/// index `index`.
fn poll_task(
index: usize,
future: Pin<&mut dyn Future<Output = Infallible>>,
) {
match future.poll(&mut Context::from_waker(&waker_for_task(index))) {
Poll::Pending => (),
Poll::Ready(never) => match never {}
}
}
/// Selects an interrupt control strategy for the scheduler.
#[derive(Copy, Clone, Debug)]
pub enum Interrupts {
/// Use PRIMASK to completely disable interrupts while task code is running.
Masked,
/// Use BASEPRI to mask interrupts of the given priority and lower. This is
/// not available on ARMv6-M.
#[cfg(feature = "has-basepri")]
Filtered(u8),
}
impl Interrupts {
fn scope<R>(self, body: impl FnOnce() -> R) -> R {
let r = match self {
Interrupts::Masked => {
let prev = cortex_m::register::primask::read();
cortex_m::interrupt::disable();
let r = body();
if prev == cortex_m::register::primask::Primask::Active {
// Safety: interrupts were just on, so this won't compromise
// memory safety.
unsafe {
cortex_m::interrupt::enable();
}
}
r
}
#[cfg(feature = "has-basepri")]
Interrupts::Filtered(priority) => {
let prev = cortex_m::register::basepri::read();
cortex_m::register::basepri_max::write(priority);
let r = body();
// Safety: just restoring state
unsafe {
cortex_m::register::basepri::write(prev);
}
r
}
};
// Make sure newly-enabled interrupt handlers fire.
cortex_m::asm::isb();
r
}
}
/// Runs the given futures forever, sleeping when possible. Each future acts as
/// a task, in the sense of `core::task`.
///
/// The futures are defined as returning `!`, which means they won't complete.
///
/// Not all tasks are polled every time through the loop. On the first
/// iteration, only the tasks with a corresponding bit set in `initial_mask` are
/// polled; on subsequent futures, only tasks awoken by the *previous* iteration
/// are called.
///
/// Any time polling completes with *no* tasks awoken, code will never run again
/// unless an interrupt handler wakes tasks using `Notify`. And so, when we
/// detect this condition, we use the `WFI` instruction to idle the processor
/// until an interrupt arrives. This has the advantages of using less power and
/// having more predictable response latency than spinning.
pub fn run_tasks(
futures: &mut [Pin<&mut dyn Future<Output = Infallible>>],
initial_mask: usize,
) -> ! {
// Safety: we're passing Interrupts::Masked, the always-safe option
unsafe {
run_tasks_with_preemption_and_idle(
futures,
initial_mask,
Interrupts::Masked,
cortex_m::asm::wfi,
)
}
}
/// Extended version of `run_tasks` that replaces the default idle behavior
/// (sleeping until the next interrupt) with code of your choosing.
///
/// If you would like the processor to sleep when idle, you will need to call
/// WFI yourself from within the implementation of `idle_hook`.
///
/// See [`run_tasks`] for more details.
pub fn run_tasks_with_idle(
futures: &mut [Pin<&mut dyn Future<Output = Infallible>>],
initial_mask: usize,
idle_hook: impl FnMut(),
) -> ! {
// Safety: we're passing Interrupts::Masked, the always-safe option
unsafe {
run_tasks_with_preemption_and_idle(
futures,
initial_mask,
Interrupts::Masked,
idle_hook,
)
}
}
/// Extended version of `run_tasks` that configures the scheduler with a custom
/// interrupt policy.
///
/// Passing `Interrupts::Masked` here gets the same behavior as `run_tasks`.
///
/// Passing `Interrupts::Filtered(p)` causes the scheduler to only disable
/// interrupts with priority equal to or numerically greater than `p`. This can
/// be used to ensure that the OS systick ISR (priority 0) can preempt
/// long-running tasks.
///
/// # Safety
///
/// This can be used safely as long as ISRs and task code that share data
/// structures use appropriate critical sections.
///
/// In particular, none of the top-level functions in this module are safe to
/// use from an ISR. Only operations on types that are specifically described as
/// being ISR safe, such as `Notify::notify`, can be used from ISRs.
pub unsafe fn run_tasks_with_preemption(
futures: &mut [Pin<&mut dyn Future<Output = Infallible>>],
initial_mask: usize,
interrupts: Interrupts,
) -> ! {
// Safety: this is safe if our own contract is upheld.
unsafe {
run_tasks_with_preemption_and_idle(
futures,
initial_mask,
interrupts,
cortex_m::asm::wfi,
)
}
}
/// Extended version of `run_tasks` that configures the scheduler with a custom
/// interrupt policy and idle hook.
///
/// Passing `Interrupts::Masked` here gets the same behavior as
/// `run_tasks_with_idle`.
///
/// Passing `Interrupts::Filtered(p)` causes the scheduler to only disable
/// interrupts with priority equal to or numerically greater than `p`. This can
/// be used to ensure that the OS systick ISR (priority 0) can preempt
/// long-running tasks.
///
/// # Safety
///
/// This can be used safely as long as ISRs and task code that share data
/// structures use appropriate critical sections.
///
/// In particular, none of the top-level functions in this module are safe to
/// use from an ISR. Only operations on types that are specifically described as
/// being ISR safe, such as `Notify::notify`, can be used from ISRs.
pub unsafe fn run_tasks_with_preemption_and_idle(
futures: &mut [Pin<&mut dyn Future<Output = Infallible>>],
initial_mask: usize,
interrupts: Interrupts,
mut idle_hook: impl FnMut(),
) -> ! {
// Record the task futures for debugger access.
{
// Degrade &mut[] to *mut[]
let futures_ptr: *mut [Pin<&mut dyn Future<Output = Infallible>>] = futures;
// Change interpretation of the Pins; this assumes that &mut and *mut
// have equivalent representation! But we want to store *mut into the
// static because
// 1. It grants no authority without unsafe, so the fact that it aliases
// an array we intend to keep using is nbd.
// 2. It relieves us from having to pretend the array has static
// lifetime, which it does _not._ Casting it to `&'static mut` would
// be wrong.
let futures_ptr: *mut [Pin<*mut dyn Future<Output = Infallible>>] = futures_ptr as _;
// Stash the task future array in a known location.
unsafe {
TASK_FUTURES = Some(futures_ptr);
}
}
WAKE_BITS.store(initial_mask, Ordering::SeqCst);
// TODO make this list static for more predictable memory usage
#[cfg(feature = "systick")]
create_list!(timer_list);
#[cfg(not(feature = "systick"))]
let timer_list = ();
set_timer_list(timer_list, || loop {
interrupts.scope(|| {
#[cfg(feature = "systick")]
{
// Scan for any expired timers.
with_timer_list(|tl| tl.wake_less_than(TickTime::now()));
}
// Capture and reset wake bits, then process any 1s.
// TODO: this loop visits every future testing for 1 bits; it would
// almost certainly be faster to visit the futures corresponding to
// 1 bits instead. I have avoided this for now because of the
// increased complexity.
let mask = WAKE_BITS.swap_polyfill(0, Ordering::SeqCst);
for (i, f) in futures.iter_mut().enumerate() {
if mask & wake_mask_for_index(i) != 0 {
poll_task(i, f.as_mut());
}
}
// If none of the futures woke each other, we're relying on an
// interrupt to set bits -- so we can sleep waiting for it.
if WAKE_BITS.load(Ordering::SeqCst) == 0 {
idle_hook();
}
});
// Now interrupts are enabled for a brief period before diving back in.
// Note that we allow interrupt-wake even when some wake bits are set;
// this prevents ISR starvation by polling tasks.
})
}
/// This `static` variable is only written by the OS, and never read. It exists
/// to be observed from a debugger.
///
/// Without this, it's really hard to figure out where the official list of
/// tasks is. We don't put the list of tasks in a `static` because we can't
/// predict its size (it's up to the client). We don't use this `static` as
/// _our_ sense of the task list because, well, we don't have to.
///
/// The fact that we don't _read_ this variable dodges most lifetime/safety
/// issues.
#[used]
static mut TASK_FUTURES: Option<*mut [Pin<*mut dyn Future<Output = Infallible>>]> = None;
/// Constant that can be passed to `run_tasks` and `wake_tasks_by_mask` to mean
/// "all tasks."
pub const ALL_TASKS: usize = !0;
/// A lightweight task notification scheme that can be used to safely route
/// events from interrupt handlers to task code.
///
/// This is the lowest level inter-task communication type in `lilos`.
///
/// Any number of tasks can [`subscribe`][Notify::subscribe] to a `Notify`. When
/// [`notify`][Notify::notify] is called on it, all those tasks will be awoken
/// (i.e. their `Waker` will be triggered so that they become eligible for
/// polling), and their subscription is atomically ended.
///
/// A `Notify` is very small (the size of a pointer), so feel free to create as
/// many as you like.
///
/// It is safe to call `notify` from an ISR, so this is the usual method by
/// which interrupt handlers inform task code of events. Normally a `Notify`
/// used in this way is stored in a `static`:
///
/// ```ignore
/// static EVENT: Notify = Notify::new();
/// ```
///
/// You can use that style of `static` `Notify` to sleep waiting for interrupt
/// conditions in async code. Here's an example for a made-up but typical UART
/// driver:
///
/// ```ignore
/// /// Event signal for waking task(s) when data arrives.
/// static RX_NOT_EMPTY: Notify = Notify::new();
///
/// /// UART interrupt handler.
/// #[interrupt]
/// fn UART() {
/// let uart = get_uart_peripheral_somehow();
///
/// let control = uart.control.read();
/// let status = uart.status.read();
///
/// if control.rx_irq_enabled() && status.rx_not_empty() {
/// // Shut off the interrupt source to keep this from reoccurring.
/// uart.control.modify(|_, w| w.rx_irq_enabled().clear());
/// // Wake up the task that requested this.
/// RX_NOT_EMPTY.notify();
/// }
/// }
///
/// async fn uart_recv(uart: &Uart) -> u8 {
/// // Enable the rx data interrupt so we get notified.
/// uart.control.modify(|_, w| w.rx_irq_enabled().set());
/// // Listen for data, using a predicate to filter out spurious wakes.
/// RX_NOT_EMPTY.until(|| uart.status.read().rx_not_empty());
///
/// UART.data.read()
/// }
/// ```
///
/// # Waker coalescing
///
/// A `Notify` collects any number of task `Waker`s into a fixed-size structure
/// without heap allocation. It does this by coalescing the `Waker`s such that
/// they may become *imprecise*: firing the waker for task N may also spuriously
/// wake task M. (Implementation-wise, this is a matter of collecting a wake
/// bits mask from the wakers using secret knowledge.)
///
/// While this is often not the *ideal* strategy, it has the advantage that it
/// can be built up cheaply and torn down atomically from interrupt context.
/// (Contrast with e.g. a list of waiting tasks, which is more precise but
/// harder to get right and more expensive at runtime.)
#[derive(Debug, Default)]
pub struct Notify {
mask: AtomicUsize,
}
impl Notify {
/// Creates a new `Notify` with no tasks waiting.
pub const fn new() -> Self {
Self {
mask: AtomicUsize::new(0),
}
}
/// Adds the `Waker` to the set of waiters.
pub fn subscribe(&self, waker: &Waker) {
self.mask.fetch_or_polyfill(extract_mask(waker), Ordering::SeqCst);
}
/// Wakes tasks, at least all those whose waiters have been passed to
/// `subscribe` since the last `notify`, possibly more.
pub fn notify(&self) {
wake_tasks_by_mask(self.mask.swap_polyfill(0, Ordering::SeqCst))
}
/// Repeatedly calls `cond`, completing when it passes. In between calls,
/// subscribes to `self`, so that the task will wake less often and leave
/// CPU available for other things.
///
/// This is appropriate if you know that any change to `cond`'s result will
/// be preceded by some task calling `self.notify()`.
///
/// # Cancellation
///
/// **Cancel safety:** Strict.
///
/// Dropping this future will drop `cond`, and may leave the current task
/// subscribed to `self` (meaning one potential spurious wakeup in the
/// future is possible).
pub fn until<'a, 'b, T: TestResult>(
&'a self,
cond: impl (FnMut() -> T) + 'b,
) -> impl Future<Output = T::Output> + 'a
where
'b: 'a,
{
// TODO: in a future breaking revision, change the public type of until
// to expose the concrete Until type, in case that's useful to someone.
Until {
cond,
notify: self,
}
}
/// Subscribes to `notify` and then calls `cond`, completing if it returns
/// `true`. Otherwise, waits and tries again. This is very similar to
/// `until`, and is slightly more expensive, but in exchange it is correct
/// if the condition may be set asynchronously (i.e. you are running the OS
/// with preemption enabled).
///
/// # Cancellation
///
/// **Cancel safety:** Strict.
///
/// Dropping this future will drop `cond`, and will leave the current task
/// subscribed to `self` (meaning one potential spurious wakeup in the
/// future is possible).
pub fn until_racy<'a, 'b, T: TestResult>(
&'a self,
cond: impl (FnMut() -> T) + 'b,
) -> impl Future<Output = T::Output> + 'a
where
'b: 'a,
{
// TODO: in a future breaking revision, change the public type of
// until_racy to expose the concrete UntilRacy type, in case that's
// useful to someone.
UntilRacy {
cond,
notify: self,
}
}
/// Subscribes to `notify` and blocks until the task is awoken. This may
/// produces spurious wakeups, and is appropriate only when you're checking
/// some condition separately. Otherwise, use `until`.
///
/// # Cancellation
///
/// **Cancel safety:** Strict.
///
/// Dropping this future will leave the current task subscribed to `self`
/// (meaning one potential spurious wakeup in the future is possible).
pub fn until_next(
&self,
) -> impl Future<Output = ()> + '_
{
let mut setup = false;
self.until(move || core::mem::replace(&mut setup, true))
}
}
/// Trait implemented by things that indicate success or failure, to be used
/// with [`Notify::until`] and friends.
///
/// In practice this is `bool` (if there's no output associated with success) or
/// `Option<T>` (if there is).
///
/// This is used by the various polling functions in this module.
pub trait TestResult {
/// Type of content produced on success.
type Output;
/// Converts `self` into an `Option` that is `Some` on success, `None` on
/// failure.
fn into_test_result(self) -> Option<Self::Output>;
}
impl TestResult for bool {
type Output = ();
fn into_test_result(self) -> Option<Self::Output> {
if self {
Some(())
} else {
None
}
}
}
impl<T> TestResult for Option<T> {
type Output = T;
fn into_test_result(self) -> Option<Self::Output> {
self
}
}
/// Internal future type used to implement `Notify::until`. This makes it much
/// easier to recognize the future in a debugger.
struct Until<'n, F> {
cond: F,
notify: &'n Notify,
}
impl<F> Until<'_, F> {
fn cond(self: Pin<&mut Self>) -> &mut F {
// Safety: this is a structural pin projection, safe because cond is
// never treated as pinned.
unsafe { &mut self.get_unchecked_mut().cond }
}
}
impl<F, T> Future for Until<'_, F>
where F: FnMut() -> T,
T: TestResult,
{
type Output = T::Output;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
if let Some(x) = self.as_mut().cond()().into_test_result() {
Poll::Ready(x)
} else {
self.notify.subscribe(cx.waker());
Poll::Pending
}
}
}
/// Internal future type used to implement `Notify::until_racy`. This makes it
/// much easier to recognize the future in a debugger.
struct UntilRacy<'n, F> {
cond: F,
notify: &'n Notify,
}
impl<F> UntilRacy<'_, F> {
fn cond(self: Pin<&mut Self>) -> &mut F {
// Safety: this is a structural pin projection, safe because cond is
// never treated as pinned.
unsafe { &mut self.get_unchecked_mut().cond }
}
}
impl<F, T> Future for UntilRacy<'_, F>
where F: FnMut() -> T,
T: TestResult,
{
type Output = T::Output;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.notify.subscribe(cx.waker());
if let Some(x) = self.as_mut().cond()().into_test_result() {
Poll::Ready(x)
} else {
Poll::Pending
}
}
}
/// Notifies the executor that any tasks whose wake bits are set in `mask`
/// should be polled on the next iteration.
///
/// This is a very low-level operation and is rarely what you want to use. See
/// `Notify`.
#[inline(always)]
pub fn wake_tasks_by_mask(mask: usize) {
WAKE_BITS.fetch_or_polyfill(mask, Ordering::SeqCst);
}
/// Notifies the executor that the task with the given `index` should be polled
/// on the next iteration.
///
/// This operation isn't precise: it may wake other tasks, but it is guaranteed
/// to at least wake the desired task.
#[inline(always)]
pub fn wake_task_by_index(index: usize) {
wake_tasks_by_mask(wake_mask_for_index(index));
}
/// Tracks the timer list currently in scope.
#[cfg(feature = "systick")]
static TIMER_LIST: AtomicPtr<List<TickTime>> =
AtomicPtr::new(core::ptr::null_mut());
/// Panics if called from an interrupt service routine (ISR). This is used to
/// prevent OS features that are unavailable to ISRs from being used in ISRs.
fn assert_not_in_isr() {
let psr_value = cortex_m::register::apsr::read().bits();
// Bottom 9 bits are the exception number, which are 0 in Thread mode.
if psr_value & 0x1FF != 0 {
panic!();
}
}
/// Sets the timer list for the duration of `body`.
///
/// This doesn't nest, and will assert if you try.
#[cfg(feature = "systick")]
#[inline(always)]
fn set_timer_list<R>(
list: Pin<&mut List<TickTime>>,
body: impl FnOnce() -> R,
) -> R {
// Prevent this from being used from interrupt context.
assert_not_in_isr();
let old_list = TIMER_LIST.swap_polyfill(
// Safety: since we've gotten a &mut, we hold the only reference, so
// it's safe for us to smuggle it through a pointer and reborrow it as
// shared.
unsafe { Pin::get_unchecked_mut(list) },
Ordering::Acquire,
);
// Detect weird reentrant uses of this function. This would indicate an
// internal error, or possibly an application being cheeky and calling
// `run_tasks` from within a task. Since this assert should only be checked
// on executor startup, there is no need to optimize it away in release
// builds.
cheap_assert!(old_list.is_null());
let r = body();
// Give up our scoped reference so the caller's &mut has no risk of
// aliasing.
TIMER_LIST.store(core::ptr::null_mut(), Ordering::Release);
r
}
/// No-op definition of `set_timer_list` if the OS has no actual timer list.
#[cfg(not(feature = "systick"))]
#[inline(always)]
fn set_timer_list<X, R>(
_list: X,
body: impl FnOnce() -> R,
) -> R {
body()
}
/// Nabs a reference to the current timer list and executes `body`.
///
/// This provides a safe way to access the timer thread local.
///
/// # Preconditions
///
/// - Must not be called from an interrupt.
/// - Must only be called with a timer list available, which is to say, from
/// within a task.
#[cfg(feature = "systick")]
fn with_timer_list<R>(body: impl FnOnce(Pin<&List<TickTime>>) -> R) -> R {
// Prevent this from being used from interrupt context.
assert_not_in_isr();
let list_ref = {
let tlptr = TIMER_LIST.load(Ordering::Acquire);
// If this assertion fails, it's a sign that one of the timer-aware OS
// primitives (likely a `sleep_*`) has been used without the OS actually
// running.
cheap_assert!(!tlptr.is_null());
// Safety: if it's not null, then it came from a `Pin<&mut>` that we
// have been loaned. We do not treat it as a &mut anywhere, so we can
// safely reborrow it as shared.
unsafe {
Pin::new_unchecked(&*tlptr)
}
};
body(list_ref)
}
/// Sleeps until the system time is equal to or greater than `deadline`.
///
/// More precisely, `sleep_until(d)` returns a `Future` that will poll as
/// `Pending` until `TickTime::now() >= deadline`; then it will poll `Ready`.
///
/// If `deadline` is already in the past, this will instantly become `Ready`.
///
/// Other tools you might consider:
///
/// - If you want to sleep for a relative time interval, consider [`sleep_for`].
/// - If you want to make an action periodic by sleeping in a loop,
/// [`PeriodicGate`] helps avoid common mistakes that cause timing drift and
/// jitter.
///
/// # Imposing a timeout on async code
///
/// This function can be used to delay the current task -- but it can also be
/// used to impose a timeout on any async operation, by using
/// [`select_biased!`](https://docs.rs/futures/latest/futures/macro.select_biased.html)
/// or something similar:
///
/// ```ignore
/// use futures::select_biased;
///
/// select_biased! {
/// result = my_long_running_operation() => {
/// // we finished in time, yay! use result here.
/// }
/// _ = lilos::exec::sleep_until(deadline) => {
/// // we reached the deadline without finishing, the long
/// // running operation is now cancelled.
/// }
/// }
/// ```
///
/// # Preconditions
///
/// This can only be used within a task.
///
/// # Cancellation
///
/// **Cancel safety:** Strict.
///
/// Dropping this future does nothing in particular.
#[cfg(feature = "systick")]
pub async fn sleep_until(deadline: TickTime) {
// TODO: this early return means we can't simply return the insert_and_wait
// future below, which is costing us some bytes of text.
if TickTime::now() >= deadline {
return;
}
crate::create_node!(node, deadline, noop_waker());
// Insert our node into the pending timer list. If we get cancelled, the
// node will detach itself as it's being dropped.
with_timer_list(|tl| tl.insert_and_wait(node.as_mut())).await
}
/// Sleeps until the system time has increased by `d`.
///
/// More precisely, `sleep_for(d)` captures the system time, `t`, and returns a
/// `Future` that will poll as `Pending` until `TickTime::now() >= t + d`; then
/// it will poll `Ready`.
///
/// If `d` is 0, this will instantly become `Ready`.
///
/// `d` can be any type that can be added to a `TickTime`, which in practice
/// means either [`Millis`] or [`Duration`].
///
/// This function is a thin wrapper around [`sleep_until`]. See that function's
/// docs for examples, details, and alternatives.
///
/// # Cancellation
///
/// **Cancel safety:** Strict.
///
/// Dropping this future does nothing in particular.
#[cfg(feature = "systick")]
pub fn sleep_for<D>(d: D) -> impl Future<Output = ()>
where TickTime: Add<D, Output = TickTime>,
{
sleep_until(TickTime::now() + d)
}
/// Returns a future that will be pending exactly once before resolving.
///
/// This can be used to give up CPU to any other tasks that are currently ready
/// to run, and then take it back without waiting for an event.
///
/// # Cancellation
///
/// **Cancel safety:** Strict.
///
/// Dropping this future does nothing in particular.
pub fn yield_cpu() -> impl Future<Output = ()> {
YieldCpu { polled: false }
}
struct YieldCpu {
polled: bool,
}
impl Future for YieldCpu {
type Output = ();
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
if core::mem::replace(&mut self.polled, true) {
Poll::Ready(())
} else {
// Ensure that we get called next round.
cx.waker().wake_by_ref();
Poll::Pending
}
}
}
/// Makes a future periodic, with a termination condition.
///
/// This will evaluate `action` periodically and poll the `Future` that results
/// until it completes before repeating.
///
/// Specifically, `action` will be called immediately, and then every `period`
/// thereafter. If the action future is still being polled when it comes time to
/// call `action` again, the call will be delayed, but will not be skipped.
/// Thus, you may observe rapid repeated calls to `action` to make up for lost
/// time.
///
/// This means that, if your requirement is to ensure that some amount of time
/// elapses *between* operations, this is *not* the right function -- you should
/// just `loop` and call `sleep_for` instead.
///
/// `period` can be any type that can be added to a `TickTime`, which in
/// practice means either [`Millis`] or [`Duration`].
///
/// # Cancellation
///
/// **Cancel safety:** Strict with caveat about nested future.
///
/// Dropping this future will cancel any in-progress future previously returned
/// from `action`, as well as dropping `action` itself. If the future produced
/// by `action` is not cancel-safe, `every_until` will not fix that.
#[cfg(feature = "systick")]
pub async fn every_until<D, F>(period: D, mut action: impl FnMut() -> F)
where
F: Future<Output = bool>,
TickTime: AddAssign<D>,
D: Copy,
{
let mut next = TickTime::now();
loop {
sleep_until(next).await;
if action().await {
break;
}
next += period;
}
}
/// Helper for doing something periodically, accurately.
///
/// A `PeriodicGate` can be used to *gate* (pause) execution of a task until a
/// point in time arrives; that point in time is *periodic*, meaning it repeats
/// at regular intervals. For example, to call the function `f` every 30
/// milliseconds, you would write:
///
/// ```ignore
/// let gate = PeriodicGate::from(Millis(30));
/// loop {
/// f();
/// gate.next_time().await;
/// }
/// ```
///
/// This will maintain the 30-millisecond interval consistently, even if `f()`
/// takes several milliseconds to run, and even if `f()` is sometimes fast and
/// sometimes slow. (If `f` sometimes takes more than 30 milliseconds, the next
/// execution will happen later than normal -- there's not a lot we can do about
/// that. However, as soon as calls to `f` take less than 30 milliseconds, we'll
/// return to the normal periodic timing.)
///
/// This is often, but not always, what you want in a timing loop.
///
/// - `PeriodicGate` has "catch-up" behavior that might not be what you want: if
/// one execution takes (say) 5 times longer than the chosen period, it will
/// frantically run 4 more just after it to "catch up." This attempts to
/// maintain a constant number of executions per unit time, but that might not
/// be what you want.
///
/// - [`sleep_for`] can ensure a minimum delay _between_ operations, which is
/// different from `PeriodicGate`'s behavior.
#[derive(Debug)]
#[cfg(feature = "systick")]
pub struct PeriodicGate {
interval: Millis,
next: TickTime,
}
#[cfg(feature = "systick")]
impl From<Duration> for PeriodicGate {
fn from(d: Duration) -> Self {
PeriodicGate {
interval: Millis(d.as_millis() as u64),
next: TickTime::now(),
}
}
}
#[cfg(feature = "systick")]
impl From<Millis> for PeriodicGate {
/// Creates a periodic gate that can be used to release execution every
/// `interval`, starting right now.
fn from(interval: Millis) -> Self {
PeriodicGate {
interval,
next: TickTime::now(),
}
}
}
#[cfg(feature = "systick")]
impl PeriodicGate {
/// Creates a periodic gate that can be used to release execution every
/// `interval`, starting `delay` ticks in the future.
///
/// This can be useful for creating multiple periodic gates that operate out
/// of phase with respect to each other.
pub fn new_shift(interval: Millis, delay: Millis) -> Self {
PeriodicGate {
interval,
next: TickTime::now() + delay,
}
}
/// Returns a future that will resolve when it's time to execute again.
///
/// # Cancellation
///
/// **Cancel safety:** Strict.
///
/// Dropping this future does nothing in particular.
pub async fn next_time(&mut self) {
sleep_until(self.next).await;
self.next += self.interval;
}
}