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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
// RUN: %clang_analyze_cc1 \
// RUN: -analyzer-checker=unix.BlockInCriticalSection \
// RUN: -std=c++11 \
// RUN: -analyzer-output text \
// RUN: -verify %s
void sleep(int x) {}
namespace std {
struct mutex {
void lock() {}
void unlock() {}
};
template<typename T>
struct lock_guard {
lock_guard<T>(std::mutex) {}
~lock_guard<T>() {}
};
template<typename T>
struct unique_lock {
unique_lock<T>(std::mutex) {}
~unique_lock<T>() {}
};
template<typename T>
struct not_real_lock {
not_real_lock<T>(std::mutex) {}
};
} // namespace std
struct FILE;
int getc(FILE *stream);
char* fgets(char *str, FILE *stream);
using ssize_t = long long;
using size_t = unsigned long long;
ssize_t read(int fd, void *buf, size_t count);
ssize_t recv(int sockfd, void *buf, size_t len, int flags);
struct pthread_mutex_t;
int pthread_mutex_lock(pthread_mutex_t *mutex);
int pthread_mutex_trylock(pthread_mutex_t *mutex);
int pthread_mutex_unlock(pthread_mutex_t *mutex);
struct mtx_t;
int mtx_lock(mtx_t *mutex);
int mtx_timedlock(mtx_t *mutex);
int mtx_trylock(mtx_t *mutex);
int mtx_unlock(mtx_t *mutex);
// global params for dummy function calls
FILE *stream;
char *str;
int fd;
void *buf;
size_t count;
int sockfd;
size_t len;
int flags;
void testBlockInCriticalSectionWithStdMutex() {
std::mutex m;
m.lock(); // expected-note 5{{Entering critical section here}}
sleep(3); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
getc(stream); // expected-warning {{Call to blocking function 'getc' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'getc' inside of critical section}}
fgets(str, stream); // expected-warning {{Call to blocking function 'fgets' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'fgets' inside of critical section}}
read(fd, buf, count); // expected-warning {{Call to blocking function 'read' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'read' inside of critical section}}
recv(sockfd, buf, count, flags); // expected-warning {{Call to blocking function 'recv' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'recv' inside of critical section}}
m.unlock();
}
void testBlockInCriticalSectionWithPthreadMutex(pthread_mutex_t *mutex) {
pthread_mutex_lock(mutex); // expected-note 5{{Entering critical section here}}
sleep(3); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
getc(stream); // expected-warning {{Call to blocking function 'getc' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'getc' inside of critical section}}
fgets(str, stream); // expected-warning {{Call to blocking function 'fgets' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'fgets' inside of critical section}}
read(fd, buf, count); // expected-warning {{Call to blocking function 'read' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'read' inside of critical section}}
recv(sockfd, buf, count, flags); // expected-warning {{Call to blocking function 'recv' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'recv' inside of critical section}}
pthread_mutex_unlock(mutex);
pthread_mutex_trylock(mutex); // expected-note 5{{Entering critical section here}}
sleep(3); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
getc(stream); // expected-warning {{Call to blocking function 'getc' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'getc' inside of critical section}}
fgets(str, stream); // expected-warning {{Call to blocking function 'fgets' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'fgets' inside of critical section}}
read(fd, buf, count); // expected-warning {{Call to blocking function 'read' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'read' inside of critical section}}
recv(sockfd, buf, count, flags); // expected-warning {{Call to blocking function 'recv' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'recv' inside of critical section}}
pthread_mutex_unlock(mutex);
}
void testBlockInCriticalSectionC11Locks(mtx_t *mutex) {
mtx_lock(mutex); // expected-note 5{{Entering critical section here}}
sleep(3); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
getc(stream); // expected-warning {{Call to blocking function 'getc' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'getc' inside of critical section}}
fgets(str, stream); // expected-warning {{Call to blocking function 'fgets' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'fgets' inside of critical section}}
read(fd, buf, count); // expected-warning {{Call to blocking function 'read' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'read' inside of critical section}}
recv(sockfd, buf, count, flags); // expected-warning {{Call to blocking function 'recv' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'recv' inside of critical section}}
mtx_unlock(mutex);
mtx_timedlock(mutex); // expected-note 5{{Entering critical section here}}
sleep(3); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
getc(stream); // expected-warning {{Call to blocking function 'getc' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'getc' inside of critical section}}
fgets(str, stream); // expected-warning {{Call to blocking function 'fgets' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'fgets' inside of critical section}}
read(fd, buf, count); // expected-warning {{Call to blocking function 'read' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'read' inside of critical section}}
recv(sockfd, buf, count, flags); // expected-warning {{Call to blocking function 'recv' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'recv' inside of critical section}}
mtx_unlock(mutex);
mtx_trylock(mutex); // expected-note 5{{Entering critical section here}}
sleep(3); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
getc(stream); // expected-warning {{Call to blocking function 'getc' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'getc' inside of critical section}}
fgets(str, stream); // expected-warning {{Call to blocking function 'fgets' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'fgets' inside of critical section}}
read(fd, buf, count); // expected-warning {{Call to blocking function 'read' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'read' inside of critical section}}
recv(sockfd, buf, count, flags); // expected-warning {{Call to blocking function 'recv' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'recv' inside of critical section}}
mtx_unlock(mutex);
}
void testMultipleBlockingCalls() {
std::mutex m;
m.lock(); // expected-note 1{{Entering critical section here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
m.unlock();
sleep(2); // no-warning
}
void testMultipleMutexesMultipleBlockingCalls() {
std::mutex m, n, k;
m.lock(); // expected-note 2{{Entering critical section here}}
n.lock(); // expected-note 2{{Entering critical section here}}
k.lock(); // expected-note 1{{Entering critical section here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
k.unlock();
sleep(2); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
}
void testRecursiveAcquisition() {
std::mutex m;
m.lock(); // expected-note {{Entering critical section for the 1st time here}}
m.lock(); // expected-note {{Entering critical section for the 2nd time here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
m.unlock();
m.unlock();
}
void testRecursiveAcquisitionWithMultipleBlockingCalls() {
std::mutex m;
m.lock(); // expected-note 1{{Entering critical section for the 1st time here}}
// expected-note@-1 {{Entering critical section here}}
m.lock(); // expected-note 1{{Entering critical section for the 2nd time here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
m.unlock();
// this next 'sleep' call is only in the critical section of the first lock
sleep(2); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
m.unlock();
}
void testRecursiveAcquisitionWithMultipleMutexes() {
std::mutex m, n;
m.lock(); // expected-note 1{{Entering critical section here}}
n.lock(); // expected-note 2{{Entering critical section here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
m.unlock();
// this next 'sleep' call is only in the critical section of mutex 'n'
sleep(2); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
n.unlock();
}
void testNestedMutexes() {
std::mutex m, n, k;
m.lock(); // expected-note 3{{Entering critical section here}}
n.lock(); // expected-note 2{{Entering critical section here}}
k.lock(); // expected-note 1{{Entering critical section here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
k.unlock();
sleep(2); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
n.unlock();
sleep(3); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
m.unlock();
sleep(4); // no-warning
}
void testNonOverlappingMutexes() {
std::mutex m;
m.lock(); // There should be no warning here
m.unlock();
m.lock(); // expected-note {{Entering critical section here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
m.unlock();
}
void testMixedMutexLocksWithIntermittentUnlock() {
std::mutex m, n, k;
m.lock(); // expected-note {{Entering critical section here}}
n.lock(); // the problem is not is this lock's critical section
n.unlock();
k.lock(); // same as for n.lock()
k.unlock();
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
m.unlock();
}
void f() {
sleep(1000); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
}
void testBlockInCriticalSectionInterProcedural() {
std::mutex m;
m.lock(); // expected-note {{Entering critical section here}}
f(); // expected-note {{Calling 'f'}}
m.unlock();
}
void unknown_function_that_may_lock(std::mutex &);
void testBlockInCriticalSectionUnexpectedUnlock() {
std::mutex m;
unknown_function_that_may_lock(m);
m.unlock();
sleep(1); // no-warning
m.lock(); // expected-note {{Entering critical section here}}
sleep(2); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
}
void testBlockInCriticalSectionLockGuard() {
std::mutex g_mutex;
std::not_real_lock<std::mutex> not_real_lock(g_mutex);
sleep(1); // no-warning
std::lock_guard<std::mutex> lock(g_mutex); // expected-note {{Entering critical section here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
}
void testBlockInCriticalSectionLockGuardNested() {
testBlockInCriticalSectionLockGuard(); // expected-note {{Calling 'testBlockInCriticalSectionLockGuard'}}
sleep(1); // no-warning
}
void testBlockInCriticalSectionUniqueLock() {
std::mutex g_mutex;
std::not_real_lock<std::mutex> not_real_lock(g_mutex);
sleep(1); // no-warning
std::unique_lock<std::mutex> lock(g_mutex); // expected-note {{Entering critical section here}}
sleep(1); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
}
void testBlockInCriticalSectionUniqueLockNested() {
testBlockInCriticalSectionUniqueLock(); // expected-note {{Calling 'testBlockInCriticalSectionUniqueLock'}}
sleep(1); // no-warning
}
void testTrylockCurrentlyFalsePositive(pthread_mutex_t *m) {
// expected-note@+4 {{Assuming the condition is true}}
// expected-note@+3 {{Taking true branch}}
// expected-note@+2 {{Assuming the condition is false}}
// expected-note@+1 {{Taking false branch}}
if (pthread_mutex_trylock(m) == 0) { // expected-note 2 {{Entering critical section here}}
// FIXME: we are entering the critical section only in the true branch
sleep(10); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
pthread_mutex_unlock(m);
} else {
sleep(10); // expected-warning {{Call to blocking function 'sleep' inside of critical section}}
// expected-note@-1 {{Call to blocking function 'sleep' inside of critical section}}
// FIXME: this is a false positive, the lock was not acquired
}
}
|
