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