1/* Copyright (C) 2001-2013 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_CONST, "const") 87DEF_ATTR_IDENT (ATTR_FORMAT, "format") 88DEF_ATTR_IDENT (ATTR_FORMAT_ARG, "format_arg") 89DEF_ATTR_IDENT (ATTR_MALLOC, "malloc") 90DEF_ATTR_IDENT (ATTR_NONNULL, "nonnull") 91DEF_ATTR_IDENT (ATTR_NORETURN, "noreturn") 92DEF_ATTR_IDENT (ATTR_NOTHROW, "nothrow") 93DEF_ATTR_IDENT (ATTR_LEAF, "leaf") 94DEF_ATTR_IDENT (ATTR_FNSPEC, "fn spec") 95DEF_ATTR_IDENT (ATTR_PRINTF, "printf") 96DEF_ATTR_IDENT (ATTR_ASM_FPRINTF, "asm_fprintf") 97DEF_ATTR_IDENT (ATTR_GCC_DIAG, "gcc_diag") 98DEF_ATTR_IDENT (ATTR_GCC_CDIAG, "gcc_cdiag") 99DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG, "gcc_cxxdiag") 100DEF_ATTR_IDENT (ATTR_PURE, "pure") 101DEF_ATTR_IDENT (ATTR_NOVOPS, "no vops") 102DEF_ATTR_IDENT (ATTR_SCANF, "scanf") 103DEF_ATTR_IDENT (ATTR_SENTINEL, "sentinel") 104DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon") 105DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime") 106DEF_ATTR_IDENT (ATTR_TYPEGENERIC, "type generic") 107DEF_ATTR_IDENT (ATTR_TM_REGPARM, "*tm regparm") 108DEF_ATTR_IDENT (ATTR_TM_TMPURE, "transaction_pure") 109DEF_ATTR_IDENT (ATTR_RETURNS_TWICE, "returns_twice") 110 111DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL) 112 113DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOVOPS_LIST) 114 115DEF_ATTR_TREE_LIST (ATTR_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NULL) 116 117DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL) 118 119DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_LIST) 120 121DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST, \ 122 ATTR_NULL, ATTR_NOTHROW_LIST) 123DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST, ATTR_CONST, \ 124 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 125DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE, \ 126 ATTR_NULL, ATTR_NOTHROW_LIST) 127DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST, ATTR_PURE, \ 128 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 129DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN, \ 130 ATTR_NULL, ATTR_NOTHROW_LIST) 131DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST, ATTR_NORETURN,\ 132 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 133DEF_ATTR_TREE_LIST (ATTR_CONST_NORETURN_NOTHROW_LEAF_LIST, ATTR_CONST,\ 134 ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST) 135DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC, \ 136 ATTR_NULL, ATTR_NOTHROW_LIST) 137DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LEAF_LIST, ATTR_MALLOC, \ 138 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 139DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL, \ 140 ATTR_NULL, ATTR_NOTHROW_LIST) 141DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST, ATTR_SENTINEL, \ 142 ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 143 144/* Functions whose pointer parameter(s) are all nonnull. */ 145DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL) 146/* Functions whose first parameter is a nonnull pointer. */ 147DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL) 148/* Functions whose second parameter is a nonnull pointer. */ 149DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL) 150/* Functions whose third parameter is a nonnull pointer. */ 151DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL) 152/* Nothrow functions with the sentinel(1) attribute. */ 153DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \ 154 ATTR_NOTHROW_LIST) 155/* Nothrow functions whose pointer parameter(s) are all nonnull. */ 156DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \ 157 ATTR_NOTHROW_LIST) 158/* Nothrow leaf functions whose pointer parameter(s) are all nonnull. */ 159DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF, ATTR_NONNULL, ATTR_NULL, \ 160 ATTR_NOTHROW_LEAF_LIST) 161/* Nothrow functions whose first parameter is a nonnull pointer. */ 162DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \ 163 ATTR_NOTHROW_LIST) 164/* Nothrow functions whose second parameter is a nonnull pointer. */ 165DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \ 166 ATTR_NOTHROW_LIST) 167/* Nothrow functions whose third parameter is a nonnull pointer. */ 168DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \ 169 ATTR_NOTHROW_LIST) 170/* Nothrow functions whose fourth parameter is a nonnull pointer. */ 171DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \ 172 ATTR_NOTHROW_LIST) 173/* Nothrow functions whose fifth parameter is a nonnull pointer. */ 174DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \ 175 ATTR_NOTHROW_LIST) 176/* Nothrow const functions whose pointer parameter(s) are all nonnull. */ 177DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \ 178 ATTR_NOTHROW_NONNULL) 179/* Nothrow leaf functions whose pointer parameter(s) are all nonnull, 180 and which return their first argument. */ 181DEF_ATTR_TREE_LIST (ATTR_RET1_NOTHROW_NONNULL_LEAF, ATTR_FNSPEC, ATTR_LIST_STR1, \ 182 ATTR_NOTHROW_NONNULL_LEAF) 183/* Nothrow const leaf functions whose pointer parameter(s) are all nonnull. */ 184DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF, ATTR_CONST, ATTR_NULL, \ 185 ATTR_NOTHROW_NONNULL_LEAF) 186/* Nothrow const functions which are type-generic. */ 187DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \ 188 ATTR_CONST_NOTHROW_LIST) 189/* Nothrow const leaf functions which are type-generic. */ 190DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \ 191 ATTR_CONST_NOTHROW_LEAF_LIST) 192/* Nothrow pure functions whose pointer parameter(s) are all nonnull. */ 193DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \ 194 ATTR_NOTHROW_NONNULL) 195/* Nothrow pure leaf functions whose pointer parameter(s) are all nonnull. */ 196DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF, ATTR_PURE, ATTR_NULL, \ 197 ATTR_NOTHROW_NONNULL_LEAF) 198/* Nothrow malloc functions whose pointer parameter(s) are all nonnull. */ 199DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \ 200 ATTR_NOTHROW_NONNULL) 201/* Nothrow malloc leaf functions whose pointer parameter(s) are all nonnull. */ 202DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL_LEAF, ATTR_MALLOC, ATTR_NULL, \ 203 ATTR_NOTHROW_NONNULL_LEAF) 204 205/* Construct a tree for a format attribute. */ 206#define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES) \ 207 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \ 208 ATTR_##TYPE, ATTR_LIST_##VALUES) \ 209 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT, \ 210 ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA) 211#define DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA, VALUES) \ 212 DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL, \ 213 ATTR_##TYPE, ATTR_LIST_##VALUES) \ 214 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\ 215 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA) 216#define DEF_FORMAT_ATTRIBUTE_BOTH(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 DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\ 222 ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA) 223DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0) 224DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2) 225DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_0) 226DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_3) 227DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_0) 228DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_4) 229DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_0) 230DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_5) 231DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_0) 232DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_6) 233DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0) 234DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2) 235DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_0) 236DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_3) 237DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME,3,3_0) 238DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON,3,3_4) 239#undef DEF_FORMAT_ATTRIBUTE 240#undef DEF_FORMAT_ATTRIBUTE_NOTHROW 241#undef DEF_FORMAT_ATTRIBUTE_BOTH 242 243/* Transactional memory variants of the above. */ 244 245DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST, 246 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NOTHROW_LIST) 247DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST, 248 ATTR_TM_TMPURE, ATTR_NULL, ATTR_TM_NOTHROW_LIST) 249DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST, 250 ATTR_PURE, ATTR_NULL, ATTR_TM_TMPURE_NOTHROW_LIST) 251DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST, 252 ATTR_TM_REGPARM, ATTR_NULL, ATTR_NORETURN_NOTHROW_LIST) 253DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST, 254 ATTR_TM_REGPARM, ATTR_NULL, ATTR_CONST_NOTHROW_LIST) 255DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_RT_LIST, 256 ATTR_RETURNS_TWICE, ATTR_NULL, ATTR_TM_NOTHROW_LIST) 257 258/* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in. */ 259DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST, 260 ATTR_TM_TMPURE, ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST) 261/* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in. */ 262DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST, 263 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LIST) 264 265DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LEAF_LIST, 266 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LEAF_LIST) 267DEF_ATTR_TREE_LIST (ATTR_TMPURE_NORETURN_NOTHROW_LEAF_LIST, 268 ATTR_TM_TMPURE, ATTR_NULL, ATTR_NORETURN_NOTHROW_LEAF_LIST) 269 270/* Construct a tree for a format_arg attribute. */ 271#define DEF_FORMAT_ARG_ATTRIBUTE(FA) \ 272 DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG, \ 273 ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA) 274DEF_FORMAT_ARG_ATTRIBUTE(1) 275DEF_FORMAT_ARG_ATTRIBUTE(2) 276#undef DEF_FORMAT_ARG_ATTRIBUTE 277 278