parlib: Add reader-writer sleeping locks
[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 <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_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 /* Helper, resets the earliest/latest times, based on the elements of the list.
125  * If the list is empty, we set the times to be the 12345 poison time.  Since
126  * the list is empty, the alarm shouldn't be going off. */
127 static void reset_tchain_times(struct timer_chain *tchain)
128 {
129         if (TAILQ_EMPTY(&tchain->waiters)) {
130                 tchain->earliest_time = ALARM_POISON_TIME;
131                 tchain->latest_time = ALARM_POISON_TIME;
132         } else {
133                 tchain->earliest_time = TAILQ_FIRST(&tchain->waiters)->wake_up_time;
134                 tchain->latest_time =
135                         TAILQ_LAST(&tchain->waiters, awaiters_tailq)->wake_up_time;
136         }
137 }
138
139 static void devalarm_forked(void)
140 {
141         /* We need to poison the FDs too, in case the child attempts to use the
142          * alarms.  It'd be chaos if they read/wrote to an arbitrary open FD. */
143         close(global_tchain.ctlfd);
144         global_tchain.ctlfd = -42;
145         close(global_tchain.timerfd);
146         global_tchain.timerfd = -42;
147 }
148
149 static void __attribute__((constructor)) init_alarm_service(void)
150 {
151         int ctlfd, timerfd, alarmid;
152         struct event_queue *ev_q;
153         static struct fork_cb devalarm_fork_cb = {.func = devalarm_forked};
154
155         /* Sets up timer chain (only one chain per process) */
156         spin_pdr_init(&global_tchain.lock);
157         TAILQ_INIT(&global_tchain.waiters);
158         reset_tchain_times(&global_tchain);
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_locked_set_alarm(&global_tchain, waiter);
239 }
240
241 void set_alarm(struct alarm_waiter *waiter)
242 {
243         __tc_set_alarm(&global_tchain, waiter);
244 }
245
246 bool unset_alarm(struct alarm_waiter *waiter)
247 {
248         return __tc_unset_alarm(&global_tchain, waiter);
249 }
250
251 void reset_alarm_abs(struct alarm_waiter *waiter, uint64_t abs_time)
252 {
253         __tc_reset_alarm_abs(&global_tchain, waiter, abs_time);
254 }
255
256 /* Helper, makes sure the kernel alarm is turned on at the right time. */
257 static void reset_tchain_interrupt(struct timer_chain *tchain)
258 {
259         if (TAILQ_EMPTY(&tchain->waiters)) {
260                 /* Turn it off */
261                 printd("Turning alarm off\n");
262                 if (devalarm_disable(tchain->timerfd)) {
263                         printf("Useralarm: unable to disarm alarm!\n");
264                         return;
265                 }
266         } else {
267                 /* Make sure it is on and set to the earliest time */
268                 assert(tchain->earliest_time != ALARM_POISON_TIME);
269                 /* TODO: check for times in the past or very close to now */
270                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
271                 if (devalarm_set_time(tchain->timerfd, tchain->earliest_time)) {
272                         perror("Useralarm: Failed to set timer");
273                         return;
274                 }
275         }
276 }
277
278 /* When an awaiter's time has come, this gets called. */
279 static void wake_awaiter(struct alarm_waiter *waiter)
280 {
281         waiter->on_tchain = FALSE;
282         cmb();  /* enforce the on_tchain write before the handlers */
283         waiter->func(waiter);
284 }
285
286 /* This is called when the kernel alarm triggers a tchain, and needs to wake up
287  * everyone whose time is up.  Called from vcore context. */
288 static void __trigger_tchain(struct timer_chain *tchain)
289 {
290         struct alarm_waiter *i, *temp;
291         uint64_t now = read_tsc();
292         bool changed_list = FALSE;
293         spin_pdr_lock(&tchain->lock);
294         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
295                 printd("Trying to wake up %p who is due at %llu and now is %llu\n",
296                        i, i->wake_up_time, now);
297                 /* TODO: Could also do something in cases where we're close to now */
298                 if (i->wake_up_time <= now) {
299                         changed_list = TRUE;
300                         TAILQ_REMOVE(&tchain->waiters, i, next);
301                         /* Don't touch the waiter after waking it, since it could be in use
302                          * on another core (and the waiter can be clobbered as the kthread
303                          * unwinds its stack).  Or it could be kfreed */
304                         wake_awaiter(i);
305                 } else {
306                         break;
307                 }
308         }
309         if (changed_list) {
310                 reset_tchain_times(tchain);
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         waiter->on_tchain = TRUE;
334         /* Either the list is empty, or not. */
335         if (TAILQ_EMPTY(&tchain->waiters)) {
336                 tchain->earliest_time = waiter->wake_up_time;
337                 tchain->latest_time = waiter->wake_up_time;
338                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
339                 /* Need to turn on the timer interrupt later */
340                 return TRUE;
341         }
342         /* If not, either we're first, last, or in the middle.  Reset the interrupt
343          * and adjust the tchain's times accordingly. */
344         if (waiter->wake_up_time < tchain->earliest_time) {
345                 tchain->earliest_time = waiter->wake_up_time;
346                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
347                 /* Changed the first entry; we'll need to reset the interrupt later */
348                 return TRUE;
349         }
350         /* If there is a tie for last, the newer one will really go last.  We need
351          * to handle equality here since the loop later won't catch it. */
352         if (waiter->wake_up_time >= tchain->latest_time) {
353                 tchain->latest_time = waiter->wake_up_time;
354                 /* Proactively put it at the end if we know we're last */
355                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
356                 return FALSE;
357         }
358         /* Insert before the first one you are earlier than.  This won't scale well
359          * (TODO) if we have a lot of inserts.  The proactive insert_tail up above
360          * will help a bit. */
361         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
362                 if (waiter->wake_up_time < i->wake_up_time) {
363                         TAILQ_INSERT_BEFORE(i, waiter, next);
364                         return FALSE;
365                 }
366         }
367         printf("Could not find a spot for awaiter %p\n", waiter);
368         assert(0);
369 }
370
371 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
372  * later.  This version assumes you have the lock held.  That only makes sense
373  * from alarm handlers, which are called with this lock held from IRQ context */
374 static void __tc_locked_set_alarm(struct timer_chain *tchain,
375                                   struct alarm_waiter *waiter)
376 {
377         if (__insert_awaiter(tchain, waiter))
378                 reset_tchain_interrupt(tchain);
379 }
380
381 /* Sets the alarm.  Don't call this from an alarm handler, since you already
382  * have the lock held.  Call __set_alarm() instead. */
383 static void __tc_set_alarm(struct timer_chain *tchain,
384                            struct alarm_waiter *waiter)
385 {
386         spin_pdr_lock(&tchain->lock);
387         __set_alarm(waiter);
388         spin_pdr_unlock(&tchain->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         /* Need to make sure earliest and latest are set, in case we're mucking with
400          * the first and/or last element of the chain. */
401         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
402                 temp = TAILQ_NEXT(waiter, next);
403                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
404                 reset_int = TRUE;               /* we'll need to reset the timer later */
405         }
406         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
407                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
408                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
409         }
410         TAILQ_REMOVE(&tchain->waiters, waiter, next);
411         return reset_int;
412 }
413
414 /* Removes waiter from the tchain before it goes off.  Returns TRUE if we
415  * disarmed before the alarm went off, FALSE if it already fired.  Also, if
416  * FALSE, the alarm has already completed.  Userspace alarms are like kernel IRQ
417  * alarms - they run with the tchain lock held, meaning their execution is
418  * synchronized with operations like unset. */
419 static bool __tc_unset_alarm(struct timer_chain *tchain,
420                              struct alarm_waiter *waiter)
421 {
422         spin_pdr_lock(&tchain->lock);
423         if (!waiter->on_tchain) {
424                 /* the alarm has already gone off.  its not even on this tchain's list,
425                  * though the concurrent change to on_tchain (specifically, the setting
426                  * of it to FALSE), happens under the tchain's lock. */
427                 spin_pdr_unlock(&tchain->lock);
428                 return FALSE;
429         }
430         if (__remove_awaiter(tchain, waiter))
431                 reset_tchain_interrupt(tchain);
432         spin_pdr_unlock(&tchain->lock);
433         return TRUE;
434 }
435
436 /* waiter may be on the tchain, or it might have fired already and be off the
437  * tchain.  Either way, this will put the waiter on the list, set to go off at
438  * abs_time.  If you know the alarm has fired, don't call this.  Just set the
439  * awaiter, and then set_alarm() */
440 static void __tc_reset_alarm_abs(struct timer_chain *tchain,
441                                  struct alarm_waiter *waiter, uint64_t abs_time)
442 {
443         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
444         spin_pdr_lock(&tchain->lock);
445         /* We only need to remove/unset when the alarm has not fired yet (is still
446          * on the tchain).  If it has fired, it's like a fresh insert */
447         if (waiter->on_tchain)
448                 reset_int = __remove_awaiter(tchain, waiter);
449         __set_awaiter_abs(waiter, abs_time);
450         /* regardless, we need to be reinserted */
451         if (__insert_awaiter(tchain, waiter) || reset_int)
452                 reset_tchain_interrupt(tchain);
453         spin_pdr_unlock(&tchain->lock);
454 }
455
456 /* Debug helpers */
457
458 void print_chain(struct timer_chain *tchain)
459 {
460         struct alarm_waiter *i;
461         spin_pdr_lock(&tchain->lock);
462         printf("Chain %p is%s empty, early: %llu latest: %llu\n", tchain,
463                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
464                tchain->earliest_time,
465                tchain->latest_time);
466         spin_pdr_unlock(&tchain->lock);
467 }
468
469 /* "parlib" alarm handlers */
470 void alarm_abort_sysc(struct alarm_waiter *awaiter)
471 {
472         struct uthread *uth = awaiter->data;
473         assert(uth);
474         if (!uth->sysc) {
475                 /* It's possible the sysc hasn't blocked yet or is in the process of
476                  * unblocking, or even has returned, but hasn't cancelled the alarm.
477                  * regardless, we request a new alarm (the uthread will cancel us one
478                  * way or another). */
479                 set_awaiter_inc(awaiter, 1000000);
480                 __set_alarm(awaiter);
481                 return;
482         }
483         sys_abort_sysc(uth->sysc);
484 }