OSDN Git Service

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