Alarm pcpu tchains can be adjusted cross-core
[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         if (waiter->func)
111                 waiter->func(waiter);
112         else
113                 sem_up(&waiter->sem); /* IRQs are disabled, can call sem_up directly */
114 }
115
116 /* This is called when an interrupt triggers a tchain, and needs to wake up
117  * everyone whose time is up.  Called from IRQ context. */
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         spin_lock(&tchain->lock);
125         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
126                 printd("Trying to wake up %p who is due at %llu and now is %llu\n",
127                        i, i->wake_up_time, now);
128                 /* TODO: Could also do something in cases where we're close to now */
129                 if (i->wake_up_time <= now) {
130                         changed_list = TRUE;
131                         TAILQ_REMOVE(&tchain->waiters, i, next);
132                         /* Don't touch the waiter after waking it, since it could be in use
133                          * on another core (and the waiter can be clobbered as the kthread
134                          * unwinds its stack).  Or it could be kfreed */
135                         wake_awaiter(i);
136                 } else {
137                         break;
138                 }
139         }
140         if (changed_list) {
141                 reset_tchain_times(tchain);
142         }
143         /* Need to reset the interrupt no matter what */
144         reset_tchain_interrupt(tchain);
145         spin_unlock(&tchain->lock);
146 }
147
148 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
149  * later.  Hold the lock, if applicable.  If this is a per-core tchain, the
150  * interrupt-disabling ought to suffice. */
151 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter)
152 {
153         struct alarm_waiter *i, *temp;
154         /* This will fail if you don't set a time */
155         assert(waiter->wake_up_time != ALARM_POISON_TIME);
156         spin_lock_irqsave(&tchain->lock);
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 %p\n", waiter);
191 reset_out:
192         reset_tchain_interrupt(tchain);
193 no_reset_out:
194         spin_unlock_irqsave(&tchain->lock);
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
205         spin_lock_irqsave(&tchain->lock);
206         warn("Code currently assumes the alarm waiter hasn't triggered yet!");
207         /* Need to make sure earliest and latest are set, in case we're mucking with
208          * the first and/or last element of the chain. */
209         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
210                 temp = TAILQ_NEXT(waiter, next);
211                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
212                 reset_int = TRUE;               /* we'll need to reset the timer later */
213         }
214         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
215                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
216                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
217         }
218         TAILQ_REMOVE(&tchain->waiters, waiter, next);
219         if (reset_int)
220                 reset_tchain_interrupt(tchain);
221         spin_unlock_irqsave(&tchain->lock);
222 }
223
224 /* Attempts to sleep on the alarm.  Could fail if you aren't allowed to kthread
225  * (process limit, etc).  Don't call it on a waiter that is an event-handler. */
226 int sleep_on_awaiter(struct alarm_waiter *waiter)
227 {
228         int8_t irq_state = 0;
229         if (waiter->func)
230                 panic("Tried blocking on a waiter %p with a func %p!", waiter,
231                       waiter->func);
232         /* Put the kthread to sleep.  TODO: This can fail (or at least it will be
233          * able to in the future) and we'll need to handle that. */
234         sem_down_irqsave(&waiter->sem, &irq_state);
235         return 0;
236 }
237
238 /* Sets the Alarm interrupt, per-core style.  Also is an example of what any
239  * similar function needs to do (this is the func ptr in the tchain). 
240  * Note the tchain is our per-core one, and we don't need tchain passed to us to
241  * figure that out.  It's kept around in case other tchain-usage wants it -
242  * might not be necessary in the future.
243  *
244  * Needs to set the interrupt to trigger tchain at the given time, or disarm it
245  * if time is 0.   Any function like this needs to do a few things:
246  *      - Make sure the interrupt is on and will go off when we want
247  *      - Make sure the interrupt source can find tchain
248  *      - Make sure the interrupt handler calls trigger_tchain(tchain)
249  *      - Make sure you don't clobber an old tchain here (a bug) 
250  * This implies the function knows how to find its timer source/void
251  *
252  * Called with the tchain lock held, and IRQs disabled.  However, we could be
253  * calling this cross-core, and we cannot disable those IRQs (hence the
254  * locking). */
255 void set_pcpu_alarm_interrupt(uint64_t time, struct timer_chain *tchain)
256 {
257         uint64_t rel_usec, now;
258         int pcoreid = core_id();
259         struct timer_chain *pcpui_tchain = &per_cpu_info[pcoreid].tchain;
260
261         if (pcpui_tchain != tchain) {
262                 /* cross-core call.  we can simply send an alarm IRQ.  the alarm handler
263                  * will reset its pcpu timer, based on its current lists.  they take an
264                  * extra IRQ, but it gets the job done. */
265                 /* TODO: using the LAPIC vector is a bit ghetto, since that's x86.  But
266                  * RISCV ignores the vector field, and we don't have a global IRQ vector
267                  * namespace or anything. */
268                 send_ipi(pcoreid + (pcpui_tchain - tchain), LAPIC_TIMER_DEFAULT_VECTOR);
269                 return;
270         }
271         if (time) {
272                 /* Arm the alarm.  For times in the past, we just need to make sure it
273                  * goes off. */
274                 now = read_tsc();
275                 if (time <= now)
276                         rel_usec = 1;
277                 else
278                         rel_usec = tsc2usec(time - now);
279                 rel_usec = MAX(rel_usec, 1);
280                 printd("Setting alarm for %llu, it is now %llu, rel_time %llu "
281                        "tchain %p\n", time, now, rel_usec, pcpui_tchain);
282                 set_core_timer(rel_usec, FALSE);
283         } else  {
284                 /* Disarm */
285                 set_core_timer(0, FALSE);
286         }
287 }
288
289 /* Debug helpers */
290
291 void print_chain(struct timer_chain *tchain)
292 {
293         struct alarm_waiter *i;
294         spin_lock_irqsave(&tchain->lock);
295         printk("Chain %p is%s empty, early: %llu latest: %llu\n", tchain,
296                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
297                tchain->earliest_time,
298                tchain->latest_time);
299         TAILQ_FOREACH(i, &tchain->waiters, next) {
300                 struct kthread *kthread = TAILQ_FIRST(&i->sem.waiters);
301                 printk("\tWaiter %p, time: %llu, kthread: %p (%p) %s\n", i,
302                        i->wake_up_time, kthread, (kthread ? kthread->proc : 0),
303                        (kthread ? kthread->name : 0));
304
305         }
306         spin_unlock_irqsave(&tchain->lock);
307 }
308
309 /* Prints all chains, rather verbosely */
310 void print_pcpu_chains(void)
311 {
312         struct timer_chain *pcpu_chain;
313         printk("PCPU Chains:  It is now %llu\n", read_tsc());
314
315         for (int i = 0; i < num_cpus; i++) {
316                 pcpu_chain = &per_cpu_info[i].tchain;
317                 print_chain(pcpu_chain);
318         }
319 }