gcc/builtin-attrs.def

   1 /* Copyright (C) 2001, 2002, 2004, 2005, 2007, 2010
   2    Free Software Foundation, Inc.
   3    Contributed by Joseph Myers <jsm28@cam.ac.uk>.
   4
   5 This file is part of GCC.
   6
   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
  10 version.
  11
  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
  15 for more details.
  16
  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/>.  */
  20
  21 /* This header provides a declarative way of describing the attributes
  22    that are applied to some functions by default.
  23
  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.
  27
  28    DEF_ATTR_NULL_TREE (ENUM)
  29
  30      Constructs a NULL_TREE.
  31
  32    DEF_ATTR_INT (ENUM, VALUE)
  33
  34      Constructs an INTEGER_CST with value VALUE (an integer representable
  35      in HOST_WIDE_INT).
  36
  37    DEF_ATTR_IDENT (ENUM, STRING)
  38
  39      Constructs an IDENTIFIER_NODE for STRING.
  40
  41    DEF_ATTR_TREE_LIST (ENUM, PURPOSE, VALUE, CHAIN)
  42
  43      Constructs a TREE_LIST with given PURPOSE, VALUE and CHAIN (given
  44      as previous ENUM names).  */
  45
  46 DEF_ATTR_NULL_TREE (ATTR_NULL)
  47
  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)
  53 DEF_ATTR_FOR_INT (0)
  54 DEF_ATTR_FOR_INT (1)
  55 DEF_ATTR_FOR_INT (2)
  56 DEF_ATTR_FOR_INT (3)
  57 DEF_ATTR_FOR_INT (4)
  58 DEF_ATTR_FOR_INT (5)
  59 DEF_ATTR_FOR_INT (6)
  60 #undef DEF_ATTR_FOR_INT
  61
  62 /* Construct a tree for a given string and a list containing it.  */
  63 #define DEF_ATTR_FOR_STRING(ENUM, VALUE)                                        \
  64   DEF_ATTR_STRING (ATTR_##ENUM, VALUE)                  \
  65   DEF_ATTR_TREE_LIST (ATTR_LIST_##ENUM, ATTR_NULL,      \
  66                       ATTR_##ENUM, ATTR_NULL)
  67 DEF_ATTR_FOR_STRING (STR1, "1")
  68 #undef DEF_ATTR_FOR_STRING
  69
  70 /* Construct a tree for a list of two integers.  */
  71 #define DEF_LIST_INT_INT(VALUE1, VALUE2)                                 \
  72   DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE1##_##VALUE2, ATTR_NULL,          \
  73                       ATTR_##VALUE1, ATTR_LIST_##VALUE2)
  74 DEF_LIST_INT_INT (1,0)
  75 DEF_LIST_INT_INT (1,2)
  76 DEF_LIST_INT_INT (2,0)
  77 DEF_LIST_INT_INT (2,3)
  78 DEF_LIST_INT_INT (3,0)
  79 DEF_LIST_INT_INT (3,4)
  80 DEF_LIST_INT_INT (4,0)
  81 DEF_LIST_INT_INT (4,5)
  82 DEF_LIST_INT_INT (5,0)
  83 DEF_LIST_INT_INT (5,6)
  84 #undef DEF_LIST_INT_INT
  85
  86 /* Construct trees for identifiers.  */
  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
 112 DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL)
 113
 114 DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOVOPS_LIST)
 115
 116 DEF_ATTR_TREE_LIST (ATTR_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NULL)
 117
 118 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL)
 119
 120 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LEAF_LIST, ATTR_LEAF, ATTR_NULL, ATTR_NOTHROW_LIST)
 121
 122 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST,        \
 123                         ATTR_NULL, ATTR_NOTHROW_LIST)
 124 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LEAF_LIST, ATTR_CONST,   \
 125                         ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
 126 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE,          \
 127                         ATTR_NULL, ATTR_NOTHROW_LIST)
 128 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LEAF_LIST, ATTR_PURE,     \
 129                         ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
 130 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NOVOPS_LIST, ATTR_NOVOPS, \
 131                         ATTR_NULL, ATTR_PURE_NOTHROW_LIST)
 132 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NOVOPS_LEAF_LIST, ATTR_NOVOPS,\
 133                         ATTR_NULL, ATTR_PURE_NOTHROW_LEAF_LIST)
 134 DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN,  \
 135                         ATTR_NULL, ATTR_NOTHROW_LIST)
 136 DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LEAF_LIST, ATTR_NORETURN,\
 137                         ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
 138 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC,      \
 139                         ATTR_NULL, ATTR_NOTHROW_LIST)
 140 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LEAF_LIST, ATTR_MALLOC, \
 141                         ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
 142 DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL,  \
 143                         ATTR_NULL, ATTR_NOTHROW_LIST)
 144 DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LEAF_LIST, ATTR_SENTINEL,     \
 145                         ATTR_NULL, ATTR_NOTHROW_LEAF_LIST)
 146
 147 /* Functions whose pointer parameter(s) are all nonnull.  */
 148 DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL)
 149 /* Functions whose first parameter is a nonnull pointer.  */
 150 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
 151 /* Functions whose second parameter is a nonnull pointer.  */
 152 DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
 153 /* Functions whose third parameter is a nonnull pointer.  */
 154 DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL)
 155 /* Nothrow functions with the sentinel(1) attribute. */
 156 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \
 157                         ATTR_NOTHROW_LIST)
 158 /* Nothrow functions whose pointer parameter(s) are all nonnull.  */
 159 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \
 160                         ATTR_NOTHROW_LIST)
 161 /* Nothrow leaf functions whose pointer parameter(s) are all nonnull.  */
 162 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_LEAF, ATTR_NONNULL, ATTR_NULL, \
 163                         ATTR_NOTHROW_LEAF_LIST)
 164 /* Nothrow functions whose first parameter is a nonnull pointer.  */
 165 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \
 166                         ATTR_NOTHROW_LIST)
 167 /* Nothrow functions whose second parameter is a nonnull pointer.  */
 168 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \
 169                         ATTR_NOTHROW_LIST)
 170 /* Nothrow functions whose third parameter is a nonnull pointer.  */
 171 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \
 172                         ATTR_NOTHROW_LIST)
 173 /* Nothrow functions whose fourth parameter is a nonnull pointer.  */
 174 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \
 175                         ATTR_NOTHROW_LIST)
 176 /* Nothrow functions whose fifth parameter is a nonnull pointer.  */
 177 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \
 178                         ATTR_NOTHROW_LIST)
 179 /* Nothrow const functions whose pointer parameter(s) are all nonnull.  */
 180 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \
 181                         ATTR_NOTHROW_NONNULL)
 182 /* Nothrow leaf functions whose pointer parameter(s) are all nonnull,
 183    and which return their first argument.  */
 184 DEF_ATTR_TREE_LIST (ATTR_RET1_NOTHROW_NONNULL_LEAF, ATTR_FNSPEC, ATTR_LIST_STR1, \
 185                         ATTR_NOTHROW_NONNULL_LEAF)
 186 /* Nothrow const leaf functions whose pointer parameter(s) are all nonnull.  */
 187 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL_LEAF, ATTR_CONST, ATTR_NULL, \
 188                         ATTR_NOTHROW_NONNULL_LEAF)
 189 /* Nothrow const functions which are type-generic.  */
 190 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \
 191                         ATTR_CONST_NOTHROW_LIST)
 192 /* Nothrow const leaf functions which are type-generic.  */
 193 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC_LEAF, ATTR_TYPEGENERIC, ATTR_NULL, \
 194                         ATTR_CONST_NOTHROW_LEAF_LIST)
 195 /* Nothrow pure functions whose pointer parameter(s) are all nonnull.  */
 196 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \
 197                         ATTR_NOTHROW_NONNULL)
 198 /* Nothrow pure leaf functions whose pointer parameter(s) are all nonnull.  */
 199 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL_LEAF, ATTR_PURE, ATTR_NULL, \
 200                         ATTR_NOTHROW_NONNULL_LEAF)
 201 /* Nothrow malloc functions whose pointer parameter(s) are all nonnull.  */
 202 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \
 203                         ATTR_NOTHROW_NONNULL)
 204 /* Nothrow malloc leaf functions whose pointer parameter(s) are all nonnull.  */
 205 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL_LEAF, ATTR_MALLOC, ATTR_NULL, \
 206                         ATTR_NOTHROW_NONNULL_LEAF)
 207
 208 /* Construct a tree for a format attribute.  */
 209 #define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES)                           \
 210   DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL,                 \
 211                       ATTR_##TYPE, ATTR_LIST_##VALUES)                   \
 212   DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT,        \
 213                       ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA)
 214 #define DEF_FORMAT_ATTRIBUTE_NOTHROW(TYPE, FA, VALUES)                   \
 215   DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL,                 \
 216                       ATTR_##TYPE, ATTR_LIST_##VALUES)                   \
 217   DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
 218                       ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
 219 #define DEF_FORMAT_ATTRIBUTE_BOTH(TYPE, FA, VALUES)                      \
 220   DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL,                 \
 221                       ATTR_##TYPE, ATTR_LIST_##VALUES)                   \
 222   DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT,        \
 223                       ATTR_##TYPE##_##VALUES, ATTR_NONNULL_##FA)         \
 224   DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_NOTHROW_##VALUES, ATTR_FORMAT,\
 225                       ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
 226 DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
 227 DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
 228 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_0)
 229 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,2,2_3)
 230 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_0)
 231 DEF_FORMAT_ATTRIBUTE_BOTH(PRINTF,3,3_4)
 232 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_0)
 233 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,4,4_5)
 234 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_0)
 235 DEF_FORMAT_ATTRIBUTE_NOTHROW(PRINTF,5,5_6)
 236 DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
 237 DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
 238 DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_0)
 239 DEF_FORMAT_ATTRIBUTE_BOTH(SCANF,2,2_3)
 240 DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFTIME,3,3_0)
 241 DEF_FORMAT_ATTRIBUTE_NOTHROW(STRFMON,3,3_4)
 242 #undef DEF_FORMAT_ATTRIBUTE
 243 #undef DEF_FORMAT_ATTRIBUTE_NOTHROW
 244 #undef DEF_FORMAT_ATTRIBUTE_BOTH
 245
 246 /* Transactional memory variants of the above.  */
 247
 248 DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_LIST,
 249                     ATTR_TM_REGPARM, ATTR_NULL, ATTR_NOTHROW_LIST)
 250 DEF_ATTR_TREE_LIST (ATTR_TM_TMPURE_NOTHROW_LIST,
 251                     ATTR_TM_TMPURE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
 252 DEF_ATTR_TREE_LIST (ATTR_TM_PURE_TMPURE_NOTHROW_LIST,
 253                     ATTR_PURE, ATTR_NULL, ATTR_TM_TMPURE_NOTHROW_LIST)
 254 DEF_ATTR_TREE_LIST (ATTR_TM_NORETURN_NOTHROW_LIST,
 255                     ATTR_TM_REGPARM, ATTR_NULL, ATTR_NORETURN_NOTHROW_LIST)
 256 DEF_ATTR_TREE_LIST (ATTR_TM_CONST_NOTHROW_LIST,
 257                     ATTR_TM_REGPARM, ATTR_NULL, ATTR_CONST_NOTHROW_LIST)
 258 DEF_ATTR_TREE_LIST (ATTR_TM_NOTHROW_RT_LIST,
 259                     ATTR_RETURNS_TWICE, ATTR_NULL, ATTR_TM_NOTHROW_LIST)
 260
 261 /* Same attributes used for BUILT_IN_MALLOC except with TM_PURE thrown in.  */
 262 DEF_ATTR_TREE_LIST (ATTR_TMPURE_MALLOC_NOTHROW_LIST,
 263                    ATTR_TM_TMPURE, ATTR_NULL, ATTR_MALLOC_NOTHROW_LIST)
 264 /* Same attributes used for BUILT_IN_FREE except with TM_PURE thrown in.  */
 265 DEF_ATTR_TREE_LIST (ATTR_TMPURE_NOTHROW_LIST,
 266                    ATTR_TM_TMPURE, ATTR_NULL, ATTR_NOTHROW_LIST)
 267
 268 /* Construct a tree for a format_arg attribute.  */
 269 #define DEF_FORMAT_ARG_ATTRIBUTE(FA)                                    \
 270   DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG,            \
 271                       ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA)
 272 DEF_FORMAT_ARG_ATTRIBUTE(1)
 273 DEF_FORMAT_ARG_ATTRIBUTE(2)
 274 #undef DEF_FORMAT_ARG_ATTRIBUTE
 275