GCC Middle and Back End API Reference
checker-path.h
Go to the documentation of this file.
1/* Subclass of diagnostic_path for analyzer diagnostics.
2 Copyright (C) 2019-2024 Free Software Foundation, Inc.
3 Contributed by David Malcolm <dmalcolm@redhat.com>.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it
8under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 3, or (at your option)
10any later version.
11
12GCC is distributed in the hope that it will be useful, but
13WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21#ifndef GCC_ANALYZER_CHECKER_PATH_H
22#define GCC_ANALYZER_CHECKER_PATH_H
23
26
27namespace ana {
28
29/* Subclass of diagnostic_path for analyzer diagnostics. */
30
32{
33public:
35 : diagnostic_path (),
36 m_thread ("main"),
38 {}
39
40 /* Implementation of diagnostic_path vfuncs. */
41
42 unsigned num_events () const final override
43 {
44 return m_events.length ();
45 }
46
47 const diagnostic_event & get_event (int idx) const final override
48 {
49 return *m_events[idx];
50 }
51 unsigned num_threads () const final override
52 {
53 return 1;
54 }
55 const diagnostic_thread &
56 get_thread (diagnostic_thread_id_t) const final override
57 {
58 return m_thread;
59 }
60
62 {
63 return m_events[idx];
64 }
65
66 bool
67 same_function_p (int event_idx_a,
68 int event_idx_b) const final override;
69
70 void dump (pretty_printer *pp) const;
71 void debug () const;
72
73 logger *get_logger () const { return m_logger; }
74 void maybe_log (logger *logger, const char *desc) const;
75
76 void add_event (std::unique_ptr<checker_event> event);
77
78 void delete_event (int idx)
79 {
80 checker_event *event = m_events[idx];
81 m_events.ordered_remove (idx);
82 delete event;
83 }
84
85 void delete_events (unsigned start_idx, unsigned len)
86 {
87 for (unsigned i = start_idx; i < start_idx + len; i++)
88 delete m_events[i];
89 m_events.block_remove (start_idx, len);
90 }
91
92 void replace_event (unsigned idx, checker_event *new_event)
93 {
94 delete m_events[idx];
95 m_events[idx] = new_event;
96 }
97
99 const region *reg,
100 const region_model *model,
101 const event_loc_info &loc_info,
102 bool debug);
103
104 /* After all event-pruning, a hook for notifying each event what
105 its ID will be. The events are notified in order, allowing
106 for later events to refer to the IDs of earlier events in
107 their descriptions. */
109 {
110 checker_event *e;
111 int i;
114 }
115
117
119 diagnostic_event_id_t setjmp_emission_id)
120 {
121 m_setjmp_event_ids.put (enode, setjmp_emission_id);
122 }
123
124 bool get_setjmp_event (const exploded_node *enode,
125 diagnostic_event_id_t *out_emission_id)
126 {
127 if (diagnostic_event_id_t *emission_id = m_setjmp_event_ids.get (enode))
128 {
129 *out_emission_id = *emission_id;
130 return true;
131 }
132 return false;
133 }
134
135 bool cfg_edge_pair_at_p (unsigned idx) const;
136
138
139private:
141
143
144 /* The events that have occurred along this path. */
146
147 /* During prepare_for_emission (and after), the setjmp_event for each
148 exploded_node *, so that rewind events can refer to them in their
149 descriptions. */
150 hash_map <const exploded_node *, diagnostic_event_id_t> m_setjmp_event_ids;
151
153};
154
155} // namespace ana
156
157#endif /* GCC_ANALYZER_CHECKER_PATH_H */
Definition checker-event.h:89
virtual void prepare_for_emission(checker_path *, pending_diagnostic *pd, diagnostic_event_id_t emission_id)
Definition checker-path.h:32
void delete_events(unsigned start_idx, unsigned len)
Definition checker-path.h:85
void add_region_creation_events(pending_diagnostic *pd, const region *reg, const region_model *model, const event_loc_info &loc_info, bool debug)
void prepare_for_emission(pending_diagnostic *pd)
Definition checker-path.h:108
void inject_any_inlined_call_events(logger *logger)
void maybe_log(logger *logger, const char *desc) const
const diagnostic_event & get_event(int idx) const final override
Definition checker-path.h:47
bool get_setjmp_event(const exploded_node *enode, diagnostic_event_id_t *out_emission_id)
Definition checker-path.h:124
hash_map< const exploded_node *, diagnostic_event_id_t > m_setjmp_event_ids
Definition checker-path.h:150
auto_delete_vec< checker_event > m_events
Definition checker-path.h:145
const diagnostic_thread & get_thread(diagnostic_thread_id_t) const final override
Definition checker-path.h:56
void debug() const
bool same_function_p(int event_idx_a, int event_idx_b) const final override
unsigned num_threads() const final override
Definition checker-path.h:51
DISABLE_COPY_AND_ASSIGN(checker_path)
checker_path(logger *logger)
Definition checker-path.h:34
logger * m_logger
Definition checker-path.h:152
void record_setjmp_event(const exploded_node *enode, diagnostic_event_id_t setjmp_emission_id)
Definition checker-path.h:118
void add_event(std::unique_ptr< checker_event > event)
void replace_event(unsigned idx, checker_event *new_event)
Definition checker-path.h:92
unsigned num_events() const final override
Definition checker-path.h:42
void dump(pretty_printer *pp) const
logger * get_logger() const
Definition checker-path.h:73
checker_event * get_checker_event(int idx)
Definition checker-path.h:61
bool cfg_edge_pair_at_p(unsigned idx) const
simple_diagnostic_thread m_thread
Definition checker-path.h:142
void fixup_locations(pending_diagnostic *pd)
void delete_event(int idx)
Definition checker-path.h:78
Definition exploded-graph.h:203
Definition analyzer-logging.h:34
Definition pending-diagnostic.h:208
Definition region-model.h:263
Definition region.h:126
Definition vec.h:1802
Definition diagnostic-event-id.h:37
Definition diagnostic-path.h:70
Definition diagnostic-path.h:186
Definition diagnostic-path.h:177
Definition pretty-print.h:255
Definition simple-diagnostic-path.h:86
unsigned diagnostic_thread_id_t
Definition diagnostic-event-id.h:64
void final(rtx_insn *first, FILE *file, int optimize_p)
Definition final.cc:2002
Definition access-diagram.h:30
i
Definition poly-int.h:772
Definition event-loc-info.h:29
#define FOR_EACH_VEC_ELT(V, I, P)
Definition vec.h:1884