Update version-controlled scripts for bash
[akaros.git] / kern / include / alarm.h
1 /* Copyright (c) 2011 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Alarms.  This includes various ways to sleep for a while or defer work on a
6  * specific timer.  These can be per-core, global or whatever.  Deferred work
7  * is a function pointer which runs in interrupt context when the alarm goes off
8  * (picture running the ksched then).
9  *
10  * Like with most systems, you won't wake up til after the time you specify (for
11  * now).  This might change, esp if we tweak things to coalesce alarms.
12  *
13  * All tchains come with locks.  Originally, I left these out, since the pcpu
14  * tchains didn't need them (disable_irq was sufficient).  However, disabling
15  * alarms remotely (a valid use case) is a real pain without locks, so now
16  * everyone has locks.  As an added benefit, you can submit an alarm to another
17  * core's pcpu tchain (though it probably costs an extra IRQ).  Note there is a
18  * lock ordering, tchains before awaiters (when they are grabbed together).
19  *
20  * There are two options for pcpu alarms: hard IRQ and routine KMSG (RKM).
21  * IRQ alarms are run directly in the timer interrupt handler and take a hw_tf
22  * parameter in addition to the standard alarm_waiter.  RKM alarms are executed
23  * when kernel messages are executed, which is out of IRQ context.  RKMs are
24  * safer, since you can sleep (qlock, some kmalloc, etc) and you do not need
25  * irqsave locks.
26  *
27  * Another important difference between IRQ and RKM alarms comes when cancelling
28  * or unsetting an alarm.  When you cancel (unset or reset) an alarm, you may
29  * need to block until the RKM has run.  IRQ alarms run with the tchain lock
30  * held, so once the canceller grabs the lock, it has either run already or will
31  * not at all.  With RKMs, the handler runs outside of the lock.  Thus you may
32  * have to wait until the RKM has run, and the RKM might be waiting to run on
33  * your core.
34  *
35  * Note that RKM unset_alarm() has a waits-on dependency with the actual alarm
36  * handler, so be careful of deadlock.
37  *
38  * To use an IRQ alarm, init the waiter with init_awaiter_irq().
39  *
40  * Quick howto, using the pcpu tchains:
41  *      struct timer_chain *tchain = &per_cpu_info[core_id()].tchain;
42  * To block your kthread on an alarm:
43  *      struct alarm_waiter *waiter = kmalloc(sizeof(struct alarm_waiter), 0);
44  *      struct alarm_waiter a_waiter;   // or use the stack
45  *
46  *      init_awaiter(waiter, HANDLER); // or init_awaiter_irq() for IRQ ctx alarms
47  *      set_awaiter_rel(waiter, USEC);
48  *      set_alarm(tchain, waiter);
49  *
50  * If you want the HANDLER to run again, do this at the end of it:
51  *      set_awaiter_rel(waiter, USEC);  // or whenever you want it to fire
52  *      set_alarm(tchain, waiter);
53  * or:
54  *      reset_alarm_rel(tchain, waiter, USEC);
55  *
56  * Don't forget to manage your memory at some (safe) point:
57  *      kfree(waiter);
58  * In the future, we might have a slab for these.  You can get it from wherever
59  * you want, just be careful if you use the stack. */
60
61 #pragma once
62
63 #include <ros/common.h>
64 #include <sys/queue.h>
65 #include <kthread.h>
66
67 /* These structures allow code to defer work for a certain amount of time.
68  * Timer chains (like off a per-core timer) are made of lists/trees of these. */
69 struct alarm_waiter {
70         uint64_t                                        wake_up_time;   /* ugh, this is a TSC for now */
71         union {
72                 void (*func) (struct alarm_waiter *waiter);
73                 void (*func_irq) (struct alarm_waiter *waiter,
74                                   struct hw_trapframe *hw_tf);
75         };
76         void                                            *data;
77         TAILQ_ENTRY(alarm_waiter)       next;
78         bool                                            on_tchain;
79         bool                                            irq_ok;
80         bool                                            holds_tchain_lock;
81         bool                                            rkm_pending;
82         struct cond_var                         rkm_cv;
83 };
84 TAILQ_HEAD(awaiters_tailq, alarm_waiter);               /* ideally not a LL */
85
86 typedef void (*alarm_handler)(struct alarm_waiter *waiter);
87
88 /* One of these per alarm source, such as a per-core timer.  All tchains come
89  * with a lock, even if its rarely needed (like the pcpu tchains).
90  * set_interrupt() is a method for setting the interrupt source. */
91 struct timer_chain {
92         spinlock_t                                      lock;
93         struct awaiters_tailq           waiters;
94         uint64_t                                        earliest_time;
95         uint64_t                                        latest_time;
96         void (*set_interrupt)(struct timer_chain *);
97 };
98
99 /* Called once per timer chain, currently in per_cpu_init() */
100 void init_timer_chain(struct timer_chain *tchain,
101                       void (*set_interrupt)(struct timer_chain *));
102 /* For fresh alarm waiters.  func == 0 for kthreads */
103 void init_awaiter(struct alarm_waiter *waiter,
104                   void (*func) (struct alarm_waiter *));
105 void init_awaiter_irq(struct alarm_waiter *waiter,
106                       void (*func_irq) (struct alarm_waiter *awaiter,
107                                         struct hw_trapframe *hw_tf));
108 /* Sets the time an awaiter goes off */
109 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time);
110 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep);
111 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep);
112 /* Arms/disarms the alarm.  Can be called from within a handler.*/
113 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
114 /* Unset and reset may block if the alarm is not IRQ.  Do not call from within a
115  * handler.  Returns TRUE if you stopped the alarm from firing. */
116 bool unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
117 /* Convenience wrappers for unset, then set.  Slower, but easier than just
118  * setting, since you don't need to know if it fired.  Returns TRUE if the alarm
119  * did not fire before your reset. */
120 bool reset_alarm_abs(struct timer_chain *tchain, struct alarm_waiter *waiter,
121                      uint64_t abs_time);
122 bool reset_alarm_rel(struct timer_chain *tchain, struct alarm_waiter *waiter,
123                      uint64_t usleep);
124
125 /* Interrupt handlers need to call this.  Don't call it directly. */
126 void __trigger_tchain(struct timer_chain *tchain, struct hw_trapframe *hw_tf);
127 /* Sets the timer chain interrupt according to the next timer in the chain. */
128 void set_pcpu_alarm_interrupt(struct timer_chain *tchain);
129
130 /* Debugging */
131 #define ALARM_POISON_TIME 12345                         /* could use some work */
132 void print_chain(struct timer_chain *tchain);
133 void print_pcpu_chains(void);