Unmap pages mapped during a failed fill_vmr()
[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 <parlib/assert.h>
29 #include <parlib/stdio.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 <parlib/uthread.h>
38 #include <parlib/spinlock.h>
39 #include <parlib/timing.h>
40 #include <sys/plan9_helpers.h>
41 #include <sys/fork_cb.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_set_alarm(struct timer_chain *tchain,
110                            struct alarm_waiter *waiter);
111 static bool __tc_unset_alarm(struct timer_chain *tchain,
112                              struct alarm_waiter *waiter);
113 static bool __tc_reset_alarm_abs(struct timer_chain *tchain,
114                                  struct alarm_waiter *waiter,
115                                  uint64_t abs_time);
116 static void handle_user_alarm(struct event_msg *ev_msg, unsigned int ev_type,
117                               void *data);
118
119 /* One chain to rule them all. */
120 struct timer_chain global_tchain;
121
122 /* Helper, resets the earliest/latest times, based on the elements of the list.
123  * If the list is empty, we set the times to be the 12345 poison time.  Since
124  * the list is empty, the alarm shouldn't be going off. */
125 static void reset_tchain_times(struct timer_chain *tchain)
126 {
127         if (TAILQ_EMPTY(&tchain->waiters)) {
128                 tchain->earliest_time = ALARM_POISON_TIME;
129                 tchain->latest_time = ALARM_POISON_TIME;
130         } else {
131                 tchain->earliest_time =
132                     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,
143                              NULL))
144                 perror("Useralarm on fork");
145 }
146
147 static void __attribute__((constructor)) alarm_service_ctor(void)
148 {
149         int ctlfd, timerfd, alarmid;
150         struct event_queue *ev_q;
151         static struct fork_cb devalarm_fork_cb = {.func = devalarm_forked};
152
153         if (__in_fake_parlib())
154                 return;
155         /* Sets up timer chain (only one chain per process) */
156         TAILQ_INIT(&global_tchain.waiters);
157         global_tchain.running = NULL;
158         reset_tchain_times(&global_tchain);
159         uth_cond_var_init(&global_tchain.cv);
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
166          * ev_q.  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
175          * use an INDIR (probably with SPAM_INDIR too) instead of SPAM_PUBLIC.
176          */
177         ev_q->ev_flags = EVENT_IPI | EVENT_SPAM_PUBLIC | EVENT_WAKEUP;
178         if (devalarm_set_evq(timerfd, ev_q, alarmid)) {
179                 perror("set_alarm_evq");
180                 return;
181         }
182         /* now the alarm is all set, just need to write the timer whenever we
183          * want it to go off. */
184         global_tchain.alarmid = alarmid;
185         global_tchain.ctlfd = ctlfd;
186         global_tchain.timerfd = timerfd;
187         global_tchain.ev_q = ev_q;      /* mostly for debugging */
188         register_fork_cb(&devalarm_fork_cb);
189 }
190
191 /* Initializes a new awaiter. */
192 void init_awaiter(struct alarm_waiter *waiter,
193                   void (*func) (struct alarm_waiter *awaiter))
194 {
195         waiter->wake_up_time = ALARM_POISON_TIME;
196         assert(func);
197         waiter->func = func;
198         waiter->on_tchain = false;
199 }
200
201 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
202  * the alarm to go off. */
203 static void __set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
204 {
205         waiter->wake_up_time = abs_time;
206 }
207
208 /* Give this the absolute unix time (in microseconds) that you want the alarm
209  * to go off. */
210 void set_awaiter_abs_unix(struct alarm_waiter *waiter, uint64_t abs_usec)
211 {
212         __set_awaiter_abs(waiter, epoch_nsec_to_tsc(abs_usec * 1000));
213 }
214
215 /* Give this a relative time from now, in microseconds.  This might be easier to
216  * use than dealing with the TSC. */
217 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
218 {
219         uint64_t now, then;
220
221         now = read_tsc();
222         then = now + usec2tsc(usleep);
223         /* This will go off if we wrap-around the TSC.  It'll never happen for
224          * legit values, but this might catch some bugs with large usleeps. */
225         assert(now <= then);
226         __set_awaiter_abs(waiter, then);
227 }
228
229 /* Increment the timer that was already set, so that it goes off usleep usec
230  * from the previous tick.  This is different than 'rel' in that it doesn't care
231  * about when 'now' is. */
232 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
233 {
234         assert(waiter->wake_up_time != ALARM_POISON_TIME);
235         waiter->wake_up_time += usec2tsc(usleep);
236 }
237
238 /* User interface to the global tchain */
239 void set_alarm(struct alarm_waiter *waiter)
240 {
241         __tc_set_alarm(&global_tchain, waiter);
242 }
243
244 bool unset_alarm(struct alarm_waiter *waiter)
245 {
246         return __tc_unset_alarm(&global_tchain, waiter);
247 }
248
249 bool reset_alarm_abs(struct alarm_waiter *waiter, uint64_t abs_time)
250 {
251         return __tc_reset_alarm_abs(&global_tchain, waiter, abs_time);
252 }
253
254 /* Helper, makes sure the kernel alarm is turned on at the right time. */
255 static void reset_tchain_interrupt(struct timer_chain *tchain)
256 {
257         if (TAILQ_EMPTY(&tchain->waiters)) {
258                 /* Turn it off */
259                 printd("Turning alarm off\n");
260                 if (devalarm_disable(tchain->timerfd)) {
261                         printf("Useralarm: unable to disarm alarm!\n");
262                         return;
263                 }
264         } else {
265                 /* Make sure it is on and set to the earliest time */
266                 assert(tchain->earliest_time != ALARM_POISON_TIME);
267                 /* TODO: check for times in the past or very close to now */
268                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
269                 if (devalarm_set_time(tchain->timerfd, tchain->earliest_time)) {
270                         perror("Useralarm: Failed to set timer");
271                         return;
272                 }
273         }
274 }
275
276 /* This is called when the kernel alarm triggers a tchain, and needs to wake up
277  * everyone whose time is up.  Called from vcore context. */
278 static void __trigger_tchain(struct timer_chain *tchain)
279 {
280         struct alarm_waiter *i, *temp;
281         struct uthread *unsetter;
282
283         spin_pdr_lock(&tchain->cv.lock);
284         /* It's possible we have multiple contexts running a single tchain.  It
285          * shouldn't be possible for per-core tchains, but it is possible
286          * otherwise.  In that case, we can just abort, treating the event/IRQ
287          * that woke us up as a 'poke'. */
288         if (tchain->running) {
289                 spin_pdr_unlock(&tchain->cv.lock);
290                 return;
291         }
292         while ((i = TAILQ_FIRST(&tchain->waiters))) {
293                 /* TODO: Could also do something in cases where it's close to
294                  * expiring. */
295                 if (i->wake_up_time > read_tsc())
296                         break;
297                 TAILQ_REMOVE(&tchain->waiters, i, next);
298                 i->on_tchain = false;
299                 tchain->running = i;
300
301                 /* Need the tchain times (earliest/latest) in sync when
302                  * unlocked. */
303                 reset_tchain_times(tchain);
304
305                 spin_pdr_unlock(&tchain->cv.lock);
306
307                 /* Don't touch the waiter after running it, since the memory can
308                  * be used immediately */
309                 i->func(i);
310
311                 spin_pdr_lock(&tchain->cv.lock);
312                 tchain->running = NULL;
313
314                 /* This is the guts of a signal, but we're optimizing for the
315                  * common case where there is no unsetter.  Uthread CV
316                  * signal/broadcast wakes the uthreads up outside of the CV
317                  * lock, which will avoid any lock-ordering issues with the 2LS
318                  * and the CV - in this case, the alarm service. */
319                 unsetter = __uth_cond_var_wake_one(&tchain->cv);
320                 if (unsetter) {
321                         spin_pdr_unlock(&tchain->cv.lock);
322                         uthread_runnable(unsetter);
323                         spin_pdr_lock(&tchain->cv.lock);
324                 }
325         }
326         reset_tchain_interrupt(tchain);
327         spin_pdr_unlock(&tchain->cv.lock);
328 }
329
330 static void handle_user_alarm(struct event_msg *ev_msg, unsigned int ev_type,
331                               void *data)
332 {
333         assert(ev_type == EV_ALARM);
334         if (devalarm_get_id(ev_msg) == global_tchain.alarmid)
335                 __trigger_tchain(&global_tchain);
336 }
337
338 /* Helper, inserts the waiter into the tchain, returning TRUE if we still need
339  * to reset the tchain interrupt.  Caller holds the lock. */
340 static bool __insert_awaiter(struct timer_chain *tchain,
341                              struct alarm_waiter *waiter)
342 {
343         struct alarm_waiter *i, *temp;
344
345         waiter->on_tchain = TRUE;
346         /* Either the list is empty, or not. */
347         if (TAILQ_EMPTY(&tchain->waiters)) {
348                 tchain->earliest_time = waiter->wake_up_time;
349                 tchain->latest_time = waiter->wake_up_time;
350                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
351                 /* Need to turn on the timer interrupt later */
352                 return TRUE;
353         }
354         /* If not, either we're first, last, or in the middle.  Reset the
355          * interrupt and adjust the tchain's times accordingly. */
356         if (waiter->wake_up_time < tchain->earliest_time) {
357                 tchain->earliest_time = waiter->wake_up_time;
358                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
359                 /* Changed the first entry; we'll need to reset the interrupt
360                  * later */
361                 return TRUE;
362         }
363         /* If there is a tie for last, the newer one will really go last.  We
364          * need to handle equality here since the loop later won't catch it. */
365         if (waiter->wake_up_time >= tchain->latest_time) {
366                 tchain->latest_time = waiter->wake_up_time;
367                 /* Proactively put it at the end if we know we're last */
368                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
369                 return FALSE;
370         }
371         /* Insert before the first one you are earlier than.  This won't scale
372          * well (TODO) if we have a lot of inserts.  The proactive insert_tail
373          * up above will help a bit. */
374         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
375                 if (waiter->wake_up_time < i->wake_up_time) {
376                         TAILQ_INSERT_BEFORE(i, waiter, next);
377                         return FALSE;
378                 }
379         }
380         panic("Could not find a spot for awaiter %p\n", waiter);
381 }
382
383 static void __tc_set_alarm(struct timer_chain *tchain,
384                            struct alarm_waiter *waiter)
385 {
386         assert(waiter->wake_up_time != ALARM_POISON_TIME);
387         assert(!waiter->on_tchain);
388
389         spin_pdr_lock(&tchain->cv.lock);
390         if (__insert_awaiter(tchain, waiter))
391                 reset_tchain_interrupt(tchain);
392         spin_pdr_unlock(&tchain->cv.lock);
393 }
394
395 /* Helper, rips the waiter from the tchain, knowing that it is on the list.
396  * Returns TRUE if the tchain interrupt needs to be reset.  Callers hold the
397  * lock. */
398 static bool __remove_awaiter(struct timer_chain *tchain,
399                              struct alarm_waiter *waiter)
400 {
401         struct alarm_waiter *temp;
402         bool reset_int = FALSE; /* whether or not to reset the interrupt */
403
404         /* Need to make sure earliest and latest are set, in case we're mucking
405          * with the first and/or last element of the chain. */
406         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
407                 temp = TAILQ_NEXT(waiter, next);
408                 tchain->earliest_time = (temp) ? temp->wake_up_time :
409                                                  ALARM_POISON_TIME;
410                 reset_int = TRUE; /* we'll need to reset the timer later */
411         }
412         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
413                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
414                 tchain->latest_time = (temp) ? temp->wake_up_time :
415                                                ALARM_POISON_TIME;
416         }
417         TAILQ_REMOVE(&tchain->waiters, waiter, next);
418         waiter->on_tchain = FALSE;
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.  May block,
424  * since the handler may be running asynchronously. */
425 static bool __tc_unset_alarm(struct timer_chain *tchain,
426                              struct alarm_waiter *waiter)
427 {
428         spin_pdr_lock(&tchain->cv.lock);
429         for (;;) {
430                 if (waiter->on_tchain) {
431                         if (__remove_awaiter(tchain, waiter))
432                                 reset_tchain_interrupt(tchain);
433                         spin_pdr_unlock(&tchain->cv.lock);
434                         return true;
435                 }
436                 if (tchain->running != waiter) {
437                         spin_pdr_unlock(&tchain->cv.lock);
438                         return false;
439                 }
440                 /* It's running.  We'll need to try again.  Note the alarm could
441                  * have resubmitted itself, so ideally the caller can tell it to
442                  * not resubmit.
443                  *
444                  * Despite the slightly more difficult wake-up code in userspace
445                  * compared to the kernel, it's still better to use a CV here.
446                  * Some go tests in qemu were more likely to timeout/starve even
447                  * if we did some form of unlock/yield/relock pattern. */
448                 uth_cond_var_wait(&tchain->cv, NULL);
449         }
450 }
451
452 /* waiter may be on the tchain, or it might have fired already and be off the
453  * tchain.  Either way, this will put the waiter on the list, set to go off at
454  * abs_time.  If you know the alarm has fired, don't call this.  Just set the
455  * awaiter, and then set_alarm() */
456 static bool __tc_reset_alarm_abs(struct timer_chain *tchain,
457                                  struct alarm_waiter *waiter, uint64_t abs_time)
458 {
459         bool ret;
460
461         ret = __tc_unset_alarm(tchain, waiter);
462         __set_awaiter_abs(waiter, abs_time);
463         __tc_set_alarm(tchain, waiter);
464         return ret;
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->cv.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->cv.lock);
478 }
479
480 /* "parlib" alarm handlers */
481 void alarm_abort_sysc(struct alarm_waiter *awaiter)
482 {
483         struct uthread *uth = awaiter->data;
484
485         assert(uth);
486         if (uth->sysc && sys_abort_sysc(uth->sysc))
487                 return;
488         /* There are a bunch of reasons why we didn't abort the syscall.  The
489          * syscall might not have been issued or blocked at all, so uth->sysc
490          * would be NULL.  The syscall might have blocked, but at a
491          * non-abortable location
492          * - picture blocking on a qlock, then unblocking and blocking later on
493          *   a rendez.  If you try to abort in between, abort_sysc will fail,
494          *   then we'll get blocked on the rendez until the next abort.
495          *   Finally, the syscall might have completed, but the uthread hasn't
496          *   cancelled the alarm yet.
497          *
498          * It's always safe to rearm the alarm - the uthread will unset it and
499          * break us out of the rearm loop. */
500         set_awaiter_rel(awaiter, 10000);
501         set_alarm(awaiter);
502 }