1 /* Callgraph based analysis of static variables.
2 Copyright (C) 2004, 2005, 2007, 2008, 2009, 2010
3 Free Software Foundation, Inc.
4 Contributed by Kenneth Zadeck <zadeck@naturalbridge.com>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 /* This file marks functions as being either const (TREE_READONLY) or
23 pure (DECL_PURE_P). It can also set a variant of these that
24 are allowed to loop indefinitely (DECL_LOOPING_CONST_PURE_P).
26 This must be run after inlining decisions have been made since
27 otherwise, the local sets will not contain information that is
28 consistent with post inlined state. The global sets are not prone
29 to this problem since they are by definition transitive. */
31 /* The code in this module is called by the ipa pass manager. It
32 should be one of the later passes since it's information is used by
33 the rest of the compilation. */
37 #include "coretypes.h"
40 #include "tree-flow.h"
41 #include "tree-inline.h"
42 #include "tree-pass.h"
43 #include "langhooks.h"
44 #include "pointer-set.h"
46 #include "ipa-utils.h"
50 #include "diagnostic.h"
51 #include "gimple-pretty-print.h"
52 #include "langhooks.h"
54 #include "lto-streamer.h"
55 #include "data-streamer.h"
56 #include "tree-streamer.h"
58 #include "tree-scalar-evolution.h"
62 static struct pointer_set_t
*visited_nodes
;
64 /* Lattice values for const and pure functions. Everything starts out
65 being const, then may drop to pure and then neither depending on
67 enum pure_const_state_e
74 const char *pure_const_names
[3] = {"const", "pure", "neither"};
76 /* Holder for the const_state. There is one of these per function
81 enum pure_const_state_e pure_const_state
;
82 /* What user set here; we can be always sure about this. */
83 enum pure_const_state_e state_previously_known
;
84 bool looping_previously_known
;
86 /* True if the function could possibly infinite loop. There are a
87 lot of ways that this could be determined. We are pretty
88 conservative here. While it is possible to cse pure and const
89 calls, it is not legal to have dce get rid of the call if there
90 is a possibility that the call could infinite loop since this is
91 a behavioral change. */
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 };
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
108 /* Array, indexed by cgraph node uid, of function states. */
110 DEF_VEC_P (funct_state
);
111 DEF_VEC_ALLOC_P (funct_state
, heap
);
112 static VEC (funct_state
, heap
) *funct_state_vec
;
114 /* Holders of ipa cgraph hooks: */
115 static struct cgraph_node_hook_list
*function_insertion_hook_holder
;
116 static struct cgraph_2node_hook_list
*node_duplication_hook_holder
;
117 static struct cgraph_node_hook_list
*node_removal_hook_holder
;
119 /* Try to guess if function body will always be visible to compiler
120 when compiling the call and whether compiler will be able
121 to propagate the information by itself. */
124 function_always_visible_to_compiler_p (tree decl
)
126 return (!TREE_PUBLIC (decl
) || DECL_DECLARED_INLINE_P (decl
));
129 /* Emit suggestion about attribute ATTRIB_NAME for DECL. KNOWN_FINITE
130 is true if the function is known to be finite. The diagnostic is
131 controlled by OPTION. WARNED_ABOUT is a pointer_set unique for
132 OPTION, this function may initialize it and it is always returned
135 static struct pointer_set_t
*
136 suggest_attribute (int option
, tree decl
, bool known_finite
,
137 struct pointer_set_t
*warned_about
,
138 const char * attrib_name
)
140 if (!option_enabled (option
, &global_options
))
142 if (TREE_THIS_VOLATILE (decl
)
143 || (known_finite
&& function_always_visible_to_compiler_p (decl
)))
147 warned_about
= pointer_set_create ();
148 if (pointer_set_contains (warned_about
, decl
))
150 pointer_set_insert (warned_about
, decl
);
151 warning_at (DECL_SOURCE_LOCATION (decl
),
154 ? _("function might be candidate for attribute %<%s%>")
155 : _("function might be candidate for attribute %<%s%>"
156 " if it is known to return normally"), attrib_name
);
160 /* Emit suggestion about __attribute_((pure)) for DECL. KNOWN_FINITE
161 is true if the function is known to be finite. */
164 warn_function_pure (tree decl
, bool known_finite
)
166 static struct pointer_set_t
*warned_about
;
169 = suggest_attribute (OPT_Wsuggest_attribute_pure
, decl
,
170 known_finite
, warned_about
, "pure");
173 /* Emit suggestion about __attribute_((const)) for DECL. KNOWN_FINITE
174 is true if the function is known to be finite. */
177 warn_function_const (tree decl
, bool known_finite
)
179 static struct pointer_set_t
*warned_about
;
181 = suggest_attribute (OPT_Wsuggest_attribute_const
, decl
,
182 known_finite
, warned_about
, "const");
186 warn_function_noreturn (tree decl
)
188 static struct pointer_set_t
*warned_about
;
189 if (!lang_hooks
.missing_noreturn_ok_p (decl
)
190 && targetm
.warn_func_return (decl
))
192 = suggest_attribute (OPT_Wsuggest_attribute_noreturn
, decl
,
193 true, warned_about
, "noreturn");
196 /* Init the function state. */
201 free (funct_state_vec
);
205 /* Return true if we have a function state for NODE. */
208 has_function_state (struct cgraph_node
*node
)
211 || VEC_length (funct_state
, funct_state_vec
) <= (unsigned int)node
->uid
)
213 return VEC_index (funct_state
, funct_state_vec
, node
->uid
) != NULL
;
216 /* Return the function state from NODE. */
218 static inline funct_state
219 get_function_state (struct cgraph_node
*node
)
222 || VEC_length (funct_state
, funct_state_vec
) <= (unsigned int)node
->uid
223 || !VEC_index (funct_state
, funct_state_vec
, node
->uid
))
224 /* We might want to put correct previously_known state into varying. */
225 return &varying_state
;
226 return VEC_index (funct_state
, funct_state_vec
, node
->uid
);
229 /* Set the function state S for NODE. */
232 set_function_state (struct cgraph_node
*node
, funct_state s
)
235 || VEC_length (funct_state
, funct_state_vec
) <= (unsigned int)node
->uid
)
236 VEC_safe_grow_cleared (funct_state
, heap
, funct_state_vec
, node
->uid
+ 1);
237 VEC_replace (funct_state
, funct_state_vec
, node
->uid
, s
);
240 /* Check to see if the use (or definition when CHECKING_WRITE is true)
241 variable T is legal in a function that is either pure or const. */
244 check_decl (funct_state local
,
245 tree t
, bool checking_write
, bool ipa
)
247 /* Do not want to do anything with volatile except mark any
248 function that uses one to be not const or pure. */
249 if (TREE_THIS_VOLATILE (t
))
251 local
->pure_const_state
= IPA_NEITHER
;
253 fprintf (dump_file
, " Volatile operand is not const/pure");
257 /* Do not care about a local automatic that is not static. */
258 if (!TREE_STATIC (t
) && !DECL_EXTERNAL (t
))
261 /* If the variable has the "used" attribute, treat it as if it had a
262 been touched by the devil. */
263 if (DECL_PRESERVE_P (t
))
265 local
->pure_const_state
= IPA_NEITHER
;
267 fprintf (dump_file
, " Used static/global variable is not const/pure\n");
271 /* In IPA mode we are not interested in checking actual loads and stores;
272 they will be processed at propagation time using ipa_ref. */
276 /* Since we have dealt with the locals and params cases above, if we
277 are CHECKING_WRITE, this cannot be a pure or constant
281 local
->pure_const_state
= IPA_NEITHER
;
283 fprintf (dump_file
, " static/global memory write is not const/pure\n");
287 if (DECL_EXTERNAL (t
) || TREE_PUBLIC (t
))
289 /* Readonly reads are safe. */
290 if (TREE_READONLY (t
) && !TYPE_NEEDS_CONSTRUCTING (TREE_TYPE (t
)))
291 return; /* Read of a constant, do not change the function state. */
295 fprintf (dump_file
, " global memory read is not const\n");
296 /* Just a regular read. */
297 if (local
->pure_const_state
== IPA_CONST
)
298 local
->pure_const_state
= IPA_PURE
;
303 /* Compilation level statics can be read if they are readonly
305 if (TREE_READONLY (t
))
309 fprintf (dump_file
, " static memory read is not const\n");
310 /* Just a regular read. */
311 if (local
->pure_const_state
== IPA_CONST
)
312 local
->pure_const_state
= IPA_PURE
;
317 /* Check to see if the use (or definition when CHECKING_WRITE is true)
318 variable T is legal in a function that is either pure or const. */
321 check_op (funct_state local
, tree t
, bool checking_write
)
323 t
= get_base_address (t
);
324 if (t
&& TREE_THIS_VOLATILE (t
))
326 local
->pure_const_state
= IPA_NEITHER
;
328 fprintf (dump_file
, " Volatile indirect ref is not const/pure\n");
332 && (INDIRECT_REF_P (t
) || TREE_CODE (t
) == MEM_REF
)
333 && TREE_CODE (TREE_OPERAND (t
, 0)) == SSA_NAME
334 && !ptr_deref_may_alias_global_p (TREE_OPERAND (t
, 0)))
337 fprintf (dump_file
, " Indirect ref to local memory is OK\n");
340 else if (checking_write
)
342 local
->pure_const_state
= IPA_NEITHER
;
344 fprintf (dump_file
, " Indirect ref write is not const/pure\n");
350 fprintf (dump_file
, " Indirect ref read is not const\n");
351 if (local
->pure_const_state
== IPA_CONST
)
352 local
->pure_const_state
= IPA_PURE
;
356 /* compute state based on ECF FLAGS and store to STATE and LOOPING. */
359 state_from_flags (enum pure_const_state_e
*state
, bool *looping
,
360 int flags
, bool cannot_lead_to_return
)
363 if (flags
& ECF_LOOPING_CONST_OR_PURE
)
366 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
367 fprintf (dump_file
, " looping");
369 if (flags
& ECF_CONST
)
372 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
373 fprintf (dump_file
, " const\n");
375 else if (flags
& ECF_PURE
)
378 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
379 fprintf (dump_file
, " pure\n");
381 else if (cannot_lead_to_return
)
385 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
386 fprintf (dump_file
, " ignoring side effects->pure looping\n");
390 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
391 fprintf (dump_file
, " neither\n");
392 *state
= IPA_NEITHER
;
397 /* Merge STATE and STATE2 and LOOPING and LOOPING2 and store
398 into STATE and LOOPING better of the two variants.
399 Be sure to merge looping correctly. IPA_NEITHER functions
400 have looping 0 even if they don't have to return. */
403 better_state (enum pure_const_state_e
*state
, bool *looping
,
404 enum pure_const_state_e state2
, bool looping2
)
408 if (*state
== IPA_NEITHER
)
411 *looping
= MIN (*looping
, looping2
);
413 else if (state2
!= IPA_NEITHER
)
414 *looping
= MIN (*looping
, looping2
);
417 /* Merge STATE and STATE2 and LOOPING and LOOPING2 and store
418 into STATE and LOOPING worse of the two variants. */
421 worse_state (enum pure_const_state_e
*state
, bool *looping
,
422 enum pure_const_state_e state2
, bool looping2
)
424 *state
= MAX (*state
, state2
);
425 *looping
= MAX (*looping
, looping2
);
428 /* Recognize special cases of builtins that are by themselves not pure or const
429 but function using them is. */
431 special_builtin_state (enum pure_const_state_e
*state
, bool *looping
,
434 if (DECL_BUILT_IN_CLASS (callee
) == BUILT_IN_NORMAL
)
435 switch (DECL_FUNCTION_CODE (callee
))
437 case BUILT_IN_RETURN
:
438 case BUILT_IN_UNREACHABLE
:
439 case BUILT_IN_ALLOCA
:
440 case BUILT_IN_ALLOCA_WITH_ALIGN
:
441 case BUILT_IN_STACK_SAVE
:
442 case BUILT_IN_STACK_RESTORE
:
443 case BUILT_IN_EH_POINTER
:
444 case BUILT_IN_EH_FILTER
:
445 case BUILT_IN_UNWIND_RESUME
:
446 case BUILT_IN_CXA_END_CLEANUP
:
447 case BUILT_IN_EH_COPY_VALUES
:
448 case BUILT_IN_FRAME_ADDRESS
:
450 case BUILT_IN_APPLY_ARGS
:
454 case BUILT_IN_PREFETCH
:
462 /* Check the parameters of a function call to CALL_EXPR to see if
463 there are any references in the parameters that are not allowed for
464 pure or const functions. Also check to see if this is either an
465 indirect call, a call outside the compilation unit, or has special
466 attributes that may also effect the purity. The CALL_EXPR node for
467 the entire call expression. */
470 check_call (funct_state local
, gimple call
, bool ipa
)
472 int flags
= gimple_call_flags (call
);
473 tree callee_t
= gimple_call_fndecl (call
);
474 bool possibly_throws
= stmt_could_throw_p (call
);
475 bool possibly_throws_externally
= (possibly_throws
476 && stmt_can_throw_external (call
));
481 for (i
= 0; i
< gimple_num_ops (call
); i
++)
482 if (gimple_op (call
, i
)
483 && tree_could_throw_p (gimple_op (call
, i
)))
485 if (possibly_throws
&& cfun
->can_throw_non_call_exceptions
)
488 fprintf (dump_file
, " operand can throw; looping\n");
489 local
->looping
= true;
491 if (possibly_throws_externally
)
494 fprintf (dump_file
, " operand can throw externally\n");
495 local
->can_throw
= true;
500 /* The const and pure flags are set by a variety of places in the
501 compiler (including here). If someone has already set the flags
502 for the callee, (such as for some of the builtins) we will use
503 them, otherwise we will compute our own information.
505 Const and pure functions have less clobber effects than other
506 functions so we process these first. Otherwise if it is a call
507 outside the compilation unit or an indirect call we punt. This
508 leaves local calls which will be processed by following the call
512 enum pure_const_state_e call_state
;
515 if (special_builtin_state (&call_state
, &call_looping
, callee_t
))
517 worse_state (&local
->pure_const_state
, &local
->looping
,
518 call_state
, call_looping
);
521 /* When bad things happen to bad functions, they cannot be const
523 if (setjmp_call_p (callee_t
))
526 fprintf (dump_file
, " setjmp is not const/pure\n");
527 local
->looping
= true;
528 local
->pure_const_state
= IPA_NEITHER
;
531 if (DECL_BUILT_IN_CLASS (callee_t
) == BUILT_IN_NORMAL
)
532 switch (DECL_FUNCTION_CODE (callee_t
))
534 case BUILT_IN_LONGJMP
:
535 case BUILT_IN_NONLOCAL_GOTO
:
537 fprintf (dump_file
, " longjmp and nonlocal goto is not const/pure\n");
538 local
->pure_const_state
= IPA_NEITHER
;
539 local
->looping
= true;
546 /* When not in IPA mode, we can still handle self recursion. */
547 if (!ipa
&& callee_t
== current_function_decl
)
550 fprintf (dump_file
, " Recursive call can loop.\n");
551 local
->looping
= true;
553 /* Either callee is unknown or we are doing local analysis.
554 Look to see if there are any bits available for the callee (such as by
555 declaration or because it is builtin) and process solely on the basis of
559 enum pure_const_state_e call_state
;
561 if (possibly_throws
&& cfun
->can_throw_non_call_exceptions
)
564 fprintf (dump_file
, " can throw; looping\n");
565 local
->looping
= true;
567 if (possibly_throws_externally
)
571 fprintf (dump_file
, " can throw externally to lp %i\n",
572 lookup_stmt_eh_lp (call
));
574 fprintf (dump_file
, " callee:%s\n",
575 IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (callee_t
)));
577 local
->can_throw
= true;
579 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
580 fprintf (dump_file
, " checking flags for call:");
581 state_from_flags (&call_state
, &call_looping
, flags
,
582 ((flags
& (ECF_NORETURN
| ECF_NOTHROW
))
583 == (ECF_NORETURN
| ECF_NOTHROW
))
584 || (!flag_exceptions
&& (flags
& ECF_NORETURN
)));
585 worse_state (&local
->pure_const_state
, &local
->looping
,
586 call_state
, call_looping
);
588 /* Direct functions calls are handled by IPA propagation. */
591 /* Wrapper around check_decl for loads in local more. */
594 check_load (gimple stmt ATTRIBUTE_UNUSED
, tree op
, void *data
)
597 check_decl ((funct_state
)data
, op
, false, false);
599 check_op ((funct_state
)data
, op
, false);
603 /* Wrapper around check_decl for stores in local more. */
606 check_store (gimple stmt ATTRIBUTE_UNUSED
, tree op
, void *data
)
609 check_decl ((funct_state
)data
, op
, true, false);
611 check_op ((funct_state
)data
, op
, true);
615 /* Wrapper around check_decl for loads in ipa mode. */
618 check_ipa_load (gimple stmt ATTRIBUTE_UNUSED
, tree op
, void *data
)
621 check_decl ((funct_state
)data
, op
, false, true);
623 check_op ((funct_state
)data
, op
, false);
627 /* Wrapper around check_decl for stores in ipa mode. */
630 check_ipa_store (gimple stmt ATTRIBUTE_UNUSED
, tree op
, void *data
)
633 check_decl ((funct_state
)data
, op
, true, true);
635 check_op ((funct_state
)data
, op
, true);
639 /* Look into pointer pointed to by GSIP and figure out what interesting side
642 check_stmt (gimple_stmt_iterator
*gsip
, funct_state local
, bool ipa
)
644 gimple stmt
= gsi_stmt (*gsip
);
646 if (is_gimple_debug (stmt
))
651 fprintf (dump_file
, " scanning: ");
652 print_gimple_stmt (dump_file
, stmt
, 0, 0);
655 if (gimple_has_volatile_ops (stmt
)
656 && !gimple_clobber_p (stmt
))
658 local
->pure_const_state
= IPA_NEITHER
;
660 fprintf (dump_file
, " Volatile stmt is not const/pure\n");
663 /* Look for loads and stores. */
664 walk_stmt_load_store_ops (stmt
, local
,
665 ipa
? check_ipa_load
: check_load
,
666 ipa
? check_ipa_store
: check_store
);
668 if (gimple_code (stmt
) != GIMPLE_CALL
669 && stmt_could_throw_p (stmt
))
671 if (cfun
->can_throw_non_call_exceptions
)
674 fprintf (dump_file
, " can throw; looping");
675 local
->looping
= true;
677 if (stmt_can_throw_external (stmt
))
680 fprintf (dump_file
, " can throw externally");
681 local
->can_throw
= true;
684 switch (gimple_code (stmt
))
687 check_call (local
, stmt
, ipa
);
690 if (DECL_NONLOCAL (gimple_label_label (stmt
)))
691 /* Target of long jump. */
694 fprintf (dump_file
, " nonlocal label is not const/pure");
695 local
->pure_const_state
= IPA_NEITHER
;
699 if (gimple_asm_clobbers_memory_p (stmt
))
702 fprintf (dump_file
, " memory asm clobber is not const/pure");
703 /* Abandon all hope, ye who enter here. */
704 local
->pure_const_state
= IPA_NEITHER
;
706 if (gimple_asm_volatile_p (stmt
))
709 fprintf (dump_file
, " volatile is not const/pure");
710 /* Abandon all hope, ye who enter here. */
711 local
->pure_const_state
= IPA_NEITHER
;
712 local
->looping
= true;
721 /* This is the main routine for finding the reference patterns for
722 global variables within a function FN. */
725 analyze_function (struct cgraph_node
*fn
, bool ipa
)
727 tree decl
= fn
->symbol
.decl
;
729 basic_block this_block
;
731 l
= XCNEW (struct funct_state_d
);
732 l
->pure_const_state
= IPA_CONST
;
733 l
->state_previously_known
= IPA_NEITHER
;
734 l
->looping_previously_known
= true;
736 l
->can_throw
= false;
737 state_from_flags (&l
->state_previously_known
, &l
->looping_previously_known
,
738 flags_from_decl_or_type (fn
->symbol
.decl
),
739 cgraph_node_cannot_return (fn
));
741 if (fn
->thunk
.thunk_p
|| fn
->alias
)
743 /* Thunk gets propagated through, so nothing interesting happens. */
750 fprintf (dump_file
, "\n\n local analysis of %s\n ",
751 cgraph_node_name (fn
));
754 push_cfun (DECL_STRUCT_FUNCTION (decl
));
756 FOR_EACH_BB (this_block
)
758 gimple_stmt_iterator gsi
;
759 struct walk_stmt_info wi
;
761 memset (&wi
, 0, sizeof(wi
));
762 for (gsi
= gsi_start_bb (this_block
);
766 check_stmt (&gsi
, l
, ipa
);
767 if (l
->pure_const_state
== IPA_NEITHER
&& l
->looping
&& l
->can_throw
)
773 if (l
->pure_const_state
!= IPA_NEITHER
)
775 /* Const functions cannot have back edges (an
776 indication of possible infinite loop side
778 if (mark_dfs_back_edges ())
780 /* Preheaders are needed for SCEV to work.
781 Simple latches and recorded exits improve chances that loop will
782 proved to be finite in testcases such as in loop-15.c and loop-24.c */
783 loop_optimizer_init (LOOPS_NORMAL
784 | LOOPS_HAVE_RECORDED_EXITS
);
785 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
786 flow_loops_dump (dump_file
, NULL
, 0);
787 if (mark_irreducible_loops ())
790 fprintf (dump_file
, " has irreducible loops\n");
798 FOR_EACH_LOOP (li
, loop
, 0)
799 if (!finite_loop_p (loop
))
802 fprintf (dump_file
, " can not prove finiteness of loop %i\n", loop
->num
);
804 FOR_EACH_LOOP_BREAK (li
);
808 loop_optimizer_finalize ();
812 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
813 fprintf (dump_file
, " checking previously known:");
815 better_state (&l
->pure_const_state
, &l
->looping
,
816 l
->state_previously_known
,
817 l
->looping_previously_known
);
818 if (TREE_NOTHROW (decl
))
819 l
->can_throw
= false;
825 fprintf (dump_file
, "Function is locally looping.\n");
827 fprintf (dump_file
, "Function is locally throwing.\n");
828 if (l
->pure_const_state
== IPA_CONST
)
829 fprintf (dump_file
, "Function is locally const.\n");
830 if (l
->pure_const_state
== IPA_PURE
)
831 fprintf (dump_file
, "Function is locally pure.\n");
836 /* Called when new function is inserted to callgraph late. */
838 add_new_function (struct cgraph_node
*node
, void *data ATTRIBUTE_UNUSED
)
840 if (cgraph_function_body_availability (node
) < AVAIL_OVERWRITABLE
)
842 /* There are some shared nodes, in particular the initializers on
843 static declarations. We do not need to scan them more than once
844 since all we would be interested in are the addressof
846 visited_nodes
= pointer_set_create ();
847 if (cgraph_function_body_availability (node
) > AVAIL_OVERWRITABLE
)
848 set_function_state (node
, analyze_function (node
, true));
849 pointer_set_destroy (visited_nodes
);
850 visited_nodes
= NULL
;
853 /* Called when new clone is inserted to callgraph late. */
856 duplicate_node_data (struct cgraph_node
*src
, struct cgraph_node
*dst
,
857 void *data ATTRIBUTE_UNUSED
)
859 if (has_function_state (src
))
861 funct_state l
= XNEW (struct funct_state_d
);
862 gcc_assert (!has_function_state (dst
));
863 memcpy (l
, get_function_state (src
), sizeof (*l
));
864 set_function_state (dst
, l
);
868 /* Called when new clone is inserted to callgraph late. */
871 remove_node_data (struct cgraph_node
*node
, void *data ATTRIBUTE_UNUSED
)
873 if (has_function_state (node
))
875 funct_state l
= get_function_state (node
);
876 if (l
!= &varying_state
)
878 set_function_state (node
, NULL
);
884 register_hooks (void)
886 static bool init_p
= false;
893 node_removal_hook_holder
=
894 cgraph_add_node_removal_hook (&remove_node_data
, NULL
);
895 node_duplication_hook_holder
=
896 cgraph_add_node_duplication_hook (&duplicate_node_data
, NULL
);
897 function_insertion_hook_holder
=
898 cgraph_add_function_insertion_hook (&add_new_function
, NULL
);
902 /* Analyze each function in the cgraph to see if it is locally PURE or
906 generate_summary (void)
908 struct cgraph_node
*node
;
912 /* There are some shared nodes, in particular the initializers on
913 static declarations. We do not need to scan them more than once
914 since all we would be interested in are the addressof
916 visited_nodes
= pointer_set_create ();
918 /* Process all of the functions.
920 We process AVAIL_OVERWRITABLE functions. We can not use the results
921 by default, but the info can be used at LTO with -fwhole-program or
922 when function got cloned and the clone is AVAILABLE. */
924 FOR_EACH_DEFINED_FUNCTION (node
)
925 if (cgraph_function_body_availability (node
) >= AVAIL_OVERWRITABLE
)
926 set_function_state (node
, analyze_function (node
, true));
928 pointer_set_destroy (visited_nodes
);
929 visited_nodes
= NULL
;
933 /* Serialize the ipa info for lto. */
936 pure_const_write_summary (void)
938 struct cgraph_node
*node
;
939 struct lto_simple_output_block
*ob
940 = lto_create_simple_output_block (LTO_section_ipa_pure_const
);
941 unsigned int count
= 0;
942 lto_symtab_encoder_iterator lsei
;
943 lto_symtab_encoder_t encoder
;
945 encoder
= lto_get_out_decl_state ()->symtab_node_encoder
;
947 for (lsei
= lsei_start_function_in_partition (encoder
); !lsei_end_p (lsei
);
948 lsei_next_function_in_partition (&lsei
))
950 node
= lsei_cgraph_node (lsei
);
951 if (node
->analyzed
&& has_function_state (node
))
955 streamer_write_uhwi_stream (ob
->main_stream
, count
);
957 /* Process all of the functions. */
958 for (lsei
= lsei_start_function_in_partition (encoder
); !lsei_end_p (lsei
);
959 lsei_next_function_in_partition (&lsei
))
961 node
= lsei_cgraph_node (lsei
);
962 if (node
->analyzed
&& has_function_state (node
))
967 lto_symtab_encoder_t encoder
;
969 fs
= get_function_state (node
);
971 encoder
= ob
->decl_state
->symtab_node_encoder
;
972 node_ref
= lto_symtab_encoder_encode (encoder
, (symtab_node
)node
);
973 streamer_write_uhwi_stream (ob
->main_stream
, node_ref
);
975 /* Note that flags will need to be read in the opposite
976 order as we are pushing the bitflags into FLAGS. */
977 bp
= bitpack_create (ob
->main_stream
);
978 bp_pack_value (&bp
, fs
->pure_const_state
, 2);
979 bp_pack_value (&bp
, fs
->state_previously_known
, 2);
980 bp_pack_value (&bp
, fs
->looping_previously_known
, 1);
981 bp_pack_value (&bp
, fs
->looping
, 1);
982 bp_pack_value (&bp
, fs
->can_throw
, 1);
983 streamer_write_bitpack (&bp
);
987 lto_destroy_simple_output_block (ob
);
991 /* Deserialize the ipa info for lto. */
994 pure_const_read_summary (void)
996 struct lto_file_decl_data
**file_data_vec
= lto_get_file_decl_data ();
997 struct lto_file_decl_data
*file_data
;
1001 while ((file_data
= file_data_vec
[j
++]))
1005 struct lto_input_block
*ib
1006 = lto_create_simple_input_block (file_data
,
1007 LTO_section_ipa_pure_const
,
1012 unsigned int count
= streamer_read_uhwi (ib
);
1014 for (i
= 0; i
< count
; i
++)
1017 struct cgraph_node
*node
;
1018 struct bitpack_d bp
;
1020 lto_symtab_encoder_t encoder
;
1022 fs
= XCNEW (struct funct_state_d
);
1023 index
= streamer_read_uhwi (ib
);
1024 encoder
= file_data
->symtab_node_encoder
;
1025 node
= cgraph (lto_symtab_encoder_deref (encoder
, index
));
1026 set_function_state (node
, fs
);
1028 /* Note that the flags must be read in the opposite
1029 order in which they were written (the bitflags were
1030 pushed into FLAGS). */
1031 bp
= streamer_read_bitpack (ib
);
1032 fs
->pure_const_state
1033 = (enum pure_const_state_e
) bp_unpack_value (&bp
, 2);
1034 fs
->state_previously_known
1035 = (enum pure_const_state_e
) bp_unpack_value (&bp
, 2);
1036 fs
->looping_previously_known
= bp_unpack_value (&bp
, 1);
1037 fs
->looping
= bp_unpack_value (&bp
, 1);
1038 fs
->can_throw
= bp_unpack_value (&bp
, 1);
1041 int flags
= flags_from_decl_or_type (node
->symbol
.decl
);
1042 fprintf (dump_file
, "Read info for %s/%i ",
1043 cgraph_node_name (node
),
1045 if (flags
& ECF_CONST
)
1046 fprintf (dump_file
, " const");
1047 if (flags
& ECF_PURE
)
1048 fprintf (dump_file
, " pure");
1049 if (flags
& ECF_NOTHROW
)
1050 fprintf (dump_file
, " nothrow");
1051 fprintf (dump_file
, "\n pure const state: %s\n",
1052 pure_const_names
[fs
->pure_const_state
]);
1053 fprintf (dump_file
, " previously known state: %s\n",
1054 pure_const_names
[fs
->looping_previously_known
]);
1056 fprintf (dump_file
," function is locally looping\n");
1057 if (fs
->looping_previously_known
)
1058 fprintf (dump_file
," function is previously known looping\n");
1060 fprintf (dump_file
," function is locally throwing\n");
1064 lto_destroy_simple_input_block (file_data
,
1065 LTO_section_ipa_pure_const
,
1073 ignore_edge (struct cgraph_edge
*e
)
1075 return (!e
->can_throw_external
);
1078 /* Return true if NODE is self recursive function.
1079 ??? self recursive and indirectly recursive funcions should
1080 be the same, so this function seems unnecesary. */
1083 self_recursive_p (struct cgraph_node
*node
)
1085 struct cgraph_edge
*e
;
1086 for (e
= node
->callees
; e
; e
= e
->next_callee
)
1087 if (cgraph_function_node (e
->callee
, NULL
) == node
)
1092 /* Produce transitive closure over the callgraph and compute pure/const
1096 propagate_pure_const (void)
1098 struct cgraph_node
*node
;
1099 struct cgraph_node
*w
;
1100 struct cgraph_node
**order
=
1101 XCNEWVEC (struct cgraph_node
*, cgraph_n_nodes
);
1104 struct ipa_dfs_info
* w_info
;
1106 order_pos
= ipa_reduced_postorder (order
, true, false, NULL
);
1109 dump_cgraph (dump_file
);
1110 ipa_print_order(dump_file
, "reduced", order
, order_pos
);
1113 /* Propagate the local information through the call graph to produce
1114 the global information. All the nodes within a cycle will have
1115 the same info so we collapse cycles first. Then we can do the
1116 propagation in one pass from the leaves to the roots. */
1117 for (i
= 0; i
< order_pos
; i
++ )
1119 enum pure_const_state_e pure_const_state
= IPA_CONST
;
1120 bool looping
= false;
1127 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1128 fprintf (dump_file
, "Starting cycle\n");
1130 /* Find the worst state for any node in the cycle. */
1132 while (w
&& pure_const_state
!= IPA_NEITHER
)
1134 struct cgraph_edge
*e
;
1135 struct cgraph_edge
*ie
;
1137 struct ipa_ref
*ref
;
1139 funct_state w_l
= get_function_state (w
);
1140 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1141 fprintf (dump_file
, " Visiting %s/%i state:%s looping %i\n",
1142 cgraph_node_name (w
),
1144 pure_const_names
[w_l
->pure_const_state
],
1147 /* First merge in function body properties. */
1148 worse_state (&pure_const_state
, &looping
,
1149 w_l
->pure_const_state
, w_l
->looping
);
1150 if (pure_const_state
== IPA_NEITHER
)
1153 /* For overwritable nodes we can not assume anything. */
1154 if (cgraph_function_body_availability (w
) == AVAIL_OVERWRITABLE
)
1156 worse_state (&pure_const_state
, &looping
,
1157 w_l
->state_previously_known
,
1158 w_l
->looping_previously_known
);
1159 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1162 " Overwritable. state %s looping %i\n",
1163 pure_const_names
[w_l
->state_previously_known
],
1164 w_l
->looping_previously_known
);
1171 /* We consider recursive cycles as possibly infinite.
1172 This might be relaxed since infinite recursion leads to stack
1177 /* Now walk the edges and merge in callee properties. */
1178 for (e
= w
->callees
; e
; e
= e
->next_callee
)
1180 enum availability avail
;
1181 struct cgraph_node
*y
= cgraph_function_node (e
->callee
, &avail
);
1182 enum pure_const_state_e edge_state
= IPA_CONST
;
1183 bool edge_looping
= false;
1185 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1189 cgraph_node_name (e
->callee
),
1192 if (avail
> AVAIL_OVERWRITABLE
)
1194 funct_state y_l
= get_function_state (y
);
1195 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1198 " state:%s looping:%i\n",
1199 pure_const_names
[y_l
->pure_const_state
],
1202 if (y_l
->pure_const_state
> IPA_PURE
1203 && cgraph_edge_cannot_lead_to_return (e
))
1205 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1207 " Ignoring side effects"
1208 " -> pure, looping\n");
1209 edge_state
= IPA_PURE
;
1210 edge_looping
= true;
1214 edge_state
= y_l
->pure_const_state
;
1215 edge_looping
= y_l
->looping
;
1218 else if (special_builtin_state (&edge_state
, &edge_looping
,
1222 state_from_flags (&edge_state
, &edge_looping
,
1223 flags_from_decl_or_type (y
->symbol
.decl
),
1224 cgraph_edge_cannot_lead_to_return (e
));
1226 /* Merge the results with what we already know. */
1227 better_state (&edge_state
, &edge_looping
,
1228 w_l
->state_previously_known
,
1229 w_l
->looping_previously_known
);
1230 worse_state (&pure_const_state
, &looping
,
1231 edge_state
, edge_looping
);
1232 if (pure_const_state
== IPA_NEITHER
)
1235 if (pure_const_state
== IPA_NEITHER
)
1238 /* Now process the indirect call. */
1239 for (ie
= w
->indirect_calls
; ie
; ie
= ie
->next_callee
)
1241 enum pure_const_state_e edge_state
= IPA_CONST
;
1242 bool edge_looping
= false;
1244 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1245 fprintf (dump_file
, " Indirect call");
1246 state_from_flags (&edge_state
, &edge_looping
,
1247 ie
->indirect_info
->ecf_flags
,
1248 cgraph_edge_cannot_lead_to_return (ie
));
1249 /* Merge the results with what we already know. */
1250 better_state (&edge_state
, &edge_looping
,
1251 w_l
->state_previously_known
,
1252 w_l
->looping_previously_known
);
1253 worse_state (&pure_const_state
, &looping
,
1254 edge_state
, edge_looping
);
1255 if (pure_const_state
== IPA_NEITHER
)
1258 if (pure_const_state
== IPA_NEITHER
)
1261 /* And finally all loads and stores. */
1262 for (i
= 0; ipa_ref_list_reference_iterate (&w
->symbol
.ref_list
, i
, ref
); i
++)
1264 enum pure_const_state_e ref_state
= IPA_CONST
;
1265 bool ref_looping
= false;
1269 /* readonly reads are safe. */
1270 if (TREE_READONLY (ipa_ref_varpool_node (ref
)->symbol
.decl
))
1272 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1273 fprintf (dump_file
, " nonreadonly global var read\n");
1274 ref_state
= IPA_PURE
;
1277 if (ipa_ref_cannot_lead_to_return (ref
))
1279 ref_state
= IPA_NEITHER
;
1280 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1281 fprintf (dump_file
, " global var write\n");
1286 better_state (&ref_state
, &ref_looping
,
1287 w_l
->state_previously_known
,
1288 w_l
->looping_previously_known
);
1289 worse_state (&pure_const_state
, &looping
,
1290 ref_state
, ref_looping
);
1291 if (pure_const_state
== IPA_NEITHER
)
1294 w_info
= (struct ipa_dfs_info
*) w
->symbol
.aux
;
1295 w
= w_info
->next_cycle
;
1297 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1298 fprintf (dump_file
, "Result %s looping %i\n",
1299 pure_const_names
[pure_const_state
],
1302 /* Copy back the region's pure_const_state which is shared by
1303 all nodes in the region. */
1307 funct_state w_l
= get_function_state (w
);
1308 enum pure_const_state_e this_state
= pure_const_state
;
1309 bool this_looping
= looping
;
1311 if (w_l
->state_previously_known
!= IPA_NEITHER
1312 && this_state
> w_l
->state_previously_known
)
1314 this_state
= w_l
->state_previously_known
;
1315 this_looping
|= w_l
->looping_previously_known
;
1317 if (!this_looping
&& self_recursive_p (w
))
1318 this_looping
= true;
1319 if (!w_l
->looping_previously_known
)
1320 this_looping
= false;
1322 /* All nodes within a cycle share the same info. */
1323 w_l
->pure_const_state
= this_state
;
1324 w_l
->looping
= this_looping
;
1329 if (!TREE_READONLY (w
->symbol
.decl
))
1331 warn_function_const (w
->symbol
.decl
, !this_looping
);
1333 fprintf (dump_file
, "Function found to be %sconst: %s\n",
1334 this_looping
? "looping " : "",
1335 cgraph_node_name (w
));
1337 cgraph_set_const_flag (w
, true, this_looping
);
1341 if (!DECL_PURE_P (w
->symbol
.decl
))
1343 warn_function_pure (w
->symbol
.decl
, !this_looping
);
1345 fprintf (dump_file
, "Function found to be %spure: %s\n",
1346 this_looping
? "looping " : "",
1347 cgraph_node_name (w
));
1349 cgraph_set_pure_flag (w
, true, this_looping
);
1355 w_info
= (struct ipa_dfs_info
*) w
->symbol
.aux
;
1356 w
= w_info
->next_cycle
;
1360 ipa_free_postorder_info ();
1364 /* Produce transitive closure over the callgraph and compute nothrow
1368 propagate_nothrow (void)
1370 struct cgraph_node
*node
;
1371 struct cgraph_node
*w
;
1372 struct cgraph_node
**order
=
1373 XCNEWVEC (struct cgraph_node
*, cgraph_n_nodes
);
1376 struct ipa_dfs_info
* w_info
;
1378 order_pos
= ipa_reduced_postorder (order
, true, false, ignore_edge
);
1381 dump_cgraph (dump_file
);
1382 ipa_print_order (dump_file
, "reduced for nothrow", order
, order_pos
);
1385 /* Propagate the local information through the call graph to produce
1386 the global information. All the nodes within a cycle will have
1387 the same info so we collapse cycles first. Then we can do the
1388 propagation in one pass from the leaves to the roots. */
1389 for (i
= 0; i
< order_pos
; i
++ )
1391 bool can_throw
= false;
1397 /* Find the worst state for any node in the cycle. */
1401 struct cgraph_edge
*e
, *ie
;
1402 funct_state w_l
= get_function_state (w
);
1405 || cgraph_function_body_availability (w
) == AVAIL_OVERWRITABLE
)
1411 for (e
= w
->callees
; e
; e
= e
->next_callee
)
1413 enum availability avail
;
1414 struct cgraph_node
*y
= cgraph_function_node (e
->callee
, &avail
);
1416 if (avail
> AVAIL_OVERWRITABLE
)
1418 funct_state y_l
= get_function_state (y
);
1422 if (y_l
->can_throw
&& !TREE_NOTHROW (w
->symbol
.decl
)
1423 && e
->can_throw_external
)
1426 else if (e
->can_throw_external
&& !TREE_NOTHROW (y
->symbol
.decl
))
1429 for (ie
= node
->indirect_calls
; ie
; ie
= ie
->next_callee
)
1430 if (ie
->can_throw_external
)
1432 w_info
= (struct ipa_dfs_info
*) w
->symbol
.aux
;
1433 w
= w_info
->next_cycle
;
1436 /* Copy back the region's pure_const_state which is shared by
1437 all nodes in the region. */
1441 funct_state w_l
= get_function_state (w
);
1442 if (!can_throw
&& !TREE_NOTHROW (w
->symbol
.decl
))
1444 cgraph_set_nothrow_flag (w
, true);
1446 fprintf (dump_file
, "Function found to be nothrow: %s\n",
1447 cgraph_node_name (w
));
1449 else if (can_throw
&& !TREE_NOTHROW (w
->symbol
.decl
))
1450 w_l
->can_throw
= true;
1451 w_info
= (struct ipa_dfs_info
*) w
->symbol
.aux
;
1452 w
= w_info
->next_cycle
;
1456 ipa_free_postorder_info ();
1461 /* Produce the global information by preforming a transitive closure
1462 on the local information that was produced by generate_summary. */
1467 struct cgraph_node
*node
;
1469 cgraph_remove_function_insertion_hook (function_insertion_hook_holder
);
1470 cgraph_remove_node_duplication_hook (node_duplication_hook_holder
);
1471 cgraph_remove_node_removal_hook (node_removal_hook_holder
);
1473 /* Nothrow makes more function to not lead to return and improve
1475 propagate_nothrow ();
1476 propagate_pure_const ();
1479 FOR_EACH_DEFINED_FUNCTION (node
)
1480 if (has_function_state (node
))
1481 free (get_function_state (node
));
1482 VEC_free (funct_state
, heap
, funct_state_vec
);
1488 gate_pure_const (void)
1490 return (flag_ipa_pure_const
1491 /* Don't bother doing anything if the program has errors. */
1495 struct ipa_opt_pass_d pass_ipa_pure_const
=
1499 "pure-const", /* name */
1500 gate_pure_const
, /* gate */
1501 propagate
, /* execute */
1504 0, /* static_pass_number */
1505 TV_IPA_PURE_CONST
, /* tv_id */
1506 0, /* properties_required */
1507 0, /* properties_provided */
1508 0, /* properties_destroyed */
1509 0, /* todo_flags_start */
1510 0 /* todo_flags_finish */
1512 generate_summary
, /* generate_summary */
1513 pure_const_write_summary
, /* write_summary */
1514 pure_const_read_summary
, /* read_summary */
1515 NULL
, /* write_optimization_summary */
1516 NULL
, /* read_optimization_summary */
1517 NULL
, /* stmt_fixup */
1519 NULL
, /* function_transform */
1520 NULL
/* variable_transform */
1523 /* Return true if function should be skipped for local pure const analysis. */
1526 skip_function_for_local_pure_const (struct cgraph_node
*node
)
1528 /* Because we do not schedule pass_fixup_cfg over whole program after early optimizations
1529 we must not promote functions that are called by already processed functions. */
1531 if (function_called_by_processed_nodes_p ())
1534 fprintf (dump_file
, "Function called in recursive cycle; ignoring\n");
1537 if (cgraph_function_body_availability (node
) <= AVAIL_OVERWRITABLE
)
1540 fprintf (dump_file
, "Function is not available or overwritable; not analyzing.\n");
1546 /* Simple local pass for pure const discovery reusing the analysis from
1547 ipa_pure_const. This pass is effective when executed together with
1548 other optimization passes in early optimization pass queue. */
1551 local_pure_const (void)
1553 bool changed
= false;
1556 struct cgraph_node
*node
;
1558 node
= cgraph_get_node (current_function_decl
);
1559 skip
= skip_function_for_local_pure_const (node
);
1560 if (!warn_suggest_attribute_const
1561 && !warn_suggest_attribute_pure
1565 l
= analyze_function (node
, false);
1567 /* Do NORETURN discovery. */
1568 if (!skip
&& !TREE_THIS_VOLATILE (current_function_decl
)
1569 && EDGE_COUNT (EXIT_BLOCK_PTR
->preds
) == 0)
1571 warn_function_noreturn (cfun
->decl
);
1573 fprintf (dump_file
, "Function found to be noreturn: %s\n",
1574 current_function_name ());
1576 /* Update declaration and reduce profile to executed once. */
1577 TREE_THIS_VOLATILE (current_function_decl
) = 1;
1578 if (node
->frequency
> NODE_FREQUENCY_EXECUTED_ONCE
)
1579 node
->frequency
= NODE_FREQUENCY_EXECUTED_ONCE
;
1584 switch (l
->pure_const_state
)
1587 if (!TREE_READONLY (current_function_decl
))
1589 warn_function_const (current_function_decl
, !l
->looping
);
1592 cgraph_set_const_flag (node
, true, l
->looping
);
1596 fprintf (dump_file
, "Function found to be %sconst: %s\n",
1597 l
->looping
? "looping " : "",
1598 current_function_name ());
1600 else if (DECL_LOOPING_CONST_OR_PURE_P (current_function_decl
)
1605 cgraph_set_const_flag (node
, true, false);
1609 fprintf (dump_file
, "Function found to be non-looping: %s\n",
1610 current_function_name ());
1615 if (!DECL_PURE_P (current_function_decl
))
1619 cgraph_set_pure_flag (node
, true, l
->looping
);
1622 warn_function_pure (current_function_decl
, !l
->looping
);
1624 fprintf (dump_file
, "Function found to be %spure: %s\n",
1625 l
->looping
? "looping " : "",
1626 current_function_name ());
1628 else if (DECL_LOOPING_CONST_OR_PURE_P (current_function_decl
)
1633 cgraph_set_pure_flag (node
, true, false);
1637 fprintf (dump_file
, "Function found to be non-looping: %s\n",
1638 current_function_name ());
1645 if (!l
->can_throw
&& !TREE_NOTHROW (current_function_decl
))
1647 cgraph_set_nothrow_flag (node
, true);
1650 fprintf (dump_file
, "Function found to be nothrow: %s\n",
1651 current_function_name ());
1655 return execute_fixup_cfg ();
1660 struct gimple_opt_pass pass_local_pure_const
=
1664 "local-pure-const", /* name */
1665 gate_pure_const
, /* gate */
1666 local_pure_const
, /* execute */
1669 0, /* static_pass_number */
1670 TV_IPA_PURE_CONST
, /* tv_id */
1671 0, /* properties_required */
1672 0, /* properties_provided */
1673 0, /* properties_destroyed */
1674 0, /* todo_flags_start */
1675 0 /* todo_flags_finish */