1 @c Copyright (C) 1988,1989,1992,1993,1994,1995,1996,1997,1998,1999,2000,2001,
2 @c 2002, 2003 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
7 @chapter Target Description Macros and Functions
8 @cindex machine description macros
9 @cindex target description macros
10 @cindex macros, target description
11 @cindex @file{tm.h} macros
13 In addition to the file @file{@var{machine}.md}, a machine description
14 includes a C header file conventionally given the name
15 @file{@var{machine}.h} and a C source file named @file{@var{machine}.c}.
16 The header file defines numerous macros that convey the information
17 about the target machine that does not fit into the scheme of the
18 @file{.md} file. The file @file{tm.h} should be a link to
19 @file{@var{machine}.h}. The header file @file{config.h} includes
20 @file{tm.h} and most compiler source files include @file{config.h}. The
21 source file defines a variable @code{targetm}, which is a structure
22 containing pointers to functions and data relating to the target
23 machine. @file{@var{machine}.c} should also contain their definitions,
24 if they are not defined elsewhere in GCC, and other functions called
25 through the macros defined in the @file{.h} file.
28 * Target Structure:: The @code{targetm} variable.
29 * Driver:: Controlling how the driver runs the compilation passes.
30 * Run-time Target:: Defining @samp{-m} options like @option{-m68000} and @option{-m68020}.
31 * Per-Function Data:: Defining data structures for per-function information.
32 * Storage Layout:: Defining sizes and alignments of data.
33 * Type Layout:: Defining sizes and properties of basic user data types.
34 * Escape Sequences:: Defining the value of target character escape sequences
35 * Registers:: Naming and describing the hardware registers.
36 * Register Classes:: Defining the classes of hardware registers.
37 * Stack and Calling:: Defining which way the stack grows and by how much.
38 * Varargs:: Defining the varargs macros.
39 * Trampolines:: Code set up at run time to enter a nested function.
40 * Library Calls:: Controlling how library routines are implicitly called.
41 * Addressing Modes:: Defining addressing modes valid for memory operands.
42 * Condition Code:: Defining how insns update the condition code.
43 * Costs:: Defining relative costs of different operations.
44 * Scheduling:: Adjusting the behavior of the instruction scheduler.
45 * Sections:: Dividing storage into text, data, and other sections.
46 * PIC:: Macros for position independent code.
47 * Assembler Format:: Defining how to write insns and pseudo-ops to output.
48 * Debugging Info:: Defining the format of debugging output.
49 * Floating Point:: Handling floating point for cross-compilers.
50 * Mode Switching:: Insertion of mode-switching instructions.
51 * Target Attributes:: Defining target-specific uses of @code{__attribute__}.
52 * MIPS Coprocessors:: MIPS coprocessor support and how to customize it.
53 * Misc:: Everything else.
56 @node Target Structure
57 @section The Global @code{targetm} Variable
59 @cindex target functions
61 @deftypevar {struct gcc_target} targetm
62 The target @file{.c} file must define the global @code{targetm} variable
63 which contains pointers to functions and data relating to the target
64 machine. The variable is declared in @file{target.h};
65 @file{target-def.h} defines the macro @code{TARGET_INITIALIZER} which is
66 used to initialize the variable, and macros for the default initializers
67 for elements of the structure. The @file{.c} file should override those
68 macros for which the default definition is inappropriate. For example:
71 #include "target-def.h"
73 /* @r{Initialize the GCC target structure.} */
75 #undef TARGET_COMP_TYPE_ATTRIBUTES
76 #define TARGET_COMP_TYPE_ATTRIBUTES @var{machine}_comp_type_attributes
78 struct gcc_target targetm = TARGET_INITIALIZER;
82 Where a macro should be defined in the @file{.c} file in this manner to
83 form part of the @code{targetm} structure, it is documented below as a
84 ``Target Hook'' with a prototype. Many macros will change in future
85 from being defined in the @file{.h} file to being part of the
86 @code{targetm} structure.
89 @section Controlling the Compilation Driver, @file{gcc}
91 @cindex controlling the compilation driver
93 @c prevent bad page break with this line
94 You can control the compilation driver.
96 @defmac SWITCH_TAKES_ARG (@var{char})
97 A C expression which determines whether the option @option{-@var{char}}
98 takes arguments. The value should be the number of arguments that
99 option takes--zero, for many options.
101 By default, this macro is defined as
102 @code{DEFAULT_SWITCH_TAKES_ARG}, which handles the standard options
103 properly. You need not define @code{SWITCH_TAKES_ARG} unless you
104 wish to add additional options which take arguments. Any redefinition
105 should call @code{DEFAULT_SWITCH_TAKES_ARG} and then check for
109 @defmac WORD_SWITCH_TAKES_ARG (@var{name})
110 A C expression which determines whether the option @option{-@var{name}}
111 takes arguments. The value should be the number of arguments that
112 option takes--zero, for many options. This macro rather than
113 @code{SWITCH_TAKES_ARG} is used for multi-character option names.
115 By default, this macro is defined as
116 @code{DEFAULT_WORD_SWITCH_TAKES_ARG}, which handles the standard options
117 properly. You need not define @code{WORD_SWITCH_TAKES_ARG} unless you
118 wish to add additional options which take arguments. Any redefinition
119 should call @code{DEFAULT_WORD_SWITCH_TAKES_ARG} and then check for
123 @defmac SWITCH_CURTAILS_COMPILATION (@var{char})
124 A C expression which determines whether the option @option{-@var{char}}
125 stops compilation before the generation of an executable. The value is
126 boolean, nonzero if the option does stop an executable from being
127 generated, zero otherwise.
129 By default, this macro is defined as
130 @code{DEFAULT_SWITCH_CURTAILS_COMPILATION}, which handles the standard
131 options properly. You need not define
132 @code{SWITCH_CURTAILS_COMPILATION} unless you wish to add additional
133 options which affect the generation of an executable. Any redefinition
134 should call @code{DEFAULT_SWITCH_CURTAILS_COMPILATION} and then check
135 for additional options.
138 @defmac SWITCHES_NEED_SPACES
139 A string-valued C expression which enumerates the options for which
140 the linker needs a space between the option and its argument.
142 If this macro is not defined, the default value is @code{""}.
145 @defmac TARGET_OPTION_TRANSLATE_TABLE
146 If defined, a list of pairs of strings, the first of which is a
147 potential command line target to the @file{gcc} driver program, and the
148 second of which is a space-separated (tabs and other whitespace are not
149 supported) list of options with which to replace the first option. The
150 target defining this list is responsible for assuring that the results
151 are valid. Replacement options may not be the @code{--opt} style, they
152 must be the @code{-opt} style. It is the intention of this macro to
153 provide a mechanism for substitution that affects the multilibs chosen,
154 such as one option that enables many options, some of which select
155 multilibs. Example nonsensical definition, where @code{-malt-abi},
156 @code{-EB}, and @code{-mspoo} cause different multilibs to be chosen:
159 #define TARGET_OPTION_TRANSLATE_TABLE \
160 @{ "-fast", "-march=fast-foo -malt-abi -I/usr/fast-foo" @}, \
161 @{ "-compat", "-EB -malign=4 -mspoo" @}
165 @defmac DRIVER_SELF_SPECS
166 A list of specs for the driver itself. It should be a suitable
167 initializer for an array of strings, with no surrounding braces.
169 The driver applies these specs to its own command line between loading
170 default @file{specs} files (but not command-line specified ones) and
171 choosing the multilib directory or running any subcommands. It
172 applies them in the order given, so each spec can depend on the
173 options added by earlier ones. It is also possible to remove options
174 using @samp{%<@var{option}} in the usual way.
176 This macro can be useful when a port has several interdependent target
177 options. It provides a way of standardizing the command line so
178 that the other specs are easier to write.
180 Do not define this macro if it does not need to do anything.
183 @defmac OPTION_DEFAULT_SPECS
184 A list of specs used to support configure-time default options (i.e.@:
185 @option{--with} options) in the driver. It should be a suitable initializer
186 for an array of structures, each containing two strings, without the
187 outermost pair of surrounding braces.
189 The first item in the pair is the name of the default. This must match
190 the code in @file{config.gcc} for the target. The second item is a spec
191 to apply if a default with this name was specified. The string
192 @samp{%(VALUE)} in the spec will be replaced by the value of the default
193 everywhere it occurs.
195 The driver will apply these specs to its own command line between loading
196 default @file{specs} files and processing @code{DRIVER_SELF_SPECS}, using
197 the same mechanism as @code{DRIVER_SELF_SPECS}.
199 Do not define this macro if it does not need to do anything.
203 A C string constant that tells the GCC driver program options to
204 pass to CPP@. It can also specify how to translate options you
205 give to GCC into options for GCC to pass to the CPP@.
207 Do not define this macro if it does not need to do anything.
210 @defmac CPLUSPLUS_CPP_SPEC
211 This macro is just like @code{CPP_SPEC}, but is used for C++, rather
212 than C@. If you do not define this macro, then the value of
213 @code{CPP_SPEC} (if any) will be used instead.
217 A C string constant that tells the GCC driver program options to
218 pass to @code{cc1}, @code{cc1plus}, @code{f771}, and the other language
220 It can also specify how to translate options you give to GCC into options
221 for GCC to pass to front ends.
223 Do not define this macro if it does not need to do anything.
227 A C string constant that tells the GCC driver program options to
228 pass to @code{cc1plus}. It can also specify how to translate options you
229 give to GCC into options for GCC to pass to the @code{cc1plus}.
231 Do not define this macro if it does not need to do anything.
232 Note that everything defined in CC1_SPEC is already passed to
233 @code{cc1plus} so there is no need to duplicate the contents of
234 CC1_SPEC in CC1PLUS_SPEC@.
238 A C string constant that tells the GCC driver program options to
239 pass to the assembler. It can also specify how to translate options
240 you give to GCC into options for GCC to pass to the assembler.
241 See the file @file{sun3.h} for an example of this.
243 Do not define this macro if it does not need to do anything.
246 @defmac ASM_FINAL_SPEC
247 A C string constant that tells the GCC driver program how to
248 run any programs which cleanup after the normal assembler.
249 Normally, this is not needed. See the file @file{mips.h} for
252 Do not define this macro if it does not need to do anything.
255 @defmac AS_NEEDS_DASH_FOR_PIPED_INPUT
256 Define this macro, with no value, if the driver should give the assembler
257 an argument consisting of a single dash, @option{-}, to instruct it to
258 read from its standard input (which will be a pipe connected to the
259 output of the compiler proper). This argument is given after any
260 @option{-o} option specifying the name of the output file.
262 If you do not define this macro, the assembler is assumed to read its
263 standard input if given no non-option arguments. If your assembler
264 cannot read standard input at all, use a @samp{%@{pipe:%e@}} construct;
265 see @file{mips.h} for instance.
269 A C string constant that tells the GCC driver program options to
270 pass to the linker. It can also specify how to translate options you
271 give to GCC into options for GCC to pass to the linker.
273 Do not define this macro if it does not need to do anything.
277 Another C string constant used much like @code{LINK_SPEC}. The difference
278 between the two is that @code{LIB_SPEC} is used at the end of the
279 command given to the linker.
281 If this macro is not defined, a default is provided that
282 loads the standard C library from the usual place. See @file{gcc.c}.
286 Another C string constant that tells the GCC driver program
287 how and when to place a reference to @file{libgcc.a} into the
288 linker command line. This constant is placed both before and after
289 the value of @code{LIB_SPEC}.
291 If this macro is not defined, the GCC driver provides a default that
292 passes the string @option{-lgcc} to the linker.
295 @defmac STARTFILE_SPEC
296 Another C string constant used much like @code{LINK_SPEC}. The
297 difference between the two is that @code{STARTFILE_SPEC} is used at
298 the very beginning of the command given to the linker.
300 If this macro is not defined, a default is provided that loads the
301 standard C startup file from the usual place. See @file{gcc.c}.
305 Another C string constant used much like @code{LINK_SPEC}. The
306 difference between the two is that @code{ENDFILE_SPEC} is used at
307 the very end of the command given to the linker.
309 Do not define this macro if it does not need to do anything.
312 @defmac THREAD_MODEL_SPEC
313 GCC @code{-v} will print the thread model GCC was configured to use.
314 However, this doesn't work on platforms that are multilibbed on thread
315 models, such as AIX 4.3. On such platforms, define
316 @code{THREAD_MODEL_SPEC} such that it evaluates to a string without
317 blanks that names one of the recognized thread models. @code{%*}, the
318 default value of this macro, will expand to the value of
319 @code{thread_file} set in @file{config.gcc}.
322 @defmac SYSROOT_SUFFIX_SPEC
323 Define this macro to add a suffix to the target sysroot when GCC is
324 configured with a sysroot. This will cause GCC to search for usr/lib,
325 et al, within sysroot+suffix.
328 @defmac SYSROOT_HEADERS_SUFFIX_SPEC
329 Define this macro to add a headers_suffix to the target sysroot when
330 GCC is configured with a sysroot. This will cause GCC to pass the
331 updated sysroot+headers_suffix to CPP@, causing it to search for
332 usr/include, et al, within sysroot+headers_suffix.
336 Define this macro to provide additional specifications to put in the
337 @file{specs} file that can be used in various specifications like
340 The definition should be an initializer for an array of structures,
341 containing a string constant, that defines the specification name, and a
342 string constant that provides the specification.
344 Do not define this macro if it does not need to do anything.
346 @code{EXTRA_SPECS} is useful when an architecture contains several
347 related targets, which have various @code{@dots{}_SPECS} which are similar
348 to each other, and the maintainer would like one central place to keep
351 For example, the PowerPC System V.4 targets use @code{EXTRA_SPECS} to
352 define either @code{_CALL_SYSV} when the System V calling sequence is
353 used or @code{_CALL_AIX} when the older AIX-based calling sequence is
356 The @file{config/rs6000/rs6000.h} target file defines:
359 #define EXTRA_SPECS \
360 @{ "cpp_sysv_default", CPP_SYSV_DEFAULT @},
362 #define CPP_SYS_DEFAULT ""
365 The @file{config/rs6000/sysv.h} target file defines:
369 "%@{posix: -D_POSIX_SOURCE @} \
370 %@{mcall-sysv: -D_CALL_SYSV @} \
371 %@{!mcall-sysv: %(cpp_sysv_default) @} \
372 %@{msoft-float: -D_SOFT_FLOAT@} %@{mcpu=403: -D_SOFT_FLOAT@}"
374 #undef CPP_SYSV_DEFAULT
375 #define CPP_SYSV_DEFAULT "-D_CALL_SYSV"
378 while the @file{config/rs6000/eabiaix.h} target file defines
379 @code{CPP_SYSV_DEFAULT} as:
382 #undef CPP_SYSV_DEFAULT
383 #define CPP_SYSV_DEFAULT "-D_CALL_AIX"
387 @defmac LINK_LIBGCC_SPECIAL
388 Define this macro if the driver program should find the library
389 @file{libgcc.a} itself and should not pass @option{-L} options to the
390 linker. If you do not define this macro, the driver program will pass
391 the argument @option{-lgcc} to tell the linker to do the search and will
392 pass @option{-L} options to it.
395 @defmac LINK_LIBGCC_SPECIAL_1
396 Define this macro if the driver program should find the library
397 @file{libgcc.a}. If you do not define this macro, the driver program will pass
398 the argument @option{-lgcc} to tell the linker to do the search.
399 This macro is similar to @code{LINK_LIBGCC_SPECIAL}, except that it does
400 not affect @option{-L} options.
403 @defmac LINK_GCC_C_SEQUENCE_SPEC
404 The sequence in which libgcc and libc are specified to the linker.
405 By default this is @code{%G %L %G}.
408 @defmac LINK_COMMAND_SPEC
409 A C string constant giving the complete command line need to execute the
410 linker. When you do this, you will need to update your port each time a
411 change is made to the link command line within @file{gcc.c}. Therefore,
412 define this macro only if you need to completely redefine the command
413 line for invoking the linker and there is no other way to accomplish
414 the effect you need. Overriding this macro may be avoidable by overriding
415 @code{LINK_GCC_C_SEQUENCE_SPEC} instead.
418 @defmac LINK_ELIMINATE_DUPLICATE_LDIRECTORIES
419 A nonzero value causes @command{collect2} to remove duplicate @option{-L@var{directory}} search
420 directories from linking commands. Do not give it a nonzero value if
421 removing duplicate search directories changes the linker's semantics.
424 @defmac MULTILIB_DEFAULTS
425 Define this macro as a C expression for the initializer of an array of
426 string to tell the driver program which options are defaults for this
427 target and thus do not need to be handled specially when using
428 @code{MULTILIB_OPTIONS}.
430 Do not define this macro if @code{MULTILIB_OPTIONS} is not defined in
431 the target makefile fragment or if none of the options listed in
432 @code{MULTILIB_OPTIONS} are set by default.
433 @xref{Target Fragment}.
436 @defmac RELATIVE_PREFIX_NOT_LINKDIR
437 Define this macro to tell @command{gcc} that it should only translate
438 a @option{-B} prefix into a @option{-L} linker option if the prefix
439 indicates an absolute file name.
442 @defmac STANDARD_EXEC_PREFIX
443 Define this macro as a C string constant if you wish to override the
444 standard choice of @file{/usr/local/lib/gcc-lib/} as the default prefix to
445 try when searching for the executable files of the compiler.
448 @defmac MD_EXEC_PREFIX
449 If defined, this macro is an additional prefix to try after
450 @code{STANDARD_EXEC_PREFIX}. @code{MD_EXEC_PREFIX} is not searched
451 when the @option{-b} option is used, or the compiler is built as a cross
452 compiler. If you define @code{MD_EXEC_PREFIX}, then be sure to add it
453 to the list of directories used to find the assembler in @file{configure.in}.
456 @defmac STANDARD_STARTFILE_PREFIX
457 Define this macro as a C string constant if you wish to override the
458 standard choice of @file{/usr/local/lib/} as the default prefix to
459 try when searching for startup files such as @file{crt0.o}.
462 @defmac MD_STARTFILE_PREFIX
463 If defined, this macro supplies an additional prefix to try after the
464 standard prefixes. @code{MD_EXEC_PREFIX} is not searched when the
465 @option{-b} option is used, or when the compiler is built as a cross
469 @defmac MD_STARTFILE_PREFIX_1
470 If defined, this macro supplies yet another prefix to try after the
471 standard prefixes. It is not searched when the @option{-b} option is
472 used, or when the compiler is built as a cross compiler.
475 @defmac INIT_ENVIRONMENT
476 Define this macro as a C string constant if you wish to set environment
477 variables for programs called by the driver, such as the assembler and
478 loader. The driver passes the value of this macro to @code{putenv} to
479 initialize the necessary environment variables.
482 @defmac LOCAL_INCLUDE_DIR
483 Define this macro as a C string constant if you wish to override the
484 standard choice of @file{/usr/local/include} as the default prefix to
485 try when searching for local header files. @code{LOCAL_INCLUDE_DIR}
486 comes before @code{SYSTEM_INCLUDE_DIR} in the search order.
488 Cross compilers do not search either @file{/usr/local/include} or its
492 @defmac MODIFY_TARGET_NAME
493 Define this macro if you wish to define command-line switches that
494 modify the default target name.
496 For each switch, you can include a string to be appended to the first
497 part of the configuration name or a string to be deleted from the
498 configuration name, if present. The definition should be an initializer
499 for an array of structures. Each array element should have three
500 elements: the switch name (a string constant, including the initial
501 dash), one of the enumeration codes @code{ADD} or @code{DELETE} to
502 indicate whether the string should be inserted or deleted, and the string
503 to be inserted or deleted (a string constant).
505 For example, on a machine where @samp{64} at the end of the
506 configuration name denotes a 64-bit target and you want the @option{-32}
507 and @option{-64} switches to select between 32- and 64-bit targets, you would
511 #define MODIFY_TARGET_NAME \
512 @{ @{ "-32", DELETE, "64"@}, \
513 @{"-64", ADD, "64"@}@}
517 @defmac SYSTEM_INCLUDE_DIR
518 Define this macro as a C string constant if you wish to specify a
519 system-specific directory to search for header files before the standard
520 directory. @code{SYSTEM_INCLUDE_DIR} comes before
521 @code{STANDARD_INCLUDE_DIR} in the search order.
523 Cross compilers do not use this macro and do not search the directory
527 @defmac STANDARD_INCLUDE_DIR
528 Define this macro as a C string constant if you wish to override the
529 standard choice of @file{/usr/include} as the default prefix to
530 try when searching for header files.
532 Cross compilers ignore this macro and do not search either
533 @file{/usr/include} or its replacement.
536 @defmac STANDARD_INCLUDE_COMPONENT
537 The ``component'' corresponding to @code{STANDARD_INCLUDE_DIR}.
538 See @code{INCLUDE_DEFAULTS}, below, for the description of components.
539 If you do not define this macro, no component is used.
542 @defmac INCLUDE_DEFAULTS
543 Define this macro if you wish to override the entire default search path
544 for include files. For a native compiler, the default search path
545 usually consists of @code{GCC_INCLUDE_DIR}, @code{LOCAL_INCLUDE_DIR},
546 @code{SYSTEM_INCLUDE_DIR}, @code{GPLUSPLUS_INCLUDE_DIR}, and
547 @code{STANDARD_INCLUDE_DIR}. In addition, @code{GPLUSPLUS_INCLUDE_DIR}
548 and @code{GCC_INCLUDE_DIR} are defined automatically by @file{Makefile},
549 and specify private search areas for GCC@. The directory
550 @code{GPLUSPLUS_INCLUDE_DIR} is used only for C++ programs.
552 The definition should be an initializer for an array of structures.
553 Each array element should have four elements: the directory name (a
554 string constant), the component name (also a string constant), a flag
555 for C++-only directories,
556 and a flag showing that the includes in the directory don't need to be
557 wrapped in @code{extern @samp{C}} when compiling C++. Mark the end of
558 the array with a null element.
560 The component name denotes what GNU package the include file is part of,
561 if any, in all upper-case letters. For example, it might be @samp{GCC}
562 or @samp{BINUTILS}. If the package is part of a vendor-supplied
563 operating system, code the component name as @samp{0}.
565 For example, here is the definition used for VAX/VMS:
568 #define INCLUDE_DEFAULTS \
570 @{ "GNU_GXX_INCLUDE:", "G++", 1, 1@}, \
571 @{ "GNU_CC_INCLUDE:", "GCC", 0, 0@}, \
572 @{ "SYS$SYSROOT:[SYSLIB.]", 0, 0, 0@}, \
579 Here is the order of prefixes tried for exec files:
583 Any prefixes specified by the user with @option{-B}.
586 The environment variable @code{GCC_EXEC_PREFIX}, if any.
589 The directories specified by the environment variable @code{COMPILER_PATH}.
592 The macro @code{STANDARD_EXEC_PREFIX}.
595 @file{/usr/lib/gcc/}.
598 The macro @code{MD_EXEC_PREFIX}, if any.
601 Here is the order of prefixes tried for startfiles:
605 Any prefixes specified by the user with @option{-B}.
608 The environment variable @code{GCC_EXEC_PREFIX}, if any.
611 The directories specified by the environment variable @code{LIBRARY_PATH}
612 (or port-specific name; native only, cross compilers do not use this).
615 The macro @code{STANDARD_EXEC_PREFIX}.
618 @file{/usr/lib/gcc/}.
621 The macro @code{MD_EXEC_PREFIX}, if any.
624 The macro @code{MD_STARTFILE_PREFIX}, if any.
627 The macro @code{STANDARD_STARTFILE_PREFIX}.
636 @node Run-time Target
637 @section Run-time Target Specification
638 @cindex run-time target specification
639 @cindex predefined macros
640 @cindex target specifications
642 @c prevent bad page break with this line
643 Here are run-time target specifications.
645 @defmac TARGET_CPU_CPP_BUILTINS ()
646 This function-like macro expands to a block of code that defines
647 built-in preprocessor macros and assertions for the target cpu, using
648 the functions @code{builtin_define}, @code{builtin_define_std} and
649 @code{builtin_assert}. When the front end
650 calls this macro it provides a trailing semicolon, and since it has
651 finished command line option processing your code can use those
654 @code{builtin_assert} takes a string in the form you pass to the
655 command-line option @option{-A}, such as @code{cpu=mips}, and creates
656 the assertion. @code{builtin_define} takes a string in the form
657 accepted by option @option{-D} and unconditionally defines the macro.
659 @code{builtin_define_std} takes a string representing the name of an
660 object-like macro. If it doesn't lie in the user's namespace,
661 @code{builtin_define_std} defines it unconditionally. Otherwise, it
662 defines a version with two leading underscores, and another version
663 with two leading and trailing underscores, and defines the original
664 only if an ISO standard was not requested on the command line. For
665 example, passing @code{unix} defines @code{__unix}, @code{__unix__}
666 and possibly @code{unix}; passing @code{_mips} defines @code{__mips},
667 @code{__mips__} and possibly @code{_mips}, and passing @code{_ABI64}
668 defines only @code{_ABI64}.
670 You can also test for the C dialect being compiled. The variable
671 @code{c_language} is set to one of @code{clk_c}, @code{clk_cplusplus}
672 or @code{clk_objective_c}. Note that if we are preprocessing
673 assembler, this variable will be @code{clk_c} but the function-like
674 macro @code{preprocessing_asm_p()} will return true, so you might want
675 to check for that first. If you need to check for strict ANSI, the
676 variable @code{flag_iso} can be used. The function-like macro
677 @code{preprocessing_trad_p()} can be used to check for traditional
681 @defmac TARGET_OS_CPP_BUILTINS ()
682 Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional
683 and is used for the target operating system instead.
686 @defmac TARGET_OBJFMT_CPP_BUILTINS ()
687 Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional
688 and is used for the target object format. @file{elfos.h} uses this
689 macro to define @code{__ELF__}, so you probably do not need to define
693 @deftypevar {extern int} target_flags
694 This declaration should be present.
697 @cindex optional hardware or system features
698 @cindex features, optional, in system conventions
700 @defmac TARGET_@var{featurename}
701 This series of macros is to allow compiler command arguments to
702 enable or disable the use of optional features of the target machine.
703 For example, one machine description serves both the 68000 and
704 the 68020; a command argument tells the compiler whether it should
705 use 68020-only instructions or not. This command argument works
706 by means of a macro @code{TARGET_68020} that tests a bit in
709 Define a macro @code{TARGET_@var{featurename}} for each such option.
710 Its definition should test a bit in @code{target_flags}. It is
711 recommended that a helper macro @code{MASK_@var{featurename}}
712 is defined for each bit-value to test, and used in
713 @code{TARGET_@var{featurename}} and @code{TARGET_SWITCHES}. For
717 #define TARGET_MASK_68020 1
718 #define TARGET_68020 (target_flags & MASK_68020)
721 One place where these macros are used is in the condition-expressions
722 of instruction patterns. Note how @code{TARGET_68020} appears
723 frequently in the 68000 machine description file, @file{m68k.md}.
724 Another place they are used is in the definitions of the other
725 macros in the @file{@var{machine}.h} file.
728 @defmac TARGET_SWITCHES
729 This macro defines names of command options to set and clear
730 bits in @code{target_flags}. Its definition is an initializer
731 with a subgrouping for each command option.
733 Each subgrouping contains a string constant, that defines the option
734 name, a number, which contains the bits to set in
735 @code{target_flags}, and a second string which is the description
736 displayed by @option{--help}. If the number is negative then the bits specified
737 by the number are cleared instead of being set. If the description
738 string is present but empty, then no help information will be displayed
739 for that option, but it will not count as an undocumented option. The
740 actual option name is made by appending @samp{-m} to the specified name.
741 Non-empty description strings should be marked with @code{N_(@dots{})} for
742 @command{xgettext}. Please do not mark empty strings because the empty
743 string is reserved by GNU gettext. @code{gettext("")} returns the header entry
744 of the message catalog with meta information, not the empty string.
746 In addition to the description for @option{--help},
747 more detailed documentation for each option should be added to
750 One of the subgroupings should have a null string. The number in
751 this grouping is the default value for @code{target_flags}. Any
752 target options act starting with that value.
754 Here is an example which defines @option{-m68000} and @option{-m68020}
755 with opposite meanings, and picks the latter as the default:
758 #define TARGET_SWITCHES \
759 @{ @{ "68020", MASK_68020, "" @}, \
760 @{ "68000", -MASK_68020, \
761 N_("Compile for the 68000") @}, \
762 @{ "", MASK_68020, "" @}, \
767 @defmac TARGET_OPTIONS
768 This macro is similar to @code{TARGET_SWITCHES} but defines names of command
769 options that have values. Its definition is an initializer with a
770 subgrouping for each command option.
772 Each subgrouping contains a string constant, that defines the option
773 name, the address of a variable, a description string, and a value.
774 Non-empty description strings should be marked with @code{N_(@dots{})}
775 for @command{xgettext}. Please do not mark empty strings because the
776 empty string is reserved by GNU gettext. @code{gettext("")} returns the
777 header entry of the message catalog with meta information, not the empty
780 If the value listed in the table is @code{NULL}, then the variable, type
781 @code{char *}, is set to the variable part of the given option if the
782 fixed part matches. In other words, if the first part of the option
783 matches what's in the table, the variable will be set to point to the
784 rest of the option. This allows the user to specify a value for that
785 option. The actual option name is made by appending @samp{-m} to the
786 specified name. Again, each option should also be documented in
789 If the value listed in the table is non-@code{NULL}, then the option
790 must match the option in the table exactly (with @samp{-m}), and the
791 variable is set to point to the value listed in the table.
793 Here is an example which defines @option{-mshort-data-@var{number}}. If the
794 given option is @option{-mshort-data-512}, the variable @code{m88k_short_data}
795 will be set to the string @code{"512"}.
798 extern char *m88k_short_data;
799 #define TARGET_OPTIONS \
800 @{ @{ "short-data-", &m88k_short_data, \
801 N_("Specify the size of the short data section"), 0 @} @}
804 Here is an variant of the above that allows the user to also specify
805 just @option{-mshort-data} where a default of @code{"64"} is used.
808 extern char *m88k_short_data;
809 #define TARGET_OPTIONS \
810 @{ @{ "short-data-", &m88k_short_data, \
811 N_("Specify the size of the short data section"), 0 @} \
812 @{ "short-data", &m88k_short_data, "", "64" @},
816 Here is an example which defines @option{-mno-alu}, @option{-malu1}, and
817 @option{-malu2} as a three-state switch, along with suitable macros for
818 checking the state of the option (documentation is elided for brevity).
822 char *chip_alu = ""; /* Specify default here. */
825 extern char *chip_alu;
826 #define TARGET_OPTIONS \
827 @{ @{ "no-alu", &chip_alu, "", "" @}, \
828 @{ "alu1", &chip_alu, "", "1" @}, \
829 @{ "alu2", &chip_alu, "", "2" @}, @}
830 #define TARGET_ALU (chip_alu[0] != '\0')
831 #define TARGET_ALU1 (chip_alu[0] == '1')
832 #define TARGET_ALU2 (chip_alu[0] == '2')
836 @defmac TARGET_VERSION
837 This macro is a C statement to print on @code{stderr} a string
838 describing the particular machine description choice. Every machine
839 description should define @code{TARGET_VERSION}. For example:
843 #define TARGET_VERSION \
844 fprintf (stderr, " (68k, Motorola syntax)");
846 #define TARGET_VERSION \
847 fprintf (stderr, " (68k, MIT syntax)");
852 @defmac OVERRIDE_OPTIONS
853 Sometimes certain combinations of command options do not make sense on
854 a particular target machine. You can define a macro
855 @code{OVERRIDE_OPTIONS} to take account of this. This macro, if
856 defined, is executed once just after all the command options have been
859 Don't use this macro to turn on various extra optimizations for
860 @option{-O}. That is what @code{OPTIMIZATION_OPTIONS} is for.
863 @defmac OPTIMIZATION_OPTIONS (@var{level}, @var{size})
864 Some machines may desire to change what optimizations are performed for
865 various optimization levels. This macro, if defined, is executed once
866 just after the optimization level is determined and before the remainder
867 of the command options have been parsed. Values set in this macro are
868 used as the default values for the other command line options.
870 @var{level} is the optimization level specified; 2 if @option{-O2} is
871 specified, 1 if @option{-O} is specified, and 0 if neither is specified.
873 @var{size} is nonzero if @option{-Os} is specified and zero otherwise.
875 You should not use this macro to change options that are not
876 machine-specific. These should uniformly selected by the same
877 optimization level on all supported machines. Use this macro to enable
878 machine-specific optimizations.
880 @strong{Do not examine @code{write_symbols} in
881 this macro!} The debugging options are not supposed to alter the
885 @defmac CAN_DEBUG_WITHOUT_FP
886 Define this macro if debugging can be performed even without a frame
887 pointer. If this macro is defined, GCC will turn on the
888 @option{-fomit-frame-pointer} option whenever @option{-O} is specified.
891 @node Per-Function Data
892 @section Defining data structures for per-function information.
893 @cindex per-function data
894 @cindex data structures
896 If the target needs to store information on a per-function basis, GCC
897 provides a macro and a couple of variables to allow this. Note, just
898 using statics to store the information is a bad idea, since GCC supports
899 nested functions, so you can be halfway through encoding one function
900 when another one comes along.
902 GCC defines a data structure called @code{struct function} which
903 contains all of the data specific to an individual function. This
904 structure contains a field called @code{machine} whose type is
905 @code{struct machine_function *}, which can be used by targets to point
906 to their own specific data.
908 If a target needs per-function specific data it should define the type
909 @code{struct machine_function} and also the macro @code{INIT_EXPANDERS}.
910 This macro should be used to initialize the function pointer
911 @code{init_machine_status}. This pointer is explained below.
913 One typical use of per-function, target specific data is to create an
914 RTX to hold the register containing the function's return address. This
915 RTX can then be used to implement the @code{__builtin_return_address}
916 function, for level 0.
918 Note---earlier implementations of GCC used a single data area to hold
919 all of the per-function information. Thus when processing of a nested
920 function began the old per-function data had to be pushed onto a
921 stack, and when the processing was finished, it had to be popped off the
922 stack. GCC used to provide function pointers called
923 @code{save_machine_status} and @code{restore_machine_status} to handle
924 the saving and restoring of the target specific information. Since the
925 single data area approach is no longer used, these pointers are no
928 @defmac INIT_EXPANDERS
929 Macro called to initialize any target specific information. This macro
930 is called once per function, before generation of any RTL has begun.
931 The intention of this macro is to allow the initialization of the
932 function pointer @code{init_machine_status}.
935 @deftypevar {void (*)(struct function *)} init_machine_status
936 If this function pointer is non-@code{NULL} it will be called once per
937 function, before function compilation starts, in order to allow the
938 target to perform any target specific initialization of the
939 @code{struct function} structure. It is intended that this would be
940 used to initialize the @code{machine} of that structure.
942 @code{struct machine_function} structures are expected to be freed by GC.
943 Generally, any memory that they reference must be allocated by using
944 @code{ggc_alloc}, including the structure itself.
948 @section Storage Layout
949 @cindex storage layout
951 Note that the definitions of the macros in this table which are sizes or
952 alignments measured in bits do not need to be constant. They can be C
953 expressions that refer to static variables, such as the @code{target_flags}.
954 @xref{Run-time Target}.
956 @defmac BITS_BIG_ENDIAN
957 Define this macro to have the value 1 if the most significant bit in a
958 byte has the lowest number; otherwise define it to have the value zero.
959 This means that bit-field instructions count from the most significant
960 bit. If the machine has no bit-field instructions, then this must still
961 be defined, but it doesn't matter which value it is defined to. This
962 macro need not be a constant.
964 This macro does not affect the way structure fields are packed into
965 bytes or words; that is controlled by @code{BYTES_BIG_ENDIAN}.
968 @defmac BYTES_BIG_ENDIAN
969 Define this macro to have the value 1 if the most significant byte in a
970 word has the lowest number. This macro need not be a constant.
973 @defmac WORDS_BIG_ENDIAN
974 Define this macro to have the value 1 if, in a multiword object, the
975 most significant word has the lowest number. This applies to both
976 memory locations and registers; GCC fundamentally assumes that the
977 order of words in memory is the same as the order in registers. This
978 macro need not be a constant.
981 @defmac LIBGCC2_WORDS_BIG_ENDIAN
982 Define this macro if @code{WORDS_BIG_ENDIAN} is not constant. This must be a
983 constant value with the same meaning as @code{WORDS_BIG_ENDIAN}, which will be
984 used only when compiling @file{libgcc2.c}. Typically the value will be set
985 based on preprocessor defines.
988 @defmac FLOAT_WORDS_BIG_ENDIAN
989 Define this macro to have the value 1 if @code{DFmode}, @code{XFmode} or
990 @code{TFmode} floating point numbers are stored in memory with the word
991 containing the sign bit at the lowest address; otherwise define it to
992 have the value 0. This macro need not be a constant.
994 You need not define this macro if the ordering is the same as for
998 @defmac BITS_PER_UNIT
999 Define this macro to be the number of bits in an addressable storage
1000 unit (byte). If you do not define this macro the default is 8.
1003 @defmac BITS_PER_WORD
1004 Number of bits in a word. If you do not define this macro, the default
1005 is @code{BITS_PER_UNIT * UNITS_PER_WORD}.
1008 @defmac MAX_BITS_PER_WORD
1009 Maximum number of bits in a word. If this is undefined, the default is
1010 @code{BITS_PER_WORD}. Otherwise, it is the constant value that is the
1011 largest value that @code{BITS_PER_WORD} can have at run-time.
1014 @defmac UNITS_PER_WORD
1015 Number of storage units in a word; normally 4.
1018 @defmac MIN_UNITS_PER_WORD
1019 Minimum number of units in a word. If this is undefined, the default is
1020 @code{UNITS_PER_WORD}. Otherwise, it is the constant value that is the
1021 smallest value that @code{UNITS_PER_WORD} can have at run-time.
1024 @defmac POINTER_SIZE
1025 Width of a pointer, in bits. You must specify a value no wider than the
1026 width of @code{Pmode}. If it is not equal to the width of @code{Pmode},
1027 you must define @code{POINTERS_EXTEND_UNSIGNED}. If you do not specify
1028 a value the default is @code{BITS_PER_WORD}.
1031 @defmac POINTERS_EXTEND_UNSIGNED
1032 A C expression whose value is greater than zero if pointers that need to be
1033 extended from being @code{POINTER_SIZE} bits wide to @code{Pmode} are to
1034 be zero-extended and zero if they are to be sign-extended. If the value
1035 is less then zero then there must be an "ptr_extend" instruction that
1036 extends a pointer from @code{POINTER_SIZE} to @code{Pmode}.
1038 You need not define this macro if the @code{POINTER_SIZE} is equal
1039 to the width of @code{Pmode}.
1042 @defmac PROMOTE_MODE (@var{m}, @var{unsignedp}, @var{type})
1043 A macro to update @var{m} and @var{unsignedp} when an object whose type
1044 is @var{type} and which has the specified mode and signedness is to be
1045 stored in a register. This macro is only called when @var{type} is a
1048 On most RISC machines, which only have operations that operate on a full
1049 register, define this macro to set @var{m} to @code{word_mode} if
1050 @var{m} is an integer mode narrower than @code{BITS_PER_WORD}. In most
1051 cases, only integer modes should be widened because wider-precision
1052 floating-point operations are usually more expensive than their narrower
1055 For most machines, the macro definition does not change @var{unsignedp}.
1056 However, some machines, have instructions that preferentially handle
1057 either signed or unsigned quantities of certain modes. For example, on
1058 the DEC Alpha, 32-bit loads from memory and 32-bit add instructions
1059 sign-extend the result to 64 bits. On such machines, set
1060 @var{unsignedp} according to which kind of extension is more efficient.
1062 Do not define this macro if it would never modify @var{m}.
1065 @defmac PROMOTE_FUNCTION_ARGS
1066 Define this macro if the promotion described by @code{PROMOTE_MODE}
1067 should also be done for outgoing function arguments.
1070 @defmac PROMOTE_FUNCTION_RETURN
1071 Define this macro if the promotion described by @code{PROMOTE_MODE}
1072 should also be done for the return value of functions.
1074 If this macro is defined, @code{FUNCTION_VALUE} must perform the same
1075 promotions done by @code{PROMOTE_MODE}.
1078 @defmac PROMOTE_FOR_CALL_ONLY
1079 Define this macro if the promotion described by @code{PROMOTE_MODE}
1080 should @emph{only} be performed for outgoing function arguments or
1081 function return values, as specified by @code{PROMOTE_FUNCTION_ARGS}
1082 and @code{PROMOTE_FUNCTION_RETURN}, respectively.
1085 @defmac PARM_BOUNDARY
1086 Normal alignment required for function parameters on the stack, in
1087 bits. All stack parameters receive at least this much alignment
1088 regardless of data type. On most machines, this is the same as the
1092 @defmac STACK_BOUNDARY
1093 Define this macro to the minimum alignment enforced by hardware for the
1094 stack pointer on this machine. The definition is a C expression for the
1095 desired alignment (measured in bits). This value is used as a default
1096 if @code{PREFERRED_STACK_BOUNDARY} is not defined. On most machines,
1097 this should be the same as @code{PARM_BOUNDARY}.
1100 @defmac PREFERRED_STACK_BOUNDARY
1101 Define this macro if you wish to preserve a certain alignment for the
1102 stack pointer, greater than what the hardware enforces. The definition
1103 is a C expression for the desired alignment (measured in bits). This
1104 macro must evaluate to a value equal to or larger than
1105 @code{STACK_BOUNDARY}.
1108 @defmac FORCE_PREFERRED_STACK_BOUNDARY_IN_MAIN
1109 A C expression that evaluates true if @code{PREFERRED_STACK_BOUNDARY} is
1110 not guaranteed by the runtime and we should emit code to align the stack
1111 at the beginning of @code{main}.
1113 @cindex @code{PUSH_ROUNDING}, interaction with @code{PREFERRED_STACK_BOUNDARY}
1114 If @code{PUSH_ROUNDING} is not defined, the stack will always be aligned
1115 to the specified boundary. If @code{PUSH_ROUNDING} is defined and specifies
1116 a less strict alignment than @code{PREFERRED_STACK_BOUNDARY}, the stack may
1117 be momentarily unaligned while pushing arguments.
1120 @defmac FUNCTION_BOUNDARY
1121 Alignment required for a function entry point, in bits.
1124 @defmac BIGGEST_ALIGNMENT
1125 Biggest alignment that any data type can require on this machine, in bits.
1128 @defmac MINIMUM_ATOMIC_ALIGNMENT
1129 If defined, the smallest alignment, in bits, that can be given to an
1130 object that can be referenced in one operation, without disturbing any
1131 nearby object. Normally, this is @code{BITS_PER_UNIT}, but may be larger
1132 on machines that don't have byte or half-word store operations.
1135 @defmac BIGGEST_FIELD_ALIGNMENT
1136 Biggest alignment that any structure or union field can require on this
1137 machine, in bits. If defined, this overrides @code{BIGGEST_ALIGNMENT} for
1138 structure and union fields only, unless the field alignment has been set
1139 by the @code{__attribute__ ((aligned (@var{n})))} construct.
1142 @defmac ADJUST_FIELD_ALIGN (@var{field}, @var{computed})
1143 An expression for the alignment of a structure field @var{field} if the
1144 alignment computed in the usual way (including applying of
1145 @code{BIGGEST_ALIGNMENT} and @code{BIGGEST_FIELD_ALIGNMENT} to the
1146 alignment) is @var{computed}. It overrides alignment only if the
1147 field alignment has not been set by the
1148 @code{__attribute__ ((aligned (@var{n})))} construct.
1151 @defmac MAX_OFILE_ALIGNMENT
1152 Biggest alignment supported by the object file format of this machine.
1153 Use this macro to limit the alignment which can be specified using the
1154 @code{__attribute__ ((aligned (@var{n})))} construct. If not defined,
1155 the default value is @code{BIGGEST_ALIGNMENT}.
1158 @defmac DATA_ALIGNMENT (@var{type}, @var{basic-align})
1159 If defined, a C expression to compute the alignment for a variable in
1160 the static store. @var{type} is the data type, and @var{basic-align} is
1161 the alignment that the object would ordinarily have. The value of this
1162 macro is used instead of that alignment to align the object.
1164 If this macro is not defined, then @var{basic-align} is used.
1167 One use of this macro is to increase alignment of medium-size data to
1168 make it all fit in fewer cache lines. Another is to cause character
1169 arrays to be word-aligned so that @code{strcpy} calls that copy
1170 constants to character arrays can be done inline.
1173 @defmac CONSTANT_ALIGNMENT (@var{constant}, @var{basic-align})
1174 If defined, a C expression to compute the alignment given to a constant
1175 that is being placed in memory. @var{constant} is the constant and
1176 @var{basic-align} is the alignment that the object would ordinarily
1177 have. The value of this macro is used instead of that alignment to
1180 If this macro is not defined, then @var{basic-align} is used.
1182 The typical use of this macro is to increase alignment for string
1183 constants to be word aligned so that @code{strcpy} calls that copy
1184 constants can be done inline.
1187 @defmac LOCAL_ALIGNMENT (@var{type}, @var{basic-align})
1188 If defined, a C expression to compute the alignment for a variable in
1189 the local store. @var{type} is the data type, and @var{basic-align} is
1190 the alignment that the object would ordinarily have. The value of this
1191 macro is used instead of that alignment to align the object.
1193 If this macro is not defined, then @var{basic-align} is used.
1195 One use of this macro is to increase alignment of medium-size data to
1196 make it all fit in fewer cache lines.
1199 @defmac EMPTY_FIELD_BOUNDARY
1200 Alignment in bits to be given to a structure bit-field that follows an
1201 empty field such as @code{int : 0;}.
1203 If @code{PCC_BITFIELD_TYPE_MATTERS} is true, it overrides this macro.
1206 @defmac STRUCTURE_SIZE_BOUNDARY
1207 Number of bits which any structure or union's size must be a multiple of.
1208 Each structure or union's size is rounded up to a multiple of this.
1210 If you do not define this macro, the default is the same as
1211 @code{BITS_PER_UNIT}.
1214 @defmac STRICT_ALIGNMENT
1215 Define this macro to be the value 1 if instructions will fail to work
1216 if given data not on the nominal alignment. If instructions will merely
1217 go slower in that case, define this macro as 0.
1220 @defmac PCC_BITFIELD_TYPE_MATTERS
1221 Define this if you wish to imitate the way many other C compilers handle
1222 alignment of bit-fields and the structures that contain them.
1224 The behavior is that the type written for a named bit-field (@code{int},
1225 @code{short}, or other integer type) imposes an alignment for the entire
1226 structure, as if the structure really did contain an ordinary field of
1227 that type. In addition, the bit-field is placed within the structure so
1228 that it would fit within such a field, not crossing a boundary for it.
1230 Thus, on most machines, a named bit-field whose type is written as
1231 @code{int} would not cross a four-byte boundary, and would force
1232 four-byte alignment for the whole structure. (The alignment used may
1233 not be four bytes; it is controlled by the other alignment parameters.)
1235 An unnamed bit-field will not affect the alignment of the containing
1238 If the macro is defined, its definition should be a C expression;
1239 a nonzero value for the expression enables this behavior.
1241 Note that if this macro is not defined, or its value is zero, some
1242 bit-fields may cross more than one alignment boundary. The compiler can
1243 support such references if there are @samp{insv}, @samp{extv}, and
1244 @samp{extzv} insns that can directly reference memory.
1246 The other known way of making bit-fields work is to define
1247 @code{STRUCTURE_SIZE_BOUNDARY} as large as @code{BIGGEST_ALIGNMENT}.
1248 Then every structure can be accessed with fullwords.
1250 Unless the machine has bit-field instructions or you define
1251 @code{STRUCTURE_SIZE_BOUNDARY} that way, you must define
1252 @code{PCC_BITFIELD_TYPE_MATTERS} to have a nonzero value.
1254 If your aim is to make GCC use the same conventions for laying out
1255 bit-fields as are used by another compiler, here is how to investigate
1256 what the other compiler does. Compile and run this program:
1275 printf ("Size of foo1 is %d\n",
1276 sizeof (struct foo1));
1277 printf ("Size of foo2 is %d\n",
1278 sizeof (struct foo2));
1283 If this prints 2 and 5, then the compiler's behavior is what you would
1284 get from @code{PCC_BITFIELD_TYPE_MATTERS}.
1287 @defmac BITFIELD_NBYTES_LIMITED
1288 Like @code{PCC_BITFIELD_TYPE_MATTERS} except that its effect is limited
1289 to aligning a bit-field within the structure.
1292 @defmac MEMBER_TYPE_FORCES_BLK (@var{field}, @var{mode})
1293 Return 1 if a structure or array containing @var{field} should be accessed using
1296 If @var{field} is the only field in the structure, @var{mode} is its
1297 mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the
1298 case where structures of one field would require the structure's mode to
1299 retain the field's mode.
1301 Normally, this is not needed. See the file @file{c4x.h} for an example
1302 of how to use this macro to prevent a structure having a floating point
1303 field from being accessed in an integer mode.
1306 @defmac ROUND_TYPE_ALIGN (@var{type}, @var{computed}, @var{specified})
1307 Define this macro as an expression for the alignment of a type (given
1308 by @var{type} as a tree node) if the alignment computed in the usual
1309 way is @var{computed} and the alignment explicitly specified was
1312 The default is to use @var{specified} if it is larger; otherwise, use
1313 the smaller of @var{computed} and @code{BIGGEST_ALIGNMENT}
1316 @defmac MAX_FIXED_MODE_SIZE
1317 An integer expression for the size in bits of the largest integer
1318 machine mode that should actually be used. All integer machine modes of
1319 this size or smaller can be used for structures and unions with the
1320 appropriate sizes. If this macro is undefined, @code{GET_MODE_BITSIZE
1321 (DImode)} is assumed.
1324 @defmac VECTOR_MODE_SUPPORTED_P (@var{mode})
1325 Define this macro to be nonzero if the port is prepared to handle insns
1326 involving vector mode @var{mode}. At the very least, it must have move
1327 patterns for this mode.
1330 @defmac STACK_SAVEAREA_MODE (@var{save_level})
1331 If defined, an expression of type @code{enum machine_mode} that
1332 specifies the mode of the save area operand of a
1333 @code{save_stack_@var{level}} named pattern (@pxref{Standard Names}).
1334 @var{save_level} is one of @code{SAVE_BLOCK}, @code{SAVE_FUNCTION}, or
1335 @code{SAVE_NONLOCAL} and selects which of the three named patterns is
1336 having its mode specified.
1338 You need not define this macro if it always returns @code{Pmode}. You
1339 would most commonly define this macro if the
1340 @code{save_stack_@var{level}} patterns need to support both a 32- and a
1344 @defmac STACK_SIZE_MODE
1345 If defined, an expression of type @code{enum machine_mode} that
1346 specifies the mode of the size increment operand of an
1347 @code{allocate_stack} named pattern (@pxref{Standard Names}).
1349 You need not define this macro if it always returns @code{word_mode}.
1350 You would most commonly define this macro if the @code{allocate_stack}
1351 pattern needs to support both a 32- and a 64-bit mode.
1354 @defmac TARGET_FLOAT_FORMAT
1355 A code distinguishing the floating point format of the target machine.
1356 There are four defined values:
1359 @item IEEE_FLOAT_FORMAT
1360 This code indicates IEEE floating point. It is the default; there is no
1361 need to define @code{TARGET_FLOAT_FORMAT} when the format is IEEE@.
1363 @item VAX_FLOAT_FORMAT
1364 This code indicates the ``F float'' (for @code{float}) and ``D float''
1365 or ``G float'' formats (for @code{double}) used on the VAX and PDP-11@.
1367 @item IBM_FLOAT_FORMAT
1368 This code indicates the format used on the IBM System/370.
1370 @item C4X_FLOAT_FORMAT
1371 This code indicates the format used on the TMS320C3x/C4x.
1374 If your target uses a floating point format other than these, you must
1375 define a new @var{name}_FLOAT_FORMAT code for it, and add support for
1376 it to @file{real.c}.
1378 The ordering of the component words of floating point values stored in
1379 memory is controlled by @code{FLOAT_WORDS_BIG_ENDIAN}.
1382 @defmac MODE_HAS_NANS (@var{mode})
1383 When defined, this macro should be true if @var{mode} has a NaN
1384 representation. The compiler assumes that NaNs are not equal to
1385 anything (including themselves) and that addition, subtraction,
1386 multiplication and division all return NaNs when one operand is
1389 By default, this macro is true if @var{mode} is a floating-point
1390 mode and the target floating-point format is IEEE@.
1393 @defmac MODE_HAS_INFINITIES (@var{mode})
1394 This macro should be true if @var{mode} can represent infinity. At
1395 present, the compiler uses this macro to decide whether @samp{x - x}
1396 is always defined. By default, the macro is true when @var{mode}
1397 is a floating-point mode and the target format is IEEE@.
1400 @defmac MODE_HAS_SIGNED_ZEROS (@var{mode})
1401 True if @var{mode} distinguishes between positive and negative zero.
1402 The rules are expected to follow the IEEE standard:
1406 @samp{x + x} has the same sign as @samp{x}.
1409 If the sum of two values with opposite sign is zero, the result is
1410 positive for all rounding modes expect towards @minus{}infinity, for
1411 which it is negative.
1414 The sign of a product or quotient is negative when exactly one
1415 of the operands is negative.
1418 The default definition is true if @var{mode} is a floating-point
1419 mode and the target format is IEEE@.
1422 @defmac MODE_HAS_SIGN_DEPENDENT_ROUNDING (@var{mode})
1423 If defined, this macro should be true for @var{mode} if it has at
1424 least one rounding mode in which @samp{x} and @samp{-x} can be
1425 rounded to numbers of different magnitude. Two such modes are
1426 towards @minus{}infinity and towards +infinity.
1428 The default definition of this macro is true if @var{mode} is
1429 a floating-point mode and the target format is IEEE@.
1432 @defmac ROUND_TOWARDS_ZERO
1433 If defined, this macro should be true if the prevailing rounding
1434 mode is towards zero. A true value has the following effects:
1438 @code{MODE_HAS_SIGN_DEPENDENT_ROUNDING} will be false for all modes.
1441 @file{libgcc.a}'s floating-point emulator will round towards zero
1442 rather than towards nearest.
1445 The compiler's floating-point emulator will round towards zero after
1446 doing arithmetic, and when converting from the internal float format to
1450 The macro does not affect the parsing of string literals. When the
1451 primary rounding mode is towards zero, library functions like
1452 @code{strtod} might still round towards nearest, and the compiler's
1453 parser should behave like the target's @code{strtod} where possible.
1455 Not defining this macro is equivalent to returning zero.
1458 @defmac LARGEST_EXPONENT_IS_NORMAL (@var{size})
1459 This macro should return true if floats with @var{size}
1460 bits do not have a NaN or infinity representation, but use the largest
1461 exponent for normal numbers instead.
1463 Defining this macro to true for @var{size} causes @code{MODE_HAS_NANS}
1464 and @code{MODE_HAS_INFINITIES} to be false for @var{size}-bit modes.
1465 It also affects the way @file{libgcc.a} and @file{real.c} emulate
1466 floating-point arithmetic.
1468 The default definition of this macro returns false for all sizes.
1471 @deftypefn {Target Hook} bool TARGET_VECTOR_OPAQUE_P (tree @var{type})
1472 This target hook should return @code{true} a vector is opaque. That
1473 is, if no cast is needed when copying a vector value of type
1474 @var{type} into another vector lvalue of the same size. Vector opaque
1475 types cannot be initialized. The default is that there are no such
1479 @deftypefn {Target Hook} bool TARGET_MS_BITFIELD_LAYOUT_P (tree @var{record_type})
1480 This target hook returns @code{true} if bit-fields in the given
1481 @var{record_type} are to be laid out following the rules of Microsoft
1482 Visual C/C++, namely: (i) a bit-field won't share the same storage
1483 unit with the previous bit-field if their underlying types have
1484 different sizes, and the bit-field will be aligned to the highest
1485 alignment of the underlying types of itself and of the previous
1486 bit-field; (ii) a zero-sized bit-field will affect the alignment of
1487 the whole enclosing structure, even if it is unnamed; except that
1488 (iii) a zero-sized bit-field will be disregarded unless it follows
1489 another bit-field of nonzero size. If this hook returns @code{true},
1490 other macros that control bit-field layout are ignored.
1492 When a bit-field is inserted into a packed record, the whole size
1493 of the underlying type is used by one or more same-size adjacent
1494 bit-fields (that is, if its long:3, 32 bits is used in the record,
1495 and any additional adjacent long bit-fields are packed into the same
1496 chunk of 32 bits. However, if the size changes, a new field of that
1497 size is allocated). In an unpacked record, this is the same as using
1498 alignment, but not equivalent when packing.
1500 If both MS bit-fields and @samp{__attribute__((packed))} are used,
1501 the latter will take precedence. If @samp{__attribute__((packed))} is
1502 used on a single field when MS bit-fields are in use, it will take
1503 precedence for that field, but the alignment of the rest of the structure
1504 may affect its placement.
1508 @section Layout of Source Language Data Types
1510 These macros define the sizes and other characteristics of the standard
1511 basic data types used in programs being compiled. Unlike the macros in
1512 the previous section, these apply to specific features of C and related
1513 languages, rather than to fundamental aspects of storage layout.
1515 @defmac INT_TYPE_SIZE
1516 A C expression for the size in bits of the type @code{int} on the
1517 target machine. If you don't define this, the default is one word.
1520 @defmac SHORT_TYPE_SIZE
1521 A C expression for the size in bits of the type @code{short} on the
1522 target machine. If you don't define this, the default is half a word.
1523 (If this would be less than one storage unit, it is rounded up to one
1527 @defmac LONG_TYPE_SIZE
1528 A C expression for the size in bits of the type @code{long} on the
1529 target machine. If you don't define this, the default is one word.
1532 @defmac ADA_LONG_TYPE_SIZE
1533 On some machines, the size used for the Ada equivalent of the type
1534 @code{long} by a native Ada compiler differs from that used by C. In
1535 that situation, define this macro to be a C expression to be used for
1536 the size of that type. If you don't define this, the default is the
1537 value of @code{LONG_TYPE_SIZE}.
1540 @defmac MAX_LONG_TYPE_SIZE
1541 Maximum number for the size in bits of the type @code{long} on the
1542 target machine. If this is undefined, the default is
1543 @code{LONG_TYPE_SIZE}. Otherwise, it is the constant value that is the
1544 largest value that @code{LONG_TYPE_SIZE} can have at run-time. This is
1548 @defmac LONG_LONG_TYPE_SIZE
1549 A C expression for the size in bits of the type @code{long long} on the
1550 target machine. If you don't define this, the default is two
1551 words. If you want to support GNU Ada on your machine, the value of this
1552 macro must be at least 64.
1555 @defmac CHAR_TYPE_SIZE
1556 A C expression for the size in bits of the type @code{char} on the
1557 target machine. If you don't define this, the default is
1558 @code{BITS_PER_UNIT}.
1561 @defmac BOOL_TYPE_SIZE
1562 A C expression for the size in bits of the C++ type @code{bool} and
1563 C99 type @code{_Bool} on the target machine. If you don't define
1564 this, and you probably shouldn't, the default is @code{CHAR_TYPE_SIZE}.
1567 @defmac FLOAT_TYPE_SIZE
1568 A C expression for the size in bits of the type @code{float} on the
1569 target machine. If you don't define this, the default is one word.
1572 @defmac DOUBLE_TYPE_SIZE
1573 A C expression for the size in bits of the type @code{double} on the
1574 target machine. If you don't define this, the default is two
1578 @defmac LONG_DOUBLE_TYPE_SIZE
1579 A C expression for the size in bits of the type @code{long double} on
1580 the target machine. If you don't define this, the default is two
1584 @defmac MAX_LONG_DOUBLE_TYPE_SIZE
1585 Maximum number for the size in bits of the type @code{long double} on the
1586 target machine. If this is undefined, the default is
1587 @code{LONG_DOUBLE_TYPE_SIZE}. Otherwise, it is the constant value that is
1588 the largest value that @code{LONG_DOUBLE_TYPE_SIZE} can have at run-time.
1589 This is used in @code{cpp}.
1592 @defmac TARGET_FLT_EVAL_METHOD
1593 A C expression for the value for @code{FLT_EVAL_METHOD} in @file{float.h},
1594 assuming, if applicable, that the floating-point control word is in its
1595 default state. If you do not define this macro the value of
1596 @code{FLT_EVAL_METHOD} will be zero.
1599 @defmac WIDEST_HARDWARE_FP_SIZE
1600 A C expression for the size in bits of the widest floating-point format
1601 supported by the hardware. If you define this macro, you must specify a
1602 value less than or equal to the value of @code{LONG_DOUBLE_TYPE_SIZE}.
1603 If you do not define this macro, the value of @code{LONG_DOUBLE_TYPE_SIZE}
1607 @defmac DEFAULT_SIGNED_CHAR
1608 An expression whose value is 1 or 0, according to whether the type
1609 @code{char} should be signed or unsigned by default. The user can
1610 always override this default with the options @option{-fsigned-char}
1611 and @option{-funsigned-char}.
1614 @defmac DEFAULT_SHORT_ENUMS
1615 A C expression to determine whether to give an @code{enum} type
1616 only as many bytes as it takes to represent the range of possible values
1617 of that type. A nonzero value means to do that; a zero value means all
1618 @code{enum} types should be allocated like @code{int}.
1620 If you don't define the macro, the default is 0.
1624 A C expression for a string describing the name of the data type to use
1625 for size values. The typedef name @code{size_t} is defined using the
1626 contents of the string.
1628 The string can contain more than one keyword. If so, separate them with
1629 spaces, and write first any length keyword, then @code{unsigned} if
1630 appropriate, and finally @code{int}. The string must exactly match one
1631 of the data type names defined in the function
1632 @code{init_decl_processing} in the file @file{c-decl.c}. You may not
1633 omit @code{int} or change the order---that would cause the compiler to
1636 If you don't define this macro, the default is @code{"long unsigned
1640 @defmac PTRDIFF_TYPE
1641 A C expression for a string describing the name of the data type to use
1642 for the result of subtracting two pointers. The typedef name
1643 @code{ptrdiff_t} is defined using the contents of the string. See
1644 @code{SIZE_TYPE} above for more information.
1646 If you don't define this macro, the default is @code{"long int"}.
1650 A C expression for a string describing the name of the data type to use
1651 for wide characters. The typedef name @code{wchar_t} is defined using
1652 the contents of the string. See @code{SIZE_TYPE} above for more
1655 If you don't define this macro, the default is @code{"int"}.
1658 @defmac WCHAR_TYPE_SIZE
1659 A C expression for the size in bits of the data type for wide
1660 characters. This is used in @code{cpp}, which cannot make use of
1664 @defmac MAX_WCHAR_TYPE_SIZE
1665 Maximum number for the size in bits of the data type for wide
1666 characters. If this is undefined, the default is
1667 @code{WCHAR_TYPE_SIZE}. Otherwise, it is the constant value that is the
1668 largest value that @code{WCHAR_TYPE_SIZE} can have at run-time. This is
1672 @defmac GCOV_TYPE_SIZE
1673 A C expression for the size in bits of the type used for gcov counters on the
1674 target machine. If you don't define this, the default is one
1675 @code{LONG_TYPE_SIZE} in case it is greater or equal to 64-bit and
1676 @code{LONG_LONG_TYPE_SIZE} otherwise. You may want to re-define the type to
1677 ensure atomicity for counters in multithreaded programs.
1681 A C expression for a string describing the name of the data type to
1682 use for wide characters passed to @code{printf} and returned from
1683 @code{getwc}. The typedef name @code{wint_t} is defined using the
1684 contents of the string. See @code{SIZE_TYPE} above for more
1687 If you don't define this macro, the default is @code{"unsigned int"}.
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 signed integer type.
1693 The typedef name @code{intmax_t} is defined using the contents of the
1694 string. See @code{SIZE_TYPE} above for more information.
1696 If you don't define this macro, the default is the first of
1697 @code{"int"}, @code{"long int"}, or @code{"long long int"} that has as
1698 much precision as @code{long long int}.
1701 @defmac UINTMAX_TYPE
1702 A C expression for a string describing the name of the data type that
1703 can represent any value of any standard or extended unsigned integer
1704 type. The typedef name @code{uintmax_t} is defined using the contents
1705 of the string. See @code{SIZE_TYPE} above for more information.
1707 If you don't define this macro, the default is the first of
1708 @code{"unsigned int"}, @code{"long unsigned int"}, or @code{"long long
1709 unsigned int"} that has as much precision as @code{long long unsigned
1713 @defmac TARGET_PTRMEMFUNC_VBIT_LOCATION
1714 The C++ compiler represents a pointer-to-member-function with a struct
1721 ptrdiff_t vtable_index;
1728 The C++ compiler must use one bit to indicate whether the function that
1729 will be called through a pointer-to-member-function is virtual.
1730 Normally, we assume that the low-order bit of a function pointer must
1731 always be zero. Then, by ensuring that the vtable_index is odd, we can
1732 distinguish which variant of the union is in use. But, on some
1733 platforms function pointers can be odd, and so this doesn't work. In
1734 that case, we use the low-order bit of the @code{delta} field, and shift
1735 the remainder of the @code{delta} field to the left.
1737 GCC will automatically make the right selection about where to store
1738 this bit using the @code{FUNCTION_BOUNDARY} setting for your platform.
1739 However, some platforms such as ARM/Thumb have @code{FUNCTION_BOUNDARY}
1740 set such that functions always start at even addresses, but the lowest
1741 bit of pointers to functions indicate whether the function at that
1742 address is in ARM or Thumb mode. If this is the case of your
1743 architecture, you should define this macro to
1744 @code{ptrmemfunc_vbit_in_delta}.
1746 In general, you should not have to define this macro. On architectures
1747 in which function addresses are always even, according to
1748 @code{FUNCTION_BOUNDARY}, GCC will automatically define this macro to
1749 @code{ptrmemfunc_vbit_in_pfn}.
1752 @defmac TARGET_VTABLE_USES_DESCRIPTORS
1753 Normally, the C++ compiler uses function pointers in vtables. This
1754 macro allows the target to change to use ``function descriptors''
1755 instead. Function descriptors are found on targets for whom a
1756 function pointer is actually a small data structure. Normally the
1757 data structure consists of the actual code address plus a data
1758 pointer to which the function's data is relative.
1760 If vtables are used, the value of this macro should be the number
1761 of words that the function descriptor occupies.
1764 @defmac TARGET_VTABLE_ENTRY_ALIGN
1765 By default, the vtable entries are void pointers, the so the alignment
1766 is the same as pointer alignment. The value of this macro specifies
1767 the alignment of the vtable entry in bits. It should be defined only
1768 when special alignment is necessary. */
1771 @defmac TARGET_VTABLE_DATA_ENTRY_DISTANCE
1772 There are a few non-descriptor entries in the vtable at offsets below
1773 zero. If these entries must be padded (say, to preserve the alignment
1774 specified by @code{TARGET_VTABLE_ENTRY_ALIGN}), set this to the number
1775 of words in each data entry.
1778 @node Escape Sequences
1779 @section Target Character Escape Sequences
1780 @cindex escape sequences
1782 By default, GCC assumes that the C character escape sequences take on
1783 their ASCII values for the target. If this is not correct, you must
1784 explicitly define all of the macros below. All of them must evaluate
1785 to constants; they are used in @code{case} statements.
1791 @findex TARGET_NEWLINE
1794 @multitable {@code{TARGET_NEWLINE}} {Escape} {ASCII character}
1795 @item Macro @tab Escape @tab ASCII character
1796 @item @code{TARGET_BELL} @tab @kbd{\a} @tab @code{07}, @code{BEL}
1797 @item @code{TARGET_CR} @tab @kbd{\r} @tab @code{0D}, @code{CR}
1798 @item @code{TARGET_ESC} @tab @kbd{\e}, @kbd{\E} @tab @code{1B}, @code{ESC}
1799 @item @code{TARGET_FF} @tab @kbd{\f} @tab @code{0C}, @code{FF}
1800 @item @code{TARGET_NEWLINE} @tab @kbd{\n} @tab @code{0A}, @code{LF}
1801 @item @code{TARGET_TAB} @tab @kbd{\t} @tab @code{09}, @code{HT}
1802 @item @code{TARGET_VT} @tab @kbd{\v} @tab @code{0B}, @code{VT}
1806 Note that the @kbd{\e} and @kbd{\E} escapes are GNU extensions, not
1807 part of the C standard.
1810 @section Register Usage
1811 @cindex register usage
1813 This section explains how to describe what registers the target machine
1814 has, and how (in general) they can be used.
1816 The description of which registers a specific instruction can use is
1817 done with register classes; see @ref{Register Classes}. For information
1818 on using registers to access a stack frame, see @ref{Frame Registers}.
1819 For passing values in registers, see @ref{Register Arguments}.
1820 For returning values in registers, see @ref{Scalar Return}.
1823 * Register Basics:: Number and kinds of registers.
1824 * Allocation Order:: Order in which registers are allocated.
1825 * Values in Registers:: What kinds of values each reg can hold.
1826 * Leaf Functions:: Renumbering registers for leaf functions.
1827 * Stack Registers:: Handling a register stack such as 80387.
1830 @node Register Basics
1831 @subsection Basic Characteristics of Registers
1833 @c prevent bad page break with this line
1834 Registers have various characteristics.
1836 @defmac FIRST_PSEUDO_REGISTER
1837 Number of hardware registers known to the compiler. They receive
1838 numbers 0 through @code{FIRST_PSEUDO_REGISTER-1}; thus, the first
1839 pseudo register's number really is assigned the number
1840 @code{FIRST_PSEUDO_REGISTER}.
1843 @defmac FIXED_REGISTERS
1844 @cindex fixed register
1845 An initializer that says which registers are used for fixed purposes
1846 all throughout the compiled code and are therefore not available for
1847 general allocation. These would include the stack pointer, the frame
1848 pointer (except on machines where that can be used as a general
1849 register when no frame pointer is needed), the program counter on
1850 machines where that is considered one of the addressable registers,
1851 and any other numbered register with a standard use.
1853 This information is expressed as a sequence of numbers, separated by
1854 commas and surrounded by braces. The @var{n}th number is 1 if
1855 register @var{n} is fixed, 0 otherwise.
1857 The table initialized from this macro, and the table initialized by
1858 the following one, may be overridden at run time either automatically,
1859 by the actions of the macro @code{CONDITIONAL_REGISTER_USAGE}, or by
1860 the user with the command options @option{-ffixed-@var{reg}},
1861 @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}.
1864 @defmac CALL_USED_REGISTERS
1865 @cindex call-used register
1866 @cindex call-clobbered register
1867 @cindex call-saved register
1868 Like @code{FIXED_REGISTERS} but has 1 for each register that is
1869 clobbered (in general) by function calls as well as for fixed
1870 registers. This macro therefore identifies the registers that are not
1871 available for general allocation of values that must live across
1874 If a register has 0 in @code{CALL_USED_REGISTERS}, the compiler
1875 automatically saves it on function entry and restores it on function
1876 exit, if the register is used within the function.
1879 @defmac CALL_REALLY_USED_REGISTERS
1880 @cindex call-used register
1881 @cindex call-clobbered register
1882 @cindex call-saved register
1883 Like @code{CALL_USED_REGISTERS} except this macro doesn't require
1884 that the entire set of @code{FIXED_REGISTERS} be included.
1885 (@code{CALL_USED_REGISTERS} must be a superset of @code{FIXED_REGISTERS}).
1886 This macro is optional. If not specified, it defaults to the value
1887 of @code{CALL_USED_REGISTERS}.
1890 @defmac HARD_REGNO_CALL_PART_CLOBBERED (@var{regno}, @var{mode})
1891 @cindex call-used register
1892 @cindex call-clobbered register
1893 @cindex call-saved register
1894 A C expression that is nonzero if it is not permissible to store a
1895 value of mode @var{mode} in hard register number @var{regno} across a
1896 call without some part of it being clobbered. For most machines this
1897 macro need not be defined. It is only required for machines that do not
1898 preserve the entire contents of a register across a call.
1902 @findex call_used_regs
1905 @findex reg_class_contents
1906 @defmac CONDITIONAL_REGISTER_USAGE
1907 Zero or more C statements that may conditionally modify five variables
1908 @code{fixed_regs}, @code{call_used_regs}, @code{global_regs},
1909 @code{reg_names}, and @code{reg_class_contents}, to take into account
1910 any dependence of these register sets on target flags. The first three
1911 of these are of type @code{char []} (interpreted as Boolean vectors).
1912 @code{global_regs} is a @code{const char *[]}, and
1913 @code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is
1914 called, @code{fixed_regs}, @code{call_used_regs},
1915 @code{reg_class_contents}, and @code{reg_names} have been initialized
1916 from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},
1917 @code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.
1918 @code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},
1919 @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}
1920 command options have been applied.
1922 You need not define this macro if it has no work to do.
1924 @cindex disabling certain registers
1925 @cindex controlling register usage
1926 If the usage of an entire class of registers depends on the target
1927 flags, you may indicate this to GCC by using this macro to modify
1928 @code{fixed_regs} and @code{call_used_regs} to 1 for each of the
1929 registers in the classes which should not be used by GCC@. Also define
1930 the macro @code{REG_CLASS_FROM_LETTER} / @code{REG_CLASS_FROM_CONSTRAINT}
1931 to return @code{NO_REGS} if it
1932 is called with a letter for a class that shouldn't be used.
1934 (However, if this class is not included in @code{GENERAL_REGS} and all
1935 of the insn patterns whose constraints permit this class are
1936 controlled by target switches, then GCC will automatically avoid using
1937 these registers when the target switches are opposed to them.)
1940 @defmac NON_SAVING_SETJMP
1941 If this macro is defined and has a nonzero value, it means that
1942 @code{setjmp} and related functions fail to save the registers, or that
1943 @code{longjmp} fails to restore them. To compensate, the compiler
1944 avoids putting variables in registers in functions that use
1948 @defmac INCOMING_REGNO (@var{out})
1949 Define this macro if the target machine has register windows. This C
1950 expression returns the register number as seen by the called function
1951 corresponding to the register number @var{out} as seen by the calling
1952 function. Return @var{out} if register number @var{out} is not an
1956 @defmac OUTGOING_REGNO (@var{in})
1957 Define this macro if the target machine has register windows. This C
1958 expression returns the register number as seen by the calling function
1959 corresponding to the register number @var{in} as seen by the called
1960 function. Return @var{in} if register number @var{in} is not an inbound
1964 @defmac LOCAL_REGNO (@var{regno})
1965 Define this macro if the target machine has register windows. This C
1966 expression returns true if the register is call-saved but is in the
1967 register window. Unlike most call-saved registers, such registers
1968 need not be explicitly restored on function exit or during non-local
1973 If the program counter has a register number, define this as that
1974 register number. Otherwise, do not define it.
1977 @node Allocation Order
1978 @subsection Order of Allocation of Registers
1979 @cindex order of register allocation
1980 @cindex register allocation order
1982 @c prevent bad page break with this line
1983 Registers are allocated in order.
1985 @defmac REG_ALLOC_ORDER
1986 If defined, an initializer for a vector of integers, containing the
1987 numbers of hard registers in the order in which GCC should prefer
1988 to use them (from most preferred to least).
1990 If this macro is not defined, registers are used lowest numbered first
1991 (all else being equal).
1993 One use of this macro is on machines where the highest numbered
1994 registers must always be saved and the save-multiple-registers
1995 instruction supports only sequences of consecutive registers. On such
1996 machines, define @code{REG_ALLOC_ORDER} to be an initializer that lists
1997 the highest numbered allocable register first.
2000 @defmac ORDER_REGS_FOR_LOCAL_ALLOC
2001 A C statement (sans semicolon) to choose the order in which to allocate
2002 hard registers for pseudo-registers local to a basic block.
2004 Store the desired register order in the array @code{reg_alloc_order}.
2005 Element 0 should be the register to allocate first; element 1, the next
2006 register; and so on.
2008 The macro body should not assume anything about the contents of
2009 @code{reg_alloc_order} before execution of the macro.
2011 On most machines, it is not necessary to define this macro.
2014 @node Values in Registers
2015 @subsection How Values Fit in Registers
2017 This section discusses the macros that describe which kinds of values
2018 (specifically, which machine modes) each register can hold, and how many
2019 consecutive registers are needed for a given mode.
2021 @defmac HARD_REGNO_NREGS (@var{regno}, @var{mode})
2022 A C expression for the number of consecutive hard registers, starting
2023 at register number @var{regno}, required to hold a value of mode
2026 On a machine where all registers are exactly one word, a suitable
2027 definition of this macro is
2030 #define HARD_REGNO_NREGS(REGNO, MODE) \
2031 ((GET_MODE_SIZE (MODE) + UNITS_PER_WORD - 1) \
2036 @defmac HARD_REGNO_MODE_OK (@var{regno}, @var{mode})
2037 A C expression that is nonzero if it is permissible to store a value
2038 of mode @var{mode} in hard register number @var{regno} (or in several
2039 registers starting with that one). For a machine where all registers
2040 are equivalent, a suitable definition is
2043 #define HARD_REGNO_MODE_OK(REGNO, MODE) 1
2046 You need not include code to check for the numbers of fixed registers,
2047 because the allocation mechanism considers them to be always occupied.
2049 @cindex register pairs
2050 On some machines, double-precision values must be kept in even/odd
2051 register pairs. You can implement that by defining this macro to reject
2052 odd register numbers for such modes.
2054 The minimum requirement for a mode to be OK in a register is that the
2055 @samp{mov@var{mode}} instruction pattern support moves between the
2056 register and other hard register in the same class and that moving a
2057 value into the register and back out not alter it.
2059 Since the same instruction used to move @code{word_mode} will work for
2060 all narrower integer modes, it is not necessary on any machine for
2061 @code{HARD_REGNO_MODE_OK} to distinguish between these modes, provided
2062 you define patterns @samp{movhi}, etc., to take advantage of this. This
2063 is useful because of the interaction between @code{HARD_REGNO_MODE_OK}
2064 and @code{MODES_TIEABLE_P}; it is very desirable for all integer modes
2067 Many machines have special registers for floating point arithmetic.
2068 Often people assume that floating point machine modes are allowed only
2069 in floating point registers. This is not true. Any registers that
2070 can hold integers can safely @emph{hold} a floating point machine
2071 mode, whether or not floating arithmetic can be done on it in those
2072 registers. Integer move instructions can be used to move the values.
2074 On some machines, though, the converse is true: fixed-point machine
2075 modes may not go in floating registers. This is true if the floating
2076 registers normalize any value stored in them, because storing a
2077 non-floating value there would garble it. In this case,
2078 @code{HARD_REGNO_MODE_OK} should reject fixed-point machine modes in
2079 floating registers. But if the floating registers do not automatically
2080 normalize, if you can store any bit pattern in one and retrieve it
2081 unchanged without a trap, then any machine mode may go in a floating
2082 register, so you can define this macro to say so.
2084 The primary significance of special floating registers is rather that
2085 they are the registers acceptable in floating point arithmetic
2086 instructions. However, this is of no concern to
2087 @code{HARD_REGNO_MODE_OK}. You handle it by writing the proper
2088 constraints for those instructions.
2090 On some machines, the floating registers are especially slow to access,
2091 so that it is better to store a value in a stack frame than in such a
2092 register if floating point arithmetic is not being done. As long as the
2093 floating registers are not in class @code{GENERAL_REGS}, they will not
2094 be used unless some pattern's constraint asks for one.
2097 @defmac MODES_TIEABLE_P (@var{mode1}, @var{mode2})
2098 A C expression that is nonzero if a value of mode
2099 @var{mode1} is accessible in mode @var{mode2} without copying.
2101 If @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and
2102 @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always the same for
2103 any @var{r}, then @code{MODES_TIEABLE_P (@var{mode1}, @var{mode2})}
2104 should be nonzero. If they differ for any @var{r}, you should define
2105 this macro to return zero unless some other mechanism ensures the
2106 accessibility of the value in a narrower mode.
2108 You should define this macro to return nonzero in as many cases as
2109 possible since doing so will allow GCC to perform better register
2113 @defmac AVOID_CCMODE_COPIES
2114 Define this macro if the compiler should avoid copies to/from @code{CCmode}
2115 registers. You should only define this macro if support for copying to/from
2116 @code{CCmode} is incomplete.
2119 @node Leaf Functions
2120 @subsection Handling Leaf Functions
2122 @cindex leaf functions
2123 @cindex functions, leaf
2124 On some machines, a leaf function (i.e., one which makes no calls) can run
2125 more efficiently if it does not make its own register window. Often this
2126 means it is required to receive its arguments in the registers where they
2127 are passed by the caller, instead of the registers where they would
2130 The special treatment for leaf functions generally applies only when
2131 other conditions are met; for example, often they may use only those
2132 registers for its own variables and temporaries. We use the term ``leaf
2133 function'' to mean a function that is suitable for this special
2134 handling, so that functions with no calls are not necessarily ``leaf
2137 GCC assigns register numbers before it knows whether the function is
2138 suitable for leaf function treatment. So it needs to renumber the
2139 registers in order to output a leaf function. The following macros
2142 @defmac LEAF_REGISTERS
2143 Name of a char vector, indexed by hard register number, which
2144 contains 1 for a register that is allowable in a candidate for leaf
2147 If leaf function treatment involves renumbering the registers, then the
2148 registers marked here should be the ones before renumbering---those that
2149 GCC would ordinarily allocate. The registers which will actually be
2150 used in the assembler code, after renumbering, should not be marked with 1
2153 Define this macro only if the target machine offers a way to optimize
2154 the treatment of leaf functions.
2157 @defmac LEAF_REG_REMAP (@var{regno})
2158 A C expression whose value is the register number to which @var{regno}
2159 should be renumbered, when a function is treated as a leaf function.
2161 If @var{regno} is a register number which should not appear in a leaf
2162 function before renumbering, then the expression should yield @minus{}1, which
2163 will cause the compiler to abort.
2165 Define this macro only if the target machine offers a way to optimize the
2166 treatment of leaf functions, and registers need to be renumbered to do
2170 @findex current_function_is_leaf
2171 @findex current_function_uses_only_leaf_regs
2172 @code{TARGET_ASM_FUNCTION_PROLOGUE} and
2173 @code{TARGET_ASM_FUNCTION_EPILOGUE} must usually treat leaf functions
2174 specially. They can test the C variable @code{current_function_is_leaf}
2175 which is nonzero for leaf functions. @code{current_function_is_leaf} is
2176 set prior to local register allocation and is valid for the remaining
2177 compiler passes. They can also test the C variable
2178 @code{current_function_uses_only_leaf_regs} which is nonzero for leaf
2179 functions which only use leaf registers.
2180 @code{current_function_uses_only_leaf_regs} is valid after reload and is
2181 only useful if @code{LEAF_REGISTERS} is defined.
2182 @c changed this to fix overfull. ALSO: why the "it" at the beginning
2183 @c of the next paragraph?! --mew 2feb93
2185 @node Stack Registers
2186 @subsection Registers That Form a Stack
2188 There are special features to handle computers where some of the
2189 ``registers'' form a stack. Stack registers are normally written by
2190 pushing onto the stack, and are numbered relative to the top of the
2193 Currently, GCC can only handle one group of stack-like registers, and
2194 they must be consecutively numbered. Furthermore, the existing
2195 support for stack-like registers is specific to the 80387 floating
2196 point coprocessor. If you have a new architecture that uses
2197 stack-like registers, you will need to do substantial work on
2198 @file{reg-stack.c} and write your machine description to cooperate
2199 with it, as well as defining these macros.
2202 Define this if the machine has any stack-like registers.
2205 @defmac FIRST_STACK_REG
2206 The number of the first stack-like register. This one is the top
2210 @defmac LAST_STACK_REG
2211 The number of the last stack-like register. This one is the bottom of
2215 @node Register Classes
2216 @section Register Classes
2217 @cindex register class definitions
2218 @cindex class definitions, register
2220 On many machines, the numbered registers are not all equivalent.
2221 For example, certain registers may not be allowed for indexed addressing;
2222 certain registers may not be allowed in some instructions. These machine
2223 restrictions are described to the compiler using @dfn{register classes}.
2225 You define a number of register classes, giving each one a name and saying
2226 which of the registers belong to it. Then you can specify register classes
2227 that are allowed as operands to particular instruction patterns.
2231 In general, each register will belong to several classes. In fact, one
2232 class must be named @code{ALL_REGS} and contain all the registers. Another
2233 class must be named @code{NO_REGS} and contain no registers. Often the
2234 union of two classes will be another class; however, this is not required.
2236 @findex GENERAL_REGS
2237 One of the classes must be named @code{GENERAL_REGS}. There is nothing
2238 terribly special about the name, but the operand constraint letters
2239 @samp{r} and @samp{g} specify this class. If @code{GENERAL_REGS} is
2240 the same as @code{ALL_REGS}, just define it as a macro which expands
2243 Order the classes so that if class @var{x} is contained in class @var{y}
2244 then @var{x} has a lower class number than @var{y}.
2246 The way classes other than @code{GENERAL_REGS} are specified in operand
2247 constraints is through machine-dependent operand constraint letters.
2248 You can define such letters to correspond to various classes, then use
2249 them in operand constraints.
2251 You should define a class for the union of two classes whenever some
2252 instruction allows both classes. For example, if an instruction allows
2253 either a floating point (coprocessor) register or a general register for a
2254 certain operand, you should define a class @code{FLOAT_OR_GENERAL_REGS}
2255 which includes both of them. Otherwise you will get suboptimal code.
2257 You must also specify certain redundant information about the register
2258 classes: for each class, which classes contain it and which ones are
2259 contained in it; for each pair of classes, the largest class contained
2262 When a value occupying several consecutive registers is expected in a
2263 certain class, all the registers used must belong to that class.
2264 Therefore, register classes cannot be used to enforce a requirement for
2265 a register pair to start with an even-numbered register. The way to
2266 specify this requirement is with @code{HARD_REGNO_MODE_OK}.
2268 Register classes used for input-operands of bitwise-and or shift
2269 instructions have a special requirement: each such class must have, for
2270 each fixed-point machine mode, a subclass whose registers can transfer that
2271 mode to or from memory. For example, on some machines, the operations for
2272 single-byte values (@code{QImode}) are limited to certain registers. When
2273 this is so, each register class that is used in a bitwise-and or shift
2274 instruction must have a subclass consisting of registers from which
2275 single-byte values can be loaded or stored. This is so that
2276 @code{PREFERRED_RELOAD_CLASS} can always have a possible value to return.
2278 @deftp {Data type} {enum reg_class}
2279 An enumeral type that must be defined with all the register class names
2280 as enumeral values. @code{NO_REGS} must be first. @code{ALL_REGS}
2281 must be the last register class, followed by one more enumeral value,
2282 @code{LIM_REG_CLASSES}, which is not a register class but rather
2283 tells how many classes there are.
2285 Each register class has a number, which is the value of casting
2286 the class name to type @code{int}. The number serves as an index
2287 in many of the tables described below.
2290 @defmac N_REG_CLASSES
2291 The number of distinct register classes, defined as follows:
2294 #define N_REG_CLASSES (int) LIM_REG_CLASSES
2298 @defmac REG_CLASS_NAMES
2299 An initializer containing the names of the register classes as C string
2300 constants. These names are used in writing some of the debugging dumps.
2303 @defmac REG_CLASS_CONTENTS
2304 An initializer containing the contents of the register classes, as integers
2305 which are bit masks. The @var{n}th integer specifies the contents of class
2306 @var{n}. The way the integer @var{mask} is interpreted is that
2307 register @var{r} is in the class if @code{@var{mask} & (1 << @var{r})} is 1.
2309 When the machine has more than 32 registers, an integer does not suffice.
2310 Then the integers are replaced by sub-initializers, braced groupings containing
2311 several integers. Each sub-initializer must be suitable as an initializer
2312 for the type @code{HARD_REG_SET} which is defined in @file{hard-reg-set.h}.
2313 In this situation, the first integer in each sub-initializer corresponds to
2314 registers 0 through 31, the second integer to registers 32 through 63, and
2318 @defmac REGNO_REG_CLASS (@var{regno})
2319 A C expression whose value is a register class containing hard register
2320 @var{regno}. In general there is more than one such class; choose a class
2321 which is @dfn{minimal}, meaning that no smaller class also contains the
2325 @defmac BASE_REG_CLASS
2326 A macro whose definition is the name of the class to which a valid
2327 base register must belong. A base register is one used in an address
2328 which is the register value plus a displacement.
2331 @defmac MODE_BASE_REG_CLASS (@var{mode})
2332 This is a variation of the @code{BASE_REG_CLASS} macro which allows
2333 the selection of a base register in a mode dependent manner. If
2334 @var{mode} is VOIDmode then it should return the same value as
2335 @code{BASE_REG_CLASS}.
2338 @defmac INDEX_REG_CLASS
2339 A macro whose definition is the name of the class to which a valid
2340 index register must belong. An index register is one used in an
2341 address where its value is either multiplied by a scale factor or
2342 added to another register (as well as added to a displacement).
2345 @defmac CONSTRAINT_LEN (@var{char}, @var{str})
2346 For the constraint at the start of @var{str}, which starts with the letter
2347 @var{c}, return the length. This allows you to have register class /
2348 constant / extra constraints that are longer than a single letter;
2349 you don't need to define this macro if you can do with single-letter
2350 constraints only. The definition of this macro should use
2351 DEFAULT_CONSTRAINT_LEN for all the characters that you don't want
2352 to handle specially.
2353 There are some sanity checks in genoutput.c that check the constraint lengths
2354 for the md file, so you can also use this macro to help you while you are
2355 transitioning from a byzantine single-letter-constraint scheme: when you
2356 return a negative length for a constraint you want to re-use, genoutput
2357 will complain about every instance where it is used in the md file.
2360 @defmac REG_CLASS_FROM_LETTER (@var{char})
2361 A C expression which defines the machine-dependent operand constraint
2362 letters for register classes. If @var{char} is such a letter, the
2363 value should be the register class corresponding to it. Otherwise,
2364 the value should be @code{NO_REGS}. The register letter @samp{r},
2365 corresponding to class @code{GENERAL_REGS}, will not be passed
2366 to this macro; you do not need to handle it.
2369 @defmac REG_CLASS_FROM_CONSTRAINT (@var{char}, @var{str})
2370 Like @code{REG_CLASS_FROM_LETTER}, but you also get the constraint string
2371 passed in @var{str}, so that you can use suffixes to distinguish between
2375 @defmac REGNO_OK_FOR_BASE_P (@var{num})
2376 A C expression which is nonzero if register number @var{num} is
2377 suitable for use as a base register in operand addresses. It may be
2378 either a suitable hard register or a pseudo register that has been
2379 allocated such a hard register.
2382 @defmac REGNO_MODE_OK_FOR_BASE_P (@var{num}, @var{mode})
2383 A C expression that is just like @code{REGNO_OK_FOR_BASE_P}, except that
2384 that expression may examine the mode of the memory reference in
2385 @var{mode}. You should define this macro if the mode of the memory
2386 reference affects whether a register may be used as a base register. If
2387 you define this macro, the compiler will use it instead of
2388 @code{REGNO_OK_FOR_BASE_P}.
2391 @defmac REGNO_OK_FOR_INDEX_P (@var{num})
2392 A C expression which is nonzero if register number @var{num} is
2393 suitable for use as an index register in operand addresses. It may be
2394 either a suitable hard register or a pseudo register that has been
2395 allocated such a hard register.
2397 The difference between an index register and a base register is that
2398 the index register may be scaled. If an address involves the sum of
2399 two registers, neither one of them scaled, then either one may be
2400 labeled the ``base'' and the other the ``index''; but whichever
2401 labeling is used must fit the machine's constraints of which registers
2402 may serve in each capacity. The compiler will try both labelings,
2403 looking for one that is valid, and will reload one or both registers
2404 only if neither labeling works.
2407 @defmac PREFERRED_RELOAD_CLASS (@var{x}, @var{class})
2408 A C expression that places additional restrictions on the register class
2409 to use when it is necessary to copy value @var{x} into a register in class
2410 @var{class}. The value is a register class; perhaps @var{class}, or perhaps
2411 another, smaller class. On many machines, the following definition is
2415 #define PREFERRED_RELOAD_CLASS(X,CLASS) CLASS
2418 Sometimes returning a more restrictive class makes better code. For
2419 example, on the 68000, when @var{x} is an integer constant that is in range
2420 for a @samp{moveq} instruction, the value of this macro is always
2421 @code{DATA_REGS} as long as @var{class} includes the data registers.
2422 Requiring a data register guarantees that a @samp{moveq} will be used.
2424 If @var{x} is a @code{const_double}, by returning @code{NO_REGS}
2425 you can force @var{x} into a memory constant. This is useful on
2426 certain machines where immediate floating values cannot be loaded into
2427 certain kinds of registers.
2430 @defmac PREFERRED_OUTPUT_RELOAD_CLASS (@var{x}, @var{class})
2431 Like @code{PREFERRED_RELOAD_CLASS}, but for output reloads instead of
2432 input reloads. If you don't define this macro, the default is to use
2433 @var{class}, unchanged.
2436 @defmac LIMIT_RELOAD_CLASS (@var{mode}, @var{class})
2437 A C expression that places additional restrictions on the register class
2438 to use when it is necessary to be able to hold a value of mode
2439 @var{mode} in a reload register for which class @var{class} would
2442 Unlike @code{PREFERRED_RELOAD_CLASS}, this macro should be used when
2443 there are certain modes that simply can't go in certain reload classes.
2445 The value is a register class; perhaps @var{class}, or perhaps another,
2448 Don't define this macro unless the target machine has limitations which
2449 require the macro to do something nontrivial.
2452 @defmac SECONDARY_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2453 @defmacx SECONDARY_INPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2454 @defmacx SECONDARY_OUTPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2455 Many machines have some registers that cannot be copied directly to or
2456 from memory or even from other types of registers. An example is the
2457 @samp{MQ} register, which on most machines, can only be copied to or
2458 from general registers, but not memory. Some machines allow copying all
2459 registers to and from memory, but require a scratch register for stores
2460 to some memory locations (e.g., those with symbolic address on the RT,
2461 and those with certain symbolic address on the SPARC when compiling
2462 PIC)@. In some cases, both an intermediate and a scratch register are
2465 You should define these macros to indicate to the reload phase that it may
2466 need to allocate at least one register for a reload in addition to the
2467 register to contain the data. Specifically, if copying @var{x} to a
2468 register @var{class} in @var{mode} requires an intermediate register,
2469 you should define @code{SECONDARY_INPUT_RELOAD_CLASS} to return the
2470 largest register class all of whose registers can be used as
2471 intermediate registers or scratch registers.
2473 If copying a register @var{class} in @var{mode} to @var{x} requires an
2474 intermediate or scratch register, @code{SECONDARY_OUTPUT_RELOAD_CLASS}
2475 should be defined to return the largest register class required. If the
2476 requirements for input and output reloads are the same, the macro
2477 @code{SECONDARY_RELOAD_CLASS} should be used instead of defining both
2480 The values returned by these macros are often @code{GENERAL_REGS}.
2481 Return @code{NO_REGS} if no spare register is needed; i.e., if @var{x}
2482 can be directly copied to or from a register of @var{class} in
2483 @var{mode} without requiring a scratch register. Do not define this
2484 macro if it would always return @code{NO_REGS}.
2486 If a scratch register is required (either with or without an
2487 intermediate register), you should define patterns for
2488 @samp{reload_in@var{m}} or @samp{reload_out@var{m}}, as required
2489 (@pxref{Standard Names}. These patterns, which will normally be
2490 implemented with a @code{define_expand}, should be similar to the
2491 @samp{mov@var{m}} patterns, except that operand 2 is the scratch
2494 Define constraints for the reload register and scratch register that
2495 contain a single register class. If the original reload register (whose
2496 class is @var{class}) can meet the constraint given in the pattern, the
2497 value returned by these macros is used for the class of the scratch
2498 register. Otherwise, two additional reload registers are required.
2499 Their classes are obtained from the constraints in the insn pattern.
2501 @var{x} might be a pseudo-register or a @code{subreg} of a
2502 pseudo-register, which could either be in a hard register or in memory.
2503 Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is
2504 in memory and the hard register number if it is in a register.
2506 These macros should not be used in the case where a particular class of
2507 registers can only be copied to memory and not to another class of
2508 registers. In that case, secondary reload registers are not needed and
2509 would not be helpful. Instead, a stack location must be used to perform
2510 the copy and the @code{mov@var{m}} pattern should use memory as an
2511 intermediate storage. This case often occurs between floating-point and
2515 @defmac SECONDARY_MEMORY_NEEDED (@var{class1}, @var{class2}, @var{m})
2516 Certain machines have the property that some registers cannot be copied
2517 to some other registers without using memory. Define this macro on
2518 those machines to be a C expression that is nonzero if objects of mode
2519 @var{m} in registers of @var{class1} can only be copied to registers of
2520 class @var{class2} by storing a register of @var{class1} into memory
2521 and loading that memory location into a register of @var{class2}.
2523 Do not define this macro if its value would always be zero.
2526 @defmac SECONDARY_MEMORY_NEEDED_RTX (@var{mode})
2527 Normally when @code{SECONDARY_MEMORY_NEEDED} is defined, the compiler
2528 allocates a stack slot for a memory location needed for register copies.
2529 If this macro is defined, the compiler instead uses the memory location
2530 defined by this macro.
2532 Do not define this macro if you do not define
2533 @code{SECONDARY_MEMORY_NEEDED}.
2536 @defmac SECONDARY_MEMORY_NEEDED_MODE (@var{mode})
2537 When the compiler needs a secondary memory location to copy between two
2538 registers of mode @var{mode}, it normally allocates sufficient memory to
2539 hold a quantity of @code{BITS_PER_WORD} bits and performs the store and
2540 load operations in a mode that many bits wide and whose class is the
2541 same as that of @var{mode}.
2543 This is right thing to do on most machines because it ensures that all
2544 bits of the register are copied and prevents accesses to the registers
2545 in a narrower mode, which some machines prohibit for floating-point
2548 However, this default behavior is not correct on some machines, such as
2549 the DEC Alpha, that store short integers in floating-point registers
2550 differently than in integer registers. On those machines, the default
2551 widening will not work correctly and you must define this macro to
2552 suppress that widening in some cases. See the file @file{alpha.h} for
2555 Do not define this macro if you do not define
2556 @code{SECONDARY_MEMORY_NEEDED} or if widening @var{mode} to a mode that
2557 is @code{BITS_PER_WORD} bits wide is correct for your machine.
2560 @defmac SMALL_REGISTER_CLASSES
2561 On some machines, it is risky to let hard registers live across arbitrary
2562 insns. Typically, these machines have instructions that require values
2563 to be in specific registers (like an accumulator), and reload will fail
2564 if the required hard register is used for another purpose across such an
2567 Define @code{SMALL_REGISTER_CLASSES} to be an expression with a nonzero
2568 value on these machines. When this macro has a nonzero value, the
2569 compiler will try to minimize the lifetime of hard registers.
2571 It is always safe to define this macro with a nonzero value, but if you
2572 unnecessarily define it, you will reduce the amount of optimizations
2573 that can be performed in some cases. If you do not define this macro
2574 with a nonzero value when it is required, the compiler will run out of
2575 spill registers and print a fatal error message. For most machines, you
2576 should not define this macro at all.
2579 @defmac CLASS_LIKELY_SPILLED_P (@var{class})
2580 A C expression whose value is nonzero if pseudos that have been assigned
2581 to registers of class @var{class} would likely be spilled because
2582 registers of @var{class} are needed for spill registers.
2584 The default value of this macro returns 1 if @var{class} has exactly one
2585 register and zero otherwise. On most machines, this default should be
2586 used. Only define this macro to some other expression if pseudos
2587 allocated by @file{local-alloc.c} end up in memory because their hard
2588 registers were needed for spill registers. If this macro returns nonzero
2589 for those classes, those pseudos will only be allocated by
2590 @file{global.c}, which knows how to reallocate the pseudo to another
2591 register. If there would not be another register available for
2592 reallocation, you should not change the definition of this macro since
2593 the only effect of such a definition would be to slow down register
2597 @defmac CLASS_MAX_NREGS (@var{class}, @var{mode})
2598 A C expression for the maximum number of consecutive registers
2599 of class @var{class} needed to hold a value of mode @var{mode}.
2601 This is closely related to the macro @code{HARD_REGNO_NREGS}. In fact,
2602 the value of the macro @code{CLASS_MAX_NREGS (@var{class}, @var{mode})}
2603 should be the maximum value of @code{HARD_REGNO_NREGS (@var{regno},
2604 @var{mode})} for all @var{regno} values in the class @var{class}.
2606 This macro helps control the handling of multiple-word values
2610 @defmac CANNOT_CHANGE_MODE_CLASS (@var{from}, @var{to}, @var{class})
2611 If defined, a C expression that returns nonzero for a @var{class} for which
2612 a change from mode @var{from} to mode @var{to} is invalid.
2614 For the example, loading 32-bit integer or floating-point objects into
2615 floating-point registers on the Alpha extends them to 64 bits.
2616 Therefore loading a 64-bit object and then storing it as a 32-bit object
2617 does not store the low-order 32 bits, as would be the case for a normal
2618 register. Therefore, @file{alpha.h} defines @code{CANNOT_CHANGE_MODE_CLASS}
2622 #define CANNOT_CHANGE_MODE_CLASS(FROM, TO, CLASS) \
2623 (GET_MODE_SIZE (FROM) != GET_MODE_SIZE (TO) \
2624 ? reg_classes_intersect_p (FLOAT_REGS, (CLASS)) : 0)
2628 Three other special macros describe which operands fit which constraint
2631 @defmac CONST_OK_FOR_LETTER_P (@var{value}, @var{c})
2632 A C expression that defines the machine-dependent operand constraint
2633 letters (@samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}) that specify
2634 particular ranges of integer values. If @var{c} is one of those
2635 letters, the expression should check that @var{value}, an integer, is in
2636 the appropriate range and return 1 if so, 0 otherwise. If @var{c} is
2637 not one of those letters, the value should be 0 regardless of
2641 @defmac CONST_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str})
2642 Like @code{CONST_OK_FOR_LETTER_P}, but you also get the constraint
2643 string passed in @var{str}, so that you can use suffixes to distinguish
2644 between different variants.
2647 @defmac CONST_DOUBLE_OK_FOR_LETTER_P (@var{value}, @var{c})
2648 A C expression that defines the machine-dependent operand constraint
2649 letters that specify particular ranges of @code{const_double} values
2650 (@samp{G} or @samp{H}).
2652 If @var{c} is one of those letters, the expression should check that
2653 @var{value}, an RTX of code @code{const_double}, is in the appropriate
2654 range and return 1 if so, 0 otherwise. If @var{c} is not one of those
2655 letters, the value should be 0 regardless of @var{value}.
2657 @code{const_double} is used for all floating-point constants and for
2658 @code{DImode} fixed-point constants. A given letter can accept either
2659 or both kinds of values. It can use @code{GET_MODE} to distinguish
2660 between these kinds.
2663 @defmac CONST_DOUBLE_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str})
2664 Like @code{CONST_DOUBLE_OK_FOR_LETTER_P}, but you also get the constraint
2665 string passed in @var{str}, so that you can use suffixes to distinguish
2666 between different variants.
2669 @defmac EXTRA_CONSTRAINT (@var{value}, @var{c})
2670 A C expression that defines the optional machine-dependent constraint
2671 letters that can be used to segregate specific types of operands, usually
2672 memory references, for the target machine. Any letter that is not
2673 elsewhere defined and not matched by @code{REG_CLASS_FROM_LETTER} /
2674 @code{REG_CLASS_FROM_CONSTRAINT}
2675 may be used. Normally this macro will not be defined.
2677 If it is required for a particular target machine, it should return 1
2678 if @var{value} corresponds to the operand type represented by the
2679 constraint letter @var{c}. If @var{c} is not defined as an extra
2680 constraint, the value returned should be 0 regardless of @var{value}.
2682 For example, on the ROMP, load instructions cannot have their output
2683 in r0 if the memory reference contains a symbolic address. Constraint
2684 letter @samp{Q} is defined as representing a memory address that does
2685 @emph{not} contain a symbolic address. An alternative is specified with
2686 a @samp{Q} constraint on the input and @samp{r} on the output. The next
2687 alternative specifies @samp{m} on the input and a register class that
2688 does not include r0 on the output.
2691 @defmac EXTRA_CONSTRAINT_STR (@var{value}, @var{c}, @var{str})
2692 Like @code{EXTRA_CONSTRAINT}, but you also get the constraint string passed
2693 in @var{str}, so that you can use suffixes to distinguish between different
2697 @defmac EXTRA_MEMORY_CONSTRAINT (@var{c}, @var{str})
2698 A C expression that defines the optional machine-dependent constraint
2699 letters, amongst those accepted by @code{EXTRA_CONSTRAINT}, that should
2700 be treated like memory constraints by the reload pass.
2702 It should return 1 if the operand type represented by the constraint
2703 at the start of @var{str}, the first letter of which is the letter @var{c},
2704 comprises a subset of all memory references including
2705 all those whose address is simply a base register. This allows the reload
2706 pass to reload an operand, if it does not directly correspond to the operand
2707 type of @var{c}, by copying its address into a base register.
2709 For example, on the S/390, some instructions do not accept arbitrary
2710 memory references, but only those that do not make use of an index
2711 register. The constraint letter @samp{Q} is defined via
2712 @code{EXTRA_CONSTRAINT} as representing a memory address of this type.
2713 If the letter @samp{Q} is marked as @code{EXTRA_MEMORY_CONSTRAINT},
2714 a @samp{Q} constraint can handle any memory operand, because the
2715 reload pass knows it can be reloaded by copying the memory address
2716 into a base register if required. This is analogous to the way
2717 a @samp{o} constraint can handle any memory operand.
2720 @defmac EXTRA_ADDRESS_CONSTRAINT (@var{c}, @var{str})
2721 A C expression that defines the optional machine-dependent constraint
2722 letters, amongst those accepted by @code{EXTRA_CONSTRAINT} /
2723 @code{EXTRA_CONSTRAINT_STR}, that should
2724 be treated like address constraints by the reload pass.
2726 It should return 1 if the operand type represented by the constraint
2727 at the start of @var{str}, which starts with the letter @var{c}, comprises
2728 a subset of all memory addresses including
2729 all those that consist of just a base register. This allows the reload
2730 pass to reload an operand, if it does not directly correspond to the operand
2731 type of @var{str}, by copying it into a base register.
2733 Any constraint marked as @code{EXTRA_ADDRESS_CONSTRAINT} can only
2734 be used with the @code{address_operand} predicate. It is treated
2735 analogously to the @samp{p} constraint.
2738 @node Stack and Calling
2739 @section Stack Layout and Calling Conventions
2740 @cindex calling conventions
2742 @c prevent bad page break with this line
2743 This describes the stack layout and calling conventions.
2747 * Exception Handling::
2752 * Register Arguments::
2754 * Aggregate Return::
2762 @subsection Basic Stack Layout
2763 @cindex stack frame layout
2764 @cindex frame layout
2766 @c prevent bad page break with this line
2767 Here is the basic stack layout.
2769 @defmac STACK_GROWS_DOWNWARD
2770 Define this macro if pushing a word onto the stack moves the stack
2771 pointer to a smaller address.
2773 When we say, ``define this macro if @dots{},'' it means that the
2774 compiler checks this macro only with @code{#ifdef} so the precise
2775 definition used does not matter.
2778 @defmac STACK_PUSH_CODE
2779 This macro defines the operation used when something is pushed
2780 on the stack. In RTL, a push operation will be
2781 @code{(set (mem (STACK_PUSH_CODE (reg sp))) @dots{})}
2783 The choices are @code{PRE_DEC}, @code{POST_DEC}, @code{PRE_INC},
2784 and @code{POST_INC}. Which of these is correct depends on
2785 the stack direction and on whether the stack pointer points
2786 to the last item on the stack or whether it points to the
2787 space for the next item on the stack.
2789 The default is @code{PRE_DEC} when @code{STACK_GROWS_DOWNWARD} is
2790 defined, which is almost always right, and @code{PRE_INC} otherwise,
2791 which is often wrong.
2794 @defmac FRAME_GROWS_DOWNWARD
2795 Define this macro if the addresses of local variable slots are at negative
2796 offsets from the frame pointer.
2799 @defmac ARGS_GROW_DOWNWARD
2800 Define this macro if successive arguments to a function occupy decreasing
2801 addresses on the stack.
2804 @defmac STARTING_FRAME_OFFSET
2805 Offset from the frame pointer to the first local variable slot to be allocated.
2807 If @code{FRAME_GROWS_DOWNWARD}, find the next slot's offset by
2808 subtracting the first slot's length from @code{STARTING_FRAME_OFFSET}.
2809 Otherwise, it is found by adding the length of the first slot to the
2810 value @code{STARTING_FRAME_OFFSET}.
2811 @c i'm not sure if the above is still correct.. had to change it to get
2812 @c rid of an overfull. --mew 2feb93
2815 @defmac STACK_ALIGNMENT_NEEDED
2816 Define to zero to disable final alignment of the stack during reload.
2817 The nonzero default for this macro is suitable for most ports.
2819 On ports where @code{STARTING_FRAME_OFFSET} is nonzero or where there
2820 is a register save block following the local block that doesn't require
2821 alignment to @code{STACK_BOUNDARY}, it may be beneficial to disable
2822 stack alignment and do it in the backend.
2825 @defmac STACK_POINTER_OFFSET
2826 Offset from the stack pointer register to the first location at which
2827 outgoing arguments are placed. If not specified, the default value of
2828 zero is used. This is the proper value for most machines.
2830 If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above
2831 the first location at which outgoing arguments are placed.
2834 @defmac FIRST_PARM_OFFSET (@var{fundecl})
2835 Offset from the argument pointer register to the first argument's
2836 address. On some machines it may depend on the data type of the
2839 If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above
2840 the first argument's address.
2843 @defmac STACK_DYNAMIC_OFFSET (@var{fundecl})
2844 Offset from the stack pointer register to an item dynamically allocated
2845 on the stack, e.g., by @code{alloca}.
2847 The default value for this macro is @code{STACK_POINTER_OFFSET} plus the
2848 length of the outgoing arguments. The default is correct for most
2849 machines. See @file{function.c} for details.
2852 @defmac DYNAMIC_CHAIN_ADDRESS (@var{frameaddr})
2853 A C expression whose value is RTL representing the address in a stack
2854 frame where the pointer to the caller's frame is stored. Assume that
2855 @var{frameaddr} is an RTL expression for the address of the stack frame
2858 If you don't define this macro, the default is to return the value
2859 of @var{frameaddr}---that is, the stack frame address is also the
2860 address of the stack word that points to the previous frame.
2863 @defmac SETUP_FRAME_ADDRESSES
2864 If defined, a C expression that produces the machine-specific code to
2865 setup the stack so that arbitrary frames can be accessed. For example,
2866 on the SPARC, we must flush all of the register windows to the stack
2867 before we can access arbitrary stack frames. You will seldom need to
2871 @defmac BUILTIN_SETJMP_FRAME_VALUE
2872 If defined, a C expression that contains an rtx that is used to store
2873 the address of the current frame into the built in @code{setjmp} buffer.
2874 The default value, @code{virtual_stack_vars_rtx}, is correct for most
2875 machines. One reason you may need to define this macro is if
2876 @code{hard_frame_pointer_rtx} is the appropriate value on your machine.
2879 @defmac RETURN_ADDR_RTX (@var{count}, @var{frameaddr})
2880 A C expression whose value is RTL representing the value of the return
2881 address for the frame @var{count} steps up from the current frame, after
2882 the prologue. @var{frameaddr} is the frame pointer of the @var{count}
2883 frame, or the frame pointer of the @var{count} @minus{} 1 frame if
2884 @code{RETURN_ADDR_IN_PREVIOUS_FRAME} is defined.
2886 The value of the expression must always be the correct address when
2887 @var{count} is zero, but may be @code{NULL_RTX} if there is not way to
2888 determine the return address of other frames.
2891 @defmac RETURN_ADDR_IN_PREVIOUS_FRAME
2892 Define this if the return address of a particular stack frame is accessed
2893 from the frame pointer of the previous stack frame.
2896 @defmac INCOMING_RETURN_ADDR_RTX
2897 A C expression whose value is RTL representing the location of the
2898 incoming return address at the beginning of any function, before the
2899 prologue. This RTL is either a @code{REG}, indicating that the return
2900 value is saved in @samp{REG}, or a @code{MEM} representing a location in
2903 You only need to define this macro if you want to support call frame
2904 debugging information like that provided by DWARF 2.
2906 If this RTL is a @code{REG}, you should also define
2907 @code{DWARF_FRAME_RETURN_COLUMN} to @code{DWARF_FRAME_REGNUM (REGNO)}.
2910 @defmac INCOMING_FRAME_SP_OFFSET
2911 A C expression whose value is an integer giving the offset, in bytes,
2912 from the value of the stack pointer register to the top of the stack
2913 frame at the beginning of any function, before the prologue. The top of
2914 the frame is defined to be the value of the stack pointer in the
2915 previous frame, just before the call instruction.
2917 You only need to define this macro if you want to support call frame
2918 debugging information like that provided by DWARF 2.
2921 @defmac ARG_POINTER_CFA_OFFSET (@var{fundecl})
2922 A C expression whose value is an integer giving the offset, in bytes,
2923 from the argument pointer to the canonical frame address (cfa). The
2924 final value should coincide with that calculated by
2925 @code{INCOMING_FRAME_SP_OFFSET}. Which is unfortunately not usable
2926 during virtual register instantiation.
2928 The default value for this macro is @code{FIRST_PARM_OFFSET (fundecl)},
2929 which is correct for most machines; in general, the arguments are found
2930 immediately before the stack frame. Note that this is not the case on
2931 some targets that save registers into the caller's frame, such as SPARC
2932 and rs6000, and so such targets need to define this macro.
2934 You only need to define this macro if the default is incorrect, and you
2935 want to support call frame debugging information like that provided by
2940 Define this macro if the stack size for the target is very small. This
2941 has the effect of disabling gcc's built-in @samp{alloca}, though
2942 @samp{__builtin_alloca} is not affected.
2945 @node Exception Handling
2946 @subsection Exception Handling Support
2947 @cindex exception handling
2949 @defmac EH_RETURN_DATA_REGNO (@var{N})
2950 A C expression whose value is the @var{N}th register number used for
2951 data by exception handlers, or @code{INVALID_REGNUM} if fewer than
2952 @var{N} registers are usable.
2954 The exception handling library routines communicate with the exception
2955 handlers via a set of agreed upon registers. Ideally these registers
2956 should be call-clobbered; it is possible to use call-saved registers,
2957 but may negatively impact code size. The target must support at least
2958 2 data registers, but should define 4 if there are enough free registers.
2960 You must define this macro if you want to support call frame exception
2961 handling like that provided by DWARF 2.
2964 @defmac EH_RETURN_STACKADJ_RTX
2965 A C expression whose value is RTL representing a location in which
2966 to store a stack adjustment to be applied before function return.
2967 This is used to unwind the stack to an exception handler's call frame.
2968 It will be assigned zero on code paths that return normally.
2970 Typically this is a call-clobbered hard register that is otherwise
2971 untouched by the epilogue, but could also be a stack slot.
2973 Do not define this macro if the stack pointer is saved and restored
2974 by the regular prolog and epilog code in the call frame itself; in
2975 this case, the exception handling library routines will update the
2976 stack location to be restored in place. Otherwise, you must define
2977 this macro if you want to support call frame exception handling like
2978 that provided by DWARF 2.
2981 @defmac EH_RETURN_HANDLER_RTX
2982 A C expression whose value is RTL representing a location in which
2983 to store the address of an exception handler to which we should
2984 return. It will not be assigned on code paths that return normally.
2986 Typically this is the location in the call frame at which the normal
2987 return address is stored. For targets that return by popping an
2988 address off the stack, this might be a memory address just below
2989 the @emph{target} call frame rather than inside the current call
2990 frame. If defined, @code{EH_RETURN_STACKADJ_RTX} will have already
2991 been assigned, so it may be used to calculate the location of the
2994 Some targets have more complex requirements than storing to an
2995 address calculable during initial code generation. In that case
2996 the @code{eh_return} instruction pattern should be used instead.
2998 If you want to support call frame exception handling, you must
2999 define either this macro or the @code{eh_return} instruction pattern.
3002 @defmac ASM_PREFERRED_EH_DATA_FORMAT (@var{code}, @var{global})
3003 This macro chooses the encoding of pointers embedded in the exception
3004 handling sections. If at all possible, this should be defined such
3005 that the exception handling section will not require dynamic relocations,
3006 and so may be read-only.
3008 @var{code} is 0 for data, 1 for code labels, 2 for function pointers.
3009 @var{global} is true if the symbol may be affected by dynamic relocations.
3010 The macro should return a combination of the @code{DW_EH_PE_*} defines
3011 as found in @file{dwarf2.h}.
3013 If this macro is not defined, pointers will not be encoded but
3014 represented directly.
3017 @defmac ASM_MAYBE_OUTPUT_ENCODED_ADDR_RTX (@var{file}, @var{encoding}, @var{size}, @var{addr}, @var{done})
3018 This macro allows the target to emit whatever special magic is required
3019 to represent the encoding chosen by @code{ASM_PREFERRED_EH_DATA_FORMAT}.
3020 Generic code takes care of pc-relative and indirect encodings; this must
3021 be defined if the target uses text-relative or data-relative encodings.
3023 This is a C statement that branches to @var{done} if the format was
3024 handled. @var{encoding} is the format chosen, @var{size} is the number
3025 of bytes that the format occupies, @var{addr} is the @code{SYMBOL_REF}
3029 @defmac MD_FALLBACK_FRAME_STATE_FOR (@var{context}, @var{fs}, @var{success})
3030 This macro allows the target to add cpu and operating system specific
3031 code to the call-frame unwinder for use when there is no unwind data
3032 available. The most common reason to implement this macro is to unwind
3033 through signal frames.
3035 This macro is called from @code{uw_frame_state_for} in @file{unwind-dw2.c}
3036 and @file{unwind-ia64.c}. @var{context} is an @code{_Unwind_Context};
3037 @var{fs} is an @code{_Unwind_FrameState}. Examine @code{context->ra}
3038 for the address of the code being executed and @code{context->cfa} for
3039 the stack pointer value. If the frame can be decoded, the register save
3040 addresses should be updated in @var{fs} and the macro should branch to
3041 @var{success}. If the frame cannot be decoded, the macro should do
3044 For proper signal handling in Java this macro is accompanied by
3045 @code{MAKE_THROW_FRAME}, defined in @file{libjava/include/*-signal.h} headers.
3048 @node Stack Checking
3049 @subsection Specifying How Stack Checking is Done
3051 GCC will check that stack references are within the boundaries of
3052 the stack, if the @option{-fstack-check} is specified, in one of three ways:
3056 If the value of the @code{STACK_CHECK_BUILTIN} macro is nonzero, GCC
3057 will assume that you have arranged for stack checking to be done at
3058 appropriate places in the configuration files, e.g., in
3059 @code{TARGET_ASM_FUNCTION_PROLOGUE}. GCC will do not other special
3063 If @code{STACK_CHECK_BUILTIN} is zero and you defined a named pattern
3064 called @code{check_stack} in your @file{md} file, GCC will call that
3065 pattern with one argument which is the address to compare the stack
3066 value against. You must arrange for this pattern to report an error if
3067 the stack pointer is out of range.
3070 If neither of the above are true, GCC will generate code to periodically
3071 ``probe'' the stack pointer using the values of the macros defined below.
3074 Normally, you will use the default values of these macros, so GCC
3075 will use the third approach.
3077 @defmac STACK_CHECK_BUILTIN
3078 A nonzero value if stack checking is done by the configuration files in a
3079 machine-dependent manner. You should define this macro if stack checking
3080 is require by the ABI of your machine or if you would like to have to stack
3081 checking in some more efficient way than GCC's portable approach.
3082 The default value of this macro is zero.
3085 @defmac STACK_CHECK_PROBE_INTERVAL
3086 An integer representing the interval at which GCC must generate stack
3087 probe instructions. You will normally define this macro to be no larger
3088 than the size of the ``guard pages'' at the end of a stack area. The
3089 default value of 4096 is suitable for most systems.
3092 @defmac STACK_CHECK_PROBE_LOAD
3093 A integer which is nonzero if GCC should perform the stack probe
3094 as a load instruction and zero if GCC should use a store instruction.
3095 The default is zero, which is the most efficient choice on most systems.
3098 @defmac STACK_CHECK_PROTECT
3099 The number of bytes of stack needed to recover from a stack overflow,
3100 for languages where such a recovery is supported. The default value of
3101 75 words should be adequate for most machines.
3104 @defmac STACK_CHECK_MAX_FRAME_SIZE
3105 The maximum size of a stack frame, in bytes. GCC will generate probe
3106 instructions in non-leaf functions to ensure at least this many bytes of
3107 stack are available. If a stack frame is larger than this size, stack
3108 checking will not be reliable and GCC will issue a warning. The
3109 default is chosen so that GCC only generates one instruction on most
3110 systems. You should normally not change the default value of this macro.
3113 @defmac STACK_CHECK_FIXED_FRAME_SIZE
3114 GCC uses this value to generate the above warning message. It
3115 represents the amount of fixed frame used by a function, not including
3116 space for any callee-saved registers, temporaries and user variables.
3117 You need only specify an upper bound for this amount and will normally
3118 use the default of four words.
3121 @defmac STACK_CHECK_MAX_VAR_SIZE
3122 The maximum size, in bytes, of an object that GCC will place in the
3123 fixed area of the stack frame when the user specifies
3124 @option{-fstack-check}.
3125 GCC computed the default from the values of the above macros and you will
3126 normally not need to override that default.
3130 @node Frame Registers
3131 @subsection Registers That Address the Stack Frame
3133 @c prevent bad page break with this line
3134 This discusses registers that address the stack frame.
3136 @defmac STACK_POINTER_REGNUM
3137 The register number of the stack pointer register, which must also be a
3138 fixed register according to @code{FIXED_REGISTERS}. On most machines,
3139 the hardware determines which register this is.
3142 @defmac FRAME_POINTER_REGNUM
3143 The register number of the frame pointer register, which is used to
3144 access automatic variables in the stack frame. On some machines, the
3145 hardware determines which register this is. On other machines, you can
3146 choose any register you wish for this purpose.
3149 @defmac HARD_FRAME_POINTER_REGNUM
3150 On some machines the offset between the frame pointer and starting
3151 offset of the automatic variables is not known until after register
3152 allocation has been done (for example, because the saved registers are
3153 between these two locations). On those machines, define
3154 @code{FRAME_POINTER_REGNUM} the number of a special, fixed register to
3155 be used internally until the offset is known, and define
3156 @code{HARD_FRAME_POINTER_REGNUM} to be the actual hard register number
3157 used for the frame pointer.
3159 You should define this macro only in the very rare circumstances when it
3160 is not possible to calculate the offset between the frame pointer and
3161 the automatic variables until after register allocation has been
3162 completed. When this macro is defined, you must also indicate in your
3163 definition of @code{ELIMINABLE_REGS} how to eliminate
3164 @code{FRAME_POINTER_REGNUM} into either @code{HARD_FRAME_POINTER_REGNUM}
3165 or @code{STACK_POINTER_REGNUM}.
3167 Do not define this macro if it would be the same as
3168 @code{FRAME_POINTER_REGNUM}.
3171 @defmac ARG_POINTER_REGNUM
3172 The register number of the arg pointer register, which is used to access
3173 the function's argument list. On some machines, this is the same as the
3174 frame pointer register. On some machines, the hardware determines which
3175 register this is. On other machines, you can choose any register you
3176 wish for this purpose. If this is not the same register as the frame
3177 pointer register, then you must mark it as a fixed register according to
3178 @code{FIXED_REGISTERS}, or arrange to be able to eliminate it
3179 (@pxref{Elimination}).
3182 @defmac RETURN_ADDRESS_POINTER_REGNUM
3183 The register number of the return address pointer register, which is used to
3184 access the current function's return address from the stack. On some
3185 machines, the return address is not at a fixed offset from the frame
3186 pointer or stack pointer or argument pointer. This register can be defined
3187 to point to the return address on the stack, and then be converted by
3188 @code{ELIMINABLE_REGS} into either the frame pointer or stack pointer.
3190 Do not define this macro unless there is no other way to get the return
3191 address from the stack.
3194 @defmac STATIC_CHAIN_REGNUM
3195 @defmacx STATIC_CHAIN_INCOMING_REGNUM
3196 Register numbers used for passing a function's static chain pointer. If
3197 register windows are used, the register number as seen by the called
3198 function is @code{STATIC_CHAIN_INCOMING_REGNUM}, while the register
3199 number as seen by the calling function is @code{STATIC_CHAIN_REGNUM}. If
3200 these registers are the same, @code{STATIC_CHAIN_INCOMING_REGNUM} need
3203 The static chain register need not be a fixed register.
3205 If the static chain is passed in memory, these macros should not be
3206 defined; instead, the next two macros should be defined.
3209 @defmac STATIC_CHAIN
3210 @defmacx STATIC_CHAIN_INCOMING
3211 If the static chain is passed in memory, these macros provide rtx giving
3212 @code{mem} expressions that denote where they are stored.
3213 @code{STATIC_CHAIN} and @code{STATIC_CHAIN_INCOMING} give the locations
3214 as seen by the calling and called functions, respectively. Often the former
3215 will be at an offset from the stack pointer and the latter at an offset from
3218 @findex stack_pointer_rtx
3219 @findex frame_pointer_rtx
3220 @findex arg_pointer_rtx
3221 The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and
3222 @code{arg_pointer_rtx} will have been initialized prior to the use of these
3223 macros and should be used to refer to those items.
3225 If the static chain is passed in a register, the two previous macros should
3229 @defmac DWARF_FRAME_REGISTERS
3230 This macro specifies the maximum number of hard registers that can be
3231 saved in a call frame. This is used to size data structures used in
3232 DWARF2 exception handling.
3234 Prior to GCC 3.0, this macro was needed in order to establish a stable
3235 exception handling ABI in the face of adding new hard registers for ISA
3236 extensions. In GCC 3.0 and later, the EH ABI is insulated from changes
3237 in the number of hard registers. Nevertheless, this macro can still be
3238 used to reduce the runtime memory requirements of the exception handling
3239 routines, which can be substantial if the ISA contains a lot of
3240 registers that are not call-saved.
3242 If this macro is not defined, it defaults to
3243 @code{FIRST_PSEUDO_REGISTER}.
3246 @defmac PRE_GCC3_DWARF_FRAME_REGISTERS
3248 This macro is similar to @code{DWARF_FRAME_REGISTERS}, but is provided
3249 for backward compatibility in pre GCC 3.0 compiled code.
3251 If this macro is not defined, it defaults to
3252 @code{DWARF_FRAME_REGISTERS}.
3255 @defmac DWARF_REG_TO_UNWIND_COLUMN (@var{regno})
3257 Define this macro if the target's representation for dwarf registers
3258 is different than the internal representation for unwind column.
3259 Given a dwarf register, this macro should return the interal unwind
3260 column number to use instead.
3262 See the PowerPC's SPE target for an example.
3266 @subsection Eliminating Frame Pointer and Arg Pointer
3268 @c prevent bad page break with this line
3269 This is about eliminating the frame pointer and arg pointer.
3271 @defmac FRAME_POINTER_REQUIRED
3272 A C expression which is nonzero if a function must have and use a frame
3273 pointer. This expression is evaluated in the reload pass. If its value is
3274 nonzero the function will have a frame pointer.
3276 The expression can in principle examine the current function and decide
3277 according to the facts, but on most machines the constant 0 or the
3278 constant 1 suffices. Use 0 when the machine allows code to be generated
3279 with no frame pointer, and doing so saves some time or space. Use 1
3280 when there is no possible advantage to avoiding a frame pointer.
3282 In certain cases, the compiler does not know how to produce valid code
3283 without a frame pointer. The compiler recognizes those cases and
3284 automatically gives the function a frame pointer regardless of what
3285 @code{FRAME_POINTER_REQUIRED} says. You don't need to worry about
3288 In a function that does not require a frame pointer, the frame pointer
3289 register can be allocated for ordinary usage, unless you mark it as a
3290 fixed register. See @code{FIXED_REGISTERS} for more information.
3293 @findex get_frame_size
3294 @defmac INITIAL_FRAME_POINTER_OFFSET (@var{depth-var})
3295 A C statement to store in the variable @var{depth-var} the difference
3296 between the frame pointer and the stack pointer values immediately after
3297 the function prologue. The value would be computed from information
3298 such as the result of @code{get_frame_size ()} and the tables of
3299 registers @code{regs_ever_live} and @code{call_used_regs}.
3301 If @code{ELIMINABLE_REGS} is defined, this macro will be not be used and
3302 need not be defined. Otherwise, it must be defined even if
3303 @code{FRAME_POINTER_REQUIRED} is defined to always be true; in that
3304 case, you may set @var{depth-var} to anything.
3307 @defmac ELIMINABLE_REGS
3308 If defined, this macro specifies a table of register pairs used to
3309 eliminate unneeded registers that point into the stack frame. If it is not
3310 defined, the only elimination attempted by the compiler is to replace
3311 references to the frame pointer with references to the stack pointer.
3313 The definition of this macro is a list of structure initializations, each
3314 of which specifies an original and replacement register.
3316 On some machines, the position of the argument pointer is not known until
3317 the compilation is completed. In such a case, a separate hard register
3318 must be used for the argument pointer. This register can be eliminated by
3319 replacing it with either the frame pointer or the argument pointer,
3320 depending on whether or not the frame pointer has been eliminated.
3322 In this case, you might specify:
3324 #define ELIMINABLE_REGS \
3325 @{@{ARG_POINTER_REGNUM, STACK_POINTER_REGNUM@}, \
3326 @{ARG_POINTER_REGNUM, FRAME_POINTER_REGNUM@}, \
3327 @{FRAME_POINTER_REGNUM, STACK_POINTER_REGNUM@}@}
3330 Note that the elimination of the argument pointer with the stack pointer is
3331 specified first since that is the preferred elimination.
3334 @defmac CAN_ELIMINATE (@var{from-reg}, @var{to-reg})
3335 A C expression that returns nonzero if the compiler is allowed to try
3336 to replace register number @var{from-reg} with register number
3337 @var{to-reg}. This macro need only be defined if @code{ELIMINABLE_REGS}
3338 is defined, and will usually be the constant 1, since most of the cases
3339 preventing register elimination are things that the compiler already
3343 @defmac INITIAL_ELIMINATION_OFFSET (@var{from-reg}, @var{to-reg}, @var{offset-var})
3344 This macro is similar to @code{INITIAL_FRAME_POINTER_OFFSET}. It
3345 specifies the initial difference between the specified pair of
3346 registers. This macro must be defined if @code{ELIMINABLE_REGS} is
3350 @node Stack Arguments
3351 @subsection Passing Function Arguments on the Stack
3352 @cindex arguments on stack
3353 @cindex stack arguments
3355 The macros in this section control how arguments are passed
3356 on the stack. See the following section for other macros that
3357 control passing certain arguments in registers.
3359 @defmac PROMOTE_PROTOTYPES
3360 A C expression whose value is nonzero if an argument declared in
3361 a prototype as an integral type smaller than @code{int} should
3362 actually be passed as an @code{int}. In addition to avoiding
3363 errors in certain cases of mismatch, it also makes for better
3364 code on certain machines. If the macro is not defined in target
3365 header files, it defaults to 0.
3369 A C expression. If nonzero, push insns will be used to pass
3371 If the target machine does not have a push instruction, set it to zero.
3372 That directs GCC to use an alternate strategy: to
3373 allocate the entire argument block and then store the arguments into
3374 it. When @code{PUSH_ARGS} is nonzero, @code{PUSH_ROUNDING} must be defined too.
3377 @defmac PUSH_ROUNDING (@var{npushed})
3378 A C expression that is the number of bytes actually pushed onto the
3379 stack when an instruction attempts to push @var{npushed} bytes.
3381 On some machines, the definition
3384 #define PUSH_ROUNDING(BYTES) (BYTES)
3388 will suffice. But on other machines, instructions that appear
3389 to push one byte actually push two bytes in an attempt to maintain
3390 alignment. Then the definition should be
3393 #define PUSH_ROUNDING(BYTES) (((BYTES) + 1) & ~1)
3397 @findex current_function_outgoing_args_size
3398 @defmac ACCUMULATE_OUTGOING_ARGS
3399 A C expression. If nonzero, the maximum amount of space required for outgoing arguments
3400 will be computed and placed into the variable
3401 @code{current_function_outgoing_args_size}. No space will be pushed
3402 onto the stack for each call; instead, the function prologue should
3403 increase the stack frame size by this amount.
3405 Setting both @code{PUSH_ARGS} and @code{ACCUMULATE_OUTGOING_ARGS}
3409 @defmac REG_PARM_STACK_SPACE (@var{fndecl})
3410 Define this macro if functions should assume that stack space has been
3411 allocated for arguments even when their values are passed in
3414 The value of this macro is the size, in bytes, of the area reserved for
3415 arguments passed in registers for the function represented by @var{fndecl},
3416 which can be zero if GCC is calling a library function.
3418 This space can be allocated by the caller, or be a part of the
3419 machine-dependent stack frame: @code{OUTGOING_REG_PARM_STACK_SPACE} says
3422 @c above is overfull. not sure what to do. --mew 5feb93 did
3423 @c something, not sure if it looks good. --mew 10feb93
3425 @defmac MAYBE_REG_PARM_STACK_SPACE
3426 @defmacx FINAL_REG_PARM_STACK_SPACE (@var{const_size}, @var{var_size})
3427 Define these macros in addition to the one above if functions might
3428 allocate stack space for arguments even when their values are passed
3429 in registers. These should be used when the stack space allocated
3430 for arguments in registers is not a simple constant independent of the
3431 function declaration.
3433 The value of the first macro is the size, in bytes, of the area that
3434 we should initially assume would be reserved for arguments passed in registers.
3436 The value of the second macro is the actual size, in bytes, of the area
3437 that will be reserved for arguments passed in registers. This takes two
3438 arguments: an integer representing the number of bytes of fixed sized
3439 arguments on the stack, and a tree representing the number of bytes of
3440 variable sized arguments on the stack.
3442 When these macros are defined, @code{REG_PARM_STACK_SPACE} will only be
3443 called for libcall functions, the current function, or for a function
3444 being called when it is known that such stack space must be allocated.
3445 In each case this value can be easily computed.
3447 When deciding whether a called function needs such stack space, and how
3448 much space to reserve, GCC uses these two macros instead of
3449 @code{REG_PARM_STACK_SPACE}.
3452 @defmac OUTGOING_REG_PARM_STACK_SPACE
3453 Define this if it is the responsibility of the caller to allocate the area
3454 reserved for arguments passed in registers.
3456 If @code{ACCUMULATE_OUTGOING_ARGS} is defined, this macro controls
3457 whether the space for these arguments counts in the value of
3458 @code{current_function_outgoing_args_size}.
3461 @defmac STACK_PARMS_IN_REG_PARM_AREA
3462 Define this macro if @code{REG_PARM_STACK_SPACE} is defined, but the
3463 stack parameters don't skip the area specified by it.
3464 @c i changed this, makes more sens and it should have taken care of the
3465 @c overfull.. not as specific, tho. --mew 5feb93
3467 Normally, when a parameter is not passed in registers, it is placed on the
3468 stack beyond the @code{REG_PARM_STACK_SPACE} area. Defining this macro
3469 suppresses this behavior and causes the parameter to be passed on the
3470 stack in its natural location.
3473 @defmac RETURN_POPS_ARGS (@var{fundecl}, @var{funtype}, @var{stack-size})
3474 A C expression that should indicate the number of bytes of its own
3475 arguments that a function pops on returning, or 0 if the
3476 function pops no arguments and the caller must therefore pop them all
3477 after the function returns.
3479 @var{fundecl} is a C variable whose value is a tree node that describes
3480 the function in question. Normally it is a node of type
3481 @code{FUNCTION_DECL} that describes the declaration of the function.
3482 From this you can obtain the @code{DECL_ATTRIBUTES} of the function.
3484 @var{funtype} is a C variable whose value is a tree node that
3485 describes the function in question. Normally it is a node of type
3486 @code{FUNCTION_TYPE} that describes the data type of the function.
3487 From this it is possible to obtain the data types of the value and
3488 arguments (if known).
3490 When a call to a library function is being considered, @var{fundecl}
3491 will contain an identifier node for the library function. Thus, if
3492 you need to distinguish among various library functions, you can do so
3493 by their names. Note that ``library function'' in this context means
3494 a function used to perform arithmetic, whose name is known specially
3495 in the compiler and was not mentioned in the C code being compiled.
3497 @var{stack-size} is the number of bytes of arguments passed on the
3498 stack. If a variable number of bytes is passed, it is zero, and
3499 argument popping will always be the responsibility of the calling function.
3501 On the VAX, all functions always pop their arguments, so the definition
3502 of this macro is @var{stack-size}. On the 68000, using the standard
3503 calling convention, no functions pop their arguments, so the value of
3504 the macro is always 0 in this case. But an alternative calling
3505 convention is available in which functions that take a fixed number of
3506 arguments pop them but other functions (such as @code{printf}) pop
3507 nothing (the caller pops all). When this convention is in use,
3508 @var{funtype} is examined to determine whether a function takes a fixed
3509 number of arguments.
3512 @defmac CALL_POPS_ARGS (@var{cum})
3513 A C expression that should indicate the number of bytes a call sequence
3514 pops off the stack. It is added to the value of @code{RETURN_POPS_ARGS}
3515 when compiling a function call.
3517 @var{cum} is the variable in which all arguments to the called function
3518 have been accumulated.
3520 On certain architectures, such as the SH5, a call trampoline is used
3521 that pops certain registers off the stack, depending on the arguments
3522 that have been passed to the function. Since this is a property of the
3523 call site, not of the called function, @code{RETURN_POPS_ARGS} is not
3527 @node Register Arguments
3528 @subsection Passing Arguments in Registers
3529 @cindex arguments in registers
3530 @cindex registers arguments
3532 This section describes the macros which let you control how various
3533 types of arguments are passed in registers or how they are arranged in
3536 @defmac FUNCTION_ARG (@var{cum}, @var{mode}, @var{type}, @var{named})
3537 A C expression that controls whether a function argument is passed
3538 in a register, and which register.
3540 The arguments are @var{cum}, which summarizes all the previous
3541 arguments; @var{mode}, the machine mode of the argument; @var{type},
3542 the data type of the argument as a tree node or 0 if that is not known
3543 (which happens for C support library functions); and @var{named},
3544 which is 1 for an ordinary argument and 0 for nameless arguments that
3545 correspond to @samp{@dots{}} in the called function's prototype.
3546 @var{type} can be an incomplete type if a syntax error has previously
3549 The value of the expression is usually either a @code{reg} RTX for the
3550 hard register in which to pass the argument, or zero to pass the
3551 argument on the stack.
3553 For machines like the VAX and 68000, where normally all arguments are
3554 pushed, zero suffices as a definition.
3556 The value of the expression can also be a @code{parallel} RTX@. This is
3557 used when an argument is passed in multiple locations. The mode of the
3558 @code{parallel} should be the mode of the entire argument. The
3559 @code{parallel} holds any number of @code{expr_list} pairs; each one
3560 describes where part of the argument is passed. In each
3561 @code{expr_list} the first operand must be a @code{reg} RTX for the hard
3562 register in which to pass this part of the argument, and the mode of the
3563 register RTX indicates how large this part of the argument is. The
3564 second operand of the @code{expr_list} is a @code{const_int} which gives
3565 the offset in bytes into the entire argument of where this part starts.
3566 As a special exception the first @code{expr_list} in the @code{parallel}
3567 RTX may have a first operand of zero. This indicates that the entire
3568 argument is also stored on the stack.
3570 The last time this macro is called, it is called with @code{MODE ==
3571 VOIDmode}, and its result is passed to the @code{call} or @code{call_value}
3572 pattern as operands 2 and 3 respectively.
3574 @cindex @file{stdarg.h} and register arguments
3575 The usual way to make the ISO library @file{stdarg.h} work on a machine
3576 where some arguments are usually passed in registers, is to cause
3577 nameless arguments to be passed on the stack instead. This is done
3578 by making @code{FUNCTION_ARG} return 0 whenever @var{named} is 0.
3580 @cindex @code{MUST_PASS_IN_STACK}, and @code{FUNCTION_ARG}
3581 @cindex @code{REG_PARM_STACK_SPACE}, and @code{FUNCTION_ARG}
3582 You may use the macro @code{MUST_PASS_IN_STACK (@var{mode}, @var{type})}
3583 in the definition of this macro to determine if this argument is of a
3584 type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}
3585 is not defined and @code{FUNCTION_ARG} returns nonzero for such an
3586 argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is
3587 defined, the argument will be computed in the stack and then loaded into
3591 @defmac MUST_PASS_IN_STACK (@var{mode}, @var{type})
3592 Define as a C expression that evaluates to nonzero if we do not know how
3593 to pass TYPE solely in registers. The file @file{expr.h} defines a
3594 definition that is usually appropriate, refer to @file{expr.h} for additional
3598 @defmac FUNCTION_INCOMING_ARG (@var{cum}, @var{mode}, @var{type}, @var{named})
3599 Define this macro if the target machine has ``register windows'', so
3600 that the register in which a function sees an arguments is not
3601 necessarily the same as the one in which the caller passed the
3604 For such machines, @code{FUNCTION_ARG} computes the register in which
3605 the caller passes the value, and @code{FUNCTION_INCOMING_ARG} should
3606 be defined in a similar fashion to tell the function being called
3607 where the arguments will arrive.
3609 If @code{FUNCTION_INCOMING_ARG} is not defined, @code{FUNCTION_ARG}
3610 serves both purposes.
3613 @defmac FUNCTION_ARG_PARTIAL_NREGS (@var{cum}, @var{mode}, @var{type}, @var{named})
3614 A C expression for the number of words, at the beginning of an
3615 argument, that must be put in registers. The value must be zero for
3616 arguments that are passed entirely in registers or that are entirely
3617 pushed on the stack.
3619 On some machines, certain arguments must be passed partially in
3620 registers and partially in memory. On these machines, typically the
3621 first @var{n} words of arguments are passed in registers, and the rest
3622 on the stack. If a multi-word argument (a @code{double} or a
3623 structure) crosses that boundary, its first few words must be passed
3624 in registers and the rest must be pushed. This macro tells the
3625 compiler when this occurs, and how many of the words should go in
3628 @code{FUNCTION_ARG} for these arguments should return the first
3629 register to be used by the caller for this argument; likewise
3630 @code{FUNCTION_INCOMING_ARG}, for the called function.
3633 @defmac FUNCTION_ARG_PASS_BY_REFERENCE (@var{cum}, @var{mode}, @var{type}, @var{named})
3634 A C expression that indicates when an argument must be passed by reference.
3635 If nonzero for an argument, a copy of that argument is made in memory and a
3636 pointer to the argument is passed instead of the argument itself.
3637 The pointer is passed in whatever way is appropriate for passing a pointer
3640 On machines where @code{REG_PARM_STACK_SPACE} is not defined, a suitable
3641 definition of this macro might be
3643 #define FUNCTION_ARG_PASS_BY_REFERENCE\
3644 (CUM, MODE, TYPE, NAMED) \
3645 MUST_PASS_IN_STACK (MODE, TYPE)
3647 @c this is *still* too long. --mew 5feb93
3650 @defmac FUNCTION_ARG_CALLEE_COPIES (@var{cum}, @var{mode}, @var{type}, @var{named})
3651 If defined, a C expression that indicates when it is the called function's
3652 responsibility to make a copy of arguments passed by invisible reference.
3653 Normally, the caller makes a copy and passes the address of the copy to the
3654 routine being called. When @code{FUNCTION_ARG_CALLEE_COPIES} is defined and is
3655 nonzero, the caller does not make a copy. Instead, it passes a pointer to the
3656 ``live'' value. The called function must not modify this value. If it can be
3657 determined that the value won't be modified, it need not make a copy;
3658 otherwise a copy must be made.
3661 @defmac CUMULATIVE_ARGS
3662 A C type for declaring a variable that is used as the first argument of
3663 @code{FUNCTION_ARG} and other related values. For some target machines,
3664 the type @code{int} suffices and can hold the number of bytes of
3667 There is no need to record in @code{CUMULATIVE_ARGS} anything about the
3668 arguments that have been passed on the stack. The compiler has other
3669 variables to keep track of that. For target machines on which all
3670 arguments are passed on the stack, there is no need to store anything in
3671 @code{CUMULATIVE_ARGS}; however, the data structure must exist and
3672 should not be empty, so use @code{int}.
3675 @defmac INIT_CUMULATIVE_ARGS (@var{cum}, @var{fntype}, @var{libname}, @var{fndecl})
3676 A C statement (sans semicolon) for initializing the variable
3677 @var{cum} for the state at the beginning of the argument list. The
3678 variable has type @code{CUMULATIVE_ARGS}. The value of @var{fntype}
3679 is the tree node for the data type of the function which will receive
3680 the args, or 0 if the args are to a compiler support library function.
3681 For direct calls that are not libcalls, @var{fndecl} contain the
3682 declaration node of the function. @var{fndecl} is also set when
3683 @code{INIT_CUMULATIVE_ARGS} is used to find arguments for the function
3686 When processing a call to a compiler support library function,
3687 @var{libname} identifies which one. It is a @code{symbol_ref} rtx which
3688 contains the name of the function, as a string. @var{libname} is 0 when
3689 an ordinary C function call is being processed. Thus, each time this
3690 macro is called, either @var{libname} or @var{fntype} is nonzero, but
3691 never both of them at once.
3694 @defmac INIT_CUMULATIVE_LIBCALL_ARGS (@var{cum}, @var{mode}, @var{libname})
3695 Like @code{INIT_CUMULATIVE_ARGS} but only used for outgoing libcalls,
3696 it gets a @code{MODE} argument instead of @var{fntype}, that would be
3697 @code{NULL}. @var{indirect} would always be zero, too. If this macro
3698 is not defined, @code{INIT_CUMULATIVE_ARGS (cum, NULL_RTX, libname,
3699 0)} is used instead.
3702 @defmac INIT_CUMULATIVE_INCOMING_ARGS (@var{cum}, @var{fntype}, @var{libname})
3703 Like @code{INIT_CUMULATIVE_ARGS} but overrides it for the purposes of
3704 finding the arguments for the function being compiled. If this macro is
3705 undefined, @code{INIT_CUMULATIVE_ARGS} is used instead.
3707 The value passed for @var{libname} is always 0, since library routines
3708 with special calling conventions are never compiled with GCC@. The
3709 argument @var{libname} exists for symmetry with
3710 @code{INIT_CUMULATIVE_ARGS}.
3711 @c could use "this macro" in place of @code{INIT_CUMULATIVE_ARGS}, maybe.
3712 @c --mew 5feb93 i switched the order of the sentences. --mew 10feb93
3715 @defmac FUNCTION_ARG_ADVANCE (@var{cum}, @var{mode}, @var{type}, @var{named})
3716 A C statement (sans semicolon) to update the summarizer variable
3717 @var{cum} to advance past an argument in the argument list. The
3718 values @var{mode}, @var{type} and @var{named} describe that argument.
3719 Once this is done, the variable @var{cum} is suitable for analyzing
3720 the @emph{following} argument with @code{FUNCTION_ARG}, etc.
3722 This macro need not do anything if the argument in question was passed
3723 on the stack. The compiler knows how to track the amount of stack space
3724 used for arguments without any special help.
3727 @defmac FUNCTION_ARG_PADDING (@var{mode}, @var{type})
3728 If defined, a C expression which determines whether, and in which direction,
3729 to pad out an argument with extra space. The value should be of type
3730 @code{enum direction}: either @code{upward} to pad above the argument,
3731 @code{downward} to pad below, or @code{none} to inhibit padding.
3733 The @emph{amount} of padding is always just enough to reach the next
3734 multiple of @code{FUNCTION_ARG_BOUNDARY}; this macro does not control
3737 This macro has a default definition which is right for most systems.
3738 For little-endian machines, the default is to pad upward. For
3739 big-endian machines, the default is to pad downward for an argument of
3740 constant size shorter than an @code{int}, and upward otherwise.
3743 @defmac PAD_VARARGS_DOWN
3744 If defined, a C expression which determines whether the default
3745 implementation of va_arg will attempt to pad down before reading the
3746 next argument, if that argument is smaller than its aligned space as
3747 controlled by @code{PARM_BOUNDARY}. If this macro is not defined, all such
3748 arguments are padded down if @code{BYTES_BIG_ENDIAN} is true.
3751 @defmac FUNCTION_ARG_BOUNDARY (@var{mode}, @var{type})
3752 If defined, a C expression that gives the alignment boundary, in bits,
3753 of an argument with the specified mode and type. If it is not defined,
3754 @code{PARM_BOUNDARY} is used for all arguments.
3757 @defmac FUNCTION_ARG_REGNO_P (@var{regno})
3758 A C expression that is nonzero if @var{regno} is the number of a hard
3759 register in which function arguments are sometimes passed. This does
3760 @emph{not} include implicit arguments such as the static chain and
3761 the structure-value address. On many machines, no registers can be
3762 used for this purpose since all function arguments are pushed on the
3766 @defmac SPLIT_COMPLEX_ARGS
3768 Define this macro to a nonzero value if complex function arguments
3769 should be split into their corresponding components. By default, GCC
3770 will attempt to pack complex arguments into the target's word size.
3771 Some ABIs require complex arguments to be split and treated as their
3772 individual components. For example, on AIX64, complex floats should
3773 be passed in a pair of floating point registers, even though a complex
3774 float would fit in one 64-bit floating point register.
3777 @defmac LOAD_ARGS_REVERSED
3778 If defined, the order in which arguments are loaded into their
3779 respective argument registers is reversed so that the last
3780 argument is loaded first. This macro only affects arguments
3781 passed in registers.
3785 @subsection How Scalar Function Values Are Returned
3786 @cindex return values in registers
3787 @cindex values, returned by functions
3788 @cindex scalars, returned as values
3790 This section discusses the macros that control returning scalars as
3791 values---values that can fit in registers.
3793 @defmac FUNCTION_VALUE (@var{valtype}, @var{func})
3794 A C expression to create an RTX representing the place where a
3795 function returns a value of data type @var{valtype}. @var{valtype} is
3796 a tree node representing a data type. Write @code{TYPE_MODE
3797 (@var{valtype})} to get the machine mode used to represent that type.
3798 On many machines, only the mode is relevant. (Actually, on most
3799 machines, scalar values are returned in the same place regardless of
3802 The value of the expression is usually a @code{reg} RTX for the hard
3803 register where the return value is stored. The value can also be a
3804 @code{parallel} RTX, if the return value is in multiple places. See
3805 @code{FUNCTION_ARG} for an explanation of the @code{parallel} form.
3807 If @code{PROMOTE_FUNCTION_RETURN} is defined, you must apply the same
3808 promotion rules specified in @code{PROMOTE_MODE} if @var{valtype} is a
3811 If the precise function being called is known, @var{func} is a tree
3812 node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null
3813 pointer. This makes it possible to use a different value-returning
3814 convention for specific functions when all their calls are
3817 @code{FUNCTION_VALUE} is not used for return vales with aggregate data
3818 types, because these are returned in another way. See
3819 @code{STRUCT_VALUE_REGNUM} and related macros, below.
3822 @defmac FUNCTION_OUTGOING_VALUE (@var{valtype}, @var{func})
3823 Define this macro if the target machine has ``register windows''
3824 so that the register in which a function returns its value is not
3825 the same as the one in which the caller sees the value.
3827 For such machines, @code{FUNCTION_VALUE} computes the register in which
3828 the caller will see the value. @code{FUNCTION_OUTGOING_VALUE} should be
3829 defined in a similar fashion to tell the function where to put the
3832 If @code{FUNCTION_OUTGOING_VALUE} is not defined,
3833 @code{FUNCTION_VALUE} serves both purposes.
3835 @code{FUNCTION_OUTGOING_VALUE} is not used for return vales with
3836 aggregate data types, because these are returned in another way. See
3837 @code{STRUCT_VALUE_REGNUM} and related macros, below.
3840 @defmac LIBCALL_VALUE (@var{mode})
3841 A C expression to create an RTX representing the place where a library
3842 function returns a value of mode @var{mode}. If the precise function
3843 being called is known, @var{func} is a tree node
3844 (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null
3845 pointer. This makes it possible to use a different value-returning
3846 convention for specific functions when all their calls are
3849 Note that ``library function'' in this context means a compiler
3850 support routine, used to perform arithmetic, whose name is known
3851 specially by the compiler and was not mentioned in the C code being
3854 The definition of @code{LIBRARY_VALUE} need not be concerned aggregate
3855 data types, because none of the library functions returns such types.
3858 @defmac FUNCTION_VALUE_REGNO_P (@var{regno})
3859 A C expression that is nonzero if @var{regno} is the number of a hard
3860 register in which the values of called function may come back.
3862 A register whose use for returning values is limited to serving as the
3863 second of a pair (for a value of type @code{double}, say) need not be
3864 recognized by this macro. So for most machines, this definition
3868 #define FUNCTION_VALUE_REGNO_P(N) ((N) == 0)
3871 If the machine has register windows, so that the caller and the called
3872 function use different registers for the return value, this macro
3873 should recognize only the caller's register numbers.
3876 @defmac APPLY_RESULT_SIZE
3877 Define this macro if @samp{untyped_call} and @samp{untyped_return}
3878 need more space than is implied by @code{FUNCTION_VALUE_REGNO_P} for
3879 saving and restoring an arbitrary return value.
3882 @node Aggregate Return
3883 @subsection How Large Values Are Returned
3884 @cindex aggregates as return values
3885 @cindex large return values
3886 @cindex returning aggregate values
3887 @cindex structure value address
3889 When a function value's mode is @code{BLKmode} (and in some other
3890 cases), the value is not returned according to @code{FUNCTION_VALUE}
3891 (@pxref{Scalar Return}). Instead, the caller passes the address of a
3892 block of memory in which the value should be stored. This address
3893 is called the @dfn{structure value address}.
3895 This section describes how to control returning structure values in
3898 @defmac RETURN_IN_MEMORY (@var{type})
3899 A C expression which can inhibit the returning of certain function
3900 values in registers, based on the type of value. A nonzero value says
3901 to return the function value in memory, just as large structures are
3902 always returned. Here @var{type} will be a C expression of type
3903 @code{tree}, representing the data type of the value.
3905 Note that values of mode @code{BLKmode} must be explicitly handled
3906 by this macro. Also, the option @option{-fpcc-struct-return}
3907 takes effect regardless of this macro. On most systems, it is
3908 possible to leave the macro undefined; this causes a default
3909 definition to be used, whose value is the constant 1 for @code{BLKmode}
3910 values, and 0 otherwise.
3912 Do not use this macro to indicate that structures and unions should always
3913 be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}
3917 @defmac DEFAULT_PCC_STRUCT_RETURN
3918 Define this macro to be 1 if all structure and union return values must be
3919 in memory. Since this results in slower code, this should be defined
3920 only if needed for compatibility with other compilers or with an ABI@.
3921 If you define this macro to be 0, then the conventions used for structure
3922 and union return values are decided by the @code{RETURN_IN_MEMORY} macro.
3924 If not defined, this defaults to the value 1.
3927 @defmac STRUCT_VALUE_REGNUM
3928 If the structure value address is passed in a register, then
3929 @code{STRUCT_VALUE_REGNUM} should be the number of that register.
3932 @defmac STRUCT_VALUE
3933 If the structure value address is not passed in a register, define
3934 @code{STRUCT_VALUE} as an expression returning an RTX for the place
3935 where the address is passed. If it returns 0, the address is passed as
3936 an ``invisible'' first argument.
3939 @defmac STRUCT_VALUE_INCOMING_REGNUM
3940 On some architectures the place where the structure value address
3941 is found by the called function is not the same place that the
3942 caller put it. This can be due to register windows, or it could
3943 be because the function prologue moves it to a different place.
3945 If the incoming location of the structure value address is in a
3946 register, define this macro as the register number.
3949 @defmac STRUCT_VALUE_INCOMING
3950 If the incoming location is not a register, then you should define
3951 @code{STRUCT_VALUE_INCOMING} as an expression for an RTX for where the
3952 called function should find the value. If it should find the value on
3953 the stack, define this to create a @code{mem} which refers to the frame
3954 pointer. A definition of 0 means that the address is passed as an
3955 ``invisible'' first argument.
3958 @defmac PCC_STATIC_STRUCT_RETURN
3959 Define this macro if the usual system convention on the target machine
3960 for returning structures and unions is for the called function to return
3961 the address of a static variable containing the value.
3963 Do not define this if the usual system convention is for the caller to
3964 pass an address to the subroutine.
3966 This macro has effect in @option{-fpcc-struct-return} mode, but it does
3967 nothing when you use @option{-freg-struct-return} mode.
3971 @subsection Caller-Saves Register Allocation
3973 If you enable it, GCC can save registers around function calls. This
3974 makes it possible to use call-clobbered registers to hold variables that
3975 must live across calls.
3977 @defmac DEFAULT_CALLER_SAVES
3978 Define this macro if function calls on the target machine do not preserve
3979 any registers; in other words, if @code{CALL_USED_REGISTERS} has 1
3980 for all registers. When defined, this macro enables @option{-fcaller-saves}
3981 by default for all optimization levels. It has no effect for optimization
3982 levels 2 and higher, where @option{-fcaller-saves} is the default.
3985 @defmac CALLER_SAVE_PROFITABLE (@var{refs}, @var{calls})
3986 A C expression to determine whether it is worthwhile to consider placing
3987 a pseudo-register in a call-clobbered hard register and saving and
3988 restoring it around each function call. The expression should be 1 when
3989 this is worth doing, and 0 otherwise.
3991 If you don't define this macro, a default is used which is good on most
3992 machines: @code{4 * @var{calls} < @var{refs}}.
3995 @defmac HARD_REGNO_CALLER_SAVE_MODE (@var{regno}, @var{nregs})
3996 A C expression specifying which mode is required for saving @var{nregs}
3997 of a pseudo-register in call-clobbered hard register @var{regno}. If
3998 @var{regno} is unsuitable for caller save, @code{VOIDmode} should be
3999 returned. For most machines this macro need not be defined since GCC
4000 will select the smallest suitable mode.
4003 @node Function Entry
4004 @subsection Function Entry and Exit
4005 @cindex function entry and exit
4009 This section describes the macros that output function entry
4010 (@dfn{prologue}) and exit (@dfn{epilogue}) code.
4012 @deftypefn {Target Hook} void TARGET_ASM_FUNCTION_PROLOGUE (FILE *@var{file}, HOST_WIDE_INT @var{size})
4013 If defined, a function that outputs the assembler code for entry to a
4014 function. The prologue is responsible for setting up the stack frame,
4015 initializing the frame pointer register, saving registers that must be
4016 saved, and allocating @var{size} additional bytes of storage for the
4017 local variables. @var{size} is an integer. @var{file} is a stdio
4018 stream to which the assembler code should be output.
4020 The label for the beginning of the function need not be output by this
4021 macro. That has already been done when the macro is run.
4023 @findex regs_ever_live
4024 To determine which registers to save, the macro can refer to the array
4025 @code{regs_ever_live}: element @var{r} is nonzero if hard register
4026 @var{r} is used anywhere within the function. This implies the function
4027 prologue should save register @var{r}, provided it is not one of the
4028 call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use
4029 @code{regs_ever_live}.)
4031 On machines that have ``register windows'', the function entry code does
4032 not save on the stack the registers that are in the windows, even if
4033 they are supposed to be preserved by function calls; instead it takes
4034 appropriate steps to ``push'' the register stack, if any non-call-used
4035 registers are used in the function.
4037 @findex frame_pointer_needed
4038 On machines where functions may or may not have frame-pointers, the
4039 function entry code must vary accordingly; it must set up the frame
4040 pointer if one is wanted, and not otherwise. To determine whether a
4041 frame pointer is in wanted, the macro can refer to the variable
4042 @code{frame_pointer_needed}. The variable's value will be 1 at run
4043 time in a function that needs a frame pointer. @xref{Elimination}.
4045 The function entry code is responsible for allocating any stack space
4046 required for the function. This stack space consists of the regions
4047 listed below. In most cases, these regions are allocated in the
4048 order listed, with the last listed region closest to the top of the
4049 stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and
4050 the highest address if it is not defined). You can use a different order
4051 for a machine if doing so is more convenient or required for
4052 compatibility reasons. Except in cases where required by standard
4053 or by a debugger, there is no reason why the stack layout used by GCC
4054 need agree with that used by other compilers for a machine.
4057 @deftypefn {Target Hook} void TARGET_ASM_FUNCTION_END_PROLOGUE (FILE *@var{file})
4058 If defined, a function that outputs assembler code at the end of a
4059 prologue. This should be used when the function prologue is being
4060 emitted as RTL, and you have some extra assembler that needs to be
4061 emitted. @xref{prologue instruction pattern}.
4064 @deftypefn {Target Hook} void TARGET_ASM_FUNCTION_BEGIN_EPILOGUE (FILE *@var{file})
4065 If defined, a function that outputs assembler code at the start of an
4066 epilogue. This should be used when the function epilogue is being
4067 emitted as RTL, and you have some extra assembler that needs to be
4068 emitted. @xref{epilogue instruction pattern}.
4071 @deftypefn {Target Hook} void TARGET_ASM_FUNCTION_EPILOGUE (FILE *@var{file}, HOST_WIDE_INT @var{size})
4072 If defined, a function that outputs the assembler code for exit from a
4073 function. The epilogue is responsible for restoring the saved
4074 registers and stack pointer to their values when the function was
4075 called, and returning control to the caller. This macro takes the
4076 same arguments as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the
4077 registers to restore are determined from @code{regs_ever_live} and
4078 @code{CALL_USED_REGISTERS} in the same way.
4080 On some machines, there is a single instruction that does all the work
4081 of returning from the function. On these machines, give that
4082 instruction the name @samp{return} and do not define the macro
4083 @code{TARGET_ASM_FUNCTION_EPILOGUE} at all.
4085 Do not define a pattern named @samp{return} if you want the
4086 @code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target
4087 switches to control whether return instructions or epilogues are used,
4088 define a @samp{return} pattern with a validity condition that tests the
4089 target switches appropriately. If the @samp{return} pattern's validity
4090 condition is false, epilogues will be used.
4092 On machines where functions may or may not have frame-pointers, the
4093 function exit code must vary accordingly. Sometimes the code for these
4094 two cases is completely different. To determine whether a frame pointer
4095 is wanted, the macro can refer to the variable
4096 @code{frame_pointer_needed}. The variable's value will be 1 when compiling
4097 a function that needs a frame pointer.
4099 Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and
4100 @code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.
4101 The C variable @code{current_function_is_leaf} is nonzero for such a
4102 function. @xref{Leaf Functions}.
4104 On some machines, some functions pop their arguments on exit while
4105 others leave that for the caller to do. For example, the 68020 when
4106 given @option{-mrtd} pops arguments in functions that take a fixed
4107 number of arguments.
4109 @findex current_function_pops_args
4110 Your definition of the macro @code{RETURN_POPS_ARGS} decides which
4111 functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}
4112 needs to know what was decided. The variable that is called
4113 @code{current_function_pops_args} is the number of bytes of its
4114 arguments that a function should pop. @xref{Scalar Return}.
4115 @c what is the "its arguments" in the above sentence referring to, pray
4116 @c tell? --mew 5feb93
4121 @findex current_function_pretend_args_size
4122 A region of @code{current_function_pretend_args_size} bytes of
4123 uninitialized space just underneath the first argument arriving on the
4124 stack. (This may not be at the very start of the allocated stack region
4125 if the calling sequence has pushed anything else since pushing the stack
4126 arguments. But usually, on such machines, nothing else has been pushed
4127 yet, because the function prologue itself does all the pushing.) This
4128 region is used on machines where an argument may be passed partly in
4129 registers and partly in memory, and, in some cases to support the
4130 features in @code{<stdarg.h>}.
4133 An area of memory used to save certain registers used by the function.
4134 The size of this area, which may also include space for such things as
4135 the return address and pointers to previous stack frames, is
4136 machine-specific and usually depends on which registers have been used
4137 in the function. Machines with register windows often do not require
4141 A region of at least @var{size} bytes, possibly rounded up to an allocation
4142 boundary, to contain the local variables of the function. On some machines,
4143 this region and the save area may occur in the opposite order, with the
4144 save area closer to the top of the stack.
4147 @cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames
4148 Optionally, when @code{ACCUMULATE_OUTGOING_ARGS} is defined, a region of
4149 @code{current_function_outgoing_args_size} bytes to be used for outgoing
4150 argument lists of the function. @xref{Stack Arguments}.
4153 Normally, it is necessary for the macros
4154 @code{TARGET_ASM_FUNCTION_PROLOGUE} and
4155 @code{TARGET_ASM_FUNCTION_EPILOGUE} to treat leaf functions specially.
4156 The C variable @code{current_function_is_leaf} is nonzero for such a
4159 @defmac EXIT_IGNORE_STACK
4160 Define this macro as a C expression that is nonzero if the return
4161 instruction or the function epilogue ignores the value of the stack
4162 pointer; in other words, if it is safe to delete an instruction to
4163 adjust the stack pointer before a return from the function.
4165 Note that this macro's value is relevant only for functions for which
4166 frame pointers are maintained. It is never safe to delete a final
4167 stack adjustment in a function that has no frame pointer, and the
4168 compiler knows this regardless of @code{EXIT_IGNORE_STACK}.
4171 @defmac EPILOGUE_USES (@var{regno})
4172 Define this macro as a C expression that is nonzero for registers that are
4173 used by the epilogue or the @samp{return} pattern. The stack and frame
4174 pointer registers are already be assumed to be used as needed.
4177 @defmac EH_USES (@var{regno})
4178 Define this macro as a C expression that is nonzero for registers that are
4179 used by the exception handling mechanism, and so should be considered live
4180 on entry to an exception edge.
4183 @defmac DELAY_SLOTS_FOR_EPILOGUE
4184 Define this macro if the function epilogue contains delay slots to which
4185 instructions from the rest of the function can be ``moved''. The
4186 definition should be a C expression whose value is an integer
4187 representing the number of delay slots there.
4190 @defmac ELIGIBLE_FOR_EPILOGUE_DELAY (@var{insn}, @var{n})
4191 A C expression that returns 1 if @var{insn} can be placed in delay
4192 slot number @var{n} of the epilogue.
4194 The argument @var{n} is an integer which identifies the delay slot now
4195 being considered (since different slots may have different rules of
4196 eligibility). It is never negative and is always less than the number
4197 of epilogue delay slots (what @code{DELAY_SLOTS_FOR_EPILOGUE} returns).
4198 If you reject a particular insn for a given delay slot, in principle, it
4199 may be reconsidered for a subsequent delay slot. Also, other insns may
4200 (at least in principle) be considered for the so far unfilled delay
4203 @findex current_function_epilogue_delay_list
4204 @findex final_scan_insn
4205 The insns accepted to fill the epilogue delay slots are put in an RTL
4206 list made with @code{insn_list} objects, stored in the variable
4207 @code{current_function_epilogue_delay_list}. The insn for the first
4208 delay slot comes first in the list. Your definition of the macro
4209 @code{TARGET_ASM_FUNCTION_EPILOGUE} should fill the delay slots by
4210 outputting the insns in this list, usually by calling
4211 @code{final_scan_insn}.
4213 You need not define this macro if you did not define
4214 @code{DELAY_SLOTS_FOR_EPILOGUE}.
4217 @deftypefn {Target Hook} void TARGET_ASM_OUTPUT_MI_THUNK (FILE *@var{file}, tree @var{thunk_fndecl}, HOST_WIDE_INT @var{delta}, tree @var{function})
4218 A function that outputs the assembler code for a thunk
4219 function, used to implement C++ virtual function calls with multiple
4220 inheritance. The thunk acts as a wrapper around a virtual function,
4221 adjusting the implicit object parameter before handing control off to
4224 First, emit code to add the integer @var{delta} to the location that
4225 contains the incoming first argument. Assume that this argument
4226 contains a pointer, and is the one used to pass the @code{this} pointer
4227 in C++. This is the incoming argument @emph{before} the function prologue,
4228 e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of
4229 all other incoming arguments.
4231 After the addition, emit code to jump to @var{function}, which is a
4232 @code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does
4233 not touch the return address. Hence returning from @var{FUNCTION} will
4234 return to whoever called the current @samp{thunk}.
4236 The effect must be as if @var{function} had been called directly with
4237 the adjusted first argument. This macro is responsible for emitting all
4238 of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}
4239 and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.
4241 The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}
4242 have already been extracted from it.) It might possibly be useful on
4243 some targets, but probably not.
4245 If you do not define this macro, the target-independent code in the C++
4246 front end will generate a less efficient heavyweight thunk that calls
4247 @var{function} instead of jumping to it. The generic approach does
4248 not support varargs.
4251 @deftypefn {Target Hook} void TARGET_ASM_OUTPUT_MI_VCALL_THUNK (FILE *@var{file}, tree @var{thunk_fndecl}, HOST_WIDE_INT @var{delta}, int @var{vcall_offset}, tree @var{function})
4252 A function like @code{TARGET_ASM_OUTPUT_MI_THUNK}, except that if
4253 @var{vcall_offset} is nonzero, an additional adjustment should be made
4254 after adding @code{delta}. In particular, if @var{p} is the
4255 adjusted pointer, the following adjustment should be made:
4258 p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]
4262 If this function is defined, it will always be used in place of
4263 @code{TARGET_ASM_OUTPUT_MI_THUNK}.
4267 @subsection Generating Code for Profiling
4268 @cindex profiling, code generation
4270 These macros will help you generate code for profiling.
4272 @defmac FUNCTION_PROFILER (@var{file}, @var{labelno})
4273 A C statement or compound statement to output to @var{file} some
4274 assembler code to call the profiling subroutine @code{mcount}.
4277 The details of how @code{mcount} expects to be called are determined by
4278 your operating system environment, not by GCC@. To figure them out,
4279 compile a small program for profiling using the system's installed C
4280 compiler and look at the assembler code that results.
4282 Older implementations of @code{mcount} expect the address of a counter
4283 variable to be loaded into some register. The name of this variable is
4284 @samp{LP} followed by the number @var{labelno}, so you would generate
4285 the name using @samp{LP%d} in a @code{fprintf}.
4288 @defmac PROFILE_HOOK
4289 A C statement or compound statement to output to @var{file} some assembly
4290 code to call the profiling subroutine @code{mcount} even the target does
4291 not support profiling.
4294 @defmac NO_PROFILE_COUNTERS
4295 Define this macro if the @code{mcount} subroutine on your system does
4296 not need a counter variable allocated for each function. This is true
4297 for almost all modern implementations. If you define this macro, you
4298 must not use the @var{labelno} argument to @code{FUNCTION_PROFILER}.
4301 @defmac PROFILE_BEFORE_PROLOGUE
4302 Define this macro if the code for function profiling should come before
4303 the function prologue. Normally, the profiling code comes after.
4307 @subsection Permitting tail calls
4310 @deftypefn {Target Hook} bool TARGET_FUNCTION_OK_FOR_SIBCALL (tree @var{decl}, tree @var{exp})
4311 True if it is ok to do sibling call optimization for the specified
4312 call expression @var{exp}. @var{decl} will be the called function,
4313 or @code{NULL} if this is an indirect call.
4315 It is not uncommon for limitations of calling conventions to prevent
4316 tail calls to functions outside the current unit of translation, or
4317 during PIC compilation. The hook is used to enforce these restrictions,
4318 as the @code{sibcall} md pattern can not fail, or fall over to a
4319 ``normal'' call. The criteria for successful sibling call optimization
4320 may vary greatly between different architectures.
4324 @section Implementing the Varargs Macros
4325 @cindex varargs implementation
4327 GCC comes with an implementation of @code{<varargs.h>} and
4328 @code{<stdarg.h>} that work without change on machines that pass arguments
4329 on the stack. Other machines require their own implementations of
4330 varargs, and the two machine independent header files must have
4331 conditionals to include it.
4333 ISO @code{<stdarg.h>} differs from traditional @code{<varargs.h>} mainly in
4334 the calling convention for @code{va_start}. The traditional
4335 implementation takes just one argument, which is the variable in which
4336 to store the argument pointer. The ISO implementation of
4337 @code{va_start} takes an additional second argument. The user is
4338 supposed to write the last named argument of the function here.
4340 However, @code{va_start} should not use this argument. The way to find
4341 the end of the named arguments is with the built-in functions described
4344 @defmac __builtin_saveregs ()
4345 Use this built-in function to save the argument registers in memory so
4346 that the varargs mechanism can access them. Both ISO and traditional
4347 versions of @code{va_start} must use @code{__builtin_saveregs}, unless
4348 you use @code{SETUP_INCOMING_VARARGS} (see below) instead.
4350 On some machines, @code{__builtin_saveregs} is open-coded under the
4351 control of the macro @code{EXPAND_BUILTIN_SAVEREGS}. On other machines,
4352 it calls a routine written in assembler language, found in
4355 Code generated for the call to @code{__builtin_saveregs} appears at the
4356 beginning of the function, as opposed to where the call to
4357 @code{__builtin_saveregs} is written, regardless of what the code is.
4358 This is because the registers must be saved before the function starts
4359 to use them for its own purposes.
4360 @c i rewrote the first sentence above to fix an overfull hbox. --mew
4364 @defmac __builtin_args_info (@var{category})
4365 Use this built-in function to find the first anonymous arguments in
4368 In general, a machine may have several categories of registers used for
4369 arguments, each for a particular category of data types. (For example,
4370 on some machines, floating-point registers are used for floating-point
4371 arguments while other arguments are passed in the general registers.)
4372 To make non-varargs functions use the proper calling convention, you
4373 have defined the @code{CUMULATIVE_ARGS} data type to record how many
4374 registers in each category have been used so far
4376 @code{__builtin_args_info} accesses the same data structure of type
4377 @code{CUMULATIVE_ARGS} after the ordinary argument layout is finished
4378 with it, with @var{category} specifying which word to access. Thus, the
4379 value indicates the first unused register in a given category.
4381 Normally, you would use @code{__builtin_args_info} in the implementation
4382 of @code{va_start}, accessing each category just once and storing the
4383 value in the @code{va_list} object. This is because @code{va_list} will
4384 have to update the values, and there is no way to alter the
4385 values accessed by @code{__builtin_args_info}.
4388 @defmac __builtin_next_arg (@var{lastarg})
4389 This is the equivalent of @code{__builtin_args_info}, for stack
4390 arguments. It returns the address of the first anonymous stack
4391 argument, as type @code{void *}. If @code{ARGS_GROW_DOWNWARD}, it
4392 returns the address of the location above the first anonymous stack
4393 argument. Use it in @code{va_start} to initialize the pointer for
4394 fetching arguments from the stack. Also use it in @code{va_start} to
4395 verify that the second parameter @var{lastarg} is the last named argument
4396 of the current function.
4399 @defmac __builtin_classify_type (@var{object})
4400 Since each machine has its own conventions for which data types are
4401 passed in which kind of register, your implementation of @code{va_arg}
4402 has to embody these conventions. The easiest way to categorize the
4403 specified data type is to use @code{__builtin_classify_type} together
4404 with @code{sizeof} and @code{__alignof__}.
4406 @code{__builtin_classify_type} ignores the value of @var{object},
4407 considering only its data type. It returns an integer describing what
4408 kind of type that is---integer, floating, pointer, structure, and so on.
4410 The file @file{typeclass.h} defines an enumeration that you can use to
4411 interpret the values of @code{__builtin_classify_type}.
4414 These machine description macros help implement varargs:
4416 @defmac EXPAND_BUILTIN_SAVEREGS ()
4417 If defined, is a C expression that produces the machine-specific code
4418 for a call to @code{__builtin_saveregs}. This code will be moved to the
4419 very beginning of the function, before any parameter access are made.
4420 The return value of this function should be an RTX that contains the
4421 value to use as the return of @code{__builtin_saveregs}.
4424 @defmac SETUP_INCOMING_VARARGS (@var{args_so_far}, @var{mode}, @var{type}, @var{pretend_args_size}, @var{second_time})
4425 This macro offers an alternative to using @code{__builtin_saveregs} and
4426 defining the macro @code{EXPAND_BUILTIN_SAVEREGS}. Use it to store the
4427 anonymous register arguments into the stack so that all the arguments
4428 appear to have been passed consecutively on the stack. Once this is
4429 done, you can use the standard implementation of varargs that works for
4430 machines that pass all their arguments on the stack.
4432 The argument @var{args_so_far} is the @code{CUMULATIVE_ARGS} data
4433 structure, containing the values that are obtained after processing the
4434 named arguments. The arguments @var{mode} and @var{type} describe the
4435 last named argument---its machine mode and its data type as a tree node.
4437 The macro implementation should do two things: first, push onto the
4438 stack all the argument registers @emph{not} used for the named
4439 arguments, and second, store the size of the data thus pushed into the
4440 @code{int}-valued variable whose name is supplied as the argument
4441 @var{pretend_args_size}. The value that you store here will serve as
4442 additional offset for setting up the stack frame.
4444 Because you must generate code to push the anonymous arguments at
4445 compile time without knowing their data types,
4446 @code{SETUP_INCOMING_VARARGS} is only useful on machines that have just
4447 a single category of argument register and use it uniformly for all data
4450 If the argument @var{second_time} is nonzero, it means that the
4451 arguments of the function are being analyzed for the second time. This
4452 happens for an inline function, which is not actually compiled until the
4453 end of the source file. The macro @code{SETUP_INCOMING_VARARGS} should
4454 not generate any instructions in this case.
4457 @defmac STRICT_ARGUMENT_NAMING
4458 Define this macro to be a nonzero value if the location where a function
4459 argument is passed depends on whether or not it is a named argument.
4461 This macro controls how the @var{named} argument to @code{FUNCTION_ARG}
4462 is set for varargs and stdarg functions. If this macro returns a
4463 nonzero value, the @var{named} argument is always true for named
4464 arguments, and false for unnamed arguments. If it returns a value of
4465 zero, but @code{SETUP_INCOMING_VARARGS} is defined, then all arguments
4466 are treated as named. Otherwise, all named arguments except the last
4467 are treated as named.
4469 You need not define this macro if it always returns zero.
4472 @defmac PRETEND_OUTGOING_VARARGS_NAMED
4473 If you need to conditionally change ABIs so that one works with
4474 @code{SETUP_INCOMING_VARARGS}, but the other works like neither
4475 @code{SETUP_INCOMING_VARARGS} nor @code{STRICT_ARGUMENT_NAMING} was
4476 defined, then define this macro to return nonzero if
4477 @code{SETUP_INCOMING_VARARGS} is used, zero otherwise.
4478 Otherwise, you should not define this macro.
4482 @section Trampolines for Nested Functions
4483 @cindex trampolines for nested functions
4484 @cindex nested functions, trampolines for
4486 A @dfn{trampoline} is a small piece of code that is created at run time
4487 when the address of a nested function is taken. It normally resides on
4488 the stack, in the stack frame of the containing function. These macros
4489 tell GCC how to generate code to allocate and initialize a
4492 The instructions in the trampoline must do two things: load a constant
4493 address into the static chain register, and jump to the real address of
4494 the nested function. On CISC machines such as the m68k, this requires
4495 two instructions, a move immediate and a jump. Then the two addresses
4496 exist in the trampoline as word-long immediate operands. On RISC
4497 machines, it is often necessary to load each address into a register in
4498 two parts. Then pieces of each address form separate immediate
4501 The code generated to initialize the trampoline must store the variable
4502 parts---the static chain value and the function address---into the
4503 immediate operands of the instructions. On a CISC machine, this is
4504 simply a matter of copying each address to a memory reference at the
4505 proper offset from the start of the trampoline. On a RISC machine, it
4506 may be necessary to take out pieces of the address and store them
4509 @defmac TRAMPOLINE_TEMPLATE (@var{file})
4510 A C statement to output, on the stream @var{file}, assembler code for a
4511 block of data that contains the constant parts of a trampoline. This
4512 code should not include a label---the label is taken care of
4515 If you do not define this macro, it means no template is needed
4516 for the target. Do not define this macro on systems where the block move
4517 code to copy the trampoline into place would be larger than the code
4518 to generate it on the spot.
4521 @defmac TRAMPOLINE_SECTION
4522 The name of a subroutine to switch to the section in which the
4523 trampoline template is to be placed (@pxref{Sections}). The default is
4524 a value of @samp{readonly_data_section}, which places the trampoline in
4525 the section containing read-only data.
4528 @defmac TRAMPOLINE_SIZE
4529 A C expression for the size in bytes of the trampoline, as an integer.
4532 @defmac TRAMPOLINE_ALIGNMENT
4533 Alignment required for trampolines, in bits.
4535 If you don't define this macro, the value of @code{BIGGEST_ALIGNMENT}
4536 is used for aligning trampolines.
4539 @defmac INITIALIZE_TRAMPOLINE (@var{addr}, @var{fnaddr}, @var{static_chain})
4540 A C statement to initialize the variable parts of a trampoline.
4541 @var{addr} is an RTX for the address of the trampoline; @var{fnaddr} is
4542 an RTX for the address of the nested function; @var{static_chain} is an
4543 RTX for the static chain value that should be passed to the function
4547 @defmac TRAMPOLINE_ADJUST_ADDRESS (@var{addr})
4548 A C statement that should perform any machine-specific adjustment in
4549 the address of the trampoline. Its argument contains the address that
4550 was passed to @code{INITIALIZE_TRAMPOLINE}. In case the address to be
4551 used for a function call should be different from the address in which
4552 the template was stored, the different address should be assigned to
4553 @var{addr}. If this macro is not defined, @var{addr} will be used for
4556 @cindex @code{TARGET_ASM_FUNCTION_EPILOGUE} and trampolines
4557 @cindex @code{TARGET_ASM_FUNCTION_PROLOGUE} and trampolines
4558 If this macro is not defined, by default the trampoline is allocated as
4559 a stack slot. This default is right for most machines. The exceptions
4560 are machines where it is impossible to execute instructions in the stack
4561 area. On such machines, you may have to implement a separate stack,
4562 using this macro in conjunction with @code{TARGET_ASM_FUNCTION_PROLOGUE}
4563 and @code{TARGET_ASM_FUNCTION_EPILOGUE}.
4565 @var{fp} points to a data structure, a @code{struct function}, which
4566 describes the compilation status of the immediate containing function of
4567 the function which the trampoline is for. The stack slot for the
4568 trampoline is in the stack frame of this containing function. Other
4569 allocation strategies probably must do something analogous with this
4573 Implementing trampolines is difficult on many machines because they have
4574 separate instruction and data caches. Writing into a stack location
4575 fails to clear the memory in the instruction cache, so when the program
4576 jumps to that location, it executes the old contents.
4578 Here are two possible solutions. One is to clear the relevant parts of
4579 the instruction cache whenever a trampoline is set up. The other is to
4580 make all trampolines identical, by having them jump to a standard
4581 subroutine. The former technique makes trampoline execution faster; the
4582 latter makes initialization faster.
4584 To clear the instruction cache when a trampoline is initialized, define
4585 the following macro.
4587 @defmac CLEAR_INSN_CACHE (@var{beg}, @var{end})
4588 If defined, expands to a C expression clearing the @emph{instruction
4589 cache} in the specified interval. The definition of this macro would
4590 typically be a series of @code{asm} statements. Both @var{beg} and
4591 @var{end} are both pointer expressions.
4594 To use a standard subroutine, define the following macro. In addition,
4595 you must make sure that the instructions in a trampoline fill an entire
4596 cache line with identical instructions, or else ensure that the
4597 beginning of the trampoline code is always aligned at the same point in
4598 its cache line. Look in @file{m68k.h} as a guide.
4600 @defmac TRANSFER_FROM_TRAMPOLINE
4601 Define this macro if trampolines need a special subroutine to do their
4602 work. The macro should expand to a series of @code{asm} statements
4603 which will be compiled with GCC@. They go in a library function named
4604 @code{__transfer_from_trampoline}.
4606 If you need to avoid executing the ordinary prologue code of a compiled
4607 C function when you jump to the subroutine, you can do so by placing a
4608 special label of your own in the assembler code. Use one @code{asm}
4609 statement to generate an assembler label, and another to make the label
4610 global. Then trampolines can use that label to jump directly to your
4611 special assembler code.
4615 @section Implicit Calls to Library Routines
4616 @cindex library subroutine names
4617 @cindex @file{libgcc.a}
4619 @c prevent bad page break with this line
4620 Here is an explanation of implicit calls to library routines.
4622 @defmac MULSI3_LIBCALL
4623 A C string constant giving the name of the function to call for
4624 multiplication of one signed full-word by another. If you do not
4625 define this macro, the default name is used, which is @code{__mulsi3},
4626 a function defined in @file{libgcc.a}.
4629 @defmac DIVSI3_LIBCALL
4630 A C string constant giving the name of the function to call for
4631 division of one signed full-word by another. If you do not define
4632 this macro, the default name is used, which is @code{__divsi3}, a
4633 function defined in @file{libgcc.a}.
4636 @defmac UDIVSI3_LIBCALL
4637 A C string constant giving the name of the function to call for
4638 division of one unsigned full-word by another. If you do not define
4639 this macro, the default name is used, which is @code{__udivsi3}, a
4640 function defined in @file{libgcc.a}.
4643 @defmac MODSI3_LIBCALL
4644 A C string constant giving the name of the function to call for the
4645 remainder in division of one signed full-word by another. If you do
4646 not define this macro, the default name is used, which is
4647 @code{__modsi3}, a function defined in @file{libgcc.a}.
4650 @defmac UMODSI3_LIBCALL
4651 A C string constant giving the name of the function to call for the
4652 remainder in division of one unsigned full-word by another. If you do
4653 not define this macro, the default name is used, which is
4654 @code{__umodsi3}, a function defined in @file{libgcc.a}.
4657 @defmac MULDI3_LIBCALL
4658 A C string constant giving the name of the function to call for
4659 multiplication of one signed double-word by another. If you do not
4660 define this macro, the default name is used, which is @code{__muldi3},
4661 a function defined in @file{libgcc.a}.
4664 @defmac DIVDI3_LIBCALL
4665 A C string constant giving the name of the function to call for
4666 division of one signed double-word by another. If you do not define
4667 this macro, the default name is used, which is @code{__divdi3}, a
4668 function defined in @file{libgcc.a}.
4671 @defmac UDIVDI3_LIBCALL
4672 A C string constant giving the name of the function to call for
4673 division of one unsigned full-word by another. If you do not define
4674 this macro, the default name is used, which is @code{__udivdi3}, a
4675 function defined in @file{libgcc.a}.
4678 @defmac MODDI3_LIBCALL
4679 A C string constant giving the name of the function to call for the
4680 remainder in division of one signed double-word by another. If you do
4681 not define this macro, the default name is used, which is
4682 @code{__moddi3}, a function defined in @file{libgcc.a}.
4685 @defmac UMODDI3_LIBCALL
4686 A C string constant giving the name of the function to call for the
4687 remainder in division of one unsigned full-word by another. If you do
4688 not define this macro, the default name is used, which is
4689 @code{__umoddi3}, a function defined in @file{libgcc.a}.
4692 @defmac DECLARE_LIBRARY_RENAMES
4693 This macro, if defined, should expand to a piece of C code that will get
4694 expanded when compiling functions for libgcc.a. It can be used to
4695 provide alternate names for gcc's internal library functions if there
4696 are ABI-mandated names that the compiler should provide.
4699 @defmac INIT_TARGET_OPTABS
4700 Define this macro as a C statement that declares additional library
4701 routines renames existing ones. @code{init_optabs} calls this macro after
4702 initializing all the normal library routines.
4705 @defmac FLOAT_LIB_COMPARE_RETURNS_BOOL (@var{mode}, @var{comparison})
4706 Define this macro as a C statement that returns nonzero if a call to
4707 the floating point comparison library function will return a boolean
4708 value that indicates the result of the comparison. It should return
4709 zero if one of gcc's own libgcc functions is called.
4711 Most ports don't need to define this macro.
4714 @cindex @code{EDOM}, implicit usage
4717 The value of @code{EDOM} on the target machine, as a C integer constant
4718 expression. If you don't define this macro, GCC does not attempt to
4719 deposit the value of @code{EDOM} into @code{errno} directly. Look in
4720 @file{/usr/include/errno.h} to find the value of @code{EDOM} on your
4723 If you do not define @code{TARGET_EDOM}, then compiled code reports
4724 domain errors by calling the library function and letting it report the
4725 error. If mathematical functions on your system use @code{matherr} when
4726 there is an error, then you should leave @code{TARGET_EDOM} undefined so
4727 that @code{matherr} is used normally.
4730 @cindex @code{errno}, implicit usage
4731 @defmac GEN_ERRNO_RTX
4732 Define this macro as a C expression to create an rtl expression that
4733 refers to the global ``variable'' @code{errno}. (On certain systems,
4734 @code{errno} may not actually be a variable.) If you don't define this
4735 macro, a reasonable default is used.
4738 @cindex @code{bcopy}, implicit usage
4739 @cindex @code{memcpy}, implicit usage
4740 @cindex @code{memmove}, implicit usage
4741 @cindex @code{bzero}, implicit usage
4742 @cindex @code{memset}, implicit usage
4743 @defmac TARGET_MEM_FUNCTIONS
4744 Define this macro if GCC should generate calls to the ISO C
4745 (and System V) library functions @code{memcpy}, @code{memmove} and
4746 @code{memset} rather than the BSD functions @code{bcopy} and @code{bzero}.
4749 @cindex C99 math functions, implicit usage
4750 @defmac TARGET_C99_FUNCTIONS
4751 When this macro is nonzero, GCC will implicitly optimize @code{sin} calls into
4752 @code{sinf} and similarly for other functions defined by C99 standard. The
4753 default is nonzero that should be proper value for most modern systems, however
4754 number of existing systems lacks support for these functions in the runtime so
4755 they needs this macro to be redefined to 0.
4758 @defmac LIBGCC_NEEDS_DOUBLE
4759 Define this macro if @code{float} arguments cannot be passed to library
4760 routines (so they must be converted to @code{double}). This macro
4761 affects both how library calls are generated and how the library
4762 routines in @file{libgcc.a} accept their arguments. It is useful on
4763 machines where floating and fixed point arguments are passed
4764 differently, such as the i860.
4767 @defmac NEXT_OBJC_RUNTIME
4768 Define this macro to generate code for Objective-C message sending using
4769 the calling convention of the NeXT system. This calling convention
4770 involves passing the object, the selector and the method arguments all
4771 at once to the method-lookup library function.
4773 The default calling convention passes just the object and the selector
4774 to the lookup function, which returns a pointer to the method.
4777 @node Addressing Modes
4778 @section Addressing Modes
4779 @cindex addressing modes
4781 @c prevent bad page break with this line
4782 This is about addressing modes.
4784 @defmac HAVE_PRE_INCREMENT
4785 @defmacx HAVE_PRE_DECREMENT
4786 @defmacx HAVE_POST_INCREMENT
4787 @defmacx HAVE_POST_DECREMENT
4788 A C expression that is nonzero if the machine supports pre-increment,
4789 pre-decrement, post-increment, or post-decrement addressing respectively.
4792 @defmac HAVE_PRE_MODIFY_DISP
4793 @defmacx HAVE_POST_MODIFY_DISP
4794 A C expression that is nonzero if the machine supports pre- or
4795 post-address side-effect generation involving constants other than
4796 the size of the memory operand.
4799 @defmac HAVE_PRE_MODIFY_REG
4800 @defmacx HAVE_POST_MODIFY_REG
4801 A C expression that is nonzero if the machine supports pre- or
4802 post-address side-effect generation involving a register displacement.
4805 @defmac CONSTANT_ADDRESS_P (@var{x})
4806 A C expression that is 1 if the RTX @var{x} is a constant which
4807 is a valid address. On most machines, this can be defined as
4808 @code{CONSTANT_P (@var{x})}, but a few machines are more restrictive
4809 in which constant addresses are supported.
4812 @defmac CONSTANT_P (@var{x})
4813 @code{CONSTANT_P}, which is defined by target-independent code,
4814 accepts integer-values expressions whose values are not explicitly
4815 known, such as @code{symbol_ref}, @code{label_ref}, and @code{high}
4816 expressions and @code{const} arithmetic expressions, in addition to
4817 @code{const_int} and @code{const_double} expressions.
4820 @defmac MAX_REGS_PER_ADDRESS
4821 A number, the maximum number of registers that can appear in a valid
4822 memory address. Note that it is up to you to specify a value equal to
4823 the maximum number that @code{GO_IF_LEGITIMATE_ADDRESS} would ever
4827 @defmac GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})
4828 A C compound statement with a conditional @code{goto @var{label};}
4829 executed if @var{x} (an RTX) is a legitimate memory address on the
4830 target machine for a memory operand of mode @var{mode}.
4832 It usually pays to define several simpler macros to serve as
4833 subroutines for this one. Otherwise it may be too complicated to
4836 This macro must exist in two variants: a strict variant and a
4837 non-strict one. The strict variant is used in the reload pass. It
4838 must be defined so that any pseudo-register that has not been
4839 allocated a hard register is considered a memory reference. In
4840 contexts where some kind of register is required, a pseudo-register
4841 with no hard register must be rejected.
4843 The non-strict variant is used in other passes. It must be defined to
4844 accept all pseudo-registers in every context where some kind of
4845 register is required.
4847 @findex REG_OK_STRICT
4848 Compiler source files that want to use the strict variant of this
4849 macro define the macro @code{REG_OK_STRICT}. You should use an
4850 @code{#ifdef REG_OK_STRICT} conditional to define the strict variant
4851 in that case and the non-strict variant otherwise.
4853 Subroutines to check for acceptable registers for various purposes (one
4854 for base registers, one for index registers, and so on) are typically
4855 among the subroutines used to define @code{GO_IF_LEGITIMATE_ADDRESS}.
4856 Then only these subroutine macros need have two variants; the higher
4857 levels of macros may be the same whether strict or not.
4859 Normally, constant addresses which are the sum of a @code{symbol_ref}
4860 and an integer are stored inside a @code{const} RTX to mark them as
4861 constant. Therefore, there is no need to recognize such sums
4862 specifically as legitimate addresses. Normally you would simply
4863 recognize any @code{const} as legitimate.
4865 Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant
4866 sums that are not marked with @code{const}. It assumes that a naked
4867 @code{plus} indicates indexing. If so, then you @emph{must} reject such
4868 naked constant sums as illegitimate addresses, so that none of them will
4869 be given to @code{PRINT_OPERAND_ADDRESS}.
4871 @cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation
4872 On some machines, whether a symbolic address is legitimate depends on
4873 the section that the address refers to. On these machines, define the
4874 target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information
4875 into the @code{symbol_ref}, and then check for it here. When you see a
4876 @code{const}, you will have to look inside it to find the
4877 @code{symbol_ref} in order to determine the section. @xref{Assembler
4881 @defmac REG_OK_FOR_BASE_P (@var{x})
4882 A C expression that is nonzero if @var{x} (assumed to be a @code{reg}
4883 RTX) is valid for use as a base register. For hard registers, it
4884 should always accept those which the hardware permits and reject the
4885 others. Whether the macro accepts or rejects pseudo registers must be
4886 controlled by @code{REG_OK_STRICT} as described above. This usually
4887 requires two variant definitions, of which @code{REG_OK_STRICT}
4888 controls the one actually used.
4891 @defmac REG_MODE_OK_FOR_BASE_P (@var{x}, @var{mode})
4892 A C expression that is just like @code{REG_OK_FOR_BASE_P}, except that
4893 that expression may examine the mode of the memory reference in
4894 @var{mode}. You should define this macro if the mode of the memory
4895 reference affects whether a register may be used as a base register. If
4896 you define this macro, the compiler will use it instead of
4897 @code{REG_OK_FOR_BASE_P}.
4900 @defmac REG_OK_FOR_INDEX_P (@var{x})
4901 A C expression that is nonzero if @var{x} (assumed to be a @code{reg}
4902 RTX) is valid for use as an index register.
4904 The difference between an index register and a base register is that
4905 the index register may be scaled. If an address involves the sum of
4906 two registers, neither one of them scaled, then either one may be
4907 labeled the ``base'' and the other the ``index''; but whichever
4908 labeling is used must fit the machine's constraints of which registers
4909 may serve in each capacity. The compiler will try both labelings,
4910 looking for one that is valid, and will reload one or both registers
4911 only if neither labeling works.
4914 @defmac FIND_BASE_TERM (@var{x})
4915 A C expression to determine the base term of address @var{x}.
4916 This macro is used in only one place: `find_base_term' in alias.c.
4918 It is always safe for this macro to not be defined. It exists so
4919 that alias analysis can understand machine-dependent addresses.
4921 The typical use of this macro is to handle addresses containing
4922 a label_ref or symbol_ref within an UNSPEC@.
4925 @defmac LEGITIMIZE_ADDRESS (@var{x}, @var{oldx}, @var{mode}, @var{win})
4926 A C compound statement that attempts to replace @var{x} with a valid
4927 memory address for an operand of mode @var{mode}. @var{win} will be a
4928 C statement label elsewhere in the code; the macro definition may use
4931 GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{win});
4935 to avoid further processing if the address has become legitimate.
4937 @findex break_out_memory_refs
4938 @var{x} will always be the result of a call to @code{break_out_memory_refs},
4939 and @var{oldx} will be the operand that was given to that function to produce
4942 The code generated by this macro should not alter the substructure of
4943 @var{x}. If it transforms @var{x} into a more legitimate form, it
4944 should assign @var{x} (which will always be a C variable) a new value.
4946 It is not necessary for this macro to come up with a legitimate
4947 address. The compiler has standard ways of doing so in all cases. In
4948 fact, it is safe for this macro to do nothing. But often a
4949 machine-dependent strategy can generate better code.
4952 @defmac LEGITIMIZE_RELOAD_ADDRESS (@var{x}, @var{mode}, @var{opnum}, @var{type}, @var{ind_levels}, @var{win})
4953 A C compound statement that attempts to replace @var{x}, which is an address
4954 that needs reloading, with a valid memory address for an operand of mode
4955 @var{mode}. @var{win} will be a C statement label elsewhere in the code.
4956 It is not necessary to define this macro, but it might be useful for
4957 performance reasons.
4959 For example, on the i386, it is sometimes possible to use a single
4960 reload register instead of two by reloading a sum of two pseudo
4961 registers into a register. On the other hand, for number of RISC
4962 processors offsets are limited so that often an intermediate address
4963 needs to be generated in order to address a stack slot. By defining
4964 @code{LEGITIMIZE_RELOAD_ADDRESS} appropriately, the intermediate addresses
4965 generated for adjacent some stack slots can be made identical, and thus
4968 @emph{Note}: This macro should be used with caution. It is necessary
4969 to know something of how reload works in order to effectively use this,
4970 and it is quite easy to produce macros that build in too much knowledge
4971 of reload internals.
4973 @emph{Note}: This macro must be able to reload an address created by a
4974 previous invocation of this macro. If it fails to handle such addresses
4975 then the compiler may generate incorrect code or abort.
4978 The macro definition should use @code{push_reload} to indicate parts that
4979 need reloading; @var{opnum}, @var{type} and @var{ind_levels} are usually
4980 suitable to be passed unaltered to @code{push_reload}.
4982 The code generated by this macro must not alter the substructure of
4983 @var{x}. If it transforms @var{x} into a more legitimate form, it
4984 should assign @var{x} (which will always be a C variable) a new value.
4985 This also applies to parts that you change indirectly by calling
4988 @findex strict_memory_address_p
4989 The macro definition may use @code{strict_memory_address_p} to test if
4990 the address has become legitimate.
4993 If you want to change only a part of @var{x}, one standard way of doing
4994 this is to use @code{copy_rtx}. Note, however, that is unshares only a
4995 single level of rtl. Thus, if the part to be changed is not at the
4996 top level, you'll need to replace first the top level.
4997 It is not necessary for this macro to come up with a legitimate
4998 address; but often a machine-dependent strategy can generate better code.
5001 @defmac GO_IF_MODE_DEPENDENT_ADDRESS (@var{addr}, @var{label})
5002 A C statement or compound statement with a conditional @code{goto
5003 @var{label};} executed if memory address @var{x} (an RTX) can have
5004 different meanings depending on the machine mode of the memory
5005 reference it is used for or if the address is valid for some modes
5008 Autoincrement and autodecrement addresses typically have mode-dependent
5009 effects because the amount of the increment or decrement is the size
5010 of the operand being addressed. Some machines have other mode-dependent
5011 addresses. Many RISC machines have no mode-dependent addresses.
5013 You may assume that @var{addr} is a valid address for the machine.
5016 @defmac LEGITIMATE_CONSTANT_P (@var{x})
5017 A C expression that is nonzero if @var{x} is a legitimate constant for
5018 an immediate operand on the target machine. You can assume that
5019 @var{x} satisfies @code{CONSTANT_P}, so you need not check this. In fact,
5020 @samp{1} is a suitable definition for this macro on machines where
5021 anything @code{CONSTANT_P} is valid.
5024 @node Condition Code
5025 @section Condition Code Status
5026 @cindex condition code status
5028 @c prevent bad page break with this line
5029 This describes the condition code status.
5032 The file @file{conditions.h} defines a variable @code{cc_status} to
5033 describe how the condition code was computed (in case the interpretation of
5034 the condition code depends on the instruction that it was set by). This
5035 variable contains the RTL expressions on which the condition code is
5036 currently based, and several standard flags.
5038 Sometimes additional machine-specific flags must be defined in the machine
5039 description header file. It can also add additional machine-specific
5040 information by defining @code{CC_STATUS_MDEP}.
5042 @defmac CC_STATUS_MDEP
5043 C code for a data type which is used for declaring the @code{mdep}
5044 component of @code{cc_status}. It defaults to @code{int}.
5046 This macro is not used on machines that do not use @code{cc0}.
5049 @defmac CC_STATUS_MDEP_INIT
5050 A C expression to initialize the @code{mdep} field to ``empty''.
5051 The default definition does nothing, since most machines don't use
5052 the field anyway. If you want to use the field, you should probably
5053 define this macro to initialize it.
5055 This macro is not used on machines that do not use @code{cc0}.
5058 @defmac NOTICE_UPDATE_CC (@var{exp}, @var{insn})
5059 A C compound statement to set the components of @code{cc_status}
5060 appropriately for an insn @var{insn} whose body is @var{exp}. It is
5061 this macro's responsibility to recognize insns that set the condition
5062 code as a byproduct of other activity as well as those that explicitly
5065 This macro is not used on machines that do not use @code{cc0}.
5067 If there are insns that do not set the condition code but do alter
5068 other machine registers, this macro must check to see whether they
5069 invalidate the expressions that the condition code is recorded as
5070 reflecting. For example, on the 68000, insns that store in address
5071 registers do not set the condition code, which means that usually
5072 @code{NOTICE_UPDATE_CC} can leave @code{cc_status} unaltered for such
5073 insns. But suppose that the previous insn set the condition code
5074 based on location @samp{a4@@(102)} and the current insn stores a new
5075 value in @samp{a4}. Although the condition code is not changed by
5076 this, it will no longer be true that it reflects the contents of
5077 @samp{a4@@(102)}. Therefore, @code{NOTICE_UPDATE_CC} must alter
5078 @code{cc_status} in this case to say that nothing is known about the
5079 condition code value.
5081 The definition of @code{NOTICE_UPDATE_CC} must be prepared to deal
5082 with the results of peephole optimization: insns whose patterns are
5083 @code{parallel} RTXs containing various @code{reg}, @code{mem} or
5084 constants which are just the operands. The RTL structure of these
5085 insns is not sufficient to indicate what the insns actually do. What
5086 @code{NOTICE_UPDATE_CC} should do when it sees one is just to run
5087 @code{CC_STATUS_INIT}.
5089 A possible definition of @code{NOTICE_UPDATE_CC} is to call a function
5090 that looks at an attribute (@pxref{Insn Attributes}) named, for example,
5091 @samp{cc}. This avoids having detailed information about patterns in
5092 two places, the @file{md} file and in @code{NOTICE_UPDATE_CC}.
5095 @defmac EXTRA_CC_MODES
5096 Condition codes are represented in registers by machine modes of class
5097 @code{MODE_CC}. By default, there is just one mode, @code{CCmode}, with
5098 this class. If you need more such modes, create a file named
5099 @file{@var{machine}-modes.def} in your @file{config/@var{machine}}
5100 directory (@pxref{Back End, , Anatomy of a Target Back End}), containing
5101 a list of these modes. Each entry in the list should be a call to the
5102 macro @code{CC}. This macro takes one argument, which is the name of
5103 the mode: it should begin with @samp{CC}. Do not put quotation marks
5104 around the name, or include the trailing @samp{mode}; these are
5105 automatically added. There should not be anything else in the file
5108 A sample @file{@var{machine}-modes.def} file might look like this:
5111 CC (CC_NOOV) /* @r{Comparison only valid if there was no overflow.} */
5112 CC (CCFP) /* @r{Floating point comparison that cannot trap.} */
5113 CC (CCFPE) /* @r{Floating point comparison that may trap.} */
5116 When you create this file, the macro @code{EXTRA_CC_MODES} is
5117 automatically defined by @command{configure}, with value @samp{1}.
5120 @defmac SELECT_CC_MODE (@var{op}, @var{x}, @var{y})
5121 Returns a mode from class @code{MODE_CC} to be used when comparison
5122 operation code @var{op} is applied to rtx @var{x} and @var{y}. For
5123 example, on the SPARC, @code{SELECT_CC_MODE} is defined as (see
5124 @pxref{Jump Patterns} for a description of the reason for this
5128 #define SELECT_CC_MODE(OP,X,Y) \
5129 (GET_MODE_CLASS (GET_MODE (X)) == MODE_FLOAT \
5130 ? ((OP == EQ || OP == NE) ? CCFPmode : CCFPEmode) \
5131 : ((GET_CODE (X) == PLUS || GET_CODE (X) == MINUS \
5132 || GET_CODE (X) == NEG) \
5133 ? CC_NOOVmode : CCmode))
5136 You need not define this macro if @code{EXTRA_CC_MODES} is not defined.
5139 @defmac CANONICALIZE_COMPARISON (@var{code}, @var{op0}, @var{op1})
5140 On some machines not all possible comparisons are defined, but you can
5141 convert an invalid comparison into a valid one. For example, the Alpha
5142 does not have a @code{GT} comparison, but you can use an @code{LT}
5143 comparison instead and swap the order of the operands.
5145 On such machines, define this macro to be a C statement to do any
5146 required conversions. @var{code} is the initial comparison code
5147 and @var{op0} and @var{op1} are the left and right operands of the
5148 comparison, respectively. You should modify @var{code}, @var{op0}, and
5149 @var{op1} as required.
5151 GCC will not assume that the comparison resulting from this macro is
5152 valid but will see if the resulting insn matches a pattern in the
5155 You need not define this macro if it would never change the comparison
5159 @defmac REVERSIBLE_CC_MODE (@var{mode})
5160 A C expression whose value is one if it is always safe to reverse a
5161 comparison whose mode is @var{mode}. If @code{SELECT_CC_MODE}
5162 can ever return @var{mode} for a floating-point inequality comparison,
5163 then @code{REVERSIBLE_CC_MODE (@var{mode})} must be zero.
5165 You need not define this macro if it would always returns zero or if the
5166 floating-point format is anything other than @code{IEEE_FLOAT_FORMAT}.
5167 For example, here is the definition used on the SPARC, where floating-point
5168 inequality comparisons are always given @code{CCFPEmode}:
5171 #define REVERSIBLE_CC_MODE(MODE) ((MODE) != CCFPEmode)
5175 @defmac REVERSE_CONDITION (@var{code}, @var{mode})
5176 A C expression whose value is reversed condition code of the @var{code} for
5177 comparison done in CC_MODE @var{mode}. The macro is used only in case
5178 @code{REVERSIBLE_CC_MODE (@var{mode})} is nonzero. Define this macro in case
5179 machine has some non-standard way how to reverse certain conditionals. For
5180 instance in case all floating point conditions are non-trapping, compiler may
5181 freely convert unordered compares to ordered one. Then definition may look
5185 #define REVERSE_CONDITION(CODE, MODE) \
5186 ((MODE) != CCFPmode ? reverse_condition (CODE) \
5187 : reverse_condition_maybe_unordered (CODE))
5191 @defmac REVERSE_CONDEXEC_PREDICATES_P (@var{code1}, @var{code2})
5192 A C expression that returns true if the conditional execution predicate
5193 @var{code1} is the inverse of @var{code2} and vice versa. Define this to
5194 return 0 if the target has conditional execution predicates that cannot be
5195 reversed safely. If no expansion is specified, this macro is defined as
5199 #define REVERSE_CONDEXEC_PREDICATES_P (x, y) \
5200 ((x) == reverse_condition (y))
5205 @section Describing Relative Costs of Operations
5206 @cindex costs of instructions
5207 @cindex relative costs
5208 @cindex speed of instructions
5210 These macros let you describe the relative speed of various operations
5211 on the target machine.
5213 @defmac REGISTER_MOVE_COST (@var{mode}, @var{from}, @var{to})
5214 A C expression for the cost of moving data of mode @var{mode} from a
5215 register in class @var{from} to one in class @var{to}. The classes are
5216 expressed using the enumeration values such as @code{GENERAL_REGS}. A
5217 value of 2 is the default; other values are interpreted relative to
5220 It is not required that the cost always equal 2 when @var{from} is the
5221 same as @var{to}; on some machines it is expensive to move between
5222 registers if they are not general registers.
5224 If reload sees an insn consisting of a single @code{set} between two
5225 hard registers, and if @code{REGISTER_MOVE_COST} applied to their
5226 classes returns a value of 2, reload does not check to ensure that the
5227 constraints of the insn are met. Setting a cost of other than 2 will
5228 allow reload to verify that the constraints are met. You should do this
5229 if the @samp{mov@var{m}} pattern's constraints do not allow such copying.
5232 @defmac MEMORY_MOVE_COST (@var{mode}, @var{class}, @var{in})
5233 A C expression for the cost of moving data of mode @var{mode} between a
5234 register of class @var{class} and memory; @var{in} is zero if the value
5235 is to be written to memory, nonzero if it is to be read in. This cost
5236 is relative to those in @code{REGISTER_MOVE_COST}. If moving between
5237 registers and memory is more expensive than between two registers, you
5238 should define this macro to express the relative cost.
5240 If you do not define this macro, GCC uses a default cost of 4 plus
5241 the cost of copying via a secondary reload register, if one is
5242 needed. If your machine requires a secondary reload register to copy
5243 between memory and a register of @var{class} but the reload mechanism is
5244 more complex than copying via an intermediate, define this macro to
5245 reflect the actual cost of the move.
5247 GCC defines the function @code{memory_move_secondary_cost} if
5248 secondary reloads are needed. It computes the costs due to copying via
5249 a secondary register. If your machine copies from memory using a
5250 secondary register in the conventional way but the default base value of
5251 4 is not correct for your machine, define this macro to add some other
5252 value to the result of that function. The arguments to that function
5253 are the same as to this macro.
5257 A C expression for the cost of a branch instruction. A value of 1 is
5258 the default; other values are interpreted relative to that.
5261 Here are additional macros which do not specify precise relative costs,
5262 but only that certain actions are more expensive than GCC would
5265 @defmac SLOW_BYTE_ACCESS
5266 Define this macro as a C expression which is nonzero if accessing less
5267 than a word of memory (i.e.@: a @code{char} or a @code{short}) is no
5268 faster than accessing a word of memory, i.e., if such access
5269 require more than one instruction or if there is no difference in cost
5270 between byte and (aligned) word loads.
5272 When this macro is not defined, the compiler will access a field by
5273 finding the smallest containing object; when it is defined, a fullword
5274 load will be used if alignment permits. Unless bytes accesses are
5275 faster than word accesses, using word accesses is preferable since it
5276 may eliminate subsequent memory access if subsequent accesses occur to
5277 other fields in the same word of the structure, but to different bytes.
5280 @defmac SLOW_UNALIGNED_ACCESS (@var{mode}, @var{alignment})
5281 Define this macro to be the value 1 if memory accesses described by the
5282 @var{mode} and @var{alignment} parameters have a cost many times greater
5283 than aligned accesses, for example if they are emulated in a trap
5286 When this macro is nonzero, the compiler will act as if
5287 @code{STRICT_ALIGNMENT} were nonzero when generating code for block
5288 moves. This can cause significantly more instructions to be produced.
5289 Therefore, do not set this macro nonzero if unaligned accesses only add a
5290 cycle or two to the time for a memory access.
5292 If the value of this macro is always zero, it need not be defined. If
5293 this macro is defined, it should produce a nonzero value when
5294 @code{STRICT_ALIGNMENT} is nonzero.
5298 The threshold of number of scalar memory-to-memory move insns, @emph{below}
5299 which a sequence of insns should be generated instead of a
5300 string move insn or a library call. Increasing the value will always
5301 make code faster, but eventually incurs high cost in increased code size.
5303 Note that on machines where the corresponding move insn is a
5304 @code{define_expand} that emits a sequence of insns, this macro counts
5305 the number of such sequences.
5307 If you don't define this, a reasonable default is used.
5310 @defmac MOVE_BY_PIECES_P (@var{size}, @var{alignment})
5311 A C expression used to determine whether @code{move_by_pieces} will be used to
5312 copy a chunk of memory, or whether some other block move mechanism
5313 will be used. Defaults to 1 if @code{move_by_pieces_ninsns} returns less
5314 than @code{MOVE_RATIO}.
5317 @defmac MOVE_MAX_PIECES
5318 A C expression used by @code{move_by_pieces} to determine the largest unit
5319 a load or store used to copy memory is. Defaults to @code{MOVE_MAX}.
5323 The threshold of number of scalar move insns, @emph{below} which a sequence
5324 of insns should be generated to clear memory instead of a string clear insn
5325 or a library call. Increasing the value will always make code faster, but
5326 eventually incurs high cost in increased code size.
5328 If you don't define this, a reasonable default is used.
5331 @defmac CLEAR_BY_PIECES_P (@var{size}, @var{alignment})
5332 A C expression used to determine whether @code{clear_by_pieces} will be used
5333 to clear a chunk of memory, or whether some other block clear mechanism
5334 will be used. Defaults to 1 if @code{move_by_pieces_ninsns} returns less
5335 than @code{CLEAR_RATIO}.
5338 @defmac STORE_BY_PIECES_P (@var{size}, @var{alignment})
5339 A C expression used to determine whether @code{store_by_pieces} will be
5340 used to set a chunk of memory to a constant value, or whether some other
5341 mechanism will be used. Used by @code{__builtin_memset} when storing
5342 values other than constant zero and by @code{__builtin_strcpy} when
5343 when called with a constant source string.
5344 Defaults to @code{MOVE_BY_PIECES_P}.
5347 @defmac USE_LOAD_POST_INCREMENT (@var{mode})
5348 A C expression used to determine whether a load postincrement is a good
5349 thing to use for a given mode. Defaults to the value of
5350 @code{HAVE_POST_INCREMENT}.
5353 @defmac USE_LOAD_POST_DECREMENT (@var{mode})
5354 A C expression used to determine whether a load postdecrement is a good
5355 thing to use for a given mode. Defaults to the value of
5356 @code{HAVE_POST_DECREMENT}.
5359 @defmac USE_LOAD_PRE_INCREMENT (@var{mode})
5360 A C expression used to determine whether a load preincrement is a good
5361 thing to use for a given mode. Defaults to the value of
5362 @code{HAVE_PRE_INCREMENT}.
5365 @defmac USE_LOAD_PRE_DECREMENT (@var{mode})
5366 A C expression used to determine whether a load predecrement is a good
5367 thing to use for a given mode. Defaults to the value of
5368 @code{HAVE_PRE_DECREMENT}.
5371 @defmac USE_STORE_POST_INCREMENT (@var{mode})
5372 A C expression used to determine whether a store postincrement is a good
5373 thing to use for a given mode. Defaults to the value of
5374 @code{HAVE_POST_INCREMENT}.
5377 @defmac USE_STORE_POST_DECREMENT (@var{mode})
5378 A C expression used to determine whether a store postdecrement is a good
5379 thing to use for a given mode. Defaults to the value of
5380 @code{HAVE_POST_DECREMENT}.
5383 @defmac USE_STORE_PRE_INCREMENT (@var{mode})
5384 This macro is used to determine whether a store preincrement is a good
5385 thing to use for a given mode. Defaults to the value of
5386 @code{HAVE_PRE_INCREMENT}.
5389 @defmac USE_STORE_PRE_DECREMENT (@var{mode})
5390 This macro is used to determine whether a store predecrement is a good
5391 thing to use for a given mode. Defaults to the value of
5392 @code{HAVE_PRE_DECREMENT}.
5395 @defmac NO_FUNCTION_CSE
5396 Define this macro if it is as good or better to call a constant
5397 function address than to call an address kept in a register.
5400 @defmac NO_RECURSIVE_FUNCTION_CSE
5401 Define this macro if it is as good or better for a function to call
5402 itself with an explicit address than to call an address kept in a
5406 @defmac RANGE_TEST_NON_SHORT_CIRCUIT
5407 Define this macro if a non-short-circuit operation produced by
5408 @samp{fold_range_test ()} is optimal. This macro defaults to true if
5409 @code{BRANCH_COST} is greater than or equal to the value 2.
5412 @deftypefn {Target Hook} bool TARGET_RTX_COSTS (rtx @var{x}, int @var{code}, int @var{outer_code}, int *@var{total})
5413 This target hook describes the relative costs of RTL expressions.
5415 The cost may depend on the precise form of the expression, which is
5416 available for examination in @var{x}, and the rtx code of the expression
5417 in which it is contained, found in @var{outer_code}. @var{code} is the
5418 expression code---redundant, since it can be obtained with
5419 @code{GET_CODE (@var{x})}.
5421 In implementing this hook, you can use the construct
5422 @code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast
5425 On entry to the hook, @code{*@var{total}} contains a default estimate
5426 for the cost of the expression. The hook should modify this value as
5429 The hook returns true when all subexpressions of @var{x} have been
5430 processed, and false when @code{rtx_cost} should recurse.
5433 @deftypefn {Target Hook} int TARGET_ADDRESS_COST (rtx @var{address})
5434 This hook computes the cost of an addressing mode that contains
5435 @var{address}. If not defined, the cost is computed from
5436 the @var{address} expression and the @code{TARGET_RTX_COST} hook.
5438 For most CISC machines, the default cost is a good approximation of the
5439 true cost of the addressing mode. However, on RISC machines, all
5440 instructions normally have the same length and execution time. Hence
5441 all addresses will have equal costs.
5443 In cases where more than one form of an address is known, the form with
5444 the lowest cost will be used. If multiple forms have the same, lowest,
5445 cost, the one that is the most complex will be used.
5447 For example, suppose an address that is equal to the sum of a register
5448 and a constant is used twice in the same basic block. When this macro
5449 is not defined, the address will be computed in a register and memory
5450 references will be indirect through that register. On machines where
5451 the cost of the addressing mode containing the sum is no higher than
5452 that of a simple indirect reference, this will produce an additional
5453 instruction and possibly require an additional register. Proper
5454 specification of this macro eliminates this overhead for such machines.
5456 This hook is never called with an invalid address.
5458 On machines where an address involving more than one register is as
5459 cheap as an address computation involving only one register, defining
5460 @code{TARGET_ADDRESS_COST} to reflect this can cause two registers to
5461 be live over a region of code where only one would have been if
5462 @code{TARGET_ADDRESS_COST} were not defined in that manner. This effect
5463 should be considered in the definition of this macro. Equivalent costs
5464 should probably only be given to addresses with different numbers of
5465 registers on machines with lots of registers.
5469 @section Adjusting the Instruction Scheduler
5471 The instruction scheduler may need a fair amount of machine-specific
5472 adjustment in order to produce good code. GCC provides several target
5473 hooks for this purpose. It is usually enough to define just a few of
5474 them: try the first ones in this list first.
5476 @deftypefn {Target Hook} int TARGET_SCHED_ISSUE_RATE (void)
5477 This hook returns the maximum number of instructions that can ever
5478 issue at the same time on the target machine. The default is one.
5479 Although the insn scheduler can define itself the possibility of issue
5480 an insn on the same cycle, the value can serve as an additional
5481 constraint to issue insns on the same simulated processor cycle (see
5482 hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).
5483 This value must be constant over the entire compilation. If you need
5484 it to vary depending on what the instructions are, you must use
5485 @samp{TARGET_SCHED_VARIABLE_ISSUE}.
5487 For the automaton based pipeline interface, you could define this hook
5488 to return the value of the macro @code{MAX_DFA_ISSUE_RATE}.
5491 @deftypefn {Target Hook} int TARGET_SCHED_VARIABLE_ISSUE (FILE *@var{file}, int @var{verbose}, rtx @var{insn}, int @var{more})
5492 This hook is executed by the scheduler after it has scheduled an insn
5493 from the ready list. It should return the number of insns which can
5494 still be issued in the current cycle. The default is
5495 @samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and
5496 @code{USE}, which normally are not counted against the issue rate.
5497 You should define this hook if some insns take more machine resources
5498 than others, so that fewer insns can follow them in the same cycle.
5499 @var{file} is either a null pointer, or a stdio stream to write any
5500 debug output to. @var{verbose} is the verbose level provided by
5501 @option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that
5505 @deftypefn {Target Hook} int TARGET_SCHED_ADJUST_COST (rtx @var{insn}, rtx @var{link}, rtx @var{dep_insn}, int @var{cost})
5506 This function corrects the value of @var{cost} based on the
5507 relationship between @var{insn} and @var{dep_insn} through the
5508 dependence @var{link}. It should return the new value. The default
5509 is to make no adjustment to @var{cost}. This can be used for example
5510 to specify to the scheduler using the traditional pipeline description
5511 that an output- or anti-dependence does not incur the same cost as a
5512 data-dependence. If the scheduler using the automaton based pipeline
5513 description, the cost of anti-dependence is zero and the cost of
5514 output-dependence is maximum of one and the difference of latency
5515 times of the first and the second insns. If these values are not
5516 acceptable, you could use the hook to modify them too. See also
5517 @pxref{Automaton pipeline description}.
5520 @deftypefn {Target Hook} int TARGET_SCHED_ADJUST_PRIORITY (rtx @var{insn}, int @var{priority})
5521 This hook adjusts the integer scheduling priority @var{priority} of
5522 @var{insn}. It should return the new priority. Reduce the priority to
5523 execute @var{insn} earlier, increase the priority to execute @var{insn}
5524 later. Do not define this hook if you do not need to adjust the
5525 scheduling priorities of insns.
5528 @deftypefn {Target Hook} int TARGET_SCHED_REORDER (FILE *@var{file}, int @var{verbose}, rtx *@var{ready}, int *@var{n_readyp}, int @var{clock})
5529 This hook is executed by the scheduler after it has scheduled the ready
5530 list, to allow the machine description to reorder it (for example to
5531 combine two small instructions together on @samp{VLIW} machines).
5532 @var{file} is either a null pointer, or a stdio stream to write any
5533 debug output to. @var{verbose} is the verbose level provided by
5534 @option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready
5535 list of instructions that are ready to be scheduled. @var{n_readyp} is
5536 a pointer to the number of elements in the ready list. The scheduler
5537 reads the ready list in reverse order, starting with
5538 @var{ready}[@var{*n_readyp}-1] and going to @var{ready}[0]. @var{clock}
5539 is the timer tick of the scheduler. You may modify the ready list and
5540 the number of ready insns. The return value is the number of insns that
5541 can issue this cycle; normally this is just @code{issue_rate}. See also
5542 @samp{TARGET_SCHED_REORDER2}.
5545 @deftypefn {Target Hook} int TARGET_SCHED_REORDER2 (FILE *@var{file}, int @var{verbose}, rtx *@var{ready}, int *@var{n_ready}, @var{clock})
5546 Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That
5547 function is called whenever the scheduler starts a new cycle. This one
5548 is called once per iteration over a cycle, immediately after
5549 @samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and
5550 return the number of insns to be scheduled in the same cycle. Defining
5551 this hook can be useful if there are frequent situations where
5552 scheduling one insn causes other insns to become ready in the same
5553 cycle. These other insns can then be taken into account properly.
5556 @deftypefn {Target Hook} void TARGET_SCHED_DEPENDENCIES_EVALUATION_HOOK (rtx @var{head}, rtx @var{tail})
5557 This hook is called after evaluation forward dependencies of insns in
5558 chain given by two parameter values (@var{head} and @var{tail}
5559 correspondingly) but before insns scheduling of the insn chain. For
5560 example, it can be used for better insn classification if it requires
5561 analysis of dependencies. This hook can use backward and forward
5562 dependencies of the insn scheduler because they are already
5566 @deftypefn {Target Hook} void TARGET_SCHED_INIT (FILE *@var{file}, int @var{verbose}, int @var{max_ready})
5567 This hook is executed by the scheduler at the beginning of each block of
5568 instructions that are to be scheduled. @var{file} is either a null
5569 pointer, or a stdio stream to write any debug output to. @var{verbose}
5570 is the verbose level provided by @option{-fsched-verbose-@var{n}}.
5571 @var{max_ready} is the maximum number of insns in the current scheduling
5572 region that can be live at the same time. This can be used to allocate
5573 scratch space if it is needed, e.g. by @samp{TARGET_SCHED_REORDER}.
5576 @deftypefn {Target Hook} void TARGET_SCHED_FINISH (FILE *@var{file}, int @var{verbose})
5577 This hook is executed by the scheduler at the end of each block of
5578 instructions that are to be scheduled. It can be used to perform
5579 cleanup of any actions done by the other scheduling hooks. @var{file}
5580 is either a null pointer, or a stdio stream to write any debug output
5581 to. @var{verbose} is the verbose level provided by
5582 @option{-fsched-verbose-@var{n}}.
5585 @deftypefn {Target Hook} int TARGET_SCHED_USE_DFA_PIPELINE_INTERFACE (void)
5586 This hook is called many times during insn scheduling. If the hook
5587 returns nonzero, the automaton based pipeline description is used for
5588 insn scheduling. Otherwise the traditional pipeline description is
5589 used. The default is usage of the traditional pipeline description.
5591 You should also remember that to simplify the insn scheduler sources
5592 an empty traditional pipeline description interface is generated even
5593 if there is no a traditional pipeline description in the @file{.md}
5594 file. The same is true for the automaton based pipeline description.
5595 That means that you should be accurate in defining the hook.
5598 @deftypefn {Target Hook} int TARGET_SCHED_DFA_PRE_CYCLE_INSN (void)
5599 The hook returns an RTL insn. The automaton state used in the
5600 pipeline hazard recognizer is changed as if the insn were scheduled
5601 when the new simulated processor cycle starts. Usage of the hook may
5602 simplify the automaton pipeline description for some @acronym{VLIW}
5603 processors. If the hook is defined, it is used only for the automaton
5604 based pipeline description. The default is not to change the state
5605 when the new simulated processor cycle starts.
5608 @deftypefn {Target Hook} void TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN (void)
5609 The hook can be used to initialize data used by the previous hook.
5612 @deftypefn {Target Hook} int TARGET_SCHED_DFA_POST_CYCLE_INSN (void)
5613 The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used
5614 to changed the state as if the insn were scheduled when the new
5615 simulated processor cycle finishes.
5618 @deftypefn {Target Hook} void TARGET_SCHED_INIT_DFA_POST_CYCLE_INSN (void)
5619 The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but
5620 used to initialize data used by the previous hook.
5623 @deftypefn {Target Hook} int TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD (void)
5624 This hook controls better choosing an insn from the ready insn queue
5625 for the @acronym{DFA}-based insn scheduler. Usually the scheduler
5626 chooses the first insn from the queue. If the hook returns a positive
5627 value, an additional scheduler code tries all permutations of
5628 @samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}
5629 subsequent ready insns to choose an insn whose issue will result in
5630 maximal number of issued insns on the same cycle. For the
5631 @acronym{VLIW} processor, the code could actually solve the problem of
5632 packing simple insns into the @acronym{VLIW} insn. Of course, if the
5633 rules of @acronym{VLIW} packing are described in the automaton.
5635 This code also could be used for superscalar @acronym{RISC}
5636 processors. Let us consider a superscalar @acronym{RISC} processor
5637 with 3 pipelines. Some insns can be executed in pipelines @var{A} or
5638 @var{B}, some insns can be executed only in pipelines @var{B} or
5639 @var{C}, and one insn can be executed in pipeline @var{B}. The
5640 processor may issue the 1st insn into @var{A} and the 2nd one into
5641 @var{B}. In this case, the 3rd insn will wait for freeing @var{B}
5642 until the next cycle. If the scheduler issues the 3rd insn the first,
5643 the processor could issue all 3 insns per cycle.
5645 Actually this code demonstrates advantages of the automaton based
5646 pipeline hazard recognizer. We try quickly and easy many insn
5647 schedules to choose the best one.
5649 The default is no multipass scheduling.
5652 @deftypefn {Target Hook} int TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD (rtx)
5654 This hook controls what insns from the ready insn queue will be
5655 considered for the multipass insn scheduling. If the hook returns
5656 zero for insn passed as the parameter, the insn will be not chosen to
5659 The default is that any ready insns can be chosen to be issued.
5662 @deftypefn {Target Hook} int TARGET_SCHED_DFA_NEW_CYCLE (FILE *, int, rtx, int, int, int *)
5664 This hook is called by the insn scheduler before issuing insn passed
5665 as the third parameter on given cycle. If the hook returns nonzero,
5666 the insn is not issued on given processors cycle. Instead of that,
5667 the processor cycle is advanced. If the value passed through the last
5668 parameter is zero, the insn ready queue is not sorted on the new cycle
5669 start as usually. The first parameter passes file for debugging
5670 output. The second one passes the scheduler verbose level of the
5671 debugging output. The forth and the fifth parameter values are
5672 correspondingly processor cycle on which the previous insn has been
5673 issued and the current processor cycle.
5676 @deftypefn {Target Hook} void TARGET_SCHED_INIT_DFA_BUBBLES (void)
5677 The @acronym{DFA}-based scheduler could take the insertion of nop
5678 operations for better insn scheduling into account. It can be done
5679 only if the multi-pass insn scheduling works (see hook
5680 @samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD}).
5682 Let us consider a @acronym{VLIW} processor insn with 3 slots. Each
5683 insn can be placed only in one of the three slots. We have 3 ready
5684 insns @var{A}, @var{B}, and @var{C}. @var{A} and @var{C} can be
5685 placed only in the 1st slot, @var{B} can be placed only in the 3rd
5686 slot. We described the automaton which does not permit empty slot
5687 gaps between insns (usually such description is simpler). Without
5688 this code the scheduler would place each insn in 3 separate
5689 @acronym{VLIW} insns. If the scheduler places a nop insn into the 2nd
5690 slot, it could place the 3 insns into 2 @acronym{VLIW} insns. What is
5691 the nop insn is returned by hook @samp{TARGET_SCHED_DFA_BUBBLE}. Hook
5692 @samp{TARGET_SCHED_INIT_DFA_BUBBLES} can be used to initialize or
5693 create the nop insns.
5695 You should remember that the scheduler does not insert the nop insns.
5696 It is not wise because of the following optimizations. The scheduler
5697 only considers such possibility to improve the result schedule. The
5698 nop insns should be inserted lately, e.g. on the final phase.
5701 @deftypefn {Target Hook} rtx TARGET_SCHED_DFA_BUBBLE (int @var{index})
5702 This hook @samp{FIRST_CYCLE_MULTIPASS_SCHEDULING} is used to insert
5703 nop operations for better insn scheduling when @acronym{DFA}-based
5704 scheduler makes multipass insn scheduling (see also description of
5705 hook @samp{TARGET_SCHED_INIT_DFA_BUBBLES}). This hook
5706 returns a nop insn with given @var{index}. The indexes start with
5707 zero. The hook should return @code{NULL} if there are no more nop
5708 insns with indexes greater than given index.
5711 Macros in the following table are generated by the program
5712 @file{genattr} and can be useful for writing the hooks.
5714 @defmac TRADITIONAL_PIPELINE_INTERFACE
5715 The macro definition is generated if there is a traditional pipeline
5716 description in @file{.md} file. You should also remember that to
5717 simplify the insn scheduler sources an empty traditional pipeline
5718 description interface is generated even if there is no a traditional
5719 pipeline description in the @file{.md} file. The macro can be used to
5720 distinguish the two types of the traditional interface.
5723 @defmac DFA_PIPELINE_INTERFACE
5724 The macro definition is generated if there is an automaton pipeline
5725 description in @file{.md} file. You should also remember that to
5726 simplify the insn scheduler sources an empty automaton pipeline
5727 description interface is generated even if there is no an automaton
5728 pipeline description in the @file{.md} file. The macro can be used to
5729 distinguish the two types of the automaton interface.
5732 @defmac MAX_DFA_ISSUE_RATE
5733 The macro definition is generated in the automaton based pipeline
5734 description interface. Its value is calculated from the automaton
5735 based pipeline description and is equal to maximal number of all insns
5736 described in constructions @samp{define_insn_reservation} which can be
5737 issued on the same processor cycle.
5741 @section Dividing the Output into Sections (Texts, Data, @dots{})
5742 @c the above section title is WAY too long. maybe cut the part between
5743 @c the (...)? --mew 10feb93
5745 An object file is divided into sections containing different types of
5746 data. In the most common case, there are three sections: the @dfn{text
5747 section}, which holds instructions and read-only data; the @dfn{data
5748 section}, which holds initialized writable data; and the @dfn{bss
5749 section}, which holds uninitialized data. Some systems have other kinds
5752 The compiler must tell the assembler when to switch sections. These
5753 macros control what commands to output to tell the assembler this. You
5754 can also define additional sections.
5756 @defmac TEXT_SECTION_ASM_OP
5757 A C expression whose value is a string, including spacing, containing the
5758 assembler operation that should precede instructions and read-only data.
5759 Normally @code{"\t.text"} is right.
5762 @defmac TEXT_SECTION
5763 A C statement that switches to the default section containing instructions.
5764 Normally this is not needed, as simply defining @code{TEXT_SECTION_ASM_OP}
5765 is enough. The MIPS port uses this to sort all functions after all data
5769 @defmac HOT_TEXT_SECTION_NAME
5770 If defined, a C string constant for the name of the section containing most
5771 frequently executed functions of the program. If not defined, GCC will provide
5772 a default definition if the target supports named sections.
5775 @defmac UNLIKELY_EXECUTED_TEXT_SECTION_NAME
5776 If defined, a C string constant for the name of the section containing unlikely
5777 executed functions in the program.
5780 @defmac DATA_SECTION_ASM_OP
5781 A C expression whose value is a string, including spacing, containing the
5782 assembler operation to identify the following data as writable initialized
5783 data. Normally @code{"\t.data"} is right.
5786 @defmac READONLY_DATA_SECTION_ASM_OP
5787 A C expression whose value is a string, including spacing, containing the
5788 assembler operation to identify the following data as read-only initialized
5792 @defmac READONLY_DATA_SECTION
5793 A macro naming a function to call to switch to the proper section for
5794 read-only data. The default is to use @code{READONLY_DATA_SECTION_ASM_OP}
5795 if defined, else fall back to @code{text_section}.
5797 The most common definition will be @code{data_section}, if the target
5798 does not have a special read-only data section, and does not put data
5799 in the text section.
5802 @defmac SHARED_SECTION_ASM_OP
5803 If defined, a C expression whose value is a string, including spacing,
5804 containing the assembler operation to identify the following data as
5805 shared data. If not defined, @code{DATA_SECTION_ASM_OP} will be used.
5808 @defmac BSS_SECTION_ASM_OP
5809 If defined, a C expression whose value is a string, including spacing,
5810 containing the assembler operation to identify the following data as
5811 uninitialized global data. If not defined, and neither
5812 @code{ASM_OUTPUT_BSS} nor @code{ASM_OUTPUT_ALIGNED_BSS} are defined,
5813 uninitialized global data will be output in the data section if
5814 @option{-fno-common} is passed, otherwise @code{ASM_OUTPUT_COMMON} will be
5818 @defmac SHARED_BSS_SECTION_ASM_OP
5819 If defined, a C expression whose value is a string, including spacing,
5820 containing the assembler operation to identify the following data as
5821 uninitialized global shared data. If not defined, and
5822 @code{BSS_SECTION_ASM_OP} is, the latter will be used.
5825 @defmac INIT_SECTION_ASM_OP
5826 If defined, a C expression whose value is a string, including spacing,
5827 containing the assembler operation to identify the following data as
5828 initialization code. If not defined, GCC will assume such a section does
5832 @defmac FINI_SECTION_ASM_OP
5833 If defined, a C expression whose value is a string, including spacing,
5834 containing the assembler operation to identify the following data as
5835 finalization code. If not defined, GCC will assume such a section does
5839 @defmac CRT_CALL_STATIC_FUNCTION (@var{section_op}, @var{function})
5840 If defined, an ASM statement that switches to a different section
5841 via @var{section_op}, calls @var{function}, and switches back to
5842 the text section. This is used in @file{crtstuff.c} if
5843 @code{INIT_SECTION_ASM_OP} or @code{FINI_SECTION_ASM_OP} to calls
5844 to initialization and finalization functions from the init and fini
5845 sections. By default, this macro uses a simple function call. Some
5846 ports need hand-crafted assembly code to avoid dependencies on
5847 registers initialized in the function prologue or to ensure that
5848 constant pools don't end up too far way in the text section.
5851 @defmac FORCE_CODE_SECTION_ALIGN
5852 If defined, an ASM statement that aligns a code section to some
5853 arbitrary boundary. This is used to force all fragments of the
5854 @code{.init} and @code{.fini} sections to have to same alignment
5855 and thus prevent the linker from having to add any padding.
5860 @defmac EXTRA_SECTIONS
5861 A list of names for sections other than the standard two, which are
5862 @code{in_text} and @code{in_data}. You need not define this macro
5863 on a system with no other sections (that GCC needs to use).
5866 @findex text_section
5867 @findex data_section
5868 @defmac EXTRA_SECTION_FUNCTIONS
5869 One or more functions to be defined in @file{varasm.c}. These
5870 functions should do jobs analogous to those of @code{text_section} and
5871 @code{data_section}, for your additional sections. Do not define this
5872 macro if you do not define @code{EXTRA_SECTIONS}.
5875 @defmac JUMP_TABLES_IN_TEXT_SECTION
5876 Define this macro to be an expression with a nonzero value if jump
5877 tables (for @code{tablejump} insns) should be output in the text
5878 section, along with the assembler instructions. Otherwise, the
5879 readonly data section is used.
5881 This macro is irrelevant if there is no separate readonly data section.
5884 @deftypefn {Target Hook} void TARGET_ASM_SELECT_SECTION (tree @var{exp}, int @var{reloc}, unsigned HOST_WIDE_INT @var{align})
5885 Switches to the appropriate section for output of @var{exp}. You can
5886 assume that @var{exp} is either a @code{VAR_DECL} node or a constant of
5887 some sort. @var{reloc} indicates whether the initial value of @var{exp}
5888 requires link-time relocations. Bit 0 is set when variable contains
5889 local relocations only, while bit 1 is set for global relocations.
5890 Select the section by calling @code{data_section} or one of the
5891 alternatives for other sections. @var{align} is the constant alignment
5894 The default version of this function takes care of putting read-only
5895 variables in @code{readonly_data_section}.
5898 @deftypefn {Target Hook} void TARGET_ASM_UNIQUE_SECTION (tree @var{decl}, int @var{reloc})
5899 Build up a unique section name, expressed as a @code{STRING_CST} node,
5900 and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.
5901 As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether
5902 the initial value of @var{exp} requires link-time relocations.
5904 The default version of this function appends the symbol name to the
5905 ELF section name that would normally be used for the symbol. For
5906 example, the function @code{foo} would be placed in @code{.text.foo}.
5907 Whatever the actual target object format, this is often good enough.
5910 @deftypefn {Target Hook} void TARGET_ASM_SELECT_RTX_SECTION (enum machine_mode @var{mode}, rtx @var{x}, unsigned HOST_WIDE_INT @var{align})
5911 Switches to the appropriate section for output of constant pool entry
5912 @var{x} in @var{mode}. You can assume that @var{x} is some kind of
5913 constant in RTL@. The argument @var{mode} is redundant except in the
5914 case of a @code{const_int} rtx. Select the section by calling
5915 @code{readonly_data_section} or one of the alternatives for other
5916 sections. @var{align} is the constant alignment in bits.
5918 The default version of this function takes care of putting symbolic
5919 constants in @code{flag_pic} mode in @code{data_section} and everything
5920 else in @code{readonly_data_section}.
5923 @deftypefn {Target Hook} void TARGET_ENCODE_SECTION_INFO (tree @var{decl}, rtx @var{rtl}, int @var{new_decl_p})
5924 Define this hook if references to a symbol or a constant must be
5925 treated differently depending on something about the variable or
5926 function named by the symbol (such as what section it is in).
5928 The hook is executed immediately after rtl has been created for
5929 @var{decl}, which may be a variable or function declaration or
5930 an entry in the constant pool. In either case, @var{rtl} is the
5931 rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}
5932 in this hook; that field may not have been initialized yet.
5934 In the case of a constant, it is safe to assume that the rtl is
5935 a @code{mem} whose address is a @code{symbol_ref}. Most decls
5936 will also have this form, but that is not guaranteed. Global
5937 register variables, for instance, will have a @code{reg} for their
5938 rtl. (Normally the right thing to do with such unusual rtl is
5941 The @var{new_decl_p} argument will be true if this is the first time
5942 that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will
5943 be false for subsequent invocations, which will happen for duplicate
5944 declarations. Whether or not anything must be done for the duplicate
5945 declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.
5946 @var{new_decl_p} is always true when the hook is called for a constant.
5948 @cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}
5949 The usual thing for this hook to do is to record flags in the
5950 @code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.
5951 Historically, the name string was modified if it was necessary to
5952 encode more than one bit of information, but this practice is now
5953 discouraged; use @code{SYMBOL_REF_FLAGS}.
5955 The default definition of this hook, @code{default_encode_section_info}
5956 in @file{varasm.c}, sets a number of commonly-useful bits in
5957 @code{SYMBOL_REF_FLAGS}. Check whether the default does what you need
5958 before overriding it.
5961 @deftypefn {Target Hook} const char *TARGET_STRIP_NAME_ENCODING (const char *name)
5962 Decode @var{name} and return the real name part, sans
5963 the characters that @code{TARGET_ENCODE_SECTION_INFO}
5967 @deftypefn {Target Hook} bool TARGET_IN_SMALL_DATA_P (tree @var{exp})
5968 Returns true if @var{exp} should be placed into a ``small data'' section.
5969 The default version of this hook always returns false.
5972 @deftypevar {Target Hook} bool TARGET_HAVE_SRODATA_SECTION
5973 Contains the value true if the target places read-only
5974 ``small data'' into a separate section. The default value is false.
5977 @deftypefn {Target Hook} bool TARGET_BINDS_LOCAL_P (tree @var{exp})
5978 Returns true if @var{exp} names an object for which name resolution
5979 rules must resolve to the current ``module'' (dynamic shared library
5980 or executable image).
5982 The default version of this hook implements the name resolution rules
5983 for ELF, which has a looser model of global name binding than other
5984 currently supported object file formats.
5987 @deftypevar {Target Hook} bool TARGET_HAVE_TLS
5988 Contains the value true if the target supports thread-local storage.
5989 The default value is false.
5994 @section Position Independent Code
5995 @cindex position independent code
5998 This section describes macros that help implement generation of position
5999 independent code. Simply defining these macros is not enough to
6000 generate valid PIC; you must also add support to the macros
6001 @code{GO_IF_LEGITIMATE_ADDRESS} and @code{PRINT_OPERAND_ADDRESS}, as
6002 well as @code{LEGITIMIZE_ADDRESS}. You must modify the definition of
6003 @samp{movsi} to do something appropriate when the source operand
6004 contains a symbolic address. You may also need to alter the handling of
6005 switch statements so that they use relative addresses.
6006 @c i rearranged the order of the macros above to try to force one of
6007 @c them to the next line, to eliminate an overfull hbox. --mew 10feb93
6009 @defmac PIC_OFFSET_TABLE_REGNUM
6010 The register number of the register used to address a table of static
6011 data addresses in memory. In some cases this register is defined by a
6012 processor's ``application binary interface'' (ABI)@. When this macro
6013 is defined, RTL is generated for this register once, as with the stack
6014 pointer and frame pointer registers. If this macro is not defined, it
6015 is up to the machine-dependent files to allocate such a register (if
6016 necessary). Note that this register must be fixed when in use (e.g.@:
6017 when @code{flag_pic} is true).
6020 @defmac PIC_OFFSET_TABLE_REG_CALL_CLOBBERED
6021 Define this macro if the register defined by
6022 @code{PIC_OFFSET_TABLE_REGNUM} is clobbered by calls. Do not define
6023 this macro if @code{PIC_OFFSET_TABLE_REGNUM} is not defined.
6026 @defmac FINALIZE_PIC
6027 By generating position-independent code, when two different programs (A
6028 and B) share a common library (libC.a), the text of the library can be
6029 shared whether or not the library is linked at the same address for both
6030 programs. In some of these environments, position-independent code
6031 requires not only the use of different addressing modes, but also
6032 special code to enable the use of these addressing modes.
6034 The @code{FINALIZE_PIC} macro serves as a hook to emit these special
6035 codes once the function is being compiled into assembly code, but not
6036 before. (It is not done before, because in the case of compiling an
6037 inline function, it would lead to multiple PIC prologues being
6038 included in functions which used inline functions and were compiled to
6042 @defmac LEGITIMATE_PIC_OPERAND_P (@var{x})
6043 A C expression that is nonzero if @var{x} is a legitimate immediate
6044 operand on the target machine when generating position independent code.
6045 You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not
6046 check this. You can also assume @var{flag_pic} is true, so you need not
6047 check it either. You need not define this macro if all constants
6048 (including @code{SYMBOL_REF}) can be immediate operands when generating
6049 position independent code.
6052 @node Assembler Format
6053 @section Defining the Output Assembler Language
6055 This section describes macros whose principal purpose is to describe how
6056 to write instructions in assembler language---rather than what the
6060 * File Framework:: Structural information for the assembler file.
6061 * Data Output:: Output of constants (numbers, strings, addresses).
6062 * Uninitialized Data:: Output of uninitialized variables.
6063 * Label Output:: Output and generation of labels.
6064 * Initialization:: General principles of initialization
6065 and termination routines.
6066 * Macros for Initialization::
6067 Specific macros that control the handling of
6068 initialization and termination routines.
6069 * Instruction Output:: Output of actual instructions.
6070 * Dispatch Tables:: Output of jump tables.
6071 * Exception Region Output:: Output of exception region code.
6072 * Alignment Output:: Pseudo ops for alignment and skipping data.
6075 @node File Framework
6076 @subsection The Overall Framework of an Assembler File
6077 @cindex assembler format
6078 @cindex output of assembler code
6080 @c prevent bad page break with this line
6081 This describes the overall framework of an assembly file.
6083 @deftypefn {Target Hook} void TARGET_ASM_FILE_START ()
6084 @findex default_file_start
6085 Output to @code{asm_out_file} any text which the assembler expects to
6086 find at the beginning of a file. The default behavior is controlled
6087 by two flags, documented below. Unless your target's assembler is
6088 quite unusual, if you override the default, you should call
6089 @code{default_file_start} at some point in your target hook. This
6090 lets other target files rely on these variables.
6093 @deftypevr {Target Hook} bool TARGET_ASM_FILE_START_APP_OFF
6094 If this flag is true, the text of the macro @code{ASM_APP_OFF} will be
6095 printed as the very first line in the assembly file, unless
6096 @option{-fverbose-asm} is in effect. (If that macro has been defined
6097 to the empty string, this variable has no effect.) With the normal
6098 definition of @code{ASM_APP_OFF}, the effect is to notify the GNU
6099 assembler that it need not bother stripping comments or extra
6100 whitespace from its input. This allows it to work a bit faster.
6102 The default is false. You should not set it to true unless you have
6103 verified that your port does not generate any extra whitespace or
6104 comments that will cause GAS to issue errors in NO_APP mode.
6107 @deftypevr {Target Hook} bool TARGET_ASM_FILE_START_FILE_DIRECTIVE
6108 If this flag is true, @code{output_file_directive} will be called
6109 for the primary source file, immediately after printing
6110 @code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect
6111 this to be done. The default is false.
6114 @deftypefn {Target Hook} void TARGET_ASM_FILE_END ()
6115 Output to @code{asm_out_file} any text which the assembler expects
6116 to find at the end of a file. The default is to output nothing.
6119 @deftypefun void file_end_indicate_exec_stack ()
6120 Some systems use a common convention, the @samp{.note.GNU-stack}
6121 special section, to indicate whether or not an object file relies on
6122 the stack being executable. If your system uses this convention, you
6123 should define @code{TARGET_ASM_FILE_END} to this function. If you
6124 need to do other things in that hook, have your hook function call
6128 @defmac ASM_COMMENT_START
6129 A C string constant describing how to begin a comment in the target
6130 assembler language. The compiler assumes that the comment will end at
6131 the end of the line.
6135 A C string constant for text to be output before each @code{asm}
6136 statement or group of consecutive ones. Normally this is
6137 @code{"#APP"}, which is a comment that has no effect on most
6138 assemblers but tells the GNU assembler that it must check the lines
6139 that follow for all valid assembler constructs.
6143 A C string constant for text to be output after each @code{asm}
6144 statement or group of consecutive ones. Normally this is
6145 @code{"#NO_APP"}, which tells the GNU assembler to resume making the
6146 time-saving assumptions that are valid for ordinary compiler output.
6149 @defmac ASM_OUTPUT_SOURCE_FILENAME (@var{stream}, @var{name})
6150 A C statement to output COFF information or DWARF debugging information
6151 which indicates that filename @var{name} is the current source file to
6152 the stdio stream @var{stream}.
6154 This macro need not be defined if the standard form of output
6155 for the file format in use is appropriate.
6158 @defmac OUTPUT_QUOTED_STRING (@var{stream}, @var{string})
6159 A C statement to output the string @var{string} to the stdio stream
6160 @var{stream}. If you do not call the function @code{output_quoted_string}
6161 in your config files, GCC will only call it to output filenames to
6162 the assembler source. So you can use it to canonicalize the format
6163 of the filename using this macro.
6166 @defmac ASM_OUTPUT_SOURCE_LINE (@var{stream}, @var{line}, @var{counter})
6167 A C statement to output DBX or SDB debugging information before code
6168 for line number @var{line} of the current source file to the
6169 stdio stream @var{stream}. @var{counter} is the number of time the
6170 macro was invoked, including the current invocation; it is intended
6171 to generate unique labels in the assembly output.
6173 This macro need not be defined if the standard form of debugging
6174 information for the debugger in use is appropriate.
6177 @defmac ASM_OUTPUT_IDENT (@var{stream}, @var{string})
6178 A C statement to output something to the assembler file to handle a
6179 @samp{#ident} directive containing the text @var{string}. If this
6180 macro is not defined, nothing is output for a @samp{#ident} directive.
6183 @deftypefn {Target Hook} void TARGET_ASM_NAMED_SECTION (const char *@var{name}, unsigned int @var{flags}, unsigned int @var{align})
6184 Output assembly directives to switch to section @var{name}. The section
6185 should have attributes as specified by @var{flags}, which is a bit mask
6186 of the @code{SECTION_*} flags defined in @file{output.h}. If @var{align}
6187 is nonzero, it contains an alignment in bytes to be used for the section,
6188 otherwise some target default should be used. Only targets that must
6189 specify an alignment within the section directive need pay attention to
6190 @var{align} -- we will still use @code{ASM_OUTPUT_ALIGN}.
6193 @deftypefn {Target Hook} bool TARGET_HAVE_NAMED_SECTIONS
6194 This flag is true if the target supports @code{TARGET_ASM_NAMED_SECTION}.
6197 @deftypefn {Target Hook} {unsigned int} TARGET_SECTION_TYPE_FLAGS (tree @var{decl}, const char *@var{name}, int @var{reloc})
6198 Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}
6199 based on a variable or function decl, a section name, and whether or not the
6200 declaration's initializer may contain runtime relocations. @var{decl} may be
6201 null, in which case read-write data should be assumed.
6203 The default version if this function handles choosing code vs data,
6204 read-only vs read-write data, and @code{flag_pic}. You should only
6205 need to override this if your target has special flags that might be
6206 set via @code{__attribute__}.
6211 @subsection Output of Data
6214 @deftypevr {Target Hook} {const char *} TARGET_ASM_BYTE_OP
6215 @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP
6216 @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP
6217 @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP
6218 @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP
6219 @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP
6220 @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP
6221 @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP
6222 @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP
6223 These hooks specify assembly directives for creating certain kinds
6224 of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a
6225 byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an
6226 aligned two-byte object, and so on. Any of the hooks may be
6227 @code{NULL}, indicating that no suitable directive is available.
6229 The compiler will print these strings at the start of a new line,
6230 followed immediately by the object's initial value. In most cases,
6231 the string should contain a tab, a pseudo-op, and then another tab.
6234 @deftypefn {Target Hook} bool TARGET_ASM_INTEGER (rtx @var{x}, unsigned int @var{size}, int @var{aligned_p})
6235 The @code{assemble_integer} function uses this hook to output an
6236 integer object. @var{x} is the object's value, @var{size} is its size
6237 in bytes and @var{aligned_p} indicates whether it is aligned. The
6238 function should return @code{true} if it was able to output the
6239 object. If it returns false, @code{assemble_integer} will try to
6240 split the object into smaller parts.
6242 The default implementation of this hook will use the
6243 @code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}
6244 when the relevant string is @code{NULL}.
6247 @defmac OUTPUT_ADDR_CONST_EXTRA (@var{stream}, @var{x}, @var{fail})
6248 A C statement to recognize @var{rtx} patterns that
6249 @code{output_addr_const} can't deal with, and output assembly code to
6250 @var{stream} corresponding to the pattern @var{x}. This may be used to
6251 allow machine-dependent @code{UNSPEC}s to appear within constants.
6253 If @code{OUTPUT_ADDR_CONST_EXTRA} fails to recognize a pattern, it must
6254 @code{goto fail}, so that a standard error message is printed. If it
6255 prints an error message itself, by calling, for example,
6256 @code{output_operand_lossage}, it may just complete normally.
6259 @defmac ASM_OUTPUT_ASCII (@var{stream}, @var{ptr}, @var{len})
6260 A C statement to output to the stdio stream @var{stream} an assembler
6261 instruction to assemble a string constant containing the @var{len}
6262 bytes at @var{ptr}. @var{ptr} will be a C expression of type
6263 @code{char *} and @var{len} a C expression of type @code{int}.
6265 If the assembler has a @code{.ascii} pseudo-op as found in the
6266 Berkeley Unix assembler, do not define the macro
6267 @code{ASM_OUTPUT_ASCII}.
6270 @defmac ASM_OUTPUT_FDESC (@var{stream}, @var{decl}, @var{n})
6271 A C statement to output word @var{n} of a function descriptor for
6272 @var{decl}. This must be defined if @code{TARGET_VTABLE_USES_DESCRIPTORS}
6273 is defined, and is otherwise unused.
6276 @defmac CONSTANT_POOL_BEFORE_FUNCTION
6277 You may define this macro as a C expression. You should define the
6278 expression to have a nonzero value if GCC should output the constant
6279 pool for a function before the code for the function, or a zero value if
6280 GCC should output the constant pool after the function. If you do
6281 not define this macro, the usual case, GCC will output the constant
6282 pool before the function.
6285 @defmac ASM_OUTPUT_POOL_PROLOGUE (@var{file}, @var{funname}, @var{fundecl}, @var{size})
6286 A C statement to output assembler commands to define the start of the
6287 constant pool for a function. @var{funname} is a string giving
6288 the name of the function. Should the return type of the function
6289 be required, it can be obtained via @var{fundecl}. @var{size}
6290 is the size, in bytes, of the constant pool that will be written
6291 immediately after this call.
6293 If no constant-pool prefix is required, the usual case, this macro need
6297 @defmac ASM_OUTPUT_SPECIAL_POOL_ENTRY (@var{file}, @var{x}, @var{mode}, @var{align}, @var{labelno}, @var{jumpto})
6298 A C statement (with or without semicolon) to output a constant in the
6299 constant pool, if it needs special treatment. (This macro need not do
6300 anything for RTL expressions that can be output normally.)
6302 The argument @var{file} is the standard I/O stream to output the
6303 assembler code on. @var{x} is the RTL expression for the constant to
6304 output, and @var{mode} is the machine mode (in case @var{x} is a
6305 @samp{const_int}). @var{align} is the required alignment for the value
6306 @var{x}; you should output an assembler directive to force this much
6309 The argument @var{labelno} is a number to use in an internal label for
6310 the address of this pool entry. The definition of this macro is
6311 responsible for outputting the label definition at the proper place.
6312 Here is how to do this:
6315 @code{(*targetm.asm_out.internal_label)} (@var{file}, "LC", @var{labelno});
6318 When you output a pool entry specially, you should end with a
6319 @code{goto} to the label @var{jumpto}. This will prevent the same pool
6320 entry from being output a second time in the usual manner.
6322 You need not define this macro if it would do nothing.
6325 @defmac ASM_OUTPUT_POOL_EPILOGUE (@var{file} @var{funname} @var{fundecl} @var{size})
6326 A C statement to output assembler commands to at the end of the constant
6327 pool for a function. @var{funname} is a string giving the name of the
6328 function. Should the return type of the function be required, you can
6329 obtain it via @var{fundecl}. @var{size} is the size, in bytes, of the
6330 constant pool that GCC wrote immediately before this call.
6332 If no constant-pool epilogue is required, the usual case, you need not
6336 @defmac IS_ASM_LOGICAL_LINE_SEPARATOR (@var{C})
6337 Define this macro as a C expression which is nonzero if @var{C} is
6338 used as a logical line separator by the assembler.
6340 If you do not define this macro, the default is that only
6341 the character @samp{;} is treated as a logical line separator.
6344 @deftypevr {Target Hook} {const char *} TARGET_ASM_OPEN_PAREN
6345 @deftypevrx {Target Hook} {const char *} TARGET_ASM_CLOSE_PAREN
6346 These target hooks are C string constants, describing the syntax in the
6347 assembler for grouping arithmetic expressions. If not overridden, they
6348 default to normal parentheses, which is correct for most assemblers.
6351 These macros are provided by @file{real.h} for writing the definitions
6352 of @code{ASM_OUTPUT_DOUBLE} and the like:
6354 @defmac REAL_VALUE_TO_TARGET_SINGLE (@var{x}, @var{l})
6355 @defmacx REAL_VALUE_TO_TARGET_DOUBLE (@var{x}, @var{l})
6356 @defmacx REAL_VALUE_TO_TARGET_LONG_DOUBLE (@var{x}, @var{l})
6357 These translate @var{x}, of type @code{REAL_VALUE_TYPE}, to the target's
6358 floating point representation, and store its bit pattern in the variable
6359 @var{l}. For @code{REAL_VALUE_TO_TARGET_SINGLE}, this variable should
6360 be a simple @code{long int}. For the others, it should be an array of
6361 @code{long int}. The number of elements in this array is determined by
6362 the size of the desired target floating point data type: 32 bits of it
6363 go in each @code{long int} array element. Each array element holds 32
6364 bits of the result, even if @code{long int} is wider than 32 bits on the
6367 The array element values are designed so that you can print them out
6368 using @code{fprintf} in the order they should appear in the target
6372 @node Uninitialized Data
6373 @subsection Output of Uninitialized Variables
6375 Each of the macros in this section is used to do the whole job of
6376 outputting a single uninitialized variable.
6378 @defmac ASM_OUTPUT_COMMON (@var{stream}, @var{name}, @var{size}, @var{rounded})
6379 A C statement (sans semicolon) to output to the stdio stream
6380 @var{stream} the assembler definition of a common-label named
6381 @var{name} whose size is @var{size} bytes. The variable @var{rounded}
6382 is the size rounded up to whatever alignment the caller wants.
6384 Use the expression @code{assemble_name (@var{stream}, @var{name})} to
6385 output the name itself; before and after that, output the additional
6386 assembler syntax for defining the name, and a newline.
6388 This macro controls how the assembler definitions of uninitialized
6389 common global variables are output.
6392 @defmac ASM_OUTPUT_ALIGNED_COMMON (@var{stream}, @var{name}, @var{size}, @var{alignment})
6393 Like @code{ASM_OUTPUT_COMMON} except takes the required alignment as a
6394 separate, explicit argument. If you define this macro, it is used in
6395 place of @code{ASM_OUTPUT_COMMON}, and gives you more flexibility in
6396 handling the required alignment of the variable. The alignment is specified
6397 as the number of bits.
6400 @defmac ASM_OUTPUT_ALIGNED_DECL_COMMON (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment})
6401 Like @code{ASM_OUTPUT_ALIGNED_COMMON} except that @var{decl} of the
6402 variable to be output, if there is one, or @code{NULL_TREE} if there
6403 is no corresponding variable. If you define this macro, GCC will use it
6404 in place of both @code{ASM_OUTPUT_COMMON} and
6405 @code{ASM_OUTPUT_ALIGNED_COMMON}. Define this macro when you need to see
6406 the variable's decl in order to chose what to output.
6409 @defmac ASM_OUTPUT_SHARED_COMMON (@var{stream}, @var{name}, @var{size}, @var{rounded})
6410 If defined, it is similar to @code{ASM_OUTPUT_COMMON}, except that it
6411 is used when @var{name} is shared. If not defined, @code{ASM_OUTPUT_COMMON}
6415 @defmac ASM_OUTPUT_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{rounded})
6416 A C statement (sans semicolon) to output to the stdio stream
6417 @var{stream} the assembler definition of uninitialized global @var{decl} named
6418 @var{name} whose size is @var{size} bytes. The variable @var{rounded}
6419 is the size rounded up to whatever alignment the caller wants.
6421 Try to use function @code{asm_output_bss} defined in @file{varasm.c} when
6422 defining this macro. If unable, use the expression
6423 @code{assemble_name (@var{stream}, @var{name})} to output the name itself;
6424 before and after that, output the additional assembler syntax for defining
6425 the name, and a newline.
6427 This macro controls how the assembler definitions of uninitialized global
6428 variables are output. This macro exists to properly support languages like
6429 C++ which do not have @code{common} data. However, this macro currently
6430 is not defined for all targets. If this macro and
6431 @code{ASM_OUTPUT_ALIGNED_BSS} are not defined then @code{ASM_OUTPUT_COMMON}
6432 or @code{ASM_OUTPUT_ALIGNED_COMMON} or
6433 @code{ASM_OUTPUT_ALIGNED_DECL_COMMON} is used.
6436 @defmac ASM_OUTPUT_ALIGNED_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment})
6437 Like @code{ASM_OUTPUT_BSS} except takes the required alignment as a
6438 separate, explicit argument. If you define this macro, it is used in
6439 place of @code{ASM_OUTPUT_BSS}, and gives you more flexibility in
6440 handling the required alignment of the variable. The alignment is specified
6441 as the number of bits.
6443 Try to use function @code{asm_output_aligned_bss} defined in file
6444 @file{varasm.c} when defining this macro.
6447 @defmac ASM_OUTPUT_SHARED_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{rounded})
6448 If defined, it is similar to @code{ASM_OUTPUT_BSS}, except that it
6449 is used when @var{name} is shared. If not defined, @code{ASM_OUTPUT_BSS}
6453 @defmac ASM_OUTPUT_LOCAL (@var{stream}, @var{name}, @var{size}, @var{rounded})
6454 A C statement (sans semicolon) to output to the stdio stream
6455 @var{stream} the assembler definition of a local-common-label named
6456 @var{name} whose size is @var{size} bytes. The variable @var{rounded}
6457 is the size rounded up to whatever alignment the caller wants.
6459 Use the expression @code{assemble_name (@var{stream}, @var{name})} to
6460 output the name itself; before and after that, output the additional
6461 assembler syntax for defining the name, and a newline.
6463 This macro controls how the assembler definitions of uninitialized
6464 static variables are output.
6467 @defmac ASM_OUTPUT_ALIGNED_LOCAL (@var{stream}, @var{name}, @var{size}, @var{alignment})
6468 Like @code{ASM_OUTPUT_LOCAL} except takes the required alignment as a
6469 separate, explicit argument. If you define this macro, it is used in
6470 place of @code{ASM_OUTPUT_LOCAL}, and gives you more flexibility in
6471 handling the required alignment of the variable. The alignment is specified
6472 as the number of bits.
6475 @defmac ASM_OUTPUT_ALIGNED_DECL_LOCAL (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment})
6476 Like @code{ASM_OUTPUT_ALIGNED_DECL} except that @var{decl} of the
6477 variable to be output, if there is one, or @code{NULL_TREE} if there
6478 is no corresponding variable. If you define this macro, GCC will use it
6479 in place of both @code{ASM_OUTPUT_DECL} and
6480 @code{ASM_OUTPUT_ALIGNED_DECL}. Define this macro when you need to see
6481 the variable's decl in order to chose what to output.
6484 @defmac ASM_OUTPUT_SHARED_LOCAL (@var{stream}, @var{name}, @var{size}, @var{rounded})
6485 If defined, it is similar to @code{ASM_OUTPUT_LOCAL}, except that it
6486 is used when @var{name} is shared. If not defined, @code{ASM_OUTPUT_LOCAL}
6491 @subsection Output and Generation of Labels
6493 @c prevent bad page break with this line
6494 This is about outputting labels.
6496 @findex assemble_name
6497 @defmac ASM_OUTPUT_LABEL (@var{stream}, @var{name})
6498 A C statement (sans semicolon) to output to the stdio stream
6499 @var{stream} the assembler definition of a label named @var{name}.
6500 Use the expression @code{assemble_name (@var{stream}, @var{name})} to
6501 output the name itself; before and after that, output the additional
6502 assembler syntax for defining the name, and a newline. A default
6503 definition of this macro is provided which is correct for most systems.
6507 A C string containing the appropriate assembler directive to specify the
6508 size of a symbol, without any arguments. On systems that use ELF, the
6509 default (in @file{config/elfos.h}) is @samp{"\t.size\t"}; on other
6510 systems, the default is not to define this macro.
6512 Define this macro only if it is correct to use the default definitions
6513 of @code{ASM_OUTPUT_SIZE_DIRECTIVE} and @code{ASM_OUTPUT_MEASURED_SIZE}
6514 for your system. If you need your own custom definitions of those
6515 macros, or if you do not need explicit symbol sizes at all, do not
6519 @defmac ASM_OUTPUT_SIZE_DIRECTIVE (@var{stream}, @var{name}, @var{size})
6520 A C statement (sans semicolon) to output to the stdio stream
6521 @var{stream} a directive telling the assembler that the size of the
6522 symbol @var{name} is @var{size}. @var{size} is a @code{HOST_WIDE_INT}.
6523 If you define @code{SIZE_ASM_OP}, a default definition of this macro is
6527 @defmac ASM_OUTPUT_MEASURED_SIZE (@var{stream}, @var{name})
6528 A C statement (sans semicolon) to output to the stdio stream
6529 @var{stream} a directive telling the assembler to calculate the size of
6530 the symbol @var{name} by subtracting its address from the current
6533 If you define @code{SIZE_ASM_OP}, a default definition of this macro is
6534 provided. The default assumes that the assembler recognizes a special
6535 @samp{.} symbol as referring to the current address, and can calculate
6536 the difference between this and another symbol. If your assembler does
6537 not recognize @samp{.} or cannot do calculations with it, you will need
6538 to redefine @code{ASM_OUTPUT_MEASURED_SIZE} to use some other technique.
6542 A C string containing the appropriate assembler directive to specify the
6543 type of a symbol, without any arguments. On systems that use ELF, the
6544 default (in @file{config/elfos.h}) is @samp{"\t.type\t"}; on other
6545 systems, the default is not to define this macro.
6547 Define this macro only if it is correct to use the default definition of
6548 @code{ASM_OUTPUT_TYPE_DIRECTIVE} for your system. If you need your own
6549 custom definition of this macro, or if you do not need explicit symbol
6550 types at all, do not define this macro.
6553 @defmac TYPE_OPERAND_FMT
6554 A C string which specifies (using @code{printf} syntax) the format of
6555 the second operand to @code{TYPE_ASM_OP}. On systems that use ELF, the
6556 default (in @file{config/elfos.h}) is @samp{"@@%s"}; on other systems,
6557 the default is not to define this macro.
6559 Define this macro only if it is correct to use the default definition of
6560 @code{ASM_OUTPUT_TYPE_DIRECTIVE} for your system. If you need your own
6561 custom definition of this macro, or if you do not need explicit symbol
6562 types at all, do not define this macro.
6565 @defmac ASM_OUTPUT_TYPE_DIRECTIVE (@var{stream}, @var{type})
6566 A C statement (sans semicolon) to output to the stdio stream
6567 @var{stream} a directive telling the assembler that the type of the
6568 symbol @var{name} is @var{type}. @var{type} is a C string; currently,
6569 that string is always either @samp{"function"} or @samp{"object"}, but
6570 you should not count on this.
6572 If you define @code{TYPE_ASM_OP} and @code{TYPE_OPERAND_FMT}, a default
6573 definition of this macro is provided.
6576 @defmac ASM_DECLARE_FUNCTION_NAME (@var{stream}, @var{name}, @var{decl})
6577 A C statement (sans semicolon) to output to the stdio stream
6578 @var{stream} any text necessary for declaring the name @var{name} of a
6579 function which is being defined. This macro is responsible for
6580 outputting the label definition (perhaps using
6581 @code{ASM_OUTPUT_LABEL}). The argument @var{decl} is the
6582 @code{FUNCTION_DECL} tree node representing the function.
6584 If this macro is not defined, then the function name is defined in the
6585 usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}).
6587 You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in the definition
6591 @defmac ASM_DECLARE_FUNCTION_SIZE (@var{stream}, @var{name}, @var{decl})
6592 A C statement (sans semicolon) to output to the stdio stream
6593 @var{stream} any text necessary for declaring the size of a function
6594 which is being defined. The argument @var{name} is the name of the
6595 function. The argument @var{decl} is the @code{FUNCTION_DECL} tree node
6596 representing the function.
6598 If this macro is not defined, then the function size is not defined.
6600 You may wish to use @code{ASM_OUTPUT_MEASURED_SIZE} in the definition
6604 @defmac ASM_DECLARE_OBJECT_NAME (@var{stream}, @var{name}, @var{decl})
6605 A C statement (sans semicolon) to output to the stdio stream
6606 @var{stream} any text necessary for declaring the name @var{name} of an
6607 initialized variable which is being defined. This macro must output the
6608 label definition (perhaps using @code{ASM_OUTPUT_LABEL}). The argument
6609 @var{decl} is the @code{VAR_DECL} tree node representing the variable.
6611 If this macro is not defined, then the variable name is defined in the
6612 usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}).
6614 You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} and/or
6615 @code{ASM_OUTPUT_SIZE_DIRECTIVE} in the definition of this macro.
6618 @defmac ASM_DECLARE_REGISTER_GLOBAL (@var{stream}, @var{decl}, @var{regno}, @var{name})
6619 A C statement (sans semicolon) to output to the stdio stream
6620 @var{stream} any text necessary for claiming a register @var{regno}
6621 for a global variable @var{decl} with name @var{name}.
6623 If you don't define this macro, that is equivalent to defining it to do
6627 @defmac ASM_FINISH_DECLARE_OBJECT (@var{stream}, @var{decl}, @var{toplevel}, @var{atend})
6628 A C statement (sans semicolon) to finish up declaring a variable name
6629 once the compiler has processed its initializer fully and thus has had a
6630 chance to determine the size of an array when controlled by an
6631 initializer. This is used on systems where it's necessary to declare
6632 something about the size of the object.
6634 If you don't define this macro, that is equivalent to defining it to do
6637 You may wish to use @code{ASM_OUTPUT_SIZE_DIRECTIVE} and/or
6638 @code{ASM_OUTPUT_MEASURED_SIZE} in the definition of this macro.
6641 @deftypefn {Target Hook} void TARGET_ASM_GLOBALIZE_LABEL (FILE *@var{stream}, const char *@var{name})
6642 This target hook is a function to output to the stdio stream
6643 @var{stream} some commands that will make the label @var{name} global;
6644 that is, available for reference from other files.
6646 The default implementation relies on a proper definition of
6647 @code{GLOBAL_ASM_OP}.
6650 @defmac ASM_WEAKEN_LABEL (@var{stream}, @var{name})
6651 A C statement (sans semicolon) to output to the stdio stream
6652 @var{stream} some commands that will make the label @var{name} weak;
6653 that is, available for reference from other files but only used if
6654 no other definition is available. Use the expression
6655 @code{assemble_name (@var{stream}, @var{name})} to output the name
6656 itself; before and after that, output the additional assembler syntax
6657 for making that name weak, and a newline.
6659 If you don't define this macro or @code{ASM_WEAKEN_DECL}, GCC will not
6660 support weak symbols and you should not define the @code{SUPPORTS_WEAK}
6664 @defmac ASM_WEAKEN_DECL (@var{stream}, @var{decl}, @var{name}, @var{value})
6665 Combines (and replaces) the function of @code{ASM_WEAKEN_LABEL} and
6666 @code{ASM_OUTPUT_WEAK_ALIAS}, allowing access to the associated function
6667 or variable decl. If @var{value} is not @code{NULL}, this C statement
6668 should output to the stdio stream @var{stream} assembler code which
6669 defines (equates) the weak symbol @var{name} to have the value
6670 @var{value}. If @var{value} is @code{NULL}, it should output commands
6671 to make @var{name} weak.
6674 @defmac SUPPORTS_WEAK
6675 A C expression which evaluates to true if the target supports weak symbols.
6677 If you don't define this macro, @file{defaults.h} provides a default
6678 definition. If either @code{ASM_WEAKEN_LABEL} or @code{ASM_WEAKEN_DECL}
6679 is defined, the default definition is @samp{1}; otherwise, it is
6680 @samp{0}. Define this macro if you want to control weak symbol support
6681 with a compiler flag such as @option{-melf}.
6684 @defmac MAKE_DECL_ONE_ONLY (@var{decl})
6685 A C statement (sans semicolon) to mark @var{decl} to be emitted as a
6686 public symbol such that extra copies in multiple translation units will
6687 be discarded by the linker. Define this macro if your object file
6688 format provides support for this concept, such as the @samp{COMDAT}
6689 section flags in the Microsoft Windows PE/COFF format, and this support
6690 requires changes to @var{decl}, such as putting it in a separate section.
6693 @defmac SUPPORTS_ONE_ONLY
6694 A C expression which evaluates to true if the target supports one-only
6697 If you don't define this macro, @file{varasm.c} provides a default
6698 definition. If @code{MAKE_DECL_ONE_ONLY} is defined, the default
6699 definition is @samp{1}; otherwise, it is @samp{0}. Define this macro if
6700 you want to control one-only symbol support with a compiler flag, or if
6701 setting the @code{DECL_ONE_ONLY} flag is enough to mark a declaration to
6702 be emitted as one-only.
6705 @deftypefn {Target Hook} void TARGET_ASM_ASSEMBLE_VISIBILITY (tree @var{decl}, const char *@var{visibility})
6706 This target hook is a function to output to @var{asm_out_file} some
6707 commands that will make the symbol(s) associated with @var{decl} have
6708 hidden, protected or internal visibility as specified by @var{visibility}.
6711 @defmac ASM_OUTPUT_EXTERNAL (@var{stream}, @var{decl}, @var{name})
6712 A C statement (sans semicolon) to output to the stdio stream
6713 @var{stream} any text necessary for declaring the name of an external
6714 symbol named @var{name} which is referenced in this compilation but
6715 not defined. The value of @var{decl} is the tree node for the
6718 This macro need not be defined if it does not need to output anything.
6719 The GNU assembler and most Unix assemblers don't require anything.
6722 @defmac ASM_OUTPUT_EXTERNAL_LIBCALL (@var{stream}, @var{symref})
6723 A C statement (sans semicolon) to output on @var{stream} an assembler
6724 pseudo-op to declare a library function name external. The name of the
6725 library function is given by @var{symref}, which has type @code{rtx} and
6726 is a @code{symbol_ref}.
6728 This macro need not be defined if it does not need to output anything.
6729 The GNU assembler and most Unix assemblers don't require anything.
6732 @defmac ASM_OUTPUT_LABELREF (@var{stream}, @var{name})
6733 A C statement (sans semicolon) to output to the stdio stream
6734 @var{stream} a reference in assembler syntax to a label named
6735 @var{name}. This should add @samp{_} to the front of the name, if that
6736 is customary on your operating system, as it is in most Berkeley Unix
6737 systems. This macro is used in @code{assemble_name}.
6740 @defmac ASM_OUTPUT_SYMBOL_REF (@var{stream}, @var{sym})
6741 A C statement (sans semicolon) to output a reference to
6742 @code{SYMBOL_REF} @var{sym}. If not defined, @code{assemble_name}
6743 will be used to output the name of the symbol. This macro may be used
6744 to modify the way a symbol is referenced depending on information
6745 encoded by @code{TARGET_ENCODE_SECTION_INFO}.
6748 @defmac ASM_OUTPUT_LABEL_REF (@var{stream}, @var{buf})
6749 A C statement (sans semicolon) to output a reference to @var{buf}, the
6750 result of @code{ASM_GENERATE_INTERNAL_LABEL}. If not defined,
6751 @code{assemble_name} will be used to output the name of the symbol.
6752 This macro is not used by @code{output_asm_label}, or the @code{%l}
6753 specifier that calls it; the intention is that this macro should be set
6754 when it is necessary to output a label differently when its address is
6758 @deftypefn {Target Hook} void TARGET_ASM_INTERNAL_LABEL (FILE *@var{stream}, const char *@var{prefix}, unsigned long @var{labelno})
6759 A function to output to the stdio stream @var{stream} a label whose
6760 name is made from the string @var{prefix} and the number @var{labelno}.
6762 It is absolutely essential that these labels be distinct from the labels
6763 used for user-level functions and variables. Otherwise, certain programs
6764 will have name conflicts with internal labels.
6766 It is desirable to exclude internal labels from the symbol table of the
6767 object file. Most assemblers have a naming convention for labels that
6768 should be excluded; on many systems, the letter @samp{L} at the
6769 beginning of a label has this effect. You should find out what
6770 convention your system uses, and follow it.
6772 The default version of this function utilizes ASM_GENERATE_INTERNAL_LABEL.
6775 @defmac ASM_OUTPUT_DEBUG_LABEL (@var{stream}, @var{prefix}, @var{num})
6776 A C statement to output to the stdio stream @var{stream} a debug info
6777 label whose name is made from the string @var{prefix} and the number
6778 @var{num}. This is useful for VLIW targets, where debug info labels
6779 may need to be treated differently than branch target labels. On some
6780 systems, branch target labels must be at the beginning of instruction
6781 bundles, but debug info labels can occur in the middle of instruction
6784 If this macro is not defined, then @code{(*targetm.asm_out.internal_label)} will be
6788 @defmac ASM_GENERATE_INTERNAL_LABEL (@var{string}, @var{prefix}, @var{num})
6789 A C statement to store into the string @var{string} a label whose name
6790 is made from the string @var{prefix} and the number @var{num}.
6792 This string, when output subsequently by @code{assemble_name}, should
6793 produce the output that @code{(*targetm.asm_out.internal_label)} would produce
6794 with the same @var{prefix} and @var{num}.
6796 If the string begins with @samp{*}, then @code{assemble_name} will
6797 output the rest of the string unchanged. It is often convenient for
6798 @code{ASM_GENERATE_INTERNAL_LABEL} to use @samp{*} in this way. If the
6799 string doesn't start with @samp{*}, then @code{ASM_OUTPUT_LABELREF} gets
6800 to output the string, and may change it. (Of course,
6801 @code{ASM_OUTPUT_LABELREF} is also part of your machine description, so
6802 you should know what it does on your machine.)
6805 @defmac ASM_FORMAT_PRIVATE_NAME (@var{outvar}, @var{name}, @var{number})
6806 A C expression to assign to @var{outvar} (which is a variable of type
6807 @code{char *}) a newly allocated string made from the string
6808 @var{name} and the number @var{number}, with some suitable punctuation
6809 added. Use @code{alloca} to get space for the string.
6811 The string will be used as an argument to @code{ASM_OUTPUT_LABELREF} to
6812 produce an assembler label for an internal static variable whose name is
6813 @var{name}. Therefore, the string must be such as to result in valid
6814 assembler code. The argument @var{number} is different each time this
6815 macro is executed; it prevents conflicts between similarly-named
6816 internal static variables in different scopes.
6818 Ideally this string should not be a valid C identifier, to prevent any
6819 conflict with the user's own symbols. Most assemblers allow periods
6820 or percent signs in assembler symbols; putting at least one of these
6821 between the name and the number will suffice.
6823 If this macro is not defined, a default definition will be provided
6824 which is correct for most systems.
6827 @defmac ASM_OUTPUT_DEF (@var{stream}, @var{name}, @var{value})
6828 A C statement to output to the stdio stream @var{stream} assembler code
6829 which defines (equates) the symbol @var{name} to have the value @var{value}.
6832 If @code{SET_ASM_OP} is defined, a default definition is provided which is
6833 correct for most systems.
6836 @defmac ASM_OUTPUT_DEF_FROM_DECLS (@var{stream}, @var{decl_of_name}, @var{decl_of_value})
6837 A C statement to output to the stdio stream @var{stream} assembler code
6838 which defines (equates) the symbol whose tree node is @var{decl_of_name}
6839 to have the value of the tree node @var{decl_of_value}. This macro will
6840 be used in preference to @samp{ASM_OUTPUT_DEF} if it is defined and if
6841 the tree nodes are available.
6844 If @code{SET_ASM_OP} is defined, a default definition is provided which is
6845 correct for most systems.
6848 @defmac ASM_OUTPUT_WEAK_ALIAS (@var{stream}, @var{name}, @var{value})
6849 A C statement to output to the stdio stream @var{stream} assembler code
6850 which defines (equates) the weak symbol @var{name} to have the value
6851 @var{value}. If @var{value} is @code{NULL}, it defines @var{name} as
6852 an undefined weak symbol.
6854 Define this macro if the target only supports weak aliases; define
6855 @code{ASM_OUTPUT_DEF} instead if possible.
6858 @defmac OBJC_GEN_METHOD_LABEL (@var{buf}, @var{is_inst}, @var{class_name}, @var{cat_name}, @var{sel_name})
6859 Define this macro to override the default assembler names used for
6860 Objective-C methods.
6862 The default name is a unique method number followed by the name of the
6863 class (e.g.@: @samp{_1_Foo}). For methods in categories, the name of
6864 the category is also included in the assembler name (e.g.@:
6867 These names are safe on most systems, but make debugging difficult since
6868 the method's selector is not present in the name. Therefore, particular
6869 systems define other ways of computing names.
6871 @var{buf} is an expression of type @code{char *} which gives you a
6872 buffer in which to store the name; its length is as long as
6873 @var{class_name}, @var{cat_name} and @var{sel_name} put together, plus
6874 50 characters extra.
6876 The argument @var{is_inst} specifies whether the method is an instance
6877 method or a class method; @var{class_name} is the name of the class;
6878 @var{cat_name} is the name of the category (or @code{NULL} if the method is not
6879 in a category); and @var{sel_name} is the name of the selector.
6881 On systems where the assembler can handle quoted names, you can use this
6882 macro to provide more human-readable names.
6885 @defmac ASM_DECLARE_CLASS_REFERENCE (@var{stream}, @var{name})
6886 A C statement (sans semicolon) to output to the stdio stream
6887 @var{stream} commands to declare that the label @var{name} is an
6888 Objective-C class reference. This is only needed for targets whose
6889 linkers have special support for NeXT-style runtimes.
6892 @defmac ASM_DECLARE_UNRESOLVED_REFERENCE (@var{stream}, @var{name})
6893 A C statement (sans semicolon) to output to the stdio stream
6894 @var{stream} commands to declare that the label @var{name} is an
6895 unresolved Objective-C class reference. This is only needed for targets
6896 whose linkers have special support for NeXT-style runtimes.
6899 @node Initialization
6900 @subsection How Initialization Functions Are Handled
6901 @cindex initialization routines
6902 @cindex termination routines
6903 @cindex constructors, output of
6904 @cindex destructors, output of
6906 The compiled code for certain languages includes @dfn{constructors}
6907 (also called @dfn{initialization routines})---functions to initialize
6908 data in the program when the program is started. These functions need
6909 to be called before the program is ``started''---that is to say, before
6910 @code{main} is called.
6912 Compiling some languages generates @dfn{destructors} (also called
6913 @dfn{termination routines}) that should be called when the program
6916 To make the initialization and termination functions work, the compiler
6917 must output something in the assembler code to cause those functions to
6918 be called at the appropriate time. When you port the compiler to a new
6919 system, you need to specify how to do this.
6921 There are two major ways that GCC currently supports the execution of
6922 initialization and termination functions. Each way has two variants.
6923 Much of the structure is common to all four variations.
6925 @findex __CTOR_LIST__
6926 @findex __DTOR_LIST__
6927 The linker must build two lists of these functions---a list of
6928 initialization functions, called @code{__CTOR_LIST__}, and a list of
6929 termination functions, called @code{__DTOR_LIST__}.
6931 Each list always begins with an ignored function pointer (which may hold
6932 0, @minus{}1, or a count of the function pointers after it, depending on
6933 the environment). This is followed by a series of zero or more function
6934 pointers to constructors (or destructors), followed by a function
6935 pointer containing zero.
6937 Depending on the operating system and its executable file format, either
6938 @file{crtstuff.c} or @file{libgcc2.c} traverses these lists at startup
6939 time and exit time. Constructors are called in reverse order of the
6940 list; destructors in forward order.
6942 The best way to handle static constructors works only for object file
6943 formats which provide arbitrarily-named sections. A section is set
6944 aside for a list of constructors, and another for a list of destructors.
6945 Traditionally these are called @samp{.ctors} and @samp{.dtors}. Each
6946 object file that defines an initialization function also puts a word in
6947 the constructor section to point to that function. The linker
6948 accumulates all these words into one contiguous @samp{.ctors} section.
6949 Termination functions are handled similarly.
6951 This method will be chosen as the default by @file{target-def.h} if
6952 @code{TARGET_ASM_NAMED_SECTION} is defined. A target that does not
6953 support arbitrary sections, but does support special designated
6954 constructor and destructor sections may define @code{CTORS_SECTION_ASM_OP}
6955 and @code{DTORS_SECTION_ASM_OP} to achieve the same effect.
6957 When arbitrary sections are available, there are two variants, depending
6958 upon how the code in @file{crtstuff.c} is called. On systems that
6959 support a @dfn{.init} section which is executed at program startup,
6960 parts of @file{crtstuff.c} are compiled into that section. The
6961 program is linked by the @command{gcc} driver like this:
6964 ld -o @var{output_file} crti.o crtbegin.o @dots{} -lgcc crtend.o crtn.o
6967 The prologue of a function (@code{__init}) appears in the @code{.init}
6968 section of @file{crti.o}; the epilogue appears in @file{crtn.o}. Likewise
6969 for the function @code{__fini} in the @dfn{.fini} section. Normally these
6970 files are provided by the operating system or by the GNU C library, but
6971 are provided by GCC for a few targets.
6973 The objects @file{crtbegin.o} and @file{crtend.o} are (for most targets)
6974 compiled from @file{crtstuff.c}. They contain, among other things, code
6975 fragments within the @code{.init} and @code{.fini} sections that branch
6976 to routines in the @code{.text} section. The linker will pull all parts
6977 of a section together, which results in a complete @code{__init} function
6978 that invokes the routines we need at startup.
6980 To use this variant, you must define the @code{INIT_SECTION_ASM_OP}
6983 If no init section is available, when GCC compiles any function called
6984 @code{main} (or more accurately, any function designated as a program
6985 entry point by the language front end calling @code{expand_main_function}),
6986 it inserts a procedure call to @code{__main} as the first executable code
6987 after the function prologue. The @code{__main} function is defined
6988 in @file{libgcc2.c} and runs the global constructors.
6990 In file formats that don't support arbitrary sections, there are again
6991 two variants. In the simplest variant, the GNU linker (GNU @code{ld})
6992 and an `a.out' format must be used. In this case,
6993 @code{TARGET_ASM_CONSTRUCTOR} is defined to produce a @code{.stabs}
6994 entry of type @samp{N_SETT}, referencing the name @code{__CTOR_LIST__},
6995 and with the address of the void function containing the initialization
6996 code as its value. The GNU linker recognizes this as a request to add
6997 the value to a @dfn{set}; the values are accumulated, and are eventually
6998 placed in the executable as a vector in the format described above, with
6999 a leading (ignored) count and a trailing zero element.
7000 @code{TARGET_ASM_DESTRUCTOR} is handled similarly. Since no init
7001 section is available, the absence of @code{INIT_SECTION_ASM_OP} causes
7002 the compilation of @code{main} to call @code{__main} as above, starting
7003 the initialization process.
7005 The last variant uses neither arbitrary sections nor the GNU linker.
7006 This is preferable when you want to do dynamic linking and when using
7007 file formats which the GNU linker does not support, such as `ECOFF'@. In
7008 this case, @code{TARGET_HAVE_CTORS_DTORS} is false, initialization and
7009 termination functions are recognized simply by their names. This requires
7010 an extra program in the linkage step, called @command{collect2}. This program
7011 pretends to be the linker, for use with GCC; it does its job by running
7012 the ordinary linker, but also arranges to include the vectors of
7013 initialization and termination functions. These functions are called
7014 via @code{__main} as described above. In order to use this method,
7015 @code{use_collect2} must be defined in the target in @file{config.gcc}.
7018 The following section describes the specific macros that control and
7019 customize the handling of initialization and termination functions.
7022 @node Macros for Initialization
7023 @subsection Macros Controlling Initialization Routines
7025 Here are the macros that control how the compiler handles initialization
7026 and termination functions:
7028 @defmac INIT_SECTION_ASM_OP
7029 If defined, a C string constant, including spacing, for the assembler
7030 operation to identify the following data as initialization code. If not
7031 defined, GCC will assume such a section does not exist. When you are
7032 using special sections for initialization and termination functions, this
7033 macro also controls how @file{crtstuff.c} and @file{libgcc2.c} arrange to
7034 run the initialization functions.
7037 @defmac HAS_INIT_SECTION
7038 If defined, @code{main} will not call @code{__main} as described above.
7039 This macro should be defined for systems that control start-up code
7040 on a symbol-by-symbol basis, such as OSF/1, and should not
7041 be defined explicitly for systems that support @code{INIT_SECTION_ASM_OP}.
7044 @defmac LD_INIT_SWITCH
7045 If defined, a C string constant for a switch that tells the linker that
7046 the following symbol is an initialization routine.
7049 @defmac LD_FINI_SWITCH
7050 If defined, a C string constant for a switch that tells the linker that
7051 the following symbol is a finalization routine.
7054 @defmac COLLECT_SHARED_INIT_FUNC (@var{stream}, @var{func})
7055 If defined, a C statement that will write a function that can be
7056 automatically called when a shared library is loaded. The function
7057 should call @var{func}, which takes no arguments. If not defined, and
7058 the object format requires an explicit initialization function, then a
7059 function called @code{_GLOBAL__DI} will be generated.
7061 This function and the following one are used by collect2 when linking a
7062 shared library that needs constructors or destructors, or has DWARF2
7063 exception tables embedded in the code.
7066 @defmac COLLECT_SHARED_FINI_FUNC (@var{stream}, @var{func})
7067 If defined, a C statement that will write a function that can be
7068 automatically called when a shared library is unloaded. The function
7069 should call @var{func}, which takes no arguments. If not defined, and
7070 the object format requires an explicit finalization function, then a
7071 function called @code{_GLOBAL__DD} will be generated.
7074 @defmac INVOKE__main
7075 If defined, @code{main} will call @code{__main} despite the presence of
7076 @code{INIT_SECTION_ASM_OP}. This macro should be defined for systems
7077 where the init section is not actually run automatically, but is still
7078 useful for collecting the lists of constructors and destructors.
7081 @defmac SUPPORTS_INIT_PRIORITY
7082 If nonzero, the C++ @code{init_priority} attribute is supported and the
7083 compiler should emit instructions to control the order of initialization
7084 of objects. If zero, the compiler will issue an error message upon
7085 encountering an @code{init_priority} attribute.
7088 @deftypefn {Target Hook} bool TARGET_HAVE_CTORS_DTORS
7089 This value is true if the target supports some ``native'' method of
7090 collecting constructors and destructors to be run at startup and exit.
7091 It is false if we must use @command{collect2}.
7094 @deftypefn {Target Hook} void TARGET_ASM_CONSTRUCTOR (rtx @var{symbol}, int @var{priority})
7095 If defined, a function that outputs assembler code to arrange to call
7096 the function referenced by @var{symbol} at initialization time.
7098 Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking
7099 no arguments and with no return value. If the target supports initialization
7100 priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};
7101 otherwise it must be @code{DEFAULT_INIT_PRIORITY}.
7103 If this macro is not defined by the target, a suitable default will
7104 be chosen if (1) the target supports arbitrary section names, (2) the
7105 target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}
7109 @deftypefn {Target Hook} void TARGET_ASM_DESTRUCTOR (rtx @var{symbol}, int @var{priority})
7110 This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination
7111 functions rather than initialization functions.
7114 If @code{TARGET_HAVE_CTORS_DTORS} is true, the initialization routine
7115 generated for the generated object file will have static linkage.
7117 If your system uses @command{collect2} as the means of processing
7118 constructors, then that program normally uses @command{nm} to scan
7119 an object file for constructor functions to be called.
7121 On certain kinds of systems, you can define these macros to make
7122 @command{collect2} work faster (and, in some cases, make it work at all):
7124 @defmac OBJECT_FORMAT_COFF
7125 Define this macro if the system uses COFF (Common Object File Format)
7126 object files, so that @command{collect2} can assume this format and scan
7127 object files directly for dynamic constructor/destructor functions.
7130 @defmac OBJECT_FORMAT_ROSE
7131 Define this macro if the system uses ROSE format object files, so that
7132 @command{collect2} can assume this format and scan object files directly
7133 for dynamic constructor/destructor functions.
7135 These macros are effective only in a native compiler; @command{collect2} as
7136 part of a cross compiler always uses @command{nm} for the target machine.
7139 @defmac REAL_NM_FILE_NAME
7140 Define this macro as a C string constant containing the file name to use
7141 to execute @command{nm}. The default is to search the path normally for
7144 If your system supports shared libraries and has a program to list the
7145 dynamic dependencies of a given library or executable, you can define
7146 these macros to enable support for running initialization and
7147 termination functions in shared libraries:
7151 Define this macro to a C string constant containing the name of the program
7152 which lists dynamic dependencies, like @command{"ldd"} under SunOS 4.
7155 @defmac PARSE_LDD_OUTPUT (@var{ptr})
7156 Define this macro to be C code that extracts filenames from the output
7157 of the program denoted by @code{LDD_SUFFIX}. @var{ptr} is a variable
7158 of type @code{char *} that points to the beginning of a line of output
7159 from @code{LDD_SUFFIX}. If the line lists a dynamic dependency, the
7160 code must advance @var{ptr} to the beginning of the filename on that
7161 line. Otherwise, it must set @var{ptr} to @code{NULL}.
7164 @node Instruction Output
7165 @subsection Output of Assembler Instructions
7167 @c prevent bad page break with this line
7168 This describes assembler instruction output.
7170 @defmac REGISTER_NAMES
7171 A C initializer containing the assembler's names for the machine
7172 registers, each one as a C string constant. This is what translates
7173 register numbers in the compiler into assembler language.
7176 @defmac ADDITIONAL_REGISTER_NAMES
7177 If defined, a C initializer for an array of structures containing a name
7178 and a register number. This macro defines additional names for hard
7179 registers, thus allowing the @code{asm} option in declarations to refer
7180 to registers using alternate names.
7183 @defmac ASM_OUTPUT_OPCODE (@var{stream}, @var{ptr})
7184 Define this macro if you are using an unusual assembler that
7185 requires different names for the machine instructions.
7187 The definition is a C statement or statements which output an
7188 assembler instruction opcode to the stdio stream @var{stream}. The
7189 macro-operand @var{ptr} is a variable of type @code{char *} which
7190 points to the opcode name in its ``internal'' form---the form that is
7191 written in the machine description. The definition should output the
7192 opcode name to @var{stream}, performing any translation you desire, and
7193 increment the variable @var{ptr} to point at the end of the opcode
7194 so that it will not be output twice.
7196 In fact, your macro definition may process less than the entire opcode
7197 name, or more than the opcode name; but if you want to process text
7198 that includes @samp{%}-sequences to substitute operands, you must take
7199 care of the substitution yourself. Just be sure to increment
7200 @var{ptr} over whatever text should not be output normally.
7202 @findex recog_data.operand
7203 If you need to look at the operand values, they can be found as the
7204 elements of @code{recog_data.operand}.
7206 If the macro definition does nothing, the instruction is output
7210 @defmac FINAL_PRESCAN_INSN (@var{insn}, @var{opvec}, @var{noperands})
7211 If defined, a C statement to be executed just prior to the output of
7212 assembler code for @var{insn}, to modify the extracted operands so
7213 they will be output differently.
7215 Here the argument @var{opvec} is the vector containing the operands
7216 extracted from @var{insn}, and @var{noperands} is the number of
7217 elements of the vector which contain meaningful data for this insn.
7218 The contents of this vector are what will be used to convert the insn
7219 template into assembler code, so you can change the assembler output
7220 by changing the contents of the vector.
7222 This macro is useful when various assembler syntaxes share a single
7223 file of instruction patterns; by defining this macro differently, you
7224 can cause a large class of instructions to be output differently (such
7225 as with rearranged operands). Naturally, variations in assembler
7226 syntax affecting individual insn patterns ought to be handled by
7227 writing conditional output routines in those patterns.
7229 If this macro is not defined, it is equivalent to a null statement.
7232 @defmac FINAL_PRESCAN_LABEL
7233 If defined, @code{FINAL_PRESCAN_INSN} will be called on each
7234 @code{CODE_LABEL}. In that case, @var{opvec} will be a null pointer and
7235 @var{noperands} will be zero.
7238 @defmac PRINT_OPERAND (@var{stream}, @var{x}, @var{code})
7239 A C compound statement to output to stdio stream @var{stream} the
7240 assembler syntax for an instruction operand @var{x}. @var{x} is an
7243 @var{code} is a value that can be used to specify one of several ways
7244 of printing the operand. It is used when identical operands must be
7245 printed differently depending on the context. @var{code} comes from
7246 the @samp{%} specification that was used to request printing of the
7247 operand. If the specification was just @samp{%@var{digit}} then
7248 @var{code} is 0; if the specification was @samp{%@var{ltr}
7249 @var{digit}} then @var{code} is the ASCII code for @var{ltr}.
7252 If @var{x} is a register, this macro should print the register's name.
7253 The names can be found in an array @code{reg_names} whose type is
7254 @code{char *[]}. @code{reg_names} is initialized from
7255 @code{REGISTER_NAMES}.
7257 When the machine description has a specification @samp{%@var{punct}}
7258 (a @samp{%} followed by a punctuation character), this macro is called
7259 with a null pointer for @var{x} and the punctuation character for
7263 @defmac PRINT_OPERAND_PUNCT_VALID_P (@var{code})
7264 A C expression which evaluates to true if @var{code} is a valid
7265 punctuation character for use in the @code{PRINT_OPERAND} macro. If
7266 @code{PRINT_OPERAND_PUNCT_VALID_P} is not defined, it means that no
7267 punctuation characters (except for the standard one, @samp{%}) are used
7271 @defmac PRINT_OPERAND_ADDRESS (@var{stream}, @var{x})
7272 A C compound statement to output to stdio stream @var{stream} the
7273 assembler syntax for an instruction operand that is a memory reference
7274 whose address is @var{x}. @var{x} is an RTL expression.
7276 @cindex @code{TARGET_ENCODE_SECTION_INFO} usage
7277 On some machines, the syntax for a symbolic address depends on the
7278 section that the address refers to. On these machines, define the hook
7279 @code{TARGET_ENCODE_SECTION_INFO} to store the information into the
7280 @code{symbol_ref}, and then check for it here. @xref{Assembler
7284 @findex dbr_sequence_length
7285 @defmac DBR_OUTPUT_SEQEND (@var{file})
7286 A C statement, to be executed after all slot-filler instructions have
7287 been output. If necessary, call @code{dbr_sequence_length} to
7288 determine the number of slots filled in a sequence (zero if not
7289 currently outputting a sequence), to decide how many no-ops to output,
7292 Don't define this macro if it has nothing to do, but it is helpful in
7293 reading assembly output if the extent of the delay sequence is made
7294 explicit (e.g.@: with white space).
7297 @findex final_sequence
7298 Note that output routines for instructions with delay slots must be
7299 prepared to deal with not being output as part of a sequence
7300 (i.e.@: when the scheduling pass is not run, or when no slot fillers could be
7301 found.) The variable @code{final_sequence} is null when not
7302 processing a sequence, otherwise it contains the @code{sequence} rtx
7306 @defmac REGISTER_PREFIX
7307 @defmacx LOCAL_LABEL_PREFIX
7308 @defmacx USER_LABEL_PREFIX
7309 @defmacx IMMEDIATE_PREFIX
7310 If defined, C string expressions to be used for the @samp{%R}, @samp{%L},
7311 @samp{%U}, and @samp{%I} options of @code{asm_fprintf} (see
7312 @file{final.c}). These are useful when a single @file{md} file must
7313 support multiple assembler formats. In that case, the various @file{tm.h}
7314 files can define these macros differently.
7317 @defmac ASM_FPRINTF_EXTENSIONS (@var{file}, @var{argptr}, @var{format})
7318 If defined this macro should expand to a series of @code{case}
7319 statements which will be parsed inside the @code{switch} statement of
7320 the @code{asm_fprintf} function. This allows targets to define extra
7321 printf formats which may useful when generating their assembler
7322 statements. Note that upper case letters are reserved for future
7323 generic extensions to asm_fprintf, and so are not available to target
7324 specific code. The output file is given by the parameter @var{file}.
7325 The varargs input pointer is @var{argptr} and the rest of the format
7326 string, starting the character after the one that is being switched
7327 upon, is pointed to by @var{format}.
7330 @defmac ASSEMBLER_DIALECT
7331 If your target supports multiple dialects of assembler language (such as
7332 different opcodes), define this macro as a C expression that gives the
7333 numeric index of the assembler language dialect to use, with zero as the
7336 If this macro is defined, you may use constructs of the form
7338 @samp{@{option0|option1|option2@dots{}@}}
7341 in the output templates of patterns (@pxref{Output Template}) or in the
7342 first argument of @code{asm_fprintf}. This construct outputs
7343 @samp{option0}, @samp{option1}, @samp{option2}, etc., if the value of
7344 @code{ASSEMBLER_DIALECT} is zero, one, two, etc. Any special characters
7345 within these strings retain their usual meaning. If there are fewer
7346 alternatives within the braces than the value of
7347 @code{ASSEMBLER_DIALECT}, the construct outputs nothing.
7349 If you do not define this macro, the characters @samp{@{}, @samp{|} and
7350 @samp{@}} do not have any special meaning when used in templates or
7351 operands to @code{asm_fprintf}.
7353 Define the macros @code{REGISTER_PREFIX}, @code{LOCAL_LABEL_PREFIX},
7354 @code{USER_LABEL_PREFIX} and @code{IMMEDIATE_PREFIX} if you can express
7355 the variations in assembler language syntax with that mechanism. Define
7356 @code{ASSEMBLER_DIALECT} and use the @samp{@{option0|option1@}} syntax
7357 if the syntax variant are larger and involve such things as different
7358 opcodes or operand order.
7361 @defmac ASM_OUTPUT_REG_PUSH (@var{stream}, @var{regno})
7362 A C expression to output to @var{stream} some assembler code
7363 which will push hard register number @var{regno} onto the stack.
7364 The code need not be optimal, since this macro is used only when
7368 @defmac ASM_OUTPUT_REG_POP (@var{stream}, @var{regno})
7369 A C expression to output to @var{stream} some assembler code
7370 which will pop hard register number @var{regno} off of the stack.
7371 The code need not be optimal, since this macro is used only when
7375 @node Dispatch Tables
7376 @subsection Output of Dispatch Tables
7378 @c prevent bad page break with this line
7379 This concerns dispatch tables.
7381 @cindex dispatch table
7382 @defmac ASM_OUTPUT_ADDR_DIFF_ELT (@var{stream}, @var{body}, @var{value}, @var{rel})
7383 A C statement to output to the stdio stream @var{stream} an assembler
7384 pseudo-instruction to generate a difference between two labels.
7385 @var{value} and @var{rel} are the numbers of two internal labels. The
7386 definitions of these labels are output using
7387 @code{(*targetm.asm_out.internal_label)}, and they must be printed in the same
7388 way here. For example,
7391 fprintf (@var{stream}, "\t.word L%d-L%d\n",
7392 @var{value}, @var{rel})
7395 You must provide this macro on machines where the addresses in a
7396 dispatch table are relative to the table's own address. If defined, GCC
7397 will also use this macro on all machines when producing PIC@.
7398 @var{body} is the body of the @code{ADDR_DIFF_VEC}; it is provided so that the
7399 mode and flags can be read.
7402 @defmac ASM_OUTPUT_ADDR_VEC_ELT (@var{stream}, @var{value})
7403 This macro should be provided on machines where the addresses
7404 in a dispatch table are absolute.
7406 The definition should be a C statement to output to the stdio stream
7407 @var{stream} an assembler pseudo-instruction to generate a reference to
7408 a label. @var{value} is the number of an internal label whose
7409 definition is output using @code{(*targetm.asm_out.internal_label)}.
7413 fprintf (@var{stream}, "\t.word L%d\n", @var{value})
7417 @defmac ASM_OUTPUT_CASE_LABEL (@var{stream}, @var{prefix}, @var{num}, @var{table})
7418 Define this if the label before a jump-table needs to be output
7419 specially. The first three arguments are the same as for
7420 @code{(*targetm.asm_out.internal_label)}; the fourth argument is the
7421 jump-table which follows (a @code{jump_insn} containing an
7422 @code{addr_vec} or @code{addr_diff_vec}).
7424 This feature is used on system V to output a @code{swbeg} statement
7427 If this macro is not defined, these labels are output with
7428 @code{(*targetm.asm_out.internal_label)}.
7431 @defmac ASM_OUTPUT_CASE_END (@var{stream}, @var{num}, @var{table})
7432 Define this if something special must be output at the end of a
7433 jump-table. The definition should be a C statement to be executed
7434 after the assembler code for the table is written. It should write
7435 the appropriate code to stdio stream @var{stream}. The argument
7436 @var{table} is the jump-table insn, and @var{num} is the label-number
7437 of the preceding label.
7439 If this macro is not defined, nothing special is output at the end of
7443 @node Exception Region Output
7444 @subsection Assembler Commands for Exception Regions
7446 @c prevent bad page break with this line
7448 This describes commands marking the start and the end of an exception
7451 @defmac EH_FRAME_SECTION_NAME
7452 If defined, a C string constant for the name of the section containing
7453 exception handling frame unwind information. If not defined, GCC will
7454 provide a default definition if the target supports named sections.
7455 @file{crtstuff.c} uses this macro to switch to the appropriate section.
7457 You should define this symbol if your target supports DWARF 2 frame
7458 unwind information and the default definition does not work.
7461 @defmac EH_FRAME_IN_DATA_SECTION
7462 If defined, DWARF 2 frame unwind information will be placed in the
7463 data section even though the target supports named sections. This
7464 might be necessary, for instance, if the system linker does garbage
7465 collection and sections cannot be marked as not to be collected.
7467 Do not define this macro unless @code{TARGET_ASM_NAMED_SECTION} is
7471 @defmac MASK_RETURN_ADDR
7472 An rtx used to mask the return address found via @code{RETURN_ADDR_RTX}, so
7473 that it does not contain any extraneous set bits in it.
7476 @defmac DWARF2_UNWIND_INFO
7477 Define this macro to 0 if your target supports DWARF 2 frame unwind
7478 information, but it does not yet work with exception handling.
7479 Otherwise, if your target supports this information (if it defines
7480 @samp{INCOMING_RETURN_ADDR_RTX} and either @samp{UNALIGNED_INT_ASM_OP}
7481 or @samp{OBJECT_FORMAT_ELF}), GCC will provide a default definition of
7484 If this macro is defined to 1, the DWARF 2 unwinder will be the default
7485 exception handling mechanism; otherwise, @code{setjmp}/@code{longjmp} will be used by
7488 If this macro is defined to anything, the DWARF 2 unwinder will be used
7489 instead of inline unwinders and @code{__unwind_function} in the non-@code{setjmp} case.
7492 @defmac DWARF_CIE_DATA_ALIGNMENT
7493 This macro need only be defined if the target might save registers in the
7494 function prologue at an offset to the stack pointer that is not aligned to
7495 @code{UNITS_PER_WORD}. The definition should be the negative minimum
7496 alignment if @code{STACK_GROWS_DOWNWARD} is defined, and the positive
7497 minimum alignment otherwise. @xref{SDB and DWARF}. Only applicable if
7498 the target supports DWARF 2 frame unwind information.
7501 @deftypefn {Target Hook} void TARGET_ASM_EXCEPTION_SECTION ()
7502 If defined, a function that switches to the section in which the main
7503 exception table is to be placed (@pxref{Sections}). The default is a
7504 function that switches to a section named @code{.gcc_except_table} on
7505 machines that support named sections via
7506 @code{TARGET_ASM_NAMED_SECTION}, otherwise if @option{-fpic} or
7507 @option{-fPIC} is in effect, the @code{data_section}, otherwise the
7508 @code{readonly_data_section}.
7511 @deftypefn {Target Hook} void TARGET_ASM_EH_FRAME_SECTION ()
7512 If defined, a function that switches to the section in which the DWARF 2
7513 frame unwind information to be placed (@pxref{Sections}). The default
7514 is a function that outputs a standard GAS section directive, if
7515 @code{EH_FRAME_SECTION_NAME} is defined, or else a data section
7516 directive followed by a synthetic label.
7519 @deftypevar {Target Hook} bool TARGET_TERMINATE_DW2_EH_FRAME_INFO
7520 Contains the value true if the target should add a zero word onto the
7521 end of a Dwarf-2 frame info section when used for exception handling.
7522 Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and
7526 @deftypefn {Target Hook} rtx TARGET_DWARF_REGISTER_SPAN (rtx @var{reg})
7527 Given a register, this hook should return a parallel of registers to
7528 represent where to find the register pieces. Define this hook if the
7529 register and its mode are represented in Dwarf in non-contiguous
7530 locations, or if the register should be represented in more than one
7531 register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.
7532 If not defined, the default is to return @code{NULL_RTX}.
7535 @node Alignment Output
7536 @subsection Assembler Commands for Alignment
7538 @c prevent bad page break with this line
7539 This describes commands for alignment.
7541 @defmac JUMP_ALIGN (@var{label})
7542 The alignment (log base 2) to put in front of @var{label}, which is
7543 a common destination of jumps and has no fallthru incoming edge.
7545 This macro need not be defined if you don't want any special alignment
7546 to be done at such a time. Most machine descriptions do not currently
7549 Unless it's necessary to inspect the @var{label} parameter, it is better
7550 to set the variable @var{align_jumps} in the target's
7551 @code{OVERRIDE_OPTIONS}. Otherwise, you should try to honor the user's
7552 selection in @var{align_jumps} in a @code{JUMP_ALIGN} implementation.
7555 @defmac LABEL_ALIGN_AFTER_BARRIER (@var{label})
7556 The alignment (log base 2) to put in front of @var{label}, which follows
7559 This macro need not be defined if you don't want any special alignment
7560 to be done at such a time. Most machine descriptions do not currently
7564 @defmac LABEL_ALIGN_AFTER_BARRIER_MAX_SKIP
7565 The maximum number of bytes to skip when applying
7566 @code{LABEL_ALIGN_AFTER_BARRIER}. This works only if
7567 @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.
7570 @defmac LOOP_ALIGN (@var{label})
7571 The alignment (log base 2) to put in front of @var{label}, which follows
7572 a @code{NOTE_INSN_LOOP_BEG} note.
7574 This macro need not be defined if you don't want any special alignment
7575 to be done at such a time. Most machine descriptions do not currently
7578 Unless it's necessary to inspect the @var{label} parameter, it is better
7579 to set the variable @code{align_loops} in the target's
7580 @code{OVERRIDE_OPTIONS}. Otherwise, you should try to honor the user's
7581 selection in @code{align_loops} in a @code{LOOP_ALIGN} implementation.
7584 @defmac LOOP_ALIGN_MAX_SKIP
7585 The maximum number of bytes to skip when applying @code{LOOP_ALIGN}.
7586 This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.
7589 @defmac LABEL_ALIGN (@var{label})
7590 The alignment (log base 2) to put in front of @var{label}.
7591 If @code{LABEL_ALIGN_AFTER_BARRIER} / @code{LOOP_ALIGN} specify a different alignment,
7592 the maximum of the specified values is used.
7594 Unless it's necessary to inspect the @var{label} parameter, it is better
7595 to set the variable @code{align_labels} in the target's
7596 @code{OVERRIDE_OPTIONS}. Otherwise, you should try to honor the user's
7597 selection in @code{align_labels} in a @code{LABEL_ALIGN} implementation.
7600 @defmac LABEL_ALIGN_MAX_SKIP
7601 The maximum number of bytes to skip when applying @code{LABEL_ALIGN}.
7602 This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.
7605 @defmac ASM_OUTPUT_SKIP (@var{stream}, @var{nbytes})
7606 A C statement to output to the stdio stream @var{stream} an assembler
7607 instruction to advance the location counter by @var{nbytes} bytes.
7608 Those bytes should be zero when loaded. @var{nbytes} will be a C
7609 expression of type @code{int}.
7612 @defmac ASM_NO_SKIP_IN_TEXT
7613 Define this macro if @code{ASM_OUTPUT_SKIP} should not be used in the
7614 text section because it fails to put zeros in the bytes that are skipped.
7615 This is true on many Unix systems, where the pseudo--op to skip bytes
7616 produces no-op instructions rather than zeros when used in the text
7620 @defmac ASM_OUTPUT_ALIGN (@var{stream}, @var{power})
7621 A C statement to output to the stdio stream @var{stream} an assembler
7622 command to advance the location counter to a multiple of 2 to the
7623 @var{power} bytes. @var{power} will be a C expression of type @code{int}.
7626 @defmac ASM_OUTPUT_ALIGN_WITH_NOP (@var{stream}, @var{power})
7627 Like @code{ASM_OUTPUT_ALIGN}, except that the ``nop'' instruction is used
7628 for padding, if necessary.
7631 @defmac ASM_OUTPUT_MAX_SKIP_ALIGN (@var{stream}, @var{power}, @var{max_skip})
7632 A C statement to output to the stdio stream @var{stream} an assembler
7633 command to advance the location counter to a multiple of 2 to the
7634 @var{power} bytes, but only if @var{max_skip} or fewer bytes are needed to
7635 satisfy the alignment request. @var{power} and @var{max_skip} will be
7636 a C expression of type @code{int}.
7640 @node Debugging Info
7641 @section Controlling Debugging Information Format
7643 @c prevent bad page break with this line
7644 This describes how to specify debugging information.
7647 * All Debuggers:: Macros that affect all debugging formats uniformly.
7648 * DBX Options:: Macros enabling specific options in DBX format.
7649 * DBX Hooks:: Hook macros for varying DBX format.
7650 * File Names and DBX:: Macros controlling output of file names in DBX format.
7651 * SDB and DWARF:: Macros for SDB (COFF) and DWARF formats.
7652 * VMS Debug:: Macros for VMS debug format.
7656 @subsection Macros Affecting All Debugging Formats
7658 @c prevent bad page break with this line
7659 These macros affect all debugging formats.
7661 @defmac DBX_REGISTER_NUMBER (@var{regno})
7662 A C expression that returns the DBX register number for the compiler
7663 register number @var{regno}. In the default macro provided, the value
7664 of this expression will be @var{regno} itself. But sometimes there are
7665 some registers that the compiler knows about and DBX does not, or vice
7666 versa. In such cases, some register may need to have one number in the
7667 compiler and another for DBX@.
7669 If two registers have consecutive numbers inside GCC, and they can be
7670 used as a pair to hold a multiword value, then they @emph{must} have
7671 consecutive numbers after renumbering with @code{DBX_REGISTER_NUMBER}.
7672 Otherwise, debuggers will be unable to access such a pair, because they
7673 expect register pairs to be consecutive in their own numbering scheme.
7675 If you find yourself defining @code{DBX_REGISTER_NUMBER} in way that
7676 does not preserve register pairs, then what you must do instead is
7677 redefine the actual register numbering scheme.
7680 @defmac DEBUGGER_AUTO_OFFSET (@var{x})
7681 A C expression that returns the integer offset value for an automatic
7682 variable having address @var{x} (an RTL expression). The default
7683 computation assumes that @var{x} is based on the frame-pointer and
7684 gives the offset from the frame-pointer. This is required for targets
7685 that produce debugging output for DBX or COFF-style debugging output
7686 for SDB and allow the frame-pointer to be eliminated when the
7687 @option{-g} options is used.
7690 @defmac DEBUGGER_ARG_OFFSET (@var{offset}, @var{x})
7691 A C expression that returns the integer offset value for an argument
7692 having address @var{x} (an RTL expression). The nominal offset is
7696 @defmac PREFERRED_DEBUGGING_TYPE
7697 A C expression that returns the type of debugging output GCC should
7698 produce when the user specifies just @option{-g}. Define
7699 this if you have arranged for GCC to support more than one format of
7700 debugging output. Currently, the allowable values are @code{DBX_DEBUG},
7701 @code{SDB_DEBUG}, @code{DWARF_DEBUG}, @code{DWARF2_DEBUG},
7702 @code{XCOFF_DEBUG}, @code{VMS_DEBUG}, and @code{VMS_AND_DWARF2_DEBUG}.
7704 When the user specifies @option{-ggdb}, GCC normally also uses the
7705 value of this macro to select the debugging output format, but with two
7706 exceptions. If @code{DWARF2_DEBUGGING_INFO} is defined and
7707 @code{LINKER_DOES_NOT_WORK_WITH_DWARF2} is not defined, GCC uses the
7708 value @code{DWARF2_DEBUG}. Otherwise, if @code{DBX_DEBUGGING_INFO} is
7709 defined, GCC uses @code{DBX_DEBUG}.
7711 The value of this macro only affects the default debugging output; the
7712 user can always get a specific type of output by using @option{-gstabs},
7713 @option{-gcoff}, @option{-gdwarf-1}, @option{-gdwarf-2}, @option{-gxcoff},
7718 @subsection Specific Options for DBX Output
7720 @c prevent bad page break with this line
7721 These are specific options for DBX output.
7723 @defmac DBX_DEBUGGING_INFO
7724 Define this macro if GCC should produce debugging output for DBX
7725 in response to the @option{-g} option.
7728 @defmac XCOFF_DEBUGGING_INFO
7729 Define this macro if GCC should produce XCOFF format debugging output
7730 in response to the @option{-g} option. This is a variant of DBX format.
7733 @defmac DEFAULT_GDB_EXTENSIONS
7734 Define this macro to control whether GCC should by default generate
7735 GDB's extended version of DBX debugging information (assuming DBX-format
7736 debugging information is enabled at all). If you don't define the
7737 macro, the default is 1: always generate the extended information
7738 if there is any occasion to.
7741 @defmac DEBUG_SYMS_TEXT
7742 Define this macro if all @code{.stabs} commands should be output while
7743 in the text section.
7746 @defmac ASM_STABS_OP
7747 A C string constant, including spacing, naming the assembler pseudo op to
7748 use instead of @code{"\t.stabs\t"} to define an ordinary debugging symbol.
7749 If you don't define this macro, @code{"\t.stabs\t"} is used. This macro
7750 applies only to DBX debugging information format.
7753 @defmac ASM_STABD_OP
7754 A C string constant, including spacing, naming the assembler pseudo op to
7755 use instead of @code{"\t.stabd\t"} to define a debugging symbol whose
7756 value is the current location. If you don't define this macro,
7757 @code{"\t.stabd\t"} is used. This macro applies only to DBX debugging
7761 @defmac ASM_STABN_OP
7762 A C string constant, including spacing, naming the assembler pseudo op to
7763 use instead of @code{"\t.stabn\t"} to define a debugging symbol with no
7764 name. If you don't define this macro, @code{"\t.stabn\t"} is used. This
7765 macro applies only to DBX debugging information format.
7768 @defmac DBX_NO_XREFS
7769 Define this macro if DBX on your system does not support the construct
7770 @samp{xs@var{tagname}}. On some systems, this construct is used to
7771 describe a forward reference to a structure named @var{tagname}.
7772 On other systems, this construct is not supported at all.
7775 @defmac DBX_CONTIN_LENGTH
7776 A symbol name in DBX-format debugging information is normally
7777 continued (split into two separate @code{.stabs} directives) when it
7778 exceeds a certain length (by default, 80 characters). On some
7779 operating systems, DBX requires this splitting; on others, splitting
7780 must not be done. You can inhibit splitting by defining this macro
7781 with the value zero. You can override the default splitting-length by
7782 defining this macro as an expression for the length you desire.
7785 @defmac DBX_CONTIN_CHAR
7786 Normally continuation is indicated by adding a @samp{\} character to
7787 the end of a @code{.stabs} string when a continuation follows. To use
7788 a different character instead, define this macro as a character
7789 constant for the character you want to use. Do not define this macro
7790 if backslash is correct for your system.
7793 @defmac DBX_STATIC_STAB_DATA_SECTION
7794 Define this macro if it is necessary to go to the data section before
7795 outputting the @samp{.stabs} pseudo-op for a non-global static
7799 @defmac DBX_TYPE_DECL_STABS_CODE
7800 The value to use in the ``code'' field of the @code{.stabs} directive
7801 for a typedef. The default is @code{N_LSYM}.
7804 @defmac DBX_STATIC_CONST_VAR_CODE
7805 The value to use in the ``code'' field of the @code{.stabs} directive
7806 for a static variable located in the text section. DBX format does not
7807 provide any ``right'' way to do this. The default is @code{N_FUN}.
7810 @defmac DBX_REGPARM_STABS_CODE
7811 The value to use in the ``code'' field of the @code{.stabs} directive
7812 for a parameter passed in registers. DBX format does not provide any
7813 ``right'' way to do this. The default is @code{N_RSYM}.
7816 @defmac DBX_REGPARM_STABS_LETTER
7817 The letter to use in DBX symbol data to identify a symbol as a parameter
7818 passed in registers. DBX format does not customarily provide any way to
7819 do this. The default is @code{'P'}.
7822 @defmac DBX_MEMPARM_STABS_LETTER
7823 The letter to use in DBX symbol data to identify a symbol as a stack
7824 parameter. The default is @code{'p'}.
7827 @defmac DBX_FUNCTION_FIRST
7828 Define this macro if the DBX information for a function and its
7829 arguments should precede the assembler code for the function. Normally,
7830 in DBX format, the debugging information entirely follows the assembler
7834 @defmac DBX_BLOCKS_FUNCTION_RELATIVE
7835 Define this macro if the value of a symbol describing the scope of a
7836 block (@code{N_LBRAC} or @code{N_RBRAC}) should be relative to the start
7837 of the enclosing function. Normally, GCC uses an absolute address.
7840 @defmac DBX_USE_BINCL
7841 Define this macro if GCC should generate @code{N_BINCL} and
7842 @code{N_EINCL} stabs for included header files, as on Sun systems. This
7843 macro also directs GCC to output a type number as a pair of a file
7844 number and a type number within the file. Normally, GCC does not
7845 generate @code{N_BINCL} or @code{N_EINCL} stabs, and it outputs a single
7846 number for a type number.
7850 @subsection Open-Ended Hooks for DBX Format
7852 @c prevent bad page break with this line
7853 These are hooks for DBX format.
7855 @defmac DBX_OUTPUT_LBRAC (@var{stream}, @var{name})
7856 Define this macro to say how to output to @var{stream} the debugging
7857 information for the start of a scope level for variable names. The
7858 argument @var{name} is the name of an assembler symbol (for use with
7859 @code{assemble_name}) whose value is the address where the scope begins.
7862 @defmac DBX_OUTPUT_RBRAC (@var{stream}, @var{name})
7863 Like @code{DBX_OUTPUT_LBRAC}, but for the end of a scope level.
7866 @defmac DBX_OUTPUT_NFUN (@var{stream}, @var{lscope_label}, @var{decl})
7867 Define this macro if the target machine requires special handling to
7868 output an @code{N_FUN} entry for the function @var{decl}.
7871 @defmac DBX_OUTPUT_FUNCTION_END (@var{stream}, @var{function})
7872 Define this macro if the target machine requires special output at the
7873 end of the debugging information for a function. The definition should
7874 be a C statement (sans semicolon) to output the appropriate information
7875 to @var{stream}. @var{function} is the @code{FUNCTION_DECL} node for
7879 @defmac DBX_OUTPUT_STANDARD_TYPES (@var{syms})
7880 Define this macro if you need to control the order of output of the
7881 standard data types at the beginning of compilation. The argument
7882 @var{syms} is a @code{tree} which is a chain of all the predefined
7883 global symbols, including names of data types.
7885 Normally, DBX output starts with definitions of the types for integers
7886 and characters, followed by all the other predefined types of the
7887 particular language in no particular order.
7889 On some machines, it is necessary to output different particular types
7890 first. To do this, define @code{DBX_OUTPUT_STANDARD_TYPES} to output
7891 those symbols in the necessary order. Any predefined types that you
7892 don't explicitly output will be output afterward in no particular order.
7894 Be careful not to define this macro so that it works only for C@. There
7895 are no global variables to access most of the built-in types, because
7896 another language may have another set of types. The way to output a
7897 particular type is to look through @var{syms} to see if you can find it.
7903 for (decl = syms; decl; decl = TREE_CHAIN (decl))
7904 if (!strcmp (IDENTIFIER_POINTER (DECL_NAME (decl)),
7906 dbxout_symbol (decl);
7912 This does nothing if the expected type does not exist.
7914 See the function @code{init_decl_processing} in @file{c-decl.c} to find
7915 the names to use for all the built-in C types.
7917 Here is another way of finding a particular type:
7919 @c this is still overfull. --mew 10feb93
7923 for (decl = syms; decl; decl = TREE_CHAIN (decl))
7924 if (TREE_CODE (decl) == TYPE_DECL
7925 && (TREE_CODE (TREE_TYPE (decl))
7927 && TYPE_PRECISION (TREE_TYPE (decl)) == 16
7928 && TYPE_UNSIGNED (TREE_TYPE (decl)))
7930 /* @r{This must be @code{unsigned short}.} */
7931 dbxout_symbol (decl);
7938 @defmac NO_DBX_FUNCTION_END
7939 Some stabs encapsulation formats (in particular ECOFF), cannot handle the
7940 @code{.stabs "",N_FUN,,0,0,Lscope-function-1} gdb dbx extension construct.
7941 On those machines, define this macro to turn this feature off without
7942 disturbing the rest of the gdb extensions.
7945 @node File Names and DBX
7946 @subsection File Names in DBX Format
7948 @c prevent bad page break with this line
7949 This describes file names in DBX format.
7951 @defmac DBX_OUTPUT_MAIN_SOURCE_FILENAME (@var{stream}, @var{name})
7952 A C statement to output DBX debugging information to the stdio stream
7953 @var{stream} which indicates that file @var{name} is the main source
7954 file---the file specified as the input file for compilation.
7955 This macro is called only once, at the beginning of compilation.
7957 This macro need not be defined if the standard form of output
7958 for DBX debugging information is appropriate.
7961 @defmac DBX_OUTPUT_MAIN_SOURCE_DIRECTORY (@var{stream}, @var{name})
7962 A C statement to output DBX debugging information to the stdio stream
7963 @var{stream} which indicates that the current directory during
7964 compilation is named @var{name}.
7966 This macro need not be defined if the standard form of output
7967 for DBX debugging information is appropriate.
7970 @defmac DBX_OUTPUT_MAIN_SOURCE_FILE_END (@var{stream}, @var{name})
7971 A C statement to output DBX debugging information at the end of
7972 compilation of the main source file @var{name}.
7974 If you don't define this macro, nothing special is output at the end
7975 of compilation, which is correct for most machines.
7980 @subsection Macros for SDB and DWARF Output
7982 @c prevent bad page break with this line
7983 Here are macros for SDB and DWARF output.
7985 @defmac SDB_DEBUGGING_INFO
7986 Define this macro if GCC should produce COFF-style debugging output
7987 for SDB in response to the @option{-g} option.
7990 @defmac DWARF_DEBUGGING_INFO
7991 Define this macro if GCC should produce dwarf format debugging output
7992 in response to the @option{-g} option.
7995 @defmac DWARF2_DEBUGGING_INFO
7996 Define this macro if GCC should produce dwarf version 2 format
7997 debugging output in response to the @option{-g} option.
7999 To support optional call frame debugging information, you must also
8000 define @code{INCOMING_RETURN_ADDR_RTX} and either set
8001 @code{RTX_FRAME_RELATED_P} on the prologue insns if you use RTL for the
8002 prologue, or call @code{dwarf2out_def_cfa} and @code{dwarf2out_reg_save}
8003 as appropriate from @code{TARGET_ASM_FUNCTION_PROLOGUE} if you don't.
8006 @defmac DWARF2_FRAME_INFO
8007 Define this macro to a nonzero value if GCC should always output
8008 Dwarf 2 frame information. If @code{DWARF2_UNWIND_INFO}
8009 (@pxref{Exception Region Output} is nonzero, GCC will output this
8010 information not matter how you define @code{DWARF2_FRAME_INFO}.
8013 @defmac LINKER_DOES_NOT_WORK_WITH_DWARF2
8014 Define this macro if the linker does not work with Dwarf version 2.
8015 Normally, if the user specifies only @option{-ggdb} GCC will use Dwarf
8016 version 2 if available; this macro disables this. See the description
8017 of the @code{PREFERRED_DEBUGGING_TYPE} macro for more details.
8020 @defmac DWARF2_GENERATE_TEXT_SECTION_LABEL
8021 By default, the Dwarf 2 debugging information generator will generate a
8022 label to mark the beginning of the text section. If it is better simply
8023 to use the name of the text section itself, rather than an explicit label,
8024 to indicate the beginning of the text section, define this macro to zero.
8027 @defmac DWARF2_ASM_LINE_DEBUG_INFO
8028 Define this macro to be a nonzero value if the assembler can generate Dwarf 2
8029 line debug info sections. This will result in much more compact line number
8030 tables, and hence is desirable if it works.
8033 @defmac ASM_OUTPUT_DWARF_DELTA (@var{stream}, @var{size}, @var{label1}, @var{label2})
8034 A C statement to issue assembly directives that create a difference
8035 between the two given labels, using an integer of the given size.
8038 @defmac ASM_OUTPUT_DWARF_OFFSET (@var{stream}, @var{size}, @var{label})
8039 A C statement to issue assembly directives that create a
8040 section-relative reference to the given label, using an integer of the
8044 @defmac ASM_OUTPUT_DWARF_PCREL (@var{stream}, @var{size}, @var{label})
8045 A C statement to issue assembly directives that create a self-relative
8046 reference to the given label, using an integer of the given size.
8049 @defmac PUT_SDB_@dots{}
8050 Define these macros to override the assembler syntax for the special
8051 SDB assembler directives. See @file{sdbout.c} for a list of these
8052 macros and their arguments. If the standard syntax is used, you need
8053 not define them yourself.
8057 Some assemblers do not support a semicolon as a delimiter, even between
8058 SDB assembler directives. In that case, define this macro to be the
8059 delimiter to use (usually @samp{\n}). It is not necessary to define
8060 a new set of @code{PUT_SDB_@var{op}} macros if this is the only change
8064 @defmac SDB_GENERATE_FAKE
8065 Define this macro to override the usual method of constructing a dummy
8066 name for anonymous structure and union types. See @file{sdbout.c} for
8070 @defmac SDB_ALLOW_UNKNOWN_REFERENCES
8071 Define this macro to allow references to unknown structure,
8072 union, or enumeration tags to be emitted. Standard COFF does not
8073 allow handling of unknown references, MIPS ECOFF has support for
8077 @defmac SDB_ALLOW_FORWARD_REFERENCES
8078 Define this macro to allow references to structure, union, or
8079 enumeration tags that have not yet been seen to be handled. Some
8080 assemblers choke if forward tags are used, while some require it.
8085 @subsection Macros for VMS Debug Format
8087 @c prevent bad page break with this line
8088 Here are macros for VMS debug format.
8090 @defmac VMS_DEBUGGING_INFO
8091 Define this macro if GCC should produce debugging output for VMS
8092 in response to the @option{-g} option. The default behavior for VMS
8093 is to generate minimal debug info for a traceback in the absence of
8094 @option{-g} unless explicitly overridden with @option{-g0}. This
8095 behavior is controlled by @code{OPTIMIZATION_OPTIONS} and
8096 @code{OVERRIDE_OPTIONS}.
8099 @node Floating Point
8100 @section Cross Compilation and Floating Point
8101 @cindex cross compilation and floating point
8102 @cindex floating point and cross compilation
8104 While all modern machines use twos-complement representation for integers,
8105 there are a variety of representations for floating point numbers. This
8106 means that in a cross-compiler the representation of floating point numbers
8107 in the compiled program may be different from that used in the machine
8108 doing the compilation.
8110 Because different representation systems may offer different amounts of
8111 range and precision, all floating point constants must be represented in
8112 the target machine's format. Therefore, the cross compiler cannot
8113 safely use the host machine's floating point arithmetic; it must emulate
8114 the target's arithmetic. To ensure consistency, GCC always uses
8115 emulation to work with floating point values, even when the host and
8116 target floating point formats are identical.
8118 The following macros are provided by @file{real.h} for the compiler to
8119 use. All parts of the compiler which generate or optimize
8120 floating-point calculations must use these macros. They may evaluate
8121 their operands more than once, so operands must not have side effects.
8123 @defmac REAL_VALUE_TYPE
8124 The C data type to be used to hold a floating point value in the target
8125 machine's format. Typically this is a @code{struct} containing an
8126 array of @code{HOST_WIDE_INT}, but all code should treat it as an opaque
8130 @deftypefn Macro int REAL_VALUES_EQUAL (REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y})
8131 Compares for equality the two values, @var{x} and @var{y}. If the target
8132 floating point format supports negative zeroes and/or NaNs,
8133 @samp{REAL_VALUES_EQUAL (-0.0, 0.0)} is true, and
8134 @samp{REAL_VALUES_EQUAL (NaN, NaN)} is false.
8137 @deftypefn Macro int REAL_VALUES_LESS (REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y})
8138 Tests whether @var{x} is less than @var{y}.
8141 @deftypefn Macro HOST_WIDE_INT REAL_VALUE_FIX (REAL_VALUE_TYPE @var{x})
8142 Truncates @var{x} to a signed integer, rounding toward zero.
8145 @deftypefn Macro {unsigned HOST_WIDE_INT} REAL_VALUE_UNSIGNED_FIX (REAL_VALUE_TYPE @var{x})
8146 Truncates @var{x} to an unsigned integer, rounding toward zero. If
8147 @var{x} is negative, returns zero.
8150 @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_ATOF (const char *@var{string}, enum machine_mode @var{mode})
8151 Converts @var{string} into a floating point number in the target machine's
8152 representation for mode @var{mode}. This routine can handle both
8153 decimal and hexadecimal floating point constants, using the syntax
8154 defined by the C language for both.
8157 @deftypefn Macro int REAL_VALUE_NEGATIVE (REAL_VALUE_TYPE @var{x})
8158 Returns 1 if @var{x} is negative (including negative zero), 0 otherwise.
8161 @deftypefn Macro int REAL_VALUE_ISINF (REAL_VALUE_TYPE @var{x})
8162 Determines whether @var{x} represents infinity (positive or negative).
8165 @deftypefn Macro int REAL_VALUE_ISNAN (REAL_VALUE_TYPE @var{x})
8166 Determines whether @var{x} represents a ``NaN'' (not-a-number).
8169 @deftypefn Macro void REAL_ARITHMETIC (REAL_VALUE_TYPE @var{output}, enum tree_code @var{code}, REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y})
8170 Calculates an arithmetic operation on the two floating point values
8171 @var{x} and @var{y}, storing the result in @var{output} (which must be a
8174 The operation to be performed is specified by @var{code}. Only the
8175 following codes are supported: @code{PLUS_EXPR}, @code{MINUS_EXPR},
8176 @code{MULT_EXPR}, @code{RDIV_EXPR}, @code{MAX_EXPR}, @code{MIN_EXPR}.
8178 If @code{REAL_ARITHMETIC} is asked to evaluate division by zero and the
8179 target's floating point format cannot represent infinity, it will call
8180 @code{abort}. Callers should check for this situation first, using
8181 @code{MODE_HAS_INFINITIES}. @xref{Storage Layout}.
8184 @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_NEGATE (REAL_VALUE_TYPE @var{x})
8185 Returns the negative of the floating point value @var{x}.
8188 @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_ABS (REAL_VALUE_TYPE @var{x})
8189 Returns the absolute value of @var{x}.
8192 @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_TRUNCATE (REAL_VALUE_TYPE @var{mode}, enum machine_mode @var{x})
8193 Truncates the floating point value @var{x} to fit in @var{mode}. The
8194 return value is still a full-size @code{REAL_VALUE_TYPE}, but it has an
8195 appropriate bit pattern to be output asa floating constant whose
8196 precision accords with mode @var{mode}.
8199 @deftypefn Macro void REAL_VALUE_TO_INT (HOST_WIDE_INT @var{low}, HOST_WIDE_INT @var{high}, REAL_VALUE_TYPE @var{x})
8200 Converts a floating point value @var{x} into a double-precision integer
8201 which is then stored into @var{low} and @var{high}. If the value is not
8202 integral, it is truncated.
8205 @deftypefn Macro void REAL_VALUE_FROM_INT (REAL_VALUE_TYPE @var{x}, HOST_WIDE_INT @var{low}, HOST_WIDE_INT @var{high}, enum machine_mode @var{mode})
8206 Converts a double-precision integer found in @var{low} and @var{high},
8207 into a floating point value which is then stored into @var{x}. The
8208 value is truncated to fit in mode @var{mode}.
8211 @node Mode Switching
8212 @section Mode Switching Instructions
8213 @cindex mode switching
8214 The following macros control mode switching optimizations:
8216 @defmac OPTIMIZE_MODE_SWITCHING (@var{entity})
8217 Define this macro if the port needs extra instructions inserted for mode
8218 switching in an optimizing compilation.
8220 For an example, the SH4 can perform both single and double precision
8221 floating point operations, but to perform a single precision operation,
8222 the FPSCR PR bit has to be cleared, while for a double precision
8223 operation, this bit has to be set. Changing the PR bit requires a general
8224 purpose register as a scratch register, hence these FPSCR sets have to
8225 be inserted before reload, i.e.@: you can't put this into instruction emitting
8226 or @code{TARGET_MACHINE_DEPENDENT_REORG}.
8228 You can have multiple entities that are mode-switched, and select at run time
8229 which entities actually need it. @code{OPTIMIZE_MODE_SWITCHING} should
8230 return nonzero for any @var{entity} that needs mode-switching.
8231 If you define this macro, you also have to define
8232 @code{NUM_MODES_FOR_MODE_SWITCHING}, @code{MODE_NEEDED},
8233 @code{MODE_PRIORITY_TO_MODE} and @code{EMIT_MODE_SET}.
8234 @code{NORMAL_MODE} is optional.
8237 @defmac NUM_MODES_FOR_MODE_SWITCHING
8238 If you define @code{OPTIMIZE_MODE_SWITCHING}, you have to define this as
8239 initializer for an array of integers. Each initializer element
8240 N refers to an entity that needs mode switching, and specifies the number
8241 of different modes that might need to be set for this entity.
8242 The position of the initializer in the initializer - starting counting at
8243 zero - determines the integer that is used to refer to the mode-switched
8245 In macros that take mode arguments / yield a mode result, modes are
8246 represented as numbers 0 @dots{} N @minus{} 1. N is used to specify that no mode
8247 switch is needed / supplied.
8250 @defmac MODE_NEEDED (@var{entity}, @var{insn})
8251 @var{entity} is an integer specifying a mode-switched entity. If
8252 @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro to
8253 return an integer value not larger than the corresponding element in
8254 @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity} must
8255 be switched into prior to the execution of @var{insn}.
8258 @defmac NORMAL_MODE (@var{entity})
8259 If this macro is defined, it is evaluated for every @var{entity} that needs
8260 mode switching. It should evaluate to an integer, which is a mode that
8261 @var{entity} is assumed to be switched to at function entry and exit.
8264 @defmac MODE_PRIORITY_TO_MODE (@var{entity}, @var{n})
8265 This macro specifies the order in which modes for @var{entity} are processed.
8266 0 is the highest priority, @code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the
8267 lowest. The value of the macro should be an integer designating a mode
8268 for @var{entity}. For any fixed @var{entity}, @code{mode_priority_to_mode}
8269 (@var{entity}, @var{n}) shall be a bijection in 0 @dots{}
8270 @code{num_modes_for_mode_switching[@var{entity}] - 1}.
8273 @defmac EMIT_MODE_SET (@var{entity}, @var{mode}, @var{hard_regs_live})
8274 Generate one or more insns to set @var{entity} to @var{mode}.
8275 @var{hard_reg_live} is the set of hard registers live at the point where
8276 the insn(s) are to be inserted.
8279 @node Target Attributes
8280 @section Defining target-specific uses of @code{__attribute__}
8281 @cindex target attributes
8282 @cindex machine attributes
8283 @cindex attributes, target-specific
8285 Target-specific attributes may be defined for functions, data and types.
8286 These are described using the following target hooks; they also need to
8287 be documented in @file{extend.texi}.
8289 @deftypevr {Target Hook} {const struct attribute_spec *} TARGET_ATTRIBUTE_TABLE
8290 If defined, this target hook points to an array of @samp{struct
8291 attribute_spec} (defined in @file{tree.h}) specifying the machine
8292 specific attributes for this target and some of the restrictions on the
8293 entities to which these attributes are applied and the arguments they
8297 @deftypefn {Target Hook} int TARGET_COMP_TYPE_ATTRIBUTES (tree @var{type1}, tree @var{type2})
8298 If defined, this target hook is a function which returns zero if the attributes on
8299 @var{type1} and @var{type2} are incompatible, one if they are compatible,
8300 and two if they are nearly compatible (which causes a warning to be
8301 generated). If this is not defined, machine-specific attributes are
8302 supposed always to be compatible.
8305 @deftypefn {Target Hook} void TARGET_SET_DEFAULT_TYPE_ATTRIBUTES (tree @var{type})
8306 If defined, this target hook is a function which assigns default attributes to
8307 newly defined @var{type}.
8310 @deftypefn {Target Hook} tree TARGET_MERGE_TYPE_ATTRIBUTES (tree @var{type1}, tree @var{type2})
8311 Define this target hook if the merging of type attributes needs special
8312 handling. If defined, the result is a list of the combined
8313 @code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed
8314 that @code{comptypes} has already been called and returned 1. This
8315 function may call @code{merge_attributes} to handle machine-independent
8319 @deftypefn {Target Hook} tree TARGET_MERGE_DECL_ATTRIBUTES (tree @var{olddecl}, tree @var{newdecl})
8320 Define this target hook if the merging of decl attributes needs special
8321 handling. If defined, the result is a list of the combined
8322 @code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.
8323 @var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of
8324 when this is needed are when one attribute overrides another, or when an
8325 attribute is nullified by a subsequent definition. This function may
8326 call @code{merge_attributes} to handle machine-independent merging.
8328 @findex TARGET_DLLIMPORT_DECL_ATTRIBUTES
8329 If the only target-specific handling you require is @samp{dllimport} for
8330 Windows targets, you should define the macro
8331 @code{TARGET_DLLIMPORT_DECL_ATTRIBUTES}. This links in a function
8332 called @code{merge_dllimport_decl_attributes} which can then be defined
8333 as the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. This is done
8334 in @file{i386/cygwin.h} and @file{i386/i386.c}, for example.
8337 @deftypefn {Target Hook} void TARGET_INSERT_ATTRIBUTES (tree @var{node}, tree *@var{attr_ptr})
8338 Define this target hook if you want to be able to add attributes to a decl
8339 when it is being created. This is normally useful for back ends which
8340 wish to implement a pragma by using the attributes which correspond to
8341 the pragma's effect. The @var{node} argument is the decl which is being
8342 created. The @var{attr_ptr} argument is a pointer to the attribute list
8343 for this decl. The list itself should not be modified, since it may be
8344 shared with other decls, but attributes may be chained on the head of
8345 the list and @code{*@var{attr_ptr}} modified to point to the new
8346 attributes, or a copy of the list may be made if further changes are
8350 @deftypefn {Target Hook} bool TARGET_FUNCTION_ATTRIBUTE_INLINABLE_P (tree @var{fndecl})
8352 This target hook returns @code{true} if it is ok to inline @var{fndecl}
8353 into the current function, despite its having target-specific
8354 attributes, @code{false} otherwise. By default, if a function has a
8355 target specific attribute attached to it, it will not be inlined.
8358 @node MIPS Coprocessors
8359 @section Defining coprocessor specifics for MIPS targets.
8360 @cindex MIPS coprocessor-definition macros
8362 The MIPS specification allows MIPS implementations to have as many as 4
8363 coprocessors, each with as many as 32 private registers. gcc supports
8364 accessing these registers and transferring values between the registers
8365 and memory using asm-ized variables. For example:
8368 register unsigned int cp0count asm ("c0r1");
8374 (``c0r1'' is the default name of register 1 in coprocessor 0; alternate
8375 names may be added as described below, or the default names may be
8376 overridden entirely in @code{SUBTARGET_CONDITIONAL_REGISTER_USAGE}.)
8378 Coprocessor registers are assumed to be epilogue-used; sets to them will
8379 be preserved even if it does not appear that the register is used again
8380 later in the function.
8382 Another note: according to the MIPS spec, coprocessor 1 (if present) is
8383 the FPU. One accesses COP1 registers through standard mips
8384 floating-point support; they are not included in this mechanism.
8386 There is one macro used in defining the MIPS coprocessor interface which
8387 you may want to override in subtargets; it is described below.
8389 @defmac ALL_COP_ADDITIONAL_REGISTER_NAMES
8390 A comma-separated list (with leading comma) of pairs describing the
8391 alternate names of coprocessor registers. The format of each entry should be
8393 @{ @var{alternatename}, @var{register_number}@}
8399 @section Miscellaneous Parameters
8400 @cindex parameters, miscellaneous
8402 @c prevent bad page break with this line
8403 Here are several miscellaneous parameters.
8405 @defmac PREDICATE_CODES
8406 Define this if you have defined special-purpose predicates in the file
8407 @file{@var{machine}.c}. This macro is called within an initializer of an
8408 array of structures. The first field in the structure is the name of a
8409 predicate and the second field is an array of rtl codes. For each
8410 predicate, list all rtl codes that can be in expressions matched by the
8411 predicate. The list should have a trailing comma. Here is an example
8412 of two entries in the list for a typical RISC machine:
8415 #define PREDICATE_CODES \
8416 @{"gen_reg_rtx_operand", @{SUBREG, REG@}@}, \
8417 @{"reg_or_short_cint_operand", @{SUBREG, REG, CONST_INT@}@},
8420 Defining this macro does not affect the generated code (however,
8421 incorrect definitions that omit an rtl code that may be matched by the
8422 predicate can cause the compiler to malfunction). Instead, it allows
8423 the table built by @file{genrecog} to be more compact and efficient,
8424 thus speeding up the compiler. The most important predicates to include
8425 in the list specified by this macro are those used in the most insn
8428 For each predicate function named in @code{PREDICATE_CODES}, a
8429 declaration will be generated in @file{insn-codes.h}.
8432 @defmac SPECIAL_MODE_PREDICATES
8433 Define this if you have special predicates that know special things
8434 about modes. Genrecog will warn about certain forms of
8435 @code{match_operand} without a mode; if the operand predicate is
8436 listed in @code{SPECIAL_MODE_PREDICATES}, the warning will be
8439 Here is an example from the IA-32 port (@code{ext_register_operand}
8440 specially checks for @code{HImode} or @code{SImode} in preparation
8441 for a byte extraction from @code{%ah} etc.).
8444 #define SPECIAL_MODE_PREDICATES \
8445 "ext_register_operand",
8449 @defmac CASE_VECTOR_MODE
8450 An alias for a machine mode name. This is the machine mode that
8451 elements of a jump-table should have.
8454 @defmac CASE_VECTOR_SHORTEN_MODE (@var{min_offset}, @var{max_offset}, @var{body})
8455 Optional: return the preferred mode for an @code{addr_diff_vec}
8456 when the minimum and maximum offset are known. If you define this,
8457 it enables extra code in branch shortening to deal with @code{addr_diff_vec}.
8458 To make this work, you also have to define @code{INSN_ALIGN} and
8459 make the alignment for @code{addr_diff_vec} explicit.
8460 The @var{body} argument is provided so that the offset_unsigned and scale
8461 flags can be updated.
8464 @defmac CASE_VECTOR_PC_RELATIVE
8465 Define this macro to be a C expression to indicate when jump-tables
8466 should contain relative addresses. If jump-tables never contain
8467 relative addresses, then you need not define this macro.
8470 @defmac CASE_DROPS_THROUGH
8471 Define this if control falls through a @code{case} insn when the index
8472 value is out of range. This means the specified default-label is
8473 actually ignored by the @code{case} insn proper.
8476 @defmac CASE_VALUES_THRESHOLD
8477 Define this to be the smallest number of different values for which it
8478 is best to use a jump-table instead of a tree of conditional branches.
8479 The default is four for machines with a @code{casesi} instruction and
8480 five otherwise. This is best for most machines.
8483 @defmac CASE_USE_BIT_TESTS
8484 Define this macro to be a C expression to indicate whether C switch
8485 statements may be implemented by a sequence of bit tests. This is
8486 advantageous on processors that can efficiently implement left shift
8487 of 1 by the number of bits held in a register, but inappropriate on
8488 targets that would require a loop. By default, this macro returns
8489 @code{true} if the target defines an @code{ashlsi3} pattern, and
8490 @code{false} otherwise.
8493 @defmac WORD_REGISTER_OPERATIONS
8494 Define this macro if operations between registers with integral mode
8495 smaller than a word are always performed on the entire register.
8496 Most RISC machines have this property and most CISC machines do not.
8499 @defmac LOAD_EXTEND_OP (@var{mode})
8500 Define this macro to be a C expression indicating when insns that read
8501 memory in @var{mode}, an integral mode narrower than a word, set the
8502 bits outside of @var{mode} to be either the sign-extension or the
8503 zero-extension of the data read. Return @code{SIGN_EXTEND} for values
8504 of @var{mode} for which the
8505 insn sign-extends, @code{ZERO_EXTEND} for which it zero-extends, and
8506 @code{NIL} for other modes.
8508 This macro is not called with @var{mode} non-integral or with a width
8509 greater than or equal to @code{BITS_PER_WORD}, so you may return any
8510 value in this case. Do not define this macro if it would always return
8511 @code{NIL}. On machines where this macro is defined, you will normally
8512 define it as the constant @code{SIGN_EXTEND} or @code{ZERO_EXTEND}.
8515 @defmac SHORT_IMMEDIATES_SIGN_EXTEND
8516 Define this macro if loading short immediate values into registers sign
8520 @defmac FIXUNS_TRUNC_LIKE_FIX_TRUNC
8521 Define this macro if the same instructions that convert a floating
8522 point number to a signed fixed point number also convert validly to an
8527 The maximum number of bytes that a single instruction can move quickly
8528 between memory and registers or between two memory locations.
8531 @defmac MAX_MOVE_MAX
8532 The maximum number of bytes that a single instruction can move quickly
8533 between memory and registers or between two memory locations. If this
8534 is undefined, the default is @code{MOVE_MAX}. Otherwise, it is the
8535 constant value that is the largest value that @code{MOVE_MAX} can have
8539 @defmac SHIFT_COUNT_TRUNCATED
8540 A C expression that is nonzero if on this machine the number of bits
8541 actually used for the count of a shift operation is equal to the number
8542 of bits needed to represent the size of the object being shifted. When
8543 this macro is nonzero, the compiler will assume that it is safe to omit
8544 a sign-extend, zero-extend, and certain bitwise `and' instructions that
8545 truncates the count of a shift operation. On machines that have
8546 instructions that act on bit-fields at variable positions, which may
8547 include `bit test' instructions, a nonzero @code{SHIFT_COUNT_TRUNCATED}
8548 also enables deletion of truncations of the values that serve as
8549 arguments to bit-field instructions.
8551 If both types of instructions truncate the count (for shifts) and
8552 position (for bit-field operations), or if no variable-position bit-field
8553 instructions exist, you should define this macro.
8555 However, on some machines, such as the 80386 and the 680x0, truncation
8556 only applies to shift operations and not the (real or pretended)
8557 bit-field operations. Define @code{SHIFT_COUNT_TRUNCATED} to be zero on
8558 such machines. Instead, add patterns to the @file{md} file that include
8559 the implied truncation of the shift instructions.
8561 You need not define this macro if it would always have the value of zero.
8564 @defmac TRULY_NOOP_TRUNCATION (@var{outprec}, @var{inprec})
8565 A C expression which is nonzero if on this machine it is safe to
8566 ``convert'' an integer of @var{inprec} bits to one of @var{outprec}
8567 bits (where @var{outprec} is smaller than @var{inprec}) by merely
8568 operating on it as if it had only @var{outprec} bits.
8570 On many machines, this expression can be 1.
8572 @c rearranged this, removed the phrase "it is reported that". this was
8573 @c to fix an overfull hbox. --mew 10feb93
8574 When @code{TRULY_NOOP_TRUNCATION} returns 1 for a pair of sizes for
8575 modes for which @code{MODES_TIEABLE_P} is 0, suboptimal code can result.
8576 If this is the case, making @code{TRULY_NOOP_TRUNCATION} return 0 in
8577 such cases may improve things.
8580 @defmac STORE_FLAG_VALUE
8581 A C expression describing the value returned by a comparison operator
8582 with an integral mode and stored by a store-flag instruction
8583 (@samp{s@var{cond}}) when the condition is true. This description must
8584 apply to @emph{all} the @samp{s@var{cond}} patterns and all the
8585 comparison operators whose results have a @code{MODE_INT} mode.
8587 A value of 1 or @minus{}1 means that the instruction implementing the
8588 comparison operator returns exactly 1 or @minus{}1 when the comparison is true
8589 and 0 when the comparison is false. Otherwise, the value indicates
8590 which bits of the result are guaranteed to be 1 when the comparison is
8591 true. This value is interpreted in the mode of the comparison
8592 operation, which is given by the mode of the first operand in the
8593 @samp{s@var{cond}} pattern. Either the low bit or the sign bit of
8594 @code{STORE_FLAG_VALUE} be on. Presently, only those bits are used by
8597 If @code{STORE_FLAG_VALUE} is neither 1 or @minus{}1, the compiler will
8598 generate code that depends only on the specified bits. It can also
8599 replace comparison operators with equivalent operations if they cause
8600 the required bits to be set, even if the remaining bits are undefined.
8601 For example, on a machine whose comparison operators return an
8602 @code{SImode} value and where @code{STORE_FLAG_VALUE} is defined as
8603 @samp{0x80000000}, saying that just the sign bit is relevant, the
8607 (ne:SI (and:SI @var{x} (const_int @var{power-of-2})) (const_int 0))
8614 (ashift:SI @var{x} (const_int @var{n}))
8618 where @var{n} is the appropriate shift count to move the bit being
8619 tested into the sign bit.
8621 There is no way to describe a machine that always sets the low-order bit
8622 for a true value, but does not guarantee the value of any other bits,
8623 but we do not know of any machine that has such an instruction. If you
8624 are trying to port GCC to such a machine, include an instruction to
8625 perform a logical-and of the result with 1 in the pattern for the
8626 comparison operators and let us know at @email{gcc@@gcc.gnu.org}.
8628 Often, a machine will have multiple instructions that obtain a value
8629 from a comparison (or the condition codes). Here are rules to guide the
8630 choice of value for @code{STORE_FLAG_VALUE}, and hence the instructions
8635 Use the shortest sequence that yields a valid definition for
8636 @code{STORE_FLAG_VALUE}. It is more efficient for the compiler to
8637 ``normalize'' the value (convert it to, e.g., 1 or 0) than for the
8638 comparison operators to do so because there may be opportunities to
8639 combine the normalization with other operations.
8642 For equal-length sequences, use a value of 1 or @minus{}1, with @minus{}1 being
8643 slightly preferred on machines with expensive jumps and 1 preferred on
8647 As a second choice, choose a value of @samp{0x80000001} if instructions
8648 exist that set both the sign and low-order bits but do not define the
8652 Otherwise, use a value of @samp{0x80000000}.
8655 Many machines can produce both the value chosen for
8656 @code{STORE_FLAG_VALUE} and its negation in the same number of
8657 instructions. On those machines, you should also define a pattern for
8658 those cases, e.g., one matching
8661 (set @var{A} (neg:@var{m} (ne:@var{m} @var{B} @var{C})))
8664 Some machines can also perform @code{and} or @code{plus} operations on
8665 condition code values with less instructions than the corresponding
8666 @samp{s@var{cond}} insn followed by @code{and} or @code{plus}. On those
8667 machines, define the appropriate patterns. Use the names @code{incscc}
8668 and @code{decscc}, respectively, for the patterns which perform
8669 @code{plus} or @code{minus} operations on condition code values. See
8670 @file{rs6000.md} for some examples. The GNU Superoptizer can be used to
8671 find such instruction sequences on other machines.
8673 If this macro is not defined, the default value, 1, is used. You need
8674 not define @code{STORE_FLAG_VALUE} if the machine has no store-flag
8675 instructions, or if the value generated by these instructions is 1.
8678 @defmac FLOAT_STORE_FLAG_VALUE (@var{mode})
8679 A C expression that gives a nonzero @code{REAL_VALUE_TYPE} value that is
8680 returned when comparison operators with floating-point results are true.
8681 Define this macro on machine that have comparison operations that return
8682 floating-point values. If there are no such operations, do not define
8686 @defmac CLZ_DEFINED_VALUE_AT_ZERO (@var{mode}, @var{value})
8687 @defmacx CTZ_DEFINED_VALUE_AT_ZERO (@var{mode}, @var{value})
8688 A C expression that evaluates to true if the architecture defines a value
8689 for @code{clz} or @code{ctz} with a zero operand. If so, @var{value}
8690 should be set to this value. If this macro is not defined, the value of
8691 @code{clz} or @code{ctz} is assumed to be undefined.
8693 This macro must be defined if the target's expansion for @code{ffs}
8694 relies on a particular value to get correct results. Otherwise it
8695 is not necessary, though it may be used to optimize some corner cases.
8697 Note that regardless of this macro the ``definedness'' of @code{clz}
8698 and @code{ctz} at zero do @emph{not} extend to the builtin functions
8699 visible to the user. Thus one may be free to adjust the value at will
8700 to match the target expansion of these operations without fear of
8705 An alias for the machine mode for pointers. On most machines, define
8706 this to be the integer mode corresponding to the width of a hardware
8707 pointer; @code{SImode} on 32-bit machine or @code{DImode} on 64-bit machines.
8708 On some machines you must define this to be one of the partial integer
8709 modes, such as @code{PSImode}.
8711 The width of @code{Pmode} must be at least as large as the value of
8712 @code{POINTER_SIZE}. If it is not equal, you must define the macro
8713 @code{POINTERS_EXTEND_UNSIGNED} to specify how pointers are extended
8717 @defmac FUNCTION_MODE
8718 An alias for the machine mode used for memory references to functions
8719 being called, in @code{call} RTL expressions. On most machines this
8720 should be @code{QImode}.
8723 @defmac INTEGRATE_THRESHOLD (@var{decl})
8724 A C expression for the maximum number of instructions above which the
8725 function @var{decl} should not be inlined. @var{decl} is a
8726 @code{FUNCTION_DECL} node.
8728 The default definition of this macro is 64 plus 8 times the number of
8729 arguments that the function accepts. Some people think a larger
8730 threshold should be used on RISC machines.
8733 @defmac STDC_0_IN_SYSTEM_HEADERS
8734 In normal operation, the preprocessor expands @code{__STDC__} to the
8735 constant 1, to signify that GCC conforms to ISO Standard C@. On some
8736 hosts, like Solaris, the system compiler uses a different convention,
8737 where @code{__STDC__} is normally 0, but is 1 if the user specifies
8738 strict conformance to the C Standard.
8740 Defining @code{STDC_0_IN_SYSTEM_HEADERS} makes GNU CPP follows the host
8741 convention when processing system header files, but when processing user
8742 files @code{__STDC__} will always expand to 1.
8745 @defmac NO_IMPLICIT_EXTERN_C
8746 Define this macro if the system header files support C++ as well as C@.
8747 This macro inhibits the usual method of using system header files in
8748 C++, which is to pretend that the file's contents are enclosed in
8749 @samp{extern "C" @{@dots{}@}}.
8754 @defmac REGISTER_TARGET_PRAGMAS ()
8755 Define this macro if you want to implement any target-specific pragmas.
8756 If defined, it is a C expression which makes a series of calls to
8757 @code{c_register_pragma} for each pragma. The macro may also do any
8758 setup required for the pragmas.
8760 The primary reason to define this macro is to provide compatibility with
8761 other compilers for the same target. In general, we discourage
8762 definition of target-specific pragmas for GCC@.
8764 If the pragma can be implemented by attributes then you should consider
8765 defining the target hook @samp{TARGET_INSERT_ATTRIBUTES} as well.
8767 Preprocessor macros that appear on pragma lines are not expanded. All
8768 @samp{#pragma} directives that do not match any registered pragma are
8769 silently ignored, unless the user specifies @option{-Wunknown-pragmas}.
8772 @deftypefun void c_register_pragma (const char *@var{space}, const char *@var{name}, void (*@var{callback}) (struct cpp_reader *))
8774 Each call to @code{c_register_pragma} establishes one pragma. The
8775 @var{callback} routine will be called when the preprocessor encounters a
8779 #pragma [@var{space}] @var{name} @dots{}
8782 @var{space} is the case-sensitive namespace of the pragma, or
8783 @code{NULL} to put the pragma in the global namespace. The callback
8784 routine receives @var{pfile} as its first argument, which can be passed
8785 on to cpplib's functions if necessary. You can lex tokens after the
8786 @var{name} by calling @code{c_lex}. Tokens that are not read by the
8787 callback will be silently ignored. The end of the line is indicated by
8788 a token of type @code{CPP_EOF}
8790 For an example use of this routine, see @file{c4x.h} and the callback
8791 routines defined in @file{c4x-c.c}.
8793 Note that the use of @code{c_lex} is specific to the C and C++
8794 compilers. It will not work in the Java or Fortran compilers, or any
8795 other language compilers for that matter. Thus if @code{c_lex} is going
8796 to be called from target-specific code, it must only be done so when
8797 building the C and C++ compilers. This can be done by defining the
8798 variables @code{c_target_objs} and @code{cxx_target_objs} in the
8799 target entry in the @file{config.gcc} file. These variables should name
8800 the target-specific, language-specific object file which contains the
8801 code that uses @code{c_lex}. Note it will also be necessary to add a
8802 rule to the makefile fragment pointed to by @code{tmake_file} that shows
8803 how to build this object file.
8808 @defmac HANDLE_SYSV_PRAGMA
8809 Define this macro (to a value of 1) if you want the System V style
8810 pragmas @samp{#pragma pack(<n>)} and @samp{#pragma weak <name>
8811 [=<value>]} to be supported by gcc.
8813 The pack pragma specifies the maximum alignment (in bytes) of fields
8814 within a structure, in much the same way as the @samp{__aligned__} and
8815 @samp{__packed__} @code{__attribute__}s do. A pack value of zero resets
8816 the behavior to the default.
8818 A subtlety for Microsoft Visual C/C++ style bit-field packing
8819 (e.g. -mms-bitfields) for targets that support it:
8820 When a bit-field is inserted into a packed record, the whole size
8821 of the underlying type is used by one or more same-size adjacent
8822 bit-fields (that is, if its long:3, 32 bits is used in the record,
8823 and any additional adjacent long bit-fields are packed into the same
8824 chunk of 32 bits. However, if the size changes, a new field of that
8827 If both MS bit-fields and @samp{__attribute__((packed))} are used,
8828 the latter will take precedence. If @samp{__attribute__((packed))} is
8829 used on a single field when MS bit-fields are in use, it will take
8830 precedence for that field, but the alignment of the rest of the structure
8831 may affect its placement.
8833 The weak pragma only works if @code{SUPPORTS_WEAK} and
8834 @code{ASM_WEAKEN_LABEL} are defined. If enabled it allows the creation
8835 of specifically named weak labels, optionally with a value.
8840 @defmac HANDLE_PRAGMA_PACK_PUSH_POP
8841 Define this macro (to a value of 1) if you want to support the Win32
8842 style pragmas @samp{#pragma pack(push,@var{n})} and @samp{#pragma
8843 pack(pop)}. The @samp{pack(push,@var{n})} pragma specifies the maximum alignment
8844 (in bytes) of fields within a structure, in much the same way as the
8845 @samp{__aligned__} and @samp{__packed__} @code{__attribute__}s do. A
8846 pack value of zero resets the behavior to the default. Successive
8847 invocations of this pragma cause the previous values to be stacked, so
8848 that invocations of @samp{#pragma pack(pop)} will return to the previous
8852 @defmac DOLLARS_IN_IDENTIFIERS
8853 Define this macro to control use of the character @samp{$} in
8854 identifier names for the C family of languages. 0 means @samp{$} is
8855 not allowed by default; 1 means it is allowed. 1 is the default;
8856 there is no need to define this macro in that case.
8859 @defmac NO_DOLLAR_IN_LABEL
8860 Define this macro if the assembler does not accept the character
8861 @samp{$} in label names. By default constructors and destructors in
8862 G++ have @samp{$} in the identifiers. If this macro is defined,
8863 @samp{.} is used instead.
8866 @defmac NO_DOT_IN_LABEL
8867 Define this macro if the assembler does not accept the character
8868 @samp{.} in label names. By default constructors and destructors in G++
8869 have names that use @samp{.}. If this macro is defined, these names
8870 are rewritten to avoid @samp{.}.
8873 @defmac DEFAULT_MAIN_RETURN
8874 Define this macro if the target system expects every program's @code{main}
8875 function to return a standard ``success'' value by default (if no other
8876 value is explicitly returned).
8878 The definition should be a C statement (sans semicolon) to generate the
8879 appropriate rtl instructions. It is used only when compiling the end of
8883 @defmac INSN_SETS_ARE_DELAYED (@var{insn})
8884 Define this macro as a C expression that is nonzero if it is safe for the
8885 delay slot scheduler to place instructions in the delay slot of @var{insn},
8886 even if they appear to use a resource set or clobbered in @var{insn}.
8887 @var{insn} is always a @code{jump_insn} or an @code{insn}; GCC knows that
8888 every @code{call_insn} has this behavior. On machines where some @code{insn}
8889 or @code{jump_insn} is really a function call and hence has this behavior,
8890 you should define this macro.
8892 You need not define this macro if it would always return zero.
8895 @defmac INSN_REFERENCES_ARE_DELAYED (@var{insn})
8896 Define this macro as a C expression that is nonzero if it is safe for the
8897 delay slot scheduler to place instructions in the delay slot of @var{insn},
8898 even if they appear to set or clobber a resource referenced in @var{insn}.
8899 @var{insn} is always a @code{jump_insn} or an @code{insn}. On machines where
8900 some @code{insn} or @code{jump_insn} is really a function call and its operands
8901 are registers whose use is actually in the subroutine it calls, you should
8902 define this macro. Doing so allows the delay slot scheduler to move
8903 instructions which copy arguments into the argument registers into the delay
8906 You need not define this macro if it would always return zero.
8909 @defmac MULTIPLE_SYMBOL_SPACES
8910 Define this macro if in some cases global symbols from one translation
8911 unit may not be bound to undefined symbols in another translation unit
8912 without user intervention. For instance, under Microsoft Windows
8913 symbols must be explicitly imported from shared libraries (DLLs).
8916 @defmac MD_ASM_CLOBBERS (@var{clobbers})
8917 A C statement that adds to @var{clobbers} @code{STRING_CST} trees for
8918 any hard regs the port wishes to automatically clobber for all asms.
8921 @defmac MAX_INTEGER_COMPUTATION_MODE
8922 Define this to the largest integer machine mode which can be used for
8923 operations other than load, store and copy operations.
8925 You need only define this macro if the target holds values larger than
8926 @code{word_mode} in general purpose registers. Most targets should not define
8930 @defmac MATH_LIBRARY
8931 Define this macro as a C string constant for the linker argument to link
8932 in the system math library, or @samp{""} if the target does not have a
8933 separate math library.
8935 You need only define this macro if the default of @samp{"-lm"} is wrong.
8938 @defmac LIBRARY_PATH_ENV
8939 Define this macro as a C string constant for the environment variable that
8940 specifies where the linker should look for libraries.
8942 You need only define this macro if the default of @samp{"LIBRARY_PATH"}
8946 @defmac TARGET_HAS_F_SETLKW
8947 Define this macro if the target supports file locking with fcntl / F_SETLKW@.
8948 Note that this functionality is part of POSIX@.
8949 Defining @code{TARGET_HAS_F_SETLKW} will enable the test coverage code
8950 to use file locking when exiting a program, which avoids race conditions
8951 if the program has forked.
8954 @defmac MAX_CONDITIONAL_EXECUTE
8956 A C expression for the maximum number of instructions to execute via
8957 conditional execution instructions instead of a branch. A value of
8958 @code{BRANCH_COST}+1 is the default if the machine does not use cc0, and
8959 1 if it does use cc0.
8962 @defmac IFCVT_MODIFY_TESTS (@var{ce_info}, @var{true_expr}, @var{false_expr})
8963 Used if the target needs to perform machine-dependent modifications on the
8964 conditionals used for turning basic blocks into conditionally executed code.
8965 @var{ce_info} points to a data structure, @code{struct ce_if_block}, which
8966 contains information about the currently processed blocks. @var{true_expr}
8967 and @var{false_expr} are the tests that are used for converting the
8968 then-block and the else-block, respectively. Set either @var{true_expr} or
8969 @var{false_expr} to a null pointer if the tests cannot be converted.
8972 @defmac IFCVT_MODIFY_MULTIPLE_TESTS (@var{ce_info}, @var{bb}, @var{true_expr}, @var{false_expr})
8973 Like @code{IFCVT_MODIFY_TESTS}, but used when converting more complicated
8974 if-statements into conditions combined by @code{and} and @code{or} operations.
8975 @var{bb} contains the basic block that contains the test that is currently
8976 being processed and about to be turned into a condition.
8979 @defmac IFCVT_MODIFY_INSN (@var{ce_info}, @var{pattern}, @var{insn})
8980 A C expression to modify the @var{PATTERN} of an @var{INSN} that is to
8981 be converted to conditional execution format. @var{ce_info} points to
8982 a data structure, @code{struct ce_if_block}, which contains information
8983 about the currently processed blocks.
8986 @defmac IFCVT_MODIFY_FINAL (@var{ce_info})
8987 A C expression to perform any final machine dependent modifications in
8988 converting code to conditional execution. The involved basic blocks
8989 can be found in the @code{struct ce_if_block} structure that is pointed
8990 to by @var{ce_info}.
8993 @defmac IFCVT_MODIFY_CANCEL (@var{ce_info})
8994 A C expression to cancel any machine dependent modifications in
8995 converting code to conditional execution. The involved basic blocks
8996 can be found in the @code{struct ce_if_block} structure that is pointed
8997 to by @var{ce_info}.
9000 @defmac IFCVT_INIT_EXTRA_FIELDS (@var{ce_info})
9001 A C expression to initialize any extra fields in a @code{struct ce_if_block}
9002 structure, which are defined by the @code{IFCVT_EXTRA_FIELDS} macro.
9005 @defmac IFCVT_EXTRA_FIELDS
9006 If defined, it should expand to a set of field declarations that will be
9007 added to the @code{struct ce_if_block} structure. These should be initialized
9008 by the @code{IFCVT_INIT_EXTRA_FIELDS} macro.
9011 @deftypefn {Target Hook} void TARGET_MACHINE_DEPENDENT_REORG ()
9012 If non-null, this hook performs a target-specific pass over the
9013 instruction stream. The compiler will run it at all optimization levels,
9014 just before the point at which it normally does delayed-branch scheduling.
9016 The exact purpose of the hook varies from target to target. Some use
9017 it to do transformations that are necessary for correctness, such as
9018 laying out in-function constant pools or avoiding hardware hazards.
9019 Others use it as an opportunity to do some machine-dependent optimizations.
9021 You need not implement the hook if it has nothing to do. The default
9025 @deftypefn {Target Hook} void TARGET_INIT_BUILTINS ()
9026 Define this hook if you have any machine-specific built-in functions
9027 that need to be defined. It should be a function that performs the
9030 Machine specific built-in functions can be useful to expand special machine
9031 instructions that would otherwise not normally be generated because
9032 they have no equivalent in the source language (for example, SIMD vector
9033 instructions or prefetch instructions).
9035 To create a built-in function, call the function @code{builtin_function}
9036 which is defined by the language front end. You can use any type nodes set
9037 up by @code{build_common_tree_nodes} and @code{build_common_tree_nodes_2};
9038 only language front ends that use those two functions will call
9039 @samp{TARGET_INIT_BUILTINS}.
9042 @deftypefn {Target Hook} rtx TARGET_EXPAND_BUILTIN (tree @var{exp}, rtx @var{target}, rtx @var{subtarget}, enum machine_mode @var{mode}, int @var{ignore})
9044 Expand a call to a machine specific built-in function that was set up by
9045 @samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the
9046 function call; the result should go to @var{target} if that is
9047 convenient, and have mode @var{mode} if that is convenient.
9048 @var{subtarget} may be used as the target for computing one of
9049 @var{exp}'s operands. @var{ignore} is nonzero if the value is to be
9050 ignored. This function should return the result of the call to the
9054 @defmac MD_CAN_REDIRECT_BRANCH (@var{branch1}, @var{branch2})
9056 Take a branch insn in @var{branch1} and another in @var{branch2}.
9057 Return true if redirecting @var{branch1} to the destination of
9058 @var{branch2} is possible.
9060 On some targets, branches may have a limited range. Optimizing the
9061 filling of delay slots can result in branches being redirected, and this
9062 may in turn cause a branch offset to overflow.
9065 @defmac ALLOCATE_INITIAL_VALUE (@var{hard_reg})
9067 When the initial value of a hard register has been copied in a pseudo
9068 register, it is often not necessary to actually allocate another register
9069 to this pseudo register, because the original hard register or a stack slot
9070 it has been saved into can be used. @code{ALLOCATE_INITIAL_VALUE}, if
9071 defined, is called at the start of register allocation once for each
9072 hard register that had its initial value copied by using
9073 @code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.
9074 Possible values are @code{NULL_RTX}, if you don't want
9075 to do any special allocation, a @code{REG} rtx---that would typically be
9076 the hard register itself, if it is known not to be clobbered---or a
9078 If you are returning a @code{MEM}, this is only a hint for the allocator;
9079 it might decide to use another register anyways.
9080 You may use @code{current_function_leaf_function} in the definition of the
9081 macro, functions that use @code{REG_N_SETS}, to determine if the hard
9082 register in question will not be clobbered.
9085 @defmac TARGET_OBJECT_SUFFIX
9086 Define this macro to be a C string representing the suffix for object
9087 files on your target machine. If you do not define this macro, GCC will
9088 use @samp{.o} as the suffix for object files.
9091 @defmac TARGET_EXECUTABLE_SUFFIX
9092 Define this macro to be a C string representing the suffix to be
9093 automatically added to executable files on your target machine. If you
9094 do not define this macro, GCC will use the null string as the suffix for
9098 @defmac COLLECT_EXPORT_LIST
9099 If defined, @code{collect2} will scan the individual object files
9100 specified on its command line and create an export list for the linker.
9101 Define this macro for systems like AIX, where the linker discards
9102 object files that are not referenced from @code{main} and uses export
9106 @defmac MODIFY_JNI_METHOD_CALL (@var{mdecl})
9107 Define this macro to a C expression representing a variant of the
9108 method call @var{mdecl}, if Java Native Interface (JNI) methods
9109 must be invoked differently from other methods on your target.
9110 For example, on 32-bit Windows, JNI methods must be invoked using
9111 the @code{stdcall} calling convention and this macro is then
9112 defined as this expression:
9115 build_type_attribute_variant (@var{mdecl},
9117 (get_identifier ("stdcall"),
9122 @deftypefn {Target Hook} bool TARGET_CANNOT_MODIFY_JUMPS_P (void)
9123 This target hook returns @code{true} past the point in which new jump
9124 instructions could be created. On machines that require a register for
9125 every jump such as the SHmedia ISA of SH5, this point would typically be
9126 reload, so this target hook should be defined to a function such as:
9130 cannot_modify_jumps_past_reload_p ()
9132 return (reload_completed || reload_in_progress);
9137 @deftypefn {Target Hook} enum reg_class TARGET_BRANCH_TARGET_REGISTER_CLASS (void)
9138 This target hook returns a register class for which branch target register
9139 optimizations should be applied. All registers in this class should be
9140 usable interchangably. After reload, registers in this class will be
9141 re-allocated and loads will be hoisted out of loops and be subjected
9142 to inter-block scheduling.
9145 @deftypefn {Target Hook} bool TARGET_BRANCH_TARGET_REGISTER_CALLEE_SAVED (bool @var{after_prologue_epilogue_gen})
9146 Branch target register optimization will by default exclude callee-saved
9148 that are not already live during the current function; if this target hook
9149 returns true, they will be included. The target code must than make sure
9150 that all target registers in the class returned by
9151 @samp{TARGET_BRANCH_TARGET_REGISTER_CLASS} that might need saving are
9152 saved. @var{after_prologue_epilogue_gen} indicates if prologues and
9153 epilogues have already been generated. Note, even if you only return
9154 true when @var{after_prologue_epilogue_gen} is false, you still are likely
9155 to have to make special provisions in @code{INITIAL_ELIMINATION_OFFSET}
9156 to reserve space for caller-saved target registers.