OSDN Git Service

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