1 /* A class to encapsulate decisions about how the analysis should happen.
2 Copyright (C) 2019-2023 Free Software Foundation, Inc.
3 Contributed by David Malcolm <dmalcolm@redhat.com>.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GCC is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License 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/>. */
22 #define INCLUDE_MEMORY
24 #include "coretypes.h"
29 #include "ipa-utils.h"
31 #include "analyzer/analyzer.h"
32 #include "diagnostic-core.h"
33 #include "analyzer/analyzer-logging.h"
34 #include "analyzer/analysis-plan.h"
35 #include "ordered-hash-map.h"
39 #include "basic-block.h"
41 #include "gimple-iterator.h"
43 #include "analyzer/supergraph.h"
47 /* class analysis_plan. */
49 /* analysis_plan's ctor. */
51 analysis_plan::analysis_plan (const supergraph
&sg
, logger
*logger
)
52 : log_user (logger
), m_sg (sg
),
53 m_cgraph_node_postorder (XCNEWVEC (struct cgraph_node
*,
54 symtab
->cgraph_count
)),
55 m_index_by_uid (symtab
->cgraph_max_uid
)
58 auto_timevar
time (TV_ANALYZER_PLAN
);
60 m_num_cgraph_nodes
= ipa_reverse_postorder (m_cgraph_node_postorder
);
61 gcc_assert (m_num_cgraph_nodes
== symtab
->cgraph_count
);
62 if (get_logger_file ())
63 ipa_print_order (get_logger_file (),
64 "analysis_plan", m_cgraph_node_postorder
,
67 /* Populate m_index_by_uid. */
68 for (int i
= 0; i
< symtab
->cgraph_max_uid
; i
++)
69 m_index_by_uid
.quick_push (-1);
70 for (int i
= 0; i
< m_num_cgraph_nodes
; i
++)
72 gcc_assert (m_cgraph_node_postorder
[i
]->get_uid ()
73 < symtab
->cgraph_max_uid
);
74 m_index_by_uid
[m_cgraph_node_postorder
[i
]->get_uid ()] = i
;
78 /* analysis_plan's dtor. */
80 analysis_plan::~analysis_plan ()
82 free (m_cgraph_node_postorder
);
85 /* Comparator for use by the exploded_graph's worklist, to order FUN_A
86 and FUN_B so that functions that are to be summarized are visited
87 before the summary is needed (based on a sort of the callgraph). */
90 analysis_plan::cmp_function (function
*fun_a
, function
*fun_b
) const
92 cgraph_node
*node_a
= cgraph_node::get (fun_a
->decl
);
93 cgraph_node
*node_b
= cgraph_node::get (fun_b
->decl
);
95 int idx_a
= m_index_by_uid
[node_a
->get_uid ()];
96 int idx_b
= m_index_by_uid
[node_b
->get_uid ()];
101 /* Return true if the call EDGE should be analyzed using a call summary.
102 Return false if it should be analyzed using a full call and return. */
105 analysis_plan::use_summary_p (const cgraph_edge
*edge
) const
107 /* Don't use call summaries if -fno-analyzer-call-summaries. */
108 if (!flag_analyzer_call_summaries
)
111 /* Don't use call summaries if there is no callgraph edge */
112 if (!edge
|| !edge
->callee
)
115 /* TODO: don't count callsites each time. */
116 int num_call_sites
= 0;
117 const cgraph_node
*callee
= edge
->callee
;
118 for (cgraph_edge
*edge
= callee
->callers
; edge
; edge
= edge
->next_caller
)
121 /* Don't use a call summary if there's only one call site. */
122 if (num_call_sites
<= 1)
125 /* Require the callee to be sufficiently complex to be worth
128 = const_cast <cgraph_node
*> (callee
)->ultimate_alias_target ()->get_fun ();
129 /* TODO(stage1): can ultimate_alias_target be made const? */
131 if ((int)m_sg
.get_num_snodes (fun
)
132 < param_analyzer_min_snodes_for_call_summary
)
138 #endif /* #if ENABLE_ANALYZER */