Skip to content

Commit

Permalink
perf mutex: Add annotations for LOCKS_EXCLUDED and LOCKS_RETURNED
Browse files Browse the repository at this point in the history
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: Ian Rogers <irogers@google.com>
Link: https://lore.kernel.org/r/20250318043151.137973-2-irogers@google.com
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
  • Loading branch information
Ian Rogers authored and Namhyung Kim committed Mar 18, 2025
1 parent 658b34c commit c5ebf3a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions tools/perf/util/mutex.h
Original file line number Diff line number Diff line change
Expand Up @@ -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__)))

Expand All @@ -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(...)
Expand Down

0 comments on commit c5ebf3a

Please sign in to comment.