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>. 4 5 This file is part of GCC. 6 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) 10 any later version. 11 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. 16 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/>. */ 20 21 #ifndef GCC_ANALYZER_DIAGNOSTIC_MANAGER_H 22 #define GCC_ANALYZER_DIAGNOSTIC_MANAGER_H 23 24 namespace ana { 25 26 class epath_finder; 27 28 /* A to-be-emitted diagnostic stored within diagnostic_manager. */ 29 30 class saved_diagnostic 31 { 32 public: 33 saved_diagnostic (const state_machine *sm, 34 const exploded_node *enode, 35 const supernode *snode, const gimple *stmt, 36 stmt_finder *stmt_finder, 37 tree var, const svalue *sval, 38 state_machine::state_t state, 39 pending_diagnostic *d, 40 unsigned idx); 41 ~saved_diagnostic (); 42 43 bool operator== (const saved_diagnostic &other) const; 44 45 void add_note (pending_note *pn); 46 47 json::object *to_json () const; 48 49 void dump_dot_id (pretty_printer *pp) const; 50 void dump_as_dot_node (pretty_printer *pp) const; 51 get_feasibility_problem()52 const feasibility_problem *get_feasibility_problem () const 53 { 54 return m_problem; 55 } 56 57 bool calc_best_epath (epath_finder *pf); get_best_epath()58 const exploded_path *get_best_epath () const { return m_best_epath; } 59 unsigned get_epath_length () const; 60 61 void add_duplicate (saved_diagnostic *other); get_num_dupes()62 unsigned get_num_dupes () const { return m_duplicates.length (); } 63 get_index()64 unsigned get_index () const { return m_idx; } 65 66 bool supercedes_p (const saved_diagnostic &other) const; 67 68 void emit_any_notes () const; 69 70 //private: 71 const state_machine *m_sm; 72 const exploded_node *m_enode; 73 const supernode *m_snode; 74 const gimple *m_stmt; 75 stmt_finder *m_stmt_finder; 76 tree m_var; 77 const svalue *m_sval; 78 state_machine::state_t m_state; 79 pending_diagnostic *m_d; // owned 80 const exploded_edge *m_trailing_eedge; 81 82 private: 83 DISABLE_COPY_AND_ASSIGN (saved_diagnostic); 84 85 unsigned m_idx; 86 exploded_path *m_best_epath; // owned 87 feasibility_problem *m_problem; // owned 88 89 auto_vec<const saved_diagnostic *> m_duplicates; 90 auto_delete_vec <pending_note> m_notes; 91 }; 92 93 class path_builder; 94 95 /* A class with responsibility for saving pending diagnostics, so that 96 they can be emitted after the exploded_graph is complete. 97 This lets us de-duplicate diagnostics, and find the shortest path 98 for each similar diagnostic, potentially using edges that might 99 not have been found when each diagnostic was first saved. 100 101 This also lets us compute shortest_paths once, rather than 102 per-diagnostic. */ 103 104 class diagnostic_manager : public log_user 105 { 106 public: 107 diagnostic_manager (logger *logger, engine *eng, int verbosity); 108 get_engine()109 engine *get_engine () const { return m_eng; } 110 111 json::object *to_json () const; 112 113 bool add_diagnostic (const state_machine *sm, 114 exploded_node *enode, 115 const supernode *snode, const gimple *stmt, 116 stmt_finder *finder, 117 tree var, 118 const svalue *sval, 119 state_machine::state_t state, 120 pending_diagnostic *d); 121 122 bool add_diagnostic (exploded_node *enode, 123 const supernode *snode, const gimple *stmt, 124 stmt_finder *finder, 125 pending_diagnostic *d); 126 127 void add_note (pending_note *pn); 128 129 void emit_saved_diagnostics (const exploded_graph &eg); 130 131 void emit_saved_diagnostic (const exploded_graph &eg, 132 const saved_diagnostic &sd); 133 get_num_diagnostics()134 unsigned get_num_diagnostics () const 135 { 136 return m_saved_diagnostics.length (); 137 } get_saved_diagnostic(unsigned idx)138 saved_diagnostic *get_saved_diagnostic (unsigned idx) 139 { 140 return m_saved_diagnostics[idx]; 141 } get_saved_diagnostic(unsigned idx)142 const saved_diagnostic *get_saved_diagnostic (unsigned idx) const 143 { 144 return m_saved_diagnostics[idx]; 145 } 146 147 private: 148 void build_emission_path (const path_builder &pb, 149 const exploded_path &epath, 150 checker_path *emission_path) const; 151 152 void add_events_for_eedge (const path_builder &pb, 153 const exploded_edge &eedge, 154 checker_path *emission_path, 155 interesting_t *interest) const; 156 157 bool significant_edge_p (const path_builder &pb, 158 const exploded_edge &eedge) const; 159 160 void add_events_for_superedge (const path_builder &pb, 161 const exploded_edge &eedge, 162 checker_path *emission_path) const; 163 164 void prune_path (checker_path *path, 165 const state_machine *sm, 166 const svalue *sval, 167 state_machine::state_t state) const; 168 169 void prune_for_sm_diagnostic (checker_path *path, 170 const state_machine *sm, 171 tree var, 172 state_machine::state_t state) const; 173 void prune_for_sm_diagnostic (checker_path *path, 174 const state_machine *sm, 175 const svalue *sval, 176 state_machine::state_t state) const; 177 void update_for_unsuitable_sm_exprs (tree *expr) const; 178 void prune_interproc_events (checker_path *path) const; 179 void consolidate_conditions (checker_path *path) const; 180 void finish_pruning (checker_path *path) const; 181 182 engine *m_eng; 183 auto_delete_vec<saved_diagnostic> m_saved_diagnostics; 184 const int m_verbosity; 185 int m_num_disabled_diagnostics; 186 }; 187 188 } // namespace ana 189 190 #endif /* GCC_ANALYZER_DIAGNOSTIC_MANAGER_H */ 191