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