include/linux/hrtimer.h

   1 /*
   2  *  include/linux/hrtimer.h
   3  *
   4  *  hrtimers - High-resolution kernel timers
   5  *
   6  *   Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
   7  *   Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
   8  *
   9  *  data type definitions, declarations, prototypes
  10  *
  11  *  Started by: Thomas Gleixner and Ingo Molnar
  12  *
  13  *  For licencing details see kernel-base/COPYING
  14  */
  15 #ifndef _LINUX_HRTIMER_H
  16 #define _LINUX_HRTIMER_H
  17
  18 #include <linux/rbtree.h>
  19 #include <linux/ktime.h>
  20 #include <linux/init.h>
  21 #include <linux/list.h>
  22 #include <linux/wait.h>
  23
  24 struct hrtimer_clock_base;
  25 struct hrtimer_cpu_base;
  26
  27 /*
  28  * Mode arguments of xxx_hrtimer functions:
  29  */
  30 enum hrtimer_mode {
  31         HRTIMER_MODE_ABS,       /* Time value is absolute */
  32         HRTIMER_MODE_REL,       /* Time value is relative to now */
  33 };
  34
  35 /*
  36  * Return values for the callback function
  37  */
  38 enum hrtimer_restart {
  39         HRTIMER_NORESTART,      /* Timer is not restarted */
  40         HRTIMER_RESTART,        /* Timer must be restarted */
  41 };
  42
  43 /*
  44  * hrtimer callback modes:
  45  *
  46  *      HRTIMER_CB_SOFTIRQ:             Callback must run in softirq context
  47  *      HRTIMER_CB_IRQSAFE:             Callback may run in hardirq context
  48  *      HRTIMER_CB_IRQSAFE_NO_RESTART:  Callback may run in hardirq context and
  49  *                                      does not restart the timer
  50  *      HRTIMER_CB_IRQSAFE_NO_SOFTIRQ:  Callback must run in hardirq context
  51  *                                      Special mode for tick emultation
  52  */
  53 enum hrtimer_cb_mode {
  54         HRTIMER_CB_SOFTIRQ,
  55         HRTIMER_CB_IRQSAFE,
  56         HRTIMER_CB_IRQSAFE_NO_RESTART,
  57         HRTIMER_CB_IRQSAFE_NO_SOFTIRQ,
  58 };
  59
  60 /*
  61  * Values to track state of the timer
  62  *
  63  * Possible states:
  64  *
  65  * 0x00         inactive
  66  * 0x01         enqueued into rbtree
  67  * 0x02         callback function running
  68  * 0x04         callback pending (high resolution mode)
  69  *
  70  * Special case:
  71  * 0x03         callback function running and enqueued
  72  *              (was requeued on another CPU)
  73  * The "callback function running and enqueued" status is only possible on
  74  * SMP. It happens for example when a posix timer expired and the callback
  75  * queued a signal. Between dropping the lock which protects the posix timer
  76  * and reacquiring the base lock of the hrtimer, another CPU can deliver the
  77  * signal and rearm the timer. We have to preserve the callback running state,
  78  * as otherwise the timer could be removed before the softirq code finishes the
  79  * the handling of the timer.
  80  *
  81  * The HRTIMER_STATE_ENQUEUED bit is always or'ed to the current state to
  82  * preserve the HRTIMER_STATE_CALLBACK bit in the above scenario.
  83  *
  84  * All state transitions are protected by cpu_base->lock.
  85  */
  86 #define HRTIMER_STATE_INACTIVE  0x00
  87 #define HRTIMER_STATE_ENQUEUED  0x01
  88 #define HRTIMER_STATE_CALLBACK  0x02
  89 #define HRTIMER_STATE_PENDING   0x04
  90
  91 /**
  92  * struct hrtimer - the basic hrtimer structure
  93  * @node:       red black tree node for time ordered insertion
  94  * @expires:    the absolute expiry time in the hrtimers internal
  95  *              representation. The time is related to the clock on
  96  *              which the timer is based.
  97  * @function:   timer expiry callback function
  98  * @base:       pointer to the timer base (per cpu and per clock)
  99  * @state:      state information (See bit values above)
 100  * @cb_mode:    high resolution timer feature to select the callback execution
 101  *               mode
 102  * @cb_entry:   list head to enqueue an expired timer into the callback list
 103  * @start_site: timer statistics field to store the site where the timer
 104  *              was started
 105  * @start_comm: timer statistics field to store the name of the process which
 106  *              started the timer
 107  * @start_pid: timer statistics field to store the pid of the task which
 108  *              started the timer
 109  *
 110  * The hrtimer structure must be initialized by hrtimer_init()
 111  */
 112 struct hrtimer {
 113         struct rb_node                  node;
 114         ktime_t                         expires;
 115         enum hrtimer_restart            (*function)(struct hrtimer *);
 116         struct hrtimer_clock_base       *base;
 117         unsigned long                   state;
 118         enum hrtimer_cb_mode            cb_mode;
 119         struct list_head                cb_entry;
 120 #ifdef CONFIG_TIMER_STATS
 121         void                            *start_site;
 122         char                            start_comm[16];
 123         int                             start_pid;
 124 #endif
 125 };
 126
 127 /**
 128  * struct hrtimer_sleeper - simple sleeper structure
 129  * @timer:      embedded timer structure
 130  * @task:       task to wake up
 131  *
 132  * task is set to NULL, when the timer expires.
 133  */
 134 struct hrtimer_sleeper {
 135         struct hrtimer timer;
 136         struct task_struct *task;
 137 };
 138
 139 /**
 140  * struct hrtimer_clock_base - the timer base for a specific clock
 141  * @cpu_base:           per cpu clock base
 142  * @index:              clock type index for per_cpu support when moving a
 143  *                      timer to a base on another cpu.
 144  * @active:             red black tree root node for the active timers
 145  * @first:              pointer to the timer node which expires first
 146  * @resolution:         the resolution of the clock, in nanoseconds
 147  * @get_time:           function to retrieve the current time of the clock
 148  * @get_softirq_time:   function to retrieve the current time from the softirq
 149  * @softirq_time:       the time when running the hrtimer queue in the softirq
 150  * @offset:             offset of this clock to the monotonic base
 151  * @reprogram:          function to reprogram the timer event
 152  */
 153 struct hrtimer_clock_base {
 154         struct hrtimer_cpu_base *cpu_base;
 155         clockid_t               index;
 156         struct rb_root          active;
 157         struct rb_node          *first;
 158         ktime_t                 resolution;
 159         ktime_t                 (*get_time)(void);
 160         ktime_t                 (*get_softirq_time)(void);
 161         ktime_t                 softirq_time;
 162 #ifdef CONFIG_HIGH_RES_TIMERS
 163         ktime_t                 offset;
 164         int                     (*reprogram)(struct hrtimer *t,
 165                                              struct hrtimer_clock_base *b,
 166                                              ktime_t n);
 167 #endif
 168 };
 169
 170 #define HRTIMER_MAX_CLOCK_BASES 2
 171
 172 /*
 173  * struct hrtimer_cpu_base - the per cpu clock bases
 174  * @lock:               lock protecting the base and associated clock bases
 175  *                      and timers
 176  * @clock_base:         array of clock bases for this cpu
 177  * @curr_timer:         the timer which is executing a callback right now
 178  * @expires_next:       absolute time of the next event which was scheduled
 179  *                      via clock_set_next_event()
 180  * @hres_active:        State of high resolution mode
 181  * @check_clocks:       Indictator, when set evaluate time source and clock
 182  *                      event devices whether high resolution mode can be
 183  *                      activated.
 184  * @cb_pending:         Expired timers are moved from the rbtree to this
 185  *                      list in the timer interrupt. The list is processed
 186  *                      in the softirq.
 187  * @nr_events:          Total number of timer interrupt events
 188  */
 189 struct hrtimer_cpu_base {
 190         spinlock_t                      lock;
 191         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 192         struct list_head                cb_pending;
 193 #ifdef CONFIG_HIGH_RES_TIMERS
 194         ktime_t                         expires_next;
 195         int                             hres_active;
 196         unsigned long                   nr_events;
 197 #endif
 198 };
 199
 200 #ifdef CONFIG_HIGH_RES_TIMERS
 201 struct clock_event_device;
 202
 203 extern void clock_was_set(void);
 204 extern void hres_timers_resume(void);
 205 extern void hrtimer_interrupt(struct clock_event_device *dev);
 206
 207 /*
 208  * In high resolution mode the time reference must be read accurate
 209  */
 210 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 211 {
 212         return timer->base->get_time();
 213 }
 214
 215 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 216 {
 217         return timer->base->cpu_base->hres_active;
 218 }
 219
 220 /*
 221  * The resolution of the clocks. The resolution value is returned in
 222  * the clock_getres() system call to give application programmers an
 223  * idea of the (in)accuracy of timers. Timer values are rounded up to
 224  * this resolution values.
 225  */
 226 # define HIGH_RES_NSEC          1
 227 # define KTIME_HIGH_RES         (ktime_t) { .tv64 = HIGH_RES_NSEC }
 228 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
 229 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
 230
 231 #else
 232
 233 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 234 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 235
 236 /*
 237  * clock_was_set() is a NOP for non- high-resolution systems. The
 238  * time-sorted order guarantees that a timer does not expire early and
 239  * is expired in the next softirq when the clock was advanced.
 240  */
 241 static inline void clock_was_set(void) { }
 242
 243 static inline void hres_timers_resume(void) { }
 244
 245 /*
 246  * In non high resolution mode the time reference is taken from
 247  * the base softirq time variable.
 248  */
 249 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 250 {
 251         return timer->base->softirq_time;
 252 }
 253
 254 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 255 {
 256         return 0;
 257 }
 258 #endif
 259
 260 extern ktime_t ktime_get(void);
 261 extern ktime_t ktime_get_real(void);
 262
 263 /* Exported timer functions: */
 264
 265 /* Initialize timers: */
 266 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
 267                          enum hrtimer_mode mode);
 268
 269 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
 270 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
 271                                   enum hrtimer_mode mode);
 272
 273 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
 274 #else
 275 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
 276                                          clockid_t which_clock,
 277                                          enum hrtimer_mode mode)
 278 {
 279         hrtimer_init(timer, which_clock, mode);
 280 }
 281 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
 282 #endif
 283
 284 /* Basic timer operations: */
 285 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
 286                          const enum hrtimer_mode mode);
 287 extern int hrtimer_cancel(struct hrtimer *timer);
 288 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 289
 290 static inline int hrtimer_restart(struct hrtimer *timer)
 291 {
 292         return hrtimer_start(timer, timer->expires, HRTIMER_MODE_ABS);
 293 }
 294
 295 /* Query timers: */
 296 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
 297 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
 298
 299 extern ktime_t hrtimer_get_next_event(void);
 300
 301 /*
 302  * A timer is active, when it is enqueued into the rbtree or the callback
 303  * function is running.
 304  */
 305 static inline int hrtimer_active(const struct hrtimer *timer)
 306 {
 307         return timer->state != HRTIMER_STATE_INACTIVE;
 308 }
 309
 310 /*
 311  * Helper function to check, whether the timer is on one of the queues
 312  */
 313 static inline int hrtimer_is_queued(struct hrtimer *timer)
 314 {
 315         return timer->state &
 316                 (HRTIMER_STATE_ENQUEUED | HRTIMER_STATE_PENDING);
 317 }
 318
 319 /*
 320  * Helper function to check, whether the timer is running the callback
 321  * function
 322  */
 323 static inline int hrtimer_callback_running(struct hrtimer *timer)
 324 {
 325         return timer->state & HRTIMER_STATE_CALLBACK;
 326 }
 327
 328 /* Forward a hrtimer so it expires after now: */
 329 extern u64
 330 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
 331
 332 /* Forward a hrtimer so it expires after the hrtimer's current now */
 333 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
 334                                       ktime_t interval)
 335 {
 336         return hrtimer_forward(timer, timer->base->get_time(), interval);
 337 }
 338
 339 /* Precise sleep: */
 340 extern long hrtimer_nanosleep(struct timespec *rqtp,
 341                               struct timespec __user *rmtp,
 342                               const enum hrtimer_mode mode,
 343                               const clockid_t clockid);
 344 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
 345
 346 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
 347                                  struct task_struct *tsk);
 348
 349 /* Soft interrupt function to run the hrtimer queues: */
 350 extern void hrtimer_run_queues(void);
 351 extern void hrtimer_run_pending(void);
 352
 353 /* Bootup initialization: */
 354 extern void __init hrtimers_init(void);
 355
 356 #if BITS_PER_LONG < 64
 357 extern u64 ktime_divns(const ktime_t kt, s64 div);
 358 #else /* BITS_PER_LONG < 64 */
 359 # define ktime_divns(kt, div)           (u64)((kt).tv64 / (div))
 360 #endif
 361
 362 /* Show pending timers: */
 363 extern void sysrq_timer_list_show(void);
 364
 365 /*
 366  * Timer-statistics info:
 367  */
 368 #ifdef CONFIG_TIMER_STATS
 369
 370 extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
 371                                      void *timerf, char *comm,
 372                                      unsigned int timer_flag);
 373
 374 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 375 {
 376         timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
 377                                  timer->function, timer->start_comm, 0);
 378 }
 379
 380 extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
 381                                                  void *addr);
 382
 383 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 384 {
 385         __timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
 386 }
 387
 388 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 389 {
 390         timer->start_site = NULL;
 391 }
 392 #else
 393 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 394 {
 395 }
 396
 397 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 398 {
 399 }
 400
 401 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 402 {
 403 }
 404 #endif
 405
 406 #endif