1/* Copyright (C) 2001-2025 Free Software Foundation, Inc.
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
8Software Foundation; either version 3, or (at your option) any later
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
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20/* This header provides a declarative way of describing the attributes
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.
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
46 as previous ENUM names). */
47
48DEF_ATTR_NULL_TREE (ATTR_NULL)
49
50/* Construct a tree for a given integer and a list containing it. */
51#define DEF_ATTR_FOR_INT(VALUE) \
52 DEF_ATTR_INT (ATTR_##VALUE, VALUE) \
53 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE, ATTR_NULL, \
54 ATTR_##VALUE, ATTR_NULL)
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)
60DEF_ATTR_FOR_INT (5)
61DEF_ATTR_FOR_INT (6)
62#undef DEF_ATTR_FOR_INT
63
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 ")
70DEF_ATTR_FOR_STRING (STRERRNOC, ".C")
71DEF_ATTR_FOR_STRING (STRERRNOP, ".P")
72#undef DEF_ATTR_FOR_STRING
73
74/* Construct a tree for a list of two integers. */
75#define DEF_LIST_INT_INT(VALUE1, VALUE2) \
76 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE1##_##VALUE2, ATTR_NULL, \
77 ATTR_##VALUE1, ATTR_LIST_##VALUE2)
78DEF_LIST_INT_INT (1,0)
79DEF_LIST_INT_INT (1,2)
80DEF_LIST_INT_INT (1,3)
81DEF_LIST_INT_INT (1,4)
82DEF_LIST_INT_INT (1,5)
83DEF_LIST_INT_INT (2,0)
84DEF_LIST_INT_INT (2,3)
85DEF_LIST_INT_INT (3,0)
86DEF_LIST_INT_INT (3,4)
87DEF_LIST_INT_INT (4,0)
88DEF_LIST_INT_INT (4,5)
89DEF_LIST_INT_INT (5,0)
90DEF_LIST_INT_INT (5,6)
91#undef DEF_LIST_INT_INT
92
93/* Construct trees for identifiers used in built-in function attributes.
94 The construction contributes to startup costs so only attributes that
95 are used to define built-ins should be defined here. */
96DEF_ATTR_IDENT (ATTR_ALLOC_SIZE, "alloc_size")
97DEF_ATTR_IDENT (ATTR_COLD, "cold")
98DEF_ATTR_IDENT (ATTR_CONST, "const")
99DEF_ATTR_IDENT (ATTR_FORMAT, "format")
100DEF_ATTR_IDENT (ATTR_FORMAT_ARG, "format_arg")
101DEF_ATTR_IDENT (ATTR_MALLOC, "malloc")
102DEF_ATTR_IDENT (ATTR_NONNULL, "nonnull")
103DEF_ATTR_IDENT (ATTR_NONNULL_IF_NONZERO, "nonnull_if_nonzero")
104DEF_ATTR_IDENT (ATTR_NORETURN, "noreturn")
105DEF_ATTR_IDENT (ATTR_NOTHROW, "nothrow")
106DEF_ATTR_IDENT (ATTR_LEAF, "leaf")
107DEF_ATTR_IDENT (ATTR_FNSPEC, "fn spec")
108DEF_ATTR_IDENT (ATTR_PRINTF, "printf")
109DEF_ATTR_IDENT (ATTR_ASM_FPRINTF, "asm_fprintf")
110DEF_ATTR_IDENT (ATTR_GCC_DIAG, "gcc_diag")
111DEF_ATTR_IDENT (ATTR_GCC_CDIAG, "gcc_cdiag")
112DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG, "gcc_cxxdiag")
113DEF_ATTR_IDENT (ATTR_PURE, "pure")
114DEF_ATTR_IDENT (ATTR_NOVOPS, "no vops")
115DEF_ATTR_IDENT (ATTR_SCANF, "scanf")
116DEF_ATTR_IDENT (ATTR_SENTINEL, "sentinel")
117DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon")
118DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime")
119DEF_ATTR_IDENT (ATTR_TYPEGENERIC, "type generic")
120DEF_ATTR_IDENT (ATTR_TM_REGPARM, "*tm regparm")
121DEF_ATTR_IDENT (ATTR_TM_TMPURE, "transaction_pure")
122DEF_ATTR_IDENT (ATTR_RETURNS_TWICE, "returns_twice")
123DEF_ATTR_IDENT (ATTR_RETURNS_NONNULL, "returns_nonnull")
124DEF_ATTR_IDENT (ATTR_WARN_UNUSED_RESULT, "warn_unused_result")
125
126DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL)
127
128DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOVOPS_LIST)
129
130DEF_ATTR_TREE_LIST (ATTR_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NULL)
131
132DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL)
133
134DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_LIST)
135
136DEF_ATTR_TREE_LIST (ATTR_NOVOPS_NOTHROW_LEAF_LIST, ATTR_NOVOPS, \
137 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
138DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST, \
139 ATTR_NULL, ATTR_NOTHROW_LIST)
140DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST, ATTR_CONST, \
141 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
142DEF_ATTR_TREE_LIST (ATTR_ERRNOCONST_NOTHROW_LEAF_LIST, ATTR_FNSPEC,\
143 ATTR_LIST_STRERRNOC, ATTR_NOTHROW_LEAF_LIST)
144DEF_ATTR_TREE_LIST (ATTR_ERRNOPURE_NOTHROW_LEAF_LIST, ATTR_FNSPEC,\
145 ATTR_LIST_STRERRNOP, ATTR_NOTHROW_LEAF_LIST)
146DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE, \
147 ATTR_NULL, ATTR_NOTHROW_LIST)
148DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST, ATTR_PURE, \
149 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
150DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN, \
151 ATTR_NULL, ATTR_NOTHROW_LIST)
152DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST, ATTR_NORETURN,\
153 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
154DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_COLD_LIST, ATTR_COLD,\
155 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
156DEF_ATTR_TREE_LIST (ATTR_RT_NOTHROW_LEAF_LIST, ATTR_RETURNS_TWICE,\
157 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
158DEF_ATTR_TREE_LIST (ATTR_COLD_NOTHROW_LEAF_LIST, ATTR_COLD,\
159 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
160DEF_ATTR_TREE_LIST (ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST, ATTR_COLD,\
161 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
162DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\
163 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
164DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_COLD_LIST, ATTR_COLD,\
165 ATTR_NULL, ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST)
166DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC, \
167 ATTR_NULL, ATTR_NOTHROW_LIST)
168DEF_ATTR_TREE_LIST (ATTR_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST, ATTR_WARN_UNUSED_RESULT, \
169 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
170DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST, ATTR_MALLOC, \
171 ATTR_NULL, ATTR_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST)
172DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL, \
173 ATTR_NULL, ATTR_NOTHROW_LIST)
174DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST, ATTR_SENTINEL, \
175 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
176DEF_ATTR_TREE_LIST (ATTR_COLD_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\
177 ATTR_NULL, ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST)
178
179/* Allocation functions like malloc and realloc whose first argument
180 with _SIZE_1, or second argument with _SIZE_2, specifies the size
181 of the allocated object. */
182DEF_ATTR_TREE_LIST (ATTR_MALLOC_SIZE_1_NOTHROW_LIST, ATTR_ALLOC_SIZE, \
183 ATTR_LIST_1, ATTR_MALLOC_NOTHROW_LIST)
184DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LIST, ATTR_WARN_UNUSED_RESULT, \
185 ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST)
186DEF_ATTR_TREE_LIST (ATTR_ALLOC_WARN_UNUSED_RESULT_SIZE_2_NOTHROW_LIST, ATTR_ALLOC_SIZE, \
187 ATTR_LIST_2, ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LIST)
188DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_SIZE_1_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
189 ATTR_LIST_1, ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST)
190/* Alloca is just like malloc except that it never returns null. */
191DEF_ATTR_TREE_LIST (ATTR_ALLOCA_WARN_UNUSED_RESULT_SIZE_1_NOTHROW_LEAF_LIST, ATTR_RETURNS_NONNULL,
192 ATTR_NULL, ATTR_MALLOC_WARN_UNUSED_RESULT_SIZE_1_NOTHROW_LEAF_LIST)
193
194/* Allocation functions like calloc the product of whose first two arguments
195 specifies the size of the allocated object. */
196DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_SIZE_1_2_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
197 ATTR_LIST_1_2, ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST)
198
199/* Allocation functions like realloc whose second argument specifies
200 the size of the allocated object. */
201DEF_ATTR_TREE_LIST (ATTR_ALLOC_WARN_UNUSED_RESULT_SIZE_2_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
202 ATTR_LIST_2, ATTR_WARN_UNUSED_RESULT_NOTHROW_LEAF_LIST)
203
204/* Functions whose pointer parameter(s) are all nonnull. */
205DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL)
206/* Functions whose first parameter is a nonnull pointer. */
207DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
208/* Functions whose second parameter is a nonnull pointer. */
209DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
210/* Functions whose third parameter is a nonnull pointer. */
211DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL)
212/* Nothrow functions with the sentinel(1) attribute. */
213DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \
214 ATTR_NOTHROW_LIST)
215/* Nothrow functions whose pointer parameter(s) are all nonnull. */
216DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \
217 ATTR_NOTHROW_LIST)
218/* Nothrow leaf functions whose pointer parameter(s) are all nonnull. */
219DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF, ATTR_NONNULL, ATTR_NULL, \
220 ATTR_NOTHROW_LEAF_LIST)
221DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_NONNULL_LEAF)
222/* Nothrow functions whose first parameter is a nonnull pointer. */
223DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \
224 ATTR_NOTHROW_LIST)
225/* Nothrow functions whose second parameter is a nonnull pointer. */
226DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \
227 ATTR_NOTHROW_LIST)
228/* Nothrow functions whose third parameter is a nonnull pointer. */
229DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \
230 ATTR_NOTHROW_LIST)
231/* Nothrow functions whose fourth parameter is a nonnull pointer. */
232DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \
233 ATTR_NOTHROW_LIST)
234/* Nothrow functions whose fifth parameter is a nonnull pointer. */
235DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \
236 ATTR_NOTHROW_LIST)
237/* Nothrow leaf functions whose selected pointer parameter(s) are conditionally
238 nonnull. */
239DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_IF12_LEAF, ATTR_NONNULL_IF_NONZERO, \
240 ATTR_LIST_1_2, ATTR_NOTHROW_LEAF_LIST)
241DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_IF13_LEAF, ATTR_NONNULL_IF_NONZERO, \
242 ATTR_LIST_1_3, ATTR_NOTHROW_LEAF_LIST)
243DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_IF123_LEAF, ATTR_NONNULL_IF_NONZERO, \
244 ATTR_LIST_2_3, ATTR_NOTHROW_NONNULL_IF13_LEAF)
245DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_IF23_LEAF, ATTR_NONNULL_IF_NONZERO, \
246 ATTR_LIST_2_3, ATTR_NOTHROW_LEAF_LIST)
247DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_IF23_LEAF, ATTR_NONNULL, \
248 ATTR_LIST_1, ATTR_NOTHROW_NONNULL_IF23_LEAF)
249
250/* Same as ATTR_NONNULL_1. */
251DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
252/* Functions like {v,}fprintf whose first and second parameters are
253 nonnull pointers. As cancellation points the functions are not
254 nothrow. */
255DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_2, ATTR_NONNULL, ATTR_LIST_1_2, ATTR_NULL)
256/* The following don't have {v,}fprintf forms. They exist only to
257 make it possible to declare {v,}{f,s}printf attributes using
258 the same macro. */
259DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_3, ATTR_NONNULL, ATTR_LIST_1_3, ATTR_NULL)
260DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_4, ATTR_NONNULL, ATTR_LIST_1_4, ATTR_NULL)
261DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_5, ATTR_NONNULL, ATTR_LIST_1_5, ATTR_NULL)
262
263/* Same as ATTR_NOTHROW_NONNULL_1. */
264DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_1, ATTR_NONNULL, ATTR_LIST_1,
265 ATTR_NOTHROW_LIST)
266/* Nothrow functions like {v,}sprintf whose first and second parameters
267 are nonnull pointers. */
268DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_2, ATTR_NONNULL, ATTR_LIST_1_2, \
269 ATTR_NOTHROW_LIST)
270/* Nothrow functions like {v,}snprintf whose first and third parameters
271 are nonnull pointers. */
272DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_3, ATTR_NONNULL, ATTR_LIST_1_3, \
273 ATTR_NOTHROW_LIST)
274/* Nothrow functions like {v,}sprintf_chk whose first and fourth parameters
275 are nonnull pointers. */
276DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_4, ATTR_NONNULL, ATTR_LIST_1_4, \
277 ATTR_NOTHROW_LIST)
278/* Nothrow functions like {v,}snprintf_chk whose first and fifth parameters
279 are nonnull pointers. */
280DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_5, ATTR_NONNULL, ATTR_LIST_1_5, \
281 ATTR_NOTHROW_LIST)
282
283/* Nothrow leaf functions which are type-generic. */
284DEF_ATTR_TREE_LIST (ATTR_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
285 ATTR_NOTHROW_LEAF_LIST)
286/* Nothrow nonnull leaf functions that are type-generic. */
287DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_TYPEGENERIC_LEAF,
288 ATTR_TYPEGENERIC, ATTR_NULL,
289 ATTR_NOTHROW_NONNULL_LEAF)
290/* Nothrow const functions whose pointer parameter(s) are all nonnull. */
291DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \
292 ATTR_NOTHROW_NONNULL)
293/* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
294 and which return their first argument. */
295DEF_ATTR_TREE_LIST (ATTR_RET1_NOTHROW_NONNULL_LEAF, ATTR_FNSPEC, ATTR_LIST_STR1, \
296 ATTR_NOTHROW_NONNULL_LEAF)
297/* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
298 and return value is also nonnull. */
299DEF_ATTR_TREE_LIST (ATTR_RETNONNULL_NOTHROW_LEAF, ATTR_RETURNS_NONNULL, ATTR_NULL, \
300 ATTR_NOTHROW_NONNULL_LEAF)
301/* Nothrow const leaf functions whose pointer parameter(s) are all nonnull. */
302DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF, ATTR_CONST, ATTR_NULL, \
303 ATTR_NOTHROW_NONNULL_LEAF)
304/* Nothrow const functions which are type-generic. */
305DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \
306 ATTR_CONST_NOTHROW_LIST)
307/* Nothrow const leaf functions which are type-generic. */
308DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
309 ATTR_CONST_NOTHROW_LEAF_LIST)
310/* Nothrow pure functions whose pointer parameter(s) are all nonnull. */
311DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \
312 ATTR_NOTHROW_NONNULL)
313/* Nothrow pure leaf functions whose pointer parameter(s) are all nonnull. */
314DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF, ATTR_PURE, ATTR_NULL, \
315 ATTR_NOTHROW_NONNULL_LEAF)
316/* Nothrow pure leaf functions whose selected pointer parameter(s) are
317 conditionally nonnull. */
318DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_IF12_LEAF, ATTR_PURE, ATTR_NULL, \
319 ATTR_NOTHROW_NONNULL_IF12_LEAF)
320DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_IF13_LEAF, ATTR_PURE, ATTR_NULL, \
321 ATTR_NOTHROW_NONNULL_IF13_LEAF)
322DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_IF123_LEAF, ATTR_PURE, ATTR_NULL, \
323 ATTR_NOTHROW_NONNULL_IF123_LEAF)
324/* Nothrow malloc functions whose pointer parameter(s) are all nonnull. */
325DEF_ATTR_TREE_LIST (ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL, ATTR_WARN_UNUSED_RESULT, ATTR_NULL, \
326 ATTR_NOTHROW_NONNULL)
327DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \
328 ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL)
329/* Nothrow malloc leaf functions whose pointer parameter(s) are all nonnull. */
330DEF_ATTR_TREE_LIST (ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL_LEAF, ATTR_WARN_UNUSED_RESULT, ATTR_NULL, \
331 ATTR_NOTHROW_NONNULL_LEAF)
332DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_NONNULL_LEAF, ATTR_MALLOC, ATTR_NULL, \
333 ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL_LEAF)
334/* Nothrow malloc leaf functions whose selected pointer parameter(s) are
335 conditionally nonnull. */
336DEF_ATTR_TREE_LIST (ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL_IF12_LEAF, \
337 ATTR_WARN_UNUSED_RESULT, ATTR_NULL, \
338 ATTR_NOTHROW_NONNULL_IF12_LEAF)
339DEF_ATTR_TREE_LIST (ATTR_MALLOC_WARN_UNUSED_RESULT_NOTHROW_NONNULL_IF12_LEAF, \
340 ATTR_MALLOC, ATTR_NULL, \
341 ATTR_WARN_UNUSED_RESULT_NOTHROW_NONNULL_IF12_LEAF)
342
343/* Construct a tree for the format attribute (and implicitly nonnull). */
344#define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES) \
345 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
346 ATTR_##TYPE, ATTR_LIST_##VALUES) \
347 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
348 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA)
349
350/* Construct a tree for the format and nothrow attributes (format
351 implies nonnull). */
352#define DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA, VALUES) \
353 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
354 ATTR_##TYPE, ATTR_LIST_##VALUES) \
355 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
356 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
357
358/* Construct one tree for the format attribute and another for the format
359 and nothrow attributes (in both cases format implies nonnull). */
360#define DEF_FORMAT_ATTRIBUTE_BOTH(TYPE, FA, VALUES) \
361 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
362 ATTR_##TYPE, ATTR_LIST_##VALUES) \
363 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
364 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA) \
365 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
366 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
367
368/* Construct a pair of trees for the nonnull attribute for the first
369 argument, plus format printf attribute (format implies nonnull):
370 the first ordinary and the second nothrow. */
371#define DEF_FORMAT_ATTRIBUTE_NONNULL(TYPE, FA, VALUES) \
372 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_FORMAT_##TYPE##_##VALUES, \
373 ATTR_FORMAT, ATTR_##TYPE##_##VALUES, \
374 ATTR_NONNULL_1_##FA) \
375 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_FORMAT_##TYPE##_##VALUES, \
376 ATTR_FORMAT, ATTR_##TYPE##_##VALUES, \
377 ATTR_NOTHROW_NONNULL_1_##FA)
378
379DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
380DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
381DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_0)
382DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_3)
383DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_0)
384DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_4)
385DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_0)
386DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_5)
387DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_0)
388DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_6)
389
390/* Attributes for fprintf(f, f, va). */
391DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,1,1_2)
392/* Attributes for v{f,s}printf(d, f, va). vsprintf is nothrow, vfprintf
393 is not. */
394DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,2,2_0)
395/* Attributes for {f,s}printf(d, f, ...). sprintf is nothrow, fprintf
396 is not. */
397DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,2,2_3)
398/* Attributes for vprintf_chk. */
399DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,3,3_0)
400/* Attributes for printf_chk. */
401DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,3,3_4)
402/* Attributes for v{f,s}printf_chk(d, t, bos, f, va). vsprintf_chk is
403 nothrow, vfprintf_chk is not. */
404DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,4,4_0)
405/* Attributes for {f,s}printf_chk(d, t, bos, f, ...). sprintf_chk is
406 nothrow, fprintf_chk is not. */
407DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,4,4_5)
408
409DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
410DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
411DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_0)
412DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_3)
413DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME,3,3_0)
414DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON,3,3_4)
415#undef DEF_FORMAT_ATTRIBUTE
416#undef DEF_FORMAT_ATTRIBUTE_NOTHROW
417#undef DEF_FORMAT_ATTRIBUTE_BOTH
418
419/* Transactional memory variants of the above. */
420
421DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST,
422 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NOTHROW_LIST)
423DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST,
424 ATTR_TM_TMPURE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
425DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST,
426 ATTR_PURE, ATTR_NULL, ATTR_TM_TMPURE_NOTHROW_LIST)
427DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST,
428 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NORETURN_NOTHROW_LIST)
429DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST,
430 ATTR_TM_REGPARM, ATTR_NULL, ATTR_CONST_NOTHROW_LIST)
431DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_RT_LIST,
432 ATTR_RETURNS_TWICE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
433
434/* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in. */
435DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST,
436 ATTR_TM_TMPURE, ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST)
437/* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in. */
438DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST,
439 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LIST)
440
441DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LEAF_LIST,
442 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
443DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST,
444 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
445DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_COLD_LIST,
446 ATTR_COLD, ATTR_NULL,
447 ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST)
448
449/* Construct a tree for a format_arg attribute. */
450#define DEF_FORMAT_ARG_ATTRIBUTE(FA) \
451 DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG, \
452 ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA)
453DEF_FORMAT_ARG_ATTRIBUTE(1)
454DEF_FORMAT_ARG_ATTRIBUTE(2)
455#undef DEF_FORMAT_ARG_ATTRIBUTE
456
457

source code of gcc/builtin-attrs.def