Kernel alarms can run in IRQ or RKM context
[akaros.git] / kern / src / alarm.c
1 /* Copyright (c) 2011 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Alarms.  This includes various ways to sleep for a while or defer work on a
6  * specific timer.  These can be per-core, global or whatever.  Like with most
7  * systems, you won't wake up til after the time you specify. (for now, this
8  * might change).
9  *
10  * TODO:
11  *      - have a kernel sense of time, instead of just the TSC or whatever timer the
12  *      chain uses...
13  *      - coalesce or otherwise deal with alarms that are close to cut down on
14  *      interrupt overhead. */
15
16 #include <ros/common.h>
17 #include <sys/queue.h>
18 #include <kthread.h>
19 #include <alarm.h>
20 #include <stdio.h>
21 #include <smp.h>
22
23 /* Helper, resets the earliest/latest times, based on the elements of the list.
24  * If the list is empty, we set the times to be the 12345 poison time.  Since
25  * the list is empty, the alarm shouldn't be going off. */
26 static void reset_tchain_times(struct timer_chain *tchain)
27 {
28         if (TAILQ_EMPTY(&tchain->waiters)) {
29                 tchain->earliest_time = ALARM_POISON_TIME;
30                 tchain->latest_time = ALARM_POISON_TIME;
31         } else {
32                 tchain->earliest_time = TAILQ_FIRST(&tchain->waiters)->wake_up_time;
33                 tchain->latest_time =
34                         TAILQ_LAST(&tchain->waiters, awaiters_tailq)->wake_up_time;
35         }
36 }
37
38 /* One time set up of a tchain, currently called in per_cpu_init() */
39 void init_timer_chain(struct timer_chain *tchain,
40                       void (*set_interrupt) (uint64_t, struct timer_chain *))
41 {
42         spinlock_init_irqsave(&tchain->lock);
43         TAILQ_INIT(&tchain->waiters);
44         tchain->set_interrupt = set_interrupt;
45         reset_tchain_times(tchain);
46 }
47
48 /* Initializes a new awaiter.  Pass 0 for the function if you want it to be a
49  * kthread-alarm, and sleep on it after you set the alarm later. */
50 static void __init_awaiter(struct alarm_waiter *waiter)
51 {
52         waiter->wake_up_time = ALARM_POISON_TIME;
53         waiter->on_tchain = FALSE;
54         if (!waiter->has_func)
55                 sem_init_irqsave(&waiter->sem, 0);
56 }
57
58 void init_awaiter(struct alarm_waiter *waiter,
59                   void (*func) (struct alarm_waiter *awaiter))
60 {
61         waiter->irq_ok = FALSE;
62         waiter->has_func = func ? TRUE : FALSE;
63         waiter->func = func;                    /* if !func, this is a harmless zeroing */
64         __init_awaiter(waiter);
65 }
66
67 void init_awaiter_irq(struct alarm_waiter *waiter,
68                       void (*func_irq) (struct alarm_waiter *awaiter,
69                                         struct hw_trapframe *hw_tf))
70 {
71         waiter->irq_ok = TRUE;
72         waiter->has_func = func_irq ? TRUE : FALSE;
73         waiter->func_irq = func_irq;    /* if !func, this is a harmless zeroing */
74         __init_awaiter(waiter);
75 }
76
77 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
78  * the alarm to go off. */
79 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
80 {
81         waiter->wake_up_time = abs_time;
82 }
83
84 /* Give this a relative time from now, in microseconds.  This might be easier to
85  * use than dealing with the TSC. */
86 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
87 {
88         uint64_t now, then;
89         now = read_tsc();
90         then = now + usec2tsc(usleep);
91         /* This will go off if we wrap-around the TSC.  It'll never happen for legit
92          * values, but this might catch some bugs with large usleeps. */
93         assert(now <= then);
94         set_awaiter_abs(waiter, then);
95 }
96
97 /* Increment the timer that was already set, so that it goes off usleep usec
98  * from the previous tick.  This is different than 'rel' in that it doesn't care
99  * about when 'now' is. */
100 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
101 {
102         assert(waiter->wake_up_time != ALARM_POISON_TIME);
103         waiter->wake_up_time += usec2tsc(usleep);
104 }
105
106 /* Helper, makes sure the interrupt is turned on at the right time.  Most of the
107  * heavy lifting is in the timer-source specific function pointer. */
108 static void reset_tchain_interrupt(struct timer_chain *tchain)
109 {
110         assert(!irq_is_enabled());
111         if (TAILQ_EMPTY(&tchain->waiters)) {
112                 /* Turn it off */
113                 printd("Turning alarm off\n");
114                 tchain->set_interrupt(0, tchain);
115         } else {
116                 /* Make sure it is on and set to the earliest time */
117                 assert(tchain->earliest_time != ALARM_POISON_TIME);
118                 /* TODO: check for times in the past or very close to now */
119                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
120                 tchain->set_interrupt(tchain->earliest_time, tchain);
121         }
122 }
123
124 static void __run_awaiter(uint32_t srcid, long a0, long a1, long a2)
125 {
126         struct alarm_waiter *waiter = (struct alarm_waiter*)a0;
127         waiter->func(waiter);
128 }
129
130 /* When an awaiter's time has come, this gets called.  If it was a kthread, it
131  * will wake up.  o/w, it will call the func ptr stored in the awaiter. */
132 static void wake_awaiter(struct alarm_waiter *waiter,
133                          struct hw_trapframe *hw_tf)
134 {
135         if (waiter->has_func) {
136                 if (waiter->irq_ok)
137                         waiter->func_irq(waiter, hw_tf);
138                 else
139                         send_kernel_message(core_id(), __run_awaiter, (long)waiter,
140                                             0, 0, KMSG_ROUTINE);
141         } else {
142                 sem_up(&waiter->sem); /* IRQs are disabled, can call sem_up directly */
143         }
144 }
145
146 /* This is called when an interrupt triggers a tchain, and needs to wake up
147  * everyone whose time is up.  Called from IRQ context. */
148 void __trigger_tchain(struct timer_chain *tchain, struct hw_trapframe *hw_tf)
149 {
150         struct alarm_waiter *i, *temp;
151         uint64_t now = read_tsc();
152         bool changed_list = FALSE;
153         /* why do we disable irqs here?  the lock is irqsave, but we (think we) know
154          * the timer IRQ for this tchain won't fire again.  disabling irqs is nice
155          * for the lock debugger.  i don't want to disable the debugger completely,
156          * and we can't make the debugger ignore irq context code either in the
157          * general case.  it might be nice for handlers to have IRQs disabled too.*/
158         spin_lock_irqsave(&tchain->lock);
159         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
160                 printd("Trying to wake up %p who is due at %llu and now is %llu\n",
161                        i, i->wake_up_time, now);
162                 /* TODO: Could also do something in cases where we're close to now */
163                 if (i->wake_up_time <= now) {
164                         changed_list = TRUE;
165                         i->on_tchain = FALSE;
166                         TAILQ_REMOVE(&tchain->waiters, i, next);
167                         cmb();  /* enforce waking after removal */
168                         /* Don't touch the waiter after waking it, since it could be in use
169                          * on another core (and the waiter can be clobbered as the kthread
170                          * unwinds its stack).  Or it could be kfreed */
171                         wake_awaiter(i, hw_tf);
172                 } else {
173                         break;
174                 }
175         }
176         if (changed_list) {
177                 reset_tchain_times(tchain);
178         }
179         /* Need to reset the interrupt no matter what */
180         reset_tchain_interrupt(tchain);
181         spin_unlock_irqsave(&tchain->lock);
182 }
183
184 /* Helper, inserts the waiter into the tchain, returning TRUE if we still need
185  * to reset the tchain interrupt.  Caller holds the lock. */
186 static bool __insert_awaiter(struct timer_chain *tchain,
187                              struct alarm_waiter *waiter)
188 {
189         struct alarm_waiter *i, *temp;
190         /* This will fail if you don't set a time */
191         assert(waiter->wake_up_time != ALARM_POISON_TIME);
192         assert(!waiter->on_tchain);
193         waiter->on_tchain = TRUE;
194         /* Either the list is empty, or not. */
195         if (TAILQ_EMPTY(&tchain->waiters)) {
196                 tchain->earliest_time = waiter->wake_up_time;
197                 tchain->latest_time = waiter->wake_up_time;
198                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
199                 /* Need to turn on the timer interrupt later */
200                 return TRUE;
201         }
202         /* If not, either we're first, last, or in the middle.  Reset the interrupt
203          * and adjust the tchain's times accordingly. */
204         if (waiter->wake_up_time < tchain->earliest_time) {
205                 tchain->earliest_time = waiter->wake_up_time;
206                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
207                 /* Changed the first entry; we'll need to reset the interrupt later */
208                 return TRUE;
209         }
210         /* If there is a tie for last, the newer one will really go last.  We need
211          * to handle equality here since the loop later won't catch it. */
212         if (waiter->wake_up_time >= tchain->latest_time) {
213                 tchain->latest_time = waiter->wake_up_time;
214                 /* Proactively put it at the end if we know we're last */
215                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
216                 return FALSE;
217         }
218         /* Insert before the first one you are earlier than.  This won't scale well
219          * (TODO) if we have a lot of inserts.  The proactive insert_tail up above
220          * will help a bit. */
221         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
222                 if (waiter->wake_up_time < i->wake_up_time) {
223                         TAILQ_INSERT_BEFORE(i, waiter, next);
224                         return FALSE;
225                 }
226         }
227         panic("Could not find a spot for awaiter %p\n", waiter);
228 }
229
230 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
231  * later.  This version assumes you have the lock held.  That only makes sense
232  * from alarm handlers, which are called with this lock held from IRQ context */
233 void __set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
234 {
235         if (__insert_awaiter(tchain, waiter))
236                 reset_tchain_interrupt(tchain);
237 }
238
239 /* Sets the alarm.  Don't call this from an alarm handler, since you already
240  * have the lock held.  Call __set_alarm() instead. */
241 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
242 {
243         spin_lock_irqsave(&tchain->lock);
244         __set_alarm(tchain, waiter);
245         spin_unlock_irqsave(&tchain->lock);
246 }
247
248 /* Helper, rips the waiter from the tchain, knowing that it is on the list.
249  * Returns TRUE if the tchain interrupt needs to be reset.  Callers hold the
250  * lock. */
251 static bool __remove_awaiter(struct timer_chain *tchain,
252                              struct alarm_waiter *waiter)
253 {
254         struct alarm_waiter *temp;
255         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
256         /* Need to make sure earliest and latest are set, in case we're mucking with
257          * the first and/or last element of the chain. */
258         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
259                 temp = TAILQ_NEXT(waiter, next);
260                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
261                 reset_int = TRUE;               /* we'll need to reset the timer later */
262         }
263         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
264                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
265                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
266         }
267         TAILQ_REMOVE(&tchain->waiters, waiter, next);
268         waiter->on_tchain = FALSE;
269         return reset_int;
270 }
271
272 /* Removes waiter from the tchain before it goes off.  Returns TRUE if we
273  * disarmed before the alarm went off, FALSE if it already fired. */
274 bool unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
275 {
276         spin_lock_irqsave(&tchain->lock);
277         if (!waiter->on_tchain) {
278                 /* the alarm has already gone off.  its not even on this tchain's list,
279                  * though the concurrent change to on_tchain (specifically, the setting
280                  * of it to FALSE), happens under the tchain's lock. */
281                 spin_unlock_irqsave(&tchain->lock);
282                 return FALSE;
283         }
284         if (__remove_awaiter(tchain, waiter))
285                 reset_tchain_interrupt(tchain);
286         spin_unlock_irqsave(&tchain->lock);
287         return TRUE;
288 }
289
290 /* waiter may be on the tchain, or it might have fired already and be off the
291  * tchain.  Either way, this will put the waiter on the list, set to go off at
292  * abs_time.  If you know the alarm has fired, don't call this.  Just set the
293  * awaiter, and then set_alarm() */
294 void reset_alarm_abs(struct timer_chain *tchain, struct alarm_waiter *waiter,
295                      uint64_t abs_time)
296 {
297         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
298         spin_lock_irqsave(&tchain->lock);
299         /* We only need to remove/unset when the alarm has not fired yet (is still
300          * on the tchain).  If it has fired, it's like a fresh insert */
301         if (waiter->on_tchain)
302                 reset_int = __remove_awaiter(tchain, waiter);
303         set_awaiter_abs(waiter, abs_time);
304         /* regardless, we need to be reinserted */
305         if (__insert_awaiter(tchain, waiter) || reset_int)
306                 reset_tchain_interrupt(tchain);
307         spin_unlock_irqsave(&tchain->lock);
308 }
309
310 /* Attempts to sleep on the alarm.  Could fail if you aren't allowed to kthread
311  * (process limit, etc).  Don't call it on a waiter that is an event-handler. */
312 int sleep_on_awaiter(struct alarm_waiter *waiter)
313 {
314         int8_t irq_state = 0;
315         if (waiter->has_func)
316                 panic("Tried blocking on a waiter %p with a func %p!", waiter,
317                       waiter->func);
318         /* Put the kthread to sleep.  TODO: This can fail (or at least it will be
319          * able to in the future) and we'll need to handle that. */
320         sem_down_irqsave(&waiter->sem, &irq_state);
321         return 0;
322 }
323
324 /* Sets the Alarm interrupt, per-core style.  Also is an example of what any
325  * similar function needs to do (this is the func ptr in the tchain). 
326  * Note the tchain is our per-core one, and we don't need tchain passed to us to
327  * figure that out.  It's kept around in case other tchain-usage wants it -
328  * might not be necessary in the future.
329  *
330  * Needs to set the interrupt to trigger tchain at the given time, or disarm it
331  * if time is 0.   Any function like this needs to do a few things:
332  *      - Make sure the interrupt is on and will go off when we want
333  *      - Make sure the interrupt source can find tchain
334  *      - Make sure the interrupt handler calls __trigger_tchain(tchain)
335  *      - Make sure you don't clobber an old tchain here (a bug) 
336  * This implies the function knows how to find its timer source/void
337  *
338  * Called with the tchain lock held, and IRQs disabled.  However, we could be
339  * calling this cross-core, and we cannot disable those IRQs (hence the
340  * locking). */
341 void set_pcpu_alarm_interrupt(uint64_t time, struct timer_chain *tchain)
342 {
343         uint64_t rel_usec, now;
344         int pcoreid = core_id();
345         struct per_cpu_info *rem_pcpui, *pcpui = &per_cpu_info[pcoreid];
346         struct timer_chain *pcpui_tchain = &pcpui->tchain;
347
348         if (pcpui_tchain != tchain) {
349                 /* cross-core call.  we can simply send an alarm IRQ.  the alarm handler
350                  * will reset its pcpu timer, based on its current lists.  they take an
351                  * extra IRQ, but it gets the job done. */
352                 rem_pcpui = (struct per_cpu_info*)((uintptr_t)tchain -
353                                     offsetof(struct per_cpu_info, tchain));
354                 /* TODO: using the LAPIC vector is a bit ghetto, since that's x86.  But
355                  * RISCV ignores the vector field, and we don't have a global IRQ vector
356                  * namespace or anything. */
357                 send_ipi(rem_pcpui - &per_cpu_info[0], IdtLAPIC_TIMER);
358                 return;
359         }
360         if (time) {
361                 /* Arm the alarm.  For times in the past, we just need to make sure it
362                  * goes off. */
363                 now = read_tsc();
364                 if (time <= now)
365                         rel_usec = 1;
366                 else
367                         rel_usec = tsc2usec(time - now);
368                 rel_usec = MAX(rel_usec, 1);
369                 printd("Setting alarm for %llu, it is now %llu, rel_time %llu "
370                        "tchain %p\n", time, now, rel_usec, pcpui_tchain);
371                 set_core_timer(rel_usec, FALSE);
372         } else  {
373                 /* Disarm */
374                 set_core_timer(0, FALSE);
375         }
376 }
377
378 /* Debug helpers */
379
380 void print_chain(struct timer_chain *tchain)
381 {
382         struct alarm_waiter *i;
383         spin_lock_irqsave(&tchain->lock);
384         printk("Chain %p is%s empty, early: %llu latest: %llu\n", tchain,
385                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
386                tchain->earliest_time,
387                tchain->latest_time);
388         TAILQ_FOREACH(i, &tchain->waiters, next) {
389                 struct kthread *kthread = TAILQ_FIRST(&i->sem.waiters);
390                 printk("\tWaiter %p, time: %llu, kthread: %p (%p) %s\n", i,
391                        i->wake_up_time, kthread, (kthread ? kthread->proc : 0),
392                        (kthread ? kthread->name : 0));
393
394         }
395         spin_unlock_irqsave(&tchain->lock);
396 }
397
398 /* Prints all chains, rather verbosely */
399 void print_pcpu_chains(void)
400 {
401         struct timer_chain *pcpu_chain;
402         printk("PCPU Chains:  It is now %llu\n", read_tsc());
403
404         for (int i = 0; i < num_cpus; i++) {
405                 pcpu_chain = &per_cpu_info[i].tchain;
406                 print_chain(pcpu_chain);
407         }
408 }