parlib: Fix the use-after-func issue
[akaros.git] / user / parlib / include / parlib / alarm.h
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 #A device and an alarm service, based off a slimmed down version of
8  * the kernel alarms.  Under the hood, the user alarm uses the #A service for
9  * 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 #A directly.
14  *
15  * Your handlers will run from vcore context.
16  *
17  * 1) To set a handler to run on an alarm:
18  *      struct alarm_waiter *waiter = malloc(sizeof(struct alarm_waiter));
19  *      init_awaiter(waiter, HANDLER);
20  *      waiter->data = something;
21  *      set_awaiter_rel(waiter, USEC);
22  *      set_alarm(waiter);
23  * If you want the HANDLER to run again, do this at the end of it:
24  *      set_awaiter_rel(waiter, USEC);
25  *      __set_alarm(waiter);
26  * Do not call set_alarm() from within an alarm handler; you'll deadlock.
27  * Don't forget to manage your memory at some (safe) point:
28  *      free(waiter); */
29
30 #pragma once
31
32 #include <parlib/common.h>
33 #include <sys/queue.h>
34 #include <parlib/spinlock.h>
35 #include <parlib/event.h>
36 #include <parlib/uthread.h>
37
38 __BEGIN_DECLS
39
40 /* Low-level alarm interface */
41
42 int devalarm_get_fds(int *ctlfd_r, int *timerfd_r, int *alarmid_r);
43 int devalarm_set_evq(int timerfd, struct event_queue *ev_q, int alarmid);
44 int devalarm_set_time(int timerfd, uint64_t tsc_time);
45 int devalarm_get_id(struct event_msg *ev_msg);
46 int devalarm_disable(int timerfd);
47
48 /* Alarm service */
49
50 /* Specifc waiter, per alarm */
51 struct alarm_waiter {
52         uint64_t                                        wake_up_time;   /* tsc time */
53         void (*func) (struct alarm_waiter *waiter);
54         void                                            *data;
55         TAILQ_ENTRY(alarm_waiter)       next;
56         bool                                            on_tchain;
57 };
58 TAILQ_HEAD(awaiters_tailq, alarm_waiter);               /* ideally not a LL */
59
60 typedef void (*alarm_handler)(struct alarm_waiter *waiter);
61
62 /* Sorted collection of alarms. */
63 struct timer_chain {
64         struct awaiters_tailq           waiters;
65         struct alarm_waiter                     *running;
66         uint64_t                                        earliest_time;
67         uint64_t                                        latest_time;
68         struct uth_cond_var                     cv;
69         int                                                     ctlfd;
70         int                                                     timerfd;
71         int                                                     alarmid;
72         struct event_queue                      *ev_q;
73 };
74
75 /* For fresh alarm waiters.  func == 0 for kthreads */
76 void init_awaiter(struct alarm_waiter *waiter,
77                   void (*func) (struct alarm_waiter *));
78 /* Sets the time an awaiter goes off */
79 void set_awaiter_abs_unix(struct alarm_waiter *waiter, uint64_t abs_usec);
80 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep);
81 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep);
82
83 /* Helper: converts a timespec to the units of the #alarm service (usec).  A
84  * common usage:
85  *              set_awaiter_abs_unix(w, timespec_to_alarm_time(abs_ts));
86  */
87 static uint64_t timespec_to_alarm_time(const struct timespec *ts)
88 {
89         return ts->tv_nsec / 1000 + ts->tv_sec * 1000000ULL;
90 }
91
92 /* Arms/disarms the alarm */
93 void set_alarm(struct alarm_waiter *waiter);
94 bool unset_alarm(struct alarm_waiter *waiter);
95 bool reset_alarm_abs(struct alarm_waiter *waiter, uint64_t abs_time);
96
97 /* "parlib" alarm handlers */
98 void alarm_abort_sysc(struct alarm_waiter *awaiter);
99
100 /* Debugging */
101 #define ALARM_POISON_TIME 12345
102 void print_chain(struct timer_chain *tchain);
103
104 __END_DECLS