OSDN Git Service

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