kcsan: Improvements to reporting
Subsystems (2)
Marco Elver
maintainercover kcsan: Improvements to reporting
Improvements to KCSAN data race reporting:
1. Show if access is marked (*_ONCE, atomic, etc.).
2. Rate limit reporting to avoid spamming console.
Marco Elver (2):
kcsan: Show full access type in report
kcsan: Rate-limit reporting per data races
kernel/kcsan/core.c | 15 +++-- kernel/kcsan/kcsan.h | 2 +- kernel/kcsan/report.c | 153 +++++++++++++++++++++++++++++++++++------- lib/Kconfig.kcsan | 10 +++ 4 files changed, 148 insertions(+), 32 deletions(-)
Signature · 1 line
2.25.0.rc1.283.g88dfdc4193-goog
Marco Elver
maintainerPATCH 1/2 kcsan: Show full access type in report
This change adds support for showing the complete access type in the report. Currently the following access types can be shown:
"read", "read (marked)", "write", "write (marked)".
--- kernel/kcsan/core.c | 15 ++++++++------- kernel/kcsan/kcsan.h | 2 +- kernel/kcsan/report.c | 43 ++++++++++++++++++++++++++++--------------- 3 files changed, 37 insertions(+), 23 deletions(-)
kernel/kcsan/core.c +8 -7
@@ -255,7 +255,7 @@ static inline unsigned int get_delay(void) static noinline void kcsan_found_watchpoint(const volatile void *ptr,size_t size, -bool is_write, +int type,atomic_long_t *watchpoint,long encoded_watchpoint) {
@@ -276,7 +276,7 @@ static noinline void kcsan_found_watchpoint(const volatile void *ptr, flags =user_access_save ();if (consumed) { -kcsan_report (ptr, size, is_write, true,raw_smp_processor_id (), +kcsan_report (ptr, size, type, true,raw_smp_processor_id (),KCSAN_REPORT_CONSUMED_WATCHPOINT ); }else {/*
@@ -292,8 +292,9 @@ static noinline void kcsan_found_watchpoint(const volatile void *ptr, } static noinline void -kcsan_setup_watchpoint (const volatile void *ptr,size_t size,bool is_write) +kcsan_setup_watchpoint (const volatile void *ptr,size_t size,int type) { +const bool is_write = (type &KCSAN_ACCESS_WRITE ) !=0 ;atomic_long_t *watchpoint;union {u8 _1;
@@ -415,13 +416,13 @@ kcsan_setup_watchpoint(const volatile void *ptr, size_t size, bool is_write)* No need to increment 'data_races' counter, as the racing * thread already did. */ -kcsan_report (ptr, size, is_write, size >8 || value_change, +kcsan_report (ptr, size, type, size >8 || value_change,smp_processor_id (),KCSAN_REPORT_RACE_SIGNAL ); }else if (value_change) {/* Inferring a race, since the value should not have changed. */ kcsan_counter_inc (KCSAN_COUNTER_RACES_UNKNOWN_ORIGIN );if (IS_ENABLED (CONFIG_KCSAN_REPORT_RACE_UNKNOWN_ORIGIN )) -kcsan_report (ptr, size, is_write, true, +kcsan_report (ptr, size, type, true,smp_processor_id (),KCSAN_REPORT_RACE_UNKNOWN_ORIGIN ); }
@@ -455,10 +456,10 @@ static __always_inline void check_access(const volatile void *ptr, size_t size,*/ if (unlikely (watchpoint !=NULL )) -kcsan_found_watchpoint (ptr, size, is_write, watchpoint, +kcsan_found_watchpoint (ptr, size, type, watchpoint, encoded_watchpoint);else if (unlikely (should_watch (ptr, type))) -kcsan_setup_watchpoint (ptr, size, is_write); +kcsan_setup_watchpoint (ptr, size, type); }/* === Public interface ===================================================== */
kernel/kcsan/kcsan.h +1 -1
@@ -103,7 +103,7 @@ enum kcsan_report_type {/* * Print a race report from thread that encountered the race. */ -extern void kcsan_report (const volatile void *ptr,size_t size,bool is_write, +extern void kcsan_report (const volatile void *ptr,size_t size,int access_type,bool value_change,int cpu_id,enum kcsan_report_type type);#endif /* _KERNEL_KCSAN_KCSAN_H */
kernel/kcsan/report.c +28 -15
122 lines not on this page · raw message
Signature · 1 line
2.25.0.rc1.283.g88dfdc4193-goog
Marco Elver
maintainerPATCH 2/2 kcsan: Rate-limit reporting per data races
In reply to Marco ElverAdds support for rate limiting reports. This uses a time based rate limit, that limits any given data race report to no more than one in a fixed time window (default is 3 sec). This should prevent the console from being spammed with data race reports, that would render the system unusable.
The implementation assumes that unique data races and the rate at which they occur is bounded, since we cannot store arbitrarily many past data race report information: we use a fixed-size array to store the required information. We cannot use kmalloc/krealloc and resize the list when needed, as reporting is triggered by the instrumentation calls; to permit using KCSAN on the allocators, we cannot (re-)allocate any memory during report generation (data races in the allocators lead to deadlock).
--- kernel/kcsan/report.c | 112 ++++++++++++++++++++++++++++++++++++++---- lib/Kconfig.kcsan | 10 ++++ 2 files changed, 112 insertions(+), 10 deletions(-)
kernel/kcsan/report.c +102 -10
@@ -1,6 +1,7 @@// SPDX-License-Identifier: GPL-2.0 #include <linux/kernel.h> +#include <linux/ktime.h> #include <linux/preempt.h> #include <linux/printk.h> #include <linux/sched.h>
@@ -31,12 +32,101 @@ static struct {int num_stack_entries; } other_info = { .ptr = NULL }; +/* +* Information about reported data races; used to rate limit reporting. +*/ +struct report_time { +/* +* The last time the data race was reported. +*/ +ktime_t time; + +/* +* The frames of the 2 threads; if only 1 thread is known, one frame +* will be 0. +*/ +unsigned long frame1; +unsigned long frame2; +}; + +/* +* Since we also want to be able to debug allocators with KCSAN, to avoid +* deadlock, report_times cannot be dynamically resized with krealloc in +* rate_limit_report. +* +* Therefore, we use a fixed-size array, which at most will occupy a page. This +* still adequately rate limits reports, assuming that a) number of unique data +* races is not excessive, and b) occurrence of unique data races within the +* same time window is limited. +*/ +#define REPORT_TIMES_MAX (PAGE_SIZE / sizeof(struct report_time)) +#define REPORT_TIMES_SIZE \ + (CONFIG_KCSAN_REPORT_ONCE_IN_MS > REPORT_TIMES_MAX ? \ + REPORT_TIMES_MAX : \ + CONFIG_KCSAN_REPORT_ONCE_IN_MS) +static struct report_time report_times[REPORT_TIMES_SIZE ]; +/* * This spinlock protects reporting and other_info, since other_info is usually * required when reporting. */ static DEFINE_SPINLOCK (report_lock); +/* +* Checks if the data race identified by thread frames frame1 and frame2 has +* been reported since (now - KCSAN_REPORT_ONCE_IN_MS). +*/ +static bool rate_limit_report (unsigned long frame1,unsigned long frame2) +{ +struct report_time *use_entry = &report_times[0 ]; +ktime_t now; +ktime_t invalid_before; +int i; + +BUILD_BUG_ON (CONFIG_KCSAN_REPORT_ONCE_IN_MS !=0 &&REPORT_TIMES_SIZE ==0 ); + +if (CONFIG_KCSAN_REPORT_ONCE_IN_MS ==0 ) +return false; + + now =ktime_get (); + invalid_before =ktime_sub_ms (now,CONFIG_KCSAN_REPORT_ONCE_IN_MS ); + +/* Check if a matching data race report exists. */ +for (i =0 ; i <REPORT_TIMES_SIZE ; ++i) { +struct report_time *rt = &report_times[i]; + +/* +* Must always select an entry for use to store info as we +* cannot resize report_times; at the end of the scan, use_entry +* will be the oldest entry, which ideally also happened before +* KCSAN_REPORT_ONCE_IN_MS ago. +*/ +if (ktime_before (rt->time, use_entry->time)) + use_entry = rt; + +/* +* Initially, no need to check any further as this entry as well +* as following entries have never been used. +*/ +if (rt->time ==0 ) +break ; + +/* Check if entry expired. */ +if (ktime_before (rt->time, invalid_before)) +continue ;/* before KCSAN_REPORT_ONCE_IN_MS ago */ + +/* Reported recently, check if data race matches. */ +if ((rt->frame1 == frame1 && rt->frame2 == frame2) || + (rt->frame1 == frame2 && rt->frame2 == frame1)) +return true; + } + + use_entry->time = now; + use_entry->frame1 = frame1; + use_entry->frame2 = frame2; +return false; +} +/* * Special rules to skip reporting. */
@@ -132,7 +222,9 @@ static bool print_report(const volatile void *ptr, size_t size, int access_type,unsigned long stack_entries[NUM_STACK_ENTRIES ] = {0 };int num_stack_entries =stack_trace_save (stack_entries,NUM_STACK_ENTRIES ,1 );int skipnr =get_stack_skipnr (stack_entries, num_stack_entries); -int other_skipnr; +unsigned long this_frame = stack_entries[skipnr]; +unsigned long other_frame =0 ; +int other_skipnr =0 ;/* silence uninit warnings */ /* * Must check report filter rules before starting to print.
@@ -143,34 +235,34 @@ static bool print_report(const volatile void *ptr, size_t size, int access_type,if (type ==KCSAN_REPORT_RACE_SIGNAL ) { other_skipnr =get_stack_skipnr (other_info.stack_entries, other_info.num_stack_entries); + other_frame = other_info.stack_entries[other_skipnr];/* @value_change is only known for the other thread */ -if (skip_report (other_info.access_type, value_change, - other_info.stack_entries[other_skipnr])) +if (skip_report (other_info.access_type, value_change, other_frame))return false; } +if (rate_limit_report (this_frame, other_frame)) +return false; +/* Print report header. */ pr_err ("==================================================================\n" );switch (type) {case KCSAN_REPORT_RACE_SIGNAL : { -void *this_fn = (void *)stack_entries[skipnr]; -void *other_fn = (void *)other_info.stack_entries[other_skipnr];int cmp;/* * Order functions lexographically for consistent bug titles. * Do not print offset of functions to keep title short. */ - cmp =sym_strcmp (other_fn, this_fn); + cmp =sym_strcmp ((void *)other_frame, (void *)this_frame);pr_err ("BUG: KCSAN: data-race in %ps / %ps\n" , - cmp <0 ? other_fn : this_fn, - cmp <0 ? this_fn : other_fn); + (void *)(cmp <0 ? other_frame : this_frame), + (void *)(cmp <0 ? this_frame : other_frame)); }break ;case KCSAN_REPORT_RACE_UNKNOWN_ORIGIN : -pr_err ("BUG: KCSAN: data-race in %pS\n" , - (void *)stack_entries[skipnr]); +pr_err ("BUG: KCSAN: data-race in %pS\n" , (void *)this_frame);break ;default :
lib/Kconfig.kcsan +10 -0
@@ -81,6 +81,16 @@ config KCSAN_SKIP_WATCH_RANDOMIZE KCSAN_WATCH_SKIP. If false, the chosen value is always KCSAN_WATCH_SKIP. +config KCSAN_REPORT_ONCE_IN_MS + int "Duration in milliseconds, in which any given data race is only reported once" + default 3000 + help + Any given data race is only reported once in the defined time window. + Different data races may still generate reports within a duration + that is smaller than the duration defined here. This allows rate + limiting reporting to avoid flooding the console with reports. + Setting this to 0 disables rate limiting. + # Note that, while some of the below options could be turned into boot # parameters, to optimize for the common use-case, we avoid this because: (a) # it would impact performance (and we want to avoid static branch for all
Signature · 1 line
2.25.0.rc1.283.g88dfdc4193-goog
Marco Elver
maintainerRe: [PATCH -rcu 2/2] kcsan: Rate-limit reporting per data races
Quoted 88 lines · Marco Elver
Adds support for rate limiting reports. This uses a time based rate limit, that limits any given data race report to no more than one in a fixed time window (default is 3 sec). This should prevent the console from being spammed with data race reports, that would render the system unusable.
The implementation assumes that unique data races and the rate at which they occur is bounded, since we cannot store arbitrarily many past data race report information: we use a fixed-size array to store the required information. We cannot use kmalloc/krealloc and resize the list when needed, as reporting is triggered by the instrumentation calls; to permit using KCSAN on the allocators, we cannot (re-)allocate any memory during report generation (data races in the allocators lead to deadlock).
Reported-by Qian Cai <[email protected]>Suggested-by Paul E. McKenney <[email protected]>Signed-off-by Marco Elver <[email protected]>--- kernel/kcsan/report.c | 112 ++++++++++++++++++++++++++++++++++++++---- lib/Kconfig.kcsan | 10 ++++ 2 files changed, 112 insertions(+), 10 deletions(-)kernel/kcsan/report.c +43
-0@@ -1,6 +1,7 @@// SPDX-License-Identifier: GPL-2.0 #include <linux/kernel.h> +#include <linux/ktime.h> #include <linux/preempt.h> #include <linux/printk.h> #include <linux/sched.h> @@ -31,12 +32,101 @@ static struct {int num_stack_entries; } other_info = { .ptr = NULL }; +/* +* Information about reported data races; used to rate limit reporting. +*/ +struct report_time { +/* +* The last time the data race was reported. +*/ +ktime_t time; + +/* +* The frames of the 2 threads; if only 1 thread is known, one frame +* will be 0. +*/ +unsigned long frame1; +unsigned long frame2; +}; + +/* +* Since we also want to be able to debug allocators with KCSAN, to avoid +* deadlock, report_times cannot be dynamically resized with krealloc in +* rate_limit_report. +* +* Therefore, we use a fixed-size array, which at most will occupy a page. This +* still adequately rate limits reports, assuming that a) number of unique data +* races is not excessive, and b) occurrence of unique data races within the +* same time window is limited. +*/ +#define REPORT_TIMES_MAX (PAGE_SIZE / sizeof(struct report_time)) +#define REPORT_TIMES_SIZE \ + (CONFIG_KCSAN_REPORT_ONCE_IN_MS > REPORT_TIMES_MAX ? \ + REPORT_TIMES_MAX : \ + CONFIG_KCSAN_REPORT_ONCE_IN_MS) +static struct report_time report_times[REPORT_TIMES_SIZE ]; +/* * This spinlock protects reporting and other_info, since other_info is usually * required when reporting. */ static DEFINE_SPINLOCK (report_lock); +/* +* Checks if the data race identified by thread frames frame1 and frame2 has +* been reported since (now - KCSAN_REPORT_ONCE_IN_MS). +*/ +static bool rate_limit_report (unsigned long frame1,unsigned long frame2) +{ +struct report_time *use_entry = &report_times[0 ]; +ktime_t now;
kernel/kcsan/report.c static struct { · line 92
Quoted 10 lines
kernel/kcsan/report.c +10
-0+ktime_t invalid_before; +int i; + +BUILD_BUG_ON (CONFIG_KCSAN_REPORT_ONCE_IN_MS !=0 &&REPORT_TIMES_SIZE ==0 ); + +if (CONFIG_KCSAN_REPORT_ONCE_IN_MS ==0 ) +return false; + + now =ktime_get (); + invalid_before =ktime_sub_ms (now,CONFIG_KCSAN_REPORT_ONCE_IN_MS );
Been thinking about this a bit more, and wondering if we should just use jiffies here? Don't think we need the precision.
Thanks,
-- Marco
Quoted 118 lines
kernel/kcsan/report.c +48
-10+/* Check if a matching data race report exists. */ +for (i =0 ; i <REPORT_TIMES_SIZE ; ++i) { +struct report_time *rt = &report_times[i]; + +/* +* Must always select an entry for use to store info as we +* cannot resize report_times; at the end of the scan, use_entry +* will be the oldest entry, which ideally also happened before +* KCSAN_REPORT_ONCE_IN_MS ago. +*/ +if (ktime_before (rt->time, use_entry->time)) + use_entry = rt; + +/* +* Initially, no need to check any further as this entry as well +* as following entries have never been used. +*/ +if (rt->time ==0 ) +break ; + +/* Check if entry expired. */ +if (ktime_before (rt->time, invalid_before)) +continue ;/* before KCSAN_REPORT_ONCE_IN_MS ago */ + +/* Reported recently, check if data race matches. */ +if ((rt->frame1 == frame1 && rt->frame2 == frame2) || + (rt->frame1 == frame2 && rt->frame2 == frame1)) +return true; + } + + use_entry->time = now; + use_entry->frame1 = frame1; + use_entry->frame2 = frame2; +return false; +} +/* * Special rules to skip reporting. */ @@ -132,7 +222,9 @@ static bool print_report(const volatile void *ptr, size_t size, int access_type,unsigned long stack_entries[NUM_STACK_ENTRIES ] = {0 };int num_stack_entries =stack_trace_save (stack_entries,NUM_STACK_ENTRIES ,1 );int skipnr =get_stack_skipnr (stack_entries, num_stack_entries); -int other_skipnr; +unsigned long this_frame = stack_entries[skipnr]; +unsigned long other_frame =0 ; +int other_skipnr =0 ;/* silence uninit warnings */ /* * Must check report filter rules before starting to print. @@ -143,34 +235,34 @@ static bool print_report(const volatile void *ptr, size_t size, int access_type,if (type ==KCSAN_REPORT_RACE_SIGNAL ) { other_skipnr =get_stack_skipnr (other_info.stack_entries, other_info.num_stack_entries); + other_frame = other_info.stack_entries[other_skipnr];/* @value_change is only known for the other thread */ -if (skip_report (other_info.access_type, value_change, - other_info.stack_entries[other_skipnr])) +if (skip_report (other_info.access_type, value_change, other_frame))return false; } +if (rate_limit_report (this_frame, other_frame)) +return false; +/* Print report header. */ pr_err ("==================================================================\n" );switch (type) {case KCSAN_REPORT_RACE_SIGNAL : { -void *this_fn = (void *)stack_entries[skipnr]; -void *other_fn = (void *)other_info.stack_entries[other_skipnr];int cmp;/* * Order functions lexographically for consistent bug titles. * Do not print offset of functions to keep title short. */ - cmp =sym_strcmp (other_fn, this_fn); + cmp =sym_strcmp ((void *)other_frame, (void *)this_frame);pr_err ("BUG: KCSAN: data-race in %ps / %ps\n" , - cmp <0 ? other_fn : this_fn, - cmp <0 ? this_fn : other_fn); + (void *)(cmp <0 ? other_frame : this_frame), + (void *)(cmp <0 ? this_frame : other_frame)); }break ;case KCSAN_REPORT_RACE_UNKNOWN_ORIGIN : -pr_err ("BUG: KCSAN: data-race in %pS\n" , - (void *)stack_entries[skipnr]); +pr_err ("BUG: KCSAN: data-race in %pS\n" , (void *)this_frame);break ;default :lib/Kconfig.kcsan +10
-1@@ -81,6 +81,16 @@ config KCSAN_SKIP_WATCH_RANDOMIZE KCSAN_WATCH_SKIP. If false, the chosen value is always KCSAN_WATCH_SKIP. +config KCSAN_REPORT_ONCE_IN_MS + int "Duration in milliseconds, in which any given data race is only reported once" + default 3000 + help + Any given data race is only reported once in the defined time window. + Different data races may still generate reports within a duration + that is smaller than the duration defined here. This allows rate + limiting reporting to avoid flooding the console with reports. + Setting this to 0 disables rate limiting. + # Note that, while some of the below options could be turned into boot # parameters, to optimize for the common use-case, we avoid this because: (a) # it would impact performance (and we want to avoid static branch for all --2.25.0.rc1.283.g88dfdc4193-goog
Marco Elver
maintainerRe: [PATCH -rcu 2/2] kcsan: Rate-limit reporting per data races
Quoted 95 lines · Marco Elver
Quoted 93 lines · Marco Elver
Adds support for rate limiting reports. This uses a time based rate limit, that limits any given data race report to no more than one in a fixed time window (default is 3 sec). This should prevent the console from being spammed with data race reports, that would render the system unusable.
The implementation assumes that unique data races and the rate at which they occur is bounded, since we cannot store arbitrarily many past data race report information: we use a fixed-size array to store the required information. We cannot use kmalloc/krealloc and resize the list when needed, as reporting is triggered by the instrumentation calls; to permit using KCSAN on the allocators, we cannot (re-)allocate any memory during report generation (data races in the allocators lead to deadlock).
Reported-by Qian Cai <[email protected]>Suggested-by Paul E. McKenney <[email protected]>Signed-off-by Marco Elver <[email protected]>--- kernel/kcsan/report.c | 112 ++++++++++++++++++++++++++++++++++++++---- lib/Kconfig.kcsan | 10 ++++ 2 files changed, 112 insertions(+), 10 deletions(-)kernel/kcsan/report.c +48
-0@@ -1,6 +1,7 @@// SPDX-License-Identifier: GPL-2.0 #include <linux/kernel.h> +#include <linux/ktime.h> #include <linux/preempt.h> #include <linux/printk.h> #include <linux/sched.h> @@ -31,12 +32,101 @@ static struct {int num_stack_entries; } other_info = { .ptr = NULL }; +/* +* Information about reported data races; used to rate limit reporting. +*/ +struct report_time { +/* +* The last time the data race was reported. +*/ +ktime_t time; + +/* +* The frames of the 2 threads; if only 1 thread is known, one frame +* will be 0. +*/ +unsigned long frame1; +unsigned long frame2; +}; + +/* +* Since we also want to be able to debug allocators with KCSAN, to avoid +* deadlock, report_times cannot be dynamically resized with krealloc in +* rate_limit_report. +* +* Therefore, we use a fixed-size array, which at most will occupy a page. This +* still adequately rate limits reports, assuming that a) number of unique data +* races is not excessive, and b) occurrence of unique data races within the +* same time window is limited. +*/ +#define REPORT_TIMES_MAX (PAGE_SIZE / sizeof(struct report_time)) +#define REPORT_TIMES_SIZE \ + (CONFIG_KCSAN_REPORT_ONCE_IN_MS > REPORT_TIMES_MAX ? \ + REPORT_TIMES_MAX : \ + CONFIG_KCSAN_REPORT_ONCE_IN_MS) +static struct report_time report_times[REPORT_TIMES_SIZE ]; +/* * This spinlock protects reporting and other_info, since other_info is usually * required when reporting. */ static DEFINE_SPINLOCK (report_lock); +/* +* Checks if the data race identified by thread frames frame1 and frame2 has +* been reported since (now - KCSAN_REPORT_ONCE_IN_MS). +*/ +static bool rate_limit_report (unsigned long frame1,unsigned long frame2) +{ +struct report_time *use_entry = &report_times[0 ]; +ktime_t now; +ktime_t invalid_before; +int i; + +BUILD_BUG_ON (CONFIG_KCSAN_REPORT_ONCE_IN_MS !=0 &&REPORT_TIMES_SIZE ==0 ); +
Quoted 8 lines
kernel/kcsan/report.c static struct { · line 92
Quoted 5 lines
kernel/kcsan/report.c +5
-0+if (CONFIG_KCSAN_REPORT_ONCE_IN_MS ==0 ) +return false; + + now =ktime_get (); + invalid_before =ktime_sub_ms (now,CONFIG_KCSAN_REPORT_ONCE_IN_MS );Been thinking about this a bit more, and wondering if we should just use jiffies here? Don't think we need the precision.
Sent v2: http://lkml.kernel.org/r/[email protected]
I think it's also safer to use jiffies, as noted in the v2 patch.
Paul: sorry for sending v2, seeing you already had these in your tree. Hope this is ok.
Thanks,
-- Marco
Re: [PATCH -rcu 2/2] kcsan: Rate-limit reporting per data races
Quoted 105 lines · Marco Elver
Quoted 95 lines · Marco Elver
Quoted 93 lines · Marco Elver
Adds support for rate limiting reports. This uses a time based rate limit, that limits any given data race report to no more than one in a fixed time window (default is 3 sec). This should prevent the console from being spammed with data race reports, that would render the system unusable.
The implementation assumes that unique data races and the rate at which they occur is bounded, since we cannot store arbitrarily many past data race report information: we use a fixed-size array to store the required information. We cannot use kmalloc/krealloc and resize the list when needed, as reporting is triggered by the instrumentation calls; to permit using KCSAN on the allocators, we cannot (re-)allocate any memory during report generation (data races in the allocators lead to deadlock).
Reported-by Qian Cai <[email protected]>Suggested-by Paul E. McKenney <[email protected]>Signed-off-by Marco Elver <[email protected]>--- kernel/kcsan/report.c | 112 ++++++++++++++++++++++++++++++++++++++---- lib/Kconfig.kcsan | 10 ++++ 2 files changed, 112 insertions(+), 10 deletions(-)kernel/kcsan/report.c +48
-0@@ -1,6 +1,7 @@// SPDX-License-Identifier: GPL-2.0 #include <linux/kernel.h> +#include <linux/ktime.h> #include <linux/preempt.h> #include <linux/printk.h> #include <linux/sched.h> @@ -31,12 +32,101 @@ static struct {int num_stack_entries; } other_info = { .ptr = NULL }; +/* +* Information about reported data races; used to rate limit reporting. +*/ +struct report_time { +/* +* The last time the data race was reported. +*/ +ktime_t time; + +/* +* The frames of the 2 threads; if only 1 thread is known, one frame +* will be 0. +*/ +unsigned long frame1; +unsigned long frame2; +}; + +/* +* Since we also want to be able to debug allocators with KCSAN, to avoid +* deadlock, report_times cannot be dynamically resized with krealloc in +* rate_limit_report. +* +* Therefore, we use a fixed-size array, which at most will occupy a page. This +* still adequately rate limits reports, assuming that a) number of unique data +* races is not excessive, and b) occurrence of unique data races within the +* same time window is limited. +*/ +#define REPORT_TIMES_MAX (PAGE_SIZE / sizeof(struct report_time)) +#define REPORT_TIMES_SIZE \ + (CONFIG_KCSAN_REPORT_ONCE_IN_MS > REPORT_TIMES_MAX ? \ + REPORT_TIMES_MAX : \ + CONFIG_KCSAN_REPORT_ONCE_IN_MS) +static struct report_time report_times[REPORT_TIMES_SIZE ]; +/* * This spinlock protects reporting and other_info, since other_info is usually * required when reporting. */ static DEFINE_SPINLOCK (report_lock); +/* +* Checks if the data race identified by thread frames frame1 and frame2 has +* been reported since (now - KCSAN_REPORT_ONCE_IN_MS). +*/ +static bool rate_limit_report (unsigned long frame1,unsigned long frame2) +{ +struct report_time *use_entry = &report_times[0 ]; +ktime_t now; +ktime_t invalid_before; +int i; + +BUILD_BUG_ON (CONFIG_KCSAN_REPORT_ONCE_IN_MS !=0 &&REPORT_TIMES_SIZE ==0 ); +Quoted 8 lines
kernel/kcsan/report.c static struct { · line 92
Quoted 5 lines
kernel/kcsan/report.c +5
-0+if (CONFIG_KCSAN_REPORT_ONCE_IN_MS ==0 ) +return false; + + now =ktime_get (); + invalid_before =ktime_sub_ms (now,CONFIG_KCSAN_REPORT_ONCE_IN_MS );Been thinking about this a bit more, and wondering if we should just use jiffies here? Don't think we need the precision.
Quoted 5 lines
Sent v2: http://lkml.kernel.org/r/[email protected]
I think it's also safer to use jiffies, as noted in the v2 patch.Paul: sorry for sending v2, seeing you already had these in your tree. Hope this is ok.
Not a problem! Pulling in the replacements shortly.
Thanx, Paul
Paul E. McKenney
AppliedQuoted 7 lines · Marco Elver
Improvements to KCSAN data race reporting:
1. Show if access is marked (*_ONCE, atomic, etc.).
2. Rate limit reporting to avoid spamming console.Marco Elver (2):
kcsan: Show full access type in report
kcsan: Rate-limit reporting per data races
Queued and pushed, thank you! I edited the commit logs a bit, so could you please check to make sure that I didn't mess anything up?
At some point, boot-time-allocated per-CPU arrays might be needed to avoid contention on large systems, but one step at a time. ;-)
Thanx, Paul
Quoted 9 lines
kernel/kcsan/core.c | 15 +++-- kernel/kcsan/kcsan.h | 2 +- kernel/kcsan/report.c | 153 +++++++++++++++++++++++++++++++++++------- lib/Kconfig.kcsan | 10 +++ 4 files changed, 148 insertions(+), 32 deletions(-)Signature · 1 line
2.25.0.rc1.283.g88dfdc4193-goog
Marco Elver
maintainerQuoted 6 lines · Paul E. McKenney
Quoted 4 lines · Marco Elver
Improvements to KCSAN data race reporting:
1. Show if access is marked (*_ONCE, atomic, etc.).
2. Rate limit reporting to avoid spamming console.
Quoted 6 lines
Quoted 3 lines
Marco Elver (2):
kcsan: Show full access type in report
kcsan: Rate-limit reporting per data racesQueued and pushed, thank you! I edited the commit logs a bit, so could you please check to make sure that I didn't mess anything up?
Looks good to me, thank you.
Quoted 2 lines
At some point, boot-time-allocated per-CPU arrays might be needed to avoid contention on large systems, but one step at a time. ;-)
I certainly hope the rate of fixing/avoiding data races will not be eclipsed by the rate at which new ones are introduced. :-)
Thanks,
-- Marco
Quoted 16 lines
Thanx, Paul
Quoted 9 lines
kernel/kcsan/core.c | 15 +++-- kernel/kcsan/kcsan.h | 2 +- kernel/kcsan/report.c | 153 +++++++++++++++++++++++++++++++++++------- lib/Kconfig.kcsan | 10 +++ 4 files changed, 148 insertions(+), 32 deletions(-)--
2.25.0.rc1.283.g88dfdc4193-goog--
You received this message because you are subscribed to the Google Groups "kasan-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/kasan-dev/20200109162739.GS13449%40paulmck-ThinkPad-P72.
Quoted 14 lines · Marco Elver
Quoted 6 lines · Paul E. McKenney
Quoted 4 lines · Marco Elver
Improvements to KCSAN data race reporting:
1. Show if access is marked (*_ONCE, atomic, etc.).
2. Rate limit reporting to avoid spamming console.Quoted 6 lines
Quoted 3 lines
Marco Elver (2):
kcsan: Show full access type in report
kcsan: Rate-limit reporting per data racesQueued and pushed, thank you! I edited the commit logs a bit, so could you please check to make sure that I didn't mess anything up?
Quoted 7 lines
Looks good to me, thank you.
Quoted 2 lines
At some point, boot-time-allocated per-CPU arrays might be needed to avoid contention on large systems, but one step at a time. ;-)
I certainly hope the rate of fixing/avoiding data races will not be eclipsed by the rate at which new ones are introduced. :-)
Me too!
However, on a large system, duplicate reports might happen quite frequently, which might cause slowdowns given the single global array. Or maybe not -- I guess we will find out soon enough. ;-)
But I must confess that I am missing how concurrent access to the report_times[] array is handled. I would have expected that rate_limit_report() would choose a random starting entry and search circularly. And I would expect that the code at the end of that function would instead look something like this:
if (ktime_before(oldtime, invalid_before) &&
cmpxchg(&use_entry->time, oldtime, now) == oldtime) {
use_entry->frame1 = frame1;
use_entry->frame2 = frame2;
} else {
// Too bad, next duplicate report won't be suppressed.
}Where "oldtime" is captured from the entry during the scan, and from the first entry scanned. This cmpxchg() approach is of course vulnerable to the ->frame1 and ->frame2 assignments taking more than three seconds (by default), but if that becomes a problem, a WARN_ON() could be added:
if (ktime_before(oldtime, invalid_before) &&
cmpxchg(&use_entry->time, oldtime, now) == oldtime) {
use_entry->frame1 = frame1;
use_entry->frame2 = frame2;
WARN_ON_ONCE(use_entry->time != now);
} else {
// Too bad, next duplicate report won't be suppressed.
}So what am I missing here?
Thanx, Paul
Quoted 19 lines
Thanks,
-- MarcoQuoted 16 lines
Thanx, Paul
Quoted 9 lines
kernel/kcsan/core.c | 15 +++-- kernel/kcsan/kcsan.h | 2 +- kernel/kcsan/report.c | 153 +++++++++++++++++++++++++++++++++++------- lib/Kconfig.kcsan | 10 +++ 4 files changed, 148 insertions(+), 32 deletions(-)--
2.25.0.rc1.283.g88dfdc4193-goog--
You received this message because you are subscribed to the Google Groups "kasan-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/kasan-dev/20200109162739.GS13449%40paulmck-ThinkPad-P72.
Marco Elver
maintainerQuoted 58 lines · Paul E. McKenney
Quoted 14 lines · Marco Elver
Quoted 6 lines · Paul E. McKenney
Quoted 4 lines · Marco Elver
Improvements to KCSAN data race reporting:
1. Show if access is marked (*_ONCE, atomic, etc.).
2. Rate limit reporting to avoid spamming console.Quoted 6 lines
Quoted 3 lines
Marco Elver (2):
kcsan: Show full access type in report
kcsan: Rate-limit reporting per data racesQueued and pushed, thank you! I edited the commit logs a bit, so could you please check to make sure that I didn't mess anything up?
Quoted 7 lines
Looks good to me, thank you.
Quoted 2 lines
At some point, boot-time-allocated per-CPU arrays might be needed to avoid contention on large systems, but one step at a time. ;-)
I certainly hope the rate of fixing/avoiding data races will not be eclipsed by the rate at which new ones are introduced. :-)
Me too!
However, on a large system, duplicate reports might happen quite frequently, which might cause slowdowns given the single global array. Or maybe not -- I guess we will find out soon enough. ;-)
But I must confess that I am missing how concurrent access to the report_times[] array is handled. I would have expected that
rate_limit_report()would choose a random starting entry and search circularly. And I would expect that the code at the end of that function would instead look something like this:if (ktime_before(oldtime, invalid_before) && cmpxchg(&use_entry->time, oldtime, now) == oldtime) { use_entry->frame1 = frame1; use_entry->frame2 = frame2; } else { // Too bad, next duplicate report won't be suppressed. }Where "oldtime" is captured from the entry during the scan, and from the first entry scanned. This
cmpxchg()approach is of course vulnerable to the ->frame1 and ->frame2 assignments taking more than three seconds (by default), but if that becomes a problem, aWARN_ON()could be added:if (ktime_before(oldtime, invalid_before) && cmpxchg(&use_entry->time, oldtime, now) == oldtime) { use_entry->frame1 = frame1; use_entry->frame2 = frame2; WARN_ON_ONCE(use_entry->time != now); } else { // Too bad, next duplicate report won't be suppressed. }
Quoted 1 line
So what am I missing here?
Ah right, sorry, I should have clarified or commented in the code that all of this is happening under 'report_lock' (taken in prepare_report, held in print_report->rate_limit_report, released in release_report). That also means that any optimization here won't matter until report_lock is removed.
Thanks,
-- Marco
Quoted 21 lines
Thanx, Paul
Quoted 19 lines
Thanks,
-- MarcoQuoted 16 lines
Thanx, Paul
Quoted 9 lines
kernel/kcsan/core.c | 15 +++-- kernel/kcsan/kcsan.h | 2 +- kernel/kcsan/report.c | 153 +++++++++++++++++++++++++++++++++++------- lib/Kconfig.kcsan | 10 +++ 4 files changed, 148 insertions(+), 32 deletions(-)--
2.25.0.rc1.283.g88dfdc4193-goog--
You received this message because you are subscribed to the Google Groups "kasan-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/kasan-dev/20200109162739.GS13449%40paulmck-ThinkPad-P72.
Quoted 59 lines · Marco Elver
Quoted 58 lines · Paul E. McKenney
Quoted 14 lines · Marco Elver
Quoted 6 lines · Paul E. McKenney
Quoted 4 lines · Marco Elver
Improvements to KCSAN data race reporting:
1. Show if access is marked (*_ONCE, atomic, etc.).
2. Rate limit reporting to avoid spamming console.Quoted 6 lines
Quoted 3 lines
Marco Elver (2):
kcsan: Show full access type in report
kcsan: Rate-limit reporting per data racesQueued and pushed, thank you! I edited the commit logs a bit, so could you please check to make sure that I didn't mess anything up?
Quoted 7 lines
Looks good to me, thank you.
Quoted 2 lines
At some point, boot-time-allocated per-CPU arrays might be needed to avoid contention on large systems, but one step at a time. ;-)
I certainly hope the rate of fixing/avoiding data races will not be eclipsed by the rate at which new ones are introduced. :-)
Me too!
However, on a large system, duplicate reports might happen quite frequently, which might cause slowdowns given the single global array. Or maybe not -- I guess we will find out soon enough. ;-)
But I must confess that I am missing how concurrent access to the report_times[] array is handled. I would have expected that
rate_limit_report()would choose a random starting entry and search circularly. And I would expect that the code at the end of that function would instead look something like this:if (ktime_before(oldtime, invalid_before) && cmpxchg(&use_entry->time, oldtime, now) == oldtime) { use_entry->frame1 = frame1; use_entry->frame2 = frame2; } else { // Too bad, next duplicate report won't be suppressed. }Where "oldtime" is captured from the entry during the scan, and from the first entry scanned. This
cmpxchg()approach is of course vulnerable to the ->frame1 and ->frame2 assignments taking more than three seconds (by default), but if that becomes a problem, aWARN_ON()could be added:if (ktime_before(oldtime, invalid_before) && cmpxchg(&use_entry->time, oldtime, now) == oldtime) { use_entry->frame1 = frame1; use_entry->frame2 = frame2; WARN_ON_ONCE(use_entry->time != now); } else { // Too bad, next duplicate report won't be suppressed. }
Quoted 7 lines
Quoted 1 line
So what am I missing here?
Ah right, sorry, I should have clarified or commented in the code that all of this is happening under '
report_lock' (taken inprepare_report, held inprint_report->rate_limit_report, released inrelease_report). That also means that any optimization here won't matter untilreport_lockis removed.
Got it, thank you! And yes, lock contention on report_lock might be a problem on large systems. But let's see how it goes.
Thanx, Paul
Quoted 24 lines
Thanks,
-- MarcoQuoted 21 lines
Thanx, Paul
Quoted 19 lines
Thanks,
-- MarcoQuoted 16 lines
Thanx, Paul
Quoted 9 lines
kernel/kcsan/core.c | 15 +++-- kernel/kcsan/kcsan.h | 2 +- kernel/kcsan/report.c | 153 +++++++++++++++++++++++++++++++++++------- lib/Kconfig.kcsan | 10 +++ 4 files changed, 148 insertions(+), 32 deletions(-)--
2.25.0.rc1.283.g88dfdc4193-goog--
You received this message because you are subscribed to the Google Groups "kasan-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/kasan-dev/20200109162739.GS13449%40paulmck-ThinkPad-P72.