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