[gcc.git] / gcc / builtin-attrs.def

/* Copyright (C) 2001, 2002 Free Software Foundation, Inc.
   Contributed by Joseph Myers <jsm28@cam.ac.uk>.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING.  If not, write to the Free
Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.  */

/* This header provides a declarative way of describing the attributes
   that are applied to some functions by default.

   Before including this header, you must define the following macros.
   In each case where there is an ENUM, it is an identifier used to
   reference the tree in subsequent definitions.

   DEF_ATTR_NULL_TREE (ENUM)

     Constructs a NULL_TREE.

   DEF_ATTR_INT (ENUM, VALUE)

     Constructs an INTEGER_CST with value VALUE (an integer representable
     in HOST_WIDE_INT).

   DEF_ATTR_IDENT (ENUM, STRING)

     Constructs an IDENTIFIER_NODE for STRING.

   DEF_ATTR_TREE_LIST (ENUM, PURPOSE, VALUE, CHAIN)

     Constructs a TREE_LIST with given PURPOSE, VALUE and CHAIN (given
     as previous ENUM names).

   DEF_FN_ATTR (NAME, ATTRS, PREDICATE)

     Specifies that the function with name NAME (a previous ENUM for an
     IDENTIFIER_NODE) has attributes ATTRS (a previous ENUM) if
     PREDICATE is true.  */

DEF_ATTR_NULL_TREE (ATTR_NULL)

/* Note that below we must avoid whitespace in arguments of CONCAT*.  */

/* Construct a tree for a given integer and a list containing it.  */
#define DEF_ATTR_FOR_INT(VALUE)					\
  DEF_ATTR_INT (CONCAT2 (ATTR_,VALUE), VALUE)			\
  DEF_ATTR_TREE_LIST (CONCAT2 (ATTR_LIST_,VALUE), ATTR_NULL,	\
		      CONCAT2 (ATTR_,VALUE), ATTR_NULL)
DEF_ATTR_FOR_INT (0)
DEF_ATTR_FOR_INT (1)
DEF_ATTR_FOR_INT (2)
DEF_ATTR_FOR_INT (3)
DEF_ATTR_FOR_INT (4)
#undef DEF_ATTR_FOR_INT

/* Construct a tree for a list of two integers.  */
#define DEF_LIST_INT_INT(VALUE1, VALUE2)				 \
  DEF_ATTR_TREE_LIST (CONCAT4 (ATTR_LIST_,VALUE1,_,VALUE2), ATTR_NULL,	 \
		    CONCAT2 (ATTR_,VALUE1), CONCAT2 (ATTR_LIST_,VALUE2))
DEF_LIST_INT_INT (1,0)
DEF_LIST_INT_INT (1,2)
DEF_LIST_INT_INT (2,0)
DEF_LIST_INT_INT (2,3)
DEF_LIST_INT_INT (3,0)
DEF_LIST_INT_INT (3,4)
#undef DEF_LIST_INT_INT

DEF_ATTR_IDENT (ATTR_PRINTF, "printf")
DEF_ATTR_IDENT (ATTR_SCANF, "scanf")
DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime")
DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon")

DEF_ATTR_IDENT (ATTR_FORMAT, "format")
DEF_ATTR_IDENT (ATTR_FORMAT_ARG, "format_arg")

DEF_ATTR_IDENT (ATTR_NONNULL, "nonnull")

DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL)

/* Construct a tree for a format attribute.  */
#define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES)				 \
  DEF_ATTR_TREE_LIST (CONCAT4 (ATTR_,TYPE,_,VALUES), ATTR_NULL,		 \
		      CONCAT2 (ATTR_,TYPE), CONCAT2 (ATTR_LIST_,VALUES)) \
  DEF_ATTR_TREE_LIST (CONCAT4 (ATTR_FORMAT_,TYPE,_,VALUES), ATTR_FORMAT, \
		      CONCAT4 (ATTR_,TYPE,_,VALUES), CONCAT2 (ATTR_NONNULL_,FA))
DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
DEF_FORMAT_ATTRIBUTE(PRINTF,2,2_0)
DEF_FORMAT_ATTRIBUTE(PRINTF,2,2_3)
DEF_FORMAT_ATTRIBUTE(PRINTF,3,3_0)
DEF_FORMAT_ATTRIBUTE(PRINTF,3,3_4)
DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
DEF_FORMAT_ATTRIBUTE(SCANF,2,2_0)
DEF_FORMAT_ATTRIBUTE(SCANF,2,2_3)
DEF_FORMAT_ATTRIBUTE(STRFTIME,3,3_0)
DEF_FORMAT_ATTRIBUTE(STRFMON,3,3_4)
#undef DEF_FORMAT_ATTRIBUTE

/* Construct a tree for a format_arg attribute.  */
#define DEF_FORMAT_ARG_ATTRIBUTE(FA)					\
  DEF_ATTR_TREE_LIST (CONCAT2 (ATTR_FORMAT_ARG_,FA), ATTR_FORMAT_ARG,	\
		      CONCAT2 (ATTR_LIST_,FA), CONCAT2 (ATTR_NONNULL_,FA))
DEF_FORMAT_ARG_ATTRIBUTE(1)
DEF_FORMAT_ARG_ATTRIBUTE(2)
#undef DEF_FORMAT_ARG_ATTRIBUTE

/* Define an attribute for a function, along with the IDENTIFIER_NODE.  */
#define DEF_FN_ATTR_IDENT(NAME, ATTRS, PREDICATE)	\
  DEF_ATTR_IDENT (CONCAT2(ATTR_,NAME), STRINGX(NAME))	\
  DEF_FN_ATTR (CONCAT2(ATTR_,NAME), ATTRS, PREDICATE)

/* The ISO C functions are always checked (whether <stdio.h> is
   included or not), since it is common to call printf without
   including <stdio.h>.  There shouldn't be a problem with this,
   since ISO C reserves these function names whether you include the
   header file or not.  In any case, the checking is harmless.  With
   -ffreestanding, these default attributes are disabled, and must be
   specified manually if desired.  */

/* __builtin functions should be checked unconditionally, even with
   -ffreestanding.  */
DEF_FN_ATTR_IDENT (__builtin_printf, ATTR_FORMAT_PRINTF_1_2, true)
DEF_FN_ATTR_IDENT (__builtin_fprintf, ATTR_FORMAT_PRINTF_2_3, true)
DEF_FN_ATTR_IDENT (__builtin_printf_unlocked, ATTR_FORMAT_PRINTF_1_2, true)
DEF_FN_ATTR_IDENT (__builtin_fprintf_unlocked, ATTR_FORMAT_PRINTF_2_3, true)

/* Functions from ISO/IEC 9899:1990.  */
#define DEF_C89_ATTR(NAME, ATTRS) DEF_FN_ATTR_IDENT (NAME, ATTRS, flag_hosted)
DEF_C89_ATTR (printf, ATTR_FORMAT_PRINTF_1_2)
DEF_C89_ATTR (fprintf, ATTR_FORMAT_PRINTF_2_3)
DEF_C89_ATTR (sprintf, ATTR_FORMAT_PRINTF_2_3)
DEF_C89_ATTR (scanf, ATTR_FORMAT_SCANF_1_2)
DEF_C89_ATTR (fscanf, ATTR_FORMAT_SCANF_2_3)
DEF_C89_ATTR (sscanf, ATTR_FORMAT_SCANF_2_3)
DEF_C89_ATTR (vprintf, ATTR_FORMAT_PRINTF_1_0)
DEF_C89_ATTR (vfprintf, ATTR_FORMAT_PRINTF_2_0)
DEF_C89_ATTR (vsprintf, ATTR_FORMAT_PRINTF_2_0)
DEF_C89_ATTR (strftime, ATTR_FORMAT_STRFTIME_3_0)
#undef DEF_C89_ATTR

/* ISO C99 adds the snprintf and vscanf family functions.  */
#define DEF_C99_ATTR(NAME, ATTRS)					    \
  DEF_FN_ATTR_IDENT (NAME, ATTRS,					    \
	       (flag_hosted						    \
		&& (flag_isoc99 || flag_noniso_default_format_attributes)))
DEF_C99_ATTR (snprintf, ATTR_FORMAT_PRINTF_3_4)
DEF_C99_ATTR (vsnprintf, ATTR_FORMAT_PRINTF_3_0)
DEF_C99_ATTR (vscanf, ATTR_FORMAT_SCANF_1_0)
DEF_C99_ATTR (vfscanf, ATTR_FORMAT_SCANF_2_0)
DEF_C99_ATTR (vsscanf, ATTR_FORMAT_SCANF_2_0)
#undef DEF_C99_ATTR

/* Functions not in any version of ISO C.  */
#define DEF_EXT_ATTR(NAME, ATTRS)					\
  DEF_FN_ATTR_IDENT (NAME, ATTRS,					\
	       flag_hosted && flag_noniso_default_format_attributes)
/* Uniforum/GNU gettext functions.  */
DEF_EXT_ATTR (gettext, ATTR_FORMAT_ARG_1)
DEF_EXT_ATTR (dgettext, ATTR_FORMAT_ARG_2)
DEF_EXT_ATTR (dcgettext, ATTR_FORMAT_ARG_2)
/* X/Open strfmon function.  */
DEF_EXT_ATTR (strfmon, ATTR_FORMAT_STRFMON_3_4)
/* Glibc thread-unsafe stdio functions.  */
DEF_EXT_ATTR (printf_unlocked, ATTR_FORMAT_PRINTF_1_2)
DEF_EXT_ATTR (fprintf_unlocked, ATTR_FORMAT_PRINTF_2_3)
#undef DEF_EXT_ATTR
#undef DEF_FN_ATTR_IDENT
Commit	Line	Data
79ed7328	1	/* Copyright (C) 2001, 2002 Free Software Foundation, Inc.
6431177a JM	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, 59 Temple Place - Suite 330, Boston, MA
	19	02111-1307, 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_FN_ATTR (NAME, ATTRS, PREDICATE)
	47
	48	Specifies that the function with name NAME (a previous ENUM for an
	49	IDENTIFIER_NODE) has attributes ATTRS (a previous ENUM) if
	50	PREDICATE is true. */
	51
	52	DEF_ATTR_NULL_TREE (ATTR_NULL)
	53
	54	/* Note that below we must avoid whitespace in arguments of CONCAT. /
	55
	56	/* Construct a tree for a given integer and a list containing it. */
	57	#define DEF_ATTR_FOR_INT(VALUE) \
	58	DEF_ATTR_INT (CONCAT2 (ATTR_,VALUE), VALUE) \
	59	DEF_ATTR_TREE_LIST (CONCAT2 (ATTR_LIST_,VALUE), ATTR_NULL, \
	60	CONCAT2 (ATTR_,VALUE), ATTR_NULL)
	61	DEF_ATTR_FOR_INT (0)
	62	DEF_ATTR_FOR_INT (1)
	63	DEF_ATTR_FOR_INT (2)
	64	DEF_ATTR_FOR_INT (3)
	65	DEF_ATTR_FOR_INT (4)
66	#undef DEF_ATTR_FOR_INT
67
68	/* Construct a tree for a list of two integers. */
69	#define DEF_LIST_INT_INT(VALUE1, VALUE2) \
70	DEF_ATTR_TREE_LIST (CONCAT4 (ATTR_LIST_,VALUE1,_,VALUE2), ATTR_NULL, \
71	CONCAT2 (ATTR_,VALUE1), CONCAT2 (ATTR_LIST_,VALUE2))
72	DEF_LIST_INT_INT (1,0)
73	DEF_LIST_INT_INT (1,2)
74	DEF_LIST_INT_INT (2,0)
75	DEF_LIST_INT_INT (2,3)
76	DEF_LIST_INT_INT (3,0)
77	DEF_LIST_INT_INT (3,4)
78	#undef DEF_LIST_INT_INT
79
80	DEF_ATTR_IDENT (ATTR_PRINTF, "printf")
81	DEF_ATTR_IDENT (ATTR_SCANF, "scanf")
82	DEF_ATTR_IDENT (ATTR_STRFTIME, "strftime")
83	DEF_ATTR_IDENT (ATTR_STRFMON, "strfmon")
84
85	DEF_ATTR_IDENT (ATTR_FORMAT, "format")
86	DEF_ATTR_IDENT (ATTR_FORMAT_ARG, "format_arg")
87
79ed7328 JT	88	DEF_ATTR_IDENT (ATTR_NONNULL, "nonnull")
	89
	90	DEF_ATTR_TREE_LIST (ATTR_NONNULL_1, ATTR_NONNULL, ATTR_LIST_1, ATTR_NULL)
	91	DEF_ATTR_TREE_LIST (ATTR_NONNULL_2, ATTR_NONNULL, ATTR_LIST_2, ATTR_NULL)
	92	DEF_ATTR_TREE_LIST (ATTR_NONNULL_3, ATTR_NONNULL, ATTR_LIST_3, ATTR_NULL)
	93
6431177a	94	/* Construct a tree for a format attribute. */
79ed7328	95	#define DEF_FORMAT_ATTRIBUTE(TYPE, FA, VALUES) \
6431177a JM	96	DEF_ATTR_TREE_LIST (CONCAT4 (ATTR_,TYPE,_,VALUES), ATTR_NULL, \
	97	CONCAT2 (ATTR_,TYPE), CONCAT2 (ATTR_LIST_,VALUES)) \
	98	DEF_ATTR_TREE_LIST (CONCAT4 (ATTR_FORMAT_,TYPE,_,VALUES), ATTR_FORMAT, \
79ed7328 JT	99	CONCAT4 (ATTR_,TYPE,_,VALUES), CONCAT2 (ATTR_NONNULL_,FA))
	100	DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_0)
	101	DEF_FORMAT_ATTRIBUTE(PRINTF,1,1_2)
	102	DEF_FORMAT_ATTRIBUTE(PRINTF,2,2_0)
	103	DEF_FORMAT_ATTRIBUTE(PRINTF,2,2_3)
	104	DEF_FORMAT_ATTRIBUTE(PRINTF,3,3_0)
	105	DEF_FORMAT_ATTRIBUTE(PRINTF,3,3_4)
	106	DEF_FORMAT_ATTRIBUTE(SCANF,1,1_0)
	107	DEF_FORMAT_ATTRIBUTE(SCANF,1,1_2)
	108	DEF_FORMAT_ATTRIBUTE(SCANF,2,2_0)
	109	DEF_FORMAT_ATTRIBUTE(SCANF,2,2_3)
	110	DEF_FORMAT_ATTRIBUTE(STRFTIME,3,3_0)
	111	DEF_FORMAT_ATTRIBUTE(STRFMON,3,3_4)
6431177a JM	112	#undef DEF_FORMAT_ATTRIBUTE
6431177a JM	113
79ed7328 JT	114	/* Construct a tree for a format_arg attribute. */
	115	#define DEF_FORMAT_ARG_ATTRIBUTE(FA) \
	116	DEF_ATTR_TREE_LIST (CONCAT2 (ATTR_FORMAT_ARG_,FA), ATTR_FORMAT_ARG, \
	117	CONCAT2 (ATTR_LIST_,FA), CONCAT2 (ATTR_NONNULL_,FA))
	118	DEF_FORMAT_ARG_ATTRIBUTE(1)
	119	DEF_FORMAT_ARG_ATTRIBUTE(2)
	120	#undef DEF_FORMAT_ARG_ATTRIBUTE
6431177a JM	121
	122	/* Define an attribute for a function, along with the IDENTIFIER_NODE. */
	123	#define DEF_FN_ATTR_IDENT(NAME, ATTRS, PREDICATE) \
	124	DEF_ATTR_IDENT (CONCAT2(ATTR_,NAME), STRINGX(NAME)) \
	125	DEF_FN_ATTR (CONCAT2(ATTR_,NAME), ATTRS, PREDICATE)
	126
	127	/* The ISO C functions are always checked (whether <stdio.h> is
	128	included or not), since it is common to call printf without
	129	including <stdio.h>. There shouldn't be a problem with this,
	130	since ISO C reserves these function names whether you include the
	131	header file or not. In any case, the checking is harmless. With
	132	-ffreestanding, these default attributes are disabled, and must be
	133	specified manually if desired. */
	134
	135	/* __builtin functions should be checked unconditionally, even with
	136	-ffreestanding. */
	137	DEF_FN_ATTR_IDENT (__builtin_printf, ATTR_FORMAT_PRINTF_1_2, true)
	138	DEF_FN_ATTR_IDENT (__builtin_fprintf, ATTR_FORMAT_PRINTF_2_3, true)
b4c984fb KG	139	DEF_FN_ATTR_IDENT (__builtin_printf_unlocked, ATTR_FORMAT_PRINTF_1_2, true)
b4c984fb KG	140	DEF_FN_ATTR_IDENT (__builtin_fprintf_unlocked, ATTR_FORMAT_PRINTF_2_3, true)
6431177a JM	141
	142	/* Functions from ISO/IEC 9899:1990. */
	143	#define DEF_C89_ATTR(NAME, ATTRS) DEF_FN_ATTR_IDENT (NAME, ATTRS, flag_hosted)
	144	DEF_C89_ATTR (printf, ATTR_FORMAT_PRINTF_1_2)
	145	DEF_C89_ATTR (fprintf, ATTR_FORMAT_PRINTF_2_3)
	146	DEF_C89_ATTR (sprintf, ATTR_FORMAT_PRINTF_2_3)
	147	DEF_C89_ATTR (scanf, ATTR_FORMAT_SCANF_1_2)
	148	DEF_C89_ATTR (fscanf, ATTR_FORMAT_SCANF_2_3)
	149	DEF_C89_ATTR (sscanf, ATTR_FORMAT_SCANF_2_3)
	150	DEF_C89_ATTR (vprintf, ATTR_FORMAT_PRINTF_1_0)
	151	DEF_C89_ATTR (vfprintf, ATTR_FORMAT_PRINTF_2_0)
	152	DEF_C89_ATTR (vsprintf, ATTR_FORMAT_PRINTF_2_0)
	153	DEF_C89_ATTR (strftime, ATTR_FORMAT_STRFTIME_3_0)
	154	#undef DEF_C89_ATTR
	155
	156	/* ISO C99 adds the snprintf and vscanf family functions. */
	157	#define DEF_C99_ATTR(NAME, ATTRS) \
	158	DEF_FN_ATTR_IDENT (NAME, ATTRS, \
	159	(flag_hosted \
	160	&& (flag_isoc99 \|\| flag_noniso_default_format_attributes)))
	161	DEF_C99_ATTR (snprintf, ATTR_FORMAT_PRINTF_3_4)
	162	DEF_C99_ATTR (vsnprintf, ATTR_FORMAT_PRINTF_3_0)
	163	DEF_C99_ATTR (vscanf, ATTR_FORMAT_SCANF_1_0)
	164	DEF_C99_ATTR (vfscanf, ATTR_FORMAT_SCANF_2_0)
	165	DEF_C99_ATTR (vsscanf, ATTR_FORMAT_SCANF_2_0)
	166	#undef DEF_C99_ATTR
	167
	168	/* Functions not in any version of ISO C. */
	169	#define DEF_EXT_ATTR(NAME, ATTRS) \
	170	DEF_FN_ATTR_IDENT (NAME, ATTRS, \
	171	flag_hosted && flag_noniso_default_format_attributes)
	172	/* Uniforum/GNU gettext functions. */
	173	DEF_EXT_ATTR (gettext, ATTR_FORMAT_ARG_1)
	174	DEF_EXT_ATTR (dgettext, ATTR_FORMAT_ARG_2)
	175	DEF_EXT_ATTR (dcgettext, ATTR_FORMAT_ARG_2)
	176	/* X/Open strfmon function. */
	177	DEF_EXT_ATTR (strfmon, ATTR_FORMAT_STRFMON_3_4)
b4c984fb KG	178	/* Glibc thread-unsafe stdio functions. */
	179	DEF_EXT_ATTR (printf_unlocked, ATTR_FORMAT_PRINTF_1_2)
	180	DEF_EXT_ATTR (fprintf_unlocked, ATTR_FORMAT_PRINTF_2_3)
6431177a JM	181	#undef DEF_EXT_ATTR
6431177a JM	182	#undef DEF_FN_ATTR_IDENT