OSDN Git Service

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