gcc/ada/
[official-gcc.git] / gcc / ipa-split.c
blobc1ce1a4e25346dfe0ef47e4a6e7e8e101a8e1b8c
1 /* Function splitting pass
2 Copyright (C) 2010-2015 Free Software Foundation, Inc.
3 Contributed by Jan Hubicka <jh@suse.cz>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 /* The purpose of this pass is to split function bodies to improve
22 inlining. I.e. for function of the form:
24 func (...)
26 if (cheap_test)
27 something_small
28 else
29 something_big
32 Produce:
34 func.part (...)
36 something_big
39 func (...)
41 if (cheap_test)
42 something_small
43 else
44 func.part (...);
47 When func becomes inlinable and when cheap_test is often true, inlining func,
48 but not fund.part leads to performance improvement similar as inlining
49 original func while the code size growth is smaller.
51 The pass is organized in three stages:
52 1) Collect local info about basic block into BB_INFO structure and
53 compute function body estimated size and time.
54 2) Via DFS walk find all possible basic blocks where we can split
55 and chose best one.
56 3) If split point is found, split at the specified BB by creating a clone
57 and updating function to call it.
59 The decisions what functions to split are in execute_split_functions
60 and consider_split.
62 There are several possible future improvements for this pass including:
64 1) Splitting to break up large functions
65 2) Splitting to reduce stack frame usage
66 3) Allow split part of function to use values computed in the header part.
67 The values needs to be passed to split function, perhaps via same
68 interface as for nested functions or as argument.
69 4) Support for simple rematerialization. I.e. when split part use
70 value computed in header from function parameter in very cheap way, we
71 can just recompute it.
72 5) Support splitting of nested functions.
73 6) Support non-SSA arguments.
74 7) There is nothing preventing us from producing multiple parts of single function
75 when needed or splitting also the parts. */
77 #include "config.h"
78 #include "system.h"
79 #include "coretypes.h"
80 #include "alias.h"
81 #include "symtab.h"
82 #include "options.h"
83 #include "tree.h"
84 #include "fold-const.h"
85 #include "predict.h"
86 #include "tm.h"
87 #include "hard-reg-set.h"
88 #include "function.h"
89 #include "dominance.h"
90 #include "cfg.h"
91 #include "cfganal.h"
92 #include "basic-block.h"
93 #include "tree-ssa-alias.h"
94 #include "internal-fn.h"
95 #include "gimple-expr.h"
96 #include "gimple.h"
97 #include "stringpool.h"
98 #include "rtl.h"
99 #include "flags.h"
100 #include "insn-config.h"
101 #include "expmed.h"
102 #include "dojump.h"
103 #include "explow.h"
104 #include "calls.h"
105 #include "emit-rtl.h"
106 #include "varasm.h"
107 #include "stmt.h"
108 #include "expr.h"
109 #include "gimplify.h"
110 #include "gimple-iterator.h"
111 #include "gimplify-me.h"
112 #include "gimple-walk.h"
113 #include "target.h"
114 #include "plugin-api.h"
115 #include "ipa-ref.h"
116 #include "cgraph.h"
117 #include "alloc-pool.h"
118 #include "symbol-summary.h"
119 #include "ipa-prop.h"
120 #include "gimple-ssa.h"
121 #include "tree-cfg.h"
122 #include "tree-phinodes.h"
123 #include "ssa-iterators.h"
124 #include "tree-ssanames.h"
125 #include "tree-into-ssa.h"
126 #include "tree-dfa.h"
127 #include "tree-pass.h"
128 #include "diagnostic.h"
129 #include "tree-dump.h"
130 #include "tree-inline.h"
131 #include "params.h"
132 #include "gimple-pretty-print.h"
133 #include "ipa-inline.h"
134 #include "cfgloop.h"
135 #include "tree-chkp.h"
137 /* Per basic block info. */
139 typedef struct
141 unsigned int size;
142 unsigned int time;
143 } split_bb_info;
145 static vec<split_bb_info> bb_info_vec;
147 /* Description of split point. */
149 struct split_point
151 /* Size of the partitions. */
152 unsigned int header_time, header_size, split_time, split_size;
154 /* SSA names that need to be passed into spit function. */
155 bitmap ssa_names_to_pass;
157 /* Basic block where we split (that will become entry point of new function. */
158 basic_block entry_bb;
160 /* Basic blocks we are splitting away. */
161 bitmap split_bbs;
163 /* True when return value is computed on split part and thus it needs
164 to be returned. */
165 bool split_part_set_retval;
168 /* Best split point found. */
170 struct split_point best_split_point;
172 /* Set of basic blocks that are not allowed to dominate a split point. */
174 static bitmap forbidden_dominators;
176 static tree find_retval (basic_block return_bb);
177 static tree find_retbnd (basic_block return_bb);
179 /* Callback for walk_stmt_load_store_addr_ops. If T is non-SSA automatic
180 variable, check it if it is present in bitmap passed via DATA. */
182 static bool
183 test_nonssa_use (gimple, tree t, tree, void *data)
185 t = get_base_address (t);
187 if (!t || is_gimple_reg (t))
188 return false;
190 if (TREE_CODE (t) == PARM_DECL
191 || (TREE_CODE (t) == VAR_DECL
192 && auto_var_in_fn_p (t, current_function_decl))
193 || TREE_CODE (t) == RESULT_DECL
194 /* Normal labels are part of CFG and will be handled gratefuly.
195 Forced labels however can be used directly by statements and
196 need to stay in one partition along with their uses. */
197 || (TREE_CODE (t) == LABEL_DECL
198 && FORCED_LABEL (t)))
199 return bitmap_bit_p ((bitmap)data, DECL_UID (t));
201 /* For DECL_BY_REFERENCE, the return value is actually a pointer. We want
202 to pretend that the value pointed to is actual result decl. */
203 if ((TREE_CODE (t) == MEM_REF || INDIRECT_REF_P (t))
204 && TREE_CODE (TREE_OPERAND (t, 0)) == SSA_NAME
205 && SSA_NAME_VAR (TREE_OPERAND (t, 0))
206 && TREE_CODE (SSA_NAME_VAR (TREE_OPERAND (t, 0))) == RESULT_DECL
207 && DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
208 return
209 bitmap_bit_p ((bitmap)data,
210 DECL_UID (DECL_RESULT (current_function_decl)));
212 return false;
215 /* Dump split point CURRENT. */
217 static void
218 dump_split_point (FILE * file, struct split_point *current)
220 fprintf (file,
221 "Split point at BB %i\n"
222 " header time: %i header size: %i\n"
223 " split time: %i split size: %i\n bbs: ",
224 current->entry_bb->index, current->header_time,
225 current->header_size, current->split_time, current->split_size);
226 dump_bitmap (file, current->split_bbs);
227 fprintf (file, " SSA names to pass: ");
228 dump_bitmap (file, current->ssa_names_to_pass);
231 /* Look for all BBs in header that might lead to the split part and verify
232 that they are not defining any non-SSA var used by the split part.
233 Parameters are the same as for consider_split. */
235 static bool
236 verify_non_ssa_vars (struct split_point *current, bitmap non_ssa_vars,
237 basic_block return_bb)
239 bitmap seen = BITMAP_ALLOC (NULL);
240 vec<basic_block> worklist = vNULL;
241 edge e;
242 edge_iterator ei;
243 bool ok = true;
244 basic_block bb;
246 FOR_EACH_EDGE (e, ei, current->entry_bb->preds)
247 if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
248 && !bitmap_bit_p (current->split_bbs, e->src->index))
250 worklist.safe_push (e->src);
251 bitmap_set_bit (seen, e->src->index);
254 while (!worklist.is_empty ())
256 bb = worklist.pop ();
257 FOR_EACH_EDGE (e, ei, bb->preds)
258 if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
259 && bitmap_set_bit (seen, e->src->index))
261 gcc_checking_assert (!bitmap_bit_p (current->split_bbs,
262 e->src->index));
263 worklist.safe_push (e->src);
265 for (gimple_stmt_iterator bsi = gsi_start_bb (bb); !gsi_end_p (bsi);
266 gsi_next (&bsi))
268 gimple stmt = gsi_stmt (bsi);
269 if (is_gimple_debug (stmt))
270 continue;
271 if (walk_stmt_load_store_addr_ops
272 (stmt, non_ssa_vars, test_nonssa_use, test_nonssa_use,
273 test_nonssa_use))
275 ok = false;
276 goto done;
278 if (glabel *label_stmt = dyn_cast <glabel *> (stmt))
279 if (test_nonssa_use (stmt, gimple_label_label (label_stmt),
280 NULL_TREE, non_ssa_vars))
282 ok = false;
283 goto done;
286 for (gphi_iterator bsi = gsi_start_phis (bb); !gsi_end_p (bsi);
287 gsi_next (&bsi))
289 if (walk_stmt_load_store_addr_ops
290 (gsi_stmt (bsi), non_ssa_vars, test_nonssa_use, test_nonssa_use,
291 test_nonssa_use))
293 ok = false;
294 goto done;
297 FOR_EACH_EDGE (e, ei, bb->succs)
299 if (e->dest != return_bb)
300 continue;
301 for (gphi_iterator bsi = gsi_start_phis (return_bb);
302 !gsi_end_p (bsi);
303 gsi_next (&bsi))
305 gphi *stmt = bsi.phi ();
306 tree op = gimple_phi_arg_def (stmt, e->dest_idx);
308 if (virtual_operand_p (gimple_phi_result (stmt)))
309 continue;
310 if (TREE_CODE (op) != SSA_NAME
311 && test_nonssa_use (stmt, op, op, non_ssa_vars))
313 ok = false;
314 goto done;
320 /* Verify that the rest of function does not define any label
321 used by the split part. */
322 FOR_EACH_BB_FN (bb, cfun)
323 if (!bitmap_bit_p (current->split_bbs, bb->index)
324 && !bitmap_bit_p (seen, bb->index))
326 gimple_stmt_iterator bsi;
327 for (bsi = gsi_start_bb (bb); !gsi_end_p (bsi); gsi_next (&bsi))
328 if (glabel *label_stmt = dyn_cast <glabel *> (gsi_stmt (bsi)))
330 if (test_nonssa_use (label_stmt,
331 gimple_label_label (label_stmt),
332 NULL_TREE, non_ssa_vars))
334 ok = false;
335 goto done;
338 else
339 break;
342 done:
343 BITMAP_FREE (seen);
344 worklist.release ();
345 return ok;
348 /* If STMT is a call, check the callee against a list of forbidden
349 predicate functions. If a match is found, look for uses of the
350 call result in condition statements that compare against zero.
351 For each such use, find the block targeted by the condition
352 statement for the nonzero result, and set the bit for this block
353 in the forbidden dominators bitmap. The purpose of this is to avoid
354 selecting a split point where we are likely to lose the chance
355 to optimize away an unused function call. */
357 static void
358 check_forbidden_calls (gimple stmt)
360 imm_use_iterator use_iter;
361 use_operand_p use_p;
362 tree lhs;
364 /* At the moment, __builtin_constant_p is the only forbidden
365 predicate function call (see PR49642). */
366 if (!gimple_call_builtin_p (stmt, BUILT_IN_CONSTANT_P))
367 return;
369 lhs = gimple_call_lhs (stmt);
371 if (!lhs || TREE_CODE (lhs) != SSA_NAME)
372 return;
374 FOR_EACH_IMM_USE_FAST (use_p, use_iter, lhs)
376 tree op1;
377 basic_block use_bb, forbidden_bb;
378 enum tree_code code;
379 edge true_edge, false_edge;
380 gcond *use_stmt;
382 use_stmt = dyn_cast <gcond *> (USE_STMT (use_p));
383 if (!use_stmt)
384 continue;
386 /* Assuming canonical form for GIMPLE_COND here, with constant
387 in second position. */
388 op1 = gimple_cond_rhs (use_stmt);
389 code = gimple_cond_code (use_stmt);
390 use_bb = gimple_bb (use_stmt);
392 extract_true_false_edges_from_block (use_bb, &true_edge, &false_edge);
394 /* We're only interested in comparisons that distinguish
395 unambiguously from zero. */
396 if (!integer_zerop (op1) || code == LE_EXPR || code == GE_EXPR)
397 continue;
399 if (code == EQ_EXPR)
400 forbidden_bb = false_edge->dest;
401 else
402 forbidden_bb = true_edge->dest;
404 bitmap_set_bit (forbidden_dominators, forbidden_bb->index);
408 /* If BB is dominated by any block in the forbidden dominators set,
409 return TRUE; else FALSE. */
411 static bool
412 dominated_by_forbidden (basic_block bb)
414 unsigned dom_bb;
415 bitmap_iterator bi;
417 EXECUTE_IF_SET_IN_BITMAP (forbidden_dominators, 1, dom_bb, bi)
419 if (dominated_by_p (CDI_DOMINATORS, bb,
420 BASIC_BLOCK_FOR_FN (cfun, dom_bb)))
421 return true;
424 return false;
427 /* For give split point CURRENT and return block RETURN_BB return 1
428 if ssa name VAL is set by split part and 0 otherwise. */
429 static bool
430 split_part_set_ssa_name_p (tree val, struct split_point *current,
431 basic_block return_bb)
433 if (TREE_CODE (val) != SSA_NAME)
434 return false;
436 return (!SSA_NAME_IS_DEFAULT_DEF (val)
437 && (bitmap_bit_p (current->split_bbs,
438 gimple_bb (SSA_NAME_DEF_STMT (val))->index)
439 || gimple_bb (SSA_NAME_DEF_STMT (val)) == return_bb));
442 /* We found an split_point CURRENT. NON_SSA_VARS is bitmap of all non ssa
443 variables used and RETURN_BB is return basic block.
444 See if we can split function here. */
446 static void
447 consider_split (struct split_point *current, bitmap non_ssa_vars,
448 basic_block return_bb)
450 tree parm;
451 unsigned int num_args = 0;
452 unsigned int call_overhead;
453 edge e;
454 edge_iterator ei;
455 gphi_iterator bsi;
456 unsigned int i;
457 int incoming_freq = 0;
458 tree retval;
459 tree retbnd;
460 bool back_edge = false;
462 if (dump_file && (dump_flags & TDF_DETAILS))
463 dump_split_point (dump_file, current);
465 FOR_EACH_EDGE (e, ei, current->entry_bb->preds)
467 if (e->flags & EDGE_DFS_BACK)
468 back_edge = true;
469 if (!bitmap_bit_p (current->split_bbs, e->src->index))
470 incoming_freq += EDGE_FREQUENCY (e);
473 /* Do not split when we would end up calling function anyway. */
474 if (incoming_freq
475 >= (ENTRY_BLOCK_PTR_FOR_FN (cfun)->frequency
476 * PARAM_VALUE (PARAM_PARTIAL_INLINING_ENTRY_PROBABILITY) / 100))
478 /* When profile is guessed, we can not expect it to give us
479 realistic estimate on likelyness of function taking the
480 complex path. As a special case, when tail of the function is
481 a loop, enable splitting since inlining code skipping the loop
482 is likely noticeable win. */
483 if (back_edge
484 && profile_status_for_fn (cfun) != PROFILE_READ
485 && incoming_freq < ENTRY_BLOCK_PTR_FOR_FN (cfun)->frequency)
487 if (dump_file && (dump_flags & TDF_DETAILS))
488 fprintf (dump_file,
489 " Split before loop, accepting despite low frequencies %i %i.\n",
490 incoming_freq,
491 ENTRY_BLOCK_PTR_FOR_FN (cfun)->frequency);
493 else
495 if (dump_file && (dump_flags & TDF_DETAILS))
496 fprintf (dump_file,
497 " Refused: incoming frequency is too large.\n");
498 return;
502 if (!current->header_size)
504 if (dump_file && (dump_flags & TDF_DETAILS))
505 fprintf (dump_file, " Refused: header empty\n");
506 return;
509 /* Verify that PHI args on entry are either virtual or all their operands
510 incoming from header are the same. */
511 for (bsi = gsi_start_phis (current->entry_bb); !gsi_end_p (bsi); gsi_next (&bsi))
513 gphi *stmt = bsi.phi ();
514 tree val = NULL;
516 if (virtual_operand_p (gimple_phi_result (stmt)))
517 continue;
518 for (i = 0; i < gimple_phi_num_args (stmt); i++)
520 edge e = gimple_phi_arg_edge (stmt, i);
521 if (!bitmap_bit_p (current->split_bbs, e->src->index))
523 tree edge_val = gimple_phi_arg_def (stmt, i);
524 if (val && edge_val != val)
526 if (dump_file && (dump_flags & TDF_DETAILS))
527 fprintf (dump_file,
528 " Refused: entry BB has PHI with multiple variants\n");
529 return;
531 val = edge_val;
537 /* See what argument we will pass to the split function and compute
538 call overhead. */
539 call_overhead = eni_size_weights.call_cost;
540 for (parm = DECL_ARGUMENTS (current_function_decl); parm;
541 parm = DECL_CHAIN (parm))
543 if (!is_gimple_reg (parm))
545 if (bitmap_bit_p (non_ssa_vars, DECL_UID (parm)))
547 if (dump_file && (dump_flags & TDF_DETAILS))
548 fprintf (dump_file,
549 " Refused: need to pass non-ssa param values\n");
550 return;
553 else
555 tree ddef = ssa_default_def (cfun, parm);
556 if (ddef
557 && bitmap_bit_p (current->ssa_names_to_pass,
558 SSA_NAME_VERSION (ddef)))
560 if (!VOID_TYPE_P (TREE_TYPE (parm)))
561 call_overhead += estimate_move_cost (TREE_TYPE (parm), false);
562 num_args++;
566 if (!VOID_TYPE_P (TREE_TYPE (current_function_decl)))
567 call_overhead += estimate_move_cost (TREE_TYPE (current_function_decl),
568 false);
570 if (current->split_size <= call_overhead)
572 if (dump_file && (dump_flags & TDF_DETAILS))
573 fprintf (dump_file,
574 " Refused: split size is smaller than call overhead\n");
575 return;
577 if (current->header_size + call_overhead
578 >= (unsigned int)(DECL_DECLARED_INLINE_P (current_function_decl)
579 ? MAX_INLINE_INSNS_SINGLE
580 : MAX_INLINE_INSNS_AUTO))
582 if (dump_file && (dump_flags & TDF_DETAILS))
583 fprintf (dump_file,
584 " Refused: header size is too large for inline candidate\n");
585 return;
588 /* Splitting functions brings the target out of comdat group; this will
589 lead to code duplication if the function is reused by other unit.
590 Limit this duplication. This is consistent with limit in tree-sra.c
591 FIXME: with LTO we ought to be able to do better! */
592 if (DECL_ONE_ONLY (current_function_decl)
593 && current->split_size >= (unsigned int) MAX_INLINE_INSNS_AUTO)
595 if (dump_file && (dump_flags & TDF_DETAILS))
596 fprintf (dump_file,
597 " Refused: function is COMDAT and tail is too large\n");
598 return;
600 /* For comdat functions also reject very small tails; those will likely get
601 inlined back and we do not want to risk the duplication overhead.
602 FIXME: with LTO we ought to be able to do better! */
603 if (DECL_ONE_ONLY (current_function_decl)
604 && current->split_size
605 <= (unsigned int) PARAM_VALUE (PARAM_EARLY_INLINING_INSNS) / 2)
607 if (dump_file && (dump_flags & TDF_DETAILS))
608 fprintf (dump_file,
609 " Refused: function is COMDAT and tail is too small\n");
610 return;
613 /* FIXME: we currently can pass only SSA function parameters to the split
614 arguments. Once parm_adjustment infrastructure is supported by cloning,
615 we can pass more than that. */
616 if (num_args != bitmap_count_bits (current->ssa_names_to_pass))
619 if (dump_file && (dump_flags & TDF_DETAILS))
620 fprintf (dump_file,
621 " Refused: need to pass non-param values\n");
622 return;
625 /* When there are non-ssa vars used in the split region, see if they
626 are used in the header region. If so, reject the split.
627 FIXME: we can use nested function support to access both. */
628 if (!bitmap_empty_p (non_ssa_vars)
629 && !verify_non_ssa_vars (current, non_ssa_vars, return_bb))
631 if (dump_file && (dump_flags & TDF_DETAILS))
632 fprintf (dump_file,
633 " Refused: split part has non-ssa uses\n");
634 return;
637 /* If the split point is dominated by a forbidden block, reject
638 the split. */
639 if (!bitmap_empty_p (forbidden_dominators)
640 && dominated_by_forbidden (current->entry_bb))
642 if (dump_file && (dump_flags & TDF_DETAILS))
643 fprintf (dump_file,
644 " Refused: split point dominated by forbidden block\n");
645 return;
648 /* See if retval used by return bb is computed by header or split part.
649 When it is computed by split part, we need to produce return statement
650 in the split part and add code to header to pass it around.
652 This is bit tricky to test:
653 1) When there is no return_bb or no return value, we always pass
654 value around.
655 2) Invariants are always computed by caller.
656 3) For SSA we need to look if defining statement is in header or split part
657 4) For non-SSA we need to look where the var is computed. */
658 retval = find_retval (return_bb);
659 if (!retval)
660 current->split_part_set_retval = true;
661 else if (is_gimple_min_invariant (retval))
662 current->split_part_set_retval = false;
663 /* Special case is value returned by reference we record as if it was non-ssa
664 set to result_decl. */
665 else if (TREE_CODE (retval) == SSA_NAME
666 && SSA_NAME_VAR (retval)
667 && TREE_CODE (SSA_NAME_VAR (retval)) == RESULT_DECL
668 && DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
669 current->split_part_set_retval
670 = bitmap_bit_p (non_ssa_vars, DECL_UID (SSA_NAME_VAR (retval)));
671 else if (TREE_CODE (retval) == SSA_NAME)
672 current->split_part_set_retval
673 = split_part_set_ssa_name_p (retval, current, return_bb);
674 else if (TREE_CODE (retval) == PARM_DECL)
675 current->split_part_set_retval = false;
676 else if (TREE_CODE (retval) == VAR_DECL
677 || TREE_CODE (retval) == RESULT_DECL)
678 current->split_part_set_retval
679 = bitmap_bit_p (non_ssa_vars, DECL_UID (retval));
680 else
681 current->split_part_set_retval = true;
683 /* See if retbnd used by return bb is computed by header or split part. */
684 retbnd = find_retbnd (return_bb);
685 if (retbnd)
687 bool split_part_set_retbnd
688 = split_part_set_ssa_name_p (retbnd, current, return_bb);
690 /* If we have both return value and bounds then keep their definitions
691 in a single function. We use SSA names to link returned bounds and
692 value and therefore do not handle cases when result is passed by
693 reference (which should not be our case anyway since bounds are
694 returned for pointers only). */
695 if ((DECL_BY_REFERENCE (DECL_RESULT (current_function_decl))
696 && current->split_part_set_retval)
697 || split_part_set_retbnd != current->split_part_set_retval)
699 if (dump_file && (dump_flags & TDF_DETAILS))
700 fprintf (dump_file,
701 " Refused: split point splits return value and bounds\n");
702 return;
706 /* split_function fixes up at most one PHI non-virtual PHI node in return_bb,
707 for the return value. If there are other PHIs, give up. */
708 if (return_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
710 gphi_iterator psi;
712 for (psi = gsi_start_phis (return_bb); !gsi_end_p (psi); gsi_next (&psi))
713 if (!virtual_operand_p (gimple_phi_result (psi.phi ()))
714 && !(retval
715 && current->split_part_set_retval
716 && TREE_CODE (retval) == SSA_NAME
717 && !DECL_BY_REFERENCE (DECL_RESULT (current_function_decl))
718 && SSA_NAME_DEF_STMT (retval) == psi.phi ()))
720 if (dump_file && (dump_flags & TDF_DETAILS))
721 fprintf (dump_file,
722 " Refused: return bb has extra PHIs\n");
723 return;
727 if (dump_file && (dump_flags & TDF_DETAILS))
728 fprintf (dump_file, " Accepted!\n");
730 /* At the moment chose split point with lowest frequency and that leaves
731 out smallest size of header.
732 In future we might re-consider this heuristics. */
733 if (!best_split_point.split_bbs
734 || best_split_point.entry_bb->frequency > current->entry_bb->frequency
735 || (best_split_point.entry_bb->frequency == current->entry_bb->frequency
736 && best_split_point.split_size < current->split_size))
739 if (dump_file && (dump_flags & TDF_DETAILS))
740 fprintf (dump_file, " New best split point!\n");
741 if (best_split_point.ssa_names_to_pass)
743 BITMAP_FREE (best_split_point.ssa_names_to_pass);
744 BITMAP_FREE (best_split_point.split_bbs);
746 best_split_point = *current;
747 best_split_point.ssa_names_to_pass = BITMAP_ALLOC (NULL);
748 bitmap_copy (best_split_point.ssa_names_to_pass,
749 current->ssa_names_to_pass);
750 best_split_point.split_bbs = BITMAP_ALLOC (NULL);
751 bitmap_copy (best_split_point.split_bbs, current->split_bbs);
755 /* Return basic block containing RETURN statement. We allow basic blocks
756 of the form:
757 <retval> = tmp_var;
758 return <retval>
759 but return_bb can not be more complex than this (except for
760 -fsanitize=thread we allow TSAN_FUNC_EXIT () internal call in there).
761 If nothing is found, return the exit block.
763 When there are multiple RETURN statement, chose one with return value,
764 since that one is more likely shared by multiple code paths.
766 Return BB is special, because for function splitting it is the only
767 basic block that is duplicated in between header and split part of the
768 function.
770 TODO: We might support multiple return blocks. */
772 static basic_block
773 find_return_bb (void)
775 edge e;
776 basic_block return_bb = EXIT_BLOCK_PTR_FOR_FN (cfun);
777 gimple_stmt_iterator bsi;
778 bool found_return = false;
779 tree retval = NULL_TREE;
781 if (!single_pred_p (EXIT_BLOCK_PTR_FOR_FN (cfun)))
782 return return_bb;
784 e = single_pred_edge (EXIT_BLOCK_PTR_FOR_FN (cfun));
785 for (bsi = gsi_last_bb (e->src); !gsi_end_p (bsi); gsi_prev (&bsi))
787 gimple stmt = gsi_stmt (bsi);
788 if (gimple_code (stmt) == GIMPLE_LABEL
789 || is_gimple_debug (stmt)
790 || gimple_clobber_p (stmt))
792 else if (gimple_code (stmt) == GIMPLE_ASSIGN
793 && found_return
794 && gimple_assign_single_p (stmt)
795 && (auto_var_in_fn_p (gimple_assign_rhs1 (stmt),
796 current_function_decl)
797 || is_gimple_min_invariant (gimple_assign_rhs1 (stmt)))
798 && retval == gimple_assign_lhs (stmt))
800 else if (greturn *return_stmt = dyn_cast <greturn *> (stmt))
802 found_return = true;
803 retval = gimple_return_retval (return_stmt);
805 /* For -fsanitize=thread, allow also TSAN_FUNC_EXIT () in the return
806 bb. */
807 else if ((flag_sanitize & SANITIZE_THREAD)
808 && is_gimple_call (stmt)
809 && gimple_call_internal_p (stmt)
810 && gimple_call_internal_fn (stmt) == IFN_TSAN_FUNC_EXIT)
812 else
813 break;
815 if (gsi_end_p (bsi) && found_return)
816 return_bb = e->src;
818 return return_bb;
821 /* Given return basic block RETURN_BB, see where return value is really
822 stored. */
823 static tree
824 find_retval (basic_block return_bb)
826 gimple_stmt_iterator bsi;
827 for (bsi = gsi_start_bb (return_bb); !gsi_end_p (bsi); gsi_next (&bsi))
828 if (greturn *return_stmt = dyn_cast <greturn *> (gsi_stmt (bsi)))
829 return gimple_return_retval (return_stmt);
830 else if (gimple_code (gsi_stmt (bsi)) == GIMPLE_ASSIGN
831 && !gimple_clobber_p (gsi_stmt (bsi)))
832 return gimple_assign_rhs1 (gsi_stmt (bsi));
833 return NULL;
836 /* Given return basic block RETURN_BB, see where return bounds are really
837 stored. */
838 static tree
839 find_retbnd (basic_block return_bb)
841 gimple_stmt_iterator bsi;
842 for (bsi = gsi_last_bb (return_bb); !gsi_end_p (bsi); gsi_prev (&bsi))
843 if (gimple_code (gsi_stmt (bsi)) == GIMPLE_RETURN)
844 return gimple_return_retbnd (gsi_stmt (bsi));
845 return NULL;
848 /* Callback for walk_stmt_load_store_addr_ops. If T is non-SSA automatic
849 variable, mark it as used in bitmap passed via DATA.
850 Return true when access to T prevents splitting the function. */
852 static bool
853 mark_nonssa_use (gimple, tree t, tree, void *data)
855 t = get_base_address (t);
857 if (!t || is_gimple_reg (t))
858 return false;
860 /* At present we can't pass non-SSA arguments to split function.
861 FIXME: this can be relaxed by passing references to arguments. */
862 if (TREE_CODE (t) == PARM_DECL)
864 if (dump_file && (dump_flags & TDF_DETAILS))
865 fprintf (dump_file,
866 "Cannot split: use of non-ssa function parameter.\n");
867 return true;
870 if ((TREE_CODE (t) == VAR_DECL
871 && auto_var_in_fn_p (t, current_function_decl))
872 || TREE_CODE (t) == RESULT_DECL
873 || (TREE_CODE (t) == LABEL_DECL
874 && FORCED_LABEL (t)))
875 bitmap_set_bit ((bitmap)data, DECL_UID (t));
877 /* For DECL_BY_REFERENCE, the return value is actually a pointer. We want
878 to pretend that the value pointed to is actual result decl. */
879 if ((TREE_CODE (t) == MEM_REF || INDIRECT_REF_P (t))
880 && TREE_CODE (TREE_OPERAND (t, 0)) == SSA_NAME
881 && SSA_NAME_VAR (TREE_OPERAND (t, 0))
882 && TREE_CODE (SSA_NAME_VAR (TREE_OPERAND (t, 0))) == RESULT_DECL
883 && DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
884 return
885 bitmap_bit_p ((bitmap)data,
886 DECL_UID (DECL_RESULT (current_function_decl)));
888 return false;
891 /* Compute local properties of basic block BB we collect when looking for
892 split points. We look for ssa defs and store them in SET_SSA_NAMES,
893 for ssa uses and store them in USED_SSA_NAMES and for any non-SSA automatic
894 vars stored in NON_SSA_VARS.
896 When BB has edge to RETURN_BB, collect uses in RETURN_BB too.
898 Return false when BB contains something that prevents it from being put into
899 split function. */
901 static bool
902 visit_bb (basic_block bb, basic_block return_bb,
903 bitmap set_ssa_names, bitmap used_ssa_names,
904 bitmap non_ssa_vars)
906 edge e;
907 edge_iterator ei;
908 bool can_split = true;
910 for (gimple_stmt_iterator bsi = gsi_start_bb (bb); !gsi_end_p (bsi);
911 gsi_next (&bsi))
913 gimple stmt = gsi_stmt (bsi);
914 tree op;
915 ssa_op_iter iter;
916 tree decl;
918 if (is_gimple_debug (stmt))
919 continue;
921 if (gimple_clobber_p (stmt))
922 continue;
924 /* FIXME: We can split regions containing EH. We can not however
925 split RESX, EH_DISPATCH and EH_POINTER referring to same region
926 into different partitions. This would require tracking of
927 EH regions and checking in consider_split_point if they
928 are not used elsewhere. */
929 if (gimple_code (stmt) == GIMPLE_RESX)
931 if (dump_file && (dump_flags & TDF_DETAILS))
932 fprintf (dump_file, "Cannot split: resx.\n");
933 can_split = false;
935 if (gimple_code (stmt) == GIMPLE_EH_DISPATCH)
937 if (dump_file && (dump_flags & TDF_DETAILS))
938 fprintf (dump_file, "Cannot split: eh dispatch.\n");
939 can_split = false;
942 /* Check builtins that prevent splitting. */
943 if (gimple_code (stmt) == GIMPLE_CALL
944 && (decl = gimple_call_fndecl (stmt)) != NULL_TREE
945 && DECL_BUILT_IN (decl)
946 && DECL_BUILT_IN_CLASS (decl) == BUILT_IN_NORMAL)
947 switch (DECL_FUNCTION_CODE (decl))
949 /* FIXME: once we will allow passing non-parm values to split part,
950 we need to be sure to handle correct builtin_stack_save and
951 builtin_stack_restore. At the moment we are safe; there is no
952 way to store builtin_stack_save result in non-SSA variable
953 since all calls to those are compiler generated. */
954 case BUILT_IN_APPLY:
955 case BUILT_IN_APPLY_ARGS:
956 case BUILT_IN_VA_START:
957 if (dump_file && (dump_flags & TDF_DETAILS))
958 fprintf (dump_file,
959 "Cannot split: builtin_apply and va_start.\n");
960 can_split = false;
961 break;
962 case BUILT_IN_EH_POINTER:
963 if (dump_file && (dump_flags & TDF_DETAILS))
964 fprintf (dump_file, "Cannot split: builtin_eh_pointer.\n");
965 can_split = false;
966 break;
967 default:
968 break;
971 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_DEF)
972 bitmap_set_bit (set_ssa_names, SSA_NAME_VERSION (op));
973 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_USE)
974 bitmap_set_bit (used_ssa_names, SSA_NAME_VERSION (op));
975 can_split &= !walk_stmt_load_store_addr_ops (stmt, non_ssa_vars,
976 mark_nonssa_use,
977 mark_nonssa_use,
978 mark_nonssa_use);
980 for (gphi_iterator bsi = gsi_start_phis (bb); !gsi_end_p (bsi);
981 gsi_next (&bsi))
983 gphi *stmt = bsi.phi ();
984 unsigned int i;
986 if (virtual_operand_p (gimple_phi_result (stmt)))
987 continue;
988 bitmap_set_bit (set_ssa_names,
989 SSA_NAME_VERSION (gimple_phi_result (stmt)));
990 for (i = 0; i < gimple_phi_num_args (stmt); i++)
992 tree op = gimple_phi_arg_def (stmt, i);
993 if (TREE_CODE (op) == SSA_NAME)
994 bitmap_set_bit (used_ssa_names, SSA_NAME_VERSION (op));
996 can_split &= !walk_stmt_load_store_addr_ops (stmt, non_ssa_vars,
997 mark_nonssa_use,
998 mark_nonssa_use,
999 mark_nonssa_use);
1001 /* Record also uses coming from PHI operand in return BB. */
1002 FOR_EACH_EDGE (e, ei, bb->succs)
1003 if (e->dest == return_bb)
1005 for (gphi_iterator bsi = gsi_start_phis (return_bb);
1006 !gsi_end_p (bsi);
1007 gsi_next (&bsi))
1009 gphi *stmt = bsi.phi ();
1010 tree op = gimple_phi_arg_def (stmt, e->dest_idx);
1012 if (virtual_operand_p (gimple_phi_result (stmt)))
1013 continue;
1014 if (TREE_CODE (op) == SSA_NAME)
1015 bitmap_set_bit (used_ssa_names, SSA_NAME_VERSION (op));
1016 else
1017 can_split &= !mark_nonssa_use (stmt, op, op, non_ssa_vars);
1020 return can_split;
1023 /* Stack entry for recursive DFS walk in find_split_point. */
1025 typedef struct
1027 /* Basic block we are examining. */
1028 basic_block bb;
1030 /* SSA names set and used by the BB and all BBs reachable
1031 from it via DFS walk. */
1032 bitmap set_ssa_names, used_ssa_names;
1033 bitmap non_ssa_vars;
1035 /* All BBS visited from this BB via DFS walk. */
1036 bitmap bbs_visited;
1038 /* Last examined edge in DFS walk. Since we walk unoriented graph,
1039 the value is up to sum of incoming and outgoing edges of BB. */
1040 unsigned int edge_num;
1042 /* Stack entry index of earliest BB reachable from current BB
1043 or any BB visited later in DFS walk. */
1044 int earliest;
1046 /* Overall time and size of all BBs reached from this BB in DFS walk. */
1047 int overall_time, overall_size;
1049 /* When false we can not split on this BB. */
1050 bool can_split;
1051 } stack_entry;
1054 /* Find all articulations and call consider_split on them.
1055 OVERALL_TIME and OVERALL_SIZE is time and size of the function.
1057 We perform basic algorithm for finding an articulation in a graph
1058 created from CFG by considering it to be an unoriented graph.
1060 The articulation is discovered via DFS walk. We collect earliest
1061 basic block on stack that is reachable via backward edge. Articulation
1062 is any basic block such that there is no backward edge bypassing it.
1063 To reduce stack usage we maintain heap allocated stack in STACK vector.
1064 AUX pointer of BB is set to index it appears in the stack or -1 once
1065 it is visited and popped off the stack.
1067 The algorithm finds articulation after visiting the whole component
1068 reachable by it. This makes it convenient to collect information about
1069 the component used by consider_split. */
1071 static void
1072 find_split_points (basic_block return_bb, int overall_time, int overall_size)
1074 stack_entry first;
1075 vec<stack_entry> stack = vNULL;
1076 basic_block bb;
1077 struct split_point current;
1079 current.header_time = overall_time;
1080 current.header_size = overall_size;
1081 current.split_time = 0;
1082 current.split_size = 0;
1083 current.ssa_names_to_pass = BITMAP_ALLOC (NULL);
1085 first.bb = ENTRY_BLOCK_PTR_FOR_FN (cfun);
1086 first.edge_num = 0;
1087 first.overall_time = 0;
1088 first.overall_size = 0;
1089 first.earliest = INT_MAX;
1090 first.set_ssa_names = 0;
1091 first.used_ssa_names = 0;
1092 first.non_ssa_vars = 0;
1093 first.bbs_visited = 0;
1094 first.can_split = false;
1095 stack.safe_push (first);
1096 ENTRY_BLOCK_PTR_FOR_FN (cfun)->aux = (void *)(intptr_t)-1;
1098 while (!stack.is_empty ())
1100 stack_entry *entry = &stack.last ();
1102 /* We are walking an acyclic graph, so edge_num counts
1103 succ and pred edges together. However when considering
1104 articulation, we want to have processed everything reachable
1105 from articulation but nothing that reaches into it. */
1106 if (entry->edge_num == EDGE_COUNT (entry->bb->succs)
1107 && entry->bb != ENTRY_BLOCK_PTR_FOR_FN (cfun))
1109 int pos = stack.length ();
1110 entry->can_split &= visit_bb (entry->bb, return_bb,
1111 entry->set_ssa_names,
1112 entry->used_ssa_names,
1113 entry->non_ssa_vars);
1114 if (pos <= entry->earliest && !entry->can_split
1115 && dump_file && (dump_flags & TDF_DETAILS))
1116 fprintf (dump_file,
1117 "found articulation at bb %i but can not split\n",
1118 entry->bb->index);
1119 if (pos <= entry->earliest && entry->can_split)
1121 if (dump_file && (dump_flags & TDF_DETAILS))
1122 fprintf (dump_file, "found articulation at bb %i\n",
1123 entry->bb->index);
1124 current.entry_bb = entry->bb;
1125 current.ssa_names_to_pass = BITMAP_ALLOC (NULL);
1126 bitmap_and_compl (current.ssa_names_to_pass,
1127 entry->used_ssa_names, entry->set_ssa_names);
1128 current.header_time = overall_time - entry->overall_time;
1129 current.header_size = overall_size - entry->overall_size;
1130 current.split_time = entry->overall_time;
1131 current.split_size = entry->overall_size;
1132 current.split_bbs = entry->bbs_visited;
1133 consider_split (&current, entry->non_ssa_vars, return_bb);
1134 BITMAP_FREE (current.ssa_names_to_pass);
1137 /* Do actual DFS walk. */
1138 if (entry->edge_num
1139 < (EDGE_COUNT (entry->bb->succs)
1140 + EDGE_COUNT (entry->bb->preds)))
1142 edge e;
1143 basic_block dest;
1144 if (entry->edge_num < EDGE_COUNT (entry->bb->succs))
1146 e = EDGE_SUCC (entry->bb, entry->edge_num);
1147 dest = e->dest;
1149 else
1151 e = EDGE_PRED (entry->bb, entry->edge_num
1152 - EDGE_COUNT (entry->bb->succs));
1153 dest = e->src;
1156 entry->edge_num++;
1158 /* New BB to visit, push it to the stack. */
1159 if (dest != return_bb && dest != EXIT_BLOCK_PTR_FOR_FN (cfun)
1160 && !dest->aux)
1162 stack_entry new_entry;
1164 new_entry.bb = dest;
1165 new_entry.edge_num = 0;
1166 new_entry.overall_time
1167 = bb_info_vec[dest->index].time;
1168 new_entry.overall_size
1169 = bb_info_vec[dest->index].size;
1170 new_entry.earliest = INT_MAX;
1171 new_entry.set_ssa_names = BITMAP_ALLOC (NULL);
1172 new_entry.used_ssa_names = BITMAP_ALLOC (NULL);
1173 new_entry.bbs_visited = BITMAP_ALLOC (NULL);
1174 new_entry.non_ssa_vars = BITMAP_ALLOC (NULL);
1175 new_entry.can_split = true;
1176 bitmap_set_bit (new_entry.bbs_visited, dest->index);
1177 stack.safe_push (new_entry);
1178 dest->aux = (void *)(intptr_t)stack.length ();
1180 /* Back edge found, record the earliest point. */
1181 else if ((intptr_t)dest->aux > 0
1182 && (intptr_t)dest->aux < entry->earliest)
1183 entry->earliest = (intptr_t)dest->aux;
1185 /* We are done with examining the edges. Pop off the value from stack
1186 and merge stuff we accumulate during the walk. */
1187 else if (entry->bb != ENTRY_BLOCK_PTR_FOR_FN (cfun))
1189 stack_entry *prev = &stack[stack.length () - 2];
1191 entry->bb->aux = (void *)(intptr_t)-1;
1192 prev->can_split &= entry->can_split;
1193 if (prev->set_ssa_names)
1195 bitmap_ior_into (prev->set_ssa_names, entry->set_ssa_names);
1196 bitmap_ior_into (prev->used_ssa_names, entry->used_ssa_names);
1197 bitmap_ior_into (prev->bbs_visited, entry->bbs_visited);
1198 bitmap_ior_into (prev->non_ssa_vars, entry->non_ssa_vars);
1200 if (prev->earliest > entry->earliest)
1201 prev->earliest = entry->earliest;
1202 prev->overall_time += entry->overall_time;
1203 prev->overall_size += entry->overall_size;
1204 BITMAP_FREE (entry->set_ssa_names);
1205 BITMAP_FREE (entry->used_ssa_names);
1206 BITMAP_FREE (entry->bbs_visited);
1207 BITMAP_FREE (entry->non_ssa_vars);
1208 stack.pop ();
1210 else
1211 stack.pop ();
1213 ENTRY_BLOCK_PTR_FOR_FN (cfun)->aux = NULL;
1214 FOR_EACH_BB_FN (bb, cfun)
1215 bb->aux = NULL;
1216 stack.release ();
1217 BITMAP_FREE (current.ssa_names_to_pass);
1220 /* Split function at SPLIT_POINT. */
1222 static void
1223 split_function (basic_block return_bb, struct split_point *split_point,
1224 bool add_tsan_func_exit)
1226 vec<tree> args_to_pass = vNULL;
1227 bitmap args_to_skip;
1228 tree parm;
1229 int num = 0;
1230 cgraph_node *node, *cur_node = cgraph_node::get (current_function_decl);
1231 basic_block call_bb;
1232 gcall *call, *tsan_func_exit_call = NULL;
1233 edge e;
1234 edge_iterator ei;
1235 tree retval = NULL, real_retval = NULL, retbnd = NULL;
1236 bool split_part_return_p = false;
1237 bool with_bounds = chkp_function_instrumented_p (current_function_decl);
1238 gimple last_stmt = NULL;
1239 unsigned int i;
1240 tree arg, ddef;
1241 vec<tree, va_gc> **debug_args = NULL;
1243 if (dump_file)
1245 fprintf (dump_file, "\n\nSplitting function at:\n");
1246 dump_split_point (dump_file, split_point);
1249 if (cur_node->local.can_change_signature)
1250 args_to_skip = BITMAP_ALLOC (NULL);
1251 else
1252 args_to_skip = NULL;
1254 /* Collect the parameters of new function and args_to_skip bitmap. */
1255 for (parm = DECL_ARGUMENTS (current_function_decl);
1256 parm; parm = DECL_CHAIN (parm), num++)
1257 if (args_to_skip
1258 && (!is_gimple_reg (parm)
1259 || (ddef = ssa_default_def (cfun, parm)) == NULL_TREE
1260 || !bitmap_bit_p (split_point->ssa_names_to_pass,
1261 SSA_NAME_VERSION (ddef))))
1262 bitmap_set_bit (args_to_skip, num);
1263 else
1265 /* This parm might not have been used up to now, but is going to be
1266 used, hence register it. */
1267 if (is_gimple_reg (parm))
1268 arg = get_or_create_ssa_default_def (cfun, parm);
1269 else
1270 arg = parm;
1272 if (!useless_type_conversion_p (DECL_ARG_TYPE (parm), TREE_TYPE (arg)))
1273 arg = fold_convert (DECL_ARG_TYPE (parm), arg);
1274 args_to_pass.safe_push (arg);
1277 /* See if the split function will return. */
1278 FOR_EACH_EDGE (e, ei, return_bb->preds)
1279 if (bitmap_bit_p (split_point->split_bbs, e->src->index))
1280 break;
1281 if (e)
1282 split_part_return_p = true;
1284 /* Add return block to what will become the split function.
1285 We do not return; no return block is needed. */
1286 if (!split_part_return_p)
1288 /* We have no return block, so nothing is needed. */
1289 else if (return_bb == EXIT_BLOCK_PTR_FOR_FN (cfun))
1291 /* When we do not want to return value, we need to construct
1292 new return block with empty return statement.
1293 FIXME: Once we are able to change return type, we should change function
1294 to return void instead of just outputting function with undefined return
1295 value. For structures this affects quality of codegen. */
1296 else if (!split_point->split_part_set_retval
1297 && find_retval (return_bb))
1299 bool redirected = true;
1300 basic_block new_return_bb = create_basic_block (NULL, 0, return_bb);
1301 gimple_stmt_iterator gsi = gsi_start_bb (new_return_bb);
1302 gsi_insert_after (&gsi, gimple_build_return (NULL), GSI_NEW_STMT);
1303 while (redirected)
1305 redirected = false;
1306 FOR_EACH_EDGE (e, ei, return_bb->preds)
1307 if (bitmap_bit_p (split_point->split_bbs, e->src->index))
1309 new_return_bb->count += e->count;
1310 new_return_bb->frequency += EDGE_FREQUENCY (e);
1311 redirect_edge_and_branch (e, new_return_bb);
1312 redirected = true;
1313 break;
1316 e = make_edge (new_return_bb, EXIT_BLOCK_PTR_FOR_FN (cfun), 0);
1317 e->probability = REG_BR_PROB_BASE;
1318 e->count = new_return_bb->count;
1319 add_bb_to_loop (new_return_bb, current_loops->tree_root);
1320 bitmap_set_bit (split_point->split_bbs, new_return_bb->index);
1322 /* When we pass around the value, use existing return block. */
1323 else
1324 bitmap_set_bit (split_point->split_bbs, return_bb->index);
1326 /* If RETURN_BB has virtual operand PHIs, they must be removed and the
1327 virtual operand marked for renaming as we change the CFG in a way that
1328 tree-inline is not able to compensate for.
1330 Note this can happen whether or not we have a return value. If we have
1331 a return value, then RETURN_BB may have PHIs for real operands too. */
1332 if (return_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
1334 bool phi_p = false;
1335 for (gphi_iterator gsi = gsi_start_phis (return_bb);
1336 !gsi_end_p (gsi);)
1338 gphi *stmt = gsi.phi ();
1339 if (!virtual_operand_p (gimple_phi_result (stmt)))
1341 gsi_next (&gsi);
1342 continue;
1344 mark_virtual_phi_result_for_renaming (stmt);
1345 remove_phi_node (&gsi, true);
1346 phi_p = true;
1348 /* In reality we have to rename the reaching definition of the
1349 virtual operand at return_bb as we will eventually release it
1350 when we remove the code region we outlined.
1351 So we have to rename all immediate virtual uses of that region
1352 if we didn't see a PHI definition yet. */
1353 /* ??? In real reality we want to set the reaching vdef of the
1354 entry of the SESE region as the vuse of the call and the reaching
1355 vdef of the exit of the SESE region as the vdef of the call. */
1356 if (!phi_p)
1357 for (gimple_stmt_iterator gsi = gsi_start_bb (return_bb);
1358 !gsi_end_p (gsi);
1359 gsi_next (&gsi))
1361 gimple stmt = gsi_stmt (gsi);
1362 if (gimple_vuse (stmt))
1364 gimple_set_vuse (stmt, NULL_TREE);
1365 update_stmt (stmt);
1367 if (gimple_vdef (stmt))
1368 break;
1372 /* Now create the actual clone. */
1373 cgraph_edge::rebuild_edges ();
1374 node = cur_node->create_version_clone_with_body
1375 (vNULL, NULL, args_to_skip, !split_part_return_p, split_point->split_bbs,
1376 split_point->entry_bb, "part");
1378 node->split_part = true;
1380 /* Let's take a time profile for splitted function. */
1381 node->tp_first_run = cur_node->tp_first_run + 1;
1383 /* For usual cloning it is enough to clear builtin only when signature
1384 changes. For partial inlining we however can not expect the part
1385 of builtin implementation to have same semantic as the whole. */
1386 if (DECL_BUILT_IN (node->decl))
1388 DECL_BUILT_IN_CLASS (node->decl) = NOT_BUILT_IN;
1389 DECL_FUNCTION_CODE (node->decl) = (enum built_in_function) 0;
1392 /* If the original function is instrumented then it's
1393 part is also instrumented. */
1394 if (with_bounds)
1395 chkp_function_mark_instrumented (node->decl);
1397 /* If the original function is declared inline, there is no point in issuing
1398 a warning for the non-inlinable part. */
1399 DECL_NO_INLINE_WARNING_P (node->decl) = 1;
1400 cur_node->remove_callees ();
1401 cur_node->remove_all_references ();
1402 if (!split_part_return_p)
1403 TREE_THIS_VOLATILE (node->decl) = 1;
1404 if (dump_file)
1405 dump_function_to_file (node->decl, dump_file, dump_flags);
1407 /* Create the basic block we place call into. It is the entry basic block
1408 split after last label. */
1409 call_bb = split_point->entry_bb;
1410 for (gimple_stmt_iterator gsi = gsi_start_bb (call_bb); !gsi_end_p (gsi);)
1411 if (gimple_code (gsi_stmt (gsi)) == GIMPLE_LABEL)
1413 last_stmt = gsi_stmt (gsi);
1414 gsi_next (&gsi);
1416 else
1417 break;
1418 e = split_block (split_point->entry_bb, last_stmt);
1419 remove_edge (e);
1421 /* Produce the call statement. */
1422 gimple_stmt_iterator gsi = gsi_last_bb (call_bb);
1423 FOR_EACH_VEC_ELT (args_to_pass, i, arg)
1424 if (!is_gimple_val (arg))
1426 arg = force_gimple_operand_gsi (&gsi, arg, true, NULL_TREE,
1427 false, GSI_CONTINUE_LINKING);
1428 args_to_pass[i] = arg;
1430 call = gimple_build_call_vec (node->decl, args_to_pass);
1431 gimple_call_set_with_bounds (call, with_bounds);
1432 gimple_set_block (call, DECL_INITIAL (current_function_decl));
1433 args_to_pass.release ();
1435 /* For optimized away parameters, add on the caller side
1436 before the call
1437 DEBUG D#X => parm_Y(D)
1438 stmts and associate D#X with parm in decl_debug_args_lookup
1439 vector to say for debug info that if parameter parm had been passed,
1440 it would have value parm_Y(D). */
1441 if (args_to_skip)
1442 for (parm = DECL_ARGUMENTS (current_function_decl), num = 0;
1443 parm; parm = DECL_CHAIN (parm), num++)
1444 if (bitmap_bit_p (args_to_skip, num)
1445 && is_gimple_reg (parm))
1447 tree ddecl;
1448 gimple def_temp;
1450 /* This needs to be done even without MAY_HAVE_DEBUG_STMTS,
1451 otherwise if it didn't exist before, we'd end up with
1452 different SSA_NAME_VERSIONs between -g and -g0. */
1453 arg = get_or_create_ssa_default_def (cfun, parm);
1454 if (!MAY_HAVE_DEBUG_STMTS)
1455 continue;
1457 if (debug_args == NULL)
1458 debug_args = decl_debug_args_insert (node->decl);
1459 ddecl = make_node (DEBUG_EXPR_DECL);
1460 DECL_ARTIFICIAL (ddecl) = 1;
1461 TREE_TYPE (ddecl) = TREE_TYPE (parm);
1462 DECL_MODE (ddecl) = DECL_MODE (parm);
1463 vec_safe_push (*debug_args, DECL_ORIGIN (parm));
1464 vec_safe_push (*debug_args, ddecl);
1465 def_temp = gimple_build_debug_bind (ddecl, unshare_expr (arg),
1466 call);
1467 gsi_insert_after (&gsi, def_temp, GSI_NEW_STMT);
1469 /* And on the callee side, add
1470 DEBUG D#Y s=> parm
1471 DEBUG var => D#Y
1472 stmts to the first bb where var is a VAR_DECL created for the
1473 optimized away parameter in DECL_INITIAL block. This hints
1474 in the debug info that var (whole DECL_ORIGIN is the parm PARM_DECL)
1475 is optimized away, but could be looked up at the call site
1476 as value of D#X there. */
1477 if (debug_args != NULL)
1479 unsigned int i;
1480 tree var, vexpr;
1481 gimple_stmt_iterator cgsi;
1482 gimple def_temp;
1484 push_cfun (DECL_STRUCT_FUNCTION (node->decl));
1485 var = BLOCK_VARS (DECL_INITIAL (node->decl));
1486 i = vec_safe_length (*debug_args);
1487 cgsi = gsi_after_labels (single_succ (ENTRY_BLOCK_PTR_FOR_FN (cfun)));
1490 i -= 2;
1491 while (var != NULL_TREE
1492 && DECL_ABSTRACT_ORIGIN (var) != (**debug_args)[i])
1493 var = TREE_CHAIN (var);
1494 if (var == NULL_TREE)
1495 break;
1496 vexpr = make_node (DEBUG_EXPR_DECL);
1497 parm = (**debug_args)[i];
1498 DECL_ARTIFICIAL (vexpr) = 1;
1499 TREE_TYPE (vexpr) = TREE_TYPE (parm);
1500 DECL_MODE (vexpr) = DECL_MODE (parm);
1501 def_temp = gimple_build_debug_source_bind (vexpr, parm,
1502 NULL);
1503 gsi_insert_before (&cgsi, def_temp, GSI_SAME_STMT);
1504 def_temp = gimple_build_debug_bind (var, vexpr, NULL);
1505 gsi_insert_before (&cgsi, def_temp, GSI_SAME_STMT);
1507 while (i);
1508 pop_cfun ();
1511 /* We avoid address being taken on any variable used by split part,
1512 so return slot optimization is always possible. Moreover this is
1513 required to make DECL_BY_REFERENCE work. */
1514 if (aggregate_value_p (DECL_RESULT (current_function_decl),
1515 TREE_TYPE (current_function_decl))
1516 && (!is_gimple_reg_type (TREE_TYPE (DECL_RESULT (current_function_decl)))
1517 || DECL_BY_REFERENCE (DECL_RESULT (current_function_decl))))
1518 gimple_call_set_return_slot_opt (call, true);
1520 if (add_tsan_func_exit)
1521 tsan_func_exit_call = gimple_build_call_internal (IFN_TSAN_FUNC_EXIT, 0);
1523 /* Update return value. This is bit tricky. When we do not return,
1524 do nothing. When we return we might need to update return_bb
1525 or produce a new return statement. */
1526 if (!split_part_return_p)
1528 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1529 if (tsan_func_exit_call)
1530 gsi_insert_after (&gsi, tsan_func_exit_call, GSI_NEW_STMT);
1532 else
1534 e = make_edge (call_bb, return_bb,
1535 return_bb == EXIT_BLOCK_PTR_FOR_FN (cfun)
1536 ? 0 : EDGE_FALLTHRU);
1537 e->count = call_bb->count;
1538 e->probability = REG_BR_PROB_BASE;
1540 /* If there is return basic block, see what value we need to store
1541 return value into and put call just before it. */
1542 if (return_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
1544 real_retval = retval = find_retval (return_bb);
1545 retbnd = find_retbnd (return_bb);
1547 if (real_retval && split_point->split_part_set_retval)
1549 gphi_iterator psi;
1551 /* See if we need new SSA_NAME for the result.
1552 When DECL_BY_REFERENCE is true, retval is actually pointer to
1553 return value and it is constant in whole function. */
1554 if (TREE_CODE (retval) == SSA_NAME
1555 && !DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
1557 retval = copy_ssa_name (retval, call);
1559 /* See if there is PHI defining return value. */
1560 for (psi = gsi_start_phis (return_bb);
1561 !gsi_end_p (psi); gsi_next (&psi))
1562 if (!virtual_operand_p (gimple_phi_result (psi.phi ())))
1563 break;
1565 /* When there is PHI, just update its value. */
1566 if (TREE_CODE (retval) == SSA_NAME
1567 && !gsi_end_p (psi))
1568 add_phi_arg (psi.phi (), retval, e, UNKNOWN_LOCATION);
1569 /* Otherwise update the return BB itself.
1570 find_return_bb allows at most one assignment to return value,
1571 so update first statement. */
1572 else
1574 gimple_stmt_iterator bsi;
1575 for (bsi = gsi_start_bb (return_bb); !gsi_end_p (bsi);
1576 gsi_next (&bsi))
1577 if (greturn *return_stmt
1578 = dyn_cast <greturn *> (gsi_stmt (bsi)))
1580 gimple_return_set_retval (return_stmt, retval);
1581 break;
1583 else if (gimple_code (gsi_stmt (bsi)) == GIMPLE_ASSIGN
1584 && !gimple_clobber_p (gsi_stmt (bsi)))
1586 gimple_assign_set_rhs1 (gsi_stmt (bsi), retval);
1587 break;
1589 update_stmt (gsi_stmt (bsi));
1592 /* Replace retbnd with new one. */
1593 if (retbnd)
1595 gimple_stmt_iterator bsi;
1596 for (bsi = gsi_last_bb (return_bb); !gsi_end_p (bsi);
1597 gsi_prev (&bsi))
1598 if (gimple_code (gsi_stmt (bsi)) == GIMPLE_RETURN)
1600 retbnd = copy_ssa_name (retbnd, call);
1601 gimple_return_set_retbnd (gsi_stmt (bsi), retbnd);
1602 update_stmt (gsi_stmt (bsi));
1603 break;
1607 if (DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
1609 gimple_call_set_lhs (call, build_simple_mem_ref (retval));
1610 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1612 else
1614 tree restype;
1615 restype = TREE_TYPE (DECL_RESULT (current_function_decl));
1616 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1617 if (!useless_type_conversion_p (TREE_TYPE (retval), restype))
1619 gimple cpy;
1620 tree tem = create_tmp_reg (restype);
1621 tem = make_ssa_name (tem, call);
1622 cpy = gimple_build_assign (retval, NOP_EXPR, tem);
1623 gsi_insert_after (&gsi, cpy, GSI_NEW_STMT);
1624 retval = tem;
1626 /* Build bndret call to obtain returned bounds. */
1627 if (retbnd)
1628 chkp_insert_retbnd_call (retbnd, retval, &gsi);
1629 gimple_call_set_lhs (call, retval);
1630 update_stmt (call);
1633 else
1634 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1635 if (tsan_func_exit_call)
1636 gsi_insert_after (&gsi, tsan_func_exit_call, GSI_NEW_STMT);
1638 /* We don't use return block (there is either no return in function or
1639 multiple of them). So create new basic block with return statement.
1641 else
1643 greturn *ret;
1644 if (split_point->split_part_set_retval
1645 && !VOID_TYPE_P (TREE_TYPE (TREE_TYPE (current_function_decl))))
1647 retval = DECL_RESULT (current_function_decl);
1649 if (chkp_function_instrumented_p (current_function_decl)
1650 && BOUNDED_P (retval))
1651 retbnd = create_tmp_reg (pointer_bounds_type_node);
1653 /* We use temporary register to hold value when aggregate_value_p
1654 is false. Similarly for DECL_BY_REFERENCE we must avoid extra
1655 copy. */
1656 if (!aggregate_value_p (retval, TREE_TYPE (current_function_decl))
1657 && !DECL_BY_REFERENCE (retval))
1658 retval = create_tmp_reg (TREE_TYPE (retval));
1659 if (is_gimple_reg (retval))
1661 /* When returning by reference, there is only one SSA name
1662 assigned to RESULT_DECL (that is pointer to return value).
1663 Look it up or create new one if it is missing. */
1664 if (DECL_BY_REFERENCE (retval))
1665 retval = get_or_create_ssa_default_def (cfun, retval);
1666 /* Otherwise produce new SSA name for return value. */
1667 else
1668 retval = make_ssa_name (retval, call);
1670 if (DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
1671 gimple_call_set_lhs (call, build_simple_mem_ref (retval));
1672 else
1673 gimple_call_set_lhs (call, retval);
1675 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1676 /* Build bndret call to obtain returned bounds. */
1677 if (retbnd)
1678 chkp_insert_retbnd_call (retbnd, retval, &gsi);
1679 if (tsan_func_exit_call)
1680 gsi_insert_after (&gsi, tsan_func_exit_call, GSI_NEW_STMT);
1681 ret = gimple_build_return (retval);
1682 gsi_insert_after (&gsi, ret, GSI_NEW_STMT);
1685 free_dominance_info (CDI_DOMINATORS);
1686 free_dominance_info (CDI_POST_DOMINATORS);
1687 compute_inline_parameters (node, true);
1690 /* Execute function splitting pass. */
1692 static unsigned int
1693 execute_split_functions (void)
1695 gimple_stmt_iterator bsi;
1696 basic_block bb;
1697 int overall_time = 0, overall_size = 0;
1698 int todo = 0;
1699 struct cgraph_node *node = cgraph_node::get (current_function_decl);
1701 if (flags_from_decl_or_type (current_function_decl)
1702 & (ECF_NORETURN|ECF_MALLOC))
1704 if (dump_file)
1705 fprintf (dump_file, "Not splitting: noreturn/malloc function.\n");
1706 return 0;
1708 if (MAIN_NAME_P (DECL_NAME (current_function_decl)))
1710 if (dump_file)
1711 fprintf (dump_file, "Not splitting: main function.\n");
1712 return 0;
1714 /* This can be relaxed; function might become inlinable after splitting
1715 away the uninlinable part. */
1716 if (inline_edge_summary_vec.exists ()
1717 && !inline_summaries->get (node)->inlinable)
1719 if (dump_file)
1720 fprintf (dump_file, "Not splitting: not inlinable.\n");
1721 return 0;
1723 if (DECL_DISREGARD_INLINE_LIMITS (node->decl))
1725 if (dump_file)
1726 fprintf (dump_file, "Not splitting: disregarding inline limits.\n");
1727 return 0;
1729 /* This can be relaxed; most of versioning tests actually prevents
1730 a duplication. */
1731 if (!tree_versionable_function_p (current_function_decl))
1733 if (dump_file)
1734 fprintf (dump_file, "Not splitting: not versionable.\n");
1735 return 0;
1737 /* FIXME: we could support this. */
1738 if (DECL_STRUCT_FUNCTION (current_function_decl)->static_chain_decl)
1740 if (dump_file)
1741 fprintf (dump_file, "Not splitting: nested function.\n");
1742 return 0;
1745 /* See if it makes sense to try to split.
1746 It makes sense to split if we inline, that is if we have direct calls to
1747 handle or direct calls are possibly going to appear as result of indirect
1748 inlining or LTO. Also handle -fprofile-generate as LTO to allow non-LTO
1749 training for LTO -fprofile-use build.
1751 Note that we are not completely conservative about disqualifying functions
1752 called once. It is possible that the caller is called more then once and
1753 then inlining would still benefit. */
1754 if ((!node->callers
1755 /* Local functions called once will be completely inlined most of time. */
1756 || (!node->callers->next_caller && node->local.local))
1757 && !node->address_taken
1758 && !node->has_aliases_p ()
1759 && (!flag_lto || !node->externally_visible))
1761 if (dump_file)
1762 fprintf (dump_file, "Not splitting: not called directly "
1763 "or called once.\n");
1764 return 0;
1767 /* FIXME: We can actually split if splitting reduces call overhead. */
1768 if (!flag_inline_small_functions
1769 && !DECL_DECLARED_INLINE_P (current_function_decl))
1771 if (dump_file)
1772 fprintf (dump_file, "Not splitting: not autoinlining and function"
1773 " is not inline.\n");
1774 return 0;
1777 /* We enforce splitting after loop headers when profile info is not
1778 available. */
1779 if (profile_status_for_fn (cfun) != PROFILE_READ)
1780 mark_dfs_back_edges ();
1782 /* Initialize bitmap to track forbidden calls. */
1783 forbidden_dominators = BITMAP_ALLOC (NULL);
1784 calculate_dominance_info (CDI_DOMINATORS);
1786 /* Compute local info about basic blocks and determine function size/time. */
1787 bb_info_vec.safe_grow_cleared (last_basic_block_for_fn (cfun) + 1);
1788 memset (&best_split_point, 0, sizeof (best_split_point));
1789 basic_block return_bb = find_return_bb ();
1790 int tsan_exit_found = -1;
1791 FOR_EACH_BB_FN (bb, cfun)
1793 int time = 0;
1794 int size = 0;
1795 int freq = compute_call_stmt_bb_frequency (current_function_decl, bb);
1797 if (dump_file && (dump_flags & TDF_DETAILS))
1798 fprintf (dump_file, "Basic block %i\n", bb->index);
1800 for (bsi = gsi_start_bb (bb); !gsi_end_p (bsi); gsi_next (&bsi))
1802 int this_time, this_size;
1803 gimple stmt = gsi_stmt (bsi);
1805 this_size = estimate_num_insns (stmt, &eni_size_weights);
1806 this_time = estimate_num_insns (stmt, &eni_time_weights) * freq;
1807 size += this_size;
1808 time += this_time;
1809 check_forbidden_calls (stmt);
1811 if (dump_file && (dump_flags & TDF_DETAILS))
1813 fprintf (dump_file, " freq:%6i size:%3i time:%3i ",
1814 freq, this_size, this_time);
1815 print_gimple_stmt (dump_file, stmt, 0, 0);
1818 if ((flag_sanitize & SANITIZE_THREAD)
1819 && is_gimple_call (stmt)
1820 && gimple_call_internal_p (stmt)
1821 && gimple_call_internal_fn (stmt) == IFN_TSAN_FUNC_EXIT)
1823 /* We handle TSAN_FUNC_EXIT for splitting either in the
1824 return_bb, or in its immediate predecessors. */
1825 if ((bb != return_bb && !find_edge (bb, return_bb))
1826 || (tsan_exit_found != -1
1827 && tsan_exit_found != (bb != return_bb)))
1829 if (dump_file)
1830 fprintf (dump_file, "Not splitting: TSAN_FUNC_EXIT"
1831 " in unexpected basic block.\n");
1832 BITMAP_FREE (forbidden_dominators);
1833 bb_info_vec.release ();
1834 return 0;
1836 tsan_exit_found = bb != return_bb;
1839 overall_time += time;
1840 overall_size += size;
1841 bb_info_vec[bb->index].time = time;
1842 bb_info_vec[bb->index].size = size;
1844 find_split_points (return_bb, overall_time, overall_size);
1845 if (best_split_point.split_bbs)
1847 split_function (return_bb, &best_split_point, tsan_exit_found == 1);
1848 BITMAP_FREE (best_split_point.ssa_names_to_pass);
1849 BITMAP_FREE (best_split_point.split_bbs);
1850 todo = TODO_update_ssa | TODO_cleanup_cfg;
1852 BITMAP_FREE (forbidden_dominators);
1853 bb_info_vec.release ();
1854 return todo;
1857 namespace {
1859 const pass_data pass_data_split_functions =
1861 GIMPLE_PASS, /* type */
1862 "fnsplit", /* name */
1863 OPTGROUP_NONE, /* optinfo_flags */
1864 TV_IPA_FNSPLIT, /* tv_id */
1865 PROP_cfg, /* properties_required */
1866 0, /* properties_provided */
1867 0, /* properties_destroyed */
1868 0, /* todo_flags_start */
1869 0, /* todo_flags_finish */
1872 class pass_split_functions : public gimple_opt_pass
1874 public:
1875 pass_split_functions (gcc::context *ctxt)
1876 : gimple_opt_pass (pass_data_split_functions, ctxt)
1879 /* opt_pass methods: */
1880 virtual bool gate (function *);
1881 virtual unsigned int execute (function *)
1883 return execute_split_functions ();
1886 }; // class pass_split_functions
1888 bool
1889 pass_split_functions::gate (function *)
1891 /* When doing profile feedback, we want to execute the pass after profiling
1892 is read. So disable one in early optimization. */
1893 return (flag_partial_inlining
1894 && !profile_arc_flag && !flag_branch_probabilities);
1897 } // anon namespace
1899 gimple_opt_pass *
1900 make_pass_split_functions (gcc::context *ctxt)
1902 return new pass_split_functions (ctxt);
1905 /* Execute function splitting pass. */
1907 static unsigned int
1908 execute_feedback_split_functions (void)
1910 unsigned int retval = execute_split_functions ();
1911 if (retval)
1912 retval |= TODO_rebuild_cgraph_edges;
1913 return retval;
1916 namespace {
1918 const pass_data pass_data_feedback_split_functions =
1920 GIMPLE_PASS, /* type */
1921 "feedback_fnsplit", /* name */
1922 OPTGROUP_NONE, /* optinfo_flags */
1923 TV_IPA_FNSPLIT, /* tv_id */
1924 PROP_cfg, /* properties_required */
1925 0, /* properties_provided */
1926 0, /* properties_destroyed */
1927 0, /* todo_flags_start */
1928 0, /* todo_flags_finish */
1931 class pass_feedback_split_functions : public gimple_opt_pass
1933 public:
1934 pass_feedback_split_functions (gcc::context *ctxt)
1935 : gimple_opt_pass (pass_data_feedback_split_functions, ctxt)
1938 /* opt_pass methods: */
1939 virtual bool gate (function *);
1940 virtual unsigned int execute (function *)
1942 return execute_feedback_split_functions ();
1945 }; // class pass_feedback_split_functions
1947 bool
1948 pass_feedback_split_functions::gate (function *)
1950 /* We don't need to split when profiling at all, we are producing
1951 lousy code anyway. */
1952 return (flag_partial_inlining
1953 && flag_branch_probabilities);
1956 } // anon namespace
1958 gimple_opt_pass *
1959 make_pass_feedback_split_functions (gcc::context *ctxt)
1961 return new pass_feedback_split_functions (ctxt);