OSDN Git Service

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