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