OSDN Git Service

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