Merge from trunk: 215733-215743
[official-gcc.git] / gcc-4_7 / gcc / target.def
blob5fc30795552ee8a37401c5821704e813e3d1f281
1 /* Target hook definitions.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
3 2011, 2012
4 Free Software Foundation, Inc.
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.
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.
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/>.
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! */
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"
28 #undef HOOK_TYPE
29 #define HOOK_TYPE "Target Hook"
31 HOOK_VECTOR (TARGET_INITIALIZER, gcc_target)
33 /* Functions that output assembler for the target. */
34 #define HOOK_PREFIX "TARGET_ASM_"
35 HOOK_VECTOR (TARGET_ASM_OUT, asm_out)
37 /* Opening and closing parentheses for asm expression grouping. */
38 DEFHOOKPOD
39 (open_paren,
40 "",
41 const char *, "(")
42 DEFHOOKPODX (close_paren, const char *, ")")
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)
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)
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)
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)
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)
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)
97 /* Output code that will globalize a label. */
98 DEFHOOK
99 (globalize_label,
101 void, (FILE *stream, const char *name),
102 default_globalize_label)
104 /* Output code that will globalize a declaration. */
105 DEFHOOK
106 (globalize_decl_name,
108 void, (FILE *stream, tree decl), default_globalize_decl_name)
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,
118 void, (FILE *stream, tree decl, int for_eh, int empty),
119 default_emit_unwind_label)
121 /* Output code that will emit a label to divide up the exception table. */
122 DEFHOOK
123 (emit_except_table_label,
125 void, (FILE *stream),
126 default_emit_except_table_label)
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)
137 /* Emit any directives required to unwind this instruction. */
138 DEFHOOK
139 (unwind_emit,
141 void, (FILE *stream, rtx insn),
142 NULL)
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)
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,
156 void, (char *buf, const char *prefix, unsigned long labelno),
157 default_generate_internal_label)
159 /* Output an internal label. */
160 DEFHOOK
161 (internal_label,
163 void, (FILE *stream, const char *prefix, unsigned long labelno),
164 default_internal_label)
166 /* Output label for the constant. */
167 DEFHOOK
168 (declare_constant_name,
170 void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
171 default_asm_declare_constant_name)
173 /* Emit a ttype table reference to a typeinfo object. */
174 DEFHOOK
175 (ttype,
177 bool, (rtx sym),
178 hook_bool_rtx_false)
180 /* Emit an assembler directive to set visibility for the symbol
181 associated with the tree decl. */
182 DEFHOOK
183 (assemble_visibility,
185 void, (tree decl, int visibility),
186 default_assemble_visibility)
188 /* Output the assembler code for entry to a function. */
189 DEFHOOK
190 (function_prologue,
192 void, (FILE *file, HOST_WIDE_INT size),
193 default_function_pro_epilogue)
195 /* Output the assembler code for end of prologue. */
196 DEFHOOK
197 (function_end_prologue,
199 void, (FILE *file),
200 no_asm_to_stream)
202 /* Output the assembler code for start of epilogue. */
203 DEFHOOK
204 (function_begin_epilogue,
206 void, (FILE *file),
207 no_asm_to_stream)
209 /* Output the assembler code for function exit. */
210 DEFHOOK
211 (function_epilogue,
213 void, (FILE *file, HOST_WIDE_INT size),
214 default_function_pro_epilogue)
216 /* Initialize target-specific sections. */
217 DEFHOOK
218 (init_sections,
220 void, (void),
221 hook_void_void)
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,
229 void, (const char *name, unsigned int flags, tree decl),
230 default_no_named_section)
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,
242 section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
243 default_function_section)
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)
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,
263 int, (void),
264 default_reloc_rw_mask)
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,
273 section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
274 default_select_section)
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,
281 section *, (enum machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
282 default_select_rtx_section)
284 /* Select a unique section name for DECL. RELOC is the same as
285 for SELECT_SECTION. */
286 DEFHOOK
287 (unique_section,
289 void, (tree decl, int reloc),
290 default_unique_section)
292 /* Return the readonly data section associated with function DECL. */
293 DEFHOOK
294 (function_rodata_section,
296 section *, (tree decl),
297 default_function_rodata_section)
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")
308 /* Return the section to be used for transactional memory clone tables. */
309 DEFHOOK
310 (tm_clone_table_section,
311 "Return the section that should be used for transactional memory clone\
312 tables.",
313 section *, (void), default_clone_table_section)
315 /* Output a constructor for a symbol with a given priority. */
316 DEFHOOK
317 (constructor,
319 void, (rtx symbol, int priority), NULL)
321 /* Output a destructor for a symbol with a given priority. */
322 DEFHOOK
323 (destructor,
325 void, (rtx symbol, int priority), NULL)
327 /* Output the assembler code for a thunk function. THUNK_DECL is the
328 declaration for the thunk function itself, FUNCTION is the decl for
329 the target function. DELTA is an immediate constant offset to be
330 added to THIS. If VCALL_OFFSET is nonzero, the word at
331 *(*this + vcall_offset) should be added to THIS. */
332 DEFHOOK
333 (output_mi_thunk,
335 void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
336 HOST_WIDE_INT vcall_offset, tree function),
337 NULL)
339 /* Determine whether output_mi_thunk would succeed. */
340 /* ??? Ideally, this hook would not exist, and success or failure
341 would be returned from output_mi_thunk directly. But there's
342 too much undo-able setup involved in invoking output_mi_thunk.
343 Could be fixed by making output_mi_thunk emit rtl instead of
344 text to the output file. */
345 DEFHOOK
346 (can_output_mi_thunk,
348 bool, (const_tree thunk_fndecl, HOST_WIDE_INT delta,
349 HOST_WIDE_INT vcall_offset, const_tree function),
350 hook_bool_const_tree_hwi_hwi_const_tree_false)
352 /* Output any boilerplate text needed at the beginning of a
353 translation unit. */
354 DEFHOOK
355 (file_start,
357 void, (void),
358 default_file_start)
360 /* Output any boilerplate text needed at the end of a translation unit. */
361 DEFHOOK
362 (file_end,
364 void, (void),
365 hook_void_void)
367 /* Output any boilerplate text needed at the beginning of an
368 LTO output stream. */
369 DEFHOOK
370 (lto_start,
372 void, (void),
373 hook_void_void)
375 /* Output any boilerplate text needed at the end of an
376 LTO output stream. */
377 DEFHOOK
378 (lto_end,
380 void, (void),
381 hook_void_void)
383 /* Output any boilerplace text needed at the end of a
384 translation unit before debug and unwind info is emitted. */
385 DEFHOOK
386 (code_end,
388 void, (void),
389 hook_void_void)
391 /* Output an assembler pseudo-op to declare a library function name
392 external. */
393 DEFHOOK
394 (external_libcall,
396 void, (rtx symref),
397 default_external_libcall)
399 /* Output an assembler directive to mark decl live. This instructs
400 linker to not dead code strip this symbol. */
401 DEFHOOK
402 (mark_decl_preserved,
404 void, (const char *symbol),
405 hook_void_constcharptr)
407 /* Output a record of the command line switches that have been passed. */
408 DEFHOOK
409 (record_gcc_switches,
411 int, (print_switch_type type, const char *text),
412 NULL)
414 /* The name of the section that the example ELF implementation of
415 record_gcc_switches will use to store the information. Target
416 specific versions of record_gcc_switches may or may not use
417 this information. */
418 DEFHOOKPOD
419 (record_gcc_switches_section,
421 const char *, ".GCC.command.line")
423 /* Output the definition of a section anchor. */
424 DEFHOOK
425 (output_anchor,
427 void, (rtx x),
428 default_asm_output_anchor)
430 /* Output a DTP-relative reference to a TLS symbol. */
431 DEFHOOK
432 (output_dwarf_dtprel,
434 void, (FILE *file, int size, rtx x),
435 NULL)
437 /* Some target machines need to postscan each insn after it is output. */
438 DEFHOOK
439 (final_postscan_insn,
441 void, (FILE *file, rtx insn, rtx *opvec, int noperands),
442 NULL)
444 /* Emit the trampoline template. This hook may be NULL. */
445 DEFHOOK
446 (trampoline_template,
448 void, (FILE *f),
449 NULL)
451 DEFHOOK
452 (output_source_filename,
453 "Output COFF information or DWARF debugging information which indicates\
454 that filename @var{name} is the current source file to the stdio\
455 stream @var{file}.\n\
457 This target hook need not be defined if the standard form of output\
458 for the file format in use is appropriate.",
459 void ,(FILE *file, const char *name),
460 default_asm_output_source_filename)
462 DEFHOOK
463 (output_addr_const_extra,
465 bool, (FILE *file, rtx x),
466 hook_bool_FILEptr_rtx_false)
468 /* ??? The TARGET_PRINT_OPERAND* hooks are part of the asm_out struct,
469 even though that is not reflected in the macro name to override their
470 initializers. */
471 #undef HOOK_PREFIX
472 #define HOOK_PREFIX "TARGET_"
474 /* Emit a machine-specific insn operand. */
475 /* ??? tm.texi only documents the old macro PRINT_OPERAND,
476 not this hook, and uses a different name for the argument FILE. */
477 DEFHOOK_UNDOC
478 (print_operand,
480 void, (FILE *file, rtx x, int code),
481 default_print_operand)
483 /* Emit a machine-specific memory address. */
484 /* ??? tm.texi only documents the old macro PRINT_OPERAND_ADDRESS,
485 not this hook, and uses different argument names. */
486 DEFHOOK_UNDOC
487 (print_operand_address,
489 void, (FILE *file, rtx addr),
490 default_print_operand_address)
492 /* Determine whether CODE is a valid punctuation character for the
493 `print_operand' hook. */
494 /* ??? tm.texi only documents the old macro PRINT_OPERAND_PUNCT_VALID_P,
495 not this hook. */
496 DEFHOOK_UNDOC
497 (print_operand_punct_valid_p,
499 bool ,(unsigned char code),
500 default_print_operand_punct_valid_p)
502 /* Given a symbol name, perform same mangling as assemble_name and
503 ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
504 DEFHOOK
505 (mangle_assembler_name,
506 "Given a symbol @var{name}, perform same mangling as @code{varasm.c}'s\
507 @code{assemble_name}, but in memory rather than to a file stream, returning\
508 result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\
509 default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\
510 then prepends the @code{USER_LABEL_PREFIX}, if any.",
511 tree, (const char *name),
512 default_mangle_assembler_name)
514 HOOK_VECTOR_END (asm_out)
516 /* Functions relating to instruction scheduling. All of these
517 default to null pointers, which haifa-sched.c looks for and handles. */
518 #undef HOOK_PREFIX
519 #define HOOK_PREFIX "TARGET_SCHED_"
520 HOOK_VECTOR (TARGET_SCHED, sched)
522 /* Given the current cost, COST, of an insn, INSN, calculate and
523 return a new cost based on its relationship to DEP_INSN through
524 the dependence LINK. The default is to make no adjustment. */
525 DEFHOOK
526 (adjust_cost,
528 int, (rtx insn, rtx link, rtx dep_insn, int cost), NULL)
530 /* Adjust the priority of an insn as you see fit. Returns the new priority. */
531 DEFHOOK
532 (adjust_priority,
534 int, (rtx insn, int priority), NULL)
536 /* Function which returns the maximum number of insns that can be
537 scheduled in the same machine cycle. This must be constant
538 over an entire compilation. The default is 1. */
539 DEFHOOK
540 (issue_rate,
542 int, (void), NULL)
544 /* Calculate how much this insn affects how many more insns we
545 can emit this cycle. Default is they all cost the same. */
546 DEFHOOK
547 (variable_issue,
549 int, (FILE *file, int verbose, rtx insn, int more), NULL)
551 /* Initialize machine-dependent scheduling code. */
552 DEFHOOK
553 (init,
555 void, (FILE *file, int verbose, int max_ready), NULL)
557 /* Finalize machine-dependent scheduling code. */
558 DEFHOOK
559 (finish,
561 void, (FILE *file, int verbose), NULL)
563 /* Initialize machine-dependent function wide scheduling code. */
564 DEFHOOK
565 (init_global,
567 void, (FILE *file, int verbose, int old_max_uid), NULL)
569 /* Finalize machine-dependent function wide scheduling code. */
570 DEFHOOK
571 (finish_global,
573 void, (FILE *file, int verbose), NULL)
575 /* Reorder insns in a machine-dependent fashion, in two different
576 places. Default does nothing. */
577 DEFHOOK
578 (reorder,
580 int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL)
582 DEFHOOK
583 (reorder2,
585 int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL)
587 /* The following member value is a pointer to a function called
588 after evaluation forward dependencies of insns in chain given
589 by two parameter values (head and tail correspondingly). */
590 DEFHOOK
591 (dependencies_evaluation_hook,
593 void, (rtx head, rtx tail), NULL)
595 /* The values of the following four members are pointers to functions
596 used to simplify the automaton descriptions. dfa_pre_cycle_insn and
597 dfa_post_cycle_insn give functions returning insns which are used to
598 change the pipeline hazard recognizer state when the new simulated
599 processor cycle correspondingly starts and finishes. The function
600 defined by init_dfa_pre_cycle_insn and init_dfa_post_cycle_insn are
601 used to initialize the corresponding insns. The default values of
602 the members result in not changing the automaton state when the
603 new simulated processor cycle correspondingly starts and finishes. */
605 DEFHOOK
606 (init_dfa_pre_cycle_insn,
608 void, (void), NULL)
610 DEFHOOK
611 (dfa_pre_cycle_insn,
613 rtx, (void), NULL)
615 DEFHOOK
616 (init_dfa_post_cycle_insn,
618 void, (void), NULL)
620 DEFHOOK
621 (dfa_post_cycle_insn,
623 rtx, (void), NULL)
625 /* The values of the following two members are pointers to
626 functions used to simplify the automaton descriptions.
627 dfa_pre_advance_cycle and dfa_post_advance_cycle are getting called
628 immediately before and after cycle is advanced. */
630 DEFHOOK
631 (dfa_pre_advance_cycle,
633 void, (void), NULL)
635 DEFHOOK
636 (dfa_post_advance_cycle,
638 void, (void), NULL)
640 /* The following member value is a pointer to a function returning value
641 which defines how many insns in queue `ready' will we try for
642 multi-pass scheduling. If the member value is nonzero and the
643 function returns positive value, the DFA based scheduler will make
644 multi-pass scheduling for the first cycle. In other words, we will
645 try to choose ready insn which permits to start maximum number of
646 insns on the same cycle. */
647 DEFHOOK
648 (first_cycle_multipass_dfa_lookahead,
650 int, (void), NULL)
652 /* The following member value is pointer to a function controlling
653 what insns from the ready insn queue will be considered for the
654 multipass insn scheduling. If the hook returns zero for insn
655 passed as the parameter, the insn will be not chosen to be issued. */
656 DEFHOOK
657 (first_cycle_multipass_dfa_lookahead_guard,
659 int, (rtx insn), NULL)
661 /* This hook prepares the target for a new round of multipass
662 scheduling.
663 DATA is a pointer to target-specific data used for multipass scheduling.
664 READY_TRY and N_READY represent the current state of search in the
665 optimization space. The target can filter out instructions that
666 should not be tried during current round by setting corresponding
667 elements in READY_TRY to non-zero.
668 FIRST_CYCLE_INSN_P is true if this is the first round of multipass
669 scheduling on current cycle. */
670 DEFHOOK
671 (first_cycle_multipass_begin,
673 void, (void *data, char *ready_try, int n_ready, bool first_cycle_insn_p),
674 NULL)
676 /* This hook is called when multipass scheduling evaluates instruction INSN.
677 DATA is a pointer to target-specific data that can be used to record effects
678 of INSN on CPU that are not described in DFA.
679 READY_TRY and N_READY represent the current state of search in the
680 optimization space. The target can filter out instructions that
681 should not be tried after issueing INSN by setting corresponding
682 elements in READY_TRY to non-zero.
683 INSN is the instruction being evaluated.
684 PREV_DATA is a pointer to target-specific data corresponding
685 to a state before issueing INSN. */
686 DEFHOOK
687 (first_cycle_multipass_issue,
689 void, (void *data, char *ready_try, int n_ready, rtx insn,
690 const void *prev_data), NULL)
692 /* This hook is called when multipass scheduling backtracks from evaluation of
693 instruction corresponding to DATA.
694 DATA is a pointer to target-specific data that stores the effects
695 of instruction from which the algorithm backtracks on CPU that are not
696 described in DFA.
697 READY_TRY and N_READY represent the current state of search in the
698 optimization space. The target can filter out instructions that
699 should not be tried after issueing INSN by setting corresponding
700 elements in READY_TRY to non-zero. */
701 DEFHOOK
702 (first_cycle_multipass_backtrack,
704 void, (const void *data, char *ready_try, int n_ready), NULL)
706 /* This hook notifies the target about the result of the concluded current
707 round of multipass scheduling.
708 DATA is a pointer.
709 If DATA is non-NULL it points to target-specific data used for multipass
710 scheduling which corresponds to instruction at the start of the chain of
711 the winning solution. DATA is NULL when multipass scheduling cannot find
712 a good enough solution on current cycle and decides to retry later,
713 usually after advancing the cycle count. */
714 DEFHOOK
715 (first_cycle_multipass_end,
717 void, (const void *data), NULL)
719 /* This hook is called to initialize target-specific data for multipass
720 scheduling after it has been allocated.
721 DATA is a pointer to target-specific data that stores the effects
722 of instruction from which the algorithm backtracks on CPU that are not
723 described in DFA. */
724 DEFHOOK
725 (first_cycle_multipass_init,
727 void, (void *data), NULL)
729 /* This hook is called to finalize target-specific data for multipass
730 scheduling before it is deallocated.
731 DATA is a pointer to target-specific data that stores the effects
732 of instruction from which the algorithm backtracks on CPU that are not
733 described in DFA. */
734 DEFHOOK
735 (first_cycle_multipass_fini,
737 void, (void *data), NULL)
739 /* The following member value is pointer to a function called by
740 the insn scheduler before issuing insn passed as the third
741 parameter on given cycle. If the hook returns nonzero, the
742 insn is not issued on given processors cycle. Instead of that,
743 the processor cycle is advanced. If the value passed through
744 the last parameter is zero, the insn ready queue is not sorted
745 on the new cycle start as usually. The first parameter passes
746 file for debugging output. The second one passes the scheduler
747 verbose level of the debugging output. The forth and the fifth
748 parameter values are correspondingly processor cycle on which
749 the previous insn has been issued and the current processor cycle. */
750 DEFHOOK
751 (dfa_new_cycle,
753 int, (FILE *dump, int verbose, rtx insn, int last_clock,
754 int clock, int *sort_p),
755 NULL)
757 /* The following member value is a pointer to a function called by the
758 insn scheduler. It should return true if there exists a dependence
759 which is considered costly by the target, between the insn
760 DEP_PRO (&_DEP), and the insn DEP_CON (&_DEP). The first parameter is
761 the dep that represents the dependence between the two insns. The
762 second argument is the cost of the dependence as estimated by
763 the scheduler. The last argument is the distance in cycles
764 between the already scheduled insn (first parameter) and the
765 second insn (second parameter). */
766 DEFHOOK
767 (is_costly_dependence,
769 bool, (struct _dep *_dep, int cost, int distance), NULL)
771 DEFHOOK_UNDOC
772 (adjust_cost_2,
773 "Given the current cost, @var{cost}, of an insn, @var{insn}, calculate and\
774 return a new cost based on its relationship to @var{dep_insn} through the\
775 dependence of weakness @var{dw}. The default is to make no adjustment.",
776 int, (rtx insn, int dep_type1, rtx dep_insn, int cost, int dw), NULL)
778 /* The following member value is a pointer to a function called
779 by the insn scheduler. This hook is called to notify the backend
780 that new instructions were emitted. */
781 DEFHOOK
782 (h_i_d_extended,
784 void, (void), NULL)
786 /* Next 5 functions are for multi-point scheduling. */
788 /* Allocate memory for scheduler context. */
789 DEFHOOK
790 (alloc_sched_context,
792 void *, (void), NULL)
794 /* Fills the context from the local machine scheduler context. */
795 DEFHOOK
796 (init_sched_context,
798 void, (void *tc, bool clean_p), NULL)
800 /* Sets local machine scheduler context to a saved value. */
801 DEFHOOK
802 (set_sched_context,
804 void, (void *tc), NULL)
806 /* Clears a scheduler context so it becomes like after init. */
807 DEFHOOK
808 (clear_sched_context,
810 void, (void *tc), NULL)
812 /* Frees the scheduler context. */
813 DEFHOOK
814 (free_sched_context,
816 void, (void *tc), NULL)
818 /* The following member value is a pointer to a function called
819 by the insn scheduler.
820 The first parameter is an instruction, the second parameter is the type
821 of the requested speculation, and the third parameter is a pointer to the
822 speculative pattern of the corresponding type (set if return value == 1).
823 It should return
824 -1, if there is no pattern, that will satisfy the requested speculation type,
825 0, if current pattern satisfies the requested speculation type,
826 1, if pattern of the instruction should be changed to the newly
827 generated one. */
828 DEFHOOK
829 (speculate_insn,
831 int, (rtx insn, int request, rtx *new_pat), NULL)
833 /* The following member value is a pointer to a function called
834 by the insn scheduler. It should return true if the check instruction
835 passed as the parameter needs a recovery block. */
836 DEFHOOK
837 (needs_block_p,
839 bool, (int dep_status), NULL)
841 /* The following member value is a pointer to a function called
842 by the insn scheduler. It should return a pattern for the check
843 instruction.
844 The first parameter is a speculative instruction, the second parameter
845 is the label of the corresponding recovery block (or null, if it is a
846 simple check). If the mutation of the check is requested (e.g. from
847 ld.c to chk.a), the third parameter is true - in this case the first
848 parameter is the previous check. */
849 DEFHOOK
850 (gen_spec_check,
852 rtx, (rtx insn, rtx label, int mutate_p), NULL)
854 /* The following member value is a pointer to a function controlling
855 what insns from the ready insn queue will be considered for the
856 multipass insn scheduling. If the hook returns zero for the insn
857 passed as the parameter, the insn will not be chosen to be
858 issued. This hook is used to discard speculative instructions,
859 that stand at the first position of the ready list. */
860 DEFHOOK
861 (first_cycle_multipass_dfa_lookahead_guard_spec,
863 bool, (const_rtx insn), NULL)
865 /* The following member value is a pointer to a function that provides
866 information about the speculation capabilities of the target.
867 The parameter is a pointer to spec_info variable. */
868 DEFHOOK
869 (set_sched_flags,
871 void, (struct spec_info_def *spec_info), NULL)
873 DEFHOOK_UNDOC
874 (get_insn_spec_ds,
875 "Return speculation types of instruction @var{insn}.",
876 int, (rtx insn), NULL)
878 DEFHOOK_UNDOC
879 (get_insn_checked_ds,
880 "Return speculation types that are checked for instruction @var{insn}",
881 int, (rtx insn), NULL)
883 DEFHOOK_UNDOC
884 (skip_rtx_p,
885 "Return bool if rtx scanning should just skip current layer and\
886 advance to the inner rtxes.",
887 bool, (const_rtx x), NULL)
889 /* The following member value is a pointer to a function that provides
890 information about the target resource-based lower bound which is
891 used by the swing modulo scheduler. The parameter is a pointer
892 to ddg variable. */
893 DEFHOOK
894 (sms_res_mii,
896 int, (struct ddg *g), NULL)
898 /* The following member value is a function that initializes dispatch
899 schedling and adds instructions to dispatch window according to its
900 parameters. */
901 DEFHOOK
902 (dispatch_do,
904 void, (rtx insn, int x),
905 hook_void_rtx_int)
907 /* The following member value is a a function that returns true is
908 dispatch schedling is supported in hardware and condition passed
909 as the second parameter is true. */
910 DEFHOOK
911 (dispatch,
913 bool, (rtx insn, int x),
914 hook_bool_rtx_int_false)
916 DEFHOOKPOD
917 (exposed_pipeline,
918 "True if the processor has an exposed pipeline, which means that not just\n\
919 the order of instructions is important for correctness when scheduling, but\n\
920 also the latencies of operations.",
921 bool, false)
923 /* The following member value is a function that returns number
924 of operations reassociator should try to put in parallel for
925 statements of the given type. By default 1 is used. */
926 DEFHOOK
927 (reassociation_width,
928 "This hook is called by tree reassociator to determine a level of\n\
929 parallelism required in output calculations chain.",
930 int, (unsigned int opc, enum machine_mode mode),
931 hook_int_uint_mode_1)
933 HOOK_VECTOR_END (sched)
935 /* Functions relating to vectorization. */
936 #undef HOOK_PREFIX
937 #define HOOK_PREFIX "TARGET_VECTORIZE_"
938 HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
940 /* The following member value is a pointer to a function called
941 by the vectorizer, and return the decl of the target builtin
942 function. */
943 DEFHOOK
944 (builtin_mask_for_load,
946 tree, (void), NULL)
948 /* Returns a code for builtin that realizes vectorized version of
949 function, or NULL_TREE if not available. */
950 DEFHOOK
951 (builtin_vectorized_function,
953 tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
954 default_builtin_vectorized_function)
956 /* Returns a function declaration for a builtin that realizes the
957 vector conversion, or NULL_TREE if not available. */
958 DEFHOOK
959 (builtin_conversion,
961 tree, (unsigned code, tree dest_type, tree src_type),
962 default_builtin_vectorized_conversion)
964 /* Target builtin that implements vector widening multiplication.
965 builtin_mul_widen_eve computes the element-by-element products
966 for the even elements, and builtin_mul_widen_odd computes the
967 element-by-element products for the odd elements. */
968 DEFHOOK
969 (builtin_mul_widen_even,
971 tree, (tree x), NULL)
973 DEFHOOK
974 (builtin_mul_widen_odd,
976 tree, (tree x), NULL)
978 /* Cost of different vector/scalar statements in vectorization cost
979 model. In case of misaligned vector loads and stores the cost depends
980 on the data type and misalignment value. */
981 DEFHOOK
982 (builtin_vectorization_cost,
984 int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
985 default_builtin_vectorization_cost)
987 /* Return true if vector alignment is reachable (by peeling N
988 iterations) for the given type. */
989 DEFHOOK
990 (vector_alignment_reachable,
992 bool, (const_tree type, bool is_packed),
993 default_builtin_vector_alignment_reachable)
995 /* Return true if a vector created for vec_perm_const is valid.
996 A NULL indicates that all constants are valid permutations. */
997 DEFHOOK
998 (vec_perm_const_ok,
1000 bool, (enum machine_mode, const unsigned char *sel),
1001 NULL)
1003 /* Return true if the target supports misaligned store/load of a
1004 specific factor denoted in the third parameter. The last parameter
1005 is true if the access is defined in a packed struct. */
1006 DEFHOOK
1007 (support_vector_misalignment,
1009 bool,
1010 (enum machine_mode mode, const_tree type, int misalignment, bool is_packed),
1011 default_builtin_support_vector_misalignment)
1013 /* Return the builtin decl needed to load a vector of TYPE. */
1014 DEFHOOK
1015 (builtin_tm_load,
1016 "This hook should return the built-in decl needed to load a vector of the "
1017 "given type within a transaction.",
1018 tree,
1019 (tree),
1020 default_builtin_tm_load_store)
1022 /* Return the builtin decl needed to store a vector of TYPE. */
1023 DEFHOOK
1024 (builtin_tm_store,
1025 "This hook should return the built-in decl needed to store a vector of the "
1026 "given type within a transaction.",
1027 tree,
1028 (tree),
1029 default_builtin_tm_load_store)
1031 /* Returns the preferred mode for SIMD operations for the specified
1032 scalar mode. */
1033 DEFHOOK
1034 (preferred_simd_mode,
1036 enum machine_mode,
1037 (enum machine_mode mode),
1038 default_preferred_simd_mode)
1040 /* Returns a mask of vector sizes to iterate over when auto-vectorizing
1041 after processing the preferred one derived from preferred_simd_mode. */
1042 DEFHOOK
1043 (autovectorize_vector_sizes,
1045 unsigned int,
1046 (void),
1047 default_autovectorize_vector_sizes)
1049 /* Target builtin that implements vector gather operation. */
1050 DEFHOOK
1051 (builtin_gather,
1053 tree,
1054 (const_tree mem_vectype, const_tree index_type, int scale),
1055 NULL)
1057 HOOK_VECTOR_END (vectorize)
1059 #undef HOOK_PREFIX
1060 #define HOOK_PREFIX "TARGET_"
1062 /* Allow target specific overriding of option settings after options have
1063 been changed by an attribute or pragma or when it is reset at the
1064 end of the code affected by an attribute or pragma. */
1065 DEFHOOK
1066 (override_options_after_change,
1068 void, (void),
1069 hook_void_void)
1071 DEFHOOK_UNDOC
1072 (eh_return_filter_mode,
1073 "Return machine mode for filter value.",
1074 enum machine_mode, (void),
1075 default_eh_return_filter_mode)
1077 /* Return machine mode for libgcc expanded cmp instructions. */
1078 DEFHOOK
1079 (libgcc_cmp_return_mode,
1081 enum machine_mode, (void),
1082 default_libgcc_cmp_return_mode)
1084 /* Return machine mode for libgcc expanded shift instructions. */
1085 DEFHOOK
1086 (libgcc_shift_count_mode,
1088 enum machine_mode, (void),
1089 default_libgcc_shift_count_mode)
1091 /* Return machine mode to be used for _Unwind_Word type. */
1092 DEFHOOK
1093 (unwind_word_mode,
1095 enum machine_mode, (void),
1096 default_unwind_word_mode)
1098 /* Given two decls, merge their attributes and return the result. */
1099 DEFHOOK
1100 (merge_decl_attributes,
1102 tree, (tree olddecl, tree newdecl),
1103 merge_decl_attributes)
1105 /* Given two types, merge their attributes and return the result. */
1106 DEFHOOK
1107 (merge_type_attributes,
1109 tree, (tree type1, tree type2),
1110 merge_type_attributes)
1112 /* Table of machine attributes and functions to handle them.
1113 Ignored if NULL. */
1114 DEFHOOKPOD
1115 (attribute_table,
1117 const struct attribute_spec *, NULL)
1119 /* Return true iff attribute NAME expects a plain identifier as its first
1120 argument. */
1121 DEFHOOK
1122 (attribute_takes_identifier_p,
1124 bool, (const_tree name),
1125 hook_bool_const_tree_false)
1127 /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible,
1128 one if they are compatible and two if they are nearly compatible
1129 (which causes a warning to be generated). */
1130 DEFHOOK
1131 (comp_type_attributes,
1133 int, (const_tree type1, const_tree type2),
1134 hook_int_const_tree_const_tree_1)
1136 /* Assign default attributes to the newly defined TYPE. */
1137 DEFHOOK
1138 (set_default_type_attributes,
1140 void, (tree type),
1141 hook_void_tree)
1143 /* Insert attributes on the newly created DECL. */
1144 DEFHOOK
1145 (insert_attributes,
1147 void, (tree node, tree *attr_ptr),
1148 hook_void_tree_treeptr)
1150 /* Return true if FNDECL (which has at least one machine attribute)
1151 can be inlined despite its machine attributes, false otherwise. */
1152 DEFHOOK
1153 (function_attribute_inlinable_p,
1155 bool, (const_tree fndecl),
1156 hook_bool_const_tree_false)
1158 /* Return true if bitfields in RECORD_TYPE should follow the
1159 Microsoft Visual C++ bitfield layout rules. */
1160 DEFHOOK
1161 (ms_bitfield_layout_p,
1163 bool, (const_tree record_type),
1164 hook_bool_const_tree_false)
1166 /* For now this is only an interface to WORDS_BIG_ENDIAN for
1167 target-independent code like the front ends, need performance testing
1168 before switching completely to the target hook. */
1169 DEFHOOK_UNDOC
1170 (words_big_endian,
1172 bool, (void),
1173 targhook_words_big_endian)
1175 /* Likewise for FLOAT_WORDS_BIG_ENDIAN. */
1176 DEFHOOK_UNDOC
1177 (float_words_big_endian,
1179 bool, (void),
1180 targhook_float_words_big_endian)
1182 /* True if the target supports decimal floating point. */
1183 DEFHOOK
1184 (decimal_float_supported_p,
1186 bool, (void),
1187 default_decimal_float_supported_p)
1189 /* True if the target supports fixed-point. */
1190 DEFHOOK
1191 (fixed_point_supported_p,
1193 bool, (void),
1194 default_fixed_point_supported_p)
1196 /* Return true if anonymous bitfields affect structure alignment. */
1197 DEFHOOK
1198 (align_anon_bitfield,
1200 bool, (void),
1201 hook_bool_void_false)
1203 /* Return true if volatile bitfields should use the narrowest type possible.
1204 Return false if they should use the container type. */
1205 DEFHOOK
1206 (narrow_volatile_bitfield,
1208 bool, (void),
1209 hook_bool_void_false)
1211 /* Set up target-specific built-in functions. */
1212 DEFHOOK
1213 (init_builtins,
1215 void, (void),
1216 hook_void_void)
1218 /* Initialize (if INITIALIZE_P is true) and return the target-specific
1219 built-in function decl for CODE.
1220 Return NULL if that is not possible. Return error_mark_node if CODE
1221 is outside of the range of valid target builtin function codes. */
1222 DEFHOOK
1223 (builtin_decl,
1225 tree, (unsigned code, bool initialize_p), NULL)
1227 /* Expand a target-specific builtin. */
1228 DEFHOOK
1229 (expand_builtin,
1231 rtx,
1232 (tree exp, rtx target, rtx subtarget, enum machine_mode mode, int ignore),
1233 default_expand_builtin)
1235 /* Select a replacement for a target-specific builtin. This is done
1236 *before* regular type checking, and so allows the target to
1237 implement a crude form of function overloading. The result is a
1238 complete expression that implements the operation. PARAMS really
1239 has type VEC(tree,gc)*, but we don't want to include tree.h here. */
1240 DEFHOOK
1241 (resolve_overloaded_builtin,
1243 tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
1245 /* Fold a target-specific builtin. */
1246 DEFHOOK
1247 (fold_builtin,
1249 tree, (tree fndecl, int n_args, tree *argp, bool ignore),
1250 hook_tree_tree_int_treep_bool_null)
1252 /* Returns true if unaligned vector loads/stores are slow. */
1253 DEFHOOK
1254 (slow_unaligned_vector_memop,
1256 bool, (void), NULL)
1258 /* Target hook is used to compare the target attributes in two functions to
1259 determine which function's features get higher priority. This is used
1260 during function multi-versioning to figure out the order in which two
1261 versions must be dispatched. A function version with a higher priority
1262 is checked for dispatching earlier. DECL1 and DECL2 are
1263 the two function decls that will be compared. It returns positive value
1264 if DECL1 is higher priority, negative value if DECL2 is higher priority
1265 and 0 if they are the same. */
1266 DEFHOOK
1267 (compare_version_priority,
1269 int, (tree decl1, tree decl2), NULL)
1271 /* Target hook is used to generate the dispatcher logic to invoke the right
1272 function version at run-time for a given set of function versions.
1273 ARG points to the callgraph node of the dispatcher function whose body
1274 must be generated. */
1275 DEFHOOK
1276 (generate_version_dispatcher_body,
1278 tree, (void *arg), NULL)
1280 /* Target hook is used to get the dispatcher function for a set of function
1281 versions. The dispatcher function is called to invoke the right function
1282 version at run-time. DECL is one version from a set of semantically
1283 identical versions. */
1284 DEFHOOK
1285 (get_function_versions_dispatcher,
1287 tree, (void *decl), NULL)
1289 /* Returns a code for a target-specific builtin that implements
1290 reciprocal of the function, or NULL_TREE if not available. */
1291 DEFHOOK
1292 (builtin_reciprocal,
1294 tree, (unsigned fn, bool md_fn, bool sqrt),
1295 default_builtin_reciprocal)
1297 /* For a vendor-specific TYPE, return a pointer to a statically-allocated
1298 string containing the C++ mangling for TYPE. In all other cases, return
1299 NULL. */
1300 DEFHOOK
1301 (mangle_type,
1303 const char *, (const_tree type),
1304 hook_constcharptr_const_tree_null)
1306 /* Make any adjustments to libfunc names needed for this target. */
1307 DEFHOOK
1308 (init_libfuncs,
1310 void, (void),
1311 hook_void_void)
1313 /* Add a __gnu_ prefix to library functions rather than just __. */
1314 DEFHOOKPOD
1315 (libfunc_gnu_prefix,
1316 "If false (the default), internal library routines start with two\n\
1317 underscores. If set to true, these routines start with @code{__gnu_}\n\
1318 instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
1319 currently only affects functions defined in @file{libgcc2.c}. If this\n\
1320 is set to true, the @file{tm.h} file must also\n\
1321 @code{#define LIBGCC2_GNU_PREFIX}.",
1322 bool, false)
1324 /* Given a decl, a section name, and whether the decl initializer
1325 has relocs, choose attributes for the section. */
1326 /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
1327 DEFHOOK
1328 (section_type_flags,
1330 unsigned int, (tree decl, const char *name, int reloc),
1331 default_section_type_flags)
1333 /* True if new jumps cannot be created, to replace existing ones or
1334 not, at the current point in the compilation. */
1335 DEFHOOK
1336 (cannot_modify_jumps_p,
1338 bool, (void),
1339 hook_bool_void_false)
1341 /* Return a register class for which branch target register
1342 optimizations should be applied. */
1343 DEFHOOK
1344 (branch_target_register_class,
1346 reg_class_t, (void),
1347 default_branch_target_register_class)
1349 /* Return true if branch target register optimizations should include
1350 callee-saved registers that are not already live during the current
1351 function. AFTER_PE_GEN is true if prologues and epilogues have
1352 already been generated. */
1353 DEFHOOK
1354 (branch_target_register_callee_saved,
1356 bool, (bool after_prologue_epilogue_gen),
1357 hook_bool_bool_false)
1359 /* Return true if the target supports conditional execution. */
1360 DEFHOOK
1361 (have_conditional_execution,
1363 bool, (void),
1364 default_have_conditional_execution)
1366 /* Return a new value for loop unroll size. */
1367 DEFHOOK
1368 (loop_unroll_adjust,
1370 unsigned, (unsigned nunroll, struct loop *loop),
1371 NULL)
1373 /* True if X is a legitimate MODE-mode immediate operand. */
1374 DEFHOOK
1375 (legitimate_constant_p,
1377 bool, (enum machine_mode mode, rtx x),
1378 hook_bool_mode_rtx_true)
1380 /* True if the constant X cannot be placed in the constant pool. */
1381 DEFHOOK
1382 (cannot_force_const_mem,
1384 bool, (enum machine_mode mode, rtx x),
1385 hook_bool_mode_rtx_false)
1387 DEFHOOK_UNDOC
1388 (cannot_copy_insn_p,
1389 "True if the insn @var{x} cannot be duplicated.",
1390 bool, (rtx), NULL)
1392 /* True if X is considered to be commutative. */
1393 DEFHOOK
1394 (commutative_p,
1396 bool, (const_rtx x, int outer_code),
1397 hook_bool_const_rtx_commutative_p)
1399 /* True if ADDR is an address-expression whose effect depends
1400 on the mode of the memory reference it is used in. */
1401 DEFHOOK
1402 (mode_dependent_address_p,
1404 bool, (const_rtx addr),
1405 default_mode_dependent_address_p)
1407 /* Given an invalid address X for a given machine mode, try machine-specific
1408 ways to make it legitimate. Return X or an invalid address on failure. */
1409 DEFHOOK
1410 (legitimize_address,
1412 rtx, (rtx x, rtx oldx, enum machine_mode mode),
1413 default_legitimize_address)
1415 /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS. */
1416 DEFHOOK
1417 (delegitimize_address,
1419 rtx, (rtx x),
1420 delegitimize_mem_from_attrs)
1422 /* Given an RTX, return true if it is not ok to emit it into debug info
1423 section. */
1424 DEFHOOK
1425 (const_not_ok_for_debug_p,
1427 bool, (rtx x),
1428 hook_bool_rtx_false)
1430 /* Given an address RTX, say whether it is valid. */
1431 DEFHOOK
1432 (legitimate_address_p,
1434 bool, (enum machine_mode mode, rtx x, bool strict),
1435 default_legitimate_address_p)
1437 /* True if the given constant can be put into an object_block. */
1438 DEFHOOK
1439 (use_blocks_for_constant_p,
1441 bool, (enum machine_mode mode, const_rtx x),
1442 hook_bool_mode_const_rtx_false)
1444 /* The minimum and maximum byte offsets for anchored addresses. */
1445 DEFHOOKPOD
1446 (min_anchor_offset,
1448 HOST_WIDE_INT, 0)
1450 DEFHOOKPOD
1451 (max_anchor_offset,
1453 HOST_WIDE_INT, 0)
1455 /* True if section anchors can be used to access the given symbol. */
1456 DEFHOOK
1457 (use_anchors_for_symbol_p,
1459 bool, (const_rtx x),
1460 default_use_anchors_for_symbol_p)
1462 /* True if it is OK to do sibling call optimization for the specified
1463 call expression EXP. DECL will be the called function, or NULL if
1464 this is an indirect call. */
1465 DEFHOOK
1466 (function_ok_for_sibcall,
1468 bool, (tree decl, tree exp),
1469 hook_bool_tree_tree_false)
1471 /* Establish appropriate back-end context for processing the function
1472 FNDECL. The argument might be NULL to indicate processing at top
1473 level, outside of any function scope. */
1474 DEFHOOK
1475 (set_current_function,
1477 void, (tree decl), hook_void_tree)
1479 /* True if EXP should be placed in a "small data" section. */
1480 DEFHOOK
1481 (in_small_data_p,
1483 bool, (const_tree exp),
1484 hook_bool_const_tree_false)
1486 /* True if EXP names an object for which name resolution must resolve
1487 to the current executable or shared library. */
1488 DEFHOOK
1489 (binds_local_p,
1491 bool, (const_tree exp),
1492 default_binds_local_p)
1494 /* Check if profiling code is before or after prologue. */
1495 DEFHOOK
1496 (profile_before_prologue,
1497 "It returns true if target wants profile code emitted before prologue.\n\n\
1498 The default version of this hook use the target macro\n\
1499 @code{PROFILE_BEFORE_PROLOGUE}.",
1500 bool, (void),
1501 default_profile_before_prologue)
1503 /* Modify and return the identifier of a DECL's external name,
1504 originally identified by ID, as required by the target,
1505 (eg, append @nn to windows32 stdcall function names).
1506 The default is to return ID without modification. */
1507 DEFHOOK
1508 (mangle_decl_assembler_name,
1510 tree, (tree decl, tree id),
1511 default_mangle_decl_assembler_name)
1513 /* Do something target-specific to record properties of the DECL into
1514 the associated SYMBOL_REF. */
1515 DEFHOOK
1516 (encode_section_info,
1518 void, (tree decl, rtx rtl, int new_decl_p),
1519 default_encode_section_info)
1521 /* Undo the effects of encode_section_info on the symbol string. */
1522 DEFHOOK
1523 (strip_name_encoding,
1525 const char *, (const char *name),
1526 default_strip_name_encoding)
1528 /* If shift optabs for MODE are known to always truncate the shift count,
1529 return the mask that they apply. Return 0 otherwise. */
1530 DEFHOOK
1531 (shift_truncation_mask,
1533 unsigned HOST_WIDE_INT, (enum machine_mode mode),
1534 default_shift_truncation_mask)
1536 /* Return the number of divisions in the given MODE that should be present,
1537 so that it is profitable to turn the division into a multiplication by
1538 the reciprocal. */
1539 DEFHOOK
1540 (min_divisions_for_recip_mul,
1542 unsigned int, (enum machine_mode mode),
1543 default_min_divisions_for_recip_mul)
1545 /* If the representation of integral MODE is such that values are
1546 always sign-extended to a wider mode MODE_REP then return
1547 SIGN_EXTEND. Return UNKNOWN otherwise. */
1548 /* Note that the return type ought to be RTX_CODE, but that's not
1549 necessarily defined at this point. */
1550 DEFHOOK
1551 (mode_rep_extended,
1553 int, (enum machine_mode mode, enum machine_mode rep_mode),
1554 default_mode_rep_extended)
1556 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))). */
1557 DEFHOOK
1558 (valid_pointer_mode,
1560 bool, (enum machine_mode mode),
1561 default_valid_pointer_mode)
1563 /* Disambiguate with errno. */
1564 DEFHOOK
1565 (ref_may_alias_errno,
1566 "Define this to return nonzero if the memory reference @var{ref}\
1567 may alias with the system C library errno location. The default\
1568 version of this hook assumes the system C library errno location\
1569 is either a declaration of type int or accessed by dereferencing\
1570 a pointer to int.",
1571 bool, (struct ao_ref_s *ref),
1572 default_ref_may_alias_errno)
1574 /* Support for named address spaces. */
1575 #undef HOOK_PREFIX
1576 #define HOOK_PREFIX "TARGET_ADDR_SPACE_"
1577 HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
1579 /* MODE to use for a pointer into another address space. */
1580 DEFHOOK
1581 (pointer_mode,
1583 enum machine_mode, (addr_space_t address_space),
1584 default_addr_space_pointer_mode)
1586 /* MODE to use for an address in another address space. */
1587 DEFHOOK
1588 (address_mode,
1590 enum machine_mode, (addr_space_t address_space),
1591 default_addr_space_address_mode)
1593 /* True if MODE is valid for a pointer in __attribute__((mode("MODE")))
1594 in another address space. */
1595 DEFHOOK
1596 (valid_pointer_mode,
1598 bool, (enum machine_mode mode, addr_space_t as),
1599 default_addr_space_valid_pointer_mode)
1601 /* True if an address is a valid memory address to a given named address
1602 space for a given mode. */
1603 DEFHOOK
1604 (legitimate_address_p,
1606 bool, (enum machine_mode mode, rtx exp, bool strict, addr_space_t as),
1607 default_addr_space_legitimate_address_p)
1609 /* Return an updated address to convert an invalid pointer to a named
1610 address space to a valid one. If NULL_RTX is returned use machine
1611 independent methods to make the address valid. */
1612 DEFHOOK
1613 (legitimize_address,
1615 rtx, (rtx x, rtx oldx, enum machine_mode mode, addr_space_t as),
1616 default_addr_space_legitimize_address)
1618 /* True if one named address space is a subset of another named address. */
1619 DEFHOOK
1620 (subset_p,
1622 bool, (addr_space_t subset, addr_space_t superset),
1623 default_addr_space_subset_p)
1625 /* Function to convert an rtl expression from one address space to another. */
1626 DEFHOOK
1627 (convert,
1629 rtx, (rtx op, tree from_type, tree to_type),
1630 default_addr_space_convert)
1632 HOOK_VECTOR_END (addr_space)
1634 #undef HOOK_PREFIX
1635 #define HOOK_PREFIX "TARGET_"
1637 /* True if MODE is valid for the target. By "valid", we mean able to
1638 be manipulated in non-trivial ways. In particular, this means all
1639 the arithmetic is supported. */
1640 DEFHOOK
1641 (scalar_mode_supported_p,
1643 bool, (enum machine_mode mode),
1644 default_scalar_mode_supported_p)
1646 /* Similarly for vector modes. "Supported" here is less strict. At
1647 least some operations are supported; need to check optabs or builtins
1648 for further details. */
1649 DEFHOOK
1650 (vector_mode_supported_p,
1652 bool, (enum machine_mode mode),
1653 hook_bool_mode_false)
1655 DEFHOOK
1656 (vector_alignment,
1657 "This hook can be used to define the alignment for a vector of type\n\
1658 @var{type}, in order to comply with a platform ABI. The default is to\n\
1659 require natural alignment for vector types. The alignment returned by\n\
1660 this hook must be a power-of-two multiple of the default alignment of\n\
1661 the vector element type.",
1662 HOST_WIDE_INT, (const_tree type),
1663 default_vector_alignment)
1665 /* True if we should try to use a scalar mode to represent an array,
1666 overriding the usual MAX_FIXED_MODE limit. */
1667 DEFHOOK
1668 (array_mode_supported_p,
1669 "Return true if GCC should try to use a scalar mode to store an array\n\
1670 of @var{nelems} elements, given that each element has mode @var{mode}.\n\
1671 Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
1672 and allows GCC to use any defined integer mode.\n\
1674 One use of this hook is to support vector load and store operations\n\
1675 that operate on several homogeneous vectors. For example, ARM NEON\n\
1676 has operations like:\n\
1678 @smallexample\n\
1679 int8x8x3_t vld3_s8 (const int8_t *)\n\
1680 @end smallexample\n\
1682 where the return type is defined as:\n\
1684 @smallexample\n\
1685 typedef struct int8x8x3_t\n\
1686 @{\n\
1687 int8x8_t val[3];\n\
1688 @} int8x8x3_t;\n\
1689 @end smallexample\n\
1691 If this hook allows @code{val} to have a scalar mode, then\n\
1692 @code{int8x8x3_t} can have the same mode. GCC can then store\n\
1693 @code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
1694 bool, (enum machine_mode mode, unsigned HOST_WIDE_INT nelems),
1695 hook_bool_mode_uhwi_false)
1697 /* Compute cost of moving data from a register of class FROM to one of
1698 TO, using MODE. */
1699 DEFHOOK
1700 (register_move_cost,
1702 int, (enum machine_mode mode, reg_class_t from, reg_class_t to),
1703 default_register_move_cost)
1705 /* Compute cost of moving registers to/from memory. */
1706 /* ??? Documenting the argument types for this hook requires a GFDL
1707 license grant. Also, the documentation uses a different name for RCLASS. */
1708 DEFHOOK
1709 (memory_move_cost,
1711 int, (enum machine_mode mode, reg_class_t rclass, bool in),
1712 default_memory_move_cost)
1714 /* True for MODE if the target expects that registers in this mode will
1715 be allocated to registers in a small register class. The compiler is
1716 allowed to use registers explicitly used in the rtl as spill registers
1717 but it should prevent extending the lifetime of these registers. */
1718 DEFHOOK
1719 (small_register_classes_for_mode_p,
1721 bool, (enum machine_mode mode),
1722 hook_bool_mode_false)
1724 /* Register number for a flags register. Only needs to be defined if the
1725 target is constrainted to use post-reload comparison elimination. */
1726 DEFHOOKPOD
1727 (flags_regnum,
1728 "If the target has a dedicated flags register, and it needs to use the\
1729 post-reload comparison elimination pass, then this value should be set\
1730 appropriately.",
1731 unsigned int, INVALID_REGNUM)
1733 /* Compute a (partial) cost for rtx X. Return true if the complete
1734 cost has been computed, and false if subexpressions should be
1735 scanned. In either case, *TOTAL contains the cost result. */
1736 /* Note that CODE and OUTER_CODE ought to be RTX_CODE, but that's
1737 not necessarily defined at this point. */
1738 DEFHOOK
1739 (rtx_costs,
1741 bool, (rtx x, int code, int outer_code, int opno, int *total, bool speed),
1742 hook_bool_rtx_int_int_int_intp_bool_false)
1744 /* Compute the cost of X, used as an address. Never called with
1745 invalid addresses. */
1746 DEFHOOK
1747 (address_cost,
1749 int, (rtx address, bool speed),
1750 default_address_cost)
1752 /* Return where to allocate pseudo for a given hard register initial value. */
1753 DEFHOOK
1754 (allocate_initial_value,
1756 rtx, (rtx hard_reg), NULL)
1758 /* Return nonzero if evaluating UNSPEC[_VOLATILE] X might cause a trap.
1759 FLAGS has the same meaning as in rtlanal.c: may_trap_p_1. */
1760 DEFHOOK
1761 (unspec_may_trap_p,
1763 int, (const_rtx x, unsigned flags),
1764 default_unspec_may_trap_p)
1766 /* Given a register, this hook should return a parallel of registers
1767 to represent where to find the register pieces. Define this hook
1768 if the register and its mode are represented in Dwarf in
1769 non-contiguous locations, or if the register should be
1770 represented in more than one register in Dwarf. Otherwise, this
1771 hook should return NULL_RTX. */
1772 DEFHOOK
1773 (dwarf_register_span,
1775 rtx, (rtx reg),
1776 hook_rtx_rtx_null)
1778 /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table
1779 entries not corresponding directly to registers below
1780 FIRST_PSEUDO_REGISTER, this hook should generate the necessary
1781 code, given the address of the table. */
1782 DEFHOOK
1783 (init_dwarf_reg_sizes_extra,
1785 void, (tree address),
1786 hook_void_tree)
1788 /* Fetch the fixed register(s) which hold condition codes, for
1789 targets where it makes sense to look for duplicate assignments to
1790 the condition codes. This should return true if there is such a
1791 register, false otherwise. The arguments should be set to the
1792 fixed register numbers. Up to two condition code registers are
1793 supported. If there is only one for this target, the int pointed
1794 at by the second argument should be set to -1. */
1795 DEFHOOK
1796 (fixed_condition_code_regs,
1798 bool, (unsigned int *p1, unsigned int *p2),
1799 hook_bool_uintp_uintp_false)
1801 /* If two condition code modes are compatible, return a condition
1802 code mode which is compatible with both, such that a comparison
1803 done in the returned mode will work for both of the original
1804 modes. If the condition code modes are not compatible, return
1805 VOIDmode. */
1806 DEFHOOK
1807 (cc_modes_compatible,
1809 enum machine_mode, (enum machine_mode m1, enum machine_mode m2),
1810 default_cc_modes_compatible)
1812 /* Do machine-dependent code transformations. Called just before
1813 delayed-branch scheduling. */
1814 DEFHOOK
1815 (machine_dependent_reorg,
1817 void, (void), NULL)
1819 /* Create the __builtin_va_list type. */
1820 DEFHOOK
1821 (build_builtin_va_list,
1823 tree, (void),
1824 std_build_builtin_va_list)
1826 /* Enumerate the va list variants. */
1827 DEFHOOK
1828 (enum_va_list_p,
1830 int, (int idx, const char **pname, tree *ptree),
1831 NULL)
1833 /* Get the cfun/fndecl calling abi __builtin_va_list type. */
1834 DEFHOOK
1835 (fn_abi_va_list,
1837 tree, (tree fndecl),
1838 std_fn_abi_va_list)
1840 /* Get the __builtin_va_list type dependent on input type. */
1841 DEFHOOK
1842 (canonical_va_list_type,
1844 tree, (tree type),
1845 std_canonical_va_list_type)
1847 /* ??? Documenting this hook requires a GFDL license grant. */
1848 DEFHOOK_UNDOC
1849 (expand_builtin_va_start,
1850 "Expand the @code{__builtin_va_start} builtin.",
1851 void, (tree valist, rtx nextarg), NULL)
1853 /* Gimplifies a VA_ARG_EXPR. */
1854 DEFHOOK
1855 (gimplify_va_arg_expr,
1857 tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
1858 std_gimplify_va_arg_expr)
1860 /* Validity-checking routines for PCH files, target-specific.
1861 get_pch_validity returns a pointer to the data to be stored,
1862 and stores the size in its argument. pch_valid_p gets the same
1863 information back and returns NULL if the PCH is valid,
1864 or an error message if not. */
1865 DEFHOOK
1866 (get_pch_validity,
1868 void *, (size_t *sz),
1869 default_get_pch_validity)
1871 DEFHOOK
1872 (pch_valid_p,
1874 const char *, (const void *data, size_t sz),
1875 default_pch_valid_p)
1877 DEFHOOK
1878 (prepare_pch_save,
1879 "Called before writing out a PCH file. If the target has some\n\
1880 garbage-collected data that needs to be in a particular state on PCH loads,\n\
1881 it can use this hook to enforce that state. Very few targets need\n\
1882 to do anything here.",
1883 void, (void),
1884 hook_void_void)
1886 /* If nonnull, this function checks whether a PCH file with the
1887 given set of target flags can be used. It returns NULL if so,
1888 otherwise it returns an error message. */
1889 DEFHOOK
1890 (check_pch_target_flags,
1892 const char *, (int pch_flags), NULL)
1894 /* True if the compiler should give an enum type only as many
1895 bytes as it takes to represent the range of possible values of
1896 that type. */
1897 DEFHOOK
1898 (default_short_enums,
1900 bool, (void),
1901 hook_bool_void_false)
1903 /* This target hook returns an rtx that is used to store the address
1904 of the current frame into the built-in setjmp buffer. */
1905 DEFHOOK
1906 (builtin_setjmp_frame_value,
1908 rtx, (void),
1909 default_builtin_setjmp_frame_value)
1911 /* This target hook should add STRING_CST trees for any hard regs
1912 the port wishes to automatically clobber for an asm. */
1913 DEFHOOK
1914 (md_asm_clobbers,
1916 tree, (tree outputs, tree inputs, tree clobbers),
1917 hook_tree_tree_tree_tree_3rd_identity)
1919 /* This target hook allows the backend to specify a calling convention
1920 in the debug information. This function actually returns an
1921 enum dwarf_calling_convention, but because of forward declarations
1922 and not wanting to include dwarf2.h everywhere target.h is included
1923 the function is being declared as an int. */
1924 DEFHOOK
1925 (dwarf_calling_convention,
1927 int, (const_tree function),
1928 hook_int_const_tree_0)
1930 /* This target hook allows the backend to emit frame-related insns that
1931 contain UNSPECs or UNSPEC_VOLATILEs. The call frame debugging info
1932 engine will invoke it on insns of the form
1933 (set (reg) (unspec [...] UNSPEC_INDEX))
1935 (set (reg) (unspec_volatile [...] UNSPECV_INDEX))
1936 to let the backend emit the call frame instructions. */
1937 DEFHOOK
1938 (dwarf_handle_frame_unspec,
1940 void, (const char *label, rtx pattern, int index), NULL)
1942 /* ??? Documenting this hook requires a GFDL license grant. */
1943 DEFHOOK_UNDOC
1944 (stdarg_optimize_hook,
1945 "Perform architecture specific checking of statements gimplified\
1946 from @code{VA_ARG_EXPR}. @var{stmt} is the statement. Returns true if\
1947 the statement doesn't need to be checked for @code{va_list} references.",
1948 bool, (struct stdarg_info *ai, const_gimple stmt), NULL)
1950 /* This target hook allows the operating system to override the DECL
1951 that represents the external variable that contains the stack
1952 protection guard variable. The type of this DECL is ptr_type_node. */
1953 DEFHOOK
1954 (stack_protect_guard,
1956 tree, (void),
1957 default_stack_protect_guard)
1959 /* This target hook allows the operating system to override the CALL_EXPR
1960 that is invoked when a check vs the guard variable fails. */
1961 DEFHOOK
1962 (stack_protect_fail,
1964 tree, (void),
1965 default_external_stack_protect_fail)
1967 /* Returns NULL if target supports the insn within a doloop block,
1968 otherwise it returns an error message. */
1969 DEFHOOK
1970 (invalid_within_doloop,
1972 const char *, (const_rtx insn),
1973 default_invalid_within_doloop)
1975 DEFHOOK
1976 (valid_dllimport_attribute_p,
1977 "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\
1978 specified. Use this hook if the target needs to add extra validation\
1979 checks to @code{handle_dll_attribute}.",
1980 bool, (const_tree decl),
1981 hook_bool_const_tree_true)
1983 /* If non-zero, align constant anchors in CSE to a multiple of this
1984 value. */
1985 DEFHOOKPOD
1986 (const_anchor,
1988 unsigned HOST_WIDE_INT, 0)
1990 /* Functions relating to calls - argument passing, returns, etc. */
1991 /* Members of struct call have no special macro prefix. */
1992 HOOK_VECTOR (TARGET_CALLS, calls)
1994 DEFHOOK
1995 (promote_function_mode,
1997 enum machine_mode, (const_tree type, enum machine_mode mode, int *punsignedp,
1998 const_tree funtype, int for_return),
1999 default_promote_function_mode)
2001 DEFHOOK
2002 (promote_prototypes,
2004 bool, (const_tree fntype),
2005 hook_bool_const_tree_false)
2007 DEFHOOK
2008 (struct_value_rtx,
2010 rtx, (tree fndecl, int incoming),
2011 hook_rtx_tree_int_null)
2012 DEFHOOK
2013 (return_in_memory,
2015 bool, (const_tree type, const_tree fntype),
2016 default_return_in_memory)
2018 DEFHOOK
2019 (return_in_msb,
2021 bool, (const_tree type),
2022 hook_bool_const_tree_false)
2024 /* Return true if a parameter must be passed by reference. TYPE may
2025 be null if this is a libcall. CA may be null if this query is
2026 from __builtin_va_arg. */
2027 DEFHOOK
2028 (pass_by_reference,
2030 bool,
2031 (cumulative_args_t cum, enum machine_mode mode, const_tree type, bool named),
2032 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
2034 DEFHOOK
2035 (expand_builtin_saveregs,
2037 rtx, (void),
2038 default_expand_builtin_saveregs)
2040 /* Returns pretend_argument_size. */
2041 DEFHOOK
2042 (setup_incoming_varargs,
2044 void, (cumulative_args_t args_so_far, enum machine_mode mode, tree type,
2045 int *pretend_args_size, int second_time),
2046 default_setup_incoming_varargs)
2048 DEFHOOK
2049 (strict_argument_naming,
2051 bool, (cumulative_args_t ca),
2052 hook_bool_CUMULATIVE_ARGS_false)
2054 /* Returns true if we should use
2055 targetm.calls.setup_incoming_varargs() and/or
2056 targetm.calls.strict_argument_naming(). */
2057 DEFHOOK
2058 (pretend_outgoing_varargs_named,
2060 bool, (cumulative_args_t ca),
2061 default_pretend_outgoing_varargs_named)
2063 /* Given a complex type T, return true if a parameter of type T
2064 should be passed as two scalars. */
2065 DEFHOOK
2066 (split_complex_arg,
2068 bool, (const_tree type), NULL)
2070 /* Return true if type T, mode MODE, may not be passed in registers,
2071 but must be passed on the stack. */
2072 /* ??? This predicate should be applied strictly after pass-by-reference.
2073 Need audit to verify that this is the case. */
2074 DEFHOOK
2075 (must_pass_in_stack,
2077 bool, (enum machine_mode mode, const_tree type),
2078 must_pass_in_stack_var_size_or_pad)
2080 /* Return true if type TYPE, mode MODE, which is passed by reference,
2081 should have the object copy generated by the callee rather than
2082 the caller. It is never called for TYPE requiring constructors. */
2083 DEFHOOK
2084 (callee_copies,
2086 bool,
2087 (cumulative_args_t cum, enum machine_mode mode, const_tree type, bool named),
2088 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
2090 /* Return zero for arguments passed entirely on the stack or entirely
2091 in registers. If passed in both, return the number of bytes passed
2092 in registers; the balance is therefore passed on the stack. */
2093 DEFHOOK
2094 (arg_partial_bytes,
2096 int, (cumulative_args_t cum, enum machine_mode mode, tree type, bool named),
2097 hook_int_CUMULATIVE_ARGS_mode_tree_bool_0)
2099 /* Update the state in CA to advance past an argument in the
2100 argument list. The values MODE, TYPE, and NAMED describe that
2101 argument. */
2102 DEFHOOK
2103 (function_arg_advance,
2105 void,
2106 (cumulative_args_t ca, enum machine_mode mode, const_tree type, bool named),
2107 default_function_arg_advance)
2109 /* Return zero if the argument described by the state of CA should
2110 be placed on a stack, or a hard register in which to store the
2111 argument. The values MODE, TYPE, and NAMED describe that
2112 argument. */
2113 DEFHOOK
2114 (function_arg,
2116 rtx, (cumulative_args_t ca, enum machine_mode mode, const_tree type,
2117 bool named),
2118 default_function_arg)
2120 /* Likewise, but for machines with register windows. Return the
2121 location where the argument will appear to the callee. */
2122 DEFHOOK
2123 (function_incoming_arg,
2125 rtx, (cumulative_args_t ca, enum machine_mode mode, const_tree type,
2126 bool named),
2127 default_function_incoming_arg)
2129 DEFHOOK
2130 (function_arg_boundary,
2132 unsigned int, (enum machine_mode mode, const_tree type),
2133 default_function_arg_boundary)
2135 DEFHOOK
2136 (function_arg_round_boundary,
2137 "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
2138 which is the default value for this hook. You can define this hook to\n\
2139 return a different value if an argument size must be rounded to a larger\n\
2140 value.",
2141 unsigned int, (enum machine_mode mode, const_tree type),
2142 default_function_arg_round_boundary)
2144 /* Return the diagnostic message string if function without a prototype
2145 is not allowed for this 'val' argument; NULL otherwise. */
2146 DEFHOOK
2147 (invalid_arg_for_unprototyped_fn,
2149 const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
2150 hook_invalid_arg_for_unprototyped_fn)
2152 /* Return an rtx for the return value location of the function
2153 specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
2154 DEFHOOK
2155 (function_value,
2157 rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
2158 default_function_value)
2160 /* Return the rtx for the result of a libcall of mode MODE,
2161 calling the function FN_NAME. */
2162 DEFHOOK
2163 (libcall_value,
2165 rtx, (enum machine_mode mode, const_rtx fun),
2166 default_libcall_value)
2168 /* Return true if REGNO is a possible register number for
2169 a function value as seen by the caller. */
2170 DEFHOOK
2171 (function_value_regno_p,
2173 bool, (const unsigned int regno),
2174 default_function_value_regno_p)
2176 /* ??? Documenting this hook requires a GFDL license grant. */
2177 DEFHOOK_UNDOC
2178 (internal_arg_pointer,
2179 "Return an rtx for the argument pointer incoming to the\
2180 current function.",
2181 rtx, (void),
2182 default_internal_arg_pointer)
2184 /* Update the current function stack boundary if needed. */
2185 DEFHOOK
2186 (update_stack_boundary,
2188 void, (void), NULL)
2190 /* Handle stack alignment and return an rtx for Dynamic Realign
2191 Argument Pointer if necessary. */
2192 DEFHOOK
2193 (get_drap_rtx,
2195 rtx, (void), NULL)
2197 /* Return true if all function parameters should be spilled to the
2198 stack. */
2199 DEFHOOK
2200 (allocate_stack_slots_for_args,
2202 bool, (void),
2203 hook_bool_void_true)
2205 /* Return an rtx for the static chain for FNDECL. If INCOMING_P is true,
2206 then it should be for the callee; otherwise for the caller. */
2207 DEFHOOK
2208 (static_chain,
2210 rtx, (const_tree fndecl, bool incoming_p),
2211 default_static_chain)
2213 /* Fill in the trampoline at MEM with a call to FNDECL and a
2214 static chain value of CHAIN. */
2215 DEFHOOK
2216 (trampoline_init,
2218 void, (rtx m_tramp, tree fndecl, rtx static_chain),
2219 default_trampoline_init)
2221 /* Adjust the address of the trampoline in a target-specific way. */
2222 DEFHOOK
2223 (trampoline_adjust_address,
2225 rtx, (rtx addr), NULL)
2227 /* Return the number of bytes of its own arguments that a function
2228 pops on returning, or 0 if the function pops no arguments and the
2229 caller must therefore pop them all after the function returns. */
2230 /* ??? tm.texi has no types for the parameters. */
2231 DEFHOOK
2232 (return_pops_args,
2234 int, (tree fundecl, tree funtype, int size),
2235 default_return_pops_args)
2237 /* Return a mode wide enough to copy any function value that might be
2238 returned. */
2239 DEFHOOK
2240 (get_raw_result_mode,
2241 "This target hook returns the mode to be used when accessing raw return\
2242 registers in @code{__builtin_return}. Define this macro if the value\
2243 in @var{reg_raw_mode} is not correct.",
2244 enum machine_mode, (int regno),
2245 default_get_reg_raw_mode)
2247 /* Return a mode wide enough to copy any argument value that might be
2248 passed. */
2249 DEFHOOK
2250 (get_raw_arg_mode,
2251 "This target hook returns the mode to be used when accessing raw argument\
2252 registers in @code{__builtin_apply_args}. Define this macro if the value\
2253 in @var{reg_raw_mode} is not correct.",
2254 enum machine_mode, (int regno),
2255 default_get_reg_raw_mode)
2257 HOOK_VECTOR_END (calls)
2259 /* Return the diagnostic message string if conversion from FROMTYPE
2260 to TOTYPE is not allowed, NULL otherwise. */
2261 DEFHOOK
2262 (invalid_conversion,
2264 const char *, (const_tree fromtype, const_tree totype),
2265 hook_constcharptr_const_tree_const_tree_null)
2267 /* Return the diagnostic message string if the unary operation OP is
2268 not permitted on TYPE, NULL otherwise. */
2269 DEFHOOK
2270 (invalid_unary_op,
2272 const char *, (int op, const_tree type),
2273 hook_constcharptr_int_const_tree_null)
2275 /* Return the diagnostic message string if the binary operation OP
2276 is not permitted on TYPE1 and TYPE2, NULL otherwise. */
2277 DEFHOOK
2278 (invalid_binary_op,
2280 const char *, (int op, const_tree type1, const_tree type2),
2281 hook_constcharptr_int_const_tree_const_tree_null)
2283 /* Return the diagnostic message string if TYPE is not valid as a
2284 function parameter type, NULL otherwise. */
2285 DEFHOOK
2286 (invalid_parameter_type,
2288 const char *, (const_tree type),
2289 hook_constcharptr_const_tree_null)
2291 /* Return the diagnostic message string if TYPE is not valid as a
2292 function return type, NULL otherwise. */
2293 DEFHOOK
2294 (invalid_return_type,
2296 const char *, (const_tree type),
2297 hook_constcharptr_const_tree_null)
2299 /* If values of TYPE are promoted to some other type when used in
2300 expressions (analogous to the integer promotions), return that type,
2301 or NULL_TREE otherwise. */
2302 DEFHOOK
2303 (promoted_type,
2305 tree, (const_tree type),
2306 hook_tree_const_tree_null)
2308 /* Convert EXPR to TYPE, if target-specific types with special conversion
2309 rules are involved. Return the converted expression, or NULL to apply
2310 the standard conversion rules. */
2311 DEFHOOK
2312 (convert_to_type,
2314 tree, (tree type, tree expr),
2315 hook_tree_tree_tree_null)
2317 /* Return the class for a secondary reload, and fill in extra information. */
2318 DEFHOOK
2319 (secondary_reload,
2321 reg_class_t,
2322 (bool in_p, rtx x, reg_class_t reload_class, enum machine_mode reload_mode,
2323 secondary_reload_info *sri),
2324 default_secondary_reload)
2326 /* Given an rtx X being reloaded into a reg required to be in class CLASS,
2327 return the class of reg to actually use. */
2328 DEFHOOK
2329 (preferred_reload_class,
2331 reg_class_t,
2332 (rtx x, reg_class_t rclass),
2333 default_preferred_reload_class)
2335 /* Like TARGET_PREFERRED_RELOAD_CLASS, but for output reloads instead of
2336 input reloads. */
2337 DEFHOOK
2338 (preferred_output_reload_class,
2340 reg_class_t,
2341 (rtx x, reg_class_t rclass),
2342 default_preferred_output_reload_class)
2344 DEFHOOK
2345 (class_likely_spilled_p,
2347 bool, (reg_class_t rclass),
2348 default_class_likely_spilled_p)
2350 /* Return the maximum number of consecutive registers
2351 needed to represent mode MODE in a register of class RCLASS. */
2352 DEFHOOK
2353 (class_max_nregs,
2355 unsigned char, (reg_class_t rclass, enum machine_mode mode),
2356 default_class_max_nregs)
2358 DEFHOOK
2359 (preferred_rename_class,
2360 "A target hook that places additional preference on the register\
2361 class to use when it is necessary to rename a register in class\
2362 @var{rclass} to another class, or perhaps @var{NO_REGS}, if no\
2363 preferred register class is found or hook @code{preferred_rename_class}\
2364 is not implemented.\
2365 Sometimes returning a more restrictive class makes better code. For\
2366 example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\
2367 smaller than instructions using @code{GENERIC_REGS}. By returning\
2368 @code{LO_REGS} from @code{preferred_rename_class}, code size can\
2369 be reduced.",
2370 reg_class_t, (reg_class_t rclass),
2371 default_preferred_rename_class)
2373 /* This target hook allows the backend to perform additional
2374 processing while initializing for variable expansion. */
2375 DEFHOOK
2376 (expand_to_rtl_hook,
2378 void, (void),
2379 hook_void_void)
2381 /* This target hook allows the backend to perform additional
2382 instantiations on rtx that are not actually in insns yet,
2383 but will be later. */
2384 DEFHOOK
2385 (instantiate_decls,
2387 void, (void),
2388 hook_void_void)
2390 /* Return true if is OK to use a hard register REGNO as scratch register
2391 in peephole2. */
2392 DEFHOOK
2393 (hard_regno_scratch_ok,
2395 bool, (unsigned int regno),
2396 default_hard_regno_scratch_ok)
2398 /* Return the smallest number of different values for which it is best to
2399 use a jump-table instead of a tree of conditional branches. */
2400 DEFHOOK
2401 (case_values_threshold,
2403 unsigned int, (void),
2404 default_case_values_threshold)
2406 /* Retutn true if a function must have and use a frame pointer. */
2407 DEFHOOK
2408 (frame_pointer_required,
2410 bool, (void),
2411 hook_bool_void_false)
2413 /* Returns true if the compiler is allowed to try to replace register number
2414 from-reg with register number to-reg. */
2415 DEFHOOK
2416 (can_eliminate,
2418 bool, (const int from_reg, const int to_reg),
2419 hook_bool_const_int_const_int_true)
2421 /* Modify any or all of fixed_regs, call_used_regs, global_regs,
2422 reg_names, and reg_class_contents to account of the vagaries of the
2423 target. */
2424 DEFHOOK
2425 (conditional_register_usage,
2427 void, (void),
2428 hook_void_void)
2430 /* Functions specific to the C family of frontends. */
2431 #undef HOOK_PREFIX
2432 #define HOOK_PREFIX "TARGET_C_"
2433 HOOK_VECTOR (TARGET_C, c)
2435 /* ??? Documenting this hook requires a GFDL license grant. */
2436 DEFHOOK_UNDOC
2437 (mode_for_suffix,
2438 "Return machine mode for non-standard constant literal suffix @var{c},\
2439 or VOIDmode if non-standard suffixes are unsupported.",
2440 enum machine_mode, (char c),
2441 default_mode_for_suffix)
2443 HOOK_VECTOR_END (c)
2445 /* Functions specific to the C++ frontend. */
2446 #undef HOOK_PREFIX
2447 #define HOOK_PREFIX "TARGET_CXX_"
2448 HOOK_VECTOR (TARGET_CXX, cxx)
2450 /* Return the integer type used for guard variables. */
2451 DEFHOOK
2452 (guard_type,
2454 tree, (void),
2455 default_cxx_guard_type)
2457 /* Return true if only the low bit of the guard should be tested. */
2458 DEFHOOK
2459 (guard_mask_bit,
2461 bool, (void),
2462 hook_bool_void_false)
2464 /* Returns the size of the array cookie for an array of type. */
2465 DEFHOOK
2466 (get_cookie_size,
2468 tree, (tree type),
2469 default_cxx_get_cookie_size)
2471 /* Returns true if the element size should be stored in the array cookie. */
2472 DEFHOOK
2473 (cookie_has_size,
2475 bool, (void),
2476 hook_bool_void_false)
2478 /* Allows backends to perform additional processing when
2479 deciding if a class should be exported or imported. */
2480 DEFHOOK
2481 (import_export_class,
2483 int, (tree type, int import_export), NULL)
2485 /* Returns true if constructors and destructors return "this". */
2486 DEFHOOK
2487 (cdtor_returns_this,
2489 bool, (void),
2490 hook_bool_void_false)
2492 /* Returns true if the key method for a class can be an inline
2493 function, so long as it is not declared inline in the class
2494 itself. Returning true is the behavior required by the Itanium C++ ABI. */
2495 DEFHOOK
2496 (key_method_may_be_inline,
2498 bool, (void),
2499 hook_bool_void_true)
2501 DEFHOOK
2502 (determine_class_data_visibility,
2503 "@var{decl} is a virtual table, virtual table table, typeinfo object,\
2504 or other similar implicit class data object that will be emitted with\
2505 external linkage in this translation unit. No ELF visibility has been\
2506 explicitly specified. If the target needs to specify a visibility\
2507 other than that of the containing class, use this hook to set\
2508 @code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
2509 void, (tree decl),
2510 hook_void_tree)
2512 /* Returns true (the default) if virtual tables and other
2513 similar implicit class data objects are always COMDAT if they
2514 have external linkage. If this hook returns false, then
2515 class data for classes whose virtual table will be emitted in
2516 only one translation unit will not be COMDAT. */
2517 DEFHOOK
2518 (class_data_always_comdat,
2520 bool, (void),
2521 hook_bool_void_true)
2523 /* Returns true (the default) if the RTTI for the basic types,
2524 which is always defined in the C++ runtime, should be COMDAT;
2525 false if it should not be COMDAT. */
2526 DEFHOOK
2527 (library_rtti_comdat,
2529 bool, (void),
2530 hook_bool_void_true)
2532 /* Returns true if __aeabi_atexit should be used to register static
2533 destructors. */
2534 DEFHOOK
2535 (use_aeabi_atexit,
2537 bool, (void),
2538 hook_bool_void_false)
2540 /* Returns true if target may use atexit in the same manner as
2541 __cxa_atexit to register static destructors. */
2542 DEFHOOK
2543 (use_atexit_for_cxa_atexit,
2545 bool, (void),
2546 hook_bool_void_false)
2548 DEFHOOK
2549 (adjust_class_at_definition,
2550 "@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\
2551 been defined. Use this hook to make adjustments to the class (eg, tweak\
2552 visibility or perform any other required target modifications).",
2553 void, (tree type),
2554 hook_void_tree)
2556 DEFHOOK
2557 (decl_mangling_context,
2558 "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
2559 tree, (const_tree decl),
2560 hook_tree_const_tree_null)
2562 HOOK_VECTOR_END (cxx)
2564 /* Functions and data for emulated TLS support. */
2565 #undef HOOK_PREFIX
2566 #define HOOK_PREFIX "TARGET_EMUTLS_"
2567 HOOK_VECTOR (TARGET_EMUTLS, emutls)
2569 /* Name of the address and common functions. */
2570 DEFHOOKPOD
2571 (get_address,
2573 const char *, "__builtin___emutls_get_address")
2575 DEFHOOKPOD
2576 (register_common,
2578 const char *, "__builtin___emutls_register_common")
2580 /* Prefixes for proxy variable and template. */
2581 DEFHOOKPOD
2582 (var_section,
2584 const char *, NULL)
2586 DEFHOOKPOD
2587 (tmpl_section,
2589 const char *, NULL)
2591 /* Prefixes for proxy variable and template. */
2592 DEFHOOKPOD
2593 (var_prefix,
2595 const char *, NULL)
2597 DEFHOOKPOD
2598 (tmpl_prefix,
2600 const char *, NULL)
2602 /* Function to generate field definitions of the proxy variable. */
2603 DEFHOOK
2604 (var_fields,
2606 tree, (tree type, tree *name),
2607 default_emutls_var_fields)
2609 /* Function to initialize a proxy variable. */
2610 DEFHOOK
2611 (var_init,
2613 tree, (tree var, tree decl, tree tmpl_addr),
2614 default_emutls_var_init)
2616 /* Whether we are allowed to alter the usual alignment of the
2617 proxy variable. */
2618 DEFHOOKPOD
2619 (var_align_fixed,
2621 bool, false)
2623 /* Whether we can emit debug information for TLS vars. */
2624 DEFHOOKPOD
2625 (debug_form_tls_address,
2627 bool, false)
2629 HOOK_VECTOR_END (emutls)
2631 #undef HOOK_PREFIX
2632 #define HOOK_PREFIX "TARGET_OPTION_"
2633 HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
2635 /* Function to validate the attribute((option(...))) strings or NULL. If
2636 the option is validated, it is assumed that DECL_FUNCTION_SPECIFIC will
2637 be filled in in the function decl node. */
2638 DEFHOOK
2639 (valid_attribute_p,
2641 bool, (tree fndecl, tree name, tree args, int flags),
2642 default_target_option_valid_attribute_p)
2644 /* Function to save any extra target state in the target options structure. */
2645 DEFHOOK
2646 (save,
2648 void, (struct cl_target_option *ptr), NULL)
2650 /* Function to restore any extra target state from the target options
2651 structure. */
2652 DEFHOOK
2653 (restore,
2655 void, (struct cl_target_option *ptr), NULL)
2657 /* Function to print any extra target state from the target options
2658 structure. */
2659 DEFHOOK
2660 (print,
2662 void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
2664 /* Function to parse arguments to be validated for #pragma option, and to
2665 change the state if the options are valid. If the first argument is
2666 NULL, the second argument specifies the default options to use. Return
2667 true if the options are valid, and set the current state. */
2668 /* ??? The documentation in tm.texi is incomplete. */
2669 DEFHOOK
2670 (pragma_parse,
2672 bool, (tree args, tree pop_target),
2673 default_target_option_pragma_parse)
2675 /* Do option overrides for the target. */
2676 DEFHOOK
2677 (override,
2679 void, (void),
2680 hook_void_void)
2682 /* This function returns true if DECL1 and DECL2 are versions of the same
2683 function. DECL1 and DECL2 are function versions if and only if they
2684 have the same function signature and different target specific attributes,
2685 that is, they are compiled for different target machines. */
2686 DEFHOOK
2687 (function_versions,
2689 bool, (tree decl1, tree decl2),
2690 hook_bool_tree_tree_false)
2692 /* Function to determine if one function can inline another function. */
2693 #undef HOOK_PREFIX
2694 #define HOOK_PREFIX "TARGET_"
2695 DEFHOOK
2696 (can_inline_p,
2698 bool, (tree caller, tree callee),
2699 default_target_can_inline_p)
2701 HOOK_VECTOR_END (target_option)
2703 /* Functions used to simplify GOT access. */
2704 #undef HOOK_PREFIX
2705 #define HOOK_PREFIX "TARGET_"
2706 HOOK_VECTOR (TARGET_SIMPLIFY_GOT_ACCESS, simplify_got_access)
2708 /* Function to get the pic_reg which holds the base address of GOT. */
2709 DEFHOOK
2710 (get_pic_reg,
2711 "Return the pic_reg pseudo register which holds the base address of GOT.\
2712 It is only required by the simplify-got optimization.",
2713 rtx, (void),
2714 hook_rtx_void_null)
2716 /* Function to clear the pic_reg which is useless now. */
2717 DEFHOOK
2718 (clear_pic_reg,
2719 "After successful simplify-got optimization, the pic_reg is useless. So a\
2720 target can use this hook to clear pic_reg.",
2721 void, (void),
2722 NULL)
2724 /* Function to detect if the specified insn loads a global variable's
2725 address from GOT. If so returns that symbol. */
2726 DEFHOOK
2727 (loaded_global_var,
2728 "This hook is used to detect if the given @var{insn} loads a global\
2729 variable's address from GOT with the form of\
2730 @smallexample\
2731 (set @var{address_reg} (mem (plus pic_reg @var{offset_reg})))\
2732 @end smallexample\
2733 If so return the global variable whose address will be loaded and fill in\
2734 @var{offset_insn} and @var{offset_reg}. @var{offset_reg} is set at\
2735 @var{offset_insn} to hold the offset from GOT base to the GOT entry of the\
2736 global variable. Otherwise return @code{NULL_RTX}.",
2737 rtx, (rtx insn, rtx *offset_reg, rtx *offset_insn),
2738 NULL)
2740 /* This function checks if it satisfies the target dependent conditions
2741 that we can simplify GOT accesses. */
2742 DEFHOOK
2743 (can_simplify_got_access,
2744 "This hook determines if it satisfy the target dependent conditions to do\
2745 simplify-got when given the number of global variable accessing and the\
2746 number of accessed symbols. If the returned value is false the GOT access\
2747 insns will not be rewritten. Otherwise we will rewrite these insns.",
2748 bool, (int n_symbol, int n_access),
2749 NULL)
2751 /* This function does the actual rewriting of GOT accesses. */
2752 DEFHOOK
2753 (load_global_address,
2754 "This hook does the actual rewriting of GOT access insn @var{load_insn}.\
2755 The global variable is @var{symbol}. The global address should be loaded\
2756 into @var{address_reg}. The register @var{offset_reg} was previously set\
2757 in insn @var{offset_insn} to hold the offset from GOT base to the GOT\
2758 entry of the global variable. Now it can be used as a scratch register.",
2759 void, (rtx symbol, rtx offset_reg, rtx address_reg, rtx load_insn,
2760 rtx offset_insn),
2761 NULL)
2763 HOOK_VECTOR_END (got_access)
2765 /* For targets that need to mark extra registers as live on entry to
2766 the function, they should define this target hook and set their
2767 bits in the bitmap passed in. */
2768 DEFHOOK
2769 (extra_live_on_entry,
2771 void, (bitmap regs),
2772 hook_void_bitmap)
2774 /* Fill in additional registers set up by prologue into a regset. */
2775 DEFHOOK
2776 (set_up_by_prologue,
2777 "This hook should add additional registers that are computed by the prologue\
2778 to the hard regset for shrink-wrapping optimization purposes.",
2779 void, (struct hard_reg_set_container *),
2780 NULL)
2782 /* Determine the type of unwind info to emit for debugging. */
2783 DEFHOOK
2784 (debug_unwind_info,
2786 enum unwind_info_type, (void),
2787 default_debug_unwind_info)
2789 DEFHOOKPOD
2790 (atomic_test_and_set_trueval,
2791 "This value should be set if the result written by\
2792 @code{atomic_test_and_set} is not exactly 1, i.e. the\
2793 @code{bool} @code{true}.",
2794 unsigned char, 1)
2796 /* Leave the boolean fields at the end. */
2798 /* True if we can create zeroed data by switching to a BSS section
2799 and then using ASM_OUTPUT_SKIP to allocate the space. */
2800 DEFHOOKPOD
2801 (have_switchable_bss_sections,
2803 bool, false)
2805 /* True if "native" constructors and destructors are supported,
2806 false if we're using collect2 for the job. */
2807 DEFHOOKPOD
2808 (have_ctors_dtors,
2810 bool, false)
2812 /* True if thread-local storage is supported. */
2813 DEFHOOKPOD
2814 (have_tls,
2816 bool, false)
2818 /* True if a small readonly data section is supported. */
2819 DEFHOOKPOD
2820 (have_srodata_section,
2822 bool, false)
2824 /* True if EH frame info sections should be zero-terminated. */
2825 DEFHOOKPOD
2826 (terminate_dw2_eh_frame_info,
2828 bool, true)
2830 /* True if #NO_APP should be emitted at the beginning of assembly output. */
2831 DEFHOOKPOD
2832 (asm_file_start_app_off,
2834 bool, false)
2836 /* True if output_file_directive should be called for main_input_filename
2837 at the beginning of assembly output. */
2838 DEFHOOKPOD
2839 (asm_file_start_file_directive,
2841 bool, false)
2843 DEFHOOKPOD
2844 (handle_pragma_extern_prefix,
2845 "True if @code{#pragma extern_prefix} is to be supported.",
2846 bool, 0)
2848 /* True if the target is allowed to reorder memory accesses unless
2849 synchronization is explicitly requested. */
2850 DEFHOOKPOD
2851 (relaxed_ordering,
2853 bool, false)
2855 /* Returns true if we should generate exception tables for use with the
2856 ARM EABI. The effects the encoding of function exception specifications. */
2857 DEFHOOKPOD
2858 (arm_eabi_unwinder,
2860 bool, false)
2862 DEFHOOKPOD
2863 (want_debug_pub_sections,
2864 "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\
2865 should be emitted. These sections are not used on most platforms, and\
2866 in particular GDB does not use them.",
2867 bool, false)
2869 DEFHOOKPOD
2870 (delay_sched2, "True if sched2 is not to be run at its normal place. \
2871 This usually means it will be run as part of machine-specific reorg.",
2872 bool, false)
2874 DEFHOOKPOD
2875 (delay_vartrack, "True if vartrack is not to be run at its normal place. \
2876 This usually means it will be run as part of machine-specific reorg.",
2877 bool, false)
2879 /* Leave the boolean fields at the end. */
2881 /* Close the 'struct gcc_target' definition. */
2882 HOOK_VECTOR_END (C90_EMPTY_HACK)