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