[mirror_ubuntu-bionic-kernel.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 = 0x0,		/* Time value is absolute */
	HRTIMER_MODE_REL = 0x1,		/* Time value is relative to now */
	HRTIMER_MODE_PINNED = 0x02,	/* Timer is bound to CPU */
	HRTIMER_MODE_ABS_PINNED = 0x02,
	HRTIMER_MODE_REL_PINNED = 0x03,
};

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

/*
 * Values to track state of the timer
 *
 * Possible states:
 *
 * 0x00		inactive
 * 0x01		enqueued into rbtree
 * 0x02		callback function running
 *
 * 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_MIGRATE	0x04

/**
 * 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_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;
#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.
 * @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];
#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_start_range_ns(struct hrtimer *timer, ktime_t tim,
			 unsigned long delta_ns,
			 const enum hrtimer_mode mode, int wakeup);

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;
}

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