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