include/linux/hrtimer.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  hrtimers - High-resolution kernel timers
   4  *
   5  *   Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
   6  *   Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
   7  *
   8  *  data type definitions, declarations, prototypes
   9  *
  10  *  Started by: Thomas Gleixner and Ingo Molnar
  11  */
  12 #ifndef _LINUX_HRTIMER_H
  13 #define _LINUX_HRTIMER_H
  14
  15 #include <linux/hrtimer_defs.h>
  16 #include <linux/hrtimer_types.h>
  17 #include <linux/init.h>
  18 #include <linux/list.h>
  19 #include <linux/percpu-defs.h>
  20 #include <linux/rbtree.h>
  21 #include <linux/seqlock.h>
  22 #include <linux/timer.h>
  23
  24 struct hrtimer_clock_base;
  25 struct hrtimer_cpu_base;
  26
  27 /*
  28  * Mode arguments of xxx_hrtimer functions:
  29  *
  30  * HRTIMER_MODE_ABS             - Time value is absolute
  31  * HRTIMER_MODE_REL             - Time value is relative to now
  32  * HRTIMER_MODE_PINNED          - Timer is bound to CPU (is only considered
  33  *                                when starting the timer)
  34  * HRTIMER_MODE_SOFT            - Timer callback function will be executed in
  35  *                                soft irq context
  36  * HRTIMER_MODE_HARD            - Timer callback function will be executed in
  37  *                                hard irq context even on PREEMPT_RT.
  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         HRTIMER_MODE_HARD       = 0x08,
  45
  46         HRTIMER_MODE_ABS_PINNED = HRTIMER_MODE_ABS | HRTIMER_MODE_PINNED,
  47         HRTIMER_MODE_REL_PINNED = HRTIMER_MODE_REL | HRTIMER_MODE_PINNED,
  48
  49         HRTIMER_MODE_ABS_SOFT   = HRTIMER_MODE_ABS | HRTIMER_MODE_SOFT,
  50         HRTIMER_MODE_REL_SOFT   = HRTIMER_MODE_REL | HRTIMER_MODE_SOFT,
  51
  52         HRTIMER_MODE_ABS_PINNED_SOFT = HRTIMER_MODE_ABS_PINNED | HRTIMER_MODE_SOFT,
  53         HRTIMER_MODE_REL_PINNED_SOFT = HRTIMER_MODE_REL_PINNED | HRTIMER_MODE_SOFT,
  54
  55         HRTIMER_MODE_ABS_HARD   = HRTIMER_MODE_ABS | HRTIMER_MODE_HARD,
  56         HRTIMER_MODE_REL_HARD   = HRTIMER_MODE_REL | HRTIMER_MODE_HARD,
  57
  58         HRTIMER_MODE_ABS_PINNED_HARD = HRTIMER_MODE_ABS_PINNED | HRTIMER_MODE_HARD,
  59         HRTIMER_MODE_REL_PINNED_HARD = HRTIMER_MODE_REL_PINNED | HRTIMER_MODE_HARD,
  60 };
  61
  62 /*
  63  * Values to track state of the timer
  64  *
  65  * Possible states:
  66  *
  67  * 0x00         inactive
  68  * 0x01         enqueued into rbtree
  69  *
  70  * The callback state is not part of the timer->state because clearing it would
  71  * mean touching the timer after the callback, this makes it impossible to free
  72  * the timer from the callback function.
  73  *
  74  * Therefore we track the callback state in:
  75  *
  76  *      timer->base->cpu_base->running == timer
  77  *
  78  * On SMP it is possible to have a "callback function running and enqueued"
  79  * status. It happens for example when a posix timer expired and the callback
  80  * queued a signal. Between dropping the lock which protects the posix timer
  81  * and reacquiring the base lock of the hrtimer, another CPU can deliver the
  82  * signal and rearm the timer.
  83  *
  84  * All state transitions are protected by cpu_base->lock.
  85  */
  86 #define HRTIMER_STATE_INACTIVE  0x00
  87 #define HRTIMER_STATE_ENQUEUED  0x01
  88
  89 /**
  90  * struct hrtimer_sleeper - simple sleeper structure
  91  * @timer:      embedded timer structure
  92  * @task:       task to wake up
  93  *
  94  * task is set to NULL, when the timer expires.
  95  */
  96 struct hrtimer_sleeper {
  97         struct hrtimer timer;
  98         struct task_struct *task;
  99 };
 100
 101 #ifdef CONFIG_64BIT
 102 # define __hrtimer_clock_base_align     ____cacheline_aligned
 103 #else
 104 # define __hrtimer_clock_base_align
 105 #endif
 106
 107 /**
 108  * struct hrtimer_clock_base - the timer base for a specific clock
 109  * @cpu_base:           per cpu clock base
 110  * @index:              clock type index for per_cpu support when moving a
 111  *                      timer to a base on another cpu.
 112  * @clockid:            clock id for per_cpu support
 113  * @seq:                seqcount around __run_hrtimer
 114  * @running:            pointer to the currently running hrtimer
 115  * @active:             red black tree root node for the active timers
 116  * @get_time:           function to retrieve the current time of the clock
 117  * @offset:             offset of this clock to the monotonic base
 118  */
 119 struct hrtimer_clock_base {
 120         struct hrtimer_cpu_base *cpu_base;
 121         unsigned int            index;
 122         clockid_t               clockid;
 123         seqcount_raw_spinlock_t seq;
 124         struct hrtimer          *running;
 125         struct timerqueue_head  active;
 126         ktime_t                 (*get_time)(void);
 127         ktime_t                 offset;
 128 } __hrtimer_clock_base_align;
 129
 130 enum  hrtimer_base_type {
 131         HRTIMER_BASE_MONOTONIC,
 132         HRTIMER_BASE_REALTIME,
 133         HRTIMER_BASE_BOOTTIME,
 134         HRTIMER_BASE_TAI,
 135         HRTIMER_BASE_MONOTONIC_SOFT,
 136         HRTIMER_BASE_REALTIME_SOFT,
 137         HRTIMER_BASE_BOOTTIME_SOFT,
 138         HRTIMER_BASE_TAI_SOFT,
 139         HRTIMER_MAX_CLOCK_BASES,
 140 };
 141
 142 /**
 143  * struct hrtimer_cpu_base - the per cpu clock bases
 144  * @lock:               lock protecting the base and associated clock bases
 145  *                      and timers
 146  * @cpu:                cpu number
 147  * @active_bases:       Bitfield to mark bases with active timers
 148  * @clock_was_set_seq:  Sequence counter of clock was set events
 149  * @hres_active:        State of high resolution mode
 150  * @in_hrtirq:          hrtimer_interrupt() is currently executing
 151  * @hang_detected:      The last hrtimer interrupt detected a hang
 152  * @softirq_activated:  displays, if the softirq is raised - update of softirq
 153  *                      related settings is not required then.
 154  * @nr_events:          Total number of hrtimer interrupt events
 155  * @nr_retries:         Total number of hrtimer interrupt retries
 156  * @nr_hangs:           Total number of hrtimer interrupt hangs
 157  * @max_hang_time:      Maximum time spent in hrtimer_interrupt
 158  * @softirq_expiry_lock: Lock which is taken while softirq based hrtimer are
 159  *                       expired
 160  * @online:             CPU is online from an hrtimers point of view
 161  * @timer_waiters:      A hrtimer_cancel() invocation waits for the timer
 162  *                      callback to finish.
 163  * @expires_next:       absolute time of the next event, is required for remote
 164  *                      hrtimer enqueue; it is the total first expiry time (hard
 165  *                      and soft hrtimer are taken into account)
 166  * @next_timer:         Pointer to the first expiring timer
 167  * @softirq_expires_next: Time to check, if soft queues needs also to be expired
 168  * @softirq_next_timer: Pointer to the first expiring softirq based timer
 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         unsigned int                    cpu;
 178         unsigned int                    active_bases;
 179         unsigned int                    clock_was_set_seq;
 180         unsigned int                    hres_active             : 1,
 181                                         in_hrtirq               : 1,
 182                                         hang_detected           : 1,
 183                                         softirq_activated       : 1,
 184                                         online                  : 1;
 185 #ifdef CONFIG_HIGH_RES_TIMERS
 186         unsigned int                    nr_events;
 187         unsigned short                  nr_retries;
 188         unsigned short                  nr_hangs;
 189         unsigned int                    max_hang_time;
 190 #endif
 191 #ifdef CONFIG_PREEMPT_RT
 192         spinlock_t                      softirq_expiry_lock;
 193         atomic_t                        timer_waiters;
 194 #endif
 195         ktime_t                         expires_next;
 196         struct hrtimer                  *next_timer;
 197         ktime_t                         softirq_expires_next;
 198         struct hrtimer                  *softirq_next_timer;
 199         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 200 } ____cacheline_aligned;
 201
 202 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
 203 {
 204         timer->node.expires = time;
 205         timer->_softexpires = time;
 206 }
 207
 208 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
 209 {
 210         timer->_softexpires = time;
 211         timer->node.expires = ktime_add_safe(time, delta);
 212 }
 213
 214 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, u64 delta)
 215 {
 216         timer->_softexpires = time;
 217         timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta));
 218 }
 219
 220 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
 221 {
 222         timer->node.expires = tv64;
 223         timer->_softexpires = tv64;
 224 }
 225
 226 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
 227 {
 228         timer->node.expires = ktime_add_safe(timer->node.expires, time);
 229         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
 230 }
 231
 232 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
 233 {
 234         timer->node.expires = ktime_add_ns(timer->node.expires, ns);
 235         timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
 236 }
 237
 238 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
 239 {
 240         return timer->node.expires;
 241 }
 242
 243 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
 244 {
 245         return timer->_softexpires;
 246 }
 247
 248 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
 249 {
 250         return timer->node.expires;
 251 }
 252 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
 253 {
 254         return timer->_softexpires;
 255 }
 256
 257 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
 258 {
 259         return ktime_to_ns(timer->node.expires);
 260 }
 261
 262 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
 263 {
 264         return ktime_sub(timer->node.expires, timer->base->get_time());
 265 }
 266
 267 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 268 {
 269         return timer->base->get_time();
 270 }
 271
 272 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 273 {
 274         return IS_ENABLED(CONFIG_HIGH_RES_TIMERS) ?
 275                 timer->base->cpu_base->hres_active : 0;
 276 }
 277
 278 #ifdef CONFIG_HIGH_RES_TIMERS
 279 struct clock_event_device;
 280
 281 extern void hrtimer_interrupt(struct clock_event_device *dev);
 282
 283 extern unsigned int hrtimer_resolution;
 284
 285 #else
 286
 287 #define hrtimer_resolution      (unsigned int)LOW_RES_NSEC
 288
 289 #endif
 290
 291 static inline ktime_t
 292 __hrtimer_expires_remaining_adjusted(const struct hrtimer *timer, ktime_t now)
 293 {
 294         ktime_t rem = ktime_sub(timer->node.expires, now);
 295
 296         /*
 297          * Adjust relative timers for the extra we added in
 298          * hrtimer_start_range_ns() to prevent short timeouts.
 299          */
 300         if (IS_ENABLED(CONFIG_TIME_LOW_RES) && timer->is_rel)
 301                 rem -= hrtimer_resolution;
 302         return rem;
 303 }
 304
 305 static inline ktime_t
 306 hrtimer_expires_remaining_adjusted(const struct hrtimer *timer)
 307 {
 308         return __hrtimer_expires_remaining_adjusted(timer,
 309                                                     timer->base->get_time());
 310 }
 311
 312 #ifdef CONFIG_TIMERFD
 313 extern void timerfd_clock_was_set(void);
 314 extern void timerfd_resume(void);
 315 #else
 316 static inline void timerfd_clock_was_set(void) { }
 317 static inline void timerfd_resume(void) { }
 318 #endif
 319
 320 DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
 321
 322 #ifdef CONFIG_PREEMPT_RT
 323 void hrtimer_cancel_wait_running(const struct hrtimer *timer);
 324 #else
 325 static inline void hrtimer_cancel_wait_running(struct hrtimer *timer)
 326 {
 327         cpu_relax();
 328 }
 329 #endif
 330
 331 /* Exported timer functions: */
 332
 333 /* Initialize timers: */
 334 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
 335                          enum hrtimer_mode mode);
 336 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, clockid_t clock_id,
 337                                  enum hrtimer_mode mode);
 338
 339 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
 340 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
 341                                   enum hrtimer_mode mode);
 342 extern void hrtimer_init_sleeper_on_stack(struct hrtimer_sleeper *sl,
 343                                           clockid_t clock_id,
 344                                           enum hrtimer_mode mode);
 345
 346 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
 347 #else
 348 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
 349                                          clockid_t which_clock,
 350                                          enum hrtimer_mode mode)
 351 {
 352         hrtimer_init(timer, which_clock, mode);
 353 }
 354
 355 static inline void hrtimer_init_sleeper_on_stack(struct hrtimer_sleeper *sl,
 356                                                  clockid_t clock_id,
 357                                                  enum hrtimer_mode mode)
 358 {
 359         hrtimer_init_sleeper(sl, clock_id, mode);
 360 }
 361
 362 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
 363 #endif
 364
 365 /* Basic timer operations: */
 366 extern void hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
 367                                    u64 range_ns, const enum hrtimer_mode mode);
 368
 369 /**
 370  * hrtimer_start - (re)start an hrtimer
 371  * @timer:      the timer to be added
 372  * @tim:        expiry time
 373  * @mode:       timer mode: absolute (HRTIMER_MODE_ABS) or
 374  *              relative (HRTIMER_MODE_REL), and pinned (HRTIMER_MODE_PINNED);
 375  *              softirq based mode is considered for debug purpose only!
 376  */
 377 static inline void hrtimer_start(struct hrtimer *timer, ktime_t tim,
 378                                  const enum hrtimer_mode mode)
 379 {
 380         hrtimer_start_range_ns(timer, tim, 0, mode);
 381 }
 382
 383 extern int hrtimer_cancel(struct hrtimer *timer);
 384 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 385
 386 static inline void hrtimer_start_expires(struct hrtimer *timer,
 387                                          enum hrtimer_mode mode)
 388 {
 389         u64 delta;
 390         ktime_t soft, hard;
 391         soft = hrtimer_get_softexpires(timer);
 392         hard = hrtimer_get_expires(timer);
 393         delta = ktime_to_ns(ktime_sub(hard, soft));
 394         hrtimer_start_range_ns(timer, soft, delta, mode);
 395 }
 396
 397 void hrtimer_sleeper_start_expires(struct hrtimer_sleeper *sl,
 398                                    enum hrtimer_mode mode);
 399
 400 static inline void hrtimer_restart(struct hrtimer *timer)
 401 {
 402         hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
 403 }
 404
 405 /* Query timers: */
 406 extern ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust);
 407
 408 /**
 409  * hrtimer_get_remaining - get remaining time for the timer
 410  * @timer:      the timer to read
 411  */
 412 static inline ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
 413 {
 414         return __hrtimer_get_remaining(timer, false);
 415 }
 416
 417 extern u64 hrtimer_get_next_event(void);
 418 extern u64 hrtimer_next_event_without(const struct hrtimer *exclude);
 419
 420 extern bool hrtimer_active(const struct hrtimer *timer);
 421
 422 /**
 423  * hrtimer_is_queued - check, whether the timer is on one of the queues
 424  * @timer:      Timer to check
 425  *
 426  * Returns: True if the timer is queued, false otherwise
 427  *
 428  * The function can be used lockless, but it gives only a current snapshot.
 429  */
 430 static inline bool hrtimer_is_queued(struct hrtimer *timer)
 431 {
 432         /* The READ_ONCE pairs with the update functions of timer->state */
 433         return !!(READ_ONCE(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->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
 473 extern int nanosleep_copyout(struct restart_block *, struct timespec64 *);
 474 extern long hrtimer_nanosleep(ktime_t rqtp, const enum hrtimer_mode mode,
 475                               const clockid_t clockid);
 476
 477 extern int schedule_hrtimeout_range(ktime_t *expires, u64 delta,
 478                                     const enum hrtimer_mode mode);
 479 extern int schedule_hrtimeout_range_clock(ktime_t *expires,
 480                                           u64 delta,
 481                                           const enum hrtimer_mode mode,
 482                                           clockid_t clock_id);
 483 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
 484
 485 /* Soft interrupt function to run the hrtimer queues: */
 486 extern void hrtimer_run_queues(void);
 487
 488 /* Bootup initialization: */
 489 extern void __init hrtimers_init(void);
 490
 491 /* Show pending timers: */
 492 extern void sysrq_timer_list_show(void);
 493
 494 int hrtimers_prepare_cpu(unsigned int cpu);
 495 #ifdef CONFIG_HOTPLUG_CPU
 496 int hrtimers_cpu_dying(unsigned int cpu);
 497 #else
 498 #define hrtimers_cpu_dying      NULL
 499 #endif
 500
 501 #endif