* ipa-split.c (split_function): Initialize return bb profile.
[official-gcc.git] / gcc / ipa-split.c
blob0af31d683530df0ac2c6524d61d72abf7c24853e
1 /* Function splitting pass
2 Copyright (C) 2010-2017 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 "backend.h"
81 #include "rtl.h"
82 #include "tree.h"
83 #include "gimple.h"
84 #include "cfghooks.h"
85 #include "alloc-pool.h"
86 #include "tree-pass.h"
87 #include "ssa.h"
88 #include "cgraph.h"
89 #include "diagnostic.h"
90 #include "fold-const.h"
91 #include "cfganal.h"
92 #include "calls.h"
93 #include "gimplify.h"
94 #include "gimple-iterator.h"
95 #include "gimplify-me.h"
96 #include "gimple-walk.h"
97 #include "symbol-summary.h"
98 #include "ipa-prop.h"
99 #include "tree-cfg.h"
100 #include "tree-into-ssa.h"
101 #include "tree-dfa.h"
102 #include "tree-inline.h"
103 #include "params.h"
104 #include "gimple-pretty-print.h"
105 #include "ipa-fnsummary.h"
106 #include "cfgloop.h"
107 #include "tree-chkp.h"
109 /* Per basic block info. */
111 struct split_bb_info
113 unsigned int size;
114 unsigned int time;
117 static vec<split_bb_info> bb_info_vec;
119 /* Description of split point. */
121 struct split_point
123 /* Size of the partitions. */
124 unsigned int header_time, header_size, split_time, split_size;
126 /* SSA names that need to be passed into spit function. */
127 bitmap ssa_names_to_pass;
129 /* Basic block where we split (that will become entry point of new function. */
130 basic_block entry_bb;
132 /* Basic blocks we are splitting away. */
133 bitmap split_bbs;
135 /* True when return value is computed on split part and thus it needs
136 to be returned. */
137 bool split_part_set_retval;
140 /* Best split point found. */
142 struct split_point best_split_point;
144 /* Set of basic blocks that are not allowed to dominate a split point. */
146 static bitmap forbidden_dominators;
148 static tree find_retval (basic_block return_bb);
149 static tree find_retbnd (basic_block return_bb);
151 /* Callback for walk_stmt_load_store_addr_ops. If T is non-SSA automatic
152 variable, check it if it is present in bitmap passed via DATA. */
154 static bool
155 test_nonssa_use (gimple *, tree t, tree, void *data)
157 t = get_base_address (t);
159 if (!t || is_gimple_reg (t))
160 return false;
162 if (TREE_CODE (t) == PARM_DECL
163 || (VAR_P (t)
164 && auto_var_in_fn_p (t, current_function_decl))
165 || TREE_CODE (t) == RESULT_DECL
166 /* Normal labels are part of CFG and will be handled gratefuly.
167 Forced labels however can be used directly by statements and
168 need to stay in one partition along with their uses. */
169 || (TREE_CODE (t) == LABEL_DECL
170 && FORCED_LABEL (t)))
171 return bitmap_bit_p ((bitmap)data, DECL_UID (t));
173 /* For DECL_BY_REFERENCE, the return value is actually a pointer. We want
174 to pretend that the value pointed to is actual result decl. */
175 if ((TREE_CODE (t) == MEM_REF || INDIRECT_REF_P (t))
176 && TREE_CODE (TREE_OPERAND (t, 0)) == SSA_NAME
177 && SSA_NAME_VAR (TREE_OPERAND (t, 0))
178 && TREE_CODE (SSA_NAME_VAR (TREE_OPERAND (t, 0))) == RESULT_DECL
179 && DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
180 return
181 bitmap_bit_p ((bitmap)data,
182 DECL_UID (DECL_RESULT (current_function_decl)));
184 return false;
187 /* Dump split point CURRENT. */
189 static void
190 dump_split_point (FILE * file, struct split_point *current)
192 fprintf (file,
193 "Split point at BB %i\n"
194 " header time: %i header size: %i\n"
195 " split time: %i split size: %i\n bbs: ",
196 current->entry_bb->index, current->header_time,
197 current->header_size, current->split_time, current->split_size);
198 dump_bitmap (file, current->split_bbs);
199 fprintf (file, " SSA names to pass: ");
200 dump_bitmap (file, current->ssa_names_to_pass);
203 /* Look for all BBs in header that might lead to the split part and verify
204 that they are not defining any non-SSA var used by the split part.
205 Parameters are the same as for consider_split. */
207 static bool
208 verify_non_ssa_vars (struct split_point *current, bitmap non_ssa_vars,
209 basic_block return_bb)
211 bitmap seen = BITMAP_ALLOC (NULL);
212 vec<basic_block> worklist = vNULL;
213 edge e;
214 edge_iterator ei;
215 bool ok = true;
216 basic_block bb;
218 FOR_EACH_EDGE (e, ei, current->entry_bb->preds)
219 if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
220 && !bitmap_bit_p (current->split_bbs, e->src->index))
222 worklist.safe_push (e->src);
223 bitmap_set_bit (seen, e->src->index);
226 while (!worklist.is_empty ())
228 bb = worklist.pop ();
229 FOR_EACH_EDGE (e, ei, bb->preds)
230 if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
231 && bitmap_set_bit (seen, e->src->index))
233 gcc_checking_assert (!bitmap_bit_p (current->split_bbs,
234 e->src->index));
235 worklist.safe_push (e->src);
237 for (gimple_stmt_iterator bsi = gsi_start_bb (bb); !gsi_end_p (bsi);
238 gsi_next (&bsi))
240 gimple *stmt = gsi_stmt (bsi);
241 if (is_gimple_debug (stmt))
242 continue;
243 if (walk_stmt_load_store_addr_ops
244 (stmt, non_ssa_vars, test_nonssa_use, test_nonssa_use,
245 test_nonssa_use))
247 ok = false;
248 goto done;
250 if (glabel *label_stmt = dyn_cast <glabel *> (stmt))
251 if (test_nonssa_use (stmt, gimple_label_label (label_stmt),
252 NULL_TREE, non_ssa_vars))
254 ok = false;
255 goto done;
258 for (gphi_iterator bsi = gsi_start_phis (bb); !gsi_end_p (bsi);
259 gsi_next (&bsi))
261 if (walk_stmt_load_store_addr_ops
262 (gsi_stmt (bsi), non_ssa_vars, test_nonssa_use, test_nonssa_use,
263 test_nonssa_use))
265 ok = false;
266 goto done;
269 FOR_EACH_EDGE (e, ei, bb->succs)
271 if (e->dest != return_bb)
272 continue;
273 for (gphi_iterator bsi = gsi_start_phis (return_bb);
274 !gsi_end_p (bsi);
275 gsi_next (&bsi))
277 gphi *stmt = bsi.phi ();
278 tree op = gimple_phi_arg_def (stmt, e->dest_idx);
280 if (virtual_operand_p (gimple_phi_result (stmt)))
281 continue;
282 if (TREE_CODE (op) != SSA_NAME
283 && test_nonssa_use (stmt, op, op, non_ssa_vars))
285 ok = false;
286 goto done;
292 /* Verify that the rest of function does not define any label
293 used by the split part. */
294 FOR_EACH_BB_FN (bb, cfun)
295 if (!bitmap_bit_p (current->split_bbs, bb->index)
296 && !bitmap_bit_p (seen, bb->index))
298 gimple_stmt_iterator bsi;
299 for (bsi = gsi_start_bb (bb); !gsi_end_p (bsi); gsi_next (&bsi))
300 if (glabel *label_stmt = dyn_cast <glabel *> (gsi_stmt (bsi)))
302 if (test_nonssa_use (label_stmt,
303 gimple_label_label (label_stmt),
304 NULL_TREE, non_ssa_vars))
306 ok = false;
307 goto done;
310 else
311 break;
314 done:
315 BITMAP_FREE (seen);
316 worklist.release ();
317 return ok;
320 /* If STMT is a call, check the callee against a list of forbidden
321 predicate functions. If a match is found, look for uses of the
322 call result in condition statements that compare against zero.
323 For each such use, find the block targeted by the condition
324 statement for the nonzero result, and set the bit for this block
325 in the forbidden dominators bitmap. The purpose of this is to avoid
326 selecting a split point where we are likely to lose the chance
327 to optimize away an unused function call. */
329 static void
330 check_forbidden_calls (gimple *stmt)
332 imm_use_iterator use_iter;
333 use_operand_p use_p;
334 tree lhs;
336 /* At the moment, __builtin_constant_p is the only forbidden
337 predicate function call (see PR49642). */
338 if (!gimple_call_builtin_p (stmt, BUILT_IN_CONSTANT_P))
339 return;
341 lhs = gimple_call_lhs (stmt);
343 if (!lhs || TREE_CODE (lhs) != SSA_NAME)
344 return;
346 FOR_EACH_IMM_USE_FAST (use_p, use_iter, lhs)
348 tree op1;
349 basic_block use_bb, forbidden_bb;
350 enum tree_code code;
351 edge true_edge, false_edge;
352 gcond *use_stmt;
354 use_stmt = dyn_cast <gcond *> (USE_STMT (use_p));
355 if (!use_stmt)
356 continue;
358 /* Assuming canonical form for GIMPLE_COND here, with constant
359 in second position. */
360 op1 = gimple_cond_rhs (use_stmt);
361 code = gimple_cond_code (use_stmt);
362 use_bb = gimple_bb (use_stmt);
364 extract_true_false_edges_from_block (use_bb, &true_edge, &false_edge);
366 /* We're only interested in comparisons that distinguish
367 unambiguously from zero. */
368 if (!integer_zerop (op1) || code == LE_EXPR || code == GE_EXPR)
369 continue;
371 if (code == EQ_EXPR)
372 forbidden_bb = false_edge->dest;
373 else
374 forbidden_bb = true_edge->dest;
376 bitmap_set_bit (forbidden_dominators, forbidden_bb->index);
380 /* If BB is dominated by any block in the forbidden dominators set,
381 return TRUE; else FALSE. */
383 static bool
384 dominated_by_forbidden (basic_block bb)
386 unsigned dom_bb;
387 bitmap_iterator bi;
389 EXECUTE_IF_SET_IN_BITMAP (forbidden_dominators, 1, dom_bb, bi)
391 if (dominated_by_p (CDI_DOMINATORS, bb,
392 BASIC_BLOCK_FOR_FN (cfun, dom_bb)))
393 return true;
396 return false;
399 /* For give split point CURRENT and return block RETURN_BB return 1
400 if ssa name VAL is set by split part and 0 otherwise. */
401 static bool
402 split_part_set_ssa_name_p (tree val, struct split_point *current,
403 basic_block return_bb)
405 if (TREE_CODE (val) != SSA_NAME)
406 return false;
408 return (!SSA_NAME_IS_DEFAULT_DEF (val)
409 && (bitmap_bit_p (current->split_bbs,
410 gimple_bb (SSA_NAME_DEF_STMT (val))->index)
411 || gimple_bb (SSA_NAME_DEF_STMT (val)) == return_bb));
414 /* We found an split_point CURRENT. NON_SSA_VARS is bitmap of all non ssa
415 variables used and RETURN_BB is return basic block.
416 See if we can split function here. */
418 static void
419 consider_split (struct split_point *current, bitmap non_ssa_vars,
420 basic_block return_bb)
422 tree parm;
423 unsigned int num_args = 0;
424 unsigned int call_overhead;
425 edge e;
426 edge_iterator ei;
427 gphi_iterator bsi;
428 unsigned int i;
429 int incoming_freq = 0;
430 tree retval;
431 tree retbnd;
432 bool back_edge = false;
434 if (dump_file && (dump_flags & TDF_DETAILS))
435 dump_split_point (dump_file, current);
437 FOR_EACH_EDGE (e, ei, current->entry_bb->preds)
439 if (e->flags & EDGE_DFS_BACK)
440 back_edge = true;
441 if (!bitmap_bit_p (current->split_bbs, e->src->index))
442 incoming_freq += EDGE_FREQUENCY (e);
445 /* Do not split when we would end up calling function anyway. */
446 if (incoming_freq
447 >= (ENTRY_BLOCK_PTR_FOR_FN (cfun)->frequency
448 * PARAM_VALUE (PARAM_PARTIAL_INLINING_ENTRY_PROBABILITY) / 100))
450 /* When profile is guessed, we can not expect it to give us
451 realistic estimate on likelyness of function taking the
452 complex path. As a special case, when tail of the function is
453 a loop, enable splitting since inlining code skipping the loop
454 is likely noticeable win. */
455 if (back_edge
456 && profile_status_for_fn (cfun) != PROFILE_READ
457 && incoming_freq < ENTRY_BLOCK_PTR_FOR_FN (cfun)->frequency)
459 if (dump_file && (dump_flags & TDF_DETAILS))
460 fprintf (dump_file,
461 " Split before loop, accepting despite low frequencies %i %i.\n",
462 incoming_freq,
463 ENTRY_BLOCK_PTR_FOR_FN (cfun)->frequency);
465 else
467 if (dump_file && (dump_flags & TDF_DETAILS))
468 fprintf (dump_file,
469 " Refused: incoming frequency is too large.\n");
470 return;
474 if (!current->header_size)
476 if (dump_file && (dump_flags & TDF_DETAILS))
477 fprintf (dump_file, " Refused: header empty\n");
478 return;
481 /* Verify that PHI args on entry are either virtual or all their operands
482 incoming from header are the same. */
483 for (bsi = gsi_start_phis (current->entry_bb); !gsi_end_p (bsi); gsi_next (&bsi))
485 gphi *stmt = bsi.phi ();
486 tree val = NULL;
488 if (virtual_operand_p (gimple_phi_result (stmt)))
489 continue;
490 for (i = 0; i < gimple_phi_num_args (stmt); i++)
492 edge e = gimple_phi_arg_edge (stmt, i);
493 if (!bitmap_bit_p (current->split_bbs, e->src->index))
495 tree edge_val = gimple_phi_arg_def (stmt, i);
496 if (val && edge_val != val)
498 if (dump_file && (dump_flags & TDF_DETAILS))
499 fprintf (dump_file,
500 " Refused: entry BB has PHI with multiple variants\n");
501 return;
503 val = edge_val;
509 /* See what argument we will pass to the split function and compute
510 call overhead. */
511 call_overhead = eni_size_weights.call_cost;
512 for (parm = DECL_ARGUMENTS (current_function_decl); parm;
513 parm = DECL_CHAIN (parm))
515 if (!is_gimple_reg (parm))
517 if (bitmap_bit_p (non_ssa_vars, DECL_UID (parm)))
519 if (dump_file && (dump_flags & TDF_DETAILS))
520 fprintf (dump_file,
521 " Refused: need to pass non-ssa param values\n");
522 return;
525 else
527 tree ddef = ssa_default_def (cfun, parm);
528 if (ddef
529 && bitmap_bit_p (current->ssa_names_to_pass,
530 SSA_NAME_VERSION (ddef)))
532 if (!VOID_TYPE_P (TREE_TYPE (parm)))
533 call_overhead += estimate_move_cost (TREE_TYPE (parm), false);
534 num_args++;
538 if (!VOID_TYPE_P (TREE_TYPE (current_function_decl)))
539 call_overhead += estimate_move_cost (TREE_TYPE (current_function_decl),
540 false);
542 if (current->split_size <= call_overhead)
544 if (dump_file && (dump_flags & TDF_DETAILS))
545 fprintf (dump_file,
546 " Refused: split size is smaller than call overhead\n");
547 return;
549 if (current->header_size + call_overhead
550 >= (unsigned int)(DECL_DECLARED_INLINE_P (current_function_decl)
551 ? MAX_INLINE_INSNS_SINGLE
552 : MAX_INLINE_INSNS_AUTO))
554 if (dump_file && (dump_flags & TDF_DETAILS))
555 fprintf (dump_file,
556 " Refused: header size is too large for inline candidate\n");
557 return;
560 /* Splitting functions brings the target out of comdat group; this will
561 lead to code duplication if the function is reused by other unit.
562 Limit this duplication. This is consistent with limit in tree-sra.c
563 FIXME: with LTO we ought to be able to do better! */
564 if (DECL_ONE_ONLY (current_function_decl)
565 && current->split_size >= (unsigned int) MAX_INLINE_INSNS_AUTO)
567 if (dump_file && (dump_flags & TDF_DETAILS))
568 fprintf (dump_file,
569 " Refused: function is COMDAT and tail is too large\n");
570 return;
572 /* For comdat functions also reject very small tails; those will likely get
573 inlined back and we do not want to risk the duplication overhead.
574 FIXME: with LTO we ought to be able to do better! */
575 if (DECL_ONE_ONLY (current_function_decl)
576 && current->split_size
577 <= (unsigned int) PARAM_VALUE (PARAM_EARLY_INLINING_INSNS) / 2)
579 if (dump_file && (dump_flags & TDF_DETAILS))
580 fprintf (dump_file,
581 " Refused: function is COMDAT and tail is too small\n");
582 return;
585 /* FIXME: we currently can pass only SSA function parameters to the split
586 arguments. Once parm_adjustment infrastructure is supported by cloning,
587 we can pass more than that. */
588 if (num_args != bitmap_count_bits (current->ssa_names_to_pass))
591 if (dump_file && (dump_flags & TDF_DETAILS))
592 fprintf (dump_file,
593 " Refused: need to pass non-param values\n");
594 return;
597 /* When there are non-ssa vars used in the split region, see if they
598 are used in the header region. If so, reject the split.
599 FIXME: we can use nested function support to access both. */
600 if (!bitmap_empty_p (non_ssa_vars)
601 && !verify_non_ssa_vars (current, non_ssa_vars, return_bb))
603 if (dump_file && (dump_flags & TDF_DETAILS))
604 fprintf (dump_file,
605 " Refused: split part has non-ssa uses\n");
606 return;
609 /* If the split point is dominated by a forbidden block, reject
610 the split. */
611 if (!bitmap_empty_p (forbidden_dominators)
612 && dominated_by_forbidden (current->entry_bb))
614 if (dump_file && (dump_flags & TDF_DETAILS))
615 fprintf (dump_file,
616 " Refused: split point dominated by forbidden block\n");
617 return;
620 /* See if retval used by return bb is computed by header or split part.
621 When it is computed by split part, we need to produce return statement
622 in the split part and add code to header to pass it around.
624 This is bit tricky to test:
625 1) When there is no return_bb or no return value, we always pass
626 value around.
627 2) Invariants are always computed by caller.
628 3) For SSA we need to look if defining statement is in header or split part
629 4) For non-SSA we need to look where the var is computed. */
630 retval = find_retval (return_bb);
631 if (!retval)
633 /* If there is a return_bb with no return value in function returning
634 value by reference, also make the split part return void, otherwise
635 we expansion would try to create a non-POD temporary, which is
636 invalid. */
637 if (return_bb != EXIT_BLOCK_PTR_FOR_FN (cfun)
638 && DECL_RESULT (current_function_decl)
639 && DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
640 current->split_part_set_retval = false;
641 else
642 current->split_part_set_retval = true;
644 else if (is_gimple_min_invariant (retval))
645 current->split_part_set_retval = false;
646 /* Special case is value returned by reference we record as if it was non-ssa
647 set to result_decl. */
648 else if (TREE_CODE (retval) == SSA_NAME
649 && SSA_NAME_VAR (retval)
650 && TREE_CODE (SSA_NAME_VAR (retval)) == RESULT_DECL
651 && DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
652 current->split_part_set_retval
653 = bitmap_bit_p (non_ssa_vars, DECL_UID (SSA_NAME_VAR (retval)));
654 else if (TREE_CODE (retval) == SSA_NAME)
655 current->split_part_set_retval
656 = split_part_set_ssa_name_p (retval, current, return_bb);
657 else if (TREE_CODE (retval) == PARM_DECL)
658 current->split_part_set_retval = false;
659 else if (VAR_P (retval)
660 || TREE_CODE (retval) == RESULT_DECL)
661 current->split_part_set_retval
662 = bitmap_bit_p (non_ssa_vars, DECL_UID (retval));
663 else
664 current->split_part_set_retval = true;
666 /* See if retbnd used by return bb is computed by header or split part. */
667 retbnd = find_retbnd (return_bb);
668 if (retbnd)
670 bool split_part_set_retbnd
671 = split_part_set_ssa_name_p (retbnd, current, return_bb);
673 /* If we have both return value and bounds then keep their definitions
674 in a single function. We use SSA names to link returned bounds and
675 value and therefore do not handle cases when result is passed by
676 reference (which should not be our case anyway since bounds are
677 returned for pointers only). */
678 if ((DECL_BY_REFERENCE (DECL_RESULT (current_function_decl))
679 && current->split_part_set_retval)
680 || split_part_set_retbnd != current->split_part_set_retval)
682 if (dump_file && (dump_flags & TDF_DETAILS))
683 fprintf (dump_file,
684 " Refused: split point splits return value and bounds\n");
685 return;
689 /* split_function fixes up at most one PHI non-virtual PHI node in return_bb,
690 for the return value. If there are other PHIs, give up. */
691 if (return_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
693 gphi_iterator psi;
695 for (psi = gsi_start_phis (return_bb); !gsi_end_p (psi); gsi_next (&psi))
696 if (!virtual_operand_p (gimple_phi_result (psi.phi ()))
697 && !(retval
698 && current->split_part_set_retval
699 && TREE_CODE (retval) == SSA_NAME
700 && !DECL_BY_REFERENCE (DECL_RESULT (current_function_decl))
701 && SSA_NAME_DEF_STMT (retval) == psi.phi ()))
703 if (dump_file && (dump_flags & TDF_DETAILS))
704 fprintf (dump_file,
705 " Refused: return bb has extra PHIs\n");
706 return;
710 if (dump_file && (dump_flags & TDF_DETAILS))
711 fprintf (dump_file, " Accepted!\n");
713 /* At the moment chose split point with lowest frequency and that leaves
714 out smallest size of header.
715 In future we might re-consider this heuristics. */
716 if (!best_split_point.split_bbs
717 || best_split_point.entry_bb->frequency > current->entry_bb->frequency
718 || (best_split_point.entry_bb->frequency == current->entry_bb->frequency
719 && best_split_point.split_size < current->split_size))
722 if (dump_file && (dump_flags & TDF_DETAILS))
723 fprintf (dump_file, " New best split point!\n");
724 if (best_split_point.ssa_names_to_pass)
726 BITMAP_FREE (best_split_point.ssa_names_to_pass);
727 BITMAP_FREE (best_split_point.split_bbs);
729 best_split_point = *current;
730 best_split_point.ssa_names_to_pass = BITMAP_ALLOC (NULL);
731 bitmap_copy (best_split_point.ssa_names_to_pass,
732 current->ssa_names_to_pass);
733 best_split_point.split_bbs = BITMAP_ALLOC (NULL);
734 bitmap_copy (best_split_point.split_bbs, current->split_bbs);
738 /* Return basic block containing RETURN statement. We allow basic blocks
739 of the form:
740 <retval> = tmp_var;
741 return <retval>
742 but return_bb can not be more complex than this (except for
743 -fsanitize=thread we allow TSAN_FUNC_EXIT () internal call in there).
744 If nothing is found, return the exit block.
746 When there are multiple RETURN statement, chose one with return value,
747 since that one is more likely shared by multiple code paths.
749 Return BB is special, because for function splitting it is the only
750 basic block that is duplicated in between header and split part of the
751 function.
753 TODO: We might support multiple return blocks. */
755 static basic_block
756 find_return_bb (void)
758 edge e;
759 basic_block return_bb = EXIT_BLOCK_PTR_FOR_FN (cfun);
760 gimple_stmt_iterator bsi;
761 bool found_return = false;
762 tree retval = NULL_TREE;
764 if (!single_pred_p (EXIT_BLOCK_PTR_FOR_FN (cfun)))
765 return return_bb;
767 e = single_pred_edge (EXIT_BLOCK_PTR_FOR_FN (cfun));
768 for (bsi = gsi_last_bb (e->src); !gsi_end_p (bsi); gsi_prev (&bsi))
770 gimple *stmt = gsi_stmt (bsi);
771 if (gimple_code (stmt) == GIMPLE_LABEL
772 || is_gimple_debug (stmt)
773 || gimple_clobber_p (stmt))
775 else if (gimple_code (stmt) == GIMPLE_ASSIGN
776 && found_return
777 && gimple_assign_single_p (stmt)
778 && (auto_var_in_fn_p (gimple_assign_rhs1 (stmt),
779 current_function_decl)
780 || is_gimple_min_invariant (gimple_assign_rhs1 (stmt)))
781 && retval == gimple_assign_lhs (stmt))
783 else if (greturn *return_stmt = dyn_cast <greturn *> (stmt))
785 found_return = true;
786 retval = gimple_return_retval (return_stmt);
788 /* For -fsanitize=thread, allow also TSAN_FUNC_EXIT () in the return
789 bb. */
790 else if ((flag_sanitize & SANITIZE_THREAD)
791 && gimple_call_internal_p (stmt, IFN_TSAN_FUNC_EXIT))
793 else
794 break;
796 if (gsi_end_p (bsi) && found_return)
797 return_bb = e->src;
799 return return_bb;
802 /* Given return basic block RETURN_BB, see where return value is really
803 stored. */
804 static tree
805 find_retval (basic_block return_bb)
807 gimple_stmt_iterator bsi;
808 for (bsi = gsi_start_bb (return_bb); !gsi_end_p (bsi); gsi_next (&bsi))
809 if (greturn *return_stmt = dyn_cast <greturn *> (gsi_stmt (bsi)))
810 return gimple_return_retval (return_stmt);
811 else if (gimple_code (gsi_stmt (bsi)) == GIMPLE_ASSIGN
812 && !gimple_clobber_p (gsi_stmt (bsi)))
813 return gimple_assign_rhs1 (gsi_stmt (bsi));
814 return NULL;
817 /* Given return basic block RETURN_BB, see where return bounds are really
818 stored. */
819 static tree
820 find_retbnd (basic_block return_bb)
822 gimple_stmt_iterator bsi;
823 for (bsi = gsi_last_bb (return_bb); !gsi_end_p (bsi); gsi_prev (&bsi))
824 if (gimple_code (gsi_stmt (bsi)) == GIMPLE_RETURN)
825 return gimple_return_retbnd (gsi_stmt (bsi));
826 return NULL;
829 /* Callback for walk_stmt_load_store_addr_ops. If T is non-SSA automatic
830 variable, mark it as used in bitmap passed via DATA.
831 Return true when access to T prevents splitting the function. */
833 static bool
834 mark_nonssa_use (gimple *, tree t, tree, void *data)
836 t = get_base_address (t);
838 if (!t || is_gimple_reg (t))
839 return false;
841 /* At present we can't pass non-SSA arguments to split function.
842 FIXME: this can be relaxed by passing references to arguments. */
843 if (TREE_CODE (t) == PARM_DECL)
845 if (dump_file && (dump_flags & TDF_DETAILS))
846 fprintf (dump_file,
847 "Cannot split: use of non-ssa function parameter.\n");
848 return true;
851 if ((VAR_P (t) && auto_var_in_fn_p (t, current_function_decl))
852 || TREE_CODE (t) == RESULT_DECL
853 || (TREE_CODE (t) == LABEL_DECL && FORCED_LABEL (t)))
854 bitmap_set_bit ((bitmap)data, DECL_UID (t));
856 /* For DECL_BY_REFERENCE, the return value is actually a pointer. We want
857 to pretend that the value pointed to is actual result decl. */
858 if ((TREE_CODE (t) == MEM_REF || INDIRECT_REF_P (t))
859 && TREE_CODE (TREE_OPERAND (t, 0)) == SSA_NAME
860 && SSA_NAME_VAR (TREE_OPERAND (t, 0))
861 && TREE_CODE (SSA_NAME_VAR (TREE_OPERAND (t, 0))) == RESULT_DECL
862 && DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
863 return
864 bitmap_bit_p ((bitmap)data,
865 DECL_UID (DECL_RESULT (current_function_decl)));
867 return false;
870 /* Compute local properties of basic block BB we collect when looking for
871 split points. We look for ssa defs and store them in SET_SSA_NAMES,
872 for ssa uses and store them in USED_SSA_NAMES and for any non-SSA automatic
873 vars stored in NON_SSA_VARS.
875 When BB has edge to RETURN_BB, collect uses in RETURN_BB too.
877 Return false when BB contains something that prevents it from being put into
878 split function. */
880 static bool
881 visit_bb (basic_block bb, basic_block return_bb,
882 bitmap set_ssa_names, bitmap used_ssa_names,
883 bitmap non_ssa_vars)
885 edge e;
886 edge_iterator ei;
887 bool can_split = true;
889 for (gimple_stmt_iterator bsi = gsi_start_bb (bb); !gsi_end_p (bsi);
890 gsi_next (&bsi))
892 gimple *stmt = gsi_stmt (bsi);
893 tree op;
894 ssa_op_iter iter;
895 tree decl;
897 if (is_gimple_debug (stmt))
898 continue;
900 if (gimple_clobber_p (stmt))
901 continue;
903 /* FIXME: We can split regions containing EH. We can not however
904 split RESX, EH_DISPATCH and EH_POINTER referring to same region
905 into different partitions. This would require tracking of
906 EH regions and checking in consider_split_point if they
907 are not used elsewhere. */
908 if (gimple_code (stmt) == GIMPLE_RESX)
910 if (dump_file && (dump_flags & TDF_DETAILS))
911 fprintf (dump_file, "Cannot split: resx.\n");
912 can_split = false;
914 if (gimple_code (stmt) == GIMPLE_EH_DISPATCH)
916 if (dump_file && (dump_flags & TDF_DETAILS))
917 fprintf (dump_file, "Cannot split: eh dispatch.\n");
918 can_split = false;
921 /* Check builtins that prevent splitting. */
922 if (gimple_code (stmt) == GIMPLE_CALL
923 && (decl = gimple_call_fndecl (stmt)) != NULL_TREE
924 && DECL_BUILT_IN (decl)
925 && DECL_BUILT_IN_CLASS (decl) == BUILT_IN_NORMAL)
926 switch (DECL_FUNCTION_CODE (decl))
928 /* FIXME: once we will allow passing non-parm values to split part,
929 we need to be sure to handle correct builtin_stack_save and
930 builtin_stack_restore. At the moment we are safe; there is no
931 way to store builtin_stack_save result in non-SSA variable
932 since all calls to those are compiler generated. */
933 case BUILT_IN_APPLY:
934 case BUILT_IN_APPLY_ARGS:
935 case BUILT_IN_VA_START:
936 if (dump_file && (dump_flags & TDF_DETAILS))
937 fprintf (dump_file,
938 "Cannot split: builtin_apply and va_start.\n");
939 can_split = false;
940 break;
941 case BUILT_IN_EH_POINTER:
942 if (dump_file && (dump_flags & TDF_DETAILS))
943 fprintf (dump_file, "Cannot split: builtin_eh_pointer.\n");
944 can_split = false;
945 break;
946 default:
947 break;
950 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_DEF)
951 bitmap_set_bit (set_ssa_names, SSA_NAME_VERSION (op));
952 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_USE)
953 bitmap_set_bit (used_ssa_names, SSA_NAME_VERSION (op));
954 can_split &= !walk_stmt_load_store_addr_ops (stmt, non_ssa_vars,
955 mark_nonssa_use,
956 mark_nonssa_use,
957 mark_nonssa_use);
959 for (gphi_iterator bsi = gsi_start_phis (bb); !gsi_end_p (bsi);
960 gsi_next (&bsi))
962 gphi *stmt = bsi.phi ();
963 unsigned int i;
965 if (virtual_operand_p (gimple_phi_result (stmt)))
966 continue;
967 bitmap_set_bit (set_ssa_names,
968 SSA_NAME_VERSION (gimple_phi_result (stmt)));
969 for (i = 0; i < gimple_phi_num_args (stmt); i++)
971 tree op = gimple_phi_arg_def (stmt, i);
972 if (TREE_CODE (op) == SSA_NAME)
973 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 /* Record also uses coming from PHI operand in return BB. */
981 FOR_EACH_EDGE (e, ei, bb->succs)
982 if (e->dest == return_bb)
984 for (gphi_iterator bsi = gsi_start_phis (return_bb);
985 !gsi_end_p (bsi);
986 gsi_next (&bsi))
988 gphi *stmt = bsi.phi ();
989 tree op = gimple_phi_arg_def (stmt, e->dest_idx);
991 if (virtual_operand_p (gimple_phi_result (stmt)))
992 continue;
993 if (TREE_CODE (op) == SSA_NAME)
994 bitmap_set_bit (used_ssa_names, SSA_NAME_VERSION (op));
995 else
996 can_split &= !mark_nonssa_use (stmt, op, op, non_ssa_vars);
999 return can_split;
1002 /* Stack entry for recursive DFS walk in find_split_point. */
1004 struct stack_entry
1006 /* Basic block we are examining. */
1007 basic_block bb;
1009 /* SSA names set and used by the BB and all BBs reachable
1010 from it via DFS walk. */
1011 bitmap set_ssa_names, used_ssa_names;
1012 bitmap non_ssa_vars;
1014 /* All BBS visited from this BB via DFS walk. */
1015 bitmap bbs_visited;
1017 /* Last examined edge in DFS walk. Since we walk unoriented graph,
1018 the value is up to sum of incoming and outgoing edges of BB. */
1019 unsigned int edge_num;
1021 /* Stack entry index of earliest BB reachable from current BB
1022 or any BB visited later in DFS walk. */
1023 int earliest;
1025 /* Overall time and size of all BBs reached from this BB in DFS walk. */
1026 int overall_time, overall_size;
1028 /* When false we can not split on this BB. */
1029 bool can_split;
1033 /* Find all articulations and call consider_split on them.
1034 OVERALL_TIME and OVERALL_SIZE is time and size of the function.
1036 We perform basic algorithm for finding an articulation in a graph
1037 created from CFG by considering it to be an unoriented graph.
1039 The articulation is discovered via DFS walk. We collect earliest
1040 basic block on stack that is reachable via backward edge. Articulation
1041 is any basic block such that there is no backward edge bypassing it.
1042 To reduce stack usage we maintain heap allocated stack in STACK vector.
1043 AUX pointer of BB is set to index it appears in the stack or -1 once
1044 it is visited and popped off the stack.
1046 The algorithm finds articulation after visiting the whole component
1047 reachable by it. This makes it convenient to collect information about
1048 the component used by consider_split. */
1050 static void
1051 find_split_points (basic_block return_bb, int overall_time, int overall_size)
1053 stack_entry first;
1054 vec<stack_entry> stack = vNULL;
1055 basic_block bb;
1056 struct split_point current;
1058 current.header_time = overall_time;
1059 current.header_size = overall_size;
1060 current.split_time = 0;
1061 current.split_size = 0;
1062 current.ssa_names_to_pass = BITMAP_ALLOC (NULL);
1064 first.bb = ENTRY_BLOCK_PTR_FOR_FN (cfun);
1065 first.edge_num = 0;
1066 first.overall_time = 0;
1067 first.overall_size = 0;
1068 first.earliest = INT_MAX;
1069 first.set_ssa_names = 0;
1070 first.used_ssa_names = 0;
1071 first.non_ssa_vars = 0;
1072 first.bbs_visited = 0;
1073 first.can_split = false;
1074 stack.safe_push (first);
1075 ENTRY_BLOCK_PTR_FOR_FN (cfun)->aux = (void *)(intptr_t)-1;
1077 while (!stack.is_empty ())
1079 stack_entry *entry = &stack.last ();
1081 /* We are walking an acyclic graph, so edge_num counts
1082 succ and pred edges together. However when considering
1083 articulation, we want to have processed everything reachable
1084 from articulation but nothing that reaches into it. */
1085 if (entry->edge_num == EDGE_COUNT (entry->bb->succs)
1086 && entry->bb != ENTRY_BLOCK_PTR_FOR_FN (cfun))
1088 int pos = stack.length ();
1089 entry->can_split &= visit_bb (entry->bb, return_bb,
1090 entry->set_ssa_names,
1091 entry->used_ssa_names,
1092 entry->non_ssa_vars);
1093 if (pos <= entry->earliest && !entry->can_split
1094 && dump_file && (dump_flags & TDF_DETAILS))
1095 fprintf (dump_file,
1096 "found articulation at bb %i but can not split\n",
1097 entry->bb->index);
1098 if (pos <= entry->earliest && entry->can_split)
1100 if (dump_file && (dump_flags & TDF_DETAILS))
1101 fprintf (dump_file, "found articulation at bb %i\n",
1102 entry->bb->index);
1103 current.entry_bb = entry->bb;
1104 current.ssa_names_to_pass = BITMAP_ALLOC (NULL);
1105 bitmap_and_compl (current.ssa_names_to_pass,
1106 entry->used_ssa_names, entry->set_ssa_names);
1107 current.header_time = overall_time - entry->overall_time;
1108 current.header_size = overall_size - entry->overall_size;
1109 current.split_time = entry->overall_time;
1110 current.split_size = entry->overall_size;
1111 current.split_bbs = entry->bbs_visited;
1112 consider_split (&current, entry->non_ssa_vars, return_bb);
1113 BITMAP_FREE (current.ssa_names_to_pass);
1116 /* Do actual DFS walk. */
1117 if (entry->edge_num
1118 < (EDGE_COUNT (entry->bb->succs)
1119 + EDGE_COUNT (entry->bb->preds)))
1121 edge e;
1122 basic_block dest;
1123 if (entry->edge_num < EDGE_COUNT (entry->bb->succs))
1125 e = EDGE_SUCC (entry->bb, entry->edge_num);
1126 dest = e->dest;
1128 else
1130 e = EDGE_PRED (entry->bb, entry->edge_num
1131 - EDGE_COUNT (entry->bb->succs));
1132 dest = e->src;
1135 entry->edge_num++;
1137 /* New BB to visit, push it to the stack. */
1138 if (dest != return_bb && dest != EXIT_BLOCK_PTR_FOR_FN (cfun)
1139 && !dest->aux)
1141 stack_entry new_entry;
1143 new_entry.bb = dest;
1144 new_entry.edge_num = 0;
1145 new_entry.overall_time
1146 = bb_info_vec[dest->index].time;
1147 new_entry.overall_size
1148 = bb_info_vec[dest->index].size;
1149 new_entry.earliest = INT_MAX;
1150 new_entry.set_ssa_names = BITMAP_ALLOC (NULL);
1151 new_entry.used_ssa_names = BITMAP_ALLOC (NULL);
1152 new_entry.bbs_visited = BITMAP_ALLOC (NULL);
1153 new_entry.non_ssa_vars = BITMAP_ALLOC (NULL);
1154 new_entry.can_split = true;
1155 bitmap_set_bit (new_entry.bbs_visited, dest->index);
1156 stack.safe_push (new_entry);
1157 dest->aux = (void *)(intptr_t)stack.length ();
1159 /* Back edge found, record the earliest point. */
1160 else if ((intptr_t)dest->aux > 0
1161 && (intptr_t)dest->aux < entry->earliest)
1162 entry->earliest = (intptr_t)dest->aux;
1164 /* We are done with examining the edges. Pop off the value from stack
1165 and merge stuff we accumulate during the walk. */
1166 else if (entry->bb != ENTRY_BLOCK_PTR_FOR_FN (cfun))
1168 stack_entry *prev = &stack[stack.length () - 2];
1170 entry->bb->aux = (void *)(intptr_t)-1;
1171 prev->can_split &= entry->can_split;
1172 if (prev->set_ssa_names)
1174 bitmap_ior_into (prev->set_ssa_names, entry->set_ssa_names);
1175 bitmap_ior_into (prev->used_ssa_names, entry->used_ssa_names);
1176 bitmap_ior_into (prev->bbs_visited, entry->bbs_visited);
1177 bitmap_ior_into (prev->non_ssa_vars, entry->non_ssa_vars);
1179 if (prev->earliest > entry->earliest)
1180 prev->earliest = entry->earliest;
1181 prev->overall_time += entry->overall_time;
1182 prev->overall_size += entry->overall_size;
1183 BITMAP_FREE (entry->set_ssa_names);
1184 BITMAP_FREE (entry->used_ssa_names);
1185 BITMAP_FREE (entry->bbs_visited);
1186 BITMAP_FREE (entry->non_ssa_vars);
1187 stack.pop ();
1189 else
1190 stack.pop ();
1192 ENTRY_BLOCK_PTR_FOR_FN (cfun)->aux = NULL;
1193 FOR_EACH_BB_FN (bb, cfun)
1194 bb->aux = NULL;
1195 stack.release ();
1196 BITMAP_FREE (current.ssa_names_to_pass);
1199 /* Split function at SPLIT_POINT. */
1201 static void
1202 split_function (basic_block return_bb, struct split_point *split_point,
1203 bool add_tsan_func_exit)
1205 vec<tree> args_to_pass = vNULL;
1206 bitmap args_to_skip;
1207 tree parm;
1208 int num = 0;
1209 cgraph_node *node, *cur_node = cgraph_node::get (current_function_decl);
1210 basic_block call_bb;
1211 gcall *call, *tsan_func_exit_call = NULL;
1212 edge e;
1213 edge_iterator ei;
1214 tree retval = NULL, real_retval = NULL, retbnd = NULL;
1215 bool with_bounds = chkp_function_instrumented_p (current_function_decl);
1216 gimple *last_stmt = NULL;
1217 unsigned int i;
1218 tree arg, ddef;
1220 if (dump_file)
1222 fprintf (dump_file, "\n\nSplitting function at:\n");
1223 dump_split_point (dump_file, split_point);
1226 if (cur_node->local.can_change_signature)
1227 args_to_skip = BITMAP_ALLOC (NULL);
1228 else
1229 args_to_skip = NULL;
1231 /* Collect the parameters of new function and args_to_skip bitmap. */
1232 for (parm = DECL_ARGUMENTS (current_function_decl);
1233 parm; parm = DECL_CHAIN (parm), num++)
1234 if (args_to_skip
1235 && (!is_gimple_reg (parm)
1236 || (ddef = ssa_default_def (cfun, parm)) == NULL_TREE
1237 || !bitmap_bit_p (split_point->ssa_names_to_pass,
1238 SSA_NAME_VERSION (ddef))))
1239 bitmap_set_bit (args_to_skip, num);
1240 else
1242 /* This parm might not have been used up to now, but is going to be
1243 used, hence register it. */
1244 if (is_gimple_reg (parm))
1245 arg = get_or_create_ssa_default_def (cfun, parm);
1246 else
1247 arg = parm;
1249 if (!useless_type_conversion_p (DECL_ARG_TYPE (parm), TREE_TYPE (arg)))
1250 arg = fold_convert (DECL_ARG_TYPE (parm), arg);
1251 args_to_pass.safe_push (arg);
1254 /* See if the split function will return. */
1255 bool split_part_return_p = false;
1256 FOR_EACH_EDGE (e, ei, return_bb->preds)
1258 if (bitmap_bit_p (split_point->split_bbs, e->src->index))
1259 split_part_return_p = true;
1262 /* Add return block to what will become the split function.
1263 We do not return; no return block is needed. */
1264 if (!split_part_return_p)
1266 /* We have no return block, so nothing is needed. */
1267 else if (return_bb == EXIT_BLOCK_PTR_FOR_FN (cfun))
1269 /* When we do not want to return value, we need to construct
1270 new return block with empty return statement.
1271 FIXME: Once we are able to change return type, we should change function
1272 to return void instead of just outputting function with undefined return
1273 value. For structures this affects quality of codegen. */
1274 else if ((retval = find_retval (return_bb))
1275 && !split_point->split_part_set_retval)
1277 bool redirected = true;
1278 basic_block new_return_bb = create_basic_block (NULL, 0, return_bb);
1279 gimple_stmt_iterator gsi = gsi_start_bb (new_return_bb);
1280 gsi_insert_after (&gsi, gimple_build_return (NULL), GSI_NEW_STMT);
1281 new_return_bb->count = profile_count::zero ();
1282 while (redirected)
1284 redirected = false;
1285 FOR_EACH_EDGE (e, ei, return_bb->preds)
1286 if (bitmap_bit_p (split_point->split_bbs, e->src->index))
1288 new_return_bb->count += e->count;
1289 new_return_bb->frequency += EDGE_FREQUENCY (e);
1290 redirect_edge_and_branch (e, new_return_bb);
1291 redirected = true;
1292 break;
1295 e = make_edge (new_return_bb, EXIT_BLOCK_PTR_FOR_FN (cfun), 0);
1296 e->probability = REG_BR_PROB_BASE;
1297 e->count = new_return_bb->count;
1298 add_bb_to_loop (new_return_bb, current_loops->tree_root);
1299 bitmap_set_bit (split_point->split_bbs, new_return_bb->index);
1300 retbnd = find_retbnd (return_bb);
1302 /* When we pass around the value, use existing return block. */
1303 else
1305 bitmap_set_bit (split_point->split_bbs, return_bb->index);
1306 retbnd = find_retbnd (return_bb);
1309 /* If RETURN_BB has virtual operand PHIs, they must be removed and the
1310 virtual operand marked for renaming as we change the CFG in a way that
1311 tree-inline is not able to compensate for.
1313 Note this can happen whether or not we have a return value. If we have
1314 a return value, then RETURN_BB may have PHIs for real operands too. */
1315 if (return_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
1317 bool phi_p = false;
1318 for (gphi_iterator gsi = gsi_start_phis (return_bb);
1319 !gsi_end_p (gsi);)
1321 gphi *stmt = gsi.phi ();
1322 if (!virtual_operand_p (gimple_phi_result (stmt)))
1324 gsi_next (&gsi);
1325 continue;
1327 mark_virtual_phi_result_for_renaming (stmt);
1328 remove_phi_node (&gsi, true);
1329 phi_p = true;
1331 /* In reality we have to rename the reaching definition of the
1332 virtual operand at return_bb as we will eventually release it
1333 when we remove the code region we outlined.
1334 So we have to rename all immediate virtual uses of that region
1335 if we didn't see a PHI definition yet. */
1336 /* ??? In real reality we want to set the reaching vdef of the
1337 entry of the SESE region as the vuse of the call and the reaching
1338 vdef of the exit of the SESE region as the vdef of the call. */
1339 if (!phi_p)
1340 for (gimple_stmt_iterator gsi = gsi_start_bb (return_bb);
1341 !gsi_end_p (gsi);
1342 gsi_next (&gsi))
1344 gimple *stmt = gsi_stmt (gsi);
1345 if (gimple_vuse (stmt))
1347 gimple_set_vuse (stmt, NULL_TREE);
1348 update_stmt (stmt);
1350 if (gimple_vdef (stmt))
1351 break;
1355 /* Now create the actual clone. */
1356 cgraph_edge::rebuild_edges ();
1357 node = cur_node->create_version_clone_with_body
1358 (vNULL, NULL, args_to_skip,
1359 !split_part_return_p || !split_point->split_part_set_retval,
1360 split_point->split_bbs, split_point->entry_bb, "part");
1362 node->split_part = true;
1364 if (cur_node->same_comdat_group)
1366 /* TODO: call is versionable if we make sure that all
1367 callers are inside of a comdat group. */
1368 cur_node->calls_comdat_local = 1;
1369 node->add_to_same_comdat_group (cur_node);
1373 /* Let's take a time profile for splitted function. */
1374 node->tp_first_run = cur_node->tp_first_run + 1;
1376 /* For usual cloning it is enough to clear builtin only when signature
1377 changes. For partial inlining we however can not expect the part
1378 of builtin implementation to have same semantic as the whole. */
1379 if (DECL_BUILT_IN (node->decl))
1381 DECL_BUILT_IN_CLASS (node->decl) = NOT_BUILT_IN;
1382 DECL_FUNCTION_CODE (node->decl) = (enum built_in_function) 0;
1385 /* If return_bb contains any clobbers that refer to SSA_NAMEs
1386 set in the split part, remove them. Also reset debug stmts that
1387 refer to SSA_NAMEs set in the split part. */
1388 if (return_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
1390 gimple_stmt_iterator gsi = gsi_start_bb (return_bb);
1391 while (!gsi_end_p (gsi))
1393 tree op;
1394 ssa_op_iter iter;
1395 gimple *stmt = gsi_stmt (gsi);
1396 bool remove = false;
1397 if (gimple_clobber_p (stmt) || is_gimple_debug (stmt))
1398 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_USE)
1400 basic_block bb = gimple_bb (SSA_NAME_DEF_STMT (op));
1401 if (op != retval
1402 && bb
1403 && bb != return_bb
1404 && bitmap_bit_p (split_point->split_bbs, bb->index))
1406 if (is_gimple_debug (stmt))
1408 gimple_debug_bind_reset_value (stmt);
1409 update_stmt (stmt);
1411 else
1412 remove = true;
1413 break;
1416 if (remove)
1417 gsi_remove (&gsi, true);
1418 else
1419 gsi_next (&gsi);
1423 /* If the original function is instrumented then it's
1424 part is also instrumented. */
1425 if (with_bounds)
1426 chkp_function_mark_instrumented (node->decl);
1428 /* If the original function is declared inline, there is no point in issuing
1429 a warning for the non-inlinable part. */
1430 DECL_NO_INLINE_WARNING_P (node->decl) = 1;
1431 cur_node->remove_callees ();
1432 cur_node->remove_all_references ();
1433 if (!split_part_return_p)
1434 TREE_THIS_VOLATILE (node->decl) = 1;
1435 if (dump_file)
1436 dump_function_to_file (node->decl, dump_file, dump_flags);
1438 /* Create the basic block we place call into. It is the entry basic block
1439 split after last label. */
1440 call_bb = split_point->entry_bb;
1441 for (gimple_stmt_iterator gsi = gsi_start_bb (call_bb); !gsi_end_p (gsi);)
1442 if (gimple_code (gsi_stmt (gsi)) == GIMPLE_LABEL)
1444 last_stmt = gsi_stmt (gsi);
1445 gsi_next (&gsi);
1447 else
1448 break;
1449 e = split_block (split_point->entry_bb, last_stmt);
1450 remove_edge (e);
1452 /* Produce the call statement. */
1453 gimple_stmt_iterator gsi = gsi_last_bb (call_bb);
1454 FOR_EACH_VEC_ELT (args_to_pass, i, arg)
1455 if (!is_gimple_val (arg))
1457 arg = force_gimple_operand_gsi (&gsi, arg, true, NULL_TREE,
1458 false, GSI_CONTINUE_LINKING);
1459 args_to_pass[i] = arg;
1461 call = gimple_build_call_vec (node->decl, args_to_pass);
1462 gimple_call_set_with_bounds (call, with_bounds);
1463 gimple_set_block (call, DECL_INITIAL (current_function_decl));
1464 args_to_pass.release ();
1466 /* For optimized away parameters, add on the caller side
1467 before the call
1468 DEBUG D#X => parm_Y(D)
1469 stmts and associate D#X with parm in decl_debug_args_lookup
1470 vector to say for debug info that if parameter parm had been passed,
1471 it would have value parm_Y(D). */
1472 if (args_to_skip)
1474 vec<tree, va_gc> **debug_args = NULL;
1475 unsigned i = 0, len = 0;
1476 if (MAY_HAVE_DEBUG_STMTS)
1478 debug_args = decl_debug_args_lookup (node->decl);
1479 if (debug_args)
1480 len = vec_safe_length (*debug_args);
1482 for (parm = DECL_ARGUMENTS (current_function_decl), num = 0;
1483 parm; parm = DECL_CHAIN (parm), num++)
1484 if (bitmap_bit_p (args_to_skip, num) && is_gimple_reg (parm))
1486 tree ddecl;
1487 gimple *def_temp;
1489 /* This needs to be done even without MAY_HAVE_DEBUG_STMTS,
1490 otherwise if it didn't exist before, we'd end up with
1491 different SSA_NAME_VERSIONs between -g and -g0. */
1492 arg = get_or_create_ssa_default_def (cfun, parm);
1493 if (!MAY_HAVE_DEBUG_STMTS || debug_args == NULL)
1494 continue;
1496 while (i < len && (**debug_args)[i] != DECL_ORIGIN (parm))
1497 i += 2;
1498 if (i >= len)
1499 continue;
1500 ddecl = (**debug_args)[i + 1];
1501 def_temp
1502 = gimple_build_debug_bind (ddecl, unshare_expr (arg), call);
1503 gsi_insert_after (&gsi, def_temp, GSI_NEW_STMT);
1507 /* We avoid address being taken on any variable used by split part,
1508 so return slot optimization is always possible. Moreover this is
1509 required to make DECL_BY_REFERENCE work. */
1510 if (aggregate_value_p (DECL_RESULT (current_function_decl),
1511 TREE_TYPE (current_function_decl))
1512 && (!is_gimple_reg_type (TREE_TYPE (DECL_RESULT (current_function_decl)))
1513 || DECL_BY_REFERENCE (DECL_RESULT (current_function_decl))))
1514 gimple_call_set_return_slot_opt (call, true);
1516 if (add_tsan_func_exit)
1517 tsan_func_exit_call = gimple_build_call_internal (IFN_TSAN_FUNC_EXIT, 0);
1519 /* Update return value. This is bit tricky. When we do not return,
1520 do nothing. When we return we might need to update return_bb
1521 or produce a new return statement. */
1522 if (!split_part_return_p)
1524 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1525 if (tsan_func_exit_call)
1526 gsi_insert_after (&gsi, tsan_func_exit_call, GSI_NEW_STMT);
1528 else
1530 e = make_edge (call_bb, return_bb,
1531 return_bb == EXIT_BLOCK_PTR_FOR_FN (cfun)
1532 ? 0 : EDGE_FALLTHRU);
1533 e->count = call_bb->count;
1534 e->probability = REG_BR_PROB_BASE;
1536 /* If there is return basic block, see what value we need to store
1537 return value into and put call just before it. */
1538 if (return_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
1540 real_retval = retval;
1541 if (real_retval && split_point->split_part_set_retval)
1543 gphi_iterator psi;
1545 /* See if we need new SSA_NAME for the result.
1546 When DECL_BY_REFERENCE is true, retval is actually pointer to
1547 return value and it is constant in whole function. */
1548 if (TREE_CODE (retval) == SSA_NAME
1549 && !DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
1551 retval = copy_ssa_name (retval, call);
1553 /* See if there is PHI defining return value. */
1554 for (psi = gsi_start_phis (return_bb);
1555 !gsi_end_p (psi); gsi_next (&psi))
1556 if (!virtual_operand_p (gimple_phi_result (psi.phi ())))
1557 break;
1559 /* When there is PHI, just update its value. */
1560 if (TREE_CODE (retval) == SSA_NAME
1561 && !gsi_end_p (psi))
1562 add_phi_arg (psi.phi (), retval, e, UNKNOWN_LOCATION);
1563 /* Otherwise update the return BB itself.
1564 find_return_bb allows at most one assignment to return value,
1565 so update first statement. */
1566 else
1568 gimple_stmt_iterator bsi;
1569 for (bsi = gsi_start_bb (return_bb); !gsi_end_p (bsi);
1570 gsi_next (&bsi))
1571 if (greturn *return_stmt
1572 = dyn_cast <greturn *> (gsi_stmt (bsi)))
1574 gimple_return_set_retval (return_stmt, retval);
1575 break;
1577 else if (gimple_code (gsi_stmt (bsi)) == GIMPLE_ASSIGN
1578 && !gimple_clobber_p (gsi_stmt (bsi)))
1580 gimple_assign_set_rhs1 (gsi_stmt (bsi), retval);
1581 break;
1583 update_stmt (gsi_stmt (bsi));
1584 /* Also adjust clobbers and debug stmts in return_bb. */
1585 for (bsi = gsi_start_bb (return_bb); !gsi_end_p (bsi);
1586 gsi_next (&bsi))
1588 gimple *stmt = gsi_stmt (bsi);
1589 if (gimple_clobber_p (stmt)
1590 || is_gimple_debug (stmt))
1592 ssa_op_iter iter;
1593 use_operand_p use_p;
1594 bool update = false;
1595 FOR_EACH_SSA_USE_OPERAND (use_p, stmt, iter,
1596 SSA_OP_USE)
1597 if (USE_FROM_PTR (use_p) == real_retval)
1599 SET_USE (use_p, retval);
1600 update = true;
1602 if (update)
1603 update_stmt (stmt);
1608 /* Replace retbnd with new one. */
1609 if (retbnd)
1611 gimple_stmt_iterator bsi;
1612 for (bsi = gsi_last_bb (return_bb); !gsi_end_p (bsi);
1613 gsi_prev (&bsi))
1614 if (gimple_code (gsi_stmt (bsi)) == GIMPLE_RETURN)
1616 retbnd = copy_ssa_name (retbnd, call);
1617 gimple_return_set_retbnd (gsi_stmt (bsi), retbnd);
1618 update_stmt (gsi_stmt (bsi));
1619 break;
1623 if (DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
1625 gimple_call_set_lhs (call, build_simple_mem_ref (retval));
1626 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1628 else
1630 tree restype;
1631 restype = TREE_TYPE (DECL_RESULT (current_function_decl));
1632 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1633 if (!useless_type_conversion_p (TREE_TYPE (retval), restype))
1635 gimple *cpy;
1636 tree tem = create_tmp_reg (restype);
1637 tem = make_ssa_name (tem, call);
1638 cpy = gimple_build_assign (retval, NOP_EXPR, tem);
1639 gsi_insert_after (&gsi, cpy, GSI_NEW_STMT);
1640 retval = tem;
1642 /* Build bndret call to obtain returned bounds. */
1643 if (retbnd)
1644 chkp_insert_retbnd_call (retbnd, retval, &gsi);
1645 gimple_call_set_lhs (call, retval);
1646 update_stmt (call);
1649 else
1650 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1651 if (tsan_func_exit_call)
1652 gsi_insert_after (&gsi, tsan_func_exit_call, GSI_NEW_STMT);
1654 /* We don't use return block (there is either no return in function or
1655 multiple of them). So create new basic block with return statement.
1657 else
1659 greturn *ret;
1660 if (split_point->split_part_set_retval
1661 && !VOID_TYPE_P (TREE_TYPE (TREE_TYPE (current_function_decl))))
1663 retval = DECL_RESULT (current_function_decl);
1665 if (chkp_function_instrumented_p (current_function_decl)
1666 && BOUNDED_P (retval))
1667 retbnd = create_tmp_reg (pointer_bounds_type_node);
1669 /* We use temporary register to hold value when aggregate_value_p
1670 is false. Similarly for DECL_BY_REFERENCE we must avoid extra
1671 copy. */
1672 if (!aggregate_value_p (retval, TREE_TYPE (current_function_decl))
1673 && !DECL_BY_REFERENCE (retval))
1674 retval = create_tmp_reg (TREE_TYPE (retval));
1675 if (is_gimple_reg (retval))
1677 /* When returning by reference, there is only one SSA name
1678 assigned to RESULT_DECL (that is pointer to return value).
1679 Look it up or create new one if it is missing. */
1680 if (DECL_BY_REFERENCE (retval))
1681 retval = get_or_create_ssa_default_def (cfun, retval);
1682 /* Otherwise produce new SSA name for return value. */
1683 else
1684 retval = make_ssa_name (retval, call);
1686 if (DECL_BY_REFERENCE (DECL_RESULT (current_function_decl)))
1687 gimple_call_set_lhs (call, build_simple_mem_ref (retval));
1688 else
1689 gimple_call_set_lhs (call, retval);
1690 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1692 else
1694 gsi_insert_after (&gsi, call, GSI_NEW_STMT);
1695 if (retval
1696 && is_gimple_reg_type (TREE_TYPE (retval))
1697 && !is_gimple_val (retval))
1699 gassign *g
1700 = gimple_build_assign (make_ssa_name (TREE_TYPE (retval)),
1701 retval);
1702 retval = gimple_assign_lhs (g);
1703 gsi_insert_after (&gsi, g, GSI_NEW_STMT);
1706 /* Build bndret call to obtain returned bounds. */
1707 if (retbnd)
1708 chkp_insert_retbnd_call (retbnd, retval, &gsi);
1709 if (tsan_func_exit_call)
1710 gsi_insert_after (&gsi, tsan_func_exit_call, GSI_NEW_STMT);
1711 ret = gimple_build_return (retval);
1712 gsi_insert_after (&gsi, ret, GSI_NEW_STMT);
1715 free_dominance_info (CDI_DOMINATORS);
1716 free_dominance_info (CDI_POST_DOMINATORS);
1717 compute_fn_summary (node, true);
1720 /* Execute function splitting pass. */
1722 static unsigned int
1723 execute_split_functions (void)
1725 gimple_stmt_iterator bsi;
1726 basic_block bb;
1727 int overall_time = 0, overall_size = 0;
1728 int todo = 0;
1729 struct cgraph_node *node = cgraph_node::get (current_function_decl);
1731 if (flags_from_decl_or_type (current_function_decl)
1732 & (ECF_NORETURN|ECF_MALLOC))
1734 if (dump_file)
1735 fprintf (dump_file, "Not splitting: noreturn/malloc function.\n");
1736 return 0;
1738 if (MAIN_NAME_P (DECL_NAME (current_function_decl)))
1740 if (dump_file)
1741 fprintf (dump_file, "Not splitting: main function.\n");
1742 return 0;
1744 /* This can be relaxed; function might become inlinable after splitting
1745 away the uninlinable part. */
1746 if (ipa_fn_summaries
1747 && !ipa_fn_summaries->get (node)->inlinable)
1749 if (dump_file)
1750 fprintf (dump_file, "Not splitting: not inlinable.\n");
1751 return 0;
1753 if (DECL_DISREGARD_INLINE_LIMITS (node->decl))
1755 if (dump_file)
1756 fprintf (dump_file, "Not splitting: disregarding inline limits.\n");
1757 return 0;
1759 /* This can be relaxed; most of versioning tests actually prevents
1760 a duplication. */
1761 if (!tree_versionable_function_p (current_function_decl))
1763 if (dump_file)
1764 fprintf (dump_file, "Not splitting: not versionable.\n");
1765 return 0;
1767 /* FIXME: we could support this. */
1768 if (DECL_STRUCT_FUNCTION (current_function_decl)->static_chain_decl)
1770 if (dump_file)
1771 fprintf (dump_file, "Not splitting: nested function.\n");
1772 return 0;
1775 /* See if it makes sense to try to split.
1776 It makes sense to split if we inline, that is if we have direct calls to
1777 handle or direct calls are possibly going to appear as result of indirect
1778 inlining or LTO. Also handle -fprofile-generate as LTO to allow non-LTO
1779 training for LTO -fprofile-use build.
1781 Note that we are not completely conservative about disqualifying functions
1782 called once. It is possible that the caller is called more then once and
1783 then inlining would still benefit. */
1784 if ((!node->callers
1785 /* Local functions called once will be completely inlined most of time. */
1786 || (!node->callers->next_caller && node->local.local))
1787 && !node->address_taken
1788 && !node->has_aliases_p ()
1789 && (!flag_lto || !node->externally_visible))
1791 if (dump_file)
1792 fprintf (dump_file, "Not splitting: not called directly "
1793 "or called once.\n");
1794 return 0;
1797 /* FIXME: We can actually split if splitting reduces call overhead. */
1798 if (!flag_inline_small_functions
1799 && !DECL_DECLARED_INLINE_P (current_function_decl))
1801 if (dump_file)
1802 fprintf (dump_file, "Not splitting: not autoinlining and function"
1803 " is not inline.\n");
1804 return 0;
1807 /* We enforce splitting after loop headers when profile info is not
1808 available. */
1809 if (profile_status_for_fn (cfun) != PROFILE_READ)
1810 mark_dfs_back_edges ();
1812 /* Initialize bitmap to track forbidden calls. */
1813 forbidden_dominators = BITMAP_ALLOC (NULL);
1814 calculate_dominance_info (CDI_DOMINATORS);
1816 /* Compute local info about basic blocks and determine function size/time. */
1817 bb_info_vec.safe_grow_cleared (last_basic_block_for_fn (cfun) + 1);
1818 memset (&best_split_point, 0, sizeof (best_split_point));
1819 basic_block return_bb = find_return_bb ();
1820 int tsan_exit_found = -1;
1821 FOR_EACH_BB_FN (bb, cfun)
1823 int time = 0;
1824 int size = 0;
1825 int freq = compute_call_stmt_bb_frequency (current_function_decl, bb);
1827 if (dump_file && (dump_flags & TDF_DETAILS))
1828 fprintf (dump_file, "Basic block %i\n", bb->index);
1830 for (bsi = gsi_start_bb (bb); !gsi_end_p (bsi); gsi_next (&bsi))
1832 int this_time, this_size;
1833 gimple *stmt = gsi_stmt (bsi);
1835 this_size = estimate_num_insns (stmt, &eni_size_weights);
1836 this_time = estimate_num_insns (stmt, &eni_time_weights) * freq;
1837 size += this_size;
1838 time += this_time;
1839 check_forbidden_calls (stmt);
1841 if (dump_file && (dump_flags & TDF_DETAILS))
1843 fprintf (dump_file, " freq:%6i size:%3i time:%3i ",
1844 freq, this_size, this_time);
1845 print_gimple_stmt (dump_file, stmt, 0);
1848 if ((flag_sanitize & SANITIZE_THREAD)
1849 && gimple_call_internal_p (stmt, IFN_TSAN_FUNC_EXIT))
1851 /* We handle TSAN_FUNC_EXIT for splitting either in the
1852 return_bb, or in its immediate predecessors. */
1853 if ((bb != return_bb && !find_edge (bb, return_bb))
1854 || (tsan_exit_found != -1
1855 && tsan_exit_found != (bb != return_bb)))
1857 if (dump_file)
1858 fprintf (dump_file, "Not splitting: TSAN_FUNC_EXIT"
1859 " in unexpected basic block.\n");
1860 BITMAP_FREE (forbidden_dominators);
1861 bb_info_vec.release ();
1862 return 0;
1864 tsan_exit_found = bb != return_bb;
1867 overall_time += time;
1868 overall_size += size;
1869 bb_info_vec[bb->index].time = time;
1870 bb_info_vec[bb->index].size = size;
1872 find_split_points (return_bb, overall_time, overall_size);
1873 if (best_split_point.split_bbs)
1875 split_function (return_bb, &best_split_point, tsan_exit_found == 1);
1876 BITMAP_FREE (best_split_point.ssa_names_to_pass);
1877 BITMAP_FREE (best_split_point.split_bbs);
1878 todo = TODO_update_ssa | TODO_cleanup_cfg;
1880 BITMAP_FREE (forbidden_dominators);
1881 bb_info_vec.release ();
1882 return todo;
1885 namespace {
1887 const pass_data pass_data_split_functions =
1889 GIMPLE_PASS, /* type */
1890 "fnsplit", /* name */
1891 OPTGROUP_NONE, /* optinfo_flags */
1892 TV_IPA_FNSPLIT, /* tv_id */
1893 PROP_cfg, /* properties_required */
1894 0, /* properties_provided */
1895 0, /* properties_destroyed */
1896 0, /* todo_flags_start */
1897 0, /* todo_flags_finish */
1900 class pass_split_functions : public gimple_opt_pass
1902 public:
1903 pass_split_functions (gcc::context *ctxt)
1904 : gimple_opt_pass (pass_data_split_functions, ctxt)
1907 /* opt_pass methods: */
1908 virtual bool gate (function *);
1909 virtual unsigned int execute (function *)
1911 return execute_split_functions ();
1914 }; // class pass_split_functions
1916 bool
1917 pass_split_functions::gate (function *)
1919 /* When doing profile feedback, we want to execute the pass after profiling
1920 is read. So disable one in early optimization. */
1921 return (flag_partial_inlining
1922 && !profile_arc_flag && !flag_branch_probabilities);
1925 } // anon namespace
1927 gimple_opt_pass *
1928 make_pass_split_functions (gcc::context *ctxt)
1930 return new pass_split_functions (ctxt);
1933 /* Execute function splitting pass. */
1935 static unsigned int
1936 execute_feedback_split_functions (void)
1938 unsigned int retval = execute_split_functions ();
1939 if (retval)
1940 retval |= TODO_rebuild_cgraph_edges;
1941 return retval;
1944 namespace {
1946 const pass_data pass_data_feedback_split_functions =
1948 GIMPLE_PASS, /* type */
1949 "feedback_fnsplit", /* name */
1950 OPTGROUP_NONE, /* optinfo_flags */
1951 TV_IPA_FNSPLIT, /* tv_id */
1952 PROP_cfg, /* properties_required */
1953 0, /* properties_provided */
1954 0, /* properties_destroyed */
1955 0, /* todo_flags_start */
1956 0, /* todo_flags_finish */
1959 class pass_feedback_split_functions : public gimple_opt_pass
1961 public:
1962 pass_feedback_split_functions (gcc::context *ctxt)
1963 : gimple_opt_pass (pass_data_feedback_split_functions, ctxt)
1966 /* opt_pass methods: */
1967 virtual bool gate (function *);
1968 virtual unsigned int execute (function *)
1970 return execute_feedback_split_functions ();
1973 }; // class pass_feedback_split_functions
1975 bool
1976 pass_feedback_split_functions::gate (function *)
1978 /* We don't need to split when profiling at all, we are producing
1979 lousy code anyway. */
1980 return (flag_partial_inlining
1981 && flag_branch_probabilities);
1984 } // anon namespace
1986 gimple_opt_pass *
1987 make_pass_feedback_split_functions (gcc::context *ctxt)
1989 return new pass_feedback_split_functions (ctxt);