* varasm.c (bss_initializer_p): Remove static.
[official-gcc.git] / gcc / trans-mem.c
blob8762ad358bd9ece85025559404cd2189de163777
1 /* Passes for transactional memory support.
2 Copyright (C) 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 #include "config.h"
21 #include "system.h"
22 #include "coretypes.h"
23 #include "tree.h"
24 #include "gimple.h"
25 #include "tree-flow.h"
26 #include "tree-pass.h"
27 #include "tree-inline.h"
28 #include "diagnostic-core.h"
29 #include "demangle.h"
30 #include "output.h"
31 #include "trans-mem.h"
32 #include "params.h"
33 #include "target.h"
34 #include "langhooks.h"
35 #include "gimple-pretty-print.h"
36 #include "cfgloop.h"
39 #define PROB_VERY_UNLIKELY (REG_BR_PROB_BASE / 2000 - 1)
40 #define PROB_VERY_LIKELY (PROB_ALWAYS - PROB_VERY_UNLIKELY)
41 #define PROB_UNLIKELY (REG_BR_PROB_BASE / 5 - 1)
42 #define PROB_LIKELY (PROB_ALWAYS - PROB_VERY_LIKELY)
43 #define PROB_ALWAYS (REG_BR_PROB_BASE)
45 #define A_RUNINSTRUMENTEDCODE 0x0001
46 #define A_RUNUNINSTRUMENTEDCODE 0x0002
47 #define A_SAVELIVEVARIABLES 0x0004
48 #define A_RESTORELIVEVARIABLES 0x0008
49 #define A_ABORTTRANSACTION 0x0010
51 #define AR_USERABORT 0x0001
52 #define AR_USERRETRY 0x0002
53 #define AR_TMCONFLICT 0x0004
54 #define AR_EXCEPTIONBLOCKABORT 0x0008
55 #define AR_OUTERABORT 0x0010
57 #define MODE_SERIALIRREVOCABLE 0x0000
60 /* The representation of a transaction changes several times during the
61 lowering process. In the beginning, in the front-end we have the
62 GENERIC tree TRANSACTION_EXPR. For example,
64 __transaction {
65 local++;
66 if (++global == 10)
67 __tm_abort;
70 During initial gimplification (gimplify.c) the TRANSACTION_EXPR node is
71 trivially replaced with a GIMPLE_TRANSACTION node.
73 During pass_lower_tm, we examine the body of transactions looking
74 for aborts. Transactions that do not contain an abort may be
75 merged into an outer transaction. We also add a TRY-FINALLY node
76 to arrange for the transaction to be committed on any exit.
78 [??? Think about how this arrangement affects throw-with-commit
79 and throw-with-abort operations. In this case we want the TRY to
80 handle gotos, but not to catch any exceptions because the transaction
81 will already be closed.]
83 GIMPLE_TRANSACTION [label=NULL] {
84 try {
85 local = local + 1;
86 t0 = global;
87 t1 = t0 + 1;
88 global = t1;
89 if (t1 == 10)
90 __builtin___tm_abort ();
91 } finally {
92 __builtin___tm_commit ();
96 During pass_lower_eh, we create EH regions for the transactions,
97 intermixed with the regular EH stuff. This gives us a nice persistent
98 mapping (all the way through rtl) from transactional memory operation
99 back to the transaction, which allows us to get the abnormal edges
100 correct to model transaction aborts and restarts:
102 GIMPLE_TRANSACTION [label=over]
103 local = local + 1;
104 t0 = global;
105 t1 = t0 + 1;
106 global = t1;
107 if (t1 == 10)
108 __builtin___tm_abort ();
109 __builtin___tm_commit ();
110 over:
112 This is the end of all_lowering_passes, and so is what is present
113 during the IPA passes, and through all of the optimization passes.
115 During pass_ipa_tm, we examine all GIMPLE_TRANSACTION blocks in all
116 functions and mark functions for cloning.
118 At the end of gimple optimization, before exiting SSA form,
119 pass_tm_edges replaces statements that perform transactional
120 memory operations with the appropriate TM builtins, and swap
121 out function calls with their transactional clones. At this
122 point we introduce the abnormal transaction restart edges and
123 complete lowering of the GIMPLE_TRANSACTION node.
125 x = __builtin___tm_start (MAY_ABORT);
126 eh_label:
127 if (x & abort_transaction)
128 goto over;
129 local = local + 1;
130 t0 = __builtin___tm_load (global);
131 t1 = t0 + 1;
132 __builtin___tm_store (&global, t1);
133 if (t1 == 10)
134 __builtin___tm_abort ();
135 __builtin___tm_commit ();
136 over:
139 static void *expand_regions (struct tm_region *,
140 void *(*callback)(struct tm_region *, void *),
141 void *, bool);
144 /* Return the attributes we want to examine for X, or NULL if it's not
145 something we examine. We look at function types, but allow pointers
146 to function types and function decls and peek through. */
148 static tree
149 get_attrs_for (const_tree x)
151 switch (TREE_CODE (x))
153 case FUNCTION_DECL:
154 return TYPE_ATTRIBUTES (TREE_TYPE (x));
155 break;
157 default:
158 if (TYPE_P (x))
159 return NULL;
160 x = TREE_TYPE (x);
161 if (TREE_CODE (x) != POINTER_TYPE)
162 return NULL;
163 /* FALLTHRU */
165 case POINTER_TYPE:
166 x = TREE_TYPE (x);
167 if (TREE_CODE (x) != FUNCTION_TYPE && TREE_CODE (x) != METHOD_TYPE)
168 return NULL;
169 /* FALLTHRU */
171 case FUNCTION_TYPE:
172 case METHOD_TYPE:
173 return TYPE_ATTRIBUTES (x);
177 /* Return true if X has been marked TM_PURE. */
179 bool
180 is_tm_pure (const_tree x)
182 unsigned flags;
184 switch (TREE_CODE (x))
186 case FUNCTION_DECL:
187 case FUNCTION_TYPE:
188 case METHOD_TYPE:
189 break;
191 default:
192 if (TYPE_P (x))
193 return false;
194 x = TREE_TYPE (x);
195 if (TREE_CODE (x) != POINTER_TYPE)
196 return false;
197 /* FALLTHRU */
199 case POINTER_TYPE:
200 x = TREE_TYPE (x);
201 if (TREE_CODE (x) != FUNCTION_TYPE && TREE_CODE (x) != METHOD_TYPE)
202 return false;
203 break;
206 flags = flags_from_decl_or_type (x);
207 return (flags & ECF_TM_PURE) != 0;
210 /* Return true if X has been marked TM_IRREVOCABLE. */
212 static bool
213 is_tm_irrevocable (tree x)
215 tree attrs = get_attrs_for (x);
217 if (attrs && lookup_attribute ("transaction_unsafe", attrs))
218 return true;
220 /* A call to the irrevocable builtin is by definition,
221 irrevocable. */
222 if (TREE_CODE (x) == ADDR_EXPR)
223 x = TREE_OPERAND (x, 0);
224 if (TREE_CODE (x) == FUNCTION_DECL
225 && DECL_BUILT_IN_CLASS (x) == BUILT_IN_NORMAL
226 && DECL_FUNCTION_CODE (x) == BUILT_IN_TM_IRREVOCABLE)
227 return true;
229 return false;
232 /* Return true if X has been marked TM_SAFE. */
234 bool
235 is_tm_safe (const_tree x)
237 if (flag_tm)
239 tree attrs = get_attrs_for (x);
240 if (attrs)
242 if (lookup_attribute ("transaction_safe", attrs))
243 return true;
244 if (lookup_attribute ("transaction_may_cancel_outer", attrs))
245 return true;
248 return false;
251 /* Return true if CALL is const, or tm_pure. */
253 static bool
254 is_tm_pure_call (gimple call)
256 tree fn = gimple_call_fn (call);
258 if (TREE_CODE (fn) == ADDR_EXPR)
260 fn = TREE_OPERAND (fn, 0);
261 gcc_assert (TREE_CODE (fn) == FUNCTION_DECL);
263 else
264 fn = TREE_TYPE (fn);
266 return is_tm_pure (fn);
269 /* Return true if X has been marked TM_CALLABLE. */
271 static bool
272 is_tm_callable (tree x)
274 tree attrs = get_attrs_for (x);
275 if (attrs)
277 if (lookup_attribute ("transaction_callable", attrs))
278 return true;
279 if (lookup_attribute ("transaction_safe", attrs))
280 return true;
281 if (lookup_attribute ("transaction_may_cancel_outer", attrs))
282 return true;
284 return false;
287 /* Return true if X has been marked TRANSACTION_MAY_CANCEL_OUTER. */
289 bool
290 is_tm_may_cancel_outer (tree x)
292 tree attrs = get_attrs_for (x);
293 if (attrs)
294 return lookup_attribute ("transaction_may_cancel_outer", attrs) != NULL;
295 return false;
298 /* Return true for built in functions that "end" a transaction. */
300 bool
301 is_tm_ending_fndecl (tree fndecl)
303 if (DECL_BUILT_IN_CLASS (fndecl) == BUILT_IN_NORMAL)
304 switch (DECL_FUNCTION_CODE (fndecl))
306 case BUILT_IN_TM_COMMIT:
307 case BUILT_IN_TM_COMMIT_EH:
308 case BUILT_IN_TM_ABORT:
309 case BUILT_IN_TM_IRREVOCABLE:
310 return true;
311 default:
312 break;
315 return false;
318 /* Return true if STMT is a TM load. */
320 static bool
321 is_tm_load (gimple stmt)
323 tree fndecl;
325 if (gimple_code (stmt) != GIMPLE_CALL)
326 return false;
328 fndecl = gimple_call_fndecl (stmt);
329 return (fndecl && DECL_BUILT_IN_CLASS (fndecl) == BUILT_IN_NORMAL
330 && BUILTIN_TM_LOAD_P (DECL_FUNCTION_CODE (fndecl)));
333 /* Same as above, but for simple TM loads, that is, not the
334 after-write, after-read, etc optimized variants. */
336 static bool
337 is_tm_simple_load (gimple stmt)
339 tree fndecl;
341 if (gimple_code (stmt) != GIMPLE_CALL)
342 return false;
344 fndecl = gimple_call_fndecl (stmt);
345 if (fndecl && DECL_BUILT_IN_CLASS (fndecl) == BUILT_IN_NORMAL)
347 enum built_in_function fcode = DECL_FUNCTION_CODE (fndecl);
348 return (fcode == BUILT_IN_TM_LOAD_1
349 || fcode == BUILT_IN_TM_LOAD_2
350 || fcode == BUILT_IN_TM_LOAD_4
351 || fcode == BUILT_IN_TM_LOAD_8
352 || fcode == BUILT_IN_TM_LOAD_FLOAT
353 || fcode == BUILT_IN_TM_LOAD_DOUBLE
354 || fcode == BUILT_IN_TM_LOAD_LDOUBLE
355 || fcode == BUILT_IN_TM_LOAD_M64
356 || fcode == BUILT_IN_TM_LOAD_M128
357 || fcode == BUILT_IN_TM_LOAD_M256);
359 return false;
362 /* Return true if STMT is a TM store. */
364 static bool
365 is_tm_store (gimple stmt)
367 tree fndecl;
369 if (gimple_code (stmt) != GIMPLE_CALL)
370 return false;
372 fndecl = gimple_call_fndecl (stmt);
373 return (fndecl && DECL_BUILT_IN_CLASS (fndecl) == BUILT_IN_NORMAL
374 && BUILTIN_TM_STORE_P (DECL_FUNCTION_CODE (fndecl)));
377 /* Same as above, but for simple TM stores, that is, not the
378 after-write, after-read, etc optimized variants. */
380 static bool
381 is_tm_simple_store (gimple stmt)
383 tree fndecl;
385 if (gimple_code (stmt) != GIMPLE_CALL)
386 return false;
388 fndecl = gimple_call_fndecl (stmt);
389 if (fndecl && DECL_BUILT_IN_CLASS (fndecl) == BUILT_IN_NORMAL)
391 enum built_in_function fcode = DECL_FUNCTION_CODE (fndecl);
392 return (fcode == BUILT_IN_TM_STORE_1
393 || fcode == BUILT_IN_TM_STORE_2
394 || fcode == BUILT_IN_TM_STORE_4
395 || fcode == BUILT_IN_TM_STORE_8
396 || fcode == BUILT_IN_TM_STORE_FLOAT
397 || fcode == BUILT_IN_TM_STORE_DOUBLE
398 || fcode == BUILT_IN_TM_STORE_LDOUBLE
399 || fcode == BUILT_IN_TM_STORE_M64
400 || fcode == BUILT_IN_TM_STORE_M128
401 || fcode == BUILT_IN_TM_STORE_M256);
403 return false;
406 /* Return true if FNDECL is BUILT_IN_TM_ABORT. */
408 static bool
409 is_tm_abort (tree fndecl)
411 return (fndecl
412 && DECL_BUILT_IN_CLASS (fndecl) == BUILT_IN_NORMAL
413 && DECL_FUNCTION_CODE (fndecl) == BUILT_IN_TM_ABORT);
416 /* Build a GENERIC tree for a user abort. This is called by front ends
417 while transforming the __tm_abort statement. */
419 tree
420 build_tm_abort_call (location_t loc, bool is_outer)
422 return build_call_expr_loc (loc, builtin_decl_explicit (BUILT_IN_TM_ABORT), 1,
423 build_int_cst (integer_type_node,
424 AR_USERABORT
425 | (is_outer ? AR_OUTERABORT : 0)));
428 /* Common gateing function for several of the TM passes. */
430 static bool
431 gate_tm (void)
433 return flag_tm;
436 /* Map for aribtrary function replacement under TM, as created
437 by the tm_wrap attribute. */
439 static GTY((if_marked ("tree_map_marked_p"), param_is (struct tree_map)))
440 htab_t tm_wrap_map;
442 void
443 record_tm_replacement (tree from, tree to)
445 struct tree_map **slot, *h;
447 /* Do not inline wrapper functions that will get replaced in the TM
448 pass.
450 Suppose you have foo() that will get replaced into tmfoo(). Make
451 sure the inliner doesn't try to outsmart us and inline foo()
452 before we get a chance to do the TM replacement. */
453 DECL_UNINLINABLE (from) = 1;
455 if (tm_wrap_map == NULL)
456 tm_wrap_map = htab_create_ggc (32, tree_map_hash, tree_map_eq, 0);
458 h = ggc_alloc_tree_map ();
459 h->hash = htab_hash_pointer (from);
460 h->base.from = from;
461 h->to = to;
463 slot = (struct tree_map **)
464 htab_find_slot_with_hash (tm_wrap_map, h, h->hash, INSERT);
465 *slot = h;
468 /* Return a TM-aware replacement function for DECL. */
470 static tree
471 find_tm_replacement_function (tree fndecl)
473 if (tm_wrap_map)
475 struct tree_map *h, in;
477 in.base.from = fndecl;
478 in.hash = htab_hash_pointer (fndecl);
479 h = (struct tree_map *) htab_find_with_hash (tm_wrap_map, &in, in.hash);
480 if (h)
481 return h->to;
484 /* ??? We may well want TM versions of most of the common <string.h>
485 functions. For now, we've already these two defined. */
486 /* Adjust expand_call_tm() attributes as necessary for the cases
487 handled here: */
488 if (DECL_BUILT_IN_CLASS (fndecl) == BUILT_IN_NORMAL)
489 switch (DECL_FUNCTION_CODE (fndecl))
491 case BUILT_IN_MEMCPY:
492 return builtin_decl_explicit (BUILT_IN_TM_MEMCPY);
493 case BUILT_IN_MEMMOVE:
494 return builtin_decl_explicit (BUILT_IN_TM_MEMMOVE);
495 case BUILT_IN_MEMSET:
496 return builtin_decl_explicit (BUILT_IN_TM_MEMSET);
497 default:
498 return NULL;
501 return NULL;
504 /* When appropriate, record TM replacement for memory allocation functions.
506 FROM is the FNDECL to wrap. */
507 void
508 tm_malloc_replacement (tree from)
510 const char *str;
511 tree to;
513 if (TREE_CODE (from) != FUNCTION_DECL)
514 return;
516 /* If we have a previous replacement, the user must be explicitly
517 wrapping malloc/calloc/free. They better know what they're
518 doing... */
519 if (find_tm_replacement_function (from))
520 return;
522 str = IDENTIFIER_POINTER (DECL_NAME (from));
524 if (!strcmp (str, "malloc"))
525 to = builtin_decl_explicit (BUILT_IN_TM_MALLOC);
526 else if (!strcmp (str, "calloc"))
527 to = builtin_decl_explicit (BUILT_IN_TM_CALLOC);
528 else if (!strcmp (str, "free"))
529 to = builtin_decl_explicit (BUILT_IN_TM_FREE);
530 else
531 return;
533 TREE_NOTHROW (to) = 0;
535 record_tm_replacement (from, to);
538 /* Diagnostics for tm_safe functions/regions. Called by the front end
539 once we've lowered the function to high-gimple. */
541 /* Subroutine of diagnose_tm_safe_errors, called through walk_gimple_seq.
542 Process exactly one statement. WI->INFO is set to non-null when in
543 the context of a tm_safe function, and null for a __transaction block. */
545 #define DIAG_TM_OUTER 1
546 #define DIAG_TM_SAFE 2
547 #define DIAG_TM_RELAXED 4
549 struct diagnose_tm
551 unsigned int summary_flags : 8;
552 unsigned int block_flags : 8;
553 unsigned int func_flags : 8;
554 unsigned int saw_volatile : 1;
555 gimple stmt;
558 /* Return true if T is a volatile variable of some kind. */
560 static bool
561 volatile_var_p (tree t)
563 return (SSA_VAR_P (t)
564 && TREE_THIS_VOLATILE (TREE_TYPE (t)));
567 /* Tree callback function for diagnose_tm pass. */
569 static tree
570 diagnose_tm_1_op (tree *tp, int *walk_subtrees ATTRIBUTE_UNUSED,
571 void *data)
573 struct walk_stmt_info *wi = (struct walk_stmt_info *) data;
574 struct diagnose_tm *d = (struct diagnose_tm *) wi->info;
576 if (volatile_var_p (*tp)
577 && d->block_flags & DIAG_TM_SAFE
578 && !d->saw_volatile)
580 d->saw_volatile = 1;
581 error_at (gimple_location (d->stmt),
582 "invalid volatile use of %qD inside transaction",
583 *tp);
586 return NULL_TREE;
589 static tree
590 diagnose_tm_1 (gimple_stmt_iterator *gsi, bool *handled_ops_p,
591 struct walk_stmt_info *wi)
593 gimple stmt = gsi_stmt (*gsi);
594 struct diagnose_tm *d = (struct diagnose_tm *) wi->info;
596 /* Save stmt for use in leaf analysis. */
597 d->stmt = stmt;
599 switch (gimple_code (stmt))
601 case GIMPLE_CALL:
603 tree fn = gimple_call_fn (stmt);
605 if ((d->summary_flags & DIAG_TM_OUTER) == 0
606 && is_tm_may_cancel_outer (fn))
607 error_at (gimple_location (stmt),
608 "%<transaction_may_cancel_outer%> function call not within"
609 " outer transaction or %<transaction_may_cancel_outer%>");
611 if (d->summary_flags & DIAG_TM_SAFE)
613 bool is_safe, direct_call_p;
614 tree replacement;
616 if (TREE_CODE (fn) == ADDR_EXPR
617 && TREE_CODE (TREE_OPERAND (fn, 0)) == FUNCTION_DECL)
619 direct_call_p = true;
620 replacement = TREE_OPERAND (fn, 0);
621 replacement = find_tm_replacement_function (replacement);
622 if (replacement)
623 fn = replacement;
625 else
627 direct_call_p = false;
628 replacement = NULL_TREE;
631 if (is_tm_safe_or_pure (fn))
632 is_safe = true;
633 else if (is_tm_callable (fn) || is_tm_irrevocable (fn))
635 /* A function explicitly marked transaction_callable as
636 opposed to transaction_safe is being defined to be
637 unsafe as part of its ABI, regardless of its contents. */
638 is_safe = false;
640 else if (direct_call_p)
642 if (flags_from_decl_or_type (fn) & ECF_TM_BUILTIN)
643 is_safe = true;
644 else if (replacement)
646 /* ??? At present we've been considering replacements
647 merely transaction_callable, and therefore might
648 enter irrevocable. The tm_wrap attribute has not
649 yet made it into the new language spec. */
650 is_safe = false;
652 else
654 /* ??? Diagnostics for unmarked direct calls moved into
655 the IPA pass. Section 3.2 of the spec details how
656 functions not marked should be considered "implicitly
657 safe" based on having examined the function body. */
658 is_safe = true;
661 else
663 /* An unmarked indirect call. Consider it unsafe even
664 though optimization may yet figure out how to inline. */
665 is_safe = false;
668 if (!is_safe)
670 if (TREE_CODE (fn) == ADDR_EXPR)
671 fn = TREE_OPERAND (fn, 0);
672 if (d->block_flags & DIAG_TM_SAFE)
674 if (direct_call_p)
675 error_at (gimple_location (stmt),
676 "unsafe function call %qD within "
677 "atomic transaction", fn);
678 else
680 if (!DECL_P (fn) || DECL_NAME (fn))
681 error_at (gimple_location (stmt),
682 "unsafe function call %qE within "
683 "atomic transaction", fn);
684 else
685 error_at (gimple_location (stmt),
686 "unsafe indirect function call within "
687 "atomic transaction");
690 else
692 if (direct_call_p)
693 error_at (gimple_location (stmt),
694 "unsafe function call %qD within "
695 "%<transaction_safe%> function", fn);
696 else
698 if (!DECL_P (fn) || DECL_NAME (fn))
699 error_at (gimple_location (stmt),
700 "unsafe function call %qE within "
701 "%<transaction_safe%> function", fn);
702 else
703 error_at (gimple_location (stmt),
704 "unsafe indirect function call within "
705 "%<transaction_safe%> function");
711 break;
713 case GIMPLE_ASM:
714 /* ??? We ought to come up with a way to add attributes to
715 asm statements, and then add "transaction_safe" to it.
716 Either that or get the language spec to resurrect __tm_waiver. */
717 if (d->block_flags & DIAG_TM_SAFE)
718 error_at (gimple_location (stmt),
719 "asm not allowed in atomic transaction");
720 else if (d->func_flags & DIAG_TM_SAFE)
721 error_at (gimple_location (stmt),
722 "asm not allowed in %<transaction_safe%> function");
723 break;
725 case GIMPLE_TRANSACTION:
727 unsigned char inner_flags = DIAG_TM_SAFE;
729 if (gimple_transaction_subcode (stmt) & GTMA_IS_RELAXED)
731 if (d->block_flags & DIAG_TM_SAFE)
732 error_at (gimple_location (stmt),
733 "relaxed transaction in atomic transaction");
734 else if (d->func_flags & DIAG_TM_SAFE)
735 error_at (gimple_location (stmt),
736 "relaxed transaction in %<transaction_safe%> function");
737 inner_flags = DIAG_TM_RELAXED;
739 else if (gimple_transaction_subcode (stmt) & GTMA_IS_OUTER)
741 if (d->block_flags)
742 error_at (gimple_location (stmt),
743 "outer transaction in transaction");
744 else if (d->func_flags & DIAG_TM_OUTER)
745 error_at (gimple_location (stmt),
746 "outer transaction in "
747 "%<transaction_may_cancel_outer%> function");
748 else if (d->func_flags & DIAG_TM_SAFE)
749 error_at (gimple_location (stmt),
750 "outer transaction in %<transaction_safe%> function");
751 inner_flags |= DIAG_TM_OUTER;
754 *handled_ops_p = true;
755 if (gimple_transaction_body (stmt))
757 struct walk_stmt_info wi_inner;
758 struct diagnose_tm d_inner;
760 memset (&d_inner, 0, sizeof (d_inner));
761 d_inner.func_flags = d->func_flags;
762 d_inner.block_flags = d->block_flags | inner_flags;
763 d_inner.summary_flags = d_inner.func_flags | d_inner.block_flags;
765 memset (&wi_inner, 0, sizeof (wi_inner));
766 wi_inner.info = &d_inner;
768 walk_gimple_seq (gimple_transaction_body (stmt),
769 diagnose_tm_1, diagnose_tm_1_op, &wi_inner);
772 break;
774 default:
775 break;
778 return NULL_TREE;
781 static unsigned int
782 diagnose_tm_blocks (void)
784 struct walk_stmt_info wi;
785 struct diagnose_tm d;
787 memset (&d, 0, sizeof (d));
788 if (is_tm_may_cancel_outer (current_function_decl))
789 d.func_flags = DIAG_TM_OUTER | DIAG_TM_SAFE;
790 else if (is_tm_safe (current_function_decl))
791 d.func_flags = DIAG_TM_SAFE;
792 d.summary_flags = d.func_flags;
794 memset (&wi, 0, sizeof (wi));
795 wi.info = &d;
797 walk_gimple_seq (gimple_body (current_function_decl),
798 diagnose_tm_1, diagnose_tm_1_op, &wi);
800 return 0;
803 struct gimple_opt_pass pass_diagnose_tm_blocks =
806 GIMPLE_PASS,
807 "*diagnose_tm_blocks", /* name */
808 OPTGROUP_NONE, /* optinfo_flags */
809 gate_tm, /* gate */
810 diagnose_tm_blocks, /* execute */
811 NULL, /* sub */
812 NULL, /* next */
813 0, /* static_pass_number */
814 TV_TRANS_MEM, /* tv_id */
815 PROP_gimple_any, /* properties_required */
816 0, /* properties_provided */
817 0, /* properties_destroyed */
818 0, /* todo_flags_start */
819 0, /* todo_flags_finish */
823 /* Instead of instrumenting thread private memory, we save the
824 addresses in a log which we later use to save/restore the addresses
825 upon transaction start/restart.
827 The log is keyed by address, where each element contains individual
828 statements among different code paths that perform the store.
830 This log is later used to generate either plain save/restore of the
831 addresses upon transaction start/restart, or calls to the ITM_L*
832 logging functions.
834 So for something like:
836 struct large { int x[1000]; };
837 struct large lala = { 0 };
838 __transaction {
839 lala.x[i] = 123;
843 We can either save/restore:
845 lala = { 0 };
846 trxn = _ITM_startTransaction ();
847 if (trxn & a_saveLiveVariables)
848 tmp_lala1 = lala.x[i];
849 else if (a & a_restoreLiveVariables)
850 lala.x[i] = tmp_lala1;
852 or use the logging functions:
854 lala = { 0 };
855 trxn = _ITM_startTransaction ();
856 _ITM_LU4 (&lala.x[i]);
858 Obviously, if we use _ITM_L* to log, we prefer to call _ITM_L* as
859 far up the dominator tree to shadow all of the writes to a given
860 location (thus reducing the total number of logging calls), but not
861 so high as to be called on a path that does not perform a
862 write. */
864 /* One individual log entry. We may have multiple statements for the
865 same location if neither dominate each other (on different
866 execution paths). */
867 typedef struct tm_log_entry
869 /* Address to save. */
870 tree addr;
871 /* Entry block for the transaction this address occurs in. */
872 basic_block entry_block;
873 /* Dominating statements the store occurs in. */
874 gimple_vec stmts;
875 /* Initially, while we are building the log, we place a nonzero
876 value here to mean that this address *will* be saved with a
877 save/restore sequence. Later, when generating the save sequence
878 we place the SSA temp generated here. */
879 tree save_var;
880 } *tm_log_entry_t;
882 /* The actual log. */
883 static htab_t tm_log;
885 /* Addresses to log with a save/restore sequence. These should be in
886 dominator order. */
887 static vec<tree> tm_log_save_addresses;
889 /* Map for an SSA_NAME originally pointing to a non aliased new piece
890 of memory (malloc, alloc, etc). */
891 static htab_t tm_new_mem_hash;
893 enum thread_memory_type
895 mem_non_local = 0,
896 mem_thread_local,
897 mem_transaction_local,
898 mem_max
901 typedef struct tm_new_mem_map
903 /* SSA_NAME being dereferenced. */
904 tree val;
905 enum thread_memory_type local_new_memory;
906 } tm_new_mem_map_t;
908 /* Htab support. Return hash value for a `tm_log_entry'. */
909 static hashval_t
910 tm_log_hash (const void *p)
912 const struct tm_log_entry *log = (const struct tm_log_entry *) p;
913 return iterative_hash_expr (log->addr, 0);
916 /* Htab support. Return true if two log entries are the same. */
917 static int
918 tm_log_eq (const void *p1, const void *p2)
920 const struct tm_log_entry *log1 = (const struct tm_log_entry *) p1;
921 const struct tm_log_entry *log2 = (const struct tm_log_entry *) p2;
923 /* FIXME:
925 rth: I suggest that we get rid of the component refs etc.
926 I.e. resolve the reference to base + offset.
928 We may need to actually finish a merge with mainline for this,
929 since we'd like to be presented with Richi's MEM_REF_EXPRs more
930 often than not. But in the meantime your tm_log_entry could save
931 the results of get_inner_reference.
933 See: g++.dg/tm/pr46653.C
936 /* Special case plain equality because operand_equal_p() below will
937 return FALSE if the addresses are equal but they have
938 side-effects (e.g. a volatile address). */
939 if (log1->addr == log2->addr)
940 return true;
942 return operand_equal_p (log1->addr, log2->addr, 0);
945 /* Htab support. Free one tm_log_entry. */
946 static void
947 tm_log_free (void *p)
949 struct tm_log_entry *lp = (struct tm_log_entry *) p;
950 lp->stmts.release ();
951 free (lp);
954 /* Initialize logging data structures. */
955 static void
956 tm_log_init (void)
958 tm_log = htab_create (10, tm_log_hash, tm_log_eq, tm_log_free);
959 tm_new_mem_hash = htab_create (5, struct_ptr_hash, struct_ptr_eq, free);
960 tm_log_save_addresses.create (5);
963 /* Free logging data structures. */
964 static void
965 tm_log_delete (void)
967 htab_delete (tm_log);
968 htab_delete (tm_new_mem_hash);
969 tm_log_save_addresses.release ();
972 /* Return true if MEM is a transaction invariant memory for the TM
973 region starting at REGION_ENTRY_BLOCK. */
974 static bool
975 transaction_invariant_address_p (const_tree mem, basic_block region_entry_block)
977 if ((TREE_CODE (mem) == INDIRECT_REF || TREE_CODE (mem) == MEM_REF)
978 && TREE_CODE (TREE_OPERAND (mem, 0)) == SSA_NAME)
980 basic_block def_bb;
982 def_bb = gimple_bb (SSA_NAME_DEF_STMT (TREE_OPERAND (mem, 0)));
983 return def_bb != region_entry_block
984 && dominated_by_p (CDI_DOMINATORS, region_entry_block, def_bb);
987 mem = strip_invariant_refs (mem);
988 return mem && (CONSTANT_CLASS_P (mem) || decl_address_invariant_p (mem));
991 /* Given an address ADDR in STMT, find it in the memory log or add it,
992 making sure to keep only the addresses highest in the dominator
993 tree.
995 ENTRY_BLOCK is the entry_block for the transaction.
997 If we find the address in the log, make sure it's either the same
998 address, or an equivalent one that dominates ADDR.
1000 If we find the address, but neither ADDR dominates the found
1001 address, nor the found one dominates ADDR, we're on different
1002 execution paths. Add it.
1004 If known, ENTRY_BLOCK is the entry block for the region, otherwise
1005 NULL. */
1006 static void
1007 tm_log_add (basic_block entry_block, tree addr, gimple stmt)
1009 void **slot;
1010 struct tm_log_entry l, *lp;
1012 l.addr = addr;
1013 slot = htab_find_slot (tm_log, &l, INSERT);
1014 if (!*slot)
1016 tree type = TREE_TYPE (addr);
1018 lp = XNEW (struct tm_log_entry);
1019 lp->addr = addr;
1020 *slot = lp;
1022 /* Small invariant addresses can be handled as save/restores. */
1023 if (entry_block
1024 && transaction_invariant_address_p (lp->addr, entry_block)
1025 && TYPE_SIZE_UNIT (type) != NULL
1026 && host_integerp (TYPE_SIZE_UNIT (type), 1)
1027 && (tree_low_cst (TYPE_SIZE_UNIT (type), 1)
1028 < PARAM_VALUE (PARAM_TM_MAX_AGGREGATE_SIZE))
1029 /* We must be able to copy this type normally. I.e., no
1030 special constructors and the like. */
1031 && !TREE_ADDRESSABLE (type))
1033 lp->save_var = create_tmp_reg (TREE_TYPE (lp->addr), "tm_save");
1034 lp->stmts.create (0);
1035 lp->entry_block = entry_block;
1036 /* Save addresses separately in dominator order so we don't
1037 get confused by overlapping addresses in the save/restore
1038 sequence. */
1039 tm_log_save_addresses.safe_push (lp->addr);
1041 else
1043 /* Use the logging functions. */
1044 lp->stmts.create (5);
1045 lp->stmts.quick_push (stmt);
1046 lp->save_var = NULL;
1049 else
1051 size_t i;
1052 gimple oldstmt;
1054 lp = (struct tm_log_entry *) *slot;
1056 /* If we're generating a save/restore sequence, we don't care
1057 about statements. */
1058 if (lp->save_var)
1059 return;
1061 for (i = 0; lp->stmts.iterate (i, &oldstmt); ++i)
1063 if (stmt == oldstmt)
1064 return;
1065 /* We already have a store to the same address, higher up the
1066 dominator tree. Nothing to do. */
1067 if (dominated_by_p (CDI_DOMINATORS,
1068 gimple_bb (stmt), gimple_bb (oldstmt)))
1069 return;
1070 /* We should be processing blocks in dominator tree order. */
1071 gcc_assert (!dominated_by_p (CDI_DOMINATORS,
1072 gimple_bb (oldstmt), gimple_bb (stmt)));
1074 /* Store is on a different code path. */
1075 lp->stmts.safe_push (stmt);
1079 /* Gimplify the address of a TARGET_MEM_REF. Return the SSA_NAME
1080 result, insert the new statements before GSI. */
1082 static tree
1083 gimplify_addr (gimple_stmt_iterator *gsi, tree x)
1085 if (TREE_CODE (x) == TARGET_MEM_REF)
1086 x = tree_mem_ref_addr (build_pointer_type (TREE_TYPE (x)), x);
1087 else
1088 x = build_fold_addr_expr (x);
1089 return force_gimple_operand_gsi (gsi, x, true, NULL, true, GSI_SAME_STMT);
1092 /* Instrument one address with the logging functions.
1093 ADDR is the address to save.
1094 STMT is the statement before which to place it. */
1095 static void
1096 tm_log_emit_stmt (tree addr, gimple stmt)
1098 tree type = TREE_TYPE (addr);
1099 tree size = TYPE_SIZE_UNIT (type);
1100 gimple_stmt_iterator gsi = gsi_for_stmt (stmt);
1101 gimple log;
1102 enum built_in_function code = BUILT_IN_TM_LOG;
1104 if (type == float_type_node)
1105 code = BUILT_IN_TM_LOG_FLOAT;
1106 else if (type == double_type_node)
1107 code = BUILT_IN_TM_LOG_DOUBLE;
1108 else if (type == long_double_type_node)
1109 code = BUILT_IN_TM_LOG_LDOUBLE;
1110 else if (host_integerp (size, 1))
1112 unsigned int n = tree_low_cst (size, 1);
1113 switch (n)
1115 case 1:
1116 code = BUILT_IN_TM_LOG_1;
1117 break;
1118 case 2:
1119 code = BUILT_IN_TM_LOG_2;
1120 break;
1121 case 4:
1122 code = BUILT_IN_TM_LOG_4;
1123 break;
1124 case 8:
1125 code = BUILT_IN_TM_LOG_8;
1126 break;
1127 default:
1128 code = BUILT_IN_TM_LOG;
1129 if (TREE_CODE (type) == VECTOR_TYPE)
1131 if (n == 8 && builtin_decl_explicit (BUILT_IN_TM_LOG_M64))
1132 code = BUILT_IN_TM_LOG_M64;
1133 else if (n == 16 && builtin_decl_explicit (BUILT_IN_TM_LOG_M128))
1134 code = BUILT_IN_TM_LOG_M128;
1135 else if (n == 32 && builtin_decl_explicit (BUILT_IN_TM_LOG_M256))
1136 code = BUILT_IN_TM_LOG_M256;
1138 break;
1142 addr = gimplify_addr (&gsi, addr);
1143 if (code == BUILT_IN_TM_LOG)
1144 log = gimple_build_call (builtin_decl_explicit (code), 2, addr, size);
1145 else
1146 log = gimple_build_call (builtin_decl_explicit (code), 1, addr);
1147 gsi_insert_before (&gsi, log, GSI_SAME_STMT);
1150 /* Go through the log and instrument address that must be instrumented
1151 with the logging functions. Leave the save/restore addresses for
1152 later. */
1153 static void
1154 tm_log_emit (void)
1156 htab_iterator hi;
1157 struct tm_log_entry *lp;
1159 FOR_EACH_HTAB_ELEMENT (tm_log, lp, tm_log_entry_t, hi)
1161 size_t i;
1162 gimple stmt;
1164 if (dump_file)
1166 fprintf (dump_file, "TM thread private mem logging: ");
1167 print_generic_expr (dump_file, lp->addr, 0);
1168 fprintf (dump_file, "\n");
1171 if (lp->save_var)
1173 if (dump_file)
1174 fprintf (dump_file, "DUMPING to variable\n");
1175 continue;
1177 else
1179 if (dump_file)
1180 fprintf (dump_file, "DUMPING with logging functions\n");
1181 for (i = 0; lp->stmts.iterate (i, &stmt); ++i)
1182 tm_log_emit_stmt (lp->addr, stmt);
1187 /* Emit the save sequence for the corresponding addresses in the log.
1188 ENTRY_BLOCK is the entry block for the transaction.
1189 BB is the basic block to insert the code in. */
1190 static void
1191 tm_log_emit_saves (basic_block entry_block, basic_block bb)
1193 size_t i;
1194 gimple_stmt_iterator gsi = gsi_last_bb (bb);
1195 gimple stmt;
1196 struct tm_log_entry l, *lp;
1198 for (i = 0; i < tm_log_save_addresses.length (); ++i)
1200 l.addr = tm_log_save_addresses[i];
1201 lp = (struct tm_log_entry *) *htab_find_slot (tm_log, &l, NO_INSERT);
1202 gcc_assert (lp->save_var != NULL);
1204 /* We only care about variables in the current transaction. */
1205 if (lp->entry_block != entry_block)
1206 continue;
1208 stmt = gimple_build_assign (lp->save_var, unshare_expr (lp->addr));
1210 /* Make sure we can create an SSA_NAME for this type. For
1211 instance, aggregates aren't allowed, in which case the system
1212 will create a VOP for us and everything will just work. */
1213 if (is_gimple_reg_type (TREE_TYPE (lp->save_var)))
1215 lp->save_var = make_ssa_name (lp->save_var, stmt);
1216 gimple_assign_set_lhs (stmt, lp->save_var);
1219 gsi_insert_before (&gsi, stmt, GSI_SAME_STMT);
1223 /* Emit the restore sequence for the corresponding addresses in the log.
1224 ENTRY_BLOCK is the entry block for the transaction.
1225 BB is the basic block to insert the code in. */
1226 static void
1227 tm_log_emit_restores (basic_block entry_block, basic_block bb)
1229 int i;
1230 struct tm_log_entry l, *lp;
1231 gimple_stmt_iterator gsi;
1232 gimple stmt;
1234 for (i = tm_log_save_addresses.length () - 1; i >= 0; i--)
1236 l.addr = tm_log_save_addresses[i];
1237 lp = (struct tm_log_entry *) *htab_find_slot (tm_log, &l, NO_INSERT);
1238 gcc_assert (lp->save_var != NULL);
1240 /* We only care about variables in the current transaction. */
1241 if (lp->entry_block != entry_block)
1242 continue;
1244 /* Restores are in LIFO order from the saves in case we have
1245 overlaps. */
1246 gsi = gsi_start_bb (bb);
1248 stmt = gimple_build_assign (unshare_expr (lp->addr), lp->save_var);
1249 gsi_insert_after (&gsi, stmt, GSI_CONTINUE_LINKING);
1254 static tree lower_sequence_tm (gimple_stmt_iterator *, bool *,
1255 struct walk_stmt_info *);
1256 static tree lower_sequence_no_tm (gimple_stmt_iterator *, bool *,
1257 struct walk_stmt_info *);
1259 /* Evaluate an address X being dereferenced and determine if it
1260 originally points to a non aliased new chunk of memory (malloc,
1261 alloca, etc).
1263 Return MEM_THREAD_LOCAL if it points to a thread-local address.
1264 Return MEM_TRANSACTION_LOCAL if it points to a transaction-local address.
1265 Return MEM_NON_LOCAL otherwise.
1267 ENTRY_BLOCK is the entry block to the transaction containing the
1268 dereference of X. */
1269 static enum thread_memory_type
1270 thread_private_new_memory (basic_block entry_block, tree x)
1272 gimple stmt = NULL;
1273 enum tree_code code;
1274 void **slot;
1275 tm_new_mem_map_t elt, *elt_p;
1276 tree val = x;
1277 enum thread_memory_type retval = mem_transaction_local;
1279 if (!entry_block
1280 || TREE_CODE (x) != SSA_NAME
1281 /* Possible uninitialized use, or a function argument. In
1282 either case, we don't care. */
1283 || SSA_NAME_IS_DEFAULT_DEF (x))
1284 return mem_non_local;
1286 /* Look in cache first. */
1287 elt.val = x;
1288 slot = htab_find_slot (tm_new_mem_hash, &elt, INSERT);
1289 elt_p = (tm_new_mem_map_t *) *slot;
1290 if (elt_p)
1291 return elt_p->local_new_memory;
1293 /* Optimistically assume the memory is transaction local during
1294 processing. This catches recursion into this variable. */
1295 *slot = elt_p = XNEW (tm_new_mem_map_t);
1296 elt_p->val = val;
1297 elt_p->local_new_memory = mem_transaction_local;
1299 /* Search DEF chain to find the original definition of this address. */
1302 if (ptr_deref_may_alias_global_p (x))
1304 /* Address escapes. This is not thread-private. */
1305 retval = mem_non_local;
1306 goto new_memory_ret;
1309 stmt = SSA_NAME_DEF_STMT (x);
1311 /* If the malloc call is outside the transaction, this is
1312 thread-local. */
1313 if (retval != mem_thread_local
1314 && !dominated_by_p (CDI_DOMINATORS, gimple_bb (stmt), entry_block))
1315 retval = mem_thread_local;
1317 if (is_gimple_assign (stmt))
1319 code = gimple_assign_rhs_code (stmt);
1320 /* x = foo ==> foo */
1321 if (code == SSA_NAME)
1322 x = gimple_assign_rhs1 (stmt);
1323 /* x = foo + n ==> foo */
1324 else if (code == POINTER_PLUS_EXPR)
1325 x = gimple_assign_rhs1 (stmt);
1326 /* x = (cast*) foo ==> foo */
1327 else if (code == VIEW_CONVERT_EXPR || code == NOP_EXPR)
1328 x = gimple_assign_rhs1 (stmt);
1329 /* x = c ? op1 : op2 == > op1 or op2 just like a PHI */
1330 else if (code == COND_EXPR)
1332 tree op1 = gimple_assign_rhs2 (stmt);
1333 tree op2 = gimple_assign_rhs3 (stmt);
1334 enum thread_memory_type mem;
1335 retval = thread_private_new_memory (entry_block, op1);
1336 if (retval == mem_non_local)
1337 goto new_memory_ret;
1338 mem = thread_private_new_memory (entry_block, op2);
1339 retval = MIN (retval, mem);
1340 goto new_memory_ret;
1342 else
1344 retval = mem_non_local;
1345 goto new_memory_ret;
1348 else
1350 if (gimple_code (stmt) == GIMPLE_PHI)
1352 unsigned int i;
1353 enum thread_memory_type mem;
1354 tree phi_result = gimple_phi_result (stmt);
1356 /* If any of the ancestors are non-local, we are sure to
1357 be non-local. Otherwise we can avoid doing anything
1358 and inherit what has already been generated. */
1359 retval = mem_max;
1360 for (i = 0; i < gimple_phi_num_args (stmt); ++i)
1362 tree op = PHI_ARG_DEF (stmt, i);
1364 /* Exclude self-assignment. */
1365 if (phi_result == op)
1366 continue;
1368 mem = thread_private_new_memory (entry_block, op);
1369 if (mem == mem_non_local)
1371 retval = mem;
1372 goto new_memory_ret;
1374 retval = MIN (retval, mem);
1376 goto new_memory_ret;
1378 break;
1381 while (TREE_CODE (x) == SSA_NAME);
1383 if (stmt && is_gimple_call (stmt) && gimple_call_flags (stmt) & ECF_MALLOC)
1384 /* Thread-local or transaction-local. */
1386 else
1387 retval = mem_non_local;
1389 new_memory_ret:
1390 elt_p->local_new_memory = retval;
1391 return retval;
1394 /* Determine whether X has to be instrumented using a read
1395 or write barrier.
1397 ENTRY_BLOCK is the entry block for the region where stmt resides
1398 in. NULL if unknown.
1400 STMT is the statement in which X occurs in. It is used for thread
1401 private memory instrumentation. If no TPM instrumentation is
1402 desired, STMT should be null. */
1403 static bool
1404 requires_barrier (basic_block entry_block, tree x, gimple stmt)
1406 tree orig = x;
1407 while (handled_component_p (x))
1408 x = TREE_OPERAND (x, 0);
1410 switch (TREE_CODE (x))
1412 case INDIRECT_REF:
1413 case MEM_REF:
1415 enum thread_memory_type ret;
1417 ret = thread_private_new_memory (entry_block, TREE_OPERAND (x, 0));
1418 if (ret == mem_non_local)
1419 return true;
1420 if (stmt && ret == mem_thread_local)
1421 /* ?? Should we pass `orig', or the INDIRECT_REF X. ?? */
1422 tm_log_add (entry_block, orig, stmt);
1424 /* Transaction-locals require nothing at all. For malloc, a
1425 transaction restart frees the memory and we reallocate.
1426 For alloca, the stack pointer gets reset by the retry and
1427 we reallocate. */
1428 return false;
1431 case TARGET_MEM_REF:
1432 if (TREE_CODE (TMR_BASE (x)) != ADDR_EXPR)
1433 return true;
1434 x = TREE_OPERAND (TMR_BASE (x), 0);
1435 if (TREE_CODE (x) == PARM_DECL)
1436 return false;
1437 gcc_assert (TREE_CODE (x) == VAR_DECL);
1438 /* FALLTHRU */
1440 case PARM_DECL:
1441 case RESULT_DECL:
1442 case VAR_DECL:
1443 if (DECL_BY_REFERENCE (x))
1445 /* ??? This value is a pointer, but aggregate_value_p has been
1446 jigged to return true which confuses needs_to_live_in_memory.
1447 This ought to be cleaned up generically.
1449 FIXME: Verify this still happens after the next mainline
1450 merge. Testcase ie g++.dg/tm/pr47554.C.
1452 return false;
1455 if (is_global_var (x))
1456 return !TREE_READONLY (x);
1457 if (/* FIXME: This condition should actually go below in the
1458 tm_log_add() call, however is_call_clobbered() depends on
1459 aliasing info which is not available during
1460 gimplification. Since requires_barrier() gets called
1461 during lower_sequence_tm/gimplification, leave the call
1462 to needs_to_live_in_memory until we eliminate
1463 lower_sequence_tm altogether. */
1464 needs_to_live_in_memory (x))
1465 return true;
1466 else
1468 /* For local memory that doesn't escape (aka thread private
1469 memory), we can either save the value at the beginning of
1470 the transaction and restore on restart, or call a tm
1471 function to dynamically save and restore on restart
1472 (ITM_L*). */
1473 if (stmt)
1474 tm_log_add (entry_block, orig, stmt);
1475 return false;
1478 default:
1479 return false;
1483 /* Mark the GIMPLE_ASSIGN statement as appropriate for being inside
1484 a transaction region. */
1486 static void
1487 examine_assign_tm (unsigned *state, gimple_stmt_iterator *gsi)
1489 gimple stmt = gsi_stmt (*gsi);
1491 if (requires_barrier (/*entry_block=*/NULL, gimple_assign_rhs1 (stmt), NULL))
1492 *state |= GTMA_HAVE_LOAD;
1493 if (requires_barrier (/*entry_block=*/NULL, gimple_assign_lhs (stmt), NULL))
1494 *state |= GTMA_HAVE_STORE;
1497 /* Mark a GIMPLE_CALL as appropriate for being inside a transaction. */
1499 static void
1500 examine_call_tm (unsigned *state, gimple_stmt_iterator *gsi)
1502 gimple stmt = gsi_stmt (*gsi);
1503 tree fn;
1505 if (is_tm_pure_call (stmt))
1506 return;
1508 /* Check if this call is a transaction abort. */
1509 fn = gimple_call_fndecl (stmt);
1510 if (is_tm_abort (fn))
1511 *state |= GTMA_HAVE_ABORT;
1513 /* Note that something may happen. */
1514 *state |= GTMA_HAVE_LOAD | GTMA_HAVE_STORE;
1517 /* Lower a GIMPLE_TRANSACTION statement. */
1519 static void
1520 lower_transaction (gimple_stmt_iterator *gsi, struct walk_stmt_info *wi)
1522 gimple g, stmt = gsi_stmt (*gsi);
1523 unsigned int *outer_state = (unsigned int *) wi->info;
1524 unsigned int this_state = 0;
1525 struct walk_stmt_info this_wi;
1527 /* First, lower the body. The scanning that we do inside gives
1528 us some idea of what we're dealing with. */
1529 memset (&this_wi, 0, sizeof (this_wi));
1530 this_wi.info = (void *) &this_state;
1531 walk_gimple_seq_mod (gimple_transaction_body_ptr (stmt),
1532 lower_sequence_tm, NULL, &this_wi);
1534 /* If there was absolutely nothing transaction related inside the
1535 transaction, we may elide it. Likewise if this is a nested
1536 transaction and does not contain an abort. */
1537 if (this_state == 0
1538 || (!(this_state & GTMA_HAVE_ABORT) && outer_state != NULL))
1540 if (outer_state)
1541 *outer_state |= this_state;
1543 gsi_insert_seq_before (gsi, gimple_transaction_body (stmt),
1544 GSI_SAME_STMT);
1545 gimple_transaction_set_body (stmt, NULL);
1547 gsi_remove (gsi, true);
1548 wi->removed_stmt = true;
1549 return;
1552 /* Wrap the body of the transaction in a try-finally node so that
1553 the commit call is always properly called. */
1554 g = gimple_build_call (builtin_decl_explicit (BUILT_IN_TM_COMMIT), 0);
1555 if (flag_exceptions)
1557 tree ptr;
1558 gimple_seq n_seq, e_seq;
1560 n_seq = gimple_seq_alloc_with_stmt (g);
1561 e_seq = NULL;
1563 g = gimple_build_call (builtin_decl_explicit (BUILT_IN_EH_POINTER),
1564 1, integer_zero_node);
1565 ptr = create_tmp_var (ptr_type_node, NULL);
1566 gimple_call_set_lhs (g, ptr);
1567 gimple_seq_add_stmt (&e_seq, g);
1569 g = gimple_build_call (builtin_decl_explicit (BUILT_IN_TM_COMMIT_EH),
1570 1, ptr);
1571 gimple_seq_add_stmt (&e_seq, g);
1573 g = gimple_build_eh_else (n_seq, e_seq);
1576 g = gimple_build_try (gimple_transaction_body (stmt),
1577 gimple_seq_alloc_with_stmt (g), GIMPLE_TRY_FINALLY);
1578 gsi_insert_after (gsi, g, GSI_CONTINUE_LINKING);
1580 gimple_transaction_set_body (stmt, NULL);
1582 /* If the transaction calls abort or if this is an outer transaction,
1583 add an "over" label afterwards. */
1584 if ((this_state & (GTMA_HAVE_ABORT))
1585 || (gimple_transaction_subcode(stmt) & GTMA_IS_OUTER))
1587 tree label = create_artificial_label (UNKNOWN_LOCATION);
1588 gimple_transaction_set_label (stmt, label);
1589 gsi_insert_after (gsi, gimple_build_label (label), GSI_CONTINUE_LINKING);
1592 /* Record the set of operations found for use later. */
1593 this_state |= gimple_transaction_subcode (stmt) & GTMA_DECLARATION_MASK;
1594 gimple_transaction_set_subcode (stmt, this_state);
1597 /* Iterate through the statements in the sequence, lowering them all
1598 as appropriate for being in a transaction. */
1600 static tree
1601 lower_sequence_tm (gimple_stmt_iterator *gsi, bool *handled_ops_p,
1602 struct walk_stmt_info *wi)
1604 unsigned int *state = (unsigned int *) wi->info;
1605 gimple stmt = gsi_stmt (*gsi);
1607 *handled_ops_p = true;
1608 switch (gimple_code (stmt))
1610 case GIMPLE_ASSIGN:
1611 /* Only memory reads/writes need to be instrumented. */
1612 if (gimple_assign_single_p (stmt))
1613 examine_assign_tm (state, gsi);
1614 break;
1616 case GIMPLE_CALL:
1617 examine_call_tm (state, gsi);
1618 break;
1620 case GIMPLE_ASM:
1621 *state |= GTMA_MAY_ENTER_IRREVOCABLE;
1622 break;
1624 case GIMPLE_TRANSACTION:
1625 lower_transaction (gsi, wi);
1626 break;
1628 default:
1629 *handled_ops_p = !gimple_has_substatements (stmt);
1630 break;
1633 return NULL_TREE;
1636 /* Iterate through the statements in the sequence, lowering them all
1637 as appropriate for being outside of a transaction. */
1639 static tree
1640 lower_sequence_no_tm (gimple_stmt_iterator *gsi, bool *handled_ops_p,
1641 struct walk_stmt_info * wi)
1643 gimple stmt = gsi_stmt (*gsi);
1645 if (gimple_code (stmt) == GIMPLE_TRANSACTION)
1647 *handled_ops_p = true;
1648 lower_transaction (gsi, wi);
1650 else
1651 *handled_ops_p = !gimple_has_substatements (stmt);
1653 return NULL_TREE;
1656 /* Main entry point for flattening GIMPLE_TRANSACTION constructs. After
1657 this, GIMPLE_TRANSACTION nodes still exist, but the nested body has
1658 been moved out, and all the data required for constructing a proper
1659 CFG has been recorded. */
1661 static unsigned int
1662 execute_lower_tm (void)
1664 struct walk_stmt_info wi;
1665 gimple_seq body;
1667 /* Transactional clones aren't created until a later pass. */
1668 gcc_assert (!decl_is_tm_clone (current_function_decl));
1670 body = gimple_body (current_function_decl);
1671 memset (&wi, 0, sizeof (wi));
1672 walk_gimple_seq_mod (&body, lower_sequence_no_tm, NULL, &wi);
1673 gimple_set_body (current_function_decl, body);
1675 return 0;
1678 struct gimple_opt_pass pass_lower_tm =
1681 GIMPLE_PASS,
1682 "tmlower", /* name */
1683 OPTGROUP_NONE, /* optinfo_flags */
1684 gate_tm, /* gate */
1685 execute_lower_tm, /* execute */
1686 NULL, /* sub */
1687 NULL, /* next */
1688 0, /* static_pass_number */
1689 TV_TRANS_MEM, /* tv_id */
1690 PROP_gimple_lcf, /* properties_required */
1691 0, /* properties_provided */
1692 0, /* properties_destroyed */
1693 0, /* todo_flags_start */
1694 0, /* todo_flags_finish */
1698 /* Collect region information for each transaction. */
1700 struct tm_region
1702 /* Link to the next unnested transaction. */
1703 struct tm_region *next;
1705 /* Link to the next inner transaction. */
1706 struct tm_region *inner;
1708 /* Link to the next outer transaction. */
1709 struct tm_region *outer;
1711 /* The GIMPLE_TRANSACTION statement beginning this transaction.
1712 After TM_MARK, this gets replaced by a call to
1713 BUILT_IN_TM_START. */
1714 gimple transaction_stmt;
1716 /* After TM_MARK expands the GIMPLE_TRANSACTION into a call to
1717 BUILT_IN_TM_START, this field is true if the transaction is an
1718 outer transaction. */
1719 bool original_transaction_was_outer;
1721 /* Return value from BUILT_IN_TM_START. */
1722 tree tm_state;
1724 /* The entry block to this region. This will always be the first
1725 block of the body of the transaction. */
1726 basic_block entry_block;
1728 /* The first block after an expanded call to _ITM_beginTransaction. */
1729 basic_block restart_block;
1731 /* The set of all blocks that end the region; NULL if only EXIT_BLOCK.
1732 These blocks are still a part of the region (i.e., the border is
1733 inclusive). Note that this set is only complete for paths in the CFG
1734 starting at ENTRY_BLOCK, and that there is no exit block recorded for
1735 the edge to the "over" label. */
1736 bitmap exit_blocks;
1738 /* The set of all blocks that have an TM_IRREVOCABLE call. */
1739 bitmap irr_blocks;
1742 typedef struct tm_region *tm_region_p;
1744 /* True if there are pending edge statements to be committed for the
1745 current function being scanned in the tmmark pass. */
1746 bool pending_edge_inserts_p;
1748 static struct tm_region *all_tm_regions;
1749 static bitmap_obstack tm_obstack;
1752 /* A subroutine of tm_region_init. Record the existence of the
1753 GIMPLE_TRANSACTION statement in a tree of tm_region elements. */
1755 static struct tm_region *
1756 tm_region_init_0 (struct tm_region *outer, basic_block bb, gimple stmt)
1758 struct tm_region *region;
1760 region = (struct tm_region *)
1761 obstack_alloc (&tm_obstack.obstack, sizeof (struct tm_region));
1763 if (outer)
1765 region->next = outer->inner;
1766 outer->inner = region;
1768 else
1770 region->next = all_tm_regions;
1771 all_tm_regions = region;
1773 region->inner = NULL;
1774 region->outer = outer;
1776 region->transaction_stmt = stmt;
1777 region->original_transaction_was_outer = false;
1778 region->tm_state = NULL;
1780 /* There are either one or two edges out of the block containing
1781 the GIMPLE_TRANSACTION, one to the actual region and one to the
1782 "over" label if the region contains an abort. The former will
1783 always be the one marked FALLTHRU. */
1784 region->entry_block = FALLTHRU_EDGE (bb)->dest;
1786 region->exit_blocks = BITMAP_ALLOC (&tm_obstack);
1787 region->irr_blocks = BITMAP_ALLOC (&tm_obstack);
1789 return region;
1792 /* A subroutine of tm_region_init. Record all the exit and
1793 irrevocable blocks in BB into the region's exit_blocks and
1794 irr_blocks bitmaps. Returns the new region being scanned. */
1796 static struct tm_region *
1797 tm_region_init_1 (struct tm_region *region, basic_block bb)
1799 gimple_stmt_iterator gsi;
1800 gimple g;
1802 if (!region
1803 || (!region->irr_blocks && !region->exit_blocks))
1804 return region;
1806 /* Check to see if this is the end of a region by seeing if it
1807 contains a call to __builtin_tm_commit{,_eh}. Note that the
1808 outermost region for DECL_IS_TM_CLONE need not collect this. */
1809 for (gsi = gsi_last_bb (bb); !gsi_end_p (gsi); gsi_prev (&gsi))
1811 g = gsi_stmt (gsi);
1812 if (gimple_code (g) == GIMPLE_CALL)
1814 tree fn = gimple_call_fndecl (g);
1815 if (fn && DECL_BUILT_IN_CLASS (fn) == BUILT_IN_NORMAL)
1817 if ((DECL_FUNCTION_CODE (fn) == BUILT_IN_TM_COMMIT
1818 || DECL_FUNCTION_CODE (fn) == BUILT_IN_TM_COMMIT_EH)
1819 && region->exit_blocks)
1821 bitmap_set_bit (region->exit_blocks, bb->index);
1822 region = region->outer;
1823 break;
1825 if (DECL_FUNCTION_CODE (fn) == BUILT_IN_TM_IRREVOCABLE)
1826 bitmap_set_bit (region->irr_blocks, bb->index);
1830 return region;
1833 /* Collect all of the transaction regions within the current function
1834 and record them in ALL_TM_REGIONS. The REGION parameter may specify
1835 an "outermost" region for use by tm clones. */
1837 static void
1838 tm_region_init (struct tm_region *region)
1840 gimple g;
1841 edge_iterator ei;
1842 edge e;
1843 basic_block bb;
1844 vec<basic_block> queue = vNULL;
1845 bitmap visited_blocks = BITMAP_ALLOC (NULL);
1846 struct tm_region *old_region;
1847 vec<tm_region_p> bb_regions = vNULL;
1849 all_tm_regions = region;
1850 bb = single_succ (ENTRY_BLOCK_PTR);
1852 /* We could store this information in bb->aux, but we may get called
1853 through get_all_tm_blocks() from another pass that may be already
1854 using bb->aux. */
1855 bb_regions.safe_grow_cleared (last_basic_block);
1857 queue.safe_push (bb);
1858 bb_regions[bb->index] = region;
1861 bb = queue.pop ();
1862 region = bb_regions[bb->index];
1863 bb_regions[bb->index] = NULL;
1865 /* Record exit and irrevocable blocks. */
1866 region = tm_region_init_1 (region, bb);
1868 /* Check for the last statement in the block beginning a new region. */
1869 g = last_stmt (bb);
1870 old_region = region;
1871 if (g && gimple_code (g) == GIMPLE_TRANSACTION)
1872 region = tm_region_init_0 (region, bb, g);
1874 /* Process subsequent blocks. */
1875 FOR_EACH_EDGE (e, ei, bb->succs)
1876 if (!bitmap_bit_p (visited_blocks, e->dest->index))
1878 bitmap_set_bit (visited_blocks, e->dest->index);
1879 queue.safe_push (e->dest);
1881 /* If the current block started a new region, make sure that only
1882 the entry block of the new region is associated with this region.
1883 Other successors are still part of the old region. */
1884 if (old_region != region && e->dest != region->entry_block)
1885 bb_regions[e->dest->index] = old_region;
1886 else
1887 bb_regions[e->dest->index] = region;
1890 while (!queue.is_empty ());
1891 queue.release ();
1892 BITMAP_FREE (visited_blocks);
1893 bb_regions.release ();
1896 /* The "gate" function for all transactional memory expansion and optimization
1897 passes. We collect region information for each top-level transaction, and
1898 if we don't find any, we skip all of the TM passes. Each region will have
1899 all of the exit blocks recorded, and the originating statement. */
1901 static bool
1902 gate_tm_init (void)
1904 if (!flag_tm)
1905 return false;
1907 calculate_dominance_info (CDI_DOMINATORS);
1908 bitmap_obstack_initialize (&tm_obstack);
1910 /* If the function is a TM_CLONE, then the entire function is the region. */
1911 if (decl_is_tm_clone (current_function_decl))
1913 struct tm_region *region = (struct tm_region *)
1914 obstack_alloc (&tm_obstack.obstack, sizeof (struct tm_region));
1915 memset (region, 0, sizeof (*region));
1916 region->entry_block = single_succ (ENTRY_BLOCK_PTR);
1917 /* For a clone, the entire function is the region. But even if
1918 we don't need to record any exit blocks, we may need to
1919 record irrevocable blocks. */
1920 region->irr_blocks = BITMAP_ALLOC (&tm_obstack);
1922 tm_region_init (region);
1924 else
1926 tm_region_init (NULL);
1928 /* If we didn't find any regions, cleanup and skip the whole tree
1929 of tm-related optimizations. */
1930 if (all_tm_regions == NULL)
1932 bitmap_obstack_release (&tm_obstack);
1933 return false;
1937 return true;
1940 struct gimple_opt_pass pass_tm_init =
1943 GIMPLE_PASS,
1944 "*tminit", /* name */
1945 OPTGROUP_NONE, /* optinfo_flags */
1946 gate_tm_init, /* gate */
1947 NULL, /* execute */
1948 NULL, /* sub */
1949 NULL, /* next */
1950 0, /* static_pass_number */
1951 TV_TRANS_MEM, /* tv_id */
1952 PROP_ssa | PROP_cfg, /* properties_required */
1953 0, /* properties_provided */
1954 0, /* properties_destroyed */
1955 0, /* todo_flags_start */
1956 0, /* todo_flags_finish */
1960 /* Add FLAGS to the GIMPLE_TRANSACTION subcode for the transaction region
1961 represented by STATE. */
1963 static inline void
1964 transaction_subcode_ior (struct tm_region *region, unsigned flags)
1966 if (region && region->transaction_stmt)
1968 flags |= gimple_transaction_subcode (region->transaction_stmt);
1969 gimple_transaction_set_subcode (region->transaction_stmt, flags);
1973 /* Construct a memory load in a transactional context. Return the
1974 gimple statement performing the load, or NULL if there is no
1975 TM_LOAD builtin of the appropriate size to do the load.
1977 LOC is the location to use for the new statement(s). */
1979 static gimple
1980 build_tm_load (location_t loc, tree lhs, tree rhs, gimple_stmt_iterator *gsi)
1982 enum built_in_function code = END_BUILTINS;
1983 tree t, type = TREE_TYPE (rhs), decl;
1984 gimple gcall;
1986 if (type == float_type_node)
1987 code = BUILT_IN_TM_LOAD_FLOAT;
1988 else if (type == double_type_node)
1989 code = BUILT_IN_TM_LOAD_DOUBLE;
1990 else if (type == long_double_type_node)
1991 code = BUILT_IN_TM_LOAD_LDOUBLE;
1992 else if (TYPE_SIZE_UNIT (type) != NULL
1993 && host_integerp (TYPE_SIZE_UNIT (type), 1))
1995 switch (tree_low_cst (TYPE_SIZE_UNIT (type), 1))
1997 case 1:
1998 code = BUILT_IN_TM_LOAD_1;
1999 break;
2000 case 2:
2001 code = BUILT_IN_TM_LOAD_2;
2002 break;
2003 case 4:
2004 code = BUILT_IN_TM_LOAD_4;
2005 break;
2006 case 8:
2007 code = BUILT_IN_TM_LOAD_8;
2008 break;
2012 if (code == END_BUILTINS)
2014 decl = targetm.vectorize.builtin_tm_load (type);
2015 if (!decl)
2016 return NULL;
2018 else
2019 decl = builtin_decl_explicit (code);
2021 t = gimplify_addr (gsi, rhs);
2022 gcall = gimple_build_call (decl, 1, t);
2023 gimple_set_location (gcall, loc);
2025 t = TREE_TYPE (TREE_TYPE (decl));
2026 if (useless_type_conversion_p (type, t))
2028 gimple_call_set_lhs (gcall, lhs);
2029 gsi_insert_before (gsi, gcall, GSI_SAME_STMT);
2031 else
2033 gimple g;
2034 tree temp;
2036 temp = create_tmp_reg (t, NULL);
2037 gimple_call_set_lhs (gcall, temp);
2038 gsi_insert_before (gsi, gcall, GSI_SAME_STMT);
2040 t = fold_build1 (VIEW_CONVERT_EXPR, type, temp);
2041 g = gimple_build_assign (lhs, t);
2042 gsi_insert_before (gsi, g, GSI_SAME_STMT);
2045 return gcall;
2049 /* Similarly for storing TYPE in a transactional context. */
2051 static gimple
2052 build_tm_store (location_t loc, tree lhs, tree rhs, gimple_stmt_iterator *gsi)
2054 enum built_in_function code = END_BUILTINS;
2055 tree t, fn, type = TREE_TYPE (rhs), simple_type;
2056 gimple gcall;
2058 if (type == float_type_node)
2059 code = BUILT_IN_TM_STORE_FLOAT;
2060 else if (type == double_type_node)
2061 code = BUILT_IN_TM_STORE_DOUBLE;
2062 else if (type == long_double_type_node)
2063 code = BUILT_IN_TM_STORE_LDOUBLE;
2064 else if (TYPE_SIZE_UNIT (type) != NULL
2065 && host_integerp (TYPE_SIZE_UNIT (type), 1))
2067 switch (tree_low_cst (TYPE_SIZE_UNIT (type), 1))
2069 case 1:
2070 code = BUILT_IN_TM_STORE_1;
2071 break;
2072 case 2:
2073 code = BUILT_IN_TM_STORE_2;
2074 break;
2075 case 4:
2076 code = BUILT_IN_TM_STORE_4;
2077 break;
2078 case 8:
2079 code = BUILT_IN_TM_STORE_8;
2080 break;
2084 if (code == END_BUILTINS)
2086 fn = targetm.vectorize.builtin_tm_store (type);
2087 if (!fn)
2088 return NULL;
2090 else
2091 fn = builtin_decl_explicit (code);
2093 simple_type = TREE_VALUE (TREE_CHAIN (TYPE_ARG_TYPES (TREE_TYPE (fn))));
2095 if (TREE_CODE (rhs) == CONSTRUCTOR)
2097 /* Handle the easy initialization to zero. */
2098 if (!CONSTRUCTOR_ELTS (rhs))
2099 rhs = build_int_cst (simple_type, 0);
2100 else
2102 /* ...otherwise punt to the caller and probably use
2103 BUILT_IN_TM_MEMMOVE, because we can't wrap a
2104 VIEW_CONVERT_EXPR around a CONSTRUCTOR (below) and produce
2105 valid gimple. */
2106 return NULL;
2109 else if (!useless_type_conversion_p (simple_type, type))
2111 gimple g;
2112 tree temp;
2114 temp = create_tmp_reg (simple_type, NULL);
2115 t = fold_build1 (VIEW_CONVERT_EXPR, simple_type, rhs);
2116 g = gimple_build_assign (temp, t);
2117 gimple_set_location (g, loc);
2118 gsi_insert_before (gsi, g, GSI_SAME_STMT);
2120 rhs = temp;
2123 t = gimplify_addr (gsi, lhs);
2124 gcall = gimple_build_call (fn, 2, t, rhs);
2125 gimple_set_location (gcall, loc);
2126 gsi_insert_before (gsi, gcall, GSI_SAME_STMT);
2128 return gcall;
2132 /* Expand an assignment statement into transactional builtins. */
2134 static void
2135 expand_assign_tm (struct tm_region *region, gimple_stmt_iterator *gsi)
2137 gimple stmt = gsi_stmt (*gsi);
2138 location_t loc = gimple_location (stmt);
2139 tree lhs = gimple_assign_lhs (stmt);
2140 tree rhs = gimple_assign_rhs1 (stmt);
2141 bool store_p = requires_barrier (region->entry_block, lhs, NULL);
2142 bool load_p = requires_barrier (region->entry_block, rhs, NULL);
2143 gimple gcall = NULL;
2145 if (!load_p && !store_p)
2147 /* Add thread private addresses to log if applicable. */
2148 requires_barrier (region->entry_block, lhs, stmt);
2149 gsi_next (gsi);
2150 return;
2153 // Remove original load/store statement.
2154 gsi_remove (gsi, true);
2156 if (load_p && !store_p)
2158 transaction_subcode_ior (region, GTMA_HAVE_LOAD);
2159 gcall = build_tm_load (loc, lhs, rhs, gsi);
2161 else if (store_p && !load_p)
2163 transaction_subcode_ior (region, GTMA_HAVE_STORE);
2164 gcall = build_tm_store (loc, lhs, rhs, gsi);
2166 if (!gcall)
2168 tree lhs_addr, rhs_addr, tmp;
2170 if (load_p)
2171 transaction_subcode_ior (region, GTMA_HAVE_LOAD);
2172 if (store_p)
2173 transaction_subcode_ior (region, GTMA_HAVE_STORE);
2175 /* ??? Figure out if there's any possible overlap between the LHS
2176 and the RHS and if not, use MEMCPY. */
2178 if (load_p && is_gimple_reg (lhs))
2180 tmp = create_tmp_var (TREE_TYPE (lhs), NULL);
2181 lhs_addr = build_fold_addr_expr (tmp);
2183 else
2185 tmp = NULL_TREE;
2186 lhs_addr = gimplify_addr (gsi, lhs);
2188 rhs_addr = gimplify_addr (gsi, rhs);
2189 gcall = gimple_build_call (builtin_decl_explicit (BUILT_IN_TM_MEMMOVE),
2190 3, lhs_addr, rhs_addr,
2191 TYPE_SIZE_UNIT (TREE_TYPE (lhs)));
2192 gimple_set_location (gcall, loc);
2193 gsi_insert_before (gsi, gcall, GSI_SAME_STMT);
2195 if (tmp)
2197 gcall = gimple_build_assign (lhs, tmp);
2198 gsi_insert_before (gsi, gcall, GSI_SAME_STMT);
2202 /* Now that we have the load/store in its instrumented form, add
2203 thread private addresses to the log if applicable. */
2204 if (!store_p)
2205 requires_barrier (region->entry_block, lhs, gcall);
2207 // The calls to build_tm_{store,load} above inserted the instrumented
2208 // call into the stream.
2209 // gsi_insert_before (gsi, gcall, GSI_SAME_STMT);
2213 /* Expand a call statement as appropriate for a transaction. That is,
2214 either verify that the call does not affect the transaction, or
2215 redirect the call to a clone that handles transactions, or change
2216 the transaction state to IRREVOCABLE. Return true if the call is
2217 one of the builtins that end a transaction. */
2219 static bool
2220 expand_call_tm (struct tm_region *region,
2221 gimple_stmt_iterator *gsi)
2223 gimple stmt = gsi_stmt (*gsi);
2224 tree lhs = gimple_call_lhs (stmt);
2225 tree fn_decl;
2226 struct cgraph_node *node;
2227 bool retval = false;
2229 fn_decl = gimple_call_fndecl (stmt);
2231 if (fn_decl == builtin_decl_explicit (BUILT_IN_TM_MEMCPY)
2232 || fn_decl == builtin_decl_explicit (BUILT_IN_TM_MEMMOVE))
2233 transaction_subcode_ior (region, GTMA_HAVE_STORE | GTMA_HAVE_LOAD);
2234 if (fn_decl == builtin_decl_explicit (BUILT_IN_TM_MEMSET))
2235 transaction_subcode_ior (region, GTMA_HAVE_STORE);
2237 if (is_tm_pure_call (stmt))
2238 return false;
2240 if (fn_decl)
2241 retval = is_tm_ending_fndecl (fn_decl);
2242 if (!retval)
2244 /* Assume all non-const/pure calls write to memory, except
2245 transaction ending builtins. */
2246 transaction_subcode_ior (region, GTMA_HAVE_STORE);
2249 /* For indirect calls, we already generated a call into the runtime. */
2250 if (!fn_decl)
2252 tree fn = gimple_call_fn (stmt);
2254 /* We are guaranteed never to go irrevocable on a safe or pure
2255 call, and the pure call was handled above. */
2256 if (is_tm_safe (fn))
2257 return false;
2258 else
2259 transaction_subcode_ior (region, GTMA_MAY_ENTER_IRREVOCABLE);
2261 return false;
2264 node = cgraph_get_node (fn_decl);
2265 /* All calls should have cgraph here. */
2266 if (!node)
2268 /* We can have a nodeless call here if some pass after IPA-tm
2269 added uninstrumented calls. For example, loop distribution
2270 can transform certain loop constructs into __builtin_mem*
2271 calls. In this case, see if we have a suitable TM
2272 replacement and fill in the gaps. */
2273 gcc_assert (DECL_BUILT_IN_CLASS (fn_decl) == BUILT_IN_NORMAL);
2274 enum built_in_function code = DECL_FUNCTION_CODE (fn_decl);
2275 gcc_assert (code == BUILT_IN_MEMCPY
2276 || code == BUILT_IN_MEMMOVE
2277 || code == BUILT_IN_MEMSET);
2279 tree repl = find_tm_replacement_function (fn_decl);
2280 if (repl)
2282 gimple_call_set_fndecl (stmt, repl);
2283 update_stmt (stmt);
2284 node = cgraph_create_node (repl);
2285 node->local.tm_may_enter_irr = false;
2286 return expand_call_tm (region, gsi);
2288 gcc_unreachable ();
2290 if (node->local.tm_may_enter_irr)
2291 transaction_subcode_ior (region, GTMA_MAY_ENTER_IRREVOCABLE);
2293 if (is_tm_abort (fn_decl))
2295 transaction_subcode_ior (region, GTMA_HAVE_ABORT);
2296 return true;
2299 /* Instrument the store if needed.
2301 If the assignment happens inside the function call (return slot
2302 optimization), there is no instrumentation to be done, since
2303 the callee should have done the right thing. */
2304 if (lhs && requires_barrier (region->entry_block, lhs, stmt)
2305 && !gimple_call_return_slot_opt_p (stmt))
2307 tree tmp = create_tmp_reg (TREE_TYPE (lhs), NULL);
2308 location_t loc = gimple_location (stmt);
2309 edge fallthru_edge = NULL;
2311 /* Remember if the call was going to throw. */
2312 if (stmt_can_throw_internal (stmt))
2314 edge_iterator ei;
2315 edge e;
2316 basic_block bb = gimple_bb (stmt);
2318 FOR_EACH_EDGE (e, ei, bb->succs)
2319 if (e->flags & EDGE_FALLTHRU)
2321 fallthru_edge = e;
2322 break;
2326 gimple_call_set_lhs (stmt, tmp);
2327 update_stmt (stmt);
2328 stmt = gimple_build_assign (lhs, tmp);
2329 gimple_set_location (stmt, loc);
2331 /* We cannot throw in the middle of a BB. If the call was going
2332 to throw, place the instrumentation on the fallthru edge, so
2333 the call remains the last statement in the block. */
2334 if (fallthru_edge)
2336 gimple_seq fallthru_seq = gimple_seq_alloc_with_stmt (stmt);
2337 gimple_stmt_iterator fallthru_gsi = gsi_start (fallthru_seq);
2338 expand_assign_tm (region, &fallthru_gsi);
2339 gsi_insert_seq_on_edge (fallthru_edge, fallthru_seq);
2340 pending_edge_inserts_p = true;
2342 else
2344 gsi_insert_after (gsi, stmt, GSI_CONTINUE_LINKING);
2345 expand_assign_tm (region, gsi);
2348 transaction_subcode_ior (region, GTMA_HAVE_STORE);
2351 return retval;
2355 /* Expand all statements in BB as appropriate for being inside
2356 a transaction. */
2358 static void
2359 expand_block_tm (struct tm_region *region, basic_block bb)
2361 gimple_stmt_iterator gsi;
2363 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); )
2365 gimple stmt = gsi_stmt (gsi);
2366 switch (gimple_code (stmt))
2368 case GIMPLE_ASSIGN:
2369 /* Only memory reads/writes need to be instrumented. */
2370 if (gimple_assign_single_p (stmt)
2371 && !gimple_clobber_p (stmt))
2373 expand_assign_tm (region, &gsi);
2374 continue;
2376 break;
2378 case GIMPLE_CALL:
2379 if (expand_call_tm (region, &gsi))
2380 return;
2381 break;
2383 case GIMPLE_ASM:
2384 gcc_unreachable ();
2386 default:
2387 break;
2389 if (!gsi_end_p (gsi))
2390 gsi_next (&gsi);
2394 /* Return the list of basic-blocks in REGION.
2396 STOP_AT_IRREVOCABLE_P is true if caller is uninterested in blocks
2397 following a TM_IRREVOCABLE call.
2399 INCLUDE_UNINSTRUMENTED_P is TRUE if we should include the
2400 uninstrumented code path blocks in the list of basic blocks
2401 returned, false otherwise. */
2403 static vec<basic_block>
2404 get_tm_region_blocks (basic_block entry_block,
2405 bitmap exit_blocks,
2406 bitmap irr_blocks,
2407 bitmap all_region_blocks,
2408 bool stop_at_irrevocable_p,
2409 bool include_uninstrumented_p = true)
2411 vec<basic_block> bbs = vNULL;
2412 unsigned i;
2413 edge e;
2414 edge_iterator ei;
2415 bitmap visited_blocks = BITMAP_ALLOC (NULL);
2417 i = 0;
2418 bbs.safe_push (entry_block);
2419 bitmap_set_bit (visited_blocks, entry_block->index);
2423 basic_block bb = bbs[i++];
2425 if (exit_blocks &&
2426 bitmap_bit_p (exit_blocks, bb->index))
2427 continue;
2429 if (stop_at_irrevocable_p
2430 && irr_blocks
2431 && bitmap_bit_p (irr_blocks, bb->index))
2432 continue;
2434 FOR_EACH_EDGE (e, ei, bb->succs)
2435 if ((include_uninstrumented_p
2436 || !(e->flags & EDGE_TM_UNINSTRUMENTED))
2437 && !bitmap_bit_p (visited_blocks, e->dest->index))
2439 bitmap_set_bit (visited_blocks, e->dest->index);
2440 bbs.safe_push (e->dest);
2443 while (i < bbs.length ());
2445 if (all_region_blocks)
2446 bitmap_ior_into (all_region_blocks, visited_blocks);
2448 BITMAP_FREE (visited_blocks);
2449 return bbs;
2452 // Callback data for collect_bb2reg.
2453 struct bb2reg_stuff
2455 vec<tm_region_p> *bb2reg;
2456 bool include_uninstrumented_p;
2459 // Callback for expand_regions, collect innermost region data for each bb.
2460 static void *
2461 collect_bb2reg (struct tm_region *region, void *data)
2463 struct bb2reg_stuff *stuff = (struct bb2reg_stuff *)data;
2464 vec<tm_region_p> *bb2reg = stuff->bb2reg;
2465 vec<basic_block> queue;
2466 unsigned int i;
2467 basic_block bb;
2469 queue = get_tm_region_blocks (region->entry_block,
2470 region->exit_blocks,
2471 region->irr_blocks,
2472 NULL,
2473 /*stop_at_irr_p=*/true,
2474 stuff->include_uninstrumented_p);
2476 // We expect expand_region to perform a post-order traversal of the region
2477 // tree. Therefore the last region seen for any bb is the innermost.
2478 FOR_EACH_VEC_ELT (queue, i, bb)
2479 (*bb2reg)[bb->index] = region;
2481 queue.release ();
2482 return NULL;
2485 // Returns a vector, indexed by BB->INDEX, of the innermost tm_region to
2486 // which a basic block belongs. Note that we only consider the instrumented
2487 // code paths for the region; the uninstrumented code paths are ignored if
2488 // INCLUDE_UNINSTRUMENTED_P is false.
2490 // ??? This data is very similar to the bb_regions array that is collected
2491 // during tm_region_init. Or, rather, this data is similar to what could
2492 // be used within tm_region_init. The actual computation in tm_region_init
2493 // begins and ends with bb_regions entirely full of NULL pointers, due to
2494 // the way in which pointers are swapped in and out of the array.
2496 // ??? Our callers expect that blocks are not shared between transactions.
2497 // When the optimizers get too smart, and blocks are shared, then during
2498 // the tm_mark phase we'll add log entries to only one of the two transactions,
2499 // and in the tm_edge phase we'll add edges to the CFG that create invalid
2500 // cycles. The symptom being SSA defs that do not dominate their uses.
2501 // Note that the optimizers were locally correct with their transformation,
2502 // as we have no info within the program that suggests that the blocks cannot
2503 // be shared.
2505 // ??? There is currently a hack inside tree-ssa-pre.c to work around the
2506 // only known instance of this block sharing.
2508 static vec<tm_region_p>
2509 get_bb_regions_instrumented (bool traverse_clones,
2510 bool include_uninstrumented_p)
2512 unsigned n = last_basic_block;
2513 struct bb2reg_stuff stuff;
2514 vec<tm_region_p> ret;
2516 ret.create (n);
2517 ret.safe_grow_cleared (n);
2518 stuff.bb2reg = &ret;
2519 stuff.include_uninstrumented_p = include_uninstrumented_p;
2520 expand_regions (all_tm_regions, collect_bb2reg, &stuff, traverse_clones);
2522 return ret;
2525 /* Set the IN_TRANSACTION for all gimple statements that appear in a
2526 transaction. */
2528 void
2529 compute_transaction_bits (void)
2531 struct tm_region *region;
2532 vec<basic_block> queue;
2533 unsigned int i;
2534 basic_block bb;
2536 /* ?? Perhaps we need to abstract gate_tm_init further, because we
2537 certainly don't need it to calculate CDI_DOMINATOR info. */
2538 gate_tm_init ();
2540 FOR_EACH_BB (bb)
2541 bb->flags &= ~BB_IN_TRANSACTION;
2543 for (region = all_tm_regions; region; region = region->next)
2545 queue = get_tm_region_blocks (region->entry_block,
2546 region->exit_blocks,
2547 region->irr_blocks,
2548 NULL,
2549 /*stop_at_irr_p=*/true);
2550 for (i = 0; queue.iterate (i, &bb); ++i)
2551 bb->flags |= BB_IN_TRANSACTION;
2552 queue.release ();
2555 if (all_tm_regions)
2556 bitmap_obstack_release (&tm_obstack);
2559 /* Replace the GIMPLE_TRANSACTION in this region with the corresponding
2560 call to BUILT_IN_TM_START. */
2562 static void *
2563 expand_transaction (struct tm_region *region, void *data ATTRIBUTE_UNUSED)
2565 tree tm_start = builtin_decl_explicit (BUILT_IN_TM_START);
2566 basic_block transaction_bb = gimple_bb (region->transaction_stmt);
2567 tree tm_state = region->tm_state;
2568 tree tm_state_type = TREE_TYPE (tm_state);
2569 edge abort_edge = NULL;
2570 edge inst_edge = NULL;
2571 edge uninst_edge = NULL;
2572 edge fallthru_edge = NULL;
2574 // Identify the various successors of the transaction start.
2576 edge_iterator i;
2577 edge e;
2578 FOR_EACH_EDGE (e, i, transaction_bb->succs)
2580 if (e->flags & EDGE_TM_ABORT)
2581 abort_edge = e;
2582 else if (e->flags & EDGE_TM_UNINSTRUMENTED)
2583 uninst_edge = e;
2584 else
2585 inst_edge = e;
2586 if (e->flags & EDGE_FALLTHRU)
2587 fallthru_edge = e;
2591 /* ??? There are plenty of bits here we're not computing. */
2593 int subcode = gimple_transaction_subcode (region->transaction_stmt);
2594 int flags = 0;
2595 if (subcode & GTMA_DOES_GO_IRREVOCABLE)
2596 flags |= PR_DOESGOIRREVOCABLE;
2597 if ((subcode & GTMA_MAY_ENTER_IRREVOCABLE) == 0)
2598 flags |= PR_HASNOIRREVOCABLE;
2599 /* If the transaction does not have an abort in lexical scope and is not
2600 marked as an outer transaction, then it will never abort. */
2601 if ((subcode & GTMA_HAVE_ABORT) == 0 && (subcode & GTMA_IS_OUTER) == 0)
2602 flags |= PR_HASNOABORT;
2603 if ((subcode & GTMA_HAVE_STORE) == 0)
2604 flags |= PR_READONLY;
2605 if (inst_edge)
2606 flags |= PR_INSTRUMENTEDCODE;
2607 if (uninst_edge)
2608 flags |= PR_UNINSTRUMENTEDCODE;
2609 if (subcode & GTMA_IS_OUTER)
2610 region->original_transaction_was_outer = true;
2611 tree t = build_int_cst (tm_state_type, flags);
2612 gimple call = gimple_build_call (tm_start, 1, t);
2613 gimple_call_set_lhs (call, tm_state);
2614 gimple_set_location (call, gimple_location (region->transaction_stmt));
2616 // Replace the GIMPLE_TRANSACTION with the call to BUILT_IN_TM_START.
2617 gimple_stmt_iterator gsi = gsi_last_bb (transaction_bb);
2618 gcc_assert (gsi_stmt (gsi) == region->transaction_stmt);
2619 gsi_insert_before (&gsi, call, GSI_SAME_STMT);
2620 gsi_remove (&gsi, true);
2621 region->transaction_stmt = call;
2624 // Generate log saves.
2625 if (!tm_log_save_addresses.is_empty ())
2626 tm_log_emit_saves (region->entry_block, transaction_bb);
2628 // In the beginning, we've no tests to perform on transaction restart.
2629 // Note that after this point, transaction_bb becomes the "most recent
2630 // block containing tests for the transaction".
2631 region->restart_block = region->entry_block;
2633 // Generate log restores.
2634 if (!tm_log_save_addresses.is_empty ())
2636 basic_block test_bb = create_empty_bb (transaction_bb);
2637 basic_block code_bb = create_empty_bb (test_bb);
2638 basic_block join_bb = create_empty_bb (code_bb);
2639 if (current_loops && transaction_bb->loop_father)
2641 add_bb_to_loop (test_bb, transaction_bb->loop_father);
2642 add_bb_to_loop (code_bb, transaction_bb->loop_father);
2643 add_bb_to_loop (join_bb, transaction_bb->loop_father);
2645 if (region->restart_block == region->entry_block)
2646 region->restart_block = test_bb;
2648 tree t1 = create_tmp_reg (tm_state_type, NULL);
2649 tree t2 = build_int_cst (tm_state_type, A_RESTORELIVEVARIABLES);
2650 gimple stmt = gimple_build_assign_with_ops (BIT_AND_EXPR, t1,
2651 tm_state, t2);
2652 gimple_stmt_iterator gsi = gsi_last_bb (test_bb);
2653 gsi_insert_after (&gsi, stmt, GSI_CONTINUE_LINKING);
2655 t2 = build_int_cst (tm_state_type, 0);
2656 stmt = gimple_build_cond (NE_EXPR, t1, t2, NULL, NULL);
2657 gsi_insert_after (&gsi, stmt, GSI_CONTINUE_LINKING);
2659 tm_log_emit_restores (region->entry_block, code_bb);
2661 edge ei = make_edge (transaction_bb, test_bb, EDGE_FALLTHRU);
2662 edge et = make_edge (test_bb, code_bb, EDGE_TRUE_VALUE);
2663 edge ef = make_edge (test_bb, join_bb, EDGE_FALSE_VALUE);
2664 redirect_edge_pred (fallthru_edge, join_bb);
2666 join_bb->frequency = test_bb->frequency = transaction_bb->frequency;
2667 join_bb->count = test_bb->count = transaction_bb->count;
2669 ei->probability = PROB_ALWAYS;
2670 et->probability = PROB_LIKELY;
2671 ef->probability = PROB_UNLIKELY;
2672 et->count = apply_probability(test_bb->count, et->probability);
2673 ef->count = apply_probability(test_bb->count, ef->probability);
2675 code_bb->count = et->count;
2676 code_bb->frequency = EDGE_FREQUENCY (et);
2678 transaction_bb = join_bb;
2681 // If we have an ABORT edge, create a test to perform the abort.
2682 if (abort_edge)
2684 basic_block test_bb = create_empty_bb (transaction_bb);
2685 if (current_loops && transaction_bb->loop_father)
2686 add_bb_to_loop (test_bb, transaction_bb->loop_father);
2687 if (region->restart_block == region->entry_block)
2688 region->restart_block = test_bb;
2690 tree t1 = create_tmp_reg (tm_state_type, NULL);
2691 tree t2 = build_int_cst (tm_state_type, A_ABORTTRANSACTION);
2692 gimple stmt = gimple_build_assign_with_ops (BIT_AND_EXPR, t1,
2693 tm_state, t2);
2694 gimple_stmt_iterator gsi = gsi_last_bb (test_bb);
2695 gsi_insert_after (&gsi, stmt, GSI_CONTINUE_LINKING);
2697 t2 = build_int_cst (tm_state_type, 0);
2698 stmt = gimple_build_cond (NE_EXPR, t1, t2, NULL, NULL);
2699 gsi_insert_after (&gsi, stmt, GSI_CONTINUE_LINKING);
2701 edge ei = make_edge (transaction_bb, test_bb, EDGE_FALLTHRU);
2702 test_bb->frequency = transaction_bb->frequency;
2703 test_bb->count = transaction_bb->count;
2704 ei->probability = PROB_ALWAYS;
2706 // Not abort edge. If both are live, chose one at random as we'll
2707 // we'll be fixing that up below.
2708 redirect_edge_pred (fallthru_edge, test_bb);
2709 fallthru_edge->flags = EDGE_FALSE_VALUE;
2710 fallthru_edge->probability = PROB_VERY_LIKELY;
2711 fallthru_edge->count
2712 = apply_probability(test_bb->count, fallthru_edge->probability);
2714 // Abort/over edge.
2715 redirect_edge_pred (abort_edge, test_bb);
2716 abort_edge->flags = EDGE_TRUE_VALUE;
2717 abort_edge->probability = PROB_VERY_UNLIKELY;
2718 abort_edge->count
2719 = apply_probability(test_bb->count, abort_edge->probability);
2721 transaction_bb = test_bb;
2724 // If we have both instrumented and uninstrumented code paths, select one.
2725 if (inst_edge && uninst_edge)
2727 basic_block test_bb = create_empty_bb (transaction_bb);
2728 if (current_loops && transaction_bb->loop_father)
2729 add_bb_to_loop (test_bb, transaction_bb->loop_father);
2730 if (region->restart_block == region->entry_block)
2731 region->restart_block = test_bb;
2733 tree t1 = create_tmp_reg (tm_state_type, NULL);
2734 tree t2 = build_int_cst (tm_state_type, A_RUNUNINSTRUMENTEDCODE);
2736 gimple stmt = gimple_build_assign_with_ops (BIT_AND_EXPR, t1,
2737 tm_state, t2);
2738 gimple_stmt_iterator gsi = gsi_last_bb (test_bb);
2739 gsi_insert_after (&gsi, stmt, GSI_CONTINUE_LINKING);
2741 t2 = build_int_cst (tm_state_type, 0);
2742 stmt = gimple_build_cond (NE_EXPR, t1, t2, NULL, NULL);
2743 gsi_insert_after (&gsi, stmt, GSI_CONTINUE_LINKING);
2745 // Create the edge into test_bb first, as we want to copy values
2746 // out of the fallthru edge.
2747 edge e = make_edge (transaction_bb, test_bb, fallthru_edge->flags);
2748 e->probability = fallthru_edge->probability;
2749 test_bb->count = e->count = fallthru_edge->count;
2750 test_bb->frequency = EDGE_FREQUENCY (e);
2752 // Now update the edges to the inst/uninist implementations.
2753 // For now assume that the paths are equally likely. When using HTM,
2754 // we'll try the uninst path first and fallback to inst path if htm
2755 // buffers are exceeded. Without HTM we start with the inst path and
2756 // use the uninst path when falling back to serial mode.
2757 redirect_edge_pred (inst_edge, test_bb);
2758 inst_edge->flags = EDGE_FALSE_VALUE;
2759 inst_edge->probability = REG_BR_PROB_BASE / 2;
2760 inst_edge->count
2761 = apply_probability(test_bb->count, inst_edge->probability);
2763 redirect_edge_pred (uninst_edge, test_bb);
2764 uninst_edge->flags = EDGE_TRUE_VALUE;
2765 uninst_edge->probability = REG_BR_PROB_BASE / 2;
2766 uninst_edge->count
2767 = apply_probability(test_bb->count, uninst_edge->probability);
2770 // If we have no previous special cases, and we have PHIs at the beginning
2771 // of the atomic region, this means we have a loop at the beginning of the
2772 // atomic region that shares the first block. This can cause problems with
2773 // the transaction restart abnormal edges to be added in the tm_edges pass.
2774 // Solve this by adding a new empty block to receive the abnormal edges.
2775 if (region->restart_block == region->entry_block
2776 && phi_nodes (region->entry_block))
2778 basic_block empty_bb = create_empty_bb (transaction_bb);
2779 region->restart_block = empty_bb;
2780 if (current_loops && transaction_bb->loop_father)
2781 add_bb_to_loop (empty_bb, transaction_bb->loop_father);
2783 redirect_edge_pred (fallthru_edge, empty_bb);
2784 make_edge (transaction_bb, empty_bb, EDGE_FALLTHRU);
2787 return NULL;
2790 /* Generate the temporary to be used for the return value of
2791 BUILT_IN_TM_START. */
2793 static void *
2794 generate_tm_state (struct tm_region *region, void *data ATTRIBUTE_UNUSED)
2796 tree tm_start = builtin_decl_explicit (BUILT_IN_TM_START);
2797 region->tm_state =
2798 create_tmp_reg (TREE_TYPE (TREE_TYPE (tm_start)), "tm_state");
2800 // Reset the subcode, post optimizations. We'll fill this in
2801 // again as we process blocks.
2802 if (region->exit_blocks)
2804 unsigned int subcode
2805 = gimple_transaction_subcode (region->transaction_stmt);
2807 if (subcode & GTMA_DOES_GO_IRREVOCABLE)
2808 subcode &= (GTMA_DECLARATION_MASK | GTMA_DOES_GO_IRREVOCABLE
2809 | GTMA_MAY_ENTER_IRREVOCABLE);
2810 else
2811 subcode &= GTMA_DECLARATION_MASK;
2812 gimple_transaction_set_subcode (region->transaction_stmt, subcode);
2815 return NULL;
2818 // Propagate flags from inner transactions outwards.
2819 static void
2820 propagate_tm_flags_out (struct tm_region *region)
2822 if (region == NULL)
2823 return;
2824 propagate_tm_flags_out (region->inner);
2826 if (region->outer && region->outer->transaction_stmt)
2828 unsigned s = gimple_transaction_subcode (region->transaction_stmt);
2829 s &= (GTMA_HAVE_ABORT | GTMA_HAVE_LOAD | GTMA_HAVE_STORE
2830 | GTMA_MAY_ENTER_IRREVOCABLE);
2831 s |= gimple_transaction_subcode (region->outer->transaction_stmt);
2832 gimple_transaction_set_subcode (region->outer->transaction_stmt, s);
2835 propagate_tm_flags_out (region->next);
2838 /* Entry point to the MARK phase of TM expansion. Here we replace
2839 transactional memory statements with calls to builtins, and function
2840 calls with their transactional clones (if available). But we don't
2841 yet lower GIMPLE_TRANSACTION or add the transaction restart back-edges. */
2843 static unsigned int
2844 execute_tm_mark (void)
2846 pending_edge_inserts_p = false;
2848 expand_regions (all_tm_regions, generate_tm_state, NULL,
2849 /*traverse_clones=*/true);
2851 tm_log_init ();
2853 vec<tm_region_p> bb_regions
2854 = get_bb_regions_instrumented (/*traverse_clones=*/true,
2855 /*include_uninstrumented_p=*/false);
2856 struct tm_region *r;
2857 unsigned i;
2859 // Expand memory operations into calls into the runtime.
2860 // This collects log entries as well.
2861 FOR_EACH_VEC_ELT (bb_regions, i, r)
2862 if (r != NULL)
2863 expand_block_tm (r, BASIC_BLOCK (i));
2865 bb_regions.release ();
2867 // Propagate flags from inner transactions outwards.
2868 propagate_tm_flags_out (all_tm_regions);
2870 // Expand GIMPLE_TRANSACTIONs into calls into the runtime.
2871 expand_regions (all_tm_regions, expand_transaction, NULL,
2872 /*traverse_clones=*/false);
2874 tm_log_emit ();
2875 tm_log_delete ();
2877 if (pending_edge_inserts_p)
2878 gsi_commit_edge_inserts ();
2879 free_dominance_info (CDI_DOMINATORS);
2880 return 0;
2883 struct gimple_opt_pass pass_tm_mark =
2886 GIMPLE_PASS,
2887 "tmmark", /* name */
2888 OPTGROUP_NONE, /* optinfo_flags */
2889 NULL, /* gate */
2890 execute_tm_mark, /* execute */
2891 NULL, /* sub */
2892 NULL, /* next */
2893 0, /* static_pass_number */
2894 TV_TRANS_MEM, /* tv_id */
2895 PROP_ssa | PROP_cfg, /* properties_required */
2896 0, /* properties_provided */
2897 0, /* properties_destroyed */
2898 0, /* todo_flags_start */
2899 TODO_update_ssa
2900 | TODO_verify_ssa, /* todo_flags_finish */
2905 /* Create an abnormal edge from STMT at iter, splitting the block
2906 as necessary. Adjust *PNEXT as needed for the split block. */
2908 static inline void
2909 split_bb_make_tm_edge (gimple stmt, basic_block dest_bb,
2910 gimple_stmt_iterator iter, gimple_stmt_iterator *pnext)
2912 basic_block bb = gimple_bb (stmt);
2913 if (!gsi_one_before_end_p (iter))
2915 edge e = split_block (bb, stmt);
2916 *pnext = gsi_start_bb (e->dest);
2918 make_edge (bb, dest_bb, EDGE_ABNORMAL);
2920 // Record the need for the edge for the benefit of the rtl passes.
2921 if (cfun->gimple_df->tm_restart == NULL)
2922 cfun->gimple_df->tm_restart = htab_create_ggc (31, struct_ptr_hash,
2923 struct_ptr_eq, ggc_free);
2925 struct tm_restart_node dummy;
2926 dummy.stmt = stmt;
2927 dummy.label_or_list = gimple_block_label (dest_bb);
2929 void **slot = htab_find_slot (cfun->gimple_df->tm_restart, &dummy, INSERT);
2930 struct tm_restart_node *n = (struct tm_restart_node *) *slot;
2931 if (n == NULL)
2933 n = ggc_alloc_tm_restart_node ();
2934 *n = dummy;
2936 else
2938 tree old = n->label_or_list;
2939 if (TREE_CODE (old) == LABEL_DECL)
2940 old = tree_cons (NULL, old, NULL);
2941 n->label_or_list = tree_cons (NULL, dummy.label_or_list, old);
2945 /* Split block BB as necessary for every builtin function we added, and
2946 wire up the abnormal back edges implied by the transaction restart. */
2948 static void
2949 expand_block_edges (struct tm_region *const region, basic_block bb)
2951 gimple_stmt_iterator gsi, next_gsi;
2953 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi = next_gsi)
2955 gimple stmt = gsi_stmt (gsi);
2957 next_gsi = gsi;
2958 gsi_next (&next_gsi);
2960 // ??? Shouldn't we split for any non-pure, non-irrevocable function?
2961 if (gimple_code (stmt) != GIMPLE_CALL
2962 || (gimple_call_flags (stmt) & ECF_TM_BUILTIN) == 0)
2963 continue;
2965 if (DECL_FUNCTION_CODE (gimple_call_fndecl (stmt)) == BUILT_IN_TM_ABORT)
2967 // If we have a ``_transaction_cancel [[outer]]'', there is only
2968 // one abnormal edge: to the transaction marked OUTER.
2969 // All compiler-generated instances of BUILT_IN_TM_ABORT have a
2970 // constant argument, which we can examine here. Users invoking
2971 // TM_ABORT directly get what they deserve.
2972 tree arg = gimple_call_arg (stmt, 0);
2973 if (TREE_CODE (arg) == INTEGER_CST
2974 && (TREE_INT_CST_LOW (arg) & AR_OUTERABORT) != 0
2975 && !decl_is_tm_clone (current_function_decl))
2977 // Find the GTMA_IS_OUTER transaction.
2978 for (struct tm_region *o = region; o; o = o->outer)
2979 if (o->original_transaction_was_outer)
2981 split_bb_make_tm_edge (stmt, o->restart_block,
2982 gsi, &next_gsi);
2983 break;
2986 // Otherwise, the front-end should have semantically checked
2987 // outer aborts, but in either case the target region is not
2988 // within this function.
2989 continue;
2992 // Non-outer, TM aborts have an abnormal edge to the inner-most
2993 // transaction, the one being aborted;
2994 split_bb_make_tm_edge (stmt, region->restart_block, gsi, &next_gsi);
2997 // All TM builtins have an abnormal edge to the outer-most transaction.
2998 // We never restart inner transactions. For tm clones, we know a-priori
2999 // that the outer-most transaction is outside the function.
3000 if (decl_is_tm_clone (current_function_decl))
3001 continue;
3003 if (cfun->gimple_df->tm_restart == NULL)
3004 cfun->gimple_df->tm_restart
3005 = htab_create_ggc (31, struct_ptr_hash, struct_ptr_eq, ggc_free);
3007 // All TM builtins have an abnormal edge to the outer-most transaction.
3008 // We never restart inner transactions.
3009 for (struct tm_region *o = region; o; o = o->outer)
3010 if (!o->outer)
3012 split_bb_make_tm_edge (stmt, o->restart_block, gsi, &next_gsi);
3013 break;
3016 // Delete any tail-call annotation that may have been added.
3017 // The tail-call pass may have mis-identified the commit as being
3018 // a candidate because we had not yet added this restart edge.
3019 gimple_call_set_tail (stmt, false);
3023 /* Entry point to the final expansion of transactional nodes. */
3025 static unsigned int
3026 execute_tm_edges (void)
3028 vec<tm_region_p> bb_regions
3029 = get_bb_regions_instrumented (/*traverse_clones=*/false,
3030 /*include_uninstrumented_p=*/true);
3031 struct tm_region *r;
3032 unsigned i;
3034 FOR_EACH_VEC_ELT (bb_regions, i, r)
3035 if (r != NULL)
3036 expand_block_edges (r, BASIC_BLOCK (i));
3038 bb_regions.release ();
3040 /* We've got to release the dominance info now, to indicate that it
3041 must be rebuilt completely. Otherwise we'll crash trying to update
3042 the SSA web in the TODO section following this pass. */
3043 free_dominance_info (CDI_DOMINATORS);
3044 bitmap_obstack_release (&tm_obstack);
3045 all_tm_regions = NULL;
3047 return 0;
3050 struct gimple_opt_pass pass_tm_edges =
3053 GIMPLE_PASS,
3054 "tmedge", /* name */
3055 OPTGROUP_NONE, /* optinfo_flags */
3056 NULL, /* gate */
3057 execute_tm_edges, /* execute */
3058 NULL, /* sub */
3059 NULL, /* next */
3060 0, /* static_pass_number */
3061 TV_TRANS_MEM, /* tv_id */
3062 PROP_ssa | PROP_cfg, /* properties_required */
3063 0, /* properties_provided */
3064 0, /* properties_destroyed */
3065 0, /* todo_flags_start */
3066 TODO_update_ssa
3067 | TODO_verify_ssa, /* todo_flags_finish */
3071 /* Helper function for expand_regions. Expand REGION and recurse to
3072 the inner region. Call CALLBACK on each region. CALLBACK returns
3073 NULL to continue the traversal, otherwise a non-null value which
3074 this function will return as well. TRAVERSE_CLONES is true if we
3075 should traverse transactional clones. */
3077 static void *
3078 expand_regions_1 (struct tm_region *region,
3079 void *(*callback)(struct tm_region *, void *),
3080 void *data,
3081 bool traverse_clones)
3083 void *retval = NULL;
3084 if (region->exit_blocks
3085 || (traverse_clones && decl_is_tm_clone (current_function_decl)))
3087 retval = callback (region, data);
3088 if (retval)
3089 return retval;
3091 if (region->inner)
3093 retval = expand_regions (region->inner, callback, data, traverse_clones);
3094 if (retval)
3095 return retval;
3097 return retval;
3100 /* Traverse the regions enclosed and including REGION. Execute
3101 CALLBACK for each region, passing DATA. CALLBACK returns NULL to
3102 continue the traversal, otherwise a non-null value which this
3103 function will return as well. TRAVERSE_CLONES is true if we should
3104 traverse transactional clones. */
3106 static void *
3107 expand_regions (struct tm_region *region,
3108 void *(*callback)(struct tm_region *, void *),
3109 void *data,
3110 bool traverse_clones)
3112 void *retval = NULL;
3113 while (region)
3115 retval = expand_regions_1 (region, callback, data, traverse_clones);
3116 if (retval)
3117 return retval;
3118 region = region->next;
3120 return retval;
3124 /* A unique TM memory operation. */
3125 typedef struct tm_memop
3127 /* Unique ID that all memory operations to the same location have. */
3128 unsigned int value_id;
3129 /* Address of load/store. */
3130 tree addr;
3131 } *tm_memop_t;
3133 /* Sets for solving data flow equations in the memory optimization pass. */
3134 struct tm_memopt_bitmaps
3136 /* Stores available to this BB upon entry. Basically, stores that
3137 dominate this BB. */
3138 bitmap store_avail_in;
3139 /* Stores available at the end of this BB. */
3140 bitmap store_avail_out;
3141 bitmap store_antic_in;
3142 bitmap store_antic_out;
3143 /* Reads available to this BB upon entry. Basically, reads that
3144 dominate this BB. */
3145 bitmap read_avail_in;
3146 /* Reads available at the end of this BB. */
3147 bitmap read_avail_out;
3148 /* Reads performed in this BB. */
3149 bitmap read_local;
3150 /* Writes performed in this BB. */
3151 bitmap store_local;
3153 /* Temporary storage for pass. */
3154 /* Is the current BB in the worklist? */
3155 bool avail_in_worklist_p;
3156 /* Have we visited this BB? */
3157 bool visited_p;
3160 static bitmap_obstack tm_memopt_obstack;
3162 /* Unique counter for TM loads and stores. Loads and stores of the
3163 same address get the same ID. */
3164 static unsigned int tm_memopt_value_id;
3165 static htab_t tm_memopt_value_numbers;
3167 #define STORE_AVAIL_IN(BB) \
3168 ((struct tm_memopt_bitmaps *) ((BB)->aux))->store_avail_in
3169 #define STORE_AVAIL_OUT(BB) \
3170 ((struct tm_memopt_bitmaps *) ((BB)->aux))->store_avail_out
3171 #define STORE_ANTIC_IN(BB) \
3172 ((struct tm_memopt_bitmaps *) ((BB)->aux))->store_antic_in
3173 #define STORE_ANTIC_OUT(BB) \
3174 ((struct tm_memopt_bitmaps *) ((BB)->aux))->store_antic_out
3175 #define READ_AVAIL_IN(BB) \
3176 ((struct tm_memopt_bitmaps *) ((BB)->aux))->read_avail_in
3177 #define READ_AVAIL_OUT(BB) \
3178 ((struct tm_memopt_bitmaps *) ((BB)->aux))->read_avail_out
3179 #define READ_LOCAL(BB) \
3180 ((struct tm_memopt_bitmaps *) ((BB)->aux))->read_local
3181 #define STORE_LOCAL(BB) \
3182 ((struct tm_memopt_bitmaps *) ((BB)->aux))->store_local
3183 #define AVAIL_IN_WORKLIST_P(BB) \
3184 ((struct tm_memopt_bitmaps *) ((BB)->aux))->avail_in_worklist_p
3185 #define BB_VISITED_P(BB) \
3186 ((struct tm_memopt_bitmaps *) ((BB)->aux))->visited_p
3188 /* Htab support. Return a hash value for a `tm_memop'. */
3189 static hashval_t
3190 tm_memop_hash (const void *p)
3192 const struct tm_memop *mem = (const struct tm_memop *) p;
3193 tree addr = mem->addr;
3194 /* We drill down to the SSA_NAME/DECL for the hash, but equality is
3195 actually done with operand_equal_p (see tm_memop_eq). */
3196 if (TREE_CODE (addr) == ADDR_EXPR)
3197 addr = TREE_OPERAND (addr, 0);
3198 return iterative_hash_expr (addr, 0);
3201 /* Htab support. Return true if two tm_memop's are the same. */
3202 static int
3203 tm_memop_eq (const void *p1, const void *p2)
3205 const struct tm_memop *mem1 = (const struct tm_memop *) p1;
3206 const struct tm_memop *mem2 = (const struct tm_memop *) p2;
3208 return operand_equal_p (mem1->addr, mem2->addr, 0);
3211 /* Given a TM load/store in STMT, return the value number for the address
3212 it accesses. */
3214 static unsigned int
3215 tm_memopt_value_number (gimple stmt, enum insert_option op)
3217 struct tm_memop tmpmem, *mem;
3218 void **slot;
3220 gcc_assert (is_tm_load (stmt) || is_tm_store (stmt));
3221 tmpmem.addr = gimple_call_arg (stmt, 0);
3222 slot = htab_find_slot (tm_memopt_value_numbers, &tmpmem, op);
3223 if (*slot)
3224 mem = (struct tm_memop *) *slot;
3225 else if (op == INSERT)
3227 mem = XNEW (struct tm_memop);
3228 *slot = mem;
3229 mem->value_id = tm_memopt_value_id++;
3230 mem->addr = tmpmem.addr;
3232 else
3233 gcc_unreachable ();
3234 return mem->value_id;
3237 /* Accumulate TM memory operations in BB into STORE_LOCAL and READ_LOCAL. */
3239 static void
3240 tm_memopt_accumulate_memops (basic_block bb)
3242 gimple_stmt_iterator gsi;
3244 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
3246 gimple stmt = gsi_stmt (gsi);
3247 bitmap bits;
3248 unsigned int loc;
3250 if (is_tm_store (stmt))
3251 bits = STORE_LOCAL (bb);
3252 else if (is_tm_load (stmt))
3253 bits = READ_LOCAL (bb);
3254 else
3255 continue;
3257 loc = tm_memopt_value_number (stmt, INSERT);
3258 bitmap_set_bit (bits, loc);
3259 if (dump_file)
3261 fprintf (dump_file, "TM memopt (%s): value num=%d, BB=%d, addr=",
3262 is_tm_load (stmt) ? "LOAD" : "STORE", loc,
3263 gimple_bb (stmt)->index);
3264 print_generic_expr (dump_file, gimple_call_arg (stmt, 0), 0);
3265 fprintf (dump_file, "\n");
3270 /* Prettily dump one of the memopt sets. BITS is the bitmap to dump. */
3272 static void
3273 dump_tm_memopt_set (const char *set_name, bitmap bits)
3275 unsigned i;
3276 bitmap_iterator bi;
3277 const char *comma = "";
3279 fprintf (dump_file, "TM memopt: %s: [", set_name);
3280 EXECUTE_IF_SET_IN_BITMAP (bits, 0, i, bi)
3282 htab_iterator hi;
3283 struct tm_memop *mem;
3285 /* Yeah, yeah, yeah. Whatever. This is just for debugging. */
3286 FOR_EACH_HTAB_ELEMENT (tm_memopt_value_numbers, mem, tm_memop_t, hi)
3287 if (mem->value_id == i)
3288 break;
3289 gcc_assert (mem->value_id == i);
3290 fprintf (dump_file, "%s", comma);
3291 comma = ", ";
3292 print_generic_expr (dump_file, mem->addr, 0);
3294 fprintf (dump_file, "]\n");
3297 /* Prettily dump all of the memopt sets in BLOCKS. */
3299 static void
3300 dump_tm_memopt_sets (vec<basic_block> blocks)
3302 size_t i;
3303 basic_block bb;
3305 for (i = 0; blocks.iterate (i, &bb); ++i)
3307 fprintf (dump_file, "------------BB %d---------\n", bb->index);
3308 dump_tm_memopt_set ("STORE_LOCAL", STORE_LOCAL (bb));
3309 dump_tm_memopt_set ("READ_LOCAL", READ_LOCAL (bb));
3310 dump_tm_memopt_set ("STORE_AVAIL_IN", STORE_AVAIL_IN (bb));
3311 dump_tm_memopt_set ("STORE_AVAIL_OUT", STORE_AVAIL_OUT (bb));
3312 dump_tm_memopt_set ("READ_AVAIL_IN", READ_AVAIL_IN (bb));
3313 dump_tm_memopt_set ("READ_AVAIL_OUT", READ_AVAIL_OUT (bb));
3317 /* Compute {STORE,READ}_AVAIL_IN for the basic block BB. */
3319 static void
3320 tm_memopt_compute_avin (basic_block bb)
3322 edge e;
3323 unsigned ix;
3325 /* Seed with the AVOUT of any predecessor. */
3326 for (ix = 0; ix < EDGE_COUNT (bb->preds); ix++)
3328 e = EDGE_PRED (bb, ix);
3329 /* Make sure we have already visited this BB, and is thus
3330 initialized.
3332 If e->src->aux is NULL, this predecessor is actually on an
3333 enclosing transaction. We only care about the current
3334 transaction, so ignore it. */
3335 if (e->src->aux && BB_VISITED_P (e->src))
3337 bitmap_copy (STORE_AVAIL_IN (bb), STORE_AVAIL_OUT (e->src));
3338 bitmap_copy (READ_AVAIL_IN (bb), READ_AVAIL_OUT (e->src));
3339 break;
3343 for (; ix < EDGE_COUNT (bb->preds); ix++)
3345 e = EDGE_PRED (bb, ix);
3346 if (e->src->aux && BB_VISITED_P (e->src))
3348 bitmap_and_into (STORE_AVAIL_IN (bb), STORE_AVAIL_OUT (e->src));
3349 bitmap_and_into (READ_AVAIL_IN (bb), READ_AVAIL_OUT (e->src));
3353 BB_VISITED_P (bb) = true;
3356 /* Compute the STORE_ANTIC_IN for the basic block BB. */
3358 static void
3359 tm_memopt_compute_antin (basic_block bb)
3361 edge e;
3362 unsigned ix;
3364 /* Seed with the ANTIC_OUT of any successor. */
3365 for (ix = 0; ix < EDGE_COUNT (bb->succs); ix++)
3367 e = EDGE_SUCC (bb, ix);
3368 /* Make sure we have already visited this BB, and is thus
3369 initialized. */
3370 if (BB_VISITED_P (e->dest))
3372 bitmap_copy (STORE_ANTIC_IN (bb), STORE_ANTIC_OUT (e->dest));
3373 break;
3377 for (; ix < EDGE_COUNT (bb->succs); ix++)
3379 e = EDGE_SUCC (bb, ix);
3380 if (BB_VISITED_P (e->dest))
3381 bitmap_and_into (STORE_ANTIC_IN (bb), STORE_ANTIC_OUT (e->dest));
3384 BB_VISITED_P (bb) = true;
3387 /* Compute the AVAIL sets for every basic block in BLOCKS.
3389 We compute {STORE,READ}_AVAIL_{OUT,IN} as follows:
3391 AVAIL_OUT[bb] = union (AVAIL_IN[bb], LOCAL[bb])
3392 AVAIL_IN[bb] = intersect (AVAIL_OUT[predecessors])
3394 This is basically what we do in lcm's compute_available(), but here
3395 we calculate two sets of sets (one for STOREs and one for READs),
3396 and we work on a region instead of the entire CFG.
3398 REGION is the TM region.
3399 BLOCKS are the basic blocks in the region. */
3401 static void
3402 tm_memopt_compute_available (struct tm_region *region,
3403 vec<basic_block> blocks)
3405 edge e;
3406 basic_block *worklist, *qin, *qout, *qend, bb;
3407 unsigned int qlen, i;
3408 edge_iterator ei;
3409 bool changed;
3411 /* Allocate a worklist array/queue. Entries are only added to the
3412 list if they were not already on the list. So the size is
3413 bounded by the number of basic blocks in the region. */
3414 qlen = blocks.length () - 1;
3415 qin = qout = worklist =
3416 XNEWVEC (basic_block, qlen);
3418 /* Put every block in the region on the worklist. */
3419 for (i = 0; blocks.iterate (i, &bb); ++i)
3421 /* Seed AVAIL_OUT with the LOCAL set. */
3422 bitmap_ior_into (STORE_AVAIL_OUT (bb), STORE_LOCAL (bb));
3423 bitmap_ior_into (READ_AVAIL_OUT (bb), READ_LOCAL (bb));
3425 AVAIL_IN_WORKLIST_P (bb) = true;
3426 /* No need to insert the entry block, since it has an AVIN of
3427 null, and an AVOUT that has already been seeded in. */
3428 if (bb != region->entry_block)
3429 *qin++ = bb;
3432 /* The entry block has been initialized with the local sets. */
3433 BB_VISITED_P (region->entry_block) = true;
3435 qin = worklist;
3436 qend = &worklist[qlen];
3438 /* Iterate until the worklist is empty. */
3439 while (qlen)
3441 /* Take the first entry off the worklist. */
3442 bb = *qout++;
3443 qlen--;
3445 if (qout >= qend)
3446 qout = worklist;
3448 /* This block can be added to the worklist again if necessary. */
3449 AVAIL_IN_WORKLIST_P (bb) = false;
3450 tm_memopt_compute_avin (bb);
3452 /* Note: We do not add the LOCAL sets here because we already
3453 seeded the AVAIL_OUT sets with them. */
3454 changed = bitmap_ior_into (STORE_AVAIL_OUT (bb), STORE_AVAIL_IN (bb));
3455 changed |= bitmap_ior_into (READ_AVAIL_OUT (bb), READ_AVAIL_IN (bb));
3456 if (changed
3457 && (region->exit_blocks == NULL
3458 || !bitmap_bit_p (region->exit_blocks, bb->index)))
3459 /* If the out state of this block changed, then we need to add
3460 its successors to the worklist if they are not already in. */
3461 FOR_EACH_EDGE (e, ei, bb->succs)
3462 if (!AVAIL_IN_WORKLIST_P (e->dest) && e->dest != EXIT_BLOCK_PTR)
3464 *qin++ = e->dest;
3465 AVAIL_IN_WORKLIST_P (e->dest) = true;
3466 qlen++;
3468 if (qin >= qend)
3469 qin = worklist;
3473 free (worklist);
3475 if (dump_file)
3476 dump_tm_memopt_sets (blocks);
3479 /* Compute ANTIC sets for every basic block in BLOCKS.
3481 We compute STORE_ANTIC_OUT as follows:
3483 STORE_ANTIC_OUT[bb] = union(STORE_ANTIC_IN[bb], STORE_LOCAL[bb])
3484 STORE_ANTIC_IN[bb] = intersect(STORE_ANTIC_OUT[successors])
3486 REGION is the TM region.
3487 BLOCKS are the basic blocks in the region. */
3489 static void
3490 tm_memopt_compute_antic (struct tm_region *region,
3491 vec<basic_block> blocks)
3493 edge e;
3494 basic_block *worklist, *qin, *qout, *qend, bb;
3495 unsigned int qlen;
3496 int i;
3497 edge_iterator ei;
3499 /* Allocate a worklist array/queue. Entries are only added to the
3500 list if they were not already on the list. So the size is
3501 bounded by the number of basic blocks in the region. */
3502 qin = qout = worklist = XNEWVEC (basic_block, blocks.length ());
3504 for (qlen = 0, i = blocks.length () - 1; i >= 0; --i)
3506 bb = blocks[i];
3508 /* Seed ANTIC_OUT with the LOCAL set. */
3509 bitmap_ior_into (STORE_ANTIC_OUT (bb), STORE_LOCAL (bb));
3511 /* Put every block in the region on the worklist. */
3512 AVAIL_IN_WORKLIST_P (bb) = true;
3513 /* No need to insert exit blocks, since their ANTIC_IN is NULL,
3514 and their ANTIC_OUT has already been seeded in. */
3515 if (region->exit_blocks
3516 && !bitmap_bit_p (region->exit_blocks, bb->index))
3518 qlen++;
3519 *qin++ = bb;
3523 /* The exit blocks have been initialized with the local sets. */
3524 if (region->exit_blocks)
3526 unsigned int i;
3527 bitmap_iterator bi;
3528 EXECUTE_IF_SET_IN_BITMAP (region->exit_blocks, 0, i, bi)
3529 BB_VISITED_P (BASIC_BLOCK (i)) = true;
3532 qin = worklist;
3533 qend = &worklist[qlen];
3535 /* Iterate until the worklist is empty. */
3536 while (qlen)
3538 /* Take the first entry off the worklist. */
3539 bb = *qout++;
3540 qlen--;
3542 if (qout >= qend)
3543 qout = worklist;
3545 /* This block can be added to the worklist again if necessary. */
3546 AVAIL_IN_WORKLIST_P (bb) = false;
3547 tm_memopt_compute_antin (bb);
3549 /* Note: We do not add the LOCAL sets here because we already
3550 seeded the ANTIC_OUT sets with them. */
3551 if (bitmap_ior_into (STORE_ANTIC_OUT (bb), STORE_ANTIC_IN (bb))
3552 && bb != region->entry_block)
3553 /* If the out state of this block changed, then we need to add
3554 its predecessors to the worklist if they are not already in. */
3555 FOR_EACH_EDGE (e, ei, bb->preds)
3556 if (!AVAIL_IN_WORKLIST_P (e->src))
3558 *qin++ = e->src;
3559 AVAIL_IN_WORKLIST_P (e->src) = true;
3560 qlen++;
3562 if (qin >= qend)
3563 qin = worklist;
3567 free (worklist);
3569 if (dump_file)
3570 dump_tm_memopt_sets (blocks);
3573 /* Offsets of load variants from TM_LOAD. For example,
3574 BUILT_IN_TM_LOAD_RAR* is an offset of 1 from BUILT_IN_TM_LOAD*.
3575 See gtm-builtins.def. */
3576 #define TRANSFORM_RAR 1
3577 #define TRANSFORM_RAW 2
3578 #define TRANSFORM_RFW 3
3579 /* Offsets of store variants from TM_STORE. */
3580 #define TRANSFORM_WAR 1
3581 #define TRANSFORM_WAW 2
3583 /* Inform about a load/store optimization. */
3585 static void
3586 dump_tm_memopt_transform (gimple stmt)
3588 if (dump_file)
3590 fprintf (dump_file, "TM memopt: transforming: ");
3591 print_gimple_stmt (dump_file, stmt, 0, 0);
3592 fprintf (dump_file, "\n");
3596 /* Perform a read/write optimization. Replaces the TM builtin in STMT
3597 by a builtin that is OFFSET entries down in the builtins table in
3598 gtm-builtins.def. */
3600 static void
3601 tm_memopt_transform_stmt (unsigned int offset,
3602 gimple stmt,
3603 gimple_stmt_iterator *gsi)
3605 tree fn = gimple_call_fn (stmt);
3606 gcc_assert (TREE_CODE (fn) == ADDR_EXPR);
3607 TREE_OPERAND (fn, 0)
3608 = builtin_decl_explicit ((enum built_in_function)
3609 (DECL_FUNCTION_CODE (TREE_OPERAND (fn, 0))
3610 + offset));
3611 gimple_call_set_fn (stmt, fn);
3612 gsi_replace (gsi, stmt, true);
3613 dump_tm_memopt_transform (stmt);
3616 /* Perform the actual TM memory optimization transformations in the
3617 basic blocks in BLOCKS. */
3619 static void
3620 tm_memopt_transform_blocks (vec<basic_block> blocks)
3622 size_t i;
3623 basic_block bb;
3624 gimple_stmt_iterator gsi;
3626 for (i = 0; blocks.iterate (i, &bb); ++i)
3628 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
3630 gimple stmt = gsi_stmt (gsi);
3631 bitmap read_avail = READ_AVAIL_IN (bb);
3632 bitmap store_avail = STORE_AVAIL_IN (bb);
3633 bitmap store_antic = STORE_ANTIC_OUT (bb);
3634 unsigned int loc;
3636 if (is_tm_simple_load (stmt))
3638 loc = tm_memopt_value_number (stmt, NO_INSERT);
3639 if (store_avail && bitmap_bit_p (store_avail, loc))
3640 tm_memopt_transform_stmt (TRANSFORM_RAW, stmt, &gsi);
3641 else if (store_antic && bitmap_bit_p (store_antic, loc))
3643 tm_memopt_transform_stmt (TRANSFORM_RFW, stmt, &gsi);
3644 bitmap_set_bit (store_avail, loc);
3646 else if (read_avail && bitmap_bit_p (read_avail, loc))
3647 tm_memopt_transform_stmt (TRANSFORM_RAR, stmt, &gsi);
3648 else
3649 bitmap_set_bit (read_avail, loc);
3651 else if (is_tm_simple_store (stmt))
3653 loc = tm_memopt_value_number (stmt, NO_INSERT);
3654 if (store_avail && bitmap_bit_p (store_avail, loc))
3655 tm_memopt_transform_stmt (TRANSFORM_WAW, stmt, &gsi);
3656 else
3658 if (read_avail && bitmap_bit_p (read_avail, loc))
3659 tm_memopt_transform_stmt (TRANSFORM_WAR, stmt, &gsi);
3660 bitmap_set_bit (store_avail, loc);
3667 /* Return a new set of bitmaps for a BB. */
3669 static struct tm_memopt_bitmaps *
3670 tm_memopt_init_sets (void)
3672 struct tm_memopt_bitmaps *b
3673 = XOBNEW (&tm_memopt_obstack.obstack, struct tm_memopt_bitmaps);
3674 b->store_avail_in = BITMAP_ALLOC (&tm_memopt_obstack);
3675 b->store_avail_out = BITMAP_ALLOC (&tm_memopt_obstack);
3676 b->store_antic_in = BITMAP_ALLOC (&tm_memopt_obstack);
3677 b->store_antic_out = BITMAP_ALLOC (&tm_memopt_obstack);
3678 b->store_avail_out = BITMAP_ALLOC (&tm_memopt_obstack);
3679 b->read_avail_in = BITMAP_ALLOC (&tm_memopt_obstack);
3680 b->read_avail_out = BITMAP_ALLOC (&tm_memopt_obstack);
3681 b->read_local = BITMAP_ALLOC (&tm_memopt_obstack);
3682 b->store_local = BITMAP_ALLOC (&tm_memopt_obstack);
3683 return b;
3686 /* Free sets computed for each BB. */
3688 static void
3689 tm_memopt_free_sets (vec<basic_block> blocks)
3691 size_t i;
3692 basic_block bb;
3694 for (i = 0; blocks.iterate (i, &bb); ++i)
3695 bb->aux = NULL;
3698 /* Clear the visited bit for every basic block in BLOCKS. */
3700 static void
3701 tm_memopt_clear_visited (vec<basic_block> blocks)
3703 size_t i;
3704 basic_block bb;
3706 for (i = 0; blocks.iterate (i, &bb); ++i)
3707 BB_VISITED_P (bb) = false;
3710 /* Replace TM load/stores with hints for the runtime. We handle
3711 things like read-after-write, write-after-read, read-after-read,
3712 read-for-write, etc. */
3714 static unsigned int
3715 execute_tm_memopt (void)
3717 struct tm_region *region;
3718 vec<basic_block> bbs;
3720 tm_memopt_value_id = 0;
3721 tm_memopt_value_numbers = htab_create (10, tm_memop_hash, tm_memop_eq, free);
3723 for (region = all_tm_regions; region; region = region->next)
3725 /* All the TM stores/loads in the current region. */
3726 size_t i;
3727 basic_block bb;
3729 bitmap_obstack_initialize (&tm_memopt_obstack);
3731 /* Save all BBs for the current region. */
3732 bbs = get_tm_region_blocks (region->entry_block,
3733 region->exit_blocks,
3734 region->irr_blocks,
3735 NULL,
3736 false);
3738 /* Collect all the memory operations. */
3739 for (i = 0; bbs.iterate (i, &bb); ++i)
3741 bb->aux = tm_memopt_init_sets ();
3742 tm_memopt_accumulate_memops (bb);
3745 /* Solve data flow equations and transform each block accordingly. */
3746 tm_memopt_clear_visited (bbs);
3747 tm_memopt_compute_available (region, bbs);
3748 tm_memopt_clear_visited (bbs);
3749 tm_memopt_compute_antic (region, bbs);
3750 tm_memopt_transform_blocks (bbs);
3752 tm_memopt_free_sets (bbs);
3753 bbs.release ();
3754 bitmap_obstack_release (&tm_memopt_obstack);
3755 htab_empty (tm_memopt_value_numbers);
3758 htab_delete (tm_memopt_value_numbers);
3759 return 0;
3762 static bool
3763 gate_tm_memopt (void)
3765 return flag_tm && optimize > 0;
3768 struct gimple_opt_pass pass_tm_memopt =
3771 GIMPLE_PASS,
3772 "tmmemopt", /* name */
3773 OPTGROUP_NONE, /* optinfo_flags */
3774 gate_tm_memopt, /* gate */
3775 execute_tm_memopt, /* execute */
3776 NULL, /* sub */
3777 NULL, /* next */
3778 0, /* static_pass_number */
3779 TV_TRANS_MEM, /* tv_id */
3780 PROP_ssa | PROP_cfg, /* properties_required */
3781 0, /* properties_provided */
3782 0, /* properties_destroyed */
3783 0, /* todo_flags_start */
3784 0, /* todo_flags_finish */
3789 /* Interprocedual analysis for the creation of transactional clones.
3790 The aim of this pass is to find which functions are referenced in
3791 a non-irrevocable transaction context, and for those over which
3792 we have control (or user directive), create a version of the
3793 function which uses only the transactional interface to reference
3794 protected memories. This analysis proceeds in several steps:
3796 (1) Collect the set of all possible transactional clones:
3798 (a) For all local public functions marked tm_callable, push
3799 it onto the tm_callee queue.
3801 (b) For all local functions, scan for calls in transaction blocks.
3802 Push the caller and callee onto the tm_caller and tm_callee
3803 queues. Count the number of callers for each callee.
3805 (c) For each local function on the callee list, assume we will
3806 create a transactional clone. Push *all* calls onto the
3807 callee queues; count the number of clone callers separately
3808 to the number of original callers.
3810 (2) Propagate irrevocable status up the dominator tree:
3812 (a) Any external function on the callee list that is not marked
3813 tm_callable is irrevocable. Push all callers of such onto
3814 a worklist.
3816 (b) For each function on the worklist, mark each block that
3817 contains an irrevocable call. Use the AND operator to
3818 propagate that mark up the dominator tree.
3820 (c) If we reach the entry block for a possible transactional
3821 clone, then the transactional clone is irrevocable, and
3822 we should not create the clone after all. Push all
3823 callers onto the worklist.
3825 (d) Place tm_irrevocable calls at the beginning of the relevant
3826 blocks. Special case here is the entry block for the entire
3827 transaction region; there we mark it GTMA_DOES_GO_IRREVOCABLE for
3828 the library to begin the region in serial mode. Decrement
3829 the call count for all callees in the irrevocable region.
3831 (3) Create the transactional clones:
3833 Any tm_callee that still has a non-zero call count is cloned.
3836 /* This structure is stored in the AUX field of each cgraph_node. */
3837 struct tm_ipa_cg_data
3839 /* The clone of the function that got created. */
3840 struct cgraph_node *clone;
3842 /* The tm regions in the normal function. */
3843 struct tm_region *all_tm_regions;
3845 /* The blocks of the normal/clone functions that contain irrevocable
3846 calls, or blocks that are post-dominated by irrevocable calls. */
3847 bitmap irrevocable_blocks_normal;
3848 bitmap irrevocable_blocks_clone;
3850 /* The blocks of the normal function that are involved in transactions. */
3851 bitmap transaction_blocks_normal;
3853 /* The number of callers to the transactional clone of this function
3854 from normal and transactional clones respectively. */
3855 unsigned tm_callers_normal;
3856 unsigned tm_callers_clone;
3858 /* True if all calls to this function's transactional clone
3859 are irrevocable. Also automatically true if the function
3860 has no transactional clone. */
3861 bool is_irrevocable;
3863 /* Flags indicating the presence of this function in various queues. */
3864 bool in_callee_queue;
3865 bool in_worklist;
3867 /* Flags indicating the kind of scan desired while in the worklist. */
3868 bool want_irr_scan_normal;
3871 typedef vec<cgraph_node_ptr> cgraph_node_queue;
3873 /* Return the ipa data associated with NODE, allocating zeroed memory
3874 if necessary. TRAVERSE_ALIASES is true if we must traverse aliases
3875 and set *NODE accordingly. */
3877 static struct tm_ipa_cg_data *
3878 get_cg_data (struct cgraph_node **node, bool traverse_aliases)
3880 struct tm_ipa_cg_data *d;
3882 if (traverse_aliases && (*node)->alias)
3883 *node = cgraph_get_node ((*node)->thunk.alias);
3885 d = (struct tm_ipa_cg_data *) (*node)->symbol.aux;
3887 if (d == NULL)
3889 d = (struct tm_ipa_cg_data *)
3890 obstack_alloc (&tm_obstack.obstack, sizeof (*d));
3891 (*node)->symbol.aux = (void *) d;
3892 memset (d, 0, sizeof (*d));
3895 return d;
3898 /* Add NODE to the end of QUEUE, unless IN_QUEUE_P indicates that
3899 it is already present. */
3901 static void
3902 maybe_push_queue (struct cgraph_node *node,
3903 cgraph_node_queue *queue_p, bool *in_queue_p)
3905 if (!*in_queue_p)
3907 *in_queue_p = true;
3908 queue_p->safe_push (node);
3912 /* Duplicate the basic blocks in QUEUE for use in the uninstrumented
3913 code path. QUEUE are the basic blocks inside the transaction
3914 represented in REGION.
3916 Later in split_code_paths() we will add the conditional to choose
3917 between the two alternatives. */
3919 static void
3920 ipa_uninstrument_transaction (struct tm_region *region,
3921 vec<basic_block> queue)
3923 gimple transaction = region->transaction_stmt;
3924 basic_block transaction_bb = gimple_bb (transaction);
3925 int n = queue.length ();
3926 basic_block *new_bbs = XNEWVEC (basic_block, n);
3928 copy_bbs (queue.address (), n, new_bbs, NULL, 0, NULL, NULL, transaction_bb);
3929 edge e = make_edge (transaction_bb, new_bbs[0], EDGE_TM_UNINSTRUMENTED);
3930 add_phi_args_after_copy (new_bbs, n, e);
3932 // Now we will have a GIMPLE_ATOMIC with 3 possible edges out of it.
3933 // a) EDGE_FALLTHRU into the transaction
3934 // b) EDGE_TM_ABORT out of the transaction
3935 // c) EDGE_TM_UNINSTRUMENTED into the uninstrumented blocks.
3937 free (new_bbs);
3940 /* A subroutine of ipa_tm_scan_calls_transaction and ipa_tm_scan_calls_clone.
3941 Queue all callees within block BB. */
3943 static void
3944 ipa_tm_scan_calls_block (cgraph_node_queue *callees_p,
3945 basic_block bb, bool for_clone)
3947 gimple_stmt_iterator gsi;
3949 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
3951 gimple stmt = gsi_stmt (gsi);
3952 if (is_gimple_call (stmt) && !is_tm_pure_call (stmt))
3954 tree fndecl = gimple_call_fndecl (stmt);
3955 if (fndecl)
3957 struct tm_ipa_cg_data *d;
3958 unsigned *pcallers;
3959 struct cgraph_node *node;
3961 if (is_tm_ending_fndecl (fndecl))
3962 continue;
3963 if (find_tm_replacement_function (fndecl))
3964 continue;
3966 node = cgraph_get_node (fndecl);
3967 gcc_assert (node != NULL);
3968 d = get_cg_data (&node, true);
3970 pcallers = (for_clone ? &d->tm_callers_clone
3971 : &d->tm_callers_normal);
3972 *pcallers += 1;
3974 maybe_push_queue (node, callees_p, &d->in_callee_queue);
3980 /* Scan all calls in NODE that are within a transaction region,
3981 and push the resulting nodes into the callee queue. */
3983 static void
3984 ipa_tm_scan_calls_transaction (struct tm_ipa_cg_data *d,
3985 cgraph_node_queue *callees_p)
3987 struct tm_region *r;
3989 d->transaction_blocks_normal = BITMAP_ALLOC (&tm_obstack);
3990 d->all_tm_regions = all_tm_regions;
3992 for (r = all_tm_regions; r; r = r->next)
3994 vec<basic_block> bbs;
3995 basic_block bb;
3996 unsigned i;
3998 bbs = get_tm_region_blocks (r->entry_block, r->exit_blocks, NULL,
3999 d->transaction_blocks_normal, false);
4001 // Generate the uninstrumented code path for this transaction.
4002 ipa_uninstrument_transaction (r, bbs);
4004 FOR_EACH_VEC_ELT (bbs, i, bb)
4005 ipa_tm_scan_calls_block (callees_p, bb, false);
4007 bbs.release ();
4010 // ??? copy_bbs should maintain cgraph edges for the blocks as it is
4011 // copying them, rather than forcing us to do this externally.
4012 rebuild_cgraph_edges ();
4014 // ??? In ipa_uninstrument_transaction we don't try to update dominators
4015 // because copy_bbs doesn't return a VEC like iterate_fix_dominators expects.
4016 // Instead, just release dominators here so update_ssa recomputes them.
4017 free_dominance_info (CDI_DOMINATORS);
4019 // When building the uninstrumented code path, copy_bbs will have invoked
4020 // create_new_def_for starting an "ssa update context". There is only one
4021 // instance of this context, so resolve ssa updates before moving on to
4022 // the next function.
4023 update_ssa (TODO_update_ssa);
4026 /* Scan all calls in NODE as if this is the transactional clone,
4027 and push the destinations into the callee queue. */
4029 static void
4030 ipa_tm_scan_calls_clone (struct cgraph_node *node,
4031 cgraph_node_queue *callees_p)
4033 struct function *fn = DECL_STRUCT_FUNCTION (node->symbol.decl);
4034 basic_block bb;
4036 FOR_EACH_BB_FN (bb, fn)
4037 ipa_tm_scan_calls_block (callees_p, bb, true);
4040 /* The function NODE has been detected to be irrevocable. Push all
4041 of its callers onto WORKLIST for the purpose of re-scanning them. */
4043 static void
4044 ipa_tm_note_irrevocable (struct cgraph_node *node,
4045 cgraph_node_queue *worklist_p)
4047 struct tm_ipa_cg_data *d = get_cg_data (&node, true);
4048 struct cgraph_edge *e;
4050 d->is_irrevocable = true;
4052 for (e = node->callers; e ; e = e->next_caller)
4054 basic_block bb;
4055 struct cgraph_node *caller;
4057 /* Don't examine recursive calls. */
4058 if (e->caller == node)
4059 continue;
4060 /* Even if we think we can go irrevocable, believe the user
4061 above all. */
4062 if (is_tm_safe_or_pure (e->caller->symbol.decl))
4063 continue;
4065 caller = e->caller;
4066 d = get_cg_data (&caller, true);
4068 /* Check if the callee is in a transactional region. If so,
4069 schedule the function for normal re-scan as well. */
4070 bb = gimple_bb (e->call_stmt);
4071 gcc_assert (bb != NULL);
4072 if (d->transaction_blocks_normal
4073 && bitmap_bit_p (d->transaction_blocks_normal, bb->index))
4074 d->want_irr_scan_normal = true;
4076 maybe_push_queue (caller, worklist_p, &d->in_worklist);
4080 /* A subroutine of ipa_tm_scan_irr_blocks; return true iff any statement
4081 within the block is irrevocable. */
4083 static bool
4084 ipa_tm_scan_irr_block (basic_block bb)
4086 gimple_stmt_iterator gsi;
4087 tree fn;
4089 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
4091 gimple stmt = gsi_stmt (gsi);
4092 switch (gimple_code (stmt))
4094 case GIMPLE_ASSIGN:
4095 if (gimple_assign_single_p (stmt))
4097 tree lhs = gimple_assign_lhs (stmt);
4098 tree rhs = gimple_assign_rhs1 (stmt);
4099 if (volatile_var_p (lhs) || volatile_var_p (rhs))
4100 return true;
4102 break;
4104 case GIMPLE_CALL:
4106 tree lhs = gimple_call_lhs (stmt);
4107 if (lhs && volatile_var_p (lhs))
4108 return true;
4110 if (is_tm_pure_call (stmt))
4111 break;
4113 fn = gimple_call_fn (stmt);
4115 /* Functions with the attribute are by definition irrevocable. */
4116 if (is_tm_irrevocable (fn))
4117 return true;
4119 /* For direct function calls, go ahead and check for replacement
4120 functions, or transitive irrevocable functions. For indirect
4121 functions, we'll ask the runtime. */
4122 if (TREE_CODE (fn) == ADDR_EXPR)
4124 struct tm_ipa_cg_data *d;
4125 struct cgraph_node *node;
4127 fn = TREE_OPERAND (fn, 0);
4128 if (is_tm_ending_fndecl (fn))
4129 break;
4130 if (find_tm_replacement_function (fn))
4131 break;
4133 node = cgraph_get_node(fn);
4134 d = get_cg_data (&node, true);
4136 /* Return true if irrevocable, but above all, believe
4137 the user. */
4138 if (d->is_irrevocable
4139 && !is_tm_safe_or_pure (fn))
4140 return true;
4142 break;
4145 case GIMPLE_ASM:
4146 /* ??? The Approved Method of indicating that an inline
4147 assembly statement is not relevant to the transaction
4148 is to wrap it in a __tm_waiver block. This is not
4149 yet implemented, so we can't check for it. */
4150 if (is_tm_safe (current_function_decl))
4152 tree t = build1 (NOP_EXPR, void_type_node, size_zero_node);
4153 SET_EXPR_LOCATION (t, gimple_location (stmt));
4154 error ("%Kasm not allowed in %<transaction_safe%> function", t);
4156 return true;
4158 default:
4159 break;
4163 return false;
4166 /* For each of the blocks seeded witin PQUEUE, walk the CFG looking
4167 for new irrevocable blocks, marking them in NEW_IRR. Don't bother
4168 scanning past OLD_IRR or EXIT_BLOCKS. */
4170 static bool
4171 ipa_tm_scan_irr_blocks (vec<basic_block> *pqueue, bitmap new_irr,
4172 bitmap old_irr, bitmap exit_blocks)
4174 bool any_new_irr = false;
4175 edge e;
4176 edge_iterator ei;
4177 bitmap visited_blocks = BITMAP_ALLOC (NULL);
4181 basic_block bb = pqueue->pop ();
4183 /* Don't re-scan blocks we know already are irrevocable. */
4184 if (old_irr && bitmap_bit_p (old_irr, bb->index))
4185 continue;
4187 if (ipa_tm_scan_irr_block (bb))
4189 bitmap_set_bit (new_irr, bb->index);
4190 any_new_irr = true;
4192 else if (exit_blocks == NULL || !bitmap_bit_p (exit_blocks, bb->index))
4194 FOR_EACH_EDGE (e, ei, bb->succs)
4195 if (!bitmap_bit_p (visited_blocks, e->dest->index))
4197 bitmap_set_bit (visited_blocks, e->dest->index);
4198 pqueue->safe_push (e->dest);
4202 while (!pqueue->is_empty ());
4204 BITMAP_FREE (visited_blocks);
4206 return any_new_irr;
4209 /* Propagate the irrevocable property both up and down the dominator tree.
4210 BB is the current block being scanned; EXIT_BLOCKS are the edges of the
4211 TM regions; OLD_IRR are the results of a previous scan of the dominator
4212 tree which has been fully propagated; NEW_IRR is the set of new blocks
4213 which are gaining the irrevocable property during the current scan. */
4215 static void
4216 ipa_tm_propagate_irr (basic_block entry_block, bitmap new_irr,
4217 bitmap old_irr, bitmap exit_blocks)
4219 vec<basic_block> bbs;
4220 bitmap all_region_blocks;
4222 /* If this block is in the old set, no need to rescan. */
4223 if (old_irr && bitmap_bit_p (old_irr, entry_block->index))
4224 return;
4226 all_region_blocks = BITMAP_ALLOC (&tm_obstack);
4227 bbs = get_tm_region_blocks (entry_block, exit_blocks, NULL,
4228 all_region_blocks, false);
4231 basic_block bb = bbs.pop ();
4232 bool this_irr = bitmap_bit_p (new_irr, bb->index);
4233 bool all_son_irr = false;
4234 edge_iterator ei;
4235 edge e;
4237 /* Propagate up. If my children are, I am too, but we must have
4238 at least one child that is. */
4239 if (!this_irr)
4241 FOR_EACH_EDGE (e, ei, bb->succs)
4243 if (!bitmap_bit_p (new_irr, e->dest->index))
4245 all_son_irr = false;
4246 break;
4248 else
4249 all_son_irr = true;
4251 if (all_son_irr)
4253 /* Add block to new_irr if it hasn't already been processed. */
4254 if (!old_irr || !bitmap_bit_p (old_irr, bb->index))
4256 bitmap_set_bit (new_irr, bb->index);
4257 this_irr = true;
4262 /* Propagate down to everyone we immediately dominate. */
4263 if (this_irr)
4265 basic_block son;
4266 for (son = first_dom_son (CDI_DOMINATORS, bb);
4267 son;
4268 son = next_dom_son (CDI_DOMINATORS, son))
4270 /* Make sure block is actually in a TM region, and it
4271 isn't already in old_irr. */
4272 if ((!old_irr || !bitmap_bit_p (old_irr, son->index))
4273 && bitmap_bit_p (all_region_blocks, son->index))
4274 bitmap_set_bit (new_irr, son->index);
4278 while (!bbs.is_empty ());
4280 BITMAP_FREE (all_region_blocks);
4281 bbs.release ();
4284 static void
4285 ipa_tm_decrement_clone_counts (basic_block bb, bool for_clone)
4287 gimple_stmt_iterator gsi;
4289 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
4291 gimple stmt = gsi_stmt (gsi);
4292 if (is_gimple_call (stmt) && !is_tm_pure_call (stmt))
4294 tree fndecl = gimple_call_fndecl (stmt);
4295 if (fndecl)
4297 struct tm_ipa_cg_data *d;
4298 unsigned *pcallers;
4299 struct cgraph_node *tnode;
4301 if (is_tm_ending_fndecl (fndecl))
4302 continue;
4303 if (find_tm_replacement_function (fndecl))
4304 continue;
4306 tnode = cgraph_get_node (fndecl);
4307 d = get_cg_data (&tnode, true);
4309 pcallers = (for_clone ? &d->tm_callers_clone
4310 : &d->tm_callers_normal);
4312 gcc_assert (*pcallers > 0);
4313 *pcallers -= 1;
4319 /* (Re-)Scan the transaction blocks in NODE for calls to irrevocable functions,
4320 as well as other irrevocable actions such as inline assembly. Mark all
4321 such blocks as irrevocable and decrement the number of calls to
4322 transactional clones. Return true if, for the transactional clone, the
4323 entire function is irrevocable. */
4325 static bool
4326 ipa_tm_scan_irr_function (struct cgraph_node *node, bool for_clone)
4328 struct tm_ipa_cg_data *d;
4329 bitmap new_irr, old_irr;
4330 vec<basic_block> queue;
4331 bool ret = false;
4333 /* Builtin operators (operator new, and such). */
4334 if (DECL_STRUCT_FUNCTION (node->symbol.decl) == NULL
4335 || DECL_STRUCT_FUNCTION (node->symbol.decl)->cfg == NULL)
4336 return false;
4338 push_cfun (DECL_STRUCT_FUNCTION (node->symbol.decl));
4339 calculate_dominance_info (CDI_DOMINATORS);
4341 d = get_cg_data (&node, true);
4342 queue.create (10);
4343 new_irr = BITMAP_ALLOC (&tm_obstack);
4345 /* Scan each tm region, propagating irrevocable status through the tree. */
4346 if (for_clone)
4348 old_irr = d->irrevocable_blocks_clone;
4349 queue.quick_push (single_succ (ENTRY_BLOCK_PTR));
4350 if (ipa_tm_scan_irr_blocks (&queue, new_irr, old_irr, NULL))
4352 ipa_tm_propagate_irr (single_succ (ENTRY_BLOCK_PTR), new_irr,
4353 old_irr, NULL);
4354 ret = bitmap_bit_p (new_irr, single_succ (ENTRY_BLOCK_PTR)->index);
4357 else
4359 struct tm_region *region;
4361 old_irr = d->irrevocable_blocks_normal;
4362 for (region = d->all_tm_regions; region; region = region->next)
4364 queue.quick_push (region->entry_block);
4365 if (ipa_tm_scan_irr_blocks (&queue, new_irr, old_irr,
4366 region->exit_blocks))
4367 ipa_tm_propagate_irr (region->entry_block, new_irr, old_irr,
4368 region->exit_blocks);
4372 /* If we found any new irrevocable blocks, reduce the call count for
4373 transactional clones within the irrevocable blocks. Save the new
4374 set of irrevocable blocks for next time. */
4375 if (!bitmap_empty_p (new_irr))
4377 bitmap_iterator bmi;
4378 unsigned i;
4380 EXECUTE_IF_SET_IN_BITMAP (new_irr, 0, i, bmi)
4381 ipa_tm_decrement_clone_counts (BASIC_BLOCK (i), for_clone);
4383 if (old_irr)
4385 bitmap_ior_into (old_irr, new_irr);
4386 BITMAP_FREE (new_irr);
4388 else if (for_clone)
4389 d->irrevocable_blocks_clone = new_irr;
4390 else
4391 d->irrevocable_blocks_normal = new_irr;
4393 if (dump_file && new_irr)
4395 const char *dname;
4396 bitmap_iterator bmi;
4397 unsigned i;
4399 dname = lang_hooks.decl_printable_name (current_function_decl, 2);
4400 EXECUTE_IF_SET_IN_BITMAP (new_irr, 0, i, bmi)
4401 fprintf (dump_file, "%s: bb %d goes irrevocable\n", dname, i);
4404 else
4405 BITMAP_FREE (new_irr);
4407 queue.release ();
4408 pop_cfun ();
4410 return ret;
4413 /* Return true if, for the transactional clone of NODE, any call
4414 may enter irrevocable mode. */
4416 static bool
4417 ipa_tm_mayenterirr_function (struct cgraph_node *node)
4419 struct tm_ipa_cg_data *d;
4420 tree decl;
4421 unsigned flags;
4423 d = get_cg_data (&node, true);
4424 decl = node->symbol.decl;
4425 flags = flags_from_decl_or_type (decl);
4427 /* Handle some TM builtins. Ordinarily these aren't actually generated
4428 at this point, but handling these functions when written in by the
4429 user makes it easier to build unit tests. */
4430 if (flags & ECF_TM_BUILTIN)
4431 return false;
4433 /* Filter out all functions that are marked. */
4434 if (flags & ECF_TM_PURE)
4435 return false;
4436 if (is_tm_safe (decl))
4437 return false;
4438 if (is_tm_irrevocable (decl))
4439 return true;
4440 if (is_tm_callable (decl))
4441 return true;
4442 if (find_tm_replacement_function (decl))
4443 return true;
4445 /* If we aren't seeing the final version of the function we don't
4446 know what it will contain at runtime. */
4447 if (cgraph_function_body_availability (node) < AVAIL_AVAILABLE)
4448 return true;
4450 /* If the function must go irrevocable, then of course true. */
4451 if (d->is_irrevocable)
4452 return true;
4454 /* If there are any blocks marked irrevocable, then the function
4455 as a whole may enter irrevocable. */
4456 if (d->irrevocable_blocks_clone)
4457 return true;
4459 /* We may have previously marked this function as tm_may_enter_irr;
4460 see pass_diagnose_tm_blocks. */
4461 if (node->local.tm_may_enter_irr)
4462 return true;
4464 /* Recurse on the main body for aliases. In general, this will
4465 result in one of the bits above being set so that we will not
4466 have to recurse next time. */
4467 if (node->alias)
4468 return ipa_tm_mayenterirr_function (cgraph_get_node (node->thunk.alias));
4470 /* What remains is unmarked local functions without items that force
4471 the function to go irrevocable. */
4472 return false;
4475 /* Diagnose calls from transaction_safe functions to unmarked
4476 functions that are determined to not be safe. */
4478 static void
4479 ipa_tm_diagnose_tm_safe (struct cgraph_node *node)
4481 struct cgraph_edge *e;
4483 for (e = node->callees; e ; e = e->next_callee)
4484 if (!is_tm_callable (e->callee->symbol.decl)
4485 && e->callee->local.tm_may_enter_irr)
4486 error_at (gimple_location (e->call_stmt),
4487 "unsafe function call %qD within "
4488 "%<transaction_safe%> function", e->callee->symbol.decl);
4491 /* Diagnose call from atomic transactions to unmarked functions
4492 that are determined to not be safe. */
4494 static void
4495 ipa_tm_diagnose_transaction (struct cgraph_node *node,
4496 struct tm_region *all_tm_regions)
4498 struct tm_region *r;
4500 for (r = all_tm_regions; r ; r = r->next)
4501 if (gimple_transaction_subcode (r->transaction_stmt) & GTMA_IS_RELAXED)
4503 /* Atomic transactions can be nested inside relaxed. */
4504 if (r->inner)
4505 ipa_tm_diagnose_transaction (node, r->inner);
4507 else
4509 vec<basic_block> bbs;
4510 gimple_stmt_iterator gsi;
4511 basic_block bb;
4512 size_t i;
4514 bbs = get_tm_region_blocks (r->entry_block, r->exit_blocks,
4515 r->irr_blocks, NULL, false);
4517 for (i = 0; bbs.iterate (i, &bb); ++i)
4518 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
4520 gimple stmt = gsi_stmt (gsi);
4521 tree fndecl;
4523 if (gimple_code (stmt) == GIMPLE_ASM)
4525 error_at (gimple_location (stmt),
4526 "asm not allowed in atomic transaction");
4527 continue;
4530 if (!is_gimple_call (stmt))
4531 continue;
4532 fndecl = gimple_call_fndecl (stmt);
4534 /* Indirect function calls have been diagnosed already. */
4535 if (!fndecl)
4536 continue;
4538 /* Stop at the end of the transaction. */
4539 if (is_tm_ending_fndecl (fndecl))
4541 if (bitmap_bit_p (r->exit_blocks, bb->index))
4542 break;
4543 continue;
4546 /* Marked functions have been diagnosed already. */
4547 if (is_tm_pure_call (stmt))
4548 continue;
4549 if (is_tm_callable (fndecl))
4550 continue;
4552 if (cgraph_local_info (fndecl)->tm_may_enter_irr)
4553 error_at (gimple_location (stmt),
4554 "unsafe function call %qD within "
4555 "atomic transaction", fndecl);
4558 bbs.release ();
4562 /* Return a transactional mangled name for the DECL_ASSEMBLER_NAME in
4563 OLD_DECL. The returned value is a freshly malloced pointer that
4564 should be freed by the caller. */
4566 static tree
4567 tm_mangle (tree old_asm_id)
4569 const char *old_asm_name;
4570 char *tm_name;
4571 void *alloc = NULL;
4572 struct demangle_component *dc;
4573 tree new_asm_id;
4575 /* Determine if the symbol is already a valid C++ mangled name. Do this
4576 even for C, which might be interfacing with C++ code via appropriately
4577 ugly identifiers. */
4578 /* ??? We could probably do just as well checking for "_Z" and be done. */
4579 old_asm_name = IDENTIFIER_POINTER (old_asm_id);
4580 dc = cplus_demangle_v3_components (old_asm_name, DMGL_NO_OPTS, &alloc);
4582 if (dc == NULL)
4584 char length[8];
4586 do_unencoded:
4587 sprintf (length, "%u", IDENTIFIER_LENGTH (old_asm_id));
4588 tm_name = concat ("_ZGTt", length, old_asm_name, NULL);
4590 else
4592 old_asm_name += 2; /* Skip _Z */
4594 switch (dc->type)
4596 case DEMANGLE_COMPONENT_TRANSACTION_CLONE:
4597 case DEMANGLE_COMPONENT_NONTRANSACTION_CLONE:
4598 /* Don't play silly games, you! */
4599 goto do_unencoded;
4601 case DEMANGLE_COMPONENT_HIDDEN_ALIAS:
4602 /* I'd really like to know if we can ever be passed one of
4603 these from the C++ front end. The Logical Thing would
4604 seem that hidden-alias should be outer-most, so that we
4605 get hidden-alias of a transaction-clone and not vice-versa. */
4606 old_asm_name += 2;
4607 break;
4609 default:
4610 break;
4613 tm_name = concat ("_ZGTt", old_asm_name, NULL);
4615 free (alloc);
4617 new_asm_id = get_identifier (tm_name);
4618 free (tm_name);
4620 return new_asm_id;
4623 static inline void
4624 ipa_tm_mark_force_output_node (struct cgraph_node *node)
4626 cgraph_mark_force_output_node (node);
4627 /* ??? function_and_variable_visibility will reset
4628 the needed bit, without actually checking. */
4629 node->analyzed = 1;
4632 /* Callback data for ipa_tm_create_version_alias. */
4633 struct create_version_alias_info
4635 struct cgraph_node *old_node;
4636 tree new_decl;
4639 /* A subroutine of ipa_tm_create_version, called via
4640 cgraph_for_node_and_aliases. Create new tm clones for each of
4641 the existing aliases. */
4642 static bool
4643 ipa_tm_create_version_alias (struct cgraph_node *node, void *data)
4645 struct create_version_alias_info *info
4646 = (struct create_version_alias_info *)data;
4647 tree old_decl, new_decl, tm_name;
4648 struct cgraph_node *new_node;
4650 if (!node->same_body_alias)
4651 return false;
4653 old_decl = node->symbol.decl;
4654 tm_name = tm_mangle (DECL_ASSEMBLER_NAME (old_decl));
4655 new_decl = build_decl (DECL_SOURCE_LOCATION (old_decl),
4656 TREE_CODE (old_decl), tm_name,
4657 TREE_TYPE (old_decl));
4659 SET_DECL_ASSEMBLER_NAME (new_decl, tm_name);
4660 SET_DECL_RTL (new_decl, NULL);
4662 /* Based loosely on C++'s make_alias_for(). */
4663 TREE_PUBLIC (new_decl) = TREE_PUBLIC (old_decl);
4664 DECL_CONTEXT (new_decl) = DECL_CONTEXT (old_decl);
4665 DECL_LANG_SPECIFIC (new_decl) = DECL_LANG_SPECIFIC (old_decl);
4666 TREE_READONLY (new_decl) = TREE_READONLY (old_decl);
4667 DECL_EXTERNAL (new_decl) = 0;
4668 DECL_ARTIFICIAL (new_decl) = 1;
4669 TREE_ADDRESSABLE (new_decl) = 1;
4670 TREE_USED (new_decl) = 1;
4671 TREE_SYMBOL_REFERENCED (tm_name) = 1;
4673 /* Perform the same remapping to the comdat group. */
4674 if (DECL_ONE_ONLY (new_decl))
4675 DECL_COMDAT_GROUP (new_decl) = tm_mangle (DECL_COMDAT_GROUP (old_decl));
4677 new_node = cgraph_same_body_alias (NULL, new_decl, info->new_decl);
4678 new_node->tm_clone = true;
4679 new_node->symbol.externally_visible = info->old_node->symbol.externally_visible;
4680 /* ?? Do not traverse aliases here. */
4681 get_cg_data (&node, false)->clone = new_node;
4683 record_tm_clone_pair (old_decl, new_decl);
4685 if (info->old_node->symbol.force_output
4686 || ipa_ref_list_first_referring (&info->old_node->symbol.ref_list))
4687 ipa_tm_mark_force_output_node (new_node);
4688 return false;
4691 /* Create a copy of the function (possibly declaration only) of OLD_NODE,
4692 appropriate for the transactional clone. */
4694 static void
4695 ipa_tm_create_version (struct cgraph_node *old_node)
4697 tree new_decl, old_decl, tm_name;
4698 struct cgraph_node *new_node;
4700 old_decl = old_node->symbol.decl;
4701 new_decl = copy_node (old_decl);
4703 /* DECL_ASSEMBLER_NAME needs to be set before we call
4704 cgraph_copy_node_for_versioning below, because cgraph_node will
4705 fill the assembler_name_hash. */
4706 tm_name = tm_mangle (DECL_ASSEMBLER_NAME (old_decl));
4707 SET_DECL_ASSEMBLER_NAME (new_decl, tm_name);
4708 SET_DECL_RTL (new_decl, NULL);
4709 TREE_SYMBOL_REFERENCED (tm_name) = 1;
4711 /* Perform the same remapping to the comdat group. */
4712 if (DECL_ONE_ONLY (new_decl))
4713 DECL_COMDAT_GROUP (new_decl) = tm_mangle (DECL_COMDAT_GROUP (old_decl));
4715 new_node = cgraph_copy_node_for_versioning (old_node, new_decl, vNULL, NULL);
4716 new_node->symbol.externally_visible = old_node->symbol.externally_visible;
4717 new_node->lowered = true;
4718 new_node->tm_clone = 1;
4719 get_cg_data (&old_node, true)->clone = new_node;
4721 if (cgraph_function_body_availability (old_node) >= AVAIL_OVERWRITABLE)
4723 /* Remap extern inline to static inline. */
4724 /* ??? Is it worth trying to use make_decl_one_only? */
4725 if (DECL_DECLARED_INLINE_P (new_decl) && DECL_EXTERNAL (new_decl))
4727 DECL_EXTERNAL (new_decl) = 0;
4728 TREE_PUBLIC (new_decl) = 0;
4729 DECL_WEAK (new_decl) = 0;
4732 tree_function_versioning (old_decl, new_decl,
4733 NULL, false, NULL,
4734 false, NULL, NULL);
4737 record_tm_clone_pair (old_decl, new_decl);
4739 cgraph_call_function_insertion_hooks (new_node);
4740 if (old_node->symbol.force_output
4741 || ipa_ref_list_first_referring (&old_node->symbol.ref_list))
4742 ipa_tm_mark_force_output_node (new_node);
4744 /* Do the same thing, but for any aliases of the original node. */
4746 struct create_version_alias_info data;
4747 data.old_node = old_node;
4748 data.new_decl = new_decl;
4749 cgraph_for_node_and_aliases (old_node, ipa_tm_create_version_alias,
4750 &data, true);
4754 /* Construct a call to TM_IRREVOCABLE and insert it at the beginning of BB. */
4756 static void
4757 ipa_tm_insert_irr_call (struct cgraph_node *node, struct tm_region *region,
4758 basic_block bb)
4760 gimple_stmt_iterator gsi;
4761 gimple g;
4763 transaction_subcode_ior (region, GTMA_MAY_ENTER_IRREVOCABLE);
4765 g = gimple_build_call (builtin_decl_explicit (BUILT_IN_TM_IRREVOCABLE),
4766 1, build_int_cst (NULL_TREE, MODE_SERIALIRREVOCABLE));
4768 split_block_after_labels (bb);
4769 gsi = gsi_after_labels (bb);
4770 gsi_insert_before (&gsi, g, GSI_SAME_STMT);
4772 cgraph_create_edge (node,
4773 cgraph_get_create_node
4774 (builtin_decl_explicit (BUILT_IN_TM_IRREVOCABLE)),
4775 g, 0,
4776 compute_call_stmt_bb_frequency (node->symbol.decl,
4777 gimple_bb (g)));
4780 /* Construct a call to TM_GETTMCLONE and insert it before GSI. */
4782 static bool
4783 ipa_tm_insert_gettmclone_call (struct cgraph_node *node,
4784 struct tm_region *region,
4785 gimple_stmt_iterator *gsi, gimple stmt)
4787 tree gettm_fn, ret, old_fn, callfn;
4788 gimple g, g2;
4789 bool safe;
4791 old_fn = gimple_call_fn (stmt);
4793 if (TREE_CODE (old_fn) == ADDR_EXPR)
4795 tree fndecl = TREE_OPERAND (old_fn, 0);
4796 tree clone = get_tm_clone_pair (fndecl);
4798 /* By transforming the call into a TM_GETTMCLONE, we are
4799 technically taking the address of the original function and
4800 its clone. Explain this so inlining will know this function
4801 is needed. */
4802 cgraph_mark_address_taken_node (cgraph_get_node (fndecl));
4803 if (clone)
4804 cgraph_mark_address_taken_node (cgraph_get_node (clone));
4807 safe = is_tm_safe (TREE_TYPE (old_fn));
4808 gettm_fn = builtin_decl_explicit (safe ? BUILT_IN_TM_GETTMCLONE_SAFE
4809 : BUILT_IN_TM_GETTMCLONE_IRR);
4810 ret = create_tmp_var (ptr_type_node, NULL);
4812 if (!safe)
4813 transaction_subcode_ior (region, GTMA_MAY_ENTER_IRREVOCABLE);
4815 /* Discard OBJ_TYPE_REF, since we weren't able to fold it. */
4816 if (TREE_CODE (old_fn) == OBJ_TYPE_REF)
4817 old_fn = OBJ_TYPE_REF_EXPR (old_fn);
4819 g = gimple_build_call (gettm_fn, 1, old_fn);
4820 ret = make_ssa_name (ret, g);
4821 gimple_call_set_lhs (g, ret);
4823 gsi_insert_before (gsi, g, GSI_SAME_STMT);
4825 cgraph_create_edge (node, cgraph_get_create_node (gettm_fn), g, 0,
4826 compute_call_stmt_bb_frequency (node->symbol.decl,
4827 gimple_bb(g)));
4829 /* Cast return value from tm_gettmclone* into appropriate function
4830 pointer. */
4831 callfn = create_tmp_var (TREE_TYPE (old_fn), NULL);
4832 g2 = gimple_build_assign (callfn,
4833 fold_build1 (NOP_EXPR, TREE_TYPE (callfn), ret));
4834 callfn = make_ssa_name (callfn, g2);
4835 gimple_assign_set_lhs (g2, callfn);
4836 gsi_insert_before (gsi, g2, GSI_SAME_STMT);
4838 /* ??? This is a hack to preserve the NOTHROW bit on the call,
4839 which we would have derived from the decl. Failure to save
4840 this bit means we might have to split the basic block. */
4841 if (gimple_call_nothrow_p (stmt))
4842 gimple_call_set_nothrow (stmt, true);
4844 gimple_call_set_fn (stmt, callfn);
4846 /* Discarding OBJ_TYPE_REF above may produce incompatible LHS and RHS
4847 for a call statement. Fix it. */
4849 tree lhs = gimple_call_lhs (stmt);
4850 tree rettype = TREE_TYPE (gimple_call_fntype (stmt));
4851 if (lhs
4852 && !useless_type_conversion_p (TREE_TYPE (lhs), rettype))
4854 tree temp;
4856 temp = create_tmp_reg (rettype, 0);
4857 gimple_call_set_lhs (stmt, temp);
4859 g2 = gimple_build_assign (lhs,
4860 fold_build1 (VIEW_CONVERT_EXPR,
4861 TREE_TYPE (lhs), temp));
4862 gsi_insert_after (gsi, g2, GSI_SAME_STMT);
4866 update_stmt (stmt);
4868 return true;
4871 /* Helper function for ipa_tm_transform_calls*. Given a call
4872 statement in GSI which resides inside transaction REGION, redirect
4873 the call to either its wrapper function, or its clone. */
4875 static void
4876 ipa_tm_transform_calls_redirect (struct cgraph_node *node,
4877 struct tm_region *region,
4878 gimple_stmt_iterator *gsi,
4879 bool *need_ssa_rename_p)
4881 gimple stmt = gsi_stmt (*gsi);
4882 struct cgraph_node *new_node;
4883 struct cgraph_edge *e = cgraph_edge (node, stmt);
4884 tree fndecl = gimple_call_fndecl (stmt);
4886 /* For indirect calls, pass the address through the runtime. */
4887 if (fndecl == NULL)
4889 *need_ssa_rename_p |=
4890 ipa_tm_insert_gettmclone_call (node, region, gsi, stmt);
4891 return;
4894 /* Handle some TM builtins. Ordinarily these aren't actually generated
4895 at this point, but handling these functions when written in by the
4896 user makes it easier to build unit tests. */
4897 if (flags_from_decl_or_type (fndecl) & ECF_TM_BUILTIN)
4898 return;
4900 /* Fixup recursive calls inside clones. */
4901 /* ??? Why did cgraph_copy_node_for_versioning update the call edges
4902 for recursion but not update the call statements themselves? */
4903 if (e->caller == e->callee && decl_is_tm_clone (current_function_decl))
4905 gimple_call_set_fndecl (stmt, current_function_decl);
4906 return;
4909 /* If there is a replacement, use it. */
4910 fndecl = find_tm_replacement_function (fndecl);
4911 if (fndecl)
4913 new_node = cgraph_get_create_node (fndecl);
4915 /* ??? Mark all transaction_wrap functions tm_may_enter_irr.
4917 We can't do this earlier in record_tm_replacement because
4918 cgraph_remove_unreachable_nodes is called before we inject
4919 references to the node. Further, we can't do this in some
4920 nice central place in ipa_tm_execute because we don't have
4921 the exact list of wrapper functions that would be used.
4922 Marking more wrappers than necessary results in the creation
4923 of unnecessary cgraph_nodes, which can cause some of the
4924 other IPA passes to crash.
4926 We do need to mark these nodes so that we get the proper
4927 result in expand_call_tm. */
4928 /* ??? This seems broken. How is it that we're marking the
4929 CALLEE as may_enter_irr? Surely we should be marking the
4930 CALLER. Also note that find_tm_replacement_function also
4931 contains mappings into the TM runtime, e.g. memcpy. These
4932 we know won't go irrevocable. */
4933 new_node->local.tm_may_enter_irr = 1;
4935 else
4937 struct tm_ipa_cg_data *d;
4938 struct cgraph_node *tnode = e->callee;
4940 d = get_cg_data (&tnode, true);
4941 new_node = d->clone;
4943 /* As we've already skipped pure calls and appropriate builtins,
4944 and we've already marked irrevocable blocks, if we can't come
4945 up with a static replacement, then ask the runtime. */
4946 if (new_node == NULL)
4948 *need_ssa_rename_p |=
4949 ipa_tm_insert_gettmclone_call (node, region, gsi, stmt);
4950 return;
4953 fndecl = new_node->symbol.decl;
4956 cgraph_redirect_edge_callee (e, new_node);
4957 gimple_call_set_fndecl (stmt, fndecl);
4960 /* Helper function for ipa_tm_transform_calls. For a given BB,
4961 install calls to tm_irrevocable when IRR_BLOCKS are reached,
4962 redirect other calls to the generated transactional clone. */
4964 static bool
4965 ipa_tm_transform_calls_1 (struct cgraph_node *node, struct tm_region *region,
4966 basic_block bb, bitmap irr_blocks)
4968 gimple_stmt_iterator gsi;
4969 bool need_ssa_rename = false;
4971 if (irr_blocks && bitmap_bit_p (irr_blocks, bb->index))
4973 ipa_tm_insert_irr_call (node, region, bb);
4974 return true;
4977 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
4979 gimple stmt = gsi_stmt (gsi);
4981 if (!is_gimple_call (stmt))
4982 continue;
4983 if (is_tm_pure_call (stmt))
4984 continue;
4986 /* Redirect edges to the appropriate replacement or clone. */
4987 ipa_tm_transform_calls_redirect (node, region, &gsi, &need_ssa_rename);
4990 return need_ssa_rename;
4993 /* Walk the CFG for REGION, beginning at BB. Install calls to
4994 tm_irrevocable when IRR_BLOCKS are reached, redirect other calls to
4995 the generated transactional clone. */
4997 static bool
4998 ipa_tm_transform_calls (struct cgraph_node *node, struct tm_region *region,
4999 basic_block bb, bitmap irr_blocks)
5001 bool need_ssa_rename = false;
5002 edge e;
5003 edge_iterator ei;
5004 vec<basic_block> queue = vNULL;
5005 bitmap visited_blocks = BITMAP_ALLOC (NULL);
5007 queue.safe_push (bb);
5010 bb = queue.pop ();
5012 need_ssa_rename |=
5013 ipa_tm_transform_calls_1 (node, region, bb, irr_blocks);
5015 if (irr_blocks && bitmap_bit_p (irr_blocks, bb->index))
5016 continue;
5018 if (region && bitmap_bit_p (region->exit_blocks, bb->index))
5019 continue;
5021 FOR_EACH_EDGE (e, ei, bb->succs)
5022 if (!bitmap_bit_p (visited_blocks, e->dest->index))
5024 bitmap_set_bit (visited_blocks, e->dest->index);
5025 queue.safe_push (e->dest);
5028 while (!queue.is_empty ());
5030 queue.release ();
5031 BITMAP_FREE (visited_blocks);
5033 return need_ssa_rename;
5036 /* Transform the calls within the TM regions within NODE. */
5038 static void
5039 ipa_tm_transform_transaction (struct cgraph_node *node)
5041 struct tm_ipa_cg_data *d;
5042 struct tm_region *region;
5043 bool need_ssa_rename = false;
5045 d = get_cg_data (&node, true);
5047 push_cfun (DECL_STRUCT_FUNCTION (node->symbol.decl));
5048 calculate_dominance_info (CDI_DOMINATORS);
5050 for (region = d->all_tm_regions; region; region = region->next)
5052 /* If we're sure to go irrevocable, don't transform anything. */
5053 if (d->irrevocable_blocks_normal
5054 && bitmap_bit_p (d->irrevocable_blocks_normal,
5055 region->entry_block->index))
5057 transaction_subcode_ior (region, GTMA_DOES_GO_IRREVOCABLE);
5058 transaction_subcode_ior (region, GTMA_MAY_ENTER_IRREVOCABLE);
5059 continue;
5062 need_ssa_rename |=
5063 ipa_tm_transform_calls (node, region, region->entry_block,
5064 d->irrevocable_blocks_normal);
5067 if (need_ssa_rename)
5068 update_ssa (TODO_update_ssa_only_virtuals);
5070 pop_cfun ();
5073 /* Transform the calls within the transactional clone of NODE. */
5075 static void
5076 ipa_tm_transform_clone (struct cgraph_node *node)
5078 struct tm_ipa_cg_data *d;
5079 bool need_ssa_rename;
5081 d = get_cg_data (&node, true);
5083 /* If this function makes no calls and has no irrevocable blocks,
5084 then there's nothing to do. */
5085 /* ??? Remove non-aborting top-level transactions. */
5086 if (!node->callees && !node->indirect_calls && !d->irrevocable_blocks_clone)
5087 return;
5089 push_cfun (DECL_STRUCT_FUNCTION (d->clone->symbol.decl));
5090 calculate_dominance_info (CDI_DOMINATORS);
5092 need_ssa_rename =
5093 ipa_tm_transform_calls (d->clone, NULL, single_succ (ENTRY_BLOCK_PTR),
5094 d->irrevocable_blocks_clone);
5096 if (need_ssa_rename)
5097 update_ssa (TODO_update_ssa_only_virtuals);
5099 pop_cfun ();
5102 /* Main entry point for the transactional memory IPA pass. */
5104 static unsigned int
5105 ipa_tm_execute (void)
5107 cgraph_node_queue tm_callees = cgraph_node_queue();
5108 /* List of functions that will go irrevocable. */
5109 cgraph_node_queue irr_worklist = cgraph_node_queue();
5111 struct cgraph_node *node;
5112 struct tm_ipa_cg_data *d;
5113 enum availability a;
5114 unsigned int i;
5116 #ifdef ENABLE_CHECKING
5117 verify_cgraph ();
5118 #endif
5120 bitmap_obstack_initialize (&tm_obstack);
5121 initialize_original_copy_tables ();
5123 /* For all local functions marked tm_callable, queue them. */
5124 FOR_EACH_DEFINED_FUNCTION (node)
5125 if (is_tm_callable (node->symbol.decl)
5126 && cgraph_function_body_availability (node) >= AVAIL_OVERWRITABLE)
5128 d = get_cg_data (&node, true);
5129 maybe_push_queue (node, &tm_callees, &d->in_callee_queue);
5132 /* For all local reachable functions... */
5133 FOR_EACH_DEFINED_FUNCTION (node)
5134 if (node->lowered
5135 && cgraph_function_body_availability (node) >= AVAIL_OVERWRITABLE)
5137 /* ... marked tm_pure, record that fact for the runtime by
5138 indicating that the pure function is its own tm_callable.
5139 No need to do this if the function's address can't be taken. */
5140 if (is_tm_pure (node->symbol.decl))
5142 if (!node->local.local)
5143 record_tm_clone_pair (node->symbol.decl, node->symbol.decl);
5144 continue;
5147 push_cfun (DECL_STRUCT_FUNCTION (node->symbol.decl));
5148 calculate_dominance_info (CDI_DOMINATORS);
5150 tm_region_init (NULL);
5151 if (all_tm_regions)
5153 d = get_cg_data (&node, true);
5155 /* Scan for calls that are in each transaction, and
5156 generate the uninstrumented code path. */
5157 ipa_tm_scan_calls_transaction (d, &tm_callees);
5159 /* Put it in the worklist so we can scan the function
5160 later (ipa_tm_scan_irr_function) and mark the
5161 irrevocable blocks. */
5162 maybe_push_queue (node, &irr_worklist, &d->in_worklist);
5163 d->want_irr_scan_normal = true;
5166 pop_cfun ();
5169 /* For every local function on the callee list, scan as if we will be
5170 creating a transactional clone, queueing all new functions we find
5171 along the way. */
5172 for (i = 0; i < tm_callees.length (); ++i)
5174 node = tm_callees[i];
5175 a = cgraph_function_body_availability (node);
5176 d = get_cg_data (&node, true);
5178 /* Put it in the worklist so we can scan the function later
5179 (ipa_tm_scan_irr_function) and mark the irrevocable
5180 blocks. */
5181 maybe_push_queue (node, &irr_worklist, &d->in_worklist);
5183 /* Some callees cannot be arbitrarily cloned. These will always be
5184 irrevocable. Mark these now, so that we need not scan them. */
5185 if (is_tm_irrevocable (node->symbol.decl))
5186 ipa_tm_note_irrevocable (node, &irr_worklist);
5187 else if (a <= AVAIL_NOT_AVAILABLE
5188 && !is_tm_safe_or_pure (node->symbol.decl))
5189 ipa_tm_note_irrevocable (node, &irr_worklist);
5190 else if (a >= AVAIL_OVERWRITABLE)
5192 if (!tree_versionable_function_p (node->symbol.decl))
5193 ipa_tm_note_irrevocable (node, &irr_worklist);
5194 else if (!d->is_irrevocable)
5196 /* If this is an alias, make sure its base is queued as well.
5197 we need not scan the callees now, as the base will do. */
5198 if (node->alias)
5200 node = cgraph_get_node (node->thunk.alias);
5201 d = get_cg_data (&node, true);
5202 maybe_push_queue (node, &tm_callees, &d->in_callee_queue);
5203 continue;
5206 /* Add all nodes called by this function into
5207 tm_callees as well. */
5208 ipa_tm_scan_calls_clone (node, &tm_callees);
5213 /* Iterate scans until no more work to be done. Prefer not to use
5214 vec::pop because the worklist tends to follow a breadth-first
5215 search of the callgraph, which should allow convergance with a
5216 minimum number of scans. But we also don't want the worklist
5217 array to grow without bound, so we shift the array up periodically. */
5218 for (i = 0; i < irr_worklist.length (); ++i)
5220 if (i > 256 && i == irr_worklist.length () / 8)
5222 irr_worklist.block_remove (0, i);
5223 i = 0;
5226 node = irr_worklist[i];
5227 d = get_cg_data (&node, true);
5228 d->in_worklist = false;
5230 if (d->want_irr_scan_normal)
5232 d->want_irr_scan_normal = false;
5233 ipa_tm_scan_irr_function (node, false);
5235 if (d->in_callee_queue && ipa_tm_scan_irr_function (node, true))
5236 ipa_tm_note_irrevocable (node, &irr_worklist);
5239 /* For every function on the callee list, collect the tm_may_enter_irr
5240 bit on the node. */
5241 irr_worklist.truncate (0);
5242 for (i = 0; i < tm_callees.length (); ++i)
5244 node = tm_callees[i];
5245 if (ipa_tm_mayenterirr_function (node))
5247 d = get_cg_data (&node, true);
5248 gcc_assert (d->in_worklist == false);
5249 maybe_push_queue (node, &irr_worklist, &d->in_worklist);
5253 /* Propagate the tm_may_enter_irr bit to callers until stable. */
5254 for (i = 0; i < irr_worklist.length (); ++i)
5256 struct cgraph_node *caller;
5257 struct cgraph_edge *e;
5258 struct ipa_ref *ref;
5259 unsigned j;
5261 if (i > 256 && i == irr_worklist.length () / 8)
5263 irr_worklist.block_remove (0, i);
5264 i = 0;
5267 node = irr_worklist[i];
5268 d = get_cg_data (&node, true);
5269 d->in_worklist = false;
5270 node->local.tm_may_enter_irr = true;
5272 /* Propagate back to normal callers. */
5273 for (e = node->callers; e ; e = e->next_caller)
5275 caller = e->caller;
5276 if (!is_tm_safe_or_pure (caller->symbol.decl)
5277 && !caller->local.tm_may_enter_irr)
5279 d = get_cg_data (&caller, true);
5280 maybe_push_queue (caller, &irr_worklist, &d->in_worklist);
5284 /* Propagate back to referring aliases as well. */
5285 for (j = 0; ipa_ref_list_referring_iterate (&node->symbol.ref_list, j, ref); j++)
5287 caller = cgraph (ref->referring);
5288 if (ref->use == IPA_REF_ALIAS
5289 && !caller->local.tm_may_enter_irr)
5291 /* ?? Do not traverse aliases here. */
5292 d = get_cg_data (&caller, false);
5293 maybe_push_queue (caller, &irr_worklist, &d->in_worklist);
5298 /* Now validate all tm_safe functions, and all atomic regions in
5299 other functions. */
5300 FOR_EACH_DEFINED_FUNCTION (node)
5301 if (node->lowered
5302 && cgraph_function_body_availability (node) >= AVAIL_OVERWRITABLE)
5304 d = get_cg_data (&node, true);
5305 if (is_tm_safe (node->symbol.decl))
5306 ipa_tm_diagnose_tm_safe (node);
5307 else if (d->all_tm_regions)
5308 ipa_tm_diagnose_transaction (node, d->all_tm_regions);
5311 /* Create clones. Do those that are not irrevocable and have a
5312 positive call count. Do those publicly visible functions that
5313 the user directed us to clone. */
5314 for (i = 0; i < tm_callees.length (); ++i)
5316 bool doit = false;
5318 node = tm_callees[i];
5319 if (node->same_body_alias)
5320 continue;
5322 a = cgraph_function_body_availability (node);
5323 d = get_cg_data (&node, true);
5325 if (a <= AVAIL_NOT_AVAILABLE)
5326 doit = is_tm_callable (node->symbol.decl);
5327 else if (a <= AVAIL_AVAILABLE && is_tm_callable (node->symbol.decl))
5328 doit = true;
5329 else if (!d->is_irrevocable
5330 && d->tm_callers_normal + d->tm_callers_clone > 0)
5331 doit = true;
5333 if (doit)
5334 ipa_tm_create_version (node);
5337 /* Redirect calls to the new clones, and insert irrevocable marks. */
5338 for (i = 0; i < tm_callees.length (); ++i)
5340 node = tm_callees[i];
5341 if (node->analyzed)
5343 d = get_cg_data (&node, true);
5344 if (d->clone)
5345 ipa_tm_transform_clone (node);
5348 FOR_EACH_DEFINED_FUNCTION (node)
5349 if (node->lowered
5350 && cgraph_function_body_availability (node) >= AVAIL_OVERWRITABLE)
5352 d = get_cg_data (&node, true);
5353 if (d->all_tm_regions)
5354 ipa_tm_transform_transaction (node);
5357 /* Free and clear all data structures. */
5358 tm_callees.release ();
5359 irr_worklist.release ();
5360 bitmap_obstack_release (&tm_obstack);
5361 free_original_copy_tables ();
5363 FOR_EACH_FUNCTION (node)
5364 node->symbol.aux = NULL;
5366 #ifdef ENABLE_CHECKING
5367 verify_cgraph ();
5368 #endif
5370 return 0;
5373 struct simple_ipa_opt_pass pass_ipa_tm =
5376 SIMPLE_IPA_PASS,
5377 "tmipa", /* name */
5378 OPTGROUP_NONE, /* optinfo_flags */
5379 gate_tm, /* gate */
5380 ipa_tm_execute, /* execute */
5381 NULL, /* sub */
5382 NULL, /* next */
5383 0, /* static_pass_number */
5384 TV_TRANS_MEM, /* tv_id */
5385 PROP_ssa | PROP_cfg, /* properties_required */
5386 0, /* properties_provided */
5387 0, /* properties_destroyed */
5388 0, /* todo_flags_start */
5389 0, /* todo_flags_finish */
5393 #include "gt-trans-mem.h"