blob: c16c48de01c5f90170b064b75f5fe422887a90a6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/kernel/timer.c
3 *
Stephen Rothwell4a22f162013-04-30 15:27:37 -07004 * Kernel internal timers
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
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>
Paul Gortmaker9984de12011-05-23 14:51:41 -040023#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/interrupt.h>
25#include <linux/percpu.h>
26#include <linux/init.h>
27#include <linux/mm.h>
28#include <linux/swap.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -070029#include <linux/pid_namespace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#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>
Adrian Bunk97a41e22006-01-08 01:02:17 -080037#include <linux/delay.h>
Thomas Gleixner79bf2bb2007-02-16 01:28:03 -080038#include <linux/tick.h>
Ingo Molnar82f67cd2007-02-16 01:28:13 -080039#include <linux/kallsyms.h>
Peter Zijlstrae360adb2010-10-14 14:01:34 +080040#include <linux/irq_work.h>
Arun R Bharadwajeea08f32009-04-16 12:16:41 +053041#include <linux/sched.h>
Clark Williamscf4aebc22013-02-07 09:46:59 -060042#include <linux/sched/sysctl.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090043#include <linux/slab.h>
Stephen Rothwell1a0df592013-04-30 15:27:34 -070044#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
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
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +000052#include "tick-internal.h"
53
Xiao Guangrong2b022e32009-08-10 10:48:59 +080054#define CREATE_TRACE_POINTS
55#include <trace/events/timer.h>
56
Andi Kleen40747ff2014-02-08 08:51:59 +010057__visible u64 jiffies_64 __cacheline_aligned_in_smp = INITIAL_JIFFIES;
Thomas Gleixnerecea8d12005-10-30 15:03:00 -080058
59EXPORT_SYMBOL(jiffies_64);
60
Linus Torvalds1da177e2005-04-16 15:20:36 -070061/*
Thomas Gleixner500462a2016-07-04 09:50:30 +000062 * 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Thomas Gleixner500462a2016-07-04 09:50:30 +0000149/* 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))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Thomas Gleixner500462a2016-07-04 09:50:30 +0000156/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Thomas Gleixner494af3e2016-07-04 09:50:28 +0000195struct timer_base {
Thomas Gleixner500462a2016-07-04 09:50:30 +0000196 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];
Venki Pallipadi6e453a62007-05-08 00:27:44 -0700204} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Thomas Gleixner500462a2016-07-04 09:50:30 +0000206static DEFINE_PER_CPU(struct timer_base, timer_bases[NR_BASES]);
Venki Pallipadi6e453a62007-05-08 00:27:44 -0700207
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000208#if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
209unsigned int sysctl_timer_migration = 1;
210
Thomas Gleixner683be132015-05-26 22:50:35 +0000211void timers_update_migration(bool update_nohz)
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000212{
213 bool on = sysctl_timer_migration && tick_nohz_active;
214 unsigned int cpu;
215
216 /* Avoid the loop, if nothing to update */
Thomas Gleixner500462a2016-07-04 09:50:30 +0000217 if (this_cpu_read(timer_bases[BASE_STD].migration_enabled) == on)
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000218 return;
219
220 for_each_possible_cpu(cpu) {
Thomas Gleixner500462a2016-07-04 09:50:30 +0000221 per_cpu(timer_bases[BASE_STD].migration_enabled, cpu) = on;
222 per_cpu(timer_bases[BASE_DEF].migration_enabled, cpu) = on;
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000223 per_cpu(hrtimer_bases.migration_enabled, cpu) = on;
Thomas Gleixner683be132015-05-26 22:50:35 +0000224 if (!update_nohz)
225 continue;
Thomas Gleixner500462a2016-07-04 09:50:30 +0000226 per_cpu(timer_bases[BASE_STD].nohz_active, cpu) = true;
227 per_cpu(timer_bases[BASE_DEF].nohz_active, cpu) = true;
Thomas Gleixner683be132015-05-26 22:50:35 +0000228 per_cpu(hrtimer_bases.nohz_active, cpu) = true;
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000229 }
230}
231
232int 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)
Thomas Gleixner683be132015-05-26 22:50:35 +0000242 timers_update_migration(false);
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000243 mutex_unlock(&mutex);
244 return ret;
245}
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000246#endif
247
Alan Stern9c133c42008-11-06 08:42:48 +0100248static 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
Bart Van Assche9e04d382013-05-21 20:43:50 +0200281 /*
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;
Alan Stern9c133c42008-11-06 08:42:48 +0100286}
287
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800288/**
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 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800293 * __round_jiffies() rounds an absolute time in the future (in jiffies)
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800294 * 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 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800306 * The return value is the rounded version of the @j parameter.
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800307 */
308unsigned long __round_jiffies(unsigned long j, int cpu)
309{
Alan Stern9c133c42008-11-06 08:42:48 +0100310 return round_jiffies_common(j, cpu, false);
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800311}
312EXPORT_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 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800319 * __round_jiffies_relative() rounds a time delta in the future (in jiffies)
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800320 * 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 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800332 * The return value is the rounded version of the @j parameter.
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800333 */
334unsigned long __round_jiffies_relative(unsigned long j, int cpu)
335{
Alan Stern9c133c42008-11-06 08:42:48 +0100336 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;
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800340}
341EXPORT_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 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800347 * round_jiffies() rounds an absolute time in the future (in jiffies)
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800348 * 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 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800356 * The return value is the rounded version of the @j parameter.
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800357 */
358unsigned long round_jiffies(unsigned long j)
359{
Alan Stern9c133c42008-11-06 08:42:48 +0100360 return round_jiffies_common(j, raw_smp_processor_id(), false);
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800361}
362EXPORT_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 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800368 * round_jiffies_relative() rounds a time delta in the future (in jiffies)
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800369 * 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 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800377 * The return value is the rounded version of the @j parameter.
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800378 */
379unsigned long round_jiffies_relative(unsigned long j)
380{
381 return __round_jiffies_relative(j, raw_smp_processor_id());
382}
383EXPORT_SYMBOL_GPL(round_jiffies_relative);
384
Alan Stern9c133c42008-11-06 08:42:48 +0100385/**
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 */
395unsigned long __round_jiffies_up(unsigned long j, int cpu)
396{
397 return round_jiffies_common(j, cpu, true);
398}
399EXPORT_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 */
411unsigned 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}
418EXPORT_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 */
429unsigned long round_jiffies_up(unsigned long j)
430{
431 return round_jiffies_common(j, raw_smp_processor_id(), true);
432}
433EXPORT_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 */
444unsigned long round_jiffies_up_relative(unsigned long j)
445{
446 return __round_jiffies_up_relative(j, raw_smp_processor_id());
447}
448EXPORT_SYMBOL_GPL(round_jiffies_up_relative);
449
Arjan van de Ven3bbb9ec2010-03-11 14:04:36 -0800450
Thomas Gleixner500462a2016-07-04 09:50:30 +0000451static inline unsigned int timer_get_idx(struct timer_list *timer)
452{
453 return (timer->flags & TIMER_ARRAYMASK) >> TIMER_ARRAYSHIFT;
454}
455
456static inline void timer_set_idx(struct timer_list *timer, unsigned int idx)
457{
458 timer->flags = (timer->flags & ~TIMER_ARRAYMASK) |
459 idx << TIMER_ARRAYSHIFT;
460}
461
462/*
463 * Helper function to calculate the array index for a given expiry
464 * time.
465 */
466static inline unsigned calc_index(unsigned expires, unsigned lvl)
467{
468 expires = (expires + LVL_GRAN(lvl)) >> LVL_SHIFT(lvl);
469 return LVL_OFFS(lvl) + (expires & LVL_MASK);
470}
471
Thomas Gleixnerfacbb4a2012-05-25 22:08:57 +0000472static void
Thomas Gleixner494af3e2016-07-04 09:50:28 +0000473__internal_add_timer(struct timer_base *base, struct timer_list *timer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474{
475 unsigned long expires = timer->expires;
Thomas Gleixner500462a2016-07-04 09:50:30 +0000476 unsigned long delta = expires - base->clk;
Thomas Gleixner1dabbce2015-05-26 22:50:28 +0000477 struct hlist_head *vec;
Thomas Gleixner500462a2016-07-04 09:50:30 +0000478 unsigned int idx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Thomas Gleixner500462a2016-07-04 09:50:30 +0000480 if (delta < LVL_START(1)) {
481 idx = calc_index(expires, 0);
482 } else if (delta < LVL_START(2)) {
483 idx = calc_index(expires, 1);
484 } else if (delta < LVL_START(3)) {
485 idx = calc_index(expires, 2);
486 } else if (delta < LVL_START(4)) {
487 idx = calc_index(expires, 3);
488 } else if (delta < LVL_START(5)) {
489 idx = calc_index(expires, 4);
490 } else if (delta < LVL_START(6)) {
491 idx = calc_index(expires, 5);
492 } else if (delta < LVL_START(7)) {
493 idx = calc_index(expires, 6);
494 } else if (LVL_DEPTH > 8 && delta < LVL_START(8)) {
495 idx = calc_index(expires, 7);
496 } else if ((long) delta < 0) {
497 idx = base->clk & LVL_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 } else {
Thomas Gleixner500462a2016-07-04 09:50:30 +0000499 /*
500 * Force expire obscene large timeouts to expire at the
501 * capacity limit of the wheel.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 */
Thomas Gleixner500462a2016-07-04 09:50:30 +0000503 if (expires >= WHEEL_TIMEOUT_CUTOFF)
504 expires = WHEEL_TIMEOUT_MAX;
Thomas Gleixner1bd04bf2015-05-26 22:50:26 +0000505
Thomas Gleixner500462a2016-07-04 09:50:30 +0000506 idx = calc_index(expires, LVL_DEPTH - 1);
507 }
508 /*
509 * Enqueue the timer into the array bucket, mark it pending in
510 * the bitmap and store the index in the timer flags.
511 */
512 vec = base->vectors + idx;
Thomas Gleixner1dabbce2015-05-26 22:50:28 +0000513 hlist_add_head(&timer->entry, vec);
Thomas Gleixner500462a2016-07-04 09:50:30 +0000514 __set_bit(idx, base->pending_map);
515 timer_set_idx(timer, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
517
Thomas Gleixner494af3e2016-07-04 09:50:28 +0000518static void internal_add_timer(struct timer_base *base, struct timer_list *timer)
Thomas Gleixnerfacbb4a2012-05-25 22:08:57 +0000519{
520 __internal_add_timer(base, timer);
Viresh Kumar9f6d9ba2014-06-22 01:29:14 +0200521
522 /*
523 * Check whether the other CPU is in dynticks mode and needs
Thomas Gleixner500462a2016-07-04 09:50:30 +0000524 * to be triggered to reevaluate the timer wheel. We are
525 * protected against the other CPU fiddling with the timer by
526 * holding the timer base lock. This also makes sure that a
527 * CPU on the way to stop its tick can not evaluate the timer
528 * wheel.
Viresh Kumar9f6d9ba2014-06-22 01:29:14 +0200529 *
530 * Spare the IPI for deferrable timers on idle targets though.
531 * The next busy ticks will take care of it. Except full dynticks
532 * require special care against races with idle_cpu(), lets deal
533 * with that later.
534 */
Thomas Gleixner500462a2016-07-04 09:50:30 +0000535 if (IS_ENABLED(CONFIG_NO_HZ_COMMON) && base->nohz_active) {
Thomas Gleixner683be132015-05-26 22:50:35 +0000536 if (!(timer->flags & TIMER_DEFERRABLE) ||
537 tick_nohz_full_cpu(base->cpu))
538 wake_up_nohz_cpu(base->cpu);
539 }
Thomas Gleixnerfacbb4a2012-05-25 22:08:57 +0000540}
541
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800542#ifdef CONFIG_TIMER_STATS
543void __timer_stats_timer_set_start_info(struct timer_list *timer, void *addr)
544{
545 if (timer->start_site)
546 return;
547
548 timer->start_site = addr;
549 memcpy(timer->start_comm, current->comm, TASK_COMM_LEN);
550 timer->start_pid = current->pid;
551}
Venki Pallipadic5c061b82007-07-15 23:40:30 -0700552
553static void timer_stats_account_timer(struct timer_list *timer)
554{
Dmitry Vyukov3ed769b2015-09-18 15:54:23 +0200555 void *site;
556
557 /*
558 * start_site can be concurrently reset by
559 * timer_stats_timer_clear_start_info()
560 */
561 site = READ_ONCE(timer->start_site);
562 if (likely(!site))
Heiko Carstens507e1232009-06-23 17:38:15 +0200563 return;
Venki Pallipadic5c061b82007-07-15 23:40:30 -0700564
Dmitry Vyukov3ed769b2015-09-18 15:54:23 +0200565 timer_stats_update_stats(timer, timer->start_pid, site,
Thomas Gleixnerc74441a2015-05-26 22:50:31 +0000566 timer->function, timer->start_comm,
567 timer->flags);
Venki Pallipadic5c061b82007-07-15 23:40:30 -0700568}
569
570#else
571static void timer_stats_account_timer(struct timer_list *timer) {}
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800572#endif
573
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700574#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
575
576static struct debug_obj_descr timer_debug_descr;
577
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100578static void *timer_debug_hint(void *addr)
579{
580 return ((struct timer_list *) addr)->function;
581}
582
Du, Changbinb9fdac72016-05-19 17:09:41 -0700583static bool timer_is_static_object(void *addr)
584{
585 struct timer_list *timer = addr;
586
587 return (timer->entry.pprev == NULL &&
588 timer->entry.next == TIMER_ENTRY_STATIC);
589}
590
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700591/*
592 * fixup_init is called when:
593 * - an active object is initialized
594 */
Du, Changbine3252462016-05-19 17:09:29 -0700595static bool timer_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700596{
597 struct timer_list *timer = addr;
598
599 switch (state) {
600 case ODEBUG_STATE_ACTIVE:
601 del_timer_sync(timer);
602 debug_object_init(timer, &timer_debug_descr);
Du, Changbine3252462016-05-19 17:09:29 -0700603 return true;
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700604 default:
Du, Changbine3252462016-05-19 17:09:29 -0700605 return false;
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700606 }
607}
608
Stephen Boydfb16b8c2011-11-07 19:48:26 -0800609/* Stub timer callback for improperly used timers. */
610static void stub_timer(unsigned long data)
611{
612 WARN_ON(1);
613}
614
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700615/*
616 * fixup_activate is called when:
617 * - an active object is activated
Du, Changbinb9fdac72016-05-19 17:09:41 -0700618 * - an unknown non-static object is activated
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700619 */
Du, Changbine3252462016-05-19 17:09:29 -0700620static bool timer_fixup_activate(void *addr, enum debug_obj_state state)
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700621{
622 struct timer_list *timer = addr;
623
624 switch (state) {
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700625 case ODEBUG_STATE_NOTAVAILABLE:
Du, Changbinb9fdac72016-05-19 17:09:41 -0700626 setup_timer(timer, stub_timer, 0);
627 return true;
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700628
629 case ODEBUG_STATE_ACTIVE:
630 WARN_ON(1);
631
632 default:
Du, Changbine3252462016-05-19 17:09:29 -0700633 return false;
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700634 }
635}
636
637/*
638 * fixup_free is called when:
639 * - an active object is freed
640 */
Du, Changbine3252462016-05-19 17:09:29 -0700641static bool timer_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700642{
643 struct timer_list *timer = addr;
644
645 switch (state) {
646 case ODEBUG_STATE_ACTIVE:
647 del_timer_sync(timer);
648 debug_object_free(timer, &timer_debug_descr);
Du, Changbine3252462016-05-19 17:09:29 -0700649 return true;
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700650 default:
Du, Changbine3252462016-05-19 17:09:29 -0700651 return false;
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700652 }
653}
654
Christine Chandc4218b2011-11-07 19:48:28 -0800655/*
656 * fixup_assert_init is called when:
657 * - an untracked/uninit-ed object is found
658 */
Du, Changbine3252462016-05-19 17:09:29 -0700659static bool timer_fixup_assert_init(void *addr, enum debug_obj_state state)
Christine Chandc4218b2011-11-07 19:48:28 -0800660{
661 struct timer_list *timer = addr;
662
663 switch (state) {
664 case ODEBUG_STATE_NOTAVAILABLE:
Du, Changbinb9fdac72016-05-19 17:09:41 -0700665 setup_timer(timer, stub_timer, 0);
666 return true;
Christine Chandc4218b2011-11-07 19:48:28 -0800667 default:
Du, Changbine3252462016-05-19 17:09:29 -0700668 return false;
Christine Chandc4218b2011-11-07 19:48:28 -0800669 }
670}
671
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700672static struct debug_obj_descr timer_debug_descr = {
Christine Chandc4218b2011-11-07 19:48:28 -0800673 .name = "timer_list",
674 .debug_hint = timer_debug_hint,
Du, Changbinb9fdac72016-05-19 17:09:41 -0700675 .is_static_object = timer_is_static_object,
Christine Chandc4218b2011-11-07 19:48:28 -0800676 .fixup_init = timer_fixup_init,
677 .fixup_activate = timer_fixup_activate,
678 .fixup_free = timer_fixup_free,
679 .fixup_assert_init = timer_fixup_assert_init,
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700680};
681
682static inline void debug_timer_init(struct timer_list *timer)
683{
684 debug_object_init(timer, &timer_debug_descr);
685}
686
687static inline void debug_timer_activate(struct timer_list *timer)
688{
689 debug_object_activate(timer, &timer_debug_descr);
690}
691
692static inline void debug_timer_deactivate(struct timer_list *timer)
693{
694 debug_object_deactivate(timer, &timer_debug_descr);
695}
696
697static inline void debug_timer_free(struct timer_list *timer)
698{
699 debug_object_free(timer, &timer_debug_descr);
700}
701
Christine Chandc4218b2011-11-07 19:48:28 -0800702static inline void debug_timer_assert_init(struct timer_list *timer)
703{
704 debug_object_assert_init(timer, &timer_debug_descr);
705}
706
Tejun Heofc683992012-08-08 11:10:27 -0700707static void do_init_timer(struct timer_list *timer, unsigned int flags,
708 const char *name, struct lock_class_key *key);
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700709
Tejun Heofc683992012-08-08 11:10:27 -0700710void init_timer_on_stack_key(struct timer_list *timer, unsigned int flags,
711 const char *name, struct lock_class_key *key)
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700712{
713 debug_object_init_on_stack(timer, &timer_debug_descr);
Tejun Heofc683992012-08-08 11:10:27 -0700714 do_init_timer(timer, flags, name, key);
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700715}
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100716EXPORT_SYMBOL_GPL(init_timer_on_stack_key);
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700717
718void destroy_timer_on_stack(struct timer_list *timer)
719{
720 debug_object_free(timer, &timer_debug_descr);
721}
722EXPORT_SYMBOL_GPL(destroy_timer_on_stack);
723
724#else
725static inline void debug_timer_init(struct timer_list *timer) { }
726static inline void debug_timer_activate(struct timer_list *timer) { }
727static inline void debug_timer_deactivate(struct timer_list *timer) { }
Christine Chandc4218b2011-11-07 19:48:28 -0800728static inline void debug_timer_assert_init(struct timer_list *timer) { }
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700729#endif
730
Xiao Guangrong2b022e32009-08-10 10:48:59 +0800731static inline void debug_init(struct timer_list *timer)
732{
733 debug_timer_init(timer);
734 trace_timer_init(timer);
735}
736
737static inline void
738debug_activate(struct timer_list *timer, unsigned long expires)
739{
740 debug_timer_activate(timer);
Thomas Gleixner0eeda712015-05-26 22:50:29 +0000741 trace_timer_start(timer, expires, timer->flags);
Xiao Guangrong2b022e32009-08-10 10:48:59 +0800742}
743
744static inline void debug_deactivate(struct timer_list *timer)
745{
746 debug_timer_deactivate(timer);
747 trace_timer_cancel(timer);
748}
749
Christine Chandc4218b2011-11-07 19:48:28 -0800750static inline void debug_assert_init(struct timer_list *timer)
751{
752 debug_timer_assert_init(timer);
753}
754
Tejun Heofc683992012-08-08 11:10:27 -0700755static void do_init_timer(struct timer_list *timer, unsigned int flags,
756 const char *name, struct lock_class_key *key)
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700757{
Thomas Gleixner1dabbce2015-05-26 22:50:28 +0000758 timer->entry.pprev = NULL;
Thomas Gleixner0eeda712015-05-26 22:50:29 +0000759 timer->flags = flags | raw_smp_processor_id();
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700760#ifdef CONFIG_TIMER_STATS
761 timer->start_site = NULL;
762 timer->start_pid = -1;
763 memset(timer->start_comm, 0, TASK_COMM_LEN);
764#endif
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100765 lockdep_init_map(&timer->lockdep_map, name, key, 0);
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700766}
767
Rolf Eike Beer2aae4a12006-09-29 01:59:46 -0700768/**
Randy Dunlap633fe792009-04-01 17:47:23 -0700769 * init_timer_key - initialize a timer
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700770 * @timer: the timer to be initialized
Tejun Heofc683992012-08-08 11:10:27 -0700771 * @flags: timer flags
Randy Dunlap633fe792009-04-01 17:47:23 -0700772 * @name: name of the timer
773 * @key: lockdep class key of the fake lock used for tracking timer
774 * sync lock dependencies
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700775 *
Randy Dunlap633fe792009-04-01 17:47:23 -0700776 * init_timer_key() must be done to a timer prior calling *any* of the
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700777 * other timer functions.
778 */
Tejun Heofc683992012-08-08 11:10:27 -0700779void init_timer_key(struct timer_list *timer, unsigned int flags,
780 const char *name, struct lock_class_key *key)
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700781{
Xiao Guangrong2b022e32009-08-10 10:48:59 +0800782 debug_init(timer);
Tejun Heofc683992012-08-08 11:10:27 -0700783 do_init_timer(timer, flags, name, key);
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700784}
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100785EXPORT_SYMBOL(init_timer_key);
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700786
Thomas Gleixnerec44bc72012-05-25 22:08:57 +0000787static inline void detach_timer(struct timer_list *timer, bool clear_pending)
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700788{
Thomas Gleixner1dabbce2015-05-26 22:50:28 +0000789 struct hlist_node *entry = &timer->entry;
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700790
Xiao Guangrong2b022e32009-08-10 10:48:59 +0800791 debug_deactivate(timer);
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700792
Thomas Gleixner1dabbce2015-05-26 22:50:28 +0000793 __hlist_del(entry);
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700794 if (clear_pending)
Thomas Gleixner1dabbce2015-05-26 22:50:28 +0000795 entry->pprev = NULL;
796 entry->next = LIST_POISON2;
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700797}
798
Thomas Gleixner494af3e2016-07-04 09:50:28 +0000799static int detach_if_pending(struct timer_list *timer, struct timer_base *base,
Thomas Gleixnerec44bc72012-05-25 22:08:57 +0000800 bool clear_pending)
801{
Thomas Gleixner500462a2016-07-04 09:50:30 +0000802 unsigned idx = timer_get_idx(timer);
803
Thomas Gleixnerec44bc72012-05-25 22:08:57 +0000804 if (!timer_pending(timer))
805 return 0;
806
Thomas Gleixner500462a2016-07-04 09:50:30 +0000807 if (hlist_is_singular_node(&timer->entry, base->vectors + idx))
808 __clear_bit(idx, base->pending_map);
809
Thomas Gleixnerec44bc72012-05-25 22:08:57 +0000810 detach_timer(timer, clear_pending);
Thomas Gleixnerec44bc72012-05-25 22:08:57 +0000811 return 1;
812}
813
Thomas Gleixner500462a2016-07-04 09:50:30 +0000814static inline struct timer_base *get_timer_cpu_base(u32 tflags, u32 cpu)
815{
816 struct timer_base *base = per_cpu_ptr(&timer_bases[BASE_STD], cpu);
817
818 /*
819 * If the timer is deferrable and nohz is active then we need to use
820 * the deferrable base.
821 */
822 if (IS_ENABLED(CONFIG_NO_HZ_COMMON) && base->nohz_active &&
823 (tflags & TIMER_DEFERRABLE))
824 base = per_cpu_ptr(&timer_bases[BASE_DEF], cpu);
825 return base;
826}
827
828static inline struct timer_base *get_timer_this_cpu_base(u32 tflags)
829{
830 struct timer_base *base = this_cpu_ptr(&timer_bases[BASE_STD]);
831
832 /*
833 * If the timer is deferrable and nohz is active then we need to use
834 * the deferrable base.
835 */
836 if (IS_ENABLED(CONFIG_NO_HZ_COMMON) && base->nohz_active &&
837 (tflags & TIMER_DEFERRABLE))
838 base = this_cpu_ptr(&timer_bases[BASE_DEF]);
839 return base;
840}
841
842static inline struct timer_base *get_timer_base(u32 tflags)
843{
844 return get_timer_cpu_base(tflags, tflags & TIMER_CPUMASK);
845}
846
847static inline struct timer_base *get_target_base(struct timer_base *base,
848 unsigned tflags)
849{
850#if defined(CONFIG_NO_HZ_COMMON) && defined(CONFIG_SMP)
851 if ((tflags & TIMER_PINNED) || !base->migration_enabled)
852 return get_timer_this_cpu_base(tflags);
853 return get_timer_cpu_base(tflags, get_nohz_timer_target());
854#else
855 return get_timer_this_cpu_base(tflags);
856#endif
857}
858
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700859/*
Thomas Gleixner500462a2016-07-04 09:50:30 +0000860 * We are using hashed locking: Holding per_cpu(timer_bases[x]).lock means
861 * that all timers which are tied to this base are locked, and the base itself
862 * is locked too.
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700863 *
864 * So __run_timers/migrate_timers can safely modify all timers which could
Thomas Gleixner500462a2016-07-04 09:50:30 +0000865 * be found in the base->vectors array.
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700866 *
Thomas Gleixner500462a2016-07-04 09:50:30 +0000867 * When a timer is migrating then the TIMER_MIGRATING flag is set and we need
868 * to wait until the migration is done.
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700869 */
Thomas Gleixner494af3e2016-07-04 09:50:28 +0000870static struct timer_base *lock_timer_base(struct timer_list *timer,
Thomas Gleixner500462a2016-07-04 09:50:30 +0000871 unsigned long *flags)
Josh Triplett89e7e3742006-09-29 01:59:36 -0700872 __acquires(timer->base->lock)
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700873{
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700874 for (;;) {
Thomas Gleixner494af3e2016-07-04 09:50:28 +0000875 struct timer_base *base;
Thomas Gleixner500462a2016-07-04 09:50:30 +0000876 u32 tf = timer->flags;
Thomas Gleixner0eeda712015-05-26 22:50:29 +0000877
878 if (!(tf & TIMER_MIGRATING)) {
Thomas Gleixner500462a2016-07-04 09:50:30 +0000879 base = get_timer_base(tf);
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700880 spin_lock_irqsave(&base->lock, *flags);
Thomas Gleixner0eeda712015-05-26 22:50:29 +0000881 if (timer->flags == tf)
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700882 return base;
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700883 spin_unlock_irqrestore(&base->lock, *flags);
884 }
885 cpu_relax();
886 }
887}
888
Ingo Molnar74019222009-02-18 12:23:29 +0100889static inline int
Thomas Gleixner177ec0a2016-07-04 09:50:24 +0000890__mod_timer(struct timer_list *timer, unsigned long expires, bool pending_only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891{
Thomas Gleixner494af3e2016-07-04 09:50:28 +0000892 struct timer_base *base, *new_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 unsigned long flags;
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000894 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Thomas Gleixner500462a2016-07-04 09:50:30 +0000896 /*
897 * TODO: Calculate the array bucket of the timer right here w/o
898 * holding the base lock. This allows to check not only
899 * timer->expires == expires below, but also whether the timer
900 * ends up in the same bucket. If we really need to requeue
901 * the timer then we check whether base->clk have
902 * advanced between here and locking the timer base. If
903 * jiffies advanced we have to recalc the array bucket with the
904 * lock held.
905 */
906
907 /*
908 * This is a common optimization triggered by the
909 * networking code - if the timer is re-modified
910 * to be the same thing then just return:
911 */
912 if (timer_pending(timer)) {
913 if (timer->expires == expires)
914 return 1;
915 }
916
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800917 timer_stats_timer_set_start_info(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 BUG_ON(!timer->function);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700920 base = lock_timer_base(timer, &flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Thomas Gleixnerec44bc72012-05-25 22:08:57 +0000922 ret = detach_if_pending(timer, base, false);
923 if (!ret && pending_only)
924 goto out_unlock;
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700925
Xiao Guangrong2b022e32009-08-10 10:48:59 +0800926 debug_activate(timer, expires);
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700927
Thomas Gleixner500462a2016-07-04 09:50:30 +0000928 new_base = get_target_base(base, timer->flags);
Arun R Bharadwajeea08f32009-04-16 12:16:41 +0530929
Oleg Nesterov3691c512006-03-31 02:30:30 -0800930 if (base != new_base) {
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700931 /*
Thomas Gleixner500462a2016-07-04 09:50:30 +0000932 * We are trying to schedule the timer on the new base.
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700933 * However we can't change timer's base while it is running,
934 * otherwise del_timer_sync() can't detect that the timer's
Thomas Gleixner500462a2016-07-04 09:50:30 +0000935 * handler yet has not finished. This also guarantees that the
936 * timer is serialized wrt itself.
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700937 */
Oleg Nesterova2c348f2006-03-31 02:30:31 -0800938 if (likely(base->running_timer != timer)) {
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700939 /* See the comment in lock_timer_base() */
Thomas Gleixner0eeda712015-05-26 22:50:29 +0000940 timer->flags |= TIMER_MIGRATING;
941
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700942 spin_unlock(&base->lock);
Oleg Nesterova2c348f2006-03-31 02:30:31 -0800943 base = new_base;
944 spin_lock(&base->lock);
Eric Dumazetd0023a12015-08-17 10:18:48 -0700945 WRITE_ONCE(timer->flags,
946 (timer->flags & ~TIMER_BASEMASK) | base->cpu);
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700947 }
948 }
949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 timer->expires = expires;
Oleg Nesterova2c348f2006-03-31 02:30:31 -0800951 internal_add_timer(base, timer);
Ingo Molnar74019222009-02-18 12:23:29 +0100952
953out_unlock:
Oleg Nesterova2c348f2006-03-31 02:30:31 -0800954 spin_unlock_irqrestore(&base->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955
956 return ret;
957}
958
Ingo Molnar74019222009-02-18 12:23:29 +0100959/**
960 * mod_timer_pending - modify a pending timer's timeout
961 * @timer: the pending timer to be modified
962 * @expires: new timeout in jiffies
963 *
964 * mod_timer_pending() is the same for pending timers as mod_timer(),
965 * but will not re-activate and modify already deleted timers.
966 *
967 * It is useful for unserialized use of timers.
968 */
969int mod_timer_pending(struct timer_list *timer, unsigned long expires)
970{
Thomas Gleixner177ec0a2016-07-04 09:50:24 +0000971 return __mod_timer(timer, expires, true);
Ingo Molnar74019222009-02-18 12:23:29 +0100972}
973EXPORT_SYMBOL(mod_timer_pending);
974
975/**
976 * mod_timer - modify a timer's timeout
977 * @timer: the timer to be modified
978 * @expires: new timeout in jiffies
979 *
980 * mod_timer() is a more efficient way to update the expire field of an
981 * active timer (if the timer is inactive it will be activated)
982 *
983 * mod_timer(timer, expires) is equivalent to:
984 *
985 * del_timer(timer); timer->expires = expires; add_timer(timer);
986 *
987 * Note that if there are multiple unserialized concurrent users of the
988 * same timer, then mod_timer() is the only safe way to modify the timeout,
989 * since add_timer() cannot modify an already running timer.
990 *
991 * The function returns whether it has modified a pending timer or not.
992 * (ie. mod_timer() of an inactive timer returns 0, mod_timer() of an
993 * active timer returns 1.)
994 */
995int mod_timer(struct timer_list *timer, unsigned long expires)
996{
Thomas Gleixner177ec0a2016-07-04 09:50:24 +0000997 return __mod_timer(timer, expires, false);
Ingo Molnar74019222009-02-18 12:23:29 +0100998}
999EXPORT_SYMBOL(mod_timer);
1000
1001/**
1002 * add_timer - start a timer
1003 * @timer: the timer to be added
1004 *
1005 * The kernel will do a ->function(->data) callback from the
1006 * timer interrupt at the ->expires point in the future. The
1007 * current time is 'jiffies'.
1008 *
1009 * The timer's ->expires, ->function (and if the handler uses it, ->data)
1010 * fields must be set prior calling this function.
1011 *
1012 * Timers with an ->expires field in the past will be executed in the next
1013 * timer tick.
1014 */
1015void add_timer(struct timer_list *timer)
1016{
1017 BUG_ON(timer_pending(timer));
1018 mod_timer(timer, timer->expires);
1019}
1020EXPORT_SYMBOL(add_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
Rolf Eike Beer2aae4a12006-09-29 01:59:46 -07001022/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 * add_timer_on - start a timer on a particular CPU
1024 * @timer: the timer to be added
1025 * @cpu: the CPU to start it on
1026 *
1027 * This is not very scalable on SMP. Double adds are not possible.
1028 */
1029void add_timer_on(struct timer_list *timer, int cpu)
1030{
Thomas Gleixner500462a2016-07-04 09:50:30 +00001031 struct timer_base *new_base, *base;
Thomas Gleixner68194572007-07-19 01:49:16 -07001032 unsigned long flags;
Oleg Nesterov55c888d2005-06-23 00:08:56 -07001033
Ingo Molnar82f67cd2007-02-16 01:28:13 -08001034 timer_stats_timer_set_start_info(timer);
Thomas Gleixner68194572007-07-19 01:49:16 -07001035 BUG_ON(timer_pending(timer) || !timer->function);
Tejun Heo22b886d2015-11-04 12:15:33 -05001036
Thomas Gleixner500462a2016-07-04 09:50:30 +00001037 new_base = get_timer_cpu_base(timer->flags, cpu);
1038
Tejun Heo22b886d2015-11-04 12:15:33 -05001039 /*
1040 * If @timer was on a different CPU, it should be migrated with the
1041 * old base locked to prevent other operations proceeding with the
1042 * wrong base locked. See lock_timer_base().
1043 */
1044 base = lock_timer_base(timer, &flags);
1045 if (base != new_base) {
1046 timer->flags |= TIMER_MIGRATING;
1047
1048 spin_unlock(&base->lock);
1049 base = new_base;
1050 spin_lock(&base->lock);
1051 WRITE_ONCE(timer->flags,
1052 (timer->flags & ~TIMER_BASEMASK) | cpu);
1053 }
1054
Xiao Guangrong2b022e32009-08-10 10:48:59 +08001055 debug_activate(timer, timer->expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 internal_add_timer(base, timer);
Oleg Nesterov3691c512006-03-31 02:30:30 -08001057 spin_unlock_irqrestore(&base->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058}
Andi Kleena9862e02009-05-19 22:49:07 +02001059EXPORT_SYMBOL_GPL(add_timer_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060
Rolf Eike Beer2aae4a12006-09-29 01:59:46 -07001061/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 * del_timer - deactive a timer.
1063 * @timer: the timer to be deactivated
1064 *
1065 * del_timer() deactivates a timer - this works on both active and inactive
1066 * timers.
1067 *
1068 * The function returns whether it has deactivated a pending timer or not.
1069 * (ie. del_timer() of an inactive timer returns 0, del_timer() of an
1070 * active timer returns 1.)
1071 */
1072int del_timer(struct timer_list *timer)
1073{
Thomas Gleixner494af3e2016-07-04 09:50:28 +00001074 struct timer_base *base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 unsigned long flags;
Oleg Nesterov55c888d2005-06-23 00:08:56 -07001076 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
Christine Chandc4218b2011-11-07 19:48:28 -08001078 debug_assert_init(timer);
1079
Ingo Molnar82f67cd2007-02-16 01:28:13 -08001080 timer_stats_timer_clear_start_info(timer);
Oleg Nesterov55c888d2005-06-23 00:08:56 -07001081 if (timer_pending(timer)) {
1082 base = lock_timer_base(timer, &flags);
Thomas Gleixnerec44bc72012-05-25 22:08:57 +00001083 ret = detach_if_pending(timer, base, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 spin_unlock_irqrestore(&base->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
Oleg Nesterov55c888d2005-06-23 00:08:56 -07001087 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089EXPORT_SYMBOL(del_timer);
1090
Rolf Eike Beer2aae4a12006-09-29 01:59:46 -07001091/**
1092 * try_to_del_timer_sync - Try to deactivate a timer
1093 * @timer: timer do del
1094 *
Oleg Nesterovfd450b72005-06-23 00:08:59 -07001095 * This function tries to deactivate a timer. Upon successful (ret >= 0)
1096 * exit the timer is not queued and the handler is not running on any CPU.
Oleg Nesterovfd450b72005-06-23 00:08:59 -07001097 */
1098int try_to_del_timer_sync(struct timer_list *timer)
1099{
Thomas Gleixner494af3e2016-07-04 09:50:28 +00001100 struct timer_base *base;
Oleg Nesterovfd450b72005-06-23 00:08:59 -07001101 unsigned long flags;
1102 int ret = -1;
1103
Christine Chandc4218b2011-11-07 19:48:28 -08001104 debug_assert_init(timer);
1105
Oleg Nesterovfd450b72005-06-23 00:08:59 -07001106 base = lock_timer_base(timer, &flags);
1107
Thomas Gleixnerec44bc72012-05-25 22:08:57 +00001108 if (base->running_timer != timer) {
1109 timer_stats_timer_clear_start_info(timer);
1110 ret = detach_if_pending(timer, base, true);
Oleg Nesterovfd450b72005-06-23 00:08:59 -07001111 }
Oleg Nesterovfd450b72005-06-23 00:08:59 -07001112 spin_unlock_irqrestore(&base->lock, flags);
1113
1114 return ret;
1115}
David Howellse19dff12007-04-26 15:46:56 -07001116EXPORT_SYMBOL(try_to_del_timer_sync);
1117
Yong Zhang6f1bc452010-10-20 15:57:31 -07001118#ifdef CONFIG_SMP
Rolf Eike Beer2aae4a12006-09-29 01:59:46 -07001119/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 * del_timer_sync - deactivate a timer and wait for the handler to finish.
1121 * @timer: the timer to be deactivated
1122 *
1123 * This function only differs from del_timer() on SMP: besides deactivating
1124 * the timer it also makes sure the handler has finished executing on other
1125 * CPUs.
1126 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001127 * Synchronization rules: Callers must prevent restarting of the timer,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 * otherwise this function is meaningless. It must not be called from
Tejun Heoc5f66e92012-08-08 11:10:28 -07001129 * interrupt contexts unless the timer is an irqsafe one. The caller must
1130 * not hold locks which would prevent completion of the timer's
1131 * handler. The timer's handler must not call add_timer_on(). Upon exit the
1132 * timer is not queued and the handler is not running on any CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 *
Tejun Heoc5f66e92012-08-08 11:10:28 -07001134 * Note: For !irqsafe timers, you must not hold locks that are held in
1135 * interrupt context while calling this function. Even if the lock has
1136 * nothing to do with the timer in question. Here's why:
Steven Rostedt48228f72011-02-08 12:39:54 -05001137 *
1138 * CPU0 CPU1
1139 * ---- ----
1140 * <SOFTIRQ>
1141 * call_timer_fn();
1142 * base->running_timer = mytimer;
1143 * spin_lock_irq(somelock);
1144 * <IRQ>
1145 * spin_lock(somelock);
1146 * del_timer_sync(mytimer);
1147 * while (base->running_timer == mytimer);
1148 *
1149 * Now del_timer_sync() will never return and never release somelock.
1150 * The interrupt on the other CPU is waiting to grab somelock but
1151 * it has interrupted the softirq that CPU0 is waiting to finish.
1152 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 * The function returns whether it has deactivated a pending timer or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 */
1155int del_timer_sync(struct timer_list *timer)
1156{
Johannes Berg6f2b9b92009-01-29 16:03:20 +01001157#ifdef CONFIG_LOCKDEP
Peter Zijlstraf266a512011-02-03 15:09:41 +01001158 unsigned long flags;
1159
Steven Rostedt48228f72011-02-08 12:39:54 -05001160 /*
1161 * If lockdep gives a backtrace here, please reference
1162 * the synchronization rules above.
1163 */
Peter Zijlstra7ff20792011-02-08 15:18:00 +01001164 local_irq_save(flags);
Johannes Berg6f2b9b92009-01-29 16:03:20 +01001165 lock_map_acquire(&timer->lockdep_map);
1166 lock_map_release(&timer->lockdep_map);
Peter Zijlstra7ff20792011-02-08 15:18:00 +01001167 local_irq_restore(flags);
Johannes Berg6f2b9b92009-01-29 16:03:20 +01001168#endif
Yong Zhang466bd302010-10-20 15:57:33 -07001169 /*
1170 * don't use it in hardirq context, because it
1171 * could lead to deadlock.
1172 */
Thomas Gleixner0eeda712015-05-26 22:50:29 +00001173 WARN_ON(in_irq() && !(timer->flags & TIMER_IRQSAFE));
Oleg Nesterovfd450b72005-06-23 00:08:59 -07001174 for (;;) {
1175 int ret = try_to_del_timer_sync(timer);
1176 if (ret >= 0)
1177 return ret;
Andrew Mortona0009652006-07-14 00:24:06 -07001178 cpu_relax();
Oleg Nesterovfd450b72005-06-23 00:08:59 -07001179 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180}
1181EXPORT_SYMBOL(del_timer_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182#endif
1183
Thomas Gleixner576da122010-03-12 21:10:29 +01001184static void call_timer_fn(struct timer_list *timer, void (*fn)(unsigned long),
1185 unsigned long data)
1186{
Peter Zijlstra4a2b4b22013-08-14 14:55:24 +02001187 int count = preempt_count();
Thomas Gleixner576da122010-03-12 21:10:29 +01001188
1189#ifdef CONFIG_LOCKDEP
1190 /*
1191 * It is permissible to free the timer from inside the
1192 * function that is called from it, this we need to take into
1193 * account for lockdep too. To avoid bogus "held lock freed"
1194 * warnings as well as problems when looking into
1195 * timer->lockdep_map, make a copy and use that here.
1196 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07001197 struct lockdep_map lockdep_map;
1198
1199 lockdep_copy_map(&lockdep_map, &timer->lockdep_map);
Thomas Gleixner576da122010-03-12 21:10:29 +01001200#endif
1201 /*
1202 * Couple the lock chain with the lock chain at
1203 * del_timer_sync() by acquiring the lock_map around the fn()
1204 * call here and in del_timer_sync().
1205 */
1206 lock_map_acquire(&lockdep_map);
1207
1208 trace_timer_expire_entry(timer);
1209 fn(data);
1210 trace_timer_expire_exit(timer);
1211
1212 lock_map_release(&lockdep_map);
1213
Peter Zijlstra4a2b4b22013-08-14 14:55:24 +02001214 if (count != preempt_count()) {
Thomas Gleixner802702e2010-03-12 20:13:23 +01001215 WARN_ONCE(1, "timer: %pF preempt leak: %08x -> %08x\n",
Peter Zijlstra4a2b4b22013-08-14 14:55:24 +02001216 fn, count, preempt_count());
Thomas Gleixner802702e2010-03-12 20:13:23 +01001217 /*
1218 * Restore the preempt count. That gives us a decent
1219 * chance to survive and extract information. If the
1220 * callback kept a lock held, bad luck, but not worse
1221 * than the BUG() we had.
1222 */
Peter Zijlstra4a2b4b22013-08-14 14:55:24 +02001223 preempt_count_set(count);
Thomas Gleixner576da122010-03-12 21:10:29 +01001224 }
1225}
1226
Thomas Gleixner500462a2016-07-04 09:50:30 +00001227static void expire_timers(struct timer_base *base, struct hlist_head *head)
1228{
1229 while (!hlist_empty(head)) {
1230 struct timer_list *timer;
1231 void (*fn)(unsigned long);
1232 unsigned long data;
1233
1234 timer = hlist_entry(head->first, struct timer_list, entry);
1235 timer_stats_account_timer(timer);
1236
1237 base->running_timer = timer;
1238 detach_timer(timer, true);
1239
1240 fn = timer->function;
1241 data = timer->data;
1242
1243 if (timer->flags & TIMER_IRQSAFE) {
1244 spin_unlock(&base->lock);
1245 call_timer_fn(timer, fn, data);
1246 spin_lock(&base->lock);
1247 } else {
1248 spin_unlock_irq(&base->lock);
1249 call_timer_fn(timer, fn, data);
1250 spin_lock_irq(&base->lock);
1251 }
1252 }
1253}
1254
1255static int collect_expired_timers(struct timer_base *base,
1256 struct hlist_head *heads)
1257{
1258 unsigned long clk = base->clk;
1259 struct hlist_head *vec;
1260 int i, levels = 0;
1261 unsigned int idx;
1262
1263 for (i = 0; i < LVL_DEPTH; i++) {
1264 idx = (clk & LVL_MASK) + i * LVL_SIZE;
1265
1266 if (__test_and_clear_bit(idx, base->pending_map)) {
1267 vec = base->vectors + idx;
1268 hlist_move_list(vec, heads++);
1269 levels++;
1270 }
1271 /* Is it time to look at the next level? */
1272 if (clk & LVL_CLK_MASK)
1273 break;
1274 /* Shift clock for the next level granularity */
1275 clk >>= LVL_CLK_SHIFT;
1276 }
1277 return levels;
1278}
Rolf Eike Beer2aae4a12006-09-29 01:59:46 -07001279
Frederic Weisbecker3451d022011-08-10 23:21:01 +02001280#ifdef CONFIG_NO_HZ_COMMON
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281/*
Thomas Gleixner500462a2016-07-04 09:50:30 +00001282 * Find the next pending bucket of a level. Search from @offset + @clk upwards
1283 * and if nothing there, search from start of the level (@offset) up to
1284 * @offset + clk.
1285 */
1286static int next_pending_bucket(struct timer_base *base, unsigned offset,
1287 unsigned clk)
1288{
1289 unsigned pos, start = offset + clk;
1290 unsigned end = offset + LVL_SIZE;
1291
1292 pos = find_next_bit(base->pending_map, end, start);
1293 if (pos < end)
1294 return pos - start;
1295
1296 pos = find_next_bit(base->pending_map, start, offset);
1297 return pos < start ? pos + LVL_SIZE - start : -1;
1298}
1299
1300/*
1301 * Search the first expiring timer in the various clock levels.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 */
Thomas Gleixner494af3e2016-07-04 09:50:28 +00001303static unsigned long __next_timer_interrupt(struct timer_base *base)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304{
Thomas Gleixner500462a2016-07-04 09:50:30 +00001305 unsigned long clk, next, adj;
1306 unsigned lvl, offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
Thomas Gleixner500462a2016-07-04 09:50:30 +00001308 spin_lock(&base->lock);
1309 next = base->clk + NEXT_TIMER_MAX_DELTA;
1310 clk = base->clk;
1311 for (lvl = 0; lvl < LVL_DEPTH; lvl++, offset += LVL_SIZE) {
1312 int pos = next_pending_bucket(base, offset, clk & LVL_MASK);
Venki Pallipadi6e453a62007-05-08 00:27:44 -07001313
Thomas Gleixner500462a2016-07-04 09:50:30 +00001314 if (pos >= 0) {
1315 unsigned long tmp = clk + (unsigned long) pos;
1316
1317 tmp <<= LVL_SHIFT(lvl);
1318 if (time_before(tmp, next))
1319 next = tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 }
Thomas Gleixner500462a2016-07-04 09:50:30 +00001321 /*
1322 * Clock for the next level. If the current level clock lower
1323 * bits are zero, we look at the next level as is. If not we
1324 * need to advance it by one because that's going to be the
1325 * next expiring bucket in that level. base->clk is the next
1326 * expiring jiffie. So in case of:
1327 *
1328 * LVL5 LVL4 LVL3 LVL2 LVL1 LVL0
1329 * 0 0 0 0 0 0
1330 *
1331 * we have to look at all levels @index 0. With
1332 *
1333 * LVL5 LVL4 LVL3 LVL2 LVL1 LVL0
1334 * 0 0 0 0 0 2
1335 *
1336 * LVL0 has the next expiring bucket @index 2. The upper
1337 * levels have the next expiring bucket @index 1.
1338 *
1339 * In case that the propagation wraps the next level the same
1340 * rules apply:
1341 *
1342 * LVL5 LVL4 LVL3 LVL2 LVL1 LVL0
1343 * 0 0 0 0 F 2
1344 *
1345 * So after looking at LVL0 we get:
1346 *
1347 * LVL5 LVL4 LVL3 LVL2 LVL1
1348 * 0 0 0 1 0
1349 *
1350 * So no propagation from LVL1 to LVL2 because that happened
1351 * with the add already, but then we need to propagate further
1352 * from LVL2 to LVL3.
1353 *
1354 * So the simple check whether the lower bits of the current
1355 * level are 0 or not is sufficient for all cases.
1356 */
1357 adj = clk & LVL_CLK_MASK ? 1 : 0;
1358 clk >>= LVL_CLK_SHIFT;
1359 clk += adj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 }
Thomas Gleixner500462a2016-07-04 09:50:30 +00001361 spin_unlock(&base->lock);
1362 return next;
Thomas Gleixner1cfd6842007-02-16 01:27:46 -08001363}
1364
1365/*
1366 * Check, if the next hrtimer event is before the next timer wheel
1367 * event:
1368 */
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001369static u64 cmp_next_hrtimer_event(u64 basem, u64 expires)
Thomas Gleixner1cfd6842007-02-16 01:27:46 -08001370{
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001371 u64 nextevt = hrtimer_get_next_event();
Thomas Gleixner1cfd6842007-02-16 01:27:46 -08001372
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001373 /*
1374 * If high resolution timers are enabled
1375 * hrtimer_get_next_event() returns KTIME_MAX.
1376 */
1377 if (expires <= nextevt)
Thomas Gleixner1cfd6842007-02-16 01:27:46 -08001378 return expires;
1379
Thomas Gleixner9501b6c2007-03-25 14:31:17 +02001380 /*
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001381 * If the next timer is already expired, return the tick base
1382 * time so the tick is fired immediately.
Thomas Gleixner9501b6c2007-03-25 14:31:17 +02001383 */
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001384 if (nextevt <= basem)
1385 return basem;
Thomas Gleixnereaad0842007-05-29 23:47:39 +02001386
1387 /*
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001388 * Round up to the next jiffie. High resolution timers are
1389 * off, so the hrtimers are expired in the tick and we need to
1390 * make sure that this tick really expires the timer to avoid
1391 * a ping pong of the nohz stop code.
1392 *
1393 * Use DIV_ROUND_UP_ULL to prevent gcc calling __divdi3
Thomas Gleixnereaad0842007-05-29 23:47:39 +02001394 */
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001395 return DIV_ROUND_UP_ULL(nextevt, TICK_NSEC) * TICK_NSEC;
Thomas Gleixner1cfd6842007-02-16 01:27:46 -08001396}
1397
1398/**
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001399 * get_next_timer_interrupt - return the time (clock mono) of the next timer
1400 * @basej: base time jiffies
1401 * @basem: base time clock monotonic
1402 *
1403 * Returns the tick aligned clock monotonic time of the next pending
1404 * timer or KTIME_MAX if no timer is pending.
Thomas Gleixner1cfd6842007-02-16 01:27:46 -08001405 */
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001406u64 get_next_timer_interrupt(unsigned long basej, u64 basem)
Thomas Gleixner1cfd6842007-02-16 01:27:46 -08001407{
Thomas Gleixner500462a2016-07-04 09:50:30 +00001408 struct timer_base *base = this_cpu_ptr(&timer_bases[BASE_STD]);
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001409 u64 expires = KTIME_MAX;
1410 unsigned long nextevt;
Thomas Gleixner1cfd6842007-02-16 01:27:46 -08001411
Heiko Carstensdbd87b52010-12-01 10:11:09 +01001412 /*
1413 * Pretend that there is no timer pending if the cpu is offline.
1414 * Possible pending timers will be migrated later to an active cpu.
1415 */
1416 if (cpu_is_offline(smp_processor_id()))
Thomas Gleixnere40468a2012-05-25 22:08:59 +00001417 return expires;
1418
Thomas Gleixner500462a2016-07-04 09:50:30 +00001419 nextevt = __next_timer_interrupt(base);
1420 if (time_before_eq(nextevt, basej))
1421 expires = basem;
1422 else
1423 expires = basem + (nextevt - basej) * TICK_NSEC;
Tony Lindgren69239742006-03-06 15:42:45 -08001424
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +00001425 return cmp_next_hrtimer_event(basem, expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426}
1427#endif
1428
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429/*
Daniel Walker5b4db0c2007-10-18 03:06:11 -07001430 * Called from the timer interrupt handler to charge one tick to the current
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 * process. user_tick is 1 if the tick is user time, 0 for system.
1432 */
1433void update_process_times(int user_tick)
1434{
1435 struct task_struct *p = current;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
1437 /* Note: this timer irq context must be accounted for as well. */
Paul Mackerrasfa13a5a2007-11-09 22:39:38 +01001438 account_process_tick(p, user_tick);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 run_local_timers();
Paul E. McKenneyc3377c2d2014-10-21 07:53:02 -07001440 rcu_check_callbacks(user_tick);
Peter Zijlstrae360adb2010-10-14 14:01:34 +08001441#ifdef CONFIG_IRQ_WORK
1442 if (in_irq())
Frederic Weisbecker76a33062014-08-16 18:37:19 +02001443 irq_work_tick();
Peter Zijlstrae360adb2010-10-14 14:01:34 +08001444#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 scheduler_tick();
Thomas Gleixner68194572007-07-19 01:49:16 -07001446 run_posix_cpu_timers(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447}
1448
Anna-Maria Gleixner73420fe2016-07-04 09:50:33 +00001449/**
1450 * __run_timers - run all expired timers (if any) on this CPU.
1451 * @base: the timer vector to be processed.
1452 */
1453static inline void __run_timers(struct timer_base *base)
1454{
1455 struct hlist_head heads[LVL_DEPTH];
1456 int levels;
1457
1458 if (!time_after_eq(jiffies, base->clk))
1459 return;
1460
1461 spin_lock_irq(&base->lock);
1462
1463 while (time_after_eq(jiffies, base->clk)) {
1464
1465 levels = collect_expired_timers(base, heads);
1466 base->clk++;
1467
1468 while (levels--)
1469 expire_timers(base, heads + levels);
1470 }
1471 base->running_timer = NULL;
1472 spin_unlock_irq(&base->lock);
1473}
1474
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 * This function runs timers and the timer-tq in bottom half context.
1477 */
1478static void run_timer_softirq(struct softirq_action *h)
1479{
Thomas Gleixner500462a2016-07-04 09:50:30 +00001480 struct timer_base *base = this_cpu_ptr(&timer_bases[BASE_STD]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481
Thomas Gleixner500462a2016-07-04 09:50:30 +00001482 __run_timers(base);
1483 if (IS_ENABLED(CONFIG_NO_HZ_COMMON) && base->nohz_active)
1484 __run_timers(this_cpu_ptr(&timer_bases[BASE_DEF]));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485}
1486
1487/*
1488 * Called by the local, per-CPU timer interrupt on SMP.
1489 */
1490void run_local_timers(void)
1491{
Peter Zijlstrad3d74452008-01-25 21:08:31 +01001492 hrtimer_run_queues();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 raise_softirq(TIMER_SOFTIRQ);
1494}
1495
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496#ifdef __ARCH_WANT_SYS_ALARM
1497
1498/*
1499 * For backwards compatibility? This can be done in libc so Alpha
1500 * and all newer ports shouldn't need it.
1501 */
Heiko Carstens58fd3aa2009-01-14 14:14:03 +01001502SYSCALL_DEFINE1(alarm, unsigned int, seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503{
Thomas Gleixnerc08b8a42006-03-25 03:06:33 -08001504 return alarm_setitimer(seconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505}
1506
1507#endif
1508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509static void process_timeout(unsigned long __data)
1510{
Ingo Molnar36c8b582006-07-03 00:25:41 -07001511 wake_up_process((struct task_struct *)__data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512}
1513
1514/**
1515 * schedule_timeout - sleep until timeout
1516 * @timeout: timeout value in jiffies
1517 *
1518 * Make the current task sleep until @timeout jiffies have
1519 * elapsed. The routine will return immediately unless
1520 * the current task state has been set (see set_current_state()).
1521 *
1522 * You can set the task state as follows -
1523 *
1524 * %TASK_UNINTERRUPTIBLE - at least @timeout jiffies are guaranteed to
1525 * pass before the routine returns. The routine will return 0
1526 *
1527 * %TASK_INTERRUPTIBLE - the routine may return early if a signal is
1528 * delivered to the current task. In this case the remaining time
1529 * in jiffies will be returned, or 0 if the timer expired in time
1530 *
1531 * The current task state is guaranteed to be TASK_RUNNING when this
1532 * routine returns.
1533 *
1534 * Specifying a @timeout value of %MAX_SCHEDULE_TIMEOUT will schedule
1535 * the CPU away without a bound on the timeout. In this case the return
1536 * value will be %MAX_SCHEDULE_TIMEOUT.
1537 *
1538 * In all cases the return value is guaranteed to be non-negative.
1539 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001540signed long __sched schedule_timeout(signed long timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541{
1542 struct timer_list timer;
1543 unsigned long expire;
1544
1545 switch (timeout)
1546 {
1547 case MAX_SCHEDULE_TIMEOUT:
1548 /*
1549 * These two special cases are useful to be comfortable
1550 * in the caller. Nothing more. We could take
1551 * MAX_SCHEDULE_TIMEOUT from one of the negative value
1552 * but I' d like to return a valid offset (>=0) to allow
1553 * the caller to do everything it want with the retval.
1554 */
1555 schedule();
1556 goto out;
1557 default:
1558 /*
1559 * Another bit of PARANOID. Note that the retval will be
1560 * 0 since no piece of kernel is supposed to do a check
1561 * for a negative retval of schedule_timeout() (since it
1562 * should never happens anyway). You just have the printk()
1563 * that will tell you if something is gone wrong and where.
1564 */
Andrew Morton5b149bc2006-12-22 01:10:14 -08001565 if (timeout < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 printk(KERN_ERR "schedule_timeout: wrong timeout "
Andrew Morton5b149bc2006-12-22 01:10:14 -08001567 "value %lx\n", timeout);
1568 dump_stack();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 current->state = TASK_RUNNING;
1570 goto out;
1571 }
1572 }
1573
1574 expire = timeout + jiffies;
1575
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001576 setup_timer_on_stack(&timer, process_timeout, (unsigned long)current);
Thomas Gleixner177ec0a2016-07-04 09:50:24 +00001577 __mod_timer(&timer, expire, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 schedule();
1579 del_singleshot_timer_sync(&timer);
1580
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001581 /* Remove the timer from the object tracker */
1582 destroy_timer_on_stack(&timer);
1583
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 timeout = expire - jiffies;
1585
1586 out:
1587 return timeout < 0 ? 0 : timeout;
1588}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589EXPORT_SYMBOL(schedule_timeout);
1590
Andrew Morton8a1c1752005-09-13 01:25:15 -07001591/*
1592 * We can use __set_current_state() here because schedule_timeout() calls
1593 * schedule() unconditionally.
1594 */
Nishanth Aravamudan64ed93a2005-09-10 00:27:21 -07001595signed long __sched schedule_timeout_interruptible(signed long timeout)
1596{
Andrew Mortona5a0d522005-10-30 15:01:42 -08001597 __set_current_state(TASK_INTERRUPTIBLE);
1598 return schedule_timeout(timeout);
Nishanth Aravamudan64ed93a2005-09-10 00:27:21 -07001599}
1600EXPORT_SYMBOL(schedule_timeout_interruptible);
1601
Matthew Wilcox294d5cc2007-12-06 11:59:46 -05001602signed long __sched schedule_timeout_killable(signed long timeout)
1603{
1604 __set_current_state(TASK_KILLABLE);
1605 return schedule_timeout(timeout);
1606}
1607EXPORT_SYMBOL(schedule_timeout_killable);
1608
Nishanth Aravamudan64ed93a2005-09-10 00:27:21 -07001609signed long __sched schedule_timeout_uninterruptible(signed long timeout)
1610{
Andrew Mortona5a0d522005-10-30 15:01:42 -08001611 __set_current_state(TASK_UNINTERRUPTIBLE);
1612 return schedule_timeout(timeout);
Nishanth Aravamudan64ed93a2005-09-10 00:27:21 -07001613}
1614EXPORT_SYMBOL(schedule_timeout_uninterruptible);
1615
Andrew Morton69b27ba2016-03-25 14:20:21 -07001616/*
1617 * Like schedule_timeout_uninterruptible(), except this task will not contribute
1618 * to load average.
1619 */
1620signed long __sched schedule_timeout_idle(signed long timeout)
1621{
1622 __set_current_state(TASK_IDLE);
1623 return schedule_timeout(timeout);
1624}
1625EXPORT_SYMBOL(schedule_timeout_idle);
1626
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627#ifdef CONFIG_HOTPLUG_CPU
Thomas Gleixner494af3e2016-07-04 09:50:28 +00001628static void migrate_timer_list(struct timer_base *new_base, struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629{
1630 struct timer_list *timer;
Thomas Gleixner0eeda712015-05-26 22:50:29 +00001631 int cpu = new_base->cpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
Thomas Gleixner1dabbce2015-05-26 22:50:28 +00001633 while (!hlist_empty(head)) {
1634 timer = hlist_entry(head->first, struct timer_list, entry);
Thomas Gleixnerec44bc72012-05-25 22:08:57 +00001635 detach_timer(timer, false);
Thomas Gleixner0eeda712015-05-26 22:50:29 +00001636 timer->flags = (timer->flags & ~TIMER_BASEMASK) | cpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 internal_add_timer(new_base, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639}
1640
Paul Gortmaker0db06282013-06-19 14:53:51 -04001641static void migrate_timers(int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642{
Thomas Gleixner494af3e2016-07-04 09:50:28 +00001643 struct timer_base *old_base;
1644 struct timer_base *new_base;
Thomas Gleixner500462a2016-07-04 09:50:30 +00001645 int b, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646
1647 BUG_ON(cpu_online(cpu));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
Thomas Gleixner500462a2016-07-04 09:50:30 +00001649 for (b = 0; b < NR_BASES; b++) {
1650 old_base = per_cpu_ptr(&timer_bases[b], cpu);
1651 new_base = get_cpu_ptr(&timer_bases[b]);
1652 /*
1653 * The caller is globally serialized and nobody else
1654 * takes two locks at once, deadlock is not possible.
1655 */
1656 spin_lock_irq(&new_base->lock);
1657 spin_lock_nested(&old_base->lock, SINGLE_DEPTH_NESTING);
Oleg Nesterov3691c512006-03-31 02:30:30 -08001658
Thomas Gleixner500462a2016-07-04 09:50:30 +00001659 BUG_ON(old_base->running_timer);
1660
1661 for (i = 0; i < WHEEL_SIZE; i++)
1662 migrate_timer_list(new_base, old_base->vectors + i);
1663
1664 spin_unlock(&old_base->lock);
1665 spin_unlock_irq(&new_base->lock);
1666 put_cpu_ptr(&timer_bases);
Oleg Nesterov55c888d2005-06-23 00:08:56 -07001667 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
Paul Gortmaker0db06282013-06-19 14:53:51 -04001670static int timer_cpu_notify(struct notifier_block *self,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 unsigned long action, void *hcpu)
1672{
Viresh Kumar8def9062015-03-31 20:49:01 +05301673 switch (action) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 case CPU_DEAD:
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07001675 case CPU_DEAD_FROZEN:
Viresh Kumar8def9062015-03-31 20:49:01 +05301676 migrate_timers((long)hcpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 default:
1679 break;
1680 }
Peter Zijlstra3650b572015-03-31 20:49:02 +05301681
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 return NOTIFY_OK;
1683}
1684
Peter Zijlstra3650b572015-03-31 20:49:02 +05301685static inline void timer_register_cpu_notifier(void)
1686{
1687 cpu_notifier(timer_cpu_notify, 0);
1688}
1689#else
1690static inline void timer_register_cpu_notifier(void) { }
1691#endif /* CONFIG_HOTPLUG_CPU */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Thomas Gleixner0eeda712015-05-26 22:50:29 +00001693static void __init init_timer_cpu(int cpu)
Viresh Kumar8def9062015-03-31 20:49:01 +05301694{
Thomas Gleixner500462a2016-07-04 09:50:30 +00001695 struct timer_base *base;
1696 int i;
Peter Zijlstra3650b572015-03-31 20:49:02 +05301697
Thomas Gleixner500462a2016-07-04 09:50:30 +00001698 for (i = 0; i < NR_BASES; i++) {
1699 base = per_cpu_ptr(&timer_bases[i], cpu);
1700 base->cpu = cpu;
1701 spin_lock_init(&base->lock);
1702 base->clk = jiffies;
1703 }
Viresh Kumar8def9062015-03-31 20:49:01 +05301704}
1705
1706static void __init init_timer_cpus(void)
1707{
Viresh Kumar8def9062015-03-31 20:49:01 +05301708 int cpu;
1709
Thomas Gleixner0eeda712015-05-26 22:50:29 +00001710 for_each_possible_cpu(cpu)
1711 init_timer_cpu(cpu);
Viresh Kumar8def9062015-03-31 20:49:01 +05301712}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713
1714void __init init_timers(void)
1715{
Viresh Kumar8def9062015-03-31 20:49:01 +05301716 init_timer_cpus();
Viresh Kumarc24a4a32014-02-28 14:15:21 +05301717 init_timer_stats();
Peter Zijlstra3650b572015-03-31 20:49:02 +05301718 timer_register_cpu_notifier();
Carlos R. Mafra962cf362008-05-15 11:15:37 -03001719 open_softirq(TIMER_SOFTIRQ, run_timer_softirq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720}
1721
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722/**
1723 * msleep - sleep safely even with waitqueue interruptions
1724 * @msecs: Time in milliseconds to sleep for
1725 */
1726void msleep(unsigned int msecs)
1727{
1728 unsigned long timeout = msecs_to_jiffies(msecs) + 1;
1729
Nishanth Aravamudan75bcc8c2005-09-10 00:27:24 -07001730 while (timeout)
1731 timeout = schedule_timeout_uninterruptible(timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732}
1733
1734EXPORT_SYMBOL(msleep);
1735
1736/**
Domen Puncer96ec3ef2005-06-25 14:58:43 -07001737 * msleep_interruptible - sleep waiting for signals
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 * @msecs: Time in milliseconds to sleep for
1739 */
1740unsigned long msleep_interruptible(unsigned int msecs)
1741{
1742 unsigned long timeout = msecs_to_jiffies(msecs) + 1;
1743
Nishanth Aravamudan75bcc8c2005-09-10 00:27:24 -07001744 while (timeout && !signal_pending(current))
1745 timeout = schedule_timeout_interruptible(timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 return jiffies_to_msecs(timeout);
1747}
1748
1749EXPORT_SYMBOL(msleep_interruptible);
Patrick Pannuto5e7f5a12010-08-02 15:01:04 -07001750
Thomas Gleixner6deba082015-04-14 21:09:28 +00001751static void __sched do_usleep_range(unsigned long min, unsigned long max)
Patrick Pannuto5e7f5a12010-08-02 15:01:04 -07001752{
1753 ktime_t kmin;
John Stultzda8b44d2016-03-17 14:20:51 -07001754 u64 delta;
Patrick Pannuto5e7f5a12010-08-02 15:01:04 -07001755
1756 kmin = ktime_set(0, min * NSEC_PER_USEC);
John Stultzda8b44d2016-03-17 14:20:51 -07001757 delta = (u64)(max - min) * NSEC_PER_USEC;
Thomas Gleixner6deba082015-04-14 21:09:28 +00001758 schedule_hrtimeout_range(&kmin, delta, HRTIMER_MODE_REL);
Patrick Pannuto5e7f5a12010-08-02 15:01:04 -07001759}
1760
1761/**
1762 * usleep_range - Drop in replacement for udelay where wakeup is flexible
1763 * @min: Minimum time in usecs to sleep
1764 * @max: Maximum time in usecs to sleep
1765 */
Thomas Gleixner2ad5d322015-04-14 21:09:30 +00001766void __sched usleep_range(unsigned long min, unsigned long max)
Patrick Pannuto5e7f5a12010-08-02 15:01:04 -07001767{
1768 __set_current_state(TASK_UNINTERRUPTIBLE);
1769 do_usleep_range(min, max);
1770}
1771EXPORT_SYMBOL(usleep_range);