1/* Copyright (C) 2001-2017 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")
70#undef DEF_ATTR_FOR_STRING
71
72/* Construct a tree for a list of two integers. */
73#define DEF_LIST_INT_INT(VALUE1, VALUE2) \
74 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE1##_##VALUE2, ATTR_NULL, \
75 ATTR_##VALUE1, ATTR_LIST_##VALUE2)
76DEF_LIST_INT_INT (1,0)
77DEF_LIST_INT_INT (1,2)
78DEF_LIST_INT_INT (1,3)
79DEF_LIST_INT_INT (1,4)
80DEF_LIST_INT_INT (1,5)
81DEF_LIST_INT_INT (2,0)
82DEF_LIST_INT_INT (2,3)
83DEF_LIST_INT_INT (3,0)
84DEF_LIST_INT_INT (3,4)
85DEF_LIST_INT_INT (4,0)
86DEF_LIST_INT_INT (4,5)
87DEF_LIST_INT_INT (5,0)
88DEF_LIST_INT_INT (5,6)
89#undef DEF_LIST_INT_INT
90
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. */
94DEF_ATTR_IDENT (ATTR_ALLOC_SIZE, "alloc_size")
95DEF_ATTR_IDENT (ATTR_COLD, "cold")
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")
103DEF_ATTR_IDENT (ATTR_LEAF, "leaf")
104DEF_ATTR_IDENT (ATTR_FNSPEC, "fn spec")
105DEF_ATTR_IDENT (ATTR_PRINTF, "printf")
106DEF_ATTR_IDENT (ATTR_ASM_FPRINTF, "asm_fprintf")
107DEF_ATTR_IDENT (ATTR_GCC_DIAG, "gcc_diag")
108DEF_ATTR_IDENT (ATTR_GCC_CDIAG, "gcc_cdiag")
109DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG, "gcc_cxxdiag")
110DEF_ATTR_IDENT (ATTR_PURE, "pure")
111DEF_ATTR_IDENT (ATTR_NOVOPS, "no vops")
112DEF_ATTR_IDENT (ATTR_SCANF, "scanf")
113DEF_ATTR_IDENT (ATTR_SENTINEL, "sentinel")
114DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon")
115DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime")
116DEF_ATTR_IDENT (ATTR_TYPEGENERIC, "type generic")
117DEF_ATTR_IDENT (ATTR_TM_REGPARM, "*tm regparm")
118DEF_ATTR_IDENT (ATTR_TM_TMPURE, "transaction_pure")
119DEF_ATTR_IDENT (ATTR_RETURNS_TWICE, "returns_twice")
120DEF_ATTR_IDENT (ATTR_RETURNS_NONNULL, "returns_nonnull")
121
122DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL)
123
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
128DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL)
129
130DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_LIST)
131
132DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST, \
133 ATTR_NULL, ATTR_NOTHROW_LIST)
134DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST, ATTR_CONST, \
135 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
136DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE, \
137 ATTR_NULL, ATTR_NOTHROW_LIST)
138DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST, ATTR_PURE, \
139 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
140DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN, \
141 ATTR_NULL, ATTR_NOTHROW_LIST)
142DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST, ATTR_NORETURN,\
143 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
144DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_COLD_LIST, ATTR_COLD,\
145 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
146DEF_ATTR_TREE_LIST (ATTR_RT_NOTHROW_LEAF_LIST, ATTR_RETURNS_TWICE,\
147 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
148DEF_ATTR_TREE_LIST (ATTR_COLD_NOTHROW_LEAF_LIST, ATTR_COLD,\
149 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
150DEF_ATTR_TREE_LIST (ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST, ATTR_COLD,\
151 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
152DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\
153 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
154DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_COLD_LIST, ATTR_COLD,\
155 ATTR_NULL, ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST)
156DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC, \
157 ATTR_NULL, ATTR_NOTHROW_LIST)
158DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LEAF_LIST, ATTR_MALLOC, \
159 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
160DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL, \
161 ATTR_NULL, ATTR_NOTHROW_LIST)
162DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST, ATTR_SENTINEL, \
163 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
164DEF_ATTR_TREE_LIST (ATTR_COLD_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\
165 ATTR_NULL, ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST)
166
167/* Allocation functions like malloc and realloc whose first argument
168 with _SIZE_1, or second argument with _SIZE_2, specifies the size
169 of the allocated object. */
170DEF_ATTR_TREE_LIST (ATTR_MALLOC_SIZE_1_NOTHROW_LIST, ATTR_ALLOC_SIZE, \
171 ATTR_LIST_1, ATTR_MALLOC_NOTHROW_LIST)
172DEF_ATTR_TREE_LIST (ATTR_ALLOC_SIZE_2_NOTHROW_LIST, ATTR_ALLOC_SIZE, \
173 ATTR_LIST_2, ATTR_MALLOC_NOTHROW_LIST)
174DEF_ATTR_TREE_LIST (ATTR_MALLOC_SIZE_1_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
175 ATTR_LIST_1, ATTR_MALLOC_NOTHROW_LEAF_LIST)
176/* Alloca is just like malloc except that it never returns null. */
177DEF_ATTR_TREE_LIST (ATTR_ALLOCA_SIZE_1_NOTHROW_LEAF_LIST, ATTR_RETURNS_NONNULL,
178 ATTR_NULL, ATTR_MALLOC_SIZE_1_NOTHROW_LEAF_LIST)
179
180/* Allocation functions like calloc the product of whose first two arguments
181 specifies the size of the allocated object. */
182DEF_ATTR_TREE_LIST (ATTR_MALLOC_SIZE_1_2_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
183 ATTR_LIST_1_2, ATTR_MALLOC_NOTHROW_LEAF_LIST)
184
185/* Allocation functions like realloc whose second argument specifies
186 the size of the allocated object. */
187DEF_ATTR_TREE_LIST (ATTR_ALLOC_SIZE_2_NOTHROW_LEAF_LIST, ATTR_ALLOC_SIZE, \
188 ATTR_LIST_2, ATTR_NOTHROW_LEAF_LIST)
189
190/* Functions whose pointer parameter(s) are all nonnull. */
191DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL)
192/* Functions whose first parameter is a nonnull pointer. */
193DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
194/* Functions whose second parameter is a nonnull pointer. */
195DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
196/* Functions whose third parameter is a nonnull pointer. */
197DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL)
198/* Nothrow functions with the sentinel(1) attribute. */
199DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \
200 ATTR_NOTHROW_LIST)
201/* Nothrow functions whose pointer parameter(s) are all nonnull. */
202DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \
203 ATTR_NOTHROW_LIST)
204/* Nothrow leaf functions whose pointer parameter(s) are all nonnull. */
205DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF, ATTR_NONNULL, ATTR_NULL, \
206 ATTR_NOTHROW_LEAF_LIST)
207DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_NONNULL_LEAF)
208/* Nothrow functions whose first parameter is a nonnull pointer. */
209DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \
210 ATTR_NOTHROW_LIST)
211/* Nothrow functions whose second parameter is a nonnull pointer. */
212DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \
213 ATTR_NOTHROW_LIST)
214/* Nothrow functions whose third parameter is a nonnull pointer. */
215DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \
216 ATTR_NOTHROW_LIST)
217/* Nothrow functions whose fourth parameter is a nonnull pointer. */
218DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \
219 ATTR_NOTHROW_LIST)
220/* Nothrow functions whose fifth parameter is a nonnull pointer. */
221DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \
222 ATTR_NOTHROW_LIST)
223
224/* Same as ATTR_NONNULL_1. */
225DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
226/* Functions like {v,}fprintf whose first and second parameters are
227 nonnull pointers. As cancellation points the functions are not
228 nothrow. */
229DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_2, ATTR_NONNULL, ATTR_LIST_1_2, ATTR_NULL)
230/* The following don't have {v,}fprintf forms. They exist only to
231 make it possible to declare {v,}{f,s}printf attributes using
232 the same macro. */
233DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_3, ATTR_NONNULL, ATTR_LIST_1_3, ATTR_NULL)
234DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_4, ATTR_NONNULL, ATTR_LIST_1_4, ATTR_NULL)
235DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_5, ATTR_NONNULL, ATTR_LIST_1_5, ATTR_NULL)
236
237/* Same as ATTR_NOTHROW_NONNULL_1. */
238DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_1, ATTR_NONNULL, ATTR_LIST_1,
239 ATTR_NOTHROW_LIST)
240/* Nothrow functions like {v,}sprintf whose first and second parameters
241 are nonnull pointers. */
242DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_2, ATTR_NONNULL, ATTR_LIST_1_2, \
243 ATTR_NOTHROW_LIST)
244/* Nothrow functions like {v,}snprintf whose first and third parameters
245 are nonnull pointers. */
246DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_3, ATTR_NONNULL, ATTR_LIST_1_3, \
247 ATTR_NOTHROW_LIST)
248/* Nothrow functions like {v,}sprintf_chk whose first and fourth parameters
249 are nonnull pointers. */
250DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_4, ATTR_NONNULL, ATTR_LIST_1_4, \
251 ATTR_NOTHROW_LIST)
252/* Nothrow functions like {v,}snprintf_chk whose first and fifth parameters
253 are nonnull pointers. */
254DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_5, ATTR_NONNULL, ATTR_LIST_1_5, \
255 ATTR_NOTHROW_LIST)
256
257/* Nothrow leaf functions which are type-generic. */
258DEF_ATTR_TREE_LIST (ATTR_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
259 ATTR_NOTHROW_LEAF_LIST)
260/* Nothrow nonnull leaf functions that are type-generic. */
261DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_TYPEGENERIC_LEAF,
262 ATTR_TYPEGENERIC, ATTR_NULL,
263 ATTR_NOTHROW_NONNULL_LEAF)
264/* Nothrow const functions whose pointer parameter(s) are all nonnull. */
265DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \
266 ATTR_NOTHROW_NONNULL)
267/* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
268 and which return their first argument. */
269DEF_ATTR_TREE_LIST (ATTR_RET1_NOTHROW_NONNULL_LEAF, ATTR_FNSPEC, ATTR_LIST_STR1, \
270 ATTR_NOTHROW_NONNULL_LEAF)
271/* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
272 and return value is also nonnull. */
273DEF_ATTR_TREE_LIST (ATTR_RETNONNULL_NOTHROW_LEAF, ATTR_RETURNS_NONNULL, ATTR_NULL, \
274 ATTR_NOTHROW_NONNULL_LEAF)
275/* Nothrow const leaf functions whose pointer parameter(s) are all nonnull. */
276DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF, ATTR_CONST, ATTR_NULL, \
277 ATTR_NOTHROW_NONNULL_LEAF)
278/* Nothrow const functions which are type-generic. */
279DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \
280 ATTR_CONST_NOTHROW_LIST)
281/* Nothrow const leaf functions which are type-generic. */
282DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
283 ATTR_CONST_NOTHROW_LEAF_LIST)
284/* Nothrow pure functions whose pointer parameter(s) are all nonnull. */
285DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \
286 ATTR_NOTHROW_NONNULL)
287/* Nothrow pure leaf functions whose pointer parameter(s) are all nonnull. */
288DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF, ATTR_PURE, ATTR_NULL, \
289 ATTR_NOTHROW_NONNULL_LEAF)
290/* Nothrow malloc functions whose pointer parameter(s) are all nonnull. */
291DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \
292 ATTR_NOTHROW_NONNULL)
293/* Nothrow malloc leaf functions whose pointer parameter(s) are all nonnull. */
294DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL_LEAF, ATTR_MALLOC, ATTR_NULL, \
295 ATTR_NOTHROW_NONNULL_LEAF)
296
297/* Construct a tree for the format attribute (and implicitly nonnull). */
298#define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES) \
299 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
300 ATTR_##TYPE, ATTR_LIST_##VALUES) \
301 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
302 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA)
303
304/* Construct a tree for the format and nothrow attributes (format
305 implies nonnull). */
306#define DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA, VALUES) \
307 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
308 ATTR_##TYPE, ATTR_LIST_##VALUES) \
309 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
310 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
311
312/* Construct one tree for the format attribute and another for the format
313 and nothrow attributes (in both cases format implies nonnull). */
314#define DEF_FORMAT_ATTRIBUTE_BOTH(TYPE, FA, VALUES) \
315 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
316 ATTR_##TYPE, ATTR_LIST_##VALUES) \
317 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
318 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA) \
319 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
320 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
321
322/* Construct a pair of trees for the nonnull attribute for the first
323 argument, plus format printf attribute (format implies nonnull):
324 the first ordinary and the second nothrow. */
325#define DEF_FORMAT_ATTRIBUTE_NONNULL(TYPE, FA, VALUES) \
326 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1_FORMAT_##TYPE##_##VALUES, \
327 ATTR_FORMAT, ATTR_##TYPE##_##VALUES, \
328 ATTR_NONNULL_1_##FA) \
329 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1_FORMAT_##TYPE##_##VALUES, \
330 ATTR_FORMAT, ATTR_##TYPE##_##VALUES, \
331 ATTR_NOTHROW_NONNULL_1_##FA)
332
333DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
334DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
335DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_0)
336DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_3)
337DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_0)
338DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_4)
339DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_0)
340DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_5)
341DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_0)
342DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_6)
343
344/* Attributes for fprintf(f, f, va). */
345DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,1,1_2)
346/* Attributes for v{f,s}printf(d, f, va). vsprintf is nothrow, vfprintf
347 is not. */
348DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,2,2_0)
349/* Attributes for {f,s}printf(d, f, ...). sprintf is nothrow, fprintf
350 is not. */
351DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,2,2_3)
352/* Attributes for vprintf_chk. */
353DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,3,3_0)
354/* Attributes for printf_chk. */
355DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,3,3_4)
356/* Attributes for v{f,s}printf_chk(d, t, bos, f, va). vsprintf_chk is
357 nothrow, vfprintf_chk is not. */
358DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,4,4_0)
359/* Attributes for {f,s}printf_chk(d, t, bos, f, ...). sprintf_chk is
360 nothrow, fprintf_chk is not. */
361DEF_FORMAT_ATTRIBUTE_NONNULL(PRINTF,4,4_5)
362
363DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
364DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
365DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_0)
366DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_3)
367DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME,3,3_0)
368DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON,3,3_4)
369#undef DEF_FORMAT_ATTRIBUTE
370#undef DEF_FORMAT_ATTRIBUTE_NOTHROW
371#undef DEF_FORMAT_ATTRIBUTE_BOTH
372
373/* Transactional memory variants of the above. */
374
375DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST,
376 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NOTHROW_LIST)
377DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST,
378 ATTR_TM_TMPURE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
379DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST,
380 ATTR_PURE, ATTR_NULL, ATTR_TM_TMPURE_NOTHROW_LIST)
381DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST,
382 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NORETURN_NOTHROW_LIST)
383DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST,
384 ATTR_TM_REGPARM, ATTR_NULL, ATTR_CONST_NOTHROW_LIST)
385DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_RT_LIST,
386 ATTR_RETURNS_TWICE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
387
388/* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in. */
389DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST,
390 ATTR_TM_TMPURE, ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST)
391/* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in. */
392DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST,
393 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LIST)
394
395DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LEAF_LIST,
396 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
397DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST,
398 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST)
399DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_COLD_LIST,
400 ATTR_COLD, ATTR_NULL,
401 ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST)
402
403/* Construct a tree for a format_arg attribute. */
404#define DEF_FORMAT_ARG_ATTRIBUTE(FA) \
405 DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG, \
406 ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA)
407DEF_FORMAT_ARG_ATTRIBUTE(1)
408DEF_FORMAT_ARG_ATTRIBUTE(2)
409#undef DEF_FORMAT_ARG_ATTRIBUTE
410
411