1 /* Copyright (C
) 2001-2016 Free Software Foundation
, Inc.
2 Contributed by Joseph Myers
<jsm28@cam.ac.uk
>.
4 This file is part of GCC.
6 GCC is free software
; you can redistribute it and
/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation
; either version
3, or (at your option
) any later
11 GCC is distributed in the hope that it will be useful
, but WITHOUT ANY
12 WARRANTY
; without even the implied warranty of MERCHANTABILITY or
13 FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC
; see the file COPYING3. If not see
18 <http
://www.gnu.org
/licenses
/>.
*/
20 /* This header provides a declarative way of describing the attributes
21 that are applied to some functions by default.
23 Before including this header
, you must define the following macros.
24 In each case where there is an ENUM
, it is an identifier used to
25 reference the tree in subsequent definitions.
27 DEF_ATTR_NULL_TREE (ENUM
)
29 Constructs a NULL_TREE.
31 DEF_ATTR_INT (ENUM
, VALUE
)
33 Constructs an INTEGER_CST with value
VALUE (an integer representable
36 DEF_ATTR_IDENT (ENUM
, STRING
)
38 Constructs an IDENTIFIER_NODE for STRING.
40 DEF_ATTR_TREE_LIST (ENUM
, PURPOSE
, VALUE
, CHAIN
)
42 Constructs a TREE_LIST with given PURPOSE
, VALUE and
CHAIN (given
43 as previous ENUM names
).
*/
45 DEF_ATTR_NULL_TREE (ATTR_NULL
)
47 /* Construct a tree for a given integer and a list containing it.
*/
48 #define
DEF_ATTR_FOR_INT(VALUE
) \
49 DEF_ATTR_INT (ATTR_##VALUE
, VALUE
) \
50 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE
, ATTR_NULL
, \
51 ATTR_##VALUE
, ATTR_NULL
)
59 #undef DEF_ATTR_FOR_INT
61 /* Construct a tree for a given string and a list containing it.
*/
62 #define
DEF_ATTR_FOR_STRING(ENUM
, VALUE
) \
63 DEF_ATTR_STRING (ATTR_##ENUM
, VALUE
) \
64 DEF_ATTR_TREE_LIST (ATTR_LIST_##ENUM
, ATTR_NULL
, \
65 ATTR_##ENUM
, ATTR_NULL
)
66 DEF_ATTR_FOR_STRING (STR1
, "1")
67 #undef DEF_ATTR_FOR_STRING
69 /* Construct a tree for a list of two integers.
*/
70 #define
DEF_LIST_INT_INT(VALUE1
, VALUE2
) \
71 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE1##_##VALUE2
, ATTR_NULL
, \
72 ATTR_##VALUE1
, ATTR_LIST_##VALUE2
)
73 DEF_LIST_INT_INT (1,0)
74 DEF_LIST_INT_INT (1,2)
75 DEF_LIST_INT_INT (2,0)
76 DEF_LIST_INT_INT (2,3)
77 DEF_LIST_INT_INT (3,0)
78 DEF_LIST_INT_INT (3,4)
79 DEF_LIST_INT_INT (4,0)
80 DEF_LIST_INT_INT (4,5)
81 DEF_LIST_INT_INT (5,0)
82 DEF_LIST_INT_INT (5,6)
83 #undef DEF_LIST_INT_INT
85 /* Construct trees for identifiers.
*/
86 DEF_ATTR_IDENT (ATTR_COLD
, "cold")
87 DEF_ATTR_IDENT (ATTR_CONST
, "const")
88 DEF_ATTR_IDENT (ATTR_FORMAT
, "format")
89 DEF_ATTR_IDENT (ATTR_FORMAT_ARG
, "format_arg")
90 DEF_ATTR_IDENT (ATTR_MALLOC
, "malloc")
91 DEF_ATTR_IDENT (ATTR_NONNULL
, "nonnull")
92 DEF_ATTR_IDENT (ATTR_NORETURN
, "noreturn")
93 DEF_ATTR_IDENT (ATTR_NOTHROW
, "nothrow")
94 DEF_ATTR_IDENT (ATTR_LEAF
, "leaf")
95 DEF_ATTR_IDENT (ATTR_FNSPEC
, "fn spec")
96 DEF_ATTR_IDENT (ATTR_PRINTF
, "printf")
97 DEF_ATTR_IDENT (ATTR_ASM_FPRINTF
, "asm_fprintf")
98 DEF_ATTR_IDENT (ATTR_GCC_DIAG
, "gcc_diag")
99 DEF_ATTR_IDENT (ATTR_GCC_CDIAG
, "gcc_cdiag")
100 DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG
, "gcc_cxxdiag")
101 DEF_ATTR_IDENT (ATTR_PURE
, "pure")
102 DEF_ATTR_IDENT (ATTR_NOVOPS
, "no vops")
103 DEF_ATTR_IDENT (ATTR_SCANF
, "scanf")
104 DEF_ATTR_IDENT (ATTR_SENTINEL
, "sentinel")
105 DEF_ATTR_IDENT (ATTR_STRFMON
, "strfmon")
106 DEF_ATTR_IDENT (ATTR_STRFTIME
, "strftime")
107 DEF_ATTR_IDENT (ATTR_TYPEGENERIC
, "type generic")
108 DEF_ATTR_IDENT (ATTR_TM_REGPARM
, "*tm regparm")
109 DEF_ATTR_IDENT (ATTR_TM_TMPURE
, "transaction_pure")
110 DEF_ATTR_IDENT (ATTR_RETURNS_TWICE
, "returns_twice")
111 DEF_ATTR_IDENT (ATTR_RETURNS_NONNULL
, "returns_nonnull")
113 DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST
, ATTR_NOVOPS
, ATTR_NULL
, ATTR_NULL
)
115 DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LEAF_LIST
, ATTR_LEAF
, ATTR_NULL
, ATTR_NOVOPS_LIST
)
117 DEF_ATTR_TREE_LIST (ATTR_LEAF_LIST
, ATTR_LEAF
, ATTR_NULL
, ATTR_NULL
)
119 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST
, ATTR_NOTHROW
, ATTR_NULL
, ATTR_NULL
)
121 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST
, ATTR_LEAF
, ATTR_NULL
, ATTR_NOTHROW_LIST
)
123 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST
, ATTR_CONST
, \
124 ATTR_NULL
, ATTR_NOTHROW_LIST
)
125 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST
, ATTR_CONST
, \
126 ATTR_NULL
, ATTR_NOTHROW_LEAF_LIST
)
127 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST
, ATTR_PURE
, \
128 ATTR_NULL
, ATTR_NOTHROW_LIST
)
129 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST
, ATTR_PURE
, \
130 ATTR_NULL
, ATTR_NOTHROW_LEAF_LIST
)
131 DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST
, ATTR_NORETURN
, \
132 ATTR_NULL
, ATTR_NOTHROW_LIST
)
133 DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST
, ATTR_NORETURN
,\
134 ATTR_NULL
, ATTR_NOTHROW_LEAF_LIST
)
135 DEF_ATTR_TREE_LIST (ATTR_RT_NOTHROW_LEAF_LIST
, ATTR_RETURNS_TWICE
,\
136 ATTR_NULL
, ATTR_NOTHROW_LEAF_LIST
)
137 DEF_ATTR_TREE_LIST (ATTR_COLD_NOTHROW_LEAF_LIST
, ATTR_COLD
,\
138 ATTR_NULL
, ATTR_NOTHROW_LEAF_LIST
)
139 DEF_ATTR_TREE_LIST (ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST
, ATTR_COLD
,\
140 ATTR_NULL
, ATTR_NORETURN_NOTHROW_LEAF_LIST
)
141 DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST
, ATTR_CONST
,\
142 ATTR_NULL
, ATTR_NORETURN_NOTHROW_LEAF_LIST
)
143 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST
, ATTR_MALLOC
, \
144 ATTR_NULL
, ATTR_NOTHROW_LIST
)
145 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LEAF_LIST
, ATTR_MALLOC
, \
146 ATTR_NULL
, ATTR_NOTHROW_LEAF_LIST
)
147 DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST
, ATTR_SENTINEL
, \
148 ATTR_NULL
, ATTR_NOTHROW_LIST
)
149 DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST
, ATTR_SENTINEL
, \
150 ATTR_NULL
, ATTR_NOTHROW_LEAF_LIST
)
151 DEF_ATTR_TREE_LIST (ATTR_COLD_CONST_NORETURN_NOTHROW_LEAF_LIST
, ATTR_CONST
,\
152 ATTR_NULL
, ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST
)
154 /* Functions whose pointer
parameter(s
) are all nonnull.
*/
155 DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST
, ATTR_NONNULL
, ATTR_NULL
, ATTR_NULL
)
156 /* Functions whose first parameter is a nonnull pointer.
*/
157 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1
, ATTR_NONNULL
, ATTR_LIST_1
, ATTR_NULL
)
158 /* Functions whose second parameter is a nonnull pointer.
*/
159 DEF_ATTR_TREE_LIST (ATTR_NONNULL_2
, ATTR_NONNULL
, ATTR_LIST_2
, ATTR_NULL
)
160 /* Functions whose third parameter is a nonnull pointer.
*/
161 DEF_ATTR_TREE_LIST (ATTR_NONNULL_3
, ATTR_NONNULL
, ATTR_LIST_3
, ATTR_NULL
)
162 /* Nothrow functions with the
sentinel(1) attribute.
*/
163 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1
, ATTR_SENTINEL
, ATTR_LIST_1
, \
165 /* Nothrow functions whose pointer
parameter(s
) are all nonnull.
*/
166 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL
, ATTR_NONNULL
, ATTR_NULL
, \
168 /* Nothrow leaf functions whose pointer
parameter(s
) are all nonnull.
*/
169 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF
, ATTR_NONNULL
, ATTR_NULL
, \
170 ATTR_NOTHROW_LEAF_LIST
)
171 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF_LIST
, ATTR_LEAF
, ATTR_NULL
, ATTR_NOTHROW_NONNULL_LEAF
)
172 /* Nothrow functions whose first parameter is a nonnull pointer.
*/
173 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1
, ATTR_NONNULL
, ATTR_LIST_1
, \
175 /* Nothrow functions whose second parameter is a nonnull pointer.
*/
176 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2
, ATTR_NONNULL
, ATTR_LIST_2
, \
178 /* Nothrow functions whose third parameter is a nonnull pointer.
*/
179 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3
, ATTR_NONNULL
, ATTR_LIST_3
, \
181 /* Nothrow functions whose fourth parameter is a nonnull pointer.
*/
182 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4
, ATTR_NONNULL
, ATTR_LIST_4
, \
184 /* Nothrow functions whose fifth parameter is a nonnull pointer.
*/
185 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5
, ATTR_NONNULL
, ATTR_LIST_5
, \
187 /* Nothrow leaf functions which are type
-generic.
*/
188 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_TYPEGENERIC_LEAF
, ATTR_TYPEGENERIC
, ATTR_NULL
, \
189 ATTR_NOTHROW_LEAF_LIST
)
190 /* Nothrow nonnull leaf functions that are type
-generic.
*/
191 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_TYPEGENERIC_LEAF
,
192 ATTR_TYPEGENERIC
, ATTR_NULL
,
193 ATTR_NOTHROW_NONNULL_LEAF
)
194 /* Nothrow const functions whose pointer
parameter(s
) are all nonnull.
*/
195 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL
, ATTR_CONST
, ATTR_NULL
, \
196 ATTR_NOTHROW_NONNULL
)
197 /* Nothrow leaf functions whose pointer
parameter(s
) are all nonnull
,
198 and which return their first argument.
*/
199 DEF_ATTR_TREE_LIST (ATTR_RET1_NOTHROW_NONNULL_LEAF
, ATTR_FNSPEC
, ATTR_LIST_STR1
, \
200 ATTR_NOTHROW_NONNULL_LEAF
)
201 /* Nothrow leaf functions whose pointer
parameter(s
) are all nonnull
,
202 and return value is also nonnull.
*/
203 DEF_ATTR_TREE_LIST (ATTR_RETNONNULL_NOTHROW_LEAF
, ATTR_RETURNS_NONNULL
, ATTR_NULL
, \
204 ATTR_NOTHROW_NONNULL_LEAF
)
205 /* Nothrow const leaf functions whose pointer
parameter(s
) are all nonnull.
*/
206 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF
, ATTR_CONST
, ATTR_NULL
, \
207 ATTR_NOTHROW_NONNULL_LEAF
)
208 /* Nothrow const functions which are type
-generic.
*/
209 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC
, ATTR_TYPEGENERIC
, ATTR_NULL
, \
210 ATTR_CONST_NOTHROW_LIST
)
211 /* Nothrow const leaf functions which are type
-generic.
*/
212 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF
, ATTR_TYPEGENERIC
, ATTR_NULL
, \
213 ATTR_CONST_NOTHROW_LEAF_LIST
)
214 /* Nothrow pure functions whose pointer
parameter(s
) are all nonnull.
*/
215 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL
, ATTR_PURE
, ATTR_NULL
, \
216 ATTR_NOTHROW_NONNULL
)
217 /* Nothrow pure leaf functions whose pointer
parameter(s
) are all nonnull.
*/
218 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF
, ATTR_PURE
, ATTR_NULL
, \
219 ATTR_NOTHROW_NONNULL_LEAF
)
220 /* Nothrow malloc functions whose pointer
parameter(s
) are all nonnull.
*/
221 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL
, ATTR_MALLOC
, ATTR_NULL
, \
222 ATTR_NOTHROW_NONNULL
)
223 /* Nothrow malloc leaf functions whose pointer
parameter(s
) are all nonnull.
*/
224 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL_LEAF
, ATTR_MALLOC
, ATTR_NULL
, \
225 ATTR_NOTHROW_NONNULL_LEAF
)
227 /* Construct a tree for a format attribute.
*/
228 #define
DEF_FORMAT_ATTRIBUTE(TYPE, FA
, VALUES
) \
229 DEF_ATTR_TREE_LIST (ATTR_##
TYPE##_##VALUES
, ATTR_NULL
, \
230 ATTR_##
TYPE, ATTR_LIST_##VALUES
) \
231 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##
TYPE##_##VALUES
, ATTR_FORMAT
, \
232 ATTR_##
TYPE##_##VALUES
, ATTR_NONNULL_##FA
)
233 #define
DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA
, VALUES
) \
234 DEF_ATTR_TREE_LIST (ATTR_##
TYPE##_##VALUES
, ATTR_NULL
, \
235 ATTR_##
TYPE, ATTR_LIST_##VALUES
) \
236 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##
TYPE##_NOTHROW_##VALUES
, ATTR_FORMAT
,\
237 ATTR_##
TYPE##_##VALUES
, ATTR_NOTHROW_NONNULL_##FA
)
238 #define
DEF_FORMAT_ATTRIBUTE_BOTH(TYPE, FA
, VALUES
) \
239 DEF_ATTR_TREE_LIST (ATTR_##
TYPE##_##VALUES
, ATTR_NULL
, \
240 ATTR_##
TYPE, ATTR_LIST_##VALUES
) \
241 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##
TYPE##_##VALUES
, ATTR_FORMAT
, \
242 ATTR_##
TYPE##_##VALUES
, ATTR_NONNULL_##FA
) \
243 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##
TYPE##_NOTHROW_##VALUES
, ATTR_FORMAT
,\
244 ATTR_##
TYPE##_##VALUES
, ATTR_NOTHROW_NONNULL_##FA
)
245 DEF_FORMAT_ATTRIBUTE(PRINTF
,1,1_0
)
246 DEF_FORMAT_ATTRIBUTE(PRINTF
,1,1_2
)
247 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF
,2,2_0
)
248 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF
,2,2_3
)
249 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF
,3,3_0
)
250 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF
,3,3_4
)
251 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF
,4,4_0
)
252 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF
,4,4_5
)
253 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF
,5,5_0
)
254 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF
,5,5_6
)
255 DEF_FORMAT_ATTRIBUTE(SCANF
,1,1_0
)
256 DEF_FORMAT_ATTRIBUTE(SCANF
,1,1_2
)
257 DEF_FORMAT_ATTRIBUTE_BOTH(SCANF
,2,2_0
)
258 DEF_FORMAT_ATTRIBUTE_BOTH(SCANF
,2,2_3
)
259 DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME
,3,3_0
)
260 DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON
,3,3_4
)
261 #undef DEF_FORMAT_ATTRIBUTE
262 #undef DEF_FORMAT_ATTRIBUTE_NOTHROW
263 #undef DEF_FORMAT_ATTRIBUTE_BOTH
265 /* Transactional memory variants of the above.
*/
267 DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST
,
268 ATTR_TM_REGPARM
, ATTR_NULL
, ATTR_NOTHROW_LIST
)
269 DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST
,
270 ATTR_TM_TMPURE
, ATTR_NULL
, ATTR_TM_NOTHROW_LIST
)
271 DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST
,
272 ATTR_PURE
, ATTR_NULL
, ATTR_TM_TMPURE_NOTHROW_LIST
)
273 DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST
,
274 ATTR_TM_REGPARM
, ATTR_NULL
, ATTR_NORETURN_NOTHROW_LIST
)
275 DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST
,
276 ATTR_TM_REGPARM
, ATTR_NULL
, ATTR_CONST_NOTHROW_LIST
)
277 DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_RT_LIST
,
278 ATTR_RETURNS_TWICE
, ATTR_NULL
, ATTR_TM_NOTHROW_LIST
)
280 /* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in.
*/
281 DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST
,
282 ATTR_TM_TMPURE
, ATTR_NULL
, ATTR_MALLOC_NOTHROW_LIST
)
283 /* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in.
*/
284 DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST
,
285 ATTR_TM_TMPURE
, ATTR_NULL
, ATTR_NOTHROW_LIST
)
287 DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LEAF_LIST
,
288 ATTR_TM_TMPURE
, ATTR_NULL
, ATTR_NOTHROW_LEAF_LIST
)
289 DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST
,
290 ATTR_TM_TMPURE
, ATTR_NULL
, ATTR_NORETURN_NOTHROW_LEAF_LIST
)
292 /* Construct a tree for a format_arg attribute.
*/
293 #define
DEF_FORMAT_ARG_ATTRIBUTE(FA
) \
294 DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA
, ATTR_FORMAT_ARG
, \
295 ATTR_LIST_##FA
, ATTR_NOTHROW_NONNULL_##FA
)
296 DEF_FORMAT_ARG_ATTRIBUTE(1)
297 DEF_FORMAT_ARG_ATTRIBUTE(2)
298 #undef DEF_FORMAT_ARG_ATTRIBUTE