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