include/linux/posix-timers.h

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