Commit c5ebf3a2 authored by Ian Rogers's avatar Ian Rogers Committed by Namhyung Kim
Browse files

perf mutex: Add annotations for LOCKS_EXCLUDED and LOCKS_RETURNED 



Used to annotate when locks shouldn't be held for a function or if a
function returns a lock that's used by later mutex lock unlock
operations.

Signed-off-by: default avatarIan Rogers <irogers@google.com>
Link: https://lore.kernel.org/r/20250318043151.137973-2-irogers@google.com


Signed-off-by: default avatarNamhyung Kim <namhyung@kernel.org>
parent 658b34cc

tools/perf/util/mutex.h

+8 −0
Original line number Diff line number Diff line
@@ -33,6 +33,12 @@ 
/* Documents if a type is a lockable type. */

#define LOCKABLE __attribute__((lockable))



/* Documents a function that expects a lock not to be held prior to entry. */

#define LOCKS_EXCLUDED(...) __attribute__((locks_excluded(__VA_ARGS__)))



/* Documents a function that returns a lock. */

#define LOCK_RETURNED(x) __attribute__((lock_returned(x)))



/* Documents functions that acquire a lock in the body of a function, and do not release it. */

#define EXCLUSIVE_LOCK_FUNCTION(...)  __attribute__((exclusive_lock_function(__VA_ARGS__)))
@@ -57,6 +63,8 @@ 
#define GUARDED_BY(x)

#define PT_GUARDED_BY(x)

#define LOCKABLE

#define LOCKS_EXCLUDED(...)

#define LOCK_RETURNED(x)

#define EXCLUSIVE_LOCK_FUNCTION(...)

#define UNLOCK_FUNCTION(...)

#define EXCLUSIVE_TRYLOCK_FUNCTION(...)