PR rtl-optimization/79386
[official-gcc.git] / gcc / attribs.c
blob55b21271b39e210451d9d9a10cf941be1fa3a5c3
1 /* Functions dealing with attribute handling, used by most front ends.
2 Copyright (C) 1992-2017 Free Software Foundation, Inc.
4 This file is part of GCC.
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.
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.
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/>. */
20 #include "config.h"
21 #include "system.h"
22 #include "coretypes.h"
23 #include "target.h"
24 #include "tree.h"
25 #include "stringpool.h"
26 #include "diagnostic-core.h"
27 #include "attribs.h"
28 #include "stor-layout.h"
29 #include "langhooks.h"
30 #include "plugin.h"
32 /* Table of the tables of attributes (common, language, format, machine)
33 searched. */
34 static const struct attribute_spec *attribute_tables[4];
36 /* Substring representation. */
38 struct substring
40 const char *str;
41 int length;
44 /* Simple hash function to avoid need to scan whole string. */
46 static inline hashval_t
47 substring_hash (const char *str, int l)
49 return str[0] + str[l - 1] * 256 + l * 65536;
52 /* Used for attribute_hash. */
54 struct attribute_hasher : nofree_ptr_hash <attribute_spec>
56 typedef substring *compare_type;
57 static inline hashval_t hash (const attribute_spec *);
58 static inline bool equal (const attribute_spec *, const substring *);
61 inline hashval_t
62 attribute_hasher::hash (const attribute_spec *spec)
64 const int l = strlen (spec->name);
65 return substring_hash (spec->name, l);
68 inline bool
69 attribute_hasher::equal (const attribute_spec *spec, const substring *str)
71 return (strncmp (spec->name, str->str, str->length) == 0
72 && !spec->name[str->length]);
75 /* Scoped attribute name representation. */
77 struct scoped_attributes
79 const char *ns;
80 vec<attribute_spec> attributes;
81 hash_table<attribute_hasher> *attribute_hash;
84 /* The table of scope attributes. */
85 static vec<scoped_attributes> attributes_table;
87 static scoped_attributes* find_attribute_namespace (const char*);
88 static void register_scoped_attribute (const struct attribute_spec *,
89 scoped_attributes *);
91 static bool attributes_initialized = false;
93 /* Default empty table of attributes. */
95 static const struct attribute_spec empty_attribute_table[] =
97 { NULL, 0, 0, false, false, false, NULL, false }
100 /* Return base name of the attribute. Ie '__attr__' is turned into 'attr'.
101 To avoid need for copying, we simply return length of the string. */
103 static void
104 extract_attribute_substring (struct substring *str)
106 if (str->length > 4 && str->str[0] == '_' && str->str[1] == '_'
107 && str->str[str->length - 1] == '_' && str->str[str->length - 2] == '_')
109 str->length -= 4;
110 str->str += 2;
114 /* Insert an array of attributes ATTRIBUTES into a namespace. This
115 array must be NULL terminated. NS is the name of attribute
116 namespace. The function returns the namespace into which the
117 attributes have been registered. */
119 scoped_attributes*
120 register_scoped_attributes (const struct attribute_spec * attributes,
121 const char* ns)
123 scoped_attributes *result = NULL;
125 /* See if we already have attributes in the namespace NS. */
126 result = find_attribute_namespace (ns);
128 if (result == NULL)
130 /* We don't have any namespace NS yet. Create one. */
131 scoped_attributes sa;
133 if (attributes_table.is_empty ())
134 attributes_table.create (64);
136 memset (&sa, 0, sizeof (sa));
137 sa.ns = ns;
138 sa.attributes.create (64);
139 result = attributes_table.safe_push (sa);
140 result->attribute_hash = new hash_table<attribute_hasher> (200);
143 /* Really add the attributes to their namespace now. */
144 for (unsigned i = 0; attributes[i].name != NULL; ++i)
146 result->attributes.safe_push (attributes[i]);
147 register_scoped_attribute (&attributes[i], result);
150 gcc_assert (result != NULL);
152 return result;
155 /* Return the namespace which name is NS, NULL if none exist. */
157 static scoped_attributes*
158 find_attribute_namespace (const char* ns)
160 unsigned ix;
161 scoped_attributes *iter;
163 FOR_EACH_VEC_ELT (attributes_table, ix, iter)
164 if (ns == iter->ns
165 || (iter->ns != NULL
166 && ns != NULL
167 && !strcmp (iter->ns, ns)))
168 return iter;
169 return NULL;
172 /* Make some sanity checks on the attribute tables. */
174 static void
175 check_attribute_tables (void)
177 for (size_t i = 0; i < ARRAY_SIZE (attribute_tables); i++)
178 for (size_t j = 0; attribute_tables[i][j].name != NULL; j++)
180 /* The name must not begin and end with __. */
181 const char *name = attribute_tables[i][j].name;
182 int len = strlen (name);
184 gcc_assert (!(name[0] == '_' && name[1] == '_'
185 && name[len - 1] == '_' && name[len - 2] == '_'));
187 /* The minimum and maximum lengths must be consistent. */
188 gcc_assert (attribute_tables[i][j].min_length >= 0);
190 gcc_assert (attribute_tables[i][j].max_length == -1
191 || (attribute_tables[i][j].max_length
192 >= attribute_tables[i][j].min_length));
194 /* An attribute cannot require both a DECL and a TYPE. */
195 gcc_assert (!attribute_tables[i][j].decl_required
196 || !attribute_tables[i][j].type_required);
198 /* If an attribute requires a function type, in particular
199 it requires a type. */
200 gcc_assert (!attribute_tables[i][j].function_type_required
201 || attribute_tables[i][j].type_required);
204 /* Check that each name occurs just once in each table. */
205 for (size_t i = 0; i < ARRAY_SIZE (attribute_tables); i++)
206 for (size_t j = 0; attribute_tables[i][j].name != NULL; j++)
207 for (size_t k = j + 1; attribute_tables[i][k].name != NULL; k++)
208 gcc_assert (strcmp (attribute_tables[i][j].name,
209 attribute_tables[i][k].name));
211 /* Check that no name occurs in more than one table. Names that
212 begin with '*' are exempt, and may be overridden. */
213 for (size_t i = 0; i < ARRAY_SIZE (attribute_tables); i++)
214 for (size_t j = i + 1; j < ARRAY_SIZE (attribute_tables); j++)
215 for (size_t k = 0; attribute_tables[i][k].name != NULL; k++)
216 for (size_t l = 0; attribute_tables[j][l].name != NULL; l++)
217 gcc_assert (attribute_tables[i][k].name[0] == '*'
218 || strcmp (attribute_tables[i][k].name,
219 attribute_tables[j][l].name));
222 /* Initialize attribute tables, and make some sanity checks if checking is
223 enabled. */
225 void
226 init_attributes (void)
228 size_t i;
230 if (attributes_initialized)
231 return;
233 attribute_tables[0] = lang_hooks.common_attribute_table;
234 attribute_tables[1] = lang_hooks.attribute_table;
235 attribute_tables[2] = lang_hooks.format_attribute_table;
236 attribute_tables[3] = targetm.attribute_table;
238 /* Translate NULL pointers to pointers to the empty table. */
239 for (i = 0; i < ARRAY_SIZE (attribute_tables); i++)
240 if (attribute_tables[i] == NULL)
241 attribute_tables[i] = empty_attribute_table;
243 if (flag_checking)
244 check_attribute_tables ();
246 for (i = 0; i < ARRAY_SIZE (attribute_tables); ++i)
247 /* Put all the GNU attributes into the "gnu" namespace. */
248 register_scoped_attributes (attribute_tables[i], "gnu");
250 invoke_plugin_callbacks (PLUGIN_ATTRIBUTES, NULL);
251 attributes_initialized = true;
254 /* Insert a single ATTR into the attribute table. */
256 void
257 register_attribute (const struct attribute_spec *attr)
259 register_scoped_attribute (attr, find_attribute_namespace ("gnu"));
262 /* Insert a single attribute ATTR into a namespace of attributes. */
264 static void
265 register_scoped_attribute (const struct attribute_spec *attr,
266 scoped_attributes *name_space)
268 struct substring str;
269 attribute_spec **slot;
271 gcc_assert (attr != NULL && name_space != NULL);
273 gcc_assert (name_space->attribute_hash);
275 str.str = attr->name;
276 str.length = strlen (str.str);
278 /* Attribute names in the table must be in the form 'text' and not
279 in the form '__text__'. */
280 gcc_assert (str.length > 0 && str.str[0] != '_');
282 slot = name_space->attribute_hash
283 ->find_slot_with_hash (&str, substring_hash (str.str, str.length),
284 INSERT);
285 gcc_assert (!*slot || attr->name[0] == '*');
286 *slot = CONST_CAST (struct attribute_spec *, attr);
289 /* Return the spec for the scoped attribute with namespace NS and
290 name NAME. */
292 static const struct attribute_spec *
293 lookup_scoped_attribute_spec (const_tree ns, const_tree name)
295 struct substring attr;
296 scoped_attributes *attrs;
298 const char *ns_str = (ns != NULL_TREE) ? IDENTIFIER_POINTER (ns): NULL;
300 attrs = find_attribute_namespace (ns_str);
302 if (attrs == NULL)
303 return NULL;
305 attr.str = IDENTIFIER_POINTER (name);
306 attr.length = IDENTIFIER_LENGTH (name);
307 extract_attribute_substring (&attr);
308 return attrs->attribute_hash->find_with_hash (&attr,
309 substring_hash (attr.str,
310 attr.length));
313 /* Return the spec for the attribute named NAME. If NAME is a TREE_LIST,
314 it also specifies the attribute namespace. */
316 const struct attribute_spec *
317 lookup_attribute_spec (const_tree name)
319 tree ns;
320 if (TREE_CODE (name) == TREE_LIST)
322 ns = TREE_PURPOSE (name);
323 name = TREE_VALUE (name);
325 else
326 ns = get_identifier ("gnu");
327 return lookup_scoped_attribute_spec (ns, name);
331 /* Return the namespace of the attribute ATTR. This accessor works on
332 GNU and C++11 (scoped) attributes. On GNU attributes,
333 it returns an identifier tree for the string "gnu".
335 Please read the comments of cxx11_attribute_p to understand the
336 format of attributes. */
338 static tree
339 get_attribute_namespace (const_tree attr)
341 if (cxx11_attribute_p (attr))
342 return TREE_PURPOSE (TREE_PURPOSE (attr));
343 return get_identifier ("gnu");
347 /* Process the attributes listed in ATTRIBUTES and install them in *NODE,
348 which is either a DECL (including a TYPE_DECL) or a TYPE. If a DECL,
349 it should be modified in place; if a TYPE, a copy should be created
350 unless ATTR_FLAG_TYPE_IN_PLACE is set in FLAGS. FLAGS gives further
351 information, in the form of a bitwise OR of flags in enum attribute_flags
352 from tree.h. Depending on these flags, some attributes may be
353 returned to be applied at a later stage (for example, to apply
354 a decl attribute to the declaration rather than to its type). */
356 tree
357 decl_attributes (tree *node, tree attributes, int flags)
359 tree a;
360 tree returned_attrs = NULL_TREE;
362 if (TREE_TYPE (*node) == error_mark_node || attributes == error_mark_node)
363 return NULL_TREE;
365 if (!attributes_initialized)
366 init_attributes ();
368 /* If this is a function and the user used #pragma GCC optimize, add the
369 options to the attribute((optimize(...))) list. */
370 if (TREE_CODE (*node) == FUNCTION_DECL && current_optimize_pragma)
372 tree cur_attr = lookup_attribute ("optimize", attributes);
373 tree opts = copy_list (current_optimize_pragma);
375 if (! cur_attr)
376 attributes
377 = tree_cons (get_identifier ("optimize"), opts, attributes);
378 else
379 TREE_VALUE (cur_attr) = chainon (opts, TREE_VALUE (cur_attr));
382 if (TREE_CODE (*node) == FUNCTION_DECL
383 && optimization_current_node != optimization_default_node
384 && !DECL_FUNCTION_SPECIFIC_OPTIMIZATION (*node))
385 DECL_FUNCTION_SPECIFIC_OPTIMIZATION (*node) = optimization_current_node;
387 /* If this is a function and the user used #pragma GCC target, add the
388 options to the attribute((target(...))) list. */
389 if (TREE_CODE (*node) == FUNCTION_DECL
390 && current_target_pragma
391 && targetm.target_option.valid_attribute_p (*node, NULL_TREE,
392 current_target_pragma, 0))
394 tree cur_attr = lookup_attribute ("target", attributes);
395 tree opts = copy_list (current_target_pragma);
397 if (! cur_attr)
398 attributes = tree_cons (get_identifier ("target"), opts, attributes);
399 else
400 TREE_VALUE (cur_attr) = chainon (opts, TREE_VALUE (cur_attr));
403 /* A "naked" function attribute implies "noinline" and "noclone" for
404 those targets that support it. */
405 if (TREE_CODE (*node) == FUNCTION_DECL
406 && attributes
407 && lookup_attribute_spec (get_identifier ("naked"))
408 && lookup_attribute ("naked", attributes) != NULL)
410 if (lookup_attribute ("noinline", attributes) == NULL)
411 attributes = tree_cons (get_identifier ("noinline"), NULL, attributes);
413 if (lookup_attribute ("noclone", attributes) == NULL)
414 attributes = tree_cons (get_identifier ("noclone"), NULL, attributes);
417 targetm.insert_attributes (*node, &attributes);
419 for (a = attributes; a; a = TREE_CHAIN (a))
421 tree ns = get_attribute_namespace (a);
422 tree name = get_attribute_name (a);
423 tree args = TREE_VALUE (a);
424 tree *anode = node;
425 const struct attribute_spec *spec =
426 lookup_scoped_attribute_spec (ns, name);
427 bool no_add_attrs = 0;
428 int fn_ptr_quals = 0;
429 tree fn_ptr_tmp = NULL_TREE;
431 if (spec == NULL)
433 if (!(flags & (int) ATTR_FLAG_BUILT_IN))
435 if (ns == NULL_TREE || !cxx11_attribute_p (a))
436 warning (OPT_Wattributes, "%qE attribute directive ignored",
437 name);
438 else
439 warning (OPT_Wattributes,
440 "%<%E::%E%> scoped attribute directive ignored",
441 ns, name);
443 continue;
445 else if (list_length (args) < spec->min_length
446 || (spec->max_length >= 0
447 && list_length (args) > spec->max_length))
449 error ("wrong number of arguments specified for %qE attribute",
450 name);
451 continue;
453 gcc_assert (is_attribute_p (spec->name, name));
455 if (TYPE_P (*node)
456 && cxx11_attribute_p (a)
457 && !(flags & ATTR_FLAG_TYPE_IN_PLACE))
459 /* This is a c++11 attribute that appertains to a
460 type-specifier, outside of the definition of, a class
461 type. Ignore it. */
462 if (warning (OPT_Wattributes, "attribute ignored"))
463 inform (input_location,
464 "an attribute that appertains to a type-specifier "
465 "is ignored");
466 continue;
469 if (spec->decl_required && !DECL_P (*anode))
471 if (flags & ((int) ATTR_FLAG_DECL_NEXT
472 | (int) ATTR_FLAG_FUNCTION_NEXT
473 | (int) ATTR_FLAG_ARRAY_NEXT))
475 /* Pass on this attribute to be tried again. */
476 returned_attrs = tree_cons (name, args, returned_attrs);
477 continue;
479 else
481 warning (OPT_Wattributes, "%qE attribute does not apply to types",
482 name);
483 continue;
487 /* If we require a type, but were passed a decl, set up to make a
488 new type and update the one in the decl. ATTR_FLAG_TYPE_IN_PLACE
489 would have applied if we'd been passed a type, but we cannot modify
490 the decl's type in place here. */
491 if (spec->type_required && DECL_P (*anode))
493 anode = &TREE_TYPE (*anode);
494 flags &= ~(int) ATTR_FLAG_TYPE_IN_PLACE;
497 if (spec->function_type_required && TREE_CODE (*anode) != FUNCTION_TYPE
498 && TREE_CODE (*anode) != METHOD_TYPE)
500 if (TREE_CODE (*anode) == POINTER_TYPE
501 && (TREE_CODE (TREE_TYPE (*anode)) == FUNCTION_TYPE
502 || TREE_CODE (TREE_TYPE (*anode)) == METHOD_TYPE))
504 /* OK, this is a bit convoluted. We can't just make a copy
505 of the pointer type and modify its TREE_TYPE, because if
506 we change the attributes of the target type the pointer
507 type needs to have a different TYPE_MAIN_VARIANT. So we
508 pull out the target type now, frob it as appropriate, and
509 rebuild the pointer type later.
511 This would all be simpler if attributes were part of the
512 declarator, grumble grumble. */
513 fn_ptr_tmp = TREE_TYPE (*anode);
514 fn_ptr_quals = TYPE_QUALS (*anode);
515 anode = &fn_ptr_tmp;
516 flags &= ~(int) ATTR_FLAG_TYPE_IN_PLACE;
518 else if (flags & (int) ATTR_FLAG_FUNCTION_NEXT)
520 /* Pass on this attribute to be tried again. */
521 returned_attrs = tree_cons (name, args, returned_attrs);
522 continue;
525 if (TREE_CODE (*anode) != FUNCTION_TYPE
526 && TREE_CODE (*anode) != METHOD_TYPE)
528 warning (OPT_Wattributes,
529 "%qE attribute only applies to function types",
530 name);
531 continue;
535 if (TYPE_P (*anode)
536 && (flags & (int) ATTR_FLAG_TYPE_IN_PLACE)
537 && TYPE_SIZE (*anode) != NULL_TREE)
539 warning (OPT_Wattributes, "type attributes ignored after type is already defined");
540 continue;
543 if (spec->handler != NULL)
545 int cxx11_flag =
546 cxx11_attribute_p (a) ? ATTR_FLAG_CXX11 : 0;
548 returned_attrs = chainon ((*spec->handler) (anode, name, args,
549 flags|cxx11_flag,
550 &no_add_attrs),
551 returned_attrs);
554 /* Layout the decl in case anything changed. */
555 if (spec->type_required && DECL_P (*node)
556 && (VAR_P (*node)
557 || TREE_CODE (*node) == PARM_DECL
558 || TREE_CODE (*node) == RESULT_DECL))
559 relayout_decl (*node);
561 if (!no_add_attrs)
563 tree old_attrs;
564 tree a;
566 if (DECL_P (*anode))
567 old_attrs = DECL_ATTRIBUTES (*anode);
568 else
569 old_attrs = TYPE_ATTRIBUTES (*anode);
571 for (a = lookup_attribute (spec->name, old_attrs);
572 a != NULL_TREE;
573 a = lookup_attribute (spec->name, TREE_CHAIN (a)))
575 if (simple_cst_equal (TREE_VALUE (a), args) == 1)
576 break;
579 if (a == NULL_TREE)
581 /* This attribute isn't already in the list. */
582 if (DECL_P (*anode))
583 DECL_ATTRIBUTES (*anode) = tree_cons (name, args, old_attrs);
584 else if (flags & (int) ATTR_FLAG_TYPE_IN_PLACE)
586 TYPE_ATTRIBUTES (*anode) = tree_cons (name, args, old_attrs);
587 /* If this is the main variant, also push the attributes
588 out to the other variants. */
589 if (*anode == TYPE_MAIN_VARIANT (*anode))
591 tree variant;
592 for (variant = *anode; variant;
593 variant = TYPE_NEXT_VARIANT (variant))
595 if (TYPE_ATTRIBUTES (variant) == old_attrs)
596 TYPE_ATTRIBUTES (variant)
597 = TYPE_ATTRIBUTES (*anode);
598 else if (!lookup_attribute
599 (spec->name, TYPE_ATTRIBUTES (variant)))
600 TYPE_ATTRIBUTES (variant) = tree_cons
601 (name, args, TYPE_ATTRIBUTES (variant));
605 else
606 *anode = build_type_attribute_variant (*anode,
607 tree_cons (name, args,
608 old_attrs));
612 if (fn_ptr_tmp)
614 /* Rebuild the function pointer type and put it in the
615 appropriate place. */
616 fn_ptr_tmp = build_pointer_type (fn_ptr_tmp);
617 if (fn_ptr_quals)
618 fn_ptr_tmp = build_qualified_type (fn_ptr_tmp, fn_ptr_quals);
619 if (DECL_P (*node))
620 TREE_TYPE (*node) = fn_ptr_tmp;
621 else
623 gcc_assert (TREE_CODE (*node) == POINTER_TYPE);
624 *node = fn_ptr_tmp;
629 return returned_attrs;
632 /* Return TRUE iff ATTR has been parsed by the front-end as a C++-11
633 attribute.
635 When G++ parses a C++11 attribute, it is represented as
636 a TREE_LIST which TREE_PURPOSE is itself a TREE_LIST. TREE_PURPOSE
637 (TREE_PURPOSE (ATTR)) is the namespace of the attribute, and the
638 TREE_VALUE (TREE_PURPOSE (ATTR)) is its non-qualified name. Please
639 use get_attribute_namespace and get_attribute_name to retrieve the
640 namespace and name of the attribute, as these accessors work with
641 GNU attributes as well. */
643 bool
644 cxx11_attribute_p (const_tree attr)
646 if (attr == NULL_TREE
647 || TREE_CODE (attr) != TREE_LIST)
648 return false;
650 return (TREE_CODE (TREE_PURPOSE (attr)) == TREE_LIST);
653 /* Return the name of the attribute ATTR. This accessor works on GNU
654 and C++11 (scoped) attributes.
656 Please read the comments of cxx11_attribute_p to understand the
657 format of attributes. */
659 tree
660 get_attribute_name (const_tree attr)
662 if (cxx11_attribute_p (attr))
663 return TREE_VALUE (TREE_PURPOSE (attr));
664 return TREE_PURPOSE (attr);
667 /* Subroutine of set_method_tm_attributes. Apply TM attribute ATTR
668 to the method FNDECL. */
670 void
671 apply_tm_attr (tree fndecl, tree attr)
673 decl_attributes (&TREE_TYPE (fndecl), tree_cons (attr, NULL, NULL), 0);
676 /* Makes a function attribute of the form NAME(ARG_NAME) and chains
677 it to CHAIN. */
679 tree
680 make_attribute (const char *name, const char *arg_name, tree chain)
682 tree attr_name;
683 tree attr_arg_name;
684 tree attr_args;
685 tree attr;
687 attr_name = get_identifier (name);
688 attr_arg_name = build_string (strlen (arg_name), arg_name);
689 attr_args = tree_cons (NULL_TREE, attr_arg_name, NULL_TREE);
690 attr = tree_cons (attr_name, attr_args, chain);
691 return attr;