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