]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - kernel/time/posix-timers.c
posix-timers: Make use of forward/remaining callbacks
[karo-tx-linux.git] / kernel / time / posix-timers.c
1 /*
2  * linux/kernel/posix-timers.c
3  *
4  *
5  * 2002-10-15  Posix Clocks & timers
6  *                           by George Anzinger george@mvista.com
7  *
8  *                           Copyright (C) 2002 2003 by MontaVista Software.
9  *
10  * 2004-06-01  Fix CLOCK_REALTIME clock/timer TIMER_ABSTIME bug.
11  *                           Copyright (C) 2004 Boris Hu
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or (at
16  * your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful, but
19  * WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21  * General Public License for more details.
22
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26  *
27  * MontaVista Software | 1237 East Arques Avenue | Sunnyvale | CA 94085 | USA
28  */
29
30 /* These are all the functions necessary to implement
31  * POSIX clocks & timers
32  */
33 #include <linux/mm.h>
34 #include <linux/interrupt.h>
35 #include <linux/slab.h>
36 #include <linux/time.h>
37 #include <linux/mutex.h>
38 #include <linux/sched/task.h>
39
40 #include <linux/uaccess.h>
41 #include <linux/list.h>
42 #include <linux/init.h>
43 #include <linux/compiler.h>
44 #include <linux/hash.h>
45 #include <linux/posix-clock.h>
46 #include <linux/posix-timers.h>
47 #include <linux/syscalls.h>
48 #include <linux/wait.h>
49 #include <linux/workqueue.h>
50 #include <linux/export.h>
51 #include <linux/hashtable.h>
52
53 #include "timekeeping.h"
54 #include "posix-timers.h"
55
56 /*
57  * Management arrays for POSIX timers. Timers are now kept in static hash table
58  * with 512 entries.
59  * Timer ids are allocated by local routine, which selects proper hash head by
60  * key, constructed from current->signal address and per signal struct counter.
61  * This keeps timer ids unique per process, but now they can intersect between
62  * processes.
63  */
64
65 /*
66  * Lets keep our timers in a slab cache :-)
67  */
68 static struct kmem_cache *posix_timers_cache;
69
70 static DEFINE_HASHTABLE(posix_timers_hashtable, 9);
71 static DEFINE_SPINLOCK(hash_lock);
72
73 static const struct k_clock * const posix_clocks[];
74 static const struct k_clock *clockid_to_kclock(const clockid_t id);
75
76 /*
77  * we assume that the new SIGEV_THREAD_ID shares no bits with the other
78  * SIGEV values.  Here we put out an error if this assumption fails.
79  */
80 #if SIGEV_THREAD_ID != (SIGEV_THREAD_ID & \
81                        ~(SIGEV_SIGNAL | SIGEV_NONE | SIGEV_THREAD))
82 #error "SIGEV_THREAD_ID must not share bit with other SIGEV values!"
83 #endif
84
85 /*
86  * parisc wants ENOTSUP instead of EOPNOTSUPP
87  */
88 #ifndef ENOTSUP
89 # define ENANOSLEEP_NOTSUP EOPNOTSUPP
90 #else
91 # define ENANOSLEEP_NOTSUP ENOTSUP
92 #endif
93
94 /*
95  * The timer ID is turned into a timer address by idr_find().
96  * Verifying a valid ID consists of:
97  *
98  * a) checking that idr_find() returns other than -1.
99  * b) checking that the timer id matches the one in the timer itself.
100  * c) that the timer owner is in the callers thread group.
101  */
102
103 /*
104  * CLOCKs: The POSIX standard calls for a couple of clocks and allows us
105  *          to implement others.  This structure defines the various
106  *          clocks.
107  *
108  * RESOLUTION: Clock resolution is used to round up timer and interval
109  *          times, NOT to report clock times, which are reported with as
110  *          much resolution as the system can muster.  In some cases this
111  *          resolution may depend on the underlying clock hardware and
112  *          may not be quantifiable until run time, and only then is the
113  *          necessary code is written.  The standard says we should say
114  *          something about this issue in the documentation...
115  *
116  * FUNCTIONS: The CLOCKs structure defines possible functions to
117  *          handle various clock functions.
118  *
119  *          The standard POSIX timer management code assumes the
120  *          following: 1.) The k_itimer struct (sched.h) is used for
121  *          the timer.  2.) The list, it_lock, it_clock, it_id and
122  *          it_pid fields are not modified by timer code.
123  *
124  * Permissions: It is assumed that the clock_settime() function defined
125  *          for each clock will take care of permission checks.  Some
126  *          clocks may be set able by any user (i.e. local process
127  *          clocks) others not.  Currently the only set able clock we
128  *          have is CLOCK_REALTIME and its high res counter part, both of
129  *          which we beg off on and pass to do_sys_settimeofday().
130  */
131 static struct k_itimer *__lock_timer(timer_t timer_id, unsigned long *flags);
132
133 #define lock_timer(tid, flags)                                             \
134 ({      struct k_itimer *__timr;                                           \
135         __cond_lock(&__timr->it_lock, __timr = __lock_timer(tid, flags));  \
136         __timr;                                                            \
137 })
138
139 static int hash(struct signal_struct *sig, unsigned int nr)
140 {
141         return hash_32(hash32_ptr(sig) ^ nr, HASH_BITS(posix_timers_hashtable));
142 }
143
144 static struct k_itimer *__posix_timers_find(struct hlist_head *head,
145                                             struct signal_struct *sig,
146                                             timer_t id)
147 {
148         struct k_itimer *timer;
149
150         hlist_for_each_entry_rcu(timer, head, t_hash) {
151                 if ((timer->it_signal == sig) && (timer->it_id == id))
152                         return timer;
153         }
154         return NULL;
155 }
156
157 static struct k_itimer *posix_timer_by_id(timer_t id)
158 {
159         struct signal_struct *sig = current->signal;
160         struct hlist_head *head = &posix_timers_hashtable[hash(sig, id)];
161
162         return __posix_timers_find(head, sig, id);
163 }
164
165 static int posix_timer_add(struct k_itimer *timer)
166 {
167         struct signal_struct *sig = current->signal;
168         int first_free_id = sig->posix_timer_id;
169         struct hlist_head *head;
170         int ret = -ENOENT;
171
172         do {
173                 spin_lock(&hash_lock);
174                 head = &posix_timers_hashtable[hash(sig, sig->posix_timer_id)];
175                 if (!__posix_timers_find(head, sig, sig->posix_timer_id)) {
176                         hlist_add_head_rcu(&timer->t_hash, head);
177                         ret = sig->posix_timer_id;
178                 }
179                 if (++sig->posix_timer_id < 0)
180                         sig->posix_timer_id = 0;
181                 if ((sig->posix_timer_id == first_free_id) && (ret == -ENOENT))
182                         /* Loop over all possible ids completed */
183                         ret = -EAGAIN;
184                 spin_unlock(&hash_lock);
185         } while (ret == -ENOENT);
186         return ret;
187 }
188
189 static inline void unlock_timer(struct k_itimer *timr, unsigned long flags)
190 {
191         spin_unlock_irqrestore(&timr->it_lock, flags);
192 }
193
194 /* Get clock_realtime */
195 static int posix_clock_realtime_get(clockid_t which_clock, struct timespec64 *tp)
196 {
197         ktime_get_real_ts64(tp);
198         return 0;
199 }
200
201 /* Set clock_realtime */
202 static int posix_clock_realtime_set(const clockid_t which_clock,
203                                     const struct timespec64 *tp)
204 {
205         return do_sys_settimeofday64(tp, NULL);
206 }
207
208 static int posix_clock_realtime_adj(const clockid_t which_clock,
209                                     struct timex *t)
210 {
211         return do_adjtimex(t);
212 }
213
214 /*
215  * Get monotonic time for posix timers
216  */
217 static int posix_ktime_get_ts(clockid_t which_clock, struct timespec64 *tp)
218 {
219         ktime_get_ts64(tp);
220         return 0;
221 }
222
223 /*
224  * Get monotonic-raw time for posix timers
225  */
226 static int posix_get_monotonic_raw(clockid_t which_clock, struct timespec64 *tp)
227 {
228         getrawmonotonic64(tp);
229         return 0;
230 }
231
232
233 static int posix_get_realtime_coarse(clockid_t which_clock, struct timespec64 *tp)
234 {
235         *tp = current_kernel_time64();
236         return 0;
237 }
238
239 static int posix_get_monotonic_coarse(clockid_t which_clock,
240                                                 struct timespec64 *tp)
241 {
242         *tp = get_monotonic_coarse64();
243         return 0;
244 }
245
246 static int posix_get_coarse_res(const clockid_t which_clock, struct timespec64 *tp)
247 {
248         *tp = ktime_to_timespec64(KTIME_LOW_RES);
249         return 0;
250 }
251
252 static int posix_get_boottime(const clockid_t which_clock, struct timespec64 *tp)
253 {
254         get_monotonic_boottime64(tp);
255         return 0;
256 }
257
258 static int posix_get_tai(clockid_t which_clock, struct timespec64 *tp)
259 {
260         timekeeping_clocktai64(tp);
261         return 0;
262 }
263
264 static int posix_get_hrtimer_res(clockid_t which_clock, struct timespec64 *tp)
265 {
266         tp->tv_sec = 0;
267         tp->tv_nsec = hrtimer_resolution;
268         return 0;
269 }
270
271 /*
272  * Initialize everything, well, just everything in Posix clocks/timers ;)
273  */
274 static __init int init_posix_timers(void)
275 {
276         posix_timers_cache = kmem_cache_create("posix_timers_cache",
277                                         sizeof (struct k_itimer), 0, SLAB_PANIC,
278                                         NULL);
279         return 0;
280 }
281 __initcall(init_posix_timers);
282
283 static void common_hrtimer_rearm(struct k_itimer *timr)
284 {
285         struct hrtimer *timer = &timr->it.real.timer;
286
287         if (!timr->it_interval)
288                 return;
289
290         timr->it_overrun += (unsigned int) hrtimer_forward(timer,
291                                                 timer->base->get_time(),
292                                                 timr->it_interval);
293         hrtimer_restart(timer);
294 }
295
296 /*
297  * This function is exported for use by the signal deliver code.  It is
298  * called just prior to the info block being released and passes that
299  * block to us.  It's function is to update the overrun entry AND to
300  * restart the timer.  It should only be called if the timer is to be
301  * restarted (i.e. we have flagged this in the sys_private entry of the
302  * info block).
303  *
304  * To protect against the timer going away while the interrupt is queued,
305  * we require that the it_requeue_pending flag be set.
306  */
307 void posixtimer_rearm(struct siginfo *info)
308 {
309         struct k_itimer *timr;
310         unsigned long flags;
311
312         timr = lock_timer(info->si_tid, &flags);
313         if (!timr)
314                 return;
315
316         if (timr->it_requeue_pending == info->si_sys_private) {
317                 timr->kclock->timer_rearm(timr);
318
319                 timr->it_active = 1;
320                 timr->it_overrun_last = timr->it_overrun;
321                 timr->it_overrun = -1;
322                 ++timr->it_requeue_pending;
323
324                 info->si_overrun += timr->it_overrun_last;
325         }
326
327         unlock_timer(timr, flags);
328 }
329
330 int posix_timer_event(struct k_itimer *timr, int si_private)
331 {
332         struct task_struct *task;
333         int shared, ret = -1;
334         /*
335          * FIXME: if ->sigq is queued we can race with
336          * dequeue_signal()->posixtimer_rearm().
337          *
338          * If dequeue_signal() sees the "right" value of
339          * si_sys_private it calls posixtimer_rearm().
340          * We re-queue ->sigq and drop ->it_lock().
341          * posixtimer_rearm() locks the timer
342          * and re-schedules it while ->sigq is pending.
343          * Not really bad, but not that we want.
344          */
345         timr->sigq->info.si_sys_private = si_private;
346
347         rcu_read_lock();
348         task = pid_task(timr->it_pid, PIDTYPE_PID);
349         if (task) {
350                 shared = !(timr->it_sigev_notify & SIGEV_THREAD_ID);
351                 ret = send_sigqueue(timr->sigq, task, shared);
352         }
353         rcu_read_unlock();
354         /* If we failed to send the signal the timer stops. */
355         return ret > 0;
356 }
357
358 /*
359  * This function gets called when a POSIX.1b interval timer expires.  It
360  * is used as a callback from the kernel internal timer.  The
361  * run_timer_list code ALWAYS calls with interrupts on.
362
363  * This code is for CLOCK_REALTIME* and CLOCK_MONOTONIC* timers.
364  */
365 static enum hrtimer_restart posix_timer_fn(struct hrtimer *timer)
366 {
367         struct k_itimer *timr;
368         unsigned long flags;
369         int si_private = 0;
370         enum hrtimer_restart ret = HRTIMER_NORESTART;
371
372         timr = container_of(timer, struct k_itimer, it.real.timer);
373         spin_lock_irqsave(&timr->it_lock, flags);
374
375         timr->it_active = 0;
376         if (timr->it_interval != 0)
377                 si_private = ++timr->it_requeue_pending;
378
379         if (posix_timer_event(timr, si_private)) {
380                 /*
381                  * signal was not sent because of sig_ignor
382                  * we will not get a call back to restart it AND
383                  * it should be restarted.
384                  */
385                 if (timr->it_interval != 0) {
386                         ktime_t now = hrtimer_cb_get_time(timer);
387
388                         /*
389                          * FIXME: What we really want, is to stop this
390                          * timer completely and restart it in case the
391                          * SIG_IGN is removed. This is a non trivial
392                          * change which involves sighand locking
393                          * (sigh !), which we don't want to do late in
394                          * the release cycle.
395                          *
396                          * For now we just let timers with an interval
397                          * less than a jiffie expire every jiffie to
398                          * avoid softirq starvation in case of SIG_IGN
399                          * and a very small interval, which would put
400                          * the timer right back on the softirq pending
401                          * list. By moving now ahead of time we trick
402                          * hrtimer_forward() to expire the timer
403                          * later, while we still maintain the overrun
404                          * accuracy, but have some inconsistency in
405                          * the timer_gettime() case. This is at least
406                          * better than a starved softirq. A more
407                          * complex fix which solves also another related
408                          * inconsistency is already in the pipeline.
409                          */
410 #ifdef CONFIG_HIGH_RES_TIMERS
411                         {
412                                 ktime_t kj = NSEC_PER_SEC / HZ;
413
414                                 if (timr->it_interval < kj)
415                                         now = ktime_add(now, kj);
416                         }
417 #endif
418                         timr->it_overrun += (unsigned int)
419                                 hrtimer_forward(timer, now,
420                                                 timr->it_interval);
421                         ret = HRTIMER_RESTART;
422                         ++timr->it_requeue_pending;
423                         timr->it_active = 1;
424                 }
425         }
426
427         unlock_timer(timr, flags);
428         return ret;
429 }
430
431 static struct pid *good_sigevent(sigevent_t * event)
432 {
433         struct task_struct *rtn = current->group_leader;
434
435         if ((event->sigev_notify & SIGEV_THREAD_ID ) &&
436                 (!(rtn = find_task_by_vpid(event->sigev_notify_thread_id)) ||
437                  !same_thread_group(rtn, current) ||
438                  (event->sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_SIGNAL))
439                 return NULL;
440
441         if (((event->sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_NONE) &&
442             ((event->sigev_signo <= 0) || (event->sigev_signo > SIGRTMAX)))
443                 return NULL;
444
445         return task_pid(rtn);
446 }
447
448 static struct k_itimer * alloc_posix_timer(void)
449 {
450         struct k_itimer *tmr;
451         tmr = kmem_cache_zalloc(posix_timers_cache, GFP_KERNEL);
452         if (!tmr)
453                 return tmr;
454         if (unlikely(!(tmr->sigq = sigqueue_alloc()))) {
455                 kmem_cache_free(posix_timers_cache, tmr);
456                 return NULL;
457         }
458         memset(&tmr->sigq->info, 0, sizeof(siginfo_t));
459         return tmr;
460 }
461
462 static void k_itimer_rcu_free(struct rcu_head *head)
463 {
464         struct k_itimer *tmr = container_of(head, struct k_itimer, it.rcu);
465
466         kmem_cache_free(posix_timers_cache, tmr);
467 }
468
469 #define IT_ID_SET       1
470 #define IT_ID_NOT_SET   0
471 static void release_posix_timer(struct k_itimer *tmr, int it_id_set)
472 {
473         if (it_id_set) {
474                 unsigned long flags;
475                 spin_lock_irqsave(&hash_lock, flags);
476                 hlist_del_rcu(&tmr->t_hash);
477                 spin_unlock_irqrestore(&hash_lock, flags);
478         }
479         put_pid(tmr->it_pid);
480         sigqueue_free(tmr->sigq);
481         call_rcu(&tmr->it.rcu, k_itimer_rcu_free);
482 }
483
484 static int common_timer_create(struct k_itimer *new_timer)
485 {
486         hrtimer_init(&new_timer->it.real.timer, new_timer->it_clock, 0);
487         return 0;
488 }
489
490 /* Create a POSIX.1b interval timer. */
491
492 SYSCALL_DEFINE3(timer_create, const clockid_t, which_clock,
493                 struct sigevent __user *, timer_event_spec,
494                 timer_t __user *, created_timer_id)
495 {
496         const struct k_clock *kc = clockid_to_kclock(which_clock);
497         struct k_itimer *new_timer;
498         int error, new_timer_id;
499         sigevent_t event;
500         int it_id_set = IT_ID_NOT_SET;
501
502         if (!kc)
503                 return -EINVAL;
504         if (!kc->timer_create)
505                 return -EOPNOTSUPP;
506
507         new_timer = alloc_posix_timer();
508         if (unlikely(!new_timer))
509                 return -EAGAIN;
510
511         spin_lock_init(&new_timer->it_lock);
512         new_timer_id = posix_timer_add(new_timer);
513         if (new_timer_id < 0) {
514                 error = new_timer_id;
515                 goto out;
516         }
517
518         it_id_set = IT_ID_SET;
519         new_timer->it_id = (timer_t) new_timer_id;
520         new_timer->it_clock = which_clock;
521         new_timer->kclock = kc;
522         new_timer->it_overrun = -1;
523
524         if (timer_event_spec) {
525                 if (copy_from_user(&event, timer_event_spec, sizeof (event))) {
526                         error = -EFAULT;
527                         goto out;
528                 }
529                 rcu_read_lock();
530                 new_timer->it_pid = get_pid(good_sigevent(&event));
531                 rcu_read_unlock();
532                 if (!new_timer->it_pid) {
533                         error = -EINVAL;
534                         goto out;
535                 }
536         } else {
537                 memset(&event.sigev_value, 0, sizeof(event.sigev_value));
538                 event.sigev_notify = SIGEV_SIGNAL;
539                 event.sigev_signo = SIGALRM;
540                 event.sigev_value.sival_int = new_timer->it_id;
541                 new_timer->it_pid = get_pid(task_tgid(current));
542         }
543
544         new_timer->it_sigev_notify     = event.sigev_notify;
545         new_timer->sigq->info.si_signo = event.sigev_signo;
546         new_timer->sigq->info.si_value = event.sigev_value;
547         new_timer->sigq->info.si_tid   = new_timer->it_id;
548         new_timer->sigq->info.si_code  = SI_TIMER;
549
550         if (copy_to_user(created_timer_id,
551                          &new_timer_id, sizeof (new_timer_id))) {
552                 error = -EFAULT;
553                 goto out;
554         }
555
556         error = kc->timer_create(new_timer);
557         if (error)
558                 goto out;
559
560         spin_lock_irq(&current->sighand->siglock);
561         new_timer->it_signal = current->signal;
562         list_add(&new_timer->list, &current->signal->posix_timers);
563         spin_unlock_irq(&current->sighand->siglock);
564
565         return 0;
566         /*
567          * In the case of the timer belonging to another task, after
568          * the task is unlocked, the timer is owned by the other task
569          * and may cease to exist at any time.  Don't use or modify
570          * new_timer after the unlock call.
571          */
572 out:
573         release_posix_timer(new_timer, it_id_set);
574         return error;
575 }
576
577 /*
578  * Locking issues: We need to protect the result of the id look up until
579  * we get the timer locked down so it is not deleted under us.  The
580  * removal is done under the idr spinlock so we use that here to bridge
581  * the find to the timer lock.  To avoid a dead lock, the timer id MUST
582  * be release with out holding the timer lock.
583  */
584 static struct k_itimer *__lock_timer(timer_t timer_id, unsigned long *flags)
585 {
586         struct k_itimer *timr;
587
588         /*
589          * timer_t could be any type >= int and we want to make sure any
590          * @timer_id outside positive int range fails lookup.
591          */
592         if ((unsigned long long)timer_id > INT_MAX)
593                 return NULL;
594
595         rcu_read_lock();
596         timr = posix_timer_by_id(timer_id);
597         if (timr) {
598                 spin_lock_irqsave(&timr->it_lock, *flags);
599                 if (timr->it_signal == current->signal) {
600                         rcu_read_unlock();
601                         return timr;
602                 }
603                 spin_unlock_irqrestore(&timr->it_lock, *flags);
604         }
605         rcu_read_unlock();
606
607         return NULL;
608 }
609
610 static ktime_t common_hrtimer_remaining(struct k_itimer *timr, ktime_t now)
611 {
612         struct hrtimer *timer = &timr->it.real.timer;
613
614         return __hrtimer_expires_remaining_adjusted(timer, now);
615 }
616
617 static int common_hrtimer_forward(struct k_itimer *timr, ktime_t now)
618 {
619         struct hrtimer *timer = &timr->it.real.timer;
620
621         return (int)hrtimer_forward(timer, now, timr->it_interval);
622 }
623
624 /*
625  * Get the time remaining on a POSIX.1b interval timer.  This function
626  * is ALWAYS called with spin_lock_irq on the timer, thus it must not
627  * mess with irq.
628  *
629  * We have a couple of messes to clean up here.  First there is the case
630  * of a timer that has a requeue pending.  These timers should appear to
631  * be in the timer list with an expiry as if we were to requeue them
632  * now.
633  *
634  * The second issue is the SIGEV_NONE timer which may be active but is
635  * not really ever put in the timer list (to save system resources).
636  * This timer may be expired, and if so, we will do it here.  Otherwise
637  * it is the same as a requeue pending timer WRT to what we should
638  * report.
639  */
640 static void
641 common_timer_get(struct k_itimer *timr, struct itimerspec64 *cur_setting)
642 {
643         const struct k_clock *kc = timr->kclock;
644         ktime_t now, remaining, iv;
645         struct timespec64 ts64;
646         bool sig_none;
647
648         memset(cur_setting, 0, sizeof(*cur_setting));
649
650         sig_none = (timr->it_sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_NONE;
651         iv = timr->it_interval;
652
653         /* interval timer ? */
654         if (iv) {
655                 cur_setting->it_interval = ktime_to_timespec64(iv);
656         } else if (!timr->it_active) {
657                 /*
658                  * SIGEV_NONE oneshot timers are never queued. Check them
659                  * below.
660                  */
661                 if (!sig_none)
662                         return;
663         }
664
665         /*
666          * The timespec64 based conversion is suboptimal, but it's not
667          * worth to implement yet another callback.
668          */
669         kc->clock_get(timr->it_clock, &ts64);
670         now = timespec64_to_ktime(ts64);
671
672         /*
673          * When a requeue is pending or this is a SIGEV_NONE timer move the
674          * expiry time forward by intervals, so expiry is > now.
675          */
676         if (iv && (timr->it_requeue_pending & REQUEUE_PENDING || sig_none))
677                 timr->it_overrun += kc->timer_forward(timr, now);
678
679         remaining = kc->timer_remaining(timr, now);
680         /* Return 0 only, when the timer is expired and not pending */
681         if (remaining <= 0) {
682                 /*
683                  * A single shot SIGEV_NONE timer must return 0, when
684                  * it is expired !
685                  */
686                 if (!sig_none)
687                         cur_setting->it_value.tv_nsec = 1;
688         } else {
689                 cur_setting->it_value = ktime_to_timespec64(remaining);
690         }
691 }
692
693 /* Get the time remaining on a POSIX.1b interval timer. */
694 SYSCALL_DEFINE2(timer_gettime, timer_t, timer_id,
695                 struct itimerspec __user *, setting)
696 {
697         struct itimerspec64 cur_setting64;
698         struct itimerspec cur_setting;
699         struct k_itimer *timr;
700         const struct k_clock *kc;
701         unsigned long flags;
702         int ret = 0;
703
704         timr = lock_timer(timer_id, &flags);
705         if (!timr)
706                 return -EINVAL;
707
708         kc = timr->kclock;
709         if (WARN_ON_ONCE(!kc || !kc->timer_get))
710                 ret = -EINVAL;
711         else
712                 kc->timer_get(timr, &cur_setting64);
713
714         unlock_timer(timr, flags);
715
716         cur_setting = itimerspec64_to_itimerspec(&cur_setting64);
717         if (!ret && copy_to_user(setting, &cur_setting, sizeof (cur_setting)))
718                 return -EFAULT;
719
720         return ret;
721 }
722
723 /*
724  * Get the number of overruns of a POSIX.1b interval timer.  This is to
725  * be the overrun of the timer last delivered.  At the same time we are
726  * accumulating overruns on the next timer.  The overrun is frozen when
727  * the signal is delivered, either at the notify time (if the info block
728  * is not queued) or at the actual delivery time (as we are informed by
729  * the call back to posixtimer_rearm().  So all we need to do is
730  * to pick up the frozen overrun.
731  */
732 SYSCALL_DEFINE1(timer_getoverrun, timer_t, timer_id)
733 {
734         struct k_itimer *timr;
735         int overrun;
736         unsigned long flags;
737
738         timr = lock_timer(timer_id, &flags);
739         if (!timr)
740                 return -EINVAL;
741
742         overrun = timr->it_overrun_last;
743         unlock_timer(timr, flags);
744
745         return overrun;
746 }
747
748 /* Set a POSIX.1b interval timer. */
749 /* timr->it_lock is taken. */
750 static int
751 common_timer_set(struct k_itimer *timr, int flags,
752                  struct itimerspec64 *new_setting, struct itimerspec64 *old_setting)
753 {
754         struct hrtimer *timer = &timr->it.real.timer;
755         enum hrtimer_mode mode;
756
757         if (old_setting)
758                 common_timer_get(timr, old_setting);
759
760         /* disable the timer */
761         timr->it_interval = 0;
762         /*
763          * careful here.  If smp we could be in the "fire" routine which will
764          * be spinning as we hold the lock.  But this is ONLY an SMP issue.
765          */
766         if (hrtimer_try_to_cancel(timer) < 0)
767                 return TIMER_RETRY;
768
769         timr->it_active = 0;
770         timr->it_requeue_pending = (timr->it_requeue_pending + 2) &
771                 ~REQUEUE_PENDING;
772         timr->it_overrun_last = 0;
773
774         /* switch off the timer when it_value is zero */
775         if (!new_setting->it_value.tv_sec && !new_setting->it_value.tv_nsec)
776                 return 0;
777
778         mode = flags & TIMER_ABSTIME ? HRTIMER_MODE_ABS : HRTIMER_MODE_REL;
779         hrtimer_init(&timr->it.real.timer, timr->it_clock, mode);
780         timr->it.real.timer.function = posix_timer_fn;
781
782         hrtimer_set_expires(timer, timespec64_to_ktime(new_setting->it_value));
783
784         /* Convert interval */
785         timr->it_interval = timespec64_to_ktime(new_setting->it_interval);
786
787         /* SIGEV_NONE timers are not queued ! See common_timer_get */
788         if (((timr->it_sigev_notify & ~SIGEV_THREAD_ID) == SIGEV_NONE)) {
789                 /* Setup correct expiry time for relative timers */
790                 if (mode == HRTIMER_MODE_REL) {
791                         hrtimer_add_expires(timer, timer->base->get_time());
792                 }
793                 return 0;
794         }
795
796         timr->it_active = 1;
797         hrtimer_start_expires(timer, mode);
798         return 0;
799 }
800
801 /* Set a POSIX.1b interval timer */
802 SYSCALL_DEFINE4(timer_settime, timer_t, timer_id, int, flags,
803                 const struct itimerspec __user *, new_setting,
804                 struct itimerspec __user *, old_setting)
805 {
806         struct itimerspec64 new_spec64, old_spec64;
807         struct itimerspec64 *rtn = old_setting ? &old_spec64 : NULL;
808         struct itimerspec new_spec, old_spec;
809         struct k_itimer *timr;
810         unsigned long flag;
811         const struct k_clock *kc;
812         int error = 0;
813
814         if (!new_setting)
815                 return -EINVAL;
816
817         if (copy_from_user(&new_spec, new_setting, sizeof (new_spec)))
818                 return -EFAULT;
819         new_spec64 = itimerspec_to_itimerspec64(&new_spec);
820
821         if (!timespec64_valid(&new_spec64.it_interval) ||
822             !timespec64_valid(&new_spec64.it_value))
823                 return -EINVAL;
824 retry:
825         timr = lock_timer(timer_id, &flag);
826         if (!timr)
827                 return -EINVAL;
828
829         kc = timr->kclock;
830         if (WARN_ON_ONCE(!kc || !kc->timer_set))
831                 error = -EINVAL;
832         else
833                 error = kc->timer_set(timr, flags, &new_spec64, rtn);
834
835         unlock_timer(timr, flag);
836         if (error == TIMER_RETRY) {
837                 rtn = NULL;     // We already got the old time...
838                 goto retry;
839         }
840
841         old_spec = itimerspec64_to_itimerspec(&old_spec64);
842         if (old_setting && !error &&
843             copy_to_user(old_setting, &old_spec, sizeof (old_spec)))
844                 error = -EFAULT;
845
846         return error;
847 }
848
849 static int common_timer_del(struct k_itimer *timer)
850 {
851         timer->it_interval = 0;
852
853         if (hrtimer_try_to_cancel(&timer->it.real.timer) < 0)
854                 return TIMER_RETRY;
855         timer->it_active = 0;
856         return 0;
857 }
858
859 static inline int timer_delete_hook(struct k_itimer *timer)
860 {
861         const struct k_clock *kc = timer->kclock;
862
863         if (WARN_ON_ONCE(!kc || !kc->timer_del))
864                 return -EINVAL;
865         return kc->timer_del(timer);
866 }
867
868 /* Delete a POSIX.1b interval timer. */
869 SYSCALL_DEFINE1(timer_delete, timer_t, timer_id)
870 {
871         struct k_itimer *timer;
872         unsigned long flags;
873
874 retry_delete:
875         timer = lock_timer(timer_id, &flags);
876         if (!timer)
877                 return -EINVAL;
878
879         if (timer_delete_hook(timer) == TIMER_RETRY) {
880                 unlock_timer(timer, flags);
881                 goto retry_delete;
882         }
883
884         spin_lock(&current->sighand->siglock);
885         list_del(&timer->list);
886         spin_unlock(&current->sighand->siglock);
887         /*
888          * This keeps any tasks waiting on the spin lock from thinking
889          * they got something (see the lock code above).
890          */
891         timer->it_signal = NULL;
892
893         unlock_timer(timer, flags);
894         release_posix_timer(timer, IT_ID_SET);
895         return 0;
896 }
897
898 /*
899  * return timer owned by the process, used by exit_itimers
900  */
901 static void itimer_delete(struct k_itimer *timer)
902 {
903         unsigned long flags;
904
905 retry_delete:
906         spin_lock_irqsave(&timer->it_lock, flags);
907
908         if (timer_delete_hook(timer) == TIMER_RETRY) {
909                 unlock_timer(timer, flags);
910                 goto retry_delete;
911         }
912         list_del(&timer->list);
913         /*
914          * This keeps any tasks waiting on the spin lock from thinking
915          * they got something (see the lock code above).
916          */
917         timer->it_signal = NULL;
918
919         unlock_timer(timer, flags);
920         release_posix_timer(timer, IT_ID_SET);
921 }
922
923 /*
924  * This is called by do_exit or de_thread, only when there are no more
925  * references to the shared signal_struct.
926  */
927 void exit_itimers(struct signal_struct *sig)
928 {
929         struct k_itimer *tmr;
930
931         while (!list_empty(&sig->posix_timers)) {
932                 tmr = list_entry(sig->posix_timers.next, struct k_itimer, list);
933                 itimer_delete(tmr);
934         }
935 }
936
937 SYSCALL_DEFINE2(clock_settime, const clockid_t, which_clock,
938                 const struct timespec __user *, tp)
939 {
940         const struct k_clock *kc = clockid_to_kclock(which_clock);
941         struct timespec64 new_tp64;
942         struct timespec new_tp;
943
944         if (!kc || !kc->clock_set)
945                 return -EINVAL;
946
947         if (copy_from_user(&new_tp, tp, sizeof (*tp)))
948                 return -EFAULT;
949         new_tp64 = timespec_to_timespec64(new_tp);
950
951         return kc->clock_set(which_clock, &new_tp64);
952 }
953
954 SYSCALL_DEFINE2(clock_gettime, const clockid_t, which_clock,
955                 struct timespec __user *,tp)
956 {
957         const struct k_clock *kc = clockid_to_kclock(which_clock);
958         struct timespec64 kernel_tp64;
959         struct timespec kernel_tp;
960         int error;
961
962         if (!kc)
963                 return -EINVAL;
964
965         error = kc->clock_get(which_clock, &kernel_tp64);
966         kernel_tp = timespec64_to_timespec(kernel_tp64);
967
968         if (!error && copy_to_user(tp, &kernel_tp, sizeof (kernel_tp)))
969                 error = -EFAULT;
970
971         return error;
972 }
973
974 SYSCALL_DEFINE2(clock_adjtime, const clockid_t, which_clock,
975                 struct timex __user *, utx)
976 {
977         const struct k_clock *kc = clockid_to_kclock(which_clock);
978         struct timex ktx;
979         int err;
980
981         if (!kc)
982                 return -EINVAL;
983         if (!kc->clock_adj)
984                 return -EOPNOTSUPP;
985
986         if (copy_from_user(&ktx, utx, sizeof(ktx)))
987                 return -EFAULT;
988
989         err = kc->clock_adj(which_clock, &ktx);
990
991         if (err >= 0 && copy_to_user(utx, &ktx, sizeof(ktx)))
992                 return -EFAULT;
993
994         return err;
995 }
996
997 SYSCALL_DEFINE2(clock_getres, const clockid_t, which_clock,
998                 struct timespec __user *, tp)
999 {
1000         const struct k_clock *kc = clockid_to_kclock(which_clock);
1001         struct timespec64 rtn_tp64;
1002         struct timespec rtn_tp;
1003         int error;
1004
1005         if (!kc)
1006                 return -EINVAL;
1007
1008         error = kc->clock_getres(which_clock, &rtn_tp64);
1009         rtn_tp = timespec64_to_timespec(rtn_tp64);
1010
1011         if (!error && tp && copy_to_user(tp, &rtn_tp, sizeof (rtn_tp)))
1012                 error = -EFAULT;
1013
1014         return error;
1015 }
1016
1017 /*
1018  * nanosleep for monotonic and realtime clocks
1019  */
1020 static int common_nsleep(const clockid_t which_clock, int flags,
1021                          struct timespec64 *tsave, struct timespec __user *rmtp)
1022 {
1023         return hrtimer_nanosleep(tsave, rmtp, flags & TIMER_ABSTIME ?
1024                                  HRTIMER_MODE_ABS : HRTIMER_MODE_REL,
1025                                  which_clock);
1026 }
1027
1028 SYSCALL_DEFINE4(clock_nanosleep, const clockid_t, which_clock, int, flags,
1029                 const struct timespec __user *, rqtp,
1030                 struct timespec __user *, rmtp)
1031 {
1032         const struct k_clock *kc = clockid_to_kclock(which_clock);
1033         struct timespec64 t64;
1034         struct timespec t;
1035
1036         if (!kc)
1037                 return -EINVAL;
1038         if (!kc->nsleep)
1039                 return -ENANOSLEEP_NOTSUP;
1040
1041         if (copy_from_user(&t, rqtp, sizeof (struct timespec)))
1042                 return -EFAULT;
1043
1044         t64 = timespec_to_timespec64(t);
1045         if (!timespec64_valid(&t64))
1046                 return -EINVAL;
1047
1048         return kc->nsleep(which_clock, flags, &t64, rmtp);
1049 }
1050
1051 /*
1052  * This will restart clock_nanosleep. This is required only by
1053  * compat_clock_nanosleep_restart for now.
1054  */
1055 long clock_nanosleep_restart(struct restart_block *restart_block)
1056 {
1057         clockid_t which_clock = restart_block->nanosleep.clockid;
1058         const struct k_clock *kc = clockid_to_kclock(which_clock);
1059
1060         if (WARN_ON_ONCE(!kc || !kc->nsleep_restart))
1061                 return -EINVAL;
1062
1063         return kc->nsleep_restart(restart_block);
1064 }
1065
1066 static const struct k_clock clock_realtime = {
1067         .clock_getres   = posix_get_hrtimer_res,
1068         .clock_get      = posix_clock_realtime_get,
1069         .clock_set      = posix_clock_realtime_set,
1070         .clock_adj      = posix_clock_realtime_adj,
1071         .nsleep         = common_nsleep,
1072         .nsleep_restart = hrtimer_nanosleep_restart,
1073         .timer_create   = common_timer_create,
1074         .timer_set      = common_timer_set,
1075         .timer_get      = common_timer_get,
1076         .timer_del      = common_timer_del,
1077         .timer_rearm    = common_hrtimer_rearm,
1078         .timer_forward  = common_hrtimer_forward,
1079         .timer_remaining= common_hrtimer_remaining,
1080 };
1081
1082 static const struct k_clock clock_monotonic = {
1083         .clock_getres   = posix_get_hrtimer_res,
1084         .clock_get      = posix_ktime_get_ts,
1085         .nsleep         = common_nsleep,
1086         .nsleep_restart = hrtimer_nanosleep_restart,
1087         .timer_create   = common_timer_create,
1088         .timer_set      = common_timer_set,
1089         .timer_get      = common_timer_get,
1090         .timer_del      = common_timer_del,
1091         .timer_rearm    = common_hrtimer_rearm,
1092         .timer_forward  = common_hrtimer_forward,
1093         .timer_remaining= common_hrtimer_remaining,
1094 };
1095
1096 static const struct k_clock clock_monotonic_raw = {
1097         .clock_getres   = posix_get_hrtimer_res,
1098         .clock_get      = posix_get_monotonic_raw,
1099 };
1100
1101 static const struct k_clock clock_realtime_coarse = {
1102         .clock_getres   = posix_get_coarse_res,
1103         .clock_get      = posix_get_realtime_coarse,
1104 };
1105
1106 static const struct k_clock clock_monotonic_coarse = {
1107         .clock_getres   = posix_get_coarse_res,
1108         .clock_get      = posix_get_monotonic_coarse,
1109 };
1110
1111 static const struct k_clock clock_tai = {
1112         .clock_getres   = posix_get_hrtimer_res,
1113         .clock_get      = posix_get_tai,
1114         .nsleep         = common_nsleep,
1115         .nsleep_restart = hrtimer_nanosleep_restart,
1116         .timer_create   = common_timer_create,
1117         .timer_set      = common_timer_set,
1118         .timer_get      = common_timer_get,
1119         .timer_del      = common_timer_del,
1120         .timer_rearm    = common_hrtimer_rearm,
1121         .timer_forward  = common_hrtimer_forward,
1122         .timer_remaining= common_hrtimer_remaining,
1123 };
1124
1125 static const struct k_clock clock_boottime = {
1126         .clock_getres   = posix_get_hrtimer_res,
1127         .clock_get      = posix_get_boottime,
1128         .nsleep         = common_nsleep,
1129         .nsleep_restart = hrtimer_nanosleep_restart,
1130         .timer_create   = common_timer_create,
1131         .timer_set      = common_timer_set,
1132         .timer_get      = common_timer_get,
1133         .timer_del      = common_timer_del,
1134         .timer_rearm    = common_hrtimer_rearm,
1135         .timer_forward  = common_hrtimer_forward,
1136         .timer_remaining= common_hrtimer_remaining,
1137 };
1138
1139 static const struct k_clock * const posix_clocks[] = {
1140         [CLOCK_REALTIME]                = &clock_realtime,
1141         [CLOCK_MONOTONIC]               = &clock_monotonic,
1142         [CLOCK_PROCESS_CPUTIME_ID]      = &clock_process,
1143         [CLOCK_THREAD_CPUTIME_ID]       = &clock_thread,
1144         [CLOCK_MONOTONIC_RAW]           = &clock_monotonic_raw,
1145         [CLOCK_REALTIME_COARSE]         = &clock_realtime_coarse,
1146         [CLOCK_MONOTONIC_COARSE]        = &clock_monotonic_coarse,
1147         [CLOCK_BOOTTIME]                = &clock_boottime,
1148         [CLOCK_REALTIME_ALARM]          = &alarm_clock,
1149         [CLOCK_BOOTTIME_ALARM]          = &alarm_clock,
1150         [CLOCK_TAI]                     = &clock_tai,
1151 };
1152
1153 static const struct k_clock *clockid_to_kclock(const clockid_t id)
1154 {
1155         if (id < 0)
1156                 return (id & CLOCKFD_MASK) == CLOCKFD ?
1157                         &clock_posix_dynamic : &clock_posix_cpu;
1158
1159         if (id >= ARRAY_SIZE(posix_clocks) || !posix_clocks[id])
1160                 return NULL;
1161         return posix_clocks[id];
1162 }