Branch data Line data Source code
1 : : /* Classes for modeling the state of memory.
2 : : Copyright (C) 2019-2024 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 : : #include "config.h"
22 : : #define INCLUDE_ALGORITHM
23 : : #define INCLUDE_VECTOR
24 : : #include "system.h"
25 : : #include "coretypes.h"
26 : : #include "make-unique.h"
27 : : #include "tree.h"
28 : : #include "function.h"
29 : : #include "basic-block.h"
30 : : #include "gimple.h"
31 : : #include "gimple-iterator.h"
32 : : #include "diagnostic-core.h"
33 : : #include "graphviz.h"
34 : : #include "options.h"
35 : : #include "cgraph.h"
36 : : #include "tree-dfa.h"
37 : : #include "stringpool.h"
38 : : #include "convert.h"
39 : : #include "target.h"
40 : : #include "fold-const.h"
41 : : #include "tree-pretty-print.h"
42 : : #include "diagnostic-color.h"
43 : : #include "bitmap.h"
44 : : #include "selftest.h"
45 : : #include "selftest-tree.h"
46 : : #include "analyzer/analyzer.h"
47 : : #include "analyzer/analyzer-logging.h"
48 : : #include "ordered-hash-map.h"
49 : : #include "options.h"
50 : : #include "cgraph.h"
51 : : #include "cfg.h"
52 : : #include "analyzer/supergraph.h"
53 : : #include "sbitmap.h"
54 : : #include "analyzer/call-string.h"
55 : : #include "analyzer/program-point.h"
56 : : #include "analyzer/store.h"
57 : : #include "analyzer/region-model.h"
58 : : #include "analyzer/constraint-manager.h"
59 : : #include "diagnostic-event-id.h"
60 : : #include "analyzer/sm.h"
61 : : #include "diagnostic-event-id.h"
62 : : #include "analyzer/sm.h"
63 : : #include "analyzer/pending-diagnostic.h"
64 : : #include "analyzer/region-model-reachability.h"
65 : : #include "analyzer/analyzer-selftests.h"
66 : : #include "analyzer/program-state.h"
67 : : #include "analyzer/call-summary.h"
68 : : #include "stor-layout.h"
69 : : #include "attribs.h"
70 : : #include "tree-object-size.h"
71 : : #include "gimple-ssa.h"
72 : : #include "tree-phinodes.h"
73 : : #include "tree-ssa-operands.h"
74 : : #include "ssa-iterators.h"
75 : : #include "calls.h"
76 : : #include "is-a.h"
77 : : #include "gcc-rich-location.h"
78 : : #include "analyzer/checker-event.h"
79 : : #include "analyzer/checker-path.h"
80 : : #include "analyzer/feasible-graph.h"
81 : : #include "analyzer/record-layout.h"
82 : : #include "diagnostic-format-sarif.h"
83 : : #include "text-art/tree-widget.h"
84 : : #include "gcc-urlifier.h"
85 : :
86 : : #if ENABLE_ANALYZER
87 : :
88 : : namespace ana {
89 : :
90 : : auto_vec<pop_frame_callback> region_model::pop_frame_callbacks;
91 : :
92 : : /* Dump T to PP in language-independent form, for debugging/logging/dumping
93 : : purposes. */
94 : :
95 : : void
96 : 33299 : dump_tree (pretty_printer *pp, tree t)
97 : : {
98 : 33299 : dump_generic_node (pp, t, 0, TDF_SLIM, 0);
99 : 33299 : }
100 : :
101 : : /* Dump T to PP in language-independent form in quotes, for
102 : : debugging/logging/dumping purposes. */
103 : :
104 : : void
105 : 1389 : dump_quoted_tree (pretty_printer *pp, tree t)
106 : : {
107 : 1389 : pp_begin_quote (pp, pp_show_color (pp));
108 : 1389 : dump_tree (pp, t);
109 : 1389 : pp_end_quote (pp, pp_show_color (pp));
110 : 1389 : }
111 : :
112 : : /* Equivalent to pp_printf (pp, "%qT", t), to avoid nesting pp_printf
113 : : calls within other pp_printf calls.
114 : :
115 : : default_tree_printer handles 'T' and some other codes by calling
116 : : dump_generic_node (pp, t, 0, TDF_SLIM, 0);
117 : : dump_generic_node calls pp_printf in various places, leading to
118 : : garbled output.
119 : :
120 : : Ideally pp_printf could be made to be reentrant, but in the meantime
121 : : this function provides a workaround. */
122 : :
123 : : void
124 : 4485 : print_quoted_type (pretty_printer *pp, tree t)
125 : : {
126 : 4485 : if (!t)
127 : : return;
128 : 4481 : pp_begin_quote (pp, pp_show_color (pp));
129 : 4481 : dump_generic_node (pp, t, 0, TDF_SLIM, 0);
130 : 4481 : pp_end_quote (pp, pp_show_color (pp));
131 : : }
132 : :
133 : : /* Print EXPR to PP, without quotes.
134 : : For use within svalue::maybe_print_for_user
135 : : and region::maybe_print_for_user. */
136 : :
137 : : void
138 : 38 : print_expr_for_user (pretty_printer *pp, tree expr)
139 : : {
140 : : /* Workaround for C++'s lang_hooks.decl_printable_name,
141 : : which unhelpfully (for us) prefixes the decl with its
142 : : type. */
143 : 38 : if (DECL_P (expr))
144 : 38 : dump_generic_node (pp, expr, 0, TDF_SLIM, 0);
145 : : else
146 : 0 : pp_printf (pp, "%E", expr);
147 : 38 : }
148 : :
149 : : /* class region_to_value_map. */
150 : :
151 : : /* Assignment operator for region_to_value_map. */
152 : :
153 : : region_to_value_map &
154 : 17533 : region_to_value_map::operator= (const region_to_value_map &other)
155 : : {
156 : 17533 : m_hash_map.empty ();
157 : 29704 : for (auto iter : other.m_hash_map)
158 : : {
159 : 12171 : const region *reg = iter.first;
160 : 12171 : const svalue *sval = iter.second;
161 : 12171 : m_hash_map.put (reg, sval);
162 : : }
163 : 17533 : return *this;
164 : : }
165 : :
166 : : /* Equality operator for region_to_value_map. */
167 : :
168 : : bool
169 : 658044 : region_to_value_map::operator== (const region_to_value_map &other) const
170 : : {
171 : 658044 : if (m_hash_map.elements () != other.m_hash_map.elements ())
172 : : return false;
173 : :
174 : 1166168 : for (auto iter : *this)
175 : : {
176 : 262660 : const region *reg = iter.first;
177 : 262660 : const svalue *sval = iter.second;
178 : 262660 : const svalue * const *other_slot = other.get (reg);
179 : 262660 : if (other_slot == NULL)
180 : 178 : return false;
181 : 262620 : if (sval != *other_slot)
182 : : return false;
183 : : }
184 : :
185 : 641026 : return true;
186 : : }
187 : :
188 : : /* Dump this object to PP. */
189 : :
190 : : void
191 : 552 : region_to_value_map::dump_to_pp (pretty_printer *pp, bool simple,
192 : : bool multiline) const
193 : : {
194 : 552 : auto_vec<const region *> regs;
195 : 1656 : for (iterator iter = begin (); iter != end (); ++iter)
196 : 552 : regs.safe_push ((*iter).first);
197 : 552 : regs.qsort (region::cmp_ptr_ptr);
198 : 552 : if (multiline)
199 : 552 : pp_newline (pp);
200 : : else
201 : 0 : pp_string (pp, " {");
202 : : unsigned i;
203 : : const region *reg;
204 : 1104 : FOR_EACH_VEC_ELT (regs, i, reg)
205 : : {
206 : 552 : if (multiline)
207 : 552 : pp_string (pp, " ");
208 : 0 : else if (i > 0)
209 : 0 : pp_string (pp, ", ");
210 : 552 : reg->dump_to_pp (pp, simple);
211 : 552 : pp_string (pp, ": ");
212 : 552 : const svalue *sval = *get (reg);
213 : 552 : sval->dump_to_pp (pp, true);
214 : 552 : if (multiline)
215 : 552 : pp_newline (pp);
216 : : }
217 : 552 : if (!multiline)
218 : 0 : pp_string (pp, "}");
219 : 552 : }
220 : :
221 : : /* Dump this object to stderr. */
222 : :
223 : : DEBUG_FUNCTION void
224 : 0 : region_to_value_map::dump (bool simple) const
225 : : {
226 : 0 : tree_dump_pretty_printer pp (stderr);
227 : 0 : dump_to_pp (&pp, simple, true);
228 : 0 : pp_newline (&pp);
229 : 0 : }
230 : :
231 : : /* Generate a JSON value for this region_to_value_map.
232 : : This is intended for debugging the analyzer rather than
233 : : serialization. */
234 : :
235 : : std::unique_ptr<json::object>
236 : 4 : region_to_value_map::to_json () const
237 : : {
238 : 4 : auto map_obj = ::make_unique<json::object> ();
239 : :
240 : 4 : auto_vec<const region *> regs;
241 : 4 : for (iterator iter = begin (); iter != end (); ++iter)
242 : 0 : regs.safe_push ((*iter).first);
243 : 4 : regs.qsort (region::cmp_ptr_ptr);
244 : :
245 : : unsigned i;
246 : : const region *reg;
247 : 4 : FOR_EACH_VEC_ELT (regs, i, reg)
248 : : {
249 : 0 : label_text reg_desc = reg->get_desc ();
250 : 0 : const svalue *sval = *get (reg);
251 : 0 : map_obj->set (reg_desc.get (), sval->to_json ());
252 : 0 : }
253 : :
254 : 4 : return map_obj;
255 : 4 : }
256 : :
257 : : std::unique_ptr<text_art::tree_widget>
258 : 4 : region_to_value_map::
259 : : make_dump_widget (const text_art::dump_widget_info &dwi) const
260 : : {
261 : 4 : if (is_empty ())
262 : 4 : return nullptr;
263 : :
264 : 0 : std::unique_ptr<text_art::tree_widget> w
265 : 0 : (text_art::tree_widget::make (dwi, "Dynamic Extents"));
266 : :
267 : 0 : auto_vec<const region *> regs;
268 : 0 : for (iterator iter = begin (); iter != end (); ++iter)
269 : 0 : regs.safe_push ((*iter).first);
270 : 0 : regs.qsort (region::cmp_ptr_ptr);
271 : :
272 : : unsigned i;
273 : : const region *reg;
274 : 0 : FOR_EACH_VEC_ELT (regs, i, reg)
275 : : {
276 : 0 : pretty_printer the_pp;
277 : 0 : pretty_printer * const pp = &the_pp;
278 : 0 : pp_format_decoder (pp) = default_tree_printer;
279 : 0 : const bool simple = true;
280 : :
281 : 0 : reg->dump_to_pp (pp, simple);
282 : 0 : pp_string (pp, ": ");
283 : 0 : const svalue *sval = *get (reg);
284 : 0 : sval->dump_to_pp (pp, true);
285 : 0 : w->add_child (text_art::tree_widget::make (dwi, pp));
286 : 0 : }
287 : 0 : return w;
288 : 0 : }
289 : :
290 : : /* Attempt to merge THIS with OTHER, writing the result
291 : : to OUT.
292 : :
293 : : For now, write (region, value) mappings that are in common between THIS
294 : : and OTHER to OUT, effectively taking the intersection.
295 : :
296 : : Reject merger of different values. */
297 : :
298 : : bool
299 : 66563 : region_to_value_map::can_merge_with_p (const region_to_value_map &other,
300 : : region_to_value_map *out) const
301 : : {
302 : 95085 : for (auto iter : *this)
303 : : {
304 : 18569 : const region *iter_reg = iter.first;
305 : 18569 : const svalue *iter_sval = iter.second;
306 : 18569 : const svalue * const * other_slot = other.get (iter_reg);
307 : 18569 : if (other_slot)
308 : : {
309 : 18142 : if (iter_sval == *other_slot)
310 : 13834 : out->put (iter_reg, iter_sval);
311 : : else
312 : 4308 : return false;
313 : : }
314 : : }
315 : 62255 : return true;
316 : : }
317 : :
318 : : /* Purge any state involving SVAL. */
319 : :
320 : : void
321 : 34398 : region_to_value_map::purge_state_involving (const svalue *sval)
322 : : {
323 : 34398 : auto_vec<const region *> to_purge;
324 : 113348 : for (auto iter : *this)
325 : : {
326 : 39475 : const region *iter_reg = iter.first;
327 : 39475 : const svalue *iter_sval = iter.second;
328 : 39475 : if (iter_reg->involves_p (sval) || iter_sval->involves_p (sval))
329 : 56 : to_purge.safe_push (iter_reg);
330 : : }
331 : 34566 : for (auto iter : to_purge)
332 : 56 : m_hash_map.remove (iter);
333 : 34398 : }
334 : :
335 : : /* class region_model. */
336 : :
337 : : /* Ctor for region_model: construct an "empty" model. */
338 : :
339 : 338513 : region_model::region_model (region_model_manager *mgr)
340 : 338513 : : m_mgr (mgr), m_store (), m_current_frame (NULL),
341 : 338513 : m_dynamic_extents ()
342 : : {
343 : 338513 : m_constraints = new constraint_manager (mgr);
344 : 338513 : }
345 : :
346 : : /* region_model's copy ctor. */
347 : :
348 : 3527887 : region_model::region_model (const region_model &other)
349 : 3527887 : : m_mgr (other.m_mgr), m_store (other.m_store),
350 : 3527887 : m_constraints (new constraint_manager (*other.m_constraints)),
351 : 3527887 : m_current_frame (other.m_current_frame),
352 : 3527887 : m_dynamic_extents (other.m_dynamic_extents)
353 : : {
354 : 3527887 : }
355 : :
356 : : /* region_model's dtor. */
357 : :
358 : 3866400 : region_model::~region_model ()
359 : : {
360 : 3866400 : delete m_constraints;
361 : 3866400 : }
362 : :
363 : : /* region_model's assignment operator. */
364 : :
365 : : region_model &
366 : 17533 : region_model::operator= (const region_model &other)
367 : : {
368 : : /* m_mgr is const. */
369 : 17533 : gcc_assert (m_mgr == other.m_mgr);
370 : :
371 : 17533 : m_store = other.m_store;
372 : :
373 : 17533 : delete m_constraints;
374 : 17533 : m_constraints = new constraint_manager (*other.m_constraints);
375 : :
376 : 17533 : m_current_frame = other.m_current_frame;
377 : :
378 : 17533 : m_dynamic_extents = other.m_dynamic_extents;
379 : :
380 : 17533 : return *this;
381 : : }
382 : :
383 : : /* Equality operator for region_model.
384 : :
385 : : Amongst other things this directly compares the stores and the constraint
386 : : managers, so for this to be meaningful both this and OTHER should
387 : : have been canonicalized. */
388 : :
389 : : bool
390 : 431202 : region_model::operator== (const region_model &other) const
391 : : {
392 : : /* We can only compare instances that use the same manager. */
393 : 431202 : gcc_assert (m_mgr == other.m_mgr);
394 : :
395 : 431202 : if (m_store != other.m_store)
396 : : return false;
397 : :
398 : 371823 : if (*m_constraints != *other.m_constraints)
399 : : return false;
400 : :
401 : 368333 : if (m_current_frame != other.m_current_frame)
402 : : return false;
403 : :
404 : 368333 : if (m_dynamic_extents != other.m_dynamic_extents)
405 : : return false;
406 : :
407 : 367784 : gcc_checking_assert (hash () == other.hash ());
408 : :
409 : : return true;
410 : : }
411 : :
412 : : /* Generate a hash value for this region_model. */
413 : :
414 : : hashval_t
415 : 1165027 : region_model::hash () const
416 : : {
417 : 1165027 : hashval_t result = m_store.hash ();
418 : 1165027 : result ^= m_constraints->hash ();
419 : 1165027 : return result;
420 : : }
421 : :
422 : : /* Dump a representation of this model to PP, showing the
423 : : stack, the store, and any constraints.
424 : : Use SIMPLE to control how svalues and regions are printed. */
425 : :
426 : : void
427 : 1952 : region_model::dump_to_pp (pretty_printer *pp, bool simple,
428 : : bool multiline) const
429 : : {
430 : : /* Dump stack. */
431 : 1952 : pp_printf (pp, "stack depth: %i", get_stack_depth ());
432 : 1952 : if (multiline)
433 : 856 : pp_newline (pp);
434 : : else
435 : 1096 : pp_string (pp, " {");
436 : 3953 : for (const frame_region *iter_frame = m_current_frame; iter_frame;
437 : 2001 : iter_frame = iter_frame->get_calling_frame ())
438 : : {
439 : 2001 : if (multiline)
440 : 916 : pp_string (pp, " ");
441 : 1085 : else if (iter_frame != m_current_frame)
442 : 0 : pp_string (pp, ", ");
443 : 2001 : pp_printf (pp, "frame (index %i): ", iter_frame->get_index ());
444 : 2001 : iter_frame->dump_to_pp (pp, simple);
445 : 2001 : if (multiline)
446 : 916 : pp_newline (pp);
447 : : }
448 : 1952 : if (!multiline)
449 : 1096 : pp_string (pp, "}");
450 : :
451 : : /* Dump store. */
452 : 1096 : if (!multiline)
453 : 1096 : pp_string (pp, ", {");
454 : 1952 : m_store.dump_to_pp (pp, simple, multiline,
455 : 1952 : m_mgr->get_store_manager ());
456 : 1952 : if (!multiline)
457 : 1096 : pp_string (pp, "}");
458 : :
459 : : /* Dump constraints. */
460 : 1952 : pp_string (pp, "constraint_manager:");
461 : 1952 : if (multiline)
462 : 856 : pp_newline (pp);
463 : : else
464 : 1096 : pp_string (pp, " {");
465 : 1952 : m_constraints->dump_to_pp (pp, multiline);
466 : 1952 : if (!multiline)
467 : 1096 : pp_string (pp, "}");
468 : :
469 : : /* Dump sizes of dynamic regions, if any are known. */
470 : 1952 : if (!m_dynamic_extents.is_empty ())
471 : : {
472 : 552 : pp_string (pp, "dynamic_extents:");
473 : 552 : m_dynamic_extents.dump_to_pp (pp, simple, multiline);
474 : : }
475 : 1952 : }
476 : :
477 : : /* Dump a representation of this model to FILE. */
478 : :
479 : : void
480 : 0 : region_model::dump (FILE *fp, bool simple, bool multiline) const
481 : : {
482 : 0 : tree_dump_pretty_printer pp (fp);
483 : 0 : dump_to_pp (&pp, simple, multiline);
484 : 0 : pp_newline (&pp);
485 : 0 : }
486 : :
487 : : /* Dump a multiline representation of this model to stderr. */
488 : :
489 : : DEBUG_FUNCTION void
490 : 0 : region_model::dump (bool simple) const
491 : : {
492 : 0 : dump (stderr, simple, true);
493 : 0 : }
494 : :
495 : : /* Dump a tree-like representation of this state to stderr. */
496 : :
497 : : DEBUG_FUNCTION void
498 : 0 : region_model::dump () const
499 : : {
500 : 0 : text_art::dump (*this);
501 : 0 : }
502 : :
503 : : /* Dump a multiline representation of this model to stderr. */
504 : :
505 : : DEBUG_FUNCTION void
506 : 0 : region_model::debug () const
507 : : {
508 : 0 : dump (true);
509 : 0 : }
510 : :
511 : : /* Generate a JSON value for this region_model.
512 : : This is intended for debugging the analyzer rather than
513 : : serialization. */
514 : :
515 : : std::unique_ptr<json::object>
516 : 4 : region_model::to_json () const
517 : : {
518 : 4 : auto model_obj = ::make_unique<json::object> ();
519 : 4 : model_obj->set ("store", m_store.to_json ());
520 : 4 : model_obj->set ("constraints", m_constraints->to_json ());
521 : 4 : if (m_current_frame)
522 : 4 : model_obj->set ("current_frame", m_current_frame->to_json ());
523 : 4 : model_obj->set ("dynamic_extents", m_dynamic_extents.to_json ());
524 : 4 : return model_obj;
525 : : }
526 : :
527 : : std::unique_ptr<text_art::tree_widget>
528 : 4 : region_model::make_dump_widget (const text_art::dump_widget_info &dwi) const
529 : : {
530 : 4 : using text_art::tree_widget;
531 : 4 : std::unique_ptr<tree_widget> model_widget
532 : 4 : (tree_widget::from_fmt (dwi, nullptr, "Region Model"));
533 : :
534 : 4 : if (m_current_frame)
535 : : {
536 : 0 : pretty_printer the_pp;
537 : 0 : pretty_printer * const pp = &the_pp;
538 : 0 : pp_format_decoder (pp) = default_tree_printer;
539 : 0 : pp_show_color (pp) = true;
540 : 0 : const bool simple = true;
541 : :
542 : 0 : pp_string (pp, "Current Frame: ");
543 : 0 : m_current_frame->dump_to_pp (pp, simple);
544 : 0 : model_widget->add_child (tree_widget::make (dwi, pp));
545 : 0 : }
546 : 4 : model_widget->add_child
547 : 8 : (m_store.make_dump_widget (dwi,
548 : 4 : m_mgr->get_store_manager ()));
549 : 4 : model_widget->add_child (m_constraints->make_dump_widget (dwi));
550 : 4 : model_widget->add_child (m_dynamic_extents.make_dump_widget (dwi));
551 : 4 : return model_widget;
552 : : }
553 : :
554 : : /* Assert that this object is valid. */
555 : :
556 : : void
557 : 1644747 : region_model::validate () const
558 : : {
559 : 1644747 : m_store.validate ();
560 : 1644747 : }
561 : :
562 : : /* Canonicalize the store and constraints, to maximize the chance of
563 : : equality between region_model instances. */
564 : :
565 : : void
566 : 1019710 : region_model::canonicalize ()
567 : : {
568 : 1019710 : m_store.canonicalize (m_mgr->get_store_manager ());
569 : 1019710 : m_constraints->canonicalize ();
570 : 1019710 : }
571 : :
572 : : /* Return true if this region_model is in canonical form. */
573 : :
574 : : bool
575 : 358163 : region_model::canonicalized_p () const
576 : : {
577 : 358163 : region_model copy (*this);
578 : 358163 : copy.canonicalize ();
579 : 358163 : return *this == copy;
580 : 358163 : }
581 : :
582 : : /* See the comment for store::loop_replay_fixup. */
583 : :
584 : : void
585 : 9119 : region_model::loop_replay_fixup (const region_model *dst_state)
586 : : {
587 : 9119 : m_store.loop_replay_fixup (dst_state->get_store (), m_mgr);
588 : 9119 : }
589 : :
590 : : /* A subclass of pending_diagnostic for complaining about uses of
591 : : poisoned values. */
592 : :
593 : : class poisoned_value_diagnostic
594 : : : public pending_diagnostic_subclass<poisoned_value_diagnostic>
595 : : {
596 : : public:
597 : 1732 : poisoned_value_diagnostic (tree expr, enum poison_kind pkind,
598 : : const region *src_region,
599 : : tree check_expr)
600 : 1732 : : m_expr (expr), m_pkind (pkind),
601 : 1732 : m_src_region (src_region),
602 : 1732 : m_check_expr (check_expr)
603 : : {}
604 : :
605 : 4348 : const char *get_kind () const final override { return "poisoned_value_diagnostic"; }
606 : :
607 : 58 : bool use_of_uninit_p () const final override
608 : : {
609 : 58 : return m_pkind == POISON_KIND_UNINIT;
610 : : }
611 : :
612 : 1204 : bool operator== (const poisoned_value_diagnostic &other) const
613 : : {
614 : 1204 : return (m_expr == other.m_expr
615 : 1197 : && m_pkind == other.m_pkind
616 : 2401 : && m_src_region == other.m_src_region);
617 : : }
618 : :
619 : 1930 : int get_controlling_option () const final override
620 : : {
621 : 1930 : switch (m_pkind)
622 : : {
623 : 0 : default:
624 : 0 : gcc_unreachable ();
625 : : case POISON_KIND_UNINIT:
626 : : return OPT_Wanalyzer_use_of_uninitialized_value;
627 : : case POISON_KIND_FREED:
628 : : case POISON_KIND_DELETED:
629 : : return OPT_Wanalyzer_use_after_free;
630 : : case POISON_KIND_POPPED_STACK:
631 : : return OPT_Wanalyzer_use_of_pointer_in_stale_stack_frame;
632 : : }
633 : : }
634 : :
635 : 1375 : bool terminate_path_p () const final override { return true; }
636 : :
637 : 555 : bool emit (diagnostic_emission_context &ctxt) final override
638 : : {
639 : 555 : switch (m_pkind)
640 : : {
641 : 0 : default:
642 : 0 : gcc_unreachable ();
643 : 528 : case POISON_KIND_UNINIT:
644 : 528 : {
645 : 528 : ctxt.add_cwe (457); /* "CWE-457: Use of Uninitialized Variable". */
646 : 528 : return ctxt.warn ("use of uninitialized value %qE",
647 : 528 : m_expr);
648 : : }
649 : 3 : break;
650 : 3 : case POISON_KIND_FREED:
651 : 3 : {
652 : 3 : ctxt.add_cwe (416); /* "CWE-416: Use After Free". */
653 : 3 : return ctxt.warn ("use after %<free%> of %qE",
654 : 3 : m_expr);
655 : : }
656 : 9 : break;
657 : 9 : case POISON_KIND_DELETED:
658 : 9 : {
659 : 9 : ctxt.add_cwe (416); /* "CWE-416: Use After Free". */
660 : 9 : return ctxt.warn ("use after %<delete%> of %qE",
661 : 9 : m_expr);
662 : : }
663 : 15 : break;
664 : 15 : case POISON_KIND_POPPED_STACK:
665 : 15 : {
666 : : /* TODO: which CWE? */
667 : 15 : return ctxt.warn
668 : 15 : ("dereferencing pointer %qE to within stale stack frame",
669 : 15 : m_expr);
670 : : }
671 : : break;
672 : : }
673 : : }
674 : :
675 : : bool
676 : 1110 : describe_final_event (pretty_printer &pp,
677 : : const evdesc::final_event &) final override
678 : : {
679 : 1110 : switch (m_pkind)
680 : : {
681 : 0 : default:
682 : 0 : gcc_unreachable ();
683 : 1056 : case POISON_KIND_UNINIT:
684 : 1056 : {
685 : 1056 : pp_printf (&pp,
686 : : "use of uninitialized value %qE here",
687 : : m_expr);
688 : 1056 : return true;
689 : : }
690 : 6 : case POISON_KIND_FREED:
691 : 6 : {
692 : 6 : pp_printf (&pp,
693 : : "use after %<free%> of %qE here",
694 : : m_expr);
695 : 6 : return true;
696 : : }
697 : 18 : case POISON_KIND_DELETED:
698 : 18 : {
699 : 18 : pp_printf (&pp,
700 : : "use after %<delete%> of %qE here",
701 : : m_expr);
702 : 18 : return true;
703 : : }
704 : 30 : case POISON_KIND_POPPED_STACK:
705 : 30 : {
706 : 30 : pp_printf (&pp,
707 : : "dereferencing pointer %qE to within stale stack frame",
708 : : m_expr);
709 : 30 : return true;
710 : : }
711 : : }
712 : : }
713 : :
714 : 555 : void mark_interesting_stuff (interesting_t *interest) final override
715 : : {
716 : 555 : if (m_src_region)
717 : 532 : interest->add_region_creation (m_src_region);
718 : 555 : }
719 : :
720 : : /* Attempt to suppress false positives.
721 : : Reject paths where the value of the underlying region isn't poisoned.
722 : : This can happen due to state merging when exploring the exploded graph,
723 : : where the more precise analysis during feasibility analysis finds that
724 : : the region is in fact valid.
725 : : To do this we need to get the value from the fgraph. Unfortunately
726 : : we can't simply query the state of m_src_region (from the enode),
727 : : since it might be a different region in the fnode state (e.g. with
728 : : heap-allocated regions, the numbering could be different).
729 : : Hence we access m_check_expr, if available. */
730 : :
731 : 1233 : bool check_valid_fpath_p (const feasible_node &fnode,
732 : : const gimple *emission_stmt)
733 : : const final override
734 : : {
735 : 1233 : if (!m_check_expr)
736 : : return true;
737 : :
738 : : /* We've reached the enode, but not necessarily the right function_point.
739 : : Try to get the state at the correct stmt. */
740 : 1131 : region_model emission_model (fnode.get_model ().get_manager());
741 : 1131 : if (!fnode.get_state_at_stmt (emission_stmt, &emission_model))
742 : : /* Couldn't get state; accept this diagnostic. */
743 : : return true;
744 : :
745 : 1021 : const svalue *fsval = emission_model.get_rvalue (m_check_expr, NULL);
746 : : /* Check to see if the expr is also poisoned in FNODE (and in the
747 : : same way). */
748 : 1021 : const poisoned_svalue * fspval = fsval->dyn_cast_poisoned_svalue ();
749 : 1021 : if (!fspval)
750 : : return false;
751 : 969 : if (fspval->get_poison_kind () != m_pkind)
752 : : return false;
753 : : return true;
754 : 1131 : }
755 : :
756 : : private:
757 : : tree m_expr;
758 : : enum poison_kind m_pkind;
759 : : const region *m_src_region;
760 : : tree m_check_expr;
761 : : };
762 : :
763 : : /* A subclass of pending_diagnostic for complaining about shifts
764 : : by negative counts. */
765 : :
766 : : class shift_count_negative_diagnostic
767 : : : public pending_diagnostic_subclass<shift_count_negative_diagnostic>
768 : : {
769 : : public:
770 : 16 : shift_count_negative_diagnostic (const gassign *assign, tree count_cst)
771 : 16 : : m_assign (assign), m_count_cst (count_cst)
772 : : {}
773 : :
774 : 56 : const char *get_kind () const final override
775 : : {
776 : 56 : return "shift_count_negative_diagnostic";
777 : : }
778 : :
779 : 16 : bool operator== (const shift_count_negative_diagnostic &other) const
780 : : {
781 : 16 : return (m_assign == other.m_assign
782 : 16 : && same_tree_p (m_count_cst, other.m_count_cst));
783 : : }
784 : :
785 : 24 : int get_controlling_option () const final override
786 : : {
787 : 24 : return OPT_Wanalyzer_shift_count_negative;
788 : : }
789 : :
790 : 8 : bool emit (diagnostic_emission_context &ctxt) final override
791 : : {
792 : 8 : return ctxt.warn ("shift by negative count (%qE)", m_count_cst);
793 : : }
794 : :
795 : : bool
796 : 16 : describe_final_event (pretty_printer &pp,
797 : : const evdesc::final_event &) final override
798 : : {
799 : 16 : pp_printf (&pp,
800 : : "shift by negative amount here (%qE)",
801 : : m_count_cst);
802 : 16 : return true;
803 : : }
804 : :
805 : : private:
806 : : const gassign *m_assign;
807 : : tree m_count_cst;
808 : : };
809 : :
810 : : /* A subclass of pending_diagnostic for complaining about shifts
811 : : by counts >= the width of the operand type. */
812 : :
813 : : class shift_count_overflow_diagnostic
814 : : : public pending_diagnostic_subclass<shift_count_overflow_diagnostic>
815 : : {
816 : : public:
817 : 8 : shift_count_overflow_diagnostic (const gassign *assign,
818 : : int operand_precision,
819 : : tree count_cst)
820 : 8 : : m_assign (assign), m_operand_precision (operand_precision),
821 : 8 : m_count_cst (count_cst)
822 : : {}
823 : :
824 : 28 : const char *get_kind () const final override
825 : : {
826 : 28 : return "shift_count_overflow_diagnostic";
827 : : }
828 : :
829 : 8 : bool operator== (const shift_count_overflow_diagnostic &other) const
830 : : {
831 : 8 : return (m_assign == other.m_assign
832 : 8 : && m_operand_precision == other.m_operand_precision
833 : 16 : && same_tree_p (m_count_cst, other.m_count_cst));
834 : : }
835 : :
836 : 12 : int get_controlling_option () const final override
837 : : {
838 : 12 : return OPT_Wanalyzer_shift_count_overflow;
839 : : }
840 : :
841 : 4 : bool emit (diagnostic_emission_context &ctxt) final override
842 : : {
843 : 4 : return ctxt.warn ("shift by count (%qE) >= precision of type (%qi)",
844 : 4 : m_count_cst, m_operand_precision);
845 : : }
846 : :
847 : : bool
848 : 8 : describe_final_event (pretty_printer &pp,
849 : : const evdesc::final_event &) final override
850 : : {
851 : 8 : pp_printf (&pp,
852 : : "shift by count %qE here",
853 : : m_count_cst);
854 : 8 : return true;
855 : : }
856 : :
857 : : private:
858 : : const gassign *m_assign;
859 : : int m_operand_precision;
860 : : tree m_count_cst;
861 : : };
862 : :
863 : : /* A subclass of pending_diagnostic for complaining about pointer
864 : : subtractions involving unrelated buffers. */
865 : :
866 : : class undefined_ptrdiff_diagnostic
867 : : : public pending_diagnostic_subclass<undefined_ptrdiff_diagnostic>
868 : : {
869 : : public:
870 : : /* Region_creation_event subclass to give a custom wording when
871 : : talking about creation of buffers for LHS and RHS of the
872 : : subtraction. */
873 : : class ptrdiff_region_creation_event : public region_creation_event
874 : : {
875 : : public:
876 : 56 : ptrdiff_region_creation_event (const event_loc_info &loc_info,
877 : : bool is_lhs)
878 : 56 : : region_creation_event (loc_info),
879 : 56 : m_is_lhs (is_lhs)
880 : : {
881 : : }
882 : :
883 : 112 : void print_desc (pretty_printer &pp) const final override
884 : : {
885 : 112 : if (m_is_lhs)
886 : 56 : pp_string (&pp,
887 : : "underlying object for left-hand side"
888 : : " of subtraction created here");
889 : : else
890 : 56 : pp_string (&pp,
891 : : "underlying object for right-hand side"
892 : : " of subtraction created here");
893 : 112 : }
894 : :
895 : : private:
896 : : bool m_is_lhs;
897 : : };
898 : :
899 : 56 : undefined_ptrdiff_diagnostic (const gassign *assign,
900 : : const svalue *sval_a,
901 : : const svalue *sval_b,
902 : : const region *base_reg_a,
903 : : const region *base_reg_b)
904 : 56 : : m_assign (assign),
905 : 56 : m_sval_a (sval_a),
906 : 56 : m_sval_b (sval_b),
907 : 56 : m_base_reg_a (base_reg_a),
908 : 56 : m_base_reg_b (base_reg_b)
909 : : {
910 : 56 : gcc_assert (m_base_reg_a != m_base_reg_b);
911 : : }
912 : :
913 : 196 : const char *get_kind () const final override
914 : : {
915 : 196 : return "undefined_ptrdiff_diagnostic";
916 : : }
917 : :
918 : 56 : bool operator== (const undefined_ptrdiff_diagnostic &other) const
919 : : {
920 : 56 : return (m_assign == other.m_assign
921 : 56 : && m_sval_a == other.m_sval_a
922 : 56 : && m_sval_b == other.m_sval_b
923 : 56 : && m_base_reg_a == other.m_base_reg_a
924 : 112 : && m_base_reg_b == other.m_base_reg_b);
925 : : }
926 : :
927 : 84 : int get_controlling_option () const final override
928 : : {
929 : 84 : return OPT_Wanalyzer_undefined_behavior_ptrdiff;
930 : : }
931 : :
932 : 28 : bool emit (diagnostic_emission_context &ctxt) final override
933 : : {
934 : : /* CWE-469: Use of Pointer Subtraction to Determine Size. */
935 : 28 : ctxt.add_cwe (469);
936 : 28 : return ctxt.warn ("undefined behavior when subtracting pointers");
937 : : }
938 : :
939 : 56 : void add_region_creation_events (const region *reg,
940 : : tree /*capacity*/,
941 : : const event_loc_info &loc_info,
942 : : checker_path &emission_path) final override
943 : : {
944 : 56 : if (reg == m_base_reg_a)
945 : 28 : emission_path.add_event
946 : 28 : (make_unique<ptrdiff_region_creation_event> (loc_info, true));
947 : 28 : else if (reg == m_base_reg_b)
948 : 28 : emission_path.add_event
949 : 28 : (make_unique<ptrdiff_region_creation_event> (loc_info, false));
950 : 56 : }
951 : :
952 : : bool
953 : 56 : describe_final_event (pretty_printer &pp,
954 : : const evdesc::final_event &) final override
955 : : {
956 : 56 : pp_string (&pp,
957 : : "subtraction of pointers has undefined behavior if"
958 : : " they do not point into the same array object");
959 : 56 : return true;
960 : : }
961 : :
962 : 28 : void mark_interesting_stuff (interesting_t *interesting) final override
963 : : {
964 : 28 : interesting->add_region_creation (m_base_reg_a);
965 : 28 : interesting->add_region_creation (m_base_reg_b);
966 : 28 : }
967 : :
968 : : private:
969 : : const gassign *m_assign;
970 : : const svalue *m_sval_a;
971 : : const svalue *m_sval_b;
972 : : const region *m_base_reg_a;
973 : : const region *m_base_reg_b;
974 : : };
975 : :
976 : : /* Check the pointer subtraction SVAL_A - SVAL_B at ASSIGN and add
977 : : a warning to CTXT if they're not within the same base region. */
978 : :
979 : : static void
980 : 618 : check_for_invalid_ptrdiff (const gassign *assign,
981 : : region_model_context &ctxt,
982 : : const svalue *sval_a, const svalue *sval_b)
983 : : {
984 : 618 : const region *base_reg_a = sval_a->maybe_get_deref_base_region ();
985 : 618 : if (!base_reg_a)
986 : 562 : return;
987 : 80 : const region *base_reg_b = sval_b->maybe_get_deref_base_region ();
988 : 80 : if (!base_reg_b)
989 : : return;
990 : :
991 : 56 : if (base_reg_a == base_reg_b)
992 : : return;
993 : :
994 : 56 : if (base_reg_a->get_kind () == RK_SYMBOLIC)
995 : : return;
996 : 56 : if (base_reg_b->get_kind () == RK_SYMBOLIC)
997 : : return;
998 : :
999 : 56 : ctxt.warn (make_unique<undefined_ptrdiff_diagnostic> (assign,
1000 : : sval_a,
1001 : : sval_b,
1002 : : base_reg_a,
1003 : : base_reg_b));
1004 : : }
1005 : :
1006 : : /* If ASSIGN is a stmt that can be modelled via
1007 : : set_value (lhs_reg, SVALUE, CTXT)
1008 : : for some SVALUE, get the SVALUE.
1009 : : Otherwise return NULL. */
1010 : :
1011 : : const svalue *
1012 : 367433 : region_model::get_gassign_result (const gassign *assign,
1013 : : region_model_context *ctxt)
1014 : : {
1015 : 367433 : tree lhs = gimple_assign_lhs (assign);
1016 : :
1017 : 367433 : if (gimple_has_volatile_ops (assign)
1018 : 367433 : && !gimple_clobber_p (assign))
1019 : : {
1020 : 120 : conjured_purge p (this, ctxt);
1021 : 120 : return m_mgr->get_or_create_conjured_svalue (TREE_TYPE (lhs),
1022 : : assign,
1023 : : get_lvalue (lhs, ctxt),
1024 : : p);
1025 : : }
1026 : :
1027 : 367313 : tree rhs1 = gimple_assign_rhs1 (assign);
1028 : 367313 : enum tree_code op = gimple_assign_rhs_code (assign);
1029 : 367313 : switch (op)
1030 : : {
1031 : : default:
1032 : : return NULL;
1033 : :
1034 : 27496 : case POINTER_PLUS_EXPR:
1035 : 27496 : {
1036 : : /* e.g. "_1 = a_10(D) + 12;" */
1037 : 27496 : tree ptr = rhs1;
1038 : 27496 : tree offset = gimple_assign_rhs2 (assign);
1039 : :
1040 : 27496 : const svalue *ptr_sval = get_rvalue (ptr, ctxt);
1041 : 27496 : const svalue *offset_sval = get_rvalue (offset, ctxt);
1042 : : /* Quoting tree.def, "the second operand [of a POINTER_PLUS_EXPR]
1043 : : is an integer of type sizetype". */
1044 : 27496 : offset_sval = m_mgr->get_or_create_cast (size_type_node, offset_sval);
1045 : :
1046 : 27496 : const svalue *sval_binop
1047 : 27496 : = m_mgr->get_or_create_binop (TREE_TYPE (lhs), op,
1048 : : ptr_sval, offset_sval);
1049 : 27496 : return sval_binop;
1050 : : }
1051 : 930 : break;
1052 : :
1053 : 930 : case POINTER_DIFF_EXPR:
1054 : 930 : {
1055 : : /* e.g. "_1 = p_2(D) - q_3(D);". */
1056 : 930 : tree rhs2 = gimple_assign_rhs2 (assign);
1057 : 930 : const svalue *rhs1_sval = get_rvalue (rhs1, ctxt);
1058 : 930 : const svalue *rhs2_sval = get_rvalue (rhs2, ctxt);
1059 : :
1060 : : // TODO: perhaps fold to zero if they're known to be equal?
1061 : :
1062 : 930 : if (ctxt)
1063 : 618 : check_for_invalid_ptrdiff (assign, *ctxt, rhs1_sval, rhs2_sval);
1064 : :
1065 : 930 : const svalue *sval_binop
1066 : 930 : = m_mgr->get_or_create_binop (TREE_TYPE (lhs), op,
1067 : : rhs1_sval, rhs2_sval);
1068 : 930 : return sval_binop;
1069 : : }
1070 : 209739 : break;
1071 : :
1072 : : /* Assignments of the form
1073 : : set_value (lvalue (LHS), rvalue (EXPR))
1074 : : for various EXPR.
1075 : : We already have the lvalue for the LHS above, as "lhs_reg". */
1076 : 209739 : case ADDR_EXPR: /* LHS = &RHS; */
1077 : 209739 : case BIT_FIELD_REF:
1078 : 209739 : case COMPONENT_REF: /* LHS = op0.op1; */
1079 : 209739 : case MEM_REF:
1080 : 209739 : case REAL_CST:
1081 : 209739 : case COMPLEX_CST:
1082 : 209739 : case VECTOR_CST:
1083 : 209739 : case INTEGER_CST:
1084 : 209739 : case ARRAY_REF:
1085 : 209739 : case SSA_NAME: /* LHS = VAR; */
1086 : 209739 : case VAR_DECL: /* LHS = VAR; */
1087 : 209739 : case PARM_DECL:/* LHS = VAR; */
1088 : 209739 : case REALPART_EXPR:
1089 : 209739 : case IMAGPART_EXPR:
1090 : 209739 : return get_rvalue (rhs1, ctxt);
1091 : :
1092 : 39663 : case ABS_EXPR:
1093 : 39663 : case ABSU_EXPR:
1094 : 39663 : case CONJ_EXPR:
1095 : 39663 : case BIT_NOT_EXPR:
1096 : 39663 : case FIX_TRUNC_EXPR:
1097 : 39663 : case FLOAT_EXPR:
1098 : 39663 : case NEGATE_EXPR:
1099 : 39663 : case NOP_EXPR:
1100 : 39663 : case VIEW_CONVERT_EXPR:
1101 : 39663 : {
1102 : : /* Unary ops. */
1103 : 39663 : const svalue *rhs_sval = get_rvalue (rhs1, ctxt);
1104 : 39663 : const svalue *sval_unaryop
1105 : 39663 : = m_mgr->get_or_create_unaryop (TREE_TYPE (lhs), op, rhs_sval);
1106 : 39663 : return sval_unaryop;
1107 : : }
1108 : :
1109 : 15153 : case EQ_EXPR:
1110 : 15153 : case GE_EXPR:
1111 : 15153 : case LE_EXPR:
1112 : 15153 : case NE_EXPR:
1113 : 15153 : case GT_EXPR:
1114 : 15153 : case LT_EXPR:
1115 : 15153 : case UNORDERED_EXPR:
1116 : 15153 : case ORDERED_EXPR:
1117 : 15153 : {
1118 : 15153 : tree rhs2 = gimple_assign_rhs2 (assign);
1119 : :
1120 : 15153 : const svalue *rhs1_sval = get_rvalue (rhs1, ctxt);
1121 : 15153 : const svalue *rhs2_sval = get_rvalue (rhs2, ctxt);
1122 : :
1123 : 15153 : if (TREE_TYPE (lhs) == boolean_type_node)
1124 : : {
1125 : : /* Consider constraints between svalues. */
1126 : 14885 : tristate t = eval_condition (rhs1_sval, op, rhs2_sval);
1127 : 14885 : if (t.is_known ())
1128 : 8130 : return m_mgr->get_or_create_constant_svalue
1129 : 8130 : (t.is_true () ? boolean_true_node : boolean_false_node);
1130 : : }
1131 : :
1132 : : /* Otherwise, generate a symbolic binary op. */
1133 : 7023 : const svalue *sval_binop
1134 : 7023 : = m_mgr->get_or_create_binop (TREE_TYPE (lhs), op,
1135 : : rhs1_sval, rhs2_sval);
1136 : 7023 : return sval_binop;
1137 : : }
1138 : 61780 : break;
1139 : :
1140 : 61780 : case PLUS_EXPR:
1141 : 61780 : case MINUS_EXPR:
1142 : 61780 : case MULT_EXPR:
1143 : 61780 : case MULT_HIGHPART_EXPR:
1144 : 61780 : case TRUNC_DIV_EXPR:
1145 : 61780 : case CEIL_DIV_EXPR:
1146 : 61780 : case FLOOR_DIV_EXPR:
1147 : 61780 : case ROUND_DIV_EXPR:
1148 : 61780 : case TRUNC_MOD_EXPR:
1149 : 61780 : case CEIL_MOD_EXPR:
1150 : 61780 : case FLOOR_MOD_EXPR:
1151 : 61780 : case ROUND_MOD_EXPR:
1152 : 61780 : case RDIV_EXPR:
1153 : 61780 : case EXACT_DIV_EXPR:
1154 : 61780 : case LSHIFT_EXPR:
1155 : 61780 : case RSHIFT_EXPR:
1156 : 61780 : case LROTATE_EXPR:
1157 : 61780 : case RROTATE_EXPR:
1158 : 61780 : case BIT_IOR_EXPR:
1159 : 61780 : case BIT_XOR_EXPR:
1160 : 61780 : case BIT_AND_EXPR:
1161 : 61780 : case MIN_EXPR:
1162 : 61780 : case MAX_EXPR:
1163 : 61780 : case COMPLEX_EXPR:
1164 : 61780 : {
1165 : : /* Binary ops. */
1166 : 61780 : tree rhs2 = gimple_assign_rhs2 (assign);
1167 : :
1168 : 61780 : const svalue *rhs1_sval = get_rvalue (rhs1, ctxt);
1169 : 61780 : const svalue *rhs2_sval = get_rvalue (rhs2, ctxt);
1170 : :
1171 : 61780 : if (ctxt && (op == LSHIFT_EXPR || op == RSHIFT_EXPR))
1172 : : {
1173 : : /* "INT34-C. Do not shift an expression by a negative number of bits
1174 : : or by greater than or equal to the number of bits that exist in
1175 : : the operand." */
1176 : 1944 : if (const tree rhs2_cst = rhs2_sval->maybe_get_constant ())
1177 : 1692 : if (TREE_CODE (rhs2_cst) == INTEGER_CST
1178 : 1692 : && INTEGRAL_TYPE_P (TREE_TYPE (rhs1)))
1179 : : {
1180 : 1690 : if (tree_int_cst_sgn (rhs2_cst) < 0)
1181 : 16 : ctxt->warn
1182 : 16 : (make_unique<shift_count_negative_diagnostic>
1183 : 32 : (assign, rhs2_cst));
1184 : 1674 : else if (compare_tree_int (rhs2_cst,
1185 : 1674 : TYPE_PRECISION (TREE_TYPE (rhs1)))
1186 : : >= 0)
1187 : 8 : ctxt->warn
1188 : 8 : (make_unique<shift_count_overflow_diagnostic>
1189 : 16 : (assign,
1190 : 16 : int (TYPE_PRECISION (TREE_TYPE (rhs1))),
1191 : : rhs2_cst));
1192 : : }
1193 : : }
1194 : :
1195 : 61780 : const svalue *sval_binop
1196 : 61780 : = m_mgr->get_or_create_binop (TREE_TYPE (lhs), op,
1197 : : rhs1_sval, rhs2_sval);
1198 : 61780 : return sval_binop;
1199 : : }
1200 : :
1201 : : /* Vector expressions. In theory we could implement these elementwise,
1202 : : but for now, simply return unknown values. */
1203 : 0 : case VEC_DUPLICATE_EXPR:
1204 : 0 : case VEC_SERIES_EXPR:
1205 : 0 : case VEC_COND_EXPR:
1206 : 0 : case VEC_PERM_EXPR:
1207 : 0 : case VEC_WIDEN_MULT_HI_EXPR:
1208 : 0 : case VEC_WIDEN_MULT_LO_EXPR:
1209 : 0 : case VEC_WIDEN_MULT_EVEN_EXPR:
1210 : 0 : case VEC_WIDEN_MULT_ODD_EXPR:
1211 : 0 : case VEC_UNPACK_HI_EXPR:
1212 : 0 : case VEC_UNPACK_LO_EXPR:
1213 : 0 : case VEC_UNPACK_FLOAT_HI_EXPR:
1214 : 0 : case VEC_UNPACK_FLOAT_LO_EXPR:
1215 : 0 : case VEC_UNPACK_FIX_TRUNC_HI_EXPR:
1216 : 0 : case VEC_UNPACK_FIX_TRUNC_LO_EXPR:
1217 : 0 : case VEC_PACK_TRUNC_EXPR:
1218 : 0 : case VEC_PACK_SAT_EXPR:
1219 : 0 : case VEC_PACK_FIX_TRUNC_EXPR:
1220 : 0 : case VEC_PACK_FLOAT_EXPR:
1221 : 0 : case VEC_WIDEN_LSHIFT_HI_EXPR:
1222 : 0 : case VEC_WIDEN_LSHIFT_LO_EXPR:
1223 : 0 : return m_mgr->get_or_create_unknown_svalue (TREE_TYPE (lhs));
1224 : : }
1225 : : }
1226 : :
1227 : : /* Workaround for discarding certain false positives from
1228 : : -Wanalyzer-use-of-uninitialized-value
1229 : : of the form:
1230 : : ((A OR-IF B) OR-IF C)
1231 : : and:
1232 : : ((A AND-IF B) AND-IF C)
1233 : : where evaluating B is redundant, but could involve simple accesses of
1234 : : uninitialized locals.
1235 : :
1236 : : When optimization is turned on the FE can immediately fold compound
1237 : : conditionals. Specifically, c_parser_condition parses this condition:
1238 : : ((A OR-IF B) OR-IF C)
1239 : : and calls c_fully_fold on the condition.
1240 : : Within c_fully_fold, fold_truth_andor is called, which bails when
1241 : : optimization is off, but if any optimization is turned on can convert the
1242 : : ((A OR-IF B) OR-IF C)
1243 : : into:
1244 : : ((A OR B) OR_IF C)
1245 : : for sufficiently simple B
1246 : : i.e. the inner OR-IF becomes an OR.
1247 : : At gimplification time the inner OR becomes BIT_IOR_EXPR (in gimplify_expr),
1248 : : giving this for the inner condition:
1249 : : tmp = A | B;
1250 : : if (tmp)
1251 : : thus effectively synthesizing a redundant access of B when optimization
1252 : : is turned on, when compared to:
1253 : : if (A) goto L1; else goto L4;
1254 : : L1: if (B) goto L2; else goto L4;
1255 : : L2: if (C) goto L3; else goto L4;
1256 : : for the unoptimized case.
1257 : :
1258 : : Return true if CTXT appears to be handling such a short-circuitable stmt,
1259 : : such as the def-stmt for B for the:
1260 : : tmp = A | B;
1261 : : case above, for the case where A is true and thus B would have been
1262 : : short-circuited without optimization, using MODEL for the value of A. */
1263 : :
1264 : : static bool
1265 : 906 : within_short_circuited_stmt_p (const region_model *model,
1266 : : const gassign *assign_stmt)
1267 : : {
1268 : : /* We must have an assignment to a temporary of _Bool type. */
1269 : 906 : tree lhs = gimple_assign_lhs (assign_stmt);
1270 : 906 : if (TREE_TYPE (lhs) != boolean_type_node)
1271 : : return false;
1272 : 42 : if (TREE_CODE (lhs) != SSA_NAME)
1273 : : return false;
1274 : 42 : if (SSA_NAME_VAR (lhs) != NULL_TREE)
1275 : : return false;
1276 : :
1277 : : /* The temporary bool must be used exactly once: as the second arg of
1278 : : a BIT_IOR_EXPR or BIT_AND_EXPR. */
1279 : 42 : use_operand_p use_op;
1280 : 42 : gimple *use_stmt;
1281 : 42 : if (!single_imm_use (lhs, &use_op, &use_stmt))
1282 : : return false;
1283 : 936 : const gassign *use_assign = dyn_cast <const gassign *> (use_stmt);
1284 : 42 : if (!use_assign)
1285 : : return false;
1286 : 42 : enum tree_code op = gimple_assign_rhs_code (use_assign);
1287 : 42 : if (!(op == BIT_IOR_EXPR ||op == BIT_AND_EXPR))
1288 : : return false;
1289 : 28 : if (!(gimple_assign_rhs1 (use_assign) != lhs
1290 : 28 : && gimple_assign_rhs2 (use_assign) == lhs))
1291 : : return false;
1292 : :
1293 : : /* The first arg of the bitwise stmt must have a known value in MODEL
1294 : : that implies that the value of the second arg doesn't matter, i.e.
1295 : : 1 for bitwise or, 0 for bitwise and. */
1296 : 28 : tree other_arg = gimple_assign_rhs1 (use_assign);
1297 : : /* Use a NULL ctxt here to avoid generating warnings. */
1298 : 28 : const svalue *other_arg_sval = model->get_rvalue (other_arg, NULL);
1299 : 28 : tree other_arg_cst = other_arg_sval->maybe_get_constant ();
1300 : 28 : if (!other_arg_cst)
1301 : : return false;
1302 : 12 : switch (op)
1303 : : {
1304 : 0 : default:
1305 : 0 : gcc_unreachable ();
1306 : 12 : case BIT_IOR_EXPR:
1307 : 12 : if (zerop (other_arg_cst))
1308 : : return false;
1309 : : break;
1310 : 0 : case BIT_AND_EXPR:
1311 : 0 : if (!zerop (other_arg_cst))
1312 : : return false;
1313 : : break;
1314 : : }
1315 : :
1316 : : /* All tests passed. We appear to be in a stmt that generates a boolean
1317 : : temporary with a value that won't matter. */
1318 : : return true;
1319 : : }
1320 : :
1321 : : /* Workaround for discarding certain false positives from
1322 : : -Wanalyzer-use-of-uninitialized-value
1323 : : seen with -ftrivial-auto-var-init=.
1324 : :
1325 : : -ftrivial-auto-var-init= will generate calls to IFN_DEFERRED_INIT.
1326 : :
1327 : : If the address of the var is taken, gimplification will give us
1328 : : something like:
1329 : :
1330 : : _1 = .DEFERRED_INIT (4, 2, &"len"[0]);
1331 : : len = _1;
1332 : :
1333 : : The result of DEFERRED_INIT will be an uninit value; we don't
1334 : : want to emit a false positive for "len = _1;"
1335 : :
1336 : : Return true if ASSIGN_STMT is such a stmt. */
1337 : :
1338 : : static bool
1339 : 894 : due_to_ifn_deferred_init_p (const gassign *assign_stmt)
1340 : :
1341 : : {
1342 : : /* We must have an assignment to a decl from an SSA name that's the
1343 : : result of a IFN_DEFERRED_INIT call. */
1344 : 1618 : if (gimple_assign_rhs_code (assign_stmt) != SSA_NAME)
1345 : : return false;
1346 : 103 : tree lhs = gimple_assign_lhs (assign_stmt);
1347 : 103 : if (TREE_CODE (lhs) != VAR_DECL)
1348 : : return false;
1349 : 30 : tree rhs = gimple_assign_rhs1 (assign_stmt);
1350 : 30 : if (TREE_CODE (rhs) != SSA_NAME)
1351 : : return false;
1352 : 30 : const gimple *def_stmt = SSA_NAME_DEF_STMT (rhs);
1353 : 30 : const gcall *call = dyn_cast <const gcall *> (def_stmt);
1354 : 30 : if (!call)
1355 : : return false;
1356 : 30 : if (gimple_call_internal_p (call)
1357 : 30 : && gimple_call_internal_fn (call) == IFN_DEFERRED_INIT)
1358 : 30 : return true;
1359 : : return false;
1360 : : }
1361 : :
1362 : : /* Check for SVAL being poisoned, adding a warning to CTXT.
1363 : : Return SVAL, or, if a warning is added, another value, to avoid
1364 : : repeatedly complaining about the same poisoned value in followup code.
1365 : : SRC_REGION is a hint about where SVAL came from, and can be NULL. */
1366 : :
1367 : : const svalue *
1368 : 2987463 : region_model::check_for_poison (const svalue *sval,
1369 : : tree expr,
1370 : : const region *src_region,
1371 : : region_model_context *ctxt) const
1372 : : {
1373 : 2987463 : if (!ctxt)
1374 : : return sval;
1375 : :
1376 : 1418134 : if (const poisoned_svalue *poisoned_sval = sval->dyn_cast_poisoned_svalue ())
1377 : : {
1378 : 1874 : enum poison_kind pkind = poisoned_sval->get_poison_kind ();
1379 : :
1380 : : /* Ignore uninitialized uses of empty types; there's nothing
1381 : : to initialize. */
1382 : 1874 : if (pkind == POISON_KIND_UNINIT
1383 : 1833 : && sval->get_type ()
1384 : 3605 : && is_empty_type (sval->get_type ()))
1385 : : return sval;
1386 : :
1387 : 1738 : if (pkind == POISON_KIND_UNINIT)
1388 : 1697 : if (const gimple *curr_stmt = ctxt->get_stmt ())
1389 : 1352 : if (const gassign *assign_stmt
1390 : 2602 : = dyn_cast <const gassign *> (curr_stmt))
1391 : : {
1392 : : /* Special case to avoid certain false positives. */
1393 : 906 : if (within_short_circuited_stmt_p (this, assign_stmt))
1394 : : return sval;
1395 : :
1396 : : /* Special case to avoid false positive on
1397 : : -ftrivial-auto-var-init=. */
1398 : 894 : if (due_to_ifn_deferred_init_p (assign_stmt))
1399 : : return sval;
1400 : : }
1401 : :
1402 : : /* If we have an SSA name for a temporary, we don't want to print
1403 : : '<unknown>'.
1404 : : Poisoned values are shared by type, and so we can't reconstruct
1405 : : the tree other than via the def stmts, using
1406 : : fixup_tree_for_diagnostic. */
1407 : 1696 : tree diag_arg = fixup_tree_for_diagnostic (expr);
1408 : 1696 : if (src_region == NULL && pkind == POISON_KIND_UNINIT)
1409 : 1611 : src_region = get_region_for_poisoned_expr (expr);
1410 : :
1411 : : /* Can we reliably get the poisoned value from "expr"?
1412 : : This is for use by poisoned_value_diagnostic::check_valid_fpath_p.
1413 : : Unfortunately, we might not have a reliable value for EXPR.
1414 : : Hence we only query its value now, and only use it if we get the
1415 : : poisoned value back again. */
1416 : 1696 : tree check_expr = expr;
1417 : 1696 : const svalue *foo_sval = get_rvalue (expr, NULL);
1418 : 1696 : if (foo_sval == sval)
1419 : : check_expr = expr;
1420 : : else
1421 : 102 : check_expr = NULL;
1422 : 1696 : if (ctxt->warn (make_unique<poisoned_value_diagnostic> (diag_arg,
1423 : : pkind,
1424 : : src_region,
1425 : : check_expr)))
1426 : : {
1427 : : /* We only want to report use of a poisoned value at the first
1428 : : place it gets used; return an unknown value to avoid generating
1429 : : a chain of followup warnings. */
1430 : 1251 : sval = m_mgr->get_or_create_unknown_svalue (sval->get_type ());
1431 : : }
1432 : :
1433 : 1696 : return sval;
1434 : : }
1435 : :
1436 : : return sval;
1437 : : }
1438 : :
1439 : : /* Attempt to get a region for describing EXPR, the source of region of
1440 : : a poisoned_svalue for use in a poisoned_value_diagnostic.
1441 : : Return NULL if there is no good region to use. */
1442 : :
1443 : : const region *
1444 : 1611 : region_model::get_region_for_poisoned_expr (tree expr) const
1445 : : {
1446 : 1611 : if (TREE_CODE (expr) == SSA_NAME)
1447 : : {
1448 : 774 : tree decl = SSA_NAME_VAR (expr);
1449 : 772 : if (decl && DECL_P (decl))
1450 : : expr = decl;
1451 : : else
1452 : : return NULL;
1453 : : }
1454 : 1609 : return get_lvalue (expr, NULL);
1455 : : }
1456 : :
1457 : : /* Update this model for the ASSIGN stmt, using CTXT to report any
1458 : : diagnostics. */
1459 : :
1460 : : void
1461 : 212578 : region_model::on_assignment (const gassign *assign, region_model_context *ctxt)
1462 : : {
1463 : 212578 : tree lhs = gimple_assign_lhs (assign);
1464 : 212578 : tree rhs1 = gimple_assign_rhs1 (assign);
1465 : :
1466 : 212578 : const region *lhs_reg = get_lvalue (lhs, ctxt);
1467 : :
1468 : : /* Any writes other than to the stack are treated
1469 : : as externally visible. */
1470 : 212578 : if (ctxt)
1471 : : {
1472 : 125039 : enum memory_space memspace = lhs_reg->get_memory_space ();
1473 : 125039 : if (memspace != MEMSPACE_STACK)
1474 : 13106 : ctxt->maybe_did_work ();
1475 : : }
1476 : :
1477 : : /* Most assignments are handled by:
1478 : : set_value (lhs_reg, SVALUE, CTXT)
1479 : : for some SVALUE. */
1480 : 212578 : if (const svalue *sval = get_gassign_result (assign, ctxt))
1481 : : {
1482 : 206022 : tree expr = get_diagnostic_tree_for_gassign (assign);
1483 : 206022 : check_for_poison (sval, expr, NULL, ctxt);
1484 : 206022 : set_value (lhs_reg, sval, ctxt);
1485 : 206022 : return;
1486 : : }
1487 : :
1488 : 6556 : enum tree_code op = gimple_assign_rhs_code (assign);
1489 : 6556 : switch (op)
1490 : : {
1491 : 0 : default:
1492 : 0 : {
1493 : 0 : if (0)
1494 : : sorry_at (assign->location, "unhandled assignment op: %qs",
1495 : : get_tree_code_name (op));
1496 : 0 : const svalue *unknown_sval
1497 : 0 : = m_mgr->get_or_create_unknown_svalue (TREE_TYPE (lhs));
1498 : 0 : set_value (lhs_reg, unknown_sval, ctxt);
1499 : : }
1500 : 0 : break;
1501 : :
1502 : 6285 : case CONSTRUCTOR:
1503 : 6285 : {
1504 : 6285 : if (TREE_CLOBBER_P (rhs1))
1505 : : {
1506 : : /* e.g. "x ={v} {CLOBBER};" */
1507 : 6152 : clobber_region (lhs_reg);
1508 : : }
1509 : : else
1510 : : {
1511 : : /* Any CONSTRUCTOR that survives to this point is either
1512 : : just a zero-init of everything, or a vector. */
1513 : 133 : if (!CONSTRUCTOR_NO_CLEARING (rhs1))
1514 : 133 : zero_fill_region (lhs_reg, ctxt);
1515 : : unsigned ix;
1516 : : tree index;
1517 : : tree val;
1518 : 295 : FOR_EACH_CONSTRUCTOR_ELT (CONSTRUCTOR_ELTS (rhs1), ix, index, val)
1519 : : {
1520 : 162 : gcc_assert (TREE_CODE (TREE_TYPE (rhs1)) == VECTOR_TYPE);
1521 : 162 : if (!index)
1522 : 22 : index = build_int_cst (integer_type_node, ix);
1523 : 162 : gcc_assert (TREE_CODE (index) == INTEGER_CST);
1524 : 162 : const svalue *index_sval
1525 : 162 : = m_mgr->get_or_create_constant_svalue (index);
1526 : 162 : gcc_assert (index_sval);
1527 : 162 : const region *sub_reg
1528 : 162 : = m_mgr->get_element_region (lhs_reg,
1529 : 162 : TREE_TYPE (val),
1530 : : index_sval);
1531 : 162 : const svalue *val_sval = get_rvalue (val, ctxt);
1532 : 162 : set_value (sub_reg, val_sval, ctxt);
1533 : : }
1534 : : }
1535 : : }
1536 : : break;
1537 : :
1538 : 271 : case STRING_CST:
1539 : 271 : {
1540 : : /* e.g. "struct s2 x = {{'A', 'B', 'C', 'D'}};". */
1541 : 271 : const svalue *rhs_sval = get_rvalue (rhs1, ctxt);
1542 : 399 : m_store.set_value (m_mgr->get_store_manager(), lhs_reg, rhs_sval,
1543 : 128 : ctxt ? ctxt->get_uncertainty () : NULL);
1544 : : }
1545 : 271 : break;
1546 : : }
1547 : : }
1548 : :
1549 : : /* Handle the pre-sm-state part of STMT, modifying this object in-place.
1550 : : Write true to *OUT_UNKNOWN_SIDE_EFFECTS if the stmt has unknown
1551 : : side effects. */
1552 : :
1553 : : void
1554 : 237787 : region_model::on_stmt_pre (const gimple *stmt,
1555 : : bool *out_unknown_side_effects,
1556 : : region_model_context *ctxt)
1557 : : {
1558 : 237787 : switch (gimple_code (stmt))
1559 : : {
1560 : : default:
1561 : : /* No-op for now. */
1562 : : break;
1563 : :
1564 : 0 : case GIMPLE_DEBUG:
1565 : : /* We should have stripped these out when building the supergraph. */
1566 : 0 : gcc_unreachable ();
1567 : 125039 : break;
1568 : :
1569 : 125039 : case GIMPLE_ASSIGN:
1570 : 125039 : {
1571 : 125039 : const gassign *assign = as_a <const gassign *> (stmt);
1572 : 125039 : on_assignment (assign, ctxt);
1573 : : }
1574 : 125039 : break;
1575 : :
1576 : 356 : case GIMPLE_ASM:
1577 : 356 : {
1578 : 356 : const gasm *asm_stmt = as_a <const gasm *> (stmt);
1579 : 356 : on_asm_stmt (asm_stmt, ctxt);
1580 : 356 : if (ctxt)
1581 : 356 : ctxt->maybe_did_work ();
1582 : : }
1583 : : break;
1584 : :
1585 : 55214 : case GIMPLE_CALL:
1586 : 55214 : {
1587 : : /* Track whether we have a gcall to a function that's not recognized by
1588 : : anything, for which we don't have a function body, or for which we
1589 : : don't know the fndecl. */
1590 : 55214 : const gcall *call = as_a <const gcall *> (stmt);
1591 : 55214 : *out_unknown_side_effects = on_call_pre (call, ctxt);
1592 : : }
1593 : 55214 : break;
1594 : :
1595 : 16177 : case GIMPLE_RETURN:
1596 : 16177 : {
1597 : 16177 : const greturn *return_ = as_a <const greturn *> (stmt);
1598 : 16177 : on_return (return_, ctxt);
1599 : : }
1600 : 16177 : break;
1601 : : }
1602 : 237787 : }
1603 : :
1604 : : /* Given a call CD with function attribute FORMAT_ATTR, check that the
1605 : : format arg to the call is a valid null-terminated string. */
1606 : :
1607 : : void
1608 : 1593 : region_model::check_call_format_attr (const call_details &cd,
1609 : : tree format_attr) const
1610 : : {
1611 : : /* We assume that FORMAT_ATTR has already been validated. */
1612 : :
1613 : : /* arg0 of the attribute should be kind of format strings
1614 : : that this function expects (e.g. "printf"). */
1615 : 1593 : const tree arg0_tree_list = TREE_VALUE (format_attr);
1616 : 1593 : if (!arg0_tree_list)
1617 : 0 : return;
1618 : :
1619 : : /* arg1 of the attribute should be the 1-based parameter index
1620 : : to treat as the format string. */
1621 : 1593 : const tree arg1_tree_list = TREE_CHAIN (arg0_tree_list);
1622 : 1593 : if (!arg1_tree_list)
1623 : : return;
1624 : 1593 : const tree arg1_value = TREE_VALUE (arg1_tree_list);
1625 : 1593 : if (!arg1_value)
1626 : : return;
1627 : :
1628 : 1593 : unsigned format_arg_idx = TREE_INT_CST_LOW (arg1_value) - 1;
1629 : 1593 : if (cd.num_args () <= format_arg_idx)
1630 : : return;
1631 : :
1632 : : /* Subclass of annotating_context that
1633 : : adds a note about the format attr to any saved diagnostics. */
1634 : 1593 : class annotating_ctxt : public annotating_context
1635 : : {
1636 : : public:
1637 : 1593 : annotating_ctxt (const call_details &cd,
1638 : : unsigned fmt_param_idx)
1639 : 1593 : : annotating_context (cd.get_ctxt ()),
1640 : 1593 : m_cd (cd),
1641 : 1593 : m_fmt_param_idx (fmt_param_idx)
1642 : : {
1643 : : }
1644 : 14 : void add_annotations () final override
1645 : : {
1646 : 0 : class reason_format_attr
1647 : : : public pending_note_subclass<reason_format_attr>
1648 : : {
1649 : : public:
1650 : 14 : reason_format_attr (const call_arg_details &arg_details)
1651 : 14 : : m_arg_details (arg_details)
1652 : : {
1653 : : }
1654 : :
1655 : 84 : const char *get_kind () const final override
1656 : : {
1657 : 84 : return "reason_format_attr";
1658 : : }
1659 : :
1660 : 13 : void emit () const final override
1661 : : {
1662 : 13 : inform (DECL_SOURCE_LOCATION (m_arg_details.m_called_fndecl),
1663 : : "parameter %i of %qD marked as a format string"
1664 : : " via %qs attribute",
1665 : 13 : m_arg_details.m_arg_idx + 1, m_arg_details.m_called_fndecl,
1666 : : "format");
1667 : 13 : }
1668 : :
1669 : 42 : bool operator== (const reason_format_attr &other) const
1670 : : {
1671 : 42 : return m_arg_details == other.m_arg_details;
1672 : : }
1673 : :
1674 : : private:
1675 : : call_arg_details m_arg_details;
1676 : : };
1677 : :
1678 : 14 : call_arg_details arg_details (m_cd, m_fmt_param_idx);
1679 : 14 : add_note (make_unique<reason_format_attr> (arg_details));
1680 : 14 : }
1681 : : private:
1682 : : const call_details &m_cd;
1683 : : unsigned m_fmt_param_idx;
1684 : : };
1685 : :
1686 : 1593 : annotating_ctxt my_ctxt (cd, format_arg_idx);
1687 : 1593 : call_details my_cd (cd, &my_ctxt);
1688 : 1593 : my_cd.check_for_null_terminated_string_arg (format_arg_idx);
1689 : : }
1690 : :
1691 : : /* Ensure that all arguments at the call described by CD are checked
1692 : : for poisoned values, by calling get_rvalue on each argument.
1693 : :
1694 : : Check that calls to functions with "format" attribute have valid
1695 : : null-terminated strings for their format argument. */
1696 : :
1697 : : void
1698 : 55187 : region_model::check_call_args (const call_details &cd) const
1699 : : {
1700 : 126123 : for (unsigned arg_idx = 0; arg_idx < cd.num_args (); arg_idx++)
1701 : 70936 : cd.get_arg_svalue (arg_idx);
1702 : :
1703 : : /* Handle attribute "format". */
1704 : 55187 : if (tree format_attr = cd.lookup_function_attribute ("format"))
1705 : 1593 : check_call_format_attr (cd, format_attr);
1706 : 55187 : }
1707 : :
1708 : : /* Update this model for an outcome of a call that returns a specific
1709 : : integer constant.
1710 : : If UNMERGEABLE, then make the result unmergeable, e.g. to prevent
1711 : : the state-merger code from merging success and failure outcomes. */
1712 : :
1713 : : void
1714 : 999 : region_model::update_for_int_cst_return (const call_details &cd,
1715 : : int retval,
1716 : : bool unmergeable)
1717 : : {
1718 : 999 : if (!cd.get_lhs_type ())
1719 : : return;
1720 : 711 : if (TREE_CODE (cd.get_lhs_type ()) != INTEGER_TYPE)
1721 : : return;
1722 : 705 : const svalue *result
1723 : 705 : = m_mgr->get_or_create_int_cst (cd.get_lhs_type (), retval);
1724 : 705 : if (unmergeable)
1725 : 705 : result = m_mgr->get_or_create_unmergeable (result);
1726 : 705 : set_value (cd.get_lhs_region (), result, cd.get_ctxt ());
1727 : : }
1728 : :
1729 : : /* Update this model for an outcome of a call that returns zero.
1730 : : If UNMERGEABLE, then make the result unmergeable, e.g. to prevent
1731 : : the state-merger code from merging success and failure outcomes. */
1732 : :
1733 : : void
1734 : 399 : region_model::update_for_zero_return (const call_details &cd,
1735 : : bool unmergeable)
1736 : : {
1737 : 399 : update_for_int_cst_return (cd, 0, unmergeable);
1738 : 399 : }
1739 : :
1740 : : /* Update this model for an outcome of a call that returns non-zero.
1741 : : Specifically, assign an svalue to the LHS, and add a constraint that
1742 : : that svalue is non-zero. */
1743 : :
1744 : : void
1745 : 133 : region_model::update_for_nonzero_return (const call_details &cd)
1746 : : {
1747 : 133 : if (!cd.get_lhs_type ())
1748 : : return;
1749 : 97 : if (TREE_CODE (cd.get_lhs_type ()) != INTEGER_TYPE)
1750 : : return;
1751 : 97 : cd.set_any_lhs_with_defaults ();
1752 : 97 : const svalue *zero
1753 : 97 : = m_mgr->get_or_create_int_cst (cd.get_lhs_type (), 0);
1754 : 97 : const svalue *result
1755 : 97 : = get_store_value (cd.get_lhs_region (), cd.get_ctxt ());
1756 : 97 : add_constraint (result, NE_EXPR, zero, cd.get_ctxt ());
1757 : : }
1758 : :
1759 : : /* Subroutine of region_model::maybe_get_copy_bounds.
1760 : : The Linux kernel commonly uses
1761 : : min_t([unsigned] long, VAR, sizeof(T));
1762 : : to set an upper bound on the size of a copy_to_user.
1763 : : Attempt to simplify such sizes by trying to get the upper bound as a
1764 : : constant.
1765 : : Return the simplified svalue if possible, or NULL otherwise. */
1766 : :
1767 : : static const svalue *
1768 : 103 : maybe_simplify_upper_bound (const svalue *num_bytes_sval,
1769 : : region_model_manager *mgr)
1770 : : {
1771 : 103 : tree type = num_bytes_sval->get_type ();
1772 : 137 : while (const svalue *raw = num_bytes_sval->maybe_undo_cast ())
1773 : : num_bytes_sval = raw;
1774 : 103 : if (const binop_svalue *binop_sval = num_bytes_sval->dyn_cast_binop_svalue ())
1775 : 76 : if (binop_sval->get_op () == MIN_EXPR)
1776 : 16 : if (binop_sval->get_arg1 ()->get_kind () == SK_CONSTANT)
1777 : : {
1778 : 16 : return mgr->get_or_create_cast (type, binop_sval->get_arg1 ());
1779 : : /* TODO: we might want to also capture the constraint
1780 : : when recording the diagnostic, or note that we're using
1781 : : the upper bound. */
1782 : : }
1783 : : return NULL;
1784 : : }
1785 : :
1786 : : /* Attempt to get an upper bound for the size of a copy when simulating a
1787 : : copy function.
1788 : :
1789 : : NUM_BYTES_SVAL is the symbolic value for the size of the copy.
1790 : : Use it if it's constant, otherwise try to simplify it. Failing
1791 : : that, use the size of SRC_REG if constant.
1792 : :
1793 : : Return a symbolic value for an upper limit on the number of bytes
1794 : : copied, or NULL if no such value could be determined. */
1795 : :
1796 : : const svalue *
1797 : 264 : region_model::maybe_get_copy_bounds (const region *src_reg,
1798 : : const svalue *num_bytes_sval)
1799 : : {
1800 : 264 : if (num_bytes_sval->maybe_get_constant ())
1801 : : return num_bytes_sval;
1802 : :
1803 : 206 : if (const svalue *simplified
1804 : 103 : = maybe_simplify_upper_bound (num_bytes_sval, m_mgr))
1805 : 16 : num_bytes_sval = simplified;
1806 : :
1807 : 103 : if (num_bytes_sval->maybe_get_constant ())
1808 : : return num_bytes_sval;
1809 : :
1810 : : /* For now, try just guessing the size as the capacity of the
1811 : : base region of the src.
1812 : : This is a hack; we might get too large a value. */
1813 : 87 : const region *src_base_reg = src_reg->get_base_region ();
1814 : 87 : num_bytes_sval = get_capacity (src_base_reg);
1815 : :
1816 : 87 : if (num_bytes_sval->maybe_get_constant ())
1817 : 22 : return num_bytes_sval;
1818 : :
1819 : : /* Non-constant: give up. */
1820 : : return NULL;
1821 : : }
1822 : :
1823 : : /* Get any known_function for FNDECL for call CD.
1824 : :
1825 : : The call must match all assumptions made by the known_function (such as
1826 : : e.g. "argument 1's type must be a pointer type").
1827 : :
1828 : : Return NULL if no known_function is found, or it does not match the
1829 : : assumption(s). */
1830 : :
1831 : : const known_function *
1832 : 354632 : region_model::get_known_function (tree fndecl, const call_details &cd) const
1833 : : {
1834 : 354632 : known_function_manager *known_fn_mgr = m_mgr->get_known_function_manager ();
1835 : 354632 : return known_fn_mgr->get_match (fndecl, cd);
1836 : : }
1837 : :
1838 : : /* Get any known_function for IFN, or NULL. */
1839 : :
1840 : : const known_function *
1841 : 1327 : region_model::get_known_function (enum internal_fn ifn) const
1842 : : {
1843 : 1327 : known_function_manager *known_fn_mgr = m_mgr->get_known_function_manager ();
1844 : 1327 : return known_fn_mgr->get_internal_fn (ifn);
1845 : : }
1846 : :
1847 : : /* Get any builtin_known_function for CALL and emit any warning to CTXT
1848 : : if not NULL.
1849 : :
1850 : : The call must match all assumptions made by the known_function (such as
1851 : : e.g. "argument 1's type must be a pointer type").
1852 : :
1853 : : Return NULL if no builtin_known_function is found, or it does
1854 : : not match the assumption(s).
1855 : :
1856 : : Internally calls get_known_function to find a known_function and cast it
1857 : : to a builtin_known_function.
1858 : :
1859 : : For instance, calloc is a C builtin, defined in gcc/builtins.def
1860 : : by the DEF_LIB_BUILTIN macro. Such builtins are recognized by the
1861 : : analyzer by their name, so that even in C++ or if the user redeclares
1862 : : them but mismatch their signature, they are still recognized as builtins.
1863 : :
1864 : : Cases when a supposed builtin is not flagged as one by the FE:
1865 : :
1866 : : The C++ FE does not recognize calloc as a builtin if it has not been
1867 : : included from a standard header, but the C FE does. Hence in C++ if
1868 : : CALL comes from a calloc and stdlib is not included,
1869 : : gcc/tree.h:fndecl_built_in_p (CALL) would be false.
1870 : :
1871 : : In C code, a __SIZE_TYPE__ calloc (__SIZE_TYPE__, __SIZE_TYPE__) user
1872 : : declaration has obviously a mismatching signature from the standard, and
1873 : : its function_decl tree won't be unified by
1874 : : gcc/c-decl.cc:match_builtin_function_types.
1875 : :
1876 : : Yet in both cases the analyzer should treat the calls as a builtin calloc
1877 : : so that extra attributes unspecified by the standard but added by GCC
1878 : : (e.g. sprintf attributes in gcc/builtins.def), useful for the detection of
1879 : : dangerous behavior, are indeed processed.
1880 : :
1881 : : Therefore for those cases when a "builtin flag" is not added by the FE,
1882 : : builtins' kf are derived from builtin_known_function, whose method
1883 : : builtin_known_function::builtin_decl returns the builtin's
1884 : : function_decl tree as defined in gcc/builtins.def, with all the extra
1885 : : attributes. */
1886 : :
1887 : : const builtin_known_function *
1888 : 194646 : region_model::get_builtin_kf (const gcall *call,
1889 : : region_model_context *ctxt /* = NULL */) const
1890 : : {
1891 : 194646 : region_model *mut_this = const_cast <region_model *> (this);
1892 : 194646 : tree callee_fndecl = mut_this->get_fndecl_for_call (call, ctxt);
1893 : 194646 : if (! callee_fndecl)
1894 : : return NULL;
1895 : :
1896 : 194646 : call_details cd (call, mut_this, ctxt);
1897 : 194646 : if (const known_function *kf = get_known_function (callee_fndecl, cd))
1898 : 114394 : return kf->dyn_cast_builtin_kf ();
1899 : :
1900 : : return NULL;
1901 : : }
1902 : :
1903 : : /* Update this model for the CALL stmt, using CTXT to report any
1904 : : diagnostics - the first half.
1905 : :
1906 : : Updates to the region_model that should be made *before* sm-states
1907 : : are updated are done here; other updates to the region_model are done
1908 : : in region_model::on_call_post.
1909 : :
1910 : : Return true if the function call has unknown side effects (it wasn't
1911 : : recognized and we don't have a body for it, or are unable to tell which
1912 : : fndecl it is). */
1913 : :
1914 : : bool
1915 : 81798 : region_model::on_call_pre (const gcall *call, region_model_context *ctxt)
1916 : : {
1917 : 81798 : call_details cd (call, this, ctxt);
1918 : :
1919 : : /* Special-case for IFN_DEFERRED_INIT.
1920 : : We want to report uninitialized variables with -fanalyzer (treating
1921 : : -ftrivial-auto-var-init= as purely a mitigation feature).
1922 : : Handle IFN_DEFERRED_INIT by treating it as no-op: don't touch the
1923 : : lhs of the call, so that it is still uninitialized from the point of
1924 : : view of the analyzer. */
1925 : 81798 : if (gimple_call_internal_p (call)
1926 : 81798 : && gimple_call_internal_fn (call) == IFN_DEFERRED_INIT)
1927 : : return false; /* No side effects. */
1928 : :
1929 : : /* Get svalues for all of the arguments at the callsite, to ensure that we
1930 : : complain about any uninitialized arguments. This might lead to
1931 : : duplicates if any of the handling below also looks up the svalues,
1932 : : but the deduplication code should deal with that. */
1933 : 81741 : if (ctxt)
1934 : 55187 : check_call_args (cd);
1935 : :
1936 : 81741 : tree callee_fndecl = get_fndecl_for_call (call, ctxt);
1937 : :
1938 : 81741 : if (gimple_call_internal_p (call))
1939 : 2654 : if (const known_function *kf
1940 : 1327 : = get_known_function (gimple_call_internal_fn (call)))
1941 : : {
1942 : 1249 : kf->impl_call_pre (cd);
1943 : 1249 : return false; /* No further side effects. */
1944 : : }
1945 : :
1946 : 80492 : if (!callee_fndecl)
1947 : : {
1948 : 567 : cd.set_any_lhs_with_defaults ();
1949 : 567 : return true; /* Unknown side effects. */
1950 : : }
1951 : :
1952 : 79925 : if (const known_function *kf = get_known_function (callee_fndecl, cd))
1953 : : {
1954 : 48568 : kf->impl_call_pre (cd);
1955 : 48568 : return false; /* No further side effects. */
1956 : : }
1957 : :
1958 : 31357 : cd.set_any_lhs_with_defaults ();
1959 : :
1960 : 31357 : const int callee_fndecl_flags = flags_from_decl_or_type (callee_fndecl);
1961 : 31357 : if (callee_fndecl_flags & (ECF_CONST | ECF_PURE))
1962 : : return false; /* No side effects. */
1963 : :
1964 : 29673 : if (fndecl_built_in_p (callee_fndecl))
1965 : : return true; /* Unknown side effects. */
1966 : :
1967 : 28826 : if (!fndecl_has_gimple_body_p (callee_fndecl))
1968 : : return true; /* Unknown side effects. */
1969 : :
1970 : : return false; /* No side effects. */
1971 : : }
1972 : :
1973 : : /* Update this model for the CALL stmt, using CTXT to report any
1974 : : diagnostics - the second half.
1975 : :
1976 : : Updates to the region_model that should be made *after* sm-states
1977 : : are updated are done here; other updates to the region_model are done
1978 : : in region_model::on_call_pre.
1979 : :
1980 : : If UNKNOWN_SIDE_EFFECTS is true, also call handle_unrecognized_call
1981 : : to purge state. */
1982 : :
1983 : : void
1984 : 81903 : region_model::on_call_post (const gcall *call,
1985 : : bool unknown_side_effects,
1986 : : region_model_context *ctxt)
1987 : : {
1988 : 81903 : if (tree callee_fndecl = get_fndecl_for_call (call, ctxt))
1989 : : {
1990 : 80061 : call_details cd (call, this, ctxt);
1991 : 80061 : if (const known_function *kf = get_known_function (callee_fndecl, cd))
1992 : : {
1993 : 48397 : kf->impl_call_post (cd);
1994 : 97307 : return;
1995 : : }
1996 : : /* Was this fndecl referenced by
1997 : : __attribute__((malloc(FOO)))? */
1998 : 31664 : if (lookup_attribute ("*dealloc", DECL_ATTRIBUTES (callee_fndecl)))
1999 : : {
2000 : 513 : impl_deallocation_call (cd);
2001 : 513 : return;
2002 : : }
2003 : : }
2004 : :
2005 : 32993 : if (unknown_side_effects)
2006 : : {
2007 : 18460 : handle_unrecognized_call (call, ctxt);
2008 : 18460 : if (ctxt)
2009 : 12378 : ctxt->maybe_did_work ();
2010 : : }
2011 : : }
2012 : :
2013 : : /* Purge state involving SVAL from this region_model, using CTXT
2014 : : (if non-NULL) to purge other state in a program_state.
2015 : :
2016 : : For example, if we're at the def-stmt of an SSA name, then we need to
2017 : : purge any state for svalues that involve that SSA name. This avoids
2018 : : false positives in loops, since a symbolic value referring to the
2019 : : SSA name will be referring to the previous value of that SSA name.
2020 : :
2021 : : For example, in:
2022 : : while ((e = hashmap_iter_next(&iter))) {
2023 : : struct oid2strbuf *e_strbuf = (struct oid2strbuf *)e;
2024 : : free (e_strbuf->value);
2025 : : }
2026 : : at the def-stmt of e_8:
2027 : : e_8 = hashmap_iter_next (&iter);
2028 : : we should purge the "freed" state of:
2029 : : INIT_VAL(CAST_REG(‘struct oid2strbuf’, (*INIT_VAL(e_8))).value)
2030 : : which is the "e_strbuf->value" value from the previous iteration,
2031 : : or we will erroneously report a double-free - the "e_8" within it
2032 : : refers to the previous value. */
2033 : :
2034 : : void
2035 : 34398 : region_model::purge_state_involving (const svalue *sval,
2036 : : region_model_context *ctxt)
2037 : : {
2038 : 34398 : if (!sval->can_have_associated_state_p ())
2039 : : return;
2040 : 34398 : m_store.purge_state_involving (sval, m_mgr);
2041 : 34398 : m_constraints->purge_state_involving (sval);
2042 : 34398 : m_dynamic_extents.purge_state_involving (sval);
2043 : 34398 : if (ctxt)
2044 : 18060 : ctxt->purge_state_involving (sval);
2045 : : }
2046 : :
2047 : : /* A pending_note subclass for adding a note about an
2048 : : __attribute__((access, ...)) to a diagnostic. */
2049 : :
2050 : : class reason_attr_access : public pending_note_subclass<reason_attr_access>
2051 : : {
2052 : : public:
2053 : 22 : reason_attr_access (tree callee_fndecl, const attr_access &access)
2054 : 22 : : m_callee_fndecl (callee_fndecl),
2055 : 22 : m_ptr_argno (access.ptrarg),
2056 : 22 : m_access_str (TREE_STRING_POINTER (access.to_external_string ()))
2057 : : {
2058 : 22 : }
2059 : :
2060 : 116 : const char *get_kind () const final override { return "reason_attr_access"; }
2061 : :
2062 : 18 : void emit () const final override
2063 : : {
2064 : 18 : auto_urlify_attributes sentinel;
2065 : 18 : inform (DECL_SOURCE_LOCATION (m_callee_fndecl),
2066 : : "parameter %i of %qD marked with attribute %qs",
2067 : 18 : m_ptr_argno + 1, m_callee_fndecl, m_access_str);
2068 : 18 : }
2069 : :
2070 : 58 : bool operator== (const reason_attr_access &other) const
2071 : : {
2072 : 58 : return (m_callee_fndecl == other.m_callee_fndecl
2073 : 22 : && m_ptr_argno == other.m_ptr_argno
2074 : 80 : && !strcmp (m_access_str, other.m_access_str));
2075 : : }
2076 : :
2077 : : private:
2078 : : tree m_callee_fndecl;
2079 : : unsigned m_ptr_argno;
2080 : : const char *m_access_str;
2081 : : };
2082 : :
2083 : : /* Check CALL a call to external function CALLEE_FNDECL based on
2084 : : any __attribute__ ((access, ....) on the latter, complaining to
2085 : : CTXT about any issues.
2086 : :
2087 : : Currently we merely call check_region_for_write on any regions
2088 : : pointed to by arguments marked with a "write_only" or "read_write"
2089 : : attribute. */
2090 : :
2091 : : void
2092 : 1223 : region_model::check_function_attr_access (const gcall *call,
2093 : : tree callee_fndecl,
2094 : : region_model_context *ctxt,
2095 : : rdwr_map &rdwr_idx) const
2096 : : {
2097 : 1223 : gcc_assert (call);
2098 : 1223 : gcc_assert (callee_fndecl);
2099 : 1223 : gcc_assert (ctxt);
2100 : :
2101 : 1223 : tree fntype = TREE_TYPE (callee_fndecl);
2102 : 1223 : gcc_assert (fntype);
2103 : :
2104 : 1223 : unsigned argno = 0;
2105 : :
2106 : 4568 : for (tree iter = TYPE_ARG_TYPES (fntype); iter;
2107 : 3345 : iter = TREE_CHAIN (iter), ++argno)
2108 : : {
2109 : 3345 : const attr_access* access = rdwr_idx.get (argno);
2110 : 3345 : if (!access)
2111 : 3075 : continue;
2112 : :
2113 : : /* Ignore any duplicate entry in the map for the size argument. */
2114 : 270 : if (access->ptrarg != argno)
2115 : 109 : continue;
2116 : :
2117 : 161 : if (access->mode == access_write_only
2118 : 161 : || access->mode == access_read_write)
2119 : : {
2120 : : /* Subclass of annotating_context that
2121 : : adds a note about the attr access to any saved diagnostics. */
2122 : 42 : class annotating_ctxt : public annotating_context
2123 : : {
2124 : : public:
2125 : 42 : annotating_ctxt (tree callee_fndecl,
2126 : : const attr_access &access,
2127 : : region_model_context *ctxt)
2128 : 42 : : annotating_context (ctxt),
2129 : 42 : m_callee_fndecl (callee_fndecl),
2130 : 42 : m_access (access)
2131 : : {
2132 : : }
2133 : 22 : void add_annotations () final override
2134 : : {
2135 : 22 : add_note (make_unique<reason_attr_access>
2136 : 44 : (m_callee_fndecl, m_access));
2137 : 22 : }
2138 : : private:
2139 : : tree m_callee_fndecl;
2140 : : const attr_access &m_access;
2141 : : };
2142 : :
2143 : : /* Use this ctxt below so that any diagnostics get the
2144 : : note added to them. */
2145 : 42 : annotating_ctxt my_ctxt (callee_fndecl, *access, ctxt);
2146 : :
2147 : 42 : tree ptr_tree = gimple_call_arg (call, access->ptrarg);
2148 : 42 : const svalue *ptr_sval = get_rvalue (ptr_tree, &my_ctxt);
2149 : 42 : const region *reg = deref_rvalue (ptr_sval, ptr_tree, &my_ctxt);
2150 : 42 : check_region_for_write (reg, nullptr, &my_ctxt);
2151 : : /* We don't use the size arg for now. */
2152 : : }
2153 : : }
2154 : 1223 : }
2155 : :
2156 : : /* Subroutine of region_model::check_function_attr_null_terminated_string_arg,
2157 : : checking one instance of __attribute__((null_terminated_string_arg)). */
2158 : :
2159 : : void
2160 : 184 : region_model::
2161 : : check_one_function_attr_null_terminated_string_arg (const gcall *call,
2162 : : tree callee_fndecl,
2163 : : region_model_context *ctxt,
2164 : : rdwr_map &rdwr_idx,
2165 : : tree attr)
2166 : : {
2167 : 184 : gcc_assert (call);
2168 : 184 : gcc_assert (callee_fndecl);
2169 : 184 : gcc_assert (ctxt);
2170 : 184 : gcc_assert (attr);
2171 : :
2172 : 184 : tree arg = TREE_VALUE (attr);
2173 : 184 : if (!arg)
2174 : 68 : return;
2175 : :
2176 : : /* Convert from 1-based to 0-based index. */
2177 : 184 : unsigned int arg_idx = TREE_INT_CST_LOW (TREE_VALUE (arg)) - 1;
2178 : :
2179 : : /* If there's also an "access" attribute on the ptr param
2180 : : for reading with a size param specified, then that size
2181 : : limits the size of the possible read from the pointer. */
2182 : 184 : if (const attr_access* access = rdwr_idx.get (arg_idx))
2183 : 96 : if ((access->mode == access_read_only
2184 : 96 : || access->mode == access_read_write)
2185 : 96 : && access->sizarg != UINT_MAX)
2186 : : {
2187 : 68 : call_details cd_checked (call, this, ctxt);
2188 : 68 : const svalue *limit_sval
2189 : 68 : = cd_checked.get_arg_svalue (access->sizarg);
2190 : 68 : const svalue *ptr_sval
2191 : 68 : = cd_checked.get_arg_svalue (arg_idx);
2192 : : /* Try reading all of the bytes expressed by the size param,
2193 : : but without emitting warnings (via a null context). */
2194 : 68 : const svalue *limited_sval
2195 : 68 : = read_bytes (deref_rvalue (ptr_sval, NULL_TREE, nullptr),
2196 : : NULL_TREE,
2197 : : limit_sval,
2198 : : nullptr);
2199 : 68 : if (limited_sval->get_kind () == SK_POISONED)
2200 : : {
2201 : : /* Reading up to the truncation limit caused issues.
2202 : : Assume that the string is meant to be terminated
2203 : : before then, so perform a *checked* check for the
2204 : : terminator. */
2205 : 24 : check_for_null_terminated_string_arg (cd_checked,
2206 : : arg_idx);
2207 : : }
2208 : : else
2209 : : {
2210 : : /* Reading up to the truncation limit seems OK; repeat
2211 : : the read, but with checking enabled. */
2212 : 44 : read_bytes (deref_rvalue (ptr_sval, NULL_TREE, ctxt),
2213 : : NULL_TREE,
2214 : : limit_sval,
2215 : : ctxt);
2216 : : }
2217 : 68 : return;
2218 : : }
2219 : :
2220 : : /* Otherwise, we don't have an access-attribute limiting the read.
2221 : : Simulate a read up to the null terminator (if any). */
2222 : :
2223 : 116 : call_details cd (call, this, ctxt);
2224 : 116 : check_for_null_terminated_string_arg (cd, arg_idx);
2225 : : }
2226 : :
2227 : : /* Check CALL a call to external function CALLEE_FNDECL for any uses
2228 : : of __attribute__ ((null_terminated_string_arg)), compaining
2229 : : to CTXT about any issues.
2230 : :
2231 : : Use RDWR_IDX for tracking uses of __attribute__ ((access, ....). */
2232 : :
2233 : : void
2234 : 1223 : region_model::
2235 : : check_function_attr_null_terminated_string_arg (const gcall *call,
2236 : : tree callee_fndecl,
2237 : : region_model_context *ctxt,
2238 : : rdwr_map &rdwr_idx)
2239 : : {
2240 : 1223 : gcc_assert (call);
2241 : 1223 : gcc_assert (callee_fndecl);
2242 : 1223 : gcc_assert (ctxt);
2243 : :
2244 : 1223 : tree fntype = TREE_TYPE (callee_fndecl);
2245 : 1223 : gcc_assert (fntype);
2246 : :
2247 : : /* A function declaration can specify multiple attribute
2248 : : null_terminated_string_arg, each with one argument. */
2249 : 1407 : for (tree attr = TYPE_ATTRIBUTES (fntype); attr; attr = TREE_CHAIN (attr))
2250 : : {
2251 : 1247 : attr = lookup_attribute ("null_terminated_string_arg", attr);
2252 : 1247 : if (!attr)
2253 : : return;
2254 : :
2255 : 184 : check_one_function_attr_null_terminated_string_arg (call, callee_fndecl,
2256 : : ctxt, rdwr_idx,
2257 : : attr);
2258 : : }
2259 : : }
2260 : :
2261 : : /* Check CALL a call to external function CALLEE_FNDECL for any
2262 : : function attributes, complaining to CTXT about any issues. */
2263 : :
2264 : : void
2265 : 11924 : region_model::check_function_attrs (const gcall *call,
2266 : : tree callee_fndecl,
2267 : : region_model_context *ctxt)
2268 : : {
2269 : 11924 : gcc_assert (call);
2270 : 11924 : gcc_assert (callee_fndecl);
2271 : 11924 : gcc_assert (ctxt);
2272 : :
2273 : 11924 : tree fntype = TREE_TYPE (callee_fndecl);
2274 : 11924 : if (!fntype)
2275 : 10701 : return;
2276 : :
2277 : 11924 : if (!TYPE_ATTRIBUTES (fntype))
2278 : : return;
2279 : :
2280 : : /* Initialize a map of attribute access specifications for arguments
2281 : : to the function call. */
2282 : 1223 : rdwr_map rdwr_idx;
2283 : 1223 : init_attr_rdwr_indices (&rdwr_idx, TYPE_ATTRIBUTES (fntype));
2284 : :
2285 : 1223 : check_function_attr_access (call, callee_fndecl, ctxt, rdwr_idx);
2286 : 1223 : check_function_attr_null_terminated_string_arg (call, callee_fndecl,
2287 : : ctxt, rdwr_idx);
2288 : 1223 : }
2289 : :
2290 : : /* Handle a call CALL to a function with unknown behavior.
2291 : :
2292 : : Traverse the regions in this model, determining what regions are
2293 : : reachable from pointer arguments to CALL and from global variables,
2294 : : recursively.
2295 : :
2296 : : Set all reachable regions to new unknown values and purge sm-state
2297 : : from their values, and from values that point to them. */
2298 : :
2299 : : void
2300 : 18460 : region_model::handle_unrecognized_call (const gcall *call,
2301 : : region_model_context *ctxt)
2302 : : {
2303 : 18460 : tree fndecl = get_fndecl_for_call (call, ctxt);
2304 : :
2305 : 18460 : if (fndecl && ctxt)
2306 : 11924 : check_function_attrs (call, fndecl, ctxt);
2307 : :
2308 : 18460 : reachable_regions reachable_regs (this);
2309 : :
2310 : : /* Determine the reachable regions and their mutability. */
2311 : 18460 : {
2312 : : /* Add globals and regions that already escaped in previous
2313 : : unknown calls. */
2314 : 18460 : m_store.for_each_cluster (reachable_regions::init_cluster_cb,
2315 : : &reachable_regs);
2316 : :
2317 : : /* Params that are pointers. */
2318 : 18460 : tree iter_param_types = NULL_TREE;
2319 : 18460 : if (fndecl)
2320 : 17898 : iter_param_types = TYPE_ARG_TYPES (TREE_TYPE (fndecl));
2321 : 40152 : for (unsigned arg_idx = 0; arg_idx < gimple_call_num_args (call); arg_idx++)
2322 : : {
2323 : : /* Track expected param type, where available. */
2324 : 21692 : tree param_type = NULL_TREE;
2325 : 21692 : if (iter_param_types)
2326 : : {
2327 : 20084 : param_type = TREE_VALUE (iter_param_types);
2328 : 20084 : gcc_assert (param_type);
2329 : 20084 : iter_param_types = TREE_CHAIN (iter_param_types);
2330 : : }
2331 : :
2332 : 21692 : tree parm = gimple_call_arg (call, arg_idx);
2333 : 21692 : const svalue *parm_sval = get_rvalue (parm, ctxt);
2334 : 21692 : reachable_regs.handle_parm (parm_sval, param_type);
2335 : : }
2336 : : }
2337 : :
2338 : 18460 : uncertainty_t *uncertainty = ctxt ? ctxt->get_uncertainty () : NULL;
2339 : :
2340 : : /* Purge sm-state for the svalues that were reachable,
2341 : : both in non-mutable and mutable form. */
2342 : 52152 : for (svalue_set::iterator iter
2343 : 18460 : = reachable_regs.begin_reachable_svals ();
2344 : 85844 : iter != reachable_regs.end_reachable_svals (); ++iter)
2345 : : {
2346 : 33692 : const svalue *sval = (*iter);
2347 : 33692 : if (ctxt)
2348 : 24428 : ctxt->on_unknown_change (sval, false);
2349 : : }
2350 : 65880 : for (svalue_set::iterator iter
2351 : 18460 : = reachable_regs.begin_mutable_svals ();
2352 : 113300 : iter != reachable_regs.end_mutable_svals (); ++iter)
2353 : : {
2354 : 47420 : const svalue *sval = (*iter);
2355 : 47420 : if (ctxt)
2356 : 35506 : ctxt->on_unknown_change (sval, true);
2357 : 47420 : if (uncertainty)
2358 : 35506 : uncertainty->on_mutable_sval_at_unknown_call (sval);
2359 : : }
2360 : :
2361 : : /* Mark any clusters that have escaped. */
2362 : 18460 : reachable_regs.mark_escaped_clusters (ctxt);
2363 : :
2364 : : /* Update bindings for all clusters that have escaped, whether above,
2365 : : or previously. */
2366 : 18460 : m_store.on_unknown_fncall (call, m_mgr->get_store_manager (),
2367 : 18460 : conjured_purge (this, ctxt));
2368 : :
2369 : : /* Purge dynamic extents from any regions that have escaped mutably:
2370 : : realloc could have been called on them. */
2371 : 50805 : for (hash_set<const region *>::iterator
2372 : 18460 : iter = reachable_regs.begin_mutable_base_regs ();
2373 : 50805 : iter != reachable_regs.end_mutable_base_regs ();
2374 : 32345 : ++iter)
2375 : : {
2376 : 32345 : const region *base_reg = (*iter);
2377 : 32345 : unset_dynamic_extents (base_reg);
2378 : : }
2379 : 18460 : }
2380 : :
2381 : : /* Traverse the regions in this model, determining what regions are
2382 : : reachable from the store and populating *OUT.
2383 : :
2384 : : If EXTRA_SVAL is non-NULL, treat it as an additional "root"
2385 : : for reachability (for handling return values from functions when
2386 : : analyzing return of the only function on the stack).
2387 : :
2388 : : If UNCERTAINTY is non-NULL, treat any svalues that were recorded
2389 : : within it as being maybe-bound as additional "roots" for reachability.
2390 : :
2391 : : Find svalues that haven't leaked. */
2392 : :
2393 : : void
2394 : 1147666 : region_model::get_reachable_svalues (svalue_set *out,
2395 : : const svalue *extra_sval,
2396 : : const uncertainty_t *uncertainty)
2397 : : {
2398 : 1147666 : reachable_regions reachable_regs (this);
2399 : :
2400 : : /* Add globals and regions that already escaped in previous
2401 : : unknown calls. */
2402 : 1147666 : m_store.for_each_cluster (reachable_regions::init_cluster_cb,
2403 : : &reachable_regs);
2404 : :
2405 : 1147666 : if (extra_sval)
2406 : 4922 : reachable_regs.handle_sval (extra_sval);
2407 : :
2408 : 1147666 : if (uncertainty)
2409 : 663347 : for (uncertainty_t::iterator iter
2410 : 573833 : = uncertainty->begin_maybe_bound_svals ();
2411 : 1326694 : iter != uncertainty->end_maybe_bound_svals (); ++iter)
2412 : 89514 : reachable_regs.handle_sval (*iter);
2413 : :
2414 : : /* Get regions for locals that have explicitly bound values. */
2415 : 8580390 : for (store::cluster_map_t::iterator iter = m_store.begin ();
2416 : 16013114 : iter != m_store.end (); ++iter)
2417 : : {
2418 : 7432724 : const region *base_reg = (*iter).first;
2419 : 7432724 : if (const region *parent = base_reg->get_parent_region ())
2420 : 7432724 : if (parent->get_kind () == RK_FRAME)
2421 : 4185029 : reachable_regs.add (base_reg, false);
2422 : : }
2423 : :
2424 : : /* Populate *OUT based on the values that were reachable. */
2425 : 1147666 : for (svalue_set::iterator iter
2426 : 1147666 : = reachable_regs.begin_reachable_svals ();
2427 : 13321162 : iter != reachable_regs.end_reachable_svals (); ++iter)
2428 : 6086748 : out->add (*iter);
2429 : 1147666 : }
2430 : :
2431 : : /* Update this model for the RETURN_STMT, using CTXT to report any
2432 : : diagnostics. */
2433 : :
2434 : : void
2435 : 19253 : region_model::on_return (const greturn *return_stmt, region_model_context *ctxt)
2436 : : {
2437 : 19253 : tree callee = get_current_function ()->decl;
2438 : 19253 : tree lhs = DECL_RESULT (callee);
2439 : 19253 : tree rhs = gimple_return_retval (return_stmt);
2440 : :
2441 : 19253 : if (lhs && rhs)
2442 : : {
2443 : 9045 : const svalue *sval = get_rvalue (rhs, ctxt);
2444 : 9045 : const region *ret_reg = get_lvalue (lhs, ctxt);
2445 : 9045 : set_value (ret_reg, sval, ctxt);
2446 : : }
2447 : 19253 : }
2448 : :
2449 : : /* Update this model for a call and return of setjmp/sigsetjmp at CALL within
2450 : : ENODE, using CTXT to report any diagnostics.
2451 : :
2452 : : This is for the initial direct invocation of setjmp/sigsetjmp (which returns
2453 : : 0), as opposed to any second return due to longjmp/sigsetjmp. */
2454 : :
2455 : : void
2456 : 34 : region_model::on_setjmp (const gcall *call, const exploded_node *enode,
2457 : : region_model_context *ctxt)
2458 : : {
2459 : 34 : const svalue *buf_ptr = get_rvalue (gimple_call_arg (call, 0), ctxt);
2460 : 34 : const region *buf_reg = deref_rvalue (buf_ptr, gimple_call_arg (call, 0),
2461 : : ctxt);
2462 : :
2463 : : /* Create a setjmp_svalue for this call and store it in BUF_REG's
2464 : : region. */
2465 : 34 : if (buf_reg)
2466 : : {
2467 : 34 : setjmp_record r (enode, call);
2468 : 34 : const svalue *sval
2469 : 34 : = m_mgr->get_or_create_setjmp_svalue (r, buf_reg->get_type ());
2470 : 34 : set_value (buf_reg, sval, ctxt);
2471 : : }
2472 : :
2473 : : /* Direct calls to setjmp return 0. */
2474 : 34 : if (tree lhs = gimple_call_lhs (call))
2475 : : {
2476 : 16 : const svalue *new_sval
2477 : 16 : = m_mgr->get_or_create_int_cst (TREE_TYPE (lhs), 0);
2478 : 16 : const region *lhs_reg = get_lvalue (lhs, ctxt);
2479 : 16 : set_value (lhs_reg, new_sval, ctxt);
2480 : : }
2481 : 34 : }
2482 : :
2483 : : /* Update this region_model for rewinding from a "longjmp" at LONGJMP_CALL
2484 : : to a "setjmp" at SETJMP_CALL where the final stack depth should be
2485 : : SETJMP_STACK_DEPTH. Pop any stack frames. Leak detection is *not*
2486 : : done, and should be done by the caller. */
2487 : :
2488 : : void
2489 : 31 : region_model::on_longjmp (const gcall *longjmp_call, const gcall *setjmp_call,
2490 : : int setjmp_stack_depth, region_model_context *ctxt)
2491 : : {
2492 : : /* Evaluate the val, using the frame of the "longjmp". */
2493 : 31 : tree fake_retval = gimple_call_arg (longjmp_call, 1);
2494 : 31 : const svalue *fake_retval_sval = get_rvalue (fake_retval, ctxt);
2495 : :
2496 : : /* Pop any frames until we reach the stack depth of the function where
2497 : : setjmp was called. */
2498 : 31 : gcc_assert (get_stack_depth () >= setjmp_stack_depth);
2499 : 61 : while (get_stack_depth () > setjmp_stack_depth)
2500 : 30 : pop_frame (NULL, NULL, ctxt, nullptr, false);
2501 : :
2502 : 31 : gcc_assert (get_stack_depth () == setjmp_stack_depth);
2503 : :
2504 : : /* Assign to LHS of "setjmp" in new_state. */
2505 : 31 : if (tree lhs = gimple_call_lhs (setjmp_call))
2506 : : {
2507 : : /* Passing 0 as the val to longjmp leads to setjmp returning 1. */
2508 : 27 : const svalue *zero_sval
2509 : 27 : = m_mgr->get_or_create_int_cst (TREE_TYPE (fake_retval), 0);
2510 : 27 : tristate eq_zero = eval_condition (fake_retval_sval, EQ_EXPR, zero_sval);
2511 : : /* If we have 0, use 1. */
2512 : 27 : if (eq_zero.is_true ())
2513 : : {
2514 : 2 : const svalue *one_sval
2515 : 2 : = m_mgr->get_or_create_int_cst (TREE_TYPE (fake_retval), 1);
2516 : 2 : fake_retval_sval = one_sval;
2517 : : }
2518 : : else
2519 : : {
2520 : : /* Otherwise note that the value is nonzero. */
2521 : 25 : m_constraints->add_constraint (fake_retval_sval, NE_EXPR, zero_sval);
2522 : : }
2523 : :
2524 : : /* Decorate the return value from setjmp as being unmergeable,
2525 : : so that we don't attempt to merge states with it as zero
2526 : : with states in which it's nonzero, leading to a clean distinction
2527 : : in the exploded_graph betweeen the first return and the second
2528 : : return. */
2529 : 27 : fake_retval_sval = m_mgr->get_or_create_unmergeable (fake_retval_sval);
2530 : :
2531 : 27 : const region *lhs_reg = get_lvalue (lhs, ctxt);
2532 : 27 : set_value (lhs_reg, fake_retval_sval, ctxt);
2533 : : }
2534 : 31 : }
2535 : :
2536 : : /* Update this region_model for a phi stmt of the form
2537 : : LHS = PHI <...RHS...>.
2538 : : where RHS is for the appropriate edge.
2539 : : Get state from OLD_STATE so that all of the phi stmts for a basic block
2540 : : are effectively handled simultaneously. */
2541 : :
2542 : : void
2543 : 76640 : region_model::handle_phi (const gphi *phi,
2544 : : tree lhs, tree rhs,
2545 : : const region_model &old_state,
2546 : : hash_set<const svalue *> &svals_changing_meaning,
2547 : : region_model_context *ctxt)
2548 : : {
2549 : : /* For now, don't bother tracking the .MEM SSA names. */
2550 : 76640 : if (tree var = SSA_NAME_VAR (lhs))
2551 : 66400 : if (TREE_CODE (var) == VAR_DECL)
2552 : 64277 : if (VAR_DECL_IS_VIRTUAL_OPERAND (var))
2553 : 35607 : return;
2554 : :
2555 : 41033 : const svalue *src_sval = old_state.get_rvalue (rhs, ctxt);
2556 : 41033 : const region *dst_reg = old_state.get_lvalue (lhs, ctxt);
2557 : :
2558 : 41033 : const svalue *sval = old_state.get_rvalue (lhs, nullptr);
2559 : 41033 : if (sval->get_kind () == SK_WIDENING)
2560 : 1660 : svals_changing_meaning.add (sval);
2561 : :
2562 : 41033 : set_value (dst_reg, src_sval, ctxt);
2563 : :
2564 : 41033 : if (ctxt)
2565 : 31044 : ctxt->on_phi (phi, rhs);
2566 : : }
2567 : :
2568 : : /* Implementation of region_model::get_lvalue; the latter adds type-checking.
2569 : :
2570 : : Get the id of the region for PV within this region_model,
2571 : : emitting any diagnostics to CTXT. */
2572 : :
2573 : : const region *
2574 : 2374833 : region_model::get_lvalue_1 (path_var pv, region_model_context *ctxt) const
2575 : : {
2576 : 2374833 : tree expr = pv.m_tree;
2577 : :
2578 : 2374833 : gcc_assert (expr);
2579 : :
2580 : 2374833 : switch (TREE_CODE (expr))
2581 : : {
2582 : 54 : default:
2583 : 54 : return m_mgr->get_region_for_unexpected_tree_code (ctxt, expr,
2584 : 54 : dump_location_t ());
2585 : :
2586 : 14855 : case ARRAY_REF:
2587 : 14855 : {
2588 : 14855 : tree array = TREE_OPERAND (expr, 0);
2589 : 14855 : tree index = TREE_OPERAND (expr, 1);
2590 : :
2591 : 14855 : const region *array_reg = get_lvalue (array, ctxt);
2592 : 14855 : const svalue *index_sval = get_rvalue (index, ctxt);
2593 : 14855 : return m_mgr->get_element_region (array_reg,
2594 : 14855 : TREE_TYPE (TREE_TYPE (array)),
2595 : 14855 : index_sval);
2596 : : }
2597 : 184 : break;
2598 : :
2599 : 184 : case BIT_FIELD_REF:
2600 : 184 : {
2601 : 184 : tree inner_expr = TREE_OPERAND (expr, 0);
2602 : 184 : const region *inner_reg = get_lvalue (inner_expr, ctxt);
2603 : 184 : tree num_bits = TREE_OPERAND (expr, 1);
2604 : 184 : tree first_bit_offset = TREE_OPERAND (expr, 2);
2605 : 184 : gcc_assert (TREE_CODE (num_bits) == INTEGER_CST);
2606 : 184 : gcc_assert (TREE_CODE (first_bit_offset) == INTEGER_CST);
2607 : 184 : bit_range bits (TREE_INT_CST_LOW (first_bit_offset),
2608 : 368 : TREE_INT_CST_LOW (num_bits));
2609 : 184 : return m_mgr->get_bit_range (inner_reg, TREE_TYPE (expr), bits);
2610 : : }
2611 : 77911 : break;
2612 : :
2613 : 77911 : case MEM_REF:
2614 : 77911 : {
2615 : 77911 : tree ptr = TREE_OPERAND (expr, 0);
2616 : 77911 : tree offset = TREE_OPERAND (expr, 1);
2617 : 77911 : const svalue *ptr_sval = get_rvalue (ptr, ctxt);
2618 : 77911 : const svalue *offset_sval = get_rvalue (offset, ctxt);
2619 : 77911 : const region *star_ptr = deref_rvalue (ptr_sval, ptr, ctxt);
2620 : 77911 : return m_mgr->get_offset_region (star_ptr,
2621 : 77911 : TREE_TYPE (expr),
2622 : 77911 : offset_sval);
2623 : : }
2624 : 862159 : break;
2625 : :
2626 : 862159 : case FUNCTION_DECL:
2627 : 862159 : return m_mgr->get_region_for_fndecl (expr);
2628 : :
2629 : 314 : case LABEL_DECL:
2630 : 314 : return m_mgr->get_region_for_label (expr);
2631 : :
2632 : 134919 : case VAR_DECL:
2633 : : /* Handle globals. */
2634 : 134919 : if (is_global_var (expr))
2635 : 58597 : return m_mgr->get_region_for_global (expr);
2636 : :
2637 : : /* Fall through. */
2638 : :
2639 : 1287357 : case SSA_NAME:
2640 : 1287357 : case PARM_DECL:
2641 : 1287357 : case RESULT_DECL:
2642 : 1287357 : {
2643 : 1287357 : gcc_assert (TREE_CODE (expr) == SSA_NAME
2644 : : || TREE_CODE (expr) == PARM_DECL
2645 : : || VAR_P (expr)
2646 : : || TREE_CODE (expr) == RESULT_DECL);
2647 : :
2648 : 1287357 : int stack_index = pv.m_stack_depth;
2649 : 1287357 : const frame_region *frame = get_frame_at_index (stack_index);
2650 : 1287357 : gcc_assert (frame);
2651 : 1287357 : return frame->get_region_for_local (m_mgr, expr, ctxt);
2652 : : }
2653 : :
2654 : 55993 : case COMPONENT_REF:
2655 : 55993 : {
2656 : : /* obj.field */
2657 : 55993 : tree obj = TREE_OPERAND (expr, 0);
2658 : 55993 : tree field = TREE_OPERAND (expr, 1);
2659 : 55993 : const region *obj_reg = get_lvalue (obj, ctxt);
2660 : 55993 : return m_mgr->get_field_region (obj_reg, field);
2661 : : }
2662 : 17409 : break;
2663 : :
2664 : 17409 : case STRING_CST:
2665 : 17409 : return m_mgr->get_region_for_string (expr);
2666 : : }
2667 : : }
2668 : :
2669 : : /* Assert that SRC_TYPE can be converted to DST_TYPE as a no-op. */
2670 : :
2671 : : static void
2672 : 5163937 : assert_compat_types (tree src_type, tree dst_type)
2673 : : {
2674 : 5163937 : if (src_type && dst_type && !VOID_TYPE_P (dst_type))
2675 : : {
2676 : : #if CHECKING_P
2677 : 5163575 : if (!(useless_type_conversion_p (src_type, dst_type)))
2678 : 0 : internal_error ("incompatible types: %qT and %qT", src_type, dst_type);
2679 : : #endif
2680 : : }
2681 : 5163937 : }
2682 : :
2683 : : /* Return true if SRC_TYPE can be converted to DST_TYPE as a no-op. */
2684 : :
2685 : : bool
2686 : 14053 : compat_types_p (tree src_type, tree dst_type)
2687 : : {
2688 : 14053 : if (src_type && dst_type && !VOID_TYPE_P (dst_type))
2689 : 14053 : if (!(useless_type_conversion_p (src_type, dst_type)))
2690 : : return false;
2691 : : return true;
2692 : : }
2693 : :
2694 : : /* Get the region for PV within this region_model,
2695 : : emitting any diagnostics to CTXT. */
2696 : :
2697 : : const region *
2698 : 2374833 : region_model::get_lvalue (path_var pv, region_model_context *ctxt) const
2699 : : {
2700 : 2374833 : if (pv.m_tree == NULL_TREE)
2701 : : return NULL;
2702 : :
2703 : 2374833 : const region *result_reg = get_lvalue_1 (pv, ctxt);
2704 : 2374833 : assert_compat_types (result_reg->get_type (), TREE_TYPE (pv.m_tree));
2705 : 2374833 : return result_reg;
2706 : : }
2707 : :
2708 : : /* Get the region for EXPR within this region_model (assuming the most
2709 : : recent stack frame if it's a local). */
2710 : :
2711 : : const region *
2712 : 1480186 : region_model::get_lvalue (tree expr, region_model_context *ctxt) const
2713 : : {
2714 : 1480186 : return get_lvalue (path_var (expr, get_stack_depth () - 1), ctxt);
2715 : : }
2716 : :
2717 : : /* Implementation of region_model::get_rvalue; the latter adds type-checking.
2718 : :
2719 : : Get the value of PV within this region_model,
2720 : : emitting any diagnostics to CTXT. */
2721 : :
2722 : : const svalue *
2723 : 2775319 : region_model::get_rvalue_1 (path_var pv, region_model_context *ctxt) const
2724 : : {
2725 : 2775319 : gcc_assert (pv.m_tree);
2726 : :
2727 : 2775319 : switch (TREE_CODE (pv.m_tree))
2728 : : {
2729 : 49 : default:
2730 : 49 : return m_mgr->get_or_create_unknown_svalue (TREE_TYPE (pv.m_tree));
2731 : :
2732 : 912289 : case ADDR_EXPR:
2733 : 912289 : {
2734 : : /* "&EXPR". */
2735 : 912289 : tree expr = pv.m_tree;
2736 : 912289 : tree op0 = TREE_OPERAND (expr, 0);
2737 : 912289 : const region *expr_reg = get_lvalue (op0, ctxt);
2738 : 912289 : return m_mgr->get_ptr_svalue (TREE_TYPE (expr), expr_reg);
2739 : : }
2740 : 138 : break;
2741 : :
2742 : 138 : case BIT_FIELD_REF:
2743 : 138 : {
2744 : 138 : tree expr = pv.m_tree;
2745 : 138 : tree op0 = TREE_OPERAND (expr, 0);
2746 : 138 : const region *reg = get_lvalue (op0, ctxt);
2747 : 138 : tree num_bits = TREE_OPERAND (expr, 1);
2748 : 138 : tree first_bit_offset = TREE_OPERAND (expr, 2);
2749 : 138 : gcc_assert (TREE_CODE (num_bits) == INTEGER_CST);
2750 : 138 : gcc_assert (TREE_CODE (first_bit_offset) == INTEGER_CST);
2751 : 138 : bit_range bits (TREE_INT_CST_LOW (first_bit_offset),
2752 : 276 : TREE_INT_CST_LOW (num_bits));
2753 : 138 : return get_rvalue_for_bits (TREE_TYPE (expr), reg, bits, ctxt);
2754 : : }
2755 : :
2756 : 41965 : case VAR_DECL:
2757 : 41965 : if (DECL_HARD_REGISTER (pv.m_tree))
2758 : : {
2759 : : /* If it has a hard register, it doesn't have a memory region
2760 : : and can't be referred to as an lvalue. */
2761 : 35 : return m_mgr->get_or_create_unknown_svalue (TREE_TYPE (pv.m_tree));
2762 : : }
2763 : : /* Fall through. */
2764 : 831851 : case PARM_DECL:
2765 : 831851 : case SSA_NAME:
2766 : 831851 : case RESULT_DECL:
2767 : 831851 : case ARRAY_REF:
2768 : 831851 : {
2769 : 831851 : const region *reg = get_lvalue (pv, ctxt);
2770 : 831851 : return get_store_value (reg, ctxt);
2771 : : }
2772 : :
2773 : 178 : case REALPART_EXPR:
2774 : 178 : case IMAGPART_EXPR:
2775 : 178 : case VIEW_CONVERT_EXPR:
2776 : 178 : {
2777 : 178 : tree expr = pv.m_tree;
2778 : 178 : tree arg = TREE_OPERAND (expr, 0);
2779 : 178 : const svalue *arg_sval = get_rvalue (arg, ctxt);
2780 : 178 : const svalue *sval_unaryop
2781 : 178 : = m_mgr->get_or_create_unaryop (TREE_TYPE (expr), TREE_CODE (expr),
2782 : : arg_sval);
2783 : 178 : return sval_unaryop;
2784 : 965668 : };
2785 : :
2786 : 965668 : case INTEGER_CST:
2787 : 965668 : case REAL_CST:
2788 : 965668 : case COMPLEX_CST:
2789 : 965668 : case VECTOR_CST:
2790 : 965668 : case STRING_CST:
2791 : 965668 : return m_mgr->get_or_create_constant_svalue (pv.m_tree);
2792 : :
2793 : 8 : case POINTER_PLUS_EXPR:
2794 : 8 : {
2795 : 8 : tree expr = pv.m_tree;
2796 : 8 : tree ptr = TREE_OPERAND (expr, 0);
2797 : 8 : tree offset = TREE_OPERAND (expr, 1);
2798 : 8 : const svalue *ptr_sval = get_rvalue (ptr, ctxt);
2799 : 8 : const svalue *offset_sval = get_rvalue (offset, ctxt);
2800 : 8 : const svalue *sval_binop
2801 : 8 : = m_mgr->get_or_create_binop (TREE_TYPE (expr), POINTER_PLUS_EXPR,
2802 : : ptr_sval, offset_sval);
2803 : 8 : return sval_binop;
2804 : : }
2805 : :
2806 : : /* Binary ops. */
2807 : 94 : case PLUS_EXPR:
2808 : 94 : case MULT_EXPR:
2809 : 94 : case BIT_AND_EXPR:
2810 : 94 : case BIT_IOR_EXPR:
2811 : 94 : case BIT_XOR_EXPR:
2812 : 94 : {
2813 : 94 : tree expr = pv.m_tree;
2814 : 94 : tree arg0 = TREE_OPERAND (expr, 0);
2815 : 94 : tree arg1 = TREE_OPERAND (expr, 1);
2816 : 94 : const svalue *arg0_sval = get_rvalue (arg0, ctxt);
2817 : 94 : const svalue *arg1_sval = get_rvalue (arg1, ctxt);
2818 : 94 : const svalue *sval_binop
2819 : 94 : = m_mgr->get_or_create_binop (TREE_TYPE (expr), TREE_CODE (expr),
2820 : : arg0_sval, arg1_sval);
2821 : 94 : return sval_binop;
2822 : : }
2823 : :
2824 : 62756 : case COMPONENT_REF:
2825 : 62756 : case MEM_REF:
2826 : 62756 : {
2827 : 62756 : const region *ref_reg = get_lvalue (pv, ctxt);
2828 : 62756 : return get_store_value (ref_reg, ctxt);
2829 : : }
2830 : 2253 : case OBJ_TYPE_REF:
2831 : 2253 : {
2832 : 2253 : tree expr = OBJ_TYPE_REF_EXPR (pv.m_tree);
2833 : 2253 : return get_rvalue (expr, ctxt);
2834 : : }
2835 : : }
2836 : : }
2837 : :
2838 : : /* Get the value of PV within this region_model,
2839 : : emitting any diagnostics to CTXT. */
2840 : :
2841 : : const svalue *
2842 : 2817142 : region_model::get_rvalue (path_var pv, region_model_context *ctxt) const
2843 : : {
2844 : 2817142 : if (pv.m_tree == NULL_TREE)
2845 : : return NULL;
2846 : :
2847 : 2775319 : const svalue *result_sval = get_rvalue_1 (pv, ctxt);
2848 : :
2849 : 2775319 : assert_compat_types (result_sval->get_type (), TREE_TYPE (pv.m_tree));
2850 : :
2851 : 2775319 : result_sval = check_for_poison (result_sval, pv.m_tree, NULL, ctxt);
2852 : :
2853 : 2775319 : return result_sval;
2854 : : }
2855 : :
2856 : : /* Get the value of EXPR within this region_model (assuming the most
2857 : : recent stack frame if it's a local). */
2858 : :
2859 : : const svalue *
2860 : 2816676 : region_model::get_rvalue (tree expr, region_model_context *ctxt) const
2861 : : {
2862 : 2816676 : return get_rvalue (path_var (expr, get_stack_depth () - 1), ctxt);
2863 : : }
2864 : :
2865 : : /* Return true if this model is on a path with "main" as the entrypoint
2866 : : (as opposed to one in which we're merely analyzing a subset of the
2867 : : path through the code). */
2868 : :
2869 : : bool
2870 : 286095 : region_model::called_from_main_p () const
2871 : : {
2872 : 286095 : if (!m_current_frame)
2873 : : return false;
2874 : : /* Determine if the oldest stack frame in this model is for "main". */
2875 : 279866 : const frame_region *frame0 = get_frame_at_index (0);
2876 : 279866 : gcc_assert (frame0);
2877 : 279866 : return id_equal (DECL_NAME (frame0->get_function ().decl), "main");
2878 : : }
2879 : :
2880 : : /* Subroutine of region_model::get_store_value for when REG is (or is within)
2881 : : a global variable that hasn't been touched since the start of this path
2882 : : (or was implicitly touched due to a call to an unknown function). */
2883 : :
2884 : : const svalue *
2885 : 296440 : region_model::get_initial_value_for_global (const region *reg) const
2886 : : {
2887 : : /* Get the decl that REG is for (or is within). */
2888 : 296440 : const decl_region *base_reg
2889 : 296440 : = reg->get_base_region ()->dyn_cast_decl_region ();
2890 : 296440 : gcc_assert (base_reg);
2891 : 296440 : tree decl = base_reg->get_decl ();
2892 : :
2893 : : /* Special-case: to avoid having to explicitly update all previously
2894 : : untracked globals when calling an unknown fn, they implicitly have
2895 : : an unknown value if an unknown call has occurred, unless this is
2896 : : static to-this-TU and hasn't escaped. Globals that have escaped
2897 : : are explicitly tracked, so we shouldn't hit this case for them. */
2898 : 296440 : if (m_store.called_unknown_fn_p ()
2899 : 67728 : && TREE_PUBLIC (decl)
2900 : 306851 : && !TREE_READONLY (decl))
2901 : 10393 : return m_mgr->get_or_create_unknown_svalue (reg->get_type ());
2902 : :
2903 : : /* If we are on a path from the entrypoint from "main" and we have a
2904 : : global decl defined in this TU that hasn't been touched yet, then
2905 : : the initial value of REG can be taken from the initialization value
2906 : : of the decl. */
2907 : 286047 : if (called_from_main_p () || TREE_READONLY (decl))
2908 : 7746 : return reg->get_initial_value_at_main (m_mgr);
2909 : :
2910 : : /* Otherwise, return INIT_VAL(REG). */
2911 : 278301 : return m_mgr->get_or_create_initial_value (reg);
2912 : : }
2913 : :
2914 : : /* Get a value for REG, looking it up in the store, or otherwise falling
2915 : : back to "initial" or "unknown" values.
2916 : : Use CTXT to report any warnings associated with reading from REG. */
2917 : :
2918 : : const svalue *
2919 : 3704794 : region_model::get_store_value (const region *reg,
2920 : : region_model_context *ctxt) const
2921 : : {
2922 : : /* Getting the value of an empty region gives an unknown_svalue. */
2923 : 3704794 : if (reg->empty_p ())
2924 : 44 : return m_mgr->get_or_create_unknown_svalue (reg->get_type ());
2925 : :
2926 : 3704750 : bool check_poisoned = true;
2927 : 3704750 : if (check_region_for_read (reg, ctxt))
2928 : 396 : check_poisoned = false;
2929 : :
2930 : : /* Special-case: handle var_decls in the constant pool. */
2931 : 3704750 : if (const decl_region *decl_reg = reg->dyn_cast_decl_region ())
2932 : 2956438 : if (const svalue *sval = decl_reg->maybe_get_constant_value (m_mgr))
2933 : : return sval;
2934 : :
2935 : 3704746 : const svalue *sval
2936 : 3704746 : = m_store.get_any_binding (m_mgr->get_store_manager (), reg);
2937 : 3704746 : if (sval)
2938 : : {
2939 : 1103163 : if (reg->get_type ())
2940 : 1101107 : sval = m_mgr->get_or_create_cast (reg->get_type (), sval);
2941 : 1103163 : return sval;
2942 : : }
2943 : :
2944 : : /* Special-case: read at a constant index within a STRING_CST. */
2945 : 2601583 : if (const offset_region *offset_reg = reg->dyn_cast_offset_region ())
2946 : 172563 : if (tree byte_offset_cst
2947 : 172563 : = offset_reg->get_byte_offset ()->maybe_get_constant ())
2948 : 12617 : if (const string_region *str_reg
2949 : 12617 : = reg->get_parent_region ()->dyn_cast_string_region ())
2950 : : {
2951 : 189 : tree string_cst = str_reg->get_string_cst ();
2952 : 378 : if (const svalue *char_sval
2953 : 189 : = m_mgr->maybe_get_char_from_string_cst (string_cst,
2954 : : byte_offset_cst))
2955 : 183 : return m_mgr->get_or_create_cast (reg->get_type (), char_sval);
2956 : : }
2957 : :
2958 : : /* Special-case: read the initial char of a STRING_CST. */
2959 : 2601400 : if (const cast_region *cast_reg = reg->dyn_cast_cast_region ())
2960 : 6352 : if (const string_region *str_reg
2961 : 3176 : = cast_reg->get_parent_region ()->dyn_cast_string_region ())
2962 : : {
2963 : 204 : tree string_cst = str_reg->get_string_cst ();
2964 : 204 : tree byte_offset_cst = integer_zero_node;
2965 : 408 : if (const svalue *char_sval
2966 : 204 : = m_mgr->maybe_get_char_from_string_cst (string_cst,
2967 : : byte_offset_cst))
2968 : 204 : return m_mgr->get_or_create_cast (reg->get_type (), char_sval);
2969 : : }
2970 : :
2971 : : /* Otherwise we implicitly have the initial value of the region
2972 : : (if the cluster had been touched, binding_cluster::get_any_binding,
2973 : : would have returned UNKNOWN, and we would already have returned
2974 : : that above). */
2975 : :
2976 : : /* Handle globals. */
2977 : 2601196 : if (reg->get_base_region ()->get_parent_region ()->get_kind ()
2978 : : == RK_GLOBALS)
2979 : 296440 : return get_initial_value_for_global (reg);
2980 : :
2981 : 2304756 : return m_mgr->get_or_create_initial_value (reg, check_poisoned);
2982 : : }
2983 : :
2984 : : /* Return false if REG does not exist, true if it may do.
2985 : : This is for detecting regions within the stack that don't exist anymore
2986 : : after frames are popped. */
2987 : :
2988 : : bool
2989 : 2363964 : region_model::region_exists_p (const region *reg) const
2990 : : {
2991 : : /* If within a stack frame, check that the stack frame is live. */
2992 : 2363964 : if (const frame_region *enclosing_frame = reg->maybe_get_frame_region ())
2993 : : {
2994 : : /* Check that the current frame is the enclosing frame, or is called
2995 : : by it. */
2996 : 2334183 : for (const frame_region *iter_frame = get_current_frame (); iter_frame;
2997 : 774347 : iter_frame = iter_frame->get_calling_frame ())
2998 : 2321253 : if (iter_frame == enclosing_frame)
2999 : : return true;
3000 : : return false;
3001 : : }
3002 : :
3003 : : return true;
3004 : : }
3005 : :
3006 : : /* Get a region for referencing PTR_SVAL, creating a region if need be, and
3007 : : potentially generating warnings via CTXT.
3008 : : PTR_SVAL must be of pointer type.
3009 : : PTR_TREE if non-NULL can be used when emitting diagnostics. */
3010 : :
3011 : : const region *
3012 : 126335 : region_model::deref_rvalue (const svalue *ptr_sval, tree ptr_tree,
3013 : : region_model_context *ctxt,
3014 : : bool add_nonnull_constraint) const
3015 : : {
3016 : 126335 : gcc_assert (ptr_sval);
3017 : 126335 : gcc_assert (POINTER_TYPE_P (ptr_sval->get_type ()));
3018 : :
3019 : : /* If we're dereferencing PTR_SVAL, assume that it is non-NULL; add this
3020 : : as a constraint. This suppresses false positives from
3021 : : -Wanalyzer-null-dereference for the case where we later have an
3022 : : if (PTR_SVAL) that would occur if we considered the false branch
3023 : : and transitioned the malloc state machine from start->null. */
3024 : 126335 : if (add_nonnull_constraint)
3025 : : {
3026 : 120596 : tree null_ptr_cst = build_int_cst (ptr_sval->get_type (), 0);
3027 : 120596 : const svalue *null_ptr
3028 : 120596 : = m_mgr->get_or_create_constant_svalue (null_ptr_cst);
3029 : 120596 : m_constraints->add_constraint (ptr_sval, NE_EXPR, null_ptr);
3030 : : }
3031 : :
3032 : 126335 : switch (ptr_sval->get_kind ())
3033 : : {
3034 : : default:
3035 : : break;
3036 : :
3037 : 42579 : case SK_REGION:
3038 : 42579 : {
3039 : 42579 : const region_svalue *region_sval
3040 : 42579 : = as_a <const region_svalue *> (ptr_sval);
3041 : 42579 : return region_sval->get_pointee ();
3042 : : }
3043 : :
3044 : 16616 : case SK_BINOP:
3045 : 16616 : {
3046 : 16616 : const binop_svalue *binop_sval
3047 : 16616 : = as_a <const binop_svalue *> (ptr_sval);
3048 : 16616 : switch (binop_sval->get_op ())
3049 : : {
3050 : 16616 : case POINTER_PLUS_EXPR:
3051 : 16616 : {
3052 : : /* If we have a symbolic value expressing pointer arithmentic,
3053 : : try to convert it to a suitable region. */
3054 : 16616 : const region *parent_region
3055 : 16616 : = deref_rvalue (binop_sval->get_arg0 (), NULL_TREE, ctxt);
3056 : 16616 : const svalue *offset = binop_sval->get_arg1 ();
3057 : 16616 : tree type= TREE_TYPE (ptr_sval->get_type ());
3058 : 16616 : return m_mgr->get_offset_region (parent_region, type, offset);
3059 : : }
3060 : : default:
3061 : : break;
3062 : : }
3063 : : }
3064 : : break;
3065 : :
3066 : 3580 : case SK_POISONED:
3067 : 3580 : {
3068 : 3580 : if (ctxt)
3069 : : {
3070 : 798 : tree ptr = get_representative_tree (ptr_sval);
3071 : : /* If we can't get a representative tree for PTR_SVAL
3072 : : (e.g. if it hasn't been bound into the store), then
3073 : : fall back on PTR_TREE, if non-NULL. */
3074 : 798 : if (!ptr)
3075 : 786 : ptr = ptr_tree;
3076 : 798 : if (ptr)
3077 : : {
3078 : 36 : const poisoned_svalue *poisoned_sval
3079 : 36 : = as_a <const poisoned_svalue *> (ptr_sval);
3080 : 36 : enum poison_kind pkind = poisoned_sval->get_poison_kind ();
3081 : 36 : ctxt->warn (::make_unique<poisoned_value_diagnostic>
3082 : 72 : (ptr, pkind, nullptr, nullptr));
3083 : : }
3084 : : }
3085 : : }
3086 : : break;
3087 : : }
3088 : :
3089 : 67140 : return m_mgr->get_symbolic_region (ptr_sval);
3090 : : }
3091 : :
3092 : : /* Attempt to get BITS within any value of REG, as TYPE.
3093 : : In particular, extract values from compound_svalues for the case
3094 : : where there's a concrete binding at BITS.
3095 : : Return an unknown svalue if we can't handle the given case.
3096 : : Use CTXT to report any warnings associated with reading from REG. */
3097 : :
3098 : : const svalue *
3099 : 138 : region_model::get_rvalue_for_bits (tree type,
3100 : : const region *reg,
3101 : : const bit_range &bits,
3102 : : region_model_context *ctxt) const
3103 : : {
3104 : 138 : const svalue *sval = get_store_value (reg, ctxt);
3105 : 138 : return m_mgr->get_or_create_bits_within (type, bits, sval);
3106 : : }
3107 : :
3108 : : /* A subclass of pending_diagnostic for complaining about writes to
3109 : : constant regions of memory. */
3110 : :
3111 : : class write_to_const_diagnostic
3112 : : : public pending_diagnostic_subclass<write_to_const_diagnostic>
3113 : : {
3114 : : public:
3115 : 33 : write_to_const_diagnostic (const region *reg, tree decl)
3116 : 33 : : m_reg (reg), m_decl (decl)
3117 : : {}
3118 : :
3119 : 148 : const char *get_kind () const final override
3120 : : {
3121 : 148 : return "write_to_const_diagnostic";
3122 : : }
3123 : :
3124 : 33 : bool operator== (const write_to_const_diagnostic &other) const
3125 : : {
3126 : 33 : return (m_reg == other.m_reg
3127 : 33 : && m_decl == other.m_decl);
3128 : : }
3129 : :
3130 : 66 : int get_controlling_option () const final override
3131 : : {
3132 : 66 : return OPT_Wanalyzer_write_to_const;
3133 : : }
3134 : :
3135 : 33 : bool emit (diagnostic_emission_context &ctxt) final override
3136 : : {
3137 : 33 : auto_diagnostic_group d;
3138 : 33 : bool warned;
3139 : 33 : switch (m_reg->get_kind ())
3140 : : {
3141 : 20 : default:
3142 : 20 : warned = ctxt.warn ("write to %<const%> object %qE", m_decl);
3143 : 20 : break;
3144 : 9 : case RK_FUNCTION:
3145 : 9 : warned = ctxt.warn ("write to function %qE", m_decl);
3146 : 9 : break;
3147 : 4 : case RK_LABEL:
3148 : 4 : warned = ctxt.warn ("write to label %qE", m_decl);
3149 : 4 : break;
3150 : : }
3151 : 33 : if (warned)
3152 : 33 : inform (DECL_SOURCE_LOCATION (m_decl), "declared here");
3153 : 66 : return warned;
3154 : 33 : }
3155 : :
3156 : : bool
3157 : 66 : describe_final_event (pretty_printer &pp,
3158 : : const evdesc::final_event &) final override
3159 : : {
3160 : 66 : switch (m_reg->get_kind ())
3161 : : {
3162 : 40 : default:
3163 : 40 : {
3164 : 40 : pp_printf (&pp,
3165 : : "write to %<const%> object %qE here", m_decl);
3166 : 40 : return true;
3167 : : }
3168 : 18 : case RK_FUNCTION:
3169 : 18 : {
3170 : 18 : pp_printf (&pp,
3171 : : "write to function %qE here", m_decl);
3172 : 18 : return true;
3173 : : }
3174 : 8 : case RK_LABEL:
3175 : 8 : {
3176 : 8 : pp_printf (&pp,
3177 : : "write to label %qE here", m_decl);
3178 : 8 : return true;
3179 : : }
3180 : : }
3181 : : }
3182 : :
3183 : : private:
3184 : : const region *m_reg;
3185 : : tree m_decl;
3186 : : };
3187 : :
3188 : : /* A subclass of pending_diagnostic for complaining about writes to
3189 : : string literals. */
3190 : :
3191 : : class write_to_string_literal_diagnostic
3192 : : : public pending_diagnostic_subclass<write_to_string_literal_diagnostic>
3193 : : {
3194 : : public:
3195 : 51 : write_to_string_literal_diagnostic (const region *reg)
3196 : 51 : : m_reg (reg)
3197 : : {}
3198 : :
3199 : 200 : const char *get_kind () const final override
3200 : : {
3201 : 200 : return "write_to_string_literal_diagnostic";
3202 : : }
3203 : :
3204 : 47 : bool operator== (const write_to_string_literal_diagnostic &other) const
3205 : : {
3206 : 47 : return m_reg == other.m_reg;
3207 : : }
3208 : :
3209 : 94 : int get_controlling_option () const final override
3210 : : {
3211 : 94 : return OPT_Wanalyzer_write_to_string_literal;
3212 : : }
3213 : :
3214 : 43 : bool emit (diagnostic_emission_context &ctxt) final override
3215 : : {
3216 : 43 : return ctxt.warn ("write to string literal");
3217 : : /* Ideally we would show the location of the STRING_CST as well,
3218 : : but it is not available at this point. */
3219 : : }
3220 : :
3221 : : bool
3222 : 86 : describe_final_event (pretty_printer &pp,
3223 : : const evdesc::final_event &) final override
3224 : : {
3225 : 86 : pp_string (&pp, "write to string literal here");
3226 : 86 : return true;
3227 : : }
3228 : :
3229 : : private:
3230 : : const region *m_reg;
3231 : : };
3232 : :
3233 : : /* Use CTXT to warn If DEST_REG is a region that shouldn't be written to. */
3234 : :
3235 : : void
3236 : 195590 : region_model::check_for_writable_region (const region* dest_reg,
3237 : : region_model_context *ctxt) const
3238 : : {
3239 : : /* Fail gracefully if CTXT is NULL. */
3240 : 195590 : if (!ctxt)
3241 : : return;
3242 : :
3243 : 195590 : const region *base_reg = dest_reg->get_base_region ();
3244 : 195590 : switch (base_reg->get_kind ())
3245 : : {
3246 : : default:
3247 : : break;
3248 : 9 : case RK_FUNCTION:
3249 : 9 : {
3250 : 9 : const function_region *func_reg = as_a <const function_region *> (base_reg);
3251 : 9 : tree fndecl = func_reg->get_fndecl ();
3252 : 9 : ctxt->warn (make_unique<write_to_const_diagnostic>
3253 : 18 : (func_reg, fndecl));
3254 : : }
3255 : 9 : break;
3256 : 4 : case RK_LABEL:
3257 : 4 : {
3258 : 4 : const label_region *label_reg = as_a <const label_region *> (base_reg);
3259 : 4 : tree label = label_reg->get_label ();
3260 : 4 : ctxt->warn (make_unique<write_to_const_diagnostic>
3261 : 8 : (label_reg, label));
3262 : : }
3263 : 4 : break;
3264 : 183372 : case RK_DECL:
3265 : 183372 : {
3266 : 183372 : const decl_region *decl_reg = as_a <const decl_region *> (base_reg);
3267 : 183372 : tree decl = decl_reg->get_decl ();
3268 : : /* Warn about writes to const globals.
3269 : : Don't warn for writes to const locals, and params in particular,
3270 : : since we would warn in push_frame when setting them up (e.g the
3271 : : "this" param is "T* const"). */
3272 : 183372 : if (TREE_READONLY (decl)
3273 : 183372 : && is_global_var (decl))
3274 : 20 : ctxt->warn (make_unique<write_to_const_diagnostic> (dest_reg, decl));
3275 : : }
3276 : 183372 : break;
3277 : 51 : case RK_STRING:
3278 : 51 : ctxt->warn (make_unique<write_to_string_literal_diagnostic> (dest_reg));
3279 : 51 : break;
3280 : : }
3281 : : }
3282 : :
3283 : : /* Get the capacity of REG in bytes. */
3284 : :
3285 : : const svalue *
3286 : 690227 : region_model::get_capacity (const region *reg) const
3287 : : {
3288 : 690259 : switch (reg->get_kind ())
3289 : : {
3290 : : default:
3291 : : break;
3292 : 630562 : case RK_DECL:
3293 : 630562 : {
3294 : 630562 : const decl_region *decl_reg = as_a <const decl_region *> (reg);
3295 : 630562 : tree decl = decl_reg->get_decl ();
3296 : 630562 : if (TREE_CODE (decl) == SSA_NAME)
3297 : : {
3298 : 555920 : tree type = TREE_TYPE (decl);
3299 : 555920 : tree size = TYPE_SIZE (type);
3300 : 555920 : return get_rvalue (size, NULL);
3301 : : }
3302 : : else
3303 : : {
3304 : 74642 : tree size = decl_init_size (decl, false);
3305 : 74642 : if (size)
3306 : 74473 : return get_rvalue (size, NULL);
3307 : : }
3308 : : }
3309 : : break;
3310 : 32 : case RK_SIZED:
3311 : : /* Look through sized regions to get at the capacity
3312 : : of the underlying regions. */
3313 : 32 : return get_capacity (reg->get_parent_region ());
3314 : 456 : case RK_STRING:
3315 : 456 : {
3316 : : /* "Capacity" here means "size". */
3317 : 456 : const string_region *string_reg = as_a <const string_region *> (reg);
3318 : 456 : tree string_cst = string_reg->get_string_cst ();
3319 : 456 : return m_mgr->get_or_create_int_cst (size_type_node,
3320 : 456 : TREE_STRING_LENGTH (string_cst));
3321 : : }
3322 : 59378 : break;
3323 : : }
3324 : :
3325 : 59378 : if (const svalue *recorded = get_dynamic_extents (reg))
3326 : : return recorded;
3327 : :
3328 : 46861 : return m_mgr->get_or_create_unknown_svalue (sizetype);
3329 : : }
3330 : :
3331 : : /* If CTXT is non-NULL, use it to warn about any problems accessing REG,
3332 : : using DIR to determine if this access is a read or write.
3333 : : Return TRUE if an OOB access was detected.
3334 : : If SVAL_HINT is non-NULL, use it as a hint in diagnostics
3335 : : about the value that would be written to REG. */
3336 : :
3337 : : bool
3338 : 4021943 : region_model::check_region_access (const region *reg,
3339 : : enum access_direction dir,
3340 : : const svalue *sval_hint,
3341 : : region_model_context *ctxt) const
3342 : : {
3343 : : /* Fail gracefully if CTXT is NULL. */
3344 : 4021943 : if (!ctxt)
3345 : : return false;
3346 : :
3347 : 682046 : bool oob_access_detected = false;
3348 : 682046 : check_region_for_taint (reg, dir, ctxt);
3349 : 682046 : if (!check_region_bounds (reg, dir, sval_hint, ctxt))
3350 : 743 : oob_access_detected = true;
3351 : :
3352 : 682046 : switch (dir)
3353 : : {
3354 : 0 : default:
3355 : 0 : gcc_unreachable ();
3356 : : case DIR_READ:
3357 : : /* Currently a no-op. */
3358 : : break;
3359 : 195590 : case DIR_WRITE:
3360 : 195590 : check_for_writable_region (reg, ctxt);
3361 : 195590 : break;
3362 : : }
3363 : : return oob_access_detected;
3364 : : }
3365 : :
3366 : : /* If CTXT is non-NULL, use it to warn about any problems writing to REG. */
3367 : :
3368 : : void
3369 : 317193 : region_model::check_region_for_write (const region *dest_reg,
3370 : : const svalue *sval_hint,
3371 : : region_model_context *ctxt) const
3372 : : {
3373 : 317193 : check_region_access (dest_reg, DIR_WRITE, sval_hint, ctxt);
3374 : 317193 : }
3375 : :
3376 : : /* If CTXT is non-NULL, use it to warn about any problems reading from REG.
3377 : : Returns TRUE if an OOB read was detected. */
3378 : :
3379 : : bool
3380 : 3704750 : region_model::check_region_for_read (const region *src_reg,
3381 : : region_model_context *ctxt) const
3382 : : {
3383 : 3704750 : return check_region_access (src_reg, DIR_READ, NULL, ctxt);
3384 : : }
3385 : :
3386 : : /* Concrete subclass for casts of pointers that lead to trailing bytes. */
3387 : :
3388 : : class dubious_allocation_size
3389 : : : public pending_diagnostic_subclass<dubious_allocation_size>
3390 : : {
3391 : : public:
3392 : 134 : dubious_allocation_size (const region *lhs, const region *rhs,
3393 : : const svalue *capacity_sval, tree expr,
3394 : : const gimple *stmt)
3395 : 134 : : m_lhs (lhs), m_rhs (rhs),
3396 : 134 : m_capacity_sval (capacity_sval), m_expr (expr),
3397 : 134 : m_stmt (stmt),
3398 : 134 : m_has_allocation_event (false)
3399 : : {
3400 : 134 : gcc_assert (m_capacity_sval);
3401 : : }
3402 : :
3403 : 538 : const char *get_kind () const final override
3404 : : {
3405 : 538 : return "dubious_allocation_size";
3406 : : }
3407 : :
3408 : 134 : bool operator== (const dubious_allocation_size &other) const
3409 : : {
3410 : 134 : return (m_stmt == other.m_stmt
3411 : 134 : && pending_diagnostic::same_tree_p (m_expr, other.m_expr));
3412 : : }
3413 : :
3414 : 236 : int get_controlling_option () const final override
3415 : : {
3416 : 236 : return OPT_Wanalyzer_allocation_size;
3417 : : }
3418 : :
3419 : 114 : bool emit (diagnostic_emission_context &ctxt) final override
3420 : : {
3421 : 114 : ctxt.add_cwe (131);
3422 : :
3423 : 114 : return ctxt.warn ("allocated buffer size is not a multiple"
3424 : 114 : " of the pointee's size");
3425 : : }
3426 : :
3427 : : bool
3428 : 228 : describe_final_event (pretty_printer &pp,
3429 : : const evdesc::final_event &) final override
3430 : : {
3431 : 228 : tree pointee_type = TREE_TYPE (m_lhs->get_type ());
3432 : 228 : if (m_has_allocation_event)
3433 : : {
3434 : 188 : pp_printf (&pp,
3435 : : "assigned to %qT here;"
3436 : : " %<sizeof (%T)%> is %qE",
3437 : 188 : m_lhs->get_type (), pointee_type,
3438 : : size_in_bytes (pointee_type));
3439 : 188 : return true;
3440 : : }
3441 : : /* Fallback: Typically, we should always see an allocation_event
3442 : : before. */
3443 : 40 : if (m_expr)
3444 : : {
3445 : 40 : if (TREE_CODE (m_expr) == INTEGER_CST)
3446 : : {
3447 : 8 : pp_printf (&pp,
3448 : : "allocated %E bytes and assigned to"
3449 : : " %qT here; %<sizeof (%T)%> is %qE",
3450 : 8 : m_expr, m_lhs->get_type (), pointee_type,
3451 : : size_in_bytes (pointee_type));
3452 : 8 : return true;
3453 : : }
3454 : : else
3455 : : {
3456 : 32 : pp_printf (&pp,
3457 : : "allocated %qE bytes and assigned to"
3458 : : " %qT here; %<sizeof (%T)%> is %qE",
3459 : 32 : m_expr, m_lhs->get_type (), pointee_type,
3460 : : size_in_bytes (pointee_type));
3461 : 32 : return true;
3462 : : }
3463 : : }
3464 : :
3465 : 0 : pp_printf (&pp,
3466 : : "allocated and assigned to %qT here;"
3467 : : " %<sizeof (%T)%> is %qE",
3468 : 0 : m_lhs->get_type (), pointee_type,
3469 : : size_in_bytes (pointee_type));
3470 : 0 : return true;
3471 : : }
3472 : :
3473 : : void
3474 : 94 : add_region_creation_events (const region *,
3475 : : tree capacity,
3476 : : const event_loc_info &loc_info,
3477 : : checker_path &emission_path) final override
3478 : : {
3479 : 94 : emission_path.add_event
3480 : 94 : (make_unique<region_creation_event_allocation_size> (capacity, loc_info));
3481 : :
3482 : 94 : m_has_allocation_event = true;
3483 : 94 : }
3484 : :
3485 : 114 : void mark_interesting_stuff (interesting_t *interest) final override
3486 : : {
3487 : 114 : interest->add_region_creation (m_rhs);
3488 : 114 : }
3489 : :
3490 : 0 : void maybe_add_sarif_properties (sarif_object &result_obj)
3491 : : const final override
3492 : : {
3493 : 0 : sarif_property_bag &props = result_obj.get_or_create_properties ();
3494 : : #define PROPERTY_PREFIX "gcc/analyzer/dubious_allocation_size/"
3495 : 0 : props.set (PROPERTY_PREFIX "lhs", m_lhs->to_json ());
3496 : 0 : props.set (PROPERTY_PREFIX "rhs", m_rhs->to_json ());
3497 : 0 : props.set (PROPERTY_PREFIX "capacity_sval", m_capacity_sval->to_json ());
3498 : : #undef PROPERTY_PREFIX
3499 : 0 : }
3500 : :
3501 : : private:
3502 : : const region *m_lhs;
3503 : : const region *m_rhs;
3504 : : const svalue *m_capacity_sval;
3505 : : const tree m_expr;
3506 : : const gimple *m_stmt;
3507 : : bool m_has_allocation_event;
3508 : : };
3509 : :
3510 : : /* Return true on dubious allocation sizes for constant sizes. */
3511 : :
3512 : : static bool
3513 : 2301 : capacity_compatible_with_type (tree cst, tree pointee_size_tree,
3514 : : bool is_struct)
3515 : : {
3516 : 2301 : gcc_assert (TREE_CODE (cst) == INTEGER_CST);
3517 : 2301 : gcc_assert (TREE_CODE (pointee_size_tree) == INTEGER_CST);
3518 : :
3519 : 2301 : unsigned HOST_WIDE_INT pointee_size = TREE_INT_CST_LOW (pointee_size_tree);
3520 : 2301 : unsigned HOST_WIDE_INT alloc_size = TREE_INT_CST_LOW (cst);
3521 : :
3522 : 2301 : if (is_struct)
3523 : 822 : return alloc_size == 0 || alloc_size >= pointee_size;
3524 : 1479 : return alloc_size % pointee_size == 0;
3525 : : }
3526 : :
3527 : : static bool
3528 : 628 : capacity_compatible_with_type (tree cst, tree pointee_size_tree)
3529 : : {
3530 : 0 : return capacity_compatible_with_type (cst, pointee_size_tree, false);
3531 : : }
3532 : :
3533 : : /* Checks whether SVAL could be a multiple of SIZE_CST.
3534 : :
3535 : : It works by visiting all svalues inside SVAL until it reaches
3536 : : atomic nodes. From those, it goes back up again and adds each
3537 : : node that is not a multiple of SIZE_CST to the RESULT_SET. */
3538 : :
3539 : 2136 : class size_visitor : public visitor
3540 : : {
3541 : : public:
3542 : 1068 : size_visitor (tree size_cst, const svalue *root_sval, constraint_manager *cm)
3543 : 1068 : : m_size_cst (size_cst), m_root_sval (root_sval), m_cm (cm)
3544 : : {
3545 : 1068 : m_root_sval->accept (this);
3546 : 1068 : }
3547 : :
3548 : 1068 : bool is_dubious_capacity ()
3549 : : {
3550 : 1068 : return result_set.contains (m_root_sval);
3551 : : }
3552 : :
3553 : 668 : void visit_constant_svalue (const constant_svalue *sval) final override
3554 : : {
3555 : 668 : check_constant (sval->get_constant (), sval);
3556 : 668 : }
3557 : :
3558 : 421 : void visit_unaryop_svalue (const unaryop_svalue *sval) final override
3559 : : {
3560 : 421 : if (CONVERT_EXPR_CODE_P (sval->get_op ())
3561 : 495 : && result_set.contains (sval->get_arg ()))
3562 : 141 : result_set.add (sval);
3563 : 421 : }
3564 : :
3565 : 684 : void visit_binop_svalue (const binop_svalue *sval) final override
3566 : : {
3567 : 684 : const svalue *arg0 = sval->get_arg0 ();
3568 : 684 : const svalue *arg1 = sval->get_arg1 ();
3569 : :
3570 : 684 : switch (sval->get_op ())
3571 : : {
3572 : 501 : case MULT_EXPR:
3573 : 501 : if (result_set.contains (arg0) && result_set.contains (arg1))
3574 : 28 : result_set.add (sval);
3575 : : break;
3576 : 127 : case PLUS_EXPR:
3577 : 127 : case MINUS_EXPR:
3578 : 127 : if (result_set.contains (arg0) || result_set.contains (arg1))
3579 : 51 : result_set.add (sval);
3580 : : break;
3581 : : default:
3582 : : break;
3583 : : }
3584 : 684 : }
3585 : :
3586 : 0 : void visit_unmergeable_svalue (const unmergeable_svalue *sval) final override
3587 : : {
3588 : 0 : if (result_set.contains (sval->get_arg ()))
3589 : 0 : result_set.add (sval);
3590 : 0 : }
3591 : :
3592 : 12 : void visit_widening_svalue (const widening_svalue *sval) final override
3593 : : {
3594 : 12 : const svalue *base = sval->get_base_svalue ();
3595 : 12 : const svalue *iter = sval->get_iter_svalue ();
3596 : :
3597 : 12 : if (result_set.contains (base) || result_set.contains (iter))
3598 : 8 : result_set.add (sval);
3599 : 12 : }
3600 : :
3601 : 511 : void visit_initial_svalue (const initial_svalue *sval) final override
3602 : : {
3603 : 511 : equiv_class_id id = equiv_class_id::null ();
3604 : 511 : if (m_cm->get_equiv_class_by_svalue (sval, &id))
3605 : : {
3606 : 176 : if (tree cst = id.get_obj (*m_cm).get_any_constant ())
3607 : 0 : check_constant (cst, sval);
3608 : : }
3609 : 335 : else if (!m_cm->sval_constrained_p (sval))
3610 : : {
3611 : 267 : result_set.add (sval);
3612 : : }
3613 : 511 : }
3614 : :
3615 : 36 : void visit_conjured_svalue (const conjured_svalue *sval) final override
3616 : : {
3617 : 36 : equiv_class_id id = equiv_class_id::null ();
3618 : 36 : if (m_cm->get_equiv_class_by_svalue (sval, &id))
3619 : 14 : if (tree cst = id.get_obj (*m_cm).get_any_constant ())
3620 : 8 : check_constant (cst, sval);
3621 : 36 : }
3622 : :
3623 : : private:
3624 : 676 : void check_constant (tree cst, const svalue *sval)
3625 : : {
3626 : 676 : switch (TREE_CODE (cst))
3627 : : {
3628 : : default:
3629 : : /* Assume all unhandled operands are compatible. */
3630 : : break;
3631 : 628 : case INTEGER_CST:
3632 : 628 : if (!capacity_compatible_with_type (cst, m_size_cst))
3633 : 111 : result_set.add (sval);
3634 : : break;
3635 : : }
3636 : 676 : }
3637 : :
3638 : : tree m_size_cst;
3639 : : const svalue *m_root_sval;
3640 : : constraint_manager *m_cm;
3641 : : svalue_set result_set; /* Used as a mapping of svalue*->bool. */
3642 : : };
3643 : :
3644 : : /* Return true if SIZE_CST is a power of 2, and we have
3645 : : CAPACITY_SVAL == ((X | (Y - 1) ) + 1), since it is then a multiple
3646 : : of SIZE_CST, as used by Linux kernel's round_up macro. */
3647 : :
3648 : : static bool
3649 : 1076 : is_round_up (tree size_cst,
3650 : : const svalue *capacity_sval)
3651 : : {
3652 : 1076 : if (!integer_pow2p (size_cst))
3653 : : return false;
3654 : 1076 : const binop_svalue *binop_sval = capacity_sval->dyn_cast_binop_svalue ();
3655 : 1076 : if (!binop_sval)
3656 : : return false;
3657 : 449 : if (binop_sval->get_op () != PLUS_EXPR)
3658 : : return false;
3659 : 100 : tree rhs_cst = binop_sval->get_arg1 ()->maybe_get_constant ();
3660 : 100 : if (!rhs_cst)
3661 : : return false;
3662 : 100 : if (!integer_onep (rhs_cst))
3663 : : return false;
3664 : :
3665 : : /* We have CAPACITY_SVAL == (LHS + 1) for some LHS expression. */
3666 : :
3667 : 8 : const binop_svalue *lhs_binop_sval
3668 : 8 : = binop_sval->get_arg0 ()->dyn_cast_binop_svalue ();
3669 : 8 : if (!lhs_binop_sval)
3670 : : return false;
3671 : 8 : if (lhs_binop_sval->get_op () != BIT_IOR_EXPR)
3672 : : return false;
3673 : :
3674 : 8 : tree inner_rhs_cst = lhs_binop_sval->get_arg1 ()->maybe_get_constant ();
3675 : 8 : if (!inner_rhs_cst)
3676 : : return false;
3677 : :
3678 : 8 : if (wi::to_widest (inner_rhs_cst) + 1 != wi::to_widest (size_cst))
3679 : : return false;
3680 : : return true;
3681 : : }
3682 : :
3683 : : /* Return true if CAPACITY_SVAL is known to be a multiple of SIZE_CST. */
3684 : :
3685 : : static bool
3686 : 1076 : is_multiple_p (tree size_cst,
3687 : : const svalue *capacity_sval)
3688 : : {
3689 : 1140 : if (const svalue *sval = capacity_sval->maybe_undo_cast ())
3690 : : return is_multiple_p (size_cst, sval);
3691 : :
3692 : 1076 : if (is_round_up (size_cst, capacity_sval))
3693 : : return true;
3694 : :
3695 : : return false;
3696 : : }
3697 : :
3698 : : /* Return true if we should emit a dubious_allocation_size warning
3699 : : on assigning a region of capacity CAPACITY_SVAL bytes to a pointer
3700 : : of type with size SIZE_CST, where CM expresses known constraints. */
3701 : :
3702 : : static bool
3703 : 1076 : is_dubious_capacity (tree size_cst,
3704 : : const svalue *capacity_sval,
3705 : : constraint_manager *cm)
3706 : : {
3707 : 1076 : if (is_multiple_p (size_cst, capacity_sval))
3708 : : return false;
3709 : 1068 : size_visitor v (size_cst, capacity_sval, cm);
3710 : 1068 : return v.is_dubious_capacity ();
3711 : 1068 : }
3712 : :
3713 : :
3714 : : /* Return true if a struct or union either uses the inheritance pattern,
3715 : : where the first field is a base struct, or the flexible array member
3716 : : pattern, where the last field is an array without a specified size. */
3717 : :
3718 : : static bool
3719 : 3988 : struct_or_union_with_inheritance_p (tree struc)
3720 : : {
3721 : 3988 : tree iter = TYPE_FIELDS (struc);
3722 : 3988 : if (iter == NULL_TREE)
3723 : : return false;
3724 : 3979 : if (RECORD_OR_UNION_TYPE_P (TREE_TYPE (iter)))
3725 : : return true;
3726 : :
3727 : : tree last_field;
3728 : 39099 : while (iter != NULL_TREE)
3729 : : {
3730 : 35371 : last_field = iter;
3731 : 35371 : iter = DECL_CHAIN (iter);
3732 : : }
3733 : :
3734 : 3728 : if (last_field != NULL_TREE
3735 : 3728 : && TREE_CODE (TREE_TYPE (last_field)) == ARRAY_TYPE)
3736 : : return true;
3737 : :
3738 : : return false;
3739 : : }
3740 : :
3741 : : /* Return true if the lhs and rhs of an assignment have different types. */
3742 : :
3743 : : static bool
3744 : 163263 : is_any_cast_p (const gimple *stmt)
3745 : : {
3746 : 163263 : if (const gassign *assign = dyn_cast <const gassign *> (stmt))
3747 : 120115 : return gimple_assign_cast_p (assign)
3748 : 226146 : || !pending_diagnostic::same_tree_p (
3749 : 106031 : TREE_TYPE (gimple_assign_lhs (assign)),
3750 : 106031 : TREE_TYPE (gimple_assign_rhs1 (assign)));
3751 : 43148 : else if (const gcall *call = dyn_cast <const gcall *> (stmt))
3752 : : {
3753 : 34955 : tree lhs = gimple_call_lhs (call);
3754 : 64783 : return lhs != NULL_TREE && !pending_diagnostic::same_tree_p (
3755 : 29828 : TREE_TYPE (gimple_call_lhs (call)),
3756 : : gimple_call_return_type (call));
3757 : : }
3758 : :
3759 : : return false;
3760 : : }
3761 : :
3762 : : /* On pointer assignments, check whether the buffer size of
3763 : : RHS_SVAL is compatible with the type of the LHS_REG.
3764 : : Use a non-null CTXT to report allocation size warnings. */
3765 : :
3766 : : void
3767 : 315594 : region_model::check_region_size (const region *lhs_reg, const svalue *rhs_sval,
3768 : : region_model_context *ctxt) const
3769 : : {
3770 : 315594 : if (!ctxt || ctxt->get_stmt () == NULL)
3771 : 310050 : return;
3772 : : /* Only report warnings on assignments that actually change the type. */
3773 : 163263 : if (!is_any_cast_p (ctxt->get_stmt ()))
3774 : : return;
3775 : :
3776 : 41868 : tree pointer_type = lhs_reg->get_type ();
3777 : 41868 : if (pointer_type == NULL_TREE || !POINTER_TYPE_P (pointer_type))
3778 : : return;
3779 : :
3780 : 9304 : tree pointee_type = TREE_TYPE (pointer_type);
3781 : : /* Make sure that the type on the left-hand size actually has a size. */
3782 : 9304 : if (pointee_type == NULL_TREE || VOID_TYPE_P (pointee_type)
3783 : 18217 : || TYPE_SIZE_UNIT (pointee_type) == NULL_TREE)
3784 : : return;
3785 : :
3786 : : /* Bail out early on function pointers. */
3787 : 8801 : if (TREE_CODE (pointee_type) == FUNCTION_TYPE)
3788 : : return;
3789 : :
3790 : : /* Bail out early on pointers to structs where we can
3791 : : not deduce whether the buffer size is compatible. */
3792 : 8500 : bool is_struct = RECORD_OR_UNION_TYPE_P (pointee_type);
3793 : 8500 : if (is_struct && struct_or_union_with_inheritance_p (pointee_type))
3794 : : return;
3795 : :
3796 : 8206 : tree pointee_size_tree = size_in_bytes (pointee_type);
3797 : : /* We give up if the type size is not known at compile-time or the
3798 : : type size is always compatible regardless of the buffer size. */
3799 : 8206 : if (TREE_CODE (pointee_size_tree) != INTEGER_CST
3800 : 8048 : || integer_zerop (pointee_size_tree)
3801 : 16229 : || integer_onep (pointee_size_tree))
3802 : 2662 : return;
3803 : :
3804 : 5544 : const region *rhs_reg = deref_rvalue (rhs_sval, NULL_TREE, ctxt, false);
3805 : 5544 : const svalue *capacity = get_capacity (rhs_reg);
3806 : 5544 : switch (capacity->get_kind ())
3807 : : {
3808 : 1673 : case svalue_kind::SK_CONSTANT:
3809 : 1673 : {
3810 : 1673 : const constant_svalue *cst_cap_sval
3811 : 1673 : = as_a <const constant_svalue *> (capacity);
3812 : 1673 : tree cst_cap = cst_cap_sval->get_constant ();
3813 : 1673 : if (TREE_CODE (cst_cap) == INTEGER_CST
3814 : 1673 : && !capacity_compatible_with_type (cst_cap, pointee_size_tree,
3815 : : is_struct))
3816 : 70 : ctxt->warn (make_unique <dubious_allocation_size> (lhs_reg, rhs_reg,
3817 : : capacity, cst_cap,
3818 : 140 : ctxt->get_stmt ()));
3819 : : }
3820 : 1673 : break;
3821 : 3871 : default:
3822 : 3871 : {
3823 : 3871 : if (!is_struct)
3824 : : {
3825 : 1076 : if (is_dubious_capacity (pointee_size_tree,
3826 : : capacity,
3827 : 1076 : m_constraints))
3828 : : {
3829 : 64 : tree expr = get_representative_tree (capacity);
3830 : 64 : ctxt->warn (make_unique <dubious_allocation_size> (lhs_reg,
3831 : : rhs_reg,
3832 : : capacity, expr,
3833 : 128 : ctxt->get_stmt ()));
3834 : : }
3835 : : }
3836 : : break;
3837 : : }
3838 : : }
3839 : : }
3840 : :
3841 : : /* Set the value of the region given by LHS_REG to the value given
3842 : : by RHS_SVAL.
3843 : : Use CTXT to report any warnings associated with writing to LHS_REG. */
3844 : :
3845 : : void
3846 : 315614 : region_model::set_value (const region *lhs_reg, const svalue *rhs_sval,
3847 : : region_model_context *ctxt)
3848 : : {
3849 : 315614 : gcc_assert (lhs_reg);
3850 : 315614 : gcc_assert (rhs_sval);
3851 : :
3852 : : /* Setting the value of an empty region is a no-op. */
3853 : 315614 : if (lhs_reg->empty_p ())
3854 : : return;
3855 : :
3856 : 315594 : check_region_size (lhs_reg, rhs_sval, ctxt);
3857 : :
3858 : 315594 : check_region_for_write (lhs_reg, rhs_sval, ctxt);
3859 : :
3860 : 510163 : m_store.set_value (m_mgr->get_store_manager(), lhs_reg, rhs_sval,
3861 : 194569 : ctxt ? ctxt->get_uncertainty () : NULL);
3862 : : }
3863 : :
3864 : : /* Set the value of the region given by LHS to the value given by RHS. */
3865 : :
3866 : : void
3867 : 84 : region_model::set_value (tree lhs, tree rhs, region_model_context *ctxt)
3868 : : {
3869 : 84 : const region *lhs_reg = get_lvalue (lhs, ctxt);
3870 : 84 : const svalue *rhs_sval = get_rvalue (rhs, ctxt);
3871 : 84 : gcc_assert (lhs_reg);
3872 : 84 : gcc_assert (rhs_sval);
3873 : 84 : set_value (lhs_reg, rhs_sval, ctxt);
3874 : 84 : }
3875 : :
3876 : : /* Issue a note specifying that a particular function parameter is expected
3877 : : to be a valid null-terminated string. */
3878 : :
3879 : : static void
3880 : 146 : inform_about_expected_null_terminated_string_arg (const call_arg_details &ad)
3881 : : {
3882 : : // TODO: ideally we'd underline the param here
3883 : 146 : inform (DECL_SOURCE_LOCATION (ad.m_called_fndecl),
3884 : : "argument %d of %qD must be a pointer to a null-terminated string",
3885 : 146 : ad.m_arg_idx + 1, ad.m_called_fndecl);
3886 : 146 : }
3887 : :
3888 : : /* A binding of a specific svalue at a concrete byte range. */
3889 : :
3890 : : struct fragment
3891 : : {
3892 : 3855 : fragment ()
3893 : 3855 : : m_byte_range (0, 0), m_sval (nullptr)
3894 : : {
3895 : 3855 : }
3896 : :
3897 : 683 : fragment (const byte_range &bytes, const svalue *sval)
3898 : 683 : : m_byte_range (bytes), m_sval (sval)
3899 : : {
3900 : : }
3901 : :
3902 : 571 : static int cmp_ptrs (const void *p1, const void *p2)
3903 : : {
3904 : 571 : const fragment *f1 = (const fragment *)p1;
3905 : 571 : const fragment *f2 = (const fragment *)p2;
3906 : 571 : return byte_range::cmp (f1->m_byte_range, f2->m_byte_range);
3907 : : }
3908 : :
3909 : : void
3910 : 0 : dump_to_pp (pretty_printer *pp) const
3911 : : {
3912 : 0 : pp_string (pp, "fragment(");
3913 : 0 : m_byte_range.dump_to_pp (pp);
3914 : 0 : pp_string (pp, ", sval: ");
3915 : 0 : if (m_sval)
3916 : 0 : m_sval->dump_to_pp (pp, true);
3917 : : else
3918 : 0 : pp_string (pp, "nullptr");
3919 : 0 : pp_string (pp, ")");
3920 : 0 : }
3921 : :
3922 : : byte_range m_byte_range;
3923 : : const svalue *m_sval;
3924 : : };
3925 : :
3926 : : /* Determine if there is a zero terminator somewhere in the
3927 : : part of STRING_CST covered by BYTES (where BYTES is relative to the
3928 : : start of the constant).
3929 : :
3930 : : Return a tristate:
3931 : : - true if there definitely is a zero byte, writing to *OUT_BYTES_READ
3932 : : the number of bytes from that would be read, including the zero byte.
3933 : : - false if there definitely isn't a zero byte
3934 : : - unknown if we don't know. */
3935 : :
3936 : : static tristate
3937 : 287 : string_cst_has_null_terminator (tree string_cst,
3938 : : const byte_range &bytes,
3939 : : byte_offset_t *out_bytes_read)
3940 : : {
3941 : 287 : gcc_assert (bytes.m_start_byte_offset >= 0);
3942 : :
3943 : : /* If we're beyond the string_cst, reads are unsuccessful. */
3944 : 287 : if (tree cst_size = get_string_cst_size (string_cst))
3945 : 287 : if (TREE_CODE (cst_size) == INTEGER_CST)
3946 : 287 : if (bytes.m_start_byte_offset >= TREE_INT_CST_LOW (cst_size))
3947 : 0 : return tristate::unknown ();
3948 : :
3949 : : /* Assume all bytes after TREE_STRING_LENGTH are zero. This handles
3950 : : the case where an array is initialized with a string_cst that isn't
3951 : : as long as the array, where the remaining elements are
3952 : : empty-initialized and thus zeroed. */
3953 : 287 : if (bytes.m_start_byte_offset >= TREE_STRING_LENGTH (string_cst))
3954 : : {
3955 : 2 : *out_bytes_read = 1;
3956 : 2 : return tristate (true);
3957 : : }
3958 : :
3959 : : /* Look for the first 0 byte within STRING_CST
3960 : : from START_READ_OFFSET onwards. */
3961 : 285 : const byte_offset_t num_bytes_to_search
3962 : 570 : = std::min<byte_offset_t> ((TREE_STRING_LENGTH (string_cst)
3963 : 285 : - bytes.m_start_byte_offset),
3964 : 285 : bytes.m_size_in_bytes);
3965 : 285 : const char *start = (TREE_STRING_POINTER (string_cst)
3966 : 285 : + bytes.m_start_byte_offset.slow ());
3967 : 285 : if (num_bytes_to_search >= 0)
3968 : 285 : if (const void *p = memchr (start, 0, bytes.m_size_in_bytes.slow ()))
3969 : : {
3970 : 142 : *out_bytes_read = (const char *)p - start + 1;
3971 : 142 : return tristate (true);
3972 : : }
3973 : :
3974 : 143 : *out_bytes_read = bytes.m_size_in_bytes;
3975 : 143 : return tristate (false);
3976 : : }
3977 : :
3978 : : static tristate
3979 : : svalue_byte_range_has_null_terminator (const svalue *sval,
3980 : : const byte_range &bytes,
3981 : : byte_offset_t *out_bytes_read,
3982 : : logger *logger);
3983 : :
3984 : : /* Determine if there is a zero terminator somewhere in the
3985 : : part of SVAL covered by BYTES (where BYTES is relative to the svalue).
3986 : :
3987 : : Return a tristate:
3988 : : - true if there definitely is a zero byte, writing to *OUT_BYTES_READ
3989 : : the number of bytes from that would be read, including the zero byte.
3990 : : - false if there definitely isn't a zero byte
3991 : : - unknown if we don't know.
3992 : :
3993 : : Use LOGGER (if non-null) for any logging. */
3994 : :
3995 : : static tristate
3996 : 632 : svalue_byte_range_has_null_terminator_1 (const svalue *sval,
3997 : : const byte_range &bytes,
3998 : : byte_offset_t *out_bytes_read,
3999 : : logger *logger)
4000 : : {
4001 : 632 : if (bytes.m_start_byte_offset == 0
4002 : 632 : && sval->all_zeroes_p ())
4003 : : {
4004 : : /* The initial byte of an all-zeroes SVAL is a zero byte. */
4005 : 22 : *out_bytes_read = 1;
4006 : 22 : return tristate (true);
4007 : : }
4008 : :
4009 : 610 : switch (sval->get_kind ())
4010 : : {
4011 : 203 : case SK_CONSTANT:
4012 : 203 : {
4013 : 203 : tree cst
4014 : 203 : = as_a <const constant_svalue *> (sval)->get_constant ();
4015 : 203 : switch (TREE_CODE (cst))
4016 : : {
4017 : 184 : case STRING_CST:
4018 : 184 : return string_cst_has_null_terminator (cst, bytes, out_bytes_read);
4019 : 19 : case INTEGER_CST:
4020 : 19 : if (bytes.m_start_byte_offset == 0
4021 : 19 : && integer_onep (TYPE_SIZE_UNIT (TREE_TYPE (cst))))
4022 : : {
4023 : : /* Model accesses to the initial byte of a 1-byte
4024 : : INTEGER_CST. */
4025 : 17 : *out_bytes_read = 1;
4026 : 17 : if (zerop (cst))
4027 : 0 : return tristate (true);
4028 : : else
4029 : 17 : return tristate (false);
4030 : : }
4031 : : /* Treat any other access to an INTEGER_CST as unknown. */
4032 : 2 : return tristate::TS_UNKNOWN;
4033 : :
4034 : : default:
4035 : : break;
4036 : : }
4037 : : }
4038 : : break;
4039 : :
4040 : 112 : case SK_INITIAL:
4041 : 112 : {
4042 : 112 : const initial_svalue *initial_sval = (const initial_svalue *)sval;
4043 : 112 : const region *reg = initial_sval->get_region ();
4044 : 112 : if (const string_region *string_reg = reg->dyn_cast_string_region ())
4045 : : {
4046 : 103 : tree string_cst = string_reg->get_string_cst ();
4047 : 103 : return string_cst_has_null_terminator (string_cst,
4048 : : bytes,
4049 : 103 : out_bytes_read);
4050 : : }
4051 : 9 : return tristate::TS_UNKNOWN;
4052 : : }
4053 : 44 : break;
4054 : :
4055 : 44 : case SK_BITS_WITHIN:
4056 : 44 : {
4057 : 44 : const bits_within_svalue *bits_within_sval
4058 : : = (const bits_within_svalue *)sval;
4059 : 44 : byte_range bytes_within_inner (0, 0);
4060 : 44 : if (bits_within_sval->get_bits ().as_byte_range (&bytes_within_inner))
4061 : : {
4062 : : /* Consider e.g. looking for null terminator of
4063 : : bytes 2-4 of BITS_WITHIN(bytes 10-15 of inner_sval)
4064 : :
4065 : : This is equivalent to looking within bytes 12-14 of
4066 : : inner_sval. */
4067 : 44 : const byte_offset_t start_byte_relative_to_inner
4068 : 44 : = (bytes.m_start_byte_offset
4069 : 44 : + bytes_within_inner.m_start_byte_offset);
4070 : 44 : const byte_offset_t next_byte_relative_to_inner
4071 : 44 : = (bytes.get_next_byte_offset ()
4072 : 44 : + bytes_within_inner.m_start_byte_offset);
4073 : 44 : if (next_byte_relative_to_inner > start_byte_relative_to_inner)
4074 : : {
4075 : 44 : const byte_range relative_to_inner
4076 : : (start_byte_relative_to_inner,
4077 : 44 : next_byte_relative_to_inner - start_byte_relative_to_inner);
4078 : 44 : const svalue *inner_sval
4079 : 44 : = bits_within_sval->get_inner_svalue ();
4080 : 44 : return svalue_byte_range_has_null_terminator (inner_sval,
4081 : : relative_to_inner,
4082 : : out_bytes_read,
4083 : : logger);
4084 : : }
4085 : : }
4086 : : }
4087 : 0 : break;
4088 : :
4089 : : default:
4090 : : // TODO: it may be possible to handle other cases here.
4091 : : break;
4092 : : }
4093 : 251 : return tristate::TS_UNKNOWN;
4094 : : }
4095 : :
4096 : : /* Like svalue_byte_range_has_null_terminator_1, but add logging. */
4097 : :
4098 : : static tristate
4099 : 632 : svalue_byte_range_has_null_terminator (const svalue *sval,
4100 : : const byte_range &bytes,
4101 : : byte_offset_t *out_bytes_read,
4102 : : logger *logger)
4103 : : {
4104 : 632 : LOG_SCOPE (logger);
4105 : 632 : if (logger)
4106 : : {
4107 : 0 : pretty_printer *pp = logger->get_printer ();
4108 : 0 : logger->start_log_line ();
4109 : 0 : bytes.dump_to_pp (pp);
4110 : 0 : logger->log_partial (" of sval: ");
4111 : 0 : sval->dump_to_pp (pp, true);
4112 : 0 : logger->end_log_line ();
4113 : : }
4114 : 632 : tristate ts
4115 : 632 : = svalue_byte_range_has_null_terminator_1 (sval, bytes,
4116 : : out_bytes_read, logger);
4117 : 632 : if (logger)
4118 : : {
4119 : 0 : pretty_printer *pp = logger->get_printer ();
4120 : 0 : logger->start_log_line ();
4121 : 0 : pp_printf (pp, "has null terminator: %s", ts.as_string ());
4122 : 0 : if (ts.is_true ())
4123 : : {
4124 : 0 : pp_string (pp, "; bytes read: ");
4125 : 0 : pp_wide_int (pp, *out_bytes_read, SIGNED);
4126 : : }
4127 : 0 : logger->end_log_line ();
4128 : : }
4129 : 1264 : return ts;
4130 : 632 : }
4131 : :
4132 : : /* A frozen copy of a single base region's binding_cluster within a store,
4133 : : optimized for traversal of the concrete parts in byte order.
4134 : : This only captures concrete bindings, and is an implementation detail
4135 : : of region_model::scan_for_null_terminator. */
4136 : :
4137 : 3695 : class iterable_cluster
4138 : : {
4139 : : public:
4140 : 3695 : iterable_cluster (const binding_cluster *cluster)
4141 : 3695 : {
4142 : 3695 : if (!cluster)
4143 : : return;
4144 : 3662 : for (auto iter : *cluster)
4145 : : {
4146 : 875 : const binding_key *key = iter.first;
4147 : 875 : const svalue *sval = iter.second;
4148 : :
4149 : 1750 : if (const concrete_binding *concrete_key
4150 : 875 : = key->dyn_cast_concrete_binding ())
4151 : : {
4152 : 683 : byte_range fragment_bytes (0, 0);
4153 : 683 : if (concrete_key->get_byte_range (&fragment_bytes))
4154 : 683 : m_fragments.safe_push (fragment (fragment_bytes, sval));
4155 : : }
4156 : : else
4157 : 192 : m_symbolic_bindings.safe_push (key);
4158 : : }
4159 : 1912 : m_fragments.qsort (fragment::cmp_ptrs);
4160 : : }
4161 : :
4162 : : bool
4163 : 3855 : get_fragment_for_byte (byte_offset_t byte, fragment *out_frag) const
4164 : : {
4165 : : /* TODO: binary search rather than linear. */
4166 : 3855 : unsigned iter_idx;
4167 : 4068 : for (iter_idx = 0; iter_idx < m_fragments.length (); iter_idx++)
4168 : : {
4169 : 801 : if (m_fragments[iter_idx].m_byte_range.contains_p (byte))
4170 : : {
4171 : 588 : *out_frag = m_fragments[iter_idx];
4172 : 588 : return true;
4173 : : }
4174 : : }
4175 : : return false;
4176 : : }
4177 : :
4178 : 3267 : bool has_symbolic_bindings_p () const
4179 : : {
4180 : 6534 : return !m_symbolic_bindings.is_empty ();
4181 : : }
4182 : :
4183 : 0 : void dump_to_pp (pretty_printer *pp) const
4184 : : {
4185 : 0 : pp_string (pp, "iterable_cluster (fragments: [");
4186 : 0 : for (auto const &iter : &m_fragments)
4187 : : {
4188 : 0 : if (&iter != m_fragments.begin ())
4189 : 0 : pp_string (pp, ", ");
4190 : 0 : iter.dump_to_pp (pp);
4191 : : }
4192 : 0 : pp_printf (pp, "], symbolic bindings: [");
4193 : 0 : for (auto const &iter : m_symbolic_bindings)
4194 : : {
4195 : 0 : if (&iter != m_symbolic_bindings.begin ())
4196 : 0 : pp_string (pp, ", ");
4197 : 0 : (*iter).dump_to_pp (pp, true);
4198 : : }
4199 : 0 : pp_string (pp, "])");
4200 : 0 : }
4201 : :
4202 : : private:
4203 : : auto_vec<fragment> m_fragments;
4204 : : auto_vec<const binding_key *> m_symbolic_bindings;
4205 : : };
4206 : :
4207 : : /* Simulate reading the bytes at BYTES from BASE_REG.
4208 : : Complain to CTXT about any issues with the read e.g. out-of-bounds. */
4209 : :
4210 : : const svalue *
4211 : 7611 : region_model::get_store_bytes (const region *base_reg,
4212 : : const byte_range &bytes,
4213 : : region_model_context *ctxt) const
4214 : : {
4215 : : /* Shortcut reading all of a string_region. */
4216 : 7611 : if (bytes.get_start_byte_offset () == 0)
4217 : 7395 : if (const string_region *string_reg = base_reg->dyn_cast_string_region ())
4218 : 4208 : if (bytes.m_size_in_bytes
4219 : 4208 : == TREE_STRING_LENGTH (string_reg->get_string_cst ()))
4220 : 4208 : return m_mgr->get_or_create_initial_value (base_reg);
4221 : :
4222 : 3403 : const svalue *index_sval
4223 : 3403 : = m_mgr->get_or_create_int_cst (size_type_node,
4224 : 3403 : bytes.get_start_byte_offset ());
4225 : 3403 : const region *offset_reg = m_mgr->get_offset_region (base_reg,
4226 : : NULL_TREE,
4227 : : index_sval);
4228 : 3403 : const svalue *byte_size_sval
4229 : 3403 : = m_mgr->get_or_create_int_cst (size_type_node, bytes.m_size_in_bytes);
4230 : 3403 : const region *read_reg = m_mgr->get_sized_region (offset_reg,
4231 : : NULL_TREE,
4232 : : byte_size_sval);
4233 : :
4234 : : /* Simulate reading those bytes from the store. */
4235 : 3403 : const svalue *sval = get_store_value (read_reg, ctxt);
4236 : 3403 : return sval;
4237 : : }
4238 : :
4239 : : static tree
4240 : 2955 : get_tree_for_byte_offset (tree ptr_expr, byte_offset_t byte_offset)
4241 : : {
4242 : 2955 : gcc_assert (ptr_expr);
4243 : 2955 : tree ptype = build_pointer_type_for_mode (char_type_node, ptr_mode, true);
4244 : 2955 : return fold_build2 (MEM_REF,
4245 : : char_type_node,
4246 : : ptr_expr, wide_int_to_tree (ptype, byte_offset));
4247 : : }
4248 : :
4249 : : /* Simulate a series of reads of REG until we find a 0 byte
4250 : : (equivalent to calling strlen).
4251 : :
4252 : : Complain to CTXT and return NULL if:
4253 : : - the buffer pointed to isn't null-terminated
4254 : : - the buffer pointed to has any uninitialized bytes before any 0-terminator
4255 : : - any of the reads aren't within the bounds of the underlying base region
4256 : :
4257 : : Otherwise, return a svalue for the number of bytes read (strlen + 1),
4258 : : and, if OUT_SVAL is non-NULL, write to *OUT_SVAL with an svalue
4259 : : representing the content of REG up to and including the terminator.
4260 : :
4261 : : Algorithm
4262 : : =========
4263 : :
4264 : : Get offset for first byte to read.
4265 : : Find the binding (if any) that contains it.
4266 : : Find the size in bits of that binding.
4267 : : Round to the nearest byte (which way???)
4268 : : Or maybe give up if we have a partial binding there.
4269 : : Get the svalue from the binding.
4270 : : Determine the strlen (if any) of that svalue.
4271 : : Does it have a 0-terminator within it?
4272 : : If so, we have a partial read up to and including that terminator
4273 : : Read those bytes from the store; add to the result in the correct place.
4274 : : Finish
4275 : : If not, we have a full read of that svalue
4276 : : Read those bytes from the store; add to the result in the correct place.
4277 : : Update read/write offsets
4278 : : Continue
4279 : : If unknown:
4280 : : Result is unknown
4281 : : Finish
4282 : : */
4283 : :
4284 : : const svalue *
4285 : 8006 : region_model::scan_for_null_terminator_1 (const region *reg,
4286 : : tree expr,
4287 : : const svalue **out_sval,
4288 : : region_model_context *ctxt) const
4289 : : {
4290 : 8006 : logger *logger = ctxt ? ctxt->get_logger () : nullptr;
4291 : 8006 : store_manager *store_mgr = m_mgr->get_store_manager ();
4292 : :
4293 : 8006 : region_offset offset = reg->get_offset (m_mgr);
4294 : 8006 : if (offset.symbolic_p ())
4295 : : {
4296 : 101 : if (out_sval)
4297 : 0 : *out_sval = get_store_value (reg, nullptr);
4298 : 101 : if (logger)
4299 : 0 : logger->log ("offset is symbolic");
4300 : 101 : return m_mgr->get_or_create_unknown_svalue (size_type_node);
4301 : : }
4302 : 7905 : byte_offset_t src_byte_offset;
4303 : 7905 : if (!offset.get_concrete_byte_offset (&src_byte_offset))
4304 : : {
4305 : 0 : if (out_sval)
4306 : 0 : *out_sval = get_store_value (reg, nullptr);
4307 : 0 : if (logger)
4308 : 0 : logger->log ("can't get concrete byte offset");
4309 : 0 : return m_mgr->get_or_create_unknown_svalue (size_type_node);
4310 : : }
4311 : 7905 : const byte_offset_t initial_src_byte_offset = src_byte_offset;
4312 : 7905 : byte_offset_t dst_byte_offset = 0;
4313 : :
4314 : 7905 : const region *base_reg = reg->get_base_region ();
4315 : :
4316 : 7905 : if (const string_region *str_reg = base_reg->dyn_cast_string_region ())
4317 : : {
4318 : 4210 : tree string_cst = str_reg->get_string_cst ();
4319 : 4210 : if (const void *p = memchr (TREE_STRING_POINTER (string_cst),
4320 : : 0,
4321 : 4210 : TREE_STRING_LENGTH (string_cst)))
4322 : : {
4323 : 4210 : size_t num_bytes_read
4324 : 4210 : = (const char *)p - TREE_STRING_POINTER (string_cst) + 1;
4325 : : /* Simulate the read. */
4326 : 4210 : byte_range bytes_to_read (0, num_bytes_read);
4327 : 4210 : const svalue *sval = get_store_bytes (reg, bytes_to_read, ctxt);
4328 : 4210 : if (out_sval)
4329 : 516 : *out_sval = sval;
4330 : 4210 : if (logger)
4331 : 0 : logger->log ("using string_cst");
4332 : 4210 : return m_mgr->get_or_create_int_cst (size_type_node,
4333 : : num_bytes_read);
4334 : : }
4335 : : }
4336 : :
4337 : 3695 : const binding_cluster *cluster = m_store.get_cluster (base_reg);
4338 : 3695 : iterable_cluster c (cluster);
4339 : 3695 : if (logger)
4340 : : {
4341 : 0 : pretty_printer *pp = logger->get_printer ();
4342 : 0 : logger->start_log_line ();
4343 : 0 : c.dump_to_pp (pp);
4344 : 0 : logger->end_log_line ();
4345 : : }
4346 : :
4347 : 3695 : binding_map result;
4348 : :
4349 : 160 : while (1)
4350 : : {
4351 : 3855 : fragment f;
4352 : 3855 : if (c.get_fragment_for_byte (src_byte_offset, &f))
4353 : : {
4354 : 588 : if (logger)
4355 : : {
4356 : 0 : logger->start_log_line ();
4357 : 0 : pretty_printer *pp = logger->get_printer ();
4358 : 0 : pp_printf (pp, "src_byte_offset: ");
4359 : 0 : pp_wide_int (pp, src_byte_offset, SIGNED);
4360 : 0 : pp_string (pp, ": ");
4361 : 0 : f.dump_to_pp (pp);
4362 : 0 : logger->end_log_line ();
4363 : : }
4364 : 588 : gcc_assert (f.m_byte_range.contains_p (src_byte_offset));
4365 : : /* src_byte_offset and f.m_byte_range are both expressed relative to
4366 : : the base region.
4367 : : Convert to a byte_range relative to the svalue. */
4368 : 588 : const byte_range bytes_relative_to_svalue
4369 : 588 : (src_byte_offset - f.m_byte_range.get_start_byte_offset (),
4370 : 588 : f.m_byte_range.get_next_byte_offset () - src_byte_offset);
4371 : 588 : byte_offset_t fragment_bytes_read;
4372 : 588 : tristate is_terminated
4373 : 588 : = svalue_byte_range_has_null_terminator (f.m_sval,
4374 : : bytes_relative_to_svalue,
4375 : : &fragment_bytes_read,
4376 : : logger);
4377 : 588 : if (is_terminated.is_unknown ())
4378 : : {
4379 : 262 : if (out_sval)
4380 : 2 : *out_sval = get_store_value (reg, nullptr);
4381 : 428 : return m_mgr->get_or_create_unknown_svalue (size_type_node);
4382 : : }
4383 : :
4384 : : /* Simulate reading those bytes from the store. */
4385 : 326 : byte_range bytes_to_read (src_byte_offset, fragment_bytes_read);
4386 : 326 : const svalue *sval = get_store_bytes (base_reg, bytes_to_read, ctxt);
4387 : 326 : check_for_poison (sval, expr, nullptr, ctxt);
4388 : :
4389 : 326 : if (out_sval)
4390 : : {
4391 : 8 : byte_range bytes_to_write (dst_byte_offset, fragment_bytes_read);
4392 : 8 : const binding_key *key
4393 : 8 : = store_mgr->get_concrete_binding (bytes_to_write);
4394 : 8 : result.put (key, sval);
4395 : : }
4396 : :
4397 : 326 : src_byte_offset += fragment_bytes_read;
4398 : 326 : dst_byte_offset += fragment_bytes_read;
4399 : :
4400 : 326 : if (is_terminated.is_true ())
4401 : : {
4402 : 166 : if (out_sval)
4403 : 5 : *out_sval = m_mgr->get_or_create_compound_svalue (NULL_TREE,
4404 : : result);
4405 : 166 : if (logger)
4406 : 0 : logger->log ("got terminator");
4407 : 166 : return m_mgr->get_or_create_int_cst (size_type_node,
4408 : : dst_byte_offset);
4409 : : }
4410 : : }
4411 : : else
4412 : : break;
4413 : : }
4414 : :
4415 : : /* No binding for this base_region, or no binding at src_byte_offset
4416 : : (or a symbolic binding). */
4417 : :
4418 : 3267 : if (c.has_symbolic_bindings_p ())
4419 : : {
4420 : 192 : if (out_sval)
4421 : 75 : *out_sval = get_store_value (reg, nullptr);
4422 : 192 : if (logger)
4423 : 0 : logger->log ("got symbolic binding");
4424 : 192 : return m_mgr->get_or_create_unknown_svalue (size_type_node);
4425 : : }
4426 : :
4427 : : /* TODO: the various special-cases seen in
4428 : : region_model::get_store_value. */
4429 : :
4430 : : /* Simulate reading from this byte, then give up. */
4431 : 3075 : byte_range bytes_to_read (src_byte_offset, 1);
4432 : 3075 : const svalue *sval = get_store_bytes (base_reg, bytes_to_read, ctxt);
4433 : 3075 : tree byte_expr
4434 : : = (expr
4435 : 6030 : ? get_tree_for_byte_offset (expr,
4436 : : src_byte_offset - initial_src_byte_offset)
4437 : 3075 : : NULL_TREE);
4438 : 3075 : check_for_poison (sval, byte_expr, nullptr, ctxt);
4439 : 3075 : if (base_reg->can_have_initial_svalue_p ())
4440 : : {
4441 : 2840 : if (out_sval)
4442 : 300 : *out_sval = get_store_value (reg, nullptr);
4443 : 2840 : return m_mgr->get_or_create_unknown_svalue (size_type_node);
4444 : : }
4445 : : else
4446 : : return nullptr;
4447 : 7390 : }
4448 : :
4449 : : /* Like region_model::scan_for_null_terminator_1, but add logging. */
4450 : :
4451 : : const svalue *
4452 : 8006 : region_model::scan_for_null_terminator (const region *reg,
4453 : : tree expr,
4454 : : const svalue **out_sval,
4455 : : region_model_context *ctxt) const
4456 : : {
4457 : 8006 : logger *logger = ctxt ? ctxt->get_logger () : nullptr;
4458 : 8006 : LOG_SCOPE (logger);
4459 : 8006 : if (logger)
4460 : : {
4461 : 0 : pretty_printer *pp = logger->get_printer ();
4462 : 0 : logger->start_log_line ();
4463 : 0 : logger->log_partial ("region: ");
4464 : 0 : reg->dump_to_pp (pp, true);
4465 : 0 : logger->end_log_line ();
4466 : : }
4467 : 8006 : const svalue *sval = scan_for_null_terminator_1 (reg, expr, out_sval, ctxt);
4468 : 8006 : if (logger)
4469 : : {
4470 : 0 : pretty_printer *pp = logger->get_printer ();
4471 : 0 : logger->start_log_line ();
4472 : 0 : logger->log_partial ("length result: ");
4473 : 0 : if (sval)
4474 : 0 : sval->dump_to_pp (pp, true);
4475 : : else
4476 : 0 : pp_printf (pp, "NULL");
4477 : 0 : logger->end_log_line ();
4478 : 0 : if (out_sval)
4479 : : {
4480 : 0 : logger->start_log_line ();
4481 : 0 : logger->log_partial ("content result: ");
4482 : 0 : if (*out_sval)
4483 : 0 : (*out_sval)->dump_to_pp (pp, true);
4484 : : else
4485 : 0 : pp_printf (pp, "NULL");
4486 : 0 : logger->end_log_line ();
4487 : : }
4488 : : }
4489 : 16012 : return sval;
4490 : 8006 : }
4491 : :
4492 : : /* Check that argument ARG_IDX (0-based) to the call described by CD
4493 : : is a pointer to a valid null-terminated string.
4494 : :
4495 : : Simulate scanning through the buffer, reading until we find a 0 byte
4496 : : (equivalent to calling strlen).
4497 : :
4498 : : Complain and return NULL if:
4499 : : - the buffer pointed to isn't null-terminated
4500 : : - the buffer pointed to has any uninitalized bytes before any 0-terminator
4501 : : - any of the reads aren't within the bounds of the underlying base region
4502 : :
4503 : : Otherwise, return a svalue for strlen of the buffer (*not* including
4504 : : the null terminator).
4505 : :
4506 : : TODO: we should also complain if:
4507 : : - the pointer is NULL (or could be). */
4508 : :
4509 : : const svalue *
4510 : 196 : region_model::check_for_null_terminated_string_arg (const call_details &cd,
4511 : : unsigned arg_idx) const
4512 : : {
4513 : 196 : return check_for_null_terminated_string_arg (cd,
4514 : : arg_idx,
4515 : : false, /* include_terminator */
4516 : 196 : nullptr); // out_sval
4517 : : }
4518 : :
4519 : :
4520 : : /* Check that argument ARG_IDX (0-based) to the call described by CD
4521 : : is a pointer to a valid null-terminated string.
4522 : :
4523 : : Simulate scanning through the buffer, reading until we find a 0 byte
4524 : : (equivalent to calling strlen).
4525 : :
4526 : : Complain and return NULL if:
4527 : : - the buffer pointed to isn't null-terminated
4528 : : - the buffer pointed to has any uninitalized bytes before any 0-terminator
4529 : : - any of the reads aren't within the bounds of the underlying base region
4530 : :
4531 : : Otherwise, return a svalue. This will be the number of bytes read
4532 : : (including the null terminator) if INCLUDE_TERMINATOR is true, or strlen
4533 : : of the buffer (not including the null terminator) if it is false.
4534 : :
4535 : : Also, when returning an svalue, if OUT_SVAL is non-NULL, write to
4536 : : *OUT_SVAL with an svalue representing the content of the buffer up to
4537 : : and including the terminator.
4538 : :
4539 : : TODO: we should also complain if:
4540 : : - the pointer is NULL (or could be). */
4541 : :
4542 : : const svalue *
4543 : 7459 : region_model::check_for_null_terminated_string_arg (const call_details &cd,
4544 : : unsigned arg_idx,
4545 : : bool include_terminator,
4546 : : const svalue **out_sval) const
4547 : : {
4548 : 0 : class null_terminator_check_event : public custom_event
4549 : : {
4550 : : public:
4551 : 170 : null_terminator_check_event (const event_loc_info &loc_info,
4552 : : const call_arg_details &arg_details)
4553 : 170 : : custom_event (loc_info),
4554 : 170 : m_arg_details (arg_details)
4555 : : {
4556 : : }
4557 : :
4558 : 292 : void print_desc (pretty_printer &pp) const final override
4559 : : {
4560 : 292 : if (m_arg_details.m_arg_expr)
4561 : 292 : pp_printf (&pp,
4562 : : "while looking for null terminator"
4563 : : " for argument %i (%qE) of %qD...",
4564 : 292 : m_arg_details.m_arg_idx + 1,
4565 : : m_arg_details.m_arg_expr,
4566 : 292 : m_arg_details.m_called_fndecl);
4567 : : else
4568 : 0 : pp_printf (&pp,
4569 : : "while looking for null terminator"
4570 : : " for argument %i of %qD...",
4571 : 0 : m_arg_details.m_arg_idx + 1,
4572 : 0 : m_arg_details.m_called_fndecl);
4573 : 292 : }
4574 : :
4575 : : private:
4576 : : const call_arg_details m_arg_details;
4577 : : };
4578 : :
4579 : 0 : class null_terminator_check_decl_note
4580 : : : public pending_note_subclass<null_terminator_check_decl_note>
4581 : : {
4582 : : public:
4583 : 170 : null_terminator_check_decl_note (const call_arg_details &arg_details)
4584 : 170 : : m_arg_details (arg_details)
4585 : : {
4586 : : }
4587 : :
4588 : 1398 : const char *get_kind () const final override
4589 : : {
4590 : 1398 : return "null_terminator_check_decl_note";
4591 : : }
4592 : :
4593 : 146 : void emit () const final override
4594 : : {
4595 : 146 : inform_about_expected_null_terminated_string_arg (m_arg_details);
4596 : 146 : }
4597 : :
4598 : 699 : bool operator== (const null_terminator_check_decl_note &other) const
4599 : : {
4600 : 699 : return m_arg_details == other.m_arg_details;
4601 : : }
4602 : :
4603 : : private:
4604 : : const call_arg_details m_arg_details;
4605 : : };
4606 : :
4607 : : /* Subclass of decorated_region_model_context that
4608 : : adds the above event and note to any saved diagnostics. */
4609 : 7459 : class annotating_ctxt : public annotating_context
4610 : : {
4611 : : public:
4612 : 7459 : annotating_ctxt (const call_details &cd,
4613 : : unsigned arg_idx)
4614 : 7459 : : annotating_context (cd.get_ctxt ()),
4615 : 7459 : m_cd (cd),
4616 : 7459 : m_arg_idx (arg_idx)
4617 : : {
4618 : : }
4619 : 170 : void add_annotations () final override
4620 : : {
4621 : 170 : call_arg_details arg_details (m_cd, m_arg_idx);
4622 : 340 : event_loc_info loc_info (m_cd.get_location (),
4623 : 170 : m_cd.get_model ()->get_current_function ()->decl,
4624 : 340 : m_cd.get_model ()->get_stack_depth ());
4625 : :
4626 : 170 : add_event (make_unique<null_terminator_check_event> (loc_info,
4627 : : arg_details));
4628 : 170 : add_note (make_unique <null_terminator_check_decl_note> (arg_details));
4629 : 170 : }
4630 : : private:
4631 : : const call_details &m_cd;
4632 : : unsigned m_arg_idx;
4633 : : };
4634 : :
4635 : : /* Use this ctxt below so that any diagnostics that get added
4636 : : get annotated. */
4637 : 7459 : annotating_ctxt my_ctxt (cd, arg_idx);
4638 : :
4639 : 7459 : const svalue *arg_sval = cd.get_arg_svalue (arg_idx);
4640 : 7459 : const region *buf_reg
4641 : 7459 : = deref_rvalue (arg_sval, cd.get_arg_tree (arg_idx), &my_ctxt);
4642 : :
4643 : 14918 : if (const svalue *num_bytes_read_sval
4644 : 7459 : = scan_for_null_terminator (buf_reg,
4645 : : cd.get_arg_tree (arg_idx),
4646 : : out_sval,
4647 : : &my_ctxt))
4648 : : {
4649 : 7281 : if (include_terminator)
4650 : : return num_bytes_read_sval;
4651 : : else
4652 : : {
4653 : : /* strlen is (bytes_read - 1). */
4654 : 6383 : const svalue *one = m_mgr->get_or_create_int_cst (size_type_node, 1);
4655 : 6383 : return m_mgr->get_or_create_binop (size_type_node,
4656 : : MINUS_EXPR,
4657 : : num_bytes_read_sval,
4658 : 6383 : one);
4659 : : }
4660 : : }
4661 : : else
4662 : : return nullptr;
4663 : : }
4664 : :
4665 : : /* Remove all bindings overlapping REG within the store. */
4666 : :
4667 : : void
4668 : 6152 : region_model::clobber_region (const region *reg)
4669 : : {
4670 : 6152 : m_store.clobber_region (m_mgr->get_store_manager(), reg);
4671 : 6152 : }
4672 : :
4673 : : /* Remove any bindings for REG within the store. */
4674 : :
4675 : : void
4676 : 178731 : region_model::purge_region (const region *reg)
4677 : : {
4678 : 178731 : m_store.purge_region (m_mgr->get_store_manager(), reg);
4679 : 178731 : }
4680 : :
4681 : : /* Fill REG with SVAL.
4682 : : Use CTXT to report any warnings associated with the write
4683 : : (e.g. out-of-bounds). */
4684 : :
4685 : : void
4686 : 663 : region_model::fill_region (const region *reg,
4687 : : const svalue *sval,
4688 : : region_model_context *ctxt)
4689 : : {
4690 : 663 : check_region_for_write (reg, nullptr, ctxt);
4691 : 663 : m_store.fill_region (m_mgr->get_store_manager(), reg, sval);
4692 : 663 : }
4693 : :
4694 : : /* Zero-fill REG.
4695 : : Use CTXT to report any warnings associated with the write
4696 : : (e.g. out-of-bounds). */
4697 : :
4698 : : void
4699 : 777 : region_model::zero_fill_region (const region *reg,
4700 : : region_model_context *ctxt)
4701 : : {
4702 : 777 : check_region_for_write (reg, nullptr, ctxt);
4703 : 777 : m_store.zero_fill_region (m_mgr->get_store_manager(), reg);
4704 : 777 : }
4705 : :
4706 : : /* Copy NUM_BYTES_SVAL of SVAL to DEST_REG.
4707 : : Use CTXT to report any warnings associated with the copy
4708 : : (e.g. out-of-bounds writes). */
4709 : :
4710 : : void
4711 : 1799 : region_model::write_bytes (const region *dest_reg,
4712 : : const svalue *num_bytes_sval,
4713 : : const svalue *sval,
4714 : : region_model_context *ctxt)
4715 : : {
4716 : 1799 : const region *sized_dest_reg
4717 : 1799 : = m_mgr->get_sized_region (dest_reg, NULL_TREE, num_bytes_sval);
4718 : 1799 : set_value (sized_dest_reg, sval, ctxt);
4719 : 1799 : }
4720 : :
4721 : : /* Read NUM_BYTES_SVAL from SRC_REG.
4722 : : Use CTXT to report any warnings associated with the copy
4723 : : (e.g. out-of-bounds reads, copying of uninitialized values, etc). */
4724 : :
4725 : : const svalue *
4726 : 1013 : region_model::read_bytes (const region *src_reg,
4727 : : tree src_ptr_expr,
4728 : : const svalue *num_bytes_sval,
4729 : : region_model_context *ctxt) const
4730 : : {
4731 : 1013 : if (num_bytes_sval->get_kind () == SK_UNKNOWN)
4732 : 179 : return m_mgr->get_or_create_unknown_svalue (NULL_TREE);
4733 : 834 : const region *sized_src_reg
4734 : 834 : = m_mgr->get_sized_region (src_reg, NULL_TREE, num_bytes_sval);
4735 : 834 : const svalue *src_contents_sval = get_store_value (sized_src_reg, ctxt);
4736 : 834 : check_for_poison (src_contents_sval, src_ptr_expr,
4737 : : sized_src_reg, ctxt);
4738 : 834 : return src_contents_sval;
4739 : : }
4740 : :
4741 : : /* Copy NUM_BYTES_SVAL bytes from SRC_REG to DEST_REG.
4742 : : Use CTXT to report any warnings associated with the copy
4743 : : (e.g. out-of-bounds reads/writes, copying of uninitialized values,
4744 : : etc). */
4745 : :
4746 : : void
4747 : 459 : region_model::copy_bytes (const region *dest_reg,
4748 : : const region *src_reg,
4749 : : tree src_ptr_expr,
4750 : : const svalue *num_bytes_sval,
4751 : : region_model_context *ctxt)
4752 : : {
4753 : 459 : const svalue *data_sval
4754 : 459 : = read_bytes (src_reg, src_ptr_expr, num_bytes_sval, ctxt);
4755 : 459 : write_bytes (dest_reg, num_bytes_sval, data_sval, ctxt);
4756 : 459 : }
4757 : :
4758 : : /* Mark REG as having unknown content. */
4759 : :
4760 : : void
4761 : 289 : region_model::mark_region_as_unknown (const region *reg,
4762 : : uncertainty_t *uncertainty)
4763 : : {
4764 : 289 : svalue_set maybe_live_values;
4765 : 289 : m_store.mark_region_as_unknown (m_mgr->get_store_manager(), reg,
4766 : : uncertainty, &maybe_live_values);
4767 : 289 : m_store.on_maybe_live_values (maybe_live_values);
4768 : 289 : }
4769 : :
4770 : : /* Determine what is known about the condition "LHS_SVAL OP RHS_SVAL" within
4771 : : this model. */
4772 : :
4773 : : tristate
4774 : 193070 : region_model::eval_condition (const svalue *lhs,
4775 : : enum tree_code op,
4776 : : const svalue *rhs) const
4777 : : {
4778 : 193070 : gcc_assert (lhs);
4779 : 193070 : gcc_assert (rhs);
4780 : :
4781 : : /* For now, make no attempt to capture constraints on floating-point
4782 : : values. */
4783 : 193070 : if ((lhs->get_type () && FLOAT_TYPE_P (lhs->get_type ()))
4784 : 330035 : || (rhs->get_type () && FLOAT_TYPE_P (rhs->get_type ())))
4785 : 72 : return tristate::unknown ();
4786 : :
4787 : : /* See what we know based on the values. */
4788 : :
4789 : : /* Unwrap any unmergeable values. */
4790 : 192998 : lhs = lhs->unwrap_any_unmergeable ();
4791 : 192998 : rhs = rhs->unwrap_any_unmergeable ();
4792 : :
4793 : 192998 : if (lhs == rhs)
4794 : : {
4795 : : /* If we have the same svalue, then we have equality
4796 : : (apart from NaN-handling).
4797 : : TODO: should this definitely be the case for poisoned values? */
4798 : : /* Poisoned and unknown values are "unknowable". */
4799 : 14651 : if (lhs->get_kind () == SK_POISONED
4800 : 14651 : || lhs->get_kind () == SK_UNKNOWN)
4801 : 3578 : return tristate::TS_UNKNOWN;
4802 : :
4803 : 11073 : switch (op)
4804 : : {
4805 : 8134 : case EQ_EXPR:
4806 : 8134 : case GE_EXPR:
4807 : 8134 : case LE_EXPR:
4808 : 8134 : return tristate::TS_TRUE;
4809 : :
4810 : 2939 : case NE_EXPR:
4811 : 2939 : case GT_EXPR:
4812 : 2939 : case LT_EXPR:
4813 : 2939 : return tristate::TS_FALSE;
4814 : :
4815 : : default:
4816 : : /* For other ops, use the logic below. */
4817 : : break;
4818 : : }
4819 : : }
4820 : :
4821 : : /* If we have a pair of region_svalues, compare them. */
4822 : 178347 : if (const region_svalue *lhs_ptr = lhs->dyn_cast_region_svalue ())
4823 : 13009 : if (const region_svalue *rhs_ptr = rhs->dyn_cast_region_svalue ())
4824 : : {
4825 : 349 : tristate res = region_svalue::eval_condition (lhs_ptr, op, rhs_ptr);
4826 : 349 : if (res.is_known ())
4827 : 341 : return res;
4828 : : /* Otherwise, only known through constraints. */
4829 : : }
4830 : :
4831 : 178006 : if (const constant_svalue *cst_lhs = lhs->dyn_cast_constant_svalue ())
4832 : : {
4833 : : /* If we have a pair of constants, compare them. */
4834 : 47632 : if (const constant_svalue *cst_rhs = rhs->dyn_cast_constant_svalue ())
4835 : 10547 : return constant_svalue::eval_condition (cst_lhs, op, cst_rhs);
4836 : : else
4837 : : {
4838 : : /* When we have one constant, put it on the RHS. */
4839 : 37085 : std::swap (lhs, rhs);
4840 : 37085 : op = swap_tree_comparison (op);
4841 : : }
4842 : : }
4843 : 167459 : gcc_assert (lhs->get_kind () != SK_CONSTANT);
4844 : :
4845 : : /* Handle comparison against zero. */
4846 : 167459 : if (const constant_svalue *cst_rhs = rhs->dyn_cast_constant_svalue ())
4847 : 138560 : if (zerop (cst_rhs->get_constant ()))
4848 : : {
4849 : 82789 : if (const region_svalue *ptr = lhs->dyn_cast_region_svalue ())
4850 : : {
4851 : : /* A region_svalue is a non-NULL pointer, except in certain
4852 : : special cases (see the comment for region::non_null_p). */
4853 : 12438 : const region *pointee = ptr->get_pointee ();
4854 : 12438 : if (pointee->non_null_p ())
4855 : : {
4856 : 3471 : switch (op)
4857 : : {
4858 : 0 : default:
4859 : 0 : gcc_unreachable ();
4860 : :
4861 : 200 : case EQ_EXPR:
4862 : 200 : case GE_EXPR:
4863 : 200 : case LE_EXPR:
4864 : 200 : return tristate::TS_FALSE;
4865 : :
4866 : 3271 : case NE_EXPR:
4867 : 3271 : case GT_EXPR:
4868 : 3271 : case LT_EXPR:
4869 : 3271 : return tristate::TS_TRUE;
4870 : : }
4871 : : }
4872 : : }
4873 : 70351 : else if (const binop_svalue *binop = lhs->dyn_cast_binop_svalue ())
4874 : : {
4875 : : /* Treat offsets from a non-NULL pointer as being non-NULL. This
4876 : : isn't strictly true, in that eventually ptr++ will wrap
4877 : : around and be NULL, but it won't occur in practise and thus
4878 : : can be used to suppress effectively false positives that we
4879 : : shouldn't warn for. */
4880 : 12675 : if (binop->get_op () == POINTER_PLUS_EXPR)
4881 : : {
4882 : 6473 : tristate lhs_ts = eval_condition (binop->get_arg0 (), op, rhs);
4883 : 6473 : if (lhs_ts.is_known ())
4884 : 5180 : return lhs_ts;
4885 : : }
4886 : : }
4887 : 115352 : else if (const unaryop_svalue *unaryop
4888 : 57676 : = lhs->dyn_cast_unaryop_svalue ())
4889 : : {
4890 : 1974 : if (unaryop->get_op () == NEGATE_EXPR)
4891 : : {
4892 : : /* e.g. "-X <= 0" is equivalent to X >= 0". */
4893 : 17 : tristate lhs_ts = eval_condition (unaryop->get_arg (),
4894 : : swap_tree_comparison (op),
4895 : : rhs);
4896 : 17 : if (lhs_ts.is_known ())
4897 : 16 : return lhs_ts;
4898 : : }
4899 : : }
4900 : : }
4901 : :
4902 : : /* Handle rejection of equality for comparisons of the initial values of
4903 : : "external" values (such as params) with the address of locals. */
4904 : 158792 : if (const initial_svalue *init_lhs = lhs->dyn_cast_initial_svalue ())
4905 : 41768 : if (const region_svalue *rhs_ptr = rhs->dyn_cast_region_svalue ())
4906 : : {
4907 : 65 : tristate res = compare_initial_and_pointer (init_lhs, rhs_ptr);
4908 : 65 : if (res.is_known ())
4909 : 0 : return res;
4910 : : }
4911 : 158792 : if (const initial_svalue *init_rhs = rhs->dyn_cast_initial_svalue ())
4912 : 5238 : if (const region_svalue *lhs_ptr = lhs->dyn_cast_region_svalue ())
4913 : : {
4914 : 215 : tristate res = compare_initial_and_pointer (init_rhs, lhs_ptr);
4915 : 215 : if (res.is_known ())
4916 : 32 : return res;
4917 : : }
4918 : :
4919 : 158760 : if (const widening_svalue *widen_lhs = lhs->dyn_cast_widening_svalue ())
4920 : 5244 : if (tree rhs_cst = rhs->maybe_get_constant ())
4921 : : {
4922 : 2966 : tristate res = widen_lhs->eval_condition_without_cm (op, rhs_cst);
4923 : 2966 : if (res.is_known ())
4924 : 105 : return res;
4925 : : }
4926 : :
4927 : : /* Handle comparisons between two svalues with more than one operand. */
4928 : 158655 : if (const binop_svalue *binop = lhs->dyn_cast_binop_svalue ())
4929 : : {
4930 : 26260 : switch (op)
4931 : : {
4932 : : default:
4933 : : break;
4934 : 2711 : case EQ_EXPR:
4935 : 2711 : {
4936 : : /* TODO: binops can be equal even if they are not structurally
4937 : : equal in case of commutative operators. */
4938 : 2711 : tristate res = structural_equality (lhs, rhs);
4939 : 2711 : if (res.is_true ())
4940 : 44 : return res;
4941 : : }
4942 : 2667 : break;
4943 : 892 : case LE_EXPR:
4944 : 892 : {
4945 : 892 : tristate res = structural_equality (lhs, rhs);
4946 : 892 : if (res.is_true ())
4947 : 0 : return res;
4948 : : }
4949 : 892 : break;
4950 : 7810 : case GE_EXPR:
4951 : 7810 : {
4952 : 7810 : tristate res = structural_equality (lhs, rhs);
4953 : 7810 : if (res.is_true ())
4954 : 30 : return res;
4955 : 7780 : res = symbolic_greater_than (binop, rhs);
4956 : 7780 : if (res.is_true ())
4957 : 36 : return res;
4958 : : }
4959 : : break;
4960 : 9191 : case GT_EXPR:
4961 : 9191 : {
4962 : 9191 : tristate res = symbolic_greater_than (binop, rhs);
4963 : 9191 : if (res.is_true ())
4964 : 150 : return res;
4965 : : }
4966 : 9041 : break;
4967 : : }
4968 : : }
4969 : :
4970 : : /* Attempt to unwrap cast if there is one, and the types match. */
4971 : 158395 : tree lhs_type = lhs->get_type ();
4972 : 158395 : tree rhs_type = rhs->get_type ();
4973 : 158395 : if (lhs_type && rhs_type)
4974 : : {
4975 : 100333 : const unaryop_svalue *lhs_un_op = dyn_cast <const unaryop_svalue *> (lhs);
4976 : 100333 : const unaryop_svalue *rhs_un_op = dyn_cast <const unaryop_svalue *> (rhs);
4977 : 2575 : if (lhs_un_op && CONVERT_EXPR_CODE_P (lhs_un_op->get_op ())
4978 : 2492 : && rhs_un_op && CONVERT_EXPR_CODE_P (rhs_un_op->get_op ())
4979 : 100397 : && lhs_type == rhs_type)
4980 : : {
4981 : 64 : tristate res = eval_condition (lhs_un_op->get_arg (),
4982 : : op,
4983 : : rhs_un_op->get_arg ());
4984 : 64 : if (res.is_known ())
4985 : 0 : return res;
4986 : : }
4987 : 2511 : else if (lhs_un_op && CONVERT_EXPR_CODE_P (lhs_un_op->get_op ())
4988 : 102697 : && lhs_type == rhs_type)
4989 : : {
4990 : 2028 : tristate res = eval_condition (lhs_un_op->get_arg (), op, rhs);
4991 : 2028 : if (res.is_known ())
4992 : 19 : return res;
4993 : : }
4994 : 721 : else if (rhs_un_op && CONVERT_EXPR_CODE_P (rhs_un_op->get_op ())
4995 : 98962 : && lhs_type == rhs_type)
4996 : : {
4997 : 520 : tristate res = eval_condition (lhs, op, rhs_un_op->get_arg ());
4998 : 520 : if (res.is_known ())
4999 : 0 : return res;
5000 : : }
5001 : : }
5002 : :
5003 : : /* Otherwise, try constraints.
5004 : : Cast to const to ensure we don't change the constraint_manager as we
5005 : : do this (e.g. by creating equivalence classes). */
5006 : 158376 : const constraint_manager *constraints = m_constraints;
5007 : 158376 : return constraints->eval_condition (lhs, op, rhs);
5008 : : }
5009 : :
5010 : : /* Subroutine of region_model::eval_condition, for rejecting
5011 : : equality of INIT_VAL(PARM) with &LOCAL. */
5012 : :
5013 : : tristate
5014 : 280 : region_model::compare_initial_and_pointer (const initial_svalue *init,
5015 : : const region_svalue *ptr) const
5016 : : {
5017 : 280 : const region *pointee = ptr->get_pointee ();
5018 : :
5019 : : /* If we have a pointer to something within a stack frame, it can't be the
5020 : : initial value of a param. */
5021 : 280 : if (pointee->maybe_get_frame_region ())
5022 : 32 : if (init->initial_value_of_param_p ())
5023 : 32 : return tristate::TS_FALSE;
5024 : :
5025 : 248 : return tristate::TS_UNKNOWN;
5026 : : }
5027 : :
5028 : : /* Return true if SVAL is definitely positive. */
5029 : :
5030 : : static bool
5031 : 16180 : is_positive_svalue (const svalue *sval)
5032 : : {
5033 : 16180 : if (tree cst = sval->maybe_get_constant ())
5034 : 15764 : return !zerop (cst) && get_range_pos_neg (cst) == 1;
5035 : 416 : tree type = sval->get_type ();
5036 : 416 : if (!type)
5037 : : return false;
5038 : : /* Consider a binary operation size_t + int. The analyzer wraps the int in
5039 : : an unaryop_svalue, converting it to a size_t, but in the dynamic execution
5040 : : the result is smaller than the first operand. Thus, we have to look if
5041 : : the argument of the unaryop_svalue is also positive. */
5042 : 329 : if (const unaryop_svalue *un_op = dyn_cast <const unaryop_svalue *> (sval))
5043 : 19 : return CONVERT_EXPR_CODE_P (un_op->get_op ()) && TYPE_UNSIGNED (type)
5044 : 27 : && is_positive_svalue (un_op->get_arg ());
5045 : 310 : return TYPE_UNSIGNED (type);
5046 : : }
5047 : :
5048 : : /* Return true if A is definitely larger than B.
5049 : :
5050 : : Limitation: does not account for integer overflows and does not try to
5051 : : return false, so it can not be used negated. */
5052 : :
5053 : : tristate
5054 : 16971 : region_model::symbolic_greater_than (const binop_svalue *bin_a,
5055 : : const svalue *b) const
5056 : : {
5057 : 16971 : if (bin_a->get_op () == PLUS_EXPR || bin_a->get_op () == MULT_EXPR)
5058 : : {
5059 : : /* Eliminate the right-hand side of both svalues. */
5060 : 16212 : if (const binop_svalue *bin_b = dyn_cast <const binop_svalue *> (b))
5061 : 3126 : if (bin_a->get_op () == bin_b->get_op ()
5062 : 1699 : && eval_condition (bin_a->get_arg1 (),
5063 : : GT_EXPR,
5064 : 1699 : bin_b->get_arg1 ()).is_true ()
5065 : 4825 : && eval_condition (bin_a->get_arg0 (),
5066 : : GE_EXPR,
5067 : 46 : bin_b->get_arg0 ()).is_true ())
5068 : 40 : return tristate (tristate::TS_TRUE);
5069 : :
5070 : : /* Otherwise, try to remove a positive offset or factor from BIN_A. */
5071 : 16172 : if (is_positive_svalue (bin_a->get_arg1 ())
5072 : 16172 : && eval_condition (bin_a->get_arg0 (),
5073 : 15363 : GE_EXPR, b).is_true ())
5074 : 146 : return tristate (tristate::TS_TRUE);
5075 : : }
5076 : 16785 : return tristate::unknown ();
5077 : : }
5078 : :
5079 : : /* Return true if A and B are equal structurally.
5080 : :
5081 : : Structural equality means that A and B are equal if the svalues A and B have
5082 : : the same nodes at the same positions in the tree and the leafs are equal.
5083 : : Equality for conjured_svalues and initial_svalues is determined by comparing
5084 : : the pointers while constants are compared by value. That behavior is useful
5085 : : to check for binaryop_svlaues that evaluate to the same concrete value but
5086 : : might use one operand with a different type but the same constant value.
5087 : :
5088 : : For example,
5089 : : binop_svalue (mult_expr,
5090 : : initial_svalue (‘size_t’, decl_region (..., 'some_var')),
5091 : : constant_svalue (‘size_t’, 4))
5092 : : and
5093 : : binop_svalue (mult_expr,
5094 : : initial_svalue (‘size_t’, decl_region (..., 'some_var'),
5095 : : constant_svalue (‘sizetype’, 4))
5096 : : are structurally equal. A concrete C code example, where this occurs, can
5097 : : be found in test7 of out-of-bounds-5.c. */
5098 : :
5099 : : tristate
5100 : 14531 : region_model::structural_equality (const svalue *a, const svalue *b) const
5101 : : {
5102 : : /* If A and B are referentially equal, they are also structurally equal. */
5103 : 14531 : if (a == b)
5104 : 393 : return tristate (tristate::TS_TRUE);
5105 : :
5106 : 14138 : switch (a->get_kind ())
5107 : : {
5108 : 1442 : default:
5109 : 1442 : return tristate::unknown ();
5110 : : /* SK_CONJURED and SK_INITIAL are already handled
5111 : : by the referential equality above. */
5112 : 1195 : case SK_CONSTANT:
5113 : 1195 : {
5114 : 1195 : tree a_cst = a->maybe_get_constant ();
5115 : 1195 : tree b_cst = b->maybe_get_constant ();
5116 : 1195 : if (a_cst && b_cst)
5117 : 2284 : return tristate (tree_int_cst_equal (a_cst, b_cst));
5118 : : }
5119 : 40 : return tristate (tristate::TS_FALSE);
5120 : 8 : case SK_UNARYOP:
5121 : 8 : {
5122 : 8 : const unaryop_svalue *un_a = as_a <const unaryop_svalue *> (a);
5123 : 8 : if (const unaryop_svalue *un_b = dyn_cast <const unaryop_svalue *> (b))
5124 : 8 : return tristate (pending_diagnostic::same_tree_p (un_a->get_type (),
5125 : : un_b->get_type ())
5126 : 8 : && un_a->get_op () == un_b->get_op ()
5127 : : && structural_equality (un_a->get_arg (),
5128 : 16 : un_b->get_arg ()));
5129 : : }
5130 : 0 : return tristate (tristate::TS_FALSE);
5131 : 11493 : case SK_BINOP:
5132 : 11493 : {
5133 : 11493 : const binop_svalue *bin_a = as_a <const binop_svalue *> (a);
5134 : 11493 : if (const binop_svalue *bin_b = dyn_cast <const binop_svalue *> (b))
5135 : 1555 : return tristate (bin_a->get_op () == bin_b->get_op ()
5136 : : && structural_equality (bin_a->get_arg0 (),
5137 : 4260 : bin_b->get_arg0 ())
5138 : : && structural_equality (bin_a->get_arg1 (),
5139 : 3110 : bin_b->get_arg1 ()));
5140 : : }
5141 : 9938 : return tristate (tristate::TS_FALSE);
5142 : : }
5143 : : }
5144 : :
5145 : : /* Handle various constraints of the form:
5146 : : LHS: ((bool)INNER_LHS INNER_OP INNER_RHS))
5147 : : OP : == or !=
5148 : : RHS: zero
5149 : : and (with a cast):
5150 : : LHS: CAST([long]int, ((bool)INNER_LHS INNER_OP INNER_RHS))
5151 : : OP : == or !=
5152 : : RHS: zero
5153 : : by adding constraints for INNER_LHS INNEROP INNER_RHS.
5154 : :
5155 : : Return true if this function can fully handle the constraint; if
5156 : : so, add the implied constraint(s) and write true to *OUT if they
5157 : : are consistent with existing constraints, or write false to *OUT
5158 : : if they contradicts existing constraints.
5159 : :
5160 : : Return false for cases that this function doeesn't know how to handle.
5161 : :
5162 : : For example, if we're checking a stored conditional, we'll have
5163 : : something like:
5164 : : LHS: CAST(long int, (&HEAP_ALLOCATED_REGION(8)!=(int *)0B))
5165 : : OP : NE_EXPR
5166 : : RHS: zero
5167 : : which this function can turn into an add_constraint of:
5168 : : (&HEAP_ALLOCATED_REGION(8) != (int *)0B)
5169 : :
5170 : : Similarly, optimized && and || conditionals lead to e.g.
5171 : : if (p && q)
5172 : : becoming gimple like this:
5173 : : _1 = p_6 == 0B;
5174 : : _2 = q_8 == 0B
5175 : : _3 = _1 | _2
5176 : : On the "_3 is false" branch we can have constraints of the form:
5177 : : ((&HEAP_ALLOCATED_REGION(8)!=(int *)0B)
5178 : : | (&HEAP_ALLOCATED_REGION(10)!=(int *)0B))
5179 : : == 0
5180 : : which implies that both _1 and _2 are false,
5181 : : which this function can turn into a pair of add_constraints of
5182 : : (&HEAP_ALLOCATED_REGION(8)!=(int *)0B)
5183 : : and:
5184 : : (&HEAP_ALLOCATED_REGION(10)!=(int *)0B). */
5185 : :
5186 : : bool
5187 : 50723 : region_model::add_constraints_from_binop (const svalue *outer_lhs,
5188 : : enum tree_code outer_op,
5189 : : const svalue *outer_rhs,
5190 : : bool *out,
5191 : : region_model_context *ctxt)
5192 : : {
5193 : 52069 : while (const svalue *cast = outer_lhs->maybe_undo_cast ())
5194 : : outer_lhs = cast;
5195 : 50723 : const binop_svalue *binop_sval = outer_lhs->dyn_cast_binop_svalue ();
5196 : 50723 : if (!binop_sval)
5197 : : return false;
5198 : 6510 : if (!outer_rhs->all_zeroes_p ())
5199 : : return false;
5200 : :
5201 : 4697 : const svalue *inner_lhs = binop_sval->get_arg0 ();
5202 : 4697 : enum tree_code inner_op = binop_sval->get_op ();
5203 : 4697 : const svalue *inner_rhs = binop_sval->get_arg1 ();
5204 : :
5205 : 4697 : if (outer_op != NE_EXPR && outer_op != EQ_EXPR)
5206 : : return false;
5207 : :
5208 : : /* We have either
5209 : : - "OUTER_LHS != false" (i.e. OUTER is true), or
5210 : : - "OUTER_LHS == false" (i.e. OUTER is false). */
5211 : 4161 : bool is_true = outer_op == NE_EXPR;
5212 : :
5213 : 4161 : switch (inner_op)
5214 : : {
5215 : : default:
5216 : : return false;
5217 : :
5218 : 2563 : case EQ_EXPR:
5219 : 2563 : case NE_EXPR:
5220 : 2563 : case GE_EXPR:
5221 : 2563 : case GT_EXPR:
5222 : 2563 : case LE_EXPR:
5223 : 2563 : case LT_EXPR:
5224 : 2563 : {
5225 : : /* ...and "(inner_lhs OP inner_rhs) == 0"
5226 : : then (inner_lhs OP inner_rhs) must have the same
5227 : : logical value as LHS. */
5228 : 2563 : if (!is_true)
5229 : 1324 : inner_op = invert_tree_comparison (inner_op, false /* honor_nans */);
5230 : 2563 : *out = add_constraint (inner_lhs, inner_op, inner_rhs, ctxt);
5231 : 2563 : return true;
5232 : : }
5233 : 1049 : break;
5234 : :
5235 : 1049 : case BIT_AND_EXPR:
5236 : 1049 : if (is_true)
5237 : : {
5238 : : /* ...and "(inner_lhs & inner_rhs) != 0"
5239 : : then both inner_lhs and inner_rhs must be true. */
5240 : 515 : const svalue *false_sval
5241 : 515 : = m_mgr->get_or_create_constant_svalue (boolean_false_node);
5242 : 515 : bool sat1 = add_constraint (inner_lhs, NE_EXPR, false_sval, ctxt);
5243 : 515 : bool sat2 = add_constraint (inner_rhs, NE_EXPR, false_sval, ctxt);
5244 : 515 : *out = sat1 && sat2;
5245 : 515 : return true;
5246 : : }
5247 : : return false;
5248 : :
5249 : 117 : case BIT_IOR_EXPR:
5250 : 117 : if (!is_true)
5251 : : {
5252 : : /* ...and "(inner_lhs | inner_rhs) == 0"
5253 : : i.e. "(inner_lhs | inner_rhs)" is false
5254 : : then both inner_lhs and inner_rhs must be false. */
5255 : 64 : const svalue *false_sval
5256 : 64 : = m_mgr->get_or_create_constant_svalue (boolean_false_node);
5257 : 64 : bool sat1 = add_constraint (inner_lhs, EQ_EXPR, false_sval, ctxt);
5258 : 64 : bool sat2 = add_constraint (inner_rhs, EQ_EXPR, false_sval, ctxt);
5259 : 64 : *out = sat1 && sat2;
5260 : 64 : return true;
5261 : : }
5262 : : return false;
5263 : : }
5264 : : }
5265 : :
5266 : : /* Attempt to add the constraint "LHS OP RHS" to this region_model.
5267 : : If it is consistent with existing constraints, add it, and return true.
5268 : : Return false if it contradicts existing constraints.
5269 : : Use CTXT for reporting any diagnostics associated with the accesses. */
5270 : :
5271 : : bool
5272 : 64945 : region_model::add_constraint (tree lhs, enum tree_code op, tree rhs,
5273 : : region_model_context *ctxt)
5274 : : {
5275 : : /* For now, make no attempt to capture constraints on floating-point
5276 : : values. */
5277 : 64945 : if (FLOAT_TYPE_P (TREE_TYPE (lhs)) || FLOAT_TYPE_P (TREE_TYPE (rhs)))
5278 : : return true;
5279 : :
5280 : 64579 : const svalue *lhs_sval = get_rvalue (lhs, ctxt);
5281 : 64579 : const svalue *rhs_sval = get_rvalue (rhs, ctxt);
5282 : :
5283 : 64579 : return add_constraint (lhs_sval, op, rhs_sval, ctxt);
5284 : : }
5285 : :
5286 : : static bool
5287 : 9507 : unusable_in_infinite_loop_constraint_p (const svalue *sval)
5288 : : {
5289 : 9507 : if (sval->get_kind () == SK_WIDENING)
5290 : 0 : return true;
5291 : : return false;
5292 : : }
5293 : :
5294 : : /* Attempt to add the constraint "LHS OP RHS" to this region_model.
5295 : : If it is consistent with existing constraints, add it, and return true.
5296 : : Return false if it contradicts existing constraints.
5297 : : Use CTXT for reporting any diagnostics associated with the accesses. */
5298 : :
5299 : : bool
5300 : 72671 : region_model::add_constraint (const svalue *lhs,
5301 : : enum tree_code op,
5302 : : const svalue *rhs,
5303 : : region_model_context *ctxt)
5304 : : {
5305 : 72671 : const bool checking_for_infinite_loop
5306 : 72671 : = ctxt ? ctxt->checking_for_infinite_loop_p () : false;
5307 : :
5308 : 4871 : if (checking_for_infinite_loop)
5309 : : {
5310 : 9507 : if (unusable_in_infinite_loop_constraint_p (lhs)
5311 : 72671 : || unusable_in_infinite_loop_constraint_p (rhs))
5312 : : {
5313 : 236 : gcc_assert (ctxt);
5314 : 236 : ctxt->on_unusable_in_infinite_loop ();
5315 : 236 : return false;
5316 : : }
5317 : : }
5318 : :
5319 : 72435 : tristate t_cond = eval_condition (lhs, op, rhs);
5320 : :
5321 : : /* If we already have the condition, do nothing. */
5322 : 72435 : if (t_cond.is_true ())
5323 : : return true;
5324 : :
5325 : : /* Reject a constraint that would contradict existing knowledge, as
5326 : : unsatisfiable. */
5327 : 62030 : if (t_cond.is_false ())
5328 : : return false;
5329 : :
5330 : 53766 : if (checking_for_infinite_loop)
5331 : : {
5332 : : /* Here, we don't have a definite true/false value, so bail out
5333 : : when checking for infinite loops. */
5334 : 3043 : gcc_assert (ctxt);
5335 : 3043 : ctxt->on_unusable_in_infinite_loop ();
5336 : 3043 : return false;
5337 : : }
5338 : :
5339 : 50723 : bool out;
5340 : 50723 : if (add_constraints_from_binop (lhs, op, rhs, &out, ctxt))
5341 : 3142 : return out;
5342 : :
5343 : : /* Attempt to store the constraint. */
5344 : 47581 : if (!m_constraints->add_constraint (lhs, op, rhs))
5345 : : return false;
5346 : :
5347 : : /* Notify the context, if any. This exists so that the state machines
5348 : : in a program_state can be notified about the condition, and so can
5349 : : set sm-state for e.g. unchecked->checked, both for cfg-edges, and
5350 : : when synthesizing constraints as above. */
5351 : 47497 : if (ctxt)
5352 : 30184 : ctxt->on_condition (lhs, op, rhs);
5353 : :
5354 : : /* If we have ®ION == NULL, then drop dynamic extents for REGION (for
5355 : : the case where REGION is heap-allocated and thus could be NULL). */
5356 : 47497 : if (tree rhs_cst = rhs->maybe_get_constant ())
5357 : 39928 : if (op == EQ_EXPR && zerop (rhs_cst))
5358 : 12150 : if (const region_svalue *region_sval = lhs->dyn_cast_region_svalue ())
5359 : 1374 : unset_dynamic_extents (region_sval->get_pointee ());
5360 : :
5361 : : return true;
5362 : : }
5363 : :
5364 : : /* As above, but when returning false, if OUT is non-NULL, write a
5365 : : new rejected_constraint to *OUT. */
5366 : :
5367 : : bool
5368 : 63805 : region_model::add_constraint (tree lhs, enum tree_code op, tree rhs,
5369 : : region_model_context *ctxt,
5370 : : std::unique_ptr<rejected_constraint> *out)
5371 : : {
5372 : 63805 : bool sat = add_constraint (lhs, op, rhs, ctxt);
5373 : 63805 : if (!sat && out)
5374 : 1916 : *out = make_unique <rejected_op_constraint> (*this, lhs, op, rhs);
5375 : 63805 : return sat;
5376 : : }
5377 : :
5378 : : /* Determine what is known about the condition "LHS OP RHS" within
5379 : : this model.
5380 : : Use CTXT for reporting any diagnostics associated with the accesses. */
5381 : :
5382 : : tristate
5383 : 31737 : region_model::eval_condition (tree lhs,
5384 : : enum tree_code op,
5385 : : tree rhs,
5386 : : region_model_context *ctxt) const
5387 : : {
5388 : : /* For now, make no attempt to model constraints on floating-point
5389 : : values. */
5390 : 31737 : if (FLOAT_TYPE_P (TREE_TYPE (lhs)) || FLOAT_TYPE_P (TREE_TYPE (rhs)))
5391 : 16 : return tristate::unknown ();
5392 : :
5393 : 31721 : return eval_condition (get_rvalue (lhs, ctxt), op, get_rvalue (rhs, ctxt));
5394 : : }
5395 : :
5396 : : /* Implementation of region_model::get_representative_path_var.
5397 : : Attempt to return a path_var that represents SVAL, or return NULL_TREE.
5398 : : Use VISITED to prevent infinite mutual recursion with the overload for
5399 : : regions. */
5400 : :
5401 : : path_var
5402 : 14625 : region_model::get_representative_path_var_1 (const svalue *sval,
5403 : : svalue_set *visited,
5404 : : logger *logger) const
5405 : : {
5406 : 14625 : gcc_assert (sval);
5407 : :
5408 : : /* Prevent infinite recursion. */
5409 : 14625 : if (visited->contains (sval))
5410 : : {
5411 : 22 : if (sval->get_kind () == SK_CONSTANT)
5412 : 22 : return path_var (sval->maybe_get_constant (), 0);
5413 : : else
5414 : 0 : return path_var (NULL_TREE, 0);
5415 : : }
5416 : 14603 : visited->add (sval);
5417 : :
5418 : : /* Handle casts by recursion into get_representative_path_var. */
5419 : 14603 : if (const svalue *cast_sval = sval->maybe_undo_cast ())
5420 : : {
5421 : 436 : path_var result = get_representative_path_var (cast_sval, visited,
5422 : : logger);
5423 : 436 : tree orig_type = sval->get_type ();
5424 : : /* If necessary, wrap the result in a cast. */
5425 : 436 : if (result.m_tree && orig_type)
5426 : 349 : result.m_tree = build1 (NOP_EXPR, orig_type, result.m_tree);
5427 : 436 : return result;
5428 : : }
5429 : :
5430 : 14167 : auto_vec<path_var> pvs;
5431 : 14167 : m_store.get_representative_path_vars (this, visited, sval, logger, &pvs);
5432 : :
5433 : 14167 : if (tree cst = sval->maybe_get_constant ())
5434 : 2052 : pvs.safe_push (path_var (cst, 0));
5435 : :
5436 : : /* Handle string literals and various other pointers. */
5437 : 14167 : if (const region_svalue *ptr_sval = sval->dyn_cast_region_svalue ())
5438 : : {
5439 : 4760 : const region *reg = ptr_sval->get_pointee ();
5440 : 4760 : if (path_var pv = get_representative_path_var (reg, visited, logger))
5441 : 30 : return path_var (build1 (ADDR_EXPR,
5442 : : sval->get_type (),
5443 : : pv.m_tree),
5444 : 30 : pv.m_stack_depth);
5445 : : }
5446 : :
5447 : : /* If we have a sub_svalue, look for ways to represent the parent. */
5448 : 14137 : if (const sub_svalue *sub_sval = sval->dyn_cast_sub_svalue ())
5449 : : {
5450 : 647 : const svalue *parent_sval = sub_sval->get_parent ();
5451 : 647 : const region *subreg = sub_sval->get_subregion ();
5452 : 1294 : if (path_var parent_pv
5453 : 647 : = get_representative_path_var (parent_sval, visited, logger))
5454 : 214 : if (const field_region *field_reg = subreg->dyn_cast_field_region ())
5455 : 156 : return path_var (build3 (COMPONENT_REF,
5456 : : sval->get_type (),
5457 : : parent_pv.m_tree,
5458 : : field_reg->get_field (),
5459 : : NULL_TREE),
5460 : 156 : parent_pv.m_stack_depth);
5461 : : }
5462 : :
5463 : : /* Handle binops. */
5464 : 13981 : if (const binop_svalue *binop_sval = sval->dyn_cast_binop_svalue ())
5465 : 615 : if (path_var lhs_pv
5466 : 615 : = get_representative_path_var (binop_sval->get_arg0 (), visited,
5467 : 615 : logger))
5468 : 530 : if (path_var rhs_pv
5469 : 530 : = get_representative_path_var (binop_sval->get_arg1 (), visited,
5470 : 530 : logger))
5471 : 484 : return path_var (build2 (binop_sval->get_op (),
5472 : : sval->get_type (),
5473 : : lhs_pv.m_tree, rhs_pv.m_tree),
5474 : 484 : lhs_pv.m_stack_depth);
5475 : :
5476 : 13497 : if (pvs.length () < 1)
5477 : 2690 : return path_var (NULL_TREE, 0);
5478 : :
5479 : 10807 : pvs.qsort (readability_comparator);
5480 : 10807 : return pvs[0];
5481 : 14167 : }
5482 : :
5483 : : /* Attempt to return a path_var that represents SVAL, or return NULL_TREE.
5484 : : Use VISITED to prevent infinite mutual recursion with the overload for
5485 : : regions
5486 : :
5487 : : This function defers to get_representative_path_var_1 to do the work;
5488 : : it adds verification that get_representative_path_var_1 returned a tree
5489 : : of the correct type. */
5490 : :
5491 : : path_var
5492 : 20071 : region_model::get_representative_path_var (const svalue *sval,
5493 : : svalue_set *visited,
5494 : : logger *logger) const
5495 : : {
5496 : 20071 : if (sval == NULL)
5497 : 5446 : return path_var (NULL_TREE, 0);
5498 : :
5499 : 14625 : LOG_SCOPE (logger);
5500 : 14625 : if (logger)
5501 : : {
5502 : 0 : logger->start_log_line ();
5503 : 0 : logger->log_partial ("sval: ");
5504 : 0 : sval->dump_to_pp (logger->get_printer (), true);
5505 : 0 : logger->end_log_line ();
5506 : : }
5507 : :
5508 : 14625 : tree orig_type = sval->get_type ();
5509 : :
5510 : 14625 : path_var result = get_representative_path_var_1 (sval, visited, logger);
5511 : :
5512 : : /* Verify that the result has the same type as SVAL, if any. */
5513 : 14625 : if (result.m_tree && orig_type)
5514 : 11768 : gcc_assert (TREE_TYPE (result.m_tree) == orig_type);
5515 : :
5516 : 14625 : if (logger)
5517 : : {
5518 : 0 : logger->start_log_line ();
5519 : 0 : logger->log_partial ("sval: ");
5520 : 0 : sval->dump_to_pp (logger->get_printer (), true);
5521 : 0 : logger->end_log_line ();
5522 : :
5523 : 0 : if (result.m_tree)
5524 : 0 : logger->log ("tree: %qE", result.m_tree);
5525 : : else
5526 : 0 : logger->log ("tree: NULL");
5527 : : }
5528 : :
5529 : 14625 : return result;
5530 : 14625 : }
5531 : :
5532 : : /* Attempt to return a tree that represents SVAL, or return NULL_TREE.
5533 : :
5534 : : Strip off any top-level cast, to avoid messages like
5535 : : double-free of '(void *)ptr'
5536 : : from analyzer diagnostics. */
5537 : :
5538 : : tree
5539 : 15244 : region_model::get_representative_tree (const svalue *sval, logger *logger) const
5540 : : {
5541 : 15244 : svalue_set visited;
5542 : 15244 : tree expr = get_representative_path_var (sval, &visited, logger).m_tree;
5543 : :
5544 : : /* Strip off any top-level cast. */
5545 : 15244 : if (expr && TREE_CODE (expr) == NOP_EXPR)
5546 : 431 : expr = TREE_OPERAND (expr, 0);
5547 : :
5548 : 15244 : return fixup_tree_for_diagnostic (expr);
5549 : 15244 : }
5550 : :
5551 : : tree
5552 : 745 : region_model::get_representative_tree (const region *reg, logger *logger) const
5553 : : {
5554 : 745 : svalue_set visited;
5555 : 745 : tree expr = get_representative_path_var (reg, &visited, logger).m_tree;
5556 : :
5557 : : /* Strip off any top-level cast. */
5558 : 745 : if (expr && TREE_CODE (expr) == NOP_EXPR)
5559 : 0 : expr = TREE_OPERAND (expr, 0);
5560 : :
5561 : 745 : return fixup_tree_for_diagnostic (expr);
5562 : 745 : }
5563 : :
5564 : : /* Implementation of region_model::get_representative_path_var.
5565 : :
5566 : : Attempt to return a path_var that represents REG, or return
5567 : : the NULL path_var.
5568 : : For example, a region for a field of a local would be a path_var
5569 : : wrapping a COMPONENT_REF.
5570 : : Use VISITED to prevent infinite mutual recursion with the overload for
5571 : : svalues. */
5572 : :
5573 : : path_var
5574 : 17769 : region_model::get_representative_path_var_1 (const region *reg,
5575 : : svalue_set *visited,
5576 : : logger *logger) const
5577 : : {
5578 : 17769 : switch (reg->get_kind ())
5579 : : {
5580 : 0 : default:
5581 : 0 : gcc_unreachable ();
5582 : :
5583 : 0 : case RK_FRAME:
5584 : 0 : case RK_GLOBALS:
5585 : 0 : case RK_CODE:
5586 : 0 : case RK_HEAP:
5587 : 0 : case RK_STACK:
5588 : 0 : case RK_THREAD_LOCAL:
5589 : 0 : case RK_ROOT:
5590 : : /* Regions that represent memory spaces are not expressible as trees. */
5591 : 0 : return path_var (NULL_TREE, 0);
5592 : :
5593 : 1 : case RK_FUNCTION:
5594 : 1 : {
5595 : 1 : const function_region *function_reg
5596 : 1 : = as_a <const function_region *> (reg);
5597 : 1 : return path_var (function_reg->get_fndecl (), 0);
5598 : : }
5599 : 1 : case RK_LABEL:
5600 : 1 : {
5601 : 1 : const label_region *label_reg = as_a <const label_region *> (reg);
5602 : 1 : return path_var (label_reg->get_label (), 0);
5603 : : }
5604 : :
5605 : 400 : case RK_SYMBOLIC:
5606 : 400 : {
5607 : 400 : const symbolic_region *symbolic_reg
5608 : 400 : = as_a <const symbolic_region *> (reg);
5609 : 400 : const svalue *pointer = symbolic_reg->get_pointer ();
5610 : 400 : path_var pointer_pv = get_representative_path_var (pointer, visited,
5611 : : logger);
5612 : 400 : if (!pointer_pv)
5613 : 20 : return path_var (NULL_TREE, 0);
5614 : 380 : tree offset = build_int_cst (pointer->get_type (), 0);
5615 : 380 : return path_var (build2 (MEM_REF,
5616 : : reg->get_type (),
5617 : : pointer_pv.m_tree,
5618 : : offset),
5619 : 380 : pointer_pv.m_stack_depth);
5620 : : }
5621 : 11078 : case RK_DECL:
5622 : 11078 : {
5623 : 11078 : const decl_region *decl_reg = as_a <const decl_region *> (reg);
5624 : 11078 : return path_var (decl_reg->get_decl (), decl_reg->get_stack_depth ());
5625 : : }
5626 : 960 : case RK_FIELD:
5627 : 960 : {
5628 : 960 : const field_region *field_reg = as_a <const field_region *> (reg);
5629 : 960 : path_var parent_pv
5630 : 960 : = get_representative_path_var (reg->get_parent_region (), visited,
5631 : : logger);
5632 : 960 : if (!parent_pv)
5633 : 54 : return path_var (NULL_TREE, 0);
5634 : 906 : return path_var (build3 (COMPONENT_REF,
5635 : : reg->get_type (),
5636 : : parent_pv.m_tree,
5637 : : field_reg->get_field (),
5638 : : NULL_TREE),
5639 : 906 : parent_pv.m_stack_depth);
5640 : : }
5641 : :
5642 : 240 : case RK_ELEMENT:
5643 : 240 : {
5644 : 240 : const element_region *element_reg
5645 : 240 : = as_a <const element_region *> (reg);
5646 : 240 : path_var parent_pv
5647 : 240 : = get_representative_path_var (reg->get_parent_region (), visited,
5648 : : logger);
5649 : 240 : if (!parent_pv)
5650 : 0 : return path_var (NULL_TREE, 0);
5651 : 240 : path_var index_pv
5652 : 240 : = get_representative_path_var (element_reg->get_index (), visited,
5653 : : logger);
5654 : 240 : if (!index_pv)
5655 : 0 : return path_var (NULL_TREE, 0);
5656 : 240 : return path_var (build4 (ARRAY_REF,
5657 : : reg->get_type (),
5658 : : parent_pv.m_tree, index_pv.m_tree,
5659 : : NULL_TREE, NULL_TREE),
5660 : 240 : parent_pv.m_stack_depth);
5661 : : }
5662 : :
5663 : 109 : case RK_OFFSET:
5664 : 109 : {
5665 : 109 : const offset_region *offset_reg
5666 : 109 : = as_a <const offset_region *> (reg);
5667 : 109 : path_var parent_pv
5668 : 109 : = get_representative_path_var (reg->get_parent_region (), visited,
5669 : : logger);
5670 : 109 : if (!parent_pv)
5671 : 0 : return path_var (NULL_TREE, 0);
5672 : 109 : path_var offset_pv
5673 : 109 : = get_representative_path_var (offset_reg->get_byte_offset (),
5674 : : visited, logger);
5675 : 109 : if (!offset_pv || TREE_CODE (offset_pv.m_tree) != INTEGER_CST)
5676 : 66 : return path_var (NULL_TREE, 0);
5677 : 43 : tree addr_parent = build1 (ADDR_EXPR,
5678 : : build_pointer_type (reg->get_type ()),
5679 : : parent_pv.m_tree);
5680 : 43 : tree ptype = build_pointer_type_for_mode (char_type_node, ptr_mode,
5681 : : true);
5682 : 43 : return path_var (build2 (MEM_REF, reg->get_type (), addr_parent,
5683 : : fold_convert (ptype, offset_pv.m_tree)),
5684 : 43 : parent_pv.m_stack_depth);
5685 : : }
5686 : :
5687 : 56 : case RK_SIZED:
5688 : 56 : return path_var (NULL_TREE, 0);
5689 : :
5690 : 6 : case RK_CAST:
5691 : 6 : {
5692 : 6 : path_var parent_pv
5693 : 6 : = get_representative_path_var (reg->get_parent_region (), visited,
5694 : : logger);
5695 : 6 : if (!parent_pv)
5696 : 0 : return path_var (NULL_TREE, 0);
5697 : 6 : return path_var (build1 (NOP_EXPR,
5698 : : reg->get_type (),
5699 : : parent_pv.m_tree),
5700 : 6 : parent_pv.m_stack_depth);
5701 : : }
5702 : :
5703 : 4904 : case RK_HEAP_ALLOCATED:
5704 : 4904 : case RK_ALLOCA:
5705 : : /* No good way to express heap-allocated/alloca regions as trees. */
5706 : 4904 : return path_var (NULL_TREE, 0);
5707 : :
5708 : 10 : case RK_STRING:
5709 : 10 : {
5710 : 10 : const string_region *string_reg = as_a <const string_region *> (reg);
5711 : 10 : return path_var (string_reg->get_string_cst (), 0);
5712 : : }
5713 : :
5714 : 4 : case RK_VAR_ARG:
5715 : 4 : case RK_ERRNO:
5716 : 4 : case RK_UNKNOWN:
5717 : 4 : case RK_PRIVATE:
5718 : 4 : return path_var (NULL_TREE, 0);
5719 : : }
5720 : : }
5721 : :
5722 : : /* Attempt to return a path_var that represents REG, or return
5723 : : the NULL path_var.
5724 : : For example, a region for a field of a local would be a path_var
5725 : : wrapping a COMPONENT_REF.
5726 : : Use VISITED to prevent infinite mutual recursion with the overload for
5727 : : svalues.
5728 : :
5729 : : This function defers to get_representative_path_var_1 to do the work;
5730 : : it adds verification that get_representative_path_var_1 returned a tree
5731 : : of the correct type. */
5732 : :
5733 : : path_var
5734 : 17769 : region_model::get_representative_path_var (const region *reg,
5735 : : svalue_set *visited,
5736 : : logger *logger) const
5737 : : {
5738 : 17769 : LOG_SCOPE (logger);
5739 : 17769 : if (logger)
5740 : : {
5741 : 0 : logger->start_log_line ();
5742 : 0 : logger->log_partial ("reg: ");
5743 : 0 : reg->dump_to_pp (logger->get_printer (), true);
5744 : 0 : logger->end_log_line ();
5745 : : }
5746 : :
5747 : 17769 : path_var result = get_representative_path_var_1 (reg, visited, logger);
5748 : :
5749 : : /* Verify that the result has the same type as REG, if any. */
5750 : 17769 : if (result.m_tree && reg->get_type ())
5751 : 12664 : gcc_assert (TREE_TYPE (result.m_tree) == reg->get_type ());
5752 : :
5753 : 17769 : if (logger)
5754 : : {
5755 : 0 : logger->start_log_line ();
5756 : 0 : logger->log_partial ("reg: ");
5757 : 0 : reg->dump_to_pp (logger->get_printer (), true);
5758 : 0 : logger->end_log_line ();
5759 : :
5760 : 0 : if (result.m_tree)
5761 : 0 : logger->log ("tree: %qE", result.m_tree);
5762 : : else
5763 : 0 : logger->log ("tree: NULL");
5764 : : }
5765 : :
5766 : 35538 : return result;
5767 : 17769 : }
5768 : :
5769 : : /* Update this model for any phis in SNODE, assuming we came from
5770 : : LAST_CFG_SUPEREDGE. */
5771 : :
5772 : : void
5773 : 150412 : region_model::update_for_phis (const supernode *snode,
5774 : : const cfg_superedge *last_cfg_superedge,
5775 : : region_model_context *ctxt)
5776 : : {
5777 : 150412 : gcc_assert (last_cfg_superedge);
5778 : :
5779 : : /* Copy this state and pass it to handle_phi so that all of the phi stmts
5780 : : are effectively handled simultaneously. */
5781 : 150412 : const region_model old_state (*this);
5782 : :
5783 : 150412 : hash_set<const svalue *> svals_changing_meaning;
5784 : :
5785 : 150412 : for (gphi_iterator gpi = const_cast<supernode *>(snode)->start_phis ();
5786 : 227052 : !gsi_end_p (gpi); gsi_next (&gpi))
5787 : : {
5788 : 76640 : gphi *phi = gpi.phi ();
5789 : :
5790 : 76640 : tree src = last_cfg_superedge->get_phi_arg (phi);
5791 : 76640 : tree lhs = gimple_phi_result (phi);
5792 : :
5793 : : /* Update next_state based on phi and old_state. */
5794 : 76640 : handle_phi (phi, lhs, src, old_state, svals_changing_meaning, ctxt);
5795 : : }
5796 : :
5797 : 302484 : for (auto iter : svals_changing_meaning)
5798 : 1660 : m_constraints->purge_state_involving (iter);
5799 : 150412 : }
5800 : :
5801 : : /* Attempt to update this model for taking EDGE (where the last statement
5802 : : was LAST_STMT), returning true if the edge can be taken, false
5803 : : otherwise.
5804 : : When returning false, if OUT is non-NULL, write a new rejected_constraint
5805 : : to it.
5806 : :
5807 : : For CFG superedges where LAST_STMT is a conditional or a switch
5808 : : statement, attempt to add the relevant conditions for EDGE to this
5809 : : model, returning true if they are feasible, or false if they are
5810 : : impossible.
5811 : :
5812 : : For call superedges, push frame information and store arguments
5813 : : into parameters.
5814 : :
5815 : : For return superedges, pop frame information and store return
5816 : : values into any lhs.
5817 : :
5818 : : Rejection of call/return superedges happens elsewhere, in
5819 : : program_point::on_edge (i.e. based on program point, rather
5820 : : than program state). */
5821 : :
5822 : : bool
5823 : 180651 : region_model::maybe_update_for_edge (const superedge &edge,
5824 : : const gimple *last_stmt,
5825 : : region_model_context *ctxt,
5826 : : std::unique_ptr<rejected_constraint> *out)
5827 : : {
5828 : : /* Handle frame updates for interprocedural edges. */
5829 : 180651 : switch (edge.m_kind)
5830 : : {
5831 : : default:
5832 : : break;
5833 : :
5834 : 9352 : case SUPEREDGE_CALL:
5835 : 9352 : {
5836 : 9352 : const call_superedge *call_edge = as_a <const call_superedge *> (&edge);
5837 : 9352 : update_for_call_superedge (*call_edge, ctxt);
5838 : : }
5839 : 9352 : break;
5840 : :
5841 : 7094 : case SUPEREDGE_RETURN:
5842 : 7094 : {
5843 : 7094 : const return_superedge *return_edge
5844 : 7094 : = as_a <const return_superedge *> (&edge);
5845 : 7094 : update_for_return_superedge (*return_edge, ctxt);
5846 : : }
5847 : 7094 : break;
5848 : :
5849 : : case SUPEREDGE_INTRAPROCEDURAL_CALL:
5850 : : /* This is a no-op for call summaries; we should already
5851 : : have handled the effect of the call summary at the call stmt. */
5852 : : break;
5853 : : }
5854 : :
5855 : 180651 : if (last_stmt == NULL)
5856 : : return true;
5857 : :
5858 : : /* Apply any constraints for conditionals/switch/computed-goto statements. */
5859 : :
5860 : 143675 : if (const gcond *cond_stmt = dyn_cast <const gcond *> (last_stmt))
5861 : : {
5862 : 63793 : const cfg_superedge *cfg_sedge = as_a <const cfg_superedge *> (&edge);
5863 : 63793 : return apply_constraints_for_gcond (*cfg_sedge, cond_stmt, ctxt, out);
5864 : : }
5865 : :
5866 : 79882 : if (const gswitch *switch_stmt = dyn_cast <const gswitch *> (last_stmt))
5867 : : {
5868 : 8062 : const switch_cfg_superedge *switch_sedge
5869 : 8062 : = as_a <const switch_cfg_superedge *> (&edge);
5870 : 8062 : return apply_constraints_for_gswitch (*switch_sedge, switch_stmt,
5871 : 8062 : ctxt, out);
5872 : : }
5873 : :
5874 : 71820 : if (const ggoto *goto_stmt = dyn_cast <const ggoto *> (last_stmt))
5875 : : {
5876 : 79 : const cfg_superedge *cfg_sedge = as_a <const cfg_superedge *> (&edge);
5877 : 79 : return apply_constraints_for_ggoto (*cfg_sedge, goto_stmt, ctxt);
5878 : : }
5879 : :
5880 : : /* Apply any constraints due to an exception being thrown. */
5881 : 71741 : if (const cfg_superedge *cfg_sedge = dyn_cast <const cfg_superedge *> (&edge))
5882 : 60836 : if (cfg_sedge->get_flags () & EDGE_EH)
5883 : 2497 : return apply_constraints_for_exception (last_stmt, ctxt, out);
5884 : :
5885 : : return true;
5886 : : }
5887 : :
5888 : : /* Push a new frame_region on to the stack region.
5889 : : Populate the frame_region with child regions for the function call's
5890 : : parameters, using values from the arguments at the callsite in the
5891 : : caller's frame. */
5892 : :
5893 : : void
5894 : 9592 : region_model::update_for_gcall (const gcall *call_stmt,
5895 : : region_model_context *ctxt,
5896 : : function *callee)
5897 : : {
5898 : : /* Build a vec of argument svalues, using the current top
5899 : : frame for resolving tree expressions. */
5900 : 9592 : auto_vec<const svalue *> arg_svals (gimple_call_num_args (call_stmt));
5901 : :
5902 : 20180 : for (unsigned i = 0; i < gimple_call_num_args (call_stmt); i++)
5903 : : {
5904 : 10588 : tree arg = gimple_call_arg (call_stmt, i);
5905 : 10588 : arg_svals.quick_push (get_rvalue (arg, ctxt));
5906 : : }
5907 : :
5908 : 9592 : if(!callee)
5909 : : {
5910 : : /* Get the function * from the gcall. */
5911 : 77 : tree fn_decl = get_fndecl_for_call (call_stmt,ctxt);
5912 : 77 : callee = DECL_STRUCT_FUNCTION (fn_decl);
5913 : : }
5914 : :
5915 : 77 : gcc_assert (callee);
5916 : 9592 : push_frame (*callee, &arg_svals, ctxt);
5917 : 9592 : }
5918 : :
5919 : : /* Pop the top-most frame_region from the stack, and copy the return
5920 : : region's values (if any) into the region for the lvalue of the LHS of
5921 : : the call (if any). */
5922 : :
5923 : : void
5924 : 7302 : region_model::update_for_return_gcall (const gcall *call_stmt,
5925 : : region_model_context *ctxt)
5926 : : {
5927 : : /* Get the lvalue for the result of the call, passing it to pop_frame,
5928 : : so that pop_frame can determine the region with respect to the
5929 : : *caller* frame. */
5930 : 7302 : tree lhs = gimple_call_lhs (call_stmt);
5931 : 7302 : pop_frame (lhs, NULL, ctxt, call_stmt);
5932 : 7302 : }
5933 : :
5934 : : /* Extract calling information from the superedge and update the model for the
5935 : : call */
5936 : :
5937 : : void
5938 : 9352 : region_model::update_for_call_superedge (const call_superedge &call_edge,
5939 : : region_model_context *ctxt)
5940 : : {
5941 : 9352 : const gcall *call_stmt = call_edge.get_call_stmt ();
5942 : 9352 : update_for_gcall (call_stmt, ctxt, call_edge.get_callee_function ());
5943 : 9352 : }
5944 : :
5945 : : /* Extract calling information from the return superedge and update the model
5946 : : for the returning call */
5947 : :
5948 : : void
5949 : 7094 : region_model::update_for_return_superedge (const return_superedge &return_edge,
5950 : : region_model_context *ctxt)
5951 : : {
5952 : 7094 : const gcall *call_stmt = return_edge.get_call_stmt ();
5953 : 7094 : update_for_return_gcall (call_stmt, ctxt);
5954 : 7094 : }
5955 : :
5956 : : /* Attempt to use R to replay SUMMARY into this object.
5957 : : Return true if it is possible. */
5958 : :
5959 : : bool
5960 : 1598 : region_model::replay_call_summary (call_summary_replay &r,
5961 : : const region_model &summary)
5962 : : {
5963 : 1598 : gcc_assert (summary.get_stack_depth () == 1);
5964 : :
5965 : 1598 : m_store.replay_call_summary (r, summary.m_store);
5966 : :
5967 : 1598 : if (r.get_ctxt ())
5968 : 1487 : r.get_ctxt ()->maybe_did_work ();
5969 : :
5970 : 1598 : if (!m_constraints->replay_call_summary (r, *summary.m_constraints))
5971 : : return false;
5972 : :
5973 : 6007 : for (auto kv : summary.m_dynamic_extents)
5974 : : {
5975 : 2247 : const region *summary_reg = kv.first;
5976 : 2247 : const region *caller_reg = r.convert_region_from_summary (summary_reg);
5977 : 2247 : if (!caller_reg)
5978 : 2 : continue;
5979 : 2245 : const svalue *summary_sval = kv.second;
5980 : 2245 : const svalue *caller_sval = r.convert_svalue_from_summary (summary_sval);
5981 : 2245 : if (!caller_sval)
5982 : 0 : continue;
5983 : 2245 : m_dynamic_extents.put (caller_reg, caller_sval);
5984 : : }
5985 : :
5986 : 1513 : return true;
5987 : : }
5988 : :
5989 : : /* Given a true or false edge guarded by conditional statement COND_STMT,
5990 : : determine appropriate constraints for the edge to be taken.
5991 : :
5992 : : If they are feasible, add the constraints and return true.
5993 : :
5994 : : Return false if the constraints contradict existing knowledge
5995 : : (and so the edge should not be taken).
5996 : : When returning false, if OUT is non-NULL, write a new rejected_constraint
5997 : : to it. */
5998 : :
5999 : : bool
6000 : 63793 : region_model::
6001 : : apply_constraints_for_gcond (const cfg_superedge &sedge,
6002 : : const gcond *cond_stmt,
6003 : : region_model_context *ctxt,
6004 : : std::unique_ptr<rejected_constraint> *out)
6005 : : {
6006 : 63793 : ::edge cfg_edge = sedge.get_cfg_edge ();
6007 : 63793 : gcc_assert (cfg_edge != NULL);
6008 : 63793 : gcc_assert (cfg_edge->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE));
6009 : :
6010 : 63793 : enum tree_code op = gimple_cond_code (cond_stmt);
6011 : 63793 : tree lhs = gimple_cond_lhs (cond_stmt);
6012 : 63793 : tree rhs = gimple_cond_rhs (cond_stmt);
6013 : 63793 : if (cfg_edge->flags & EDGE_FALSE_VALUE)
6014 : 30228 : op = invert_tree_comparison (op, false /* honor_nans */);
6015 : 63793 : return add_constraint (lhs, op, rhs, ctxt, out);
6016 : : }
6017 : :
6018 : : /* Return true iff SWITCH_STMT has a non-default label that contains
6019 : : INT_CST. */
6020 : :
6021 : : static bool
6022 : 144 : has_nondefault_case_for_value_p (const gswitch *switch_stmt, tree int_cst)
6023 : : {
6024 : : /* We expect the initial label to be the default; skip it. */
6025 : 144 : gcc_assert (CASE_LOW (gimple_switch_label (switch_stmt, 0)) == NULL);
6026 : 144 : unsigned min_idx = 1;
6027 : 144 : unsigned max_idx = gimple_switch_num_labels (switch_stmt) - 1;
6028 : :
6029 : : /* Binary search: try to find the label containing INT_CST.
6030 : : This requires the cases to be sorted by CASE_LOW (done by the
6031 : : gimplifier). */
6032 : 260 : while (max_idx >= min_idx)
6033 : : {
6034 : 250 : unsigned case_idx = (min_idx + max_idx) / 2;
6035 : 250 : tree label = gimple_switch_label (switch_stmt, case_idx);
6036 : 250 : tree low = CASE_LOW (label);
6037 : 250 : gcc_assert (low);
6038 : 250 : tree high = CASE_HIGH (label);
6039 : 250 : if (!high)
6040 : 198 : high = low;
6041 : 250 : if (tree_int_cst_compare (int_cst, low) < 0)
6042 : : {
6043 : : /* INT_CST is below the range of this label. */
6044 : 27 : gcc_assert (case_idx > 0);
6045 : 27 : max_idx = case_idx - 1;
6046 : : }
6047 : 223 : else if (tree_int_cst_compare (int_cst, high) > 0)
6048 : : {
6049 : : /* INT_CST is above the range of this case. */
6050 : 89 : min_idx = case_idx + 1;
6051 : : }
6052 : : else
6053 : : /* This case contains INT_CST. */
6054 : : return true;
6055 : : }
6056 : : /* Not found. */
6057 : : return false;
6058 : : }
6059 : :
6060 : : /* Return true iff SWITCH_STMT (which must be on an enum value)
6061 : : has nondefault cases handling all values in the enum. */
6062 : :
6063 : : static bool
6064 : 46 : has_nondefault_cases_for_all_enum_values_p (const gswitch *switch_stmt,
6065 : : tree type)
6066 : : {
6067 : 46 : gcc_assert (switch_stmt);
6068 : 46 : gcc_assert (TREE_CODE (type) == ENUMERAL_TYPE);
6069 : :
6070 : 46 : for (tree enum_val_iter = TYPE_VALUES (type);
6071 : 180 : enum_val_iter;
6072 : 134 : enum_val_iter = TREE_CHAIN (enum_val_iter))
6073 : : {
6074 : 144 : tree enum_val = TREE_VALUE (enum_val_iter);
6075 : 144 : gcc_assert (TREE_CODE (enum_val) == CONST_DECL);
6076 : 144 : gcc_assert (TREE_CODE (DECL_INITIAL (enum_val)) == INTEGER_CST);
6077 : 144 : if (!has_nondefault_case_for_value_p (switch_stmt,
6078 : 144 : DECL_INITIAL (enum_val)))
6079 : : return false;
6080 : : }
6081 : : return true;
6082 : : }
6083 : :
6084 : : /* Given an EDGE guarded by SWITCH_STMT, determine appropriate constraints
6085 : : for the edge to be taken.
6086 : :
6087 : : If they are feasible, add the constraints and return true.
6088 : :
6089 : : Return false if the constraints contradict existing knowledge
6090 : : (and so the edge should not be taken).
6091 : : When returning false, if OUT is non-NULL, write a new rejected_constraint
6092 : : to it. */
6093 : :
6094 : : bool
6095 : 8062 : region_model::
6096 : : apply_constraints_for_gswitch (const switch_cfg_superedge &edge,
6097 : : const gswitch *switch_stmt,
6098 : : region_model_context *ctxt,
6099 : : std::unique_ptr<rejected_constraint> *out)
6100 : : {
6101 : 8062 : tree index = gimple_switch_index (switch_stmt);
6102 : 8062 : const svalue *index_sval = get_rvalue (index, ctxt);
6103 : 8062 : bool check_index_type = true;
6104 : :
6105 : : /* With -fshort-enum, there may be a type cast. */
6106 : 7055 : if (ctxt && index_sval->get_kind () == SK_UNARYOP
6107 : 8635 : && TREE_CODE (index_sval->get_type ()) == INTEGER_TYPE)
6108 : : {
6109 : 555 : const unaryop_svalue *unaryop = as_a <const unaryop_svalue *> (index_sval);
6110 : 555 : if (unaryop->get_op () == NOP_EXPR
6111 : 555 : && is_a <const initial_svalue *> (unaryop->get_arg ()))
6112 : 543 : if (const initial_svalue *initvalop = (as_a <const initial_svalue *>
6113 : 543 : (unaryop->get_arg ())))
6114 : 543 : if (initvalop->get_type ()
6115 : 543 : && TREE_CODE (initvalop->get_type ()) == ENUMERAL_TYPE)
6116 : : {
6117 : : index_sval = initvalop;
6118 : : check_index_type = false;
6119 : : }
6120 : : }
6121 : :
6122 : : /* If we're switching based on an enum type, assume that the user is only
6123 : : working with values from the enum. Hence if this is an
6124 : : implicitly-created "default", assume it doesn't get followed.
6125 : : This fixes numerous "uninitialized" false positives where we otherwise
6126 : : consider jumping past the initialization cases. */
6127 : :
6128 : 8062 : if (/* Don't check during feasibility-checking (when ctxt is NULL). */
6129 : : ctxt
6130 : : /* Must be an enum value. */
6131 : 7055 : && index_sval->get_type ()
6132 : 7055 : && (!check_index_type
6133 : 6662 : || TREE_CODE (TREE_TYPE (index)) == ENUMERAL_TYPE)
6134 : 724 : && TREE_CODE (index_sval->get_type ()) == ENUMERAL_TYPE
6135 : : /* If we have a constant, then we can check it directly. */
6136 : 724 : && index_sval->get_kind () != SK_CONSTANT
6137 : 715 : && edge.implicitly_created_default_p ()
6138 : 46 : && has_nondefault_cases_for_all_enum_values_p (switch_stmt,
6139 : : index_sval->get_type ())
6140 : : /* Don't do this if there's a chance that the index is
6141 : : attacker-controlled. */
6142 : 8098 : && !ctxt->possibly_tainted_p (index_sval))
6143 : : {
6144 : 34 : if (out)
6145 : 0 : *out = make_unique <rejected_default_case> (*this);
6146 : 34 : return false;
6147 : : }
6148 : :
6149 : 8028 : bounded_ranges_manager *ranges_mgr = get_range_manager ();
6150 : 8028 : const bounded_ranges *all_cases_ranges
6151 : 8028 : = ranges_mgr->get_or_create_ranges_for_switch (&edge, switch_stmt);
6152 : 8028 : bool sat = m_constraints->add_bounded_ranges (index_sval, all_cases_ranges);
6153 : 8028 : if (!sat && out)
6154 : 98 : *out = make_unique <rejected_ranges_constraint> (*this, index, all_cases_ranges);
6155 : 8028 : if (sat && ctxt && !all_cases_ranges->empty_p ())
6156 : 6491 : ctxt->on_bounded_ranges (*index_sval, *all_cases_ranges);
6157 : : return sat;
6158 : : }
6159 : :
6160 : : /* Given an edge reached by GOTO_STMT, determine appropriate constraints
6161 : : for the edge to be taken.
6162 : :
6163 : : If they are feasible, add the constraints and return true.
6164 : :
6165 : : Return false if the constraints contradict existing knowledge
6166 : : (and so the edge should not be taken). */
6167 : :
6168 : : bool
6169 : 79 : region_model::apply_constraints_for_ggoto (const cfg_superedge &edge,
6170 : : const ggoto *goto_stmt,
6171 : : region_model_context *ctxt)
6172 : : {
6173 : 79 : tree dest = gimple_goto_dest (goto_stmt);
6174 : 79 : const svalue *dest_sval = get_rvalue (dest, ctxt);
6175 : :
6176 : : /* If we know we were jumping to a specific label. */
6177 : 79 : if (tree dst_label = edge.m_dest->get_label ())
6178 : : {
6179 : 79 : const label_region *dst_label_reg
6180 : 79 : = m_mgr->get_region_for_label (dst_label);
6181 : 79 : const svalue *dst_label_ptr
6182 : 79 : = m_mgr->get_ptr_svalue (ptr_type_node, dst_label_reg);
6183 : :
6184 : 79 : if (!add_constraint (dest_sval, EQ_EXPR, dst_label_ptr, ctxt))
6185 : : return false;
6186 : : }
6187 : :
6188 : : return true;
6189 : : }
6190 : :
6191 : : /* Apply any constraints due to an exception being thrown at LAST_STMT.
6192 : :
6193 : : If they are feasible, add the constraints and return true.
6194 : :
6195 : : Return false if the constraints contradict existing knowledge
6196 : : (and so the edge should not be taken).
6197 : : When returning false, if OUT is non-NULL, write a new rejected_constraint
6198 : : to it. */
6199 : :
6200 : : bool
6201 : 2497 : region_model::
6202 : : apply_constraints_for_exception (const gimple *last_stmt,
6203 : : region_model_context *ctxt,
6204 : : std::unique_ptr<rejected_constraint> *out)
6205 : : {
6206 : 2497 : gcc_assert (last_stmt);
6207 : 2497 : if (const gcall *call = dyn_cast <const gcall *> (last_stmt))
6208 : 2490 : if (tree callee_fndecl = get_fndecl_for_call (call, ctxt))
6209 : 2490 : if (is_named_call_p (callee_fndecl, "operator new", call, 1)
6210 : 2490 : || is_named_call_p (callee_fndecl, "operator new []", call, 1))
6211 : : {
6212 : : /* We have an exception thrown from operator new.
6213 : : Add a constraint that the result was NULL, to avoid a false
6214 : : leak report due to the result being lost when following
6215 : : the EH edge. */
6216 : 12 : if (tree lhs = gimple_call_lhs (call))
6217 : 12 : return add_constraint (lhs, EQ_EXPR, null_pointer_node, ctxt, out);
6218 : : return true;
6219 : : }
6220 : : return true;
6221 : : }
6222 : :
6223 : : /* For use with push_frame when handling a top-level call within the analysis.
6224 : : PARAM has a defined but unknown initial value.
6225 : : Anything it points to has escaped, since the calling context "knows"
6226 : : the pointer, and thus calls to unknown functions could read/write into
6227 : : the region.
6228 : : If NONNULL is true, then assume that PARAM must be non-NULL. */
6229 : :
6230 : : void
6231 : 18674 : region_model::on_top_level_param (tree param,
6232 : : bool nonnull,
6233 : : region_model_context *ctxt)
6234 : : {
6235 : 18674 : if (POINTER_TYPE_P (TREE_TYPE (param)))
6236 : : {
6237 : 8823 : const region *param_reg = get_lvalue (param, ctxt);
6238 : 8823 : const svalue *init_ptr_sval
6239 : 8823 : = m_mgr->get_or_create_initial_value (param_reg);
6240 : 8823 : const region *pointee_reg = m_mgr->get_symbolic_region (init_ptr_sval);
6241 : 8823 : m_store.mark_as_escaped (pointee_reg);
6242 : 8823 : if (nonnull)
6243 : : {
6244 : 356 : const svalue *null_ptr_sval
6245 : 356 : = m_mgr->get_or_create_null_ptr (TREE_TYPE (param));
6246 : 356 : add_constraint (init_ptr_sval, NE_EXPR, null_ptr_sval, ctxt);
6247 : : }
6248 : : }
6249 : 18674 : }
6250 : :
6251 : : /* Update this region_model to reflect pushing a frame onto the stack
6252 : : for a call to FUN.
6253 : :
6254 : : If ARG_SVALS is non-NULL, use it to populate the parameters
6255 : : in the new frame.
6256 : : Otherwise, the params have their initial_svalues.
6257 : :
6258 : : Return the frame_region for the new frame. */
6259 : :
6260 : : const region *
6261 : 28927 : region_model::push_frame (const function &fun,
6262 : : const vec<const svalue *> *arg_svals,
6263 : : region_model_context *ctxt)
6264 : : {
6265 : 28927 : m_current_frame = m_mgr->get_frame_region (m_current_frame, fun);
6266 : 28927 : if (arg_svals)
6267 : : {
6268 : : /* Arguments supplied from a caller frame. */
6269 : 9592 : tree fndecl = fun.decl;
6270 : 9592 : unsigned idx = 0;
6271 : 19778 : for (tree iter_parm = DECL_ARGUMENTS (fndecl); iter_parm;
6272 : 10186 : iter_parm = DECL_CHAIN (iter_parm), ++idx)
6273 : : {
6274 : : /* If there's a mismatching declaration, the call stmt might
6275 : : not have enough args. Handle this case by leaving the
6276 : : rest of the params as uninitialized. */
6277 : 10189 : if (idx >= arg_svals->length ())
6278 : : break;
6279 : 10186 : tree parm_lval = iter_parm;
6280 : 10186 : if (tree parm_default_ssa = get_ssa_default_def (fun, iter_parm))
6281 : 9193 : parm_lval = parm_default_ssa;
6282 : 10186 : const region *parm_reg = get_lvalue (parm_lval, ctxt);
6283 : 10186 : const svalue *arg_sval = (*arg_svals)[idx];
6284 : 10186 : set_value (parm_reg, arg_sval, ctxt);
6285 : : }
6286 : :
6287 : : /* Handle any variadic args. */
6288 : : unsigned va_arg_idx = 0;
6289 : 9994 : for (; idx < arg_svals->length (); idx++, va_arg_idx++)
6290 : : {
6291 : 402 : const svalue *arg_sval = (*arg_svals)[idx];
6292 : 402 : const region *var_arg_reg
6293 : 402 : = m_mgr->get_var_arg_region (m_current_frame,
6294 : : va_arg_idx);
6295 : 402 : set_value (var_arg_reg, arg_sval, ctxt);
6296 : : }
6297 : : }
6298 : : else
6299 : : {
6300 : : /* Otherwise we have a top-level call within the analysis. The params
6301 : : have defined but unknown initial values.
6302 : : Anything they point to has escaped. */
6303 : 19335 : tree fndecl = fun.decl;
6304 : :
6305 : : /* Handle "__attribute__((nonnull))". */
6306 : 19335 : tree fntype = TREE_TYPE (fndecl);
6307 : 19335 : bitmap nonnull_args = get_nonnull_args (fntype);
6308 : :
6309 : 19335 : unsigned parm_idx = 0;
6310 : 38009 : for (tree iter_parm = DECL_ARGUMENTS (fndecl); iter_parm;
6311 : 18674 : iter_parm = DECL_CHAIN (iter_parm))
6312 : : {
6313 : 18674 : bool non_null = (nonnull_args
6314 : 18674 : ? (bitmap_empty_p (nonnull_args)
6315 : 388 : || bitmap_bit_p (nonnull_args, parm_idx))
6316 : 18674 : : false);
6317 : 18674 : if (tree parm_default_ssa = get_ssa_default_def (fun, iter_parm))
6318 : 15651 : on_top_level_param (parm_default_ssa, non_null, ctxt);
6319 : : else
6320 : 3023 : on_top_level_param (iter_parm, non_null, ctxt);
6321 : 18674 : parm_idx++;
6322 : : }
6323 : :
6324 : 19335 : BITMAP_FREE (nonnull_args);
6325 : : }
6326 : :
6327 : 28927 : return m_current_frame;
6328 : : }
6329 : :
6330 : : /* Get the function of the top-most frame in this region_model's stack.
6331 : : There must be such a frame. */
6332 : :
6333 : : const function *
6334 : 19445 : region_model::get_current_function () const
6335 : : {
6336 : 19445 : const frame_region *frame = get_current_frame ();
6337 : 19445 : gcc_assert (frame);
6338 : 19445 : return &frame->get_function ();
6339 : : }
6340 : :
6341 : : /* Custom region_model_context for the assignment to the result
6342 : : at a call statement when popping a frame (PR analyzer/106203). */
6343 : :
6344 : : class caller_context : public region_model_context_decorator
6345 : : {
6346 : : public:
6347 : 3629 : caller_context (region_model_context *inner,
6348 : : const gcall *call_stmt,
6349 : : const frame_region &caller_frame)
6350 : 3629 : : region_model_context_decorator (inner),
6351 : 3629 : m_call_stmt (call_stmt),
6352 : 3629 : m_caller_frame (caller_frame)
6353 : : {}
6354 : 12 : bool warn (std::unique_ptr<pending_diagnostic> d,
6355 : : const stmt_finder *custom_finder) override
6356 : : {
6357 : 12 : if (m_inner && custom_finder == nullptr)
6358 : : {
6359 : : /* Custom stmt_finder to use m_call_stmt for the
6360 : : diagnostic. */
6361 : 0 : class my_finder : public stmt_finder
6362 : : {
6363 : : public:
6364 : 24 : my_finder (const gcall *call_stmt,
6365 : : const frame_region &caller_frame)
6366 : 24 : : m_call_stmt (call_stmt),
6367 : 12 : m_caller_frame (caller_frame)
6368 : : {}
6369 : 12 : std::unique_ptr<stmt_finder> clone () const override
6370 : : {
6371 : 12 : return ::make_unique<my_finder> (m_call_stmt, m_caller_frame);
6372 : : }
6373 : 12 : const gimple *find_stmt (const exploded_path &) override
6374 : : {
6375 : 12 : return m_call_stmt;
6376 : : }
6377 : 12 : void update_event_loc_info (event_loc_info &loc_info) final override
6378 : : {
6379 : 12 : loc_info.m_fndecl = m_caller_frame.get_fndecl ();
6380 : 12 : loc_info.m_depth = m_caller_frame.get_stack_depth ();
6381 : 12 : }
6382 : :
6383 : : private:
6384 : : const gcall *m_call_stmt;
6385 : : const frame_region &m_caller_frame;
6386 : : };
6387 : 12 : my_finder finder (m_call_stmt, m_caller_frame);
6388 : 12 : return m_inner->warn (std::move (d), &finder);
6389 : 12 : }
6390 : : else
6391 : 0 : return region_model_context_decorator::warn (std::move (d),
6392 : : custom_finder);
6393 : : }
6394 : 7270 : const gimple *get_stmt () const override
6395 : : {
6396 : 7270 : return m_call_stmt;
6397 : : };
6398 : :
6399 : : private:
6400 : : const gcall *m_call_stmt;
6401 : : const frame_region &m_caller_frame;
6402 : : };
6403 : :
6404 : :
6405 : : /* Pop the topmost frame_region from this region_model's stack;
6406 : :
6407 : : If RESULT_LVALUE is non-null, copy any return value from the frame
6408 : : into the corresponding region (evaluated with respect to the *caller*
6409 : : frame, rather than the called frame).
6410 : : If OUT_RESULT is non-null, copy any return value from the frame
6411 : : into *OUT_RESULT.
6412 : :
6413 : : If non-null, use CALL_STMT as the location when complaining about
6414 : : assignment of the return value to RESULT_LVALUE.
6415 : :
6416 : : If EVAL_RETURN_SVALUE is false, then don't evaluate the return value.
6417 : : This is for use when unwinding frames e.g. due to longjmp, to suppress
6418 : : erroneously reporting uninitialized return values.
6419 : :
6420 : : Purge the frame region and all its descendent regions.
6421 : : Convert any pointers that point into such regions into
6422 : : POISON_KIND_POPPED_STACK svalues. */
6423 : :
6424 : : void
6425 : 18106 : region_model::pop_frame (tree result_lvalue,
6426 : : const svalue **out_result,
6427 : : region_model_context *ctxt,
6428 : : const gcall *call_stmt,
6429 : : bool eval_return_svalue)
6430 : : {
6431 : 18106 : gcc_assert (m_current_frame);
6432 : :
6433 : 18106 : const region_model pre_popped_model = *this;
6434 : 18106 : const frame_region *frame_reg = m_current_frame;
6435 : :
6436 : : /* Notify state machines. */
6437 : 18106 : if (ctxt)
6438 : 16145 : ctxt->on_pop_frame (frame_reg);
6439 : :
6440 : : /* Evaluate the result, within the callee frame. */
6441 : 18106 : tree fndecl = m_current_frame->get_function ().decl;
6442 : 18106 : tree result = DECL_RESULT (fndecl);
6443 : 18106 : const svalue *retval = NULL;
6444 : 18106 : if (result
6445 : 18098 : && TREE_TYPE (result) != void_type_node
6446 : 26975 : && eval_return_svalue)
6447 : : {
6448 : 8861 : retval = get_rvalue (result, ctxt);
6449 : 8861 : if (out_result)
6450 : 4922 : *out_result = retval;
6451 : : }
6452 : :
6453 : : /* Pop the frame. */
6454 : 18106 : m_current_frame = m_current_frame->get_calling_frame ();
6455 : :
6456 : 18106 : if (result_lvalue && retval)
6457 : : {
6458 : 3629 : gcc_assert (eval_return_svalue);
6459 : :
6460 : : /* Compute result_dst_reg using RESULT_LVALUE *after* popping
6461 : : the frame, but before poisoning pointers into the old frame. */
6462 : 3629 : const region *result_dst_reg = get_lvalue (result_lvalue, ctxt);
6463 : :
6464 : : /* Assign retval to result_dst_reg, using caller_context
6465 : : to set the call_stmt and the popped_frame for any diagnostics
6466 : : due to the assignment. */
6467 : 3629 : gcc_assert (m_current_frame);
6468 : 3629 : caller_context caller_ctxt (ctxt, call_stmt, *m_current_frame);
6469 : 3629 : set_value (result_dst_reg, retval, call_stmt ? &caller_ctxt : ctxt);
6470 : : }
6471 : :
6472 : 18106 : unbind_region_and_descendents (frame_reg,POISON_KIND_POPPED_STACK);
6473 : 18106 : notify_on_pop_frame (this, &pre_popped_model, retval, ctxt);
6474 : 18106 : }
6475 : :
6476 : : /* Get the number of frames in this region_model's stack. */
6477 : :
6478 : : int
6479 : 5023339 : region_model::get_stack_depth () const
6480 : : {
6481 : 5023339 : const frame_region *frame = get_current_frame ();
6482 : 5023339 : if (frame)
6483 : 5006868 : return frame->get_stack_depth ();
6484 : : else
6485 : : return 0;
6486 : : }
6487 : :
6488 : : /* Get the frame_region with the given index within the stack.
6489 : : The frame_region must exist. */
6490 : :
6491 : : const frame_region *
6492 : 1567223 : region_model::get_frame_at_index (int index) const
6493 : : {
6494 : 1567223 : const frame_region *frame = get_current_frame ();
6495 : 1567223 : gcc_assert (frame);
6496 : 1567223 : gcc_assert (index >= 0);
6497 : 1567223 : gcc_assert (index <= frame->get_index ());
6498 : 1876087 : while (index != frame->get_index ())
6499 : : {
6500 : 308864 : frame = frame->get_calling_frame ();
6501 : 308864 : gcc_assert (frame);
6502 : : }
6503 : 1567223 : return frame;
6504 : : }
6505 : :
6506 : : /* Unbind svalues for any regions in REG and below.
6507 : : Find any pointers to such regions; convert them to
6508 : : poisoned values of kind PKIND.
6509 : : Also purge any dynamic extents. */
6510 : :
6511 : : void
6512 : 29076 : region_model::unbind_region_and_descendents (const region *reg,
6513 : : enum poison_kind pkind)
6514 : : {
6515 : : /* Gather a set of base regions to be unbound. */
6516 : 29076 : hash_set<const region *> base_regs;
6517 : 170416 : for (store::cluster_map_t::iterator iter = m_store.begin ();
6518 : 311756 : iter != m_store.end (); ++iter)
6519 : : {
6520 : 141340 : const region *iter_base_reg = (*iter).first;
6521 : 141340 : if (iter_base_reg->descendent_of_p (reg))
6522 : 32601 : base_regs.add (iter_base_reg);
6523 : : }
6524 : 61677 : for (hash_set<const region *>::iterator iter = base_regs.begin ();
6525 : 94278 : iter != base_regs.end (); ++iter)
6526 : 32601 : m_store.purge_cluster (*iter);
6527 : :
6528 : : /* Find any pointers to REG or its descendents; convert to poisoned. */
6529 : 29076 : poison_any_pointers_to_descendents (reg, pkind);
6530 : :
6531 : : /* Purge dynamic extents of any base regions in REG and below
6532 : : (e.g. VLAs and alloca stack regions). */
6533 : 92264 : for (auto iter : m_dynamic_extents)
6534 : : {
6535 : 17056 : const region *iter_reg = iter.first;
6536 : 17056 : if (iter_reg->descendent_of_p (reg))
6537 : 6343 : unset_dynamic_extents (iter_reg);
6538 : : }
6539 : 29076 : }
6540 : :
6541 : : /* Implementation of BindingVisitor.
6542 : : Update the bound svalues for regions below REG to use poisoned
6543 : : values instead. */
6544 : :
6545 : : struct bad_pointer_finder
6546 : : {
6547 : 29076 : bad_pointer_finder (const region *reg, enum poison_kind pkind,
6548 : : region_model_manager *mgr)
6549 : 29076 : : m_reg (reg), m_pkind (pkind), m_mgr (mgr), m_count (0)
6550 : : {}
6551 : :
6552 : 113066 : void on_binding (const binding_key *, const svalue *&sval)
6553 : : {
6554 : 113066 : if (const region_svalue *ptr_sval = sval->dyn_cast_region_svalue ())
6555 : : {
6556 : 27387 : const region *ptr_dst = ptr_sval->get_pointee ();
6557 : : /* Poison ptrs to descendents of REG, but not to REG itself,
6558 : : otherwise double-free detection doesn't work (since sm-state
6559 : : for "free" is stored on the original ptr svalue). */
6560 : 27387 : if (ptr_dst->descendent_of_p (m_reg)
6561 : 27387 : && ptr_dst != m_reg)
6562 : : {
6563 : 151 : sval = m_mgr->get_or_create_poisoned_svalue (m_pkind,
6564 : : sval->get_type ());
6565 : 151 : ++m_count;
6566 : : }
6567 : : }
6568 : 113066 : }
6569 : :
6570 : : const region *m_reg;
6571 : : enum poison_kind m_pkind;
6572 : : region_model_manager *const m_mgr;
6573 : : int m_count;
6574 : : };
6575 : :
6576 : : /* Find any pointers to REG or its descendents; convert them to
6577 : : poisoned values of kind PKIND.
6578 : : Return the number of pointers that were poisoned. */
6579 : :
6580 : : int
6581 : 29076 : region_model::poison_any_pointers_to_descendents (const region *reg,
6582 : : enum poison_kind pkind)
6583 : : {
6584 : 29076 : bad_pointer_finder bv (reg, pkind, m_mgr);
6585 : 29076 : m_store.for_each_binding (bv);
6586 : 29076 : return bv.m_count;
6587 : : }
6588 : :
6589 : : /* Attempt to merge THIS with OTHER_MODEL, writing the result
6590 : : to OUT_MODEL. Use POINT to distinguish values created as a
6591 : : result of merging. */
6592 : :
6593 : : bool
6594 : 151668 : region_model::can_merge_with_p (const region_model &other_model,
6595 : : const program_point &point,
6596 : : region_model *out_model,
6597 : : const extrinsic_state *ext_state,
6598 : : const program_state *state_a,
6599 : : const program_state *state_b) const
6600 : : {
6601 : 151668 : gcc_assert (out_model);
6602 : 151668 : gcc_assert (m_mgr == other_model.m_mgr);
6603 : 151668 : gcc_assert (m_mgr == out_model->m_mgr);
6604 : :
6605 : 151668 : if (m_current_frame != other_model.m_current_frame)
6606 : : return false;
6607 : 151668 : out_model->m_current_frame = m_current_frame;
6608 : :
6609 : 151668 : model_merger m (this, &other_model, point, out_model,
6610 : 151668 : ext_state, state_a, state_b);
6611 : :
6612 : 151668 : if (!store::can_merge_p (&m_store, &other_model.m_store,
6613 : 151668 : &out_model->m_store, m_mgr->get_store_manager (),
6614 : : &m))
6615 : : return false;
6616 : :
6617 : 66563 : if (!m_dynamic_extents.can_merge_with_p (other_model.m_dynamic_extents,
6618 : : &out_model->m_dynamic_extents))
6619 : : return false;
6620 : :
6621 : : /* Merge constraints. */
6622 : 62255 : constraint_manager::merge (*m_constraints,
6623 : 62255 : *other_model.m_constraints,
6624 : : out_model->m_constraints);
6625 : :
6626 : 63033 : for (auto iter : m.m_svals_changing_meaning)
6627 : 778 : out_model->m_constraints->purge_state_involving (iter);
6628 : :
6629 : 62255 : return true;
6630 : 151668 : }
6631 : :
6632 : : /* Attempt to get the fndecl used at CALL, if known, or NULL_TREE
6633 : : otherwise. */
6634 : :
6635 : : tree
6636 : 884227 : region_model::get_fndecl_for_call (const gcall *call,
6637 : : region_model_context *ctxt)
6638 : : {
6639 : 884227 : tree fn_ptr = gimple_call_fn (call);
6640 : 884227 : if (fn_ptr == NULL_TREE)
6641 : : return NULL_TREE;
6642 : 870450 : const svalue *fn_ptr_sval = get_rvalue (fn_ptr, ctxt);
6643 : 1740900 : if (const region_svalue *fn_ptr_ptr
6644 : 870450 : = fn_ptr_sval->dyn_cast_region_svalue ())
6645 : : {
6646 : 864647 : const region *reg = fn_ptr_ptr->get_pointee ();
6647 : 864647 : if (const function_region *fn_reg = reg->dyn_cast_function_region ())
6648 : : {
6649 : 864599 : tree fn_decl = fn_reg->get_fndecl ();
6650 : 864599 : cgraph_node *node = cgraph_node::get (fn_decl);
6651 : 864599 : if (!node)
6652 : : return NULL_TREE;
6653 : 864599 : const cgraph_node *ultimate_node = node->ultimate_alias_target ();
6654 : 864599 : if (ultimate_node)
6655 : 864599 : return ultimate_node->decl;
6656 : : }
6657 : : }
6658 : :
6659 : : return NULL_TREE;
6660 : : }
6661 : :
6662 : : /* Would be much simpler to use a lambda here, if it were supported. */
6663 : :
6664 : : struct append_regions_cb_data
6665 : : {
6666 : : const region_model *model;
6667 : : auto_vec<const decl_region *> *out;
6668 : : };
6669 : :
6670 : : /* Populate *OUT with all decl_regions in the current
6671 : : frame that have clusters within the store. */
6672 : :
6673 : : void
6674 : 598400 : region_model::
6675 : : get_regions_for_current_frame (auto_vec<const decl_region *> *out) const
6676 : : {
6677 : 598400 : append_regions_cb_data data;
6678 : 598400 : data.model = this;
6679 : 598400 : data.out = out;
6680 : 598400 : m_store.for_each_cluster (append_regions_cb, &data);
6681 : 598400 : }
6682 : :
6683 : : /* Implementation detail of get_regions_for_current_frame. */
6684 : :
6685 : : void
6686 : 3577032 : region_model::append_regions_cb (const region *base_reg,
6687 : : append_regions_cb_data *cb_data)
6688 : : {
6689 : 3577032 : if (base_reg->get_parent_region () != cb_data->model->m_current_frame)
6690 : : return;
6691 : 1368428 : if (const decl_region *decl_reg = base_reg->dyn_cast_decl_region ())
6692 : 1332326 : cb_data->out->safe_push (decl_reg);
6693 : : }
6694 : :
6695 : :
6696 : : /* Abstract class for diagnostics related to the use of
6697 : : floating-point arithmetic where precision is needed. */
6698 : :
6699 : 46 : class imprecise_floating_point_arithmetic : public pending_diagnostic
6700 : : {
6701 : : public:
6702 : 71 : int get_controlling_option () const final override
6703 : : {
6704 : 71 : return OPT_Wanalyzer_imprecise_fp_arithmetic;
6705 : : }
6706 : : };
6707 : :
6708 : : /* Concrete diagnostic to complain about uses of floating-point arithmetic
6709 : : in the size argument of malloc etc. */
6710 : :
6711 : : class float_as_size_arg : public imprecise_floating_point_arithmetic
6712 : : {
6713 : : public:
6714 : 46 : float_as_size_arg (tree arg) : m_arg (arg)
6715 : : {}
6716 : :
6717 : 163 : const char *get_kind () const final override
6718 : : {
6719 : 163 : return "float_as_size_arg_diagnostic";
6720 : : }
6721 : :
6722 : 46 : bool subclass_equal_p (const pending_diagnostic &other) const final override
6723 : : {
6724 : 46 : return same_tree_p (m_arg, ((const float_as_size_arg &) other).m_arg);
6725 : : }
6726 : :
6727 : 25 : bool emit (diagnostic_emission_context &ctxt) final override
6728 : : {
6729 : 25 : bool warned = ctxt.warn ("use of floating-point arithmetic here might"
6730 : : " yield unexpected results");
6731 : 25 : if (warned)
6732 : 25 : inform (ctxt.get_location (),
6733 : : "only use operands of an integer type"
6734 : : " inside the size argument");
6735 : 25 : return warned;
6736 : : }
6737 : :
6738 : : bool
6739 : 50 : describe_final_event (pretty_printer &pp,
6740 : : const evdesc::final_event &) final override
6741 : : {
6742 : 50 : if (m_arg)
6743 : 50 : pp_printf (&pp,
6744 : : "operand %qE is of type %qT",
6745 : 50 : m_arg, TREE_TYPE (m_arg));
6746 : : else
6747 : 0 : pp_printf (&pp,
6748 : : "at least one operand of the size argument is"
6749 : : " of a floating-point type");
6750 : 50 : return true;
6751 : : }
6752 : :
6753 : : private:
6754 : : tree m_arg;
6755 : : };
6756 : :
6757 : : /* Visitor to find uses of floating-point variables/constants in an svalue. */
6758 : :
6759 : : class contains_floating_point_visitor : public visitor
6760 : : {
6761 : : public:
6762 : 8427 : contains_floating_point_visitor (const svalue *root_sval) : m_result (NULL)
6763 : : {
6764 : 8427 : root_sval->accept (this);
6765 : : }
6766 : :
6767 : 8427 : const svalue *get_svalue_to_report ()
6768 : : {
6769 : 8427 : return m_result;
6770 : : }
6771 : :
6772 : 7817 : void visit_constant_svalue (const constant_svalue *sval) final override
6773 : : {
6774 : : /* At the point the analyzer runs, constant integer operands in a floating
6775 : : point expression are already implictly converted to floating-points.
6776 : : Thus, we do prefer to report non-constants such that the diagnostic
6777 : : always reports a floating-point operand. */
6778 : 7817 : tree type = sval->get_type ();
6779 : 7817 : if (type && FLOAT_TYPE_P (type) && !m_result)
6780 : 18 : m_result = sval;
6781 : 7817 : }
6782 : :
6783 : 443 : void visit_conjured_svalue (const conjured_svalue *sval) final override
6784 : : {
6785 : 443 : tree type = sval->get_type ();
6786 : 443 : if (type && FLOAT_TYPE_P (type))
6787 : 0 : m_result = sval;
6788 : 443 : }
6789 : :
6790 : 1289 : void visit_initial_svalue (const initial_svalue *sval) final override
6791 : : {
6792 : 1289 : tree type = sval->get_type ();
6793 : 1289 : if (type && FLOAT_TYPE_P (type))
6794 : 28 : m_result = sval;
6795 : 1289 : }
6796 : :
6797 : : private:
6798 : : /* Non-null if at least one floating-point operand was found. */
6799 : : const svalue *m_result;
6800 : : };
6801 : :
6802 : : /* May complain about uses of floating-point operands in SIZE_IN_BYTES. */
6803 : :
6804 : : void
6805 : 8427 : region_model::check_dynamic_size_for_floats (const svalue *size_in_bytes,
6806 : : region_model_context *ctxt) const
6807 : : {
6808 : 8427 : gcc_assert (ctxt);
6809 : :
6810 : 8427 : contains_floating_point_visitor v (size_in_bytes);
6811 : 8427 : if (const svalue *float_sval = v.get_svalue_to_report ())
6812 : : {
6813 : 46 : tree diag_arg = get_representative_tree (float_sval);
6814 : 46 : ctxt->warn (make_unique<float_as_size_arg> (diag_arg));
6815 : : }
6816 : 8427 : }
6817 : :
6818 : : /* Return a region describing a heap-allocated block of memory.
6819 : : Use CTXT to complain about tainted sizes.
6820 : :
6821 : : Reuse an existing heap_allocated_region if it's not being referenced by
6822 : : this region_model; otherwise create a new one.
6823 : :
6824 : : Optionally (update_state_machine) transitions the pointer pointing to the
6825 : : heap_allocated_region from start to assumed non-null. */
6826 : :
6827 : : const region *
6828 : 12687 : region_model::get_or_create_region_for_heap_alloc (const svalue *size_in_bytes,
6829 : : region_model_context *ctxt,
6830 : : bool update_state_machine,
6831 : : const call_details *cd)
6832 : : {
6833 : : /* Determine which regions are referenced in this region_model, so that
6834 : : we can reuse an existing heap_allocated_region if it's not in use on
6835 : : this path. */
6836 : 12687 : auto_bitmap base_regs_in_use;
6837 : 12687 : get_referenced_base_regions (base_regs_in_use);
6838 : :
6839 : : /* Don't reuse regions that are marked as TOUCHED. */
6840 : 89729 : for (store::cluster_map_t::iterator iter = m_store.begin ();
6841 : 166771 : iter != m_store.end (); ++iter)
6842 : 77042 : if ((*iter).second->touched_p ())
6843 : : {
6844 : 9531 : const region *base_reg = (*iter).first;
6845 : 9531 : bitmap_set_bit (base_regs_in_use, base_reg->get_id ());
6846 : : }
6847 : :
6848 : 12687 : const region *reg
6849 : 12687 : = m_mgr->get_or_create_region_for_heap_alloc (base_regs_in_use);
6850 : 12687 : if (size_in_bytes)
6851 : 12661 : if (compat_types_p (size_in_bytes->get_type (), size_type_node))
6852 : 12661 : set_dynamic_extents (reg, size_in_bytes, ctxt);
6853 : :
6854 : 12687 : if (update_state_machine && cd)
6855 : : {
6856 : 0 : const svalue *ptr_sval
6857 : 0 : = m_mgr->get_ptr_svalue (cd->get_lhs_type (), reg);
6858 : 0 : transition_ptr_sval_non_null (ctxt, ptr_sval);
6859 : : }
6860 : :
6861 : 12687 : return reg;
6862 : 12687 : }
6863 : :
6864 : : /* Populate OUT_IDS with the set of IDs of those base regions which are
6865 : : reachable in this region_model. */
6866 : :
6867 : : void
6868 : 15708 : region_model::get_referenced_base_regions (auto_bitmap &out_ids) const
6869 : : {
6870 : 15708 : reachable_regions reachable_regs (const_cast<region_model *> (this));
6871 : 15708 : m_store.for_each_cluster (reachable_regions::init_cluster_cb,
6872 : : &reachable_regs);
6873 : : /* Get regions for locals that have explicitly bound values. */
6874 : 150792 : for (store::cluster_map_t::iterator iter = m_store.begin ();
6875 : 285876 : iter != m_store.end (); ++iter)
6876 : : {
6877 : 135084 : const region *base_reg = (*iter).first;
6878 : 135084 : if (const region *parent = base_reg->get_parent_region ())
6879 : 135084 : if (parent->get_kind () == RK_FRAME)
6880 : 72915 : reachable_regs.add (base_reg, false);
6881 : : }
6882 : :
6883 : 15708 : bitmap_clear (out_ids);
6884 : 153595 : for (auto iter_reg : reachable_regs)
6885 : 137887 : bitmap_set_bit (out_ids, iter_reg->get_id ());
6886 : 15708 : }
6887 : :
6888 : : /* Return a new region describing a block of memory allocated within the
6889 : : current frame.
6890 : : Use CTXT to complain about tainted sizes. */
6891 : :
6892 : : const region *
6893 : 538 : region_model::create_region_for_alloca (const svalue *size_in_bytes,
6894 : : region_model_context *ctxt)
6895 : : {
6896 : 538 : const region *reg = m_mgr->create_region_for_alloca (m_current_frame);
6897 : 538 : if (compat_types_p (size_in_bytes->get_type (), size_type_node))
6898 : 537 : set_dynamic_extents (reg, size_in_bytes, ctxt);
6899 : 538 : return reg;
6900 : : }
6901 : :
6902 : : /* Record that the size of REG is SIZE_IN_BYTES.
6903 : : Use CTXT to complain about tainted sizes. */
6904 : :
6905 : : void
6906 : 13785 : region_model::set_dynamic_extents (const region *reg,
6907 : : const svalue *size_in_bytes,
6908 : : region_model_context *ctxt)
6909 : : {
6910 : 13785 : assert_compat_types (size_in_bytes->get_type (), size_type_node);
6911 : 13785 : if (ctxt)
6912 : : {
6913 : 8427 : check_dynamic_size_for_taint (reg->get_memory_space (), size_in_bytes,
6914 : : ctxt);
6915 : 8427 : check_dynamic_size_for_floats (size_in_bytes, ctxt);
6916 : : }
6917 : 13785 : m_dynamic_extents.put (reg, size_in_bytes);
6918 : 13785 : }
6919 : :
6920 : : /* Get the recording of REG in bytes, or NULL if no dynamic size was
6921 : : recorded. */
6922 : :
6923 : : const svalue *
6924 : 60720 : region_model::get_dynamic_extents (const region *reg) const
6925 : : {
6926 : 60720 : if (const svalue * const *slot = m_dynamic_extents.get (reg))
6927 : 13152 : return *slot;
6928 : : return NULL;
6929 : : }
6930 : :
6931 : : /* Unset any recorded dynamic size of REG. */
6932 : :
6933 : : void
6934 : 57502 : region_model::unset_dynamic_extents (const region *reg)
6935 : : {
6936 : 57502 : m_dynamic_extents.remove (reg);
6937 : 57502 : }
6938 : :
6939 : : /* A subclass of pending_diagnostic for complaining about uninitialized data
6940 : : being copied across a trust boundary to an untrusted output
6941 : : (e.g. copy_to_user infoleaks in the Linux kernel). */
6942 : :
6943 : : class exposure_through_uninit_copy
6944 : : : public pending_diagnostic_subclass<exposure_through_uninit_copy>
6945 : : {
6946 : : public:
6947 : 47 : exposure_through_uninit_copy (const region *src_region,
6948 : : const region *dest_region,
6949 : : const svalue *copied_sval)
6950 : 47 : : m_src_region (src_region),
6951 : 47 : m_dest_region (dest_region),
6952 : 47 : m_copied_sval (copied_sval)
6953 : : {
6954 : 47 : gcc_assert (m_copied_sval->get_kind () == SK_POISONED
6955 : : || m_copied_sval->get_kind () == SK_COMPOUND);
6956 : 47 : }
6957 : :
6958 : 166 : const char *get_kind () const final override
6959 : : {
6960 : 166 : return "exposure_through_uninit_copy";
6961 : : }
6962 : :
6963 : 47 : bool operator== (const exposure_through_uninit_copy &other) const
6964 : : {
6965 : 47 : return (m_src_region == other.m_src_region
6966 : 47 : && m_dest_region == other.m_dest_region
6967 : 94 : && m_copied_sval == other.m_copied_sval);
6968 : : }
6969 : :
6970 : 72 : int get_controlling_option () const final override
6971 : : {
6972 : 72 : return OPT_Wanalyzer_exposure_through_uninit_copy;
6973 : : }
6974 : :
6975 : 25 : bool emit (diagnostic_emission_context &ctxt) final override
6976 : : {
6977 : : /* CWE-200: Exposure of Sensitive Information to an Unauthorized Actor. */
6978 : 25 : ctxt.add_cwe (200);
6979 : 50 : enum memory_space mem_space = get_src_memory_space ();
6980 : 25 : bool warned;
6981 : 25 : switch (mem_space)
6982 : : {
6983 : 0 : default:
6984 : 0 : warned = ctxt.warn ("potential exposure of sensitive information"
6985 : : " by copying uninitialized data"
6986 : : " across trust boundary");
6987 : 0 : break;
6988 : 25 : case MEMSPACE_STACK:
6989 : 25 : warned = ctxt.warn ("potential exposure of sensitive information"
6990 : : " by copying uninitialized data from stack"
6991 : : " across trust boundary");
6992 : 25 : break;
6993 : 0 : case MEMSPACE_HEAP:
6994 : 0 : warned = ctxt.warn ("potential exposure of sensitive information"
6995 : : " by copying uninitialized data from heap"
6996 : : " across trust boundary");
6997 : 0 : break;
6998 : : }
6999 : 25 : if (warned)
7000 : : {
7001 : 25 : const location_t loc = ctxt.get_location ();
7002 : 25 : inform_number_of_uninit_bits (loc);
7003 : 25 : complain_about_uninit_ranges (loc);
7004 : :
7005 : 25 : if (mem_space == MEMSPACE_STACK)
7006 : 25 : maybe_emit_fixit_hint ();
7007 : : }
7008 : 25 : return warned;
7009 : : }
7010 : :
7011 : : bool
7012 : 50 : describe_final_event (pretty_printer &pp,
7013 : : const evdesc::final_event &) final override
7014 : : {
7015 : 100 : enum memory_space mem_space = get_src_memory_space ();
7016 : 50 : switch (mem_space)
7017 : : {
7018 : 0 : default:
7019 : 0 : pp_string (&pp, "uninitialized data copied here");
7020 : 0 : return true;
7021 : :
7022 : 50 : case MEMSPACE_STACK:
7023 : 50 : pp_string (&pp, "uninitialized data copied from stack here");
7024 : 50 : return true;
7025 : :
7026 : 0 : case MEMSPACE_HEAP:
7027 : 0 : pp_string (&pp, "uninitialized data copied from heap here");
7028 : 0 : return true;
7029 : : }
7030 : : }
7031 : :
7032 : 25 : void mark_interesting_stuff (interesting_t *interest) final override
7033 : : {
7034 : 25 : if (m_src_region)
7035 : 25 : interest->add_region_creation (m_src_region);
7036 : 25 : }
7037 : :
7038 : : void
7039 : 0 : maybe_add_sarif_properties (sarif_object &result_obj) const final override
7040 : : {
7041 : 0 : sarif_property_bag &props = result_obj.get_or_create_properties ();
7042 : : #define PROPERTY_PREFIX "gcc/-Wanalyzer-exposure-through-uninit-copy/"
7043 : 0 : props.set (PROPERTY_PREFIX "src_region", m_src_region->to_json ());
7044 : 0 : props.set (PROPERTY_PREFIX "dest_region", m_dest_region->to_json ());
7045 : 0 : props.set (PROPERTY_PREFIX "copied_sval", m_copied_sval->to_json ());
7046 : : #undef PROPERTY_PREFIX
7047 : 0 : }
7048 : :
7049 : : private:
7050 : 75 : enum memory_space get_src_memory_space () const
7051 : : {
7052 : 75 : return m_src_region ? m_src_region->get_memory_space () : MEMSPACE_UNKNOWN;
7053 : : }
7054 : :
7055 : 25 : bit_size_t calc_num_uninit_bits () const
7056 : : {
7057 : 25 : switch (m_copied_sval->get_kind ())
7058 : : {
7059 : 0 : default:
7060 : 0 : gcc_unreachable ();
7061 : 4 : break;
7062 : 4 : case SK_POISONED:
7063 : 4 : {
7064 : 4 : const poisoned_svalue *poisoned_sval
7065 : 4 : = as_a <const poisoned_svalue *> (m_copied_sval);
7066 : 4 : gcc_assert (poisoned_sval->get_poison_kind () == POISON_KIND_UNINIT);
7067 : :
7068 : : /* Give up if don't have type information. */
7069 : 4 : if (m_copied_sval->get_type () == NULL_TREE)
7070 : 0 : return 0;
7071 : :
7072 : 4 : bit_size_t size_in_bits;
7073 : 4 : if (int_size_in_bits (m_copied_sval->get_type (), &size_in_bits))
7074 : 4 : return size_in_bits;
7075 : :
7076 : : /* Give up if we can't get the size of the type. */
7077 : 0 : return 0;
7078 : : }
7079 : 21 : break;
7080 : 21 : case SK_COMPOUND:
7081 : 21 : {
7082 : 21 : const compound_svalue *compound_sval
7083 : 21 : = as_a <const compound_svalue *> (m_copied_sval);
7084 : 21 : bit_size_t result = 0;
7085 : : /* Find keys for uninit svals. */
7086 : 143 : for (auto iter : *compound_sval)
7087 : : {
7088 : 61 : const svalue *sval = iter.second;
7089 : 122 : if (const poisoned_svalue *psval
7090 : 61 : = sval->dyn_cast_poisoned_svalue ())
7091 : 24 : if (psval->get_poison_kind () == POISON_KIND_UNINIT)
7092 : : {
7093 : 24 : const binding_key *key = iter.first;
7094 : 24 : const concrete_binding *ckey
7095 : 24 : = key->dyn_cast_concrete_binding ();
7096 : 24 : gcc_assert (ckey);
7097 : 24 : result += ckey->get_size_in_bits ();
7098 : : }
7099 : : }
7100 : 21 : return result;
7101 : : }
7102 : : }
7103 : : }
7104 : :
7105 : 25 : void inform_number_of_uninit_bits (location_t loc) const
7106 : : {
7107 : 25 : bit_size_t num_uninit_bits = calc_num_uninit_bits ();
7108 : 25 : if (num_uninit_bits <= 0)
7109 : 0 : return;
7110 : 25 : if (num_uninit_bits % BITS_PER_UNIT == 0)
7111 : : {
7112 : : /* Express in bytes. */
7113 : 25 : byte_size_t num_uninit_bytes = num_uninit_bits / BITS_PER_UNIT;
7114 : 25 : if (num_uninit_bytes == 1)
7115 : 3 : inform (loc, "1 byte is uninitialized");
7116 : : else
7117 : 22 : inform (loc,
7118 : : "%wu bytes are uninitialized", num_uninit_bytes.to_uhwi ());
7119 : : }
7120 : : else
7121 : : {
7122 : : /* Express in bits. */
7123 : 0 : if (num_uninit_bits == 1)
7124 : 0 : inform (loc, "1 bit is uninitialized");
7125 : : else
7126 : 0 : inform (loc,
7127 : : "%wu bits are uninitialized", num_uninit_bits.to_uhwi ());
7128 : : }
7129 : : }
7130 : :
7131 : 25 : void complain_about_uninit_ranges (location_t loc) const
7132 : : {
7133 : 50 : if (const compound_svalue *compound_sval
7134 : 25 : = m_copied_sval->dyn_cast_compound_svalue ())
7135 : : {
7136 : : /* Find keys for uninit svals. */
7137 : 21 : auto_vec<const concrete_binding *> uninit_keys;
7138 : 143 : for (auto iter : *compound_sval)
7139 : : {
7140 : 61 : const svalue *sval = iter.second;
7141 : 122 : if (const poisoned_svalue *psval
7142 : 61 : = sval->dyn_cast_poisoned_svalue ())
7143 : 24 : if (psval->get_poison_kind () == POISON_KIND_UNINIT)
7144 : : {
7145 : 24 : const binding_key *key = iter.first;
7146 : 24 : const concrete_binding *ckey
7147 : 24 : = key->dyn_cast_concrete_binding ();
7148 : 24 : gcc_assert (ckey);
7149 : 24 : uninit_keys.safe_push (ckey);
7150 : : }
7151 : : }
7152 : : /* Complain about them in sorted order. */
7153 : 21 : uninit_keys.qsort (concrete_binding::cmp_ptr_ptr);
7154 : :
7155 : 21 : std::unique_ptr<record_layout> layout;
7156 : :
7157 : 21 : tree type = m_copied_sval->get_type ();
7158 : 21 : if (type && TREE_CODE (type) == RECORD_TYPE)
7159 : : {
7160 : : // (std::make_unique is C++14)
7161 : 17 : layout = std::unique_ptr<record_layout> (new record_layout (type));
7162 : :
7163 : 17 : if (0)
7164 : : layout->dump ();
7165 : : }
7166 : :
7167 : : unsigned i;
7168 : : const concrete_binding *ckey;
7169 : 45 : FOR_EACH_VEC_ELT (uninit_keys, i, ckey)
7170 : : {
7171 : 24 : bit_offset_t start_bit = ckey->get_start_bit_offset ();
7172 : 24 : bit_offset_t next_bit = ckey->get_next_bit_offset ();
7173 : 24 : complain_about_uninit_range (loc, start_bit, next_bit,
7174 : 24 : layout.get ());
7175 : : }
7176 : 21 : }
7177 : 25 : }
7178 : :
7179 : 24 : void complain_about_uninit_range (location_t loc,
7180 : : bit_offset_t start_bit,
7181 : : bit_offset_t next_bit,
7182 : : const record_layout *layout) const
7183 : : {
7184 : 24 : if (layout)
7185 : : {
7186 : 75 : while (start_bit < next_bit)
7187 : : {
7188 : 165 : if (const record_layout::item *item
7189 : 55 : = layout->get_item_at (start_bit))
7190 : : {
7191 : 55 : gcc_assert (start_bit >= item->get_start_bit_offset ());
7192 : 55 : gcc_assert (start_bit < item->get_next_bit_offset ());
7193 : 55 : if (item->get_start_bit_offset () == start_bit
7194 : 108 : && item->get_next_bit_offset () <= next_bit)
7195 : 53 : complain_about_fully_uninit_item (*item);
7196 : : else
7197 : 2 : complain_about_partially_uninit_item (*item);
7198 : 55 : start_bit = item->get_next_bit_offset ();
7199 : 55 : continue;
7200 : : }
7201 : : else
7202 : : break;
7203 : : }
7204 : : }
7205 : :
7206 : 24 : if (start_bit >= next_bit)
7207 : : return;
7208 : :
7209 : 4 : if (start_bit % 8 == 0 && next_bit % 8 == 0)
7210 : : {
7211 : : /* Express in bytes. */
7212 : 4 : byte_offset_t start_byte = start_bit / 8;
7213 : 4 : byte_offset_t last_byte = (next_bit / 8) - 1;
7214 : 4 : if (last_byte == start_byte)
7215 : 0 : inform (loc,
7216 : : "byte %wu is uninitialized",
7217 : : start_byte.to_uhwi ());
7218 : : else
7219 : 4 : inform (loc,
7220 : : "bytes %wu - %wu are uninitialized",
7221 : : start_byte.to_uhwi (),
7222 : : last_byte.to_uhwi ());
7223 : : }
7224 : : else
7225 : : {
7226 : : /* Express in bits. */
7227 : 0 : bit_offset_t last_bit = next_bit - 1;
7228 : 0 : if (last_bit == start_bit)
7229 : 0 : inform (loc,
7230 : : "bit %wu is uninitialized",
7231 : : start_bit.to_uhwi ());
7232 : : else
7233 : 0 : inform (loc,
7234 : : "bits %wu - %wu are uninitialized",
7235 : : start_bit.to_uhwi (),
7236 : : last_bit.to_uhwi ());
7237 : : }
7238 : : }
7239 : :
7240 : : static void
7241 : 53 : complain_about_fully_uninit_item (const record_layout::item &item)
7242 : : {
7243 : 53 : tree field = item.m_field;
7244 : 53 : bit_size_t num_bits = item.m_bit_range.m_size_in_bits;
7245 : 53 : if (item.m_is_padding)
7246 : : {
7247 : 11 : if (num_bits % 8 == 0)
7248 : : {
7249 : : /* Express in bytes. */
7250 : 9 : byte_size_t num_bytes = num_bits / BITS_PER_UNIT;
7251 : 9 : if (num_bytes == 1)
7252 : 2 : inform (DECL_SOURCE_LOCATION (field),
7253 : : "padding after field %qD is uninitialized (1 byte)",
7254 : : field);
7255 : : else
7256 : 7 : inform (DECL_SOURCE_LOCATION (field),
7257 : : "padding after field %qD is uninitialized (%wu bytes)",
7258 : : field, num_bytes.to_uhwi ());
7259 : : }
7260 : : else
7261 : : {
7262 : : /* Express in bits. */
7263 : 2 : if (num_bits == 1)
7264 : 0 : inform (DECL_SOURCE_LOCATION (field),
7265 : : "padding after field %qD is uninitialized (1 bit)",
7266 : : field);
7267 : : else
7268 : 2 : inform (DECL_SOURCE_LOCATION (field),
7269 : : "padding after field %qD is uninitialized (%wu bits)",
7270 : : field, num_bits.to_uhwi ());
7271 : : }
7272 : : }
7273 : : else
7274 : : {
7275 : 42 : if (num_bits % 8 == 0)
7276 : : {
7277 : : /* Express in bytes. */
7278 : 32 : byte_size_t num_bytes = num_bits / BITS_PER_UNIT;
7279 : 32 : if (num_bytes == 1)
7280 : 1 : inform (DECL_SOURCE_LOCATION (field),
7281 : : "field %qD is uninitialized (1 byte)", field);
7282 : : else
7283 : 31 : inform (DECL_SOURCE_LOCATION (field),
7284 : : "field %qD is uninitialized (%wu bytes)",
7285 : : field, num_bytes.to_uhwi ());
7286 : : }
7287 : : else
7288 : : {
7289 : : /* Express in bits. */
7290 : 10 : if (num_bits == 1)
7291 : 9 : inform (DECL_SOURCE_LOCATION (field),
7292 : : "field %qD is uninitialized (1 bit)", field);
7293 : : else
7294 : 1 : inform (DECL_SOURCE_LOCATION (field),
7295 : : "field %qD is uninitialized (%wu bits)",
7296 : : field, num_bits.to_uhwi ());
7297 : : }
7298 : : }
7299 : 53 : }
7300 : :
7301 : : static void
7302 : 2 : complain_about_partially_uninit_item (const record_layout::item &item)
7303 : : {
7304 : 2 : tree field = item.m_field;
7305 : 2 : if (item.m_is_padding)
7306 : 0 : inform (DECL_SOURCE_LOCATION (field),
7307 : : "padding after field %qD is partially uninitialized",
7308 : : field);
7309 : : else
7310 : 2 : inform (DECL_SOURCE_LOCATION (field),
7311 : : "field %qD is partially uninitialized",
7312 : : field);
7313 : : /* TODO: ideally we'd describe what parts are uninitialized. */
7314 : 2 : }
7315 : :
7316 : 25 : void maybe_emit_fixit_hint () const
7317 : : {
7318 : 25 : if (tree decl = m_src_region->maybe_get_decl ())
7319 : : {
7320 : 25 : gcc_rich_location hint_richloc (DECL_SOURCE_LOCATION (decl));
7321 : 25 : hint_richloc.add_fixit_insert_after (" = {0}");
7322 : 25 : inform (&hint_richloc,
7323 : : "suggest forcing zero-initialization by"
7324 : : " providing a %<{0}%> initializer");
7325 : 25 : }
7326 : 25 : }
7327 : :
7328 : : private:
7329 : : const region *m_src_region;
7330 : : const region *m_dest_region;
7331 : : const svalue *m_copied_sval;
7332 : : };
7333 : :
7334 : : /* Return true if any part of SVAL is uninitialized. */
7335 : :
7336 : : static bool
7337 : 152 : contains_uninit_p (const svalue *sval)
7338 : : {
7339 : 152 : switch (sval->get_kind ())
7340 : : {
7341 : : default:
7342 : : return false;
7343 : 5 : case SK_POISONED:
7344 : 5 : {
7345 : 5 : const poisoned_svalue *psval
7346 : 5 : = as_a <const poisoned_svalue *> (sval);
7347 : 5 : return psval->get_poison_kind () == POISON_KIND_UNINIT;
7348 : : }
7349 : 84 : case SK_COMPOUND:
7350 : 84 : {
7351 : 84 : const compound_svalue *compound_sval
7352 : 84 : = as_a <const compound_svalue *> (sval);
7353 : :
7354 : 418 : for (auto iter : *compound_sval)
7355 : : {
7356 : 209 : const svalue *sval = iter.second;
7357 : 418 : if (const poisoned_svalue *psval
7358 : 209 : = sval->dyn_cast_poisoned_svalue ())
7359 : 42 : if (psval->get_poison_kind () == POISON_KIND_UNINIT)
7360 : 42 : return true;
7361 : : }
7362 : :
7363 : 42 : return false;
7364 : : }
7365 : : }
7366 : : }
7367 : :
7368 : : /* Function for use by plugins when simulating writing data through a
7369 : : pointer to an "untrusted" region DST_REG (and thus crossing a security
7370 : : boundary), such as copying data to user space in an OS kernel.
7371 : :
7372 : : Check that COPIED_SVAL is fully initialized. If not, complain about
7373 : : an infoleak to CTXT.
7374 : :
7375 : : SRC_REG can be NULL; if non-NULL it is used as a hint in the diagnostic
7376 : : as to where COPIED_SVAL came from. */
7377 : :
7378 : : void
7379 : 152 : region_model::maybe_complain_about_infoleak (const region *dst_reg,
7380 : : const svalue *copied_sval,
7381 : : const region *src_reg,
7382 : : region_model_context *ctxt)
7383 : : {
7384 : : /* Check for exposure. */
7385 : 152 : if (contains_uninit_p (copied_sval))
7386 : 47 : ctxt->warn (make_unique<exposure_through_uninit_copy> (src_reg,
7387 : : dst_reg,
7388 : : copied_sval));
7389 : 152 : }
7390 : :
7391 : : /* Set errno to a positive symbolic int, as if some error has occurred. */
7392 : :
7393 : : void
7394 : 455 : region_model::set_errno (const call_details &cd)
7395 : : {
7396 : 455 : const region *errno_reg = m_mgr->get_errno_region ();
7397 : 455 : conjured_purge p (this, cd.get_ctxt ());
7398 : 455 : const svalue *new_errno_sval
7399 : 455 : = m_mgr->get_or_create_conjured_svalue (integer_type_node,
7400 : 455 : cd.get_call_stmt (),
7401 : : errno_reg, p);
7402 : 455 : const svalue *zero
7403 : 455 : = m_mgr->get_or_create_int_cst (integer_type_node, 0);
7404 : 455 : add_constraint (new_errno_sval, GT_EXPR, zero, cd.get_ctxt ());
7405 : 455 : set_value (errno_reg, new_errno_sval, cd.get_ctxt ());
7406 : 455 : }
7407 : :
7408 : : /* class noop_region_model_context : public region_model_context. */
7409 : :
7410 : : void
7411 : 0 : noop_region_model_context::add_note (std::unique_ptr<pending_note>)
7412 : : {
7413 : 0 : }
7414 : :
7415 : : void
7416 : 0 : noop_region_model_context::add_event (std::unique_ptr<checker_event>)
7417 : : {
7418 : 0 : }
7419 : :
7420 : : void
7421 : 0 : noop_region_model_context::bifurcate (std::unique_ptr<custom_edge_info>)
7422 : : {
7423 : 0 : }
7424 : :
7425 : : void
7426 : 0 : noop_region_model_context::terminate_path ()
7427 : : {
7428 : 0 : }
7429 : :
7430 : : /* class region_model_context_decorator : public region_model_context. */
7431 : :
7432 : : void
7433 : 179 : region_model_context_decorator::add_event (std::unique_ptr<checker_event> event)
7434 : : {
7435 : 179 : if (m_inner)
7436 : 179 : m_inner->add_event (std::move (event));
7437 : 179 : }
7438 : :
7439 : : /* struct model_merger. */
7440 : :
7441 : : /* Dump a multiline representation of this merger to PP. */
7442 : :
7443 : : void
7444 : 0 : model_merger::dump_to_pp (pretty_printer *pp, bool simple) const
7445 : : {
7446 : 0 : pp_string (pp, "model A:");
7447 : 0 : pp_newline (pp);
7448 : 0 : m_model_a->dump_to_pp (pp, simple, true);
7449 : 0 : pp_newline (pp);
7450 : :
7451 : 0 : pp_string (pp, "model B:");
7452 : 0 : pp_newline (pp);
7453 : 0 : m_model_b->dump_to_pp (pp, simple, true);
7454 : 0 : pp_newline (pp);
7455 : :
7456 : 0 : pp_string (pp, "merged model:");
7457 : 0 : pp_newline (pp);
7458 : 0 : m_merged_model->dump_to_pp (pp, simple, true);
7459 : 0 : pp_newline (pp);
7460 : 0 : }
7461 : :
7462 : : /* Dump a multiline representation of this merger to FILE. */
7463 : :
7464 : : void
7465 : 0 : model_merger::dump (FILE *fp, bool simple) const
7466 : : {
7467 : 0 : tree_dump_pretty_printer pp (fp);
7468 : 0 : dump_to_pp (&pp, simple);
7469 : 0 : }
7470 : :
7471 : : /* Dump a multiline representation of this merger to stderr. */
7472 : :
7473 : : DEBUG_FUNCTION void
7474 : 0 : model_merger::dump (bool simple) const
7475 : : {
7476 : 0 : dump (stderr, simple);
7477 : 0 : }
7478 : :
7479 : : /* Return true if it's OK to merge SVAL with other svalues. */
7480 : :
7481 : : bool
7482 : 382278 : model_merger::mergeable_svalue_p (const svalue *sval) const
7483 : : {
7484 : 382278 : if (m_ext_state)
7485 : : {
7486 : : /* Reject merging svalues that have non-purgable sm-state,
7487 : : to avoid falsely reporting memory leaks by merging them
7488 : : with something else. For example, given a local var "p",
7489 : : reject the merger of a:
7490 : : store_a mapping "p" to a malloc-ed ptr
7491 : : with:
7492 : : store_b mapping "p" to a NULL ptr. */
7493 : 382230 : if (m_state_a)
7494 : 382230 : if (!m_state_a->can_purge_p (*m_ext_state, sval))
7495 : : return false;
7496 : 376747 : if (m_state_b)
7497 : 376747 : if (!m_state_b->can_purge_p (*m_ext_state, sval))
7498 : : return false;
7499 : : }
7500 : : return true;
7501 : : }
7502 : :
7503 : : /* Mark WIDENING_SVAL as changing meaning during the merge. */
7504 : :
7505 : : void
7506 : 1024 : model_merger::on_widening_reuse (const widening_svalue *widening_sval)
7507 : : {
7508 : 1024 : m_svals_changing_meaning.add (widening_sval);
7509 : 1024 : }
7510 : :
7511 : : } // namespace ana
7512 : :
7513 : : /* Dump RMODEL fully to stderr (i.e. without summarization). */
7514 : :
7515 : : DEBUG_FUNCTION void
7516 : 0 : debug (const region_model &rmodel)
7517 : : {
7518 : 0 : rmodel.dump (false);
7519 : 0 : }
7520 : :
7521 : : /* class rejected_op_constraint : public rejected_constraint. */
7522 : :
7523 : : void
7524 : 4 : rejected_op_constraint::dump_to_pp (pretty_printer *pp) const
7525 : : {
7526 : 4 : region_model m (m_model);
7527 : 4 : const svalue *lhs_sval = m.get_rvalue (m_lhs, NULL);
7528 : 4 : const svalue *rhs_sval = m.get_rvalue (m_rhs, NULL);
7529 : 4 : lhs_sval->dump_to_pp (pp, true);
7530 : 4 : pp_printf (pp, " %s ", op_symbol_code (m_op));
7531 : 4 : rhs_sval->dump_to_pp (pp, true);
7532 : 4 : }
7533 : :
7534 : : /* class rejected_default_case : public rejected_constraint. */
7535 : :
7536 : : void
7537 : 0 : rejected_default_case::dump_to_pp (pretty_printer *pp) const
7538 : : {
7539 : 0 : pp_string (pp, "implicit default for enum");
7540 : 0 : }
7541 : :
7542 : : /* class rejected_ranges_constraint : public rejected_constraint. */
7543 : :
7544 : : void
7545 : 0 : rejected_ranges_constraint::dump_to_pp (pretty_printer *pp) const
7546 : : {
7547 : 0 : region_model m (m_model);
7548 : 0 : const svalue *sval = m.get_rvalue (m_expr, NULL);
7549 : 0 : sval->dump_to_pp (pp, true);
7550 : 0 : pp_string (pp, " in ");
7551 : 0 : m_ranges->dump_to_pp (pp, true);
7552 : 0 : }
7553 : :
7554 : : /* class engine. */
7555 : :
7556 : : /* engine's ctor. */
7557 : :
7558 : 3219 : engine::engine (const supergraph *sg, logger *logger)
7559 : 3219 : : m_sg (sg), m_mgr (logger)
7560 : : {
7561 : 3219 : }
7562 : :
7563 : : /* Dump the managed objects by class to LOGGER, and the per-class totals. */
7564 : :
7565 : : void
7566 : 2 : engine::log_stats (logger *logger) const
7567 : : {
7568 : 2 : m_mgr.log_stats (logger, true);
7569 : 2 : }
7570 : :
7571 : : namespace ana {
7572 : :
7573 : : #if CHECKING_P
7574 : :
7575 : : namespace selftest {
7576 : :
7577 : : /* Build a constant tree of the given type from STR. */
7578 : :
7579 : : static tree
7580 : 64 : build_real_cst_from_string (tree type, const char *str)
7581 : : {
7582 : 64 : REAL_VALUE_TYPE real;
7583 : 64 : real_from_string (&real, str);
7584 : 64 : return build_real (type, real);
7585 : : }
7586 : :
7587 : : /* Append various "interesting" constants to OUT (e.g. NaN). */
7588 : :
7589 : : static void
7590 : 8 : append_interesting_constants (auto_vec<tree> *out)
7591 : : {
7592 : 8 : out->safe_push (integer_zero_node);
7593 : 8 : out->safe_push (build_int_cst (integer_type_node, 42));
7594 : 8 : out->safe_push (build_int_cst (unsigned_type_node, 0));
7595 : 8 : out->safe_push (build_int_cst (unsigned_type_node, 42));
7596 : 8 : out->safe_push (build_real_cst_from_string (float_type_node, "QNaN"));
7597 : 8 : out->safe_push (build_real_cst_from_string (float_type_node, "-QNaN"));
7598 : 8 : out->safe_push (build_real_cst_from_string (float_type_node, "SNaN"));
7599 : 8 : out->safe_push (build_real_cst_from_string (float_type_node, "-SNaN"));
7600 : 8 : out->safe_push (build_real_cst_from_string (float_type_node, "0.0"));
7601 : 8 : out->safe_push (build_real_cst_from_string (float_type_node, "-0.0"));
7602 : 8 : out->safe_push (build_real_cst_from_string (float_type_node, "Inf"));
7603 : 8 : out->safe_push (build_real_cst_from_string (float_type_node, "-Inf"));
7604 : 8 : }
7605 : :
7606 : : /* Verify that tree_cmp is a well-behaved comparator for qsort, even
7607 : : if the underlying constants aren't comparable. */
7608 : :
7609 : : static void
7610 : 4 : test_tree_cmp_on_constants ()
7611 : : {
7612 : 4 : auto_vec<tree> csts;
7613 : 4 : append_interesting_constants (&csts);
7614 : :
7615 : : /* Try sorting every triple. */
7616 : 4 : const unsigned num = csts.length ();
7617 : 52 : for (unsigned i = 0; i < num; i++)
7618 : 624 : for (unsigned j = 0; j < num; j++)
7619 : 7488 : for (unsigned k = 0; k < num; k++)
7620 : : {
7621 : 6912 : auto_vec<tree> v (3);
7622 : 6912 : v.quick_push (csts[i]);
7623 : 6912 : v.quick_push (csts[j]);
7624 : 6912 : v.quick_push (csts[k]);
7625 : 6912 : v.qsort (tree_cmp);
7626 : 6912 : }
7627 : 4 : }
7628 : :
7629 : : /* Implementation detail of the ASSERT_CONDITION_* macros. */
7630 : :
7631 : : void
7632 : 8 : assert_condition (const location &loc,
7633 : : region_model &model,
7634 : : const svalue *lhs, tree_code op, const svalue *rhs,
7635 : : tristate expected)
7636 : : {
7637 : 8 : tristate actual = model.eval_condition (lhs, op, rhs);
7638 : 8 : ASSERT_EQ_AT (loc, actual, expected);
7639 : 8 : }
7640 : :
7641 : : /* Implementation detail of the ASSERT_CONDITION_* macros. */
7642 : :
7643 : : void
7644 : 3084 : assert_condition (const location &loc,
7645 : : region_model &model,
7646 : : tree lhs, tree_code op, tree rhs,
7647 : : tristate expected)
7648 : : {
7649 : 3084 : tristate actual = model.eval_condition (lhs, op, rhs, NULL);
7650 : 3084 : ASSERT_EQ_AT (loc, actual, expected);
7651 : 3084 : }
7652 : :
7653 : : /* Implementation detail of ASSERT_DUMP_TREE_EQ. */
7654 : :
7655 : : static void
7656 : 20 : assert_dump_tree_eq (const location &loc, tree t, const char *expected)
7657 : : {
7658 : 20 : auto_fix_quotes sentinel;
7659 : 20 : pretty_printer pp;
7660 : 20 : pp_format_decoder (&pp) = default_tree_printer;
7661 : 20 : dump_tree (&pp, t);
7662 : 20 : ASSERT_STREQ_AT (loc, pp_formatted_text (&pp), expected);
7663 : 20 : }
7664 : :
7665 : : /* Assert that dump_tree (T) is EXPECTED. */
7666 : :
7667 : : #define ASSERT_DUMP_TREE_EQ(T, EXPECTED) \
7668 : : SELFTEST_BEGIN_STMT \
7669 : : assert_dump_tree_eq ((SELFTEST_LOCATION), (T), (EXPECTED)); \
7670 : : SELFTEST_END_STMT
7671 : :
7672 : : /* Implementation detail of ASSERT_DUMP_EQ. */
7673 : :
7674 : : static void
7675 : 8 : assert_dump_eq (const location &loc,
7676 : : const region_model &model,
7677 : : bool summarize,
7678 : : const char *expected)
7679 : : {
7680 : 8 : auto_fix_quotes sentinel;
7681 : 8 : pretty_printer pp;
7682 : 8 : pp_format_decoder (&pp) = default_tree_printer;
7683 : :
7684 : 8 : model.dump_to_pp (&pp, summarize, true);
7685 : 8 : ASSERT_STREQ_AT (loc, pp_formatted_text (&pp), expected);
7686 : 8 : }
7687 : :
7688 : : /* Assert that MODEL.dump_to_pp (SUMMARIZE) is EXPECTED. */
7689 : :
7690 : : #define ASSERT_DUMP_EQ(MODEL, SUMMARIZE, EXPECTED) \
7691 : : SELFTEST_BEGIN_STMT \
7692 : : assert_dump_eq ((SELFTEST_LOCATION), (MODEL), (SUMMARIZE), (EXPECTED)); \
7693 : : SELFTEST_END_STMT
7694 : :
7695 : : /* Smoketest for region_model::dump_to_pp. */
7696 : :
7697 : : static void
7698 : 4 : test_dump ()
7699 : : {
7700 : 4 : region_model_manager mgr;
7701 : 4 : region_model model (&mgr);
7702 : :
7703 : 4 : ASSERT_DUMP_EQ (model, false,
7704 : : "stack depth: 0\n"
7705 : : "m_called_unknown_fn: FALSE\n"
7706 : : "constraint_manager:\n"
7707 : : " equiv classes:\n"
7708 : : " constraints:\n");
7709 : 4 : ASSERT_DUMP_EQ (model, true,
7710 : : "stack depth: 0\n"
7711 : : "m_called_unknown_fn: FALSE\n"
7712 : : "constraint_manager:\n"
7713 : : " equiv classes:\n"
7714 : : " constraints:\n");
7715 : :
7716 : 4 : text_art::ascii_theme theme;
7717 : 4 : pretty_printer pp;
7718 : 4 : dump_to_pp (model, &theme, &pp);
7719 : 4 : ASSERT_STREQ ("Region Model\n"
7720 : : "`- Store\n"
7721 : : " `- m_called_unknown_fn: false\n",
7722 : : pp_formatted_text (&pp));
7723 : 4 : }
7724 : :
7725 : : /* Helper function for selftests. Create a struct or union type named NAME,
7726 : : with the fields given by the FIELD_DECLS in FIELDS.
7727 : : If IS_STRUCT is true create a RECORD_TYPE (aka a struct), otherwise
7728 : : create a UNION_TYPE. */
7729 : :
7730 : : static tree
7731 : 16 : make_test_compound_type (const char *name, bool is_struct,
7732 : : const auto_vec<tree> *fields)
7733 : : {
7734 : 16 : tree t = make_node (is_struct ? RECORD_TYPE : UNION_TYPE);
7735 : 16 : TYPE_NAME (t) = get_identifier (name);
7736 : 16 : TYPE_SIZE (t) = 0;
7737 : :
7738 : 16 : tree fieldlist = NULL;
7739 : 16 : int i;
7740 : 16 : tree field;
7741 : 48 : FOR_EACH_VEC_ELT (*fields, i, field)
7742 : : {
7743 : 32 : gcc_assert (TREE_CODE (field) == FIELD_DECL);
7744 : 32 : DECL_CONTEXT (field) = t;
7745 : 32 : fieldlist = chainon (field, fieldlist);
7746 : : }
7747 : 16 : fieldlist = nreverse (fieldlist);
7748 : 16 : TYPE_FIELDS (t) = fieldlist;
7749 : :
7750 : 16 : layout_type (t);
7751 : 16 : return t;
7752 : : }
7753 : :
7754 : : /* Selftest fixture for creating the type "struct coord {int x; int y; };". */
7755 : :
7756 : : struct coord_test
7757 : : {
7758 : 16 : coord_test ()
7759 : 16 : {
7760 : 16 : auto_vec<tree> fields;
7761 : 16 : m_x_field = build_decl (UNKNOWN_LOCATION, FIELD_DECL,
7762 : : get_identifier ("x"), integer_type_node);
7763 : 16 : fields.safe_push (m_x_field);
7764 : 16 : m_y_field = build_decl (UNKNOWN_LOCATION, FIELD_DECL,
7765 : : get_identifier ("y"), integer_type_node);
7766 : 16 : fields.safe_push (m_y_field);
7767 : 16 : m_coord_type = make_test_compound_type ("coord", true, &fields);
7768 : 16 : }
7769 : :
7770 : : tree m_x_field;
7771 : : tree m_y_field;
7772 : : tree m_coord_type;
7773 : : };
7774 : :
7775 : : /* Verify usage of a struct. */
7776 : :
7777 : : static void
7778 : 4 : test_struct ()
7779 : : {
7780 : 4 : coord_test ct;
7781 : :
7782 : 4 : tree c = build_global_decl ("c", ct.m_coord_type);
7783 : 4 : tree c_x = build3 (COMPONENT_REF, TREE_TYPE (ct.m_x_field),
7784 : : c, ct.m_x_field, NULL_TREE);
7785 : 4 : tree c_y = build3 (COMPONENT_REF, TREE_TYPE (ct.m_y_field),
7786 : : c, ct.m_y_field, NULL_TREE);
7787 : :
7788 : 4 : tree int_17 = build_int_cst (integer_type_node, 17);
7789 : 4 : tree int_m3 = build_int_cst (integer_type_node, -3);
7790 : :
7791 : 4 : region_model_manager mgr;
7792 : 4 : region_model model (&mgr);
7793 : 4 : model.set_value (c_x, int_17, NULL);
7794 : 4 : model.set_value (c_y, int_m3, NULL);
7795 : :
7796 : : /* Verify get_offset for "c.x". */
7797 : 4 : {
7798 : 4 : const region *c_x_reg = model.get_lvalue (c_x, NULL);
7799 : 4 : region_offset offset = c_x_reg->get_offset (&mgr);
7800 : 4 : ASSERT_EQ (offset.get_base_region (), model.get_lvalue (c, NULL));
7801 : 4 : ASSERT_EQ (offset.get_bit_offset (), 0);
7802 : : }
7803 : :
7804 : : /* Verify get_offset for "c.y". */
7805 : 4 : {
7806 : 4 : const region *c_y_reg = model.get_lvalue (c_y, NULL);
7807 : 4 : region_offset offset = c_y_reg->get_offset (&mgr);
7808 : 4 : ASSERT_EQ (offset.get_base_region (), model.get_lvalue (c, NULL));
7809 : 4 : ASSERT_EQ (offset.get_bit_offset (), INT_TYPE_SIZE);
7810 : : }
7811 : 4 : }
7812 : :
7813 : : /* Verify usage of an array element. */
7814 : :
7815 : : static void
7816 : 4 : test_array_1 ()
7817 : : {
7818 : 4 : tree tlen = size_int (10);
7819 : 4 : tree arr_type = build_array_type (char_type_node, build_index_type (tlen));
7820 : :
7821 : 4 : tree a = build_global_decl ("a", arr_type);
7822 : :
7823 : 4 : region_model_manager mgr;
7824 : 4 : region_model model (&mgr);
7825 : 4 : tree int_0 = integer_zero_node;
7826 : 4 : tree a_0 = build4 (ARRAY_REF, char_type_node,
7827 : : a, int_0, NULL_TREE, NULL_TREE);
7828 : 4 : tree char_A = build_int_cst (char_type_node, 'A');
7829 : 4 : model.set_value (a_0, char_A, NULL);
7830 : 4 : }
7831 : :
7832 : : /* Verify that region_model::get_representative_tree works as expected. */
7833 : :
7834 : : static void
7835 : 4 : test_get_representative_tree ()
7836 : : {
7837 : 4 : region_model_manager mgr;
7838 : :
7839 : : /* STRING_CST. */
7840 : 4 : {
7841 : 4 : tree string_cst = build_string (4, "foo");
7842 : 4 : region_model m (&mgr);
7843 : 4 : const svalue *str_sval = m.get_rvalue (string_cst, NULL);
7844 : 4 : tree rep = m.get_representative_tree (str_sval);
7845 : 4 : ASSERT_EQ (rep, string_cst);
7846 : 4 : }
7847 : :
7848 : : /* String literal. */
7849 : 4 : {
7850 : 4 : tree string_cst_ptr = build_string_literal (4, "foo");
7851 : 4 : region_model m (&mgr);
7852 : 4 : const svalue *str_sval = m.get_rvalue (string_cst_ptr, NULL);
7853 : 4 : tree rep = m.get_representative_tree (str_sval);
7854 : 4 : ASSERT_DUMP_TREE_EQ (rep, "&\"foo\"[0]");
7855 : 4 : }
7856 : :
7857 : : /* Value of an element within an array. */
7858 : 4 : {
7859 : 4 : tree tlen = size_int (10);
7860 : 4 : tree arr_type = build_array_type (char_type_node, build_index_type (tlen));
7861 : 4 : tree a = build_global_decl ("a", arr_type);
7862 : 4 : placeholder_svalue test_sval (mgr.alloc_symbol_id (),
7863 : 4 : char_type_node, "test value");
7864 : :
7865 : : /* Value of a[3]. */
7866 : 4 : {
7867 : 4 : test_region_model_context ctxt;
7868 : 4 : region_model model (&mgr);
7869 : 4 : tree int_3 = build_int_cst (integer_type_node, 3);
7870 : 4 : tree a_3 = build4 (ARRAY_REF, char_type_node,
7871 : : a, int_3, NULL_TREE, NULL_TREE);
7872 : 4 : const region *a_3_reg = model.get_lvalue (a_3, &ctxt);
7873 : 4 : model.set_value (a_3_reg, &test_sval, &ctxt);
7874 : 4 : tree rep = model.get_representative_tree (&test_sval);
7875 : 4 : ASSERT_DUMP_TREE_EQ (rep, "a[3]");
7876 : 4 : }
7877 : :
7878 : : /* Value of a[0]. */
7879 : 4 : {
7880 : 4 : test_region_model_context ctxt;
7881 : 4 : region_model model (&mgr);
7882 : 4 : tree idx = integer_zero_node;
7883 : 4 : tree a_0 = build4 (ARRAY_REF, char_type_node,
7884 : : a, idx, NULL_TREE, NULL_TREE);
7885 : 4 : const region *a_0_reg = model.get_lvalue (a_0, &ctxt);
7886 : 4 : model.set_value (a_0_reg, &test_sval, &ctxt);
7887 : 4 : tree rep = model.get_representative_tree (&test_sval);
7888 : 4 : ASSERT_DUMP_TREE_EQ (rep, "a[0]");
7889 : 4 : }
7890 : 4 : }
7891 : :
7892 : : /* Value of a field within a struct. */
7893 : 4 : {
7894 : 4 : coord_test ct;
7895 : :
7896 : 4 : tree c = build_global_decl ("c", ct.m_coord_type);
7897 : 4 : tree c_x = build3 (COMPONENT_REF, TREE_TYPE (ct.m_x_field),
7898 : : c, ct.m_x_field, NULL_TREE);
7899 : 4 : tree c_y = build3 (COMPONENT_REF, TREE_TYPE (ct.m_y_field),
7900 : : c, ct.m_y_field, NULL_TREE);
7901 : :
7902 : 4 : test_region_model_context ctxt;
7903 : :
7904 : : /* Value of initial field. */
7905 : 4 : {
7906 : 4 : region_model m (&mgr);
7907 : 4 : const region *c_x_reg = m.get_lvalue (c_x, &ctxt);
7908 : 4 : placeholder_svalue test_sval_x (mgr.alloc_symbol_id (),
7909 : 4 : integer_type_node, "test x val");
7910 : 4 : m.set_value (c_x_reg, &test_sval_x, &ctxt);
7911 : 4 : tree rep = m.get_representative_tree (&test_sval_x);
7912 : 4 : ASSERT_DUMP_TREE_EQ (rep, "c.x");
7913 : 4 : }
7914 : :
7915 : : /* Value of non-initial field. */
7916 : 4 : {
7917 : 4 : region_model m (&mgr);
7918 : 4 : const region *c_y_reg = m.get_lvalue (c_y, &ctxt);
7919 : 4 : placeholder_svalue test_sval_y (mgr.alloc_symbol_id (),
7920 : 4 : integer_type_node, "test y val");
7921 : 4 : m.set_value (c_y_reg, &test_sval_y, &ctxt);
7922 : 4 : tree rep = m.get_representative_tree (&test_sval_y);
7923 : 4 : ASSERT_DUMP_TREE_EQ (rep, "c.y");
7924 : 4 : }
7925 : 4 : }
7926 : 4 : }
7927 : :
7928 : : /* Verify that calling region_model::get_rvalue repeatedly on the same
7929 : : tree constant retrieves the same svalue *. */
7930 : :
7931 : : static void
7932 : 4 : test_unique_constants ()
7933 : : {
7934 : 4 : tree int_0 = integer_zero_node;
7935 : 4 : tree int_42 = build_int_cst (integer_type_node, 42);
7936 : :
7937 : 4 : test_region_model_context ctxt;
7938 : 4 : region_model_manager mgr;
7939 : 4 : region_model model (&mgr);
7940 : 4 : ASSERT_EQ (model.get_rvalue (int_0, &ctxt), model.get_rvalue (int_0, &ctxt));
7941 : 4 : ASSERT_EQ (model.get_rvalue (int_42, &ctxt),
7942 : : model.get_rvalue (int_42, &ctxt));
7943 : 4 : ASSERT_NE (model.get_rvalue (int_0, &ctxt), model.get_rvalue (int_42, &ctxt));
7944 : 4 : ASSERT_EQ (ctxt.get_num_diagnostics (), 0);
7945 : :
7946 : : /* A "(const int)42" will be a different tree from "(int)42)"... */
7947 : 4 : tree const_int_type_node
7948 : 4 : = build_qualified_type (integer_type_node, TYPE_QUAL_CONST);
7949 : 4 : tree const_int_42 = build_int_cst (const_int_type_node, 42);
7950 : 4 : ASSERT_NE (int_42, const_int_42);
7951 : : /* It should have a different const_svalue. */
7952 : 4 : const svalue *int_42_sval = model.get_rvalue (int_42, &ctxt);
7953 : 4 : const svalue *const_int_42_sval = model.get_rvalue (const_int_42, &ctxt);
7954 : 4 : ASSERT_NE (int_42_sval, const_int_42_sval);
7955 : : /* But they should compare as equal. */
7956 : 4 : ASSERT_CONDITION_TRUE (model, int_42_sval, EQ_EXPR, const_int_42_sval);
7957 : 4 : ASSERT_CONDITION_FALSE (model, int_42_sval, NE_EXPR, const_int_42_sval);
7958 : 4 : }
7959 : :
7960 : : /* Verify that each type gets its own singleton unknown_svalue within a
7961 : : region_model_manager, and that NULL_TREE gets its own singleton. */
7962 : :
7963 : : static void
7964 : 4 : test_unique_unknowns ()
7965 : : {
7966 : 4 : region_model_manager mgr;
7967 : 4 : const svalue *unknown_int
7968 : 4 : = mgr.get_or_create_unknown_svalue (integer_type_node);
7969 : : /* Repeated calls with the same type should get the same "unknown"
7970 : : svalue. */
7971 : 4 : const svalue *unknown_int_2
7972 : 4 : = mgr.get_or_create_unknown_svalue (integer_type_node);
7973 : 4 : ASSERT_EQ (unknown_int, unknown_int_2);
7974 : :
7975 : : /* Different types (or the NULL type) should have different
7976 : : unknown_svalues. */
7977 : 4 : const svalue *unknown_NULL_type = mgr.get_or_create_unknown_svalue (NULL);
7978 : 4 : ASSERT_NE (unknown_NULL_type, unknown_int);
7979 : :
7980 : : /* Repeated calls with NULL for the type should get the same "unknown"
7981 : : svalue. */
7982 : 4 : const svalue *unknown_NULL_type_2 = mgr.get_or_create_unknown_svalue (NULL);
7983 : 4 : ASSERT_EQ (unknown_NULL_type, unknown_NULL_type_2);
7984 : 4 : }
7985 : :
7986 : : /* Verify that initial_svalue are handled as expected. */
7987 : :
7988 : : static void
7989 : 4 : test_initial_svalue_folding ()
7990 : : {
7991 : 4 : region_model_manager mgr;
7992 : 4 : tree x = build_global_decl ("x", integer_type_node);
7993 : 4 : tree y = build_global_decl ("y", integer_type_node);
7994 : :
7995 : 4 : test_region_model_context ctxt;
7996 : 4 : region_model model (&mgr);
7997 : 4 : const svalue *x_init = model.get_rvalue (x, &ctxt);
7998 : 4 : const svalue *y_init = model.get_rvalue (y, &ctxt);
7999 : 4 : ASSERT_NE (x_init, y_init);
8000 : 4 : const region *x_reg = model.get_lvalue (x, &ctxt);
8001 : 4 : ASSERT_EQ (x_init, mgr.get_or_create_initial_value (x_reg));
8002 : :
8003 : 4 : }
8004 : :
8005 : : /* Verify that unary ops are folded as expected. */
8006 : :
8007 : : static void
8008 : 4 : test_unaryop_svalue_folding ()
8009 : : {
8010 : 4 : region_model_manager mgr;
8011 : 4 : tree x = build_global_decl ("x", integer_type_node);
8012 : 4 : tree y = build_global_decl ("y", integer_type_node);
8013 : :
8014 : 4 : test_region_model_context ctxt;
8015 : 4 : region_model model (&mgr);
8016 : 4 : const svalue *x_init = model.get_rvalue (x, &ctxt);
8017 : 4 : const svalue *y_init = model.get_rvalue (y, &ctxt);
8018 : 4 : const region *x_reg = model.get_lvalue (x, &ctxt);
8019 : 4 : ASSERT_EQ (x_init, mgr.get_or_create_initial_value (x_reg));
8020 : :
8021 : : /* "(int)x" -> "x". */
8022 : 4 : ASSERT_EQ (x_init, mgr.get_or_create_cast (integer_type_node, x_init));
8023 : :
8024 : : /* "(void *)x" -> something other than "x". */
8025 : 4 : ASSERT_NE (x_init, mgr.get_or_create_cast (ptr_type_node, x_init));
8026 : :
8027 : : /* "!(x == y)" -> "x != y". */
8028 : 4 : ASSERT_EQ (mgr.get_or_create_unaryop
8029 : : (boolean_type_node, TRUTH_NOT_EXPR,
8030 : : mgr.get_or_create_binop (boolean_type_node, EQ_EXPR,
8031 : : x_init, y_init)),
8032 : : mgr.get_or_create_binop (boolean_type_node, NE_EXPR,
8033 : : x_init, y_init));
8034 : : /* "!(x > y)" -> "x <= y". */
8035 : 4 : ASSERT_EQ (mgr.get_or_create_unaryop
8036 : : (boolean_type_node, TRUTH_NOT_EXPR,
8037 : : mgr.get_or_create_binop (boolean_type_node, GT_EXPR,
8038 : : x_init, y_init)),
8039 : : mgr.get_or_create_binop (boolean_type_node, LE_EXPR,
8040 : : x_init, y_init));
8041 : 4 : }
8042 : :
8043 : : /* Verify that binops on constant svalues are folded. */
8044 : :
8045 : : static void
8046 : 4 : test_binop_svalue_folding ()
8047 : : {
8048 : : #define NUM_CSTS 10
8049 : 4 : tree cst_int[NUM_CSTS];
8050 : 4 : region_model_manager mgr;
8051 : 4 : const svalue *cst_sval[NUM_CSTS];
8052 : 44 : for (int i = 0; i < NUM_CSTS; i++)
8053 : : {
8054 : 40 : cst_int[i] = build_int_cst (integer_type_node, i);
8055 : 40 : cst_sval[i] = mgr.get_or_create_constant_svalue (cst_int[i]);
8056 : 40 : ASSERT_EQ (cst_sval[i]->get_kind (), SK_CONSTANT);
8057 : 40 : ASSERT_EQ (cst_sval[i]->maybe_get_constant (), cst_int[i]);
8058 : : }
8059 : :
8060 : 44 : for (int i = 0; i < NUM_CSTS; i++)
8061 : 440 : for (int j = 0; j < NUM_CSTS; j++)
8062 : : {
8063 : 400 : if (i != j)
8064 : 360 : ASSERT_NE (cst_sval[i], cst_sval[j]);
8065 : 400 : if (i + j < NUM_CSTS)
8066 : : {
8067 : 220 : const svalue *sum
8068 : 220 : = mgr.get_or_create_binop (integer_type_node, PLUS_EXPR,
8069 : : cst_sval[i], cst_sval[j]);
8070 : 220 : ASSERT_EQ (sum, cst_sval[i + j]);
8071 : : }
8072 : 400 : if (i - j >= 0)
8073 : : {
8074 : 220 : const svalue *difference
8075 : 220 : = mgr.get_or_create_binop (integer_type_node, MINUS_EXPR,
8076 : : cst_sval[i], cst_sval[j]);
8077 : 220 : ASSERT_EQ (difference, cst_sval[i - j]);
8078 : : }
8079 : 400 : if (i * j < NUM_CSTS)
8080 : : {
8081 : 168 : const svalue *product
8082 : 168 : = mgr.get_or_create_binop (integer_type_node, MULT_EXPR,
8083 : : cst_sval[i], cst_sval[j]);
8084 : 168 : ASSERT_EQ (product, cst_sval[i * j]);
8085 : : }
8086 : 400 : const svalue *eq = mgr.get_or_create_binop (integer_type_node, EQ_EXPR,
8087 : : cst_sval[i], cst_sval[j]);
8088 : 400 : ASSERT_EQ (eq, i == j ? cst_sval[1] : cst_sval [0]);
8089 : 400 : const svalue *neq = mgr.get_or_create_binop (integer_type_node, NE_EXPR,
8090 : : cst_sval[i], cst_sval[j]);
8091 : 400 : ASSERT_EQ (neq, i != j ? cst_sval[1] : cst_sval [0]);
8092 : : // etc
8093 : : }
8094 : :
8095 : 4 : tree x = build_global_decl ("x", integer_type_node);
8096 : :
8097 : 4 : test_region_model_context ctxt;
8098 : 4 : region_model model (&mgr);
8099 : 4 : const svalue *x_init = model.get_rvalue (x, &ctxt);
8100 : :
8101 : : /* PLUS_EXPR folding. */
8102 : 4 : const svalue *x_init_plus_zero
8103 : 4 : = mgr.get_or_create_binop (integer_type_node, PLUS_EXPR,
8104 : : x_init, cst_sval[0]);
8105 : 4 : ASSERT_EQ (x_init_plus_zero, x_init);
8106 : 4 : const svalue *zero_plus_x_init
8107 : 4 : = mgr.get_or_create_binop (integer_type_node, PLUS_EXPR,
8108 : : cst_sval[0], x_init);
8109 : 4 : ASSERT_EQ (zero_plus_x_init, x_init);
8110 : :
8111 : : /* MULT_EXPR folding. */
8112 : 4 : const svalue *x_init_times_zero
8113 : 4 : = mgr.get_or_create_binop (integer_type_node, MULT_EXPR,
8114 : : x_init, cst_sval[0]);
8115 : 4 : ASSERT_EQ (x_init_times_zero, cst_sval[0]);
8116 : 4 : const svalue *zero_times_x_init
8117 : 4 : = mgr.get_or_create_binop (integer_type_node, MULT_EXPR,
8118 : : cst_sval[0], x_init);
8119 : 4 : ASSERT_EQ (zero_times_x_init, cst_sval[0]);
8120 : :
8121 : 4 : const svalue *x_init_times_one
8122 : 4 : = mgr.get_or_create_binop (integer_type_node, MULT_EXPR,
8123 : : x_init, cst_sval[1]);
8124 : 4 : ASSERT_EQ (x_init_times_one, x_init);
8125 : 4 : const svalue *one_times_x_init
8126 : 4 : = mgr.get_or_create_binop (integer_type_node, MULT_EXPR,
8127 : : cst_sval[1], x_init);
8128 : 4 : ASSERT_EQ (one_times_x_init, x_init);
8129 : :
8130 : : // etc
8131 : : // TODO: do we want to use the match-and-simplify DSL for this?
8132 : :
8133 : : /* Verify that binops put any constants on the RHS. */
8134 : 4 : const svalue *four_times_x_init
8135 : 4 : = mgr.get_or_create_binop (integer_type_node, MULT_EXPR,
8136 : : cst_sval[4], x_init);
8137 : 4 : const svalue *x_init_times_four
8138 : 4 : = mgr.get_or_create_binop (integer_type_node, MULT_EXPR,
8139 : : x_init, cst_sval[4]);
8140 : 4 : ASSERT_EQ (four_times_x_init, x_init_times_four);
8141 : 4 : const binop_svalue *binop = four_times_x_init->dyn_cast_binop_svalue ();
8142 : 4 : ASSERT_EQ (binop->get_op (), MULT_EXPR);
8143 : 4 : ASSERT_EQ (binop->get_arg0 (), x_init);
8144 : 4 : ASSERT_EQ (binop->get_arg1 (), cst_sval[4]);
8145 : :
8146 : : /* Verify that ((x + 1) + 1) == (x + 2). */
8147 : 4 : const svalue *x_init_plus_one
8148 : 4 : = mgr.get_or_create_binop (integer_type_node, PLUS_EXPR,
8149 : : x_init, cst_sval[1]);
8150 : 4 : const svalue *x_init_plus_two
8151 : 4 : = mgr.get_or_create_binop (integer_type_node, PLUS_EXPR,
8152 : : x_init, cst_sval[2]);
8153 : 4 : const svalue *x_init_plus_one_plus_one
8154 : 4 : = mgr.get_or_create_binop (integer_type_node, PLUS_EXPR,
8155 : : x_init_plus_one, cst_sval[1]);
8156 : 4 : ASSERT_EQ (x_init_plus_one_plus_one, x_init_plus_two);
8157 : :
8158 : : /* Verify various binops on booleans. */
8159 : 4 : {
8160 : 4 : const svalue *sval_true = mgr.get_or_create_int_cst (boolean_type_node, 1);
8161 : 4 : const svalue *sval_false = mgr.get_or_create_int_cst (boolean_type_node, 0);
8162 : 4 : const svalue *sval_unknown
8163 : 4 : = mgr.get_or_create_unknown_svalue (boolean_type_node);
8164 : 4 : const placeholder_svalue sval_placeholder (mgr.alloc_symbol_id (),
8165 : 4 : boolean_type_node, "v");
8166 : 12 : for (auto op : {BIT_IOR_EXPR, TRUTH_OR_EXPR})
8167 : : {
8168 : 8 : ASSERT_EQ (mgr.get_or_create_binop (boolean_type_node, op,
8169 : : sval_true, sval_unknown),
8170 : : sval_true);
8171 : 8 : ASSERT_EQ (mgr.get_or_create_binop (boolean_type_node, op,
8172 : : sval_false, sval_unknown),
8173 : : sval_unknown);
8174 : 8 : ASSERT_EQ (mgr.get_or_create_binop (boolean_type_node, op,
8175 : : sval_false, &sval_placeholder),
8176 : : &sval_placeholder);
8177 : : }
8178 : 12 : for (auto op : {BIT_AND_EXPR, TRUTH_AND_EXPR})
8179 : : {
8180 : 8 : ASSERT_EQ (mgr.get_or_create_binop (boolean_type_node, op,
8181 : : sval_false, sval_unknown),
8182 : : sval_false);
8183 : 8 : ASSERT_EQ (mgr.get_or_create_binop (boolean_type_node, op,
8184 : : sval_true, sval_unknown),
8185 : : sval_unknown);
8186 : 8 : ASSERT_EQ (mgr.get_or_create_binop (boolean_type_node, op,
8187 : : sval_true, &sval_placeholder),
8188 : : &sval_placeholder);
8189 : : }
8190 : 4 : }
8191 : 4 : }
8192 : :
8193 : : /* Verify that sub_svalues are folded as expected. */
8194 : :
8195 : : static void
8196 : 4 : test_sub_svalue_folding ()
8197 : : {
8198 : 4 : coord_test ct;
8199 : 4 : tree c = build_global_decl ("c", ct.m_coord_type);
8200 : 4 : tree c_x = build3 (COMPONENT_REF, TREE_TYPE (ct.m_x_field),
8201 : : c, ct.m_x_field, NULL_TREE);
8202 : :
8203 : 4 : region_model_manager mgr;
8204 : 4 : region_model model (&mgr);
8205 : 4 : test_region_model_context ctxt;
8206 : 4 : const region *c_x_reg = model.get_lvalue (c_x, &ctxt);
8207 : :
8208 : : /* Verify that sub_svalue of "unknown" simply
8209 : : yields an unknown. */
8210 : :
8211 : 4 : const svalue *unknown = mgr.get_or_create_unknown_svalue (ct.m_coord_type);
8212 : 4 : const svalue *sub = mgr.get_or_create_sub_svalue (TREE_TYPE (ct.m_x_field),
8213 : : unknown, c_x_reg);
8214 : 4 : ASSERT_EQ (sub->get_kind (), SK_UNKNOWN);
8215 : 4 : ASSERT_EQ (sub->get_type (), TREE_TYPE (ct.m_x_field));
8216 : 4 : }
8217 : :
8218 : : /* Get BIT within VAL as a symbolic value within MGR. */
8219 : :
8220 : : static const svalue *
8221 : 256 : get_bit (region_model_manager *mgr,
8222 : : bit_offset_t bit,
8223 : : unsigned HOST_WIDE_INT val)
8224 : : {
8225 : 256 : const svalue *inner_svalue
8226 : 256 : = mgr->get_or_create_int_cst (unsigned_type_node, val);
8227 : 256 : return mgr->get_or_create_bits_within (boolean_type_node,
8228 : 256 : bit_range (bit, 1),
8229 : 256 : inner_svalue);
8230 : : }
8231 : :
8232 : : /* Verify that bits_within_svalues are folded as expected. */
8233 : :
8234 : : static void
8235 : 4 : test_bits_within_svalue_folding ()
8236 : : {
8237 : 4 : region_model_manager mgr;
8238 : :
8239 : 4 : const svalue *zero = mgr.get_or_create_int_cst (boolean_type_node, 0);
8240 : 4 : const svalue *one = mgr.get_or_create_int_cst (boolean_type_node, 1);
8241 : :
8242 : 4 : {
8243 : 4 : const unsigned val = 0x0000;
8244 : 68 : for (unsigned bit = 0; bit < 16; bit++)
8245 : 64 : ASSERT_EQ (get_bit (&mgr, bit, val), zero);
8246 : : }
8247 : :
8248 : 4 : {
8249 : 4 : const unsigned val = 0x0001;
8250 : 4 : ASSERT_EQ (get_bit (&mgr, 0, val), one);
8251 : 64 : for (unsigned bit = 1; bit < 16; bit++)
8252 : 60 : ASSERT_EQ (get_bit (&mgr, bit, val), zero);
8253 : : }
8254 : :
8255 : 4 : {
8256 : 4 : const unsigned val = 0x8000;
8257 : 64 : for (unsigned bit = 0; bit < 15; bit++)
8258 : 60 : ASSERT_EQ (get_bit (&mgr, bit, val), zero);
8259 : 4 : ASSERT_EQ (get_bit (&mgr, 15, val), one);
8260 : : }
8261 : :
8262 : 4 : {
8263 : 4 : const unsigned val = 0xFFFF;
8264 : 68 : for (unsigned bit = 0; bit < 16; bit++)
8265 : 64 : ASSERT_EQ (get_bit (&mgr, bit, val), one);
8266 : : }
8267 : 4 : }
8268 : :
8269 : : /* Test that region::descendent_of_p works as expected. */
8270 : :
8271 : : static void
8272 : 4 : test_descendent_of_p ()
8273 : : {
8274 : 4 : region_model_manager mgr;
8275 : 4 : const region *stack = mgr.get_stack_region ();
8276 : 4 : const region *heap = mgr.get_heap_region ();
8277 : 4 : const region *code = mgr.get_code_region ();
8278 : 4 : const region *globals = mgr.get_globals_region ();
8279 : :
8280 : : /* descendent_of_p should return true when used on the region itself. */
8281 : 4 : ASSERT_TRUE (stack->descendent_of_p (stack));
8282 : 4 : ASSERT_FALSE (stack->descendent_of_p (heap));
8283 : 4 : ASSERT_FALSE (stack->descendent_of_p (code));
8284 : 4 : ASSERT_FALSE (stack->descendent_of_p (globals));
8285 : :
8286 : 4 : tree x = build_global_decl ("x", integer_type_node);
8287 : 4 : const region *x_reg = mgr.get_region_for_global (x);
8288 : 4 : ASSERT_TRUE (x_reg->descendent_of_p (globals));
8289 : :
8290 : : /* A cast_region should be a descendent of the original region. */
8291 : 4 : const region *cast_reg = mgr.get_cast_region (x_reg, ptr_type_node);
8292 : 4 : ASSERT_TRUE (cast_reg->descendent_of_p (x_reg));
8293 : 4 : }
8294 : :
8295 : : /* Verify that bit_range_region works as expected. */
8296 : :
8297 : : static void
8298 : 4 : test_bit_range_regions ()
8299 : : {
8300 : 4 : tree x = build_global_decl ("x", integer_type_node);
8301 : 4 : region_model_manager mgr;
8302 : 4 : const region *x_reg = mgr.get_region_for_global (x);
8303 : 4 : const region *byte0
8304 : 4 : = mgr.get_bit_range (x_reg, char_type_node, bit_range (0, 8));
8305 : 4 : const region *byte1
8306 : 4 : = mgr.get_bit_range (x_reg, char_type_node, bit_range (8, 8));
8307 : 4 : ASSERT_TRUE (byte0->descendent_of_p (x_reg));
8308 : 4 : ASSERT_TRUE (byte1->descendent_of_p (x_reg));
8309 : 4 : ASSERT_NE (byte0, byte1);
8310 : 4 : }
8311 : :
8312 : : /* Verify that simple assignments work as expected. */
8313 : :
8314 : : static void
8315 : 4 : test_assignment ()
8316 : : {
8317 : 4 : tree int_0 = integer_zero_node;
8318 : 4 : tree x = build_global_decl ("x", integer_type_node);
8319 : 4 : tree y = build_global_decl ("y", integer_type_node);
8320 : :
8321 : : /* "x == 0", then use of y, then "y = 0;". */
8322 : 4 : region_model_manager mgr;
8323 : 4 : region_model model (&mgr);
8324 : 4 : ADD_SAT_CONSTRAINT (model, x, EQ_EXPR, int_0);
8325 : 4 : ASSERT_CONDITION_UNKNOWN (model, y, EQ_EXPR, int_0);
8326 : 4 : model.set_value (model.get_lvalue (y, NULL),
8327 : : model.get_rvalue (int_0, NULL),
8328 : : NULL);
8329 : 4 : ASSERT_CONDITION_TRUE (model, y, EQ_EXPR, int_0);
8330 : 4 : ASSERT_CONDITION_TRUE (model, y, EQ_EXPR, x);
8331 : 4 : }
8332 : :
8333 : : /* Verify that compound assignments work as expected. */
8334 : :
8335 : : static void
8336 : 4 : test_compound_assignment ()
8337 : : {
8338 : 4 : coord_test ct;
8339 : :
8340 : 4 : tree c = build_global_decl ("c", ct.m_coord_type);
8341 : 4 : tree c_x = build3 (COMPONENT_REF, TREE_TYPE (ct.m_x_field),
8342 : : c, ct.m_x_field, NULL_TREE);
8343 : 4 : tree c_y = build3 (COMPONENT_REF, TREE_TYPE (ct.m_y_field),
8344 : : c, ct.m_y_field, NULL_TREE);
8345 : 4 : tree d = build_global_decl ("d", ct.m_coord_type);
8346 : 4 : tree d_x = build3 (COMPONENT_REF, TREE_TYPE (ct.m_x_field),
8347 : : d, ct.m_x_field, NULL_TREE);
8348 : 4 : tree d_y = build3 (COMPONENT_REF, TREE_TYPE (ct.m_y_field),
8349 : : d, ct.m_y_field, NULL_TREE);
8350 : :
8351 : 4 : tree int_17 = build_int_cst (integer_type_node, 17);
8352 : 4 : tree int_m3 = build_int_cst (integer_type_node, -3);
8353 : :
8354 : 4 : region_model_manager mgr;
8355 : 4 : region_model model (&mgr);
8356 : 4 : model.set_value (c_x, int_17, NULL);
8357 : 4 : model.set_value (c_y, int_m3, NULL);
8358 : :
8359 : : /* Copy c to d. */
8360 : 4 : const svalue *sval = model.get_rvalue (c, NULL);
8361 : 4 : model.set_value (model.get_lvalue (d, NULL), sval, NULL);
8362 : :
8363 : : /* Check that the fields have the same svalues. */
8364 : 4 : ASSERT_EQ (model.get_rvalue (c_x, NULL), model.get_rvalue (d_x, NULL));
8365 : 4 : ASSERT_EQ (model.get_rvalue (c_y, NULL), model.get_rvalue (d_y, NULL));
8366 : 4 : }
8367 : :
8368 : : /* Verify the details of pushing and popping stack frames. */
8369 : :
8370 : : static void
8371 : 4 : test_stack_frames ()
8372 : : {
8373 : 4 : tree int_42 = build_int_cst (integer_type_node, 42);
8374 : 4 : tree int_10 = build_int_cst (integer_type_node, 10);
8375 : 4 : tree int_5 = build_int_cst (integer_type_node, 5);
8376 : 4 : tree int_0 = integer_zero_node;
8377 : :
8378 : 4 : auto_vec <tree> param_types;
8379 : 4 : tree parent_fndecl = make_fndecl (integer_type_node,
8380 : : "parent_fn",
8381 : : param_types);
8382 : 4 : allocate_struct_function (parent_fndecl, true);
8383 : :
8384 : 4 : tree child_fndecl = make_fndecl (integer_type_node,
8385 : : "child_fn",
8386 : : param_types);
8387 : 4 : allocate_struct_function (child_fndecl, true);
8388 : :
8389 : : /* "a" and "b" in the parent frame. */
8390 : 4 : tree a = build_decl (UNKNOWN_LOCATION, PARM_DECL,
8391 : : get_identifier ("a"),
8392 : : integer_type_node);
8393 : 4 : DECL_CONTEXT (a) = parent_fndecl;
8394 : 4 : tree b = build_decl (UNKNOWN_LOCATION, PARM_DECL,
8395 : : get_identifier ("b"),
8396 : : integer_type_node);
8397 : 4 : DECL_CONTEXT (b) = parent_fndecl;
8398 : : /* "x" and "y" in a child frame. */
8399 : 4 : tree x = build_decl (UNKNOWN_LOCATION, PARM_DECL,
8400 : : get_identifier ("x"),
8401 : : integer_type_node);
8402 : 4 : DECL_CONTEXT (x) = child_fndecl;
8403 : 4 : tree y = build_decl (UNKNOWN_LOCATION, PARM_DECL,
8404 : : get_identifier ("y"),
8405 : : integer_type_node);
8406 : 4 : DECL_CONTEXT (y) = child_fndecl;
8407 : :
8408 : : /* "p" global. */
8409 : 4 : tree p = build_global_decl ("p", ptr_type_node);
8410 : :
8411 : : /* "q" global. */
8412 : 4 : tree q = build_global_decl ("q", ptr_type_node);
8413 : :
8414 : 4 : region_model_manager mgr;
8415 : 4 : test_region_model_context ctxt;
8416 : 4 : region_model model (&mgr);
8417 : :
8418 : : /* Push stack frame for "parent_fn". */
8419 : 4 : const region *parent_frame_reg
8420 : 4 : = model.push_frame (*DECL_STRUCT_FUNCTION (parent_fndecl),
8421 : : NULL, &ctxt);
8422 : 4 : ASSERT_EQ (model.get_current_frame (), parent_frame_reg);
8423 : 4 : ASSERT_TRUE (model.region_exists_p (parent_frame_reg));
8424 : 4 : const region *a_in_parent_reg = model.get_lvalue (a, &ctxt);
8425 : 4 : model.set_value (a_in_parent_reg,
8426 : : model.get_rvalue (int_42, &ctxt),
8427 : : &ctxt);
8428 : 4 : ASSERT_EQ (a_in_parent_reg->maybe_get_frame_region (), parent_frame_reg);
8429 : :
8430 : 4 : model.add_constraint (b, LT_EXPR, int_10, &ctxt);
8431 : 4 : ASSERT_EQ (model.eval_condition (b, LT_EXPR, int_10, &ctxt),
8432 : : tristate (tristate::TS_TRUE));
8433 : :
8434 : : /* Push stack frame for "child_fn". */
8435 : 4 : const region *child_frame_reg
8436 : 4 : = model.push_frame (*DECL_STRUCT_FUNCTION (child_fndecl), NULL, &ctxt);
8437 : 4 : ASSERT_EQ (model.get_current_frame (), child_frame_reg);
8438 : 4 : ASSERT_TRUE (model.region_exists_p (child_frame_reg));
8439 : 4 : const region *x_in_child_reg = model.get_lvalue (x, &ctxt);
8440 : 4 : model.set_value (x_in_child_reg,
8441 : : model.get_rvalue (int_0, &ctxt),
8442 : : &ctxt);
8443 : 4 : ASSERT_EQ (x_in_child_reg->maybe_get_frame_region (), child_frame_reg);
8444 : :
8445 : 4 : model.add_constraint (y, NE_EXPR, int_5, &ctxt);
8446 : 4 : ASSERT_EQ (model.eval_condition (y, NE_EXPR, int_5, &ctxt),
8447 : : tristate (tristate::TS_TRUE));
8448 : :
8449 : : /* Point a global pointer at a local in the child frame: p = &x. */
8450 : 4 : const region *p_in_globals_reg = model.get_lvalue (p, &ctxt);
8451 : 4 : model.set_value (p_in_globals_reg,
8452 : : mgr.get_ptr_svalue (ptr_type_node, x_in_child_reg),
8453 : : &ctxt);
8454 : 4 : ASSERT_EQ (p_in_globals_reg->maybe_get_frame_region (), NULL);
8455 : :
8456 : : /* Point another global pointer at p: q = &p. */
8457 : 4 : const region *q_in_globals_reg = model.get_lvalue (q, &ctxt);
8458 : 4 : model.set_value (q_in_globals_reg,
8459 : : mgr.get_ptr_svalue (ptr_type_node, p_in_globals_reg),
8460 : : &ctxt);
8461 : :
8462 : : /* Test region::descendent_of_p. */
8463 : 4 : ASSERT_TRUE (child_frame_reg->descendent_of_p (child_frame_reg));
8464 : 4 : ASSERT_TRUE (x_in_child_reg->descendent_of_p (child_frame_reg));
8465 : 4 : ASSERT_FALSE (a_in_parent_reg->descendent_of_p (child_frame_reg));
8466 : :
8467 : : /* Pop the "child_fn" frame from the stack. */
8468 : 4 : model.pop_frame (NULL, NULL, &ctxt, nullptr);
8469 : 4 : ASSERT_FALSE (model.region_exists_p (child_frame_reg));
8470 : 4 : ASSERT_TRUE (model.region_exists_p (parent_frame_reg));
8471 : :
8472 : : /* Verify that p (which was pointing at the local "x" in the popped
8473 : : frame) has been poisoned. */
8474 : 4 : const svalue *new_p_sval = model.get_rvalue (p, NULL);
8475 : 4 : ASSERT_EQ (new_p_sval->get_kind (), SK_POISONED);
8476 : 4 : ASSERT_EQ (new_p_sval->dyn_cast_poisoned_svalue ()->get_poison_kind (),
8477 : : POISON_KIND_POPPED_STACK);
8478 : :
8479 : : /* Verify that q still points to p, in spite of the region
8480 : : renumbering. */
8481 : 4 : const svalue *new_q_sval = model.get_rvalue (q, &ctxt);
8482 : 4 : ASSERT_EQ (new_q_sval->get_kind (), SK_REGION);
8483 : 4 : ASSERT_EQ (new_q_sval->maybe_get_region (),
8484 : : model.get_lvalue (p, &ctxt));
8485 : :
8486 : : /* Verify that top of stack has been updated. */
8487 : 4 : ASSERT_EQ (model.get_current_frame (), parent_frame_reg);
8488 : :
8489 : : /* Verify locals in parent frame. */
8490 : : /* Verify "a" still has its value. */
8491 : 4 : const svalue *new_a_sval = model.get_rvalue (a, &ctxt);
8492 : 4 : ASSERT_EQ (new_a_sval->get_kind (), SK_CONSTANT);
8493 : 4 : ASSERT_EQ (new_a_sval->dyn_cast_constant_svalue ()->get_constant (),
8494 : : int_42);
8495 : : /* Verify "b" still has its constraint. */
8496 : 4 : ASSERT_EQ (model.eval_condition (b, LT_EXPR, int_10, &ctxt),
8497 : : tristate (tristate::TS_TRUE));
8498 : 4 : }
8499 : :
8500 : : /* Verify that get_representative_path_var works as expected, that
8501 : : we can map from regions to parms and back within a recursive call
8502 : : stack. */
8503 : :
8504 : : static void
8505 : 4 : test_get_representative_path_var ()
8506 : : {
8507 : 4 : auto_vec <tree> param_types;
8508 : 4 : tree fndecl = make_fndecl (integer_type_node,
8509 : : "factorial",
8510 : : param_types);
8511 : 4 : allocate_struct_function (fndecl, true);
8512 : :
8513 : : /* Parm "n". */
8514 : 4 : tree n = build_decl (UNKNOWN_LOCATION, PARM_DECL,
8515 : : get_identifier ("n"),
8516 : : integer_type_node);
8517 : 4 : DECL_CONTEXT (n) = fndecl;
8518 : :
8519 : 4 : region_model_manager mgr;
8520 : 4 : test_region_model_context ctxt;
8521 : 4 : region_model model (&mgr);
8522 : :
8523 : : /* Push 5 stack frames for "factorial", each with a param */
8524 : 4 : auto_vec<const region *> parm_regs;
8525 : 4 : auto_vec<const svalue *> parm_svals;
8526 : 24 : for (int depth = 0; depth < 5; depth++)
8527 : : {
8528 : 20 : const region *frame_n_reg
8529 : 20 : = model.push_frame (*DECL_STRUCT_FUNCTION (fndecl), NULL, &ctxt);
8530 : 20 : const region *parm_n_reg = model.get_lvalue (path_var (n, depth), &ctxt);
8531 : 20 : parm_regs.safe_push (parm_n_reg);
8532 : :
8533 : 20 : ASSERT_EQ (parm_n_reg->get_parent_region (), frame_n_reg);
8534 : 20 : const svalue *sval_n = mgr.get_or_create_initial_value (parm_n_reg);
8535 : 20 : parm_svals.safe_push (sval_n);
8536 : : }
8537 : :
8538 : : /* Verify that we can recognize that the regions are the parms,
8539 : : at every depth. */
8540 : 24 : for (int depth = 0; depth < 5; depth++)
8541 : : {
8542 : 20 : {
8543 : 20 : svalue_set visited;
8544 : 40 : ASSERT_EQ (model.get_representative_path_var (parm_regs[depth],
8545 : : &visited,
8546 : : nullptr),
8547 : : path_var (n, depth + 1));
8548 : 20 : }
8549 : : /* ...and that we can lookup lvalues for locals for all frames,
8550 : : not just the top. */
8551 : 20 : ASSERT_EQ (model.get_lvalue (path_var (n, depth), NULL),
8552 : : parm_regs[depth]);
8553 : : /* ...and that we can locate the svalues. */
8554 : 20 : {
8555 : 20 : svalue_set visited;
8556 : 40 : ASSERT_EQ (model.get_representative_path_var (parm_svals[depth],
8557 : : &visited,
8558 : : nullptr),
8559 : : path_var (n, depth + 1));
8560 : 20 : }
8561 : : }
8562 : 4 : }
8563 : :
8564 : : /* Ensure that region_model::operator== works as expected. */
8565 : :
8566 : : static void
8567 : 4 : test_equality_1 ()
8568 : : {
8569 : 4 : tree int_42 = build_int_cst (integer_type_node, 42);
8570 : 4 : tree int_17 = build_int_cst (integer_type_node, 17);
8571 : :
8572 : : /* Verify that "empty" region_model instances are equal to each other. */
8573 : 4 : region_model_manager mgr;
8574 : 4 : region_model model0 (&mgr);
8575 : 4 : region_model model1 (&mgr);
8576 : 4 : ASSERT_EQ (model0, model1);
8577 : :
8578 : : /* Verify that setting state in model1 makes the models non-equal. */
8579 : 4 : tree x = build_global_decl ("x", integer_type_node);
8580 : 4 : model0.set_value (x, int_42, NULL);
8581 : 4 : ASSERT_EQ (model0.get_rvalue (x, NULL)->maybe_get_constant (), int_42);
8582 : 4 : ASSERT_NE (model0, model1);
8583 : :
8584 : : /* Verify the copy-ctor. */
8585 : 4 : region_model model2 (model0);
8586 : 4 : ASSERT_EQ (model0, model2);
8587 : 4 : ASSERT_EQ (model2.get_rvalue (x, NULL)->maybe_get_constant (), int_42);
8588 : 4 : ASSERT_NE (model1, model2);
8589 : :
8590 : : /* Verify that models obtained from copy-ctor are independently editable
8591 : : w/o affecting the original model. */
8592 : 4 : model2.set_value (x, int_17, NULL);
8593 : 4 : ASSERT_NE (model0, model2);
8594 : 4 : ASSERT_EQ (model2.get_rvalue (x, NULL)->maybe_get_constant (), int_17);
8595 : 4 : ASSERT_EQ (model0.get_rvalue (x, NULL)->maybe_get_constant (), int_42);
8596 : 4 : }
8597 : :
8598 : : /* Verify that region models for
8599 : : x = 42; y = 113;
8600 : : and
8601 : : y = 113; x = 42;
8602 : : are equal. */
8603 : :
8604 : : static void
8605 : 4 : test_canonicalization_2 ()
8606 : : {
8607 : 4 : tree int_42 = build_int_cst (integer_type_node, 42);
8608 : 4 : tree int_113 = build_int_cst (integer_type_node, 113);
8609 : 4 : tree x = build_global_decl ("x", integer_type_node);
8610 : 4 : tree y = build_global_decl ("y", integer_type_node);
8611 : :
8612 : 4 : region_model_manager mgr;
8613 : 4 : region_model model0 (&mgr);
8614 : 4 : model0.set_value (model0.get_lvalue (x, NULL),
8615 : : model0.get_rvalue (int_42, NULL),
8616 : : NULL);
8617 : 4 : model0.set_value (model0.get_lvalue (y, NULL),
8618 : : model0.get_rvalue (int_113, NULL),
8619 : : NULL);
8620 : :
8621 : 4 : region_model model1 (&mgr);
8622 : 4 : model1.set_value (model1.get_lvalue (y, NULL),
8623 : : model1.get_rvalue (int_113, NULL),
8624 : : NULL);
8625 : 4 : model1.set_value (model1.get_lvalue (x, NULL),
8626 : : model1.get_rvalue (int_42, NULL),
8627 : : NULL);
8628 : :
8629 : 4 : ASSERT_EQ (model0, model1);
8630 : 4 : }
8631 : :
8632 : : /* Verify that constraints for
8633 : : x > 3 && y > 42
8634 : : and
8635 : : y > 42 && x > 3
8636 : : are equal after canonicalization. */
8637 : :
8638 : : static void
8639 : 4 : test_canonicalization_3 ()
8640 : : {
8641 : 4 : tree int_3 = build_int_cst (integer_type_node, 3);
8642 : 4 : tree int_42 = build_int_cst (integer_type_node, 42);
8643 : 4 : tree x = build_global_decl ("x", integer_type_node);
8644 : 4 : tree y = build_global_decl ("y", integer_type_node);
8645 : :
8646 : 4 : region_model_manager mgr;
8647 : 4 : region_model model0 (&mgr);
8648 : 4 : model0.add_constraint (x, GT_EXPR, int_3, NULL);
8649 : 4 : model0.add_constraint (y, GT_EXPR, int_42, NULL);
8650 : :
8651 : 4 : region_model model1 (&mgr);
8652 : 4 : model1.add_constraint (y, GT_EXPR, int_42, NULL);
8653 : 4 : model1.add_constraint (x, GT_EXPR, int_3, NULL);
8654 : :
8655 : 4 : model0.canonicalize ();
8656 : 4 : model1.canonicalize ();
8657 : 4 : ASSERT_EQ (model0, model1);
8658 : 4 : }
8659 : :
8660 : : /* Verify that we can canonicalize a model containing NaN and other real
8661 : : constants. */
8662 : :
8663 : : static void
8664 : 4 : test_canonicalization_4 ()
8665 : : {
8666 : 4 : auto_vec<tree> csts;
8667 : 4 : append_interesting_constants (&csts);
8668 : :
8669 : 4 : region_model_manager mgr;
8670 : 4 : region_model model (&mgr);
8671 : :
8672 : 60 : for (tree cst : csts)
8673 : 48 : model.get_rvalue (cst, NULL);
8674 : :
8675 : 4 : model.canonicalize ();
8676 : 4 : }
8677 : :
8678 : : /* Assert that if we have two region_model instances
8679 : : with values VAL_A and VAL_B for EXPR that they are
8680 : : mergable. Write the merged model to *OUT_MERGED_MODEL,
8681 : : and the merged svalue ptr to *OUT_MERGED_SVALUE.
8682 : : If VAL_A or VAL_B are NULL_TREE, don't populate EXPR
8683 : : for that region_model. */
8684 : :
8685 : : static void
8686 : 24 : assert_region_models_merge (tree expr, tree val_a, tree val_b,
8687 : : region_model *out_merged_model,
8688 : : const svalue **out_merged_svalue)
8689 : : {
8690 : 24 : region_model_manager *mgr = out_merged_model->get_manager ();
8691 : 24 : program_point point (program_point::origin (*mgr));
8692 : 24 : test_region_model_context ctxt;
8693 : 24 : region_model model0 (mgr);
8694 : 24 : region_model model1 (mgr);
8695 : 24 : if (val_a)
8696 : 20 : model0.set_value (model0.get_lvalue (expr, &ctxt),
8697 : : model0.get_rvalue (val_a, &ctxt),
8698 : : &ctxt);
8699 : 24 : if (val_b)
8700 : 20 : model1.set_value (model1.get_lvalue (expr, &ctxt),
8701 : : model1.get_rvalue (val_b, &ctxt),
8702 : : &ctxt);
8703 : :
8704 : : /* They should be mergeable. */
8705 : 24 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, out_merged_model));
8706 : 24 : *out_merged_svalue = out_merged_model->get_rvalue (expr, &ctxt);
8707 : 24 : }
8708 : :
8709 : : /* Verify that we can merge region_model instances. */
8710 : :
8711 : : static void
8712 : 4 : test_state_merging ()
8713 : : {
8714 : 4 : tree int_42 = build_int_cst (integer_type_node, 42);
8715 : 4 : tree int_113 = build_int_cst (integer_type_node, 113);
8716 : 4 : tree x = build_global_decl ("x", integer_type_node);
8717 : 4 : tree y = build_global_decl ("y", integer_type_node);
8718 : 4 : tree z = build_global_decl ("z", integer_type_node);
8719 : 4 : tree p = build_global_decl ("p", ptr_type_node);
8720 : :
8721 : 4 : tree addr_of_y = build1 (ADDR_EXPR, ptr_type_node, y);
8722 : 4 : tree addr_of_z = build1 (ADDR_EXPR, ptr_type_node, z);
8723 : :
8724 : 4 : auto_vec <tree> param_types;
8725 : 4 : tree test_fndecl = make_fndecl (integer_type_node, "test_fn", param_types);
8726 : 4 : allocate_struct_function (test_fndecl, true);
8727 : :
8728 : : /* Param "a". */
8729 : 4 : tree a = build_decl (UNKNOWN_LOCATION, PARM_DECL,
8730 : : get_identifier ("a"),
8731 : : integer_type_node);
8732 : 4 : DECL_CONTEXT (a) = test_fndecl;
8733 : 4 : tree addr_of_a = build1 (ADDR_EXPR, ptr_type_node, a);
8734 : :
8735 : : /* Param "q", a pointer. */
8736 : 4 : tree q = build_decl (UNKNOWN_LOCATION, PARM_DECL,
8737 : : get_identifier ("q"),
8738 : : ptr_type_node);
8739 : 4 : DECL_CONTEXT (q) = test_fndecl;
8740 : :
8741 : 4 : region_model_manager mgr;
8742 : 4 : program_point point (program_point::origin (mgr));
8743 : :
8744 : 4 : {
8745 : 4 : region_model model0 (&mgr);
8746 : 4 : region_model model1 (&mgr);
8747 : 4 : region_model merged (&mgr);
8748 : : /* Verify empty models can be merged. */
8749 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8750 : 4 : ASSERT_EQ (model0, merged);
8751 : 4 : }
8752 : :
8753 : : /* Verify that we can merge two contradictory constraints on the
8754 : : value for a global. */
8755 : : /* TODO: verify that the merged model doesn't have a value for
8756 : : the global */
8757 : 4 : {
8758 : 4 : region_model model0 (&mgr);
8759 : 4 : region_model model1 (&mgr);
8760 : 4 : region_model merged (&mgr);
8761 : 4 : test_region_model_context ctxt;
8762 : 4 : model0.add_constraint (x, EQ_EXPR, int_42, &ctxt);
8763 : 4 : model1.add_constraint (x, EQ_EXPR, int_113, &ctxt);
8764 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8765 : 4 : ASSERT_NE (model0, merged);
8766 : 4 : ASSERT_NE (model1, merged);
8767 : 4 : }
8768 : :
8769 : : /* Verify handling of a PARM_DECL. */
8770 : 4 : {
8771 : 4 : test_region_model_context ctxt;
8772 : 4 : region_model model0 (&mgr);
8773 : 4 : region_model model1 (&mgr);
8774 : 4 : ASSERT_EQ (model0.get_stack_depth (), 0);
8775 : 4 : model0.push_frame (*DECL_STRUCT_FUNCTION (test_fndecl), NULL, &ctxt);
8776 : 4 : ASSERT_EQ (model0.get_stack_depth (), 1);
8777 : 4 : model1.push_frame (*DECL_STRUCT_FUNCTION (test_fndecl), NULL, &ctxt);
8778 : :
8779 : 4 : placeholder_svalue test_sval (mgr.alloc_symbol_id (),
8780 : 4 : integer_type_node, "test sval");
8781 : 4 : model0.set_value (model0.get_lvalue (a, &ctxt), &test_sval, &ctxt);
8782 : 4 : model1.set_value (model1.get_lvalue (a, &ctxt), &test_sval, &ctxt);
8783 : 4 : ASSERT_EQ (model0, model1);
8784 : :
8785 : : /* They should be mergeable, and the result should be the same. */
8786 : 4 : region_model merged (&mgr);
8787 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8788 : 4 : ASSERT_EQ (model0, merged);
8789 : : /* In particular, "a" should have the placeholder value. */
8790 : 4 : ASSERT_EQ (merged.get_rvalue (a, &ctxt), &test_sval);
8791 : 4 : }
8792 : :
8793 : : /* Verify handling of a global. */
8794 : 4 : {
8795 : 4 : test_region_model_context ctxt;
8796 : 4 : region_model model0 (&mgr);
8797 : 4 : region_model model1 (&mgr);
8798 : :
8799 : 4 : placeholder_svalue test_sval (mgr.alloc_symbol_id (),
8800 : 4 : integer_type_node, "test sval");
8801 : 4 : model0.set_value (model0.get_lvalue (x, &ctxt), &test_sval, &ctxt);
8802 : 4 : model1.set_value (model1.get_lvalue (x, &ctxt), &test_sval, &ctxt);
8803 : 4 : ASSERT_EQ (model0, model1);
8804 : :
8805 : : /* They should be mergeable, and the result should be the same. */
8806 : 4 : region_model merged (&mgr);
8807 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8808 : 4 : ASSERT_EQ (model0, merged);
8809 : : /* In particular, "x" should have the placeholder value. */
8810 : 4 : ASSERT_EQ (merged.get_rvalue (x, &ctxt), &test_sval);
8811 : 4 : }
8812 : :
8813 : : /* Use global-handling to verify various combinations of values. */
8814 : :
8815 : : /* Two equal constant values. */
8816 : 4 : {
8817 : 4 : region_model merged (&mgr);
8818 : 4 : const svalue *merged_x_sval;
8819 : 4 : assert_region_models_merge (x, int_42, int_42, &merged, &merged_x_sval);
8820 : :
8821 : : /* In particular, there should be a constant value for "x". */
8822 : 4 : ASSERT_EQ (merged_x_sval->get_kind (), SK_CONSTANT);
8823 : 4 : ASSERT_EQ (merged_x_sval->dyn_cast_constant_svalue ()->get_constant (),
8824 : : int_42);
8825 : 4 : }
8826 : :
8827 : : /* Two non-equal constant values. */
8828 : 4 : {
8829 : 4 : region_model merged (&mgr);
8830 : 4 : const svalue *merged_x_sval;
8831 : 4 : assert_region_models_merge (x, int_42, int_113, &merged, &merged_x_sval);
8832 : :
8833 : : /* In particular, there should be a "widening" value for "x". */
8834 : 4 : ASSERT_EQ (merged_x_sval->get_kind (), SK_WIDENING);
8835 : 4 : }
8836 : :
8837 : : /* Initial and constant. */
8838 : 4 : {
8839 : 4 : region_model merged (&mgr);
8840 : 4 : const svalue *merged_x_sval;
8841 : 4 : assert_region_models_merge (x, NULL_TREE, int_113, &merged, &merged_x_sval);
8842 : :
8843 : : /* In particular, there should be an unknown value for "x". */
8844 : 4 : ASSERT_EQ (merged_x_sval->get_kind (), SK_UNKNOWN);
8845 : 4 : }
8846 : :
8847 : : /* Constant and initial. */
8848 : 4 : {
8849 : 4 : region_model merged (&mgr);
8850 : 4 : const svalue *merged_x_sval;
8851 : 4 : assert_region_models_merge (x, int_42, NULL_TREE, &merged, &merged_x_sval);
8852 : :
8853 : : /* In particular, there should be an unknown value for "x". */
8854 : 4 : ASSERT_EQ (merged_x_sval->get_kind (), SK_UNKNOWN);
8855 : 4 : }
8856 : :
8857 : : /* Unknown and constant. */
8858 : : // TODO
8859 : :
8860 : : /* Pointers: NULL and NULL. */
8861 : : // TODO
8862 : :
8863 : : /* Pointers: NULL and non-NULL. */
8864 : : // TODO
8865 : :
8866 : : /* Pointers: non-NULL and non-NULL: ptr to a local. */
8867 : 4 : {
8868 : 4 : region_model model0 (&mgr);
8869 : 4 : model0.push_frame (*DECL_STRUCT_FUNCTION (test_fndecl), NULL, NULL);
8870 : 4 : model0.set_value (model0.get_lvalue (p, NULL),
8871 : : model0.get_rvalue (addr_of_a, NULL), NULL);
8872 : :
8873 : 4 : region_model model1 (model0);
8874 : 4 : ASSERT_EQ (model0, model1);
8875 : :
8876 : : /* They should be mergeable, and the result should be the same. */
8877 : 4 : region_model merged (&mgr);
8878 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8879 : 4 : ASSERT_EQ (model0, merged);
8880 : 4 : }
8881 : :
8882 : : /* Pointers: non-NULL and non-NULL: ptr to a global. */
8883 : 4 : {
8884 : 4 : region_model merged (&mgr);
8885 : : /* p == &y in both input models. */
8886 : 4 : const svalue *merged_p_sval;
8887 : 4 : assert_region_models_merge (p, addr_of_y, addr_of_y, &merged,
8888 : : &merged_p_sval);
8889 : :
8890 : : /* We should get p == &y in the merged model. */
8891 : 4 : ASSERT_EQ (merged_p_sval->get_kind (), SK_REGION);
8892 : 4 : const region_svalue *merged_p_ptr
8893 : 4 : = merged_p_sval->dyn_cast_region_svalue ();
8894 : 4 : const region *merged_p_star_reg = merged_p_ptr->get_pointee ();
8895 : 4 : ASSERT_EQ (merged_p_star_reg, merged.get_lvalue (y, NULL));
8896 : 4 : }
8897 : :
8898 : : /* Pointers: non-NULL ptrs to different globals: should be unknown. */
8899 : 4 : {
8900 : 4 : region_model merged (&mgr);
8901 : : /* x == &y vs x == &z in the input models; these are actually casts
8902 : : of the ptrs to "int". */
8903 : 4 : const svalue *merged_x_sval;
8904 : : // TODO:
8905 : 4 : assert_region_models_merge (x, addr_of_y, addr_of_z, &merged,
8906 : : &merged_x_sval);
8907 : :
8908 : : /* We should get x == unknown in the merged model. */
8909 : 4 : ASSERT_EQ (merged_x_sval->get_kind (), SK_UNKNOWN);
8910 : 4 : }
8911 : :
8912 : : /* Pointers: non-NULL and non-NULL: ptr to a heap region. */
8913 : 4 : {
8914 : 4 : test_region_model_context ctxt;
8915 : 4 : region_model model0 (&mgr);
8916 : 4 : tree size = build_int_cst (size_type_node, 1024);
8917 : 4 : const svalue *size_sval = mgr.get_or_create_constant_svalue (size);
8918 : 4 : const region *new_reg
8919 : 4 : = model0.get_or_create_region_for_heap_alloc (size_sval, &ctxt);
8920 : 4 : const svalue *ptr_sval = mgr.get_ptr_svalue (ptr_type_node, new_reg);
8921 : 4 : model0.set_value (model0.get_lvalue (p, &ctxt),
8922 : : ptr_sval, &ctxt);
8923 : :
8924 : 4 : region_model model1 (model0);
8925 : :
8926 : 4 : ASSERT_EQ (model0, model1);
8927 : :
8928 : 4 : region_model merged (&mgr);
8929 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8930 : :
8931 : : /* The merged model ought to be identical. */
8932 : 4 : ASSERT_EQ (model0, merged);
8933 : 4 : }
8934 : :
8935 : : /* Two regions sharing the same placeholder svalue should continue sharing
8936 : : it after self-merger. */
8937 : 4 : {
8938 : 4 : test_region_model_context ctxt;
8939 : 4 : region_model model0 (&mgr);
8940 : 4 : placeholder_svalue placeholder_sval (mgr.alloc_symbol_id (),
8941 : 4 : integer_type_node, "test");
8942 : 4 : model0.set_value (model0.get_lvalue (x, &ctxt),
8943 : : &placeholder_sval, &ctxt);
8944 : 4 : model0.set_value (model0.get_lvalue (y, &ctxt), &placeholder_sval, &ctxt);
8945 : 4 : region_model model1 (model0);
8946 : :
8947 : : /* They should be mergeable, and the result should be the same. */
8948 : 4 : region_model merged (&mgr);
8949 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8950 : 4 : ASSERT_EQ (model0, merged);
8951 : :
8952 : : /* In particular, we should have x == y. */
8953 : 4 : ASSERT_EQ (merged.eval_condition (x, EQ_EXPR, y, &ctxt),
8954 : : tristate (tristate::TS_TRUE));
8955 : 4 : }
8956 : :
8957 : 4 : {
8958 : 4 : region_model model0 (&mgr);
8959 : 4 : region_model model1 (&mgr);
8960 : 4 : test_region_model_context ctxt;
8961 : 4 : model0.add_constraint (x, EQ_EXPR, int_42, &ctxt);
8962 : 4 : model1.add_constraint (x, NE_EXPR, int_42, &ctxt);
8963 : 4 : region_model merged (&mgr);
8964 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8965 : 4 : }
8966 : :
8967 : 4 : {
8968 : 4 : region_model model0 (&mgr);
8969 : 4 : region_model model1 (&mgr);
8970 : 4 : test_region_model_context ctxt;
8971 : 4 : model0.add_constraint (x, EQ_EXPR, int_42, &ctxt);
8972 : 4 : model1.add_constraint (x, NE_EXPR, int_42, &ctxt);
8973 : 4 : model1.add_constraint (x, EQ_EXPR, int_113, &ctxt);
8974 : 4 : region_model merged (&mgr);
8975 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
8976 : 4 : }
8977 : :
8978 : : // TODO: what can't we merge? need at least one such test
8979 : :
8980 : : /* TODO: various things
8981 : : - heap regions
8982 : : - value merging:
8983 : : - every combination, but in particular
8984 : : - pairs of regions
8985 : : */
8986 : :
8987 : : /* Views. */
8988 : 4 : {
8989 : 4 : test_region_model_context ctxt;
8990 : 4 : region_model model0 (&mgr);
8991 : :
8992 : 4 : const region *x_reg = model0.get_lvalue (x, &ctxt);
8993 : 4 : const region *x_as_ptr = mgr.get_cast_region (x_reg, ptr_type_node);
8994 : 4 : model0.set_value (x_as_ptr, model0.get_rvalue (addr_of_y, &ctxt), &ctxt);
8995 : :
8996 : 4 : region_model model1 (model0);
8997 : 4 : ASSERT_EQ (model1, model0);
8998 : :
8999 : : /* They should be mergeable, and the result should be the same. */
9000 : 4 : region_model merged (&mgr);
9001 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
9002 : 4 : }
9003 : :
9004 : : /* Verify that we can merge a model in which a local in an older stack
9005 : : frame points to a local in a more recent stack frame. */
9006 : 4 : {
9007 : 4 : region_model model0 (&mgr);
9008 : 4 : model0.push_frame (*DECL_STRUCT_FUNCTION (test_fndecl), NULL, NULL);
9009 : 4 : const region *q_in_first_frame = model0.get_lvalue (q, NULL);
9010 : :
9011 : : /* Push a second frame. */
9012 : 4 : const region *reg_2nd_frame
9013 : 4 : = model0.push_frame (*DECL_STRUCT_FUNCTION (test_fndecl), NULL, NULL);
9014 : :
9015 : : /* Have a pointer in the older frame point to a local in the
9016 : : more recent frame. */
9017 : 4 : const svalue *sval_ptr = model0.get_rvalue (addr_of_a, NULL);
9018 : 4 : model0.set_value (q_in_first_frame, sval_ptr, NULL);
9019 : :
9020 : : /* Verify that it's pointing at the newer frame. */
9021 : 4 : const region *reg_pointee = sval_ptr->maybe_get_region ();
9022 : 4 : ASSERT_EQ (reg_pointee->get_parent_region (), reg_2nd_frame);
9023 : :
9024 : 4 : model0.canonicalize ();
9025 : :
9026 : 4 : region_model model1 (model0);
9027 : 4 : ASSERT_EQ (model0, model1);
9028 : :
9029 : : /* They should be mergeable, and the result should be the same
9030 : : (after canonicalization, at least). */
9031 : 4 : region_model merged (&mgr);
9032 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
9033 : 4 : merged.canonicalize ();
9034 : 4 : ASSERT_EQ (model0, merged);
9035 : 4 : }
9036 : :
9037 : : /* Verify that we can merge a model in which a local points to a global. */
9038 : 4 : {
9039 : 4 : region_model model0 (&mgr);
9040 : 4 : model0.push_frame (*DECL_STRUCT_FUNCTION (test_fndecl), NULL, NULL);
9041 : 4 : model0.set_value (model0.get_lvalue (q, NULL),
9042 : : model0.get_rvalue (addr_of_y, NULL), NULL);
9043 : :
9044 : 4 : region_model model1 (model0);
9045 : 4 : ASSERT_EQ (model0, model1);
9046 : :
9047 : : /* They should be mergeable, and the result should be the same
9048 : : (after canonicalization, at least). */
9049 : 4 : region_model merged (&mgr);
9050 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
9051 : 4 : ASSERT_EQ (model0, merged);
9052 : 4 : }
9053 : 4 : }
9054 : :
9055 : : /* Verify that constraints are correctly merged when merging region_model
9056 : : instances. */
9057 : :
9058 : : static void
9059 : 4 : test_constraint_merging ()
9060 : : {
9061 : 4 : tree int_0 = integer_zero_node;
9062 : 4 : tree int_5 = build_int_cst (integer_type_node, 5);
9063 : 4 : tree x = build_global_decl ("x", integer_type_node);
9064 : 4 : tree y = build_global_decl ("y", integer_type_node);
9065 : 4 : tree z = build_global_decl ("z", integer_type_node);
9066 : 4 : tree n = build_global_decl ("n", integer_type_node);
9067 : :
9068 : 4 : region_model_manager mgr;
9069 : 4 : test_region_model_context ctxt;
9070 : :
9071 : : /* model0: 0 <= (x == y) < n. */
9072 : 4 : region_model model0 (&mgr);
9073 : 4 : model0.add_constraint (x, EQ_EXPR, y, &ctxt);
9074 : 4 : model0.add_constraint (x, GE_EXPR, int_0, NULL);
9075 : 4 : model0.add_constraint (x, LT_EXPR, n, NULL);
9076 : :
9077 : : /* model1: z != 5 && (0 <= x < n). */
9078 : 4 : region_model model1 (&mgr);
9079 : 4 : model1.add_constraint (z, NE_EXPR, int_5, NULL);
9080 : 4 : model1.add_constraint (x, GE_EXPR, int_0, NULL);
9081 : 4 : model1.add_constraint (x, LT_EXPR, n, NULL);
9082 : :
9083 : : /* They should be mergeable; the merged constraints should
9084 : : be: (0 <= x < n). */
9085 : 4 : program_point point (program_point::origin (mgr));
9086 : 4 : region_model merged (&mgr);
9087 : 4 : ASSERT_TRUE (model0.can_merge_with_p (model1, point, &merged));
9088 : :
9089 : 4 : ASSERT_EQ (merged.eval_condition (x, GE_EXPR, int_0, &ctxt),
9090 : : tristate (tristate::TS_TRUE));
9091 : 4 : ASSERT_EQ (merged.eval_condition (x, LT_EXPR, n, &ctxt),
9092 : : tristate (tristate::TS_TRUE));
9093 : :
9094 : 4 : ASSERT_EQ (merged.eval_condition (z, NE_EXPR, int_5, &ctxt),
9095 : : tristate (tristate::TS_UNKNOWN));
9096 : 4 : ASSERT_EQ (merged.eval_condition (x, LT_EXPR, y, &ctxt),
9097 : : tristate (tristate::TS_UNKNOWN));
9098 : 4 : }
9099 : :
9100 : : /* Verify that widening_svalue::eval_condition_without_cm works as
9101 : : expected. */
9102 : :
9103 : : static void
9104 : 4 : test_widening_constraints ()
9105 : : {
9106 : 4 : region_model_manager mgr;
9107 : 4 : function_point point (program_point::origin (mgr).get_function_point ());
9108 : 4 : tree int_0 = integer_zero_node;
9109 : 4 : tree int_m1 = build_int_cst (integer_type_node, -1);
9110 : 4 : tree int_1 = integer_one_node;
9111 : 4 : tree int_256 = build_int_cst (integer_type_node, 256);
9112 : 4 : test_region_model_context ctxt;
9113 : 4 : const svalue *int_0_sval = mgr.get_or_create_constant_svalue (int_0);
9114 : 4 : const svalue *int_1_sval = mgr.get_or_create_constant_svalue (int_1);
9115 : 4 : const svalue *w_zero_then_one_sval
9116 : 4 : = mgr.get_or_create_widening_svalue (integer_type_node, point,
9117 : : int_0_sval, int_1_sval);
9118 : 4 : const widening_svalue *w_zero_then_one
9119 : 4 : = w_zero_then_one_sval->dyn_cast_widening_svalue ();
9120 : 4 : ASSERT_EQ (w_zero_then_one->get_direction (),
9121 : : widening_svalue::DIR_ASCENDING);
9122 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (LT_EXPR, int_m1),
9123 : : tristate::TS_FALSE);
9124 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (LT_EXPR, int_0),
9125 : : tristate::TS_FALSE);
9126 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (LT_EXPR, int_1),
9127 : : tristate::TS_UNKNOWN);
9128 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (LT_EXPR, int_256),
9129 : : tristate::TS_UNKNOWN);
9130 : :
9131 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (LE_EXPR, int_m1),
9132 : : tristate::TS_FALSE);
9133 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (LE_EXPR, int_0),
9134 : : tristate::TS_UNKNOWN);
9135 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (LE_EXPR, int_1),
9136 : : tristate::TS_UNKNOWN);
9137 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (LE_EXPR, int_256),
9138 : : tristate::TS_UNKNOWN);
9139 : :
9140 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (GT_EXPR, int_m1),
9141 : : tristate::TS_TRUE);
9142 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (GT_EXPR, int_0),
9143 : : tristate::TS_UNKNOWN);
9144 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (GT_EXPR, int_1),
9145 : : tristate::TS_UNKNOWN);
9146 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (GT_EXPR, int_256),
9147 : : tristate::TS_UNKNOWN);
9148 : :
9149 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (GE_EXPR, int_m1),
9150 : : tristate::TS_TRUE);
9151 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (GE_EXPR, int_0),
9152 : : tristate::TS_TRUE);
9153 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (GE_EXPR, int_1),
9154 : : tristate::TS_UNKNOWN);
9155 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (GE_EXPR, int_256),
9156 : : tristate::TS_UNKNOWN);
9157 : :
9158 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (EQ_EXPR, int_m1),
9159 : : tristate::TS_FALSE);
9160 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (EQ_EXPR, int_0),
9161 : : tristate::TS_UNKNOWN);
9162 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (EQ_EXPR, int_1),
9163 : : tristate::TS_UNKNOWN);
9164 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (EQ_EXPR, int_256),
9165 : : tristate::TS_UNKNOWN);
9166 : :
9167 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (NE_EXPR, int_m1),
9168 : : tristate::TS_TRUE);
9169 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (NE_EXPR, int_0),
9170 : : tristate::TS_UNKNOWN);
9171 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (NE_EXPR, int_1),
9172 : : tristate::TS_UNKNOWN);
9173 : 4 : ASSERT_EQ (w_zero_then_one->eval_condition_without_cm (NE_EXPR, int_256),
9174 : : tristate::TS_UNKNOWN);
9175 : 4 : }
9176 : :
9177 : : /* Verify merging constraints for states simulating successive iterations
9178 : : of a loop.
9179 : : Simulate:
9180 : : for (i = 0; i < 256; i++)
9181 : : [...body...]
9182 : : i.e. this gimple:.
9183 : : i_15 = 0;
9184 : : goto <bb 4>;
9185 : :
9186 : : <bb 4> :
9187 : : i_11 = PHI <i_15(2), i_23(3)>
9188 : : if (i_11 <= 255)
9189 : : goto <bb 3>;
9190 : : else
9191 : : goto [AFTER LOOP]
9192 : :
9193 : : <bb 3> :
9194 : : [LOOP BODY]
9195 : : i_23 = i_11 + 1;
9196 : :
9197 : : and thus these ops (and resultant states):
9198 : : i_11 = PHI()
9199 : : {i_11: 0}
9200 : : add_constraint (i_11 <= 255) [for the true edge]
9201 : : {i_11: 0} [constraint was a no-op]
9202 : : i_23 = i_11 + 1;
9203 : : {i_22: 1}
9204 : : i_11 = PHI()
9205 : : {i_11: WIDENED (at phi, 0, 1)}
9206 : : add_constraint (i_11 <= 255) [for the true edge]
9207 : : {i_11: WIDENED (at phi, 0, 1); WIDENED <= 255}
9208 : : i_23 = i_11 + 1;
9209 : : {i_23: (WIDENED (at phi, 0, 1) + 1); WIDENED <= 255}
9210 : : i_11 = PHI(); merge with state at phi above
9211 : : {i_11: WIDENED (at phi, 0, 1); WIDENED <= 256}
9212 : : [changing meaning of "WIDENED" here]
9213 : : if (i_11 <= 255)
9214 : : T: {i_11: WIDENED (at phi, 0, 1); WIDENED <= 255}; cache hit
9215 : : F: {i_11: 256}
9216 : : */
9217 : :
9218 : : static void
9219 : 4 : test_iteration_1 ()
9220 : : {
9221 : 4 : region_model_manager mgr;
9222 : 4 : program_point point (program_point::origin (mgr));
9223 : :
9224 : 4 : tree int_0 = integer_zero_node;
9225 : 4 : tree int_1 = integer_one_node;
9226 : 4 : tree int_256 = build_int_cst (integer_type_node, 256);
9227 : 4 : tree i = build_global_decl ("i", integer_type_node);
9228 : :
9229 : 4 : test_region_model_context ctxt;
9230 : :
9231 : : /* model0: i: 0. */
9232 : 4 : region_model model0 (&mgr);
9233 : 4 : model0.set_value (i, int_0, &ctxt);
9234 : :
9235 : : /* model1: i: 1. */
9236 : 4 : region_model model1 (&mgr);
9237 : 4 : model1.set_value (i, int_1, &ctxt);
9238 : :
9239 : : /* Should merge "i" to a widened value. */
9240 : 4 : region_model model2 (&mgr);
9241 : 4 : ASSERT_TRUE (model1.can_merge_with_p (model0, point, &model2));
9242 : 4 : const svalue *merged_i = model2.get_rvalue (i, &ctxt);
9243 : 4 : ASSERT_EQ (merged_i->get_kind (), SK_WIDENING);
9244 : 4 : const widening_svalue *w = merged_i->dyn_cast_widening_svalue ();
9245 : 4 : ASSERT_EQ (w->get_direction (), widening_svalue::DIR_ASCENDING);
9246 : :
9247 : : /* Add constraint: i < 256 */
9248 : 4 : model2.add_constraint (i, LT_EXPR, int_256, &ctxt);
9249 : 4 : ASSERT_EQ (model2.eval_condition (i, LT_EXPR, int_256, &ctxt),
9250 : : tristate (tristate::TS_TRUE));
9251 : 4 : ASSERT_EQ (model2.eval_condition (i, GE_EXPR, int_0, &ctxt),
9252 : : tristate (tristate::TS_TRUE));
9253 : :
9254 : : /* Try merging with the initial state. */
9255 : 4 : region_model model3 (&mgr);
9256 : 4 : ASSERT_TRUE (model2.can_merge_with_p (model0, point, &model3));
9257 : : /* Merging the merged value with the initial value should be idempotent,
9258 : : so that the analysis converges. */
9259 : 4 : ASSERT_EQ (model3.get_rvalue (i, &ctxt), merged_i);
9260 : : /* Merger of 0 and a widening value with constraint < CST
9261 : : should retain the constraint, even though it was implicit
9262 : : for the 0 case. */
9263 : 4 : ASSERT_EQ (model3.eval_condition (i, LT_EXPR, int_256, &ctxt),
9264 : : tristate (tristate::TS_TRUE));
9265 : : /* ...and we should have equality: the analysis should have converged. */
9266 : 4 : ASSERT_EQ (model3, model2);
9267 : :
9268 : : /* "i_23 = i_11 + 1;" */
9269 : 4 : region_model model4 (model3);
9270 : 4 : ASSERT_EQ (model4, model2);
9271 : 4 : model4.set_value (i, build2 (PLUS_EXPR, integer_type_node, i, int_1), &ctxt);
9272 : 4 : const svalue *plus_one = model4.get_rvalue (i, &ctxt);
9273 : 4 : ASSERT_EQ (plus_one->get_kind (), SK_BINOP);
9274 : :
9275 : : /* Try merging with the "i: 1" state. */
9276 : 4 : region_model model5 (&mgr);
9277 : 4 : ASSERT_TRUE (model4.can_merge_with_p (model1, point, &model5));
9278 : 4 : ASSERT_EQ (model5.get_rvalue (i, &ctxt), plus_one);
9279 : 4 : ASSERT_EQ (model5, model4);
9280 : :
9281 : : /* "i_11 = PHI();" merge with state at phi above.
9282 : : For i, we should have a merger of WIDENING with WIDENING + 1,
9283 : : and this should be WIDENING again. */
9284 : 4 : region_model model6 (&mgr);
9285 : 4 : ASSERT_TRUE (model5.can_merge_with_p (model2, point, &model6));
9286 : 4 : const svalue *merged_widening = model6.get_rvalue (i, &ctxt);
9287 : 4 : ASSERT_EQ (merged_widening->get_kind (), SK_WIDENING);
9288 : 4 : }
9289 : :
9290 : : /* Verify that if we mark a pointer to a malloc-ed region as non-NULL,
9291 : : all cast pointers to that region are also known to be non-NULL. */
9292 : :
9293 : : static void
9294 : 4 : test_malloc_constraints ()
9295 : : {
9296 : 4 : region_model_manager mgr;
9297 : 4 : region_model model (&mgr);
9298 : 4 : tree p = build_global_decl ("p", ptr_type_node);
9299 : 4 : tree char_star = build_pointer_type (char_type_node);
9300 : 4 : tree q = build_global_decl ("q", char_star);
9301 : 4 : tree null_ptr = build_int_cst (ptr_type_node, 0);
9302 : :
9303 : 4 : const svalue *size_in_bytes
9304 : 4 : = mgr.get_or_create_unknown_svalue (size_type_node);
9305 : 4 : const region *reg
9306 : 4 : = model.get_or_create_region_for_heap_alloc (size_in_bytes, NULL);
9307 : 4 : const svalue *sval = mgr.get_ptr_svalue (ptr_type_node, reg);
9308 : 4 : model.set_value (model.get_lvalue (p, NULL), sval, NULL);
9309 : 4 : model.set_value (q, p, NULL);
9310 : :
9311 : 4 : ASSERT_CONDITION_UNKNOWN (model, p, NE_EXPR, null_ptr);
9312 : 4 : ASSERT_CONDITION_UNKNOWN (model, p, EQ_EXPR, null_ptr);
9313 : 4 : ASSERT_CONDITION_UNKNOWN (model, q, NE_EXPR, null_ptr);
9314 : 4 : ASSERT_CONDITION_UNKNOWN (model, q, EQ_EXPR, null_ptr);
9315 : :
9316 : 4 : model.add_constraint (p, NE_EXPR, null_ptr, NULL);
9317 : :
9318 : 4 : ASSERT_CONDITION_TRUE (model, p, NE_EXPR, null_ptr);
9319 : 4 : ASSERT_CONDITION_FALSE (model, p, EQ_EXPR, null_ptr);
9320 : 4 : ASSERT_CONDITION_TRUE (model, q, NE_EXPR, null_ptr);
9321 : 4 : ASSERT_CONDITION_FALSE (model, q, EQ_EXPR, null_ptr);
9322 : 4 : }
9323 : :
9324 : : /* Smoketest of getting and setting the value of a variable. */
9325 : :
9326 : : static void
9327 : 4 : test_var ()
9328 : : {
9329 : : /* "int i;" */
9330 : 4 : tree i = build_global_decl ("i", integer_type_node);
9331 : :
9332 : 4 : tree int_17 = build_int_cst (integer_type_node, 17);
9333 : 4 : tree int_m3 = build_int_cst (integer_type_node, -3);
9334 : :
9335 : 4 : region_model_manager mgr;
9336 : 4 : region_model model (&mgr);
9337 : :
9338 : 4 : const region *i_reg = model.get_lvalue (i, NULL);
9339 : 4 : ASSERT_EQ (i_reg->get_kind (), RK_DECL);
9340 : :
9341 : : /* Reading "i" should give a symbolic "initial value". */
9342 : 4 : const svalue *sval_init = model.get_rvalue (i, NULL);
9343 : 4 : ASSERT_EQ (sval_init->get_kind (), SK_INITIAL);
9344 : 4 : ASSERT_EQ (sval_init->dyn_cast_initial_svalue ()->get_region (), i_reg);
9345 : : /* ..and doing it again should give the same "initial value". */
9346 : 4 : ASSERT_EQ (model.get_rvalue (i, NULL), sval_init);
9347 : :
9348 : : /* "i = 17;". */
9349 : 4 : model.set_value (i, int_17, NULL);
9350 : 4 : ASSERT_EQ (model.get_rvalue (i, NULL),
9351 : : model.get_rvalue (int_17, NULL));
9352 : :
9353 : : /* "i = -3;". */
9354 : 4 : model.set_value (i, int_m3, NULL);
9355 : 4 : ASSERT_EQ (model.get_rvalue (i, NULL),
9356 : : model.get_rvalue (int_m3, NULL));
9357 : :
9358 : : /* Verify get_offset for "i". */
9359 : 4 : {
9360 : 4 : region_offset offset = i_reg->get_offset (&mgr);
9361 : 4 : ASSERT_EQ (offset.get_base_region (), i_reg);
9362 : 4 : ASSERT_EQ (offset.get_bit_offset (), 0);
9363 : : }
9364 : 4 : }
9365 : :
9366 : : static void
9367 : 4 : test_array_2 ()
9368 : : {
9369 : : /* "int arr[10];" */
9370 : 4 : tree tlen = size_int (10);
9371 : 4 : tree arr_type
9372 : 4 : = build_array_type (integer_type_node, build_index_type (tlen));
9373 : 4 : tree arr = build_global_decl ("arr", arr_type);
9374 : :
9375 : : /* "int i;" */
9376 : 4 : tree i = build_global_decl ("i", integer_type_node);
9377 : :
9378 : 4 : tree int_0 = integer_zero_node;
9379 : 4 : tree int_1 = integer_one_node;
9380 : :
9381 : 4 : tree arr_0 = build4 (ARRAY_REF, integer_type_node,
9382 : : arr, int_0, NULL_TREE, NULL_TREE);
9383 : 4 : tree arr_1 = build4 (ARRAY_REF, integer_type_node,
9384 : : arr, int_1, NULL_TREE, NULL_TREE);
9385 : 4 : tree arr_i = build4 (ARRAY_REF, integer_type_node,
9386 : : arr, i, NULL_TREE, NULL_TREE);
9387 : :
9388 : 4 : tree int_17 = build_int_cst (integer_type_node, 17);
9389 : 4 : tree int_42 = build_int_cst (integer_type_node, 42);
9390 : 4 : tree int_m3 = build_int_cst (integer_type_node, -3);
9391 : :
9392 : 4 : region_model_manager mgr;
9393 : 4 : region_model model (&mgr);
9394 : : /* "arr[0] = 17;". */
9395 : 4 : model.set_value (arr_0, int_17, NULL);
9396 : : /* "arr[1] = -3;". */
9397 : 4 : model.set_value (arr_1, int_m3, NULL);
9398 : :
9399 : 4 : ASSERT_EQ (model.get_rvalue (arr_0, NULL), model.get_rvalue (int_17, NULL));
9400 : 4 : ASSERT_EQ (model.get_rvalue (arr_1, NULL), model.get_rvalue (int_m3, NULL));
9401 : :
9402 : : /* Overwrite a pre-existing binding: "arr[1] = 42;". */
9403 : 4 : model.set_value (arr_1, int_42, NULL);
9404 : 4 : ASSERT_EQ (model.get_rvalue (arr_1, NULL), model.get_rvalue (int_42, NULL));
9405 : :
9406 : : /* Verify get_offset for "arr[0]". */
9407 : 4 : {
9408 : 4 : const region *arr_0_reg = model.get_lvalue (arr_0, NULL);
9409 : 4 : region_offset offset = arr_0_reg->get_offset (&mgr);
9410 : 4 : ASSERT_EQ (offset.get_base_region (), model.get_lvalue (arr, NULL));
9411 : 4 : ASSERT_EQ (offset.get_bit_offset (), 0);
9412 : : }
9413 : :
9414 : : /* Verify get_offset for "arr[1]". */
9415 : 4 : {
9416 : 4 : const region *arr_1_reg = model.get_lvalue (arr_1, NULL);
9417 : 4 : region_offset offset = arr_1_reg->get_offset (&mgr);
9418 : 4 : ASSERT_EQ (offset.get_base_region (), model.get_lvalue (arr, NULL));
9419 : 4 : ASSERT_EQ (offset.get_bit_offset (), INT_TYPE_SIZE);
9420 : : }
9421 : :
9422 : : /* Verify get_offset for "arr[i]". */
9423 : 4 : {
9424 : 4 : const region *arr_i_reg = model.get_lvalue (arr_i, NULL);
9425 : 4 : region_offset offset = arr_i_reg->get_offset (&mgr);
9426 : 4 : ASSERT_EQ (offset.get_base_region (), model.get_lvalue (arr, NULL));
9427 : 4 : const svalue *offset_sval = offset.get_symbolic_byte_offset ();
9428 : 4 : if (const svalue *cast = offset_sval->maybe_undo_cast ())
9429 : 4 : offset_sval = cast;
9430 : 4 : ASSERT_EQ (offset_sval->get_kind (), SK_BINOP);
9431 : : }
9432 : :
9433 : : /* "arr[i] = i;" - this should remove the earlier bindings. */
9434 : 4 : model.set_value (arr_i, i, NULL);
9435 : 4 : ASSERT_EQ (model.get_rvalue (arr_i, NULL), model.get_rvalue (i, NULL));
9436 : 4 : ASSERT_EQ (model.get_rvalue (arr_0, NULL)->get_kind (), SK_UNKNOWN);
9437 : :
9438 : : /* "arr[0] = 17;" - this should remove the arr[i] binding. */
9439 : 4 : model.set_value (arr_0, int_17, NULL);
9440 : 4 : ASSERT_EQ (model.get_rvalue (arr_0, NULL), model.get_rvalue (int_17, NULL));
9441 : 4 : ASSERT_EQ (model.get_rvalue (arr_i, NULL)->get_kind (), SK_UNKNOWN);
9442 : 4 : }
9443 : :
9444 : : /* Smoketest of dereferencing a pointer via MEM_REF. */
9445 : :
9446 : : static void
9447 : 4 : test_mem_ref ()
9448 : : {
9449 : : /*
9450 : : x = 17;
9451 : : p = &x;
9452 : : *p;
9453 : : */
9454 : 4 : tree x = build_global_decl ("x", integer_type_node);
9455 : 4 : tree int_star = build_pointer_type (integer_type_node);
9456 : 4 : tree p = build_global_decl ("p", int_star);
9457 : :
9458 : 4 : tree int_17 = build_int_cst (integer_type_node, 17);
9459 : 4 : tree addr_of_x = build1 (ADDR_EXPR, int_star, x);
9460 : 4 : tree ptype = build_pointer_type_for_mode (char_type_node, ptr_mode, true);
9461 : 4 : tree offset_0 = build_int_cst (ptype, 0);
9462 : 4 : tree star_p = build2 (MEM_REF, integer_type_node, p, offset_0);
9463 : :
9464 : 4 : region_model_manager mgr;
9465 : 4 : region_model model (&mgr);
9466 : :
9467 : : /* "x = 17;". */
9468 : 4 : model.set_value (x, int_17, NULL);
9469 : :
9470 : : /* "p = &x;". */
9471 : 4 : model.set_value (p, addr_of_x, NULL);
9472 : :
9473 : 4 : const svalue *sval = model.get_rvalue (star_p, NULL);
9474 : 4 : ASSERT_EQ (sval->maybe_get_constant (), int_17);
9475 : 4 : }
9476 : :
9477 : : /* Test for a POINTER_PLUS_EXPR followed by a MEM_REF.
9478 : : Analogous to this code:
9479 : : void test_6 (int a[10])
9480 : : {
9481 : : __analyzer_eval (a[3] == 42); [should be UNKNOWN]
9482 : : a[3] = 42;
9483 : : __analyzer_eval (a[3] == 42); [should be TRUE]
9484 : : }
9485 : : from data-model-1.c, which looks like this at the gimple level:
9486 : : # __analyzer_eval (a[3] == 42); [should be UNKNOWN]
9487 : : int *_1 = a_10(D) + 12; # POINTER_PLUS_EXPR
9488 : : int _2 = *_1; # MEM_REF
9489 : : _Bool _3 = _2 == 42;
9490 : : int _4 = (int) _3;
9491 : : __analyzer_eval (_4);
9492 : :
9493 : : # a[3] = 42;
9494 : : int *_5 = a_10(D) + 12; # POINTER_PLUS_EXPR
9495 : : *_5 = 42; # MEM_REF
9496 : :
9497 : : # __analyzer_eval (a[3] == 42); [should be TRUE]
9498 : : int *_6 = a_10(D) + 12; # POINTER_PLUS_EXPR
9499 : : int _7 = *_6; # MEM_REF
9500 : : _Bool _8 = _7 == 42;
9501 : : int _9 = (int) _8;
9502 : : __analyzer_eval (_9); */
9503 : :
9504 : : static void
9505 : 4 : test_POINTER_PLUS_EXPR_then_MEM_REF ()
9506 : : {
9507 : 4 : tree int_star = build_pointer_type (integer_type_node);
9508 : 4 : tree a = build_global_decl ("a", int_star);
9509 : 4 : tree offset_12 = build_int_cst (size_type_node, 12);
9510 : 4 : tree pointer_plus_expr = build2 (POINTER_PLUS_EXPR, int_star, a, offset_12);
9511 : 4 : tree ptype = build_pointer_type_for_mode (char_type_node, ptr_mode, true);
9512 : 4 : tree offset_0 = build_int_cst (ptype, 0);
9513 : 4 : tree mem_ref = build2 (MEM_REF, integer_type_node,
9514 : : pointer_plus_expr, offset_0);
9515 : 4 : region_model_manager mgr;
9516 : 4 : region_model m (&mgr);
9517 : :
9518 : 4 : tree int_42 = build_int_cst (integer_type_node, 42);
9519 : 4 : m.set_value (mem_ref, int_42, NULL);
9520 : 4 : ASSERT_EQ (m.get_rvalue (mem_ref, NULL)->maybe_get_constant (), int_42);
9521 : 4 : }
9522 : :
9523 : : /* Verify that malloc works. */
9524 : :
9525 : : static void
9526 : 4 : test_malloc ()
9527 : : {
9528 : 4 : tree int_star = build_pointer_type (integer_type_node);
9529 : 4 : tree p = build_global_decl ("p", int_star);
9530 : 4 : tree n = build_global_decl ("n", integer_type_node);
9531 : 4 : tree n_times_4 = build2 (MULT_EXPR, size_type_node,
9532 : 4 : n, build_int_cst (size_type_node, 4));
9533 : :
9534 : 4 : region_model_manager mgr;
9535 : 4 : test_region_model_context ctxt;
9536 : 4 : region_model model (&mgr);
9537 : :
9538 : : /* "p = malloc (n * 4);". */
9539 : 4 : const svalue *size_sval = model.get_rvalue (n_times_4, &ctxt);
9540 : 4 : const region *reg
9541 : 4 : = model.get_or_create_region_for_heap_alloc (size_sval, &ctxt);
9542 : 4 : const svalue *ptr = mgr.get_ptr_svalue (int_star, reg);
9543 : 4 : model.set_value (model.get_lvalue (p, &ctxt), ptr, &ctxt);
9544 : 4 : ASSERT_EQ (model.get_capacity (reg), size_sval);
9545 : 4 : }
9546 : :
9547 : : /* Verify that alloca works. */
9548 : :
9549 : : static void
9550 : 4 : test_alloca ()
9551 : : {
9552 : 4 : auto_vec <tree> param_types;
9553 : 4 : tree fndecl = make_fndecl (integer_type_node,
9554 : : "test_fn",
9555 : : param_types);
9556 : 4 : allocate_struct_function (fndecl, true);
9557 : :
9558 : :
9559 : 4 : tree int_star = build_pointer_type (integer_type_node);
9560 : 4 : tree p = build_global_decl ("p", int_star);
9561 : 4 : tree n = build_global_decl ("n", integer_type_node);
9562 : 4 : tree n_times_4 = build2 (MULT_EXPR, size_type_node,
9563 : 4 : n, build_int_cst (size_type_node, 4));
9564 : :
9565 : 4 : region_model_manager mgr;
9566 : 4 : test_region_model_context ctxt;
9567 : 4 : region_model model (&mgr);
9568 : :
9569 : : /* Push stack frame. */
9570 : 4 : const region *frame_reg
9571 : 4 : = model.push_frame (*DECL_STRUCT_FUNCTION (fndecl),
9572 : : NULL, &ctxt);
9573 : : /* "p = alloca (n * 4);". */
9574 : 4 : const svalue *size_sval = model.get_rvalue (n_times_4, &ctxt);
9575 : 4 : const region *reg = model.create_region_for_alloca (size_sval, &ctxt);
9576 : 4 : ASSERT_EQ (reg->get_parent_region (), frame_reg);
9577 : 4 : const svalue *ptr = mgr.get_ptr_svalue (int_star, reg);
9578 : 4 : model.set_value (model.get_lvalue (p, &ctxt), ptr, &ctxt);
9579 : 4 : ASSERT_EQ (model.get_capacity (reg), size_sval);
9580 : :
9581 : : /* Verify that the pointers to the alloca region are replaced by
9582 : : poisoned values when the frame is popped. */
9583 : 4 : model.pop_frame (NULL, NULL, &ctxt, nullptr);
9584 : 4 : ASSERT_EQ (model.get_rvalue (p, NULL)->get_kind (), SK_POISONED);
9585 : 4 : }
9586 : :
9587 : : /* Verify that svalue::involves_p works. */
9588 : :
9589 : : static void
9590 : 4 : test_involves_p ()
9591 : : {
9592 : 4 : region_model_manager mgr;
9593 : 4 : tree int_star = build_pointer_type (integer_type_node);
9594 : 4 : tree p = build_global_decl ("p", int_star);
9595 : 4 : tree q = build_global_decl ("q", int_star);
9596 : :
9597 : 4 : test_region_model_context ctxt;
9598 : 4 : region_model model (&mgr);
9599 : 4 : const svalue *p_init = model.get_rvalue (p, &ctxt);
9600 : 4 : const svalue *q_init = model.get_rvalue (q, &ctxt);
9601 : :
9602 : 4 : ASSERT_TRUE (p_init->involves_p (p_init));
9603 : 4 : ASSERT_FALSE (p_init->involves_p (q_init));
9604 : :
9605 : 4 : const region *star_p_reg = mgr.get_symbolic_region (p_init);
9606 : 4 : const region *star_q_reg = mgr.get_symbolic_region (q_init);
9607 : :
9608 : 4 : const svalue *init_star_p = mgr.get_or_create_initial_value (star_p_reg);
9609 : 4 : const svalue *init_star_q = mgr.get_or_create_initial_value (star_q_reg);
9610 : :
9611 : 4 : ASSERT_TRUE (init_star_p->involves_p (p_init));
9612 : 4 : ASSERT_FALSE (p_init->involves_p (init_star_p));
9613 : 4 : ASSERT_FALSE (init_star_p->involves_p (q_init));
9614 : 4 : ASSERT_TRUE (init_star_q->involves_p (q_init));
9615 : 4 : ASSERT_FALSE (init_star_q->involves_p (p_init));
9616 : 4 : }
9617 : :
9618 : : /* Run all of the selftests within this file. */
9619 : :
9620 : : void
9621 : 4 : analyzer_region_model_cc_tests ()
9622 : : {
9623 : 4 : test_tree_cmp_on_constants ();
9624 : 4 : test_dump ();
9625 : 4 : test_struct ();
9626 : 4 : test_array_1 ();
9627 : 4 : test_get_representative_tree ();
9628 : 4 : test_unique_constants ();
9629 : 4 : test_unique_unknowns ();
9630 : 4 : test_initial_svalue_folding ();
9631 : 4 : test_unaryop_svalue_folding ();
9632 : 4 : test_binop_svalue_folding ();
9633 : 4 : test_sub_svalue_folding ();
9634 : 4 : test_bits_within_svalue_folding ();
9635 : 4 : test_descendent_of_p ();
9636 : 4 : test_bit_range_regions ();
9637 : 4 : test_assignment ();
9638 : 4 : test_compound_assignment ();
9639 : 4 : test_stack_frames ();
9640 : 4 : test_get_representative_path_var ();
9641 : 4 : test_equality_1 ();
9642 : 4 : test_canonicalization_2 ();
9643 : 4 : test_canonicalization_3 ();
9644 : 4 : test_canonicalization_4 ();
9645 : 4 : test_state_merging ();
9646 : 4 : test_constraint_merging ();
9647 : 4 : test_widening_constraints ();
9648 : 4 : test_iteration_1 ();
9649 : 4 : test_malloc_constraints ();
9650 : 4 : test_var ();
9651 : 4 : test_array_2 ();
9652 : 4 : test_mem_ref ();
9653 : 4 : test_POINTER_PLUS_EXPR_then_MEM_REF ();
9654 : 4 : test_malloc ();
9655 : 4 : test_alloca ();
9656 : 4 : test_involves_p ();
9657 : 4 : }
9658 : :
9659 : : } // namespace selftest
9660 : :
9661 : : #endif /* CHECKING_P */
9662 : :
9663 : : } // namespace ana
9664 : :
9665 : : #endif /* #if ENABLE_ANALYZER */
|
