Fixes reset_alarm_abs()
[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 void init_awaiter(struct alarm_waiter *waiter,
51                   void (*func) (struct alarm_waiter *awaiter))
52 {
53         waiter->wake_up_time = ALARM_POISON_TIME;
54         waiter->func = func;
55         if (!func)
56                 sem_init_irqsave(&waiter->sem, 0);
57         waiter->on_tchain = FALSE;
58 }
59
60 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
61  * the alarm to go off. */
62 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
63 {
64         waiter->wake_up_time = abs_time;
65 }
66
67 /* Give this a relative time from now, in microseconds.  This might be easier to
68  * use than dealing with the TSC. */
69 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
70 {
71         uint64_t now, then;
72         now = read_tsc();
73         then = now + usec2tsc(usleep);
74         /* This will go off if we wrap-around the TSC.  It'll never happen for legit
75          * values, but this might catch some bugs with large usleeps. */
76         assert(now <= then);
77         set_awaiter_abs(waiter, then);
78 }
79
80 /* Increment the timer that was already set, so that it goes off usleep usec
81  * from the previous tick.  This is different than 'rel' in that it doesn't care
82  * about when 'now' is. */
83 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
84 {
85         assert(waiter->wake_up_time != ALARM_POISON_TIME);
86         waiter->wake_up_time += usec2tsc(usleep);
87 }
88
89 /* Helper, makes sure the interrupt is turned on at the right time.  Most of the
90  * heavy lifting is in the timer-source specific function pointer. */
91 static void reset_tchain_interrupt(struct timer_chain *tchain)
92 {
93         assert(!irq_is_enabled());
94         if (TAILQ_EMPTY(&tchain->waiters)) {
95                 /* Turn it off */
96                 printd("Turning alarm off\n");
97                 tchain->set_interrupt(0, tchain);
98         } else {
99                 /* Make sure it is on and set to the earliest time */
100                 assert(tchain->earliest_time != ALARM_POISON_TIME);
101                 /* TODO: check for times in the past or very close to now */
102                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
103                 tchain->set_interrupt(tchain->earliest_time, tchain);
104         }
105 }
106
107 /* When an awaiter's time has come, this gets called.  If it was a kthread, it
108  * will wake up.  o/w, it will call the func ptr stored in the awaiter. */
109 static void wake_awaiter(struct alarm_waiter *waiter)
110 {
111         waiter->on_tchain = FALSE;
112         cmb();  /* enforce the on_tchain write before the handlers */
113         if (waiter->func)
114                 waiter->func(waiter);
115         else
116                 sem_up(&waiter->sem); /* IRQs are disabled, can call sem_up directly */
117 }
118
119 /* This is called when an interrupt triggers a tchain, and needs to wake up
120  * everyone whose time is up.  Called from IRQ context. */
121 void trigger_tchain(struct timer_chain *tchain)
122 {
123         struct alarm_waiter *i, *temp;
124         uint64_t now = read_tsc();
125         bool changed_list = FALSE;
126         assert(!irq_is_enabled());
127         spin_lock(&tchain->lock);
128         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
129                 printd("Trying to wake up %p who is due at %llu and now is %llu\n",
130                        i, i->wake_up_time, now);
131                 /* TODO: Could also do something in cases where we're close to now */
132                 if (i->wake_up_time <= now) {
133                         changed_list = TRUE;
134                         TAILQ_REMOVE(&tchain->waiters, i, next);
135                         /* Don't touch the waiter after waking it, since it could be in use
136                          * on another core (and the waiter can be clobbered as the kthread
137                          * unwinds its stack).  Or it could be kfreed */
138                         wake_awaiter(i);
139                 } else {
140                         break;
141                 }
142         }
143         if (changed_list) {
144                 reset_tchain_times(tchain);
145         }
146         /* Need to reset the interrupt no matter what */
147         reset_tchain_interrupt(tchain);
148         spin_unlock(&tchain->lock);
149 }
150
151 /* Helper, inserts the waiter into the tchain, returning TRUE if we still need
152  * to reset the tchain interrupt.  Caller holds the lock. */
153 static bool __insert_awaiter(struct timer_chain *tchain,
154                              struct alarm_waiter *waiter)
155 {
156         struct alarm_waiter *i, *temp;
157         /* This will fail if you don't set a time */
158         assert(waiter->wake_up_time != ALARM_POISON_TIME);
159         waiter->on_tchain = TRUE;
160         /* Either the list is empty, or not. */
161         if (TAILQ_EMPTY(&tchain->waiters)) {
162                 tchain->earliest_time = waiter->wake_up_time;
163                 tchain->latest_time = waiter->wake_up_time;
164                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
165                 /* Need to turn on the timer interrupt later */
166                 return TRUE;
167         }
168         /* If not, either we're first, last, or in the middle.  Reset the interrupt
169          * and adjust the tchain's times accordingly. */
170         if (waiter->wake_up_time < tchain->earliest_time) {
171                 tchain->earliest_time = waiter->wake_up_time;
172                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
173                 /* Changed the first entry; we'll need to reset the interrupt later */
174                 return TRUE;
175         }
176         /* If there is a tie for last, the newer one will really go last.  We need
177          * to handle equality here since the loop later won't catch it. */
178         if (waiter->wake_up_time >= tchain->latest_time) {
179                 tchain->latest_time = waiter->wake_up_time;
180                 /* Proactively put it at the end if we know we're last */
181                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
182                 return FALSE;
183         }
184         /* Insert before the first one you are earlier than.  This won't scale well
185          * (TODO) if we have a lot of inserts.  The proactive insert_tail up above
186          * will help a bit. */
187         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
188                 if (waiter->wake_up_time < i->wake_up_time) {
189                         TAILQ_INSERT_BEFORE(i, waiter, next);
190                         return FALSE;
191                 }
192         }
193         panic("Could not find a spot for awaiter %p\n", waiter);
194 }
195
196 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
197  * later.  This version assumes you have the lock held.  That only makes sense
198  * from alarm handlers, which are called with this lock held from IRQ context */
199 void __set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
200 {
201         if (__insert_awaiter(tchain, waiter))
202                 reset_tchain_interrupt(tchain);
203 }
204
205 /* Sets the alarm.  Don't call this from an alarm handler, since you already
206  * have the lock held.  Call __set_alarm() instead. */
207 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
208 {
209         spin_lock_irqsave(&tchain->lock);
210         __set_alarm(tchain, waiter);
211         spin_unlock_irqsave(&tchain->lock);
212 }
213
214 /* Helper, rips the waiter from the tchain, knowing that it is on the list.
215  * Returns TRUE if the tchain interrupt needs to be reset.  Callers hold the
216  * lock. */
217 static bool __remove_awaiter(struct timer_chain *tchain,
218                              struct alarm_waiter *waiter)
219 {
220         struct alarm_waiter *temp;
221         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
222         /* Need to make sure earliest and latest are set, in case we're mucking with
223          * the first and/or last element of the chain. */
224         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
225                 temp = TAILQ_NEXT(waiter, next);
226                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
227                 reset_int = TRUE;               /* we'll need to reset the timer later */
228         }
229         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
230                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
231                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
232         }
233         TAILQ_REMOVE(&tchain->waiters, waiter, next);
234         return reset_int;
235 }
236
237 /* Removes waiter from the tchain before it goes off.  Returns TRUE if we
238  * disarmed before the alarm went off, FALSE if it already fired. */
239 bool unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
240 {
241         spin_lock_irqsave(&tchain->lock);
242         if (!waiter->on_tchain) {
243                 /* the alarm has already gone off.  its not even on this tchain's list,
244                  * though the concurrent change to on_tchain (specifically, the setting
245                  * of it to FALSE), happens under the tchain's lock. */
246                 spin_unlock_irqsave(&tchain->lock);
247                 return FALSE;
248         }
249         if (__remove_awaiter(tchain, waiter))
250                 reset_tchain_interrupt(tchain);
251         spin_unlock_irqsave(&tchain->lock);
252         return TRUE;
253 }
254
255 /* waiter may be on the tchain, or it might have fired already and be off the
256  * tchain.  Either way, this will put the waiter on the list, set to go off at
257  * abs_time.  If you know the alarm has fired, don't call this.  Just set the
258  * awaiter, and then set_alarm() */
259 void reset_alarm_abs(struct timer_chain *tchain, struct alarm_waiter *waiter,
260                      uint64_t abs_time)
261 {
262         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
263         spin_lock_irqsave(&tchain->lock);
264         /* We only need to remove/unset when the alarm has not fired yet (is still
265          * on the tchain).  If it has fired, it's like a fresh insert */
266         if (waiter->on_tchain)
267                 reset_int = __remove_awaiter(tchain, waiter);
268         set_awaiter_abs(waiter, abs_time);
269         /* regardless, we need to be reinserted */
270         if (__insert_awaiter(tchain, waiter) || reset_int)
271                 reset_tchain_interrupt(tchain);
272         spin_unlock_irqsave(&tchain->lock);
273 }
274
275 /* Attempts to sleep on the alarm.  Could fail if you aren't allowed to kthread
276  * (process limit, etc).  Don't call it on a waiter that is an event-handler. */
277 int sleep_on_awaiter(struct alarm_waiter *waiter)
278 {
279         int8_t irq_state = 0;
280         if (waiter->func)
281                 panic("Tried blocking on a waiter %p with a func %p!", waiter,
282                       waiter->func);
283         /* Put the kthread to sleep.  TODO: This can fail (or at least it will be
284          * able to in the future) and we'll need to handle that. */
285         sem_down_irqsave(&waiter->sem, &irq_state);
286         return 0;
287 }
288
289 /* Sets the Alarm interrupt, per-core style.  Also is an example of what any
290  * similar function needs to do (this is the func ptr in the tchain). 
291  * Note the tchain is our per-core one, and we don't need tchain passed to us to
292  * figure that out.  It's kept around in case other tchain-usage wants it -
293  * might not be necessary in the future.
294  *
295  * Needs to set the interrupt to trigger tchain at the given time, or disarm it
296  * if time is 0.   Any function like this needs to do a few things:
297  *      - Make sure the interrupt is on and will go off when we want
298  *      - Make sure the interrupt source can find tchain
299  *      - Make sure the interrupt handler calls trigger_tchain(tchain)
300  *      - Make sure you don't clobber an old tchain here (a bug) 
301  * This implies the function knows how to find its timer source/void
302  *
303  * Called with the tchain lock held, and IRQs disabled.  However, we could be
304  * calling this cross-core, and we cannot disable those IRQs (hence the
305  * locking). */
306 void set_pcpu_alarm_interrupt(uint64_t time, struct timer_chain *tchain)
307 {
308         uint64_t rel_usec, now;
309         int pcoreid = core_id();
310         struct timer_chain *pcpui_tchain = &per_cpu_info[pcoreid].tchain;
311
312         if (pcpui_tchain != tchain) {
313                 /* cross-core call.  we can simply send an alarm IRQ.  the alarm handler
314                  * will reset its pcpu timer, based on its current lists.  they take an
315                  * extra IRQ, but it gets the job done. */
316                 /* TODO: using the LAPIC vector is a bit ghetto, since that's x86.  But
317                  * RISCV ignores the vector field, and we don't have a global IRQ vector
318                  * namespace or anything. */
319                 send_ipi(pcoreid + (pcpui_tchain - tchain), LAPIC_TIMER_DEFAULT_VECTOR);
320                 return;
321         }
322         if (time) {
323                 /* Arm the alarm.  For times in the past, we just need to make sure it
324                  * goes off. */
325                 now = read_tsc();
326                 if (time <= now)
327                         rel_usec = 1;
328                 else
329                         rel_usec = tsc2usec(time - now);
330                 rel_usec = MAX(rel_usec, 1);
331                 printd("Setting alarm for %llu, it is now %llu, rel_time %llu "
332                        "tchain %p\n", time, now, rel_usec, pcpui_tchain);
333                 set_core_timer(rel_usec, FALSE);
334         } else  {
335                 /* Disarm */
336                 set_core_timer(0, FALSE);
337         }
338 }
339
340 /* Debug helpers */
341
342 void print_chain(struct timer_chain *tchain)
343 {
344         struct alarm_waiter *i;
345         spin_lock_irqsave(&tchain->lock);
346         printk("Chain %p is%s empty, early: %llu latest: %llu\n", tchain,
347                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
348                tchain->earliest_time,
349                tchain->latest_time);
350         TAILQ_FOREACH(i, &tchain->waiters, next) {
351                 struct kthread *kthread = TAILQ_FIRST(&i->sem.waiters);
352                 printk("\tWaiter %p, time: %llu, kthread: %p (%p) %s\n", i,
353                        i->wake_up_time, kthread, (kthread ? kthread->proc : 0),
354                        (kthread ? kthread->name : 0));
355
356         }
357         spin_unlock_irqsave(&tchain->lock);
358 }
359
360 /* Prints all chains, rather verbosely */
361 void print_pcpu_chains(void)
362 {
363         struct timer_chain *pcpu_chain;
364         printk("PCPU Chains:  It is now %llu\n", read_tsc());
365
366         for (int i = 0; i < num_cpus; i++) {
367                 pcpu_chain = &per_cpu_info[i].tchain;
368                 print_chain(pcpu_chain);
369         }
370 }