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