Semaphores and CVs have irqsave initializers
[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         TAILQ_INIT(&tchain->waiters);
43         tchain->set_interrupt = set_interrupt;
44         reset_tchain_times(tchain);
45 }
46
47 /* Initializes a new awaiter.  Pass 0 for the function if you want it to be a
48  * kthread-alarm, and sleep on it after you set the alarm later. */
49 void init_awaiter(struct alarm_waiter *waiter,
50                   void (*func) (struct alarm_waiter *awaiter))
51 {
52         waiter->wake_up_time = ALARM_POISON_TIME;
53         waiter->func = func;
54         if (!func)
55                 sem_init_irqsave(&waiter->sem, 0);
56 }
57
58 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
59  * the alarm to go off. */
60 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
61 {
62         waiter->wake_up_time = abs_time;
63 }
64
65 /* Give this a relative time from now, in microseconds.  This might be easier to
66  * use than dealing with the TSC. */
67 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
68 {
69         uint64_t now, then;
70         now = read_tsc();
71         then = now + usec2tsc(usleep);
72         /* This will go off if we wrap-around the TSC.  It'll never happen for legit
73          * values, but this might catch some bugs with large usleeps. */
74         assert(now < then);
75         set_awaiter_abs(waiter, then);
76 }
77
78 /* Increment the timer that was already set, so that it goes off usleep usec
79  * from the previous tick.  This is different than 'rel' in that it doesn't care
80  * about when 'now' is. */
81 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
82 {
83         assert(waiter->wake_up_time != ALARM_POISON_TIME);
84         waiter->wake_up_time += usec2tsc(usleep);
85 }
86
87 /* Helper, makes sure the interrupt is turned on at the right time.  Most of the
88  * heavy lifting is in the timer-source specific function pointer. */
89 static void reset_tchain_interrupt(struct timer_chain *tchain)
90 {
91         assert(!irq_is_enabled());
92         if (TAILQ_EMPTY(&tchain->waiters)) {
93                 /* Turn it off */
94                 printd("Turning alarm off\n");
95                 tchain->set_interrupt(0, tchain);
96         } else {
97                 /* Make sure it is on and set to the earliest time */
98                 assert(tchain->earliest_time != ALARM_POISON_TIME);
99                 /* TODO: check for times in the past or very close to now */
100                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
101                 tchain->set_interrupt(tchain->earliest_time, tchain);
102         }
103 }
104
105 /* When an awaiter's time has come, this gets called.  If it was a kthread, it
106  * will wake up.  o/w, it will call the func ptr stored in the awaiter. */
107 static void wake_awaiter(struct alarm_waiter *waiter)
108 {
109         int8_t irq_state = 0;
110         if (waiter->func)
111                 waiter->func(waiter);
112         else
113                 sem_up_irqsave(&waiter->sem, &irq_state);
114 }
115
116 /* This is called when an interrupt triggers a tchain, and needs to wake up
117  * everyone whose time is up. */
118 void trigger_tchain(struct timer_chain *tchain)
119 {
120         struct alarm_waiter *i, *temp;
121         uint64_t now = read_tsc();
122         bool changed_list = FALSE;
123         assert(!irq_is_enabled());
124         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
125                 printd("Trying to wake up %08p who is due at %llu and now is %llu\n",
126                        i, i->wake_up_time, now);
127                 /* TODO: Could also do something in cases where we're close to now */
128                 if (i->wake_up_time <= now) {
129                         changed_list = TRUE;
130                         TAILQ_REMOVE(&tchain->waiters, i, next);
131                         /* Don't touch the waiter after waking it, since it could be in use
132                          * on another core (and the waiter can be clobbered as the kthread
133                          * unwinds its stack).  Or it could be kfreed */
134                         wake_awaiter(i);
135                 } else {
136                         break;
137                 }
138         }
139         if (changed_list) {
140                 reset_tchain_times(tchain);
141         }
142         /* Need to reset the interrupt no matter what */
143         reset_tchain_interrupt(tchain);
144 }
145
146 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
147  * later.  Hold the lock, if applicable.  If this is a per-core tchain, the
148  * interrupt-disabling ought to suffice. */
149 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
150 {
151         struct alarm_waiter *i, *temp;
152         int8_t irq_state = 0;
153
154         /* This will fail if you don't set a time */
155         assert(waiter->wake_up_time != ALARM_POISON_TIME);
156         disable_irqsave(&irq_state);
157         /* Either the list is empty, or not. */
158         if (TAILQ_EMPTY(&tchain->waiters)) {
159                 tchain->earliest_time = waiter->wake_up_time;
160                 tchain->latest_time = waiter->wake_up_time;
161                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
162                 /* Need to turn on the timer interrupt later */
163                 goto reset_out;
164         }
165         /* If not, either we're first, last, or in the middle.  Reset the interrupt
166          * and adjust the tchain's times accordingly. */
167         if (waiter->wake_up_time < tchain->earliest_time) {
168                 tchain->earliest_time = waiter->wake_up_time;
169                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
170                 /* Changed the first entry; we'll need to reset the interrupt later */
171                 goto reset_out;
172         }
173         /* If there is a tie for last, the newer one will really go last.  We need
174          * to handle equality here since the loop later won't catch it. */
175         if (waiter->wake_up_time >= tchain->latest_time) {
176                 tchain->latest_time = waiter->wake_up_time;
177                 /* Proactively put it at the end if we know we're last */
178                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
179                 goto no_reset_out;
180         }
181         /* Insert before the first one you are earlier than.  This won't scale well
182          * (TODO) if we have a lot of inserts.  The proactive insert_tail up above
183          * will help a bit. */
184         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
185                 if (waiter->wake_up_time < i->wake_up_time) {
186                         TAILQ_INSERT_BEFORE(i, waiter, next);
187                         goto no_reset_out;
188                 }
189         }
190         panic("Could not find a spot for awaiter %08p\n", waiter);
191 reset_out:
192         reset_tchain_interrupt(tchain);
193 no_reset_out:
194         enable_irqsave(&irq_state);
195         /* TODO: could put some debug stuff here */
196 }
197
198 /* Removes waiter from the tchain before it goes off. 
199  * TODO: handle waiters that already went off. */
200 void unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
201 {
202         struct alarm_waiter *temp;
203         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
204         int8_t irq_state = 0;
205
206         disable_irqsave(&irq_state);
207         warn("Code currently assumes the alarm waiter hasn't triggered yet!");
208         /* Need to make sure earliest and latest are set, in case we're mucking with
209          * the first and/or last element of the chain. */
210         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
211                 temp = TAILQ_NEXT(waiter, next);
212                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
213                 reset_int = TRUE;               /* we'll need to reset the timer later */
214         }
215         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
216                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
217                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
218         }
219         TAILQ_REMOVE(&tchain->waiters, waiter, next);
220         if (reset_int)
221                 reset_tchain_interrupt(tchain);
222         enable_irqsave(&irq_state);
223 }
224
225 /* Attempts to sleep on the alarm.  Could fail if you aren't allowed to kthread
226  * (process limit, etc).  Don't call it on a waiter that is an event-handler. */
227 int sleep_on_awaiter(struct alarm_waiter *waiter)
228 {
229         int8_t irq_state = 0;
230         if (waiter->func)
231                 panic("Tried blocking on a waiter %08p with a func %08p!", waiter,
232                       waiter->func);
233         /* Put the kthread to sleep.  TODO: This can fail (or at least it will be
234          * able to in the future) and we'll need to handle that. */
235         sem_down_irqsave(&waiter->sem, &irq_state);
236         return 0;
237 }
238
239 /* Sets the Alarm interrupt, per-core style.  Also is an example of what any
240  * similar function needs to do (this is the func ptr in the tchain). 
241  * Note the tchain is our per-core one, and we don't need tchain passed to us to
242  * figure that out.  It's kept around in case other tchain-usage wants it -
243  * might not be necessary in the future.
244  *
245  * Needs to set the interrupt to trigger tchain at the given time, or disarm it
246  * if time is 0.   Any function like this needs to do a few things:
247  *      - Make sure the interrupt is on and will go off when we want
248  *      - Make sure the interrupt source can find tchain
249  *      - Make sure the interrupt handler calls trigger_tchain(tchain)
250  *      - Make sure you don't clobber an old tchain here (a bug) 
251  * This implies the function knows how to find its timer source/void */
252 void set_pcpu_alarm_interrupt(uint64_t time, struct timer_chain *tchain)
253 {
254         uint64_t rel_usec, now;
255         struct timer_chain *pcpui_tchain = &per_cpu_info[core_id()].tchain;
256         if (time) {
257                 /* Arm the alarm.  For times in the past, we just need to make sure it
258                  * goes off. */
259                 now = read_tsc();
260                 if (time <= now)
261                         rel_usec = 1;
262                 else
263                         rel_usec = tsc2usec(time - now);
264                 rel_usec = MAX(rel_usec, 1);
265                 printd("Setting alarm for %llu, it is now %llu, rel_time %llu "
266                        "tchain %08p\n", time, now, rel_usec, pcpui_tchain);
267                 /* Note that sparc doesn't honor the one-shot setting, so you might get
268                  * spurious interrupts. */
269                 set_core_timer(rel_usec, FALSE);
270                 /* Make sure the caller is setting the right tchain */
271                 assert(pcpui_tchain == tchain);
272         } else  {
273                 /* Disarm */
274                 set_core_timer(0, FALSE);
275         }
276 }
277
278 /* Debug helpers */
279
280 /* Disable irqs before calling this, or otherwise protect yourself. */
281 void print_chain(struct timer_chain *tchain)
282 {
283         struct alarm_waiter *i;
284         printk("Chain %08p is%s empty, early: %llu latest: %llu\n", tchain,
285                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
286                tchain->earliest_time,
287                tchain->latest_time);
288         TAILQ_FOREACH(i, &tchain->waiters, next) {
289                 struct kthread *kthread = TAILQ_FIRST(&i->sem.waiters);
290                 printk("\tWaiter %08p, time: %llu, kthread: %08p (%08p)\n", i,
291                        i->wake_up_time, kthread, (kthread ? kthread->proc : 0));
292
293         }
294 }
295
296 /* Prints all chains, rather verbosely */
297 void print_pcpu_chains(void)
298 {
299         struct timer_chain *pcpu_chain;
300         int8_t irq_state = 0;
301         printk("PCPU Chains:  It is now %llu\n", read_tsc());
302
303         disable_irqsave(&irq_state);
304         for (int i = 0; i < num_cpus; i++) {
305                 pcpu_chain = &per_cpu_info[i].tchain;
306                 print_chain(pcpu_chain);
307         }
308         enable_irqsave(&irq_state);
309 }