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"
51 #include "diagnostic.h"
52 #include "gimple-pretty-print.h"
53 #include "langhooks.h"
55 #include "lto-streamer.h"
56 #include "data-streamer.h"
57 #include "tree-streamer.h"
59 #include "tree-scalar-evolution.h"
63 static struct pointer_set_t
*visited_nodes
;
65 /* Lattice values for const and pure functions. Everything starts out
66 being const, then may drop to pure and then neither depending on
68 enum pure_const_state_e
75 const char *pure_const_names
[3] = {"const", "pure", "neither"};
77 /* Holder for the const_state. There is one of these per function
82 enum pure_const_state_e pure_const_state
;
83 /* What user set here; we can be always sure about this. */
84 enum pure_const_state_e state_previously_known
;
85 bool looping_previously_known
;
87 /* True if the function could possibly infinite loop. There are a
88 lot of ways that this could be determined. We are pretty
89 conservative here. While it is possible to cse pure and const
90 calls, it is not legal to have dce get rid of the call if there
91 is a possibility that the call could infinite loop since this is
92 a behavioral change. */
98 /* State used when we know nothing about function. */
99 static struct funct_state_d varying_state
100 = { IPA_NEITHER
, IPA_NEITHER
, true, true, true };
103 typedef struct funct_state_d
* funct_state
;
105 /* The storage of the funct_state is abstracted because there is the
106 possibility that it may be desirable to move this to the cgraph
109 /* Array, indexed by cgraph node uid, of function states. */
111 DEF_VEC_P (funct_state
);
112 DEF_VEC_ALLOC_P (funct_state
, heap
);
113 static VEC (funct_state
, heap
) *funct_state_vec
;
115 /* Holders of ipa cgraph hooks: */
116 static struct cgraph_node_hook_list
*function_insertion_hook_holder
;
117 static struct cgraph_2node_hook_list
*node_duplication_hook_holder
;
118 static struct cgraph_node_hook_list
*node_removal_hook_holder
;
120 /* Try to guess if function body will always be visible to compiler
121 when compiling the call and whether compiler will be able
122 to propagate the information by itself. */
125 function_always_visible_to_compiler_p (tree decl
)
127 return (!TREE_PUBLIC (decl
) || DECL_DECLARED_INLINE_P (decl
));
130 /* Emit suggestion about attribute ATTRIB_NAME for DECL. KNOWN_FINITE
131 is true if the function is known to be finite. The diagnostic is
132 controlled by OPTION. WARNED_ABOUT is a pointer_set unique for
133 OPTION, this function may initialize it and it is always returned
136 static struct pointer_set_t
*
137 suggest_attribute (int option
, tree decl
, bool known_finite
,
138 struct pointer_set_t
*warned_about
,
139 const char * attrib_name
)
141 if (!option_enabled (option
, &global_options
))
143 if (TREE_THIS_VOLATILE (decl
)
144 || (known_finite
&& function_always_visible_to_compiler_p (decl
)))
148 warned_about
= pointer_set_create ();
149 if (pointer_set_contains (warned_about
, decl
))
151 pointer_set_insert (warned_about
, decl
);
152 warning_at (DECL_SOURCE_LOCATION (decl
),
155 ? _("function might be candidate for attribute %<%s%>")
156 : _("function might be candidate for attribute %<%s%>"
157 " if it is known to return normally"), attrib_name
);
161 /* Emit suggestion about __attribute_((pure)) for DECL. KNOWN_FINITE
162 is true if the function is known to be finite. */
165 warn_function_pure (tree decl
, bool known_finite
)
167 static struct pointer_set_t
*warned_about
;
170 = suggest_attribute (OPT_Wsuggest_attribute_pure
, decl
,
171 known_finite
, warned_about
, "pure");
174 /* Emit suggestion about __attribute_((const)) for DECL. KNOWN_FINITE
175 is true if the function is known to be finite. */
178 warn_function_const (tree decl
, bool known_finite
)
180 static struct pointer_set_t
*warned_about
;
182 = suggest_attribute (OPT_Wsuggest_attribute_const
, decl
,
183 known_finite
, warned_about
, "const");
187 warn_function_noreturn (tree decl
)
189 static struct pointer_set_t
*warned_about
;
190 if (!lang_hooks
.missing_noreturn_ok_p (decl
))
192 = suggest_attribute (OPT_Wsuggest_attribute_noreturn
, decl
,
193 true, warned_about
, "noreturn");
195 /* Init the function state. */
200 free (funct_state_vec
);
204 /* Return true if we have a function state for NODE. */
207 has_function_state (struct cgraph_node
*node
)
210 || VEC_length (funct_state
, funct_state_vec
) <= (unsigned int)node
->uid
)
212 return VEC_index (funct_state
, funct_state_vec
, node
->uid
) != NULL
;
215 /* Return the function state from NODE. */
217 static inline funct_state
218 get_function_state (struct cgraph_node
*node
)
221 || VEC_length (funct_state
, funct_state_vec
) <= (unsigned int)node
->uid
222 || !VEC_index (funct_state
, funct_state_vec
, node
->uid
))
223 /* We might want to put correct previously_known state into varying. */
224 return &varying_state
;
225 return VEC_index (funct_state
, funct_state_vec
, node
->uid
);
228 /* Set the function state S for NODE. */
231 set_function_state (struct cgraph_node
*node
, funct_state s
)
234 || VEC_length (funct_state
, funct_state_vec
) <= (unsigned int)node
->uid
)
235 VEC_safe_grow_cleared (funct_state
, heap
, funct_state_vec
, node
->uid
+ 1);
236 VEC_replace (funct_state
, funct_state_vec
, node
->uid
, s
);
239 /* Check to see if the use (or definition when CHECKING_WRITE is true)
240 variable T is legal in a function that is either pure or const. */
243 check_decl (funct_state local
,
244 tree t
, bool checking_write
, bool ipa
)
246 /* Do not want to do anything with volatile except mark any
247 function that uses one to be not const or pure. */
248 if (TREE_THIS_VOLATILE (t
))
250 local
->pure_const_state
= IPA_NEITHER
;
252 fprintf (dump_file
, " Volatile operand is not const/pure");
256 /* Do not care about a local automatic that is not static. */
257 if (!TREE_STATIC (t
) && !DECL_EXTERNAL (t
))
260 /* If the variable has the "used" attribute, treat it as if it had a
261 been touched by the devil. */
262 if (DECL_PRESERVE_P (t
))
264 local
->pure_const_state
= IPA_NEITHER
;
266 fprintf (dump_file
, " Used static/global variable is not const/pure\n");
270 /* In IPA mode we are not interested in checking actual loads and stores;
271 they will be processed at propagation time using ipa_ref. */
275 /* Since we have dealt with the locals and params cases above, if we
276 are CHECKING_WRITE, this cannot be a pure or constant
280 local
->pure_const_state
= IPA_NEITHER
;
282 fprintf (dump_file
, " static/global memory write is not const/pure\n");
286 if (DECL_EXTERNAL (t
) || TREE_PUBLIC (t
))
288 /* Readonly reads are safe. */
289 if (TREE_READONLY (t
) && !TYPE_NEEDS_CONSTRUCTING (TREE_TYPE (t
)))
290 return; /* Read of a constant, do not change the function state. */
294 fprintf (dump_file
, " global memory read is not const\n");
295 /* Just a regular read. */
296 if (local
->pure_const_state
== IPA_CONST
)
297 local
->pure_const_state
= IPA_PURE
;
302 /* Compilation level statics can be read if they are readonly
304 if (TREE_READONLY (t
))
308 fprintf (dump_file
, " static memory read is not const\n");
309 /* Just a regular read. */
310 if (local
->pure_const_state
== IPA_CONST
)
311 local
->pure_const_state
= IPA_PURE
;
316 /* Check to see if the use (or definition when CHECKING_WRITE is true)
317 variable T is legal in a function that is either pure or const. */
320 check_op (funct_state local
, tree t
, bool checking_write
)
322 t
= get_base_address (t
);
323 if (t
&& TREE_THIS_VOLATILE (t
))
325 local
->pure_const_state
= IPA_NEITHER
;
327 fprintf (dump_file
, " Volatile indirect ref is not const/pure\n");
331 && (INDIRECT_REF_P (t
) || TREE_CODE (t
) == MEM_REF
)
332 && TREE_CODE (TREE_OPERAND (t
, 0)) == SSA_NAME
333 && !ptr_deref_may_alias_global_p (TREE_OPERAND (t
, 0)))
336 fprintf (dump_file
, " Indirect ref to local memory is OK\n");
339 else if (checking_write
)
341 local
->pure_const_state
= IPA_NEITHER
;
343 fprintf (dump_file
, " Indirect ref write is not const/pure\n");
349 fprintf (dump_file
, " Indirect ref read is not const\n");
350 if (local
->pure_const_state
== IPA_CONST
)
351 local
->pure_const_state
= IPA_PURE
;
355 /* compute state based on ECF FLAGS and store to STATE and LOOPING. */
358 state_from_flags (enum pure_const_state_e
*state
, bool *looping
,
359 int flags
, bool cannot_lead_to_return
)
362 if (flags
& ECF_LOOPING_CONST_OR_PURE
)
365 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
366 fprintf (dump_file
, " looping");
368 if (flags
& ECF_CONST
)
371 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
372 fprintf (dump_file
, " const\n");
374 else if (flags
& ECF_PURE
)
377 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
378 fprintf (dump_file
, " pure\n");
380 else if (cannot_lead_to_return
)
384 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
385 fprintf (dump_file
, " ignoring side effects->pure looping\n");
389 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
390 fprintf (dump_file
, " neihter\n");
391 *state
= IPA_NEITHER
;
396 /* Merge STATE and STATE2 and LOOPING and LOOPING2 and store
397 into STATE and LOOPING better of the two variants.
398 Be sure to merge looping correctly. IPA_NEITHER functions
399 have looping 0 even if they don't have to return. */
402 better_state (enum pure_const_state_e
*state
, bool *looping
,
403 enum pure_const_state_e state2
, bool looping2
)
407 if (*state
== IPA_NEITHER
)
410 *looping
= MIN (*looping
, looping2
);
412 else if (state2
!= IPA_NEITHER
)
413 *looping
= MIN (*looping
, looping2
);
416 /* Merge STATE and STATE2 and LOOPING and LOOPING2 and store
417 into STATE and LOOPING worse of the two variants. */
420 worse_state (enum pure_const_state_e
*state
, bool *looping
,
421 enum pure_const_state_e state2
, bool looping2
)
423 *state
= MAX (*state
, state2
);
424 *looping
= MAX (*looping
, looping2
);
427 /* Recognize special cases of builtins that are by themselves not pure or const
428 but function using them is. */
430 special_builtin_state (enum pure_const_state_e
*state
, bool *looping
,
433 if (DECL_BUILT_IN_CLASS (callee
) == BUILT_IN_NORMAL
)
434 switch (DECL_FUNCTION_CODE (callee
))
436 case BUILT_IN_RETURN
:
437 case BUILT_IN_UNREACHABLE
:
438 case BUILT_IN_ALLOCA
:
439 case BUILT_IN_ALLOCA_WITH_ALIGN
:
440 case BUILT_IN_STACK_SAVE
:
441 case BUILT_IN_STACK_RESTORE
:
442 case BUILT_IN_EH_POINTER
:
443 case BUILT_IN_EH_FILTER
:
444 case BUILT_IN_UNWIND_RESUME
:
445 case BUILT_IN_CXA_END_CLEANUP
:
446 case BUILT_IN_EH_COPY_VALUES
:
447 case BUILT_IN_FRAME_ADDRESS
:
449 case BUILT_IN_APPLY_ARGS
:
453 case BUILT_IN_PREFETCH
:
461 /* Check the parameters of a function call to CALL_EXPR to see if
462 there are any references in the parameters that are not allowed for
463 pure or const functions. Also check to see if this is either an
464 indirect call, a call outside the compilation unit, or has special
465 attributes that may also effect the purity. The CALL_EXPR node for
466 the entire call expression. */
469 check_call (funct_state local
, gimple call
, bool ipa
)
471 int flags
= gimple_call_flags (call
);
472 tree callee_t
= gimple_call_fndecl (call
);
473 bool possibly_throws
= stmt_could_throw_p (call
);
474 bool possibly_throws_externally
= (possibly_throws
475 && stmt_can_throw_external (call
));
480 for (i
= 0; i
< gimple_num_ops (call
); i
++)
481 if (gimple_op (call
, i
)
482 && tree_could_throw_p (gimple_op (call
, i
)))
484 if (possibly_throws
&& cfun
->can_throw_non_call_exceptions
)
487 fprintf (dump_file
, " operand can throw; looping\n");
488 local
->looping
= true;
490 if (possibly_throws_externally
)
493 fprintf (dump_file
, " operand can throw externally\n");
494 local
->can_throw
= true;
499 /* The const and pure flags are set by a variety of places in the
500 compiler (including here). If someone has already set the flags
501 for the callee, (such as for some of the builtins) we will use
502 them, otherwise we will compute our own information.
504 Const and pure functions have less clobber effects than other
505 functions so we process these first. Otherwise if it is a call
506 outside the compilation unit or an indirect call we punt. This
507 leaves local calls which will be processed by following the call
511 enum pure_const_state_e call_state
;
514 if (special_builtin_state (&call_state
, &call_looping
, callee_t
))
516 worse_state (&local
->pure_const_state
, &local
->looping
,
517 call_state
, call_looping
);
520 /* When bad things happen to bad functions, they cannot be const
522 if (setjmp_call_p (callee_t
))
525 fprintf (dump_file
, " setjmp is not const/pure\n");
526 local
->looping
= true;
527 local
->pure_const_state
= IPA_NEITHER
;
530 if (DECL_BUILT_IN_CLASS (callee_t
) == BUILT_IN_NORMAL
)
531 switch (DECL_FUNCTION_CODE (callee_t
))
533 case BUILT_IN_LONGJMP
:
534 case BUILT_IN_NONLOCAL_GOTO
:
536 fprintf (dump_file
, " longjmp and nonlocal goto is not const/pure\n");
537 local
->pure_const_state
= IPA_NEITHER
;
538 local
->looping
= true;
545 /* When not in IPA mode, we can still handle self recursion. */
546 if (!ipa
&& callee_t
== current_function_decl
)
549 fprintf (dump_file
, " Recursive call can loop.\n");
550 local
->looping
= true;
552 /* Either callee is unknown or we are doing local analysis.
553 Look to see if there are any bits available for the callee (such as by
554 declaration or because it is builtin) and process solely on the basis of
558 enum pure_const_state_e call_state
;
560 if (possibly_throws
&& cfun
->can_throw_non_call_exceptions
)
563 fprintf (dump_file
, " can throw; looping\n");
564 local
->looping
= true;
566 if (possibly_throws_externally
)
570 fprintf (dump_file
, " can throw externally to lp %i\n",
571 lookup_stmt_eh_lp (call
));
573 fprintf (dump_file
, " callee:%s\n",
574 IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (callee_t
)));
576 local
->can_throw
= true;
578 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
579 fprintf (dump_file
, " checking flags for call:");
580 state_from_flags (&call_state
, &call_looping
, flags
,
581 ((flags
& (ECF_NORETURN
| ECF_NOTHROW
))
582 == (ECF_NORETURN
| ECF_NOTHROW
))
583 || (!flag_exceptions
&& (flags
& ECF_NORETURN
)));
584 worse_state (&local
->pure_const_state
, &local
->looping
,
585 call_state
, call_looping
);
587 /* Direct functions calls are handled by IPA propagation. */
590 /* Wrapper around check_decl for loads in local more. */
593 check_load (gimple stmt ATTRIBUTE_UNUSED
, tree op
, void *data
)
596 check_decl ((funct_state
)data
, op
, false, false);
598 check_op ((funct_state
)data
, op
, false);
602 /* Wrapper around check_decl for stores in local more. */
605 check_store (gimple stmt ATTRIBUTE_UNUSED
, tree op
, void *data
)
608 check_decl ((funct_state
)data
, op
, true, false);
610 check_op ((funct_state
)data
, op
, true);
614 /* Wrapper around check_decl for loads in ipa mode. */
617 check_ipa_load (gimple stmt ATTRIBUTE_UNUSED
, tree op
, void *data
)
620 check_decl ((funct_state
)data
, op
, false, true);
622 check_op ((funct_state
)data
, op
, false);
626 /* Wrapper around check_decl for stores in ipa mode. */
629 check_ipa_store (gimple stmt ATTRIBUTE_UNUSED
, tree op
, void *data
)
632 check_decl ((funct_state
)data
, op
, true, true);
634 check_op ((funct_state
)data
, op
, true);
638 /* Look into pointer pointed to by GSIP and figure out what interesting side
641 check_stmt (gimple_stmt_iterator
*gsip
, funct_state local
, bool ipa
)
643 gimple stmt
= gsi_stmt (*gsip
);
645 if (is_gimple_debug (stmt
))
650 fprintf (dump_file
, " scanning: ");
651 print_gimple_stmt (dump_file
, stmt
, 0, 0);
654 if (gimple_has_volatile_ops (stmt
)
655 && !gimple_clobber_p (stmt
))
657 local
->pure_const_state
= IPA_NEITHER
;
659 fprintf (dump_file
, " Volatile stmt is not const/pure\n");
662 /* Look for loads and stores. */
663 walk_stmt_load_store_ops (stmt
, local
,
664 ipa
? check_ipa_load
: check_load
,
665 ipa
? check_ipa_store
: check_store
);
667 if (gimple_code (stmt
) != GIMPLE_CALL
668 && stmt_could_throw_p (stmt
))
670 if (cfun
->can_throw_non_call_exceptions
)
673 fprintf (dump_file
, " can throw; looping");
674 local
->looping
= true;
676 if (stmt_can_throw_external (stmt
))
679 fprintf (dump_file
, " can throw externally");
680 local
->can_throw
= true;
683 switch (gimple_code (stmt
))
686 check_call (local
, stmt
, ipa
);
689 if (DECL_NONLOCAL (gimple_label_label (stmt
)))
690 /* Target of long jump. */
693 fprintf (dump_file
, " nonlocal label is not const/pure");
694 local
->pure_const_state
= IPA_NEITHER
;
698 if (gimple_asm_clobbers_memory_p (stmt
))
701 fprintf (dump_file
, " memory asm clobber is not const/pure");
702 /* Abandon all hope, ye who enter here. */
703 local
->pure_const_state
= IPA_NEITHER
;
705 if (gimple_asm_volatile_p (stmt
))
708 fprintf (dump_file
, " volatile is not const/pure");
709 /* Abandon all hope, ye who enter here. */
710 local
->pure_const_state
= IPA_NEITHER
;
711 local
->looping
= true;
720 /* This is the main routine for finding the reference patterns for
721 global variables within a function FN. */
724 analyze_function (struct cgraph_node
*fn
, bool ipa
)
726 tree decl
= fn
->symbol
.decl
;
727 tree old_decl
= current_function_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
));
755 current_function_decl
= decl
;
757 FOR_EACH_BB (this_block
)
759 gimple_stmt_iterator gsi
;
760 struct walk_stmt_info wi
;
762 memset (&wi
, 0, sizeof(wi
));
763 for (gsi
= gsi_start_bb (this_block
);
767 check_stmt (&gsi
, l
, ipa
);
768 if (l
->pure_const_state
== IPA_NEITHER
&& l
->looping
&& l
->can_throw
)
774 if (l
->pure_const_state
!= IPA_NEITHER
)
776 /* Const functions cannot have back edges (an
777 indication of possible infinite loop side
779 if (mark_dfs_back_edges ())
781 /* Preheaders are needed for SCEV to work.
782 Simple latches and recorded exits improve chances that loop will
783 proved to be finite in testcases such as in loop-15.c and loop-24.c */
784 loop_optimizer_init (LOOPS_NORMAL
785 | LOOPS_HAVE_RECORDED_EXITS
);
786 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
787 flow_loops_dump (dump_file
, NULL
, 0);
788 if (mark_irreducible_loops ())
791 fprintf (dump_file
, " has irreducible loops\n");
799 FOR_EACH_LOOP (li
, loop
, 0)
800 if (!finite_loop_p (loop
))
803 fprintf (dump_file
, " can not prove finiteness of loop %i\n", loop
->num
);
809 loop_optimizer_finalize ();
813 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
814 fprintf (dump_file
, " checking previously known:");
816 better_state (&l
->pure_const_state
, &l
->looping
,
817 l
->state_previously_known
,
818 l
->looping_previously_known
);
819 if (TREE_NOTHROW (decl
))
820 l
->can_throw
= false;
823 current_function_decl
= old_decl
;
827 fprintf (dump_file
, "Function is locally looping.\n");
829 fprintf (dump_file
, "Function is locally throwing.\n");
830 if (l
->pure_const_state
== IPA_CONST
)
831 fprintf (dump_file
, "Function is locally const.\n");
832 if (l
->pure_const_state
== IPA_PURE
)
833 fprintf (dump_file
, "Function is locally pure.\n");
838 /* Called when new function is inserted to callgraph late. */
840 add_new_function (struct cgraph_node
*node
, void *data ATTRIBUTE_UNUSED
)
842 if (cgraph_function_body_availability (node
) < AVAIL_OVERWRITABLE
)
844 /* There are some shared nodes, in particular the initializers on
845 static declarations. We do not need to scan them more than once
846 since all we would be interested in are the addressof
848 visited_nodes
= pointer_set_create ();
849 if (cgraph_function_body_availability (node
) > AVAIL_OVERWRITABLE
)
850 set_function_state (node
, analyze_function (node
, true));
851 pointer_set_destroy (visited_nodes
);
852 visited_nodes
= NULL
;
855 /* Called when new clone is inserted to callgraph late. */
858 duplicate_node_data (struct cgraph_node
*src
, struct cgraph_node
*dst
,
859 void *data ATTRIBUTE_UNUSED
)
861 if (has_function_state (src
))
863 funct_state l
= XNEW (struct funct_state_d
);
864 gcc_assert (!has_function_state (dst
));
865 memcpy (l
, get_function_state (src
), sizeof (*l
));
866 set_function_state (dst
, l
);
870 /* Called when new clone is inserted to callgraph late. */
873 remove_node_data (struct cgraph_node
*node
, void *data ATTRIBUTE_UNUSED
)
875 if (has_function_state (node
))
877 funct_state l
= get_function_state (node
);
878 if (l
!= &varying_state
)
880 set_function_state (node
, NULL
);
886 register_hooks (void)
888 static bool init_p
= false;
895 node_removal_hook_holder
=
896 cgraph_add_node_removal_hook (&remove_node_data
, NULL
);
897 node_duplication_hook_holder
=
898 cgraph_add_node_duplication_hook (&duplicate_node_data
, NULL
);
899 function_insertion_hook_holder
=
900 cgraph_add_function_insertion_hook (&add_new_function
, NULL
);
904 /* Analyze each function in the cgraph to see if it is locally PURE or
908 generate_summary (void)
910 struct cgraph_node
*node
;
914 /* There are some shared nodes, in particular the initializers on
915 static declarations. We do not need to scan them more than once
916 since all we would be interested in are the addressof
918 visited_nodes
= pointer_set_create ();
920 /* Process all of the functions.
922 We process AVAIL_OVERWRITABLE functions. We can not use the results
923 by default, but the info can be used at LTO with -fwhole-program or
924 when function got cloned and the clone is AVAILABLE. */
926 FOR_EACH_DEFINED_FUNCTION (node
)
927 if (cgraph_function_body_availability (node
) >= AVAIL_OVERWRITABLE
)
928 set_function_state (node
, analyze_function (node
, true));
930 pointer_set_destroy (visited_nodes
);
931 visited_nodes
= NULL
;
935 /* Serialize the ipa info for lto. */
938 pure_const_write_summary (cgraph_node_set set
,
939 varpool_node_set vset ATTRIBUTE_UNUSED
)
941 struct cgraph_node
*node
;
942 struct lto_simple_output_block
*ob
943 = lto_create_simple_output_block (LTO_section_ipa_pure_const
);
944 unsigned int count
= 0;
945 cgraph_node_set_iterator csi
;
947 for (csi
= csi_start (set
); !csi_end_p (csi
); csi_next (&csi
))
949 node
= csi_node (csi
);
950 if (node
->analyzed
&& has_function_state (node
))
954 streamer_write_uhwi_stream (ob
->main_stream
, count
);
956 /* Process all of the functions. */
957 for (csi
= csi_start (set
); !csi_end_p (csi
); csi_next (&csi
))
959 node
= csi_node (csi
);
960 if (node
->analyzed
&& has_function_state (node
))
965 lto_cgraph_encoder_t encoder
;
967 fs
= get_function_state (node
);
969 encoder
= ob
->decl_state
->cgraph_node_encoder
;
970 node_ref
= lto_cgraph_encoder_encode (encoder
, node
);
971 streamer_write_uhwi_stream (ob
->main_stream
, node_ref
);
973 /* Note that flags will need to be read in the opposite
974 order as we are pushing the bitflags into FLAGS. */
975 bp
= bitpack_create (ob
->main_stream
);
976 bp_pack_value (&bp
, fs
->pure_const_state
, 2);
977 bp_pack_value (&bp
, fs
->state_previously_known
, 2);
978 bp_pack_value (&bp
, fs
->looping_previously_known
, 1);
979 bp_pack_value (&bp
, fs
->looping
, 1);
980 bp_pack_value (&bp
, fs
->can_throw
, 1);
981 streamer_write_bitpack (&bp
);
985 lto_destroy_simple_output_block (ob
);
989 /* Deserialize the ipa info for lto. */
992 pure_const_read_summary (void)
994 struct lto_file_decl_data
**file_data_vec
= lto_get_file_decl_data ();
995 struct lto_file_decl_data
*file_data
;
999 while ((file_data
= file_data_vec
[j
++]))
1003 struct lto_input_block
*ib
1004 = lto_create_simple_input_block (file_data
,
1005 LTO_section_ipa_pure_const
,
1010 unsigned int count
= streamer_read_uhwi (ib
);
1012 for (i
= 0; i
< count
; i
++)
1015 struct cgraph_node
*node
;
1016 struct bitpack_d bp
;
1018 lto_cgraph_encoder_t encoder
;
1020 fs
= XCNEW (struct funct_state_d
);
1021 index
= streamer_read_uhwi (ib
);
1022 encoder
= file_data
->cgraph_node_encoder
;
1023 node
= lto_cgraph_encoder_deref (encoder
, index
);
1024 set_function_state (node
, fs
);
1026 /* Note that the flags must be read in the opposite
1027 order in which they were written (the bitflags were
1028 pushed into FLAGS). */
1029 bp
= streamer_read_bitpack (ib
);
1030 fs
->pure_const_state
1031 = (enum pure_const_state_e
) bp_unpack_value (&bp
, 2);
1032 fs
->state_previously_known
1033 = (enum pure_const_state_e
) bp_unpack_value (&bp
, 2);
1034 fs
->looping_previously_known
= bp_unpack_value (&bp
, 1);
1035 fs
->looping
= bp_unpack_value (&bp
, 1);
1036 fs
->can_throw
= bp_unpack_value (&bp
, 1);
1039 int flags
= flags_from_decl_or_type (node
->symbol
.decl
);
1040 fprintf (dump_file
, "Read info for %s/%i ",
1041 cgraph_node_name (node
),
1043 if (flags
& ECF_CONST
)
1044 fprintf (dump_file
, " const");
1045 if (flags
& ECF_PURE
)
1046 fprintf (dump_file
, " pure");
1047 if (flags
& ECF_NOTHROW
)
1048 fprintf (dump_file
, " nothrow");
1049 fprintf (dump_file
, "\n pure const state: %s\n",
1050 pure_const_names
[fs
->pure_const_state
]);
1051 fprintf (dump_file
, " previously known state: %s\n",
1052 pure_const_names
[fs
->looping_previously_known
]);
1054 fprintf (dump_file
," function is locally looping\n");
1055 if (fs
->looping_previously_known
)
1056 fprintf (dump_file
," function is previously known looping\n");
1058 fprintf (dump_file
," function is locally throwing\n");
1062 lto_destroy_simple_input_block (file_data
,
1063 LTO_section_ipa_pure_const
,
1071 ignore_edge (struct cgraph_edge
*e
)
1073 return (!e
->can_throw_external
);
1076 /* Return true if NODE is self recursive function.
1077 ??? self recursive and indirectly recursive funcions should
1078 be the same, so this function seems unnecesary. */
1081 self_recursive_p (struct cgraph_node
*node
)
1083 struct cgraph_edge
*e
;
1084 for (e
= node
->callees
; e
; e
= e
->next_callee
)
1085 if (cgraph_function_node (e
->callee
, NULL
) == node
)
1090 /* Produce transitive closure over the callgraph and compute pure/const
1094 propagate_pure_const (void)
1096 struct cgraph_node
*node
;
1097 struct cgraph_node
*w
;
1098 struct cgraph_node
**order
=
1099 XCNEWVEC (struct cgraph_node
*, cgraph_n_nodes
);
1102 struct ipa_dfs_info
* w_info
;
1104 order_pos
= ipa_reduced_postorder (order
, true, false, NULL
);
1107 dump_cgraph (dump_file
);
1108 ipa_print_order(dump_file
, "reduced", order
, order_pos
);
1111 /* Propagate the local information through the call graph to produce
1112 the global information. All the nodes within a cycle will have
1113 the same info so we collapse cycles first. Then we can do the
1114 propagation in one pass from the leaves to the roots. */
1115 for (i
= 0; i
< order_pos
; i
++ )
1117 enum pure_const_state_e pure_const_state
= IPA_CONST
;
1118 bool looping
= false;
1125 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1126 fprintf (dump_file
, "Starting cycle\n");
1128 /* Find the worst state for any node in the cycle. */
1130 while (w
&& pure_const_state
!= IPA_NEITHER
)
1132 struct cgraph_edge
*e
;
1133 struct cgraph_edge
*ie
;
1135 struct ipa_ref
*ref
;
1137 funct_state w_l
= get_function_state (w
);
1138 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1139 fprintf (dump_file
, " Visiting %s/%i state:%s looping %i\n",
1140 cgraph_node_name (w
),
1142 pure_const_names
[w_l
->pure_const_state
],
1145 /* First merge in function body properties. */
1146 worse_state (&pure_const_state
, &looping
,
1147 w_l
->pure_const_state
, w_l
->looping
);
1148 if (pure_const_state
== IPA_NEITHER
)
1151 /* For overwritable nodes we can not assume anything. */
1152 if (cgraph_function_body_availability (w
) == AVAIL_OVERWRITABLE
)
1154 worse_state (&pure_const_state
, &looping
,
1155 w_l
->state_previously_known
,
1156 w_l
->looping_previously_known
);
1157 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1160 " Overwritable. state %s looping %i\n",
1161 pure_const_names
[w_l
->state_previously_known
],
1162 w_l
->looping_previously_known
);
1169 /* We consider recursive cycles as possibly infinite.
1170 This might be relaxed since infinite recursion leads to stack
1175 /* Now walk the edges and merge in callee properties. */
1176 for (e
= w
->callees
; e
; e
= e
->next_callee
)
1178 enum availability avail
;
1179 struct cgraph_node
*y
= cgraph_function_node (e
->callee
, &avail
);
1180 enum pure_const_state_e edge_state
= IPA_CONST
;
1181 bool edge_looping
= false;
1183 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1187 cgraph_node_name (e
->callee
),
1190 if (avail
> AVAIL_OVERWRITABLE
)
1192 funct_state y_l
= get_function_state (y
);
1193 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1196 " state:%s looping:%i\n",
1197 pure_const_names
[y_l
->pure_const_state
],
1200 if (y_l
->pure_const_state
> IPA_PURE
1201 && cgraph_edge_cannot_lead_to_return (e
))
1203 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1205 " Ignoring side effects"
1206 " -> pure, looping\n");
1207 edge_state
= IPA_PURE
;
1208 edge_looping
= true;
1212 edge_state
= y_l
->pure_const_state
;
1213 edge_looping
= y_l
->looping
;
1216 else if (special_builtin_state (&edge_state
, &edge_looping
,
1220 state_from_flags (&edge_state
, &edge_looping
,
1221 flags_from_decl_or_type (y
->symbol
.decl
),
1222 cgraph_edge_cannot_lead_to_return (e
));
1224 /* Merge the results with what we already know. */
1225 better_state (&edge_state
, &edge_looping
,
1226 w_l
->state_previously_known
,
1227 w_l
->looping_previously_known
);
1228 worse_state (&pure_const_state
, &looping
,
1229 edge_state
, edge_looping
);
1230 if (pure_const_state
== IPA_NEITHER
)
1233 if (pure_const_state
== IPA_NEITHER
)
1236 /* Now process the indirect call. */
1237 for (ie
= w
->indirect_calls
; ie
; ie
= ie
->next_callee
)
1239 enum pure_const_state_e edge_state
= IPA_CONST
;
1240 bool edge_looping
= false;
1242 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1243 fprintf (dump_file
, " Indirect call");
1244 state_from_flags (&edge_state
, &edge_looping
,
1245 ie
->indirect_info
->ecf_flags
,
1246 cgraph_edge_cannot_lead_to_return (ie
));
1247 /* Merge the results with what we already know. */
1248 better_state (&edge_state
, &edge_looping
,
1249 w_l
->state_previously_known
,
1250 w_l
->looping_previously_known
);
1251 worse_state (&pure_const_state
, &looping
,
1252 edge_state
, edge_looping
);
1253 if (pure_const_state
== IPA_NEITHER
)
1256 if (pure_const_state
== IPA_NEITHER
)
1259 /* And finally all loads and stores. */
1260 for (i
= 0; ipa_ref_list_reference_iterate (&w
->symbol
.ref_list
, i
, ref
); i
++)
1262 enum pure_const_state_e ref_state
= IPA_CONST
;
1263 bool ref_looping
= false;
1267 /* readonly reads are safe. */
1268 if (TREE_READONLY (ipa_ref_varpool_node (ref
)->symbol
.decl
))
1270 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1271 fprintf (dump_file
, " nonreadonly global var read\n");
1272 ref_state
= IPA_PURE
;
1275 if (ipa_ref_cannot_lead_to_return (ref
))
1277 ref_state
= IPA_NEITHER
;
1278 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1279 fprintf (dump_file
, " global var write\n");
1284 better_state (&ref_state
, &ref_looping
,
1285 w_l
->state_previously_known
,
1286 w_l
->looping_previously_known
);
1287 worse_state (&pure_const_state
, &looping
,
1288 ref_state
, ref_looping
);
1289 if (pure_const_state
== IPA_NEITHER
)
1292 w_info
= (struct ipa_dfs_info
*) w
->symbol
.aux
;
1293 w
= w_info
->next_cycle
;
1295 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1296 fprintf (dump_file
, "Result %s looping %i\n",
1297 pure_const_names
[pure_const_state
],
1300 /* Copy back the region's pure_const_state which is shared by
1301 all nodes in the region. */
1305 funct_state w_l
= get_function_state (w
);
1306 enum pure_const_state_e this_state
= pure_const_state
;
1307 bool this_looping
= looping
;
1309 if (w_l
->state_previously_known
!= IPA_NEITHER
1310 && this_state
> w_l
->state_previously_known
)
1312 this_state
= w_l
->state_previously_known
;
1313 this_looping
|= w_l
->looping_previously_known
;
1315 if (!this_looping
&& self_recursive_p (w
))
1316 this_looping
= true;
1317 if (!w_l
->looping_previously_known
)
1318 this_looping
= false;
1320 /* All nodes within a cycle share the same info. */
1321 w_l
->pure_const_state
= this_state
;
1322 w_l
->looping
= this_looping
;
1327 if (!TREE_READONLY (w
->symbol
.decl
))
1329 warn_function_const (w
->symbol
.decl
, !this_looping
);
1331 fprintf (dump_file
, "Function found to be %sconst: %s\n",
1332 this_looping
? "looping " : "",
1333 cgraph_node_name (w
));
1335 cgraph_set_const_flag (w
, true, this_looping
);
1339 if (!DECL_PURE_P (w
->symbol
.decl
))
1341 warn_function_pure (w
->symbol
.decl
, !this_looping
);
1343 fprintf (dump_file
, "Function found to be %spure: %s\n",
1344 this_looping
? "looping " : "",
1345 cgraph_node_name (w
));
1347 cgraph_set_pure_flag (w
, true, this_looping
);
1353 w_info
= (struct ipa_dfs_info
*) w
->symbol
.aux
;
1354 w
= w_info
->next_cycle
;
1358 ipa_free_postorder_info ();
1362 /* Produce transitive closure over the callgraph and compute nothrow
1366 propagate_nothrow (void)
1368 struct cgraph_node
*node
;
1369 struct cgraph_node
*w
;
1370 struct cgraph_node
**order
=
1371 XCNEWVEC (struct cgraph_node
*, cgraph_n_nodes
);
1374 struct ipa_dfs_info
* w_info
;
1376 order_pos
= ipa_reduced_postorder (order
, true, false, ignore_edge
);
1379 dump_cgraph (dump_file
);
1380 ipa_print_order (dump_file
, "reduced for nothrow", order
, order_pos
);
1383 /* Propagate the local information through the call graph to produce
1384 the global information. All the nodes within a cycle will have
1385 the same info so we collapse cycles first. Then we can do the
1386 propagation in one pass from the leaves to the roots. */
1387 for (i
= 0; i
< order_pos
; i
++ )
1389 bool can_throw
= false;
1395 /* Find the worst state for any node in the cycle. */
1399 struct cgraph_edge
*e
, *ie
;
1400 funct_state w_l
= get_function_state (w
);
1403 || cgraph_function_body_availability (w
) == AVAIL_OVERWRITABLE
)
1409 for (e
= w
->callees
; e
; e
= e
->next_callee
)
1411 enum availability avail
;
1412 struct cgraph_node
*y
= cgraph_function_node (e
->callee
, &avail
);
1414 if (avail
> AVAIL_OVERWRITABLE
)
1416 funct_state y_l
= get_function_state (y
);
1420 if (y_l
->can_throw
&& !TREE_NOTHROW (w
->symbol
.decl
)
1421 && e
->can_throw_external
)
1424 else if (e
->can_throw_external
&& !TREE_NOTHROW (y
->symbol
.decl
))
1427 for (ie
= node
->indirect_calls
; ie
; ie
= ie
->next_callee
)
1428 if (ie
->can_throw_external
)
1430 w_info
= (struct ipa_dfs_info
*) w
->symbol
.aux
;
1431 w
= w_info
->next_cycle
;
1434 /* Copy back the region's pure_const_state which is shared by
1435 all nodes in the region. */
1439 funct_state w_l
= get_function_state (w
);
1440 if (!can_throw
&& !TREE_NOTHROW (w
->symbol
.decl
))
1442 cgraph_set_nothrow_flag (w
, true);
1444 fprintf (dump_file
, "Function found to be nothrow: %s\n",
1445 cgraph_node_name (w
));
1447 else if (can_throw
&& !TREE_NOTHROW (w
->symbol
.decl
))
1448 w_l
->can_throw
= true;
1449 w_info
= (struct ipa_dfs_info
*) w
->symbol
.aux
;
1450 w
= w_info
->next_cycle
;
1454 ipa_free_postorder_info ();
1459 /* Produce the global information by preforming a transitive closure
1460 on the local information that was produced by generate_summary. */
1465 struct cgraph_node
*node
;
1467 cgraph_remove_function_insertion_hook (function_insertion_hook_holder
);
1468 cgraph_remove_node_duplication_hook (node_duplication_hook_holder
);
1469 cgraph_remove_node_removal_hook (node_removal_hook_holder
);
1471 /* Nothrow makes more function to not lead to return and improve
1473 propagate_nothrow ();
1474 propagate_pure_const ();
1477 FOR_EACH_DEFINED_FUNCTION (node
)
1478 if (has_function_state (node
))
1479 free (get_function_state (node
));
1480 VEC_free (funct_state
, heap
, funct_state_vec
);
1486 gate_pure_const (void)
1488 return (flag_ipa_pure_const
1489 /* Don't bother doing anything if the program has errors. */
1493 struct ipa_opt_pass_d pass_ipa_pure_const
=
1497 "pure-const", /* name */
1498 gate_pure_const
, /* gate */
1499 propagate
, /* execute */
1502 0, /* static_pass_number */
1503 TV_IPA_PURE_CONST
, /* tv_id */
1504 0, /* properties_required */
1505 0, /* properties_provided */
1506 0, /* properties_destroyed */
1507 0, /* todo_flags_start */
1508 0 /* todo_flags_finish */
1510 generate_summary
, /* generate_summary */
1511 pure_const_write_summary
, /* write_summary */
1512 pure_const_read_summary
, /* read_summary */
1513 NULL
, /* write_optimization_summary */
1514 NULL
, /* read_optimization_summary */
1515 NULL
, /* stmt_fixup */
1517 NULL
, /* function_transform */
1518 NULL
/* variable_transform */
1521 /* Return true if function should be skipped for local pure const analysis. */
1524 skip_function_for_local_pure_const (struct cgraph_node
*node
)
1526 /* Because we do not schedule pass_fixup_cfg over whole program after early optimizations
1527 we must not promote functions that are called by already processed functions. */
1529 if (function_called_by_processed_nodes_p ())
1532 fprintf (dump_file
, "Function called in recursive cycle; ignoring\n");
1535 if (cgraph_function_body_availability (node
) <= AVAIL_OVERWRITABLE
)
1538 fprintf (dump_file
, "Function is not available or overwritable; not analyzing.\n");
1544 /* Simple local pass for pure const discovery reusing the analysis from
1545 ipa_pure_const. This pass is effective when executed together with
1546 other optimization passes in early optimization pass queue. */
1549 local_pure_const (void)
1551 bool changed
= false;
1554 struct cgraph_node
*node
;
1556 node
= cgraph_get_node (current_function_decl
);
1557 skip
= skip_function_for_local_pure_const (node
);
1558 if (!warn_suggest_attribute_const
1559 && !warn_suggest_attribute_pure
1563 l
= analyze_function (node
, false);
1565 /* Do NORETURN discovery. */
1566 if (!skip
&& !TREE_THIS_VOLATILE (current_function_decl
)
1567 && EDGE_COUNT (EXIT_BLOCK_PTR
->preds
) == 0)
1569 warn_function_noreturn (cfun
->decl
);
1571 fprintf (dump_file
, "Function found to be noreturn: %s\n",
1572 lang_hooks
.decl_printable_name (current_function_decl
, 2));
1574 /* Update declaration and reduce profile to executed once. */
1575 TREE_THIS_VOLATILE (current_function_decl
) = 1;
1576 if (node
->frequency
> NODE_FREQUENCY_EXECUTED_ONCE
)
1577 node
->frequency
= NODE_FREQUENCY_EXECUTED_ONCE
;
1582 switch (l
->pure_const_state
)
1585 if (!TREE_READONLY (current_function_decl
))
1587 warn_function_const (current_function_decl
, !l
->looping
);
1590 cgraph_set_const_flag (node
, true, l
->looping
);
1594 fprintf (dump_file
, "Function found to be %sconst: %s\n",
1595 l
->looping
? "looping " : "",
1596 lang_hooks
.decl_printable_name (current_function_decl
,
1599 else if (DECL_LOOPING_CONST_OR_PURE_P (current_function_decl
)
1604 cgraph_set_const_flag (node
, true, false);
1608 fprintf (dump_file
, "Function found to be non-looping: %s\n",
1609 lang_hooks
.decl_printable_name (current_function_decl
,
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 lang_hooks
.decl_printable_name (current_function_decl
,
1629 else if (DECL_LOOPING_CONST_OR_PURE_P (current_function_decl
)
1634 cgraph_set_pure_flag (node
, true, false);
1638 fprintf (dump_file
, "Function found to be non-looping: %s\n",
1639 lang_hooks
.decl_printable_name (current_function_decl
,
1647 if (!l
->can_throw
&& !TREE_NOTHROW (current_function_decl
))
1649 cgraph_set_nothrow_flag (node
, true);
1652 fprintf (dump_file
, "Function found to be nothrow: %s\n",
1653 lang_hooks
.decl_printable_name (current_function_decl
,
1658 return execute_fixup_cfg ();
1663 struct gimple_opt_pass pass_local_pure_const
=
1667 "local-pure-const", /* name */
1668 gate_pure_const
, /* gate */
1669 local_pure_const
, /* execute */
1672 0, /* static_pass_number */
1673 TV_IPA_PURE_CONST
, /* tv_id */
1674 0, /* properties_required */
1675 0, /* properties_provided */
1676 0, /* properties_destroyed */
1677 0, /* todo_flags_start */
1678 0 /* todo_flags_finish */