1 /* UndefinedBehaviorSanitizer, undefined behavior detector.
2    Copyright (C) 2013-2021 Free Software Foundation, Inc.
3    Contributed by Marek Polacek <polacek@redhat.com>
4 
5 This file is part of GCC.
6 
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
11 
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3.  If not see
19 <http://www.gnu.org/licenses/>.  */
20 
21 #ifndef GCC_UBSAN_H
22 #define GCC_UBSAN_H
23 
24 /* The various kinds of NULL pointer checks.  */
25 enum ubsan_null_ckind {
26   UBSAN_LOAD_OF,
27   UBSAN_STORE_OF,
28   UBSAN_REF_BINDING,
29   UBSAN_MEMBER_ACCESS,
30   UBSAN_MEMBER_CALL,
31   UBSAN_CTOR_CALL,
32   UBSAN_DOWNCAST_POINTER,
33   UBSAN_DOWNCAST_REFERENCE,
34   UBSAN_UPCAST,
35   UBSAN_CAST_TO_VBASE
36 };
37 
38 /* This controls how ubsan prints types.  Used in ubsan_type_descriptor.  */
39 enum ubsan_print_style {
40   UBSAN_PRINT_NORMAL,
41   UBSAN_PRINT_POINTER,
42   UBSAN_PRINT_ARRAY
43 };
44 
45 /* This controls ubsan_encode_value behavior.  */
46 enum ubsan_encode_value_phase {
47   UBSAN_ENCODE_VALUE_GENERIC,
48   UBSAN_ENCODE_VALUE_GIMPLE,
49   UBSAN_ENCODE_VALUE_RTL
50 };
51 
52 extern bool ubsan_expand_bounds_ifn (gimple_stmt_iterator *);
53 extern bool ubsan_expand_null_ifn (gimple_stmt_iterator *);
54 extern bool ubsan_expand_objsize_ifn (gimple_stmt_iterator *);
55 extern bool ubsan_expand_ptr_ifn (gimple_stmt_iterator *);
56 extern bool ubsan_expand_vptr_ifn (gimple_stmt_iterator *);
57 extern bool ubsan_instrument_unreachable (gimple_stmt_iterator *);
58 extern tree ubsan_create_data (const char *, int, const location_t *, ...);
59 extern tree ubsan_type_descriptor (tree, ubsan_print_style
60 					 = UBSAN_PRINT_NORMAL);
61 extern tree ubsan_encode_value (tree, ubsan_encode_value_phase
62 				      = UBSAN_ENCODE_VALUE_GENERIC);
63 extern bool is_ubsan_builtin_p (tree);
64 extern tree ubsan_build_overflow_builtin (tree_code, location_t, tree, tree,
65 					  tree, tree *);
66 extern tree ubsan_instrument_float_cast (location_t, tree, tree);
67 extern tree ubsan_get_source_location_type (void);
68 
69 #endif  /* GCC_UBSAN_H  */
70