Remove "early routine kmsg" 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 ways to defer work on a specific timer.  These can be
6  * per-core, global or whatever.  Like with most systems, you won't wake up til
7  * after the time you specify. (for now, this might change).
8  *
9  * TODO:
10  *      - have a kernel sense of time, instead of just the TSC or whatever timer the
11  *      chain uses...
12  *      - coalesce or otherwise deal with alarms that are close to cut down on
13  *      interrupt overhead. */
14
15 #include <ros/common.h>
16 #include <sys/queue.h>
17 #include <kthread.h>
18 #include <alarm.h>
19 #include <stdio.h>
20 #include <smp.h>
21 #include <kmalloc.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)(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 static void __init_awaiter(struct alarm_waiter *waiter)
49 {
50         waiter->wake_up_time = ALARM_POISON_TIME;
51         waiter->on_tchain = FALSE;
52         waiter->holds_tchain_lock = FALSE;
53 }
54
55 void init_awaiter(struct alarm_waiter *waiter,
56                   void (*func) (struct alarm_waiter *awaiter))
57 {
58         waiter->irq_ok = FALSE;
59         assert(func);
60         waiter->func = func;
61         __init_awaiter(waiter);
62         cv_init(&waiter->rkm_cv);
63 }
64
65 void init_awaiter_irq(struct alarm_waiter *waiter,
66                       void (*func_irq) (struct alarm_waiter *awaiter,
67                                         struct hw_trapframe *hw_tf))
68 {
69         waiter->irq_ok = TRUE;
70         assert(func_irq);
71         waiter->func_irq = func_irq;
72         __init_awaiter(waiter);
73 }
74
75 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
76  * the alarm to go off. */
77 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
78 {
79         waiter->wake_up_time = abs_time;
80 }
81
82 /* Give this a relative time from now, in microseconds.  This might be easier to
83  * use than dealing with the TSC. */
84 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
85 {
86         uint64_t now, then;
87         now = read_tsc();
88         then = now + usec2tsc(usleep);
89         /* This will go off if we wrap-around the TSC.  It'll never happen for legit
90          * values, but this might catch some bugs with large usleeps. */
91         assert(now <= then);
92         set_awaiter_abs(waiter, then);
93 }
94
95 /* Increment the timer that was already set, so that it goes off usleep usec
96  * from the previous tick.  This is different than 'rel' in that it doesn't care
97  * about when 'now' is. */
98 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
99 {
100         assert(waiter->wake_up_time != ALARM_POISON_TIME);
101         waiter->wake_up_time += usec2tsc(usleep);
102 }
103
104 /* Helper, makes sure the interrupt is turned on at the right time.  Most of the
105  * heavy lifting is in the timer-source specific function pointer. */
106 static void reset_tchain_interrupt(struct timer_chain *tchain)
107 {
108         assert(!irq_is_enabled());
109         if (TAILQ_EMPTY(&tchain->waiters)) {
110                 /* Turn it off */
111                 printd("Turning alarm off\n");
112                 tchain->set_interrupt(tchain);
113         } else {
114                 /* Make sure it is on and set to the earliest time */
115                 assert(tchain->earliest_time != ALARM_POISON_TIME);
116                 /* TODO: check for times in the past or very close to now */
117                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
118                 tchain->set_interrupt(tchain);
119         }
120 }
121
122 static void __run_awaiter(uint32_t srcid, long a0, long a1, long a2)
123 {
124         struct alarm_waiter *waiter = (struct alarm_waiter*)a0;
125
126         waiter->func(waiter);
127         cv_lock(&waiter->rkm_cv);
128         /* This completes the alarm's function.  We don't need to sync with
129          * wake_waiter, we happen after.  We do need to sync with unset_alarm. */
130         waiter->rkm_pending = FALSE;
131         /* broadcast, instead of signal.  This allows us to have multiple unsetters
132          * concurrently.  (only one of which will succeed, so YMMV.) */
133         __cv_broadcast(&waiter->rkm_cv);
134         cv_unlock(&waiter->rkm_cv);
135 }
136
137 static void wake_awaiter(struct alarm_waiter *waiter,
138                          struct hw_trapframe *hw_tf)
139 {
140         if (waiter->irq_ok) {
141                 waiter->holds_tchain_lock = TRUE;
142                 waiter->func_irq(waiter, hw_tf);
143                 waiter->holds_tchain_lock = FALSE;
144         } else {
145                 /* The alarm is in limbo and is uncancellable from now (IRQ ctx, tchain
146                  * lock held) until it finishes. */
147                 waiter->rkm_pending = TRUE;
148                 send_kernel_message(core_id(), __run_awaiter, (long)waiter,
149                                     0, 0, KMSG_ROUTINE);
150         }
151 }
152
153 /* This is called when an interrupt triggers a tchain, and needs to wake up
154  * everyone whose time is up.  Called from IRQ context. */
155 void __trigger_tchain(struct timer_chain *tchain, struct hw_trapframe *hw_tf)
156 {
157         struct alarm_waiter *i, *temp;
158         uint64_t now = read_tsc();
159
160         /* why do we disable irqs here?  the lock is irqsave, but we (think we) know
161          * the timer IRQ for this tchain won't fire again.  disabling irqs is nice
162          * for the lock debugger.  i don't want to disable the debugger completely,
163          * and we can't make the debugger ignore irq context code either in the
164          * general case.  it might be nice for handlers to have IRQs disabled too.*/
165         spin_lock_irqsave(&tchain->lock);
166         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
167                 printd("Trying to wake up %p who is due at %llu and now is %llu\n",
168                        i, i->wake_up_time, now);
169                 /* TODO: Could also do something in cases where we're close to now */
170                 if (i->wake_up_time <= now) {
171                         i->on_tchain = FALSE;
172                         TAILQ_REMOVE(&tchain->waiters, i, next);
173                         /* Need to reset after each removal, in case the handler sets the
174                          * alarm again and the earliest/latest times are wrong. */
175                         reset_tchain_times(tchain);
176                         cmb();  /* enforce waking after removal */
177                         /* Don't touch the waiter after waking it, since it could be in use
178                          * on another core (and the waiter can be clobbered as the kthread
179                          * unwinds its stack).  Or it could be kfreed */
180                         wake_awaiter(i, hw_tf);
181                 } else {
182                         break;
183                 }
184         }
185         /* Need to reset the interrupt no matter what */
186         reset_tchain_interrupt(tchain);
187         spin_unlock_irqsave(&tchain->lock);
188 }
189
190 /* Helper, inserts the waiter into the tchain, returning TRUE if we still need
191  * to reset the tchain interrupt.  Caller holds the lock. */
192 static bool __insert_awaiter(struct timer_chain *tchain,
193                              struct alarm_waiter *waiter)
194 {
195         struct alarm_waiter *i, *temp;
196         /* This will fail if you don't set a time */
197         assert(waiter->wake_up_time != ALARM_POISON_TIME);
198         assert(!waiter->on_tchain);
199         waiter->on_tchain = TRUE;
200         /* Either the list is empty, or not. */
201         if (TAILQ_EMPTY(&tchain->waiters)) {
202                 tchain->earliest_time = waiter->wake_up_time;
203                 tchain->latest_time = waiter->wake_up_time;
204                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
205                 /* Need to turn on the timer interrupt later */
206                 return TRUE;
207         }
208         /* If not, either we're first, last, or in the middle.  Reset the interrupt
209          * and adjust the tchain's times accordingly. */
210         if (waiter->wake_up_time < tchain->earliest_time) {
211                 tchain->earliest_time = waiter->wake_up_time;
212                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
213                 /* Changed the first entry; we'll need to reset the interrupt later */
214                 return TRUE;
215         }
216         /* If there is a tie for last, the newer one will really go last.  We need
217          * to handle equality here since the loop later won't catch it. */
218         if (waiter->wake_up_time >= tchain->latest_time) {
219                 tchain->latest_time = waiter->wake_up_time;
220                 /* Proactively put it at the end if we know we're last */
221                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
222                 return FALSE;
223         }
224         /* Insert before the first one you are earlier than.  This won't scale well
225          * (TODO) if we have a lot of inserts.  The proactive insert_tail up above
226          * will help a bit. */
227         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
228                 if (waiter->wake_up_time < i->wake_up_time) {
229                         TAILQ_INSERT_BEFORE(i, waiter, next);
230                         return FALSE;
231                 }
232         }
233         panic("Could not find a spot for awaiter %p\n", waiter);
234 }
235
236 static void __set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
237 {
238         assert(!waiter->on_tchain);
239         if (__insert_awaiter(tchain, waiter))
240                 reset_tchain_interrupt(tchain);
241 }
242
243 static void __set_alarm_irq(struct timer_chain *tchain,
244                             struct alarm_waiter *waiter)
245 {
246         /* holds_tchain_lock is set when we're called from an alarm handler */
247         if (waiter->holds_tchain_lock) {
248                 __set_alarm(tchain, waiter);
249         } else {
250                 spin_lock_irqsave(&tchain->lock);
251                 __set_alarm(tchain, waiter);
252                 spin_unlock_irqsave(&tchain->lock);
253         }
254 }
255
256 static void __set_alarm_rkm(struct timer_chain *tchain,
257                             struct alarm_waiter *waiter)
258 {
259         spin_lock_irqsave(&tchain->lock);
260         __set_alarm(tchain, waiter);
261         spin_unlock_irqsave(&tchain->lock);
262 }
263
264 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
265  * later. */
266 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
267 {
268         if (waiter->irq_ok)
269                 return __set_alarm_irq(tchain, waiter);
270         else
271                 return __set_alarm_rkm(tchain, waiter);
272 }
273
274 /* Helper, rips the waiter from the tchain, knowing that it is on the list.
275  * Returns TRUE if the tchain interrupt needs to be reset.  Callers hold the
276  * lock. */
277 static bool __remove_awaiter(struct timer_chain *tchain,
278                              struct alarm_waiter *waiter)
279 {
280         struct alarm_waiter *temp;
281         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
282         /* Need to make sure earliest and latest are set, in case we're mucking with
283          * the first and/or last element of the chain. */
284         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
285                 temp = TAILQ_NEXT(waiter, next);
286                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
287                 reset_int = TRUE;               /* we'll need to reset the timer later */
288         }
289         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
290                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
291                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
292         }
293         TAILQ_REMOVE(&tchain->waiters, waiter, next);
294         waiter->on_tchain = FALSE;
295         return reset_int;
296 }
297
298 static bool __unset_alarm_irq(struct timer_chain *tchain,
299                               struct alarm_waiter *waiter)
300 {
301         bool was_on_chain = FALSE;
302
303         /* We need to lock the tchain before looking at on_tchain.  At one point, I
304          * thought we could do the check-signal-check again style (lockless peek).
305          * The reason we can't is that on_tchain isn't just set FALSE.  A handler
306          * could reset the alarm and set it TRUE while we're looking.  We could
307          * briefly peek when it is off the chain but about to run its handler.
308          *
309          * I was tempted to assert(!waiter->holds_tchain_lock), to catch people who
310          * try to unset from a handler.  That won't work, since you can validly
311          * unset while the alarm is going off.  In that case, you might see
312          * holds_tchain_lock set briefly. */
313         spin_lock_irqsave(&tchain->lock);
314         if (waiter->on_tchain) {
315                 was_on_chain = TRUE;
316                 if (__remove_awaiter(tchain, waiter))
317                         reset_tchain_interrupt(tchain);
318         }
319         spin_unlock_irqsave(&tchain->lock);
320         /* IRQ alarms run under the tchain lock.  If we ripped it off the chain, it
321          * won't fire again.  Alarms that rearm may have fired multiple times before
322          * we locked, but once we locked, it was done. */
323         return was_on_chain;
324 }
325
326 static bool __unset_alarm_rkm(struct timer_chain *tchain,
327                               struct alarm_waiter *waiter)
328 {
329         bool was_on_chain, was_pending;
330
331         cv_lock(&waiter->rkm_cv);
332         while (1) {
333                 spin_lock_irqsave(&tchain->lock);
334                 was_on_chain = waiter->on_tchain;
335                 /* I think we can safely check pending outside the tchain lock, but it's
336                  * not worth the hassle and this is probably safer.  Basically,
337                  * rkm_pending will be set only if on_tchain is FALSE, and it won't get
338                  * cleared until someone grabs the cv_lock (which we hold). */
339                 was_pending = waiter->rkm_pending;
340                 if (was_on_chain) {
341                         /* The only way we ever stop repeating alarms permanently (i.e. they
342                          * rearm) is if we yank it off the tchain */
343                         if (__remove_awaiter(tchain, waiter))
344                                 reset_tchain_interrupt(tchain);
345                         spin_unlock_irqsave(&tchain->lock);
346                         cv_unlock(&waiter->rkm_cv);
347                         return TRUE;
348                 }
349                 spin_unlock_irqsave(&tchain->lock);
350                 if (!was_pending) {
351                         /* wasn't on the chain and wasn't pending: it executed and did not
352                          * get rearmed */
353                         cv_unlock(&waiter->rkm_cv);
354                         return FALSE;
355                 }
356                 /* Wait til it executes and then try again. */
357                 cv_wait(&waiter->rkm_cv);
358         }
359 }
360
361 /* Removes waiter from the tchain before it goes off.  Returns TRUE if we
362  * disarmed before the alarm went off, FALSE if it already fired.  May block for
363  * non-IRQ / RKM alarms, since the handler may be running asynchronously. */
364 bool unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
365 {
366         if (waiter->irq_ok)
367                 return __unset_alarm_irq(tchain, waiter);
368         else
369                 return __unset_alarm_rkm(tchain, waiter);
370 }
371
372 bool reset_alarm_abs(struct timer_chain *tchain, struct alarm_waiter *waiter,
373                      uint64_t abs_time)
374 {
375         bool ret;
376
377         ret = unset_alarm(tchain, waiter);
378         set_awaiter_abs(waiter, abs_time);
379         set_alarm(tchain, waiter);
380         return ret;
381 }
382
383 bool reset_alarm_rel(struct timer_chain *tchain, struct alarm_waiter *waiter,
384                      uint64_t usleep)
385 {
386         bool ret;
387
388         ret = unset_alarm(tchain, waiter);
389         set_awaiter_rel(waiter, usleep);
390         set_alarm(tchain, waiter);
391         return ret;
392 }
393
394 /* Sets the timer interrupt for the timer chain passed as parameter.
395  * The next interrupt will be scheduled at the nearest timer available in the
396  * chain.
397  * This function can be called either for the local CPU, or for a remote CPU.
398  * If called for the local CPU, it proceeds in setting up the local timer,
399  * otherwise it will trigger an IPI, and will let the remote CPU IRQ handler
400  * to setup the timer according to the active information on its timer chain.
401  *
402  * Needs to set the interrupt to trigger tchain at the given time, or disarm it
403  * if time is 0.   Any function like this needs to do a few things:
404  *      - Make sure the interrupt is on and will go off when we want
405  *      - Make sure the interrupt source can find tchain
406  *      - Make sure the interrupt handler calls __trigger_tchain(tchain)
407  *      - Make sure you don't clobber an old tchain here (a bug)
408  * This implies the function knows how to find its timer source/void
409  *
410  * Called with the tchain lock held, and IRQs disabled.  However, we could be
411  * calling this cross-core, and we cannot disable those IRQs (hence the
412  * locking). */
413 void set_pcpu_alarm_interrupt(struct timer_chain *tchain)
414 {
415         uint64_t time, rel_usec, now;
416         int pcoreid = core_id();
417         struct per_cpu_info *rem_pcpui, *pcpui = &per_cpu_info[pcoreid];
418         struct timer_chain *pcpui_tchain = &pcpui->tchain;
419
420         if (pcpui_tchain != tchain) {
421                 /* cross-core call.  we can simply send an alarm IRQ.  the alarm handler
422                  * will reset its pcpu timer, based on its current lists.  they take an
423                  * extra IRQ, but it gets the job done. */
424                 rem_pcpui = (struct per_cpu_info*)((uintptr_t)tchain -
425                                     offsetof(struct per_cpu_info, tchain));
426                 /* TODO: using the LAPIC vector is a bit ghetto, since that's x86.  But
427                  * RISCV ignores the vector field, and we don't have a global IRQ vector
428                  * namespace or anything. */
429                 send_ipi(rem_pcpui - &per_cpu_info[0], IdtLAPIC_TIMER);
430                 return;
431         }
432         time = TAILQ_EMPTY(&tchain->waiters) ? 0 : tchain->earliest_time;
433         if (time) {
434                 /* Arm the alarm.  For times in the past, we just need to make sure it
435                  * goes off. */
436                 now = read_tsc();
437                 if (time <= now)
438                         rel_usec = 1;
439                 else
440                         rel_usec = tsc2usec(time - now);
441                 rel_usec = MAX(rel_usec, 1);
442                 printd("Setting alarm for %llu, it is now %llu, rel_time %llu "
443                        "tchain %p\n", time, now, rel_usec, pcpui_tchain);
444                 set_core_timer(rel_usec, FALSE);
445         } else  {
446                 /* Disarm */
447                 set_core_timer(0, FALSE);
448         }
449 }
450
451 /* Debug helpers */
452
453 void print_chain(struct timer_chain *tchain)
454 {
455         struct alarm_waiter *i;
456         spin_lock_irqsave(&tchain->lock);
457         printk("Chain %p is%s empty, early: %llu latest: %llu\n", tchain,
458                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
459                tchain->earliest_time,
460                tchain->latest_time);
461         TAILQ_FOREACH(i, &tchain->waiters, next) {
462                 uintptr_t f;
463
464                 if (i->irq_ok)
465                         f = (uintptr_t)i->func_irq;
466                 else
467                         f = (uintptr_t)i->func;
468                 printk("\tWaiter %p, time %llu, func %p (%s)\n", i,
469                        i->wake_up_time, f, get_fn_name(f));
470         }
471         spin_unlock_irqsave(&tchain->lock);
472 }
473
474 /* Prints all chains, rather verbosely */
475 void print_pcpu_chains(void)
476 {
477         struct timer_chain *pcpu_chain;
478         printk("PCPU Chains:  It is now %llu\n", read_tsc());
479
480         for (int i = 0; i < num_cores; i++) {
481                 pcpu_chain = &per_cpu_info[i].tchain;
482                 print_chain(pcpu_chain);
483         }
484 }