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  *
  92  * The hrtimer structure must be initialized by hrtimer_init()
  93  */
  94 struct hrtimer {
  95         struct timerqueue_node          node;
  96         ktime_t                         _softexpires;
  97         enum hrtimer_restart            (*function)(struct hrtimer *);
  98         struct hrtimer_clock_base       *base;
  99         u8                              state;
 100         u8                              is_rel;
 101 };
 102
 103 /**
 104  * struct hrtimer_sleeper - simple sleeper structure
 105  * @timer:      embedded timer structure
 106  * @task:       task to wake up
 107  *
 108  * task is set to NULL, when the timer expires.
 109  */
 110 struct hrtimer_sleeper {
 111         struct hrtimer timer;
 112         struct task_struct *task;
 113 };
 114
 115 #ifdef CONFIG_64BIT
 116 # define HRTIMER_CLOCK_BASE_ALIGN       64
 117 #else
 118 # define HRTIMER_CLOCK_BASE_ALIGN       32
 119 #endif
 120
 121 /**
 122  * struct hrtimer_clock_base - the timer base for a specific clock
 123  * @cpu_base:           per cpu clock base
 124  * @index:              clock type index for per_cpu support when moving a
 125  *                      timer to a base on another cpu.
 126  * @clockid:            clock id for per_cpu support
 127  * @active:             red black tree root node for the active timers
 128  * @get_time:           function to retrieve the current time of the clock
 129  * @offset:             offset of this clock to the monotonic base
 130  */
 131 struct hrtimer_clock_base {
 132         struct hrtimer_cpu_base *cpu_base;
 133         int                     index;
 134         clockid_t               clockid;
 135         struct timerqueue_head  active;
 136         ktime_t                 (*get_time)(void);
 137         ktime_t                 offset;
 138 } __attribute__((__aligned__(HRTIMER_CLOCK_BASE_ALIGN)));
 139
 140 enum  hrtimer_base_type {
 141         HRTIMER_BASE_MONOTONIC,
 142         HRTIMER_BASE_REALTIME,
 143         HRTIMER_BASE_BOOTTIME,
 144         HRTIMER_BASE_TAI,
 145         HRTIMER_MAX_CLOCK_BASES,
 146 };
 147
 148 /*
 149  * struct hrtimer_cpu_base - the per cpu clock bases
 150  * @lock:               lock protecting the base and associated clock bases
 151  *                      and timers
 152  * @seq:                seqcount around __run_hrtimer
 153  * @running:            pointer to the currently running hrtimer
 154  * @cpu:                cpu number
 155  * @active_bases:       Bitfield to mark bases with active timers
 156  * @clock_was_set_seq:  Sequence counter of clock was set events
 157  * @migration_enabled:  The migration of hrtimers to other cpus is enabled
 158  * @nohz_active:        The nohz functionality is enabled
 159  * @expires_next:       absolute time of the next event which was scheduled
 160  *                      via clock_set_next_event()
 161  * @next_timer:         Pointer to the first expiring timer
 162  * @in_hrtirq:          hrtimer_interrupt() is currently executing
 163  * @hres_active:        State of high resolution mode
 164  * @hang_detected:      The last hrtimer interrupt detected a hang
 165  * @nr_events:          Total number of hrtimer interrupt events
 166  * @nr_retries:         Total number of hrtimer interrupt retries
 167  * @nr_hangs:           Total number of hrtimer interrupt hangs
 168  * @max_hang_time:      Maximum time spent in hrtimer_interrupt
 169  * @clock_base:         array of clock bases for this cpu
 170  *
 171  * Note: next_timer is just an optimization for __remove_hrtimer().
 172  *       Do not dereference the pointer because it is not reliable on
 173  *       cross cpu removals.
 174  */
 175 struct hrtimer_cpu_base {
 176         raw_spinlock_t                  lock;
 177         seqcount_t                      seq;
 178         struct hrtimer                  *running;
 179         unsigned int                    cpu;
 180         unsigned int                    active_bases;
 181         unsigned int                    clock_was_set_seq;
 182         bool                            migration_enabled;
 183         bool                            nohz_active;
 184 #ifdef CONFIG_HIGH_RES_TIMERS
 185         unsigned int                    in_hrtirq       : 1,
 186                                         hres_active     : 1,
 187                                         hang_detected   : 1;
 188         ktime_t                         expires_next;
 189         struct hrtimer                  *next_timer;
 190         unsigned int                    nr_events;
 191         unsigned int                    nr_retries;
 192         unsigned int                    nr_hangs;
 193         unsigned int                    max_hang_time;
 194 #endif
 195         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 196 } ____cacheline_aligned;
 197
 198 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
 199 {
 200         BUILD_BUG_ON(sizeof(struct hrtimer_clock_base) > HRTIMER_CLOCK_BASE_ALIGN);
 201
 202         timer->node.expires = time;
 203         timer->_softexpires = time;
 204 }
 205
 206 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
 207 {
 208         timer->_softexpires = time;
 209         timer->node.expires = ktime_add_safe(time, delta);
 210 }
 211
 212 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, u64 delta)
 213 {
 214         timer->_softexpires = time;
 215         timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta));
 216 }
 217
 218 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
 219 {
 220         timer->node.expires = tv64;
 221         timer->_softexpires = tv64;
 222 }
 223
 224 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
 225 {
 226         timer->node.expires = ktime_add_safe(timer->node.expires, time);
 227         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
 228 }
 229
 230 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
 231 {
 232         timer->node.expires = ktime_add_ns(timer->node.expires, ns);
 233         timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
 234 }
 235
 236 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
 237 {
 238         return timer->node.expires;
 239 }
 240
 241 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
 242 {
 243         return timer->_softexpires;
 244 }
 245
 246 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
 247 {
 248         return timer->node.expires;
 249 }
 250 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
 251 {
 252         return timer->_softexpires;
 253 }
 254
 255 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
 256 {
 257         return ktime_to_ns(timer->node.expires);
 258 }
 259
 260 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
 261 {
 262         return ktime_sub(timer->node.expires, timer->base->get_time());
 263 }
 264
 265 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 266 {
 267         return timer->base->get_time();
 268 }
 269
 270 #ifdef CONFIG_HIGH_RES_TIMERS
 271 struct clock_event_device;
 272
 273 extern void hrtimer_interrupt(struct clock_event_device *dev);
 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         (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 extern unsigned int hrtimer_resolution;
 296
 297 #else
 298
 299 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 300 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 301
 302 #define hrtimer_resolution      (unsigned int)LOW_RES_NSEC
 303
 304 static inline void hrtimer_peek_ahead_timers(void) { }
 305
 306 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 307 {
 308         return 0;
 309 }
 310
 311 static inline void clock_was_set_delayed(void) { }
 312
 313 #endif
 314
 315 static inline ktime_t
 316 __hrtimer_expires_remaining_adjusted(const struct hrtimer *timer, ktime_t now)
 317 {
 318         ktime_t rem = ktime_sub(timer->node.expires, now);
 319
 320         /*
 321          * Adjust relative timers for the extra we added in
 322          * hrtimer_start_range_ns() to prevent short timeouts.
 323          */
 324         if (IS_ENABLED(CONFIG_TIME_LOW_RES) && timer->is_rel)
 325                 rem -= hrtimer_resolution;
 326         return rem;
 327 }
 328
 329 static inline ktime_t
 330 hrtimer_expires_remaining_adjusted(const struct hrtimer *timer)
 331 {
 332         return __hrtimer_expires_remaining_adjusted(timer,
 333                                                     timer->base->get_time());
 334 }
 335
 336 extern void clock_was_set(void);
 337 #ifdef CONFIG_TIMERFD
 338 extern void timerfd_clock_was_set(void);
 339 #else
 340 static inline void timerfd_clock_was_set(void) { }
 341 #endif
 342 extern void hrtimers_resume(void);
 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 void hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
 370                                    u64 range_ns, const enum hrtimer_mode mode);
 371
 372 /**
 373  * hrtimer_start - (re)start an hrtimer on the current CPU
 374  * @timer:      the timer to be added
 375  * @tim:        expiry time
 376  * @mode:       expiry mode: absolute (HRTIMER_MODE_ABS) or
 377  *              relative (HRTIMER_MODE_REL)
 378  */
 379 static inline void hrtimer_start(struct hrtimer *timer, ktime_t tim,
 380                                  const enum hrtimer_mode mode)
 381 {
 382         hrtimer_start_range_ns(timer, tim, 0, mode);
 383 }
 384
 385 extern int hrtimer_cancel(struct hrtimer *timer);
 386 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 387
 388 static inline void hrtimer_start_expires(struct hrtimer *timer,
 389                                          enum hrtimer_mode mode)
 390 {
 391         u64 delta;
 392         ktime_t soft, hard;
 393         soft = hrtimer_get_softexpires(timer);
 394         hard = hrtimer_get_expires(timer);
 395         delta = ktime_to_ns(ktime_sub(hard, soft));
 396         hrtimer_start_range_ns(timer, soft, delta, mode);
 397 }
 398
 399 static inline void hrtimer_restart(struct hrtimer *timer)
 400 {
 401         hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
 402 }
 403
 404 /* Query timers: */
 405 extern ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust);
 406
 407 static inline ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
 408 {
 409         return __hrtimer_get_remaining(timer, false);
 410 }
 411
 412 extern u64 hrtimer_get_next_event(void);
 413
 414 extern bool hrtimer_active(const struct hrtimer *timer);
 415
 416 /*
 417  * Helper function to check, whether the timer is on one of the queues
 418  */
 419 static inline int hrtimer_is_queued(struct hrtimer *timer)
 420 {
 421         return timer->state & HRTIMER_STATE_ENQUEUED;
 422 }
 423
 424 /*
 425  * Helper function to check, whether the timer is running the callback
 426  * function
 427  */
 428 static inline int hrtimer_callback_running(struct hrtimer *timer)
 429 {
 430         return timer->base->cpu_base->running == timer;
 431 }
 432
 433 /* Forward a hrtimer so it expires after now: */
 434 extern u64
 435 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
 436
 437 /**
 438  * hrtimer_forward_now - forward the timer expiry so it expires after now
 439  * @timer:      hrtimer to forward
 440  * @interval:   the interval to forward
 441  *
 442  * Forward the timer expiry so it will expire after the current time
 443  * of the hrtimer clock base. Returns the number of overruns.
 444  *
 445  * Can be safely called from the callback function of @timer. If
 446  * called from other contexts @timer must neither be enqueued nor
 447  * running the callback and the caller needs to take care of
 448  * serialization.
 449  *
 450  * Note: This only updates the timer expiry value and does not requeue
 451  * the timer.
 452  */
 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, u64 delta,
 470                                                 const enum hrtimer_mode mode);
 471 extern int schedule_hrtimeout_range_clock(ktime_t *expires,
 472                                           u64 delta,
 473                                           const enum hrtimer_mode mode,
 474                                           int clock);
 475 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
 476
 477 /* Soft interrupt function to run the hrtimer queues: */
 478 extern void hrtimer_run_queues(void);
 479
 480 /* Bootup initialization: */
 481 extern void __init hrtimers_init(void);
 482
 483 /* Show pending timers: */
 484 extern void sysrq_timer_list_show(void);
 485
 486 int hrtimers_prepare_cpu(unsigned int cpu);
 487 #ifdef CONFIG_HOTPLUG_CPU
 488 int hrtimers_dead_cpu(unsigned int cpu);
 489 #else
 490 #define hrtimers_dead_cpu       NULL
 491 #endif
 492
 493 #endif