Kernel alarm tchains use locks
[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 }
58
59 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
60  * the alarm to go off. */
61 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
62 {
63         waiter->wake_up_time = abs_time;
64 }
65
66 /* Give this a relative time from now, in microseconds.  This might be easier to
67  * use than dealing with the TSC. */
68 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
69 {
70         uint64_t now, then;
71         now = read_tsc();
72         then = now + usec2tsc(usleep);
73         /* This will go off if we wrap-around the TSC.  It'll never happen for legit
74          * values, but this might catch some bugs with large usleeps. */
75         assert(now <= then);
76         set_awaiter_abs(waiter, then);
77 }
78
79 /* Increment the timer that was already set, so that it goes off usleep usec
80  * from the previous tick.  This is different than 'rel' in that it doesn't care
81  * about when 'now' is. */
82 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
83 {
84         assert(waiter->wake_up_time != ALARM_POISON_TIME);
85         waiter->wake_up_time += usec2tsc(usleep);
86 }
87
88 /* Helper, makes sure the interrupt is turned on at the right time.  Most of the
89  * heavy lifting is in the timer-source specific function pointer. */
90 static void reset_tchain_interrupt(struct timer_chain *tchain)
91 {
92         assert(!irq_is_enabled());
93         if (TAILQ_EMPTY(&tchain->waiters)) {
94                 /* Turn it off */
95                 printd("Turning alarm off\n");
96                 tchain->set_interrupt(0, tchain);
97         } else {
98                 /* Make sure it is on and set to the earliest time */
99                 assert(tchain->earliest_time != ALARM_POISON_TIME);
100                 /* TODO: check for times in the past or very close to now */
101                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
102                 tchain->set_interrupt(tchain->earliest_time, tchain);
103         }
104 }
105
106 /* When an awaiter's time has come, this gets called.  If it was a kthread, it
107  * will wake up.  o/w, it will call the func ptr stored in the awaiter. */
108 static void wake_awaiter(struct alarm_waiter *waiter)
109 {
110         int8_t irq_state = 0;
111         if (waiter->func)
112                 waiter->func(waiter);
113         else
114                 sem_up_irqsave(&waiter->sem, &irq_state);
115 }
116
117 /* This is called when an interrupt triggers a tchain, and needs to wake up
118  * everyone whose time is up.  Called from IRQ context. */
119 void trigger_tchain(struct timer_chain *tchain)
120 {
121         struct alarm_waiter *i, *temp;
122         uint64_t now = read_tsc();
123         bool changed_list = FALSE;
124         assert(!irq_is_enabled());
125         spin_lock(&tchain->lock);
126         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
127                 printd("Trying to wake up %p who is due at %llu and now is %llu\n",
128                        i, i->wake_up_time, now);
129                 /* TODO: Could also do something in cases where we're close to now */
130                 if (i->wake_up_time <= now) {
131                         changed_list = TRUE;
132                         TAILQ_REMOVE(&tchain->waiters, i, next);
133                         /* Don't touch the waiter after waking it, since it could be in use
134                          * on another core (and the waiter can be clobbered as the kthread
135                          * unwinds its stack).  Or it could be kfreed */
136                         wake_awaiter(i);
137                 } else {
138                         break;
139                 }
140         }
141         if (changed_list) {
142                 reset_tchain_times(tchain);
143         }
144         /* Need to reset the interrupt no matter what */
145         reset_tchain_interrupt(tchain);
146         spin_unlock(&tchain->lock);
147 }
148
149 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
150  * later.  Hold the lock, if applicable.  If this is a per-core tchain, the
151  * interrupt-disabling ought to suffice. */
152 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
153 {
154         struct alarm_waiter *i, *temp;
155         /* This will fail if you don't set a time */
156         assert(waiter->wake_up_time != ALARM_POISON_TIME);
157         spin_lock_irqsave(&tchain->lock);
158         /* Either the list is empty, or not. */
159         if (TAILQ_EMPTY(&tchain->waiters)) {
160                 tchain->earliest_time = waiter->wake_up_time;
161                 tchain->latest_time = waiter->wake_up_time;
162                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
163                 /* Need to turn on the timer interrupt later */
164                 goto reset_out;
165         }
166         /* If not, either we're first, last, or in the middle.  Reset the interrupt
167          * and adjust the tchain's times accordingly. */
168         if (waiter->wake_up_time < tchain->earliest_time) {
169                 tchain->earliest_time = waiter->wake_up_time;
170                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
171                 /* Changed the first entry; we'll need to reset the interrupt later */
172                 goto reset_out;
173         }
174         /* If there is a tie for last, the newer one will really go last.  We need
175          * to handle equality here since the loop later won't catch it. */
176         if (waiter->wake_up_time >= tchain->latest_time) {
177                 tchain->latest_time = waiter->wake_up_time;
178                 /* Proactively put it at the end if we know we're last */
179                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
180                 goto no_reset_out;
181         }
182         /* Insert before the first one you are earlier than.  This won't scale well
183          * (TODO) if we have a lot of inserts.  The proactive insert_tail up above
184          * will help a bit. */
185         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
186                 if (waiter->wake_up_time < i->wake_up_time) {
187                         TAILQ_INSERT_BEFORE(i, waiter, next);
188                         goto no_reset_out;
189                 }
190         }
191         panic("Could not find a spot for awaiter %p\n", waiter);
192 reset_out:
193         reset_tchain_interrupt(tchain);
194 no_reset_out:
195         spin_unlock_irqsave(&tchain->lock);
196         /* TODO: could put some debug stuff here */
197 }
198
199 /* Removes waiter from the tchain before it goes off. 
200  * TODO: handle waiters that already went off. */
201 void unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
202 {
203         struct alarm_waiter *temp;
204         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
205
206         spin_lock_irqsave(&tchain->lock);
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         spin_unlock_irqsave(&tchain->lock);
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 %p with a func %p!", 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  *
253  * Called with the tchain lock held, and IRQs disabled. */
254 void set_pcpu_alarm_interrupt(uint64_t time, struct timer_chain *tchain)
255 {
256         uint64_t rel_usec, now;
257         struct timer_chain *pcpui_tchain = &per_cpu_info[core_id()].tchain;
258         assert(pcpui_tchain == tchain);
259         if (time) {
260                 /* Arm the alarm.  For times in the past, we just need to make sure it
261                  * goes off. */
262                 now = read_tsc();
263                 if (time <= now)
264                         rel_usec = 1;
265                 else
266                         rel_usec = tsc2usec(time - now);
267                 rel_usec = MAX(rel_usec, 1);
268                 printd("Setting alarm for %llu, it is now %llu, rel_time %llu "
269                        "tchain %p\n", time, now, rel_usec, pcpui_tchain);
270                 set_core_timer(rel_usec, FALSE);
271                 /* Make sure the caller is setting the right tchain */
272                 assert(pcpui_tchain == tchain);
273         } else  {
274                 /* Disarm */
275                 set_core_timer(0, FALSE);
276         }
277 }
278
279 /* Debug helpers */
280
281 void print_chain(struct timer_chain *tchain)
282 {
283         struct alarm_waiter *i;
284         spin_lock_irqsave(&tchain->lock);
285         printk("Chain %p is%s empty, early: %llu latest: %llu\n", tchain,
286                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
287                tchain->earliest_time,
288                tchain->latest_time);
289         TAILQ_FOREACH(i, &tchain->waiters, next) {
290                 struct kthread *kthread = TAILQ_FIRST(&i->sem.waiters);
291                 printk("\tWaiter %p, time: %llu, kthread: %p (%p) %s\n", i,
292                        i->wake_up_time, kthread, (kthread ? kthread->proc : 0),
293                        (kthread ? kthread->name : 0));
294
295         }
296         spin_unlock_irqsave(&tchain->lock);
297 }
298
299 /* Prints all chains, rather verbosely */
300 void print_pcpu_chains(void)
301 {
302         struct timer_chain *pcpu_chain;
303         printk("PCPU Chains:  It is now %llu\n", read_tsc());
304
305         for (int i = 0; i < num_cpus; i++) {
306                 pcpu_chain = &per_cpu_info[i].tchain;
307                 print_chain(pcpu_chain);
308         }
309 }