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