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