timers: Prevent base clock rewind when forwarding clock
[cascardo/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  * The timer wheel has LVL_DEPTH array levels. Each level provides an array of
63  * LVL_SIZE buckets. Each level is driven by its own clock and therefor each
64  * level has a different granularity.
65  *
66  * The level granularity is:            LVL_CLK_DIV ^ lvl
67  * The level clock frequency is:        HZ / (LVL_CLK_DIV ^ level)
68  *
69  * The array level of a newly armed timer depends on the relative expiry
70  * time. The farther the expiry time is away the higher the array level and
71  * therefor the granularity becomes.
72  *
73  * Contrary to the original timer wheel implementation, which aims for 'exact'
74  * expiry of the timers, this implementation removes the need for recascading
75  * the timers into the lower array levels. The previous 'classic' timer wheel
76  * implementation of the kernel already violated the 'exact' expiry by adding
77  * slack to the expiry time to provide batched expiration. The granularity
78  * levels provide implicit batching.
79  *
80  * This is an optimization of the original timer wheel implementation for the
81  * majority of the timer wheel use cases: timeouts. The vast majority of
82  * timeout timers (networking, disk I/O ...) are canceled before expiry. If
83  * the timeout expires it indicates that normal operation is disturbed, so it
84  * does not matter much whether the timeout comes with a slight delay.
85  *
86  * The only exception to this are networking timers with a small expiry
87  * time. They rely on the granularity. Those fit into the first wheel level,
88  * which has HZ granularity.
89  *
90  * We don't have cascading anymore. timers with a expiry time above the
91  * capacity of the last wheel level are force expired at the maximum timeout
92  * value of the last wheel level. From data sampling we know that the maximum
93  * value observed is 5 days (network connection tracking), so this should not
94  * be an issue.
95  *
96  * The currently chosen array constants values are a good compromise between
97  * array size and granularity.
98  *
99  * This results in the following granularity and range levels:
100  *
101  * HZ 1000 steps
102  * Level Offset  Granularity            Range
103  *  0      0         1 ms                0 ms -         63 ms
104  *  1     64         8 ms               64 ms -        511 ms
105  *  2    128        64 ms              512 ms -       4095 ms (512ms - ~4s)
106  *  3    192       512 ms             4096 ms -      32767 ms (~4s - ~32s)
107  *  4    256      4096 ms (~4s)      32768 ms -     262143 ms (~32s - ~4m)
108  *  5    320     32768 ms (~32s)    262144 ms -    2097151 ms (~4m - ~34m)
109  *  6    384    262144 ms (~4m)    2097152 ms -   16777215 ms (~34m - ~4h)
110  *  7    448   2097152 ms (~34m)  16777216 ms -  134217727 ms (~4h - ~1d)
111  *  8    512  16777216 ms (~4h)  134217728 ms - 1073741822 ms (~1d - ~12d)
112  *
113  * HZ  300
114  * Level Offset  Granularity            Range
115  *  0      0         3 ms                0 ms -        210 ms
116  *  1     64        26 ms              213 ms -       1703 ms (213ms - ~1s)
117  *  2    128       213 ms             1706 ms -      13650 ms (~1s - ~13s)
118  *  3    192      1706 ms (~1s)      13653 ms -     109223 ms (~13s - ~1m)
119  *  4    256     13653 ms (~13s)    109226 ms -     873810 ms (~1m - ~14m)
120  *  5    320    109226 ms (~1m)     873813 ms -    6990503 ms (~14m - ~1h)
121  *  6    384    873813 ms (~14m)   6990506 ms -   55924050 ms (~1h - ~15h)
122  *  7    448   6990506 ms (~1h)   55924053 ms -  447392423 ms (~15h - ~5d)
123  *  8    512  55924053 ms (~15h) 447392426 ms - 3579139406 ms (~5d - ~41d)
124  *
125  * HZ  250
126  * Level Offset  Granularity            Range
127  *  0      0         4 ms                0 ms -        255 ms
128  *  1     64        32 ms              256 ms -       2047 ms (256ms - ~2s)
129  *  2    128       256 ms             2048 ms -      16383 ms (~2s - ~16s)
130  *  3    192      2048 ms (~2s)      16384 ms -     131071 ms (~16s - ~2m)
131  *  4    256     16384 ms (~16s)    131072 ms -    1048575 ms (~2m - ~17m)
132  *  5    320    131072 ms (~2m)    1048576 ms -    8388607 ms (~17m - ~2h)
133  *  6    384   1048576 ms (~17m)   8388608 ms -   67108863 ms (~2h - ~18h)
134  *  7    448   8388608 ms (~2h)   67108864 ms -  536870911 ms (~18h - ~6d)
135  *  8    512  67108864 ms (~18h) 536870912 ms - 4294967288 ms (~6d - ~49d)
136  *
137  * HZ  100
138  * Level Offset  Granularity            Range
139  *  0      0         10 ms               0 ms -        630 ms
140  *  1     64         80 ms             640 ms -       5110 ms (640ms - ~5s)
141  *  2    128        640 ms            5120 ms -      40950 ms (~5s - ~40s)
142  *  3    192       5120 ms (~5s)     40960 ms -     327670 ms (~40s - ~5m)
143  *  4    256      40960 ms (~40s)   327680 ms -    2621430 ms (~5m - ~43m)
144  *  5    320     327680 ms (~5m)   2621440 ms -   20971510 ms (~43m - ~5h)
145  *  6    384    2621440 ms (~43m) 20971520 ms -  167772150 ms (~5h - ~1d)
146  *  7    448   20971520 ms (~5h) 167772160 ms - 1342177270 ms (~1d - ~15d)
147  */
148
149 /* Clock divisor for the next level */
150 #define LVL_CLK_SHIFT   3
151 #define LVL_CLK_DIV     (1UL << LVL_CLK_SHIFT)
152 #define LVL_CLK_MASK    (LVL_CLK_DIV - 1)
153 #define LVL_SHIFT(n)    ((n) * LVL_CLK_SHIFT)
154 #define LVL_GRAN(n)     (1UL << LVL_SHIFT(n))
155
156 /*
157  * The time start value for each level to select the bucket at enqueue
158  * time.
159  */
160 #define LVL_START(n)    ((LVL_SIZE - 1) << (((n) - 1) * LVL_CLK_SHIFT))
161
162 /* Size of each clock level */
163 #define LVL_BITS        6
164 #define LVL_SIZE        (1UL << LVL_BITS)
165 #define LVL_MASK        (LVL_SIZE - 1)
166 #define LVL_OFFS(n)     ((n) * LVL_SIZE)
167
168 /* Level depth */
169 #if HZ > 100
170 # define LVL_DEPTH      9
171 # else
172 # define LVL_DEPTH      8
173 #endif
174
175 /* The cutoff (max. capacity of the wheel) */
176 #define WHEEL_TIMEOUT_CUTOFF    (LVL_START(LVL_DEPTH))
177 #define WHEEL_TIMEOUT_MAX       (WHEEL_TIMEOUT_CUTOFF - LVL_GRAN(LVL_DEPTH - 1))
178
179 /*
180  * The resulting wheel size. If NOHZ is configured we allocate two
181  * wheels so we have a separate storage for the deferrable timers.
182  */
183 #define WHEEL_SIZE      (LVL_SIZE * LVL_DEPTH)
184
185 #ifdef CONFIG_NO_HZ_COMMON
186 # define NR_BASES       2
187 # define BASE_STD       0
188 # define BASE_DEF       1
189 #else
190 # define NR_BASES       1
191 # define BASE_STD       0
192 # define BASE_DEF       0
193 #endif
194
195 struct timer_base {
196         spinlock_t              lock;
197         struct timer_list       *running_timer;
198         unsigned long           clk;
199         unsigned long           next_expiry;
200         unsigned int            cpu;
201         bool                    migration_enabled;
202         bool                    nohz_active;
203         bool                    is_idle;
204         DECLARE_BITMAP(pending_map, WHEEL_SIZE);
205         struct hlist_head       vectors[WHEEL_SIZE];
206 } ____cacheline_aligned;
207
208 static DEFINE_PER_CPU(struct timer_base, timer_bases[NR_BASES]);
209
210 #if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
211 unsigned int sysctl_timer_migration = 1;
212
213 void timers_update_migration(bool update_nohz)
214 {
215         bool on = sysctl_timer_migration && tick_nohz_active;
216         unsigned int cpu;
217
218         /* Avoid the loop, if nothing to update */
219         if (this_cpu_read(timer_bases[BASE_STD].migration_enabled) == on)
220                 return;
221
222         for_each_possible_cpu(cpu) {
223                 per_cpu(timer_bases[BASE_STD].migration_enabled, cpu) = on;
224                 per_cpu(timer_bases[BASE_DEF].migration_enabled, cpu) = on;
225                 per_cpu(hrtimer_bases.migration_enabled, cpu) = on;
226                 if (!update_nohz)
227                         continue;
228                 per_cpu(timer_bases[BASE_STD].nohz_active, cpu) = true;
229                 per_cpu(timer_bases[BASE_DEF].nohz_active, cpu) = true;
230                 per_cpu(hrtimer_bases.nohz_active, cpu) = true;
231         }
232 }
233
234 int timer_migration_handler(struct ctl_table *table, int write,
235                             void __user *buffer, size_t *lenp,
236                             loff_t *ppos)
237 {
238         static DEFINE_MUTEX(mutex);
239         int ret;
240
241         mutex_lock(&mutex);
242         ret = proc_dointvec(table, write, buffer, lenp, ppos);
243         if (!ret && write)
244                 timers_update_migration(false);
245         mutex_unlock(&mutex);
246         return ret;
247 }
248 #endif
249
250 static unsigned long round_jiffies_common(unsigned long j, int cpu,
251                 bool force_up)
252 {
253         int rem;
254         unsigned long original = j;
255
256         /*
257          * We don't want all cpus firing their timers at once hitting the
258          * same lock or cachelines, so we skew each extra cpu with an extra
259          * 3 jiffies. This 3 jiffies came originally from the mm/ code which
260          * already did this.
261          * The skew is done by adding 3*cpunr, then round, then subtract this
262          * extra offset again.
263          */
264         j += cpu * 3;
265
266         rem = j % HZ;
267
268         /*
269          * If the target jiffie is just after a whole second (which can happen
270          * due to delays of the timer irq, long irq off times etc etc) then
271          * we should round down to the whole second, not up. Use 1/4th second
272          * as cutoff for this rounding as an extreme upper bound for this.
273          * But never round down if @force_up is set.
274          */
275         if (rem < HZ/4 && !force_up) /* round down */
276                 j = j - rem;
277         else /* round up */
278                 j = j - rem + HZ;
279
280         /* now that we have rounded, subtract the extra skew again */
281         j -= cpu * 3;
282
283         /*
284          * Make sure j is still in the future. Otherwise return the
285          * unmodified value.
286          */
287         return time_is_after_jiffies(j) ? j : original;
288 }
289
290 /**
291  * __round_jiffies - function to round jiffies to a full second
292  * @j: the time in (absolute) jiffies that should be rounded
293  * @cpu: the processor number on which the timeout will happen
294  *
295  * __round_jiffies() rounds an absolute time in the future (in jiffies)
296  * up or down to (approximately) full seconds. This is useful for timers
297  * for which the exact time they fire does not matter too much, as long as
298  * they fire approximately every X seconds.
299  *
300  * By rounding these timers to whole seconds, all such timers will fire
301  * at the same time, rather than at various times spread out. The goal
302  * of this is to have the CPU wake up less, which saves power.
303  *
304  * The exact rounding is skewed for each processor to avoid all
305  * processors firing at the exact same time, which could lead
306  * to lock contention or spurious cache line bouncing.
307  *
308  * The return value is the rounded version of the @j parameter.
309  */
310 unsigned long __round_jiffies(unsigned long j, int cpu)
311 {
312         return round_jiffies_common(j, cpu, false);
313 }
314 EXPORT_SYMBOL_GPL(__round_jiffies);
315
316 /**
317  * __round_jiffies_relative - function to round jiffies to a full second
318  * @j: the time in (relative) jiffies that should be rounded
319  * @cpu: the processor number on which the timeout will happen
320  *
321  * __round_jiffies_relative() rounds a time delta  in the future (in jiffies)
322  * up or down to (approximately) full seconds. This is useful for timers
323  * for which the exact time they fire does not matter too much, as long as
324  * they fire approximately every X seconds.
325  *
326  * By rounding these timers to whole seconds, all such timers will fire
327  * at the same time, rather than at various times spread out. The goal
328  * of this is to have the CPU wake up less, which saves power.
329  *
330  * The exact rounding is skewed for each processor to avoid all
331  * processors firing at the exact same time, which could lead
332  * to lock contention or spurious cache line bouncing.
333  *
334  * The return value is the rounded version of the @j parameter.
335  */
336 unsigned long __round_jiffies_relative(unsigned long j, int cpu)
337 {
338         unsigned long j0 = jiffies;
339
340         /* Use j0 because jiffies might change while we run */
341         return round_jiffies_common(j + j0, cpu, false) - j0;
342 }
343 EXPORT_SYMBOL_GPL(__round_jiffies_relative);
344
345 /**
346  * round_jiffies - function to round jiffies to a full second
347  * @j: the time in (absolute) jiffies that should be rounded
348  *
349  * round_jiffies() rounds an absolute time in the future (in jiffies)
350  * up or down to (approximately) full seconds. This is useful for timers
351  * for which the exact time they fire does not matter too much, as long as
352  * they fire approximately every X seconds.
353  *
354  * By rounding these timers to whole seconds, all such timers will fire
355  * at the same time, rather than at various times spread out. The goal
356  * of this is to have the CPU wake up less, which saves power.
357  *
358  * The return value is the rounded version of the @j parameter.
359  */
360 unsigned long round_jiffies(unsigned long j)
361 {
362         return round_jiffies_common(j, raw_smp_processor_id(), false);
363 }
364 EXPORT_SYMBOL_GPL(round_jiffies);
365
366 /**
367  * round_jiffies_relative - function to round jiffies to a full second
368  * @j: the time in (relative) jiffies that should be rounded
369  *
370  * round_jiffies_relative() rounds a time delta  in the future (in jiffies)
371  * up or down to (approximately) full seconds. This is useful for timers
372  * for which the exact time they fire does not matter too much, as long as
373  * they fire approximately every X seconds.
374  *
375  * By rounding these timers to whole seconds, all such timers will fire
376  * at the same time, rather than at various times spread out. The goal
377  * of this is to have the CPU wake up less, which saves power.
378  *
379  * The return value is the rounded version of the @j parameter.
380  */
381 unsigned long round_jiffies_relative(unsigned long j)
382 {
383         return __round_jiffies_relative(j, raw_smp_processor_id());
384 }
385 EXPORT_SYMBOL_GPL(round_jiffies_relative);
386
387 /**
388  * __round_jiffies_up - function to round jiffies up to a full second
389  * @j: the time in (absolute) jiffies that should be rounded
390  * @cpu: the processor number on which the timeout will happen
391  *
392  * This is the same as __round_jiffies() except that it will never
393  * round down.  This is useful for timeouts for which the exact time
394  * of firing does not matter too much, as long as they don't fire too
395  * early.
396  */
397 unsigned long __round_jiffies_up(unsigned long j, int cpu)
398 {
399         return round_jiffies_common(j, cpu, true);
400 }
401 EXPORT_SYMBOL_GPL(__round_jiffies_up);
402
403 /**
404  * __round_jiffies_up_relative - function to round jiffies up to a full second
405  * @j: the time in (relative) jiffies that should be rounded
406  * @cpu: the processor number on which the timeout will happen
407  *
408  * This is the same as __round_jiffies_relative() except that it will never
409  * round down.  This is useful for timeouts for which the exact time
410  * of firing does not matter too much, as long as they don't fire too
411  * early.
412  */
413 unsigned long __round_jiffies_up_relative(unsigned long j, int cpu)
414 {
415         unsigned long j0 = jiffies;
416
417         /* Use j0 because jiffies might change while we run */
418         return round_jiffies_common(j + j0, cpu, true) - j0;
419 }
420 EXPORT_SYMBOL_GPL(__round_jiffies_up_relative);
421
422 /**
423  * round_jiffies_up - function to round jiffies up to a full second
424  * @j: the time in (absolute) jiffies that should be rounded
425  *
426  * This is the same as round_jiffies() except that it will never
427  * round down.  This is useful for timeouts for which the exact time
428  * of firing does not matter too much, as long as they don't fire too
429  * early.
430  */
431 unsigned long round_jiffies_up(unsigned long j)
432 {
433         return round_jiffies_common(j, raw_smp_processor_id(), true);
434 }
435 EXPORT_SYMBOL_GPL(round_jiffies_up);
436
437 /**
438  * round_jiffies_up_relative - function to round jiffies up to a full second
439  * @j: the time in (relative) jiffies that should be rounded
440  *
441  * This is the same as round_jiffies_relative() except that it will never
442  * round down.  This is useful for timeouts for which the exact time
443  * of firing does not matter too much, as long as they don't fire too
444  * early.
445  */
446 unsigned long round_jiffies_up_relative(unsigned long j)
447 {
448         return __round_jiffies_up_relative(j, raw_smp_processor_id());
449 }
450 EXPORT_SYMBOL_GPL(round_jiffies_up_relative);
451
452
453 static inline unsigned int timer_get_idx(struct timer_list *timer)
454 {
455         return (timer->flags & TIMER_ARRAYMASK) >> TIMER_ARRAYSHIFT;
456 }
457
458 static inline void timer_set_idx(struct timer_list *timer, unsigned int idx)
459 {
460         timer->flags = (timer->flags & ~TIMER_ARRAYMASK) |
461                         idx << TIMER_ARRAYSHIFT;
462 }
463
464 /*
465  * Helper function to calculate the array index for a given expiry
466  * time.
467  */
468 static inline unsigned calc_index(unsigned expires, unsigned lvl)
469 {
470         expires = (expires + LVL_GRAN(lvl)) >> LVL_SHIFT(lvl);
471         return LVL_OFFS(lvl) + (expires & LVL_MASK);
472 }
473
474 static int calc_wheel_index(unsigned long expires, unsigned long clk)
475 {
476         unsigned long delta = expires - clk;
477         unsigned int idx;
478
479         if (delta < LVL_START(1)) {
480                 idx = calc_index(expires, 0);
481         } else if (delta < LVL_START(2)) {
482                 idx = calc_index(expires, 1);
483         } else if (delta < LVL_START(3)) {
484                 idx = calc_index(expires, 2);
485         } else if (delta < LVL_START(4)) {
486                 idx = calc_index(expires, 3);
487         } else if (delta < LVL_START(5)) {
488                 idx = calc_index(expires, 4);
489         } else if (delta < LVL_START(6)) {
490                 idx = calc_index(expires, 5);
491         } else if (delta < LVL_START(7)) {
492                 idx = calc_index(expires, 6);
493         } else if (LVL_DEPTH > 8 && delta < LVL_START(8)) {
494                 idx = calc_index(expires, 7);
495         } else if ((long) delta < 0) {
496                 idx = clk & LVL_MASK;
497         } else {
498                 /*
499                  * Force expire obscene large timeouts to expire at the
500                  * capacity limit of the wheel.
501                  */
502                 if (expires >= WHEEL_TIMEOUT_CUTOFF)
503                         expires = WHEEL_TIMEOUT_MAX;
504
505                 idx = calc_index(expires, LVL_DEPTH - 1);
506         }
507         return idx;
508 }
509
510 /*
511  * Enqueue the timer into the hash bucket, mark it pending in
512  * the bitmap and store the index in the timer flags.
513  */
514 static void enqueue_timer(struct timer_base *base, struct timer_list *timer,
515                           unsigned int idx)
516 {
517         hlist_add_head(&timer->entry, base->vectors + idx);
518         __set_bit(idx, base->pending_map);
519         timer_set_idx(timer, idx);
520 }
521
522 static void
523 __internal_add_timer(struct timer_base *base, struct timer_list *timer)
524 {
525         unsigned int idx;
526
527         idx = calc_wheel_index(timer->expires, base->clk);
528         enqueue_timer(base, timer, idx);
529 }
530
531 static void
532 trigger_dyntick_cpu(struct timer_base *base, struct timer_list *timer)
533 {
534         if (!IS_ENABLED(CONFIG_NO_HZ_COMMON) || !base->nohz_active)
535                 return;
536
537         /*
538          * TODO: This wants some optimizing similar to the code below, but we
539          * will do that when we switch from push to pull for deferrable timers.
540          */
541         if (timer->flags & TIMER_DEFERRABLE) {
542                 if (tick_nohz_full_cpu(base->cpu))
543                         wake_up_nohz_cpu(base->cpu);
544                 return;
545         }
546
547         /*
548          * We might have to IPI the remote CPU if the base is idle and the
549          * timer is not deferrable. If the other CPU is on the way to idle
550          * then it can't set base->is_idle as we hold the base lock:
551          */
552         if (!base->is_idle)
553                 return;
554
555         /* Check whether this is the new first expiring timer: */
556         if (time_after_eq(timer->expires, base->next_expiry))
557                 return;
558
559         /*
560          * Set the next expiry time and kick the CPU so it can reevaluate the
561          * wheel:
562          */
563         base->next_expiry = timer->expires;
564                 wake_up_nohz_cpu(base->cpu);
565 }
566
567 static void
568 internal_add_timer(struct timer_base *base, struct timer_list *timer)
569 {
570         __internal_add_timer(base, timer);
571         trigger_dyntick_cpu(base, timer);
572 }
573
574 #ifdef CONFIG_TIMER_STATS
575 void __timer_stats_timer_set_start_info(struct timer_list *timer, void *addr)
576 {
577         if (timer->start_site)
578                 return;
579
580         timer->start_site = addr;
581         memcpy(timer->start_comm, current->comm, TASK_COMM_LEN);
582         timer->start_pid = current->pid;
583 }
584
585 static void timer_stats_account_timer(struct timer_list *timer)
586 {
587         void *site;
588
589         /*
590          * start_site can be concurrently reset by
591          * timer_stats_timer_clear_start_info()
592          */
593         site = READ_ONCE(timer->start_site);
594         if (likely(!site))
595                 return;
596
597         timer_stats_update_stats(timer, timer->start_pid, site,
598                                  timer->function, timer->start_comm,
599                                  timer->flags);
600 }
601
602 #else
603 static void timer_stats_account_timer(struct timer_list *timer) {}
604 #endif
605
606 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
607
608 static struct debug_obj_descr timer_debug_descr;
609
610 static void *timer_debug_hint(void *addr)
611 {
612         return ((struct timer_list *) addr)->function;
613 }
614
615 static bool timer_is_static_object(void *addr)
616 {
617         struct timer_list *timer = addr;
618
619         return (timer->entry.pprev == NULL &&
620                 timer->entry.next == TIMER_ENTRY_STATIC);
621 }
622
623 /*
624  * fixup_init is called when:
625  * - an active object is initialized
626  */
627 static bool timer_fixup_init(void *addr, enum debug_obj_state state)
628 {
629         struct timer_list *timer = addr;
630
631         switch (state) {
632         case ODEBUG_STATE_ACTIVE:
633                 del_timer_sync(timer);
634                 debug_object_init(timer, &timer_debug_descr);
635                 return true;
636         default:
637                 return false;
638         }
639 }
640
641 /* Stub timer callback for improperly used timers. */
642 static void stub_timer(unsigned long data)
643 {
644         WARN_ON(1);
645 }
646
647 /*
648  * fixup_activate is called when:
649  * - an active object is activated
650  * - an unknown non-static object is activated
651  */
652 static bool timer_fixup_activate(void *addr, enum debug_obj_state state)
653 {
654         struct timer_list *timer = addr;
655
656         switch (state) {
657         case ODEBUG_STATE_NOTAVAILABLE:
658                 setup_timer(timer, stub_timer, 0);
659                 return true;
660
661         case ODEBUG_STATE_ACTIVE:
662                 WARN_ON(1);
663
664         default:
665                 return false;
666         }
667 }
668
669 /*
670  * fixup_free is called when:
671  * - an active object is freed
672  */
673 static bool timer_fixup_free(void *addr, enum debug_obj_state state)
674 {
675         struct timer_list *timer = addr;
676
677         switch (state) {
678         case ODEBUG_STATE_ACTIVE:
679                 del_timer_sync(timer);
680                 debug_object_free(timer, &timer_debug_descr);
681                 return true;
682         default:
683                 return false;
684         }
685 }
686
687 /*
688  * fixup_assert_init is called when:
689  * - an untracked/uninit-ed object is found
690  */
691 static bool timer_fixup_assert_init(void *addr, enum debug_obj_state state)
692 {
693         struct timer_list *timer = addr;
694
695         switch (state) {
696         case ODEBUG_STATE_NOTAVAILABLE:
697                 setup_timer(timer, stub_timer, 0);
698                 return true;
699         default:
700                 return false;
701         }
702 }
703
704 static struct debug_obj_descr timer_debug_descr = {
705         .name                   = "timer_list",
706         .debug_hint             = timer_debug_hint,
707         .is_static_object       = timer_is_static_object,
708         .fixup_init             = timer_fixup_init,
709         .fixup_activate         = timer_fixup_activate,
710         .fixup_free             = timer_fixup_free,
711         .fixup_assert_init      = timer_fixup_assert_init,
712 };
713
714 static inline void debug_timer_init(struct timer_list *timer)
715 {
716         debug_object_init(timer, &timer_debug_descr);
717 }
718
719 static inline void debug_timer_activate(struct timer_list *timer)
720 {
721         debug_object_activate(timer, &timer_debug_descr);
722 }
723
724 static inline void debug_timer_deactivate(struct timer_list *timer)
725 {
726         debug_object_deactivate(timer, &timer_debug_descr);
727 }
728
729 static inline void debug_timer_free(struct timer_list *timer)
730 {
731         debug_object_free(timer, &timer_debug_descr);
732 }
733
734 static inline void debug_timer_assert_init(struct timer_list *timer)
735 {
736         debug_object_assert_init(timer, &timer_debug_descr);
737 }
738
739 static void do_init_timer(struct timer_list *timer, unsigned int flags,
740                           const char *name, struct lock_class_key *key);
741
742 void init_timer_on_stack_key(struct timer_list *timer, unsigned int flags,
743                              const char *name, struct lock_class_key *key)
744 {
745         debug_object_init_on_stack(timer, &timer_debug_descr);
746         do_init_timer(timer, flags, name, key);
747 }
748 EXPORT_SYMBOL_GPL(init_timer_on_stack_key);
749
750 void destroy_timer_on_stack(struct timer_list *timer)
751 {
752         debug_object_free(timer, &timer_debug_descr);
753 }
754 EXPORT_SYMBOL_GPL(destroy_timer_on_stack);
755
756 #else
757 static inline void debug_timer_init(struct timer_list *timer) { }
758 static inline void debug_timer_activate(struct timer_list *timer) { }
759 static inline void debug_timer_deactivate(struct timer_list *timer) { }
760 static inline void debug_timer_assert_init(struct timer_list *timer) { }
761 #endif
762
763 static inline void debug_init(struct timer_list *timer)
764 {
765         debug_timer_init(timer);
766         trace_timer_init(timer);
767 }
768
769 static inline void
770 debug_activate(struct timer_list *timer, unsigned long expires)
771 {
772         debug_timer_activate(timer);
773         trace_timer_start(timer, expires, timer->flags);
774 }
775
776 static inline void debug_deactivate(struct timer_list *timer)
777 {
778         debug_timer_deactivate(timer);
779         trace_timer_cancel(timer);
780 }
781
782 static inline void debug_assert_init(struct timer_list *timer)
783 {
784         debug_timer_assert_init(timer);
785 }
786
787 static void do_init_timer(struct timer_list *timer, unsigned int flags,
788                           const char *name, struct lock_class_key *key)
789 {
790         timer->entry.pprev = NULL;
791         timer->flags = flags | raw_smp_processor_id();
792 #ifdef CONFIG_TIMER_STATS
793         timer->start_site = NULL;
794         timer->start_pid = -1;
795         memset(timer->start_comm, 0, TASK_COMM_LEN);
796 #endif
797         lockdep_init_map(&timer->lockdep_map, name, key, 0);
798 }
799
800 /**
801  * init_timer_key - initialize a timer
802  * @timer: the timer to be initialized
803  * @flags: timer flags
804  * @name: name of the timer
805  * @key: lockdep class key of the fake lock used for tracking timer
806  *       sync lock dependencies
807  *
808  * init_timer_key() must be done to a timer prior calling *any* of the
809  * other timer functions.
810  */
811 void init_timer_key(struct timer_list *timer, unsigned int flags,
812                     const char *name, struct lock_class_key *key)
813 {
814         debug_init(timer);
815         do_init_timer(timer, flags, name, key);
816 }
817 EXPORT_SYMBOL(init_timer_key);
818
819 static inline void detach_timer(struct timer_list *timer, bool clear_pending)
820 {
821         struct hlist_node *entry = &timer->entry;
822
823         debug_deactivate(timer);
824
825         __hlist_del(entry);
826         if (clear_pending)
827                 entry->pprev = NULL;
828         entry->next = LIST_POISON2;
829 }
830
831 static int detach_if_pending(struct timer_list *timer, struct timer_base *base,
832                              bool clear_pending)
833 {
834         unsigned idx = timer_get_idx(timer);
835
836         if (!timer_pending(timer))
837                 return 0;
838
839         if (hlist_is_singular_node(&timer->entry, base->vectors + idx))
840                 __clear_bit(idx, base->pending_map);
841
842         detach_timer(timer, clear_pending);
843         return 1;
844 }
845
846 static inline struct timer_base *get_timer_cpu_base(u32 tflags, u32 cpu)
847 {
848         struct timer_base *base = per_cpu_ptr(&timer_bases[BASE_STD], cpu);
849
850         /*
851          * If the timer is deferrable and nohz is active then we need to use
852          * the deferrable base.
853          */
854         if (IS_ENABLED(CONFIG_NO_HZ_COMMON) && base->nohz_active &&
855             (tflags & TIMER_DEFERRABLE))
856                 base = per_cpu_ptr(&timer_bases[BASE_DEF], cpu);
857         return base;
858 }
859
860 static inline struct timer_base *get_timer_this_cpu_base(u32 tflags)
861 {
862         struct timer_base *base = this_cpu_ptr(&timer_bases[BASE_STD]);
863
864         /*
865          * If the timer is deferrable and nohz is active then we need to use
866          * the deferrable base.
867          */
868         if (IS_ENABLED(CONFIG_NO_HZ_COMMON) && base->nohz_active &&
869             (tflags & TIMER_DEFERRABLE))
870                 base = this_cpu_ptr(&timer_bases[BASE_DEF]);
871         return base;
872 }
873
874 static inline struct timer_base *get_timer_base(u32 tflags)
875 {
876         return get_timer_cpu_base(tflags, tflags & TIMER_CPUMASK);
877 }
878
879 #ifdef CONFIG_NO_HZ_COMMON
880 static inline struct timer_base *
881 __get_target_base(struct timer_base *base, unsigned tflags)
882 {
883 #ifdef CONFIG_SMP
884         if ((tflags & TIMER_PINNED) || !base->migration_enabled)
885                 return get_timer_this_cpu_base(tflags);
886         return get_timer_cpu_base(tflags, get_nohz_timer_target());
887 #else
888         return get_timer_this_cpu_base(tflags);
889 #endif
890 }
891
892 static inline void forward_timer_base(struct timer_base *base)
893 {
894         /*
895          * We only forward the base when it's idle and we have a delta between
896          * base clock and jiffies.
897          */
898         if (!base->is_idle || (long) (jiffies - base->clk) < 2)
899                 return;
900
901         /*
902          * If the next expiry value is > jiffies, then we fast forward to
903          * jiffies otherwise we forward to the next expiry value.
904          */
905         if (time_after(base->next_expiry, jiffies))
906                 base->clk = jiffies;
907         else
908                 base->clk = base->next_expiry;
909 }
910 #else
911 static inline struct timer_base *
912 __get_target_base(struct timer_base *base, unsigned tflags)
913 {
914         return get_timer_this_cpu_base(tflags);
915 }
916
917 static inline void forward_timer_base(struct timer_base *base) { }
918 #endif
919
920 static inline struct timer_base *
921 get_target_base(struct timer_base *base, unsigned tflags)
922 {
923         struct timer_base *target = __get_target_base(base, tflags);
924
925         forward_timer_base(target);
926         return target;
927 }
928
929 /*
930  * We are using hashed locking: Holding per_cpu(timer_bases[x]).lock means
931  * that all timers which are tied to this base are locked, and the base itself
932  * is locked too.
933  *
934  * So __run_timers/migrate_timers can safely modify all timers which could
935  * be found in the base->vectors array.
936  *
937  * When a timer is migrating then the TIMER_MIGRATING flag is set and we need
938  * to wait until the migration is done.
939  */
940 static struct timer_base *lock_timer_base(struct timer_list *timer,
941                                           unsigned long *flags)
942         __acquires(timer->base->lock)
943 {
944         for (;;) {
945                 struct timer_base *base;
946                 u32 tf;
947
948                 /*
949                  * We need to use READ_ONCE() here, otherwise the compiler
950                  * might re-read @tf between the check for TIMER_MIGRATING
951                  * and spin_lock().
952                  */
953                 tf = READ_ONCE(timer->flags);
954
955                 if (!(tf & TIMER_MIGRATING)) {
956                         base = get_timer_base(tf);
957                         spin_lock_irqsave(&base->lock, *flags);
958                         if (timer->flags == tf)
959                                 return base;
960                         spin_unlock_irqrestore(&base->lock, *flags);
961                 }
962                 cpu_relax();
963         }
964 }
965
966 static inline int
967 __mod_timer(struct timer_list *timer, unsigned long expires, bool pending_only)
968 {
969         struct timer_base *base, *new_base;
970         unsigned int idx = UINT_MAX;
971         unsigned long clk = 0, flags;
972         int ret = 0;
973
974         BUG_ON(!timer->function);
975
976         /*
977          * This is a common optimization triggered by the networking code - if
978          * the timer is re-modified to have the same timeout or ends up in the
979          * same array bucket then just return:
980          */
981         if (timer_pending(timer)) {
982                 if (timer->expires == expires)
983                         return 1;
984
985                 /*
986                  * We lock timer base and calculate the bucket index right
987                  * here. If the timer ends up in the same bucket, then we
988                  * just update the expiry time and avoid the whole
989                  * dequeue/enqueue dance.
990                  */
991                 base = lock_timer_base(timer, &flags);
992
993                 clk = base->clk;
994                 idx = calc_wheel_index(expires, clk);
995
996                 /*
997                  * Retrieve and compare the array index of the pending
998                  * timer. If it matches set the expiry to the new value so a
999                  * subsequent call will exit in the expires check above.
1000                  */
1001                 if (idx == timer_get_idx(timer)) {
1002                         timer->expires = expires;
1003                         ret = 1;
1004                         goto out_unlock;
1005                 }
1006         } else {
1007                 base = lock_timer_base(timer, &flags);
1008         }
1009
1010         timer_stats_timer_set_start_info(timer);
1011
1012         ret = detach_if_pending(timer, base, false);
1013         if (!ret && pending_only)
1014                 goto out_unlock;
1015
1016         debug_activate(timer, expires);
1017
1018         new_base = get_target_base(base, timer->flags);
1019
1020         if (base != new_base) {
1021                 /*
1022                  * We are trying to schedule the timer on the new base.
1023                  * However we can't change timer's base while it is running,
1024                  * otherwise del_timer_sync() can't detect that the timer's
1025                  * handler yet has not finished. This also guarantees that the
1026                  * timer is serialized wrt itself.
1027                  */
1028                 if (likely(base->running_timer != timer)) {
1029                         /* See the comment in lock_timer_base() */
1030                         timer->flags |= TIMER_MIGRATING;
1031
1032                         spin_unlock(&base->lock);
1033                         base = new_base;
1034                         spin_lock(&base->lock);
1035                         WRITE_ONCE(timer->flags,
1036                                    (timer->flags & ~TIMER_BASEMASK) | base->cpu);
1037                 }
1038         }
1039
1040         timer->expires = expires;
1041         /*
1042          * If 'idx' was calculated above and the base time did not advance
1043          * between calculating 'idx' and possibly switching the base, only
1044          * enqueue_timer() and trigger_dyntick_cpu() is required. Otherwise
1045          * we need to (re)calculate the wheel index via
1046          * internal_add_timer().
1047          */
1048         if (idx != UINT_MAX && clk == base->clk) {
1049                 enqueue_timer(base, timer, idx);
1050                 trigger_dyntick_cpu(base, timer);
1051         } else {
1052                 internal_add_timer(base, timer);
1053         }
1054
1055 out_unlock:
1056         spin_unlock_irqrestore(&base->lock, flags);
1057
1058         return ret;
1059 }
1060
1061 /**
1062  * mod_timer_pending - modify a pending timer's timeout
1063  * @timer: the pending timer to be modified
1064  * @expires: new timeout in jiffies
1065  *
1066  * mod_timer_pending() is the same for pending timers as mod_timer(),
1067  * but will not re-activate and modify already deleted timers.
1068  *
1069  * It is useful for unserialized use of timers.
1070  */
1071 int mod_timer_pending(struct timer_list *timer, unsigned long expires)
1072 {
1073         return __mod_timer(timer, expires, true);
1074 }
1075 EXPORT_SYMBOL(mod_timer_pending);
1076
1077 /**
1078  * mod_timer - modify a timer's timeout
1079  * @timer: the timer to be modified
1080  * @expires: new timeout in jiffies
1081  *
1082  * mod_timer() is a more efficient way to update the expire field of an
1083  * active timer (if the timer is inactive it will be activated)
1084  *
1085  * mod_timer(timer, expires) is equivalent to:
1086  *
1087  *     del_timer(timer); timer->expires = expires; add_timer(timer);
1088  *
1089  * Note that if there are multiple unserialized concurrent users of the
1090  * same timer, then mod_timer() is the only safe way to modify the timeout,
1091  * since add_timer() cannot modify an already running timer.
1092  *
1093  * The function returns whether it has modified a pending timer or not.
1094  * (ie. mod_timer() of an inactive timer returns 0, mod_timer() of an
1095  * active timer returns 1.)
1096  */
1097 int mod_timer(struct timer_list *timer, unsigned long expires)
1098 {
1099         return __mod_timer(timer, expires, false);
1100 }
1101 EXPORT_SYMBOL(mod_timer);
1102
1103 /**
1104  * add_timer - start a timer
1105  * @timer: the timer to be added
1106  *
1107  * The kernel will do a ->function(->data) callback from the
1108  * timer interrupt at the ->expires point in the future. The
1109  * current time is 'jiffies'.
1110  *
1111  * The timer's ->expires, ->function (and if the handler uses it, ->data)
1112  * fields must be set prior calling this function.
1113  *
1114  * Timers with an ->expires field in the past will be executed in the next
1115  * timer tick.
1116  */
1117 void add_timer(struct timer_list *timer)
1118 {
1119         BUG_ON(timer_pending(timer));
1120         mod_timer(timer, timer->expires);
1121 }
1122 EXPORT_SYMBOL(add_timer);
1123
1124 /**
1125  * add_timer_on - start a timer on a particular CPU
1126  * @timer: the timer to be added
1127  * @cpu: the CPU to start it on
1128  *
1129  * This is not very scalable on SMP. Double adds are not possible.
1130  */
1131 void add_timer_on(struct timer_list *timer, int cpu)
1132 {
1133         struct timer_base *new_base, *base;
1134         unsigned long flags;
1135
1136         timer_stats_timer_set_start_info(timer);
1137         BUG_ON(timer_pending(timer) || !timer->function);
1138
1139         new_base = get_timer_cpu_base(timer->flags, cpu);
1140
1141         /*
1142          * If @timer was on a different CPU, it should be migrated with the
1143          * old base locked to prevent other operations proceeding with the
1144          * wrong base locked.  See lock_timer_base().
1145          */
1146         base = lock_timer_base(timer, &flags);
1147         if (base != new_base) {
1148                 timer->flags |= TIMER_MIGRATING;
1149
1150                 spin_unlock(&base->lock);
1151                 base = new_base;
1152                 spin_lock(&base->lock);
1153                 WRITE_ONCE(timer->flags,
1154                            (timer->flags & ~TIMER_BASEMASK) | cpu);
1155         }
1156
1157         debug_activate(timer, timer->expires);
1158         internal_add_timer(base, timer);
1159         spin_unlock_irqrestore(&base->lock, flags);
1160 }
1161 EXPORT_SYMBOL_GPL(add_timer_on);
1162
1163 /**
1164  * del_timer - deactive a timer.
1165  * @timer: the timer to be deactivated
1166  *
1167  * del_timer() deactivates a timer - this works on both active and inactive
1168  * timers.
1169  *
1170  * The function returns whether it has deactivated a pending timer or not.
1171  * (ie. del_timer() of an inactive timer returns 0, del_timer() of an
1172  * active timer returns 1.)
1173  */
1174 int del_timer(struct timer_list *timer)
1175 {
1176         struct timer_base *base;
1177         unsigned long flags;
1178         int ret = 0;
1179
1180         debug_assert_init(timer);
1181
1182         timer_stats_timer_clear_start_info(timer);
1183         if (timer_pending(timer)) {
1184                 base = lock_timer_base(timer, &flags);
1185                 ret = detach_if_pending(timer, base, true);
1186                 spin_unlock_irqrestore(&base->lock, flags);
1187         }
1188
1189         return ret;
1190 }
1191 EXPORT_SYMBOL(del_timer);
1192
1193 /**
1194  * try_to_del_timer_sync - Try to deactivate a timer
1195  * @timer: timer do del
1196  *
1197  * This function tries to deactivate a timer. Upon successful (ret >= 0)
1198  * exit the timer is not queued and the handler is not running on any CPU.
1199  */
1200 int try_to_del_timer_sync(struct timer_list *timer)
1201 {
1202         struct timer_base *base;
1203         unsigned long flags;
1204         int ret = -1;
1205
1206         debug_assert_init(timer);
1207
1208         base = lock_timer_base(timer, &flags);
1209
1210         if (base->running_timer != timer) {
1211                 timer_stats_timer_clear_start_info(timer);
1212                 ret = detach_if_pending(timer, base, true);
1213         }
1214         spin_unlock_irqrestore(&base->lock, flags);
1215
1216         return ret;
1217 }
1218 EXPORT_SYMBOL(try_to_del_timer_sync);
1219
1220 #ifdef CONFIG_SMP
1221 /**
1222  * del_timer_sync - deactivate a timer and wait for the handler to finish.
1223  * @timer: the timer to be deactivated
1224  *
1225  * This function only differs from del_timer() on SMP: besides deactivating
1226  * the timer it also makes sure the handler has finished executing on other
1227  * CPUs.
1228  *
1229  * Synchronization rules: Callers must prevent restarting of the timer,
1230  * otherwise this function is meaningless. It must not be called from
1231  * interrupt contexts unless the timer is an irqsafe one. The caller must
1232  * not hold locks which would prevent completion of the timer's
1233  * handler. The timer's handler must not call add_timer_on(). Upon exit the
1234  * timer is not queued and the handler is not running on any CPU.
1235  *
1236  * Note: For !irqsafe timers, you must not hold locks that are held in
1237  *   interrupt context while calling this function. Even if the lock has
1238  *   nothing to do with the timer in question.  Here's why:
1239  *
1240  *    CPU0                             CPU1
1241  *    ----                             ----
1242  *                                   <SOFTIRQ>
1243  *                                   call_timer_fn();
1244  *                                     base->running_timer = mytimer;
1245  *  spin_lock_irq(somelock);
1246  *                                     <IRQ>
1247  *                                        spin_lock(somelock);
1248  *  del_timer_sync(mytimer);
1249  *   while (base->running_timer == mytimer);
1250  *
1251  * Now del_timer_sync() will never return and never release somelock.
1252  * The interrupt on the other CPU is waiting to grab somelock but
1253  * it has interrupted the softirq that CPU0 is waiting to finish.
1254  *
1255  * The function returns whether it has deactivated a pending timer or not.
1256  */
1257 int del_timer_sync(struct timer_list *timer)
1258 {
1259 #ifdef CONFIG_LOCKDEP
1260         unsigned long flags;
1261
1262         /*
1263          * If lockdep gives a backtrace here, please reference
1264          * the synchronization rules above.
1265          */
1266         local_irq_save(flags);
1267         lock_map_acquire(&timer->lockdep_map);
1268         lock_map_release(&timer->lockdep_map);
1269         local_irq_restore(flags);
1270 #endif
1271         /*
1272          * don't use it in hardirq context, because it
1273          * could lead to deadlock.
1274          */
1275         WARN_ON(in_irq() && !(timer->flags & TIMER_IRQSAFE));
1276         for (;;) {
1277                 int ret = try_to_del_timer_sync(timer);
1278                 if (ret >= 0)
1279                         return ret;
1280                 cpu_relax();
1281         }
1282 }
1283 EXPORT_SYMBOL(del_timer_sync);
1284 #endif
1285
1286 static void call_timer_fn(struct timer_list *timer, void (*fn)(unsigned long),
1287                           unsigned long data)
1288 {
1289         int count = preempt_count();
1290
1291 #ifdef CONFIG_LOCKDEP
1292         /*
1293          * It is permissible to free the timer from inside the
1294          * function that is called from it, this we need to take into
1295          * account for lockdep too. To avoid bogus "held lock freed"
1296          * warnings as well as problems when looking into
1297          * timer->lockdep_map, make a copy and use that here.
1298          */
1299         struct lockdep_map lockdep_map;
1300
1301         lockdep_copy_map(&lockdep_map, &timer->lockdep_map);
1302 #endif
1303         /*
1304          * Couple the lock chain with the lock chain at
1305          * del_timer_sync() by acquiring the lock_map around the fn()
1306          * call here and in del_timer_sync().
1307          */
1308         lock_map_acquire(&lockdep_map);
1309
1310         trace_timer_expire_entry(timer);
1311         fn(data);
1312         trace_timer_expire_exit(timer);
1313
1314         lock_map_release(&lockdep_map);
1315
1316         if (count != preempt_count()) {
1317                 WARN_ONCE(1, "timer: %pF preempt leak: %08x -> %08x\n",
1318                           fn, count, preempt_count());
1319                 /*
1320                  * Restore the preempt count. That gives us a decent
1321                  * chance to survive and extract information. If the
1322                  * callback kept a lock held, bad luck, but not worse
1323                  * than the BUG() we had.
1324                  */
1325                 preempt_count_set(count);
1326         }
1327 }
1328
1329 static void expire_timers(struct timer_base *base, struct hlist_head *head)
1330 {
1331         while (!hlist_empty(head)) {
1332                 struct timer_list *timer;
1333                 void (*fn)(unsigned long);
1334                 unsigned long data;
1335
1336                 timer = hlist_entry(head->first, struct timer_list, entry);
1337                 timer_stats_account_timer(timer);
1338
1339                 base->running_timer = timer;
1340                 detach_timer(timer, true);
1341
1342                 fn = timer->function;
1343                 data = timer->data;
1344
1345                 if (timer->flags & TIMER_IRQSAFE) {
1346                         spin_unlock(&base->lock);
1347                         call_timer_fn(timer, fn, data);
1348                         spin_lock(&base->lock);
1349                 } else {
1350                         spin_unlock_irq(&base->lock);
1351                         call_timer_fn(timer, fn, data);
1352                         spin_lock_irq(&base->lock);
1353                 }
1354         }
1355 }
1356
1357 static int __collect_expired_timers(struct timer_base *base,
1358                                     struct hlist_head *heads)
1359 {
1360         unsigned long clk = base->clk;
1361         struct hlist_head *vec;
1362         int i, levels = 0;
1363         unsigned int idx;
1364
1365         for (i = 0; i < LVL_DEPTH; i++) {
1366                 idx = (clk & LVL_MASK) + i * LVL_SIZE;
1367
1368                 if (__test_and_clear_bit(idx, base->pending_map)) {
1369                         vec = base->vectors + idx;
1370                         hlist_move_list(vec, heads++);
1371                         levels++;
1372                 }
1373                 /* Is it time to look at the next level? */
1374                 if (clk & LVL_CLK_MASK)
1375                         break;
1376                 /* Shift clock for the next level granularity */
1377                 clk >>= LVL_CLK_SHIFT;
1378         }
1379         return levels;
1380 }
1381
1382 #ifdef CONFIG_NO_HZ_COMMON
1383 /*
1384  * Find the next pending bucket of a level. Search from level start (@offset)
1385  * + @clk upwards and if nothing there, search from start of the level
1386  * (@offset) up to @offset + clk.
1387  */
1388 static int next_pending_bucket(struct timer_base *base, unsigned offset,
1389                                unsigned clk)
1390 {
1391         unsigned pos, start = offset + clk;
1392         unsigned end = offset + LVL_SIZE;
1393
1394         pos = find_next_bit(base->pending_map, end, start);
1395         if (pos < end)
1396                 return pos - start;
1397
1398         pos = find_next_bit(base->pending_map, start, offset);
1399         return pos < start ? pos + LVL_SIZE - start : -1;
1400 }
1401
1402 /*
1403  * Search the first expiring timer in the various clock levels. Caller must
1404  * hold base->lock.
1405  */
1406 static unsigned long __next_timer_interrupt(struct timer_base *base)
1407 {
1408         unsigned long clk, next, adj;
1409         unsigned lvl, offset = 0;
1410
1411         next = base->clk + NEXT_TIMER_MAX_DELTA;
1412         clk = base->clk;
1413         for (lvl = 0; lvl < LVL_DEPTH; lvl++, offset += LVL_SIZE) {
1414                 int pos = next_pending_bucket(base, offset, clk & LVL_MASK);
1415
1416                 if (pos >= 0) {
1417                         unsigned long tmp = clk + (unsigned long) pos;
1418
1419                         tmp <<= LVL_SHIFT(lvl);
1420                         if (time_before(tmp, next))
1421                                 next = tmp;
1422                 }
1423                 /*
1424                  * Clock for the next level. If the current level clock lower
1425                  * bits are zero, we look at the next level as is. If not we
1426                  * need to advance it by one because that's going to be the
1427                  * next expiring bucket in that level. base->clk is the next
1428                  * expiring jiffie. So in case of:
1429                  *
1430                  * LVL5 LVL4 LVL3 LVL2 LVL1 LVL0
1431                  *  0    0    0    0    0    0
1432                  *
1433                  * we have to look at all levels @index 0. With
1434                  *
1435                  * LVL5 LVL4 LVL3 LVL2 LVL1 LVL0
1436                  *  0    0    0    0    0    2
1437                  *
1438                  * LVL0 has the next expiring bucket @index 2. The upper
1439                  * levels have the next expiring bucket @index 1.
1440                  *
1441                  * In case that the propagation wraps the next level the same
1442                  * rules apply:
1443                  *
1444                  * LVL5 LVL4 LVL3 LVL2 LVL1 LVL0
1445                  *  0    0    0    0    F    2
1446                  *
1447                  * So after looking at LVL0 we get:
1448                  *
1449                  * LVL5 LVL4 LVL3 LVL2 LVL1
1450                  *  0    0    0    1    0
1451                  *
1452                  * So no propagation from LVL1 to LVL2 because that happened
1453                  * with the add already, but then we need to propagate further
1454                  * from LVL2 to LVL3.
1455                  *
1456                  * So the simple check whether the lower bits of the current
1457                  * level are 0 or not is sufficient for all cases.
1458                  */
1459                 adj = clk & LVL_CLK_MASK ? 1 : 0;
1460                 clk >>= LVL_CLK_SHIFT;
1461                 clk += adj;
1462         }
1463         return next;
1464 }
1465
1466 /*
1467  * Check, if the next hrtimer event is before the next timer wheel
1468  * event:
1469  */
1470 static u64 cmp_next_hrtimer_event(u64 basem, u64 expires)
1471 {
1472         u64 nextevt = hrtimer_get_next_event();
1473
1474         /*
1475          * If high resolution timers are enabled
1476          * hrtimer_get_next_event() returns KTIME_MAX.
1477          */
1478         if (expires <= nextevt)
1479                 return expires;
1480
1481         /*
1482          * If the next timer is already expired, return the tick base
1483          * time so the tick is fired immediately.
1484          */
1485         if (nextevt <= basem)
1486                 return basem;
1487
1488         /*
1489          * Round up to the next jiffie. High resolution timers are
1490          * off, so the hrtimers are expired in the tick and we need to
1491          * make sure that this tick really expires the timer to avoid
1492          * a ping pong of the nohz stop code.
1493          *
1494          * Use DIV_ROUND_UP_ULL to prevent gcc calling __divdi3
1495          */
1496         return DIV_ROUND_UP_ULL(nextevt, TICK_NSEC) * TICK_NSEC;
1497 }
1498
1499 /**
1500  * get_next_timer_interrupt - return the time (clock mono) of the next timer
1501  * @basej:      base time jiffies
1502  * @basem:      base time clock monotonic
1503  *
1504  * Returns the tick aligned clock monotonic time of the next pending
1505  * timer or KTIME_MAX if no timer is pending.
1506  */
1507 u64 get_next_timer_interrupt(unsigned long basej, u64 basem)
1508 {
1509         struct timer_base *base = this_cpu_ptr(&timer_bases[BASE_STD]);
1510         u64 expires = KTIME_MAX;
1511         unsigned long nextevt;
1512         bool is_max_delta;
1513
1514         /*
1515          * Pretend that there is no timer pending if the cpu is offline.
1516          * Possible pending timers will be migrated later to an active cpu.
1517          */
1518         if (cpu_is_offline(smp_processor_id()))
1519                 return expires;
1520
1521         spin_lock(&base->lock);
1522         nextevt = __next_timer_interrupt(base);
1523         is_max_delta = (nextevt == base->clk + NEXT_TIMER_MAX_DELTA);
1524         base->next_expiry = nextevt;
1525         /*
1526          * We have a fresh next event. Check whether we can forward the
1527          * base. We can only do that when @basej is past base->clk
1528          * otherwise we might rewind base->clk.
1529          */
1530         if (time_after(basej, base->clk)) {
1531                 if (time_after(nextevt, basej))
1532                         base->clk = basej;
1533                 else if (time_after(nextevt, base->clk))
1534                         base->clk = nextevt;
1535         }
1536
1537         if (time_before_eq(nextevt, basej)) {
1538                 expires = basem;
1539                 base->is_idle = false;
1540         } else {
1541                 if (!is_max_delta)
1542                         expires = basem + (nextevt - basej) * TICK_NSEC;
1543                 /*
1544                  * If we expect to sleep more than a tick, mark the base idle:
1545                  */
1546                 if ((expires - basem) > TICK_NSEC)
1547                         base->is_idle = true;
1548         }
1549         spin_unlock(&base->lock);
1550
1551         return cmp_next_hrtimer_event(basem, expires);
1552 }
1553
1554 /**
1555  * timer_clear_idle - Clear the idle state of the timer base
1556  *
1557  * Called with interrupts disabled
1558  */
1559 void timer_clear_idle(void)
1560 {
1561         struct timer_base *base = this_cpu_ptr(&timer_bases[BASE_STD]);
1562
1563         /*
1564          * We do this unlocked. The worst outcome is a remote enqueue sending
1565          * a pointless IPI, but taking the lock would just make the window for
1566          * sending the IPI a few instructions smaller for the cost of taking
1567          * the lock in the exit from idle path.
1568          */
1569         base->is_idle = false;
1570 }
1571
1572 static int collect_expired_timers(struct timer_base *base,
1573                                   struct hlist_head *heads)
1574 {
1575         /*
1576          * NOHZ optimization. After a long idle sleep we need to forward the
1577          * base to current jiffies. Avoid a loop by searching the bitfield for
1578          * the next expiring timer.
1579          */
1580         if ((long)(jiffies - base->clk) > 2) {
1581                 unsigned long next = __next_timer_interrupt(base);
1582
1583                 /*
1584                  * If the next timer is ahead of time forward to current
1585                  * jiffies, otherwise forward to the next expiry time:
1586                  */
1587                 if (time_after(next, jiffies)) {
1588                         /* The call site will increment clock! */
1589                         base->clk = jiffies - 1;
1590                         return 0;
1591                 }
1592                 base->clk = next;
1593         }
1594         return __collect_expired_timers(base, heads);
1595 }
1596 #else
1597 static inline int collect_expired_timers(struct timer_base *base,
1598                                          struct hlist_head *heads)
1599 {
1600         return __collect_expired_timers(base, heads);
1601 }
1602 #endif
1603
1604 /*
1605  * Called from the timer interrupt handler to charge one tick to the current
1606  * process.  user_tick is 1 if the tick is user time, 0 for system.
1607  */
1608 void update_process_times(int user_tick)
1609 {
1610         struct task_struct *p = current;
1611
1612         /* Note: this timer irq context must be accounted for as well. */
1613         account_process_tick(p, user_tick);
1614         run_local_timers();
1615         rcu_check_callbacks(user_tick);
1616 #ifdef CONFIG_IRQ_WORK
1617         if (in_irq())
1618                 irq_work_tick();
1619 #endif
1620         scheduler_tick();
1621         run_posix_cpu_timers(p);
1622 }
1623
1624 /**
1625  * __run_timers - run all expired timers (if any) on this CPU.
1626  * @base: the timer vector to be processed.
1627  */
1628 static inline void __run_timers(struct timer_base *base)
1629 {
1630         struct hlist_head heads[LVL_DEPTH];
1631         int levels;
1632
1633         if (!time_after_eq(jiffies, base->clk))
1634                 return;
1635
1636         spin_lock_irq(&base->lock);
1637
1638         while (time_after_eq(jiffies, base->clk)) {
1639
1640                 levels = collect_expired_timers(base, heads);
1641                 base->clk++;
1642
1643                 while (levels--)
1644                         expire_timers(base, heads + levels);
1645         }
1646         base->running_timer = NULL;
1647         spin_unlock_irq(&base->lock);
1648 }
1649
1650 /*
1651  * This function runs timers and the timer-tq in bottom half context.
1652  */
1653 static __latent_entropy void run_timer_softirq(struct softirq_action *h)
1654 {
1655         struct timer_base *base = this_cpu_ptr(&timer_bases[BASE_STD]);
1656
1657         __run_timers(base);
1658         if (IS_ENABLED(CONFIG_NO_HZ_COMMON) && base->nohz_active)
1659                 __run_timers(this_cpu_ptr(&timer_bases[BASE_DEF]));
1660 }
1661
1662 /*
1663  * Called by the local, per-CPU timer interrupt on SMP.
1664  */
1665 void run_local_timers(void)
1666 {
1667         struct timer_base *base = this_cpu_ptr(&timer_bases[BASE_STD]);
1668
1669         hrtimer_run_queues();
1670         /* Raise the softirq only if required. */
1671         if (time_before(jiffies, base->clk)) {
1672                 if (!IS_ENABLED(CONFIG_NO_HZ_COMMON) || !base->nohz_active)
1673                         return;
1674                 /* CPU is awake, so check the deferrable base. */
1675                 base++;
1676                 if (time_before(jiffies, base->clk))
1677                         return;
1678         }
1679         raise_softirq(TIMER_SOFTIRQ);
1680 }
1681
1682 #ifdef __ARCH_WANT_SYS_ALARM
1683
1684 /*
1685  * For backwards compatibility?  This can be done in libc so Alpha
1686  * and all newer ports shouldn't need it.
1687  */
1688 SYSCALL_DEFINE1(alarm, unsigned int, seconds)
1689 {
1690         return alarm_setitimer(seconds);
1691 }
1692
1693 #endif
1694
1695 static void process_timeout(unsigned long __data)
1696 {
1697         wake_up_process((struct task_struct *)__data);
1698 }
1699
1700 /**
1701  * schedule_timeout - sleep until timeout
1702  * @timeout: timeout value in jiffies
1703  *
1704  * Make the current task sleep until @timeout jiffies have
1705  * elapsed. The routine will return immediately unless
1706  * the current task state has been set (see set_current_state()).
1707  *
1708  * You can set the task state as follows -
1709  *
1710  * %TASK_UNINTERRUPTIBLE - at least @timeout jiffies are guaranteed to
1711  * pass before the routine returns. The routine will return 0
1712  *
1713  * %TASK_INTERRUPTIBLE - the routine may return early if a signal is
1714  * delivered to the current task. In this case the remaining time
1715  * in jiffies will be returned, or 0 if the timer expired in time
1716  *
1717  * The current task state is guaranteed to be TASK_RUNNING when this
1718  * routine returns.
1719  *
1720  * Specifying a @timeout value of %MAX_SCHEDULE_TIMEOUT will schedule
1721  * the CPU away without a bound on the timeout. In this case the return
1722  * value will be %MAX_SCHEDULE_TIMEOUT.
1723  *
1724  * In all cases the return value is guaranteed to be non-negative.
1725  */
1726 signed long __sched schedule_timeout(signed long timeout)
1727 {
1728         struct timer_list timer;
1729         unsigned long expire;
1730
1731         switch (timeout)
1732         {
1733         case MAX_SCHEDULE_TIMEOUT:
1734                 /*
1735                  * These two special cases are useful to be comfortable
1736                  * in the caller. Nothing more. We could take
1737                  * MAX_SCHEDULE_TIMEOUT from one of the negative value
1738                  * but I' d like to return a valid offset (>=0) to allow
1739                  * the caller to do everything it want with the retval.
1740                  */
1741                 schedule();
1742                 goto out;
1743         default:
1744                 /*
1745                  * Another bit of PARANOID. Note that the retval will be
1746                  * 0 since no piece of kernel is supposed to do a check
1747                  * for a negative retval of schedule_timeout() (since it
1748                  * should never happens anyway). You just have the printk()
1749                  * that will tell you if something is gone wrong and where.
1750                  */
1751                 if (timeout < 0) {
1752                         printk(KERN_ERR "schedule_timeout: wrong timeout "
1753                                 "value %lx\n", timeout);
1754                         dump_stack();
1755                         current->state = TASK_RUNNING;
1756                         goto out;
1757                 }
1758         }
1759
1760         expire = timeout + jiffies;
1761
1762         setup_timer_on_stack(&timer, process_timeout, (unsigned long)current);
1763         __mod_timer(&timer, expire, false);
1764         schedule();
1765         del_singleshot_timer_sync(&timer);
1766
1767         /* Remove the timer from the object tracker */
1768         destroy_timer_on_stack(&timer);
1769
1770         timeout = expire - jiffies;
1771
1772  out:
1773         return timeout < 0 ? 0 : timeout;
1774 }
1775 EXPORT_SYMBOL(schedule_timeout);
1776
1777 /*
1778  * We can use __set_current_state() here because schedule_timeout() calls
1779  * schedule() unconditionally.
1780  */
1781 signed long __sched schedule_timeout_interruptible(signed long timeout)
1782 {
1783         __set_current_state(TASK_INTERRUPTIBLE);
1784         return schedule_timeout(timeout);
1785 }
1786 EXPORT_SYMBOL(schedule_timeout_interruptible);
1787
1788 signed long __sched schedule_timeout_killable(signed long timeout)
1789 {
1790         __set_current_state(TASK_KILLABLE);
1791         return schedule_timeout(timeout);
1792 }
1793 EXPORT_SYMBOL(schedule_timeout_killable);
1794
1795 signed long __sched schedule_timeout_uninterruptible(signed long timeout)
1796 {
1797         __set_current_state(TASK_UNINTERRUPTIBLE);
1798         return schedule_timeout(timeout);
1799 }
1800 EXPORT_SYMBOL(schedule_timeout_uninterruptible);
1801
1802 /*
1803  * Like schedule_timeout_uninterruptible(), except this task will not contribute
1804  * to load average.
1805  */
1806 signed long __sched schedule_timeout_idle(signed long timeout)
1807 {
1808         __set_current_state(TASK_IDLE);
1809         return schedule_timeout(timeout);
1810 }
1811 EXPORT_SYMBOL(schedule_timeout_idle);
1812
1813 #ifdef CONFIG_HOTPLUG_CPU
1814 static void migrate_timer_list(struct timer_base *new_base, struct hlist_head *head)
1815 {
1816         struct timer_list *timer;
1817         int cpu = new_base->cpu;
1818
1819         while (!hlist_empty(head)) {
1820                 timer = hlist_entry(head->first, struct timer_list, entry);
1821                 detach_timer(timer, false);
1822                 timer->flags = (timer->flags & ~TIMER_BASEMASK) | cpu;
1823                 internal_add_timer(new_base, timer);
1824         }
1825 }
1826
1827 int timers_dead_cpu(unsigned int cpu)
1828 {
1829         struct timer_base *old_base;
1830         struct timer_base *new_base;
1831         int b, i;
1832
1833         BUG_ON(cpu_online(cpu));
1834
1835         for (b = 0; b < NR_BASES; b++) {
1836                 old_base = per_cpu_ptr(&timer_bases[b], cpu);
1837                 new_base = get_cpu_ptr(&timer_bases[b]);
1838                 /*
1839                  * The caller is globally serialized and nobody else
1840                  * takes two locks at once, deadlock is not possible.
1841                  */
1842                 spin_lock_irq(&new_base->lock);
1843                 spin_lock_nested(&old_base->lock, SINGLE_DEPTH_NESTING);
1844
1845                 BUG_ON(old_base->running_timer);
1846
1847                 for (i = 0; i < WHEEL_SIZE; i++)
1848                         migrate_timer_list(new_base, old_base->vectors + i);
1849
1850                 spin_unlock(&old_base->lock);
1851                 spin_unlock_irq(&new_base->lock);
1852                 put_cpu_ptr(&timer_bases);
1853         }
1854         return 0;
1855 }
1856
1857 #endif /* CONFIG_HOTPLUG_CPU */
1858
1859 static void __init init_timer_cpu(int cpu)
1860 {
1861         struct timer_base *base;
1862         int i;
1863
1864         for (i = 0; i < NR_BASES; i++) {
1865                 base = per_cpu_ptr(&timer_bases[i], cpu);
1866                 base->cpu = cpu;
1867                 spin_lock_init(&base->lock);
1868                 base->clk = jiffies;
1869         }
1870 }
1871
1872 static void __init init_timer_cpus(void)
1873 {
1874         int cpu;
1875
1876         for_each_possible_cpu(cpu)
1877                 init_timer_cpu(cpu);
1878 }
1879
1880 void __init init_timers(void)
1881 {
1882         init_timer_cpus();
1883         init_timer_stats();
1884         open_softirq(TIMER_SOFTIRQ, run_timer_softirq);
1885 }
1886
1887 /**
1888  * msleep - sleep safely even with waitqueue interruptions
1889  * @msecs: Time in milliseconds to sleep for
1890  */
1891 void msleep(unsigned int msecs)
1892 {
1893         unsigned long timeout = msecs_to_jiffies(msecs) + 1;
1894
1895         while (timeout)
1896                 timeout = schedule_timeout_uninterruptible(timeout);
1897 }
1898
1899 EXPORT_SYMBOL(msleep);
1900
1901 /**
1902  * msleep_interruptible - sleep waiting for signals
1903  * @msecs: Time in milliseconds to sleep for
1904  */
1905 unsigned long msleep_interruptible(unsigned int msecs)
1906 {
1907         unsigned long timeout = msecs_to_jiffies(msecs) + 1;
1908
1909         while (timeout && !signal_pending(current))
1910                 timeout = schedule_timeout_interruptible(timeout);
1911         return jiffies_to_msecs(timeout);
1912 }
1913
1914 EXPORT_SYMBOL(msleep_interruptible);
1915
1916 static void __sched do_usleep_range(unsigned long min, unsigned long max)
1917 {
1918         ktime_t kmin;
1919         u64 delta;
1920
1921         kmin = ktime_set(0, min * NSEC_PER_USEC);
1922         delta = (u64)(max - min) * NSEC_PER_USEC;
1923         schedule_hrtimeout_range(&kmin, delta, HRTIMER_MODE_REL);
1924 }
1925
1926 /**
1927  * usleep_range - Sleep for an approximate time
1928  * @min: Minimum time in usecs to sleep
1929  * @max: Maximum time in usecs to sleep
1930  *
1931  * In non-atomic context where the exact wakeup time is flexible, use
1932  * usleep_range() instead of udelay().  The sleep improves responsiveness
1933  * by avoiding the CPU-hogging busy-wait of udelay(), and the range reduces
1934  * power usage by allowing hrtimers to take advantage of an already-
1935  * scheduled interrupt instead of scheduling a new one just for this sleep.
1936  */
1937 void __sched usleep_range(unsigned long min, unsigned long max)
1938 {
1939         __set_current_state(TASK_UNINTERRUPTIBLE);
1940         do_usleep_range(min, max);
1941 }
1942 EXPORT_SYMBOL(usleep_range);