1 /* Utility functions for the analyzer.
2 Copyright (C) 2019-2023 Free Software Foundation, Inc.
3 Contributed by David Malcolm <dmalcolm@redhat.com>.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GCC is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
22 #define INCLUDE_MEMORY
24 #include "coretypes.h"
27 #include "basic-block.h"
29 #include "diagnostic.h"
31 #include "analyzer/analyzer.h"
37 /* Workaround for missing location information for some stmts,
38 which ultimately should be solved by fixing the frontends
39 to provide the locations (TODO). */
42 get_stmt_location (const gimple
*stmt
, function
*fun
)
45 return UNKNOWN_LOCATION
;
46 if (get_pure_location (stmt
->location
) == UNKNOWN_LOCATION
)
48 /* Workaround for missing location information for clobber
49 stmts, which seem to lack location information in the C frontend
50 at least. Created by gimplify_bind_expr, which uses the
51 BLOCK_SOURCE_END_LOCATION (BIND_EXPR_BLOCK (bind_expr))
52 but this is never set up when the block is created in
53 c_end_compound_stmt's pop_scope.
54 TODO: fix this missing location information.
56 For now, as a hackish workaround, use the location of the end of
58 if (gimple_clobber_p (stmt
) && fun
)
59 return fun
->function_end_locus
;
62 return stmt
->location
;
66 fixup_tree_for_diagnostic_1 (tree expr
, hash_set
<tree
> *visited
);
68 /* Attemp to generate a tree for the LHS of ASSIGN_STMT.
69 VISITED must be non-NULL; it is used to ensure termination. */
72 get_diagnostic_tree_for_gassign_1 (const gassign
*assign_stmt
,
73 hash_set
<tree
> *visited
)
75 enum tree_code code
= gimple_assign_rhs_code (assign_stmt
);
77 /* Reverse the effect of extract_ops_from_tree during
79 switch (get_gimple_rhs_class (code
))
82 case GIMPLE_INVALID_RHS
:
84 case GIMPLE_TERNARY_RHS
:
85 case GIMPLE_BINARY_RHS
:
86 case GIMPLE_UNARY_RHS
:
88 tree t
= make_node (code
);
89 TREE_TYPE (t
) = TREE_TYPE (gimple_assign_lhs (assign_stmt
));
90 unsigned num_rhs_args
= gimple_num_ops (assign_stmt
) - 1;
91 for (unsigned i
= 0; i
< num_rhs_args
; i
++)
93 tree op
= gimple_op (assign_stmt
, i
+ 1);
96 op
= fixup_tree_for_diagnostic_1 (op
, visited
);
100 TREE_OPERAND (t
, i
) = op
;
104 case GIMPLE_SINGLE_RHS
:
106 tree op
= gimple_op (assign_stmt
, 1);
107 op
= fixup_tree_for_diagnostic_1 (op
, visited
);
113 /* Subroutine of fixup_tree_for_diagnostic_1, called on SSA names.
114 Attempt to reconstruct a tree expression for SSA_NAME
115 based on its def-stmt.
116 SSA_NAME must be non-NULL.
117 VISITED must be non-NULL; it is used to ensure termination.
119 Return NULL_TREE if there is a problem. */
122 maybe_reconstruct_from_def_stmt (tree ssa_name
,
123 hash_set
<tree
> *visited
)
125 /* Ensure termination. */
126 if (visited
->contains (ssa_name
))
128 visited
->add (ssa_name
);
130 gimple
*def_stmt
= SSA_NAME_DEF_STMT (ssa_name
);
132 switch (gimple_code (def_stmt
))
139 /* Can't handle these. */
142 return get_diagnostic_tree_for_gassign_1
143 (as_a
<const gassign
*> (def_stmt
), visited
);
146 gcall
*call_stmt
= as_a
<gcall
*> (def_stmt
);
147 tree return_type
= gimple_call_return_type (call_stmt
);
148 tree fn
= fixup_tree_for_diagnostic_1 (gimple_call_fn (call_stmt
),
152 unsigned num_args
= gimple_call_num_args (call_stmt
);
153 auto_vec
<tree
> args (num_args
);
154 for (unsigned i
= 0; i
< num_args
; i
++)
156 tree arg
= gimple_call_arg (call_stmt
, i
);
157 arg
= fixup_tree_for_diagnostic_1 (arg
, visited
);
158 if (arg
== NULL_TREE
)
160 args
.quick_push (arg
);
163 return build_call_array_loc (gimple_location (call_stmt
),
165 num_args
, args
.address ());
171 /* Subroutine of fixup_tree_for_diagnostic: attempt to fixup EXPR,
173 VISITED must be non-NULL; it is used to ensure termination. */
176 fixup_tree_for_diagnostic_1 (tree expr
, hash_set
<tree
> *visited
)
179 && TREE_CODE (expr
) == SSA_NAME
180 && (SSA_NAME_VAR (expr
) == NULL_TREE
181 || DECL_ARTIFICIAL (SSA_NAME_VAR (expr
))))
183 if (tree var
= SSA_NAME_VAR (expr
))
184 if (VAR_P (var
) && DECL_HAS_DEBUG_EXPR_P (var
))
185 return DECL_DEBUG_EXPR (var
);
186 if (tree expr2
= maybe_reconstruct_from_def_stmt (expr
, visited
))
192 /* We don't want to print '<unknown>' in our diagnostics (PR analyzer/99771),
193 but sometimes we generate diagnostics involving an ssa name for a
196 Work around this by attempting to reconstruct a tree expression for
197 such temporaries based on their def-stmts.
199 Otherwise return EXPR.
204 fixup_tree_for_diagnostic (tree expr
)
206 hash_set
<tree
> visited
;
207 return fixup_tree_for_diagnostic_1 (expr
, &visited
);
210 /* Attempt to generate a tree for the LHS of ASSIGN_STMT. */
213 get_diagnostic_tree_for_gassign (const gassign
*assign_stmt
)
215 hash_set
<tree
> visited
;
216 return get_diagnostic_tree_for_gassign_1 (assign_stmt
, &visited
);
221 /* Helper function for checkers. Is the CALL to the given function name,
222 and with the given number of arguments?
224 This doesn't resolve function pointers via the region model;
225 is_named_call_p should be used instead, using a fndecl from
226 get_fndecl_for_call; this function should only be used for special cases
227 where it's not practical to get at the region model, or for special
228 analyzer functions such as __analyzer_dump. */
231 is_special_named_call_p (const gcall
*call
, const char *funcname
,
232 unsigned int num_args
)
234 gcc_assert (funcname
);
236 tree fndecl
= gimple_call_fndecl (call
);
240 return is_named_call_p (fndecl
, funcname
, call
, num_args
);
243 /* Helper function for checkers. Is FNDECL an extern fndecl at file scope
244 that has the given FUNCNAME?
246 Compare with special_function_p in calls.cc. */
249 is_named_call_p (const_tree fndecl
, const char *funcname
)
252 gcc_assert (funcname
);
254 if (!maybe_special_function_p (fndecl
))
257 tree identifier
= DECL_NAME (fndecl
);
258 const char *name
= IDENTIFIER_POINTER (identifier
);
259 const char *tname
= name
;
261 /* Potentially disregard prefix _ or __ in FNDECL's name, but not if
262 FUNCNAME itself has leading underscores (e.g. when looking for
263 "__analyzer_eval"). */
264 if (funcname
[0] != '_' && name
[0] == '_')
272 return 0 == strcmp (tname
, funcname
);
275 /* Return true if FNDECL is within the namespace "std".
276 Compare with cp/typeck.cc: decl_in_std_namespace_p, but this doesn't
277 rely on being the C++ FE (or handle inline namespaces inside of std). */
280 is_std_function_p (const_tree fndecl
)
282 tree name_decl
= DECL_NAME (fndecl
);
285 if (!DECL_CONTEXT (fndecl
))
287 if (TREE_CODE (DECL_CONTEXT (fndecl
)) != NAMESPACE_DECL
)
289 tree ns
= DECL_CONTEXT (fndecl
);
290 if (!(DECL_CONTEXT (ns
) == NULL_TREE
291 || TREE_CODE (DECL_CONTEXT (ns
)) == TRANSLATION_UNIT_DECL
))
295 return id_equal ("std", DECL_NAME (ns
));
298 /* Like is_named_call_p, but look for std::FUNCNAME. */
301 is_std_named_call_p (const_tree fndecl
, const char *funcname
)
304 gcc_assert (funcname
);
306 if (!is_std_function_p (fndecl
))
309 tree identifier
= DECL_NAME (fndecl
);
310 const char *name
= IDENTIFIER_POINTER (identifier
);
311 const char *tname
= name
;
313 /* Don't disregard prefix _ or __ in FNDECL's name. */
315 return 0 == strcmp (tname
, funcname
);
318 /* Helper function for checkers. Is FNDECL an extern fndecl at file scope
319 that has the given FUNCNAME, and does CALL have the given number of
323 is_named_call_p (const_tree fndecl
, const char *funcname
,
324 const gcall
*call
, unsigned int num_args
)
327 gcc_assert (funcname
);
329 if (!is_named_call_p (fndecl
, funcname
))
332 if (gimple_call_num_args (call
) != num_args
)
338 /* Like is_named_call_p, but check for std::FUNCNAME. */
341 is_std_named_call_p (const_tree fndecl
, const char *funcname
,
342 const gcall
*call
, unsigned int num_args
)
345 gcc_assert (funcname
);
347 if (!is_std_named_call_p (fndecl
, funcname
))
350 if (gimple_call_num_args (call
) != num_args
)
356 /* Return true if stmt is a setjmp or sigsetjmp call. */
359 is_setjmp_call_p (const gcall
*call
)
361 if (is_special_named_call_p (call
, "setjmp", 1)
362 || is_special_named_call_p (call
, "sigsetjmp", 2))
363 /* region_model::on_setjmp requires a pointer. */
364 if (POINTER_TYPE_P (TREE_TYPE (gimple_call_arg (call
, 0))))
370 /* Return true if stmt is a longjmp or siglongjmp call. */
373 is_longjmp_call_p (const gcall
*call
)
375 if (is_special_named_call_p (call
, "longjmp", 2)
376 || is_special_named_call_p (call
, "siglongjmp", 2))
377 /* exploded_node::on_longjmp requires a pointer for the initial
379 if (POINTER_TYPE_P (TREE_TYPE (gimple_call_arg (call
, 0))))
385 /* For a CALL that matched is_special_named_call_p or is_named_call_p for
386 some name, return a name for the called function suitable for use in
387 diagnostics (stripping the leading underscores). */
390 get_user_facing_name (const gcall
*call
)
392 tree fndecl
= gimple_call_fndecl (call
);
395 tree identifier
= DECL_NAME (fndecl
);
396 gcc_assert (identifier
);
398 const char *name
= IDENTIFIER_POINTER (identifier
);
400 /* Strip prefix _ or __ in FNDECL's name. */
412 /* Generate a label_text instance by formatting FMT, using a
413 temporary clone of the global_dc's printer (thus using its
414 formatting callbacks).
416 Colorize if the global_dc supports colorization and CAN_COLORIZE is
420 make_label_text (bool can_colorize
, const char *fmt
, ...)
422 pretty_printer
*pp
= global_dc
->printer
->clone ();
423 pp_clear_output_area (pp
);
426 pp_show_color (pp
) = false;
428 rich_location
rich_loc (line_table
, UNKNOWN_LOCATION
);
434 text_info
ti (_(fmt
), &ap
, 0, NULL
, &rich_loc
);
436 pp_output_formatted_text (pp
);
440 label_text result
= label_text::take (xstrdup (pp_formatted_text (pp
)));
445 /* As above, but with singular vs plural. */
448 make_label_text_n (bool can_colorize
, unsigned HOST_WIDE_INT n
,
449 const char *singular_fmt
,
450 const char *plural_fmt
, ...)
452 pretty_printer
*pp
= global_dc
->printer
->clone ();
453 pp_clear_output_area (pp
);
456 pp_show_color (pp
) = false;
458 rich_location
rich_loc (line_table
, UNKNOWN_LOCATION
);
462 va_start (ap
, plural_fmt
);
464 const char *fmt
= ngettext (singular_fmt
, plural_fmt
, n
);
466 text_info
ti (fmt
, &ap
, 0, NULL
, &rich_loc
);
469 pp_output_formatted_text (pp
);
473 label_text result
= label_text::take (xstrdup (pp_formatted_text (pp
)));
478 #endif /* #if ENABLE_ANALYZER */