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