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