kernel/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  * @start_pid: timer statistics field to store the pid of the task which
 100  *              started the timer
 101  * @start_site: timer statistics field to store the site where the timer
 102  *              was started
 103  * @start_comm: timer statistics field to store the name of the process which
 104  *              started the timer
 105  *
 106  * The hrtimer structure must be initialized by hrtimer_init()
 107  */
 108 struct hrtimer {
 109         struct timerqueue_node          node;
 110         ktime_t                         _softexpires;
 111         enum hrtimer_restart            (*function)(struct hrtimer *);
 112         struct hrtimer_clock_base       *base;
 113         unsigned long                   state;
 114         struct list_head                cb_entry;
 115         int                             irqsafe;
 116 #ifdef CONFIG_MISSED_TIMER_OFFSETS_HIST
 117         ktime_t                         praecox;
 118 #endif
 119 #ifdef CONFIG_TIMER_STATS
 120         int                             start_pid;
 121         void                            *start_site;
 122         char                            start_comm[16];
 123 #endif
 124 };
 125
 126 /**
 127  * struct hrtimer_sleeper - simple sleeper structure
 128  * @timer:      embedded timer structure
 129  * @task:       task to wake up
 130  *
 131  * task is set to NULL, when the timer expires.
 132  */
 133 struct hrtimer_sleeper {
 134         struct hrtimer timer;
 135         struct task_struct *task;
 136 };
 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  * @active:             red black tree root node for the active timers
 145  * @resolution:         the resolution of the clock, in nanoseconds
 146  * @get_time:           function to retrieve the current time of the clock
 147  * @softirq_time:       the time when running the hrtimer queue in the softirq
 148  * @offset:             offset of this clock to the monotonic base
 149  */
 150 struct hrtimer_clock_base {
 151         struct hrtimer_cpu_base *cpu_base;
 152         int                     index;
 153         clockid_t               clockid;
 154         struct timerqueue_head  active;
 155         struct list_head        expired;
 156         ktime_t                 resolution;
 157         ktime_t                 (*get_time)(void);
 158         ktime_t                 softirq_time;
 159         ktime_t                 offset;
 160 };
 161
 162 enum  hrtimer_base_type {
 163         HRTIMER_BASE_MONOTONIC,
 164         HRTIMER_BASE_REALTIME,
 165         HRTIMER_BASE_BOOTTIME,
 166         HRTIMER_BASE_TAI,
 167         HRTIMER_MAX_CLOCK_BASES,
 168 };
 169
 170 /*
 171  * struct hrtimer_cpu_base - the per cpu clock bases
 172  * @lock:               lock protecting the base and associated clock bases
 173  *                      and timers
 174  * @cpu:                cpu number
 175  * @active_bases:       Bitfield to mark bases with active timers
 176  * @clock_was_set:      Indicates that clock was set from irq context.
 177  * @expires_next:       absolute time of the next event which was scheduled
 178  *                      via clock_set_next_event()
 179  * @in_hrtirq:          hrtimer_interrupt() is currently executing
 180  * @hres_active:        State of high resolution mode
 181  * @hang_detected:      The last hrtimer interrupt detected a hang
 182  * @nr_events:          Total number of hrtimer interrupt events
 183  * @nr_retries:         Total number of hrtimer interrupt retries
 184  * @nr_hangs:           Total number of hrtimer interrupt hangs
 185  * @max_hang_time:      Maximum time spent in hrtimer_interrupt
 186  * @clock_base:         array of clock bases for this cpu
 187  */
 188 struct hrtimer_cpu_base {
 189         raw_spinlock_t                  lock;
 190         unsigned int                    cpu;
 191         unsigned int                    active_bases;
 192         unsigned int                    clock_was_set;
 193 #ifdef CONFIG_HIGH_RES_TIMERS
 194         ktime_t                         expires_next;
 195         int                             in_hrtirq;
 196         int                             hres_active;
 197         int                             hang_detected;
 198         unsigned long                   nr_events;
 199         unsigned long                   nr_retries;
 200         unsigned long                   nr_hangs;
 201         ktime_t                         max_hang_time;
 202 #endif
 203 #ifdef CONFIG_PREEMPT_RT_BASE
 204         wait_queue_head_t               wait;
 205 #endif
 206         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 207 };
 208
 209 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
 210 {
 211         timer->node.expires = time;
 212         timer->_softexpires = time;
 213 }
 214
 215 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
 216 {
 217         timer->_softexpires = time;
 218         timer->node.expires = ktime_add_safe(time, delta);
 219 }
 220
 221 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
 222 {
 223         timer->_softexpires = time;
 224         timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta));
 225 }
 226
 227 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
 228 {
 229         timer->node.expires.tv64 = tv64;
 230         timer->_softexpires.tv64 = tv64;
 231 }
 232
 233 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
 234 {
 235         timer->node.expires = ktime_add_safe(timer->node.expires, time);
 236         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
 237 }
 238
 239 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
 240 {
 241         timer->node.expires = ktime_add_ns(timer->node.expires, ns);
 242         timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
 243 }
 244
 245 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
 246 {
 247         return timer->node.expires;
 248 }
 249
 250 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
 251 {
 252         return timer->_softexpires;
 253 }
 254
 255 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
 256 {
 257         return timer->node.expires.tv64;
 258 }
 259 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
 260 {
 261         return timer->_softexpires.tv64;
 262 }
 263
 264 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
 265 {
 266         return ktime_to_ns(timer->node.expires);
 267 }
 268
 269 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
 270 {
 271         return ktime_sub(timer->node.expires, timer->base->get_time());
 272 }
 273
 274 #ifdef CONFIG_HIGH_RES_TIMERS
 275 struct clock_event_device;
 276
 277 extern void hrtimer_interrupt(struct clock_event_device *dev);
 278
 279 /*
 280  * In high resolution mode the time reference must be read accurate
 281  */
 282 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 283 {
 284         return timer->base->get_time();
 285 }
 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 #else
 308
 309 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 310 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 311
 312 static inline void hrtimer_peek_ahead_timers(void) { }
 313
 314 /*
 315  * In non high resolution mode the time reference is taken from
 316  * the base softirq time variable.
 317  */
 318 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 319 {
 320         return timer->base->softirq_time;
 321 }
 322
 323 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 324 {
 325         return 0;
 326 }
 327
 328 static inline void clock_was_set_delayed(void) { }
 329
 330 #endif
 331
 332 extern void clock_was_set(void);
 333 #ifdef CONFIG_TIMERFD
 334 extern void timerfd_clock_was_set(void);
 335 #else
 336 static inline void timerfd_clock_was_set(void) { }
 337 #endif
 338 extern void hrtimers_resume(void);
 339
 340 DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
 341
 342
 343 /* Exported timer functions: */
 344
 345 /* Initialize timers: */
 346 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
 347                          enum hrtimer_mode mode);
 348
 349 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
 350 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
 351                                   enum hrtimer_mode mode);
 352
 353 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
 354 #else
 355 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
 356                                          clockid_t which_clock,
 357                                          enum hrtimer_mode mode)
 358 {
 359         hrtimer_init(timer, which_clock, mode);
 360 }
 361 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
 362 #endif
 363
 364 /* Basic timer operations: */
 365 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
 366                          const enum hrtimer_mode mode);
 367 extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
 368                         unsigned long range_ns, const enum hrtimer_mode mode);
 369 extern int
 370 __hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
 371                          unsigned long delta_ns,
 372                          const enum hrtimer_mode mode, int wakeup);
 373
 374 extern int hrtimer_cancel(struct hrtimer *timer);
 375 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 376
 377 static inline int hrtimer_start_expires(struct hrtimer *timer,
 378                                                 enum hrtimer_mode mode)
 379 {
 380         unsigned long delta;
 381         ktime_t soft, hard;
 382         soft = hrtimer_get_softexpires(timer);
 383         hard = hrtimer_get_expires(timer);
 384         delta = ktime_to_ns(ktime_sub(hard, soft));
 385         return hrtimer_start_range_ns(timer, soft, delta, mode);
 386 }
 387
 388 static inline int hrtimer_restart(struct hrtimer *timer)
 389 {
 390         return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
 391 }
 392
 393 /* Softirq preemption could deadlock timer removal */
 394 #ifdef CONFIG_PREEMPT_RT_BASE
 395   extern void hrtimer_wait_for_timer(const struct hrtimer *timer);
 396 #else
 397 # define hrtimer_wait_for_timer(timer)  do { cpu_relax(); } while (0)
 398 #endif
 399
 400 /* Query timers: */
 401 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
 402 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
 403
 404 extern ktime_t hrtimer_get_next_event(void);
 405
 406 /*
 407  * A timer is active, when it is enqueued into the rbtree or the
 408  * callback function is running or it's in the state of being migrated
 409  * to another cpu.
 410  */
 411 static inline int hrtimer_active(const struct hrtimer *timer)
 412 {
 413         return timer->state != HRTIMER_STATE_INACTIVE;
 414 }
 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->state & HRTIMER_STATE_CALLBACK;
 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 /* Forward a hrtimer so it expires after the hrtimer's current now */
 438 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
 439                                       ktime_t interval)
 440 {
 441         return hrtimer_forward(timer, timer->base->get_time(), interval);
 442 }
 443
 444 /* Precise sleep: */
 445 extern long hrtimer_nanosleep(struct timespec *rqtp,
 446                               struct timespec __user *rmtp,
 447                               const enum hrtimer_mode mode,
 448                               const clockid_t clockid);
 449 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
 450
 451 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
 452                                  struct task_struct *tsk);
 453
 454 extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
 455                                                 const enum hrtimer_mode mode);
 456 extern int schedule_hrtimeout_range_clock(ktime_t *expires,
 457                 unsigned long delta, const enum hrtimer_mode mode, int clock);
 458 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
 459
 460 /* Soft interrupt function to run the hrtimer queues: */
 461 extern void hrtimer_run_queues(void);
 462 extern void hrtimer_run_pending(void);
 463
 464 /* Bootup initialization: */
 465 extern void __init hrtimers_init(void);
 466
 467 /* Show pending timers: */
 468 extern void sysrq_timer_list_show(void);
 469
 470 #endif