parlib: Fix the use-after-func issue
[akaros.git] / user / parlib / alarm.c
1 /* Copyright (c) 2013 The Regents of the University of California
2  * Copyright (c) 2018 Google Inc.
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  *
6  * Userspace alarms.  There are lower level helpers to build your own alarms
7  * from the #alarm device and an alarm service, based off a slimmed down version
8  * of the kernel alarms.  Under the hood, the user alarm uses the #alarm service
9  * for the root of the alarm chain.
10  *
11  * There's only one timer chain, unlike in the kernel, for the entire process.
12  * If you want one-off timers unrelated to the chain (and sent to other vcores),
13  * use #alarm directly.
14  *
15  * Your handlers will run from vcore context.
16  *
17  * Code differences from the kernel (for future porting):
18  * - init_alarm_service, run as a constructor
19  * - set_alarm() and friends are __tc_set_alarm(), passing global_tchain.
20  * - reset_tchain_interrupt() uses #alarm
21  * - spinlocks -> spin_pdr_locks (cv's lock, actually)
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 <parlib/alarm.h>
28 #include <stdio.h>
29 #include <parlib/assert.h>
30 #include <parlib/stdio.h>
31 #include <stdlib.h>
32 #include <unistd.h>
33 #include <sys/types.h>
34 #include <sys/stat.h>
35 #include <fcntl.h>
36 #include <parlib/parlib.h>
37 #include <parlib/event.h>
38 #include <parlib/uthread.h>
39 #include <parlib/spinlock.h>
40 #include <parlib/timing.h>
41 #include <sys/plan9_helpers.h>
42 #include <sys/fork_cb.h>
43
44 /* Helper to get your own alarm.   If you don't care about a return value, pass
45  * 0 and it'll be ignored.  The alarm is built, but has no evq or timer set. */
46 int devalarm_get_fds(int *ctlfd_r, int *timerfd_r, int *alarmid_r)
47 {
48         int ctlfd, timerfd, alarmid, ret;
49         char buf[20];
50         char path[32];
51
52         ctlfd = open("#alarm/clone", O_RDWR | O_CLOEXEC);
53         if (ctlfd < 0)
54                 return -1;
55         ret = read(ctlfd, buf, sizeof(buf) - 1);
56         if (ret <= 0)
57                 return -1;
58         buf[ret] = 0;
59         alarmid = atoi(buf);
60         snprintf(path, sizeof(path), "#alarm/a%s/timer", buf);
61         timerfd = open(path, O_RDWR | O_CLOEXEC);
62         if (timerfd < 0)
63                 return -1;
64         if (ctlfd_r)
65                 *ctlfd_r = ctlfd;
66         else
67                 close(ctlfd);
68         if (timerfd_r)
69                 *timerfd_r = timerfd;
70         else
71                 close(timerfd);
72         if (alarmid_r)
73                 *alarmid_r = alarmid;
74         return 0;
75 }
76
77 int devalarm_set_evq(int timerfd, struct event_queue *ev_q, int alarmid)
78 {
79         struct fd_tap_req tap_req = {0};
80
81         tap_req.fd = timerfd;
82         tap_req.cmd = FDTAP_CMD_ADD;
83         tap_req.filter = FDTAP_FILT_WRITTEN;
84         tap_req.ev_id = EV_ALARM;
85         tap_req.ev_q = ev_q;
86         tap_req.data = (void*)(long)alarmid;
87         if (sys_tap_fds(&tap_req, 1) != 1)
88                 return -1;
89         return 0;
90 }
91
92 int devalarm_set_time(int timerfd, uint64_t tsc_time)
93 {
94         return write_hex_to_fd(timerfd, tsc_time);
95 }
96
97 int devalarm_get_id(struct event_msg *ev_msg)
98 {
99         if (!ev_msg)
100                 return -1;
101         return (int)(long)ev_msg->ev_arg3;
102 }
103
104 int devalarm_disable(int timerfd)
105 {
106         return write_hex_to_fd(timerfd, 0);
107 }
108
109 /* Helpers, basically renamed kernel interfaces, with the *tchain. */
110 static void __tc_set_alarm(struct timer_chain *tchain,
111                            struct alarm_waiter *waiter);
112 static bool __tc_unset_alarm(struct timer_chain *tchain,
113                              struct alarm_waiter *waiter);
114 static bool __tc_reset_alarm_abs(struct timer_chain *tchain,
115                                  struct alarm_waiter *waiter,
116                                  uint64_t abs_time);
117 static void handle_user_alarm(struct event_msg *ev_msg, unsigned int ev_type,
118                               void *data);
119
120 /* One chain to rule them all. */
121 struct timer_chain global_tchain;
122
123 /* Helper, resets the earliest/latest times, based on the elements of the list.
124  * If the list is empty, we set the times to be the 12345 poison time.  Since
125  * the list is empty, the alarm shouldn't be going off. */
126 static void reset_tchain_times(struct timer_chain *tchain)
127 {
128         if (TAILQ_EMPTY(&tchain->waiters)) {
129                 tchain->earliest_time = ALARM_POISON_TIME;
130                 tchain->latest_time = ALARM_POISON_TIME;
131         } else {
132                 tchain->earliest_time = TAILQ_FIRST(&tchain->waiters)->wake_up_time;
133                 tchain->latest_time =
134                         TAILQ_LAST(&tchain->waiters, awaiters_tailq)->wake_up_time;
135         }
136 }
137
138 static void devalarm_forked(void)
139 {
140         close(global_tchain.ctlfd);
141         close(global_tchain.timerfd);
142         if (devalarm_get_fds(&global_tchain.ctlfd, &global_tchain.timerfd, NULL))
143                 perror("Useralarm on fork");
144 }
145
146 static void __attribute__((constructor)) alarm_service_ctor(void)
147 {
148         int ctlfd, timerfd, alarmid;
149         struct event_queue *ev_q;
150         static struct fork_cb devalarm_fork_cb = {.func = devalarm_forked};
151
152         if (__in_fake_parlib())
153                 return;
154         /* Sets up timer chain (only one chain per process) */
155         TAILQ_INIT(&global_tchain.waiters);
156         global_tchain.running = NULL;
157         reset_tchain_times(&global_tchain);
158         uth_cond_var_init(&global_tchain.cv);
159
160         if (devalarm_get_fds(&ctlfd, &timerfd, &alarmid)) {
161                 perror("Useralarm: devalarm_get_fds");
162                 return;
163         }
164         /* Since we're doing SPAM_PUBLIC later, we actually don't need a big ev_q.
165          * But someone might copy/paste this and change a flag. */
166         register_ev_handler(EV_ALARM, handle_user_alarm, 0);
167         if (!(ev_q = get_eventq(EV_MBOX_UCQ))) {
168                 perror("Useralarm: Failed ev_q");
169                 return;
170         }
171         ev_q->ev_vcore = 0;
172         /* We could get multiple events for a single alarm.  It's okay, since
173          * __trigger can handle spurious upcalls.  If it ever is not okay, then use
174          * an INDIR (probably with SPAM_INDIR too) instead of SPAM_PUBLIC. */
175         ev_q->ev_flags = EVENT_IPI | EVENT_SPAM_PUBLIC | EVENT_WAKEUP;
176         if (devalarm_set_evq(timerfd, ev_q, alarmid)) {
177                 perror("set_alarm_evq");
178                 return;
179         }
180         /* now the alarm is all set, just need to write the timer whenever we want
181          * it to go off. */
182         global_tchain.alarmid = alarmid;
183         global_tchain.ctlfd = ctlfd;
184         global_tchain.timerfd = timerfd;
185         global_tchain.ev_q = ev_q;      /* mostly for debugging */
186         register_fork_cb(&devalarm_fork_cb);
187 }
188
189 /* Initializes a new awaiter. */
190 void init_awaiter(struct alarm_waiter *waiter,
191                   void (*func) (struct alarm_waiter *awaiter))
192 {
193         waiter->wake_up_time = ALARM_POISON_TIME;
194         assert(func);
195         waiter->func = func;
196         waiter->on_tchain = false;
197 }
198
199 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
200  * the alarm to go off. */
201 static void __set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
202 {
203         waiter->wake_up_time = abs_time;
204 }
205
206 /* Give this the absolute unix time (in microseconds) that you want the alarm
207  * to go off. */
208 void set_awaiter_abs_unix(struct alarm_waiter *waiter, uint64_t abs_usec)
209 {
210         __set_awaiter_abs(waiter, epoch_nsec_to_tsc(abs_usec * 1000));
211 }
212
213 /* Give this a relative time from now, in microseconds.  This might be easier to
214  * use than dealing with the TSC. */
215 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
216 {
217         uint64_t now, then;
218         now = read_tsc();
219         then = now + usec2tsc(usleep);
220         /* This will go off if we wrap-around the TSC.  It'll never happen for legit
221          * values, but this might catch some bugs with large usleeps. */
222         assert(now <= then);
223         __set_awaiter_abs(waiter, then);
224 }
225
226 /* Increment the timer that was already set, so that it goes off usleep usec
227  * from the previous tick.  This is different than 'rel' in that it doesn't care
228  * about when 'now' is. */
229 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
230 {
231         assert(waiter->wake_up_time != ALARM_POISON_TIME);
232         waiter->wake_up_time += usec2tsc(usleep);
233 }
234
235 /* User interface to the global tchain */
236 void set_alarm(struct alarm_waiter *waiter)
237 {
238         __tc_set_alarm(&global_tchain, waiter);
239 }
240
241 bool unset_alarm(struct alarm_waiter *waiter)
242 {
243         return __tc_unset_alarm(&global_tchain, waiter);
244 }
245
246 bool reset_alarm_abs(struct alarm_waiter *waiter, uint64_t abs_time)
247 {
248         return __tc_reset_alarm_abs(&global_tchain, waiter, abs_time);
249 }
250
251 /* Helper, makes sure the kernel alarm is turned on at the right time. */
252 static void reset_tchain_interrupt(struct timer_chain *tchain)
253 {
254         if (TAILQ_EMPTY(&tchain->waiters)) {
255                 /* Turn it off */
256                 printd("Turning alarm off\n");
257                 if (devalarm_disable(tchain->timerfd)) {
258                         printf("Useralarm: unable to disarm alarm!\n");
259                         return;
260                 }
261         } else {
262                 /* Make sure it is on and set to the earliest time */
263                 assert(tchain->earliest_time != ALARM_POISON_TIME);
264                 /* TODO: check for times in the past or very close to now */
265                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
266                 if (devalarm_set_time(tchain->timerfd, tchain->earliest_time)) {
267                         perror("Useralarm: Failed to set timer");
268                         return;
269                 }
270         }
271 }
272
273 /* This is called when the kernel alarm triggers a tchain, and needs to wake up
274  * everyone whose time is up.  Called from vcore context. */
275 static void __trigger_tchain(struct timer_chain *tchain)
276 {
277         struct alarm_waiter *i, *temp;
278         struct uthread *unsetter;
279
280         spin_pdr_lock(&tchain->cv.lock);
281         /* It's possible we have multiple contexts running a single tchain.  It
282          * shouldn't be possible for per-core tchains, but it is possible
283          * otherwise.  In that case, we can just abort, treating the event/IRQ
284          * that woke us up as a 'poke'. */
285         if (tchain->running) {
286                 spin_pdr_unlock(&tchain->cv.lock);
287                 return;
288         }
289         while ((i = TAILQ_FIRST(&tchain->waiters))) {
290                 /* TODO: Could also do something in cases where it's close to
291                  * expiring. */
292                 if (i->wake_up_time > read_tsc())
293                         break;
294                 TAILQ_REMOVE(&tchain->waiters, i, next);
295                 i->on_tchain = false;
296                 tchain->running = i;
297
298                 /* Need the tchain times (earliest/latest) in sync when
299                  * unlocked. */
300                 reset_tchain_times(tchain);
301
302                 spin_pdr_unlock(&tchain->cv.lock);
303
304                 /* Don't touch the waiter after running it, since the memory can
305                  * be used immediately */
306                 i->func(i);
307
308                 spin_pdr_lock(&tchain->cv.lock);
309                 tchain->running = NULL;
310
311                 /* This is the guts of a signal, but we're optimizing for the
312                  * common case where there is no unsetter.  Uthread CV
313                  * signal/broadcast wakes the uthreads up outside of the CV
314                  * lock, which will avoid any lock-ordering issues with the 2LS
315                  * and the CV - in this case, the alarm service. */
316                 unsetter = __uth_cond_var_wake_one(&tchain->cv);
317                 if (unsetter) {
318                         spin_pdr_unlock(&tchain->cv.lock);
319                         uthread_runnable(unsetter);
320                         spin_pdr_lock(&tchain->cv.lock);
321                 }
322         }
323         reset_tchain_interrupt(tchain);
324         spin_pdr_unlock(&tchain->cv.lock);
325 }
326
327 static void handle_user_alarm(struct event_msg *ev_msg, unsigned int ev_type,
328                               void *data)
329 {
330         assert(ev_type == EV_ALARM);
331         if (devalarm_get_id(ev_msg) == global_tchain.alarmid)
332                 __trigger_tchain(&global_tchain);
333 }
334
335 /* Helper, inserts the waiter into the tchain, returning TRUE if we still need
336  * to reset the tchain interrupt.  Caller holds the lock. */
337 static bool __insert_awaiter(struct timer_chain *tchain,
338                              struct alarm_waiter *waiter)
339 {
340         struct alarm_waiter *i, *temp;
341
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         panic("Could not find a spot for awaiter %p\n", waiter);
377 }
378
379 static void __tc_set_alarm(struct timer_chain *tchain,
380                            struct alarm_waiter *waiter)
381 {
382         assert(waiter->wake_up_time != ALARM_POISON_TIME);
383         assert(!waiter->on_tchain);
384
385         spin_pdr_lock(&tchain->cv.lock);
386         if (__insert_awaiter(tchain, waiter))
387                 reset_tchain_interrupt(tchain);
388         spin_pdr_unlock(&tchain->cv.lock);
389 }
390
391 /* Helper, rips the waiter from the tchain, knowing that it is on the list.
392  * Returns TRUE if the tchain interrupt needs to be reset.  Callers hold the
393  * lock. */
394 static bool __remove_awaiter(struct timer_chain *tchain,
395                              struct alarm_waiter *waiter)
396 {
397         struct alarm_waiter *temp;
398         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
399
400         /* Need to make sure earliest and latest are set, in case we're mucking with
401          * the first and/or last element of the chain. */
402         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
403                 temp = TAILQ_NEXT(waiter, next);
404                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
405                 reset_int = TRUE;               /* we'll need to reset the timer later */
406         }
407         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
408                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
409                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
410         }
411         TAILQ_REMOVE(&tchain->waiters, waiter, next);
412         waiter->on_tchain = FALSE;
413         return reset_int;
414 }
415
416 /* Removes waiter from the tchain before it goes off.  Returns TRUE if we
417  * disarmed before the alarm went off, FALSE if it already fired.  May block,
418  * since the handler may be running asynchronously. */
419 static bool __tc_unset_alarm(struct timer_chain *tchain,
420                              struct alarm_waiter *waiter)
421 {
422         spin_pdr_lock(&tchain->cv.lock);
423         for (;;) {
424                 if (waiter->on_tchain) {
425                         if (__remove_awaiter(tchain, waiter))
426                                 reset_tchain_interrupt(tchain);
427                         spin_pdr_unlock(&tchain->cv.lock);
428                         return true;
429                 }
430                 if (tchain->running != waiter) {
431                         spin_pdr_unlock(&tchain->cv.lock);
432                         return false;
433                 }
434                 /* It's running.  We'll need to try again.  Note the alarm could
435                  * have resubmitted itself, so ideally the caller can tell it to
436                  * not resubmit.
437                  *
438                  * Despite the slightly more difficult wake-up code in userspace
439                  * compared to the kernel, it's still better to use a CV here.
440                  * Some go tests in qemu were more likely to timeout/starve even
441                  * if we did some form of unlock/yield/relock pattern. */
442                 uth_cond_var_wait(&tchain->cv, NULL);
443         }
444 }
445
446 /* waiter may be on the tchain, or it might have fired already and be off the
447  * tchain.  Either way, this will put the waiter on the list, set to go off at
448  * abs_time.  If you know the alarm has fired, don't call this.  Just set the
449  * awaiter, and then set_alarm() */
450 static bool __tc_reset_alarm_abs(struct timer_chain *tchain,
451                                  struct alarm_waiter *waiter, uint64_t abs_time)
452 {
453         bool ret;
454
455         ret = __tc_unset_alarm(tchain, waiter);
456         __set_awaiter_abs(waiter, abs_time);
457         __tc_set_alarm(tchain, waiter);
458         return ret;
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->cv.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->cv.lock);
472 }
473
474 /* "parlib" alarm handlers */
475 void alarm_abort_sysc(struct alarm_waiter *awaiter)
476 {
477         struct uthread *uth = awaiter->data;
478
479         assert(uth);
480         if (uth->sysc && sys_abort_sysc(uth->sysc))
481                 return;
482         /* There are a bunch of reasons why we didn't abort the syscall.  The
483          * syscall might not have been issued or blocked at all, so uth->sysc would
484          * be NULL.  The syscall might have blocked, but at a non-abortable location
485          * - picture blocking on a qlock, then unblocking and blocking later on a
486          * rendez.  If you try to abort in between, abort_sysc will fail, then we'll
487          * get blocked on the rendez until the next abort.  Finally, the syscall
488          * might have completed, but the uthread hasn't cancelled the alarm yet.
489          *
490          * It's always safe to rearm the alarm - the uthread will unset it and break
491          * us out of the rearm loop. */
492         set_awaiter_rel(awaiter, 10000);
493         set_alarm(awaiter);
494 }