Kernel alarms pass the alarm ID
[akaros.git] / user / benchutil / alarm.c
1 /* Copyright (c) 2013 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Userspace alarm service, based off a slimmed down version of the kernel
6  * alarms.  Under the hood, it uses the kernel alarm service for the root of
7  * the alarm chain.
8  *
9  * There's only one timer chain, unlike in the kernel, for the entire process.
10  * If you want one-off timers unrelated to the chain (and sent to other vcores),
11  * use #A directly.
12  *
13  * Your handlers will run from vcore context.
14  *
15  * Code differences from the kernel (for future porting):
16  * - init_alarm_service, run once out of init_awaiter (or wherever).
17  * - set_alarm() and friends are __tc_set_alarm(), passing global_tchain.
18  * - reset_tchain_interrupt() uses #A
19  * - removed anything related to semaphores or kthreads
20  * - spinlocks -> spin_pdr_locks
21  * - ev_q wrappers for converting #A events to __triggers
22  * - printks, and other minor stuff. */
23
24 #include <sys/queue.h>
25 #include <alarm.h>
26 #include <stdio.h>
27 #include <assert.h>
28 #include <stdlib.h>
29 #include <unistd.h>
30 #include <sys/types.h>
31 #include <sys/stat.h>
32 #include <fcntl.h>
33 #include <parlib.h>
34 #include <event.h>
35 #include <measure.h>
36 #include <uthread.h>
37 #include <spinlock.h>
38
39 /* Helpers, basically renamed kernel interfaces, with the *tchain. */
40 static void __tc_locked_set_alarm(struct timer_chain *tchain,
41                                   struct alarm_waiter *waiter);
42 static void __tc_set_alarm(struct timer_chain *tchain,
43                            struct alarm_waiter *waiter);
44 static bool __tc_unset_alarm(struct timer_chain *tchain,
45                              struct alarm_waiter *waiter);
46 static void __tc_reset_alarm_abs(struct timer_chain *tchain,
47                                  struct alarm_waiter *waiter,
48                                  uint64_t abs_time);
49 static void handle_user_alarm(struct event_msg *ev_msg, unsigned int ev_type);
50
51 /* One chain to rule them all. */
52 struct timer_chain global_tchain;
53
54 /* Helper, resets the earliest/latest times, based on the elements of the list.
55  * If the list is empty, we set the times to be the 12345 poison time.  Since
56  * the list is empty, the alarm shouldn't be going off. */
57 static void reset_tchain_times(struct timer_chain *tchain)
58 {
59         if (TAILQ_EMPTY(&tchain->waiters)) {
60                 tchain->earliest_time = ALARM_POISON_TIME;
61                 tchain->latest_time = ALARM_POISON_TIME;
62         } else {
63                 tchain->earliest_time = TAILQ_FIRST(&tchain->waiters)->wake_up_time;
64                 tchain->latest_time =
65                         TAILQ_LAST(&tchain->waiters, awaiters_tailq)->wake_up_time;
66         }
67 }
68
69 static void init_alarm_service(void)
70 {
71         int ctlfd, timerfd, alarm_nr, ret;
72         char buf[20];
73         char path[32];
74         struct event_queue *ev_q;
75
76         /* Sets up timer chain (only one chain per process) */
77         spin_pdr_init(&global_tchain.lock);
78         TAILQ_INIT(&global_tchain.waiters);
79         reset_tchain_times(&global_tchain);
80
81         ctlfd = open("#A/clone", O_RDWR | O_CLOEXEC);
82         if (ctlfd < 0) {
83                 perror("Useralarm: Can't clone an alarm");
84                 return;
85         }
86         ret = read(ctlfd, buf, sizeof(buf) - 1);
87         if (ret <= 0) {
88                 if (!ret)
89                         printf("Useralarm: Got early EOF from ctl\n");
90                 else
91                         perror("Useralarm: Can't read ctl");
92                 return;
93         }
94         buf[ret] = 0;
95         global_tchain.alarmid = atoi(buf);
96         snprintf(path, sizeof(path), "#A/a%s/timer", buf);
97         timerfd = open(path, O_RDWR | O_CLOEXEC);
98         if (timerfd < 0) {
99                 perror("Useralarm: Can't open timer");
100                 return;
101         }
102         /* Since we're doing SPAM_PUBLIC later, we actually don't need a big ev_q.
103          * But someone might copy/paste this and change a flag. */
104         ev_handlers[EV_ALARM] = handle_user_alarm;
105         if (!(ev_q = get_big_event_q())) {
106                 perror("Useralarm: Failed ev_q");
107                 return;
108         }
109         ev_q->ev_vcore = 0;
110         /* We could get multiple events for a single alarm.  It's okay, since
111          * __trigger can handle spurious upcalls.  If it ever is not okay, then use
112          * an INDIR/FALLBACK instead of SPAM_PUBLIC. */
113         ev_q->ev_flags = EVENT_IPI | EVENT_SPAM_PUBLIC;
114         ret = snprintf(path, sizeof(path), "evq %llx", ev_q);
115         ret = write(ctlfd, path, ret);
116         if (ret <= 0) {
117                 perror("Useralarm: Failed to write ev_q");
118                 return;
119         }
120         /* now the alarm is all set, just need to write the timer whenever we want
121          * it to go off. */
122         global_tchain.ctlfd = ctlfd;
123         global_tchain.timerfd = timerfd;
124         global_tchain.ev_q = ev_q;      /* mostly for debugging */
125 }
126
127 /* Initializes a new awaiter.  Pass 0 for the function if you want it to be a
128  * kthread-alarm, and sleep on it after you set the alarm later. */
129 void init_awaiter(struct alarm_waiter *waiter,
130                   void (*func) (struct alarm_waiter *awaiter))
131 {
132         run_once_racy(init_alarm_service());
133         waiter->wake_up_time = ALARM_POISON_TIME;
134         assert(func);
135         waiter->func = func;
136         waiter->on_tchain = FALSE;
137 }
138
139 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
140  * the alarm to go off. */
141 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
142 {
143         waiter->wake_up_time = abs_time;
144 }
145
146 /* Give this a relative time from now, in microseconds.  This might be easier to
147  * use than dealing with the TSC. */
148 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
149 {
150         uint64_t now, then;
151         now = read_tsc();
152         then = now + usec2tsc(usleep);
153         /* This will go off if we wrap-around the TSC.  It'll never happen for legit
154          * values, but this might catch some bugs with large usleeps. */
155         assert(now <= then);
156         set_awaiter_abs(waiter, then);
157 }
158
159 /* Increment the timer that was already set, so that it goes off usleep usec
160  * from the previous tick.  This is different than 'rel' in that it doesn't care
161  * about when 'now' is. */
162 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
163 {
164         assert(waiter->wake_up_time != ALARM_POISON_TIME);
165         waiter->wake_up_time += usec2tsc(usleep);
166 }
167
168 /* User interface to the global tchain */
169 void __set_alarm(struct alarm_waiter *waiter)
170 {
171         __tc_locked_set_alarm(&global_tchain, waiter);
172 }
173
174 void set_alarm(struct alarm_waiter *waiter)
175 {
176         __tc_set_alarm(&global_tchain, waiter);
177 }
178
179 bool unset_alarm(struct alarm_waiter *waiter)
180 {
181         return __tc_unset_alarm(&global_tchain, waiter);
182 }
183
184 void reset_alarm_abs(struct alarm_waiter *waiter, uint64_t abs_time)
185 {
186         __tc_reset_alarm_abs(&global_tchain, waiter, abs_time);
187 }
188
189 /* Helper, makes sure the kernel alarm is turned on at the right time. */
190 static void reset_tchain_interrupt(struct timer_chain *tchain)
191 {
192         int ret;
193         char buf[20];
194         if (TAILQ_EMPTY(&tchain->waiters)) {
195                 /* Turn it off */
196                 printd("Turning alarm off\n");
197                 ret = write(tchain->ctlfd, "cancel", sizeof("cancel"));
198                 if (ret <= 0) {
199                         printf("Useralarm: unable to disarm alarm!\n");
200                         return;
201                 }
202         } else {
203                 /* Make sure it is on and set to the earliest time */
204                 assert(tchain->earliest_time != ALARM_POISON_TIME);
205                 /* TODO: check for times in the past or very close to now */
206                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
207                 ret = snprintf(buf, sizeof(buf), "%llx", tchain->earliest_time);
208                 ret = write(tchain->timerfd, buf, ret);
209                 if (ret <= 0) {
210                         perror("Useralarm: Failed to set timer");
211                         return;
212                 }
213         }
214 }
215
216 /* When an awaiter's time has come, this gets called. */
217 static void wake_awaiter(struct alarm_waiter *waiter)
218 {
219         waiter->on_tchain = FALSE;
220         cmb();  /* enforce the on_tchain write before the handlers */
221         waiter->func(waiter);
222 }
223
224 /* This is called when the kernel alarm triggers a tchain, and needs to wake up
225  * everyone whose time is up.  Called from vcore context. */
226 static void __trigger_tchain(struct timer_chain *tchain)
227 {
228         struct alarm_waiter *i, *temp;
229         uint64_t now = read_tsc();
230         bool changed_list = FALSE;
231         spin_pdr_lock(&tchain->lock);
232         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
233                 printd("Trying to wake up %p who is due at %llu and now is %llu\n",
234                        i, i->wake_up_time, now);
235                 /* TODO: Could also do something in cases where we're close to now */
236                 if (i->wake_up_time <= now) {
237                         changed_list = TRUE;
238                         TAILQ_REMOVE(&tchain->waiters, i, next);
239                         /* Don't touch the waiter after waking it, since it could be in use
240                          * on another core (and the waiter can be clobbered as the kthread
241                          * unwinds its stack).  Or it could be kfreed */
242                         wake_awaiter(i);
243                 } else {
244                         break;
245                 }
246         }
247         if (changed_list) {
248                 reset_tchain_times(tchain);
249         }
250         /* Need to reset the interrupt no matter what */
251         reset_tchain_interrupt(tchain);
252         spin_pdr_unlock(&tchain->lock);
253 }
254
255 static void handle_user_alarm(struct event_msg *ev_msg, unsigned int ev_type)
256 {
257         assert(ev_type == EV_ALARM);
258         if (ev_msg && (ev_msg->ev_arg2 == global_tchain.alarmid))
259                 __trigger_tchain(&global_tchain);
260 }
261
262 /* Helper, inserts the waiter into the tchain, returning TRUE if we still need
263  * to reset the tchain interrupt.  Caller holds the lock. */
264 static bool __insert_awaiter(struct timer_chain *tchain,
265                              struct alarm_waiter *waiter)
266 {
267         struct alarm_waiter *i, *temp;
268         /* This will fail if you don't set a time */
269         assert(waiter->wake_up_time != ALARM_POISON_TIME);
270         waiter->on_tchain = TRUE;
271         /* Either the list is empty, or not. */
272         if (TAILQ_EMPTY(&tchain->waiters)) {
273                 tchain->earliest_time = waiter->wake_up_time;
274                 tchain->latest_time = waiter->wake_up_time;
275                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
276                 /* Need to turn on the timer interrupt later */
277                 return TRUE;
278         }
279         /* If not, either we're first, last, or in the middle.  Reset the interrupt
280          * and adjust the tchain's times accordingly. */
281         if (waiter->wake_up_time < tchain->earliest_time) {
282                 tchain->earliest_time = waiter->wake_up_time;
283                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
284                 /* Changed the first entry; we'll need to reset the interrupt later */
285                 return TRUE;
286         }
287         /* If there is a tie for last, the newer one will really go last.  We need
288          * to handle equality here since the loop later won't catch it. */
289         if (waiter->wake_up_time >= tchain->latest_time) {
290                 tchain->latest_time = waiter->wake_up_time;
291                 /* Proactively put it at the end if we know we're last */
292                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
293                 return FALSE;
294         }
295         /* Insert before the first one you are earlier than.  This won't scale well
296          * (TODO) if we have a lot of inserts.  The proactive insert_tail up above
297          * will help a bit. */
298         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
299                 if (waiter->wake_up_time < i->wake_up_time) {
300                         TAILQ_INSERT_BEFORE(i, waiter, next);
301                         return FALSE;
302                 }
303         }
304         printf("Could not find a spot for awaiter %p\n", waiter);
305 }
306
307 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
308  * later.  This version assumes you have the lock held.  That only makes sense
309  * from alarm handlers, which are called with this lock held from IRQ context */
310 static void __tc_locked_set_alarm(struct timer_chain *tchain,
311                                   struct alarm_waiter *waiter)
312 {       
313         if (__insert_awaiter(tchain, waiter))
314                 reset_tchain_interrupt(tchain);
315 }
316
317 /* Sets the alarm.  Don't call this from an alarm handler, since you already
318  * have the lock held.  Call __set_alarm() instead. */
319 static void __tc_set_alarm(struct timer_chain *tchain,
320                            struct alarm_waiter *waiter)
321 {
322         spin_pdr_lock(&tchain->lock);
323         __set_alarm(waiter);
324         spin_pdr_unlock(&tchain->lock);
325 }
326
327 /* Helper, rips the waiter from the tchain, knowing that it is on the list.
328  * Returns TRUE if the tchain interrupt needs to be reset.  Callers hold the
329  * lock. */
330 static bool __remove_awaiter(struct timer_chain *tchain,
331                              struct alarm_waiter *waiter)
332 {
333         struct alarm_waiter *temp;
334         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
335         /* Need to make sure earliest and latest are set, in case we're mucking with
336          * the first and/or last element of the chain. */
337         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
338                 temp = TAILQ_NEXT(waiter, next);
339                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
340                 reset_int = TRUE;               /* we'll need to reset the timer later */
341         }
342         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
343                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
344                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
345         }
346         TAILQ_REMOVE(&tchain->waiters, waiter, next);
347         return reset_int;
348 }
349
350 /* Removes waiter from the tchain before it goes off.  Returns TRUE if we
351  * disarmed before the alarm went off, FALSE if it already fired. */
352 static bool __tc_unset_alarm(struct timer_chain *tchain,
353                              struct alarm_waiter *waiter)
354 {
355         spin_pdr_lock(&tchain->lock);
356         if (!waiter->on_tchain) {
357                 /* the alarm has already gone off.  its not even on this tchain's list,
358                  * though the concurrent change to on_tchain (specifically, the setting
359                  * of it to FALSE), happens under the tchain's lock. */
360                 spin_pdr_unlock(&tchain->lock);
361                 return FALSE;
362         }
363         if (__remove_awaiter(tchain, waiter))
364                 reset_tchain_interrupt(tchain);
365         spin_pdr_unlock(&tchain->lock);
366         return TRUE;
367 }
368
369 /* waiter may be on the tchain, or it might have fired already and be off the
370  * tchain.  Either way, this will put the waiter on the list, set to go off at
371  * abs_time.  If you know the alarm has fired, don't call this.  Just set the
372  * awaiter, and then set_alarm() */
373 static void __tc_reset_alarm_abs(struct timer_chain *tchain,
374                                  struct alarm_waiter *waiter, uint64_t abs_time)
375 {
376         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
377         spin_pdr_lock(&tchain->lock);
378         /* We only need to remove/unset when the alarm has not fired yet (is still
379          * on the tchain).  If it has fired, it's like a fresh insert */
380         if (waiter->on_tchain)
381                 reset_int = __remove_awaiter(tchain, waiter);
382         set_awaiter_abs(waiter, abs_time);
383         /* regardless, we need to be reinserted */
384         if (__insert_awaiter(tchain, waiter) || reset_int)
385                 reset_tchain_interrupt(tchain);
386         spin_pdr_unlock(&tchain->lock);
387 }
388
389 /* Debug helpers */
390
391 void print_chain(struct timer_chain *tchain)
392 {
393         struct alarm_waiter *i;
394         spin_pdr_lock(&tchain->lock);
395         printf("Chain %p is%s empty, early: %llu latest: %llu\n", tchain,
396                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
397                tchain->earliest_time,
398                tchain->latest_time);
399         spin_pdr_unlock(&tchain->lock);
400 }
401
402 /* "parlib" alarm handlers */
403 void alarm_abort_sysc(struct alarm_waiter *awaiter)
404 {
405         struct uthread *uth = awaiter->data;
406         assert(uth);
407         if (!uth->sysc) {
408                 /* It's possible the sysc hasn't blocked yet or is in the process of
409                  * unblocking, or even has returned, but hasn't cancelled the alarm.
410                  * regardless, we request a new alarm (the uthread will cancel us one
411                  * way or another). */
412                 set_awaiter_inc(awaiter, 1000000);
413                 __set_alarm(awaiter);
414                 return;
415         }
416         sys_abort_sysc(uth->sysc);
417 }