1 /* 2 * Copyright (C) 2025 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #pragma once 18 19 // Enable thread safety attributes only with clang. 20 #if defined(__clang__) 21 #define THREAD_ANNOTATION_ATTRIBUTE__(x) __attribute__((x)) 22 #else 23 #define THREAD_ANNOTATION_ATTRIBUTE__(x) // no-op 24 #endif 25 26 #define CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE__(capability(x)) 27 28 #define SCOPED_CAPABILITY THREAD_ANNOTATION_ATTRIBUTE__(scoped_lockable) 29 30 #define GUARDED_BY(x) THREAD_ANNOTATION_ATTRIBUTE__(guarded_by(x)) 31 32 #define PT_GUARDED_BY(x) THREAD_ANNOTATION_ATTRIBUTE__(pt_guarded_by(x)) 33 34 #define ACQUIRED_BEFORE(...) \ 35 THREAD_ANNOTATION_ATTRIBUTE__(acquired_before(__VA_ARGS__)) 36 37 #define ACQUIRED_AFTER(...) \ 38 THREAD_ANNOTATION_ATTRIBUTE__(acquired_after(__VA_ARGS__)) 39 40 #define REQUIRES(...) \ 41 THREAD_ANNOTATION_ATTRIBUTE__(requires_capability(__VA_ARGS__)) 42 43 #define REQUIRES_SHARED(...) \ 44 THREAD_ANNOTATION_ATTRIBUTE__(requires_shared_capability(__VA_ARGS__)) 45 46 #define ACQUIRE(...) \ 47 THREAD_ANNOTATION_ATTRIBUTE__(acquire_capability(__VA_ARGS__)) 48 49 #define ACQUIRE_SHARED(...) \ 50 THREAD_ANNOTATION_ATTRIBUTE__(acquire_shared_capability(__VA_ARGS__)) 51 52 #define RELEASE(...) \ 53 THREAD_ANNOTATION_ATTRIBUTE__(release_capability(__VA_ARGS__)) 54 55 #define RELEASE_SHARED(...) \ 56 THREAD_ANNOTATION_ATTRIBUTE__(release_shared_capability(__VA_ARGS__)) 57 58 #define RELEASE_GENERIC(...) \ 59 THREAD_ANNOTATION_ATTRIBUTE__(release_generic_capability(__VA_ARGS__)) 60 61 #define TRY_ACQUIRE(...) \ 62 THREAD_ANNOTATION_ATTRIBUTE__(try_acquire_capability(__VA_ARGS__)) 63 64 #define TRY_ACQUIRE_SHARED(...) \ 65 THREAD_ANNOTATION_ATTRIBUTE__(try_acquire_shared_capability(__VA_ARGS__)) 66 67 #define EXCLUDES(...) THREAD_ANNOTATION_ATTRIBUTE__(locks_excluded(__VA_ARGS__)) 68 69 #define ASSERT_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE__(assert_capability(x)) 70 71 #define ASSERT_SHARED_CAPABILITY(x) \ 72 THREAD_ANNOTATION_ATTRIBUTE__(assert_shared_capability(x)) 73 74 #define RETURN_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE__(lock_returned(x)) 75 76 #define NO_THREAD_SAFETY_ANALYSIS \ 77 THREAD_ANNOTATION_ATTRIBUTE__(no_thread_safety_analysis)