79fd3f865b22442899490c997c908f65f60fcae0
[akaros.git] / user / benchutil / include / benchutil / 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  * This is (was) hanging out in benchutil so as to not create a dependency from
11  * parlib on benchutil (usec2tsc and friends).
12  *
13  * There's only one timer chain, unlike in the kernel, for the entire process.
14  * If you want one-off timers unrelated to the chain (and sent to other vcores),
15  * use #A directly.
16  *
17  * Your handlers will run from vcore context.
18  *
19  * 1) To set a handler to run on an alarm:
20  *      struct alarm_waiter *waiter = malloc(sizeof(struct alarm_waiter));
21  *      init_awaiter(waiter, HANDLER);
22  *      waiter->data = something;
23  *      set_awaiter_rel(waiter, USEC);
24  *      set_alarm(waiter);
25  * If you want the HANDLER to run again, do this at the end of it:
26  *      set_awaiter_rel(waiter, USEC);
27  *      __set_alarm(waiter);
28  * Do not call set_alarm() from within an alarm handler; you'll deadlock.
29  * Don't forget to manage your memory at some (safe) point:
30  *      free(waiter); */
31
32 #pragma once
33
34 #include <parlib/common.h>
35 #include <sys/queue.h>
36 #include <parlib/spinlock.h>
37 #include <parlib/event.h>
38
39 __BEGIN_DECLS
40
41 /* Low-level alarm interface */
42
43 int devalarm_get_fds(int *ctlfd_r, int *timerfd_r, int *alarmid_r);
44 int devalarm_set_evq(int ctlfd, struct event_queue *ev_q);
45 int devalarm_set_time(int timerfd, uint64_t tsc_time);
46 int devalarm_disable(int ctlfd);
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 spin_pdr_lock            lock;
65         struct awaiters_tailq           waiters;
66         uint64_t                                        earliest_time;
67         uint64_t                                        latest_time;
68         int                                                     ctlfd;
69         int                                                     timerfd;
70         int                                                     alarmid;
71         struct event_queue                      *ev_q;
72 };
73
74 /* For fresh alarm waiters.  func == 0 for kthreads */
75 void init_awaiter(struct alarm_waiter *waiter,
76                   void (*func) (struct alarm_waiter *));
77 /* Sets the time an awaiter goes off */
78 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time);
79 void set_awaiter_abs_unix(struct alarm_waiter *waiter, uint64_t abs_time);
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 /* Arms/disarms the alarm */
83 void __set_alarm(struct alarm_waiter *waiter);
84 void set_alarm(struct alarm_waiter *waiter);
85 bool unset_alarm(struct alarm_waiter *waiter);
86 void reset_alarm_abs(struct alarm_waiter *waiter, uint64_t abs_time);
87
88 /* "parlib" alarm handlers */
89 void alarm_abort_sysc(struct alarm_waiter *awaiter);
90
91 /* Debugging */
92 #define ALARM_POISON_TIME 12345
93 void print_chain(struct timer_chain *tchain);
94
95 __END_DECLS