1 // SPDX-License-Identifier: GPL-2.0
3 * check TSC synchronization.
5 * Copyright (C) 2006, Red Hat, Inc., Ingo Molnar
7 * We check whether all boot CPUs have their TSC's synchronized,
8 * print a warning if not and turn off the TSC clock-source.
10 * The warp-check is point-to-point between two CPUs, the CPU
11 * initiating the bootup is the 'source CPU', the freshly booting
12 * CPU is the 'target CPU'.
14 * Only two CPUs may participate - they can enter in any order.
15 * ( The serial nature of the boot logic and the CPU hotplug lock
16 * protects against more than 2 CPUs entering this code. )
18 #include <linux/workqueue.h>
19 #include <linux/topology.h>
20 #include <linux/spinlock.h>
21 #include <linux/kernel.h>
22 #include <linux/smp.h>
23 #include <linux/nmi.h>
29 unsigned long nextcheck
;
33 static DEFINE_PER_CPU(struct tsc_adjust
, tsc_adjust
);
34 static struct timer_list tsc_sync_check_timer
;
37 * TSC's on different sockets may be reset asynchronously.
38 * This may cause the TSC ADJUST value on socket 0 to be NOT 0.
40 bool __read_mostly tsc_async_resets
;
42 void mark_tsc_async_resets(char *reason
)
46 tsc_async_resets
= true;
47 pr_info("tsc: Marking TSC async resets true due to %s\n", reason
);
50 void tsc_verify_tsc_adjust(bool resume
)
52 struct tsc_adjust
*adj
= this_cpu_ptr(&tsc_adjust
);
55 if (!boot_cpu_has(X86_FEATURE_TSC_ADJUST
))
58 /* Skip unnecessary error messages if TSC already unstable */
59 if (check_tsc_unstable())
62 /* Rate limit the MSR check */
63 if (!resume
&& time_before(jiffies
, adj
->nextcheck
))
66 adj
->nextcheck
= jiffies
+ HZ
;
68 rdmsrl(MSR_IA32_TSC_ADJUST
, curval
);
69 if (adj
->adjusted
== curval
)
72 /* Restore the original value */
73 wrmsrl(MSR_IA32_TSC_ADJUST
, adj
->adjusted
);
75 if (!adj
->warned
|| resume
) {
76 pr_warn(FW_BUG
"TSC ADJUST differs: CPU%u %lld --> %lld. Restoring\n",
77 smp_processor_id(), adj
->adjusted
, curval
);
83 * Normally the tsc_sync will be checked every time system enters idle
84 * state, but there is still caveat that a system won't enter idle,
85 * either because it's too busy or configured purposely to not enter
88 * So setup a periodic timer (every 10 minutes) to make sure the check
92 #define SYNC_CHECK_INTERVAL (HZ * 600)
94 static void tsc_sync_check_timer_fn(struct timer_list
*unused
)
98 tsc_verify_tsc_adjust(false);
100 /* Run the check for all onlined CPUs in turn */
101 next_cpu
= cpumask_next(raw_smp_processor_id(), cpu_online_mask
);
102 if (next_cpu
>= nr_cpu_ids
)
103 next_cpu
= cpumask_first(cpu_online_mask
);
105 tsc_sync_check_timer
.expires
+= SYNC_CHECK_INTERVAL
;
106 add_timer_on(&tsc_sync_check_timer
, next_cpu
);
109 static int __init
start_sync_check_timer(void)
111 if (!cpu_feature_enabled(X86_FEATURE_TSC_ADJUST
) || tsc_clocksource_reliable
)
114 timer_setup(&tsc_sync_check_timer
, tsc_sync_check_timer_fn
, 0);
115 tsc_sync_check_timer
.expires
= jiffies
+ SYNC_CHECK_INTERVAL
;
116 add_timer(&tsc_sync_check_timer
);
120 late_initcall(start_sync_check_timer
);
122 static void tsc_sanitize_first_cpu(struct tsc_adjust
*cur
, s64 bootval
,
123 unsigned int cpu
, bool bootcpu
)
126 * First online CPU in a package stores the boot value in the
127 * adjustment value. This value might change later via the sync
128 * mechanism. If that fails we still can yell about boot values not
131 * On the boot cpu we just force set the ADJUST value to 0 if it's
132 * non zero. We don't do that on non boot cpus because physical
133 * hotplug should have set the ADJUST register to a value > 0 so
134 * the TSC is in sync with the already running cpus.
136 * Also don't force the ADJUST value to zero if that is a valid value
137 * for socket 0 as determined by the system arch. This is required
138 * when multiple sockets are reset asynchronously with each other
139 * and socket 0 may not have an TSC ADJUST value of 0.
141 if (bootcpu
&& bootval
!= 0) {
142 if (likely(!tsc_async_resets
)) {
143 pr_warn(FW_BUG
"TSC ADJUST: CPU%u: %lld force to 0\n",
145 wrmsrl(MSR_IA32_TSC_ADJUST
, 0);
148 pr_info("TSC ADJUST: CPU%u: %lld NOT forced to 0\n",
152 cur
->adjusted
= bootval
;
156 bool __init
tsc_store_and_check_tsc_adjust(bool bootcpu
)
158 struct tsc_adjust
*cur
= this_cpu_ptr(&tsc_adjust
);
161 if (!boot_cpu_has(X86_FEATURE_TSC_ADJUST
))
164 /* Skip unnecessary error messages if TSC already unstable */
165 if (check_tsc_unstable())
168 rdmsrl(MSR_IA32_TSC_ADJUST
, bootval
);
169 cur
->bootval
= bootval
;
170 cur
->nextcheck
= jiffies
+ HZ
;
171 tsc_sanitize_first_cpu(cur
, bootval
, smp_processor_id(), bootcpu
);
175 #else /* !CONFIG_SMP */
178 * Store and check the TSC ADJUST MSR if available
180 bool tsc_store_and_check_tsc_adjust(bool bootcpu
)
182 struct tsc_adjust
*ref
, *cur
= this_cpu_ptr(&tsc_adjust
);
183 unsigned int refcpu
, cpu
= smp_processor_id();
184 struct cpumask
*mask
;
187 if (!boot_cpu_has(X86_FEATURE_TSC_ADJUST
))
190 rdmsrl(MSR_IA32_TSC_ADJUST
, bootval
);
191 cur
->bootval
= bootval
;
192 cur
->nextcheck
= jiffies
+ HZ
;
196 * The default adjust value cannot be assumed to be zero on any socket.
198 cur
->adjusted
= bootval
;
201 * Check whether this CPU is the first in a package to come up. In
202 * this case do not check the boot value against another package
203 * because the new package might have been physically hotplugged,
204 * where TSC_ADJUST is expected to be different. When called on the
205 * boot CPU topology_core_cpumask() might not be available yet.
207 mask
= topology_core_cpumask(cpu
);
208 refcpu
= mask
? cpumask_any_but(mask
, cpu
) : nr_cpu_ids
;
210 if (refcpu
>= nr_cpu_ids
) {
211 tsc_sanitize_first_cpu(cur
, bootval
, smp_processor_id(),
216 ref
= per_cpu_ptr(&tsc_adjust
, refcpu
);
218 * Compare the boot value and complain if it differs in the
221 if (bootval
!= ref
->bootval
)
222 printk_once(FW_BUG
"TSC ADJUST differs within socket(s), fixing all errors\n");
225 * The TSC_ADJUST values in a package must be the same. If the boot
226 * value on this newly upcoming CPU differs from the adjustment
227 * value of the already online CPU in this package, set it to that
230 if (bootval
!= ref
->adjusted
) {
231 cur
->adjusted
= ref
->adjusted
;
232 wrmsrl(MSR_IA32_TSC_ADJUST
, ref
->adjusted
);
235 * We have the TSCs forced to be in sync on this package. Skip sync
242 * Entry/exit counters that make sure that both CPUs
243 * run the measurement code at once:
245 static atomic_t start_count
;
246 static atomic_t stop_count
;
247 static atomic_t test_runs
;
250 * We use a raw spinlock in this exceptional case, because
251 * we want to have the fastest, inlined, non-debug version
252 * of a critical section, to be able to prove TSC time-warps:
254 static arch_spinlock_t sync_lock
= __ARCH_SPIN_LOCK_UNLOCKED
;
256 static cycles_t last_tsc
;
257 static cycles_t max_warp
;
259 static int random_warps
;
262 * TSC-warp measurement loop running on both CPUs. This is not called
263 * if there is no TSC.
265 static cycles_t
check_tsc_warp(unsigned int timeout
)
267 cycles_t start
, now
, prev
, end
, cur_max_warp
= 0;
268 int i
, cur_warps
= 0;
270 start
= rdtsc_ordered();
272 * The measurement runs for 'timeout' msecs:
274 end
= start
+ (cycles_t
) tsc_khz
* timeout
;
278 * We take the global lock, measure TSC, save the
279 * previous TSC that was measured (possibly on
280 * another CPU) and update the previous TSC timestamp.
282 arch_spin_lock(&sync_lock
);
284 now
= rdtsc_ordered();
286 arch_spin_unlock(&sync_lock
);
289 * Be nice every now and then (and also check whether
290 * measurement is done [we also insert a 10 million
291 * loops safety exit, so we dont lock up in case the
292 * TSC readout is totally broken]):
294 if (unlikely(!(i
& 7))) {
295 if (now
> end
|| i
> 10000000)
298 touch_nmi_watchdog();
301 * Outside the critical section we can now see whether
302 * we saw a time-warp of the TSC going backwards:
304 if (unlikely(prev
> now
)) {
305 arch_spin_lock(&sync_lock
);
306 max_warp
= max(max_warp
, prev
- now
);
307 cur_max_warp
= max_warp
;
309 * Check whether this bounces back and forth. Only
310 * one CPU should observe time going backwards.
312 if (cur_warps
!= nr_warps
)
315 cur_warps
= nr_warps
;
316 arch_spin_unlock(&sync_lock
);
320 "Warning: zero tsc calibration delta: %Ld [max: %Ld]\n",
321 now
-start
, end
-start
);
326 * If the target CPU coming online doesn't have any of its core-siblings
327 * online, a timeout of 20msec will be used for the TSC-warp measurement
328 * loop. Otherwise a smaller timeout of 2msec will be used, as we have some
329 * information about this socket already (and this information grows as we
330 * have more and more logical-siblings in that socket).
332 * Ideally we should be able to skip the TSC sync check on the other
333 * core-siblings, if the first logical CPU in a socket passed the sync test.
334 * But as the TSC is per-logical CPU and can potentially be modified wrongly
335 * by the bios, TSC sync test for smaller duration should be able
336 * to catch such errors. Also this will catch the condition where all the
337 * cores in the socket don't get reset at the same time.
339 static inline unsigned int loop_timeout(int cpu
)
341 return (cpumask_weight(topology_core_cpumask(cpu
)) > 1) ? 2 : 20;
344 static void tsc_sync_mark_tsc_unstable(struct work_struct
*work
)
346 mark_tsc_unstable("check_tsc_sync_source failed");
349 static DECLARE_WORK(tsc_sync_work
, tsc_sync_mark_tsc_unstable
);
352 * The freshly booted CPU initiates this via an async SMP function call.
354 static void check_tsc_sync_source(void *__cpu
)
356 unsigned int cpu
= (unsigned long)__cpu
;
360 * Set the maximum number of test runs to
361 * 1 if the CPU does not provide the TSC_ADJUST MSR
362 * 3 if the MSR is available, so the target can try to adjust
364 if (!boot_cpu_has(X86_FEATURE_TSC_ADJUST
))
365 atomic_set(&test_runs
, 1);
367 atomic_set(&test_runs
, 3);
369 /* Wait for the target to start. */
370 while (atomic_read(&start_count
) != cpus
- 1)
374 * Trigger the target to continue into the measurement too:
376 atomic_inc(&start_count
);
378 check_tsc_warp(loop_timeout(cpu
));
380 while (atomic_read(&stop_count
) != cpus
-1)
384 * If the test was successful set the number of runs to zero and
385 * stop. If not, decrement the number of runs an check if we can
386 * retry. In case of random warps no retry is attempted.
389 atomic_set(&test_runs
, 0);
391 pr_debug("TSC synchronization [CPU#%d -> CPU#%u]: passed\n",
392 smp_processor_id(), cpu
);
394 } else if (atomic_dec_and_test(&test_runs
) || random_warps
) {
395 /* Force it to 0 if random warps brought us here */
396 atomic_set(&test_runs
, 0);
398 pr_warn("TSC synchronization [CPU#%d -> CPU#%u]:\n",
399 smp_processor_id(), cpu
);
400 pr_warn("Measured %Ld cycles TSC warp between CPUs, "
401 "turning off TSC clock.\n", max_warp
);
403 pr_warn("TSC warped randomly between CPUs\n");
404 schedule_work(&tsc_sync_work
);
408 * Reset it - just in case we boot another CPU later:
410 atomic_set(&start_count
, 0);
417 * Let the target continue with the bootup:
419 atomic_inc(&stop_count
);
422 * Retry, if there is a chance to do so.
424 if (atomic_read(&test_runs
) > 0)
429 * Freshly booted CPUs call into this:
431 void check_tsc_sync_target(void)
433 struct tsc_adjust
*cur
= this_cpu_ptr(&tsc_adjust
);
434 unsigned int cpu
= smp_processor_id();
435 cycles_t cur_max_warp
, gbl_max_warp
;
438 /* Also aborts if there is no TSC. */
439 if (unsynchronized_tsc())
443 * Store, verify and sanitize the TSC adjust register. If
444 * successful skip the test.
446 * The test is also skipped when the TSC is marked reliable. This
447 * is true for SoCs which have no fallback clocksource. On these
448 * SoCs the TSC is frequency synchronized, but still the TSC ADJUST
449 * register might have been wreckaged by the BIOS..
451 if (tsc_store_and_check_tsc_adjust(false) || tsc_clocksource_reliable
)
454 /* Kick the control CPU into the TSC synchronization function */
455 smp_call_function_single(cpumask_first(cpu_online_mask
), check_tsc_sync_source
,
456 (unsigned long *)(unsigned long)cpu
, 0);
459 * Register this CPU's participation and wait for the
460 * source CPU to start the measurement:
462 atomic_inc(&start_count
);
463 while (atomic_read(&start_count
) != cpus
)
466 cur_max_warp
= check_tsc_warp(loop_timeout(cpu
));
469 * Store the maximum observed warp value for a potential retry:
471 gbl_max_warp
= max_warp
;
476 atomic_inc(&stop_count
);
479 * Wait for the source CPU to print stuff:
481 while (atomic_read(&stop_count
) != cpus
)
485 * Reset it for the next sync test:
487 atomic_set(&stop_count
, 0);
490 * Check the number of remaining test runs. If not zero, the test
491 * failed and a retry with adjusted TSC is possible. If zero the
492 * test was either successful or failed terminally.
494 if (!atomic_read(&test_runs
))
498 * If the warp value of this CPU is 0, then the other CPU
499 * observed time going backwards so this TSC was ahead and
500 * needs to move backwards.
503 cur_max_warp
= -gbl_max_warp
;
506 * Add the result to the previous adjustment value.
508 * The adjustment value is slightly off by the overhead of the
509 * sync mechanism (observed values are ~200 TSC cycles), but this
510 * really depends on CPU, node distance and frequency. So
511 * compensating for this is hard to get right. Experiments show
512 * that the warp is not longer detectable when the observed warp
513 * value is used. In the worst case the adjustment needs to go
514 * through a 3rd run for fine tuning.
516 cur
->adjusted
+= cur_max_warp
;
518 pr_warn("TSC ADJUST compensate: CPU%u observed %lld warp. Adjust: %lld\n",
519 cpu
, cur_max_warp
, cur
->adjusted
);
521 wrmsrl(MSR_IA32_TSC_ADJUST
, cur
->adjusted
);
526 #endif /* CONFIG_SMP */