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         struct list_head                cb_entry;
 119         enum hrtimer_cb_mode            cb_mode;
 120 #ifdef CONFIG_TIMER_STATS
 121         int                             start_pid;
 122         void                            *start_site;
 123         char                            start_comm[16];
 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  * @softirq_time:       the time when running the hrtimer queue in the softirq
 149  * @offset:             offset of this clock to the monotonic base
 150  */
 151 struct hrtimer_clock_base {
 152         struct hrtimer_cpu_base *cpu_base;
 153         clockid_t               index;
 154         struct rb_root          active;
 155         struct rb_node          *first;
 156         ktime_t                 resolution;
 157         ktime_t                 (*get_time)(void);
 158         ktime_t                 softirq_time;
 159 #ifdef CONFIG_HIGH_RES_TIMERS
 160         ktime_t                 offset;
 161 #endif
 162 };
 163
 164 #define HRTIMER_MAX_CLOCK_BASES 2
 165
 166 /*
 167  * struct hrtimer_cpu_base - the per cpu clock bases
 168  * @lock:               lock protecting the base and associated clock bases
 169  *                      and timers
 170  * @clock_base:         array of clock bases for this cpu
 171  * @curr_timer:         the timer which is executing a callback right now
 172  * @expires_next:       absolute time of the next event which was scheduled
 173  *                      via clock_set_next_event()
 174  * @hres_active:        State of high resolution mode
 175  * @check_clocks:       Indictator, when set evaluate time source and clock
 176  *                      event devices whether high resolution mode can be
 177  *                      activated.
 178  * @cb_pending:         Expired timers are moved from the rbtree to this
 179  *                      list in the timer interrupt. The list is processed
 180  *                      in the softirq.
 181  * @nr_events:          Total number of timer interrupt events
 182  */
 183 struct hrtimer_cpu_base {
 184         spinlock_t                      lock;
 185         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 186         struct list_head                cb_pending;
 187 #ifdef CONFIG_HIGH_RES_TIMERS
 188         ktime_t                         expires_next;
 189         int                             hres_active;
 190         unsigned long                   nr_events;
 191 #endif
 192 };
 193
 194 #ifdef CONFIG_HIGH_RES_TIMERS
 195 struct clock_event_device;
 196
 197 extern void clock_was_set(void);
 198 extern void hres_timers_resume(void);
 199 extern void hrtimer_interrupt(struct clock_event_device *dev);
 200
 201 /*
 202  * In high resolution mode the time reference must be read accurate
 203  */
 204 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 205 {
 206         return timer->base->get_time();
 207 }
 208
 209 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 210 {
 211         return timer->base->cpu_base->hres_active;
 212 }
 213
 214 /*
 215  * The resolution of the clocks. The resolution value is returned in
 216  * the clock_getres() system call to give application programmers an
 217  * idea of the (in)accuracy of timers. Timer values are rounded up to
 218  * this resolution values.
 219  */
 220 # define HIGH_RES_NSEC          1
 221 # define KTIME_HIGH_RES         (ktime_t) { .tv64 = HIGH_RES_NSEC }
 222 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
 223 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
 224
 225 #else
 226
 227 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 228 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 229
 230 /*
 231  * clock_was_set() is a NOP for non- high-resolution systems. The
 232  * time-sorted order guarantees that a timer does not expire early and
 233  * is expired in the next softirq when the clock was advanced.
 234  */
 235 static inline void clock_was_set(void) { }
 236
 237 static inline void hres_timers_resume(void) { }
 238
 239 /*
 240  * In non high resolution mode the time reference is taken from
 241  * the base softirq time variable.
 242  */
 243 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 244 {
 245         return timer->base->softirq_time;
 246 }
 247
 248 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 249 {
 250         return 0;
 251 }
 252 #endif
 253
 254 extern ktime_t ktime_get(void);
 255 extern ktime_t ktime_get_real(void);
 256
 257 /* Exported timer functions: */
 258
 259 /* Initialize timers: */
 260 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
 261                          enum hrtimer_mode mode);
 262
 263 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
 264 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
 265                                   enum hrtimer_mode mode);
 266
 267 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
 268 #else
 269 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
 270                                          clockid_t which_clock,
 271                                          enum hrtimer_mode mode)
 272 {
 273         hrtimer_init(timer, which_clock, mode);
 274 }
 275 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
 276 #endif
 277
 278 /* Basic timer operations: */
 279 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
 280                          const enum hrtimer_mode mode);
 281 extern int hrtimer_cancel(struct hrtimer *timer);
 282 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 283
 284 static inline int hrtimer_restart(struct hrtimer *timer)
 285 {
 286         return hrtimer_start(timer, timer->expires, HRTIMER_MODE_ABS);
 287 }
 288
 289 /* Query timers: */
 290 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
 291 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
 292
 293 extern ktime_t hrtimer_get_next_event(void);
 294
 295 /*
 296  * A timer is active, when it is enqueued into the rbtree or the callback
 297  * function is running.
 298  */
 299 static inline int hrtimer_active(const struct hrtimer *timer)
 300 {
 301         return timer->state != HRTIMER_STATE_INACTIVE;
 302 }
 303
 304 /*
 305  * Helper function to check, whether the timer is on one of the queues
 306  */
 307 static inline int hrtimer_is_queued(struct hrtimer *timer)
 308 {
 309         return timer->state &
 310                 (HRTIMER_STATE_ENQUEUED | HRTIMER_STATE_PENDING);
 311 }
 312
 313 /*
 314  * Helper function to check, whether the timer is running the callback
 315  * function
 316  */
 317 static inline int hrtimer_callback_running(struct hrtimer *timer)
 318 {
 319         return timer->state & HRTIMER_STATE_CALLBACK;
 320 }
 321
 322 /* Forward a hrtimer so it expires after now: */
 323 extern u64
 324 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
 325
 326 /* Forward a hrtimer so it expires after the hrtimer's current now */
 327 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
 328                                       ktime_t interval)
 329 {
 330         return hrtimer_forward(timer, timer->base->get_time(), interval);
 331 }
 332
 333 /* Precise sleep: */
 334 extern long hrtimer_nanosleep(struct timespec *rqtp,
 335                               struct timespec __user *rmtp,
 336                               const enum hrtimer_mode mode,
 337                               const clockid_t clockid);
 338 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
 339
 340 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
 341                                  struct task_struct *tsk);
 342
 343 /* Soft interrupt function to run the hrtimer queues: */
 344 extern void hrtimer_run_queues(void);
 345 extern void hrtimer_run_pending(void);
 346
 347 /* Bootup initialization: */
 348 extern void __init hrtimers_init(void);
 349
 350 #if BITS_PER_LONG < 64
 351 extern u64 ktime_divns(const ktime_t kt, s64 div);
 352 #else /* BITS_PER_LONG < 64 */
 353 # define ktime_divns(kt, div)           (u64)((kt).tv64 / (div))
 354 #endif
 355
 356 /* Show pending timers: */
 357 extern void sysrq_timer_list_show(void);
 358
 359 /*
 360  * Timer-statistics info:
 361  */
 362 #ifdef CONFIG_TIMER_STATS
 363
 364 extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
 365                                      void *timerf, char *comm,
 366                                      unsigned int timer_flag);
 367
 368 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 369 {
 370         timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
 371                                  timer->function, timer->start_comm, 0);
 372 }
 373
 374 extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
 375                                                  void *addr);
 376
 377 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 378 {
 379         __timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
 380 }
 381
 382 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 383 {
 384         timer->start_site = NULL;
 385 }
 386 #else
 387 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 388 {
 389 }
 390
 391 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 392 {
 393 }
 394
 395 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 396 {
 397 }
 398 #endif
 399
 400 #endif