[deliverable/linux.git] / include / linux / hrtimer.h

/*
 *  include/linux/hrtimer.h
 *
 *  hrtimers - High-resolution kernel timers
 *
 *   Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
 *   Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
 *
 *  data type definitions, declarations, prototypes
 *
 *  Started by: Thomas Gleixner and Ingo Molnar
 *
 *  For licencing details see kernel-base/COPYING
 */
#ifndef _LINUX_HRTIMER_H
#define _LINUX_HRTIMER_H

#include <linux/rbtree.h>
#include <linux/ktime.h>
#include <linux/init.h>
#include <linux/list.h>
#include <linux/wait.h>
#include <linux/percpu.h>


struct hrtimer_clock_base;
struct hrtimer_cpu_base;

/*
 * Mode arguments of xxx_hrtimer functions:
 */
enum hrtimer_mode {
	HRTIMER_MODE_ABS,	/* Time value is absolute */
	HRTIMER_MODE_REL,	/* Time value is relative to now */
};

/*
 * Return values for the callback function
 */
enum hrtimer_restart {
	HRTIMER_NORESTART,	/* Timer is not restarted */
	HRTIMER_RESTART,	/* Timer must be restarted */
};

/*
 * hrtimer callback modes:
 *
 *	HRTIMER_CB_SOFTIRQ:		Callback must run in softirq context
 *	HRTIMER_CB_IRQSAFE_PERCPU:	Callback must run in hardirq context
 *					Special mode for tick emulation and
 *					scheduler timer. Such timers are per
 *					cpu and not allowed to be migrated on
 *					cpu unplug.
 *	HRTIMER_CB_IRQSAFE_UNLOCKED:	Callback should run in hardirq context
 *					with timer->base lock unlocked
 *					used for timers which call wakeup to
 *					avoid lock order problems with rq->lock
 */
enum hrtimer_cb_mode {
	HRTIMER_CB_SOFTIRQ,
	HRTIMER_CB_IRQSAFE_PERCPU,
	HRTIMER_CB_IRQSAFE_UNLOCKED,
};

/*
 * Values to track state of the timer
 *
 * Possible states:
 *
 * 0x00		inactive
 * 0x01		enqueued into rbtree
 * 0x02		callback function running
 * 0x04		callback pending (high resolution mode)
 *
 * Special cases:
 * 0x03		callback function running and enqueued
 *		(was requeued on another CPU)
 * 0x09		timer was migrated on CPU hotunplug
 * The "callback function running and enqueued" status is only possible on
 * SMP. It happens for example when a posix timer expired and the callback
 * queued a signal. Between dropping the lock which protects the posix timer
 * and reacquiring the base lock of the hrtimer, another CPU can deliver the
 * signal and rearm the timer. We have to preserve the callback running state,
 * as otherwise the timer could be removed before the softirq code finishes the
 * the handling of the timer.
 *
 * The HRTIMER_STATE_ENQUEUED bit is always or'ed to the current state to
 * preserve the HRTIMER_STATE_CALLBACK bit in the above scenario.
 *
 * All state transitions are protected by cpu_base->lock.
 */
#define HRTIMER_STATE_INACTIVE	0x00
#define HRTIMER_STATE_ENQUEUED	0x01
#define HRTIMER_STATE_CALLBACK	0x02
#define HRTIMER_STATE_PENDING	0x04
#define HRTIMER_STATE_MIGRATE	0x08

/**
 * struct hrtimer - the basic hrtimer structure
 * @node:	red black tree node for time ordered insertion
 * @_expires:	the absolute expiry time in the hrtimers internal
 *		representation. The time is related to the clock on
 *		which the timer is based. Is setup by adding
 *		slack to the _softexpires value. For non range timers
 *		identical to _softexpires.
 * @_softexpires: the absolute earliest expiry time of the hrtimer.
 *		The time which was given as expiry time when the timer
 *		was armed.
 * @function:	timer expiry callback function
 * @base:	pointer to the timer base (per cpu and per clock)
 * @state:	state information (See bit values above)
 * @cb_mode:	high resolution timer feature to select the callback execution
 *		 mode
 * @cb_entry:	list head to enqueue an expired timer into the callback list
 * @start_site:	timer statistics field to store the site where the timer
 *		was started
 * @start_comm: timer statistics field to store the name of the process which
 *		started the timer
 * @start_pid: timer statistics field to store the pid of the task which
 *		started the timer
 *
 * The hrtimer structure must be initialized by hrtimer_init()
 */
struct hrtimer {
	struct rb_node			node;
	ktime_t				_expires;
	ktime_t				_softexpires;
	enum hrtimer_restart		(*function)(struct hrtimer *);
	struct hrtimer_clock_base	*base;
	unsigned long			state;
	struct list_head		cb_entry;
	enum hrtimer_cb_mode		cb_mode;
#ifdef CONFIG_TIMER_STATS
	int				start_pid;
	void				*start_site;
	char				start_comm[16];
#endif
};

/**
 * struct hrtimer_sleeper - simple sleeper structure
 * @timer:	embedded timer structure
 * @task:	task to wake up
 *
 * task is set to NULL, when the timer expires.
 */
struct hrtimer_sleeper {
	struct hrtimer timer;
	struct task_struct *task;
};

/**
 * struct hrtimer_clock_base - the timer base for a specific clock
 * @cpu_base:		per cpu clock base
 * @index:		clock type index for per_cpu support when moving a
 *			timer to a base on another cpu.
 * @active:		red black tree root node for the active timers
 * @first:		pointer to the timer node which expires first
 * @resolution:		the resolution of the clock, in nanoseconds
 * @get_time:		function to retrieve the current time of the clock
 * @softirq_time:	the time when running the hrtimer queue in the softirq
 * @offset:		offset of this clock to the monotonic base
 */
struct hrtimer_clock_base {
	struct hrtimer_cpu_base	*cpu_base;
	clockid_t		index;
	struct rb_root		active;
	struct rb_node		*first;
	ktime_t			resolution;
	ktime_t			(*get_time)(void);
	ktime_t			softirq_time;
#ifdef CONFIG_HIGH_RES_TIMERS
	ktime_t			offset;
#endif
};

#define HRTIMER_MAX_CLOCK_BASES 2

/*
 * struct hrtimer_cpu_base - the per cpu clock bases
 * @lock:		lock protecting the base and associated clock bases
 *			and timers
 * @clock_base:		array of clock bases for this cpu
 * @curr_timer:		the timer which is executing a callback right now
 * @expires_next:	absolute time of the next event which was scheduled
 *			via clock_set_next_event()
 * @hres_active:	State of high resolution mode
 * @check_clocks:	Indictator, when set evaluate time source and clock
 *			event devices whether high resolution mode can be
 *			activated.
 * @cb_pending:		Expired timers are moved from the rbtree to this
 *			list in the timer interrupt. The list is processed
 *			in the softirq.
 * @nr_events:		Total number of timer interrupt events
 */
struct hrtimer_cpu_base {
	spinlock_t			lock;
	struct hrtimer_clock_base	clock_base[HRTIMER_MAX_CLOCK_BASES];
	struct list_head		cb_pending;
#ifdef CONFIG_HIGH_RES_TIMERS
	ktime_t				expires_next;
	int				hres_active;
	unsigned long			nr_events;
#endif
};

static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
{
	timer->_expires = time;
	timer->_softexpires = time;
}

static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
{
	timer->_softexpires = time;
	timer->_expires = ktime_add_safe(time, delta);
}

static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
{
	timer->_softexpires = time;
	timer->_expires = ktime_add_safe(time, ns_to_ktime(delta));
}

static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
{
	timer->_expires.tv64 = tv64;
	timer->_softexpires.tv64 = tv64;
}

static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
{
	timer->_expires = ktime_add_safe(timer->_expires, time);
	timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
}

static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
{
	timer->_expires = ktime_add_ns(timer->_expires, ns);
	timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
}

static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
{
	return timer->_expires;
}

static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
{
	return timer->_softexpires;
}

static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
{
	return timer->_expires.tv64;
}
static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
{
	return timer->_softexpires.tv64;
}

static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
{
	return ktime_to_ns(timer->_expires);
}

static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
{
    return ktime_sub(timer->_expires, timer->base->get_time());
}

#ifdef CONFIG_HIGH_RES_TIMERS
struct clock_event_device;

extern void clock_was_set(void);
extern void hres_timers_resume(void);
extern void hrtimer_interrupt(struct clock_event_device *dev);

/*
 * In high resolution mode the time reference must be read accurate
 */
static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
{
	return timer->base->get_time();
}

static inline int hrtimer_is_hres_active(struct hrtimer *timer)
{
	return timer->base->cpu_base->hres_active;
}

extern void hrtimer_peek_ahead_timers(void);

/*
 * The resolution of the clocks. The resolution value is returned in
 * the clock_getres() system call to give application programmers an
 * idea of the (in)accuracy of timers. Timer values are rounded up to
 * this resolution values.
 */
# define HIGH_RES_NSEC		1
# define KTIME_HIGH_RES		(ktime_t) { .tv64 = HIGH_RES_NSEC }
# define MONOTONIC_RES_NSEC	HIGH_RES_NSEC
# define KTIME_MONOTONIC_RES	KTIME_HIGH_RES

#else

# define MONOTONIC_RES_NSEC	LOW_RES_NSEC
# define KTIME_MONOTONIC_RES	KTIME_LOW_RES

/*
 * clock_was_set() is a NOP for non- high-resolution systems. The
 * time-sorted order guarantees that a timer does not expire early and
 * is expired in the next softirq when the clock was advanced.
 */
static inline void clock_was_set(void) { }
static inline void hrtimer_peek_ahead_timers(void) { }

static inline void hres_timers_resume(void) { }

/*
 * In non high resolution mode the time reference is taken from
 * the base softirq time variable.
 */
static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
{
	return timer->base->softirq_time;
}

static inline int hrtimer_is_hres_active(struct hrtimer *timer)
{
	return 0;
}
#endif

extern ktime_t ktime_get(void);
extern ktime_t ktime_get_real(void);


DECLARE_PER_CPU(struct tick_device, tick_cpu_device);


/* Exported timer functions: */

/* Initialize timers: */
extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
			 enum hrtimer_mode mode);

#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
				  enum hrtimer_mode mode);

extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
#else
static inline void hrtimer_init_on_stack(struct hrtimer *timer,
					 clockid_t which_clock,
					 enum hrtimer_mode mode)
{
	hrtimer_init(timer, which_clock, mode);
}
static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
#endif

/* Basic timer operations: */
extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
			 const enum hrtimer_mode mode);
extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
			unsigned long range_ns, const enum hrtimer_mode mode);
extern int hrtimer_cancel(struct hrtimer *timer);
extern int hrtimer_try_to_cancel(struct hrtimer *timer);

static inline int hrtimer_start_expires(struct hrtimer *timer,
						enum hrtimer_mode mode)
{
	unsigned long delta;
	ktime_t soft, hard;
	soft = hrtimer_get_softexpires(timer);
	hard = hrtimer_get_expires(timer);
	delta = ktime_to_ns(ktime_sub(hard, soft));
	return hrtimer_start_range_ns(timer, soft, delta, mode);
}

static inline int hrtimer_restart(struct hrtimer *timer)
{
	return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
}

/* Query timers: */
extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);

extern ktime_t hrtimer_get_next_event(void);

/*
 * A timer is active, when it is enqueued into the rbtree or the callback
 * function is running.
 */
static inline int hrtimer_active(const struct hrtimer *timer)
{
	return timer->state != HRTIMER_STATE_INACTIVE;
}

/*
 * Helper function to check, whether the timer is on one of the queues
 */
static inline int hrtimer_is_queued(struct hrtimer *timer)
{
	return timer->state &
		(HRTIMER_STATE_ENQUEUED | HRTIMER_STATE_PENDING);
}

/*
 * Helper function to check, whether the timer is running the callback
 * function
 */
static inline int hrtimer_callback_running(struct hrtimer *timer)
{
	return timer->state & HRTIMER_STATE_CALLBACK;
}

/* Forward a hrtimer so it expires after now: */
extern u64
hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);

/* Forward a hrtimer so it expires after the hrtimer's current now */
static inline u64 hrtimer_forward_now(struct hrtimer *timer,
				      ktime_t interval)
{
	return hrtimer_forward(timer, timer->base->get_time(), interval);
}

/* Precise sleep: */
extern long hrtimer_nanosleep(struct timespec *rqtp,
			      struct timespec __user *rmtp,
			      const enum hrtimer_mode mode,
			      const clockid_t clockid);
extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);

extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
				 struct task_struct *tsk);

extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
						const enum hrtimer_mode mode);
extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);

/* Soft interrupt function to run the hrtimer queues: */
extern void hrtimer_run_queues(void);
extern void hrtimer_run_pending(void);

/* Bootup initialization: */
extern void __init hrtimers_init(void);

#if BITS_PER_LONG < 64
extern u64 ktime_divns(const ktime_t kt, s64 div);
#else /* BITS_PER_LONG < 64 */
# define ktime_divns(kt, div)		(u64)((kt).tv64 / (div))
#endif

/* Show pending timers: */
extern void sysrq_timer_list_show(void);

/*
 * Timer-statistics info:
 */
#ifdef CONFIG_TIMER_STATS

extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
				     void *timerf, char *comm,
				     unsigned int timer_flag);

static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
{
	timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
				 timer->function, timer->start_comm, 0);
}

extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
						 void *addr);

static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
{
	__timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
}

static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
{
	timer->start_site = NULL;
}
#else
static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
{
}

static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
{
}

static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
{
}
#endif

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