]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - kernel/time/timer.c
Merge branch 'ras-core-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[karo-tx-linux.git] / kernel / time / timer.c
1 /*
2  *  linux/kernel/timer.c
3  *
4  *  Kernel internal timers
5  *
6  *  Copyright (C) 1991, 1992  Linus Torvalds
7  *
8  *  1997-01-28  Modified by Finn Arne Gangstad to make timers scale better.
9  *
10  *  1997-09-10  Updated NTP code according to technical memorandum Jan '96
11  *              "A Kernel Model for Precision Timekeeping" by Dave Mills
12  *  1998-12-24  Fixed a xtime SMP race (we need the xtime_lock rw spinlock to
13  *              serialize accesses to xtime/lost_ticks).
14  *                              Copyright (C) 1998  Andrea Arcangeli
15  *  1999-03-10  Improved NTP compatibility by Ulrich Windl
16  *  2002-05-31  Move sys_sysinfo here and make its locking sane, Robert Love
17  *  2000-10-05  Implemented scalable SMP per-CPU timer handling.
18  *                              Copyright (C) 2000, 2001, 2002  Ingo Molnar
19  *              Designed by David S. Miller, Alexey Kuznetsov and Ingo Molnar
20  */
21
22 #include <linux/kernel_stat.h>
23 #include <linux/export.h>
24 #include <linux/interrupt.h>
25 #include <linux/percpu.h>
26 #include <linux/init.h>
27 #include <linux/mm.h>
28 #include <linux/swap.h>
29 #include <linux/pid_namespace.h>
30 #include <linux/notifier.h>
31 #include <linux/thread_info.h>
32 #include <linux/time.h>
33 #include <linux/jiffies.h>
34 #include <linux/posix-timers.h>
35 #include <linux/cpu.h>
36 #include <linux/syscalls.h>
37 #include <linux/delay.h>
38 #include <linux/tick.h>
39 #include <linux/kallsyms.h>
40 #include <linux/irq_work.h>
41 #include <linux/sched.h>
42 #include <linux/sched/sysctl.h>
43 #include <linux/slab.h>
44 #include <linux/compat.h>
45
46 #include <asm/uaccess.h>
47 #include <asm/unistd.h>
48 #include <asm/div64.h>
49 #include <asm/timex.h>
50 #include <asm/io.h>
51
52 #include "tick-internal.h"
53
54 #define CREATE_TRACE_POINTS
55 #include <trace/events/timer.h>
56
57 __visible u64 jiffies_64 __cacheline_aligned_in_smp = INITIAL_JIFFIES;
58
59 EXPORT_SYMBOL(jiffies_64);
60
61 /*
62  * per-CPU timer vector definitions:
63  */
64 #define TVN_BITS (CONFIG_BASE_SMALL ? 4 : 6)
65 #define TVR_BITS (CONFIG_BASE_SMALL ? 6 : 8)
66 #define TVN_SIZE (1 << TVN_BITS)
67 #define TVR_SIZE (1 << TVR_BITS)
68 #define TVN_MASK (TVN_SIZE - 1)
69 #define TVR_MASK (TVR_SIZE - 1)
70 #define MAX_TVAL ((unsigned long)((1ULL << (TVR_BITS + 4*TVN_BITS)) - 1))
71
72 struct tvec {
73         struct hlist_head vec[TVN_SIZE];
74 };
75
76 struct tvec_root {
77         struct hlist_head vec[TVR_SIZE];
78 };
79
80 struct tvec_base {
81         spinlock_t lock;
82         struct timer_list *running_timer;
83         unsigned long timer_jiffies;
84         unsigned long next_timer;
85         unsigned long active_timers;
86         unsigned long all_timers;
87         int cpu;
88         bool migration_enabled;
89         bool nohz_active;
90         struct tvec_root tv1;
91         struct tvec tv2;
92         struct tvec tv3;
93         struct tvec tv4;
94         struct tvec tv5;
95 } ____cacheline_aligned;
96
97
98 static DEFINE_PER_CPU(struct tvec_base, tvec_bases);
99
100 #if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
101 unsigned int sysctl_timer_migration = 1;
102
103 void timers_update_migration(bool update_nohz)
104 {
105         bool on = sysctl_timer_migration && tick_nohz_active;
106         unsigned int cpu;
107
108         /* Avoid the loop, if nothing to update */
109         if (this_cpu_read(tvec_bases.migration_enabled) == on)
110                 return;
111
112         for_each_possible_cpu(cpu) {
113                 per_cpu(tvec_bases.migration_enabled, cpu) = on;
114                 per_cpu(hrtimer_bases.migration_enabled, cpu) = on;
115                 if (!update_nohz)
116                         continue;
117                 per_cpu(tvec_bases.nohz_active, cpu) = true;
118                 per_cpu(hrtimer_bases.nohz_active, cpu) = true;
119         }
120 }
121
122 int timer_migration_handler(struct ctl_table *table, int write,
123                             void __user *buffer, size_t *lenp,
124                             loff_t *ppos)
125 {
126         static DEFINE_MUTEX(mutex);
127         int ret;
128
129         mutex_lock(&mutex);
130         ret = proc_dointvec(table, write, buffer, lenp, ppos);
131         if (!ret && write)
132                 timers_update_migration(false);
133         mutex_unlock(&mutex);
134         return ret;
135 }
136
137 static inline struct tvec_base *get_target_base(struct tvec_base *base,
138                                                 int pinned)
139 {
140         if (pinned || !base->migration_enabled)
141                 return this_cpu_ptr(&tvec_bases);
142         return per_cpu_ptr(&tvec_bases, get_nohz_timer_target());
143 }
144 #else
145 static inline struct tvec_base *get_target_base(struct tvec_base *base,
146                                                 int pinned)
147 {
148         return this_cpu_ptr(&tvec_bases);
149 }
150 #endif
151
152 static unsigned long round_jiffies_common(unsigned long j, int cpu,
153                 bool force_up)
154 {
155         int rem;
156         unsigned long original = j;
157
158         /*
159          * We don't want all cpus firing their timers at once hitting the
160          * same lock or cachelines, so we skew each extra cpu with an extra
161          * 3 jiffies. This 3 jiffies came originally from the mm/ code which
162          * already did this.
163          * The skew is done by adding 3*cpunr, then round, then subtract this
164          * extra offset again.
165          */
166         j += cpu * 3;
167
168         rem = j % HZ;
169
170         /*
171          * If the target jiffie is just after a whole second (which can happen
172          * due to delays of the timer irq, long irq off times etc etc) then
173          * we should round down to the whole second, not up. Use 1/4th second
174          * as cutoff for this rounding as an extreme upper bound for this.
175          * But never round down if @force_up is set.
176          */
177         if (rem < HZ/4 && !force_up) /* round down */
178                 j = j - rem;
179         else /* round up */
180                 j = j - rem + HZ;
181
182         /* now that we have rounded, subtract the extra skew again */
183         j -= cpu * 3;
184
185         /*
186          * Make sure j is still in the future. Otherwise return the
187          * unmodified value.
188          */
189         return time_is_after_jiffies(j) ? j : original;
190 }
191
192 /**
193  * __round_jiffies - function to round jiffies to a full second
194  * @j: the time in (absolute) jiffies that should be rounded
195  * @cpu: the processor number on which the timeout will happen
196  *
197  * __round_jiffies() rounds an absolute time in the future (in jiffies)
198  * up or down to (approximately) full seconds. This is useful for timers
199  * for which the exact time they fire does not matter too much, as long as
200  * they fire approximately every X seconds.
201  *
202  * By rounding these timers to whole seconds, all such timers will fire
203  * at the same time, rather than at various times spread out. The goal
204  * of this is to have the CPU wake up less, which saves power.
205  *
206  * The exact rounding is skewed for each processor to avoid all
207  * processors firing at the exact same time, which could lead
208  * to lock contention or spurious cache line bouncing.
209  *
210  * The return value is the rounded version of the @j parameter.
211  */
212 unsigned long __round_jiffies(unsigned long j, int cpu)
213 {
214         return round_jiffies_common(j, cpu, false);
215 }
216 EXPORT_SYMBOL_GPL(__round_jiffies);
217
218 /**
219  * __round_jiffies_relative - function to round jiffies to a full second
220  * @j: the time in (relative) jiffies that should be rounded
221  * @cpu: the processor number on which the timeout will happen
222  *
223  * __round_jiffies_relative() rounds a time delta  in the future (in jiffies)
224  * up or down to (approximately) full seconds. This is useful for timers
225  * for which the exact time they fire does not matter too much, as long as
226  * they fire approximately every X seconds.
227  *
228  * By rounding these timers to whole seconds, all such timers will fire
229  * at the same time, rather than at various times spread out. The goal
230  * of this is to have the CPU wake up less, which saves power.
231  *
232  * The exact rounding is skewed for each processor to avoid all
233  * processors firing at the exact same time, which could lead
234  * to lock contention or spurious cache line bouncing.
235  *
236  * The return value is the rounded version of the @j parameter.
237  */
238 unsigned long __round_jiffies_relative(unsigned long j, int cpu)
239 {
240         unsigned long j0 = jiffies;
241
242         /* Use j0 because jiffies might change while we run */
243         return round_jiffies_common(j + j0, cpu, false) - j0;
244 }
245 EXPORT_SYMBOL_GPL(__round_jiffies_relative);
246
247 /**
248  * round_jiffies - function to round jiffies to a full second
249  * @j: the time in (absolute) jiffies that should be rounded
250  *
251  * round_jiffies() rounds an absolute time in the future (in jiffies)
252  * up or down to (approximately) full seconds. This is useful for timers
253  * for which the exact time they fire does not matter too much, as long as
254  * they fire approximately every X seconds.
255  *
256  * By rounding these timers to whole seconds, all such timers will fire
257  * at the same time, rather than at various times spread out. The goal
258  * of this is to have the CPU wake up less, which saves power.
259  *
260  * The return value is the rounded version of the @j parameter.
261  */
262 unsigned long round_jiffies(unsigned long j)
263 {
264         return round_jiffies_common(j, raw_smp_processor_id(), false);
265 }
266 EXPORT_SYMBOL_GPL(round_jiffies);
267
268 /**
269  * round_jiffies_relative - function to round jiffies to a full second
270  * @j: the time in (relative) jiffies that should be rounded
271  *
272  * round_jiffies_relative() rounds a time delta  in the future (in jiffies)
273  * up or down to (approximately) full seconds. This is useful for timers
274  * for which the exact time they fire does not matter too much, as long as
275  * they fire approximately every X seconds.
276  *
277  * By rounding these timers to whole seconds, all such timers will fire
278  * at the same time, rather than at various times spread out. The goal
279  * of this is to have the CPU wake up less, which saves power.
280  *
281  * The return value is the rounded version of the @j parameter.
282  */
283 unsigned long round_jiffies_relative(unsigned long j)
284 {
285         return __round_jiffies_relative(j, raw_smp_processor_id());
286 }
287 EXPORT_SYMBOL_GPL(round_jiffies_relative);
288
289 /**
290  * __round_jiffies_up - function to round jiffies up to a full second
291  * @j: the time in (absolute) jiffies that should be rounded
292  * @cpu: the processor number on which the timeout will happen
293  *
294  * This is the same as __round_jiffies() except that it will never
295  * round down.  This is useful for timeouts for which the exact time
296  * of firing does not matter too much, as long as they don't fire too
297  * early.
298  */
299 unsigned long __round_jiffies_up(unsigned long j, int cpu)
300 {
301         return round_jiffies_common(j, cpu, true);
302 }
303 EXPORT_SYMBOL_GPL(__round_jiffies_up);
304
305 /**
306  * __round_jiffies_up_relative - function to round jiffies up to a full second
307  * @j: the time in (relative) jiffies that should be rounded
308  * @cpu: the processor number on which the timeout will happen
309  *
310  * This is the same as __round_jiffies_relative() except that it will never
311  * round down.  This is useful for timeouts for which the exact time
312  * of firing does not matter too much, as long as they don't fire too
313  * early.
314  */
315 unsigned long __round_jiffies_up_relative(unsigned long j, int cpu)
316 {
317         unsigned long j0 = jiffies;
318
319         /* Use j0 because jiffies might change while we run */
320         return round_jiffies_common(j + j0, cpu, true) - j0;
321 }
322 EXPORT_SYMBOL_GPL(__round_jiffies_up_relative);
323
324 /**
325  * round_jiffies_up - function to round jiffies up to a full second
326  * @j: the time in (absolute) jiffies that should be rounded
327  *
328  * This is the same as round_jiffies() except that it will never
329  * round down.  This is useful for timeouts for which the exact time
330  * of firing does not matter too much, as long as they don't fire too
331  * early.
332  */
333 unsigned long round_jiffies_up(unsigned long j)
334 {
335         return round_jiffies_common(j, raw_smp_processor_id(), true);
336 }
337 EXPORT_SYMBOL_GPL(round_jiffies_up);
338
339 /**
340  * round_jiffies_up_relative - function to round jiffies up to a full second
341  * @j: the time in (relative) jiffies that should be rounded
342  *
343  * This is the same as round_jiffies_relative() except that it will never
344  * round down.  This is useful for timeouts for which the exact time
345  * of firing does not matter too much, as long as they don't fire too
346  * early.
347  */
348 unsigned long round_jiffies_up_relative(unsigned long j)
349 {
350         return __round_jiffies_up_relative(j, raw_smp_processor_id());
351 }
352 EXPORT_SYMBOL_GPL(round_jiffies_up_relative);
353
354 /**
355  * set_timer_slack - set the allowed slack for a timer
356  * @timer: the timer to be modified
357  * @slack_hz: the amount of time (in jiffies) allowed for rounding
358  *
359  * Set the amount of time, in jiffies, that a certain timer has
360  * in terms of slack. By setting this value, the timer subsystem
361  * will schedule the actual timer somewhere between
362  * the time mod_timer() asks for, and that time plus the slack.
363  *
364  * By setting the slack to -1, a percentage of the delay is used
365  * instead.
366  */
367 void set_timer_slack(struct timer_list *timer, int slack_hz)
368 {
369         timer->slack = slack_hz;
370 }
371 EXPORT_SYMBOL_GPL(set_timer_slack);
372
373 static void
374 __internal_add_timer(struct tvec_base *base, struct timer_list *timer)
375 {
376         unsigned long expires = timer->expires;
377         unsigned long idx = expires - base->timer_jiffies;
378         struct hlist_head *vec;
379
380         if (idx < TVR_SIZE) {
381                 int i = expires & TVR_MASK;
382                 vec = base->tv1.vec + i;
383         } else if (idx < 1 << (TVR_BITS + TVN_BITS)) {
384                 int i = (expires >> TVR_BITS) & TVN_MASK;
385                 vec = base->tv2.vec + i;
386         } else if (idx < 1 << (TVR_BITS + 2 * TVN_BITS)) {
387                 int i = (expires >> (TVR_BITS + TVN_BITS)) & TVN_MASK;
388                 vec = base->tv3.vec + i;
389         } else if (idx < 1 << (TVR_BITS + 3 * TVN_BITS)) {
390                 int i = (expires >> (TVR_BITS + 2 * TVN_BITS)) & TVN_MASK;
391                 vec = base->tv4.vec + i;
392         } else if ((signed long) idx < 0) {
393                 /*
394                  * Can happen if you add a timer with expires == jiffies,
395                  * or you set a timer to go off in the past
396                  */
397                 vec = base->tv1.vec + (base->timer_jiffies & TVR_MASK);
398         } else {
399                 int i;
400                 /* If the timeout is larger than MAX_TVAL (on 64-bit
401                  * architectures or with CONFIG_BASE_SMALL=1) then we
402                  * use the maximum timeout.
403                  */
404                 if (idx > MAX_TVAL) {
405                         idx = MAX_TVAL;
406                         expires = idx + base->timer_jiffies;
407                 }
408                 i = (expires >> (TVR_BITS + 3 * TVN_BITS)) & TVN_MASK;
409                 vec = base->tv5.vec + i;
410         }
411
412         hlist_add_head(&timer->entry, vec);
413 }
414
415 static void internal_add_timer(struct tvec_base *base, struct timer_list *timer)
416 {
417         /* Advance base->jiffies, if the base is empty */
418         if (!base->all_timers++)
419                 base->timer_jiffies = jiffies;
420
421         __internal_add_timer(base, timer);
422         /*
423          * Update base->active_timers and base->next_timer
424          */
425         if (!(timer->flags & TIMER_DEFERRABLE)) {
426                 if (!base->active_timers++ ||
427                     time_before(timer->expires, base->next_timer))
428                         base->next_timer = timer->expires;
429         }
430
431         /*
432          * Check whether the other CPU is in dynticks mode and needs
433          * to be triggered to reevaluate the timer wheel.
434          * We are protected against the other CPU fiddling
435          * with the timer by holding the timer base lock. This also
436          * makes sure that a CPU on the way to stop its tick can not
437          * evaluate the timer wheel.
438          *
439          * Spare the IPI for deferrable timers on idle targets though.
440          * The next busy ticks will take care of it. Except full dynticks
441          * require special care against races with idle_cpu(), lets deal
442          * with that later.
443          */
444         if (base->nohz_active) {
445                 if (!(timer->flags & TIMER_DEFERRABLE) ||
446                     tick_nohz_full_cpu(base->cpu))
447                         wake_up_nohz_cpu(base->cpu);
448         }
449 }
450
451 #ifdef CONFIG_TIMER_STATS
452 void __timer_stats_timer_set_start_info(struct timer_list *timer, void *addr)
453 {
454         if (timer->start_site)
455                 return;
456
457         timer->start_site = addr;
458         memcpy(timer->start_comm, current->comm, TASK_COMM_LEN);
459         timer->start_pid = current->pid;
460 }
461
462 static void timer_stats_account_timer(struct timer_list *timer)
463 {
464         void *site;
465
466         /*
467          * start_site can be concurrently reset by
468          * timer_stats_timer_clear_start_info()
469          */
470         site = READ_ONCE(timer->start_site);
471         if (likely(!site))
472                 return;
473
474         timer_stats_update_stats(timer, timer->start_pid, site,
475                                  timer->function, timer->start_comm,
476                                  timer->flags);
477 }
478
479 #else
480 static void timer_stats_account_timer(struct timer_list *timer) {}
481 #endif
482
483 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
484
485 static struct debug_obj_descr timer_debug_descr;
486
487 static void *timer_debug_hint(void *addr)
488 {
489         return ((struct timer_list *) addr)->function;
490 }
491
492 /*
493  * fixup_init is called when:
494  * - an active object is initialized
495  */
496 static int timer_fixup_init(void *addr, enum debug_obj_state state)
497 {
498         struct timer_list *timer = addr;
499
500         switch (state) {
501         case ODEBUG_STATE_ACTIVE:
502                 del_timer_sync(timer);
503                 debug_object_init(timer, &timer_debug_descr);
504                 return 1;
505         default:
506                 return 0;
507         }
508 }
509
510 /* Stub timer callback for improperly used timers. */
511 static void stub_timer(unsigned long data)
512 {
513         WARN_ON(1);
514 }
515
516 /*
517  * fixup_activate is called when:
518  * - an active object is activated
519  * - an unknown object is activated (might be a statically initialized object)
520  */
521 static int timer_fixup_activate(void *addr, enum debug_obj_state state)
522 {
523         struct timer_list *timer = addr;
524
525         switch (state) {
526
527         case ODEBUG_STATE_NOTAVAILABLE:
528                 /*
529                  * This is not really a fixup. The timer was
530                  * statically initialized. We just make sure that it
531                  * is tracked in the object tracker.
532                  */
533                 if (timer->entry.pprev == NULL &&
534                     timer->entry.next == TIMER_ENTRY_STATIC) {
535                         debug_object_init(timer, &timer_debug_descr);
536                         debug_object_activate(timer, &timer_debug_descr);
537                         return 0;
538                 } else {
539                         setup_timer(timer, stub_timer, 0);
540                         return 1;
541                 }
542                 return 0;
543
544         case ODEBUG_STATE_ACTIVE:
545                 WARN_ON(1);
546
547         default:
548                 return 0;
549         }
550 }
551
552 /*
553  * fixup_free is called when:
554  * - an active object is freed
555  */
556 static int timer_fixup_free(void *addr, enum debug_obj_state state)
557 {
558         struct timer_list *timer = addr;
559
560         switch (state) {
561         case ODEBUG_STATE_ACTIVE:
562                 del_timer_sync(timer);
563                 debug_object_free(timer, &timer_debug_descr);
564                 return 1;
565         default:
566                 return 0;
567         }
568 }
569
570 /*
571  * fixup_assert_init is called when:
572  * - an untracked/uninit-ed object is found
573  */
574 static int timer_fixup_assert_init(void *addr, enum debug_obj_state state)
575 {
576         struct timer_list *timer = addr;
577
578         switch (state) {
579         case ODEBUG_STATE_NOTAVAILABLE:
580                 if (timer->entry.next == TIMER_ENTRY_STATIC) {
581                         /*
582                          * This is not really a fixup. The timer was
583                          * statically initialized. We just make sure that it
584                          * is tracked in the object tracker.
585                          */
586                         debug_object_init(timer, &timer_debug_descr);
587                         return 0;
588                 } else {
589                         setup_timer(timer, stub_timer, 0);
590                         return 1;
591                 }
592         default:
593                 return 0;
594         }
595 }
596
597 static struct debug_obj_descr timer_debug_descr = {
598         .name                   = "timer_list",
599         .debug_hint             = timer_debug_hint,
600         .fixup_init             = timer_fixup_init,
601         .fixup_activate         = timer_fixup_activate,
602         .fixup_free             = timer_fixup_free,
603         .fixup_assert_init      = timer_fixup_assert_init,
604 };
605
606 static inline void debug_timer_init(struct timer_list *timer)
607 {
608         debug_object_init(timer, &timer_debug_descr);
609 }
610
611 static inline void debug_timer_activate(struct timer_list *timer)
612 {
613         debug_object_activate(timer, &timer_debug_descr);
614 }
615
616 static inline void debug_timer_deactivate(struct timer_list *timer)
617 {
618         debug_object_deactivate(timer, &timer_debug_descr);
619 }
620
621 static inline void debug_timer_free(struct timer_list *timer)
622 {
623         debug_object_free(timer, &timer_debug_descr);
624 }
625
626 static inline void debug_timer_assert_init(struct timer_list *timer)
627 {
628         debug_object_assert_init(timer, &timer_debug_descr);
629 }
630
631 static void do_init_timer(struct timer_list *timer, unsigned int flags,
632                           const char *name, struct lock_class_key *key);
633
634 void init_timer_on_stack_key(struct timer_list *timer, unsigned int flags,
635                              const char *name, struct lock_class_key *key)
636 {
637         debug_object_init_on_stack(timer, &timer_debug_descr);
638         do_init_timer(timer, flags, name, key);
639 }
640 EXPORT_SYMBOL_GPL(init_timer_on_stack_key);
641
642 void destroy_timer_on_stack(struct timer_list *timer)
643 {
644         debug_object_free(timer, &timer_debug_descr);
645 }
646 EXPORT_SYMBOL_GPL(destroy_timer_on_stack);
647
648 #else
649 static inline void debug_timer_init(struct timer_list *timer) { }
650 static inline void debug_timer_activate(struct timer_list *timer) { }
651 static inline void debug_timer_deactivate(struct timer_list *timer) { }
652 static inline void debug_timer_assert_init(struct timer_list *timer) { }
653 #endif
654
655 static inline void debug_init(struct timer_list *timer)
656 {
657         debug_timer_init(timer);
658         trace_timer_init(timer);
659 }
660
661 static inline void
662 debug_activate(struct timer_list *timer, unsigned long expires)
663 {
664         debug_timer_activate(timer);
665         trace_timer_start(timer, expires, timer->flags);
666 }
667
668 static inline void debug_deactivate(struct timer_list *timer)
669 {
670         debug_timer_deactivate(timer);
671         trace_timer_cancel(timer);
672 }
673
674 static inline void debug_assert_init(struct timer_list *timer)
675 {
676         debug_timer_assert_init(timer);
677 }
678
679 static void do_init_timer(struct timer_list *timer, unsigned int flags,
680                           const char *name, struct lock_class_key *key)
681 {
682         timer->entry.pprev = NULL;
683         timer->flags = flags | raw_smp_processor_id();
684         timer->slack = -1;
685 #ifdef CONFIG_TIMER_STATS
686         timer->start_site = NULL;
687         timer->start_pid = -1;
688         memset(timer->start_comm, 0, TASK_COMM_LEN);
689 #endif
690         lockdep_init_map(&timer->lockdep_map, name, key, 0);
691 }
692
693 /**
694  * init_timer_key - initialize a timer
695  * @timer: the timer to be initialized
696  * @flags: timer flags
697  * @name: name of the timer
698  * @key: lockdep class key of the fake lock used for tracking timer
699  *       sync lock dependencies
700  *
701  * init_timer_key() must be done to a timer prior calling *any* of the
702  * other timer functions.
703  */
704 void init_timer_key(struct timer_list *timer, unsigned int flags,
705                     const char *name, struct lock_class_key *key)
706 {
707         debug_init(timer);
708         do_init_timer(timer, flags, name, key);
709 }
710 EXPORT_SYMBOL(init_timer_key);
711
712 static inline void detach_timer(struct timer_list *timer, bool clear_pending)
713 {
714         struct hlist_node *entry = &timer->entry;
715
716         debug_deactivate(timer);
717
718         __hlist_del(entry);
719         if (clear_pending)
720                 entry->pprev = NULL;
721         entry->next = LIST_POISON2;
722 }
723
724 static inline void
725 detach_expired_timer(struct timer_list *timer, struct tvec_base *base)
726 {
727         detach_timer(timer, true);
728         if (!(timer->flags & TIMER_DEFERRABLE))
729                 base->active_timers--;
730         base->all_timers--;
731 }
732
733 static int detach_if_pending(struct timer_list *timer, struct tvec_base *base,
734                              bool clear_pending)
735 {
736         if (!timer_pending(timer))
737                 return 0;
738
739         detach_timer(timer, clear_pending);
740         if (!(timer->flags & TIMER_DEFERRABLE)) {
741                 base->active_timers--;
742                 if (timer->expires == base->next_timer)
743                         base->next_timer = base->timer_jiffies;
744         }
745         /* If this was the last timer, advance base->jiffies */
746         if (!--base->all_timers)
747                 base->timer_jiffies = jiffies;
748         return 1;
749 }
750
751 /*
752  * We are using hashed locking: holding per_cpu(tvec_bases).lock
753  * means that all timers which are tied to this base via timer->base are
754  * locked, and the base itself is locked too.
755  *
756  * So __run_timers/migrate_timers can safely modify all timers which could
757  * be found on ->tvX lists.
758  *
759  * When the timer's base is locked and removed from the list, the
760  * TIMER_MIGRATING flag is set, FIXME
761  */
762 static struct tvec_base *lock_timer_base(struct timer_list *timer,
763                                         unsigned long *flags)
764         __acquires(timer->base->lock)
765 {
766         for (;;) {
767                 u32 tf = timer->flags;
768                 struct tvec_base *base;
769
770                 if (!(tf & TIMER_MIGRATING)) {
771                         base = per_cpu_ptr(&tvec_bases, tf & TIMER_CPUMASK);
772                         spin_lock_irqsave(&base->lock, *flags);
773                         if (timer->flags == tf)
774                                 return base;
775                         spin_unlock_irqrestore(&base->lock, *flags);
776                 }
777                 cpu_relax();
778         }
779 }
780
781 static inline int
782 __mod_timer(struct timer_list *timer, unsigned long expires,
783             bool pending_only, int pinned)
784 {
785         struct tvec_base *base, *new_base;
786         unsigned long flags;
787         int ret = 0;
788
789         timer_stats_timer_set_start_info(timer);
790         BUG_ON(!timer->function);
791
792         base = lock_timer_base(timer, &flags);
793
794         ret = detach_if_pending(timer, base, false);
795         if (!ret && pending_only)
796                 goto out_unlock;
797
798         debug_activate(timer, expires);
799
800         new_base = get_target_base(base, pinned);
801
802         if (base != new_base) {
803                 /*
804                  * We are trying to schedule the timer on the local CPU.
805                  * However we can't change timer's base while it is running,
806                  * otherwise del_timer_sync() can't detect that the timer's
807                  * handler yet has not finished. This also guarantees that
808                  * the timer is serialized wrt itself.
809                  */
810                 if (likely(base->running_timer != timer)) {
811                         /* See the comment in lock_timer_base() */
812                         timer->flags |= TIMER_MIGRATING;
813
814                         spin_unlock(&base->lock);
815                         base = new_base;
816                         spin_lock(&base->lock);
817                         WRITE_ONCE(timer->flags,
818                                    (timer->flags & ~TIMER_BASEMASK) | base->cpu);
819                 }
820         }
821
822         timer->expires = expires;
823         internal_add_timer(base, timer);
824
825 out_unlock:
826         spin_unlock_irqrestore(&base->lock, flags);
827
828         return ret;
829 }
830
831 /**
832  * mod_timer_pending - modify a pending timer's timeout
833  * @timer: the pending timer to be modified
834  * @expires: new timeout in jiffies
835  *
836  * mod_timer_pending() is the same for pending timers as mod_timer(),
837  * but will not re-activate and modify already deleted timers.
838  *
839  * It is useful for unserialized use of timers.
840  */
841 int mod_timer_pending(struct timer_list *timer, unsigned long expires)
842 {
843         return __mod_timer(timer, expires, true, TIMER_NOT_PINNED);
844 }
845 EXPORT_SYMBOL(mod_timer_pending);
846
847 /*
848  * Decide where to put the timer while taking the slack into account
849  *
850  * Algorithm:
851  *   1) calculate the maximum (absolute) time
852  *   2) calculate the highest bit where the expires and new max are different
853  *   3) use this bit to make a mask
854  *   4) use the bitmask to round down the maximum time, so that all last
855  *      bits are zeros
856  */
857 static inline
858 unsigned long apply_slack(struct timer_list *timer, unsigned long expires)
859 {
860         unsigned long expires_limit, mask;
861         int bit;
862
863         if (timer->slack >= 0) {
864                 expires_limit = expires + timer->slack;
865         } else {
866                 long delta = expires - jiffies;
867
868                 if (delta < 256)
869                         return expires;
870
871                 expires_limit = expires + delta / 256;
872         }
873         mask = expires ^ expires_limit;
874         if (mask == 0)
875                 return expires;
876
877         bit = __fls(mask);
878
879         mask = (1UL << bit) - 1;
880
881         expires_limit = expires_limit & ~(mask);
882
883         return expires_limit;
884 }
885
886 /**
887  * mod_timer - modify a timer's timeout
888  * @timer: the timer to be modified
889  * @expires: new timeout in jiffies
890  *
891  * mod_timer() is a more efficient way to update the expire field of an
892  * active timer (if the timer is inactive it will be activated)
893  *
894  * mod_timer(timer, expires) is equivalent to:
895  *
896  *     del_timer(timer); timer->expires = expires; add_timer(timer);
897  *
898  * Note that if there are multiple unserialized concurrent users of the
899  * same timer, then mod_timer() is the only safe way to modify the timeout,
900  * since add_timer() cannot modify an already running timer.
901  *
902  * The function returns whether it has modified a pending timer or not.
903  * (ie. mod_timer() of an inactive timer returns 0, mod_timer() of an
904  * active timer returns 1.)
905  */
906 int mod_timer(struct timer_list *timer, unsigned long expires)
907 {
908         expires = apply_slack(timer, expires);
909
910         /*
911          * This is a common optimization triggered by the
912          * networking code - if the timer is re-modified
913          * to be the same thing then just return:
914          */
915         if (timer_pending(timer) && timer->expires == expires)
916                 return 1;
917
918         return __mod_timer(timer, expires, false, TIMER_NOT_PINNED);
919 }
920 EXPORT_SYMBOL(mod_timer);
921
922 /**
923  * mod_timer_pinned - modify a timer's timeout
924  * @timer: the timer to be modified
925  * @expires: new timeout in jiffies
926  *
927  * mod_timer_pinned() is a way to update the expire field of an
928  * active timer (if the timer is inactive it will be activated)
929  * and to ensure that the timer is scheduled on the current CPU.
930  *
931  * Note that this does not prevent the timer from being migrated
932  * when the current CPU goes offline.  If this is a problem for
933  * you, use CPU-hotplug notifiers to handle it correctly, for
934  * example, cancelling the timer when the corresponding CPU goes
935  * offline.
936  *
937  * mod_timer_pinned(timer, expires) is equivalent to:
938  *
939  *     del_timer(timer); timer->expires = expires; add_timer(timer);
940  */
941 int mod_timer_pinned(struct timer_list *timer, unsigned long expires)
942 {
943         if (timer->expires == expires && timer_pending(timer))
944                 return 1;
945
946         return __mod_timer(timer, expires, false, TIMER_PINNED);
947 }
948 EXPORT_SYMBOL(mod_timer_pinned);
949
950 /**
951  * add_timer - start a timer
952  * @timer: the timer to be added
953  *
954  * The kernel will do a ->function(->data) callback from the
955  * timer interrupt at the ->expires point in the future. The
956  * current time is 'jiffies'.
957  *
958  * The timer's ->expires, ->function (and if the handler uses it, ->data)
959  * fields must be set prior calling this function.
960  *
961  * Timers with an ->expires field in the past will be executed in the next
962  * timer tick.
963  */
964 void add_timer(struct timer_list *timer)
965 {
966         BUG_ON(timer_pending(timer));
967         mod_timer(timer, timer->expires);
968 }
969 EXPORT_SYMBOL(add_timer);
970
971 /**
972  * add_timer_on - start a timer on a particular CPU
973  * @timer: the timer to be added
974  * @cpu: the CPU to start it on
975  *
976  * This is not very scalable on SMP. Double adds are not possible.
977  */
978 void add_timer_on(struct timer_list *timer, int cpu)
979 {
980         struct tvec_base *base = per_cpu_ptr(&tvec_bases, cpu);
981         unsigned long flags;
982
983         timer_stats_timer_set_start_info(timer);
984         BUG_ON(timer_pending(timer) || !timer->function);
985         spin_lock_irqsave(&base->lock, flags);
986         timer->flags = (timer->flags & ~TIMER_BASEMASK) | cpu;
987         debug_activate(timer, timer->expires);
988         internal_add_timer(base, timer);
989         spin_unlock_irqrestore(&base->lock, flags);
990 }
991 EXPORT_SYMBOL_GPL(add_timer_on);
992
993 /**
994  * del_timer - deactive a timer.
995  * @timer: the timer to be deactivated
996  *
997  * del_timer() deactivates a timer - this works on both active and inactive
998  * timers.
999  *
1000  * The function returns whether it has deactivated a pending timer or not.
1001  * (ie. del_timer() of an inactive timer returns 0, del_timer() of an
1002  * active timer returns 1.)
1003  */
1004 int del_timer(struct timer_list *timer)
1005 {
1006         struct tvec_base *base;
1007         unsigned long flags;
1008         int ret = 0;
1009
1010         debug_assert_init(timer);
1011
1012         timer_stats_timer_clear_start_info(timer);
1013         if (timer_pending(timer)) {
1014                 base = lock_timer_base(timer, &flags);
1015                 ret = detach_if_pending(timer, base, true);
1016                 spin_unlock_irqrestore(&base->lock, flags);
1017         }
1018
1019         return ret;
1020 }
1021 EXPORT_SYMBOL(del_timer);
1022
1023 /**
1024  * try_to_del_timer_sync - Try to deactivate a timer
1025  * @timer: timer do del
1026  *
1027  * This function tries to deactivate a timer. Upon successful (ret >= 0)
1028  * exit the timer is not queued and the handler is not running on any CPU.
1029  */
1030 int try_to_del_timer_sync(struct timer_list *timer)
1031 {
1032         struct tvec_base *base;
1033         unsigned long flags;
1034         int ret = -1;
1035
1036         debug_assert_init(timer);
1037
1038         base = lock_timer_base(timer, &flags);
1039
1040         if (base->running_timer != timer) {
1041                 timer_stats_timer_clear_start_info(timer);
1042                 ret = detach_if_pending(timer, base, true);
1043         }
1044         spin_unlock_irqrestore(&base->lock, flags);
1045
1046         return ret;
1047 }
1048 EXPORT_SYMBOL(try_to_del_timer_sync);
1049
1050 #ifdef CONFIG_SMP
1051 /**
1052  * del_timer_sync - deactivate a timer and wait for the handler to finish.
1053  * @timer: the timer to be deactivated
1054  *
1055  * This function only differs from del_timer() on SMP: besides deactivating
1056  * the timer it also makes sure the handler has finished executing on other
1057  * CPUs.
1058  *
1059  * Synchronization rules: Callers must prevent restarting of the timer,
1060  * otherwise this function is meaningless. It must not be called from
1061  * interrupt contexts unless the timer is an irqsafe one. The caller must
1062  * not hold locks which would prevent completion of the timer's
1063  * handler. The timer's handler must not call add_timer_on(). Upon exit the
1064  * timer is not queued and the handler is not running on any CPU.
1065  *
1066  * Note: For !irqsafe timers, you must not hold locks that are held in
1067  *   interrupt context while calling this function. Even if the lock has
1068  *   nothing to do with the timer in question.  Here's why:
1069  *
1070  *    CPU0                             CPU1
1071  *    ----                             ----
1072  *                                   <SOFTIRQ>
1073  *                                   call_timer_fn();
1074  *                                     base->running_timer = mytimer;
1075  *  spin_lock_irq(somelock);
1076  *                                     <IRQ>
1077  *                                        spin_lock(somelock);
1078  *  del_timer_sync(mytimer);
1079  *   while (base->running_timer == mytimer);
1080  *
1081  * Now del_timer_sync() will never return and never release somelock.
1082  * The interrupt on the other CPU is waiting to grab somelock but
1083  * it has interrupted the softirq that CPU0 is waiting to finish.
1084  *
1085  * The function returns whether it has deactivated a pending timer or not.
1086  */
1087 int del_timer_sync(struct timer_list *timer)
1088 {
1089 #ifdef CONFIG_LOCKDEP
1090         unsigned long flags;
1091
1092         /*
1093          * If lockdep gives a backtrace here, please reference
1094          * the synchronization rules above.
1095          */
1096         local_irq_save(flags);
1097         lock_map_acquire(&timer->lockdep_map);
1098         lock_map_release(&timer->lockdep_map);
1099         local_irq_restore(flags);
1100 #endif
1101         /*
1102          * don't use it in hardirq context, because it
1103          * could lead to deadlock.
1104          */
1105         WARN_ON(in_irq() && !(timer->flags & TIMER_IRQSAFE));
1106         for (;;) {
1107                 int ret = try_to_del_timer_sync(timer);
1108                 if (ret >= 0)
1109                         return ret;
1110                 cpu_relax();
1111         }
1112 }
1113 EXPORT_SYMBOL(del_timer_sync);
1114 #endif
1115
1116 static int cascade(struct tvec_base *base, struct tvec *tv, int index)
1117 {
1118         /* cascade all the timers from tv up one level */
1119         struct timer_list *timer;
1120         struct hlist_node *tmp;
1121         struct hlist_head tv_list;
1122
1123         hlist_move_list(tv->vec + index, &tv_list);
1124
1125         /*
1126          * We are removing _all_ timers from the list, so we
1127          * don't have to detach them individually.
1128          */
1129         hlist_for_each_entry_safe(timer, tmp, &tv_list, entry) {
1130                 /* No accounting, while moving them */
1131                 __internal_add_timer(base, timer);
1132         }
1133
1134         return index;
1135 }
1136
1137 static void call_timer_fn(struct timer_list *timer, void (*fn)(unsigned long),
1138                           unsigned long data)
1139 {
1140         int count = preempt_count();
1141
1142 #ifdef CONFIG_LOCKDEP
1143         /*
1144          * It is permissible to free the timer from inside the
1145          * function that is called from it, this we need to take into
1146          * account for lockdep too. To avoid bogus "held lock freed"
1147          * warnings as well as problems when looking into
1148          * timer->lockdep_map, make a copy and use that here.
1149          */
1150         struct lockdep_map lockdep_map;
1151
1152         lockdep_copy_map(&lockdep_map, &timer->lockdep_map);
1153 #endif
1154         /*
1155          * Couple the lock chain with the lock chain at
1156          * del_timer_sync() by acquiring the lock_map around the fn()
1157          * call here and in del_timer_sync().
1158          */
1159         lock_map_acquire(&lockdep_map);
1160
1161         trace_timer_expire_entry(timer);
1162         fn(data);
1163         trace_timer_expire_exit(timer);
1164
1165         lock_map_release(&lockdep_map);
1166
1167         if (count != preempt_count()) {
1168                 WARN_ONCE(1, "timer: %pF preempt leak: %08x -> %08x\n",
1169                           fn, count, preempt_count());
1170                 /*
1171                  * Restore the preempt count. That gives us a decent
1172                  * chance to survive and extract information. If the
1173                  * callback kept a lock held, bad luck, but not worse
1174                  * than the BUG() we had.
1175                  */
1176                 preempt_count_set(count);
1177         }
1178 }
1179
1180 #define INDEX(N) ((base->timer_jiffies >> (TVR_BITS + (N) * TVN_BITS)) & TVN_MASK)
1181
1182 /**
1183  * __run_timers - run all expired timers (if any) on this CPU.
1184  * @base: the timer vector to be processed.
1185  *
1186  * This function cascades all vectors and executes all expired timer
1187  * vectors.
1188  */
1189 static inline void __run_timers(struct tvec_base *base)
1190 {
1191         struct timer_list *timer;
1192
1193         spin_lock_irq(&base->lock);
1194
1195         while (time_after_eq(jiffies, base->timer_jiffies)) {
1196                 struct hlist_head work_list;
1197                 struct hlist_head *head = &work_list;
1198                 int index;
1199
1200                 if (!base->all_timers) {
1201                         base->timer_jiffies = jiffies;
1202                         break;
1203                 }
1204
1205                 index = base->timer_jiffies & TVR_MASK;
1206
1207                 /*
1208                  * Cascade timers:
1209                  */
1210                 if (!index &&
1211                         (!cascade(base, &base->tv2, INDEX(0))) &&
1212                                 (!cascade(base, &base->tv3, INDEX(1))) &&
1213                                         !cascade(base, &base->tv4, INDEX(2)))
1214                         cascade(base, &base->tv5, INDEX(3));
1215                 ++base->timer_jiffies;
1216                 hlist_move_list(base->tv1.vec + index, head);
1217                 while (!hlist_empty(head)) {
1218                         void (*fn)(unsigned long);
1219                         unsigned long data;
1220                         bool irqsafe;
1221
1222                         timer = hlist_entry(head->first, struct timer_list, entry);
1223                         fn = timer->function;
1224                         data = timer->data;
1225                         irqsafe = timer->flags & TIMER_IRQSAFE;
1226
1227                         timer_stats_account_timer(timer);
1228
1229                         base->running_timer = timer;
1230                         detach_expired_timer(timer, base);
1231
1232                         if (irqsafe) {
1233                                 spin_unlock(&base->lock);
1234                                 call_timer_fn(timer, fn, data);
1235                                 spin_lock(&base->lock);
1236                         } else {
1237                                 spin_unlock_irq(&base->lock);
1238                                 call_timer_fn(timer, fn, data);
1239                                 spin_lock_irq(&base->lock);
1240                         }
1241                 }
1242         }
1243         base->running_timer = NULL;
1244         spin_unlock_irq(&base->lock);
1245 }
1246
1247 #ifdef CONFIG_NO_HZ_COMMON
1248 /*
1249  * Find out when the next timer event is due to happen. This
1250  * is used on S/390 to stop all activity when a CPU is idle.
1251  * This function needs to be called with interrupts disabled.
1252  */
1253 static unsigned long __next_timer_interrupt(struct tvec_base *base)
1254 {
1255         unsigned long timer_jiffies = base->timer_jiffies;
1256         unsigned long expires = timer_jiffies + NEXT_TIMER_MAX_DELTA;
1257         int index, slot, array, found = 0;
1258         struct timer_list *nte;
1259         struct tvec *varray[4];
1260
1261         /* Look for timer events in tv1. */
1262         index = slot = timer_jiffies & TVR_MASK;
1263         do {
1264                 hlist_for_each_entry(nte, base->tv1.vec + slot, entry) {
1265                         if (nte->flags & TIMER_DEFERRABLE)
1266                                 continue;
1267
1268                         found = 1;
1269                         expires = nte->expires;
1270                         /* Look at the cascade bucket(s)? */
1271                         if (!index || slot < index)
1272                                 goto cascade;
1273                         return expires;
1274                 }
1275                 slot = (slot + 1) & TVR_MASK;
1276         } while (slot != index);
1277
1278 cascade:
1279         /* Calculate the next cascade event */
1280         if (index)
1281                 timer_jiffies += TVR_SIZE - index;
1282         timer_jiffies >>= TVR_BITS;
1283
1284         /* Check tv2-tv5. */
1285         varray[0] = &base->tv2;
1286         varray[1] = &base->tv3;
1287         varray[2] = &base->tv4;
1288         varray[3] = &base->tv5;
1289
1290         for (array = 0; array < 4; array++) {
1291                 struct tvec *varp = varray[array];
1292
1293                 index = slot = timer_jiffies & TVN_MASK;
1294                 do {
1295                         hlist_for_each_entry(nte, varp->vec + slot, entry) {
1296                                 if (nte->flags & TIMER_DEFERRABLE)
1297                                         continue;
1298
1299                                 found = 1;
1300                                 if (time_before(nte->expires, expires))
1301                                         expires = nte->expires;
1302                         }
1303                         /*
1304                          * Do we still search for the first timer or are
1305                          * we looking up the cascade buckets ?
1306                          */
1307                         if (found) {
1308                                 /* Look at the cascade bucket(s)? */
1309                                 if (!index || slot < index)
1310                                         break;
1311                                 return expires;
1312                         }
1313                         slot = (slot + 1) & TVN_MASK;
1314                 } while (slot != index);
1315
1316                 if (index)
1317                         timer_jiffies += TVN_SIZE - index;
1318                 timer_jiffies >>= TVN_BITS;
1319         }
1320         return expires;
1321 }
1322
1323 /*
1324  * Check, if the next hrtimer event is before the next timer wheel
1325  * event:
1326  */
1327 static u64 cmp_next_hrtimer_event(u64 basem, u64 expires)
1328 {
1329         u64 nextevt = hrtimer_get_next_event();
1330
1331         /*
1332          * If high resolution timers are enabled
1333          * hrtimer_get_next_event() returns KTIME_MAX.
1334          */
1335         if (expires <= nextevt)
1336                 return expires;
1337
1338         /*
1339          * If the next timer is already expired, return the tick base
1340          * time so the tick is fired immediately.
1341          */
1342         if (nextevt <= basem)
1343                 return basem;
1344
1345         /*
1346          * Round up to the next jiffie. High resolution timers are
1347          * off, so the hrtimers are expired in the tick and we need to
1348          * make sure that this tick really expires the timer to avoid
1349          * a ping pong of the nohz stop code.
1350          *
1351          * Use DIV_ROUND_UP_ULL to prevent gcc calling __divdi3
1352          */
1353         return DIV_ROUND_UP_ULL(nextevt, TICK_NSEC) * TICK_NSEC;
1354 }
1355
1356 /**
1357  * get_next_timer_interrupt - return the time (clock mono) of the next timer
1358  * @basej:      base time jiffies
1359  * @basem:      base time clock monotonic
1360  *
1361  * Returns the tick aligned clock monotonic time of the next pending
1362  * timer or KTIME_MAX if no timer is pending.
1363  */
1364 u64 get_next_timer_interrupt(unsigned long basej, u64 basem)
1365 {
1366         struct tvec_base *base = this_cpu_ptr(&tvec_bases);
1367         u64 expires = KTIME_MAX;
1368         unsigned long nextevt;
1369
1370         /*
1371          * Pretend that there is no timer pending if the cpu is offline.
1372          * Possible pending timers will be migrated later to an active cpu.
1373          */
1374         if (cpu_is_offline(smp_processor_id()))
1375                 return expires;
1376
1377         spin_lock(&base->lock);
1378         if (base->active_timers) {
1379                 if (time_before_eq(base->next_timer, base->timer_jiffies))
1380                         base->next_timer = __next_timer_interrupt(base);
1381                 nextevt = base->next_timer;
1382                 if (time_before_eq(nextevt, basej))
1383                         expires = basem;
1384                 else
1385                         expires = basem + (nextevt - basej) * TICK_NSEC;
1386         }
1387         spin_unlock(&base->lock);
1388
1389         return cmp_next_hrtimer_event(basem, expires);
1390 }
1391 #endif
1392
1393 /*
1394  * Called from the timer interrupt handler to charge one tick to the current
1395  * process.  user_tick is 1 if the tick is user time, 0 for system.
1396  */
1397 void update_process_times(int user_tick)
1398 {
1399         struct task_struct *p = current;
1400
1401         /* Note: this timer irq context must be accounted for as well. */
1402         account_process_tick(p, user_tick);
1403         run_local_timers();
1404         rcu_check_callbacks(user_tick);
1405 #ifdef CONFIG_IRQ_WORK
1406         if (in_irq())
1407                 irq_work_tick();
1408 #endif
1409         scheduler_tick();
1410         run_posix_cpu_timers(p);
1411 }
1412
1413 /*
1414  * This function runs timers and the timer-tq in bottom half context.
1415  */
1416 static void run_timer_softirq(struct softirq_action *h)
1417 {
1418         struct tvec_base *base = this_cpu_ptr(&tvec_bases);
1419
1420         if (time_after_eq(jiffies, base->timer_jiffies))
1421                 __run_timers(base);
1422 }
1423
1424 /*
1425  * Called by the local, per-CPU timer interrupt on SMP.
1426  */
1427 void run_local_timers(void)
1428 {
1429         hrtimer_run_queues();
1430         raise_softirq(TIMER_SOFTIRQ);
1431 }
1432
1433 #ifdef __ARCH_WANT_SYS_ALARM
1434
1435 /*
1436  * For backwards compatibility?  This can be done in libc so Alpha
1437  * and all newer ports shouldn't need it.
1438  */
1439 SYSCALL_DEFINE1(alarm, unsigned int, seconds)
1440 {
1441         return alarm_setitimer(seconds);
1442 }
1443
1444 #endif
1445
1446 static void process_timeout(unsigned long __data)
1447 {
1448         wake_up_process((struct task_struct *)__data);
1449 }
1450
1451 /**
1452  * schedule_timeout - sleep until timeout
1453  * @timeout: timeout value in jiffies
1454  *
1455  * Make the current task sleep until @timeout jiffies have
1456  * elapsed. The routine will return immediately unless
1457  * the current task state has been set (see set_current_state()).
1458  *
1459  * You can set the task state as follows -
1460  *
1461  * %TASK_UNINTERRUPTIBLE - at least @timeout jiffies are guaranteed to
1462  * pass before the routine returns. The routine will return 0
1463  *
1464  * %TASK_INTERRUPTIBLE - the routine may return early if a signal is
1465  * delivered to the current task. In this case the remaining time
1466  * in jiffies will be returned, or 0 if the timer expired in time
1467  *
1468  * The current task state is guaranteed to be TASK_RUNNING when this
1469  * routine returns.
1470  *
1471  * Specifying a @timeout value of %MAX_SCHEDULE_TIMEOUT will schedule
1472  * the CPU away without a bound on the timeout. In this case the return
1473  * value will be %MAX_SCHEDULE_TIMEOUT.
1474  *
1475  * In all cases the return value is guaranteed to be non-negative.
1476  */
1477 signed long __sched schedule_timeout(signed long timeout)
1478 {
1479         struct timer_list timer;
1480         unsigned long expire;
1481
1482         switch (timeout)
1483         {
1484         case MAX_SCHEDULE_TIMEOUT:
1485                 /*
1486                  * These two special cases are useful to be comfortable
1487                  * in the caller. Nothing more. We could take
1488                  * MAX_SCHEDULE_TIMEOUT from one of the negative value
1489                  * but I' d like to return a valid offset (>=0) to allow
1490                  * the caller to do everything it want with the retval.
1491                  */
1492                 schedule();
1493                 goto out;
1494         default:
1495                 /*
1496                  * Another bit of PARANOID. Note that the retval will be
1497                  * 0 since no piece of kernel is supposed to do a check
1498                  * for a negative retval of schedule_timeout() (since it
1499                  * should never happens anyway). You just have the printk()
1500                  * that will tell you if something is gone wrong and where.
1501                  */
1502                 if (timeout < 0) {
1503                         printk(KERN_ERR "schedule_timeout: wrong timeout "
1504                                 "value %lx\n", timeout);
1505                         dump_stack();
1506                         current->state = TASK_RUNNING;
1507                         goto out;
1508                 }
1509         }
1510
1511         expire = timeout + jiffies;
1512
1513         setup_timer_on_stack(&timer, process_timeout, (unsigned long)current);
1514         __mod_timer(&timer, expire, false, TIMER_NOT_PINNED);
1515         schedule();
1516         del_singleshot_timer_sync(&timer);
1517
1518         /* Remove the timer from the object tracker */
1519         destroy_timer_on_stack(&timer);
1520
1521         timeout = expire - jiffies;
1522
1523  out:
1524         return timeout < 0 ? 0 : timeout;
1525 }
1526 EXPORT_SYMBOL(schedule_timeout);
1527
1528 /*
1529  * We can use __set_current_state() here because schedule_timeout() calls
1530  * schedule() unconditionally.
1531  */
1532 signed long __sched schedule_timeout_interruptible(signed long timeout)
1533 {
1534         __set_current_state(TASK_INTERRUPTIBLE);
1535         return schedule_timeout(timeout);
1536 }
1537 EXPORT_SYMBOL(schedule_timeout_interruptible);
1538
1539 signed long __sched schedule_timeout_killable(signed long timeout)
1540 {
1541         __set_current_state(TASK_KILLABLE);
1542         return schedule_timeout(timeout);
1543 }
1544 EXPORT_SYMBOL(schedule_timeout_killable);
1545
1546 signed long __sched schedule_timeout_uninterruptible(signed long timeout)
1547 {
1548         __set_current_state(TASK_UNINTERRUPTIBLE);
1549         return schedule_timeout(timeout);
1550 }
1551 EXPORT_SYMBOL(schedule_timeout_uninterruptible);
1552
1553 #ifdef CONFIG_HOTPLUG_CPU
1554 static void migrate_timer_list(struct tvec_base *new_base, struct hlist_head *head)
1555 {
1556         struct timer_list *timer;
1557         int cpu = new_base->cpu;
1558
1559         while (!hlist_empty(head)) {
1560                 timer = hlist_entry(head->first, struct timer_list, entry);
1561                 /* We ignore the accounting on the dying cpu */
1562                 detach_timer(timer, false);
1563                 timer->flags = (timer->flags & ~TIMER_BASEMASK) | cpu;
1564                 internal_add_timer(new_base, timer);
1565         }
1566 }
1567
1568 static void migrate_timers(int cpu)
1569 {
1570         struct tvec_base *old_base;
1571         struct tvec_base *new_base;
1572         int i;
1573
1574         BUG_ON(cpu_online(cpu));
1575         old_base = per_cpu_ptr(&tvec_bases, cpu);
1576         new_base = get_cpu_ptr(&tvec_bases);
1577         /*
1578          * The caller is globally serialized and nobody else
1579          * takes two locks at once, deadlock is not possible.
1580          */
1581         spin_lock_irq(&new_base->lock);
1582         spin_lock_nested(&old_base->lock, SINGLE_DEPTH_NESTING);
1583
1584         BUG_ON(old_base->running_timer);
1585
1586         for (i = 0; i < TVR_SIZE; i++)
1587                 migrate_timer_list(new_base, old_base->tv1.vec + i);
1588         for (i = 0; i < TVN_SIZE; i++) {
1589                 migrate_timer_list(new_base, old_base->tv2.vec + i);
1590                 migrate_timer_list(new_base, old_base->tv3.vec + i);
1591                 migrate_timer_list(new_base, old_base->tv4.vec + i);
1592                 migrate_timer_list(new_base, old_base->tv5.vec + i);
1593         }
1594
1595         old_base->active_timers = 0;
1596         old_base->all_timers = 0;
1597
1598         spin_unlock(&old_base->lock);
1599         spin_unlock_irq(&new_base->lock);
1600         put_cpu_ptr(&tvec_bases);
1601 }
1602
1603 static int timer_cpu_notify(struct notifier_block *self,
1604                                 unsigned long action, void *hcpu)
1605 {
1606         switch (action) {
1607         case CPU_DEAD:
1608         case CPU_DEAD_FROZEN:
1609                 migrate_timers((long)hcpu);
1610                 break;
1611         default:
1612                 break;
1613         }
1614
1615         return NOTIFY_OK;
1616 }
1617
1618 static inline void timer_register_cpu_notifier(void)
1619 {
1620         cpu_notifier(timer_cpu_notify, 0);
1621 }
1622 #else
1623 static inline void timer_register_cpu_notifier(void) { }
1624 #endif /* CONFIG_HOTPLUG_CPU */
1625
1626 static void __init init_timer_cpu(int cpu)
1627 {
1628         struct tvec_base *base = per_cpu_ptr(&tvec_bases, cpu);
1629
1630         base->cpu = cpu;
1631         spin_lock_init(&base->lock);
1632
1633         base->timer_jiffies = jiffies;
1634         base->next_timer = base->timer_jiffies;
1635 }
1636
1637 static void __init init_timer_cpus(void)
1638 {
1639         int cpu;
1640
1641         for_each_possible_cpu(cpu)
1642                 init_timer_cpu(cpu);
1643 }
1644
1645 void __init init_timers(void)
1646 {
1647         init_timer_cpus();
1648         init_timer_stats();
1649         timer_register_cpu_notifier();
1650         open_softirq(TIMER_SOFTIRQ, run_timer_softirq);
1651 }
1652
1653 /**
1654  * msleep - sleep safely even with waitqueue interruptions
1655  * @msecs: Time in milliseconds to sleep for
1656  */
1657 void msleep(unsigned int msecs)
1658 {
1659         unsigned long timeout = msecs_to_jiffies(msecs) + 1;
1660
1661         while (timeout)
1662                 timeout = schedule_timeout_uninterruptible(timeout);
1663 }
1664
1665 EXPORT_SYMBOL(msleep);
1666
1667 /**
1668  * msleep_interruptible - sleep waiting for signals
1669  * @msecs: Time in milliseconds to sleep for
1670  */
1671 unsigned long msleep_interruptible(unsigned int msecs)
1672 {
1673         unsigned long timeout = msecs_to_jiffies(msecs) + 1;
1674
1675         while (timeout && !signal_pending(current))
1676                 timeout = schedule_timeout_interruptible(timeout);
1677         return jiffies_to_msecs(timeout);
1678 }
1679
1680 EXPORT_SYMBOL(msleep_interruptible);
1681
1682 static void __sched do_usleep_range(unsigned long min, unsigned long max)
1683 {
1684         ktime_t kmin;
1685         unsigned long delta;
1686
1687         kmin = ktime_set(0, min * NSEC_PER_USEC);
1688         delta = (max - min) * NSEC_PER_USEC;
1689         schedule_hrtimeout_range(&kmin, delta, HRTIMER_MODE_REL);
1690 }
1691
1692 /**
1693  * usleep_range - Drop in replacement for udelay where wakeup is flexible
1694  * @min: Minimum time in usecs to sleep
1695  * @max: Maximum time in usecs to sleep
1696  */
1697 void __sched usleep_range(unsigned long min, unsigned long max)
1698 {
1699         __set_current_state(TASK_UNINTERRUPTIBLE);
1700         do_usleep_range(min, max);
1701 }
1702 EXPORT_SYMBOL(usleep_range);