1dfd402a4SMarco Elver // SPDX-License-Identifier: GPL-2.0
2bd0ccc4aSMarco Elver /*
3bd0ccc4aSMarco Elver * KCSAN reporting.
4bd0ccc4aSMarco Elver *
5bd0ccc4aSMarco Elver * Copyright (C) 2019, Google LLC.
6bd0ccc4aSMarco Elver */
7dfd402a4SMarco Elver
82402d0eaSMarco Elver #include <linux/debug_locks.h>
92402d0eaSMarco Elver #include <linux/delay.h>
1005f9a406SMarco Elver #include <linux/jiffies.h>
116c65eb75SMarco Elver #include <linux/kallsyms.h>
12dfd402a4SMarco Elver #include <linux/kernel.h>
13f1bc9621SMarco Elver #include <linux/lockdep.h>
14dfd402a4SMarco Elver #include <linux/preempt.h>
15dfd402a4SMarco Elver #include <linux/printk.h>
16dfd402a4SMarco Elver #include <linux/sched.h>
17dfd402a4SMarco Elver #include <linux/spinlock.h>
18dfd402a4SMarco Elver #include <linux/stacktrace.h>
19dfd402a4SMarco Elver
20dfd402a4SMarco Elver #include "kcsan.h"
21dfd402a4SMarco Elver #include "encoding.h"
22dfd402a4SMarco Elver
23dfd402a4SMarco Elver /*
24dfd402a4SMarco Elver * Max. number of stack entries to show in the report.
25dfd402a4SMarco Elver */
26dfd402a4SMarco Elver #define NUM_STACK_ENTRIES 64
27dfd402a4SMarco Elver
28135c0872SMarco Elver /* Common access info. */
29135c0872SMarco Elver struct access_info {
30135c0872SMarco Elver const volatile void *ptr;
31135c0872SMarco Elver size_t size;
32135c0872SMarco Elver int access_type;
33135c0872SMarco Elver int task_pid;
34135c0872SMarco Elver int cpu_id;
3555a55fecSMarco Elver unsigned long ip;
36135c0872SMarco Elver };
37135c0872SMarco Elver
38dfd402a4SMarco Elver /*
39dfd402a4SMarco Elver * Other thread info: communicated from other racing thread to thread that set
406119418fSMarco Elver * up the watchpoint, which then prints the complete report atomically.
41dfd402a4SMarco Elver */
42135c0872SMarco Elver struct other_info {
43135c0872SMarco Elver struct access_info ai;
44dfd402a4SMarco Elver unsigned long stack_entries[NUM_STACK_ENTRIES];
45dfd402a4SMarco Elver int num_stack_entries;
462402d0eaSMarco Elver
472402d0eaSMarco Elver /*
482402d0eaSMarco Elver * Optionally pass @current. Typically we do not need to pass @current
492402d0eaSMarco Elver * via @other_info since just @task_pid is sufficient. Passing @current
502402d0eaSMarco Elver * has additional overhead.
512402d0eaSMarco Elver *
522402d0eaSMarco Elver * To safely pass @current, we must either use get_task_struct/
532402d0eaSMarco Elver * put_task_struct, or stall the thread that populated @other_info.
542402d0eaSMarco Elver *
552402d0eaSMarco Elver * We cannot rely on get_task_struct/put_task_struct in case
562402d0eaSMarco Elver * release_report() races with a task being released, and would have to
572402d0eaSMarco Elver * free it in release_report(). This may result in deadlock if we want
582402d0eaSMarco Elver * to use KCSAN on the allocators.
592402d0eaSMarco Elver *
602402d0eaSMarco Elver * Since we also want to reliably print held locks for
612402d0eaSMarco Elver * CONFIG_KCSAN_VERBOSE, the current implementation stalls the thread
622402d0eaSMarco Elver * that populated @other_info until it has been consumed.
632402d0eaSMarco Elver */
642402d0eaSMarco Elver struct task_struct *task;
65135c0872SMarco Elver };
66135c0872SMarco Elver
676119418fSMarco Elver /*
686119418fSMarco Elver * To never block any producers of struct other_info, we need as many elements
696119418fSMarco Elver * as we have watchpoints (upper bound on concurrent races to report).
706119418fSMarco Elver */
716119418fSMarco Elver static struct other_info other_infos[CONFIG_KCSAN_NUM_WATCHPOINTS + NUM_SLOTS-1];
72dfd402a4SMarco Elver
73dfd402a4SMarco Elver /*
74d591ec3dSMarco Elver * Information about reported races; used to rate limit reporting.
7505f9a406SMarco Elver */
7605f9a406SMarco Elver struct report_time {
7705f9a406SMarco Elver /*
78d591ec3dSMarco Elver * The last time the race was reported.
7905f9a406SMarco Elver */
8005f9a406SMarco Elver unsigned long time;
8105f9a406SMarco Elver
8205f9a406SMarco Elver /*
8305f9a406SMarco Elver * The frames of the 2 threads; if only 1 thread is known, one frame
8405f9a406SMarco Elver * will be 0.
8505f9a406SMarco Elver */
8605f9a406SMarco Elver unsigned long frame1;
8705f9a406SMarco Elver unsigned long frame2;
8805f9a406SMarco Elver };
8905f9a406SMarco Elver
9005f9a406SMarco Elver /*
9105f9a406SMarco Elver * Since we also want to be able to debug allocators with KCSAN, to avoid
9205f9a406SMarco Elver * deadlock, report_times cannot be dynamically resized with krealloc in
9305f9a406SMarco Elver * rate_limit_report.
9405f9a406SMarco Elver *
9505f9a406SMarco Elver * Therefore, we use a fixed-size array, which at most will occupy a page. This
9605f9a406SMarco Elver * still adequately rate limits reports, assuming that a) number of unique data
97d591ec3dSMarco Elver * races is not excessive, and b) occurrence of unique races within the
9805f9a406SMarco Elver * same time window is limited.
9905f9a406SMarco Elver */
10005f9a406SMarco Elver #define REPORT_TIMES_MAX (PAGE_SIZE / sizeof(struct report_time))
10105f9a406SMarco Elver #define REPORT_TIMES_SIZE \
10205f9a406SMarco Elver (CONFIG_KCSAN_REPORT_ONCE_IN_MS > REPORT_TIMES_MAX ? \
10305f9a406SMarco Elver REPORT_TIMES_MAX : \
10405f9a406SMarco Elver CONFIG_KCSAN_REPORT_ONCE_IN_MS)
10505f9a406SMarco Elver static struct report_time report_times[REPORT_TIMES_SIZE];
10605f9a406SMarco Elver
10705f9a406SMarco Elver /*
1086119418fSMarco Elver * Spinlock serializing report generation, and access to @other_infos. Although
1096119418fSMarco Elver * it could make sense to have a finer-grained locking story for @other_infos,
1106119418fSMarco Elver * report generation needs to be serialized either way, so not much is gained.
111dfd402a4SMarco Elver */
1126119418fSMarco Elver static DEFINE_RAW_SPINLOCK(report_lock);
113dfd402a4SMarco Elver
114dfd402a4SMarco Elver /*
115d591ec3dSMarco Elver * Checks if the race identified by thread frames frame1 and frame2 has
11605f9a406SMarco Elver * been reported since (now - KCSAN_REPORT_ONCE_IN_MS).
11705f9a406SMarco Elver */
rate_limit_report(unsigned long frame1,unsigned long frame2)11805f9a406SMarco Elver static bool rate_limit_report(unsigned long frame1, unsigned long frame2)
11905f9a406SMarco Elver {
12005f9a406SMarco Elver struct report_time *use_entry = &report_times[0];
12105f9a406SMarco Elver unsigned long invalid_before;
12205f9a406SMarco Elver int i;
12305f9a406SMarco Elver
12405f9a406SMarco Elver BUILD_BUG_ON(CONFIG_KCSAN_REPORT_ONCE_IN_MS != 0 && REPORT_TIMES_SIZE == 0);
12505f9a406SMarco Elver
12605f9a406SMarco Elver if (CONFIG_KCSAN_REPORT_ONCE_IN_MS == 0)
12705f9a406SMarco Elver return false;
12805f9a406SMarco Elver
12905f9a406SMarco Elver invalid_before = jiffies - msecs_to_jiffies(CONFIG_KCSAN_REPORT_ONCE_IN_MS);
13005f9a406SMarco Elver
131d591ec3dSMarco Elver /* Check if a matching race report exists. */
13205f9a406SMarco Elver for (i = 0; i < REPORT_TIMES_SIZE; ++i) {
13305f9a406SMarco Elver struct report_time *rt = &report_times[i];
13405f9a406SMarco Elver
13505f9a406SMarco Elver /*
13605f9a406SMarco Elver * Must always select an entry for use to store info as we
13705f9a406SMarco Elver * cannot resize report_times; at the end of the scan, use_entry
13805f9a406SMarco Elver * will be the oldest entry, which ideally also happened before
13905f9a406SMarco Elver * KCSAN_REPORT_ONCE_IN_MS ago.
14005f9a406SMarco Elver */
14105f9a406SMarco Elver if (time_before(rt->time, use_entry->time))
14205f9a406SMarco Elver use_entry = rt;
14305f9a406SMarco Elver
14405f9a406SMarco Elver /*
14505f9a406SMarco Elver * Initially, no need to check any further as this entry as well
14605f9a406SMarco Elver * as following entries have never been used.
14705f9a406SMarco Elver */
14805f9a406SMarco Elver if (rt->time == 0)
14905f9a406SMarco Elver break;
15005f9a406SMarco Elver
15105f9a406SMarco Elver /* Check if entry expired. */
15205f9a406SMarco Elver if (time_before(rt->time, invalid_before))
15305f9a406SMarco Elver continue; /* before KCSAN_REPORT_ONCE_IN_MS ago */
15405f9a406SMarco Elver
155d591ec3dSMarco Elver /* Reported recently, check if race matches. */
15605f9a406SMarco Elver if ((rt->frame1 == frame1 && rt->frame2 == frame2) ||
15705f9a406SMarco Elver (rt->frame1 == frame2 && rt->frame2 == frame1))
15805f9a406SMarco Elver return true;
15905f9a406SMarco Elver }
16005f9a406SMarco Elver
16105f9a406SMarco Elver use_entry->time = jiffies;
16205f9a406SMarco Elver use_entry->frame1 = frame1;
16305f9a406SMarco Elver use_entry->frame2 = frame2;
16405f9a406SMarco Elver return false;
16505f9a406SMarco Elver }
16605f9a406SMarco Elver
16705f9a406SMarco Elver /*
168dfd402a4SMarco Elver * Special rules to skip reporting.
169dfd402a4SMarco Elver */
1705cbaefe9SIngo Molnar static bool
skip_report(enum kcsan_value_change value_change,unsigned long top_frame)171b738f616SMarco Elver skip_report(enum kcsan_value_change value_change, unsigned long top_frame)
172dfd402a4SMarco Elver {
17381af89e1SMarco Elver /* Should never get here if value_change==FALSE. */
17481af89e1SMarco Elver WARN_ON_ONCE(value_change == KCSAN_VALUE_CHANGE_FALSE);
17581af89e1SMarco Elver
176ad4f8eecSMarco Elver /*
177b738f616SMarco Elver * The first call to skip_report always has value_change==TRUE, since we
178ad4f8eecSMarco Elver * cannot know the value written of an instrumented access. For the 2nd
179ad4f8eecSMarco Elver * call there are 6 cases with CONFIG_KCSAN_REPORT_VALUE_CHANGE_ONLY:
180ad4f8eecSMarco Elver *
181b738f616SMarco Elver * 1. read watchpoint, conflicting write (value_change==TRUE): report;
182b738f616SMarco Elver * 2. read watchpoint, conflicting write (value_change==MAYBE): skip;
183b738f616SMarco Elver * 3. write watchpoint, conflicting write (value_change==TRUE): report;
184b738f616SMarco Elver * 4. write watchpoint, conflicting write (value_change==MAYBE): skip;
185b738f616SMarco Elver * 5. write watchpoint, conflicting read (value_change==MAYBE): skip;
186b738f616SMarco Elver * 6. write watchpoint, conflicting read (value_change==TRUE): report;
187ad4f8eecSMarco Elver *
188ad4f8eecSMarco Elver * Cases 1-4 are intuitive and expected; case 5 ensures we do not report
189d591ec3dSMarco Elver * data races where the write may have rewritten the same value; case 6
190d591ec3dSMarco Elver * is possible either if the size is larger than what we check value
191d591ec3dSMarco Elver * changes for or the access type is KCSAN_ACCESS_ASSERT.
192ad4f8eecSMarco Elver */
193b738f616SMarco Elver if (IS_ENABLED(CONFIG_KCSAN_REPORT_VALUE_CHANGE_ONLY) &&
194b738f616SMarco Elver value_change == KCSAN_VALUE_CHANGE_MAYBE) {
195dfd402a4SMarco Elver /*
196dfd402a4SMarco Elver * The access is a write, but the data value did not change.
197dfd402a4SMarco Elver *
198dfd402a4SMarco Elver * We opt-out of this filter for certain functions at request of
199dfd402a4SMarco Elver * maintainers.
200dfd402a4SMarco Elver */
201dfd402a4SMarco Elver char buf[64];
202f770ed10SMarco Elver int len = scnprintf(buf, sizeof(buf), "%ps", (void *)top_frame);
203dfd402a4SMarco Elver
204f770ed10SMarco Elver if (!strnstr(buf, "rcu_", len) &&
205f770ed10SMarco Elver !strnstr(buf, "_rcu", len) &&
206f770ed10SMarco Elver !strnstr(buf, "_srcu", len))
207dfd402a4SMarco Elver return true;
208dfd402a4SMarco Elver }
209dfd402a4SMarco Elver
210dfd402a4SMarco Elver return kcsan_skip_report_debugfs(top_frame);
211dfd402a4SMarco Elver }
212dfd402a4SMarco Elver
get_access_type(int type)21347144ecaSMarco Elver static const char *get_access_type(int type)
214dfd402a4SMarco Elver {
215757a4cefSMarco Elver if (type & KCSAN_ACCESS_ASSERT) {
216757a4cefSMarco Elver if (type & KCSAN_ACCESS_SCOPED) {
217757a4cefSMarco Elver if (type & KCSAN_ACCESS_WRITE)
2183cc21a53SMarco Elver return "assert no accesses (reordered)";
219757a4cefSMarco Elver else
2203cc21a53SMarco Elver return "assert no writes (reordered)";
221757a4cefSMarco Elver } else {
222757a4cefSMarco Elver if (type & KCSAN_ACCESS_WRITE)
223757a4cefSMarco Elver return "assert no accesses";
224757a4cefSMarco Elver else
225757a4cefSMarco Elver return "assert no writes";
226757a4cefSMarco Elver }
227757a4cefSMarco Elver }
228757a4cefSMarco Elver
22947144ecaSMarco Elver switch (type) {
23047144ecaSMarco Elver case 0:
23147144ecaSMarco Elver return "read";
23247144ecaSMarco Elver case KCSAN_ACCESS_ATOMIC:
23347144ecaSMarco Elver return "read (marked)";
23447144ecaSMarco Elver case KCSAN_ACCESS_WRITE:
23547144ecaSMarco Elver return "write";
23647144ecaSMarco Elver case KCSAN_ACCESS_WRITE | KCSAN_ACCESS_ATOMIC:
23747144ecaSMarco Elver return "write (marked)";
23814e2ac8dSMarco Elver case KCSAN_ACCESS_COMPOUND | KCSAN_ACCESS_WRITE:
23914e2ac8dSMarco Elver return "read-write";
24014e2ac8dSMarco Elver case KCSAN_ACCESS_COMPOUND | KCSAN_ACCESS_WRITE | KCSAN_ACCESS_ATOMIC:
24114e2ac8dSMarco Elver return "read-write (marked)";
242757a4cefSMarco Elver case KCSAN_ACCESS_SCOPED:
2433cc21a53SMarco Elver return "read (reordered)";
244757a4cefSMarco Elver case KCSAN_ACCESS_SCOPED | KCSAN_ACCESS_ATOMIC:
2453cc21a53SMarco Elver return "read (marked, reordered)";
246757a4cefSMarco Elver case KCSAN_ACCESS_SCOPED | KCSAN_ACCESS_WRITE:
2473cc21a53SMarco Elver return "write (reordered)";
248757a4cefSMarco Elver case KCSAN_ACCESS_SCOPED | KCSAN_ACCESS_WRITE | KCSAN_ACCESS_ATOMIC:
2493cc21a53SMarco Elver return "write (marked, reordered)";
250d627c537SMarco Elver case KCSAN_ACCESS_SCOPED | KCSAN_ACCESS_COMPOUND | KCSAN_ACCESS_WRITE:
2513cc21a53SMarco Elver return "read-write (reordered)";
252d627c537SMarco Elver case KCSAN_ACCESS_SCOPED | KCSAN_ACCESS_COMPOUND | KCSAN_ACCESS_WRITE | KCSAN_ACCESS_ATOMIC:
2533cc21a53SMarco Elver return "read-write (marked, reordered)";
25447144ecaSMarco Elver default:
25547144ecaSMarco Elver BUG();
25647144ecaSMarco Elver }
257dfd402a4SMarco Elver }
258dfd402a4SMarco Elver
get_bug_type(int type)259d591ec3dSMarco Elver static const char *get_bug_type(int type)
260d591ec3dSMarco Elver {
261d591ec3dSMarco Elver return (type & KCSAN_ACCESS_ASSERT) != 0 ? "assert: race" : "data-race";
262d591ec3dSMarco Elver }
263d591ec3dSMarco Elver
264dfd402a4SMarco Elver /* Return thread description: in task or interrupt. */
get_thread_desc(int task_id)265dfd402a4SMarco Elver static const char *get_thread_desc(int task_id)
266dfd402a4SMarco Elver {
267dfd402a4SMarco Elver if (task_id != -1) {
268dfd402a4SMarco Elver static char buf[32]; /* safe: protected by report_lock */
269dfd402a4SMarco Elver
270dfd402a4SMarco Elver snprintf(buf, sizeof(buf), "task %i", task_id);
271dfd402a4SMarco Elver return buf;
272dfd402a4SMarco Elver }
273dfd402a4SMarco Elver return "interrupt";
274dfd402a4SMarco Elver }
275dfd402a4SMarco Elver
276dfd402a4SMarco Elver /* Helper to skip KCSAN-related functions in stack-trace. */
get_stack_skipnr(const unsigned long stack_entries[],int num_entries)277135c0872SMarco Elver static int get_stack_skipnr(const unsigned long stack_entries[], int num_entries)
278dfd402a4SMarco Elver {
279dfd402a4SMarco Elver char buf[64];
280cdb9b07dSMarco Elver char *cur;
281cdb9b07dSMarco Elver int len, skip;
282dfd402a4SMarco Elver
283cdb9b07dSMarco Elver for (skip = 0; skip < num_entries; ++skip) {
284f770ed10SMarco Elver len = scnprintf(buf, sizeof(buf), "%ps", (void *)stack_entries[skip]);
285cdb9b07dSMarco Elver
286cdb9b07dSMarco Elver /* Never show tsan_* or {read,write}_once_size. */
287cdb9b07dSMarco Elver if (strnstr(buf, "tsan_", len) ||
288cdb9b07dSMarco Elver strnstr(buf, "_once_size", len))
289cdb9b07dSMarco Elver continue;
290cdb9b07dSMarco Elver
291cdb9b07dSMarco Elver cur = strnstr(buf, "kcsan_", len);
292cdb9b07dSMarco Elver if (cur) {
293a4e74fa5SMarco Elver cur += strlen("kcsan_");
294a4e74fa5SMarco Elver if (!str_has_prefix(cur, "test"))
295cdb9b07dSMarco Elver continue; /* KCSAN runtime function. */
296cdb9b07dSMarco Elver /* KCSAN related test. */
297cdb9b07dSMarco Elver }
298cdb9b07dSMarco Elver
299cdb9b07dSMarco Elver /*
300cdb9b07dSMarco Elver * No match for runtime functions -- @skip entries to skip to
301cdb9b07dSMarco Elver * get to first frame of interest.
302cdb9b07dSMarco Elver */
303dfd402a4SMarco Elver break;
304dfd402a4SMarco Elver }
305cdb9b07dSMarco Elver
306dfd402a4SMarco Elver return skip;
307dfd402a4SMarco Elver }
308dfd402a4SMarco Elver
3096c65eb75SMarco Elver /*
3106c65eb75SMarco Elver * Skips to the first entry that matches the function of @ip, and then replaces
311be3f6967SMarco Elver * that entry with @ip, returning the entries to skip with @replaced containing
312be3f6967SMarco Elver * the replaced entry.
3136c65eb75SMarco Elver */
3146c65eb75SMarco Elver static int
replace_stack_entry(unsigned long stack_entries[],int num_entries,unsigned long ip,unsigned long * replaced)315be3f6967SMarco Elver replace_stack_entry(unsigned long stack_entries[], int num_entries, unsigned long ip,
316be3f6967SMarco Elver unsigned long *replaced)
3176c65eb75SMarco Elver {
3186c65eb75SMarco Elver unsigned long symbolsize, offset;
3196c65eb75SMarco Elver unsigned long target_func;
3206c65eb75SMarco Elver int skip;
3216c65eb75SMarco Elver
3226c65eb75SMarco Elver if (kallsyms_lookup_size_offset(ip, &symbolsize, &offset))
3236c65eb75SMarco Elver target_func = ip - offset;
3246c65eb75SMarco Elver else
3256c65eb75SMarco Elver goto fallback;
3266c65eb75SMarco Elver
3276c65eb75SMarco Elver for (skip = 0; skip < num_entries; ++skip) {
3286c65eb75SMarco Elver unsigned long func = stack_entries[skip];
3296c65eb75SMarco Elver
3306c65eb75SMarco Elver if (!kallsyms_lookup_size_offset(func, &symbolsize, &offset))
3316c65eb75SMarco Elver goto fallback;
3326c65eb75SMarco Elver func -= offset;
3336c65eb75SMarco Elver
3346c65eb75SMarco Elver if (func == target_func) {
335be3f6967SMarco Elver *replaced = stack_entries[skip];
3366c65eb75SMarco Elver stack_entries[skip] = ip;
3376c65eb75SMarco Elver return skip;
3386c65eb75SMarco Elver }
3396c65eb75SMarco Elver }
3406c65eb75SMarco Elver
3416c65eb75SMarco Elver fallback:
3426c65eb75SMarco Elver /* Should not happen; the resulting stack trace is likely misleading. */
3436c65eb75SMarco Elver WARN_ONCE(1, "Cannot find frame for %pS in stack trace", (void *)ip);
3446c65eb75SMarco Elver return get_stack_skipnr(stack_entries, num_entries);
3456c65eb75SMarco Elver }
3466c65eb75SMarco Elver
3476c65eb75SMarco Elver static int
sanitize_stack_entries(unsigned long stack_entries[],int num_entries,unsigned long ip,unsigned long * replaced)348be3f6967SMarco Elver sanitize_stack_entries(unsigned long stack_entries[], int num_entries, unsigned long ip,
349be3f6967SMarco Elver unsigned long *replaced)
3506c65eb75SMarco Elver {
351be3f6967SMarco Elver return ip ? replace_stack_entry(stack_entries, num_entries, ip, replaced) :
3526c65eb75SMarco Elver get_stack_skipnr(stack_entries, num_entries);
3536c65eb75SMarco Elver }
3546c65eb75SMarco Elver
355dfd402a4SMarco Elver /* Compares symbolized strings of addr1 and addr2. */
sym_strcmp(void * addr1,void * addr2)356dfd402a4SMarco Elver static int sym_strcmp(void *addr1, void *addr2)
357dfd402a4SMarco Elver {
358dfd402a4SMarco Elver char buf1[64];
359dfd402a4SMarco Elver char buf2[64];
360dfd402a4SMarco Elver
361dfd402a4SMarco Elver snprintf(buf1, sizeof(buf1), "%pS", addr1);
362dfd402a4SMarco Elver snprintf(buf2, sizeof(buf2), "%pS", addr2);
3635cbaefe9SIngo Molnar
364dfd402a4SMarco Elver return strncmp(buf1, buf2, sizeof(buf1));
365dfd402a4SMarco Elver }
366dfd402a4SMarco Elver
367be3f6967SMarco Elver static void
print_stack_trace(unsigned long stack_entries[],int num_entries,unsigned long reordered_to)368be3f6967SMarco Elver print_stack_trace(unsigned long stack_entries[], int num_entries, unsigned long reordered_to)
369be3f6967SMarco Elver {
370be3f6967SMarco Elver stack_trace_print(stack_entries, num_entries, 0);
371be3f6967SMarco Elver if (reordered_to)
372be3f6967SMarco Elver pr_err(" |\n +-> reordered to: %pS\n", (void *)reordered_to);
373be3f6967SMarco Elver }
374be3f6967SMarco Elver
print_verbose_info(struct task_struct * task)3752402d0eaSMarco Elver static void print_verbose_info(struct task_struct *task)
3762402d0eaSMarco Elver {
3772402d0eaSMarco Elver if (!task)
3782402d0eaSMarco Elver return;
3792402d0eaSMarco Elver
38092c209acSMarco Elver /* Restore IRQ state trace for printing. */
38192c209acSMarco Elver kcsan_restore_irqtrace(task);
38292c209acSMarco Elver
3832402d0eaSMarco Elver pr_err("\n");
3842402d0eaSMarco Elver debug_show_held_locks(task);
3852402d0eaSMarco Elver print_irqtrace_events(task);
3862402d0eaSMarco Elver }
3872402d0eaSMarco Elver
print_report(enum kcsan_value_change value_change,const struct access_info * ai,struct other_info * other_info,u64 old,u64 new,u64 mask)38897aa6139SMark Rutland static void print_report(enum kcsan_value_change value_change,
389135c0872SMarco Elver const struct access_info *ai,
3906c65eb75SMarco Elver struct other_info *other_info,
3917bbe6dc0SMark Rutland u64 old, u64 new, u64 mask)
392dfd402a4SMarco Elver {
393be3f6967SMarco Elver unsigned long reordered_to = 0;
394dfd402a4SMarco Elver unsigned long stack_entries[NUM_STACK_ENTRIES] = { 0 };
3955cbaefe9SIngo Molnar int num_stack_entries = stack_trace_save(stack_entries, NUM_STACK_ENTRIES, 1);
396be3f6967SMarco Elver int skipnr = sanitize_stack_entries(stack_entries, num_stack_entries, ai->ip, &reordered_to);
39705f9a406SMarco Elver unsigned long this_frame = stack_entries[skipnr];
398be3f6967SMarco Elver unsigned long other_reordered_to = 0;
39905f9a406SMarco Elver unsigned long other_frame = 0;
40005f9a406SMarco Elver int other_skipnr = 0; /* silence uninit warnings */
401dfd402a4SMarco Elver
402dfd402a4SMarco Elver /*
403dfd402a4SMarco Elver * Must check report filter rules before starting to print.
404dfd402a4SMarco Elver */
405b738f616SMarco Elver if (skip_report(KCSAN_VALUE_CHANGE_TRUE, stack_entries[skipnr]))
40697aa6139SMark Rutland return;
407dfd402a4SMarco Elver
408609f8097SMark Rutland if (other_info) {
4096c65eb75SMarco Elver other_skipnr = sanitize_stack_entries(other_info->stack_entries,
4106c65eb75SMarco Elver other_info->num_stack_entries,
411be3f6967SMarco Elver other_info->ai.ip, &other_reordered_to);
412135c0872SMarco Elver other_frame = other_info->stack_entries[other_skipnr];
413dfd402a4SMarco Elver
4145cbaefe9SIngo Molnar /* @value_change is only known for the other thread */
415ad4f8eecSMarco Elver if (skip_report(value_change, other_frame))
41697aa6139SMark Rutland return;
417dfd402a4SMarco Elver }
418dfd402a4SMarco Elver
41905f9a406SMarco Elver if (rate_limit_report(this_frame, other_frame))
42097aa6139SMark Rutland return;
42105f9a406SMarco Elver
422dfd402a4SMarco Elver /* Print report header. */
423dfd402a4SMarco Elver pr_err("==================================================================\n");
424609f8097SMark Rutland if (other_info) {
425dfd402a4SMarco Elver int cmp;
426dfd402a4SMarco Elver
427dfd402a4SMarco Elver /*
428dfd402a4SMarco Elver * Order functions lexographically for consistent bug titles.
429dfd402a4SMarco Elver * Do not print offset of functions to keep title short.
430dfd402a4SMarco Elver */
43105f9a406SMarco Elver cmp = sym_strcmp((void *)other_frame, (void *)this_frame);
432d591ec3dSMarco Elver pr_err("BUG: KCSAN: %s in %ps / %ps\n",
433135c0872SMarco Elver get_bug_type(ai->access_type | other_info->ai.access_type),
43405f9a406SMarco Elver (void *)(cmp < 0 ? other_frame : this_frame),
43505f9a406SMarco Elver (void *)(cmp < 0 ? this_frame : other_frame));
436609f8097SMark Rutland } else {
437135c0872SMarco Elver pr_err("BUG: KCSAN: %s in %pS\n", get_bug_type(ai->access_type),
438d591ec3dSMarco Elver (void *)this_frame);
439dfd402a4SMarco Elver }
440dfd402a4SMarco Elver
441dfd402a4SMarco Elver pr_err("\n");
442dfd402a4SMarco Elver
443dfd402a4SMarco Elver /* Print information about the racing accesses. */
444609f8097SMark Rutland if (other_info) {
445dfd402a4SMarco Elver pr_err("%s to 0x%px of %zu bytes by %s on cpu %i:\n",
446135c0872SMarco Elver get_access_type(other_info->ai.access_type), other_info->ai.ptr,
447135c0872SMarco Elver other_info->ai.size, get_thread_desc(other_info->ai.task_pid),
448135c0872SMarco Elver other_info->ai.cpu_id);
449dfd402a4SMarco Elver
450dfd402a4SMarco Elver /* Print the other thread's stack trace. */
451be3f6967SMarco Elver print_stack_trace(other_info->stack_entries + other_skipnr,
452135c0872SMarco Elver other_info->num_stack_entries - other_skipnr,
453be3f6967SMarco Elver other_reordered_to);
4542402d0eaSMarco Elver if (IS_ENABLED(CONFIG_KCSAN_VERBOSE))
455135c0872SMarco Elver print_verbose_info(other_info->task);
4562402d0eaSMarco Elver
457dfd402a4SMarco Elver pr_err("\n");
458dfd402a4SMarco Elver pr_err("%s to 0x%px of %zu bytes by %s on cpu %i:\n",
459135c0872SMarco Elver get_access_type(ai->access_type), ai->ptr, ai->size,
460135c0872SMarco Elver get_thread_desc(ai->task_pid), ai->cpu_id);
461609f8097SMark Rutland } else {
462dfd402a4SMarco Elver pr_err("race at unknown origin, with %s to 0x%px of %zu bytes by %s on cpu %i:\n",
463135c0872SMarco Elver get_access_type(ai->access_type), ai->ptr, ai->size,
464135c0872SMarco Elver get_thread_desc(ai->task_pid), ai->cpu_id);
465dfd402a4SMarco Elver }
466dfd402a4SMarco Elver /* Print stack trace of this thread. */
467be3f6967SMarco Elver print_stack_trace(stack_entries + skipnr, num_stack_entries - skipnr, reordered_to);
4682402d0eaSMarco Elver if (IS_ENABLED(CONFIG_KCSAN_VERBOSE))
4692402d0eaSMarco Elver print_verbose_info(current);
4702402d0eaSMarco Elver
4717bbe6dc0SMark Rutland /* Print observed value change. */
4727bbe6dc0SMark Rutland if (ai->size <= 8) {
4737bbe6dc0SMark Rutland int hex_len = ai->size * 2;
4747bbe6dc0SMark Rutland u64 diff = old ^ new;
4757bbe6dc0SMark Rutland
4767bbe6dc0SMark Rutland if (mask)
4777bbe6dc0SMark Rutland diff &= mask;
4787bbe6dc0SMark Rutland if (diff) {
4797bbe6dc0SMark Rutland pr_err("\n");
4807bbe6dc0SMark Rutland pr_err("value changed: 0x%0*llx -> 0x%0*llx\n",
4817bbe6dc0SMark Rutland hex_len, old, hex_len, new);
4827bbe6dc0SMark Rutland if (mask) {
4837bbe6dc0SMark Rutland pr_err(" bits changed: 0x%0*llx with mask 0x%0*llx\n",
4847bbe6dc0SMark Rutland hex_len, diff, hex_len, mask);
4857bbe6dc0SMark Rutland }
4867bbe6dc0SMark Rutland }
4877bbe6dc0SMark Rutland }
4887bbe6dc0SMark Rutland
489dfd402a4SMarco Elver /* Print report footer. */
490dfd402a4SMarco Elver pr_err("\n");
491dfd402a4SMarco Elver pr_err("Reported by Kernel Concurrency Sanitizer on:\n");
492dfd402a4SMarco Elver dump_stack_print_info(KERN_DEFAULT);
493dfd402a4SMarco Elver pr_err("==================================================================\n");
494dfd402a4SMarco Elver
495*79cc1ba7SKees Cook check_panic_on_warn("KCSAN");
496dfd402a4SMarco Elver }
497dfd402a4SMarco Elver
release_report(unsigned long * flags,struct other_info * other_info)498135c0872SMarco Elver static void release_report(unsigned long *flags, struct other_info *other_info)
499dfd402a4SMarco Elver {
5006119418fSMarco Elver /*
50119dfdc05SMark Rutland * Use size to denote valid/invalid, since KCSAN entirely ignores
50219dfdc05SMark Rutland * 0-sized accesses.
5036119418fSMarco Elver */
5046119418fSMarco Elver other_info->ai.size = 0;
5056119418fSMarco Elver raw_spin_unlock_irqrestore(&report_lock, *flags);
506dfd402a4SMarco Elver }
507dfd402a4SMarco Elver
508dfd402a4SMarco Elver /*
509135c0872SMarco Elver * Sets @other_info->task and awaits consumption of @other_info.
5102402d0eaSMarco Elver *
5112402d0eaSMarco Elver * Precondition: report_lock is held.
5122402d0eaSMarco Elver * Postcondition: report_lock is held.
5132402d0eaSMarco Elver */
set_other_info_task_blocking(unsigned long * flags,const struct access_info * ai,struct other_info * other_info)514135c0872SMarco Elver static void set_other_info_task_blocking(unsigned long *flags,
515135c0872SMarco Elver const struct access_info *ai,
516135c0872SMarco Elver struct other_info *other_info)
5172402d0eaSMarco Elver {
5182402d0eaSMarco Elver /*
5192402d0eaSMarco Elver * We may be instrumenting a code-path where current->state is already
5202402d0eaSMarco Elver * something other than TASK_RUNNING.
5212402d0eaSMarco Elver */
522b03fbd4fSPeter Zijlstra const bool is_running = task_is_running(current);
5232402d0eaSMarco Elver /*
5242402d0eaSMarco Elver * To avoid deadlock in case we are in an interrupt here and this is a
5252402d0eaSMarco Elver * race with a task on the same CPU (KCSAN_INTERRUPT_WATCHER), provide a
5262402d0eaSMarco Elver * timeout to ensure this works in all contexts.
5272402d0eaSMarco Elver *
5282402d0eaSMarco Elver * Await approximately the worst case delay of the reporting thread (if
5292402d0eaSMarco Elver * we are not interrupted).
5302402d0eaSMarco Elver */
5312402d0eaSMarco Elver int timeout = max(kcsan_udelay_task, kcsan_udelay_interrupt);
5322402d0eaSMarco Elver
533135c0872SMarco Elver other_info->task = current;
5342402d0eaSMarco Elver do {
5352402d0eaSMarco Elver if (is_running) {
5362402d0eaSMarco Elver /*
5372402d0eaSMarco Elver * Let lockdep know the real task is sleeping, to print
5382402d0eaSMarco Elver * the held locks (recall we turned lockdep off, so
5392402d0eaSMarco Elver * locking/unlocking @report_lock won't be recorded).
5402402d0eaSMarco Elver */
5412402d0eaSMarco Elver set_current_state(TASK_UNINTERRUPTIBLE);
5422402d0eaSMarco Elver }
5436119418fSMarco Elver raw_spin_unlock_irqrestore(&report_lock, *flags);
5442402d0eaSMarco Elver /*
5452402d0eaSMarco Elver * We cannot call schedule() since we also cannot reliably
5462402d0eaSMarco Elver * determine if sleeping here is permitted -- see in_atomic().
5472402d0eaSMarco Elver */
5482402d0eaSMarco Elver
5492402d0eaSMarco Elver udelay(1);
5506119418fSMarco Elver raw_spin_lock_irqsave(&report_lock, *flags);
5512402d0eaSMarco Elver if (timeout-- < 0) {
5522402d0eaSMarco Elver /*
553135c0872SMarco Elver * Abort. Reset @other_info->task to NULL, since it
5542402d0eaSMarco Elver * appears the other thread is still going to consume
5552402d0eaSMarco Elver * it. It will result in no verbose info printed for
5562402d0eaSMarco Elver * this task.
5572402d0eaSMarco Elver */
558135c0872SMarco Elver other_info->task = NULL;
5592402d0eaSMarco Elver break;
5602402d0eaSMarco Elver }
5612402d0eaSMarco Elver /*
5626119418fSMarco Elver * If invalid, or @ptr nor @current matches, then @other_info
5636119418fSMarco Elver * has been consumed and we may continue. If not, retry.
5642402d0eaSMarco Elver */
5656119418fSMarco Elver } while (other_info->ai.size && other_info->ai.ptr == ai->ptr &&
5666119418fSMarco Elver other_info->task == current);
5672402d0eaSMarco Elver if (is_running)
5682402d0eaSMarco Elver set_current_state(TASK_RUNNING);
5692402d0eaSMarco Elver }
5702402d0eaSMarco Elver
5716119418fSMarco Elver /* Populate @other_info; requires that the provided @other_info not in use. */
prepare_report_producer(unsigned long * flags,const struct access_info * ai,struct other_info * other_info)5726119418fSMarco Elver static void prepare_report_producer(unsigned long *flags,
5736119418fSMarco Elver const struct access_info *ai,
5746119418fSMarco Elver struct other_info *other_info)
575dfd402a4SMarco Elver {
5766119418fSMarco Elver raw_spin_lock_irqsave(&report_lock, *flags);
577dfd402a4SMarco Elver
5786119418fSMarco Elver /*
5796119418fSMarco Elver * The same @other_infos entry cannot be used concurrently, because
5806119418fSMarco Elver * there is a one-to-one mapping to watchpoint slots (@watchpoints in
5816119418fSMarco Elver * core.c), and a watchpoint is only released for reuse after reporting
5826119418fSMarco Elver * is done by the consumer of @other_info. Therefore, it is impossible
5836119418fSMarco Elver * for another concurrent prepare_report_producer() to set the same
5846119418fSMarco Elver * @other_info, and are guaranteed exclusivity for the @other_infos
5856119418fSMarco Elver * entry pointed to by @other_info.
5866119418fSMarco Elver *
5876119418fSMarco Elver * To check this property holds, size should never be non-zero here,
5886119418fSMarco Elver * because every consumer of struct other_info resets size to 0 in
5896119418fSMarco Elver * release_report().
5906119418fSMarco Elver */
5916119418fSMarco Elver WARN_ON(other_info->ai.size);
592dfd402a4SMarco Elver
593135c0872SMarco Elver other_info->ai = *ai;
5946119418fSMarco Elver other_info->num_stack_entries = stack_trace_save(other_info->stack_entries, NUM_STACK_ENTRIES, 2);
595dfd402a4SMarco Elver
5962402d0eaSMarco Elver if (IS_ENABLED(CONFIG_KCSAN_VERBOSE))
597135c0872SMarco Elver set_other_info_task_blocking(flags, ai, other_info);
5982402d0eaSMarco Elver
5996119418fSMarco Elver raw_spin_unlock_irqrestore(&report_lock, *flags);
6006119418fSMarco Elver }
601dfd402a4SMarco Elver
6026119418fSMarco Elver /* Awaits producer to fill @other_info and then returns. */
prepare_report_consumer(unsigned long * flags,const struct access_info * ai,struct other_info * other_info)6036119418fSMarco Elver static bool prepare_report_consumer(unsigned long *flags,
6046119418fSMarco Elver const struct access_info *ai,
6056119418fSMarco Elver struct other_info *other_info)
6066119418fSMarco Elver {
607dfd402a4SMarco Elver
6086119418fSMarco Elver raw_spin_lock_irqsave(&report_lock, *flags);
6096119418fSMarco Elver while (!other_info->ai.size) { /* Await valid @other_info. */
6106119418fSMarco Elver raw_spin_unlock_irqrestore(&report_lock, *flags);
6116119418fSMarco Elver cpu_relax();
6126119418fSMarco Elver raw_spin_lock_irqsave(&report_lock, *flags);
6136119418fSMarco Elver }
614dfd402a4SMarco Elver
6156119418fSMarco Elver /* Should always have a matching access based on watchpoint encoding. */
6166119418fSMarco Elver if (WARN_ON(!matching_access((unsigned long)other_info->ai.ptr & WATCHPOINT_ADDR_MASK, other_info->ai.size,
6176119418fSMarco Elver (unsigned long)ai->ptr & WATCHPOINT_ADDR_MASK, ai->size)))
6186119418fSMarco Elver goto discard;
619dfd402a4SMarco Elver
620135c0872SMarco Elver if (!matching_access((unsigned long)other_info->ai.ptr, other_info->ai.size,
621135c0872SMarco Elver (unsigned long)ai->ptr, ai->size)) {
622dfd402a4SMarco Elver /*
623dfd402a4SMarco Elver * If the actual accesses to not match, this was a false
624dfd402a4SMarco Elver * positive due to watchpoint encoding.
625dfd402a4SMarco Elver */
6262e986b81SMarco Elver atomic_long_inc(&kcsan_counters[KCSAN_COUNTER_ENCODING_FALSE_POSITIVES]);
6276119418fSMarco Elver goto discard;
628dfd402a4SMarco Elver }
629dfd402a4SMarco Elver
630dfd402a4SMarco Elver return true;
631dfd402a4SMarco Elver
6326119418fSMarco Elver discard:
6336119418fSMarco Elver release_report(flags, other_info);
6346119418fSMarco Elver return false;
635dfd402a4SMarco Elver }
636dfd402a4SMarco Elver
prepare_access_info(const volatile void * ptr,size_t size,int access_type,unsigned long ip)63739b2e763SMark Rutland static struct access_info prepare_access_info(const volatile void *ptr, size_t size,
63855a55fecSMarco Elver int access_type, unsigned long ip)
6396119418fSMarco Elver {
64039b2e763SMark Rutland return (struct access_info) {
641135c0872SMarco Elver .ptr = ptr,
642135c0872SMarco Elver .size = size,
643135c0872SMarco Elver .access_type = access_type,
644135c0872SMarco Elver .task_pid = in_task() ? task_pid_nr(current) : -1,
64555a55fecSMarco Elver .cpu_id = raw_smp_processor_id(),
6466c65eb75SMarco Elver /* Only replace stack entry with @ip if scoped access. */
6476c65eb75SMarco Elver .ip = (access_type & KCSAN_ACCESS_SCOPED) ? ip : 0,
648135c0872SMarco Elver };
64939b2e763SMark Rutland }
65039b2e763SMark Rutland
kcsan_report_set_info(const volatile void * ptr,size_t size,int access_type,unsigned long ip,int watchpoint_idx)651793c2579SMark Rutland void kcsan_report_set_info(const volatile void *ptr, size_t size, int access_type,
65255a55fecSMarco Elver unsigned long ip, int watchpoint_idx)
653793c2579SMark Rutland {
65455a55fecSMarco Elver const struct access_info ai = prepare_access_info(ptr, size, access_type, ip);
65519dfdc05SMark Rutland unsigned long flags;
6566119418fSMarco Elver
6576119418fSMarco Elver kcsan_disable_current();
65819dfdc05SMark Rutland lockdep_off(); /* See kcsan_report_known_origin(). */
659dfd402a4SMarco Elver
66019dfdc05SMark Rutland prepare_report_producer(&flags, &ai, &other_infos[watchpoint_idx]);
66119dfdc05SMark Rutland
66219dfdc05SMark Rutland lockdep_on();
66319dfdc05SMark Rutland kcsan_enable_current();
664793c2579SMark Rutland }
665793c2579SMark Rutland
kcsan_report_known_origin(const volatile void * ptr,size_t size,int access_type,unsigned long ip,enum kcsan_value_change value_change,int watchpoint_idx,u64 old,u64 new,u64 mask)666793c2579SMark Rutland void kcsan_report_known_origin(const volatile void *ptr, size_t size, int access_type,
66755a55fecSMarco Elver unsigned long ip, enum kcsan_value_change value_change,
66855a55fecSMarco Elver int watchpoint_idx, u64 old, u64 new, u64 mask)
669793c2579SMark Rutland {
67055a55fecSMarco Elver const struct access_info ai = prepare_access_info(ptr, size, access_type, ip);
67119dfdc05SMark Rutland struct other_info *other_info = &other_infos[watchpoint_idx];
67219dfdc05SMark Rutland unsigned long flags = 0;
67339b2e763SMark Rutland
67419dfdc05SMark Rutland kcsan_disable_current();
675f1bc9621SMarco Elver /*
676248591f5SMarco Elver * Because we may generate reports when we're in scheduler code, the use
677248591f5SMarco Elver * of printk() could deadlock. Until such time that all printing code
678248591f5SMarco Elver * called in print_report() is scheduler-safe, accept the risk, and just
679248591f5SMarco Elver * get our message out. As such, also disable lockdep to hide the
680248591f5SMarco Elver * warning, and avoid disabling lockdep for the rest of the kernel.
681f1bc9621SMarco Elver */
682f1bc9621SMarco Elver lockdep_off();
683f1bc9621SMarco Elver
68419dfdc05SMark Rutland if (!prepare_report_consumer(&flags, &ai, other_info))
68519dfdc05SMark Rutland goto out;
68681af89e1SMarco Elver /*
68719dfdc05SMark Rutland * Never report if value_change is FALSE, only when it is
68881af89e1SMarco Elver * either TRUE or MAYBE. In case of MAYBE, further filtering may
68981af89e1SMarco Elver * be done once we know the full stack trace in print_report().
69081af89e1SMarco Elver */
69119dfdc05SMark Rutland if (value_change != KCSAN_VALUE_CHANGE_FALSE)
6927bbe6dc0SMark Rutland print_report(value_change, &ai, other_info, old, new, mask);
693dfd402a4SMarco Elver
694135c0872SMarco Elver release_report(&flags, other_info);
69519dfdc05SMark Rutland out:
69619dfdc05SMark Rutland lockdep_on();
69719dfdc05SMark Rutland kcsan_enable_current();
698dfd402a4SMarco Elver }
699f1bc9621SMarco Elver
kcsan_report_unknown_origin(const volatile void * ptr,size_t size,int access_type,unsigned long ip,u64 old,u64 new,u64 mask)7007bbe6dc0SMark Rutland void kcsan_report_unknown_origin(const volatile void *ptr, size_t size, int access_type,
70155a55fecSMarco Elver unsigned long ip, u64 old, u64 new, u64 mask)
702793c2579SMark Rutland {
70355a55fecSMarco Elver const struct access_info ai = prepare_access_info(ptr, size, access_type, ip);
70419dfdc05SMark Rutland unsigned long flags;
70539b2e763SMark Rutland
70619dfdc05SMark Rutland kcsan_disable_current();
70719dfdc05SMark Rutland lockdep_off(); /* See kcsan_report_known_origin(). */
70819dfdc05SMark Rutland
70919dfdc05SMark Rutland raw_spin_lock_irqsave(&report_lock, flags);
7107bbe6dc0SMark Rutland print_report(KCSAN_VALUE_CHANGE_TRUE, &ai, NULL, old, new, mask);
71119dfdc05SMark Rutland raw_spin_unlock_irqrestore(&report_lock, flags);
71219dfdc05SMark Rutland
713f1bc9621SMarco Elver lockdep_on();
7146119418fSMarco Elver kcsan_enable_current();
715dfd402a4SMarco Elver }
716