Dispatch scheduling for AMD Bulldozer processors.
[platform/upstream/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 HOOK_VECTOR_END (vectorize)
884
885 #undef HOOK_PREFIX
886 #define HOOK_PREFIX "TARGET_"
887
888 /* The initial value of target_flags.  */
889 DEFHOOKPOD
890 (default_target_flags,
891  "",
892  int, 0)
893
894 /* Allow target specific overriding of option settings after options have
895   been changed by an attribute or pragma or when it is reset at the
896   end of the code affected by an attribute or pragma.  */
897 DEFHOOK
898 (override_options_after_change,
899  "",
900  void, (void),
901  hook_void_void)
902
903 /* Handle target switch CODE (an OPT_* value).  ARG is the argument
904    passed to the switch; it is NULL if no argument was.  VALUE is the
905    value of ARG if CODE specifies a UInteger option, otherwise it is
906    1 if the positive form of the switch was used and 0 if the negative
907    form was.  Return true if the switch was valid.  */
908 DEFHOOK
909 (handle_option,
910  "",
911  bool, (size_t code, const char *arg, int value),
912  hook_bool_size_t_constcharptr_int_true)
913
914 /* ??? Documenting this hook requires a GFDL license grant.  */
915 DEFHOOK_UNDOC
916 (handle_ofast,
917  "Handle target-specific parts of specifying -Ofast.",
918  void, (void),
919  hook_void_void)
920
921 /* Display extra, target specific information in response to a
922    --target-help switch.  */
923 DEFHOOK
924 (help,
925  "",
926  void, (void), NULL)
927
928 DEFHOOK_UNDOC
929 (eh_return_filter_mode,
930  "Return machine mode for filter value.",
931  enum machine_mode, (void),
932  default_eh_return_filter_mode)
933
934 /* Return machine mode for libgcc expanded cmp instructions.  */
935 DEFHOOK
936 (libgcc_cmp_return_mode,
937  "",
938  enum machine_mode, (void),
939  default_libgcc_cmp_return_mode)
940
941 /* Return machine mode for libgcc expanded shift instructions.  */
942 DEFHOOK
943 (libgcc_shift_count_mode,
944  "",
945  enum machine_mode, (void),
946  default_libgcc_shift_count_mode)
947
948 /* Return machine mode to be used for _Unwind_Word type.  */
949 DEFHOOK
950 (unwind_word_mode,
951  "",
952  enum machine_mode, (void),
953  default_unwind_word_mode)
954
955 /* Given two decls, merge their attributes and return the result.  */
956 DEFHOOK
957 (merge_decl_attributes,
958  "",
959  tree, (tree olddecl, tree newdecl),
960  merge_decl_attributes)
961
962 /* Given two types, merge their attributes and return the result.  */
963 DEFHOOK
964 (merge_type_attributes,
965  "",
966  tree, (tree type1, tree type2),
967  merge_type_attributes)
968
969 /* Table of machine attributes and functions to handle them.
970    Ignored if NULL.  */
971 DEFHOOKPOD
972 (attribute_table,
973  "",
974  const struct attribute_spec *, NULL)
975
976 /* Return true iff attribute NAME expects a plain identifier as its first
977    argument.  */
978 DEFHOOK
979 (attribute_takes_identifier_p,
980  "",
981  bool, (const_tree name),
982  hook_bool_const_tree_false)
983
984 /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible,
985    one if they are compatible and two if they are nearly compatible
986    (which causes a warning to be generated).  */
987 DEFHOOK
988 (comp_type_attributes,
989  "",
990  int, (const_tree type1, const_tree type2),
991  hook_int_const_tree_const_tree_1)
992
993 /* Assign default attributes to the newly defined TYPE.  */
994 DEFHOOK
995 (set_default_type_attributes,
996  "",
997  void, (tree type),
998  hook_void_tree)
999
1000 /* Insert attributes on the newly created DECL.  */
1001 DEFHOOK
1002 (insert_attributes,
1003  "",
1004  void, (tree node, tree *attr_ptr),
1005  hook_void_tree_treeptr)
1006
1007 /* Return true if FNDECL (which has at least one machine attribute)
1008    can be inlined despite its machine attributes, false otherwise.  */
1009 DEFHOOK
1010 (function_attribute_inlinable_p,
1011  "",
1012  bool, (const_tree fndecl),
1013  hook_bool_const_tree_false)
1014
1015 /* Return true if bitfields in RECORD_TYPE should follow the
1016    Microsoft Visual C++ bitfield layout rules.  */
1017 DEFHOOK
1018 (ms_bitfield_layout_p,
1019  "",
1020  bool, (const_tree record_type),
1021  hook_bool_const_tree_false)
1022
1023 /* True if the target supports decimal floating point.  */
1024 DEFHOOK
1025 (decimal_float_supported_p,
1026  "",
1027  bool, (void),
1028  default_decimal_float_supported_p)
1029
1030 /* True if the target supports fixed-point.  */
1031 DEFHOOK
1032 (fixed_point_supported_p,
1033  "",
1034  bool, (void),
1035  default_fixed_point_supported_p)
1036
1037 /* Return true if anonymous bitfields affect structure alignment.  */
1038 DEFHOOK
1039 (align_anon_bitfield,
1040  "",
1041  bool, (void),
1042  hook_bool_void_false)
1043
1044 /* Return true if volatile bitfields should use the narrowest type possible.
1045    Return false if they should use the container type.  */
1046 DEFHOOK
1047 (narrow_volatile_bitfield,
1048  "",
1049  bool, (void),
1050  hook_bool_void_false)
1051
1052 /* Set up target-specific built-in functions.  */
1053 DEFHOOK
1054 (init_builtins,
1055  "",
1056  void, (void),
1057  hook_void_void)
1058
1059 /* Initialize (if INITIALIZE_P is true) and return the target-specific
1060    built-in function decl for CODE.
1061    Return NULL if that is not possible.  Return error_mark_node if CODE
1062    is outside of the range of valid target builtin function codes.  */
1063 DEFHOOK
1064 (builtin_decl,
1065  "",
1066  tree, (unsigned code, bool initialize_p), NULL)
1067
1068 /* Expand a target-specific builtin.  */
1069 DEFHOOK
1070 (expand_builtin,
1071  "",
1072  rtx,
1073  (tree exp, rtx target, rtx subtarget, enum machine_mode mode, int ignore),
1074  default_expand_builtin)
1075
1076 /* Select a replacement for a target-specific builtin.  This is done
1077    *before* regular type checking, and so allows the target to
1078    implement a crude form of function overloading.  The result is a
1079    complete expression that implements the operation.  PARAMS really
1080    has type VEC(tree,gc)*, but we don't want to include tree.h here.  */
1081 DEFHOOK
1082 (resolve_overloaded_builtin,
1083  "",
1084  tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
1085
1086 /* Fold a target-specific builtin.  */
1087 DEFHOOK
1088 (fold_builtin,
1089  "",
1090  tree, (tree fndecl, int n_args, tree *argp, bool ignore),
1091  hook_tree_tree_int_treep_bool_null)
1092
1093 /* Returns a code for a target-specific builtin that implements
1094    reciprocal of the function, or NULL_TREE if not available.  */
1095 DEFHOOK
1096 (builtin_reciprocal,
1097  "",
1098  tree, (unsigned fn, bool md_fn, bool sqrt),
1099  default_builtin_reciprocal)
1100
1101 /* For a vendor-specific TYPE, return a pointer to a statically-allocated
1102    string containing the C++ mangling for TYPE.  In all other cases, return
1103    NULL.  */
1104 DEFHOOK
1105 (mangle_type,
1106  "",
1107  const char *, (const_tree type),
1108  hook_constcharptr_const_tree_null)
1109
1110 /* Make any adjustments to libfunc names needed for this target.  */
1111 DEFHOOK
1112 (init_libfuncs,
1113  "",
1114  void, (void),
1115  hook_void_void)
1116
1117 /* Given a decl, a section name, and whether the decl initializer
1118    has relocs, choose attributes for the section.  */
1119 /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION.  */
1120 DEFHOOK
1121 (section_type_flags,
1122  "",
1123  unsigned int, (tree decl, const char *name, int reloc),
1124  default_section_type_flags)
1125
1126 /* True if new jumps cannot be created, to replace existing ones or
1127    not, at the current point in the compilation.  */
1128 DEFHOOK
1129 (cannot_modify_jumps_p,
1130  "",
1131  bool, (void),
1132  hook_bool_void_false)
1133
1134 /* Return a register class for which branch target register
1135    optimizations should be applied.  */
1136 DEFHOOK
1137 (branch_target_register_class,
1138  "",
1139  reg_class_t, (void),
1140  default_branch_target_register_class)
1141
1142 /* Return true if branch target register optimizations should include
1143    callee-saved registers that are not already live during the current
1144    function.  AFTER_PE_GEN is true if prologues and epilogues have
1145    already been generated.  */
1146 DEFHOOK
1147 (branch_target_register_callee_saved,
1148  "",
1149  bool, (bool after_prologue_epilogue_gen),
1150  hook_bool_bool_false)
1151
1152 /* Return true if the target supports conditional execution.  */
1153 DEFHOOK
1154 (have_conditional_execution,
1155  "",
1156  bool, (void),
1157  default_have_conditional_execution)
1158
1159 /* Return a new value for loop unroll size.  */
1160 DEFHOOK
1161 (loop_unroll_adjust,
1162  "",
1163  unsigned, (unsigned nunroll, struct loop *loop),
1164  NULL)
1165
1166 /* True if the constant X cannot be placed in the constant pool.  */
1167 DEFHOOK
1168 (cannot_force_const_mem,
1169  "",
1170  bool, (rtx x),
1171  hook_bool_rtx_false)
1172
1173 DEFHOOK_UNDOC
1174 (cannot_copy_insn_p,
1175  "True if the insn @var{x} cannot be duplicated.",
1176  bool, (rtx), NULL)
1177
1178 /* True if X is considered to be commutative.  */
1179 DEFHOOK
1180 (commutative_p,
1181  "",
1182  bool, (const_rtx x, int outer_code),
1183  hook_bool_const_rtx_commutative_p)
1184
1185 /* True if ADDR is an address-expression whose effect depends
1186    on the mode of the memory reference it is used in.  */
1187 DEFHOOK
1188 (mode_dependent_address_p,
1189  "",
1190  bool, (const_rtx addr),
1191  default_mode_dependent_address_p)
1192
1193 /* Given an invalid address X for a given machine mode, try machine-specific
1194    ways to make it legitimate.  Return X or an invalid address on failure.  */
1195 DEFHOOK
1196 (legitimize_address,
1197  "",
1198  rtx, (rtx x, rtx oldx, enum machine_mode mode),
1199  default_legitimize_address)
1200
1201 /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS.  */
1202 DEFHOOK
1203 (delegitimize_address,
1204  "",
1205  rtx, (rtx x),
1206  delegitimize_mem_from_attrs)
1207
1208 /* Given an address RTX, say whether it is valid.  */
1209 DEFHOOK
1210 (legitimate_address_p,
1211  "",
1212  bool, (enum machine_mode mode, rtx x, bool strict),
1213  default_legitimate_address_p)
1214
1215 /* True if the given constant can be put into an object_block.  */
1216 DEFHOOK
1217 (use_blocks_for_constant_p,
1218  "",
1219  bool, (enum machine_mode mode, const_rtx x),
1220  hook_bool_mode_const_rtx_false)
1221
1222 /* The minimum and maximum byte offsets for anchored addresses.  */
1223 DEFHOOKPOD
1224 (min_anchor_offset,
1225  "",
1226  HOST_WIDE_INT, 0)
1227
1228 DEFHOOKPOD
1229 (max_anchor_offset,
1230  "",
1231  HOST_WIDE_INT, 0)
1232
1233 /* True if section anchors can be used to access the given symbol.  */
1234 DEFHOOK
1235 (use_anchors_for_symbol_p,
1236  "",
1237  bool, (const_rtx x),
1238  default_use_anchors_for_symbol_p)
1239
1240 /* True if it is OK to do sibling call optimization for the specified
1241    call expression EXP.  DECL will be the called function, or NULL if
1242    this is an indirect call.  */
1243 DEFHOOK
1244 (function_ok_for_sibcall,
1245  "",
1246  bool, (tree decl, tree exp),
1247  hook_bool_tree_tree_false)
1248
1249 /* Establish appropriate back-end context for processing the function
1250    FNDECL.  The argument might be NULL to indicate processing at top
1251    level, outside of any function scope.  */
1252 DEFHOOK
1253 (set_current_function,
1254  "",
1255  void, (tree decl), hook_void_tree)
1256
1257 /* True if EXP should be placed in a "small data" section.  */
1258 DEFHOOK
1259 (in_small_data_p,
1260  "",
1261  bool, (const_tree exp),
1262  hook_bool_const_tree_false)
1263
1264 /* True if EXP names an object for which name resolution must resolve
1265    to the current executable or shared library.  */
1266 DEFHOOK
1267 (binds_local_p,
1268  "",
1269  bool, (const_tree exp),
1270  default_binds_local_p)
1271
1272 /* Check if profiling code is before or after prologue.  */
1273 DEFHOOK
1274 (profile_before_prologue,
1275  "It returns true if target wants profile code emitted before prologue.\n\n\
1276 The default version of this hook use the target macro\n\
1277 @code{PROFILE_BEFORE_PROLOGUE}.",
1278  bool, (void),
1279  default_profile_before_prologue)
1280
1281 /* Modify and return the identifier of a DECL's external name,
1282    originally identified by ID, as required by the target,
1283    (eg, append @nn to windows32 stdcall function names).
1284    The default is to return ID without modification. */
1285 DEFHOOK
1286 (mangle_decl_assembler_name,
1287  "",
1288  tree, (tree decl, tree  id),
1289  default_mangle_decl_assembler_name)
1290
1291 /* Do something target-specific to record properties of the DECL into
1292    the associated SYMBOL_REF.  */
1293 DEFHOOK
1294 (encode_section_info,
1295  "",
1296  void, (tree decl, rtx rtl, int new_decl_p),
1297  default_encode_section_info)
1298
1299 /* Undo the effects of encode_section_info on the symbol string.  */
1300 DEFHOOK
1301 (strip_name_encoding,
1302  "",
1303  const char *, (const char *name),
1304  default_strip_name_encoding)
1305
1306 /* If shift optabs for MODE are known to always truncate the shift count,
1307    return the mask that they apply.  Return 0 otherwise.  */
1308 DEFHOOK
1309 (shift_truncation_mask,
1310  "",
1311  unsigned HOST_WIDE_INT, (enum machine_mode mode),
1312  default_shift_truncation_mask)
1313
1314 /* Return the number of divisions in the given MODE that should be present,
1315    so that it is profitable to turn the division into a multiplication by
1316    the reciprocal.  */
1317 DEFHOOK
1318 (min_divisions_for_recip_mul,
1319  "",
1320  unsigned int, (enum machine_mode mode),
1321  default_min_divisions_for_recip_mul)
1322
1323 /* If the representation of integral MODE is such that values are
1324    always sign-extended to a wider mode MODE_REP then return
1325    SIGN_EXTEND.  Return UNKNOWN otherwise.  */
1326 /* Note that the return type ought to be RTX_CODE, but that's not
1327    necessarily defined at this point.  */
1328 DEFHOOK
1329 (mode_rep_extended,
1330  "",
1331  int, (enum machine_mode mode, enum machine_mode rep_mode),
1332  default_mode_rep_extended)
1333
1334 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))).  */
1335 DEFHOOK
1336 (valid_pointer_mode,
1337  "",
1338  bool, (enum machine_mode mode),
1339  default_valid_pointer_mode)
1340
1341 /* Support for named address spaces.  */
1342 #undef HOOK_PREFIX
1343 #define HOOK_PREFIX "TARGET_ADDR_SPACE_"
1344 HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
1345
1346 /* MODE to use for a pointer into another address space.  */
1347 DEFHOOK
1348 (pointer_mode,
1349  "",
1350  enum machine_mode, (addr_space_t address_space),
1351  default_addr_space_pointer_mode)
1352
1353 /* MODE to use for an address in another address space.  */
1354 DEFHOOK
1355 (address_mode,
1356  "",
1357  enum machine_mode, (addr_space_t address_space),
1358  default_addr_space_address_mode)
1359
1360 /* True if MODE is valid for a pointer in __attribute__((mode("MODE")))
1361    in another address space.  */
1362 DEFHOOK
1363 (valid_pointer_mode,
1364  "",
1365  bool, (enum machine_mode mode, addr_space_t as),
1366  default_addr_space_valid_pointer_mode)
1367
1368 /* True if an address is a valid memory address to a given named address
1369    space for a given mode.  */
1370 DEFHOOK
1371 (legitimate_address_p,
1372  "",
1373  bool, (enum machine_mode mode, rtx exp, bool strict, addr_space_t as),
1374  default_addr_space_legitimate_address_p)
1375
1376 /* Return an updated address to convert an invalid pointer to a named
1377    address space to a valid one.  If NULL_RTX is returned use machine
1378    independent methods to make the address valid.  */
1379 DEFHOOK
1380 (legitimize_address,
1381  "",
1382  rtx, (rtx x, rtx oldx, enum machine_mode mode, addr_space_t as),
1383  default_addr_space_legitimize_address)
1384
1385 /* True if one named address space is a subset of another named address. */
1386 DEFHOOK
1387 (subset_p,
1388  "",
1389  bool, (addr_space_t superset, addr_space_t subset),
1390  default_addr_space_subset_p)
1391
1392 /* Function to convert an rtl expression from one address space to another.  */
1393 DEFHOOK
1394 (convert,
1395  "",
1396  rtx, (rtx op, tree from_type, tree to_type),
1397  default_addr_space_convert)
1398
1399 HOOK_VECTOR_END (addr_space)
1400
1401 #undef HOOK_PREFIX
1402 #define HOOK_PREFIX "TARGET_"
1403
1404 /* True if MODE is valid for the target.  By "valid", we mean able to
1405    be manipulated in non-trivial ways.  In particular, this means all
1406    the arithmetic is supported.  */
1407 DEFHOOK
1408 (scalar_mode_supported_p,
1409  "",
1410  bool, (enum machine_mode mode),
1411  default_scalar_mode_supported_p)
1412
1413 /* Similarly for vector modes.  "Supported" here is less strict.  At
1414    least some operations are supported; need to check optabs or builtins
1415    for further details.  */
1416 DEFHOOK
1417 (vector_mode_supported_p,
1418  "",
1419  bool, (enum machine_mode mode),
1420  hook_bool_mode_false)
1421
1422 /* Compute cost of moving data from a register of class FROM to one of
1423    TO, using MODE.  */
1424 DEFHOOK
1425 (register_move_cost,
1426  "",
1427  int, (enum machine_mode mode, reg_class_t from, reg_class_t to),
1428  default_register_move_cost)
1429
1430 /* Compute cost of moving registers to/from memory.  */
1431 /* ??? Documenting the argument types for this hook requires a GFDL
1432    license grant.  Also, the documentation uses a different name for RCLASS.  */
1433 DEFHOOK
1434 (memory_move_cost,
1435  "",
1436  int, (enum machine_mode mode, reg_class_t rclass, bool in),
1437  default_memory_move_cost)
1438
1439 /* True for MODE if the target expects that registers in this mode will
1440    be allocated to registers in a small register class.  The compiler is
1441    allowed to use registers explicitly used in the rtl as spill registers
1442    but it should prevent extending the lifetime of these registers.  */
1443 DEFHOOK
1444 (small_register_classes_for_mode_p,
1445  "",
1446  bool, (enum machine_mode mode),
1447  hook_bool_mode_false)
1448
1449 /* Compute a (partial) cost for rtx X.  Return true if the complete
1450    cost has been computed, and false if subexpressions should be
1451    scanned.  In either case, *TOTAL contains the cost result.  */
1452 /* Note that CODE and OUTER_CODE ought to be RTX_CODE, but that's
1453    not necessarily defined at this point.  */
1454 DEFHOOK
1455 (rtx_costs,
1456  "",
1457  bool, (rtx x, int code, int outer_code, int *total, bool speed),
1458  hook_bool_rtx_int_int_intp_bool_false)
1459
1460 /* Compute the cost of X, used as an address.  Never called with
1461    invalid addresses.  */
1462 DEFHOOK
1463 (address_cost,
1464  "",
1465  int, (rtx address, bool speed),
1466  default_address_cost)
1467
1468 /* Return where to allocate pseudo for a given hard register initial value.  */
1469 DEFHOOK
1470 (allocate_initial_value,
1471  "",
1472  rtx, (rtx hard_reg), NULL)
1473
1474 /* Return nonzero if evaluating UNSPEC[_VOLATILE] X might cause a trap.
1475    FLAGS has the same meaning as in rtlanal.c: may_trap_p_1.  */
1476 DEFHOOK
1477 (unspec_may_trap_p,
1478  "",
1479  int, (const_rtx x, unsigned flags),
1480  default_unspec_may_trap_p)
1481
1482 /* Given a register, this hook should return a parallel of registers
1483    to represent where to find the register pieces.  Define this hook
1484    if the register and its mode are represented in Dwarf in
1485    non-contiguous locations, or if the register should be
1486    represented in more than one register in Dwarf.  Otherwise, this
1487    hook should return NULL_RTX.  */
1488 DEFHOOK
1489 (dwarf_register_span,
1490  "",
1491  rtx, (rtx reg),
1492  hook_rtx_rtx_null)
1493
1494 /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table
1495    entries not corresponding directly to registers below
1496    FIRST_PSEUDO_REGISTER, this hook should generate the necessary
1497    code, given the address of the table.  */
1498 DEFHOOK
1499 (init_dwarf_reg_sizes_extra,
1500  "",
1501  void, (tree address),
1502  hook_void_tree)
1503
1504 /* Fetch the fixed register(s) which hold condition codes, for
1505    targets where it makes sense to look for duplicate assignments to
1506    the condition codes.  This should return true if there is such a
1507    register, false otherwise.  The arguments should be set to the
1508    fixed register numbers.  Up to two condition code registers are
1509    supported.  If there is only one for this target, the int pointed
1510    at by the second argument should be set to -1.  */
1511 DEFHOOK
1512 (fixed_condition_code_regs,
1513  "",
1514  bool, (unsigned int *p1, unsigned int *p2),
1515  hook_bool_uintp_uintp_false)
1516
1517 /* If two condition code modes are compatible, return a condition
1518      code mode which is compatible with both, such that a comparison
1519      done in the returned mode will work for both of the original
1520      modes.  If the condition code modes are not compatible, return
1521      VOIDmode.  */
1522 DEFHOOK
1523 (cc_modes_compatible,
1524  "",
1525  enum machine_mode, (enum machine_mode m1, enum machine_mode m2),
1526  default_cc_modes_compatible)
1527
1528 /* Do machine-dependent code transformations.  Called just before
1529      delayed-branch scheduling.  */
1530 DEFHOOK
1531 (machine_dependent_reorg,
1532  "",
1533  void, (void), NULL)
1534
1535 /* Create the __builtin_va_list type.  */
1536 DEFHOOK
1537 (build_builtin_va_list,
1538  "",
1539  tree, (void),
1540  std_build_builtin_va_list)
1541
1542 /* Enumerate the va list variants.  */
1543 DEFHOOK
1544 (enum_va_list_p,
1545  "",
1546  int, (int idx, const char **pname, tree *ptree),
1547  NULL)
1548
1549 /* Get the cfun/fndecl calling abi __builtin_va_list type.  */
1550 DEFHOOK
1551 (fn_abi_va_list,
1552  "",
1553  tree, (tree fndecl),
1554  std_fn_abi_va_list)
1555
1556 /* Get the __builtin_va_list type dependent on input type.  */
1557 DEFHOOK
1558 (canonical_va_list_type,
1559  "",
1560  tree, (tree type),
1561  std_canonical_va_list_type)
1562
1563 /* ??? Documenting this hook requires a GFDL license grant.  */
1564 DEFHOOK_UNDOC
1565 (expand_builtin_va_start,
1566 "Expand the @code{__builtin_va_start} builtin.",
1567  void, (tree valist, rtx nextarg), NULL)
1568
1569 /* Gimplifies a VA_ARG_EXPR.  */
1570 DEFHOOK
1571 (gimplify_va_arg_expr,
1572  "",
1573  tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
1574  std_gimplify_va_arg_expr)
1575
1576 /* Validity-checking routines for PCH files, target-specific.
1577    get_pch_validity returns a pointer to the data to be stored,
1578    and stores the size in its argument.  pch_valid_p gets the same
1579    information back and returns NULL if the PCH is valid,
1580    or an error message if not.  */
1581 DEFHOOK
1582 (get_pch_validity,
1583  "",
1584  void *, (size_t *sz),
1585  default_get_pch_validity)
1586
1587 DEFHOOK
1588 (pch_valid_p,
1589  "",
1590  const char *, (const void *data, size_t sz),
1591  default_pch_valid_p)
1592
1593 /* If nonnull, this function checks whether a PCH file with the
1594    given set of target flags can be used.  It returns NULL if so,
1595    otherwise it returns an error message.  */
1596 DEFHOOK
1597 (check_pch_target_flags,
1598  "",
1599  const char *, (int pch_flags), NULL)
1600
1601 /* True if the compiler should give an enum type only as many
1602    bytes as it takes to represent the range of possible values of
1603    that type.  */
1604 DEFHOOK
1605 (default_short_enums,
1606  "",
1607  bool, (void),
1608  hook_bool_void_false)
1609
1610 /* This target hook returns an rtx that is used to store the address
1611    of the current frame into the built-in setjmp buffer.  */
1612 DEFHOOK
1613 (builtin_setjmp_frame_value,
1614  "",
1615  rtx, (void),
1616  default_builtin_setjmp_frame_value)
1617
1618 /* This target hook should add STRING_CST trees for any hard regs
1619    the port wishes to automatically clobber for an asm.  */
1620 DEFHOOK
1621 (md_asm_clobbers,
1622  "",
1623  tree, (tree outputs, tree inputs, tree clobbers),
1624  hook_tree_tree_tree_tree_3rd_identity)
1625
1626 /* This target hook allows the backend to specify a calling convention
1627    in the debug information.  This function actually returns an
1628    enum dwarf_calling_convention, but because of forward declarations
1629    and not wanting to include dwarf2.h everywhere target.h is included
1630    the function is being declared as an int.  */
1631 DEFHOOK
1632 (dwarf_calling_convention,
1633  "",
1634  int, (const_tree function),
1635  hook_int_const_tree_0)
1636
1637 /* This target hook allows the backend to emit frame-related insns that
1638    contain UNSPECs or UNSPEC_VOLATILEs.  The call frame debugging info
1639    engine will invoke it on insns of the form
1640      (set (reg) (unspec [...] UNSPEC_INDEX))
1641    and
1642      (set (reg) (unspec_volatile [...] UNSPECV_INDEX))
1643    to let the backend emit the call frame instructions.  */
1644 DEFHOOK
1645 (dwarf_handle_frame_unspec,
1646  "",
1647  void, (const char *label, rtx pattern, int index), NULL)
1648
1649 /* ??? Documenting this hook requires a GFDL license grant.  */
1650 DEFHOOK_UNDOC
1651 (stdarg_optimize_hook,
1652 "Perform architecture specific checking of statements gimplified\
1653  from @code{VA_ARG_EXPR}.  @var{stmt} is the statement.  Returns true if\
1654  the statement doesn't need to be checked for @code{va_list} references.",
1655  bool, (struct stdarg_info *ai, const_gimple stmt), NULL)
1656
1657 /* This target hook allows the operating system to override the DECL
1658    that represents the external variable that contains the stack
1659    protection guard variable.  The type of this DECL is ptr_type_node.  */
1660 DEFHOOK
1661 (stack_protect_guard,
1662  "",
1663  tree, (void),
1664  default_stack_protect_guard)
1665
1666 /* This target hook allows the operating system to override the CALL_EXPR
1667    that is invoked when a check vs the guard variable fails.  */
1668 DEFHOOK
1669 (stack_protect_fail,
1670  "",
1671  tree, (void),
1672  default_external_stack_protect_fail)
1673
1674 /* Returns NULL if target supports the insn within a doloop block,
1675    otherwise it returns an error message.  */
1676 DEFHOOK
1677 (invalid_within_doloop,
1678  "",
1679  const char *, (const_rtx insn),
1680  default_invalid_within_doloop)
1681
1682 DEFHOOK
1683 (valid_dllimport_attribute_p,
1684 "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\
1685  specified.  Use this hook if the target needs to add extra validation\
1686  checks to @code{handle_dll_attribute}.",
1687  bool, (const_tree decl),
1688  hook_bool_const_tree_true)
1689
1690 /* If non-zero, align constant anchors in CSE to a multiple of this
1691    value.  */
1692 DEFHOOKPOD
1693 (const_anchor,
1694  "",
1695  unsigned HOST_WIDE_INT, 0)
1696
1697 /* Functions relating to calls - argument passing, returns, etc.  */
1698 /* Members of struct call have no special macro prefix.  */
1699 HOOK_VECTOR (TARGET_CALLS, calls)
1700
1701 DEFHOOK
1702 (promote_function_mode,
1703  "",
1704  enum machine_mode, (const_tree type, enum machine_mode mode, int *punsignedp,
1705                      const_tree funtype, int for_return),
1706  default_promote_function_mode)
1707
1708 DEFHOOK
1709 (promote_prototypes,
1710  "",
1711  bool, (const_tree fntype),
1712  hook_bool_const_tree_false)
1713
1714 DEFHOOK
1715 (struct_value_rtx,
1716  "",
1717  rtx, (tree fndecl, int incoming),
1718  hook_rtx_tree_int_null)
1719 DEFHOOK
1720 (return_in_memory,
1721  "",
1722  bool, (const_tree type, const_tree fntype),
1723  default_return_in_memory)
1724
1725 DEFHOOK
1726 (return_in_msb,
1727  "",
1728  bool, (const_tree type),
1729  hook_bool_const_tree_false)
1730
1731 /* Return true if a parameter must be passed by reference.  TYPE may
1732    be null if this is a libcall.  CA may be null if this query is
1733    from __builtin_va_arg.  */
1734 DEFHOOK
1735 (pass_by_reference,
1736  "",
1737  bool,
1738  (CUMULATIVE_ARGS *cum, enum machine_mode mode, const_tree type, bool named),
1739  hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
1740
1741 DEFHOOK
1742 (expand_builtin_saveregs,
1743  "",
1744  rtx, (void),
1745  default_expand_builtin_saveregs)
1746
1747 /* Returns pretend_argument_size.  */
1748 DEFHOOK
1749 (setup_incoming_varargs,
1750  "",
1751  void, (CUMULATIVE_ARGS *args_so_far, enum machine_mode mode, tree type,
1752         int *pretend_args_size, int second_time),
1753  default_setup_incoming_varargs)
1754
1755 DEFHOOK
1756 (strict_argument_naming,
1757  "",
1758  bool, (CUMULATIVE_ARGS *ca),
1759  hook_bool_CUMULATIVE_ARGS_false)
1760
1761 /* Returns true if we should use
1762    targetm.calls.setup_incoming_varargs() and/or
1763    targetm.calls.strict_argument_naming().  */
1764 DEFHOOK
1765 (pretend_outgoing_varargs_named,
1766  "",
1767  bool, (CUMULATIVE_ARGS *ca),
1768  default_pretend_outgoing_varargs_named)
1769
1770 /* Given a complex type T, return true if a parameter of type T
1771    should be passed as two scalars.  */
1772 DEFHOOK
1773 (split_complex_arg,
1774  "",
1775  bool, (const_tree type), NULL)
1776
1777 /* Return true if type T, mode MODE, may not be passed in registers,
1778    but must be passed on the stack.  */
1779 /* ??? This predicate should be applied strictly after pass-by-reference.
1780    Need audit to verify that this is the case.  */
1781 DEFHOOK
1782 (must_pass_in_stack,
1783  "",
1784  bool, (enum machine_mode mode, const_tree type),
1785  must_pass_in_stack_var_size_or_pad)
1786
1787 /* Return true if type TYPE, mode MODE, which is passed by reference,
1788    should have the object copy generated by the callee rather than
1789    the caller.  It is never called for TYPE requiring constructors.  */
1790 DEFHOOK
1791 (callee_copies,
1792  "",
1793  bool,
1794  (CUMULATIVE_ARGS *cum, enum machine_mode mode, const_tree type, bool named),
1795  hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false)
1796
1797 /* Return zero for arguments passed entirely on the stack or entirely
1798    in registers.  If passed in both, return the number of bytes passed
1799    in registers; the balance is therefore passed on the stack.  */
1800 DEFHOOK
1801 (arg_partial_bytes,
1802  "",
1803  int, (CUMULATIVE_ARGS *cum, enum machine_mode mode, tree type, bool named),
1804  hook_int_CUMULATIVE_ARGS_mode_tree_bool_0)
1805
1806 /* Update the state in CA to advance past an argument in the
1807    argument list.  The values MODE, TYPE, and NAMED describe that
1808    argument.  */
1809 /* ??? tm.texi still only describes the old macro.  */
1810 DEFHOOK_UNDOC
1811 (function_arg_advance,
1812  "",
1813  void,
1814  (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type, bool named),
1815  default_function_arg_advance)
1816
1817 /* Return zero if the argument described by the state of CA should
1818    be placed on a stack, or a hard register in which to store the
1819    argument.  The values MODE, TYPE, and NAMED describe that
1820    argument.  */
1821 /* ??? tm.texi still only describes the old macro.  */
1822 DEFHOOK_UNDOC
1823 (function_arg,
1824  "",
1825  rtx, (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type,
1826        bool named),
1827  default_function_arg)
1828
1829 /* Likewise, but for machines with register windows.  Return the
1830    location where the argument will appear to the callee.  */
1831 /* ??? tm.texi still only describes the old macro.  */
1832 DEFHOOK_UNDOC
1833 (function_incoming_arg,
1834  "",
1835  rtx, (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type,
1836        bool named),
1837  default_function_incoming_arg)
1838
1839 /* Return the diagnostic message string if function without a prototype
1840    is not allowed for this 'val' argument; NULL otherwise. */
1841 DEFHOOK
1842 (invalid_arg_for_unprototyped_fn,
1843  "",
1844  const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
1845  hook_invalid_arg_for_unprototyped_fn)
1846
1847 /* Return an rtx for the return value location of the function
1848    specified by FN_DECL_OR_TYPE with a return type of RET_TYPE.  */
1849 DEFHOOK
1850 (function_value,
1851  "",
1852  rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
1853  default_function_value)
1854
1855 /* Return the rtx for the result of a libcall of mode MODE,
1856    calling the function FN_NAME.  */
1857 DEFHOOK
1858 (libcall_value,
1859  "",
1860  rtx, (enum machine_mode mode, const_rtx fun),
1861  default_libcall_value)
1862
1863 /* Return true if REGNO is a possible register number for
1864    a function value as seen by the caller.  */
1865 DEFHOOK
1866 (function_value_regno_p,
1867  "",
1868  bool, (const unsigned int regno),
1869  default_function_value_regno_p)
1870
1871 /* ??? Documenting this hook requires a GFDL license grant.  */
1872 DEFHOOK_UNDOC
1873 (internal_arg_pointer,
1874 "Return an rtx for the argument pointer incoming to the\
1875  current function.",
1876  rtx, (void),
1877  default_internal_arg_pointer)
1878
1879 /* Update the current function stack boundary if needed.  */
1880 DEFHOOK
1881 (update_stack_boundary,
1882  "",
1883  void, (void), NULL)
1884
1885 /* Handle stack alignment and return an rtx for Dynamic Realign
1886    Argument Pointer if necessary.  */
1887 DEFHOOK
1888 (get_drap_rtx,
1889  "",
1890  rtx, (void), NULL)
1891
1892 /* Return true if all function parameters should be spilled to the
1893    stack.  */
1894 DEFHOOK
1895 (allocate_stack_slots_for_args,
1896  "",
1897  bool, (void),
1898  hook_bool_void_true)
1899
1900 /* Return an rtx for the static chain for FNDECL.  If INCOMING_P is true,
1901        then it should be for the callee; otherwise for the caller.  */
1902 DEFHOOK
1903 (static_chain,
1904  "",
1905  rtx, (const_tree fndecl, bool incoming_p),
1906  default_static_chain)
1907
1908 /* Fill in the trampoline at MEM with a call to FNDECL and a
1909    static chain value of CHAIN.  */
1910 DEFHOOK
1911 (trampoline_init,
1912  "",
1913  void, (rtx m_tramp, tree fndecl, rtx static_chain),
1914  default_trampoline_init)
1915
1916 /* Adjust the address of the trampoline in a target-specific way.  */
1917 DEFHOOK
1918 (trampoline_adjust_address,
1919  "",
1920  rtx, (rtx addr), NULL)
1921
1922 /* Return the number of bytes of its own arguments that a function
1923    pops on returning, or 0 if the function pops no arguments and the
1924    caller must therefore pop them all after the function returns.  */
1925 /* ??? tm.texi has no types for the parameters.  */
1926 DEFHOOK
1927 (return_pops_args,
1928  "",
1929  int, (tree fundecl, tree funtype, int size),
1930  default_return_pops_args)
1931
1932 HOOK_VECTOR_END (calls)
1933
1934 /* Return the diagnostic message string if conversion from FROMTYPE
1935    to TOTYPE is not allowed, NULL otherwise.  */
1936 DEFHOOK
1937 (invalid_conversion,
1938  "",
1939  const char *, (const_tree fromtype, const_tree totype),
1940  hook_constcharptr_const_tree_const_tree_null)
1941
1942 /* Return the diagnostic message string if the unary operation OP is
1943    not permitted on TYPE, NULL otherwise.  */
1944 DEFHOOK
1945 (invalid_unary_op,
1946  "",
1947  const char *, (int op, const_tree type),
1948  hook_constcharptr_int_const_tree_null)
1949
1950 /* Return the diagnostic message string if the binary operation OP
1951    is not permitted on TYPE1 and TYPE2, NULL otherwise.  */
1952 DEFHOOK
1953 (invalid_binary_op,
1954  "",
1955  const char *, (int op, const_tree type1, const_tree type2),
1956  hook_constcharptr_int_const_tree_const_tree_null)
1957
1958 /* Return the diagnostic message string if TYPE is not valid as a
1959    function parameter type, NULL otherwise.  */
1960 DEFHOOK
1961 (invalid_parameter_type,
1962  "",
1963  const char *, (const_tree type),
1964  hook_constcharptr_const_tree_null)
1965
1966 /* Return the diagnostic message string if TYPE is not valid as a
1967    function return type, NULL otherwise.  */
1968 DEFHOOK
1969 (invalid_return_type,
1970  "",
1971  const char *, (const_tree type),
1972  hook_constcharptr_const_tree_null)
1973
1974 /* If values of TYPE are promoted to some other type when used in
1975    expressions (analogous to the integer promotions), return that type,
1976    or NULL_TREE otherwise.  */
1977 DEFHOOK
1978 (promoted_type,
1979  "",
1980  tree, (const_tree type),
1981  hook_tree_const_tree_null)
1982
1983 /* Convert EXPR to TYPE, if target-specific types with special conversion
1984    rules are involved.  Return the converted expression, or NULL to apply
1985    the standard conversion rules.  */
1986 DEFHOOK
1987 (convert_to_type,
1988  "",
1989  tree, (tree type, tree expr),
1990  hook_tree_tree_tree_null)
1991
1992 /* Return the array of IRA cover classes for the current target.  */
1993 DEFHOOK
1994 (ira_cover_classes,
1995  "",
1996  const reg_class_t *, (void),
1997  default_ira_cover_classes)
1998
1999 /* Return the class for a secondary reload, and fill in extra information.  */
2000 DEFHOOK
2001 (secondary_reload,
2002  "",
2003  reg_class_t,
2004  (bool in_p, rtx x, reg_class_t reload_class, enum machine_mode reload_mode,
2005   secondary_reload_info *sri),
2006  default_secondary_reload)
2007
2008 DEFHOOK
2009 (class_likely_spilled_p,
2010  "",
2011  bool, (reg_class_t rclass),
2012  default_class_likely_spilled_p)
2013
2014 /* This target hook allows the backend to perform additional
2015    processing while initializing for variable expansion.  */
2016 DEFHOOK
2017 (expand_to_rtl_hook,
2018  "",
2019  void, (void),
2020  hook_void_void)
2021
2022 /* This target hook allows the backend to perform additional
2023    instantiations on rtx that are not actually in insns yet,
2024    but will be later.  */
2025 DEFHOOK
2026 (instantiate_decls,
2027  "",
2028  void, (void),
2029  hook_void_void)
2030
2031 /* Return true if is OK to use a hard register REGNO as scratch register
2032    in peephole2.  */
2033 DEFHOOK
2034 (hard_regno_scratch_ok,
2035  "",
2036  bool, (unsigned int regno),
2037  default_hard_regno_scratch_ok)
2038
2039 /* Return the smallest number of different values for which it is best to
2040    use a jump-table instead of a tree of conditional branches.  */
2041 DEFHOOK
2042 (case_values_threshold,
2043  "",
2044  unsigned int, (void),
2045  default_case_values_threshold)
2046
2047 /* Retutn true if a function must have and use a frame pointer.  */
2048 DEFHOOK
2049 (frame_pointer_required,
2050  "",
2051  bool, (void),
2052  hook_bool_void_false)
2053
2054 /* Returns true if the compiler is allowed to try to replace register number
2055    from-reg with register number to-reg.  */
2056 DEFHOOK
2057 (can_eliminate,
2058  "",
2059  bool, (const int from_reg, const int to_reg),
2060  hook_bool_const_int_const_int_true)
2061
2062 /* Functions specific to the C family of frontends.  */
2063 #undef HOOK_PREFIX
2064 #define HOOK_PREFIX "TARGET_C_"
2065 HOOK_VECTOR (TARGET_C, c)
2066
2067 /* ??? Documenting this hook requires a GFDL license grant.  */
2068 DEFHOOK_UNDOC
2069 (mode_for_suffix,
2070 "Return machine mode for non-standard constant literal suffix @var{c},\
2071  or VOIDmode if non-standard suffixes are unsupported.",
2072  enum machine_mode, (char c),
2073  default_mode_for_suffix)
2074
2075 HOOK_VECTOR_END (c)
2076
2077 /* Functions specific to the C++ frontend.  */
2078 #undef HOOK_PREFIX
2079 #define HOOK_PREFIX "TARGET_CXX_"
2080 HOOK_VECTOR (TARGET_CXX, cxx)
2081
2082 /* Return the integer type used for guard variables.  */
2083 DEFHOOK
2084 (guard_type,
2085  "",
2086  tree, (void),
2087  default_cxx_guard_type)
2088
2089 /* Return true if only the low bit of the guard should be tested.  */
2090 DEFHOOK
2091 (guard_mask_bit,
2092  "",
2093  bool, (void),
2094  hook_bool_void_false)
2095
2096 /* Returns the size of the array cookie for an array of type.  */
2097 DEFHOOK
2098 (get_cookie_size,
2099  "",
2100  tree, (tree type),
2101  default_cxx_get_cookie_size)
2102
2103 /* Returns true if the element size should be stored in the array cookie.  */
2104 DEFHOOK
2105 (cookie_has_size,
2106  "",
2107  bool, (void),
2108  hook_bool_void_false)
2109
2110 /* Allows backends to perform additional processing when
2111    deciding if a class should be exported or imported.  */
2112 DEFHOOK
2113 (import_export_class,
2114  "",
2115  int, (tree type, int import_export), NULL)
2116
2117 /* Returns true if constructors and destructors return "this".  */
2118 DEFHOOK
2119 (cdtor_returns_this,
2120  "",
2121  bool, (void),
2122  hook_bool_void_false)
2123
2124 /* Returns true if the key method for a class can be an inline
2125    function, so long as it is not declared inline in the class
2126    itself.  Returning true is the behavior required by the Itanium C++ ABI.  */
2127 DEFHOOK
2128 (key_method_may_be_inline,
2129  "",
2130  bool, (void),
2131  hook_bool_void_true)
2132
2133 DEFHOOK
2134 (determine_class_data_visibility,
2135 "@var{decl} is a virtual table, virtual table table, typeinfo object,\
2136  or other similar implicit class data object that will be emitted with\
2137  external linkage in this translation unit.  No ELF visibility has been\
2138  explicitly specified.  If the target needs to specify a visibility\
2139  other than that of the containing class, use this hook to set\
2140  @code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
2141  void, (tree decl),
2142  hook_void_tree)
2143
2144 /* Returns true (the default) if virtual tables and other
2145    similar implicit class data objects are always COMDAT if they
2146    have external linkage.  If this hook returns false, then
2147    class data for classes whose virtual table will be emitted in
2148    only one translation unit will not be COMDAT.  */
2149 DEFHOOK
2150 (class_data_always_comdat,
2151  "",
2152  bool, (void),
2153  hook_bool_void_true)
2154
2155 /* Returns true (the default) if the RTTI for the basic types,
2156    which is always defined in the C++ runtime, should be COMDAT;
2157    false if it should not be COMDAT.  */
2158 DEFHOOK
2159 (library_rtti_comdat,
2160  "",
2161  bool, (void),
2162  hook_bool_void_true)
2163
2164 /* Returns true if __aeabi_atexit should be used to register static
2165    destructors.  */
2166 DEFHOOK
2167 (use_aeabi_atexit,
2168  "",
2169  bool, (void),
2170  hook_bool_void_false)
2171
2172 /* Returns true if target may use atexit in the same manner as
2173    __cxa_atexit  to register static destructors.  */
2174 DEFHOOK
2175 (use_atexit_for_cxa_atexit,
2176  "",
2177  bool, (void),
2178  hook_bool_void_false)
2179
2180 DEFHOOK
2181 (adjust_class_at_definition,
2182 "@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\
2183  been defined.  Use this hook to make adjustments to the class (eg, tweak\
2184  visibility or perform any other required target modifications).",
2185  void, (tree type),
2186  hook_void_tree)
2187
2188 HOOK_VECTOR_END (cxx)
2189
2190 /* Functions and data for emulated TLS support.  */
2191 #undef HOOK_PREFIX
2192 #define HOOK_PREFIX "TARGET_EMUTLS_"
2193 HOOK_VECTOR (TARGET_EMUTLS, emutls)
2194
2195 /* Name of the address and common functions.  */
2196 DEFHOOKPOD
2197 (get_address,
2198  "",
2199  const char *, "__builtin___emutls_get_address")
2200
2201 DEFHOOKPOD
2202 (register_common,
2203  "",
2204  const char *, "__builtin___emutls_register_common")
2205
2206 /* Prefixes for proxy variable and template.  */
2207 DEFHOOKPOD
2208 (var_section,
2209  "",
2210  const char *, NULL)
2211
2212 DEFHOOKPOD
2213 (tmpl_section,
2214  "",
2215  const char *, NULL)
2216
2217 /* Prefixes for proxy variable and template.  */
2218 DEFHOOKPOD
2219 (var_prefix,
2220  "",
2221  const char *, NULL)
2222
2223 DEFHOOKPOD
2224 (tmpl_prefix,
2225  "",
2226  const char *, NULL)
2227
2228 /* Function to generate field definitions of the proxy variable.  */
2229 DEFHOOK
2230 (var_fields,
2231  "",
2232  tree, (tree type, tree *name),
2233  default_emutls_var_fields)
2234
2235 /* Function to initialize a proxy variable.  */
2236 DEFHOOK
2237 (var_init,
2238  "",
2239  tree, (tree var, tree decl, tree tmpl_addr),
2240  default_emutls_var_init)
2241
2242 /* Whether we are allowed to alter the usual alignment of the
2243    proxy variable.  */
2244 DEFHOOKPOD
2245 (var_align_fixed,
2246  "",
2247  bool, false)
2248
2249 /* Whether we can emit debug information for TLS vars.  */
2250 DEFHOOKPOD
2251 (debug_form_tls_address,
2252  "",
2253  bool, false)
2254
2255 HOOK_VECTOR_END (emutls)
2256
2257 #undef HOOK_PREFIX
2258 #define HOOK_PREFIX "TARGET_OPTION_"
2259 HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
2260
2261 /* Function to validate the attribute((option(...))) strings or NULL.  If
2262    the option is validated, it is assumed that DECL_FUNCTION_SPECIFIC will
2263    be filled in in the function decl node.  */
2264 DEFHOOK
2265 (valid_attribute_p,
2266  "",
2267  bool, (tree fndecl, tree name, tree args, int flags),
2268  default_target_option_valid_attribute_p)
2269
2270 /* Function to save any extra target state in the target options structure.  */
2271 DEFHOOK
2272 (save,
2273  "",
2274  void, (struct cl_target_option *ptr), NULL)
2275
2276 /* Function to restore any extra target state from the target options
2277    structure.  */
2278 DEFHOOK
2279 (restore,
2280  "",
2281  void, (struct cl_target_option *ptr), NULL)
2282
2283 /* Function to print any extra target state from the target options
2284    structure.  */
2285 DEFHOOK
2286 (print,
2287  "",
2288  void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
2289
2290 /* Function to parse arguments to be validated for #pragma option, and to
2291    change the state if the options are valid.  If the first argument is
2292    NULL, the second argument specifies the default options to use.  Return
2293    true if the options are valid, and set the current state.  */
2294 /* ??? The documentation in tm.texi is incomplete.  */
2295 DEFHOOK
2296 (pragma_parse,
2297  "",
2298  bool, (tree args, tree pop_target),
2299  default_target_option_pragma_parse)
2300
2301 /* Do option overrides for the target.  */
2302 DEFHOOK
2303 (override,
2304  "",
2305  void, (void),
2306  default_target_option_override)
2307
2308 /* Function to determine if one function can inline another function.  */
2309 #undef HOOK_PREFIX
2310 #define HOOK_PREFIX "TARGET_"
2311 DEFHOOK
2312 (can_inline_p,
2313  "",
2314  bool, (tree caller, tree callee),
2315  default_target_can_inline_p)
2316
2317 HOOK_VECTOR_END (target_option)
2318
2319 /* For targets that need to mark extra registers as live on entry to
2320    the function, they should define this target hook and set their
2321    bits in the bitmap passed in. */
2322 DEFHOOK
2323 (extra_live_on_entry,
2324  "",
2325  void, (bitmap regs),
2326  hook_void_bitmap)
2327
2328 /* Leave the boolean fields at the end.  */
2329
2330 /* True if unwinding tables should be generated by default.  */
2331 DEFHOOKPOD
2332 (unwind_tables_default,
2333  "",
2334  bool, false)
2335
2336 /* True if arbitrary sections are supported.  */
2337 DEFHOOKPOD
2338 (have_named_sections,
2339  "",
2340  bool, false)
2341
2342 /* True if we can create zeroed data by switching to a BSS section
2343    and then using ASM_OUTPUT_SKIP to allocate the space.  */
2344 DEFHOOKPOD
2345 (have_switchable_bss_sections,
2346  "",
2347  bool, false)
2348
2349 /* True if "native" constructors and destructors are supported,
2350    false if we're using collect2 for the job.  */
2351 DEFHOOKPOD
2352 (have_ctors_dtors,
2353  "",
2354  bool, false)
2355
2356 /* True if thread-local storage is supported.  */
2357 DEFHOOKPOD
2358 (have_tls,
2359  "",
2360  bool, false)
2361
2362 /* True if a small readonly data section is supported.  */
2363 DEFHOOKPOD
2364 (have_srodata_section,
2365  "",
2366  bool, false)
2367
2368 /* True if EH frame info sections should be zero-terminated.  */
2369 DEFHOOKPOD
2370 (terminate_dw2_eh_frame_info,
2371  "",
2372  bool, true)
2373
2374 /* True if #NO_APP should be emitted at the beginning of assembly output.  */
2375 DEFHOOKPOD
2376 (asm_file_start_app_off,
2377  "",
2378  bool, false)
2379
2380 /* True if output_file_directive should be called for main_input_filename
2381    at the beginning of assembly output.  */
2382 DEFHOOKPOD
2383 (asm_file_start_file_directive,
2384  "",
2385  bool, false)
2386
2387 DEFHOOKPOD
2388 (handle_pragma_extern_prefix,
2389 "True if @code{#pragma extern_prefix} is to be supported.",
2390  bool, 0)
2391
2392 /* True if the target is allowed to reorder memory accesses unless
2393    synchronization is explicitly requested.  */
2394 DEFHOOKPOD
2395 (relaxed_ordering,
2396  "",
2397  bool, false)
2398
2399 /* Returns true if we should generate exception tables for use with the
2400    ARM EABI.  The effects the encoding of function exception specifications.  */
2401 DEFHOOKPOD
2402 (arm_eabi_unwinder,
2403  "",
2404  bool, false)
2405
2406 DEFHOOKPOD
2407 (want_debug_pub_sections,
2408  "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\
2409  should be emitted.  These sections are not used on most platforms, and\
2410  in particular GDB does not use them.",
2411  bool, false)
2412
2413 /* Leave the boolean fields at the end.  */
2414
2415 /* Empty macro arguments are undefined in C90, so use an empty macro.  */
2416 #define C90_EMPTY_HACK
2417 /* Close the 'struct gcc_target' definition.  */
2418 HOOK_VECTOR_END (C90_EMPTY_HACK)
2419
2420 HOOK_VECTOR (TARGETCM_INITIALIZER, gcc_targetcm)
2421
2422 /* Handle target switch CODE (an OPT_* value).  ARG is the argument
2423    passed to the switch; it is NULL if no argument was.  VALUE is the
2424    value of ARG if CODE specifies a UInteger option, otherwise it is
2425    1 if the positive form of the switch was used and 0 if the negative
2426    form was.  Return true if the switch was valid.  */
2427 DEFHOOK
2428 (handle_c_option,
2429  "",
2430  bool, (size_t code, const char *arg, int value),
2431  default_handle_c_option)
2432
2433 HOOK_VECTOR_END (C90_EMPTY_HACK)