ax-task 0.6.11

ArceOS task management module
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

//! Tests for the typed kernel timer queue.

use alloc::{boxed::Box, sync::Arc, vec::Vec};
use core::sync::atomic::{AtomicUsize, Ordering};

use super::*;
use crate::sync::SpinLock;

fn deadline(nanos: u64) -> MonotonicDeadline {
    MonotonicDeadline::from_nanos(nanos).unwrap()
}

fn instant(nanos: u64) -> MonotonicInstant {
    MonotonicInstant::from_nanos(nanos).unwrap()
}

#[test]
fn restartable_timer_reuses_identity_until_cancelled() {
    let invocations = Arc::new(AtomicUsize::new(0));
    let callback_invocations = Arc::clone(&invocations);
    let entry = KernelTimerEntry::new_restartable(
        deadline(10),
        Box::new(move |_| {
            let invocation = callback_invocations.fetch_add(1, Ordering::Relaxed) + 1;
            KernelTimerAction::Rearm(deadline(10 + invocation as u64 * 10))
        }),
    )
    .unwrap();
    let mut queue = KernelTimerQueue::new(1);
    let handle = queue.insert(TimerCpuId::new(0), entry).unwrap();

    assert_eq!(queue.expire_due_soft(instant(10), 1).expired(), 1);
    let mut execution = queue.claim_expired().unwrap();
    let action = execution.invoke_soft();
    assert!(queue.complete_soft_execution(execution, action).is_none());
    assert_eq!(queue.next_soft_deadline(), Some(deadline(20)));

    assert_eq!(queue.expire_due_soft(instant(20), 1).expired(), 1);
    let mut execution = queue.claim_expired().unwrap();
    let action = execution.invoke_soft();
    assert!(queue.complete_soft_execution(execution, action).is_none());
    assert_eq!(queue.next_soft_deadline(), Some(deadline(30)));
    assert_eq!(invocations.load(Ordering::Relaxed), 2);

    assert!(matches!(
        queue.cancel(handle),
        KernelTimerQueueCancel::Cancelled(_)
    ));
    assert!(!queue.has_active_work());
}

#[test]
fn cancellation_during_callback_prevents_restart() {
    let entry = KernelTimerEntry::new_restartable(
        deadline(10),
        Box::new(|_| KernelTimerAction::Rearm(deadline(20))),
    )
    .unwrap();
    let mut queue = KernelTimerQueue::new(1);
    let handle = queue.insert(TimerCpuId::new(0), entry).unwrap();
    assert_eq!(queue.expire_due_soft(instant(10), 1).expired(), 1);
    let mut execution = queue.claim_expired().unwrap();

    assert!(matches!(
        queue.cancel(handle),
        KernelTimerQueueCancel::Executing
    ));
    let action = execution.invoke_soft();
    assert!(queue.complete_soft_execution(execution, action).is_some());
    assert!(!queue.has_active_work());
}

#[test]
fn hard_completion_defers_callback_reclamation_to_task_context() {
    let invocations = Arc::new(AtomicUsize::new(0));
    let callback_invocations = Arc::clone(&invocations);
    let callback = unsafe {
        // SAFETY: this test callback performs one bounded atomic operation.
        HardKernelTimerCallback::new(Box::new(move |_| {
            callback_invocations.fetch_add(1, Ordering::Relaxed);
            HardKernelTimerAction::Complete
        }))
    };
    let entry = KernelTimerEntry::new_hard_restartable(deadline(10), callback).unwrap();
    let mut queue = KernelTimerQueue::new(1);
    let handle = queue.insert(TimerCpuId::new(0), entry).unwrap();

    let mut execution = queue.claim_due_hard(instant(10)).unwrap();
    let action = unsafe {
        // SAFETY: the pure queue test models the hard callback transaction.
        execution.invoke_hard()
    };
    assert!(queue.complete_hard_execution(execution, action));
    assert_eq!(invocations.load(Ordering::Relaxed), 1);
    assert!(queue.has_completed());
    assert!(matches!(
        queue.cancel(handle),
        KernelTimerQueueCancel::Stale
    ));

    drop(queue.claim_completed());
    assert!(!queue.has_active_work());
}

#[test]
fn hard_disarm_retains_one_stable_registration_without_reaping() {
    let callback = unsafe {
        // SAFETY: this callback returns one constant action.
        HardKernelTimerCallback::new(Box::new(|_| HardKernelTimerAction::Disarm))
    };
    let entry = KernelTimerEntry::new_hard_restartable(deadline(10), callback).unwrap();
    let mut queue = KernelTimerQueue::new(1);
    let handle = queue.insert(TimerCpuId::new(0), entry).unwrap();

    let mut execution = queue.claim_due_hard(instant(10)).unwrap();
    let action = unsafe {
        // SAFETY: the pure queue test models the hard callback transaction.
        execution.invoke_hard()
    };
    assert!(!queue.complete_hard_execution(execution, action));
    assert!(queue.has_inactive());
    assert!(!queue.has_completed());

    assert!(queue.arm_hard(handle, deadline(20)));
    let mut execution = queue.claim_due_hard(instant(20)).unwrap();
    let action = unsafe {
        // SAFETY: the pure queue test models the second hard transaction.
        execution.invoke_hard()
    };
    assert!(!queue.complete_hard_execution(execution, action));
    assert!(queue.has_inactive());
    assert!(matches!(
        queue.cancel(handle),
        KernelTimerQueueCancel::Cancelled(_)
    ));
    assert!(!queue.has_active_work());
}

#[test]
fn task_arm_while_hard_callback_runs_owns_the_next_deadline() {
    let callback = unsafe {
        // SAFETY: this callback returns one constant action.
        HardKernelTimerCallback::new(Box::new(|_| HardKernelTimerAction::Disarm))
    };
    let entry = KernelTimerEntry::new_hard_restartable(deadline(10), callback).unwrap();
    let mut queue = KernelTimerQueue::new(1);
    let handle = queue.insert(TimerCpuId::new(0), entry).unwrap();

    let mut execution = queue.claim_due_hard(instant(10)).unwrap();
    assert!(queue.arm_hard(handle, deadline(20)));
    let action = unsafe {
        // SAFETY: the pure queue test models the hard callback transaction.
        execution.invoke_hard()
    };
    assert!(!queue.complete_hard_execution(execution, action));
    assert_eq!(queue.next_hard_deadline(), Some(deadline(20)));
}

#[test]
fn equal_deadlines_execute_in_registration_order() {
    let order = Arc::new(SpinLock::new(Vec::new()));
    let mut queue = KernelTimerQueue::new(3);
    for sequence in 0..3 {
        let callback_order = Arc::clone(&order);
        let entry = KernelTimerEntry::new(
            deadline(10),
            Box::new(move |_| callback_order.lock().push(sequence)),
        )
        .unwrap();
        queue.insert(TimerCpuId::new(0), entry).unwrap();
    }

    assert_eq!(queue.expire_due_soft(instant(10), 3).expired(), 3);
    for _ in 0..3 {
        let mut execution = queue.claim_expired().unwrap();
        let action = execution.invoke_soft();
        drop(queue.complete_soft_execution(execution, action));
    }
    assert_eq!(&*order.lock(), &[0, 1, 2]);
}

#[test]
fn expiration_budget_reports_due_work_left_behind() {
    let mut queue = KernelTimerQueue::new(3);
    for _ in 0..3 {
        let entry = KernelTimerEntry::new(deadline(10), Box::new(|_| {})).unwrap();
        queue.insert(TimerCpuId::new(0), entry).unwrap();
    }

    let batch = queue.expire_due_soft(instant(10), 2);
    assert_eq!(batch.expired(), 2);
    assert!(batch.pending());
    assert_eq!(queue.next_soft_deadline(), Some(deadline(10)));
}

#[test]
fn cancelling_the_head_advances_to_the_next_deadline() {
    let mut queue = KernelTimerQueue::new(2);
    let later = KernelTimerEntry::new(deadline(30), Box::new(|_| {})).unwrap();
    let earlier = KernelTimerEntry::new(deadline(10), Box::new(|_| {})).unwrap();
    queue.insert(TimerCpuId::new(0), later).unwrap();
    let earlier_handle = queue.insert(TimerCpuId::new(0), earlier).unwrap();

    assert_eq!(queue.next_soft_deadline(), Some(deadline(10)));
    assert!(matches!(
        queue.cancel(earlier_handle),
        KernelTimerQueueCancel::Cancelled(_)
    ));
    assert_eq!(queue.next_soft_deadline(), Some(deadline(30)));
    assert!(matches!(
        queue.cancel(earlier_handle),
        KernelTimerQueueCancel::Stale
    ));
}

#[test]
fn an_early_hard_edge_does_not_claim_the_registration() {
    let callback = unsafe {
        // SAFETY: this callback returns one constant action.
        HardKernelTimerCallback::new(Box::new(|_| HardKernelTimerAction::Disarm))
    };
    let entry = KernelTimerEntry::new_hard_restartable(deadline(20), callback).unwrap();
    let mut queue = KernelTimerQueue::new(1);
    queue.insert(TimerCpuId::new(0), entry).unwrap();

    assert!(queue.claim_due_hard(instant(19)).is_none());
    assert_eq!(queue.next_hard_deadline(), Some(deadline(20)));
    assert!(queue.claim_due_hard(instant(20)).is_some());
}