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