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