SkThreadAnnotations.h 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. /*
  2. * Copyright 2019 Google LLC
  3. *
  4. * Use of this source code is governed by a BSD-style license that can be
  5. * found in the LICENSE file.
  6. */
  7. #ifndef SkThreadAnnotations_DEFINED
  8. #define SkThreadAnnotations_DEFINED
  9. // The bulk of this code is cribbed from:
  10. // http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
  11. #if defined(__clang__) && (!defined(SWIG))
  12. #define SK_THREAD_ANNOTATION_ATTRIBUTE(x) __attribute__((x))
  13. #else
  14. #define SK_THREAD_ANNOTATION_ATTRIBUTE(x) // no-op
  15. #endif
  16. #define SK_CAPABILITY(x) \
  17. SK_THREAD_ANNOTATION_ATTRIBUTE(capability(x))
  18. #define SK_SCOPED_CAPABILITY \
  19. SK_THREAD_ANNOTATION_ATTRIBUTE(scoped_lockable)
  20. #define SK_GUARDED_BY(x) \
  21. SK_THREAD_ANNOTATION_ATTRIBUTE(guarded_by(x))
  22. #define SK_PT_GUARDED_BY(x) \
  23. SK_THREAD_ANNOTATION_ATTRIBUTE(pt_guarded_by(x))
  24. #define SK_ACQUIRED_BEFORE(...) \
  25. SK_THREAD_ANNOTATION_ATTRIBUTE(acquired_before(__VA_ARGS__))
  26. #define SK_ACQUIRED_AFTER(...) \
  27. SK_THREAD_ANNOTATION_ATTRIBUTE(acquired_after(__VA_ARGS__))
  28. #define SK_REQUIRES(...) \
  29. SK_THREAD_ANNOTATION_ATTRIBUTE(requires_capability(__VA_ARGS__))
  30. #define SK_REQUIRES_SHARED(...) \
  31. SK_THREAD_ANNOTATION_ATTRIBUTE(requires_shared_capability(__VA_ARGS__))
  32. #define SK_ACQUIRE(...) \
  33. SK_THREAD_ANNOTATION_ATTRIBUTE(acquire_capability(__VA_ARGS__))
  34. #define SK_ACQUIRE_SHARED(...) \
  35. SK_THREAD_ANNOTATION_ATTRIBUTE(acquire_shared_capability(__VA_ARGS__))
  36. // Would be SK_RELEASE, but that is already in use by SkPostConfig.
  37. #define SK_RELEASE_CAPABILITY(...) \
  38. SK_THREAD_ANNOTATION_ATTRIBUTE(release_capability(__VA_ARGS__))
  39. // For symmetry with SK_RELEASE_CAPABILITY.
  40. #define SK_RELEASE_SHARED_CAPABILITY(...) \
  41. SK_THREAD_ANNOTATION_ATTRIBUTE(release_shared_capability(__VA_ARGS__))
  42. #define SK_TRY_ACQUIRE(...) \
  43. SK_THREAD_ANNOTATION_ATTRIBUTE(try_acquire_capability(__VA_ARGS__))
  44. #define SK_TRY_ACQUIRE_SHARED(...) \
  45. SK_THREAD_ANNOTATION_ATTRIBUTE(try_acquire_shared_capability(__VA_ARGS__))
  46. #define SK_EXCLUDES(...) \
  47. SK_THREAD_ANNOTATION_ATTRIBUTE(locks_excluded(__VA_ARGS__))
  48. #define SK_ASSERT_CAPABILITY(x) \
  49. SK_THREAD_ANNOTATION_ATTRIBUTE(assert_capability(x))
  50. #define SK_ASSERT_SHARED_CAPABILITY(x) \
  51. SK_THREAD_ANNOTATION_ATTRIBUTE(assert_shared_capability(x))
  52. #define SK_RETURN_CAPABILITY(x) \
  53. SK_THREAD_ANNOTATION_ATTRIBUTE(lock_returned(x))
  54. #define SK_NO_THREAD_SAFETY_ANALYSIS \
  55. SK_THREAD_ANNOTATION_ATTRIBUTE(no_thread_safety_analysis)
  56. #endif // SkThreadAnnotations_DEFINED