Replace enum gfc_try with bool type.
[official-gcc.git] / gcc / tsan.c
blobc02e100cca0695bfc8839e3927d39f7e4f29de87
1 /* GCC instrumentation plugin for ThreadSanitizer.
2 Copyright (C) 2011-2013 Free Software Foundation, Inc.
3 Contributed by Dmitry Vyukov <dvyukov@google.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "tree.h"
26 #include "intl.h"
27 #include "tm.h"
28 #include "basic-block.h"
29 #include "gimple.h"
30 #include "function.h"
31 #include "tree-flow.h"
32 #include "tree-pass.h"
33 #include "tree-iterator.h"
34 #include "langhooks.h"
35 #include "output.h"
36 #include "options.h"
37 #include "target.h"
38 #include "cgraph.h"
39 #include "diagnostic.h"
40 #include "tree-ssa-propagate.h"
41 #include "tsan.h"
42 #include "asan.h"
44 /* Number of instrumented memory accesses in the current function. */
46 /* Builds the following decl
47 void __tsan_read/writeX (void *addr); */
49 static tree
50 get_memory_access_decl (bool is_write, unsigned size)
52 enum built_in_function fcode;
54 if (size <= 1)
55 fcode = is_write ? BUILT_IN_TSAN_WRITE1
56 : BUILT_IN_TSAN_READ1;
57 else if (size <= 3)
58 fcode = is_write ? BUILT_IN_TSAN_WRITE2
59 : BUILT_IN_TSAN_READ2;
60 else if (size <= 7)
61 fcode = is_write ? BUILT_IN_TSAN_WRITE4
62 : BUILT_IN_TSAN_READ4;
63 else if (size <= 15)
64 fcode = is_write ? BUILT_IN_TSAN_WRITE8
65 : BUILT_IN_TSAN_READ8;
66 else
67 fcode = is_write ? BUILT_IN_TSAN_WRITE16
68 : BUILT_IN_TSAN_READ16;
70 return builtin_decl_implicit (fcode);
73 /* Check as to whether EXPR refers to a store to vptr. */
75 static tree
76 is_vptr_store (gimple stmt, tree expr, bool is_write)
78 if (is_write == true
79 && gimple_assign_single_p (stmt)
80 && TREE_CODE (expr) == COMPONENT_REF)
82 tree field = TREE_OPERAND (expr, 1);
83 if (TREE_CODE (field) == FIELD_DECL
84 && DECL_VIRTUAL_P (field))
85 return gimple_assign_rhs1 (stmt);
87 return NULL;
90 /* Instruments EXPR if needed. If any instrumentation is inserted,
91 return true. */
93 static bool
94 instrument_expr (gimple_stmt_iterator gsi, tree expr, bool is_write)
96 tree base, rhs, expr_ptr, builtin_decl;
97 basic_block bb;
98 HOST_WIDE_INT size;
99 gimple stmt, g;
100 gimple_seq seq;
101 location_t loc;
103 size = int_size_in_bytes (TREE_TYPE (expr));
104 if (size == -1)
105 return false;
107 /* For now just avoid instrumenting bit field acceses.
108 TODO: handle bit-fields as if touching the whole field. */
109 HOST_WIDE_INT bitsize, bitpos;
110 tree offset;
111 enum machine_mode mode;
112 int volatilep = 0, unsignedp = 0;
113 base = get_inner_reference (expr, &bitsize, &bitpos, &offset,
114 &mode, &unsignedp, &volatilep, false);
116 /* No need to instrument accesses to decls that don't escape,
117 they can't escape to other threads then. */
118 if (DECL_P (base))
120 struct pt_solution pt;
121 memset (&pt, 0, sizeof (pt));
122 pt.escaped = 1;
123 pt.ipa_escaped = flag_ipa_pta != 0;
124 pt.nonlocal = 1;
125 if (!pt_solution_includes (&pt, base))
126 return false;
127 if (!is_global_var (base) && !may_be_aliased (base))
128 return false;
131 if (TREE_READONLY (base))
132 return false;
134 if (bitpos % (size * BITS_PER_UNIT)
135 || bitsize != size * BITS_PER_UNIT)
136 return false;
138 stmt = gsi_stmt (gsi);
139 loc = gimple_location (stmt);
140 rhs = is_vptr_store (stmt, expr, is_write);
141 gcc_checking_assert (rhs != NULL || is_gimple_addressable (expr));
142 expr_ptr = build_fold_addr_expr (unshare_expr (expr));
143 seq = NULL;
144 if (!is_gimple_val (expr_ptr))
146 g = gimple_build_assign (make_ssa_name (TREE_TYPE (expr_ptr), NULL),
147 expr_ptr);
148 expr_ptr = gimple_assign_lhs (g);
149 gimple_set_location (g, loc);
150 gimple_seq_add_stmt_without_update (&seq, g);
152 if (rhs == NULL)
153 g = gimple_build_call (get_memory_access_decl (is_write, size),
154 1, expr_ptr);
155 else
157 builtin_decl = builtin_decl_implicit (BUILT_IN_TSAN_VPTR_UPDATE);
158 g = gimple_build_call (builtin_decl, 1, expr_ptr);
160 gimple_set_location (g, loc);
161 gimple_seq_add_stmt_without_update (&seq, g);
162 /* Instrumentation for assignment of a function result
163 must be inserted after the call. Instrumentation for
164 reads of function arguments must be inserted before the call.
165 That's because the call can contain synchronization. */
166 if (is_gimple_call (stmt) && is_write)
168 /* If the call can throw, it must be the last stmt in
169 a basic block, so the instrumented stmts need to be
170 inserted in successor bbs. */
171 if (is_ctrl_altering_stmt (stmt))
173 edge e;
175 bb = gsi_bb (gsi);
176 e = find_fallthru_edge (bb->succs);
177 if (e)
178 gsi_insert_seq_on_edge_immediate (e, seq);
180 else
181 gsi_insert_seq_after (&gsi, seq, GSI_NEW_STMT);
183 else
184 gsi_insert_seq_before (&gsi, seq, GSI_SAME_STMT);
186 return true;
189 /* Actions for sync/atomic builtin transformations. */
190 enum tsan_atomic_action
192 check_last, add_seq_cst, add_acquire, weak_cas, strong_cas,
193 bool_cas, val_cas, lock_release, fetch_op, fetch_op_seq_cst
196 /* Table how to map sync/atomic builtins to their corresponding
197 tsan equivalents. */
198 static struct tsan_map_atomic
200 enum built_in_function fcode, tsan_fcode;
201 enum tsan_atomic_action action;
202 enum tree_code code;
203 } tsan_atomic_table[] =
205 #define TRANSFORM(fcode, tsan_fcode, action, code) \
206 { BUILT_IN_##fcode, BUILT_IN_##tsan_fcode, action, code }
207 #define CHECK_LAST(fcode, tsan_fcode) \
208 TRANSFORM (fcode, tsan_fcode, check_last, ERROR_MARK)
209 #define ADD_SEQ_CST(fcode, tsan_fcode) \
210 TRANSFORM (fcode, tsan_fcode, add_seq_cst, ERROR_MARK)
211 #define ADD_ACQUIRE(fcode, tsan_fcode) \
212 TRANSFORM (fcode, tsan_fcode, add_acquire, ERROR_MARK)
213 #define WEAK_CAS(fcode, tsan_fcode) \
214 TRANSFORM (fcode, tsan_fcode, weak_cas, ERROR_MARK)
215 #define STRONG_CAS(fcode, tsan_fcode) \
216 TRANSFORM (fcode, tsan_fcode, strong_cas, ERROR_MARK)
217 #define BOOL_CAS(fcode, tsan_fcode) \
218 TRANSFORM (fcode, tsan_fcode, bool_cas, ERROR_MARK)
219 #define VAL_CAS(fcode, tsan_fcode) \
220 TRANSFORM (fcode, tsan_fcode, val_cas, ERROR_MARK)
221 #define LOCK_RELEASE(fcode, tsan_fcode) \
222 TRANSFORM (fcode, tsan_fcode, lock_release, ERROR_MARK)
223 #define FETCH_OP(fcode, tsan_fcode, code) \
224 TRANSFORM (fcode, tsan_fcode, fetch_op, code)
225 #define FETCH_OPS(fcode, tsan_fcode, code) \
226 TRANSFORM (fcode, tsan_fcode, fetch_op_seq_cst, code)
228 CHECK_LAST (ATOMIC_LOAD_1, TSAN_ATOMIC8_LOAD),
229 CHECK_LAST (ATOMIC_LOAD_2, TSAN_ATOMIC16_LOAD),
230 CHECK_LAST (ATOMIC_LOAD_4, TSAN_ATOMIC32_LOAD),
231 CHECK_LAST (ATOMIC_LOAD_8, TSAN_ATOMIC64_LOAD),
232 CHECK_LAST (ATOMIC_LOAD_16, TSAN_ATOMIC128_LOAD),
233 CHECK_LAST (ATOMIC_STORE_1, TSAN_ATOMIC8_STORE),
234 CHECK_LAST (ATOMIC_STORE_2, TSAN_ATOMIC16_STORE),
235 CHECK_LAST (ATOMIC_STORE_4, TSAN_ATOMIC32_STORE),
236 CHECK_LAST (ATOMIC_STORE_8, TSAN_ATOMIC64_STORE),
237 CHECK_LAST (ATOMIC_STORE_16, TSAN_ATOMIC128_STORE),
238 CHECK_LAST (ATOMIC_EXCHANGE_1, TSAN_ATOMIC8_EXCHANGE),
239 CHECK_LAST (ATOMIC_EXCHANGE_2, TSAN_ATOMIC16_EXCHANGE),
240 CHECK_LAST (ATOMIC_EXCHANGE_4, TSAN_ATOMIC32_EXCHANGE),
241 CHECK_LAST (ATOMIC_EXCHANGE_8, TSAN_ATOMIC64_EXCHANGE),
242 CHECK_LAST (ATOMIC_EXCHANGE_16, TSAN_ATOMIC128_EXCHANGE),
243 CHECK_LAST (ATOMIC_FETCH_ADD_1, TSAN_ATOMIC8_FETCH_ADD),
244 CHECK_LAST (ATOMIC_FETCH_ADD_2, TSAN_ATOMIC16_FETCH_ADD),
245 CHECK_LAST (ATOMIC_FETCH_ADD_4, TSAN_ATOMIC32_FETCH_ADD),
246 CHECK_LAST (ATOMIC_FETCH_ADD_8, TSAN_ATOMIC64_FETCH_ADD),
247 CHECK_LAST (ATOMIC_FETCH_ADD_16, TSAN_ATOMIC128_FETCH_ADD),
248 CHECK_LAST (ATOMIC_FETCH_SUB_1, TSAN_ATOMIC8_FETCH_SUB),
249 CHECK_LAST (ATOMIC_FETCH_SUB_2, TSAN_ATOMIC16_FETCH_SUB),
250 CHECK_LAST (ATOMIC_FETCH_SUB_4, TSAN_ATOMIC32_FETCH_SUB),
251 CHECK_LAST (ATOMIC_FETCH_SUB_8, TSAN_ATOMIC64_FETCH_SUB),
252 CHECK_LAST (ATOMIC_FETCH_SUB_16, TSAN_ATOMIC128_FETCH_SUB),
253 CHECK_LAST (ATOMIC_FETCH_AND_1, TSAN_ATOMIC8_FETCH_AND),
254 CHECK_LAST (ATOMIC_FETCH_AND_2, TSAN_ATOMIC16_FETCH_AND),
255 CHECK_LAST (ATOMIC_FETCH_AND_4, TSAN_ATOMIC32_FETCH_AND),
256 CHECK_LAST (ATOMIC_FETCH_AND_8, TSAN_ATOMIC64_FETCH_AND),
257 CHECK_LAST (ATOMIC_FETCH_AND_16, TSAN_ATOMIC128_FETCH_AND),
258 CHECK_LAST (ATOMIC_FETCH_OR_1, TSAN_ATOMIC8_FETCH_OR),
259 CHECK_LAST (ATOMIC_FETCH_OR_2, TSAN_ATOMIC16_FETCH_OR),
260 CHECK_LAST (ATOMIC_FETCH_OR_4, TSAN_ATOMIC32_FETCH_OR),
261 CHECK_LAST (ATOMIC_FETCH_OR_8, TSAN_ATOMIC64_FETCH_OR),
262 CHECK_LAST (ATOMIC_FETCH_OR_16, TSAN_ATOMIC128_FETCH_OR),
263 CHECK_LAST (ATOMIC_FETCH_XOR_1, TSAN_ATOMIC8_FETCH_XOR),
264 CHECK_LAST (ATOMIC_FETCH_XOR_2, TSAN_ATOMIC16_FETCH_XOR),
265 CHECK_LAST (ATOMIC_FETCH_XOR_4, TSAN_ATOMIC32_FETCH_XOR),
266 CHECK_LAST (ATOMIC_FETCH_XOR_8, TSAN_ATOMIC64_FETCH_XOR),
267 CHECK_LAST (ATOMIC_FETCH_XOR_16, TSAN_ATOMIC128_FETCH_XOR),
268 CHECK_LAST (ATOMIC_FETCH_NAND_1, TSAN_ATOMIC8_FETCH_NAND),
269 CHECK_LAST (ATOMIC_FETCH_NAND_2, TSAN_ATOMIC16_FETCH_NAND),
270 CHECK_LAST (ATOMIC_FETCH_NAND_4, TSAN_ATOMIC32_FETCH_NAND),
271 CHECK_LAST (ATOMIC_FETCH_NAND_8, TSAN_ATOMIC64_FETCH_NAND),
272 CHECK_LAST (ATOMIC_FETCH_NAND_16, TSAN_ATOMIC128_FETCH_NAND),
274 CHECK_LAST (ATOMIC_THREAD_FENCE, TSAN_ATOMIC_THREAD_FENCE),
275 CHECK_LAST (ATOMIC_SIGNAL_FENCE, TSAN_ATOMIC_SIGNAL_FENCE),
277 FETCH_OP (ATOMIC_ADD_FETCH_1, TSAN_ATOMIC8_FETCH_ADD, PLUS_EXPR),
278 FETCH_OP (ATOMIC_ADD_FETCH_2, TSAN_ATOMIC16_FETCH_ADD, PLUS_EXPR),
279 FETCH_OP (ATOMIC_ADD_FETCH_4, TSAN_ATOMIC32_FETCH_ADD, PLUS_EXPR),
280 FETCH_OP (ATOMIC_ADD_FETCH_8, TSAN_ATOMIC64_FETCH_ADD, PLUS_EXPR),
281 FETCH_OP (ATOMIC_ADD_FETCH_16, TSAN_ATOMIC128_FETCH_ADD, PLUS_EXPR),
282 FETCH_OP (ATOMIC_SUB_FETCH_1, TSAN_ATOMIC8_FETCH_SUB, MINUS_EXPR),
283 FETCH_OP (ATOMIC_SUB_FETCH_2, TSAN_ATOMIC16_FETCH_SUB, MINUS_EXPR),
284 FETCH_OP (ATOMIC_SUB_FETCH_4, TSAN_ATOMIC32_FETCH_SUB, MINUS_EXPR),
285 FETCH_OP (ATOMIC_SUB_FETCH_8, TSAN_ATOMIC64_FETCH_SUB, MINUS_EXPR),
286 FETCH_OP (ATOMIC_SUB_FETCH_16, TSAN_ATOMIC128_FETCH_SUB, MINUS_EXPR),
287 FETCH_OP (ATOMIC_AND_FETCH_1, TSAN_ATOMIC8_FETCH_AND, BIT_AND_EXPR),
288 FETCH_OP (ATOMIC_AND_FETCH_2, TSAN_ATOMIC16_FETCH_AND, BIT_AND_EXPR),
289 FETCH_OP (ATOMIC_AND_FETCH_4, TSAN_ATOMIC32_FETCH_AND, BIT_AND_EXPR),
290 FETCH_OP (ATOMIC_AND_FETCH_8, TSAN_ATOMIC64_FETCH_AND, BIT_AND_EXPR),
291 FETCH_OP (ATOMIC_AND_FETCH_16, TSAN_ATOMIC128_FETCH_AND, BIT_AND_EXPR),
292 FETCH_OP (ATOMIC_OR_FETCH_1, TSAN_ATOMIC8_FETCH_OR, BIT_IOR_EXPR),
293 FETCH_OP (ATOMIC_OR_FETCH_2, TSAN_ATOMIC16_FETCH_OR, BIT_IOR_EXPR),
294 FETCH_OP (ATOMIC_OR_FETCH_4, TSAN_ATOMIC32_FETCH_OR, BIT_IOR_EXPR),
295 FETCH_OP (ATOMIC_OR_FETCH_8, TSAN_ATOMIC64_FETCH_OR, BIT_IOR_EXPR),
296 FETCH_OP (ATOMIC_OR_FETCH_16, TSAN_ATOMIC128_FETCH_OR, BIT_IOR_EXPR),
297 FETCH_OP (ATOMIC_XOR_FETCH_1, TSAN_ATOMIC8_FETCH_XOR, BIT_XOR_EXPR),
298 FETCH_OP (ATOMIC_XOR_FETCH_2, TSAN_ATOMIC16_FETCH_XOR, BIT_XOR_EXPR),
299 FETCH_OP (ATOMIC_XOR_FETCH_4, TSAN_ATOMIC32_FETCH_XOR, BIT_XOR_EXPR),
300 FETCH_OP (ATOMIC_XOR_FETCH_8, TSAN_ATOMIC64_FETCH_XOR, BIT_XOR_EXPR),
301 FETCH_OP (ATOMIC_XOR_FETCH_16, TSAN_ATOMIC128_FETCH_XOR, BIT_XOR_EXPR),
302 FETCH_OP (ATOMIC_NAND_FETCH_1, TSAN_ATOMIC8_FETCH_NAND, BIT_NOT_EXPR),
303 FETCH_OP (ATOMIC_NAND_FETCH_2, TSAN_ATOMIC16_FETCH_NAND, BIT_NOT_EXPR),
304 FETCH_OP (ATOMIC_NAND_FETCH_4, TSAN_ATOMIC32_FETCH_NAND, BIT_NOT_EXPR),
305 FETCH_OP (ATOMIC_NAND_FETCH_8, TSAN_ATOMIC64_FETCH_NAND, BIT_NOT_EXPR),
306 FETCH_OP (ATOMIC_NAND_FETCH_16, TSAN_ATOMIC128_FETCH_NAND, BIT_NOT_EXPR),
308 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_1, TSAN_ATOMIC8_EXCHANGE),
309 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_2, TSAN_ATOMIC16_EXCHANGE),
310 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_4, TSAN_ATOMIC32_EXCHANGE),
311 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_8, TSAN_ATOMIC64_EXCHANGE),
312 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_16, TSAN_ATOMIC128_EXCHANGE),
314 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_1, TSAN_ATOMIC8_FETCH_ADD),
315 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_2, TSAN_ATOMIC16_FETCH_ADD),
316 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_4, TSAN_ATOMIC32_FETCH_ADD),
317 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_8, TSAN_ATOMIC64_FETCH_ADD),
318 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_16, TSAN_ATOMIC128_FETCH_ADD),
319 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_1, TSAN_ATOMIC8_FETCH_SUB),
320 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_2, TSAN_ATOMIC16_FETCH_SUB),
321 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_4, TSAN_ATOMIC32_FETCH_SUB),
322 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_8, TSAN_ATOMIC64_FETCH_SUB),
323 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_16, TSAN_ATOMIC128_FETCH_SUB),
324 ADD_SEQ_CST (SYNC_FETCH_AND_AND_1, TSAN_ATOMIC8_FETCH_AND),
325 ADD_SEQ_CST (SYNC_FETCH_AND_AND_2, TSAN_ATOMIC16_FETCH_AND),
326 ADD_SEQ_CST (SYNC_FETCH_AND_AND_4, TSAN_ATOMIC32_FETCH_AND),
327 ADD_SEQ_CST (SYNC_FETCH_AND_AND_8, TSAN_ATOMIC64_FETCH_AND),
328 ADD_SEQ_CST (SYNC_FETCH_AND_AND_16, TSAN_ATOMIC128_FETCH_AND),
329 ADD_SEQ_CST (SYNC_FETCH_AND_OR_1, TSAN_ATOMIC8_FETCH_OR),
330 ADD_SEQ_CST (SYNC_FETCH_AND_OR_2, TSAN_ATOMIC16_FETCH_OR),
331 ADD_SEQ_CST (SYNC_FETCH_AND_OR_4, TSAN_ATOMIC32_FETCH_OR),
332 ADD_SEQ_CST (SYNC_FETCH_AND_OR_8, TSAN_ATOMIC64_FETCH_OR),
333 ADD_SEQ_CST (SYNC_FETCH_AND_OR_16, TSAN_ATOMIC128_FETCH_OR),
334 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_1, TSAN_ATOMIC8_FETCH_XOR),
335 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_2, TSAN_ATOMIC16_FETCH_XOR),
336 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_4, TSAN_ATOMIC32_FETCH_XOR),
337 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_8, TSAN_ATOMIC64_FETCH_XOR),
338 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_16, TSAN_ATOMIC128_FETCH_XOR),
339 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_1, TSAN_ATOMIC8_FETCH_NAND),
340 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_2, TSAN_ATOMIC16_FETCH_NAND),
341 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_4, TSAN_ATOMIC32_FETCH_NAND),
342 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_8, TSAN_ATOMIC64_FETCH_NAND),
343 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_16, TSAN_ATOMIC128_FETCH_NAND),
345 ADD_SEQ_CST (SYNC_SYNCHRONIZE, TSAN_ATOMIC_THREAD_FENCE),
347 FETCH_OPS (SYNC_ADD_AND_FETCH_1, TSAN_ATOMIC8_FETCH_ADD, PLUS_EXPR),
348 FETCH_OPS (SYNC_ADD_AND_FETCH_2, TSAN_ATOMIC16_FETCH_ADD, PLUS_EXPR),
349 FETCH_OPS (SYNC_ADD_AND_FETCH_4, TSAN_ATOMIC32_FETCH_ADD, PLUS_EXPR),
350 FETCH_OPS (SYNC_ADD_AND_FETCH_8, TSAN_ATOMIC64_FETCH_ADD, PLUS_EXPR),
351 FETCH_OPS (SYNC_ADD_AND_FETCH_16, TSAN_ATOMIC128_FETCH_ADD, PLUS_EXPR),
352 FETCH_OPS (SYNC_SUB_AND_FETCH_1, TSAN_ATOMIC8_FETCH_SUB, MINUS_EXPR),
353 FETCH_OPS (SYNC_SUB_AND_FETCH_2, TSAN_ATOMIC16_FETCH_SUB, MINUS_EXPR),
354 FETCH_OPS (SYNC_SUB_AND_FETCH_4, TSAN_ATOMIC32_FETCH_SUB, MINUS_EXPR),
355 FETCH_OPS (SYNC_SUB_AND_FETCH_8, TSAN_ATOMIC64_FETCH_SUB, MINUS_EXPR),
356 FETCH_OPS (SYNC_SUB_AND_FETCH_16, TSAN_ATOMIC128_FETCH_SUB, MINUS_EXPR),
357 FETCH_OPS (SYNC_AND_AND_FETCH_1, TSAN_ATOMIC8_FETCH_AND, BIT_AND_EXPR),
358 FETCH_OPS (SYNC_AND_AND_FETCH_2, TSAN_ATOMIC16_FETCH_AND, BIT_AND_EXPR),
359 FETCH_OPS (SYNC_AND_AND_FETCH_4, TSAN_ATOMIC32_FETCH_AND, BIT_AND_EXPR),
360 FETCH_OPS (SYNC_AND_AND_FETCH_8, TSAN_ATOMIC64_FETCH_AND, BIT_AND_EXPR),
361 FETCH_OPS (SYNC_AND_AND_FETCH_16, TSAN_ATOMIC128_FETCH_AND, BIT_AND_EXPR),
362 FETCH_OPS (SYNC_OR_AND_FETCH_1, TSAN_ATOMIC8_FETCH_OR, BIT_IOR_EXPR),
363 FETCH_OPS (SYNC_OR_AND_FETCH_2, TSAN_ATOMIC16_FETCH_OR, BIT_IOR_EXPR),
364 FETCH_OPS (SYNC_OR_AND_FETCH_4, TSAN_ATOMIC32_FETCH_OR, BIT_IOR_EXPR),
365 FETCH_OPS (SYNC_OR_AND_FETCH_8, TSAN_ATOMIC64_FETCH_OR, BIT_IOR_EXPR),
366 FETCH_OPS (SYNC_OR_AND_FETCH_16, TSAN_ATOMIC128_FETCH_OR, BIT_IOR_EXPR),
367 FETCH_OPS (SYNC_XOR_AND_FETCH_1, TSAN_ATOMIC8_FETCH_XOR, BIT_XOR_EXPR),
368 FETCH_OPS (SYNC_XOR_AND_FETCH_2, TSAN_ATOMIC16_FETCH_XOR, BIT_XOR_EXPR),
369 FETCH_OPS (SYNC_XOR_AND_FETCH_4, TSAN_ATOMIC32_FETCH_XOR, BIT_XOR_EXPR),
370 FETCH_OPS (SYNC_XOR_AND_FETCH_8, TSAN_ATOMIC64_FETCH_XOR, BIT_XOR_EXPR),
371 FETCH_OPS (SYNC_XOR_AND_FETCH_16, TSAN_ATOMIC128_FETCH_XOR, BIT_XOR_EXPR),
372 FETCH_OPS (SYNC_NAND_AND_FETCH_1, TSAN_ATOMIC8_FETCH_NAND, BIT_NOT_EXPR),
373 FETCH_OPS (SYNC_NAND_AND_FETCH_2, TSAN_ATOMIC16_FETCH_NAND, BIT_NOT_EXPR),
374 FETCH_OPS (SYNC_NAND_AND_FETCH_4, TSAN_ATOMIC32_FETCH_NAND, BIT_NOT_EXPR),
375 FETCH_OPS (SYNC_NAND_AND_FETCH_8, TSAN_ATOMIC64_FETCH_NAND, BIT_NOT_EXPR),
376 FETCH_OPS (SYNC_NAND_AND_FETCH_16, TSAN_ATOMIC128_FETCH_NAND, BIT_NOT_EXPR),
378 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_1, TSAN_ATOMIC8_COMPARE_EXCHANGE_WEAK),
379 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_2, TSAN_ATOMIC16_COMPARE_EXCHANGE_WEAK),
380 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_4, TSAN_ATOMIC32_COMPARE_EXCHANGE_WEAK),
381 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_8, TSAN_ATOMIC64_COMPARE_EXCHANGE_WEAK),
382 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_16, TSAN_ATOMIC128_COMPARE_EXCHANGE_WEAK),
384 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_1, TSAN_ATOMIC8_COMPARE_EXCHANGE_STRONG),
385 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_2,
386 TSAN_ATOMIC16_COMPARE_EXCHANGE_STRONG),
387 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_4,
388 TSAN_ATOMIC32_COMPARE_EXCHANGE_STRONG),
389 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_8,
390 TSAN_ATOMIC64_COMPARE_EXCHANGE_STRONG),
391 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_16,
392 TSAN_ATOMIC128_COMPARE_EXCHANGE_STRONG),
394 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_1,
395 TSAN_ATOMIC8_COMPARE_EXCHANGE_STRONG),
396 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_2,
397 TSAN_ATOMIC16_COMPARE_EXCHANGE_STRONG),
398 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_4,
399 TSAN_ATOMIC32_COMPARE_EXCHANGE_STRONG),
400 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_8,
401 TSAN_ATOMIC64_COMPARE_EXCHANGE_STRONG),
402 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_16,
403 TSAN_ATOMIC128_COMPARE_EXCHANGE_STRONG),
405 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_1, TSAN_ATOMIC8_COMPARE_EXCHANGE_STRONG),
406 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_2, TSAN_ATOMIC16_COMPARE_EXCHANGE_STRONG),
407 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_4, TSAN_ATOMIC32_COMPARE_EXCHANGE_STRONG),
408 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_8, TSAN_ATOMIC64_COMPARE_EXCHANGE_STRONG),
409 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_16,
410 TSAN_ATOMIC128_COMPARE_EXCHANGE_STRONG),
412 LOCK_RELEASE (SYNC_LOCK_RELEASE_1, TSAN_ATOMIC8_STORE),
413 LOCK_RELEASE (SYNC_LOCK_RELEASE_2, TSAN_ATOMIC16_STORE),
414 LOCK_RELEASE (SYNC_LOCK_RELEASE_4, TSAN_ATOMIC32_STORE),
415 LOCK_RELEASE (SYNC_LOCK_RELEASE_8, TSAN_ATOMIC64_STORE),
416 LOCK_RELEASE (SYNC_LOCK_RELEASE_16, TSAN_ATOMIC128_STORE)
419 /* Instrument an atomic builtin. */
421 static void
422 instrument_builtin_call (gimple_stmt_iterator *gsi)
424 gimple stmt = gsi_stmt (*gsi), g;
425 tree callee = gimple_call_fndecl (stmt), last_arg, args[6], t, lhs;
426 enum built_in_function fcode = DECL_FUNCTION_CODE (callee);
427 unsigned int i, num = gimple_call_num_args (stmt), j;
428 for (j = 0; j < 6 && j < num; j++)
429 args[j] = gimple_call_arg (stmt, j);
430 for (i = 0; i < ARRAY_SIZE (tsan_atomic_table); i++)
431 if (fcode != tsan_atomic_table[i].fcode)
432 continue;
433 else
435 tree decl = builtin_decl_implicit (tsan_atomic_table[i].tsan_fcode);
436 if (decl == NULL_TREE)
437 return;
438 switch (tsan_atomic_table[i].action)
440 case check_last:
441 case fetch_op:
442 last_arg = gimple_call_arg (stmt, num - 1);
443 if (!host_integerp (last_arg, 1)
444 || (unsigned HOST_WIDE_INT) tree_low_cst (last_arg, 1)
445 > MEMMODEL_SEQ_CST)
446 return;
447 gimple_call_set_fndecl (stmt, decl);
448 update_stmt (stmt);
449 if (tsan_atomic_table[i].action == fetch_op)
451 args[1] = gimple_call_arg (stmt, 1);
452 goto adjust_result;
454 return;
455 case add_seq_cst:
456 case add_acquire:
457 case fetch_op_seq_cst:
458 gcc_assert (num <= 2);
459 for (j = 0; j < num; j++)
460 args[j] = gimple_call_arg (stmt, j);
461 for (; j < 2; j++)
462 args[j] = NULL_TREE;
463 args[num] = build_int_cst (NULL_TREE,
464 tsan_atomic_table[i].action
465 != add_acquire
466 ? MEMMODEL_SEQ_CST
467 : MEMMODEL_ACQUIRE);
468 update_gimple_call (gsi, decl, num + 1, args[0], args[1], args[2]);
469 stmt = gsi_stmt (*gsi);
470 if (tsan_atomic_table[i].action == fetch_op_seq_cst)
472 adjust_result:
473 lhs = gimple_call_lhs (stmt);
474 if (lhs == NULL_TREE)
475 return;
476 if (!useless_type_conversion_p (TREE_TYPE (lhs),
477 TREE_TYPE (args[1])))
479 tree var = make_ssa_name (TREE_TYPE (lhs), NULL);
480 g = gimple_build_assign_with_ops (NOP_EXPR, var,
481 args[1], NULL_TREE);
482 gsi_insert_after (gsi, g, GSI_NEW_STMT);
483 args[1] = var;
485 gimple_call_set_lhs (stmt,
486 make_ssa_name (TREE_TYPE (lhs), NULL));
487 /* BIT_NOT_EXPR stands for NAND. */
488 if (tsan_atomic_table[i].code == BIT_NOT_EXPR)
490 tree var = make_ssa_name (TREE_TYPE (lhs), NULL);
491 g = gimple_build_assign_with_ops (BIT_AND_EXPR, var,
492 gimple_call_lhs (stmt),
493 args[1]);
494 gsi_insert_after (gsi, g, GSI_NEW_STMT);
495 g = gimple_build_assign_with_ops (BIT_NOT_EXPR, lhs, var,
496 NULL_TREE);
498 else
499 g = gimple_build_assign_with_ops (tsan_atomic_table[i].code,
500 lhs,
501 gimple_call_lhs (stmt),
502 args[1]);
503 update_stmt (stmt);
504 gsi_insert_after (gsi, g, GSI_NEW_STMT);
506 return;
507 case weak_cas:
508 if (!integer_nonzerop (gimple_call_arg (stmt, 3)))
509 continue;
510 /* FALLTHRU */
511 case strong_cas:
512 gcc_assert (num == 6);
513 for (j = 0; j < 6; j++)
514 args[j] = gimple_call_arg (stmt, j);
515 if (!host_integerp (args[4], 1)
516 || (unsigned HOST_WIDE_INT) tree_low_cst (args[4], 1)
517 > MEMMODEL_SEQ_CST)
518 return;
519 if (!host_integerp (args[5], 1)
520 || (unsigned HOST_WIDE_INT) tree_low_cst (args[5], 1)
521 > MEMMODEL_SEQ_CST)
522 return;
523 update_gimple_call (gsi, decl, 5, args[0], args[1], args[2],
524 args[4], args[5]);
525 return;
526 case bool_cas:
527 case val_cas:
528 gcc_assert (num == 3);
529 for (j = 0; j < 3; j++)
530 args[j] = gimple_call_arg (stmt, j);
531 t = TYPE_ARG_TYPES (TREE_TYPE (decl));
532 t = TREE_VALUE (TREE_CHAIN (TREE_CHAIN (t)));
533 t = create_tmp_var (t, NULL);
534 mark_addressable (t);
535 if (!useless_type_conversion_p (TREE_TYPE (t),
536 TREE_TYPE (args[1])))
538 g = gimple_build_assign_with_ops (NOP_EXPR,
539 make_ssa_name (TREE_TYPE (t),
540 NULL),
541 args[1], NULL_TREE);
542 gsi_insert_before (gsi, g, GSI_SAME_STMT);
543 args[1] = gimple_assign_lhs (g);
545 g = gimple_build_assign (t, args[1]);
546 gsi_insert_before (gsi, g, GSI_SAME_STMT);
547 lhs = gimple_call_lhs (stmt);
548 update_gimple_call (gsi, decl, 5, args[0],
549 build_fold_addr_expr (t), args[2],
550 build_int_cst (NULL_TREE,
551 MEMMODEL_SEQ_CST),
552 build_int_cst (NULL_TREE,
553 MEMMODEL_SEQ_CST));
554 if (tsan_atomic_table[i].action == val_cas && lhs)
556 tree cond;
557 stmt = gsi_stmt (*gsi);
558 g = gimple_build_assign (make_ssa_name (TREE_TYPE (t), NULL),
560 gsi_insert_after (gsi, g, GSI_NEW_STMT);
561 t = make_ssa_name (TREE_TYPE (TREE_TYPE (decl)), stmt);
562 cond = build2 (NE_EXPR, boolean_type_node, t,
563 build_int_cst (TREE_TYPE (t), 0));
564 g = gimple_build_assign_with_ops (COND_EXPR, lhs, cond,
565 args[1],
566 gimple_assign_lhs (g));
567 gimple_call_set_lhs (stmt, t);
568 update_stmt (stmt);
569 gsi_insert_after (gsi, g, GSI_NEW_STMT);
571 return;
572 case lock_release:
573 gcc_assert (num == 1);
574 t = TYPE_ARG_TYPES (TREE_TYPE (decl));
575 t = TREE_VALUE (TREE_CHAIN (t));
576 update_gimple_call (gsi, decl, 3, gimple_call_arg (stmt, 0),
577 build_int_cst (t, 0),
578 build_int_cst (NULL_TREE,
579 MEMMODEL_RELEASE));
580 return;
581 default:
582 continue;
587 /* Instruments the gimple pointed to by GSI. Return
588 true if func entry/exit should be instrumented. */
590 static bool
591 instrument_gimple (gimple_stmt_iterator *gsi)
593 gimple stmt;
594 tree rhs, lhs;
595 bool instrumented = false;
597 stmt = gsi_stmt (*gsi);
598 if (is_gimple_call (stmt)
599 && (gimple_call_fndecl (stmt)
600 != builtin_decl_implicit (BUILT_IN_TSAN_INIT)))
602 if (is_gimple_builtin_call (stmt))
603 instrument_builtin_call (gsi);
604 return true;
606 else if (is_gimple_assign (stmt)
607 && !gimple_clobber_p (stmt))
609 if (gimple_store_p (stmt))
611 lhs = gimple_assign_lhs (stmt);
612 instrumented = instrument_expr (*gsi, lhs, true);
614 if (gimple_assign_load_p (stmt))
616 rhs = gimple_assign_rhs1 (stmt);
617 instrumented = instrument_expr (*gsi, rhs, false);
620 return instrumented;
623 /* Instruments all interesting memory accesses in the current function.
624 Return true if func entry/exit should be instrumented. */
626 static bool
627 instrument_memory_accesses (void)
629 basic_block bb;
630 gimple_stmt_iterator gsi;
631 bool fentry_exit_instrument = false;
633 FOR_EACH_BB (bb)
634 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
635 fentry_exit_instrument |= instrument_gimple (&gsi);
636 return fentry_exit_instrument;
639 /* Instruments function entry. */
641 static void
642 instrument_func_entry (void)
644 basic_block succ_bb;
645 gimple_stmt_iterator gsi;
646 tree ret_addr, builtin_decl;
647 gimple g;
649 succ_bb = single_succ (ENTRY_BLOCK_PTR);
650 gsi = gsi_after_labels (succ_bb);
652 builtin_decl = builtin_decl_implicit (BUILT_IN_RETURN_ADDRESS);
653 g = gimple_build_call (builtin_decl, 1, integer_zero_node);
654 ret_addr = make_ssa_name (ptr_type_node, NULL);
655 gimple_call_set_lhs (g, ret_addr);
656 gimple_set_location (g, cfun->function_start_locus);
657 gsi_insert_before (&gsi, g, GSI_SAME_STMT);
659 builtin_decl = builtin_decl_implicit (BUILT_IN_TSAN_FUNC_ENTRY);
660 g = gimple_build_call (builtin_decl, 1, ret_addr);
661 gimple_set_location (g, cfun->function_start_locus);
662 gsi_insert_before (&gsi, g, GSI_SAME_STMT);
665 /* Instruments function exits. */
667 static void
668 instrument_func_exit (void)
670 location_t loc;
671 basic_block exit_bb;
672 gimple_stmt_iterator gsi;
673 gimple stmt, g;
674 tree builtin_decl;
675 edge e;
676 edge_iterator ei;
678 /* Find all function exits. */
679 exit_bb = EXIT_BLOCK_PTR;
680 FOR_EACH_EDGE (e, ei, exit_bb->preds)
682 gsi = gsi_last_bb (e->src);
683 stmt = gsi_stmt (gsi);
684 gcc_assert (gimple_code (stmt) == GIMPLE_RETURN
685 || gimple_call_builtin_p (stmt, BUILT_IN_RETURN));
686 loc = gimple_location (stmt);
687 builtin_decl = builtin_decl_implicit (BUILT_IN_TSAN_FUNC_EXIT);
688 g = gimple_build_call (builtin_decl, 0);
689 gimple_set_location (g, loc);
690 gsi_insert_before (&gsi, g, GSI_SAME_STMT);
694 /* ThreadSanitizer instrumentation pass. */
696 static unsigned
697 tsan_pass (void)
699 initialize_sanitizer_builtins ();
700 if (instrument_memory_accesses ())
702 instrument_func_entry ();
703 instrument_func_exit ();
705 return 0;
708 /* The pass's gate. */
710 static bool
711 tsan_gate (void)
713 return flag_tsan != 0;
716 /* Inserts __tsan_init () into the list of CTORs. */
718 void
719 tsan_finish_file (void)
721 tree ctor_statements = NULL_TREE;
723 initialize_sanitizer_builtins ();
724 tree init_decl = builtin_decl_implicit (BUILT_IN_TSAN_INIT);
725 append_to_statement_list (build_call_expr (init_decl, 0),
726 &ctor_statements);
727 cgraph_build_static_cdtor ('I', ctor_statements,
728 MAX_RESERVED_INIT_PRIORITY - 1);
731 /* The pass descriptor. */
733 struct gimple_opt_pass pass_tsan =
736 GIMPLE_PASS,
737 "tsan", /* name */
738 OPTGROUP_NONE, /* optinfo_flags */
739 tsan_gate, /* gate */
740 tsan_pass, /* execute */
741 NULL, /* sub */
742 NULL, /* next */
743 0, /* static_pass_number */
744 TV_NONE, /* tv_id */
745 PROP_ssa | PROP_cfg, /* properties_required */
746 0, /* properties_provided */
747 0, /* properties_destroyed */
748 0, /* todo_flags_start */
749 TODO_verify_all | TODO_update_ssa /* todo_flags_finish */
753 static bool
754 tsan_gate_O0 (void)
756 return flag_tsan != 0 && !optimize;
759 struct gimple_opt_pass pass_tsan_O0 =
762 GIMPLE_PASS,
763 "tsan0", /* name */
764 OPTGROUP_NONE, /* optinfo_flags */
765 tsan_gate_O0, /* gate */
766 tsan_pass, /* execute */
767 NULL, /* sub */
768 NULL, /* next */
769 0, /* static_pass_number */
770 TV_NONE, /* tv_id */
771 PROP_ssa | PROP_cfg, /* properties_required */
772 0, /* properties_provided */
773 0, /* properties_destroyed */
774 0, /* todo_flags_start */
775 TODO_verify_all | TODO_update_ssa /* todo_flags_finish */