GCC Middle and Back End API Reference
call-info.h
Go to the documentation of this file.
1/* Subclasses of custom_edge_info for describing outcomes of function calls.
2 Copyright (C) 2021-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_CALL_INFO_H
22#define GCC_ANALYZER_CALL_INFO_H
23
24namespace ana {
25
26/* Subclass of custom_edge_info for an outcome of a call.
27 This is still abstract; the update_model and get_desc vfuncs must be
28 implemented. */
29
31{
32public:
33 void print (pretty_printer *pp) const final override;
34 void add_events_to_path (checker_path *emission_path,
35 const exploded_edge &eedge) const final override;
36
37 const gcall *get_call_stmt () const { return m_call_stmt; }
38 tree get_fndecl () const { return m_fndecl; }
39
40 virtual label_text get_desc (bool can_colorize) const = 0;
41
43 region_model_context *ctxt) const;
44
45protected:
47 call_info (const call_details &cd, const function &called_fn);
48
49private:
52};
53
54/* Subclass of call_info for a "success" outcome of a call,
55 adding either a
56 "when `FNDECL' succeeds" message (when 'success' is true)
57 or a
58 "when `FNDECL' fails" message (when 'success' is false).
59 This is still abstract: the custom_edge_info::update_model vfunc
60 must be implemented. */
61
63{
64public:
65 label_text get_desc (bool can_colorize) const final override;
66
67protected:
69 : call_info (cd), m_success (success) {}
70
72};
73
74/* Subclass of call_info for a "success" outcome of a call,
75 adding a "when `FNDECL' succeeds" message.
76 This is still abstract: the custom_edge_info::update_model vfunc
77 must be implemented. */
78
86
87/* Subclass of call_info for a "failure" outcome of a call,
88 adding a "when `FNDECL' fails" message.
89 This is still abstract: the custom_edge_info::update_model vfunc
90 must be implemented. */
91
99
100} // namespace ana
101
102#endif /* GCC_ANALYZER_CALL_INFO_H */
Definition call-details.h:29
Definition call-info.h:31
void print(pretty_printer *pp) const final override
const gcall * get_call_stmt() const
Definition call-info.h:37
tree get_fndecl() const
Definition call-info.h:38
const gcall * m_call_stmt
Definition call-info.h:50
call_info(const call_details &cd, const function &called_fn)
call_details get_call_details(region_model *model, region_model_context *ctxt) const
void add_events_to_path(checker_path *emission_path, const exploded_edge &eedge) const final override
call_info(const call_details &cd)
tree m_fndecl
Definition call-info.h:51
virtual label_text get_desc(bool can_colorize) const =0
Definition checker-path.h:32
Definition analyzer.h:367
Definition exploded-graph.h:381
Definition call-info.h:93
failed_call_info(const call_details &cd)
Definition call-info.h:95
Definition region-model.h:718
Definition region-model.h:263
Definition call-info.h:63
succeed_or_fail_call_info(const call_details &cd, bool success)
Definition call-info.h:68
label_text get_desc(bool can_colorize) const final override
bool m_success
Definition call-info.h:71
Definition call-info.h:80
success_call_info(const call_details &cd)
Definition call-info.h:82
Definition pretty-print.h:255
union tree_node * tree
Definition coretypes.h:97
Definition access-diagram.h:30
Definition function.h:249
Definition gimple.h:353
#define true
Definition system.h:894
#define false
Definition system.h:895
static control_dependences * cd
Definition tree-ssa-dce.cc:102