1/* Copyright (C) 2001-2016 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 functions by default. 22 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. 26 27 DEF_ATTR_NULL_TREE (ENUM) 28 29 Constructs a NULL_TREE. 30 31 DEF_ATTR_INT (ENUM, VALUE) 32 33 Constructs an INTEGER_CST with value VALUE (an integer representable 34 in HOST_WIDE_INT). 35 36 DEF_ATTR_IDENT (ENUM, STRING) 37 38 Constructs an IDENTIFIER_NODE for STRING. 39 40 DEF_ATTR_TREE_LIST (ENUM, PURPOSE, VALUE, CHAIN) 41 42 Constructs a TREE_LIST with given PURPOSE, VALUE and CHAIN (given 43 as previous ENUM names). */ 44 45DEF_ATTR_NULL_TREE (ATTR_NULL) 46 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) 52DEF_ATTR_FOR_INT (0) 53DEF_ATTR_FOR_INT (1) 54DEF_ATTR_FOR_INT (2) 55DEF_ATTR_FOR_INT (3) 56DEF_ATTR_FOR_INT (4) 57DEF_ATTR_FOR_INT (5) 58DEF_ATTR_FOR_INT (6) 59#undef DEF_ATTR_FOR_INT 60 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) 66DEF_ATTR_FOR_STRING (STR1, "1") 67#undef DEF_ATTR_FOR_STRING 68 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) 73DEF_LIST_INT_INT (1,0) 74DEF_LIST_INT_INT (1,2) 75DEF_LIST_INT_INT (2,0) 76DEF_LIST_INT_INT (2,3) 77DEF_LIST_INT_INT (3,0) 78DEF_LIST_INT_INT (3,4) 79DEF_LIST_INT_INT (4,0) 80DEF_LIST_INT_INT (4,5) 81DEF_LIST_INT_INT (5,0) 82DEF_LIST_INT_INT (5,6) 83#undef DEF_LIST_INT_INT 84 85/* Construct trees for identifiers. */ 86DEF_ATTR_IDENT (ATTR_COLD, "cold") 87DEF_ATTR_IDENT (ATTR_CONST, "const") 88DEF_ATTR_IDENT (ATTR_FORMAT, "format") 89DEF_ATTR_IDENT (ATTR_FORMAT_ARG, "format_arg") 90DEF_ATTR_IDENT (ATTR_MALLOC, "malloc") 91DEF_ATTR_IDENT (ATTR_NONNULL, "nonnull") 92DEF_ATTR_IDENT (ATTR_NORETURN, "noreturn") 93DEF_ATTR_IDENT (ATTR_NOTHROW, "nothrow") 94DEF_ATTR_IDENT (ATTR_LEAF, "leaf") 95DEF_ATTR_IDENT (ATTR_FNSPEC, "fn spec") 96DEF_ATTR_IDENT (ATTR_PRINTF, "printf") 97DEF_ATTR_IDENT (ATTR_ASM_FPRINTF, "asm_fprintf") 98DEF_ATTR_IDENT (ATTR_GCC_DIAG, "gcc_diag") 99DEF_ATTR_IDENT (ATTR_GCC_CDIAG, "gcc_cdiag") 100DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG, "gcc_cxxdiag") 101DEF_ATTR_IDENT (ATTR_PURE, "pure") 102DEF_ATTR_IDENT (ATTR_NOVOPS, "no vops") 103DEF_ATTR_IDENT (ATTR_SCANF, "scanf") 104DEF_ATTR_IDENT (ATTR_SENTINEL, "sentinel") 105DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon") 106DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime") 107DEF_ATTR_IDENT (ATTR_TYPEGENERIC, "type generic") 108DEF_ATTR_IDENT (ATTR_TM_REGPARM, "*tm regparm") 109DEF_ATTR_IDENT (ATTR_TM_TMPURE, "transaction_pure") 110DEF_ATTR_IDENT (ATTR_RETURNS_TWICE, "returns_twice") 111 112DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL) 113 114DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOVOPS_LIST) 115 116DEF_ATTR_TREE_LIST (ATTR_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NULL) 117 118DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL) 119 120DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_LIST) 121 122DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST, \ 123 ATTR_NULL, ATTR_NOTHROW_LIST) 124DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST, ATTR_CONST, \ 125 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 126DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE, \ 127 ATTR_NULL, ATTR_NOTHROW_LIST) 128DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST, ATTR_PURE, \ 129 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 130DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN, \ 131 ATTR_NULL, ATTR_NOTHROW_LIST) 132DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST, ATTR_NORETURN,\ 133 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 134DEF_ATTR_TREE_LIST (ATTR_COLD_NOTHROW_LEAF_LIST, ATTR_COLD,\ 135 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 136DEF_ATTR_TREE_LIST (ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST, ATTR_COLD,\ 137 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST) 138DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\ 139 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST) 140DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC, \ 141 ATTR_NULL, ATTR_NOTHROW_LIST) 142DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LEAF_LIST, ATTR_MALLOC, \ 143 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 144DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL, \ 145 ATTR_NULL, ATTR_NOTHROW_LIST) 146DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST, ATTR_SENTINEL, \ 147 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 148DEF_ATTR_TREE_LIST (ATTR_COLD_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\ 149 ATTR_NULL, ATTR_COLD_NORETURN_NOTHROW_LEAF_LIST) 150 151/* Functions whose pointer parameter(s) are all nonnull. */ 152DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL) 153/* Functions whose first parameter is a nonnull pointer. */ 154DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL) 155/* Functions whose second parameter is a nonnull pointer. */ 156DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL) 157/* Functions whose third parameter is a nonnull pointer. */ 158DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL) 159/* Nothrow functions with the sentinel(1) attribute. */ 160DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \ 161 ATTR_NOTHROW_LIST) 162/* Nothrow functions whose pointer parameter(s) are all nonnull. */ 163DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \ 164 ATTR_NOTHROW_LIST) 165/* Nothrow leaf functions whose pointer parameter(s) are all nonnull. */ 166DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF, ATTR_NONNULL, ATTR_NULL, \ 167 ATTR_NOTHROW_LEAF_LIST) 168/* Nothrow functions whose first parameter is a nonnull pointer. */ 169DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \ 170 ATTR_NOTHROW_LIST) 171/* Nothrow functions whose second parameter is a nonnull pointer. */ 172DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \ 173 ATTR_NOTHROW_LIST) 174/* Nothrow functions whose third parameter is a nonnull pointer. */ 175DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \ 176 ATTR_NOTHROW_LIST) 177/* Nothrow functions whose fourth parameter is a nonnull pointer. */ 178DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \ 179 ATTR_NOTHROW_LIST) 180/* Nothrow functions whose fifth parameter is a nonnull pointer. */ 181DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \ 182 ATTR_NOTHROW_LIST) 183/* Nothrow leaf functions which are type-generic. */ 184DEF_ATTR_TREE_LIST (ATTR_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \ 185 ATTR_NOTHROW_LEAF_LIST) 186/* Nothrow const functions whose pointer parameter(s) are all nonnull. */ 187DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \ 188 ATTR_NOTHROW_NONNULL) 189/* Nothrow leaf functions whose pointer parameter(s) are all nonnull, 190 and which return their first argument. */ 191DEF_ATTR_TREE_LIST (ATTR_RET1_NOTHROW_NONNULL_LEAF, ATTR_FNSPEC, ATTR_LIST_STR1, \ 192 ATTR_NOTHROW_NONNULL_LEAF) 193/* Nothrow const leaf functions whose pointer parameter(s) are all nonnull. */ 194DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF, ATTR_CONST, ATTR_NULL, \ 195 ATTR_NOTHROW_NONNULL_LEAF) 196/* Nothrow const functions which are type-generic. */ 197DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \ 198 ATTR_CONST_NOTHROW_LIST) 199/* Nothrow const leaf functions which are type-generic. */ 200DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \ 201 ATTR_CONST_NOTHROW_LEAF_LIST) 202/* Nothrow pure functions whose pointer parameter(s) are all nonnull. */ 203DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \ 204 ATTR_NOTHROW_NONNULL) 205/* Nothrow pure leaf functions whose pointer parameter(s) are all nonnull. */ 206DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF, ATTR_PURE, ATTR_NULL, \ 207 ATTR_NOTHROW_NONNULL_LEAF) 208/* Nothrow malloc functions whose pointer parameter(s) are all nonnull. */ 209DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \ 210 ATTR_NOTHROW_NONNULL) 211/* Nothrow malloc leaf functions whose pointer parameter(s) are all nonnull. */ 212DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL_LEAF, ATTR_MALLOC, ATTR_NULL, \ 213 ATTR_NOTHROW_NONNULL_LEAF) 214 215/* Construct a tree for a format attribute. */ 216#define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES) \ 217 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \ 218 ATTR_##TYPE, ATTR_LIST_##VALUES) \ 219 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \ 220 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA) 221#define DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA, VALUES) \ 222 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \ 223 ATTR_##TYPE, ATTR_LIST_##VALUES) \ 224 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\ 225 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA) 226#define DEF_FORMAT_ATTRIBUTE_BOTH(TYPE, FA, VALUES) \ 227 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \ 228 ATTR_##TYPE, ATTR_LIST_##VALUES) \ 229 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \ 230 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA) \ 231 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\ 232 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA) 233DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0) 234DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2) 235DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_0) 236DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_3) 237DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_0) 238DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_4) 239DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_0) 240DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_5) 241DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_0) 242DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_6) 243DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0) 244DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2) 245DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_0) 246DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_3) 247DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME,3,3_0) 248DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON,3,3_4) 249#undef DEF_FORMAT_ATTRIBUTE 250#undef DEF_FORMAT_ATTRIBUTE_NOTHROW 251#undef DEF_FORMAT_ATTRIBUTE_BOTH 252 253/* Transactional memory variants of the above. */ 254 255DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST, 256 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NOTHROW_LIST) 257DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST, 258 ATTR_TM_TMPURE, ATTR_NULL, ATTR_TM_NOTHROW_LIST) 259DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST, 260 ATTR_PURE, ATTR_NULL, ATTR_TM_TMPURE_NOTHROW_LIST) 261DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST, 262 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NORETURN_NOTHROW_LIST) 263DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST, 264 ATTR_TM_REGPARM, ATTR_NULL, ATTR_CONST_NOTHROW_LIST) 265DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_RT_LIST, 266 ATTR_RETURNS_TWICE, ATTR_NULL, ATTR_TM_NOTHROW_LIST) 267 268/* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in. */ 269DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST, 270 ATTR_TM_TMPURE, ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST) 271/* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in. */ 272DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST, 273 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LIST) 274 275DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LEAF_LIST, 276 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 277DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST, 278 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST) 279 280/* Construct a tree for a format_arg attribute. */ 281#define DEF_FORMAT_ARG_ATTRIBUTE(FA) \ 282 DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG, \ 283 ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA) 284DEF_FORMAT_ARG_ATTRIBUTE(1) 285DEF_FORMAT_ARG_ATTRIBUTE(2) 286#undef DEF_FORMAT_ARG_ATTRIBUTE 287 288