]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/asan.h
c++: Handle multiple aggregate overloads [PR95319].
[thirdparty/gcc.git] / gcc / asan.h
CommitLineData
37d6f666 1/* AddressSanitizer, a fast memory error detector.
8d9254fc 2 Copyright (C) 2011-2020 Free Software Foundation, Inc.
37d6f666
WM
3 Contributed by Kostya Serebryany <kcc@google.com>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21#ifndef TREE_ASAN
22#define TREE_ASAN
23
ef1b3fda 24extern void asan_function_start (void);
f3ddd692 25extern void asan_finish_file (void);
3a4abd2f
DM
26extern rtx_insn *asan_emit_stack_protection (rtx, rtx, unsigned int,
27 HOST_WIDE_INT *, tree *, int);
e3174bdf 28extern rtx_insn *asan_emit_allocas_unpoison (rtx, rtx, rtx_insn *);
1069dc25 29extern bool asan_protect_global (tree, bool ignore_decl_rtl_set_p = false);
0e668eaf 30extern void initialize_sanitizer_builtins (void);
59b36ecf 31extern tree asan_dynamic_init_call (bool);
06cefae9 32extern bool asan_expand_check_ifn (gimple_stmt_iterator *, bool);
6dc4a604 33extern bool asan_expand_mark_ifn (gimple_stmt_iterator *);
c7775327
ML
34extern bool asan_expand_poison_ifn (gimple_stmt_iterator *, bool *,
35 hash_map<tree, tree> &);
f3ddd692 36
ac0ff9f2
JJ
37extern gimple_stmt_iterator create_cond_insert_point
38 (gimple_stmt_iterator *, bool, bool, bool, basic_block *, basic_block *);
39
f3ddd692
JJ
40/* Alias set for accessing the shadow memory. */
41extern alias_set_type asan_shadow_set;
37d6f666 42
6dc4a604
ML
43/* Hash set of labels that are either used in a goto, or their address
44 has been taken. */
45extern hash_set <tree> *asan_used_labels;
46
dfe06d3e 47/* Shadow memory is found at
fd960af2 48 (address >> ASAN_SHADOW_SHIFT) + asan_shadow_offset (). */
dfe06d3e 49#define ASAN_SHADOW_SHIFT 3
6dc4a604 50#define ASAN_SHADOW_GRANULARITY (1UL << ASAN_SHADOW_SHIFT)
dfe06d3e 51
f3ddd692
JJ
52/* Red zone size, stack and global variables are padded by ASAN_RED_ZONE_SIZE
53 up to 2 * ASAN_RED_ZONE_SIZE - 1 bytes. */
54#define ASAN_RED_ZONE_SIZE 32
55
6e644a50
ML
56/* Stack variable use more compact red zones. The size includes also
57 size of variable itself. */
58
59#define ASAN_MIN_RED_ZONE_SIZE 16
60
f3ddd692
JJ
61/* Shadow memory values for stack protection. Left is below protected vars,
62 the first pointer in stack corresponding to that offset contains
63 ASAN_STACK_FRAME_MAGIC word, the second pointer to a string describing
64 the frame. Middle is for padding in between variables, right is
65 above the last protected variable and partial immediately after variables
66 up to ASAN_RED_ZONE_SIZE alignment. */
6dc4a604
ML
67#define ASAN_STACK_MAGIC_LEFT 0xf1
68#define ASAN_STACK_MAGIC_MIDDLE 0xf2
69#define ASAN_STACK_MAGIC_RIGHT 0xf3
6dc4a604
ML
70#define ASAN_STACK_MAGIC_USE_AFTER_RET 0xf5
71#define ASAN_STACK_MAGIC_USE_AFTER_SCOPE 0xf8
f3ddd692 72
e361382f
JJ
73#define ASAN_STACK_FRAME_MAGIC 0x41b58ab3
74#define ASAN_STACK_RETIRED_MAGIC 0x45e0360e
f3ddd692 75
f6b9f2ff
ML
76#define ASAN_USE_AFTER_SCOPE_ATTRIBUTE "use after scope memory"
77
6dc4a604
ML
78/* Various flags for Asan builtins. */
79enum asan_check_flags
f3ddd692 80{
6dc4a604
ML
81 ASAN_CHECK_STORE = 1 << 0,
82 ASAN_CHECK_SCALAR_ACCESS = 1 << 1,
83 ASAN_CHECK_NON_ZERO_LEN = 1 << 2,
84 ASAN_CHECK_LAST = 1 << 3
85};
86
87/* Flags for Asan check builtins. */
56b7aede
ML
88#define IFN_ASAN_MARK_FLAGS DEF(POISON), DEF(UNPOISON)
89
6dc4a604
ML
90enum asan_mark_flags
91{
56b7aede
ML
92#define DEF(X) ASAN_MARK_##X
93 IFN_ASAN_MARK_FLAGS
94#undef DEF
6dc4a604 95};
f3ddd692 96
56b7aede
ML
97/* Return true if STMT is ASAN_MARK with FLAG as first argument. */
98extern bool asan_mark_p (gimple *stmt, enum asan_mark_flags flag);
99
8240018b
JJ
100/* Return the size of padding needed to insert after a protected
101 decl of SIZE. */
102
103static inline unsigned int
104asan_red_zone_size (unsigned int size)
105{
106 unsigned int c = size & (ASAN_RED_ZONE_SIZE - 1);
107 return c ? 2 * ASAN_RED_ZONE_SIZE - c : ASAN_RED_ZONE_SIZE;
108}
109
6e644a50
ML
110/* Return how much a stack variable occupis on a stack
111 including a space for red zone. */
112
113static inline unsigned HOST_WIDE_INT
114asan_var_and_redzone_size (unsigned HOST_WIDE_INT size)
115{
116 if (size <= 4)
117 return 16;
118 else if (size <= 16)
119 return 32;
120 else if (size <= 128)
121 return size + 32;
122 else if (size <= 512)
123 return size + 64;
124 else if (size <= 4096)
125 return size + 128;
126 else
127 return size + 256;
128}
129
fd960af2
YG
130extern bool set_asan_shadow_offset (const char *);
131
18af8d16
YG
132extern void set_sanitized_sections (const char *);
133
6dc4a604
ML
134extern bool asan_sanitize_stack_p (void);
135
5094f7d5
MO
136extern bool asan_sanitize_allocas_p (void);
137
bf9f9292
ML
138extern hash_set<tree> *asan_handled_variables;
139
bdea98ca
MO
140/* Return TRUE if builtin with given FCODE will be intercepted by
141 libasan. */
142
143static inline bool
144asan_intercepted_p (enum built_in_function fcode)
145{
146 return fcode == BUILT_IN_INDEX
147 || fcode == BUILT_IN_MEMCHR
148 || fcode == BUILT_IN_MEMCMP
149 || fcode == BUILT_IN_MEMCPY
150 || fcode == BUILT_IN_MEMMOVE
151 || fcode == BUILT_IN_MEMSET
152 || fcode == BUILT_IN_STRCASECMP
153 || fcode == BUILT_IN_STRCAT
154 || fcode == BUILT_IN_STRCHR
155 || fcode == BUILT_IN_STRCMP
156 || fcode == BUILT_IN_STRCPY
157 || fcode == BUILT_IN_STRDUP
158 || fcode == BUILT_IN_STRLEN
159 || fcode == BUILT_IN_STRNCASECMP
160 || fcode == BUILT_IN_STRNCAT
161 || fcode == BUILT_IN_STRNCMP
0290a292
MO
162 || fcode == BUILT_IN_STRCSPN
163 || fcode == BUILT_IN_STRPBRK
164 || fcode == BUILT_IN_STRSPN
165 || fcode == BUILT_IN_STRSTR
bdea98ca
MO
166 || fcode == BUILT_IN_STRNCPY;
167}
6dc4a604
ML
168
169/* Return TRUE if we should instrument for use-after-scope sanity checking. */
170
171static inline bool
172asan_sanitize_use_after_scope (void)
173{
174 return (flag_sanitize_address_use_after_scope && asan_sanitize_stack_p ());
175}
176
6dc4a604
ML
177/* Return true if DECL should be guarded on the stack. */
178
179static inline bool
180asan_protect_stack_decl (tree decl)
181{
182 return DECL_P (decl)
183 && (!DECL_ARTIFICIAL (decl)
184 || (asan_sanitize_use_after_scope () && TREE_ADDRESSABLE (decl)));
185}
186
45b2222a
ML
187/* Return true when flag_sanitize & FLAG is non-zero. If FN is non-null,
188 remove all flags mentioned in "no_sanitize" of DECL_ATTRIBUTES. */
189
190static inline bool
191sanitize_flags_p (unsigned int flag, const_tree fn = current_function_decl)
192{
193 unsigned int result_flags = flag_sanitize & flag;
194 if (result_flags == 0)
195 return false;
196
197 if (fn != NULL_TREE)
198 {
199 tree value = lookup_attribute ("no_sanitize", DECL_ATTRIBUTES (fn));
200 if (value)
201 result_flags &= ~tree_to_uhwi (TREE_VALUE (value));
202 }
203
204 return result_flags;
205}
206
37d6f666 207#endif /* TREE_ASAN */