SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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
  25
  26 struct hrtimer_clock_base;
  27 struct hrtimer_cpu_base;
  28
  29 /*
  30  * Mode arguments of xxx_hrtimer functions:
  31  */
  32 enum hrtimer_mode {
  33         HRTIMER_MODE_ABS,       /* Time value is absolute */
  34         HRTIMER_MODE_REL,       /* Time value is relative to now */
  35 };
  36
  37 /*
  38  * Return values for the callback function
  39  */
  40 enum hrtimer_restart {
  41         HRTIMER_NORESTART,      /* Timer is not restarted */
  42         HRTIMER_RESTART,        /* Timer must be restarted */
  43 };
  44
  45 /*
  46  * hrtimer callback modes:
  47  *
  48  *      HRTIMER_CB_SOFTIRQ:             Callback must run in softirq context
  49  *      HRTIMER_CB_IRQSAFE:             Callback may run in hardirq context
  50  *      HRTIMER_CB_IRQSAFE_NO_RESTART:  Callback may run in hardirq context and
  51  *                                      does not restart the timer
  52  *      HRTIMER_CB_IRQSAFE_PERCPU:      Callback must run in hardirq context
  53  *                                      Special mode for tick emulation and
  54  *                                      scheduler timer. Such timers are per
  55  *                                      cpu and not allowed to be migrated on
  56  *                                      cpu unplug.
  57  *      HRTIMER_CB_IRQSAFE_UNLOCKED:    Callback should run in hardirq context
  58  *                                      with timer->base lock unlocked
  59  *                                      used for timers which call wakeup to
  60  *                                      avoid lock order problems with rq->lock
  61  */
  62 enum hrtimer_cb_mode {
  63         HRTIMER_CB_SOFTIRQ,
  64         HRTIMER_CB_IRQSAFE,
  65         HRTIMER_CB_IRQSAFE_NO_RESTART,
  66         HRTIMER_CB_IRQSAFE_PERCPU,
  67         HRTIMER_CB_IRQSAFE_UNLOCKED,
  68 };
  69
  70 /*
  71  * Values to track state of the timer
  72  *
  73  * Possible states:
  74  *
  75  * 0x00         inactive
  76  * 0x01         enqueued into rbtree
  77  * 0x02         callback function running
  78  * 0x04         callback pending (high resolution mode)
  79  *
  80  * Special cases:
  81  * 0x03         callback function running and enqueued
  82  *              (was requeued on another CPU)
  83  * 0x09         timer was migrated on CPU hotunplug
  84  * The "callback function running and enqueued" status is only possible on
  85  * SMP. It happens for example when a posix timer expired and the callback
  86  * queued a signal. Between dropping the lock which protects the posix timer
  87  * and reacquiring the base lock of the hrtimer, another CPU can deliver the
  88  * signal and rearm the timer. We have to preserve the callback running state,
  89  * as otherwise the timer could be removed before the softirq code finishes the
  90  * the handling of the timer.
  91  *
  92  * The HRTIMER_STATE_ENQUEUED bit is always or'ed to the current state to
  93  * preserve the HRTIMER_STATE_CALLBACK bit in the above scenario.
  94  *
  95  * All state transitions are protected by cpu_base->lock.
  96  */
  97 #define HRTIMER_STATE_INACTIVE  0x00
  98 #define HRTIMER_STATE_ENQUEUED  0x01
  99 #define HRTIMER_STATE_CALLBACK  0x02
 100 #define HRTIMER_STATE_PENDING   0x04
 101 #define HRTIMER_STATE_MIGRATE   0x08
 102
 103 /**
 104  * struct hrtimer - the basic hrtimer structure
 105  * @node:       red black tree node for time ordered insertion
 106  * @_expires:   the absolute expiry time in the hrtimers internal
 107  *              representation. The time is related to the clock on
 108  *              which the timer is based. Is setup by adding
 109  *              slack to the _softexpires value. For non range timers
 110  *              identical to _softexpires.
 111  * @_softexpires: the absolute earliest expiry time of the hrtimer.
 112  *              The time which was given as expiry time when the timer
 113  *              was armed.
 114  * @function:   timer expiry callback function
 115  * @base:       pointer to the timer base (per cpu and per clock)
 116  * @state:      state information (See bit values above)
 117  * @cb_mode:    high resolution timer feature to select the callback execution
 118  *               mode
 119  * @cb_entry:   list head to enqueue an expired timer into the callback list
 120  * @start_site: timer statistics field to store the site where the timer
 121  *              was started
 122  * @start_comm: timer statistics field to store the name of the process which
 123  *              started the timer
 124  * @start_pid: timer statistics field to store the pid of the task which
 125  *              started the timer
 126  *
 127  * The hrtimer structure must be initialized by hrtimer_init()
 128  */
 129 struct hrtimer {
 130         struct rb_node                  node;
 131         ktime_t                         _expires;
 132         ktime_t                         _softexpires;
 133         enum hrtimer_restart            (*function)(struct hrtimer *);
 134         struct hrtimer_clock_base       *base;
 135         unsigned long                   state;
 136         enum hrtimer_cb_mode            cb_mode;
 137         struct list_head                cb_entry;
 138 #ifdef CONFIG_TIMER_STATS
 139         void                            *start_site;
 140         char                            start_comm[16];
 141         int                             start_pid;
 142 #endif
 143 };
 144
 145 /**
 146  * struct hrtimer_sleeper - simple sleeper structure
 147  * @timer:      embedded timer structure
 148  * @task:       task to wake up
 149  *
 150  * task is set to NULL, when the timer expires.
 151  */
 152 struct hrtimer_sleeper {
 153         struct hrtimer timer;
 154         struct task_struct *task;
 155 };
 156
 157 /**
 158  * struct hrtimer_clock_base - the timer base for a specific clock
 159  * @cpu_base:           per cpu clock base
 160  * @index:              clock type index for per_cpu support when moving a
 161  *                      timer to a base on another cpu.
 162  * @active:             red black tree root node for the active timers
 163  * @first:              pointer to the timer node which expires first
 164  * @resolution:         the resolution of the clock, in nanoseconds
 165  * @get_time:           function to retrieve the current time of the clock
 166  * @get_softirq_time:   function to retrieve the current time from the softirq
 167  * @softirq_time:       the time when running the hrtimer queue in the softirq
 168  * @offset:             offset of this clock to the monotonic base
 169  * @reprogram:          function to reprogram the timer event
 170  */
 171 struct hrtimer_clock_base {
 172         struct hrtimer_cpu_base *cpu_base;
 173         clockid_t               index;
 174         struct rb_root          active;
 175         struct rb_node          *first;
 176         ktime_t                 resolution;
 177         ktime_t                 (*get_time)(void);
 178         ktime_t                 (*get_softirq_time)(void);
 179         ktime_t                 softirq_time;
 180 #ifdef CONFIG_HIGH_RES_TIMERS
 181         ktime_t                 offset;
 182         int                     (*reprogram)(struct hrtimer *t,
 183                                              struct hrtimer_clock_base *b,
 184                                              ktime_t n);
 185 #endif
 186 };
 187
 188 #define HRTIMER_MAX_CLOCK_BASES 2
 189
 190 /*
 191  * struct hrtimer_cpu_base - the per cpu clock bases
 192  * @lock:               lock protecting the base and associated clock bases
 193  *                      and timers
 194  * @clock_base:         array of clock bases for this cpu
 195  * @curr_timer:         the timer which is executing a callback right now
 196  * @expires_next:       absolute time of the next event which was scheduled
 197  *                      via clock_set_next_event()
 198  * @hres_active:        State of high resolution mode
 199  * @check_clocks:       Indictator, when set evaluate time source and clock
 200  *                      event devices whether high resolution mode can be
 201  *                      activated.
 202  * @cb_pending:         Expired timers are moved from the rbtree to this
 203  *                      list in the timer interrupt. The list is processed
 204  *                      in the softirq.
 205  * @nr_events:          Total number of timer interrupt events
 206  */
 207 struct hrtimer_cpu_base {
 208         spinlock_t                      lock;
 209         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
 210         struct list_head                cb_pending;
 211 #ifdef CONFIG_HIGH_RES_TIMERS
 212         ktime_t                         expires_next;
 213         int                             hres_active;
 214         unsigned long                   nr_events;
 215 #endif
 216 };
 217
 218 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
 219 {
 220         timer->_expires = time;
 221         timer->_softexpires = time;
 222 }
 223
 224 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
 225 {
 226         timer->_softexpires = time;
 227         timer->_expires = ktime_add_safe(time, delta);
 228 }
 229
 230 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
 231 {
 232         timer->_softexpires = time;
 233         timer->_expires = ktime_add_safe(time, ns_to_ktime(delta));
 234 }
 235
 236 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
 237 {
 238         timer->_expires.tv64 = tv64;
 239         timer->_softexpires.tv64 = tv64;
 240 }
 241
 242 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
 243 {
 244         timer->_expires = ktime_add_safe(timer->_expires, time);
 245         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
 246 }
 247
 248 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, unsigned long ns)
 249 {
 250         timer->_expires = ktime_add_ns(timer->_expires, ns);
 251         timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
 252 }
 253
 254 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
 255 {
 256         return timer->_expires;
 257 }
 258
 259 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
 260 {
 261         return timer->_softexpires;
 262 }
 263
 264 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
 265 {
 266         return timer->_expires.tv64;
 267 }
 268 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
 269 {
 270         return timer->_softexpires.tv64;
 271 }
 272
 273 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
 274 {
 275         return ktime_to_ns(timer->_expires);
 276 }
 277
 278 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
 279 {
 280     return ktime_sub(timer->_expires, timer->base->get_time());
 281 }
 282
 283 #ifdef CONFIG_HIGH_RES_TIMERS
 284 struct clock_event_device;
 285
 286 extern void clock_was_set(void);
 287 extern void hres_timers_resume(void);
 288 extern void hrtimer_interrupt(struct clock_event_device *dev);
 289
 290 /*
 291  * In high resolution mode the time reference must be read accurate
 292  */
 293 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 294 {
 295         return timer->base->get_time();
 296 }
 297
 298 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 299 {
 300         return timer->base->cpu_base->hres_active;
 301 }
 302
 303 extern void hrtimer_peek_ahead_timers(void);
 304
 305 /*
 306  * The resolution of the clocks. The resolution value is returned in
 307  * the clock_getres() system call to give application programmers an
 308  * idea of the (in)accuracy of timers. Timer values are rounded up to
 309  * this resolution values.
 310  */
 311 # define HIGH_RES_NSEC          1
 312 # define KTIME_HIGH_RES         (ktime_t) { .tv64 = HIGH_RES_NSEC }
 313 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
 314 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
 315
 316 #else
 317
 318 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
 319 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
 320
 321 /*
 322  * clock_was_set() is a NOP for non- high-resolution systems. The
 323  * time-sorted order guarantees that a timer does not expire early and
 324  * is expired in the next softirq when the clock was advanced.
 325  */
 326 static inline void clock_was_set(void) { }
 327 static inline void hrtimer_peek_ahead_timers(void) { }
 328
 329 static inline void hres_timers_resume(void) { }
 330
 331 /*
 332  * In non high resolution mode the time reference is taken from
 333  * the base softirq time variable.
 334  */
 335 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
 336 {
 337         return timer->base->softirq_time;
 338 }
 339
 340 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
 341 {
 342         return 0;
 343 }
 344 #endif
 345
 346 extern ktime_t ktime_get(void);
 347 extern ktime_t ktime_get_real(void);
 348
 349
 350 DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
 351
 352
 353 /* Exported timer functions: */
 354
 355 /* Initialize timers: */
 356 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
 357                          enum hrtimer_mode mode);
 358
 359 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
 360 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
 361                                   enum hrtimer_mode mode);
 362
 363 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
 364 #else
 365 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
 366                                          clockid_t which_clock,
 367                                          enum hrtimer_mode mode)
 368 {
 369         hrtimer_init(timer, which_clock, mode);
 370 }
 371 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
 372 #endif
 373
 374 /* Basic timer operations: */
 375 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
 376                          const enum hrtimer_mode mode);
 377 extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
 378                         unsigned long range_ns, const enum hrtimer_mode mode);
 379 extern int hrtimer_cancel(struct hrtimer *timer);
 380 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
 381
 382 static inline int hrtimer_start_expires(struct hrtimer *timer,
 383                                                 enum hrtimer_mode mode)
 384 {
 385         unsigned long delta;
 386         ktime_t soft, hard;
 387         soft = hrtimer_get_softexpires(timer);
 388         hard = hrtimer_get_expires(timer);
 389         delta = ktime_to_ns(ktime_sub(hard, soft));
 390         return hrtimer_start_range_ns(timer, soft, delta, mode);
 391 }
 392
 393 static inline int hrtimer_restart(struct hrtimer *timer)
 394 {
 395         return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
 396 }
 397
 398 /* Query timers: */
 399 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
 400 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
 401
 402 extern ktime_t hrtimer_get_next_event(void);
 403
 404 /*
 405  * A timer is active, when it is enqueued into the rbtree or the callback
 406  * function is running.
 407  */
 408 static inline int hrtimer_active(const struct hrtimer *timer)
 409 {
 410         return timer->state != HRTIMER_STATE_INACTIVE;
 411 }
 412
 413 /*
 414  * Helper function to check, whether the timer is on one of the queues
 415  */
 416 static inline int hrtimer_is_queued(struct hrtimer *timer)
 417 {
 418         return timer->state &
 419                 (HRTIMER_STATE_ENQUEUED | HRTIMER_STATE_PENDING);
 420 }
 421
 422 /*
 423  * Helper function to check, whether the timer is running the callback
 424  * function
 425  */
 426 static inline int hrtimer_callback_running(struct hrtimer *timer)
 427 {
 428         return timer->state & HRTIMER_STATE_CALLBACK;
 429 }
 430
 431 /* Forward a hrtimer so it expires after now: */
 432 extern u64
 433 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
 434
 435 /* Forward a hrtimer so it expires after the hrtimer's current now */
 436 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
 437                                       ktime_t interval)
 438 {
 439         return hrtimer_forward(timer, timer->base->get_time(), interval);
 440 }
 441
 442 /* Precise sleep: */
 443 extern long hrtimer_nanosleep(struct timespec *rqtp,
 444                               struct timespec __user *rmtp,
 445                               const enum hrtimer_mode mode,
 446                               const clockid_t clockid);
 447 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
 448
 449 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
 450                                  struct task_struct *tsk);
 451
 452 extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
 453                                                 const enum hrtimer_mode mode);
 454 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
 455
 456 /* Soft interrupt function to run the hrtimer queues: */
 457 extern void hrtimer_run_queues(void);
 458 extern void hrtimer_run_pending(void);
 459
 460 /* Bootup initialization: */
 461 extern void __init hrtimers_init(void);
 462
 463 #if BITS_PER_LONG < 64
 464 extern u64 ktime_divns(const ktime_t kt, s64 div);
 465 #else /* BITS_PER_LONG < 64 */
 466 # define ktime_divns(kt, div)           (u64)((kt).tv64 / (div))
 467 #endif
 468
 469 /* Show pending timers: */
 470 extern void sysrq_timer_list_show(void);
 471
 472 /*
 473  * Timer-statistics info:
 474  */
 475 #ifdef CONFIG_TIMER_STATS
 476
 477 extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
 478                                      void *timerf, char *comm,
 479                                      unsigned int timer_flag);
 480
 481 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 482 {
 483         timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
 484                                  timer->function, timer->start_comm, 0);
 485 }
 486
 487 extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
 488                                                  void *addr);
 489
 490 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 491 {
 492         __timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
 493 }
 494
 495 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 496 {
 497         timer->start_site = NULL;
 498 }
 499 #else
 500 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
 501 {
 502 }
 503
 504 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
 505 {
 506 }
 507
 508 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
 509 {
 510 }
 511 #endif
 512
 513 #endif