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