OSDN Git Service

* MAINTAINERS: Add myself as a maintainer for the RX port.
[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 STACK_REG_COVER_CLASS
2353 This is a cover class containing the stack registers.  Define this if
2354 the machine has any stack-like registers.
2355 @end defmac
2356
2357 @defmac FIRST_STACK_REG
2358 The number of the first stack-like register.  This one is the top
2359 of the stack.
2360 @end defmac
2361
2362 @defmac LAST_STACK_REG
2363 The number of the last stack-like register.  This one is the bottom of
2364 the stack.
2365 @end defmac
2366
2367 @node Register Classes
2368 @section Register Classes
2369 @cindex register class definitions
2370 @cindex class definitions, register
2371
2372 On many machines, the numbered registers are not all equivalent.
2373 For example, certain registers may not be allowed for indexed addressing;
2374 certain registers may not be allowed in some instructions.  These machine
2375 restrictions are described to the compiler using @dfn{register classes}.
2376
2377 You define a number of register classes, giving each one a name and saying
2378 which of the registers belong to it.  Then you can specify register classes
2379 that are allowed as operands to particular instruction patterns.
2380
2381 @findex ALL_REGS
2382 @findex NO_REGS
2383 In general, each register will belong to several classes.  In fact, one
2384 class must be named @code{ALL_REGS} and contain all the registers.  Another
2385 class must be named @code{NO_REGS} and contain no registers.  Often the
2386 union of two classes will be another class; however, this is not required.
2387
2388 @findex GENERAL_REGS
2389 One of the classes must be named @code{GENERAL_REGS}.  There is nothing
2390 terribly special about the name, but the operand constraint letters
2391 @samp{r} and @samp{g} specify this class.  If @code{GENERAL_REGS} is
2392 the same as @code{ALL_REGS}, just define it as a macro which expands
2393 to @code{ALL_REGS}.
2394
2395 Order the classes so that if class @var{x} is contained in class @var{y}
2396 then @var{x} has a lower class number than @var{y}.
2397
2398 The way classes other than @code{GENERAL_REGS} are specified in operand
2399 constraints is through machine-dependent operand constraint letters.
2400 You can define such letters to correspond to various classes, then use
2401 them in operand constraints.
2402
2403 You should define a class for the union of two classes whenever some
2404 instruction allows both classes.  For example, if an instruction allows
2405 either a floating point (coprocessor) register or a general register for a
2406 certain operand, you should define a class @code{FLOAT_OR_GENERAL_REGS}
2407 which includes both of them.  Otherwise you will get suboptimal code.
2408
2409 You must also specify certain redundant information about the register
2410 classes: for each class, which classes contain it and which ones are
2411 contained in it; for each pair of classes, the largest class contained
2412 in their union.
2413
2414 When a value occupying several consecutive registers is expected in a
2415 certain class, all the registers used must belong to that class.
2416 Therefore, register classes cannot be used to enforce a requirement for
2417 a register pair to start with an even-numbered register.  The way to
2418 specify this requirement is with @code{HARD_REGNO_MODE_OK}.
2419
2420 Register classes used for input-operands of bitwise-and or shift
2421 instructions have a special requirement: each such class must have, for
2422 each fixed-point machine mode, a subclass whose registers can transfer that
2423 mode to or from memory.  For example, on some machines, the operations for
2424 single-byte values (@code{QImode}) are limited to certain registers.  When
2425 this is so, each register class that is used in a bitwise-and or shift
2426 instruction must have a subclass consisting of registers from which
2427 single-byte values can be loaded or stored.  This is so that
2428 @code{PREFERRED_RELOAD_CLASS} can always have a possible value to return.
2429
2430 @deftp {Data type} {enum reg_class}
2431 An enumerated type that must be defined with all the register class names
2432 as enumerated values.  @code{NO_REGS} must be first.  @code{ALL_REGS}
2433 must be the last register class, followed by one more enumerated value,
2434 @code{LIM_REG_CLASSES}, which is not a register class but rather
2435 tells how many classes there are.
2436
2437 Each register class has a number, which is the value of casting
2438 the class name to type @code{int}.  The number serves as an index
2439 in many of the tables described below.
2440 @end deftp
2441
2442 @defmac N_REG_CLASSES
2443 The number of distinct register classes, defined as follows:
2444
2445 @smallexample
2446 #define N_REG_CLASSES (int) LIM_REG_CLASSES
2447 @end smallexample
2448 @end defmac
2449
2450 @defmac REG_CLASS_NAMES
2451 An initializer containing the names of the register classes as C string
2452 constants.  These names are used in writing some of the debugging dumps.
2453 @end defmac
2454
2455 @defmac REG_CLASS_CONTENTS
2456 An initializer containing the contents of the register classes, as integers
2457 which are bit masks.  The @var{n}th integer specifies the contents of class
2458 @var{n}.  The way the integer @var{mask} is interpreted is that
2459 register @var{r} is in the class if @code{@var{mask} & (1 << @var{r})} is 1.
2460
2461 When the machine has more than 32 registers, an integer does not suffice.
2462 Then the integers are replaced by sub-initializers, braced groupings containing
2463 several integers.  Each sub-initializer must be suitable as an initializer
2464 for the type @code{HARD_REG_SET} which is defined in @file{hard-reg-set.h}.
2465 In this situation, the first integer in each sub-initializer corresponds to
2466 registers 0 through 31, the second integer to registers 32 through 63, and
2467 so on.
2468 @end defmac
2469
2470 @defmac REGNO_REG_CLASS (@var{regno})
2471 A C expression whose value is a register class containing hard register
2472 @var{regno}.  In general there is more than one such class; choose a class
2473 which is @dfn{minimal}, meaning that no smaller class also contains the
2474 register.
2475 @end defmac
2476
2477 @defmac BASE_REG_CLASS
2478 A macro whose definition is the name of the class to which a valid
2479 base register must belong.  A base register is one used in an address
2480 which is the register value plus a displacement.
2481 @end defmac
2482
2483 @defmac MODE_BASE_REG_CLASS (@var{mode})
2484 This is a variation of the @code{BASE_REG_CLASS} macro which allows
2485 the selection of a base register in a mode dependent manner.  If
2486 @var{mode} is VOIDmode then it should return the same value as
2487 @code{BASE_REG_CLASS}.
2488 @end defmac
2489
2490 @defmac MODE_BASE_REG_REG_CLASS (@var{mode})
2491 A C expression whose value is the register class to which a valid
2492 base register must belong in order to be used in a base plus index
2493 register address.  You should define this macro if base plus index
2494 addresses have different requirements than other base register uses.
2495 @end defmac
2496
2497 @defmac MODE_CODE_BASE_REG_CLASS (@var{mode}, @var{outer_code}, @var{index_code})
2498 A C expression whose value is the register class to which a valid
2499 base register must belong.  @var{outer_code} and @var{index_code} define the
2500 context in which the base register occurs.  @var{outer_code} is the code of
2501 the immediately enclosing expression (@code{MEM} for the top level of an
2502 address, @code{ADDRESS} for something that occurs in an
2503 @code{address_operand}).  @var{index_code} is the code of the corresponding
2504 index expression if @var{outer_code} is @code{PLUS}; @code{SCRATCH} otherwise.
2505 @end defmac
2506
2507 @defmac INDEX_REG_CLASS
2508 A macro whose definition is the name of the class to which a valid
2509 index register must belong.  An index register is one used in an
2510 address where its value is either multiplied by a scale factor or
2511 added to another register (as well as added to a displacement).
2512 @end defmac
2513
2514 @defmac REGNO_OK_FOR_BASE_P (@var{num})
2515 A C expression which is nonzero if register number @var{num} is
2516 suitable for use as a base register in operand addresses.
2517 Like @code{TARGET_LEGITIMATE_ADDRESS_P}, this macro should also
2518 define a strict and a non-strict variant.  Both variants behave
2519 the same for hard register; for pseudos, the strict variant will
2520 pass only those that have been allocated to a valid hard registers,
2521 while the non-strict variant will pass all pseudos.
2522
2523 @findex REG_OK_STRICT
2524 Compiler source files that want to use the strict variant of this and
2525 other macros define the macro @code{REG_OK_STRICT}.  You should use an
2526 @code{#ifdef REG_OK_STRICT} conditional to define the strict variant in
2527 that case and the non-strict variant otherwise.
2528 @end defmac
2529
2530 @defmac REGNO_MODE_OK_FOR_BASE_P (@var{num}, @var{mode})
2531 A C expression that is just like @code{REGNO_OK_FOR_BASE_P}, except that
2532 that expression may examine the mode of the memory reference in
2533 @var{mode}.  You should define this macro if the mode of the memory
2534 reference affects whether a register may be used as a base register.  If
2535 you define this macro, the compiler will use it instead of
2536 @code{REGNO_OK_FOR_BASE_P}.  The mode may be @code{VOIDmode} for
2537 addresses that appear outside a @code{MEM}, i.e., as an
2538 @code{address_operand}.
2539
2540 This macro also has strict and non-strict variants.
2541 @end defmac
2542
2543 @defmac REGNO_MODE_OK_FOR_REG_BASE_P (@var{num}, @var{mode})
2544 A C expression which is nonzero if register number @var{num} is suitable for
2545 use as a base register in base plus index operand addresses, accessing
2546 memory in mode @var{mode}.  It may be either a suitable hard register or a
2547 pseudo register that has been allocated such a hard register.  You should
2548 define this macro if base plus index addresses have different requirements
2549 than other base register uses.
2550
2551 Use of this macro is deprecated; please use the more general
2552 @code{REGNO_MODE_CODE_OK_FOR_BASE_P}.
2553
2554 This macro also has strict and non-strict variants.
2555 @end defmac
2556
2557 @defmac REGNO_MODE_CODE_OK_FOR_BASE_P (@var{num}, @var{mode}, @var{outer_code}, @var{index_code})
2558 A C expression that is just like @code{REGNO_MODE_OK_FOR_BASE_P}, except
2559 that that expression may examine the context in which the register
2560 appears in the memory reference.  @var{outer_code} is the code of the
2561 immediately enclosing expression (@code{MEM} if at the top level of the
2562 address, @code{ADDRESS} for something that occurs in an
2563 @code{address_operand}).  @var{index_code} is the code of the
2564 corresponding index expression if @var{outer_code} is @code{PLUS};
2565 @code{SCRATCH} otherwise.  The mode may be @code{VOIDmode} for addresses
2566 that appear outside a @code{MEM}, i.e., as an @code{address_operand}.
2567
2568 This macro also has strict and non-strict variants.
2569 @end defmac
2570
2571 @defmac REGNO_OK_FOR_INDEX_P (@var{num})
2572 A C expression which is nonzero if register number @var{num} is
2573 suitable for use as an index register in operand addresses.  It may be
2574 either a suitable hard register or a pseudo register that has been
2575 allocated such a hard register.
2576
2577 The difference between an index register and a base register is that
2578 the index register may be scaled.  If an address involves the sum of
2579 two registers, neither one of them scaled, then either one may be
2580 labeled the ``base'' and the other the ``index''; but whichever
2581 labeling is used must fit the machine's constraints of which registers
2582 may serve in each capacity.  The compiler will try both labelings,
2583 looking for one that is valid, and will reload one or both registers
2584 only if neither labeling works.
2585
2586 This macro also has strict and non-strict variants.
2587 @end defmac
2588
2589 @defmac PREFERRED_RELOAD_CLASS (@var{x}, @var{class})
2590 A C expression that places additional restrictions on the register class
2591 to use when it is necessary to copy value @var{x} into a register in class
2592 @var{class}.  The value is a register class; perhaps @var{class}, or perhaps
2593 another, smaller class.  On many machines, the following definition is
2594 safe:
2595
2596 @smallexample
2597 #define PREFERRED_RELOAD_CLASS(X,CLASS) CLASS
2598 @end smallexample
2599
2600 Sometimes returning a more restrictive class makes better code.  For
2601 example, on the 68000, when @var{x} is an integer constant that is in range
2602 for a @samp{moveq} instruction, the value of this macro is always
2603 @code{DATA_REGS} as long as @var{class} includes the data registers.
2604 Requiring a data register guarantees that a @samp{moveq} will be used.
2605
2606 One case where @code{PREFERRED_RELOAD_CLASS} must not return
2607 @var{class} is if @var{x} is a legitimate constant which cannot be
2608 loaded into some register class.  By returning @code{NO_REGS} you can
2609 force @var{x} into a memory location.  For example, rs6000 can load
2610 immediate values into general-purpose registers, but does not have an
2611 instruction for loading an immediate value into a floating-point
2612 register, so @code{PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when
2613 @var{x} is a floating-point constant.  If the constant can't be loaded
2614 into any kind of register, code generation will be better if
2615 @code{LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead
2616 of using @code{PREFERRED_RELOAD_CLASS}.
2617
2618 If an insn has pseudos in it after register allocation, reload will go
2619 through the alternatives and call repeatedly @code{PREFERRED_RELOAD_CLASS}
2620 to find the best one.  Returning @code{NO_REGS}, in this case, makes
2621 reload add a @code{!} in front of the constraint: the x86 back-end uses
2622 this feature to discourage usage of 387 registers when math is done in
2623 the SSE registers (and vice versa).
2624 @end defmac
2625
2626 @defmac PREFERRED_OUTPUT_RELOAD_CLASS (@var{x}, @var{class})
2627 Like @code{PREFERRED_RELOAD_CLASS}, but for output reloads instead of
2628 input reloads.  If you don't define this macro, the default is to use
2629 @var{class}, unchanged.
2630
2631 You can also use @code{PREFERRED_OUTPUT_RELOAD_CLASS} to discourage
2632 reload from using some alternatives, like @code{PREFERRED_RELOAD_CLASS}.
2633 @end defmac
2634
2635 @defmac LIMIT_RELOAD_CLASS (@var{mode}, @var{class})
2636 A C expression that places additional restrictions on the register class
2637 to use when it is necessary to be able to hold a value of mode
2638 @var{mode} in a reload register for which class @var{class} would
2639 ordinarily be used.
2640
2641 Unlike @code{PREFERRED_RELOAD_CLASS}, this macro should be used when
2642 there are certain modes that simply can't go in certain reload classes.
2643
2644 The value is a register class; perhaps @var{class}, or perhaps another,
2645 smaller class.
2646
2647 Don't define this macro unless the target machine has limitations which
2648 require the macro to do something nontrivial.
2649 @end defmac
2650
2651 @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})
2652 Many machines have some registers that cannot be copied directly to or
2653 from memory or even from other types of registers.  An example is the
2654 @samp{MQ} register, which on most machines, can only be copied to or
2655 from general registers, but not memory.  Below, we shall be using the
2656 term 'intermediate register' when a move operation cannot be performed
2657 directly, but has to be done by copying the source into the intermediate
2658 register first, and then copying the intermediate register to the
2659 destination.  An intermediate register always has the same mode as
2660 source and destination.  Since it holds the actual value being copied,
2661 reload might apply optimizations to re-use an intermediate register
2662 and eliding the copy from the source when it can determine that the
2663 intermediate register still holds the required value.
2664
2665 Another kind of secondary reload is required on some machines which
2666 allow copying all registers to and from memory, but require a scratch
2667 register for stores to some memory locations (e.g., those with symbolic
2668 address on the RT, and those with certain symbolic address on the SPARC
2669 when compiling PIC)@.  Scratch registers need not have the same mode
2670 as the value being copied, and usually hold a different value than
2671 that being copied.  Special patterns in the md file are needed to
2672 describe how the copy is performed with the help of the scratch register;
2673 these patterns also describe the number, register class(es) and mode(s)
2674 of the scratch register(s).
2675
2676 In some cases, both an intermediate and a scratch register are required.
2677
2678 For input reloads, this target hook is called with nonzero @var{in_p},
2679 and @var{x} is an rtx that needs to be copied to a register of class
2680 @var{reload_class} in @var{reload_mode}.  For output reloads, this target
2681 hook is called with zero @var{in_p}, and a register of class @var{reload_class}
2682 needs to be copied to rtx @var{x} in @var{reload_mode}.
2683
2684 If copying a register of @var{reload_class} from/to @var{x} requires
2685 an intermediate register, the hook @code{secondary_reload} should
2686 return the register class required for this intermediate register.
2687 If no intermediate register is required, it should return NO_REGS.
2688 If more than one intermediate register is required, describe the one
2689 that is closest in the copy chain to the reload register.
2690
2691 If scratch registers are needed, you also have to describe how to
2692 perform the copy from/to the reload register to/from this
2693 closest intermediate register.  Or if no intermediate register is
2694 required, but still a scratch register is needed, describe the
2695 copy  from/to the reload register to/from the reload operand @var{x}.
2696
2697 You do this by setting @code{sri->icode} to the instruction code of a pattern
2698 in the md file which performs the move.  Operands 0 and 1 are the output
2699 and input of this copy, respectively.  Operands from operand 2 onward are
2700 for scratch operands.  These scratch operands must have a mode, and a
2701 single-register-class
2702 @c [later: or memory]
2703 output constraint.
2704
2705 When an intermediate register is used, the @code{secondary_reload}
2706 hook will be called again to determine how to copy the intermediate
2707 register to/from the reload operand @var{x}, so your hook must also
2708 have code to handle the register class of the intermediate operand.
2709
2710 @c [For later: maybe we'll allow multi-alternative reload patterns -
2711 @c   the port maintainer could name a mov<mode> pattern that has clobbers -
2712 @c   and match the constraints of input and output to determine the required
2713 @c   alternative.  A restriction would be that constraints used to match
2714 @c   against reloads registers would have to be written as register class
2715 @c   constraints, or we need a new target macro / hook that tells us if an
2716 @c   arbitrary constraint can match an unknown register of a given class.
2717 @c   Such a macro / hook would also be useful in other places.]
2718
2719
2720 @var{x} might be a pseudo-register or a @code{subreg} of a
2721 pseudo-register, which could either be in a hard register or in memory.
2722 Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is
2723 in memory and the hard register number if it is in a register.
2724
2725 Scratch operands in memory (constraint @code{"=m"} / @code{"=&m"}) are
2726 currently not supported.  For the time being, you will have to continue
2727 to use @code{SECONDARY_MEMORY_NEEDED} for that purpose.
2728
2729 @code{copy_cost} also uses this target hook to find out how values are
2730 copied.  If you want it to include some extra cost for the need to allocate
2731 (a) scratch register(s), set @code{sri->extra_cost} to the additional cost.
2732 Or if two dependent moves are supposed to have a lower cost than the sum
2733 of the individual moves due to expected fortuitous scheduling and/or special
2734 forwarding logic, you can set @code{sri->extra_cost} to a negative amount.
2735 @end deftypefn
2736
2737 @defmac SECONDARY_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2738 @defmacx SECONDARY_INPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2739 @defmacx SECONDARY_OUTPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2740 These macros are obsolete, new ports should use the target hook
2741 @code{TARGET_SECONDARY_RELOAD} instead.
2742
2743 These are obsolete macros, replaced by the @code{TARGET_SECONDARY_RELOAD}
2744 target hook.  Older ports still define these macros to indicate to the
2745 reload phase that it may
2746 need to allocate at least one register for a reload in addition to the
2747 register to contain the data.  Specifically, if copying @var{x} to a
2748 register @var{class} in @var{mode} requires an intermediate register,
2749 you were supposed to define @code{SECONDARY_INPUT_RELOAD_CLASS} to return the
2750 largest register class all of whose registers can be used as
2751 intermediate registers or scratch registers.
2752
2753 If copying a register @var{class} in @var{mode} to @var{x} requires an
2754 intermediate or scratch register, @code{SECONDARY_OUTPUT_RELOAD_CLASS}
2755 was supposed to be defined be defined to return the largest register
2756 class required.  If the
2757 requirements for input and output reloads were the same, the macro
2758 @code{SECONDARY_RELOAD_CLASS} should have been used instead of defining both
2759 macros identically.
2760
2761 The values returned by these macros are often @code{GENERAL_REGS}.
2762 Return @code{NO_REGS} if no spare register is needed; i.e., if @var{x}
2763 can be directly copied to or from a register of @var{class} in
2764 @var{mode} without requiring a scratch register.  Do not define this
2765 macro if it would always return @code{NO_REGS}.
2766
2767 If a scratch register is required (either with or without an
2768 intermediate register), you were supposed to define patterns for
2769 @samp{reload_in@var{m}} or @samp{reload_out@var{m}}, as required
2770 (@pxref{Standard Names}.  These patterns, which were normally
2771 implemented with a @code{define_expand}, should be similar to the
2772 @samp{mov@var{m}} patterns, except that operand 2 is the scratch
2773 register.
2774
2775 These patterns need constraints for the reload register and scratch
2776 register that
2777 contain a single register class.  If the original reload register (whose
2778 class is @var{class}) can meet the constraint given in the pattern, the
2779 value returned by these macros is used for the class of the scratch
2780 register.  Otherwise, two additional reload registers are required.
2781 Their classes are obtained from the constraints in the insn pattern.
2782
2783 @var{x} might be a pseudo-register or a @code{subreg} of a
2784 pseudo-register, which could either be in a hard register or in memory.
2785 Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is
2786 in memory and the hard register number if it is in a register.
2787
2788 These macros should not be used in the case where a particular class of
2789 registers can only be copied to memory and not to another class of
2790 registers.  In that case, secondary reload registers are not needed and
2791 would not be helpful.  Instead, a stack location must be used to perform
2792 the copy and the @code{mov@var{m}} pattern should use memory as an
2793 intermediate storage.  This case often occurs between floating-point and
2794 general registers.
2795 @end defmac
2796
2797 @defmac SECONDARY_MEMORY_NEEDED (@var{class1}, @var{class2}, @var{m})
2798 Certain machines have the property that some registers cannot be copied
2799 to some other registers without using memory.  Define this macro on
2800 those machines to be a C expression that is nonzero if objects of mode
2801 @var{m} in registers of @var{class1} can only be copied to registers of
2802 class @var{class2} by storing a register of @var{class1} into memory
2803 and loading that memory location into a register of @var{class2}.
2804
2805 Do not define this macro if its value would always be zero.
2806 @end defmac
2807
2808 @defmac SECONDARY_MEMORY_NEEDED_RTX (@var{mode})
2809 Normally when @code{SECONDARY_MEMORY_NEEDED} is defined, the compiler
2810 allocates a stack slot for a memory location needed for register copies.
2811 If this macro is defined, the compiler instead uses the memory location
2812 defined by this macro.
2813
2814 Do not define this macro if you do not define
2815 @code{SECONDARY_MEMORY_NEEDED}.
2816 @end defmac
2817
2818 @defmac SECONDARY_MEMORY_NEEDED_MODE (@var{mode})
2819 When the compiler needs a secondary memory location to copy between two
2820 registers of mode @var{mode}, it normally allocates sufficient memory to
2821 hold a quantity of @code{BITS_PER_WORD} bits and performs the store and
2822 load operations in a mode that many bits wide and whose class is the
2823 same as that of @var{mode}.
2824
2825 This is right thing to do on most machines because it ensures that all
2826 bits of the register are copied and prevents accesses to the registers
2827 in a narrower mode, which some machines prohibit for floating-point
2828 registers.
2829
2830 However, this default behavior is not correct on some machines, such as
2831 the DEC Alpha, that store short integers in floating-point registers
2832 differently than in integer registers.  On those machines, the default
2833 widening will not work correctly and you must define this macro to
2834 suppress that widening in some cases.  See the file @file{alpha.h} for
2835 details.
2836
2837 Do not define this macro if you do not define
2838 @code{SECONDARY_MEMORY_NEEDED} or if widening @var{mode} to a mode that
2839 is @code{BITS_PER_WORD} bits wide is correct for your machine.
2840 @end defmac
2841
2842 @defmac SMALL_REGISTER_CLASSES
2843 On some machines, it is risky to let hard registers live across arbitrary
2844 insns.  Typically, these machines have instructions that require values
2845 to be in specific registers (like an accumulator), and reload will fail
2846 if the required hard register is used for another purpose across such an
2847 insn.
2848
2849 Define @code{SMALL_REGISTER_CLASSES} to be an expression with a nonzero
2850 value on these machines.  When this macro has a nonzero value, the
2851 compiler will try to minimize the lifetime of hard registers.
2852
2853 It is always safe to define this macro with a nonzero value, but if you
2854 unnecessarily define it, you will reduce the amount of optimizations
2855 that can be performed in some cases.  If you do not define this macro
2856 with a nonzero value when it is required, the compiler will run out of
2857 spill registers and print a fatal error message.  For most machines, you
2858 should not define this macro at all.
2859 @end defmac
2860
2861 @defmac CLASS_LIKELY_SPILLED_P (@var{class})
2862 A C expression whose value is nonzero if pseudos that have been assigned
2863 to registers of class @var{class} would likely be spilled because
2864 registers of @var{class} are needed for spill registers.
2865
2866 The default value of this macro returns 1 if @var{class} has exactly one
2867 register and zero otherwise.  On most machines, this default should be
2868 used.  Only define this macro to some other expression if pseudos
2869 allocated by @file{local-alloc.c} end up in memory because their hard
2870 registers were needed for spill registers.  If this macro returns nonzero
2871 for those classes, those pseudos will only be allocated by
2872 @file{global.c}, which knows how to reallocate the pseudo to another
2873 register.  If there would not be another register available for
2874 reallocation, you should not change the definition of this macro since
2875 the only effect of such a definition would be to slow down register
2876 allocation.
2877 @end defmac
2878
2879 @defmac CLASS_MAX_NREGS (@var{class}, @var{mode})
2880 A C expression for the maximum number of consecutive registers
2881 of class @var{class} needed to hold a value of mode @var{mode}.
2882
2883 This is closely related to the macro @code{HARD_REGNO_NREGS}.  In fact,
2884 the value of the macro @code{CLASS_MAX_NREGS (@var{class}, @var{mode})}
2885 should be the maximum value of @code{HARD_REGNO_NREGS (@var{regno},
2886 @var{mode})} for all @var{regno} values in the class @var{class}.
2887
2888 This macro helps control the handling of multiple-word values
2889 in the reload pass.
2890 @end defmac
2891
2892 @defmac CANNOT_CHANGE_MODE_CLASS (@var{from}, @var{to}, @var{class})
2893 If defined, a C expression that returns nonzero for a @var{class} for which
2894 a change from mode @var{from} to mode @var{to} is invalid.
2895
2896 For the example, loading 32-bit integer or floating-point objects into
2897 floating-point registers on the Alpha extends them to 64 bits.
2898 Therefore loading a 64-bit object and then storing it as a 32-bit object
2899 does not store the low-order 32 bits, as would be the case for a normal
2900 register.  Therefore, @file{alpha.h} defines @code{CANNOT_CHANGE_MODE_CLASS}
2901 as below:
2902
2903 @smallexample
2904 #define CANNOT_CHANGE_MODE_CLASS(FROM, TO, CLASS) \
2905   (GET_MODE_SIZE (FROM) != GET_MODE_SIZE (TO) \
2906    ? reg_classes_intersect_p (FLOAT_REGS, (CLASS)) : 0)
2907 @end smallexample
2908 @end defmac
2909
2910 @deftypefn {Target Hook} {const enum reg_class *} TARGET_IRA_COVER_CLASSES ()
2911 Return an array of cover classes for the Integrated Register Allocator
2912 (@acronym{IRA}).  Cover classes are a set of non-intersecting register
2913 classes covering all hard registers used for register allocation
2914 purposes.  If a move between two registers in the same cover class is
2915 possible, it should be cheaper than a load or store of the registers.
2916 The array is terminated by a @code{LIM_REG_CLASSES} element.
2917
2918 The order of cover classes in the array is important.  If two classes
2919 have the same cost of usage for a pseudo, the class occurred first in
2920 the array is chosen for the pseudo.
2921
2922 This hook is called once at compiler startup, after the command-line
2923 options have been processed. It is then re-examined by every call to
2924 @code{target_reinit}.
2925
2926 The default implementation returns @code{IRA_COVER_CLASSES}, if defined,
2927 otherwise there is no default implementation.  You must define either this
2928 macro or @code{IRA_COVER_CLASSES} in order to use the integrated register
2929 allocator with Chaitin-Briggs coloring. If the macro is not defined,
2930 the only available coloring algorithm is Chow's priority coloring.
2931 @end deftypefn
2932
2933 @defmac IRA_COVER_CLASSES
2934 See the documentation for @code{TARGET_IRA_COVER_CLASSES}.
2935 @end defmac
2936
2937 @node Old Constraints
2938 @section Obsolete Macros for Defining Constraints
2939 @cindex defining constraints, obsolete method
2940 @cindex constraints, defining, obsolete method
2941
2942 Machine-specific constraints can be defined with these macros instead
2943 of the machine description constructs described in @ref{Define
2944 Constraints}.  This mechanism is obsolete.  New ports should not use
2945 it; old ports should convert to the new mechanism.
2946
2947 @defmac CONSTRAINT_LEN (@var{char}, @var{str})
2948 For the constraint at the start of @var{str}, which starts with the letter
2949 @var{c}, return the length.  This allows you to have register class /
2950 constant / extra constraints that are longer than a single letter;
2951 you don't need to define this macro if you can do with single-letter
2952 constraints only.  The definition of this macro should use
2953 DEFAULT_CONSTRAINT_LEN for all the characters that you don't want
2954 to handle specially.
2955 There are some sanity checks in genoutput.c that check the constraint lengths
2956 for the md file, so you can also use this macro to help you while you are
2957 transitioning from a byzantine single-letter-constraint scheme: when you
2958 return a negative length for a constraint you want to re-use, genoutput
2959 will complain about every instance where it is used in the md file.
2960 @end defmac
2961
2962 @defmac REG_CLASS_FROM_LETTER (@var{char})
2963 A C expression which defines the machine-dependent operand constraint
2964 letters for register classes.  If @var{char} is such a letter, the
2965 value should be the register class corresponding to it.  Otherwise,
2966 the value should be @code{NO_REGS}.  The register letter @samp{r},
2967 corresponding to class @code{GENERAL_REGS}, will not be passed
2968 to this macro; you do not need to handle it.
2969 @end defmac
2970
2971 @defmac REG_CLASS_FROM_CONSTRAINT (@var{char}, @var{str})
2972 Like @code{REG_CLASS_FROM_LETTER}, but you also get the constraint string
2973 passed in @var{str}, so that you can use suffixes to distinguish between
2974 different variants.
2975 @end defmac
2976
2977 @defmac CONST_OK_FOR_LETTER_P (@var{value}, @var{c})
2978 A C expression that defines the machine-dependent operand constraint
2979 letters (@samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}) that specify
2980 particular ranges of integer values.  If @var{c} is one of those
2981 letters, the expression should check that @var{value}, an integer, is in
2982 the appropriate range and return 1 if so, 0 otherwise.  If @var{c} is
2983 not one of those letters, the value should be 0 regardless of
2984 @var{value}.
2985 @end defmac
2986
2987 @defmac CONST_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str})
2988 Like @code{CONST_OK_FOR_LETTER_P}, but you also get the constraint
2989 string passed in @var{str}, so that you can use suffixes to distinguish
2990 between different variants.
2991 @end defmac
2992
2993 @defmac CONST_DOUBLE_OK_FOR_LETTER_P (@var{value}, @var{c})
2994 A C expression that defines the machine-dependent operand constraint
2995 letters that specify particular ranges of @code{const_double} values
2996 (@samp{G} or @samp{H}).
2997
2998 If @var{c} is one of those letters, the expression should check that
2999 @var{value}, an RTX of code @code{const_double}, is in the appropriate
3000 range and return 1 if so, 0 otherwise.  If @var{c} is not one of those
3001 letters, the value should be 0 regardless of @var{value}.
3002
3003 @code{const_double} is used for all floating-point constants and for
3004 @code{DImode} fixed-point constants.  A given letter can accept either
3005 or both kinds of values.  It can use @code{GET_MODE} to distinguish
3006 between these kinds.
3007 @end defmac
3008
3009 @defmac CONST_DOUBLE_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str})
3010 Like @code{CONST_DOUBLE_OK_FOR_LETTER_P}, but you also get the constraint
3011 string passed in @var{str}, so that you can use suffixes to distinguish
3012 between different variants.
3013 @end defmac
3014
3015 @defmac EXTRA_CONSTRAINT (@var{value}, @var{c})
3016 A C expression that defines the optional machine-dependent constraint
3017 letters that can be used to segregate specific types of operands, usually
3018 memory references, for the target machine.  Any letter that is not
3019 elsewhere defined and not matched by @code{REG_CLASS_FROM_LETTER} /
3020 @code{REG_CLASS_FROM_CONSTRAINT}
3021 may be used.  Normally this macro will not be defined.
3022
3023 If it is required for a particular target machine, it should return 1
3024 if @var{value} corresponds to the operand type represented by the
3025 constraint letter @var{c}.  If @var{c} is not defined as an extra
3026 constraint, the value returned should be 0 regardless of @var{value}.
3027
3028 For example, on the ROMP, load instructions cannot have their output
3029 in r0 if the memory reference contains a symbolic address.  Constraint
3030 letter @samp{Q} is defined as representing a memory address that does
3031 @emph{not} contain a symbolic address.  An alternative is specified with
3032 a @samp{Q} constraint on the input and @samp{r} on the output.  The next
3033 alternative specifies @samp{m} on the input and a register class that
3034 does not include r0 on the output.
3035 @end defmac
3036
3037 @defmac EXTRA_CONSTRAINT_STR (@var{value}, @var{c}, @var{str})
3038 Like @code{EXTRA_CONSTRAINT}, but you also get the constraint string passed
3039 in @var{str}, so that you can use suffixes to distinguish between different
3040 variants.
3041 @end defmac
3042
3043 @defmac EXTRA_MEMORY_CONSTRAINT (@var{c}, @var{str})
3044 A C expression that defines the optional machine-dependent constraint
3045 letters, amongst those accepted by @code{EXTRA_CONSTRAINT}, that should
3046 be treated like memory constraints by the reload pass.
3047
3048 It should return 1 if the operand type represented by the constraint
3049 at the start of @var{str}, the first letter of which is the letter @var{c},
3050 comprises a subset of all memory references including
3051 all those whose address is simply a base register.  This allows the reload
3052 pass to reload an operand, if it does not directly correspond to the operand
3053 type of @var{c}, by copying its address into a base register.
3054
3055 For example, on the S/390, some instructions do not accept arbitrary
3056 memory references, but only those that do not make use of an index
3057 register.  The constraint letter @samp{Q} is defined via
3058 @code{EXTRA_CONSTRAINT} as representing a memory address of this type.
3059 If the letter @samp{Q} is marked as @code{EXTRA_MEMORY_CONSTRAINT},
3060 a @samp{Q} constraint can handle any memory operand, because the
3061 reload pass knows it can be reloaded by copying the memory address
3062 into a base register if required.  This is analogous to the way
3063 an @samp{o} constraint can handle any memory operand.
3064 @end defmac
3065
3066 @defmac EXTRA_ADDRESS_CONSTRAINT (@var{c}, @var{str})
3067 A C expression that defines the optional machine-dependent constraint
3068 letters, amongst those accepted by @code{EXTRA_CONSTRAINT} /
3069 @code{EXTRA_CONSTRAINT_STR}, that should
3070 be treated like address constraints by the reload pass.
3071
3072 It should return 1 if the operand type represented by the constraint
3073 at the start of @var{str}, which starts with the letter @var{c}, comprises
3074 a subset of all memory addresses including
3075 all those that consist of just a base register.  This allows the reload
3076 pass to reload an operand, if it does not directly correspond to the operand
3077 type of @var{str}, by copying it into a base register.
3078
3079 Any constraint marked as @code{EXTRA_ADDRESS_CONSTRAINT} can only
3080 be used with the @code{address_operand} predicate.  It is treated
3081 analogously to the @samp{p} constraint.
3082 @end defmac
3083
3084 @node Stack and Calling
3085 @section Stack Layout and Calling Conventions
3086 @cindex calling conventions
3087
3088 @c prevent bad page break with this line
3089 This describes the stack layout and calling conventions.
3090
3091 @menu
3092 * Frame Layout::
3093 * Exception Handling::
3094 * Stack Checking::
3095 * Frame Registers::
3096 * Elimination::
3097 * Stack Arguments::
3098 * Register Arguments::
3099 * Scalar Return::
3100 * Aggregate Return::
3101 * Caller Saves::
3102 * Function Entry::
3103 * Profiling::
3104 * Tail Calls::
3105 * Stack Smashing Protection::
3106 @end menu
3107
3108 @node Frame Layout
3109 @subsection Basic Stack Layout
3110 @cindex stack frame layout
3111 @cindex frame layout
3112
3113 @c prevent bad page break with this line
3114 Here is the basic stack layout.
3115
3116 @defmac STACK_GROWS_DOWNWARD
3117 Define this macro if pushing a word onto the stack moves the stack
3118 pointer to a smaller address.
3119
3120 When we say, ``define this macro if @dots{}'', it means that the
3121 compiler checks this macro only with @code{#ifdef} so the precise
3122 definition used does not matter.
3123 @end defmac
3124
3125 @defmac STACK_PUSH_CODE
3126 This macro defines the operation used when something is pushed
3127 on the stack.  In RTL, a push operation will be
3128 @code{(set (mem (STACK_PUSH_CODE (reg sp))) @dots{})}
3129
3130 The choices are @code{PRE_DEC}, @code{POST_DEC}, @code{PRE_INC},
3131 and @code{POST_INC}.  Which of these is correct depends on
3132 the stack direction and on whether the stack pointer points
3133 to the last item on the stack or whether it points to the
3134 space for the next item on the stack.
3135
3136 The default is @code{PRE_DEC} when @code{STACK_GROWS_DOWNWARD} is
3137 defined, which is almost always right, and @code{PRE_INC} otherwise,
3138 which is often wrong.
3139 @end defmac
3140
3141 @defmac FRAME_GROWS_DOWNWARD
3142 Define this macro to nonzero value if the addresses of local variable slots
3143 are at negative offsets from the frame pointer.
3144 @end defmac
3145
3146 @defmac ARGS_GROW_DOWNWARD
3147 Define this macro if successive arguments to a function occupy decreasing
3148 addresses on the stack.
3149 @end defmac
3150
3151 @defmac STARTING_FRAME_OFFSET
3152 Offset from the frame pointer to the first local variable slot to be allocated.
3153
3154 If @code{FRAME_GROWS_DOWNWARD}, find the next slot's offset by
3155 subtracting the first slot's length from @code{STARTING_FRAME_OFFSET}.
3156 Otherwise, it is found by adding the length of the first slot to the
3157 value @code{STARTING_FRAME_OFFSET}.
3158 @c i'm not sure if the above is still correct.. had to change it to get
3159 @c rid of an overfull.  --mew 2feb93
3160 @end defmac
3161
3162 @defmac STACK_ALIGNMENT_NEEDED
3163 Define to zero to disable final alignment of the stack during reload.
3164 The nonzero default for this macro is suitable for most ports.
3165
3166 On ports where @code{STARTING_FRAME_OFFSET} is nonzero or where there
3167 is a register save block following the local block that doesn't require
3168 alignment to @code{STACK_BOUNDARY}, it may be beneficial to disable
3169 stack alignment and do it in the backend.
3170 @end defmac
3171
3172 @defmac STACK_POINTER_OFFSET
3173 Offset from the stack pointer register to the first location at which
3174 outgoing arguments are placed.  If not specified, the default value of
3175 zero is used.  This is the proper value for most machines.
3176
3177 If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above
3178 the first location at which outgoing arguments are placed.
3179 @end defmac
3180
3181 @defmac FIRST_PARM_OFFSET (@var{fundecl})
3182 Offset from the argument pointer register to the first argument's
3183 address.  On some machines it may depend on the data type of the
3184 function.
3185
3186 If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above
3187 the first argument's address.
3188 @end defmac
3189
3190 @defmac STACK_DYNAMIC_OFFSET (@var{fundecl})
3191 Offset from the stack pointer register to an item dynamically allocated
3192 on the stack, e.g., by @code{alloca}.
3193
3194 The default value for this macro is @code{STACK_POINTER_OFFSET} plus the
3195 length of the outgoing arguments.  The default is correct for most
3196 machines.  See @file{function.c} for details.
3197 @end defmac
3198
3199 @defmac INITIAL_FRAME_ADDRESS_RTX
3200 A C expression whose value is RTL representing the address of the initial
3201 stack frame. This address is passed to @code{RETURN_ADDR_RTX} and
3202 @code{DYNAMIC_CHAIN_ADDRESS}.  If you don't define this macro, a reasonable
3203 default value will be used.  Define this macro in order to make frame pointer
3204 elimination work in the presence of @code{__builtin_frame_address (count)} and
3205 @code{__builtin_return_address (count)} for @code{count} not equal to zero.
3206 @end defmac
3207
3208 @defmac DYNAMIC_CHAIN_ADDRESS (@var{frameaddr})
3209 A C expression whose value is RTL representing the address in a stack
3210 frame where the pointer to the caller's frame is stored.  Assume that
3211 @var{frameaddr} is an RTL expression for the address of the stack frame
3212 itself.
3213
3214 If you don't define this macro, the default is to return the value
3215 of @var{frameaddr}---that is, the stack frame address is also the
3216 address of the stack word that points to the previous frame.
3217 @end defmac
3218
3219 @defmac SETUP_FRAME_ADDRESSES
3220 If defined, a C expression that produces the machine-specific code to
3221 setup the stack so that arbitrary frames can be accessed.  For example,
3222 on the SPARC, we must flush all of the register windows to the stack
3223 before we can access arbitrary stack frames.  You will seldom need to
3224 define this macro.
3225 @end defmac
3226
3227 @deftypefn {Target Hook} bool TARGET_BUILTIN_SETJMP_FRAME_VALUE ()
3228 This target hook should return an rtx that is used to store
3229 the address of the current frame into the built in @code{setjmp} buffer.
3230 The default value, @code{virtual_stack_vars_rtx}, is correct for most
3231 machines.  One reason you may need to define this target hook is if
3232 @code{hard_frame_pointer_rtx} is the appropriate value on your machine.
3233 @end deftypefn
3234
3235 @defmac FRAME_ADDR_RTX (@var{frameaddr})
3236 A C expression whose value is RTL representing the value of the frame
3237 address for the current frame.  @var{frameaddr} is the frame pointer
3238 of the current frame.  This is used for __builtin_frame_address.
3239 You need only define this macro if the frame address is not the same
3240 as the frame pointer.  Most machines do not need to define it.
3241 @end defmac
3242
3243 @defmac RETURN_ADDR_RTX (@var{count}, @var{frameaddr})
3244 A C expression whose value is RTL representing the value of the return
3245 address for the frame @var{count} steps up from the current frame, after
3246 the prologue.  @var{frameaddr} is the frame pointer of the @var{count}
3247 frame, or the frame pointer of the @var{count} @minus{} 1 frame if
3248 @code{RETURN_ADDR_IN_PREVIOUS_FRAME} is defined.
3249
3250 The value of the expression must always be the correct address when
3251 @var{count} is zero, but may be @code{NULL_RTX} if there is no way to
3252 determine the return address of other frames.
3253 @end defmac
3254
3255 @defmac RETURN_ADDR_IN_PREVIOUS_FRAME
3256 Define this if the return address of a particular stack frame is accessed
3257 from the frame pointer of the previous stack frame.
3258 @end defmac
3259
3260 @defmac INCOMING_RETURN_ADDR_RTX
3261 A C expression whose value is RTL representing the location of the
3262 incoming return address at the beginning of any function, before the
3263 prologue.  This RTL is either a @code{REG}, indicating that the return
3264 value is saved in @samp{REG}, or a @code{MEM} representing a location in
3265 the stack.
3266
3267 You only need to define this macro if you want to support call frame
3268 debugging information like that provided by DWARF 2.
3269
3270 If this RTL is a @code{REG}, you should also define
3271 @code{DWARF_FRAME_RETURN_COLUMN} to @code{DWARF_FRAME_REGNUM (REGNO)}.
3272 @end defmac
3273
3274 @defmac DWARF_ALT_FRAME_RETURN_COLUMN
3275 A C expression whose value is an integer giving a DWARF 2 column
3276 number that may be used as an alternative return column.  The column
3277 must not correspond to any gcc hard register (that is, it must not
3278 be in the range of @code{DWARF_FRAME_REGNUM}).
3279
3280 This macro can be useful if @code{DWARF_FRAME_RETURN_COLUMN} is set to a
3281 general register, but an alternative column needs to be used for signal
3282 frames.  Some targets have also used different frame return columns
3283 over time.
3284 @end defmac
3285
3286 @defmac DWARF_ZERO_REG
3287 A C expression whose value is an integer giving a DWARF 2 register
3288 number that is considered to always have the value zero.  This should
3289 only be defined if the target has an architected zero register, and
3290 someone decided it was a good idea to use that register number to
3291 terminate the stack backtrace.  New ports should avoid this.
3292 @end defmac
3293
3294 @deftypefn {Target Hook} void TARGET_DWARF_HANDLE_FRAME_UNSPEC (const char *@var{label}, rtx @var{pattern}, int @var{index})
3295 This target hook allows the backend to emit frame-related insns that
3296 contain UNSPECs or UNSPEC_VOLATILEs.  The DWARF 2 call frame debugging
3297 info engine will invoke it on insns of the form
3298 @smallexample
3299 (set (reg) (unspec [@dots{}] UNSPEC_INDEX))
3300 @end smallexample
3301 and
3302 @smallexample
3303 (set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).
3304 @end smallexample
3305 to let the backend emit the call frame instructions.  @var{label} is
3306 the CFI label attached to the insn, @var{pattern} is the pattern of
3307 the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.
3308 @end deftypefn
3309
3310 @defmac INCOMING_FRAME_SP_OFFSET
3311 A C expression whose value is an integer giving the offset, in bytes,
3312 from the value of the stack pointer register to the top of the stack
3313 frame at the beginning of any function, before the prologue.  The top of
3314 the frame is defined to be the value of the stack pointer in the
3315 previous frame, just before the call instruction.
3316
3317 You only need to define this macro if you want to support call frame
3318 debugging information like that provided by DWARF 2.
3319 @end defmac
3320
3321 @defmac ARG_POINTER_CFA_OFFSET (@var{fundecl})
3322 A C expression whose value is an integer giving the offset, in bytes,
3323 from the argument pointer to the canonical frame address (cfa).  The
3324 final value should coincide with that calculated by
3325 @code{INCOMING_FRAME_SP_OFFSET}.  Which is unfortunately not usable
3326 during virtual register instantiation.
3327
3328 The default value for this macro is @code{FIRST_PARM_OFFSET (fundecl)},
3329 which is correct for most machines; in general, the arguments are found
3330 immediately before the stack frame.  Note that this is not the case on
3331 some targets that save registers into the caller's frame, such as SPARC
3332 and rs6000, and so such targets need to define this macro.
3333
3334 You only need to define this macro if the default is incorrect, and you
3335 want to support call frame debugging information like that provided by
3336 DWARF 2.
3337 @end defmac
3338
3339 @defmac FRAME_POINTER_CFA_OFFSET (@var{fundecl})
3340 If defined, a C expression whose value is an integer giving the offset
3341 in bytes from the frame pointer to the canonical frame address (cfa).
3342 The final value should coincide with that calculated by
3343 @code{INCOMING_FRAME_SP_OFFSET}.
3344
3345 Normally the CFA is calculated as an offset from the argument pointer,
3346 via @code{ARG_POINTER_CFA_OFFSET}, but if the argument pointer is
3347 variable due to the ABI, this may not be possible.  If this macro is
3348 defined, it implies that the virtual register instantiation should be
3349 based on the frame pointer instead of the argument pointer.  Only one
3350 of @code{FRAME_POINTER_CFA_OFFSET} and @code{ARG_POINTER_CFA_OFFSET}
3351 should be defined.
3352 @end defmac
3353
3354 @defmac CFA_FRAME_BASE_OFFSET (@var{fundecl})
3355 If defined, a C expression whose value is an integer giving the offset
3356 in bytes from the canonical frame address (cfa) to the frame base used
3357 in DWARF 2 debug information.  The default is zero.  A different value
3358 may reduce the size of debug information on some ports.
3359 @end defmac
3360
3361 @node Exception Handling
3362 @subsection Exception Handling Support
3363 @cindex exception handling
3364
3365 @defmac EH_RETURN_DATA_REGNO (@var{N})
3366 A C expression whose value is the @var{N}th register number used for
3367 data by exception handlers, or @code{INVALID_REGNUM} if fewer than
3368 @var{N} registers are usable.
3369
3370 The exception handling library routines communicate with the exception
3371 handlers via a set of agreed upon registers.  Ideally these registers
3372 should be call-clobbered; it is possible to use call-saved registers,
3373 but may negatively impact code size.  The target must support at least
3374 2 data registers, but should define 4 if there are enough free registers.
3375
3376 You must define this macro if you want to support call frame exception
3377 handling like that provided by DWARF 2.
3378 @end defmac
3379
3380 @defmac EH_RETURN_STACKADJ_RTX
3381 A C expression whose value is RTL representing a location in which
3382 to store a stack adjustment to be applied before function return.
3383 This is used to unwind the stack to an exception handler's call frame.
3384 It will be assigned zero on code paths that return normally.
3385
3386 Typically this is a call-clobbered hard register that is otherwise
3387 untouched by the epilogue, but could also be a stack slot.
3388
3389 Do not define this macro if the stack pointer is saved and restored
3390 by the regular prolog and epilog code in the call frame itself; in
3391 this case, the exception handling library routines will update the
3392 stack location to be restored in place.  Otherwise, you must define
3393 this macro if you want to support call frame exception handling like
3394 that provided by DWARF 2.
3395 @end defmac
3396
3397 @defmac EH_RETURN_HANDLER_RTX
3398 A C expression whose value is RTL representing a location in which
3399 to store the address of an exception handler to which we should
3400 return.  It will not be assigned on code paths that return normally.
3401
3402 Typically this is the location in the call frame at which the normal
3403 return address is stored.  For targets that return by popping an
3404 address off the stack, this might be a memory address just below
3405 the @emph{target} call frame rather than inside the current call
3406 frame.  If defined, @code{EH_RETURN_STACKADJ_RTX} will have already
3407 been assigned, so it may be used to calculate the location of the
3408 target call frame.
3409
3410 Some targets have more complex requirements than storing to an
3411 address calculable during initial code generation.  In that case
3412 the @code{eh_return} instruction pattern should be used instead.
3413
3414 If you want to support call frame exception handling, you must
3415 define either this macro or the @code{eh_return} instruction pattern.
3416 @end defmac
3417
3418 @defmac RETURN_ADDR_OFFSET
3419 If defined, an integer-valued C expression for which rtl will be generated
3420 to add it to the exception handler address before it is searched in the
3421 exception handling tables, and to subtract it again from the address before
3422 using it to return to the exception handler.
3423 @end defmac
3424
3425 @defmac ASM_PREFERRED_EH_DATA_FORMAT (@var{code}, @var{global})
3426 This macro chooses the encoding of pointers embedded in the exception
3427 handling sections.  If at all possible, this should be defined such
3428 that the exception handling section will not require dynamic relocations,
3429 and so may be read-only.
3430
3431 @var{code} is 0 for data, 1 for code labels, 2 for function pointers.
3432 @var{global} is true if the symbol may be affected by dynamic relocations.
3433 The macro should return a combination of the @code{DW_EH_PE_*} defines
3434 as found in @file{dwarf2.h}.
3435
3436 If this macro is not defined, pointers will not be encoded but
3437 represented directly.
3438 @end defmac
3439
3440 @defmac ASM_MAYBE_OUTPUT_ENCODED_ADDR_RTX (@var{file}, @var{encoding}, @var{size}, @var{addr}, @var{done})
3441 This macro allows the target to emit whatever special magic is required
3442 to represent the encoding chosen by @code{ASM_PREFERRED_EH_DATA_FORMAT}.
3443 Generic code takes care of pc-relative and indirect encodings; this must
3444 be defined if the target uses text-relative or data-relative encodings.
3445
3446 This is a C statement that branches to @var{done} if the format was
3447 handled.  @var{encoding} is the format chosen, @var{size} is the number
3448 of bytes that the format occupies, @var{addr} is the @code{SYMBOL_REF}
3449 to be emitted.
3450 @end defmac
3451
3452 @defmac MD_UNWIND_SUPPORT
3453 A string specifying a file to be #include'd in unwind-dw2.c.  The file
3454 so included typically defines @code{MD_FALLBACK_FRAME_STATE_FOR}.
3455 @end defmac
3456
3457 @defmac MD_FALLBACK_FRAME_STATE_FOR (@var{context}, @var{fs})
3458 This macro allows the target to add CPU and operating system specific
3459 code to the call-frame unwinder for use when there is no unwind data
3460 available.  The most common reason to implement this macro is to unwind
3461 through signal frames.
3462
3463 This macro is called from @code{uw_frame_state_for} in
3464 @file{unwind-dw2.c}, @file{unwind-dw2-xtensa.c} and
3465 @file{unwind-ia64.c}.  @var{context} is an @code{_Unwind_Context};
3466 @var{fs} is an @code{_Unwind_FrameState}.  Examine @code{context->ra}
3467 for the address of the code being executed and @code{context->cfa} for
3468 the stack pointer value.  If the frame can be decoded, the register
3469 save addresses should be updated in @var{fs} and the macro should
3470 evaluate to @code{_URC_NO_REASON}.  If the frame cannot be decoded,
3471 the macro should evaluate to @code{_URC_END_OF_STACK}.
3472
3473 For proper signal handling in Java this macro is accompanied by
3474 @code{MAKE_THROW_FRAME}, defined in @file{libjava/include/*-signal.h} headers.
3475 @end defmac
3476
3477 @defmac MD_HANDLE_UNWABI (@var{context}, @var{fs})
3478 This macro allows the target to add operating system specific code to the
3479 call-frame unwinder to handle the IA-64 @code{.unwabi} unwinding directive,
3480 usually used for signal or interrupt frames.
3481
3482 This macro is called from @code{uw_update_context} in @file{unwind-ia64.c}.
3483 @var{context} is an @code{_Unwind_Context};
3484 @var{fs} is an @code{_Unwind_FrameState}.  Examine @code{fs->unwabi}
3485 for the abi and context in the @code{.unwabi} directive.  If the
3486 @code{.unwabi} directive can be handled, the register save addresses should
3487 be updated in @var{fs}.
3488 @end defmac
3489
3490 @defmac TARGET_USES_WEAK_UNWIND_INFO
3491 A C expression that evaluates to true if the target requires unwind
3492 info to be given comdat linkage.  Define it to be @code{1} if comdat
3493 linkage is necessary.  The default is @code{0}.
3494 @end defmac
3495
3496 @node Stack Checking
3497 @subsection Specifying How Stack Checking is Done
3498
3499 GCC will check that stack references are within the boundaries of the
3500 stack, if the option @option{-fstack-check} is specified, in one of
3501 three ways:
3502
3503 @enumerate
3504 @item
3505 If the value of the @code{STACK_CHECK_BUILTIN} macro is nonzero, GCC
3506 will assume that you have arranged for full stack checking to be done
3507 at appropriate places in the configuration files.  GCC will not do
3508 other special processing.
3509
3510 @item
3511 If @code{STACK_CHECK_BUILTIN} is zero and the value of the
3512 @code{STACK_CHECK_STATIC_BUILTIN} macro is nonzero, GCC will assume
3513 that you have arranged for static stack checking (checking of the
3514 static stack frame of functions) to be done at appropriate places
3515 in the configuration files.  GCC will only emit code to do dynamic
3516 stack checking (checking on dynamic stack allocations) using the third
3517 approach below.
3518
3519 @item
3520 If neither of the above are true, GCC will generate code to periodically
3521 ``probe'' the stack pointer using the values of the macros defined below.
3522 @end enumerate
3523
3524 If neither STACK_CHECK_BUILTIN nor STACK_CHECK_STATIC_BUILTIN is defined,
3525 GCC will change its allocation strategy for large objects if the option
3526 @option{-fstack-check} is specified: they will always be allocated
3527 dynamically if their size exceeds @code{STACK_CHECK_MAX_VAR_SIZE} bytes.
3528
3529 @defmac STACK_CHECK_BUILTIN
3530 A nonzero value if stack checking is done by the configuration files in a
3531 machine-dependent manner.  You should define this macro if stack checking
3532 is required by the ABI of your machine or if you would like to do stack
3533 checking in some more efficient way than the generic approach.  The default
3534 value of this macro is zero.
3535 @end defmac
3536
3537 @defmac STACK_CHECK_STATIC_BUILTIN
3538 A nonzero value if static stack checking is done by the configuration files
3539 in a machine-dependent manner.  You should define this macro if you would
3540 like to do static stack checking in some more efficient way than the generic
3541 approach.  The default value of this macro is zero.
3542 @end defmac
3543
3544 @defmac STACK_CHECK_PROBE_INTERVAL
3545 An integer representing the interval at which GCC must generate stack
3546 probe instructions.  You will normally define this macro to be no larger
3547 than the size of the ``guard pages'' at the end of a stack area.  The
3548 default value of 4096 is suitable for most systems.
3549 @end defmac
3550
3551 @defmac STACK_CHECK_PROBE_LOAD
3552 An integer which is nonzero if GCC should perform the stack probe
3553 as a load instruction and zero if GCC should use a store instruction.
3554 The default is zero, which is the most efficient choice on most systems.
3555 @end defmac
3556
3557 @defmac STACK_CHECK_PROTECT
3558 The number of bytes of stack needed to recover from a stack overflow,
3559 for languages where such a recovery is supported.  The default value of
3560 75 words should be adequate for most machines.
3561 @end defmac
3562
3563 The following macros are relevant only if neither STACK_CHECK_BUILTIN
3564 nor STACK_CHECK_STATIC_BUILTIN is defined; you can omit them altogether
3565 in the opposite case.
3566
3567 @defmac STACK_CHECK_MAX_FRAME_SIZE
3568 The maximum size of a stack frame, in bytes.  GCC will generate probe
3569 instructions in non-leaf functions to ensure at least this many bytes of
3570 stack are available.  If a stack frame is larger than this size, stack
3571 checking will not be reliable and GCC will issue a warning.  The
3572 default is chosen so that GCC only generates one instruction on most
3573 systems.  You should normally not change the default value of this macro.
3574 @end defmac
3575
3576 @defmac S