net: add LRO feature
[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).  The other style is to block/sleep on the
9  * awaiter after the alarm is set.
10  *
11  * Like with most systems, you won't wake up til after the time you specify (for
12  * now).  This might change, esp if we tweak things to coalesce alarms.
13  *
14  * All tchains come with locks.  Originally, I left these out, since the pcpu
15  * tchains didn't need them (disable_irq was sufficient).  However, disabling
16  * alarms remotely (a valid use case) is a real pain without locks, so now
17  * everyone has locks.  As an added benefit, you can submit an alarm to another
18  * core's pcpu tchain (though it probably costs an extra IRQ).  Note there is a
19  * lock ordering, tchains before awaiters (when they are grabbed together).
20  *
21  * There are two options for pcpu alarms: hard IRQ and routine KMSG (RKM).
22  * IRQ alarms are run directly in the timer interrupt handler and take a hw_tf
23  * parameter in addition to the standard alarm_waiter.  RKM alarms are executed
24  * when kernel messages are executed, which is out of IRQ context.  RKMs are
25  * safer, since you can sleep (qlock, some kmalloc, etc) and you do not need
26  * irqsave locks.  To use an IRQ alarm, init the waiter with init_awaiter_irq().
27  *
28  * Quick howto, using the pcpu tchains:
29  *      struct timer_chain *tchain = &per_cpu_info[core_id()].tchain;
30  * 1) To block your kthread on an alarm:
31  *      struct alarm_waiter a_waiter;
32  *      init_awaiter(&a_waiter, 0); // or init_awaiter_irq() for IRQ ctx alarms
33  *      set_awaiter_rel(&a_waiter, USEC);
34  *      set_alarm(tchain, &a_waiter);
35  *      sleep_on_awaiter(&a_waiter);
36  * 2) To set a handler to run on an alarm:
37  *      struct alarm_waiter *waiter = kmalloc(sizeof(struct alarm_waiter), 0);
38  *      init_awaiter(waiter, HANDLER);
39  *      set_awaiter_rel(waiter, USEC);
40  *      set_alarm(tchain, waiter);
41  * If you want the HANDLER to run again, do this at the end of it:
42  *      set_awaiter_rel(waiter, USEC);
43  *      __set_alarm(tchain, waiter);
44  * Do not call set_alarm() from within an alarm handler; you'll deadlock.
45  * Don't forget to manage your memory at some (safe) point:
46  *      kfree(waiter);
47  * In the future, we might have a slab for these.  You can get it from wherever
48  * you want, just don't use the stack for handler style, since you'll usually
49  * return and pop up the stack after setting the alarm.
50  * */
51
52 #ifndef ROS_KERN_ALARM_H
53 #define ROS_KERN_ALARM_H
54
55 #include <ros/common.h>
56 #include <sys/queue.h>
57 #include <kthread.h>
58
59 /* These structures allow code to block or defer work for a certain amount of
60  * time.  Timer chains (like off a per-core timer) are made of lists/trees of
61  * these. 
62  *
63  * If you have a func pointer, that handler will run when the alarm goes off.
64  * If you don't have a func pointer, you sleep on the semaphore and block your
65  * kthread.  In the latter case, you ought to allocate space for them on the
66  * stack of the thread you're about to block on. */
67 struct alarm_waiter {
68         uint64_t                                        wake_up_time;   /* ugh, this is a TSC for now */
69         union {
70                 void (*func) (struct alarm_waiter *waiter);
71                 void (*func_irq) (struct alarm_waiter *waiter,
72                                   struct hw_trapframe *hw_tf);
73                 struct semaphore                        sem;            /* kthread will sleep on this */
74         };
75         void                                            *data;
76         TAILQ_ENTRY(alarm_waiter)       next;
77         bool                                            on_tchain;
78         bool                                            irq_ok;
79         bool                                            has_func;
80 };
81 TAILQ_HEAD(awaiters_tailq, alarm_waiter);               /* ideally not a LL */
82
83 typedef void (*alarm_handler)(struct alarm_waiter *waiter);
84
85 /* One of these per alarm source, such as a per-core timer.  All tchains come
86  * with a lock, even if its rarely needed (like the pcpu tchains).
87  * set_interrupt() is a method for setting the interrupt source. */
88 struct timer_chain {
89         spinlock_t                                      lock;
90         struct awaiters_tailq           waiters;
91         uint64_t                                        earliest_time;
92         uint64_t                                        latest_time;
93         void (*set_interrupt) (uint64_t time, struct timer_chain *);
94 };
95
96 /* Called once per timer chain, currently in per_cpu_init() */
97 void init_timer_chain(struct timer_chain *tchain,
98                       void (*set_interrupt) (uint64_t, struct timer_chain *));
99 /* For fresh alarm waiters.  func == 0 for kthreads */
100 void init_awaiter(struct alarm_waiter *waiter,
101                   void (*func) (struct alarm_waiter *));
102 void init_awaiter_irq(struct alarm_waiter *waiter,
103                       void (*func_irq) (struct alarm_waiter *awaiter,
104                                         struct hw_trapframe *hw_tf));
105 /* Sets the time an awaiter goes off */
106 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time);
107 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep);
108 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep);
109 /* Arms/disarms the alarm.  Hold the lock when calling __methods.  */
110 void __set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
111 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
112 bool unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
113 bool __reset_alarm_abs(struct timer_chain *tchain, struct alarm_waiter *waiter,
114                        uint64_t abs_time);
115 bool __reset_alarm_rel(struct timer_chain *tchain, struct alarm_waiter *waiter,
116                        uint64_t usleep);
117 bool reset_alarm_abs(struct timer_chain *tchain, struct alarm_waiter *waiter,
118                      uint64_t abs_time);
119 bool reset_alarm_rel(struct timer_chain *tchain, struct alarm_waiter *waiter,
120                      uint64_t usleep);
121
122 /* Blocks on the alarm waiter */
123 int sleep_on_awaiter(struct alarm_waiter *waiter);
124 /* Interrupt handlers need to call this.  Don't call it directly. */
125 void __trigger_tchain(struct timer_chain *tchain, struct hw_trapframe *hw_tf);
126 /* How to set a specific alarm: the per-cpu timer interrupt */
127 void set_pcpu_alarm_interrupt(uint64_t time, struct timer_chain *tchain);
128
129 /* Debugging */
130 #define ALARM_POISON_TIME 12345                         /* could use some work */
131 void print_chain(struct timer_chain *tchain);
132 void print_pcpu_chains(void);
133
134 #endif /* ROS_KERN_ALARM_H */