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