GCC Middle and Back End API Reference
call-string.h
Go to the documentation of this file.
1/* Call stacks at program points.
2 Copyright (C) 2019-2026 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_CALL_STRING_H
22#define GCC_ANALYZER_CALL_STRING_H
23
24#include "text-art/widget.h"
26
27namespace ana {
28
29class supergraph;
30class supernode;
32
33/* A string of "elements" representing a call stack at a program point.
34
35 This is used to ensure that we generate interprocedurally valid paths
36 i.e. that we return to the same callsite that called us.
37
38 Instances of call_string are consolidated by the region_model_manager,
39 which effectively owns them: it owns the root/empty call_string, and each
40 call_string instance tracks its children, lazily creating them on demand,
41 so that the call_string instances form a tree-like hierarchy in memory. */
42
44{
45public:
46 /* A struct representing an element in the call_string.
47
48 Each element represents a "call superedge" within the caller for which
49 the op was a call_and_return_op.
50 Returning from the callee to the caller will involve creating a custom
51 exploded edge from the exit supernode in the callee to the destination
52 of the call superedge within the caller. */
53
54 struct element_t
55 {
56 element_t (const superedge *call_sedge,
57 const call_and_return_op *call_op,
58 function *called_fun)
59 : m_call_sedge (call_sedge), m_call_op (call_op),
60 m_called_fun (called_fun)
61 {
62 }
63
64 bool operator== (const element_t &other) const;
65 bool operator!= (const element_t &other) const;
66
67 static int cmp (const element_t &a, const element_t &b);
68
69 /* Accessors */
74 const gcall &get_call_stmt () const;
75
76 std::unique_ptr<text_art::tree_widget>
78
82 };
83
84 void print (pretty_printer *pp) const;
85
86 std::unique_ptr<json::value> to_json () const;
87
88 bool empty_p () const { return m_elements.is_empty (); }
89
90 const call_string *push_call (const superedge &call_sedge,
91 const call_and_return_op &call_op,
92 function &called_fun) const;
93 const call_string *get_parent () const { return m_parent; }
94
96
97 static int cmp (const call_string &a,
98 const call_string &b);
99
100 static int cmp_ptr_ptr (const void *, const void *);
101
102 /* Accessors */
104 unsigned length () const { return m_elements.length (); }
105 element_t operator[] (unsigned idx) const
106 {
107 return m_elements[idx];
108 }
110 {
111 gcc_assert (m_elements.length () > 0);
112 return m_elements[m_elements.length () - 1];
113 }
114
116
117 void validate () const;
118
119 std::unique_ptr<text_art::tree_widget>
121
122private:
124 {
126 typedef const call_string *value_type;
127
128 static const bool maybe_mx = false;
129 static inline hashval_t hash (const key_type &k)
130 {
131 inchash::hash hstate;
132 hstate.add_ptr (k.m_call_sedge);
133 return hstate.end ();
134 }
135 static inline bool equal_keys (const key_type &k1, const key_type &k2)
136 {
137 return k1 == k2;
138 }
139 template <typename T> static inline void remove (T &entry)
140 {
141 entry.m_key = element_t (nullptr, nullptr, nullptr);
142 }
143 static const bool empty_zero_p = true;
144 template <typename T> static inline bool is_empty (const T &entry)
145 {
146 return entry.m_key.m_call_sedge == nullptr;
147 }
148 template <typename T> static inline bool is_deleted (const T &entry)
149 {
150 return entry.m_key.m_call_sedge == reinterpret_cast<const superedge *> (1);
151 }
152 template <typename T> static inline void mark_empty (T &entry)
153 {
154 entry.m_key = element_t (nullptr, nullptr, nullptr);
155 entry.m_value = nullptr;
156 }
157 template <typename T> static inline void mark_deleted (T &entry)
158 {
159 entry.m_key.m_call_sedge = reinterpret_cast<const superedge *> (1);
160 }
161 };
162
164
166
168 call_string (const call_string &parent, const element_t &to_push);
170
172
176};
177
178} // namespace ana
179
180#endif /* GCC_ANALYZER_CALL_STRING_H */
Definition ops.h:433
const call_string * get_parent() const
Definition call-string.h:93
static int cmp(const call_string &a, const call_string &b)
void recursive_log(logger *logger) const
void print(pretty_printer *pp) const
DISABLE_COPY_AND_ASSIGN(call_string)
element_t operator[](unsigned idx) const
Definition call-string.h:105
int calc_recursion_depth() const
friend class region_model_manager
Definition call-string.h:163
hash_map< element_t, const call_string *, hashmap_traits_t > m_children
Definition call-string.h:175
void validate() const
auto_vec< element_t > m_elements
Definition call-string.h:174
std::unique_ptr< text_art::tree_widget > make_dump_widget(symbolic::node_dump_state &nds) const
const call_string * push_call(const superedge &call_sedge, const call_and_return_op &call_op, function &called_fun) const
int count_occurrences_of_function(function *) const
const supernode * get_return_node_in_caller() const
call_string(const call_string &parent, const element_t &to_push)
const call_string * m_parent
Definition call-string.h:173
const element_t & get_top_of_stack() const
Definition call-string.h:109
bool empty_p() const
Definition call-string.h:88
static int cmp_ptr_ptr(const void *, const void *)
unsigned length() const
Definition call-string.h:104
std::unique_ptr< json::value > to_json() const
Definition analyzer-logging.h:36
Definition supergraph.h:284
Definition supergraph.h:105
Definition supergraph.h:227
Definition vec.h:1667
Definition hash-map.h:40
Definition inchash.h:38
hashval_t end() const
Definition inchash.h:49
void add_ptr(const void *ptr)
Definition inchash.h:94
Definition pretty-print.h:241
Definition access-diagram.h:30
Ca const poly_int< N, Cb > & b
Definition poly-int.h:771
Ca & a
Definition poly-int.h:770
Definition call-string.h:55
const gcall & get_call_stmt() const
bool operator==(const element_t &other) const
const superedge * m_call_sedge
Definition call-string.h:79
function * m_called_fun
Definition call-string.h:81
function * get_callee_function() const
Definition call-string.h:71
bool operator!=(const element_t &other) const
element_t(const superedge *call_sedge, const call_and_return_op *call_op, function *called_fun)
Definition call-string.h:56
const supernode * get_return_snode_in_caller() const
const call_and_return_op * m_call_op
Definition call-string.h:80
const supernode * get_call_snode_in_caller() const
function * get_caller_function() const
std::unique_ptr< text_art::tree_widget > make_dump_widget(symbolic::node_dump_state &nds) const
static int cmp(const element_t &a, const element_t &b)
Definition call-string.h:124
static void mark_deleted(T &entry)
Definition call-string.h:157
static void mark_empty(T &entry)
Definition call-string.h:152
static bool is_deleted(const T &entry)
Definition call-string.h:148
static hashval_t hash(const key_type &k)
Definition call-string.h:129
static const bool empty_zero_p
Definition call-string.h:143
static void remove(T &entry)
Definition call-string.h:139
static bool equal_keys(const key_type &k1, const key_type &k2)
Definition call-string.h:135
static bool is_empty(const T &entry)
Definition call-string.h:144
const call_string * value_type
Definition call-string.h:126
static const bool maybe_mx
Definition call-string.h:128
element_t key_type
Definition call-string.h:125
Definition symbolic-nodes.h:276
Definition function.h:249
Definition gimple.h:356
#define gcc_assert(EXPR)
Definition system.h:772