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