1 /* Classes for saving, deduplicating, and emitting analyzer diagnostics.
2 Copyright (C) 2019-2022 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/>. */
21 #ifndef GCC_ANALYZER_DIAGNOSTIC_MANAGER_H
22 #define GCC_ANALYZER_DIAGNOSTIC_MANAGER_H
28 /* A to-be-emitted diagnostic stored within diagnostic_manager. */
30 class saved_diagnostic
33 saved_diagnostic (const state_machine
*sm
,
34 const exploded_node
*enode
,
35 const supernode
*snode
, const gimple
*stmt
,
36 const stmt_finder
*stmt_finder
,
37 tree var
, const svalue
*sval
,
38 state_machine::state_t state
,
39 std::unique_ptr
<pending_diagnostic
> d
,
42 bool operator== (const saved_diagnostic
&other
) const;
44 void add_note (std::unique_ptr
<pending_note
> pn
);
46 json::object
*to_json () const;
48 void dump_dot_id (pretty_printer
*pp
) const;
49 void dump_as_dot_node (pretty_printer
*pp
) const;
51 const feasibility_problem
*get_feasibility_problem () const
53 return m_problem
.get ();
56 bool calc_best_epath (epath_finder
*pf
);
57 const exploded_path
*get_best_epath () const { return m_best_epath
.get (); }
58 unsigned get_epath_length () const;
60 void add_duplicate (saved_diagnostic
*other
);
61 unsigned get_num_dupes () const { return m_duplicates
.length (); }
63 unsigned get_index () const { return m_idx
; }
65 bool supercedes_p (const saved_diagnostic
&other
) const;
67 void emit_any_notes () const;
70 const state_machine
*m_sm
;
71 const exploded_node
*m_enode
;
72 const supernode
*m_snode
;
74 std::unique_ptr
<stmt_finder
> m_stmt_finder
;
77 state_machine::state_t m_state
;
78 std::unique_ptr
<pending_diagnostic
> m_d
;
79 const exploded_edge
*m_trailing_eedge
;
82 DISABLE_COPY_AND_ASSIGN (saved_diagnostic
);
85 std::unique_ptr
<exploded_path
> m_best_epath
;
86 std::unique_ptr
<feasibility_problem
> m_problem
;
88 auto_vec
<const saved_diagnostic
*> m_duplicates
;
89 auto_delete_vec
<pending_note
> m_notes
;
94 /* A class with responsibility for saving pending diagnostics, so that
95 they can be emitted after the exploded_graph is complete.
96 This lets us de-duplicate diagnostics, and find the shortest path
97 for each similar diagnostic, potentially using edges that might
98 not have been found when each diagnostic was first saved.
100 This also lets us compute shortest_paths once, rather than
103 class diagnostic_manager
: public log_user
106 diagnostic_manager (logger
*logger
, engine
*eng
, int verbosity
);
108 engine
*get_engine () const { return m_eng
; }
110 json::object
*to_json () const;
112 bool add_diagnostic (const state_machine
*sm
,
113 exploded_node
*enode
,
114 const supernode
*snode
, const gimple
*stmt
,
115 const stmt_finder
*finder
,
118 state_machine::state_t state
,
119 std::unique_ptr
<pending_diagnostic
> d
);
121 bool add_diagnostic (exploded_node
*enode
,
122 const supernode
*snode
, const gimple
*stmt
,
123 const stmt_finder
*finder
,
124 std::unique_ptr
<pending_diagnostic
> d
);
126 void add_note (std::unique_ptr
<pending_note
> pn
);
128 void emit_saved_diagnostics (const exploded_graph
&eg
);
130 void emit_saved_diagnostic (const exploded_graph
&eg
,
131 const saved_diagnostic
&sd
);
133 unsigned get_num_diagnostics () const
135 return m_saved_diagnostics
.length ();
137 saved_diagnostic
*get_saved_diagnostic (unsigned idx
)
139 return m_saved_diagnostics
[idx
];
141 const saved_diagnostic
*get_saved_diagnostic (unsigned idx
) const
143 return m_saved_diagnostics
[idx
];
147 void build_emission_path (const path_builder
&pb
,
148 const exploded_path
&epath
,
149 checker_path
*emission_path
) const;
151 void add_event_on_final_node (const exploded_node
*final_enode
,
152 checker_path
*emission_path
,
153 interesting_t
*interest
) const;
155 void add_events_for_eedge (const path_builder
&pb
,
156 const exploded_edge
&eedge
,
157 checker_path
*emission_path
,
158 interesting_t
*interest
) const;
160 bool significant_edge_p (const path_builder
&pb
,
161 const exploded_edge
&eedge
) const;
163 void add_events_for_superedge (const path_builder
&pb
,
164 const exploded_edge
&eedge
,
165 checker_path
*emission_path
) const;
167 void prune_path (checker_path
*path
,
168 const state_machine
*sm
,
170 state_machine::state_t state
) const;
172 void prune_for_sm_diagnostic (checker_path
*path
,
173 const state_machine
*sm
,
175 state_machine::state_t state
) const;
176 void prune_for_sm_diagnostic (checker_path
*path
,
177 const state_machine
*sm
,
179 state_machine::state_t state
) const;
180 void update_for_unsuitable_sm_exprs (tree
*expr
) const;
181 void prune_interproc_events (checker_path
*path
) const;
182 void consolidate_conditions (checker_path
*path
) const;
183 void finish_pruning (checker_path
*path
) const;
186 auto_delete_vec
<saved_diagnostic
> m_saved_diagnostics
;
187 const int m_verbosity
;
188 int m_num_disabled_diagnostics
;
193 #endif /* GCC_ANALYZER_DIAGNOSTIC_MANAGER_H */