Moves some timing func from benchutil to parlib
[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 alarm service, based off a slimmed down version of the kernel
6  * alarms.  Under the hood, it uses the kernel alarm service for the root of
7  * the alarm chain.
8  *
9  * There's only one timer chain, unlike in the kernel, for the entire process.
10  * If you want one-off timers unrelated to the chain (and sent to other vcores),
11  * use #A directly.
12  *
13  * Your handlers will run from vcore context.
14  *
15  * Code differences from the kernel (for future porting):
16  * - init_alarm_service, run once out of init_awaiter (or wherever).
17  * - set_alarm() and friends are __tc_set_alarm(), passing global_tchain.
18  * - reset_tchain_interrupt() uses #A
19  * - removed anything related to semaphores or kthreads
20  * - spinlocks -> spin_pdr_locks
21  * - ev_q wrappers for converting #A events to __triggers
22  * - printks, and other minor stuff. */
23
24 #include <sys/queue.h>
25 #include <sys/time.h>
26 #include <alarm.h>
27 #include <stdio.h>
28 #include <assert.h>
29 #include <stdlib.h>
30 #include <unistd.h>
31 #include <sys/types.h>
32 #include <sys/stat.h>
33 #include <fcntl.h>
34 #include <parlib.h>
35 #include <event.h>
36 #include <measure.h>
37 #include <uthread.h>
38 #include <spinlock.h>
39 #include <timing.h>
40
41 /* Helpers, basically renamed kernel interfaces, with the *tchain. */
42 static void __tc_locked_set_alarm(struct timer_chain *tchain,
43                                   struct alarm_waiter *waiter);
44 static void __tc_set_alarm(struct timer_chain *tchain,
45                            struct alarm_waiter *waiter);
46 static bool __tc_unset_alarm(struct timer_chain *tchain,
47                              struct alarm_waiter *waiter);
48 static void __tc_reset_alarm_abs(struct timer_chain *tchain,
49                                  struct alarm_waiter *waiter,
50                                  uint64_t abs_time);
51 static void handle_user_alarm(struct event_msg *ev_msg, unsigned int ev_type);
52
53 /* One chain to rule them all. */
54 struct timer_chain global_tchain;
55
56 /* Unix time offsets so we can allow people to specify an absolute unix time to
57  * an alarm, rather than an absolute time in terms of raw tsc ticks.  This
58  * value is initialized when the timer service is started. */
59 static struct {
60         uint64_t tod; // The initial time of day in microseconds
61         uint64_t tsc; // The initial value of the tsc counter
62 } unixtime_offsets;
63 static inline void init_unixtime_offsets()
64 {
65         struct timeval tv;
66         gettimeofday(&tv, NULL);
67         unixtime_offsets.tsc = read_tsc();
68         unixtime_offsets.tod = tv.tv_sec*1000000 + tv.tv_usec;
69 }
70
71 /* Helper, resets the earliest/latest times, based on the elements of the list.
72  * If the list is empty, we set the times to be the 12345 poison time.  Since
73  * the list is empty, the alarm shouldn't be going off. */
74 static void reset_tchain_times(struct timer_chain *tchain)
75 {
76         if (TAILQ_EMPTY(&tchain->waiters)) {
77                 tchain->earliest_time = ALARM_POISON_TIME;
78                 tchain->latest_time = ALARM_POISON_TIME;
79         } else {
80                 tchain->earliest_time = TAILQ_FIRST(&tchain->waiters)->wake_up_time;
81                 tchain->latest_time =
82                         TAILQ_LAST(&tchain->waiters, awaiters_tailq)->wake_up_time;
83         }
84 }
85
86 static void init_alarm_service(void)
87 {
88         int ctlfd, timerfd, alarm_nr, ret;
89         char buf[20];
90         char path[32];
91         struct event_queue *ev_q;
92
93         /* Initialize the unixtime_offsets */
94         init_unixtime_offsets();
95
96         /* Sets up timer chain (only one chain per process) */
97         spin_pdr_init(&global_tchain.lock);
98         TAILQ_INIT(&global_tchain.waiters);
99         reset_tchain_times(&global_tchain);
100
101         ctlfd = open("#A/clone", O_RDWR | O_CLOEXEC);
102         if (ctlfd < 0) {
103                 perror("Useralarm: Can't clone an alarm");
104                 return;
105         }
106         ret = read(ctlfd, buf, sizeof(buf) - 1);
107         if (ret <= 0) {
108                 if (!ret)
109                         printf("Useralarm: Got early EOF from ctl\n");
110                 else
111                         perror("Useralarm: Can't read ctl");
112                 return;
113         }
114         buf[ret] = 0;
115         global_tchain.alarmid = atoi(buf);
116         snprintf(path, sizeof(path), "#A/a%s/timer", buf);
117         timerfd = open(path, O_RDWR | O_CLOEXEC);
118         if (timerfd < 0) {
119                 perror("Useralarm: Can't open timer");
120                 return;
121         }
122         /* Since we're doing SPAM_PUBLIC later, we actually don't need a big ev_q.
123          * But someone might copy/paste this and change a flag. */
124         ev_handlers[EV_ALARM] = handle_user_alarm;
125         if (!(ev_q = get_big_event_q())) {
126                 perror("Useralarm: Failed ev_q");
127                 return;
128         }
129         ev_q->ev_vcore = 0;
130         /* We could get multiple events for a single alarm.  It's okay, since
131          * __trigger can handle spurious upcalls.  If it ever is not okay, then use
132          * an INDIR/FALLBACK instead of SPAM_PUBLIC. */
133         ev_q->ev_flags = EVENT_IPI | EVENT_SPAM_PUBLIC;
134         ret = snprintf(path, sizeof(path), "evq %llx", ev_q);
135         ret = write(ctlfd, path, ret);
136         if (ret <= 0) {
137                 perror("Useralarm: Failed to write ev_q");
138                 return;
139         }
140         /* now the alarm is all set, just need to write the timer whenever we want
141          * it to go off. */
142         global_tchain.ctlfd = ctlfd;
143         global_tchain.timerfd = timerfd;
144         global_tchain.ev_q = ev_q;      /* mostly for debugging */
145 }
146
147 /* Initializes a new awaiter.  Pass 0 for the function if you want it to be a
148  * kthread-alarm, and sleep on it after you set the alarm later. */
149 void init_awaiter(struct alarm_waiter *waiter,
150                   void (*func) (struct alarm_waiter *awaiter))
151 {
152         run_once_racy(init_alarm_service());
153         waiter->wake_up_time = ALARM_POISON_TIME;
154         assert(func);
155         waiter->func = func;
156         waiter->on_tchain = FALSE;
157 }
158
159 /* Give this the absolute time.  For now, abs_time is the TSC time that you want
160  * the alarm to go off. */
161 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time)
162 {
163         waiter->wake_up_time = abs_time;
164 }
165
166 /* Give this the absolute unix time (in microseconds) that you want the alarm
167  * to go off. */
168 void set_awaiter_abs_unix(struct alarm_waiter *waiter, uint64_t abs_time)
169 {
170         abs_time = usec2tsc(abs_time - unixtime_offsets.tod) + unixtime_offsets.tsc;
171         set_awaiter_abs(waiter, abs_time);
172 }
173
174 /* Give this a relative time from now, in microseconds.  This might be easier to
175  * use than dealing with the TSC. */
176 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep)
177 {
178         uint64_t now, then;
179         now = read_tsc();
180         then = now + usec2tsc(usleep);
181         /* This will go off if we wrap-around the TSC.  It'll never happen for legit
182          * values, but this might catch some bugs with large usleeps. */
183         assert(now <= then);
184         set_awaiter_abs(waiter, then);
185 }
186
187 /* Increment the timer that was already set, so that it goes off usleep usec
188  * from the previous tick.  This is different than 'rel' in that it doesn't care
189  * about when 'now' is. */
190 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep)
191 {
192         assert(waiter->wake_up_time != ALARM_POISON_TIME);
193         waiter->wake_up_time += usec2tsc(usleep);
194 }
195
196 /* User interface to the global tchain */
197 void __set_alarm(struct alarm_waiter *waiter)
198 {
199         __tc_locked_set_alarm(&global_tchain, waiter);
200 }
201
202 void set_alarm(struct alarm_waiter *waiter)
203 {
204         __tc_set_alarm(&global_tchain, waiter);
205 }
206
207 bool unset_alarm(struct alarm_waiter *waiter)
208 {
209         return __tc_unset_alarm(&global_tchain, waiter);
210 }
211
212 void reset_alarm_abs(struct alarm_waiter *waiter, uint64_t abs_time)
213 {
214         __tc_reset_alarm_abs(&global_tchain, waiter, abs_time);
215 }
216
217 /* Helper, makes sure the kernel alarm is turned on at the right time. */
218 static void reset_tchain_interrupt(struct timer_chain *tchain)
219 {
220         int ret;
221         char buf[20];
222         if (TAILQ_EMPTY(&tchain->waiters)) {
223                 /* Turn it off */
224                 printd("Turning alarm off\n");
225                 ret = write(tchain->ctlfd, "cancel", sizeof("cancel"));
226                 if (ret <= 0) {
227                         printf("Useralarm: unable to disarm alarm!\n");
228                         return;
229                 }
230         } else {
231                 /* Make sure it is on and set to the earliest time */
232                 assert(tchain->earliest_time != ALARM_POISON_TIME);
233                 /* TODO: check for times in the past or very close to now */
234                 printd("Turning alarm on for %llu\n", tchain->earliest_time);
235                 ret = snprintf(buf, sizeof(buf), "%llx", tchain->earliest_time);
236                 ret = write(tchain->timerfd, buf, ret);
237                 if (ret <= 0) {
238                         perror("Useralarm: Failed to set timer");
239                         return;
240                 }
241         }
242 }
243
244 /* When an awaiter's time has come, this gets called. */
245 static void wake_awaiter(struct alarm_waiter *waiter)
246 {
247         waiter->on_tchain = FALSE;
248         cmb();  /* enforce the on_tchain write before the handlers */
249         waiter->func(waiter);
250 }
251
252 /* This is called when the kernel alarm triggers a tchain, and needs to wake up
253  * everyone whose time is up.  Called from vcore context. */
254 static void __trigger_tchain(struct timer_chain *tchain)
255 {
256         struct alarm_waiter *i, *temp;
257         uint64_t now = read_tsc();
258         bool changed_list = FALSE;
259         spin_pdr_lock(&tchain->lock);
260         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
261                 printd("Trying to wake up %p who is due at %llu and now is %llu\n",
262                        i, i->wake_up_time, now);
263                 /* TODO: Could also do something in cases where we're close to now */
264                 if (i->wake_up_time <= now) {
265                         changed_list = TRUE;
266                         TAILQ_REMOVE(&tchain->waiters, i, next);
267                         /* Don't touch the waiter after waking it, since it could be in use
268                          * on another core (and the waiter can be clobbered as the kthread
269                          * unwinds its stack).  Or it could be kfreed */
270                         wake_awaiter(i);
271                 } else {
272                         break;
273                 }
274         }
275         if (changed_list) {
276                 reset_tchain_times(tchain);
277         }
278         /* Need to reset the interrupt no matter what */
279         reset_tchain_interrupt(tchain);
280         spin_pdr_unlock(&tchain->lock);
281 }
282
283 static void handle_user_alarm(struct event_msg *ev_msg, unsigned int ev_type)
284 {
285         assert(ev_type == EV_ALARM);
286         if (ev_msg && (ev_msg->ev_arg2 == global_tchain.alarmid))
287                 __trigger_tchain(&global_tchain);
288 }
289
290 /* Helper, inserts the waiter into the tchain, returning TRUE if we still need
291  * to reset the tchain interrupt.  Caller holds the lock. */
292 static bool __insert_awaiter(struct timer_chain *tchain,
293                              struct alarm_waiter *waiter)
294 {
295         struct alarm_waiter *i, *temp;
296         /* This will fail if you don't set a time */
297         assert(waiter->wake_up_time != ALARM_POISON_TIME);
298         waiter->on_tchain = TRUE;
299         /* Either the list is empty, or not. */
300         if (TAILQ_EMPTY(&tchain->waiters)) {
301                 tchain->earliest_time = waiter->wake_up_time;
302                 tchain->latest_time = waiter->wake_up_time;
303                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
304                 /* Need to turn on the timer interrupt later */
305                 return TRUE;
306         }
307         /* If not, either we're first, last, or in the middle.  Reset the interrupt
308          * and adjust the tchain's times accordingly. */
309         if (waiter->wake_up_time < tchain->earliest_time) {
310                 tchain->earliest_time = waiter->wake_up_time;
311                 TAILQ_INSERT_HEAD(&tchain->waiters, waiter, next);
312                 /* Changed the first entry; we'll need to reset the interrupt later */
313                 return TRUE;
314         }
315         /* If there is a tie for last, the newer one will really go last.  We need
316          * to handle equality here since the loop later won't catch it. */
317         if (waiter->wake_up_time >= tchain->latest_time) {
318                 tchain->latest_time = waiter->wake_up_time;
319                 /* Proactively put it at the end if we know we're last */
320                 TAILQ_INSERT_TAIL(&tchain->waiters, waiter, next);
321                 return FALSE;
322         }
323         /* Insert before the first one you are earlier than.  This won't scale well
324          * (TODO) if we have a lot of inserts.  The proactive insert_tail up above
325          * will help a bit. */
326         TAILQ_FOREACH_SAFE(i, &tchain->waiters, next, temp) {
327                 if (waiter->wake_up_time < i->wake_up_time) {
328                         TAILQ_INSERT_BEFORE(i, waiter, next);
329                         return FALSE;
330                 }
331         }
332         printf("Could not find a spot for awaiter %p\n", waiter);
333 }
334
335 /* Sets the alarm.  If it is a kthread-style alarm (func == 0), sleep on it
336  * later.  This version assumes you have the lock held.  That only makes sense
337  * from alarm handlers, which are called with this lock held from IRQ context */
338 static void __tc_locked_set_alarm(struct timer_chain *tchain,
339                                   struct alarm_waiter *waiter)
340 {       
341         if (__insert_awaiter(tchain, waiter))
342                 reset_tchain_interrupt(tchain);
343 }
344
345 /* Sets the alarm.  Don't call this from an alarm handler, since you already
346  * have the lock held.  Call __set_alarm() instead. */
347 static void __tc_set_alarm(struct timer_chain *tchain,
348                            struct alarm_waiter *waiter)
349 {
350         spin_pdr_lock(&tchain->lock);
351         __set_alarm(waiter);
352         spin_pdr_unlock(&tchain->lock);
353 }
354
355 /* Helper, rips the waiter from the tchain, knowing that it is on the list.
356  * Returns TRUE if the tchain interrupt needs to be reset.  Callers hold the
357  * lock. */
358 static bool __remove_awaiter(struct timer_chain *tchain,
359                              struct alarm_waiter *waiter)
360 {
361         struct alarm_waiter *temp;
362         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
363         /* Need to make sure earliest and latest are set, in case we're mucking with
364          * the first and/or last element of the chain. */
365         if (TAILQ_FIRST(&tchain->waiters) == waiter) {
366                 temp = TAILQ_NEXT(waiter, next);
367                 tchain->earliest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
368                 reset_int = TRUE;               /* we'll need to reset the timer later */
369         }
370         if (TAILQ_LAST(&tchain->waiters, awaiters_tailq) == waiter) {
371                 temp = TAILQ_PREV(waiter, awaiters_tailq, next);
372                 tchain->latest_time = (temp) ? temp->wake_up_time : ALARM_POISON_TIME;
373         }
374         TAILQ_REMOVE(&tchain->waiters, waiter, next);
375         return reset_int;
376 }
377
378 /* Removes waiter from the tchain before it goes off.  Returns TRUE if we
379  * disarmed before the alarm went off, FALSE if it already fired. */
380 static bool __tc_unset_alarm(struct timer_chain *tchain,
381                              struct alarm_waiter *waiter)
382 {
383         spin_pdr_lock(&tchain->lock);
384         if (!waiter->on_tchain) {
385                 /* the alarm has already gone off.  its not even on this tchain's list,
386                  * though the concurrent change to on_tchain (specifically, the setting
387                  * of it to FALSE), happens under the tchain's lock. */
388                 spin_pdr_unlock(&tchain->lock);
389                 return FALSE;
390         }
391         if (__remove_awaiter(tchain, waiter))
392                 reset_tchain_interrupt(tchain);
393         spin_pdr_unlock(&tchain->lock);
394         return TRUE;
395 }
396
397 /* waiter may be on the tchain, or it might have fired already and be off the
398  * tchain.  Either way, this will put the waiter on the list, set to go off at
399  * abs_time.  If you know the alarm has fired, don't call this.  Just set the
400  * awaiter, and then set_alarm() */
401 static void __tc_reset_alarm_abs(struct timer_chain *tchain,
402                                  struct alarm_waiter *waiter, uint64_t abs_time)
403 {
404         bool reset_int = FALSE;         /* whether or not to reset the interrupt */
405         spin_pdr_lock(&tchain->lock);
406         /* We only need to remove/unset when the alarm has not fired yet (is still
407          * on the tchain).  If it has fired, it's like a fresh insert */
408         if (waiter->on_tchain)
409                 reset_int = __remove_awaiter(tchain, waiter);
410         set_awaiter_abs(waiter, abs_time);
411         /* regardless, we need to be reinserted */
412         if (__insert_awaiter(tchain, waiter) || reset_int)
413                 reset_tchain_interrupt(tchain);
414         spin_pdr_unlock(&tchain->lock);
415 }
416
417 /* Debug helpers */
418
419 void print_chain(struct timer_chain *tchain)
420 {
421         struct alarm_waiter *i;
422         spin_pdr_lock(&tchain->lock);
423         printf("Chain %p is%s empty, early: %llu latest: %llu\n", tchain,
424                TAILQ_EMPTY(&tchain->waiters) ? "" : " not",
425                tchain->earliest_time,
426                tchain->latest_time);
427         spin_pdr_unlock(&tchain->lock);
428 }
429
430 /* "parlib" alarm handlers */
431 void alarm_abort_sysc(struct alarm_waiter *awaiter)
432 {
433         struct uthread *uth = awaiter->data;
434         assert(uth);
435         if (!uth->sysc) {
436                 /* It's possible the sysc hasn't blocked yet or is in the process of
437                  * unblocking, or even has returned, but hasn't cancelled the alarm.
438                  * regardless, we request a new alarm (the uthread will cancel us one
439                  * way or another). */
440                 set_awaiter_inc(awaiter, 1000000);
441                 __set_alarm(awaiter);
442                 return;
443         }
444         sys_abort_sysc(uth->sysc);
445 }