gcc/builtin-attrs.def

   1 /* Copyright (C) 2001, 2002, 2004, 2005 Free Software Foundation, Inc.
   2    Contributed by Joseph Myers <jsm28@cam.ac.uk>.
   3
   4 This file is part of GCC.
   5
   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 2, or (at your option) any later
   9 version.
  10
  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
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING.  If not, write to the Free
  18 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301, USA.  */
  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 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
  77
  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_PRINTF, "printf")
  87 DEF_ATTR_IDENT (ATTR_ASM_FPRINTF, "asm_fprintf")
  88 DEF_ATTR_IDENT (ATTR_GCC_DIAG, "gcc_diag")
  89 DEF_ATTR_IDENT (ATTR_GCC_CDIAG, "gcc_cdiag")
  90 DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG, "gcc_cxxdiag")
  91 DEF_ATTR_IDENT (ATTR_PURE, "pure")
  92 DEF_ATTR_IDENT (ATTR_NOVOPS, "no vops")
  93 DEF_ATTR_IDENT (ATTR_SCANF, "scanf")
  94 DEF_ATTR_IDENT (ATTR_SENTINEL, "sentinel")
  95 DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon")
  96 DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime")
  97 DEF_ATTR_IDENT (ATTR_TYPEGENERIC, "type generic")
  98
  99 DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL)
 100
 101 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL)
 102
 103 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST,        \
 104                         ATTR_NULL, ATTR_NOTHROW_LIST)
 105 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE,          \
 106                         ATTR_NULL, ATTR_NOTHROW_LIST)
 107 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NOVOPS_LIST, ATTR_NOVOPS, \
 108                         ATTR_NULL, ATTR_PURE_NOTHROW_LIST)
 109 DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN,  \
 110                         ATTR_NULL, ATTR_NOTHROW_LIST)
 111 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC,      \
 112                         ATTR_NULL, ATTR_NOTHROW_LIST)
 113 DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL,  \
 114                         ATTR_NULL, ATTR_NOTHROW_LIST)
 115
 116 /* Functions whose pointer parameter(s) are all nonnull.  */
 117 DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL)
 118 /* Functions whose first parameter is a nonnull pointer.  */
 119 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
 120 /* Functions whose second parameter is a nonnull pointer.  */
 121 DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
 122 /* Nothrow functions with the sentinel(1) attribute. */
 123 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \
 124                         ATTR_NOTHROW_LIST)
 125 /* Nothrow functions whose pointer parameter(s) are all nonnull.  */
 126 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \
 127                         ATTR_NOTHROW_LIST)
 128 /* Nothrow functions whose first parameter is a nonnull pointer.  */
 129 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \
 130                         ATTR_NOTHROW_LIST)
 131 /* Nothrow functions whose second parameter is a nonnull pointer.  */
 132 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \
 133                         ATTR_NOTHROW_LIST)
 134 /* Nothrow functions whose third parameter is a nonnull pointer.  */
 135 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \
 136                         ATTR_NOTHROW_LIST)
 137 /* Nothrow functions whose fourth parameter is a nonnull pointer.  */
 138 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \
 139                         ATTR_NOTHROW_LIST)
 140 /* Nothrow functions whose fifth parameter is a nonnull pointer.  */
 141 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \
 142                         ATTR_NOTHROW_LIST)
 143 /* Nothrow const functions whose pointer parameter(s) are all nonnull.  */
 144 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \
 145                         ATTR_NOTHROW_NONNULL)
 146 /* Nothrow const functions which are type-generic.  */
 147 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_TYPEGENERIC, ATTR_TYPEGENERIC, ATTR_NULL, \
 148                         ATTR_CONST_NOTHROW_LIST)
 149 /* Nothrow pure functions whose pointer parameter(s) are all nonnull.  */
 150 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \
 151                         ATTR_NOTHROW_NONNULL)
 152 /* Nothrow malloc functions whose pointer parameter(s) are all nonnull.  */
 153 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \
 154                         ATTR_NOTHROW_NONNULL)
 155
 156 /* Construct a tree for a format attribute.  */
 157 #define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES)                           \
 158   DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL,                 \
 159                       ATTR_##TYPE, ATTR_LIST_##VALUES)                   \
 160   DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT,        \
 161                       ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
 162 DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
 163 DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
 164 DEF_FORMAT_ATTRIBUTE(PRINTF,2,2_0)
 165 DEF_FORMAT_ATTRIBUTE(PRINTF,2,2_3)
 166 DEF_FORMAT_ATTRIBUTE(PRINTF,3,3_0)
 167 DEF_FORMAT_ATTRIBUTE(PRINTF,3,3_4)
 168 DEF_FORMAT_ATTRIBUTE(PRINTF,4,4_0)
 169 DEF_FORMAT_ATTRIBUTE(PRINTF,4,4_5)
 170 DEF_FORMAT_ATTRIBUTE(PRINTF,5,5_0)
 171 DEF_FORMAT_ATTRIBUTE(PRINTF,5,5_6)
 172 DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
 173 DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
 174 DEF_FORMAT_ATTRIBUTE(SCANF,2,2_0)
 175 DEF_FORMAT_ATTRIBUTE(SCANF,2,2_3)
 176 DEF_FORMAT_ATTRIBUTE(STRFTIME,3,3_0)
 177 DEF_FORMAT_ATTRIBUTE(STRFMON,3,3_4)
 178 #undef DEF_FORMAT_ATTRIBUTE
 179
 180 /* Construct a tree for a format_arg attribute.  */
 181 #define DEF_FORMAT_ARG_ATTRIBUTE(FA)                                    \
 182   DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG,            \
 183                       ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA)
 184 DEF_FORMAT_ARG_ATTRIBUTE(1)
 185 DEF_FORMAT_ARG_ATTRIBUTE(2)
 186 #undef DEF_FORMAT_ARG_ATTRIBUTE
 187