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