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