1 /* Copyright (C) 2001, 2002, 2004, 2005, 2007, 2010
2 Free Software Foundation, Inc.
3 Contributed by Joseph Myers <jsm28@cam.ac.uk>.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 /* This header provides a declarative way of describing the attributes
22 that are applied to some functions by default.
24 Before including this header, you must define the following macros.
25 In each case where there is an ENUM, it is an identifier used to
26 reference the tree in subsequent definitions.
28 DEF_ATTR_NULL_TREE (ENUM)
30 Constructs a NULL_TREE.
32 DEF_ATTR_INT (ENUM, VALUE)
34 Constructs an INTEGER_CST with value VALUE (an integer representable
37 DEF_ATTR_IDENT (ENUM, STRING)
39 Constructs an IDENTIFIER_NODE for STRING.
41 DEF_ATTR_TREE_LIST (ENUM, PURPOSE, VALUE, CHAIN)
43 Constructs a TREE_LIST with given PURPOSE, VALUE and CHAIN (given
44 as previous ENUM names). */
46 DEF_ATTR_NULL_TREE (ATTR_NULL)
48 /* Construct a tree for a given integer and a list containing it. */
49 #define DEF_ATTR_FOR_INT(VALUE) \
50 DEF_ATTR_INT (ATTR_##VALUE, VALUE) \
51 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE, ATTR_NULL, \
52 ATTR_##VALUE, ATTR_NULL)
60 #undef DEF_ATTR_FOR_INT
62 /* Construct a tree for a list of two integers. */
63 #define DEF_LIST_INT_INT(VALUE1, VALUE2) \
64 DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE1##_##VALUE2, ATTR_NULL, \
65 ATTR_##VALUE1, ATTR_LIST_##VALUE2)
66 DEF_LIST_INT_INT (1,0)
67 DEF_LIST_INT_INT (1,2)
68 DEF_LIST_INT_INT (2,0)
69 DEF_LIST_INT_INT (2,3)
70 DEF_LIST_INT_INT (3,0)
71 DEF_LIST_INT_INT (3,4)
72 DEF_LIST_INT_INT (4,0)
73 DEF_LIST_INT_INT (4,5)
74 DEF_LIST_INT_INT (5,0)
75 DEF_LIST_INT_INT (5,6)
76 #undef DEF_LIST_INT_INT
78 /* Construct trees for identifiers. */
79 DEF_ATTR_IDENT (ATTR_CONST, "const")
80 DEF_ATTR_IDENT (ATTR_FORMAT, "format")
81 DEF_ATTR_IDENT (ATTR_FORMAT_ARG, "format_arg")
82 DEF_ATTR_IDENT (ATTR_MALLOC, "malloc")
83 DEF_ATTR_IDENT (ATTR_NONNULL, "nonnull")
84 DEF_ATTR_IDENT (ATTR_NORETURN, "noreturn")
85 DEF_ATTR_IDENT (ATTR_NOTHROW, "nothrow")
86 DEF_ATTR_IDENT (ATTR_LEAF, "leaf")
87 DEF_ATTR_IDENT (ATTR_PRINTF, "printf")
88 DEF_ATTR_IDENT (ATTR_ASM_FPRINTF, "asm_fprintf")
89 DEF_ATTR_IDENT (ATTR_GCC_DIAG, "gcc_diag")
90 DEF_ATTR_IDENT (ATTR_GCC_CDIAG, "gcc_cdiag")
91 DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG, "gcc_cxxdiag")
92 DEF_ATTR_IDENT (ATTR_PURE, "pure")
93 DEF_ATTR_IDENT (ATTR_NOVOPS, "no vops")
94 DEF_ATTR_IDENT (ATTR_SCANF, "scanf")
95 DEF_ATTR_IDENT (ATTR_SENTINEL, "sentinel")
96 DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon")
97 DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime")
98 DEF_ATTR_IDENT (ATTR_TYPEGENERIC, "type generic")
99 DEF_ATTR_IDENT (ATTR_TM_REGPARM, "*tm regparm")
100 DEF_ATTR_IDENT (ATTR_TM_TMPURE, "transaction_pure")
102 DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL)
104 DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOVOPS_LIST)
106 DEF_ATTR_TREE_LIST (ATTR_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NULL)
108 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL)
110 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_LIST)
112 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST, \
113 ATTR_NULL, ATTR_NOTHROW_LIST)
114 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST, ATTR_CONST, \
115 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
116 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE, \
117 ATTR_NULL, ATTR_NOTHROW_LIST)
118 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST, ATTR_PURE, \
119 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
120 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NOVOPS_LIST, ATTR_NOVOPS, \
121 ATTR_NULL, ATTR_PURE_NOTHROW_LIST)
122 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NOVOPS_LEAF_LIST, ATTR_NOVOPS,\
123 ATTR_NULL, ATTR_PURE_NOTHROW_LEAF_LIST)
124 DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN, \
125 ATTR_NULL, ATTR_NOTHROW_LIST)
126 DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST, ATTR_NORETURN,\
127 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
128 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC, \
129 ATTR_NULL, ATTR_NOTHROW_LIST)
130 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LEAF_LIST, ATTR_MALLOC, \
131 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
132 DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL, \
133 ATTR_NULL, ATTR_NOTHROW_LIST)
134 DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST, ATTR_SENTINEL, \
135 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
137 /* Functions whose pointer parameter(s) are all nonnull. */
138 DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL)
139 /* Functions whose first parameter is a nonnull pointer. */
140 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
141 /* Functions whose second parameter is a nonnull pointer. */
142 DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
143 /* Functions whose third parameter is a nonnull pointer. */
144 DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL)
145 /* Nothrow functions with the sentinel(1) attribute. */
146 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \
148 /* Nothrow functions whose pointer parameter(s) are all nonnull. */
149 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \
151 /* Nothrow leaf functions whose pointer parameter(s) are all nonnull. */
152 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF, ATTR_NONNULL, ATTR_NULL, \
153 ATTR_NOTHROW_LEAF_LIST)
154 /* Nothrow functions whose first parameter is a nonnull pointer. */
155 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \
157 /* Nothrow functions whose second parameter is a nonnull pointer. */
158 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \
160 /* Nothrow functions whose third parameter is a nonnull pointer. */
161 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \
163 /* Nothrow functions whose fourth parameter is a nonnull pointer. */
164 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \
166 /* Nothrow functions whose fifth parameter is a nonnull pointer. */
167 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \
169 /* Nothrow const functions whose pointer parameter(s) are all nonnull. */
170 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \
171 ATTR_NOTHROW_NONNULL)
172 /* Nothrow const leaf functions whose pointer parameter(s) are all nonnull. */
173 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF, ATTR_CONST, ATTR_NULL, \
174 ATTR_NOTHROW_NONNULL_LEAF)
175 /* Nothrow const functions which are type-generic. */
176 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \
177 ATTR_CONST_NOTHROW_LIST)
178 /* Nothrow const leaf functions which are type-generic. */
179 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
180 ATTR_CONST_NOTHROW_LEAF_LIST)
181 /* Nothrow pure functions whose pointer parameter(s) are all nonnull. */
182 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \
183 ATTR_NOTHROW_NONNULL)
184 /* Nothrow pure leaf functions whose pointer parameter(s) are all nonnull. */
185 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF, ATTR_PURE, ATTR_NULL, \
186 ATTR_NOTHROW_NONNULL_LEAF)
187 /* Nothrow malloc functions whose pointer parameter(s) are all nonnull. */
188 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \
189 ATTR_NOTHROW_NONNULL)
190 /* Nothrow malloc leaf functions whose pointer parameter(s) are all nonnull. */
191 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL_LEAF, ATTR_MALLOC, ATTR_NULL, \
192 ATTR_NOTHROW_NONNULL_LEAF)
194 /* Construct a tree for a format attribute. */
195 #define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES) \
196 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
197 ATTR_##TYPE, ATTR_LIST_##VALUES) \
198 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
199 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA)
200 #define DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA, VALUES) \
201 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
202 ATTR_##TYPE, ATTR_LIST_##VALUES) \
203 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
204 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
205 #define DEF_FORMAT_ATTRIBUTE_BOTH(TYPE, FA, VALUES) \
206 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \
207 ATTR_##TYPE, ATTR_LIST_##VALUES) \
208 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \
209 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA) \
210 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
211 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
212 DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
213 DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
214 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_0)
215 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_3)
216 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_0)
217 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_4)
218 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_0)
219 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_5)
220 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_0)
221 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_6)
222 DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
223 DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
224 DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_0)
225 DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_3)
226 DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME,3,3_0)
227 DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON,3,3_4)
228 #undef DEF_FORMAT_ATTRIBUTE
229 #undef DEF_FORMAT_ATTRIBUTE_NOTHROW
230 #undef DEF_FORMAT_ATTRIBUTE_BOTH
232 /* Transactional memory variants of the above. */
234 DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST,
235 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NOTHROW_LIST)
236 DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST,
237 ATTR_TM_TMPURE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
238 DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST,
239 ATTR_PURE, ATTR_NULL, ATTR_TM_TMPURE_NOTHROW_LIST)
240 DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST,
241 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NORETURN_NOTHROW_LIST)
242 DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST,
243 ATTR_TM_REGPARM, ATTR_NULL, ATTR_CONST_NOTHROW_LIST)
245 /* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in. */
246 DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST,
247 ATTR_TM_TMPURE, ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST)
248 /* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in. */
249 DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST,
250 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LIST)
252 /* Construct a tree for a format_arg attribute. */
253 #define DEF_FORMAT_ARG_ATTRIBUTE(FA) \
254 DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG, \
255 ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA)
256 DEF_FORMAT_ARG_ATTRIBUTE(1)
257 DEF_FORMAT_ARG_ATTRIBUTE(2)
258 #undef DEF_FORMAT_ARG_ATTRIBUTE