gcc/langhooks.h

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