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/percpu.h>
  23 #include <linux/timer.h>
  24 #include <linux/timerqueue.h>
  25
  26 struct hrtimer_clock_base;
  27 struct hrtimer_cpu_base;
  28
  29 /*
  30  * Mode arguments of xxx_hrtimer functions:
  31  *
  32  * HRTIMER_MODE_ABS             - Time value is absolute
  33  * HRTIMER_MODE_REL             - Time value is relative to now
  34  * HRTIMER_MODE_PINNED          - Timer is bound to CPU (is only considered
  35  *                                when starting the timer)
  36  * HRTIMER_MODE_SOFT            - Timer callback function will be executed in
  37  *                                soft irq context
  38  */
  39 enum hrtimer_mode {
  40         HRTIMER_MODE_ABS        = 0x00,
  41         HRTIMER_MODE_REL        = 0x01,
  42         HRTIMER_MODE_PINNED     = 0x02,
  43         HRTIMER_MODE_SOFT       = 0x04,
  44
  45         HRTIMER_MODE_ABS_PINNED = HRTIMER_MODE_ABS | HRTIMER_MODE_PINNED,
  46         HRTIMER_MODE_REL_PINNED = HRTIMER_MODE_REL | HRTIMER_MODE_PINNED,
  47
  48         HRTIMER_MODE_ABS_SOFT   = HRTIMER_MODE_ABS | HRTIMER_MODE_SOFT,
  49         HRTIMER_MODE_REL_SOFT   = HRTIMER_MODE_REL | HRTIMER_MODE_SOFT,
  50
  51         HRTIMER_MODE_ABS_PINNED_SOFT = HRTIMER_MODE_ABS_PINNED | HRTIMER_MODE_SOFT,
  52         HRTIMER_MODE_REL_PINNED_SOFT = HRTIMER_MODE_REL_PINNED | HRTIMER_MODE_SOFT,
  53
  54 };
  55
  56 /*
  57  * Return values for the callback function
  58  */
  59 enum hrtimer_restart {
  60         HRTIMER_NORESTART,      /* Timer is not restarted */
  61         HRTIMER_RESTART,        /* Timer must be restarted */
  62 };
  63
  64 /*
  65  * Values to track state of the timer
  66  *
  67  * Possible states:
  68  *
  69  * 0x00         inactive
  70  * 0x01         enqueued into rbtree
  71  *
  72  * The callback state is not part of the timer->state because clearing it would
  73  * mean touching the timer after the callback, this makes it impossible to free
  74  * the timer from the callback function.
  75  *
  76  * Therefore we track the callback state in:
  77  *
  78  *      timer->base->cpu_base->running == timer
  79  *
  80  * On SMP it is possible to have a "callback function running and enqueued"
  81  * status. It happens for example when a posix timer expired and the callback
  82  * queued a signal. Between dropping the lock which protects the posix timer
  83  * and reacquiring the base lock of the hrtimer, another CPU can deliver the
  84  * signal and rearm the timer.
  85  *
  86  * All state transitions are protected by cpu_base->lock.
  87  */
  88 #define HRTIMER_STATE_INACTIVE  0x00
  89 #define HRTIMER_STATE_ENQUEUED  0x01
  90
  91 /**
  92  * struct hrtimer - the basic hrtimer structure
  93  * @node:       timerqueue node, which also manages node.expires,
  94  *              the absolute expiry time in the hrtimers internal
  95  *              representation. The time is related to the clock on
  96  *              which the timer is based. Is setup by adding
  97  *              slack to the _softexpires value. For non range timers
  98  *              identical to _softexpires.
  99  * @_softexpires: the absolute earliest expiry time of the hrtimer.
 100  *              The time which was given as expiry time when the timer
 101  *              was armed.
 102  * @function:   timer expiry callback function
 103  * @base:       pointer to the timer base (per cpu and per clock)
 104  * @state:      state information (See bit values above)
 105  * @is_rel:     Set if the timer was armed relative
 106  * @is_soft:    Set if hrtimer will be expired in soft interrupt context.
 107  *
 108  * The hrtimer structure must be initialized by hrtimer_init()
 109  */
 110 struct hrtimer {
 111         struct timerqueue_node          node;
 112         ktime_t                         _softexpires;
 113         enum hrtimer_restart            (*function)(struct hrtimer *);
 114         struct hrtimer_clock_base       *base;
 115         u8                              state;
 116         u8                              is_rel;
 117         u8                              is_soft;
 118 };
 119
 120 /**
 121  * struct hrtimer_sleeper - simple sleeper structure
 122  * @timer:      embedded timer structure
 123  * @task:       task to wake up
 124  *
 125  * task is set to NULL, when the timer expires.
 126  */
 127 struct hrtimer_sleeper {
 128         struct hrtimer timer;
 129         struct task_struct *task;
 130 };
 131
 132 #ifdef CONFIG_64BIT
 133 # define __hrtimer_clock_base_align     ____cacheline_aligned
 134 #else
 135 # define __hrtimer_clock_base_align
 136 #endif
 137
 138 /**
 139  * struct hrtimer_clock_base - the timer base for a specific clock
 140  * @cpu_base:           per cpu clock base
 141  * @index:              clock type index for per_cpu support when moving a
 142  *                      timer to a base on another cpu.
 143  * @clockid:            clock id for per_cpu support
 144  * @seq:                seqcount around __run_hrtimer
 145  * @running:            pointer to the currently running hrtimer
 146  * @active:             red black tree root node for the active timers
 147  * @get_time:           function to retrieve the current time of the clock
 148  * @offset:             offset of this clock to the monotonic base
 149  */
 150 struct hrtimer_clock_base {
 151         struct hrtimer_cpu_base *cpu_base;
 152         unsigned int            index;
 153         clockid_t               clockid;
 154         seqcount_t              seq;
 155         struct hrtimer          *running;
 156         struct timerqueue_head  active;
 157         ktime_t                 (*get_time)(void);
 158         ktime_t                 offset;
 159 } __hrtimer_clock_base_align;
 160
 161 enum  hrtimer_base_type {
 162         HRTIMER_BASE_MONOTONIC,
 163         HRTIMER_BASE_REALTIME,
 164         HRTIMER_BASE_TAI,
 165         HRTIMER_BASE_MONOTONIC_SOFT,
 166         HRTIMER_BASE_REALTIME_SOFT,
 167         HRTIMER_BASE_TAI_SOFT,
 168         HRTIMER_MAX_CLOCK_BASES,
 169 };
 170
 171 /**
 172  * struct hrtimer_cpu_base - the per cpu clock bases
 173  * @lock:               lock protecting the base and associated clock bases
 174  *                      and timers
 175  * @cpu:                cpu number
 176  * @active_bases:       Bitfield to mark bases with active timers
 177  * @clock_was_set_seq:  Sequence counter of clock was set events
 178  * @hres_active:        State of high resolution mode
 179  * @in_hrtirq:          hrtimer_interrupt() is currently executing
 180  * @hang_detected:      The last hrtimer interrupt detected a hang
 181  * @softirq_activated:  displays, if the softirq is raised - update of softirq
 182  *                      related settings is not required then.
 183  * @nr_events:          Total number of hrtimer interrupt events
 184  * @nr_retries:         Total number of hrtimer interrupt retries
 185  * @nr_hangs:           Total number of hrtimer interrupt hangs
 186  * @max_hang_time:      Maximum time spent in hrtimer_interrupt
 187  * @expires_next:       absolute time of the next event, is required for remote
 188  *                      hrtimer enqueue; it is the total first expiry time (hard
 189  *                      and soft hrtimer are taken into account)
 190  * @next_timer:         Pointer to the first expiring timer
 191  * @softirq_expires_next: Time to check, if soft queues needs also to be expired
 192  * @softirq_next_timer: Pointer to the first expiring softirq based timer
 193  * @clock_base:         array of clock bases for this cpu
 194  *
 195  * Note: next_timer is just an optimization for __remove_hrtimer().
 196  *       Do not dereference the pointer because it is not reliable on
 197  *       cross cpu removals.
 198  */
 199 struct hrtimer_cpu_base {
 200         raw_spinlock_t                  lock;
 201         unsigned int                    cpu;
 202         unsigned int                    active_bases;
 203         unsigned int                    clock_was_set_seq;
 204         unsigned int                    hres_active             : 1,
 205                                         in_hrtirq               : 1,
 206                                         hang_detected           : 1,
 207                                         softirq_activated       : 1;
 208 #ifdef CONFIG_HIGH_RES_TIMERS
 209         unsigned int                    nr_events;
 210         unsigned short                  nr_retries;
 211         unsigned short                  nr_hangs;
 212         unsigned int                    max_hang_time;
 213 #endif
 214         ktime_t                         expires_next;
 215         struct hrtimer                  *next_timer;
 216         ktime_t                         softirq_expires_next;
 217         struct hrtimer                  *softirq_next_timer;
 218         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 219 } ____cacheline_aligned;
 220
 221 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
 222 {
 223         timer->node.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->node.expires = ktime_add_safe(time, delta);
 231 }
 232
 233 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, u64 delta)
 234 {
 235         timer->_softexpires = time;
 236         timer->node.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->node.expires = tv64;
 242         timer->_softexpires = tv64;
 243 }
 244
 245 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
 246 {
 247         timer->node.expires = ktime_add_safe(timer->node.expires, time);
 248         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
 249 }
 250
 251 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
 252 {
 253         timer->node.expires = ktime_add_ns(timer->node.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->node.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->node.expires;
 270 }
 271 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
 272 {
 273         return timer->_softexpires;
 274 }
 275
 276 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
 277 {
 278         return ktime_to_ns(timer->node.expires);
 279 }
 280
 281 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
 282 {
 283         return ktime_sub(timer->node.expires, timer->base->get_time());
 284 }
 285
 286 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 287 {
 288         return timer->base->get_time();
 289 }
 290
 291 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 292 {
 293         return IS_ENABLED(CONFIG_HIGH_RES_TIMERS) ?
 294                 timer->base->cpu_base->hres_active : 0;
 295 }
 296
 297 #ifdef CONFIG_HIGH_RES_TIMERS
 298 struct clock_event_device;
 299
 300 extern void hrtimer_interrupt(struct clock_event_device *dev);
 301
 302 /*
 303  * The resolution of the clocks. The resolution value is returned in
 304  * the clock_getres() system call to give application programmers an
 305  * idea of the (in)accuracy of timers. Timer values are rounded up to
 306  * this resolution values.
 307  */
 308 # define HIGH_RES_NSEC          1
 309 # define KTIME_HIGH_RES         (HIGH_RES_NSEC)
 310 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
 311 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
 312
 313 extern void clock_was_set_delayed(void);
 314
 315 extern unsigned int hrtimer_resolution;
 316
 317 #else
 318
 319 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 320 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 321
 322 #define hrtimer_resolution      (unsigned int)LOW_RES_NSEC
 323
 324 static inline void clock_was_set_delayed(void) { }
 325
 326 #endif
 327
 328 static inline ktime_t
 329 __hrtimer_expires_remaining_adjusted(const struct hrtimer *timer, ktime_t now)
 330 {
 331         ktime_t rem = ktime_sub(timer->node.expires, now);
 332
 333         /*
 334          * Adjust relative timers for the extra we added in
 335          * hrtimer_start_range_ns() to prevent short timeouts.
 336          */
 337         if (IS_ENABLED(CONFIG_TIME_LOW_RES) && timer->is_rel)
 338                 rem -= hrtimer_resolution;
 339         return rem;
 340 }
 341
 342 static inline ktime_t
 343 hrtimer_expires_remaining_adjusted(const struct hrtimer *timer)
 344 {
 345         return __hrtimer_expires_remaining_adjusted(timer,
 346                                                     timer->base->get_time());
 347 }
 348
 349 extern void clock_was_set(void);
 350 #ifdef CONFIG_TIMERFD
 351 extern void timerfd_clock_was_set(void);
 352 #else
 353 static inline void timerfd_clock_was_set(void) { }
 354 #endif
 355 extern void hrtimers_resume(void);
 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 void hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
 383                                    u64 range_ns, const enum hrtimer_mode mode);
 384
 385 /**
 386  * hrtimer_start - (re)start an hrtimer
 387  * @timer:      the timer to be added
 388  * @tim:        expiry time
 389  * @mode:       timer mode: absolute (HRTIMER_MODE_ABS) or
 390  *              relative (HRTIMER_MODE_REL), and pinned (HRTIMER_MODE_PINNED);
 391  *              softirq based mode is considered for debug purpose only!
 392  */
 393 static inline void hrtimer_start(struct hrtimer *timer, ktime_t tim,
 394                                  const enum hrtimer_mode mode)
 395 {
 396         hrtimer_start_range_ns(timer, tim, 0, mode);
 397 }
 398
 399 extern int hrtimer_cancel(struct hrtimer *timer);
 400 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 401
 402 static inline void hrtimer_start_expires(struct hrtimer *timer,
 403                                          enum hrtimer_mode mode)
 404 {
 405         u64 delta;
 406         ktime_t soft, hard;
 407         soft = hrtimer_get_softexpires(timer);
 408         hard = hrtimer_get_expires(timer);
 409         delta = ktime_to_ns(ktime_sub(hard, soft));
 410         hrtimer_start_range_ns(timer, soft, delta, mode);
 411 }
 412
 413 static inline void hrtimer_restart(struct hrtimer *timer)
 414 {
 415         hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
 416 }
 417
 418 /* Query timers: */
 419 extern ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust);
 420
 421 static inline ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
 422 {
 423         return __hrtimer_get_remaining(timer, false);
 424 }
 425
 426 extern u64 hrtimer_get_next_event(void);
 427 extern u64 hrtimer_next_event_without(const struct hrtimer *exclude);
 428
 429 extern bool hrtimer_active(const struct hrtimer *timer);
 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->base->running == timer;
 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 /**
 453  * hrtimer_forward_now - forward the timer expiry so it expires after now
 454  * @timer:      hrtimer to forward
 455  * @interval:   the interval to forward
 456  *
 457  * Forward the timer expiry so it will expire after the current time
 458  * of the hrtimer clock base. Returns the number of overruns.
 459  *
 460  * Can be safely called from the callback function of @timer. If
 461  * called from other contexts @timer must neither be enqueued nor
 462  * running the callback and the caller needs to take care of
 463  * serialization.
 464  *
 465  * Note: This only updates the timer expiry value and does not requeue
 466  * the timer.
 467  */
 468 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
 469                                       ktime_t interval)
 470 {
 471         return hrtimer_forward(timer, timer->base->get_time(), interval);
 472 }
 473
 474 /* Precise sleep: */
 475
 476 extern int nanosleep_copyout(struct restart_block *, struct timespec64 *);
 477 extern long hrtimer_nanosleep(const struct timespec64 *rqtp,
 478                               const enum hrtimer_mode mode,
 479                               const clockid_t clockid);
 480
 481 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
 482                                  struct task_struct *tsk);
 483
 484 extern int schedule_hrtimeout_range(ktime_t *expires, u64 delta,
 485                                                 const enum hrtimer_mode mode);
 486 extern int schedule_hrtimeout_range_clock(ktime_t *expires,
 487                                           u64 delta,
 488                                           const enum hrtimer_mode mode,
 489                                           clockid_t clock_id);
 490 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
 491
 492 /* Soft interrupt function to run the hrtimer queues: */
 493 extern void hrtimer_run_queues(void);
 494
 495 /* Bootup initialization: */
 496 extern void __init hrtimers_init(void);
 497
 498 /* Show pending timers: */
 499 extern void sysrq_timer_list_show(void);
 500
 501 int hrtimers_prepare_cpu(unsigned int cpu);
 502 #ifdef CONFIG_HOTPLUG_CPU
 503 int hrtimers_dead_cpu(unsigned int cpu);
 504 #else
 505 #define hrtimers_dead_cpu       NULL
 506 #endif
 507
 508 #endif