ira.c use DF infrastructure for combine_and_move_insns
[official-gcc.git] / gcc / ipa-pure-const.c
blob7647a58fb26ede457aa54b4bf5a9396da711df3f
1 /* Callgraph based analysis of static variables.
2 Copyright (C) 2004-2016 Free Software Foundation, Inc.
3 Contributed by Kenneth Zadeck <zadeck@naturalbridge.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 /* This file marks functions as being either const (TREE_READONLY) or
22 pure (DECL_PURE_P). It can also set a variant of these that
23 are allowed to loop indefinitely (DECL_LOOPING_CONST_PURE_P).
25 This must be run after inlining decisions have been made since
26 otherwise, the local sets will not contain information that is
27 consistent with post inlined state. The global sets are not prone
28 to this problem since they are by definition transitive. */
30 /* The code in this module is called by the ipa pass manager. It
31 should be one of the later passes since it's information is used by
32 the rest of the compilation. */
34 #include "config.h"
35 #include "system.h"
36 #include "coretypes.h"
37 #include "backend.h"
38 #include "target.h"
39 #include "tree.h"
40 #include "gimple.h"
41 #include "tree-pass.h"
42 #include "tree-streamer.h"
43 #include "cgraph.h"
44 #include "diagnostic.h"
45 #include "calls.h"
46 #include "cfganal.h"
47 #include "tree-eh.h"
48 #include "gimple-iterator.h"
49 #include "gimple-walk.h"
50 #include "tree-cfg.h"
51 #include "tree-ssa-loop-niter.h"
52 #include "langhooks.h"
53 #include "ipa-utils.h"
54 #include "gimple-pretty-print.h"
55 #include "cfgloop.h"
56 #include "tree-scalar-evolution.h"
57 #include "intl.h"
58 #include "opts.h"
60 /* Lattice values for const and pure functions. Everything starts out
61 being const, then may drop to pure and then neither depending on
62 what is found. */
63 enum pure_const_state_e
65 IPA_CONST,
66 IPA_PURE,
67 IPA_NEITHER
70 const char *pure_const_names[3] = {"const", "pure", "neither"};
72 /* Holder for the const_state. There is one of these per function
73 decl. */
74 struct funct_state_d
76 /* See above. */
77 enum pure_const_state_e pure_const_state;
78 /* What user set here; we can be always sure about this. */
79 enum pure_const_state_e state_previously_known;
80 bool looping_previously_known;
82 /* True if the function could possibly infinite loop. There are a
83 lot of ways that this could be determined. We are pretty
84 conservative here. While it is possible to cse pure and const
85 calls, it is not legal to have dce get rid of the call if there
86 is a possibility that the call could infinite loop since this is
87 a behavioral change. */
88 bool looping;
90 bool can_throw;
92 /* If function can call free, munmap or otherwise make previously
93 non-trapping memory accesses trapping. */
94 bool can_free;
97 /* State used when we know nothing about function. */
98 static struct funct_state_d varying_state
99 = { IPA_NEITHER, IPA_NEITHER, true, true, true, true };
102 typedef struct funct_state_d * funct_state;
104 /* The storage of the funct_state is abstracted because there is the
105 possibility that it may be desirable to move this to the cgraph
106 local info. */
108 /* Array, indexed by cgraph node uid, of function states. */
110 static vec<funct_state> funct_state_vec;
112 static bool gate_pure_const (void);
114 namespace {
116 const pass_data pass_data_ipa_pure_const =
118 IPA_PASS, /* type */
119 "pure-const", /* name */
120 OPTGROUP_NONE, /* optinfo_flags */
121 TV_IPA_PURE_CONST, /* tv_id */
122 0, /* properties_required */
123 0, /* properties_provided */
124 0, /* properties_destroyed */
125 0, /* todo_flags_start */
126 0, /* todo_flags_finish */
129 class pass_ipa_pure_const : public ipa_opt_pass_d
131 public:
132 pass_ipa_pure_const(gcc::context *ctxt);
134 /* opt_pass methods: */
135 bool gate (function *) { return gate_pure_const (); }
136 unsigned int execute (function *fun);
138 void register_hooks (void);
140 private:
141 bool init_p;
143 /* Holders of ipa cgraph hooks: */
144 struct cgraph_node_hook_list *function_insertion_hook_holder;
145 struct cgraph_2node_hook_list *node_duplication_hook_holder;
146 struct cgraph_node_hook_list *node_removal_hook_holder;
148 }; // class pass_ipa_pure_const
150 } // anon namespace
152 /* Try to guess if function body will always be visible to compiler
153 when compiling the call and whether compiler will be able
154 to propagate the information by itself. */
156 static bool
157 function_always_visible_to_compiler_p (tree decl)
159 return (!TREE_PUBLIC (decl) || DECL_DECLARED_INLINE_P (decl));
162 /* Emit suggestion about attribute ATTRIB_NAME for DECL. KNOWN_FINITE
163 is true if the function is known to be finite. The diagnostic is
164 controlled by OPTION. WARNED_ABOUT is a hash_set<tree> unique for
165 OPTION, this function may initialize it and it is always returned
166 by the function. */
168 static hash_set<tree> *
169 suggest_attribute (int option, tree decl, bool known_finite,
170 hash_set<tree> *warned_about,
171 const char * attrib_name)
173 if (!option_enabled (option, &global_options))
174 return warned_about;
175 if (TREE_THIS_VOLATILE (decl)
176 || (known_finite && function_always_visible_to_compiler_p (decl)))
177 return warned_about;
179 if (!warned_about)
180 warned_about = new hash_set<tree>;
181 if (warned_about->contains (decl))
182 return warned_about;
183 warned_about->add (decl);
184 warning_at (DECL_SOURCE_LOCATION (decl),
185 option,
186 known_finite
187 ? _("function might be candidate for attribute %<%s%>")
188 : _("function might be candidate for attribute %<%s%>"
189 " if it is known to return normally"), attrib_name);
190 return warned_about;
193 /* Emit suggestion about __attribute_((pure)) for DECL. KNOWN_FINITE
194 is true if the function is known to be finite. */
196 static void
197 warn_function_pure (tree decl, bool known_finite)
199 static hash_set<tree> *warned_about;
201 warned_about
202 = suggest_attribute (OPT_Wsuggest_attribute_pure, decl,
203 known_finite, warned_about, "pure");
206 /* Emit suggestion about __attribute_((const)) for DECL. KNOWN_FINITE
207 is true if the function is known to be finite. */
209 static void
210 warn_function_const (tree decl, bool known_finite)
212 static hash_set<tree> *warned_about;
213 warned_about
214 = suggest_attribute (OPT_Wsuggest_attribute_const, decl,
215 known_finite, warned_about, "const");
218 static void
219 warn_function_noreturn (tree decl)
221 static hash_set<tree> *warned_about;
222 if (!lang_hooks.missing_noreturn_ok_p (decl)
223 && targetm.warn_func_return (decl))
224 warned_about
225 = suggest_attribute (OPT_Wsuggest_attribute_noreturn, decl,
226 true, warned_about, "noreturn");
229 /* Return true if we have a function state for NODE. */
231 static inline bool
232 has_function_state (struct cgraph_node *node)
234 if (!funct_state_vec.exists ()
235 || funct_state_vec.length () <= (unsigned int)node->uid)
236 return false;
237 return funct_state_vec[node->uid] != NULL;
240 /* Return the function state from NODE. */
242 static inline funct_state
243 get_function_state (struct cgraph_node *node)
245 if (!funct_state_vec.exists ()
246 || funct_state_vec.length () <= (unsigned int)node->uid
247 || !funct_state_vec[node->uid])
248 /* We might want to put correct previously_known state into varying. */
249 return &varying_state;
250 return funct_state_vec[node->uid];
253 /* Set the function state S for NODE. */
255 static inline void
256 set_function_state (struct cgraph_node *node, funct_state s)
258 if (!funct_state_vec.exists ()
259 || funct_state_vec.length () <= (unsigned int)node->uid)
260 funct_state_vec.safe_grow_cleared (node->uid + 1);
261 funct_state_vec[node->uid] = s;
264 /* Check to see if the use (or definition when CHECKING_WRITE is true)
265 variable T is legal in a function that is either pure or const. */
267 static inline void
268 check_decl (funct_state local,
269 tree t, bool checking_write, bool ipa)
271 /* Do not want to do anything with volatile except mark any
272 function that uses one to be not const or pure. */
273 if (TREE_THIS_VOLATILE (t))
275 local->pure_const_state = IPA_NEITHER;
276 if (dump_file)
277 fprintf (dump_file, " Volatile operand is not const/pure");
278 return;
281 /* Do not care about a local automatic that is not static. */
282 if (!TREE_STATIC (t) && !DECL_EXTERNAL (t))
283 return;
285 /* If the variable has the "used" attribute, treat it as if it had a
286 been touched by the devil. */
287 if (DECL_PRESERVE_P (t))
289 local->pure_const_state = IPA_NEITHER;
290 if (dump_file)
291 fprintf (dump_file, " Used static/global variable is not const/pure\n");
292 return;
295 /* In IPA mode we are not interested in checking actual loads and stores;
296 they will be processed at propagation time using ipa_ref. */
297 if (ipa)
298 return;
300 /* Since we have dealt with the locals and params cases above, if we
301 are CHECKING_WRITE, this cannot be a pure or constant
302 function. */
303 if (checking_write)
305 local->pure_const_state = IPA_NEITHER;
306 if (dump_file)
307 fprintf (dump_file, " static/global memory write is not const/pure\n");
308 return;
311 if (DECL_EXTERNAL (t) || TREE_PUBLIC (t))
313 /* Readonly reads are safe. */
314 if (TREE_READONLY (t) && !TYPE_NEEDS_CONSTRUCTING (TREE_TYPE (t)))
315 return; /* Read of a constant, do not change the function state. */
316 else
318 if (dump_file)
319 fprintf (dump_file, " global memory read is not const\n");
320 /* Just a regular read. */
321 if (local->pure_const_state == IPA_CONST)
322 local->pure_const_state = IPA_PURE;
325 else
327 /* Compilation level statics can be read if they are readonly
328 variables. */
329 if (TREE_READONLY (t))
330 return;
332 if (dump_file)
333 fprintf (dump_file, " static memory read is not const\n");
334 /* Just a regular read. */
335 if (local->pure_const_state == IPA_CONST)
336 local->pure_const_state = IPA_PURE;
341 /* Check to see if the use (or definition when CHECKING_WRITE is true)
342 variable T is legal in a function that is either pure or const. */
344 static inline void
345 check_op (funct_state local, tree t, bool checking_write)
347 t = get_base_address (t);
348 if (t && TREE_THIS_VOLATILE (t))
350 local->pure_const_state = IPA_NEITHER;
351 if (dump_file)
352 fprintf (dump_file, " Volatile indirect ref is not const/pure\n");
353 return;
355 else if (t
356 && (INDIRECT_REF_P (t) || TREE_CODE (t) == MEM_REF)
357 && TREE_CODE (TREE_OPERAND (t, 0)) == SSA_NAME
358 && !ptr_deref_may_alias_global_p (TREE_OPERAND (t, 0)))
360 if (dump_file)
361 fprintf (dump_file, " Indirect ref to local memory is OK\n");
362 return;
364 else if (checking_write)
366 local->pure_const_state = IPA_NEITHER;
367 if (dump_file)
368 fprintf (dump_file, " Indirect ref write is not const/pure\n");
369 return;
371 else
373 if (dump_file)
374 fprintf (dump_file, " Indirect ref read is not const\n");
375 if (local->pure_const_state == IPA_CONST)
376 local->pure_const_state = IPA_PURE;
380 /* compute state based on ECF FLAGS and store to STATE and LOOPING. */
382 static void
383 state_from_flags (enum pure_const_state_e *state, bool *looping,
384 int flags, bool cannot_lead_to_return)
386 *looping = false;
387 if (flags & ECF_LOOPING_CONST_OR_PURE)
389 *looping = true;
390 if (dump_file && (dump_flags & TDF_DETAILS))
391 fprintf (dump_file, " looping");
393 if (flags & ECF_CONST)
395 *state = IPA_CONST;
396 if (dump_file && (dump_flags & TDF_DETAILS))
397 fprintf (dump_file, " const\n");
399 else if (flags & ECF_PURE)
401 *state = IPA_PURE;
402 if (dump_file && (dump_flags & TDF_DETAILS))
403 fprintf (dump_file, " pure\n");
405 else if (cannot_lead_to_return)
407 *state = IPA_PURE;
408 *looping = true;
409 if (dump_file && (dump_flags & TDF_DETAILS))
410 fprintf (dump_file, " ignoring side effects->pure looping\n");
412 else
414 if (dump_file && (dump_flags & TDF_DETAILS))
415 fprintf (dump_file, " neither\n");
416 *state = IPA_NEITHER;
417 *looping = true;
421 /* Merge STATE and STATE2 and LOOPING and LOOPING2 and store
422 into STATE and LOOPING better of the two variants.
423 Be sure to merge looping correctly. IPA_NEITHER functions
424 have looping 0 even if they don't have to return. */
426 static inline void
427 better_state (enum pure_const_state_e *state, bool *looping,
428 enum pure_const_state_e state2, bool looping2)
430 if (state2 < *state)
432 if (*state == IPA_NEITHER)
433 *looping = looping2;
434 else
435 *looping = MIN (*looping, looping2);
436 *state = state2;
438 else if (state2 != IPA_NEITHER)
439 *looping = MIN (*looping, looping2);
442 /* Merge STATE and STATE2 and LOOPING and LOOPING2 and store
443 into STATE and LOOPING worse of the two variants.
444 N is the actual node called. */
446 static inline void
447 worse_state (enum pure_const_state_e *state, bool *looping,
448 enum pure_const_state_e state2, bool looping2,
449 struct symtab_node *from,
450 struct symtab_node *to)
452 /* Consider function:
454 bool a(int *p)
456 return *p==*p;
459 During early optimization we will turn this into:
461 bool a(int *p)
463 return true;
466 Now if this function will be detected as CONST however when interposed it
467 may end up being just pure. We always must assume the worst scenario here.
469 if (*state == IPA_CONST && state2 == IPA_CONST
470 && to && !TREE_READONLY (to->decl) && !to->binds_to_current_def_p (from))
472 if (dump_file && (dump_flags & TDF_DETAILS))
473 fprintf (dump_file, "Dropping state to PURE because call to %s may not "
474 "bind to current def.\n", to->name ());
475 state2 = IPA_PURE;
477 *state = MAX (*state, state2);
478 *looping = MAX (*looping, looping2);
481 /* Recognize special cases of builtins that are by themselves not pure or const
482 but function using them is. */
483 static bool
484 special_builtin_state (enum pure_const_state_e *state, bool *looping,
485 tree callee)
487 if (DECL_BUILT_IN_CLASS (callee) == BUILT_IN_NORMAL)
488 switch (DECL_FUNCTION_CODE (callee))
490 case BUILT_IN_RETURN:
491 case BUILT_IN_UNREACHABLE:
492 case BUILT_IN_ALLOCA:
493 case BUILT_IN_ALLOCA_WITH_ALIGN:
494 case BUILT_IN_STACK_SAVE:
495 case BUILT_IN_STACK_RESTORE:
496 case BUILT_IN_EH_POINTER:
497 case BUILT_IN_EH_FILTER:
498 case BUILT_IN_UNWIND_RESUME:
499 case BUILT_IN_CXA_END_CLEANUP:
500 case BUILT_IN_EH_COPY_VALUES:
501 case BUILT_IN_FRAME_ADDRESS:
502 case BUILT_IN_APPLY:
503 case BUILT_IN_APPLY_ARGS:
504 *looping = false;
505 *state = IPA_CONST;
506 return true;
507 case BUILT_IN_PREFETCH:
508 *looping = true;
509 *state = IPA_CONST;
510 return true;
511 default:
512 break;
514 return false;
517 /* Check the parameters of a function call to CALL_EXPR to see if
518 there are any references in the parameters that are not allowed for
519 pure or const functions. Also check to see if this is either an
520 indirect call, a call outside the compilation unit, or has special
521 attributes that may also effect the purity. The CALL_EXPR node for
522 the entire call expression. */
524 static void
525 check_call (funct_state local, gcall *call, bool ipa)
527 int flags = gimple_call_flags (call);
528 tree callee_t = gimple_call_fndecl (call);
529 bool possibly_throws = stmt_could_throw_p (call);
530 bool possibly_throws_externally = (possibly_throws
531 && stmt_can_throw_external (call));
533 if (possibly_throws)
535 unsigned int i;
536 for (i = 0; i < gimple_num_ops (call); i++)
537 if (gimple_op (call, i)
538 && tree_could_throw_p (gimple_op (call, i)))
540 if (possibly_throws && cfun->can_throw_non_call_exceptions)
542 if (dump_file)
543 fprintf (dump_file, " operand can throw; looping\n");
544 local->looping = true;
546 if (possibly_throws_externally)
548 if (dump_file)
549 fprintf (dump_file, " operand can throw externally\n");
550 local->can_throw = true;
555 /* The const and pure flags are set by a variety of places in the
556 compiler (including here). If someone has already set the flags
557 for the callee, (such as for some of the builtins) we will use
558 them, otherwise we will compute our own information.
560 Const and pure functions have less clobber effects than other
561 functions so we process these first. Otherwise if it is a call
562 outside the compilation unit or an indirect call we punt. This
563 leaves local calls which will be processed by following the call
564 graph. */
565 if (callee_t)
567 enum pure_const_state_e call_state;
568 bool call_looping;
570 if (gimple_call_builtin_p (call, BUILT_IN_NORMAL)
571 && !nonfreeing_call_p (call))
572 local->can_free = true;
574 if (special_builtin_state (&call_state, &call_looping, callee_t))
576 worse_state (&local->pure_const_state, &local->looping,
577 call_state, call_looping,
578 NULL, NULL);
579 return;
581 /* When bad things happen to bad functions, they cannot be const
582 or pure. */
583 if (setjmp_call_p (callee_t))
585 if (dump_file)
586 fprintf (dump_file, " setjmp is not const/pure\n");
587 local->looping = true;
588 local->pure_const_state = IPA_NEITHER;
591 if (DECL_BUILT_IN_CLASS (callee_t) == BUILT_IN_NORMAL)
592 switch (DECL_FUNCTION_CODE (callee_t))
594 case BUILT_IN_LONGJMP:
595 case BUILT_IN_NONLOCAL_GOTO:
596 if (dump_file)
597 fprintf (dump_file, " longjmp and nonlocal goto is not const/pure\n");
598 local->pure_const_state = IPA_NEITHER;
599 local->looping = true;
600 break;
601 default:
602 break;
605 else if (gimple_call_internal_p (call) && !nonfreeing_call_p (call))
606 local->can_free = true;
608 /* When not in IPA mode, we can still handle self recursion. */
609 if (!ipa && callee_t
610 && recursive_call_p (current_function_decl, callee_t))
612 if (dump_file)
613 fprintf (dump_file, " Recursive call can loop.\n");
614 local->looping = true;
616 /* Either callee is unknown or we are doing local analysis.
617 Look to see if there are any bits available for the callee (such as by
618 declaration or because it is builtin) and process solely on the basis of
619 those bits. */
620 else if (!ipa)
622 enum pure_const_state_e call_state;
623 bool call_looping;
624 if (possibly_throws && cfun->can_throw_non_call_exceptions)
626 if (dump_file)
627 fprintf (dump_file, " can throw; looping\n");
628 local->looping = true;
630 if (possibly_throws_externally)
632 if (dump_file)
634 fprintf (dump_file, " can throw externally to lp %i\n",
635 lookup_stmt_eh_lp (call));
636 if (callee_t)
637 fprintf (dump_file, " callee:%s\n",
638 IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (callee_t)));
640 local->can_throw = true;
642 if (dump_file && (dump_flags & TDF_DETAILS))
643 fprintf (dump_file, " checking flags for call:");
644 state_from_flags (&call_state, &call_looping, flags,
645 ((flags & (ECF_NORETURN | ECF_NOTHROW))
646 == (ECF_NORETURN | ECF_NOTHROW))
647 || (!flag_exceptions && (flags & ECF_NORETURN)));
648 worse_state (&local->pure_const_state, &local->looping,
649 call_state, call_looping, NULL, NULL);
651 /* Direct functions calls are handled by IPA propagation. */
654 /* Wrapper around check_decl for loads in local more. */
656 static bool
657 check_load (gimple *, tree op, tree, void *data)
659 if (DECL_P (op))
660 check_decl ((funct_state)data, op, false, false);
661 else
662 check_op ((funct_state)data, op, false);
663 return false;
666 /* Wrapper around check_decl for stores in local more. */
668 static bool
669 check_store (gimple *, tree op, tree, void *data)
671 if (DECL_P (op))
672 check_decl ((funct_state)data, op, true, false);
673 else
674 check_op ((funct_state)data, op, true);
675 return false;
678 /* Wrapper around check_decl for loads in ipa mode. */
680 static bool
681 check_ipa_load (gimple *, tree op, tree, void *data)
683 if (DECL_P (op))
684 check_decl ((funct_state)data, op, false, true);
685 else
686 check_op ((funct_state)data, op, false);
687 return false;
690 /* Wrapper around check_decl for stores in ipa mode. */
692 static bool
693 check_ipa_store (gimple *, tree op, tree, void *data)
695 if (DECL_P (op))
696 check_decl ((funct_state)data, op, true, true);
697 else
698 check_op ((funct_state)data, op, true);
699 return false;
702 /* Look into pointer pointed to by GSIP and figure out what interesting side
703 effects it has. */
704 static void
705 check_stmt (gimple_stmt_iterator *gsip, funct_state local, bool ipa)
707 gimple *stmt = gsi_stmt (*gsip);
709 if (is_gimple_debug (stmt))
710 return;
712 /* Do consider clobber as side effects before IPA, so we rather inline
713 C++ destructors and keep clobber semantics than eliminate them.
715 TODO: We may get smarter during early optimizations on these and let
716 functions containing only clobbers to be optimized more. This is a common
717 case of C++ destructors. */
719 if ((ipa || cfun->after_inlining) && gimple_clobber_p (stmt))
720 return;
722 if (dump_file)
724 fprintf (dump_file, " scanning: ");
725 print_gimple_stmt (dump_file, stmt, 0, 0);
728 if (gimple_has_volatile_ops (stmt)
729 && !gimple_clobber_p (stmt))
731 local->pure_const_state = IPA_NEITHER;
732 if (dump_file)
733 fprintf (dump_file, " Volatile stmt is not const/pure\n");
736 /* Look for loads and stores. */
737 walk_stmt_load_store_ops (stmt, local,
738 ipa ? check_ipa_load : check_load,
739 ipa ? check_ipa_store : check_store);
741 if (gimple_code (stmt) != GIMPLE_CALL
742 && stmt_could_throw_p (stmt))
744 if (cfun->can_throw_non_call_exceptions)
746 if (dump_file)
747 fprintf (dump_file, " can throw; looping\n");
748 local->looping = true;
750 if (stmt_can_throw_external (stmt))
752 if (dump_file)
753 fprintf (dump_file, " can throw externally\n");
754 local->can_throw = true;
756 else
757 if (dump_file)
758 fprintf (dump_file, " can throw\n");
760 switch (gimple_code (stmt))
762 case GIMPLE_CALL:
763 check_call (local, as_a <gcall *> (stmt), ipa);
764 break;
765 case GIMPLE_LABEL:
766 if (DECL_NONLOCAL (gimple_label_label (as_a <glabel *> (stmt))))
767 /* Target of long jump. */
769 if (dump_file)
770 fprintf (dump_file, " nonlocal label is not const/pure\n");
771 local->pure_const_state = IPA_NEITHER;
773 break;
774 case GIMPLE_ASM:
775 if (gimple_asm_clobbers_memory_p (as_a <gasm *> (stmt)))
777 if (dump_file)
778 fprintf (dump_file, " memory asm clobber is not const/pure\n");
779 /* Abandon all hope, ye who enter here. */
780 local->pure_const_state = IPA_NEITHER;
781 local->can_free = true;
783 if (gimple_asm_volatile_p (as_a <gasm *> (stmt)))
785 if (dump_file)
786 fprintf (dump_file, " volatile is not const/pure\n");
787 /* Abandon all hope, ye who enter here. */
788 local->pure_const_state = IPA_NEITHER;
789 local->looping = true;
790 local->can_free = true;
792 return;
793 default:
794 break;
799 /* This is the main routine for finding the reference patterns for
800 global variables within a function FN. */
802 static funct_state
803 analyze_function (struct cgraph_node *fn, bool ipa)
805 tree decl = fn->decl;
806 funct_state l;
807 basic_block this_block;
809 l = XCNEW (struct funct_state_d);
810 l->pure_const_state = IPA_CONST;
811 l->state_previously_known = IPA_NEITHER;
812 l->looping_previously_known = true;
813 l->looping = false;
814 l->can_throw = false;
815 l->can_free = false;
816 state_from_flags (&l->state_previously_known, &l->looping_previously_known,
817 flags_from_decl_or_type (fn->decl),
818 fn->cannot_return_p ());
820 if (fn->thunk.thunk_p || fn->alias)
822 /* Thunk gets propagated through, so nothing interesting happens. */
823 gcc_assert (ipa);
824 if (fn->thunk.thunk_p && fn->thunk.virtual_offset_p)
825 l->pure_const_state = IPA_NEITHER;
826 return l;
829 if (dump_file)
831 fprintf (dump_file, "\n\n local analysis of %s\n ",
832 fn->name ());
835 push_cfun (DECL_STRUCT_FUNCTION (decl));
837 FOR_EACH_BB_FN (this_block, cfun)
839 gimple_stmt_iterator gsi;
840 struct walk_stmt_info wi;
842 memset (&wi, 0, sizeof (wi));
843 for (gsi = gsi_start_bb (this_block);
844 !gsi_end_p (gsi);
845 gsi_next (&gsi))
847 check_stmt (&gsi, l, ipa);
848 if (l->pure_const_state == IPA_NEITHER
849 && l->looping
850 && l->can_throw
851 && l->can_free)
852 goto end;
856 end:
857 if (l->pure_const_state != IPA_NEITHER)
859 /* Const functions cannot have back edges (an
860 indication of possible infinite loop side
861 effect. */
862 if (mark_dfs_back_edges ())
864 /* Preheaders are needed for SCEV to work.
865 Simple latches and recorded exits improve chances that loop will
866 proved to be finite in testcases such as in loop-15.c
867 and loop-24.c */
868 loop_optimizer_init (LOOPS_HAVE_PREHEADERS
869 | LOOPS_HAVE_SIMPLE_LATCHES
870 | LOOPS_HAVE_RECORDED_EXITS);
871 if (dump_file && (dump_flags & TDF_DETAILS))
872 flow_loops_dump (dump_file, NULL, 0);
873 if (mark_irreducible_loops ())
875 if (dump_file)
876 fprintf (dump_file, " has irreducible loops\n");
877 l->looping = true;
879 else
881 struct loop *loop;
882 scev_initialize ();
883 FOR_EACH_LOOP (loop, 0)
884 if (!finite_loop_p (loop))
886 if (dump_file)
887 fprintf (dump_file, " can not prove finiteness of "
888 "loop %i\n", loop->num);
889 l->looping =true;
890 break;
892 scev_finalize ();
894 loop_optimizer_finalize ();
898 if (dump_file && (dump_flags & TDF_DETAILS))
899 fprintf (dump_file, " checking previously known:");
901 better_state (&l->pure_const_state, &l->looping,
902 l->state_previously_known,
903 l->looping_previously_known);
904 if (TREE_NOTHROW (decl))
905 l->can_throw = false;
907 pop_cfun ();
908 if (dump_file)
910 if (l->looping)
911 fprintf (dump_file, "Function is locally looping.\n");
912 if (l->can_throw)
913 fprintf (dump_file, "Function is locally throwing.\n");
914 if (l->pure_const_state == IPA_CONST)
915 fprintf (dump_file, "Function is locally const.\n");
916 if (l->pure_const_state == IPA_PURE)
917 fprintf (dump_file, "Function is locally pure.\n");
918 if (l->can_free)
919 fprintf (dump_file, "Function can locally free.\n");
921 return l;
924 /* Called when new function is inserted to callgraph late. */
925 static void
926 add_new_function (struct cgraph_node *node, void *data ATTRIBUTE_UNUSED)
928 if (node->get_availability () < AVAIL_INTERPOSABLE)
929 return;
930 /* There are some shared nodes, in particular the initializers on
931 static declarations. We do not need to scan them more than once
932 since all we would be interested in are the addressof
933 operations. */
934 if (opt_for_fn (node->decl, flag_ipa_pure_const))
935 set_function_state (node, analyze_function (node, true));
938 /* Called when new clone is inserted to callgraph late. */
940 static void
941 duplicate_node_data (struct cgraph_node *src, struct cgraph_node *dst,
942 void *data ATTRIBUTE_UNUSED)
944 if (has_function_state (src))
946 funct_state l = XNEW (struct funct_state_d);
947 gcc_assert (!has_function_state (dst));
948 memcpy (l, get_function_state (src), sizeof (*l));
949 set_function_state (dst, l);
953 /* Called when new clone is inserted to callgraph late. */
955 static void
956 remove_node_data (struct cgraph_node *node, void *data ATTRIBUTE_UNUSED)
958 if (has_function_state (node))
960 funct_state l = get_function_state (node);
961 if (l != &varying_state)
962 free (l);
963 set_function_state (node, NULL);
968 void
969 pass_ipa_pure_const::
970 register_hooks (void)
972 if (init_p)
973 return;
975 init_p = true;
977 node_removal_hook_holder =
978 symtab->add_cgraph_removal_hook (&remove_node_data, NULL);
979 node_duplication_hook_holder =
980 symtab->add_cgraph_duplication_hook (&duplicate_node_data, NULL);
981 function_insertion_hook_holder =
982 symtab->add_cgraph_insertion_hook (&add_new_function, NULL);
986 /* Analyze each function in the cgraph to see if it is locally PURE or
987 CONST. */
989 static void
990 pure_const_generate_summary (void)
992 struct cgraph_node *node;
994 pass_ipa_pure_const *pass = static_cast <pass_ipa_pure_const *> (current_pass);
995 pass->register_hooks ();
997 /* Process all of the functions.
999 We process AVAIL_INTERPOSABLE functions. We can not use the results
1000 by default, but the info can be used at LTO with -fwhole-program or
1001 when function got cloned and the clone is AVAILABLE. */
1003 FOR_EACH_DEFINED_FUNCTION (node)
1004 if (opt_for_fn (node->decl, flag_ipa_pure_const))
1005 set_function_state (node, analyze_function (node, true));
1009 /* Serialize the ipa info for lto. */
1011 static void
1012 pure_const_write_summary (void)
1014 struct cgraph_node *node;
1015 struct lto_simple_output_block *ob
1016 = lto_create_simple_output_block (LTO_section_ipa_pure_const);
1017 unsigned int count = 0;
1018 lto_symtab_encoder_iterator lsei;
1019 lto_symtab_encoder_t encoder;
1021 encoder = lto_get_out_decl_state ()->symtab_node_encoder;
1023 for (lsei = lsei_start_function_in_partition (encoder); !lsei_end_p (lsei);
1024 lsei_next_function_in_partition (&lsei))
1026 node = lsei_cgraph_node (lsei);
1027 if (node->definition && has_function_state (node))
1028 count++;
1031 streamer_write_uhwi_stream (ob->main_stream, count);
1033 /* Process all of the functions. */
1034 for (lsei = lsei_start_function_in_partition (encoder); !lsei_end_p (lsei);
1035 lsei_next_function_in_partition (&lsei))
1037 node = lsei_cgraph_node (lsei);
1038 if (node->definition && has_function_state (node))
1040 struct bitpack_d bp;
1041 funct_state fs;
1042 int node_ref;
1043 lto_symtab_encoder_t encoder;
1045 fs = get_function_state (node);
1047 encoder = ob->decl_state->symtab_node_encoder;
1048 node_ref = lto_symtab_encoder_encode (encoder, node);
1049 streamer_write_uhwi_stream (ob->main_stream, node_ref);
1051 /* Note that flags will need to be read in the opposite
1052 order as we are pushing the bitflags into FLAGS. */
1053 bp = bitpack_create (ob->main_stream);
1054 bp_pack_value (&bp, fs->pure_const_state, 2);
1055 bp_pack_value (&bp, fs->state_previously_known, 2);
1056 bp_pack_value (&bp, fs->looping_previously_known, 1);
1057 bp_pack_value (&bp, fs->looping, 1);
1058 bp_pack_value (&bp, fs->can_throw, 1);
1059 bp_pack_value (&bp, fs->can_free, 1);
1060 streamer_write_bitpack (&bp);
1064 lto_destroy_simple_output_block (ob);
1068 /* Deserialize the ipa info for lto. */
1070 static void
1071 pure_const_read_summary (void)
1073 struct lto_file_decl_data **file_data_vec = lto_get_file_decl_data ();
1074 struct lto_file_decl_data *file_data;
1075 unsigned int j = 0;
1077 pass_ipa_pure_const *pass = static_cast <pass_ipa_pure_const *> (current_pass);
1078 pass->register_hooks ();
1080 while ((file_data = file_data_vec[j++]))
1082 const char *data;
1083 size_t len;
1084 struct lto_input_block *ib
1085 = lto_create_simple_input_block (file_data,
1086 LTO_section_ipa_pure_const,
1087 &data, &len);
1088 if (ib)
1090 unsigned int i;
1091 unsigned int count = streamer_read_uhwi (ib);
1093 for (i = 0; i < count; i++)
1095 unsigned int index;
1096 struct cgraph_node *node;
1097 struct bitpack_d bp;
1098 funct_state fs;
1099 lto_symtab_encoder_t encoder;
1101 fs = XCNEW (struct funct_state_d);
1102 index = streamer_read_uhwi (ib);
1103 encoder = file_data->symtab_node_encoder;
1104 node = dyn_cast<cgraph_node *> (lto_symtab_encoder_deref (encoder,
1105 index));
1106 set_function_state (node, fs);
1108 /* Note that the flags must be read in the opposite
1109 order in which they were written (the bitflags were
1110 pushed into FLAGS). */
1111 bp = streamer_read_bitpack (ib);
1112 fs->pure_const_state
1113 = (enum pure_const_state_e) bp_unpack_value (&bp, 2);
1114 fs->state_previously_known
1115 = (enum pure_const_state_e) bp_unpack_value (&bp, 2);
1116 fs->looping_previously_known = bp_unpack_value (&bp, 1);
1117 fs->looping = bp_unpack_value (&bp, 1);
1118 fs->can_throw = bp_unpack_value (&bp, 1);
1119 fs->can_free = bp_unpack_value (&bp, 1);
1120 if (dump_file)
1122 int flags = flags_from_decl_or_type (node->decl);
1123 fprintf (dump_file, "Read info for %s/%i ",
1124 node->name (),
1125 node->order);
1126 if (flags & ECF_CONST)
1127 fprintf (dump_file, " const");
1128 if (flags & ECF_PURE)
1129 fprintf (dump_file, " pure");
1130 if (flags & ECF_NOTHROW)
1131 fprintf (dump_file, " nothrow");
1132 fprintf (dump_file, "\n pure const state: %s\n",
1133 pure_const_names[fs->pure_const_state]);
1134 fprintf (dump_file, " previously known state: %s\n",
1135 pure_const_names[fs->state_previously_known]);
1136 if (fs->looping)
1137 fprintf (dump_file," function is locally looping\n");
1138 if (fs->looping_previously_known)
1139 fprintf (dump_file," function is previously known looping\n");
1140 if (fs->can_throw)
1141 fprintf (dump_file," function is locally throwing\n");
1142 if (fs->can_free)
1143 fprintf (dump_file," function can locally free\n");
1147 lto_destroy_simple_input_block (file_data,
1148 LTO_section_ipa_pure_const,
1149 ib, data, len);
1154 /* We only propagate across edges that can throw externally and their callee
1155 is not interposable. */
1157 static bool
1158 ignore_edge_for_nothrow (struct cgraph_edge *e)
1160 if (!e->can_throw_external || TREE_NOTHROW (e->callee->decl))
1161 return true;
1163 enum availability avail;
1164 cgraph_node *n = e->callee->function_or_virtual_thunk_symbol (&avail,
1165 e->caller);
1166 if (avail <= AVAIL_INTERPOSABLE || TREE_NOTHROW (n->decl))
1167 return true;
1168 return opt_for_fn (e->callee->decl, flag_non_call_exceptions)
1169 && !e->callee->binds_to_current_def_p (e->caller);
1172 /* Return true if NODE is self recursive function.
1173 Indirectly recursive functions appears as non-trivial strongly
1174 connected components, so we need to care about self recursion
1175 only. */
1177 static bool
1178 self_recursive_p (struct cgraph_node *node)
1180 struct cgraph_edge *e;
1181 for (e = node->callees; e; e = e->next_callee)
1182 if (e->callee->function_symbol () == node)
1183 return true;
1184 return false;
1187 /* Return true if N is cdtor that is not const or pure. In this case we may
1188 need to remove unreachable function if it is marked const/pure. */
1190 static bool
1191 cdtor_p (cgraph_node *n, void *)
1193 if (DECL_STATIC_CONSTRUCTOR (n->decl) || DECL_STATIC_DESTRUCTOR (n->decl))
1194 return !TREE_READONLY (n->decl) && !DECL_PURE_P (n->decl);
1195 return false;
1198 /* We only propagate across edges with non-interposable callee. */
1200 static bool
1201 ignore_edge_for_pure_const (struct cgraph_edge *e)
1203 enum availability avail;
1204 e->callee->function_or_virtual_thunk_symbol (&avail, e->caller);
1205 return (avail <= AVAIL_INTERPOSABLE);
1209 /* Produce transitive closure over the callgraph and compute pure/const
1210 attributes. */
1212 static bool
1213 propagate_pure_const (void)
1215 struct cgraph_node *node;
1216 struct cgraph_node *w;
1217 struct cgraph_node **order =
1218 XCNEWVEC (struct cgraph_node *, symtab->cgraph_count);
1219 int order_pos;
1220 int i;
1221 struct ipa_dfs_info * w_info;
1222 bool remove_p = false;
1224 order_pos = ipa_reduced_postorder (order, true, false,
1225 ignore_edge_for_pure_const);
1226 if (dump_file)
1228 cgraph_node::dump_cgraph (dump_file);
1229 ipa_print_order (dump_file, "reduced", order, order_pos);
1232 /* Propagate the local information through the call graph to produce
1233 the global information. All the nodes within a cycle will have
1234 the same info so we collapse cycles first. Then we can do the
1235 propagation in one pass from the leaves to the roots. */
1236 for (i = 0; i < order_pos; i++ )
1238 enum pure_const_state_e pure_const_state = IPA_CONST;
1239 bool looping = false;
1240 int count = 0;
1241 node = order[i];
1243 if (node->alias)
1244 continue;
1246 if (dump_file && (dump_flags & TDF_DETAILS))
1247 fprintf (dump_file, "Starting cycle\n");
1249 /* Find the worst state for any node in the cycle. */
1250 w = node;
1251 while (w && pure_const_state != IPA_NEITHER)
1253 struct cgraph_edge *e;
1254 struct cgraph_edge *ie;
1255 int i;
1256 struct ipa_ref *ref = NULL;
1258 funct_state w_l = get_function_state (w);
1259 if (dump_file && (dump_flags & TDF_DETAILS))
1260 fprintf (dump_file, " Visiting %s/%i state:%s looping %i\n",
1261 w->name (),
1262 w->order,
1263 pure_const_names[w_l->pure_const_state],
1264 w_l->looping);
1266 /* First merge in function body properties.
1267 We are safe to pass NULL as FROM and TO because we will take care
1268 of possible interposition when walking callees. */
1269 worse_state (&pure_const_state, &looping,
1270 w_l->pure_const_state, w_l->looping,
1271 NULL, NULL);
1272 if (pure_const_state == IPA_NEITHER)
1273 break;
1275 /* For interposable nodes we can not assume anything.
1276 FIXME: It should be safe to remove this conditional and allow
1277 interposable functions with non-interposable aliases next
1278 stage 1. */
1279 if (w->get_availability () == AVAIL_INTERPOSABLE)
1281 worse_state (&pure_const_state, &looping,
1282 w_l->state_previously_known,
1283 w_l->looping_previously_known,
1284 NULL, NULL);
1285 if (dump_file && (dump_flags & TDF_DETAILS))
1287 fprintf (dump_file,
1288 " Interposable. state %s looping %i\n",
1289 pure_const_names[w_l->state_previously_known],
1290 w_l->looping_previously_known);
1292 break;
1295 count++;
1297 /* We consider recursive cycles as possibly infinite.
1298 This might be relaxed since infinite recursion leads to stack
1299 overflow. */
1300 if (count > 1)
1301 looping = true;
1303 /* Now walk the edges and merge in callee properties. */
1304 for (e = w->callees; e && pure_const_state != IPA_NEITHER;
1305 e = e->next_callee)
1307 enum availability avail;
1308 struct cgraph_node *y = e->callee->
1309 function_or_virtual_thunk_symbol (&avail,
1310 e->caller);
1311 enum pure_const_state_e edge_state = IPA_CONST;
1312 bool edge_looping = false;
1314 if (dump_file && (dump_flags & TDF_DETAILS))
1316 fprintf (dump_file,
1317 " Call to %s/%i",
1318 e->callee->name (),
1319 e->callee->order);
1321 if (avail > AVAIL_INTERPOSABLE)
1323 funct_state y_l = get_function_state (y);
1324 if (dump_file && (dump_flags & TDF_DETAILS))
1326 fprintf (dump_file,
1327 " state:%s looping:%i\n",
1328 pure_const_names[y_l->pure_const_state],
1329 y_l->looping);
1331 if (y_l->pure_const_state > IPA_PURE
1332 && e->cannot_lead_to_return_p ())
1334 if (dump_file && (dump_flags & TDF_DETAILS))
1335 fprintf (dump_file,
1336 " Ignoring side effects"
1337 " -> pure, looping\n");
1338 edge_state = IPA_PURE;
1339 edge_looping = true;
1341 else
1343 edge_state = y_l->pure_const_state;
1344 edge_looping = y_l->looping;
1347 else if (special_builtin_state (&edge_state, &edge_looping,
1348 y->decl))
1350 else
1351 state_from_flags (&edge_state, &edge_looping,
1352 flags_from_decl_or_type (y->decl),
1353 e->cannot_lead_to_return_p ());
1355 /* Merge the results with what we already know. */
1356 better_state (&edge_state, &edge_looping,
1357 w_l->state_previously_known,
1358 w_l->looping_previously_known);
1359 worse_state (&pure_const_state, &looping,
1360 edge_state, edge_looping, e->caller, e->callee);
1361 if (pure_const_state == IPA_NEITHER)
1362 break;
1365 /* Now process the indirect call. */
1366 for (ie = w->indirect_calls;
1367 ie && pure_const_state != IPA_NEITHER; ie = ie->next_callee)
1369 enum pure_const_state_e edge_state = IPA_CONST;
1370 bool edge_looping = false;
1372 if (dump_file && (dump_flags & TDF_DETAILS))
1373 fprintf (dump_file, " Indirect call");
1374 state_from_flags (&edge_state, &edge_looping,
1375 ie->indirect_info->ecf_flags,
1376 ie->cannot_lead_to_return_p ());
1377 /* Merge the results with what we already know. */
1378 better_state (&edge_state, &edge_looping,
1379 w_l->state_previously_known,
1380 w_l->looping_previously_known);
1381 worse_state (&pure_const_state, &looping,
1382 edge_state, edge_looping, NULL, NULL);
1383 if (pure_const_state == IPA_NEITHER)
1384 break;
1387 /* And finally all loads and stores. */
1388 for (i = 0; w->iterate_reference (i, ref)
1389 && pure_const_state != IPA_NEITHER; i++)
1391 enum pure_const_state_e ref_state = IPA_CONST;
1392 bool ref_looping = false;
1393 switch (ref->use)
1395 case IPA_REF_LOAD:
1396 /* readonly reads are safe. */
1397 if (TREE_READONLY (ref->referred->decl))
1398 break;
1399 if (dump_file && (dump_flags & TDF_DETAILS))
1400 fprintf (dump_file, " nonreadonly global var read\n");
1401 ref_state = IPA_PURE;
1402 break;
1403 case IPA_REF_STORE:
1404 if (ref->cannot_lead_to_return ())
1405 break;
1406 ref_state = IPA_NEITHER;
1407 if (dump_file && (dump_flags & TDF_DETAILS))
1408 fprintf (dump_file, " global var write\n");
1409 break;
1410 case IPA_REF_ADDR:
1411 case IPA_REF_CHKP:
1412 break;
1413 default:
1414 gcc_unreachable ();
1416 better_state (&ref_state, &ref_looping,
1417 w_l->state_previously_known,
1418 w_l->looping_previously_known);
1419 worse_state (&pure_const_state, &looping,
1420 ref_state, ref_looping, NULL, NULL);
1421 if (pure_const_state == IPA_NEITHER)
1422 break;
1424 w_info = (struct ipa_dfs_info *) w->aux;
1425 w = w_info->next_cycle;
1427 if (dump_file && (dump_flags & TDF_DETAILS))
1428 fprintf (dump_file, "Result %s looping %i\n",
1429 pure_const_names [pure_const_state],
1430 looping);
1432 /* Find the worst state of can_free for any node in the cycle. */
1433 bool can_free = false;
1434 w = node;
1435 while (w && !can_free)
1437 struct cgraph_edge *e;
1438 funct_state w_l = get_function_state (w);
1440 if (w_l->can_free
1441 || w->get_availability () == AVAIL_INTERPOSABLE
1442 || w->indirect_calls)
1443 can_free = true;
1445 for (e = w->callees; e && !can_free; e = e->next_callee)
1447 enum availability avail;
1448 struct cgraph_node *y = e->callee->
1449 function_or_virtual_thunk_symbol (&avail,
1450 e->caller);
1452 if (avail > AVAIL_INTERPOSABLE)
1453 can_free = get_function_state (y)->can_free;
1454 else
1455 can_free = true;
1457 w_info = (struct ipa_dfs_info *) w->aux;
1458 w = w_info->next_cycle;
1461 /* Copy back the region's pure_const_state which is shared by
1462 all nodes in the region. */
1463 w = node;
1464 while (w)
1466 funct_state w_l = get_function_state (w);
1467 enum pure_const_state_e this_state = pure_const_state;
1468 bool this_looping = looping;
1470 w_l->can_free = can_free;
1471 w->nonfreeing_fn = !can_free;
1472 if (!can_free && dump_file)
1473 fprintf (dump_file, "Function found not to call free: %s\n",
1474 w->name ());
1476 if (w_l->state_previously_known != IPA_NEITHER
1477 && this_state > w_l->state_previously_known)
1479 this_state = w_l->state_previously_known;
1480 if (this_state == IPA_NEITHER)
1481 this_looping = w_l->looping_previously_known;
1483 if (!this_looping && self_recursive_p (w))
1484 this_looping = true;
1485 if (!w_l->looping_previously_known)
1486 this_looping = false;
1488 /* All nodes within a cycle share the same info. */
1489 w_l->pure_const_state = this_state;
1490 w_l->looping = this_looping;
1492 /* Inline clones share declaration with their offline copies;
1493 do not modify their declarations since the offline copy may
1494 be different. */
1495 if (!w->global.inlined_to)
1496 switch (this_state)
1498 case IPA_CONST:
1499 if (!TREE_READONLY (w->decl))
1501 warn_function_const (w->decl, !this_looping);
1502 if (dump_file)
1503 fprintf (dump_file, "Function found to be %sconst: %s\n",
1504 this_looping ? "looping " : "",
1505 w->name ());
1507 remove_p |= w->call_for_symbol_and_aliases (cdtor_p,
1508 NULL, true);
1509 w->set_const_flag (true, this_looping);
1510 break;
1512 case IPA_PURE:
1513 if (!DECL_PURE_P (w->decl))
1515 warn_function_pure (w->decl, !this_looping);
1516 if (dump_file)
1517 fprintf (dump_file, "Function found to be %spure: %s\n",
1518 this_looping ? "looping " : "",
1519 w->name ());
1521 remove_p |= w->call_for_symbol_and_aliases (cdtor_p,
1522 NULL, true);
1523 w->set_pure_flag (true, this_looping);
1524 break;
1526 default:
1527 break;
1529 w_info = (struct ipa_dfs_info *) w->aux;
1530 w = w_info->next_cycle;
1534 ipa_free_postorder_info ();
1535 free (order);
1536 return remove_p;
1539 /* Produce transitive closure over the callgraph and compute nothrow
1540 attributes. */
1542 static void
1543 propagate_nothrow (void)
1545 struct cgraph_node *node;
1546 struct cgraph_node *w;
1547 struct cgraph_node **order =
1548 XCNEWVEC (struct cgraph_node *, symtab->cgraph_count);
1549 int order_pos;
1550 int i;
1551 struct ipa_dfs_info * w_info;
1553 order_pos = ipa_reduced_postorder (order, true, false,
1554 ignore_edge_for_nothrow);
1555 if (dump_file)
1557 cgraph_node::dump_cgraph (dump_file);
1558 ipa_print_order (dump_file, "reduced for nothrow", order, order_pos);
1561 /* Propagate the local information through the call graph to produce
1562 the global information. All the nodes within a cycle will have
1563 the same info so we collapse cycles first. Then we can do the
1564 propagation in one pass from the leaves to the roots. */
1565 for (i = 0; i < order_pos; i++ )
1567 bool can_throw = false;
1568 node = order[i];
1570 if (node->alias)
1571 continue;
1573 /* Find the worst state for any node in the cycle. */
1574 w = node;
1575 while (w && !can_throw)
1577 struct cgraph_edge *e, *ie;
1579 if (!TREE_NOTHROW (w->decl))
1581 funct_state w_l = get_function_state (w);
1583 if (w_l->can_throw
1584 || w->get_availability () == AVAIL_INTERPOSABLE)
1585 can_throw = true;
1587 for (e = w->callees; e && !can_throw; e = e->next_callee)
1589 enum availability avail;
1591 if (!e->can_throw_external || TREE_NOTHROW (e->callee->decl))
1592 continue;
1594 struct cgraph_node *y = e->callee->
1595 function_or_virtual_thunk_symbol (&avail,
1596 e->caller);
1598 /* We can use info about the callee only if we know it can
1599 not be interposed.
1600 When callee is compiled with non-call exceptions we also
1601 must check that the declaration is bound to current
1602 body as other semantically equivalent body may still
1603 throw. */
1604 if (avail <= AVAIL_INTERPOSABLE
1605 || (!TREE_NOTHROW (y->decl)
1606 && (get_function_state (y)->can_throw
1607 || (opt_for_fn (y->decl, flag_non_call_exceptions)
1608 && !e->callee->binds_to_current_def_p (w)))))
1609 can_throw = true;
1611 for (ie = w->indirect_calls; ie && !can_throw;
1612 ie = ie->next_callee)
1613 if (ie->can_throw_external
1614 && !(ie->indirect_info->ecf_flags & ECF_NOTHROW))
1615 can_throw = true;
1617 w_info = (struct ipa_dfs_info *) w->aux;
1618 w = w_info->next_cycle;
1621 /* Copy back the region's pure_const_state which is shared by
1622 all nodes in the region. */
1623 w = node;
1624 while (w)
1626 funct_state w_l = get_function_state (w);
1627 if (!can_throw && !TREE_NOTHROW (w->decl))
1629 /* Inline clones share declaration with their offline copies;
1630 do not modify their declarations since the offline copy may
1631 be different. */
1632 if (!w->global.inlined_to)
1634 w->set_nothrow_flag (true);
1635 if (dump_file)
1636 fprintf (dump_file, "Function found to be nothrow: %s\n",
1637 w->name ());
1640 else if (can_throw && !TREE_NOTHROW (w->decl))
1641 w_l->can_throw = true;
1642 w_info = (struct ipa_dfs_info *) w->aux;
1643 w = w_info->next_cycle;
1647 ipa_free_postorder_info ();
1648 free (order);
1652 /* Produce the global information by preforming a transitive closure
1653 on the local information that was produced by generate_summary. */
1655 unsigned int
1656 pass_ipa_pure_const::
1657 execute (function *)
1659 struct cgraph_node *node;
1660 bool remove_p;
1662 symtab->remove_cgraph_insertion_hook (function_insertion_hook_holder);
1663 symtab->remove_cgraph_duplication_hook (node_duplication_hook_holder);
1664 symtab->remove_cgraph_removal_hook (node_removal_hook_holder);
1666 /* Nothrow makes more function to not lead to return and improve
1667 later analysis. */
1668 propagate_nothrow ();
1669 remove_p = propagate_pure_const ();
1671 /* Cleanup. */
1672 FOR_EACH_FUNCTION (node)
1673 if (has_function_state (node))
1674 free (get_function_state (node));
1675 funct_state_vec.release ();
1676 return remove_p ? TODO_remove_functions : 0;
1679 static bool
1680 gate_pure_const (void)
1682 return flag_ipa_pure_const || in_lto_p;
1685 pass_ipa_pure_const::pass_ipa_pure_const(gcc::context *ctxt)
1686 : ipa_opt_pass_d(pass_data_ipa_pure_const, ctxt,
1687 pure_const_generate_summary, /* generate_summary */
1688 pure_const_write_summary, /* write_summary */
1689 pure_const_read_summary, /* read_summary */
1690 NULL, /* write_optimization_summary */
1691 NULL, /* read_optimization_summary */
1692 NULL, /* stmt_fixup */
1693 0, /* function_transform_todo_flags_start */
1694 NULL, /* function_transform */
1695 NULL), /* variable_transform */
1696 init_p(false),
1697 function_insertion_hook_holder(NULL),
1698 node_duplication_hook_holder(NULL),
1699 node_removal_hook_holder(NULL)
1703 ipa_opt_pass_d *
1704 make_pass_ipa_pure_const (gcc::context *ctxt)
1706 return new pass_ipa_pure_const (ctxt);
1709 /* Return true if function should be skipped for local pure const analysis. */
1711 static bool
1712 skip_function_for_local_pure_const (struct cgraph_node *node)
1714 /* Because we do not schedule pass_fixup_cfg over whole program after early
1715 optimizations we must not promote functions that are called by already
1716 processed functions. */
1718 if (function_called_by_processed_nodes_p ())
1720 if (dump_file)
1721 fprintf (dump_file, "Function called in recursive cycle; ignoring\n");
1722 return true;
1724 if (node->get_availability () <= AVAIL_INTERPOSABLE)
1726 if (dump_file)
1727 fprintf (dump_file,
1728 "Function is not available or interposable; not analyzing.\n");
1729 return true;
1731 return false;
1734 /* Simple local pass for pure const discovery reusing the analysis from
1735 ipa_pure_const. This pass is effective when executed together with
1736 other optimization passes in early optimization pass queue. */
1738 namespace {
1740 const pass_data pass_data_local_pure_const =
1742 GIMPLE_PASS, /* type */
1743 "local-pure-const", /* name */
1744 OPTGROUP_NONE, /* optinfo_flags */
1745 TV_IPA_PURE_CONST, /* tv_id */
1746 0, /* properties_required */
1747 0, /* properties_provided */
1748 0, /* properties_destroyed */
1749 0, /* todo_flags_start */
1750 0, /* todo_flags_finish */
1753 class pass_local_pure_const : public gimple_opt_pass
1755 public:
1756 pass_local_pure_const (gcc::context *ctxt)
1757 : gimple_opt_pass (pass_data_local_pure_const, ctxt)
1760 /* opt_pass methods: */
1761 opt_pass * clone () { return new pass_local_pure_const (m_ctxt); }
1762 virtual bool gate (function *) { return gate_pure_const (); }
1763 virtual unsigned int execute (function *);
1765 }; // class pass_local_pure_const
1767 unsigned int
1768 pass_local_pure_const::execute (function *fun)
1770 bool changed = false;
1771 funct_state l;
1772 bool skip;
1773 struct cgraph_node *node;
1775 node = cgraph_node::get (current_function_decl);
1776 skip = skip_function_for_local_pure_const (node);
1777 if (!warn_suggest_attribute_const
1778 && !warn_suggest_attribute_pure
1779 && skip)
1780 return 0;
1782 l = analyze_function (node, false);
1784 /* Do NORETURN discovery. */
1785 if (!skip && !TREE_THIS_VOLATILE (current_function_decl)
1786 && EDGE_COUNT (EXIT_BLOCK_PTR_FOR_FN (fun)->preds) == 0)
1788 warn_function_noreturn (fun->decl);
1789 if (dump_file)
1790 fprintf (dump_file, "Function found to be noreturn: %s\n",
1791 current_function_name ());
1793 /* Update declaration and reduce profile to executed once. */
1794 TREE_THIS_VOLATILE (current_function_decl) = 1;
1795 if (node->frequency > NODE_FREQUENCY_EXECUTED_ONCE)
1796 node->frequency = NODE_FREQUENCY_EXECUTED_ONCE;
1798 changed = true;
1801 switch (l->pure_const_state)
1803 case IPA_CONST:
1804 if (!TREE_READONLY (current_function_decl))
1806 warn_function_const (current_function_decl, !l->looping);
1807 if (!skip)
1809 node->set_const_flag (true, l->looping);
1810 changed = true;
1812 if (dump_file)
1813 fprintf (dump_file, "Function found to be %sconst: %s\n",
1814 l->looping ? "looping " : "",
1815 current_function_name ());
1817 else if (DECL_LOOPING_CONST_OR_PURE_P (current_function_decl)
1818 && !l->looping)
1820 if (!skip)
1822 node->set_const_flag (true, false);
1823 changed = true;
1825 if (dump_file)
1826 fprintf (dump_file, "Function found to be non-looping: %s\n",
1827 current_function_name ());
1829 break;
1831 case IPA_PURE:
1832 if (!DECL_PURE_P (current_function_decl))
1834 if (!skip)
1836 node->set_pure_flag (true, l->looping);
1837 changed = true;
1839 warn_function_pure (current_function_decl, !l->looping);
1840 if (dump_file)
1841 fprintf (dump_file, "Function found to be %spure: %s\n",
1842 l->looping ? "looping " : "",
1843 current_function_name ());
1845 else if (DECL_LOOPING_CONST_OR_PURE_P (current_function_decl)
1846 && !l->looping)
1848 if (!skip)
1850 node->set_pure_flag (true, false);
1851 changed = true;
1853 if (dump_file)
1854 fprintf (dump_file, "Function found to be non-looping: %s\n",
1855 current_function_name ());
1857 break;
1859 default:
1860 break;
1862 if (!l->can_throw && !TREE_NOTHROW (current_function_decl))
1864 node->set_nothrow_flag (true);
1865 changed = true;
1866 if (dump_file)
1867 fprintf (dump_file, "Function found to be nothrow: %s\n",
1868 current_function_name ());
1870 free (l);
1871 if (changed)
1872 return execute_fixup_cfg ();
1873 else
1874 return 0;
1877 } // anon namespace
1879 gimple_opt_pass *
1880 make_pass_local_pure_const (gcc::context *ctxt)
1882 return new pass_local_pure_const (ctxt);
1885 /* Emit noreturn warnings. */
1887 namespace {
1889 const pass_data pass_data_warn_function_noreturn =
1891 GIMPLE_PASS, /* type */
1892 "*warn_function_noreturn", /* name */
1893 OPTGROUP_NONE, /* optinfo_flags */
1894 TV_NONE, /* tv_id */
1895 PROP_cfg, /* properties_required */
1896 0, /* properties_provided */
1897 0, /* properties_destroyed */
1898 0, /* todo_flags_start */
1899 0, /* todo_flags_finish */
1902 class pass_warn_function_noreturn : public gimple_opt_pass
1904 public:
1905 pass_warn_function_noreturn (gcc::context *ctxt)
1906 : gimple_opt_pass (pass_data_warn_function_noreturn, ctxt)
1909 /* opt_pass methods: */
1910 virtual bool gate (function *) { return warn_suggest_attribute_noreturn; }
1911 virtual unsigned int execute (function *fun)
1913 if (!TREE_THIS_VOLATILE (current_function_decl)
1914 && EDGE_COUNT (EXIT_BLOCK_PTR_FOR_FN (fun)->preds) == 0)
1915 warn_function_noreturn (current_function_decl);
1916 return 0;
1919 }; // class pass_warn_function_noreturn
1921 } // anon namespace
1923 gimple_opt_pass *
1924 make_pass_warn_function_noreturn (gcc::context *ctxt)
1926 return new pass_warn_function_noreturn (ctxt);
1929 /* Simple local pass for pure const discovery reusing the analysis from
1930 ipa_pure_const. This pass is effective when executed together with
1931 other optimization passes in early optimization pass queue. */
1933 namespace {
1935 const pass_data pass_data_nothrow =
1937 GIMPLE_PASS, /* type */
1938 "nothrow", /* name */
1939 OPTGROUP_NONE, /* optinfo_flags */
1940 TV_IPA_PURE_CONST, /* tv_id */
1941 0, /* properties_required */
1942 0, /* properties_provided */
1943 0, /* properties_destroyed */
1944 0, /* todo_flags_start */
1945 0, /* todo_flags_finish */
1948 class pass_nothrow : public gimple_opt_pass
1950 public:
1951 pass_nothrow (gcc::context *ctxt)
1952 : gimple_opt_pass (pass_data_nothrow, ctxt)
1955 /* opt_pass methods: */
1956 opt_pass * clone () { return new pass_nothrow (m_ctxt); }
1957 virtual bool gate (function *) { return optimize; }
1958 virtual unsigned int execute (function *);
1960 }; // class pass_nothrow
1962 unsigned int
1963 pass_nothrow::execute (function *)
1965 struct cgraph_node *node;
1966 basic_block this_block;
1968 if (TREE_NOTHROW (current_function_decl))
1969 return 0;
1971 node = cgraph_node::get (current_function_decl);
1973 /* We run during lowering, we can not really use availability yet. */
1974 if (cgraph_node::get (current_function_decl)->get_availability ()
1975 <= AVAIL_INTERPOSABLE)
1977 if (dump_file)
1978 fprintf (dump_file, "Function is interposable;"
1979 " not analyzing.\n");
1980 return true;
1983 FOR_EACH_BB_FN (this_block, cfun)
1985 for (gimple_stmt_iterator gsi = gsi_start_bb (this_block);
1986 !gsi_end_p (gsi);
1987 gsi_next (&gsi))
1988 if (stmt_can_throw_external (gsi_stmt (gsi)))
1990 if (is_gimple_call (gsi_stmt (gsi)))
1992 tree callee_t = gimple_call_fndecl (gsi_stmt (gsi));
1993 if (callee_t && recursive_call_p (current_function_decl,
1994 callee_t))
1995 continue;
1998 if (dump_file)
2000 fprintf (dump_file, "Statement can throw: ");
2001 print_gimple_stmt (dump_file, gsi_stmt (gsi), 0, 0);
2003 return 0;
2007 node->set_nothrow_flag (true);
2009 bool cfg_changed = false;
2010 if (self_recursive_p (node))
2011 FOR_EACH_BB_FN (this_block, cfun)
2012 if (gimple *g = last_stmt (this_block))
2013 if (is_gimple_call (g))
2015 tree callee_t = gimple_call_fndecl (g);
2016 if (callee_t
2017 && recursive_call_p (current_function_decl, callee_t)
2018 && maybe_clean_eh_stmt (g)
2019 && gimple_purge_dead_eh_edges (this_block))
2020 cfg_changed = true;
2023 if (dump_file)
2024 fprintf (dump_file, "Function found to be nothrow: %s\n",
2025 current_function_name ());
2026 return cfg_changed ? TODO_cleanup_cfg : 0;
2029 } // anon namespace
2031 gimple_opt_pass *
2032 make_pass_nothrow (gcc::context *ctxt)
2034 return new pass_nothrow (ctxt);