gcc/builtin-attrs.def

   1 /* Copyright (C) 2001, 2002, 2004, 2005, 2007 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 3, 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 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
  45 DEF_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)
  52 DEF_ATTR_FOR_INT (0)
  53 DEF_ATTR_FOR_INT (1)
  54 DEF_ATTR_FOR_INT (2)
  55 DEF_ATTR_FOR_INT (3)
  56 DEF_ATTR_FOR_INT (4)
  57 DEF_ATTR_FOR_INT (5)
  58 DEF_ATTR_FOR_INT (6)
  59 #undef DEF_ATTR_FOR_INT
  60
  61 /* Construct a tree for a list of two integers.  */
  62 #define DEF_LIST_INT_INT(VALUE1, VALUE2)                                 \
  63   DEF_ATTR_TREE_LIST (ATTR_LIST_##VALUE1##_##VALUE2, ATTR_NULL,          \
  64                       ATTR_##VALUE1, ATTR_LIST_##VALUE2)
  65 DEF_LIST_INT_INT (1,0)
  66 DEF_LIST_INT_INT (1,2)
  67 DEF_LIST_INT_INT (2,0)
  68 DEF_LIST_INT_INT (2,3)
  69 DEF_LIST_INT_INT (3,0)
  70 DEF_LIST_INT_INT (3,4)
  71 DEF_LIST_INT_INT (4,0)
  72 DEF_LIST_INT_INT (4,5)
  73 DEF_LIST_INT_INT (5,0)
  74 DEF_LIST_INT_INT (5,6)
  75 #undef DEF_LIST_INT_INT
  76
  77 /* Construct trees for identifiers.  */
  78 DEF_ATTR_IDENT (ATTR_CONST, "const")
  79 DEF_ATTR_IDENT (ATTR_FORMAT, "format")
  80 DEF_ATTR_IDENT (ATTR_FORMAT_ARG, "format_arg")
  81 DEF_ATTR_IDENT (ATTR_MALLOC, "malloc")
  82 DEF_ATTR_IDENT (ATTR_NONNULL, "nonnull")
  83 DEF_ATTR_IDENT (ATTR_NORETURN, "noreturn")
  84 DEF_ATTR_IDENT (ATTR_NOTHROW, "nothrow")
  85 DEF_ATTR_IDENT (ATTR_PRINTF, "printf")
  86 DEF_ATTR_IDENT (ATTR_ASM_FPRINTF, "asm_fprintf")
  87 DEF_ATTR_IDENT (ATTR_GCC_DIAG, "gcc_diag")
  88 DEF_ATTR_IDENT (ATTR_GCC_CDIAG, "gcc_cdiag")
  89 DEF_ATTR_IDENT (ATTR_GCC_CXXDIAG, "gcc_cxxdiag")
  90 DEF_ATTR_IDENT (ATTR_PURE, "pure")
  91 DEF_ATTR_IDENT (ATTR_NOVOPS, "no vops")
  92 DEF_ATTR_IDENT (ATTR_SCANF, "scanf")
  93 DEF_ATTR_IDENT (ATTR_SENTINEL, "sentinel")
  94 DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon")
  95 DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime")
  96
  97 DEF_ATTR_TREE_LIST (ATTR_NOVOPS_LIST, ATTR_NOVOPS, ATTR_NULL, ATTR_NULL)
  98
  99 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_LIST, ATTR_NOTHROW, ATTR_NULL, ATTR_NULL)
 100
 101 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_LIST, ATTR_CONST,        \
 102                         ATTR_NULL, ATTR_NOTHROW_LIST)
 103 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_LIST, ATTR_PURE,          \
 104                         ATTR_NULL, ATTR_NOTHROW_LIST)
 105 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NOVOPS_LIST, ATTR_NOVOPS, \
 106                         ATTR_NULL, ATTR_PURE_NOTHROW_LIST)
 107 DEF_ATTR_TREE_LIST (ATTR_NORETURN_NOTHROW_LIST, ATTR_NORETURN,  \
 108                         ATTR_NULL, ATTR_NOTHROW_LIST)
 109 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_LIST, ATTR_MALLOC,      \
 110                         ATTR_NULL, ATTR_NOTHROW_LIST)
 111 DEF_ATTR_TREE_LIST (ATTR_SENTINEL_NOTHROW_LIST, ATTR_SENTINEL,  \
 112                         ATTR_NULL, ATTR_NOTHROW_LIST)
 113
 114 /* Functions whose pointer parameter(s) are all nonnull.  */
 115 DEF_ATTR_TREE_LIST (ATTR_NONNULL_LIST, ATTR_NONNULL, ATTR_NULL, ATTR_NULL)
 116 /* Functions whose first parameter is a nonnull pointer.  */
 117 DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
 118 /* Functions whose second parameter is a nonnull pointer.  */
 119 DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
 120 /* Nothrow functions with the sentinel(1) attribute. */
 121 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_SENTINEL_1, ATTR_SENTINEL, ATTR_LIST_1, \
 122                         ATTR_NOTHROW_LIST)
 123 /* Nothrow functions whose pointer parameter(s) are all nonnull.  */
 124 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL, ATTR_NONNULL, ATTR_NULL, \
 125                         ATTR_NOTHROW_LIST)
 126 /* Nothrow functions whose first parameter is a nonnull pointer.  */
 127 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, \
 128                         ATTR_NOTHROW_LIST)
 129 /* Nothrow functions whose second parameter is a nonnull pointer.  */
 130 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, \
 131                         ATTR_NOTHROW_LIST)
 132 /* Nothrow functions whose third parameter is a nonnull pointer.  */
 133 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, \
 134                         ATTR_NOTHROW_LIST)
 135 /* Nothrow functions whose fourth parameter is a nonnull pointer.  */
 136 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_4, ATTR_NONNULL, ATTR_LIST_4, \
 137                         ATTR_NOTHROW_LIST)
 138 /* Nothrow functions whose fifth parameter is a nonnull pointer.  */
 139 DEF_ATTR_TREE_LIST (ATTR_NOTHROW_NONNULL_5, ATTR_NONNULL, ATTR_LIST_5, \
 140                         ATTR_NOTHROW_LIST)
 141 /* Nothrow const functions whose pointer parameter(s) are all nonnull.  */
 142 DEF_ATTR_TREE_LIST (ATTR_CONST_NOTHROW_NONNULL, ATTR_CONST, ATTR_NULL, \
 143                         ATTR_NOTHROW_NONNULL)
 144 /* Nothrow pure functions whose pointer parameter(s) are all nonnull.  */
 145 DEF_ATTR_TREE_LIST (ATTR_PURE_NOTHROW_NONNULL, ATTR_PURE, ATTR_NULL, \
 146                         ATTR_NOTHROW_NONNULL)
 147 /* Nothrow malloc functions whose pointer parameter(s) are all nonnull.  */
 148 DEF_ATTR_TREE_LIST (ATTR_MALLOC_NOTHROW_NONNULL, ATTR_MALLOC, ATTR_NULL, \
 149                         ATTR_NOTHROW_NONNULL)
 150
 151 /* Construct a tree for a format attribute.  */
 152 #define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES)                           \
 153   DEF_ATTR_TREE_LIST (ATTR_##TYPE##_##VALUES, ATTR_NULL,                 \
 154                       ATTR_##TYPE, ATTR_LIST_##VALUES)                   \
 155   DEF_ATTR_TREE_LIST (ATTR_FORMAT_##TYPE##_##VALUES, ATTR_FORMAT,        \
 156                       ATTR_##TYPE##_##VALUES, ATTR_NOTHROW_NONNULL_##FA)
 157 DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
 158 DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
 159 DEF_FORMAT_ATTRIBUTE(PRINTF,2,2_0)
 160 DEF_FORMAT_ATTRIBUTE(PRINTF,2,2_3)
 161 DEF_FORMAT_ATTRIBUTE(PRINTF,3,3_0)
 162 DEF_FORMAT_ATTRIBUTE(PRINTF,3,3_4)
 163 DEF_FORMAT_ATTRIBUTE(PRINTF,4,4_0)
 164 DEF_FORMAT_ATTRIBUTE(PRINTF,4,4_5)
 165 DEF_FORMAT_ATTRIBUTE(PRINTF,5,5_0)
 166 DEF_FORMAT_ATTRIBUTE(PRINTF,5,5_6)
 167 DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
 168 DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
 169 DEF_FORMAT_ATTRIBUTE(SCANF,2,2_0)
 170 DEF_FORMAT_ATTRIBUTE(SCANF,2,2_3)
 171 DEF_FORMAT_ATTRIBUTE(STRFTIME,3,3_0)
 172 DEF_FORMAT_ATTRIBUTE(STRFMON,3,3_4)
 173 #undef DEF_FORMAT_ATTRIBUTE
 174
 175 /* Construct a tree for a format_arg attribute.  */
 176 #define DEF_FORMAT_ARG_ATTRIBUTE(FA)                                    \
 177   DEF_ATTR_TREE_LIST (ATTR_FORMAT_ARG_##FA, ATTR_FORMAT_ARG,            \
 178                       ATTR_LIST_##FA, ATTR_NOTHROW_NONNULL_##FA)
 179 DEF_FORMAT_ARG_ATTRIBUTE(1)
 180 DEF_FORMAT_ARG_ATTRIBUTE(2)
 181 #undef DEF_FORMAT_ARG_ATTRIBUTE
 182