]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/builtin-attrs.def
[Ada] Avoid "others => <>" association in resolved record aggregates
[thirdparty/gcc.git] / gcc / builtin-attrs.def
CommitLineData
8d9254fc 1/* Copyright (C) 2001-2020 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")
b8e2acff 121DEF_ATTR_IDENT (ATTR_WARN_UNUSED_RESULT, "warn_unused_result")
6431177a 122
dcd6de6d
ZD
123DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL)
124
0d6e14fd
JH
125DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOVOPS_LIST)
126
127DEF_ATTR_TREE_LIST (ATTR_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NULL)
128
df061a43 129DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL)
6431177a 130
0d6e14fd
JH
131DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_LIST)
132
425fc685
RE
133DEF_ATTR_TREE_LIST (ATTR_NOVOPS_NOTHROW_LEAF_LIST, ATTR_NOVOPS, \
134 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
df061a43
RS
135DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST, \
136 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
137DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST, ATTR_CONST, \
138 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
df061a43
RS
139DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE, \
140 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
141DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST, ATTR_PURE, \
142 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
df061a43
RS
143DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN, \
144 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
145DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST, ATTR_NORETURN,\
146 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
cb59f689
JH
147DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_COLD_LIST, ATTR_COLD,\
148 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
cfd97da1
BE
149DEF_ATTR_TREE_LIST (ATTR_RT_NOTHROW_LEAF_LIST, ATTR_RETURNS_TWICE,\
150 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
de5a5fa1
MP
151DEF_ATTR_TREE_LIST (ATTR_COLD_NOTHROW_LEAF_LIST, ATTR_COLD,\
152 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
153DEF_ATTR_TREE_LIST (ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST, ATTR_COLD,\
154 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
4d84e22c
JH
155DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\
156 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
cb59f689
JH
157DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_COLD_LIST, ATTR_COLD,\
158 ATTR_NULL, ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST)
df061a43
RS
159DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC, \
160 ATTR_NULL, ATTR_NOTHROW_LIST)
b8e2acff 161DEF_ATTR_TREE_LIST (ATTR_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST, ATTR_WARN_UNUSED_RESULT, \
0d6e14fd 162 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
b8e2acff
ML
163DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST, ATTR_MALLOC, \
164 ATTR_NULL, ATTR_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST)
3d091dac
KG
165DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL, \
166 ATTR_NULL, ATTR_NOTHROW_LIST)
0d6e14fd
JH
167DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST, ATTR_SENTINEL, \
168 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
4088b790
MP
169DEF_ATTR_TREE_LIST (ATTR_COLD_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\
170 ATTR_NULL, ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST)
79ed7328 171
5dcf4561 172/* Allocation functions like malloc and realloc whose first argument
5d9a283a
MS
173 with _SIZE_1, or second argument with _SIZE_2, specifies the size
174 of the allocated object. */
5dcf4561 175DEF_ATTR_TREE_LIST (ATTR_MALLOC_SIZE_1_NOTHROW_LIST, ATTR_ALLOC_SIZE, \
b8e2acff
ML
176 ATTR_LIST_1, ATTR_MALLOC_NOTHROW_LIST)
177DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LIST, ATTR_WARN_UNUSED_RESULT, \
178 ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST)
179DEF_ATTR_TREE_LIST (ATTR_ALLOC_WARN_UNUSED_RESULT_SIZE_2_NOTHROW_LIST, ATTR_ALLOC_SIZE, \
180 ATTR_LIST_2, ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LIST)
181DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_SIZE_1_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
182 ATTR_LIST_1, ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST)
5dcf4561 183/* Alloca is just like malloc except that it never returns null. */
b8e2acff
ML
184DEF_ATTR_TREE_LIST (ATTR_ALLOCA_WARN_UNUSED_RESULT_SIZE_1_NOTHROW_LEAF_LIST, ATTR_RETURNS_NONNULL,
185 ATTR_NULL, ATTR_MALLOC_WARN_UNUSED_RESULT_SIZE_1_NOTHROW_LEAF_LIST)
5dcf4561
MS
186
187/* Allocation functions like calloc the product of whose first two arguments
188 specifies the size of the allocated object. */
b8e2acff
ML
189DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_SIZE_1_2_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
190 ATTR_LIST_1_2, ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST)
5dcf4561
MS
191
192/* Allocation functions like realloc whose second argument specifies
193 the size of the allocated object. */
b8e2acff
ML
194DEF_ATTR_TREE_LIST (ATTR_ALLOC_WARN_UNUSED_RESULT_SIZE_2_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
195 ATTR_LIST_2, ATTR_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST)
5dcf4561 196
74124c73
KG
197/* Functions whose pointer parameter(s) are all nonnull. */
198DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL)
199/* Functions whose first parameter is a nonnull pointer. */
0d5b215c 200DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
74124c73 201/* Functions whose second parameter is a nonnull pointer. */
0d5b215c 202DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
b1e3f20e
JJ
203/* Functions whose third parameter is a nonnull pointer. */
204DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL)
74124c73 205/* Nothrow functions with the sentinel(1) attribute. */
254986c7
KG
206DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \
207 ATTR_NOTHROW_LIST)
74124c73
KG
208/* Nothrow functions whose pointer parameter(s) are all nonnull. */
209DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \
210 ATTR_NOTHROW_LIST)
0d6e14fd
JH
211/* Nothrow leaf functions whose pointer parameter(s) are all nonnull. */
212DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF, ATTR_NONNULL, ATTR_NULL, \
213 ATTR_NOTHROW_LEAF_LIST)
4d926e34 214DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_NONNULL_LEAF)
74124c73 215/* Nothrow functions whose first parameter is a nonnull pointer. */
00362064 216DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \
08291658 217 ATTR_NOTHROW_LIST)
74124c73 218/* Nothrow functions whose second parameter is a nonnull pointer. */
00362064 219DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \
08291658 220 ATTR_NOTHROW_LIST)
74124c73 221/* Nothrow functions whose third parameter is a nonnull pointer. */
00362064 222DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \
08291658 223 ATTR_NOTHROW_LIST)
10a0d495
JJ
224/* Nothrow functions whose fourth parameter is a nonnull pointer. */
225DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \
226 ATTR_NOTHROW_LIST)
227/* Nothrow functions whose fifth parameter is a nonnull pointer. */
228DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \
229 ATTR_NOTHROW_LIST)
474da67e
MS
230
231/* Same as ATTR_NONNULL_1. */
232DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
233/* Functions like {v,}fprintf whose first and second parameters are
234 nonnull pointers. As cancellation points the functions are not
235 nothrow. */
236DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_2, ATTR_NONNULL, ATTR_LIST_1_2, ATTR_NULL)
237/* The following don't have {v,}fprintf forms. They exist only to
238 make it possible to declare {v,}{f,s}printf attributes using
239 the same macro. */
240DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_3, ATTR_NONNULL, ATTR_LIST_1_3, ATTR_NULL)
241DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_4, ATTR_NONNULL, ATTR_LIST_1_4, ATTR_NULL)
242DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_5, ATTR_NONNULL, ATTR_LIST_1_5, ATTR_NULL)
243
244/* Same as ATTR_NOTHROW_NONNULL_1. */
245DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_1, ATTR_NONNULL, ATTR_LIST_1,
246 ATTR_NOTHROW_LIST)
247/* Nothrow functions like {v,}sprintf whose first and second parameters
248 are nonnull pointers. */
249DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_2, ATTR_NONNULL, ATTR_LIST_1_2, \
250 ATTR_NOTHROW_LIST)
251/* Nothrow functions like {v,}snprintf whose first and third parameters
252 are nonnull pointers. */
253DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_3, ATTR_NONNULL, ATTR_LIST_1_3, \
254 ATTR_NOTHROW_LIST)
255/* Nothrow functions like {v,}sprintf_chk whose first and fourth parameters
256 are nonnull pointers. */
257DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_4, ATTR_NONNULL, ATTR_LIST_1_4, \
258 ATTR_NOTHROW_LIST)
259/* Nothrow functions like {v,}snprintf_chk whose first and fifth parameters
260 are nonnull pointers. */
261DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_5, ATTR_NONNULL, ATTR_LIST_1_5, \
262 ATTR_NOTHROW_LIST)
263
1304953e
JJ
264/* Nothrow leaf functions which are type-generic. */
265DEF_ATTR_TREE_LIST (ATTR_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
266 ATTR_NOTHROW_LEAF_LIST)
4d926e34
MS
267/* Nothrow nonnull leaf functions that are type-generic. */
268DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_TYPEGENERIC_LEAF,
269 ATTR_TYPEGENERIC, ATTR_NULL,
270 ATTR_NOTHROW_NONNULL_LEAF)
74124c73
KG
271/* Nothrow const functions whose pointer parameter(s) are all nonnull. */
272DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \
273 ATTR_NOTHROW_NONNULL)
e384e6b5
BS
274/* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
275 and which return their first argument. */
276DEF_ATTR_TREE_LIST (ATTR_RET1_NOTHROW_NONNULL_LEAF, ATTR_FNSPEC, ATTR_LIST_STR1, \
277 ATTR_NOTHROW_NONNULL_LEAF)
a5bb8a5c
RB
278/* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
279 and return value is also nonnull. */
280DEF_ATTR_TREE_LIST (ATTR_RETNONNULL_NOTHROW_LEAF, ATTR_RETURNS_NONNULL, ATTR_NULL, \
281 ATTR_NOTHROW_NONNULL_LEAF)
0d6e14fd
JH
282/* Nothrow const leaf functions whose pointer parameter(s) are all nonnull. */
283DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF, ATTR_CONST, ATTR_NULL, \
284 ATTR_NOTHROW_NONNULL_LEAF)
b5d32c25
KG
285/* Nothrow const functions which are type-generic. */
286DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \
287 ATTR_CONST_NOTHROW_LIST)
0d6e14fd
JH
288/* Nothrow const leaf functions which are type-generic. */
289DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
290 ATTR_CONST_NOTHROW_LEAF_LIST)
74124c73
KG
291/* Nothrow pure functions whose pointer parameter(s) are all nonnull. */
292DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \
293 ATTR_NOTHROW_NONNULL)
0d6e14fd
JH
294/* Nothrow pure leaf functions whose pointer parameter(s) are all nonnull. */
295DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF, ATTR_PURE, ATTR_NULL, \
296 ATTR_NOTHROW_NONNULL_LEAF)
74124c73 297/* Nothrow malloc functions whose pointer parameter(s) are all nonnull. */
b8e2acff 298DEF_ATTR_TREE_LIST (ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL, ATTR_WARN_UNUSED_RESULT, ATTR_NULL, \
74124c73 299 ATTR_NOTHROW_NONNULL)
b8e2acff
ML
300DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \
301 ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL)
0d6e14fd 302/* Nothrow malloc leaf functions whose pointer parameter(s) are all nonnull. */
b8e2acff 303DEF_ATTR_TREE_LIST (ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL_LEAF, ATTR_WARN_UNUSED_RESULT, ATTR_NULL, \
0d6e14fd 304 ATTR_NOTHROW_NONNULL_LEAF)
b8e2acff
ML
305DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_NONNULL_LEAF, ATTR_MALLOC, ATTR_NULL, \
306 ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL_LEAF)
79ed7328 307
474da67e 308/* Construct a tree for the format attribute (and implicitly nonnull). */
79ed7328 309#define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES) \
9a238586
KG
310 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
311 ATTR_##TYPE, ATTR_LIST_##VALUES) \
312 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
b1e3f20e 313 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA)
474da67e
MS
314
315/* Construct a tree for the format and nothrow attributes (format
316 implies nonnull). */
b1e3f20e
JJ
317#define DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA, VALUES) \
318 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
319 ATTR_##TYPE, ATTR_LIST_##VALUES) \
320 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
321 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
474da67e
MS
322
323/* Construct one tree for the format attribute and another for the format
324 and nothrow attributes (in both cases format implies nonnull). */
b1e3f20e
JJ
325#define DEF_FORMAT_ATTRIBUTE_BOTH(TYPE, FA, VALUES) \
326 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
327 ATTR_##TYPE, ATTR_LIST_##VALUES) \
328 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
329 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA) \
330 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
9a238586 331 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
474da67e
MS
332
333/* Construct a pair of trees for the nonnull attribute for the first
334 argument, plus format printf attribute (format implies nonnull):
335 the first ordinary and the second nothrow. */
336#define DEF_FORMAT_ATTRIBUTE_NONNULL(TYPE, FA, VALUES) \
337 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_FORMAT_##TYPE##_##VALUES, \
338 ATTR_FORMAT, ATTR_##TYPE##_##VALUES, \
339 ATTR_NONNULL_1_##FA) \
340 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_FORMAT_##TYPE##_##VALUES, \
341 ATTR_FORMAT, ATTR_##TYPE##_##VALUES, \
342 ATTR_NOTHROW_NONNULL_1_##FA)
343
79ed7328
JT
344DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
345DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
b1e3f20e
JJ
346DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_0)
347DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_3)
348DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_0)
349DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_4)
350DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_0)
351DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_5)
352DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_0)
353DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_6)
474da67e
MS
354
355/* Attributes for fprintf(f, f, va). */
356DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,1,1_2)
357/* Attributes for v{f,s}printf(d, f, va). vsprintf is nothrow, vfprintf
358 is not. */
359DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,2,2_0)
360/* Attributes for {f,s}printf(d, f, ...). sprintf is nothrow, fprintf
361 is not. */
362DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,2,2_3)
363/* Attributes for vprintf_chk. */
364DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,3,3_0)
365/* Attributes for printf_chk. */
366DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,3,3_4)
367/* Attributes for v{f,s}printf_chk(d, t, bos, f, va). vsprintf_chk is
368 nothrow, vfprintf_chk is not. */
369DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,4,4_0)
370/* Attributes for {f,s}printf_chk(d, t, bos, f, ...). sprintf_chk is
371 nothrow, fprintf_chk is not. */
372DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,4,4_5)
373
79ed7328
JT
374DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
375DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
b1e3f20e
JJ
376DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_0)
377DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_3)
378DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME,3,3_0)
379DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON,3,3_4)
6431177a 380#undef DEF_FORMAT_ATTRIBUTE
b1e3f20e
JJ
381#undef DEF_FORMAT_ATTRIBUTE_NOTHROW
382#undef DEF_FORMAT_ATTRIBUTE_BOTH
6431177a 383
0a35513e
AH
384/* Transactional memory variants of the above. */
385
386DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST,
387 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NOTHROW_LIST)
388DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST,
389 ATTR_TM_TMPURE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
390DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST,
391 ATTR_PURE, ATTR_NULL, ATTR_TM_TMPURE_NOTHROW_LIST)
392DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST,
393 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NORETURN_NOTHROW_LIST)
394DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST,
395 ATTR_TM_REGPARM, ATTR_NULL, ATTR_CONST_NOTHROW_LIST)
b0c99997
TR
396DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_RT_LIST,
397 ATTR_RETURNS_TWICE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
0a35513e
AH
398
399/* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in. */
400DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST,
401 ATTR_TM_TMPURE, ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST)
402/* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in. */
403DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST,
404 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LIST)
405
bc77608b
JJ
406DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LEAF_LIST,
407 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
408DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST,
409 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
cb59f689
JH
410DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_COLD_LIST,
411 ATTR_COLD, ATTR_NULL,
412 ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST)
bc77608b 413
79ed7328
JT
414/* Construct a tree for a format_arg attribute. */
415#define DEF_FORMAT_ARG_ATTRIBUTE(FA) \
9a238586
KG
416 DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG, \
417 ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA)
79ed7328
JT
418DEF_FORMAT_ARG_ATTRIBUTE(1)
419DEF_FORMAT_ARG_ATTRIBUTE(2)
420#undef DEF_FORMAT_ARG_ATTRIBUTE
6431177a 421