main/gcc/langhooks.h

   1 /* The lang_hooks data structure.
   2    Copyright (C) 2001-2013 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 3, or (at your option)
   9 any later version.
  10
  11 GCC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License 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 #ifndef GCC_LANG_HOOKS_H
  21 #define GCC_LANG_HOOKS_H
  22
  23 /* FIXME: This file should be #include-d after tree.h (for enum tree_code).  */
  24
  25 struct diagnostic_info;
  26
  27 struct gimplify_omp_ctx;
  28
  29 struct array_descr_info;
  30
  31 /* A print hook for print_tree ().  */
  32 typedef void (*lang_print_tree_hook) (FILE *, tree, int indent);
  33
  34 enum classify_record
  35   { RECORD_IS_STRUCT, RECORD_IS_CLASS, RECORD_IS_INTERFACE };
  36
  37 /* The following hooks are documented in langhooks.c.  Must not be
  38    NULL.  */
  39
  40 struct lang_hooks_for_tree_inlining
  41 {
  42   bool (*var_mod_type_p) (tree, tree);
  43 };
  44
  45 /* The following hooks are used by tree-dump.c.  */
  46
  47 struct lang_hooks_for_tree_dump
  48 {
  49   /* Dump language-specific parts of tree nodes.  Returns nonzero if it
  50      does not want the usual dumping of the second argument.  */
  51   bool (*dump_tree) (void *, tree);
  52
  53   /* Determine type qualifiers in a language-specific way.  */
  54   int (*type_quals) (const_tree);
  55 };
  56
  57 /* Hooks related to types.  */
  58
  59 struct lang_hooks_for_types
  60 {
  61   /* Return a new type (with the indicated CODE), doing whatever
  62      language-specific processing is required.  */
  63   tree (*make_type) (enum tree_code);
  64
  65   /* Return what kind of RECORD_TYPE this is, mainly for purposes of
  66      debug information.  If not defined, record types are assumed to
  67      be structures.  */
  68   enum classify_record (*classify_record) (tree);
  69
  70   /* Given MODE and UNSIGNEDP, return a suitable type-tree with that
  71      mode.  */
  72   tree (*type_for_mode) (enum machine_mode, int);
  73
  74   /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an
  75      integer type with at least that precision.  */
  76   tree (*type_for_size) (unsigned, int);
  77
  78   /* True if the type is an instantiation of a generic type,
  79      e.g. C++ template implicit specializations.  */
  80   bool (*generic_p) (const_tree);
  81
  82   /* Returns the TREE_VEC of elements of a given generic argument pack.  */
  83   tree (*get_argument_pack_elems) (const_tree);
  84
  85   /* Given a type, apply default promotions to unnamed function
  86      arguments and return the new type.  Return the same type if no
  87      change.  Required by any language that supports variadic
  88      arguments.  The default hook dies.  */
  89   tree (*type_promotes_to) (tree);
  90
  91   /* Register TYPE as a builtin type with the indicated NAME.  The
  92      TYPE is placed in the outermost lexical scope.  The semantics
  93      should be analogous to:
  94
  95        typedef TYPE NAME;
  96
  97      in C.  The default hook ignores the declaration.  */
  98   void (*register_builtin_type) (tree, const char *);
  99
 100   /* This routine is called in tree.c to print an error message for
 101      invalid use of an incomplete type.  VALUE is the expression that
 102      was used (or 0 if that isn't known) and TYPE is the type that was
 103      invalid.  */
 104   void (*incomplete_type_error) (const_tree value, const_tree type);
 105
 106   /* Called from assign_temp to return the maximum size, if there is one,
 107      for a type.  */
 108   tree (*max_size) (const_tree);
 109
 110   /* Register language specific type size variables as potentially OpenMP
 111      firstprivate variables.  */
 112   void (*omp_firstprivatize_type_sizes) (struct gimplify_omp_ctx *, tree);
 113
 114   /* Return TRUE if TYPE1 and TYPE2 are identical for type hashing purposes.
 115      Called only after doing all language independent checks.
 116      At present, this function is only called when both TYPE1 and TYPE2 are
 117      FUNCTION_TYPEs.  */
 118   bool (*type_hash_eq) (const_tree, const_tree);
 119
 120   /* Return TRUE if TYPE uses a hidden descriptor and fills in information
 121      for the debugger about the array bounds, strides, etc.  */
 122   bool (*get_array_descr_info) (const_tree, struct array_descr_info *);
 123
 124   /* Fill in information for the debugger about the bounds of TYPE.  */
 125   void (*get_subrange_bounds) (const_tree, tree *, tree *);
 126
 127   /* A type descriptive of TYPE's complex layout generated to help the
 128      debugger to decode variable-length or self-referential constructs.
 129      This is only used for the AT_GNAT_descriptive_type DWARF attribute.  */
 130   tree (*descriptive_type) (const_tree);
 131
 132   /* If we requested a pointer to a vector, build up the pointers that
 133      we stripped off while looking for the inner type.  Similarly for
 134      return values from functions.  The argument TYPE is the top of the
 135      chain, and BOTTOM is the new type which we will point to.  */
 136   tree (*reconstruct_complex_type) (tree, tree);
 137 };
 138
 139 /* Language hooks related to decls and the symbol table.  */
 140
 141 struct lang_hooks_for_decls
 142 {
 143   /* Return true if we are in the global binding level.  This hook is really
 144      needed only if the language supports variable-sized types at the global
 145      level, i.e. declared outside subprograms.  */
 146   bool (*global_bindings_p) (void);
 147
 148   /* Function to add a decl to the current scope level.  Takes one
 149      argument, a decl to add.  Returns that decl, or, if the same
 150      symbol is already declared, may return a different decl for that
 151      name.  */
 152   tree (*pushdecl) (tree);
 153
 154   /* Returns the chain of decls so far in the current scope level.  */
 155   tree (*getdecls) (void);
 156
 157   /* Returns true if DECL is explicit member function.  */
 158   bool (*function_decl_explicit_p) (tree);
 159
 160   /* Returns True if the parameter is a generic parameter decl
 161      of a generic type, e.g a template template parameter for the C++ FE.  */
 162   bool (*generic_generic_parameter_decl_p) (const_tree);
 163
 164   /* Determine if a function parameter got expanded from a
 165      function parameter pack.  */
 166   bool (*function_parm_expanded_from_pack_p) (tree, tree);
 167
 168   /* Returns the generic declaration of a generic function instantiations.  */
 169   tree (*get_generic_function_decl) (const_tree);
 170
 171   /* Returns true when we should warn for an unused global DECL.
 172      We will already have checked that it has static binding.  */
 173   bool (*warn_unused_global) (const_tree);
 174
 175   /* Obtain a list of globals and do final output on them at end
 176      of compilation */
 177   void (*final_write_globals) (void);
 178
 179   /* True if this decl may be called via a sibcall.  */
 180   bool (*ok_for_sibcall) (const_tree);
 181
 182   /* True if OpenMP should privatize what this DECL points to rather
 183      than the DECL itself.  */
 184   bool (*omp_privatize_by_reference) (const_tree);
 185
 186   /* Return sharing kind if OpenMP sharing attribute of DECL is
 187      predetermined, OMP_CLAUSE_DEFAULT_UNSPECIFIED otherwise.  */
 188   enum omp_clause_default_kind (*omp_predetermined_sharing) (tree);
 189
 190   /* Return decl that should be reported for DEFAULT(NONE) failure
 191      diagnostics.  Usually the DECL passed in.  */
 192   tree (*omp_report_decl) (tree);
 193
 194   /* Return true if DECL's DECL_VALUE_EXPR (if any) should be
 195      disregarded in OpenMP construct, because it is going to be
 196      remapped during OpenMP lowering.  SHARED is true if DECL
 197      is going to be shared, false if it is going to be privatized.  */
 198   bool (*omp_disregard_value_expr) (tree, bool);
 199
 200   /* Return true if DECL that is shared iff SHARED is true should
 201      be put into OMP_CLAUSE_PRIVATE_DEBUG.  */
 202   bool (*omp_private_debug_clause) (tree, bool);
 203
 204   /* Return true if DECL in private clause needs
 205      OMP_CLAUSE_PRIVATE_OUTER_REF on the private clause.  */
 206   bool (*omp_private_outer_ref) (tree);
 207
 208   /* Build and return code for a default constructor for DECL in
 209      response to CLAUSE.  OUTER is corresponding outer region's
 210      variable if needed.  Return NULL if nothing to be done.  */
 211   tree (*omp_clause_default_ctor) (tree clause, tree decl, tree outer);
 212
 213   /* Build and return code for a copy constructor from SRC to DST.  */
 214   tree (*omp_clause_copy_ctor) (tree clause, tree dst, tree src);
 215
 216   /* Similarly, except use an assignment operator instead.  */
 217   tree (*omp_clause_assign_op) (tree clause, tree dst, tree src);
 218
 219   /* Build and return code destructing DECL.  Return NULL if nothing
 220      to be done.  */
 221   tree (*omp_clause_dtor) (tree clause, tree decl);
 222
 223   /* Do language specific checking on an implicitly determined clause.  */
 224   void (*omp_finish_clause) (tree clause);
 225 };
 226
 227 /* Lang hooks for LIPO.  */
 228
 229 struct lang_hooks_for_lipo
 230 {
 231   /* Add DECL to the list of predefined builtins.  */
 232   void (*add_built_in_decl) (tree decl);
 233
 234   /* Save the tree (by making a copy) and binding values
 235      for builtins before parsing start.  */
 236   void (*save_built_in_decl_pre_parsing) (void);
 237
 238   /* Restore builtins and their bindings to their values
 239      before parsing. */
 240   void (*restore_built_in_decl_pre_parsing) (void);
 241
 242   /* Save the tree (by making a copy) and binding values for
 243      builtins after parsing of a file.  */
 244   void (*save_built_in_decl_post_module_parsing) (void);
 245
 246   /* Restore builtins and their bindings to their post
 247      parsing values.  */
 248   void (*restore_built_in_decl_post_module_parsing) (void);
 249
 250   /* Clear symbol binding for name ID. */
 251   void (*clear_global_name_bindings) (tree id);
 252
 253   /* Return true if DECL in SCOPE is scoped in global/namespace scope,
 254      otherwise return false. */
 255   bool (*has_global_name) (tree decl, void *scope);
 256
 257   /* Return the actual size of the lang_decl struct for
 258      decl T.  */
 259   int (*get_lang_decl_size) (tree t);
 260
 261   /* Duplicate language specific type information from SRC
 262    to DEST.  */
 263   void (*dup_lang_type) (tree src, tree dest);
 264
 265   /* Copy DEST into SRC.  */
 266   void (*copy_lang_type) (tree src, tree dest);
 267
 268   /* Process decls after parsing of a source module.  */
 269   void (*process_pending_decls) (unsigned);
 270
 271   /* Clear the list of deferred functions.  */
 272   void (*clear_deferred_fns) (void);
 273
 274   /* Return true if T is compiler generated.  */
 275   bool (*is_compiler_generated_type) (tree t);
 276
 277   /* Compare language specific types T1 and T2.
 278      Return 1 if they are compatible.  */
 279   int (*cmp_lang_type) (tree t1, tree t2);
 280 };
 281
 282 /* Language hooks related to LTO serialization.  */
 283
 284 struct lang_hooks_for_lto
 285 {
 286   /* Begin a new LTO section named NAME.  */
 287   void (*begin_section) (const char *name);
 288
 289   /* Write DATA of length LEN to the currently open LTO section.  BLOCK is a
 290      pointer to the dynamically allocated memory containing DATA.  The
 291      append_data function is responsible for freeing it when it is no longer
 292      needed.  */
 293   void (*append_data) (const void *data, size_t len, void *block);
 294
 295   /* End the previously begun LTO section.  */
 296   void (*end_section) (void);
 297 };
 298
 299 /* Language-specific hooks.  See langhooks-def.h for defaults.  */
 300
 301 struct lang_hooks
 302 {
 303   /* String identifying the front end.  e.g. "GNU C++".  */
 304   const char *name;
 305
 306   /* sizeof (struct lang_identifier), so make_node () creates
 307      identifier nodes long enough for the language-specific slots.  */
 308   size_t identifier_size;
 309
 310   /* Remove any parts of the tree that are used only by the FE. */
 311   void (*free_lang_data) (tree);
 312
 313   /* Determines the size of any language-specific tcc_constant or
 314      tcc_exceptional nodes.  Since it is called from make_node, the
 315      only information available is the tree code.  Expected to die
 316      on unrecognized codes.  */
 317   size_t (*tree_size) (enum tree_code);
 318
 319   /* Return the language mask used for converting argv into a sequence
 320      of options.  */
 321   unsigned int (*option_lang_mask) (void);
 322
 323   /* Initialize variables in an options structure.  */
 324   void (*init_options_struct) (struct gcc_options *opts);
 325
 326   /* After the initialize_diagnostics hook is called, do any simple
 327      initialization needed before any calls to handle_option, other
 328      than that done by the init_options_struct hook.  */
 329   void (*init_options) (unsigned int decoded_options_count,
 330                         struct cl_decoded_option *decoded_options);
 331
 332   /* Callback used to perform language-specific initialization for the
 333      global diagnostic context structure.  */
 334   void (*initialize_diagnostics) (diagnostic_context *);
 335
 336   /* Return true if a warning should be given about option OPTION,
 337      which is for the wrong language, false if it should be quietly
 338      ignored.  */
 339   bool (*complain_wrong_lang_p) (const struct cl_option *option);
 340
 341   /* Handle the switch CODE, which has real type enum opt_code from
 342      options.h.  If the switch takes an argument, it is passed in ARG
 343      which points to permanent storage.  The handler is responsible for
 344      checking whether ARG is NULL, which indicates that no argument
 345      was in fact supplied.  For -f and -W switches, VALUE is 1 or 0
 346      for the positive and negative forms respectively.  HANDLERS should
 347      be passed to any recursive handle_option calls.  LOC is the
 348      location of the option.
 349
 350      Return true if the switch is valid, false if invalid.  */
 351   bool (*handle_option) (size_t code, const char *arg, int value, int kind,
 352                          location_t loc,
 353                          const struct cl_option_handlers *handlers);
 354
 355   /* Called when all command line options have been parsed to allow
 356      further processing and initialization
 357
 358      Should return true to indicate that a compiler back-end is
 359      not required, such as with the -E option.
 360
 361      If errorcount is nonzero after this call the compiler exits
 362      immediately and the finish hook is not called.  */
 363   bool (*post_options) (const char **);
 364
 365   /* Called after post_options to initialize the front end.  Return
 366      false to indicate that no further compilation be performed, in
 367      which case the finish hook is called immediately.  */
 368   bool (*init) (void);
 369
 370   /* Called at the end of compilation, as a finalizer.  */
 371   void (*finish) (void);
 372
 373   /* Parses the entire file.  */
 374   void (*parse_file) (void);
 375
 376   /* Determines if it's ok for a function to have no noreturn attribute.  */
 377   bool (*missing_noreturn_ok_p) (tree);
 378
 379   /* Called to obtain the alias set to be used for an expression or type.
 380      Returns -1 if the language does nothing special for it.  */
 381   alias_set_type (*get_alias_set) (tree);
 382
 383   /* Function to finish handling an incomplete decl at the end of
 384      compilation.  Default hook is does nothing.  */
 385   void (*finish_incomplete_decl) (tree);
 386
 387   /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the
 388      DECL_NODE with a newly GC-allocated copy.  */
 389   void (*dup_lang_specific_decl) (tree);
 390
 391   /* Set the DECL_ASSEMBLER_NAME for a node.  If it is the sort of
 392      thing that the assembler should talk about, set
 393      DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE.
 394      Otherwise, set it to the ERROR_MARK_NODE to ensure that the
 395      assembler does not talk about it.  */
 396   void (*set_decl_assembler_name) (tree);
 397
 398   /* The front end can add its own statistics to -fmem-report with
 399      this hook.  It should output to stderr.  */
 400   void (*print_statistics) (void);
 401
 402   /* Called by print_tree when there is a tree of class tcc_exceptional
 403      that it doesn't know how to display.  */
 404   lang_print_tree_hook print_xnode;
 405
 406   /* Called to print language-dependent parts of tcc_decl, tcc_type,
 407      and IDENTIFIER_NODE nodes.  */
 408   lang_print_tree_hook print_decl;
 409   lang_print_tree_hook print_type;
 410   lang_print_tree_hook print_identifier;
 411
 412   /* Computes the name to use to print a declaration.  DECL is the
 413      non-NULL declaration in question.  VERBOSITY determines what
 414      information will be printed: 0: DECL_NAME, demangled as
 415      necessary.  1: and scope information.  2: and any other
 416      information that might be interesting, such as function parameter
 417      types in C++.  The name is in the internal character set and
 418      needs to be converted to the locale character set of diagnostics,
 419      or to the execution character set for strings such as
 420      __PRETTY_FUNCTION__.  */
 421   const char *(*decl_printable_name) (tree decl, int verbosity);
 422
 423   /* Computes the dwarf-2/3 name for a tree.  VERBOSITY determines what
 424      information will be printed: 0: DECL_NAME, demangled as
 425      necessary.  1: and scope information.  */
 426   const char *(*dwarf_name) (tree, int verbosity);
 427
 428   /* This compares two types for equivalence ("compatible" in C-based languages).
 429      This routine should only return 1 if it is sure.  It should not be used
 430      in contexts where erroneously returning 0 causes problems.  */
 431   int (*types_compatible_p) (tree x, tree y);
 432
 433   /* Called by report_error_function to print out function name.  */
 434   void (*print_error_function) (diagnostic_context *, const char *,
 435                                 struct diagnostic_info *);
 436
 437   /* Convert a character from the host's to the target's character
 438      set.  The character should be in what C calls the "basic source
 439      character set" (roughly, the set of characters defined by plain
 440      old ASCII).  The default is to return the character unchanged,
 441      which is correct in most circumstances.  Note that both argument
 442      and result should be sign-extended under -fsigned-char,
 443      zero-extended under -fno-signed-char.  */
 444   HOST_WIDE_INT (*to_target_charset) (HOST_WIDE_INT);
 445
 446   /* Pointers to machine-independent attribute tables, for front ends
 447      using attribs.c.  If one is NULL, it is ignored.  Respectively, a
 448      table of attributes specific to the language, a table of
 449      attributes common to two or more languages (to allow easy
 450      sharing), and a table of attributes for checking formats.  */
 451   const struct attribute_spec *attribute_table;
 452   const struct attribute_spec *common_attribute_table;
 453   const struct attribute_spec *format_attribute_table;
 454
 455   struct lang_hooks_for_tree_inlining tree_inlining;
 456
 457   struct lang_hooks_for_tree_dump tree_dump;
 458
 459   struct lang_hooks_for_decls decls;
 460
 461   struct lang_hooks_for_types types;
 462
 463   struct lang_hooks_for_lipo l_ipo;
 464
 465   struct lang_hooks_for_lto lto;
 466
 467   /* Returns a TREE_VEC of the generic parameters of an instantiation of
 468      a generic type or decl, e.g. C++ template instantiation.  If
 469      TREE_CHAIN of the return value is set, it is an INTEGER_CST
 470      indicating how many of the elements are non-default.  */
 471   tree (*get_innermost_generic_parms) (const_tree);
 472
 473   /* Returns the TREE_VEC of arguments of an instantiation
 474      of a generic type of decl, e.g. C++ template instantiation.  */
 475   tree (*get_innermost_generic_args) (const_tree);
 476
 477   /* Determine if a tree is a function parameter pack.  */
 478   bool (*function_parameter_pack_p) (const_tree);
 479
 480   /* Perform language-specific gimplification on the argument.  Returns an
 481      enum gimplify_status, though we can't see that type here.  */
 482   int (*gimplify_expr) (tree *, gimple_seq *, gimple_seq *);
 483
 484   /* Do language specific processing in the builtin function DECL  */
 485   tree (*builtin_function) (tree decl);
 486
 487   /* Like builtin_function, but make sure the scope is the external scope.
 488      This is used to delay putting in back end builtin functions until the ISA
 489      that defines the builtin is declared via function specific target options,
 490      which can save memory for machines like the x86_64 that have multiple
 491      ISAs.  If this points to the same function as builtin_function, the
 492      backend must add all of the builtins at program initialization time.  */
 493   tree (*builtin_function_ext_scope) (tree decl);
 494
 495   /* Returns true if DECL is a user defined conversion operator (C++) */
 496   bool (*user_conv_function_p) (tree decl);
 497
 498   /* Used to set up the tree_contains_structure array for a frontend. */
 499   void (*init_ts) (void);
 500
 501   /* Called by recompute_tree_invariant_for_addr_expr to go from EXPR
 502      to a contained expression or DECL, possibly updating *TC or *SE
 503      if in the process TREE_CONSTANT or TREE_SIDE_EFFECTS need updating.  */
 504   tree (*expr_to_decl) (tree expr, bool *tc, bool *se);
 505
 506   /* The EH personality function decl.  */
 507   tree (*eh_personality) (void);
 508
 509   /* Map a type to a runtime object to match type.  */
 510   tree (*eh_runtime_type) (tree);
 511
 512   /* If non-NULL, this is a function that returns a function decl to be
 513      executed if an unhandled exception is propagated out of a cleanup
 514      region.  For example, in C++, an exception thrown by a destructor
 515      during stack unwinding is required to result in a call to
 516      `std::terminate', so the C++ version of this function returns a
 517      FUNCTION_DECL for `std::terminate'.  */
 518   tree (*eh_protect_cleanup_actions) (void);
 519
 520   /* Return true if a stmt can fallthru.  Used by block_may_fallthru
 521      to possibly handle language trees.  */
 522   bool (*block_may_fallthru) (const_tree);
 523
 524   /* True if this language uses __cxa_end_cleanup when the ARM EABI
 525      is enabled.  */
 526   bool eh_use_cxa_end_cleanup;
 527
 528   /* True if this language requires deep unsharing of tree nodes prior to
 529      gimplification.  */
 530   bool deep_unsharing;
 531
 532   /* Whenever you add entries here, make sure you adjust langhooks-def.h
 533      and langhooks.c accordingly.  */
 534 };
 535
 536 /* Each front end provides its own.  */
 537 extern struct lang_hooks lang_hooks;
 538
 539 extern tree add_builtin_function (const char *name, tree type,
 540                                   int function_code, enum built_in_class cl,
 541                                   const char *library_name,
 542                                   tree attrs);
 543
 544 extern tree add_builtin_function_ext_scope (const char *name, tree type,
 545                                             int function_code,
 546                                             enum built_in_class cl,
 547                                             const char *library_name,
 548                                             tree attrs);
 549 extern tree add_builtin_type (const char *name, tree type);
 550
 551 #endif /* GCC_LANG_HOOKS_H */