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 #include <linux/percpu.h>
  24
  25
  26 struct hrtimer_clock_base;
  27 struct hrtimer_cpu_base;
  28
  29 /*
  30  * Mode arguments of xxx_hrtimer functions:
  31  */
  32 enum hrtimer_mode {
  33         HRTIMER_MODE_ABS,       /* Time value is absolute */
  34         HRTIMER_MODE_REL,       /* Time value is relative to now */
  35 };
  36
  37 /*
  38  * Return values for the callback function
  39  */
  40 enum hrtimer_restart {
  41         HRTIMER_NORESTART,      /* Timer is not restarted */
  42         HRTIMER_RESTART,        /* Timer must be restarted */
  43 };
  44
  45 /*
  46  * hrtimer callback modes:
  47  *
  48  *      HRTIMER_CB_SOFTIRQ:             Callback must run in softirq context
  49  *      HRTIMER_CB_IRQSAFE:             Callback may run in hardirq context
  50  *      HRTIMER_CB_IRQSAFE_NO_RESTART:  Callback may run in hardirq context and
  51  *                                      does not restart the timer
  52  *      HRTIMER_CB_IRQSAFE_PERCPU:      Callback must run in hardirq context
  53  *                                      Special mode for tick emulation and
  54  *                                      scheduler timer. Such timers are per
  55  *                                      cpu and not allowed to be migrated on
  56  *                                      cpu unplug.
  57  *      HRTIMER_CB_IRQSAFE_UNLOCKED:    Callback should run in hardirq context
  58  *                                      with timer->base lock unlocked
  59  *                                      used for timers which call wakeup to
  60  *                                      avoid lock order problems with rq->lock
  61  */
  62 enum hrtimer_cb_mode {
  63         HRTIMER_CB_SOFTIRQ,
  64         HRTIMER_CB_IRQSAFE,
  65         HRTIMER_CB_IRQSAFE_NO_RESTART,
  66         HRTIMER_CB_IRQSAFE_PERCPU,
  67         HRTIMER_CB_IRQSAFE_UNLOCKED,
  68 };
  69
  70 /*
  71  * Values to track state of the timer
  72  *
  73  * Possible states:
  74  *
  75  * 0x00         inactive
  76  * 0x01         enqueued into rbtree
  77  * 0x02         callback function running
  78  * 0x04         callback pending (high resolution mode)
  79  *
  80  * Special cases:
  81  * 0x03         callback function running and enqueued
  82  *              (was requeued on another CPU)
  83  * 0x09         timer was migrated on CPU hotunplug
  84  * The "callback function running and enqueued" status is only possible on
  85  * SMP. It happens for example when a posix timer expired and the callback
  86  * queued a signal. Between dropping the lock which protects the posix timer
  87  * and reacquiring the base lock of the hrtimer, another CPU can deliver the
  88  * signal and rearm the timer. We have to preserve the callback running state,
  89  * as otherwise the timer could be removed before the softirq code finishes the
  90  * the handling of the timer.
  91  *
  92  * The HRTIMER_STATE_ENQUEUED bit is always or'ed to the current state to
  93  * preserve the HRTIMER_STATE_CALLBACK bit in the above scenario.
  94  *
  95  * All state transitions are protected by cpu_base->lock.
  96  */
  97 #define HRTIMER_STATE_INACTIVE  0x00
  98 #define HRTIMER_STATE_ENQUEUED  0x01
  99 #define HRTIMER_STATE_CALLBACK  0x02
 100 #define HRTIMER_STATE_PENDING   0x04
 101 #define HRTIMER_STATE_MIGRATE   0x08
 102
 103 /**
 104  * struct hrtimer - the basic hrtimer structure
 105  * @node:       red black tree node for time ordered insertion
 106  * @_expires:   the absolute expiry time in the hrtimers internal
 107  *              representation. The time is related to the clock on
 108  *              which the timer is based. Is setup by adding
 109  *              slack to the _softexpires value. For non range timers
 110  *              identical to _softexpires.
 111  * @_softexpires: the absolute earliest expiry time of the hrtimer.
 112  *              The time which was given as expiry time when the timer
 113  *              was armed.
 114  * @function:   timer expiry callback function
 115  * @base:       pointer to the timer base (per cpu and per clock)
 116  * @state:      state information (See bit values above)
 117  * @cb_mode:    high resolution timer feature to select the callback execution
 118  *               mode
 119  * @cb_entry:   list head to enqueue an expired timer into the callback list
 120  * @start_site: timer statistics field to store the site where the timer
 121  *              was started
 122  * @start_comm: timer statistics field to store the name of the process which
 123  *              started the timer
 124  * @start_pid: timer statistics field to store the pid of the task which
 125  *              started the timer
 126  *
 127  * The hrtimer structure must be initialized by hrtimer_init()
 128  */
 129 struct hrtimer {
 130         struct rb_node                  node;
 131         ktime_t                         _expires;
 132         ktime_t                         _softexpires;
 133         enum hrtimer_restart            (*function)(struct hrtimer *);
 134         struct hrtimer_clock_base       *base;
 135         unsigned long                   state;
 136         struct list_head                cb_entry;
 137         enum hrtimer_cb_mode            cb_mode;
 138 #ifdef CONFIG_TIMER_STATS
 139         int                             start_pid;
 140         void                            *start_site;
 141         char                            start_comm[16];
 142 #endif
 143 };
 144
 145 /**
 146  * struct hrtimer_sleeper - simple sleeper structure
 147  * @timer:      embedded timer structure
 148  * @task:       task to wake up
 149  *
 150  * task is set to NULL, when the timer expires.
 151  */
 152 struct hrtimer_sleeper {
 153         struct hrtimer timer;
 154         struct task_struct *task;
 155 };
 156
 157 /**
 158  * struct hrtimer_clock_base - the timer base for a specific clock
 159  * @cpu_base:           per cpu clock base
 160  * @index:              clock type index for per_cpu support when moving a
 161  *                      timer to a base on another cpu.
 162  * @active:             red black tree root node for the active timers
 163  * @first:              pointer to the timer node which expires first
 164  * @resolution:         the resolution of the clock, in nanoseconds
 165  * @get_time:           function to retrieve the current time of the clock
 166  * @softirq_time:       the time when running the hrtimer queue in the softirq
 167  * @offset:             offset of this clock to the monotonic base
 168  */
 169 struct hrtimer_clock_base {
 170         struct hrtimer_cpu_base *cpu_base;
 171         clockid_t               index;
 172         struct rb_root          active;
 173         struct rb_node          *first;
 174         ktime_t                 resolution;
 175         ktime_t                 (*get_time)(void);
 176         ktime_t                 softirq_time;
 177 #ifdef CONFIG_HIGH_RES_TIMERS
 178         ktime_t                 offset;
 179 #endif
 180 };
 181
 182 #define HRTIMER_MAX_CLOCK_BASES 2
 183
 184 /*
 185  * struct hrtimer_cpu_base - the per cpu clock bases
 186  * @lock:               lock protecting the base and associated clock bases
 187  *                      and timers
 188  * @clock_base:         array of clock bases for this cpu
 189  * @curr_timer:         the timer which is executing a callback right now
 190  * @expires_next:       absolute time of the next event which was scheduled
 191  *                      via clock_set_next_event()
 192  * @hres_active:        State of high resolution mode
 193  * @check_clocks:       Indictator, when set evaluate time source and clock
 194  *                      event devices whether high resolution mode can be
 195  *                      activated.
 196  * @cb_pending:         Expired timers are moved from the rbtree to this
 197  *                      list in the timer interrupt. The list is processed
 198  *                      in the softirq.
 199  * @nr_events:          Total number of timer interrupt events
 200  */
 201 struct hrtimer_cpu_base {
 202         spinlock_t                      lock;
 203         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 204         struct list_head                cb_pending;
 205 #ifdef CONFIG_HIGH_RES_TIMERS
 206         ktime_t                         expires_next;
 207         int                             hres_active;
 208         unsigned long                   nr_events;
 209 #endif
 210 };
 211
 212 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
 213 {
 214         timer->_expires = time;
 215         timer->_softexpires = time;
 216 }
 217
 218 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
 219 {
 220         timer->_softexpires = time;
 221         timer->_expires = ktime_add_safe(time, delta);
 222 }
 223
 224 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
 225 {
 226         timer->_softexpires = time;
 227         timer->_expires = ktime_add_safe(time, ns_to_ktime(delta));
 228 }
 229
 230 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
 231 {
 232         timer->_expires.tv64 = tv64;
 233         timer->_softexpires.tv64 = tv64;
 234 }
 235
 236 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
 237 {
 238         timer->_expires = ktime_add_safe(timer->_expires, time);
 239         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
 240 }
 241
 242 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
 243 {
 244         timer->_expires = ktime_add_ns(timer->_expires, ns);
 245         timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
 246 }
 247
 248 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
 249 {
 250         return timer->_expires;
 251 }
 252
 253 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
 254 {
 255         return timer->_softexpires;
 256 }
 257
 258 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
 259 {
 260         return timer->_expires.tv64;
 261 }
 262 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
 263 {
 264         return timer->_softexpires.tv64;
 265 }
 266
 267 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
 268 {
 269         return ktime_to_ns(timer->_expires);
 270 }
 271
 272 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
 273 {
 274     return ktime_sub(timer->_expires, timer->base->get_time());
 275 }
 276
 277 #ifdef CONFIG_HIGH_RES_TIMERS
 278 struct clock_event_device;
 279
 280 extern void clock_was_set(void);
 281 extern void hres_timers_resume(void);
 282 extern void hrtimer_interrupt(struct clock_event_device *dev);
 283
 284 /*
 285  * In high resolution mode the time reference must be read accurate
 286  */
 287 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 288 {
 289         return timer->base->get_time();
 290 }
 291
 292 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 293 {
 294         return timer->base->cpu_base->hres_active;
 295 }
 296
 297 extern void hrtimer_peek_ahead_timers(void);
 298
 299 /*
 300  * The resolution of the clocks. The resolution value is returned in
 301  * the clock_getres() system call to give application programmers an
 302  * idea of the (in)accuracy of timers. Timer values are rounded up to
 303  * this resolution values.
 304  */
 305 # define HIGH_RES_NSEC          1
 306 # define KTIME_HIGH_RES         (ktime_t) { .tv64 = HIGH_RES_NSEC }
 307 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
 308 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
 309
 310 #else
 311
 312 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 313 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 314
 315 /*
 316  * clock_was_set() is a NOP for non- high-resolution systems. The
 317  * time-sorted order guarantees that a timer does not expire early and
 318  * is expired in the next softirq when the clock was advanced.
 319  */
 320 static inline void clock_was_set(void) { }
 321 static inline void hrtimer_peek_ahead_timers(void) { }
 322
 323 static inline void hres_timers_resume(void) { }
 324
 325 /*
 326  * In non high resolution mode the time reference is taken from
 327  * the base softirq time variable.
 328  */
 329 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 330 {
 331         return timer->base->softirq_time;
 332 }
 333
 334 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 335 {
 336         return 0;
 337 }
 338 #endif
 339
 340 extern ktime_t ktime_get(void);
 341 extern ktime_t ktime_get_real(void);
 342
 343
 344 DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
 345
 346
 347 /* Exported timer functions: */
 348
 349 /* Initialize timers: */
 350 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
 351                          enum hrtimer_mode mode);
 352
 353 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
 354 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
 355                                   enum hrtimer_mode mode);
 356
 357 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
 358 #else
 359 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
 360                                          clockid_t which_clock,
 361                                          enum hrtimer_mode mode)
 362 {
 363         hrtimer_init(timer, which_clock, mode);
 364 }
 365 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
 366 #endif
 367
 368 /* Basic timer operations: */
 369 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
 370                          const enum hrtimer_mode mode);
 371 extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
 372                         unsigned long range_ns, const enum hrtimer_mode mode);
 373 extern int hrtimer_cancel(struct hrtimer *timer);
 374 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 375
 376 static inline int hrtimer_start_expires(struct hrtimer *timer,
 377                                                 enum hrtimer_mode mode)
 378 {
 379         unsigned long delta;
 380         ktime_t soft, hard;
 381         soft = hrtimer_get_softexpires(timer);
 382         hard = hrtimer_get_expires(timer);
 383         delta = ktime_to_ns(ktime_sub(hard, soft));
 384         return hrtimer_start_range_ns(timer, soft, delta, mode);
 385 }
 386
 387 static inline int hrtimer_restart(struct hrtimer *timer)
 388 {
 389         return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
 390 }
 391
 392 /* Query timers: */
 393 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
 394 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
 395
 396 extern ktime_t hrtimer_get_next_event(void);
 397
 398 /*
 399  * A timer is active, when it is enqueued into the rbtree or the callback
 400  * function is running.
 401  */
 402 static inline int hrtimer_active(const struct hrtimer *timer)
 403 {
 404         return timer->state != HRTIMER_STATE_INACTIVE;
 405 }
 406
 407 /*
 408  * Helper function to check, whether the timer is on one of the queues
 409  */
 410 static inline int hrtimer_is_queued(struct hrtimer *timer)
 411 {
 412         return timer->state &
 413                 (HRTIMER_STATE_ENQUEUED | HRTIMER_STATE_PENDING);
 414 }
 415
 416 /*
 417  * Helper function to check, whether the timer is running the callback
 418  * function
 419  */
 420 static inline int hrtimer_callback_running(struct hrtimer *timer)
 421 {
 422         return timer->state & HRTIMER_STATE_CALLBACK;
 423 }
 424
 425 /* Forward a hrtimer so it expires after now: */
 426 extern u64
 427 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
 428
 429 /* Forward a hrtimer so it expires after the hrtimer's current now */
 430 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
 431                                       ktime_t interval)
 432 {
 433         return hrtimer_forward(timer, timer->base->get_time(), interval);
 434 }
 435
 436 /* Precise sleep: */
 437 extern long hrtimer_nanosleep(struct timespec *rqtp,
 438                               struct timespec __user *rmtp,
 439                               const enum hrtimer_mode mode,
 440                               const clockid_t clockid);
 441 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
 442
 443 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
 444                                  struct task_struct *tsk);
 445
 446 extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
 447                                                 const enum hrtimer_mode mode);
 448 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
 449
 450 /* Soft interrupt function to run the hrtimer queues: */
 451 extern void hrtimer_run_queues(void);
 452 extern void hrtimer_run_pending(void);
 453
 454 /* Bootup initialization: */
 455 extern void __init hrtimers_init(void);
 456
 457 #if BITS_PER_LONG < 64
 458 extern u64 ktime_divns(const ktime_t kt, s64 div);
 459 #else /* BITS_PER_LONG < 64 */
 460 # define ktime_divns(kt, div)           (u64)((kt).tv64 / (div))
 461 #endif
 462
 463 /* Show pending timers: */
 464 extern void sysrq_timer_list_show(void);
 465
 466 /*
 467  * Timer-statistics info:
 468  */
 469 #ifdef CONFIG_TIMER_STATS
 470
 471 extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
 472                                      void *timerf, char *comm,
 473                                      unsigned int timer_flag);
 474
 475 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 476 {
 477         timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
 478                                  timer->function, timer->start_comm, 0);
 479 }
 480
 481 extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
 482                                                  void *addr);
 483
 484 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 485 {
 486         __timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
 487 }
 488
 489 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 490 {
 491         timer->start_site = NULL;
 492 }
 493 #else
 494 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 495 {
 496 }
 497
 498 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 499 {
 500 }
 501
 502 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 503 {
 504 }
 505 #endif
 506
 507 #endif