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