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