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