]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/builtin-attrs.def
Add __builtin_speculation_safe_value
[thirdparty/gcc.git] / gcc / builtin-attrs.def
CommitLineData
85ec4feb 1/* Copyright (C) 2001-2018 Free Software Foundation, Inc.
6431177a
JM
2 Contributed by Joseph Myers <jsm28@cam.ac.uk>.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
9dcd6f09 8Software Foundation; either version 3, or (at your option) any later
6431177a
JM
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
9dcd6f09
NC
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
6431177a
JM
19
20/* This header provides a declarative way of describing the attributes
c0ff19d5
MS
21 that are applied to some built-in functions by default. Attributes
22 that are meant to be used by user-defined functions but aren't used
23 by any built-ins, or attributes that apply to types or variables
24 but not to functions need not and should not be defined here.
6431177a
JM
25
26 Before including this header, you must define the following macros.
27 In each case where there is an ENUM, it is an identifier used to
28 reference the tree in subsequent definitions.
29
30 DEF_ATTR_NULL_TREE (ENUM)
31
32 Constructs a NULL_TREE.
33
34 DEF_ATTR_INT (ENUM, VALUE)
35
36 Constructs an INTEGER_CST with value VALUE (an integer representable
37 in HOST_WIDE_INT).
38
39 DEF_ATTR_IDENT (ENUM, STRING)
40
41 Constructs an IDENTIFIER_NODE for STRING.
42
43 DEF_ATTR_TREE_LIST (ENUM, PURPOSE, VALUE, CHAIN)
44
45 Constructs a TREE_LIST with given PURPOSE, VALUE and CHAIN (given
178b2b9f 46 as previous ENUM names). */
6431177a
JM
47
48DEF_ATTR_NULL_TREE (ATTR_NULL)
49
6431177a
JM
50/* Construct a tree for a given integer and a list containing it. */
51#define DEF_ATTR_FOR_INT(VALUE) \
9a238586
KG
52 DEF_ATTR_INT (ATTR_##VALUE, VALUE) \
53 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE, ATTR_NULL, \
54 ATTR_##VALUE, ATTR_NULL)
6431177a
JM
55DEF_ATTR_FOR_INT (0)
56DEF_ATTR_FOR_INT (1)
57DEF_ATTR_FOR_INT (2)
58DEF_ATTR_FOR_INT (3)
59DEF_ATTR_FOR_INT (4)
10a0d495
JJ
60DEF_ATTR_FOR_INT (5)
61DEF_ATTR_FOR_INT (6)
6431177a
JM
62#undef DEF_ATTR_FOR_INT
63
e384e6b5
BS
64/* Construct a tree for a given string and a list containing it. */
65#define DEF_ATTR_FOR_STRING(ENUM, VALUE) \
66 DEF_ATTR_STRING (ATTR_##ENUM, VALUE) \
67 DEF_ATTR_TREE_LIST (ATTR_LIST_##ENUM, ATTR_NULL, \
68 ATTR_##ENUM, ATTR_NULL)
69DEF_ATTR_FOR_STRING (STR1, "1")
70#undef DEF_ATTR_FOR_STRING
71
6431177a
JM
72/* Construct a tree for a list of two integers. */
73#define DEF_LIST_INT_INT(VALUE1, VALUE2) \
9a238586
KG
74 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE1##_##VALUE2, ATTR_NULL, \
75 ATTR_##VALUE1, ATTR_LIST_##VALUE2)
6431177a
JM
76DEF_LIST_INT_INT (1,0)
77DEF_LIST_INT_INT (1,2)
474da67e
MS
78DEF_LIST_INT_INT (1,3)
79DEF_LIST_INT_INT (1,4)
80DEF_LIST_INT_INT (1,5)
6431177a
JM
81DEF_LIST_INT_INT (2,0)
82DEF_LIST_INT_INT (2,3)
83DEF_LIST_INT_INT (3,0)
84DEF_LIST_INT_INT (3,4)
10a0d495
JJ
85DEF_LIST_INT_INT (4,0)
86DEF_LIST_INT_INT (4,5)
87DEF_LIST_INT_INT (5,0)
88DEF_LIST_INT_INT (5,6)
6431177a
JM
89#undef DEF_LIST_INT_INT
90
c0ff19d5
MS
91/* Construct trees for identifiers used in built-in function attributes.
92 The construction contributes to startup costs so only attributes that
93 are used to define built-ins should be defined here. */
5dcf4561 94DEF_ATTR_IDENT (ATTR_ALLOC_SIZE, "alloc_size")
de5a5fa1 95DEF_ATTR_IDENT (ATTR_COLD, "cold")
df061a43
RS
96DEF_ATTR_IDENT (ATTR_CONST, "const")
97DEF_ATTR_IDENT (ATTR_FORMAT, "format")
98DEF_ATTR_IDENT (ATTR_FORMAT_ARG, "format_arg")
99DEF_ATTR_IDENT (ATTR_MALLOC, "malloc")
100DEF_ATTR_IDENT (ATTR_NONNULL, "nonnull")
101DEF_ATTR_IDENT (ATTR_NORETURN, "noreturn")
102DEF_ATTR_IDENT (ATTR_NOTHROW, "nothrow")
0d6e14fd 103DEF_ATTR_IDENT (ATTR_LEAF, "leaf")
e384e6b5 104DEF_ATTR_IDENT (ATTR_FNSPEC, "fn spec")
6431177a 105DEF_ATTR_IDENT (ATTR_PRINTF, "printf")
3ae1d4c2 106DEF_ATTR_IDENT (ATTR_ASM_FPRINTF, "asm_fprintf")
280c1e0d
KG
107DEF_ATTR_IDENT (ATTR_GCC_DIAG, "gcc_diag")
108DEF_ATTR_IDENT (ATTR_GCC_CDIAG, "gcc_cdiag")
109DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG, "gcc_cxxdiag")
df061a43 110DEF_ATTR_IDENT (ATTR_PURE, "pure")
dcd6de6d 111DEF_ATTR_IDENT (ATTR_NOVOPS, "no vops")
6431177a 112DEF_ATTR_IDENT (ATTR_SCANF, "scanf")
3d091dac 113DEF_ATTR_IDENT (ATTR_SENTINEL, "sentinel")
6431177a 114DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon")
df061a43 115DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime")
b5d32c25 116DEF_ATTR_IDENT (ATTR_TYPEGENERIC, "type generic")
0a35513e
AH
117DEF_ATTR_IDENT (ATTR_TM_REGPARM, "*tm regparm")
118DEF_ATTR_IDENT (ATTR_TM_TMPURE, "transaction_pure")
b0c99997 119DEF_ATTR_IDENT (ATTR_RETURNS_TWICE, "returns_twice")
a5bb8a5c 120DEF_ATTR_IDENT (ATTR_RETURNS_NONNULL, "returns_nonnull")
6431177a 121
dcd6de6d
ZD
122DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL)
123
0d6e14fd
JH
124DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOVOPS_LIST)
125
126DEF_ATTR_TREE_LIST (ATTR_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NULL)
127
df061a43 128DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL)
6431177a 129
0d6e14fd
JH
130DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_LIST)
131
425fc685
RE
132DEF_ATTR_TREE_LIST (ATTR_NOVOPS_NOTHROW_LEAF_LIST, ATTR_NOVOPS, \
133 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
df061a43
RS
134DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST, \
135 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
136DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST, ATTR_CONST, \
137 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
df061a43
RS
138DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE, \
139 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
140DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST, ATTR_PURE, \
141 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
df061a43
RS
142DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN, \
143 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
144DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST, ATTR_NORETURN,\
145 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
cb59f689
JH
146DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_COLD_LIST, ATTR_COLD,\
147 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
cfd97da1
BE
148DEF_ATTR_TREE_LIST (ATTR_RT_NOTHROW_LEAF_LIST, ATTR_RETURNS_TWICE,\
149 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
de5a5fa1
MP
150DEF_ATTR_TREE_LIST (ATTR_COLD_NOTHROW_LEAF_LIST, ATTR_COLD,\
151 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
152DEF_ATTR_TREE_LIST (ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST, ATTR_COLD,\
153 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
4d84e22c
JH
154DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\
155 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
cb59f689
JH
156DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_COLD_LIST, ATTR_COLD,\
157 ATTR_NULL, ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST)
df061a43
RS
158DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC, \
159 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
160DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LEAF_LIST, ATTR_MALLOC, \
161 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
3d091dac
KG
162DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL, \
163 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
164DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST, ATTR_SENTINEL, \
165 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
4088b790
MP
166DEF_ATTR_TREE_LIST (ATTR_COLD_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\
167 ATTR_NULL, ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST)
79ed7328 168
5dcf4561 169/* Allocation functions like malloc and realloc whose first argument
5d9a283a
MS
170 with _SIZE_1, or second argument with _SIZE_2, specifies the size
171 of the allocated object. */
5dcf4561
MS
172DEF_ATTR_TREE_LIST (ATTR_MALLOC_SIZE_1_NOTHROW_LIST, ATTR_ALLOC_SIZE, \
173 ATTR_LIST_1, ATTR_MALLOC_NOTHROW_LIST)
5d9a283a
MS
174DEF_ATTR_TREE_LIST (ATTR_ALLOC_SIZE_2_NOTHROW_LIST, ATTR_ALLOC_SIZE, \
175 ATTR_LIST_2, ATTR_MALLOC_NOTHROW_LIST)
5dcf4561
MS
176DEF_ATTR_TREE_LIST (ATTR_MALLOC_SIZE_1_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
177 ATTR_LIST_1, ATTR_MALLOC_NOTHROW_LEAF_LIST)
178/* Alloca is just like malloc except that it never returns null. */
179DEF_ATTR_TREE_LIST (ATTR_ALLOCA_SIZE_1_NOTHROW_LEAF_LIST, ATTR_RETURNS_NONNULL,
180 ATTR_NULL, ATTR_MALLOC_SIZE_1_NOTHROW_LEAF_LIST)
181
182/* Allocation functions like calloc the product of whose first two arguments
183 specifies the size of the allocated object. */
184DEF_ATTR_TREE_LIST (ATTR_MALLOC_SIZE_1_2_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
185 ATTR_LIST_1_2, ATTR_MALLOC_NOTHROW_LEAF_LIST)
186
187/* Allocation functions like realloc whose second argument specifies
188 the size of the allocated object. */
189DEF_ATTR_TREE_LIST (ATTR_ALLOC_SIZE_2_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
190 ATTR_LIST_2, ATTR_NOTHROW_LEAF_LIST)
191
74124c73
KG
192/* Functions whose pointer parameter(s) are all nonnull. */
193DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL)
194/* Functions whose first parameter is a nonnull pointer. */
0d5b215c 195DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
74124c73 196/* Functions whose second parameter is a nonnull pointer. */
0d5b215c 197DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
b1e3f20e
JJ
198/* Functions whose third parameter is a nonnull pointer. */
199DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL)
74124c73 200/* Nothrow functions with the sentinel(1) attribute. */
254986c7
KG
201DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \
202 ATTR_NOTHROW_LIST)
74124c73
KG
203/* Nothrow functions whose pointer parameter(s) are all nonnull. */
204DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \
205 ATTR_NOTHROW_LIST)
0d6e14fd
JH
206/* Nothrow leaf functions whose pointer parameter(s) are all nonnull. */
207DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF, ATTR_NONNULL, ATTR_NULL, \
208 ATTR_NOTHROW_LEAF_LIST)
4d926e34 209DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_NONNULL_LEAF)
74124c73 210/* Nothrow functions whose first parameter is a nonnull pointer. */
00362064 211DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \
08291658 212 ATTR_NOTHROW_LIST)
74124c73 213/* Nothrow functions whose second parameter is a nonnull pointer. */
00362064 214DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \
08291658 215 ATTR_NOTHROW_LIST)
74124c73 216/* Nothrow functions whose third parameter is a nonnull pointer. */
00362064 217DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \
08291658 218 ATTR_NOTHROW_LIST)
10a0d495
JJ
219/* Nothrow functions whose fourth parameter is a nonnull pointer. */
220DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \
221 ATTR_NOTHROW_LIST)
222/* Nothrow functions whose fifth parameter is a nonnull pointer. */
223DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \
224 ATTR_NOTHROW_LIST)
474da67e
MS
225
226/* Same as ATTR_NONNULL_1. */
227DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
228/* Functions like {v,}fprintf whose first and second parameters are
229 nonnull pointers. As cancellation points the functions are not
230 nothrow. */
231DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_2, ATTR_NONNULL, ATTR_LIST_1_2, ATTR_NULL)
232/* The following don't have {v,}fprintf forms. They exist only to
233 make it possible to declare {v,}{f,s}printf attributes using
234 the same macro. */
235DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_3, ATTR_NONNULL, ATTR_LIST_1_3, ATTR_NULL)
236DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_4, ATTR_NONNULL, ATTR_LIST_1_4, ATTR_NULL)
237DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_5, ATTR_NONNULL, ATTR_LIST_1_5, ATTR_NULL)
238
239/* Same as ATTR_NOTHROW_NONNULL_1. */
240DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_1, ATTR_NONNULL, ATTR_LIST_1,
241 ATTR_NOTHROW_LIST)
242/* Nothrow functions like {v,}sprintf whose first and second parameters
243 are nonnull pointers. */
244DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_2, ATTR_NONNULL, ATTR_LIST_1_2, \
245 ATTR_NOTHROW_LIST)
246/* Nothrow functions like {v,}snprintf whose first and third parameters
247 are nonnull pointers. */
248DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_3, ATTR_NONNULL, ATTR_LIST_1_3, \
249 ATTR_NOTHROW_LIST)
250/* Nothrow functions like {v,}sprintf_chk whose first and fourth parameters
251 are nonnull pointers. */
252DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_4, ATTR_NONNULL, ATTR_LIST_1_4, \
253 ATTR_NOTHROW_LIST)
254/* Nothrow functions like {v,}snprintf_chk whose first and fifth parameters
255 are nonnull pointers. */
256DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_5, ATTR_NONNULL, ATTR_LIST_1_5, \
257 ATTR_NOTHROW_LIST)
258
1304953e
JJ
259/* Nothrow leaf functions which are type-generic. */
260DEF_ATTR_TREE_LIST (ATTR_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
261 ATTR_NOTHROW_LEAF_LIST)
4d926e34
MS
262/* Nothrow nonnull leaf functions that are type-generic. */
263DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_TYPEGENERIC_LEAF,
264 ATTR_TYPEGENERIC, ATTR_NULL,
265 ATTR_NOTHROW_NONNULL_LEAF)
74124c73
KG
266/* Nothrow const functions whose pointer parameter(s) are all nonnull. */
267DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \
268 ATTR_NOTHROW_NONNULL)
e384e6b5
BS
269/* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
270 and which return their first argument. */
271DEF_ATTR_TREE_LIST (ATTR_RET1_NOTHROW_NONNULL_LEAF, ATTR_FNSPEC, ATTR_LIST_STR1, \
272 ATTR_NOTHROW_NONNULL_LEAF)
a5bb8a5c
RB
273/* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
274 and return value is also nonnull. */
275DEF_ATTR_TREE_LIST (ATTR_RETNONNULL_NOTHROW_LEAF, ATTR_RETURNS_NONNULL, ATTR_NULL, \
276 ATTR_NOTHROW_NONNULL_LEAF)
0d6e14fd
JH
277/* Nothrow const leaf functions whose pointer parameter(s) are all nonnull. */
278DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF, ATTR_CONST, ATTR_NULL, \
279 ATTR_NOTHROW_NONNULL_LEAF)
b5d32c25
KG
280/* Nothrow const functions which are type-generic. */
281DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \
282 ATTR_CONST_NOTHROW_LIST)
0d6e14fd
JH
283/* Nothrow const leaf functions which are type-generic. */
284DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
285 ATTR_CONST_NOTHROW_LEAF_LIST)
74124c73
KG
286/* Nothrow pure functions whose pointer parameter(s) are all nonnull. */
287DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \
288 ATTR_NOTHROW_NONNULL)
0d6e14fd
JH
289/* Nothrow pure leaf functions whose pointer parameter(s) are all nonnull. */
290DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF, ATTR_PURE, ATTR_NULL, \
291 ATTR_NOTHROW_NONNULL_LEAF)
74124c73
KG
292/* Nothrow malloc functions whose pointer parameter(s) are all nonnull. */
293DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \
294 ATTR_NOTHROW_NONNULL)
0d6e14fd
JH
295/* Nothrow malloc leaf functions whose pointer parameter(s) are all nonnull. */
296DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL_LEAF, ATTR_MALLOC, ATTR_NULL, \
297 ATTR_NOTHROW_NONNULL_LEAF)
79ed7328 298
474da67e 299/* Construct a tree for the format attribute (and implicitly nonnull). */
79ed7328 300#define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES) \
9a238586
KG
301 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
302 ATTR_##TYPE, ATTR_LIST_##VALUES) \
303 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
b1e3f20e 304 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA)
474da67e
MS
305
306/* Construct a tree for the format and nothrow attributes (format
307 implies nonnull). */
b1e3f20e
JJ
308#define DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA, VALUES) \
309 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
310 ATTR_##TYPE, ATTR_LIST_##VALUES) \
311 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
312 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
474da67e
MS
313
314/* Construct one tree for the format attribute and another for the format
315 and nothrow attributes (in both cases format implies nonnull). */
b1e3f20e
JJ
316#define DEF_FORMAT_ATTRIBUTE_BOTH(TYPE, FA, VALUES) \
317 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
318 ATTR_##TYPE, ATTR_LIST_##VALUES) \
319 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
320 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA) \
321 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
9a238586 322 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
474da67e
MS
323
324/* Construct a pair of trees for the nonnull attribute for the first
325 argument, plus format printf attribute (format implies nonnull):
326 the first ordinary and the second nothrow. */
327#define DEF_FORMAT_ATTRIBUTE_NONNULL(TYPE, FA, VALUES) \
328 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_FORMAT_##TYPE##_##VALUES, \
329 ATTR_FORMAT, ATTR_##TYPE##_##VALUES, \
330 ATTR_NONNULL_1_##FA) \
331 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_FORMAT_##TYPE##_##VALUES, \
332 ATTR_FORMAT, ATTR_##TYPE##_##VALUES, \
333 ATTR_NOTHROW_NONNULL_1_##FA)
334
79ed7328
JT
335DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
336DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
b1e3f20e
JJ
337DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_0)
338DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_3)
339DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_0)
340DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_4)
341DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_0)
342DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_5)
343DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_0)
344DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_6)
474da67e
MS
345
346/* Attributes for fprintf(f, f, va). */
347DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,1,1_2)
348/* Attributes for v{f,s}printf(d, f, va). vsprintf is nothrow, vfprintf
349 is not. */
350DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,2,2_0)
351/* Attributes for {f,s}printf(d, f, ...). sprintf is nothrow, fprintf
352 is not. */
353DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,2,2_3)
354/* Attributes for vprintf_chk. */
355DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,3,3_0)
356/* Attributes for printf_chk. */
357DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,3,3_4)
358/* Attributes for v{f,s}printf_chk(d, t, bos, f, va). vsprintf_chk is
359 nothrow, vfprintf_chk is not. */
360DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,4,4_0)
361/* Attributes for {f,s}printf_chk(d, t, bos, f, ...). sprintf_chk is
362 nothrow, fprintf_chk is not. */
363DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,4,4_5)
364
79ed7328
JT
365DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
366DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
b1e3f20e
JJ
367DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_0)
368DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_3)
369DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME,3,3_0)
370DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON,3,3_4)
6431177a 371#undef DEF_FORMAT_ATTRIBUTE
b1e3f20e
JJ
372#undef DEF_FORMAT_ATTRIBUTE_NOTHROW
373#undef DEF_FORMAT_ATTRIBUTE_BOTH
6431177a 374
0a35513e
AH
375/* Transactional memory variants of the above. */
376
377DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST,
378 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NOTHROW_LIST)
379DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST,
380 ATTR_TM_TMPURE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
381DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST,
382 ATTR_PURE, ATTR_NULL, ATTR_TM_TMPURE_NOTHROW_LIST)
383DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST,
384 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NORETURN_NOTHROW_LIST)
385DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST,
386 ATTR_TM_REGPARM, ATTR_NULL, ATTR_CONST_NOTHROW_LIST)
b0c99997
TR
387DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_RT_LIST,
388 ATTR_RETURNS_TWICE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
0a35513e
AH
389
390/* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in. */
391DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST,
392 ATTR_TM_TMPURE, ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST)
393/* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in. */
394DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST,
395 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LIST)
396
bc77608b
JJ
397DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LEAF_LIST,
398 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
399DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST,
400 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
cb59f689
JH
401DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_COLD_LIST,
402 ATTR_COLD, ATTR_NULL,
403 ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST)
bc77608b 404
79ed7328
JT
405/* Construct a tree for a format_arg attribute. */
406#define DEF_FORMAT_ARG_ATTRIBUTE(FA) \
9a238586
KG
407 DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG, \
408 ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA)
79ed7328
JT
409DEF_FORMAT_ARG_ATTRIBUTE(1)
410DEF_FORMAT_ARG_ATTRIBUTE(2)
411#undef DEF_FORMAT_ARG_ATTRIBUTE
6431177a 412