gcc/target.def

   1 /* Target hook definitions.
   2    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
   3    Free Software Foundation, Inc.
   4
   5    This program is free software; you can redistribute it and/or modify it
   6    under the terms of the GNU General Public License as published by the
   7    Free Software Foundation; either version 3, or (at your option) any
   8    later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; see the file COPYING3.  If not see
  17    <http://www.gnu.org/licenses/>.
  18
  19    In other words, you are welcome to use, share and improve this program.
  20    You are forbidden to forbid anyone else to use, share and improve
  21    what you give them.   Help stamp out software-hoarding!  */
  22
  23 /* The following macros should be provided by the including file:
  24
  25    DEFHOOK(NAME, DOC, TYPE, PARAMS, INIT): Define a function-valued hook.
  26    DEFHOOKPOD(DOC, TYPE, NAME, INIT): Define a piece-of-data 'hook'.  */
  27
  28 /* Defaults for optional macros:
  29    DEFHOOKPODX(NAME, TYPE, INIT): Like DEFHOOKPOD, but share documentation
  30    with the previous 'hook'.  */
  31 #ifndef DEFHOOKPODX
  32 #define DEFHOOKPODX(NAME, TYPE, INIT) DEFHOOKPOD (NAME, 0, TYPE, INIT)
  33 #endif
  34
  35 /* HOOKSTRUCT(FRAGMENT): Declarator fragments to encapsulate all the
  36    members into a struct gcc_target, which in turn contains several
  37    sub-structs.  */
  38 #ifndef HOOKSTRUCT
  39 #define HOOKSTRUCT(FRAGMENT)
  40 #endif
  41 /* HOOK_VECTOR: Start a struct declaration, which then gets its own initializer.
  42    HOOK_VECTOR_END: Close a struct declaration, providing a member declarator
  43                     name for nested use.  */
  44 #ifndef HOOK_VECTOR_1
  45 #define HOOK_VECTOR_1(NAME, FRAGMENT) HOOKSTRUCT(FRAGMENT)
  46 #endif
  47 #define HOOK_VECTOR(INIT_NAME, SNAME) HOOK_VECTOR_1 (INIT_NAME, struct SNAME {)
  48 #define HOOK_VECTOR_END(DECL_NAME) HOOK_VECTOR_1(,} DECL_NAME ;)
  49
  50 HOOK_VECTOR (TARGET_INITIALIZER, gcc_target)
  51
  52 /* FIXME: For pre-existing hooks, we can't place the documentation in the
  53    documentation field here till we get permission from the FSF to include
  54    it in GPLed software - the target hook documentation is so far only
  55    available under the GFDL.  */
  56
  57 /* A hook should generally be documented by a string in the DOC parameter,
  58    which should contain texinfo markup.  If the documentation is only available
  59    under the GPL, but not under the GFDL, put it in a comment above the hook
  60    definition.  If the function declaration is available both under GPL and
  61    GFDL, but the documentation is only available under the GFDL, put the
  62    documentaton in tm.texi.in, heading with @hook <hookname> and closing
  63    the paragraph with @end deftypefn / deftypevr as appropriate, and marking
  64    the next autogenerated hook with @hook <hookname>.
  65    In both these cases, leave the DOC string empty, i.e. "".
  66    Sometimes, for some historic reason the function declaration
  67    has to be documented differently
  68    than what it is.  In that case, use DEFHOOK_UNDOC to supress auto-generation
  69    of documentation.  DEFHOOK_UNDOC takes a DOC string which it ignores, so
  70    you can put GPLed documentation string there if you have hopes that you
  71    can clear the declaration & documentation for GFDL distribution later,
  72    in which case you can then simply change the DEFHOOK_UNDOC to DEFHOOK
  73    to turn on the autogeneration of the documentation.
  74
  75    A documentation string of "*" means not to emit any documentation at all,
  76    and is mainly used internally for DEFHOOK_UNDOC.  It should generally not
  77    be used otherwise, but it has its use for exceptional cases where automatic
  78    documentation is not wanted, and the real documentation is elsewere, like
  79    for TARGET_ASM_{,UN}ALIGNED_INT_OP, which are hooks only for implementation
  80    purposes; they refer to structs, the components of which are documented as
  81    separate hooks TARGET_ASM_{,UN}ALIGNED_[HSDT]I_OP.
  82    A DOC string of 0 is for internal use of DEFHOOKPODX and special table
  83    entries only.  */
  84
  85 /* Functions that output assembler for the target.  */
  86 #define HOOK_PREFIX "TARGET_ASM_"
  87 HOOK_VECTOR (TARGET_ASM_OUT, asm_out)
  88
  89 /* Opening and closing parentheses for asm expression grouping.  */
  90 DEFHOOKPOD
  91 (open_paren,
  92  "",
  93  const char *, "(")
  94 DEFHOOKPODX (close_paren, const char *, ")")
  95
  96 /* Assembler instructions for creating various kinds of integer object.  */
  97 DEFHOOKPOD
  98 (byte_op,
  99  "",
 100  const char *, "\t.byte\t")
 101 DEFHOOKPOD (aligned_op, "*", struct asm_int_op, TARGET_ASM_ALIGNED_INT_OP)
 102 DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
 103
 104 /* The maximum number of bytes to skip when applying
 105    LABEL_ALIGN_AFTER_BARRIER.  */
 106 DEFHOOK
 107 (label_align_after_barrier_max_skip,
 108  "",
 109  int, (rtx label),
 110  default_label_align_after_barrier_max_skip)
 111
 112 /* The maximum number of bytes to skip when applying
 113    LOOP_ALIGN.  */
 114 DEFHOOK
 115 (loop_align_max_skip,
 116  "",
 117  int, (rtx label),
 118  default_loop_align_max_skip)
 119
 120 /* The maximum number of bytes to skip when applying
 121    LABEL_ALIGN.  */
 122 DEFHOOK
 123 (label_align_max_skip,
 124  "",
 125  int, (rtx label),
 126  default_label_align_max_skip)
 127
 128 /* The maximum number of bytes to skip when applying
 129    JUMP_ALIGN.  */
 130 DEFHOOK
 131 (jump_align_max_skip,
 132  "",
 133  int, (rtx label),
 134  default_jump_align_max_skip)
 135
 136 /* Try to output the assembler code for an integer object whose
 137    value is given by X.  SIZE is the size of the object in bytes and
 138    ALIGNED_P indicates whether it is aligned.  Return true if
 139    successful.  Only handles cases for which BYTE_OP, ALIGNED_OP
 140    and UNALIGNED_OP are NULL.  */
 141 DEFHOOK
 142 (integer,
 143  "",
 144  /* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
 145     NULL.  */
 146  bool, (rtx x, unsigned int size, int aligned_p),
 147  default_assemble_integer)
 148
 149 /* Output code that will globalize a label.  */
 150 DEFHOOK
 151 (globalize_label,
 152  "",
 153  void, (FILE *stream, const char *name),
 154  default_globalize_label)
 155
 156 /* Output code that will globalize a declaration.  */
 157 DEFHOOK
 158 (globalize_decl_name,
 159  "",
 160  void, (FILE *stream, tree decl), default_globalize_decl_name)
 161
 162 /* Output code that will emit a label for unwind info, if this
 163    target requires such labels.  Second argument is the decl the
 164    unwind info is associated with, third is a boolean: true if
 165    this is for exception handling, fourth is a boolean: true if
 166    this is only a placeholder for an omitted FDE.  */
 167 DEFHOOK
 168 (emit_unwind_label,
 169  "",
 170  void, (FILE *stream, tree decl, int for_eh, int empty),
 171  default_emit_unwind_label)
 172
 173 /* Output code that will emit a label to divide up the exception table.  */
 174 DEFHOOK
 175 (emit_except_table_label,
 176  "",
 177  void, (FILE *stream),
 178  default_emit_except_table_label)
 179
 180 /* Emit a directive for setting the personality for the function.  */
 181 DEFHOOK
 182 (emit_except_personality,
 183  "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\
 184  used to emit a directive to install a personality hook into the unwind\
 185  info.  This hook should not be used if dwarf2 unwind info is used.",
 186  void, (rtx personality),
 187  NULL)
 188
 189 /* Emit any directives required to unwind this instruction.  */
 190 DEFHOOK
 191 (unwind_emit,
 192  "",
 193  void, (FILE *stream, rtx insn),
 194  NULL)
 195
 196 DEFHOOKPOD
 197 (unwind_emit_before_insn,
 198  "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\
 199  the assembly for @var{insn} has been emitted, false if the hook should\
 200  be called afterward.",
 201  bool, true)
 202
 203 /* Output an internal label.  */
 204 DEFHOOK
 205 (internal_label,
 206  "",
 207  void, (FILE *stream, const char *prefix, unsigned long labelno),
 208  default_internal_label)
 209
 210 /* Output label for the constant.  */
 211 DEFHOOK
 212 (declare_constant_name,
 213  "",
 214  void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
 215  default_asm_declare_constant_name)
 216
 217 /* Emit a ttype table reference to a typeinfo object.  */
 218 DEFHOOK
 219 (ttype,
 220  "",
 221  bool, (rtx sym),
 222  hook_bool_rtx_false)
 223
 224 /* Emit an assembler directive to set visibility for the symbol
 225    associated with the tree decl.  */
 226 DEFHOOK
 227 (assemble_visibility,
 228  "",
 229  void, (tree decl, int visibility),
 230  default_assemble_visibility)
 231
 232 /* Output the assembler code for entry to a function.  */
 233 DEFHOOK
 234 (function_prologue,
 235  "",
 236  void, (FILE *file, HOST_WIDE_INT size),
 237  default_function_pro_epilogue)
 238
 239 /* Output the assembler code for end of prologue.  */
 240 DEFHOOK
 241 (function_end_prologue,
 242  "",
 243  void, (FILE *file),
 244  no_asm_to_stream)
 245
 246 /* Output the assembler code for start of epilogue.  */
 247 DEFHOOK
 248 (function_begin_epilogue,
 249  "",
 250  void, (FILE *file),
 251  no_asm_to_stream)
 252
 253 /* Output the assembler code for function exit.  */
 254 DEFHOOK
 255 (function_epilogue,
 256  "",
 257  void, (FILE *file, HOST_WIDE_INT size),
 258  default_function_pro_epilogue)
 259
 260 /* Initialize target-specific sections.  */
 261 DEFHOOK
 262 (init_sections,
 263  "",
 264  void, (void),
 265  hook_void_void)
 266
 267 /* Tell assembler to change to section NAME with attributes FLAGS.
 268    If DECL is non-NULL, it is the VAR_DECL or FUNCTION_DECL with
 269    which this section is associated.  */
 270 DEFHOOK
 271 (named_section,
 272  "",
 273  void, (const char *name, unsigned int flags, tree decl),
 274  default_no_named_section)
 275
 276 /* Return a mask describing how relocations should be treated when
 277    selecting sections.  Bit 1 should be set if global relocations
 278    should be placed in a read-write section; bit 0 should be set if
 279    local relocations should be placed in a read-write section.  */
 280 DEFHOOK
 281 (reloc_rw_mask,
 282  "",
 283  int, (void),
 284  default_reloc_rw_mask)
 285
 286  /* Return a section for EXP.  It may be a DECL or a constant.  RELOC
 287     is nonzero if runtime relocations must be applied; bit 1 will be
 288     set if the runtime relocations require non-local name resolution.
 289     ALIGN is the required alignment of the data.  */
 290 DEFHOOK
 291 (select_section,
 292  "",
 293  section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
 294  default_select_section)
 295
 296 /* Return a section for X.  MODE is X's mode and ALIGN is its
 297    alignment in bits.  */
 298 DEFHOOK
 299 (select_rtx_section,
 300  "",
 301  section *, (enum machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
 302  default_select_rtx_section)
 303
 304 /* Select a unique section name for DECL.  RELOC is the same as
 305    for SELECT_SECTION.  */
 306 DEFHOOK
 307 (unique_section,
 308  "",
 309  void, (tree decl, int reloc),
 310  default_unique_section)
 311
 312 /* Return the readonly data section associated with function DECL.  */
 313 DEFHOOK
 314 (function_rodata_section,
 315  "",
 316  section *, (tree decl),
 317  default_function_rodata_section)
 318
 319 /* Output a constructor for a symbol with a given priority.  */
 320 DEFHOOK
 321 (constructor,
 322  "",
 323  void, (rtx symbol, int priority), NULL)
 324
 325 /* Output a destructor for a symbol with a given priority.  */
 326 DEFHOOK
 327 (destructor,
 328  "",
 329  void, (rtx symbol, int priority), NULL)
 330
 331 /* Output the assembler code for a thunk function.  THUNK_DECL is the
 332    declaration for the thunk function itself, FUNCTION is the decl for
 333    the target function.  DELTA is an immediate constant offset to be
 334    added to THIS.  If VCALL_OFFSET is nonzero, the word at
 335    *(*this + vcall_offset) should be added to THIS.  */
 336 DEFHOOK
 337 (output_mi_thunk,
 338  "",
 339  void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
 340         HOST_WIDE_INT vcall_offset, tree function),
 341  NULL)
 342
 343 /* Determine whether output_mi_thunk would succeed.  */
 344 /* ??? Ideally, this hook would not exist, and success or failure
 345    would be returned from output_mi_thunk directly.  But there's
 346    too much undo-able setup involved in invoking output_mi_thunk.
 347    Could be fixed by making output_mi_thunk emit rtl instead of
 348    text to the output file.  */
 349 DEFHOOK
 350 (can_output_mi_thunk,
 351  "",
 352  bool, (const_tree thunk_fndecl, HOST_WIDE_INT delta,
 353         HOST_WIDE_INT vcall_offset, const_tree function),
 354  hook_bool_const_tree_hwi_hwi_const_tree_false)
 355
 356 /* Output any boilerplate text needed at the beginning of a
 357    translation unit.  */
 358 DEFHOOK
 359 (file_start,
 360  "",
 361  void, (void),
 362  default_file_start)
 363
 364 /* Output any boilerplate text needed at the end of a translation unit.  */
 365 DEFHOOK
 366 (file_end,
 367  "",
 368  void, (void),
 369  hook_void_void)
 370
 371 /* Output any boilerplate text needed at the beginning of an
 372    LTO output stream.  */
 373 DEFHOOK
 374 (lto_start,
 375  "",
 376  void, (void),
 377  hook_void_void)
 378
 379 /* Output any boilerplate text needed at the end of an
 380    LTO output stream.  */
 381 DEFHOOK
 382 (lto_end,
 383  "",
 384  void, (void),
 385  hook_void_void)
 386
 387 /* Output any boilerplace text needed at the end of a
 388    translation unit before debug and unwind info is emitted.  */
 389 DEFHOOK
 390 (code_end,
 391  "",
 392  void, (void),
 393  hook_void_void)
 394
 395 /* Output an assembler pseudo-op to declare a library function name
 396    external.  */
 397 DEFHOOK
 398 (external_libcall,
 399  "",
 400  void, (rtx symref),
 401  default_external_libcall)
 402
 403 /* Output an assembler directive to mark decl live. This instructs
 404    linker to not dead code strip this symbol.  */
 405 DEFHOOK
 406 (mark_decl_preserved,
 407  "",
 408  void, (const char *symbol),
 409  hook_void_constcharptr)
 410
 411 /* Output a record of the command line switches that have been passed.  */
 412 DEFHOOK
 413 (record_gcc_switches,
 414  "",
 415  int, (print_switch_type type, const char *text),
 416  NULL)
 417
 418 /* The name of the section that the example ELF implementation of
 419    record_gcc_switches will use to store the information.  Target
 420    specific versions of record_gcc_switches may or may not use
 421    this information.  */
 422 DEFHOOKPOD
 423 (record_gcc_switches_section,
 424  "",
 425  const char *, ".GCC.command.line")
 426
 427 /* Output the definition of a section anchor.  */
 428 DEFHOOK
 429 (output_anchor,
 430  "",
 431  void, (rtx x),
 432  default_asm_output_anchor)
 433
 434 /* Output a DTP-relative reference to a TLS symbol.  */
 435 DEFHOOK
 436 (output_dwarf_dtprel,
 437  "",
 438  void, (FILE *file, int size, rtx x),
 439  NULL)
 440
 441 /* Some target machines need to postscan each insn after it is output.  */
 442 DEFHOOK
 443 (final_postscan_insn,
 444  "",
 445  void, (FILE *file, rtx insn, rtx *opvec, int noperands),
 446  NULL)
 447
 448 /* Emit the trampoline template.  This hook may be NULL.  */
 449 DEFHOOK
 450 (trampoline_template,
 451  "",
 452  void, (FILE *f),
 453  NULL)
 454
 455 DEFHOOK
 456 (output_source_filename,
 457  "Output COFF information or DWARF debugging information which indicates\
 458  that filename @var{name} is the current source file to the stdio\
 459  stream @var{file}.\n\
 460  \n\
 461  This target hook need not be defined if the standard form of output\
 462  for the file format in use is appropriate.",
 463  void ,(FILE *file, const char *name),
 464  default_asm_output_source_filename)
 465
 466 DEFHOOK
 467 (output_addr_const_extra,
 468  "",
 469  bool, (FILE *file, rtx x),
 470  default_asm_output_addr_const_extra)
 471
 472 /* ??? The TARGET_PRINT_OPERAND* hooks are part of the asm_out struct,
 473    even though that is not reflected in the macro name to override their
 474    initializers.  */
 475 #undef HOOK_PREFIX
 476 #define HOOK_PREFIX "TARGET_"
 477
 478 /* Emit a machine-specific insn operand.  */
 479 /* ??? tm.texi only documents the old macro PRINT_OPERAND,
 480    not this  hook, and uses a different name for the argument FILE.  */
 481 DEFHOOK_UNDOC
 482 (print_operand,
 483  "",
 484  void, (FILE *file, rtx x, int code),
 485  default_print_operand)
 486
 487 /* Emit a machine-specific memory address.  */
 488 /* ??? tm.texi only documents the old macro PRINT_OPERAND_ADDRESS,
 489    not this  hook, and uses different argument names.  */
 490 DEFHOOK_UNDOC
 491 (print_operand_address,
 492  "",
 493  void, (FILE *file, rtx addr),
 494  default_print_operand_address)
 495
 496 /* Determine whether CODE is a valid punctuation character for the
 497    `print_operand' hook.  */
 498 /* ??? tm.texi only documents the old macro PRINT_OPERAND_PUNCT_VALID_P,
 499    not this  hook.  */
 500 DEFHOOK_UNDOC
 501 (print_operand_punct_valid_p,
 502  "",
 503  bool ,(unsigned char code),
 504  default_print_operand_punct_valid_p)
 505
 506 HOOK_VECTOR_END (asm_out)
 507
 508 /* Functions relating to instruction scheduling.  All of these
 509    default to null pointers, which haifa-sched.c looks for and handles.  */
 510 #undef HOOK_PREFIX
 511 #define HOOK_PREFIX "TARGET_SCHED_"
 512 HOOK_VECTOR (TARGET_SCHED, sched)
 513
 514 /* Given the current cost, COST, of an insn, INSN, calculate and
 515    return a new cost based on its relationship to DEP_INSN through
 516    the dependence LINK.  The default is to make no adjustment.  */
 517 DEFHOOK
 518 (adjust_cost,
 519  "",
 520  int, (rtx insn, rtx link, rtx dep_insn, int cost), NULL)
 521
 522 /* Adjust the priority of an insn as you see fit.  Returns the new priority.  */
 523 DEFHOOK
 524 (adjust_priority,
 525  "",
 526  int, (rtx insn, int priority), NULL)
 527
 528 /* Function which returns the maximum number of insns that can be
 529    scheduled in the same machine cycle.  This must be constant
 530    over an entire compilation.  The default is 1.  */
 531 DEFHOOK
 532 (issue_rate,
 533  "",
 534  int, (void), NULL)
 535
 536 /* Calculate how much this insn affects how many more insns we
 537    can emit this cycle.  Default is they all cost the same.  */
 538 DEFHOOK
 539 (variable_issue,
 540  "",
 541  int, (FILE *file, int verbose, rtx insn, int more), NULL)
 542
 543 /* Initialize machine-dependent scheduling code.  */
 544 DEFHOOK
 545 (init,
 546  "",
 547  void, (FILE *file, int verbose, int max_ready), NULL)
 548
 549 /* Finalize machine-dependent scheduling code.  */
 550 DEFHOOK
 551 (finish,
 552  "",
 553  void, (FILE *file, int verbose), NULL)
 554
 555  /* Initialize machine-dependent function wide scheduling code.  */
 556 DEFHOOK
 557 (init_global,
 558  "",
 559  void, (FILE *file, int verbose, int old_max_uid), NULL)
 560
 561 /* Finalize machine-dependent function wide scheduling code.  */
 562 DEFHOOK
 563 (finish_global,
 564  "",
 565  void, (FILE *file, int verbose), NULL)
 566
 567 /* Reorder insns in a machine-dependent fashion, in two different
 568        places.  Default does nothing.  */
 569 DEFHOOK
 570 (reorder,
 571  "",
 572  int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL)
 573
 574 DEFHOOK
 575 (reorder2,
 576  "",
 577  int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL)
 578
 579 /* The following member value is a pointer to a function called
 580    after evaluation forward dependencies of insns in chain given
 581    by two parameter values (head and tail correspondingly).  */
 582 DEFHOOK
 583 (dependencies_evaluation_hook,
 584  "",
 585  void, (rtx head, rtx tail), NULL)
 586
 587 /* The values of the following four members are pointers to functions
 588    used to simplify the automaton descriptions.  dfa_pre_cycle_insn and
 589    dfa_post_cycle_insn give functions returning insns which are used to
 590    change the pipeline hazard recognizer state when the new simulated
 591    processor cycle correspondingly starts and finishes.  The function
 592    defined by init_dfa_pre_cycle_insn and init_dfa_post_cycle_insn are
 593    used to initialize the corresponding insns.  The default values of
 594    the members result in not changing the automaton state when the
 595    new simulated processor cycle correspondingly starts and finishes.  */
 596
 597 DEFHOOK
 598 (init_dfa_pre_cycle_insn,
 599  "",
 600  void, (void), NULL)
 601
 602 DEFHOOK
 603 (dfa_pre_cycle_insn,
 604  "",
 605  rtx, (void), NULL)
 606
 607 DEFHOOK
 608 (init_dfa_post_cycle_insn,
 609  "",
 610  void, (void), NULL)
 611
 612 DEFHOOK
 613 (dfa_post_cycle_insn,
 614  "",
 615  rtx, (void), NULL)
 616
 617 /* The values of the following two members are pointers to
 618    functions used to simplify the automaton descriptions.
 619    dfa_pre_advance_cycle and dfa_post_advance_cycle are getting called
 620    immediately before and after cycle is advanced.  */
 621
 622 DEFHOOK
 623 (dfa_pre_advance_cycle,
 624  "",
 625  void, (void), NULL)
 626
 627 DEFHOOK
 628 (dfa_post_advance_cycle,
 629  "",
 630  void, (void), NULL)
 631
 632 /* The following member value is a pointer to a function returning value
 633    which defines how many insns in queue `ready' will we try for
 634    multi-pass scheduling.  If the member value is nonzero and the
 635    function returns positive value, the DFA based scheduler will make
 636    multi-pass scheduling for the first cycle.  In other words, we will
 637    try to choose ready insn which permits to start maximum number of
 638    insns on the same cycle.  */
 639 DEFHOOK
 640 (first_cycle_multipass_dfa_lookahead,
 641  "",
 642  int, (void), NULL)
 643
 644 /* The following member value is pointer to a function controlling
 645    what insns from the ready insn queue will be considered for the
 646    multipass insn scheduling.  If the hook returns zero for insn
 647    passed as the parameter, the insn will be not chosen to be issued.  */
 648 DEFHOOK
 649 (first_cycle_multipass_dfa_lookahead_guard,
 650  "",
 651  int, (rtx insn), NULL)
 652
 653 /* The following member value is pointer to a function called by
 654    the insn scheduler before issuing insn passed as the third
 655    parameter on given cycle.  If the hook returns nonzero, the
 656    insn is not issued on given processors cycle.  Instead of that,
 657    the processor cycle is advanced.  If the value passed through
 658    the last parameter is zero, the insn ready queue is not sorted
 659    on the new cycle start as usually.  The first parameter passes
 660    file for debugging output.  The second one passes the scheduler
 661    verbose level of the debugging output.  The forth and the fifth
 662    parameter values are correspondingly processor cycle on which
 663    the previous insn has been issued and the current processor cycle.  */
 664 DEFHOOK
 665 (dfa_new_cycle,
 666  "",
 667  int, (FILE *dump, int verbose, rtx insn, int last_clock,
 668        int clock, int *sort_p),
 669  NULL)
 670
 671 /* The following member value is a pointer to a function called by the
 672    insn scheduler.  It should return true if there exists a dependence
 673    which is considered costly by the target, between the insn
 674    DEP_PRO (&_DEP), and the insn DEP_CON (&_DEP).  The first parameter is
 675    the dep that represents the dependence between the two insns.  The
 676    second argument is the cost of the dependence as estimated by
 677    the scheduler.  The last argument is the distance in cycles
 678    between the already scheduled insn (first parameter) and the
 679    second insn (second parameter).  */
 680 DEFHOOK
 681 (is_costly_dependence,
 682  "",
 683  bool, (struct _dep *_dep, int cost, int distance), NULL)
 684
 685 DEFHOOK_UNDOC
 686 (adjust_cost_2,
 687  "Given the current cost, @var{cost}, of an insn, @var{insn}, calculate and\
 688  return a new cost based on its relationship to @var{dep_insn} through the\
 689  dependence of weakness @var{dw}.  The default is to make no adjustment.",
 690  int, (rtx insn, int dep_type1, rtx dep_insn, int cost, int dw), NULL)
 691
 692 /* The following member value is a pointer to a function called
 693    by the insn scheduler. This hook is called to notify the backend
 694    that new instructions were emitted.  */
 695 DEFHOOK
 696 (h_i_d_extended,
 697  "",
 698  void, (void), NULL)
 699
 700 /* Next 5 functions are for multi-point scheduling.  */
 701
 702 /* Allocate memory for scheduler context.  */
 703 DEFHOOK
 704 (alloc_sched_context,
 705  "",
 706  void *, (void), NULL)
 707
 708 /* Fills the context from the local machine scheduler context.  */
 709 DEFHOOK
 710 (init_sched_context,
 711  "",
 712  void, (void *tc, bool clean_p), NULL)
 713
 714 /* Sets local machine scheduler context to a saved value.  */
 715 DEFHOOK
 716 (set_sched_context,
 717  "",
 718  void, (void *tc), NULL)
 719
 720 /* Clears a scheduler context so it becomes like after init.  */
 721 DEFHOOK
 722 (clear_sched_context,
 723  "",
 724  void, (void *tc), NULL)
 725
 726 /* Frees the scheduler context.  */
 727 DEFHOOK
 728 (free_sched_context,
 729  "",
 730  void, (void *tc), NULL)
 731
 732 /* The following member value is a pointer to a function called
 733    by the insn scheduler.
 734    The first parameter is an instruction, the second parameter is the type
 735    of the requested speculation, and the third parameter is a pointer to the
 736    speculative pattern of the corresponding type (set if return value == 1).
 737    It should return
 738    -1, if there is no pattern, that will satisfy the requested speculation type,
 739    0, if current pattern satisfies the requested speculation type,
 740    1, if pattern of the instruction should be changed to the newly
 741    generated one.  */
 742 DEFHOOK
 743 (speculate_insn,
 744  "",
 745  int, (rtx insn, int request, rtx *new_pat), NULL)
 746
 747 /* The following member value is a pointer to a function called
 748    by the insn scheduler.  It should return true if the check instruction
 749    passed as the parameter needs a recovery block.  */
 750 DEFHOOK
 751 (needs_block_p,
 752  "",
 753  bool, (int dep_status), NULL)
 754
 755 /* The following member value is a pointer to a function called
 756    by the insn scheduler.  It should return a pattern for the check
 757    instruction.
 758    The first parameter is a speculative instruction, the second parameter
 759    is the label of the corresponding recovery block (or null, if it is a
 760    simple check).  If the mutation of the check is requested (e.g. from
 761    ld.c to chk.a), the third parameter is true - in this case the first
 762    parameter is the previous check.  */
 763 DEFHOOK
 764 (gen_spec_check,
 765  "",
 766  rtx, (rtx insn, rtx label, int mutate_p), NULL)
 767
 768 /* The following member value is a pointer to a function controlling
 769    what insns from the ready insn queue will be considered for the
 770    multipass insn scheduling.  If the hook returns zero for the insn
 771    passed as the parameter, the insn will not be chosen to be
 772    issued.  This hook is used to discard speculative instructions,
 773    that stand at the first position of the ready list.  */
 774 DEFHOOK
 775 (first_cycle_multipass_dfa_lookahead_guard_spec,
 776  "",
 777  bool, (const_rtx insn), NULL)
 778
 779 /* The following member value is a pointer to a function that provides
 780    information about the speculation capabilities of the target.
 781    The parameter is a pointer to spec_info variable.  */
 782 DEFHOOK
 783 (set_sched_flags,
 784  "",
 785  void, (struct spec_info_def *spec_info), NULL)
 786
 787 DEFHOOK_UNDOC
 788 (get_insn_spec_ds,
 789  "Return speculation types of instruction @var{insn}.",
 790  int, (rtx insn), NULL)
 791
 792 DEFHOOK_UNDOC
 793 (get_insn_checked_ds,
 794  "Return speculation types that are checked for instruction @var{insn}",
 795  int, (rtx insn), NULL)
 796
 797 DEFHOOK_UNDOC
 798 (skip_rtx_p,
 799  "Return bool if rtx scanning should just skip current layer and\
 800  advance to the inner rtxes.",
 801  bool, (const_rtx x), NULL)
 802
 803 /* The following member value is a pointer to a function that provides
 804    information about the target resource-based lower bound which is
 805    used by the swing modulo scheduler.  The parameter is a pointer
 806    to ddg variable.  */
 807 DEFHOOK
 808 (sms_res_mii,
 809  "",
 810  int, (struct ddg *g), NULL)
 811
 812 /* The following member value is a function that initializes dispatch
 813    schedling and adds instructions to dispatch window according to its
 814    parameters.  */
 815 DEFHOOK
 816 (dispatch_do,
 817 "",
 818 void, (rtx insn, int x),
 819 hook_void_rtx_int)
 820
 821 /* The following member value is a a function that returns true is
 822    dispatch schedling is supported in hardware and condition passed
 823    as the second parameter is true.  */
 824 DEFHOOK
 825 (dispatch,
 826 "",
 827 bool, (rtx insn, int x),
 828 hook_bool_rtx_int_false)
 829
 830 HOOK_VECTOR_END (sched)
 831
 832 /* Functions relating to vectorization.  */
 833 #undef HOOK_PREFIX
 834 #define HOOK_PREFIX "TARGET_VECTORIZE_"
 835 HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
 836
 837 /* The following member value is a pointer to a function called
 838    by the vectorizer, and return the decl of the target builtin
 839    function.  */
 840 DEFHOOK
 841 (builtin_mask_for_load,
 842  "",
 843  tree, (void), NULL)
 844
 845 /* Returns a code for builtin that realizes vectorized version of
 846    function, or NULL_TREE if not available.  */
 847 DEFHOOK
 848 (builtin_vectorized_function,
 849  "",
 850  tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
 851  default_builtin_vectorized_function)
 852
 853 /* Returns a function declaration for a builtin that realizes the
 854    vector conversion, or NULL_TREE if not available.  */
 855 DEFHOOK
 856 (builtin_conversion,
 857  "",
 858  tree, (unsigned code, tree dest_type, tree src_type),
 859  default_builtin_vectorized_conversion)
 860
 861 /* Target builtin that implements vector widening multiplication.
 862    builtin_mul_widen_eve computes the element-by-element products
 863    for the even elements, and builtin_mul_widen_odd computes the
 864    element-by-element products for the odd elements.  */
 865 DEFHOOK
 866 (builtin_mul_widen_even,
 867  "",
 868  tree, (tree x), NULL)
 869
 870 DEFHOOK
 871 (builtin_mul_widen_odd,
 872  "",
 873  tree, (tree x), NULL)
 874
 875 /* Cost of different vector/scalar statements in vectorization cost
 876    model. In case of misaligned vector loads and stores the cost depends
 877    on the data type and misalignment value.  */
 878 DEFHOOK
 879 (builtin_vectorization_cost,
 880  "",
 881  int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
 882  default_builtin_vectorization_cost)
 883
 884 /* Return true if vector alignment is reachable (by peeling N
 885    iterations) for the given type.  */
 886 DEFHOOK
 887 (vector_alignment_reachable,
 888  "",
 889  bool, (const_tree type, bool is_packed),
 890  default_builtin_vector_alignment_reachable)
 891
 892 /* Target builtin that implements vector permute.  */
 893 DEFHOOK
 894 (builtin_vec_perm,
 895  "",
 896  tree, (tree type, tree *mask_element_type), NULL)
 897
 898 /* Return true if a vector created for builtin_vec_perm is valid.  */
 899 DEFHOOK
 900 (builtin_vec_perm_ok,
 901  "",
 902  bool, (tree vec_type, tree mask),
 903  hook_bool_tree_tree_true)
 904
 905 /* Return true if the target supports misaligned store/load of a
 906    specific factor denoted in the third parameter.  The last parameter
 907    is true if the access is defined in a packed struct.  */
 908 DEFHOOK
 909 (support_vector_misalignment,
 910  "",
 911  bool,
 912  (enum machine_mode mode, const_tree type, int misalignment, bool is_packed),
 913  default_builtin_support_vector_misalignment)
 914
 915 /* Returns the preferred mode for SIMD operations for the specified
 916    scalar mode.  */
 917 DEFHOOK
 918 (preferred_simd_mode,
 919  "",
 920  enum machine_mode,
 921  (enum machine_mode mode),
 922  default_preferred_simd_mode)
 923
 924 /* Returns a mask of vector sizes to iterate over when auto-vectorizing
 925    after processing the preferred one derived from preferred_simd_mode.  */
 926 DEFHOOK
 927 (autovectorize_vector_sizes,
 928  "",
 929  unsigned int,
 930  (void),
 931  default_autovectorize_vector_sizes)
 932
 933 HOOK_VECTOR_END (vectorize)
 934
 935 #undef HOOK_PREFIX
 936 #define HOOK_PREFIX "TARGET_"
 937
 938 /* The initial value of target_flags.  */
 939 DEFHOOKPOD
 940 (default_target_flags,
 941  "",
 942  int, 0)
 943
 944 /* Allow target specific overriding of option settings after options have
 945   been changed by an attribute or pragma or when it is reset at the
 946   end of the code affected by an attribute or pragma.  */
 947 DEFHOOK
 948 (override_options_after_change,
 949  "",
 950  void, (void),
 951  hook_void_void)
 952
 953 /* Handle target switch CODE (an OPT_* value).  ARG is the argument
 954    passed to the switch; it is NULL if no argument was.  VALUE is the
 955    value of ARG if CODE specifies a UInteger option, otherwise it is
 956    1 if the positive form of the switch was used and 0 if the negative
 957    form was.  Return true if the switch was valid.  */
 958 DEFHOOK
 959 (handle_option,
 960  "",
 961  bool, (size_t code, const char *arg, int value),
 962  hook_bool_size_t_constcharptr_int_true)
 963
 964 /* Display extra, target specific information in response to a
 965    --target-help switch.  */
 966 DEFHOOK
 967 (help,
 968  "",
 969  void, (void), NULL)
 970
 971 DEFHOOK_UNDOC
 972 (eh_return_filter_mode,
 973  "Return machine mode for filter value.",
 974  enum machine_mode, (void),
 975  default_eh_return_filter_mode)
 976
 977 /* Return machine mode for libgcc expanded cmp instructions.  */
 978 DEFHOOK
 979 (libgcc_cmp_return_mode,
 980  "",
 981  enum machine_mode, (void),
 982  default_libgcc_cmp_return_mode)
 983
 984 /* Return machine mode for libgcc expanded shift instructions.  */
 985 DEFHOOK
 986 (libgcc_shift_count_mode,
 987  "",
 988  enum machine_mode, (void),
 989  default_libgcc_shift_count_mode)
 990
 991 /* Return machine mode to be used for _Unwind_Word type.  */
 992 DEFHOOK
 993 (unwind_word_mode,
 994  "",
 995  enum machine_mode, (void),
 996  default_unwind_word_mode)
 997
 998 /* Given two decls, merge their attributes and return the result.  */
 999 DEFHOOK
1000 (merge_decl_attributes,
1001  "",
1002  tree, (tree olddecl, tree newdecl),
1003  merge_decl_attributes)
1004
1005 /* Given two types, merge their attributes and return the result.  */
1006 DEFHOOK
1007 (merge_type_attributes,
1008  "",
1009  tree, (tree type1, tree type2),
1010  merge_type_attributes)
1011
1012 /* Table of machine attributes and functions to handle them.
1013    Ignored if NULL.  */
1014 DEFHOOKPOD
1015 (attribute_table,
1016  "",
1017  const struct attribute_spec *, NULL)
1018
1019 /* Return true iff attribute NAME expects a plain identifier as its first
1020    argument.  */
1021 DEFHOOK
1022 (attribute_takes_identifier_p,
1023  "",
1024  bool, (const_tree name),
1025  hook_bool_const_tree_false)
1026
1027 /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible,
1028    one if they are compatible and two if they are nearly compatible
1029    (which causes a warning to be generated).  */
1030 DEFHOOK
1031 (comp_type_attributes,
1032  "",
1033  int, (const_tree type1, const_tree type2),
1034  hook_int_const_tree_const_tree_1)
1035
1036 /* Assign default attributes to the newly defined TYPE.  */
1037 DEFHOOK
1038 (set_default_type_attributes,
1039  "",
1040  void, (tree type),
1041  hook_void_tree)
1042
1043 /* Insert attributes on the newly created DECL.  */
1044 DEFHOOK
1045 (insert_attributes,
1046  "",
1047  void, (tree node, tree *attr_ptr),
1048  hook_void_tree_treeptr)
1049
1050 /* Return true if FNDECL (which has at least one machine attribute)
1051    can be inlined despite its machine attributes, false otherwise.  */
1052 DEFHOOK
1053 (function_attribute_inlinable_p,
1054  "",
1055  bool, (const_tree fndecl),
1056  hook_bool_const_tree_false)
1057
1058 /* Return true if bitfields in RECORD_TYPE should follow the
1059    Microsoft Visual C++ bitfield layout rules.  */
1060 DEFHOOK
1061 (ms_bitfield_layout_p,
1062  "",
1063  bool, (const_tree record_type),
1064  hook_bool_const_tree_false)
1065
1066 /* True if the target supports decimal floating point.  */
1067 DEFHOOK
1068 (decimal_float_supported_p,
1069  "",
1070  bool, (void),
1071  default_decimal_float_supported_p)
1072
1073 /* True if the target supports fixed-point.  */
1074 DEFHOOK
1075 (fixed_point_supported_p,
1076  "",
1077  bool, (void),
1078  default_fixed_point_supported_p)
1079
1080 /* Return true if anonymous bitfields affect structure alignment.  */
1081 DEFHOOK
1082 (align_anon_bitfield,
1083  "",
1084  bool, (void),
1085  hook_bool_void_false)
1086
1087 /* Return true if volatile bitfields should use the narrowest type possible.
1088    Return false if they should use the container type.  */
1089 DEFHOOK
1090 (narrow_volatile_bitfield,
1091  "",
1092  bool, (void),
1093  hook_bool_void_false)
1094
1095 /* Set up target-specific built-in functions.  */
1096 DEFHOOK
1097 (init_builtins,
1098  "",
1099  void, (void),
1100  hook_void_void)
1101
1102 /* Initialize (if INITIALIZE_P is true) and return the target-specific
1103    built-in function decl for CODE.
1104    Return NULL if that is not possible.  Return error_mark_node if CODE
1105    is outside of the range of valid target builtin function codes.  */
1106 DEFHOOK
1107 (builtin_decl,
1108  "",
1109  tree, (unsigned code, bool initialize_p), NULL)
1110
1111 /* Expand a target-specific builtin.  */
1112 DEFHOOK
1113 (expand_builtin,
1114  "",
1115  rtx,
1116  (tree exp, rtx target, rtx subtarget, enum machine_mode mode, int ignore),
1117  default_expand_builtin)
1118
1119 /* Select a replacement for a target-specific builtin.  This is done
1120    *before* regular type checking, and so allows the target to
1121    implement a crude form of function overloading.  The result is a
1122    complete expression that implements the operation.  PARAMS really
1123    has type VEC(tree,gc)*, but we don't want to include tree.h here.  */
1124 DEFHOOK
1125 (resolve_overloaded_builtin,
1126  "",
1127  tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
1128
1129 /* Fold a target-specific builtin.  */
1130 DEFHOOK
1131 (fold_builtin,
1132  "",
1133  tree, (tree fndecl, int n_args, tree *argp, bool ignore),
1134  hook_tree_tree_int_treep_bool_null)
1135
1136 /* Returns a code for a target-specific builtin that implements
1137    reciprocal of the function, or NULL_TREE if not available.  */
1138 DEFHOOK
1139 (builtin_reciprocal,
1140  "",
1141  tree, (unsigned fn, bool md_fn, bool sqrt),
1142  default_builtin_reciprocal)
1143
1144 /* For a vendor-specific TYPE, return a pointer to a statically-allocated
1145    string containing the C++ mangling for TYPE.  In all other cases, return
1146    NULL.  */
1147 DEFHOOK
1148 (mangle_type,
1149  "",
1150  const char *, (const_tree type),
1151  hook_constcharptr_const_tree_null)
1152
1153 /* Make any adjustments to libfunc names needed for this target.  */
1154 DEFHOOK
1155 (init_libfuncs,
1156  "",
1157  void, (void),
1158  hook_void_void)
1159
1160 /* Given a decl, a section name, and whether the decl initializer
1161    has relocs, choose attributes for the section.  */
1162 /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION.  */
1163 DEFHOOK
1164 (section_type_flags,
1165  "",
1166  unsigned int, (tree decl, const char *name, int reloc),
1167  default_section_type_flags)
1168
1169 /* True if new jumps cannot be created, to replace existing ones or
1170    not, at the current point in the compilation.  */
1171 DEFHOOK
1172 (cannot_modify_jumps_p,
1173  "",
1174  bool, (void),
1175  hook_bool_void_false)
1176
1177 /* Return a register class for which branch target register
1178    optimizations should be applied.  */
1179 DEFHOOK
1180 (branch_target_register_class,
1181  "",
1182  reg_class_t, (void),
1183  default_branch_target_register_class)
1184
1185 /* Return true if branch target register optimizations should include
1186    callee-saved registers that are not already live during the current
1187    function.  AFTER_PE_GEN is true if prologues and epilogues have
1188    already been generated.  */
1189 DEFHOOK
1190 (branch_target_register_callee_saved,
1191  "",
1192  bool, (bool after_prologue_epilogue_gen),
1193  hook_bool_bool_false)
1194
1195 /* Return true if the target supports conditional execution.  */
1196 DEFHOOK
1197 (have_conditional_execution,
1198  "",
1199  bool, (void),
1200  default_have_conditional_execution)
1201
1202 /* Return a new value for loop unroll size.  */
1203 DEFHOOK
1204 (loop_unroll_adjust,
1205  "",
1206  unsigned, (unsigned nunroll, struct loop *loop),
1207  NULL)
1208
1209 /* True if the constant X cannot be placed in the constant pool.  */
1210 DEFHOOK
1211 (cannot_force_const_mem,
1212  "",
1213  bool, (rtx x),
1214  hook_bool_rtx_false)
1215
1216 DEFHOOK_UNDOC
1217 (cannot_copy_insn_p,
1218  "True if the insn @var{x} cannot be duplicated.",
1219  bool, (rtx), NULL)
1220
1221 /* True if X is considered to be commutative.  */
1222 DEFHOOK
1223 (commutative_p,
1224  "",
1225  bool, (const_rtx x, int outer_code),
1226  hook_bool_const_rtx_commutative_p)
1227
1228 /* True if ADDR is an address-expression whose effect depends
1229    on the mode of the memory reference it is used in.  */
1230 DEFHOOK
1231 (mode_dependent_address_p,
1232  "",
1233  bool, (const_rtx addr),
1234  default_mode_dependent_address_p)
1235
1236 /* Given an invalid address X for a given machine mode, try machine-specific
1237    ways to make it legitimate.  Return X or an invalid address on failure.  */
1238 DEFHOOK
1239 (legitimize_address,
1240  "",
1241  rtx, (rtx x, rtx oldx, enum machine_mode mode),
1242  default_legitimize_address)
1243
1244 /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS.  */
1245 DEFHOOK
1246 (delegitimize_address,
1247  "",
1248  rtx, (rtx x),
1249  delegitimize_mem_from_attrs)
1250
1251 /* Given an address RTX, say whether it is valid.  */
1252 DEFHOOK
1253 (legitimate_address_p,
1254  "",
1255  bool, (enum machine_mode mode, rtx x, bool strict),
1256  default_legitimate_address_p)
1257
1258 /* True if the given constant can be put into an object_block.  */
1259 DEFHOOK
1260 (use_blocks_for_constant_p,
1261  "",
1262  bool, (enum machine_mode mode, const_rtx x),
1263  hook_bool_mode_const_rtx_false)
1264
1265 /* The minimum and maximum byte offsets for anchored addresses.  */
1266 DEFHOOKPOD
1267 (min_anchor_offset,
1268  "",
1269  HOST_WIDE_INT, 0)
1270
1271 DEFHOOKPOD
1272 (max_anchor_offset,
1273  "",
1274  HOST_WIDE_INT, 0)
1275
1276 /* True if section anchors can be used to access the given symbol.  */
1277 DEFHOOK
1278 (use_anchors_for_symbol_p,
1279  "",
1280  bool, (const_rtx x),
1281  default_use_anchors_for_symbol_p)
1282
1283 /* True if it is OK to do sibling call optimization for the specified
1284    call expression EXP.  DECL will be the called function, or NULL if
1285    this is an indirect call.  */
1286 DEFHOOK
1287 (function_ok_for_sibcall,
1288  "",
1289  bool, (tree decl, tree exp),
1290  hook_bool_tree_tree_false)
1291
1292 /* Establish appropriate back-end context for processing the function
1293    FNDECL.  The argument might be NULL to indicate processing at top
1294    level, outside of any function scope.  */
1295 DEFHOOK
1296 (set_current_function,
1297  "",
1298  void, (tree decl), hook_void_tree)
1299
1300 /* True if EXP should be placed in a "small data" section.  */
1301 DEFHOOK
1302 (in_small_data_p,
1303  "",
1304  bool, (const_tree exp),
1305  hook_bool_const_tree_false)
1306
1307 /* True if EXP names an object for which name resolution must resolve
1308    to the current executable or shared library.  */
1309 DEFHOOK
1310 (binds_local_p,
1311  "",
1312  bool, (const_tree exp),
1313  default_binds_local_p)
1314
1315 /* Check if profiling code is before or after prologue.  */
1316 DEFHOOK
1317 (profile_before_prologue,
1318  "It returns true if target wants profile code emitted before prologue.\n\n\
1319 The default version of this hook use the target macro\n\
1320 @code{PROFILE_BEFORE_PROLOGUE}.",
1321  bool, (void),
1322  default_profile_before_prologue)
1323
1324 /* Modify and return the identifier of a DECL's external name,
1325    originally identified by ID, as required by the target,
1326    (eg, append @nn to windows32 stdcall function names).
1327    The default is to return ID without modification. */
1328 DEFHOOK
1329 (mangle_decl_assembler_name,
1330  "",
1331  tree, (tree decl, tree  id),
1332  default_mangle_decl_assembler_name)
1333
1334 /* Do something target-specific to record properties of the DECL into
1335    the associated SYMBOL_REF.  */
1336 DEFHOOK
1337 (encode_section_info,
1338  "",
1339  void, (tree decl, rtx rtl, int new_decl_p),
1340  default_encode_section_info)
1341
1342 /* Undo the effects of encode_section_info on the symbol string.  */
1343 DEFHOOK
1344 (strip_name_encoding,
1345  "",
1346  const char *, (const char *name),
1347  default_strip_name_encoding)
1348
1349 /* If shift optabs for MODE are known to always truncate the shift count,
1350    return the mask that they apply.  Return 0 otherwise.  */
1351 DEFHOOK
1352 (shift_truncation_mask,
1353  "",
1354  unsigned HOST_WIDE_INT, (enum machine_mode mode),
1355  default_shift_truncation_mask)
1356
1357 /* Return the number of divisions in the given MODE that should be present,
1358    so that it is profitable to turn the division into a multiplication by
1359    the reciprocal.  */
1360 DEFHOOK
1361 (min_divisions_for_recip_mul,
1362  "",
1363  unsigned int, (enum machine_mode mode),
1364  default_min_divisions_for_recip_mul)
1365
1366 /* If the representation of integral MODE is such that values are
1367    always sign-extended to a wider mode MODE_REP then return
1368    SIGN_EXTEND.  Return UNKNOWN otherwise.  */
1369 /* Note that the return type ought to be RTX_CODE, but that's not
1370    necessarily defined at this point.  */
1371 DEFHOOK
1372 (mode_rep_extended,
1373  "",
1374  int, (enum machine_mode mode, enum machine_mode rep_mode),
1375  default_mode_rep_extended)
1376
1377 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))).  */
1378 DEFHOOK
1379 (valid_pointer_mode,
1380  "",
1381  bool, (enum machine_mode mode),
1382  default_valid_pointer_mode)
1383
1384 /* Support for named address spaces.  */
1385 #undef HOOK_PREFIX
1386 #define HOOK_PREFIX "TARGET_ADDR_SPACE_"
1387 HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
1388
1389 /* MODE to use for a pointer into another address space.  */
1390 DEFHOOK
1391 (pointer_mode,
1392  "",
1393  enum machine_mode, (addr_space_t address_space),
1394  default_addr_space_pointer_mode)
1395
1396 /* MODE to use for an address in another address space.  */
1397 DEFHOOK
1398 (address_mode,
1399  "",
1400  enum machine_mode, (addr_space_t address_space),
1401  default_addr_space_address_mode)
1402
1403 /* True if MODE is valid for a pointer in __attribute__((mode("MODE")))
1404    in another address space.  */
1405 DEFHOOK
1406 (valid_pointer_mode,
1407  "",
1408  bool, (enum machine_mode mode, addr_space_t as),
1409  default_addr_space_valid_pointer_mode)
1410
1411 /* True if an address is a valid memory address to a given named address
1412    space for a given mode.  */
1413 DEFHOOK
1414 (legitimate_address_p,
1415  "",
1416  bool, (enum machine_mode mode, rtx exp, bool strict, addr_space_t as),
1417  default_addr_space_legitimate_address_p)
1418
1419 /* Return an updated address to convert an invalid pointer to a named
1420    address space to a valid one.  If NULL_RTX is returned use machine
1421    independent methods to make the address valid.  */
1422 DEFHOOK
1423 (legitimize_address,
1424  "",
1425  rtx, (rtx x, rtx oldx, enum machine_mode mode, addr_space_t as),
1426  default_addr_space_legitimize_address)
1427
1428 /* True if one named address space is a subset of another named address. */
1429 DEFHOOK
1430 (subset_p,
1431  "",
1432  bool, (addr_space_t superset, addr_space_t subset),
1433  default_addr_space_subset_p)
1434
1435 /* Function to convert an rtl expression from one address space to another.  */
1436 DEFHOOK
1437 (convert,
1438  "",
1439  rtx, (rtx op, tree from_type, tree to_type),
1440  default_addr_space_convert)
1441
1442 HOOK_VECTOR_END (addr_space)
1443
1444 #undef HOOK_PREFIX
1445 #define HOOK_PREFIX "TARGET_"
1446
1447 /* True if MODE is valid for the target.  By "valid", we mean able to
1448    be manipulated in non-trivial ways.  In particular, this means all
1449    the arithmetic is supported.  */
1450 DEFHOOK
1451 (scalar_mode_supported_p,
1452  "",
1453  bool, (enum machine_mode mode),
1454  default_scalar_mode_supported_p)
1455
1456 /* Similarly for vector modes.  "Supported" here is less strict.  At
1457    least some operations are supported; need to check optabs or builtins
1458    for further details.  */
1459 DEFHOOK
1460 (vector_mode_supported_p,
1461  "",
1462  bool, (enum machine_mode mode),
1463  hook_bool_mode_false)
1464
1465 /* Compute cost of moving data from a register of class FROM to one of
1466    TO, using MODE.  */
1467 DEFHOOK
1468 (register_move_cost,
1469  "",
1470  int, (enum machine_mode mode, reg_class_t from, reg_class_t to),
1471  default_register_move_cost)
1472
1473 /* Compute cost of moving registers to/from memory.  */
1474 /* ??? Documenting the argument types for this hook requires a GFDL
1475    license grant.  Also, the documentation uses a different name for RCLASS.  */
1476 DEFHOOK
1477 (memory_move_cost,
1478  "",
1479  int, (enum machine_mode mode, reg_class_t rclass, bool in),
1480  default_memory_move_cost)
1481
1482 /* True for MODE if the target expects that registers in this mode will
1483    be allocated to registers in a small register class.  The compiler is
1484    allowed to use registers explicitly used in the rtl as spill registers
1485    but it should prevent extending the lifetime of these registers.  */
1486 DEFHOOK
1487 (small_register_classes_for_mode_p,
1488  "",
1489  bool, (enum machine_mode mode),
1490  hook_bool_mode_false)
1491
1492 /* Compute a (partial) cost for rtx X.  Return true if the complete
1493    cost has been computed, and false if subexpressions should be
1494    scanned.  In either case, *TOTAL contains the cost result.  */
1495 /* Note that CODE and OUTER_CODE ought to be RTX_CODE, but that's
1496    not necessarily defined at this point.  */
1497 DEFHOOK
1498 (rtx_costs,
1499  "",
1500  bool, (rtx x, int code, int outer_code, int *total, bool speed),
1501  hook_bool_rtx_int_int_intp_bool_false)
1502
1503 /* Compute the cost of X, used as an address.  Never called with
1504    invalid addresses.  */
1505 DEFHOOK
1506 (address_cost,
1507  "",
1508  int, (rtx address, bool speed),
1509  default_address_cost)
1510
1511 /* Return where to allocate pseudo for a given hard register initial value.  */
1512 DEFHOOK
1513 (allocate_initial_value,
1514  "",
1515  rtx, (rtx hard_reg), NULL)
1516
1517 /* Return nonzero if evaluating UNSPEC[_VOLATILE] X might cause a trap.
1518    FLAGS has the same meaning as in rtlanal.c: may_trap_p_1.  */
1519 DEFHOOK
1520 (unspec_may_trap_p,
1521  "",
1522  int, (const_rtx x, unsigned flags),
1523  default_unspec_may_trap_p)
1524
1525 /* Given a register, this hook should return a parallel of registers
1526    to represent where to find the register pieces.  Define this hook
1527    if the register and its mode are represented in Dwarf in
1528    non-contiguous locations, or if the register should be
1529    represented in more than one register in Dwarf.  Otherwise, this
1530    hook should return NULL_RTX.  */
1531 DEFHOOK
1532 (dwarf_register_span,
1533  "",
1534  rtx, (rtx reg),
1535  hook_rtx_rtx_null)
1536
1537 /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table
1538    entries not corresponding directly to registers below
1539    FIRST_PSEUDO_REGISTER, this hook should generate the necessary
1540    code, given the address of the table.  */
1541 DEFHOOK
1542 (init_dwarf_reg_sizes_extra,
1543  "",
1544  void, (tree address),
1545  hook_void_tree)
1546
1547 /* Fetch the fixed register(s) which hold condition codes, for
1548    targets where it makes sense to look for duplicate assignments to
1549    the condition codes.  This should return true if there is such a
1550    register, false otherwise.  The arguments should be set to the
1551    fixed register numbers.  Up to two condition code registers are
1552    supported.  If there is only one for this target, the int pointed
1553    at by the second argument should be set to -1.  */
1554 DEFHOOK
1555 (fixed_condition_code_regs,
1556  "",
1557  bool, (unsigned int *p1, unsigned int *p2),
1558  hook_bool_uintp_uintp_false)
1559
1560 /* If two condition code modes are compatible, return a condition
1561      code mode which is compatible with both, such that a comparison
1562      done in the returned mode will work for both of the original
1563      modes.  If the condition code modes are not compatible, return
1564      VOIDmode.  */
1565 DEFHOOK
1566 (cc_modes_compatible,
1567  "",
1568  enum machine_mode, (enum machine_mode m1, enum machine_mode m2),
1569  default_cc_modes_compatible)
1570
1571 /* Do machine-dependent code transformations.  Called just before
1572      delayed-branch scheduling.  */
1573 DEFHOOK
1574 (machine_dependent_reorg,
1575  "",
1576  void, (void), NULL)
1577
1578 /* Create the __builtin_va_list type.  */
1579 DEFHOOK
1580 (build_builtin_va_list,
1581  "",
1582  tree, (void),
1583  std_build_builtin_va_list)
1584
1585 /* Enumerate the va list variants.  */
1586 DEFHOOK
1587 (enum_va_list_p,
1588  "",
1589  int, (int idx, const char **pname, tree *ptree),
1590  NULL)
1591
1592 /* Get the cfun/fndecl calling abi __builtin_va_list type.  */
1593 DEFHOOK
1594 (fn_abi_va_list,
1595  "",
1596  tree, (tree fndecl),
1597  std_fn_abi_va_list)
1598
1599 /* Get the __builtin_va_list type dependent on input type.  */
1600 DEFHOOK
1601 (canonical_va_list_type,
1602  "",
1603  tree, (tree type),
1604  std_canonical_va_list_type)
1605
1606 /* ??? Documenting this hook requires a GFDL license grant.  */
1607 DEFHOOK_UNDOC
1608 (expand_builtin_va_start,
1609 "Expand the @code{__builtin_va_start} builtin.",
1610  void, (tree valist, rtx nextarg), NULL)
1611
1612 /* Gimplifies a VA_ARG_EXPR.  */
1613 DEFHOOK
1614 (gimplify_va_arg_expr,
1615  "",
1616  tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
1617  std_gimplify_va_arg_expr)
1618
1619 /* Validity-checking routines for PCH files, target-specific.
1620    get_pch_validity returns a pointer to the data to be stored,
1621    and stores the size in its argument.  pch_valid_p gets the same
1622    information back and returns NULL if the PCH is valid,
1623    or an error message if not.  */
1624 DEFHOOK
1625 (get_pch_validity,
1626  "",
1627  void *, (size_t *sz),
1628  default_get_pch_validity)
1629
1630 DEFHOOK
1631 (pch_valid_p,
1632  "",
1633  const char *, (const void *data, size_t sz),
1634  default_pch_valid_p)
1635
1636 /* If nonnull, this function checks whether a PCH file with the
1637    given set of target flags can be used.  It returns NULL if so,
1638    otherwise it returns an error message.  */
1639 DEFHOOK
1640 (check_pch_target_flags,
1641  "",
1642  const char *, (int pch_flags), NULL)
1643
1644 /* True if the compiler should give an enum type only as many
1645    bytes as it takes to represent the range of possible values of
1646    that type.  */
1647 DEFHOOK
1648 (default_short_enums,
1649  "",
1650  bool, (void),
1651  hook_bool_void_false)
1652
1653 /* This target hook returns an rtx that is used to store the address
1654    of the current frame into the built-in setjmp buffer.  */
1655 DEFHOOK
1656 (builtin_setjmp_frame_value,
1657  "",
1658  rtx, (void),
1659  default_builtin_setjmp_frame_value)
1660
1661 /* This target hook should add STRING_CST trees for any hard regs
1662    the port wishes to automatically clobber for an asm.  */
1663 DEFHOOK
1664 (md_asm_clobbers,
1665  "",
1666  tree, (tree outputs, tree inputs, tree clobbers),
1667  hook_tree_tree_tree_tree_3rd_identity)
1668
1669 /* This target hook allows the backend to specify a calling convention
1670    in the debug information.  This function actually returns an
1671    enum dwarf_calling_convention, but because of forward declarations
1672    and not wanting to include dwarf2.h everywhere target.h is included
1673    the function is being declared as an int.  */
1674 DEFHOOK
1675 (dwarf_calling_convention,
1676  "",
1677  int, (const_tree function),
1678  hook_int_const_tree_0)
1679
1680 /* This target hook allows the backend to emit frame-related insns that
1681    contain UNSPECs or UNSPEC_VOLATILEs.  The call frame debugging info
1682    engine will invoke it on insns of the form
1683      (set (reg) (unspec [...] UNSPEC_INDEX))
1684    and
1685      (set (reg) (unspec_volatile [...] UNSPECV_INDEX))
1686    to let the backend emit the call frame instructions.  */
1687 DEFHOOK
1688 (dwarf_handle_frame_unspec,
1689  "",
1690  void, (const char *label, rtx pattern, int index), NULL)
1691
1692 /* ??? Documenting this hook requires a GFDL license grant.  */
1693 DEFHOOK_UNDOC
1694 (stdarg_optimize_hook,
1695 "Perform architecture specific checking of statements gimplified\
1696  from @code{VA_ARG_EXPR}.  @var{stmt} is the statement.  Returns true if\
1697  the statement doesn't need to be checked for @code{va_list} references.",
1698  bool, (struct stdarg_info *ai, const_gimple stmt), NULL)
1699
1700 /* This target hook allows the operating system to override the DECL
1701    that represents the external variable that contains the stack
1702    protection guard variable.  The type of this DECL is ptr_type_node.  */
1703 DEFHOOK
1704 (stack_protect_guard,
1705  "",
1706  tree, (void),
1707  default_stack_protect_guard)
1708
1709 /* This target hook allows the operating system to override the CALL_EXPR
1710    that is invoked when a check vs the guard variable fails.  */
1711 DEFHOOK
1712 (stack_protect_fail,
1713  "",
1714  tree, (void),
1715  default_external_stack_protect_fail)
1716
1717 DEFHOOK
1718 (supports_split_stack,
1719  "Whether this target supports splitting the stack.  This is called\
1720  after options have been parsed, so the target may reject splitting\
1721  the stack in some configurations.  The default version of this hook\
1722  returns false.  If @var{report} is true, this function may issue a warning\
1723  or error; if @var{report} is false, it must simply return a value",
1724  bool, (bool),
1725  hook_bool_bool_false)
1726
1727 /* Returns NULL if target supports the insn within a doloop block,
1728    otherwise it returns an error message.  */
1729 DEFHOOK
1730 (invalid_within_doloop,
1731  "",
1732  const char *, (const_rtx insn),
1733  default_invalid_within_doloop)
1734
1735 DEFHOOK
1736 (valid_dllimport_attribute_p,
1737 "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\
1738  specified.  Use this hook if the target needs to add extra validation\
1739  checks to @code{handle_dll_attribute}.",
1740  bool, (const_tree decl),
1741  hook_bool_const_tree_true)
1742
1743 /* If non-zero, align constant anchors in CSE to a multiple of this
1744    value.  */
1745 DEFHOOKPOD
1746 (const_anchor,
1747  "",
1748  unsigned HOST_WIDE_INT, 0)
1749
1750 /* Functions relating to calls - argument passing, returns, etc.  */
1751 /* Members of struct call have no special macro prefix.  */
1752 HOOK_VECTOR (TARGET_CALLS, calls)
1753
1754 DEFHOOK
1755 (promote_function_mode,
1756  "",
1757  enum machine_mode, (const_tree type, enum machine_mode mode, int *punsignedp,
1758                      const_tree funtype, int for_return),
1759  default_promote_function_mode)
1760
1761 DEFHOOK
1762 (promote_prototypes,
1763  "",
1764  bool, (const_tree fntype),
1765  hook_bool_const_tree_false)
1766
1767 DEFHOOK
1768 (struct_value_rtx,
1769  "",
1770  rtx, (tree fndecl, int incoming),
1771  hook_rtx_tree_int_null)
1772 DEFHOOK
1773 (return_in_memory,
1774  "",
1775  bool, (const_tree type, const_tree fntype),
1776  default_return_in_memory)
1777
1778 DEFHOOK
1779 (return_in_msb,
1780  "",
1781  bool, (const_tree type),
1782  hook_bool_const_tree_false)
1783
1784 /* Return true if a parameter must be passed by reference.  TYPE may
1785    be null if this is a libcall.  CA may be null if this query is
1786    from __builtin_va_arg.  */
1787 DEFHOOK
1788 (pass_by_reference,
1789  "",
1790  bool,
1791  (CUMULATIVE_ARGS *cum, enum machine_mode mode, const_tree type, bool named),
1792  hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
1793
1794 DEFHOOK
1795 (expand_builtin_saveregs,
1796  "",
1797  rtx, (void),
1798  default_expand_builtin_saveregs)
1799
1800 /* Returns pretend_argument_size.  */
1801 DEFHOOK
1802 (setup_incoming_varargs,
1803  "",
1804  void, (CUMULATIVE_ARGS *args_so_far, enum machine_mode mode, tree type,
1805         int *pretend_args_size, int second_time),
1806  default_setup_incoming_varargs)
1807
1808 DEFHOOK
1809 (strict_argument_naming,
1810  "",
1811  bool, (CUMULATIVE_ARGS *ca),
1812  hook_bool_CUMULATIVE_ARGS_false)
1813
1814 /* Returns true if we should use
1815    targetm.calls.setup_incoming_varargs() and/or
1816    targetm.calls.strict_argument_naming().  */
1817 DEFHOOK
1818 (pretend_outgoing_varargs_named,
1819  "",
1820  bool, (CUMULATIVE_ARGS *ca),
1821  default_pretend_outgoing_varargs_named)
1822
1823 /* Given a complex type T, return true if a parameter of type T
1824    should be passed as two scalars.  */
1825 DEFHOOK
1826 (split_complex_arg,
1827  "",
1828  bool, (const_tree type), NULL)
1829
1830 /* Return true if type T, mode MODE, may not be passed in registers,
1831    but must be passed on the stack.  */
1832 /* ??? This predicate should be applied strictly after pass-by-reference.
1833    Need audit to verify that this is the case.  */
1834 DEFHOOK
1835 (must_pass_in_stack,
1836  "",
1837  bool, (enum machine_mode mode, const_tree type),
1838  must_pass_in_stack_var_size_or_pad)
1839
1840 /* Return true if type TYPE, mode MODE, which is passed by reference,
1841    should have the object copy generated by the callee rather than
1842    the caller.  It is never called for TYPE requiring constructors.  */
1843 DEFHOOK
1844 (callee_copies,
1845  "",
1846  bool,
1847  (CUMULATIVE_ARGS *cum, enum machine_mode mode, const_tree type, bool named),
1848  hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
1849
1850 /* Return zero for arguments passed entirely on the stack or entirely
1851    in registers.  If passed in both, return the number of bytes passed
1852    in registers; the balance is therefore passed on the stack.  */
1853 DEFHOOK
1854 (arg_partial_bytes,
1855  "",
1856  int, (CUMULATIVE_ARGS *cum, enum machine_mode mode, tree type, bool named),
1857  hook_int_CUMULATIVE_ARGS_mode_tree_bool_0)
1858
1859 /* Update the state in CA to advance past an argument in the
1860    argument list.  The values MODE, TYPE, and NAMED describe that
1861    argument.  */
1862 /* ??? tm.texi still only describes the old macro.  */
1863 DEFHOOK_UNDOC
1864 (function_arg_advance,
1865  "",
1866  void,
1867  (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type, bool named),
1868  default_function_arg_advance)
1869
1870 /* Return zero if the argument described by the state of CA should
1871    be placed on a stack, or a hard register in which to store the
1872    argument.  The values MODE, TYPE, and NAMED describe that
1873    argument.  */
1874 /* ??? tm.texi still only describes the old macro.  */
1875 DEFHOOK_UNDOC
1876 (function_arg,
1877  "",
1878  rtx, (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type,
1879        bool named),
1880  default_function_arg)
1881
1882 /* Likewise, but for machines with register windows.  Return the
1883    location where the argument will appear to the callee.  */
1884 /* ??? tm.texi still only describes the old macro.  */
1885 DEFHOOK_UNDOC
1886 (function_incoming_arg,
1887  "",
1888  rtx, (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type,
1889        bool named),
1890  default_function_incoming_arg)
1891
1892 /* Return the diagnostic message string if function without a prototype
1893    is not allowed for this 'val' argument; NULL otherwise. */
1894 DEFHOOK
1895 (invalid_arg_for_unprototyped_fn,
1896  "",
1897  const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
1898  hook_invalid_arg_for_unprototyped_fn)
1899
1900 /* Return an rtx for the return value location of the function
1901    specified by FN_DECL_OR_TYPE with a return type of RET_TYPE.  */
1902 DEFHOOK
1903 (function_value,
1904  "",
1905  rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
1906  default_function_value)
1907
1908 /* Return the rtx for the result of a libcall of mode MODE,
1909    calling the function FN_NAME.  */
1910 DEFHOOK
1911 (libcall_value,
1912  "",
1913  rtx, (enum machine_mode mode, const_rtx fun),
1914  default_libcall_value)
1915
1916 /* Return true if REGNO is a possible register number for
1917    a function value as seen by the caller.  */
1918 DEFHOOK
1919 (function_value_regno_p,
1920  "",
1921  bool, (const unsigned int regno),
1922  default_function_value_regno_p)
1923
1924 /* ??? Documenting this hook requires a GFDL license grant.  */
1925 DEFHOOK_UNDOC
1926 (internal_arg_pointer,
1927 "Return an rtx for the argument pointer incoming to the\
1928  current function.",
1929  rtx, (void),
1930  default_internal_arg_pointer)
1931
1932 /* Update the current function stack boundary if needed.  */
1933 DEFHOOK
1934 (update_stack_boundary,
1935  "",
1936  void, (void), NULL)
1937
1938 /* Handle stack alignment and return an rtx for Dynamic Realign
1939    Argument Pointer if necessary.  */
1940 DEFHOOK
1941 (get_drap_rtx,
1942  "",
1943  rtx, (void), NULL)
1944
1945 /* Return true if all function parameters should be spilled to the
1946    stack.  */
1947 DEFHOOK
1948 (allocate_stack_slots_for_args,
1949  "",
1950  bool, (void),
1951  hook_bool_void_true)
1952
1953 /* Return an rtx for the static chain for FNDECL.  If INCOMING_P is true,
1954        then it should be for the callee; otherwise for the caller.  */
1955 DEFHOOK
1956 (static_chain,
1957  "",
1958  rtx, (const_tree fndecl, bool incoming_p),
1959  default_static_chain)
1960
1961 /* Fill in the trampoline at MEM with a call to FNDECL and a
1962    static chain value of CHAIN.  */
1963 DEFHOOK
1964 (trampoline_init,
1965  "",
1966  void, (rtx m_tramp, tree fndecl, rtx static_chain),
1967  default_trampoline_init)
1968
1969 /* Adjust the address of the trampoline in a target-specific way.  */
1970 DEFHOOK
1971 (trampoline_adjust_address,
1972  "",
1973  rtx, (rtx addr), NULL)
1974
1975 /* Return the number of bytes of its own arguments that a function
1976    pops on returning, or 0 if the function pops no arguments and the
1977    caller must therefore pop them all after the function returns.  */
1978 /* ??? tm.texi has no types for the parameters.  */
1979 DEFHOOK
1980 (return_pops_args,
1981  "",
1982  int, (tree fundecl, tree funtype, int size),
1983  default_return_pops_args)
1984
1985 /* Return a mode wide enough to copy any function value that might be
1986    returned.  */
1987 DEFHOOK
1988 (get_raw_result_mode,
1989  "This target hook returns the mode to be used when accessing raw return\
1990  registers in @code{__builtin_return}.  Define this macro if the value\
1991  in @var{reg_raw_mode} is not correct.",
1992  enum machine_mode, (int regno),
1993  default_get_reg_raw_mode)
1994
1995 /* Return a mode wide enough to copy any argument value that might be
1996    passed.  */
1997 DEFHOOK
1998 (get_raw_arg_mode,
1999  "This target hook returns the mode to be used when accessing raw argument\
2000  registers in @code{__builtin_apply_args}.  Define this macro if the value\
2001  in @var{reg_raw_mode} is not correct.",
2002  enum machine_mode, (int regno),
2003  default_get_reg_raw_mode)
2004
2005 HOOK_VECTOR_END (calls)
2006
2007 /* Return the diagnostic message string if conversion from FROMTYPE
2008    to TOTYPE is not allowed, NULL otherwise.  */
2009 DEFHOOK
2010 (invalid_conversion,
2011  "",
2012  const char *, (const_tree fromtype, const_tree totype),
2013  hook_constcharptr_const_tree_const_tree_null)
2014
2015 /* Return the diagnostic message string if the unary operation OP is
2016    not permitted on TYPE, NULL otherwise.  */
2017 DEFHOOK
2018 (invalid_unary_op,
2019  "",
2020  const char *, (int op, const_tree type),
2021  hook_constcharptr_int_const_tree_null)
2022
2023 /* Return the diagnostic message string if the binary operation OP
2024    is not permitted on TYPE1 and TYPE2, NULL otherwise.  */
2025 DEFHOOK
2026 (invalid_binary_op,
2027  "",
2028  const char *, (int op, const_tree type1, const_tree type2),
2029  hook_constcharptr_int_const_tree_const_tree_null)
2030
2031 /* Return the diagnostic message string if TYPE is not valid as a
2032    function parameter type, NULL otherwise.  */
2033 DEFHOOK
2034 (invalid_parameter_type,
2035  "",
2036  const char *, (const_tree type),
2037  hook_constcharptr_const_tree_null)
2038
2039 /* Return the diagnostic message string if TYPE is not valid as a
2040    function return type, NULL otherwise.  */
2041 DEFHOOK
2042 (invalid_return_type,
2043  "",
2044  const char *, (const_tree type),
2045  hook_constcharptr_const_tree_null)
2046
2047 /* If values of TYPE are promoted to some other type when used in
2048    expressions (analogous to the integer promotions), return that type,
2049    or NULL_TREE otherwise.  */
2050 DEFHOOK
2051 (promoted_type,
2052  "",
2053  tree, (const_tree type),
2054  hook_tree_const_tree_null)
2055
2056 /* Convert EXPR to TYPE, if target-specific types with special conversion
2057    rules are involved.  Return the converted expression, or NULL to apply
2058    the standard conversion rules.  */
2059 DEFHOOK
2060 (convert_to_type,
2061  "",
2062  tree, (tree type, tree expr),
2063  hook_tree_tree_tree_null)
2064
2065 /* Return the array of IRA cover classes for the current target.  */
2066 DEFHOOK
2067 (ira_cover_classes,
2068  "",
2069  const reg_class_t *, (void),
2070  default_ira_cover_classes)
2071
2072 /* Return the class for a secondary reload, and fill in extra information.  */
2073 DEFHOOK
2074 (secondary_reload,
2075  "",
2076  reg_class_t,
2077  (bool in_p, rtx x, reg_class_t reload_class, enum machine_mode reload_mode,
2078   secondary_reload_info *sri),
2079  default_secondary_reload)
2080
2081 /* Given an rtx X being reloaded into a reg required to be in class CLASS,
2082    return the class of reg to actually use.  */
2083 DEFHOOK
2084 (preferred_reload_class,
2085  "",
2086  reg_class_t,
2087  (rtx x, reg_class_t rclass),
2088  default_preferred_reload_class)
2089
2090 /* Like TARGET_PREFERRED_RELOAD_CLASS, but for output reloads instead of
2091    input reloads.  */
2092 DEFHOOK
2093 (preferred_output_reload_class,
2094  "",
2095  reg_class_t,
2096  (rtx x, reg_class_t rclass),
2097  default_preferred_output_reload_class)
2098
2099 DEFHOOK
2100 (class_likely_spilled_p,
2101  "",
2102  bool, (reg_class_t rclass),
2103  default_class_likely_spilled_p)
2104
2105 /* This target hook allows the backend to perform additional
2106    processing while initializing for variable expansion.  */
2107 DEFHOOK
2108 (expand_to_rtl_hook,
2109  "",
2110  void, (void),
2111  hook_void_void)
2112
2113 /* This target hook allows the backend to perform additional
2114    instantiations on rtx that are not actually in insns yet,
2115    but will be later.  */
2116 DEFHOOK
2117 (instantiate_decls,
2118  "",
2119  void, (void),
2120  hook_void_void)
2121
2122 /* Return true if is OK to use a hard register REGNO as scratch register
2123    in peephole2.  */
2124 DEFHOOK
2125 (hard_regno_scratch_ok,
2126  "",
2127  bool, (unsigned int regno),
2128  default_hard_regno_scratch_ok)
2129
2130 /* Return the smallest number of different values for which it is best to
2131    use a jump-table instead of a tree of conditional branches.  */
2132 DEFHOOK
2133 (case_values_threshold,
2134  "",
2135  unsigned int, (void),
2136  default_case_values_threshold)
2137
2138 /* Retutn true if a function must have and use a frame pointer.  */
2139 DEFHOOK
2140 (frame_pointer_required,
2141  "",
2142  bool, (void),
2143  hook_bool_void_false)
2144
2145 /* Returns true if the compiler is allowed to try to replace register number
2146    from-reg with register number to-reg.  */
2147 DEFHOOK
2148 (can_eliminate,
2149  "",
2150  bool, (const int from_reg, const int to_reg),
2151  hook_bool_const_int_const_int_true)
2152
2153 /* Functions specific to the C family of frontends.  */
2154 #undef HOOK_PREFIX
2155 #define HOOK_PREFIX "TARGET_C_"
2156 HOOK_VECTOR (TARGET_C, c)
2157
2158 /* ??? Documenting this hook requires a GFDL license grant.  */
2159 DEFHOOK_UNDOC
2160 (mode_for_suffix,
2161 "Return machine mode for non-standard constant literal suffix @var{c},\
2162  or VOIDmode if non-standard suffixes are unsupported.",
2163  enum machine_mode, (char c),
2164  default_mode_for_suffix)
2165
2166 HOOK_VECTOR_END (c)
2167
2168 /* Functions specific to the C++ frontend.  */
2169 #undef HOOK_PREFIX
2170 #define HOOK_PREFIX "TARGET_CXX_"
2171 HOOK_VECTOR (TARGET_CXX, cxx)
2172
2173 /* Return the integer type used for guard variables.  */
2174 DEFHOOK
2175 (guard_type,
2176  "",
2177  tree, (void),
2178  default_cxx_guard_type)
2179
2180 /* Return true if only the low bit of the guard should be tested.  */
2181 DEFHOOK
2182 (guard_mask_bit,
2183  "",
2184  bool, (void),
2185  hook_bool_void_false)
2186
2187 /* Returns the size of the array cookie for an array of type.  */
2188 DEFHOOK
2189 (get_cookie_size,
2190  "",
2191  tree, (tree type),
2192  default_cxx_get_cookie_size)
2193
2194 /* Returns true if the element size should be stored in the array cookie.  */
2195 DEFHOOK
2196 (cookie_has_size,
2197  "",
2198  bool, (void),
2199  hook_bool_void_false)
2200
2201 /* Allows backends to perform additional processing when
2202    deciding if a class should be exported or imported.  */
2203 DEFHOOK
2204 (import_export_class,
2205  "",
2206  int, (tree type, int import_export), NULL)
2207
2208 /* Returns true if constructors and destructors return "this".  */
2209 DEFHOOK
2210 (cdtor_returns_this,
2211  "",
2212  bool, (void),
2213  hook_bool_void_false)
2214
2215 /* Returns true if the key method for a class can be an inline
2216    function, so long as it is not declared inline in the class
2217    itself.  Returning true is the behavior required by the Itanium C++ ABI.  */
2218 DEFHOOK
2219 (key_method_may_be_inline,
2220  "",
2221  bool, (void),
2222  hook_bool_void_true)
2223
2224 DEFHOOK
2225 (determine_class_data_visibility,
2226 "@var{decl} is a virtual table, virtual table table, typeinfo object,\
2227  or other similar implicit class data object that will be emitted with\
2228  external linkage in this translation unit.  No ELF visibility has been\
2229  explicitly specified.  If the target needs to specify a visibility\
2230  other than that of the containing class, use this hook to set\
2231  @code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
2232  void, (tree decl),
2233  hook_void_tree)
2234
2235 /* Returns true (the default) if virtual tables and other
2236    similar implicit class data objects are always COMDAT if they
2237    have external linkage.  If this hook returns false, then
2238    class data for classes whose virtual table will be emitted in
2239    only one translation unit will not be COMDAT.  */
2240 DEFHOOK
2241 (class_data_always_comdat,
2242  "",
2243  bool, (void),
2244  hook_bool_void_true)
2245
2246 /* Returns true (the default) if the RTTI for the basic types,
2247    which is always defined in the C++ runtime, should be COMDAT;
2248    false if it should not be COMDAT.  */
2249 DEFHOOK
2250 (library_rtti_comdat,
2251  "",
2252  bool, (void),
2253  hook_bool_void_true)
2254
2255 /* Returns true if __aeabi_atexit should be used to register static
2256    destructors.  */
2257 DEFHOOK
2258 (use_aeabi_atexit,
2259  "",
2260  bool, (void),
2261  hook_bool_void_false)
2262
2263 /* Returns true if target may use atexit in the same manner as
2264    __cxa_atexit  to register static destructors.  */
2265 DEFHOOK
2266 (use_atexit_for_cxa_atexit,
2267  "",
2268  bool, (void),
2269  hook_bool_void_false)
2270
2271 DEFHOOK
2272 (adjust_class_at_definition,
2273 "@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\
2274  been defined.  Use this hook to make adjustments to the class (eg, tweak\
2275  visibility or perform any other required target modifications).",
2276  void, (tree type),
2277  hook_void_tree)
2278
2279 HOOK_VECTOR_END (cxx)
2280
2281 /* Functions and data for emulated TLS support.  */
2282 #undef HOOK_PREFIX
2283 #define HOOK_PREFIX "TARGET_EMUTLS_"
2284 HOOK_VECTOR (TARGET_EMUTLS, emutls)
2285
2286 /* Name of the address and common functions.  */
2287 DEFHOOKPOD
2288 (get_address,
2289  "",
2290  const char *, "__builtin___emutls_get_address")
2291
2292 DEFHOOKPOD
2293 (register_common,
2294  "",
2295  const char *, "__builtin___emutls_register_common")
2296
2297 /* Prefixes for proxy variable and template.  */
2298 DEFHOOKPOD
2299 (var_section,
2300  "",
2301  const char *, NULL)
2302
2303 DEFHOOKPOD
2304 (tmpl_section,
2305  "",
2306  const char *, NULL)
2307
2308 /* Prefixes for proxy variable and template.  */
2309 DEFHOOKPOD
2310 (var_prefix,
2311  "",
2312  const char *, NULL)
2313
2314 DEFHOOKPOD
2315 (tmpl_prefix,
2316  "",
2317  const char *, NULL)
2318
2319 /* Function to generate field definitions of the proxy variable.  */
2320 DEFHOOK
2321 (var_fields,
2322  "",
2323  tree, (tree type, tree *name),
2324  default_emutls_var_fields)
2325
2326 /* Function to initialize a proxy variable.  */
2327 DEFHOOK
2328 (var_init,
2329  "",
2330  tree, (tree var, tree decl, tree tmpl_addr),
2331  default_emutls_var_init)
2332
2333 /* Whether we are allowed to alter the usual alignment of the
2334    proxy variable.  */
2335 DEFHOOKPOD
2336 (var_align_fixed,
2337  "",
2338  bool, false)
2339
2340 /* Whether we can emit debug information for TLS vars.  */
2341 DEFHOOKPOD
2342 (debug_form_tls_address,
2343  "",
2344  bool, false)
2345
2346 HOOK_VECTOR_END (emutls)
2347
2348 #undef HOOK_PREFIX
2349 #define HOOK_PREFIX "TARGET_OPTION_"
2350 HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
2351
2352 /* Function to validate the attribute((option(...))) strings or NULL.  If
2353    the option is validated, it is assumed that DECL_FUNCTION_SPECIFIC will
2354    be filled in in the function decl node.  */
2355 DEFHOOK
2356 (valid_attribute_p,
2357  "",
2358  bool, (tree fndecl, tree name, tree args, int flags),
2359  default_target_option_valid_attribute_p)
2360
2361 /* Function to save any extra target state in the target options structure.  */
2362 DEFHOOK
2363 (save,
2364  "",
2365  void, (struct cl_target_option *ptr), NULL)
2366
2367 /* Function to restore any extra target state from the target options
2368    structure.  */
2369 DEFHOOK
2370 (restore,
2371  "",
2372  void, (struct cl_target_option *ptr), NULL)
2373
2374 /* Function to print any extra target state from the target options
2375    structure.  */
2376 DEFHOOK
2377 (print,
2378  "",
2379  void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
2380
2381 /* Function to parse arguments to be validated for #pragma option, and to
2382    change the state if the options are valid.  If the first argument is
2383    NULL, the second argument specifies the default options to use.  Return
2384    true if the options are valid, and set the current state.  */
2385 /* ??? The documentation in tm.texi is incomplete.  */
2386 DEFHOOK
2387 (pragma_parse,
2388  "",
2389  bool, (tree args, tree pop_target),
2390  default_target_option_pragma_parse)
2391
2392 /* Do option overrides for the target.  */
2393 DEFHOOK
2394 (override,
2395  "",
2396  void, (void),
2397  hook_void_void)
2398
2399 /* Set default optimizations for the target.  */
2400 DEFHOOKPOD
2401 (optimization_table,
2402  "",
2403  const struct default_options *, empty_optimization_table)
2404
2405 DEFHOOK
2406 (default_params,
2407 "Set target-dependent default values for @option{--param} settings, using\
2408  calls to @code{set_default_param_value}.",
2409  void, (void),
2410  hook_void_void)
2411
2412 DEFHOOK
2413 (init_struct,
2414 "Set target-dependent initial values of fields in @var{opts}.",
2415  void, (struct gcc_options *opts),
2416  hook_void_gcc_optionsp)
2417
2418 /* Function to determine if one function can inline another function.  */
2419 #undef HOOK_PREFIX
2420 #define HOOK_PREFIX "TARGET_"
2421 DEFHOOK
2422 (can_inline_p,
2423  "",
2424  bool, (tree caller, tree callee),
2425  default_target_can_inline_p)
2426
2427 HOOK_VECTOR_END (target_option)
2428
2429 /* For targets that need to mark extra registers as live on entry to
2430    the function, they should define this target hook and set their
2431    bits in the bitmap passed in. */
2432 DEFHOOK
2433 (extra_live_on_entry,
2434  "",
2435  void, (bitmap regs),
2436  hook_void_bitmap)
2437
2438 /* Determine the type of unwind info to emit for debugging.  */
2439 DEFHOOK
2440 (debug_unwind_info,
2441  "",
2442  enum unwind_info_type, (void),
2443  default_debug_unwind_info)
2444
2445 /* Determine the type of unwind info to emit for exceptions.  */
2446 DEFHOOK
2447 (except_unwind_info,
2448  "",
2449  enum unwind_info_type, (void),
2450  default_except_unwind_info)
2451
2452 /* Leave the boolean fields at the end.  */
2453
2454 /* True if unwinding tables should be generated by default.  */
2455 DEFHOOKPOD
2456 (unwind_tables_default,
2457  "",
2458  bool, false)
2459
2460 /* True if arbitrary sections are supported.  */
2461 DEFHOOKPOD
2462 (have_named_sections,
2463  "",
2464  bool, false)
2465
2466 /* True if we can create zeroed data by switching to a BSS section
2467    and then using ASM_OUTPUT_SKIP to allocate the space.  */
2468 DEFHOOKPOD
2469 (have_switchable_bss_sections,
2470  "",
2471  bool, false)
2472
2473 /* True if "native" constructors and destructors are supported,
2474    false if we're using collect2 for the job.  */
2475 DEFHOOKPOD
2476 (have_ctors_dtors,
2477  "",
2478  bool, false)
2479
2480 /* True if thread-local storage is supported.  */
2481 DEFHOOKPOD
2482 (have_tls,
2483  "",
2484  bool, false)
2485
2486 /* True if a small readonly data section is supported.  */
2487 DEFHOOKPOD
2488 (have_srodata_section,
2489  "",
2490  bool, false)
2491
2492 /* True if EH frame info sections should be zero-terminated.  */
2493 DEFHOOKPOD
2494 (terminate_dw2_eh_frame_info,
2495  "",
2496  bool, true)
2497
2498 /* True if #NO_APP should be emitted at the beginning of assembly output.  */
2499 DEFHOOKPOD
2500 (asm_file_start_app_off,
2501  "",
2502  bool, false)
2503
2504 /* True if output_file_directive should be called for main_input_filename
2505    at the beginning of assembly output.  */
2506 DEFHOOKPOD
2507 (asm_file_start_file_directive,
2508  "",
2509  bool, false)
2510
2511 DEFHOOKPOD
2512 (handle_pragma_extern_prefix,
2513 "True if @code{#pragma extern_prefix} is to be supported.",
2514  bool, 0)
2515
2516 /* True if the target is allowed to reorder memory accesses unless
2517    synchronization is explicitly requested.  */
2518 DEFHOOKPOD
2519 (relaxed_ordering,
2520  "",
2521  bool, false)
2522
2523 /* Returns true if we should generate exception tables for use with the
2524    ARM EABI.  The effects the encoding of function exception specifications.  */
2525 DEFHOOKPOD
2526 (arm_eabi_unwinder,
2527  "",
2528  bool, false)
2529
2530 DEFHOOKPOD
2531 (want_debug_pub_sections,
2532  "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\
2533  should be emitted.  These sections are not used on most platforms, and\
2534  in particular GDB does not use them.",
2535  bool, false)
2536
2537 /* Leave the boolean fields at the end.  */
2538
2539 /* Empty macro arguments are undefined in C90, so use an empty macro.  */
2540 #define C90_EMPTY_HACK
2541 /* Close the 'struct gcc_target' definition.  */
2542 HOOK_VECTOR_END (C90_EMPTY_HACK)
2543
2544 HOOK_VECTOR (TARGETCM_INITIALIZER, gcc_targetcm)
2545
2546 /* Handle target switch CODE (an OPT_* value).  ARG is the argument
2547    passed to the switch; it is NULL if no argument was.  VALUE is the
2548    value of ARG if CODE specifies a UInteger option, otherwise it is
2549    1 if the positive form of the switch was used and 0 if the negative
2550    form was.  Return true if the switch was valid.  */
2551 DEFHOOK
2552 (handle_c_option,
2553  "",
2554  bool, (size_t code, const char *arg, int value),
2555  default_handle_c_option)
2556
2557 DEFHOOK
2558 (objc_construct_string,
2559  "Construct a constant string representation for @var{string}",
2560  tree, (tree string),
2561  NULL)
2562
2563 HOOK_VECTOR_END (C90_EMPTY_HACK)