File: thread_safety_annotations.hpp

package info (click to toggle)
securefs 0.13.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 2,324 kB
  • sloc: cpp: 12,816; python: 764; sh: 13; makefile: 7
file content (58 lines) | stat: -rw-r--r-- 3,011 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
#pragma once
// Enable thread safety attributes only with clang.
// The attributes can be safely erased when compiling with other compilers.
#if defined(__clang__) && (!defined(SWIG))
#define THREAD_ANNOTATION_ATTRIBUTE__(x) __attribute__((x))
#else
#define THREAD_ANNOTATION_ATTRIBUTE__(x)    // no-op
#endif

#define THREAD_ANNOTATION_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE__(capability(x))

#define THREAD_ANNOTATION_SCOPED_CAPABILITY THREAD_ANNOTATION_ATTRIBUTE__(scoped_lockable)

#define THREAD_ANNOTATION_GUARDED_BY(x) THREAD_ANNOTATION_ATTRIBUTE__(guarded_by(x))

#define THREAD_ANNOTATION_PT_GUARDED_BY(x) THREAD_ANNOTATION_ATTRIBUTE__(pt_guarded_by(x))

#define THREAD_ANNOTATION_ACQUIRED_BEFORE(...)                                                     \
    THREAD_ANNOTATION_ATTRIBUTE__(acquired_before(__VA_ARGS__))

#define THREAD_ANNOTATION_ACQUIRED_AFTER(...)                                                      \
    THREAD_ANNOTATION_ATTRIBUTE__(acquired_after(__VA_ARGS__))

#define THREAD_ANNOTATION_REQUIRES(...)                                                            \
    THREAD_ANNOTATION_ATTRIBUTE__(requires_capability(__VA_ARGS__))

#define THREAD_ANNOTATION_REQUIRES_SHARED(...)                                                     \
    THREAD_ANNOTATION_ATTRIBUTE__(requires_shared_capability(__VA_ARGS__))

#define THREAD_ANNOTATION_ACQUIRE(...)                                                             \
    THREAD_ANNOTATION_ATTRIBUTE__(acquire_capability(__VA_ARGS__))

#define THREAD_ANNOTATION_ACQUIRE_SHARED(...)                                                      \
    THREAD_ANNOTATION_ATTRIBUTE__(acquire_shared_capability(__VA_ARGS__))

#define THREAD_ANNOTATION_RELEASE(...)                                                             \
    THREAD_ANNOTATION_ATTRIBUTE__(release_capability(__VA_ARGS__))

#define THREAD_ANNOTATION_RELEASE_SHARED(...)                                                      \
    THREAD_ANNOTATION_ATTRIBUTE__(release_shared_capability(__VA_ARGS__))

#define THREAD_ANNOTATION_TRY_ACQUIRE(...)                                                         \
    THREAD_ANNOTATION_ATTRIBUTE__(try_acquire_capability(__VA_ARGS__))

#define THREAD_ANNOTATION_TRY_ACQUIRE_SHARED(...)                                                  \
    THREAD_ANNOTATION_ATTRIBUTE__(try_acquire_shared_capability(__VA_ARGS__))

#define THREAD_ANNOTATION_EXCLUDES(...) THREAD_ANNOTATION_ATTRIBUTE__(locks_excluded(__VA_ARGS__))

#define THREAD_ANNOTATION_ASSERT_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE__(assert_capability(x))

#define THREAD_ANNOTATION_ASSERT_SHARED_CAPABILITY(x)                                              \
    THREAD_ANNOTATION_ATTRIBUTE__(assert_shared_capability(x))

#define THREAD_ANNOTATION_RETURN_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE__(lock_returned(x))

#define THREAD_ANNOTATION_NO_THREAD_SAFETY_ANALYSIS                                                \
    THREAD_ANNOTATION_ATTRIBUTE__(no_thread_safety_analysis)