dwarf2out.c (mem_loc_descriptor): Recurse on LO_SUM.
[official-gcc.git] / gcc / target.def
blobb11c0c00d1477f420a9da24c6ef77f64676a9e20
1 /* Target hook definitions.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
3 2011
4 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 3, or (at your option) any
9 later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>.
20 In other words, you are welcome to use, share and improve this program.
21 You are forbidden to forbid anyone else to use, share and improve
22 what you give them. Help stamp out software-hoarding! */
24 /* The following macros should be provided by the including file:
26 DEFHOOK(NAME, DOC, TYPE, PARAMS, INIT): Define a function-valued hook.
27 DEFHOOKPOD(DOC, TYPE, NAME, INIT): Define a piece-of-data 'hook'. */
29 /* Defaults for optional macros:
30 DEFHOOKPODX(NAME, TYPE, INIT): Like DEFHOOKPOD, but share documentation
31 with the previous 'hook'. */
32 #ifndef DEFHOOKPODX
33 #define DEFHOOKPODX(NAME, TYPE, INIT) DEFHOOKPOD (NAME, 0, TYPE, INIT)
34 #endif
36 /* HOOKSTRUCT(FRAGMENT): Declarator fragments to encapsulate all the
37 members into a struct gcc_target, which in turn contains several
38 sub-structs. */
39 #ifndef HOOKSTRUCT
40 #define HOOKSTRUCT(FRAGMENT)
41 #endif
42 /* HOOK_VECTOR: Start a struct declaration, which then gets its own initializer.
43 HOOK_VECTOR_END: Close a struct declaration, providing a member declarator
44 name for nested use. */
45 #ifndef HOOK_VECTOR_1
46 #define HOOK_VECTOR_1(NAME, FRAGMENT) HOOKSTRUCT(FRAGMENT)
47 #endif
48 #define HOOK_VECTOR(INIT_NAME, SNAME) HOOK_VECTOR_1 (INIT_NAME, struct SNAME {)
49 #define HOOK_VECTOR_END(DECL_NAME) HOOK_VECTOR_1(,} DECL_NAME ;)
51 HOOK_VECTOR (TARGET_INITIALIZER, gcc_target)
53 /* FIXME: For pre-existing hooks, we can't place the documentation in the
54 documentation field here till we get permission from the FSF to include
55 it in GPLed software - the target hook documentation is so far only
56 available under the GFDL. */
58 /* A hook should generally be documented by a string in the DOC parameter,
59 which should contain texinfo markup. If the documentation is only available
60 under the GPL, but not under the GFDL, put it in a comment above the hook
61 definition. If the function declaration is available both under GPL and
62 GFDL, but the documentation is only available under the GFDL, put the
63 documentaton in tm.texi.in, heading with @hook <hookname> and closing
64 the paragraph with @end deftypefn / deftypevr as appropriate, and marking
65 the next autogenerated hook with @hook <hookname>.
66 In both these cases, leave the DOC string empty, i.e. "".
67 Sometimes, for some historic reason the function declaration
68 has to be documented differently
69 than what it is. In that case, use DEFHOOK_UNDOC to supress auto-generation
70 of documentation. DEFHOOK_UNDOC takes a DOC string which it ignores, so
71 you can put GPLed documentation string there if you have hopes that you
72 can clear the declaration & documentation for GFDL distribution later,
73 in which case you can then simply change the DEFHOOK_UNDOC to DEFHOOK
74 to turn on the autogeneration of the documentation.
76 A documentation string of "*" means not to emit any documentation at all,
77 and is mainly used internally for DEFHOOK_UNDOC. It should generally not
78 be used otherwise, but it has its use for exceptional cases where automatic
79 documentation is not wanted, and the real documentation is elsewere, like
80 for TARGET_ASM_{,UN}ALIGNED_INT_OP, which are hooks only for implementation
81 purposes; they refer to structs, the components of which are documented as
82 separate hooks TARGET_ASM_{,UN}ALIGNED_[HSDT]I_OP.
83 A DOC string of 0 is for internal use of DEFHOOKPODX and special table
84 entries only. */
86 /* Functions that output assembler for the target. */
87 #define HOOK_PREFIX "TARGET_ASM_"
88 HOOK_VECTOR (TARGET_ASM_OUT, asm_out)
90 /* Opening and closing parentheses for asm expression grouping. */
91 DEFHOOKPOD
92 (open_paren,
93 "",
94 const char *, "(")
95 DEFHOOKPODX (close_paren, const char *, ")")
97 /* Assembler instructions for creating various kinds of integer object. */
98 DEFHOOKPOD
99 (byte_op,
101 const char *, "\t.byte\t")
102 DEFHOOKPOD (aligned_op, "*", struct asm_int_op, TARGET_ASM_ALIGNED_INT_OP)
103 DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
105 /* The maximum number of bytes to skip when applying
106 LABEL_ALIGN_AFTER_BARRIER. */
107 DEFHOOK
108 (label_align_after_barrier_max_skip,
110 int, (rtx label),
111 default_label_align_after_barrier_max_skip)
113 /* The maximum number of bytes to skip when applying
114 LOOP_ALIGN. */
115 DEFHOOK
116 (loop_align_max_skip,
118 int, (rtx label),
119 default_loop_align_max_skip)
121 /* The maximum number of bytes to skip when applying
122 LABEL_ALIGN. */
123 DEFHOOK
124 (label_align_max_skip,
126 int, (rtx label),
127 default_label_align_max_skip)
129 /* The maximum number of bytes to skip when applying
130 JUMP_ALIGN. */
131 DEFHOOK
132 (jump_align_max_skip,
134 int, (rtx label),
135 default_jump_align_max_skip)
137 /* Try to output the assembler code for an integer object whose
138 value is given by X. SIZE is the size of the object in bytes and
139 ALIGNED_P indicates whether it is aligned. Return true if
140 successful. Only handles cases for which BYTE_OP, ALIGNED_OP
141 and UNALIGNED_OP are NULL. */
142 DEFHOOK
143 (integer,
145 /* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
146 NULL. */
147 bool, (rtx x, unsigned int size, int aligned_p),
148 default_assemble_integer)
150 /* Output code that will globalize a label. */
151 DEFHOOK
152 (globalize_label,
154 void, (FILE *stream, const char *name),
155 default_globalize_label)
157 /* Output code that will globalize a declaration. */
158 DEFHOOK
159 (globalize_decl_name,
161 void, (FILE *stream, tree decl), default_globalize_decl_name)
163 /* Output code that will emit a label for unwind info, if this
164 target requires such labels. Second argument is the decl the
165 unwind info is associated with, third is a boolean: true if
166 this is for exception handling, fourth is a boolean: true if
167 this is only a placeholder for an omitted FDE. */
168 DEFHOOK
169 (emit_unwind_label,
171 void, (FILE *stream, tree decl, int for_eh, int empty),
172 default_emit_unwind_label)
174 /* Output code that will emit a label to divide up the exception table. */
175 DEFHOOK
176 (emit_except_table_label,
178 void, (FILE *stream),
179 default_emit_except_table_label)
181 /* Emit a directive for setting the personality for the function. */
182 DEFHOOK
183 (emit_except_personality,
184 "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\
185 used to emit a directive to install a personality hook into the unwind\
186 info. This hook should not be used if dwarf2 unwind info is used.",
187 void, (rtx personality),
188 NULL)
190 /* Emit any directives required to unwind this instruction. */
191 DEFHOOK
192 (unwind_emit,
194 void, (FILE *stream, rtx insn),
195 NULL)
197 DEFHOOKPOD
198 (unwind_emit_before_insn,
199 "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\
200 the assembly for @var{insn} has been emitted, false if the hook should\
201 be called afterward.",
202 bool, true)
204 /* Generate an internal label.
205 For now this is just a wrapper for ASM_GENERATE_INTERNAL_LABEL. */
206 DEFHOOK_UNDOC
207 (generate_internal_label,
209 void, (char *buf, const char *prefix, unsigned long labelno),
210 default_generate_internal_label)
212 /* Output an internal label. */
213 DEFHOOK
214 (internal_label,
216 void, (FILE *stream, const char *prefix, unsigned long labelno),
217 default_internal_label)
219 /* Output label for the constant. */
220 DEFHOOK
221 (declare_constant_name,
223 void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
224 default_asm_declare_constant_name)
226 /* Emit a ttype table reference to a typeinfo object. */
227 DEFHOOK
228 (ttype,
230 bool, (rtx sym),
231 hook_bool_rtx_false)
233 /* Emit an assembler directive to set visibility for the symbol
234 associated with the tree decl. */
235 DEFHOOK
236 (assemble_visibility,
238 void, (tree decl, int visibility),
239 default_assemble_visibility)
241 /* Output the assembler code for entry to a function. */
242 DEFHOOK
243 (function_prologue,
245 void, (FILE *file, HOST_WIDE_INT size),
246 default_function_pro_epilogue)
248 /* Output the assembler code for end of prologue. */
249 DEFHOOK
250 (function_end_prologue,
252 void, (FILE *file),
253 no_asm_to_stream)
255 /* Output the assembler code for start of epilogue. */
256 DEFHOOK
257 (function_begin_epilogue,
259 void, (FILE *file),
260 no_asm_to_stream)
262 /* Output the assembler code for function exit. */
263 DEFHOOK
264 (function_epilogue,
266 void, (FILE *file, HOST_WIDE_INT size),
267 default_function_pro_epilogue)
269 /* Initialize target-specific sections. */
270 DEFHOOK
271 (init_sections,
273 void, (void),
274 hook_void_void)
276 /* Tell assembler to change to section NAME with attributes FLAGS.
277 If DECL is non-NULL, it is the VAR_DECL or FUNCTION_DECL with
278 which this section is associated. */
279 DEFHOOK
280 (named_section,
282 void, (const char *name, unsigned int flags, tree decl),
283 default_no_named_section)
285 /* Return preferred text (sub)section for function DECL.
286 Main purpose of this function is to separate cold, normal and hot
287 functions. STARTUP is true when function is known to be used only
288 at startup (from static constructors or it is main()).
289 EXIT is true when function is known to be used only at exit
290 (from static destructors).
291 Return NULL if function should go to default text section. */
292 DEFHOOK
293 (function_section,
295 section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
296 default_function_section)
298 /* Output the assembler code for function exit. */
299 DEFHOOK
300 (function_switched_text_sections,
301 "Used by the target to emit any assembler directives or additional\
302 labels needed when a function is partitioned between different\
303 sections. Output should be written to @var{file}. The function\
304 decl is available as @var{decl} and the new section is `cold' if\
305 @var{new_is_cold} is @code{true}.",
306 void, (FILE *file, tree decl, bool new_is_cold),
307 default_function_switched_text_sections)
309 /* Return a mask describing how relocations should be treated when
310 selecting sections. Bit 1 should be set if global relocations
311 should be placed in a read-write section; bit 0 should be set if
312 local relocations should be placed in a read-write section. */
313 DEFHOOK
314 (reloc_rw_mask,
316 int, (void),
317 default_reloc_rw_mask)
319 /* Return a section for EXP. It may be a DECL or a constant. RELOC
320 is nonzero if runtime relocations must be applied; bit 1 will be
321 set if the runtime relocations require non-local name resolution.
322 ALIGN is the required alignment of the data. */
323 DEFHOOK
324 (select_section,
326 section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
327 default_select_section)
329 /* Return a section for X. MODE is X's mode and ALIGN is its
330 alignment in bits. */
331 DEFHOOK
332 (select_rtx_section,
334 section *, (enum machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
335 default_select_rtx_section)
337 /* Select a unique section name for DECL. RELOC is the same as
338 for SELECT_SECTION. */
339 DEFHOOK
340 (unique_section,
342 void, (tree decl, int reloc),
343 default_unique_section)
345 /* Return the readonly data section associated with function DECL. */
346 DEFHOOK
347 (function_rodata_section,
349 section *, (tree decl),
350 default_function_rodata_section)
352 /* Output a constructor for a symbol with a given priority. */
353 DEFHOOK
354 (constructor,
356 void, (rtx symbol, int priority), NULL)
358 /* Output a destructor for a symbol with a given priority. */
359 DEFHOOK
360 (destructor,
362 void, (rtx symbol, int priority), NULL)
364 /* Output the assembler code for a thunk function. THUNK_DECL is the
365 declaration for the thunk function itself, FUNCTION is the decl for
366 the target function. DELTA is an immediate constant offset to be
367 added to THIS. If VCALL_OFFSET is nonzero, the word at
368 *(*this + vcall_offset) should be added to THIS. */
369 DEFHOOK
370 (output_mi_thunk,
372 void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
373 HOST_WIDE_INT vcall_offset, tree function),
374 NULL)
376 /* Determine whether output_mi_thunk would succeed. */
377 /* ??? Ideally, this hook would not exist, and success or failure
378 would be returned from output_mi_thunk directly. But there's
379 too much undo-able setup involved in invoking output_mi_thunk.
380 Could be fixed by making output_mi_thunk emit rtl instead of
381 text to the output file. */
382 DEFHOOK
383 (can_output_mi_thunk,
385 bool, (const_tree thunk_fndecl, HOST_WIDE_INT delta,
386 HOST_WIDE_INT vcall_offset, const_tree function),
387 hook_bool_const_tree_hwi_hwi_const_tree_false)
389 /* Output any boilerplate text needed at the beginning of a
390 translation unit. */
391 DEFHOOK
392 (file_start,
394 void, (void),
395 default_file_start)
397 /* Output any boilerplate text needed at the end of a translation unit. */
398 DEFHOOK
399 (file_end,
401 void, (void),
402 hook_void_void)
404 /* Output any boilerplate text needed at the beginning of an
405 LTO output stream. */
406 DEFHOOK
407 (lto_start,
409 void, (void),
410 hook_void_void)
412 /* Output any boilerplate text needed at the end of an
413 LTO output stream. */
414 DEFHOOK
415 (lto_end,
417 void, (void),
418 hook_void_void)
420 /* Output any boilerplace text needed at the end of a
421 translation unit before debug and unwind info is emitted. */
422 DEFHOOK
423 (code_end,
425 void, (void),
426 hook_void_void)
428 /* Output an assembler pseudo-op to declare a library function name
429 external. */
430 DEFHOOK
431 (external_libcall,
433 void, (rtx symref),
434 default_external_libcall)
436 /* Output an assembler directive to mark decl live. This instructs
437 linker to not dead code strip this symbol. */
438 DEFHOOK
439 (mark_decl_preserved,
441 void, (const char *symbol),
442 hook_void_constcharptr)
444 /* Output a record of the command line switches that have been passed. */
445 DEFHOOK
446 (record_gcc_switches,
448 int, (print_switch_type type, const char *text),
449 NULL)
451 /* The name of the section that the example ELF implementation of
452 record_gcc_switches will use to store the information. Target
453 specific versions of record_gcc_switches may or may not use
454 this information. */
455 DEFHOOKPOD
456 (record_gcc_switches_section,
458 const char *, ".GCC.command.line")
460 /* Output the definition of a section anchor. */
461 DEFHOOK
462 (output_anchor,
464 void, (rtx x),
465 default_asm_output_anchor)
467 /* Output a DTP-relative reference to a TLS symbol. */
468 DEFHOOK
469 (output_dwarf_dtprel,
471 void, (FILE *file, int size, rtx x),
472 NULL)
474 /* Some target machines need to postscan each insn after it is output. */
475 DEFHOOK
476 (final_postscan_insn,
478 void, (FILE *file, rtx insn, rtx *opvec, int noperands),
479 NULL)
481 /* Emit the trampoline template. This hook may be NULL. */
482 DEFHOOK
483 (trampoline_template,
485 void, (FILE *f),
486 NULL)
488 DEFHOOK
489 (output_source_filename,
490 "Output COFF information or DWARF debugging information which indicates\
491 that filename @var{name} is the current source file to the stdio\
492 stream @var{file}.\n\
494 This target hook need not be defined if the standard form of output\
495 for the file format in use is appropriate.",
496 void ,(FILE *file, const char *name),
497 default_asm_output_source_filename)
499 DEFHOOK
500 (output_addr_const_extra,
502 bool, (FILE *file, rtx x),
503 default_asm_output_addr_const_extra)
505 /* ??? The TARGET_PRINT_OPERAND* hooks are part of the asm_out struct,
506 even though that is not reflected in the macro name to override their
507 initializers. */
508 #undef HOOK_PREFIX
509 #define HOOK_PREFIX "TARGET_"
511 /* Emit a machine-specific insn operand. */
512 /* ??? tm.texi only documents the old macro PRINT_OPERAND,
513 not this hook, and uses a different name for the argument FILE. */
514 DEFHOOK_UNDOC
515 (print_operand,
517 void, (FILE *file, rtx x, int code),
518 default_print_operand)
520 /* Emit a machine-specific memory address. */
521 /* ??? tm.texi only documents the old macro PRINT_OPERAND_ADDRESS,
522 not this hook, and uses different argument names. */
523 DEFHOOK_UNDOC
524 (print_operand_address,
526 void, (FILE *file, rtx addr),
527 default_print_operand_address)
529 /* Determine whether CODE is a valid punctuation character for the
530 `print_operand' hook. */
531 /* ??? tm.texi only documents the old macro PRINT_OPERAND_PUNCT_VALID_P,
532 not this hook. */
533 DEFHOOK_UNDOC
534 (print_operand_punct_valid_p,
536 bool ,(unsigned char code),
537 default_print_operand_punct_valid_p)
539 /* Given a symbol name, perform same mangling as assemble_name and
540 ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
541 DEFHOOK
542 (mangle_assembler_name,
543 "Given a symbol @var{name}, perform same mangling as @code{varasm.c}'s\
544 @code{assemble_name}, but in memory rather than to a file stream, returning\
545 result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\
546 default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\
547 then prepends the @code{USER_LABEL_PREFIX}, if any.",
548 tree, (const char *name),
549 default_mangle_assembler_name)
551 HOOK_VECTOR_END (asm_out)
553 /* Functions relating to instruction scheduling. All of these
554 default to null pointers, which haifa-sched.c looks for and handles. */
555 #undef HOOK_PREFIX
556 #define HOOK_PREFIX "TARGET_SCHED_"
557 HOOK_VECTOR (TARGET_SCHED, sched)
559 /* Given the current cost, COST, of an insn, INSN, calculate and
560 return a new cost based on its relationship to DEP_INSN through
561 the dependence LINK. The default is to make no adjustment. */
562 DEFHOOK
563 (adjust_cost,
565 int, (rtx insn, rtx link, rtx dep_insn, int cost), NULL)
567 /* Adjust the priority of an insn as you see fit. Returns the new priority. */
568 DEFHOOK
569 (adjust_priority,
571 int, (rtx insn, int priority), NULL)
573 /* Function which returns the maximum number of insns that can be
574 scheduled in the same machine cycle. This must be constant
575 over an entire compilation. The default is 1. */
576 DEFHOOK
577 (issue_rate,
579 int, (void), NULL)
581 /* Calculate how much this insn affects how many more insns we
582 can emit this cycle. Default is they all cost the same. */
583 DEFHOOK
584 (variable_issue,
586 int, (FILE *file, int verbose, rtx insn, int more), NULL)
588 /* Initialize machine-dependent scheduling code. */
589 DEFHOOK
590 (init,
592 void, (FILE *file, int verbose, int max_ready), NULL)
594 /* Finalize machine-dependent scheduling code. */
595 DEFHOOK
596 (finish,
598 void, (FILE *file, int verbose), NULL)
600 /* Initialize machine-dependent function wide scheduling code. */
601 DEFHOOK
602 (init_global,
604 void, (FILE *file, int verbose, int old_max_uid), NULL)
606 /* Finalize machine-dependent function wide scheduling code. */
607 DEFHOOK
608 (finish_global,
610 void, (FILE *file, int verbose), NULL)
612 /* Reorder insns in a machine-dependent fashion, in two different
613 places. Default does nothing. */
614 DEFHOOK
615 (reorder,
617 int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL)
619 DEFHOOK
620 (reorder2,
622 int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL)
624 /* The following member value is a pointer to a function called
625 after evaluation forward dependencies of insns in chain given
626 by two parameter values (head and tail correspondingly). */
627 DEFHOOK
628 (dependencies_evaluation_hook,
630 void, (rtx head, rtx tail), NULL)
632 /* The values of the following four members are pointers to functions
633 used to simplify the automaton descriptions. dfa_pre_cycle_insn and
634 dfa_post_cycle_insn give functions returning insns which are used to
635 change the pipeline hazard recognizer state when the new simulated
636 processor cycle correspondingly starts and finishes. The function
637 defined by init_dfa_pre_cycle_insn and init_dfa_post_cycle_insn are
638 used to initialize the corresponding insns. The default values of
639 the members result in not changing the automaton state when the
640 new simulated processor cycle correspondingly starts and finishes. */
642 DEFHOOK
643 (init_dfa_pre_cycle_insn,
645 void, (void), NULL)
647 DEFHOOK
648 (dfa_pre_cycle_insn,
650 rtx, (void), NULL)
652 DEFHOOK
653 (init_dfa_post_cycle_insn,
655 void, (void), NULL)
657 DEFHOOK
658 (dfa_post_cycle_insn,
660 rtx, (void), NULL)
662 /* The values of the following two members are pointers to
663 functions used to simplify the automaton descriptions.
664 dfa_pre_advance_cycle and dfa_post_advance_cycle are getting called
665 immediately before and after cycle is advanced. */
667 DEFHOOK
668 (dfa_pre_advance_cycle,
670 void, (void), NULL)
672 DEFHOOK
673 (dfa_post_advance_cycle,
675 void, (void), NULL)
677 /* The following member value is a pointer to a function returning value
678 which defines how many insns in queue `ready' will we try for
679 multi-pass scheduling. If the member value is nonzero and the
680 function returns positive value, the DFA based scheduler will make
681 multi-pass scheduling for the first cycle. In other words, we will
682 try to choose ready insn which permits to start maximum number of
683 insns on the same cycle. */
684 DEFHOOK
685 (first_cycle_multipass_dfa_lookahead,
687 int, (void), NULL)
689 /* The following member value is pointer to a function controlling
690 what insns from the ready insn queue will be considered for the
691 multipass insn scheduling. If the hook returns zero for insn
692 passed as the parameter, the insn will be not chosen to be issued. */
693 DEFHOOK
694 (first_cycle_multipass_dfa_lookahead_guard,
696 int, (rtx insn), NULL)
698 /* This hook prepares the target for a new round of multipass
699 scheduling.
700 DATA is a pointer to target-specific data used for multipass scheduling.
701 READY_TRY and N_READY represent the current state of search in the
702 optimization space. The target can filter out instructions that
703 should not be tried during current round by setting corresponding
704 elements in READY_TRY to non-zero.
705 FIRST_CYCLE_INSN_P is true if this is the first round of multipass
706 scheduling on current cycle. */
707 DEFHOOK
708 (first_cycle_multipass_begin,
710 void, (void *data, char *ready_try, int n_ready, bool first_cycle_insn_p),
711 NULL)
713 /* This hook is called when multipass scheduling evaluates instruction INSN.
714 DATA is a pointer to target-specific data that can be used to record effects
715 of INSN on CPU that are not described in DFA.
716 READY_TRY and N_READY represent the current state of search in the
717 optimization space. The target can filter out instructions that
718 should not be tried after issueing INSN by setting corresponding
719 elements in READY_TRY to non-zero.
720 INSN is the instruction being evaluated.
721 PREV_DATA is a pointer to target-specific data corresponding
722 to a state before issueing INSN. */
723 DEFHOOK
724 (first_cycle_multipass_issue,
726 void, (void *data, char *ready_try, int n_ready, rtx insn,
727 const void *prev_data), NULL)
729 /* This hook is called when multipass scheduling backtracks from evaluation of
730 instruction corresponding to DATA.
731 DATA is a pointer to target-specific data that stores the effects
732 of instruction from which the algorithm backtracks on CPU that are not
733 described in DFA.
734 READY_TRY and N_READY represent the current state of search in the
735 optimization space. The target can filter out instructions that
736 should not be tried after issueing INSN by setting corresponding
737 elements in READY_TRY to non-zero. */
738 DEFHOOK
739 (first_cycle_multipass_backtrack,
741 void, (const void *data, char *ready_try, int n_ready), NULL)
743 /* This hook notifies the target about the result of the concluded current
744 round of multipass scheduling.
745 DATA is a pointer.
746 If DATA is non-NULL it points to target-specific data used for multipass
747 scheduling which corresponds to instruction at the start of the chain of
748 the winning solution. DATA is NULL when multipass scheduling cannot find
749 a good enough solution on current cycle and decides to retry later,
750 usually after advancing the cycle count. */
751 DEFHOOK
752 (first_cycle_multipass_end,
754 void, (const void *data), NULL)
756 /* This hook is called to initialize target-specific data for multipass
757 scheduling after it has been allocated.
758 DATA is a pointer to target-specific data that stores the effects
759 of instruction from which the algorithm backtracks on CPU that are not
760 described in DFA. */
761 DEFHOOK
762 (first_cycle_multipass_init,
764 void, (void *data), NULL)
766 /* This hook is called to finalize target-specific data for multipass
767 scheduling before it is deallocated.
768 DATA is a pointer to target-specific data that stores the effects
769 of instruction from which the algorithm backtracks on CPU that are not
770 described in DFA. */
771 DEFHOOK
772 (first_cycle_multipass_fini,
774 void, (void *data), NULL)
776 /* The following member value is pointer to a function called by
777 the insn scheduler before issuing insn passed as the third
778 parameter on given cycle. If the hook returns nonzero, the
779 insn is not issued on given processors cycle. Instead of that,
780 the processor cycle is advanced. If the value passed through
781 the last parameter is zero, the insn ready queue is not sorted
782 on the new cycle start as usually. The first parameter passes
783 file for debugging output. The second one passes the scheduler
784 verbose level of the debugging output. The forth and the fifth
785 parameter values are correspondingly processor cycle on which
786 the previous insn has been issued and the current processor cycle. */
787 DEFHOOK
788 (dfa_new_cycle,
790 int, (FILE *dump, int verbose, rtx insn, int last_clock,
791 int clock, int *sort_p),
792 NULL)
794 /* The following member value is a pointer to a function called by the
795 insn scheduler. It should return true if there exists a dependence
796 which is considered costly by the target, between the insn
797 DEP_PRO (&_DEP), and the insn DEP_CON (&_DEP). The first parameter is
798 the dep that represents the dependence between the two insns. The
799 second argument is the cost of the dependence as estimated by
800 the scheduler. The last argument is the distance in cycles
801 between the already scheduled insn (first parameter) and the
802 second insn (second parameter). */
803 DEFHOOK
804 (is_costly_dependence,
806 bool, (struct _dep *_dep, int cost, int distance), NULL)
808 DEFHOOK_UNDOC
809 (adjust_cost_2,
810 "Given the current cost, @var{cost}, of an insn, @var{insn}, calculate and\
811 return a new cost based on its relationship to @var{dep_insn} through the\
812 dependence of weakness @var{dw}. The default is to make no adjustment.",
813 int, (rtx insn, int dep_type1, rtx dep_insn, int cost, int dw), NULL)
815 /* The following member value is a pointer to a function called
816 by the insn scheduler. This hook is called to notify the backend
817 that new instructions were emitted. */
818 DEFHOOK
819 (h_i_d_extended,
821 void, (void), NULL)
823 /* Next 5 functions are for multi-point scheduling. */
825 /* Allocate memory for scheduler context. */
826 DEFHOOK
827 (alloc_sched_context,
829 void *, (void), NULL)
831 /* Fills the context from the local machine scheduler context. */
832 DEFHOOK
833 (init_sched_context,
835 void, (void *tc, bool clean_p), NULL)
837 /* Sets local machine scheduler context to a saved value. */
838 DEFHOOK
839 (set_sched_context,
841 void, (void *tc), NULL)
843 /* Clears a scheduler context so it becomes like after init. */
844 DEFHOOK
845 (clear_sched_context,
847 void, (void *tc), NULL)
849 /* Frees the scheduler context. */
850 DEFHOOK
851 (free_sched_context,
853 void, (void *tc), NULL)
855 /* The following member value is a pointer to a function called
856 by the insn scheduler.
857 The first parameter is an instruction, the second parameter is the type
858 of the requested speculation, and the third parameter is a pointer to the
859 speculative pattern of the corresponding type (set if return value == 1).
860 It should return
861 -1, if there is no pattern, that will satisfy the requested speculation type,
862 0, if current pattern satisfies the requested speculation type,
863 1, if pattern of the instruction should be changed to the newly
864 generated one. */
865 DEFHOOK
866 (speculate_insn,
868 int, (rtx insn, int request, rtx *new_pat), NULL)
870 /* The following member value is a pointer to a function called
871 by the insn scheduler. It should return true if the check instruction
872 passed as the parameter needs a recovery block. */
873 DEFHOOK
874 (needs_block_p,
876 bool, (int dep_status), NULL)
878 /* The following member value is a pointer to a function called
879 by the insn scheduler. It should return a pattern for the check
880 instruction.
881 The first parameter is a speculative instruction, the second parameter
882 is the label of the corresponding recovery block (or null, if it is a
883 simple check). If the mutation of the check is requested (e.g. from
884 ld.c to chk.a), the third parameter is true - in this case the first
885 parameter is the previous check. */
886 DEFHOOK
887 (gen_spec_check,
889 rtx, (rtx insn, rtx label, int mutate_p), NULL)
891 /* The following member value is a pointer to a function controlling
892 what insns from the ready insn queue will be considered for the
893 multipass insn scheduling. If the hook returns zero for the insn
894 passed as the parameter, the insn will not be chosen to be
895 issued. This hook is used to discard speculative instructions,
896 that stand at the first position of the ready list. */
897 DEFHOOK
898 (first_cycle_multipass_dfa_lookahead_guard_spec,
900 bool, (const_rtx insn), NULL)
902 /* The following member value is a pointer to a function that provides
903 information about the speculation capabilities of the target.
904 The parameter is a pointer to spec_info variable. */
905 DEFHOOK
906 (set_sched_flags,
908 void, (struct spec_info_def *spec_info), NULL)
910 DEFHOOK_UNDOC
911 (get_insn_spec_ds,
912 "Return speculation types of instruction @var{insn}.",
913 int, (rtx insn), NULL)
915 DEFHOOK_UNDOC
916 (get_insn_checked_ds,
917 "Return speculation types that are checked for instruction @var{insn}",
918 int, (rtx insn), NULL)
920 DEFHOOK_UNDOC
921 (skip_rtx_p,
922 "Return bool if rtx scanning should just skip current layer and\
923 advance to the inner rtxes.",
924 bool, (const_rtx x), NULL)
926 /* The following member value is a pointer to a function that provides
927 information about the target resource-based lower bound which is
928 used by the swing modulo scheduler. The parameter is a pointer
929 to ddg variable. */
930 DEFHOOK
931 (sms_res_mii,
933 int, (struct ddg *g), NULL)
935 /* The following member value is a function that initializes dispatch
936 schedling and adds instructions to dispatch window according to its
937 parameters. */
938 DEFHOOK
939 (dispatch_do,
941 void, (rtx insn, int x),
942 hook_void_rtx_int)
944 /* The following member value is a a function that returns true is
945 dispatch schedling is supported in hardware and condition passed
946 as the second parameter is true. */
947 DEFHOOK
948 (dispatch,
950 bool, (rtx insn, int x),
951 hook_bool_rtx_int_false)
953 HOOK_VECTOR_END (sched)
955 /* Functions relating to vectorization. */
956 #undef HOOK_PREFIX
957 #define HOOK_PREFIX "TARGET_VECTORIZE_"
958 HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
960 /* The following member value is a pointer to a function called
961 by the vectorizer, and return the decl of the target builtin
962 function. */
963 DEFHOOK
964 (builtin_mask_for_load,
966 tree, (void), NULL)
968 /* Returns a code for builtin that realizes vectorized version of
969 function, or NULL_TREE if not available. */
970 DEFHOOK
971 (builtin_vectorized_function,
973 tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
974 default_builtin_vectorized_function)
976 /* Returns a function declaration for a builtin that realizes the
977 vector conversion, or NULL_TREE if not available. */
978 DEFHOOK
979 (builtin_conversion,
981 tree, (unsigned code, tree dest_type, tree src_type),
982 default_builtin_vectorized_conversion)
984 /* Target builtin that implements vector widening multiplication.
985 builtin_mul_widen_eve computes the element-by-element products
986 for the even elements, and builtin_mul_widen_odd computes the
987 element-by-element products for the odd elements. */
988 DEFHOOK
989 (builtin_mul_widen_even,
991 tree, (tree x), NULL)
993 DEFHOOK
994 (builtin_mul_widen_odd,
996 tree, (tree x), NULL)
998 /* Cost of different vector/scalar statements in vectorization cost
999 model. In case of misaligned vector loads and stores the cost depends
1000 on the data type and misalignment value. */
1001 DEFHOOK
1002 (builtin_vectorization_cost,
1004 int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
1005 default_builtin_vectorization_cost)
1007 /* Return true if vector alignment is reachable (by peeling N
1008 iterations) for the given type. */
1009 DEFHOOK
1010 (vector_alignment_reachable,
1012 bool, (const_tree type, bool is_packed),
1013 default_builtin_vector_alignment_reachable)
1015 /* Target builtin that implements vector permute. */
1016 DEFHOOK
1017 (builtin_vec_perm,
1019 tree, (tree type, tree *mask_element_type), NULL)
1021 /* Return true if a vector created for builtin_vec_perm is valid. */
1022 DEFHOOK
1023 (builtin_vec_perm_ok,
1025 bool, (tree vec_type, tree mask),
1026 hook_bool_tree_tree_true)
1028 /* Return true if the target supports misaligned store/load of a
1029 specific factor denoted in the third parameter. The last parameter
1030 is true if the access is defined in a packed struct. */
1031 DEFHOOK
1032 (support_vector_misalignment,
1034 bool,
1035 (enum machine_mode mode, const_tree type, int misalignment, bool is_packed),
1036 default_builtin_support_vector_misalignment)
1038 /* Returns the preferred mode for SIMD operations for the specified
1039 scalar mode. */
1040 DEFHOOK
1041 (preferred_simd_mode,
1043 enum machine_mode,
1044 (enum machine_mode mode),
1045 default_preferred_simd_mode)
1047 /* Returns a mask of vector sizes to iterate over when auto-vectorizing
1048 after processing the preferred one derived from preferred_simd_mode. */
1049 DEFHOOK
1050 (autovectorize_vector_sizes,
1052 unsigned int,
1053 (void),
1054 default_autovectorize_vector_sizes)
1056 HOOK_VECTOR_END (vectorize)
1058 #undef HOOK_PREFIX
1059 #define HOOK_PREFIX "TARGET_"
1061 /* The initial value of target_flags. */
1062 DEFHOOKPOD
1063 (default_target_flags,
1065 int, 0)
1067 /* Allow target specific overriding of option settings after options have
1068 been changed by an attribute or pragma or when it is reset at the
1069 end of the code affected by an attribute or pragma. */
1070 DEFHOOK
1071 (override_options_after_change,
1073 void, (void),
1074 hook_void_void)
1076 /* Handle target switch DECODED for options structures OPTS and
1077 OPTS_SET, at location LOC. Return true if the switch was valid. */
1078 DEFHOOK
1079 (handle_option,
1081 bool, (struct gcc_options *opts, struct gcc_options *opts_set,
1082 const struct cl_decoded_option *decoded,
1083 unsigned int /*location_t*/ loc),
1084 default_target_handle_option)
1086 /* Display extra, target specific information in response to a
1087 --target-help switch. */
1088 DEFHOOK
1089 (help,
1091 void, (void), NULL)
1093 DEFHOOK_UNDOC
1094 (eh_return_filter_mode,
1095 "Return machine mode for filter value.",
1096 enum machine_mode, (void),
1097 default_eh_return_filter_mode)
1099 /* Return machine mode for libgcc expanded cmp instructions. */
1100 DEFHOOK
1101 (libgcc_cmp_return_mode,
1103 enum machine_mode, (void),
1104 default_libgcc_cmp_return_mode)
1106 /* Return machine mode for libgcc expanded shift instructions. */
1107 DEFHOOK
1108 (libgcc_shift_count_mode,
1110 enum machine_mode, (void),
1111 default_libgcc_shift_count_mode)
1113 /* Return machine mode to be used for _Unwind_Word type. */
1114 DEFHOOK
1115 (unwind_word_mode,
1117 enum machine_mode, (void),
1118 default_unwind_word_mode)
1120 /* Given two decls, merge their attributes and return the result. */
1121 DEFHOOK
1122 (merge_decl_attributes,
1124 tree, (tree olddecl, tree newdecl),
1125 merge_decl_attributes)
1127 /* Given two types, merge their attributes and return the result. */
1128 DEFHOOK
1129 (merge_type_attributes,
1131 tree, (tree type1, tree type2),
1132 merge_type_attributes)
1134 /* Table of machine attributes and functions to handle them.
1135 Ignored if NULL. */
1136 DEFHOOKPOD
1137 (attribute_table,
1139 const struct attribute_spec *, NULL)
1141 /* Return true iff attribute NAME expects a plain identifier as its first
1142 argument. */
1143 DEFHOOK
1144 (attribute_takes_identifier_p,
1146 bool, (const_tree name),
1147 hook_bool_const_tree_false)
1149 /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible,
1150 one if they are compatible and two if they are nearly compatible
1151 (which causes a warning to be generated). */
1152 DEFHOOK
1153 (comp_type_attributes,
1155 int, (const_tree type1, const_tree type2),
1156 hook_int_const_tree_const_tree_1)
1158 /* Assign default attributes to the newly defined TYPE. */
1159 DEFHOOK
1160 (set_default_type_attributes,
1162 void, (tree type),
1163 hook_void_tree)
1165 /* Insert attributes on the newly created DECL. */
1166 DEFHOOK
1167 (insert_attributes,
1169 void, (tree node, tree *attr_ptr),
1170 hook_void_tree_treeptr)
1172 /* Return true if FNDECL (which has at least one machine attribute)
1173 can be inlined despite its machine attributes, false otherwise. */
1174 DEFHOOK
1175 (function_attribute_inlinable_p,
1177 bool, (const_tree fndecl),
1178 hook_bool_const_tree_false)
1180 /* Return true if bitfields in RECORD_TYPE should follow the
1181 Microsoft Visual C++ bitfield layout rules. */
1182 DEFHOOK
1183 (ms_bitfield_layout_p,
1185 bool, (const_tree record_type),
1186 hook_bool_const_tree_false)
1188 /* For now this is only an interface to WORDS_BIG_ENDIAN for
1189 target-independent code like the front ends, need performance testing
1190 before switching completely to the target hook. */
1191 DEFHOOK_UNDOC
1192 (words_big_endian,
1194 bool, (void),
1195 targhook_words_big_endian)
1197 /* Likewise for FLOAT_WORDS_BIG_ENDIAN. */
1198 DEFHOOK_UNDOC
1199 (float_words_big_endian,
1201 bool, (void),
1202 targhook_float_words_big_endian)
1204 /* True if the target supports decimal floating point. */
1205 DEFHOOK
1206 (decimal_float_supported_p,
1208 bool, (void),
1209 default_decimal_float_supported_p)
1211 /* True if the target supports fixed-point. */
1212 DEFHOOK
1213 (fixed_point_supported_p,
1215 bool, (void),
1216 default_fixed_point_supported_p)
1218 /* Return true if anonymous bitfields affect structure alignment. */
1219 DEFHOOK
1220 (align_anon_bitfield,
1222 bool, (void),
1223 hook_bool_void_false)
1225 /* Return true if volatile bitfields should use the narrowest type possible.
1226 Return false if they should use the container type. */
1227 DEFHOOK
1228 (narrow_volatile_bitfield,
1230 bool, (void),
1231 hook_bool_void_false)
1233 /* Set up target-specific built-in functions. */
1234 DEFHOOK
1235 (init_builtins,
1237 void, (void),
1238 hook_void_void)
1240 /* Initialize (if INITIALIZE_P is true) and return the target-specific
1241 built-in function decl for CODE.
1242 Return NULL if that is not possible. Return error_mark_node if CODE
1243 is outside of the range of valid target builtin function codes. */
1244 DEFHOOK
1245 (builtin_decl,
1247 tree, (unsigned code, bool initialize_p), NULL)
1249 /* Expand a target-specific builtin. */
1250 DEFHOOK
1251 (expand_builtin,
1253 rtx,
1254 (tree exp, rtx target, rtx subtarget, enum machine_mode mode, int ignore),
1255 default_expand_builtin)
1257 /* Select a replacement for a target-specific builtin. This is done
1258 *before* regular type checking, and so allows the target to
1259 implement a crude form of function overloading. The result is a
1260 complete expression that implements the operation. PARAMS really
1261 has type VEC(tree,gc)*, but we don't want to include tree.h here. */
1262 DEFHOOK
1263 (resolve_overloaded_builtin,
1265 tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
1267 /* Fold a target-specific builtin. */
1268 DEFHOOK
1269 (fold_builtin,
1271 tree, (tree fndecl, int n_args, tree *argp, bool ignore),
1272 hook_tree_tree_int_treep_bool_null)
1274 /* Returns a code for a target-specific builtin that implements
1275 reciprocal of the function, or NULL_TREE if not available. */
1276 DEFHOOK
1277 (builtin_reciprocal,
1279 tree, (unsigned fn, bool md_fn, bool sqrt),
1280 default_builtin_reciprocal)
1282 /* For a vendor-specific TYPE, return a pointer to a statically-allocated
1283 string containing the C++ mangling for TYPE. In all other cases, return
1284 NULL. */
1285 DEFHOOK
1286 (mangle_type,
1288 const char *, (const_tree type),
1289 hook_constcharptr_const_tree_null)
1291 /* Make any adjustments to libfunc names needed for this target. */
1292 DEFHOOK
1293 (init_libfuncs,
1295 void, (void),
1296 hook_void_void)
1298 /* Given a decl, a section name, and whether the decl initializer
1299 has relocs, choose attributes for the section. */
1300 /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
1301 DEFHOOK
1302 (section_type_flags,
1304 unsigned int, (tree decl, const char *name, int reloc),
1305 default_section_type_flags)
1307 /* True if new jumps cannot be created, to replace existing ones or
1308 not, at the current point in the compilation. */
1309 DEFHOOK
1310 (cannot_modify_jumps_p,
1312 bool, (void),
1313 hook_bool_void_false)
1315 /* Return a register class for which branch target register
1316 optimizations should be applied. */
1317 DEFHOOK
1318 (branch_target_register_class,
1320 reg_class_t, (void),
1321 default_branch_target_register_class)
1323 /* Return true if branch target register optimizations should include
1324 callee-saved registers that are not already live during the current
1325 function. AFTER_PE_GEN is true if prologues and epilogues have
1326 already been generated. */
1327 DEFHOOK
1328 (branch_target_register_callee_saved,
1330 bool, (bool after_prologue_epilogue_gen),
1331 hook_bool_bool_false)
1333 /* Return true if the target supports conditional execution. */
1334 DEFHOOK
1335 (have_conditional_execution,
1337 bool, (void),
1338 default_have_conditional_execution)
1340 /* Return a new value for loop unroll size. */
1341 DEFHOOK
1342 (loop_unroll_adjust,
1344 unsigned, (unsigned nunroll, struct loop *loop),
1345 NULL)
1347 /* True if the constant X cannot be placed in the constant pool. */
1348 DEFHOOK
1349 (cannot_force_const_mem,
1351 bool, (rtx x),
1352 hook_bool_rtx_false)
1354 DEFHOOK_UNDOC
1355 (cannot_copy_insn_p,
1356 "True if the insn @var{x} cannot be duplicated.",
1357 bool, (rtx), NULL)
1359 /* True if X is considered to be commutative. */
1360 DEFHOOK
1361 (commutative_p,
1363 bool, (const_rtx x, int outer_code),
1364 hook_bool_const_rtx_commutative_p)
1366 /* True if ADDR is an address-expression whose effect depends
1367 on the mode of the memory reference it is used in. */
1368 DEFHOOK
1369 (mode_dependent_address_p,
1371 bool, (const_rtx addr),
1372 default_mode_dependent_address_p)
1374 /* Given an invalid address X for a given machine mode, try machine-specific
1375 ways to make it legitimate. Return X or an invalid address on failure. */
1376 DEFHOOK
1377 (legitimize_address,
1379 rtx, (rtx x, rtx oldx, enum machine_mode mode),
1380 default_legitimize_address)
1382 /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS. */
1383 DEFHOOK
1384 (delegitimize_address,
1386 rtx, (rtx x),
1387 delegitimize_mem_from_attrs)
1389 /* Given an address RTX, say whether it is valid. */
1390 DEFHOOK
1391 (legitimate_address_p,
1393 bool, (enum machine_mode mode, rtx x, bool strict),
1394 default_legitimate_address_p)
1396 /* True if the given constant can be put into an object_block. */
1397 DEFHOOK
1398 (use_blocks_for_constant_p,
1400 bool, (enum machine_mode mode, const_rtx x),
1401 hook_bool_mode_const_rtx_false)
1403 /* The minimum and maximum byte offsets for anchored addresses. */
1404 DEFHOOKPOD
1405 (min_anchor_offset,
1407 HOST_WIDE_INT, 0)
1409 DEFHOOKPOD
1410 (max_anchor_offset,
1412 HOST_WIDE_INT, 0)
1414 /* True if section anchors can be used to access the given symbol. */
1415 DEFHOOK
1416 (use_anchors_for_symbol_p,
1418 bool, (const_rtx x),
1419 default_use_anchors_for_symbol_p)
1421 /* True if it is OK to do sibling call optimization for the specified
1422 call expression EXP. DECL will be the called function, or NULL if
1423 this is an indirect call. */
1424 DEFHOOK
1425 (function_ok_for_sibcall,
1427 bool, (tree decl, tree exp),
1428 hook_bool_tree_tree_false)
1430 /* Establish appropriate back-end context for processing the function
1431 FNDECL. The argument might be NULL to indicate processing at top
1432 level, outside of any function scope. */
1433 DEFHOOK
1434 (set_current_function,
1436 void, (tree decl), hook_void_tree)
1438 /* True if EXP should be placed in a "small data" section. */
1439 DEFHOOK
1440 (in_small_data_p,
1442 bool, (const_tree exp),
1443 hook_bool_const_tree_false)
1445 /* True if EXP names an object for which name resolution must resolve
1446 to the current executable or shared library. */
1447 DEFHOOK
1448 (binds_local_p,
1450 bool, (const_tree exp),
1451 default_binds_local_p)
1453 /* Check if profiling code is before or after prologue. */
1454 DEFHOOK
1455 (profile_before_prologue,
1456 "It returns true if target wants profile code emitted before prologue.\n\n\
1457 The default version of this hook use the target macro\n\
1458 @code{PROFILE_BEFORE_PROLOGUE}.",
1459 bool, (void),
1460 default_profile_before_prologue)
1462 /* Modify and return the identifier of a DECL's external name,
1463 originally identified by ID, as required by the target,
1464 (eg, append @nn to windows32 stdcall function names).
1465 The default is to return ID without modification. */
1466 DEFHOOK
1467 (mangle_decl_assembler_name,
1469 tree, (tree decl, tree id),
1470 default_mangle_decl_assembler_name)
1472 /* Do something target-specific to record properties of the DECL into
1473 the associated SYMBOL_REF. */
1474 DEFHOOK
1475 (encode_section_info,
1477 void, (tree decl, rtx rtl, int new_decl_p),
1478 default_encode_section_info)
1480 /* Undo the effects of encode_section_info on the symbol string. */
1481 DEFHOOK
1482 (strip_name_encoding,
1484 const char *, (const char *name),
1485 default_strip_name_encoding)
1487 /* If shift optabs for MODE are known to always truncate the shift count,
1488 return the mask that they apply. Return 0 otherwise. */
1489 DEFHOOK
1490 (shift_truncation_mask,
1492 unsigned HOST_WIDE_INT, (enum machine_mode mode),
1493 default_shift_truncation_mask)
1495 /* Return the number of divisions in the given MODE that should be present,
1496 so that it is profitable to turn the division into a multiplication by
1497 the reciprocal. */
1498 DEFHOOK
1499 (min_divisions_for_recip_mul,
1501 unsigned int, (enum machine_mode mode),
1502 default_min_divisions_for_recip_mul)
1504 /* If the representation of integral MODE is such that values are
1505 always sign-extended to a wider mode MODE_REP then return
1506 SIGN_EXTEND. Return UNKNOWN otherwise. */
1507 /* Note that the return type ought to be RTX_CODE, but that's not
1508 necessarily defined at this point. */
1509 DEFHOOK
1510 (mode_rep_extended,
1512 int, (enum machine_mode mode, enum machine_mode rep_mode),
1513 default_mode_rep_extended)
1515 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))). */
1516 DEFHOOK
1517 (valid_pointer_mode,
1519 bool, (enum machine_mode mode),
1520 default_valid_pointer_mode)
1522 /* Disambiguate with errno. */
1523 DEFHOOK
1524 (ref_may_alias_errno,
1525 "Define this to return nonzero if the memory reference @var{ref}\
1526 may alias with the system C library errno location. The default\
1527 version of this hook assumes the system C library errno location\
1528 is either a declaration of type int or accessed by dereferencing\
1529 a pointer to int.",
1530 bool, (struct ao_ref_s *ref),
1531 default_ref_may_alias_errno)
1533 /* Support for named address spaces. */
1534 #undef HOOK_PREFIX
1535 #define HOOK_PREFIX "TARGET_ADDR_SPACE_"
1536 HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
1538 /* MODE to use for a pointer into another address space. */
1539 DEFHOOK
1540 (pointer_mode,
1542 enum machine_mode, (addr_space_t address_space),
1543 default_addr_space_pointer_mode)
1545 /* MODE to use for an address in another address space. */
1546 DEFHOOK
1547 (address_mode,
1549 enum machine_mode, (addr_space_t address_space),
1550 default_addr_space_address_mode)
1552 /* True if MODE is valid for a pointer in __attribute__((mode("MODE")))
1553 in another address space. */
1554 DEFHOOK
1555 (valid_pointer_mode,
1557 bool, (enum machine_mode mode, addr_space_t as),
1558 default_addr_space_valid_pointer_mode)
1560 /* True if an address is a valid memory address to a given named address
1561 space for a given mode. */
1562 DEFHOOK
1563 (legitimate_address_p,
1565 bool, (enum machine_mode mode, rtx exp, bool strict, addr_space_t as),
1566 default_addr_space_legitimate_address_p)
1568 /* Return an updated address to convert an invalid pointer to a named
1569 address space to a valid one. If NULL_RTX is returned use machine
1570 independent methods to make the address valid. */
1571 DEFHOOK
1572 (legitimize_address,
1574 rtx, (rtx x, rtx oldx, enum machine_mode mode, addr_space_t as),
1575 default_addr_space_legitimize_address)
1577 /* True if one named address space is a subset of another named address. */
1578 DEFHOOK
1579 (subset_p,
1581 bool, (addr_space_t superset, addr_space_t subset),
1582 default_addr_space_subset_p)
1584 /* Function to convert an rtl expression from one address space to another. */
1585 DEFHOOK
1586 (convert,
1588 rtx, (rtx op, tree from_type, tree to_type),
1589 default_addr_space_convert)
1591 HOOK_VECTOR_END (addr_space)
1593 #undef HOOK_PREFIX
1594 #define HOOK_PREFIX "TARGET_"
1596 /* True if MODE is valid for the target. By "valid", we mean able to
1597 be manipulated in non-trivial ways. In particular, this means all
1598 the arithmetic is supported. */
1599 DEFHOOK
1600 (scalar_mode_supported_p,
1602 bool, (enum machine_mode mode),
1603 default_scalar_mode_supported_p)
1605 /* Similarly for vector modes. "Supported" here is less strict. At
1606 least some operations are supported; need to check optabs or builtins
1607 for further details. */
1608 DEFHOOK
1609 (vector_mode_supported_p,
1611 bool, (enum machine_mode mode),
1612 hook_bool_mode_false)
1614 /* Compute cost of moving data from a register of class FROM to one of
1615 TO, using MODE. */
1616 DEFHOOK
1617 (register_move_cost,
1619 int, (enum machine_mode mode, reg_class_t from, reg_class_t to),
1620 default_register_move_cost)
1622 /* Compute cost of moving registers to/from memory. */
1623 /* ??? Documenting the argument types for this hook requires a GFDL
1624 license grant. Also, the documentation uses a different name for RCLASS. */
1625 DEFHOOK
1626 (memory_move_cost,
1628 int, (enum machine_mode mode, reg_class_t rclass, bool in),
1629 default_memory_move_cost)
1631 /* True for MODE if the target expects that registers in this mode will
1632 be allocated to registers in a small register class. The compiler is
1633 allowed to use registers explicitly used in the rtl as spill registers
1634 but it should prevent extending the lifetime of these registers. */
1635 DEFHOOK
1636 (small_register_classes_for_mode_p,
1638 bool, (enum machine_mode mode),
1639 hook_bool_mode_false)
1641 /* Register number for a flags register. Only needs to be defined if the
1642 target is constrainted to use post-reload comparison elimination. */
1643 DEFHOOKPOD
1644 (flags_regnum,
1645 "If the target has a dedicated flags register, and it needs to use the\
1646 post-reload comparison elimination pass, then this value should be set\
1647 appropriately.",
1648 unsigned int, INVALID_REGNUM)
1650 /* Compute a (partial) cost for rtx X. Return true if the complete
1651 cost has been computed, and false if subexpressions should be
1652 scanned. In either case, *TOTAL contains the cost result. */
1653 /* Note that CODE and OUTER_CODE ought to be RTX_CODE, but that's
1654 not necessarily defined at this point. */
1655 DEFHOOK
1656 (rtx_costs,
1658 bool, (rtx x, int code, int outer_code, int *total, bool speed),
1659 hook_bool_rtx_int_int_intp_bool_false)
1661 /* Compute the cost of X, used as an address. Never called with
1662 invalid addresses. */
1663 DEFHOOK
1664 (address_cost,
1666 int, (rtx address, bool speed),
1667 default_address_cost)
1669 /* Return where to allocate pseudo for a given hard register initial value. */
1670 DEFHOOK
1671 (allocate_initial_value,
1673 rtx, (rtx hard_reg), NULL)
1675 /* Return nonzero if evaluating UNSPEC[_VOLATILE] X might cause a trap.
1676 FLAGS has the same meaning as in rtlanal.c: may_trap_p_1. */
1677 DEFHOOK
1678 (unspec_may_trap_p,
1680 int, (const_rtx x, unsigned flags),
1681 default_unspec_may_trap_p)
1683 /* Given a register, this hook should return a parallel of registers
1684 to represent where to find the register pieces. Define this hook
1685 if the register and its mode are represented in Dwarf in
1686 non-contiguous locations, or if the register should be
1687 represented in more than one register in Dwarf. Otherwise, this
1688 hook should return NULL_RTX. */
1689 DEFHOOK
1690 (dwarf_register_span,
1692 rtx, (rtx reg),
1693 hook_rtx_rtx_null)
1695 /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table
1696 entries not corresponding directly to registers below
1697 FIRST_PSEUDO_REGISTER, this hook should generate the necessary
1698 code, given the address of the table. */
1699 DEFHOOK
1700 (init_dwarf_reg_sizes_extra,
1702 void, (tree address),
1703 hook_void_tree)
1705 /* Fetch the fixed register(s) which hold condition codes, for
1706 targets where it makes sense to look for duplicate assignments to
1707 the condition codes. This should return true if there is such a
1708 register, false otherwise. The arguments should be set to the
1709 fixed register numbers. Up to two condition code registers are
1710 supported. If there is only one for this target, the int pointed
1711 at by the second argument should be set to -1. */
1712 DEFHOOK
1713 (fixed_condition_code_regs,
1715 bool, (unsigned int *p1, unsigned int *p2),
1716 hook_bool_uintp_uintp_false)
1718 /* If two condition code modes are compatible, return a condition
1719 code mode which is compatible with both, such that a comparison
1720 done in the returned mode will work for both of the original
1721 modes. If the condition code modes are not compatible, return
1722 VOIDmode. */
1723 DEFHOOK
1724 (cc_modes_compatible,
1726 enum machine_mode, (enum machine_mode m1, enum machine_mode m2),
1727 default_cc_modes_compatible)
1729 /* Do machine-dependent code transformations. Called just before
1730 delayed-branch scheduling. */
1731 DEFHOOK
1732 (machine_dependent_reorg,
1734 void, (void), NULL)
1736 /* Create the __builtin_va_list type. */
1737 DEFHOOK
1738 (build_builtin_va_list,
1740 tree, (void),
1741 std_build_builtin_va_list)
1743 /* Enumerate the va list variants. */
1744 DEFHOOK
1745 (enum_va_list_p,
1747 int, (int idx, const char **pname, tree *ptree),
1748 NULL)
1750 /* Get the cfun/fndecl calling abi __builtin_va_list type. */
1751 DEFHOOK
1752 (fn_abi_va_list,
1754 tree, (tree fndecl),
1755 std_fn_abi_va_list)
1757 /* Get the __builtin_va_list type dependent on input type. */
1758 DEFHOOK
1759 (canonical_va_list_type,
1761 tree, (tree type),
1762 std_canonical_va_list_type)
1764 /* ??? Documenting this hook requires a GFDL license grant. */
1765 DEFHOOK_UNDOC
1766 (expand_builtin_va_start,
1767 "Expand the @code{__builtin_va_start} builtin.",
1768 void, (tree valist, rtx nextarg), NULL)
1770 /* Gimplifies a VA_ARG_EXPR. */
1771 DEFHOOK
1772 (gimplify_va_arg_expr,
1774 tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
1775 std_gimplify_va_arg_expr)
1777 /* Validity-checking routines for PCH files, target-specific.
1778 get_pch_validity returns a pointer to the data to be stored,
1779 and stores the size in its argument. pch_valid_p gets the same
1780 information back and returns NULL if the PCH is valid,
1781 or an error message if not. */
1782 DEFHOOK
1783 (get_pch_validity,
1785 void *, (size_t *sz),
1786 default_get_pch_validity)
1788 DEFHOOK
1789 (pch_valid_p,
1791 const char *, (const void *data, size_t sz),
1792 default_pch_valid_p)
1794 /* If nonnull, this function checks whether a PCH file with the
1795 given set of target flags can be used. It returns NULL if so,
1796 otherwise it returns an error message. */
1797 DEFHOOK
1798 (check_pch_target_flags,
1800 const char *, (int pch_flags), NULL)
1802 /* True if the compiler should give an enum type only as many
1803 bytes as it takes to represent the range of possible values of
1804 that type. */
1805 DEFHOOK
1806 (default_short_enums,
1808 bool, (void),
1809 hook_bool_void_false)
1811 /* This target hook returns an rtx that is used to store the address
1812 of the current frame into the built-in setjmp buffer. */
1813 DEFHOOK
1814 (builtin_setjmp_frame_value,
1816 rtx, (void),
1817 default_builtin_setjmp_frame_value)
1819 /* This target hook should add STRING_CST trees for any hard regs
1820 the port wishes to automatically clobber for an asm. */
1821 DEFHOOK
1822 (md_asm_clobbers,
1824 tree, (tree outputs, tree inputs, tree clobbers),
1825 hook_tree_tree_tree_tree_3rd_identity)
1827 /* This target hook allows the backend to specify a calling convention
1828 in the debug information. This function actually returns an
1829 enum dwarf_calling_convention, but because of forward declarations
1830 and not wanting to include dwarf2.h everywhere target.h is included
1831 the function is being declared as an int. */
1832 DEFHOOK
1833 (dwarf_calling_convention,
1835 int, (const_tree function),
1836 hook_int_const_tree_0)
1838 /* This target hook allows the backend to emit frame-related insns that
1839 contain UNSPECs or UNSPEC_VOLATILEs. The call frame debugging info
1840 engine will invoke it on insns of the form
1841 (set (reg) (unspec [...] UNSPEC_INDEX))
1843 (set (reg) (unspec_volatile [...] UNSPECV_INDEX))
1844 to let the backend emit the call frame instructions. */
1845 DEFHOOK
1846 (dwarf_handle_frame_unspec,
1848 void, (const char *label, rtx pattern, int index), NULL)
1850 /* ??? Documenting this hook requires a GFDL license grant. */
1851 DEFHOOK_UNDOC
1852 (stdarg_optimize_hook,
1853 "Perform architecture specific checking of statements gimplified\
1854 from @code{VA_ARG_EXPR}. @var{stmt} is the statement. Returns true if\
1855 the statement doesn't need to be checked for @code{va_list} references.",
1856 bool, (struct stdarg_info *ai, const_gimple stmt), NULL)
1858 /* This target hook allows the operating system to override the DECL
1859 that represents the external variable that contains the stack
1860 protection guard variable. The type of this DECL is ptr_type_node. */
1861 DEFHOOK
1862 (stack_protect_guard,
1864 tree, (void),
1865 default_stack_protect_guard)
1867 /* This target hook allows the operating system to override the CALL_EXPR
1868 that is invoked when a check vs the guard variable fails. */
1869 DEFHOOK
1870 (stack_protect_fail,
1872 tree, (void),
1873 default_external_stack_protect_fail)
1875 DEFHOOK
1876 (supports_split_stack,
1877 "Whether this target supports splitting the stack when the options\
1878 described in @var{opts} have been passed. This is called\
1879 after options have been parsed, so the target may reject splitting\
1880 the stack in some configurations. The default version of this hook\
1881 returns false. If @var{report} is true, this function may issue a warning\
1882 or error; if @var{report} is false, it must simply return a value",
1883 bool, (bool report, struct gcc_options *opts),
1884 hook_bool_bool_gcc_optionsp_false)
1886 /* Returns NULL if target supports the insn within a doloop block,
1887 otherwise it returns an error message. */
1888 DEFHOOK
1889 (invalid_within_doloop,
1891 const char *, (const_rtx insn),
1892 default_invalid_within_doloop)
1894 DEFHOOK
1895 (valid_dllimport_attribute_p,
1896 "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\
1897 specified. Use this hook if the target needs to add extra validation\
1898 checks to @code{handle_dll_attribute}.",
1899 bool, (const_tree decl),
1900 hook_bool_const_tree_true)
1902 /* If non-zero, align constant anchors in CSE to a multiple of this
1903 value. */
1904 DEFHOOKPOD
1905 (const_anchor,
1907 unsigned HOST_WIDE_INT, 0)
1909 /* Functions relating to calls - argument passing, returns, etc. */
1910 /* Members of struct call have no special macro prefix. */
1911 HOOK_VECTOR (TARGET_CALLS, calls)
1913 DEFHOOK
1914 (promote_function_mode,
1916 enum machine_mode, (const_tree type, enum machine_mode mode, int *punsignedp,
1917 const_tree funtype, int for_return),
1918 default_promote_function_mode)
1920 DEFHOOK
1921 (promote_prototypes,
1923 bool, (const_tree fntype),
1924 hook_bool_const_tree_false)
1926 DEFHOOK
1927 (struct_value_rtx,
1929 rtx, (tree fndecl, int incoming),
1930 hook_rtx_tree_int_null)
1931 DEFHOOK
1932 (return_in_memory,
1934 bool, (const_tree type, const_tree fntype),
1935 default_return_in_memory)
1937 DEFHOOK
1938 (return_in_msb,
1940 bool, (const_tree type),
1941 hook_bool_const_tree_false)
1943 /* Return true if a parameter must be passed by reference. TYPE may
1944 be null if this is a libcall. CA may be null if this query is
1945 from __builtin_va_arg. */
1946 DEFHOOK
1947 (pass_by_reference,
1949 bool,
1950 (CUMULATIVE_ARGS *cum, enum machine_mode mode, const_tree type, bool named),
1951 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
1953 DEFHOOK
1954 (expand_builtin_saveregs,
1956 rtx, (void),
1957 default_expand_builtin_saveregs)
1959 /* Returns pretend_argument_size. */
1960 DEFHOOK
1961 (setup_incoming_varargs,
1963 void, (CUMULATIVE_ARGS *args_so_far, enum machine_mode mode, tree type,
1964 int *pretend_args_size, int second_time),
1965 default_setup_incoming_varargs)
1967 DEFHOOK
1968 (strict_argument_naming,
1970 bool, (CUMULATIVE_ARGS *ca),
1971 hook_bool_CUMULATIVE_ARGS_false)
1973 /* Returns true if we should use
1974 targetm.calls.setup_incoming_varargs() and/or
1975 targetm.calls.strict_argument_naming(). */
1976 DEFHOOK
1977 (pretend_outgoing_varargs_named,
1979 bool, (CUMULATIVE_ARGS *ca),
1980 default_pretend_outgoing_varargs_named)
1982 /* Given a complex type T, return true if a parameter of type T
1983 should be passed as two scalars. */
1984 DEFHOOK
1985 (split_complex_arg,
1987 bool, (const_tree type), NULL)
1989 /* Return true if type T, mode MODE, may not be passed in registers,
1990 but must be passed on the stack. */
1991 /* ??? This predicate should be applied strictly after pass-by-reference.
1992 Need audit to verify that this is the case. */
1993 DEFHOOK
1994 (must_pass_in_stack,
1996 bool, (enum machine_mode mode, const_tree type),
1997 must_pass_in_stack_var_size_or_pad)
1999 /* Return true if type TYPE, mode MODE, which is passed by reference,
2000 should have the object copy generated by the callee rather than
2001 the caller. It is never called for TYPE requiring constructors. */
2002 DEFHOOK
2003 (callee_copies,
2005 bool,
2006 (CUMULATIVE_ARGS *cum, enum machine_mode mode, const_tree type, bool named),
2007 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
2009 /* Return zero for arguments passed entirely on the stack or entirely
2010 in registers. If passed in both, return the number of bytes passed
2011 in registers; the balance is therefore passed on the stack. */
2012 DEFHOOK
2013 (arg_partial_bytes,
2015 int, (CUMULATIVE_ARGS *cum, enum machine_mode mode, tree type, bool named),
2016 hook_int_CUMULATIVE_ARGS_mode_tree_bool_0)
2018 /* Update the state in CA to advance past an argument in the
2019 argument list. The values MODE, TYPE, and NAMED describe that
2020 argument. */
2021 DEFHOOK
2022 (function_arg_advance,
2024 void,
2025 (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type, bool named),
2026 default_function_arg_advance)
2028 /* Return zero if the argument described by the state of CA should
2029 be placed on a stack, or a hard register in which to store the
2030 argument. The values MODE, TYPE, and NAMED describe that
2031 argument. */
2032 DEFHOOK
2033 (function_arg,
2035 rtx, (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type,
2036 bool named),
2037 default_function_arg)
2039 /* Likewise, but for machines with register windows. Return the
2040 location where the argument will appear to the callee. */
2041 DEFHOOK
2042 (function_incoming_arg,
2044 rtx, (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type,
2045 bool named),
2046 default_function_incoming_arg)
2048 DEFHOOK
2049 (function_arg_boundary,
2051 unsigned int, (enum machine_mode mode, const_tree type),
2052 default_function_arg_boundary)
2054 /* Return the diagnostic message string if function without a prototype
2055 is not allowed for this 'val' argument; NULL otherwise. */
2056 DEFHOOK
2057 (invalid_arg_for_unprototyped_fn,
2059 const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
2060 hook_invalid_arg_for_unprototyped_fn)
2062 /* Return an rtx for the return value location of the function
2063 specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
2064 DEFHOOK
2065 (function_value,
2067 rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
2068 default_function_value)
2070 /* Return the rtx for the result of a libcall of mode MODE,
2071 calling the function FN_NAME. */
2072 DEFHOOK
2073 (libcall_value,
2075 rtx, (enum machine_mode mode, const_rtx fun),
2076 default_libcall_value)
2078 /* Return true if REGNO is a possible register number for
2079 a function value as seen by the caller. */
2080 DEFHOOK
2081 (function_value_regno_p,
2083 bool, (const unsigned int regno),
2084 default_function_value_regno_p)
2086 /* ??? Documenting this hook requires a GFDL license grant. */
2087 DEFHOOK_UNDOC
2088 (internal_arg_pointer,
2089 "Return an rtx for the argument pointer incoming to the\
2090 current function.",
2091 rtx, (void),
2092 default_internal_arg_pointer)
2094 /* Update the current function stack boundary if needed. */
2095 DEFHOOK
2096 (update_stack_boundary,
2098 void, (void), NULL)
2100 /* Handle stack alignment and return an rtx for Dynamic Realign
2101 Argument Pointer if necessary. */
2102 DEFHOOK
2103 (get_drap_rtx,
2105 rtx, (void), NULL)
2107 /* Return true if all function parameters should be spilled to the
2108 stack. */
2109 DEFHOOK
2110 (allocate_stack_slots_for_args,
2112 bool, (void),
2113 hook_bool_void_true)
2115 /* Return an rtx for the static chain for FNDECL. If INCOMING_P is true,
2116 then it should be for the callee; otherwise for the caller. */
2117 DEFHOOK
2118 (static_chain,
2120 rtx, (const_tree fndecl, bool incoming_p),
2121 default_static_chain)
2123 /* Fill in the trampoline at MEM with a call to FNDECL and a
2124 static chain value of CHAIN. */
2125 DEFHOOK
2126 (trampoline_init,
2128 void, (rtx m_tramp, tree fndecl, rtx static_chain),
2129 default_trampoline_init)
2131 /* Adjust the address of the trampoline in a target-specific way. */
2132 DEFHOOK
2133 (trampoline_adjust_address,
2135 rtx, (rtx addr), NULL)
2137 /* Return the number of bytes of its own arguments that a function
2138 pops on returning, or 0 if the function pops no arguments and the
2139 caller must therefore pop them all after the function returns. */
2140 /* ??? tm.texi has no types for the parameters. */
2141 DEFHOOK
2142 (return_pops_args,
2144 int, (tree fundecl, tree funtype, int size),
2145 default_return_pops_args)
2147 /* Return a mode wide enough to copy any function value that might be
2148 returned. */
2149 DEFHOOK
2150 (get_raw_result_mode,
2151 "This target hook returns the mode to be used when accessing raw return\
2152 registers in @code{__builtin_return}. Define this macro if the value\
2153 in @var{reg_raw_mode} is not correct.",
2154 enum machine_mode, (int regno),
2155 default_get_reg_raw_mode)
2157 /* Return a mode wide enough to copy any argument value that might be
2158 passed. */
2159 DEFHOOK
2160 (get_raw_arg_mode,
2161 "This target hook returns the mode to be used when accessing raw argument\
2162 registers in @code{__builtin_apply_args}. Define this macro if the value\
2163 in @var{reg_raw_mode} is not correct.",
2164 enum machine_mode, (int regno),
2165 default_get_reg_raw_mode)
2167 HOOK_VECTOR_END (calls)
2169 /* Return the diagnostic message string if conversion from FROMTYPE
2170 to TOTYPE is not allowed, NULL otherwise. */
2171 DEFHOOK
2172 (invalid_conversion,
2174 const char *, (const_tree fromtype, const_tree totype),
2175 hook_constcharptr_const_tree_const_tree_null)
2177 /* Return the diagnostic message string if the unary operation OP is
2178 not permitted on TYPE, NULL otherwise. */
2179 DEFHOOK
2180 (invalid_unary_op,
2182 const char *, (int op, const_tree type),
2183 hook_constcharptr_int_const_tree_null)
2185 /* Return the diagnostic message string if the binary operation OP
2186 is not permitted on TYPE1 and TYPE2, NULL otherwise. */
2187 DEFHOOK
2188 (invalid_binary_op,
2190 const char *, (int op, const_tree type1, const_tree type2),
2191 hook_constcharptr_int_const_tree_const_tree_null)
2193 /* Return the diagnostic message string if TYPE is not valid as a
2194 function parameter type, NULL otherwise. */
2195 DEFHOOK
2196 (invalid_parameter_type,
2198 const char *, (const_tree type),
2199 hook_constcharptr_const_tree_null)
2201 /* Return the diagnostic message string if TYPE is not valid as a
2202 function return type, NULL otherwise. */
2203 DEFHOOK
2204 (invalid_return_type,
2206 const char *, (const_tree type),
2207 hook_constcharptr_const_tree_null)
2209 /* If values of TYPE are promoted to some other type when used in
2210 expressions (analogous to the integer promotions), return that type,
2211 or NULL_TREE otherwise. */
2212 DEFHOOK
2213 (promoted_type,
2215 tree, (const_tree type),
2216 hook_tree_const_tree_null)
2218 /* Convert EXPR to TYPE, if target-specific types with special conversion
2219 rules are involved. Return the converted expression, or NULL to apply
2220 the standard conversion rules. */
2221 DEFHOOK
2222 (convert_to_type,
2224 tree, (tree type, tree expr),
2225 hook_tree_tree_tree_null)
2227 /* Return the class for a secondary reload, and fill in extra information. */
2228 DEFHOOK
2229 (secondary_reload,
2231 reg_class_t,
2232 (bool in_p, rtx x, reg_class_t reload_class, enum machine_mode reload_mode,
2233 secondary_reload_info *sri),
2234 default_secondary_reload)
2236 /* Given an rtx X being reloaded into a reg required to be in class CLASS,
2237 return the class of reg to actually use. */
2238 DEFHOOK
2239 (preferred_reload_class,
2241 reg_class_t,
2242 (rtx x, reg_class_t rclass),
2243 default_preferred_reload_class)
2245 /* Like TARGET_PREFERRED_RELOAD_CLASS, but for output reloads instead of
2246 input reloads. */
2247 DEFHOOK
2248 (preferred_output_reload_class,
2250 reg_class_t,
2251 (rtx x, reg_class_t rclass),
2252 default_preferred_output_reload_class)
2254 DEFHOOK
2255 (class_likely_spilled_p,
2257 bool, (reg_class_t rclass),
2258 default_class_likely_spilled_p)
2260 DEFHOOK
2261 (preferred_rename_class,
2262 "A target hook that places additional preference on the register\
2263 class to use when it is necessary to rename a register in class\
2264 @var{rclass} to another class, or perhaps @var{NO_REGS}, if no\
2265 preferred register class is found or hook @code{preferred_rename_class}\
2266 is not implemented.\
2267 Sometimes returning a more restrictive class makes better code. For\
2268 example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\
2269 smaller than instructions using @code{GENERIC_REGS}. By returning\
2270 @code{LO_REGS} from @code{preferred_rename_class}, code size can\
2271 be reduced.",
2272 reg_class_t, (reg_class_t rclass),
2273 default_preferred_rename_class)
2275 /* This target hook allows the backend to perform additional
2276 processing while initializing for variable expansion. */
2277 DEFHOOK
2278 (expand_to_rtl_hook,
2280 void, (void),
2281 hook_void_void)
2283 /* This target hook allows the backend to perform additional
2284 instantiations on rtx that are not actually in insns yet,
2285 but will be later. */
2286 DEFHOOK
2287 (instantiate_decls,
2289 void, (void),
2290 hook_void_void)
2292 /* Return true if is OK to use a hard register REGNO as scratch register
2293 in peephole2. */
2294 DEFHOOK
2295 (hard_regno_scratch_ok,
2297 bool, (unsigned int regno),
2298 default_hard_regno_scratch_ok)
2300 /* Return the smallest number of different values for which it is best to
2301 use a jump-table instead of a tree of conditional branches. */
2302 DEFHOOK
2303 (case_values_threshold,
2305 unsigned int, (void),
2306 default_case_values_threshold)
2308 /* Retutn true if a function must have and use a frame pointer. */
2309 DEFHOOK
2310 (frame_pointer_required,
2312 bool, (void),
2313 hook_bool_void_false)
2315 /* Returns true if the compiler is allowed to try to replace register number
2316 from-reg with register number to-reg. */
2317 DEFHOOK
2318 (can_eliminate,
2320 bool, (const int from_reg, const int to_reg),
2321 hook_bool_const_int_const_int_true)
2323 /* Modify any or all of fixed_regs, call_used_regs, global_regs,
2324 reg_names, and reg_class_contents to account of the vagaries of the
2325 target. */
2326 DEFHOOK
2327 (conditional_register_usage,
2329 void, (void),
2330 hook_void_void)
2332 /* Functions specific to the C family of frontends. */
2333 #undef HOOK_PREFIX
2334 #define HOOK_PREFIX "TARGET_C_"
2335 HOOK_VECTOR (TARGET_C, c)
2337 /* ??? Documenting this hook requires a GFDL license grant. */
2338 DEFHOOK_UNDOC
2339 (mode_for_suffix,
2340 "Return machine mode for non-standard constant literal suffix @var{c},\
2341 or VOIDmode if non-standard suffixes are unsupported.",
2342 enum machine_mode, (char c),
2343 default_mode_for_suffix)
2345 HOOK_VECTOR_END (c)
2347 /* Functions specific to the C++ frontend. */
2348 #undef HOOK_PREFIX
2349 #define HOOK_PREFIX "TARGET_CXX_"
2350 HOOK_VECTOR (TARGET_CXX, cxx)
2352 /* Return the integer type used for guard variables. */
2353 DEFHOOK
2354 (guard_type,
2356 tree, (void),
2357 default_cxx_guard_type)
2359 /* Return true if only the low bit of the guard should be tested. */
2360 DEFHOOK
2361 (guard_mask_bit,
2363 bool, (void),
2364 hook_bool_void_false)
2366 /* Returns the size of the array cookie for an array of type. */
2367 DEFHOOK
2368 (get_cookie_size,
2370 tree, (tree type),
2371 default_cxx_get_cookie_size)
2373 /* Returns true if the element size should be stored in the array cookie. */
2374 DEFHOOK
2375 (cookie_has_size,
2377 bool, (void),
2378 hook_bool_void_false)
2380 /* Allows backends to perform additional processing when
2381 deciding if a class should be exported or imported. */
2382 DEFHOOK
2383 (import_export_class,
2385 int, (tree type, int import_export), NULL)
2387 /* Returns true if constructors and destructors return "this". */
2388 DEFHOOK
2389 (cdtor_returns_this,
2391 bool, (void),
2392 hook_bool_void_false)
2394 /* Returns true if the key method for a class can be an inline
2395 function, so long as it is not declared inline in the class
2396 itself. Returning true is the behavior required by the Itanium C++ ABI. */
2397 DEFHOOK
2398 (key_method_may_be_inline,
2400 bool, (void),
2401 hook_bool_void_true)
2403 DEFHOOK
2404 (determine_class_data_visibility,
2405 "@var{decl} is a virtual table, virtual table table, typeinfo object,\
2406 or other similar implicit class data object that will be emitted with\
2407 external linkage in this translation unit. No ELF visibility has been\
2408 explicitly specified. If the target needs to specify a visibility\
2409 other than that of the containing class, use this hook to set\
2410 @code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
2411 void, (tree decl),
2412 hook_void_tree)
2414 /* Returns true (the default) if virtual tables and other
2415 similar implicit class data objects are always COMDAT if they
2416 have external linkage. If this hook returns false, then
2417 class data for classes whose virtual table will be emitted in
2418 only one translation unit will not be COMDAT. */
2419 DEFHOOK
2420 (class_data_always_comdat,
2422 bool, (void),
2423 hook_bool_void_true)
2425 /* Returns true (the default) if the RTTI for the basic types,
2426 which is always defined in the C++ runtime, should be COMDAT;
2427 false if it should not be COMDAT. */
2428 DEFHOOK
2429 (library_rtti_comdat,
2431 bool, (void),
2432 hook_bool_void_true)
2434 /* Returns true if __aeabi_atexit should be used to register static
2435 destructors. */
2436 DEFHOOK
2437 (use_aeabi_atexit,
2439 bool, (void),
2440 hook_bool_void_false)
2442 /* Returns true if target may use atexit in the same manner as
2443 __cxa_atexit to register static destructors. */
2444 DEFHOOK
2445 (use_atexit_for_cxa_atexit,
2447 bool, (void),
2448 hook_bool_void_false)
2450 DEFHOOK
2451 (adjust_class_at_definition,
2452 "@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\
2453 been defined. Use this hook to make adjustments to the class (eg, tweak\
2454 visibility or perform any other required target modifications).",
2455 void, (tree type),
2456 hook_void_tree)
2458 HOOK_VECTOR_END (cxx)
2460 /* Functions and data for emulated TLS support. */
2461 #undef HOOK_PREFIX
2462 #define HOOK_PREFIX "TARGET_EMUTLS_"
2463 HOOK_VECTOR (TARGET_EMUTLS, emutls)
2465 /* Name of the address and common functions. */
2466 DEFHOOKPOD
2467 (get_address,
2469 const char *, "__builtin___emutls_get_address")
2471 DEFHOOKPOD
2472 (register_common,
2474 const char *, "__builtin___emutls_register_common")
2476 /* Prefixes for proxy variable and template. */
2477 DEFHOOKPOD
2478 (var_section,
2480 const char *, NULL)
2482 DEFHOOKPOD
2483 (tmpl_section,
2485 const char *, NULL)
2487 /* Prefixes for proxy variable and template. */
2488 DEFHOOKPOD
2489 (var_prefix,
2491 const char *, NULL)
2493 DEFHOOKPOD
2494 (tmpl_prefix,
2496 const char *, NULL)
2498 /* Function to generate field definitions of the proxy variable. */
2499 DEFHOOK
2500 (var_fields,
2502 tree, (tree type, tree *name),
2503 default_emutls_var_fields)
2505 /* Function to initialize a proxy variable. */
2506 DEFHOOK
2507 (var_init,
2509 tree, (tree var, tree decl, tree tmpl_addr),
2510 default_emutls_var_init)
2512 /* Whether we are allowed to alter the usual alignment of the
2513 proxy variable. */
2514 DEFHOOKPOD
2515 (var_align_fixed,
2517 bool, false)
2519 /* Whether we can emit debug information for TLS vars. */
2520 DEFHOOKPOD
2521 (debug_form_tls_address,
2523 bool, false)
2525 HOOK_VECTOR_END (emutls)
2527 #undef HOOK_PREFIX
2528 #define HOOK_PREFIX "TARGET_OPTION_"
2529 HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
2531 /* Function to validate the attribute((option(...))) strings or NULL. If
2532 the option is validated, it is assumed that DECL_FUNCTION_SPECIFIC will
2533 be filled in in the function decl node. */
2534 DEFHOOK
2535 (valid_attribute_p,
2537 bool, (tree fndecl, tree name, tree args, int flags),
2538 default_target_option_valid_attribute_p)
2540 /* Function to save any extra target state in the target options structure. */
2541 DEFHOOK
2542 (save,
2544 void, (struct cl_target_option *ptr), NULL)
2546 /* Function to restore any extra target state from the target options
2547 structure. */
2548 DEFHOOK
2549 (restore,
2551 void, (struct cl_target_option *ptr), NULL)
2553 /* Function to print any extra target state from the target options
2554 structure. */
2555 DEFHOOK
2556 (print,
2558 void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
2560 /* Function to parse arguments to be validated for #pragma option, and to
2561 change the state if the options are valid. If the first argument is
2562 NULL, the second argument specifies the default options to use. Return
2563 true if the options are valid, and set the current state. */
2564 /* ??? The documentation in tm.texi is incomplete. */
2565 DEFHOOK
2566 (pragma_parse,
2568 bool, (tree args, tree pop_target),
2569 default_target_option_pragma_parse)
2571 /* Do option overrides for the target. */
2572 DEFHOOK
2573 (override,
2575 void, (void),
2576 hook_void_void)
2578 /* Set default optimizations for the target. */
2579 DEFHOOKPOD
2580 (optimization_table,
2582 const struct default_options *, empty_optimization_table)
2584 DEFHOOK
2585 (default_params,
2586 "Set target-dependent default values for @option{--param} settings, using\
2587 calls to @code{set_default_param_value}.",
2588 void, (void),
2589 hook_void_void)
2591 DEFHOOK
2592 (init_struct,
2593 "Set target-dependent initial values of fields in @var{opts}.",
2594 void, (struct gcc_options *opts),
2595 hook_void_gcc_optionsp)
2597 /* Function to determine if one function can inline another function. */
2598 #undef HOOK_PREFIX
2599 #define HOOK_PREFIX "TARGET_"
2600 DEFHOOK
2601 (can_inline_p,
2603 bool, (tree caller, tree callee),
2604 default_target_can_inline_p)
2606 HOOK_VECTOR_END (target_option)
2608 /* For targets that need to mark extra registers as live on entry to
2609 the function, they should define this target hook and set their
2610 bits in the bitmap passed in. */
2611 DEFHOOK
2612 (extra_live_on_entry,
2614 void, (bitmap regs),
2615 hook_void_bitmap)
2617 /* Determine the type of unwind info to emit for debugging. */
2618 DEFHOOK
2619 (debug_unwind_info,
2621 enum unwind_info_type, (void),
2622 default_debug_unwind_info)
2624 /* Determine the type of unwind info to emit for exceptions. */
2625 DEFHOOK
2626 (except_unwind_info,
2628 enum unwind_info_type, (struct gcc_options *opts),
2629 default_except_unwind_info)
2631 /* Leave the boolean fields at the end. */
2633 /* True if unwinding tables should be generated by default. */
2634 DEFHOOKPOD
2635 (unwind_tables_default,
2637 bool, false)
2639 /* True if arbitrary sections are supported. */
2640 DEFHOOKPOD
2641 (have_named_sections,
2643 bool, false)
2645 /* True if we can create zeroed data by switching to a BSS section
2646 and then using ASM_OUTPUT_SKIP to allocate the space. */
2647 DEFHOOKPOD
2648 (have_switchable_bss_sections,
2650 bool, false)
2652 /* True if "native" constructors and destructors are supported,
2653 false if we're using collect2 for the job. */
2654 DEFHOOKPOD
2655 (have_ctors_dtors,
2657 bool, false)
2659 /* True if thread-local storage is supported. */
2660 DEFHOOKPOD
2661 (have_tls,
2663 bool, false)
2665 /* True if a small readonly data section is supported. */
2666 DEFHOOKPOD
2667 (have_srodata_section,
2669 bool, false)
2671 /* True if EH frame info sections should be zero-terminated. */
2672 DEFHOOKPOD
2673 (terminate_dw2_eh_frame_info,
2675 bool, true)
2677 /* True if #NO_APP should be emitted at the beginning of assembly output. */
2678 DEFHOOKPOD
2679 (asm_file_start_app_off,
2681 bool, false)
2683 /* True if output_file_directive should be called for main_input_filename
2684 at the beginning of assembly output. */
2685 DEFHOOKPOD
2686 (asm_file_start_file_directive,
2688 bool, false)
2690 DEFHOOKPOD
2691 (handle_pragma_extern_prefix,
2692 "True if @code{#pragma extern_prefix} is to be supported.",
2693 bool, 0)
2695 /* True if the target is allowed to reorder memory accesses unless
2696 synchronization is explicitly requested. */
2697 DEFHOOKPOD
2698 (relaxed_ordering,
2700 bool, false)
2702 /* Returns true if we should generate exception tables for use with the
2703 ARM EABI. The effects the encoding of function exception specifications. */
2704 DEFHOOKPOD
2705 (arm_eabi_unwinder,
2707 bool, false)
2709 DEFHOOKPOD
2710 (want_debug_pub_sections,
2711 "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\
2712 should be emitted. These sections are not used on most platforms, and\
2713 in particular GDB does not use them.",
2714 bool, false)
2716 /* Leave the boolean fields at the end. */
2718 /* Empty macro arguments are undefined in C90, so use an empty macro. */
2719 #define C90_EMPTY_HACK
2720 /* Close the 'struct gcc_target' definition. */
2721 HOOK_VECTOR_END (C90_EMPTY_HACK)
2723 HOOK_VECTOR (TARGETCM_INITIALIZER, gcc_targetcm)
2725 /* Handle target switch CODE (an OPT_* value). ARG is the argument
2726 passed to the switch; it is NULL if no argument was. VALUE is the
2727 value of ARG if CODE specifies a UInteger option, otherwise it is
2728 1 if the positive form of the switch was used and 0 if the negative
2729 form was. Return true if the switch was valid. */
2730 DEFHOOK
2731 (handle_c_option,
2733 bool, (size_t code, const char *arg, int value),
2734 default_handle_c_option)
2736 /* Targets may provide a string object type that can be used within
2737 and between C, C++, and Objective-C dialects. */
2739 DEFHOOK
2740 (objc_construct_string_object,
2741 "Targets may provide a string object type that can be used within\
2742 and between C, C++ and their respective Objective-C dialects.\
2743 A string object might, for example, embed encoding and length information.\
2744 These objects are considered opaque to the compiler and handled as references.\
2745 An ideal implementation makes the composition of the string object\
2746 match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\
2747 allowing efficient interworking between C-only and Objective-C code.\
2748 If a target implements string objects then this hook should return a\
2749 reference to such an object constructed from the normal `C' string\
2750 representation provided in @var{string}.\
2751 At present, the hook is used by Objective-C only, to obtain a\
2752 common-format string object when the target provides one.",
2753 tree, (tree string),
2754 NULL)
2756 DEFHOOK
2757 (string_object_ref_type_p,
2758 "If a target implements string objects then this hook should return\
2759 @code{true} if @var{stringref} is a valid reference to such an object.",
2760 bool, (const_tree stringref),
2761 hook_bool_const_tree_false)
2763 DEFHOOK
2764 (check_string_object_format_arg,
2765 "If a target implements string objects then this hook should should\
2766 provide a facility to check the function arguments in @var{args_list}\
2767 against the format specifiers in @var{format_arg} where the type of\
2768 @var{format_arg} is one recognized as a valid string reference type.",
2769 void, (tree format_arg, tree args_list),
2770 NULL)
2772 HOOK_VECTOR_END (C90_EMPTY_HACK)