Skip to content

Commit 832c57a

Browse files
committed
thread-safety: modernize thread safety macros
Clang added new "capability"-based thread-safety attributes years ago, but the old ones remain supported for backwards-compatibility. However, while adding annotations for our reverse_lock, I noticed that there is a difference between the unlock_function and release_capability attributes. unlock_function actually maps to release_generic_capability, which does not work properly when implementing a scoped unlocker. To be consistent, the other capability-based attributes are updated here as well. To avoid having to update our macro usage throughout the codebase, I reused our existing ones. Additionally, SHARED_UNLOCK_FUNCTION is added here, as a subsequent PR will introduce annotations for shared_mutex and shared_lock.
1 parent 66c968b commit 832c57a

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

src/threadsafety.h

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,24 @@
1515
// See https://clang.llvm.org/docs/ThreadSafetyAnalysis.html
1616
// for documentation. The clang compiler can do advanced static analysis
1717
// of locking when given the -Wthread-safety option.
18-
#define LOCKABLE __attribute__((lockable))
18+
#define LOCKABLE __attribute__((capability("")))
1919
#define SCOPED_LOCKABLE __attribute__((scoped_lockable))
2020
#define GUARDED_BY(x) __attribute__((guarded_by(x)))
2121
#define PT_GUARDED_BY(x) __attribute__((pt_guarded_by(x)))
2222
#define ACQUIRED_AFTER(...) __attribute__((acquired_after(__VA_ARGS__)))
2323
#define ACQUIRED_BEFORE(...) __attribute__((acquired_before(__VA_ARGS__)))
24-
#define EXCLUSIVE_LOCK_FUNCTION(...) __attribute__((exclusive_lock_function(__VA_ARGS__)))
25-
#define SHARED_LOCK_FUNCTION(...) __attribute__((shared_lock_function(__VA_ARGS__)))
26-
#define EXCLUSIVE_TRYLOCK_FUNCTION(...) __attribute__((exclusive_trylock_function(__VA_ARGS__)))
27-
#define SHARED_TRYLOCK_FUNCTION(...) __attribute__((shared_trylock_function(__VA_ARGS__)))
28-
#define UNLOCK_FUNCTION(...) __attribute__((unlock_function(__VA_ARGS__)))
24+
#define EXCLUSIVE_LOCK_FUNCTION(...) __attribute__((acquire_capability(__VA_ARGS__)))
25+
#define SHARED_LOCK_FUNCTION(...) __attribute__((acquire_shared_capability(__VA_ARGS__)))
26+
#define EXCLUSIVE_TRYLOCK_FUNCTION(...) __attribute__((try_acquire_capability(__VA_ARGS__)))
27+
#define SHARED_TRYLOCK_FUNCTION(...) __attribute__((try_acquire_shared_capability(__VA_ARGS__)))
28+
#define UNLOCK_FUNCTION(...) __attribute__((release_capability(__VA_ARGS__)))
29+
#define SHARED_UNLOCK_FUNCTION(...) __attribute__((release_shared_capability(__VA_ARGS__)))
2930
#define LOCK_RETURNED(x) __attribute__((lock_returned(x)))
3031
#define LOCKS_EXCLUDED(...) __attribute__((locks_excluded(__VA_ARGS__)))
31-
#define EXCLUSIVE_LOCKS_REQUIRED(...) __attribute__((exclusive_locks_required(__VA_ARGS__)))
32-
#define SHARED_LOCKS_REQUIRED(...) __attribute__((shared_locks_required(__VA_ARGS__)))
32+
#define EXCLUSIVE_LOCKS_REQUIRED(...) __attribute__((requires_capability(__VA_ARGS__)))
33+
#define SHARED_LOCKS_REQUIRED(...) __attribute__((requires_shared_capability(__VA_ARGS__)))
3334
#define NO_THREAD_SAFETY_ANALYSIS __attribute__((no_thread_safety_analysis))
34-
#define ASSERT_EXCLUSIVE_LOCK(...) __attribute__((assert_exclusive_lock(__VA_ARGS__)))
35+
#define ASSERT_EXCLUSIVE_LOCK(...) __attribute__((assert_capability(__VA_ARGS__)))
3536
#else
3637
#define LOCKABLE
3738
#define SCOPED_LOCKABLE
@@ -44,6 +45,7 @@
4445
#define EXCLUSIVE_TRYLOCK_FUNCTION(...)
4546
#define SHARED_TRYLOCK_FUNCTION(...)
4647
#define UNLOCK_FUNCTION(...)
48+
#define SHARED_UNLOCK_FUNCTION(...)
4749
#define LOCK_RETURNED(x)
4850
#define LOCKS_EXCLUDED(...)
4951
#define EXCLUSIVE_LOCKS_REQUIRED(...)

0 commit comments

Comments
 (0)