linux内核软件定时器编程框架

文章目录

linux 内核软件定时器简介：
描述软件定时器的结构体timer_list
软件定时器相关的配套(宏)函数

init_timer(&定时器对象);
void add_timer(struct timer_list *timer);
int del_timer(struct timer_list * timer);
int mod_timer(struct timer_list *timer, unsigned long expires);

linux内核软件定时器编程框架

代码的框架如下
举例

遇到问题

linux 内核软件定时器简介：

定时器是一种软件功能：即允许在将来的某个时刻，函数在给定的时间间隔用完时被调用。
内核软件定时器特点：可以指定一个超时时间,一旦超时时间到期,内核就会调用定会器的超时处理函数,
切记： linux 内核软件定时器基于软中断实现,所以其超时处理函数不能进行休眠操作。

内核和进程广泛使用定时器。大多数设备驱动程序利用定时器检测反常情况，例如，软盘驱动程序使用定时器在软盘暂时不被访问后就关闭设备的引擎，而并行打印机设备利用定时器检测错误的打印机情况。
程序员也经常利用定时器在将来某一时刻强制执行特定的函数。

相对来说，实现一个定时器并不难。每个定时器都包含一个字段，表示定时器将需要多长时间才到期。这个字段的初值就是jiffies的当前值加上合适的节拍数。这个字段的值将不再改变。（包含了表示当前时刻的自增变量jiffies,这个字段的值怎么保持不变的呢？）每当内核检查定时器时，就把这个到期字段值和当前这一刻jiffies的值相比较，当jiffies大于或等于这个字段存放的值时，定时器到期。

警告：因为对定时器函数的检查总是由可延迟函数进行，而可延迟函数被激活以后很长时间才能被执行，因此，内核不能确保定时器函数正好在定时到期时就开始执行，只能保证在适当的时间执行它们，或者比如延迟到几百毫秒之后执行它们。因此，对于必须严格遵守定时时间的那些实时应用而言，定时器并不合适。

linux系统考虑两种类型的定时器，即动态定时器(dynamic timer)和间隔定时器(interval timer)。第一种类型由内核使用，而间隔定时器可以由进程在用户在创建。
（摘自《深入理解linux内核第三版》）

描述软件定时器的结构体timer_list

struct timer_list {
	/*
	 * All fields that change during normal runtime grouped to the
	 * same cacheline
	 */
	struct list_head entry;
	unsigned long expires;
	struct tvec_base *base;

	void (*function)(unsigned long);
	unsigned long data;

	int slack;

#ifdef CONFIG_TIMER_STATS
	int start_pid;
	void *start_site;
	char start_comm[16];
#endif
#ifdef CONFIG_LOCKDEP
	struct lockdep_map lockdep_map;
#endif
};

entry ：用于将软件定时器插入双向循环链表队列中，该链表根据定时器expires字段的值将软件定时器来分组存放。
expires：定时器的超时时间，时间用节拍数表示(1节拍代表10ms)，该值为系统启动以来所经过的节拍数。例如：5 秒以后超时,expires=jiffies+5*HZ;（HZ在ARM结构为100，在X86架构中为1000），20毫秒以后超时，则为expires=jiffies+2；
function ：定时器的超时处理函数地址,基于软中断实现所以不能进行休眠操作。
data ：用于指定传递给定时器超时处理函数的参数。正是由于data字段，就可以定义一个单独的通用函数来处理多个设备驱动程序的超时问题，在data字段可以存放设备ID,或者其他有意义的数据，定时器函数可以用这些数据来区分不同的设备。也可以根据实际需求自定义传参

软件定时器相关的配套(宏)函数

init_timer(&定时器对象);

定义在include\linux\timer.h

#define init_timer(timer)						\
	__init_timer((timer), 0)

#ifdef CONFIG_LOCKDEP
#define __init_timer(_timer, _flags)					\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_key((_timer), (_flags), #_timer, &__key);	\
	} while (0)

#define __init_timer_on_stack(_timer, _flags)				\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_on_stack_key((_timer), (_flags), #_timer, &__key); \
	} while (0)
#else
#define __init_timer(_timer, _flags)					\
	init_timer_key((_timer), (_flags), NULL, NULL)
#define __init_timer_on_stack(_timer, _flags)				\
	init_timer_on_stack_key((_timer), (_flags), NULL, NULL)
#endif

功能：初始化定时器对象
参数：timer 指向定时器变量

void add_timer(struct timer_list *timer);

定义在kernel\timer\timer.c

/**
 - add_timer - start a timer
 - @timer: the timer to be added
 -  - The kernel will do a ->function(->data) callback from the
 - timer interrupt at the ->expires point in the future. The
 - current time is 'jiffies'.
 -  - The timer's ->expires, ->function (and if the handler uses it, ->data)
 - fields must be set prior calling this function.
 -  - Timers with an ->expires field in the past will be executed in the next
 - timer tick.
 */
void add_timer(struct timer_list *timer)
{
	BUG_ON(timer_pending(timer));
	mod_timer(timer, timer->expires);
}
EXPORT_SYMBOL(add_timer);

/**
 - timer_pending - is a timer pending?
 - @timer: the timer in question
 -  - timer_pending will tell whether a given timer is currently pending or not. Callers must ensure serialization wrt. other operations done to this timer, eg. interrupt contexts, or other CPUs on SMP.
 -  - return value: 1 if the timer is pending, 0 if not.
 */
static inline int timer_pending(const struct timer_list * timer)
{
	return timer->entry.next != NULL;
}

功能：向内核注册添加一个定时器,一旦添加完,定时器就开始倒计时一旦时间到期,内核就会调用其超时处理函数并且将定时器从内核中删除，所以内核定时器的超时处理函数只执行一次
参数：timer是指向软件定时器的指针

int del_timer(struct timer_list * timer);

定义在kernel\timer\timer.c

/**
 * del_timer - deactive a timer.
 * @timer: the timer to be deactivated
 *
 * del_timer() deactivates a timer - this works on both active and inactive timers.
 *
 * The function returns whether it has deactivated a pending timer or not.
 * (ie. del_timer() of an inactive timer returns 0, del_timer() of an
 * active timer returns 1.)
 */
int del_timer(struct timer_list *timer)
{
	struct tvec_base *base;
	unsigned long flags;
	int ret = 0;

	debug_assert_init(timer);

	timer_stats_timer_clear_start_info(timer);
	if (timer_pending(timer)) {
		base = lock_timer_base(timer, &flags);
		ret = detach_if_pending(timer, base, true);
		spin_unlock_irqrestore(&base->lock, flags);
	}

	return ret;
}
EXPORT_SYMBOL(del_timer);

功能：从内核中删除定时器
参数：timer 指向软件定时器的对象

int mod_timer(struct timer_list *timer, unsigned long expires);

定义在kernel\timer\timer.c

/**
 * mod_timer - modify a timer's timeout
 * @timer: the timer to be modified
 * @expires: new timeout in jiffies
 * mod_timer() is a more efficient way to update the expire field of an active timer (if the timer is inactive it will be activated)
 *mod_timer() 是一种有效的方式去更新一个活跃的时间的超时时间，如果这个定时器是不活跃的，将被激活
 * mod_timer(timer, expires) is equivalent to:
 *     del_timer(timer); timer->expires = expires; add_timer(timer);
 *mod_timer(timer, expires) 函数等价于先删除软件定时器，再设置一个定时器超时时间，然后再添加这个软件定时器
 * Note that if there are multiple unserialized concurrent users of the
 * same timer, then mod_timer() is the only safe way to modify the timeout,
 * since add_timer() cannot modify an already running timer.
 *如果同一个定时器有多个未序列化的并发访问用户，那么mod_timer()函数是唯一修改超时的安全方法，因为add_timer()不能修改已经运行的定时器。
 * The function returns whether it has modified a pending timer or not.
 * (ie. mod_timer() of an inactive timer returns 0, mod_timer() of an
 * active timer returns 1.)
 * mod_timer()函数返回1：如果修改一个已经被激活的定时器（即这个定时器已经被挂起）
 * mod_timer()函数返回0：如果修改一个没有被激活的定时器（即这个定时器没有被挂起）
 */
int mod_timer(struct timer_list *timer, unsigned long expires)
{
	expires = apply_slack(timer, expires);
	/*
	 * This is a common optimization triggered by the
	 * networking code - if the timer is re-modified
	 * to be the same thing then just return:
	 */
	if (timer_pending(timer) && timer->expires == expires)
		return 1;

	return __mod_timer(timer, expires, false, TIMER_NOT_PINNED);
}
EXPORT_SYMBOL(mod_timer);

功能：修改定时器的超时时刻的时间，该函数中有互斥访问机制
参数：timer 指向软件定时器的对象
expires :所要设置的定时器的超时时刻的时间。