1/* Helper class for handling a call with specific arguments.
2 Copyright (C) 2019-2025 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_DETAILS_H
22#define GCC_ANALYZER_CALL_DETAILS_H
23
24namespace ana {
25
26/* Helper class for handling calls to functions with known behavior. */
27
28class call_details
29{
30public:
31 call_details (const gcall &call, region_model *model,
32 region_model_context *ctxt);
33 call_details (const call_details &cd, region_model_context *ctxt);
34
35 region_model *get_model () const { return m_model; }
36 region_model_manager *get_manager () const;
37 region_model_context *get_ctxt () const { return m_ctxt; }
38 logger *get_logger () const;
39
40 uncertainty_t *get_uncertainty () const;
41 tree get_lhs_type () const { return m_lhs_type; }
42 const region *get_lhs_region () const { return m_lhs_region; }
43
44 bool maybe_set_lhs (const svalue *result) const;
45 void set_any_lhs_with_defaults () const;
46
47 unsigned num_args () const;
48 bool arg_is_pointer_p (unsigned idx) const
49 {
50 return POINTER_TYPE_P (get_arg_type (idx));
51 }
52 bool arg_is_size_p (unsigned idx) const;
53 bool arg_is_integral_p (unsigned idx) const
54 {
55 return INTEGRAL_TYPE_P (get_arg_type (idx));
56 }
57
58 const gcall &get_call_stmt () const { return m_call; }
59 location_t get_location () const;
60
61 tree get_arg_tree (unsigned idx) const;
62 tree get_arg_type (unsigned idx) const;
63 const svalue *get_arg_svalue (unsigned idx) const;
64 const region *deref_ptr_arg (unsigned idx) const;
65 const char *get_arg_string_literal (unsigned idx) const;
66
67 tree get_fndecl_for_call () const;
68
69 void dump_to_pp (pretty_printer *pp, bool simple) const;
70 void dump (bool simple) const;
71 void dump () const;
72
73 std::unique_ptr<text_art::tree_widget>
74 make_dump_widget (const text_art::dump_widget_info &dwi) const;
75
76 const svalue *get_or_create_conjured_svalue (const region *) const;
77
78 tree lookup_function_attribute (const char *attr_name) const;
79
80 void
81 check_for_null_terminated_string_arg (unsigned arg_idx) const;
82 const svalue *
83 check_for_null_terminated_string_arg (unsigned arg_idx,
84 bool include_terminator,
85 const svalue **out_sval) const;
86
87 void
88 complain_about_overlap (unsigned arg_idx_a,
89 unsigned arg_idx_b,
90 const svalue *num_bytes_read_sval) const;
91
92private:
93 const gcall &m_call;
94 region_model *m_model;
95 region_model_context *m_ctxt;
96 tree m_lhs_type;
97 const region *m_lhs_region;
98};
99
100/* A bundle of information about a problematic argument at a callsite
101 for use by pending_diagnostic subclasses for reporting and
102 for deduplication. */
103
104struct call_arg_details
105{
106public:
107 call_arg_details (const call_details &cd, unsigned arg_idx)
108 : m_call (cd.get_call_stmt ()),
109 m_called_fndecl (cd.get_fndecl_for_call ()),
110 m_arg_idx (arg_idx),
111 m_arg_expr (cd.get_arg_tree (idx: arg_idx))
112 {
113 }
114
115 bool operator== (const call_arg_details &other) const
116 {
117 return (&m_call == &other.m_call
118 && m_called_fndecl == other.m_called_fndecl
119 && m_arg_idx == other.m_arg_idx
120 && pending_diagnostic::same_tree_p (t1: m_arg_expr, t2: other.m_arg_expr));
121 }
122
123 const gcall &m_call;
124 tree m_called_fndecl;
125 unsigned m_arg_idx; // 0-based
126 tree m_arg_expr;
127};
128
129} // namespace ana
130
131#endif /* GCC_ANALYZER_CALL_DETAILS_H */
132

source code of gcc/analyzer/call-details.h