Commit 7ad900d3 authored by Paul E. McKenney's avatar Paul E. McKenney Committed by Ingo Molnar
Browse files

kcsan: Add docbook header for data_race()



Signed-off-by: default avatarPaul E. McKenney <paulmck@kernel.org>
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
Cc: Marco Elver <elver@google.com>
Cc: Dmitry Vyukov <dvyukov@google.com>
parent 76d6f06c
Loading
Loading
Loading
Loading
+8 −6
Original line number Diff line number Diff line
@@ -315,13 +315,15 @@ unsigned long read_word_at_a_time(const void *addr)

#include <linux/kcsan.h>

/*
 * data_race(): macro to document that accesses in an expression may conflict with
 * other concurrent accesses resulting in data races, but the resulting
 * behaviour is deemed safe regardless.
/**
 * data_race - mark an expression as containing intentional data races
 *
 * This data_race() macro is useful for situations in which data races
 * should be forgiven.  One example is diagnostic code that accesses
 * shared variables but is not a part of the core synchronization design.
 *
 * This macro *does not* affect normal code generation, but is a hint to tooling
 * that data races here should be ignored.
 * This macro *does not* affect normal code generation, but is a hint
 * to tooling that data races here are to be ignored.
 */
#define data_race(expr)                                                        \
	({                                                                     \