Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 03676b41 authored by Thomas Gleixner's avatar Thomas Gleixner
Browse files

posix-timers: Cleanup struct k_itimer 



As a preparation for further changes, cleanup the formatting of the
k_itimer structure and add kernel doc comments.

Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: John Stultz <john.stultz@linaro.org>
Link: http://lkml.kernel.org/r/20170530211656.316574129@linutronix.de
parent 6631fa12

include/linux/posix-timers.h

+40 −21
Original line number Diff line number Diff line
@@ -49,24 +49,43 @@ struct cpu_timer_list { 
#define FD_TO_CLOCKID(fd)	((~(clockid_t) (fd) << 3) | CLOCKFD)

#define CLOCKID_TO_FD(clk)	((unsigned int) ~((clk) >> 3))



/* POSIX.1b interval timer structure. */

#define REQUEUE_PENDING 1



/**

 * struct k_itimer - POSIX.1b interval timer structure.

 * @list:		List head for binding the timer to signals->posix_timers

 * @t_hash:		Entry in the posix timer hash table

 * @it_lock:		Lock protecting the timer

 * @it_clock:		The posix timer clock id

 * @it_id:		The posix timer id for identifying the timer

 * @it_overrun:		The overrun counter for pending signals

 * @it_overrun_last:	The overrun at the time of the last delivered signal

 * @it_requeue_pending:	Indicator that timer waits for being requeued on

 *			signal delivery

 * @it_sigev_notify:	The notify word of sigevent struct for signal delivery

 * @it_signal:		Pointer to the creators signal struct

 * @it_pid:		The pid of the process/task targeted by the signal

 * @it_process:		The task to wakeup on clock_nanosleep (CPU timers)

 * @sigq:		Pointer to preallocated sigqueue

 * @it:			Union representing the various posix timer type

 *			internals. Also used for rcu freeing the timer.

 */

struct k_itimer {

	struct list_head list;		/* free/ allocate list */

	struct list_head	list;

	struct hlist_node	t_hash;

	spinlock_t		it_lock;

	clockid_t it_clock;		/* which timer type */

	timer_t it_id;			/* timer id */

	int it_overrun;			/* overrun on pending signal  */

	int it_overrun_last;		/* overrun on last delivered signal */

	int it_requeue_pending;		/* waiting to requeue this timer */

#define REQUEUE_PENDING 1

	int it_sigev_notify;		/* notify word of sigevent struct */

	clockid_t		it_clock;

	timer_t			it_id;

	int			it_overrun;

	int			it_overrun_last;

	int			it_requeue_pending;

	int			it_sigev_notify;

	struct signal_struct	*it_signal;

	union {

		struct pid *it_pid;	/* pid of process to send signal to */

		struct task_struct *it_process;	/* for clock_nanosleep */

		struct pid		*it_pid;

		struct task_struct	*it_process;

	};

	struct sigqueue *sigq;		/* signal queue entry. */

	struct sigqueue		*sigq;

	union {

		struct {

			struct hrtimer	timer;