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