gcc/langhooks.h

   1 /* The lang_hooks data structure.
   2    Copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007
   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_context;
  27 struct diagnostic_info;
  28
  29 struct gimplify_omp_ctx;
  30
  31 struct array_descr_info;
  32
  33 /* A print hook for print_tree ().  */
  34 typedef void (*lang_print_tree_hook) (FILE *, tree, int indent);
  35
  36 /* The following hooks are documented in langhooks.c.  Must not be
  37    NULL.  */
  38
  39 struct lang_hooks_for_tree_inlining
  40 {
  41   bool (*var_mod_type_p) (tree, tree);
  42 };
  43
  44 struct lang_hooks_for_callgraph
  45 {
  46   /* The node passed is a language-specific tree node.  If its contents
  47      are relevant to use of other declarations, mark them.  */
  48   tree (*analyze_expr) (tree *, int *);
  49
  50   /* Emit thunks associated to function.  */
  51   void (*emit_associated_thunks) (tree);
  52 };
  53
  54 /* Lang hooks for management of language-specific data or status
  55    when entering / leaving functions etc.  */
  56 struct lang_hooks_for_functions
  57 {
  58   /* Called when entering a function.  */
  59   void (*init) (struct function *);
  60
  61   /* Called when leaving a function.  */
  62   void (*final) (struct function *);
  63
  64   /* Called when entering a nested function.  */
  65   void (*enter_nested) (struct function *);
  66
  67   /* Called when leaving a nested function.  */
  68   void (*leave_nested) (struct function *);
  69
  70   /* Determines if it's ok for a function to have no noreturn attribute.  */
  71   bool (*missing_noreturn_ok_p) (tree);
  72 };
  73
  74 /* The following hooks are used by tree-dump.c.  */
  75
  76 struct lang_hooks_for_tree_dump
  77 {
  78   /* Dump language-specific parts of tree nodes.  Returns nonzero if it
  79      does not want the usual dumping of the second argument.  */
  80   bool (*dump_tree) (void *, tree);
  81
  82   /* Determine type qualifiers in a language-specific way.  */
  83   int (*type_quals) (const_tree);
  84 };
  85
  86 /* Hooks related to types.  */
  87
  88 struct lang_hooks_for_types
  89 {
  90   /* Return a new type (with the indicated CODE), doing whatever
  91      language-specific processing is required.  */
  92   tree (*make_type) (enum tree_code);
  93
  94   /* Given MODE and UNSIGNEDP, return a suitable type-tree with that
  95      mode.  */
  96   tree (*type_for_mode) (enum machine_mode, int);
  97
  98   /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an
  99      integer type with at least that precision.  */
 100   tree (*type_for_size) (unsigned, int);
 101
 102   /* True if the type is an instantiation of a generic type,
 103      e.g. C++ template implicit specializations.  */
 104   bool (*generic_p) (const_tree);
 105
 106   /* Given a type, apply default promotions to unnamed function
 107      arguments and return the new type.  Return the same type if no
 108      change.  Required by any language that supports variadic
 109      arguments.  The default hook dies.  */
 110   tree (*type_promotes_to) (tree);
 111
 112   /* Register TYPE as a builtin type with the indicated NAME.  The
 113      TYPE is placed in the outermost lexical scope.  The semantics
 114      should be analogous to:
 115
 116        typedef TYPE NAME;
 117
 118      in C.  The default hook ignores the declaration.  */
 119   void (*register_builtin_type) (tree, const char *);
 120
 121   /* This routine is called in tree.c to print an error message for
 122      invalid use of an incomplete type.  VALUE is the expression that
 123      was used (or 0 if that isn't known) and TYPE is the type that was
 124      invalid.  */
 125   void (*incomplete_type_error) (const_tree value, const_tree type);
 126
 127   /* Called from assign_temp to return the maximum size, if there is one,
 128      for a type.  */
 129   tree (*max_size) (const_tree);
 130
 131   /* Register language specific type size variables as potentially OpenMP
 132      firstprivate variables.  */
 133   void (*omp_firstprivatize_type_sizes) (struct gimplify_omp_ctx *, tree);
 134
 135   /* Return TRUE if TYPE1 and TYPE2 are identical for type hashing purposes.
 136      Called only after doing all language independent checks.
 137      At present, this function is only called when both TYPE1 and TYPE2 are
 138      FUNCTION_TYPEs.  */
 139   bool (*type_hash_eq) (const_tree, const_tree);
 140
 141   /* Return TRUE if TYPE uses a hidden descriptor and fills in information
 142      for the debugger about the array bounds, strides, etc.  */
 143   bool (*get_array_descr_info) (const_tree, struct array_descr_info *);
 144
 145   /* Nonzero if types that are identical are to be hashed so that only
 146      one copy is kept.  If a language requires unique types for each
 147      user-specified type, such as Ada, this should be set to TRUE.  */
 148   bool hash_types;
 149 };
 150
 151 /* Language hooks related to decls and the symbol table.  */
 152
 153 struct lang_hooks_for_decls
 154 {
 155   /* Returns nonzero if we are in the global binding level.  Ada
 156      returns -1 for an undocumented reason used in stor-layout.c.  */
 157   int (*global_bindings_p) (void);
 158
 159   /* Insert BLOCK at the end of the list of subblocks of the
 160      current binding level.  This is used when a BIND_EXPR is expanded,
 161      to handle the BLOCK node inside the BIND_EXPR.  */
 162   void (*insert_block) (tree);
 163
 164   /* Function to add a decl to the current scope level.  Takes one
 165      argument, a decl to add.  Returns that decl, or, if the same
 166      symbol is already declared, may return a different decl for that
 167      name.  */
 168   tree (*pushdecl) (tree);
 169
 170   /* Returns the chain of decls so far in the current scope level.  */
 171   tree (*getdecls) (void);
 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   /* Return the COMDAT group into which this DECL should be placed.
 185      It is known that the DECL belongs in *some* COMDAT group when
 186      this hook is called.  The return value will be used immediately,
 187      but not explicitly deallocated, so implementations should not use
 188      xmalloc to allocate the string returned.  (Typically, the return
 189      value will be the string already stored in an
 190      IDENTIFIER_NODE.)  */
 191   const char * (*comdat_group) (tree);
 192
 193   /* True if OpenMP should privatize what this DECL points to rather
 194      than the DECL itself.  */
 195   bool (*omp_privatize_by_reference) (const_tree);
 196
 197   /* Return sharing kind if OpenMP sharing attribute of DECL is
 198      predetermined, OMP_CLAUSE_DEFAULT_UNSPECIFIED otherwise.  */
 199   enum omp_clause_default_kind (*omp_predetermined_sharing) (tree);
 200
 201   /* Return true if DECL's DECL_VALUE_EXPR (if any) should be
 202      disregarded in OpenMP construct, because it is going to be
 203      remapped during OpenMP lowering.  SHARED is true if DECL
 204      is going to be shared, false if it is going to be privatized.  */
 205   bool (*omp_disregard_value_expr) (tree, bool);
 206
 207   /* Return true if DECL that is shared iff SHARED is true should
 208      be put into OMP_CLAUSE_PRIVATE_DEBUG.  */
 209   bool (*omp_private_debug_clause) (tree, bool);
 210
 211   /* Build and return code for a default constructor for DECL in
 212      response to CLAUSE.  Return NULL if nothing to be done.  */
 213   tree (*omp_clause_default_ctor) (tree clause, tree decl);
 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
 226 /* Language-specific hooks.  See langhooks-def.h for defaults.  */
 227
 228 struct lang_hooks
 229 {
 230   /* String identifying the front end.  e.g. "GNU C++".  */
 231   const char *name;
 232
 233   /* sizeof (struct lang_identifier), so make_node () creates
 234      identifier nodes long enough for the language-specific slots.  */
 235   size_t identifier_size;
 236
 237   /* Determines the size of any language-specific tcc_constant or
 238      tcc_exceptional nodes.  Since it is called from make_node, the
 239      only information available is the tree code.  Expected to die
 240      on unrecognized codes.  */
 241   size_t (*tree_size) (enum tree_code);
 242
 243   /* The first callback made to the front end, for simple
 244      initialization needed before any calls to handle_option.  Return
 245      the language mask to filter the switch array with.  */
 246   unsigned int (*init_options) (unsigned int argc, const char **argv);
 247
 248   /* Callback used to perform language-specific initialization for the
 249      global diagnostic context structure.  */
 250   void (*initialize_diagnostics) (struct diagnostic_context *);
 251
 252   /* Handle the switch CODE, which has real type enum opt_code from
 253      options.h.  If the switch takes an argument, it is passed in ARG
 254      which points to permanent storage.  The handler is responsible for
 255      checking whether ARG is NULL, which indicates that no argument
 256      was in fact supplied.  For -f and -W switches, VALUE is 1 or 0
 257      for the positive and negative forms respectively.
 258
 259      Return 1 if the switch is valid, 0 if invalid, and -1 if it's
 260      valid and should not be treated as language-independent too.  */
 261   int (*handle_option) (size_t code, const char *arg, int value);
 262
 263   /* Return false to use the default complaint about a missing
 264      argument, otherwise output a complaint and return true.  */
 265   bool (*missing_argument) (const char *opt, size_t code);
 266
 267   /* Called when all command line options have been parsed to allow
 268      further processing and initialization
 269
 270      Should return true to indicate that a compiler back-end is
 271      not required, such as with the -E option.
 272
 273      If errorcount is nonzero after this call the compiler exits
 274      immediately and the finish hook is not called.  */
 275   bool (*post_options) (const char **);
 276
 277   /* Called after post_options to initialize the front end.  Return
 278      false to indicate that no further compilation be performed, in
 279      which case the finish hook is called immediately.  */
 280   bool (*init) (void);
 281
 282   /* Called at the end of compilation, as a finalizer.  */
 283   void (*finish) (void);
 284
 285   /* Parses the entire file.  The argument is nonzero to cause bison
 286      parsers to dump debugging information during parsing.  */
 287   void (*parse_file) (int);
 288
 289   /* Called immediately after parsing to clear the binding stack.  */
 290   void (*clear_binding_stack) (void);
 291
 292   /* Called to obtain the alias set to be used for an expression or type.
 293      Returns -1 if the language does nothing special for it.  */
 294   alias_set_type (*get_alias_set) (tree);
 295
 296   /* Called by expand_expr for language-specific tree codes.
 297      Fourth argument is actually an enum expand_modifier.  */
 298   rtx (*expand_expr) (tree, rtx, enum machine_mode, int, rtx *);
 299
 300   /* Called by expand_expr to generate the definition of a decl.  Returns
 301      1 if handled, 0 otherwise.  */
 302   int (*expand_decl) (tree);
 303
 304   /* Function to finish handling an incomplete decl at the end of
 305      compilation.  Default hook is does nothing.  */
 306   void (*finish_incomplete_decl) (tree);
 307
 308   /* Mark EXP saying that we need to be able to take the address of
 309      it; it should not be allocated in a register.  Return true if
 310      successful.  */
 311   bool (*mark_addressable) (tree);
 312
 313   /* Hook called by staticp for language-specific tree codes.  */
 314   tree (*staticp) (tree);
 315
 316   /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the
 317      DECL_NODE with a newly GC-allocated copy.  */
 318   void (*dup_lang_specific_decl) (tree);
 319
 320   /* Set the DECL_ASSEMBLER_NAME for a node.  If it is the sort of
 321      thing that the assembler should talk about, set
 322      DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE.
 323      Otherwise, set it to the ERROR_MARK_NODE to ensure that the
 324      assembler does not talk about it.  */
 325   void (*set_decl_assembler_name) (tree);
 326
 327   /* Nonzero if operations on types narrower than their mode should
 328      have their results reduced to the precision of the type.  */
 329   bool reduce_bit_field_operations;
 330
 331   /* Nonzero if this front end does not generate a dummy BLOCK between
 332      the outermost scope of the function and the FUNCTION_DECL.  See
 333      is_body_block in stmt.c, and its callers.  */
 334   bool no_body_blocks;
 335
 336   /* The front end can add its own statistics to -fmem-report with
 337      this hook.  It should output to stderr.  */
 338   void (*print_statistics) (void);
 339
 340   /* Called by print_tree when there is a tree of class tcc_exceptional
 341      that it doesn't know how to display.  */
 342   lang_print_tree_hook print_xnode;
 343
 344   /* Called to print language-dependent parts of tcc_decl, tcc_type,
 345      and IDENTIFIER_NODE nodes.  */
 346   lang_print_tree_hook print_decl;
 347   lang_print_tree_hook print_type;
 348   lang_print_tree_hook print_identifier;
 349
 350   /* Computes the name to use to print a declaration.  DECL is the
 351      non-NULL declaration in question.  VERBOSITY determines what
 352      information will be printed: 0: DECL_NAME, demangled as
 353      necessary.  1: and scope information.  2: and any other
 354      information that might be interesting, such as function parameter
 355      types in C++.  */
 356   const char *(*decl_printable_name) (tree decl, int verbosity);
 357
 358   /* Computes the dwarf-2/3 name for a tree.  VERBOSITY determines what
 359      information will be printed: 0: DECL_NAME, demangled as
 360      necessary.  1: and scope information.  */
 361   const char *(*dwarf_name) (tree, int verbosity);
 362
 363   /* This compares two types for equivalence ("compatible" in C-based languages).
 364      This routine should only return 1 if it is sure.  It should not be used
 365      in contexts where erroneously returning 0 causes problems.  */
 366   int (*types_compatible_p) (tree x, tree y);
 367
 368   /* Given a CALL_EXPR, return a function decl that is its target.  */
 369   tree (*lang_get_callee_fndecl) (const_tree);
 370
 371   /* Called by report_error_function to print out function name.  */
 372   void (*print_error_function) (struct diagnostic_context *, const char *,
 373                                 struct diagnostic_info *);
 374
 375   /* Called from expr_size to calculate the size of the value of an
 376      expression in a language-dependent way.  Returns a tree for the size
 377      in bytes.  A frontend can call lhd_expr_size to get the default
 378      semantics in cases that it doesn't want to handle specially.  */
 379   tree (*expr_size) (const_tree);
 380
 381   /* Convert a character from the host's to the target's character
 382      set.  The character should be in what C calls the "basic source
 383      character set" (roughly, the set of characters defined by plain
 384      old ASCII).  The default is to return the character unchanged,
 385      which is correct in most circumstances.  Note that both argument
 386      and result should be sign-extended under -fsigned-char,
 387      zero-extended under -fno-signed-char.  */
 388   HOST_WIDE_INT (*to_target_charset) (HOST_WIDE_INT);
 389
 390   /* Pointers to machine-independent attribute tables, for front ends
 391      using attribs.c.  If one is NULL, it is ignored.  Respectively, a
 392      table of attributes specific to the language, a table of
 393      attributes common to two or more languages (to allow easy
 394      sharing), and a table of attributes for checking formats.  */
 395   const struct attribute_spec *attribute_table;
 396   const struct attribute_spec *common_attribute_table;
 397   const struct attribute_spec *format_attribute_table;
 398
 399   /* Function-related language hooks.  */
 400   struct lang_hooks_for_functions function;
 401
 402   struct lang_hooks_for_tree_inlining tree_inlining;
 403
 404   struct lang_hooks_for_callgraph callgraph;
 405
 406   struct lang_hooks_for_tree_dump tree_dump;
 407
 408   struct lang_hooks_for_decls decls;
 409
 410   struct lang_hooks_for_types types;
 411
 412   /* Perform language-specific gimplification on the argument.  Returns an
 413      enum gimplify_status, though we can't see that type here.  */
 414   int (*gimplify_expr) (tree *, tree *, tree *);
 415
 416   /* Fold an OBJ_TYPE_REF expression to the address of a function.
 417      KNOWN_TYPE carries the true type of the OBJ_TYPE_REF_OBJECT.  */
 418   tree (*fold_obj_type_ref) (tree, tree);
 419
 420   /* Do language specific processing in the builtin function DECL  */
 421   tree (*builtin_function) (tree decl);
 422
 423   /* Used to set up the tree_contains_structure array for a frontend. */
 424   void (*init_ts) (void);
 425
 426   /* Called by recompute_tree_invariant_for_addr_expr to go from EXPR
 427      to a contained expression or DECL, possibly updating *TC, *TI or
 428      *SE if in the process TREE_CONSTANT, TREE_INVARIANT or
 429      TREE_SIDE_EFFECTS need updating.  */
 430   tree (*expr_to_decl) (tree expr, bool *tc, bool *ti, bool *se);
 431
 432   /* Whenever you add entries here, make sure you adjust langhooks-def.h
 433      and langhooks.c accordingly.  */
 434 };
 435
 436 /* Each front end provides its own.  */
 437 extern const struct lang_hooks lang_hooks;
 438 extern tree add_builtin_function (const char *name, tree type,
 439                                   int function_code, enum built_in_class cl,
 440                                   const char *library_name,
 441                                   tree attrs);
 442
 443 #endif /* GCC_LANG_HOOKS_H */