OSDN Git Service

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