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