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