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