OSDN Git Service

27263d91c590a1351eac2d341506d6c6f51c1942
[pf3gnuchains/gcc-fork.git] / gcc / doc / tm.texi
1 @c Copyright (C) 1988,1989,1992,1993,1994,1995,1996,1997,1998,1999,2000,2001,
2 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
6
7 @node Target Macros
8 @chapter Target Description Macros and Functions
9 @cindex machine description macros
10 @cindex target description macros
11 @cindex macros, target description
12 @cindex @file{tm.h} macros
13
14 In addition to the file @file{@var{machine}.md}, a machine description
15 includes a C header file conventionally given the name
16 @file{@var{machine}.h} and a C source file named @file{@var{machine}.c}.
17 The header file defines numerous macros that convey the information
18 about the target machine that does not fit into the scheme of the
19 @file{.md} file.  The file @file{tm.h} should be a link to
20 @file{@var{machine}.h}.  The header file @file{config.h} includes
21 @file{tm.h} and most compiler source files include @file{config.h}.  The
22 source file defines a variable @code{targetm}, which is a structure
23 containing pointers to functions and data relating to the target
24 machine.  @file{@var{machine}.c} should also contain their definitions,
25 if they are not defined elsewhere in GCC, and other functions called
26 through the macros defined in the @file{.h} file.
27
28 @menu
29 * Target Structure::    The @code{targetm} variable.
30 * Driver::              Controlling how the driver runs the compilation passes.
31 * Run-time Target::     Defining @samp{-m} options like @option{-m68000} and @option{-m68020}.
32 * Per-Function Data::   Defining data structures for per-function information.
33 * Storage Layout::      Defining sizes and alignments of data.
34 * Type Layout::         Defining sizes and properties of basic user data types.
35 * Registers::           Naming and describing the hardware registers.
36 * Register Classes::    Defining the classes of hardware registers.
37 * Old Constraints::     The old way to define machine-specific constraints.
38 * Stack and Calling::   Defining which way the stack grows and by how much.
39 * Varargs::             Defining the varargs macros.
40 * Trampolines::         Code set up at run time to enter a nested function.
41 * Library Calls::       Controlling how library routines are implicitly called.
42 * Addressing Modes::    Defining addressing modes valid for memory operands.
43 * Anchored Addresses::  Defining how @option{-fsection-anchors} should work.
44 * Condition Code::      Defining how insns update the condition code.
45 * Costs::               Defining relative costs of different operations.
46 * Scheduling::          Adjusting the behavior of the instruction scheduler.
47 * Sections::            Dividing storage into text, data, and other sections.
48 * PIC::                 Macros for position independent code.
49 * Assembler Format::    Defining how to write insns and pseudo-ops to output.
50 * Debugging Info::      Defining the format of debugging output.
51 * Floating Point::      Handling floating point for cross-compilers.
52 * Mode Switching::      Insertion of mode-switching instructions.
53 * Target Attributes::   Defining target-specific uses of @code{__attribute__}.
54 * Emulated TLS::        Emulated TLS support.
55 * MIPS Coprocessors::   MIPS coprocessor support and how to customize it.
56 * PCH Target::          Validity checking for precompiled headers.
57 * C++ ABI::             Controlling C++ ABI changes.
58 * Misc::                Everything else.
59 @end menu
60
61 @node Target Structure
62 @section The Global @code{targetm} Variable
63 @cindex target hooks
64 @cindex target functions
65
66 @deftypevar {struct gcc_target} targetm
67 The target @file{.c} file must define the global @code{targetm} variable
68 which contains pointers to functions and data relating to the target
69 machine.  The variable is declared in @file{target.h};
70 @file{target-def.h} defines the macro @code{TARGET_INITIALIZER} which is
71 used to initialize the variable, and macros for the default initializers
72 for elements of the structure.  The @file{.c} file should override those
73 macros for which the default definition is inappropriate.  For example:
74 @smallexample
75 #include "target.h"
76 #include "target-def.h"
77
78 /* @r{Initialize the GCC target structure.}  */
79
80 #undef TARGET_COMP_TYPE_ATTRIBUTES
81 #define TARGET_COMP_TYPE_ATTRIBUTES @var{machine}_comp_type_attributes
82
83 struct gcc_target targetm = TARGET_INITIALIZER;
84 @end smallexample
85 @end deftypevar
86
87 Where a macro should be defined in the @file{.c} file in this manner to
88 form part of the @code{targetm} structure, it is documented below as a
89 ``Target Hook'' with a prototype.  Many macros will change in future
90 from being defined in the @file{.h} file to being part of the
91 @code{targetm} structure.
92
93 @node Driver
94 @section Controlling the Compilation Driver, @file{gcc}
95 @cindex driver
96 @cindex controlling the compilation driver
97
98 @c prevent bad page break with this line
99 You can control the compilation driver.
100
101 @defmac SWITCH_TAKES_ARG (@var{char})
102 A C expression which determines whether the option @option{-@var{char}}
103 takes arguments.  The value should be the number of arguments that
104 option takes--zero, for many options.
105
106 By default, this macro is defined as
107 @code{DEFAULT_SWITCH_TAKES_ARG}, which handles the standard options
108 properly.  You need not define @code{SWITCH_TAKES_ARG} unless you
109 wish to add additional options which take arguments.  Any redefinition
110 should call @code{DEFAULT_SWITCH_TAKES_ARG} and then check for
111 additional options.
112 @end defmac
113
114 @defmac WORD_SWITCH_TAKES_ARG (@var{name})
115 A C expression which determines whether the option @option{-@var{name}}
116 takes arguments.  The value should be the number of arguments that
117 option takes--zero, for many options.  This macro rather than
118 @code{SWITCH_TAKES_ARG} is used for multi-character option names.
119
120 By default, this macro is defined as
121 @code{DEFAULT_WORD_SWITCH_TAKES_ARG}, which handles the standard options
122 properly.  You need not define @code{WORD_SWITCH_TAKES_ARG} unless you
123 wish to add additional options which take arguments.  Any redefinition
124 should call @code{DEFAULT_WORD_SWITCH_TAKES_ARG} and then check for
125 additional options.
126 @end defmac
127
128 @defmac SWITCH_CURTAILS_COMPILATION (@var{char})
129 A C expression which determines whether the option @option{-@var{char}}
130 stops compilation before the generation of an executable.  The value is
131 boolean, nonzero if the option does stop an executable from being
132 generated, zero otherwise.
133
134 By default, this macro is defined as
135 @code{DEFAULT_SWITCH_CURTAILS_COMPILATION}, which handles the standard
136 options properly.  You need not define
137 @code{SWITCH_CURTAILS_COMPILATION} unless you wish to add additional
138 options which affect the generation of an executable.  Any redefinition
139 should call @code{DEFAULT_SWITCH_CURTAILS_COMPILATION} and then check
140 for additional options.
141 @end defmac
142
143 @defmac SWITCHES_NEED_SPACES
144 A string-valued C expression which enumerates the options for which
145 the linker needs a space between the option and its argument.
146
147 If this macro is not defined, the default value is @code{""}.
148 @end defmac
149
150 @defmac TARGET_OPTION_TRANSLATE_TABLE
151 If defined, a list of pairs of strings, the first of which is a
152 potential command line target to the @file{gcc} driver program, and the
153 second of which is a space-separated (tabs and other whitespace are not
154 supported) list of options with which to replace the first option.  The
155 target defining this list is responsible for assuring that the results
156 are valid.  Replacement options may not be the @code{--opt} style, they
157 must be the @code{-opt} style.  It is the intention of this macro to
158 provide a mechanism for substitution that affects the multilibs chosen,
159 such as one option that enables many options, some of which select
160 multilibs.  Example nonsensical definition, where @option{-malt-abi},
161 @option{-EB}, and @option{-mspoo} cause different multilibs to be chosen:
162
163 @smallexample
164 #define TARGET_OPTION_TRANSLATE_TABLE \
165 @{ "-fast",   "-march=fast-foo -malt-abi -I/usr/fast-foo" @}, \
166 @{ "-compat", "-EB -malign=4 -mspoo" @}
167 @end smallexample
168 @end defmac
169
170 @defmac DRIVER_SELF_SPECS
171 A list of specs for the driver itself.  It should be a suitable
172 initializer for an array of strings, with no surrounding braces.
173
174 The driver applies these specs to its own command line between loading
175 default @file{specs} files (but not command-line specified ones) and
176 choosing the multilib directory or running any subcommands.  It
177 applies them in the order given, so each spec can depend on the
178 options added by earlier ones.  It is also possible to remove options
179 using @samp{%<@var{option}} in the usual way.
180
181 This macro can be useful when a port has several interdependent target
182 options.  It provides a way of standardizing the command line so
183 that the other specs are easier to write.
184
185 Do not define this macro if it does not need to do anything.
186 @end defmac
187
188 @defmac OPTION_DEFAULT_SPECS
189 A list of specs used to support configure-time default options (i.e.@:
190 @option{--with} options) in the driver.  It should be a suitable initializer
191 for an array of structures, each containing two strings, without the
192 outermost pair of surrounding braces.
193
194 The first item in the pair is the name of the default.  This must match
195 the code in @file{config.gcc} for the target.  The second item is a spec
196 to apply if a default with this name was specified.  The string
197 @samp{%(VALUE)} in the spec will be replaced by the value of the default
198 everywhere it occurs.
199
200 The driver will apply these specs to its own command line between loading
201 default @file{specs} files and processing @code{DRIVER_SELF_SPECS}, using
202 the same mechanism as @code{DRIVER_SELF_SPECS}.
203
204 Do not define this macro if it does not need to do anything.
205 @end defmac
206
207 @defmac CPP_SPEC
208 A C string constant that tells the GCC driver program options to
209 pass to CPP@.  It can also specify how to translate options you
210 give to GCC into options for GCC to pass to the CPP@.
211
212 Do not define this macro if it does not need to do anything.
213 @end defmac
214
215 @defmac CPLUSPLUS_CPP_SPEC
216 This macro is just like @code{CPP_SPEC}, but is used for C++, rather
217 than C@.  If you do not define this macro, then the value of
218 @code{CPP_SPEC} (if any) will be used instead.
219 @end defmac
220
221 @defmac CC1_SPEC
222 A C string constant that tells the GCC driver program options to
223 pass to @code{cc1}, @code{cc1plus}, @code{f771}, and the other language
224 front ends.
225 It can also specify how to translate options you give to GCC into options
226 for GCC to pass to front ends.
227
228 Do not define this macro if it does not need to do anything.
229 @end defmac
230
231 @defmac CC1PLUS_SPEC
232 A C string constant that tells the GCC driver program options to
233 pass to @code{cc1plus}.  It can also specify how to translate options you
234 give to GCC into options for GCC to pass to the @code{cc1plus}.
235
236 Do not define this macro if it does not need to do anything.
237 Note that everything defined in CC1_SPEC is already passed to
238 @code{cc1plus} so there is no need to duplicate the contents of
239 CC1_SPEC in CC1PLUS_SPEC@.
240 @end defmac
241
242 @defmac ASM_SPEC
243 A C string constant that tells the GCC driver program options to
244 pass to the assembler.  It can also specify how to translate options
245 you give to GCC into options for GCC to pass to the assembler.
246 See the file @file{sun3.h} for an example of this.
247
248 Do not define this macro if it does not need to do anything.
249 @end defmac
250
251 @defmac ASM_FINAL_SPEC
252 A C string constant that tells the GCC driver program how to
253 run any programs which cleanup after the normal assembler.
254 Normally, this is not needed.  See the file @file{mips.h} for
255 an example of this.
256
257 Do not define this macro if it does not need to do anything.
258 @end defmac
259
260 @defmac AS_NEEDS_DASH_FOR_PIPED_INPUT
261 Define this macro, with no value, if the driver should give the assembler
262 an argument consisting of a single dash, @option{-}, to instruct it to
263 read from its standard input (which will be a pipe connected to the
264 output of the compiler proper).  This argument is given after any
265 @option{-o} option specifying the name of the output file.
266
267 If you do not define this macro, the assembler is assumed to read its
268 standard input if given no non-option arguments.  If your assembler
269 cannot read standard input at all, use a @samp{%@{pipe:%e@}} construct;
270 see @file{mips.h} for instance.
271 @end defmac
272
273 @defmac LINK_SPEC
274 A C string constant that tells the GCC driver program options to
275 pass to the linker.  It can also specify how to translate options you
276 give to GCC into options for GCC to pass to the linker.
277
278 Do not define this macro if it does not need to do anything.
279 @end defmac
280
281 @defmac LIB_SPEC
282 Another C string constant used much like @code{LINK_SPEC}.  The difference
283 between the two is that @code{LIB_SPEC} is used at the end of the
284 command given to the linker.
285
286 If this macro is not defined, a default is provided that
287 loads the standard C library from the usual place.  See @file{gcc.c}.
288 @end defmac
289
290 @defmac LIBGCC_SPEC
291 Another C string constant that tells the GCC driver program
292 how and when to place a reference to @file{libgcc.a} into the
293 linker command line.  This constant is placed both before and after
294 the value of @code{LIB_SPEC}.
295
296 If this macro is not defined, the GCC driver provides a default that
297 passes the string @option{-lgcc} to the linker.
298 @end defmac
299
300 @defmac REAL_LIBGCC_SPEC
301 By default, if @code{ENABLE_SHARED_LIBGCC} is defined, the
302 @code{LIBGCC_SPEC} is not directly used by the driver program but is
303 instead modified to refer to different versions of @file{libgcc.a}
304 depending on the values of the command line flags @option{-static},
305 @option{-shared}, @option{-static-libgcc}, and @option{-shared-libgcc}.  On
306 targets where these modifications are inappropriate, define
307 @code{REAL_LIBGCC_SPEC} instead.  @code{REAL_LIBGCC_SPEC} tells the
308 driver how to place a reference to @file{libgcc} on the link command
309 line, but, unlike @code{LIBGCC_SPEC}, it is used unmodified.
310 @end defmac
311
312 @defmac USE_LD_AS_NEEDED
313 A macro that controls the modifications to @code{LIBGCC_SPEC}
314 mentioned in @code{REAL_LIBGCC_SPEC}.  If nonzero, a spec will be
315 generated that uses --as-needed and the shared libgcc in place of the
316 static exception handler library, when linking without any of
317 @code{-static}, @code{-static-libgcc}, or @code{-shared-libgcc}.
318 @end defmac
319
320 @defmac LINK_EH_SPEC
321 If defined, this C string constant is added to @code{LINK_SPEC}.
322 When @code{USE_LD_AS_NEEDED} is zero or undefined, it also affects
323 the modifications to @code{LIBGCC_SPEC} mentioned in
324 @code{REAL_LIBGCC_SPEC}.
325 @end defmac
326
327 @defmac STARTFILE_SPEC
328 Another C string constant used much like @code{LINK_SPEC}.  The
329 difference between the two is that @code{STARTFILE_SPEC} is used at
330 the very beginning of the command given to the linker.
331
332 If this macro is not defined, a default is provided that loads the
333 standard C startup file from the usual place.  See @file{gcc.c}.
334 @end defmac
335
336 @defmac ENDFILE_SPEC
337 Another C string constant used much like @code{LINK_SPEC}.  The
338 difference between the two is that @code{ENDFILE_SPEC} is used at
339 the very end of the command given to the linker.
340
341 Do not define this macro if it does not need to do anything.
342 @end defmac
343
344 @defmac THREAD_MODEL_SPEC
345 GCC @code{-v} will print the thread model GCC was configured to use.
346 However, this doesn't work on platforms that are multilibbed on thread
347 models, such as AIX 4.3.  On such platforms, define
348 @code{THREAD_MODEL_SPEC} such that it evaluates to a string without
349 blanks that names one of the recognized thread models.  @code{%*}, the
350 default value of this macro, will expand to the value of
351 @code{thread_file} set in @file{config.gcc}.
352 @end defmac
353
354 @defmac SYSROOT_SUFFIX_SPEC
355 Define this macro to add a suffix to the target sysroot when GCC is
356 configured with a sysroot.  This will cause GCC to search for usr/lib,
357 et al, within sysroot+suffix.
358 @end defmac
359
360 @defmac SYSROOT_HEADERS_SUFFIX_SPEC
361 Define this macro to add a headers_suffix to the target sysroot when
362 GCC is configured with a sysroot.  This will cause GCC to pass the
363 updated sysroot+headers_suffix to CPP, causing it to search for
364 usr/include, et al, within sysroot+headers_suffix.
365 @end defmac
366
367 @defmac EXTRA_SPECS
368 Define this macro to provide additional specifications to put in the
369 @file{specs} file that can be used in various specifications like
370 @code{CC1_SPEC}.
371
372 The definition should be an initializer for an array of structures,
373 containing a string constant, that defines the specification name, and a
374 string constant that provides the specification.
375
376 Do not define this macro if it does not need to do anything.
377
378 @code{EXTRA_SPECS} is useful when an architecture contains several
379 related targets, which have various @code{@dots{}_SPECS} which are similar
380 to each other, and the maintainer would like one central place to keep
381 these definitions.
382
383 For example, the PowerPC System V.4 targets use @code{EXTRA_SPECS} to
384 define either @code{_CALL_SYSV} when the System V calling sequence is
385 used or @code{_CALL_AIX} when the older AIX-based calling sequence is
386 used.
387
388 The @file{config/rs6000/rs6000.h} target file defines:
389
390 @smallexample
391 #define EXTRA_SPECS \
392   @{ "cpp_sysv_default", CPP_SYSV_DEFAULT @},
393
394 #define CPP_SYS_DEFAULT ""
395 @end smallexample
396
397 The @file{config/rs6000/sysv.h} target file defines:
398 @smallexample
399 #undef CPP_SPEC
400 #define CPP_SPEC \
401 "%@{posix: -D_POSIX_SOURCE @} \
402 %@{mcall-sysv: -D_CALL_SYSV @} \
403 %@{!mcall-sysv: %(cpp_sysv_default) @} \
404 %@{msoft-float: -D_SOFT_FLOAT@} %@{mcpu=403: -D_SOFT_FLOAT@}"
405
406 #undef CPP_SYSV_DEFAULT
407 #define CPP_SYSV_DEFAULT "-D_CALL_SYSV"
408 @end smallexample
409
410 while the @file{config/rs6000/eabiaix.h} target file defines
411 @code{CPP_SYSV_DEFAULT} as:
412
413 @smallexample
414 #undef CPP_SYSV_DEFAULT
415 #define CPP_SYSV_DEFAULT "-D_CALL_AIX"
416 @end smallexample
417 @end defmac
418
419 @defmac LINK_LIBGCC_SPECIAL_1
420 Define this macro if the driver program should find the library
421 @file{libgcc.a}.  If you do not define this macro, the driver program will pass
422 the argument @option{-lgcc} to tell the linker to do the search.
423 @end defmac
424
425 @defmac LINK_GCC_C_SEQUENCE_SPEC
426 The sequence in which libgcc and libc are specified to the linker.
427 By default this is @code{%G %L %G}.
428 @end defmac
429
430 @defmac LINK_COMMAND_SPEC
431 A C string constant giving the complete command line need to execute the
432 linker.  When you do this, you will need to update your port each time a
433 change is made to the link command line within @file{gcc.c}.  Therefore,
434 define this macro only if you need to completely redefine the command
435 line for invoking the linker and there is no other way to accomplish
436 the effect you need.  Overriding this macro may be avoidable by overriding
437 @code{LINK_GCC_C_SEQUENCE_SPEC} instead.
438 @end defmac
439
440 @defmac LINK_ELIMINATE_DUPLICATE_LDIRECTORIES
441 A nonzero value causes @command{collect2} to remove duplicate @option{-L@var{directory}} search
442 directories from linking commands.  Do not give it a nonzero value if
443 removing duplicate search directories changes the linker's semantics.
444 @end defmac
445
446 @defmac MULTILIB_DEFAULTS
447 Define this macro as a C expression for the initializer of an array of
448 string to tell the driver program which options are defaults for this
449 target and thus do not need to be handled specially when using
450 @code{MULTILIB_OPTIONS}.
451
452 Do not define this macro if @code{MULTILIB_OPTIONS} is not defined in
453 the target makefile fragment or if none of the options listed in
454 @code{MULTILIB_OPTIONS} are set by default.
455 @xref{Target Fragment}.
456 @end defmac
457
458 @defmac RELATIVE_PREFIX_NOT_LINKDIR
459 Define this macro to tell @command{gcc} that it should only translate
460 a @option{-B} prefix into a @option{-L} linker option if the prefix
461 indicates an absolute file name.
462 @end defmac
463
464 @defmac MD_EXEC_PREFIX
465 If defined, this macro is an additional prefix to try after
466 @code{STANDARD_EXEC_PREFIX}.  @code{MD_EXEC_PREFIX} is not searched
467 when the @option{-b} option is used, or the compiler is built as a cross
468 compiler.  If you define @code{MD_EXEC_PREFIX}, then be sure to add it
469 to the list of directories used to find the assembler in @file{configure.in}.
470 @end defmac
471
472 @defmac STANDARD_STARTFILE_PREFIX
473 Define this macro as a C string constant if you wish to override the
474 standard choice of @code{libdir} as the default prefix to
475 try when searching for startup files such as @file{crt0.o}.
476 @code{STANDARD_STARTFILE_PREFIX} is not searched when the compiler
477 is built as a cross compiler.
478 @end defmac
479
480 @defmac STANDARD_STARTFILE_PREFIX_1
481 Define this macro as a C string constant if you wish to override the
482 standard choice of @code{/lib} as a prefix to try after the default prefix
483 when searching for startup files such as @file{crt0.o}.
484 @code{STANDARD_STARTFILE_PREFIX_1} is not searched when the compiler
485 is built as a cross compiler.
486 @end defmac
487
488 @defmac STANDARD_STARTFILE_PREFIX_2
489 Define this macro as a C string constant if you wish to override the
490 standard choice of @code{/lib} as yet another prefix to try after the
491 default prefix when searching for startup files such as @file{crt0.o}.
492 @code{STANDARD_STARTFILE_PREFIX_2} is not searched when the compiler
493 is built as a cross compiler.
494 @end defmac
495
496 @defmac MD_STARTFILE_PREFIX
497 If defined, this macro supplies an additional prefix to try after the
498 standard prefixes.  @code{MD_EXEC_PREFIX} is not searched when the
499 @option{-b} option is used, or when the compiler is built as a cross
500 compiler.
501 @end defmac
502
503 @defmac MD_STARTFILE_PREFIX_1
504 If defined, this macro supplies yet another prefix to try after the
505 standard prefixes.  It is not searched when the @option{-b} option is
506 used, or when the compiler is built as a cross compiler.
507 @end defmac
508
509 @defmac INIT_ENVIRONMENT
510 Define this macro as a C string constant if you wish to set environment
511 variables for programs called by the driver, such as the assembler and
512 loader.  The driver passes the value of this macro to @code{putenv} to
513 initialize the necessary environment variables.
514 @end defmac
515
516 @defmac LOCAL_INCLUDE_DIR
517 Define this macro as a C string constant if you wish to override the
518 standard choice of @file{/usr/local/include} as the default prefix to
519 try when searching for local header files.  @code{LOCAL_INCLUDE_DIR}
520 comes before @code{SYSTEM_INCLUDE_DIR} in the search order.
521
522 Cross compilers do not search either @file{/usr/local/include} or its
523 replacement.
524 @end defmac
525
526 @defmac MODIFY_TARGET_NAME
527 Define this macro if you wish to define command-line switches that
528 modify the default target name.
529
530 For each switch, you can include a string to be appended to the first
531 part of the configuration name or a string to be deleted from the
532 configuration name, if present.  The definition should be an initializer
533 for an array of structures.  Each array element should have three
534 elements: the switch name (a string constant, including the initial
535 dash), one of the enumeration codes @code{ADD} or @code{DELETE} to
536 indicate whether the string should be inserted or deleted, and the string
537 to be inserted or deleted (a string constant).
538
539 For example, on a machine where @samp{64} at the end of the
540 configuration name denotes a 64-bit target and you want the @option{-32}
541 and @option{-64} switches to select between 32- and 64-bit targets, you would
542 code
543
544 @smallexample
545 #define MODIFY_TARGET_NAME \
546   @{ @{ "-32", DELETE, "64"@}, \
547      @{"-64", ADD, "64"@}@}
548 @end smallexample
549 @end defmac
550
551 @defmac SYSTEM_INCLUDE_DIR
552 Define this macro as a C string constant if you wish to specify a
553 system-specific directory to search for header files before the standard
554 directory.  @code{SYSTEM_INCLUDE_DIR} comes before
555 @code{STANDARD_INCLUDE_DIR} in the search order.
556
557 Cross compilers do not use this macro and do not search the directory
558 specified.
559 @end defmac
560
561 @defmac STANDARD_INCLUDE_DIR
562 Define this macro as a C string constant if you wish to override the
563 standard choice of @file{/usr/include} as the default prefix to
564 try when searching for header files.
565
566 Cross compilers ignore this macro and do not search either
567 @file{/usr/include} or its replacement.
568 @end defmac
569
570 @defmac STANDARD_INCLUDE_COMPONENT
571 The ``component'' corresponding to @code{STANDARD_INCLUDE_DIR}.
572 See @code{INCLUDE_DEFAULTS}, below, for the description of components.
573 If you do not define this macro, no component is used.
574 @end defmac
575
576 @defmac INCLUDE_DEFAULTS
577 Define this macro if you wish to override the entire default search path
578 for include files.  For a native compiler, the default search path
579 usually consists of @code{GCC_INCLUDE_DIR}, @code{LOCAL_INCLUDE_DIR},
580 @code{SYSTEM_INCLUDE_DIR}, @code{GPLUSPLUS_INCLUDE_DIR}, and
581 @code{STANDARD_INCLUDE_DIR}.  In addition, @code{GPLUSPLUS_INCLUDE_DIR}
582 and @code{GCC_INCLUDE_DIR} are defined automatically by @file{Makefile},
583 and specify private search areas for GCC@.  The directory
584 @code{GPLUSPLUS_INCLUDE_DIR} is used only for C++ programs.
585
586 The definition should be an initializer for an array of structures.
587 Each array element should have four elements: the directory name (a
588 string constant), the component name (also a string constant), a flag
589 for C++-only directories,
590 and a flag showing that the includes in the directory don't need to be
591 wrapped in @code{extern @samp{C}} when compiling C++.  Mark the end of
592 the array with a null element.
593
594 The component name denotes what GNU package the include file is part of,
595 if any, in all uppercase letters.  For example, it might be @samp{GCC}
596 or @samp{BINUTILS}.  If the package is part of a vendor-supplied
597 operating system, code the component name as @samp{0}.
598
599 For example, here is the definition used for VAX/VMS:
600
601 @smallexample
602 #define INCLUDE_DEFAULTS \
603 @{                                       \
604   @{ "GNU_GXX_INCLUDE:", "G++", 1, 1@},   \
605   @{ "GNU_CC_INCLUDE:", "GCC", 0, 0@},    \
606   @{ "SYS$SYSROOT:[SYSLIB.]", 0, 0, 0@},  \
607   @{ ".", 0, 0, 0@},                      \
608   @{ 0, 0, 0, 0@}                         \
609 @}
610 @end smallexample
611 @end defmac
612
613 Here is the order of prefixes tried for exec files:
614
615 @enumerate
616 @item
617 Any prefixes specified by the user with @option{-B}.
618
619 @item
620 The environment variable @code{GCC_EXEC_PREFIX} or, if @code{GCC_EXEC_PREFIX}
621 is not set and the compiler has not been installed in the configure-time 
622 @var{prefix}, the location in which the compiler has actually been installed.
623
624 @item
625 The directories specified by the environment variable @code{COMPILER_PATH}.
626
627 @item
628 The macro @code{STANDARD_EXEC_PREFIX}, if the compiler has been installed
629 in the configured-time @var{prefix}. 
630
631 @item
632 The location @file{/usr/libexec/gcc/}, but only if this is a native compiler. 
633
634 @item
635 The location @file{/usr/lib/gcc/}, but only if this is a native compiler. 
636
637 @item
638 The macro @code{MD_EXEC_PREFIX}, if defined, but only if this is a native 
639 compiler.
640 @end enumerate
641
642 Here is the order of prefixes tried for startfiles:
643
644 @enumerate
645 @item
646 Any prefixes specified by the user with @option{-B}.
647
648 @item
649 The environment variable @code{GCC_EXEC_PREFIX} or its automatically determined
650 value based on the installed toolchain location.
651
652 @item
653 The directories specified by the environment variable @code{LIBRARY_PATH}
654 (or port-specific name; native only, cross compilers do not use this).
655
656 @item
657 The macro @code{STANDARD_EXEC_PREFIX}, but only if the toolchain is installed
658 in the configured @var{prefix} or this is a native compiler. 
659
660 @item
661 The location @file{/usr/lib/gcc/}, but only if this is a native compiler.
662
663 @item
664 The macro @code{MD_EXEC_PREFIX}, if defined, but only if this is a native 
665 compiler.
666
667 @item
668 The macro @code{MD_STARTFILE_PREFIX}, if defined, but only if this is a 
669 native compiler, or we have a target system root.
670
671 @item
672 The macro @code{MD_STARTFILE_PREFIX_1}, if defined, but only if this is a 
673 native compiler, or we have a target system root.
674
675 @item
676 The macro @code{STANDARD_STARTFILE_PREFIX}, with any sysroot modifications.
677 If this path is relative it will be prefixed by @code{GCC_EXEC_PREFIX} and
678 the machine suffix or @code{STANDARD_EXEC_PREFIX} and the machine suffix.
679
680 @item
681 The macro @code{STANDARD_STARTFILE_PREFIX_1}, but only if this is a native
682 compiler, or we have a target system root. The default for this macro is
683 @file{/lib/}.
684
685 @item
686 The macro @code{STANDARD_STARTFILE_PREFIX_2}, but only if this is a native
687 compiler, or we have a target system root. The default for this macro is
688 @file{/usr/lib/}.
689 @end enumerate
690
691 @node Run-time Target
692 @section Run-time Target Specification
693 @cindex run-time target specification
694 @cindex predefined macros
695 @cindex target specifications
696
697 @c prevent bad page break with this line
698 Here are run-time target specifications.
699
700 @defmac TARGET_CPU_CPP_BUILTINS ()
701 This function-like macro expands to a block of code that defines
702 built-in preprocessor macros and assertions for the target CPU, using
703 the functions @code{builtin_define}, @code{builtin_define_std} and
704 @code{builtin_assert}.  When the front end
705 calls this macro it provides a trailing semicolon, and since it has
706 finished command line option processing your code can use those
707 results freely.
708
709 @code{builtin_assert} takes a string in the form you pass to the
710 command-line option @option{-A}, such as @code{cpu=mips}, and creates
711 the assertion.  @code{builtin_define} takes a string in the form
712 accepted by option @option{-D} and unconditionally defines the macro.
713
714 @code{builtin_define_std} takes a string representing the name of an
715 object-like macro.  If it doesn't lie in the user's namespace,
716 @code{builtin_define_std} defines it unconditionally.  Otherwise, it
717 defines a version with two leading underscores, and another version
718 with two leading and trailing underscores, and defines the original
719 only if an ISO standard was not requested on the command line.  For
720 example, passing @code{unix} defines @code{__unix}, @code{__unix__}
721 and possibly @code{unix}; passing @code{_mips} defines @code{__mips},
722 @code{__mips__} and possibly @code{_mips}, and passing @code{_ABI64}
723 defines only @code{_ABI64}.
724
725 You can also test for the C dialect being compiled.  The variable
726 @code{c_language} is set to one of @code{clk_c}, @code{clk_cplusplus}
727 or @code{clk_objective_c}.  Note that if we are preprocessing
728 assembler, this variable will be @code{clk_c} but the function-like
729 macro @code{preprocessing_asm_p()} will return true, so you might want
730 to check for that first.  If you need to check for strict ANSI, the
731 variable @code{flag_iso} can be used.  The function-like macro
732 @code{preprocessing_trad_p()} can be used to check for traditional
733 preprocessing.
734 @end defmac
735
736 @defmac TARGET_OS_CPP_BUILTINS ()
737 Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional
738 and is used for the target operating system instead.
739 @end defmac
740
741 @defmac TARGET_OBJFMT_CPP_BUILTINS ()
742 Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional
743 and is used for the target object format.  @file{elfos.h} uses this
744 macro to define @code{__ELF__}, so you probably do not need to define
745 it yourself.
746 @end defmac
747
748 @deftypevar {extern int} target_flags
749 This variable is declared in @file{options.h}, which is included before
750 any target-specific headers.
751 @end deftypevar
752
753 @deftypevr {Target Hook} int TARGET_DEFAULT_TARGET_FLAGS
754 This variable specifies the initial value of @code{target_flags}.
755 Its default setting is 0.
756 @end deftypevr
757
758 @cindex optional hardware or system features
759 @cindex features, optional, in system conventions
760
761 @deftypefn {Target Hook} bool TARGET_HANDLE_OPTION (size_t @var{code}, const char *@var{arg}, int @var{value})
762 This hook is called whenever the user specifies one of the
763 target-specific options described by the @file{.opt} definition files
764 (@pxref{Options}).  It has the opportunity to do some option-specific
765 processing and should return true if the option is valid.  The default
766 definition does nothing but return true.
767
768 @var{code} specifies the @code{OPT_@var{name}} enumeration value
769 associated with the selected option; @var{name} is just a rendering of
770 the option name in which non-alphanumeric characters are replaced by
771 underscores.  @var{arg} specifies the string argument and is null if
772 no argument was given.  If the option is flagged as a @code{UInteger}
773 (@pxref{Option properties}), @var{value} is the numeric value of the
774 argument.  Otherwise @var{value} is 1 if the positive form of the
775 option was used and 0 if the ``no-'' form was.
776 @end deftypefn
777
778 @deftypefn {Target Hook} bool TARGET_HANDLE_C_OPTION (size_t @var{code}, const char *@var{arg}, int @var{value})
779 This target hook is called whenever the user specifies one of the
780 target-specific C language family options described by the @file{.opt}
781 definition files(@pxref{Options}).  It has the opportunity to do some
782 option-specific processing and should return true if the option is
783 valid.  The default definition does nothing but return false.
784
785 In general, you should use @code{TARGET_HANDLE_OPTION} to handle
786 options.  However, if processing an option requires routines that are
787 only available in the C (and related language) front ends, then you
788 should use @code{TARGET_HANDLE_C_OPTION} instead.
789 @end deftypefn
790
791 @defmac TARGET_VERSION
792 This macro is a C statement to print on @code{stderr} a string
793 describing the particular machine description choice.  Every machine
794 description should define @code{TARGET_VERSION}.  For example:
795
796 @smallexample
797 #ifdef MOTOROLA
798 #define TARGET_VERSION \
799   fprintf (stderr, " (68k, Motorola syntax)");
800 #else
801 #define TARGET_VERSION \
802   fprintf (stderr, " (68k, MIT syntax)");
803 #endif
804 @end smallexample
805 @end defmac
806
807 @defmac OVERRIDE_OPTIONS
808 Sometimes certain combinations of command options do not make sense on
809 a particular target machine.  You can define a macro
810 @code{OVERRIDE_OPTIONS} to take account of this.  This macro, if
811 defined, is executed once just after all the command options have been
812 parsed.
813
814 Don't use this macro to turn on various extra optimizations for
815 @option{-O}.  That is what @code{OPTIMIZATION_OPTIONS} is for.
816 @end defmac
817
818 @defmac C_COMMON_OVERRIDE_OPTIONS
819 This is similar to @code{OVERRIDE_OPTIONS} but is only used in the C
820 language frontends (C, Objective-C, C++, Objective-C++) and so can be
821 used to alter option flag variables which only exist in those
822 frontends.
823 @end defmac
824
825 @defmac OPTIMIZATION_OPTIONS (@var{level}, @var{size})
826 Some machines may desire to change what optimizations are performed for
827 various optimization levels.   This macro, if defined, is executed once
828 just after the optimization level is determined and before the remainder
829 of the command options have been parsed.  Values set in this macro are
830 used as the default values for the other command line options.
831
832 @var{level} is the optimization level specified; 2 if @option{-O2} is
833 specified, 1 if @option{-O} is specified, and 0 if neither is specified.
834
835 @var{size} is nonzero if @option{-Os} is specified and zero otherwise.
836
837 This macro is run once at program startup and when the optimization
838 options are changed via @code{#pragma GCC optimize} or by using the
839 @code{optimize} attribute.
840
841 @strong{Do not examine @code{write_symbols} in
842 this macro!} The debugging options are not supposed to alter the
843 generated code.
844 @end defmac
845
846 @deftypefn {Target Hook} bool TARGET_HELP (void)
847 This hook is called in response to the user invoking
848 @option{--target-help} on the command line.  It gives the target a
849 chance to display extra information on the target specific command
850 line options found in its @file{.opt} file.
851 @end deftypefn
852
853 @defmac CAN_DEBUG_WITHOUT_FP
854 Define this macro if debugging can be performed even without a frame
855 pointer.  If this macro is defined, GCC will turn on the
856 @option{-fomit-frame-pointer} option whenever @option{-O} is specified.
857 @end defmac
858
859 @node Per-Function Data
860 @section Defining data structures for per-function information.
861 @cindex per-function data
862 @cindex data structures
863
864 If the target needs to store information on a per-function basis, GCC
865 provides a macro and a couple of variables to allow this.  Note, just
866 using statics to store the information is a bad idea, since GCC supports
867 nested functions, so you can be halfway through encoding one function
868 when another one comes along.
869
870 GCC defines a data structure called @code{struct function} which
871 contains all of the data specific to an individual function.  This
872 structure contains a field called @code{machine} whose type is
873 @code{struct machine_function *}, which can be used by targets to point
874 to their own specific data.
875
876 If a target needs per-function specific data it should define the type
877 @code{struct machine_function} and also the macro @code{INIT_EXPANDERS}.
878 This macro should be used to initialize the function pointer
879 @code{init_machine_status}.  This pointer is explained below.
880
881 One typical use of per-function, target specific data is to create an
882 RTX to hold the register containing the function's return address.  This
883 RTX can then be used to implement the @code{__builtin_return_address}
884 function, for level 0.
885
886 Note---earlier implementations of GCC used a single data area to hold
887 all of the per-function information.  Thus when processing of a nested
888 function began the old per-function data had to be pushed onto a
889 stack, and when the processing was finished, it had to be popped off the
890 stack.  GCC used to provide function pointers called
891 @code{save_machine_status} and @code{restore_machine_status} to handle
892 the saving and restoring of the target specific information.  Since the
893 single data area approach is no longer used, these pointers are no
894 longer supported.
895
896 @defmac INIT_EXPANDERS
897 Macro called to initialize any target specific information.  This macro
898 is called once per function, before generation of any RTL has begun.
899 The intention of this macro is to allow the initialization of the
900 function pointer @code{init_machine_status}.
901 @end defmac
902
903 @deftypevar {void (*)(struct function *)} init_machine_status
904 If this function pointer is non-@code{NULL} it will be called once per
905 function, before function compilation starts, in order to allow the
906 target to perform any target specific initialization of the
907 @code{struct function} structure.  It is intended that this would be
908 used to initialize the @code{machine} of that structure.
909
910 @code{struct machine_function} structures are expected to be freed by GC@.
911 Generally, any memory that they reference must be allocated by using
912 @code{ggc_alloc}, including the structure itself.
913 @end deftypevar
914
915 @node Storage Layout
916 @section Storage Layout
917 @cindex storage layout
918
919 Note that the definitions of the macros in this table which are sizes or
920 alignments measured in bits do not need to be constant.  They can be C
921 expressions that refer to static variables, such as the @code{target_flags}.
922 @xref{Run-time Target}.
923
924 @defmac BITS_BIG_ENDIAN
925 Define this macro to have the value 1 if the most significant bit in a
926 byte has the lowest number; otherwise define it to have the value zero.
927 This means that bit-field instructions count from the most significant
928 bit.  If the machine has no bit-field instructions, then this must still
929 be defined, but it doesn't matter which value it is defined to.  This
930 macro need not be a constant.
931
932 This macro does not affect the way structure fields are packed into
933 bytes or words; that is controlled by @code{BYTES_BIG_ENDIAN}.
934 @end defmac
935
936 @defmac BYTES_BIG_ENDIAN
937 Define this macro to have the value 1 if the most significant byte in a
938 word has the lowest number.  This macro need not be a constant.
939 @end defmac
940
941 @defmac WORDS_BIG_ENDIAN
942 Define this macro to have the value 1 if, in a multiword object, the
943 most significant word has the lowest number.  This applies to both
944 memory locations and registers; GCC fundamentally assumes that the
945 order of words in memory is the same as the order in registers.  This
946 macro need not be a constant.
947 @end defmac
948
949 @defmac LIBGCC2_WORDS_BIG_ENDIAN
950 Define this macro if @code{WORDS_BIG_ENDIAN} is not constant.  This must be a
951 constant value with the same meaning as @code{WORDS_BIG_ENDIAN}, which will be
952 used only when compiling @file{libgcc2.c}.  Typically the value will be set
953 based on preprocessor defines.
954 @end defmac
955
956 @defmac FLOAT_WORDS_BIG_ENDIAN
957 Define this macro to have the value 1 if @code{DFmode}, @code{XFmode} or
958 @code{TFmode} floating point numbers are stored in memory with the word
959 containing the sign bit at the lowest address; otherwise define it to
960 have the value 0.  This macro need not be a constant.
961
962 You need not define this macro if the ordering is the same as for
963 multi-word integers.
964 @end defmac
965
966 @defmac BITS_PER_UNIT
967 Define this macro to be the number of bits in an addressable storage
968 unit (byte).  If you do not define this macro the default is 8.
969 @end defmac
970
971 @defmac BITS_PER_WORD
972 Number of bits in a word.  If you do not define this macro, the default
973 is @code{BITS_PER_UNIT * UNITS_PER_WORD}.
974 @end defmac
975
976 @defmac MAX_BITS_PER_WORD
977 Maximum number of bits in a word.  If this is undefined, the default is
978 @code{BITS_PER_WORD}.  Otherwise, it is the constant value that is the
979 largest value that @code{BITS_PER_WORD} can have at run-time.
980 @end defmac
981
982 @defmac UNITS_PER_WORD
983 Number of storage units in a word; normally the size of a general-purpose
984 register, a power of two from 1 or 8.
985 @end defmac
986
987 @defmac MIN_UNITS_PER_WORD
988 Minimum number of units in a word.  If this is undefined, the default is
989 @code{UNITS_PER_WORD}.  Otherwise, it is the constant value that is the
990 smallest value that @code{UNITS_PER_WORD} can have at run-time.
991 @end defmac
992
993 @defmac UNITS_PER_SIMD_WORD (@var{mode})
994 Number of units in the vectors that the vectorizer can produce for
995 scalar mode @var{mode}.  The default is equal to @code{UNITS_PER_WORD},
996 because the vectorizer can do some transformations even in absence of
997 specialized @acronym{SIMD} hardware.
998 @end defmac
999
1000 @defmac POINTER_SIZE
1001 Width of a pointer, in bits.  You must specify a value no wider than the
1002 width of @code{Pmode}.  If it is not equal to the width of @code{Pmode},
1003 you must define @code{POINTERS_EXTEND_UNSIGNED}.  If you do not specify
1004 a value the default is @code{BITS_PER_WORD}.
1005 @end defmac
1006
1007 @defmac POINTERS_EXTEND_UNSIGNED
1008 A C expression that determines how pointers should be extended from
1009 @code{ptr_mode} to either @code{Pmode} or @code{word_mode}.  It is
1010 greater than zero if pointers should be zero-extended, zero if they
1011 should be sign-extended, and negative if some other sort of conversion
1012 is needed.  In the last case, the extension is done by the target's
1013 @code{ptr_extend} instruction.
1014
1015 You need not define this macro if the @code{ptr_mode}, @code{Pmode}
1016 and @code{word_mode} are all the same width.
1017 @end defmac
1018
1019 @defmac PROMOTE_MODE (@var{m}, @var{unsignedp}, @var{type})
1020 A macro to update @var{m} and @var{unsignedp} when an object whose type
1021 is @var{type} and which has the specified mode and signedness is to be
1022 stored in a register.  This macro is only called when @var{type} is a
1023 scalar type.
1024
1025 On most RISC machines, which only have operations that operate on a full
1026 register, define this macro to set @var{m} to @code{word_mode} if
1027 @var{m} is an integer mode narrower than @code{BITS_PER_WORD}.  In most
1028 cases, only integer modes should be widened because wider-precision
1029 floating-point operations are usually more expensive than their narrower
1030 counterparts.
1031
1032 For most machines, the macro definition does not change @var{unsignedp}.
1033 However, some machines, have instructions that preferentially handle
1034 either signed or unsigned quantities of certain modes.  For example, on
1035 the DEC Alpha, 32-bit loads from memory and 32-bit add instructions
1036 sign-extend the result to 64 bits.  On such machines, set
1037 @var{unsignedp} according to which kind of extension is more efficient.
1038
1039 Do not define this macro if it would never modify @var{m}.
1040 @end defmac
1041
1042 @deftypefn {Target Hook} enum machine_mode TARGET_PROMOTE_FUNCTION_MODE (tree @var{type}, enum machine_mode @var{mode}, int *@var{punsignedp}, tree @var{funtype}, int @var{for_return})
1043 Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or
1044 function return values.  The target hook should return the new mode
1045 and possibly change @code{*@var{punsignedp}} if the promotion should
1046 change signedness.  This function is called only for scalar @emph{or
1047 pointer} types.
1048
1049 @var{for_return} allows to distinguish the promotion of arguments and
1050 return values.  If it is @code{1}, a return value is being promoted and
1051 @code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.
1052 If it is @code{2}, the returned mode should be that of the register in
1053 which an incoming parameter is copied, or the outgoing result is computed;
1054 then the hook should return the same mode as @code{promote_mode}, though
1055 the signedness may be different.
1056
1057 The default is to not promote arguments and return values.  You can
1058 also define the hook to @code{default_promote_function_mode_always_promote}
1059 if you would like to apply the same rules given by @code{PROMOTE_MODE}.
1060 @end deftypefn
1061
1062 @defmac PARM_BOUNDARY
1063 Normal alignment required for function parameters on the stack, in
1064 bits.  All stack parameters receive at least this much alignment
1065 regardless of data type.  On most machines, this is the same as the
1066 size of an integer.
1067 @end defmac
1068
1069 @defmac STACK_BOUNDARY
1070 Define this macro to the minimum alignment enforced by hardware for the
1071 stack pointer on this machine.  The definition is a C expression for the
1072 desired alignment (measured in bits).  This value is used as a default
1073 if @code{PREFERRED_STACK_BOUNDARY} is not defined.  On most machines,
1074 this should be the same as @code{PARM_BOUNDARY}.
1075 @end defmac
1076
1077 @defmac PREFERRED_STACK_BOUNDARY
1078 Define this macro if you wish to preserve a certain alignment for the
1079 stack pointer, greater than what the hardware enforces.  The definition
1080 is a C expression for the desired alignment (measured in bits).  This
1081 macro must evaluate to a value equal to or larger than
1082 @code{STACK_BOUNDARY}.
1083 @end defmac
1084
1085 @defmac INCOMING_STACK_BOUNDARY
1086 Define this macro if the incoming stack boundary may be different
1087 from @code{PREFERRED_STACK_BOUNDARY}.  This macro must evaluate
1088 to a value equal to or larger than @code{STACK_BOUNDARY}.
1089 @end defmac
1090
1091 @defmac FUNCTION_BOUNDARY
1092 Alignment required for a function entry point, in bits.
1093 @end defmac
1094
1095 @defmac BIGGEST_ALIGNMENT
1096 Biggest alignment that any data type can require on this machine, in
1097 bits.  Note that this is not the biggest alignment that is supported,
1098 just the biggest alignment that, when violated, may cause a fault.
1099 @end defmac
1100
1101 @defmac MALLOC_ABI_ALIGNMENT
1102 Alignment, in bits, a C conformant malloc implementation has to
1103 provide.  If not defined, the default value is @code{BITS_PER_WORD}.
1104 @end defmac
1105
1106 @defmac ATTRIBUTE_ALIGNED_VALUE
1107 Alignment used by the @code{__attribute__ ((aligned))} construct.  If
1108 not defined, the default value is @code{BIGGEST_ALIGNMENT}.
1109 @end defmac
1110
1111 @defmac MINIMUM_ATOMIC_ALIGNMENT
1112 If defined, the smallest alignment, in bits, that can be given to an
1113 object that can be referenced in one operation, without disturbing any
1114 nearby object.  Normally, this is @code{BITS_PER_UNIT}, but may be larger
1115 on machines that don't have byte or half-word store operations.
1116 @end defmac
1117
1118 @defmac BIGGEST_FIELD_ALIGNMENT
1119 Biggest alignment that any structure or union field can require on this
1120 machine, in bits.  If defined, this overrides @code{BIGGEST_ALIGNMENT} for
1121 structure and union fields only, unless the field alignment has been set
1122 by the @code{__attribute__ ((aligned (@var{n})))} construct.
1123 @end defmac
1124
1125 @defmac ADJUST_FIELD_ALIGN (@var{field}, @var{computed})
1126 An expression for the alignment of a structure field @var{field} if the
1127 alignment computed in the usual way (including applying of
1128 @code{BIGGEST_ALIGNMENT} and @code{BIGGEST_FIELD_ALIGNMENT} to the
1129 alignment) is @var{computed}.  It overrides alignment only if the
1130 field alignment has not been set by the
1131 @code{__attribute__ ((aligned (@var{n})))} construct.
1132 @end defmac
1133
1134 @defmac MAX_STACK_ALIGNMENT
1135 Biggest stack alignment guaranteed by the backend.  Use this macro
1136 to specify the maximum alignment of a variable on stack.
1137
1138 If not defined, the default value is @code{STACK_BOUNDARY}.
1139
1140 @c FIXME: The default should be @code{PREFERRED_STACK_BOUNDARY}.
1141 @c But the fix for PR 32893 indicates that we can only guarantee
1142 @c maximum stack alignment on stack up to @code{STACK_BOUNDARY}, not
1143 @c @code{PREFERRED_STACK_BOUNDARY}, if stack alignment isn't supported.
1144 @end defmac
1145
1146 @defmac MAX_OFILE_ALIGNMENT
1147 Biggest alignment supported by the object file format of this machine.
1148 Use this macro to limit the alignment which can be specified using the
1149 @code{__attribute__ ((aligned (@var{n})))} construct.  If not defined,
1150 the default value is @code{BIGGEST_ALIGNMENT}.
1151
1152 On systems that use ELF, the default (in @file{config/elfos.h}) is
1153 the largest supported 32-bit ELF section alignment representable on
1154 a 32-bit host e.g. @samp{(((unsigned HOST_WIDEST_INT) 1 << 28) * 8)}.
1155 On 32-bit ELF the largest supported section alignment in bits is
1156 @samp{(0x80000000 * 8)}, but this is not representable on 32-bit hosts.
1157 @end defmac
1158
1159 @defmac DATA_ALIGNMENT (@var{type}, @var{basic-align})
1160 If defined, a C expression to compute the alignment for a variable in
1161 the static store.  @var{type} is the data type, and @var{basic-align} is
1162 the alignment that the object would ordinarily have.  The value of this
1163 macro is used instead of that alignment to align the object.
1164
1165 If this macro is not defined, then @var{basic-align} is used.
1166
1167 @findex strcpy
1168 One use of this macro is to increase alignment of medium-size data to
1169 make it all fit in fewer cache lines.  Another is to cause character
1170 arrays to be word-aligned so that @code{strcpy} calls that copy
1171 constants to character arrays can be done inline.
1172 @end defmac
1173
1174 @defmac CONSTANT_ALIGNMENT (@var{constant}, @var{basic-align})
1175 If defined, a C expression to compute the alignment given to a constant
1176 that is being placed in memory.  @var{constant} is the constant and
1177 @var{basic-align} is the alignment that the object would ordinarily
1178 have.  The value of this macro is used instead of that alignment to
1179 align the object.
1180
1181 If this macro is not defined, then @var{basic-align} is used.
1182
1183 The typical use of this macro is to increase alignment for string
1184 constants to be word aligned so that @code{strcpy} calls that copy
1185 constants can be done inline.
1186 @end defmac
1187
1188 @defmac LOCAL_ALIGNMENT (@var{type}, @var{basic-align})
1189 If defined, a C expression to compute the alignment for a variable in
1190 the local store.  @var{type} is the data type, and @var{basic-align} is
1191 the alignment that the object would ordinarily have.  The value of this
1192 macro is used instead of that alignment to align the object.
1193
1194 If this macro is not defined, then @var{basic-align} is used.
1195
1196 One use of this macro is to increase alignment of medium-size data to
1197 make it all fit in fewer cache lines.
1198 @end defmac
1199
1200 @defmac STACK_SLOT_ALIGNMENT (@var{type}, @var{mode}, @var{basic-align})
1201 If defined, a C expression to compute the alignment for stack slot.
1202 @var{type} is the data type, @var{mode} is the widest mode available,
1203 and @var{basic-align} is the alignment that the slot would ordinarily
1204 have.  The value of this macro is used instead of that alignment to
1205 align the slot.
1206
1207 If this macro is not defined, then @var{basic-align} is used when
1208 @var{type} is @code{NULL}.  Otherwise, @code{LOCAL_ALIGNMENT} will
1209 be used.
1210
1211 This macro is to set alignment of stack slot to the maximum alignment
1212 of all possible modes which the slot may have.
1213 @end defmac
1214
1215 @defmac LOCAL_DECL_ALIGNMENT (@var{decl})
1216 If defined, a C expression to compute the alignment for a local
1217 variable @var{decl}.
1218
1219 If this macro is not defined, then
1220 @code{LOCAL_ALIGNMENT (TREE_TYPE (@var{decl}), DECL_ALIGN (@var{decl}))}
1221 is used.
1222
1223 One use of this macro is to increase alignment of medium-size data to
1224 make it all fit in fewer cache lines.
1225 @end defmac
1226
1227 @defmac MINIMUM_ALIGNMENT (@var{exp}, @var{mode}, @var{align})
1228 If defined, a C expression to compute the minimum required alignment
1229 for dynamic stack realignment purposes for @var{exp} (a type or decl),
1230 @var{mode}, assuming normal alignment @var{align}.
1231
1232 If this macro is not defined, then @var{align} will be used.
1233 @end defmac
1234
1235 @defmac EMPTY_FIELD_BOUNDARY
1236 Alignment in bits to be given to a structure bit-field that follows an
1237 empty field such as @code{int : 0;}.
1238
1239 If @code{PCC_BITFIELD_TYPE_MATTERS} is true, it overrides this macro.
1240 @end defmac
1241
1242 @defmac STRUCTURE_SIZE_BOUNDARY
1243 Number of bits which any structure or union's size must be a multiple of.
1244 Each structure or union's size is rounded up to a multiple of this.
1245
1246 If you do not define this macro, the default is the same as
1247 @code{BITS_PER_UNIT}.
1248 @end defmac
1249
1250 @defmac STRICT_ALIGNMENT
1251 Define this macro to be the value 1 if instructions will fail to work
1252 if given data not on the nominal alignment.  If instructions will merely
1253 go slower in that case, define this macro as 0.
1254 @end defmac
1255
1256 @defmac PCC_BITFIELD_TYPE_MATTERS
1257 Define this if you wish to imitate the way many other C compilers handle
1258 alignment of bit-fields and the structures that contain them.
1259
1260 The behavior is that the type written for a named bit-field (@code{int},
1261 @code{short}, or other integer type) imposes an alignment for the entire
1262 structure, as if the structure really did contain an ordinary field of
1263 that type.  In addition, the bit-field is placed within the structure so
1264 that it would fit within such a field, not crossing a boundary for it.
1265
1266 Thus, on most machines, a named bit-field whose type is written as
1267 @code{int} would not cross a four-byte boundary, and would force
1268 four-byte alignment for the whole structure.  (The alignment used may
1269 not be four bytes; it is controlled by the other alignment parameters.)
1270
1271 An unnamed bit-field will not affect the alignment of the containing
1272 structure.
1273
1274 If the macro is defined, its definition should be a C expression;
1275 a nonzero value for the expression enables this behavior.
1276
1277 Note that if this macro is not defined, or its value is zero, some
1278 bit-fields may cross more than one alignment boundary.  The compiler can
1279 support such references if there are @samp{insv}, @samp{extv}, and
1280 @samp{extzv} insns that can directly reference memory.
1281
1282 The other known way of making bit-fields work is to define
1283 @code{STRUCTURE_SIZE_BOUNDARY} as large as @code{BIGGEST_ALIGNMENT}.
1284 Then every structure can be accessed with fullwords.
1285
1286 Unless the machine has bit-field instructions or you define
1287 @code{STRUCTURE_SIZE_BOUNDARY} that way, you must define
1288 @code{PCC_BITFIELD_TYPE_MATTERS} to have a nonzero value.
1289
1290 If your aim is to make GCC use the same conventions for laying out
1291 bit-fields as are used by another compiler, here is how to investigate
1292 what the other compiler does.  Compile and run this program:
1293
1294 @smallexample
1295 struct foo1
1296 @{
1297   char x;
1298   char :0;
1299   char y;
1300 @};
1301
1302 struct foo2
1303 @{
1304   char x;
1305   int :0;
1306   char y;
1307 @};
1308
1309 main ()
1310 @{
1311   printf ("Size of foo1 is %d\n",
1312           sizeof (struct foo1));
1313   printf ("Size of foo2 is %d\n",
1314           sizeof (struct foo2));
1315   exit (0);
1316 @}
1317 @end smallexample
1318
1319 If this prints 2 and 5, then the compiler's behavior is what you would
1320 get from @code{PCC_BITFIELD_TYPE_MATTERS}.
1321 @end defmac
1322
1323 @defmac BITFIELD_NBYTES_LIMITED
1324 Like @code{PCC_BITFIELD_TYPE_MATTERS} except that its effect is limited
1325 to aligning a bit-field within the structure.
1326 @end defmac
1327
1328 @deftypefn {Target Hook} bool TARGET_ALIGN_ANON_BITFIELD (void)
1329 When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine
1330 whether unnamed bitfields affect the alignment of the containing
1331 structure.  The hook should return true if the structure should inherit
1332 the alignment requirements of an unnamed bitfield's type.
1333 @end deftypefn
1334
1335 @deftypefn {Target Hook} bool TARGET_NARROW_VOLATILE_BITFIELD (void)
1336 This target hook should return @code{true} if accesses to volatile bitfields
1337 should use the narrowest mode possible.  It should return @code{false} if
1338 these accesses should use the bitfield container type.
1339
1340 The default is @code{!TARGET_STRICT_ALIGN}.
1341 @end deftypefn
1342
1343 @defmac MEMBER_TYPE_FORCES_BLK (@var{field}, @var{mode})
1344 Return 1 if a structure or array containing @var{field} should be accessed using
1345 @code{BLKMODE}.
1346
1347 If @var{field} is the only field in the structure, @var{mode} is its
1348 mode, otherwise @var{mode} is VOIDmode.  @var{mode} is provided in the
1349 case where structures of one field would require the structure's mode to
1350 retain the field's mode.
1351
1352 Normally, this is not needed.
1353 @end defmac
1354
1355 @defmac ROUND_TYPE_ALIGN (@var{type}, @var{computed}, @var{specified})
1356 Define this macro as an expression for the alignment of a type (given
1357 by @var{type} as a tree node) if the alignment computed in the usual
1358 way is @var{computed} and the alignment explicitly specified was
1359 @var{specified}.
1360
1361 The default is to use @var{specified} if it is larger; otherwise, use
1362 the smaller of @var{computed} and @code{BIGGEST_ALIGNMENT}
1363 @end defmac
1364
1365 @defmac MAX_FIXED_MODE_SIZE
1366 An integer expression for the size in bits of the largest integer
1367 machine mode that should actually be used.  All integer machine modes of
1368 this size or smaller can be used for structures and unions with the
1369 appropriate sizes.  If this macro is undefined, @code{GET_MODE_BITSIZE
1370 (DImode)} is assumed.
1371 @end defmac
1372
1373 @defmac STACK_SAVEAREA_MODE (@var{save_level})
1374 If defined, an expression of type @code{enum machine_mode} that
1375 specifies the mode of the save area operand of a
1376 @code{save_stack_@var{level}} named pattern (@pxref{Standard Names}).
1377 @var{save_level} is one of @code{SAVE_BLOCK}, @code{SAVE_FUNCTION}, or
1378 @code{SAVE_NONLOCAL} and selects which of the three named patterns is
1379 having its mode specified.
1380
1381 You need not define this macro if it always returns @code{Pmode}.  You
1382 would most commonly define this macro if the
1383 @code{save_stack_@var{level}} patterns need to support both a 32- and a
1384 64-bit mode.
1385 @end defmac
1386
1387 @defmac STACK_SIZE_MODE
1388 If defined, an expression of type @code{enum machine_mode} that
1389 specifies the mode of the size increment operand of an
1390 @code{allocate_stack} named pattern (@pxref{Standard Names}).
1391
1392 You need not define this macro if it always returns @code{word_mode}.
1393 You would most commonly define this macro if the @code{allocate_stack}
1394 pattern needs to support both a 32- and a 64-bit mode.
1395 @end defmac
1396
1397 @deftypefn {Target Hook} {enum machine_mode} TARGET_LIBGCC_CMP_RETURN_MODE ()
1398 This target hook should return the mode to be used for the return value
1399 of compare instructions expanded to libgcc calls.  If not defined
1400 @code{word_mode} is returned which is the right choice for a majority of
1401 targets.
1402 @end deftypefn
1403
1404 @deftypefn {Target Hook} {enum machine_mode} TARGET_LIBGCC_SHIFT_COUNT_MODE ()
1405 This target hook should return the mode to be used for the shift count operand
1406 of shift instructions expanded to libgcc calls.  If not defined
1407 @code{word_mode} is returned which is the right choice for a majority of
1408 targets.
1409 @end deftypefn
1410
1411 @defmac ROUND_TOWARDS_ZERO
1412 If defined, this macro should be true if the prevailing rounding
1413 mode is towards zero.
1414
1415 Defining this macro only affects the way @file{libgcc.a} emulates
1416 floating-point arithmetic.
1417
1418 Not defining this macro is equivalent to returning zero.
1419 @end defmac
1420
1421 @defmac LARGEST_EXPONENT_IS_NORMAL (@var{size})
1422 This macro should return true if floats with @var{size}
1423 bits do not have a NaN or infinity representation, but use the largest
1424 exponent for normal numbers instead.
1425
1426 Defining this macro only affects the way @file{libgcc.a} emulates
1427 floating-point arithmetic.
1428
1429 The default definition of this macro returns false for all sizes.
1430 @end defmac
1431
1432 @deftypefn {Target Hook} bool TARGET_MS_BITFIELD_LAYOUT_P (tree @var{record_type})
1433 This target hook returns @code{true} if bit-fields in the given
1434 @var{record_type} are to be laid out following the rules of Microsoft
1435 Visual C/C++, namely: (i) a bit-field won't share the same storage
1436 unit with the previous bit-field if their underlying types have
1437 different sizes, and the bit-field will be aligned to the highest
1438 alignment of the underlying types of itself and of the previous
1439 bit-field; (ii) a zero-sized bit-field will affect the alignment of
1440 the whole enclosing structure, even if it is unnamed; except that
1441 (iii) a zero-sized bit-field will be disregarded unless it follows
1442 another bit-field of nonzero size.  If this hook returns @code{true},
1443 other macros that control bit-field layout are ignored.
1444
1445 When a bit-field is inserted into a packed record, the whole size
1446 of the underlying type is used by one or more same-size adjacent
1447 bit-fields (that is, if its long:3, 32 bits is used in the record,
1448 and any additional adjacent long bit-fields are packed into the same
1449 chunk of 32 bits.  However, if the size changes, a new field of that
1450 size is allocated).  In an unpacked record, this is the same as using
1451 alignment, but not equivalent when packing.
1452
1453 If both MS bit-fields and @samp{__attribute__((packed))} are used,
1454 the latter will take precedence.  If @samp{__attribute__((packed))} is
1455 used on a single field when MS bit-fields are in use, it will take
1456 precedence for that field, but the alignment of the rest of the structure
1457 may affect its placement.
1458 @end deftypefn
1459
1460 @deftypefn {Target Hook} {bool} TARGET_DECIMAL_FLOAT_SUPPORTED_P (void)
1461 Returns true if the target supports decimal floating point.
1462 @end deftypefn
1463
1464 @deftypefn {Target Hook} {bool} TARGET_FIXED_POINT_SUPPORTED_P (void)
1465 Returns true if the target supports fixed-point arithmetic.
1466 @end deftypefn
1467
1468 @deftypefn {Target Hook} void TARGET_EXPAND_TO_RTL_HOOK (void)
1469 This hook is called just before expansion into rtl, allowing the target
1470 to perform additional initializations or analysis before the expansion.
1471 For example, the rs6000 port uses it to allocate a scratch stack slot
1472 for use in copying SDmode values between memory and floating point
1473 registers whenever the function being expanded has any SDmode
1474 usage.
1475 @end deftypefn
1476
1477 @deftypefn {Target Hook} void TARGET_INSTANTIATE_DECLS (void)
1478 This hook allows the backend to perform additional instantiations on rtl
1479 that are not actually in any insns yet, but will be later.
1480 @end deftypefn
1481
1482 @deftypefn {Target Hook} {const char *} TARGET_MANGLE_TYPE (tree @var{type})
1483 If your target defines any fundamental types, or any types your target
1484 uses should be mangled differently from the default, define this hook
1485 to return the appropriate encoding for these types as part of a C++
1486 mangled name.  The @var{type} argument is the tree structure representing
1487 the type to be mangled.  The hook may be applied to trees which are
1488 not target-specific fundamental types; it should return @code{NULL}
1489 for all such types, as well as arguments it does not recognize.  If the
1490 return value is not @code{NULL}, it must point to a statically-allocated
1491 string constant.
1492
1493 Target-specific fundamental types might be new fundamental types or
1494 qualified versions of ordinary fundamental types.  Encode new
1495 fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}
1496 is the name used for the type in source code, and @var{n} is the
1497 length of @var{name} in decimal.  Encode qualified versions of
1498 ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where
1499 @var{name} is the name used for the type qualifier in source code,
1500 @var{n} is the length of @var{name} as above, and @var{code} is the
1501 code used to represent the unqualified version of this type.  (See
1502 @code{write_builtin_type} in @file{cp/mangle.c} for the list of
1503 codes.)  In both cases the spaces are for clarity; do not include any
1504 spaces in your string.
1505
1506 This hook is applied to types prior to typedef resolution.  If the mangled
1507 name for a particular type depends only on that type's main variant, you
1508 can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}
1509 before mangling.
1510
1511 The default version of this hook always returns @code{NULL}, which is
1512 appropriate for a target that does not define any new fundamental
1513 types.
1514 @end deftypefn
1515
1516 @node Type Layout
1517 @section Layout of Source Language Data Types
1518
1519 These macros define the sizes and other characteristics of the standard
1520 basic data types used in programs being compiled.  Unlike the macros in
1521 the previous section, these apply to specific features of C and related
1522 languages, rather than to fundamental aspects of storage layout.
1523
1524 @defmac INT_TYPE_SIZE
1525 A C expression for the size in bits of the type @code{int} on the
1526 target machine.  If you don't define this, the default is one word.
1527 @end defmac
1528
1529 @defmac SHORT_TYPE_SIZE
1530 A C expression for the size in bits of the type @code{short} on the
1531 target machine.  If you don't define this, the default is half a word.
1532 (If this would be less than one storage unit, it is rounded up to one
1533 unit.)
1534 @end defmac
1535
1536 @defmac LONG_TYPE_SIZE
1537 A C expression for the size in bits of the type @code{long} on the
1538 target machine.  If you don't define this, the default is one word.
1539 @end defmac
1540
1541 @defmac ADA_LONG_TYPE_SIZE
1542 On some machines, the size used for the Ada equivalent of the type
1543 @code{long} by a native Ada compiler differs from that used by C@.  In
1544 that situation, define this macro to be a C expression to be used for
1545 the size of that type.  If you don't define this, the default is the
1546 value of @code{LONG_TYPE_SIZE}.
1547 @end defmac
1548
1549 @defmac LONG_LONG_TYPE_SIZE
1550 A C expression for the size in bits of the type @code{long long} on the
1551 target machine.  If you don't define this, the default is two
1552 words.  If you want to support GNU Ada on your machine, the value of this
1553 macro must be at least 64.
1554 @end defmac
1555
1556 @defmac CHAR_TYPE_SIZE
1557 A C expression for the size in bits of the type @code{char} on the
1558 target machine.  If you don't define this, the default is
1559 @code{BITS_PER_UNIT}.
1560 @end defmac
1561
1562 @defmac BOOL_TYPE_SIZE
1563 A C expression for the size in bits of the C++ type @code{bool} and
1564 C99 type @code{_Bool} on the target machine.  If you don't define
1565 this, and you probably shouldn't, the default is @code{CHAR_TYPE_SIZE}.
1566 @end defmac
1567
1568 @defmac FLOAT_TYPE_SIZE
1569 A C expression for the size in bits of the type @code{float} on the
1570 target machine.  If you don't define this, the default is one word.
1571 @end defmac
1572
1573 @defmac DOUBLE_TYPE_SIZE
1574 A C expression for the size in bits of the type @code{double} on the
1575 target machine.  If you don't define this, the default is two
1576 words.
1577 @end defmac
1578
1579 @defmac LONG_DOUBLE_TYPE_SIZE
1580 A C expression for the size in bits of the type @code{long double} on
1581 the target machine.  If you don't define this, the default is two
1582 words.
1583 @end defmac
1584
1585 @defmac SHORT_FRACT_TYPE_SIZE
1586 A C expression for the size in bits of the type @code{short _Fract} on
1587 the target machine.  If you don't define this, the default is
1588 @code{BITS_PER_UNIT}.
1589 @end defmac
1590
1591 @defmac FRACT_TYPE_SIZE
1592 A C expression for the size in bits of the type @code{_Fract} on
1593 the target machine.  If you don't define this, the default is
1594 @code{BITS_PER_UNIT * 2}.
1595 @end defmac
1596
1597 @defmac LONG_FRACT_TYPE_SIZE
1598 A C expression for the size in bits of the type @code{long _Fract} on
1599 the target machine.  If you don't define this, the default is
1600 @code{BITS_PER_UNIT * 4}.
1601 @end defmac
1602
1603 @defmac LONG_LONG_FRACT_TYPE_SIZE
1604 A C expression for the size in bits of the type @code{long long _Fract} on
1605 the target machine.  If you don't define this, the default is
1606 @code{BITS_PER_UNIT * 8}.
1607 @end defmac
1608
1609 @defmac SHORT_ACCUM_TYPE_SIZE
1610 A C expression for the size in bits of the type @code{short _Accum} on
1611 the target machine.  If you don't define this, the default is
1612 @code{BITS_PER_UNIT * 2}.
1613 @end defmac
1614
1615 @defmac ACCUM_TYPE_SIZE
1616 A C expression for the size in bits of the type @code{_Accum} on
1617 the target machine.  If you don't define this, the default is
1618 @code{BITS_PER_UNIT * 4}.
1619 @end defmac
1620
1621 @defmac LONG_ACCUM_TYPE_SIZE
1622 A C expression for the size in bits of the type @code{long _Accum} on
1623 the target machine.  If you don't define this, the default is
1624 @code{BITS_PER_UNIT * 8}.
1625 @end defmac
1626
1627 @defmac LONG_LONG_ACCUM_TYPE_SIZE
1628 A C expression for the size in bits of the type @code{long long _Accum} on
1629 the target machine.  If you don't define this, the default is
1630 @code{BITS_PER_UNIT * 16}.
1631 @end defmac
1632
1633 @defmac LIBGCC2_LONG_DOUBLE_TYPE_SIZE
1634 Define this macro if @code{LONG_DOUBLE_TYPE_SIZE} is not constant or
1635 if you want routines in @file{libgcc2.a} for a size other than
1636 @code{LONG_DOUBLE_TYPE_SIZE}.  If you don't define this, the
1637 default is @code{LONG_DOUBLE_TYPE_SIZE}.
1638 @end defmac
1639
1640 @defmac LIBGCC2_HAS_DF_MODE
1641 Define this macro if neither @code{LIBGCC2_DOUBLE_TYPE_SIZE} nor
1642 @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is
1643 @code{DFmode} but you want @code{DFmode} routines in @file{libgcc2.a}
1644 anyway.  If you don't define this and either @code{LIBGCC2_DOUBLE_TYPE_SIZE}
1645 or @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is 64 then the default is 1,
1646 otherwise it is 0.
1647 @end defmac
1648
1649 @defmac LIBGCC2_HAS_XF_MODE
1650 Define this macro if @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is not
1651 @code{XFmode} but you want @code{XFmode} routines in @file{libgcc2.a}
1652 anyway.  If you don't define this and @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE}
1653 is 80 then the default is 1, otherwise it is 0.
1654 @end defmac
1655
1656 @defmac LIBGCC2_HAS_TF_MODE
1657 Define this macro if @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is not
1658 @code{TFmode} but you want @code{TFmode} routines in @file{libgcc2.a}
1659 anyway.  If you don't define this and @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE}
1660 is 128 then the default is 1, otherwise it is 0.
1661 @end defmac
1662
1663 @defmac SF_SIZE
1664 @defmacx DF_SIZE
1665 @defmacx XF_SIZE
1666 @defmacx TF_SIZE
1667 Define these macros to be the size in bits of the mantissa of
1668 @code{SFmode}, @code{DFmode}, @code{XFmode} and @code{TFmode} values,
1669 if the defaults in @file{libgcc2.h} are inappropriate.  By default,
1670 @code{FLT_MANT_DIG} is used for @code{SF_SIZE}, @code{LDBL_MANT_DIG}
1671 for @code{XF_SIZE} and @code{TF_SIZE}, and @code{DBL_MANT_DIG} or
1672 @code{LDBL_MANT_DIG} for @code{DF_SIZE} according to whether
1673 @code{LIBGCC2_DOUBLE_TYPE_SIZE} or
1674 @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is 64.
1675 @end defmac
1676
1677 @defmac TARGET_FLT_EVAL_METHOD
1678 A C expression for the value for @code{FLT_EVAL_METHOD} in @file{float.h},
1679 assuming, if applicable, that the floating-point control word is in its
1680 default state.  If you do not define this macro the value of
1681 @code{FLT_EVAL_METHOD} will be zero.
1682 @end defmac
1683
1684 @defmac WIDEST_HARDWARE_FP_SIZE
1685 A C expression for the size in bits of the widest floating-point format
1686 supported by the hardware.  If you define this macro, you must specify a
1687 value less than or equal to the value of @code{LONG_DOUBLE_TYPE_SIZE}.
1688 If you do not define this macro, the value of @code{LONG_DOUBLE_TYPE_SIZE}
1689 is the default.
1690 @end defmac
1691
1692 @defmac DEFAULT_SIGNED_CHAR
1693 An expression whose value is 1 or 0, according to whether the type
1694 @code{char} should be signed or unsigned by default.  The user can
1695 always override this default with the options @option{-fsigned-char}
1696 and @option{-funsigned-char}.
1697 @end defmac
1698
1699 @deftypefn {Target Hook} bool TARGET_DEFAULT_SHORT_ENUMS (void)
1700 This target hook should return true if the compiler should give an
1701 @code{enum} type only as many bytes as it takes to represent the range
1702 of possible values of that type.  It should return false if all
1703 @code{enum} types should be allocated like @code{int}.
1704
1705 The default is to return false.
1706 @end deftypefn
1707
1708 @defmac SIZE_TYPE
1709 A C expression for a string describing the name of the data type to use
1710 for size values.  The typedef name @code{size_t} is defined using the
1711 contents of the string.
1712
1713 The string can contain more than one keyword.  If so, separate them with
1714 spaces, and write first any length keyword, then @code{unsigned} if
1715 appropriate, and finally @code{int}.  The string must exactly match one
1716 of the data type names defined in the function
1717 @code{init_decl_processing} in the file @file{c-decl.c}.  You may not
1718 omit @code{int} or change the order---that would cause the compiler to
1719 crash on startup.
1720
1721 If you don't define this macro, the default is @code{"long unsigned
1722 int"}.
1723 @end defmac
1724
1725 @defmac PTRDIFF_TYPE
1726 A C expression for a string describing the name of the data type to use
1727 for the result of subtracting two pointers.  The typedef name
1728 @code{ptrdiff_t} is defined using the contents of the string.  See
1729 @code{SIZE_TYPE} above for more information.
1730
1731 If you don't define this macro, the default is @code{"long int"}.
1732 @end defmac
1733
1734 @defmac WCHAR_TYPE
1735 A C expression for a string describing the name of the data type to use
1736 for wide characters.  The typedef name @code{wchar_t} is defined using
1737 the contents of the string.  See @code{SIZE_TYPE} above for more
1738 information.
1739
1740 If you don't define this macro, the default is @code{"int"}.
1741 @end defmac
1742
1743 @defmac WCHAR_TYPE_SIZE
1744 A C expression for the size in bits of the data type for wide
1745 characters.  This is used in @code{cpp}, which cannot make use of
1746 @code{WCHAR_TYPE}.
1747 @end defmac
1748
1749 @defmac WINT_TYPE
1750 A C expression for a string describing the name of the data type to
1751 use for wide characters passed to @code{printf} and returned from
1752 @code{getwc}.  The typedef name @code{wint_t} is defined using the
1753 contents of the string.  See @code{SIZE_TYPE} above for more
1754 information.
1755
1756 If you don't define this macro, the default is @code{"unsigned int"}.
1757 @end defmac
1758
1759 @defmac INTMAX_TYPE
1760 A C expression for a string describing the name of the data type that
1761 can represent any value of any standard or extended signed integer type.
1762 The typedef name @code{intmax_t} is defined using the contents of the
1763 string.  See @code{SIZE_TYPE} above for more information.
1764
1765 If you don't define this macro, the default is the first of
1766 @code{"int"}, @code{"long int"}, or @code{"long long int"} that has as
1767 much precision as @code{long long int}.
1768 @end defmac
1769
1770 @defmac UINTMAX_TYPE
1771 A C expression for a string describing the name of the data type that
1772 can represent any value of any standard or extended unsigned integer
1773 type.  The typedef name @code{uintmax_t} is defined using the contents
1774 of the string.  See @code{SIZE_TYPE} above for more information.
1775
1776 If you don't define this macro, the default is the first of
1777 @code{"unsigned int"}, @code{"long unsigned int"}, or @code{"long long
1778 unsigned int"} that has as much precision as @code{long long unsigned
1779 int}.
1780 @end defmac
1781
1782 @defmac SIG_ATOMIC_TYPE
1783 @defmacx INT8_TYPE
1784 @defmacx INT16_TYPE
1785 @defmacx INT32_TYPE
1786 @defmacx INT64_TYPE
1787 @defmacx UINT8_TYPE
1788 @defmacx UINT16_TYPE
1789 @defmacx UINT32_TYPE
1790 @defmacx UINT64_TYPE
1791 @defmacx INT_LEAST8_TYPE
1792 @defmacx INT_LEAST16_TYPE
1793 @defmacx INT_LEAST32_TYPE
1794 @defmacx INT_LEAST64_TYPE
1795 @defmacx UINT_LEAST8_TYPE
1796 @defmacx UINT_LEAST16_TYPE
1797 @defmacx UINT_LEAST32_TYPE
1798 @defmacx UINT_LEAST64_TYPE
1799 @defmacx INT_FAST8_TYPE
1800 @defmacx INT_FAST16_TYPE
1801 @defmacx INT_FAST32_TYPE
1802 @defmacx INT_FAST64_TYPE
1803 @defmacx UINT_FAST8_TYPE
1804 @defmacx UINT_FAST16_TYPE
1805 @defmacx UINT_FAST32_TYPE
1806 @defmacx UINT_FAST64_TYPE
1807 @defmacx INTPTR_TYPE
1808 @defmacx UINTPTR_TYPE
1809 C expressions for the standard types @code{sig_atomic_t},
1810 @code{int8_t}, @code{int16_t}, @code{int32_t}, @code{int64_t},
1811 @code{uint8_t}, @code{uint16_t}, @code{uint32_t}, @code{uint64_t},
1812 @code{int_least8_t}, @code{int_least16_t}, @code{int_least32_t},
1813 @code{int_least64_t}, @code{uint_least8_t}, @code{uint_least16_t},
1814 @code{uint_least32_t}, @code{uint_least64_t}, @code{int_fast8_t},
1815 @code{int_fast16_t}, @code{int_fast32_t}, @code{int_fast64_t},
1816 @code{uint_fast8_t}, @code{uint_fast16_t}, @code{uint_fast32_t},
1817 @code{uint_fast64_t}, @code{intptr_t}, and @code{uintptr_t}.  See
1818 @code{SIZE_TYPE} above for more information.
1819
1820 If any of these macros evaluates to a null pointer, the corresponding
1821 type is not supported; if GCC is configured to provide
1822 @code{<stdint.h>} in such a case, the header provided may not conform
1823 to C99, depending on the type in question.  The defaults for all of
1824 these macros are null pointers.
1825 @end defmac
1826
1827 @defmac TARGET_PTRMEMFUNC_VBIT_LOCATION
1828 The C++ compiler represents a pointer-to-member-function with a struct
1829 that looks like:
1830
1831 @smallexample
1832   struct @{
1833     union @{
1834       void (*fn)();
1835       ptrdiff_t vtable_index;
1836     @};
1837     ptrdiff_t delta;
1838   @};
1839 @end smallexample
1840
1841 @noindent
1842 The C++ compiler must use one bit to indicate whether the function that
1843 will be called through a pointer-to-member-function is virtual.
1844 Normally, we assume that the low-order bit of a function pointer must
1845 always be zero.  Then, by ensuring that the vtable_index is odd, we can
1846 distinguish which variant of the union is in use.  But, on some
1847 platforms function pointers can be odd, and so this doesn't work.  In
1848 that case, we use the low-order bit of the @code{delta} field, and shift
1849 the remainder of the @code{delta} field to the left.
1850
1851 GCC will automatically make the right selection about where to store
1852 this bit using the @code{FUNCTION_BOUNDARY} setting for your platform.
1853 However, some platforms such as ARM/Thumb have @code{FUNCTION_BOUNDARY}
1854 set such that functions always start at even addresses, but the lowest
1855 bit of pointers to functions indicate whether the function at that
1856 address is in ARM or Thumb mode.  If this is the case of your
1857 architecture, you should define this macro to
1858 @code{ptrmemfunc_vbit_in_delta}.
1859
1860 In general, you should not have to define this macro.  On architectures
1861 in which function addresses are always even, according to
1862 @code{FUNCTION_BOUNDARY}, GCC will automatically define this macro to
1863 @code{ptrmemfunc_vbit_in_pfn}.
1864 @end defmac
1865
1866 @defmac TARGET_VTABLE_USES_DESCRIPTORS
1867 Normally, the C++ compiler uses function pointers in vtables.  This
1868 macro allows the target to change to use ``function descriptors''
1869 instead.  Function descriptors are found on targets for whom a
1870 function pointer is actually a small data structure.  Normally the
1871 data structure consists of the actual code address plus a data
1872 pointer to which the function's data is relative.
1873
1874 If vtables are used, the value of this macro should be the number
1875 of words that the function descriptor occupies.
1876 @end defmac
1877
1878 @defmac TARGET_VTABLE_ENTRY_ALIGN
1879 By default, the vtable entries are void pointers, the so the alignment
1880 is the same as pointer alignment.  The value of this macro specifies
1881 the alignment of the vtable entry in bits.  It should be defined only
1882 when special alignment is necessary. */
1883 @end defmac
1884
1885 @defmac TARGET_VTABLE_DATA_ENTRY_DISTANCE
1886 There are a few non-descriptor entries in the vtable at offsets below
1887 zero.  If these entries must be padded (say, to preserve the alignment
1888 specified by @code{TARGET_VTABLE_ENTRY_ALIGN}), set this to the number
1889 of words in each data entry.
1890 @end defmac
1891
1892 @node Registers
1893 @section Register Usage
1894 @cindex register usage
1895
1896 This section explains how to describe what registers the target machine
1897 has, and how (in general) they can be used.
1898
1899 The description of which registers a specific instruction can use is
1900 done with register classes; see @ref{Register Classes}.  For information
1901 on using registers to access a stack frame, see @ref{Frame Registers}.
1902 For passing values in registers, see @ref{Register Arguments}.
1903 For returning values in registers, see @ref{Scalar Return}.
1904
1905 @menu
1906 * Register Basics::             Number and kinds of registers.
1907 * Allocation Order::            Order in which registers are allocated.
1908 * Values in Registers::         What kinds of values each reg can hold.
1909 * Leaf Functions::              Renumbering registers for leaf functions.
1910 * Stack Registers::             Handling a register stack such as 80387.
1911 @end menu
1912
1913 @node Register Basics
1914 @subsection Basic Characteristics of Registers
1915
1916 @c prevent bad page break with this line
1917 Registers have various characteristics.
1918
1919 @defmac FIRST_PSEUDO_REGISTER
1920 Number of hardware registers known to the compiler.  They receive
1921 numbers 0 through @code{FIRST_PSEUDO_REGISTER-1}; thus, the first
1922 pseudo register's number really is assigned the number
1923 @code{FIRST_PSEUDO_REGISTER}.
1924 @end defmac
1925
1926 @defmac FIXED_REGISTERS
1927 @cindex fixed register
1928 An initializer that says which registers are used for fixed purposes
1929 all throughout the compiled code and are therefore not available for
1930 general allocation.  These would include the stack pointer, the frame
1931 pointer (except on machines where that can be used as a general
1932 register when no frame pointer is needed), the program counter on
1933 machines where that is considered one of the addressable registers,
1934 and any other numbered register with a standard use.
1935
1936 This information is expressed as a sequence of numbers, separated by
1937 commas and surrounded by braces.  The @var{n}th number is 1 if
1938 register @var{n} is fixed, 0 otherwise.
1939
1940 The table initialized from this macro, and the table initialized by
1941 the following one, may be overridden at run time either automatically,
1942 by the actions of the macro @code{CONDITIONAL_REGISTER_USAGE}, or by
1943 the user with the command options @option{-ffixed-@var{reg}},
1944 @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}.
1945 @end defmac
1946
1947 @defmac CALL_USED_REGISTERS
1948 @cindex call-used register
1949 @cindex call-clobbered register
1950 @cindex call-saved register
1951 Like @code{FIXED_REGISTERS} but has 1 for each register that is
1952 clobbered (in general) by function calls as well as for fixed
1953 registers.  This macro therefore identifies the registers that are not
1954 available for general allocation of values that must live across
1955 function calls.
1956
1957 If a register has 0 in @code{CALL_USED_REGISTERS}, the compiler
1958 automatically saves it on function entry and restores it on function
1959 exit, if the register is used within the function.
1960 @end defmac
1961
1962 @defmac CALL_REALLY_USED_REGISTERS
1963 @cindex call-used register
1964 @cindex call-clobbered register
1965 @cindex call-saved register
1966 Like @code{CALL_USED_REGISTERS} except this macro doesn't require
1967 that the entire set of @code{FIXED_REGISTERS} be included.
1968 (@code{CALL_USED_REGISTERS} must be a superset of @code{FIXED_REGISTERS}).
1969 This macro is optional.  If not specified, it defaults to the value
1970 of @code{CALL_USED_REGISTERS}.
1971 @end defmac
1972
1973 @defmac HARD_REGNO_CALL_PART_CLOBBERED (@var{regno}, @var{mode})
1974 @cindex call-used register
1975 @cindex call-clobbered register
1976 @cindex call-saved register
1977 A C expression that is nonzero if it is not permissible to store a
1978 value of mode @var{mode} in hard register number @var{regno} across a
1979 call without some part of it being clobbered.  For most machines this
1980 macro need not be defined.  It is only required for machines that do not
1981 preserve the entire contents of a register across a call.
1982 @end defmac
1983
1984 @findex fixed_regs
1985 @findex call_used_regs
1986 @findex global_regs
1987 @findex reg_names
1988 @findex reg_class_contents
1989 @defmac CONDITIONAL_REGISTER_USAGE
1990 Zero or more C statements that may conditionally modify five variables
1991 @code{fixed_regs}, @code{call_used_regs}, @code{global_regs},
1992 @code{reg_names}, and @code{reg_class_contents}, to take into account
1993 any dependence of these register sets on target flags.  The first three
1994 of these are of type @code{char []} (interpreted as Boolean vectors).
1995 @code{global_regs} is a @code{const char *[]}, and
1996 @code{reg_class_contents} is a @code{HARD_REG_SET}.  Before the macro is
1997 called, @code{fixed_regs}, @code{call_used_regs},
1998 @code{reg_class_contents}, and @code{reg_names} have been initialized
1999 from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},
2000 @code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.
2001 @code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},
2002 @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}
2003 command options have been applied.
2004
2005 You need not define this macro if it has no work to do.
2006
2007 @cindex disabling certain registers
2008 @cindex controlling register usage
2009 If the usage of an entire class of registers depends on the target
2010 flags, you may indicate this to GCC by using this macro to modify
2011 @code{fixed_regs} and @code{call_used_regs} to 1 for each of the
2012 registers in the classes which should not be used by GCC@.  Also define
2013 the macro @code{REG_CLASS_FROM_LETTER} / @code{REG_CLASS_FROM_CONSTRAINT}
2014 to return @code{NO_REGS} if it
2015 is called with a letter for a class that shouldn't be used.
2016
2017 (However, if this class is not included in @code{GENERAL_REGS} and all
2018 of the insn patterns whose constraints permit this class are
2019 controlled by target switches, then GCC will automatically avoid using
2020 these registers when the target switches are opposed to them.)
2021 @end defmac
2022
2023 @defmac INCOMING_REGNO (@var{out})
2024 Define this macro if the target machine has register windows.  This C
2025 expression returns the register number as seen by the called function
2026 corresponding to the register number @var{out} as seen by the calling
2027 function.  Return @var{out} if register number @var{out} is not an
2028 outbound register.
2029 @end defmac
2030
2031 @defmac OUTGOING_REGNO (@var{in})
2032 Define this macro if the target machine has register windows.  This C
2033 expression returns the register number as seen by the calling function
2034 corresponding to the register number @var{in} as seen by the called
2035 function.  Return @var{in} if register number @var{in} is not an inbound
2036 register.
2037 @end defmac
2038
2039 @defmac LOCAL_REGNO (@var{regno})
2040 Define this macro if the target machine has register windows.  This C
2041 expression returns true if the register is call-saved but is in the
2042 register window.  Unlike most call-saved registers, such registers
2043 need not be explicitly restored on function exit or during non-local
2044 gotos.
2045 @end defmac
2046
2047 @defmac PC_REGNUM
2048 If the program counter has a register number, define this as that
2049 register number.  Otherwise, do not define it.
2050 @end defmac
2051
2052 @node Allocation Order
2053 @subsection Order of Allocation of Registers
2054 @cindex order of register allocation
2055 @cindex register allocation order
2056
2057 @c prevent bad page break with this line
2058 Registers are allocated in order.
2059
2060 @defmac REG_ALLOC_ORDER
2061 If defined, an initializer for a vector of integers, containing the
2062 numbers of hard registers in the order in which GCC should prefer
2063 to use them (from most preferred to least).
2064
2065 If this macro is not defined, registers are used lowest numbered first
2066 (all else being equal).
2067
2068 One use of this macro is on machines where the highest numbered
2069 registers must always be saved and the save-multiple-registers
2070 instruction supports only sequences of consecutive registers.  On such
2071 machines, define @code{REG_ALLOC_ORDER} to be an initializer that lists
2072 the highest numbered allocable register first.
2073 @end defmac
2074
2075 @defmac ORDER_REGS_FOR_LOCAL_ALLOC
2076 A C statement (sans semicolon) to choose the order in which to allocate
2077 hard registers for pseudo-registers local to a basic block.
2078
2079 Store the desired register order in the array @code{reg_alloc_order}.
2080 Element 0 should be the register to allocate first; element 1, the next
2081 register; and so on.
2082
2083 The macro body should not assume anything about the contents of
2084 @code{reg_alloc_order} before execution of the macro.
2085
2086 On most machines, it is not necessary to define this macro.
2087 @end defmac
2088
2089 @defmac IRA_HARD_REGNO_ADD_COST_MULTIPLIER (@var{regno})
2090 In some case register allocation order is not enough for the
2091 Integrated Register Allocator (@acronym{IRA}) to generate a good code.
2092 If this macro is defined, it should return a floating point value
2093 based on @var{regno}.  The cost of using @var{regno} for a pseudo will
2094 be increased by approximately the pseudo's usage frequency times the
2095 value returned by this macro.  Not defining this macro is equivalent
2096 to having it always return @code{0.0}.
2097
2098 On most machines, it is not necessary to define this macro.
2099 @end defmac
2100
2101 @node Values in Registers
2102 @subsection How Values Fit in Registers
2103
2104 This section discusses the macros that describe which kinds of values
2105 (specifically, which machine modes) each register can hold, and how many
2106 consecutive registers are needed for a given mode.
2107
2108 @defmac HARD_REGNO_NREGS (@var{regno}, @var{mode})
2109 A C expression for the number of consecutive hard registers, starting
2110 at register number @var{regno}, required to hold a value of mode
2111 @var{mode}.  This macro must never return zero, even if a register
2112 cannot hold the requested mode - indicate that with HARD_REGNO_MODE_OK
2113 and/or CANNOT_CHANGE_MODE_CLASS instead.
2114
2115 On a machine where all registers are exactly one word, a suitable
2116 definition of this macro is
2117
2118 @smallexample
2119 #define HARD_REGNO_NREGS(REGNO, MODE)            \
2120    ((GET_MODE_SIZE (MODE) + UNITS_PER_WORD - 1)  \
2121     / UNITS_PER_WORD)
2122 @end smallexample
2123 @end defmac
2124
2125 @defmac HARD_REGNO_NREGS_HAS_PADDING (@var{regno}, @var{mode})
2126 A C expression that is nonzero if a value of mode @var{mode}, stored
2127 in memory, ends with padding that causes it to take up more space than
2128 in registers starting at register number @var{regno} (as determined by
2129 multiplying GCC's notion of the size of the register when containing
2130 this mode by the number of registers returned by
2131 @code{HARD_REGNO_NREGS}).  By default this is zero.
2132
2133 For example, if a floating-point value is stored in three 32-bit
2134 registers but takes up 128 bits in memory, then this would be
2135 nonzero.
2136
2137 This macros only needs to be defined if there are cases where
2138 @code{subreg_get_info}
2139 would otherwise wrongly determine that a @code{subreg} can be
2140 represented by an offset to the register number, when in fact such a
2141 @code{subreg} would contain some of the padding not stored in
2142 registers and so not be representable.
2143 @end defmac
2144
2145 @defmac HARD_REGNO_NREGS_WITH_PADDING (@var{regno}, @var{mode})
2146 For values of @var{regno} and @var{mode} for which
2147 @code{HARD_REGNO_NREGS_HAS_PADDING} returns nonzero, a C expression
2148 returning the greater number of registers required to hold the value
2149 including any padding.  In the example above, the value would be four.
2150 @end defmac
2151
2152 @defmac REGMODE_NATURAL_SIZE (@var{mode})
2153 Define this macro if the natural size of registers that hold values
2154 of mode @var{mode} is not the word size.  It is a C expression that
2155 should give the natural size in bytes for the specified mode.  It is
2156 used by the register allocator to try to optimize its results.  This
2157 happens for example on SPARC 64-bit where the natural size of
2158 floating-point registers is still 32-bit.
2159 @end defmac
2160
2161 @defmac HARD_REGNO_MODE_OK (@var{regno}, @var{mode})
2162 A C expression that is nonzero if it is permissible to store a value
2163 of mode @var{mode} in hard register number @var{regno} (or in several
2164 registers starting with that one).  For a machine where all registers
2165 are equivalent, a suitable definition is
2166
2167 @smallexample
2168 #define HARD_REGNO_MODE_OK(REGNO, MODE) 1
2169 @end smallexample
2170
2171 You need not include code to check for the numbers of fixed registers,
2172 because the allocation mechanism considers them to be always occupied.
2173
2174 @cindex register pairs
2175 On some machines, double-precision values must be kept in even/odd
2176 register pairs.  You can implement that by defining this macro to reject
2177 odd register numbers for such modes.
2178
2179 The minimum requirement for a mode to be OK in a register is that the
2180 @samp{mov@var{mode}} instruction pattern support moves between the
2181 register and other hard register in the same class and that moving a
2182 value into the register and back out not alter it.
2183
2184 Since the same instruction used to move @code{word_mode} will work for
2185 all narrower integer modes, it is not necessary on any machine for
2186 @code{HARD_REGNO_MODE_OK} to distinguish between these modes, provided
2187 you define patterns @samp{movhi}, etc., to take advantage of this.  This
2188 is useful because of the interaction between @code{HARD_REGNO_MODE_OK}
2189 and @code{MODES_TIEABLE_P}; it is very desirable for all integer modes
2190 to be tieable.
2191
2192 Many machines have special registers for floating point arithmetic.
2193 Often people assume that floating point machine modes are allowed only
2194 in floating point registers.  This is not true.  Any registers that
2195 can hold integers can safely @emph{hold} a floating point machine
2196 mode, whether or not floating arithmetic can be done on it in those
2197 registers.  Integer move instructions can be used to move the values.
2198
2199 On some machines, though, the converse is true: fixed-point machine
2200 modes may not go in floating registers.  This is true if the floating
2201 registers normalize any value stored in them, because storing a
2202 non-floating value there would garble it.  In this case,
2203 @code{HARD_REGNO_MODE_OK} should reject fixed-point machine modes in
2204 floating registers.  But if the floating registers do not automatically
2205 normalize, if you can store any bit pattern in one and retrieve it
2206 unchanged without a trap, then any machine mode may go in a floating
2207 register, so you can define this macro to say so.
2208
2209 The primary significance of special floating registers is rather that
2210 they are the registers acceptable in floating point arithmetic
2211 instructions.  However, this is of no concern to
2212 @code{HARD_REGNO_MODE_OK}.  You handle it by writing the proper
2213 constraints for those instructions.
2214
2215 On some machines, the floating registers are especially slow to access,
2216 so that it is better to store a value in a stack frame than in such a
2217 register if floating point arithmetic is not being done.  As long as the
2218 floating registers are not in class @code{GENERAL_REGS}, they will not
2219 be used unless some pattern's constraint asks for one.
2220 @end defmac
2221
2222 @defmac HARD_REGNO_RENAME_OK (@var{from}, @var{to})
2223 A C expression that is nonzero if it is OK to rename a hard register
2224 @var{from} to another hard register @var{to}.
2225
2226 One common use of this macro is to prevent renaming of a register to
2227 another register that is not saved by a prologue in an interrupt
2228 handler.
2229
2230 The default is always nonzero.
2231 @end defmac
2232
2233 @defmac MODES_TIEABLE_P (@var{mode1}, @var{mode2})
2234 A C expression that is nonzero if a value of mode
2235 @var{mode1} is accessible in mode @var{mode2} without copying.
2236
2237 If @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and
2238 @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always the same for
2239 any @var{r}, then @code{MODES_TIEABLE_P (@var{mode1}, @var{mode2})}
2240 should be nonzero.  If they differ for any @var{r}, you should define
2241 this macro to return zero unless some other mechanism ensures the
2242 accessibility of the value in a narrower mode.
2243
2244 You should define this macro to return nonzero in as many cases as
2245 possible since doing so will allow GCC to perform better register
2246 allocation.
2247 @end defmac
2248
2249 @deftypefn {Target Hook} bool TARGET_HARD_REGNO_SCRATCH_OK (unsigned int @var{regno})
2250 This target hook should return @code{true} if it is OK to use a hard register
2251 @var{regno} as scratch reg in peephole2.
2252
2253 One common use of this macro is to prevent using of a register that
2254 is not saved by a prologue in an interrupt handler.
2255
2256 The default version of this hook always returns @code{true}.
2257 @end deftypefn
2258
2259 @defmac AVOID_CCMODE_COPIES
2260 Define this macro if the compiler should avoid copies to/from @code{CCmode}
2261 registers.  You should only define this macro if support for copying to/from
2262 @code{CCmode} is incomplete.
2263 @end defmac
2264
2265 @node Leaf Functions
2266 @subsection Handling Leaf Functions
2267
2268 @cindex leaf functions
2269 @cindex functions, leaf
2270 On some machines, a leaf function (i.e., one which makes no calls) can run
2271 more efficiently if it does not make its own register window.  Often this
2272 means it is required to receive its arguments in the registers where they
2273 are passed by the caller, instead of the registers where they would
2274 normally arrive.
2275
2276 The special treatment for leaf functions generally applies only when
2277 other conditions are met; for example, often they may use only those
2278 registers for its own variables and temporaries.  We use the term ``leaf
2279 function'' to mean a function that is suitable for this special
2280 handling, so that functions with no calls are not necessarily ``leaf
2281 functions''.
2282
2283 GCC assigns register numbers before it knows whether the function is
2284 suitable for leaf function treatment.  So it needs to renumber the
2285 registers in order to output a leaf function.  The following macros
2286 accomplish this.
2287
2288 @defmac LEAF_REGISTERS
2289 Name of a char vector, indexed by hard register number, which
2290 contains 1 for a register that is allowable in a candidate for leaf
2291 function treatment.
2292
2293 If leaf function treatment involves renumbering the registers, then the
2294 registers marked here should be the ones before renumbering---those that
2295 GCC would ordinarily allocate.  The registers which will actually be
2296 used in the assembler code, after renumbering, should not be marked with 1
2297 in this vector.
2298
2299 Define this macro only if the target machine offers a way to optimize
2300 the treatment of leaf functions.
2301 @end defmac
2302
2303 @defmac LEAF_REG_REMAP (@var{regno})
2304 A C expression whose value is the register number to which @var{regno}
2305 should be renumbered, when a function is treated as a leaf function.
2306
2307 If @var{regno} is a register number which should not appear in a leaf
2308 function before renumbering, then the expression should yield @minus{}1, which
2309 will cause the compiler to abort.
2310
2311 Define this macro only if the target machine offers a way to optimize the
2312 treatment of leaf functions, and registers need to be renumbered to do
2313 this.
2314 @end defmac
2315
2316 @findex current_function_is_leaf
2317 @findex current_function_uses_only_leaf_regs
2318 @code{TARGET_ASM_FUNCTION_PROLOGUE} and
2319 @code{TARGET_ASM_FUNCTION_EPILOGUE} must usually treat leaf functions
2320 specially.  They can test the C variable @code{current_function_is_leaf}
2321 which is nonzero for leaf functions.  @code{current_function_is_leaf} is
2322 set prior to local register allocation and is valid for the remaining
2323 compiler passes.  They can also test the C variable
2324 @code{current_function_uses_only_leaf_regs} which is nonzero for leaf
2325 functions which only use leaf registers.
2326 @code{current_function_uses_only_leaf_regs} is valid after all passes
2327 that modify the instructions have been run and is only useful if
2328 @code{LEAF_REGISTERS} is defined.
2329 @c changed this to fix overfull.  ALSO:  why the "it" at the beginning
2330 @c of the next paragraph?!  --mew 2feb93
2331
2332 @node Stack Registers
2333 @subsection Registers That Form a Stack
2334
2335 There are special features to handle computers where some of the
2336 ``registers'' form a stack.  Stack registers are normally written by
2337 pushing onto the stack, and are numbered relative to the top of the
2338 stack.
2339
2340 Currently, GCC can only handle one group of stack-like registers, and
2341 they must be consecutively numbered.  Furthermore, the existing
2342 support for stack-like registers is specific to the 80387 floating
2343 point coprocessor.  If you have a new architecture that uses
2344 stack-like registers, you will need to do substantial work on
2345 @file{reg-stack.c} and write your machine description to cooperate
2346 with it, as well as defining these macros.
2347
2348 @defmac STACK_REGS
2349 Define this if the machine has any stack-like registers.
2350 @end defmac
2351
2352 @defmac FIRST_STACK_REG
2353 The number of the first stack-like register.  This one is the top
2354 of the stack.
2355 @end defmac
2356
2357 @defmac LAST_STACK_REG
2358 The number of the last stack-like register.  This one is the bottom of
2359 the stack.
2360 @end defmac
2361
2362 @node Register Classes
2363 @section Register Classes
2364 @cindex register class definitions
2365 @cindex class definitions, register
2366
2367 On many machines, the numbered registers are not all equivalent.
2368 For example, certain registers may not be allowed for indexed addressing;
2369 certain registers may not be allowed in some instructions.  These machine
2370 restrictions are described to the compiler using @dfn{register classes}.
2371
2372 You define a number of register classes, giving each one a name and saying
2373 which of the registers belong to it.  Then you can specify register classes
2374 that are allowed as operands to particular instruction patterns.
2375
2376 @findex ALL_REGS
2377 @findex NO_REGS
2378 In general, each register will belong to several classes.  In fact, one
2379 class must be named @code{ALL_REGS} and contain all the registers.  Another
2380 class must be named @code{NO_REGS} and contain no registers.  Often the
2381 union of two classes will be another class; however, this is not required.
2382
2383 @findex GENERAL_REGS
2384 One of the classes must be named @code{GENERAL_REGS}.  There is nothing
2385 terribly special about the name, but the operand constraint letters
2386 @samp{r} and @samp{g} specify this class.  If @code{GENERAL_REGS} is
2387 the same as @code{ALL_REGS}, just define it as a macro which expands
2388 to @code{ALL_REGS}.
2389
2390 Order the classes so that if class @var{x} is contained in class @var{y}
2391 then @var{x} has a lower class number than @var{y}.
2392
2393 The way classes other than @code{GENERAL_REGS} are specified in operand
2394 constraints is through machine-dependent operand constraint letters.
2395 You can define such letters to correspond to various classes, then use
2396 them in operand constraints.
2397
2398 You should define a class for the union of two classes whenever some
2399 instruction allows both classes.  For example, if an instruction allows
2400 either a floating point (coprocessor) register or a general register for a
2401 certain operand, you should define a class @code{FLOAT_OR_GENERAL_REGS}
2402 which includes both of them.  Otherwise you will get suboptimal code.
2403
2404 You must also specify certain redundant information about the register
2405 classes: for each class, which classes contain it and which ones are
2406 contained in it; for each pair of classes, the largest class contained
2407 in their union.
2408
2409 When a value occupying several consecutive registers is expected in a
2410 certain class, all the registers used must belong to that class.
2411 Therefore, register classes cannot be used to enforce a requirement for
2412 a register pair to start with an even-numbered register.  The way to
2413 specify this requirement is with @code{HARD_REGNO_MODE_OK}.
2414
2415 Register classes used for input-operands of bitwise-and or shift
2416 instructions have a special requirement: each such class must have, for
2417 each fixed-point machine mode, a subclass whose registers can transfer that
2418 mode to or from memory.  For example, on some machines, the operations for
2419 single-byte values (@code{QImode}) are limited to certain registers.  When
2420 this is so, each register class that is used in a bitwise-and or shift
2421 instruction must have a subclass consisting of registers from which
2422 single-byte values can be loaded or stored.  This is so that
2423 @code{PREFERRED_RELOAD_CLASS} can always have a possible value to return.
2424
2425 @deftp {Data type} {enum reg_class}
2426 An enumerated type that must be defined with all the register class names
2427 as enumerated values.  @code{NO_REGS} must be first.  @code{ALL_REGS}
2428 must be the last register class, followed by one more enumerated value,
2429 @code{LIM_REG_CLASSES}, which is not a register class but rather
2430 tells how many classes there are.
2431
2432 Each register class has a number, which is the value of casting
2433 the class name to type @code{int}.  The number serves as an index
2434 in many of the tables described below.
2435 @end deftp
2436
2437 @defmac N_REG_CLASSES
2438 The number of distinct register classes, defined as follows:
2439
2440 @smallexample
2441 #define N_REG_CLASSES (int) LIM_REG_CLASSES
2442 @end smallexample
2443 @end defmac
2444
2445 @defmac REG_CLASS_NAMES
2446 An initializer containing the names of the register classes as C string
2447 constants.  These names are used in writing some of the debugging dumps.
2448 @end defmac
2449
2450 @defmac REG_CLASS_CONTENTS
2451 An initializer containing the contents of the register classes, as integers
2452 which are bit masks.  The @var{n}th integer specifies the contents of class
2453 @var{n}.  The way the integer @var{mask} is interpreted is that
2454 register @var{r} is in the class if @code{@var{mask} & (1 << @var{r})} is 1.
2455
2456 When the machine has more than 32 registers, an integer does not suffice.
2457 Then the integers are replaced by sub-initializers, braced groupings containing
2458 several integers.  Each sub-initializer must be suitable as an initializer
2459 for the type @code{HARD_REG_SET} which is defined in @file{hard-reg-set.h}.
2460 In this situation, the first integer in each sub-initializer corresponds to
2461 registers 0 through 31, the second integer to registers 32 through 63, and
2462 so on.
2463 @end defmac
2464
2465 @defmac REGNO_REG_CLASS (@var{regno})
2466 A C expression whose value is a register class containing hard register
2467 @var{regno}.  In general there is more than one such class; choose a class
2468 which is @dfn{minimal}, meaning that no smaller class also contains the
2469 register.
2470 @end defmac
2471
2472 @defmac BASE_REG_CLASS
2473 A macro whose definition is the name of the class to which a valid
2474 base register must belong.  A base register is one used in an address
2475 which is the register value plus a displacement.
2476 @end defmac
2477
2478 @defmac MODE_BASE_REG_CLASS (@var{mode})
2479 This is a variation of the @code{BASE_REG_CLASS} macro which allows
2480 the selection of a base register in a mode dependent manner.  If
2481 @var{mode} is VOIDmode then it should return the same value as
2482 @code{BASE_REG_CLASS}.
2483 @end defmac
2484
2485 @defmac MODE_BASE_REG_REG_CLASS (@var{mode})
2486 A C expression whose value is the register class to which a valid
2487 base register must belong in order to be used in a base plus index
2488 register address.  You should define this macro if base plus index
2489 addresses have different requirements than other base register uses.
2490 @end defmac
2491
2492 @defmac MODE_CODE_BASE_REG_CLASS (@var{mode}, @var{outer_code}, @var{index_code})
2493 A C expression whose value is the register class to which a valid
2494 base register must belong.  @var{outer_code} and @var{index_code} define the
2495 context in which the base register occurs.  @var{outer_code} is the code of
2496 the immediately enclosing expression (@code{MEM} for the top level of an
2497 address, @code{ADDRESS} for something that occurs in an
2498 @code{address_operand}).  @var{index_code} is the code of the corresponding
2499 index expression if @var{outer_code} is @code{PLUS}; @code{SCRATCH} otherwise.
2500 @end defmac
2501
2502 @defmac INDEX_REG_CLASS
2503 A macro whose definition is the name of the class to which a valid
2504 index register must belong.  An index register is one used in an
2505 address where its value is either multiplied by a scale factor or
2506 added to another register (as well as added to a displacement).
2507 @end defmac
2508
2509 @defmac REGNO_OK_FOR_BASE_P (@var{num})
2510 A C expression which is nonzero if register number @var{num} is
2511 suitable for use as a base register in operand addresses.
2512 Like @code{TARGET_LEGITIMATE_ADDRESS_P}, this macro should also
2513 define a strict and a non-strict variant.  Both variants behave
2514 the same for hard register; for pseudos, the strict variant will
2515 pass only those that have been allocated to a valid hard registers,
2516 while the non-strict variant will pass all pseudos.
2517
2518 @findex REG_OK_STRICT
2519 Compiler source files that want to use the strict variant of this and
2520 other macros define the macro @code{REG_OK_STRICT}.  You should use an
2521 @code{#ifdef REG_OK_STRICT} conditional to define the strict variant in
2522 that case and the non-strict variant otherwise.
2523 @end defmac
2524
2525 @defmac REGNO_MODE_OK_FOR_BASE_P (@var{num}, @var{mode})
2526 A C expression that is just like @code{REGNO_OK_FOR_BASE_P}, except that
2527 that expression may examine the mode of the memory reference in
2528 @var{mode}.  You should define this macro if the mode of the memory
2529 reference affects whether a register may be used as a base register.  If
2530 you define this macro, the compiler will use it instead of
2531 @code{REGNO_OK_FOR_BASE_P}.  The mode may be @code{VOIDmode} for
2532 addresses that appear outside a @code{MEM}, i.e., as an
2533 @code{address_operand}.
2534
2535 This macro also has strict and non-strict variants.
2536 @end defmac
2537
2538 @defmac REGNO_MODE_OK_FOR_REG_BASE_P (@var{num}, @var{mode})
2539 A C expression which is nonzero if register number @var{num} is suitable for
2540 use as a base register in base plus index operand addresses, accessing
2541 memory in mode @var{mode}.  It may be either a suitable hard register or a
2542 pseudo register that has been allocated such a hard register.  You should
2543 define this macro if base plus index addresses have different requirements
2544 than other base register uses.
2545
2546 Use of this macro is deprecated; please use the more general
2547 @code{REGNO_MODE_CODE_OK_FOR_BASE_P}.
2548
2549 This macro also has strict and non-strict variants.
2550 @end defmac
2551
2552 @defmac REGNO_MODE_CODE_OK_FOR_BASE_P (@var{num}, @var{mode}, @var{outer_code}, @var{index_code})
2553 A C expression that is just like @code{REGNO_MODE_OK_FOR_BASE_P}, except
2554 that that expression may examine the context in which the register
2555 appears in the memory reference.  @var{outer_code} is the code of the
2556 immediately enclosing expression (@code{MEM} if at the top level of the
2557 address, @code{ADDRESS} for something that occurs in an
2558 @code{address_operand}).  @var{index_code} is the code of the
2559 corresponding index expression if @var{outer_code} is @code{PLUS};
2560 @code{SCRATCH} otherwise.  The mode may be @code{VOIDmode} for addresses
2561 that appear outside a @code{MEM}, i.e., as an @code{address_operand}.
2562
2563 This macro also has strict and non-strict variants.
2564 @end defmac
2565
2566 @defmac REGNO_OK_FOR_INDEX_P (@var{num})
2567 A C expression which is nonzero if register number @var{num} is
2568 suitable for use as an index register in operand addresses.  It may be
2569 either a suitable hard register or a pseudo register that has been
2570 allocated such a hard register.
2571
2572 The difference between an index register and a base register is that
2573 the index register may be scaled.  If an address involves the sum of
2574 two registers, neither one of them scaled, then either one may be
2575 labeled the ``base'' and the other the ``index''; but whichever
2576 labeling is used must fit the machine's constraints of which registers
2577 may serve in each capacity.  The compiler will try both labelings,
2578 looking for one that is valid, and will reload one or both registers
2579 only if neither labeling works.
2580
2581 This macro also has strict and non-strict variants.
2582 @end defmac
2583
2584 @defmac PREFERRED_RELOAD_CLASS (@var{x}, @var{class})
2585 A C expression that places additional restrictions on the register class
2586 to use when it is necessary to copy value @var{x} into a register in class
2587 @var{class}.  The value is a register class; perhaps @var{class}, or perhaps
2588 another, smaller class.  On many machines, the following definition is
2589 safe:
2590
2591 @smallexample
2592 #define PREFERRED_RELOAD_CLASS(X,CLASS) CLASS
2593 @end smallexample
2594
2595 Sometimes returning a more restrictive class makes better code.  For
2596 example, on the 68000, when @var{x} is an integer constant that is in range
2597 for a @samp{moveq} instruction, the value of this macro is always
2598 @code{DATA_REGS} as long as @var{class} includes the data registers.
2599 Requiring a data register guarantees that a @samp{moveq} will be used.
2600
2601 One case where @code{PREFERRED_RELOAD_CLASS} must not return
2602 @var{class} is if @var{x} is a legitimate constant which cannot be
2603 loaded into some register class.  By returning @code{NO_REGS} you can
2604 force @var{x} into a memory location.  For example, rs6000 can load
2605 immediate values into general-purpose registers, but does not have an
2606 instruction for loading an immediate value into a floating-point
2607 register, so @code{PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when
2608 @var{x} is a floating-point constant.  If the constant can't be loaded
2609 into any kind of register, code generation will be better if
2610 @code{LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead
2611 of using @code{PREFERRED_RELOAD_CLASS}.
2612
2613 If an insn has pseudos in it after register allocation, reload will go
2614 through the alternatives and call repeatedly @code{PREFERRED_RELOAD_CLASS}
2615 to find the best one.  Returning @code{NO_REGS}, in this case, makes
2616 reload add a @code{!} in front of the constraint: the x86 back-end uses
2617 this feature to discourage usage of 387 registers when math is done in
2618 the SSE registers (and vice versa).
2619 @end defmac
2620
2621 @defmac PREFERRED_OUTPUT_RELOAD_CLASS (@var{x}, @var{class})
2622 Like @code{PREFERRED_RELOAD_CLASS}, but for output reloads instead of
2623 input reloads.  If you don't define this macro, the default is to use
2624 @var{class}, unchanged.
2625
2626 You can also use @code{PREFERRED_OUTPUT_RELOAD_CLASS} to discourage
2627 reload from using some alternatives, like @code{PREFERRED_RELOAD_CLASS}.
2628 @end defmac
2629
2630 @defmac LIMIT_RELOAD_CLASS (@var{mode}, @var{class})
2631 A C expression that places additional restrictions on the register class
2632 to use when it is necessary to be able to hold a value of mode
2633 @var{mode} in a reload register for which class @var{class} would
2634 ordinarily be used.
2635
2636 Unlike @code{PREFERRED_RELOAD_CLASS}, this macro should be used when
2637 there are certain modes that simply can't go in certain reload classes.
2638
2639 The value is a register class; perhaps @var{class}, or perhaps another,
2640 smaller class.
2641
2642 Don't define this macro unless the target machine has limitations which
2643 require the macro to do something nontrivial.
2644 @end defmac
2645
2646 @deftypefn {Target Hook} {enum reg_class} TARGET_SECONDARY_RELOAD (bool @var{in_p}, rtx @var{x}, enum reg_class @var{reload_class}, enum machine_mode @var{reload_mode}, secondary_reload_info *@var{sri})
2647 Many machines have some registers that cannot be copied directly to or
2648 from memory or even from other types of registers.  An example is the
2649 @samp{MQ} register, which on most machines, can only be copied to or
2650 from general registers, but not memory.  Below, we shall be using the
2651 term 'intermediate register' when a move operation cannot be performed
2652 directly, but has to be done by copying the source into the intermediate
2653 register first, and then copying the intermediate register to the
2654 destination.  An intermediate register always has the same mode as
2655 source and destination.  Since it holds the actual value being copied,
2656 reload might apply optimizations to re-use an intermediate register
2657 and eliding the copy from the source when it can determine that the
2658 intermediate register still holds the required value.
2659
2660 Another kind of secondary reload is required on some machines which
2661 allow copying all registers to and from memory, but require a scratch
2662 register for stores to some memory locations (e.g., those with symbolic
2663 address on the RT, and those with certain symbolic address on the SPARC
2664 when compiling PIC)@.  Scratch registers need not have the same mode
2665 as the value being copied, and usually hold a different value than
2666 that being copied.  Special patterns in the md file are needed to
2667 describe how the copy is performed with the help of the scratch register;
2668 these patterns also describe the number, register class(es) and mode(s)
2669 of the scratch register(s).
2670
2671 In some cases, both an intermediate and a scratch register are required.
2672
2673 For input reloads, this target hook is called with nonzero @var{in_p},
2674 and @var{x} is an rtx that needs to be copied to a register of class
2675 @var{reload_class} in @var{reload_mode}.  For output reloads, this target
2676 hook is called with zero @var{in_p}, and a register of class @var{reload_class}
2677 needs to be copied to rtx @var{x} in @var{reload_mode}.
2678
2679 If copying a register of @var{reload_class} from/to @var{x} requires
2680 an intermediate register, the hook @code{secondary_reload} should
2681 return the register class required for this intermediate register.
2682 If no intermediate register is required, it should return NO_REGS.
2683 If more than one intermediate register is required, describe the one
2684 that is closest in the copy chain to the reload register.
2685
2686 If scratch registers are needed, you also have to describe how to
2687 perform the copy from/to the reload register to/from this
2688 closest intermediate register.  Or if no intermediate register is
2689 required, but still a scratch register is needed, describe the
2690 copy  from/to the reload register to/from the reload operand @var{x}.
2691
2692 You do this by setting @code{sri->icode} to the instruction code of a pattern
2693 in the md file which performs the move.  Operands 0 and 1 are the output
2694 and input of this copy, respectively.  Operands from operand 2 onward are
2695 for scratch operands.  These scratch operands must have a mode, and a
2696 single-register-class
2697 @c [later: or memory]
2698 output constraint.
2699
2700 When an intermediate register is used, the @code{secondary_reload}
2701 hook will be called again to determine how to copy the intermediate
2702 register to/from the reload operand @var{x}, so your hook must also
2703 have code to handle the register class of the intermediate operand.
2704
2705 @c [For later: maybe we'll allow multi-alternative reload patterns -
2706 @c   the port maintainer could name a mov<mode> pattern that has clobbers -
2707 @c   and match the constraints of input and output to determine the required
2708 @c   alternative.  A restriction would be that constraints used to match
2709 @c   against reloads registers would have to be written as register class
2710 @c   constraints, or we need a new target macro / hook that tells us if an
2711 @c   arbitrary constraint can match an unknown register of a given class.
2712 @c   Such a macro / hook would also be useful in other places.]
2713
2714
2715 @var{x} might be a pseudo-register or a @code{subreg} of a
2716 pseudo-register, which could either be in a hard register or in memory.
2717 Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is
2718 in memory and the hard register number if it is in a register.
2719
2720 Scratch operands in memory (constraint @code{"=m"} / @code{"=&m"}) are
2721 currently not supported.  For the time being, you will have to continue
2722 to use @code{SECONDARY_MEMORY_NEEDED} for that purpose.
2723
2724 @code{copy_cost} also uses this target hook to find out how values are
2725 copied.  If you want it to include some extra cost for the need to allocate
2726 (a) scratch register(s), set @code{sri->extra_cost} to the additional cost.
2727 Or if two dependent moves are supposed to have a lower cost than the sum
2728 of the individual moves due to expected fortuitous scheduling and/or special
2729 forwarding logic, you can set @code{sri->extra_cost} to a negative amount.
2730 @end deftypefn
2731
2732 @defmac SECONDARY_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2733 @defmacx SECONDARY_INPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2734 @defmacx SECONDARY_OUTPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2735 These macros are obsolete, new ports should use the target hook
2736 @code{TARGET_SECONDARY_RELOAD} instead.
2737
2738 These are obsolete macros, replaced by the @code{TARGET_SECONDARY_RELOAD}
2739 target hook.  Older ports still define these macros to indicate to the
2740 reload phase that it may
2741 need to allocate at least one register for a reload in addition to the
2742 register to contain the data.  Specifically, if copying @var{x} to a
2743 register @var{class} in @var{mode} requires an intermediate register,
2744 you were supposed to define @code{SECONDARY_INPUT_RELOAD_CLASS} to return the
2745 largest register class all of whose registers can be used as
2746 intermediate registers or scratch registers.
2747
2748 If copying a register @var{class} in @var{mode} to @var{x} requires an
2749 intermediate or scratch register, @code{SECONDARY_OUTPUT_RELOAD_CLASS}
2750 was supposed to be defined be defined to return the largest register
2751 class required.  If the
2752 requirements for input and output reloads were the same, the macro
2753 @code{SECONDARY_RELOAD_CLASS} should have been used instead of defining both
2754 macros identically.
2755
2756 The values returned by these macros are often @code{GENERAL_REGS}.
2757 Return @code{NO_REGS} if no spare register is needed; i.e., if @var{x}
2758 can be directly copied to or from a register of @var{class} in
2759 @var{mode} without requiring a scratch register.  Do not define this
2760 macro if it would always return @code{NO_REGS}.
2761
2762 If a scratch register is required (either with or without an
2763 intermediate register), you were supposed to define patterns for
2764 @samp{reload_in@var{m}} or @samp{reload_out@var{m}}, as required
2765 (@pxref{Standard Names}.  These patterns, which were normally
2766 implemented with a @code{define_expand}, should be similar to the
2767 @samp{mov@var{m}} patterns, except that operand 2 is the scratch
2768 register.
2769
2770 These patterns need constraints for the reload register and scratch
2771 register that
2772 contain a single register class.  If the original reload register (whose
2773 class is @var{class}) can meet the constraint given in the pattern, the
2774 value returned by these macros is used for the class of the scratch
2775 register.  Otherwise, two additional reload registers are required.
2776 Their classes are obtained from the constraints in the insn pattern.
2777
2778 @var{x} might be a pseudo-register or a @code{subreg} of a
2779 pseudo-register, which could either be in a hard register or in memory.
2780 Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is
2781 in memory and the hard register number if it is in a register.
2782
2783 These macros should not be used in the case where a particular class of
2784 registers can only be copied to memory and not to another class of
2785 registers.  In that case, secondary reload registers are not needed and
2786 would not be helpful.  Instead, a stack location must be used to perform
2787 the copy and the @code{mov@var{m}} pattern should use memory as an
2788 intermediate storage.  This case often occurs between floating-point and
2789 general registers.
2790 @end defmac
2791
2792 @defmac SECONDARY_MEMORY_NEEDED (@var{class1}, @var{class2}, @var{m})
2793 Certain machines have the property that some registers cannot be copied
2794 to some other registers without using memory.  Define this macro on
2795 those machines to be a C expression that is nonzero if objects of mode
2796 @var{m} in registers of @var{class1} can only be copied to registers of
2797 class @var{class2} by storing a register of @var{class1} into memory
2798 and loading that memory location into a register of @var{class2}.
2799
2800 Do not define this macro if its value would always be zero.
2801 @end defmac
2802
2803 @defmac SECONDARY_MEMORY_NEEDED_RTX (@var{mode})
2804 Normally when @code{SECONDARY_MEMORY_NEEDED} is defined, the compiler
2805 allocates a stack slot for a memory location needed for register copies.
2806 If this macro is defined, the compiler instead uses the memory location
2807 defined by this macro.
2808
2809 Do not define this macro if you do not define
2810 @code{SECONDARY_MEMORY_NEEDED}.
2811 @end defmac
2812
2813 @defmac SECONDARY_MEMORY_NEEDED_MODE (@var{mode})
2814 When the compiler needs a secondary memory location to copy between two
2815 registers of mode @var{mode}, it normally allocates sufficient memory to
2816 hold a quantity of @code{BITS_PER_WORD} bits and performs the store and
2817 load operations in a mode that many bits wide and whose class is the
2818 same as that of @var{mode}.
2819
2820 This is right thing to do on most machines because it ensures that all
2821 bits of the register are copied and prevents accesses to the registers
2822 in a narrower mode, which some machines prohibit for floating-point
2823 registers.
2824
2825 However, this default behavior is not correct on some machines, such as
2826 the DEC Alpha, that store short integers in floating-point registers
2827 differently than in integer registers.  On those machines, the default
2828 widening will not work correctly and you must define this macro to
2829 suppress that widening in some cases.  See the file @file{alpha.h} for
2830 details.
2831
2832 Do not define this macro if you do not define
2833 @code{SECONDARY_MEMORY_NEEDED} or if widening @var{mode} to a mode that
2834 is @code{BITS_PER_WORD} bits wide is correct for your machine.
2835 @end defmac
2836
2837 @defmac SMALL_REGISTER_CLASSES
2838 On some machines, it is risky to let hard registers live across arbitrary
2839 insns.  Typically, these machines have instructions that require values
2840 to be in specific registers (like an accumulator), and reload will fail
2841 if the required hard register is used for another purpose across such an
2842 insn.
2843
2844 Define @code{SMALL_REGISTER_CLASSES} to be an expression with a nonzero
2845 value on these machines.  When this macro has a nonzero value, the
2846 compiler will try to minimize the lifetime of hard registers.
2847
2848 It is always safe to define this macro with a nonzero value, but if you
2849 unnecessarily define it, you will reduce the amount of optimizations
2850 that can be performed in some cases.  If you do not define this macro
2851 with a nonzero value when it is required, the compiler will run out of
2852 spill registers and print a fatal error message.  For most machines, you
2853 should not define this macro at all.
2854 @end defmac
2855
2856 @defmac CLASS_LIKELY_SPILLED_P (@var{class})
2857 A C expression whose value is nonzero if pseudos that have been assigned
2858 to registers of class @var{class} would likely be spilled because
2859 registers of @var{class} are needed for spill registers.
2860
2861 The default value of this macro returns 1 if @var{class} has exactly one
2862 register and zero otherwise.  On most machines, this default should be
2863 used.  Only define this macro to some other expression if pseudos
2864 allocated by @file{local-alloc.c} end up in memory because their hard
2865 registers were needed for spill registers.  If this macro returns nonzero
2866 for those classes, those pseudos will only be allocated by
2867 @file{global.c}, which knows how to reallocate the pseudo to another
2868 register.  If there would not be another register available for
2869 reallocation, you should not change the definition of this macro since
2870 the only effect of such a definition would be to slow down register
2871 allocation.
2872 @end defmac
2873
2874 @defmac CLASS_MAX_NREGS (@var{class}, @var{mode})
2875 A C expression for the maximum number of consecutive registers
2876 of class @var{class} needed to hold a value of mode @var{mode}.
2877
2878 This is closely related to the macro @code{HARD_REGNO_NREGS}.  In fact,
2879 the value of the macro @code{CLASS_MAX_NREGS (@var{class}, @var{mode})}
2880 should be the maximum value of @code{HARD_REGNO_NREGS (@var{regno},
2881 @var{mode})} for all @var{regno} values in the class @var{class}.
2882
2883 This macro helps control the handling of multiple-word values
2884 in the reload pass.
2885 @end defmac
2886
2887 @defmac CANNOT_CHANGE_MODE_CLASS (@var{from}, @var{to}, @var{class})
2888 If defined, a C expression that returns nonzero for a @var{class} for which
2889 a change from mode @var{from} to mode @var{to} is invalid.
2890
2891 For the example, loading 32-bit integer or floating-point objects into
2892 floating-point registers on the Alpha extends them to 64 bits.
2893 Therefore loading a 64-bit object and then storing it as a 32-bit object
2894 does not store the low-order 32 bits, as would be the case for a normal
2895 register.  Therefore, @file{alpha.h} defines @code{CANNOT_CHANGE_MODE_CLASS}
2896 as below:
2897
2898 @smallexample
2899 #define CANNOT_CHANGE_MODE_CLASS(FROM, TO, CLASS) \
2900   (GET_MODE_SIZE (FROM) != GET_MODE_SIZE (TO) \
2901    ? reg_classes_intersect_p (FLOAT_REGS, (CLASS)) : 0)
2902 @end smallexample
2903 @end defmac
2904
2905 @deftypefn {Target Hook} {const enum reg_class *} TARGET_IRA_COVER_CLASSES ()
2906 Return an array of cover classes for the Integrated Register Allocator
2907 (@acronym{IRA}).  Cover classes are a set of non-intersecting register
2908 classes covering all hard registers used for register allocation
2909 purposes.  If a move between two registers in the same cover class is
2910 possible, it should be cheaper than a load or store of the registers.
2911 The array is terminated by a @code{LIM_REG_CLASSES} element.
2912
2913 The order of cover classes in the array is important.  If two classes
2914 have the same cost of usage for a pseudo, the class occurred first in
2915 the array is chosen for the pseudo.
2916
2917 This hook is called once at compiler startup, after the command-line
2918 options have been processed. It is then re-examined by every call to
2919 @code{target_reinit}.
2920
2921 The default implementation returns @code{IRA_COVER_CLASSES}, if defined,
2922 otherwise there is no default implementation.  You must define either this
2923 macro or @code{IRA_COVER_CLASSES} in order to use the integrated register
2924 allocator with Chaitin-Briggs coloring. If the macro is not defined,
2925 the only available coloring algorithm is Chow's priority coloring.
2926 @end deftypefn
2927
2928 @defmac IRA_COVER_CLASSES
2929 See the documentation for @code{TARGET_IRA_COVER_CLASSES}.
2930 @end defmac
2931
2932 @node Old Constraints
2933 @section Obsolete Macros for Defining Constraints
2934 @cindex defining constraints, obsolete method
2935 @cindex constraints, defining, obsolete method
2936
2937 Machine-specific constraints can be defined with these macros instead
2938 of the machine description constructs described in @ref{Define
2939 Constraints}.  This mechanism is obsolete.  New ports should not use
2940 it; old ports should convert to the new mechanism.
2941
2942 @defmac CONSTRAINT_LEN (@var{char}, @var{str})
2943 For the constraint at the start of @var{str}, which starts with the letter
2944 @var{c}, return the length.  This allows you to have register class /
2945 constant / extra constraints that are longer than a single letter;
2946 you don't need to define this macro if you can do with single-letter
2947 constraints only.  The definition of this macro should use
2948 DEFAULT_CONSTRAINT_LEN for all the characters that you don't want
2949 to handle specially.
2950 There are some sanity checks in genoutput.c that check the constraint lengths
2951 for the md file, so you can also use this macro to help you while you are
2952 transitioning from a byzantine single-letter-constraint scheme: when you
2953 return a negative length for a constraint you want to re-use, genoutput
2954 will complain about every instance where it is used in the md file.
2955 @end defmac
2956
2957 @defmac REG_CLASS_FROM_LETTER (@var{char})
2958 A C expression which defines the machine-dependent operand constraint
2959 letters for register classes.  If @var{char} is such a letter, the
2960 value should be the register class corresponding to it.  Otherwise,
2961 the value should be @code{NO_REGS}.  The register letter @samp{r},
2962 corresponding to class @code{GENERAL_REGS}, will not be passed
2963 to this macro; you do not need to handle it.
2964 @end defmac
2965
2966 @defmac REG_CLASS_FROM_CONSTRAINT (@var{char}, @var{str})
2967 Like @code{REG_CLASS_FROM_LETTER}, but you also get the constraint string
2968 passed in @var{str}, so that you can use suffixes to distinguish between
2969 different variants.
2970 @end defmac
2971
2972 @defmac CONST_OK_FOR_LETTER_P (@var{value}, @var{c})
2973 A C expression that defines the machine-dependent operand constraint
2974 letters (@samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}) that specify
2975 particular ranges of integer values.  If @var{c} is one of those
2976 letters, the expression should check that @var{value}, an integer, is in
2977 the appropriate range and return 1 if so, 0 otherwise.  If @var{c} is
2978 not one of those letters, the value should be 0 regardless of
2979 @var{value}.
2980 @end defmac
2981
2982 @defmac CONST_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str})
2983 Like @code{CONST_OK_FOR_LETTER_P}, but you also get the constraint
2984 string passed in @var{str}, so that you can use suffixes to distinguish
2985 between different variants.
2986 @end defmac
2987
2988 @defmac CONST_DOUBLE_OK_FOR_LETTER_P (@var{value}, @var{c})
2989 A C expression that defines the machine-dependent operand constraint
2990 letters that specify particular ranges of @code{const_double} values
2991 (@samp{G} or @samp{H}).
2992
2993 If @var{c} is one of those letters, the expression should check that
2994 @var{value}, an RTX of code @code{const_double}, is in the appropriate
2995 range and return 1 if so, 0 otherwise.  If @var{c} is not one of those
2996 letters, the value should be 0 regardless of @var{value}.
2997
2998 @code{const_double} is used for all floating-point constants and for
2999 @code{DImode} fixed-point constants.  A given letter can accept either
3000 or both kinds of values.  It can use @code{GET_MODE} to distinguish
3001 between these kinds.
3002 @end defmac
3003
3004 @defmac CONST_DOUBLE_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str})
3005 Like @code{CONST_DOUBLE_OK_FOR_LETTER_P}, but you also get the constraint
3006 string passed in @var{str}, so that you can use suffixes to distinguish
3007 between different variants.
3008 @end defmac
3009
3010 @defmac EXTRA_CONSTRAINT (@var{value}, @var{c})
3011 A C expression that defines the optional machine-dependent constraint
3012 letters that can be used to segregate specific types of operands, usually
3013 memory references, for the target machine.  Any letter that is not
3014 elsewhere defined and not matched by @code{REG_CLASS_FROM_LETTER} /
3015 @code{REG_CLASS_FROM_CONSTRAINT}
3016 may be used.  Normally this macro will not be defined.
3017
3018 If it is required for a particular target machine, it should return 1
3019 if @var{value} corresponds to the operand type represented by the
3020 constraint letter @var{c}.  If @var{c} is not defined as an extra
3021 constraint, the value returned should be 0 regardless of @var{value}.
3022
3023 For example, on the ROMP, load instructions cannot have their output
3024 in r0 if the memory reference contains a symbolic address.  Constraint
3025 letter @samp{Q} is defined as representing a memory address that does
3026 @emph{not} contain a symbolic address.  An alternative is specified with
3027 a @samp{Q} constraint on the input and @samp{r} on the output.  The next
3028 alternative specifies @samp{m} on the input and a register class that
3029 does not include r0 on the output.
3030 @end defmac
3031
3032 @defmac EXTRA_CONSTRAINT_STR (@var{value}, @var{c}, @var{str})
3033 Like @code{EXTRA_CONSTRAINT}, but you also get the constraint string passed
3034 in @var{str}, so that you can use suffixes to distinguish between different
3035 variants.
3036 @end defmac
3037
3038 @defmac EXTRA_MEMORY_CONSTRAINT (@var{c}, @var{str})
3039 A C expression that defines the optional machine-dependent constraint
3040 letters, amongst those accepted by @code{EXTRA_CONSTRAINT}, that should
3041 be treated like memory constraints by the reload pass.
3042
3043 It should return 1 if the operand type represented by the constraint
3044 at the start of @var{str}, the first letter of which is the letter @var{c},
3045 comprises a subset of all memory references including
3046 all those whose address is simply a base register.  This allows the reload
3047 pass to reload an operand, if it does not directly correspond to the operand
3048 type of @var{c}, by copying its address into a base register.
3049
3050 For example, on the S/390, some instructions do not accept arbitrary
3051 memory references, but only those that do not make use of an index
3052 register.  The constraint letter @samp{Q} is defined via
3053 @code{EXTRA_CONSTRAINT} as representing a memory address of this type.
3054 If the letter @samp{Q} is marked as @code{EXTRA_MEMORY_CONSTRAINT},
3055 a @samp{Q} constraint can handle any memory operand, because the
3056 reload pass knows it can be reloaded by copying the memory address
3057 into a base register if required.  This is analogous to the way
3058 an @samp{o} constraint can handle any memory operand.
3059 @end defmac
3060
3061 @defmac EXTRA_ADDRESS_CONSTRAINT (@var{c}, @var{str})
3062 A C expression that defines the optional machine-dependent constraint
3063 letters, amongst those accepted by @code{EXTRA_CONSTRAINT} /
3064 @code{EXTRA_CONSTRAINT_STR}, that should
3065 be treated like address constraints by the reload pass.
3066
3067 It should return 1 if the operand type represented by the constraint
3068 at the start of @var{str}, which starts with the letter @var{c}, comprises
3069 a subset of all memory addresses including
3070 all those that consist of just a base register.  This allows the reload
3071 pass to reload an operand, if it does not directly correspond to the operand
3072 type of @var{str}, by copying it into a base register.
3073
3074 Any constraint marked as @code{EXTRA_ADDRESS_CONSTRAINT} can only
3075 be used with the @code{address_operand} predicate.  It is treated
3076 analogously to the @samp{p} constraint.
3077 @end defmac
3078
3079 @node Stack and Calling
3080 @section Stack Layout and Calling Conventions
3081 @cindex calling conventions
3082
3083 @c prevent bad page break with this line
3084 This describes the stack layout and calling conventions.
3085
3086 @menu
3087 * Frame Layout::
3088 * Exception Handling::
3089 * Stack Checking::
3090 * Frame Registers::
3091 * Elimination::
3092 * Stack Arguments::
3093 * Register Arguments::
3094 * Scalar Return::
3095 * Aggregate Return::
3096 * Caller Saves::
3097 * Function Entry::
3098 * Profiling::
3099 * Tail Calls::
3100 * Stack Smashing Protection::
3101 @end menu
3102
3103 @node Frame Layout
3104 @subsection Basic Stack Layout
3105 @cindex stack frame layout
3106 @cindex frame layout
3107
3108 @c prevent bad page break with this line
3109 Here is the basic stack layout.
3110
3111 @defmac STACK_GROWS_DOWNWARD
3112 Define this macro if pushing a word onto the stack moves the stack
3113 pointer to a smaller address.
3114
3115 When we say, ``define this macro if @dots{}'', it means that the
3116 compiler checks this macro only with @code{#ifdef} so the precise
3117 definition used does not matter.
3118 @end defmac
3119
3120 @defmac STACK_PUSH_CODE
3121 This macro defines the operation used when something is pushed
3122 on the stack.  In RTL, a push operation will be
3123 @code{(set (mem (STACK_PUSH_CODE (reg sp))) @dots{})}
3124
3125 The choices are @code{PRE_DEC}, @code{POST_DEC}, @code{PRE_INC},
3126 and @code{POST_INC}.  Which of these is correct depends on
3127 the stack direction and on whether the stack pointer points
3128 to the last item on the stack or whether it points to the
3129 space for the next item on the stack.
3130
3131 The default is @code{PRE_DEC} when @code{STACK_GROWS_DOWNWARD} is
3132 defined, which is almost always right, and @code{PRE_INC} otherwise,
3133 which is often wrong.
3134 @end defmac
3135
3136 @defmac FRAME_GROWS_DOWNWARD
3137 Define this macro to nonzero value if the addresses of local variable slots
3138 are at negative offsets from the frame pointer.
3139 @end defmac
3140
3141 @defmac ARGS_GROW_DOWNWARD
3142 Define this macro if successive arguments to a function occupy decreasing
3143 addresses on the stack.
3144 @end defmac
3145
3146 @defmac STARTING_FRAME_OFFSET
3147 Offset from the frame pointer to the first local variable slot to be allocated.
3148
3149 If @code{FRAME_GROWS_DOWNWARD}, find the next slot's offset by
3150 subtracting the first slot's length from @code{STARTING_FRAME_OFFSET}.
3151 Otherwise, it is found by adding the length of the first slot to the
3152 value @code{STARTING_FRAME_OFFSET}.
3153 @c i'm not sure if the above is still correct.. had to change it to get
3154 @c rid of an overfull.  --mew 2feb93
3155 @end defmac
3156
3157 @defmac STACK_ALIGNMENT_NEEDED
3158 Define to zero to disable final alignment of the stack during reload.
3159 The nonzero default for this macro is suitable for most ports.
3160
3161 On ports where @code{STARTING_FRAME_OFFSET} is nonzero or where there
3162 is a register save block following the local block that doesn't require
3163 alignment to @code{STACK_BOUNDARY}, it may be beneficial to disable
3164 stack alignment and do it in the backend.
3165 @end defmac
3166
3167 @defmac STACK_POINTER_OFFSET
3168 Offset from the stack pointer register to the first location at which
3169 outgoing arguments are placed.  If not specified, the default value of
3170 zero is used.  This is the proper value for most machines.
3171
3172 If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above
3173 the first location at which outgoing arguments are placed.
3174 @end defmac
3175
3176 @defmac FIRST_PARM_OFFSET (@var{fundecl})
3177 Offset from the argument pointer register to the first argument's
3178 address.  On some machines it may depend on the data type of the
3179 function.
3180
3181 If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above
3182 the first argument's address.
3183 @end defmac
3184
3185 @defmac STACK_DYNAMIC_OFFSET (@var{fundecl})
3186 Offset from the stack pointer register to an item dynamically allocated
3187 on the stack, e.g., by @code{alloca}.
3188
3189 The default value for this macro is @code{STACK_POINTER_OFFSET} plus the
3190 length of the outgoing arguments.  The default is correct for most
3191 machines.  See @file{function.c} for details.
3192 @end defmac
3193
3194 @defmac INITIAL_FRAME_ADDRESS_RTX
3195 A C expression whose value is RTL representing the address of the initial
3196 stack frame. This address is passed to @code{RETURN_ADDR_RTX} and
3197 @code{DYNAMIC_CHAIN_ADDRESS}.  If you don't define this macro, a reasonable
3198 default value will be used.  Define this macro in order to make frame pointer
3199 elimination work in the presence of @code{__builtin_frame_address (count)} and
3200 @code{__builtin_return_address (count)} for @code{count} not equal to zero.
3201 @end defmac
3202
3203 @defmac DYNAMIC_CHAIN_ADDRESS (@var{frameaddr})
3204 A C expression whose value is RTL representing the address in a stack
3205 frame where the pointer to the caller's frame is stored.  Assume that
3206 @var{frameaddr} is an RTL expression for the address of the stack frame
3207 itself.
3208
3209 If you don't define this macro, the default is to return the value
3210 of @var{frameaddr}---that is, the stack frame address is also the
3211 address of the stack word that points to the previous frame.
3212 @end defmac
3213
3214 @defmac SETUP_FRAME_ADDRESSES
3215 If defined, a C expression that produces the machine-specific code to
3216 setup the stack so that arbitrary frames can be accessed.  For example,
3217 on the SPARC, we must flush all of the register windows to the stack
3218 before we can access arbitrary stack frames.  You will seldom need to
3219 define this macro.
3220 @end defmac
3221
3222 @deftypefn {Target Hook} bool TARGET_BUILTIN_SETJMP_FRAME_VALUE ()
3223 This target hook should return an rtx that is used to store
3224 the address of the current frame into the built in @code{setjmp} buffer.
3225 The default value, @code{virtual_stack_vars_rtx}, is correct for most
3226 machines.  One reason you may need to define this target hook is if
3227 @code{hard_frame_pointer_rtx} is the appropriate value on your machine.
3228 @end deftypefn
3229
3230 @defmac FRAME_ADDR_RTX (@var{frameaddr})
3231 A C expression whose value is RTL representing the value of the frame
3232 address for the current frame.  @var{frameaddr} is the frame pointer
3233 of the current frame.  This is used for __builtin_frame_address.
3234 You need only define this macro if the frame address is not the same
3235 as the frame pointer.  Most machines do not need to define it.
3236 @end defmac
3237
3238 @defmac RETURN_ADDR_RTX (@var{count}, @var{frameaddr})
3239 A C expression whose value is RTL representing the value of the return
3240 address for the frame @var{count} steps up from the current frame, after
3241 the prologue.  @var{frameaddr} is the frame pointer of the @var{count}
3242 frame, or the frame pointer of the @var{count} @minus{} 1 frame if
3243 @code{RETURN_ADDR_IN_PREVIOUS_FRAME} is defined.
3244
3245 The value of the expression must always be the correct address when
3246 @var{count} is zero, but may be @code{NULL_RTX} if there is no way to
3247 determine the return address of other frames.
3248 @end defmac
3249
3250 @defmac RETURN_ADDR_IN_PREVIOUS_FRAME
3251 Define this if the return address of a particular stack frame is accessed
3252 from the frame pointer of the previous stack frame.
3253 @end defmac
3254
3255 @defmac INCOMING_RETURN_ADDR_RTX
3256 A C expression whose value is RTL representing the location of the
3257 incoming return address at the beginning of any function, before the
3258 prologue.  This RTL is either a @code{REG}, indicating that the return
3259 value is saved in @samp{REG}, or a @code{MEM} representing a location in
3260 the stack.
3261
3262 You only need to define this macro if you want to support call frame
3263 debugging information like that provided by DWARF 2.
3264
3265 If this RTL is a @code{REG}, you should also define
3266 @code{DWARF_FRAME_RETURN_COLUMN} to @code{DWARF_FRAME_REGNUM (REGNO)}.
3267 @end defmac
3268
3269 @defmac DWARF_ALT_FRAME_RETURN_COLUMN
3270 A C expression whose value is an integer giving a DWARF 2 column
3271 number that may be used as an alternative return column.  The column
3272 must not correspond to any gcc hard register (that is, it must not
3273 be in the range of @code{DWARF_FRAME_REGNUM}).
3274
3275 This macro can be useful if @code{DWARF_FRAME_RETURN_COLUMN} is set to a
3276 general register, but an alternative column needs to be used for signal
3277 frames.  Some targets have also used different frame return columns
3278 over time.
3279 @end defmac
3280
3281 @defmac DWARF_ZERO_REG
3282 A C expression whose value is an integer giving a DWARF 2 register
3283 number that is considered to always have the value zero.  This should
3284 only be defined if the target has an architected zero register, and
3285 someone decided it was a good idea to use that register number to
3286 terminate the stack backtrace.  New ports should avoid this.
3287 @end defmac
3288
3289 @deftypefn {Target Hook} void TARGET_DWARF_HANDLE_FRAME_UNSPEC (const char *@var{label}, rtx @var{pattern}, int @var{index})
3290 This target hook allows the backend to emit frame-related insns that
3291 contain UNSPECs or UNSPEC_VOLATILEs.  The DWARF 2 call frame debugging
3292 info engine will invoke it on insns of the form
3293 @smallexample
3294 (set (reg) (unspec [@dots{}] UNSPEC_INDEX))
3295 @end smallexample
3296 and
3297 @smallexample
3298 (set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).
3299 @end smallexample
3300 to let the backend emit the call frame instructions.  @var{label} is
3301 the CFI label attached to the insn, @var{pattern} is the pattern of
3302 the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.
3303 @end deftypefn
3304
3305 @defmac INCOMING_FRAME_SP_OFFSET
3306 A C expression whose value is an integer giving the offset, in bytes,
3307 from the value of the stack pointer register to the top of the stack
3308 frame at the beginning of any function, before the prologue.  The top of
3309 the frame is defined to be the value of the stack pointer in the
3310 previous frame, just before the call instruction.
3311
3312 You only need to define this macro if you want to support call frame
3313 debugging information like that provided by DWARF 2.
3314 @end defmac
3315
3316 @defmac ARG_POINTER_CFA_OFFSET (@var{fundecl})
3317 A C expression whose value is an integer giving the offset, in bytes,
3318 from the argument pointer to the canonical frame address (cfa).  The
3319 final value should coincide with that calculated by
3320 @code{INCOMING_FRAME_SP_OFFSET}.  Which is unfortunately not usable
3321 during virtual register instantiation.
3322
3323 The default value for this macro is @code{FIRST_PARM_OFFSET (fundecl)},
3324 which is correct for most machines; in general, the arguments are found
3325 immediately before the stack frame.  Note that this is not the case on
3326 some targets that save registers into the caller's frame, such as SPARC
3327 and rs6000, and so such targets need to define this macro.
3328
3329 You only need to define this macro if the default is incorrect, and you
3330 want to support call frame debugging information like that provided by
3331 DWARF 2.
3332 @end defmac
3333
3334 @defmac FRAME_POINTER_CFA_OFFSET (@var{fundecl})
3335 If defined, a C expression whose value is an integer giving the offset
3336 in bytes from the frame pointer to the canonical frame address (cfa).
3337 The final value should coincide with that calculated by
3338 @code{INCOMING_FRAME_SP_OFFSET}.
3339
3340 Normally the CFA is calculated as an offset from the argument pointer,
3341 via @code{ARG_POINTER_CFA_OFFSET}, but if the argument pointer is
3342 variable due to the ABI, this may not be possible.  If this macro is
3343 defined, it implies that the virtual register instantiation should be
3344 based on the frame pointer instead of the argument pointer.  Only one
3345 of @code{FRAME_POINTER_CFA_OFFSET} and @code{ARG_POINTER_CFA_OFFSET}
3346 should be defined.
3347 @end defmac
3348
3349 @defmac CFA_FRAME_BASE_OFFSET (@var{fundecl})
3350 If defined, a C expression whose value is an integer giving the offset
3351 in bytes from the canonical frame address (cfa) to the frame base used
3352 in DWARF 2 debug information.  The default is zero.  A different value
3353 may reduce the size of debug information on some ports.
3354 @end defmac
3355
3356 @node Exception Handling
3357 @subsection Exception Handling Support
3358 @cindex exception handling
3359
3360 @defmac EH_RETURN_DATA_REGNO (@var{N})
3361 A C expression whose value is the @var{N}th register number used for
3362 data by exception handlers, or @code{INVALID_REGNUM} if fewer than
3363 @var{N} registers are usable.
3364
3365 The exception handling library routines communicate with the exception
3366 handlers via a set of agreed upon registers.  Ideally these registers
3367 should be call-clobbered; it is possible to use call-saved registers,
3368 but may negatively impact code size.  The target must support at least
3369 2 data registers, but should define 4 if there are enough free registers.
3370
3371 You must define this macro if you want to support call frame exception
3372 handling like that provided by DWARF 2.
3373 @end defmac
3374
3375 @defmac EH_RETURN_STACKADJ_RTX
3376 A C expression whose value is RTL representing a location in which
3377 to store a stack adjustment to be applied before function return.
3378 This is used to unwind the stack to an exception handler's call frame.
3379 It will be assigned zero on code paths that return normally.
3380
3381 Typically this is a call-clobbered hard register that is otherwise
3382 untouched by the epilogue, but could also be a stack slot.
3383
3384 Do not define this macro if the stack pointer is saved and restored
3385 by the regular prolog and epilog code in the call frame itself; in
3386 this case, the exception handling library routines will update the
3387 stack location to be restored in place.  Otherwise, you must define
3388 this macro if you want to support call frame exception handling like
3389 that provided by DWARF 2.
3390 @end defmac
3391
3392 @defmac EH_RETURN_HANDLER_RTX
3393 A C expression whose value is RTL representing a location in which
3394 to store the address of an exception handler to which we should
3395 return.  It will not be assigned on code paths that return normally.
3396
3397 Typically this is the location in the call frame at which the normal
3398 return address is stored.  For targets that return by popping an
3399 address off the stack, this might be a memory address just below
3400 the @emph{target} call frame rather than inside the current call
3401 frame.  If defined, @code{EH_RETURN_STACKADJ_RTX} will have already
3402 been assigned, so it may be used to calculate the location of the
3403 target call frame.
3404
3405 Some targets have more complex requirements than storing to an
3406 address calculable during initial code generation.  In that case
3407 the @code{eh_return} instruction pattern should be used instead.
3408
3409 If you want to support call frame exception handling, you must
3410 define either this macro or the @code{eh_return} instruction pattern.
3411 @end defmac
3412
3413 @defmac RETURN_ADDR_OFFSET
3414 If defined, an integer-valued C expression for which rtl will be generated
3415 to add it to the exception handler address before it is searched in the
3416 exception handling tables, and to subtract it again from the address before
3417 using it to return to the exception handler.
3418 @end defmac
3419
3420 @defmac ASM_PREFERRED_EH_DATA_FORMAT (@var{code}, @var{global})
3421 This macro chooses the encoding of pointers embedded in the exception
3422 handling sections.  If at all possible, this should be defined such
3423 that the exception handling section will not require dynamic relocations,
3424 and so may be read-only.
3425
3426 @var{code} is 0 for data, 1 for code labels, 2 for function pointers.
3427 @var{global} is true if the symbol may be affected by dynamic relocations.
3428 The macro should return a combination of the @code{DW_EH_PE_*} defines
3429 as found in @file{dwarf2.h}.
3430
3431 If this macro is not defined, pointers will not be encoded but
3432 represented directly.
3433 @end defmac
3434
3435 @defmac ASM_MAYBE_OUTPUT_ENCODED_ADDR_RTX (@var{file}, @var{encoding}, @var{size}, @var{addr}, @var{done})
3436 This macro allows the target to emit whatever special magic is required
3437 to represent the encoding chosen by @code{ASM_PREFERRED_EH_DATA_FORMAT}.
3438 Generic code takes care of pc-relative and indirect encodings; this must
3439 be defined if the target uses text-relative or data-relative encodings.
3440
3441 This is a C statement that branches to @var{done} if the format was
3442 handled.  @var{encoding} is the format chosen, @var{size} is the number
3443 of bytes that the format occupies, @var{addr} is the @code{SYMBOL_REF}
3444 to be emitted.
3445 @end defmac
3446
3447 @defmac MD_UNWIND_SUPPORT
3448 A string specifying a file to be #include'd in unwind-dw2.c.  The file
3449 so included typically defines @code{MD_FALLBACK_FRAME_STATE_FOR}.
3450 @end defmac
3451
3452 @defmac MD_FALLBACK_FRAME_STATE_FOR (@var{context}, @var{fs})
3453 This macro allows the target to add CPU and operating system specific
3454 code to the call-frame unwinder for use when there is no unwind data
3455 available.  The most common reason to implement this macro is to unwind
3456 through signal frames.
3457
3458 This macro is called from @code{uw_frame_state_for} in
3459 @file{unwind-dw2.c}, @file{unwind-dw2-xtensa.c} and
3460 @file{unwind-ia64.c}.  @var{context} is an @code{_Unwind_Context};
3461 @var{fs} is an @code{_Unwind_FrameState}.  Examine @code{context->ra}
3462 for the address of the code being executed and @code{context->cfa} for
3463 the stack pointer value.  If the frame can be decoded, the register
3464 save addresses should be updated in @var{fs} and the macro should
3465 evaluate to @code{_URC_NO_REASON}.  If the frame cannot be decoded,
3466 the macro should evaluate to @code{_URC_END_OF_STACK}.
3467
3468 For proper signal handling in Java this macro is accompanied by
3469 @code{MAKE_THROW_FRAME}, defined in @file{libjava/include/*-signal.h} headers.
3470 @end defmac
3471
3472 @defmac MD_HANDLE_UNWABI (@var{context}, @var{fs})
3473 This macro allows the target to add operating system specific code to the
3474 call-frame unwinder to handle the IA-64 @code{.unwabi} unwinding directive,
3475 usually used for signal or interrupt frames.
3476
3477 This macro is called from @code{uw_update_context} in @file{unwind-ia64.c}.
3478 @var{context} is an @code{_Unwind_Context};
3479 @var{fs} is an @code{_Unwind_FrameState}.  Examine @code{fs->unwabi}
3480 for the abi and context in the @code{.unwabi} directive.  If the
3481 @code{.unwabi} directive can be handled, the register save addresses should
3482 be updated in @var{fs}.
3483 @end defmac
3484
3485 @defmac TARGET_USES_WEAK_UNWIND_INFO
3486 A C expression that evaluates to true if the target requires unwind
3487 info to be given comdat linkage.  Define it to be @code{1} if comdat
3488 linkage is necessary.  The default is @code{0}.
3489 @end defmac
3490
3491 @node Stack Checking
3492 @subsection Specifying How Stack Checking is Done
3493
3494 GCC will check that stack references are within the boundaries of the
3495 stack, if the option @option{-fstack-check} is specified, in one of
3496 three ways:
3497
3498 @enumerate
3499 @item
3500 If the value of the @code{STACK_CHECK_BUILTIN} macro is nonzero, GCC
3501 will assume that you have arranged for full stack checking to be done
3502 at appropriate places in the configuration files.  GCC will not do
3503 other special processing.
3504
3505 @item
3506 If @code{STACK_CHECK_BUILTIN} is zero and the value of the
3507 @code{STACK_CHECK_STATIC_BUILTIN} macro is nonzero, GCC will assume
3508 that you have arranged for static stack checking (checking of the
3509 static stack frame of functions) to be done at appropriate places
3510 in the configuration files.  GCC will only emit code to do dynamic
3511 stack checking (checking on dynamic stack allocations) using the third
3512 approach below.
3513
3514 @item
3515 If neither of the above are true, GCC will generate code to periodically
3516 ``probe'' the stack pointer using the values of the macros defined below.
3517 @end enumerate
3518
3519 If neither STACK_CHECK_BUILTIN nor STACK_CHECK_STATIC_BUILTIN is defined,
3520 GCC will change its allocation strategy for large objects if the option
3521 @option{-fstack-check} is specified: they will always be allocated
3522 dynamically if their size exceeds @code{STACK_CHECK_MAX_VAR_SIZE} bytes.
3523
3524 @defmac STACK_CHECK_BUILTIN
3525 A nonzero value if stack checking is done by the configuration files in a
3526 machine-dependent manner.  You should define this macro if stack checking
3527 is require by the ABI of your machine or if you would like to do stack
3528 checking in some more efficient way than the generic approach.  The default
3529 value of this macro is zero.
3530 @end defmac
3531
3532 @defmac STACK_CHECK_STATIC_BUILTIN
3533 A nonzero value if static stack checking is done by the configuration files
3534 in a machine-dependent manner.  You should define this macro if you would
3535 like to do static stack checking in some more efficient way than the generic
3536 approach.  The default value of this macro is zero.
3537 @end defmac
3538
3539 @defmac STACK_CHECK_PROBE_INTERVAL
3540 An integer representing the interval at which GCC must generate stack
3541 probe instructions.  You will normally define this macro to be no larger
3542 than the size of the ``guard pages'' at the end of a stack area.  The
3543 default value of 4096 is suitable for most systems.
3544 @end defmac
3545
3546 @defmac STACK_CHECK_PROBE_LOAD
3547 An integer which is nonzero if GCC should perform the stack probe
3548 as a load instruction and zero if GCC should use a store instruction.
3549 The default is zero, which is the most efficient choice on most systems.
3550 @end defmac
3551
3552 @defmac STACK_CHECK_PROTECT
3553 The number of bytes of stack needed to recover from a stack overflow,
3554 for languages where such a recovery is supported.  The default value of
3555 75 words should be adequate for most machines.
3556 @end defmac
3557
3558 The following macros are relevant only if neither STACK_CHECK_BUILTIN
3559 nor STACK_CHECK_STATIC_BUILTIN is defined; you can omit them altogether
3560 in the opposite case.
3561
3562 @defmac STACK_CHECK_MAX_FRAME_SIZE
3563 The maximum size of a stack frame, in bytes.  GCC will generate probe
3564 instructions in non-leaf functions to ensure at least this many bytes of
3565 stack are available.  If a stack frame is larger than this size, stack
3566 checking will not be reliable and GCC will issue a warning.  The
3567 default is chosen so that GCC only generates one instruction on most
3568 systems.  You should normally not change the default value of this macro.
3569 @end defmac
3570
3571 @defmac STACK_CHECK_FIXED_FRAME_SIZE
3572 GCC uses this value to generate the above warning message.  It
3573 represents the amount of fixed frame used by a function, not including
3574 space for any callee-saved registers, temporaries and user variables.
3575 You need only specify an upper bound for this amount and will normally
3576 use the default of four words.
3577 @end defmac
3578
3579 @defmac STACK_CHECK_MAX_VAR_SIZE
3580 The maximum size, in bytes, of an object that GCC will place in the
3581 fixed area of the stack frame when the user specifies
3582 @option{-fstack-check}.
3583 GCC computed the default from the values of the above macros and you will
3584 normally not need to override that default.
3585 @end defmac
3586
3587 @need 2000
3588 @node Frame Registers
3589 @subsection Registers That Address the Stack Frame
3590
3591 @c prevent bad page break with this line
3592 This discusses registers that address the stack frame.
3593
3594 @defmac STACK_POINTER_REGNUM
3595 The register number of the stack pointer register, which must also be a
3596 fixed register according to @code{FIXED_REGISTERS}.  On most machines,
3597 the hardware determines which register this is.
3598 @end defmac
3599
3600 @defmac FRAME_POINTER_REGNUM
3601 The register number of the frame pointer register, which is used to
3602 access automatic variables in the stack frame.  On some machines, the
3603 hardware determines which register this is.  On other machines, you can
3604 choose any register you wish for this purpose.
3605 @end defmac
3606
3607 @defmac HARD_FRAME_POINTER_REGNUM
3608 On some machines the offset between the frame pointer and starting
3609 offset of the automatic variables is not known until after register
3610 allocation has been done (for example, because the saved registers are
3611 between these two locations).  On those machines, define
3612 @code{FRAME_POINTER_REGNUM} the number of a special, fixed register to
3613 be used internally until the offset is known, and define
3614 @code{HARD_FRAME_POINTER_REGNUM} to be the actual hard register number
3615 used for the frame pointer.
3616
3617 You should define this macro only in the very rare circumstances when it
3618 is not possible to calculate the offset between the frame pointer and
3619 the automatic variables until after register allocation has been
3620 completed.  When this macro is defined, you must also indicate in your
3621 definition of @code{ELIMINABLE_REGS} how to eliminate
3622 @code{FRAME_POINTER_REGNUM} into either @code{HARD_FRAME_POINTER_REGNUM}
3623 or @code{STACK_POINTER_REGNUM}.
3624
3625 Do not define this macro if it would be the same as
3626 @code{FRAME_POINTER_REGNUM}.
3627 @end defmac
3628
3629 @defmac ARG_POINTER_REGNUM
3630 The register number of the arg pointer register, which is used to access
3631 the function's argument list.  On some machines, this is the same as the
3632 frame pointer register.  On some machines, the hardware determines which
3633 register this is.  On other machines, you can choose any register you
3634 wish for this purpose.  If this is not the same register as the frame
3635 pointer register, then you must mark it as a fixed register according to
3636 @code{FIXED_REGISTERS}, or arrange to be able to eliminate it
3637 (@pxref{Elimination}).
3638 @end defmac
3639
3640 @defmac RETURN_ADDRESS_POINTER_REGNUM
3641 The register number of the return address pointer register, which is used to
3642 access the current function's return address from the stack.  On some
3643 machines, the return address is not at a fixed offset from the frame
3644 pointer or stack pointer or argument pointer.  This register can be defined
3645 to point to the return address on the stack, and then be converted by
3646 @code{ELIMINABLE_REGS} into either the frame pointer or stack pointer.
3647
3648 Do not define this macro unless there is no other way to get the return
3649 address from the stack.
3650 @end defmac
3651
3652 @defmac STATIC_CHAIN_REGNUM
3653 @defmacx STATIC_CHAIN_INCOMING_REGNUM
3654 Register numbers used for passing a function's static chain pointer.  If
3655 register windows are used, the register number as seen by the called
3656 function is @code{STATIC_CHAIN_INCOMING_REGNUM}, while the register
3657 number as seen by the calling function is @code{STATIC_CHAIN_REGNUM}.  If
3658 these registers are the same, @code{STATIC_CHAIN_INCOMING_REGNUM} need
3659 not be defined.
3660
3661 The static chain register need not be a fixed register.
3662
3663 If the static chain is passed in memory, these macros should not be
3664 defined; instead, the @code{TARGET_STATIC_CHAIN} hook should be used.
3665 @end defmac
3666
3667 @deftypefn {Target Hook} rtx TARGET_STATIC_CHAIN (const_tree @var{fndecl}, bool @var{incoming_p})
3668 This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for
3669 targets that may use different static chain locations for different
3670 nested functions.  This may be required if the target has function
3671 attributes that affect the calling conventions of the function and
3672 those calling conventions use different static chain locations.
3673
3674 The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.
3675
3676 If the static chain is passed in memory, this hook should be used to
3677 provide rtx giving @code{mem} expressions that denote where they are stored.
3678 Often the @code{mem} expression as seen by the caller will be at an offset
3679 from the stack pointer and the @code{mem} expression as seen by the callee
3680 will be at an offset from the frame pointer.
3681 @findex stack_pointer_rtx
3682 @findex frame_pointer_rtx
3683 @findex arg_pointer_rtx
3684 The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and
3685 @code{arg_pointer_rtx} will have been initialized and should be used
3686 to refer to those items.
3687 @end deftypefn
3688
3689 @defmac DWARF_FRAME_REGISTERS
3690 This macro specifies the maximum number of hard registers that can be
3691 saved in a call frame.  This is used to size data structures used in
3692 DWARF2 exception handling.
3693
3694 Prior to GCC 3.0, this macro was needed in order to establish a stable
3695 exception handling ABI in the face of adding new hard registers for ISA
3696 extensions.  In GCC 3.0 and later, the EH ABI is insulated from changes
3697 in the number of hard registers.  Nevertheless, this macro can still be
3698 used to reduce the runtime memory requirements of the exception handling
3699 routines, which can be substantial if the ISA contains a lot of
3700 registers that are not call-saved.
3701
3702 If this macro is not defined, it defaults to
3703 @code{FIRST_PSEUDO_REGISTER}.
3704 @end defmac
3705
3706 @defmac PRE_GCC3_DWARF_FRAME_REGISTERS
3707
3708 This macro is similar to @code{DWARF_FRAME_REGISTERS}, but is provided
3709 for backward compatibility in pre GCC 3.0 compiled code.
3710
3711 If this macro is not defined, it defaults to
3712 @code{DWARF_FRAME_REGISTERS}.
3713 @end defmac
3714
3715 @defmac DWARF_REG_TO_UNWIND_COLUMN (@var{regno})
3716
3717 Define this macro if the target's representation for dwarf registers
3718 is different than the internal representation for unwind column.
3719 Given a dwarf register, this macro should return the internal unwind
3720 column number to use instead.
3721
3722 See the PowerPC's SPE target for an example.
3723 @end defmac
3724
3725 @defmac DWARF_FRAME_REGNUM (@var{regno})
3726
3727 Define this macro if the target's representation for dwarf registers
3728 used in .eh_frame or .debug_frame is different from that used in other
3729 debug info sections.  Given a GCC hard register number, this macro
3730 should return the .eh_frame register number.  The default is
3731 @code{DBX_REGISTER_NUMBER (@var{regno})}.
3732
3733 @end defmac
3734
3735 @defmac DWARF2_FRAME_REG_OUT (@var{regno}, @var{for_eh})
3736
3737 Define this macro to map register numbers held in the call frame info
3738 that GCC has collected using @code{DWARF_FRAME_REGNUM} to those that
3739 should be output in .debug_frame (@code{@var{for_eh}} is zero) and
3740 .eh_frame (@code{@var{for_eh}} is nonzero).  The default is to
3741 return @code{@var{regno}}.
3742
3743 @end defmac
3744
3745 @node Elimination
3746 @subsection Eliminating Frame Pointer and Arg Pointer
3747
3748 @c prevent bad page break with this line
3749 This is about eliminating the frame pointer and arg pointer.
3750
3751 @deftypefn {Target Hook} bool TARGET_FRAME_POINTER_REQUIRED (void)
3752 This target hook should return @code{true} if a function must have and use
3753 a frame pointer.  This target hook is called in the reload pass.  If its return
3754 value is @code{true} the function will have a frame pointer.
3755
3756 This target hook can in principle examine the current function and decide
3757 according to the facts, but on most machines the constant @code{false} or the
3758 constant @code{true} suffices.  Use @code{false} when the machine allows code
3759 to be generated with no frame pointer, and doing so saves some time or space.
3760 Use @code{true} when there is no possible advantage to avoiding a frame
3761 pointer.
3762
3763 In certain cases, the compiler does not know how to produce valid code
3764 without a frame pointer.  The compiler recognizes those cases and
3765 automatically gives the function a frame pointer regardless of what
3766 @code{TARGET_FRAME_POINTER_REQUIRED} returns.  You don't need to worry about
3767 them.
3768
3769 In a function that does not require a frame pointer, the frame pointer
3770 register can be allocated for ordinary usage, unless you mark it as a
3771 fixed register.  See @code{FIXED_REGISTERS} for more information.
3772
3773 Default return value is @code{false}.
3774 @end deftypefn
3775
3776 @findex get_frame_size
3777 @defmac INITIAL_FRAME_POINTER_OFFSET (@var{depth-var})
3778 A C statement to store in the variable @var{depth-var} the difference
3779 between the frame pointer and the stack pointer values immediately after
3780 the function prologue.  The value would be computed from information
3781 such as the result of @code{get_frame_size ()} and the tables of
3782 registers @code{regs_ever_live} and @code{call_used_regs}.
3783
3784 If @code{ELIMINABLE_REGS} is defined, this macro will be not be used and
3785 need not be defined.  Otherwise, it must be defined even if
3786 @code{TARGET_FRAME_POINTER_REQUIRED} is always return true; in that
3787 case, you may set @var{depth-var} to anything.
3788 @end defmac
3789
3790 @defmac ELIMINABLE_REGS
3791 If defined, this macro specifies a table of register pairs used to
3792 eliminate unneeded registers that point into the stack frame.  If it is not
3793 defined, the only elimination attempted by the compiler is to replace
3794 references to the frame pointer with references to the stack pointer.
3795
3796 The definition of this macro is a list of structure initializations, each
3797 of which specifies an original and replacement register.
3798
3799 On some machines, the position of the argument pointer is not known until
3800 the compilation is completed.  In such a case, a separate hard register
3801 must be used for the argument pointer.  This register can be eliminated by
3802 replacing it with either the frame pointer or the argument pointer,
3803 depending on whether or not the frame pointer has been eliminated.
3804
3805 In this case, you might specify:
3806 @smallexample
3807 #define ELIMINABLE_REGS  \
3808 @{@{ARG_POINTER_REGNUM, STACK_POINTER_REGNUM@}, \
3809  @{ARG_POINTER_REGNUM, FRAME_POINTER_REGNUM@}, \
3810  @{FRAME_POINTER_REGNUM, STACK_POINTER_REGNUM@}@}
3811 @end smallexample
3812
3813 Note that the elimination of the argument pointer with the stack pointer is
3814 specified first since that is the preferred elimination.
3815 @end defmac
3816
3817 @deftypefn {Target Hook} bool TARGET_CAN_ELIMINATE (const int @var{from-reg}, const int @var{to-reg})
3818 This target hook should returns @code{true} if the compiler is allowed to
3819 try to replace register number @var{from-reg} with register number
3820 @var{to-reg}.  This target hook need only be defined if @code{ELIMINABLE_REGS}
3821 is defined, and will usually be @code{true}, since most of the cases
3822 preventing register elimination are things that the compiler already
3823 knows about.
3824
3825 Default return value is @code{true}.
3826 @end deftypefn
3827
3828 @defmac INITIAL_ELIMINATION_OFFSET (@var{from-reg}, @var{to-reg}, @var{offset-var})
3829 This macro is similar to @code{INITIAL_FRAME_POINTER_OFFSET}.  It
3830 specifies the initial difference between the specified pair of
3831 registers.  This macro must be defined if @code{ELIMINABLE_REGS} is
3832 defined.
3833 @end defmac
3834
3835 @node Stack Arguments
3836 @subsection Passing Function Arguments on the Stack
3837 @cindex arguments on stack
3838 @cindex stack arguments
3839
3840 The macros in this section control how arguments are passed
3841 on the stack.  See the following section for other macros that
3842 control passing certain arguments in registers.
3843
3844 @deftypefn {Target Hook} bool TARGET_PROMOTE_PROTOTYPES (tree @var{fntype})
3845 This target hook returns @code{true} if an argument declared in a
3846 prototype as an integral type smaller than @code{int} should actually be
3847 passed as an @code{int}.  In addition to avoiding errors in certain
3848 cases of mismatch, it also makes for better code on certain machines.
3849 The default is to not promote prototypes.
3850 @end deftypefn
3851
3852 @defmac PUSH_ARGS
3853 A C expression.  If nonzero, push insns will be used to pass
3854 outgoing arguments.
3855 If the target machine does not have a push instruction, set it to zero.
3856 That directs GCC to use an alternate strategy: to
3857 allocate the entire argument block and then store the arguments into
3858 it.  When @code{PUSH_ARGS} is nonzero, @code{PUSH_ROUNDING} must be defined too.
3859 @end defmac
3860
3861 @defmac PUSH_ARGS_REVERSED
3862 A C expression.  If nonzero, function arguments will be evaluated from
3863 last to first, rather than from first to last.  If this macro is not
3864 defined, it defaults to @code{PUSH_ARGS} on targets where the stack
3865 and args grow in opposite directions, and 0 otherwise.
3866 @end defmac
3867
3868 @defmac PUSH_ROUNDING (@var{npushed})
3869 A C expression that is the number of bytes actually pushed onto the
3870 stack when an instruction attempts to push @var{npushed} bytes.
3871
3872 On some machines, the definition
3873
3874 @smallexample
3875 #define PUSH_ROUNDING(BYTES) (BYTES)
3876 @end smallexample
3877
3878 @noindent
3879 will suffice.  But on other machines, instructions that appear
3880 to push one byte actually push two bytes in an attempt to maintain
3881 alignment.  Then the definition should be
3882
3883 @smallexample
3884 #define PUSH_ROUNDING(BYTES) (((BYTES) + 1) & ~1)
3885 @end smallexample
3886 @end defmac
3887
3888 @findex current_function_outgoing_args_size
3889 @defmac ACCUMULATE_OUTGOING_ARGS
3890 A C expression.  If nonzero, the maximum amount of space required for outgoing arguments
3891 will be computed and placed into the variable
3892 @code{current_function_outgoing_args_size}.  No space will be pushed
3893 onto the stack for each call; instead, the function prologue should
3894 increase the stack frame size by this amount.
3895
3896 Setting both @code{PUSH_ARGS} and @code{ACCUMULATE_OUTGOING_ARGS}
3897 is not proper.
3898 @end defmac
3899
3900 @defmac REG_PARM_STACK_SPACE (@var{fndecl})
3901 Define this macro if functions should assume that stack space has been
3902 allocated for arguments even when their values are passed in
3903 registers.
3904
3905 The value of this macro is the size, in bytes, of the area reserved for
3906 arguments passed in registers for the function represented by @var{fndecl},
3907 which can be zero if GCC is calling a library function.
3908 The argument @var{fndecl} can be the FUNCTION_DECL, or the type itself
3909 of the function.
3910
3911 This space can be allocated by the caller, or be a part of the
3912 machine-dependent stack frame: @code{OUTGOING_REG_PARM_STACK_SPACE} says
3913 which.
3914 @end defmac
3915 @c above is overfull.  not sure what to do.  --mew 5feb93  did
3916 @c something, not sure if it looks good.  --mew 10feb93
3917
3918 @defmac OUTGOING_REG_PARM_STACK_SPACE (@var{fntype})
3919 Define this to a nonzero value if it is the responsibility of the
3920 caller to allocate the area reserved for arguments passed in registers
3921 when calling a function of @var{fntype}.  @var{fntype} may be NULL
3922 if the function called is a library function.
3923
3924 If @code{ACCUMULATE_OUTGOING_ARGS} is defined, this macro controls
3925 whether the space for these arguments counts in the value of
3926 @code{current_function_outgoing_args_size}.
3927 @end defmac
3928
3929 @defmac STACK_PARMS_IN_REG_PARM_AREA
3930 Define this macro if @code{REG_PARM_STACK_SPACE} is defined, but the
3931 stack parameters don't skip the area specified by it.
3932 @c i changed this, makes more sens and it should have taken care of the
3933 @c overfull.. not as specific, tho.  --mew 5feb93
3934
3935 Normally, when a parameter is not passed in registers, it is placed on the
3936 stack beyond the @code{REG_PARM_STACK_SPACE} area.  Defining this macro
3937 suppresses this behavior and causes the parameter to be passed on the
3938 stack in its natural location.
3939 @end defmac
3940
3941 @defmac RETURN_POPS_ARGS (@var{fundecl}, @var{funtype}, @var{stack-size})
3942 A C expression that should indicate the number of bytes of its own
3943 arguments that a function pops on returning, or 0 if the
3944 function pops no arguments and the caller must therefore pop them all
3945 after the function returns.
3946
3947 @var{fundecl} is a C variable whose value is a tree node that describes
3948 the function in question.  Normally it is a node of type
3949 @code{FUNCTION_DECL} that describes the declaration of the function.
3950 From this you can obtain the @code{DECL_ATTRIBUTES} of the function.
3951
3952 @var{funtype} is a C variable whose value is a tree node that
3953 describes the function in question.  Normally it is a node of type
3954 @code{FUNCTION_TYPE} that describes the data type of the function.
3955 From this it is possible to obtain the data types of the value and
3956 arguments (if known).
3957
3958 When a call to a library function is being considered, @var{fundecl}
3959 will contain an identifier node for the library function.  Thus, if
3960 you need to distinguish among various library functions, you can do so
3961 by their names.  Note that ``library function'' in this context means
3962 a function used to perform arithmetic, whose name is known specially
3963 in the compiler and was not mentioned in the C code being compiled.
3964
3965 @var{stack-size} is the number of bytes of arguments passed on the
3966 stack.  If a variable number of bytes is passed, it is zero, and
3967 argument popping will always be the responsibility of the calling function.
3968
3969 On the VAX, all functions always pop their arguments, so the definition
3970 of this macro is @var{stack-size}.  On the 68000, using the standard
3971 calling convention, no functions pop their arguments, so the value of
3972 the macro is always 0 in this case.  But an alternative calling
3973 convention is available in which functions that take a fixed number of
3974 arguments pop them but other functions (such as @code{printf}) pop
3975 nothing (the caller pops all).  When this convention is in use,
3976 @var{funtype} is examined to determine whether a function takes a fixed
3977 number of arguments.
3978 @end defmac
3979
3980 @defmac CALL_POPS_ARGS (@var{cum})
3981 A C expression that should indicate the number of bytes a call sequence
3982 pops off the stack.  It is added to the value of @code{RETURN_POPS_ARGS}
3983 when compiling a function call.
3984
3985 @var{cum} is the variable in which all arguments to the called function
3986 have been accumulated.
3987
3988 On certain architectures, such as the SH5, a call trampoline is used
3989 that pops certain registers off the stack, depending on the arguments
3990 that have been passed to the function.  Since this is a property of the
3991 call site, not of the called function, @code{RETURN_POPS_ARGS} is not
3992 appropriate.
3993 @end defmac
3994
3995 @node Register Arguments
3996 @subsection Passing Arguments in Registers
3997 @cindex arguments in registers
3998 @cindex registers arguments
3999
4000 This section describes the macros which let you control how various
4001 types of arguments are passed in registers or how they are arranged in
4002 the stack.
4003
4004 @defmac FUNCTION_ARG (@var{cum}, @var{mode}, @var{type}, @var{named})
4005 A C expression that controls whether a function argument is passed
4006 in a register, and which register.
4007
4008 The arguments are @var{cum}, which summarizes all the previous
4009 arguments; @var{mode}, the machine mode of the argument; @var{type},
4010 the data type of the argument as a tree node or 0 if that is not known
4011 (which happens for C support library functions); and @var{named},
4012 which is 1 for an ordinary argument and 0 for nameless arguments that
4013 correspond to @samp{@dots{}} in the called function's prototype.
4014 @var{type} can be an incomplete type if a syntax error has previously
4015 occurred.
4016
4017 The value of the expression is usually either a @code{reg} RTX for the
4018 hard register in which to pass the argument, or zero to pass the
4019 argument on the stack.
4020
4021 For machines like the VAX and 68000, where normally all arguments are
4022 pushed, zero suffices as a definition.
4023
4024 The value of the expression can also be a @code{parallel} RTX@.  This is
4025 used when an argument is passed in multiple locations.  The mode of the
4026 @code{parallel} should be the mode of the entire argument.  The
4027 @code{parallel} holds any number of @code{expr_list} pairs; each one
4028 describes where part of the argument is passed.  In each
4029 @code{expr_list} the first operand must be a @code{reg} RTX for the hard
4030 register in which to pass this part of the argument, and the mode of the
4031 register RTX indicates how large this part of the argument is.  The
4032 second operand of the @code{expr_list} is a @code{const_int} which gives
4033 the offset in bytes into the entire argument of where this part starts.
4034 As a special exception the first @code{expr_list} in the @code{parallel}
4035 RTX may have a first operand of zero.  This indicates that the entire
4036 argument is also stored on the stack.
4037
4038 The last time this macro is called, it is called with @code{MODE ==
4039 VOIDmode}, and its result is passed to the @code{call} or @code{call_value}
4040 pattern as operands 2 and 3 respectively.
4041
4042 @cindex @file{stdarg.h} and register arguments
4043 The usual way to make the ISO library @file{stdarg.h} work on a machine
4044 where some arguments are usually passed in registers, is to cause
4045 nameless arguments to be passed on the stack instead.  This is done
4046 by making @code{FUNCTION_ARG} return 0 whenever @var{named} is 0.
4047
4048 @cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{FUNCTION_ARG}
4049 @cindex @code{REG_PARM_STACK_SPACE}, and @code{FUNCTION_ARG}
4050 You may use the hook @code{targetm.calls.must_pass_in_stack}
4051 in the definition of this macro to determine if this argument is of a
4052 type that must be passed in the stack.  If @code{REG_PARM_STACK_SPACE}
4053 is not defined and @code{FUNCTION_ARG} returns nonzero for such an
4054 argument, the compiler will abort.  If @code{REG_PARM_STACK_SPACE} is
4055 defined, the argument will be computed in the stack and then loaded into
4056 a register.
4057 @end defmac
4058
4059 @deftypefn {Target Hook} bool TARGET_MUST_PASS_IN_STACK (enum machine_mode @var{mode}, tree @var{type})
4060 This target hook should return @code{true} if we should not pass @var{type}
4061 solely in registers.  The file @file{expr.h} defines a
4062 definition that is usually appropriate, refer to @file{expr.h} for additional
4063 documentation.
4064 @end deftypefn
4065
4066 @defmac FUNCTION_INCOMING_ARG (@var{cum}, @var{mode}, @var{type}, @var{named})
4067 Define this macro if the target machine has ``register windows'', so
4068 that the register in which a function sees an arguments is not
4069 necessarily the same as the one in which the caller passed the
4070 argument.
4071
4072 For such machines, @code{FUNCTION_ARG} computes the register in which
4073 the caller passes the value, and @code{FUNCTION_INCOMING_ARG} should
4074 be defined in a similar fashion to tell the function being called
4075 where the arguments will arrive.
4076
4077 If @code{FUNCTION_INCOMING_ARG} is not defined, @code{FUNCTION_ARG}
4078 serves both purposes.
4079 @end defmac
4080
4081 @deftypefn {Target Hook} int TARGET_ARG_PARTIAL_BYTES (CUMULATIVE_ARGS *@var{cum}, enum machine_mode @var{mode}, tree @var{type}, bool @var{named})
4082 This target hook returns the number of bytes at the beginning of an
4083 argument that must be put in registers.  The value must be zero for
4084 arguments that are passed entirely in registers or that are entirely
4085 pushed on the stack.
4086
4087 On some machines, certain arguments must be passed partially in
4088 registers and partially in memory.  On these machines, typically the
4089 first few words of arguments are passed in registers, and the rest
4090 on the stack.  If a multi-word argument (a @code{double} or a
4091 structure) crosses that boundary, its first few words must be passed
4092 in registers and the rest must be pushed.  This macro tells the
4093 compiler when this occurs, and how many bytes should go in registers.
4094
4095 @code{FUNCTION_ARG} for these arguments should return the first
4096 register to be used by the caller for this argument; likewise
4097 @code{FUNCTION_INCOMING_ARG}, for the called function.
4098 @end deftypefn
4099
4100 @deftypefn {Target Hook} bool TARGET_PASS_BY_REFERENCE (CUMULATIVE_ARGS *@var{cum}, enum machine_mode @var{mode}, tree @var{type}, bool @var{named})
4101 This target hook should return @code{true} if an argument at the
4102 position indicated by @var{cum} should be passed by reference.  This
4103 predicate is queried after target independent reasons for being
4104 passed by reference, such as @code{TREE_ADDRESSABLE (type)}.
4105
4106 If the hook returns true, a copy of that argument is made in memory and a
4107 pointer to the argument is passed instead of the argument itself.
4108 The pointer is passed in whatever way is appropriate for passing a pointer
4109 to that type.
4110 @end deftypefn
4111
4112 @deftypefn {Target Hook} bool TARGET_CALLEE_COPIES (CUMULATIVE_ARGS *@var{cum}, enum machine_mode @var{mode}, tree @var{type}, bool @var{named})
4113 The function argument described by the parameters to this hook is
4114 known to be passed by reference.  The hook should return true if the
4115 function argument should be copied by the callee instead of copied
4116 by the caller.
4117
4118 For any argument for which the hook returns true, if it can be
4119 determined that the argument is not modified, then a copy need
4120 not be generated.
4121
4122 The default version of this hook always returns false.
4123 @end deftypefn
4124
4125 @defmac CUMULATIVE_ARGS
4126 A C type for declaring a variable that is used as the first argument of
4127 @code{FUNCTION_ARG} and other related values.  For some target machines,
4128 the type @code{int} suffices and can hold the number of bytes of
4129 argument so far.
4130
4131 There is no need to record in @code{CUMULATIVE_ARGS} anything about the
4132 arguments that have been passed on the stack.  The compiler has other
4133 variables to keep track of that.  For target machines on which all
4134 arguments are passed on the stack, there is no need to store anything in
4135 @code{CUMULATIVE_ARGS}; however, the data structure must exist and
4136 should not be empty, so use @code{int}.
4137 @end defmac
4138
4139 @defmac OVERRIDE_ABI_FORMAT (@var{fndecl})
4140 If defined, this macro is called before generating any code for a
4141 function, but after the @var{cfun} descriptor for the function has been
4142 created.  The back end may use this macro to update @var{cfun} to
4143 reflect an ABI other than that which would normally be used by default.
4144 If the compiler is generating code for a compiler-generated function,
4145 @var{fndecl} may be @code{NULL}.
4146 @end defmac
4147
4148 @defmac INIT_CUMULATIVE_ARGS (@var{cum}, @var{fntype}, @var{libname}, @var{fndecl}, @var{n_named_args})
4149 A C statement (sans semicolon) for initializing the variable
4150 @var{cum} for the state at the beginning of the argument list.  The
4151 variable has type @code{CUMULATIVE_ARGS}.  The value of @var{fntype}
4152 is the tree node for the data type of the function which will receive
4153 the args, or 0 if the args are to a compiler support library function.
4154 For direct calls that are not libcalls, @var{fndecl} contain the
4155 declaration node of the function.  @var{fndecl} is also set when
4156 @code{INIT_CUMULATIVE_ARGS} is used to find arguments for the function
4157 being compiled.  @var{n_named_args} is set to the number of named
4158 arguments, including a structure return address if it is passed as a
4159 parameter, when making a call.  When processing incoming arguments,
4160 @var{n_named_args} is set to @minus{}1.
4161
4162 When processing a call to a compiler support library function,
4163 @var{libname} identifies which one.  It is a @code{symbol_ref} rtx which
4164 contains the name of the function, as a string.  @var{libname} is 0 when
4165 an ordinary C function call is being processed.  Thus, each time this
4166 macro is called, either @var{libname} or @var{fntype} is nonzero, but
4167 never both of them at once.
4168 @end defmac
4169
4170 @defmac INIT_CUMULATIVE_LIBCALL_ARGS (@var{cum}, @var{mode}, @var{libname})
4171 Like @code{INIT_CUMULATIVE_ARGS} but only used for outgoing libcalls,
4172 it gets a @code{MODE} argument instead of @var{fntype}, that would be
4173 @code{NULL}.  @var{indirect} would always be zero, too.  If this macro
4174 is not defined, @code{INIT_CUMULATIVE_ARGS (cum, NULL_RTX, libname,
4175 0)} is used instead.
4176 @end defmac
4177
4178 @defmac INIT_CUMULATIVE_INCOMING_ARGS (@var{cum}, @var{fntype}, @var{libname})
4179 Like @code{INIT_CUMULATIVE_ARGS} but overrides it for the purposes of
4180 finding the arguments for the function being compiled.  If this macro is
4181 undefined, @code{INIT_CUMULATIVE_ARGS} is used instead.
4182
4183 The value passed for @var{libname} is always 0, since library routines
4184 with special calling conventions are never compiled with GCC@.  The
4185 argument @var{libname} exists for symmetry with
4186 @code{INIT_CUMULATIVE_ARGS}.
4187 @c could use "this macro" in place of @code{INIT_CUMULATIVE_ARGS}, maybe.
4188 @c --mew 5feb93   i switched the order of the sentences.  --mew 10feb93
4189 @end defmac
4190
4191 @defmac FUNCTION_ARG_ADVANCE (@var{cum}, @var{mode}, @var{type}, @var{named})
4192 A C statement (sans semicolon) to update the summarizer variable
4193 @var{cum} to advance past an argument in the argument list.  The
4194 values @var{mode}, @var{type} and @var{named} describe that argument.
4195 Once this is done, the variable @var{cum} is suitable for analyzing
4196 the @emph{following} argument with @code{FUNCTION_ARG}, etc.
4197
4198 This macro need not do anything if the argument in question was passed
4199 on the stack.  The compiler knows how to track the amount of stack space
4200 used for arguments without any special help.
4201 @end defmac
4202
4203
4204 @defmac FUNCTION_ARG_OFFSET (@var{mode}, @var{type})
4205 If&