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  *
  57  * The callback state is not part of the timer->state because clearing it would
  58  * mean touching the timer after the callback, this makes it impossible to free
  59  * the timer from the callback function.
  60  *
  61  * Therefore we track the callback state in:
  62  *
  63  *      timer->base->cpu_base->running == timer
  64  *
  65  * On SMP it is possible to have a "callback function running and enqueued"
  66  * status. It happens for example when a posix timer expired and the callback
  67  * queued a signal. Between dropping the lock which protects the posix timer
  68  * and reacquiring the base lock of the hrtimer, another CPU can deliver the
  69  * signal and rearm the timer.
  70  *
  71  * All state transitions are protected by cpu_base->lock.
  72  */
  73 #define HRTIMER_STATE_INACTIVE  0x00
  74 #define HRTIMER_STATE_ENQUEUED  0x01
  75
  76 /**
  77  * struct hrtimer - the basic hrtimer structure
  78  * @node:       timerqueue node, which also manages node.expires,
  79  *              the absolute expiry time in the hrtimers internal
  80  *              representation. The time is related to the clock on
  81  *              which the timer is based. Is setup by adding
  82  *              slack to the _softexpires value. For non range timers
  83  *              identical to _softexpires.
  84  * @_softexpires: the absolute earliest expiry time of the hrtimer.
  85  *              The time which was given as expiry time when the timer
  86  *              was armed.
  87  * @function:   timer expiry callback function
  88  * @base:       pointer to the timer base (per cpu and per clock)
  89  * @state:      state information (See bit values above)
  90  * @is_rel:     Set if the timer was armed relative
  91  * @start_pid:  timer statistics field to store the pid of the task which
  92  *              started the timer
  93  * @start_site: timer statistics field to store the site where the timer
  94  *              was started
  95  * @start_comm: timer statistics field to store the name of the process which
  96  *              started the timer
  97  *
  98  * The hrtimer structure must be initialized by hrtimer_init()
  99  */
 100 struct hrtimer {
 101         struct timerqueue_node          node;
 102         ktime_t                         _softexpires;
 103         enum hrtimer_restart            (*function)(struct hrtimer *);
 104         struct hrtimer_clock_base       *base;
 105         u8                              state;
 106         u8                              is_rel;
 107 #ifdef CONFIG_TIMER_STATS
 108         int                             start_pid;
 109         void                            *start_site;
 110         char                            start_comm[16];
 111 #endif
 112 };
 113
 114 /**
 115  * struct hrtimer_sleeper - simple sleeper structure
 116  * @timer:      embedded timer structure
 117  * @task:       task to wake up
 118  *
 119  * task is set to NULL, when the timer expires.
 120  */
 121 struct hrtimer_sleeper {
 122         struct hrtimer timer;
 123         struct task_struct *task;
 124 };
 125
 126 #ifdef CONFIG_64BIT
 127 # define HRTIMER_CLOCK_BASE_ALIGN       64
 128 #else
 129 # define HRTIMER_CLOCK_BASE_ALIGN       32
 130 #endif
 131
 132 /**
 133  * struct hrtimer_clock_base - the timer base for a specific clock
 134  * @cpu_base:           per cpu clock base
 135  * @index:              clock type index for per_cpu support when moving a
 136  *                      timer to a base on another cpu.
 137  * @clockid:            clock id for per_cpu support
 138  * @active:             red black tree root node for the active timers
 139  * @get_time:           function to retrieve the current time of the clock
 140  * @offset:             offset of this clock to the monotonic base
 141  */
 142 struct hrtimer_clock_base {
 143         struct hrtimer_cpu_base *cpu_base;
 144         int                     index;
 145         clockid_t               clockid;
 146         struct timerqueue_head  active;
 147         ktime_t                 (*get_time)(void);
 148         ktime_t                 offset;
 149 } __attribute__((__aligned__(HRTIMER_CLOCK_BASE_ALIGN)));
 150
 151 enum  hrtimer_base_type {
 152         HRTIMER_BASE_MONOTONIC,
 153         HRTIMER_BASE_REALTIME,
 154         HRTIMER_BASE_BOOTTIME,
 155         HRTIMER_BASE_TAI,
 156         HRTIMER_BASE_MONOTONIC_RAW,
 157         HRTIMER_MAX_CLOCK_BASES,
 158 };
 159
 160 /*
 161  * struct hrtimer_cpu_base - the per cpu clock bases
 162  * @lock:               lock protecting the base and associated clock bases
 163  *                      and timers
 164  * @seq:                seqcount around __run_hrtimer
 165  * @running:            pointer to the currently running hrtimer
 166  * @cpu:                cpu number
 167  * @active_bases:       Bitfield to mark bases with active timers
 168  * @clock_was_set_seq:  Sequence counter of clock was set events
 169  * @migration_enabled:  The migration of hrtimers to other cpus is enabled
 170  * @nohz_active:        The nohz functionality is enabled
 171  * @expires_next:       absolute time of the next event which was scheduled
 172  *                      via clock_set_next_event()
 173  * @next_timer:         Pointer to the first expiring timer
 174  * @in_hrtirq:          hrtimer_interrupt() is currently executing
 175  * @hres_active:        State of high resolution mode
 176  * @hang_detected:      The last hrtimer interrupt detected a hang
 177  * @nr_events:          Total number of hrtimer interrupt events
 178  * @nr_retries:         Total number of hrtimer interrupt retries
 179  * @nr_hangs:           Total number of hrtimer interrupt hangs
 180  * @max_hang_time:      Maximum time spent in hrtimer_interrupt
 181  * @clock_base:         array of clock bases for this cpu
 182  *
 183  * Note: next_timer is just an optimization for __remove_hrtimer().
 184  *       Do not dereference the pointer because it is not reliable on
 185  *       cross cpu removals.
 186  */
 187 struct hrtimer_cpu_base {
 188         raw_spinlock_t                  lock;
 189         seqcount_t                      seq;
 190         struct hrtimer                  *running;
 191         unsigned int                    cpu;
 192         unsigned int                    active_bases;
 193         unsigned int                    clock_was_set_seq;
 194         bool                            migration_enabled;
 195         bool                            nohz_active;
 196 #ifdef CONFIG_HIGH_RES_TIMERS
 197         unsigned int                    in_hrtirq       : 1,
 198                                         hres_active     : 1,
 199                                         hang_detected   : 1;
 200         ktime_t                         expires_next;
 201         struct hrtimer                  *next_timer;
 202         unsigned int                    nr_events;
 203         unsigned int                    nr_retries;
 204         unsigned int                    nr_hangs;
 205         unsigned int                    max_hang_time;
 206 #endif
 207         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 208 } ____cacheline_aligned;
 209
 210 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
 211 {
 212         BUILD_BUG_ON(sizeof(struct hrtimer_clock_base) > HRTIMER_CLOCK_BASE_ALIGN);
 213
 214         timer->node.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->node.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->node.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->node.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->node.expires = ktime_add_safe(timer->node.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->node.expires = ktime_add_ns(timer->node.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->node.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->node.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->node.expires);
 270 }
 271
 272 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
 273 {
 274         return ktime_sub(timer->node.expires, timer->base->get_time());
 275 }
 276
 277 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 278 {
 279         return timer->base->get_time();
 280 }
 281
 282 #ifdef CONFIG_HIGH_RES_TIMERS
 283 struct clock_event_device;
 284
 285 extern void hrtimer_interrupt(struct clock_event_device *dev);
 286
 287 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 288 {
 289         return timer->base->cpu_base->hres_active;
 290 }
 291
 292 extern void hrtimer_peek_ahead_timers(void);
 293
 294 /*
 295  * The resolution of the clocks. The resolution value is returned in
 296  * the clock_getres() system call to give application programmers an
 297  * idea of the (in)accuracy of timers. Timer values are rounded up to
 298  * this resolution values.
 299  */
 300 # define HIGH_RES_NSEC          1
 301 # define KTIME_HIGH_RES         (ktime_t) { .tv64 = HIGH_RES_NSEC }
 302 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
 303 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
 304
 305 extern void clock_was_set_delayed(void);
 306
 307 extern unsigned int hrtimer_resolution;
 308
 309 #else
 310
 311 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 312 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 313
 314 #define hrtimer_resolution      (unsigned int)LOW_RES_NSEC
 315
 316 static inline void hrtimer_peek_ahead_timers(void) { }
 317
 318 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 319 {
 320         return 0;
 321 }
 322
 323 static inline void clock_was_set_delayed(void) { }
 324
 325 #endif
 326
 327 static inline ktime_t
 328 __hrtimer_expires_remaining_adjusted(const struct hrtimer *timer, ktime_t now)
 329 {
 330         ktime_t rem = ktime_sub(timer->node.expires, now);
 331
 332         /*
 333          * Adjust relative timers for the extra we added in
 334          * hrtimer_start_range_ns() to prevent short timeouts.
 335          */
 336         if (IS_ENABLED(CONFIG_TIME_LOW_RES) && timer->is_rel)
 337                 rem.tv64 -= hrtimer_resolution;
 338         return rem;
 339 }
 340
 341 static inline ktime_t
 342 hrtimer_expires_remaining_adjusted(const struct hrtimer *timer)
 343 {
 344         return __hrtimer_expires_remaining_adjusted(timer,
 345                                                     timer->base->get_time());
 346 }
 347
 348 extern void clock_was_set(void);
 349 #ifdef CONFIG_TIMERFD
 350 extern void timerfd_clock_was_set(void);
 351 #else
 352 static inline void timerfd_clock_was_set(void) { }
 353 #endif
 354 extern void hrtimers_resume(void);
 355
 356 DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
 357
 358
 359 /* Exported timer functions: */
 360
 361 /* Initialize timers: */
 362 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
 363                          enum hrtimer_mode mode);
 364
 365 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
 366 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
 367                                   enum hrtimer_mode mode);
 368
 369 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
 370 #else
 371 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
 372                                          clockid_t which_clock,
 373                                          enum hrtimer_mode mode)
 374 {
 375         hrtimer_init(timer, which_clock, mode);
 376 }
 377 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
 378 #endif
 379
 380 /* Basic timer operations: */
 381 extern void hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
 382                         unsigned long range_ns, const enum hrtimer_mode mode);
 383
 384 /**
 385  * hrtimer_start - (re)start an hrtimer on the current CPU
 386  * @timer:      the timer to be added
 387  * @tim:        expiry time
 388  * @mode:       expiry mode: absolute (HRTIMER_MODE_ABS) or
 389  *              relative (HRTIMER_MODE_REL)
 390  */
 391 static inline void hrtimer_start(struct hrtimer *timer, ktime_t tim,
 392                                  const enum hrtimer_mode mode)
 393 {
 394         hrtimer_start_range_ns(timer, tim, 0, mode);
 395 }
 396
 397 extern int hrtimer_cancel(struct hrtimer *timer);
 398 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 399
 400 static inline void hrtimer_start_expires(struct hrtimer *timer,
 401                                          enum hrtimer_mode mode)
 402 {
 403         unsigned long delta;
 404         ktime_t soft, hard;
 405         soft = hrtimer_get_softexpires(timer);
 406         hard = hrtimer_get_expires(timer);
 407         delta = ktime_to_ns(ktime_sub(hard, soft));
 408         hrtimer_start_range_ns(timer, soft, delta, mode);
 409 }
 410
 411 static inline void hrtimer_restart(struct hrtimer *timer)
 412 {
 413         hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
 414 }
 415
 416 /* Query timers: */
 417 extern ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust);
 418
 419 static inline ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
 420 {
 421         return __hrtimer_get_remaining(timer, false);
 422 }
 423
 424 extern u64 hrtimer_get_next_event(void);
 425
 426 extern bool hrtimer_active(const struct hrtimer *timer);
 427
 428 /*
 429  * Helper function to check, whether the timer is on one of the queues
 430  */
 431 static inline int hrtimer_is_queued(struct hrtimer *timer)
 432 {
 433         return timer->state & HRTIMER_STATE_ENQUEUED;
 434 }
 435
 436 /*
 437  * Helper function to check, whether the timer is running the callback
 438  * function
 439  */
 440 static inline int hrtimer_callback_running(struct hrtimer *timer)
 441 {
 442         return timer->base->cpu_base->running == timer;
 443 }
 444
 445 /* Forward a hrtimer so it expires after now: */
 446 extern u64
 447 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
 448
 449 /**
 450  * hrtimer_forward_now - forward the timer expiry so it expires after now
 451  * @timer:      hrtimer to forward
 452  * @interval:   the interval to forward
 453  *
 454  * Forward the timer expiry so it will expire after the current time
 455  * of the hrtimer clock base. Returns the number of overruns.
 456  *
 457  * Can be safely called from the callback function of @timer. If
 458  * called from other contexts @timer must neither be enqueued nor
 459  * running the callback and the caller needs to take care of
 460  * serialization.
 461  *
 462  * Note: This only updates the timer expiry value and does not requeue
 463  * the timer.
 464  */
 465 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
 466                                       ktime_t interval)
 467 {
 468         return hrtimer_forward(timer, timer->base->get_time(), interval);
 469 }
 470
 471 /* Precise sleep: */
 472 extern long hrtimer_nanosleep(struct timespec *rqtp,
 473                               struct timespec __user *rmtp,
 474                               const enum hrtimer_mode mode,
 475                               const clockid_t clockid);
 476 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
 477
 478 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
 479                                  struct task_struct *tsk);
 480
 481 extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
 482                                                 const enum hrtimer_mode mode);
 483 extern int schedule_hrtimeout_range_clock(ktime_t *expires,
 484                 unsigned long delta, const enum hrtimer_mode mode, int clock);
 485 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
 486
 487 /* Soft interrupt function to run the hrtimer queues: */
 488 extern void hrtimer_run_queues(void);
 489
 490 /* Bootup initialization: */
 491 extern void __init hrtimers_init(void);
 492
 493 /* Show pending timers: */
 494 extern void sysrq_timer_list_show(void);
 495
 496 #endif