posix-timers: Convert timer_delete() to clockid_to_kclock()
[linux-3.10.git] / kernel / 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
39 #include <asm/uaccess.h>
40 #include <linux/list.h>
41 #include <linux/init.h>
42 #include <linux/compiler.h>
43 #include <linux/idr.h>
44 #include <linux/posix-timers.h>
45 #include <linux/syscalls.h>
46 #include <linux/wait.h>
47 #include <linux/workqueue.h>
48 #include <linux/module.h>
49
50 /*
51  * Management arrays for POSIX timers.   Timers are kept in slab memory
52  * Timer ids are allocated by an external routine that keeps track of the
53  * id and the timer.  The external interface is:
54  *
55  * void *idr_find(struct idr *idp, int id);           to find timer_id <id>
56  * int idr_get_new(struct idr *idp, void *ptr);       to get a new id and
57  *                                                    related it to <ptr>
58  * void idr_remove(struct idr *idp, int id);          to release <id>
59  * void idr_init(struct idr *idp);                    to initialize <idp>
60  *                                                    which we supply.
61  * The idr_get_new *may* call slab for more memory so it must not be
62  * called under a spin lock.  Likewise idr_remore may release memory
63  * (but it may be ok to do this under a lock...).
64  * idr_find is just a memory look up and is quite fast.  A -1 return
65  * indicates that the requested id does not exist.
66  */
67
68 /*
69  * Lets keep our timers in a slab cache :-)
70  */
71 static struct kmem_cache *posix_timers_cache;
72 static struct idr posix_timers_id;
73 static DEFINE_SPINLOCK(idr_lock);
74
75 /*
76  * we assume that the new SIGEV_THREAD_ID shares no bits with the other
77  * SIGEV values.  Here we put out an error if this assumption fails.
78  */
79 #if SIGEV_THREAD_ID != (SIGEV_THREAD_ID & \
80                        ~(SIGEV_SIGNAL | SIGEV_NONE | SIGEV_THREAD))
81 #error "SIGEV_THREAD_ID must not share bit with other SIGEV values!"
82 #endif
83
84 /*
85  * parisc wants ENOTSUP instead of EOPNOTSUPP
86  */
87 #ifndef ENOTSUP
88 # define ENANOSLEEP_NOTSUP EOPNOTSUPP
89 #else
90 # define ENANOSLEEP_NOTSUP ENOTSUP
91 #endif
92
93 /*
94  * The timer ID is turned into a timer address by idr_find().
95  * Verifying a valid ID consists of:
96  *
97  * a) checking that idr_find() returns other than -1.
98  * b) checking that the timer id matches the one in the timer itself.
99  * c) that the timer owner is in the callers thread group.
100  */
101
102 /*
103  * CLOCKs: The POSIX standard calls for a couple of clocks and allows us
104  *          to implement others.  This structure defines the various
105  *          clocks and allows the possibility of adding others.  We
106  *          provide an interface to add clocks to the table and expect
107  *          the "arch" code to add at least one clock that is high
108  *          resolution.  Here we define the standard CLOCK_REALTIME as a
109  *          1/HZ resolution clock.
110  *
111  * RESOLUTION: Clock resolution is used to round up timer and interval
112  *          times, NOT to report clock times, which are reported with as
113  *          much resolution as the system can muster.  In some cases this
114  *          resolution may depend on the underlying clock hardware and
115  *          may not be quantifiable until run time, and only then is the
116  *          necessary code is written.  The standard says we should say
117  *          something about this issue in the documentation...
118  *
119  * FUNCTIONS: The CLOCKs structure defines possible functions to handle
120  *          various clock functions.  For clocks that use the standard
121  *          system timer code these entries should be NULL.  This will
122  *          allow dispatch without the overhead of indirect function
123  *          calls.  CLOCKS that depend on other sources (e.g. WWV or GPS)
124  *          must supply functions here, even if the function just returns
125  *          ENOSYS.  The standard POSIX timer management code assumes the
126  *          following: 1.) The k_itimer struct (sched.h) is used for the
127  *          timer.  2.) The list, it_lock, it_clock, it_id and it_pid
128  *          fields are not modified by timer code.
129  *
130  *          At this time all functions EXCEPT clock_nanosleep can be
131  *          redirected by the CLOCKS structure.  Clock_nanosleep is in
132  *          there, but the code ignores it.
133  *
134  * Permissions: It is assumed that the clock_settime() function defined
135  *          for each clock will take care of permission checks.  Some
136  *          clocks may be set able by any user (i.e. local process
137  *          clocks) others not.  Currently the only set able clock we
138  *          have is CLOCK_REALTIME and its high res counter part, both of
139  *          which we beg off on and pass to do_sys_settimeofday().
140  */
141
142 static struct k_clock posix_clocks[MAX_CLOCKS];
143
144 /*
145  * These ones are defined below.
146  */
147 static int common_nsleep(const clockid_t, int flags, struct timespec *t,
148                          struct timespec __user *rmtp);
149 static int common_timer_create(struct k_itimer *new_timer);
150 static void common_timer_get(struct k_itimer *, struct itimerspec *);
151 static int common_timer_set(struct k_itimer *, int,
152                             struct itimerspec *, struct itimerspec *);
153 static int common_timer_del(struct k_itimer *timer);
154
155 static enum hrtimer_restart posix_timer_fn(struct hrtimer *data);
156
157 static struct k_itimer *__lock_timer(timer_t timer_id, unsigned long *flags);
158
159 #define lock_timer(tid, flags)                                             \
160 ({      struct k_itimer *__timr;                                           \
161         __cond_lock(&__timr->it_lock, __timr = __lock_timer(tid, flags));  \
162         __timr;                                                            \
163 })
164
165 static inline void unlock_timer(struct k_itimer *timr, unsigned long flags)
166 {
167         spin_unlock_irqrestore(&timr->it_lock, flags);
168 }
169
170 /*
171  * Call the k_clock hook function if non-null, or the default function.
172  */
173 #define CLOCK_DISPATCH(clock, call, arglist) \
174         ((clock) < 0 ? posix_cpu_##call arglist : \
175          (posix_clocks[clock].call != NULL \
176           ? (*posix_clocks[clock].call) arglist : common_##call arglist))
177
178 /*
179  * Return nonzero if we know a priori this clockid_t value is bogus.
180  */
181 static inline int invalid_clockid(const clockid_t which_clock)
182 {
183         if (which_clock < 0)    /* CPU clock, posix_cpu_* will check it */
184                 return 0;
185         if ((unsigned) which_clock >= MAX_CLOCKS)
186                 return 1;
187         if (posix_clocks[which_clock].clock_getres != NULL)
188                 return 0;
189         return 1;
190 }
191
192 /* Get clock_realtime */
193 static int posix_clock_realtime_get(clockid_t which_clock, struct timespec *tp)
194 {
195         ktime_get_real_ts(tp);
196         return 0;
197 }
198
199 /* Set clock_realtime */
200 static int posix_clock_realtime_set(const clockid_t which_clock,
201                                     const struct timespec *tp)
202 {
203         return do_sys_settimeofday(tp, NULL);
204 }
205
206 /*
207  * Get monotonic time for posix timers
208  */
209 static int posix_ktime_get_ts(clockid_t which_clock, struct timespec *tp)
210 {
211         ktime_get_ts(tp);
212         return 0;
213 }
214
215 /*
216  * Get monotonic time for posix timers
217  */
218 static int posix_get_monotonic_raw(clockid_t which_clock, struct timespec *tp)
219 {
220         getrawmonotonic(tp);
221         return 0;
222 }
223
224
225 static int posix_get_realtime_coarse(clockid_t which_clock, struct timespec *tp)
226 {
227         *tp = current_kernel_time();
228         return 0;
229 }
230
231 static int posix_get_monotonic_coarse(clockid_t which_clock,
232                                                 struct timespec *tp)
233 {
234         *tp = get_monotonic_coarse();
235         return 0;
236 }
237
238 static int posix_get_coarse_res(const clockid_t which_clock, struct timespec *tp)
239 {
240         *tp = ktime_to_timespec(KTIME_LOW_RES);
241         return 0;
242 }
243 /*
244  * Initialize everything, well, just everything in Posix clocks/timers ;)
245  */
246 static __init int init_posix_timers(void)
247 {
248         struct k_clock clock_realtime = {
249                 .clock_getres   = hrtimer_get_res,
250                 .clock_get      = posix_clock_realtime_get,
251                 .clock_set      = posix_clock_realtime_set,
252                 .nsleep         = common_nsleep,
253                 .nsleep_restart = hrtimer_nanosleep_restart,
254                 .timer_create   = common_timer_create,
255                 .timer_set      = common_timer_set,
256                 .timer_get      = common_timer_get,
257                 .timer_del      = common_timer_del,
258         };
259         struct k_clock clock_monotonic = {
260                 .clock_getres   = hrtimer_get_res,
261                 .clock_get      = posix_ktime_get_ts,
262                 .nsleep         = common_nsleep,
263                 .nsleep_restart = hrtimer_nanosleep_restart,
264                 .timer_create   = common_timer_create,
265                 .timer_set      = common_timer_set,
266                 .timer_get      = common_timer_get,
267                 .timer_del      = common_timer_del,
268         };
269         struct k_clock clock_monotonic_raw = {
270                 .clock_getres   = hrtimer_get_res,
271                 .clock_get      = posix_get_monotonic_raw,
272         };
273         struct k_clock clock_realtime_coarse = {
274                 .clock_getres   = posix_get_coarse_res,
275                 .clock_get      = posix_get_realtime_coarse,
276         };
277         struct k_clock clock_monotonic_coarse = {
278                 .clock_getres   = posix_get_coarse_res,
279                 .clock_get      = posix_get_monotonic_coarse,
280         };
281
282         register_posix_clock(CLOCK_REALTIME, &clock_realtime);
283         register_posix_clock(CLOCK_MONOTONIC, &clock_monotonic);
284         register_posix_clock(CLOCK_MONOTONIC_RAW, &clock_monotonic_raw);
285         register_posix_clock(CLOCK_REALTIME_COARSE, &clock_realtime_coarse);
286         register_posix_clock(CLOCK_MONOTONIC_COARSE, &clock_monotonic_coarse);
287
288         posix_timers_cache = kmem_cache_create("posix_timers_cache",
289                                         sizeof (struct k_itimer), 0, SLAB_PANIC,
290                                         NULL);
291         idr_init(&posix_timers_id);
292         return 0;
293 }
294
295 __initcall(init_posix_timers);
296
297 static void schedule_next_timer(struct k_itimer *timr)
298 {
299         struct hrtimer *timer = &timr->it.real.timer;
300
301         if (timr->it.real.interval.tv64 == 0)
302                 return;
303
304         timr->it_overrun += (unsigned int) hrtimer_forward(timer,
305                                                 timer->base->get_time(),
306                                                 timr->it.real.interval);
307
308         timr->it_overrun_last = timr->it_overrun;
309         timr->it_overrun = -1;
310         ++timr->it_requeue_pending;
311         hrtimer_restart(timer);
312 }
313
314 /*
315  * This function is exported for use by the signal deliver code.  It is
316  * called just prior to the info block being released and passes that
317  * block to us.  It's function is to update the overrun entry AND to
318  * restart the timer.  It should only be called if the timer is to be
319  * restarted (i.e. we have flagged this in the sys_private entry of the
320  * info block).
321  *
322  * To protect aginst the timer going away while the interrupt is queued,
323  * we require that the it_requeue_pending flag be set.
324  */
325 void do_schedule_next_timer(struct siginfo *info)
326 {
327         struct k_itimer *timr;
328         unsigned long flags;
329
330         timr = lock_timer(info->si_tid, &flags);
331
332         if (timr && timr->it_requeue_pending == info->si_sys_private) {
333                 if (timr->it_clock < 0)
334                         posix_cpu_timer_schedule(timr);
335                 else
336                         schedule_next_timer(timr);
337
338                 info->si_overrun += timr->it_overrun_last;
339         }
340
341         if (timr)
342                 unlock_timer(timr, flags);
343 }
344
345 int posix_timer_event(struct k_itimer *timr, int si_private)
346 {
347         struct task_struct *task;
348         int shared, ret = -1;
349         /*
350          * FIXME: if ->sigq is queued we can race with
351          * dequeue_signal()->do_schedule_next_timer().
352          *
353          * If dequeue_signal() sees the "right" value of
354          * si_sys_private it calls do_schedule_next_timer().
355          * We re-queue ->sigq and drop ->it_lock().
356          * do_schedule_next_timer() locks the timer
357          * and re-schedules it while ->sigq is pending.
358          * Not really bad, but not that we want.
359          */
360         timr->sigq->info.si_sys_private = si_private;
361
362         rcu_read_lock();
363         task = pid_task(timr->it_pid, PIDTYPE_PID);
364         if (task) {
365                 shared = !(timr->it_sigev_notify & SIGEV_THREAD_ID);
366                 ret = send_sigqueue(timr->sigq, task, shared);
367         }
368         rcu_read_unlock();
369         /* If we failed to send the signal the timer stops. */
370         return ret > 0;
371 }
372 EXPORT_SYMBOL_GPL(posix_timer_event);
373
374 /*
375  * This function gets called when a POSIX.1b interval timer expires.  It
376  * is used as a callback from the kernel internal timer.  The
377  * run_timer_list code ALWAYS calls with interrupts on.
378
379  * This code is for CLOCK_REALTIME* and CLOCK_MONOTONIC* timers.
380  */
381 static enum hrtimer_restart posix_timer_fn(struct hrtimer *timer)
382 {
383         struct k_itimer *timr;
384         unsigned long flags;
385         int si_private = 0;
386         enum hrtimer_restart ret = HRTIMER_NORESTART;
387
388         timr = container_of(timer, struct k_itimer, it.real.timer);
389         spin_lock_irqsave(&timr->it_lock, flags);
390
391         if (timr->it.real.interval.tv64 != 0)
392                 si_private = ++timr->it_requeue_pending;
393
394         if (posix_timer_event(timr, si_private)) {
395                 /*
396                  * signal was not sent because of sig_ignor
397                  * we will not get a call back to restart it AND
398                  * it should be restarted.
399                  */
400                 if (timr->it.real.interval.tv64 != 0) {
401                         ktime_t now = hrtimer_cb_get_time(timer);
402
403                         /*
404                          * FIXME: What we really want, is to stop this
405                          * timer completely and restart it in case the
406                          * SIG_IGN is removed. This is a non trivial
407                          * change which involves sighand locking
408                          * (sigh !), which we don't want to do late in
409                          * the release cycle.
410                          *
411                          * For now we just let timers with an interval
412                          * less than a jiffie expire every jiffie to
413                          * avoid softirq starvation in case of SIG_IGN
414                          * and a very small interval, which would put
415                          * the timer right back on the softirq pending
416                          * list. By moving now ahead of time we trick
417                          * hrtimer_forward() to expire the timer
418                          * later, while we still maintain the overrun
419                          * accuracy, but have some inconsistency in
420                          * the timer_gettime() case. This is at least
421                          * better than a starved softirq. A more
422                          * complex fix which solves also another related
423                          * inconsistency is already in the pipeline.
424                          */
425 #ifdef CONFIG_HIGH_RES_TIMERS
426                         {
427                                 ktime_t kj = ktime_set(0, NSEC_PER_SEC / HZ);
428
429                                 if (timr->it.real.interval.tv64 < kj.tv64)
430                                         now = ktime_add(now, kj);
431                         }
432 #endif
433                         timr->it_overrun += (unsigned int)
434                                 hrtimer_forward(timer, now,
435                                                 timr->it.real.interval);
436                         ret = HRTIMER_RESTART;
437                         ++timr->it_requeue_pending;
438                 }
439         }
440
441         unlock_timer(timr, flags);
442         return ret;
443 }
444
445 static struct pid *good_sigevent(sigevent_t * event)
446 {
447         struct task_struct *rtn = current->group_leader;
448
449         if ((event->sigev_notify & SIGEV_THREAD_ID ) &&
450                 (!(rtn = find_task_by_vpid(event->sigev_notify_thread_id)) ||
451                  !same_thread_group(rtn, current) ||
452                  (event->sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_SIGNAL))
453                 return NULL;
454
455         if (((event->sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_NONE) &&
456             ((event->sigev_signo <= 0) || (event->sigev_signo > SIGRTMAX)))
457                 return NULL;
458
459         return task_pid(rtn);
460 }
461
462 void register_posix_clock(const clockid_t clock_id, struct k_clock *new_clock)
463 {
464         if ((unsigned) clock_id >= MAX_CLOCKS) {
465                 printk(KERN_WARNING "POSIX clock register failed for clock_id %d\n",
466                        clock_id);
467                 return;
468         }
469
470         if (!new_clock->clock_get) {
471                 printk(KERN_WARNING "POSIX clock id %d lacks clock_get()\n",
472                        clock_id);
473                 return;
474         }
475         if (!new_clock->clock_getres) {
476                 printk(KERN_WARNING "POSIX clock id %d lacks clock_getres()\n",
477                        clock_id);
478                 return;
479         }
480
481         posix_clocks[clock_id] = *new_clock;
482 }
483 EXPORT_SYMBOL_GPL(register_posix_clock);
484
485 static struct k_itimer * alloc_posix_timer(void)
486 {
487         struct k_itimer *tmr;
488         tmr = kmem_cache_zalloc(posix_timers_cache, GFP_KERNEL);
489         if (!tmr)
490                 return tmr;
491         if (unlikely(!(tmr->sigq = sigqueue_alloc()))) {
492                 kmem_cache_free(posix_timers_cache, tmr);
493                 return NULL;
494         }
495         memset(&tmr->sigq->info, 0, sizeof(siginfo_t));
496         return tmr;
497 }
498
499 #define IT_ID_SET       1
500 #define IT_ID_NOT_SET   0
501 static void release_posix_timer(struct k_itimer *tmr, int it_id_set)
502 {
503         if (it_id_set) {
504                 unsigned long flags;
505                 spin_lock_irqsave(&idr_lock, flags);
506                 idr_remove(&posix_timers_id, tmr->it_id);
507                 spin_unlock_irqrestore(&idr_lock, flags);
508         }
509         put_pid(tmr->it_pid);
510         sigqueue_free(tmr->sigq);
511         kmem_cache_free(posix_timers_cache, tmr);
512 }
513
514 static struct k_clock *clockid_to_kclock(const clockid_t id)
515 {
516         if (id < 0)
517                 return &clock_posix_cpu;
518
519         if (id >= MAX_CLOCKS || !posix_clocks[id].clock_getres)
520                 return NULL;
521         return &posix_clocks[id];
522 }
523
524 static int common_timer_create(struct k_itimer *new_timer)
525 {
526         hrtimer_init(&new_timer->it.real.timer, new_timer->it_clock, 0);
527         return 0;
528 }
529
530 /* Create a POSIX.1b interval timer. */
531
532 SYSCALL_DEFINE3(timer_create, const clockid_t, which_clock,
533                 struct sigevent __user *, timer_event_spec,
534                 timer_t __user *, created_timer_id)
535 {
536         struct k_clock *kc = clockid_to_kclock(which_clock);
537         struct k_itimer *new_timer;
538         int error, new_timer_id;
539         sigevent_t event;
540         int it_id_set = IT_ID_NOT_SET;
541
542         if (!kc)
543                 return -EINVAL;
544         if (!kc->timer_create)
545                 return -EOPNOTSUPP;
546
547         new_timer = alloc_posix_timer();
548         if (unlikely(!new_timer))
549                 return -EAGAIN;
550
551         spin_lock_init(&new_timer->it_lock);
552  retry:
553         if (unlikely(!idr_pre_get(&posix_timers_id, GFP_KERNEL))) {
554                 error = -EAGAIN;
555                 goto out;
556         }
557         spin_lock_irq(&idr_lock);
558         error = idr_get_new(&posix_timers_id, new_timer, &new_timer_id);
559         spin_unlock_irq(&idr_lock);
560         if (error) {
561                 if (error == -EAGAIN)
562                         goto retry;
563                 /*
564                  * Weird looking, but we return EAGAIN if the IDR is
565                  * full (proper POSIX return value for this)
566                  */
567                 error = -EAGAIN;
568                 goto out;
569         }
570
571         it_id_set = IT_ID_SET;
572         new_timer->it_id = (timer_t) new_timer_id;
573         new_timer->it_clock = which_clock;
574         new_timer->it_overrun = -1;
575
576         if (timer_event_spec) {
577                 if (copy_from_user(&event, timer_event_spec, sizeof (event))) {
578                         error = -EFAULT;
579                         goto out;
580                 }
581                 rcu_read_lock();
582                 new_timer->it_pid = get_pid(good_sigevent(&event));
583                 rcu_read_unlock();
584                 if (!new_timer->it_pid) {
585                         error = -EINVAL;
586                         goto out;
587                 }
588         } else {
589                 event.sigev_notify = SIGEV_SIGNAL;
590                 event.sigev_signo = SIGALRM;
591                 event.sigev_value.sival_int = new_timer->it_id;
592                 new_timer->it_pid = get_pid(task_tgid(current));
593         }
594
595         new_timer->it_sigev_notify     = event.sigev_notify;
596         new_timer->sigq->info.si_signo = event.sigev_signo;
597         new_timer->sigq->info.si_value = event.sigev_value;
598         new_timer->sigq->info.si_tid   = new_timer->it_id;
599         new_timer->sigq->info.si_code  = SI_TIMER;
600
601         if (copy_to_user(created_timer_id,
602                          &new_timer_id, sizeof (new_timer_id))) {
603                 error = -EFAULT;
604                 goto out;
605         }
606
607         error = kc->timer_create(new_timer);
608         if (error)
609                 goto out;
610
611         spin_lock_irq(&current->sighand->siglock);
612         new_timer->it_signal = current->signal;
613         list_add(&new_timer->list, &current->signal->posix_timers);
614         spin_unlock_irq(&current->sighand->siglock);
615
616         return 0;
617         /*
618          * In the case of the timer belonging to another task, after
619          * the task is unlocked, the timer is owned by the other task
620          * and may cease to exist at any time.  Don't use or modify
621          * new_timer after the unlock call.
622          */
623 out:
624         release_posix_timer(new_timer, it_id_set);
625         return error;
626 }
627
628 /*
629  * Locking issues: We need to protect the result of the id look up until
630  * we get the timer locked down so it is not deleted under us.  The
631  * removal is done under the idr spinlock so we use that here to bridge
632  * the find to the timer lock.  To avoid a dead lock, the timer id MUST
633  * be release with out holding the timer lock.
634  */
635 static struct k_itimer *__lock_timer(timer_t timer_id, unsigned long *flags)
636 {
637         struct k_itimer *timr;
638         /*
639          * Watch out here.  We do a irqsave on the idr_lock and pass the
640          * flags part over to the timer lock.  Must not let interrupts in
641          * while we are moving the lock.
642          */
643         spin_lock_irqsave(&idr_lock, *flags);
644         timr = idr_find(&posix_timers_id, (int)timer_id);
645         if (timr) {
646                 spin_lock(&timr->it_lock);
647                 if (timr->it_signal == current->signal) {
648                         spin_unlock(&idr_lock);
649                         return timr;
650                 }
651                 spin_unlock(&timr->it_lock);
652         }
653         spin_unlock_irqrestore(&idr_lock, *flags);
654
655         return NULL;
656 }
657
658 /*
659  * Get the time remaining on a POSIX.1b interval timer.  This function
660  * is ALWAYS called with spin_lock_irq on the timer, thus it must not
661  * mess with irq.
662  *
663  * We have a couple of messes to clean up here.  First there is the case
664  * of a timer that has a requeue pending.  These timers should appear to
665  * be in the timer list with an expiry as if we were to requeue them
666  * now.
667  *
668  * The second issue is the SIGEV_NONE timer which may be active but is
669  * not really ever put in the timer list (to save system resources).
670  * This timer may be expired, and if so, we will do it here.  Otherwise
671  * it is the same as a requeue pending timer WRT to what we should
672  * report.
673  */
674 static void
675 common_timer_get(struct k_itimer *timr, struct itimerspec *cur_setting)
676 {
677         ktime_t now, remaining, iv;
678         struct hrtimer *timer = &timr->it.real.timer;
679
680         memset(cur_setting, 0, sizeof(struct itimerspec));
681
682         iv = timr->it.real.interval;
683
684         /* interval timer ? */
685         if (iv.tv64)
686                 cur_setting->it_interval = ktime_to_timespec(iv);
687         else if (!hrtimer_active(timer) &&
688                  (timr->it_sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_NONE)
689                 return;
690
691         now = timer->base->get_time();
692
693         /*
694          * When a requeue is pending or this is a SIGEV_NONE
695          * timer move the expiry time forward by intervals, so
696          * expiry is > now.
697          */
698         if (iv.tv64 && (timr->it_requeue_pending & REQUEUE_PENDING ||
699             (timr->it_sigev_notify & ~SIGEV_THREAD_ID) == SIGEV_NONE))
700                 timr->it_overrun += (unsigned int) hrtimer_forward(timer, now, iv);
701
702         remaining = ktime_sub(hrtimer_get_expires(timer), now);
703         /* Return 0 only, when the timer is expired and not pending */
704         if (remaining.tv64 <= 0) {
705                 /*
706                  * A single shot SIGEV_NONE timer must return 0, when
707                  * it is expired !
708                  */
709                 if ((timr->it_sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_NONE)
710                         cur_setting->it_value.tv_nsec = 1;
711         } else
712                 cur_setting->it_value = ktime_to_timespec(remaining);
713 }
714
715 /* Get the time remaining on a POSIX.1b interval timer. */
716 SYSCALL_DEFINE2(timer_gettime, timer_t, timer_id,
717                 struct itimerspec __user *, setting)
718 {
719         struct itimerspec cur_setting;
720         struct k_itimer *timr;
721         struct k_clock *kc;
722         unsigned long flags;
723         int ret = 0;
724
725         timr = lock_timer(timer_id, &flags);
726         if (!timr)
727                 return -EINVAL;
728
729         kc = clockid_to_kclock(timr->it_clock);
730         if (WARN_ON_ONCE(!kc || !kc->timer_get))
731                 ret = -EINVAL;
732         else
733                 kc->timer_get(timr, &cur_setting);
734
735         unlock_timer(timr, flags);
736
737         if (!ret && copy_to_user(setting, &cur_setting, sizeof (cur_setting)))
738                 return -EFAULT;
739
740         return ret;
741 }
742
743 /*
744  * Get the number of overruns of a POSIX.1b interval timer.  This is to
745  * be the overrun of the timer last delivered.  At the same time we are
746  * accumulating overruns on the next timer.  The overrun is frozen when
747  * the signal is delivered, either at the notify time (if the info block
748  * is not queued) or at the actual delivery time (as we are informed by
749  * the call back to do_schedule_next_timer().  So all we need to do is
750  * to pick up the frozen overrun.
751  */
752 SYSCALL_DEFINE1(timer_getoverrun, timer_t, timer_id)
753 {
754         struct k_itimer *timr;
755         int overrun;
756         unsigned long flags;
757
758         timr = lock_timer(timer_id, &flags);
759         if (!timr)
760                 return -EINVAL;
761
762         overrun = timr->it_overrun_last;
763         unlock_timer(timr, flags);
764
765         return overrun;
766 }
767
768 /* Set a POSIX.1b interval timer. */
769 /* timr->it_lock is taken. */
770 static int
771 common_timer_set(struct k_itimer *timr, int flags,
772                  struct itimerspec *new_setting, struct itimerspec *old_setting)
773 {
774         struct hrtimer *timer = &timr->it.real.timer;
775         enum hrtimer_mode mode;
776
777         if (old_setting)
778                 common_timer_get(timr, old_setting);
779
780         /* disable the timer */
781         timr->it.real.interval.tv64 = 0;
782         /*
783          * careful here.  If smp we could be in the "fire" routine which will
784          * be spinning as we hold the lock.  But this is ONLY an SMP issue.
785          */
786         if (hrtimer_try_to_cancel(timer) < 0)
787                 return TIMER_RETRY;
788
789         timr->it_requeue_pending = (timr->it_requeue_pending + 2) & 
790                 ~REQUEUE_PENDING;
791         timr->it_overrun_last = 0;
792
793         /* switch off the timer when it_value is zero */
794         if (!new_setting->it_value.tv_sec && !new_setting->it_value.tv_nsec)
795                 return 0;
796
797         mode = flags & TIMER_ABSTIME ? HRTIMER_MODE_ABS : HRTIMER_MODE_REL;
798         hrtimer_init(&timr->it.real.timer, timr->it_clock, mode);
799         timr->it.real.timer.function = posix_timer_fn;
800
801         hrtimer_set_expires(timer, timespec_to_ktime(new_setting->it_value));
802
803         /* Convert interval */
804         timr->it.real.interval = timespec_to_ktime(new_setting->it_interval);
805
806         /* SIGEV_NONE timers are not queued ! See common_timer_get */
807         if (((timr->it_sigev_notify & ~SIGEV_THREAD_ID) == SIGEV_NONE)) {
808                 /* Setup correct expiry time for relative timers */
809                 if (mode == HRTIMER_MODE_REL) {
810                         hrtimer_add_expires(timer, timer->base->get_time());
811                 }
812                 return 0;
813         }
814
815         hrtimer_start_expires(timer, mode);
816         return 0;
817 }
818
819 /* Set a POSIX.1b interval timer */
820 SYSCALL_DEFINE4(timer_settime, timer_t, timer_id, int, flags,
821                 const struct itimerspec __user *, new_setting,
822                 struct itimerspec __user *, old_setting)
823 {
824         struct k_itimer *timr;
825         struct itimerspec new_spec, old_spec;
826         int error = 0;
827         unsigned long flag;
828         struct itimerspec *rtn = old_setting ? &old_spec : NULL;
829         struct k_clock *kc;
830
831         if (!new_setting)
832                 return -EINVAL;
833
834         if (copy_from_user(&new_spec, new_setting, sizeof (new_spec)))
835                 return -EFAULT;
836
837         if (!timespec_valid(&new_spec.it_interval) ||
838             !timespec_valid(&new_spec.it_value))
839                 return -EINVAL;
840 retry:
841         timr = lock_timer(timer_id, &flag);
842         if (!timr)
843                 return -EINVAL;
844
845         kc = clockid_to_kclock(timr->it_clock);
846         if (WARN_ON_ONCE(!kc || !kc->timer_set))
847                 error = -EINVAL;
848         else
849                 error = kc->timer_set(timr, flags, &new_spec, rtn);
850
851         unlock_timer(timr, flag);
852         if (error == TIMER_RETRY) {
853                 rtn = NULL;     // We already got the old time...
854                 goto retry;
855         }
856
857         if (old_setting && !error &&
858             copy_to_user(old_setting, &old_spec, sizeof (old_spec)))
859                 error = -EFAULT;
860
861         return error;
862 }
863
864 static int common_timer_del(struct k_itimer *timer)
865 {
866         timer->it.real.interval.tv64 = 0;
867
868         if (hrtimer_try_to_cancel(&timer->it.real.timer) < 0)
869                 return TIMER_RETRY;
870         return 0;
871 }
872
873 static inline int timer_delete_hook(struct k_itimer *timer)
874 {
875         struct k_clock *kc = clockid_to_kclock(timer->it_clock);
876
877         if (WARN_ON_ONCE(!kc || !kc->timer_del))
878                 return -EINVAL;
879         return kc->timer_del(timer);
880 }
881
882 /* Delete a POSIX.1b interval timer. */
883 SYSCALL_DEFINE1(timer_delete, timer_t, timer_id)
884 {
885         struct k_itimer *timer;
886         unsigned long flags;
887
888 retry_delete:
889         timer = lock_timer(timer_id, &flags);
890         if (!timer)
891                 return -EINVAL;
892
893         if (timer_delete_hook(timer) == TIMER_RETRY) {
894                 unlock_timer(timer, flags);
895                 goto retry_delete;
896         }
897
898         spin_lock(&current->sighand->siglock);
899         list_del(&timer->list);
900         spin_unlock(&current->sighand->siglock);
901         /*
902          * This keeps any tasks waiting on the spin lock from thinking
903          * they got something (see the lock code above).
904          */
905         timer->it_signal = NULL;
906
907         unlock_timer(timer, flags);
908         release_posix_timer(timer, IT_ID_SET);
909         return 0;
910 }
911
912 /*
913  * return timer owned by the process, used by exit_itimers
914  */
915 static void itimer_delete(struct k_itimer *timer)
916 {
917         unsigned long flags;
918
919 retry_delete:
920         spin_lock_irqsave(&timer->it_lock, flags);
921
922         if (timer_delete_hook(timer) == TIMER_RETRY) {
923                 unlock_timer(timer, flags);
924                 goto retry_delete;
925         }
926         list_del(&timer->list);
927         /*
928          * This keeps any tasks waiting on the spin lock from thinking
929          * they got something (see the lock code above).
930          */
931         timer->it_signal = NULL;
932
933         unlock_timer(timer, flags);
934         release_posix_timer(timer, IT_ID_SET);
935 }
936
937 /*
938  * This is called by do_exit or de_thread, only when there are no more
939  * references to the shared signal_struct.
940  */
941 void exit_itimers(struct signal_struct *sig)
942 {
943         struct k_itimer *tmr;
944
945         while (!list_empty(&sig->posix_timers)) {
946                 tmr = list_entry(sig->posix_timers.next, struct k_itimer, list);
947                 itimer_delete(tmr);
948         }
949 }
950
951 SYSCALL_DEFINE2(clock_settime, const clockid_t, which_clock,
952                 const struct timespec __user *, tp)
953 {
954         struct k_clock *kc = clockid_to_kclock(which_clock);
955         struct timespec new_tp;
956
957         if (!kc || !kc->clock_set)
958                 return -EINVAL;
959
960         if (copy_from_user(&new_tp, tp, sizeof (*tp)))
961                 return -EFAULT;
962
963         return kc->clock_set(which_clock, &new_tp);
964 }
965
966 SYSCALL_DEFINE2(clock_gettime, const clockid_t, which_clock,
967                 struct timespec __user *,tp)
968 {
969         struct k_clock *kc = clockid_to_kclock(which_clock);
970         struct timespec kernel_tp;
971         int error;
972
973         if (!kc)
974                 return -EINVAL;
975
976         error = kc->clock_get(which_clock, &kernel_tp);
977
978         if (!error && copy_to_user(tp, &kernel_tp, sizeof (kernel_tp)))
979                 error = -EFAULT;
980
981         return error;
982 }
983
984 SYSCALL_DEFINE2(clock_getres, const clockid_t, which_clock,
985                 struct timespec __user *, tp)
986 {
987         struct k_clock *kc = clockid_to_kclock(which_clock);
988         struct timespec rtn_tp;
989         int error;
990
991         if (!kc)
992                 return -EINVAL;
993
994         error = kc->clock_getres(which_clock, &rtn_tp);
995
996         if (!error && tp && copy_to_user(tp, &rtn_tp, sizeof (rtn_tp)))
997                 error = -EFAULT;
998
999         return error;
1000 }
1001
1002 /*
1003  * nanosleep for monotonic and realtime clocks
1004  */
1005 static int common_nsleep(const clockid_t which_clock, int flags,
1006                          struct timespec *tsave, struct timespec __user *rmtp)
1007 {
1008         return hrtimer_nanosleep(tsave, rmtp, flags & TIMER_ABSTIME ?
1009                                  HRTIMER_MODE_ABS : HRTIMER_MODE_REL,
1010                                  which_clock);
1011 }
1012
1013 SYSCALL_DEFINE4(clock_nanosleep, const clockid_t, which_clock, int, flags,
1014                 const struct timespec __user *, rqtp,
1015                 struct timespec __user *, rmtp)
1016 {
1017         struct k_clock *kc = clockid_to_kclock(which_clock);
1018         struct timespec t;
1019
1020         if (!kc)
1021                 return -EINVAL;
1022         if (!kc->nsleep)
1023                 return -ENANOSLEEP_NOTSUP;
1024
1025         if (copy_from_user(&t, rqtp, sizeof (struct timespec)))
1026                 return -EFAULT;
1027
1028         if (!timespec_valid(&t))
1029                 return -EINVAL;
1030
1031         return kc->nsleep(which_clock, flags, &t, rmtp);
1032 }
1033
1034 /*
1035  * This will restart clock_nanosleep. This is required only by
1036  * compat_clock_nanosleep_restart for now.
1037  */
1038 long clock_nanosleep_restart(struct restart_block *restart_block)
1039 {
1040         clockid_t which_clock = restart_block->nanosleep.index;
1041         struct k_clock *kc = clockid_to_kclock(which_clock);
1042
1043         if (WARN_ON_ONCE(!kc || !kc->nsleep_restart))
1044                 return -EINVAL;
1045
1046         return kc->nsleep_restart(restart_block);
1047 }