Fixes bug in cpu_relax_vc()
[akaros.git] / kern / include / alarm.h
index 1bf4446..752775f 100644 (file)
  * Like with most systems, you won't wake up til after the time you specify (for
  * now).  This might change, esp if we tweak things to coalesce alarms.
  *
- * If you're using a global alarm timer_chain, you'll probably need to grab a
- * lock.  The only current user is pcpu tchains, though the code ought be able
- * to handle other uses.
+ * All tchains come with locks.  Originally, I left these out, since the pcpu
+ * tchains didn't need them (disable_irq was sufficient).  However, disabling
+ * alarms remotely (a valid use case) is a real pain without locks, so now
+ * everyone has locks.  As an added benefit, you can submit an alarm to another
+ * core's pcpu tchain (though it probably costs an extra IRQ).  Note there is a
+ * lock ordering, tchains before awaiters (when they are grabbed together).
  *
  * Quick howto, using the pcpu tchains:
  *     struct timer_chain *tchain = &per_cpu_info[core_id()].tchain;
@@ -30,7 +33,8 @@
  *     set_alarm(tchain, waiter);
  * If you want the HANDLER to run again, do this at the end of it:
  *     set_awaiter_rel(waiter, USEC);
- *     set_alarm(tchain, waiter);
+ *     __set_alarm(tchain, waiter);
+ * Do not call set_alarm() from within an alarm handler; you'll deadlock.
  * Don't forget to manage your memory at some (safe) point:
  *     kfree(waiter);
  * In the future, we might have a slab for these.  You can get it from wherever
  * stack of the thread you're about to block on. */
 struct alarm_waiter {
        uint64_t                                        wake_up_time;   /* ugh, this is a TSC for now */
-       void (*func) (struct alarm_waiter *waiter);     /* either this, or a kthread */
-       struct semaphore                        sem;                    /* kthread will sleep on this */
+       union {
+               void (*func) (struct alarm_waiter *waiter);
+               void (*func_irq) (struct alarm_waiter *waiter,
+                                 struct hw_trapframe *hw_tf);
+               struct semaphore                        sem;            /* kthread will sleep on this */
+       };
        void                                            *data;
        TAILQ_ENTRY(alarm_waiter)       next;
+       bool                                            on_tchain;
+       bool                                            irq_ok;
+       bool                                            has_func;
 };
 TAILQ_HEAD(awaiters_tailq, alarm_waiter);              /* ideally not a LL */
 
 typedef void (*alarm_handler)(struct alarm_waiter *waiter);
 
-/* One of these per alarm source, such as a per-core timer.  Based on the
- * source, you may need a lock (such as for a global timer).  set_interrupt() is
- * a method for setting the interrupt source. */
+/* One of these per alarm source, such as a per-core timer.  All tchains come
+ * with a lock, even if its rarely needed (like the pcpu tchains).
+ * set_interrupt() is a method for setting the interrupt source. */
 struct timer_chain {
+       spinlock_t                                      lock;
        struct awaiters_tailq           waiters;
        uint64_t                                        earliest_time;
        uint64_t                                        latest_time;
@@ -80,22 +92,28 @@ void init_timer_chain(struct timer_chain *tchain,
 /* For fresh alarm waiters.  func == 0 for kthreads */
 void init_awaiter(struct alarm_waiter *waiter,
                   void (*func) (struct alarm_waiter *));
+void init_awaiter_irq(struct alarm_waiter *waiter,
+                      void (*func_irq) (struct alarm_waiter *awaiter,
+                                        struct hw_trapframe *hw_tf));
 /* Sets the time an awaiter goes off */
 void set_awaiter_abs(struct alarm_waiter *waiter, uint64_t abs_time);
 void set_awaiter_rel(struct alarm_waiter *waiter, uint64_t usleep);
 void set_awaiter_inc(struct alarm_waiter *waiter, uint64_t usleep);
 /* Arms/disarms the alarm */
+void __set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
 void set_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
-void unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
+bool unset_alarm(struct timer_chain *tchain, struct alarm_waiter *waiter);
+void reset_alarm_abs(struct timer_chain *tchain, struct alarm_waiter *waiter,
+                     uint64_t abs_time);
 /* Blocks on the alarm waiter */
 int sleep_on_awaiter(struct alarm_waiter *waiter);
-/* Interrupt handlers needs to call this.  Don't call it directly. */
-void trigger_tchain(struct timer_chain *tchain);
+/* Interrupt handlers need to call this.  Don't call it directly. */
+void __trigger_tchain(struct timer_chain *tchain, struct hw_trapframe *hw_tf);
 /* How to set a specific alarm: the per-cpu timer interrupt */
 void set_pcpu_alarm_interrupt(uint64_t time, struct timer_chain *tchain);
 
 /* Debugging */
-#define ALARM_POISON_TIME 12345
+#define ALARM_POISON_TIME 12345                                /* could use some work */
 void print_chain(struct timer_chain *tchain);
 void print_pcpu_chains(void);