OSDN Git Service

857f463217f11f1678a72267c05c8003832c6ba5
[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  default_asm_output_addr_const_extra)
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 HOOK_VECTOR_END (sched)
917
918 /* Functions relating to vectorization.  */
919 #undef HOOK_PREFIX
920 #define HOOK_PREFIX "TARGET_VECTORIZE_"
921 HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
922
923 /* The following member value is a pointer to a function called
924    by the vectorizer, and return the decl of the target builtin
925    function.  */
926 DEFHOOK
927 (builtin_mask_for_load,
928  "",
929  tree, (void), NULL)
930
931 /* Returns a code for builtin that realizes vectorized version of
932    function, or NULL_TREE if not available.  */
933 DEFHOOK
934 (builtin_vectorized_function,
935  "",
936  tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
937  default_builtin_vectorized_function)
938
939 /* Returns a function declaration for a builtin that realizes the
940    vector conversion, or NULL_TREE if not available.  */
941 DEFHOOK
942 (builtin_conversion,
943  "",
944  tree, (unsigned code, tree dest_type, tree src_type),
945  default_builtin_vectorized_conversion)
946
947 /* Target builtin that implements vector widening multiplication.
948    builtin_mul_widen_eve computes the element-by-element products
949    for the even elements, and builtin_mul_widen_odd computes the
950    element-by-element products for the odd elements.  */
951 DEFHOOK
952 (builtin_mul_widen_even,
953  "",
954  tree, (tree x), NULL)
955
956 DEFHOOK
957 (builtin_mul_widen_odd,
958  "",
959  tree, (tree x), NULL)
960
961 /* Cost of different vector/scalar statements in vectorization cost
962    model. In case of misaligned vector loads and stores the cost depends
963    on the data type and misalignment value.  */
964 DEFHOOK
965 (builtin_vectorization_cost,
966  "",
967  int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
968  default_builtin_vectorization_cost)
969
970 /* Return true if vector alignment is reachable (by peeling N
971    iterations) for the given type.  */
972 DEFHOOK
973 (vector_alignment_reachable,
974  "",
975  bool, (const_tree type, bool is_packed),
976  default_builtin_vector_alignment_reachable)
977
978 /* Target builtin that implements vector permute.  */
979 DEFHOOK
980 (builtin_vec_perm,
981  "",
982  tree, (tree type, tree *mask_element_type), NULL)
983
984 /* Return true if a vector created for builtin_vec_perm is valid.  */
985 DEFHOOK
986 (builtin_vec_perm_ok,
987  "",
988  bool, (tree vec_type, tree mask),
989  hook_bool_tree_tree_true)
990
991 /* Return true if the target supports misaligned store/load of a
992    specific factor denoted in the third parameter.  The last parameter
993    is true if the access is defined in a packed struct.  */
994 DEFHOOK
995 (support_vector_misalignment,
996  "",
997  bool,
998  (enum machine_mode mode, const_tree type, int misalignment, bool is_packed),
999  default_builtin_support_vector_misalignment)
1000
1001 /* Returns the preferred mode for SIMD operations for the specified
1002    scalar mode.  */
1003 DEFHOOK
1004 (preferred_simd_mode,
1005  "",
1006  enum machine_mode,
1007  (enum machine_mode mode),
1008  default_preferred_simd_mode)
1009
1010 /* Returns a mask of vector sizes to iterate over when auto-vectorizing
1011    after processing the preferred one derived from preferred_simd_mode.  */
1012 DEFHOOK
1013 (autovectorize_vector_sizes,
1014  "",
1015  unsigned int,
1016  (void),
1017  default_autovectorize_vector_sizes)
1018
1019 HOOK_VECTOR_END (vectorize)
1020
1021 #undef HOOK_PREFIX
1022 #define HOOK_PREFIX "TARGET_"
1023
1024 /* Allow target specific overriding of option settings after options have
1025   been changed by an attribute or pragma or when it is reset at the
1026   end of the code affected by an attribute or pragma.  */
1027 DEFHOOK
1028 (override_options_after_change,
1029  "",
1030  void, (void),
1031  hook_void_void)
1032
1033 DEFHOOK_UNDOC
1034 (eh_return_filter_mode,
1035  "Return machine mode for filter value.",
1036  enum machine_mode, (void),
1037  default_eh_return_filter_mode)
1038
1039 /* Return machine mode for libgcc expanded cmp instructions.  */
1040 DEFHOOK
1041 (libgcc_cmp_return_mode,
1042  "",
1043  enum machine_mode, (void),
1044  default_libgcc_cmp_return_mode)
1045
1046 /* Return machine mode for libgcc expanded shift instructions.  */
1047 DEFHOOK
1048 (libgcc_shift_count_mode,
1049  "",
1050  enum machine_mode, (void),
1051  default_libgcc_shift_count_mode)
1052
1053 /* Return machine mode to be used for _Unwind_Word type.  */
1054 DEFHOOK
1055 (unwind_word_mode,
1056  "",
1057  enum machine_mode, (void),
1058  default_unwind_word_mode)
1059
1060 /* Given two decls, merge their attributes and return the result.  */
1061 DEFHOOK
1062 (merge_decl_attributes,
1063  "",
1064  tree, (tree olddecl, tree newdecl),
1065  merge_decl_attributes)
1066
1067 /* Given two types, merge their attributes and return the result.  */
1068 DEFHOOK
1069 (merge_type_attributes,
1070  "",
1071  tree, (tree type1, tree type2),
1072  merge_type_attributes)
1073
1074 /* Table of machine attributes and functions to handle them.
1075    Ignored if NULL.  */
1076 DEFHOOKPOD
1077 (attribute_table,
1078  "",
1079  const struct attribute_spec *, NULL)
1080
1081 /* Return true iff attribute NAME expects a plain identifier as its first
1082    argument.  */
1083 DEFHOOK
1084 (attribute_takes_identifier_p,
1085  "",
1086  bool, (const_tree name),
1087  hook_bool_const_tree_false)
1088
1089 /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible,
1090    one if they are compatible and two if they are nearly compatible
1091    (which causes a warning to be generated).  */
1092 DEFHOOK
1093 (comp_type_attributes,
1094  "",
1095  int, (const_tree type1, const_tree type2),
1096  hook_int_const_tree_const_tree_1)
1097
1098 /* Assign default attributes to the newly defined TYPE.  */
1099 DEFHOOK
1100 (set_default_type_attributes,
1101  "",
1102  void, (tree type),
1103  hook_void_tree)
1104
1105 /* Insert attributes on the newly created DECL.  */
1106 DEFHOOK
1107 (insert_attributes,
1108  "",
1109  void, (tree node, tree *attr_ptr),
1110  hook_void_tree_treeptr)
1111
1112 /* Return true if FNDECL (which has at least one machine attribute)
1113    can be inlined despite its machine attributes, false otherwise.  */
1114 DEFHOOK
1115 (function_attribute_inlinable_p,
1116  "",
1117  bool, (const_tree fndecl),
1118  hook_bool_const_tree_false)
1119
1120 /* Return true if bitfields in RECORD_TYPE should follow the
1121    Microsoft Visual C++ bitfield layout rules.  */
1122 DEFHOOK
1123 (ms_bitfield_layout_p,
1124  "",
1125  bool, (const_tree record_type),
1126  hook_bool_const_tree_false)
1127
1128 /* For now this is only an interface to WORDS_BIG_ENDIAN for
1129    target-independent code like the front ends, need performance testing
1130    before switching completely to the target hook.  */
1131 DEFHOOK_UNDOC
1132 (words_big_endian,
1133  "",
1134  bool, (void),
1135  targhook_words_big_endian)
1136
1137 /* Likewise for FLOAT_WORDS_BIG_ENDIAN.  */
1138 DEFHOOK_UNDOC
1139 (float_words_big_endian,
1140  "",
1141  bool, (void),
1142  targhook_float_words_big_endian)
1143
1144 /* True if the target supports decimal floating point.  */
1145 DEFHOOK
1146 (decimal_float_supported_p,
1147  "",
1148  bool, (void),
1149  default_decimal_float_supported_p)
1150
1151 /* True if the target supports fixed-point.  */
1152 DEFHOOK
1153 (fixed_point_supported_p,
1154  "",
1155  bool, (void),
1156  default_fixed_point_supported_p)
1157
1158 /* Return true if anonymous bitfields affect structure alignment.  */
1159 DEFHOOK
1160 (align_anon_bitfield,
1161  "",
1162  bool, (void),
1163  hook_bool_void_false)
1164
1165 /* Return true if volatile bitfields should use the narrowest type possible.
1166    Return false if they should use the container type.  */
1167 DEFHOOK
1168 (narrow_volatile_bitfield,
1169  "",
1170  bool, (void),
1171  hook_bool_void_false)
1172
1173 /* Set up target-specific built-in functions.  */
1174 DEFHOOK
1175 (init_builtins,
1176  "",
1177  void, (void),
1178  hook_void_void)
1179
1180 /* Initialize (if INITIALIZE_P is true) and return the target-specific
1181    built-in function decl for CODE.
1182    Return NULL if that is not possible.  Return error_mark_node if CODE
1183    is outside of the range of valid target builtin function codes.  */
1184 DEFHOOK
1185 (builtin_decl,
1186  "",
1187  tree, (unsigned code, bool initialize_p), NULL)
1188
1189 /* Expand a target-specific builtin.  */
1190 DEFHOOK
1191 (expand_builtin,
1192  "",
1193  rtx,
1194  (tree exp, rtx target, rtx subtarget, enum machine_mode mode, int ignore),
1195  default_expand_builtin)
1196
1197 /* Select a replacement for a target-specific builtin.  This is done
1198    *before* regular type checking, and so allows the target to
1199    implement a crude form of function overloading.  The result is a
1200    complete expression that implements the operation.  PARAMS really
1201    has type VEC(tree,gc)*, but we don't want to include tree.h here.  */
1202 DEFHOOK
1203 (resolve_overloaded_builtin,
1204  "",
1205  tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
1206
1207 /* Fold a target-specific builtin.  */
1208 DEFHOOK
1209 (fold_builtin,
1210  "",
1211  tree, (tree fndecl, int n_args, tree *argp, bool ignore),
1212  hook_tree_tree_int_treep_bool_null)
1213
1214 /* Returns a code for a target-specific builtin that implements
1215    reciprocal of the function, or NULL_TREE if not available.  */
1216 DEFHOOK
1217 (builtin_reciprocal,
1218  "",
1219  tree, (unsigned fn, bool md_fn, bool sqrt),
1220  default_builtin_reciprocal)
1221
1222 /* For a vendor-specific TYPE, return a pointer to a statically-allocated
1223    string containing the C++ mangling for TYPE.  In all other cases, return
1224    NULL.  */
1225 DEFHOOK
1226 (mangle_type,
1227  "",
1228  const char *, (const_tree type),
1229  hook_constcharptr_const_tree_null)
1230
1231 /* Make any adjustments to libfunc names needed for this target.  */
1232 DEFHOOK
1233 (init_libfuncs,
1234  "",
1235  void, (void),
1236  hook_void_void)
1237
1238  /* Add a __gnu_ prefix to library functions rather than just __.  */
1239 DEFHOOKPOD
1240 (libfunc_gnu_prefix,
1241  "If false (the default), internal library routines start with two\n\
1242 underscores.  If set to true, these routines start with @code{__gnu_}\n\
1243 instead.  E.g., @code{__muldi3} changes to @code{__gnu_muldi3}.  This\n\
1244 currently only affects functions defined in @file{libgcc2.c}.  If this\n\
1245 is set to true, the @file{tm.h} file must also\n\
1246 @code{#define LIBGCC2_GNU_PREFIX}.",
1247   bool, false)
1248
1249 /* Given a decl, a section name, and whether the decl initializer
1250    has relocs, choose attributes for the section.  */
1251 /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION.  */
1252 DEFHOOK
1253 (section_type_flags,
1254  "",
1255  unsigned int, (tree decl, const char *name, int reloc),
1256  default_section_type_flags)
1257
1258 /* True if new jumps cannot be created, to replace existing ones or
1259    not, at the current point in the compilation.  */
1260 DEFHOOK
1261 (cannot_modify_jumps_p,
1262  "",
1263  bool, (void),
1264  hook_bool_void_false)
1265
1266 /* Return a register class for which branch target register
1267    optimizations should be applied.  */
1268 DEFHOOK
1269 (branch_target_register_class,
1270  "",
1271  reg_class_t, (void),
1272  default_branch_target_register_class)
1273
1274 /* Return true if branch target register optimizations should include
1275    callee-saved registers that are not already live during the current
1276    function.  AFTER_PE_GEN is true if prologues and epilogues have
1277    already been generated.  */
1278 DEFHOOK
1279 (branch_target_register_callee_saved,
1280  "",
1281  bool, (bool after_prologue_epilogue_gen),
1282  hook_bool_bool_false)
1283
1284 /* Return true if the target supports conditional execution.  */
1285 DEFHOOK
1286 (have_conditional_execution,
1287  "",
1288  bool, (void),
1289  default_have_conditional_execution)
1290
1291 /* Return a new value for loop unroll size.  */
1292 DEFHOOK
1293 (loop_unroll_adjust,
1294  "",
1295  unsigned, (unsigned nunroll, struct loop *loop),
1296  NULL)
1297
1298 /* True if X is a legitimate MODE-mode immediate operand.  */
1299 DEFHOOK
1300 (legitimate_constant_p,
1301  "",
1302  bool, (enum machine_mode mode, rtx x),
1303  hook_bool_mode_rtx_true)
1304
1305 /* True if the constant X cannot be placed in the constant pool.  */
1306 DEFHOOK
1307 (cannot_force_const_mem,
1308  "",
1309  bool, (enum machine_mode mode, rtx x),
1310  hook_bool_mode_rtx_false)
1311
1312 DEFHOOK_UNDOC
1313 (cannot_copy_insn_p,
1314  "True if the insn @var{x} cannot be duplicated.",
1315  bool, (rtx), NULL)
1316
1317 /* True if X is considered to be commutative.  */
1318 DEFHOOK
1319 (commutative_p,
1320  "",
1321  bool, (const_rtx x, int outer_code),
1322  hook_bool_const_rtx_commutative_p)
1323
1324 /* True if ADDR is an address-expression whose effect depends
1325    on the mode of the memory reference it is used in.  */
1326 DEFHOOK
1327 (mode_dependent_address_p,
1328  "",
1329  bool, (const_rtx addr),
1330  default_mode_dependent_address_p)
1331
1332 /* Given an invalid address X for a given machine mode, try machine-specific
1333    ways to make it legitimate.  Return X or an invalid address on failure.  */
1334 DEFHOOK
1335 (legitimize_address,
1336  "",
1337  rtx, (rtx x, rtx oldx, enum machine_mode mode),
1338  default_legitimize_address)
1339
1340 /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS.  */
1341 DEFHOOK
1342 (delegitimize_address,
1343  "",
1344  rtx, (rtx x),
1345  delegitimize_mem_from_attrs)
1346
1347 /* Given an address RTX, say whether it is valid.  */
1348 DEFHOOK
1349 (legitimate_address_p,
1350  "",
1351  bool, (enum machine_mode mode, rtx x, bool strict),
1352  default_legitimate_address_p)
1353
1354 /* True if the given constant can be put into an object_block.  */
1355 DEFHOOK
1356 (use_blocks_for_constant_p,
1357  "",
1358  bool, (enum machine_mode mode, const_rtx x),
1359  hook_bool_mode_const_rtx_false)
1360
1361 /* The minimum and maximum byte offsets for anchored addresses.  */
1362 DEFHOOKPOD
1363 (min_anchor_offset,
1364  "",
1365  HOST_WIDE_INT, 0)
1366
1367 DEFHOOKPOD
1368 (max_anchor_offset,
1369  "",
1370  HOST_WIDE_INT, 0)
1371
1372 /* True if section anchors can be used to access the given symbol.  */
1373 DEFHOOK
1374 (use_anchors_for_symbol_p,
1375  "",
1376  bool, (const_rtx x),
1377  default_use_anchors_for_symbol_p)
1378
1379 /* True if it is OK to do sibling call optimization for the specified
1380    call expression EXP.  DECL will be the called function, or NULL if
1381    this is an indirect call.  */
1382 DEFHOOK
1383 (function_ok_for_sibcall,
1384  "",
1385  bool, (tree decl, tree exp),
1386  hook_bool_tree_tree_false)
1387
1388 /* Establish appropriate back-end context for processing the function
1389    FNDECL.  The argument might be NULL to indicate processing at top
1390    level, outside of any function scope.  */
1391 DEFHOOK
1392 (set_current_function,
1393  "",
1394  void, (tree decl), hook_void_tree)
1395
1396 /* True if EXP should be placed in a "small data" section.  */
1397 DEFHOOK
1398 (in_small_data_p,
1399  "",
1400  bool, (const_tree exp),
1401  hook_bool_const_tree_false)
1402
1403 /* True if EXP names an object for which name resolution must resolve
1404    to the current executable or shared library.  */
1405 DEFHOOK
1406 (binds_local_p,
1407  "",
1408  bool, (const_tree exp),
1409  default_binds_local_p)
1410
1411 /* Check if profiling code is before or after prologue.  */
1412 DEFHOOK
1413 (profile_before_prologue,
1414  "It returns true if target wants profile code emitted before prologue.\n\n\
1415 The default version of this hook use the target macro\n\
1416 @code{PROFILE_BEFORE_PROLOGUE}.",
1417  bool, (void),
1418  default_profile_before_prologue)
1419
1420 /* Modify and return the identifier of a DECL's external name,
1421    originally identified by ID, as required by the target,
1422    (eg, append @nn to windows32 stdcall function names).
1423    The default is to return ID without modification. */
1424 DEFHOOK
1425 (mangle_decl_assembler_name,
1426  "",
1427  tree, (tree decl, tree  id),
1428  default_mangle_decl_assembler_name)
1429
1430 /* Do something target-specific to record properties of the DECL into
1431    the associated SYMBOL_REF.  */
1432 DEFHOOK
1433 (encode_section_info,
1434  "",
1435  void, (tree decl, rtx rtl, int new_decl_p),
1436  default_encode_section_info)
1437
1438 /* Undo the effects of encode_section_info on the symbol string.  */
1439 DEFHOOK
1440 (strip_name_encoding,
1441  "",
1442  const char *, (const char *name),
1443  default_strip_name_encoding)
1444
1445 /* If shift optabs for MODE are known to always truncate the shift count,
1446    return the mask that they apply.  Return 0 otherwise.  */
1447 DEFHOOK
1448 (shift_truncation_mask,
1449  "",
1450  unsigned HOST_WIDE_INT, (enum machine_mode mode),
1451  default_shift_truncation_mask)
1452
1453 /* Return the number of divisions in the given MODE that should be present,
1454    so that it is profitable to turn the division into a multiplication by
1455    the reciprocal.  */
1456 DEFHOOK
1457 (min_divisions_for_recip_mul,
1458  "",
1459  unsigned int, (enum machine_mode mode),
1460  default_min_divisions_for_recip_mul)
1461
1462 /* If the representation of integral MODE is such that values are
1463    always sign-extended to a wider mode MODE_REP then return
1464    SIGN_EXTEND.  Return UNKNOWN otherwise.  */
1465 /* Note that the return type ought to be RTX_CODE, but that's not
1466    necessarily defined at this point.  */
1467 DEFHOOK
1468 (mode_rep_extended,
1469  "",
1470  int, (enum machine_mode mode, enum machine_mode rep_mode),
1471  default_mode_rep_extended)
1472
1473 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))).  */
1474 DEFHOOK
1475 (valid_pointer_mode,
1476  "",
1477  bool, (enum machine_mode mode),
1478  default_valid_pointer_mode)
1479
1480 /* Disambiguate with errno.  */
1481 DEFHOOK
1482 (ref_may_alias_errno,
1483  "Define this to return nonzero if the memory reference @var{ref}\
1484   may alias with the system C library errno location.  The default\
1485   version of this hook assumes the system C library errno location\
1486   is either a declaration of type int or accessed by dereferencing\
1487   a pointer to int.",
1488  bool, (struct ao_ref_s *ref),
1489  default_ref_may_alias_errno)
1490
1491 /* Support for named address spaces.  */
1492 #undef HOOK_PREFIX
1493 #define HOOK_PREFIX "TARGET_ADDR_SPACE_"
1494 HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
1495
1496 /* MODE to use for a pointer into another address space.  */
1497 DEFHOOK
1498 (pointer_mode,
1499  "",
1500  enum machine_mode, (addr_space_t address_space),
1501  default_addr_space_pointer_mode)
1502
1503 /* MODE to use for an address in another address space.  */
1504 DEFHOOK
1505 (address_mode,
1506  "",
1507  enum machine_mode, (addr_space_t address_space),
1508  default_addr_space_address_mode)
1509
1510 /* True if MODE is valid for a pointer in __attribute__((mode("MODE")))
1511    in another address space.  */
1512 DEFHOOK
1513 (valid_pointer_mode,
1514  "",
1515  bool, (enum machine_mode mode, addr_space_t as),
1516  default_addr_space_valid_pointer_mode)
1517
1518 /* True if an address is a valid memory address to a given named address
1519    space for a given mode.  */
1520 DEFHOOK
1521 (legitimate_address_p,
1522  "",
1523  bool, (enum machine_mode mode, rtx exp, bool strict, addr_space_t as),
1524  default_addr_space_legitimate_address_p)
1525
1526 /* Return an updated address to convert an invalid pointer to a named
1527    address space to a valid one.  If NULL_RTX is returned use machine
1528    independent methods to make the address valid.  */
1529 DEFHOOK
1530 (legitimize_address,
1531  "",
1532  rtx, (rtx x, rtx oldx, enum machine_mode mode, addr_space_t as),
1533  default_addr_space_legitimize_address)
1534
1535 /* True if one named address space is a subset of another named address. */
1536 DEFHOOK
1537 (subset_p,
1538  "",
1539  bool, (addr_space_t superset, addr_space_t subset),
1540  default_addr_space_subset_p)
1541
1542 /* Function to convert an rtl expression from one address space to another.  */
1543 DEFHOOK
1544 (convert,
1545  "",
1546  rtx, (rtx op, tree from_type, tree to_type),
1547  default_addr_space_convert)
1548
1549 HOOK_VECTOR_END (addr_space)
1550
1551 #undef HOOK_PREFIX
1552 #define HOOK_PREFIX "TARGET_"
1553
1554 /* True if MODE is valid for the target.  By "valid", we mean able to
1555    be manipulated in non-trivial ways.  In particular, this means all
1556    the arithmetic is supported.  */
1557 DEFHOOK
1558 (scalar_mode_supported_p,
1559  "",
1560  bool, (enum machine_mode mode),
1561  default_scalar_mode_supported_p)
1562
1563 /* Similarly for vector modes.  "Supported" here is less strict.  At
1564    least some operations are supported; need to check optabs or builtins
1565    for further details.  */
1566 DEFHOOK
1567 (vector_mode_supported_p,
1568  "",
1569  bool, (enum machine_mode mode),
1570  hook_bool_mode_false)
1571
1572 /* True if we should try to use a scalar mode to represent an array,
1573    overriding the usual MAX_FIXED_MODE limit.  */
1574 DEFHOOK
1575 (array_mode_supported_p,
1576  "Return true if GCC should try to use a scalar mode to store an array\n\
1577 of @var{nelems} elements, given that each element has mode @var{mode}.\n\
1578 Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
1579 and allows GCC to use any defined integer mode.\n\
1580 \n\
1581 One use of this hook is to support vector load and store operations\n\
1582 that operate on several homogeneous vectors.  For example, ARM NEON\n\
1583 has operations like:\n\
1584 \n\
1585 @smallexample\n\
1586 int8x8x3_t vld3_s8 (const int8_t *)\n\
1587 @end smallexample\n\
1588 \n\
1589 where the return type is defined as:\n\
1590 \n\
1591 @smallexample\n\
1592 typedef struct int8x8x3_t\n\
1593 @{\n\
1594   int8x8_t val[3];\n\
1595 @} int8x8x3_t;\n\
1596 @end smallexample\n\
1597 \n\
1598 If this hook allows @code{val} to have a scalar mode, then\n\
1599 @code{int8x8x3_t} can have the same mode.  GCC can then store\n\
1600 @code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
1601  bool, (enum machine_mode mode, unsigned HOST_WIDE_INT nelems),
1602  hook_bool_mode_uhwi_false)
1603
1604 /* Compute cost of moving data from a register of class FROM to one of
1605    TO, using MODE.  */
1606 DEFHOOK
1607 (register_move_cost,
1608  "",
1609  int, (enum machine_mode mode, reg_class_t from, reg_class_t to),
1610  default_register_move_cost)
1611
1612 /* Compute cost of moving registers to/from memory.  */
1613 /* ??? Documenting the argument types for this hook requires a GFDL
1614    license grant.  Also, the documentation uses a different name for RCLASS.  */
1615 DEFHOOK
1616 (memory_move_cost,
1617  "",
1618  int, (enum machine_mode mode, reg_class_t rclass, bool in),
1619  default_memory_move_cost)
1620
1621 /* True for MODE if the target expects that registers in this mode will
1622    be allocated to registers in a small register class.  The compiler is
1623    allowed to use registers explicitly used in the rtl as spill registers
1624    but it should prevent extending the lifetime of these registers.  */
1625 DEFHOOK
1626 (small_register_classes_for_mode_p,
1627  "",
1628  bool, (enum machine_mode mode),
1629  hook_bool_mode_false)
1630
1631 /* Register number for a flags register.  Only needs to be defined if the
1632    target is constrainted to use post-reload comparison elimination.  */
1633 DEFHOOKPOD
1634 (flags_regnum,
1635  "If the target has a dedicated flags register, and it needs to use the\
1636  post-reload comparison elimination pass, then this value should be set\
1637  appropriately.",
1638  unsigned int, INVALID_REGNUM)
1639
1640 /* Compute a (partial) cost for rtx X.  Return true if the complete
1641    cost has been computed, and false if subexpressions should be
1642    scanned.  In either case, *TOTAL contains the cost result.  */
1643 /* Note that CODE and OUTER_CODE ought to be RTX_CODE, but that's
1644    not necessarily defined at this point.  */
1645 DEFHOOK
1646 (rtx_costs,
1647  "",
1648  bool, (rtx x, int code, int outer_code, int opno, int *total, bool speed),
1649  hook_bool_rtx_int_int_int_intp_bool_false)
1650
1651 /* Compute the cost of X, used as an address.  Never called with
1652    invalid addresses.  */
1653 DEFHOOK
1654 (address_cost,
1655  "",
1656  int, (rtx address, bool speed),
1657  default_address_cost)
1658
1659 /* Return where to allocate pseudo for a given hard register initial value.  */
1660 DEFHOOK
1661 (allocate_initial_value,
1662  "",
1663  rtx, (rtx hard_reg), NULL)
1664
1665 /* Return nonzero if evaluating UNSPEC[_VOLATILE] X might cause a trap.
1666    FLAGS has the same meaning as in rtlanal.c: may_trap_p_1.  */
1667 DEFHOOK
1668 (unspec_may_trap_p,
1669  "",
1670  int, (const_rtx x, unsigned flags),
1671  default_unspec_may_trap_p)
1672
1673 /* Given a register, this hook should return a parallel of registers
1674    to represent where to find the register pieces.  Define this hook
1675    if the register and its mode are represented in Dwarf in
1676    non-contiguous locations, or if the register should be
1677    represented in more than one register in Dwarf.  Otherwise, this
1678    hook should return NULL_RTX.  */
1679 DEFHOOK
1680 (dwarf_register_span,
1681  "",
1682  rtx, (rtx reg),
1683  hook_rtx_rtx_null)
1684
1685 /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table
1686    entries not corresponding directly to registers below
1687    FIRST_PSEUDO_REGISTER, this hook should generate the necessary
1688    code, given the address of the table.  */
1689 DEFHOOK
1690 (init_dwarf_reg_sizes_extra,
1691  "",
1692  void, (tree address),
1693  hook_void_tree)
1694
1695 /* Fetch the fixed register(s) which hold condition codes, for
1696    targets where it makes sense to look for duplicate assignments to
1697    the condition codes.  This should return true if there is such a
1698    register, false otherwise.  The arguments should be set to the
1699    fixed register numbers.  Up to two condition code registers are
1700    supported.  If there is only one for this target, the int pointed
1701    at by the second argument should be set to -1.  */
1702 DEFHOOK
1703 (fixed_condition_code_regs,
1704  "",
1705  bool, (unsigned int *p1, unsigned int *p2),
1706  hook_bool_uintp_uintp_false)
1707
1708 /* If two condition code modes are compatible, return a condition
1709      code mode which is compatible with both, such that a comparison
1710      done in the returned mode will work for both of the original
1711      modes.  If the condition code modes are not compatible, return
1712      VOIDmode.  */
1713 DEFHOOK
1714 (cc_modes_compatible,
1715  "",
1716  enum machine_mode, (enum machine_mode m1, enum machine_mode m2),
1717  default_cc_modes_compatible)
1718
1719 /* Do machine-dependent code transformations.  Called just before
1720      delayed-branch scheduling.  */
1721 DEFHOOK
1722 (machine_dependent_reorg,
1723  "",
1724  void, (void), NULL)
1725
1726 /* Create the __builtin_va_list type.  */
1727 DEFHOOK
1728 (build_builtin_va_list,
1729  "",
1730  tree, (void),
1731  std_build_builtin_va_list)
1732
1733 /* Enumerate the va list variants.  */
1734 DEFHOOK
1735 (enum_va_list_p,
1736  "",
1737  int, (int idx, const char **pname, tree *ptree),
1738  NULL)
1739
1740 /* Get the cfun/fndecl calling abi __builtin_va_list type.  */
1741 DEFHOOK
1742 (fn_abi_va_list,
1743  "",
1744  tree, (tree fndecl),
1745  std_fn_abi_va_list)
1746
1747 /* Get the __builtin_va_list type dependent on input type.  */
1748 DEFHOOK
1749 (canonical_va_list_type,
1750  "",
1751  tree, (tree type),
1752  std_canonical_va_list_type)
1753
1754 /* ??? Documenting this hook requires a GFDL license grant.  */
1755 DEFHOOK_UNDOC
1756 (expand_builtin_va_start,
1757 "Expand the @code{__builtin_va_start} builtin.",
1758  void, (tree valist, rtx nextarg), NULL)
1759
1760 /* Gimplifies a VA_ARG_EXPR.  */
1761 DEFHOOK
1762 (gimplify_va_arg_expr,
1763  "",
1764  tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
1765  std_gimplify_va_arg_expr)
1766
1767 /* Validity-checking routines for PCH files, target-specific.
1768    get_pch_validity returns a pointer to the data to be stored,
1769    and stores the size in its argument.  pch_valid_p gets the same
1770    information back and returns NULL if the PCH is valid,
1771    or an error message if not.  */
1772 DEFHOOK
1773 (get_pch_validity,
1774  "",
1775  void *, (size_t *sz),
1776  default_get_pch_validity)
1777
1778 DEFHOOK
1779 (pch_valid_p,
1780  "",
1781  const char *, (const void *data, size_t sz),
1782  default_pch_valid_p)
1783
1784 /* If nonnull, this function checks whether a PCH file with the
1785    given set of target flags can be used.  It returns NULL if so,
1786    otherwise it returns an error message.  */
1787 DEFHOOK
1788 (check_pch_target_flags,
1789  "",
1790  const char *, (int pch_flags), NULL)
1791
1792 /* True if the compiler should give an enum type only as many
1793    bytes as it takes to represent the range of possible values of
1794    that type.  */
1795 DEFHOOK
1796 (default_short_enums,
1797  "",
1798  bool, (void),
1799  hook_bool_void_false)
1800
1801 /* This target hook returns an rtx that is used to store the address
1802    of the current frame into the built-in setjmp buffer.  */
1803 DEFHOOK
1804 (builtin_setjmp_frame_value,
1805  "",
1806  rtx, (void),
1807  default_builtin_setjmp_frame_value)
1808
1809 /* This target hook should add STRING_CST trees for any hard regs
1810    the port wishes to automatically clobber for an asm.  */
1811 DEFHOOK
1812 (md_asm_clobbers,
1813  "",
1814  tree, (tree outputs, tree inputs, tree clobbers),
1815  hook_tree_tree_tree_tree_3rd_identity)
1816
1817 /* This target hook allows the backend to specify a calling convention
1818    in the debug information.  This function actually returns an
1819    enum dwarf_calling_convention, but because of forward declarations
1820    and not wanting to include dwarf2.h everywhere target.h is included
1821    the function is being declared as an int.  */
1822 DEFHOOK
1823 (dwarf_calling_convention,
1824  "",
1825  int, (const_tree function),
1826  hook_int_const_tree_0)
1827
1828 /* This target hook allows the backend to emit frame-related insns that
1829    contain UNSPECs or UNSPEC_VOLATILEs.  The call frame debugging info
1830    engine will invoke it on insns of the form
1831      (set (reg) (unspec [...] UNSPEC_INDEX))
1832    and
1833      (set (reg) (unspec_volatile [...] UNSPECV_INDEX))
1834    to let the backend emit the call frame instructions.  */
1835 DEFHOOK
1836 (dwarf_handle_frame_unspec,
1837  "",
1838  void, (const char *label, rtx pattern, int index), NULL)
1839
1840 /* ??? Documenting this hook requires a GFDL license grant.  */
1841 DEFHOOK_UNDOC
1842 (stdarg_optimize_hook,
1843 "Perform architecture specific checking of statements gimplified\
1844  from @code{VA_ARG_EXPR}.  @var{stmt} is the statement.  Returns true if\
1845  the statement doesn't need to be checked for @code{va_list} references.",
1846  bool, (struct stdarg_info *ai, const_gimple stmt), NULL)
1847
1848 /* This target hook allows the operating system to override the DECL
1849    that represents the external variable that contains the stack
1850    protection guard variable.  The type of this DECL is ptr_type_node.  */
1851 DEFHOOK
1852 (stack_protect_guard,
1853  "",
1854  tree, (void),
1855  default_stack_protect_guard)
1856
1857 /* This target hook allows the operating system to override the CALL_EXPR
1858    that is invoked when a check vs the guard variable fails.  */
1859 DEFHOOK
1860 (stack_protect_fail,
1861  "",
1862  tree, (void),
1863  default_external_stack_protect_fail)
1864
1865 /* Returns NULL if target supports the insn within a doloop block,
1866    otherwise it returns an error message.  */
1867 DEFHOOK
1868 (invalid_within_doloop,
1869  "",
1870  const char *, (const_rtx insn),
1871  default_invalid_within_doloop)
1872
1873 DEFHOOK
1874 (valid_dllimport_attribute_p,
1875 "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\
1876  specified.  Use this hook if the target needs to add extra validation\
1877  checks to @code{handle_dll_attribute}.",
1878  bool, (const_tree decl),
1879  hook_bool_const_tree_true)
1880
1881 /* If non-zero, align constant anchors in CSE to a multiple of this
1882    value.  */
1883 DEFHOOKPOD
1884 (const_anchor,
1885  "",
1886  unsigned HOST_WIDE_INT, 0)
1887
1888 /* Functions relating to calls - argument passing, returns, etc.  */
1889 /* Members of struct call have no special macro prefix.  */
1890 HOOK_VECTOR (TARGET_CALLS, calls)
1891
1892 DEFHOOK
1893 (promote_function_mode,
1894  "",
1895  enum machine_mode, (const_tree type, enum machine_mode mode, int *punsignedp,
1896                      const_tree funtype, int for_return),
1897  default_promote_function_mode)
1898
1899 DEFHOOK
1900 (promote_prototypes,
1901  "",
1902  bool, (const_tree fntype),
1903  hook_bool_const_tree_false)
1904
1905 DEFHOOK
1906 (struct_value_rtx,
1907  "",
1908  rtx, (tree fndecl, int incoming),
1909  hook_rtx_tree_int_null)
1910 DEFHOOK
1911 (return_in_memory,
1912  "",
1913  bool, (const_tree type, const_tree fntype),
1914  default_return_in_memory)
1915
1916 DEFHOOK
1917 (return_in_msb,
1918  "",
1919  bool, (const_tree type),
1920  hook_bool_const_tree_false)
1921
1922 /* Return true if a parameter must be passed by reference.  TYPE may
1923    be null if this is a libcall.  CA may be null if this query is
1924    from __builtin_va_arg.  */
1925 DEFHOOK
1926 (pass_by_reference,
1927  "",
1928  bool,
1929  (cumulative_args_t cum, enum machine_mode mode, const_tree type, bool named),
1930  hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
1931
1932 DEFHOOK
1933 (expand_builtin_saveregs,
1934  "",
1935  rtx, (void),
1936  default_expand_builtin_saveregs)
1937
1938 /* Returns pretend_argument_size.  */
1939 DEFHOOK
1940 (setup_incoming_varargs,
1941  "",
1942  void, (cumulative_args_t args_so_far, enum machine_mode mode, tree type,
1943         int *pretend_args_size, int second_time),
1944  default_setup_incoming_varargs)
1945
1946 DEFHOOK
1947 (strict_argument_naming,
1948  "",
1949  bool, (cumulative_args_t ca),
1950  hook_bool_CUMULATIVE_ARGS_false)
1951
1952 /* Returns true if we should use
1953    targetm.calls.setup_incoming_varargs() and/or
1954    targetm.calls.strict_argument_naming().  */
1955 DEFHOOK
1956 (pretend_outgoing_varargs_named,
1957  "",
1958  bool, (cumulative_args_t ca),
1959  default_pretend_outgoing_varargs_named)
1960
1961 /* Given a complex type T, return true if a parameter of type T
1962    should be passed as two scalars.  */
1963 DEFHOOK
1964 (split_complex_arg,
1965  "",
1966  bool, (const_tree type), NULL)
1967
1968 /* Return true if type T, mode MODE, may not be passed in registers,
1969    but must be passed on the stack.  */
1970 /* ??? This predicate should be applied strictly after pass-by-reference.
1971    Need audit to verify that this is the case.  */
1972 DEFHOOK
1973 (must_pass_in_stack,
1974  "",
1975  bool, (enum machine_mode mode, const_tree type),
1976  must_pass_in_stack_var_size_or_pad)
1977
1978 /* Return true if type TYPE, mode MODE, which is passed by reference,
1979    should have the object copy generated by the callee rather than
1980    the caller.  It is never called for TYPE requiring constructors.  */
1981 DEFHOOK
1982 (callee_copies,
1983  "",
1984  bool,
1985  (cumulative_args_t cum, enum machine_mode mode, const_tree type, bool named),
1986  hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
1987
1988 /* Return zero for arguments passed entirely on the stack or entirely
1989    in registers.  If passed in both, return the number of bytes passed
1990    in registers; the balance is therefore passed on the stack.  */
1991 DEFHOOK
1992 (arg_partial_bytes,
1993  "",
1994  int, (cumulative_args_t cum, enum machine_mode mode, tree type, bool named),
1995  hook_int_CUMULATIVE_ARGS_mode_tree_bool_0)
1996
1997 /* Update the state in CA to advance past an argument in the
1998    argument list.  The values MODE, TYPE, and NAMED describe that
1999    argument.  */
2000 DEFHOOK
2001 (function_arg_advance,
2002  "",
2003  void,
2004  (cumulative_args_t ca, enum machine_mode mode, const_tree type, bool named),
2005  default_function_arg_advance)
2006
2007 /* Return zero if the argument described by the state of CA should
2008    be placed on a stack, or a hard register in which to store the
2009    argument.  The values MODE, TYPE, and NAMED describe that
2010    argument.  */
2011 DEFHOOK
2012 (function_arg,
2013  "",
2014  rtx, (cumulative_args_t ca, enum machine_mode mode, const_tree type,
2015        bool named),
2016  default_function_arg)
2017
2018 /* Likewise, but for machines with register windows.  Return the
2019    location where the argument will appear to the callee.  */
2020 DEFHOOK
2021 (function_incoming_arg,
2022  "",
2023  rtx, (cumulative_args_t ca, enum machine_mode mode, const_tree type,
2024        bool named),
2025  default_function_incoming_arg)
2026
2027 DEFHOOK
2028 (function_arg_boundary,
2029  "",
2030  unsigned int, (enum machine_mode mode, const_tree type),
2031  default_function_arg_boundary)
2032
2033 DEFHOOK
2034 (function_arg_round_boundary,
2035  "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
2036 which is the default value for this hook.  You can define this hook to\n\
2037 return a different value if an argument size must be rounded to a larger\n\
2038 value.",
2039  unsigned int, (enum machine_mode mode, const_tree type),
2040  default_function_arg_round_boundary)
2041
2042 /* Return the diagnostic message string if function without a prototype
2043    is not allowed for this 'val' argument; NULL otherwise. */
2044 DEFHOOK
2045 (invalid_arg_for_unprototyped_fn,
2046  "",
2047  const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
2048  hook_invalid_arg_for_unprototyped_fn)
2049
2050 /* Return an rtx for the return value location of the function
2051    specified by FN_DECL_OR_TYPE with a return type of RET_TYPE.  */
2052 DEFHOOK
2053 (function_value,
2054  "",
2055  rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
2056  default_function_value)
2057
2058 /* Return the rtx for the result of a libcall of mode MODE,
2059    calling the function FN_NAME.  */
2060 DEFHOOK
2061 (libcall_value,
2062  "",
2063  rtx, (enum machine_mode mode, const_rtx fun),
2064  default_libcall_value)
2065
2066 /* Return true if REGNO is a possible register number for
2067    a function value as seen by the caller.  */
2068 DEFHOOK
2069 (function_value_regno_p,
2070  "",
2071  bool, (const unsigned int regno),
2072  default_function_value_regno_p)
2073
2074 /* ??? Documenting this hook requires a GFDL license grant.  */
2075 DEFHOOK_UNDOC
2076 (internal_arg_pointer,
2077 "Return an rtx for the argument pointer incoming to the\
2078  current function.",
2079  rtx, (void),
2080  default_internal_arg_pointer)
2081
2082 /* Update the current function stack boundary if needed.  */
2083 DEFHOOK
2084 (update_stack_boundary,
2085  "",
2086  void, (void), NULL)
2087
2088 /* Handle stack alignment and return an rtx for Dynamic Realign
2089    Argument Pointer if necessary.  */
2090 DEFHOOK
2091 (get_drap_rtx,
2092  "",
2093  rtx, (void), NULL)
2094
2095 /* Return true if all function parameters should be spilled to the
2096    stack.  */
2097 DEFHOOK
2098 (allocate_stack_slots_for_args,
2099  "",
2100  bool, (void),
2101  hook_bool_void_true)
2102
2103 /* Return an rtx for the static chain for FNDECL.  If INCOMING_P is true,
2104        then it should be for the callee; otherwise for the caller.  */
2105 DEFHOOK
2106 (static_chain,
2107  "",
2108  rtx, (const_tree fndecl, bool incoming_p),
2109  default_static_chain)
2110
2111 /* Fill in the trampoline at MEM with a call to FNDECL and a
2112    static chain value of CHAIN.  */
2113 DEFHOOK
2114 (trampoline_init,
2115  "",
2116  void, (rtx m_tramp, tree fndecl, rtx static_chain),
2117  default_trampoline_init)
2118
2119 /* Adjust the address of the trampoline in a target-specific way.  */
2120 DEFHOOK
2121 (trampoline_adjust_address,
2122  "",
2123  rtx, (rtx addr), NULL)
2124
2125 /* Return the number of bytes of its own arguments that a function
2126    pops on returning, or 0 if the function pops no arguments and the
2127    caller must therefore pop them all after the function returns.  */
2128 /* ??? tm.texi has no types for the parameters.  */
2129 DEFHOOK
2130 (return_pops_args,
2131  "",
2132  int, (tree fundecl, tree funtype, int size),
2133  default_return_pops_args)
2134
2135 /* Return a mode wide enough to copy any function value that might be
2136    returned.  */
2137 DEFHOOK
2138 (get_raw_result_mode,
2139  "This target hook returns the mode to be used when accessing raw return\
2140  registers in @code{__builtin_return}.  Define this macro if the value\
2141  in @var{reg_raw_mode} is not correct.",
2142  enum machine_mode, (int regno),
2143  default_get_reg_raw_mode)
2144
2145 /* Return a mode wide enough to copy any argument value that might be
2146    passed.  */
2147 DEFHOOK
2148 (get_raw_arg_mode,
2149  "This target hook returns the mode to be used when accessing raw argument\
2150  registers in @code{__builtin_apply_args}.  Define this macro if the value\
2151  in @var{reg_raw_mode} is not correct.",
2152  enum machine_mode, (int regno),
2153  default_get_reg_raw_mode)
2154
2155 HOOK_VECTOR_END (calls)
2156
2157 /* Return the diagnostic message string if conversion from FROMTYPE
2158    to TOTYPE is not allowed, NULL otherwise.  */
2159 DEFHOOK
2160 (invalid_conversion,
2161  "",
2162  const char *, (const_tree fromtype, const_tree totype),
2163  hook_constcharptr_const_tree_const_tree_null)
2164
2165 /* Return the diagnostic message string if the unary operation OP is
2166    not permitted on TYPE, NULL otherwise.  */
2167 DEFHOOK
2168 (invalid_unary_op,
2169  "",
2170  const char *, (int op, const_tree type),
2171  hook_constcharptr_int_const_tree_null)
2172
2173 /* Return the diagnostic message string if the binary operation OP
2174    is not permitted on TYPE1 and TYPE2, NULL otherwise.  */
2175 DEFHOOK
2176 (invalid_binary_op,
2177  "",
2178  const char *, (int op, const_tree type1, const_tree type2),
2179  hook_constcharptr_int_const_tree_const_tree_null)
2180
2181 /* Return the diagnostic message string if TYPE is not valid as a
2182    function parameter type, NULL otherwise.  */
2183 DEFHOOK
2184 (invalid_parameter_type,
2185  "",
2186  const char *, (const_tree type),
2187  hook_constcharptr_const_tree_null)
2188
2189 /* Return the diagnostic message string if TYPE is not valid as a
2190    function return type, NULL otherwise.  */
2191 DEFHOOK
2192 (invalid_return_type,
2193  "",
2194  const char *, (const_tree type),
2195  hook_constcharptr_const_tree_null)
2196
2197 /* If values of TYPE are promoted to some other type when used in
2198    expressions (analogous to the integer promotions), return that type,
2199    or NULL_TREE otherwise.  */
2200 DEFHOOK
2201 (promoted_type,
2202  "",
2203  tree, (const_tree type),
2204  hook_tree_const_tree_null)
2205
2206 /* Convert EXPR to TYPE, if target-specific types with special conversion
2207    rules are involved.  Return the converted expression, or NULL to apply
2208    the standard conversion rules.  */
2209 DEFHOOK
2210 (convert_to_type,
2211  "",
2212  tree, (tree type, tree expr),
2213  hook_tree_tree_tree_null)
2214
2215 /* Return the class for a secondary reload, and fill in extra information.  */
2216 DEFHOOK
2217 (secondary_reload,
2218  "",
2219  reg_class_t,
2220  (bool in_p, rtx x, reg_class_t reload_class, enum machine_mode reload_mode,
2221   secondary_reload_info *sri),
2222  default_secondary_reload)
2223
2224 /* Given an rtx X being reloaded into a reg required to be in class CLASS,
2225    return the class of reg to actually use.  */
2226 DEFHOOK
2227 (preferred_reload_class,
2228  "",
2229  reg_class_t,
2230  (rtx x, reg_class_t rclass),
2231  default_preferred_reload_class)
2232
2233 /* Like TARGET_PREFERRED_RELOAD_CLASS, but for output reloads instead of
2234    input reloads.  */
2235 DEFHOOK
2236 (preferred_output_reload_class,
2237  "",
2238  reg_class_t,
2239  (rtx x, reg_class_t rclass),
2240  default_preferred_output_reload_class)
2241
2242 DEFHOOK
2243 (class_likely_spilled_p,
2244  "",
2245  bool, (reg_class_t rclass),
2246  default_class_likely_spilled_p)
2247
2248 /* Return the maximum number of consecutive registers
2249    needed to represent mode MODE in a register of class RCLASS.  */
2250 DEFHOOK
2251 (class_max_nregs,
2252  "",
2253  unsigned char, (reg_class_t rclass, enum machine_mode mode),
2254  default_class_max_nregs)
2255
2256 DEFHOOK
2257 (preferred_rename_class,
2258  "A target hook that places additional preference on the register\
2259  class to use when it is necessary to rename a register in class\
2260  @var{rclass} to another class, or perhaps @var{NO_REGS}, if no\
2261  preferred register class is found or hook @code{preferred_rename_class}\
2262  is not implemented.\
2263  Sometimes returning a more restrictive class makes better code.  For\
2264  example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\
2265  smaller than instructions using @code{GENERIC_REGS}.  By returning\
2266  @code{LO_REGS} from @code{preferred_rename_class}, code size can\
2267  be reduced.",
2268  reg_class_t, (reg_class_t rclass),
2269  default_preferred_rename_class)
2270
2271 /* This target hook allows the backend to perform additional
2272    processing while initializing for variable expansion.  */
2273 DEFHOOK
2274 (expand_to_rtl_hook,
2275  "",
2276  void, (void),
2277  hook_void_void)
2278
2279 /* This target hook allows the backend to perform additional
2280    instantiations on rtx that are not actually in insns yet,
2281    but will be later.  */
2282 DEFHOOK
2283 (instantiate_decls,
2284  "",
2285  void, (void),
2286  hook_void_void)
2287
2288 /* Return true if is OK to use a hard register REGNO as scratch register
2289    in peephole2.  */
2290 DEFHOOK
2291 (hard_regno_scratch_ok,
2292  "",
2293  bool, (unsigned int regno),
2294  default_hard_regno_scratch_ok)
2295
2296 /* Return the smallest number of different values for which it is best to
2297    use a jump-table instead of a tree of conditional branches.  */
2298 DEFHOOK
2299 (case_values_threshold,
2300  "",
2301  unsigned int, (void),
2302  default_case_values_threshold)
2303
2304 /* Retutn true if a function must have and use a frame pointer.  */
2305 DEFHOOK
2306 (frame_pointer_required,
2307  "",
2308  bool, (void),
2309  hook_bool_void_false)
2310
2311 /* Returns true if the compiler is allowed to try to replace register number
2312    from-reg with register number to-reg.  */
2313 DEFHOOK
2314 (can_eliminate,
2315  "",
2316  bool, (const int from_reg, const int to_reg),
2317  hook_bool_const_int_const_int_true)
2318
2319 /* Modify any or all of fixed_regs, call_used_regs, global_regs,
2320    reg_names, and reg_class_contents to account of the vagaries of the
2321    target.  */
2322 DEFHOOK
2323 (conditional_register_usage,
2324  "",
2325  void, (void),
2326  hook_void_void)
2327
2328 /* Functions specific to the C family of frontends.  */
2329 #undef HOOK_PREFIX
2330 #define HOOK_PREFIX "TARGET_C_"
2331 HOOK_VECTOR (TARGET_C, c)
2332
2333 /* ??? Documenting this hook requires a GFDL license grant.  */
2334 DEFHOOK_UNDOC
2335 (mode_for_suffix,
2336 "Return machine mode for non-standard constant literal suffix @var{c},\
2337  or VOIDmode if non-standard suffixes are unsupported.",
2338  enum machine_mode, (char c),
2339  default_mode_for_suffix)
2340
2341 HOOK_VECTOR_END (c)
2342
2343 /* Functions specific to the C++ frontend.  */
2344 #undef HOOK_PREFIX
2345 #define HOOK_PREFIX "TARGET_CXX_"
2346 HOOK_VECTOR (TARGET_CXX, cxx)
2347
2348 /* Return the integer type used for guard variables.  */
2349 DEFHOOK
2350 (guard_type,
2351  "",
2352  tree, (void),
2353  default_cxx_guard_type)
2354
2355 /* Return true if only the low bit of the guard should be tested.  */
2356 DEFHOOK
2357 (guard_mask_bit,
2358  "",
2359  bool, (void),
2360  hook_bool_void_false)
2361
2362 /* Returns the size of the array cookie for an array of type.  */
2363 DEFHOOK
2364 (get_cookie_size,
2365  "",
2366  tree, (tree type),
2367  default_cxx_get_cookie_size)
2368
2369 /* Returns true if the element size should be stored in the array cookie.  */
2370 DEFHOOK
2371 (cookie_has_size,
2372  "",
2373  bool, (void),
2374  hook_bool_void_false)
2375
2376 /* Allows backends to perform additional processing when
2377    deciding if a class should be exported or imported.  */
2378 DEFHOOK
2379 (import_export_class,
2380  "",
2381  int, (tree type, int import_export), NULL)
2382
2383 /* Returns true if constructors and destructors return "this".  */
2384 DEFHOOK
2385 (cdtor_returns_this,
2386  "",
2387  bool, (void),
2388  hook_bool_void_false)
2389
2390 /* Returns true if the key method for a class can be an inline
2391    function, so long as it is not declared inline in the class
2392    itself.  Returning true is the behavior required by the Itanium C++ ABI.  */
2393 DEFHOOK
2394 (key_method_may_be_inline,
2395  "",
2396  bool, (void),
2397  hook_bool_void_true)
2398
2399 DEFHOOK
2400 (determine_class_data_visibility,
2401 "@var{decl} is a virtual table, virtual table table, typeinfo object,\
2402  or other similar implicit class data object that will be emitted with\
2403  external linkage in this translation unit.  No ELF visibility has been\
2404  explicitly specified.  If the target needs to specify a visibility\
2405  other than that of the containing class, use this hook to set\
2406  @code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
2407  void, (tree decl),
2408  hook_void_tree)
2409
2410 /* Returns true (the default) if virtual tables and other
2411    similar implicit class data objects are always COMDAT if they
2412    have external linkage.  If this hook returns false, then
2413    class data for classes whose virtual table will be emitted in
2414    only one translation unit will not be COMDAT.  */
2415 DEFHOOK
2416 (class_data_always_comdat,
2417  "",
2418  bool, (void),
2419  hook_bool_void_true)
2420
2421 /* Returns true (the default) if the RTTI for the basic types,
2422    which is always defined in the C++ runtime, should be COMDAT;
2423    false if it should not be COMDAT.  */
2424 DEFHOOK
2425 (library_rtti_comdat,
2426  "",
2427  bool, (void),
2428  hook_bool_void_true)
2429
2430 /* Returns true if __aeabi_atexit should be used to register static
2431    destructors.  */
2432 DEFHOOK
2433 (use_aeabi_atexit,
2434  "",
2435  bool, (void),
2436  hook_bool_void_false)
2437
2438 /* Returns true if target may use atexit in the same manner as
2439    __cxa_atexit  to register static destructors.  */
2440 DEFHOOK
2441 (use_atexit_for_cxa_atexit,
2442  "",
2443  bool, (void),
2444  hook_bool_void_false)
2445
2446 DEFHOOK
2447 (adjust_class_at_definition,
2448 "@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\
2449  been defined.  Use this hook to make adjustments to the class (eg, tweak\
2450  visibility or perform any other required target modifications).",
2451  void, (tree type),
2452  hook_void_tree)
2453
2454 DEFHOOK
2455 (decl_mangling_context,
2456  "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
2457  tree, (const_tree decl),
2458  hook_tree_const_tree_null)
2459
2460 HOOK_VECTOR_END (cxx)
2461
2462 /* Functions and data for emulated TLS support.  */
2463 #undef HOOK_PREFIX
2464 #define HOOK_PREFIX "TARGET_EMUTLS_"
2465 HOOK_VECTOR (TARGET_EMUTLS, emutls)
2466
2467 /* Name of the address and common functions.  */
2468 DEFHOOKPOD
2469 (get_address,
2470  "",
2471  const char *, "__builtin___emutls_get_address")
2472
2473 DEFHOOKPOD
2474 (register_common,
2475  "",
2476  const char *, "__builtin___emutls_register_common")
2477
2478 /* Prefixes for proxy variable and template.  */
2479 DEFHOOKPOD
2480 (var_section,
2481  "",
2482  const char *, NULL)
2483
2484 DEFHOOKPOD
2485 (tmpl_section,
2486  "",
2487  const char *, NULL)
2488
2489 /* Prefixes for proxy variable and template.  */
2490 DEFHOOKPOD
2491 (var_prefix,
2492  "",
2493  const char *, NULL)
2494
2495 DEFHOOKPOD
2496 (tmpl_prefix,
2497  "",
2498  const char *, NULL)
2499
2500 /* Function to generate field definitions of the proxy variable.  */
2501 DEFHOOK
2502 (var_fields,
2503  "",
2504  tree, (tree type, tree *name),
2505  default_emutls_var_fields)
2506
2507 /* Function to initialize a proxy variable.  */
2508 DEFHOOK
2509 (var_init,
2510  "",
2511  tree, (tree var, tree decl, tree tmpl_addr),
2512  default_emutls_var_init)
2513
2514 /* Whether we are allowed to alter the usual alignment of the
2515    proxy variable.  */
2516 DEFHOOKPOD
2517 (var_align_fixed,
2518  "",
2519  bool, false)
2520
2521 /* Whether we can emit debug information for TLS vars.  */
2522 DEFHOOKPOD
2523 (debug_form_tls_address,
2524  "",
2525  bool, false)
2526
2527 HOOK_VECTOR_END (emutls)
2528
2529 #undef HOOK_PREFIX
2530 #define HOOK_PREFIX "TARGET_OPTION_"
2531 HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
2532
2533 /* Function to validate the attribute((option(...))) strings or NULL.  If
2534    the option is validated, it is assumed that DECL_FUNCTION_SPECIFIC will
2535    be filled in in the function decl node.  */
2536 DEFHOOK
2537 (valid_attribute_p,
2538  "",
2539  bool, (tree fndecl, tree name, tree args, int flags),
2540  default_target_option_valid_attribute_p)
2541
2542 /* Function to save any extra target state in the target options structure.  */
2543 DEFHOOK
2544 (save,
2545  "",
2546  void, (struct cl_target_option *ptr), NULL)
2547
2548 /* Function to restore any extra target state from the target options
2549    structure.  */
2550 DEFHOOK
2551 (restore,
2552  "",
2553  void, (struct cl_target_option *ptr), NULL)
2554
2555 /* Function to print any extra target state from the target options
2556    structure.  */
2557 DEFHOOK
2558 (print,
2559  "",
2560  void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
2561
2562 /* Function to parse arguments to be validated for #pragma option, and to
2563    change the state if the options are valid.  If the first argument is
2564    NULL, the second argument specifies the default options to use.  Return
2565    true if the options are valid, and set the current state.  */
2566 /* ??? The documentation in tm.texi is incomplete.  */
2567 DEFHOOK
2568 (pragma_parse,
2569  "",
2570  bool, (tree args, tree pop_target),
2571  default_target_option_pragma_parse)
2572
2573 /* Do option overrides for the target.  */
2574 DEFHOOK
2575 (override,
2576  "",
2577  void, (void),
2578  hook_void_void)
2579
2580 /* Function to determine if one function can inline another function.  */
2581 #undef HOOK_PREFIX
2582 #define HOOK_PREFIX "TARGET_"
2583 DEFHOOK
2584 (can_inline_p,
2585  "",
2586  bool, (tree caller, tree callee),
2587  default_target_can_inline_p)
2588
2589 HOOK_VECTOR_END (target_option)
2590
2591 /* For targets that need to mark extra registers as live on entry to
2592    the function, they should define this target hook and set their
2593    bits in the bitmap passed in. */
2594 DEFHOOK
2595 (extra_live_on_entry,
2596  "",
2597  void, (bitmap regs),
2598  hook_void_bitmap)
2599
2600 /* Determine the type of unwind info to emit for debugging.  */
2601 DEFHOOK
2602 (debug_unwind_info,
2603  "",
2604  enum unwind_info_type, (void),
2605  default_debug_unwind_info)
2606
2607 /* Leave the boolean fields at the end.  */
2608
2609 /* True if we can create zeroed data by switching to a BSS section
2610    and then using ASM_OUTPUT_SKIP to allocate the space.  */
2611 DEFHOOKPOD
2612 (have_switchable_bss_sections,
2613  "",
2614  bool, false)
2615
2616 /* True if "native" constructors and destructors are supported,
2617    false if we're using collect2 for the job.  */
2618 DEFHOOKPOD
2619 (have_ctors_dtors,
2620  "",
2621  bool, false)
2622
2623 /* True if thread-local storage is supported.  */
2624 DEFHOOKPOD
2625 (have_tls,
2626  "",
2627  bool, false)
2628
2629 /* True if a small readonly data section is supported.  */
2630 DEFHOOKPOD
2631 (have_srodata_section,
2632  "",
2633  bool, false)
2634
2635 /* True if EH frame info sections should be zero-terminated.  */
2636 DEFHOOKPOD
2637 (terminate_dw2_eh_frame_info,
2638  "",
2639  bool, true)
2640
2641 /* True if #NO_APP should be emitted at the beginning of assembly output.  */
2642 DEFHOOKPOD
2643 (asm_file_start_app_off,
2644  "",
2645  bool, false)
2646
2647 /* True if output_file_directive should be called for main_input_filename
2648    at the beginning of assembly output.  */
2649 DEFHOOKPOD
2650 (asm_file_start_file_directive,
2651  "",
2652  bool, false)
2653
2654 DEFHOOKPOD
2655 (handle_pragma_extern_prefix,
2656 "True if @code{#pragma extern_prefix} is to be supported.",
2657  bool, 0)
2658
2659 /* True if the target is allowed to reorder memory accesses unless
2660    synchronization is explicitly requested.  */
2661 DEFHOOKPOD
2662 (relaxed_ordering,
2663  "",
2664  bool, false)
2665
2666 /* Returns true if we should generate exception tables for use with the
2667    ARM EABI.  The effects the encoding of function exception specifications.  */
2668 DEFHOOKPOD
2669 (arm_eabi_unwinder,
2670  "",
2671  bool, false)
2672
2673 DEFHOOKPOD
2674 (want_debug_pub_sections,
2675  "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\
2676  should be emitted.  These sections are not used on most platforms, and\
2677  in particular GDB does not use them.",
2678  bool, false)
2679
2680 DEFHOOKPOD
2681 (delay_sched2, "True if sched2 is not to be run at its normal place.  \
2682 This usually means it will be run as part of machine-specific reorg.",
2683 bool, false)
2684
2685 DEFHOOKPOD
2686 (delay_vartrack, "True if vartrack is not to be run at its normal place.  \
2687 This usually means it will be run as part of machine-specific reorg.",
2688 bool, false)
2689
2690 /* Leave the boolean fields at the end.  */
2691
2692 /* Close the 'struct gcc_target' definition.  */
2693 HOOK_VECTOR_END (C90_EMPTY_HACK)