blob: 62839fd04dce25dc63fa8ceb175eb94ae915171a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
Richard Cochranf1f1d5e2011-02-01 13:52:26 +00007#include <linux/timex.h>
John Stultz9a7adcf52011-01-11 09:54:33 -08008#include <linux/alarmtimer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
Christoph Hellwig31ea70e2017-06-03 21:01:00 +020010struct siginfo;
Frederic Weisbecker55ccb612013-06-28 00:06:42 +000011
Linus Torvalds1da177e2005-04-16 15:20:36 -070012struct cpu_timer_list {
13 struct list_head entry;
Frederic Weisbeckerebd7e7f2017-01-31 04:09:34 +010014 u64 expires, incr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 struct task_struct *task;
16 int firing;
17};
18
Richard Cochran81e294c2011-02-01 13:52:32 +000019/*
20 * Bit fields within a clockid:
21 *
22 * The most significant 29 bits hold either a pid or a file descriptor.
23 *
24 * Bit 2 indicates whether a cpu clock refers to a thread or a process.
25 *
26 * Bits 1 and 0 give the type: PROF=0, VIRT=1, SCHED=2, or FD=3.
27 *
28 * A clockid is invalid if bits 2, 1, and 0 are all set.
29 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#define CPUCLOCK_PID(clock) ((pid_t) ~((clock) >> 3))
31#define CPUCLOCK_PERTHREAD(clock) \
32 (((clock) & (clockid_t) CPUCLOCK_PERTHREAD_MASK) != 0)
Richard Cochran0606f422011-02-01 13:52:35 +000033
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#define CPUCLOCK_PERTHREAD_MASK 4
35#define CPUCLOCK_WHICH(clock) ((clock) & (clockid_t) CPUCLOCK_CLOCK_MASK)
36#define CPUCLOCK_CLOCK_MASK 3
37#define CPUCLOCK_PROF 0
38#define CPUCLOCK_VIRT 1
39#define CPUCLOCK_SCHED 2
40#define CPUCLOCK_MAX 3
Richard Cochran81e294c2011-02-01 13:52:32 +000041#define CLOCKFD CPUCLOCK_MAX
42#define CLOCKFD_MASK (CPUCLOCK_PERTHREAD_MASK|CPUCLOCK_CLOCK_MASK)
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44#define MAKE_PROCESS_CPUCLOCK(pid, clock) \
45 ((~(clockid_t) (pid) << 3) | (clockid_t) (clock))
46#define MAKE_THREAD_CPUCLOCK(tid, clock) \
47 MAKE_PROCESS_CPUCLOCK((tid), (clock) | CPUCLOCK_PERTHREAD_MASK)
48
Richard Cochran0606f422011-02-01 13:52:35 +000049#define FD_TO_CLOCKID(fd) ((~(clockid_t) (fd) << 3) | CLOCKFD)
50#define CLOCKID_TO_FD(clk) ((unsigned int) ~((clk) >> 3))
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#define REQUEUE_PENDING 1
Thomas Gleixner03676b42017-05-30 23:15:40 +020053
54/**
55 * struct k_itimer - POSIX.1b interval timer structure.
56 * @list: List head for binding the timer to signals->posix_timers
57 * @t_hash: Entry in the posix timer hash table
58 * @it_lock: Lock protecting the timer
Thomas Gleixnerd97bb752017-05-30 23:15:44 +020059 * @kclock: Pointer to the k_clock struct handling this timer
Thomas Gleixner03676b42017-05-30 23:15:40 +020060 * @it_clock: The posix timer clock id
61 * @it_id: The posix timer id for identifying the timer
Thomas Gleixner21e55c12017-05-30 23:15:48 +020062 * @it_active: Marker that timer is active
Thomas Gleixner03676b42017-05-30 23:15:40 +020063 * @it_overrun: The overrun counter for pending signals
64 * @it_overrun_last: The overrun at the time of the last delivered signal
65 * @it_requeue_pending: Indicator that timer waits for being requeued on
66 * signal delivery
67 * @it_sigev_notify: The notify word of sigevent struct for signal delivery
Thomas Gleixner80105cd2017-05-30 23:15:43 +020068 * @it_interval: The interval for periodic timers
Thomas Gleixner03676b42017-05-30 23:15:40 +020069 * @it_signal: Pointer to the creators signal struct
70 * @it_pid: The pid of the process/task targeted by the signal
71 * @it_process: The task to wakeup on clock_nanosleep (CPU timers)
72 * @sigq: Pointer to preallocated sigqueue
73 * @it: Union representing the various posix timer type
74 * internals. Also used for rcu freeing the timer.
75 */
76struct k_itimer {
77 struct list_head list;
78 struct hlist_node t_hash;
79 spinlock_t it_lock;
Thomas Gleixnerd97bb752017-05-30 23:15:44 +020080 const struct k_clock *kclock;
Thomas Gleixner03676b42017-05-30 23:15:40 +020081 clockid_t it_clock;
82 timer_t it_id;
Thomas Gleixner21e55c12017-05-30 23:15:48 +020083 int it_active;
Thomas Gleixner03676b42017-05-30 23:15:40 +020084 int it_overrun;
85 int it_overrun_last;
86 int it_requeue_pending;
87 int it_sigev_notify;
Thomas Gleixner80105cd2017-05-30 23:15:43 +020088 ktime_t it_interval;
Thomas Gleixner03676b42017-05-30 23:15:40 +020089 struct signal_struct *it_signal;
Oleg Nesterov27af4242008-12-01 14:18:13 -080090 union {
Thomas Gleixner03676b42017-05-30 23:15:40 +020091 struct pid *it_pid;
92 struct task_struct *it_process;
Oleg Nesterov27af4242008-12-01 14:18:13 -080093 };
Thomas Gleixner03676b42017-05-30 23:15:40 +020094 struct sigqueue *sigq;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 union {
96 struct {
Thomas Gleixner03676b42017-05-30 23:15:40 +020097 struct hrtimer timer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 } real;
Thomas Gleixner03676b42017-05-30 23:15:40 +020099 struct cpu_timer_list cpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 struct {
Thomas Gleixner03676b42017-05-30 23:15:40 +0200101 struct alarm alarmtimer;
John Stultz9e264762011-08-10 12:09:24 -0700102 } alarm;
Thomas Gleixner03676b42017-05-30 23:15:40 +0200103 struct rcu_head rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 } it;
105};
106
Thomas Gleixner2a698972006-01-09 20:52:28 -0800107void run_posix_cpu_timers(struct task_struct *task);
108void posix_cpu_timers_exit(struct task_struct *task);
109void posix_cpu_timers_exit_group(struct task_struct *task);
Thomas Gleixner2a698972006-01-09 20:52:28 -0800110void set_process_cpu_timer(struct task_struct *task, unsigned int clock_idx,
Frederic Weisbecker858cf3a2017-01-31 04:09:35 +0100111 u64 *newval, u64 *oldval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Jiri Slaby5ab46b32009-08-28 14:05:12 +0200113void update_rlimit_cpu(struct task_struct *task, unsigned long rlim_new);
Frank Mayharf06febc2008-09-12 09:54:39 -0700114
Thomas Gleixner96fe3b02017-05-30 23:15:46 +0200115void posixtimer_rearm(struct siginfo *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116#endif