2012-07-09 Tom de Vries <tom@codesourcery.com>
[official-gcc.git] / gcc / target.def
blob051579ffabeb63dbed4089e7201cd755505f08ee
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 DEFHOOK
431 (output_ident,
432 "Output a string based on @var{name}, suitable for the @samp{#ident} \
433 directive, or the equivalent directive or pragma in non-C-family languages. \
434 If this hook is not defined, nothing is output for the @samp{#ident} \
435 directive.",
436 void, (const char *name),
437 hook_void_constcharptr)
439 /* Output a DTP-relative reference to a TLS symbol. */
440 DEFHOOK
441 (output_dwarf_dtprel,
443 void, (FILE *file, int size, rtx x),
444 NULL)
446 /* Some target machines need to postscan each insn after it is output. */
447 DEFHOOK
448 (final_postscan_insn,
450 void, (FILE *file, rtx insn, rtx *opvec, int noperands),
451 NULL)
453 /* Emit the trampoline template. This hook may be NULL. */
454 DEFHOOK
455 (trampoline_template,
457 void, (FILE *f),
458 NULL)
460 DEFHOOK
461 (output_source_filename,
462 "Output COFF information or DWARF debugging information which indicates\
463 that filename @var{name} is the current source file to the stdio\
464 stream @var{file}.\n\
466 This target hook need not be defined if the standard form of output\
467 for the file format in use is appropriate.",
468 void ,(FILE *file, const char *name),
469 default_asm_output_source_filename)
471 DEFHOOK
472 (output_addr_const_extra,
474 bool, (FILE *file, rtx x),
475 hook_bool_FILEptr_rtx_false)
477 /* ??? The TARGET_PRINT_OPERAND* hooks are part of the asm_out struct,
478 even though that is not reflected in the macro name to override their
479 initializers. */
480 #undef HOOK_PREFIX
481 #define HOOK_PREFIX "TARGET_"
483 /* Emit a machine-specific insn operand. */
484 /* ??? tm.texi only documents the old macro PRINT_OPERAND,
485 not this hook, and uses a different name for the argument FILE. */
486 DEFHOOK_UNDOC
487 (print_operand,
489 void, (FILE *file, rtx x, int code),
490 default_print_operand)
492 /* Emit a machine-specific memory address. */
493 /* ??? tm.texi only documents the old macro PRINT_OPERAND_ADDRESS,
494 not this hook, and uses different argument names. */
495 DEFHOOK_UNDOC
496 (print_operand_address,
498 void, (FILE *file, rtx addr),
499 default_print_operand_address)
501 /* Determine whether CODE is a valid punctuation character for the
502 `print_operand' hook. */
503 /* ??? tm.texi only documents the old macro PRINT_OPERAND_PUNCT_VALID_P,
504 not this hook. */
505 DEFHOOK_UNDOC
506 (print_operand_punct_valid_p,
508 bool ,(unsigned char code),
509 default_print_operand_punct_valid_p)
511 /* Given a symbol name, perform same mangling as assemble_name and
512 ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
513 DEFHOOK
514 (mangle_assembler_name,
515 "Given a symbol @var{name}, perform same mangling as @code{varasm.c}'s\
516 @code{assemble_name}, but in memory rather than to a file stream, returning\
517 result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\
518 default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\
519 then prepends the @code{USER_LABEL_PREFIX}, if any.",
520 tree, (const char *name),
521 default_mangle_assembler_name)
523 HOOK_VECTOR_END (asm_out)
525 /* Functions relating to instruction scheduling. All of these
526 default to null pointers, which haifa-sched.c looks for and handles. */
527 #undef HOOK_PREFIX
528 #define HOOK_PREFIX "TARGET_SCHED_"
529 HOOK_VECTOR (TARGET_SCHED, sched)
531 /* Given the current cost, COST, of an insn, INSN, calculate and
532 return a new cost based on its relationship to DEP_INSN through
533 the dependence LINK. The default is to make no adjustment. */
534 DEFHOOK
535 (adjust_cost,
537 int, (rtx insn, rtx link, rtx dep_insn, int cost), NULL)
539 /* Adjust the priority of an insn as you see fit. Returns the new priority. */
540 DEFHOOK
541 (adjust_priority,
543 int, (rtx insn, int priority), NULL)
545 /* Function which returns the maximum number of insns that can be
546 scheduled in the same machine cycle. This must be constant
547 over an entire compilation. The default is 1. */
548 DEFHOOK
549 (issue_rate,
551 int, (void), NULL)
553 /* Calculate how much this insn affects how many more insns we
554 can emit this cycle. Default is they all cost the same. */
555 DEFHOOK
556 (variable_issue,
558 int, (FILE *file, int verbose, rtx insn, int more), NULL)
560 /* Initialize machine-dependent scheduling code. */
561 DEFHOOK
562 (init,
564 void, (FILE *file, int verbose, int max_ready), NULL)
566 /* Finalize machine-dependent scheduling code. */
567 DEFHOOK
568 (finish,
570 void, (FILE *file, int verbose), NULL)
572 /* Initialize machine-dependent function wide scheduling code. */
573 DEFHOOK
574 (init_global,
576 void, (FILE *file, int verbose, int old_max_uid), NULL)
578 /* Finalize machine-dependent function wide scheduling code. */
579 DEFHOOK
580 (finish_global,
582 void, (FILE *file, int verbose), NULL)
584 /* Reorder insns in a machine-dependent fashion, in two different
585 places. Default does nothing. */
586 DEFHOOK
587 (reorder,
589 int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL)
591 DEFHOOK
592 (reorder2,
594 int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL)
596 /* The following member value is a pointer to a function called
597 after evaluation forward dependencies of insns in chain given
598 by two parameter values (head and tail correspondingly). */
599 DEFHOOK
600 (dependencies_evaluation_hook,
602 void, (rtx head, rtx tail), NULL)
604 /* The values of the following four members are pointers to functions
605 used to simplify the automaton descriptions. dfa_pre_cycle_insn and
606 dfa_post_cycle_insn give functions returning insns which are used to
607 change the pipeline hazard recognizer state when the new simulated
608 processor cycle correspondingly starts and finishes. The function
609 defined by init_dfa_pre_cycle_insn and init_dfa_post_cycle_insn are
610 used to initialize the corresponding insns. The default values of
611 the members result in not changing the automaton state when the
612 new simulated processor cycle correspondingly starts and finishes. */
614 DEFHOOK
615 (init_dfa_pre_cycle_insn,
617 void, (void), NULL)
619 DEFHOOK
620 (dfa_pre_cycle_insn,
622 rtx, (void), NULL)
624 DEFHOOK
625 (init_dfa_post_cycle_insn,
627 void, (void), NULL)
629 DEFHOOK
630 (dfa_post_cycle_insn,
632 rtx, (void), NULL)
634 /* The values of the following two members are pointers to
635 functions used to simplify the automaton descriptions.
636 dfa_pre_advance_cycle and dfa_post_advance_cycle are getting called
637 immediately before and after cycle is advanced. */
639 DEFHOOK
640 (dfa_pre_advance_cycle,
642 void, (void), NULL)
644 DEFHOOK
645 (dfa_post_advance_cycle,
647 void, (void), NULL)
649 /* The following member value is a pointer to a function returning value
650 which defines how many insns in queue `ready' will we try for
651 multi-pass scheduling. If the member value is nonzero and the
652 function returns positive value, the DFA based scheduler will make
653 multi-pass scheduling for the first cycle. In other words, we will
654 try to choose ready insn which permits to start maximum number of
655 insns on the same cycle. */
656 DEFHOOK
657 (first_cycle_multipass_dfa_lookahead,
659 int, (void), NULL)
661 /* The following member value is pointer to a function controlling
662 what insns from the ready insn queue will be considered for the
663 multipass insn scheduling. If the hook returns zero for insn
664 passed as the parameter, the insn will be not chosen to be issued. */
665 DEFHOOK
666 (first_cycle_multipass_dfa_lookahead_guard,
668 int, (rtx insn), NULL)
670 /* This hook prepares the target for a new round of multipass
671 scheduling.
672 DATA is a pointer to target-specific data used for multipass scheduling.
673 READY_TRY and N_READY represent the current state of search in the
674 optimization space. The target can filter out instructions that
675 should not be tried during current round by setting corresponding
676 elements in READY_TRY to non-zero.
677 FIRST_CYCLE_INSN_P is true if this is the first round of multipass
678 scheduling on current cycle. */
679 DEFHOOK
680 (first_cycle_multipass_begin,
682 void, (void *data, char *ready_try, int n_ready, bool first_cycle_insn_p),
683 NULL)
685 /* This hook is called when multipass scheduling evaluates instruction INSN.
686 DATA is a pointer to target-specific data that can be used to record effects
687 of INSN on CPU that are not described in DFA.
688 READY_TRY and N_READY represent the current state of search in the
689 optimization space. The target can filter out instructions that
690 should not be tried after issuing INSN by setting corresponding
691 elements in READY_TRY to non-zero.
692 INSN is the instruction being evaluated.
693 PREV_DATA is a pointer to target-specific data corresponding
694 to a state before issuing INSN. */
695 DEFHOOK
696 (first_cycle_multipass_issue,
698 void, (void *data, char *ready_try, int n_ready, rtx insn,
699 const void *prev_data), NULL)
701 /* This hook is called when multipass scheduling backtracks from evaluation of
702 instruction corresponding to DATA.
703 DATA is a pointer to target-specific data that stores the effects
704 of instruction from which the algorithm backtracks on CPU that are not
705 described in DFA.
706 READY_TRY and N_READY represent the current state of search in the
707 optimization space. The target can filter out instructions that
708 should not be tried after issuing INSN by setting corresponding
709 elements in READY_TRY to non-zero. */
710 DEFHOOK
711 (first_cycle_multipass_backtrack,
713 void, (const void *data, char *ready_try, int n_ready), NULL)
715 /* This hook notifies the target about the result of the concluded current
716 round of multipass scheduling.
717 DATA is a pointer.
718 If DATA is non-NULL it points to target-specific data used for multipass
719 scheduling which corresponds to instruction at the start of the chain of
720 the winning solution. DATA is NULL when multipass scheduling cannot find
721 a good enough solution on current cycle and decides to retry later,
722 usually after advancing the cycle count. */
723 DEFHOOK
724 (first_cycle_multipass_end,
726 void, (const void *data), NULL)
728 /* This hook is called to initialize target-specific data for multipass
729 scheduling after it has been allocated.
730 DATA is a pointer to target-specific data that stores the effects
731 of instruction from which the algorithm backtracks on CPU that are not
732 described in DFA. */
733 DEFHOOK
734 (first_cycle_multipass_init,
736 void, (void *data), NULL)
738 /* This hook is called to finalize target-specific data for multipass
739 scheduling before it is deallocated.
740 DATA is a pointer to target-specific data that stores the effects
741 of instruction from which the algorithm backtracks on CPU that are not
742 described in DFA. */
743 DEFHOOK
744 (first_cycle_multipass_fini,
746 void, (void *data), NULL)
748 /* The following member value is pointer to a function called by
749 the insn scheduler before issuing insn passed as the third
750 parameter on given cycle. If the hook returns nonzero, the
751 insn is not issued on given processors cycle. Instead of that,
752 the processor cycle is advanced. If the value passed through
753 the last parameter is zero, the insn ready queue is not sorted
754 on the new cycle start as usually. The first parameter passes
755 file for debugging output. The second one passes the scheduler
756 verbose level of the debugging output. The forth and the fifth
757 parameter values are correspondingly processor cycle on which
758 the previous insn has been issued and the current processor cycle. */
759 DEFHOOK
760 (dfa_new_cycle,
762 int, (FILE *dump, int verbose, rtx insn, int last_clock,
763 int clock, int *sort_p),
764 NULL)
766 /* The following member value is a pointer to a function called by the
767 insn scheduler. It should return true if there exists a dependence
768 which is considered costly by the target, between the insn
769 DEP_PRO (&_DEP), and the insn DEP_CON (&_DEP). The first parameter is
770 the dep that represents the dependence between the two insns. The
771 second argument is the cost of the dependence as estimated by
772 the scheduler. The last argument is the distance in cycles
773 between the already scheduled insn (first parameter) and the
774 second insn (second parameter). */
775 DEFHOOK
776 (is_costly_dependence,
778 bool, (struct _dep *_dep, int cost, int distance), NULL)
780 DEFHOOK_UNDOC
781 (adjust_cost_2,
782 "Given the current cost, @var{cost}, of an insn, @var{insn}, calculate and\
783 return a new cost based on its relationship to @var{dep_insn} through the\
784 dependence of weakness @var{dw}. The default is to make no adjustment.",
785 int, (rtx insn, int dep_type1, rtx dep_insn, int cost, int dw), NULL)
787 /* The following member value is a pointer to a function called
788 by the insn scheduler. This hook is called to notify the backend
789 that new instructions were emitted. */
790 DEFHOOK
791 (h_i_d_extended,
793 void, (void), NULL)
795 /* Next 5 functions are for multi-point scheduling. */
797 /* Allocate memory for scheduler context. */
798 DEFHOOK
799 (alloc_sched_context,
801 void *, (void), NULL)
803 /* Fills the context from the local machine scheduler context. */
804 DEFHOOK
805 (init_sched_context,
807 void, (void *tc, bool clean_p), NULL)
809 /* Sets local machine scheduler context to a saved value. */
810 DEFHOOK
811 (set_sched_context,
813 void, (void *tc), NULL)
815 /* Clears a scheduler context so it becomes like after init. */
816 DEFHOOK
817 (clear_sched_context,
819 void, (void *tc), NULL)
821 /* Frees the scheduler context. */
822 DEFHOOK
823 (free_sched_context,
825 void, (void *tc), NULL)
827 /* The following member value is a pointer to a function called
828 by the insn scheduler.
829 The first parameter is an instruction, the second parameter is the type
830 of the requested speculation, and the third parameter is a pointer to the
831 speculative pattern of the corresponding type (set if return value == 1).
832 It should return
833 -1, if there is no pattern, that will satisfy the requested speculation type,
834 0, if current pattern satisfies the requested speculation type,
835 1, if pattern of the instruction should be changed to the newly
836 generated one. */
837 DEFHOOK
838 (speculate_insn,
840 int, (rtx insn, int request, rtx *new_pat), NULL)
842 /* The following member value is a pointer to a function called
843 by the insn scheduler. It should return true if the check instruction
844 passed as the parameter needs a recovery block. */
845 DEFHOOK
846 (needs_block_p,
848 bool, (int dep_status), NULL)
850 /* The following member value is a pointer to a function called
851 by the insn scheduler. It should return a pattern for the check
852 instruction.
853 The first parameter is a speculative instruction, the second parameter
854 is the label of the corresponding recovery block (or null, if it is a
855 simple check). If the mutation of the check is requested (e.g. from
856 ld.c to chk.a), the third parameter is true - in this case the first
857 parameter is the previous check. */
858 DEFHOOK
859 (gen_spec_check,
861 rtx, (rtx insn, rtx label, int mutate_p), NULL)
863 /* The following member value is a pointer to a function controlling
864 what insns from the ready insn queue will be considered for the
865 multipass insn scheduling. If the hook returns zero for the insn
866 passed as the parameter, the insn will not be chosen to be
867 issued. This hook is used to discard speculative instructions,
868 that stand at the first position of the ready list. */
869 DEFHOOK
870 (first_cycle_multipass_dfa_lookahead_guard_spec,
872 bool, (const_rtx insn), NULL)
874 /* The following member value is a pointer to a function that provides
875 information about the speculation capabilities of the target.
876 The parameter is a pointer to spec_info variable. */
877 DEFHOOK
878 (set_sched_flags,
880 void, (struct spec_info_def *spec_info), NULL)
882 DEFHOOK_UNDOC
883 (get_insn_spec_ds,
884 "Return speculation types of instruction @var{insn}.",
885 int, (rtx insn), NULL)
887 DEFHOOK_UNDOC
888 (get_insn_checked_ds,
889 "Return speculation types that are checked for instruction @var{insn}",
890 int, (rtx insn), NULL)
892 DEFHOOK_UNDOC
893 (skip_rtx_p,
894 "Return bool if rtx scanning should just skip current layer and\
895 advance to the inner rtxes.",
896 bool, (const_rtx x), NULL)
898 /* The following member value is a pointer to a function that provides
899 information about the target resource-based lower bound which is
900 used by the swing modulo scheduler. The parameter is a pointer
901 to ddg variable. */
902 DEFHOOK
903 (sms_res_mii,
905 int, (struct ddg *g), NULL)
907 /* The following member value is a function that initializes dispatch
908 schedling and adds instructions to dispatch window according to its
909 parameters. */
910 DEFHOOK
911 (dispatch_do,
913 void, (rtx insn, int x),
914 hook_void_rtx_int)
916 /* The following member value is a a function that returns true is
917 dispatch schedling is supported in hardware and condition passed
918 as the second parameter is true. */
919 DEFHOOK
920 (dispatch,
922 bool, (rtx insn, int x),
923 hook_bool_rtx_int_false)
925 DEFHOOKPOD
926 (exposed_pipeline,
927 "True if the processor has an exposed pipeline, which means that not just\n\
928 the order of instructions is important for correctness when scheduling, but\n\
929 also the latencies of operations.",
930 bool, false)
932 /* The following member value is a function that returns number
933 of operations reassociator should try to put in parallel for
934 statements of the given type. By default 1 is used. */
935 DEFHOOK
936 (reassociation_width,
937 "This hook is called by tree reassociator to determine a level of\n\
938 parallelism required in output calculations chain.",
939 int, (unsigned int opc, enum machine_mode mode),
940 hook_int_uint_mode_1)
942 HOOK_VECTOR_END (sched)
944 /* Functions relating to vectorization. */
945 #undef HOOK_PREFIX
946 #define HOOK_PREFIX "TARGET_VECTORIZE_"
947 HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
949 /* The following member value is a pointer to a function called
950 by the vectorizer, and return the decl of the target builtin
951 function. */
952 DEFHOOK
953 (builtin_mask_for_load,
955 tree, (void), NULL)
957 /* Returns a code for builtin that realizes vectorized version of
958 function, or NULL_TREE if not available. */
959 DEFHOOK
960 (builtin_vectorized_function,
962 tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
963 default_builtin_vectorized_function)
965 /* Returns a function declaration for a builtin that realizes the
966 vector conversion, or NULL_TREE if not available. */
967 DEFHOOK
968 (builtin_conversion,
970 tree, (unsigned code, tree dest_type, tree src_type),
971 default_builtin_vectorized_conversion)
973 /* Target builtin that implements vector widening multiplication.
974 builtin_mul_widen_eve computes the element-by-element products
975 for the even elements, and builtin_mul_widen_odd computes the
976 element-by-element products for the odd elements. */
977 DEFHOOK
978 (builtin_mul_widen_even,
980 tree, (tree x), NULL)
982 DEFHOOK
983 (builtin_mul_widen_odd,
985 tree, (tree x), NULL)
987 /* Cost of different vector/scalar statements in vectorization cost
988 model. In case of misaligned vector loads and stores the cost depends
989 on the data type and misalignment value. */
990 DEFHOOK
991 (builtin_vectorization_cost,
993 int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
994 default_builtin_vectorization_cost)
996 /* Return true if vector alignment is reachable (by peeling N
997 iterations) for the given type. */
998 DEFHOOK
999 (vector_alignment_reachable,
1001 bool, (const_tree type, bool is_packed),
1002 default_builtin_vector_alignment_reachable)
1004 /* Return true if a vector created for vec_perm_const is valid.
1005 A NULL indicates that all constants are valid permutations. */
1006 DEFHOOK
1007 (vec_perm_const_ok,
1009 bool, (enum machine_mode, const unsigned char *sel),
1010 NULL)
1012 /* Return true if the target supports misaligned store/load of a
1013 specific factor denoted in the third parameter. The last parameter
1014 is true if the access is defined in a packed struct. */
1015 DEFHOOK
1016 (support_vector_misalignment,
1018 bool,
1019 (enum machine_mode mode, const_tree type, int misalignment, bool is_packed),
1020 default_builtin_support_vector_misalignment)
1022 /* Return the builtin decl needed to load a vector of TYPE. */
1023 DEFHOOK
1024 (builtin_tm_load,
1025 "This hook should return the built-in decl needed to load a vector of the "
1026 "given type within a transaction.",
1027 tree,
1028 (tree),
1029 default_builtin_tm_load_store)
1031 /* Return the builtin decl needed to store a vector of TYPE. */
1032 DEFHOOK
1033 (builtin_tm_store,
1034 "This hook should return the built-in decl needed to store a vector of the "
1035 "given type within a transaction.",
1036 tree,
1037 (tree),
1038 default_builtin_tm_load_store)
1040 /* Returns the preferred mode for SIMD operations for the specified
1041 scalar mode. */
1042 DEFHOOK
1043 (preferred_simd_mode,
1045 enum machine_mode,
1046 (enum machine_mode mode),
1047 default_preferred_simd_mode)
1049 /* Returns a mask of vector sizes to iterate over when auto-vectorizing
1050 after processing the preferred one derived from preferred_simd_mode. */
1051 DEFHOOK
1052 (autovectorize_vector_sizes,
1054 unsigned int,
1055 (void),
1056 default_autovectorize_vector_sizes)
1058 /* Target builtin that implements vector gather operation. */
1059 DEFHOOK
1060 (builtin_gather,
1062 tree,
1063 (const_tree mem_vectype, const_tree index_type, int scale),
1064 NULL)
1066 HOOK_VECTOR_END (vectorize)
1068 #undef HOOK_PREFIX
1069 #define HOOK_PREFIX "TARGET_"
1071 /* Allow target specific overriding of option settings after options have
1072 been changed by an attribute or pragma or when it is reset at the
1073 end of the code affected by an attribute or pragma. */
1074 DEFHOOK
1075 (override_options_after_change,
1077 void, (void),
1078 hook_void_void)
1080 DEFHOOK_UNDOC
1081 (eh_return_filter_mode,
1082 "Return machine mode for filter value.",
1083 enum machine_mode, (void),
1084 default_eh_return_filter_mode)
1086 /* Return machine mode for libgcc expanded cmp instructions. */
1087 DEFHOOK
1088 (libgcc_cmp_return_mode,
1090 enum machine_mode, (void),
1091 default_libgcc_cmp_return_mode)
1093 /* Return machine mode for libgcc expanded shift instructions. */
1094 DEFHOOK
1095 (libgcc_shift_count_mode,
1097 enum machine_mode, (void),
1098 default_libgcc_shift_count_mode)
1100 /* Return machine mode to be used for _Unwind_Word type. */
1101 DEFHOOK
1102 (unwind_word_mode,
1104 enum machine_mode, (void),
1105 default_unwind_word_mode)
1107 /* Given two decls, merge their attributes and return the result. */
1108 DEFHOOK
1109 (merge_decl_attributes,
1111 tree, (tree olddecl, tree newdecl),
1112 merge_decl_attributes)
1114 /* Given two types, merge their attributes and return the result. */
1115 DEFHOOK
1116 (merge_type_attributes,
1118 tree, (tree type1, tree type2),
1119 merge_type_attributes)
1121 /* Table of machine attributes and functions to handle them.
1122 Ignored if NULL. */
1123 DEFHOOKPOD
1124 (attribute_table,
1126 const struct attribute_spec *, NULL)
1128 /* Return true iff attribute NAME expects a plain identifier as its first
1129 argument. */
1130 DEFHOOK
1131 (attribute_takes_identifier_p,
1133 bool, (const_tree name),
1134 hook_bool_const_tree_false)
1136 /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible,
1137 one if they are compatible and two if they are nearly compatible
1138 (which causes a warning to be generated). */
1139 DEFHOOK
1140 (comp_type_attributes,
1142 int, (const_tree type1, const_tree type2),
1143 hook_int_const_tree_const_tree_1)
1145 /* Assign default attributes to the newly defined TYPE. */
1146 DEFHOOK
1147 (set_default_type_attributes,
1149 void, (tree type),
1150 hook_void_tree)
1152 /* Insert attributes on the newly created DECL. */
1153 DEFHOOK
1154 (insert_attributes,
1156 void, (tree node, tree *attr_ptr),
1157 hook_void_tree_treeptr)
1159 /* Return true if FNDECL (which has at least one machine attribute)
1160 can be inlined despite its machine attributes, false otherwise. */
1161 DEFHOOK
1162 (function_attribute_inlinable_p,
1164 bool, (const_tree fndecl),
1165 hook_bool_const_tree_false)
1167 /* Return true if bitfields in RECORD_TYPE should follow the
1168 Microsoft Visual C++ bitfield layout rules. */
1169 DEFHOOK
1170 (ms_bitfield_layout_p,
1172 bool, (const_tree record_type),
1173 hook_bool_const_tree_false)
1175 /* For now this is only an interface to WORDS_BIG_ENDIAN for
1176 target-independent code like the front ends, need performance testing
1177 before switching completely to the target hook. */
1178 DEFHOOK_UNDOC
1179 (words_big_endian,
1181 bool, (void),
1182 targhook_words_big_endian)
1184 /* Likewise for FLOAT_WORDS_BIG_ENDIAN. */
1185 DEFHOOK_UNDOC
1186 (float_words_big_endian,
1188 bool, (void),
1189 targhook_float_words_big_endian)
1191 /* True if the target supports decimal floating point. */
1192 DEFHOOK
1193 (decimal_float_supported_p,
1195 bool, (void),
1196 default_decimal_float_supported_p)
1198 /* True if the target supports fixed-point. */
1199 DEFHOOK
1200 (fixed_point_supported_p,
1202 bool, (void),
1203 default_fixed_point_supported_p)
1205 /* Return true if anonymous bitfields affect structure alignment. */
1206 DEFHOOK
1207 (align_anon_bitfield,
1209 bool, (void),
1210 hook_bool_void_false)
1212 /* Return true if volatile bitfields should use the narrowest type possible.
1213 Return false if they should use the container type. */
1214 DEFHOOK
1215 (narrow_volatile_bitfield,
1217 bool, (void),
1218 hook_bool_void_false)
1220 /* Set up target-specific built-in functions. */
1221 DEFHOOK
1222 (init_builtins,
1224 void, (void),
1225 hook_void_void)
1227 /* Initialize (if INITIALIZE_P is true) and return the target-specific
1228 built-in function decl for CODE.
1229 Return NULL if that is not possible. Return error_mark_node if CODE
1230 is outside of the range of valid target builtin function codes. */
1231 DEFHOOK
1232 (builtin_decl,
1234 tree, (unsigned code, bool initialize_p), NULL)
1236 /* Expand a target-specific builtin. */
1237 DEFHOOK
1238 (expand_builtin,
1240 rtx,
1241 (tree exp, rtx target, rtx subtarget, enum machine_mode mode, int ignore),
1242 default_expand_builtin)
1244 /* Select a replacement for a target-specific builtin. This is done
1245 *before* regular type checking, and so allows the target to
1246 implement a crude form of function overloading. The result is a
1247 complete expression that implements the operation. PARAMS really
1248 has type VEC(tree,gc)*, but we don't want to include tree.h here. */
1249 DEFHOOK
1250 (resolve_overloaded_builtin,
1252 tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
1254 /* Fold a target-specific builtin. */
1255 DEFHOOK
1256 (fold_builtin,
1258 tree, (tree fndecl, int n_args, tree *argp, bool ignore),
1259 hook_tree_tree_int_treep_bool_null)
1261 /* Returns a code for a target-specific builtin that implements
1262 reciprocal of the function, or NULL_TREE if not available. */
1263 DEFHOOK
1264 (builtin_reciprocal,
1266 tree, (unsigned fn, bool md_fn, bool sqrt),
1267 default_builtin_reciprocal)
1269 /* For a vendor-specific TYPE, return a pointer to a statically-allocated
1270 string containing the C++ mangling for TYPE. In all other cases, return
1271 NULL. */
1272 DEFHOOK
1273 (mangle_type,
1275 const char *, (const_tree type),
1276 hook_constcharptr_const_tree_null)
1278 /* Make any adjustments to libfunc names needed for this target. */
1279 DEFHOOK
1280 (init_libfuncs,
1282 void, (void),
1283 hook_void_void)
1285 /* Add a __gnu_ prefix to library functions rather than just __. */
1286 DEFHOOKPOD
1287 (libfunc_gnu_prefix,
1288 "If false (the default), internal library routines start with two\n\
1289 underscores. If set to true, these routines start with @code{__gnu_}\n\
1290 instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
1291 currently only affects functions defined in @file{libgcc2.c}. If this\n\
1292 is set to true, the @file{tm.h} file must also\n\
1293 @code{#define LIBGCC2_GNU_PREFIX}.",
1294 bool, false)
1296 /* Given a decl, a section name, and whether the decl initializer
1297 has relocs, choose attributes for the section. */
1298 /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
1299 DEFHOOK
1300 (section_type_flags,
1302 unsigned int, (tree decl, const char *name, int reloc),
1303 default_section_type_flags)
1305 /* True if new jumps cannot be created, to replace existing ones or
1306 not, at the current point in the compilation. */
1307 DEFHOOK
1308 (cannot_modify_jumps_p,
1310 bool, (void),
1311 hook_bool_void_false)
1313 /* Return a register class for which branch target register
1314 optimizations should be applied. */
1315 DEFHOOK
1316 (branch_target_register_class,
1318 reg_class_t, (void),
1319 default_branch_target_register_class)
1321 /* Return true if branch target register optimizations should include
1322 callee-saved registers that are not already live during the current
1323 function. AFTER_PE_GEN is true if prologues and epilogues have
1324 already been generated. */
1325 DEFHOOK
1326 (branch_target_register_callee_saved,
1328 bool, (bool after_prologue_epilogue_gen),
1329 hook_bool_bool_false)
1331 /* Return true if the target supports conditional execution. */
1332 DEFHOOK
1333 (have_conditional_execution,
1335 bool, (void),
1336 default_have_conditional_execution)
1338 /* Return a new value for loop unroll size. */
1339 DEFHOOK
1340 (loop_unroll_adjust,
1342 unsigned, (unsigned nunroll, struct loop *loop),
1343 NULL)
1345 /* True if X is a legitimate MODE-mode immediate operand. */
1346 DEFHOOK
1347 (legitimate_constant_p,
1349 bool, (enum machine_mode mode, rtx x),
1350 hook_bool_mode_rtx_true)
1352 /* True if the constant X cannot be placed in the constant pool. */
1353 DEFHOOK
1354 (cannot_force_const_mem,
1356 bool, (enum machine_mode mode, rtx x),
1357 hook_bool_mode_rtx_false)
1359 DEFHOOK_UNDOC
1360 (cannot_copy_insn_p,
1361 "True if the insn @var{x} cannot be duplicated.",
1362 bool, (rtx), NULL)
1364 /* True if X is considered to be commutative. */
1365 DEFHOOK
1366 (commutative_p,
1368 bool, (const_rtx x, int outer_code),
1369 hook_bool_const_rtx_commutative_p)
1371 /* True if ADDR is an address-expression whose effect depends
1372 on the mode of the memory reference it is used in. */
1373 DEFHOOK
1374 (mode_dependent_address_p,
1376 bool, (const_rtx addr),
1377 default_mode_dependent_address_p)
1379 /* Given an invalid address X for a given machine mode, try machine-specific
1380 ways to make it legitimate. Return X or an invalid address on failure. */
1381 DEFHOOK
1382 (legitimize_address,
1384 rtx, (rtx x, rtx oldx, enum machine_mode mode),
1385 default_legitimize_address)
1387 /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS. */
1388 DEFHOOK
1389 (delegitimize_address,
1391 rtx, (rtx x),
1392 delegitimize_mem_from_attrs)
1394 /* Given an RTX, return true if it is not ok to emit it into debug info
1395 section. */
1396 DEFHOOK
1397 (const_not_ok_for_debug_p,
1399 bool, (rtx x),
1400 hook_bool_rtx_false)
1402 /* Given an address RTX, say whether it is valid. */
1403 DEFHOOK
1404 (legitimate_address_p,
1406 bool, (enum machine_mode mode, rtx x, bool strict),
1407 default_legitimate_address_p)
1409 /* True if the given constant can be put into an object_block. */
1410 DEFHOOK
1411 (use_blocks_for_constant_p,
1413 bool, (enum machine_mode mode, const_rtx x),
1414 hook_bool_mode_const_rtx_false)
1416 /* The minimum and maximum byte offsets for anchored addresses. */
1417 DEFHOOKPOD
1418 (min_anchor_offset,
1420 HOST_WIDE_INT, 0)
1422 DEFHOOKPOD
1423 (max_anchor_offset,
1425 HOST_WIDE_INT, 0)
1427 /* True if section anchors can be used to access the given symbol. */
1428 DEFHOOK
1429 (use_anchors_for_symbol_p,
1431 bool, (const_rtx x),
1432 default_use_anchors_for_symbol_p)
1434 /* True if it is OK to do sibling call optimization for the specified
1435 call expression EXP. DECL will be the called function, or NULL if
1436 this is an indirect call. */
1437 DEFHOOK
1438 (function_ok_for_sibcall,
1440 bool, (tree decl, tree exp),
1441 hook_bool_tree_tree_false)
1443 /* Establish appropriate back-end context for processing the function
1444 FNDECL. The argument might be NULL to indicate processing at top
1445 level, outside of any function scope. */
1446 DEFHOOK
1447 (set_current_function,
1449 void, (tree decl), hook_void_tree)
1451 /* True if EXP should be placed in a "small data" section. */
1452 DEFHOOK
1453 (in_small_data_p,
1455 bool, (const_tree exp),
1456 hook_bool_const_tree_false)
1458 /* True if EXP names an object for which name resolution must resolve
1459 to the current executable or shared library. */
1460 DEFHOOK
1461 (binds_local_p,
1463 bool, (const_tree exp),
1464 default_binds_local_p)
1466 /* Check if profiling code is before or after prologue. */
1467 DEFHOOK
1468 (profile_before_prologue,
1469 "It returns true if target wants profile code emitted before prologue.\n\n\
1470 The default version of this hook use the target macro\n\
1471 @code{PROFILE_BEFORE_PROLOGUE}.",
1472 bool, (void),
1473 default_profile_before_prologue)
1475 /* Modify and return the identifier of a DECL's external name,
1476 originally identified by ID, as required by the target,
1477 (eg, append @nn to windows32 stdcall function names).
1478 The default is to return ID without modification. */
1479 DEFHOOK
1480 (mangle_decl_assembler_name,
1482 tree, (tree decl, tree id),
1483 default_mangle_decl_assembler_name)
1485 /* Do something target-specific to record properties of the DECL into
1486 the associated SYMBOL_REF. */
1487 DEFHOOK
1488 (encode_section_info,
1490 void, (tree decl, rtx rtl, int new_decl_p),
1491 default_encode_section_info)
1493 /* Undo the effects of encode_section_info on the symbol string. */
1494 DEFHOOK
1495 (strip_name_encoding,
1497 const char *, (const char *name),
1498 default_strip_name_encoding)
1500 /* If shift optabs for MODE are known to always truncate the shift count,
1501 return the mask that they apply. Return 0 otherwise. */
1502 DEFHOOK
1503 (shift_truncation_mask,
1505 unsigned HOST_WIDE_INT, (enum machine_mode mode),
1506 default_shift_truncation_mask)
1508 /* Return the number of divisions in the given MODE that should be present,
1509 so that it is profitable to turn the division into a multiplication by
1510 the reciprocal. */
1511 DEFHOOK
1512 (min_divisions_for_recip_mul,
1514 unsigned int, (enum machine_mode mode),
1515 default_min_divisions_for_recip_mul)
1517 /* If the representation of integral MODE is such that values are
1518 always sign-extended to a wider mode MODE_REP then return
1519 SIGN_EXTEND. Return UNKNOWN otherwise. */
1520 /* Note that the return type ought to be RTX_CODE, but that's not
1521 necessarily defined at this point. */
1522 DEFHOOK
1523 (mode_rep_extended,
1525 int, (enum machine_mode mode, enum machine_mode rep_mode),
1526 default_mode_rep_extended)
1528 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))). */
1529 DEFHOOK
1530 (valid_pointer_mode,
1532 bool, (enum machine_mode mode),
1533 default_valid_pointer_mode)
1535 /* Disambiguate with errno. */
1536 DEFHOOK
1537 (ref_may_alias_errno,
1538 "Define this to return nonzero if the memory reference @var{ref}\
1539 may alias with the system C library errno location. The default\
1540 version of this hook assumes the system C library errno location\
1541 is either a declaration of type int or accessed by dereferencing\
1542 a pointer to int.",
1543 bool, (struct ao_ref_s *ref),
1544 default_ref_may_alias_errno)
1546 /* Support for named address spaces. */
1547 #undef HOOK_PREFIX
1548 #define HOOK_PREFIX "TARGET_ADDR_SPACE_"
1549 HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
1551 /* MODE to use for a pointer into another address space. */
1552 DEFHOOK
1553 (pointer_mode,
1555 enum machine_mode, (addr_space_t address_space),
1556 default_addr_space_pointer_mode)
1558 /* MODE to use for an address in another address space. */
1559 DEFHOOK
1560 (address_mode,
1562 enum machine_mode, (addr_space_t address_space),
1563 default_addr_space_address_mode)
1565 /* True if MODE is valid for a pointer in __attribute__((mode("MODE")))
1566 in another address space. */
1567 DEFHOOK
1568 (valid_pointer_mode,
1570 bool, (enum machine_mode mode, addr_space_t as),
1571 default_addr_space_valid_pointer_mode)
1573 /* True if an address is a valid memory address to a given named address
1574 space for a given mode. */
1575 DEFHOOK
1576 (legitimate_address_p,
1578 bool, (enum machine_mode mode, rtx exp, bool strict, addr_space_t as),
1579 default_addr_space_legitimate_address_p)
1581 /* Return an updated address to convert an invalid pointer to a named
1582 address space to a valid one. If NULL_RTX is returned use machine
1583 independent methods to make the address valid. */
1584 DEFHOOK
1585 (legitimize_address,
1587 rtx, (rtx x, rtx oldx, enum machine_mode mode, addr_space_t as),
1588 default_addr_space_legitimize_address)
1590 /* True if one named address space is a subset of another named address. */
1591 DEFHOOK
1592 (subset_p,
1594 bool, (addr_space_t subset, addr_space_t superset),
1595 default_addr_space_subset_p)
1597 /* Function to convert an rtl expression from one address space to another. */
1598 DEFHOOK
1599 (convert,
1601 rtx, (rtx op, tree from_type, tree to_type),
1602 default_addr_space_convert)
1604 HOOK_VECTOR_END (addr_space)
1606 #undef HOOK_PREFIX
1607 #define HOOK_PREFIX "TARGET_"
1609 /* True if MODE is valid for the target. By "valid", we mean able to
1610 be manipulated in non-trivial ways. In particular, this means all
1611 the arithmetic is supported. */
1612 DEFHOOK
1613 (scalar_mode_supported_p,
1615 bool, (enum machine_mode mode),
1616 default_scalar_mode_supported_p)
1618 /* Similarly for vector modes. "Supported" here is less strict. At
1619 least some operations are supported; need to check optabs or builtins
1620 for further details. */
1621 DEFHOOK
1622 (vector_mode_supported_p,
1624 bool, (enum machine_mode mode),
1625 hook_bool_mode_false)
1627 /* True if we should try to use a scalar mode to represent an array,
1628 overriding the usual MAX_FIXED_MODE limit. */
1629 DEFHOOK
1630 (array_mode_supported_p,
1631 "Return true if GCC should try to use a scalar mode to store an array\n\
1632 of @var{nelems} elements, given that each element has mode @var{mode}.\n\
1633 Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
1634 and allows GCC to use any defined integer mode.\n\
1636 One use of this hook is to support vector load and store operations\n\
1637 that operate on several homogeneous vectors. For example, ARM NEON\n\
1638 has operations like:\n\
1640 @smallexample\n\
1641 int8x8x3_t vld3_s8 (const int8_t *)\n\
1642 @end smallexample\n\
1644 where the return type is defined as:\n\
1646 @smallexample\n\
1647 typedef struct int8x8x3_t\n\
1648 @{\n\
1649 int8x8_t val[3];\n\
1650 @} int8x8x3_t;\n\
1651 @end smallexample\n\
1653 If this hook allows @code{val} to have a scalar mode, then\n\
1654 @code{int8x8x3_t} can have the same mode. GCC can then store\n\
1655 @code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
1656 bool, (enum machine_mode mode, unsigned HOST_WIDE_INT nelems),
1657 hook_bool_mode_uhwi_false)
1659 /* Compute cost of moving data from a register of class FROM to one of
1660 TO, using MODE. */
1661 DEFHOOK
1662 (register_move_cost,
1664 int, (enum machine_mode mode, reg_class_t from, reg_class_t to),
1665 default_register_move_cost)
1667 /* Compute cost of moving registers to/from memory. */
1668 /* ??? Documenting the argument types for this hook requires a GFDL
1669 license grant. Also, the documentation uses a different name for RCLASS. */
1670 DEFHOOK
1671 (memory_move_cost,
1673 int, (enum machine_mode mode, reg_class_t rclass, bool in),
1674 default_memory_move_cost)
1676 /* True for MODE if the target expects that registers in this mode will
1677 be allocated to registers in a small register class. The compiler is
1678 allowed to use registers explicitly used in the rtl as spill registers
1679 but it should prevent extending the lifetime of these registers. */
1680 DEFHOOK
1681 (small_register_classes_for_mode_p,
1683 bool, (enum machine_mode mode),
1684 hook_bool_mode_false)
1686 /* Register number for a flags register. Only needs to be defined if the
1687 target is constrainted to use post-reload comparison elimination. */
1688 DEFHOOKPOD
1689 (flags_regnum,
1690 "If the target has a dedicated flags register, and it needs to use the\
1691 post-reload comparison elimination pass, then this value should be set\
1692 appropriately.",
1693 unsigned int, INVALID_REGNUM)
1695 /* Compute a (partial) cost for rtx X. Return true if the complete
1696 cost has been computed, and false if subexpressions should be
1697 scanned. In either case, *TOTAL contains the cost result. */
1698 /* Note that CODE and OUTER_CODE ought to be RTX_CODE, but that's
1699 not necessarily defined at this point. */
1700 DEFHOOK
1701 (rtx_costs,
1703 bool, (rtx x, int code, int outer_code, int opno, int *total, bool speed),
1704 hook_bool_rtx_int_int_int_intp_bool_false)
1706 /* Compute the cost of X, used as an address. Never called with
1707 invalid addresses. */
1708 DEFHOOK
1709 (address_cost,
1711 int, (rtx address, bool speed),
1712 default_address_cost)
1714 /* Return where to allocate pseudo for a given hard register initial value. */
1715 DEFHOOK
1716 (allocate_initial_value,
1718 rtx, (rtx hard_reg), NULL)
1720 /* Return nonzero if evaluating UNSPEC[_VOLATILE] X might cause a trap.
1721 FLAGS has the same meaning as in rtlanal.c: may_trap_p_1. */
1722 DEFHOOK
1723 (unspec_may_trap_p,
1725 int, (const_rtx x, unsigned flags),
1726 default_unspec_may_trap_p)
1728 /* Given a register, this hook should return a parallel of registers
1729 to represent where to find the register pieces. Define this hook
1730 if the register and its mode are represented in Dwarf in
1731 non-contiguous locations, or if the register should be
1732 represented in more than one register in Dwarf. Otherwise, this
1733 hook should return NULL_RTX. */
1734 DEFHOOK
1735 (dwarf_register_span,
1737 rtx, (rtx reg),
1738 hook_rtx_rtx_null)
1740 /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table
1741 entries not corresponding directly to registers below
1742 FIRST_PSEUDO_REGISTER, this hook should generate the necessary
1743 code, given the address of the table. */
1744 DEFHOOK
1745 (init_dwarf_reg_sizes_extra,
1747 void, (tree address),
1748 hook_void_tree)
1750 /* Fetch the fixed register(s) which hold condition codes, for
1751 targets where it makes sense to look for duplicate assignments to
1752 the condition codes. This should return true if there is such a
1753 register, false otherwise. The arguments should be set to the
1754 fixed register numbers. Up to two condition code registers are
1755 supported. If there is only one for this target, the int pointed
1756 at by the second argument should be set to -1. */
1757 DEFHOOK
1758 (fixed_condition_code_regs,
1760 bool, (unsigned int *p1, unsigned int *p2),
1761 hook_bool_uintp_uintp_false)
1763 /* If two condition code modes are compatible, return a condition
1764 code mode which is compatible with both, such that a comparison
1765 done in the returned mode will work for both of the original
1766 modes. If the condition code modes are not compatible, return
1767 VOIDmode. */
1768 DEFHOOK
1769 (cc_modes_compatible,
1771 enum machine_mode, (enum machine_mode m1, enum machine_mode m2),
1772 default_cc_modes_compatible)
1774 /* Do machine-dependent code transformations. Called just before
1775 delayed-branch scheduling. */
1776 DEFHOOK
1777 (machine_dependent_reorg,
1779 void, (void), NULL)
1781 /* Create the __builtin_va_list type. */
1782 DEFHOOK
1783 (build_builtin_va_list,
1785 tree, (void),
1786 std_build_builtin_va_list)
1788 /* Enumerate the va list variants. */
1789 DEFHOOK
1790 (enum_va_list_p,
1792 int, (int idx, const char **pname, tree *ptree),
1793 NULL)
1795 /* Get the cfun/fndecl calling abi __builtin_va_list type. */
1796 DEFHOOK
1797 (fn_abi_va_list,
1799 tree, (tree fndecl),
1800 std_fn_abi_va_list)
1802 /* Get the __builtin_va_list type dependent on input type. */
1803 DEFHOOK
1804 (canonical_va_list_type,
1806 tree, (tree type),
1807 std_canonical_va_list_type)
1809 /* ??? Documenting this hook requires a GFDL license grant. */
1810 DEFHOOK_UNDOC
1811 (expand_builtin_va_start,
1812 "Expand the @code{__builtin_va_start} builtin.",
1813 void, (tree valist, rtx nextarg), NULL)
1815 /* Gimplifies a VA_ARG_EXPR. */
1816 DEFHOOK
1817 (gimplify_va_arg_expr,
1819 tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
1820 std_gimplify_va_arg_expr)
1822 /* Validity-checking routines for PCH files, target-specific.
1823 get_pch_validity returns a pointer to the data to be stored,
1824 and stores the size in its argument. pch_valid_p gets the same
1825 information back and returns NULL if the PCH is valid,
1826 or an error message if not. */
1827 DEFHOOK
1828 (get_pch_validity,
1830 void *, (size_t *sz),
1831 default_get_pch_validity)
1833 DEFHOOK
1834 (pch_valid_p,
1836 const char *, (const void *data, size_t sz),
1837 default_pch_valid_p)
1839 DEFHOOK
1840 (prepare_pch_save,
1841 "Called before writing out a PCH file. If the target has some\n\
1842 garbage-collected data that needs to be in a particular state on PCH loads,\n\
1843 it can use this hook to enforce that state. Very few targets need\n\
1844 to do anything here.",
1845 void, (void),
1846 hook_void_void)
1848 /* If nonnull, this function checks whether a PCH file with the
1849 given set of target flags can be used. It returns NULL if so,
1850 otherwise it returns an error message. */
1851 DEFHOOK
1852 (check_pch_target_flags,
1854 const char *, (int pch_flags), NULL)
1856 /* True if the compiler should give an enum type only as many
1857 bytes as it takes to represent the range of possible values of
1858 that type. */
1859 DEFHOOK
1860 (default_short_enums,
1862 bool, (void),
1863 hook_bool_void_false)
1865 /* This target hook returns an rtx that is used to store the address
1866 of the current frame into the built-in setjmp buffer. */
1867 DEFHOOK
1868 (builtin_setjmp_frame_value,
1870 rtx, (void),
1871 default_builtin_setjmp_frame_value)
1873 /* This target hook should add STRING_CST trees for any hard regs
1874 the port wishes to automatically clobber for an asm. */
1875 DEFHOOK
1876 (md_asm_clobbers,
1878 tree, (tree outputs, tree inputs, tree clobbers),
1879 hook_tree_tree_tree_tree_3rd_identity)
1881 /* This target hook allows the backend to specify a calling convention
1882 in the debug information. This function actually returns an
1883 enum dwarf_calling_convention, but because of forward declarations
1884 and not wanting to include dwarf2.h everywhere target.h is included
1885 the function is being declared as an int. */
1886 DEFHOOK
1887 (dwarf_calling_convention,
1889 int, (const_tree function),
1890 hook_int_const_tree_0)
1892 /* This target hook allows the backend to emit frame-related insns that
1893 contain UNSPECs or UNSPEC_VOLATILEs. The call frame debugging info
1894 engine will invoke it on insns of the form
1895 (set (reg) (unspec [...] UNSPEC_INDEX))
1897 (set (reg) (unspec_volatile [...] UNSPECV_INDEX))
1898 to let the backend emit the call frame instructions. */
1899 DEFHOOK
1900 (dwarf_handle_frame_unspec,
1902 void, (const char *label, rtx pattern, int index), NULL)
1904 /* ??? Documenting this hook requires a GFDL license grant. */
1905 DEFHOOK_UNDOC
1906 (stdarg_optimize_hook,
1907 "Perform architecture specific checking of statements gimplified\
1908 from @code{VA_ARG_EXPR}. @var{stmt} is the statement. Returns true if\
1909 the statement doesn't need to be checked for @code{va_list} references.",
1910 bool, (struct stdarg_info *ai, const_gimple stmt), NULL)
1912 /* This target hook allows the operating system to override the DECL
1913 that represents the external variable that contains the stack
1914 protection guard variable. The type of this DECL is ptr_type_node. */
1915 DEFHOOK
1916 (stack_protect_guard,
1918 tree, (void),
1919 default_stack_protect_guard)
1921 /* This target hook allows the operating system to override the CALL_EXPR
1922 that is invoked when a check vs the guard variable fails. */
1923 DEFHOOK
1924 (stack_protect_fail,
1926 tree, (void),
1927 default_external_stack_protect_fail)
1929 /* Returns NULL if target supports the insn within a doloop block,
1930 otherwise it returns an error message. */
1931 DEFHOOK
1932 (invalid_within_doloop,
1934 const char *, (const_rtx insn),
1935 default_invalid_within_doloop)
1937 DEFHOOK
1938 (valid_dllimport_attribute_p,
1939 "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\
1940 specified. Use this hook if the target needs to add extra validation\
1941 checks to @code{handle_dll_attribute}.",
1942 bool, (const_tree decl),
1943 hook_bool_const_tree_true)
1945 /* If non-zero, align constant anchors in CSE to a multiple of this
1946 value. */
1947 DEFHOOKPOD
1948 (const_anchor,
1950 unsigned HOST_WIDE_INT, 0)
1952 /* Defines, which target-dependent bits (upper 16) are used by port */
1953 DEFHOOK
1954 (memmodel_check,
1956 unsigned HOST_WIDE_INT, (unsigned HOST_WIDE_INT val), NULL)
1958 /* Functions relating to calls - argument passing, returns, etc. */
1959 /* Members of struct call have no special macro prefix. */
1960 HOOK_VECTOR (TARGET_CALLS, calls)
1962 DEFHOOK
1963 (promote_function_mode,
1965 enum machine_mode, (const_tree type, enum machine_mode mode, int *punsignedp,
1966 const_tree funtype, int for_return),
1967 default_promote_function_mode)
1969 DEFHOOK
1970 (promote_prototypes,
1972 bool, (const_tree fntype),
1973 hook_bool_const_tree_false)
1975 DEFHOOK
1976 (struct_value_rtx,
1978 rtx, (tree fndecl, int incoming),
1979 hook_rtx_tree_int_null)
1980 DEFHOOK
1981 (return_in_memory,
1983 bool, (const_tree type, const_tree fntype),
1984 default_return_in_memory)
1986 DEFHOOK
1987 (return_in_msb,
1989 bool, (const_tree type),
1990 hook_bool_const_tree_false)
1992 /* Return true if a parameter must be passed by reference. TYPE may
1993 be null if this is a libcall. CA may be null if this query is
1994 from __builtin_va_arg. */
1995 DEFHOOK
1996 (pass_by_reference,
1998 bool,
1999 (cumulative_args_t cum, enum machine_mode mode, const_tree type, bool named),
2000 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
2002 DEFHOOK
2003 (expand_builtin_saveregs,
2005 rtx, (void),
2006 default_expand_builtin_saveregs)
2008 /* Returns pretend_argument_size. */
2009 DEFHOOK
2010 (setup_incoming_varargs,
2012 void, (cumulative_args_t args_so_far, enum machine_mode mode, tree type,
2013 int *pretend_args_size, int second_time),
2014 default_setup_incoming_varargs)
2016 DEFHOOK
2017 (strict_argument_naming,
2019 bool, (cumulative_args_t ca),
2020 hook_bool_CUMULATIVE_ARGS_false)
2022 /* Returns true if we should use
2023 targetm.calls.setup_incoming_varargs() and/or
2024 targetm.calls.strict_argument_naming(). */
2025 DEFHOOK
2026 (pretend_outgoing_varargs_named,
2028 bool, (cumulative_args_t ca),
2029 default_pretend_outgoing_varargs_named)
2031 /* Given a complex type T, return true if a parameter of type T
2032 should be passed as two scalars. */
2033 DEFHOOK
2034 (split_complex_arg,
2036 bool, (const_tree type), NULL)
2038 /* Return true if type T, mode MODE, may not be passed in registers,
2039 but must be passed on the stack. */
2040 /* ??? This predicate should be applied strictly after pass-by-reference.
2041 Need audit to verify that this is the case. */
2042 DEFHOOK
2043 (must_pass_in_stack,
2045 bool, (enum machine_mode mode, const_tree type),
2046 must_pass_in_stack_var_size_or_pad)
2048 /* Return true if type TYPE, mode MODE, which is passed by reference,
2049 should have the object copy generated by the callee rather than
2050 the caller. It is never called for TYPE requiring constructors. */
2051 DEFHOOK
2052 (callee_copies,
2054 bool,
2055 (cumulative_args_t cum, enum machine_mode mode, const_tree type, bool named),
2056 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
2058 /* Return zero for arguments passed entirely on the stack or entirely
2059 in registers. If passed in both, return the number of bytes passed
2060 in registers; the balance is therefore passed on the stack. */
2061 DEFHOOK
2062 (arg_partial_bytes,
2064 int, (cumulative_args_t cum, enum machine_mode mode, tree type, bool named),
2065 hook_int_CUMULATIVE_ARGS_mode_tree_bool_0)
2067 /* Update the state in CA to advance past an argument in the
2068 argument list. The values MODE, TYPE, and NAMED describe that
2069 argument. */
2070 DEFHOOK
2071 (function_arg_advance,
2073 void,
2074 (cumulative_args_t ca, enum machine_mode mode, const_tree type, bool named),
2075 default_function_arg_advance)
2077 /* Return zero if the argument described by the state of CA should
2078 be placed on a stack, or a hard register in which to store the
2079 argument. The values MODE, TYPE, and NAMED describe that
2080 argument. */
2081 DEFHOOK
2082 (function_arg,
2084 rtx, (cumulative_args_t ca, enum machine_mode mode, const_tree type,
2085 bool named),
2086 default_function_arg)
2088 /* Likewise, but for machines with register windows. Return the
2089 location where the argument will appear to the callee. */
2090 DEFHOOK
2091 (function_incoming_arg,
2093 rtx, (cumulative_args_t ca, enum machine_mode mode, const_tree type,
2094 bool named),
2095 default_function_incoming_arg)
2097 DEFHOOK
2098 (function_arg_boundary,
2100 unsigned int, (enum machine_mode mode, const_tree type),
2101 default_function_arg_boundary)
2103 DEFHOOK
2104 (function_arg_round_boundary,
2105 "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
2106 which is the default value for this hook. You can define this hook to\n\
2107 return a different value if an argument size must be rounded to a larger\n\
2108 value.",
2109 unsigned int, (enum machine_mode mode, const_tree type),
2110 default_function_arg_round_boundary)
2112 /* Return the diagnostic message string if function without a prototype
2113 is not allowed for this 'val' argument; NULL otherwise. */
2114 DEFHOOK
2115 (invalid_arg_for_unprototyped_fn,
2117 const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
2118 hook_invalid_arg_for_unprototyped_fn)
2120 /* Return an rtx for the return value location of the function
2121 specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
2122 DEFHOOK
2123 (function_value,
2125 rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
2126 default_function_value)
2128 /* Return the rtx for the result of a libcall of mode MODE,
2129 calling the function FN_NAME. */
2130 DEFHOOK
2131 (libcall_value,
2133 rtx, (enum machine_mode mode, const_rtx fun),
2134 default_libcall_value)
2136 /* Return true if REGNO is a possible register number for
2137 a function value as seen by the caller. */
2138 DEFHOOK
2139 (function_value_regno_p,
2141 bool, (const unsigned int regno),
2142 default_function_value_regno_p)
2144 /* ??? Documenting this hook requires a GFDL license grant. */
2145 DEFHOOK_UNDOC
2146 (internal_arg_pointer,
2147 "Return an rtx for the argument pointer incoming to the\
2148 current function.",
2149 rtx, (void),
2150 default_internal_arg_pointer)
2152 /* Update the current function stack boundary if needed. */
2153 DEFHOOK
2154 (update_stack_boundary,
2156 void, (void), NULL)
2158 /* Handle stack alignment and return an rtx for Dynamic Realign
2159 Argument Pointer if necessary. */
2160 DEFHOOK
2161 (get_drap_rtx,
2163 rtx, (void), NULL)
2165 /* Return true if all function parameters should be spilled to the
2166 stack. */
2167 DEFHOOK
2168 (allocate_stack_slots_for_args,
2170 bool, (void),
2171 hook_bool_void_true)
2173 /* Return an rtx for the static chain for FNDECL. If INCOMING_P is true,
2174 then it should be for the callee; otherwise for the caller. */
2175 DEFHOOK
2176 (static_chain,
2178 rtx, (const_tree fndecl, bool incoming_p),
2179 default_static_chain)
2181 /* Fill in the trampoline at MEM with a call to FNDECL and a
2182 static chain value of CHAIN. */
2183 DEFHOOK
2184 (trampoline_init,
2186 void, (rtx m_tramp, tree fndecl, rtx static_chain),
2187 default_trampoline_init)
2189 /* Adjust the address of the trampoline in a target-specific way. */
2190 DEFHOOK
2191 (trampoline_adjust_address,
2193 rtx, (rtx addr), NULL)
2195 /* Return the number of bytes of its own arguments that a function
2196 pops on returning, or 0 if the function pops no arguments and the
2197 caller must therefore pop them all after the function returns. */
2198 /* ??? tm.texi has no types for the parameters. */
2199 DEFHOOK
2200 (return_pops_args,
2202 int, (tree fundecl, tree funtype, int size),
2203 default_return_pops_args)
2205 /* Return a mode wide enough to copy any function value that might be
2206 returned. */
2207 DEFHOOK
2208 (get_raw_result_mode,
2209 "This target hook returns the mode to be used when accessing raw return\
2210 registers in @code{__builtin_return}. Define this macro if the value\
2211 in @var{reg_raw_mode} is not correct.",
2212 enum machine_mode, (int regno),
2213 default_get_reg_raw_mode)
2215 /* Return a mode wide enough to copy any argument value that might be
2216 passed. */
2217 DEFHOOK
2218 (get_raw_arg_mode,
2219 "This target hook returns the mode to be used when accessing raw argument\
2220 registers in @code{__builtin_apply_args}. Define this macro if the value\
2221 in @var{reg_raw_mode} is not correct.",
2222 enum machine_mode, (int regno),
2223 default_get_reg_raw_mode)
2225 HOOK_VECTOR_END (calls)
2227 /* Return the diagnostic message string if conversion from FROMTYPE
2228 to TOTYPE is not allowed, NULL otherwise. */
2229 DEFHOOK
2230 (invalid_conversion,
2232 const char *, (const_tree fromtype, const_tree totype),
2233 hook_constcharptr_const_tree_const_tree_null)
2235 /* Return the diagnostic message string if the unary operation OP is
2236 not permitted on TYPE, NULL otherwise. */
2237 DEFHOOK
2238 (invalid_unary_op,
2240 const char *, (int op, const_tree type),
2241 hook_constcharptr_int_const_tree_null)
2243 /* Return the diagnostic message string if the binary operation OP
2244 is not permitted on TYPE1 and TYPE2, NULL otherwise. */
2245 DEFHOOK
2246 (invalid_binary_op,
2248 const char *, (int op, const_tree type1, const_tree type2),
2249 hook_constcharptr_int_const_tree_const_tree_null)
2251 /* Return the diagnostic message string if TYPE is not valid as a
2252 function parameter type, NULL otherwise. */
2253 DEFHOOK
2254 (invalid_parameter_type,
2256 const char *, (const_tree type),
2257 hook_constcharptr_const_tree_null)
2259 /* Return the diagnostic message string if TYPE is not valid as a
2260 function return type, NULL otherwise. */
2261 DEFHOOK
2262 (invalid_return_type,
2264 const char *, (const_tree type),
2265 hook_constcharptr_const_tree_null)
2267 /* If values of TYPE are promoted to some other type when used in
2268 expressions (analogous to the integer promotions), return that type,
2269 or NULL_TREE otherwise. */
2270 DEFHOOK
2271 (promoted_type,
2273 tree, (const_tree type),
2274 hook_tree_const_tree_null)
2276 /* Convert EXPR to TYPE, if target-specific types with special conversion
2277 rules are involved. Return the converted expression, or NULL to apply
2278 the standard conversion rules. */
2279 DEFHOOK
2280 (convert_to_type,
2282 tree, (tree type, tree expr),
2283 hook_tree_tree_tree_null)
2285 /* Return the class for a secondary reload, and fill in extra information. */
2286 DEFHOOK
2287 (secondary_reload,
2289 reg_class_t,
2290 (bool in_p, rtx x, reg_class_t reload_class, enum machine_mode reload_mode,
2291 secondary_reload_info *sri),
2292 default_secondary_reload)
2294 /* Given an rtx X being reloaded into a reg required to be in class CLASS,
2295 return the class of reg to actually use. */
2296 DEFHOOK
2297 (preferred_reload_class,
2299 reg_class_t,
2300 (rtx x, reg_class_t rclass),
2301 default_preferred_reload_class)
2303 /* Like TARGET_PREFERRED_RELOAD_CLASS, but for output reloads instead of
2304 input reloads. */
2305 DEFHOOK
2306 (preferred_output_reload_class,
2308 reg_class_t,
2309 (rtx x, reg_class_t rclass),
2310 default_preferred_output_reload_class)
2312 DEFHOOK
2313 (class_likely_spilled_p,
2315 bool, (reg_class_t rclass),
2316 default_class_likely_spilled_p)
2318 /* Return the maximum number of consecutive registers
2319 needed to represent mode MODE in a register of class RCLASS. */
2320 DEFHOOK
2321 (class_max_nregs,
2323 unsigned char, (reg_class_t rclass, enum machine_mode mode),
2324 default_class_max_nregs)
2326 DEFHOOK
2327 (preferred_rename_class,
2328 "A target hook that places additional preference on the register\
2329 class to use when it is necessary to rename a register in class\
2330 @var{rclass} to another class, or perhaps @var{NO_REGS}, if no\
2331 preferred register class is found or hook @code{preferred_rename_class}\
2332 is not implemented.\
2333 Sometimes returning a more restrictive class makes better code. For\
2334 example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\
2335 smaller than instructions using @code{GENERIC_REGS}. By returning\
2336 @code{LO_REGS} from @code{preferred_rename_class}, code size can\
2337 be reduced.",
2338 reg_class_t, (reg_class_t rclass),
2339 default_preferred_rename_class)
2341 /* This target hook allows the backend to perform additional
2342 processing while initializing for variable expansion. */
2343 DEFHOOK
2344 (expand_to_rtl_hook,
2346 void, (void),
2347 hook_void_void)
2349 /* This target hook allows the backend to perform additional
2350 instantiations on rtx that are not actually in insns yet,
2351 but will be later. */
2352 DEFHOOK
2353 (instantiate_decls,
2355 void, (void),
2356 hook_void_void)
2358 /* Return true if is OK to use a hard register REGNO as scratch register
2359 in peephole2. */
2360 DEFHOOK
2361 (hard_regno_scratch_ok,
2363 bool, (unsigned int regno),
2364 default_hard_regno_scratch_ok)
2366 /* Return the smallest number of different values for which it is best to
2367 use a jump-table instead of a tree of conditional branches. */
2368 DEFHOOK
2369 (case_values_threshold,
2371 unsigned int, (void),
2372 default_case_values_threshold)
2374 /* Retutn true if a function must have and use a frame pointer. */
2375 DEFHOOK
2376 (frame_pointer_required,
2378 bool, (void),
2379 hook_bool_void_false)
2381 /* Returns true if the compiler is allowed to try to replace register number
2382 from-reg with register number to-reg. */
2383 DEFHOOK
2384 (can_eliminate,
2386 bool, (const int from_reg, const int to_reg),
2387 hook_bool_const_int_const_int_true)
2389 /* Modify any or all of fixed_regs, call_used_regs, global_regs,
2390 reg_names, and reg_class_contents to account of the vagaries of the
2391 target. */
2392 DEFHOOK
2393 (conditional_register_usage,
2395 void, (void),
2396 hook_void_void)
2398 /* Functions specific to the C family of frontends. */
2399 #undef HOOK_PREFIX
2400 #define HOOK_PREFIX "TARGET_C_"
2401 HOOK_VECTOR (TARGET_C, c)
2403 /* ??? Documenting this hook requires a GFDL license grant. */
2404 DEFHOOK_UNDOC
2405 (mode_for_suffix,
2406 "Return machine mode for non-standard constant literal suffix @var{c},\
2407 or VOIDmode if non-standard suffixes are unsupported.",
2408 enum machine_mode, (char c),
2409 default_mode_for_suffix)
2411 HOOK_VECTOR_END (c)
2413 /* Functions specific to the C++ frontend. */
2414 #undef HOOK_PREFIX
2415 #define HOOK_PREFIX "TARGET_CXX_"
2416 HOOK_VECTOR (TARGET_CXX, cxx)
2418 /* Return the integer type used for guard variables. */
2419 DEFHOOK
2420 (guard_type,
2422 tree, (void),
2423 default_cxx_guard_type)
2425 /* Return true if only the low bit of the guard should be tested. */
2426 DEFHOOK
2427 (guard_mask_bit,
2429 bool, (void),
2430 hook_bool_void_false)
2432 /* Returns the size of the array cookie for an array of type. */
2433 DEFHOOK
2434 (get_cookie_size,
2436 tree, (tree type),
2437 default_cxx_get_cookie_size)
2439 /* Returns true if the element size should be stored in the array cookie. */
2440 DEFHOOK
2441 (cookie_has_size,
2443 bool, (void),
2444 hook_bool_void_false)
2446 /* Allows backends to perform additional processing when
2447 deciding if a class should be exported or imported. */
2448 DEFHOOK
2449 (import_export_class,
2451 int, (tree type, int import_export), NULL)
2453 /* Returns true if constructors and destructors return "this". */
2454 DEFHOOK
2455 (cdtor_returns_this,
2457 bool, (void),
2458 hook_bool_void_false)
2460 /* Returns true if the key method for a class can be an inline
2461 function, so long as it is not declared inline in the class
2462 itself. Returning true is the behavior required by the Itanium C++ ABI. */
2463 DEFHOOK
2464 (key_method_may_be_inline,
2466 bool, (void),
2467 hook_bool_void_true)
2469 DEFHOOK
2470 (determine_class_data_visibility,
2471 "@var{decl} is a virtual table, virtual table table, typeinfo object,\
2472 or other similar implicit class data object that will be emitted with\
2473 external linkage in this translation unit. No ELF visibility has been\
2474 explicitly specified. If the target needs to specify a visibility\
2475 other than that of the containing class, use this hook to set\
2476 @code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
2477 void, (tree decl),
2478 hook_void_tree)
2480 /* Returns true (the default) if virtual tables and other
2481 similar implicit class data objects are always COMDAT if they
2482 have external linkage. If this hook returns false, then
2483 class data for classes whose virtual table will be emitted in
2484 only one translation unit will not be COMDAT. */
2485 DEFHOOK
2486 (class_data_always_comdat,
2488 bool, (void),
2489 hook_bool_void_true)
2491 /* Returns true (the default) if the RTTI for the basic types,
2492 which is always defined in the C++ runtime, should be COMDAT;
2493 false if it should not be COMDAT. */
2494 DEFHOOK
2495 (library_rtti_comdat,
2497 bool, (void),
2498 hook_bool_void_true)
2500 /* Returns true if __aeabi_atexit should be used to register static
2501 destructors. */
2502 DEFHOOK
2503 (use_aeabi_atexit,
2505 bool, (void),
2506 hook_bool_void_false)
2508 /* Returns true if target may use atexit in the same manner as
2509 __cxa_atexit to register static destructors. */
2510 DEFHOOK
2511 (use_atexit_for_cxa_atexit,
2513 bool, (void),
2514 hook_bool_void_false)
2516 DEFHOOK
2517 (adjust_class_at_definition,
2518 "@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\
2519 been defined. Use this hook to make adjustments to the class (eg, tweak\
2520 visibility or perform any other required target modifications).",
2521 void, (tree type),
2522 hook_void_tree)
2524 DEFHOOK
2525 (decl_mangling_context,
2526 "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
2527 tree, (const_tree decl),
2528 hook_tree_const_tree_null)
2530 HOOK_VECTOR_END (cxx)
2532 /* Functions and data for emulated TLS support. */
2533 #undef HOOK_PREFIX
2534 #define HOOK_PREFIX "TARGET_EMUTLS_"
2535 HOOK_VECTOR (TARGET_EMUTLS, emutls)
2537 /* Name of the address and common functions. */
2538 DEFHOOKPOD
2539 (get_address,
2541 const char *, "__builtin___emutls_get_address")
2543 DEFHOOKPOD
2544 (register_common,
2546 const char *, "__builtin___emutls_register_common")
2548 /* Prefixes for proxy variable and template. */
2549 DEFHOOKPOD
2550 (var_section,
2552 const char *, NULL)
2554 DEFHOOKPOD
2555 (tmpl_section,
2557 const char *, NULL)
2559 /* Prefixes for proxy variable and template. */
2560 DEFHOOKPOD
2561 (var_prefix,
2563 const char *, NULL)
2565 DEFHOOKPOD
2566 (tmpl_prefix,
2568 const char *, NULL)
2570 /* Function to generate field definitions of the proxy variable. */
2571 DEFHOOK
2572 (var_fields,
2574 tree, (tree type, tree *name),
2575 default_emutls_var_fields)
2577 /* Function to initialize a proxy variable. */
2578 DEFHOOK
2579 (var_init,
2581 tree, (tree var, tree decl, tree tmpl_addr),
2582 default_emutls_var_init)
2584 /* Whether we are allowed to alter the usual alignment of the
2585 proxy variable. */
2586 DEFHOOKPOD
2587 (var_align_fixed,
2589 bool, false)
2591 /* Whether we can emit debug information for TLS vars. */
2592 DEFHOOKPOD
2593 (debug_form_tls_address,
2595 bool, false)
2597 HOOK_VECTOR_END (emutls)
2599 #undef HOOK_PREFIX
2600 #define HOOK_PREFIX "TARGET_OPTION_"
2601 HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
2603 /* Function to validate the attribute((option(...))) strings or NULL. If
2604 the option is validated, it is assumed that DECL_FUNCTION_SPECIFIC will
2605 be filled in in the function decl node. */
2606 DEFHOOK
2607 (valid_attribute_p,
2609 bool, (tree fndecl, tree name, tree args, int flags),
2610 default_target_option_valid_attribute_p)
2612 /* Function to save any extra target state in the target options structure. */
2613 DEFHOOK
2614 (save,
2616 void, (struct cl_target_option *ptr), NULL)
2618 /* Function to restore any extra target state from the target options
2619 structure. */
2620 DEFHOOK
2621 (restore,
2623 void, (struct cl_target_option *ptr), NULL)
2625 /* Function to print any extra target state from the target options
2626 structure. */
2627 DEFHOOK
2628 (print,
2630 void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
2632 /* Function to parse arguments to be validated for #pragma option, and to
2633 change the state if the options are valid. If the first argument is
2634 NULL, the second argument specifies the default options to use. Return
2635 true if the options are valid, and set the current state. */
2636 /* ??? The documentation in tm.texi is incomplete. */
2637 DEFHOOK
2638 (pragma_parse,
2640 bool, (tree args, tree pop_target),
2641 default_target_option_pragma_parse)
2643 /* Do option overrides for the target. */
2644 DEFHOOK
2645 (override,
2647 void, (void),
2648 hook_void_void)
2650 /* Function to determine if one function can inline another function. */
2651 #undef HOOK_PREFIX
2652 #define HOOK_PREFIX "TARGET_"
2653 DEFHOOK
2654 (can_inline_p,
2656 bool, (tree caller, tree callee),
2657 default_target_can_inline_p)
2659 HOOK_VECTOR_END (target_option)
2661 /* For targets that need to mark extra registers as live on entry to
2662 the function, they should define this target hook and set their
2663 bits in the bitmap passed in. */
2664 DEFHOOK
2665 (extra_live_on_entry,
2667 void, (bitmap regs),
2668 hook_void_bitmap)
2670 /* Fill in additional registers set up by prologue into a regset. */
2671 DEFHOOK
2672 (set_up_by_prologue,
2673 "This hook should add additional registers that are computed by the prologue\
2674 to the hard regset for shrink-wrapping optimization purposes.",
2675 void, (struct hard_reg_set_container *),
2676 NULL)
2678 /* Determine the type of unwind info to emit for debugging. */
2679 DEFHOOK
2680 (debug_unwind_info,
2682 enum unwind_info_type, (void),
2683 default_debug_unwind_info)
2685 DEFHOOKPOD
2686 (atomic_test_and_set_trueval,
2687 "This value should be set if the result written by\
2688 @code{atomic_test_and_set} is not exactly 1, i.e. the\
2689 @code{bool} @code{true}.",
2690 unsigned char, 1)
2692 /* Leave the boolean fields at the end. */
2694 /* True if we can create zeroed data by switching to a BSS section
2695 and then using ASM_OUTPUT_SKIP to allocate the space. */
2696 DEFHOOKPOD
2697 (have_switchable_bss_sections,
2699 bool, false)
2701 /* True if "native" constructors and destructors are supported,
2702 false if we're using collect2 for the job. */
2703 DEFHOOKPOD
2704 (have_ctors_dtors,
2706 bool, false)
2708 /* True if thread-local storage is supported. */
2709 DEFHOOKPOD
2710 (have_tls,
2712 bool, false)
2714 /* True if a small readonly data section is supported. */
2715 DEFHOOKPOD
2716 (have_srodata_section,
2718 bool, false)
2720 /* True if EH frame info sections should be zero-terminated. */
2721 DEFHOOKPOD
2722 (terminate_dw2_eh_frame_info,
2724 bool, true)
2726 /* True if #NO_APP should be emitted at the beginning of assembly output. */
2727 DEFHOOKPOD
2728 (asm_file_start_app_off,
2730 bool, false)
2732 /* True if output_file_directive should be called for main_input_filename
2733 at the beginning of assembly output. */
2734 DEFHOOKPOD
2735 (asm_file_start_file_directive,
2737 bool, false)
2739 /* True if the target is allowed to reorder memory accesses unless
2740 synchronization is explicitly requested. */
2741 DEFHOOKPOD
2742 (relaxed_ordering,
2744 bool, false)
2746 /* Returns true if we should generate exception tables for use with the
2747 ARM EABI. The effects the encoding of function exception specifications. */
2748 DEFHOOKPOD
2749 (arm_eabi_unwinder,
2751 bool, false)
2753 DEFHOOKPOD
2754 (want_debug_pub_sections,
2755 "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\
2756 should be emitted. These sections are not used on most platforms, and\
2757 in particular GDB does not use them.",
2758 bool, false)
2760 DEFHOOKPOD
2761 (force_at_comp_dir,
2762 "True if the @code{DW_AT_comp_dir} attribute should be emitted for each \
2763 compilation unit. This attribute is required for the darwin linker \
2764 to emit debug information.",
2765 bool, false)
2767 DEFHOOKPOD
2768 (delay_sched2, "True if sched2 is not to be run at its normal place. \
2769 This usually means it will be run as part of machine-specific reorg.",
2770 bool, false)
2772 DEFHOOKPOD
2773 (delay_vartrack, "True if vartrack is not to be run at its normal place. \
2774 This usually means it will be run as part of machine-specific reorg.",
2775 bool, false)
2777 /* Leave the boolean fields at the end. */
2779 /* Close the 'struct gcc_target' definition. */
2780 HOOK_VECTOR_END (C90_EMPTY_HACK)