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