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         ktime_t                         _softexpires;
 116         enum hrtimer_restart            (*function)(struct hrtimer *);
 117         struct hrtimer_clock_base       *base;
 118         unsigned long                   state;
 119         enum hrtimer_cb_mode            cb_mode;
 120         struct list_head                cb_entry;
 121 #ifdef CONFIG_TIMER_STATS
 122         void                            *start_site;
 123         char                            start_comm[16];
 124         int                             start_pid;
 125 #endif
 126 };
 127
 128 /**
 129  * struct hrtimer_sleeper - simple sleeper structure
 130  * @timer:      embedded timer structure
 131  * @task:       task to wake up
 132  *
 133  * task is set to NULL, when the timer expires.
 134  */
 135 struct hrtimer_sleeper {
 136         struct hrtimer timer;
 137         struct task_struct *task;
 138 };
 139
 140 /**
 141  * struct hrtimer_clock_base - the timer base for a specific clock
 142  * @cpu_base:           per cpu clock base
 143  * @index:              clock type index for per_cpu support when moving a
 144  *                      timer to a base on another cpu.
 145  * @active:             red black tree root node for the active timers
 146  * @first:              pointer to the timer node which expires first
 147  * @resolution:         the resolution of the clock, in nanoseconds
 148  * @get_time:           function to retrieve the current time of the clock
 149  * @get_softirq_time:   function to retrieve the current time from the softirq
 150  * @softirq_time:       the time when running the hrtimer queue in the softirq
 151  * @offset:             offset of this clock to the monotonic base
 152  * @reprogram:          function to reprogram the timer event
 153  */
 154 struct hrtimer_clock_base {
 155         struct hrtimer_cpu_base *cpu_base;
 156         clockid_t               index;
 157         struct rb_root          active;
 158         struct rb_node          *first;
 159         ktime_t                 resolution;
 160         ktime_t                 (*get_time)(void);
 161         ktime_t                 (*get_softirq_time)(void);
 162         ktime_t                 softirq_time;
 163 #ifdef CONFIG_HIGH_RES_TIMERS
 164         ktime_t                 offset;
 165         int                     (*reprogram)(struct hrtimer *t,
 166                                              struct hrtimer_clock_base *b,
 167                                              ktime_t n);
 168 #endif
 169 };
 170
 171 #define HRTIMER_MAX_CLOCK_BASES 2
 172
 173 /*
 174  * struct hrtimer_cpu_base - the per cpu clock bases
 175  * @lock:               lock protecting the base and associated clock bases
 176  *                      and timers
 177  * @clock_base:         array of clock bases for this cpu
 178  * @curr_timer:         the timer which is executing a callback right now
 179  * @expires_next:       absolute time of the next event which was scheduled
 180  *                      via clock_set_next_event()
 181  * @hres_active:        State of high resolution mode
 182  * @check_clocks:       Indictator, when set evaluate time source and clock
 183  *                      event devices whether high resolution mode can be
 184  *                      activated.
 185  * @cb_pending:         Expired timers are moved from the rbtree to this
 186  *                      list in the timer interrupt. The list is processed
 187  *                      in the softirq.
 188  * @nr_events:          Total number of timer interrupt events
 189  */
 190 struct hrtimer_cpu_base {
 191         spinlock_t                      lock;
 192         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 193         struct list_head                cb_pending;
 194 #ifdef CONFIG_HIGH_RES_TIMERS
 195         ktime_t                         expires_next;
 196         int                             hres_active;
 197         unsigned long                   nr_events;
 198 #endif
 199 };
 200
 201 #ifdef CONFIG_HIGH_RES_TIMERS
 202 struct clock_event_device;
 203
 204 extern void clock_was_set(void);
 205 extern void hres_timers_resume(void);
 206 extern void hrtimer_interrupt(struct clock_event_device *dev);
 207
 208 /*
 209  * In high resolution mode the time reference must be read accurate
 210  */
 211 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 212 {
 213         return timer->base->get_time();
 214 }
 215
 216 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 217 {
 218         return timer->base->cpu_base->hres_active;
 219 }
 220
 221 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
 222 {
 223         timer->_expires = time;
 224         timer->_softexpires = time;
 225 }
 226
 227 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
 228 {
 229         timer->_softexpires = time;
 230         timer->_expires = ktime_add_safe(time, delta);
 231 }
 232
 233 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
 234 {
 235         timer->_softexpires = time;
 236         timer->_expires = ktime_add_safe(time, ns_to_ktime(delta));
 237 }
 238
 239 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
 240 {
 241         timer->_expires.tv64 = tv64;
 242         timer->_softexpires.tv64 = tv64;
 243 }
 244
 245 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
 246 {
 247         timer->_expires = ktime_add_safe(timer->_expires, time);
 248         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
 249 }
 250
 251 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, unsigned long ns)
 252 {
 253         timer->_expires = ktime_add_ns(timer->_expires, ns);
 254         timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
 255 }
 256
 257 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
 258 {
 259         return timer->_expires;
 260 }
 261
 262 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
 263 {
 264         return timer->_softexpires;
 265 }
 266
 267 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
 268 {
 269         return timer->_expires.tv64;
 270 }
 271 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
 272 {
 273         return timer->_softexpires.tv64;
 274 }
 275
 276 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
 277 {
 278         return ktime_to_ns(timer->_expires);
 279 }
 280
 281 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
 282 {
 283     return ktime_sub(timer->_expires, timer->base->get_time());
 284 }
 285
 286 /*
 287  * The resolution of the clocks. The resolution value is returned in
 288  * the clock_getres() system call to give application programmers an
 289  * idea of the (in)accuracy of timers. Timer values are rounded up to
 290  * this resolution values.
 291  */
 292 # define HIGH_RES_NSEC          1
 293 # define KTIME_HIGH_RES         (ktime_t) { .tv64 = HIGH_RES_NSEC }
 294 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
 295 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
 296
 297 #else
 298
 299 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 300 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 301
 302 /*
 303  * clock_was_set() is a NOP for non- high-resolution systems. The
 304  * time-sorted order guarantees that a timer does not expire early and
 305  * is expired in the next softirq when the clock was advanced.
 306  */
 307 static inline void clock_was_set(void) { }
 308
 309 static inline void hres_timers_resume(void) { }
 310
 311 /*
 312  * In non high resolution mode the time reference is taken from
 313  * the base softirq time variable.
 314  */
 315 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 316 {
 317         return timer->base->softirq_time;
 318 }
 319
 320 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 321 {
 322         return 0;
 323 }
 324 #endif
 325
 326 extern ktime_t ktime_get(void);
 327 extern ktime_t ktime_get_real(void);
 328
 329 /* Exported timer functions: */
 330
 331 /* Initialize timers: */
 332 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
 333                          enum hrtimer_mode mode);
 334
 335 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
 336 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
 337                                   enum hrtimer_mode mode);
 338
 339 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
 340 #else
 341 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
 342                                          clockid_t which_clock,
 343                                          enum hrtimer_mode mode)
 344 {
 345         hrtimer_init(timer, which_clock, mode);
 346 }
 347 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
 348 #endif
 349
 350 /* Basic timer operations: */
 351 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
 352                          const enum hrtimer_mode mode);
 353 extern int hrtimer_cancel(struct hrtimer *timer);
 354 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 355
 356 static inline int hrtimer_start_expires(struct hrtimer *timer,
 357                                                 enum hrtimer_mode mode)
 358 {
 359         return hrtimer_start(timer, hrtimer_get_expires(timer), mode);
 360 }
 361
 362 static inline int hrtimer_restart(struct hrtimer *timer)
 363 {
 364         return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
 365 }
 366
 367 /* Query timers: */
 368 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
 369 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
 370
 371 extern ktime_t hrtimer_get_next_event(void);
 372
 373 /*
 374  * A timer is active, when it is enqueued into the rbtree or the callback
 375  * function is running.
 376  */
 377 static inline int hrtimer_active(const struct hrtimer *timer)
 378 {
 379         return timer->state != HRTIMER_STATE_INACTIVE;
 380 }
 381
 382 /*
 383  * Helper function to check, whether the timer is on one of the queues
 384  */
 385 static inline int hrtimer_is_queued(struct hrtimer *timer)
 386 {
 387         return timer->state &
 388                 (HRTIMER_STATE_ENQUEUED | HRTIMER_STATE_PENDING);
 389 }
 390
 391 /*
 392  * Helper function to check, whether the timer is running the callback
 393  * function
 394  */
 395 static inline int hrtimer_callback_running(struct hrtimer *timer)
 396 {
 397         return timer->state & HRTIMER_STATE_CALLBACK;
 398 }
 399
 400 /* Forward a hrtimer so it expires after now: */
 401 extern u64
 402 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
 403
 404 /* Forward a hrtimer so it expires after the hrtimer's current now */
 405 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
 406                                       ktime_t interval)
 407 {
 408         return hrtimer_forward(timer, timer->base->get_time(), interval);
 409 }
 410
 411 /* Precise sleep: */
 412 extern long hrtimer_nanosleep(struct timespec *rqtp,
 413                               struct timespec __user *rmtp,
 414                               const enum hrtimer_mode mode,
 415                               const clockid_t clockid);
 416 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
 417
 418 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
 419                                  struct task_struct *tsk);
 420
 421 extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
 422                                                 const enum hrtimer_mode mode);
 423 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
 424
 425 /* Soft interrupt function to run the hrtimer queues: */
 426 extern void hrtimer_run_queues(void);
 427 extern void hrtimer_run_pending(void);
 428
 429 /* Bootup initialization: */
 430 extern void __init hrtimers_init(void);
 431
 432 #if BITS_PER_LONG < 64
 433 extern u64 ktime_divns(const ktime_t kt, s64 div);
 434 #else /* BITS_PER_LONG < 64 */
 435 # define ktime_divns(kt, div)           (u64)((kt).tv64 / (div))
 436 #endif
 437
 438 /* Show pending timers: */
 439 extern void sysrq_timer_list_show(void);
 440
 441 /*
 442  * Timer-statistics info:
 443  */
 444 #ifdef CONFIG_TIMER_STATS
 445
 446 extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
 447                                      void *timerf, char *comm,
 448                                      unsigned int timer_flag);
 449
 450 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 451 {
 452         timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
 453                                  timer->function, timer->start_comm, 0);
 454 }
 455
 456 extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
 457                                                  void *addr);
 458
 459 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 460 {
 461         __timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
 462 }
 463
 464 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 465 {
 466         timer->start_site = NULL;
 467 }
 468 #else
 469 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 470 {
 471 }
 472
 473 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 474 {
 475 }
 476
 477 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 478 {
 479 }
 480 #endif
 481
 482 #endif