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