thread_annotations.h 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. //===-- thread_annotations.h ------------------------------------*- C++ -*-===//
  2. //
  3. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  4. // See https://llvm.org/LICENSE.txt for license information.
  5. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  6. //
  7. //===----------------------------------------------------------------------===//
  8. #ifndef SCUDO_THREAD_ANNOTATIONS_
  9. #define SCUDO_THREAD_ANNOTATIONS_
  10. // Enable thread safety attributes only with clang.
  11. // The attributes can be safely ignored when compiling with other compilers.
  12. #if defined(__clang__)
  13. #define THREAD_ANNOTATION_ATTRIBUTE_(x) __attribute__((x))
  14. #else
  15. #define THREAD_ANNOTATION_ATTRIBUTE_(x) // no-op
  16. #endif
  17. #define CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE_(capability(x))
  18. #define SCOPED_CAPABILITY THREAD_ANNOTATION_ATTRIBUTE_(scoped_lockable)
  19. #define GUARDED_BY(x) THREAD_ANNOTATION_ATTRIBUTE_(guarded_by(x))
  20. #define PT_GUARDED_BY(x) THREAD_ANNOTATION_ATTRIBUTE_(pt_guarded_by(x))
  21. #define ACQUIRED_BEFORE(...) \
  22. THREAD_ANNOTATION_ATTRIBUTE_(acquired_before(__VA_ARGS__))
  23. #define ACQUIRED_AFTER(...) \
  24. THREAD_ANNOTATION_ATTRIBUTE_(acquired_after(__VA_ARGS__))
  25. #define REQUIRES(...) \
  26. THREAD_ANNOTATION_ATTRIBUTE_(requires_capability(__VA_ARGS__))
  27. #define REQUIRES_SHARED(...) \
  28. THREAD_ANNOTATION_ATTRIBUTE_(requires_shared_capability(__VA_ARGS__))
  29. #define ACQUIRE(...) \
  30. THREAD_ANNOTATION_ATTRIBUTE_(acquire_capability(__VA_ARGS__))
  31. #define ACQUIRE_SHARED(...) \
  32. THREAD_ANNOTATION_ATTRIBUTE_(acquire_shared_capability(__VA_ARGS__))
  33. #define RELEASE(...) \
  34. THREAD_ANNOTATION_ATTRIBUTE_(release_capability(__VA_ARGS__))
  35. #define RELEASE_SHARED(...) \
  36. THREAD_ANNOTATION_ATTRIBUTE_(release_shared_capability(__VA_ARGS__))
  37. #define TRY_ACQUIRE(...) \
  38. THREAD_ANNOTATION_ATTRIBUTE_(try_acquire_capability(__VA_ARGS__))
  39. #define TRY_ACQUIRE_SHARED(...) \
  40. THREAD_ANNOTATION_ATTRIBUTE_(try_acquire_shared_capability(__VA_ARGS__))
  41. #define EXCLUDES(...) THREAD_ANNOTATION_ATTRIBUTE_(locks_excluded(__VA_ARGS__))
  42. #define ASSERT_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE_(assert_capability(x))
  43. #define ASSERT_SHARED_CAPABILITY(x) \
  44. THREAD_ANNOTATION_ATTRIBUTE_(assert_shared_capability(x))
  45. #define RETURN_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE_(lock_returned(x))
  46. #define NO_THREAD_SAFETY_ANALYSIS \
  47. THREAD_ANNOTATION_ATTRIBUTE_(no_thread_safety_analysis)
  48. #endif // SCUDO_THREAD_ANNOTATIONS_