1 #ifndef _linux_POSIX_TIMERS_H
2 #define _linux_POSIX_TIMERS_H
3 
4 #include <linux/spinlock.h>
5 #include <linux/list.h>
6 #include <linux/sched.h>
7 #include <linux/timex.h>
8 
9 union cpu_time_count {
10 	cputime_t cpu;
11 	unsigned long long sched;
12 };
13 
14 struct cpu_timer_list {
15 	struct list_head entry;
16 	union cpu_time_count expires, incr;
17 	struct task_struct *task;
18 	int firing;
19 };
20 
21 /*
22  * Bit fields within a clockid:
23  *
24  * The most significant 29 bits hold either a pid or a file descriptor.
25  *
26  * Bit 2 indicates whether a cpu clock refers to a thread or a process.
27  *
28  * Bits 1 and 0 give the type: PROF=0, VIRT=1, SCHED=2, or FD=3.
29  *
30  * A clockid is invalid if bits 2, 1, and 0 are all set.
31  */
32 #define CPUCLOCK_PID(clock)		((pid_t) ~((clock) >> 3))
33 #define CPUCLOCK_PERTHREAD(clock) \
34 	(((clock) & (clockid_t) CPUCLOCK_PERTHREAD_MASK) != 0)
35 
36 #define CPUCLOCK_PERTHREAD_MASK	4
37 #define CPUCLOCK_WHICH(clock)	((clock) & (clockid_t) CPUCLOCK_CLOCK_MASK)
38 #define CPUCLOCK_CLOCK_MASK	3
39 #define CPUCLOCK_PROF		0
40 #define CPUCLOCK_VIRT		1
41 #define CPUCLOCK_SCHED		2
42 #define CPUCLOCK_MAX		3
43 #define CLOCKFD			CPUCLOCK_MAX
44 #define CLOCKFD_MASK		(CPUCLOCK_PERTHREAD_MASK|CPUCLOCK_CLOCK_MASK)
45 
46 #define MAKE_PROCESS_CPUCLOCK(pid, clock) \
47 	((~(clockid_t) (pid) << 3) | (clockid_t) (clock))
48 #define MAKE_THREAD_CPUCLOCK(tid, clock) \
49 	MAKE_PROCESS_CPUCLOCK((tid), (clock) | CPUCLOCK_PERTHREAD_MASK)
50 
51 #define FD_TO_CLOCKID(fd)	((~(clockid_t) (fd) << 3) | CLOCKFD)
52 #define CLOCKID_TO_FD(clk)	((unsigned int) ~((clk) >> 3))
53 
54 /* POSIX.1b interval timer structure. */
55 struct k_itimer {
56 	struct list_head list;		/* free/ allocate list */
57 	spinlock_t it_lock;
58 	clockid_t it_clock;		/* which timer type */
59 	timer_t it_id;			/* timer id */
60 	int it_overrun;			/* overrun on pending signal  */
61 	int it_overrun_last;		/* overrun on last delivered signal */
62 	int it_requeue_pending;		/* waiting to requeue this timer */
63 #define REQUEUE_PENDING 1
64 	int it_sigev_notify;		/* notify word of sigevent struct */
65 	struct signal_struct *it_signal;
66 	union {
67 		struct pid *it_pid;	/* pid of process to send signal to */
68 		struct task_struct *it_process;	/* for clock_nanosleep */
69 	};
70 	struct sigqueue *sigq;		/* signal queue entry. */
71 	union {
72 		struct {
73 			struct hrtimer timer;
74 			ktime_t interval;
75 		} real;
76 		struct cpu_timer_list cpu;
77 		struct {
78 			unsigned int clock;
79 			unsigned int node;
80 			unsigned long incr;
81 			unsigned long expires;
82 		} mmtimer;
83 	} it;
84 };
85 
86 struct k_clock {
87 	int (*clock_getres) (const clockid_t which_clock, struct timespec *tp);
88 	int (*clock_set) (const clockid_t which_clock,
89 			  const struct timespec *tp);
90 	int (*clock_get) (const clockid_t which_clock, struct timespec * tp);
91 	int (*clock_adj) (const clockid_t which_clock, struct timex *tx);
92 	int (*timer_create) (struct k_itimer *timer);
93 	int (*nsleep) (const clockid_t which_clock, int flags,
94 		       struct timespec *, struct timespec __user *);
95 	long (*nsleep_restart) (struct restart_block *restart_block);
96 	int (*timer_set) (struct k_itimer * timr, int flags,
97 			  struct itimerspec * new_setting,
98 			  struct itimerspec * old_setting);
99 	int (*timer_del) (struct k_itimer * timr);
100 #define TIMER_RETRY 1
101 	void (*timer_get) (struct k_itimer * timr,
102 			   struct itimerspec * cur_setting);
103 };
104 
105 extern struct k_clock clock_posix_cpu;
106 extern struct k_clock clock_posix_dynamic;
107 
108 void posix_timers_register_clock(const clockid_t clock_id, struct k_clock *new_clock);
109 
110 /* function to call to trigger timer event */
111 int posix_timer_event(struct k_itimer *timr, int si_private);
112 
113 void posix_cpu_timer_schedule(struct k_itimer *timer);
114 
115 void run_posix_cpu_timers(struct task_struct *task);
116 void posix_cpu_timers_exit(struct task_struct *task);
117 void posix_cpu_timers_exit_group(struct task_struct *task);
118 
119 void set_process_cpu_timer(struct task_struct *task, unsigned int clock_idx,
120 			   cputime_t *newval, cputime_t *oldval);
121 
122 long clock_nanosleep_restart(struct restart_block *restart_block);
123 
124 void update_rlimit_cpu(struct task_struct *task, unsigned long rlim_new);
125 
126 #endif
127