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