1 /* GCC instrumentation plugin for ThreadSanitizer.
2 Copyright (C) 2011-2015 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
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
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/>. */
24 #include "coretypes.h"
30 #include "tree-pass.h"
33 #include "insn-config.h"
36 #include "diagnostic.h"
38 #include "fold-const.h"
47 #include "internal-fn.h"
49 #include "gimple-iterator.h"
50 #include "gimplify-me.h"
52 #include "tree-iterator.h"
53 #include "langhooks.h"
55 #include "tree-ssa-propagate.h"
56 #include "tree-ssa-loop-ivopts.h"
61 /* Number of instrumented memory accesses in the current function. */
63 /* Builds the following decl
64 void __tsan_read/writeX (void *addr); */
67 get_memory_access_decl (bool is_write
, unsigned size
)
69 enum built_in_function fcode
;
72 fcode
= is_write
? BUILT_IN_TSAN_WRITE1
73 : BUILT_IN_TSAN_READ1
;
75 fcode
= is_write
? BUILT_IN_TSAN_WRITE2
76 : BUILT_IN_TSAN_READ2
;
78 fcode
= is_write
? BUILT_IN_TSAN_WRITE4
79 : BUILT_IN_TSAN_READ4
;
81 fcode
= is_write
? BUILT_IN_TSAN_WRITE8
82 : BUILT_IN_TSAN_READ8
;
84 fcode
= is_write
? BUILT_IN_TSAN_WRITE16
85 : BUILT_IN_TSAN_READ16
;
87 return builtin_decl_implicit (fcode
);
90 /* Check as to whether EXPR refers to a store to vptr. */
93 is_vptr_store (gimple
*stmt
, tree expr
, bool is_write
)
96 && gimple_assign_single_p (stmt
)
97 && TREE_CODE (expr
) == COMPONENT_REF
)
99 tree field
= TREE_OPERAND (expr
, 1);
100 if (TREE_CODE (field
) == FIELD_DECL
101 && DECL_VIRTUAL_P (field
))
102 return gimple_assign_rhs1 (stmt
);
107 /* Instruments EXPR if needed. If any instrumentation is inserted,
111 instrument_expr (gimple_stmt_iterator gsi
, tree expr
, bool is_write
)
113 tree base
, rhs
, expr_ptr
, builtin_decl
;
121 size
= int_size_in_bytes (TREE_TYPE (expr
));
125 HOST_WIDE_INT bitsize
, bitpos
;
128 int volatilep
= 0, unsignedp
= 0;
129 base
= get_inner_reference (expr
, &bitsize
, &bitpos
, &offset
,
130 &mode
, &unsignedp
, &volatilep
, false);
132 /* No need to instrument accesses to decls that don't escape,
133 they can't escape to other threads then. */
134 if (DECL_P (base
) && !is_global_var (base
))
136 struct pt_solution pt
;
137 memset (&pt
, 0, sizeof (pt
));
139 pt
.ipa_escaped
= flag_ipa_pta
!= 0;
140 if (!pt_solution_includes (&pt
, base
))
142 if (!may_be_aliased (base
))
146 if (TREE_READONLY (base
)
147 || (TREE_CODE (base
) == VAR_DECL
148 && DECL_HARD_REGISTER (base
)))
151 stmt
= gsi_stmt (gsi
);
152 loc
= gimple_location (stmt
);
153 rhs
= is_vptr_store (stmt
, expr
, is_write
);
155 if ((TREE_CODE (expr
) == COMPONENT_REF
156 && DECL_BIT_FIELD_TYPE (TREE_OPERAND (expr
, 1)))
157 || TREE_CODE (expr
) == BIT_FIELD_REF
)
159 base
= TREE_OPERAND (expr
, 0);
160 if (TREE_CODE (expr
) == COMPONENT_REF
)
162 expr
= TREE_OPERAND (expr
, 1);
163 if (is_write
&& DECL_BIT_FIELD_REPRESENTATIVE (expr
))
164 expr
= DECL_BIT_FIELD_REPRESENTATIVE (expr
);
165 if (!tree_fits_uhwi_p (DECL_FIELD_OFFSET (expr
))
166 || !tree_fits_uhwi_p (DECL_FIELD_BIT_OFFSET (expr
))
167 || !tree_fits_uhwi_p (DECL_SIZE (expr
)))
169 bitpos
= tree_to_uhwi (DECL_FIELD_OFFSET (expr
)) * BITS_PER_UNIT
170 + tree_to_uhwi (DECL_FIELD_BIT_OFFSET (expr
));
171 bitsize
= tree_to_uhwi (DECL_SIZE (expr
));
175 if (!tree_fits_uhwi_p (TREE_OPERAND (expr
, 2))
176 || !tree_fits_uhwi_p (TREE_OPERAND (expr
, 1)))
178 bitpos
= tree_to_uhwi (TREE_OPERAND (expr
, 2));
179 bitsize
= tree_to_uhwi (TREE_OPERAND (expr
, 1));
181 if (bitpos
< 0 || bitsize
<= 0)
183 size
= (bitpos
% BITS_PER_UNIT
+ bitsize
+ BITS_PER_UNIT
- 1)
185 if (may_be_nonaddressable_p (base
))
187 align
= get_object_alignment (base
);
188 if (align
< BITS_PER_UNIT
)
190 bitpos
= bitpos
& ~(BITS_PER_UNIT
- 1);
191 if ((align
- 1) & bitpos
)
193 align
= (align
- 1) & bitpos
;
194 align
= align
& -align
;
196 expr
= build_fold_addr_expr (unshare_expr (base
));
197 expr
= build2 (MEM_REF
, char_type_node
, expr
,
198 build_int_cst (TREE_TYPE (expr
), bitpos
/ BITS_PER_UNIT
));
199 expr_ptr
= build_fold_addr_expr (expr
);
203 if (may_be_nonaddressable_p (expr
))
205 align
= get_object_alignment (expr
);
206 if (align
< BITS_PER_UNIT
)
208 expr_ptr
= build_fold_addr_expr (unshare_expr (expr
));
210 expr_ptr
= force_gimple_operand (expr_ptr
, &seq
, true, NULL_TREE
);
211 if ((size
& (size
- 1)) != 0 || size
> 16
212 || align
< MIN (size
, 8) * BITS_PER_UNIT
)
214 builtin_decl
= builtin_decl_implicit (is_write
215 ? BUILT_IN_TSAN_WRITE_RANGE
216 : BUILT_IN_TSAN_READ_RANGE
);
217 g
= gimple_build_call (builtin_decl
, 2, expr_ptr
, size_int (size
));
219 else if (rhs
== NULL
)
220 g
= gimple_build_call (get_memory_access_decl (is_write
, size
),
224 builtin_decl
= builtin_decl_implicit (BUILT_IN_TSAN_VPTR_UPDATE
);
225 g
= gimple_build_call (builtin_decl
, 2, expr_ptr
, unshare_expr (rhs
));
227 gimple_set_location (g
, loc
);
228 gimple_seq_add_stmt_without_update (&seq
, g
);
229 /* Instrumentation for assignment of a function result
230 must be inserted after the call. Instrumentation for
231 reads of function arguments must be inserted before the call.
232 That's because the call can contain synchronization. */
233 if (is_gimple_call (stmt
) && is_write
)
235 /* If the call can throw, it must be the last stmt in
236 a basic block, so the instrumented stmts need to be
237 inserted in successor bbs. */
238 if (is_ctrl_altering_stmt (stmt
))
243 e
= find_fallthru_edge (bb
->succs
);
245 gsi_insert_seq_on_edge_immediate (e
, seq
);
248 gsi_insert_seq_after (&gsi
, seq
, GSI_NEW_STMT
);
251 gsi_insert_seq_before (&gsi
, seq
, GSI_SAME_STMT
);
256 /* Actions for sync/atomic builtin transformations. */
257 enum tsan_atomic_action
259 check_last
, add_seq_cst
, add_acquire
, weak_cas
, strong_cas
,
260 bool_cas
, val_cas
, lock_release
, fetch_op
, fetch_op_seq_cst
263 /* Table how to map sync/atomic builtins to their corresponding
265 static const struct tsan_map_atomic
267 enum built_in_function fcode
, tsan_fcode
;
268 enum tsan_atomic_action action
;
270 } tsan_atomic_table
[] =
272 #define TRANSFORM(fcode, tsan_fcode, action, code) \
273 { BUILT_IN_##fcode, BUILT_IN_##tsan_fcode, action, code }
274 #define CHECK_LAST(fcode, tsan_fcode) \
275 TRANSFORM (fcode, tsan_fcode, check_last, ERROR_MARK)
276 #define ADD_SEQ_CST(fcode, tsan_fcode) \
277 TRANSFORM (fcode, tsan_fcode, add_seq_cst, ERROR_MARK)
278 #define ADD_ACQUIRE(fcode, tsan_fcode) \
279 TRANSFORM (fcode, tsan_fcode, add_acquire, ERROR_MARK)
280 #define WEAK_CAS(fcode, tsan_fcode) \
281 TRANSFORM (fcode, tsan_fcode, weak_cas, ERROR_MARK)
282 #define STRONG_CAS(fcode, tsan_fcode) \
283 TRANSFORM (fcode, tsan_fcode, strong_cas, ERROR_MARK)
284 #define BOOL_CAS(fcode, tsan_fcode) \
285 TRANSFORM (fcode, tsan_fcode, bool_cas, ERROR_MARK)
286 #define VAL_CAS(fcode, tsan_fcode) \
287 TRANSFORM (fcode, tsan_fcode, val_cas, ERROR_MARK)
288 #define LOCK_RELEASE(fcode, tsan_fcode) \
289 TRANSFORM (fcode, tsan_fcode, lock_release, ERROR_MARK)
290 #define FETCH_OP(fcode, tsan_fcode, code) \
291 TRANSFORM (fcode, tsan_fcode, fetch_op, code)
292 #define FETCH_OPS(fcode, tsan_fcode, code) \
293 TRANSFORM (fcode, tsan_fcode, fetch_op_seq_cst, code)
295 CHECK_LAST (ATOMIC_LOAD_1
, TSAN_ATOMIC8_LOAD
),
296 CHECK_LAST (ATOMIC_LOAD_2
, TSAN_ATOMIC16_LOAD
),
297 CHECK_LAST (ATOMIC_LOAD_4
, TSAN_ATOMIC32_LOAD
),
298 CHECK_LAST (ATOMIC_LOAD_8
, TSAN_ATOMIC64_LOAD
),
299 CHECK_LAST (ATOMIC_LOAD_16
, TSAN_ATOMIC128_LOAD
),
300 CHECK_LAST (ATOMIC_STORE_1
, TSAN_ATOMIC8_STORE
),
301 CHECK_LAST (ATOMIC_STORE_2
, TSAN_ATOMIC16_STORE
),
302 CHECK_LAST (ATOMIC_STORE_4
, TSAN_ATOMIC32_STORE
),
303 CHECK_LAST (ATOMIC_STORE_8
, TSAN_ATOMIC64_STORE
),
304 CHECK_LAST (ATOMIC_STORE_16
, TSAN_ATOMIC128_STORE
),
305 CHECK_LAST (ATOMIC_EXCHANGE_1
, TSAN_ATOMIC8_EXCHANGE
),
306 CHECK_LAST (ATOMIC_EXCHANGE_2
, TSAN_ATOMIC16_EXCHANGE
),
307 CHECK_LAST (ATOMIC_EXCHANGE_4
, TSAN_ATOMIC32_EXCHANGE
),
308 CHECK_LAST (ATOMIC_EXCHANGE_8
, TSAN_ATOMIC64_EXCHANGE
),
309 CHECK_LAST (ATOMIC_EXCHANGE_16
, TSAN_ATOMIC128_EXCHANGE
),
310 CHECK_LAST (ATOMIC_FETCH_ADD_1
, TSAN_ATOMIC8_FETCH_ADD
),
311 CHECK_LAST (ATOMIC_FETCH_ADD_2
, TSAN_ATOMIC16_FETCH_ADD
),
312 CHECK_LAST (ATOMIC_FETCH_ADD_4
, TSAN_ATOMIC32_FETCH_ADD
),
313 CHECK_LAST (ATOMIC_FETCH_ADD_8
, TSAN_ATOMIC64_FETCH_ADD
),
314 CHECK_LAST (ATOMIC_FETCH_ADD_16
, TSAN_ATOMIC128_FETCH_ADD
),
315 CHECK_LAST (ATOMIC_FETCH_SUB_1
, TSAN_ATOMIC8_FETCH_SUB
),
316 CHECK_LAST (ATOMIC_FETCH_SUB_2
, TSAN_ATOMIC16_FETCH_SUB
),
317 CHECK_LAST (ATOMIC_FETCH_SUB_4
, TSAN_ATOMIC32_FETCH_SUB
),
318 CHECK_LAST (ATOMIC_FETCH_SUB_8
, TSAN_ATOMIC64_FETCH_SUB
),
319 CHECK_LAST (ATOMIC_FETCH_SUB_16
, TSAN_ATOMIC128_FETCH_SUB
),
320 CHECK_LAST (ATOMIC_FETCH_AND_1
, TSAN_ATOMIC8_FETCH_AND
),
321 CHECK_LAST (ATOMIC_FETCH_AND_2
, TSAN_ATOMIC16_FETCH_AND
),
322 CHECK_LAST (ATOMIC_FETCH_AND_4
, TSAN_ATOMIC32_FETCH_AND
),
323 CHECK_LAST (ATOMIC_FETCH_AND_8
, TSAN_ATOMIC64_FETCH_AND
),
324 CHECK_LAST (ATOMIC_FETCH_AND_16
, TSAN_ATOMIC128_FETCH_AND
),
325 CHECK_LAST (ATOMIC_FETCH_OR_1
, TSAN_ATOMIC8_FETCH_OR
),
326 CHECK_LAST (ATOMIC_FETCH_OR_2
, TSAN_ATOMIC16_FETCH_OR
),
327 CHECK_LAST (ATOMIC_FETCH_OR_4
, TSAN_ATOMIC32_FETCH_OR
),
328 CHECK_LAST (ATOMIC_FETCH_OR_8
, TSAN_ATOMIC64_FETCH_OR
),
329 CHECK_LAST (ATOMIC_FETCH_OR_16
, TSAN_ATOMIC128_FETCH_OR
),
330 CHECK_LAST (ATOMIC_FETCH_XOR_1
, TSAN_ATOMIC8_FETCH_XOR
),
331 CHECK_LAST (ATOMIC_FETCH_XOR_2
, TSAN_ATOMIC16_FETCH_XOR
),
332 CHECK_LAST (ATOMIC_FETCH_XOR_4
, TSAN_ATOMIC32_FETCH_XOR
),
333 CHECK_LAST (ATOMIC_FETCH_XOR_8
, TSAN_ATOMIC64_FETCH_XOR
),
334 CHECK_LAST (ATOMIC_FETCH_XOR_16
, TSAN_ATOMIC128_FETCH_XOR
),
335 CHECK_LAST (ATOMIC_FETCH_NAND_1
, TSAN_ATOMIC8_FETCH_NAND
),
336 CHECK_LAST (ATOMIC_FETCH_NAND_2
, TSAN_ATOMIC16_FETCH_NAND
),
337 CHECK_LAST (ATOMIC_FETCH_NAND_4
, TSAN_ATOMIC32_FETCH_NAND
),
338 CHECK_LAST (ATOMIC_FETCH_NAND_8
, TSAN_ATOMIC64_FETCH_NAND
),
339 CHECK_LAST (ATOMIC_FETCH_NAND_16
, TSAN_ATOMIC128_FETCH_NAND
),
341 CHECK_LAST (ATOMIC_THREAD_FENCE
, TSAN_ATOMIC_THREAD_FENCE
),
342 CHECK_LAST (ATOMIC_SIGNAL_FENCE
, TSAN_ATOMIC_SIGNAL_FENCE
),
344 FETCH_OP (ATOMIC_ADD_FETCH_1
, TSAN_ATOMIC8_FETCH_ADD
, PLUS_EXPR
),
345 FETCH_OP (ATOMIC_ADD_FETCH_2
, TSAN_ATOMIC16_FETCH_ADD
, PLUS_EXPR
),
346 FETCH_OP (ATOMIC_ADD_FETCH_4
, TSAN_ATOMIC32_FETCH_ADD
, PLUS_EXPR
),
347 FETCH_OP (ATOMIC_ADD_FETCH_8
, TSAN_ATOMIC64_FETCH_ADD
, PLUS_EXPR
),
348 FETCH_OP (ATOMIC_ADD_FETCH_16
, TSAN_ATOMIC128_FETCH_ADD
, PLUS_EXPR
),
349 FETCH_OP (ATOMIC_SUB_FETCH_1
, TSAN_ATOMIC8_FETCH_SUB
, MINUS_EXPR
),
350 FETCH_OP (ATOMIC_SUB_FETCH_2
, TSAN_ATOMIC16_FETCH_SUB
, MINUS_EXPR
),
351 FETCH_OP (ATOMIC_SUB_FETCH_4
, TSAN_ATOMIC32_FETCH_SUB
, MINUS_EXPR
),
352 FETCH_OP (ATOMIC_SUB_FETCH_8
, TSAN_ATOMIC64_FETCH_SUB
, MINUS_EXPR
),
353 FETCH_OP (ATOMIC_SUB_FETCH_16
, TSAN_ATOMIC128_FETCH_SUB
, MINUS_EXPR
),
354 FETCH_OP (ATOMIC_AND_FETCH_1
, TSAN_ATOMIC8_FETCH_AND
, BIT_AND_EXPR
),
355 FETCH_OP (ATOMIC_AND_FETCH_2
, TSAN_ATOMIC16_FETCH_AND
, BIT_AND_EXPR
),
356 FETCH_OP (ATOMIC_AND_FETCH_4
, TSAN_ATOMIC32_FETCH_AND
, BIT_AND_EXPR
),
357 FETCH_OP (ATOMIC_AND_FETCH_8
, TSAN_ATOMIC64_FETCH_AND
, BIT_AND_EXPR
),
358 FETCH_OP (ATOMIC_AND_FETCH_16
, TSAN_ATOMIC128_FETCH_AND
, BIT_AND_EXPR
),
359 FETCH_OP (ATOMIC_OR_FETCH_1
, TSAN_ATOMIC8_FETCH_OR
, BIT_IOR_EXPR
),
360 FETCH_OP (ATOMIC_OR_FETCH_2
, TSAN_ATOMIC16_FETCH_OR
, BIT_IOR_EXPR
),
361 FETCH_OP (ATOMIC_OR_FETCH_4
, TSAN_ATOMIC32_FETCH_OR
, BIT_IOR_EXPR
),
362 FETCH_OP (ATOMIC_OR_FETCH_8
, TSAN_ATOMIC64_FETCH_OR
, BIT_IOR_EXPR
),
363 FETCH_OP (ATOMIC_OR_FETCH_16
, TSAN_ATOMIC128_FETCH_OR
, BIT_IOR_EXPR
),
364 FETCH_OP (ATOMIC_XOR_FETCH_1
, TSAN_ATOMIC8_FETCH_XOR
, BIT_XOR_EXPR
),
365 FETCH_OP (ATOMIC_XOR_FETCH_2
, TSAN_ATOMIC16_FETCH_XOR
, BIT_XOR_EXPR
),
366 FETCH_OP (ATOMIC_XOR_FETCH_4
, TSAN_ATOMIC32_FETCH_XOR
, BIT_XOR_EXPR
),
367 FETCH_OP (ATOMIC_XOR_FETCH_8
, TSAN_ATOMIC64_FETCH_XOR
, BIT_XOR_EXPR
),
368 FETCH_OP (ATOMIC_XOR_FETCH_16
, TSAN_ATOMIC128_FETCH_XOR
, BIT_XOR_EXPR
),
369 FETCH_OP (ATOMIC_NAND_FETCH_1
, TSAN_ATOMIC8_FETCH_NAND
, BIT_NOT_EXPR
),
370 FETCH_OP (ATOMIC_NAND_FETCH_2
, TSAN_ATOMIC16_FETCH_NAND
, BIT_NOT_EXPR
),
371 FETCH_OP (ATOMIC_NAND_FETCH_4
, TSAN_ATOMIC32_FETCH_NAND
, BIT_NOT_EXPR
),
372 FETCH_OP (ATOMIC_NAND_FETCH_8
, TSAN_ATOMIC64_FETCH_NAND
, BIT_NOT_EXPR
),
373 FETCH_OP (ATOMIC_NAND_FETCH_16
, TSAN_ATOMIC128_FETCH_NAND
, BIT_NOT_EXPR
),
375 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_1
, TSAN_ATOMIC8_EXCHANGE
),
376 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_2
, TSAN_ATOMIC16_EXCHANGE
),
377 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_4
, TSAN_ATOMIC32_EXCHANGE
),
378 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_8
, TSAN_ATOMIC64_EXCHANGE
),
379 ADD_ACQUIRE (SYNC_LOCK_TEST_AND_SET_16
, TSAN_ATOMIC128_EXCHANGE
),
381 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_1
, TSAN_ATOMIC8_FETCH_ADD
),
382 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_2
, TSAN_ATOMIC16_FETCH_ADD
),
383 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_4
, TSAN_ATOMIC32_FETCH_ADD
),
384 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_8
, TSAN_ATOMIC64_FETCH_ADD
),
385 ADD_SEQ_CST (SYNC_FETCH_AND_ADD_16
, TSAN_ATOMIC128_FETCH_ADD
),
386 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_1
, TSAN_ATOMIC8_FETCH_SUB
),
387 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_2
, TSAN_ATOMIC16_FETCH_SUB
),
388 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_4
, TSAN_ATOMIC32_FETCH_SUB
),
389 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_8
, TSAN_ATOMIC64_FETCH_SUB
),
390 ADD_SEQ_CST (SYNC_FETCH_AND_SUB_16
, TSAN_ATOMIC128_FETCH_SUB
),
391 ADD_SEQ_CST (SYNC_FETCH_AND_AND_1
, TSAN_ATOMIC8_FETCH_AND
),
392 ADD_SEQ_CST (SYNC_FETCH_AND_AND_2
, TSAN_ATOMIC16_FETCH_AND
),
393 ADD_SEQ_CST (SYNC_FETCH_AND_AND_4
, TSAN_ATOMIC32_FETCH_AND
),
394 ADD_SEQ_CST (SYNC_FETCH_AND_AND_8
, TSAN_ATOMIC64_FETCH_AND
),
395 ADD_SEQ_CST (SYNC_FETCH_AND_AND_16
, TSAN_ATOMIC128_FETCH_AND
),
396 ADD_SEQ_CST (SYNC_FETCH_AND_OR_1
, TSAN_ATOMIC8_FETCH_OR
),
397 ADD_SEQ_CST (SYNC_FETCH_AND_OR_2
, TSAN_ATOMIC16_FETCH_OR
),
398 ADD_SEQ_CST (SYNC_FETCH_AND_OR_4
, TSAN_ATOMIC32_FETCH_OR
),
399 ADD_SEQ_CST (SYNC_FETCH_AND_OR_8
, TSAN_ATOMIC64_FETCH_OR
),
400 ADD_SEQ_CST (SYNC_FETCH_AND_OR_16
, TSAN_ATOMIC128_FETCH_OR
),
401 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_1
, TSAN_ATOMIC8_FETCH_XOR
),
402 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_2
, TSAN_ATOMIC16_FETCH_XOR
),
403 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_4
, TSAN_ATOMIC32_FETCH_XOR
),
404 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_8
, TSAN_ATOMIC64_FETCH_XOR
),
405 ADD_SEQ_CST (SYNC_FETCH_AND_XOR_16
, TSAN_ATOMIC128_FETCH_XOR
),
406 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_1
, TSAN_ATOMIC8_FETCH_NAND
),
407 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_2
, TSAN_ATOMIC16_FETCH_NAND
),
408 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_4
, TSAN_ATOMIC32_FETCH_NAND
),
409 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_8
, TSAN_ATOMIC64_FETCH_NAND
),
410 ADD_SEQ_CST (SYNC_FETCH_AND_NAND_16
, TSAN_ATOMIC128_FETCH_NAND
),
412 ADD_SEQ_CST (SYNC_SYNCHRONIZE
, TSAN_ATOMIC_THREAD_FENCE
),
414 FETCH_OPS (SYNC_ADD_AND_FETCH_1
, TSAN_ATOMIC8_FETCH_ADD
, PLUS_EXPR
),
415 FETCH_OPS (SYNC_ADD_AND_FETCH_2
, TSAN_ATOMIC16_FETCH_ADD
, PLUS_EXPR
),
416 FETCH_OPS (SYNC_ADD_AND_FETCH_4
, TSAN_ATOMIC32_FETCH_ADD
, PLUS_EXPR
),
417 FETCH_OPS (SYNC_ADD_AND_FETCH_8
, TSAN_ATOMIC64_FETCH_ADD
, PLUS_EXPR
),
418 FETCH_OPS (SYNC_ADD_AND_FETCH_16
, TSAN_ATOMIC128_FETCH_ADD
, PLUS_EXPR
),
419 FETCH_OPS (SYNC_SUB_AND_FETCH_1
, TSAN_ATOMIC8_FETCH_SUB
, MINUS_EXPR
),
420 FETCH_OPS (SYNC_SUB_AND_FETCH_2
, TSAN_ATOMIC16_FETCH_SUB
, MINUS_EXPR
),
421 FETCH_OPS (SYNC_SUB_AND_FETCH_4
, TSAN_ATOMIC32_FETCH_SUB
, MINUS_EXPR
),
422 FETCH_OPS (SYNC_SUB_AND_FETCH_8
, TSAN_ATOMIC64_FETCH_SUB
, MINUS_EXPR
),
423 FETCH_OPS (SYNC_SUB_AND_FETCH_16
, TSAN_ATOMIC128_FETCH_SUB
, MINUS_EXPR
),
424 FETCH_OPS (SYNC_AND_AND_FETCH_1
, TSAN_ATOMIC8_FETCH_AND
, BIT_AND_EXPR
),
425 FETCH_OPS (SYNC_AND_AND_FETCH_2
, TSAN_ATOMIC16_FETCH_AND
, BIT_AND_EXPR
),
426 FETCH_OPS (SYNC_AND_AND_FETCH_4
, TSAN_ATOMIC32_FETCH_AND
, BIT_AND_EXPR
),
427 FETCH_OPS (SYNC_AND_AND_FETCH_8
, TSAN_ATOMIC64_FETCH_AND
, BIT_AND_EXPR
),
428 FETCH_OPS (SYNC_AND_AND_FETCH_16
, TSAN_ATOMIC128_FETCH_AND
, BIT_AND_EXPR
),
429 FETCH_OPS (SYNC_OR_AND_FETCH_1
, TSAN_ATOMIC8_FETCH_OR
, BIT_IOR_EXPR
),
430 FETCH_OPS (SYNC_OR_AND_FETCH_2
, TSAN_ATOMIC16_FETCH_OR
, BIT_IOR_EXPR
),
431 FETCH_OPS (SYNC_OR_AND_FETCH_4
, TSAN_ATOMIC32_FETCH_OR
, BIT_IOR_EXPR
),
432 FETCH_OPS (SYNC_OR_AND_FETCH_8
, TSAN_ATOMIC64_FETCH_OR
, BIT_IOR_EXPR
),
433 FETCH_OPS (SYNC_OR_AND_FETCH_16
, TSAN_ATOMIC128_FETCH_OR
, BIT_IOR_EXPR
),
434 FETCH_OPS (SYNC_XOR_AND_FETCH_1
, TSAN_ATOMIC8_FETCH_XOR
, BIT_XOR_EXPR
),
435 FETCH_OPS (SYNC_XOR_AND_FETCH_2
, TSAN_ATOMIC16_FETCH_XOR
, BIT_XOR_EXPR
),
436 FETCH_OPS (SYNC_XOR_AND_FETCH_4
, TSAN_ATOMIC32_FETCH_XOR
, BIT_XOR_EXPR
),
437 FETCH_OPS (SYNC_XOR_AND_FETCH_8
, TSAN_ATOMIC64_FETCH_XOR
, BIT_XOR_EXPR
),
438 FETCH_OPS (SYNC_XOR_AND_FETCH_16
, TSAN_ATOMIC128_FETCH_XOR
, BIT_XOR_EXPR
),
439 FETCH_OPS (SYNC_NAND_AND_FETCH_1
, TSAN_ATOMIC8_FETCH_NAND
, BIT_NOT_EXPR
),
440 FETCH_OPS (SYNC_NAND_AND_FETCH_2
, TSAN_ATOMIC16_FETCH_NAND
, BIT_NOT_EXPR
),
441 FETCH_OPS (SYNC_NAND_AND_FETCH_4
, TSAN_ATOMIC32_FETCH_NAND
, BIT_NOT_EXPR
),
442 FETCH_OPS (SYNC_NAND_AND_FETCH_8
, TSAN_ATOMIC64_FETCH_NAND
, BIT_NOT_EXPR
),
443 FETCH_OPS (SYNC_NAND_AND_FETCH_16
, TSAN_ATOMIC128_FETCH_NAND
, BIT_NOT_EXPR
),
445 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_1
, TSAN_ATOMIC8_COMPARE_EXCHANGE_WEAK
),
446 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_2
, TSAN_ATOMIC16_COMPARE_EXCHANGE_WEAK
),
447 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_4
, TSAN_ATOMIC32_COMPARE_EXCHANGE_WEAK
),
448 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_8
, TSAN_ATOMIC64_COMPARE_EXCHANGE_WEAK
),
449 WEAK_CAS (ATOMIC_COMPARE_EXCHANGE_16
, TSAN_ATOMIC128_COMPARE_EXCHANGE_WEAK
),
451 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_1
, TSAN_ATOMIC8_COMPARE_EXCHANGE_STRONG
),
452 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_2
,
453 TSAN_ATOMIC16_COMPARE_EXCHANGE_STRONG
),
454 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_4
,
455 TSAN_ATOMIC32_COMPARE_EXCHANGE_STRONG
),
456 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_8
,
457 TSAN_ATOMIC64_COMPARE_EXCHANGE_STRONG
),
458 STRONG_CAS (ATOMIC_COMPARE_EXCHANGE_16
,
459 TSAN_ATOMIC128_COMPARE_EXCHANGE_STRONG
),
461 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_1
,
462 TSAN_ATOMIC8_COMPARE_EXCHANGE_STRONG
),
463 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_2
,
464 TSAN_ATOMIC16_COMPARE_EXCHANGE_STRONG
),
465 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_4
,
466 TSAN_ATOMIC32_COMPARE_EXCHANGE_STRONG
),
467 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_8
,
468 TSAN_ATOMIC64_COMPARE_EXCHANGE_STRONG
),
469 BOOL_CAS (SYNC_BOOL_COMPARE_AND_SWAP_16
,
470 TSAN_ATOMIC128_COMPARE_EXCHANGE_STRONG
),
472 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_1
, TSAN_ATOMIC8_COMPARE_EXCHANGE_STRONG
),
473 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_2
, TSAN_ATOMIC16_COMPARE_EXCHANGE_STRONG
),
474 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_4
, TSAN_ATOMIC32_COMPARE_EXCHANGE_STRONG
),
475 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_8
, TSAN_ATOMIC64_COMPARE_EXCHANGE_STRONG
),
476 VAL_CAS (SYNC_VAL_COMPARE_AND_SWAP_16
,
477 TSAN_ATOMIC128_COMPARE_EXCHANGE_STRONG
),
479 LOCK_RELEASE (SYNC_LOCK_RELEASE_1
, TSAN_ATOMIC8_STORE
),
480 LOCK_RELEASE (SYNC_LOCK_RELEASE_2
, TSAN_ATOMIC16_STORE
),
481 LOCK_RELEASE (SYNC_LOCK_RELEASE_4
, TSAN_ATOMIC32_STORE
),
482 LOCK_RELEASE (SYNC_LOCK_RELEASE_8
, TSAN_ATOMIC64_STORE
),
483 LOCK_RELEASE (SYNC_LOCK_RELEASE_16
, TSAN_ATOMIC128_STORE
)
486 /* Instrument an atomic builtin. */
489 instrument_builtin_call (gimple_stmt_iterator
*gsi
)
491 gimple
*stmt
= gsi_stmt (*gsi
), *g
;
492 tree callee
= gimple_call_fndecl (stmt
), last_arg
, args
[6], t
, lhs
;
493 enum built_in_function fcode
= DECL_FUNCTION_CODE (callee
);
494 unsigned int i
, num
= gimple_call_num_args (stmt
), j
;
495 for (j
= 0; j
< 6 && j
< num
; j
++)
496 args
[j
] = gimple_call_arg (stmt
, j
);
497 for (i
= 0; i
< ARRAY_SIZE (tsan_atomic_table
); i
++)
498 if (fcode
!= tsan_atomic_table
[i
].fcode
)
502 tree decl
= builtin_decl_implicit (tsan_atomic_table
[i
].tsan_fcode
);
503 if (decl
== NULL_TREE
)
505 switch (tsan_atomic_table
[i
].action
)
509 last_arg
= gimple_call_arg (stmt
, num
- 1);
510 if (!tree_fits_uhwi_p (last_arg
)
511 || memmodel_base (tree_to_uhwi (last_arg
)) >= MEMMODEL_LAST
)
513 gimple_call_set_fndecl (stmt
, decl
);
515 if (tsan_atomic_table
[i
].action
== fetch_op
)
517 args
[1] = gimple_call_arg (stmt
, 1);
523 case fetch_op_seq_cst
:
524 gcc_assert (num
<= 2);
525 for (j
= 0; j
< num
; j
++)
526 args
[j
] = gimple_call_arg (stmt
, j
);
529 args
[num
] = build_int_cst (NULL_TREE
,
530 tsan_atomic_table
[i
].action
534 update_gimple_call (gsi
, decl
, num
+ 1, args
[0], args
[1], args
[2]);
535 stmt
= gsi_stmt (*gsi
);
536 if (tsan_atomic_table
[i
].action
== fetch_op_seq_cst
)
539 lhs
= gimple_call_lhs (stmt
);
540 if (lhs
== NULL_TREE
)
542 if (!useless_type_conversion_p (TREE_TYPE (lhs
),
543 TREE_TYPE (args
[1])))
545 tree var
= make_ssa_name (TREE_TYPE (lhs
));
546 g
= gimple_build_assign (var
, NOP_EXPR
, args
[1]);
547 gsi_insert_after (gsi
, g
, GSI_NEW_STMT
);
550 gimple_call_set_lhs (stmt
, make_ssa_name (TREE_TYPE (lhs
)));
551 /* BIT_NOT_EXPR stands for NAND. */
552 if (tsan_atomic_table
[i
].code
== BIT_NOT_EXPR
)
554 tree var
= make_ssa_name (TREE_TYPE (lhs
));
555 g
= gimple_build_assign (var
, BIT_AND_EXPR
,
556 gimple_call_lhs (stmt
), args
[1]);
557 gsi_insert_after (gsi
, g
, GSI_NEW_STMT
);
558 g
= gimple_build_assign (lhs
, BIT_NOT_EXPR
, var
);
561 g
= gimple_build_assign (lhs
, tsan_atomic_table
[i
].code
,
562 gimple_call_lhs (stmt
), args
[1]);
564 gsi_insert_after (gsi
, g
, GSI_NEW_STMT
);
568 if (!integer_nonzerop (gimple_call_arg (stmt
, 3)))
572 gcc_assert (num
== 6);
573 for (j
= 0; j
< 6; j
++)
574 args
[j
] = gimple_call_arg (stmt
, j
);
575 if (!tree_fits_uhwi_p (args
[4])
576 || memmodel_base (tree_to_uhwi (args
[4])) >= MEMMODEL_LAST
)
578 if (!tree_fits_uhwi_p (args
[5])
579 || memmodel_base (tree_to_uhwi (args
[5])) >= MEMMODEL_LAST
)
581 update_gimple_call (gsi
, decl
, 5, args
[0], args
[1], args
[2],
586 gcc_assert (num
== 3);
587 for (j
= 0; j
< 3; j
++)
588 args
[j
] = gimple_call_arg (stmt
, j
);
589 t
= TYPE_ARG_TYPES (TREE_TYPE (decl
));
590 t
= TREE_VALUE (TREE_CHAIN (TREE_CHAIN (t
)));
591 t
= create_tmp_var (t
);
592 mark_addressable (t
);
593 if (!useless_type_conversion_p (TREE_TYPE (t
),
594 TREE_TYPE (args
[1])))
596 g
= gimple_build_assign (make_ssa_name (TREE_TYPE (t
)),
598 gsi_insert_before (gsi
, g
, GSI_SAME_STMT
);
599 args
[1] = gimple_assign_lhs (g
);
601 g
= gimple_build_assign (t
, args
[1]);
602 gsi_insert_before (gsi
, g
, GSI_SAME_STMT
);
603 lhs
= gimple_call_lhs (stmt
);
604 update_gimple_call (gsi
, decl
, 5, args
[0],
605 build_fold_addr_expr (t
), args
[2],
606 build_int_cst (NULL_TREE
,
608 build_int_cst (NULL_TREE
,
610 if (tsan_atomic_table
[i
].action
== val_cas
&& lhs
)
613 stmt
= gsi_stmt (*gsi
);
614 g
= gimple_build_assign (make_ssa_name (TREE_TYPE (t
)), t
);
615 gsi_insert_after (gsi
, g
, GSI_NEW_STMT
);
616 t
= make_ssa_name (TREE_TYPE (TREE_TYPE (decl
)), stmt
);
617 cond
= build2 (NE_EXPR
, boolean_type_node
, t
,
618 build_int_cst (TREE_TYPE (t
), 0));
619 g
= gimple_build_assign (lhs
, COND_EXPR
, cond
, args
[1],
620 gimple_assign_lhs (g
));
621 gimple_call_set_lhs (stmt
, t
);
623 gsi_insert_after (gsi
, g
, GSI_NEW_STMT
);
627 gcc_assert (num
== 1);
628 t
= TYPE_ARG_TYPES (TREE_TYPE (decl
));
629 t
= TREE_VALUE (TREE_CHAIN (t
));
630 update_gimple_call (gsi
, decl
, 3, gimple_call_arg (stmt
, 0),
631 build_int_cst (t
, 0),
632 build_int_cst (NULL_TREE
,
641 /* Instruments the gimple pointed to by GSI. Return
642 true if func entry/exit should be instrumented. */
645 instrument_gimple (gimple_stmt_iterator
*gsi
)
649 bool instrumented
= false;
651 stmt
= gsi_stmt (*gsi
);
652 if (is_gimple_call (stmt
)
653 && (gimple_call_fndecl (stmt
)
654 != builtin_decl_implicit (BUILT_IN_TSAN_INIT
)))
656 /* All functions with function call will have exit instrumented,
657 therefore no function calls other than __tsan_func_exit
658 shall appear in the functions. */
659 gimple_call_set_tail (as_a
<gcall
*> (stmt
), false);
660 if (gimple_call_builtin_p (stmt
, BUILT_IN_NORMAL
))
661 instrument_builtin_call (gsi
);
664 else if (is_gimple_assign (stmt
)
665 && !gimple_clobber_p (stmt
))
667 if (gimple_store_p (stmt
))
669 lhs
= gimple_assign_lhs (stmt
);
670 instrumented
= instrument_expr (*gsi
, lhs
, true);
672 if (gimple_assign_load_p (stmt
))
674 rhs
= gimple_assign_rhs1 (stmt
);
675 instrumented
= instrument_expr (*gsi
, rhs
, false);
681 /* Replace TSAN_FUNC_EXIT internal call with function exit tsan builtin. */
684 replace_func_exit (gimple
*stmt
)
686 tree builtin_decl
= builtin_decl_implicit (BUILT_IN_TSAN_FUNC_EXIT
);
687 gimple
*g
= gimple_build_call (builtin_decl
, 0);
688 gimple_set_location (g
, cfun
->function_end_locus
);
689 gimple_stmt_iterator gsi
= gsi_for_stmt (stmt
);
690 gsi_replace (&gsi
, g
, true);
693 /* Instrument function exit. Used when TSAN_FUNC_EXIT does not exist. */
696 instrument_func_exit (void)
700 gimple_stmt_iterator gsi
;
706 /* Find all function exits. */
707 exit_bb
= EXIT_BLOCK_PTR_FOR_FN (cfun
);
708 FOR_EACH_EDGE (e
, ei
, exit_bb
->preds
)
710 gsi
= gsi_last_bb (e
->src
);
711 stmt
= gsi_stmt (gsi
);
712 gcc_assert (gimple_code (stmt
) == GIMPLE_RETURN
713 || gimple_call_builtin_p (stmt
, BUILT_IN_RETURN
));
714 loc
= gimple_location (stmt
);
715 builtin_decl
= builtin_decl_implicit (BUILT_IN_TSAN_FUNC_EXIT
);
716 g
= gimple_build_call (builtin_decl
, 0);
717 gimple_set_location (g
, loc
);
718 gsi_insert_before (&gsi
, g
, GSI_SAME_STMT
);
722 /* Instruments all interesting memory accesses in the current function.
723 Return true if func entry/exit should be instrumented. */
726 instrument_memory_accesses (void)
729 gimple_stmt_iterator gsi
;
730 bool fentry_exit_instrument
= false;
731 bool func_exit_seen
= false;
732 auto_vec
<gimple
*> tsan_func_exits
;
734 FOR_EACH_BB_FN (bb
, cfun
)
735 for (gsi
= gsi_start_bb (bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
737 gimple
*stmt
= gsi_stmt (gsi
);
738 if (is_gimple_call (stmt
)
739 && gimple_call_internal_p (stmt
)
740 && gimple_call_internal_fn (stmt
) == IFN_TSAN_FUNC_EXIT
)
742 if (fentry_exit_instrument
)
743 replace_func_exit (stmt
);
745 tsan_func_exits
.safe_push (stmt
);
746 func_exit_seen
= true;
749 fentry_exit_instrument
|= instrument_gimple (&gsi
);
753 FOR_EACH_VEC_ELT (tsan_func_exits
, i
, stmt
)
754 if (fentry_exit_instrument
)
755 replace_func_exit (stmt
);
758 gsi
= gsi_for_stmt (stmt
);
759 gsi_remove (&gsi
, true);
761 if (fentry_exit_instrument
&& !func_exit_seen
)
762 instrument_func_exit ();
763 return fentry_exit_instrument
;
766 /* Instruments function entry. */
769 instrument_func_entry (void)
771 tree ret_addr
, builtin_decl
;
773 gimple_seq seq
= NULL
;
775 builtin_decl
= builtin_decl_implicit (BUILT_IN_RETURN_ADDRESS
);
776 g
= gimple_build_call (builtin_decl
, 1, integer_zero_node
);
777 ret_addr
= make_ssa_name (ptr_type_node
);
778 gimple_call_set_lhs (g
, ret_addr
);
779 gimple_set_location (g
, cfun
->function_start_locus
);
780 gimple_seq_add_stmt_without_update (&seq
, g
);
782 builtin_decl
= builtin_decl_implicit (BUILT_IN_TSAN_FUNC_ENTRY
);
783 g
= gimple_build_call (builtin_decl
, 1, ret_addr
);
784 gimple_set_location (g
, cfun
->function_start_locus
);
785 gimple_seq_add_stmt_without_update (&seq
, g
);
787 edge e
= single_succ_edge (ENTRY_BLOCK_PTR_FOR_FN (cfun
));
788 gsi_insert_seq_on_edge_immediate (e
, seq
);
791 /* ThreadSanitizer instrumentation pass. */
796 initialize_sanitizer_builtins ();
797 if (instrument_memory_accesses ())
798 instrument_func_entry ();
802 /* Inserts __tsan_init () into the list of CTORs. */
805 tsan_finish_file (void)
807 tree ctor_statements
= NULL_TREE
;
809 initialize_sanitizer_builtins ();
810 tree init_decl
= builtin_decl_implicit (BUILT_IN_TSAN_INIT
);
811 append_to_statement_list (build_call_expr (init_decl
, 0),
813 cgraph_build_static_cdtor ('I', ctor_statements
,
814 MAX_RESERVED_INIT_PRIORITY
- 1);
817 /* The pass descriptor. */
821 const pass_data pass_data_tsan
=
823 GIMPLE_PASS
, /* type */
825 OPTGROUP_NONE
, /* optinfo_flags */
827 ( PROP_ssa
| PROP_cfg
), /* properties_required */
828 0, /* properties_provided */
829 0, /* properties_destroyed */
830 0, /* todo_flags_start */
831 TODO_update_ssa
, /* todo_flags_finish */
834 class pass_tsan
: public gimple_opt_pass
837 pass_tsan (gcc::context
*ctxt
)
838 : gimple_opt_pass (pass_data_tsan
, ctxt
)
841 /* opt_pass methods: */
842 opt_pass
* clone () { return new pass_tsan (m_ctxt
); }
843 virtual bool gate (function
*)
845 return ((flag_sanitize
& SANITIZE_THREAD
) != 0
846 && !lookup_attribute ("no_sanitize_thread",
847 DECL_ATTRIBUTES (current_function_decl
)));
850 virtual unsigned int execute (function
*) { return tsan_pass (); }
852 }; // class pass_tsan
857 make_pass_tsan (gcc::context
*ctxt
)
859 return new pass_tsan (ctxt
);
864 const pass_data pass_data_tsan_O0
=
866 GIMPLE_PASS
, /* type */
868 OPTGROUP_NONE
, /* optinfo_flags */
870 ( PROP_ssa
| PROP_cfg
), /* properties_required */
871 0, /* properties_provided */
872 0, /* properties_destroyed */
873 0, /* todo_flags_start */
874 TODO_update_ssa
, /* todo_flags_finish */
877 class pass_tsan_O0
: public gimple_opt_pass
880 pass_tsan_O0 (gcc::context
*ctxt
)
881 : gimple_opt_pass (pass_data_tsan_O0
, ctxt
)
884 /* opt_pass methods: */
885 virtual bool gate (function
*)
887 return ((flag_sanitize
& SANITIZE_THREAD
) != 0 && !optimize
888 && !lookup_attribute ("no_sanitize_thread",
889 DECL_ATTRIBUTES (current_function_decl
)));
892 virtual unsigned int execute (function
*) { return tsan_pass (); }
894 }; // class pass_tsan_O0
899 make_pass_tsan_O0 (gcc::context
*ctxt
)
901 return new pass_tsan_O0 (ctxt
);