Fix gnat.dg/opt39.adb on hppa.
[official-gcc.git] / gcc / gimple-ssa-warn-access.cc
blobb3de4b779245e326a053e18e01b3e5e5c1d74efb
1 /* Pass to detect and issue warnings for invalid accesses, including
2 invalid or mismatched allocation/deallocation calls.
4 Copyright (C) 2020-2023 Free Software Foundation, Inc.
5 Contributed by Martin Sebor <msebor@redhat.com>.
7 This file is part of GCC.
9 GCC is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free
11 Software Foundation; either version 3, or (at your option) any later
12 version.
14 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
15 WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 for more details.
19 You should have received a copy of the GNU General Public License
20 along with GCC; see the file COPYING3. If not see
21 <http://www.gnu.org/licenses/>. */
23 #define INCLUDE_STRING
24 #include "config.h"
25 #include "system.h"
26 #include "coretypes.h"
27 #include "backend.h"
28 #include "tree.h"
29 #include "gimple.h"
30 #include "tree-pass.h"
31 #include "builtins.h"
32 #include "diagnostic.h"
33 #include "ssa.h"
34 #include "gimple-pretty-print.h"
35 #include "gimple-ssa-warn-access.h"
36 #include "gimple-ssa-warn-restrict.h"
37 #include "diagnostic-core.h"
38 #include "fold-const.h"
39 #include "gimple-iterator.h"
40 #include "gimple-fold.h"
41 #include "langhooks.h"
42 #include "memmodel.h"
43 #include "target.h"
44 #include "tree-dfa.h"
45 #include "tree-ssa.h"
46 #include "tree-cfg.h"
47 #include "tree-object-size.h"
48 #include "tree-ssa-strlen.h"
49 #include "calls.h"
50 #include "cfganal.h"
51 #include "intl.h"
52 #include "gimple-range.h"
53 #include "stringpool.h"
54 #include "attribs.h"
55 #include "demangle.h"
56 #include "attr-fnspec.h"
57 #include "pointer-query.h"
59 /* Return true if tree node X has an associated location. */
61 static inline location_t
62 has_location (const_tree x)
64 if (DECL_P (x))
65 return DECL_SOURCE_LOCATION (x) != UNKNOWN_LOCATION;
67 if (EXPR_P (x))
68 return EXPR_HAS_LOCATION (x);
70 return false;
73 /* Return the associated location of STMT. */
75 static inline location_t
76 get_location (const gimple *stmt)
78 return gimple_location (stmt);
81 /* Return the associated location of tree node X. */
83 static inline location_t
84 get_location (tree x)
86 if (DECL_P (x))
87 return DECL_SOURCE_LOCATION (x);
89 if (EXPR_P (x))
90 return EXPR_LOCATION (x);
92 return UNKNOWN_LOCATION;
95 /* Overload of the nascent tree function for GIMPLE STMT. */
97 static inline tree
98 get_callee_fndecl (const gimple *stmt)
100 return gimple_call_fndecl (stmt);
103 static inline unsigned
104 call_nargs (const gimple *stmt)
106 return gimple_call_num_args (stmt);
109 static inline unsigned
110 call_nargs (const_tree expr)
112 return call_expr_nargs (expr);
116 static inline tree
117 call_arg (const gimple *stmt, unsigned argno)
119 return gimple_call_arg (stmt, argno);
122 static inline tree
123 call_arg (tree expr, unsigned argno)
125 return CALL_EXPR_ARG (expr, argno);
128 /* For a call EXPR at LOC to a function FNAME that expects a string
129 in the argument ARG, issue a diagnostic due to it being a called
130 with an argument that is a character array with no terminating
131 NUL. SIZE is the EXACT size of the array, and BNDRNG the number
132 of characters in which the NUL is expected. Either EXPR or FNAME
133 may be null but noth both. SIZE may be null when BNDRNG is null. */
135 template <class GimpleOrTree>
136 static void
137 warn_string_no_nul (location_t loc, GimpleOrTree expr, const char *fname,
138 tree arg, tree decl, tree size, bool exact,
139 const wide_int bndrng[2] /* = NULL */)
141 const opt_code opt = OPT_Wstringop_overread;
142 if ((expr && warning_suppressed_p (expr, opt))
143 || warning_suppressed_p (arg, opt))
144 return;
146 loc = expansion_point_location_if_in_system_header (loc);
147 bool warned;
149 /* Format the bound range as a string to keep the number of messages
150 from exploding. */
151 char bndstr[80];
152 *bndstr = 0;
153 if (bndrng)
155 if (bndrng[0] == bndrng[1])
156 sprintf (bndstr, "%llu", (unsigned long long) bndrng[0].to_uhwi ());
157 else
158 sprintf (bndstr, "[%llu, %llu]",
159 (unsigned long long) bndrng[0].to_uhwi (),
160 (unsigned long long) bndrng[1].to_uhwi ());
163 auto_diagnostic_group d;
165 const tree maxobjsize = max_object_size ();
166 const wide_int maxsiz = wi::to_wide (maxobjsize);
167 if (expr)
169 tree func = get_callee_fndecl (expr);
170 if (bndrng)
172 if (wi::ltu_p (maxsiz, bndrng[0]))
173 warned = warning_at (loc, opt,
174 "%qD specified bound %s exceeds "
175 "maximum object size %E",
176 func, bndstr, maxobjsize);
177 else
179 bool maybe = wi::to_wide (size) == bndrng[0];
180 warned = warning_at (loc, opt,
181 exact
182 ? G_("%qD specified bound %s exceeds "
183 "the size %E of unterminated array")
184 : (maybe
185 ? G_("%qD specified bound %s may "
186 "exceed the size of at most %E "
187 "of unterminated array")
188 : G_("%qD specified bound %s exceeds "
189 "the size of at most %E "
190 "of unterminated array")),
191 func, bndstr, size);
194 else
195 warned = warning_at (loc, opt,
196 "%qD argument missing terminating nul",
197 func);
199 else
201 if (bndrng)
203 if (wi::ltu_p (maxsiz, bndrng[0]))
204 warned = warning_at (loc, opt,
205 "%qs specified bound %s exceeds "
206 "maximum object size %E",
207 fname, bndstr, maxobjsize);
208 else
210 bool maybe = wi::to_wide (size) == bndrng[0];
211 warned = warning_at (loc, opt,
212 exact
213 ? G_("%qs specified bound %s exceeds "
214 "the size %E of unterminated array")
215 : (maybe
216 ? G_("%qs specified bound %s may "
217 "exceed the size of at most %E "
218 "of unterminated array")
219 : G_("%qs specified bound %s exceeds "
220 "the size of at most %E "
221 "of unterminated array")),
222 fname, bndstr, size);
225 else
226 warned = warning_at (loc, opt,
227 "%qs argument missing terminating nul",
228 fname);
231 if (warned)
233 inform (get_location (decl),
234 "referenced argument declared here");
235 suppress_warning (arg, opt);
236 if (expr)
237 suppress_warning (expr, opt);
241 void
242 warn_string_no_nul (location_t loc, gimple *stmt, const char *fname,
243 tree arg, tree decl, tree size /* = NULL_TREE */,
244 bool exact /* = false */,
245 const wide_int bndrng[2] /* = NULL */)
247 return warn_string_no_nul<gimple *> (loc, stmt, fname,
248 arg, decl, size, exact, bndrng);
251 void
252 warn_string_no_nul (location_t loc, tree expr, const char *fname,
253 tree arg, tree decl, tree size /* = NULL_TREE */,
254 bool exact /* = false */,
255 const wide_int bndrng[2] /* = NULL */)
257 return warn_string_no_nul<tree> (loc, expr, fname,
258 arg, decl, size, exact, bndrng);
261 /* If EXP refers to an unterminated constant character array return
262 the declaration of the object of which the array is a member or
263 element and if SIZE is not null, set *SIZE to the size of
264 the unterminated array and set *EXACT if the size is exact or
265 clear it otherwise. Otherwise return null. */
267 tree
268 unterminated_array (tree exp, tree *size /* = NULL */, bool *exact /* = NULL */)
270 /* C_STRLEN will return NULL and set DECL in the info
271 structure if EXP references a unterminated array. */
272 c_strlen_data lendata = { };
273 tree len = c_strlen (exp, 1, &lendata);
274 if (len || !lendata.minlen || !lendata.decl)
275 return NULL_TREE;
277 if (!size)
278 return lendata.decl;
280 len = lendata.minlen;
281 if (lendata.off)
283 /* Constant offsets are already accounted for in LENDATA.MINLEN,
284 but not in a SSA_NAME + CST expression. */
285 if (TREE_CODE (lendata.off) == INTEGER_CST)
286 *exact = true;
287 else if (TREE_CODE (lendata.off) == PLUS_EXPR
288 && TREE_CODE (TREE_OPERAND (lendata.off, 1)) == INTEGER_CST)
290 /* Subtract the offset from the size of the array. */
291 *exact = false;
292 tree temp = TREE_OPERAND (lendata.off, 1);
293 temp = fold_convert (ssizetype, temp);
294 len = fold_build2 (MINUS_EXPR, ssizetype, len, temp);
296 else
297 *exact = false;
299 else
300 *exact = true;
302 *size = len;
303 return lendata.decl;
306 /* For a call EXPR (which may be null) that expects a string argument
307 SRC as an argument, returns false if SRC is a character array with
308 no terminating NUL. When nonnull, BOUND is the number of characters
309 in which to expect the terminating NUL. When EXPR is nonnull also
310 issues a warning. */
312 template <class GimpleOrTree>
313 static bool
314 check_nul_terminated_array (GimpleOrTree expr, tree src, tree bound)
316 /* The constant size of the array SRC points to. The actual size
317 may be less of EXACT is true, but not more. */
318 tree size;
319 /* True if SRC involves a non-constant offset into the array. */
320 bool exact;
321 /* The unterminated constant array SRC points to. */
322 tree nonstr = unterminated_array (src, &size, &exact);
323 if (!nonstr)
324 return true;
326 /* NONSTR refers to the non-nul terminated constant array and SIZE
327 is the constant size of the array in bytes. EXACT is true when
328 SIZE is exact. */
330 wide_int bndrng[2];
331 if (bound)
333 Value_Range r (TREE_TYPE (bound));
335 get_global_range_query ()->range_of_expr (r, bound);
337 if (r.undefined_p () || r.varying_p ())
338 return true;
340 bndrng[0] = r.lower_bound ();
341 bndrng[1] = r.upper_bound ();
343 if (exact)
345 if (wi::leu_p (bndrng[0], wi::to_wide (size)))
346 return true;
348 else if (wi::lt_p (bndrng[0], wi::to_wide (size), UNSIGNED))
349 return true;
352 if (expr)
353 warn_string_no_nul (get_location (expr), expr, NULL, src, nonstr,
354 size, exact, bound ? bndrng : NULL);
356 return false;
359 bool
360 check_nul_terminated_array (gimple *stmt, tree src, tree bound /* = NULL_TREE */)
362 return check_nul_terminated_array<gimple *>(stmt, src, bound);
365 bool
366 check_nul_terminated_array (tree expr, tree src, tree bound /* = NULL_TREE */)
368 return check_nul_terminated_array<tree>(expr, src, bound);
371 /* Warn about passing a non-string array/pointer to a built-in function
372 that expects a nul-terminated string argument. Returns true if
373 a warning has been issued.*/
375 template <class GimpleOrTree>
376 static bool
377 maybe_warn_nonstring_arg (tree fndecl, GimpleOrTree exp)
379 if (!fndecl || !fndecl_built_in_p (fndecl, BUILT_IN_NORMAL))
380 return false;
382 if (!warn_stringop_overread
383 || warning_suppressed_p (exp, OPT_Wstringop_overread))
384 return false;
386 /* Avoid clearly invalid calls (more checking done below). */
387 unsigned nargs = call_nargs (exp);
388 if (!nargs)
389 return false;
391 /* The bound argument to a bounded string function like strncpy. */
392 tree bound = NULL_TREE;
394 /* The longest known or possible string argument to one of the comparison
395 functions. If the length is less than the bound it is used instead.
396 Since the length is only used for warning and not for code generation
397 disable strict mode in the calls to get_range_strlen below. */
398 tree maxlen = NULL_TREE;
400 /* It's safe to call "bounded" string functions with a non-string
401 argument since the functions provide an explicit bound for this
402 purpose. The exception is strncat where the bound may refer to
403 either the destination or the source. */
404 int fncode = DECL_FUNCTION_CODE (fndecl);
405 switch (fncode)
407 case BUILT_IN_STRCMP:
408 case BUILT_IN_STRNCMP:
409 case BUILT_IN_STRNCASECMP:
411 /* For these, if one argument refers to one or more of a set
412 of string constants or arrays of known size, determine
413 the range of their known or possible lengths and use it
414 conservatively as the bound for the unbounded function,
415 and to adjust the range of the bound of the bounded ones. */
416 for (unsigned argno = 0;
417 argno < MIN (nargs, 2)
418 && !(maxlen && TREE_CODE (maxlen) == INTEGER_CST); argno++)
420 tree arg = call_arg (exp, argno);
421 if (!get_attr_nonstring_decl (arg))
423 c_strlen_data lendata = { };
424 /* Set MAXBOUND to an arbitrary non-null non-integer
425 node as a request to have it set to the length of
426 the longest string in a PHI. */
427 lendata.maxbound = arg;
428 get_range_strlen (arg, &lendata, /* eltsize = */ 1);
429 maxlen = lendata.maxbound;
433 /* Fall through. */
435 case BUILT_IN_STRNCAT:
436 case BUILT_IN_STPNCPY:
437 case BUILT_IN_STRNCPY:
438 if (nargs > 2)
439 bound = call_arg (exp, 2);
440 break;
442 case BUILT_IN_STRNDUP:
443 if (nargs < 2)
444 return false;
445 bound = call_arg (exp, 1);
446 break;
448 case BUILT_IN_STRNLEN:
450 tree arg = call_arg (exp, 0);
451 if (!get_attr_nonstring_decl (arg))
453 c_strlen_data lendata = { };
454 /* Set MAXBOUND to an arbitrary non-null non-integer
455 node as a request to have it set to the length of
456 the longest string in a PHI. */
457 lendata.maxbound = arg;
458 get_range_strlen (arg, &lendata, /* eltsize = */ 1);
459 maxlen = lendata.maxbound;
461 if (nargs > 1)
462 bound = call_arg (exp, 1);
463 break;
466 default:
467 break;
470 /* Determine the range of the bound argument (if specified). */
471 tree bndrng[2] = { NULL_TREE, NULL_TREE };
472 if (bound)
474 STRIP_NOPS (bound);
475 get_size_range (bound, bndrng);
478 location_t loc = get_location (exp);
480 if (bndrng[0])
482 /* Diagnose excessive bound prior to the adjustment below and
483 regardless of attribute nonstring. */
484 tree maxobjsize = max_object_size ();
485 if (tree_int_cst_lt (maxobjsize, bndrng[0]))
487 bool warned = false;
488 if (tree_int_cst_equal (bndrng[0], bndrng[1]))
489 warned = warning_at (loc, OPT_Wstringop_overread,
490 "%qD specified bound %E "
491 "exceeds maximum object size %E",
492 fndecl, bndrng[0], maxobjsize);
493 else
494 warned = warning_at (loc, OPT_Wstringop_overread,
495 "%qD specified bound [%E, %E] "
496 "exceeds maximum object size %E",
497 fndecl, bndrng[0], bndrng[1],
498 maxobjsize);
499 if (warned)
500 suppress_warning (exp, OPT_Wstringop_overread);
502 return warned;
506 if (maxlen && !integer_all_onesp (maxlen))
508 /* Add one for the nul. */
509 maxlen = const_binop (PLUS_EXPR, TREE_TYPE (maxlen), maxlen,
510 size_one_node);
512 if (!bndrng[0])
514 /* Conservatively use the upper bound of the lengths for
515 both the lower and the upper bound of the operation. */
516 bndrng[0] = maxlen;
517 bndrng[1] = maxlen;
518 bound = void_type_node;
520 else if (maxlen)
522 /* Replace the bound on the operation with the upper bound
523 of the length of the string if the latter is smaller. */
524 if (tree_int_cst_lt (maxlen, bndrng[0]))
525 bndrng[0] = maxlen;
526 else if (tree_int_cst_lt (maxlen, bndrng[1]))
527 bndrng[1] = maxlen;
531 bool any_arg_warned = false;
532 /* Iterate over the built-in function's formal arguments and check
533 each const char* against the actual argument. If the actual
534 argument is declared attribute non-string issue a warning unless
535 the argument's maximum length is bounded. */
536 function_args_iterator it;
537 function_args_iter_init (&it, TREE_TYPE (fndecl));
539 for (unsigned argno = 0; ; ++argno, function_args_iter_next (&it))
541 /* Avoid iterating past the declared argument in a call
542 to function declared without a prototype. */
543 if (argno >= nargs)
544 break;
546 tree argtype = function_args_iter_cond (&it);
547 if (!argtype)
548 break;
550 if (TREE_CODE (argtype) != POINTER_TYPE)
551 continue;
553 argtype = TREE_TYPE (argtype);
555 if (TREE_CODE (argtype) != INTEGER_TYPE
556 || !TYPE_READONLY (argtype))
557 continue;
559 argtype = TYPE_MAIN_VARIANT (argtype);
560 if (argtype != char_type_node)
561 continue;
563 tree callarg = call_arg (exp, argno);
564 if (TREE_CODE (callarg) == ADDR_EXPR)
565 callarg = TREE_OPERAND (callarg, 0);
567 /* See if the destination is declared with attribute "nonstring". */
568 tree decl = get_attr_nonstring_decl (callarg);
569 if (!decl)
570 continue;
572 /* The maximum number of array elements accessed. */
573 offset_int wibnd = 0;
575 if (argno && fncode == BUILT_IN_STRNCAT)
577 /* See if the bound in strncat is derived from the length
578 of the strlen of the destination (as it's expected to be).
579 If so, reset BOUND and FNCODE to trigger a warning. */
580 tree dstarg = call_arg (exp, 0);
581 if (is_strlen_related_p (dstarg, bound))
583 /* The bound applies to the destination, not to the source,
584 so reset these to trigger a warning without mentioning
585 the bound. */
586 bound = NULL;
587 fncode = 0;
589 else if (bndrng[1])
590 /* Use the upper bound of the range for strncat. */
591 wibnd = wi::to_offset (bndrng[1]);
593 else if (bndrng[0])
594 /* Use the lower bound of the range for functions other than
595 strncat. */
596 wibnd = wi::to_offset (bndrng[0]);
598 /* Determine the size of the argument array if it is one. */
599 offset_int asize = wibnd;
600 bool known_size = false;
601 tree type = TREE_TYPE (decl);
603 /* Determine the array size. For arrays of unknown bound and
604 pointers reset BOUND to trigger the appropriate warning. */
605 if (TREE_CODE (type) == ARRAY_TYPE)
607 if (tree arrbnd = TYPE_DOMAIN (type))
609 if ((arrbnd = TYPE_MAX_VALUE (arrbnd)))
611 asize = wi::to_offset (arrbnd) + 1;
612 known_size = true;
615 else if (bound == void_type_node)
616 bound = NULL_TREE;
618 else if (bound == void_type_node)
619 bound = NULL_TREE;
621 /* In a call to strncat with a bound in a range whose lower but
622 not upper bound is less than the array size, reset ASIZE to
623 be the same as the bound and the other variable to trigger
624 the appropriate warning below. */
625 if (fncode == BUILT_IN_STRNCAT
626 && bndrng[0] != bndrng[1]
627 && wi::ltu_p (wi::to_offset (bndrng[0]), asize)
628 && (!known_size
629 || wi::ltu_p (asize, wibnd)))
631 asize = wibnd;
632 bound = NULL_TREE;
633 fncode = 0;
636 bool warned = false;
638 auto_diagnostic_group d;
639 if (wi::ltu_p (asize, wibnd))
641 if (bndrng[0] == bndrng[1])
642 warned = warning_at (loc, OPT_Wstringop_overread,
643 "%qD argument %i declared attribute "
644 "%<nonstring%> is smaller than the specified "
645 "bound %wu",
646 fndecl, argno + 1, wibnd.to_uhwi ());
647 else if (wi::ltu_p (asize, wi::to_offset (bndrng[0])))
648 warned = warning_at (loc, OPT_Wstringop_overread,
649 "%qD argument %i declared attribute "
650 "%<nonstring%> is smaller than "
651 "the specified bound [%E, %E]",
652 fndecl, argno + 1, bndrng[0], bndrng[1]);
653 else
654 warned = warning_at (loc, OPT_Wstringop_overread,
655 "%qD argument %i declared attribute "
656 "%<nonstring%> may be smaller than "
657 "the specified bound [%E, %E]",
658 fndecl, argno + 1, bndrng[0], bndrng[1]);
660 else if (fncode == BUILT_IN_STRNCAT)
661 ; /* Avoid warning for calls to strncat() when the bound
662 is equal to the size of the non-string argument. */
663 else if (!bound)
664 warned = warning_at (loc, OPT_Wstringop_overread,
665 "%qD argument %i declared attribute %<nonstring%>",
666 fndecl, argno + 1);
668 if (warned)
670 inform (DECL_SOURCE_LOCATION (decl),
671 "argument %qD declared here", decl);
672 any_arg_warned = true;
676 if (any_arg_warned)
677 suppress_warning (exp, OPT_Wstringop_overread);
679 return any_arg_warned;
682 bool
683 maybe_warn_nonstring_arg (tree fndecl, gimple *stmt)
685 return maybe_warn_nonstring_arg<gimple *>(fndecl, stmt);
689 bool
690 maybe_warn_nonstring_arg (tree fndecl, tree expr)
692 return maybe_warn_nonstring_arg<tree>(fndecl, expr);
695 /* Issue a warning OPT for a bounded call EXP with a bound in RANGE
696 accessing an object with SIZE. */
698 template <class GimpleOrTree>
699 static bool
700 maybe_warn_for_bound (opt_code opt, location_t loc, GimpleOrTree exp, tree func,
701 tree bndrng[2], tree size, const access_data *pad)
703 if (!bndrng[0] || warning_suppressed_p (exp, opt))
704 return false;
706 tree maxobjsize = max_object_size ();
708 bool warned = false;
710 if (opt == OPT_Wstringop_overread)
712 bool maybe = pad && pad->src.phi ();
713 if (maybe)
715 /* Issue a "maybe" warning only if the PHI refers to objects
716 at least one of which has more space remaining than the bound.
717 Otherwise, if the bound is greater, use the definitive form. */
718 offset_int remmax = pad->src.size_remaining ();
719 if (remmax < wi::to_offset (bndrng[0]))
720 maybe = false;
723 auto_diagnostic_group d;
724 if (tree_int_cst_lt (maxobjsize, bndrng[0]))
726 if (bndrng[0] == bndrng[1])
727 warned = (func
728 ? warning_at (loc, opt,
729 (maybe
730 ? G_("%qD specified bound %E may "
731 "exceed maximum object size %E")
732 : G_("%qD specified bound %E "
733 "exceeds maximum object size %E")),
734 func, bndrng[0], maxobjsize)
735 : warning_at (loc, opt,
736 (maybe
737 ? G_("specified bound %E may "
738 "exceed maximum object size %E")
739 : G_("specified bound %E "
740 "exceeds maximum object size %E")),
741 bndrng[0], maxobjsize));
742 else
743 warned = (func
744 ? warning_at (loc, opt,
745 (maybe
746 ? G_("%qD specified bound [%E, %E] may "
747 "exceed maximum object size %E")
748 : G_("%qD specified bound [%E, %E] "
749 "exceeds maximum object size %E")),
750 func,
751 bndrng[0], bndrng[1], maxobjsize)
752 : warning_at (loc, opt,
753 (maybe
754 ? G_("specified bound [%E, %E] may "
755 "exceed maximum object size %E")
756 : G_("specified bound [%E, %E] "
757 "exceeds maximum object size %E")),
758 bndrng[0], bndrng[1], maxobjsize));
760 else if (!size || tree_int_cst_le (bndrng[0], size))
761 return false;
762 else if (tree_int_cst_equal (bndrng[0], bndrng[1]))
763 warned = (func
764 ? warning_at (loc, opt,
765 (maybe
766 ? G_("%qD specified bound %E may exceed "
767 "source size %E")
768 : G_("%qD specified bound %E exceeds "
769 "source size %E")),
770 func, bndrng[0], size)
771 : warning_at (loc, opt,
772 (maybe
773 ? G_("specified bound %E may exceed "
774 "source size %E")
775 : G_("specified bound %E exceeds "
776 "source size %E")),
777 bndrng[0], size));
778 else
779 warned = (func
780 ? warning_at (loc, opt,
781 (maybe
782 ? G_("%qD specified bound [%E, %E] may "
783 "exceed source size %E")
784 : G_("%qD specified bound [%E, %E] exceeds "
785 "source size %E")),
786 func, bndrng[0], bndrng[1], size)
787 : warning_at (loc, opt,
788 (maybe
789 ? G_("specified bound [%E, %E] may exceed "
790 "source size %E")
791 : G_("specified bound [%E, %E] exceeds "
792 "source size %E")),
793 bndrng[0], bndrng[1], size));
794 if (warned)
796 if (pad && pad->src.ref
797 && has_location (pad->src.ref))
798 inform (get_location (pad->src.ref),
799 "source object allocated here");
800 suppress_warning (exp, opt);
803 return warned;
806 bool maybe = pad && pad->dst.phi ();
807 if (maybe)
809 /* Issue a "maybe" warning only if the PHI refers to objects
810 at least one of which has more space remaining than the bound.
811 Otherwise, if the bound is greater, use the definitive form. */
812 offset_int remmax = pad->dst.size_remaining ();
813 if (remmax < wi::to_offset (bndrng[0]))
814 maybe = false;
816 if (tree_int_cst_lt (maxobjsize, bndrng[0]))
818 if (bndrng[0] == bndrng[1])
819 warned = (func
820 ? warning_at (loc, opt,
821 (maybe
822 ? G_("%qD specified size %E may "
823 "exceed maximum object size %E")
824 : G_("%qD specified size %E "
825 "exceeds maximum object size %E")),
826 func, bndrng[0], maxobjsize)
827 : warning_at (loc, opt,
828 (maybe
829 ? G_("specified size %E may exceed "
830 "maximum object size %E")
831 : G_("specified size %E exceeds "
832 "maximum object size %E")),
833 bndrng[0], maxobjsize));
834 else
835 warned = (func
836 ? warning_at (loc, opt,
837 (maybe
838 ? G_("%qD specified size between %E and %E "
839 "may exceed maximum object size %E")
840 : G_("%qD specified size between %E and %E "
841 "exceeds maximum object size %E")),
842 func, bndrng[0], bndrng[1], maxobjsize)
843 : warning_at (loc, opt,
844 (maybe
845 ? G_("specified size between %E and %E "
846 "may exceed maximum object size %E")
847 : G_("specified size between %E and %E "
848 "exceeds maximum object size %E")),
849 bndrng[0], bndrng[1], maxobjsize));
851 else if (!size || tree_int_cst_le (bndrng[0], size))
852 return false;
853 else if (tree_int_cst_equal (bndrng[0], bndrng[1]))
854 warned = (func
855 ? warning_at (loc, opt,
856 (maybe
857 ? G_("%qD specified bound %E may exceed "
858 "destination size %E")
859 : G_("%qD specified bound %E exceeds "
860 "destination size %E")),
861 func, bndrng[0], size)
862 : warning_at (loc, opt,
863 (maybe
864 ? G_("specified bound %E may exceed "
865 "destination size %E")
866 : G_("specified bound %E exceeds "
867 "destination size %E")),
868 bndrng[0], size));
869 else
870 warned = (func
871 ? warning_at (loc, opt,
872 (maybe
873 ? G_("%qD specified bound [%E, %E] may exceed "
874 "destination size %E")
875 : G_("%qD specified bound [%E, %E] exceeds "
876 "destination size %E")),
877 func, bndrng[0], bndrng[1], size)
878 : warning_at (loc, opt,
879 (maybe
880 ? G_("specified bound [%E, %E] exceeds "
881 "destination size %E")
882 : G_("specified bound [%E, %E] exceeds "
883 "destination size %E")),
884 bndrng[0], bndrng[1], size));
886 if (warned)
888 if (pad && pad->dst.ref
889 && has_location (pad->dst.ref))
890 inform (get_location (pad->dst.ref),
891 "destination object allocated here");
892 suppress_warning (exp, opt);
895 return warned;
898 bool
899 maybe_warn_for_bound (opt_code opt, location_t loc, gimple *stmt, tree func,
900 tree bndrng[2], tree size,
901 const access_data *pad /* = NULL */)
903 return maybe_warn_for_bound<gimple *> (opt, loc, stmt, func, bndrng, size,
904 pad);
907 bool
908 maybe_warn_for_bound (opt_code opt, location_t loc, tree expr, tree func,
909 tree bndrng[2], tree size,
910 const access_data *pad /* = NULL */)
912 return maybe_warn_for_bound<tree> (opt, loc, expr, func, bndrng, size, pad);
915 /* For an expression EXP issue an access warning controlled by option OPT
916 with access to a region SIZE bytes in size in the RANGE of sizes.
917 WRITE is true for a write access, READ for a read access, neither for
918 call that may or may not perform an access but for which the range
919 is expected to valid.
920 Returns true when a warning has been issued. */
922 template <class GimpleOrTree>
923 static bool
924 warn_for_access (location_t loc, tree func, GimpleOrTree exp, int opt,
925 tree range[2], tree size, bool write, bool read, bool maybe)
927 bool warned = false;
929 if (write && read)
931 if (tree_int_cst_equal (range[0], range[1]))
932 warned = (func
933 ? warning_n (loc, opt, tree_to_uhwi (range[0]),
934 (maybe
935 ? G_("%qD may access %E byte in a region "
936 "of size %E")
937 : G_("%qD accessing %E byte in a region "
938 "of size %E")),
939 (maybe
940 ? G_ ("%qD may access %E bytes in a region "
941 "of size %E")
942 : G_ ("%qD accessing %E bytes in a region "
943 "of size %E")),
944 func, range[0], size)
945 : warning_n (loc, opt, tree_to_uhwi (range[0]),
946 (maybe
947 ? G_("may access %E byte in a region "
948 "of size %E")
949 : G_("accessing %E byte in a region "
950 "of size %E")),
951 (maybe
952 ? G_("may access %E bytes in a region "
953 "of size %E")
954 : G_("accessing %E bytes in a region "
955 "of size %E")),
956 range[0], size));
957 else if (tree_int_cst_sign_bit (range[1]))
959 /* Avoid printing the upper bound if it's invalid. */
960 warned = (func
961 ? warning_at (loc, opt,
962 (maybe
963 ? G_("%qD may access %E or more bytes "
964 "in a region of size %E")
965 : G_("%qD accessing %E or more bytes "
966 "in a region of size %E")),
967 func, range[0], size)
968 : warning_at (loc, opt,
969 (maybe
970 ? G_("may access %E or more bytes "
971 "in a region of size %E")
972 : G_("accessing %E or more bytes "
973 "in a region of size %E")),
974 range[0], size));
976 else
977 warned = (func
978 ? warning_at (loc, opt,
979 (maybe
980 ? G_("%qD may access between %E and %E "
981 "bytes in a region of size %E")
982 : G_("%qD accessing between %E and %E "
983 "bytes in a region of size %E")),
984 func, range[0], range[1], size)
985 : warning_at (loc, opt,
986 (maybe
987 ? G_("may access between %E and %E bytes "
988 "in a region of size %E")
989 : G_("accessing between %E and %E bytes "
990 "in a region of size %E")),
991 range[0], range[1], size));
992 return warned;
995 if (write)
997 if (tree_int_cst_equal (range[0], range[1]))
998 warned = (func
999 ? warning_n (loc, opt, tree_to_uhwi (range[0]),
1000 (maybe
1001 ? G_("%qD may write %E byte into a region "
1002 "of size %E")
1003 : G_("%qD writing %E byte into a region "
1004 "of size %E overflows the destination")),
1005 (maybe
1006 ? G_("%qD may write %E bytes into a region "
1007 "of size %E")
1008 : G_("%qD writing %E bytes into a region "
1009 "of size %E overflows the destination")),
1010 func, range[0], size)
1011 : warning_n (loc, opt, tree_to_uhwi (range[0]),
1012 (maybe
1013 ? G_("may write %E byte into a region "
1014 "of size %E")
1015 : G_("writing %E byte into a region "
1016 "of size %E overflows the destination")),
1017 (maybe
1018 ? G_("may write %E bytes into a region "
1019 "of size %E")
1020 : G_("writing %E bytes into a region "
1021 "of size %E overflows the destination")),
1022 range[0], size));
1023 else if (tree_int_cst_sign_bit (range[1]))
1025 /* Avoid printing the upper bound if it's invalid. */
1026 warned = (func
1027 ? warning_at (loc, opt,
1028 (maybe
1029 ? G_("%qD may write %E or more bytes "
1030 "into a region of size %E")
1031 : G_("%qD writing %E or more bytes "
1032 "into a region of size %E overflows "
1033 "the destination")),
1034 func, range[0], size)
1035 : warning_at (loc, opt,
1036 (maybe
1037 ? G_("may write %E or more bytes into "
1038 "a region of size %E")
1039 : G_("writing %E or more bytes into "
1040 "a region of size %E overflows "
1041 "the destination")),
1042 range[0], size));
1044 else
1045 warned = (func
1046 ? warning_at (loc, opt,
1047 (maybe
1048 ? G_("%qD may write between %E and %E bytes "
1049 "into a region of size %E")
1050 : G_("%qD writing between %E and %E bytes "
1051 "into a region of size %E overflows "
1052 "the destination")),
1053 func, range[0], range[1], size)
1054 : warning_at (loc, opt,
1055 (maybe
1056 ? G_("may write between %E and %E bytes "
1057 "into a region of size %E")
1058 : G_("writing between %E and %E bytes "
1059 "into a region of size %E overflows "
1060 "the destination")),
1061 range[0], range[1], size));
1062 return warned;
1065 if (read)
1067 if (tree_int_cst_equal (range[0], range[1]))
1068 warned = (func
1069 ? warning_n (loc, OPT_Wstringop_overread,
1070 tree_to_uhwi (range[0]),
1071 (maybe
1072 ? G_("%qD may read %E byte from a region "
1073 "of size %E")
1074 : G_("%qD reading %E byte from a region "
1075 "of size %E")),
1076 (maybe
1077 ? G_("%qD may read %E bytes from a region "
1078 "of size %E")
1079 : G_("%qD reading %E bytes from a region "
1080 "of size %E")),
1081 func, range[0], size)
1082 : warning_n (loc, OPT_Wstringop_overread,
1083 tree_to_uhwi (range[0]),
1084 (maybe
1085 ? G_("may read %E byte from a region "
1086 "of size %E")
1087 : G_("reading %E byte from a region "
1088 "of size %E")),
1089 (maybe
1090 ? G_("may read %E bytes from a region "
1091 "of size %E")
1092 : G_("reading %E bytes from a region "
1093 "of size %E")),
1094 range[0], size));
1095 else if (tree_int_cst_sign_bit (range[1]))
1097 /* Avoid printing the upper bound if it's invalid. */
1098 warned = (func
1099 ? warning_at (loc, OPT_Wstringop_overread,
1100 (maybe
1101 ? G_("%qD may read %E or more bytes "
1102 "from a region of size %E")
1103 : G_("%qD reading %E or more bytes "
1104 "from a region of size %E")),
1105 func, range[0], size)
1106 : warning_at (loc, OPT_Wstringop_overread,
1107 (maybe
1108 ? G_("may read %E or more bytes "
1109 "from a region of size %E")
1110 : G_("reading %E or more bytes "
1111 "from a region of size %E")),
1112 range[0], size));
1114 else
1115 warned = (func
1116 ? warning_at (loc, OPT_Wstringop_overread,
1117 (maybe
1118 ? G_("%qD may read between %E and %E bytes "
1119 "from a region of size %E")
1120 : G_("%qD reading between %E and %E bytes "
1121 "from a region of size %E")),
1122 func, range[0], range[1], size)
1123 : warning_at (loc, opt,
1124 (maybe
1125 ? G_("may read between %E and %E bytes "
1126 "from a region of size %E")
1127 : G_("reading between %E and %E bytes "
1128 "from a region of size %E")),
1129 range[0], range[1], size));
1131 if (warned)
1132 suppress_warning (exp, OPT_Wstringop_overread);
1134 return warned;
1137 if (tree_int_cst_equal (range[0], range[1])
1138 || tree_int_cst_sign_bit (range[1]))
1139 warned = (func
1140 ? warning_n (loc, OPT_Wstringop_overread,
1141 tree_to_uhwi (range[0]),
1142 "%qD expecting %E byte in a region of size %E",
1143 "%qD expecting %E bytes in a region of size %E",
1144 func, range[0], size)
1145 : warning_n (loc, OPT_Wstringop_overread,
1146 tree_to_uhwi (range[0]),
1147 "expecting %E byte in a region of size %E",
1148 "expecting %E bytes in a region of size %E",
1149 range[0], size));
1150 else if (tree_int_cst_sign_bit (range[1]))
1152 /* Avoid printing the upper bound if it's invalid. */
1153 warned = (func
1154 ? warning_at (loc, OPT_Wstringop_overread,
1155 "%qD expecting %E or more bytes in a region "
1156 "of size %E",
1157 func, range[0], size)
1158 : warning_at (loc, OPT_Wstringop_overread,
1159 "expecting %E or more bytes in a region "
1160 "of size %E",
1161 range[0], size));
1163 else
1164 warned = (func
1165 ? warning_at (loc, OPT_Wstringop_overread,
1166 "%qD expecting between %E and %E bytes in "
1167 "a region of size %E",
1168 func, range[0], range[1], size)
1169 : warning_at (loc, OPT_Wstringop_overread,
1170 "expecting between %E and %E bytes in "
1171 "a region of size %E",
1172 range[0], range[1], size));
1174 if (warned)
1175 suppress_warning (exp, OPT_Wstringop_overread);
1177 return warned;
1180 static bool
1181 warn_for_access (location_t loc, tree func, gimple *stmt, int opt,
1182 tree range[2], tree size, bool write, bool read, bool maybe)
1184 return warn_for_access<gimple *>(loc, func, stmt, opt, range, size,
1185 write, read, maybe);
1188 static bool
1189 warn_for_access (location_t loc, tree func, tree expr, int opt,
1190 tree range[2], tree size, bool write, bool read, bool maybe)
1192 return warn_for_access<tree>(loc, func, expr, opt, range, size,
1193 write, read, maybe);
1196 /* Helper to set RANGE to the range of BOUND if it's nonnull, bounded
1197 by BNDRNG if nonnull and valid. */
1199 static void
1200 get_size_range (range_query *query, tree bound, gimple *stmt, tree range[2],
1201 int flags, const offset_int bndrng[2])
1203 if (bound)
1204 get_size_range (query, bound, stmt, range, flags);
1206 if (!bndrng || (bndrng[0] == 0 && bndrng[1] == HOST_WIDE_INT_M1U))
1207 return;
1209 if (range[0] && TREE_CODE (range[0]) == INTEGER_CST)
1211 offset_int r[] =
1212 { wi::to_offset (range[0]), wi::to_offset (range[1]) };
1213 if (r[0] < bndrng[0])
1214 range[0] = wide_int_to_tree (sizetype, bndrng[0]);
1215 if (bndrng[1] < r[1])
1216 range[1] = wide_int_to_tree (sizetype, bndrng[1]);
1218 else
1220 range[0] = wide_int_to_tree (sizetype, bndrng[0]);
1221 range[1] = wide_int_to_tree (sizetype, bndrng[1]);
1225 /* Try to verify that the sizes and lengths of the arguments to a string
1226 manipulation function given by EXP are within valid bounds and that
1227 the operation does not lead to buffer overflow or read past the end.
1228 Arguments other than EXP may be null. When non-null, the arguments
1229 have the following meaning:
1230 DST is the destination of a copy call or NULL otherwise.
1231 SRC is the source of a copy call or NULL otherwise.
1232 DSTWRITE is the number of bytes written into the destination obtained
1233 from the user-supplied size argument to the function (such as in
1234 memcpy(DST, SRCs, DSTWRITE) or strncpy(DST, DRC, DSTWRITE).
1235 MAXREAD is the user-supplied bound on the length of the source sequence
1236 (such as in strncat(d, s, N). It specifies the upper limit on the number
1237 of bytes to write. If NULL, it's taken to be the same as DSTWRITE.
1238 SRCSTR is the source string (such as in strcpy(DST, SRC)) when the
1239 expression EXP is a string function call (as opposed to a memory call
1240 like memcpy). As an exception, SRCSTR can also be an integer denoting
1241 the precomputed size of the source string or object (for functions like
1242 memcpy).
1243 DSTSIZE is the size of the destination object.
1245 When DSTWRITE is null LEN is checked to verify that it doesn't exceed
1246 SIZE_MAX.
1248 WRITE is true for write accesses, READ is true for reads. Both are
1249 false for simple size checks in calls to functions that neither read
1250 from nor write to the region.
1252 When nonnull, PAD points to a more detailed description of the access.
1254 If the call is successfully verified as safe return true, otherwise
1255 return false. */
1257 template <class GimpleOrTree>
1258 static bool
1259 check_access (GimpleOrTree exp, tree dstwrite,
1260 tree maxread, tree srcstr, tree dstsize,
1261 access_mode mode, const access_data *pad,
1262 range_query *rvals)
1264 /* The size of the largest object is half the address space, or
1265 PTRDIFF_MAX. (This is way too permissive.) */
1266 tree maxobjsize = max_object_size ();
1268 /* Either an approximate/minimum the length of the source string for
1269 string functions or the size of the source object for raw memory
1270 functions. */
1271 tree slen = NULL_TREE;
1273 /* The range of the access in bytes; first set to the write access
1274 for functions that write and then read for those that also (or
1275 just) read. */
1276 tree range[2] = { NULL_TREE, NULL_TREE };
1278 /* Set to true when the exact number of bytes written by a string
1279 function like strcpy is not known and the only thing that is
1280 known is that it must be at least one (for the terminating nul). */
1281 bool at_least_one = false;
1282 if (srcstr)
1284 /* SRCSTR is normally a pointer to string but as a special case
1285 it can be an integer denoting the length of a string. */
1286 if (POINTER_TYPE_P (TREE_TYPE (srcstr)))
1288 if (!check_nul_terminated_array (exp, srcstr, maxread))
1289 /* Return if the array is not nul-terminated and a warning
1290 has been issued. */
1291 return false;
1293 /* Try to determine the range of lengths the source string
1294 refers to. If it can be determined and is less than
1295 the upper bound given by MAXREAD add one to it for
1296 the terminating nul. Otherwise, set it to one for
1297 the same reason, or to MAXREAD as appropriate. */
1298 c_strlen_data lendata = { };
1299 get_range_strlen (srcstr, &lendata, /* eltsize = */ 1);
1300 range[0] = lendata.minlen;
1301 range[1] = lendata.maxbound ? lendata.maxbound : lendata.maxlen;
1302 if (range[0]
1303 && TREE_CODE (range[0]) == INTEGER_CST
1304 && TREE_CODE (range[1]) == INTEGER_CST
1305 && (!maxread || TREE_CODE (maxread) == INTEGER_CST))
1307 if (maxread && tree_int_cst_le (maxread, range[0]))
1308 range[0] = range[1] = maxread;
1309 else
1310 range[0] = fold_build2 (PLUS_EXPR, size_type_node,
1311 range[0], size_one_node);
1313 if (maxread && tree_int_cst_le (maxread, range[1]))
1314 range[1] = maxread;
1315 else if (!integer_all_onesp (range[1]))
1316 range[1] = fold_build2 (PLUS_EXPR, size_type_node,
1317 range[1], size_one_node);
1319 slen = range[0];
1321 else
1323 at_least_one = true;
1324 slen = size_one_node;
1327 else
1328 slen = srcstr;
1331 if (!dstwrite && !maxread)
1333 /* When the only available piece of data is the object size
1334 there is nothing to do. */
1335 if (!slen)
1336 return true;
1338 /* Otherwise, when the length of the source sequence is known
1339 (as with strlen), set DSTWRITE to it. */
1340 if (!range[0])
1341 dstwrite = slen;
1344 if (!dstsize)
1345 dstsize = maxobjsize;
1347 /* Set RANGE to that of DSTWRITE if non-null, bounded by PAD->DST_BNDRNG
1348 if valid. */
1349 gimple *stmt = pad ? pad->stmt : nullptr;
1350 get_size_range (rvals, dstwrite, stmt, range,
1351 /* If the destination has known zero size prefer a zero
1352 size range to avoid false positives if that's a
1353 possibility. */
1354 integer_zerop (dstsize) ? SR_ALLOW_ZERO : 0,
1355 pad ? pad->dst_bndrng : NULL);
1357 tree func = get_callee_fndecl (exp);
1358 /* Read vs write access by built-ins can be determined from the const
1359 qualifiers on the pointer argument. In the absence of attribute
1360 access, non-const qualified pointer arguments to user-defined
1361 functions are assumed to both read and write the objects. */
1362 const bool builtin = func ? fndecl_built_in_p (func) : false;
1364 /* First check the number of bytes to be written against the maximum
1365 object size. */
1366 if (range[0]
1367 && TREE_CODE (range[0]) == INTEGER_CST
1368 && tree_int_cst_lt (maxobjsize, range[0]))
1370 location_t loc = get_location (exp);
1371 maybe_warn_for_bound (OPT_Wstringop_overflow_, loc, exp, func, range,
1372 NULL_TREE, pad);
1373 return false;
1376 /* The number of bytes to write is "exact" if DSTWRITE is non-null,
1377 constant, and in range of unsigned HOST_WIDE_INT. */
1378 bool exactwrite = dstwrite && tree_fits_uhwi_p (dstwrite);
1380 /* Next check the number of bytes to be written against the destination
1381 object size. */
1382 if (range[0] || !exactwrite || integer_all_onesp (dstwrite))
1384 if (range[0]
1385 && TREE_CODE (range[0]) == INTEGER_CST
1386 && ((tree_fits_uhwi_p (dstsize)
1387 && tree_int_cst_lt (dstsize, range[0]))
1388 || (dstwrite
1389 && tree_fits_uhwi_p (dstwrite)
1390 && tree_int_cst_lt (dstwrite, range[0]))))
1392 const opt_code opt = OPT_Wstringop_overflow_;
1393 if (warning_suppressed_p (exp, opt)
1394 || (pad && pad->dst.ref
1395 && warning_suppressed_p (pad->dst.ref, opt)))
1396 return false;
1398 auto_diagnostic_group d;
1399 location_t loc = get_location (exp);
1400 bool warned = false;
1401 if (dstwrite == slen && at_least_one)
1403 /* This is a call to strcpy with a destination of 0 size
1404 and a source of unknown length. The call will write
1405 at least one byte past the end of the destination. */
1406 warned = (func
1407 ? warning_at (loc, opt,
1408 "%qD writing %E or more bytes into "
1409 "a region of size %E overflows "
1410 "the destination",
1411 func, range[0], dstsize)
1412 : warning_at (loc, opt,
1413 "writing %E or more bytes into "
1414 "a region of size %E overflows "
1415 "the destination",
1416 range[0], dstsize));
1418 else
1420 const bool read
1421 = mode == access_read_only || mode == access_read_write;
1422 const bool write
1423 = mode == access_write_only || mode == access_read_write;
1424 const bool maybe = pad && pad->dst.parmarray;
1425 warned = warn_for_access (loc, func, exp,
1426 OPT_Wstringop_overflow_,
1427 range, dstsize,
1428 write, read && !builtin, maybe);
1431 if (warned)
1433 suppress_warning (exp, OPT_Wstringop_overflow_);
1434 if (pad)
1435 pad->dst.inform_access (pad->mode);
1438 /* Return error when an overflow has been detected. */
1439 return false;
1443 /* Check the maximum length of the source sequence against the size
1444 of the destination object if known, or against the maximum size
1445 of an object. */
1446 if (maxread)
1448 /* Set RANGE to that of MAXREAD, bounded by PAD->SRC_BNDRNG if
1449 PAD is nonnull and BNDRNG is valid. */
1450 get_size_range (rvals, maxread, stmt, range, 0,
1451 pad ? pad->src_bndrng : NULL);
1453 location_t loc = get_location (exp);
1454 tree size = dstsize;
1455 if (pad && pad->mode == access_read_only)
1456 size = wide_int_to_tree (sizetype, pad->src.size_remaining ());
1458 if (range[0] && maxread && tree_fits_uhwi_p (size))
1460 if (tree_int_cst_lt (maxobjsize, range[0]))
1462 maybe_warn_for_bound (OPT_Wstringop_overread, loc, exp, func,
1463 range, size, pad);
1464 return false;
1467 if (size != maxobjsize && tree_int_cst_lt (size, range[0]))
1469 opt_code opt = (dstwrite || mode != access_read_only
1470 ? OPT_Wstringop_overflow_
1471 : OPT_Wstringop_overread);
1472 maybe_warn_for_bound (opt, loc, exp, func, range, size, pad);
1473 return false;
1477 maybe_warn_nonstring_arg (func, exp);
1480 /* Check for reading past the end of SRC. */
1481 bool overread = (slen
1482 && slen == srcstr
1483 && dstwrite
1484 && range[0]
1485 && TREE_CODE (slen) == INTEGER_CST
1486 && tree_int_cst_lt (slen, range[0]));
1487 /* If none is determined try to get a better answer based on the details
1488 in PAD. */
1489 if (!overread
1490 && pad
1491 && pad->src.sizrng[1] >= 0
1492 && pad->src.offrng[0] >= 0
1493 && (pad->src.offrng[1] < 0
1494 || pad->src.offrng[0] <= pad->src.offrng[1]))
1496 /* Set RANGE to that of MAXREAD, bounded by PAD->SRC_BNDRNG if
1497 PAD is nonnull and BNDRNG is valid. */
1498 get_size_range (rvals, maxread, stmt, range, 0,
1499 pad ? pad->src_bndrng : NULL);
1500 /* Set OVERREAD for reads starting just past the end of an object. */
1501 overread = pad->src.sizrng[1] - pad->src.offrng[0] < pad->src_bndrng[0];
1502 range[0] = wide_int_to_tree (sizetype, pad->src_bndrng[0]);
1503 slen = size_zero_node;
1506 if (overread)
1508 const opt_code opt = OPT_Wstringop_overread;
1509 if (warning_suppressed_p (exp, opt)
1510 || (srcstr && warning_suppressed_p (srcstr, opt))
1511 || (pad && pad->src.ref
1512 && warning_suppressed_p (pad->src.ref, opt)))
1513 return false;
1515 location_t loc = get_location (exp);
1516 const bool read
1517 = mode == access_read_only || mode == access_read_write;
1518 const bool maybe = pad && pad->dst.parmarray;
1519 auto_diagnostic_group d;
1520 if (warn_for_access (loc, func, exp, opt, range, slen, false, read,
1521 maybe))
1523 suppress_warning (exp, opt);
1524 if (pad)
1525 pad->src.inform_access (access_read_only);
1527 return false;
1530 return true;
1533 static bool
1534 check_access (gimple *stmt, tree dstwrite,
1535 tree maxread, tree srcstr, tree dstsize,
1536 access_mode mode, const access_data *pad,
1537 range_query *rvals)
1539 return check_access<gimple *> (stmt, dstwrite, maxread, srcstr, dstsize,
1540 mode, pad, rvals);
1543 bool
1544 check_access (tree expr, tree dstwrite,
1545 tree maxread, tree srcstr, tree dstsize,
1546 access_mode mode, const access_data *pad /* = NULL */)
1548 return check_access<tree> (expr, dstwrite, maxread, srcstr, dstsize,
1549 mode, pad, nullptr);
1552 /* Return true if STMT is a call to an allocation function. Unless
1553 ALL_ALLOC is set, consider only functions that return dynamically
1554 allocated objects. Otherwise return true even for all forms of
1555 alloca (including VLA). */
1557 static bool
1558 fndecl_alloc_p (tree fndecl, bool all_alloc)
1560 if (!fndecl)
1561 return false;
1563 /* A call to operator new isn't recognized as one to a built-in. */
1564 if (DECL_IS_OPERATOR_NEW_P (fndecl))
1565 return true;
1567 if (fndecl_built_in_p (fndecl, BUILT_IN_NORMAL))
1569 switch (DECL_FUNCTION_CODE (fndecl))
1571 case BUILT_IN_ALLOCA:
1572 case BUILT_IN_ALLOCA_WITH_ALIGN:
1573 return all_alloc;
1574 case BUILT_IN_ALIGNED_ALLOC:
1575 case BUILT_IN_CALLOC:
1576 case BUILT_IN_GOMP_ALLOC:
1577 case BUILT_IN_MALLOC:
1578 case BUILT_IN_REALLOC:
1579 case BUILT_IN_STRDUP:
1580 case BUILT_IN_STRNDUP:
1581 return true;
1582 default:
1583 break;
1587 /* A function is considered an allocation function if it's declared
1588 with attribute malloc with an argument naming its associated
1589 deallocation function. */
1590 tree attrs = DECL_ATTRIBUTES (fndecl);
1591 if (!attrs)
1592 return false;
1594 for (tree allocs = attrs;
1595 (allocs = lookup_attribute ("malloc", allocs));
1596 allocs = TREE_CHAIN (allocs))
1598 tree args = TREE_VALUE (allocs);
1599 if (!args)
1600 continue;
1602 if (TREE_VALUE (args))
1603 return true;
1606 return false;
1609 /* Return true if STMT is a call to an allocation function. A wrapper
1610 around fndecl_alloc_p. */
1612 static bool
1613 gimple_call_alloc_p (gimple *stmt, bool all_alloc = false)
1615 return fndecl_alloc_p (gimple_call_fndecl (stmt), all_alloc);
1618 /* Return true if DELC doesn't refer to an operator delete that's
1619 suitable to call with a pointer returned from the operator new
1620 described by NEWC. */
1622 static bool
1623 new_delete_mismatch_p (const demangle_component &newc,
1624 const demangle_component &delc)
1626 if (newc.type != delc.type)
1627 return true;
1629 switch (newc.type)
1631 case DEMANGLE_COMPONENT_NAME:
1633 int len = newc.u.s_name.len;
1634 const char *news = newc.u.s_name.s;
1635 const char *dels = delc.u.s_name.s;
1636 if (len != delc.u.s_name.len || memcmp (news, dels, len))
1637 return true;
1639 if (news[len] == 'n')
1641 if (news[len + 1] == 'a')
1642 return dels[len] != 'd' || dels[len + 1] != 'a';
1643 if (news[len + 1] == 'w')
1644 return dels[len] != 'd' || dels[len + 1] != 'l';
1646 return false;
1649 case DEMANGLE_COMPONENT_OPERATOR:
1650 /* Operator mismatches are handled above. */
1651 return false;
1653 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR:
1654 if (newc.u.s_extended_operator.args != delc.u.s_extended_operator.args)
1655 return true;
1656 return new_delete_mismatch_p (*newc.u.s_extended_operator.name,
1657 *delc.u.s_extended_operator.name);
1659 case DEMANGLE_COMPONENT_FIXED_TYPE:
1660 if (newc.u.s_fixed.accum != delc.u.s_fixed.accum
1661 || newc.u.s_fixed.sat != delc.u.s_fixed.sat)
1662 return true;
1663 return new_delete_mismatch_p (*newc.u.s_fixed.length,
1664 *delc.u.s_fixed.length);
1666 case DEMANGLE_COMPONENT_CTOR:
1667 if (newc.u.s_ctor.kind != delc.u.s_ctor.kind)
1668 return true;
1669 return new_delete_mismatch_p (*newc.u.s_ctor.name,
1670 *delc.u.s_ctor.name);
1672 case DEMANGLE_COMPONENT_DTOR:
1673 if (newc.u.s_dtor.kind != delc.u.s_dtor.kind)
1674 return true;
1675 return new_delete_mismatch_p (*newc.u.s_dtor.name,
1676 *delc.u.s_dtor.name);
1678 case DEMANGLE_COMPONENT_BUILTIN_TYPE:
1680 /* The demangler API provides no better way to compare built-in
1681 types except to by comparing their demangled names. */
1682 size_t nsz, dsz;
1683 demangle_component *pnc = const_cast<demangle_component *>(&newc);
1684 demangle_component *pdc = const_cast<demangle_component *>(&delc);
1685 char *nts = cplus_demangle_print (0, pnc, 16, &nsz);
1686 char *dts = cplus_demangle_print (0, pdc, 16, &dsz);
1687 if (!nts != !dts)
1688 return true;
1689 bool mismatch = strcmp (nts, dts);
1690 free (nts);
1691 free (dts);
1692 return mismatch;
1695 case DEMANGLE_COMPONENT_SUB_STD:
1696 if (newc.u.s_string.len != delc.u.s_string.len)
1697 return true;
1698 return memcmp (newc.u.s_string.string, delc.u.s_string.string,
1699 newc.u.s_string.len);
1701 case DEMANGLE_COMPONENT_FUNCTION_PARAM:
1702 case DEMANGLE_COMPONENT_TEMPLATE_PARAM:
1703 return newc.u.s_number.number != delc.u.s_number.number;
1705 case DEMANGLE_COMPONENT_CHARACTER:
1706 return newc.u.s_character.character != delc.u.s_character.character;
1708 case DEMANGLE_COMPONENT_DEFAULT_ARG:
1709 case DEMANGLE_COMPONENT_LAMBDA:
1710 if (newc.u.s_unary_num.num != delc.u.s_unary_num.num)
1711 return true;
1712 return new_delete_mismatch_p (*newc.u.s_unary_num.sub,
1713 *delc.u.s_unary_num.sub);
1714 default:
1715 break;
1718 if (!newc.u.s_binary.left != !delc.u.s_binary.left)
1719 return true;
1721 if (!newc.u.s_binary.left)
1722 return false;
1724 if (new_delete_mismatch_p (*newc.u.s_binary.left, *delc.u.s_binary.left)
1725 || !newc.u.s_binary.right != !delc.u.s_binary.right)
1726 return true;
1728 if (newc.u.s_binary.right)
1729 return new_delete_mismatch_p (*newc.u.s_binary.right,
1730 *delc.u.s_binary.right);
1731 return false;
1734 /* Return true if DELETE_DECL is an operator delete that's not suitable
1735 to call with a pointer returned from NEW_DECL. */
1737 static bool
1738 new_delete_mismatch_p (tree new_decl, tree delete_decl)
1740 tree new_name = DECL_ASSEMBLER_NAME (new_decl);
1741 tree delete_name = DECL_ASSEMBLER_NAME (delete_decl);
1743 /* valid_new_delete_pair_p() returns a conservative result (currently
1744 it only handles global operators). A true result is reliable but
1745 a false result doesn't necessarily mean the operators don't match
1746 unless CERTAIN is set. */
1747 bool certain;
1748 if (valid_new_delete_pair_p (new_name, delete_name, &certain))
1749 return false;
1750 /* CERTAIN is set when the negative result is certain. */
1751 if (certain)
1752 return true;
1754 /* For anything not handled by valid_new_delete_pair_p() such as member
1755 operators compare the individual demangled components of the mangled
1756 name. */
1757 const char *new_str = IDENTIFIER_POINTER (new_name);
1758 const char *del_str = IDENTIFIER_POINTER (delete_name);
1760 void *np = NULL, *dp = NULL;
1761 demangle_component *ndc = cplus_demangle_v3_components (new_str, 0, &np);
1762 demangle_component *ddc = cplus_demangle_v3_components (del_str, 0, &dp);
1763 bool mismatch = new_delete_mismatch_p (*ndc, *ddc);
1764 free (np);
1765 free (dp);
1766 return mismatch;
1769 /* ALLOC_DECL and DEALLOC_DECL are pair of allocation and deallocation
1770 functions. Return true if the latter is suitable to deallocate objects
1771 allocated by calls to the former. */
1773 static bool
1774 matching_alloc_calls_p (tree alloc_decl, tree dealloc_decl)
1776 /* Set to alloc_kind_t::builtin if ALLOC_DECL is associated with
1777 a built-in deallocator. */
1778 enum class alloc_kind_t { none, builtin, user }
1779 alloc_dealloc_kind = alloc_kind_t::none;
1781 if (DECL_IS_OPERATOR_NEW_P (alloc_decl))
1783 if (DECL_IS_OPERATOR_DELETE_P (dealloc_decl))
1784 /* Return true iff both functions are of the same array or
1785 singleton form and false otherwise. */
1786 return !new_delete_mismatch_p (alloc_decl, dealloc_decl);
1788 /* Return false for deallocation functions that are known not
1789 to match. */
1790 if (fndecl_built_in_p (dealloc_decl, BUILT_IN_FREE)
1791 || fndecl_built_in_p (dealloc_decl, BUILT_IN_REALLOC))
1792 return false;
1793 /* Otherwise proceed below to check the deallocation function's
1794 "*dealloc" attributes to look for one that mentions this operator
1795 new. */
1797 else if (fndecl_built_in_p (alloc_decl, BUILT_IN_NORMAL))
1799 switch (DECL_FUNCTION_CODE (alloc_decl))
1801 case BUILT_IN_ALLOCA:
1802 case BUILT_IN_ALLOCA_WITH_ALIGN:
1803 return false;
1805 case BUILT_IN_ALIGNED_ALLOC:
1806 case BUILT_IN_CALLOC:
1807 case BUILT_IN_GOMP_ALLOC:
1808 case BUILT_IN_MALLOC:
1809 case BUILT_IN_REALLOC:
1810 case BUILT_IN_STRDUP:
1811 case BUILT_IN_STRNDUP:
1812 if (DECL_IS_OPERATOR_DELETE_P (dealloc_decl))
1813 return false;
1815 if (fndecl_built_in_p (dealloc_decl, BUILT_IN_FREE)
1816 || fndecl_built_in_p (dealloc_decl, BUILT_IN_REALLOC))
1817 return true;
1819 alloc_dealloc_kind = alloc_kind_t::builtin;
1820 break;
1822 default:
1823 break;
1827 /* Set if DEALLOC_DECL both allocates and deallocates. */
1828 alloc_kind_t realloc_kind = alloc_kind_t::none;
1830 if (fndecl_built_in_p (dealloc_decl, BUILT_IN_NORMAL))
1832 built_in_function dealloc_code = DECL_FUNCTION_CODE (dealloc_decl);
1833 if (dealloc_code == BUILT_IN_REALLOC)
1834 realloc_kind = alloc_kind_t::builtin;
1836 for (tree amats = DECL_ATTRIBUTES (alloc_decl);
1837 (amats = lookup_attribute ("malloc", amats));
1838 amats = TREE_CHAIN (amats))
1840 tree args = TREE_VALUE (amats);
1841 if (!args)
1842 continue;
1844 tree fndecl = TREE_VALUE (args);
1845 if (!fndecl || !DECL_P (fndecl))
1846 continue;
1848 if (fndecl_built_in_p (fndecl, BUILT_IN_NORMAL)
1849 && dealloc_code == DECL_FUNCTION_CODE (fndecl))
1850 return true;
1854 const bool alloc_builtin = fndecl_built_in_p (alloc_decl, BUILT_IN_NORMAL);
1855 alloc_kind_t realloc_dealloc_kind = alloc_kind_t::none;
1857 /* If DEALLOC_DECL has an internal "*dealloc" attribute scan the list
1858 of its associated allocation functions for ALLOC_DECL.
1859 If the corresponding ALLOC_DECL is found they're a matching pair,
1860 otherwise they're not.
1861 With DDATS set to the Deallocator's *Dealloc ATtributes... */
1862 for (tree ddats = DECL_ATTRIBUTES (dealloc_decl);
1863 (ddats = lookup_attribute ("*dealloc", ddats));
1864 ddats = TREE_CHAIN (ddats))
1866 tree args = TREE_VALUE (ddats);
1867 if (!args)
1868 continue;
1870 tree alloc = TREE_VALUE (args);
1871 if (!alloc)
1872 continue;
1874 if (alloc == DECL_NAME (dealloc_decl))
1875 realloc_kind = alloc_kind_t::user;
1877 if (DECL_P (alloc))
1879 gcc_checking_assert (fndecl_built_in_p (alloc, BUILT_IN_NORMAL));
1881 switch (DECL_FUNCTION_CODE (alloc))
1883 case BUILT_IN_ALIGNED_ALLOC:
1884 case BUILT_IN_CALLOC:
1885 case BUILT_IN_GOMP_ALLOC:
1886 case BUILT_IN_MALLOC:
1887 case BUILT_IN_REALLOC:
1888 case BUILT_IN_STRDUP:
1889 case BUILT_IN_STRNDUP:
1890 realloc_dealloc_kind = alloc_kind_t::builtin;
1891 break;
1892 default:
1893 break;
1896 if (!alloc_builtin)
1897 continue;
1899 if (DECL_FUNCTION_CODE (alloc) != DECL_FUNCTION_CODE (alloc_decl))
1900 continue;
1902 return true;
1905 if (alloc == DECL_NAME (alloc_decl))
1906 return true;
1909 if (realloc_kind == alloc_kind_t::none)
1910 return false;
1912 hash_set<tree> common_deallocs;
1913 /* Special handling for deallocators. Iterate over both the allocator's
1914 and the reallocator's associated deallocator functions looking for
1915 the first one in common. If one is found, the de/reallocator is
1916 a match for the allocator even though the latter isn't directly
1917 associated with the former. This simplifies declarations in system
1918 headers.
1919 With AMATS set to the Allocator's Malloc ATtributes,
1920 and RMATS set to Reallocator's Malloc ATtributes... */
1921 for (tree amats = DECL_ATTRIBUTES (alloc_decl),
1922 rmats = DECL_ATTRIBUTES (dealloc_decl);
1923 (amats = lookup_attribute ("malloc", amats))
1924 || (rmats = lookup_attribute ("malloc", rmats));
1925 amats = amats ? TREE_CHAIN (amats) : NULL_TREE,
1926 rmats = rmats ? TREE_CHAIN (rmats) : NULL_TREE)
1928 if (tree args = amats ? TREE_VALUE (amats) : NULL_TREE)
1929 if (tree adealloc = TREE_VALUE (args))
1931 if (DECL_P (adealloc)
1932 && fndecl_built_in_p (adealloc, BUILT_IN_NORMAL))
1934 built_in_function fncode = DECL_FUNCTION_CODE (adealloc);
1935 if (fncode == BUILT_IN_FREE || fncode == BUILT_IN_REALLOC)
1937 if (realloc_kind == alloc_kind_t::builtin)
1938 return true;
1939 alloc_dealloc_kind = alloc_kind_t::builtin;
1941 continue;
1944 common_deallocs.add (adealloc);
1947 if (tree args = rmats ? TREE_VALUE (rmats) : NULL_TREE)
1948 if (tree ddealloc = TREE_VALUE (args))
1950 if (DECL_P (ddealloc)
1951 && fndecl_built_in_p (ddealloc, BUILT_IN_NORMAL))
1953 built_in_function fncode = DECL_FUNCTION_CODE (ddealloc);
1954 if (fncode == BUILT_IN_FREE || fncode == BUILT_IN_REALLOC)
1956 if (alloc_dealloc_kind == alloc_kind_t::builtin)
1957 return true;
1958 realloc_dealloc_kind = alloc_kind_t::builtin;
1960 continue;
1963 if (common_deallocs.add (ddealloc))
1964 return true;
1968 /* Succeed only if ALLOC_DECL and the reallocator DEALLOC_DECL share
1969 a built-in deallocator. */
1970 return (alloc_dealloc_kind == alloc_kind_t::builtin
1971 && realloc_dealloc_kind == alloc_kind_t::builtin);
1974 /* Return true if DEALLOC_DECL is a function suitable to deallocate
1975 objects allocated by the ALLOC call. */
1977 static bool
1978 matching_alloc_calls_p (gimple *alloc, tree dealloc_decl)
1980 tree alloc_decl = gimple_call_fndecl (alloc);
1981 if (!alloc_decl)
1982 return true;
1984 return matching_alloc_calls_p (alloc_decl, dealloc_decl);
1987 /* Diagnose a call EXP to deallocate a pointer referenced by AREF if it
1988 includes a nonzero offset. Such a pointer cannot refer to the beginning
1989 of an allocated object. A negative offset may refer to it only if
1990 the target pointer is unknown. */
1992 static bool
1993 warn_dealloc_offset (location_t loc, gimple *call, const access_ref &aref)
1995 if (aref.deref || aref.offrng[0] <= 0 || aref.offrng[1] <= 0)
1996 return false;
1998 tree dealloc_decl = gimple_call_fndecl (call);
1999 if (!dealloc_decl)
2000 return false;
2002 if (DECL_IS_OPERATOR_DELETE_P (dealloc_decl)
2003 && !DECL_IS_REPLACEABLE_OPERATOR (dealloc_decl))
2005 /* A call to a user-defined operator delete with a pointer plus offset
2006 may be valid if it's returned from an unknown function (i.e., one
2007 that's not operator new). */
2008 if (TREE_CODE (aref.ref) == SSA_NAME)
2010 gimple *def_stmt = SSA_NAME_DEF_STMT (aref.ref);
2011 if (is_gimple_call (def_stmt))
2013 tree alloc_decl = gimple_call_fndecl (def_stmt);
2014 if (!alloc_decl || !DECL_IS_OPERATOR_NEW_P (alloc_decl))
2015 return false;
2020 char offstr[80];
2021 offstr[0] = '\0';
2022 if (wi::fits_shwi_p (aref.offrng[0]))
2024 if (aref.offrng[0] == aref.offrng[1]
2025 || !wi::fits_shwi_p (aref.offrng[1]))
2026 sprintf (offstr, " %lli",
2027 (long long)aref.offrng[0].to_shwi ());
2028 else
2029 sprintf (offstr, " [%lli, %lli]",
2030 (long long)aref.offrng[0].to_shwi (),
2031 (long long)aref.offrng[1].to_shwi ());
2034 auto_diagnostic_group d;
2035 if (!warning_at (loc, OPT_Wfree_nonheap_object,
2036 "%qD called on pointer %qE with nonzero offset%s",
2037 dealloc_decl, aref.ref, offstr))
2038 return false;
2040 if (DECL_P (aref.ref))
2041 inform (get_location (aref.ref), "declared here");
2042 else if (TREE_CODE (aref.ref) == SSA_NAME)
2044 gimple *def_stmt = SSA_NAME_DEF_STMT (aref.ref);
2045 if (is_gimple_call (def_stmt))
2047 location_t def_loc = get_location (def_stmt);
2048 tree alloc_decl = gimple_call_fndecl (def_stmt);
2049 if (alloc_decl)
2050 inform (def_loc,
2051 "returned from %qD", alloc_decl);
2052 else if (tree alloc_fntype = gimple_call_fntype (def_stmt))
2053 inform (def_loc,
2054 "returned from %qT", alloc_fntype);
2055 else
2056 inform (def_loc, "obtained here");
2060 return true;
2063 namespace {
2065 const pass_data pass_data_waccess = {
2066 GIMPLE_PASS,
2067 "waccess",
2068 OPTGROUP_NONE,
2069 TV_WARN_ACCESS, /* timer variable */
2070 PROP_cfg, /* properties_required */
2071 0, /* properties_provided */
2072 0, /* properties_destroyed */
2073 0, /* properties_start */
2074 0, /* properties_finish */
2077 /* Pass to detect invalid accesses. */
2078 class pass_waccess : public gimple_opt_pass
2080 public:
2081 pass_waccess (gcc::context *);
2083 ~pass_waccess ();
2085 opt_pass *clone () final override;
2087 bool gate (function *) final override;
2089 void set_pass_param (unsigned, bool) final override;
2091 unsigned int execute (function *) final override;
2093 private:
2094 /* Not copyable or assignable. */
2095 pass_waccess (pass_waccess &) = delete;
2096 void operator= (pass_waccess &) = delete;
2098 /* Check a call to an atomic built-in function. */
2099 bool check_atomic_builtin (gcall *);
2101 /* Check a call to a built-in function. */
2102 bool check_builtin (gcall *);
2104 /* Check a call to an ordinary function for invalid accesses. */
2105 bool check_call_access (gcall *);
2107 /* Check a non-call statement. */
2108 void check_stmt (gimple *);
2110 /* Check statements in a basic block. */
2111 void check_block (basic_block);
2113 /* Check a call to a function. */
2114 void check_call (gcall *);
2116 /* Check a call to the named built-in function. */
2117 void check_alloca (gcall *);
2118 void check_alloc_size_call (gcall *);
2119 void check_strcat (gcall *);
2120 void check_strncat (gcall *);
2121 void check_stxcpy (gcall *);
2122 void check_stxncpy (gcall *);
2123 void check_strncmp (gcall *);
2124 void check_memop_access (gimple *, tree, tree, tree);
2125 void check_read_access (gimple *, tree, tree = NULL_TREE, int = 1);
2127 void maybe_check_dealloc_call (gcall *);
2128 void maybe_check_access_sizes (rdwr_map *, tree, tree, gimple *);
2129 bool maybe_warn_memmodel (gimple *, tree, tree, const unsigned char *);
2130 void check_atomic_memmodel (gimple *, tree, tree, const unsigned char *);
2132 /* Check for uses of indeterminate pointers. */
2133 void check_pointer_uses (gimple *, tree, tree = NULL_TREE, bool = false);
2135 /* Return the argument that a call returns. */
2136 tree gimple_call_return_arg (gcall *);
2138 /* Check a call for uses of a dangling pointer arguments. */
2139 void check_call_dangling (gcall *);
2141 /* Check uses of a dangling pointer or those derived from it. */
2142 void check_dangling_uses (tree, tree, bool = false, bool = false);
2143 void check_dangling_uses ();
2144 void check_dangling_stores ();
2145 void check_dangling_stores (basic_block, hash_set<tree> &, auto_bitmap &);
2147 void warn_invalid_pointer (tree, gimple *, gimple *, tree, bool, bool = false);
2149 /* Return true if use follows an invalidating statement. */
2150 bool use_after_inval_p (gimple *, gimple *, bool = false);
2152 /* A pointer_query object to store information about pointers and
2153 their targets in. */
2154 pointer_query m_ptr_qry;
2155 /* Mapping from DECLs and their clobber statements in the function. */
2156 hash_map<tree, gimple *> m_clobbers;
2157 /* A bit is set for each basic block whose statements have been assigned
2158 valid UIDs. */
2159 bitmap m_bb_uids_set;
2160 /* The current function. */
2161 function *m_func;
2162 /* True to run checks for uses of dangling pointers. */
2163 bool m_check_dangling_p;
2164 /* True to run checks early on in the optimization pipeline. */
2165 bool m_early_checks_p;
2168 /* Construct the pass. */
2170 pass_waccess::pass_waccess (gcc::context *ctxt)
2171 : gimple_opt_pass (pass_data_waccess, ctxt),
2172 m_ptr_qry (NULL),
2173 m_clobbers (),
2174 m_bb_uids_set (),
2175 m_func (),
2176 m_check_dangling_p (),
2177 m_early_checks_p ()
2181 /* Return a copy of the pass with RUN_NUMBER one greater than THIS. */
2183 opt_pass*
2184 pass_waccess::clone ()
2186 return new pass_waccess (m_ctxt);
2189 /* Release pointer_query cache. */
2191 pass_waccess::~pass_waccess ()
2193 m_ptr_qry.flush_cache ();
2196 void
2197 pass_waccess::set_pass_param (unsigned int n, bool early)
2199 gcc_assert (n == 0);
2201 m_early_checks_p = early;
2204 /* Return true when any checks performed by the pass are enabled. */
2206 bool
2207 pass_waccess::gate (function *)
2209 return (warn_free_nonheap_object
2210 || warn_mismatched_alloc
2211 || warn_mismatched_new_delete);
2214 /* Initialize ALLOC_OBJECT_SIZE_LIMIT based on the -Walloc-size-larger-than=
2215 setting if the option is specified, or to the maximum object size if it
2216 is not. Return the initialized value. */
2218 static tree
2219 alloc_max_size (void)
2221 HOST_WIDE_INT limit = warn_alloc_size_limit;
2222 if (limit == HOST_WIDE_INT_MAX)
2223 limit = tree_to_shwi (TYPE_MAX_VALUE (ptrdiff_type_node));
2225 return build_int_cst (size_type_node, limit);
2228 /* Diagnose a call EXP to function FN decorated with attribute alloc_size
2229 whose argument numbers given by IDX with values given by ARGS exceed
2230 the maximum object size or cause an unsigned overflow (wrapping) when
2231 multiplied. FN is null when EXP is a call via a function pointer.
2232 When ARGS[0] is null the function does nothing. ARGS[1] may be null
2233 for functions like malloc, and non-null for those like calloc that
2234 are decorated with a two-argument attribute alloc_size. */
2236 void
2237 maybe_warn_alloc_args_overflow (gimple *stmt, const tree args[2],
2238 const int idx[2])
2240 /* The range each of the (up to) two arguments is known to be in. */
2241 tree argrange[2][2] = { { NULL_TREE, NULL_TREE }, { NULL_TREE, NULL_TREE } };
2243 /* Maximum object size set by -Walloc-size-larger-than= or SIZE_MAX / 2. */
2244 tree maxobjsize = alloc_max_size ();
2246 location_t loc = get_location (stmt);
2248 tree fn = gimple_call_fndecl (stmt);
2249 tree fntype = fn ? TREE_TYPE (fn) : gimple_call_fntype (stmt);
2250 bool warned = false;
2252 /* Validate each argument individually. */
2253 for (unsigned i = 0; i != 2 && args[i]; ++i)
2255 if (TREE_CODE (args[i]) == INTEGER_CST)
2257 argrange[i][0] = args[i];
2258 argrange[i][1] = args[i];
2260 if (tree_int_cst_lt (args[i], integer_zero_node))
2262 warned = warning_at (loc, OPT_Walloc_size_larger_than_,
2263 "argument %i value %qE is negative",
2264 idx[i] + 1, args[i]);
2266 else if (integer_zerop (args[i]))
2268 /* Avoid issuing -Walloc-zero for allocation functions other
2269 than __builtin_alloca that are declared with attribute
2270 returns_nonnull because there's no portability risk. This
2271 avoids warning for such calls to libiberty's xmalloc and
2272 friends.
2273 Also avoid issuing the warning for calls to function named
2274 "alloca". */
2275 if (fn && fndecl_built_in_p (fn, BUILT_IN_ALLOCA)
2276 ? IDENTIFIER_LENGTH (DECL_NAME (fn)) != 6
2277 : !lookup_attribute ("returns_nonnull",
2278 TYPE_ATTRIBUTES (fntype)))
2279 warned = warning_at (loc, OPT_Walloc_zero,
2280 "argument %i value is zero",
2281 idx[i] + 1);
2283 else if (tree_int_cst_lt (maxobjsize, args[i]))
2285 /* G++ emits calls to ::operator new[](SIZE_MAX) in C++98
2286 mode and with -fno-exceptions as a way to indicate array
2287 size overflow. There's no good way to detect C++98 here
2288 so avoid diagnosing these calls for all C++ modes. */
2289 if (i == 0
2290 && fn
2291 && !args[1]
2292 && lang_GNU_CXX ()
2293 && DECL_IS_OPERATOR_NEW_P (fn)
2294 && integer_all_onesp (args[i]))
2295 continue;
2297 warned = warning_at (loc, OPT_Walloc_size_larger_than_,
2298 "argument %i value %qE exceeds "
2299 "maximum object size %E",
2300 idx[i] + 1, args[i], maxobjsize);
2303 else if (TREE_CODE (args[i]) == SSA_NAME
2304 && get_size_range (args[i], argrange[i]))
2306 /* Verify that the argument's range is not negative (including
2307 upper bound of zero). */
2308 if (tree_int_cst_lt (argrange[i][0], integer_zero_node)
2309 && tree_int_cst_le (argrange[i][1], integer_zero_node))
2311 warned = warning_at (loc, OPT_Walloc_size_larger_than_,
2312 "argument %i range [%E, %E] is negative",
2313 idx[i] + 1,
2314 argrange[i][0], argrange[i][1]);
2316 else if (tree_int_cst_lt (maxobjsize, argrange[i][0]))
2318 warned = warning_at (loc, OPT_Walloc_size_larger_than_,
2319 "argument %i range [%E, %E] exceeds "
2320 "maximum object size %E",
2321 idx[i] + 1,
2322 argrange[i][0], argrange[i][1],
2323 maxobjsize);
2328 if (!argrange[0][0])
2329 return;
2331 /* For a two-argument alloc_size, validate the product of the two
2332 arguments if both of their values or ranges are known. */
2333 if (!warned && tree_fits_uhwi_p (argrange[0][0])
2334 && argrange[1][0] && tree_fits_uhwi_p (argrange[1][0])
2335 && !integer_onep (argrange[0][0])
2336 && !integer_onep (argrange[1][0]))
2338 /* Check for overflow in the product of a function decorated with
2339 attribute alloc_size (X, Y). */
2340 unsigned szprec = TYPE_PRECISION (size_type_node);
2341 wide_int x = wi::to_wide (argrange[0][0], szprec);
2342 wide_int y = wi::to_wide (argrange[1][0], szprec);
2344 wi::overflow_type vflow;
2345 wide_int prod = wi::umul (x, y, &vflow);
2347 if (vflow)
2348 warned = warning_at (loc, OPT_Walloc_size_larger_than_,
2349 "product %<%E * %E%> of arguments %i and %i "
2350 "exceeds %<SIZE_MAX%>",
2351 argrange[0][0], argrange[1][0],
2352 idx[0] + 1, idx[1] + 1);
2353 else if (wi::ltu_p (wi::to_wide (maxobjsize, szprec), prod))
2354 warned = warning_at (loc, OPT_Walloc_size_larger_than_,
2355 "product %<%E * %E%> of arguments %i and %i "
2356 "exceeds maximum object size %E",
2357 argrange[0][0], argrange[1][0],
2358 idx[0] + 1, idx[1] + 1,
2359 maxobjsize);
2361 if (warned)
2363 /* Print the full range of each of the two arguments to make
2364 it clear when it is, in fact, in a range and not constant. */
2365 if (argrange[0][0] != argrange [0][1])
2366 inform (loc, "argument %i in the range [%E, %E]",
2367 idx[0] + 1, argrange[0][0], argrange[0][1]);
2368 if (argrange[1][0] != argrange [1][1])
2369 inform (loc, "argument %i in the range [%E, %E]",
2370 idx[1] + 1, argrange[1][0], argrange[1][1]);
2374 if (warned && fn)
2376 location_t fnloc = DECL_SOURCE_LOCATION (fn);
2378 if (DECL_IS_UNDECLARED_BUILTIN (fn))
2379 inform (loc,
2380 "in a call to built-in allocation function %qD", fn);
2381 else
2382 inform (fnloc,
2383 "in a call to allocation function %qD declared here", fn);
2387 /* Check a call to an alloca function for an excessive size. */
2389 void
2390 pass_waccess::check_alloca (gcall *stmt)
2392 if (m_early_checks_p)
2393 return;
2395 if ((warn_vla_limit >= HOST_WIDE_INT_MAX
2396 && warn_alloc_size_limit < warn_vla_limit)
2397 || (warn_alloca_limit >= HOST_WIDE_INT_MAX
2398 && warn_alloc_size_limit < warn_alloca_limit))
2400 /* -Walloca-larger-than and -Wvla-larger-than settings of less
2401 than HWI_MAX override the more general -Walloc-size-larger-than
2402 so unless either of the former options is smaller than the last
2403 one (which would imply that the call was already checked), check
2404 the alloca arguments for overflow. */
2405 const tree alloc_args[] = { call_arg (stmt, 0), NULL_TREE };
2406 const int idx[] = { 0, -1 };
2407 maybe_warn_alloc_args_overflow (stmt, alloc_args, idx);
2411 /* Check a call to an allocation function for an excessive size. */
2413 void
2414 pass_waccess::check_alloc_size_call (gcall *stmt)
2416 if (m_early_checks_p)
2417 return;
2419 if (gimple_call_num_args (stmt) < 1)
2420 /* Avoid invalid calls to functions without a prototype. */
2421 return;
2423 tree fndecl = gimple_call_fndecl (stmt);
2424 if (fndecl && gimple_call_builtin_p (stmt, BUILT_IN_NORMAL))
2426 /* Alloca is handled separately. */
2427 switch (DECL_FUNCTION_CODE (fndecl))
2429 case BUILT_IN_ALLOCA:
2430 case BUILT_IN_ALLOCA_WITH_ALIGN:
2431 case BUILT_IN_ALLOCA_WITH_ALIGN_AND_MAX:
2432 return;
2433 default:
2434 break;
2438 tree fntype = gimple_call_fntype (stmt);
2439 tree fntypeattrs = TYPE_ATTRIBUTES (fntype);
2441 tree alloc_size = lookup_attribute ("alloc_size", fntypeattrs);
2442 if (!alloc_size)
2443 return;
2445 /* Extract attribute alloc_size from the type of the called expression
2446 (which could be a function or a function pointer) and if set, store
2447 the indices of the corresponding arguments in ALLOC_IDX, and then
2448 the actual argument(s) at those indices in ALLOC_ARGS. */
2449 int idx[2] = { -1, -1 };
2450 tree alloc_args[] = { NULL_TREE, NULL_TREE };
2451 unsigned nargs = gimple_call_num_args (stmt);
2453 tree args = TREE_VALUE (alloc_size);
2454 idx[0] = TREE_INT_CST_LOW (TREE_VALUE (args)) - 1;
2455 /* Avoid invalid calls to functions without a prototype. */
2456 if ((unsigned) idx[0] >= nargs)
2457 return;
2458 alloc_args[0] = call_arg (stmt, idx[0]);
2459 if (TREE_CHAIN (args))
2461 idx[1] = TREE_INT_CST_LOW (TREE_VALUE (TREE_CHAIN (args))) - 1;
2462 if ((unsigned) idx[1] >= nargs)
2463 return;
2464 alloc_args[1] = call_arg (stmt, idx[1]);
2467 maybe_warn_alloc_args_overflow (stmt, alloc_args, idx);
2470 /* Check a call STMT to strcat() for overflow and warn if it does. */
2472 void
2473 pass_waccess::check_strcat (gcall *stmt)
2475 if (m_early_checks_p)
2476 return;
2478 if (!warn_stringop_overflow && !warn_stringop_overread)
2479 return;
2481 tree dest = call_arg (stmt, 0);
2482 tree src = call_arg (stmt, 1);
2484 /* There is no way here to determine the length of the string in
2485 the destination to which the SRC string is being appended so
2486 just diagnose cases when the source string is longer than
2487 the destination object. */
2488 access_data data (m_ptr_qry.rvals, stmt, access_read_write, NULL_TREE,
2489 true, NULL_TREE, true);
2490 const int ost = warn_stringop_overflow ? warn_stringop_overflow - 1 : 1;
2491 compute_objsize (src, stmt, ost, &data.src, &m_ptr_qry);
2492 tree destsize = compute_objsize (dest, stmt, ost, &data.dst, &m_ptr_qry);
2494 check_access (stmt, /*dstwrite=*/NULL_TREE, /*maxread=*/NULL_TREE,
2495 src, destsize, data.mode, &data, m_ptr_qry.rvals);
2498 /* Check a call STMT to strcat() for overflow and warn if it does. */
2500 void
2501 pass_waccess::check_strncat (gcall *stmt)
2503 if (m_early_checks_p)
2504 return;
2506 if (!warn_stringop_overflow && !warn_stringop_overread)
2507 return;
2509 tree dest = call_arg (stmt, 0);
2510 tree src = call_arg (stmt, 1);
2511 /* The upper bound on the number of bytes to write. */
2512 tree maxread = call_arg (stmt, 2);
2514 /* Detect unterminated source (only). */
2515 if (!check_nul_terminated_array (stmt, src, maxread))
2516 return;
2518 /* The length of the source sequence. */
2519 tree slen = c_strlen (src, 1);
2521 /* Try to determine the range of lengths that the source expression
2522 refers to. Since the lengths are only used for warning and not
2523 for code generation disable strict mode below. */
2524 tree maxlen = slen;
2525 if (!maxlen)
2527 c_strlen_data lendata = { };
2528 get_range_strlen (src, &lendata, /* eltsize = */ 1);
2529 maxlen = lendata.maxbound;
2532 access_data data (m_ptr_qry.rvals, stmt, access_read_write);
2533 /* Try to verify that the destination is big enough for the shortest
2534 string. First try to determine the size of the destination object
2535 into which the source is being copied. */
2536 const int ost = warn_stringop_overflow - 1;
2537 tree destsize = compute_objsize (dest, stmt, ost, &data.dst, &m_ptr_qry);
2539 /* Add one for the terminating nul. */
2540 tree srclen = (maxlen
2541 ? fold_build2 (PLUS_EXPR, size_type_node, maxlen,
2542 size_one_node)
2543 : NULL_TREE);
2545 /* The strncat function copies at most MAXREAD bytes and always appends
2546 the terminating nul so the specified upper bound should never be equal
2547 to (or greater than) the size of the destination. */
2548 if (tree_fits_uhwi_p (maxread) && tree_fits_uhwi_p (destsize)
2549 && tree_int_cst_equal (destsize, maxread))
2551 location_t loc = get_location (stmt);
2552 warning_at (loc, OPT_Wstringop_overflow_,
2553 "%qD specified bound %E equals destination size",
2554 get_callee_fndecl (stmt), maxread);
2556 return;
2559 if (!srclen
2560 || (maxread && tree_fits_uhwi_p (maxread)
2561 && tree_fits_uhwi_p (srclen)
2562 && tree_int_cst_lt (maxread, srclen)))
2563 srclen = maxread;
2565 check_access (stmt, /*dstwrite=*/NULL_TREE, maxread, srclen,
2566 destsize, data.mode, &data, m_ptr_qry.rvals);
2569 /* Check a call STMT to stpcpy() or strcpy() for overflow and warn
2570 if it does. */
2572 void
2573 pass_waccess::check_stxcpy (gcall *stmt)
2575 if (m_early_checks_p)
2576 return;
2578 tree dst = call_arg (stmt, 0);
2579 tree src = call_arg (stmt, 1);
2581 tree size;
2582 bool exact;
2583 if (tree nonstr = unterminated_array (src, &size, &exact))
2585 /* NONSTR refers to the non-nul terminated constant array. */
2586 warn_string_no_nul (get_location (stmt), stmt, NULL, src, nonstr,
2587 size, exact);
2588 return;
2591 if (warn_stringop_overflow)
2593 access_data data (m_ptr_qry.rvals, stmt, access_read_write, NULL_TREE,
2594 true, NULL_TREE, true);
2595 const int ost = warn_stringop_overflow ? warn_stringop_overflow - 1 : 1;
2596 compute_objsize (src, stmt, ost, &data.src, &m_ptr_qry);
2597 tree dstsize = compute_objsize (dst, stmt, ost, &data.dst, &m_ptr_qry);
2598 check_access (stmt, /*dstwrite=*/ NULL_TREE,
2599 /*maxread=*/ NULL_TREE, /*srcstr=*/ src,
2600 dstsize, data.mode, &data, m_ptr_qry.rvals);
2603 /* Check to see if the argument was declared attribute nonstring
2604 and if so, issue a warning since at this point it's not known
2605 to be nul-terminated. */
2606 tree fndecl = get_callee_fndecl (stmt);
2607 maybe_warn_nonstring_arg (fndecl, stmt);
2610 /* Check a call STMT to stpncpy() or strncpy() for overflow and warn
2611 if it does. */
2613 void
2614 pass_waccess::check_stxncpy (gcall *stmt)
2616 if (m_early_checks_p || !warn_stringop_overflow)
2617 return;
2619 tree dst = call_arg (stmt, 0);
2620 tree src = call_arg (stmt, 1);
2621 /* The number of bytes to write (not the maximum). */
2622 tree len = call_arg (stmt, 2);
2624 access_data data (m_ptr_qry.rvals, stmt, access_read_write, len, true, len,
2625 true);
2626 const int ost = warn_stringop_overflow ? warn_stringop_overflow - 1 : 1;
2627 compute_objsize (src, stmt, ost, &data.src, &m_ptr_qry);
2628 tree dstsize = compute_objsize (dst, stmt, ost, &data.dst, &m_ptr_qry);
2630 check_access (stmt, /*dstwrite=*/len, /*maxread=*/len, src, dstsize,
2631 data.mode, &data, m_ptr_qry.rvals);
2634 /* Check a call STMT to stpncpy() or strncpy() for overflow and warn
2635 if it does. */
2637 void
2638 pass_waccess::check_strncmp (gcall *stmt)
2640 if (m_early_checks_p || !warn_stringop_overread)
2641 return;
2643 tree arg1 = call_arg (stmt, 0);
2644 tree arg2 = call_arg (stmt, 1);
2645 tree bound = call_arg (stmt, 2);
2647 /* First check each argument separately, considering the bound. */
2648 if (!check_nul_terminated_array (stmt, arg1, bound)
2649 || !check_nul_terminated_array (stmt, arg2, bound))
2650 return;
2652 /* A strncmp read from each argument is constrained not just by
2653 the bound but also by the length of the shorter string. Specifying
2654 a bound that's larger than the size of either array makes no sense
2655 and is likely a bug. When the length of neither of the two strings
2656 is known but the sizes of both of the arrays they are stored in is,
2657 issue a warning if the bound is larger than the size of
2658 the larger of the two arrays. */
2660 c_strlen_data lendata1{ }, lendata2{ };
2661 tree len1 = c_strlen (arg1, 1, &lendata1);
2662 tree len2 = c_strlen (arg2, 1, &lendata2);
2664 if (len1 && TREE_CODE (len1) != INTEGER_CST)
2665 len1 = NULL_TREE;
2666 if (len2 && TREE_CODE (len2) != INTEGER_CST)
2667 len2 = NULL_TREE;
2669 if (len1 && len2)
2670 /* If the length of both arguments was computed they must both be
2671 nul-terminated and no further checking is necessary regardless
2672 of the bound. */
2673 return;
2675 /* Check to see if the argument was declared with attribute nonstring
2676 and if so, issue a warning since at this point it's not known to be
2677 nul-terminated. */
2678 if (maybe_warn_nonstring_arg (get_callee_fndecl (stmt), stmt))
2679 return;
2681 access_data adata1 (m_ptr_qry.rvals, stmt, access_read_only, NULL_TREE, false,
2682 bound, true);
2683 access_data adata2 (m_ptr_qry.rvals, stmt, access_read_only, NULL_TREE, false,
2684 bound, true);
2686 /* Determine the range of the bound first and bail if it fails; it's
2687 cheaper than computing the size of the objects. */
2688 tree bndrng[2] = { NULL_TREE, NULL_TREE };
2689 get_size_range (m_ptr_qry.rvals, bound, stmt, bndrng, 0, adata1.src_bndrng);
2690 if (!bndrng[0] || integer_zerop (bndrng[0]))
2691 return;
2693 if (len1 && tree_int_cst_lt (len1, bndrng[0]))
2694 bndrng[0] = len1;
2695 if (len2 && tree_int_cst_lt (len2, bndrng[0]))
2696 bndrng[0] = len2;
2698 /* compute_objsize almost never fails (and ultimately should never
2699 fail). Don't bother to handle the rare case when it does. */
2700 if (!compute_objsize (arg1, stmt, 1, &adata1.src, &m_ptr_qry)
2701 || !compute_objsize (arg2, stmt, 1, &adata2.src, &m_ptr_qry))
2702 return;
2704 /* Compute the size of the remaining space in each array after
2705 subtracting any offset into it. */
2706 offset_int rem1 = adata1.src.size_remaining ();
2707 offset_int rem2 = adata2.src.size_remaining ();
2709 /* Cap REM1 and REM2 at the other if the other's argument is known
2710 to be an unterminated array, either because there's no space
2711 left in it after adding its offset or because it's constant and
2712 has no nul. */
2713 if (rem1 == 0 || (rem1 < rem2 && lendata1.decl))
2714 rem2 = rem1;
2715 else if (rem2 == 0 || (rem2 < rem1 && lendata2.decl))
2716 rem1 = rem2;
2718 /* Point PAD at the array to reference in the note if a warning
2719 is issued. */
2720 access_data *pad = len1 ? &adata2 : &adata1;
2721 offset_int maxrem = wi::max (rem1, rem2, UNSIGNED);
2722 if (lendata1.decl || lendata2.decl
2723 || maxrem < wi::to_offset (bndrng[0]))
2725 /* Warn when either argument isn't nul-terminated or the maximum
2726 remaining space in the two arrays is less than the bound. */
2727 tree func = get_callee_fndecl (stmt);
2728 location_t loc = gimple_location (stmt);
2729 maybe_warn_for_bound (OPT_Wstringop_overread, loc, stmt, func,
2730 bndrng, wide_int_to_tree (sizetype, maxrem),
2731 pad);
2735 /* Determine and check the sizes of the source and the destination
2736 of calls to __builtin_{bzero,memcpy,mempcpy,memset} calls. STMT is
2737 the call statement, DEST is the destination argument, SRC is the source
2738 argument or null, and SIZE is the number of bytes being accessed. Use
2739 Object Size type-0 regardless of the OPT_Wstringop_overflow_ setting.
2740 Return true on success (no overflow or invalid sizes), false otherwise. */
2742 void
2743 pass_waccess::check_memop_access (gimple *stmt, tree dest, tree src, tree size)
2745 if (m_early_checks_p)
2746 return;
2748 /* For functions like memset and memcpy that operate on raw memory
2749 try to determine the size of the largest source and destination
2750 object using type-0 Object Size regardless of the object size
2751 type specified by the option. */
2752 access_data data (m_ptr_qry.rvals, stmt, access_read_write);
2753 tree srcsize
2754 = src ? compute_objsize (src, stmt, 0, &data.src, &m_ptr_qry) : NULL_TREE;
2755 tree dstsize = compute_objsize (dest, stmt, 0, &data.dst, &m_ptr_qry);
2757 check_access (stmt, size, /*maxread=*/NULL_TREE, srcsize, dstsize,
2758 data.mode, &data, m_ptr_qry.rvals);
2761 /* A convenience wrapper for check_access to check access by a read-only
2762 function like puts or strcmp. */
2764 void
2765 pass_waccess::check_read_access (gimple *stmt, tree src,
2766 tree bound /* = NULL_TREE */,
2767 int ost /* = 1 */)
2769 if (m_early_checks_p || !warn_stringop_overread)
2770 return;
2772 if (bound && !useless_type_conversion_p (size_type_node, TREE_TYPE (bound)))
2773 bound = fold_convert (size_type_node, bound);
2775 tree fndecl = get_callee_fndecl (stmt);
2776 maybe_warn_nonstring_arg (fndecl, stmt);
2778 access_data data (m_ptr_qry.rvals, stmt, access_read_only, NULL_TREE,
2779 false, bound, true);
2780 compute_objsize (src, stmt, ost, &data.src, &m_ptr_qry);
2781 check_access (stmt, /*dstwrite=*/ NULL_TREE, /*maxread=*/ bound,
2782 /*srcstr=*/ src, /*dstsize=*/ NULL_TREE, data.mode,
2783 &data, m_ptr_qry.rvals);
2786 /* Return true if memory model ORD is constant in the context of STMT and
2787 set *CSTVAL to the constant value. Otherwise return false. Warn for
2788 invalid ORD. */
2790 bool
2791 memmodel_to_uhwi (tree ord, gimple *stmt, unsigned HOST_WIDE_INT *cstval)
2793 unsigned HOST_WIDE_INT val;
2795 if (TREE_CODE (ord) == INTEGER_CST)
2797 if (!tree_fits_uhwi_p (ord))
2798 return false;
2799 val = tree_to_uhwi (ord);
2801 else
2803 /* Use the range query to determine constant values in the absence
2804 of constant propagation (such as at -O0). */
2805 Value_Range rng (TREE_TYPE (ord));
2806 if (!get_range_query (cfun)->range_of_expr (rng, ord, stmt)
2807 || !rng.singleton_p (&ord))
2808 return false;
2810 wide_int lob = rng.lower_bound ();
2811 if (!wi::fits_uhwi_p (lob))
2812 return false;
2814 val = lob.to_shwi ();
2817 if (targetm.memmodel_check)
2818 /* This might warn for an invalid VAL but return a conservatively
2819 valid result. */
2820 val = targetm.memmodel_check (val);
2821 else if (val & ~MEMMODEL_MASK)
2823 tree fndecl = gimple_call_fndecl (stmt);
2824 location_t loc = gimple_location (stmt);
2825 loc = expansion_point_location_if_in_system_header (loc);
2827 warning_at (loc, OPT_Winvalid_memory_model,
2828 "unknown architecture specifier in memory model "
2829 "%wi for %qD", val, fndecl);
2830 return false;
2833 *cstval = val;
2835 return true;
2838 /* Valid memory model for each set of atomic built-in functions. */
2840 struct memmodel_pair
2842 memmodel modval;
2843 const char* modname;
2845 #define MEMMODEL_PAIR(val, str) \
2846 { MEMMODEL_ ## val, "memory_order_" str }
2849 /* Valid memory models in the order of increasing strength. */
2851 static const memmodel_pair memory_models[] =
2852 { MEMMODEL_PAIR (RELAXED, "relaxed"),
2853 MEMMODEL_PAIR (SEQ_CST, "seq_cst"),
2854 MEMMODEL_PAIR (ACQUIRE, "acquire"),
2855 MEMMODEL_PAIR (CONSUME, "consume"),
2856 MEMMODEL_PAIR (RELEASE, "release"),
2857 MEMMODEL_PAIR (ACQ_REL, "acq_rel")
2860 /* Return the name of the memory model VAL. */
2862 static const char*
2863 memmodel_name (unsigned HOST_WIDE_INT val)
2865 val = memmodel_base (val);
2867 for (unsigned i = 0; i != ARRAY_SIZE (memory_models); ++i)
2869 if (val == memory_models[i].modval)
2870 return memory_models[i].modname;
2872 return NULL;
2875 /* Indices of valid MEMORY_MODELS above for corresponding atomic operations. */
2876 static const unsigned char load_models[] = { 0, 1, 2, 3, UCHAR_MAX };
2877 static const unsigned char store_models[] = { 0, 1, 4, UCHAR_MAX };
2878 static const unsigned char xchg_models[] = { 0, 1, 3, 4, 5, UCHAR_MAX };
2879 static const unsigned char flag_clr_models[] = { 0, 1, 4, UCHAR_MAX };
2880 static const unsigned char all_models[] = { 0, 1, 2, 3, 4, 5, UCHAR_MAX };
2882 /* Check the success memory model argument ORD_SUCS to the call STMT to
2883 an atomic function and warn if it's invalid. If nonnull, also check
2884 the failure memory model ORD_FAIL and warn if it's invalid. Return
2885 true if a warning has been issued. */
2887 bool
2888 pass_waccess::maybe_warn_memmodel (gimple *stmt, tree ord_sucs,
2889 tree ord_fail, const unsigned char *valid)
2891 unsigned HOST_WIDE_INT sucs, fail = 0;
2892 if (!memmodel_to_uhwi (ord_sucs, stmt, &sucs)
2893 || (ord_fail && !memmodel_to_uhwi (ord_fail, stmt, &fail)))
2894 return false;
2896 bool is_valid = false;
2897 if (valid)
2898 for (unsigned i = 0; valid[i] != UCHAR_MAX; ++i)
2900 memmodel model = memory_models[valid[i]].modval;
2901 if (memmodel_base (sucs) == model)
2903 is_valid = true;
2904 break;
2907 else
2908 is_valid = true;
2910 tree fndecl = gimple_call_fndecl (stmt);
2911 location_t loc = gimple_location (stmt);
2912 loc = expansion_point_location_if_in_system_header (loc);
2914 if (!is_valid)
2916 bool warned = false;
2917 auto_diagnostic_group d;
2918 if (const char *modname = memmodel_name (sucs))
2919 warned = warning_at (loc, OPT_Winvalid_memory_model,
2920 "invalid memory model %qs for %qD",
2921 modname, fndecl);
2922 else
2923 warned = warning_at (loc, OPT_Winvalid_memory_model,
2924 "invalid memory model %wi for %qD",
2925 sucs, fndecl);
2927 if (!warned)
2928 return false;
2930 /* Print a note with the valid memory models. */
2931 pretty_printer pp;
2932 pp_show_color (&pp) = pp_show_color (global_dc->printer);
2933 for (unsigned i = 0; valid[i] != UCHAR_MAX; ++i)
2935 const char *modname = memory_models[valid[i]].modname;
2936 pp_printf (&pp, "%s%qs", i ? ", " : "", modname);
2939 inform (loc, "valid models are %s", pp_formatted_text (&pp));
2940 return true;
2943 if (!ord_fail)
2944 return false;
2946 if (fail == MEMMODEL_RELEASE || fail == MEMMODEL_ACQ_REL)
2947 if (const char *failname = memmodel_name (fail))
2949 /* If both memory model arguments are valid but their combination
2950 is not, use their names in the warning. */
2951 auto_diagnostic_group d;
2952 if (!warning_at (loc, OPT_Winvalid_memory_model,
2953 "invalid failure memory model %qs for %qD",
2954 failname, fndecl))
2955 return false;
2957 inform (loc,
2958 "valid failure models are %qs, %qs, %qs, %qs",
2959 "memory_order_relaxed", "memory_order_seq_cst",
2960 "memory_order_acquire", "memory_order_consume");
2961 return true;
2964 if (memmodel_base (fail) <= memmodel_base (sucs))
2965 return false;
2967 if (const char *sucsname = memmodel_name (sucs))
2968 if (const char *failname = memmodel_name (fail))
2970 /* If both memory model arguments are valid but their combination
2971 is not, use their names in the warning. */
2972 auto_diagnostic_group d;
2973 if (!warning_at (loc, OPT_Winvalid_memory_model,
2974 "failure memory model %qs cannot be stronger "
2975 "than success memory model %qs for %qD",
2976 failname, sucsname, fndecl))
2977 return false;
2979 /* Print a note with the valid failure memory models which are
2980 those with a value less than or equal to the success mode. */
2981 char buf[120];
2982 *buf = '\0';
2983 for (unsigned i = 0;
2984 memory_models[i].modval <= memmodel_base (sucs); ++i)
2986 if (*buf)
2987 strcat (buf, ", ");
2989 const char *modname = memory_models[valid[i]].modname;
2990 sprintf (buf + strlen (buf), "'%s'", modname);
2993 inform (loc, "valid models are %s", buf);
2994 return true;
2997 /* If either memory model argument value is invalid use the numerical
2998 value of both in the message. */
2999 return warning_at (loc, OPT_Winvalid_memory_model,
3000 "failure memory model %wi cannot be stronger "
3001 "than success memory model %wi for %qD",
3002 fail, sucs, fndecl);
3005 /* Wrapper for the above. */
3007 void
3008 pass_waccess::check_atomic_memmodel (gimple *stmt, tree ord_sucs,
3009 tree ord_fail, const unsigned char *valid)
3011 if (warning_suppressed_p (stmt, OPT_Winvalid_memory_model))
3012 return;
3014 if (!maybe_warn_memmodel (stmt, ord_sucs, ord_fail, valid))
3015 return;
3017 suppress_warning (stmt, OPT_Winvalid_memory_model);
3020 /* Check a call STMT to an atomic or sync built-in. */
3022 bool
3023 pass_waccess::check_atomic_builtin (gcall *stmt)
3025 tree callee = gimple_call_fndecl (stmt);
3026 if (!callee)
3027 return false;
3029 /* The size in bytes of the access by the function, and the number
3030 of the second argument to check (if any). */
3031 unsigned bytes = 0, arg2 = UINT_MAX;
3032 unsigned sucs_arg = UINT_MAX, fail_arg = UINT_MAX;
3033 /* Points to the array of indices of valid memory models. */
3034 const unsigned char *pvalid_models = NULL;
3036 switch (DECL_FUNCTION_CODE (callee))
3038 #define BUILTIN_ACCESS_SIZE_FNSPEC(N) \
3039 BUILT_IN_SYNC_FETCH_AND_ADD_ ## N: \
3040 case BUILT_IN_SYNC_FETCH_AND_SUB_ ## N: \
3041 case BUILT_IN_SYNC_FETCH_AND_OR_ ## N: \
3042 case BUILT_IN_SYNC_FETCH_AND_AND_ ## N: \
3043 case BUILT_IN_SYNC_FETCH_AND_XOR_ ## N: \
3044 case BUILT_IN_SYNC_FETCH_AND_NAND_ ## N: \
3045 case BUILT_IN_SYNC_ADD_AND_FETCH_ ## N: \
3046 case BUILT_IN_SYNC_SUB_AND_FETCH_ ## N: \
3047 case BUILT_IN_SYNC_OR_AND_FETCH_ ## N: \
3048 case BUILT_IN_SYNC_AND_AND_FETCH_ ## N: \
3049 case BUILT_IN_SYNC_XOR_AND_FETCH_ ## N: \
3050 case BUILT_IN_SYNC_NAND_AND_FETCH_ ## N: \
3051 case BUILT_IN_SYNC_LOCK_TEST_AND_SET_ ## N: \
3052 case BUILT_IN_SYNC_BOOL_COMPARE_AND_SWAP_ ## N: \
3053 case BUILT_IN_SYNC_VAL_COMPARE_AND_SWAP_ ## N: \
3054 case BUILT_IN_SYNC_LOCK_RELEASE_ ## N: \
3055 bytes = N; \
3056 break; \
3057 case BUILT_IN_ATOMIC_LOAD_ ## N: \
3058 pvalid_models = load_models; \
3059 sucs_arg = 1; \
3060 /* FALLTHROUGH */ \
3061 case BUILT_IN_ATOMIC_STORE_ ## N: \
3062 if (!pvalid_models) \
3063 pvalid_models = store_models; \
3064 /* FALLTHROUGH */ \
3065 case BUILT_IN_ATOMIC_ADD_FETCH_ ## N: \
3066 case BUILT_IN_ATOMIC_SUB_FETCH_ ## N: \
3067 case BUILT_IN_ATOMIC_AND_FETCH_ ## N: \
3068 case BUILT_IN_ATOMIC_NAND_FETCH_ ## N: \
3069 case BUILT_IN_ATOMIC_XOR_FETCH_ ## N: \
3070 case BUILT_IN_ATOMIC_OR_FETCH_ ## N: \
3071 case BUILT_IN_ATOMIC_FETCH_ADD_ ## N: \
3072 case BUILT_IN_ATOMIC_FETCH_SUB_ ## N: \
3073 case BUILT_IN_ATOMIC_FETCH_AND_ ## N: \
3074 case BUILT_IN_ATOMIC_FETCH_NAND_ ## N: \
3075 case BUILT_IN_ATOMIC_FETCH_OR_ ## N: \
3076 case BUILT_IN_ATOMIC_FETCH_XOR_ ## N: \
3077 bytes = N; \
3078 if (sucs_arg == UINT_MAX) \
3079 sucs_arg = 2; \
3080 if (!pvalid_models) \
3081 pvalid_models = all_models; \
3082 break; \
3083 case BUILT_IN_ATOMIC_EXCHANGE_ ## N: \
3084 bytes = N; \
3085 sucs_arg = 3; \
3086 pvalid_models = xchg_models; \
3087 break; \
3088 case BUILT_IN_ATOMIC_COMPARE_EXCHANGE_ ## N: \
3089 bytes = N; \
3090 sucs_arg = 4; \
3091 fail_arg = 5; \
3092 pvalid_models = all_models; \
3093 arg2 = 1
3095 case BUILTIN_ACCESS_SIZE_FNSPEC (1);
3096 break;
3097 case BUILTIN_ACCESS_SIZE_FNSPEC (2);
3098 break;
3099 case BUILTIN_ACCESS_SIZE_FNSPEC (4);
3100 break;
3101 case BUILTIN_ACCESS_SIZE_FNSPEC (8);
3102 break;
3103 case BUILTIN_ACCESS_SIZE_FNSPEC (16);
3104 break;
3106 case BUILT_IN_ATOMIC_CLEAR:
3107 sucs_arg = 1;
3108 pvalid_models = flag_clr_models;
3109 break;
3111 default:
3112 return false;
3115 unsigned nargs = gimple_call_num_args (stmt);
3116 if (sucs_arg < nargs)
3118 tree ord_sucs = gimple_call_arg (stmt, sucs_arg);
3119 tree ord_fail = NULL_TREE;
3120 if (fail_arg < nargs)
3121 ord_fail = gimple_call_arg (stmt, fail_arg);
3122 check_atomic_memmodel (stmt, ord_sucs, ord_fail, pvalid_models);
3125 if (!bytes)
3126 return true;
3128 tree size = build_int_cstu (sizetype, bytes);
3129 tree dst = gimple_call_arg (stmt, 0);
3130 check_memop_access (stmt, dst, NULL_TREE, size);
3132 if (arg2 != UINT_MAX)
3134 tree dst = gimple_call_arg (stmt, arg2);
3135 check_memop_access (stmt, dst, NULL_TREE, size);
3138 return true;
3141 /* Check call STMT to a built-in function for invalid accesses. Return
3142 true if a call has been handled. */
3144 bool
3145 pass_waccess::check_builtin (gcall *stmt)
3147 tree callee = gimple_call_fndecl (stmt);
3148 if (!callee)
3149 return false;
3151 switch (DECL_FUNCTION_CODE (callee))
3153 case BUILT_IN_ALLOCA:
3154 case BUILT_IN_ALLOCA_WITH_ALIGN:
3155 case BUILT_IN_ALLOCA_WITH_ALIGN_AND_MAX:
3156 check_alloca (stmt);
3157 return true;
3159 case BUILT_IN_EXECL:
3160 case BUILT_IN_EXECLE:
3161 case BUILT_IN_EXECLP:
3162 case BUILT_IN_EXECV:
3163 case BUILT_IN_EXECVE:
3164 case BUILT_IN_EXECVP:
3165 check_read_access (stmt, call_arg (stmt, 0));
3166 return true;
3168 case BUILT_IN_FREE:
3169 case BUILT_IN_REALLOC:
3170 if (!m_early_checks_p)
3172 tree arg = call_arg (stmt, 0);
3173 if (TREE_CODE (arg) == SSA_NAME)
3174 check_pointer_uses (stmt, arg);
3176 return true;
3178 case BUILT_IN_GETTEXT:
3179 case BUILT_IN_PUTS:
3180 case BUILT_IN_PUTS_UNLOCKED:
3181 case BUILT_IN_STRDUP:
3182 check_read_access (stmt, call_arg (stmt, 0));
3183 return true;
3185 case BUILT_IN_INDEX:
3186 case BUILT_IN_RINDEX:
3187 case BUILT_IN_STRCHR:
3188 case BUILT_IN_STRRCHR:
3189 case BUILT_IN_STRLEN:
3190 check_read_access (stmt, call_arg (stmt, 0));
3191 return true;
3193 case BUILT_IN_FPUTS:
3194 case BUILT_IN_FPUTS_UNLOCKED:
3195 check_read_access (stmt, call_arg (stmt, 0));
3196 return true;
3198 case BUILT_IN_STRNDUP:
3199 case BUILT_IN_STRNLEN:
3201 tree str = call_arg (stmt, 0);
3202 tree len = call_arg (stmt, 1);
3203 check_read_access (stmt, str, len);
3204 return true;
3207 case BUILT_IN_STRCAT:
3208 check_strcat (stmt);
3209 return true;
3211 case BUILT_IN_STRNCAT:
3212 check_strncat (stmt);
3213 return true;
3215 case BUILT_IN_STPCPY:
3216 case BUILT_IN_STRCPY:
3217 check_stxcpy (stmt);
3218 return true;
3220 case BUILT_IN_STPNCPY:
3221 case BUILT_IN_STRNCPY:
3222 check_stxncpy (stmt);
3223 return true;
3225 case BUILT_IN_STRCASECMP:
3226 case BUILT_IN_STRCMP:
3227 case BUILT_IN_STRPBRK:
3228 case BUILT_IN_STRSPN:
3229 case BUILT_IN_STRCSPN:
3230 case BUILT_IN_STRSTR:
3231 check_read_access (stmt, call_arg (stmt, 0));
3232 check_read_access (stmt, call_arg (stmt, 1));
3233 return true;
3235 case BUILT_IN_STRNCASECMP:
3236 case BUILT_IN_STRNCMP:
3237 check_strncmp (stmt);
3238 return true;
3240 case BUILT_IN_MEMCMP:
3242 tree a1 = call_arg (stmt, 0);
3243 tree a2 = call_arg (stmt, 1);
3244 tree len = call_arg (stmt, 2);
3245 check_read_access (stmt, a1, len, 0);
3246 check_read_access (stmt, a2, len, 0);
3247 return true;
3250 case BUILT_IN_MEMCPY:
3251 case BUILT_IN_MEMPCPY:
3252 case BUILT_IN_MEMMOVE:
3254 tree dst = call_arg (stmt, 0);
3255 tree src = call_arg (stmt, 1);
3256 tree len = call_arg (stmt, 2);
3257 check_memop_access (stmt, dst, src, len);
3258 return true;
3261 case BUILT_IN_MEMCHR:
3263 tree src = call_arg (stmt, 0);
3264 tree len = call_arg (stmt, 2);
3265 check_read_access (stmt, src, len, 0);
3266 return true;
3269 case BUILT_IN_MEMSET:
3271 tree dst = call_arg (stmt, 0);
3272 tree len = call_arg (stmt, 2);
3273 check_memop_access (stmt, dst, NULL_TREE, len);
3274 return true;
3277 default:
3278 if (check_atomic_builtin (stmt))
3279 return true;
3280 break;
3283 return false;
3286 /* Returns the type of the argument ARGNO to function with type FNTYPE
3287 or null when the type cannot be determined or no such argument exists. */
3289 static tree
3290 fntype_argno_type (tree fntype, unsigned argno)
3292 if (!prototype_p (fntype))
3293 return NULL_TREE;
3295 tree argtype;
3296 function_args_iterator it;
3297 FOREACH_FUNCTION_ARGS (fntype, argtype, it)
3298 if (argno-- == 0)
3299 return argtype;
3301 return NULL_TREE;
3304 /* Helper to append the "human readable" attribute access specification
3305 described by ACCESS to the array ATTRSTR with size STRSIZE. Used in
3306 diagnostics. */
3308 static inline void
3309 append_attrname (const std::pair<int, attr_access> &access,
3310 char *attrstr, size_t strsize)
3312 if (access.second.internal_p)
3313 return;
3315 tree str = access.second.to_external_string ();
3316 gcc_assert (strsize >= (size_t) TREE_STRING_LENGTH (str));
3317 strcpy (attrstr, TREE_STRING_POINTER (str));
3320 /* Iterate over attribute access read-only, read-write, and write-only
3321 arguments and diagnose past-the-end accesses and related problems
3322 in the function call EXP. */
3324 void
3325 pass_waccess::maybe_check_access_sizes (rdwr_map *rwm, tree fndecl, tree fntype,
3326 gimple *stmt)
3328 if (warning_suppressed_p (stmt, OPT_Wnonnull)
3329 || warning_suppressed_p (stmt, OPT_Wstringop_overflow_))
3330 return;
3332 auto_diagnostic_group adg;
3334 /* Set if a warning has been issued for any argument (used to decide
3335 whether to emit an informational note at the end). */
3336 opt_code opt_warned = no_warning;
3338 /* A string describing the attributes that the warnings issued by this
3339 function apply to. Used to print one informational note per function
3340 call, rather than one per warning. That reduces clutter. */
3341 char attrstr[80];
3342 attrstr[0] = 0;
3344 for (rdwr_map::iterator it = rwm->begin (); it != rwm->end (); ++it)
3346 std::pair<int, attr_access> access = *it;
3348 /* Get the function call arguments corresponding to the attribute's
3349 positional arguments. When both arguments have been specified
3350 there will be two entries in *RWM, one for each. They are
3351 cross-referenced by their respective argument numbers in
3352 ACCESS.PTRARG and ACCESS.SIZARG. */
3353 const int ptridx = access.second.ptrarg;
3354 const int sizidx = access.second.sizarg;
3356 gcc_assert (ptridx != -1);
3357 gcc_assert (access.first == ptridx || access.first == sizidx);
3359 /* The pointer is set to null for the entry corresponding to
3360 the size argument. Skip it. It's handled when the entry
3361 corresponding to the pointer argument comes up. */
3362 if (!access.second.ptr)
3363 continue;
3365 tree ptrtype = fntype_argno_type (fntype, ptridx);
3366 if (!ptrtype)
3367 /* A function with a prototype was redeclared without one and
3368 the prototype has been lost. See pr102759. Avoid dealing
3369 with this pathological case. */
3370 return;
3372 tree argtype = TREE_TYPE (ptrtype);
3374 /* The size of the access by the call in elements. */
3375 tree access_nelts;
3376 if (sizidx == -1)
3378 /* If only the pointer attribute operand was specified and
3379 not size, set SIZE to the greater of MINSIZE or size of
3380 one element of the pointed to type to detect smaller
3381 objects (null pointers are diagnosed in this case only
3382 if the pointer is also declared with attribute nonnull. */
3383 if (access.second.minsize
3384 && access.second.minsize != HOST_WIDE_INT_M1U)
3385 access_nelts = build_int_cstu (sizetype, access.second.minsize);
3386 else if (VOID_TYPE_P (argtype) && access.second.mode == access_none)
3387 /* Treat access mode none on a void* argument as expecting
3388 as little as zero bytes. */
3389 access_nelts = size_zero_node;
3390 else
3391 access_nelts = size_one_node;
3393 else
3394 access_nelts = rwm->get (sizidx)->size;
3396 /* Format the value or range to avoid an explosion of messages. */
3397 char sizstr[80];
3398 tree sizrng[2] = { size_zero_node, build_all_ones_cst (sizetype) };
3399 if (get_size_range (m_ptr_qry.rvals, access_nelts, stmt, sizrng, 1))
3401 char *s0 = print_generic_expr_to_str (sizrng[0]);
3402 if (tree_int_cst_equal (sizrng[0], sizrng[1]))
3404 gcc_checking_assert (strlen (s0) < sizeof sizstr);
3405 strcpy (sizstr, s0);
3407 else
3409 char *s1 = print_generic_expr_to_str (sizrng[1]);
3410 gcc_checking_assert (strlen (s0) + strlen (s1)
3411 < sizeof sizstr - 4);
3412 sprintf (sizstr, "[%.37s, %.37s]", s0, s1);
3413 free (s1);
3415 free (s0);
3417 else
3418 *sizstr = '\0';
3420 /* Set if a warning has been issued for the current argument. */
3421 opt_code arg_warned = no_warning;
3422 location_t loc = get_location (stmt);
3423 tree ptr = access.second.ptr;
3424 if (*sizstr
3425 && tree_int_cst_sgn (sizrng[0]) < 0
3426 && tree_int_cst_sgn (sizrng[1]) < 0)
3428 /* Warn about negative sizes. */
3429 if (access.second.internal_p)
3431 const std::string argtypestr
3432 = access.second.array_as_string (ptrtype);
3434 if (warning_at (loc, OPT_Wstringop_overflow_,
3435 "bound argument %i value %s is "
3436 "negative for a variable length array "
3437 "argument %i of type %s",
3438 sizidx + 1, sizstr,
3439 ptridx + 1, argtypestr.c_str ()))
3440 arg_warned = OPT_Wstringop_overflow_;
3442 else if (warning_at (loc, OPT_Wstringop_overflow_,
3443 "argument %i value %s is negative",
3444 sizidx + 1, sizstr))
3445 arg_warned = OPT_Wstringop_overflow_;
3447 if (arg_warned != no_warning)
3449 append_attrname (access, attrstr, sizeof attrstr);
3450 /* Remember a warning has been issued and avoid warning
3451 again below for the same attribute. */
3452 opt_warned = arg_warned;
3453 continue;
3457 /* The size of the access by the call in bytes. */
3458 tree access_size = NULL_TREE;
3459 if (tree_int_cst_sgn (sizrng[0]) >= 0)
3461 if (COMPLETE_TYPE_P (argtype))
3463 /* Multiply ACCESS_SIZE by the size of the type the pointer
3464 argument points to. If it's incomplete the size is used
3465 as is. */
3466 if (tree argsize = TYPE_SIZE_UNIT (argtype))
3467 if (TREE_CODE (argsize) == INTEGER_CST)
3469 const int prec = TYPE_PRECISION (sizetype);
3470 wide_int minsize = wi::to_wide (sizrng[0], prec);
3471 minsize *= wi::to_wide (argsize, prec);
3472 access_size = wide_int_to_tree (sizetype, minsize);
3475 else
3476 access_size = access_nelts;
3479 if (integer_zerop (ptr))
3481 if (sizidx >= 0 && tree_int_cst_sgn (sizrng[0]) > 0)
3483 /* Warn about null pointers with positive sizes. This is
3484 different from also declaring the pointer argument with
3485 attribute nonnull when the function accepts null pointers
3486 only when the corresponding size is zero. */
3487 if (access.second.internal_p)
3489 const std::string argtypestr
3490 = access.second.array_as_string (ptrtype);
3492 if (warning_at (loc, OPT_Wnonnull,
3493 "argument %i of variable length "
3494 "array %s is null but "
3495 "the corresponding bound argument "
3496 "%i value is %s",
3497 ptridx + 1, argtypestr.c_str (),
3498 sizidx + 1, sizstr))
3499 arg_warned = OPT_Wnonnull;
3501 else if (warning_at (loc, OPT_Wnonnull,
3502 "argument %i is null but "
3503 "the corresponding size argument "
3504 "%i value is %s",
3505 ptridx + 1, sizidx + 1, sizstr))
3506 arg_warned = OPT_Wnonnull;
3508 else if (access_size && access.second.static_p)
3510 /* Warn about null pointers for [static N] array arguments
3511 but do not warn for ordinary (i.e., nonstatic) arrays. */
3512 if (warning_at (loc, OPT_Wnonnull,
3513 "argument %i to %<%T[static %E]%> "
3514 "is null where non-null expected",
3515 ptridx + 1, argtype, access_nelts))
3516 arg_warned = OPT_Wnonnull;
3519 if (arg_warned != no_warning)
3521 append_attrname (access, attrstr, sizeof attrstr);
3522 /* Remember a warning has been issued and avoid warning
3523 again below for the same attribute. */
3524 opt_warned = OPT_Wnonnull;
3525 continue;
3529 access_data data (m_ptr_qry.rvals, stmt, access.second.mode,
3530 NULL_TREE, false, NULL_TREE, false);
3531 access_ref* const pobj = (access.second.mode == access_write_only
3532 ? &data.dst : &data.src);
3533 tree objsize = compute_objsize (ptr, stmt, 1, pobj, &m_ptr_qry);
3535 /* The size of the destination or source object. */
3536 tree dstsize = NULL_TREE, srcsize = NULL_TREE;
3537 if (access.second.mode == access_read_only
3538 || access.second.mode == access_none)
3540 /* For a read-only argument there is no destination. For
3541 no access, set the source as well and differentiate via
3542 the access flag below. */
3543 srcsize = objsize;
3544 if (access.second.mode == access_read_only
3545 || access.second.mode == access_none)
3547 /* For a read-only attribute there is no destination so
3548 clear OBJSIZE. This emits "reading N bytes" kind of
3549 diagnostics instead of the "writing N bytes" kind,
3550 unless MODE is none. */
3551 objsize = NULL_TREE;
3554 else
3555 dstsize = objsize;
3557 /* Clear the no-warning bit in case it was set by check_access
3558 in a prior iteration so that accesses via different arguments
3559 are diagnosed. */
3560 suppress_warning (stmt, OPT_Wstringop_overflow_, false);
3561 access_mode mode = data.mode;
3562 if (mode == access_deferred)
3563 mode = TYPE_READONLY (argtype) ? access_read_only : access_read_write;
3564 check_access (stmt, access_size, /*maxread=*/ NULL_TREE, srcsize,
3565 dstsize, mode, &data, m_ptr_qry.rvals);
3567 if (warning_suppressed_p (stmt, OPT_Wstringop_overflow_))
3568 opt_warned = OPT_Wstringop_overflow_;
3569 if (opt_warned != no_warning)
3571 if (access.second.internal_p)
3573 unsigned HOST_WIDE_INT nelts =
3574 access_nelts ? access.second.minsize : HOST_WIDE_INT_M1U;
3575 tree arrtype = build_printable_array_type (argtype, nelts);
3576 inform (loc, "referencing argument %u of type %qT",
3577 ptridx + 1, arrtype);
3579 else
3580 /* If check_access issued a warning above, append the relevant
3581 attribute to the string. */
3582 append_attrname (access, attrstr, sizeof attrstr);
3586 if (*attrstr)
3588 if (fndecl)
3589 inform (get_location (fndecl),
3590 "in a call to function %qD declared with attribute %qs",
3591 fndecl, attrstr);
3592 else
3593 inform (get_location (stmt),
3594 "in a call with type %qT and attribute %qs",
3595 fntype, attrstr);
3597 else if (opt_warned != no_warning)
3599 if (fndecl)
3600 inform (get_location (fndecl),
3601 "in a call to function %qD", fndecl);
3602 else
3603 inform (get_location (stmt),
3604 "in a call with type %qT", fntype);
3607 /* Set the bit in case it was cleared and not set above. */
3608 if (opt_warned != no_warning)
3609 suppress_warning (stmt, opt_warned);
3612 /* Check call STMT to an ordinary (non-built-in) function for invalid
3613 accesses. Return true if a call has been handled. */
3615 bool
3616 pass_waccess::check_call_access (gcall *stmt)
3618 tree fntype = gimple_call_fntype (stmt);
3619 if (!fntype)
3620 return false;
3622 tree fntypeattrs = TYPE_ATTRIBUTES (fntype);
3623 if (!fntypeattrs)
3624 return false;
3626 /* Map of attribute access specifications for function arguments. */
3627 rdwr_map rdwr_idx;
3628 init_attr_rdwr_indices (&rdwr_idx, fntypeattrs);
3630 unsigned nargs = call_nargs (stmt);
3631 for (unsigned i = 0; i != nargs; ++i)
3633 tree arg = call_arg (stmt, i);
3635 /* Save the actual argument that corresponds to the access attribute
3636 operand for later processing. */
3637 if (attr_access *access = rdwr_idx.get (i))
3639 if (POINTER_TYPE_P (TREE_TYPE (arg)))
3641 access->ptr = arg;
3642 /* A nonnull ACCESS->SIZE contains VLA bounds. */
3644 else
3646 access->size = arg;
3647 gcc_assert (access->ptr == NULL_TREE);
3652 /* Check attribute access arguments. */
3653 tree fndecl = gimple_call_fndecl (stmt);
3654 maybe_check_access_sizes (&rdwr_idx, fndecl, fntype, stmt);
3656 check_alloc_size_call (stmt);
3657 return true;
3660 /* Check arguments in a call STMT for attribute nonstring. */
3662 static void
3663 check_nonstring_args (gcall *stmt)
3665 tree fndecl = gimple_call_fndecl (stmt);
3667 /* Detect passing non-string arguments to functions expecting
3668 nul-terminated strings. */
3669 maybe_warn_nonstring_arg (fndecl, stmt);
3672 /* Issue a warning if a deallocation function such as free, realloc,
3673 or C++ operator delete is called with an argument not returned by
3674 a matching allocation function such as malloc or the corresponding
3675 form of C++ operator new. */
3677 void
3678 pass_waccess::maybe_check_dealloc_call (gcall *call)
3680 tree fndecl = gimple_call_fndecl (call);
3681 if (!fndecl)
3682 return;
3684 unsigned argno = fndecl_dealloc_argno (fndecl);
3685 if ((unsigned) call_nargs (call) <= argno)
3686 return;
3688 tree ptr = gimple_call_arg (call, argno);
3689 if (integer_zerop (ptr))
3690 return;
3692 access_ref aref;
3693 if (!compute_objsize (ptr, call, 0, &aref, &m_ptr_qry))
3694 return;
3696 tree ref = aref.ref;
3697 if (integer_zerop (ref))
3698 return;
3700 tree dealloc_decl = fndecl;
3701 location_t loc = gimple_location (call);
3703 if (DECL_P (ref) || EXPR_P (ref))
3705 /* Diagnose freeing a declared object. */
3706 if (aref.ref_declared ())
3708 auto_diagnostic_group d;
3709 if (warning_at (loc, OPT_Wfree_nonheap_object,
3710 "%qD called on unallocated object %qD",
3711 dealloc_decl, ref))
3713 inform (get_location (ref), "declared here");
3714 return;
3718 /* Diagnose freeing a pointer that includes a positive offset.
3719 Such a pointer cannot refer to the beginning of an allocated
3720 object. A negative offset may refer to it. */
3721 if (aref.sizrng[0] != aref.sizrng[1]
3722 && warn_dealloc_offset (loc, call, aref))
3723 return;
3725 else if (CONSTANT_CLASS_P (ref))
3727 auto_diagnostic_group d;
3728 if (warning_at (loc, OPT_Wfree_nonheap_object,
3729 "%qD called on a pointer to an unallocated "
3730 "object %qE", dealloc_decl, ref))
3732 if (TREE_CODE (ptr) == SSA_NAME)
3734 gimple *def_stmt = SSA_NAME_DEF_STMT (ptr);
3735 if (is_gimple_assign (def_stmt))
3737 location_t loc = gimple_location (def_stmt);
3738 inform (loc, "assigned here");
3741 return;
3744 else if (TREE_CODE (ref) == SSA_NAME)
3746 /* Also warn if the pointer argument refers to the result
3747 of an allocation call like alloca or VLA. */
3748 gimple *def_stmt = SSA_NAME_DEF_STMT (ref);
3749 if (!def_stmt)
3750 return;
3752 if (is_gimple_call (def_stmt))
3754 bool warned = false;
3755 if (gimple_call_alloc_p (def_stmt))
3757 if (matching_alloc_calls_p (def_stmt, dealloc_decl))
3759 if (warn_dealloc_offset (loc, call, aref))
3760 return;
3762 else
3764 tree alloc_decl = gimple_call_fndecl (def_stmt);
3765 const opt_code opt =
3766 (DECL_IS_OPERATOR_NEW_P (alloc_decl)
3767 || DECL_IS_OPERATOR_DELETE_P (dealloc_decl)
3768 ? OPT_Wmismatched_new_delete
3769 : OPT_Wmismatched_dealloc);
3770 warned = warning_at (loc, opt,
3771 "%qD called on pointer returned "
3772 "from a mismatched allocation "
3773 "function", dealloc_decl);
3776 else if (gimple_call_builtin_p (def_stmt, BUILT_IN_ALLOCA)
3777 || gimple_call_builtin_p (def_stmt,
3778 BUILT_IN_ALLOCA_WITH_ALIGN))
3779 warned = warning_at (loc, OPT_Wfree_nonheap_object,
3780 "%qD called on pointer to "
3781 "an unallocated object",
3782 dealloc_decl);
3783 else if (warn_dealloc_offset (loc, call, aref))
3784 return;
3786 if (warned)
3788 tree fndecl = gimple_call_fndecl (def_stmt);
3789 inform (gimple_location (def_stmt),
3790 "returned from %qD", fndecl);
3791 return;
3794 else if (gimple_nop_p (def_stmt))
3796 ref = SSA_NAME_VAR (ref);
3797 /* Diagnose freeing a pointer that includes a positive offset. */
3798 if (TREE_CODE (ref) == PARM_DECL
3799 && !aref.deref
3800 && aref.sizrng[0] != aref.sizrng[1]
3801 && aref.offrng[0] > 0 && aref.offrng[1] > 0
3802 && warn_dealloc_offset (loc, call, aref))
3803 return;
3808 /* Return true if either USE_STMT's basic block (that of a pointer's use)
3809 is dominated by INVAL_STMT's (that of a pointer's invalidating statement,
3810 which is either a clobber or a deallocation call), or if they're in
3811 the same block, USE_STMT follows INVAL_STMT. */
3813 bool
3814 pass_waccess::use_after_inval_p (gimple *inval_stmt, gimple *use_stmt,
3815 bool last_block /* = false */)
3817 tree clobvar =
3818 gimple_clobber_p (inval_stmt) ? gimple_assign_lhs (inval_stmt) : NULL_TREE;
3820 basic_block inval_bb = gimple_bb (inval_stmt);
3821 basic_block use_bb = gimple_bb (use_stmt);
3823 if (!inval_bb || !use_bb)
3824 return false;
3826 if (inval_bb != use_bb)
3828 if (dominated_by_p (CDI_DOMINATORS, use_bb, inval_bb))
3829 return true;
3831 if (!clobvar || !last_block)
3832 return false;
3834 /* Proceed only when looking for uses of dangling pointers. */
3835 auto gsi = gsi_for_stmt (use_stmt);
3837 /* A use statement in the last basic block in a function or one that
3838 falls through to it is after any other prior clobber of the used
3839 variable unless it's followed by a clobber of the same variable. */
3840 basic_block bb = use_bb;
3841 while (bb != inval_bb
3842 && single_succ_p (bb)
3843 && !(single_succ_edge (bb)->flags
3844 & (EDGE_EH | EDGE_ABNORMAL | EDGE_DFS_BACK)))
3846 for (; !gsi_end_p (gsi); gsi_next_nondebug (&gsi))
3848 gimple *stmt = gsi_stmt (gsi);
3849 if (gimple_clobber_p (stmt))
3851 if (clobvar == gimple_assign_lhs (stmt))
3852 /* The use is followed by a clobber. */
3853 return false;
3857 bb = single_succ (bb);
3858 gsi = gsi_start_bb (bb);
3861 /* The use is one of a dangling pointer if a clobber of the variable
3862 [the pointer points to] has not been found before the function exit
3863 point. */
3864 return bb == EXIT_BLOCK_PTR_FOR_FN (cfun);
3867 if (bitmap_set_bit (m_bb_uids_set, inval_bb->index))
3868 /* The first time this basic block is visited assign increasing ids
3869 to consecutive statements in it. Use the ids to determine which
3870 precedes which. This avoids the linear traversal on subsequent
3871 visits to the same block. */
3872 renumber_gimple_stmt_uids_in_block (m_func, inval_bb);
3874 return gimple_uid (inval_stmt) < gimple_uid (use_stmt);
3877 /* Issue a warning for the USE_STMT of pointer or reference REF rendered
3878 invalid by INVAL_STMT. REF may be null when it's been optimized away.
3879 When nonnull, INVAL_STMT is the deallocation function that rendered
3880 the pointer or reference dangling. Otherwise, VAR is the auto variable
3881 (including an unnamed temporary such as a compound literal) whose
3882 lifetime's rended it dangling. MAYBE is true to issue the "maybe"
3883 kind of warning. EQUALITY is true when the pointer is used in
3884 an equality expression. */
3886 void
3887 pass_waccess::warn_invalid_pointer (tree ref, gimple *use_stmt,
3888 gimple *inval_stmt, tree var,
3889 bool maybe, bool equality /* = false */)
3891 /* Avoid printing the unhelpful "<unknown>" in the diagnostics. */
3892 if (ref && TREE_CODE (ref) == SSA_NAME)
3894 tree var = SSA_NAME_VAR (ref);
3895 if (!var)
3896 ref = NULL_TREE;
3897 /* Don't warn for cases like when a cdtor returns 'this' on ARM. */
3898 else if (warning_suppressed_p (var, OPT_Wuse_after_free))
3899 return;
3900 else if (DECL_ARTIFICIAL (var))
3901 ref = NULL_TREE;
3904 location_t use_loc = gimple_location (use_stmt);
3905 if (use_loc == UNKNOWN_LOCATION)
3907 use_loc = m_func->function_end_locus;
3908 if (!ref)
3909 /* Avoid issuing a warning with no context other than
3910 the function. That would make it difficult to debug
3911 in any but very simple cases. */
3912 return;
3915 if (is_gimple_call (inval_stmt))
3917 if (!m_early_checks_p
3918 || (equality && warn_use_after_free < 3)
3919 || (maybe && warn_use_after_free < 2)
3920 || warning_suppressed_p (use_stmt, OPT_Wuse_after_free))
3921 return;
3923 const tree inval_decl = gimple_call_fndecl (inval_stmt);
3925 auto_diagnostic_group d;
3926 if ((ref && warning_at (use_loc, OPT_Wuse_after_free,
3927 (maybe
3928 ? G_("pointer %qE may be used after %qD")
3929 : G_("pointer %qE used after %qD")),
3930 ref, inval_decl))
3931 || (!ref && warning_at (use_loc, OPT_Wuse_after_free,
3932 (maybe
3933 ? G_("pointer may be used after %qD")
3934 : G_("pointer used after %qD")),
3935 inval_decl)))
3937 location_t loc = gimple_location (inval_stmt);
3938 inform (loc, "call to %qD here", inval_decl);
3939 suppress_warning (use_stmt, OPT_Wuse_after_free);
3941 return;
3944 if (equality
3945 || (maybe && warn_dangling_pointer < 2)
3946 || warning_suppressed_p (use_stmt, OPT_Wdangling_pointer_))
3947 return;
3949 if (DECL_NAME (var))
3951 auto_diagnostic_group d;
3952 if ((ref
3953 && warning_at (use_loc, OPT_Wdangling_pointer_,
3954 (maybe
3955 ? G_("dangling pointer %qE to %qD may be used")
3956 : G_("using dangling pointer %qE to %qD")),
3957 ref, var))
3958 || (!ref
3959 && warning_at (use_loc, OPT_Wdangling_pointer_,
3960 (maybe
3961 ? G_("dangling pointer to %qD may be used")
3962 : G_("using a dangling pointer to %qD")),
3963 var)))
3964 inform (DECL_SOURCE_LOCATION (var),
3965 "%qD declared here", var);
3966 suppress_warning (use_stmt, OPT_Wdangling_pointer_);
3967 return;
3970 if ((ref
3971 && warning_at (use_loc, OPT_Wdangling_pointer_,
3972 (maybe
3973 ? G_("dangling pointer %qE to an unnamed temporary "
3974 "may be used")
3975 : G_("using dangling pointer %qE to an unnamed "
3976 "temporary")),
3977 ref))
3978 || (!ref
3979 && warning_at (use_loc, OPT_Wdangling_pointer_,
3980 (maybe
3981 ? G_("dangling pointer to an unnamed temporary "
3982 "may be used")
3983 : G_("using a dangling pointer to an unnamed "
3984 "temporary")))))
3986 inform (DECL_SOURCE_LOCATION (var),
3987 "unnamed temporary defined here");
3988 suppress_warning (use_stmt, OPT_Wdangling_pointer_);
3992 /* If STMT is a call to either the standard realloc or to a user-defined
3993 reallocation function returns its LHS and set *PTR to the reallocated
3994 pointer. Otherwise return null. */
3996 static tree
3997 get_realloc_lhs (gimple *stmt, tree *ptr)
3999 if (gimple_call_builtin_p (stmt, BUILT_IN_REALLOC))
4001 *ptr = gimple_call_arg (stmt, 0);
4002 return gimple_call_lhs (stmt);
4005 gcall *call = dyn_cast<gcall *>(stmt);
4006 if (!call)
4007 return NULL_TREE;
4009 tree fnattr = NULL_TREE;
4010 tree fndecl = gimple_call_fndecl (call);
4011 if (fndecl)
4012 fnattr = DECL_ATTRIBUTES (fndecl);
4013 else
4015 tree fntype = gimple_call_fntype (stmt);
4016 if (!fntype)
4017 return NULL_TREE;
4018 fnattr = TYPE_ATTRIBUTES (fntype);
4021 if (!fnattr)
4022 return NULL_TREE;
4024 for (tree ats = fnattr; (ats = lookup_attribute ("*dealloc", ats));
4025 ats = TREE_CHAIN (ats))
4027 tree args = TREE_VALUE (ats);
4028 if (!args)
4029 continue;
4031 tree alloc = TREE_VALUE (args);
4032 if (!alloc)
4033 continue;
4035 if (alloc == DECL_NAME (fndecl))
4037 unsigned argno = 0;
4038 if (tree index = TREE_CHAIN (args))
4039 argno = TREE_INT_CST_LOW (TREE_VALUE (index)) - 1;
4040 *ptr = gimple_call_arg (stmt, argno);
4041 return gimple_call_lhs (stmt);
4045 return NULL_TREE;
4048 /* Warn if STMT is a call to a deallocation function that's not a match
4049 for the REALLOC_STMT call. Return true if warned. */
4051 static bool
4052 maybe_warn_mismatched_realloc (tree ptr, gimple *realloc_stmt, gimple *stmt)
4054 if (!is_gimple_call (stmt))
4055 return false;
4057 tree fndecl = gimple_call_fndecl (stmt);
4058 if (!fndecl)
4059 return false;
4061 unsigned argno = fndecl_dealloc_argno (fndecl);
4062 if (call_nargs (stmt) <= argno)
4063 return false;
4065 if (matching_alloc_calls_p (realloc_stmt, fndecl))
4066 return false;
4068 /* Avoid printing the unhelpful "<unknown>" in the diagnostics. */
4069 if (ptr && TREE_CODE (ptr) == SSA_NAME
4070 && (!SSA_NAME_VAR (ptr) || DECL_ARTIFICIAL (SSA_NAME_VAR (ptr))))
4071 ptr = NULL_TREE;
4073 location_t loc = gimple_location (stmt);
4074 tree realloc_decl = gimple_call_fndecl (realloc_stmt);
4075 tree dealloc_decl = gimple_call_fndecl (stmt);
4076 if (ptr && !warning_at (loc, OPT_Wmismatched_dealloc,
4077 "%qD called on pointer %qE passed to mismatched "
4078 "allocation function %qD",
4079 dealloc_decl, ptr, realloc_decl))
4080 return false;
4081 if (!ptr && !warning_at (loc, OPT_Wmismatched_dealloc,
4082 "%qD called on a pointer passed to mismatched "
4083 "reallocation function %qD",
4084 dealloc_decl, realloc_decl))
4085 return false;
4087 inform (gimple_location (realloc_stmt),
4088 "call to %qD", realloc_decl);
4089 return true;
4092 /* Return true if P and Q point to the same object, and false if they
4093 either don't or their relationship cannot be determined. */
4095 static bool
4096 pointers_related_p (gimple *stmt, tree p, tree q, pointer_query &qry,
4097 auto_bitmap &visited)
4099 if (!ptr_derefs_may_alias_p (p, q))
4100 return false;
4102 /* TODO: Work harder to rule out relatedness. */
4103 access_ref pref, qref;
4104 if (!qry.get_ref (p, stmt, &pref, 0)
4105 || !qry.get_ref (q, stmt, &qref, 0))
4106 /* GET_REF() only rarely fails. When it does, it's likely because
4107 it involves a self-referential PHI. Return a conservative result. */
4108 return false;
4110 if (pref.ref == qref.ref)
4111 return true;
4113 /* If either pointer is a PHI, iterate over all its operands and
4114 return true if they're all related to the other pointer. */
4115 tree ptr = q;
4116 unsigned version;
4117 gphi *phi = pref.phi ();
4118 if (phi)
4119 version = SSA_NAME_VERSION (pref.ref);
4120 else
4122 phi = qref.phi ();
4123 if (!phi)
4124 return false;
4126 ptr = p;
4127 version = SSA_NAME_VERSION (qref.ref);
4130 if (!bitmap_set_bit (visited, version))
4131 return true;
4133 unsigned nargs = gimple_phi_num_args (phi);
4134 for (unsigned i = 0; i != nargs; ++i)
4136 tree arg = gimple_phi_arg_def (phi, i);
4137 if (!pointers_related_p (stmt, arg, ptr, qry, visited))
4138 return false;
4141 return true;
4144 /* Convenience wrapper for the above. */
4146 static bool
4147 pointers_related_p (gimple *stmt, tree p, tree q, pointer_query &qry)
4149 auto_bitmap visited;
4150 return pointers_related_p (stmt, p, q, qry, visited);
4153 /* For a STMT either a call to a deallocation function or a clobber, warn
4154 for uses of the pointer PTR it was called with (including its copies
4155 or others derived from it by pointer arithmetic). If STMT is a clobber,
4156 VAR is the decl of the clobbered variable. When MAYBE is true use
4157 a "maybe" form of diagnostic. */
4159 void
4160 pass_waccess::check_pointer_uses (gimple *stmt, tree ptr,
4161 tree var /* = NULL_TREE */,
4162 bool maybe /* = false */)
4164 gcc_assert (TREE_CODE (ptr) == SSA_NAME);
4166 const bool check_dangling = !is_gimple_call (stmt);
4167 basic_block stmt_bb = gimple_bb (stmt);
4169 /* If STMT is a reallocation function set to the reallocated pointer
4170 and the LHS of the call, respectively. */
4171 tree realloc_ptr = NULL_TREE;
4172 tree realloc_lhs = get_realloc_lhs (stmt, &realloc_ptr);
4174 auto_bitmap visited;
4176 auto_vec<tree> pointers;
4177 pointers.safe_push (ptr);
4179 /* Starting with PTR, iterate over POINTERS added by the loop, and
4180 either warn for their uses in basic blocks dominated by the STMT
4181 or in statements that follow it in the same basic block, or add
4182 them to POINTERS if they point into the same object as PTR (i.e.,
4183 are obtained by pointer arithmetic on PTR). */
4184 for (unsigned i = 0; i != pointers.length (); ++i)
4186 tree ptr = pointers[i];
4187 if (!bitmap_set_bit (visited, SSA_NAME_VERSION (ptr)))
4188 /* Avoid revisiting the same pointer. */
4189 continue;
4191 use_operand_p use_p;
4192 imm_use_iterator iter;
4193 FOR_EACH_IMM_USE_FAST (use_p, iter, ptr)
4195 gimple *use_stmt = USE_STMT (use_p);
4196 if (use_stmt == stmt || is_gimple_debug (use_stmt))
4197 continue;
4199 /* A clobber isn't a use. */
4200 if (gimple_clobber_p (use_stmt))
4201 continue;
4203 if (realloc_lhs)
4205 /* Check to see if USE_STMT is a mismatched deallocation
4206 call for the pointer passed to realloc. That's a bug
4207 regardless of the pointer's value and so warn. */
4208 if (maybe_warn_mismatched_realloc (*use_p->use, stmt, use_stmt))
4209 continue;
4211 /* Pointers passed to realloc that are used in basic blocks
4212 where the realloc call is known to have failed are valid.
4213 Ignore pointers that nothing is known about. Those could
4214 have escaped along with their nullness. */
4215 value_range vr;
4216 if (m_ptr_qry.rvals->range_of_expr (vr, realloc_lhs, use_stmt))
4218 if (vr.zero_p ())
4219 continue;
4221 if (!pointers_related_p (stmt, ptr, realloc_ptr, m_ptr_qry))
4222 continue;
4226 if (check_dangling
4227 && gimple_code (use_stmt) == GIMPLE_RETURN)
4228 /* Avoid interfering with -Wreturn-local-addr (which runs only
4229 with optimization enabled so it won't diagnose cases that
4230 would be caught here when optimization is disabled). */
4231 continue;
4233 bool equality = false;
4234 if (is_gimple_assign (use_stmt))
4236 tree_code code = gimple_assign_rhs_code (use_stmt);
4237 equality = code == EQ_EXPR || code == NE_EXPR;
4239 else if (gcond *cond = dyn_cast<gcond *>(use_stmt))
4241 tree_code code = gimple_cond_code (cond);
4242 equality = code == EQ_EXPR || code == NE_EXPR;
4244 else if (gimple_code (use_stmt) == GIMPLE_PHI)
4246 /* Only add a PHI result to POINTERS if all its
4247 operands are related to PTR, otherwise continue. */
4248 tree lhs = gimple_phi_result (use_stmt);
4249 if (!pointers_related_p (stmt, lhs, ptr, m_ptr_qry))
4250 continue;
4252 if (TREE_CODE (lhs) == SSA_NAME)
4254 pointers.safe_push (lhs);
4255 continue;
4259 /* Warn if USE_STMT is dominated by the deallocation STMT.
4260 Otherwise, add the pointer to POINTERS so that the uses
4261 of any other pointers derived from it can be checked. */
4262 if (use_after_inval_p (stmt, use_stmt, check_dangling))
4264 basic_block use_bb = gimple_bb (use_stmt);
4265 bool this_maybe
4266 = (maybe
4267 || !dominated_by_p (CDI_POST_DOMINATORS, stmt_bb, use_bb));
4268 warn_invalid_pointer (*use_p->use, use_stmt, stmt, var,
4269 this_maybe, equality);
4270 continue;
4273 if (is_gimple_assign (use_stmt))
4275 tree lhs = gimple_assign_lhs (use_stmt);
4276 if (TREE_CODE (lhs) == SSA_NAME)
4278 tree_code rhs_code = gimple_assign_rhs_code (use_stmt);
4279 if (rhs_code == POINTER_PLUS_EXPR || rhs_code == SSA_NAME)
4280 pointers.safe_push (lhs);
4282 continue;
4285 if (gcall *call = dyn_cast <gcall *>(use_stmt))
4287 if (gimple_call_return_arg (call) == ptr)
4288 if (tree lhs = gimple_call_lhs (call))
4289 if (TREE_CODE (lhs) == SSA_NAME)
4290 pointers.safe_push (lhs);
4291 continue;
4297 /* Check call STMT for invalid accesses. */
4299 void
4300 pass_waccess::check_call (gcall *stmt)
4302 /* Skip special calls generated by the compiler. */
4303 if (gimple_call_from_thunk_p (stmt))
4304 return;
4306 /* .ASAN_MARK doesn't access any vars, only modifies shadow memory. */
4307 if (gimple_call_internal_p (stmt)
4308 && gimple_call_internal_fn (stmt) == IFN_ASAN_MARK)
4309 return;
4311 if (gimple_call_builtin_p (stmt, BUILT_IN_NORMAL))
4312 check_builtin (stmt);
4314 if (tree callee = gimple_call_fndecl (stmt))
4316 /* Check for uses of the pointer passed to either a standard
4317 or a user-defined deallocation function. */
4318 unsigned argno = fndecl_dealloc_argno (callee);
4319 if (argno < (unsigned) call_nargs (stmt))
4321 tree arg = call_arg (stmt, argno);
4322 if (TREE_CODE (arg) == SSA_NAME)
4323 check_pointer_uses (stmt, arg);
4327 check_call_access (stmt);
4328 check_call_dangling (stmt);
4330 if (m_early_checks_p)
4331 return;
4333 maybe_check_dealloc_call (stmt);
4334 check_nonstring_args (stmt);
4337 /* Check non-call STMT for invalid accesses. */
4339 void
4340 pass_waccess::check_stmt (gimple *stmt)
4342 if (m_check_dangling_p
4343 && gimple_clobber_p (stmt, CLOBBER_EOL))
4345 /* Ignore clobber statements in blocks with exceptional edges. */
4346 basic_block bb = gimple_bb (stmt);
4347 edge e = EDGE_PRED (bb, 0);
4348 if (e->flags & EDGE_EH)
4349 return;
4351 tree var = gimple_assign_lhs (stmt);
4352 m_clobbers.put (var, stmt);
4353 return;
4356 if (is_gimple_assign (stmt))
4358 /* Clobbered unnamed temporaries such as compound literals can be
4359 revived. Check for an assignment to one and remove it from
4360 M_CLOBBERS. */
4361 tree lhs = gimple_assign_lhs (stmt);
4362 while (handled_component_p (lhs))
4363 lhs = TREE_OPERAND (lhs, 0);
4365 if (auto_var_p (lhs))
4366 m_clobbers.remove (lhs);
4367 return;
4370 if (greturn *ret = dyn_cast <greturn *> (stmt))
4372 if (optimize && flag_isolate_erroneous_paths_dereference)
4373 /* Avoid interfering with -Wreturn-local-addr (which runs only
4374 with optimization enabled). */
4375 return;
4377 tree arg = gimple_return_retval (ret);
4378 if (!arg || TREE_CODE (arg) != ADDR_EXPR)
4379 return;
4381 arg = TREE_OPERAND (arg, 0);
4382 while (handled_component_p (arg))
4383 arg = TREE_OPERAND (arg, 0);
4385 if (!auto_var_p (arg))
4386 return;
4388 gimple **pclobber = m_clobbers.get (arg);
4389 if (!pclobber)
4390 return;
4392 if (!use_after_inval_p (*pclobber, stmt))
4393 return;
4395 warn_invalid_pointer (NULL_TREE, stmt, *pclobber, arg, false);
4399 /* Check basic block BB for invalid accesses. */
4401 void
4402 pass_waccess::check_block (basic_block bb)
4404 /* Iterate over statements, looking for function calls. */
4405 for (auto si = gsi_start_bb (bb); !gsi_end_p (si);
4406 gsi_next_nondebug (&si))
4408 gimple *stmt = gsi_stmt (si);
4409 if (gcall *call = dyn_cast <gcall *> (stmt))
4410 check_call (call);
4411 else
4412 check_stmt (stmt);
4416 /* Return the argument that the call STMT to a built-in function returns
4417 (including with an offset) or null if it doesn't. */
4419 tree
4420 pass_waccess::gimple_call_return_arg (gcall *call)
4422 /* Check for attribute fn spec to see if the function returns one
4423 of its arguments. */
4424 attr_fnspec fnspec = gimple_call_fnspec (call);
4425 unsigned int argno;
4426 if (!fnspec.returns_arg (&argno))
4428 if (gimple_call_num_args (call) < 1)
4429 return NULL_TREE;
4431 if (!gimple_call_builtin_p (call, BUILT_IN_NORMAL))
4432 return NULL_TREE;
4434 tree fndecl = gimple_call_fndecl (call);
4435 switch (DECL_FUNCTION_CODE (fndecl))
4437 case BUILT_IN_MEMPCPY:
4438 case BUILT_IN_MEMPCPY_CHK:
4439 case BUILT_IN_MEMCHR:
4440 case BUILT_IN_STRCHR:
4441 case BUILT_IN_STRRCHR:
4442 case BUILT_IN_STRSTR:
4443 case BUILT_IN_STPCPY:
4444 case BUILT_IN_STPCPY_CHK:
4445 case BUILT_IN_STPNCPY:
4446 case BUILT_IN_STPNCPY_CHK:
4447 argno = 0;
4448 break;
4450 default:
4451 return NULL_TREE;
4455 if (gimple_call_num_args (call) <= argno)
4456 return NULL_TREE;
4458 return gimple_call_arg (call, argno);
4461 /* Check for and diagnose all uses of the dangling pointer VAR to the auto
4462 object DECL whose lifetime has ended. OBJREF is true when VAR denotes
4463 an access to a DECL that may have been clobbered. */
4465 void
4466 pass_waccess::check_dangling_uses (tree var, tree decl, bool maybe /* = false */,
4467 bool objref /* = false */)
4469 if (!decl || !auto_var_p (decl))
4470 return;
4472 gimple **pclob = m_clobbers.get (decl);
4473 if (!pclob)
4474 return;
4476 if (!objref)
4478 check_pointer_uses (*pclob, var, decl, maybe);
4479 return;
4482 gimple *use_stmt = SSA_NAME_DEF_STMT (var);
4483 if (!use_after_inval_p (*pclob, use_stmt, true))
4484 return;
4486 basic_block use_bb = gimple_bb (use_stmt);
4487 basic_block clob_bb = gimple_bb (*pclob);
4488 maybe = maybe || !dominated_by_p (CDI_POST_DOMINATORS, clob_bb, use_bb);
4489 warn_invalid_pointer (var, use_stmt, *pclob, decl, maybe, false);
4492 /* Diagnose stores in BB and (recursively) its predecessors of the addresses
4493 of local variables into nonlocal pointers that are left dangling after
4494 the function returns. BBS is a bitmap of basic blocks visited. */
4496 void
4497 pass_waccess::check_dangling_stores (basic_block bb,
4498 hash_set<tree> &stores,
4499 auto_bitmap &bbs)
4501 if (!bitmap_set_bit (bbs, bb->index))
4502 /* Avoid cycles. */
4503 return;
4505 /* Iterate backwards over the statements looking for a store of
4506 the address of a local variable into a nonlocal pointer. */
4507 for (auto gsi = gsi_last_nondebug_bb (bb); ; gsi_prev_nondebug (&gsi))
4509 gimple *stmt = gsi_stmt (gsi);
4510 if (!stmt)
4511 break;
4513 if (warning_suppressed_p (stmt, OPT_Wdangling_pointer_))
4514 continue;
4516 if (is_gimple_call (stmt)
4517 && !(gimple_call_flags (stmt) & (ECF_CONST | ECF_PURE)))
4518 /* Avoid looking before nonconst, nonpure calls since those might
4519 use the escaped locals. */
4520 return;
4522 if (!is_gimple_assign (stmt) || gimple_clobber_p (stmt)
4523 || !gimple_store_p (stmt))
4524 continue;
4526 access_ref lhs_ref;
4527 tree lhs = gimple_assign_lhs (stmt);
4528 if (!m_ptr_qry.get_ref (lhs, stmt, &lhs_ref, 0))
4529 continue;
4531 if (auto_var_p (lhs_ref.ref))
4532 continue;
4534 if (DECL_P (lhs_ref.ref))
4536 if (!POINTER_TYPE_P (TREE_TYPE (lhs_ref.ref))
4537 || lhs_ref.deref > 0)
4538 continue;
4540 else if (TREE_CODE (lhs_ref.ref) == SSA_NAME)
4542 gimple *def_stmt = SSA_NAME_DEF_STMT (lhs_ref.ref);
4543 if (!gimple_nop_p (def_stmt))
4544 /* Avoid looking at or before stores into unknown objects. */
4545 return;
4547 tree var = SSA_NAME_VAR (lhs_ref.ref);
4548 if (TREE_CODE (var) == PARM_DECL && DECL_BY_REFERENCE (var))
4549 /* Avoid by-value arguments transformed into by-reference. */
4550 continue;
4553 else if (TREE_CODE (lhs_ref.ref) == MEM_REF)
4555 tree arg = TREE_OPERAND (lhs_ref.ref, 0);
4556 if (TREE_CODE (arg) == SSA_NAME)
4558 gimple *def_stmt = SSA_NAME_DEF_STMT (arg);
4559 if (!gimple_nop_p (def_stmt))
4560 return;
4563 else
4564 continue;
4566 if (stores.add (lhs_ref.ref))
4567 continue;
4569 /* FIXME: Handle stores of alloca() and VLA. */
4570 access_ref rhs_ref;
4571 tree rhs = gimple_assign_rhs1 (stmt);
4572 if (!m_ptr_qry.get_ref (rhs, stmt, &rhs_ref, 0)
4573 || rhs_ref.deref != -1)
4574 continue;
4576 if (!auto_var_p (rhs_ref.ref))
4577 continue;
4579 auto_diagnostic_group d;
4580 location_t loc = gimple_location (stmt);
4581 if (warning_at (loc, OPT_Wdangling_pointer_,
4582 "storing the address of local variable %qD in %qE",
4583 rhs_ref.ref, lhs))
4585 suppress_warning (stmt, OPT_Wdangling_pointer_);
4587 location_t loc = DECL_SOURCE_LOCATION (rhs_ref.ref);
4588 inform (loc, "%qD declared here", rhs_ref.ref);
4590 if (DECL_P (lhs_ref.ref))
4591 loc = DECL_SOURCE_LOCATION (lhs_ref.ref);
4592 else if (EXPR_HAS_LOCATION (lhs_ref.ref))
4593 loc = EXPR_LOCATION (lhs_ref.ref);
4595 if (loc != UNKNOWN_LOCATION)
4596 inform (loc, "%qE declared here", lhs_ref.ref);
4600 edge e;
4601 edge_iterator ei;
4602 FOR_EACH_EDGE (e, ei, bb->preds)
4604 basic_block pred = e->src;
4605 check_dangling_stores (pred, stores, bbs);
4609 /* Diagnose stores of the addresses of local variables into nonlocal
4610 pointers that are left dangling after the function returns. */
4612 void
4613 pass_waccess::check_dangling_stores ()
4615 auto_bitmap bbs;
4616 hash_set<tree> stores;
4617 check_dangling_stores (EXIT_BLOCK_PTR_FOR_FN (m_func), stores, bbs);
4620 /* Check for and diagnose uses of dangling pointers to auto objects
4621 whose lifetime has ended. */
4623 void
4624 pass_waccess::check_dangling_uses ()
4626 tree var;
4627 unsigned i;
4628 FOR_EACH_SSA_NAME (i, var, m_func)
4630 /* For each SSA_NAME pointer VAR find the object it points to.
4631 If the object is a clobbered local variable, check to see
4632 if any of VAR's uses (or those of other pointers derived
4633 from VAR) happens after the clobber. If so, warn. */
4635 gimple *def_stmt = SSA_NAME_DEF_STMT (var);
4636 if (is_gimple_assign (def_stmt))
4638 tree rhs = gimple_assign_rhs1 (def_stmt);
4639 if (TREE_CODE (rhs) == ADDR_EXPR)
4641 if (!POINTER_TYPE_P (TREE_TYPE (var)))
4642 continue;
4643 check_dangling_uses (var, TREE_OPERAND (rhs, 0));
4645 else
4647 /* For other expressions, check the base DECL to see
4648 if it's been clobbered, most likely as a result of
4649 inlining a reference to it. */
4650 tree decl = get_base_address (rhs);
4651 if (DECL_P (decl))
4652 check_dangling_uses (var, decl, false, true);
4655 else if (POINTER_TYPE_P (TREE_TYPE (var)))
4657 if (gcall *call = dyn_cast<gcall *>(def_stmt))
4659 if (tree arg = gimple_call_return_arg (call))
4661 access_ref aref;
4662 if (m_ptr_qry.get_ref (arg, call, &aref, 0)
4663 && aref.deref < 0)
4664 check_dangling_uses (var, aref.ref);
4667 else if (gphi *phi = dyn_cast <gphi *>(def_stmt))
4669 unsigned nargs = gimple_phi_num_args (phi);
4670 for (unsigned i = 0; i != nargs; ++i)
4672 access_ref aref;
4673 tree arg = gimple_phi_arg_def (phi, i);
4674 if (m_ptr_qry.get_ref (arg, phi, &aref, 0)
4675 && aref.deref < 0)
4676 check_dangling_uses (var, aref.ref, true);
4683 /* Check CALL arguments for dangling pointers (those that have been
4684 clobbered) and warn if found. */
4686 void
4687 pass_waccess::check_call_dangling (gcall *call)
4689 unsigned nargs = gimple_call_num_args (call);
4690 for (unsigned i = 0; i != nargs; ++i)
4692 tree arg = gimple_call_arg (call, i);
4693 if (TREE_CODE (arg) != ADDR_EXPR)
4694 continue;
4696 arg = TREE_OPERAND (arg, 0);
4697 if (!DECL_P (arg))
4698 continue;
4700 gimple **pclobber = m_clobbers.get (arg);
4701 if (!pclobber)
4702 continue;
4704 if (!use_after_inval_p (*pclobber, call))
4705 continue;
4707 warn_invalid_pointer (NULL_TREE, call, *pclobber, arg, false);
4711 /* Check function FUN for invalid accesses. */
4713 unsigned
4714 pass_waccess::execute (function *fun)
4716 calculate_dominance_info (CDI_DOMINATORS);
4717 calculate_dominance_info (CDI_POST_DOMINATORS);
4719 /* Set or clear EDGE_DFS_BACK bits on back edges. */
4720 mark_dfs_back_edges (fun);
4722 /* Create a new ranger instance and associate it with FUN. */
4723 m_ptr_qry.rvals = enable_ranger (fun);
4724 m_func = fun;
4726 /* Check for dangling pointers in the earliest run of the pass.
4727 The latest point -Wdangling-pointer should run is just before
4728 loop unrolling which introduces uses after clobbers. Most cases
4729 can be detected without optimization; cases where the address of
4730 the local variable is passed to and then returned from a user-
4731 defined function before its lifetime ends and the returned pointer
4732 becomes dangling depend on inlining. */
4733 m_check_dangling_p = m_early_checks_p;
4735 auto_bitmap bb_uids_set (&bitmap_default_obstack);
4736 m_bb_uids_set = bb_uids_set;
4738 set_gimple_stmt_max_uid (m_func, 0);
4740 basic_block bb;
4741 FOR_EACH_BB_FN (bb, fun)
4742 check_block (bb);
4744 if (m_check_dangling_p)
4746 check_dangling_uses ();
4747 check_dangling_stores ();
4750 if (dump_file)
4751 m_ptr_qry.dump (dump_file, (dump_flags & TDF_DETAILS) != 0);
4753 m_ptr_qry.flush_cache ();
4755 /* Release the ranger instance and replace it with a global ranger.
4756 Also reset the pointer since calling disable_ranger() deletes it. */
4757 disable_ranger (fun);
4758 m_ptr_qry.rvals = NULL;
4760 m_clobbers.empty ();
4761 m_bb_uids_set = NULL;
4763 free_dominance_info (CDI_POST_DOMINATORS);
4764 free_dominance_info (CDI_DOMINATORS);
4765 return 0;
4768 } // namespace
4770 /* Return a new instance of the pass. */
4772 gimple_opt_pass *
4773 make_pass_warn_access (gcc::context *ctxt)
4775 return new pass_waccess (ctxt);