Add support for target specific, language specific object files.
[official-gcc.git] / gcc / tm.texi
blobcb923653c367a195f9a8a69164f18646d0a495b8
1 @c Copyright (C) 1988,1989,1992,1993,1994,1995,1996,1997,1998,1999,2000
2 @c Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @node Target Macros
7 @chapter Target Description Macros
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}.  This header file defines numerous macros
16 that convey the information about the target machine that does not fit
17 into the scheme of the @file{.md} file.  The file @file{tm.h} should be
18 a link to @file{@var{machine}.h}.  The header file @file{config.h}
19 includes @file{tm.h} and most compiler source files include
20 @file{config.h}.
22 @menu
23 * Driver::              Controlling how the driver runs the compilation passes.
24 * Run-time Target::     Defining @samp{-m} options like @samp{-m68000} and @samp{-m68020}.
25 * Storage Layout::      Defining sizes and alignments of data.
26 * Type Layout::         Defining sizes and properties of basic user data types.
27 * Registers::           Naming and describing the hardware registers.
28 * Register Classes::    Defining the classes of hardware registers.
29 * Stack and Calling::   Defining which way the stack grows and by how much.
30 * Varargs::             Defining the varargs macros.
31 * Trampolines::         Code set up at run time to enter a nested function.
32 * Library Calls::       Controlling how library routines are implicitly called.
33 * Addressing Modes::    Defining addressing modes valid for memory operands.
34 * Condition Code::      Defining how insns update the condition code.
35 * Costs::               Defining relative costs of different operations.
36 * Sections::            Dividing storage into text, data, and other sections.
37 * PIC::                 Macros for position independent code.
38 * Assembler Format::    Defining how to write insns and pseudo-ops to output.
39 * Debugging Info::      Defining the format of debugging output.
40 * Cross-compilation::   Handling floating point for cross-compilers.
41 * Mode Switching::      Insertion of mode-switching instructions.
42 * Misc::                Everything else.
43 @end menu
45 @node Driver
46 @section Controlling the Compilation Driver, @file{gcc}
47 @cindex driver
48 @cindex controlling the compilation driver
50 @c prevent bad page break with this line
51 You can control the compilation driver.
53 @table @code
54 @findex SWITCH_TAKES_ARG
55 @item SWITCH_TAKES_ARG (@var{char})
56 A C expression which determines whether the option @samp{-@var{char}}
57 takes arguments.  The value should be the number of arguments that
58 option takes--zero, for many options.
60 By default, this macro is defined as
61 @code{DEFAULT_SWITCH_TAKES_ARG}, which handles the standard options
62 properly.  You need not define @code{SWITCH_TAKES_ARG} unless you
63 wish to add additional options which take arguments.  Any redefinition
64 should call @code{DEFAULT_SWITCH_TAKES_ARG} and then check for
65 additional options.
67 @findex WORD_SWITCH_TAKES_ARG
68 @item WORD_SWITCH_TAKES_ARG (@var{name})
69 A C expression which determines whether the option @samp{-@var{name}}
70 takes arguments.  The value should be the number of arguments that
71 option takes--zero, for many options.  This macro rather than
72 @code{SWITCH_TAKES_ARG} is used for multi-character option names.
74 By default, this macro is defined as
75 @code{DEFAULT_WORD_SWITCH_TAKES_ARG}, which handles the standard options
76 properly.  You need not define @code{WORD_SWITCH_TAKES_ARG} unless you
77 wish to add additional options which take arguments.  Any redefinition
78 should call @code{DEFAULT_WORD_SWITCH_TAKES_ARG} and then check for
79 additional options.
81 @findex SWITCH_CURTAILS_COMPILATION
82 @item SWITCH_CURTAILS_COMPILATION (@var{char})
83 A C expression which determines whether the option @samp{-@var{char}}
84 stops compilation before the generation of an executable.  The value is
85 boolean, non-zero if the option does stop an executable from being
86 generated, zero otherwise.
88 By default, this macro is defined as
89 @code{DEFAULT_SWITCH_CURTAILS_COMPILATION}, which handles the standard
90 options properly.  You need not define
91 @code{SWITCH_CURTAILS_COMPILATION} unless you wish to add additional
92 options which affect the generation of an executable.  Any redefinition
93 should call @code{DEFAULT_SWITCH_CURTAILS_COMPILATION} and then check
94 for additional options.
96 @findex SWITCHES_NEED_SPACES
97 @item SWITCHES_NEED_SPACES
98 A string-valued C expression which enumerates the options for which
99 the linker needs a space between the option and its argument.
101 If this macro is not defined, the default value is @code{""}.
103 @findex CPP_SPEC
104 @item CPP_SPEC
105 A C string constant that tells the GCC driver program options to
106 pass to CPP.  It can also specify how to translate options you
107 give to GCC into options for GCC to pass to the CPP.
109 Do not define this macro if it does not need to do anything.
111 @findex NO_BUILTIN_SIZE_TYPE
112 @item NO_BUILTIN_SIZE_TYPE
113 If this macro is defined, the preprocessor will not define the builtin macro
114 @code{__SIZE_TYPE__}.  The macro @code{__SIZE_TYPE__} must then be defined
115 by @code{CPP_SPEC} instead.
117 This should be defined if @code{SIZE_TYPE} depends on target dependent flags
118 which are not accessible to the preprocessor.  Otherwise, it should not
119 be defined.
121 @findex NO_BUILTIN_PTRDIFF_TYPE
122 @item NO_BUILTIN_PTRDIFF_TYPE
123 If this macro is defined, the preprocessor will not define the builtin macro
124 @code{__PTRDIFF_TYPE__}.  The macro @code{__PTRDIFF_TYPE__} must then be
125 defined by @code{CPP_SPEC} instead.
127 This should be defined if @code{PTRDIFF_TYPE} depends on target dependent flags
128 which are not accessible to the preprocessor.  Otherwise, it should not
129 be defined.
131 @findex NO_BUILTIN_WCHAR_TYPE
132 @item NO_BUILTIN_WCHAR_TYPE
133 If this macro is defined, the preprocessor will not define the builtin macro
134 @code{__WCHAR_TYPE__}.  The macro @code{__WCHAR_TYPE__} must then be
135 defined by @code{CPP_SPEC} instead.
137 This should be defined if @code{WCHAR_TYPE} depends on target dependent flags
138 which are not accessible to the preprocessor.  Otherwise, it should not
139 be defined.
141 @findex NO_BUILTIN_WINT_TYPE
142 @item NO_BUILTIN_WINT_TYPE
143 If this macro is defined, the preprocessor will not define the builtin macro
144 @code{__WINT_TYPE__}.  The macro @code{__WINT_TYPE__} must then be
145 defined by @code{CPP_SPEC} instead.
147 This should be defined if @code{WINT_TYPE} depends on target dependent flags
148 which are not accessible to the preprocessor.  Otherwise, it should not
149 be defined.
151 @findex SIGNED_CHAR_SPEC
152 @item SIGNED_CHAR_SPEC
153 A C string constant that tells the GCC driver program options to
154 pass to CPP.  By default, this macro is defined to pass the option
155 @samp{-D__CHAR_UNSIGNED__} to CPP if @code{char} will be treated as
156 @code{unsigned char} by @code{cc1}.
158 Do not define this macro unless you need to override the default
159 definition.
161 @findex CC1_SPEC
162 @item CC1_SPEC
163 A C string constant that tells the GCC driver program options to
164 pass to @code{cc1}, @code{cc1plus}, @code{f771}, and the other language
165 front ends.
166 It can also specify how to translate options you give to GCC into options
167 for GCC to pass to front ends..
169 Do not define this macro if it does not need to do anything.
171 @findex CC1PLUS_SPEC
172 @item CC1PLUS_SPEC
173 A C string constant that tells the GCC driver program options to
174 pass to @code{cc1plus}.  It can also specify how to translate options you
175 give to GCC into options for GCC to pass to the @code{cc1plus}.
177 Do not define this macro if it does not need to do anything.
178 Note that everything defined in CC1_SPEC is already passed to
179 @code{cc1plus} so there is no need to duplicate the contents of
180 CC1_SPEC in CC1PLUS_SPEC.
182 @findex ASM_SPEC
183 @item ASM_SPEC
184 A C string constant that tells the GCC driver program options to
185 pass to the assembler.  It can also specify how to translate options
186 you give to GCC into options for GCC to pass to the assembler.
187 See the file @file{sun3.h} for an example of this.
189 Do not define this macro if it does not need to do anything.
191 @findex ASM_FINAL_SPEC
192 @item ASM_FINAL_SPEC
193 A C string constant that tells the GCC driver program how to
194 run any programs which cleanup after the normal assembler.
195 Normally, this is not needed.  See the file @file{mips.h} for
196 an example of this.
198 Do not define this macro if it does not need to do anything.
200 @findex LINK_SPEC
201 @item LINK_SPEC
202 A C string constant that tells the GCC driver program options to
203 pass to the linker.  It can also specify how to translate options you
204 give to GCC into options for GCC to pass to the linker.
206 Do not define this macro if it does not need to do anything.
208 @findex LIB_SPEC
209 @item LIB_SPEC
210 Another C string constant used much like @code{LINK_SPEC}.  The difference
211 between the two is that @code{LIB_SPEC} is used at the end of the
212 command given to the linker.
214 If this macro is not defined, a default is provided that
215 loads the standard C library from the usual place.  See @file{gcc.c}.
217 @findex LIBGCC_SPEC
218 @item LIBGCC_SPEC
219 Another C string constant that tells the GCC driver program
220 how and when to place a reference to @file{libgcc.a} into the
221 linker command line.  This constant is placed both before and after
222 the value of @code{LIB_SPEC}.
224 If this macro is not defined, the GCC driver provides a default that
225 passes the string @samp{-lgcc} to the linker.
227 @findex STARTFILE_SPEC
228 @item STARTFILE_SPEC
229 Another C string constant used much like @code{LINK_SPEC}.  The
230 difference between the two is that @code{STARTFILE_SPEC} is used at
231 the very beginning of the command given to the linker.
233 If this macro is not defined, a default is provided that loads the
234 standard C startup file from the usual place.  See @file{gcc.c}.
236 @findex ENDFILE_SPEC
237 @item ENDFILE_SPEC
238 Another C string constant used much like @code{LINK_SPEC}.  The
239 difference between the two is that @code{ENDFILE_SPEC} is used at
240 the very end of the command given to the linker.
242 Do not define this macro if it does not need to do anything.
244 @findex EXTRA_SPECS
245 @item EXTRA_SPECS
246 Define this macro to provide additional specifications to put in the
247 @file{specs} file that can be used in various specifications like
248 @code{CC1_SPEC}.
250 The definition should be an initializer for an array of structures,
251 containing a string constant, that defines the specification name, and a
252 string constant that provides the specification.
254 Do not define this macro if it does not need to do anything.
256 @code{EXTRA_SPECS} is useful when an architecture contains several
257 related targets, which have various @code{..._SPECS} which are similar
258 to each other, and the maintainer would like one central place to keep
259 these definitions.
261 For example, the PowerPC System V.4 targets use @code{EXTRA_SPECS} to
262 define either @code{_CALL_SYSV} when the System V calling sequence is
263 used or @code{_CALL_AIX} when the older AIX-based calling sequence is
264 used.
266 The @file{config/rs6000/rs6000.h} target file defines:
268 @example
269 #define EXTRA_SPECS \
270   @{ "cpp_sysv_default", CPP_SYSV_DEFAULT @},
272 #define CPP_SYS_DEFAULT ""
273 @end example
275 The @file{config/rs6000/sysv.h} target file defines:
276 @smallexample
277 #undef CPP_SPEC
278 #define CPP_SPEC \
279 "%@{posix: -D_POSIX_SOURCE @} \
280 %@{mcall-sysv: -D_CALL_SYSV @} %@{mcall-aix: -D_CALL_AIX @} \
281 %@{!mcall-sysv: %@{!mcall-aix: %(cpp_sysv_default) @}@} \
282 %@{msoft-float: -D_SOFT_FLOAT@} %@{mcpu=403: -D_SOFT_FLOAT@}"
284 #undef CPP_SYSV_DEFAULT
285 #define CPP_SYSV_DEFAULT "-D_CALL_SYSV"
286 @end smallexample
288 while the @file{config/rs6000/eabiaix.h} target file defines
289 @code{CPP_SYSV_DEFAULT} as:
291 @smallexample
292 #undef CPP_SYSV_DEFAULT
293 #define CPP_SYSV_DEFAULT "-D_CALL_AIX"
294 @end smallexample
296 @findex LINK_LIBGCC_SPECIAL
297 @item LINK_LIBGCC_SPECIAL
298 Define this macro if the driver program should find the library
299 @file{libgcc.a} itself and should not pass @samp{-L} options to the
300 linker.  If you do not define this macro, the driver program will pass
301 the argument @samp{-lgcc} to tell the linker to do the search and will
302 pass @samp{-L} options to it.
304 @findex LINK_LIBGCC_SPECIAL_1
305 @item LINK_LIBGCC_SPECIAL_1
306 Define this macro if the driver program should find the library
307 @file{libgcc.a}.  If you do not define this macro, the driver program will pass
308 the argument @samp{-lgcc} to tell the linker to do the search.
309 This macro is similar to @code{LINK_LIBGCC_SPECIAL}, except that it does
310 not affect @samp{-L} options.
312 @findex LINK_COMMAND_SPEC
313 @item LINK_COMMAND_SPEC
314 A C string constant giving the complete command line need to execute the
315 linker.  When you do this, you will need to update your port each time a
316 change is made to the link command line within @file{gcc.c}.  Therefore,
317 define this macro only if you need to completely redefine the command
318 line for invoking the linker and there is no other way to accomplish
319 the effect you need.
321 @findex MULTILIB_DEFAULTS
322 @item MULTILIB_DEFAULTS
323 Define this macro as a C expression for the initializer of an array of
324 string to tell the driver program which options are defaults for this
325 target and thus do not need to be handled specially when using
326 @code{MULTILIB_OPTIONS}.
328 Do not define this macro if @code{MULTILIB_OPTIONS} is not defined in
329 the target makefile fragment or if none of the options listed in
330 @code{MULTILIB_OPTIONS} are set by default.
331 @xref{Target Fragment}.
333 @findex RELATIVE_PREFIX_NOT_LINKDIR
334 @item RELATIVE_PREFIX_NOT_LINKDIR
335 Define this macro to tell @code{gcc} that it should only translate
336 a @samp{-B} prefix into a @samp{-L} linker option if the prefix
337 indicates an absolute file name.
339 @findex STANDARD_EXEC_PREFIX
340 @item STANDARD_EXEC_PREFIX
341 Define this macro as a C string constant if you wish to override the
342 standard choice of @file{/usr/local/lib/gcc-lib/} as the default prefix to
343 try when searching for the executable files of the compiler.
345 @findex MD_EXEC_PREFIX
346 @item MD_EXEC_PREFIX
347 If defined, this macro is an additional prefix to try after
348 @code{STANDARD_EXEC_PREFIX}.  @code{MD_EXEC_PREFIX} is not searched
349 when the @samp{-b} option is used, or the compiler is built as a cross
350 compiler.  If you define @code{MD_EXEC_PREFIX}, then be sure to add it
351 to the list of directories used to find the assembler in @file{configure.in}.
353 @findex STANDARD_STARTFILE_PREFIX
354 @item STANDARD_STARTFILE_PREFIX
355 Define this macro as a C string constant if you wish to override the
356 standard choice of @file{/usr/local/lib/} as the default prefix to
357 try when searching for startup files such as @file{crt0.o}.
359 @findex MD_STARTFILE_PREFIX
360 @item MD_STARTFILE_PREFIX
361 If defined, this macro supplies an additional prefix to try after the
362 standard prefixes.  @code{MD_EXEC_PREFIX} is not searched when the
363 @samp{-b} option is used, or when the compiler is built as a cross
364 compiler.
366 @findex MD_STARTFILE_PREFIX_1
367 @item MD_STARTFILE_PREFIX_1
368 If defined, this macro supplies yet another prefix to try after the
369 standard prefixes.  It is not searched when the @samp{-b} option is
370 used, or when the compiler is built as a cross compiler.
372 @findex INIT_ENVIRONMENT
373 @item INIT_ENVIRONMENT
374 Define this macro as a C string constant if you wish to set environment
375 variables for programs called by the driver, such as the assembler and
376 loader.  The driver passes the value of this macro to @code{putenv} to
377 initialize the necessary environment variables.
379 @findex LOCAL_INCLUDE_DIR
380 @item LOCAL_INCLUDE_DIR
381 Define this macro as a C string constant if you wish to override the
382 standard choice of @file{/usr/local/include} as the default prefix to
383 try when searching for local header files.  @code{LOCAL_INCLUDE_DIR}
384 comes before @code{SYSTEM_INCLUDE_DIR} in the search order.
386 Cross compilers do not use this macro and do not search either
387 @file{/usr/local/include} or its replacement.
389 @findex MODIFY_TARGET_NAME
390 @item MODIFY_TARGET_NAME
391 Define this macro if you with to define command-line switches that modify the
392 default target name
394 For each switch, you can include a string to be appended to the first
395 part of the configuration name or a string to be deleted from the
396 configuration name, if present.  The definition should be an initializer
397 for an array of structures.  Each array element should have three
398 elements: the switch name (a string constant, including the initial
399 dash), one of the enumeration codes @code{ADD} or @code{DELETE} to
400 indicate whether the string should be inserted or deleted, and the string
401 to be inserted or deleted (a string constant).
403 For example, on a machine where @samp{64} at the end of the
404 configuration name denotes a 64-bit target and you want the @samp{-32}
405 and @samp{-64} switches to select between 32- and 64-bit targets, you would
406 code
408 @smallexample
409 #define MODIFY_TARGET_NAME \
410   @{ @{ "-32", DELETE, "64"@}, \
411      @{"-64", ADD, "64"@}@}
412 @end smallexample
415 @findex SYSTEM_INCLUDE_DIR
416 @item SYSTEM_INCLUDE_DIR
417 Define this macro as a C string constant if you wish to specify a
418 system-specific directory to search for header files before the standard
419 directory.  @code{SYSTEM_INCLUDE_DIR} comes before
420 @code{STANDARD_INCLUDE_DIR} in the search order.
422 Cross compilers do not use this macro and do not search the directory
423 specified.
425 @findex STANDARD_INCLUDE_DIR
426 @item STANDARD_INCLUDE_DIR
427 Define this macro as a C string constant if you wish to override the
428 standard choice of @file{/usr/include} as the default prefix to
429 try when searching for header files.
431 Cross compilers do not use this macro and do not search either
432 @file{/usr/include} or its replacement.
434 @findex STANDARD_INCLUDE_COMPONENT
435 @item STANDARD_INCLUDE_COMPONENT
436 The ``component'' corresponding to @code{STANDARD_INCLUDE_DIR}.
437 See @code{INCLUDE_DEFAULTS}, below, for the description of components.
438 If you do not define this macro, no component is used.
440 @findex INCLUDE_DEFAULTS
441 @item INCLUDE_DEFAULTS
442 Define this macro if you wish to override the entire default search path
443 for include files.  For a native compiler, the default search path
444 usually consists of @code{GCC_INCLUDE_DIR}, @code{LOCAL_INCLUDE_DIR},
445 @code{SYSTEM_INCLUDE_DIR}, @code{GPLUSPLUS_INCLUDE_DIR}, and
446 @code{STANDARD_INCLUDE_DIR}.  In addition, @code{GPLUSPLUS_INCLUDE_DIR}
447 and @code{GCC_INCLUDE_DIR} are defined automatically by @file{Makefile},
448 and specify private search areas for GCC.  The directory
449 @code{GPLUSPLUS_INCLUDE_DIR} is used only for C++ programs.
451 The definition should be an initializer for an array of structures.
452 Each array element should have four elements: the directory name (a
453 string constant), the component name (also a string constant), a flag
454 for C++-only directories,
455 and a flag showing that the includes in the directory don't need to be
456 wrapped in @code{extern @samp{C}} when compiling C++.  Mark the end of
457 the array with a null element.
459 The component name denotes what GNU package the include file is part of,
460 if any, in all upper-case letters.  For example, it might be @samp{GCC}
461 or @samp{BINUTILS}.  If the package is part of a vendor-supplied
462 operating system, code the component name as @samp{0}.
464 For example, here is the definition used for VAX/VMS:
466 @example
467 #define INCLUDE_DEFAULTS \
468 @{                                       \
469   @{ "GNU_GXX_INCLUDE:", "G++", 1, 1@},   \
470   @{ "GNU_CC_INCLUDE:", "GCC", 0, 0@},    \
471   @{ "SYS$SYSROOT:[SYSLIB.]", 0, 0, 0@},  \
472   @{ ".", 0, 0, 0@},                      \
473   @{ 0, 0, 0, 0@}                         \
475 @end example
476 @end table
478 Here is the order of prefixes tried for exec files:
480 @enumerate
481 @item
482 Any prefixes specified by the user with @samp{-B}.
484 @item
485 The environment variable @code{GCC_EXEC_PREFIX}, if any.
487 @item
488 The directories specified by the environment variable @code{COMPILER_PATH}.
490 @item
491 The macro @code{STANDARD_EXEC_PREFIX}.
493 @item
494 @file{/usr/lib/gcc/}.
496 @item
497 The macro @code{MD_EXEC_PREFIX}, if any.
498 @end enumerate
500 Here is the order of prefixes tried for startfiles:
502 @enumerate
503 @item
504 Any prefixes specified by the user with @samp{-B}.
506 @item
507 The environment variable @code{GCC_EXEC_PREFIX}, if any.
509 @item
510 The directories specified by the environment variable @code{LIBRARY_PATH}
511 (or port-specific name; native only, cross compilers do not use this).
513 @item
514 The macro @code{STANDARD_EXEC_PREFIX}.
516 @item
517 @file{/usr/lib/gcc/}.
519 @item
520 The macro @code{MD_EXEC_PREFIX}, if any.
522 @item
523 The macro @code{MD_STARTFILE_PREFIX}, if any.
525 @item
526 The macro @code{STANDARD_STARTFILE_PREFIX}.
528 @item
529 @file{/lib/}.
531 @item
532 @file{/usr/lib/}.
533 @end enumerate
535 @node Run-time Target
536 @section Run-time Target Specification
537 @cindex run-time target specification
538 @cindex predefined macros
539 @cindex target specifications
541 @c prevent bad page break with this line
542 Here are run-time target specifications.
544 @table @code
545 @findex CPP_PREDEFINES
546 @item CPP_PREDEFINES
547 Define this to be a string constant containing @samp{-D} options to
548 define the predefined macros that identify this machine and system.
549 These macros will be predefined unless the @samp{-ansi} option is
550 specified.
552 In addition, a parallel set of macros are predefined, whose names are
553 made by appending @samp{__} at the beginning and at the end.  These
554 @samp{__} macros are permitted by the ANSI standard, so they are
555 predefined regardless of whether @samp{-ansi} is specified.
557 For example, on the Sun, one can use the following value:
559 @smallexample
560 "-Dmc68000 -Dsun -Dunix"
561 @end smallexample
563 The result is to define the macros @code{__mc68000__}, @code{__sun__}
564 and @code{__unix__} unconditionally, and the macros @code{mc68000},
565 @code{sun} and @code{unix} provided @samp{-ansi} is not specified.
567 @findex extern int target_flags
568 @item extern int target_flags;
569 This declaration should be present.
571 @cindex optional hardware or system features
572 @cindex features, optional, in system conventions
573 @item TARGET_@dots{}
574 This series of macros is to allow compiler command arguments to
575 enable or disable the use of optional features of the target machine.
576 For example, one machine description serves both the 68000 and
577 the 68020; a command argument tells the compiler whether it should
578 use 68020-only instructions or not.  This command argument works
579 by means of a macro @code{TARGET_68020} that tests a bit in
580 @code{target_flags}.
582 Define a macro @code{TARGET_@var{featurename}} for each such option.
583 Its definition should test a bit in @code{target_flags}.  It is
584 recommended that a helper macro @code{TARGET_MASK_@var{featurename}}
585 is defined for each bit-value to test, and used in
586 @code{TARGET_@var{featurename}} and @code{TARGET_SWITCHES}.  For
587 example:
589 @smallexample
590 #define TARGET_MASK_68020 1
591 #define TARGET_68020 (target_flags & TARGET_MASK_68020)
592 @end smallexample
594 One place where these macros are used is in the condition-expressions
595 of instruction patterns.  Note how @code{TARGET_68020} appears
596 frequently in the 68000 machine description file, @file{m68k.md}.
597 Another place they are used is in the definitions of the other
598 macros in the @file{@var{machine}.h} file.
600 @findex TARGET_SWITCHES
601 @item TARGET_SWITCHES
602 This macro defines names of command options to set and clear
603 bits in @code{target_flags}.  Its definition is an initializer
604 with a subgrouping for each command option.
606 Each subgrouping contains a string constant, that defines the option
607 name, a number, which contains the bits to set in
608 @code{target_flags}, and a second string which is the description
609 displayed by --help.  If the number is negative then the bits specified
610 by the number are cleared instead of being set.  If the description
611 string is present but empty, then no help information will be displayed
612 for that option, but it will not count as an undocumented option.  The
613 actual option name is made by appending @samp{-m} to the specified name.
615 One of the subgroupings should have a null string.  The number in
616 this grouping is the default value for @code{target_flags}.  Any
617 target options act starting with that value.
619 Here is an example which defines @samp{-m68000} and @samp{-m68020}
620 with opposite meanings, and picks the latter as the default:
622 @smallexample
623 #define TARGET_SWITCHES \
624   @{ @{ "68020", TARGET_MASK_68020, "" @},      \
625     @{ "68000", -TARGET_MASK_68020, "Compile for the 68000" @}, \
626     @{ "", TARGET_MASK_68020, "" @}@}
627 @end smallexample
629 @findex TARGET_OPTIONS
630 @item TARGET_OPTIONS
631 This macro is similar to @code{TARGET_SWITCHES} but defines names of command
632 options that have values.  Its definition is an initializer with a
633 subgrouping for each command option.
635 Each subgrouping contains a string constant, that defines the fixed part
636 of the option name, the address of a variable, and a description string.
637 The variable, type @code{char *}, is set to the variable part of the
638 given option if the fixed part matches.  The actual option name is made
639 by appending @samp{-m} to the specified name.
641 Here is an example which defines @samp{-mshort-data-@var{number}}.  If the
642 given option is @samp{-mshort-data-512}, the variable @code{m88k_short_data}
643 will be set to the string @code{"512"}.
645 @smallexample
646 extern char *m88k_short_data;
647 #define TARGET_OPTIONS \
648  @{ @{ "short-data-", &m88k_short_data, "Specify the size of the short data section" @} @}
649 @end smallexample
651 @findex TARGET_VERSION
652 @item TARGET_VERSION
653 This macro is a C statement to print on @code{stderr} a string
654 describing the particular machine description choice.  Every machine
655 description should define @code{TARGET_VERSION}.  For example:
657 @smallexample
658 #ifdef MOTOROLA
659 #define TARGET_VERSION \
660   fprintf (stderr, " (68k, Motorola syntax)");
661 #else
662 #define TARGET_VERSION \
663   fprintf (stderr, " (68k, MIT syntax)");
664 #endif
665 @end smallexample
667 @findex OVERRIDE_OPTIONS
668 @item OVERRIDE_OPTIONS
669 Sometimes certain combinations of command options do not make sense on
670 a particular target machine.  You can define a macro
671 @code{OVERRIDE_OPTIONS} to take account of this.  This macro, if
672 defined, is executed once just after all the command options have been
673 parsed.
675 Don't use this macro to turn on various extra optimizations for
676 @samp{-O}.  That is what @code{OPTIMIZATION_OPTIONS} is for.
678 @findex OPTIMIZATION_OPTIONS
679 @item OPTIMIZATION_OPTIONS (@var{level}, @var{size})
680 Some machines may desire to change what optimizations are performed for
681 various optimization levels.   This macro, if defined, is executed once
682 just after the optimization level is determined and before the remainder
683 of the command options have been parsed.  Values set in this macro are
684 used as the default values for the other command line options.
686 @var{level} is the optimization level specified; 2 if @samp{-O2} is
687 specified, 1 if @samp{-O} is specified, and 0 if neither is specified.
689 @var{size} is non-zero if @samp{-Os} is specified and zero otherwise.
691 You should not use this macro to change options that are not
692 machine-specific.  These should uniformly selected by the same
693 optimization level on all supported machines.  Use this macro to enable
694 machine-specific optimizations.
696 @strong{Do not examine @code{write_symbols} in
697 this macro!} The debugging options are not supposed to alter the
698 generated code.
700 @findex CAN_DEBUG_WITHOUT_FP
701 @item CAN_DEBUG_WITHOUT_FP
702 Define this macro if debugging can be performed even without a frame
703 pointer.  If this macro is defined, GCC will turn on the
704 @samp{-fomit-frame-pointer} option whenever @samp{-O} is specified.
705 @end table
707 @node Storage Layout
708 @section Storage Layout
709 @cindex storage layout
711 Note that the definitions of the macros in this table which are sizes or
712 alignments measured in bits do not need to be constant.  They can be C
713 expressions that refer to static variables, such as the @code{target_flags}.
714 @xref{Run-time Target}.
716 @table @code
717 @findex BITS_BIG_ENDIAN
718 @item BITS_BIG_ENDIAN
719 Define this macro to have the value 1 if the most significant bit in a
720 byte has the lowest number; otherwise define it to have the value zero.
721 This means that bit-field instructions count from the most significant
722 bit.  If the machine has no bit-field instructions, then this must still
723 be defined, but it doesn't matter which value it is defined to.  This
724 macro need not be a constant.
726 This macro does not affect the way structure fields are packed into
727 bytes or words; that is controlled by @code{BYTES_BIG_ENDIAN}.
729 @findex BYTES_BIG_ENDIAN
730 @item BYTES_BIG_ENDIAN
731 Define this macro to have the value 1 if the most significant byte in a
732 word has the lowest number.  This macro need not be a constant.
734 @findex WORDS_BIG_ENDIAN
735 @item WORDS_BIG_ENDIAN
736 Define this macro to have the value 1 if, in a multiword object, the
737 most significant word has the lowest number.  This applies to both
738 memory locations and registers; GCC fundamentally assumes that the
739 order of words in memory is the same as the order in registers.  This
740 macro need not be a constant.
742 @findex LIBGCC2_WORDS_BIG_ENDIAN
743 @item LIBGCC2_WORDS_BIG_ENDIAN
744 Define this macro if WORDS_BIG_ENDIAN is not constant.  This must be a
745 constant value with the same meaning as WORDS_BIG_ENDIAN, which will be
746 used only when compiling libgcc2.c.  Typically the value will be set
747 based on preprocessor defines.
749 @findex FLOAT_WORDS_BIG_ENDIAN
750 @item FLOAT_WORDS_BIG_ENDIAN
751 Define this macro to have the value 1 if @code{DFmode}, @code{XFmode} or
752 @code{TFmode} floating point numbers are stored in memory with the word
753 containing the sign bit at the lowest address; otherwise define it to
754 have the value 0.  This macro need not be a constant.
756 You need not define this macro if the ordering is the same as for
757 multi-word integers.
759 @findex BITS_PER_UNIT
760 @item BITS_PER_UNIT
761 Define this macro to be the number of bits in an addressable storage
762 unit (byte); normally 8.
764 @findex BITS_PER_WORD
765 @item BITS_PER_WORD
766 Number of bits in a word; normally 32.
768 @findex MAX_BITS_PER_WORD
769 @item MAX_BITS_PER_WORD
770 Maximum number of bits in a word.  If this is undefined, the default is
771 @code{BITS_PER_WORD}.  Otherwise, it is the constant value that is the
772 largest value that @code{BITS_PER_WORD} can have at run-time.
774 @findex UNITS_PER_WORD
775 @item UNITS_PER_WORD
776 Number of storage units in a word; normally 4.
778 @findex MIN_UNITS_PER_WORD
779 @item MIN_UNITS_PER_WORD
780 Minimum number of units in a word.  If this is undefined, the default is
781 @code{UNITS_PER_WORD}.  Otherwise, it is the constant value that is the
782 smallest value that @code{UNITS_PER_WORD} can have at run-time.
784 @findex POINTER_SIZE
785 @item POINTER_SIZE
786 Width of a pointer, in bits.  You must specify a value no wider than the
787 width of @code{Pmode}.  If it is not equal to the width of @code{Pmode},
788 you must define @code{POINTERS_EXTEND_UNSIGNED}.
790 @findex POINTERS_EXTEND_UNSIGNED
791 @item POINTERS_EXTEND_UNSIGNED
792 A C expression whose value is nonzero if pointers that need to be
793 extended from being @code{POINTER_SIZE} bits wide to @code{Pmode} are to
794 be zero-extended and zero if they are to be sign-extended.
796 You need not define this macro if the @code{POINTER_SIZE} is equal
797 to the width of @code{Pmode}.
799 @findex PROMOTE_MODE
800 @item PROMOTE_MODE (@var{m}, @var{unsignedp}, @var{type})
801 A macro to update @var{m} and @var{unsignedp} when an object whose type
802 is @var{type} and which has the specified mode and signedness is to be
803 stored in a register.  This macro is only called when @var{type} is a
804 scalar type.
806 On most RISC machines, which only have operations that operate on a full
807 register, define this macro to set @var{m} to @code{word_mode} if
808 @var{m} is an integer mode narrower than @code{BITS_PER_WORD}.  In most
809 cases, only integer modes should be widened because wider-precision
810 floating-point operations are usually more expensive than their narrower
811 counterparts.
813 For most machines, the macro definition does not change @var{unsignedp}.
814 However, some machines, have instructions that preferentially handle
815 either signed or unsigned quantities of certain modes.  For example, on
816 the DEC Alpha, 32-bit loads from memory and 32-bit add instructions
817 sign-extend the result to 64 bits.  On such machines, set
818 @var{unsignedp} according to which kind of extension is more efficient.
820 Do not define this macro if it would never modify @var{m}.
822 @findex PROMOTE_FUNCTION_ARGS
823 @item PROMOTE_FUNCTION_ARGS
824 Define this macro if the promotion described by @code{PROMOTE_MODE}
825 should also be done for outgoing function arguments.
827 @findex PROMOTE_FUNCTION_RETURN
828 @item PROMOTE_FUNCTION_RETURN
829 Define this macro if the promotion described by @code{PROMOTE_MODE}
830 should also be done for the return value of functions.
832 If this macro is defined, @code{FUNCTION_VALUE} must perform the same
833 promotions done by @code{PROMOTE_MODE}.
835 @findex PROMOTE_FOR_CALL_ONLY
836 @item PROMOTE_FOR_CALL_ONLY
837 Define this macro if the promotion described by @code{PROMOTE_MODE}
838 should @emph{only} be performed for outgoing function arguments or
839 function return values, as specified by @code{PROMOTE_FUNCTION_ARGS}
840 and @code{PROMOTE_FUNCTION_RETURN}, respectively.
842 @findex PARM_BOUNDARY
843 @item PARM_BOUNDARY
844 Normal alignment required for function parameters on the stack, in
845 bits.  All stack parameters receive at least this much alignment
846 regardless of data type.  On most machines, this is the same as the
847 size of an integer.
849 @findex STACK_BOUNDARY
850 @item STACK_BOUNDARY
851 Define this macro if there is a guaranteed alignment for the stack
852 pointer on this machine.  The definition is a C expression
853 for the desired alignment (measured in bits).  This value is used as a
854 default if PREFERRED_STACK_BOUNDARY is not defined.
856 @findex PREFERRED_STACK_BOUNDARY
857 @item PREFERRED_STACK_BOUNDARY
858 Define this macro if you wish to preserve a certain alignment for
859 the stack pointer.  The definition is a C expression
860 for the desired alignment (measured in bits).  If STACK_BOUNDARY is
861 also defined, this macro must evaluate to a value equal to or larger
862 than STACK_BOUNDARY.
864 @cindex @code{PUSH_ROUNDING}, interaction with @code{PREFERRED_STACK_BOUNDARY}
865 If @code{PUSH_ROUNDING} is not defined, the stack will always be aligned
866 to the specified boundary.  If @code{PUSH_ROUNDING} is defined and specifies
867 a less strict alignment than @code{PREFERRED_STACK_BOUNDARY}, the stack may
868 be momentarily unaligned while pushing arguments.
870 @findex FUNCTION_BOUNDARY
871 @item FUNCTION_BOUNDARY
872 Alignment required for a function entry point, in bits.
874 @findex BIGGEST_ALIGNMENT
875 @item BIGGEST_ALIGNMENT
876 Biggest alignment that any data type can require on this machine, in bits.
878 @findex MINIMUM_ATOMIC_ALIGNMENT
879 @item MINIMUM_ATOMIC_ALIGNMENT
880 If defined, the smallest alignment, in bits, that can be given to an
881 object that can be referenced in one operation, without disturbing any
882 nearby object.  Normally, this is @code{BITS_PER_UNIT}, but may be larger
883 on machines that don't have byte or half-word store operations.
885 @findex BIGGEST_FIELD_ALIGNMENT
886 @item BIGGEST_FIELD_ALIGNMENT
887 Biggest alignment that any structure or union field can require on this
888 machine, in bits.  If defined, this overrides @code{BIGGEST_ALIGNMENT} for
889 structure and union fields only, unless the field alignment has been set
890 by the @code{__attribute__ ((aligned (@var{n})))} construct.
892 @findex ADJUST_FIELD_ALIGN
893 @item ADJUST_FIELD_ALIGN (@var{field}, @var{computed})
894 An expression for the alignment of a structure field @var{field} if the
895 alignment computed in the usual way is @var{computed}.  GCC uses
896 this value instead of the value in @code{BIGGEST_ALIGNMENT} or
897 @code{BIGGEST_FIELD_ALIGNMENT}, if defined, for structure fields only.
899 @findex MAX_OFILE_ALIGNMENT
900 @item MAX_OFILE_ALIGNMENT
901 Biggest alignment supported by the object file format of this machine.
902 Use this macro to limit the alignment which can be specified using the
903 @code{__attribute__ ((aligned (@var{n})))} construct.  If not defined,
904 the default value is @code{BIGGEST_ALIGNMENT}.
906 @findex DATA_ALIGNMENT
907 @item DATA_ALIGNMENT (@var{type}, @var{basic-align})
908 If defined, a C expression to compute the alignment for a variables in
909 the static store.  @var{type} is the data type, and @var{basic-align} is
910 the alignment that the object would ordinarily have.  The value of this
911 macro is used instead of that alignment to align the object.
913 If this macro is not defined, then @var{basic-align} is used.
915 @findex strcpy
916 One use of this macro is to increase alignment of medium-size data to
917 make it all fit in fewer cache lines.  Another is to cause character
918 arrays to be word-aligned so that @code{strcpy} calls that copy
919 constants to character arrays can be done inline.
921 @findex CONSTANT_ALIGNMENT
922 @item CONSTANT_ALIGNMENT (@var{constant}, @var{basic-align})
923 If defined, a C expression to compute the alignment given to a constant
924 that is being placed in memory.  @var{constant} is the constant and
925 @var{basic-align} is the alignment that the object would ordinarily
926 have.  The value of this macro is used instead of that alignment to
927 align the object.
929 If this macro is not defined, then @var{basic-align} is used.
931 The typical use of this macro is to increase alignment for string
932 constants to be word aligned so that @code{strcpy} calls that copy
933 constants can be done inline.
935 @findex LOCAL_ALIGNMENT
936 @item LOCAL_ALIGNMENT (@var{type}, @var{basic-align})
937 If defined, a C expression to compute the alignment for a variables in
938 the local store.  @var{type} is the data type, and @var{basic-align} is
939 the alignment that the object would ordinarily have.  The value of this
940 macro is used instead of that alignment to align the object.
942 If this macro is not defined, then @var{basic-align} is used.
944 One use of this macro is to increase alignment of medium-size data to
945 make it all fit in fewer cache lines.
947 @findex EMPTY_FIELD_BOUNDARY
948 @item EMPTY_FIELD_BOUNDARY
949 Alignment in bits to be given to a structure bit field that follows an
950 empty field such as @code{int : 0;}.
952 Note that @code{PCC_BITFIELD_TYPE_MATTERS} also affects the alignment
953 that results from an empty field.
955 @findex STRUCTURE_SIZE_BOUNDARY
956 @item STRUCTURE_SIZE_BOUNDARY
957 Number of bits which any structure or union's size must be a multiple of.
958 Each structure or union's size is rounded up to a multiple of this.
960 If you do not define this macro, the default is the same as
961 @code{BITS_PER_UNIT}.
963 @findex STRICT_ALIGNMENT
964 @item STRICT_ALIGNMENT
965 Define this macro to be the value 1 if instructions will fail to work
966 if given data not on the nominal alignment.  If instructions will merely
967 go slower in that case, define this macro as 0.
969 @findex PCC_BITFIELD_TYPE_MATTERS
970 @item PCC_BITFIELD_TYPE_MATTERS
971 Define this if you wish to imitate the way many other C compilers handle
972 alignment of bitfields and the structures that contain them.
974 The behavior is that the type written for a bitfield (@code{int},
975 @code{short}, or other integer type) imposes an alignment for the
976 entire structure, as if the structure really did contain an ordinary
977 field of that type.  In addition, the bitfield is placed within the
978 structure so that it would fit within such a field, not crossing a
979 boundary for it.
981 Thus, on most machines, a bitfield whose type is written as @code{int}
982 would not cross a four-byte boundary, and would force four-byte
983 alignment for the whole structure.  (The alignment used may not be four
984 bytes; it is controlled by the other alignment parameters.)
986 If the macro is defined, its definition should be a C expression;
987 a nonzero value for the expression enables this behavior.
989 Note that if this macro is not defined, or its value is zero, some
990 bitfields may cross more than one alignment boundary.  The compiler can
991 support such references if there are @samp{insv}, @samp{extv}, and
992 @samp{extzv} insns that can directly reference memory.
994 The other known way of making bitfields work is to define
995 @code{STRUCTURE_SIZE_BOUNDARY} as large as @code{BIGGEST_ALIGNMENT}.
996 Then every structure can be accessed with fullwords.
998 Unless the machine has bitfield instructions or you define
999 @code{STRUCTURE_SIZE_BOUNDARY} that way, you must define
1000 @code{PCC_BITFIELD_TYPE_MATTERS} to have a nonzero value.
1002 If your aim is to make GCC use the same conventions for laying out
1003 bitfields as are used by another compiler, here is how to investigate
1004 what the other compiler does.  Compile and run this program:
1006 @example
1007 struct foo1
1009   char x;
1010   char :0;
1011   char y;
1014 struct foo2
1016   char x;
1017   int :0;
1018   char y;
1021 main ()
1023   printf ("Size of foo1 is %d\n",
1024           sizeof (struct foo1));
1025   printf ("Size of foo2 is %d\n",
1026           sizeof (struct foo2));
1027   exit (0);
1029 @end example
1031 If this prints 2 and 5, then the compiler's behavior is what you would
1032 get from @code{PCC_BITFIELD_TYPE_MATTERS}.
1034 @findex BITFIELD_NBYTES_LIMITED
1035 @item BITFIELD_NBYTES_LIMITED
1036 Like PCC_BITFIELD_TYPE_MATTERS except that its effect is limited to
1037 aligning a bitfield within the structure.
1039 @findex STRUCT_FORCE_BLK
1040 @item STRUCT_FORCE_BLK (@var{field})
1041 Return 1 if a structure containing @var{field} should be accessed using
1042 @code{BLKMODE}.
1044 Normally, this is not needed.  See the file @file{c4x.h} for an example
1045 of how to use this macro to prevent a structure having a floating point
1046 field from being accessed in an integer mode.
1048 @findex ROUND_TYPE_SIZE
1049 @item ROUND_TYPE_SIZE (@var{type}, @var{computed}, @var{specified})
1050 Define this macro as an expression for the overall size of a type
1051 (given by @var{type} as a tree node) when the size computed in the
1052 usual way is @var{computed} and the alignment is @var{specified}.
1054 The default is to round @var{computed} up to a multiple of @var{specified}.
1056 @findex ROUND_TYPE_SIZE_UNIT
1057 @item ROUND_TYPE_SIZE_UNIT (@var{type}, @var{computed}, @var{specified})
1058 Similar to @code{ROUND_TYPE_SIZE}, but sizes and alignments are
1059 specified in units (bytes).  If you define @code{ROUND_TYPE_SIZE},
1060 you must also define this macro and they must be defined consistently
1061 with each other.
1063 @findex ROUND_TYPE_ALIGN
1064 @item ROUND_TYPE_ALIGN (@var{type}, @var{computed}, @var{specified})
1065 Define this macro as an expression for the alignment of a type (given
1066 by @var{type} as a tree node) if the alignment computed in the usual
1067 way is @var{computed} and the alignment explicitly specified was
1068 @var{specified}.
1070 The default is to use @var{specified} if it is larger; otherwise, use
1071 the smaller of @var{computed} and @code{BIGGEST_ALIGNMENT}
1073 @findex MAX_FIXED_MODE_SIZE
1074 @item MAX_FIXED_MODE_SIZE
1075 An integer expression for the size in bits of the largest integer
1076 machine mode that should actually be used.  All integer machine modes of
1077 this size or smaller can be used for structures and unions with the
1078 appropriate sizes.  If this macro is undefined, @code{GET_MODE_BITSIZE
1079 (DImode)} is assumed.
1081 @findex VECTOR_MODE_SUPPORTED_P
1082 @item VECTOR_MODE_SUPPORTED_P(@var{mode})
1083 Define this macro to be nonzero if the port is prepared to handle insns
1084 involving vector mode @var{mode}.  At the very least, it must have move
1085 patterns for this mode.
1087 @findex STACK_SAVEAREA_MODE
1088 @item STACK_SAVEAREA_MODE (@var{save_level})
1089 If defined, an expression of type @code{enum machine_mode} that
1090 specifies the mode of the save area operand of a
1091 @code{save_stack_@var{level}} named pattern (@pxref{Standard Names}).
1092 @var{save_level} is one of @code{SAVE_BLOCK}, @code{SAVE_FUNCTION}, or
1093 @code{SAVE_NONLOCAL} and selects which of the three named patterns is
1094 having its mode specified.
1096 You need not define this macro if it always returns @code{Pmode}.  You
1097 would most commonly define this macro if the
1098 @code{save_stack_@var{level}} patterns need to support both a 32- and a
1099 64-bit mode.
1101 @findex STACK_SIZE_MODE
1102 @item STACK_SIZE_MODE
1103 If defined, an expression of type @code{enum machine_mode} that
1104 specifies the mode of the size increment operand of an
1105 @code{allocate_stack} named pattern (@pxref{Standard Names}).
1107 You need not define this macro if it always returns @code{word_mode}.
1108 You would most commonly define this macro if the @code{allocate_stack}
1109 pattern needs to support both a 32- and a 64-bit mode.
1111 @findex CHECK_FLOAT_VALUE
1112 @item CHECK_FLOAT_VALUE (@var{mode}, @var{value}, @var{overflow})
1113 A C statement to validate the value @var{value} (of type
1114 @code{double}) for mode @var{mode}.  This means that you check whether
1115 @var{value} fits within the possible range of values for mode
1116 @var{mode} on this target machine.  The mode @var{mode} is always
1117 a mode of class @code{MODE_FLOAT}.  @var{overflow} is nonzero if
1118 the value is already known to be out of range.
1120 If @var{value} is not valid or if @var{overflow} is nonzero, you should
1121 set @var{overflow} to 1 and then assign some valid value to @var{value}.
1122 Allowing an invalid value to go through the compiler can produce
1123 incorrect assembler code which may even cause Unix assemblers to crash.
1125 This macro need not be defined if there is no work for it to do.
1127 @findex TARGET_FLOAT_FORMAT
1128 @item TARGET_FLOAT_FORMAT
1129 A code distinguishing the floating point format of the target machine.
1130 There are three defined values:
1132 @table @code
1133 @findex IEEE_FLOAT_FORMAT
1134 @item IEEE_FLOAT_FORMAT
1135 This code indicates IEEE floating point.  It is the default; there is no
1136 need to define this macro when the format is IEEE.
1138 @findex VAX_FLOAT_FORMAT
1139 @item VAX_FLOAT_FORMAT
1140 This code indicates the peculiar format used on the Vax.
1142 @findex UNKNOWN_FLOAT_FORMAT
1143 @item UNKNOWN_FLOAT_FORMAT
1144 This code indicates any other format.
1145 @end table
1147 The value of this macro is compared with @code{HOST_FLOAT_FORMAT}
1148 (@pxref{Config}) to determine whether the target machine has the same
1149 format as the host machine.  If any other formats are actually in use on
1150 supported machines, new codes should be defined for them.
1152 The ordering of the component words of floating point values stored in
1153 memory is controlled by @code{FLOAT_WORDS_BIG_ENDIAN} for the target
1154 machine and @code{HOST_FLOAT_WORDS_BIG_ENDIAN} for the host.
1156 @findex DEFAULT_VTABLE_THUNKS
1157 @item DEFAULT_VTABLE_THUNKS
1158 GCC supports two ways of implementing C++ vtables:  traditional or with
1159 so-called ``thunks''.  The flag @samp{-fvtable-thunk} chooses between them.
1160 Define this macro to be a C expression for the default value of that flag.
1161 If @code{DEFAULT_VTABLE_THUNKS} is 0, GCC uses the traditional
1162 implementation by default.  The ``thunk'' implementation is more efficient
1163 (especially if you have provided an implementation of
1164 @code{ASM_OUTPUT_MI_THUNK}, see @ref{Function Entry}), but is not binary
1165 compatible with code compiled using the traditional implementation.  
1166 If you are writing a new port, define @code{DEFAULT_VTABLE_THUNKS} to 1.
1168 If you do not define this macro, the default for @samp{-fvtable-thunk} is 0.
1169 @end table
1171 @node Type Layout
1172 @section Layout of Source Language Data Types
1174 These macros define the sizes and other characteristics of the standard
1175 basic data types used in programs being compiled.  Unlike the macros in
1176 the previous section, these apply to specific features of C and related
1177 languages, rather than to fundamental aspects of storage layout.
1179 @table @code
1180 @findex INT_TYPE_SIZE
1181 @item INT_TYPE_SIZE
1182 A C expression for the size in bits of the type @code{int} on the
1183 target machine.  If you don't define this, the default is one word.
1185 @findex MAX_INT_TYPE_SIZE
1186 @item MAX_INT_TYPE_SIZE
1187 Maximum number for the size in bits of the type @code{int} on the target
1188 machine.  If this is undefined, the default is @code{INT_TYPE_SIZE}.
1189 Otherwise, it is the constant value that is the largest value that
1190 @code{INT_TYPE_SIZE} can have at run-time.  This is used in @code{cpp}.
1192 @findex SHORT_TYPE_SIZE
1193 @item SHORT_TYPE_SIZE
1194 A C expression for the size in bits of the type @code{short} on the
1195 target machine.  If you don't define this, the default is half a word.
1196 (If this would be less than one storage unit, it is rounded up to one
1197 unit.)
1199 @findex LONG_TYPE_SIZE
1200 @item LONG_TYPE_SIZE
1201 A C expression for the size in bits of the type @code{long} on the
1202 target machine.  If you don't define this, the default is one word.
1204 @findex MAX_LONG_TYPE_SIZE
1205 @item MAX_LONG_TYPE_SIZE
1206 Maximum number for the size in bits of the type @code{long} on the
1207 target machine.  If this is undefined, the default is
1208 @code{LONG_TYPE_SIZE}.  Otherwise, it is the constant value that is the
1209 largest value that @code{LONG_TYPE_SIZE} can have at run-time.  This is
1210 used in @code{cpp}.
1212 @findex LONG_LONG_TYPE_SIZE
1213 @item LONG_LONG_TYPE_SIZE
1214 A C expression for the size in bits of the type @code{long long} on the
1215 target machine.  If you don't define this, the default is two
1216 words.  If you want to support GNU Ada on your machine, the value of this
1217 macro must be at least 64.
1219 @findex CHAR_TYPE_SIZE
1220 @item CHAR_TYPE_SIZE
1221 A C expression for the size in bits of the type @code{char} on the
1222 target machine.  If you don't define this, the default is
1223 @code{BITS_PER_UNIT}.
1225 @findex MAX_CHAR_TYPE_SIZE
1226 @item MAX_CHAR_TYPE_SIZE
1227 Maximum number for the size in bits of the type @code{char} on the
1228 target machine.  If this is undefined, the default is
1229 @code{CHAR_TYPE_SIZE}.  Otherwise, it is the constant value that is the
1230 largest value that @code{CHAR_TYPE_SIZE} can have at run-time.  This is
1231 used in @code{cpp}.
1233 @findex FLOAT_TYPE_SIZE
1234 @item FLOAT_TYPE_SIZE
1235 A C expression for the size in bits of the type @code{float} on the
1236 target machine.  If you don't define this, the default is one word.
1238 @findex DOUBLE_TYPE_SIZE
1239 @item DOUBLE_TYPE_SIZE
1240 A C expression for the size in bits of the type @code{double} on the
1241 target machine.  If you don't define this, the default is two
1242 words.
1244 @findex LONG_DOUBLE_TYPE_SIZE
1245 @item LONG_DOUBLE_TYPE_SIZE
1246 A C expression for the size in bits of the type @code{long double} on
1247 the target machine.  If you don't define this, the default is two
1248 words.
1250 @findex WIDEST_HARDWARE_FP_SIZE
1251 @item WIDEST_HARDWARE_FP_SIZE
1252 A C expression for the size in bits of the widest floating-point format
1253 supported by the hardware.  If you define this macro, you must specify a
1254 value less than or equal to the value of @code{LONG_DOUBLE_TYPE_SIZE}.
1255 If you do not define this macro, the value of @code{LONG_DOUBLE_TYPE_SIZE}
1256 is the default.
1258 @findex DEFAULT_SIGNED_CHAR
1259 @item DEFAULT_SIGNED_CHAR
1260 An expression whose value is 1 or 0, according to whether the type
1261 @code{char} should be signed or unsigned by default.  The user can
1262 always override this default with the options @samp{-fsigned-char}
1263 and @samp{-funsigned-char}.
1265 @findex DEFAULT_SHORT_ENUMS
1266 @item DEFAULT_SHORT_ENUMS
1267 A C expression to determine whether to give an @code{enum} type
1268 only as many bytes as it takes to represent the range of possible values
1269 of that type.  A nonzero value means to do that; a zero value means all
1270 @code{enum} types should be allocated like @code{int}.
1272 If you don't define the macro, the default is 0.
1274 @findex SIZE_TYPE
1275 @item SIZE_TYPE
1276 A C expression for a string describing the name of the data type to use
1277 for size values.  The typedef name @code{size_t} is defined using the
1278 contents of the string.
1280 The string can contain more than one keyword.  If so, separate them with
1281 spaces, and write first any length keyword, then @code{unsigned} if
1282 appropriate, and finally @code{int}.  The string must exactly match one
1283 of the data type names defined in the function
1284 @code{init_decl_processing} in the file @file{c-decl.c}.  You may not
1285 omit @code{int} or change the order---that would cause the compiler to
1286 crash on startup.
1288 If you don't define this macro, the default is @code{"long unsigned
1289 int"}.
1291 @findex PTRDIFF_TYPE
1292 @item PTRDIFF_TYPE
1293 A C expression for a string describing the name of the data type to use
1294 for the result of subtracting two pointers.  The typedef name
1295 @code{ptrdiff_t} is defined using the contents of the string.  See
1296 @code{SIZE_TYPE} above for more information.
1298 If you don't define this macro, the default is @code{"long int"}.
1300 @findex WCHAR_TYPE
1301 @item WCHAR_TYPE
1302 A C expression for a string describing the name of the data type to use
1303 for wide characters.  The typedef name @code{wchar_t} is defined using
1304 the contents of the string.  See @code{SIZE_TYPE} above for more
1305 information.
1307 If you don't define this macro, the default is @code{"int"}.
1309 @findex WCHAR_TYPE_SIZE
1310 @item WCHAR_TYPE_SIZE
1311 A C expression for the size in bits of the data type for wide
1312 characters.  This is used in @code{cpp}, which cannot make use of
1313 @code{WCHAR_TYPE}.
1315 @findex MAX_WCHAR_TYPE_SIZE
1316 @item MAX_WCHAR_TYPE_SIZE
1317 Maximum number for the size in bits of the data type for wide
1318 characters.  If this is undefined, the default is
1319 @code{WCHAR_TYPE_SIZE}.  Otherwise, it is the constant value that is the
1320 largest value that @code{WCHAR_TYPE_SIZE} can have at run-time.  This is
1321 used in @code{cpp}.
1323 @findex WINT_TYPE
1324 @item WINT_TYPE
1325 A C expression for a string describing the name of the data type to
1326 use for wide characters passed to @code{printf} and returned from
1327 @code{getwc}.  The typedef name @code{wint_t} is defined using the
1328 contents of the string.  See @code{SIZE_TYPE} above for more
1329 information.
1331 If you don't define this macro, the default is @code{"unsigned int"}.
1333 @findex INTMAX_TYPE
1334 @item INTMAX_TYPE
1335 A C expression for a string describing the name of the data type that
1336 can represent any value of any standard or extended signed integer type.
1337 The typedef name @code{intmax_t} is defined using the contents of the
1338 string.  See @code{SIZE_TYPE} above for more information.
1340 If you don't define this macro, the default is the first of
1341 @code{"int"}, @code{"long int"}, or @code{"long long int"} that has as
1342 much precision as @code{long long int}.
1344 @findex UINTMAX_TYPE
1345 @item UINTMAX_TYPE
1346 A C expression for a string describing the name of the data type that
1347 can represent any value of any standard or extended unsigned integer
1348 type.  The typedef name @code{uintmax_t} is defined using the contents
1349 of the string.  See @code{SIZE_TYPE} above for more information.
1351 If you don't define this macro, the default is the first of
1352 @code{"unsigned int"}, @code{"long unsigned int"}, or @code{"long long
1353 unsigned int"} that has as much precision as @code{long long unsigned
1354 int}.
1356 @findex OBJC_INT_SELECTORS
1357 @item OBJC_INT_SELECTORS
1358 Define this macro if the type of Objective C selectors should be
1359 @code{int}.
1361 If this macro is not defined, then selectors should have the type
1362 @code{struct objc_selector *}.
1364 @findex OBJC_SELECTORS_WITHOUT_LABELS
1365 @item OBJC_SELECTORS_WITHOUT_LABELS
1366 Define this macro if the compiler can group all the selectors together
1367 into a vector and use just one label at the beginning of the vector.
1368 Otherwise, the compiler must give each selector its own assembler
1369 label.
1371 On certain machines, it is important to have a separate label for each
1372 selector because this enables the linker to eliminate duplicate selectors.
1374 @findex TARGET_BELL
1375 @item TARGET_BELL
1376 A C constant expression for the integer value for escape sequence
1377 @samp{\a}.
1379 @findex TARGET_TAB
1380 @findex TARGET_BS
1381 @findex TARGET_NEWLINE
1382 @item TARGET_BS
1383 @itemx TARGET_TAB
1384 @itemx TARGET_NEWLINE
1385 C constant expressions for the integer values for escape sequences
1386 @samp{\b}, @samp{\t} and @samp{\n}.
1388 @findex TARGET_VT
1389 @findex TARGET_FF
1390 @findex TARGET_CR
1391 @item TARGET_VT
1392 @itemx TARGET_FF
1393 @itemx TARGET_CR
1394 C constant expressions for the integer values for escape sequences
1395 @samp{\v}, @samp{\f} and @samp{\r}.
1396 @end table
1398 @node Registers
1399 @section Register Usage
1400 @cindex register usage
1402 This section explains how to describe what registers the target machine
1403 has, and how (in general) they can be used.
1405 The description of which registers a specific instruction can use is
1406 done with register classes; see @ref{Register Classes}.  For information
1407 on using registers to access a stack frame, see @ref{Frame Registers}.
1408 For passing values in registers, see @ref{Register Arguments}.
1409 For returning values in registers, see @ref{Scalar Return}.
1411 @menu
1412 * Register Basics::             Number and kinds of registers.
1413 * Allocation Order::            Order in which registers are allocated.
1414 * Values in Registers::         What kinds of values each reg can hold.
1415 * Leaf Functions::              Renumbering registers for leaf functions.
1416 * Stack Registers::             Handling a register stack such as 80387.
1417 @end menu
1419 @node Register Basics
1420 @subsection Basic Characteristics of Registers
1422 @c prevent bad page break with this line
1423 Registers have various characteristics.
1425 @table @code
1426 @findex FIRST_PSEUDO_REGISTER
1427 @item FIRST_PSEUDO_REGISTER
1428 Number of hardware registers known to the compiler.  They receive
1429 numbers 0 through @code{FIRST_PSEUDO_REGISTER-1}; thus, the first
1430 pseudo register's number really is assigned the number
1431 @code{FIRST_PSEUDO_REGISTER}.
1433 @item FIXED_REGISTERS
1434 @findex FIXED_REGISTERS
1435 @cindex fixed register
1436 An initializer that says which registers are used for fixed purposes
1437 all throughout the compiled code and are therefore not available for
1438 general allocation.  These would include the stack pointer, the frame
1439 pointer (except on machines where that can be used as a general
1440 register when no frame pointer is needed), the program counter on
1441 machines where that is considered one of the addressable registers,
1442 and any other numbered register with a standard use.
1444 This information is expressed as a sequence of numbers, separated by
1445 commas and surrounded by braces.  The @var{n}th number is 1 if
1446 register @var{n} is fixed, 0 otherwise.
1448 The table initialized from this macro, and the table initialized by
1449 the following one, may be overridden at run time either automatically,
1450 by the actions of the macro @code{CONDITIONAL_REGISTER_USAGE}, or by
1451 the user with the command options @samp{-ffixed-@var{reg}},
1452 @samp{-fcall-used-@var{reg}} and @samp{-fcall-saved-@var{reg}}.
1454 @findex CALL_USED_REGISTERS
1455 @item CALL_USED_REGISTERS
1456 @cindex call-used register
1457 @cindex call-clobbered register
1458 @cindex call-saved register
1459 Like @code{FIXED_REGISTERS} but has 1 for each register that is
1460 clobbered (in general) by function calls as well as for fixed
1461 registers.  This macro therefore identifies the registers that are not
1462 available for general allocation of values that must live across
1463 function calls.
1465 If a register has 0 in @code{CALL_USED_REGISTERS}, the compiler
1466 automatically saves it on function entry and restores it on function
1467 exit, if the register is used within the function.
1469 @findex HARD_REGNO_CALL_PART_CLOBBERED
1470 @item HARD_REGNO_CALL_PART_CLOBBERED (@var{regno}, @var{mode})
1471 @cindex call-used register
1472 @cindex call-clobbered register
1473 @cindex call-saved register
1474 A C expression that is non-zero if it is not permissible to store a
1475 value of mode @var{mode} in hard register number @var{regno} across a
1476 call without some part of it being clobbered.  For most machines this
1477 macro need not be defined.  It is only required for machines that do not
1478 preserve the entire contents of a register across a call.
1480 @findex CONDITIONAL_REGISTER_USAGE
1481 @findex fixed_regs
1482 @findex call_used_regs
1483 @item CONDITIONAL_REGISTER_USAGE
1484 Zero or more C statements that may conditionally modify five variables
1485 @code{fixed_regs}, @code{call_used_regs}, @code{global_regs},
1486 (these three are of type @code{char []}), @code{reg_names} (of type
1487 @code{const char * []}) and @code{reg_class_contents} (of type
1488 @code{HARD_REG_SET}).
1489 Before the macro is called @code{fixed_regs}, @code{call_used_regs}
1490 @code{reg_class_contents} and @code{reg_names} have been initialized
1491 from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},
1492 @code{REG_CLASS_CONTENTS} and @code{REGISTER_NAMES}, respectively, 
1493 @code{global_regs} has been cleared, and any @samp{-ffixed-@var{reg}},
1494 @samp{-fcall-used-@var{reg}} and @samp{-fcall-saved-@var{reg}} command
1495 options have been applied.
1497 This is necessary in case the fixed or call-clobbered registers depend
1498 on target flags.
1500 You need not define this macro if it has no work to do.
1502 @cindex disabling certain registers
1503 @cindex controlling register usage
1504 If the usage of an entire class of registers depends on the target
1505 flags, you may indicate this to GCC by using this macro to modify
1506 @code{fixed_regs} and @code{call_used_regs} to 1 for each of the
1507 registers in the classes which should not be used by GCC.  Also define
1508 the macro @code{REG_CLASS_FROM_LETTER} to return @code{NO_REGS} if it
1509 is called with a letter for a class that shouldn't be used.
1511 (However, if this class is not included in @code{GENERAL_REGS} and all
1512 of the insn patterns whose constraints permit this class are
1513 controlled by target switches, then GCC will automatically avoid using
1514 these registers when the target switches are opposed to them.)
1516 @findex NON_SAVING_SETJMP
1517 @item NON_SAVING_SETJMP
1518 If this macro is defined and has a nonzero value, it means that
1519 @code{setjmp} and related functions fail to save the registers, or that
1520 @code{longjmp} fails to restore them.  To compensate, the compiler
1521 avoids putting variables in registers in functions that use
1522 @code{setjmp}.
1524 @findex INCOMING_REGNO
1525 @item INCOMING_REGNO (@var{out})
1526 Define this macro if the target machine has register windows.  This C
1527 expression returns the register number as seen by the called function
1528 corresponding to the register number @var{out} as seen by the calling
1529 function.  Return @var{out} if register number @var{out} is not an
1530 outbound register.
1532 @findex OUTGOING_REGNO
1533 @item OUTGOING_REGNO (@var{in})
1534 Define this macro if the target machine has register windows.  This C
1535 expression returns the register number as seen by the calling function
1536 corresponding to the register number @var{in} as seen by the called
1537 function.  Return @var{in} if register number @var{in} is not an inbound
1538 register.
1540 @findex LOCAL_REGNO
1541 @item LOCAL_REGNO (@var{regno})
1542 Define this macro if the target machine has register windows.  This C
1543 expression returns true if the register is call-saved but is in the
1544 register window.  Unlike most call-saved registers, such registers
1545 need not be explicitly restored on function exit or during non-local
1546 gotos.
1548 @ignore
1549 @findex PC_REGNUM
1550 @item PC_REGNUM
1551 If the program counter has a register number, define this as that
1552 register number.  Otherwise, do not define it.
1553 @end ignore
1554 @end table
1556 @node Allocation Order
1557 @subsection Order of Allocation of Registers
1558 @cindex order of register allocation
1559 @cindex register allocation order
1561 @c prevent bad page break with this line
1562 Registers are allocated in order.
1564 @table @code
1565 @findex REG_ALLOC_ORDER
1566 @item REG_ALLOC_ORDER
1567 If defined, an initializer for a vector of integers, containing the
1568 numbers of hard registers in the order in which GCC should prefer
1569 to use them (from most preferred to least).
1571 If this macro is not defined, registers are used lowest numbered first
1572 (all else being equal).
1574 One use of this macro is on machines where the highest numbered
1575 registers must always be saved and the save-multiple-registers
1576 instruction supports only sequences of consecutive registers.  On such
1577 machines, define @code{REG_ALLOC_ORDER} to be an initializer that lists
1578 the highest numbered allocable register first.
1580 @findex ORDER_REGS_FOR_LOCAL_ALLOC
1581 @item ORDER_REGS_FOR_LOCAL_ALLOC
1582 A C statement (sans semicolon) to choose the order in which to allocate
1583 hard registers for pseudo-registers local to a basic block.
1585 Store the desired register order in the array @code{reg_alloc_order}.
1586 Element 0 should be the register to allocate first; element 1, the next
1587 register; and so on.
1589 The macro body should not assume anything about the contents of
1590 @code{reg_alloc_order} before execution of the macro.
1592 On most machines, it is not necessary to define this macro.
1593 @end table
1595 @node Values in Registers
1596 @subsection How Values Fit in Registers
1598 This section discusses the macros that describe which kinds of values
1599 (specifically, which machine modes) each register can hold, and how many
1600 consecutive registers are needed for a given mode.
1602 @table @code
1603 @findex HARD_REGNO_NREGS
1604 @item HARD_REGNO_NREGS (@var{regno}, @var{mode})
1605 A C expression for the number of consecutive hard registers, starting
1606 at register number @var{regno}, required to hold a value of mode
1607 @var{mode}.
1609 On a machine where all registers are exactly one word, a suitable
1610 definition of this macro is
1612 @smallexample
1613 #define HARD_REGNO_NREGS(REGNO, MODE)            \
1614    ((GET_MODE_SIZE (MODE) + UNITS_PER_WORD - 1)  \
1615     / UNITS_PER_WORD)
1616 @end smallexample
1618 @findex ALTER_HARD_SUBREG
1619 @item ALTER_HARD_SUBREG (@var{tgt_mode}, @var{word}, @var{src_mode}, @var{regno})
1620 A C expression that returns an adjusted hard register number for 
1622 @smallexample
1623 (subreg:@var{tgt_mode} (reg:@var{src_mode} @var{regno}) @var{word})
1624 @end smallexample
1626 This may be needed if the target machine has mixed sized big-endian
1627 registers, like Sparc v9.
1629 @findex HARD_REGNO_MODE_OK
1630 @item HARD_REGNO_MODE_OK (@var{regno}, @var{mode})
1631 A C expression that is nonzero if it is permissible to store a value
1632 of mode @var{mode} in hard register number @var{regno} (or in several
1633 registers starting with that one).  For a machine where all registers
1634 are equivalent, a suitable definition is
1636 @smallexample
1637 #define HARD_REGNO_MODE_OK(REGNO, MODE) 1
1638 @end smallexample
1640 You need not include code to check for the numbers of fixed registers,
1641 because the allocation mechanism considers them to be always occupied.
1643 @cindex register pairs
1644 On some machines, double-precision values must be kept in even/odd
1645 register pairs.  You can implement that by defining this macro to reject
1646 odd register numbers for such modes.
1648 The minimum requirement for a mode to be OK in a register is that the
1649 @samp{mov@var{mode}} instruction pattern support moves between the
1650 register and other hard register in the same class and that moving a
1651 value into the register and back out not alter it.
1653 Since the same instruction used to move @code{word_mode} will work for
1654 all narrower integer modes, it is not necessary on any machine for
1655 @code{HARD_REGNO_MODE_OK} to distinguish between these modes, provided
1656 you define patterns @samp{movhi}, etc., to take advantage of this.  This
1657 is useful because of the interaction between @code{HARD_REGNO_MODE_OK}
1658 and @code{MODES_TIEABLE_P}; it is very desirable for all integer modes
1659 to be tieable.
1661 Many machines have special registers for floating point arithmetic.
1662 Often people assume that floating point machine modes are allowed only
1663 in floating point registers.  This is not true.  Any registers that
1664 can hold integers can safely @emph{hold} a floating point machine
1665 mode, whether or not floating arithmetic can be done on it in those
1666 registers.  Integer move instructions can be used to move the values.
1668 On some machines, though, the converse is true: fixed-point machine
1669 modes may not go in floating registers.  This is true if the floating
1670 registers normalize any value stored in them, because storing a
1671 non-floating value there would garble it.  In this case,
1672 @code{HARD_REGNO_MODE_OK} should reject fixed-point machine modes in
1673 floating registers.  But if the floating registers do not automatically
1674 normalize, if you can store any bit pattern in one and retrieve it
1675 unchanged without a trap, then any machine mode may go in a floating
1676 register, so you can define this macro to say so.
1678 The primary significance of special floating registers is rather that
1679 they are the registers acceptable in floating point arithmetic
1680 instructions.  However, this is of no concern to
1681 @code{HARD_REGNO_MODE_OK}.  You handle it by writing the proper
1682 constraints for those instructions.
1684 On some machines, the floating registers are especially slow to access,
1685 so that it is better to store a value in a stack frame than in such a
1686 register if floating point arithmetic is not being done.  As long as the
1687 floating registers are not in class @code{GENERAL_REGS}, they will not
1688 be used unless some pattern's constraint asks for one.
1690 @findex MODES_TIEABLE_P
1691 @item MODES_TIEABLE_P (@var{mode1}, @var{mode2})
1692 A C expression that is nonzero if a value of mode
1693 @var{mode1} is accessible in mode @var{mode2} without copying.
1695 If @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and
1696 @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always the same for
1697 any @var{r}, then @code{MODES_TIEABLE_P (@var{mode1}, @var{mode2})}
1698 should be nonzero.  If they differ for any @var{r}, you should define
1699 this macro to return zero unless some other mechanism ensures the
1700 accessibility of the value in a narrower mode.
1702 You should define this macro to return nonzero in as many cases as
1703 possible since doing so will allow GCC to perform better register
1704 allocation.
1706 @findex AVOID_CCMODE_COPIES
1707 @item AVOID_CCMODE_COPIES
1708 Define this macro if the compiler should avoid copies to/from @code{CCmode}
1709 registers.  You should only define this macro if support for copying to/from
1710 @code{CCmode} is incomplete.
1711 @end table
1713 @node Leaf Functions
1714 @subsection Handling Leaf Functions
1716 @cindex leaf functions
1717 @cindex functions, leaf
1718 On some machines, a leaf function (i.e., one which makes no calls) can run
1719 more efficiently if it does not make its own register window.  Often this
1720 means it is required to receive its arguments in the registers where they
1721 are passed by the caller, instead of the registers where they would
1722 normally arrive.
1724 The special treatment for leaf functions generally applies only when
1725 other conditions are met; for example, often they may use only those
1726 registers for its own variables and temporaries.  We use the term ``leaf
1727 function'' to mean a function that is suitable for this special
1728 handling, so that functions with no calls are not necessarily ``leaf
1729 functions''.
1731 GCC assigns register numbers before it knows whether the function is
1732 suitable for leaf function treatment.  So it needs to renumber the
1733 registers in order to output a leaf function.  The following macros
1734 accomplish this.
1736 @table @code
1737 @findex LEAF_REGISTERS
1738 @item LEAF_REGISTERS
1739 Name of a char vector, indexed by hard register number, which
1740 contains 1 for a register that is allowable in a candidate for leaf
1741 function treatment.
1743 If leaf function treatment involves renumbering the registers, then the
1744 registers marked here should be the ones before renumbering---those that
1745 GCC would ordinarily allocate.  The registers which will actually be
1746 used in the assembler code, after renumbering, should not be marked with 1
1747 in this vector.
1749 Define this macro only if the target machine offers a way to optimize
1750 the treatment of leaf functions.
1752 @findex LEAF_REG_REMAP
1753 @item LEAF_REG_REMAP (@var{regno})
1754 A C expression whose value is the register number to which @var{regno}
1755 should be renumbered, when a function is treated as a leaf function.
1757 If @var{regno} is a register number which should not appear in a leaf
1758 function before renumbering, then the expression should yield -1, which
1759 will cause the compiler to abort.
1761 Define this macro only if the target machine offers a way to optimize the
1762 treatment of leaf functions, and registers need to be renumbered to do
1763 this.
1764 @end table
1766 @findex current_function_is_leaf
1767 @findex current_function_uses_only_leaf_regs
1768 Normally, @code{FUNCTION_PROLOGUE} and @code{FUNCTION_EPILOGUE} must
1769 treat leaf functions specially.  They can test the C variable
1770 @code{current_function_is_leaf} which is nonzero for leaf functions.
1771 @code{current_function_is_leaf} is set prior to local register allocation
1772 and is valid for the remaining compiler passes.  They can also test the C
1773 variable @code{current_function_uses_only_leaf_regs} which is nonzero for
1774 leaf functions which only use leaf registers.
1775 @code{current_function_uses_only_leaf_regs} is valid after reload and is
1776 only useful if @code{LEAF_REGISTERS} is defined.
1777 @c changed this to fix overfull.  ALSO:  why the "it" at the beginning
1778 @c of the next paragraph?!  --mew 2feb93
1780 @node Stack Registers
1781 @subsection Registers That Form a Stack
1783 There are special features to handle computers where some of the
1784 ``registers'' form a stack, as in the 80387 coprocessor for the 80386.
1785 Stack registers are normally written by pushing onto the stack, and are
1786 numbered relative to the top of the stack.
1788 Currently, GCC can only handle one group of stack-like registers, and
1789 they must be consecutively numbered.
1791 @table @code
1792 @findex STACK_REGS
1793 @item STACK_REGS
1794 Define this if the machine has any stack-like registers.
1796 @findex FIRST_STACK_REG
1797 @item FIRST_STACK_REG
1798 The number of the first stack-like register.  This one is the top
1799 of the stack.
1801 @findex LAST_STACK_REG
1802 @item LAST_STACK_REG
1803 The number of the last stack-like register.  This one is the bottom of
1804 the stack.
1805 @end table
1807 @node Register Classes
1808 @section Register Classes
1809 @cindex register class definitions
1810 @cindex class definitions, register
1812 On many machines, the numbered registers are not all equivalent.
1813 For example, certain registers may not be allowed for indexed addressing;
1814 certain registers may not be allowed in some instructions.  These machine
1815 restrictions are described to the compiler using @dfn{register classes}.
1817 You define a number of register classes, giving each one a name and saying
1818 which of the registers belong to it.  Then you can specify register classes
1819 that are allowed as operands to particular instruction patterns.
1821 @findex ALL_REGS
1822 @findex NO_REGS
1823 In general, each register will belong to several classes.  In fact, one
1824 class must be named @code{ALL_REGS} and contain all the registers.  Another
1825 class must be named @code{NO_REGS} and contain no registers.  Often the
1826 union of two classes will be another class; however, this is not required.
1828 @findex GENERAL_REGS
1829 One of the classes must be named @code{GENERAL_REGS}.  There is nothing
1830 terribly special about the name, but the operand constraint letters
1831 @samp{r} and @samp{g} specify this class.  If @code{GENERAL_REGS} is
1832 the same as @code{ALL_REGS}, just define it as a macro which expands
1833 to @code{ALL_REGS}.
1835 Order the classes so that if class @var{x} is contained in class @var{y}
1836 then @var{x} has a lower class number than @var{y}.
1838 The way classes other than @code{GENERAL_REGS} are specified in operand
1839 constraints is through machine-dependent operand constraint letters.
1840 You can define such letters to correspond to various classes, then use
1841 them in operand constraints.
1843 You should define a class for the union of two classes whenever some
1844 instruction allows both classes.  For example, if an instruction allows
1845 either a floating point (coprocessor) register or a general register for a
1846 certain operand, you should define a class @code{FLOAT_OR_GENERAL_REGS}
1847 which includes both of them.  Otherwise you will get suboptimal code.
1849 You must also specify certain redundant information about the register
1850 classes: for each class, which classes contain it and which ones are
1851 contained in it; for each pair of classes, the largest class contained
1852 in their union.
1854 When a value occupying several consecutive registers is expected in a
1855 certain class, all the registers used must belong to that class.
1856 Therefore, register classes cannot be used to enforce a requirement for
1857 a register pair to start with an even-numbered register.  The way to
1858 specify this requirement is with @code{HARD_REGNO_MODE_OK}.
1860 Register classes used for input-operands of bitwise-and or shift
1861 instructions have a special requirement: each such class must have, for
1862 each fixed-point machine mode, a subclass whose registers can transfer that
1863 mode to or from memory.  For example, on some machines, the operations for
1864 single-byte values (@code{QImode}) are limited to certain registers.  When
1865 this is so, each register class that is used in a bitwise-and or shift
1866 instruction must have a subclass consisting of registers from which
1867 single-byte values can be loaded or stored.  This is so that
1868 @code{PREFERRED_RELOAD_CLASS} can always have a possible value to return.
1870 @table @code
1871 @findex enum reg_class
1872 @item enum reg_class
1873 An enumeral type that must be defined with all the register class names
1874 as enumeral values.  @code{NO_REGS} must be first.  @code{ALL_REGS}
1875 must be the last register class, followed by one more enumeral value,
1876 @code{LIM_REG_CLASSES}, which is not a register class but rather
1877 tells how many classes there are.
1879 Each register class has a number, which is the value of casting
1880 the class name to type @code{int}.  The number serves as an index
1881 in many of the tables described below.
1883 @findex N_REG_CLASSES
1884 @item N_REG_CLASSES
1885 The number of distinct register classes, defined as follows:
1887 @example
1888 #define N_REG_CLASSES (int) LIM_REG_CLASSES
1889 @end example
1891 @findex REG_CLASS_NAMES
1892 @item REG_CLASS_NAMES
1893 An initializer containing the names of the register classes as C string
1894 constants.  These names are used in writing some of the debugging dumps.
1896 @findex REG_CLASS_CONTENTS
1897 @item REG_CLASS_CONTENTS
1898 An initializer containing the contents of the register classes, as integers
1899 which are bit masks.  The @var{n}th integer specifies the contents of class
1900 @var{n}.  The way the integer @var{mask} is interpreted is that
1901 register @var{r} is in the class if @code{@var{mask} & (1 << @var{r})} is 1.
1903 When the machine has more than 32 registers, an integer does not suffice.
1904 Then the integers are replaced by sub-initializers, braced groupings containing
1905 several integers.  Each sub-initializer must be suitable as an initializer
1906 for the type @code{HARD_REG_SET} which is defined in @file{hard-reg-set.h}.
1907 In this situation, the first integer in each sub-initializer corresponds to
1908 registers 0 through 31, the second integer to registers 32 through 63, and
1909 so on.
1911 @findex REGNO_REG_CLASS
1912 @item REGNO_REG_CLASS (@var{regno})
1913 A C expression whose value is a register class containing hard register
1914 @var{regno}.  In general there is more than one such class; choose a class
1915 which is @dfn{minimal}, meaning that no smaller class also contains the
1916 register.
1918 @findex BASE_REG_CLASS
1919 @item BASE_REG_CLASS
1920 A macro whose definition is the name of the class to which a valid
1921 base register must belong.  A base register is one used in an address
1922 which is the register value plus a displacement.
1924 @findex INDEX_REG_CLASS
1925 @item INDEX_REG_CLASS
1926 A macro whose definition is the name of the class to which a valid
1927 index register must belong.  An index register is one used in an
1928 address where its value is either multiplied by a scale factor or
1929 added to another register (as well as added to a displacement).
1931 @findex REG_CLASS_FROM_LETTER
1932 @item REG_CLASS_FROM_LETTER (@var{char})
1933 A C expression which defines the machine-dependent operand constraint
1934 letters for register classes.  If @var{char} is such a letter, the
1935 value should be the register class corresponding to it.  Otherwise,
1936 the value should be @code{NO_REGS}.  The register letter @samp{r},
1937 corresponding to class @code{GENERAL_REGS}, will not be passed
1938 to this macro; you do not need to handle it.
1940 @findex REGNO_OK_FOR_BASE_P
1941 @item REGNO_OK_FOR_BASE_P (@var{num})
1942 A C expression which is nonzero if register number @var{num} is
1943 suitable for use as a base register in operand addresses.  It may be
1944 either a suitable hard register or a pseudo register that has been
1945 allocated such a hard register.
1947 @findex REGNO_MODE_OK_FOR_BASE_P
1948 @item REGNO_MODE_OK_FOR_BASE_P (@var{num}, @var{mode})
1949 A C expression that is just like @code{REGNO_OK_FOR_BASE_P}, except that
1950 that expression may examine the mode of the memory reference in
1951 @var{mode}.  You should define this macro if the mode of the memory
1952 reference affects whether a register may be used as a base register.  If
1953 you define this macro, the compiler will use it instead of
1954 @code{REGNO_OK_FOR_BASE_P}.
1956 @findex REGNO_OK_FOR_INDEX_P
1957 @item REGNO_OK_FOR_INDEX_P (@var{num})
1958 A C expression which is nonzero if register number @var{num} is
1959 suitable for use as an index register in operand addresses.  It may be
1960 either a suitable hard register or a pseudo register that has been
1961 allocated such a hard register.
1963 The difference between an index register and a base register is that
1964 the index register may be scaled.  If an address involves the sum of
1965 two registers, neither one of them scaled, then either one may be
1966 labeled the ``base'' and the other the ``index''; but whichever
1967 labeling is used must fit the machine's constraints of which registers
1968 may serve in each capacity.  The compiler will try both labelings,
1969 looking for one that is valid, and will reload one or both registers
1970 only if neither labeling works.
1972 @findex PREFERRED_RELOAD_CLASS
1973 @item PREFERRED_RELOAD_CLASS (@var{x}, @var{class})
1974 A C expression that places additional restrictions on the register class
1975 to use when it is necessary to copy value @var{x} into a register in class
1976 @var{class}.  The value is a register class; perhaps @var{class}, or perhaps
1977 another, smaller class.  On many machines, the following definition is
1978 safe:
1980 @example
1981 #define PREFERRED_RELOAD_CLASS(X,CLASS) CLASS
1982 @end example
1984 Sometimes returning a more restrictive class makes better code.  For
1985 example, on the 68000, when @var{x} is an integer constant that is in range
1986 for a @samp{moveq} instruction, the value of this macro is always
1987 @code{DATA_REGS} as long as @var{class} includes the data registers.
1988 Requiring a data register guarantees that a @samp{moveq} will be used.
1990 If @var{x} is a @code{const_double}, by returning @code{NO_REGS}
1991 you can force @var{x} into a memory constant.  This is useful on
1992 certain machines where immediate floating values cannot be loaded into
1993 certain kinds of registers.
1995 @findex PREFERRED_OUTPUT_RELOAD_CLASS
1996 @item PREFERRED_OUTPUT_RELOAD_CLASS (@var{x}, @var{class})
1997 Like @code{PREFERRED_RELOAD_CLASS}, but for output reloads instead of
1998 input reloads.  If you don't define this macro, the default is to use
1999 @var{class}, unchanged.
2001 @findex LIMIT_RELOAD_CLASS
2002 @item LIMIT_RELOAD_CLASS (@var{mode}, @var{class})
2003 A C expression that places additional restrictions on the register class
2004 to use when it is necessary to be able to hold a value of mode
2005 @var{mode} in a reload register for which class @var{class} would
2006 ordinarily be used.
2008 Unlike @code{PREFERRED_RELOAD_CLASS}, this macro should be used when
2009 there are certain modes that simply can't go in certain reload classes.
2011 The value is a register class; perhaps @var{class}, or perhaps another,
2012 smaller class.
2014 Don't define this macro unless the target machine has limitations which
2015 require the macro to do something nontrivial.
2017 @findex SECONDARY_RELOAD_CLASS
2018 @findex SECONDARY_INPUT_RELOAD_CLASS
2019 @findex SECONDARY_OUTPUT_RELOAD_CLASS
2020 @item SECONDARY_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2021 @itemx SECONDARY_INPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2022 @itemx SECONDARY_OUTPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x})
2023 Many machines have some registers that cannot be copied directly to or
2024 from memory or even from other types of registers.  An example is the
2025 @samp{MQ} register, which on most machines, can only be copied to or
2026 from general registers, but not memory.  Some machines allow copying all
2027 registers to and from memory, but require a scratch register for stores
2028 to some memory locations (e.g., those with symbolic address on the RT,
2029 and those with certain symbolic address on the Sparc when compiling
2030 PIC).  In some cases, both an intermediate and a scratch register are
2031 required.
2033 You should define these macros to indicate to the reload phase that it may
2034 need to allocate at least one register for a reload in addition to the
2035 register to contain the data.  Specifically, if copying @var{x} to a
2036 register @var{class} in @var{mode} requires an intermediate register,
2037 you should define @code{SECONDARY_INPUT_RELOAD_CLASS} to return the
2038 largest register class all of whose registers can be used as
2039 intermediate registers or scratch registers.
2041 If copying a register @var{class} in @var{mode} to @var{x} requires an
2042 intermediate or scratch register, @code{SECONDARY_OUTPUT_RELOAD_CLASS}
2043 should be defined to return the largest register class required.  If the
2044 requirements for input and output reloads are the same, the macro
2045 @code{SECONDARY_RELOAD_CLASS} should be used instead of defining both
2046 macros identically.
2048 The values returned by these macros are often @code{GENERAL_REGS}.
2049 Return @code{NO_REGS} if no spare register is needed; i.e., if @var{x}
2050 can be directly copied to or from a register of @var{class} in
2051 @var{mode} without requiring a scratch register.  Do not define this
2052 macro if it would always return @code{NO_REGS}.
2054 If a scratch register is required (either with or without an
2055 intermediate register), you should define patterns for
2056 @samp{reload_in@var{m}} or @samp{reload_out@var{m}}, as required
2057 (@pxref{Standard Names}.  These patterns, which will normally be
2058 implemented with a @code{define_expand}, should be similar to the
2059 @samp{mov@var{m}} patterns, except that operand 2 is the scratch
2060 register.
2062 Define constraints for the reload register and scratch register that
2063 contain a single register class.  If the original reload register (whose
2064 class is @var{class}) can meet the constraint given in the pattern, the
2065 value returned by these macros is used for the class of the scratch
2066 register.  Otherwise, two additional reload registers are required.
2067 Their classes are obtained from the constraints in the insn pattern.
2069 @var{x} might be a pseudo-register or a @code{subreg} of a
2070 pseudo-register, which could either be in a hard register or in memory.
2071 Use @code{true_regnum} to find out; it will return -1 if the pseudo is
2072 in memory and the hard register number if it is in a register.
2074 These macros should not be used in the case where a particular class of
2075 registers can only be copied to memory and not to another class of
2076 registers.  In that case, secondary reload registers are not needed and
2077 would not be helpful.  Instead, a stack location must be used to perform
2078 the copy and the @code{mov@var{m}} pattern should use memory as a
2079 intermediate storage.  This case often occurs between floating-point and
2080 general registers.
2082 @findex SECONDARY_MEMORY_NEEDED
2083 @item SECONDARY_MEMORY_NEEDED (@var{class1}, @var{class2}, @var{m})
2084 Certain machines have the property that some registers cannot be copied
2085 to some other registers without using memory.  Define this macro on
2086 those machines to be a C expression that is non-zero if objects of mode
2087 @var{m} in registers of @var{class1} can only be copied to registers of
2088 class @var{class2} by storing a register of @var{class1} into memory
2089 and loading that memory location into a register of @var{class2}.
2091 Do not define this macro if its value would always be zero.
2093 @findex SECONDARY_MEMORY_NEEDED_RTX
2094 @item SECONDARY_MEMORY_NEEDED_RTX (@var{mode})
2095 Normally when @code{SECONDARY_MEMORY_NEEDED} is defined, the compiler
2096 allocates a stack slot for a memory location needed for register copies.
2097 If this macro is defined, the compiler instead uses the memory location
2098 defined by this macro.
2100 Do not define this macro if you do not define
2101 @code{SECONDARY_MEMORY_NEEDED}.
2103 @findex SECONDARY_MEMORY_NEEDED_MODE
2104 @item SECONDARY_MEMORY_NEEDED_MODE (@var{mode})
2105 When the compiler needs a secondary memory location to copy between two
2106 registers of mode @var{mode}, it normally allocates sufficient memory to
2107 hold a quantity of @code{BITS_PER_WORD} bits and performs the store and
2108 load operations in a mode that many bits wide and whose class is the
2109 same as that of @var{mode}.
2111 This is right thing to do on most machines because it ensures that all
2112 bits of the register are copied and prevents accesses to the registers
2113 in a narrower mode, which some machines prohibit for floating-point
2114 registers.
2116 However, this default behavior is not correct on some machines, such as
2117 the DEC Alpha, that store short integers in floating-point registers
2118 differently than in integer registers.  On those machines, the default
2119 widening will not work correctly and you must define this macro to
2120 suppress that widening in some cases.  See the file @file{alpha.h} for
2121 details.
2123 Do not define this macro if you do not define
2124 @code{SECONDARY_MEMORY_NEEDED} or if widening @var{mode} to a mode that
2125 is @code{BITS_PER_WORD} bits wide is correct for your machine.
2127 @findex SMALL_REGISTER_CLASSES
2128 @item SMALL_REGISTER_CLASSES
2129 On some machines, it is risky to let hard registers live across arbitrary
2130 insns.  Typically, these machines have instructions that require values
2131 to be in specific registers (like an accumulator), and reload will fail
2132 if the required hard register is used for another purpose across such an
2133 insn.
2135 Define @code{SMALL_REGISTER_CLASSES} to be an expression with a non-zero
2136 value on these machines.  When this macro has a non-zero value, the
2137 compiler will try to minimize the lifetime of hard registers.
2139 It is always safe to define this macro with a non-zero value, but if you
2140 unnecessarily define it, you will reduce the amount of optimizations
2141 that can be performed in some cases.  If you do not define this macro
2142 with a non-zero value when it is required, the compiler will run out of
2143 spill registers and print a fatal error message.  For most machines, you
2144 should not define this macro at all.
2146 @findex CLASS_LIKELY_SPILLED_P
2147 @item CLASS_LIKELY_SPILLED_P (@var{class})
2148 A C expression whose value is nonzero if pseudos that have been assigned
2149 to registers of class @var{class} would likely be spilled because
2150 registers of @var{class} are needed for spill registers.
2152 The default value of this macro returns 1 if @var{class} has exactly one
2153 register and zero otherwise.  On most machines, this default should be
2154 used.  Only define this macro to some other expression if pseudos
2155 allocated by @file{local-alloc.c} end up in memory because their hard
2156 registers were needed for spill registers.  If this macro returns nonzero
2157 for those classes, those pseudos will only be allocated by
2158 @file{global.c}, which knows how to reallocate the pseudo to another
2159 register.  If there would not be another register available for
2160 reallocation, you should not change the definition of this macro since
2161 the only effect of such a definition would be to slow down register
2162 allocation.
2164 @findex CLASS_MAX_NREGS
2165 @item CLASS_MAX_NREGS (@var{class}, @var{mode})
2166 A C expression for the maximum number of consecutive registers
2167 of class @var{class} needed to hold a value of mode @var{mode}.
2169 This is closely related to the macro @code{HARD_REGNO_NREGS}.  In fact,
2170 the value of the macro @code{CLASS_MAX_NREGS (@var{class}, @var{mode})}
2171 should be the maximum value of @code{HARD_REGNO_NREGS (@var{regno},
2172 @var{mode})} for all @var{regno} values in the class @var{class}.
2174 This macro helps control the handling of multiple-word values
2175 in the reload pass.
2177 @item CLASS_CANNOT_CHANGE_MODE
2178 If defined, a C expression for a class that contains registers for
2179 which the compiler may not change modes arbitrarily.
2181 @item CLASS_CANNOT_CHANGE_MODE_P(@var{from}, @var{to})
2182 A C expression that is true if, for a register in
2183 @code{CLASS_CANNOT_CHANGE_MODE}, the requested mode punning is illegal.
2185 For the example, loading 32-bit integer or floating-point objects into
2186 floating-point registers on the Alpha extends them to 64-bits.
2187 Therefore loading a 64-bit object and then storing it as a 32-bit object
2188 does not store the low-order 32-bits, as would be the case for a normal
2189 register.  Therefore, @file{alpha.h} defines @code{CLASS_CANNOT_CHANGE_MODE}
2190 as @code{FLOAT_REGS} and @code{CLASS_CANNOT_CHANGE_MODE_P} restricts
2191 mode changes to same-size modes.
2193 Compare this to IA-64, which extends floating-point values to 82-bits,
2194 and stores 64-bit integers in a different format than 64-bit doubles.
2195 Therefore @code{CLASS_CANNOT_CHANGE_MODE_P} is always true.
2196 @end table
2198 Three other special macros describe which operands fit which constraint
2199 letters.
2201 @table @code
2202 @findex CONST_OK_FOR_LETTER_P
2203 @item CONST_OK_FOR_LETTER_P (@var{value}, @var{c})
2204 A C expression that defines the machine-dependent operand constraint
2205 letters (@samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}) that specify
2206 particular ranges of integer values.  If @var{c} is one of those
2207 letters, the expression should check that @var{value}, an integer, is in
2208 the appropriate range and return 1 if so, 0 otherwise.  If @var{c} is
2209 not one of those letters, the value should be 0 regardless of
2210 @var{value}.
2212 @findex CONST_DOUBLE_OK_FOR_LETTER_P
2213 @item CONST_DOUBLE_OK_FOR_LETTER_P (@var{value}, @var{c})
2214 A C expression that defines the machine-dependent operand constraint
2215 letters that specify particular ranges of @code{const_double} values
2216 (@samp{G} or @samp{H}).
2218 If @var{c} is one of those letters, the expression should check that
2219 @var{value}, an RTX of code @code{const_double}, is in the appropriate
2220 range and return 1 if so, 0 otherwise.  If @var{c} is not one of those
2221 letters, the value should be 0 regardless of @var{value}.
2223 @code{const_double} is used for all floating-point constants and for
2224 @code{DImode} fixed-point constants.  A given letter can accept either
2225 or both kinds of values.  It can use @code{GET_MODE} to distinguish
2226 between these kinds.
2228 @findex EXTRA_CONSTRAINT
2229 @item EXTRA_CONSTRAINT (@var{value}, @var{c})
2230 A C expression that defines the optional machine-dependent constraint
2231 letters that can be used to segregate specific types of operands, usually
2232 memory references, for the target machine.  Any letter that is not
2233 elsewhere defined and not matched by @code{REG_CLASS_FROM_LETTER}
2234 may be used.  Normally this macro will not be defined.
2236 If it is required for a particular target machine, it should return 1
2237 if @var{value} corresponds to the operand type represented by the
2238 constraint letter @var{c}.  If @var{c} is not defined as an extra
2239 constraint, the value returned should be 0 regardless of @var{value}.
2241 For example, on the ROMP, load instructions cannot have their output
2242 in r0 if the memory reference contains a symbolic address.  Constraint
2243 letter @samp{Q} is defined as representing a memory address that does
2244 @emph{not} contain a symbolic address.  An alternative is specified with
2245 a @samp{Q} constraint on the input and @samp{r} on the output.  The next
2246 alternative specifies @samp{m} on the input and a register class that
2247 does not include r0 on the output.
2248 @end table
2250 @node Stack and Calling
2251 @section Stack Layout and Calling Conventions
2252 @cindex calling conventions
2254 @c prevent bad page break with this line
2255 This describes the stack layout and calling conventions.
2257 @menu
2258 * Frame Layout::
2259 * Stack Checking::
2260 * Frame Registers::
2261 * Elimination::
2262 * Stack Arguments::
2263 * Register Arguments::
2264 * Scalar Return::
2265 * Aggregate Return::
2266 * Caller Saves::
2267 * Function Entry::
2268 * Profiling::
2269 * Inlining::
2270 * Tail Calling::
2271 @end menu
2273 @node Frame Layout
2274 @subsection Basic Stack Layout
2275 @cindex stack frame layout
2276 @cindex frame layout
2278 @c prevent bad page break with this line
2279 Here is the basic stack layout.
2281 @table @code
2282 @findex STACK_GROWS_DOWNWARD
2283 @item STACK_GROWS_DOWNWARD
2284 Define this macro if pushing a word onto the stack moves the stack
2285 pointer to a smaller address.
2287 When we say, ``define this macro if @dots{},'' it means that the
2288 compiler checks this macro only with @code{#ifdef} so the precise
2289 definition used does not matter.
2291 @findex FRAME_GROWS_DOWNWARD
2292 @item FRAME_GROWS_DOWNWARD
2293 Define this macro if the addresses of local variable slots are at negative
2294 offsets from the frame pointer.
2296 @findex ARGS_GROW_DOWNWARD
2297 @item ARGS_GROW_DOWNWARD
2298 Define this macro if successive arguments to a function occupy decreasing
2299 addresses on the stack.
2301 @findex STARTING_FRAME_OFFSET
2302 @item STARTING_FRAME_OFFSET
2303 Offset from the frame pointer to the first local variable slot to be allocated.
2305 If @code{FRAME_GROWS_DOWNWARD}, find the next slot's offset by
2306 subtracting the first slot's length from @code{STARTING_FRAME_OFFSET}.
2307 Otherwise, it is found by adding the length of the first slot to the
2308 value @code{STARTING_FRAME_OFFSET}.
2309 @c i'm not sure if the above is still correct.. had to change it to get
2310 @c rid of an overfull.  --mew 2feb93
2312 @findex STACK_POINTER_OFFSET
2313 @item STACK_POINTER_OFFSET
2314 Offset from the stack pointer register to the first location at which
2315 outgoing arguments are placed.  If not specified, the default value of
2316 zero is used.  This is the proper value for most machines.
2318 If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above
2319 the first location at which outgoing arguments are placed.
2321 @findex FIRST_PARM_OFFSET
2322 @item FIRST_PARM_OFFSET (@var{fundecl})
2323 Offset from the argument pointer register to the first argument's
2324 address.  On some machines it may depend on the data type of the
2325 function.
2327 If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above
2328 the first argument's address.
2330 @findex STACK_DYNAMIC_OFFSET
2331 @item STACK_DYNAMIC_OFFSET (@var{fundecl})
2332 Offset from the stack pointer register to an item dynamically allocated
2333 on the stack, e.g., by @code{alloca}.
2335 The default value for this macro is @code{STACK_POINTER_OFFSET} plus the
2336 length of the outgoing arguments.  The default is correct for most
2337 machines.  See @file{function.c} for details.
2339 @findex DYNAMIC_CHAIN_ADDRESS
2340 @item DYNAMIC_CHAIN_ADDRESS (@var{frameaddr})
2341 A C expression whose value is RTL representing the address in a stack
2342 frame where the pointer to the caller's frame is stored.  Assume that
2343 @var{frameaddr} is an RTL expression for the address of the stack frame
2344 itself.
2346 If you don't define this macro, the default is to return the value
2347 of @var{frameaddr}---that is, the stack frame address is also the
2348 address of the stack word that points to the previous frame.
2350 @findex SETUP_FRAME_ADDRESSES
2351 @item SETUP_FRAME_ADDRESSES
2352 If defined, a C expression that produces the machine-specific code to
2353 setup the stack so that arbitrary frames can be accessed.  For example,
2354 on the Sparc, we must flush all of the register windows to the stack
2355 before we can access arbitrary stack frames.  You will seldom need to
2356 define this macro.
2358 @findex BUILTIN_SETJMP_FRAME_VALUE
2359 @item BUILTIN_SETJMP_FRAME_VALUE
2360 If defined, a C expression that contains an rtx that is used to store
2361 the address of the current frame into the built in @code{setjmp} buffer.
2362 The default value, @code{virtual_stack_vars_rtx}, is correct for most
2363 machines.  One reason you may need to define this macro is if
2364 @code{hard_frame_pointer_rtx} is the appropriate value on your machine.
2366 @findex RETURN_ADDR_RTX
2367 @item RETURN_ADDR_RTX (@var{count}, @var{frameaddr})
2368 A C expression whose value is RTL representing the value of the return
2369 address for the frame @var{count} steps up from the current frame, after
2370 the prologue.  @var{frameaddr} is the frame pointer of the @var{count}
2371 frame, or the frame pointer of the @var{count} @minus{} 1 frame if
2372 @code{RETURN_ADDR_IN_PREVIOUS_FRAME} is defined.
2374 The value of the expression must always be the correct address when
2375 @var{count} is zero, but may be @code{NULL_RTX} if there is not way to
2376 determine the return address of other frames.
2378 @findex RETURN_ADDR_IN_PREVIOUS_FRAME
2379 @item RETURN_ADDR_IN_PREVIOUS_FRAME
2380 Define this if the return address of a particular stack frame is accessed
2381 from the frame pointer of the previous stack frame.
2383 @findex INCOMING_RETURN_ADDR_RTX
2384 @item INCOMING_RETURN_ADDR_RTX
2385 A C expression whose value is RTL representing the location of the
2386 incoming return address at the beginning of any function, before the
2387 prologue.  This RTL is either a @code{REG}, indicating that the return
2388 value is saved in @samp{REG}, or a @code{MEM} representing a location in
2389 the stack.
2391 You only need to define this macro if you want to support call frame
2392 debugging information like that provided by DWARF 2.
2394 If this RTL is a @code{REG}, you should also define
2395 DWARF_FRAME_RETURN_COLUMN to @code{DWARF_FRAME_REGNUM (REGNO)}.
2397 @findex INCOMING_FRAME_SP_OFFSET
2398 @item INCOMING_FRAME_SP_OFFSET
2399 A C expression whose value is an integer giving the offset, in bytes,
2400 from the value of the stack pointer register to the top of the stack
2401 frame at the beginning of any function, before the prologue.  The top of
2402 the frame is defined to be the value of the stack pointer in the
2403 previous frame, just before the call instruction.
2405 You only need to define this macro if you want to support call frame
2406 debugging information like that provided by DWARF 2.
2408 @findex ARG_POINTER_CFA_OFFSET
2409 @item ARG_POINTER_CFA_OFFSET (@var{fundecl})
2410 A C expression whose value is an integer giving the offset, in bytes,
2411 from the argument pointer to the canonical frame address (cfa).  The
2412 final value should coincide with that calculated by 
2413 @code{INCOMING_FRAME_SP_OFFSET}.  Which is unfortunately not usable
2414 during virtual register instantiation.
2416 The default value for this macro is @code{FIRST_PARM_OFFSET (fundecl)},
2417 which is correct for most machines; in general, the arguments are found
2418 immediately before the stack frame.  Note that this is not the case on
2419 some targets that save registers into the caller's frame, such as SPARC
2420 and rs6000, and so such targets need to define this macro.
2422 You only need to define this macro if the default is incorrect, and you
2423 want to support call frame debugging information like that provided by
2424 DWARF 2.
2426 @findex SMALL_STACK
2427 @item SMALL_STACK
2428 Define this macro if the stack size for the target is very small.  This
2429 has the effect of disabling gcc's builtin @samp{alloca}, though
2430 @samp{__builtin_alloca} is not affected.
2431 @end table
2433 @node Stack Checking
2434 @subsection Specifying How Stack Checking is Done
2436 GCC will check that stack references are within the boundaries of
2437 the stack, if the @samp{-fstack-check} is specified, in one of three ways:
2439 @enumerate
2440 @item
2441 If the value of the @code{STACK_CHECK_BUILTIN} macro is nonzero, GCC
2442 will assume that you have arranged for stack checking to be done at
2443 appropriate places in the configuration files, e.g., in
2444 @code{FUNCTION_PROLOGUE}.  GCC will do not other special processing.
2446 @item
2447 If @code{STACK_CHECK_BUILTIN} is zero and you defined a named pattern
2448 called @code{check_stack} in your @file{md} file, GCC will call that
2449 pattern with one argument which is the address to compare the stack
2450 value against.  You must arrange for this pattern to report an error if
2451 the stack pointer is out of range.
2453 @item
2454 If neither of the above are true, GCC will generate code to periodically
2455 ``probe'' the stack pointer using the values of the macros defined below.
2456 @end enumerate
2458 Normally, you will use the default values of these macros, so GCC
2459 will use the third approach.
2461 @table @code
2462 @findex STACK_CHECK_BUILTIN
2463 @item STACK_CHECK_BUILTIN
2464 A nonzero value if stack checking is done by the configuration files in a
2465 machine-dependent manner.  You should define this macro if stack checking 
2466 is require by the ABI of your machine or if you would like to have to stack 
2467 checking in some more efficient way than GCC's portable approach.
2468 The default value of this macro is zero.
2470 @findex STACK_CHECK_PROBE_INTERVAL
2471 @item STACK_CHECK_PROBE_INTERVAL
2472 An integer representing the interval at which GCC must generate stack
2473 probe instructions.  You will normally define this macro to be no larger
2474 than the size of the ``guard pages'' at the end of a stack area.  The
2475 default value of 4096 is suitable for most systems.
2477 @findex STACK_CHECK_PROBE_LOAD
2478 @item STACK_CHECK_PROBE_LOAD
2479 A integer which is nonzero if GCC should perform the stack probe 
2480 as a load instruction and zero if GCC should use a store instruction.
2481 The default is zero, which is the most efficient choice on most systems.
2483 @findex STACK_CHECK_PROTECT
2484 @item STACK_CHECK_PROTECT
2485 The number of bytes of stack needed to recover from a stack overflow,
2486 for languages where such a recovery is supported.  The default value of
2487 75 words should be adequate for most machines.
2489 @findex STACK_CHECK_MAX_FRAME_SIZE
2490 @item STACK_CHECK_MAX_FRAME_SIZE
2491 The maximum size of a stack frame, in bytes.  GCC will generate probe
2492 instructions in non-leaf functions to ensure at least this many bytes of
2493 stack are available.  If a stack frame is larger than this size, stack
2494 checking will not be reliable and GCC will issue a warning.  The
2495 default is chosen so that GCC only generates one instruction on most
2496 systems.  You should normally not change the default value of this macro.
2498 @findex STACK_CHECK_FIXED_FRAME_SIZE
2499 @item STACK_CHECK_FIXED_FRAME_SIZE
2500 GCC uses this value to generate the above warning message.  It
2501 represents the amount of fixed frame used by a function, not including
2502 space for any callee-saved registers, temporaries and user variables.
2503 You need only specify an upper bound for this amount and will normally
2504 use the default of four words.
2506 @findex STACK_CHECK_MAX_VAR_SIZE
2507 @item STACK_CHECK_MAX_VAR_SIZE
2508 The maximum size, in bytes, of an object that GCC will place in the
2509 fixed area of the stack frame when the user specifies
2510 @samp{-fstack-check}.
2511 GCC computed the default from the values of the above macros and you will
2512 normally not need to override that default.
2513 @end table
2515 @need 2000
2516 @node Frame Registers
2517 @subsection Registers That Address the Stack Frame
2519 @c prevent bad page break with this line
2520 This discusses registers that address the stack frame.
2522 @table @code
2523 @findex STACK_POINTER_REGNUM
2524 @item STACK_POINTER_REGNUM
2525 The register number of the stack pointer register, which must also be a
2526 fixed register according to @code{FIXED_REGISTERS}.  On most machines,
2527 the hardware determines which register this is.
2529 @findex FRAME_POINTER_REGNUM
2530 @item FRAME_POINTER_REGNUM
2531 The register number of the frame pointer register, which is used to
2532 access automatic variables in the stack frame.  On some machines, the
2533 hardware determines which register this is.  On other machines, you can
2534 choose any register you wish for this purpose.
2536 @findex HARD_FRAME_POINTER_REGNUM
2537 @item HARD_FRAME_POINTER_REGNUM
2538 On some machines the offset between the frame pointer and starting
2539 offset of the automatic variables is not known until after register
2540 allocation has been done (for example, because the saved registers are
2541 between these two locations).  On those machines, define
2542 @code{FRAME_POINTER_REGNUM} the number of a special, fixed register to
2543 be used internally until the offset is known, and define
2544 @code{HARD_FRAME_POINTER_REGNUM} to be the actual hard register number
2545 used for the frame pointer.
2547 You should define this macro only in the very rare circumstances when it
2548 is not possible to calculate the offset between the frame pointer and
2549 the automatic variables until after register allocation has been
2550 completed.  When this macro is defined, you must also indicate in your
2551 definition of @code{ELIMINABLE_REGS} how to eliminate
2552 @code{FRAME_POINTER_REGNUM} into either @code{HARD_FRAME_POINTER_REGNUM}
2553 or @code{STACK_POINTER_REGNUM}.
2555 Do not define this macro if it would be the same as
2556 @code{FRAME_POINTER_REGNUM}.
2558 @findex ARG_POINTER_REGNUM
2559 @item ARG_POINTER_REGNUM
2560 The register number of the arg pointer register, which is used to access
2561 the function's argument list.  On some machines, this is the same as the
2562 frame pointer register.  On some machines, the hardware determines which
2563 register this is.  On other machines, you can choose any register you
2564 wish for this purpose.  If this is not the same register as the frame
2565 pointer register, then you must mark it as a fixed register according to
2566 @code{FIXED_REGISTERS}, or arrange to be able to eliminate it
2567 (@pxref{Elimination}).
2569 @findex RETURN_ADDRESS_POINTER_REGNUM
2570 @item RETURN_ADDRESS_POINTER_REGNUM
2571 The register number of the return address pointer register, which is used to
2572 access the current function's return address from the stack.  On some
2573 machines, the return address is not at a fixed offset from the frame
2574 pointer or stack pointer or argument pointer.  This register can be defined
2575 to point to the return address on the stack, and then be converted by
2576 @code{ELIMINABLE_REGS} into either the frame pointer or stack pointer.
2578 Do not define this macro unless there is no other way to get the return
2579 address from the stack.
2581 @findex STATIC_CHAIN_REGNUM
2582 @findex STATIC_CHAIN_INCOMING_REGNUM
2583 @item STATIC_CHAIN_REGNUM
2584 @itemx STATIC_CHAIN_INCOMING_REGNUM
2585 Register numbers used for passing a function's static chain pointer.  If
2586 register windows are used, the register number as seen by the called
2587 function is @code{STATIC_CHAIN_INCOMING_REGNUM}, while the register
2588 number as seen by the calling function is @code{STATIC_CHAIN_REGNUM}.  If
2589 these registers are the same, @code{STATIC_CHAIN_INCOMING_REGNUM} need
2590 not be defined.@refill
2592 The static chain register need not be a fixed register.
2594 If the static chain is passed in memory, these macros should not be
2595 defined; instead, the next two macros should be defined.
2597 @findex STATIC_CHAIN
2598 @findex STATIC_CHAIN_INCOMING
2599 @item STATIC_CHAIN
2600 @itemx STATIC_CHAIN_INCOMING
2601 If the static chain is passed in memory, these macros provide rtx giving
2602 @code{mem} expressions that denote where they are stored.
2603 @code{STATIC_CHAIN} and @code{STATIC_CHAIN_INCOMING} give the locations
2604 as seen by the calling and called functions, respectively.  Often the former
2605 will be at an offset from the stack pointer and the latter at an offset from
2606 the frame pointer.@refill
2608 @findex stack_pointer_rtx
2609 @findex frame_pointer_rtx
2610 @findex arg_pointer_rtx
2611 The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and
2612 @code{arg_pointer_rtx} will have been initialized prior to the use of these
2613 macros and should be used to refer to those items.
2615 If the static chain is passed in a register, the two previous macros should
2616 be defined instead.
2617 @end table
2619 @node Elimination
2620 @subsection Eliminating Frame Pointer and Arg Pointer
2622 @c prevent bad page break with this line
2623 This is about eliminating the frame pointer and arg pointer.
2625 @table @code
2626 @findex FRAME_POINTER_REQUIRED
2627 @item FRAME_POINTER_REQUIRED
2628 A C expression which is nonzero if a function must have and use a frame
2629 pointer.  This expression is evaluated  in the reload pass.  If its value is
2630 nonzero the function will have a frame pointer.
2632 The expression can in principle examine the current function and decide
2633 according to the facts, but on most machines the constant 0 or the
2634 constant 1 suffices.  Use 0 when the machine allows code to be generated
2635 with no frame pointer, and doing so saves some time or space.  Use 1
2636 when there is no possible advantage to avoiding a frame pointer.
2638 In certain cases, the compiler does not know how to produce valid code
2639 without a frame pointer.  The compiler recognizes those cases and
2640 automatically gives the function a frame pointer regardless of what
2641 @code{FRAME_POINTER_REQUIRED} says.  You don't need to worry about
2642 them.@refill
2644 In a function that does not require a frame pointer, the frame pointer
2645 register can be allocated for ordinary usage, unless you mark it as a
2646 fixed register.  See @code{FIXED_REGISTERS} for more information.
2648 @findex INITIAL_FRAME_POINTER_OFFSET
2649 @findex get_frame_size
2650 @item INITIAL_FRAME_POINTER_OFFSET (@var{depth-var})
2651 A C statement to store in the variable @var{depth-var} the difference
2652 between the frame pointer and the stack pointer values immediately after
2653 the function prologue.  The value would be computed from information
2654 such as the result of @code{get_frame_size ()} and the tables of
2655 registers @code{regs_ever_live} and @code{call_used_regs}.
2657 If @code{ELIMINABLE_REGS} is defined, this macro will be not be used and
2658 need not be defined.  Otherwise, it must be defined even if
2659 @code{FRAME_POINTER_REQUIRED} is defined to always be true; in that
2660 case, you may set @var{depth-var} to anything.
2662 @findex ELIMINABLE_REGS
2663 @item ELIMINABLE_REGS
2664 If defined, this macro specifies a table of register pairs used to
2665 eliminate unneeded registers that point into the stack frame.  If it is not
2666 defined, the only elimination attempted by the compiler is to replace
2667 references to the frame pointer with references to the stack pointer.
2669 The definition of this macro is a list of structure initializations, each
2670 of which specifies an original and replacement register.
2672 On some machines, the position of the argument pointer is not known until
2673 the compilation is completed.  In such a case, a separate hard register
2674 must be used for the argument pointer.  This register can be eliminated by
2675 replacing it with either the frame pointer or the argument pointer,
2676 depending on whether or not the frame pointer has been eliminated.
2678 In this case, you might specify:
2679 @example
2680 #define ELIMINABLE_REGS  \
2681 @{@{ARG_POINTER_REGNUM, STACK_POINTER_REGNUM@}, \
2682  @{ARG_POINTER_REGNUM, FRAME_POINTER_REGNUM@}, \
2683  @{FRAME_POINTER_REGNUM, STACK_POINTER_REGNUM@}@}
2684 @end example
2686 Note that the elimination of the argument pointer with the stack pointer is
2687 specified first since that is the preferred elimination.
2689 @findex CAN_ELIMINATE
2690 @item CAN_ELIMINATE (@var{from-reg}, @var{to-reg})
2691 A C expression that returns non-zero if the compiler is allowed to try
2692 to replace register number @var{from-reg} with register number
2693 @var{to-reg}.  This macro need only be defined if @code{ELIMINABLE_REGS}
2694 is defined, and will usually be the constant 1, since most of the cases
2695 preventing register elimination are things that the compiler already
2696 knows about.
2698 @findex INITIAL_ELIMINATION_OFFSET
2699 @item INITIAL_ELIMINATION_OFFSET (@var{from-reg}, @var{to-reg}, @var{offset-var})
2700 This macro is similar to @code{INITIAL_FRAME_POINTER_OFFSET}.  It
2701 specifies the initial difference between the specified pair of
2702 registers.  This macro must be defined if @code{ELIMINABLE_REGS} is
2703 defined.
2705 @findex LONGJMP_RESTORE_FROM_STACK
2706 @item LONGJMP_RESTORE_FROM_STACK
2707 Define this macro if the @code{longjmp} function restores registers from
2708 the stack frames, rather than from those saved specifically by
2709 @code{setjmp}.  Certain quantities must not be kept in registers across
2710 a call to @code{setjmp} on such machines.
2711 @end table
2713 @node Stack Arguments
2714 @subsection Passing Function Arguments on the Stack
2715 @cindex arguments on stack
2716 @cindex stack arguments
2718 The macros in this section control how arguments are passed
2719 on the stack.  See the following section for other macros that
2720 control passing certain arguments in registers.
2722 @table @code
2723 @findex PROMOTE_PROTOTYPES
2724 @item PROMOTE_PROTOTYPES
2725 A C expression whose value is nonzero if an argument declared in
2726 a prototype as an integral type smaller than @code{int} should
2727 actually be passed as an @code{int}.  In addition to avoiding
2728 errors in certain cases of mismatch, it also makes for better
2729 code on certain machines.  If the macro is not defined in target
2730 header files, it defaults to 0.
2732 @findex PUSH_ARGS
2733 @item PUSH_ARGS
2734 A C expression. If nonzero, push insns will be used to pass
2735 outgoing arguments.
2736 If the target machine does not have a push instruction, set it to zero.
2737 That directs GCC to use an alternate strategy: to
2738 allocate the entire argument block and then store the arguments into
2739 it.  When PUSH_ARGS is nonzero, PUSH_ROUNDING must be defined too.
2740 On some machines, the definition
2742 @findex PUSH_ROUNDING
2743 @item PUSH_ROUNDING (@var{npushed})
2744 A C expression that is the number of bytes actually pushed onto the
2745 stack when an instruction attempts to push @var{npushed} bytes.
2746 @findex PUSH_ROUNDING
2747 @item PUSH_ROUNDING (@var{npushed})
2748 A C expression that is the number of bytes actually pushed onto the
2749 stack when an instruction attempts to push @var{npushed} bytes.
2751 On some machines, the definition
2753 @example
2754 #define PUSH_ROUNDING(BYTES) (BYTES)
2755 @end example
2757 @noindent
2758 will suffice.  But on other machines, instructions that appear
2759 to push one byte actually push two bytes in an attempt to maintain
2760 alignment.  Then the definition should be
2762 @example
2763 #define PUSH_ROUNDING(BYTES) (((BYTES) + 1) & ~1)
2764 @end example
2766 @findex ACCUMULATE_OUTGOING_ARGS
2767 @findex current_function_outgoing_args_size
2768 @item ACCUMULATE_OUTGOING_ARGS
2769 A C expression. If nonzero, the maximum amount of space required for outgoing arguments
2770 will be computed and placed into the variable
2771 @code{current_function_outgoing_args_size}.  No space will be pushed
2772 onto the stack for each call; instead, the function prologue should
2773 increase the stack frame size by this amount.
2775 Setting both @code{PUSH_ARGS} and @code{ACCUMULATE_OUTGOING_ARGS}
2776 is not proper.
2778 @findex REG_PARM_STACK_SPACE
2779 @item REG_PARM_STACK_SPACE (@var{fndecl})
2780 Define this macro if functions should assume that stack space has been
2781 allocated for arguments even when their values are passed in
2782 registers.
2784 The value of this macro is the size, in bytes, of the area reserved for
2785 arguments passed in registers for the function represented by @var{fndecl},
2786 which can be zero if GCC is calling a library function.
2788 This space can be allocated by the caller, or be a part of the
2789 machine-dependent stack frame: @code{OUTGOING_REG_PARM_STACK_SPACE} says
2790 which.
2791 @c above is overfull.  not sure what to do.  --mew 5feb93  did
2792 @c something, not sure if it looks good.  --mew 10feb93
2794 @findex MAYBE_REG_PARM_STACK_SPACE
2795 @findex FINAL_REG_PARM_STACK_SPACE
2796 @item MAYBE_REG_PARM_STACK_SPACE
2797 @itemx FINAL_REG_PARM_STACK_SPACE (@var{const_size}, @var{var_size})
2798 Define these macros in addition to the one above if functions might
2799 allocate stack space for arguments even when their values are passed
2800 in registers.  These should be used when the stack space allocated
2801 for arguments in registers is not a simple constant independent of the
2802 function declaration.
2804 The value of the first macro is the size, in bytes, of the area that
2805 we should initially assume would be reserved for arguments passed in registers.
2807 The value of the second macro is the actual size, in bytes, of the area
2808 that will be reserved for arguments passed in registers.  This takes two
2809 arguments: an integer representing the number of bytes of fixed sized
2810 arguments on the stack, and a tree representing the number of bytes of
2811 variable sized arguments on the stack.
2813 When these macros are defined, @code{REG_PARM_STACK_SPACE} will only be
2814 called for libcall functions, the current function, or for a function
2815 being called when it is known that such stack space must be allocated.
2816 In each case this value can be easily computed.
2818 When deciding whether a called function needs such stack space, and how
2819 much space to reserve, GCC uses these two macros instead of
2820 @code{REG_PARM_STACK_SPACE}.
2822 @findex OUTGOING_REG_PARM_STACK_SPACE
2823 @item OUTGOING_REG_PARM_STACK_SPACE
2824 Define this if it is the responsibility of the caller to allocate the area
2825 reserved for arguments passed in registers.
2827 If @code{ACCUMULATE_OUTGOING_ARGS} is defined, this macro controls
2828 whether the space for these arguments counts in the value of
2829 @code{current_function_outgoing_args_size}.
2831 @findex STACK_PARMS_IN_REG_PARM_AREA
2832 @item STACK_PARMS_IN_REG_PARM_AREA
2833 Define this macro if @code{REG_PARM_STACK_SPACE} is defined, but the
2834 stack parameters don't skip the area specified by it.
2835 @c i changed this, makes more sens and it should have taken care of the
2836 @c overfull.. not as specific, tho.  --mew 5feb93
2838 Normally, when a parameter is not passed in registers, it is placed on the
2839 stack beyond the @code{REG_PARM_STACK_SPACE} area.  Defining this macro
2840 suppresses this behavior and causes the parameter to be passed on the
2841 stack in its natural location.
2843 @findex RETURN_POPS_ARGS
2844 @item RETURN_POPS_ARGS (@var{fundecl}, @var{funtype}, @var{stack-size})
2845 A C expression that should indicate the number of bytes of its own
2846 arguments that a function pops on returning, or 0 if the
2847 function pops no arguments and the caller must therefore pop them all
2848 after the function returns.
2850 @var{fundecl} is a C variable whose value is a tree node that describes
2851 the function in question.  Normally it is a node of type
2852 @code{FUNCTION_DECL} that describes the declaration of the function.
2853 From this you can obtain the DECL_MACHINE_ATTRIBUTES of the function.
2855 @var{funtype} is a C variable whose value is a tree node that
2856 describes the function in question.  Normally it is a node of type
2857 @code{FUNCTION_TYPE} that describes the data type of the function.
2858 From this it is possible to obtain the data types of the value and
2859 arguments (if known).
2861 When a call to a library function is being considered, @var{fundecl}
2862 will contain an identifier node for the library function.  Thus, if
2863 you need to distinguish among various library functions, you can do so
2864 by their names.  Note that ``library function'' in this context means
2865 a function used to perform arithmetic, whose name is known specially
2866 in the compiler and was not mentioned in the C code being compiled.
2868 @var{stack-size} is the number of bytes of arguments passed on the
2869 stack.  If a variable number of bytes is passed, it is zero, and
2870 argument popping will always be the responsibility of the calling function.
2872 On the Vax, all functions always pop their arguments, so the definition
2873 of this macro is @var{stack-size}.  On the 68000, using the standard
2874 calling convention, no functions pop their arguments, so the value of
2875 the macro is always 0 in this case.  But an alternative calling
2876 convention is available in which functions that take a fixed number of
2877 arguments pop them but other functions (such as @code{printf}) pop
2878 nothing (the caller pops all).  When this convention is in use,
2879 @var{funtype} is examined to determine whether a function takes a fixed
2880 number of arguments.
2881 @end table
2883 @node Register Arguments
2884 @subsection Passing Arguments in Registers
2885 @cindex arguments in registers
2886 @cindex registers arguments
2888 This section describes the macros which let you control how various
2889 types of arguments are passed in registers or how they are arranged in
2890 the stack.
2892 @table @code
2893 @findex FUNCTION_ARG
2894 @item FUNCTION_ARG (@var{cum}, @var{mode}, @var{type}, @var{named})
2895 A C expression that controls whether a function argument is passed
2896 in a register, and which register.
2898 The arguments are @var{cum}, which summarizes all the previous
2899 arguments; @var{mode}, the machine mode of the argument; @var{type},
2900 the data type of the argument as a tree node or 0 if that is not known
2901 (which happens for C support library functions); and @var{named},
2902 which is 1 for an ordinary argument and 0 for nameless arguments that
2903 correspond to @samp{@dots{}} in the called function's prototype.
2905 The value of the expression is usually either a @code{reg} RTX for the
2906 hard register in which to pass the argument, or zero to pass the
2907 argument on the stack.
2909 For machines like the Vax and 68000, where normally all arguments are
2910 pushed, zero suffices as a definition.
2912 The value of the expression can also be a @code{parallel} RTX.  This is
2913 used when an argument is passed in multiple locations.  The mode of the
2914 of the @code{parallel} should be the mode of the entire argument.  The
2915 @code{parallel} holds any number of @code{expr_list} pairs; each one
2916 describes where part of the argument is passed.  In each
2917 @code{expr_list} the first operand must be a @code{reg} RTX for the hard
2918 register in which to pass this part of the argument, and the mode of the
2919 register RTX indicates how large this part of the argument is.  The
2920 second operand of the @code{expr_list} is a @code{const_int} which gives
2921 the offset in bytes into the entire argument of where this part starts.
2922 As a special exception the first @code{expr_list} in the @code{parallel} 
2923 RTX may have a first operand of zero.  This indicates that the entire
2924 argument is also stored on the stack.
2926 @cindex @file{stdarg.h} and register arguments
2927 The usual way to make the ANSI library @file{stdarg.h} work on a machine
2928 where some arguments are usually passed in registers, is to cause
2929 nameless arguments to be passed on the stack instead.  This is done
2930 by making @code{FUNCTION_ARG} return 0 whenever @var{named} is 0.
2932 @cindex @code{MUST_PASS_IN_STACK}, and @code{FUNCTION_ARG}
2933 @cindex @code{REG_PARM_STACK_SPACE}, and @code{FUNCTION_ARG}
2934 You may use the macro @code{MUST_PASS_IN_STACK (@var{mode}, @var{type})}
2935 in the definition of this macro to determine if this argument is of a
2936 type that must be passed in the stack.  If @code{REG_PARM_STACK_SPACE}
2937 is not defined and @code{FUNCTION_ARG} returns non-zero for such an
2938 argument, the compiler will abort.  If @code{REG_PARM_STACK_SPACE} is
2939 defined, the argument will be computed in the stack and then loaded into
2940 a register.
2942 @findex MUST_PASS_IN_STACK
2943 @item MUST_PASS_IN_STACK (@var{mode}, @var{type})
2944 Define as a C expression that evaluates to nonzero if we do not know how
2945 to pass TYPE solely in registers.  The file @file{expr.h} defines a
2946 definition that is usually appropriate, refer to @file{expr.h} for additional
2947 documentation.
2949 @findex FUNCTION_INCOMING_ARG
2950 @item FUNCTION_INCOMING_ARG (@var{cum}, @var{mode}, @var{type}, @var{named})
2951 Define this macro if the target machine has ``register windows'', so
2952 that the register in which a function sees an arguments is not
2953 necessarily the same as the one in which the caller passed the
2954 argument.
2956 For such machines, @code{FUNCTION_ARG} computes the register in which
2957 the caller passes the value, and @code{FUNCTION_INCOMING_ARG} should
2958 be defined in a similar fashion to tell the function being called
2959 where the arguments will arrive.
2961 If @code{FUNCTION_INCOMING_ARG} is not defined, @code{FUNCTION_ARG}
2962 serves both purposes.@refill
2964 @findex FUNCTION_ARG_PARTIAL_NREGS
2965 @item FUNCTION_ARG_PARTIAL_NREGS (@var{cum}, @var{mode}, @var{type}, @var{named})
2966 A C expression for the number of words, at the beginning of an
2967 argument, that must be put in registers.  The value must be zero for
2968 arguments that are passed entirely in registers or that are entirely
2969 pushed on the stack.
2971 On some machines, certain arguments must be passed partially in
2972 registers and partially in memory.  On these machines, typically the
2973 first @var{n} words of arguments are passed in registers, and the rest
2974 on the stack.  If a multi-word argument (a @code{double} or a
2975 structure) crosses that boundary, its first few words must be passed
2976 in registers and the rest must be pushed.  This macro tells the
2977 compiler when this occurs, and how many of the words should go in
2978 registers.
2980 @code{FUNCTION_ARG} for these arguments should return the first
2981 register to be used by the caller for this argument; likewise
2982 @code{FUNCTION_INCOMING_ARG}, for the called function.
2984 @findex FUNCTION_ARG_PASS_BY_REFERENCE
2985 @item FUNCTION_ARG_PASS_BY_REFERENCE (@var{cum}, @var{mode}, @var{type}, @var{named})
2986 A C expression that indicates when an argument must be passed by reference.
2987 If nonzero for an argument, a copy of that argument is made in memory and a
2988 pointer to the argument is passed instead of the argument itself.
2989 The pointer is passed in whatever way is appropriate for passing a pointer
2990 to that type.
2992 On machines where @code{REG_PARM_STACK_SPACE} is not defined, a suitable
2993 definition of this macro might be
2994 @smallexample
2995 #define FUNCTION_ARG_PASS_BY_REFERENCE\
2996 (CUM, MODE, TYPE, NAMED)  \
2997   MUST_PASS_IN_STACK (MODE, TYPE)
2998 @end smallexample
2999 @c this is *still* too long.  --mew 5feb93
3001 @findex FUNCTION_ARG_CALLEE_COPIES
3002 @item FUNCTION_ARG_CALLEE_COPIES (@var{cum}, @var{mode}, @var{type}, @var{named})
3003 If defined, a C expression that indicates when it is the called function's
3004 responsibility to make a copy of arguments passed by invisible reference.
3005 Normally, the caller makes a copy and passes the address of the copy to the
3006 routine being called.  When FUNCTION_ARG_CALLEE_COPIES is defined and is
3007 nonzero, the caller does not make a copy.  Instead, it passes a pointer to the
3008 ``live'' value.  The called function must not modify this value.  If it can be
3009 determined that the value won't be modified, it need not make a copy;
3010 otherwise a copy must be made.
3012 @findex CUMULATIVE_ARGS
3013 @item CUMULATIVE_ARGS
3014 A C type for declaring a variable that is used as the first argument of
3015 @code{FUNCTION_ARG} and other related values.  For some target machines,
3016 the type @code{int} suffices and can hold the number of bytes of
3017 argument so far.
3019 There is no need to record in @code{CUMULATIVE_ARGS} anything about the
3020 arguments that have been passed on the stack.  The compiler has other
3021 variables to keep track of that.  For target machines on which all
3022 arguments are passed on the stack, there is no need to store anything in
3023 @code{CUMULATIVE_ARGS}; however, the data structure must exist and
3024 should not be empty, so use @code{int}.
3026 @findex INIT_CUMULATIVE_ARGS
3027 @item INIT_CUMULATIVE_ARGS (@var{cum}, @var{fntype}, @var{libname}, @var{indirect})
3028 A C statement (sans semicolon) for initializing the variable @var{cum}
3029 for the state at the beginning of the argument list.  The variable has
3030 type @code{CUMULATIVE_ARGS}.  The value of @var{fntype} is the tree node
3031 for the data type of the function which will receive the args, or 0
3032 if the args are to a compiler support library function.  The value of
3033 @var{indirect} is nonzero when processing an indirect call, for example
3034 a call through a function pointer.  The value of @var{indirect} is zero
3035 for a call to an explicitly named function, a library function call, or when
3036 @code{INIT_CUMULATIVE_ARGS} is used to find arguments for the function
3037 being compiled.
3039 When processing a call to a compiler support library function,
3040 @var{libname} identifies which one.  It is a @code{symbol_ref} rtx which
3041 contains the name of the function, as a string.  @var{libname} is 0 when
3042 an ordinary C function call is being processed.  Thus, each time this
3043 macro is called, either @var{libname} or @var{fntype} is nonzero, but
3044 never both of them at once.
3046 @findex INIT_CUMULATIVE_INCOMING_ARGS
3047 @item INIT_CUMULATIVE_INCOMING_ARGS (@var{cum}, @var{fntype}, @var{libname})
3048 Like @code{INIT_CUMULATIVE_ARGS} but overrides it for the purposes of
3049 finding the arguments for the function being compiled.  If this macro is
3050 undefined, @code{INIT_CUMULATIVE_ARGS} is used instead.
3052 The value passed for @var{libname} is always 0, since library routines
3053 with special calling conventions are never compiled with GCC.  The
3054 argument @var{libname} exists for symmetry with
3055 @code{INIT_CUMULATIVE_ARGS}.
3056 @c could use "this macro" in place of @code{INIT_CUMULATIVE_ARGS}, maybe.
3057 @c --mew 5feb93   i switched the order of the sentences.  --mew 10feb93
3059 @findex FUNCTION_ARG_ADVANCE
3060 @item FUNCTION_ARG_ADVANCE (@var{cum}, @var{mode}, @var{type}, @var{named})
3061 A C statement (sans semicolon) to update the summarizer variable
3062 @var{cum} to advance past an argument in the argument list.  The
3063 values @var{mode}, @var{type} and @var{named} describe that argument.
3064 Once this is done, the variable @var{cum} is suitable for analyzing
3065 the @emph{following} argument with @code{FUNCTION_ARG}, etc.@refill
3067 This macro need not do anything if the argument in question was passed
3068 on the stack.  The compiler knows how to track the amount of stack space
3069 used for arguments without any special help.
3071 @findex FUNCTION_ARG_PADDING
3072 @item FUNCTION_ARG_PADDING (@var{mode}, @var{type})
3073 If defined, a C expression which determines whether, and in which direction,
3074 to pad out an argument with extra space.  The value should be of type
3075 @code{enum direction}: either @code{upward} to pad above the argument,
3076 @code{downward} to pad below, or @code{none} to inhibit padding.
3078 The @emph{amount} of padding is always just enough to reach the next
3079 multiple of @code{FUNCTION_ARG_BOUNDARY}; this macro does not control
3082 This macro has a default definition which is right for most systems.
3083 For little-endian machines, the default is to pad upward.  For
3084 big-endian machines, the default is to pad downward for an argument of
3085 constant size shorter than an @code{int}, and upward otherwise.
3087 @findex PAD_VARARGS_DOWN
3088 @item PAD_VARARGS_DOWN
3089 If defined, a C expression which determines whether the default 
3090 implementation of va_arg will attempt to pad down before reading the 
3091 next argument, if that argument is smaller than its aligned space as
3092 controlled by @code{PARM_BOUNDARY}.  If this macro is not defined, all such
3093 arguments are padded down if @code{BYTES_BIG_ENDIAN} is true.
3095 @findex FUNCTION_ARG_BOUNDARY
3096 @item FUNCTION_ARG_BOUNDARY (@var{mode}, @var{type})
3097 If defined, a C expression that gives the alignment boundary, in bits,
3098 of an argument with the specified mode and type.  If it is not defined,
3099 @code{PARM_BOUNDARY} is used for all arguments.
3101 @findex FUNCTION_ARG_REGNO_P
3102 @item FUNCTION_ARG_REGNO_P (@var{regno})
3103 A C expression that is nonzero if @var{regno} is the number of a hard
3104 register in which function arguments are sometimes passed.  This does
3105 @emph{not} include implicit arguments such as the static chain and
3106 the structure-value address.  On many machines, no registers can be
3107 used for this purpose since all function arguments are pushed on the
3108 stack.
3110 @findex LOAD_ARGS_REVERSED
3111 @item LOAD_ARGS_REVERSED
3112 If defined, the order in which arguments are loaded into their
3113 respective argument registers is reversed so that the last 
3114 argument is loaded first.  This macro only affects arguments
3115 passed in registers.
3117 @end table
3119 @node Scalar Return
3120 @subsection How Scalar Function Values Are Returned
3121 @cindex return values in registers
3122 @cindex values, returned by functions
3123 @cindex scalars, returned as values
3125 This section discusses the macros that control returning scalars as
3126 values---values that can fit in registers.
3128 @table @code
3129 @findex TRADITIONAL_RETURN_FLOAT
3130 @item TRADITIONAL_RETURN_FLOAT
3131 Define this macro if @samp{-traditional} should not cause functions
3132 declared to return @code{float} to convert the value to @code{double}.
3134 @findex FUNCTION_VALUE
3135 @item FUNCTION_VALUE (@var{valtype}, @var{func})
3136 A C expression to create an RTX representing the place where a
3137 function returns a value of data type @var{valtype}.  @var{valtype} is
3138 a tree node representing a data type.  Write @code{TYPE_MODE
3139 (@var{valtype})} to get the machine mode used to represent that type.
3140 On many machines, only the mode is relevant.  (Actually, on most
3141 machines, scalar values are returned in the same place regardless of
3142 mode).@refill
3144 The value of the expression is usually a @code{reg} RTX for the hard
3145 register where the return value is stored.  The value can also be a
3146 @code{parallel} RTX, if the return value is in multiple places.  See
3147 @code{FUNCTION_ARG} for an explanation of the @code{parallel} form.
3149 If @code{PROMOTE_FUNCTION_RETURN} is defined, you must apply the same
3150 promotion rules specified in @code{PROMOTE_MODE} if @var{valtype} is a
3151 scalar type.
3153 If the precise function being called is known, @var{func} is a tree
3154 node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null
3155 pointer.  This makes it possible to use a different value-returning
3156 convention for specific functions when all their calls are
3157 known.@refill
3159 @code{FUNCTION_VALUE} is not used for return vales with aggregate data
3160 types, because these are returned in another way.  See
3161 @code{STRUCT_VALUE_REGNUM} and related macros, below.
3163 @findex FUNCTION_OUTGOING_VALUE
3164 @item FUNCTION_OUTGOING_VALUE (@var{valtype}, @var{func})
3165 Define this macro if the target machine has ``register windows''
3166 so that the register in which a function returns its value is not
3167 the same as the one in which the caller sees the value.
3169 For such machines, @code{FUNCTION_VALUE} computes the register in which
3170 the caller will see the value.  @code{FUNCTION_OUTGOING_VALUE} should be
3171 defined in a similar fashion to tell the function where to put the
3172 value.@refill
3174 If @code{FUNCTION_OUTGOING_VALUE} is not defined,
3175 @code{FUNCTION_VALUE} serves both purposes.@refill
3177 @code{FUNCTION_OUTGOING_VALUE} is not used for return vales with
3178 aggregate data types, because these are returned in another way.  See
3179 @code{STRUCT_VALUE_REGNUM} and related macros, below.
3181 @findex LIBCALL_VALUE
3182 @item LIBCALL_VALUE (@var{mode})
3183 A C expression to create an RTX representing the place where a library
3184 function returns a value of mode @var{mode}.  If the precise function
3185 being called is known, @var{func} is a tree node
3186 (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null
3187 pointer.  This makes it possible to use a different value-returning
3188 convention for specific functions when all their calls are
3189 known.@refill
3191 Note that ``library function'' in this context means a compiler
3192 support routine, used to perform arithmetic, whose name is known
3193 specially by the compiler and was not mentioned in the C code being
3194 compiled.
3196 The definition of @code{LIBRARY_VALUE} need not be concerned aggregate
3197 data types, because none of the library functions returns such types.
3199 @findex FUNCTION_VALUE_REGNO_P
3200 @item FUNCTION_VALUE_REGNO_P (@var{regno})
3201 A C expression that is nonzero if @var{regno} is the number of a hard
3202 register in which the values of called function may come back.
3204 A register whose use for returning values is limited to serving as the
3205 second of a pair (for a value of type @code{double}, say) need not be
3206 recognized by this macro.  So for most machines, this definition
3207 suffices:
3209 @example
3210 #define FUNCTION_VALUE_REGNO_P(N) ((N) == 0)
3211 @end example
3213 If the machine has register windows, so that the caller and the called
3214 function use different registers for the return value, this macro
3215 should recognize only the caller's register numbers.
3217 @findex APPLY_RESULT_SIZE
3218 @item APPLY_RESULT_SIZE
3219 Define this macro if @samp{untyped_call} and @samp{untyped_return}
3220 need more space than is implied by @code{FUNCTION_VALUE_REGNO_P} for
3221 saving and restoring an arbitrary return value.
3222 @end table
3224 @node Aggregate Return
3225 @subsection How Large Values Are Returned
3226 @cindex aggregates as return values
3227 @cindex large return values
3228 @cindex returning aggregate values
3229 @cindex structure value address
3231 When a function value's mode is @code{BLKmode} (and in some other
3232 cases), the value is not returned according to @code{FUNCTION_VALUE}
3233 (@pxref{Scalar Return}).  Instead, the caller passes the address of a
3234 block of memory in which the value should be stored.  This address
3235 is called the @dfn{structure value address}.
3237 This section describes how to control returning structure values in
3238 memory.
3240 @table @code
3241 @findex RETURN_IN_MEMORY
3242 @item RETURN_IN_MEMORY (@var{type})
3243 A C expression which can inhibit the returning of certain function
3244 values in registers, based on the type of value.  A nonzero value says
3245 to return the function value in memory, just as large structures are
3246 always returned.  Here @var{type} will be a C expression of type
3247 @code{tree}, representing the data type of the value.
3249 Note that values of mode @code{BLKmode} must be explicitly handled
3250 by this macro.  Also, the option @samp{-fpcc-struct-return}
3251 takes effect regardless of this macro.  On most systems, it is
3252 possible to leave the macro undefined; this causes a default
3253 definition to be used, whose value is the constant 1 for @code{BLKmode}
3254 values, and 0 otherwise.
3256 Do not use this macro to indicate that structures and unions should always
3257 be returned in memory.  You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}
3258 to indicate this.
3260 @findex DEFAULT_PCC_STRUCT_RETURN
3261 @item DEFAULT_PCC_STRUCT_RETURN
3262 Define this macro to be 1 if all structure and union return values must be
3263 in memory.  Since this results in slower code, this should be defined
3264 only if needed for compatibility with other compilers or with an ABI.
3265 If you define this macro to be 0, then the conventions used for structure
3266 and union return values are decided by the @code{RETURN_IN_MEMORY} macro.
3268 If not defined, this defaults to the value 1.
3270 @findex STRUCT_VALUE_REGNUM
3271 @item STRUCT_VALUE_REGNUM
3272 If the structure value address is passed in a register, then
3273 @code{STRUCT_VALUE_REGNUM} should be the number of that register.
3275 @findex STRUCT_VALUE
3276 @item STRUCT_VALUE
3277 If the structure value address is not passed in a register, define
3278 @code{STRUCT_VALUE} as an expression returning an RTX for the place
3279 where the address is passed.  If it returns 0, the address is passed as
3280 an ``invisible'' first argument.
3282 @findex STRUCT_VALUE_INCOMING_REGNUM
3283 @item STRUCT_VALUE_INCOMING_REGNUM
3284 On some architectures the place where the structure value address
3285 is found by the called function is not the same place that the
3286 caller put it.  This can be due to register windows, or it could
3287 be because the function prologue moves it to a different place.
3289 If the incoming location of the structure value address is in a
3290 register, define this macro as the register number.
3292 @findex STRUCT_VALUE_INCOMING
3293 @item STRUCT_VALUE_INCOMING
3294 If the incoming location is not a register, then you should define
3295 @code{STRUCT_VALUE_INCOMING} as an expression for an RTX for where the
3296 called function should find the value.  If it should find the value on
3297 the stack, define this to create a @code{mem} which refers to the frame
3298 pointer.  A definition of 0 means that the address is passed as an
3299 ``invisible'' first argument.
3301 @findex PCC_STATIC_STRUCT_RETURN
3302 @item PCC_STATIC_STRUCT_RETURN
3303 Define this macro if the usual system convention on the target machine
3304 for returning structures and unions is for the called function to return
3305 the address of a static variable containing the value.
3307 Do not define this if the usual system convention is for the caller to
3308 pass an address to the subroutine.
3310 This macro has effect in @samp{-fpcc-struct-return} mode, but it does
3311 nothing when you use @samp{-freg-struct-return} mode.
3312 @end table
3314 @node Caller Saves
3315 @subsection Caller-Saves Register Allocation
3317 If you enable it, GCC can save registers around function calls.  This
3318 makes it possible to use call-clobbered registers to hold variables that
3319 must live across calls.
3321 @table @code
3322 @findex DEFAULT_CALLER_SAVES
3323 @item DEFAULT_CALLER_SAVES
3324 Define this macro if function calls on the target machine do not preserve
3325 any registers; in other words, if @code{CALL_USED_REGISTERS} has 1
3326 for all registers.  When defined, this macro enables @samp{-fcaller-saves} 
3327 by default for all optimization levels.  It has no effect for optimization
3328 levels 2 and higher, where @samp{-fcaller-saves} is the default.
3330 @findex CALLER_SAVE_PROFITABLE
3331 @item CALLER_SAVE_PROFITABLE (@var{refs}, @var{calls})
3332 A C expression to determine whether it is worthwhile to consider placing
3333 a pseudo-register in a call-clobbered hard register and saving and
3334 restoring it around each function call.  The expression should be 1 when
3335 this is worth doing, and 0 otherwise.
3337 If you don't define this macro, a default is used which is good on most
3338 machines: @code{4 * @var{calls} < @var{refs}}.
3340 @findex HARD_REGNO_CALLER_SAVE_MODE
3341 @item HARD_REGNO_CALLER_SAVE_MODE (@var{regno}, @var{nregs})
3342 A C expression specifying which mode is required for saving @var{nregs}
3343 of a pseudo-register in call-clobbered hard register @var{regno}.  If
3344 @var{regno} is unsuitable for caller save, @code{VOIDmode} should be
3345 returned.  For most machines this macro need not be defined since GCC
3346 will select the smallest suitable mode.
3347 @end table
3349 @node Function Entry
3350 @subsection Function Entry and Exit
3351 @cindex function entry and exit
3352 @cindex prologue
3353 @cindex epilogue
3355 This section describes the macros that output function entry
3356 (@dfn{prologue}) and exit (@dfn{epilogue}) code.
3358 @table @code
3359 @findex FUNCTION_PROLOGUE
3360 @item FUNCTION_PROLOGUE (@var{file}, @var{size})
3361 A C compound statement that outputs the assembler code for entry to a
3362 function.  The prologue is responsible for setting up the stack frame,
3363 initializing the frame pointer register, saving registers that must be
3364 saved, and allocating @var{size} additional bytes of storage for the
3365 local variables.  @var{size} is an integer.  @var{file} is a stdio
3366 stream to which the assembler code should be output.
3368 The label for the beginning of the function need not be output by this
3369 macro.  That has already been done when the macro is run.
3371 @findex regs_ever_live
3372 To determine which registers to save, the macro can refer to the array
3373 @code{regs_ever_live}: element @var{r} is nonzero if hard register
3374 @var{r} is used anywhere within the function.  This implies the function
3375 prologue should save register @var{r}, provided it is not one of the
3376 call-used registers.  (@code{FUNCTION_EPILOGUE} must likewise use
3377 @code{regs_ever_live}.)
3379 On machines that have ``register windows'', the function entry code does
3380 not save on the stack the registers that are in the windows, even if
3381 they are supposed to be preserved by function calls; instead it takes
3382 appropriate steps to ``push'' the register stack, if any non-call-used
3383 registers are used in the function.
3385 @findex frame_pointer_needed
3386 On machines where functions may or may not have frame-pointers, the
3387 function entry code must vary accordingly; it must set up the frame
3388 pointer if one is wanted, and not otherwise.  To determine whether a
3389 frame pointer is in wanted, the macro can refer to the variable
3390 @code{frame_pointer_needed}.  The variable's value will be 1 at run
3391 time in a function that needs a frame pointer.  @xref{Elimination}.
3393 The function entry code is responsible for allocating any stack space
3394 required for the function.  This stack space consists of the regions
3395 listed below.  In most cases, these regions are allocated in the
3396 order listed, with the last listed region closest to the top of the
3397 stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and
3398 the highest address if it is not defined).  You can use a different order
3399 for a machine if doing so is more convenient or required for
3400 compatibility reasons.  Except in cases where required by standard
3401 or by a debugger, there is no reason why the stack layout used by GCC
3402 need agree with that used by other compilers for a machine.
3404 @itemize @bullet
3405 @item
3406 @findex current_function_pretend_args_size
3407 A region of @code{current_function_pretend_args_size} bytes of
3408 uninitialized space just underneath the first argument arriving on the
3409 stack.  (This may not be at the very start of the allocated stack region
3410 if the calling sequence has pushed anything else since pushing the stack
3411 arguments.  But usually, on such machines, nothing else has been pushed
3412 yet, because the function prologue itself does all the pushing.)  This
3413 region is used on machines where an argument may be passed partly in
3414 registers and partly in memory, and, in some cases to support the
3415 features in @file{varargs.h} and @file{stdargs.h}.
3417 @item
3418 An area of memory used to save certain registers used by the function.
3419 The size of this area, which may also include space for such things as
3420 the return address and pointers to previous stack frames, is
3421 machine-specific and usually depends on which registers have been used
3422 in the function.  Machines with register windows often do not require
3423 a save area.
3425 @item
3426 A region of at least @var{size} bytes, possibly rounded up to an allocation
3427 boundary, to contain the local variables of the function.  On some machines,
3428 this region and the save area may occur in the opposite order, with the
3429 save area closer to the top of the stack.
3431 @item
3432 @cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames
3433 Optionally, when @code{ACCUMULATE_OUTGOING_ARGS} is defined, a region of
3434 @code{current_function_outgoing_args_size} bytes to be used for outgoing
3435 argument lists of the function.  @xref{Stack Arguments}.
3436 @end itemize
3438 Normally, it is necessary for the macros @code{FUNCTION_PROLOGUE} and
3439 @code{FUNCTION_EPILOGUE} to treat leaf functions specially.  The C
3440 variable @code{current_function_is_leaf} is nonzero for such a function.
3442 @findex EXIT_IGNORE_STACK
3443 @item EXIT_IGNORE_STACK
3444 Define this macro as a C expression that is nonzero if the return
3445 instruction or the function epilogue ignores the value of the stack
3446 pointer; in other words, if it is safe to delete an instruction to
3447 adjust the stack pointer before a return from the function.
3449 Note that this macro's value is relevant only for functions for which
3450 frame pointers are maintained.  It is never safe to delete a final
3451 stack adjustment in a function that has no frame pointer, and the
3452 compiler knows this regardless of @code{EXIT_IGNORE_STACK}.
3454 @findex EPILOGUE_USES
3455 @item EPILOGUE_USES (@var{regno})
3456 Define this macro as a C expression that is nonzero for registers that are
3457 used by the epilogue or the @samp{return} pattern.  The stack and frame
3458 pointer registers are already be assumed to be used as needed.
3460 @findex FUNCTION_EPILOGUE
3461 @item FUNCTION_EPILOGUE (@var{file}, @var{size})
3462 A C compound statement that outputs the assembler code for exit from a
3463 function.  The epilogue is responsible for restoring the saved
3464 registers and stack pointer to their values when the function was
3465 called, and returning control to the caller.  This macro takes the
3466 same arguments as the macro @code{FUNCTION_PROLOGUE}, and the
3467 registers to restore are determined from @code{regs_ever_live} and
3468 @code{CALL_USED_REGISTERS} in the same way.
3470 On some machines, there is a single instruction that does all the work
3471 of returning from the function.  On these machines, give that
3472 instruction the name @samp{return} and do not define the macro
3473 @code{FUNCTION_EPILOGUE} at all.
3475 Do not define a pattern named @samp{return} if you want the
3476 @code{FUNCTION_EPILOGUE} to be used.  If you want the target switches
3477 to control whether return instructions or epilogues are used, define a
3478 @samp{return} pattern with a validity condition that tests the target
3479 switches appropriately.  If the @samp{return} pattern's validity
3480 condition is false, epilogues will be used.
3482 On machines where functions may or may not have frame-pointers, the
3483 function exit code must vary accordingly.  Sometimes the code for these
3484 two cases is completely different.  To determine whether a frame pointer
3485 is wanted, the macro can refer to the variable
3486 @code{frame_pointer_needed}.  The variable's value will be 1 when compiling
3487 a function that needs a frame pointer.
3489 Normally, @code{FUNCTION_PROLOGUE} and @code{FUNCTION_EPILOGUE} must
3490 treat leaf functions specially.  The C variable @code{current_function_is_leaf}
3491 is nonzero for such a function.  @xref{Leaf Functions}.
3493 On some machines, some functions pop their arguments on exit while
3494 others leave that for the caller to do.  For example, the 68020 when
3495 given @samp{-mrtd} pops arguments in functions that take a fixed
3496 number of arguments.
3498 @findex current_function_pops_args
3499 Your definition of the macro @code{RETURN_POPS_ARGS} decides which
3500 functions pop their own arguments.  @code{FUNCTION_EPILOGUE} needs to
3501 know what was decided.  The variable that is called
3502 @code{current_function_pops_args} is the number of bytes of its
3503 arguments that a function should pop.  @xref{Scalar Return}.
3504 @c what is the "its arguments" in the above sentence referring to, pray
3505 @c tell?  --mew 5feb93
3507 @findex DELAY_SLOTS_FOR_EPILOGUE
3508 @item DELAY_SLOTS_FOR_EPILOGUE
3509 Define this macro if the function epilogue contains delay slots to which
3510 instructions from the rest of the function can be ``moved''.  The
3511 definition should be a C expression whose value is an integer
3512 representing the number of delay slots there.
3514 @findex ELIGIBLE_FOR_EPILOGUE_DELAY
3515 @item ELIGIBLE_FOR_EPILOGUE_DELAY (@var{insn}, @var{n})
3516 A C expression that returns 1 if @var{insn} can be placed in delay
3517 slot number @var{n} of the epilogue.
3519 The argument @var{n} is an integer which identifies the delay slot now
3520 being considered (since different slots may have different rules of
3521 eligibility).  It is never negative and is always less than the number
3522 of epilogue delay slots (what @code{DELAY_SLOTS_FOR_EPILOGUE} returns).
3523 If you reject a particular insn for a given delay slot, in principle, it
3524 may be reconsidered for a subsequent delay slot.  Also, other insns may
3525 (at least in principle) be considered for the so far unfilled delay
3526 slot.
3528 @findex current_function_epilogue_delay_list
3529 @findex final_scan_insn
3530 The insns accepted to fill the epilogue delay slots are put in an RTL
3531 list made with @code{insn_list} objects, stored in the variable
3532 @code{current_function_epilogue_delay_list}.  The insn for the first
3533 delay slot comes first in the list.  Your definition of the macro
3534 @code{FUNCTION_EPILOGUE} should fill the delay slots by outputting the
3535 insns in this list, usually by calling @code{final_scan_insn}.
3537 You need not define this macro if you did not define
3538 @code{DELAY_SLOTS_FOR_EPILOGUE}.
3540 @findex ASM_OUTPUT_MI_THUNK
3541 @item ASM_OUTPUT_MI_THUNK (@var{file}, @var{thunk_fndecl}, @var{delta}, @var{function})
3542 A C compound statement that outputs the assembler code for a thunk
3543 function, used to implement C++ virtual function calls with multiple
3544 inheritance.  The thunk acts as a wrapper around a virtual function,
3545 adjusting the implicit object parameter before handing control off to
3546 the real function.
3548 First, emit code to add the integer @var{delta} to the location that
3549 contains the incoming first argument.  Assume that this argument
3550 contains a pointer, and is the one used to pass the @code{this} pointer
3551 in C++.  This is the incoming argument @emph{before} the function prologue,
3552 e.g. @samp{%o0} on a sparc.  The addition must preserve the values of
3553 all other incoming arguments.
3555 After the addition, emit code to jump to @var{function}, which is a
3556 @code{FUNCTION_DECL}.  This is a direct pure jump, not a call, and does
3557 not touch the return address.  Hence returning from @var{FUNCTION} will
3558 return to whoever called the current @samp{thunk}.
3560 The effect must be as if @var{function} had been called directly with
3561 the adjusted first argument.  This macro is responsible for emitting all
3562 of the code for a thunk function; @code{FUNCTION_PROLOGUE} and
3563 @code{FUNCTION_EPILOGUE} are not invoked.
3565 The @var{thunk_fndecl} is redundant.  (@var{delta} and @var{function}
3566 have already been extracted from it.)  It might possibly be useful on
3567 some targets, but probably not.
3569 If you do not define this macro, the target-independent code in the C++
3570 frontend will generate a less efficient heavyweight thunk that calls
3571 @var{function} instead of jumping to it.  The generic approach does
3572 not support varargs.
3573 @end table
3575 @node Profiling
3576 @subsection Generating Code for Profiling
3577 @cindex profiling, code generation
3579 These macros will help you generate code for profiling.
3581 @table @code
3582 @findex FUNCTION_PROFILER
3583 @item FUNCTION_PROFILER (@var{file}, @var{labelno})
3584 A C statement or compound statement to output to @var{file} some
3585 assembler code to call the profiling subroutine @code{mcount}.
3587 @findex mcount
3588 The details of how @code{mcount} expects to be called are determined by
3589 your operating system environment, not by GCC.  To figure them out,
3590 compile a small program for profiling using the system's installed C
3591 compiler and look at the assembler code that results.
3593 Older implementations of @code{mcount} expect the address of a counter
3594 variable to be loaded into some register.  The name of this variable is
3595 @samp{LP} followed by the number @var{labelno}, so you would generate
3596 the name using @samp{LP%d} in a @code{fprintf}.
3598 @findex NO_PROFILE_COUNTERS
3599 @item NO_PROFILE_COUNTERS
3600 Define this macro if the @code{mcount} subroutine on your system does
3601 not need a counter variable allocated for each function.  This is true
3602 for almost all modern implementations.  If you define this macro, you
3603 must not use the @var{labelno} argument to @code{FUNCTION_PROFILER}.
3605 @findex PROFILE_BEFORE_PROLOGUE
3606 @item PROFILE_BEFORE_PROLOGUE
3607 Define this macro if the code for function profiling should come before
3608 the function prologue.  Normally, the profiling code comes after.
3610 @findex FUNCTION_BLOCK_PROFILER
3611 @vindex profile_block_flag
3612 @item FUNCTION_BLOCK_PROFILER (@var{file}, @var{labelno})
3613 A C statement or compound statement to output to @var{file} some
3614 assembler code to initialize basic-block profiling for the current
3615 object module.  The global compile flag @code{profile_block_flag}
3616 distinguishes two profile modes.
3618 @table @code
3619 @findex __bb_init_func
3620 @item profile_block_flag != 2
3621 Output code to call the subroutine @code{__bb_init_func} once per
3622 object module, passing it as its sole argument the address of a block
3623 allocated in the object module.
3625 The name of the block is a local symbol made with this statement:
3627 @smallexample
3628 ASM_GENERATE_INTERNAL_LABEL (@var{buffer}, "LPBX", 0);
3629 @end smallexample
3631 Of course, since you are writing the definition of
3632 @code{ASM_GENERATE_INTERNAL_LABEL} as well as that of this macro, you
3633 can take a short cut in the definition of this macro and use the name
3634 that you know will result.
3636 The first word of this block is a flag which will be nonzero if the
3637 object module has already been initialized.  So test this word first,
3638 and do not call @code{__bb_init_func} if the flag is
3639 nonzero.  BLOCK_OR_LABEL contains a unique number which may be used to
3640 generate a label as a branch destination when @code{__bb_init_func}
3641 will not be called.
3643 Described in assembler language, the code to be output looks like:
3645 @example
3646   cmp (LPBX0),0
3647   bne local_label
3648   parameter1 <- LPBX0
3649   call __bb_init_func
3650 local_label:
3651 @end example
3653 @findex __bb_init_trace_func
3654 @item profile_block_flag == 2
3655 Output code to call the subroutine @code{__bb_init_trace_func}
3656 and pass two parameters to it.  The first parameter is the same as
3657 for @code{__bb_init_func}.  The second parameter is the number of the
3658 first basic block of the function as given by BLOCK_OR_LABEL.  Note
3659 that @code{__bb_init_trace_func} has to be called, even if the object
3660 module has been initialized already.
3662 Described in assembler language, the code to be output looks like:
3663 @example
3664 parameter1 <- LPBX0
3665 parameter2 <- BLOCK_OR_LABEL
3666 call __bb_init_trace_func
3667 @end example
3668 @end table
3670 @findex BLOCK_PROFILER
3671 @vindex profile_block_flag
3672 @item BLOCK_PROFILER (@var{file}, @var{blockno})
3673 A C statement or compound statement to output to @var{file} some
3674 assembler code to increment the count associated with the basic
3675 block number @var{blockno}.  The global compile flag
3676 @code{profile_block_flag} distinguishes two profile modes.
3678 @table @code
3679 @item profile_block_flag != 2
3680 Output code to increment the counter directly.  Basic blocks are
3681 numbered separately from zero within each compilation.  The count
3682 associated with block number @var{blockno} is at index
3683 @var{blockno} in a vector of words; the name of this array is a local
3684 symbol made with this statement:
3686 @smallexample
3687 ASM_GENERATE_INTERNAL_LABEL (@var{buffer}, "LPBX", 2);
3688 @end smallexample
3690 @c This paragraph is the same as one a few paragraphs up.
3691 @c That is not an error.
3692 Of course, since you are writing the definition of
3693 @code{ASM_GENERATE_INTERNAL_LABEL} as well as that of this macro, you
3694 can take a short cut in the definition of this macro and use the name
3695 that you know will result.
3697 Described in assembler language, the code to be output looks like:
3699 @smallexample
3700 inc (LPBX2+4*BLOCKNO)
3701 @end smallexample
3703 @vindex __bb
3704 @findex __bb_trace_func
3705 @item profile_block_flag == 2
3706 Output code to initialize the global structure @code{__bb} and
3707 call the function @code{__bb_trace_func}, which will increment the
3708 counter.
3710 @code{__bb} consists of two words.  In the first word, the current
3711 basic block number, as given by BLOCKNO, has to be stored.  In
3712 the second word, the address of a block allocated in the object
3713 module has to be stored.  The address is given by the label created
3714 with this statement:
3716 @smallexample
3717 ASM_GENERATE_INTERNAL_LABEL (@var{buffer}, "LPBX", 0);
3718 @end smallexample
3720 Described in assembler language, the code to be output looks like:
3721 @example
3722 move BLOCKNO -> (__bb)
3723 move LPBX0 -> (__bb+4)
3724 call __bb_trace_func
3725 @end example
3726 @end table
3728 @findex FUNCTION_BLOCK_PROFILER_EXIT
3729 @findex __bb_trace_ret
3730 @vindex profile_block_flag
3731 @item FUNCTION_BLOCK_PROFILER_EXIT (@var{file})
3732 A C statement or compound statement to output to @var{file}
3733 assembler code to call function @code{__bb_trace_ret}.  The
3734 assembler code should only be output
3735 if the global compile flag @code{profile_block_flag} == 2.  This
3736 macro has to be used at every place where code for returning from
3737 a function is generated (e.g. @code{FUNCTION_EPILOGUE}).  Although
3738 you have to write the definition of @code{FUNCTION_EPILOGUE}
3739 as well, you have to define this macro to tell the compiler, that
3740 the proper call to @code{__bb_trace_ret} is produced.
3742 @findex MACHINE_STATE_SAVE
3743 @findex __bb_init_trace_func
3744 @findex __bb_trace_func
3745 @findex __bb_trace_ret
3746 @item MACHINE_STATE_SAVE (@var{id})
3747 A C statement or compound statement to save all registers, which may
3748 be clobbered by a function call, including condition codes.  The
3749 @code{asm} statement will be mostly likely needed to handle this
3750 task.  Local labels in the assembler code can be concatenated with the
3751 string @var{id}, to obtain a unique label name.
3753 Registers or condition codes clobbered by @code{FUNCTION_PROLOGUE} or
3754 @code{FUNCTION_EPILOGUE} must be saved in the macros
3755 @code{FUNCTION_BLOCK_PROFILER}, @code{FUNCTION_BLOCK_PROFILER_EXIT} and
3756 @code{BLOCK_PROFILER} prior calling @code{__bb_init_trace_func},
3757 @code{__bb_trace_ret} and @code{__bb_trace_func} respectively.
3759 @findex MACHINE_STATE_RESTORE
3760 @findex __bb_init_trace_func
3761 @findex __bb_trace_func
3762 @findex __bb_trace_ret
3763 @item MACHINE_STATE_RESTORE (@var{id})
3764 A C statement or compound statement to restore all registers, including
3765 condition codes, saved by @code{MACHINE_STATE_SAVE}.
3767 Registers or condition codes clobbered by @code{FUNCTION_PROLOGUE} or
3768 @code{FUNCTION_EPILOGUE} must be restored in the macros
3769 @code{FUNCTION_BLOCK_PROFILER}, @code{FUNCTION_BLOCK_PROFILER_EXIT} and
3770 @code{BLOCK_PROFILER} after calling @code{__bb_init_trace_func},
3771 @code{__bb_trace_ret} and @code{__bb_trace_func} respectively.
3773 @findex BLOCK_PROFILER_CODE
3774 @item BLOCK_PROFILER_CODE
3775 A C function or functions which are needed in the library to
3776 support block profiling.
3777 @end table
3779 @node Inlining
3780 @subsection Permitting inlining of functions with attributes
3781 @cindex inlining
3783 By default if a function has a target specific attribute attached to it,
3784 it will not be inlined.  This behaviour can be overridden if the target
3785 defines the @samp{FUNCTION_ATTRIBUTE_INLINABLE_P} macro.  This macro
3786 takes one argument, a @samp{DECL} describing the function.  It should
3787 return non-zero if the function can be inlined, otherwise it should
3788 return 0.
3790 @node Tail Calling
3791 @subsection Permitting tail calls to functions
3792 @cindex tail calls
3793 @cindex sibling calls
3795 @table @code
3796 @findex FUNCTION_OK_FOR_SIBCALL
3797 @item FUNCTION_OK_FOR_SIBCALL (@var{decl})
3798 A C expression that evaluates to true if it is ok to perform a sibling
3799 call to @var{decl}.  
3801 It is not uncommon for limitations of calling conventions to prevent
3802 tail calls to functions outside the current unit of translation, or
3803 during PIC compilation.  Use this macro to enforce these restrictions,
3804 as the @code{sibcall} md pattern can not fail, or fall over to a 
3805 ``normal'' call.
3806 @end table
3808 @node Varargs
3809 @section Implementing the Varargs Macros
3810 @cindex varargs implementation
3812 GCC comes with an implementation of @file{varargs.h} and
3813 @file{stdarg.h} that work without change on machines that pass arguments
3814 on the stack.  Other machines require their own implementations of
3815 varargs, and the two machine independent header files must have
3816 conditionals to include it.
3818 ANSI @file{stdarg.h} differs from traditional @file{varargs.h} mainly in
3819 the calling convention for @code{va_start}.  The traditional
3820 implementation takes just one argument, which is the variable in which
3821 to store the argument pointer.  The ANSI implementation of
3822 @code{va_start} takes an additional second argument.  The user is
3823 supposed to write the last named argument of the function here.
3825 However, @code{va_start} should not use this argument.  The way to find
3826 the end of the named arguments is with the built-in functions described
3827 below.
3829 @table @code
3830 @findex __builtin_saveregs
3831 @item __builtin_saveregs ()
3832 Use this built-in function to save the argument registers in memory so
3833 that the varargs mechanism can access them.  Both ANSI and traditional
3834 versions of @code{va_start} must use @code{__builtin_saveregs}, unless
3835 you use @code{SETUP_INCOMING_VARARGS} (see below) instead.
3837 On some machines, @code{__builtin_saveregs} is open-coded under the
3838 control of the macro @code{EXPAND_BUILTIN_SAVEREGS}.  On other machines,
3839 it calls a routine written in assembler language, found in
3840 @file{libgcc2.c}.
3842 Code generated for the call to @code{__builtin_saveregs} appears at the
3843 beginning of the function, as opposed to where the call to
3844 @code{__builtin_saveregs} is written, regardless of what the code is.
3845 This is because the registers must be saved before the function starts
3846 to use them for its own purposes.
3847 @c i rewrote the first sentence above to fix an overfull hbox. --mew
3848 @c 10feb93
3850 @findex __builtin_args_info
3851 @item __builtin_args_info (@var{category})
3852 Use this built-in function to find the first anonymous arguments in
3853 registers.
3855 In general, a machine may have several categories of registers used for
3856 arguments, each for a particular category of data types.  (For example,
3857 on some machines, floating-point registers are used for floating-point
3858 arguments while other arguments are passed in the general registers.)
3859 To make non-varargs functions use the proper calling convention, you
3860 have defined the @code{CUMULATIVE_ARGS} data type to record how many
3861 registers in each category have been used so far
3863 @code{__builtin_args_info} accesses the same data structure of type
3864 @code{CUMULATIVE_ARGS} after the ordinary argument layout is finished
3865 with it, with @var{category} specifying which word to access.  Thus, the
3866 value indicates the first unused register in a given category.
3868 Normally, you would use @code{__builtin_args_info} in the implementation
3869 of @code{va_start}, accessing each category just once and storing the
3870 value in the @code{va_list} object.  This is because @code{va_list} will
3871 have to update the values, and there is no way to alter the
3872 values accessed by @code{__builtin_args_info}.
3874 @findex __builtin_next_arg
3875 @item __builtin_next_arg (@var{lastarg})
3876 This is the equivalent of @code{__builtin_args_info}, for stack
3877 arguments.  It returns the address of the first anonymous stack
3878 argument, as type @code{void *}. If @code{ARGS_GROW_DOWNWARD}, it
3879 returns the address of the location above the first anonymous stack
3880 argument.  Use it in @code{va_start} to initialize the pointer for
3881 fetching arguments from the stack.  Also use it in @code{va_start} to
3882 verify that the second parameter @var{lastarg} is the last named argument
3883 of the current function.
3885 @findex __builtin_classify_type
3886 @item __builtin_classify_type (@var{object})
3887 Since each machine has its own conventions for which data types are
3888 passed in which kind of register, your implementation of @code{va_arg}
3889 has to embody these conventions.  The easiest way to categorize the
3890 specified data type is to use @code{__builtin_classify_type} together
3891 with @code{sizeof} and @code{__alignof__}.
3893 @code{__builtin_classify_type} ignores the value of @var{object},
3894 considering only its data type.  It returns an integer describing what
3895 kind of type that is---integer, floating, pointer, structure, and so on.
3897 The file @file{typeclass.h} defines an enumeration that you can use to
3898 interpret the values of @code{__builtin_classify_type}.
3899 @end table
3901 These machine description macros help implement varargs:
3903 @table @code
3904 @findex EXPAND_BUILTIN_SAVEREGS
3905 @item EXPAND_BUILTIN_SAVEREGS ()
3906 If defined, is a C expression that produces the machine-specific code
3907 for a call to @code{__builtin_saveregs}.  This code will be moved to the
3908 very beginning of the function, before any parameter access are made.
3909 The return value of this function should be an RTX that contains the
3910 value to use as the return of @code{__builtin_saveregs}.
3912 @findex SETUP_INCOMING_VARARGS
3913 @item SETUP_INCOMING_VARARGS (@var{args_so_far}, @var{mode}, @var{type}, @var{pretend_args_size}, @var{second_time})
3914 This macro offers an alternative to using @code{__builtin_saveregs} and
3915 defining the macro @code{EXPAND_BUILTIN_SAVEREGS}.  Use it to store the
3916 anonymous register arguments into the stack so that all the arguments
3917 appear to have been passed consecutively on the stack.  Once this is
3918 done, you can use the standard implementation of varargs that works for
3919 machines that pass all their arguments on the stack.
3921 The argument @var{args_so_far} is the @code{CUMULATIVE_ARGS} data
3922 structure, containing the values that are obtained after processing the
3923 named arguments.  The arguments @var{mode} and @var{type} describe the
3924 last named argument---its machine mode and its data type as a tree node.
3926 The macro implementation should do two things: first, push onto the
3927 stack all the argument registers @emph{not} used for the named
3928 arguments, and second, store the size of the data thus pushed into the
3929 @code{int}-valued variable whose name is supplied as the argument
3930 @var{pretend_args_size}.  The value that you store here will serve as
3931 additional offset for setting up the stack frame.
3933 Because you must generate code to push the anonymous arguments at
3934 compile time without knowing their data types,
3935 @code{SETUP_INCOMING_VARARGS} is only useful on machines that have just
3936 a single category of argument register and use it uniformly for all data
3937 types.
3939 If the argument @var{second_time} is nonzero, it means that the
3940 arguments of the function are being analyzed for the second time.  This
3941 happens for an inline function, which is not actually compiled until the
3942 end of the source file.  The macro @code{SETUP_INCOMING_VARARGS} should
3943 not generate any instructions in this case.
3945 @findex STRICT_ARGUMENT_NAMING
3946 @item STRICT_ARGUMENT_NAMING
3947 Define this macro to be a nonzero value if the location where a function
3948 argument is passed depends on whether or not it is a named argument.
3950 This macro controls how the @var{named} argument to @code{FUNCTION_ARG}
3951 is set for varargs and stdarg functions.  If this macro returns a
3952 nonzero value, the @var{named} argument is always true for named
3953 arguments, and false for unnamed arguments.  If it returns a value of
3954 zero, but @code{SETUP_INCOMING_VARARGS} is defined, then all arguments
3955 are treated as named.  Otherwise, all named arguments except the last
3956 are treated as named.
3958 You need not define this macro if it always returns zero.
3960 @findex PRETEND_OUTGOING_VARARGS_NAMED
3961 @item PRETEND_OUTGOING_VARARGS_NAMED
3962 If you need to conditionally change ABIs so that one works with
3963 @code{SETUP_INCOMING_VARARGS}, but the other works like neither
3964 @code{SETUP_INCOMING_VARARGS} nor @code{STRICT_ARGUMENT_NAMING} was
3965 defined, then define this macro to return nonzero if
3966 @code{SETUP_INCOMING_VARARGS} is used, zero otherwise.
3967 Otherwise, you should not define this macro.
3968 @end table
3970 @node Trampolines
3971 @section Trampolines for Nested Functions
3972 @cindex trampolines for nested functions
3973 @cindex nested functions, trampolines for
3975 A @dfn{trampoline} is a small piece of code that is created at run time
3976 when the address of a nested function is taken.  It normally resides on
3977 the stack, in the stack frame of the containing function.  These macros
3978 tell GCC how to generate code to allocate and initialize a
3979 trampoline.
3981 The instructions in the trampoline must do two things: load a constant
3982 address into the static chain register, and jump to the real address of
3983 the nested function.  On CISC machines such as the m68k, this requires
3984 two instructions, a move immediate and a jump.  Then the two addresses
3985 exist in the trampoline as word-long immediate operands.  On RISC
3986 machines, it is often necessary to load each address into a register in
3987 two parts.  Then pieces of each address form separate immediate
3988 operands.
3990 The code generated to initialize the trampoline must store the variable
3991 parts---the static chain value and the function address---into the
3992 immediate operands of the instructions.  On a CISC machine, this is
3993 simply a matter of copying each address to a memory reference at the
3994 proper offset from the start of the trampoline.  On a RISC machine, it
3995 may be necessary to take out pieces of the address and store them
3996 separately.
3998 @table @code
3999 @findex TRAMPOLINE_TEMPLATE
4000 @item TRAMPOLINE_TEMPLATE (@var{file})
4001 A C statement to output, on the stream @var{file}, assembler code for a
4002 block of data that contains the constant parts of a trampoline.  This
4003 code should not include a label---the label is taken care of
4004 automatically.
4006 If you do not define this macro, it means no template is needed
4007 for the target.  Do not define this macro on systems where the block move
4008 code to copy the trampoline into place would be larger than the code
4009 to generate it on the spot.
4011 @findex TRAMPOLINE_SECTION
4012 @item TRAMPOLINE_SECTION
4013 The name of a subroutine to switch to the section in which the
4014 trampoline template is to be placed (@pxref{Sections}).  The default is
4015 a value of @samp{readonly_data_section}, which places the trampoline in
4016 the section containing read-only data.
4018 @findex TRAMPOLINE_SIZE
4019 @item TRAMPOLINE_SIZE
4020 A C expression for the size in bytes of the trampoline, as an integer.
4022 @findex TRAMPOLINE_ALIGNMENT
4023 @item TRAMPOLINE_ALIGNMENT
4024 Alignment required for trampolines, in bits.
4026 If you don't define this macro, the value of @code{BIGGEST_ALIGNMENT}
4027 is used for aligning trampolines.
4029 @findex INITIALIZE_TRAMPOLINE
4030 @item INITIALIZE_TRAMPOLINE (@var{addr}, @var{fnaddr}, @var{static_chain})
4031 A C statement to initialize the variable parts of a trampoline.
4032 @var{addr} is an RTX for the address of the trampoline; @var{fnaddr} is
4033 an RTX for the address of the nested function; @var{static_chain} is an
4034 RTX for the static chain value that should be passed to the function
4035 when it is called.
4037 @findex ALLOCATE_TRAMPOLINE
4038 @item ALLOCATE_TRAMPOLINE (@var{fp})
4039 A C expression to allocate run-time space for a trampoline.  The
4040 expression value should be an RTX representing a memory reference to the
4041 space for the trampoline.
4043 @cindex @code{FUNCTION_EPILOGUE} and trampolines
4044 @cindex @code{FUNCTION_PROLOGUE} and trampolines
4045 If this macro is not defined, by default the trampoline is allocated as
4046 a stack slot.  This default is right for most machines.  The exceptions
4047 are machines where it is impossible to execute instructions in the stack
4048 area.  On such machines, you may have to implement a separate stack,
4049 using this macro in conjunction with @code{FUNCTION_PROLOGUE} and
4050 @code{FUNCTION_EPILOGUE}.
4052 @var{fp} points to a data structure, a @code{struct function}, which
4053 describes the compilation status of the immediate containing function of
4054 the function which the trampoline is for.  Normally (when
4055 @code{ALLOCATE_TRAMPOLINE} is not defined), the stack slot for the
4056 trampoline is in the stack frame of this containing function.  Other
4057 allocation strategies probably must do something analogous with this
4058 information.
4059 @end table
4061 Implementing trampolines is difficult on many machines because they have
4062 separate instruction and data caches.  Writing into a stack location
4063 fails to clear the memory in the instruction cache, so when the program
4064 jumps to that location, it executes the old contents.
4066 Here are two possible solutions.  One is to clear the relevant parts of
4067 the instruction cache whenever a trampoline is set up.  The other is to
4068 make all trampolines identical, by having them jump to a standard
4069 subroutine.  The former technique makes trampoline execution faster; the
4070 latter makes initialization faster.
4072 To clear the instruction cache when a trampoline is initialized, define
4073 the following macros which describe the shape of the cache.
4075 @table @code
4076 @findex INSN_CACHE_SIZE
4077 @item INSN_CACHE_SIZE
4078 The total size in bytes of the cache.
4080 @findex INSN_CACHE_LINE_WIDTH
4081 @item INSN_CACHE_LINE_WIDTH
4082 The length in bytes of each cache line.  The cache is divided into cache
4083 lines which are disjoint slots, each holding a contiguous chunk of data
4084 fetched from memory.  Each time data is brought into the cache, an
4085 entire line is read at once.  The data loaded into a cache line is
4086 always aligned on a boundary equal to the line size.
4088 @findex INSN_CACHE_DEPTH
4089 @item INSN_CACHE_DEPTH
4090 The number of alternative cache lines that can hold any particular memory
4091 location.
4092 @end table
4094 Alternatively, if the machine has system calls or instructions to clear
4095 the instruction cache directly, you can define the following macro.
4097 @table @code
4098 @findex CLEAR_INSN_CACHE
4099 @item CLEAR_INSN_CACHE (@var{BEG}, @var{END})
4100 If defined, expands to a C expression clearing the @emph{instruction
4101 cache} in the specified interval.  If it is not defined, and the macro
4102 INSN_CACHE_SIZE is defined, some generic code is generated to clear the
4103 cache.  The definition of this macro would typically be a series of
4104 @code{asm} statements.  Both @var{BEG} and @var{END} are both pointer
4105 expressions.
4106 @end table
4108 To use a standard subroutine, define the following macro.  In addition,
4109 you must make sure that the instructions in a trampoline fill an entire
4110 cache line with identical instructions, or else ensure that the
4111 beginning of the trampoline code is always aligned at the same point in
4112 its cache line.  Look in @file{m68k.h} as a guide.
4114 @table @code
4115 @findex TRANSFER_FROM_TRAMPOLINE
4116 @item TRANSFER_FROM_TRAMPOLINE
4117 Define this macro if trampolines need a special subroutine to do their
4118 work.  The macro should expand to a series of @code{asm} statements
4119 which will be compiled with GCC.  They go in a library function named
4120 @code{__transfer_from_trampoline}.
4122 If you need to avoid executing the ordinary prologue code of a compiled
4123 C function when you jump to the subroutine, you can do so by placing a
4124 special label of your own in the assembler code.  Use one @code{asm}
4125 statement to generate an assembler label, and another to make the label
4126 global.  Then trampolines can use that label to jump directly to your
4127 special assembler code.
4128 @end table
4130 @node Library Calls
4131 @section Implicit Calls to Library Routines
4132 @cindex library subroutine names
4133 @cindex @file{libgcc.a}
4135 @c prevent bad page break with this line
4136 Here is an explanation of implicit calls to library routines.
4138 @table @code
4139 @findex MULSI3_LIBCALL
4140 @item MULSI3_LIBCALL
4141 A C string constant giving the name of the function to call for
4142 multiplication of one signed full-word by another.  If you do not
4143 define this macro, the default name is used, which is @code{__mulsi3},
4144 a function defined in @file{libgcc.a}.
4146 @findex DIVSI3_LIBCALL
4147 @item DIVSI3_LIBCALL
4148 A C string constant giving the name of the function to call for
4149 division of one signed full-word by another.  If you do not define
4150 this macro, the default name is used, which is @code{__divsi3}, a
4151 function defined in @file{libgcc.a}.
4153 @findex UDIVSI3_LIBCALL
4154 @item UDIVSI3_LIBCALL
4155 A C string constant giving the name of the function to call for
4156 division of one unsigned full-word by another.  If you do not define
4157 this macro, the default name is used, which is @code{__udivsi3}, a
4158 function defined in @file{libgcc.a}.
4160 @findex MODSI3_LIBCALL
4161 @item MODSI3_LIBCALL
4162 A C string constant giving the name of the function to call for the
4163 remainder in division of one signed full-word by another.  If you do
4164 not define this macro, the default name is used, which is
4165 @code{__modsi3}, a function defined in @file{libgcc.a}.
4167 @findex UMODSI3_LIBCALL
4168 @item UMODSI3_LIBCALL
4169 A C string constant giving the name of the function to call for the
4170 remainder in division of one unsigned full-word by another.  If you do
4171 not define this macro, the default name is used, which is
4172 @code{__umodsi3}, a function defined in @file{libgcc.a}.
4174 @findex MULDI3_LIBCALL
4175 @item MULDI3_LIBCALL
4176 A C string constant giving the name of the function to call for
4177 multiplication of one signed double-word by another.  If you do not
4178 define this macro, the default name is used, which is @code{__muldi3},
4179 a function defined in @file{libgcc.a}.
4181 @findex DIVDI3_LIBCALL
4182 @item DIVDI3_LIBCALL
4183 A C string constant giving the name of the function to call for
4184 division of one signed double-word by another.  If you do not define
4185 this macro, the default name is used, which is @code{__divdi3}, a
4186 function defined in @file{libgcc.a}.
4188 @findex UDIVDI3_LIBCALL
4189 @item UDIVDI3_LIBCALL
4190 A C string constant giving the name of the function to call for
4191 division of one unsigned full-word by another.  If you do not define
4192 this macro, the default name is used, which is @code{__udivdi3}, a
4193 function defined in @file{libgcc.a}.
4195 @findex MODDI3_LIBCALL
4196 @item MODDI3_LIBCALL
4197 A C string constant giving the name of the function to call for the
4198 remainder in division of one signed double-word by another.  If you do
4199 not define this macro, the default name is used, which is
4200 @code{__moddi3}, a function defined in @file{libgcc.a}.
4202 @findex UMODDI3_LIBCALL
4203 @item UMODDI3_LIBCALL
4204 A C string constant giving the name of the function to call for the
4205 remainder in division of one unsigned full-word by another.  If you do
4206 not define this macro, the default name is used, which is
4207 @code{__umoddi3}, a function defined in @file{libgcc.a}.
4209 @findex INIT_TARGET_OPTABS
4210 @item INIT_TARGET_OPTABS
4211 Define this macro as a C statement that declares additional library
4212 routines renames existing ones. @code{init_optabs} calls this macro after
4213 initializing all the normal library routines.
4215 @findex FLOAT_LIB_COMPARE_RETURNS_BOOL (@var{mode}, @var{comparison})
4216 @item FLOAT_LIB_COMPARE_RETURNS_BOOL
4217 Define this macro as a C statement that returns nonzero if a call to
4218 the floating point comparison library function will return a boolean
4219 value that indicates the result of the comparison.  It should return
4220 zero if one of gcc's own libgcc functions is called.
4222 Most ports don't need to define this macro.
4224 @findex TARGET_EDOM
4225 @cindex @code{EDOM}, implicit usage
4226 @item TARGET_EDOM
4227 The value of @code{EDOM} on the target machine, as a C integer constant
4228 expression.  If you don't define this macro, GCC does not attempt to
4229 deposit the value of @code{EDOM} into @code{errno} directly.  Look in
4230 @file{/usr/include/errno.h} to find the value of @code{EDOM} on your
4231 system.
4233 If you do not define @code{TARGET_EDOM}, then compiled code reports
4234 domain errors by calling the library function and letting it report the
4235 error.  If mathematical functions on your system use @code{matherr} when
4236 there is an error, then you should leave @code{TARGET_EDOM} undefined so
4237 that @code{matherr} is used normally.
4239 @findex GEN_ERRNO_RTX
4240 @cindex @code{errno}, implicit usage
4241 @item GEN_ERRNO_RTX
4242 Define this macro as a C expression to create an rtl expression that
4243 refers to the global ``variable'' @code{errno}.  (On certain systems,
4244 @code{errno} may not actually be a variable.)  If you don't define this
4245 macro, a reasonable default is used.
4247 @findex TARGET_MEM_FUNCTIONS
4248 @cindex @code{bcopy}, implicit usage
4249 @cindex @code{memcpy}, implicit usage
4250 @cindex @code{bzero}, implicit usage
4251 @cindex @code{memset}, implicit usage
4252 @item TARGET_MEM_FUNCTIONS
4253 Define this macro if GCC should generate calls to the System V
4254 (and ANSI C) library functions @code{memcpy} and @code{memset}
4255 rather than the BSD functions @code{bcopy} and @code{bzero}.
4257 @findex LIBGCC_NEEDS_DOUBLE
4258 @item LIBGCC_NEEDS_DOUBLE
4259 Define this macro if only @code{float} arguments cannot be passed to
4260 library routines (so they must be converted to @code{double}).  This
4261 macro affects both how library calls are generated and how the library
4262 routines in @file{libgcc1.c} accept their arguments.  It is useful on
4263 machines where floating and fixed point arguments are passed
4264 differently, such as the i860.
4266 @findex FLOAT_ARG_TYPE
4267 @item FLOAT_ARG_TYPE
4268 Define this macro to override the type used by the library routines to
4269 pick up arguments of type @code{float}.  (By default, they use a union
4270 of @code{float} and @code{int}.)
4272 The obvious choice would be @code{float}---but that won't work with
4273 traditional C compilers that expect all arguments declared as @code{float}
4274 to arrive as @code{double}.  To avoid this conversion, the library routines
4275 ask for the value as some other type and then treat it as a @code{float}.
4277 On some systems, no other type will work for this.  For these systems,
4278 you must use @code{LIBGCC_NEEDS_DOUBLE} instead, to force conversion of
4279 the values @code{double} before they are passed.
4281 @findex FLOATIFY
4282 @item FLOATIFY (@var{passed-value})
4283 Define this macro to override the way library routines redesignate a
4284 @code{float} argument as a @code{float} instead of the type it was
4285 passed as.  The default is an expression which takes the @code{float}
4286 field of the union.
4288 @findex FLOAT_VALUE_TYPE
4289 @item FLOAT_VALUE_TYPE
4290 Define this macro to override the type used by the library routines to
4291 return values that ought to have type @code{float}.  (By default, they
4292 use @code{int}.)
4294 The obvious choice would be @code{float}---but that won't work with
4295 traditional C compilers gratuitously convert values declared as
4296 @code{float} into @code{double}.
4298 @findex INTIFY
4299 @item INTIFY (@var{float-value})
4300 Define this macro to override the way the value of a
4301 @code{float}-returning library routine should be packaged in order to
4302 return it.  These functions are actually declared to return type
4303 @code{FLOAT_VALUE_TYPE} (normally @code{int}).
4305 These values can't be returned as type @code{float} because traditional
4306 C compilers would gratuitously convert the value to a @code{double}.
4308 A local variable named @code{intify} is always available when the macro
4309 @code{INTIFY} is used.  It is a union of a @code{float} field named
4310 @code{f} and a field named @code{i} whose type is
4311 @code{FLOAT_VALUE_TYPE} or @code{int}.
4313 If you don't define this macro, the default definition works by copying
4314 the value through that union.
4316 @findex nongcc_SI_type
4317 @item nongcc_SI_type
4318 Define this macro as the name of the data type corresponding to
4319 @code{SImode} in the system's own C compiler.
4321 You need not define this macro if that type is @code{long int}, as it usually
4324 @findex nongcc_word_type
4325 @item nongcc_word_type
4326 Define this macro as the name of the data type corresponding to the
4327 word_mode in the system's own C compiler.
4329 You need not define this macro if that type is @code{long int}, as it usually
4332 @findex perform_@dots{}
4333 @item perform_@dots{}
4334 Define these macros to supply explicit C statements to carry out various
4335 arithmetic operations on types @code{float} and @code{double} in the
4336 library routines in @file{libgcc1.c}.  See that file for a full list
4337 of these macros and their arguments.
4339 On most machines, you don't need to define any of these macros, because
4340 the C compiler that comes with the system takes care of doing them.
4342 @findex NEXT_OBJC_RUNTIME
4343 @item NEXT_OBJC_RUNTIME
4344 Define this macro to generate code for Objective C message sending using
4345 the calling convention of the NeXT system.  This calling convention
4346 involves passing the object, the selector and the method arguments all
4347 at once to the method-lookup library function.
4349 The default calling convention passes just the object and the selector
4350 to the lookup function, which returns a pointer to the method.
4351 @end table
4353 @node Addressing Modes
4354 @section Addressing Modes
4355 @cindex addressing modes
4357 @c prevent bad page break with this line
4358 This is about addressing modes.
4360 @table @code
4361 @findex HAVE_PRE_INCREMENT
4362 @findex HAVE_PRE_DECREMENT
4363 @findex HAVE_POST_INCREMENT
4364 @findex HAVE_POST_DECREMENT
4365 @item HAVE_PRE_INCREMENT
4366 @itemx HAVE_PRE_DECREMENT
4367 @itemx HAVE_POST_INCREMENT
4368 @itemx HAVE_POST_DECREMENT
4369 A C expression that is non-zero if the machine supports pre-increment,
4370 pre-decrement, post-increment, or post-decrement addressing respectively.
4372 @findex HAVE_POST_MODIFY_DISP
4373 @findex HAVE_PRE_MODIFY_DISP
4374 @item HAVE_PRE_MODIFY_DISP
4375 @itemx HAVE_POST_MODIFY_DISP
4376 A C expression that is non-zero if the machine supports pre- or
4377 post-address side-effect generation involving constants other than
4378 the size of the memory operand.
4380 @findex HAVE_POST_MODIFY_REG
4381 @findex HAVE_PRE_MODIFY_REG
4382 @item HAVE_PRE_MODIFY_REG
4383 @itemx HAVE_POST_MODIFY_REG
4384 A C expression that is non-zero if the machine supports pre- or
4385 post-address side-effect generation involving a register displacement.
4387 @findex CONSTANT_ADDRESS_P
4388 @item CONSTANT_ADDRESS_P (@var{x})
4389 A C expression that is 1 if the RTX @var{x} is a constant which
4390 is a valid address.  On most machines, this can be defined as
4391 @code{CONSTANT_P (@var{x})}, but a few machines are more restrictive
4392 in which constant addresses are supported.
4394 @findex CONSTANT_P
4395 @code{CONSTANT_P} accepts integer-values expressions whose values are
4396 not explicitly known, such as @code{symbol_ref}, @code{label_ref}, and
4397 @code{high} expressions and @code{const} arithmetic expressions, in
4398 addition to @code{const_int} and @code{const_double} expressions.
4400 @findex MAX_REGS_PER_ADDRESS
4401 @item MAX_REGS_PER_ADDRESS
4402 A number, the maximum number of registers that can appear in a valid
4403 memory address.  Note that it is up to you to specify a value equal to
4404 the maximum number that @code{GO_IF_LEGITIMATE_ADDRESS} would ever
4405 accept.
4407 @findex GO_IF_LEGITIMATE_ADDRESS
4408 @item GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})
4409 A C compound statement with a conditional @code{goto @var{label};}
4410 executed if @var{x} (an RTX) is a legitimate memory address on the
4411 target machine for a memory operand of mode @var{mode}.
4413 It usually pays to define several simpler macros to serve as
4414 subroutines for this one.  Otherwise it may be too complicated to
4415 understand.
4417 This macro must exist in two variants: a strict variant and a
4418 non-strict one.  The strict variant is used in the reload pass.  It
4419 must be defined so that any pseudo-register that has not been
4420 allocated a hard register is considered a memory reference.  In
4421 contexts where some kind of register is required, a pseudo-register
4422 with no hard register must be rejected.
4424 The non-strict variant is used in other passes.  It must be defined to
4425 accept all pseudo-registers in every context where some kind of
4426 register is required.
4428 @findex REG_OK_STRICT
4429 Compiler source files that want to use the strict variant of this
4430 macro define the macro @code{REG_OK_STRICT}.  You should use an
4431 @code{#ifdef REG_OK_STRICT} conditional to define the strict variant
4432 in that case and the non-strict variant otherwise.
4434 Subroutines to check for acceptable registers for various purposes (one
4435 for base registers, one for index registers, and so on) are typically
4436 among the subroutines used to define @code{GO_IF_LEGITIMATE_ADDRESS}.
4437 Then only these subroutine macros need have two variants; the higher
4438 levels of macros may be the same whether strict or not.@refill
4440 Normally, constant addresses which are the sum of a @code{symbol_ref}
4441 and an integer are stored inside a @code{const} RTX to mark them as
4442 constant.  Therefore, there is no need to recognize such sums
4443 specifically as legitimate addresses.  Normally you would simply
4444 recognize any @code{const} as legitimate.
4446 Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant
4447 sums that are not marked with  @code{const}.  It assumes that a naked
4448 @code{plus} indicates indexing.  If so, then you @emph{must} reject such
4449 naked constant sums as illegitimate addresses, so that none of them will
4450 be given to @code{PRINT_OPERAND_ADDRESS}.
4452 @cindex @code{ENCODE_SECTION_INFO} and address validation
4453 On some machines, whether a symbolic address is legitimate depends on
4454 the section that the address refers to.  On these machines, define the
4455 macro @code{ENCODE_SECTION_INFO} to store the information into the
4456 @code{symbol_ref}, and then check for it here.  When you see a
4457 @code{const}, you will have to look inside it to find the
4458 @code{symbol_ref} in order to determine the section.  @xref{Assembler
4459 Format}.
4461 @findex saveable_obstack
4462 The best way to modify the name string is by adding text to the
4463 beginning, with suitable punctuation to prevent any ambiguity.  Allocate
4464 the new name in @code{saveable_obstack}.  You will have to modify
4465 @code{ASM_OUTPUT_LABELREF} to remove and decode the added text and
4466 output the name accordingly, and define @code{STRIP_NAME_ENCODING} to
4467 access the original name string.
4469 You can check the information stored here into the @code{symbol_ref} in
4470 the definitions of the macros @code{GO_IF_LEGITIMATE_ADDRESS} and
4471 @code{PRINT_OPERAND_ADDRESS}.
4473 @findex REG_OK_FOR_BASE_P
4474 @item REG_OK_FOR_BASE_P (@var{x})
4475 A C expression that is nonzero if @var{x} (assumed to be a @code{reg}
4476 RTX) is valid for use as a base register.  For hard registers, it
4477 should always accept those which the hardware permits and reject the
4478 others.  Whether the macro accepts or rejects pseudo registers must be
4479 controlled by @code{REG_OK_STRICT} as described above.  This usually
4480 requires two variant definitions, of which @code{REG_OK_STRICT}
4481 controls the one actually used.
4483 @findex REG_MODE_OK_FOR_BASE_P
4484 @item REG_MODE_OK_FOR_BASE_P (@var{x}, @var{mode})
4485 A C expression that is just like @code{REG_OK_FOR_BASE_P}, except that
4486 that expression may examine the mode of the memory reference in
4487 @var{mode}.  You should define this macro if the mode of the memory
4488 reference affects whether a register may be used as a base register.  If
4489 you define this macro, the compiler will use it instead of
4490 @code{REG_OK_FOR_BASE_P}.
4492 @findex REG_OK_FOR_INDEX_P
4493 @item REG_OK_FOR_INDEX_P (@var{x})
4494 A C expression that is nonzero if @var{x} (assumed to be a @code{reg}
4495 RTX) is valid for use as an index register.
4497 The difference between an index register and a base register is that
4498 the index register may be scaled.  If an address involves the sum of
4499 two registers, neither one of them scaled, then either one may be
4500 labeled the ``base'' and the other the ``index''; but whichever
4501 labeling is used must fit the machine's constraints of which registers
4502 may serve in each capacity.  The compiler will try both labelings,
4503 looking for one that is valid, and will reload one or both registers
4504 only if neither labeling works.
4506 @findex FIND_BASE_TERM
4507 @item FIND_BASE_TERM (@var{x})
4508 A C expression to determine the base term of address @var{x}.
4509 This macro is used in only one place: `find_base_term' in alias.c.
4511 It is always safe for this macro to not be defined.  It exists so
4512 that alias analysis can understand machine-dependent addresses.
4514 The typical use of this macro is to handle addresses containing
4515 a label_ref or symbol_ref within an UNSPEC.
4517 @findex LEGITIMIZE_ADDRESS
4518 @item LEGITIMIZE_ADDRESS (@var{x}, @var{oldx}, @var{mode}, @var{win})
4519 A C compound statement that attempts to replace @var{x} with a valid
4520 memory address for an operand of mode @var{mode}.  @var{win} will be a
4521 C statement label elsewhere in the code; the macro definition may use
4523 @example
4524 GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{win});
4525 @end example
4527 @noindent
4528 to avoid further processing if the address has become legitimate.
4530 @findex break_out_memory_refs
4531 @var{x} will always be the result of a call to @code{break_out_memory_refs},
4532 and @var{oldx} will be the operand that was given to that function to produce
4533 @var{x}.
4535 The code generated by this macro should not alter the substructure of
4536 @var{x}.  If it transforms @var{x} into a more legitimate form, it
4537 should assign @var{x} (which will always be a C variable) a new value.
4539 It is not necessary for this macro to come up with a legitimate
4540 address.  The compiler has standard ways of doing so in all cases.  In
4541 fact, it is safe for this macro to do nothing.  But often a
4542 machine-dependent strategy can generate better code.
4544 @findex LEGITIMIZE_RELOAD_ADDRESS
4545 @item LEGITIMIZE_RELOAD_ADDRESS (@var{x}, @var{mode}, @var{opnum}, @var{type}, @var{ind_levels}, @var{win})
4546 A C compound statement that attempts to replace @var{x}, which is an address
4547 that needs reloading, with a valid memory address for an operand of mode
4548 @var{mode}.  @var{win} will be a C statement label elsewhere in the code.
4549 It is not necessary to define this macro, but it might be useful for
4550 performance reasons. 
4552 For example, on the i386, it is sometimes possible to use a single
4553 reload register instead of two by reloading a sum of two pseudo
4554 registers into a register.  On the other hand, for number of RISC
4555 processors offsets are limited so that often an intermediate address
4556 needs to be generated in order to address a stack slot.  By defining
4557 LEGITIMIZE_RELOAD_ADDRESS appropriately, the intermediate addresses
4558 generated for adjacent some stack slots can be made identical, and thus
4559 be shared.
4561 @emph{Note}: This macro should be used with caution.  It is necessary
4562 to know something of how reload works in order to effectively use this,
4563 and it is quite easy to produce macros that build in too much knowledge
4564 of reload internals.
4566 @emph{Note}: This macro must be able to reload an address created by a
4567 previous invocation of this macro.  If it fails to handle such addresses
4568 then the compiler may generate incorrect code or abort.
4570 @findex push_reload
4571 The macro definition should use @code{push_reload} to indicate parts that
4572 need reloading; @var{opnum}, @var{type} and @var{ind_levels} are usually
4573 suitable to be passed unaltered to @code{push_reload}.
4575 The code generated by this macro must not alter the substructure of
4576 @var{x}.  If it transforms @var{x} into a more legitimate form, it
4577 should assign @var{x} (which will always be a C variable) a new value.
4578 This also applies to parts that you change indirectly by calling
4579 @code{push_reload}.
4581 @findex strict_memory_address_p
4582 The macro definition may use @code{strict_memory_address_p} to test if
4583 the address has become legitimate.
4585 @findex copy_rtx
4586 If you want to change only a part of @var{x}, one standard way of doing
4587 this is to use @code{copy_rtx}.  Note, however, that is unshares only a
4588 single level of rtl.  Thus, if the part to be changed is not at the
4589 top level, you'll need to replace first the top leve
4590 It is not necessary for this macro to come up with a legitimate
4591 address;  but often a machine-dependent strategy can generate better code.
4593 @findex GO_IF_MODE_DEPENDENT_ADDRESS
4594 @item GO_IF_MODE_DEPENDENT_ADDRESS (@var{addr}, @var{label})
4595 A C statement or compound statement with a conditional @code{goto
4596 @var{label};} executed if memory address @var{x} (an RTX) can have
4597 different meanings depending on the machine mode of the memory
4598 reference it is used for or if the address is valid for some modes
4599 but not others.
4601 Autoincrement and autodecrement addresses typically have mode-dependent
4602 effects because the amount of the increment or decrement is the size
4603 of the operand being addressed.  Some machines have other mode-dependent
4604 addresses.  Many RISC machines have no mode-dependent addresses.
4606 You may assume that @var{addr} is a valid address for the machine.
4608 @findex LEGITIMATE_CONSTANT_P
4609 @item LEGITIMATE_CONSTANT_P (@var{x})
4610 A C expression that is nonzero if @var{x} is a legitimate constant for
4611 an immediate operand on the target machine.  You can assume that
4612 @var{x} satisfies @code{CONSTANT_P}, so you need not check this.  In fact,
4613 @samp{1} is a suitable definition for this macro on machines where
4614 anything @code{CONSTANT_P} is valid.@refill
4615 @end table
4617 @node Condition Code
4618 @section Condition Code Status
4619 @cindex condition code status
4621 @c prevent bad page break with this line
4622 This describes the condition code status.
4624 @findex cc_status
4625 The file @file{conditions.h} defines a variable @code{cc_status} to
4626 describe how the condition code was computed (in case the interpretation of
4627 the condition code depends on the instruction that it was set by).  This
4628 variable contains the RTL expressions on which the condition code is
4629 currently based, and several standard flags.
4631 Sometimes additional machine-specific flags must be defined in the machine
4632 description header file.  It can also add additional machine-specific
4633 information by defining @code{CC_STATUS_MDEP}.
4635 @table @code
4636 @findex CC_STATUS_MDEP
4637 @item CC_STATUS_MDEP
4638 C code for a data type which is used for declaring the @code{mdep}
4639 component of @code{cc_status}.  It defaults to @code{int}.
4641 This macro is not used on machines that do not use @code{cc0}.
4643 @findex CC_STATUS_MDEP_INIT
4644 @item CC_STATUS_MDEP_INIT
4645 A C expression to initialize the @code{mdep} field to ``empty''.
4646 The default definition does nothing, since most machines don't use
4647 the field anyway.  If you want to use the field, you should probably
4648 define this macro to initialize it.
4650 This macro is not used on machines that do not use @code{cc0}.
4652 @findex NOTICE_UPDATE_CC
4653 @item NOTICE_UPDATE_CC (@var{exp}, @var{insn})
4654 A C compound statement to set the components of @code{cc_status}
4655 appropriately for an insn @var{insn} whose body is @var{exp}.  It is
4656 this macro's responsibility to recognize insns that set the condition
4657 code as a byproduct of other activity as well as those that explicitly
4658 set @code{(cc0)}.
4660 This macro is not used on machines that do not use @code{cc0}.
4662 If there are insns that do not set the condition code but do alter
4663 other machine registers, this macro must check to see whether they
4664 invalidate the expressions that the condition code is recorded as
4665 reflecting.  For example, on the 68000, insns that store in address
4666 registers do not set the condition code, which means that usually
4667 @code{NOTICE_UPDATE_CC} can leave @code{cc_status} unaltered for such
4668 insns.  But suppose that the previous insn set the condition code
4669 based on location @samp{a4@@(102)} and the current insn stores a new
4670 value in @samp{a4}.  Although the condition code is not changed by
4671 this, it will no longer be true that it reflects the contents of
4672 @samp{a4@@(102)}.  Therefore, @code{NOTICE_UPDATE_CC} must alter
4673 @code{cc_status} in this case to say that nothing is known about the
4674 condition code value.
4676 The definition of @code{NOTICE_UPDATE_CC} must be prepared to deal
4677 with the results of peephole optimization: insns whose patterns are
4678 @code{parallel} RTXs containing various @code{reg}, @code{mem} or
4679 constants which are just the operands.  The RTL structure of these
4680 insns is not sufficient to indicate what the insns actually do.  What
4681 @code{NOTICE_UPDATE_CC} should do when it sees one is just to run
4682 @code{CC_STATUS_INIT}.
4684 A possible definition of @code{NOTICE_UPDATE_CC} is to call a function
4685 that looks at an attribute (@pxref{Insn Attributes}) named, for example,
4686 @samp{cc}.  This avoids having detailed information about patterns in
4687 two places, the @file{md} file and in @code{NOTICE_UPDATE_CC}.
4689 @findex EXTRA_CC_MODES
4690 @item EXTRA_CC_MODES
4691 A list of additional modes for condition code values in registers 
4692 (@pxref{Jump Patterns}).  This macro should expand to a sequence of
4693 calls of the macro @code{CC} separated by white space.  @code{CC} takes
4694 two arguments.  The first is the enumeration name of the mode, which
4695 should begin with @samp{CC} and end with @samp{mode}.  The second is a C
4696 string giving the printable name of the mode; it should be the same as
4697 the first argument, but with the trailing @samp{mode} removed.
4699 You should only define this macro if additional modes are required.
4701 A sample definition of @code{EXTRA_CC_MODES} is:
4702 @smallexample
4703 #define EXTRA_CC_MODES            \
4704     CC(CC_NOOVmode, "CC_NOOV")    \
4705     CC(CCFPmode, "CCFP")          \
4706     CC(CCFPEmode, "CCFPE")
4707 @end smallexample
4709 @findex SELECT_CC_MODE
4710 @item SELECT_CC_MODE (@var{op}, @var{x}, @var{y})
4711 Returns a mode from class @code{MODE_CC} to be used when comparison
4712 operation code @var{op} is applied to rtx @var{x} and @var{y}.  For
4713 example, on the Sparc, @code{SELECT_CC_MODE} is defined as (see
4714 @pxref{Jump Patterns} for a description of the reason for this
4715 definition)
4717 @smallexample
4718 #define SELECT_CC_MODE(OP,X,Y) \
4719   (GET_MODE_CLASS (GET_MODE (X)) == MODE_FLOAT          \
4720    ? ((OP == EQ || OP == NE) ? CCFPmode : CCFPEmode)    \
4721    : ((GET_CODE (X) == PLUS || GET_CODE (X) == MINUS    \
4722        || GET_CODE (X) == NEG) \
4723       ? CC_NOOVmode : CCmode))
4724 @end smallexample
4726 You need not define this macro if @code{EXTRA_CC_MODES} is not defined.
4728 @findex CANONICALIZE_COMPARISON
4729 @item CANONICALIZE_COMPARISON (@var{code}, @var{op0}, @var{op1})
4730 On some machines not all possible comparisons are defined, but you can
4731 convert an invalid comparison into a valid one.  For example, the Alpha
4732 does not have a @code{GT} comparison, but you can use an @code{LT}
4733 comparison instead and swap the order of the operands.
4735 On such machines, define this macro to be a C statement to do any
4736 required conversions.  @var{code} is the initial comparison code
4737 and @var{op0} and @var{op1} are the left and right operands of the
4738 comparison, respectively.  You should modify @var{code}, @var{op0}, and
4739 @var{op1} as required.
4741 GCC will not assume that the comparison resulting from this macro is
4742 valid but will see if the resulting insn matches a pattern in the
4743 @file{md} file.
4745 You need not define this macro if it would never change the comparison
4746 code or operands.
4748 @findex REVERSIBLE_CC_MODE
4749 @item REVERSIBLE_CC_MODE (@var{mode})
4750 A C expression whose value is one if it is always safe to reverse a
4751 comparison whose mode is @var{mode}.  If @code{SELECT_CC_MODE}
4752 can ever return @var{mode} for a floating-point inequality comparison,
4753 then @code{REVERSIBLE_CC_MODE (@var{mode})} must be zero.
4755 You need not define this macro if it would always returns zero or if the
4756 floating-point format is anything other than @code{IEEE_FLOAT_FORMAT}.
4757 For example, here is the definition used on the Sparc, where floating-point
4758 inequality comparisons are always given @code{CCFPEmode}:
4760 @smallexample
4761 #define REVERSIBLE_CC_MODE(MODE)  ((MODE) != CCFPEmode)
4762 @end smallexample
4764 @end table
4766 @node Costs
4767 @section Describing Relative Costs of Operations
4768 @cindex costs of instructions
4769 @cindex relative costs
4770 @cindex speed of instructions
4772 These macros let you describe the relative speed of various operations
4773 on the target machine.
4775 @table @code
4776 @findex CONST_COSTS
4777 @item CONST_COSTS (@var{x}, @var{code}, @var{outer_code})
4778 A part of a C @code{switch} statement that describes the relative costs
4779 of constant RTL expressions.  It must contain @code{case} labels for
4780 expression codes @code{const_int}, @code{const}, @code{symbol_ref},
4781 @code{label_ref} and @code{const_double}.  Each case must ultimately
4782 reach a @code{return} statement to return the relative cost of the use
4783 of that kind of constant value in an expression.  The cost may depend on
4784 the precise value of the constant, which is available for examination in
4785 @var{x}, and the rtx code of the expression in which it is contained,
4786 found in @var{outer_code}.
4788 @var{code} is the expression code---redundant, since it can be
4789 obtained with @code{GET_CODE (@var{x})}.
4791 @findex RTX_COSTS
4792 @findex COSTS_N_INSNS
4793 @item RTX_COSTS (@var{x}, @var{code}, @var{outer_code})
4794 Like @code{CONST_COSTS} but applies to nonconstant RTL expressions.
4795 This can be used, for example, to indicate how costly a multiply
4796 instruction is.  In writing this macro, you can use the construct
4797 @code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast
4798 instructions.  @var{outer_code} is the code of the expression in which
4799 @var{x} is contained.
4801 This macro is optional; do not define it if the default cost assumptions
4802 are adequate for the target machine.
4804 @findex DEFAULT_RTX_COSTS
4805 @item DEFAULT_RTX_COSTS (@var{x}, @var{code}, @var{outer_code})
4806 This macro, if defined, is called for any case not handled by the
4807 @code{RTX_COSTS} or @code{CONST_COSTS} macros.  This eliminates the need
4808 to put case labels into the macro, but the code, or any functions it
4809 calls, must assume that the RTL in @var{x} could be of any type that has
4810 not already been handled.  The arguments are the same as for
4811 @code{RTX_COSTS}, and the macro should execute a return statement giving
4812 the cost of any RTL expressions that it can handle.  The default cost
4813 calculation is used for any RTL for which this macro does not return a
4814 value.
4816 This macro is optional; do not define it if the default cost assumptions
4817 are adequate for the target machine.  
4819 @findex ADDRESS_COST
4820 @item ADDRESS_COST (@var{address})
4821 An expression giving the cost of an addressing mode that contains
4822 @var{address}.  If not defined, the cost is computed from
4823 the @var{address} expression and the @code{CONST_COSTS} values.
4825 For most CISC machines, the default cost is a good approximation of the
4826 true cost of the addressing mode.  However, on RISC machines, all
4827 instructions normally have the same length and execution time.  Hence
4828 all addresses will have equal costs.
4830 In cases where more than one form of an address is known, the form with
4831 the lowest cost will be used.  If multiple forms have the same, lowest,
4832 cost, the one that is the most complex will be used.
4834 For example, suppose an address that is equal to the sum of a register
4835 and a constant is used twice in the same basic block.  When this macro
4836 is not defined, the address will be computed in a register and memory
4837 references will be indirect through that register.  On machines where
4838 the cost of the addressing mode containing the sum is no higher than
4839 that of a simple indirect reference, this will produce an additional
4840 instruction and possibly require an additional register.  Proper
4841 specification of this macro eliminates this overhead for such machines.
4843 Similar use of this macro is made in strength reduction of loops.
4845 @var{address} need not be valid as an address.  In such a case, the cost
4846 is not relevant and can be any value; invalid addresses need not be
4847 assigned a different cost.
4849 On machines where an address involving more than one register is as
4850 cheap as an address computation involving only one register, defining
4851 @code{ADDRESS_COST} to reflect this can cause two registers to be live
4852 over a region of code where only one would have been if
4853 @code{ADDRESS_COST} were not defined in that manner.  This effect should
4854 be considered in the definition of this macro.  Equivalent costs should
4855 probably only be given to addresses with different numbers of registers
4856 on machines with lots of registers.
4858 This macro will normally either not be defined or be defined as a
4859 constant.
4861 @findex REGISTER_MOVE_COST
4862 @item REGISTER_MOVE_COST (@var{from}, @var{to})
4863 A C expression for the cost of moving data from a register in class
4864 @var{from} to one in class @var{to}.  The classes are expressed using
4865 the enumeration values such as @code{GENERAL_REGS}.  A value of 2 is the
4866 default; other values are interpreted relative to that.
4868 It is not required that the cost always equal 2 when @var{from} is the
4869 same as @var{to}; on some machines it is expensive to move between
4870 registers if they are not general registers.
4872 If reload sees an insn consisting of a single @code{set} between two
4873 hard registers, and if @code{REGISTER_MOVE_COST} applied to their
4874 classes returns a value of 2, reload does not check to ensure that the
4875 constraints of the insn are met.  Setting a cost of other than 2 will
4876 allow reload to verify that the constraints are met.  You should do this
4877 if the @samp{mov@var{m}} pattern's constraints do not allow such copying.
4879 @findex MEMORY_MOVE_COST
4880 @item MEMORY_MOVE_COST (@var{mode}, @var{class}, @var{in})
4881 A C expression for the cost of moving data of mode @var{mode} between a
4882 register of class @var{class} and memory; @var{in} is zero if the value
4883 is to be written to memory, non-zero if it is to be read in.  This cost
4884 is relative to those in @code{REGISTER_MOVE_COST}.  If moving between
4885 registers and memory is more expensive than between two registers, you
4886 should define this macro to express the relative cost.
4888 If you do not define this macro, GCC uses a default cost of 4 plus
4889 the cost of copying via a secondary reload register, if one is
4890 needed.  If your machine requires a secondary reload register to copy
4891 between memory and a register of @var{class} but the reload mechanism is
4892 more complex than copying via an intermediate, define this macro to
4893 reflect the actual cost of the move.
4895 GCC defines the function @code{memory_move_secondary_cost} if
4896 secondary reloads are needed.  It computes the costs due to copying via
4897 a secondary register.  If your machine copies from memory using a
4898 secondary register in the conventional way but the default base value of
4899 4 is not correct for your machine, define this macro to add some other
4900 value to the result of that function.  The arguments to that function
4901 are the same as to this macro.
4903 @findex BRANCH_COST
4904 @item BRANCH_COST
4905 A C expression for the cost of a branch instruction.  A value of 1 is
4906 the default; other values are interpreted relative to that.
4907 @end table
4909 Here are additional macros which do not specify precise relative costs,
4910 but only that certain actions are more expensive than GCC would
4911 ordinarily expect.
4913 @table @code
4914 @findex SLOW_BYTE_ACCESS
4915 @item SLOW_BYTE_ACCESS
4916 Define this macro as a C expression which is nonzero if accessing less
4917 than a word of memory (i.e. a @code{char} or a @code{short}) is no
4918 faster than accessing a word of memory, i.e., if such access
4919 require more than one instruction or if there is no difference in cost
4920 between byte and (aligned) word loads.
4922 When this macro is not defined, the compiler will access a field by
4923 finding the smallest containing object; when it is defined, a fullword
4924 load will be used if alignment permits.  Unless bytes accesses are
4925 faster than word accesses, using word accesses is preferable since it
4926 may eliminate subsequent memory access if subsequent accesses occur to
4927 other fields in the same word of the structure, but to different bytes.
4929 @findex SLOW_ZERO_EXTEND
4930 @item SLOW_ZERO_EXTEND
4931 Define this macro if zero-extension (of a @code{char} or @code{short}
4932 to an @code{int}) can be done faster if the destination is a register
4933 that is known to be zero.
4935 If you define this macro, you must have instruction patterns that
4936 recognize RTL structures like this:
4938 @smallexample
4939 (set (strict_low_part (subreg:QI (reg:SI @dots{}) 0)) @dots{})
4940 @end smallexample
4942 @noindent
4943 and likewise for @code{HImode}.
4945 @findex SLOW_UNALIGNED_ACCESS
4946 @item SLOW_UNALIGNED_ACCESS (@var{mode}, @var{alignment})
4947 Define this macro to be the value 1 if memory accesses described by the
4948 @var{mode} and @var{alignment} parameters have a cost many times greater
4949 than aligned accesses, for example if they are emulated in a trap
4950 handler.
4952 When this macro is non-zero, the compiler will act as if
4953 @code{STRICT_ALIGNMENT} were non-zero when generating code for block
4954 moves.  This can cause significantly more instructions to be produced.
4955 Therefore, do not set this macro non-zero if unaligned accesses only add a
4956 cycle or two to the time for a memory access.
4958 If the value of this macro is always zero, it need not be defined.  If
4959 this macro is defined, it should produce a non-zero value when
4960 @code{STRICT_ALIGNMENT} is non-zero.
4962 @findex DONT_REDUCE_ADDR
4963 @item DONT_REDUCE_ADDR
4964 Define this macro to inhibit strength reduction of memory addresses.
4965 (On some machines, such strength reduction seems to do harm rather
4966 than good.)
4968 @findex MOVE_RATIO
4969 @item MOVE_RATIO
4970 The threshold of number of scalar memory-to-memory move insns, @emph{below}
4971 which a sequence of insns should be generated instead of a
4972 string move insn or a library call.  Increasing the value will always
4973 make code faster, but eventually incurs high cost in increased code size.
4975 Note that on machines where the corresponding move insn is a
4976 @code{define_expand} that emits a sequence of insns, this macro counts
4977 the number of such sequences.
4979 If you don't define this, a reasonable default is used.
4981 @findex MOVE_BY_PIECES_P
4982 @item MOVE_BY_PIECES_P (@var{size}, @var{alignment})
4983 A C expression used to determine whether @code{move_by_pieces} will be used to
4984 copy a chunk of memory, or whether some other block move mechanism
4985 will be used.  Defaults to 1 if @code{move_by_pieces_ninsns} returns less
4986 than @code{MOVE_RATIO}.
4988 @findex MOVE_MAX_PIECES
4989 @item MOVE_MAX_PIECES
4990 A C expression used by @code{move_by_pieces} to determine the largest unit
4991 a load or store used to copy memory is.  Defaults to @code{MOVE_MAX}.
4993 @findex USE_LOAD_POST_INCREMENT
4994 @item USE_LOAD_POST_INCREMENT (@var{mode})
4995 A C expression used to determine whether a load postincrement is a good
4996 thing to use for a given mode.  Defaults to the value of
4997 @code{HAVE_POST_INCREMENT}.
4999 @findex USE_LOAD_POST_DECREMENT
5000 @item USE_LOAD_POST_DECREMENT (@var{mode})
5001 A C expression used to determine whether a load postdecrement is a good
5002 thing to use for a given mode.  Defaults to the value of
5003 @code{HAVE_POST_DECREMENT}.
5005 @findex USE_LOAD_PRE_INCREMENT
5006 @item USE_LOAD_PRE_INCREMENT (@var{mode})
5007 A C expression used to determine whether a load preincrement is a good
5008 thing to use for a given mode.  Defaults to the value of
5009 @code{HAVE_PRE_INCREMENT}.
5011 @findex USE_LOAD_PRE_DECREMENT
5012 @item USE_LOAD_PRE_DECREMENT (@var{mode})
5013 A C expression used to determine whether a load predecrement is a good
5014 thing to use for a given mode.  Defaults to the value of
5015 @code{HAVE_PRE_DECREMENT}.
5017 @findex USE_STORE_POST_INCREMENT
5018 @item USE_STORE_POST_INCREMENT (@var{mode})
5019 A C expression used to determine whether a store postincrement is a good
5020 thing to use for a given mode.  Defaults to the value of
5021 @code{HAVE_POST_INCREMENT}.
5023 @findex USE_STORE_POST_DECREMENT
5024 @item USE_STORE_POST_DECREMENT (@var{mode})
5025 A C expression used to determine whether a store postdeccrement is a good
5026 thing to use for a given mode.  Defaults to the value of
5027 @code{HAVE_POST_DECREMENT}.
5029 @findex USE_STORE_PRE_INCREMENT
5030 @item USE_STORE_PRE_INCREMENT (@var{mode})
5031 This macro is used to determine whether a store preincrement is a good
5032 thing to use for a given mode.  Defaults to the value of
5033 @code{HAVE_PRE_INCREMENT}.
5035 @findex USE_STORE_PRE_DECREMENT
5036 @item USE_STORE_PRE_DECREMENT (@var{mode})
5037 This macro is used to determine whether a store predecrement is a good
5038 thing to use for a given mode.  Defaults to the value of
5039 @code{HAVE_PRE_DECREMENT}.
5041 @findex NO_FUNCTION_CSE
5042 @item NO_FUNCTION_CSE
5043 Define this macro if it is as good or better to call a constant
5044 function address than to call an address kept in a register.
5046 @findex NO_RECURSIVE_FUNCTION_CSE
5047 @item NO_RECURSIVE_FUNCTION_CSE
5048 Define this macro if it is as good or better for a function to call
5049 itself with an explicit address than to call an address kept in a
5050 register.
5052 @findex ADJUST_COST
5053 @item ADJUST_COST (@var{insn}, @var{link}, @var{dep_insn}, @var{cost})
5054 A C statement (sans semicolon) to update the integer variable @var{cost}
5055 based on the relationship between @var{insn} that is dependent on
5056 @var{dep_insn} through the dependence @var{link}.  The default is to
5057 make no adjustment to @var{cost}.  This can be used for example to
5058 specify to the scheduler that an output- or anti-dependence does not
5059 incur the same cost as a data-dependence.
5061 @findex ADJUST_PRIORITY
5062 @item ADJUST_PRIORITY (@var{insn})
5063 A C statement (sans semicolon) to update the integer scheduling
5064 priority @code{INSN_PRIORITY(@var{insn})}.  Reduce the priority
5065 to execute the @var{insn} earlier, increase the priority to execute
5066 @var{insn} later.    Do not define this macro if you do not need to
5067 adjust the scheduling priorities of insns.
5068 @end table
5070 @node Sections
5071 @section Dividing the Output into Sections (Texts, Data, @dots{})
5072 @c the above section title is WAY too long.  maybe cut the part between
5073 @c the (...)?  --mew 10feb93
5075 An object file is divided into sections containing different types of
5076 data.  In the most common case, there are three sections: the @dfn{text
5077 section}, which holds instructions and read-only data; the @dfn{data
5078 section}, which holds initialized writable data; and the @dfn{bss
5079 section}, which holds uninitialized data.  Some systems have other kinds
5080 of sections.
5082 The compiler must tell the assembler when to switch sections.  These
5083 macros control what commands to output to tell the assembler this.  You
5084 can also define additional sections.
5086 @table @code
5087 @findex TEXT_SECTION_ASM_OP
5088 @item TEXT_SECTION_ASM_OP
5089 A C expression whose value is a string, including spacing, containing the
5090 assembler operation that should precede instructions and read-only data.
5091 Normally @code{"\t.text"} is right.
5093 @findex DATA_SECTION_ASM_OP
5094 @item DATA_SECTION_ASM_OP
5095 A C expression whose value is a string, including spacing, containing the
5096 assembler operation to identify the following data as writable initialized
5097 data.  Normally @code{"\t.data"} is right.
5099 @findex SHARED_SECTION_ASM_OP
5100 @item SHARED_SECTION_ASM_OP
5101 If defined, a C expression whose value is a string, including spacing,
5102 containing the assembler operation to identify the following data as
5103 shared data.  If not defined, @code{DATA_SECTION_ASM_OP} will be used.
5105 @findex BSS_SECTION_ASM_OP
5106 @item BSS_SECTION_ASM_OP
5107 If defined, a C expression whose value is a string, including spacing,
5108 containing the assembler operation to identify the following data as
5109 uninitialized global data.  If not defined, and neither
5110 @code{ASM_OUTPUT_BSS} nor @code{ASM_OUTPUT_ALIGNED_BSS} are defined,
5111 uninitialized global data will be output in the data section if
5112 @samp{-fno-common} is passed, otherwise @code{ASM_OUTPUT_COMMON} will be
5113 used.
5115 @findex SHARED_BSS_SECTION_ASM_OP
5116 @item SHARED_BSS_SECTION_ASM_OP
5117 If defined, a C expression whose value is a string, including spacing,
5118 containing the assembler operation to identify the following data as
5119 uninitialized global shared data.  If not defined, and
5120 @code{BSS_SECTION_ASM_OP} is, the latter will be used.
5122 @findex INIT_SECTION_ASM_OP
5123 @item INIT_SECTION_ASM_OP
5124 If defined, a C expression whose value is a string, including spacing,
5125 containing the assembler operation to identify the following data as
5126 initialization code.  If not defined, GCC will assume such a section does
5127 not exist.
5129 @findex FINI_SECTION_ASM_OP
5130 @item FINI_SECTION_ASM_OP
5131 If defined, a C expression whose value is a string, including spacing,
5132 containing the assembler operation to identify the following data as
5133 finalization code.  If not defined, GCC will assume such a section does
5134 not exist.
5136 @findex CRT_CALL_STATIC_FUNCTION
5137 @item CRT_CALL_STATIC_FUNCTION
5138 If defined, a C statement that calls the function named as the sole
5139 argument of this macro.  This is used in @file{crtstuff.c} if
5140 @code{INIT_SECTION_ASM_OP} or @code{FINI_SECTION_ASM_OP} to calls to
5141 initialization and finalization functions from the init and fini
5142 sections. By default, this macro is a simple function call.  Some
5143 ports need hand-crafted assembly code to avoid dependencies on
5144 registers initialized in the function prologue or to ensure that
5145 constant pools don't end up too far way in the text section.
5147 @findex EXTRA_SECTIONS
5148 @findex in_text
5149 @findex in_data
5150 @item EXTRA_SECTIONS
5151 A list of names for sections other than the standard two, which are
5152 @code{in_text} and @code{in_data}.  You need not define this macro
5153 on a system with no other sections (that GCC needs to use).
5155 @findex EXTRA_SECTION_FUNCTIONS
5156 @findex text_section
5157 @findex data_section
5158 @item EXTRA_SECTION_FUNCTIONS
5159 One or more functions to be defined in @file{varasm.c}.  These
5160 functions should do jobs analogous to those of @code{text_section} and
5161 @code{data_section}, for your additional sections.  Do not define this
5162 macro if you do not define @code{EXTRA_SECTIONS}.
5164 @findex READONLY_DATA_SECTION
5165 @item READONLY_DATA_SECTION
5166 On most machines, read-only variables, constants, and jump tables are
5167 placed in the text section.  If this is not the case on your machine,
5168 this macro should be defined to be the name of a function (either
5169 @code{data_section} or a function defined in @code{EXTRA_SECTIONS}) that
5170 switches to the section to be used for read-only items.
5172 If these items should be placed in the text section, this macro should
5173 not be defined.
5175 @findex SELECT_SECTION
5176 @item SELECT_SECTION (@var{exp}, @var{reloc})
5177 A C statement or statements to switch to the appropriate section for
5178 output of @var{exp}.  You can assume that @var{exp} is either a
5179 @code{VAR_DECL} node or a constant of some sort.  @var{reloc}
5180 indicates whether the initial value of @var{exp} requires link-time
5181 relocations.  Select the section by calling @code{text_section} or one
5182 of the alternatives for other sections.
5184 Do not define this macro if you put all read-only variables and
5185 constants in the read-only data section (usually the text section).
5187 @findex SELECT_RTX_SECTION
5188 @item SELECT_RTX_SECTION (@var{mode}, @var{rtx})
5189 A C statement or statements to switch to the appropriate section for
5190 output of @var{rtx} in mode @var{mode}.  You can assume that @var{rtx}
5191 is some kind of constant in RTL.  The argument @var{mode} is redundant
5192 except in the case of a @code{const_int} rtx.  Select the section by
5193 calling @code{text_section} or one of the alternatives for other
5194 sections.
5196 Do not define this macro if you put all constants in the read-only
5197 data section.
5199 @findex JUMP_TABLES_IN_TEXT_SECTION
5200 @item JUMP_TABLES_IN_TEXT_SECTION
5201 Define this macro to be an expression with a non-zero value if jump 
5202 tables (for @code{tablejump} insns) should be output in the text
5203 section, along with the assembler instructions.  Otherwise, the
5204 readonly data section is used.
5206 This macro is irrelevant if there is no separate readonly data section.
5208 @findex ENCODE_SECTION_INFO
5209 @item ENCODE_SECTION_INFO (@var{decl})
5210 Define this macro if references to a symbol must be treated differently
5211 depending on something about the variable or function named by the
5212 symbol (such as what section it is in).
5214 The macro definition, if any, is executed immediately after the rtl for
5215 @var{decl} has been created and stored in @code{DECL_RTL (@var{decl})}.
5216 The value of the rtl will be a @code{mem} whose address is a
5217 @code{symbol_ref}.
5219 @cindex @code{SYMBOL_REF_FLAG}, in @code{ENCODE_SECTION_INFO}
5220 The usual thing for this macro to do is to record a flag in the
5221 @code{symbol_ref} (such as @code{SYMBOL_REF_FLAG}) or to store a
5222 modified name string in the @code{symbol_ref} (if one bit is not enough
5223 information).
5225 @findex STRIP_NAME_ENCODING
5226 @item STRIP_NAME_ENCODING (@var{var}, @var{sym_name})
5227 Decode @var{sym_name} and store the real name part in @var{var}, sans
5228 the characters that encode section info.  Define this macro if
5229 @code{ENCODE_SECTION_INFO} alters the symbol's name string.
5231 @findex UNIQUE_SECTION_P
5232 @item UNIQUE_SECTION_P (@var{decl})
5233 A C expression which evaluates to true if @var{decl} should be placed
5234 into a unique section for some target-specific reason.  If you do not
5235 define this macro, the default is @samp{0}.  Note that the flag
5236 @samp{-ffunction-sections} will also cause functions to be placed into
5237 unique sections.
5239 @findex UNIQUE_SECTION
5240 @item UNIQUE_SECTION (@var{decl}, @var{reloc})
5241 A C statement to build up a unique section name, expressed as a
5242 STRING_CST node, and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.
5243 @var{reloc} indicates whether the initial value of @var{exp} requires
5244 link-time relocations.  If you do not define this macro, GCC will use
5245 the symbol name prefixed by @samp{.} as the section name.  Note - this
5246 macro can now be called for unitialised data items as well as
5247 initialised data and functions.
5248 @end table
5250 @node PIC
5251 @section Position Independent Code
5252 @cindex position independent code
5253 @cindex PIC
5255 This section describes macros that help implement generation of position
5256 independent code.  Simply defining these macros is not enough to
5257 generate valid PIC; you must also add support to the macros
5258 @code{GO_IF_LEGITIMATE_ADDRESS} and @code{PRINT_OPERAND_ADDRESS}, as
5259 well as @code{LEGITIMIZE_ADDRESS}.  You must modify the definition of
5260 @samp{movsi} to do something appropriate when the source operand
5261 contains a symbolic address.  You may also need to alter the handling of
5262 switch statements so that they use relative addresses.
5263 @c i rearranged the order of the macros above to try to force one of
5264 @c them to the next line, to eliminate an overfull hbox. --mew 10feb93
5266 @table @code
5267 @findex PIC_OFFSET_TABLE_REGNUM
5268 @item PIC_OFFSET_TABLE_REGNUM
5269 The register number of the register used to address a table of static
5270 data addresses in memory.  In some cases this register is defined by a
5271 processor's ``application binary interface'' (ABI).  When this macro
5272 is defined, RTL is generated for this register once, as with the stack
5273 pointer and frame pointer registers.  If this macro is not defined, it
5274 is up to the machine-dependent files to allocate such a register (if
5275 necessary).
5277 @findex PIC_OFFSET_TABLE_REG_CALL_CLOBBERED
5278 @item PIC_OFFSET_TABLE_REG_CALL_CLOBBERED
5279 Define this macro if the register defined by
5280 @code{PIC_OFFSET_TABLE_REGNUM} is clobbered by calls.  Do not define
5281 this macro if @code{PIC_OFFSET_TABLE_REGNUM} is not defined.
5283 @findex FINALIZE_PIC
5284 @item FINALIZE_PIC
5285 By generating position-independent code, when two different programs (A
5286 and B) share a common library (libC.a), the text of the library can be
5287 shared whether or not the library is linked at the same address for both
5288 programs.  In some of these environments, position-independent code
5289 requires not only the use of different addressing modes, but also
5290 special code to enable the use of these addressing modes.
5292 The @code{FINALIZE_PIC} macro serves as a hook to emit these special
5293 codes once the function is being compiled into assembly code, but not
5294 before.  (It is not done before, because in the case of compiling an
5295 inline function, it would lead to multiple PIC prologues being
5296 included in functions which used inline functions and were compiled to
5297 assembly language.)
5299 @findex LEGITIMATE_PIC_OPERAND_P
5300 @item LEGITIMATE_PIC_OPERAND_P (@var{x})
5301 A C expression that is nonzero if @var{x} is a legitimate immediate
5302 operand on the target machine when generating position independent code.
5303 You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not
5304 check this.  You can also assume @var{flag_pic} is true, so you need not
5305 check it either.  You need not define this macro if all constants
5306 (including @code{SYMBOL_REF}) can be immediate operands when generating
5307 position independent code.
5308 @end table
5310 @node Assembler Format
5311 @section Defining the Output Assembler Language
5313 This section describes macros whose principal purpose is to describe how
5314 to write instructions in assembler language--rather than what the
5315 instructions do.
5317 @menu
5318 * File Framework::       Structural information for the assembler file.
5319 * Data Output::          Output of constants (numbers, strings, addresses).
5320 * Uninitialized Data::   Output of uninitialized variables.
5321 * Label Output::         Output and generation of labels.
5322 * Initialization::       General principles of initialization
5323                            and termination routines.
5324 * Macros for Initialization::
5325                          Specific macros that control the handling of
5326                            initialization and termination routines.
5327 * Instruction Output::   Output of actual instructions.
5328 * Dispatch Tables::      Output of jump tables.
5329 * Exception Region Output:: Output of exception region code.
5330 * Alignment Output::     Pseudo ops for alignment and skipping data.
5331 @end menu
5333 @node File Framework
5334 @subsection The Overall Framework of an Assembler File
5335 @cindex assembler format
5336 @cindex output of assembler code
5338 @c prevent bad page break with this line
5339 This describes the overall framework of an assembler file.
5341 @table @code
5342 @findex ASM_FILE_START
5343 @item ASM_FILE_START (@var{stream})
5344 A C expression which outputs to the stdio stream @var{stream}
5345 some appropriate text to go at the start of an assembler file.
5347 Normally this macro is defined to output a line containing
5348 @samp{#NO_APP}, which is a comment that has no effect on most
5349 assemblers but tells the GNU assembler that it can save time by not
5350 checking for certain assembler constructs.
5352 On systems that use SDB, it is necessary to output certain commands;
5353 see @file{attasm.h}.
5355 @findex ASM_FILE_END
5356 @item ASM_FILE_END (@var{stream})
5357 A C expression which outputs to the stdio stream @var{stream}
5358 some appropriate text to go at the end of an assembler file.
5360 If this macro is not defined, the default is to output nothing
5361 special at the end of the file.  Most systems don't require any
5362 definition.
5364 On systems that use SDB, it is necessary to output certain commands;
5365 see @file{attasm.h}.
5367 @findex ASM_IDENTIFY_GCC
5368 @item ASM_IDENTIFY_GCC (@var{file})
5369 A C statement to output assembler commands which will identify
5370 the object file as having been compiled with GCC (or another
5371 GNU compiler).
5373 If you don't define this macro, the string @samp{gcc_compiled.:}
5374 is output.  This string is calculated to define a symbol which,
5375 on BSD systems, will never be defined for any other reason.
5376 GDB checks for the presence of this symbol when reading the
5377 symbol table of an executable.
5379 On non-BSD systems, you must arrange communication with GDB in
5380 some other fashion.  If GDB is not used on your system, you can
5381 define this macro with an empty body.
5383 @findex ASM_COMMENT_START
5384 @item ASM_COMMENT_START
5385 A C string constant describing how to begin a comment in the target
5386 assembler language.  The compiler assumes that the comment will end at
5387 the end of the line.
5389 @findex ASM_APP_ON
5390 @item ASM_APP_ON
5391 A C string constant for text to be output before each @code{asm}
5392 statement or group of consecutive ones.  Normally this is
5393 @code{"#APP"}, which is a comment that has no effect on most
5394 assemblers but tells the GNU assembler that it must check the lines
5395 that follow for all valid assembler constructs.
5397 @findex ASM_APP_OFF
5398 @item ASM_APP_OFF
5399 A C string constant for text to be output after each @code{asm}
5400 statement or group of consecutive ones.  Normally this is
5401 @code{"#NO_APP"}, which tells the GNU assembler to resume making the
5402 time-saving assumptions that are valid for ordinary compiler output.
5404 @findex ASM_OUTPUT_SOURCE_FILENAME
5405 @item ASM_OUTPUT_SOURCE_FILENAME (@var{stream}, @var{name})
5406 A C statement to output COFF information or DWARF debugging information
5407 which indicates that filename @var{name} is the current source file to
5408 the stdio stream @var{stream}.
5410 This macro need not be defined if the standard form of output
5411 for the file format in use is appropriate.
5413 @findex OUTPUT_QUOTED_STRING
5414 @item OUTPUT_QUOTED_STRING (@var{stream}, @var{string})
5415 A C statement to output the string @var{string} to the stdio stream
5416 @var{stream}.  If you do not call the function @code{output_quoted_string}
5417 in your config files, GCC will only call it to output filenames to
5418 the assembler source.  So you can use it to canonicalize the format
5419 of the filename using this macro.
5421 @findex ASM_OUTPUT_SOURCE_LINE
5422 @item ASM_OUTPUT_SOURCE_LINE (@var{stream}, @var{line})
5423 A C statement to output DBX or SDB debugging information before code
5424 for line number @var{line} of the current source file to the
5425 stdio stream @var{stream}.
5427 This macro need not be defined if the standard form of debugging
5428 information for the debugger in use is appropriate.
5430 @findex ASM_OUTPUT_IDENT
5431 @item ASM_OUTPUT_IDENT (@var{stream}, @var{string})
5432 A C statement to output something to the assembler file to handle a
5433 @samp{#ident} directive containing the text @var{string}.  If this
5434 macro is not defined, nothing is output for a @samp{#ident} directive.
5436 @findex ASM_OUTPUT_SECTION_NAME
5437 @item ASM_OUTPUT_SECTION_NAME (@var{stream}, @var{decl}, @var{name}, @var{reloc})
5438 A C statement to output something to the assembler file to switch to section
5439 @var{name} for object @var{decl} which is either a @code{FUNCTION_DECL}, a
5440 @code{VAR_DECL} or @code{NULL_TREE}.  @var{reloc}
5441 indicates whether the initial value of @var{exp} requires link-time
5442 relocations.  Some target formats do not support
5443 arbitrary sections.  Do not define this macro in such cases.
5445 At present this macro is only used to support section attributes.
5446 When this macro is undefined, section attributes are disabled.
5448 @findex OBJC_PROLOGUE
5449 @item OBJC_PROLOGUE
5450 A C statement to output any assembler statements which are required to
5451 precede any Objective C object definitions or message sending.  The
5452 statement is executed only when compiling an Objective C program.
5453 @end table
5455 @need 2000
5456 @node Data Output
5457 @subsection Output of Data
5459 @c prevent bad page break with this line
5460 This describes data output.
5462 @table @code
5463 @findex ASM_OUTPUT_LONG_DOUBLE
5464 @findex ASM_OUTPUT_DOUBLE
5465 @findex ASM_OUTPUT_FLOAT
5466 @item ASM_OUTPUT_LONG_DOUBLE (@var{stream}, @var{value})
5467 @itemx ASM_OUTPUT_DOUBLE (@var{stream}, @var{value})
5468 @itemx ASM_OUTPUT_FLOAT (@var{stream}, @var{value})
5469 @itemx ASM_OUTPUT_THREE_QUARTER_FLOAT (@var{stream}, @var{value})
5470 @itemx ASM_OUTPUT_SHORT_FLOAT (@var{stream}, @var{value})
5471 @itemx ASM_OUTPUT_BYTE_FLOAT (@var{stream}, @var{value})
5472 A C statement to output to the stdio stream @var{stream} an assembler
5473 instruction to assemble a floating-point constant of @code{TFmode},
5474 @code{DFmode}, @code{SFmode}, @code{TQFmode}, @code{HFmode}, or
5475 @code{QFmode}, respectively, whose value is @var{value}.  @var{value}
5476 will be a C expression of type @code{REAL_VALUE_TYPE}.  Macros such as
5477 @code{REAL_VALUE_TO_TARGET_DOUBLE} are useful for writing these
5478 definitions.
5480 @findex ASM_OUTPUT_QUADRUPLE_INT
5481 @findex ASM_OUTPUT_DOUBLE_INT
5482 @findex ASM_OUTPUT_INT
5483 @findex ASM_OUTPUT_SHORT
5484 @findex ASM_OUTPUT_CHAR
5485 @findex output_addr_const
5486 @item ASM_OUTPUT_QUADRUPLE_INT (@var{stream}, @var{exp})
5487 @itemx ASM_OUTPUT_DOUBLE_INT (@var{stream}, @var{exp})
5488 @itemx ASM_OUTPUT_INT (@var{stream}, @var{exp})
5489 @itemx ASM_OUTPUT_SHORT (@var{stream}, @var{exp})
5490 @itemx ASM_OUTPUT_CHAR (@var{stream}, @var{exp})
5491 A C statement to output to the stdio stream @var{stream} an assembler
5492 instruction to assemble an integer of 16, 8, 4, 2 or 1 bytes,
5493 respectively, whose value is @var{value}.  The argument @var{exp} will
5494 be an RTL expression which represents a constant value.  Use
5495 @samp{output_addr_const (@var{stream}, @var{exp})} to output this value
5496 as an assembler expression.@refill
5498 For sizes larger than @code{UNITS_PER_WORD}, if the action of a macro
5499 would be identical to repeatedly calling the macro corresponding to
5500 a size of @code{UNITS_PER_WORD}, once for each word, you need not define
5501 the macro.
5503 @findex OUTPUT_ADDR_CONST_EXTRA
5504 @item OUTPUT_ADDR_CONST_EXTRA (@var{stream}, @var{x}, @var{fail})
5505 A C statement to recognize @var{rtx} patterns that
5506 @code{output_addr_const} can't deal with, and output assembly code to
5507 @var{stream} corresponding to the pattern @var{x}.  This may be used to
5508 allow machine-dependent @code{UNSPEC}s to appear within constants.
5510 If @code{OUTPUT_ADDR_CONST_EXTRA} fails to recognize a pattern, it must
5511 @code{goto fail}, so that a standard error message is printed.  If it
5512 prints an error message itself, by calling, for example,
5513 @code{output_operand_lossage}, it may just complete normally.
5515 @findex ASM_OUTPUT_BYTE
5516 @item ASM_OUTPUT_BYTE (@var{stream}, @var{value})
5517 A C statement to output to the stdio stream @var{stream} an assembler
5518 instruction to assemble a single byte containing the number @var{value}.
5520 @findex ASM_BYTE_OP
5521 @item ASM_BYTE_OP
5522 A C string constant, including spacing, giving the pseudo-op to use for a
5523 sequence of single-byte constants.  If this macro is not defined, the
5524 default is @code{"\t.byte\t"}.
5526 @findex ASM_OUTPUT_ASCII
5527 @item ASM_OUTPUT_ASCII (@var{stream}, @var{ptr}, @var{len})
5528 A C statement to output to the stdio stream @var{stream} an assembler
5529 instruction to assemble a string constant containing the @var{len}
5530 bytes at @var{ptr}.  @var{ptr} will be a C expression of type
5531 @code{char *} and @var{len} a C expression of type @code{int}.
5533 If the assembler has a @code{.ascii} pseudo-op as found in the
5534 Berkeley Unix assembler, do not define the macro
5535 @code{ASM_OUTPUT_ASCII}.
5537 @findex CONSTANT_POOL_BEFORE_FUNCTION
5538 @item CONSTANT_POOL_BEFORE_FUNCTION
5539 You may define this macro as a C expression.  You should define the
5540 expression to have a non-zero value if GCC should output the constant
5541 pool for a function before the code for the function, or a zero value if
5542 GCC should output the constant pool after the function.  If you do
5543 not define this macro, the usual case, GCC will output the constant
5544 pool before the function.
5546 @findex ASM_OUTPUT_POOL_PROLOGUE
5547 @item ASM_OUTPUT_POOL_PROLOGUE (@var{file}, @var{funname}, @var{fundecl}, @var{size})
5548 A C statement to output assembler commands to define the start of the
5549 constant pool for a function.  @var{funname} is a string giving
5550 the name of the function.  Should the return type of the function
5551 be required, it can be obtained via @var{fundecl}.  @var{size}
5552 is the size, in bytes, of the constant pool that will be written
5553 immediately after this call.
5555 If no constant-pool prefix is required, the usual case, this macro need
5556 not be defined.
5558 @findex ASM_OUTPUT_SPECIAL_POOL_ENTRY
5559 @item ASM_OUTPUT_SPECIAL_POOL_ENTRY (@var{file}, @var{x}, @var{mode}, @var{align}, @var{labelno}, @var{jumpto})
5560 A C statement (with or without semicolon) to output a constant in the
5561 constant pool, if it needs special treatment.  (This macro need not do
5562 anything for RTL expressions that can be output normally.)
5564 The argument @var{file} is the standard I/O stream to output the
5565 assembler code on.  @var{x} is the RTL expression for the constant to
5566 output, and @var{mode} is the machine mode (in case @var{x} is a
5567 @samp{const_int}).  @var{align} is the required alignment for the value
5568 @var{x}; you should output an assembler directive to force this much
5569 alignment.
5571 The argument @var{labelno} is a number to use in an internal label for
5572 the address of this pool entry.  The definition of this macro is
5573 responsible for outputting the label definition at the proper place.
5574 Here is how to do this:
5576 @example
5577 ASM_OUTPUT_INTERNAL_LABEL (@var{file}, "LC", @var{labelno});
5578 @end example
5580 When you output a pool entry specially, you should end with a
5581 @code{goto} to the label @var{jumpto}.  This will prevent the same pool
5582 entry from being output a second time in the usual manner.
5584 You need not define this macro if it would do nothing.
5586 @findex CONSTANT_AFTER_FUNCTION_P
5587 @item CONSTANT_AFTER_FUNCTION_P (@var{exp})
5588 Define this macro as a C expression which is nonzero if the constant
5589 @var{exp}, of type @code{tree}, should be output after the code for a
5590 function.  The compiler will normally output all constants before the
5591 function; you need not define this macro if this is OK.
5593 @findex ASM_OUTPUT_POOL_EPILOGUE
5594 @item ASM_OUTPUT_POOL_EPILOGUE (@var{file} @var{funname} @var{fundecl} @var{size})
5595 A C statement to output assembler commands to at the end of the constant
5596 pool for a function.  @var{funname} is a string giving the name of the
5597 function.  Should the return type of the function be required, you can
5598 obtain it via @var{fundecl}.  @var{size} is the size, in bytes, of the
5599 constant pool that GCC wrote immediately before this call.
5601 If no constant-pool epilogue is required, the usual case, you need not
5602 define this macro.
5604 @findex IS_ASM_LOGICAL_LINE_SEPARATOR
5605 @item IS_ASM_LOGICAL_LINE_SEPARATOR (@var{C})
5606 Define this macro as a C expression which is nonzero if @var{C} is
5607 used as a logical line separator by the assembler.
5609 If you do not define this macro, the default is that only
5610 the character @samp{;} is treated as a logical line separator.
5613 @findex ASM_OPEN_PAREN
5614 @findex ASM_CLOSE_PAREN
5615 @item ASM_OPEN_PAREN
5616 @itemx ASM_CLOSE_PAREN
5617 These macros are defined as C string constant, describing the syntax
5618 in the assembler for grouping arithmetic expressions.  The following
5619 definitions are correct for most assemblers:
5621 @example
5622 #define ASM_OPEN_PAREN "("
5623 #define ASM_CLOSE_PAREN ")"
5624 @end example
5625 @end table
5627   These macros are provided by @file{real.h} for writing the definitions
5628 of @code{ASM_OUTPUT_DOUBLE} and the like:
5630 @table @code
5631 @item REAL_VALUE_TO_TARGET_SINGLE (@var{x}, @var{l})
5632 @itemx REAL_VALUE_TO_TARGET_DOUBLE (@var{x}, @var{l})
5633 @itemx REAL_VALUE_TO_TARGET_LONG_DOUBLE (@var{x}, @var{l})
5634 @findex REAL_VALUE_TO_TARGET_SINGLE
5635 @findex REAL_VALUE_TO_TARGET_DOUBLE
5636 @findex REAL_VALUE_TO_TARGET_LONG_DOUBLE
5637 These translate @var{x}, of type @code{REAL_VALUE_TYPE}, to the target's
5638 floating point representation, and store its bit pattern in the array of
5639 @code{long int} whose address is @var{l}.  The number of elements in the
5640 output array is determined by the size of the desired target floating
5641 point data type: 32 bits of it go in each @code{long int} array
5642 element.  Each array element holds 32 bits of the result, even if
5643 @code{long int} is wider than 32 bits on the host machine.
5645 The array element values are designed so that you can print them out
5646 using @code{fprintf} in the order they should appear in the target
5647 machine's memory.
5649 @item REAL_VALUE_TO_DECIMAL (@var{x}, @var{format}, @var{string})
5650 @findex REAL_VALUE_TO_DECIMAL
5651 This macro converts @var{x}, of type @code{REAL_VALUE_TYPE}, to a
5652 decimal number and stores it as a string into @var{string}.
5653 You must pass, as @var{string}, the address of a long enough block
5654 of space to hold the result.
5656 The argument @var{format} is a @code{printf}-specification that serves
5657 as a suggestion for how to format the output string.
5658 @end table
5660 @node Uninitialized Data
5661 @subsection Output of Uninitialized Variables
5663 Each of the macros in this section is used to do the whole job of
5664 outputting a single uninitialized variable.
5666 @table @code
5667 @findex ASM_OUTPUT_COMMON
5668 @item ASM_OUTPUT_COMMON (@var{stream}, @var{name}, @var{size}, @var{rounded})
5669 A C statement (sans semicolon) to output to the stdio stream
5670 @var{stream} the assembler definition of a common-label named
5671 @var{name} whose size is @var{size} bytes.  The variable @var{rounded}
5672 is the size rounded up to whatever alignment the caller wants.
5674 Use the expression @code{assemble_name (@var{stream}, @var{name})} to
5675 output the name itself; before and after that, output the additional
5676 assembler syntax for defining the name, and a newline.
5678 This macro controls how the assembler definitions of uninitialized
5679 common global variables are output.
5681 @findex ASM_OUTPUT_ALIGNED_COMMON
5682 @item ASM_OUTPUT_ALIGNED_COMMON (@var{stream}, @var{name}, @var{size}, @var{alignment})
5683 Like @code{ASM_OUTPUT_COMMON} except takes the required alignment as a
5684 separate, explicit argument.  If you define this macro, it is used in
5685 place of @code{ASM_OUTPUT_COMMON}, and gives you more flexibility in
5686 handling the required alignment of the variable.  The alignment is specified
5687 as the number of bits.
5689 @findex ASM_OUTPUT_ALIGNED_DECL_COMMON
5690 @item ASM_OUTPUT_ALIGNED_DECL_COMMON (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment})
5691 Like @code{ASM_OUTPUT_ALIGNED_COMMON} except that @var{decl} of the
5692 variable to be output, if there is one, or @code{NULL_TREE} if there
5693 is no corresponding variable.  If you define this macro, GCC will use it
5694 in place of both @code{ASM_OUTPUT_COMMON} and
5695 @code{ASM_OUTPUT_ALIGNED_COMMON}.  Define this macro when you need to see
5696 the variable's decl in order to chose what to output.
5698 @findex ASM_OUTPUT_SHARED_COMMON
5699 @item ASM_OUTPUT_SHARED_COMMON (@var{stream}, @var{name}, @var{size}, @var{rounded})
5700 If defined, it is similar to @code{ASM_OUTPUT_COMMON}, except that it
5701 is used when @var{name} is shared.  If not defined, @code{ASM_OUTPUT_COMMON}
5702 will be used.
5704 @findex ASM_OUTPUT_BSS
5705 @item ASM_OUTPUT_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{rounded})
5706 A C statement (sans semicolon) to output to the stdio stream
5707 @var{stream} the assembler definition of uninitialized global @var{decl} named
5708 @var{name} whose size is @var{size} bytes.  The variable @var{rounded}
5709 is the size rounded up to whatever alignment the caller wants.
5711 Try to use function @code{asm_output_bss} defined in @file{varasm.c} when
5712 defining this macro.  If unable, use the expression
5713 @code{assemble_name (@var{stream}, @var{name})} to output the name itself;
5714 before and after that, output the additional assembler syntax for defining
5715 the name, and a newline.
5717 This macro controls how the assembler definitions of uninitialized global
5718 variables are output.  This macro exists to properly support languages like
5719 @code{c++} which do not have @code{common} data.  However, this macro currently
5720 is not defined for all targets.  If this macro and
5721 @code{ASM_OUTPUT_ALIGNED_BSS} are not defined then @code{ASM_OUTPUT_COMMON}
5722 or @code{ASM_OUTPUT_ALIGNED_COMMON} or
5723 @code{ASM_OUTPUT_ALIGNED_DECL_COMMON} is used.
5725 @findex ASM_OUTPUT_ALIGNED_BSS
5726 @item ASM_OUTPUT_ALIGNED_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment})
5727 Like @code{ASM_OUTPUT_BSS} except takes the required alignment as a
5728 separate, explicit argument.  If you define this macro, it is used in
5729 place of @code{ASM_OUTPUT_BSS}, and gives you more flexibility in
5730 handling the required alignment of the variable.  The alignment is specified
5731 as the number of bits.
5733 Try to use function @code{asm_output_aligned_bss} defined in file
5734 @file{varasm.c} when defining this macro.
5736 @findex ASM_OUTPUT_SHARED_BSS
5737 @item ASM_OUTPUT_SHARED_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{rounded})
5738 If defined, it is similar to @code{ASM_OUTPUT_BSS}, except that it
5739 is used when @var{name} is shared.  If not defined, @code{ASM_OUTPUT_BSS}
5740 will be used.
5742 @findex ASM_OUTPUT_LOCAL
5743 @item ASM_OUTPUT_LOCAL (@var{stream}, @var{name}, @var{size}, @var{rounded})
5744 A C statement (sans semicolon) to output to the stdio stream
5745 @var{stream} the assembler definition of a local-common-label named
5746 @var{name} whose size is @var{size} bytes.  The variable @var{rounded}
5747 is the size rounded up to whatever alignment the caller wants.
5749 Use the expression @code{assemble_name (@var{stream}, @var{name})} to
5750 output the name itself; before and after that, output the additional
5751 assembler syntax for defining the name, and a newline.
5753 This macro controls how the assembler definitions of uninitialized
5754 static variables are output.
5756 @findex ASM_OUTPUT_ALIGNED_LOCAL
5757 @item ASM_OUTPUT_ALIGNED_LOCAL (@var{stream}, @var{name}, @var{size}, @var{alignment})
5758 Like @code{ASM_OUTPUT_LOCAL} except takes the required alignment as a
5759 separate, explicit argument.  If you define this macro, it is used in
5760 place of @code{ASM_OUTPUT_LOCAL}, and gives you more flexibility in
5761 handling the required alignment of the variable.  The alignment is specified
5762 as the number of bits.
5764 @findex ASM_OUTPUT_ALIGNED_DECL_LOCAL
5765 @item ASM_OUTPUT_ALIGNED_DECL_LOCAL (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment})
5766 Like @code{ASM_OUTPUT_ALIGNED_DECL} except that @var{decl} of the
5767 variable to be output, if there is one, or @code{NULL_TREE} if there
5768 is no corresponding variable.  If you define this macro, GCC will use it
5769 in place of both @code{ASM_OUTPUT_DECL} and
5770 @code{ASM_OUTPUT_ALIGNED_DECL}.  Define this macro when you need to see
5771 the variable's decl in order to chose what to output.
5773 @findex ASM_OUTPUT_SHARED_LOCAL
5774 @item ASM_OUTPUT_SHARED_LOCAL (@var{stream}, @var{name}, @var{size}, @var{rounded})
5775 If defined, it is similar to @code{ASM_OUTPUT_LOCAL}, except that it
5776 is used when @var{name} is shared.  If not defined, @code{ASM_OUTPUT_LOCAL}
5777 will be used.
5778 @end table
5780 @node Label Output
5781 @subsection Output and Generation of Labels
5783 @c prevent bad page break with this line
5784 This is about outputting labels.
5786 @table @code
5787 @findex ASM_OUTPUT_LABEL
5788 @findex assemble_name
5789 @item ASM_OUTPUT_LABEL (@var{stream}, @var{name})
5790 A C statement (sans semicolon) to output to the stdio stream
5791 @var{stream} the assembler definition of a label named @var{name}.
5792 Use the expression @code{assemble_name (@var{stream}, @var{name})} to
5793 output the name itself; before and after that, output the additional
5794 assembler syntax for defining the name, and a newline.
5796 @findex ASM_DECLARE_FUNCTION_NAME
5797 @item ASM_DECLARE_FUNCTION_NAME (@var{stream}, @var{name}, @var{decl})
5798 A C statement (sans semicolon) to output to the stdio stream
5799 @var{stream} any text necessary for declaring the name @var{name} of a
5800 function which is being defined.  This macro is responsible for
5801 outputting the label definition (perhaps using
5802 @code{ASM_OUTPUT_LABEL}).  The argument @var{decl} is the
5803 @code{FUNCTION_DECL} tree node representing the function.
5805 If this macro is not defined, then the function name is defined in the
5806 usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}).
5808 @findex ASM_DECLARE_FUNCTION_SIZE
5809 @item ASM_DECLARE_FUNCTION_SIZE (@var{stream}, @var{name}, @var{decl})
5810 A C statement (sans semicolon) to output to the stdio stream
5811 @var{stream} any text necessary for declaring the size of a function
5812 which is being defined.  The argument @var{name} is the name of the
5813 function.  The argument @var{decl} is the @code{FUNCTION_DECL} tree node
5814 representing the function.
5816 If this macro is not defined, then the function size is not defined.
5818 @findex ASM_DECLARE_OBJECT_NAME
5819 @item ASM_DECLARE_OBJECT_NAME (@var{stream}, @var{name}, @var{decl})
5820 A C statement (sans semicolon) to output to the stdio stream
5821 @var{stream} any text necessary for declaring the name @var{name} of an
5822 initialized variable which is being defined.  This macro must output the
5823 label definition (perhaps using @code{ASM_OUTPUT_LABEL}).  The argument
5824 @var{decl} is the @code{VAR_DECL} tree node representing the variable.
5826 If this macro is not defined, then the variable name is defined in the
5827 usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}).
5829 @findex ASM_DECLARE_REGISTER_GLOBAL
5830 @item ASM_DECLARE_REGISTER_GLOBAL (@var{stream}, @var{decl}, @var{regno}, @var{name})
5831 A C statement (sans semicolon) to output to the stdio stream
5832 @var{stream} any text necessary for claiming a register @var{regno}
5833 for a global variable @var{decl} with name @var{name}.
5835 If you don't define this macro, that is equivalent to defining it to do
5836 nothing.
5838 @findex  ASM_FINISH_DECLARE_OBJECT
5839 @item ASM_FINISH_DECLARE_OBJECT (@var{stream}, @var{decl}, @var{toplevel}, @var{atend})
5840 A C statement (sans semicolon) to finish up declaring a variable name
5841 once the compiler has processed its initializer fully and thus has had a
5842 chance to determine the size of an array when controlled by an
5843 initializer.  This is used on systems where it's necessary to declare
5844 something about the size of the object.
5846 If you don't define this macro, that is equivalent to defining it to do
5847 nothing.
5849 @findex ASM_GLOBALIZE_LABEL
5850 @item ASM_GLOBALIZE_LABEL (@var{stream}, @var{name})
5851 A C statement (sans semicolon) to output to the stdio stream
5852 @var{stream} some commands that will make the label @var{name} global;
5853 that is, available for reference from other files.  Use the expression
5854 @code{assemble_name (@var{stream}, @var{name})} to output the name
5855 itself; before and after that, output the additional assembler syntax
5856 for making that name global, and a newline.
5858 @findex ASM_WEAKEN_LABEL
5859 @item ASM_WEAKEN_LABEL
5860 A C statement (sans semicolon) to output to the stdio stream
5861 @var{stream} some commands that will make the label @var{name} weak;
5862 that is, available for reference from other files but only used if
5863 no other definition is available.  Use the expression
5864 @code{assemble_name (@var{stream}, @var{name})} to output the name
5865 itself; before and after that, output the additional assembler syntax
5866 for making that name weak, and a newline.
5868 If you don't define this macro, GCC will not support weak
5869 symbols and you should not define the @code{SUPPORTS_WEAK} macro.
5871 @findex SUPPORTS_WEAK
5872 @item SUPPORTS_WEAK
5873 A C expression which evaluates to true if the target supports weak symbols.
5875 If you don't define this macro, @file{defaults.h} provides a default
5876 definition.  If @code{ASM_WEAKEN_LABEL} is defined, the default
5877 definition is @samp{1}; otherwise, it is @samp{0}.  Define this macro if
5878 you want to control weak symbol support with a compiler flag such as
5879 @samp{-melf}.
5881 @findex MAKE_DECL_ONE_ONLY (@var{decl})
5882 @item MAKE_DECL_ONE_ONLY
5883 A C statement (sans semicolon) to mark @var{decl} to be emitted as a
5884 public symbol such that extra copies in multiple translation units will
5885 be discarded by the linker.  Define this macro if your object file
5886 format provides support for this concept, such as the @samp{COMDAT}
5887 section flags in the Microsoft Windows PE/COFF format, and this support
5888 requires changes to @var{decl}, such as putting it in a separate section.
5890 @findex SUPPORTS_ONE_ONLY
5891 @item SUPPORTS_ONE_ONLY
5892 A C expression which evaluates to true if the target supports one-only
5893 semantics.
5895 If you don't define this macro, @file{varasm.c} provides a default
5896 definition.  If @code{MAKE_DECL_ONE_ONLY} is defined, the default
5897 definition is @samp{1}; otherwise, it is @samp{0}.  Define this macro if
5898 you want to control one-only symbol support with a compiler flag, or if
5899 setting the @code{DECL_ONE_ONLY} flag is enough to mark a declaration to
5900 be emitted as one-only.
5902 @findex ASM_OUTPUT_EXTERNAL
5903 @item ASM_OUTPUT_EXTERNAL (@var{stream}, @var{decl}, @var{name})
5904 A C statement (sans semicolon) to output to the stdio stream
5905 @var{stream} any text necessary for declaring the name of an external
5906 symbol named @var{name} which is referenced in this compilation but
5907 not defined.  The value of @var{decl} is the tree node for the
5908 declaration.
5910 This macro need not be defined if it does not need to output anything.
5911 The GNU assembler and most Unix assemblers don't require anything.
5913 @findex ASM_OUTPUT_EXTERNAL_LIBCALL
5914 @item ASM_OUTPUT_EXTERNAL_LIBCALL (@var{stream}, @var{symref})
5915 A C statement (sans semicolon) to output on @var{stream} an assembler
5916 pseudo-op to declare a library function name external.  The name of the
5917 library function is given by @var{symref}, which has type @code{rtx} and
5918 is a @code{symbol_ref}.
5920 This macro need not be defined if it does not need to output anything.
5921 The GNU assembler and most Unix assemblers don't require anything.
5923 @findex ASM_OUTPUT_LABELREF
5924 @item ASM_OUTPUT_LABELREF (@var{stream}, @var{name})
5925 A C statement (sans semicolon) to output to the stdio stream
5926 @var{stream} a reference in assembler syntax to a label named
5927 @var{name}.  This should add @samp{_} to the front of the name, if that
5928 is customary on your operating system, as it is in most Berkeley Unix
5929 systems.  This macro is used in @code{assemble_name}.
5931 @ignore @c Seems not to exist anymore.
5932 @findex ASM_OUTPUT_LABELREF_AS_INT
5933 @item ASM_OUTPUT_LABELREF_AS_INT (@var{file}, @var{label})
5934 Define this macro for systems that use the program @code{collect2}.
5935 The definition should be a C statement to output a word containing
5936 a reference to the label @var{label}.
5937 @end ignore
5939 @findex ASM_OUTPUT_INTERNAL_LABEL
5940 @item ASM_OUTPUT_INTERNAL_LABEL (@var{stream}, @var{prefix}, @var{num})
5941 A C statement to output to the stdio stream @var{stream} a label whose
5942 name is made from the string @var{prefix} and the number @var{num}.
5944 It is absolutely essential that these labels be distinct from the labels
5945 used for user-level functions and variables.  Otherwise, certain programs
5946 will have name conflicts with internal labels.
5948 It is desirable to exclude internal labels from the symbol table of the
5949 object file.  Most assemblers have a naming convention for labels that
5950 should be excluded; on many systems, the letter @samp{L} at the
5951 beginning of a label has this effect.  You should find out what
5952 convention your system uses, and follow it.
5954 The usual definition of this macro is as follows:
5956 @example
5957 fprintf (@var{stream}, "L%s%d:\n", @var{prefix}, @var{num})
5958 @end example
5960 @findex ASM_OUTPUT_DEBUG_LABEL
5961 @item ASM_OUTPUT_DEBUG_LABEL (@var{stream}, @var{prefix}, @var{num})
5962 A C statement to output to the stdio stream @var{stream} a debug info
5963 label whose name is made from the string @var{prefix} and the number
5964 @var{num}.  This is useful for VLIW targets, where debug info labels
5965 may need to be treated differently than branch target labels.  On some
5966 systems, branch target labels must be at the beginning of instruction
5967 bundles, but debug info labels can occur in the middle of instruction
5968 bundles.
5970 If this macro is not defined, then @code{ASM_OUTPUT_INTERNAL_LABEL} will be
5971 used.
5973 @findex ASM_OUTPUT_ALTERNATE_LABEL_NAME
5974 @item ASM_OUTPUT_ALTERNATE_LABEL_NAME (@var{stream}, @var{string})
5975 A C statement to output to the stdio stream @var{stream} the string
5976 @var{string}.
5978 The default definition of this macro is as follows:
5980 @example
5981 fprintf (@var{stream}, "%s:\n", LABEL_ALTERNATE_NAME (INSN))
5982 @end example
5984 @findex ASM_GENERATE_INTERNAL_LABEL
5985 @item ASM_GENERATE_INTERNAL_LABEL (@var{string}, @var{prefix}, @var{num})
5986 A C statement to store into the string @var{string} a label whose name
5987 is made from the string @var{prefix} and the number @var{num}.
5989 This string, when output subsequently by @code{assemble_name}, should
5990 produce the output that @code{ASM_OUTPUT_INTERNAL_LABEL} would produce
5991 with the same @var{prefix} and @var{num}.
5993 If the string begins with @samp{*}, then @code{assemble_name} will
5994 output the rest of the string unchanged.  It is often convenient for
5995 @code{ASM_GENERATE_INTERNAL_LABEL} to use @samp{*} in this way.  If the
5996 string doesn't start with @samp{*}, then @code{ASM_OUTPUT_LABELREF} gets
5997 to output the string, and may change it.  (Of course,
5998 @code{ASM_OUTPUT_LABELREF} is also part of your machine description, so
5999 you should know what it does on your machine.)
6001 @findex ASM_FORMAT_PRIVATE_NAME
6002 @item ASM_FORMAT_PRIVATE_NAME (@var{outvar}, @var{name}, @var{number})
6003 A C expression to assign to @var{outvar} (which is a variable of type
6004 @code{char *}) a newly allocated string made from the string
6005 @var{name} and the number @var{number}, with some suitable punctuation
6006 added.  Use @code{alloca} to get space for the string.
6008 The string will be used as an argument to @code{ASM_OUTPUT_LABELREF} to
6009 produce an assembler label for an internal static variable whose name is
6010 @var{name}.  Therefore, the string must be such as to result in valid
6011 assembler code.  The argument @var{number} is different each time this
6012 macro is executed; it prevents conflicts between similarly-named
6013 internal static variables in different scopes.
6015 Ideally this string should not be a valid C identifier, to prevent any
6016 conflict with the user's own symbols.  Most assemblers allow periods
6017 or percent signs in assembler symbols; putting at least one of these
6018 between the name and the number will suffice.
6020 @findex ASM_OUTPUT_DEF
6021 @item ASM_OUTPUT_DEF (@var{stream}, @var{name}, @var{value})
6022 A C statement to output to the stdio stream @var{stream} assembler code
6023 which defines (equates) the symbol @var{name} to have the value @var{value}.
6025 @findex SET_ASM_OP
6026 If SET_ASM_OP is defined, a default definition is provided which is
6027 correct for most systems.
6029 @findex ASM_OUTPUT_DEF_FROM_DECLS
6030 @item ASM_OUTPUT_DEF_FROM_DECLS (@var{stream}, @var{decl_of_name}, @var{decl_of_value})
6031 A C statement to output to the stdio stream @var{stream} assembler code
6032 which defines (equates) the symbol whose tree node is @var{decl_of_name}
6033 to have the value of the tree node @var{decl_of_value}.  This macro will
6034 be used in preference to @samp{ASM_OUTPUT_DEF} if it is defined and if
6035 the tree nodes are available.
6037 @findex ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL
6038 @item ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL (@var{stream}, @var{symbol}, @var{high}, @var{low})
6039 A C statement to output to the stdio stream @var{stream} assembler code
6040 which defines (equates) the symbol @var{symbol} to have a value equal to
6041 the difference of the two symbols @var{high} and @var{low}, i.e.
6042 @var{high} minus @var{low}.  GCC guarantees that the symbols @var{high}
6043 and @var{low} are already known by the assembler so that the difference
6044 resolves into a constant.
6046 @findex SET_ASM_OP
6047 If SET_ASM_OP is defined, a default definition is provided which is
6048 correct for most systems.
6050 @findex ASM_OUTPUT_WEAK_ALIAS
6051 @item ASM_OUTPUT_WEAK_ALIAS (@var{stream}, @var{name}, @var{value})
6052 A C statement to output to the stdio stream @var{stream} assembler code
6053 which defines (equates) the weak symbol @var{name} to have the value
6054 @var{value}.
6056 Define this macro if the target only supports weak aliases; define
6057 ASM_OUTPUT_DEF instead if possible.
6059 @findex OBJC_GEN_METHOD_LABEL
6060 @item OBJC_GEN_METHOD_LABEL (@var{buf}, @var{is_inst}, @var{class_name}, @var{cat_name}, @var{sel_name})
6061 Define this macro to override the default assembler names used for
6062 Objective C methods.
6064 The default name is a unique method number followed by the name of the
6065 class (e.g.@: @samp{_1_Foo}).  For methods in categories, the name of
6066 the category is also included in the assembler name (e.g.@:
6067 @samp{_1_Foo_Bar}).
6069 These names are safe on most systems, but make debugging difficult since
6070 the method's selector is not present in the name.  Therefore, particular
6071 systems define other ways of computing names.
6073 @var{buf} is an expression of type @code{char *} which gives you a
6074 buffer in which to store the name; its length is as long as
6075 @var{class_name}, @var{cat_name} and @var{sel_name} put together, plus
6076 50 characters extra.
6078 The argument @var{is_inst} specifies whether the method is an instance
6079 method or a class method; @var{class_name} is the name of the class;
6080 @var{cat_name} is the name of the category (or NULL if the method is not
6081 in a category); and @var{sel_name} is the name of the selector.
6083 On systems where the assembler can handle quoted names, you can use this
6084 macro to provide more human-readable names.
6085 @end table
6087 @node Initialization
6088 @subsection How Initialization Functions Are Handled
6089 @cindex initialization routines
6090 @cindex termination routines
6091 @cindex constructors, output of
6092 @cindex destructors, output of
6094 The compiled code for certain languages includes @dfn{constructors}
6095 (also called @dfn{initialization routines})---functions to initialize
6096 data in the program when the program is started.  These functions need
6097 to be called before the program is ``started''---that is to say, before
6098 @code{main} is called.
6100 Compiling some languages generates @dfn{destructors} (also called
6101 @dfn{termination routines}) that should be called when the program
6102 terminates.
6104 To make the initialization and termination functions work, the compiler
6105 must output something in the assembler code to cause those functions to
6106 be called at the appropriate time.  When you port the compiler to a new
6107 system, you need to specify how to do this.
6109 There are two major ways that GCC currently supports the execution of
6110 initialization and termination functions.  Each way has two variants.
6111 Much of the structure is common to all four variations.
6113 @findex __CTOR_LIST__
6114 @findex __DTOR_LIST__
6115 The linker must build two lists of these functions---a list of
6116 initialization functions, called @code{__CTOR_LIST__}, and a list of
6117 termination functions, called @code{__DTOR_LIST__}.
6119 Each list always begins with an ignored function pointer (which may hold
6120 0, @minus{}1, or a count of the function pointers after it, depending on
6121 the environment).  This is followed by a series of zero or more function
6122 pointers to constructors (or destructors), followed by a function
6123 pointer containing zero.
6125 Depending on the operating system and its executable file format, either
6126 @file{crtstuff.c} or @file{libgcc2.c} traverses these lists at startup
6127 time and exit time.  Constructors are called in reverse order of the
6128 list; destructors in forward order.
6130 The best way to handle static constructors works only for object file
6131 formats which provide arbitrarily-named sections.  A section is set
6132 aside for a list of constructors, and another for a list of destructors.
6133 Traditionally these are called @samp{.ctors} and @samp{.dtors}.  Each
6134 object file that defines an initialization function also puts a word in
6135 the constructor section to point to that function.  The linker
6136 accumulates all these words into one contiguous @samp{.ctors} section.
6137 Termination functions are handled similarly.
6139 To use this method, you need appropriate definitions of the macros
6140 @code{ASM_OUTPUT_CONSTRUCTOR} and @code{ASM_OUTPUT_DESTRUCTOR}.  Usually
6141 you can get them by including @file{svr4.h}.
6143 When arbitrary sections are available, there are two variants, depending
6144 upon how the code in @file{crtstuff.c} is called.  On systems that
6145 support an @dfn{init} section which is executed at program startup,
6146 parts of @file{crtstuff.c} are compiled into that section.  The
6147 program is linked by the @code{gcc} driver like this:
6149 @example
6150 ld -o @var{output_file} crtbegin.o @dots{} crtend.o -lgcc
6151 @end example
6153 The head of a function (@code{__do_global_ctors}) appears in the init
6154 section of @file{crtbegin.o}; the remainder of the function appears in
6155 the init section of @file{crtend.o}.  The linker will pull these two
6156 parts of the section together, making a whole function.  If any of the
6157 user's object files linked into the middle of it contribute code, then that
6158 code will be executed as part of the body of @code{__do_global_ctors}.
6160 To use this variant, you must define the @code{INIT_SECTION_ASM_OP}
6161 macro properly.
6163 If no init section is available, do not define
6164 @code{INIT_SECTION_ASM_OP}.  Then @code{__do_global_ctors} is built into
6165 the text section like all other functions, and resides in
6166 @file{libgcc.a}.  When GCC compiles any function called @code{main}, it
6167 inserts a procedure call to @code{__main} as the first executable code
6168 after the function prologue.  The @code{__main} function, also defined
6169 in @file{libgcc2.c}, simply calls @file{__do_global_ctors}.
6171 In file formats that don't support arbitrary sections, there are again
6172 two variants.  In the simplest variant, the GNU linker (GNU @code{ld})
6173 and an `a.out' format must be used.  In this case,
6174 @code{ASM_OUTPUT_CONSTRUCTOR} is defined to produce a @code{.stabs}
6175 entry of type @samp{N_SETT}, referencing the name @code{__CTOR_LIST__},
6176 and with the address of the void function containing the initialization
6177 code as its value.  The GNU linker recognizes this as a request to add
6178 the value to a ``set''; the values are accumulated, and are eventually
6179 placed in the executable as a vector in the format described above, with
6180 a leading (ignored) count and a trailing zero element.
6181 @code{ASM_OUTPUT_DESTRUCTOR} is handled similarly.  Since no init
6182 section is available, the absence of @code{INIT_SECTION_ASM_OP} causes
6183 the compilation of @code{main} to call @code{__main} as above, starting
6184 the initialization process.
6186 The last variant uses neither arbitrary sections nor the GNU linker.
6187 This is preferable when you want to do dynamic linking and when using
6188 file formats which the GNU linker does not support, such as `ECOFF'.  In
6189 this case, @code{ASM_OUTPUT_CONSTRUCTOR} does not produce an
6190 @code{N_SETT} symbol; initialization and termination functions are
6191 recognized simply by their names.  This requires an extra program in the
6192 linkage step, called @code{collect2}.  This program pretends to be the
6193 linker, for use with GCC; it does its job by running the ordinary
6194 linker, but also arranges to include the vectors of initialization and
6195 termination functions.  These functions are called via @code{__main} as
6196 described above.
6198 Choosing among these configuration options has been simplified by a set
6199 of operating-system-dependent files in the @file{config} subdirectory.
6200 These files define all of the relevant parameters.  Usually it is
6201 sufficient to include one into your specific machine-dependent
6202 configuration file.  These files are:
6204 @table @file
6205 @item aoutos.h
6206 For operating systems using the `a.out' format.
6208 @item next.h
6209 For operating systems using the `MachO' format.
6211 @item svr3.h
6212 For System V Release 3 and similar systems using `COFF' format.
6214 @item svr4.h
6215 For System V Release 4 and similar systems using `ELF' format.
6217 @item vms.h
6218 For the VMS operating system.
6219 @end table
6221 @ifinfo
6222 The following section describes the specific macros that control and
6223 customize the handling of initialization and termination functions.
6224 @end ifinfo
6226 @node Macros for Initialization
6227 @subsection Macros Controlling Initialization Routines
6229 Here are the macros that control how the compiler handles initialization
6230 and termination functions:
6232 @table @code
6233 @findex INIT_SECTION_ASM_OP
6234 @item INIT_SECTION_ASM_OP
6235 If defined, a C string constant, including spacing, for the assembler
6236 operation to identify the following data as initialization code.  If not
6237 defined, GCC will assume such a section does not exist.  When you are
6238 using special sections for initialization and termination functions, this
6239 macro also controls how @file{crtstuff.c} and @file{libgcc2.c} arrange to
6240 run the initialization functions.
6242 @item HAS_INIT_SECTION
6243 @findex HAS_INIT_SECTION
6244 If defined, @code{main} will not call @code{__main} as described above.
6245 This macro should be defined for systems that control the contents of the
6246 init section on a symbol-by-symbol basis, such as OSF/1, and should not
6247 be defined explicitly for systems that support
6248 @code{INIT_SECTION_ASM_OP}.
6250 @item LD_INIT_SWITCH
6251 @findex LD_INIT_SWITCH
6252 If defined, a C string constant for a switch that tells the linker that
6253 the following symbol is an initialization routine.
6255 @item LD_FINI_SWITCH
6256 @findex LD_FINI_SWITCH
6257 If defined, a C string constant for a switch that tells the linker that
6258 the following symbol is a finalization routine.
6260 @item INVOKE__main
6261 @findex INVOKE__main
6262 If defined, @code{main} will call @code{__main} despite the presence of
6263 @code{INIT_SECTION_ASM_OP}.  This macro should be defined for systems
6264 where the init section is not actually run automatically, but is still
6265 useful for collecting the lists of constructors and destructors.
6267 @item ASM_OUTPUT_CONSTRUCTOR (@var{stream}, @var{name})
6268 @findex ASM_OUTPUT_CONSTRUCTOR
6269 Define this macro as a C statement to output on the stream @var{stream}
6270 the assembler code to arrange to call the function named @var{name} at
6271 initialization time.
6273 Assume that @var{name} is the name of a C function generated
6274 automatically by the compiler.  This function takes no arguments.  Use
6275 the function @code{assemble_name} to output the name @var{name}; this
6276 performs any system-specific syntactic transformations such as adding an
6277 underscore.
6279 If you don't define this macro, nothing special is output to arrange to
6280 call the function.  This is correct when the function will be called in
6281 some other manner---for example, by means of the @code{collect2} program,
6282 which looks through the symbol table to find these functions by their
6283 names.
6285 @item ASM_OUTPUT_DESTRUCTOR (@var{stream}, @var{name})
6286 @findex ASM_OUTPUT_DESTRUCTOR
6287 This is like @code{ASM_OUTPUT_CONSTRUCTOR} but used for termination
6288 functions rather than initialization functions.
6290 When @code{ASM_OUTPUT_CONSTRUCTOR} and @code{ASM_OUTPUT_DESTRUCTOR} are
6291 defined, the initialization routine generated for the generated object
6292 file will have static linkage.
6293 @end table
6295 If your system uses @code{collect2} as the means of processing
6296 constructors, then that program normally uses @code{nm} to scan an
6297 object file for constructor functions to be called.  On such systems you
6298 must not define @code{ASM_OUTPUT_CONSTRUCTOR} and @code{ASM_OUTPUT_DESTRUCTOR}
6299 as the object file's initialization routine must have global scope.
6301 On certain kinds of systems, you can define these macros to make
6302 @code{collect2} work faster (and, in some cases, make it work at all):
6304 @table @code
6305 @findex OBJECT_FORMAT_COFF
6306 @item OBJECT_FORMAT_COFF
6307 Define this macro if the system uses COFF (Common Object File Format)
6308 object files, so that @code{collect2} can assume this format and scan
6309 object files directly for dynamic constructor/destructor functions.
6311 @findex OBJECT_FORMAT_ROSE
6312 @item OBJECT_FORMAT_ROSE
6313 Define this macro if the system uses ROSE format object files, so that
6314 @code{collect2} can assume this format and scan object files directly
6315 for dynamic constructor/destructor functions.
6317 These macros are effective only in a native compiler; @code{collect2} as
6318 part of a cross compiler always uses @code{nm} for the target machine.
6320 @findex REAL_NM_FILE_NAME
6321 @item REAL_NM_FILE_NAME
6322 Define this macro as a C string constant containing the file name to use
6323 to execute @code{nm}.  The default is to search the path normally for
6324 @code{nm}.
6326 If your system supports shared libraries and has a program to list the
6327 dynamic dependencies of a given library or executable, you can define
6328 these macros to enable support for running initialization and
6329 termination functions in shared libraries:
6331 @findex LDD_SUFFIX
6332 @item LDD_SUFFIX
6333 Define this macro to a C string constant containing the name of the
6334 program which lists dynamic dependencies, like @code{"ldd"} under SunOS 4.
6336 @findex PARSE_LDD_OUTPUT
6337 @item PARSE_LDD_OUTPUT (@var{PTR})
6338 Define this macro to be C code that extracts filenames from the output
6339 of the program denoted by @code{LDD_SUFFIX}.  @var{PTR} is a variable
6340 of type @code{char *} that points to the beginning of a line of output
6341 from @code{LDD_SUFFIX}.  If the line lists a dynamic dependency, the
6342 code must advance @var{PTR} to the beginning of the filename on that
6343 line.  Otherwise, it must set @var{PTR} to @code{NULL}.
6345 @end table
6347 @node Instruction Output
6348 @subsection Output of Assembler Instructions
6350 @c prevent bad page break with this line
6351 This describes assembler instruction output.
6353 @table @code
6354 @findex REGISTER_NAMES
6355 @item REGISTER_NAMES
6356 A C initializer containing the assembler's names for the machine
6357 registers, each one as a C string constant.  This is what translates
6358 register numbers in the compiler into assembler language.
6360 @findex ADDITIONAL_REGISTER_NAMES
6361 @item ADDITIONAL_REGISTER_NAMES
6362 If defined, a C initializer for an array of structures containing a name
6363 and a register number.  This macro defines additional names for hard
6364 registers, thus allowing the @code{asm} option in declarations to refer
6365 to registers using alternate names.
6367 @findex ASM_OUTPUT_OPCODE
6368 @item ASM_OUTPUT_OPCODE (@var{stream}, @var{ptr})
6369 Define this macro if you are using an unusual assembler that
6370 requires different names for the machine instructions.
6372 The definition is a C statement or statements which output an
6373 assembler instruction opcode to the stdio stream @var{stream}.  The
6374 macro-operand @var{ptr} is a variable of type @code{char *} which
6375 points to the opcode name in its ``internal'' form---the form that is
6376 written in the machine description.  The definition should output the
6377 opcode name to @var{stream}, performing any translation you desire, and
6378 increment the variable @var{ptr} to point at the end of the opcode
6379 so that it will not be output twice.
6381 In fact, your macro definition may process less than the entire opcode
6382 name, or more than the opcode name; but if you want to process text
6383 that includes @samp{%}-sequences to substitute operands, you must take
6384 care of the substitution yourself.  Just be sure to increment
6385 @var{ptr} over whatever text should not be output normally.
6387 @findex recog_operand
6388 If you need to look at the operand values, they can be found as the
6389 elements of @code{recog_operand}.
6391 If the macro definition does nothing, the instruction is output
6392 in the usual way.
6394 @findex FINAL_PRESCAN_INSN
6395 @item FINAL_PRESCAN_INSN (@var{insn}, @var{opvec}, @var{noperands})
6396 If defined, a C statement to be executed just prior to the output of
6397 assembler code for @var{insn}, to modify the extracted operands so
6398 they will be output differently.
6400 Here the argument @var{opvec} is the vector containing the operands
6401 extracted from @var{insn}, and @var{noperands} is the number of
6402 elements of the vector which contain meaningful data for this insn.
6403 The contents of this vector are what will be used to convert the insn
6404 template into assembler code, so you can change the assembler output
6405 by changing the contents of the vector.
6407 This macro is useful when various assembler syntaxes share a single
6408 file of instruction patterns; by defining this macro differently, you
6409 can cause a large class of instructions to be output differently (such
6410 as with rearranged operands).  Naturally, variations in assembler
6411 syntax affecting individual insn patterns ought to be handled by
6412 writing conditional output routines in those patterns.
6414 If this macro is not defined, it is equivalent to a null statement.
6416 @findex FINAL_PRESCAN_LABEL
6417 @item FINAL_PRESCAN_LABEL
6418 If defined, @code{FINAL_PRESCAN_INSN} will be called on each
6419 @code{CODE_LABEL}.  In that case, @var{opvec} will be a null pointer and
6420 @var{noperands} will be zero.
6422 @findex PRINT_OPERAND
6423 @item PRINT_OPERAND (@var{stream}, @var{x}, @var{code})
6424 A C compound statement to output to stdio stream @var{stream} the
6425 assembler syntax for an instruction operand @var{x}.  @var{x} is an
6426 RTL expression.
6428 @var{code} is a value that can be used to specify one of several ways
6429 of printing the operand.  It is used when identical operands must be
6430 printed differently depending on the context.  @var{code} comes from
6431 the @samp{%} specification that was used to request printing of the
6432 operand.  If the specification was just @samp{%@var{digit}} then
6433 @var{code} is 0; if the specification was @samp{%@var{ltr}
6434 @var{digit}} then @var{code} is the ASCII code for @var{ltr}.
6436 @findex reg_names
6437 If @var{x} is a register, this macro should print the register's name.
6438 The names can be found in an array @code{reg_names} whose type is
6439 @code{char *[]}.  @code{reg_names} is initialized from
6440 @code{REGISTER_NAMES}.
6442 When the machine description has a specification @samp{%@var{punct}}
6443 (a @samp{%} followed by a punctuation character), this macro is called
6444 with a null pointer for @var{x} and the punctuation character for
6445 @var{code}.
6447 @findex PRINT_OPERAND_PUNCT_VALID_P
6448 @item PRINT_OPERAND_PUNCT_VALID_P (@var{code})
6449 A C expression which evaluates to true if @var{code} is a valid
6450 punctuation character for use in the @code{PRINT_OPERAND} macro.  If
6451 @code{PRINT_OPERAND_PUNCT_VALID_P} is not defined, it means that no
6452 punctuation characters (except for the standard one, @samp{%}) are used
6453 in this way.
6455 @findex PRINT_OPERAND_ADDRESS
6456 @item PRINT_OPERAND_ADDRESS (@var{stream}, @var{x})
6457 A C compound statement to output to stdio stream @var{stream} the
6458 assembler syntax for an instruction operand that is a memory reference
6459 whose address is @var{x}.  @var{x} is an RTL expression.
6461 @cindex @code{ENCODE_SECTION_INFO} usage
6462 On some machines, the syntax for a symbolic address depends on the
6463 section that the address refers to.  On these machines, define the macro
6464 @code{ENCODE_SECTION_INFO} to store the information into the
6465 @code{symbol_ref}, and then check for it here.  @xref{Assembler Format}.
6467 @findex DBR_OUTPUT_SEQEND
6468 @findex dbr_sequence_length
6469 @item DBR_OUTPUT_SEQEND(@var{file})
6470 A C statement, to be executed after all slot-filler instructions have
6471 been output.  If necessary, call @code{dbr_sequence_length} to
6472 determine the number of slots filled in a sequence (zero if not
6473 currently outputting a sequence), to decide how many no-ops to output,
6474 or whatever.
6476 Don't define this macro if it has nothing to do, but it is helpful in
6477 reading assembly output if the extent of the delay sequence is made
6478 explicit (e.g. with white space).
6480 @findex final_sequence
6481 Note that output routines for instructions with delay slots must be
6482 prepared to deal with not being output as part of a sequence (i.e.
6483 when the scheduling pass is not run, or when no slot fillers could be
6484 found.)  The variable @code{final_sequence} is null when not
6485 processing a sequence, otherwise it contains the @code{sequence} rtx
6486 being output.
6488 @findex REGISTER_PREFIX
6489 @findex LOCAL_LABEL_PREFIX
6490 @findex USER_LABEL_PREFIX
6491 @findex IMMEDIATE_PREFIX
6492 @findex asm_fprintf
6493 @item REGISTER_PREFIX
6494 @itemx LOCAL_LABEL_PREFIX
6495 @itemx USER_LABEL_PREFIX
6496 @itemx IMMEDIATE_PREFIX
6497 If defined, C string expressions to be used for the @samp{%R}, @samp{%L},
6498 @samp{%U}, and @samp{%I} options of @code{asm_fprintf} (see
6499 @file{final.c}).  These are useful when a single @file{md} file must
6500 support multiple assembler formats.  In that case, the various @file{tm.h}
6501 files can define these macros differently.
6503 @item ASM_FPRINTF_EXTENSIONS(@var{file}, @var{argptr}, @var{format})
6504 @findex ASM_FPRINTF_EXTENSIONS
6505 If defined this macro should expand to a series of @code{case}
6506 statements which will be parsed inside the @code{switch} statement of
6507 the @code{asm_fprintf} function.  This allows targets to define extra
6508 printf formats which may useful when generating their assembler
6509 statements.  Note that upper case letters are reserved for future
6510 generic extensions to asm_fprintf, and so are not available to target
6511 specific code.  The output file is given by the parameter @var{file}.
6512 The varargs input pointer is @var{argptr} and the rest of the format
6513 string, starting the character after the one that is being switched
6514 upon, is pointed to by @var{format}.
6516 @findex ASSEMBLER_DIALECT
6517 @item ASSEMBLER_DIALECT
6518 If your target supports multiple dialects of assembler language (such as
6519 different opcodes), define this macro as a C expression that gives the
6520 numeric index of the assembler language dialect to use, with zero as the
6521 first variant.
6523 If this macro is defined, you may use constructs of the form
6524 @samp{@{option0|option1|option2@dots{}@}} in the output
6525 templates of patterns (@pxref{Output Template}) or in the first argument
6526 of @code{asm_fprintf}.  This construct outputs @samp{option0},
6527 @samp{option1} or @samp{option2}, etc., if the value of
6528 @code{ASSEMBLER_DIALECT} is zero, one or two, etc.  Any special
6529 characters within these strings retain their usual meaning.
6531 If you do not define this macro, the characters @samp{@{}, @samp{|} and
6532 @samp{@}} do not have any special meaning when used in templates or
6533 operands to @code{asm_fprintf}.
6535 Define the macros @code{REGISTER_PREFIX}, @code{LOCAL_LABEL_PREFIX},
6536 @code{USER_LABEL_PREFIX} and @code{IMMEDIATE_PREFIX} if you can express
6537 the variations in assembler language syntax with that mechanism.  Define
6538 @code{ASSEMBLER_DIALECT} and use the @samp{@{option0|option1@}} syntax
6539 if the syntax variant are larger and involve such things as different
6540 opcodes or operand order.
6542 @findex ASM_OUTPUT_REG_PUSH
6543 @item ASM_OUTPUT_REG_PUSH (@var{stream}, @var{regno})
6544 A C expression to output to @var{stream} some assembler code
6545 which will push hard register number @var{regno} onto the stack.
6546 The code need not be optimal, since this macro is used only when
6547 profiling.
6549 @findex ASM_OUTPUT_REG_POP
6550 @item ASM_OUTPUT_REG_POP (@var{stream}, @var{regno})
6551 A C expression to output to @var{stream} some assembler code
6552 which will pop hard register number @var{regno} off of the stack.
6553 The code need not be optimal, since this macro is used only when
6554 profiling.
6555 @end table
6557 @node Dispatch Tables
6558 @subsection Output of Dispatch Tables
6560 @c prevent bad page break with this line
6561 This concerns dispatch tables.
6563 @table @code
6564 @cindex dispatch table
6565 @findex ASM_OUTPUT_ADDR_DIFF_ELT
6566 @item ASM_OUTPUT_ADDR_DIFF_ELT (@var{stream}, @var{body}, @var{value}, @var{rel})
6567 A C statement to output to the stdio stream @var{stream} an assembler
6568 pseudo-instruction to generate a difference between two labels.
6569 @var{value} and @var{rel} are the numbers of two internal labels.  The
6570 definitions of these labels are output using
6571 @code{ASM_OUTPUT_INTERNAL_LABEL}, and they must be printed in the same
6572 way here.  For example,
6574 @example
6575 fprintf (@var{stream}, "\t.word L%d-L%d\n",
6576          @var{value}, @var{rel})
6577 @end example
6579 You must provide this macro on machines where the addresses in a
6580 dispatch table are relative to the table's own address.  If defined, GNU
6581 CC will also use this macro on all machines when producing PIC.
6582 @var{body} is the body of the ADDR_DIFF_VEC; it is provided so that the
6583 mode and flags can be read.
6585 @findex ASM_OUTPUT_ADDR_VEC_ELT
6586 @item ASM_OUTPUT_ADDR_VEC_ELT (@var{stream}, @var{value})
6587 This macro should be provided on machines where the addresses
6588 in a dispatch table are absolute.
6590 The definition should be a C statement to output to the stdio stream
6591 @var{stream} an assembler pseudo-instruction to generate a reference to
6592 a label.  @var{value} is the number of an internal label whose
6593 definition is output using @code{ASM_OUTPUT_INTERNAL_LABEL}.
6594 For example,
6596 @example
6597 fprintf (@var{stream}, "\t.word L%d\n", @var{value})
6598 @end example
6600 @findex ASM_OUTPUT_CASE_LABEL
6601 @item ASM_OUTPUT_CASE_LABEL (@var{stream}, @var{prefix}, @var{num}, @var{table})
6602 Define this if the label before a jump-table needs to be output
6603 specially.  The first three arguments are the same as for
6604 @code{ASM_OUTPUT_INTERNAL_LABEL}; the fourth argument is the
6605 jump-table which follows (a @code{jump_insn} containing an
6606 @code{addr_vec} or @code{addr_diff_vec}).
6608 This feature is used on system V to output a @code{swbeg} statement
6609 for the table.
6611 If this macro is not defined, these labels are output with
6612 @code{ASM_OUTPUT_INTERNAL_LABEL}.
6614 @findex ASM_OUTPUT_CASE_END
6615 @item ASM_OUTPUT_CASE_END (@var{stream}, @var{num}, @var{table})
6616 Define this if something special must be output at the end of a
6617 jump-table.  The definition should be a C statement to be executed
6618 after the assembler code for the table is written.  It should write
6619 the appropriate code to stdio stream @var{stream}.  The argument
6620 @var{table} is the jump-table insn, and @var{num} is the label-number
6621 of the preceding label.
6623 If this macro is not defined, nothing special is output at the end of
6624 the jump-table.
6625 @end table
6627 @node Exception Region Output 
6628 @subsection Assembler Commands for Exception Regions
6630 @c prevent bad page break with this line
6632 This describes commands marking the start and the end of an exception
6633 region.
6635 @table @code
6636 @findex ASM_OUTPUT_EH_REGION_BEG
6637 @item ASM_OUTPUT_EH_REGION_BEG ()
6638 A C expression to output text to mark the start of an exception region.
6640 This macro need not be defined on most platforms.
6642 @findex ASM_OUTPUT_EH_REGION_END
6643 @item ASM_OUTPUT_EH_REGION_END ()
6644 A C expression to output text to mark the end of an exception region.
6646 This macro need not be defined on most platforms.
6648 @findex EXCEPTION_SECTION
6649 @item EXCEPTION_SECTION ()
6650 A C expression to switch to the section in which the main
6651 exception table is to be placed (@pxref{Sections}).  The default is a
6652 section named @code{.gcc_except_table} on machines that support named
6653 sections via @code{ASM_OUTPUT_SECTION_NAME}, otherwise if @samp{-fpic}
6654 or @samp{-fPIC} is in effect, the @code{data_section}, otherwise the
6655 @code{readonly_data_section}.
6657 @findex EH_FRAME_SECTION_ASM_OP
6658 @item EH_FRAME_SECTION_ASM_OP
6659 If defined, a C string constant, including spacing, for the assembler
6660 operation to switch to the section for exception handling frame unwind
6661 information.  If not defined, GCC will provide a default definition if the
6662 target supports named sections.  @file{crtstuff.c} uses this macro to
6663 switch to the appropriate section.
6665 You should define this symbol if your target supports DWARF 2 frame
6666 unwind information and the default definition does not work.
6668 @findex OMIT_EH_TABLE
6669 @item OMIT_EH_TABLE ()
6670 A C expression that is nonzero if the normal exception table output
6671 should be omitted.
6673 This macro need not be defined on most platforms.
6675 @findex EH_TABLE_LOOKUP
6676 @item EH_TABLE_LOOKUP ()
6677 Alternate runtime support for looking up an exception at runtime and
6678 finding the associated handler, if the default method won't work.
6680 This macro need not be defined on most platforms.
6682 @findex DOESNT_NEED_UNWINDER
6683 @item DOESNT_NEED_UNWINDER
6684 A C expression that decides whether or not the current function needs to
6685 have a function unwinder generated for it.  See the file @code{except.c}
6686 for details on when to define this, and how.
6688 @findex MASK_RETURN_ADDR
6689 @item MASK_RETURN_ADDR
6690 An rtx used to mask the return address found via RETURN_ADDR_RTX, so
6691 that it does not contain any extraneous set bits in it.
6693 @findex DWARF2_UNWIND_INFO
6694 @item DWARF2_UNWIND_INFO
6695 Define this macro to 0 if your target supports DWARF 2 frame unwind
6696 information, but it does not yet work with exception handling.
6697 Otherwise, if your target supports this information (if it defines
6698 @samp{INCOMING_RETURN_ADDR_RTX} and either @samp{UNALIGNED_INT_ASM_OP}
6699 or @samp{OBJECT_FORMAT_ELF}), GCC will provide a default definition of
6702 If this macro is defined to 1, the DWARF 2 unwinder will be the default
6703 exception handling mechanism; otherwise, setjmp/longjmp will be used by
6704 default.
6706 If this macro is defined to anything, the DWARF 2 unwinder will be used
6707 instead of inline unwinders and __unwind_function in the non-setjmp case.
6709 @findex DWARF_CIE_DATA_ALIGNMENT
6710 @item DWARF_CIE_DATA_ALIGNMENT
6711 This macro need only be defined if the target might save registers in the
6712 function prologue at an offset to the stack pointer that is not aligned to
6713 @code{UNITS_PER_WORD}.  The definition should be the negative minimum
6714 alignment if @code{STACK_GROWS_DOWNWARD} is defined, and the positive
6715 minimum alignment otherwise.  @xref{SDB and DWARF}.  Only applicable if
6716 the target supports DWARF 2 frame unwind information.
6718 @end table
6720 @node Alignment Output
6721 @subsection Assembler Commands for Alignment
6723 @c prevent bad page break with this line
6724 This describes commands for alignment.
6726 @table @code
6727 @findex LABEL_ALIGN_AFTER_BARRIER
6728 @item LABEL_ALIGN_AFTER_BARRIER (@var{label})
6729 The alignment (log base 2) to put in front of @var{label}, which follows
6730 a BARRIER.
6732 This macro need not be defined if you don't want any special alignment
6733 to be done at such a time.  Most machine descriptions do not currently
6734 define the macro.
6736 Unless it's necessary to inspect the @var{label} parameter, it is better
6737 to set the variable @var{align_jumps} in the target's
6738 @code{OVERRIDE_OPTIONS}.  Otherwise, you should try to honour the user's
6739 selection in @var{align_jumps} in a @code{LABEL_ALIGN_AFTER_BARRIER}
6740 implementation.
6742 @findex LABEL_ALIGN_AFTER_BARRIER_MAX_SKIP
6743 @item LABEL_ALIGN_AFTER_BARRIER_MAX_SKIP
6744 The maximum number of bytes to skip when applying 
6745 @code{LABEL_ALIGN_AFTER_BARRIER}.  This works only if
6746 @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.
6748 @findex LOOP_ALIGN
6749 @item LOOP_ALIGN (@var{label})
6750 The alignment (log base 2) to put in front of @var{label}, which follows
6751 a NOTE_INSN_LOOP_BEG note.
6753 This macro need not be defined if you don't want any special alignment
6754 to be done at such a time.  Most machine descriptions do not currently
6755 define the macro.
6757 Unless it's necessary to inspect the @var{label} parameter, it is better
6758 to set the variable @var{align_loops} in the target's
6759 @code{OVERRIDE_OPTIONS}.  Otherwise, you should try to honour the user's
6760 selection in @var{align_loops} in a @code{LOOP_ALIGN} implementation.
6762 @findex LOOP_ALIGN_MAX_SKIP
6763 @item LOOP_ALIGN_MAX_SKIP
6764 The maximum number of bytes to skip when applying @code{LOOP_ALIGN}.
6765 This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.
6767 @findex LABEL_ALIGN
6768 @item LABEL_ALIGN (@var{label})
6769 The alignment (log base 2) to put in front of @var{label}.
6770 If LABEL_ALIGN_AFTER_BARRIER / LOOP_ALIGN specify a different alignment,
6771 the maximum of the specified values is used.
6773 Unless it's necessary to inspect the @var{label} parameter, it is better
6774 to set the variable @var{align_labels} in the target's
6775 @code{OVERRIDE_OPTIONS}.  Otherwise, you should try to honour the user's
6776 selection in @var{align_labels} in a @code{LABEL_ALIGN} implementation.
6778 @findex LABEL_ALIGN_MAX_SKIP
6779 @item LABEL_ALIGN_MAX_SKIP
6780 The maximum number of bytes to skip when applying @code{LABEL_ALIGN}.
6781 This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.
6783 @findex ASM_OUTPUT_SKIP
6784 @item ASM_OUTPUT_SKIP (@var{stream}, @var{nbytes})
6785 A C statement to output to the stdio stream @var{stream} an assembler
6786 instruction to advance the location counter by @var{nbytes} bytes.
6787 Those bytes should be zero when loaded.  @var{nbytes} will be a C
6788 expression of type @code{int}.
6790 @findex ASM_NO_SKIP_IN_TEXT
6791 @item ASM_NO_SKIP_IN_TEXT
6792 Define this macro if @code{ASM_OUTPUT_SKIP} should not be used in the
6793 text section because it fails to put zeros in the bytes that are skipped.
6794 This is true on many Unix systems, where the pseudo--op to skip bytes
6795 produces no-op instructions rather than zeros when used in the text
6796 section.
6798 @findex ASM_OUTPUT_ALIGN
6799 @item ASM_OUTPUT_ALIGN (@var{stream}, @var{power})
6800 A C statement to output to the stdio stream @var{stream} an assembler
6801 command to advance the location counter to a multiple of 2 to the
6802 @var{power} bytes.  @var{power} will be a C expression of type @code{int}.
6804 @findex ASM_OUTPUT_MAX_SKIP_ALIGN
6805 @item ASM_OUTPUT_MAX_SKIP_ALIGN (@var{stream}, @var{power}, @var{max_skip})
6806 A C statement to output to the stdio stream @var{stream} an assembler
6807 command to advance the location counter to a multiple of 2 to the
6808 @var{power} bytes, but only if @var{max_skip} or fewer bytes are needed to
6809 satisfy the alignment request.  @var{power} and @var{max_skip} will be
6810 a C expression of type @code{int}.
6811 @end table
6813 @need 3000
6814 @node Debugging Info
6815 @section Controlling Debugging Information Format
6817 @c prevent bad page break with this line
6818 This describes how to specify debugging information.
6820 @menu
6821 * All Debuggers::      Macros that affect all debugging formats uniformly.
6822 * DBX Options::        Macros enabling specific options in DBX format.
6823 * DBX Hooks::          Hook macros for varying DBX format.
6824 * File Names and DBX:: Macros controlling output of file names in DBX format.
6825 * SDB and DWARF::      Macros for SDB (COFF) and DWARF formats.
6826 @end menu
6828 @node All Debuggers
6829 @subsection Macros Affecting All Debugging Formats
6831 @c prevent bad page break with this line
6832 These macros affect all debugging formats.
6834 @table @code
6835 @findex DBX_REGISTER_NUMBER
6836 @item DBX_REGISTER_NUMBER (@var{regno})
6837 A C expression that returns the DBX register number for the compiler
6838 register number @var{regno}.  In simple cases, the value of this
6839 expression may be @var{regno} itself.  But sometimes there are some
6840 registers that the compiler knows about and DBX does not, or vice
6841 versa.  In such cases, some register may need to have one number in
6842 the compiler and another for DBX.
6844 If two registers have consecutive numbers inside GCC, and they can be
6845 used as a pair to hold a multiword value, then they @emph{must} have
6846 consecutive numbers after renumbering with @code{DBX_REGISTER_NUMBER}.
6847 Otherwise, debuggers will be unable to access such a pair, because they
6848 expect register pairs to be consecutive in their own numbering scheme.
6850 If you find yourself defining @code{DBX_REGISTER_NUMBER} in way that
6851 does not preserve register pairs, then what you must do instead is
6852 redefine the actual register numbering scheme.
6854 @findex DEBUGGER_AUTO_OFFSET
6855 @item DEBUGGER_AUTO_OFFSET (@var{x})
6856 A C expression that returns the integer offset value for an automatic
6857 variable having address @var{x} (an RTL expression).  The default
6858 computation assumes that @var{x} is based on the frame-pointer and
6859 gives the offset from the frame-pointer.  This is required for targets
6860 that produce debugging output for DBX or COFF-style debugging output
6861 for SDB and allow the frame-pointer to be eliminated when the
6862 @samp{-g} options is used.
6864 @findex DEBUGGER_ARG_OFFSET
6865 @item DEBUGGER_ARG_OFFSET (@var{offset}, @var{x})
6866 A C expression that returns the integer offset value for an argument
6867 having address @var{x} (an RTL expression).  The nominal offset is
6868 @var{offset}.
6870 @findex PREFERRED_DEBUGGING_TYPE
6871 @item PREFERRED_DEBUGGING_TYPE
6872 A C expression that returns the type of debugging output GCC should
6873 produce when the user specifies just @samp{-g}.  Define
6874 this if you have arranged for GCC to support more than one format of
6875 debugging output.  Currently, the allowable values are @code{DBX_DEBUG},
6876 @code{SDB_DEBUG}, @code{DWARF_DEBUG}, @code{DWARF2_DEBUG}, and
6877 @code{XCOFF_DEBUG}.
6879 When the user specifies @samp{-ggdb}, GCC normally also uses the
6880 value of this macro to select the debugging output format, but with two
6881 exceptions.  If @code{DWARF2_DEBUGGING_INFO} is defined and
6882 @code{LINKER_DOES_NOT_WORK_WITH_DWARF2} is not defined, GCC uses the
6883 value @code{DWARF2_DEBUG}.  Otherwise, if @code{DBX_DEBUGGING_INFO} is
6884 defined, GCC uses @code{DBX_DEBUG}.
6886 The value of this macro only affects the default debugging output; the
6887 user can always get a specific type of output by using @samp{-gstabs},
6888 @samp{-gcoff}, @samp{-gdwarf-1}, @samp{-gdwarf-2}, or @samp{-gxcoff}.
6889 @end table
6891 @node DBX Options
6892 @subsection Specific Options for DBX Output
6894 @c prevent bad page break with this line
6895 These are specific options for DBX output.
6897 @table @code
6898 @findex DBX_DEBUGGING_INFO
6899 @item DBX_DEBUGGING_INFO
6900 Define this macro if GCC should produce debugging output for DBX
6901 in response to the @samp{-g} option.
6903 @findex XCOFF_DEBUGGING_INFO
6904 @item XCOFF_DEBUGGING_INFO
6905 Define this macro if GCC should produce XCOFF format debugging output
6906 in response to the @samp{-g} option.  This is a variant of DBX format.
6908 @findex DEFAULT_GDB_EXTENSIONS
6909 @item DEFAULT_GDB_EXTENSIONS
6910 Define this macro to control whether GCC should by default generate
6911 GDB's extended version of DBX debugging information (assuming DBX-format
6912 debugging information is enabled at all).  If you don't define the
6913 macro, the default is 1: always generate the extended information
6914 if there is any occasion to.
6916 @findex DEBUG_SYMS_TEXT
6917 @item DEBUG_SYMS_TEXT
6918 Define this macro if all @code{.stabs} commands should be output while
6919 in the text section.
6921 @findex ASM_STABS_OP
6922 @item ASM_STABS_OP
6923 A C string constant, including spacing, naming the assembler pseudo op to
6924 use instead of @code{"\t.stabs\t"} to define an ordinary debugging symbol.
6925 If you don't define this macro, @code{"\t.stabs\t"} is used.  This macro
6926 applies only to DBX debugging information format.
6928 @findex ASM_STABD_OP
6929 @item ASM_STABD_OP
6930 A C string constant, including spacing, naming the assembler pseudo op to
6931 use instead of @code{"\t.stabd\t"} to define a debugging symbol whose
6932 value is the current location.  If you don't define this macro,
6933 @code{"\t.stabd\t"} is used.  This macro applies only to DBX debugging
6934 information format.
6936 @findex ASM_STABN_OP
6937 @item ASM_STABN_OP
6938 A C string constant, including spacing, naming the assembler pseudo op to
6939 use instead of @code{"\t.stabn\t"} to define a debugging symbol with no
6940 name.  If you don't define this macro, @code{"\t.stabn\t"} is used.  This
6941 macro applies only to DBX debugging information format.
6943 @findex DBX_NO_XREFS
6944 @item DBX_NO_XREFS
6945 Define this macro if DBX on your system does not support the construct
6946 @samp{xs@var{tagname}}.  On some systems, this construct is used to
6947 describe a forward reference to a structure named @var{tagname}.
6948 On other systems, this construct is not supported at all.
6950 @findex DBX_CONTIN_LENGTH
6951 @item DBX_CONTIN_LENGTH
6952 A symbol name in DBX-format debugging information is normally
6953 continued (split into two separate @code{.stabs} directives) when it
6954 exceeds a certain length (by default, 80 characters).  On some
6955 operating systems, DBX requires this splitting; on others, splitting
6956 must not be done.  You can inhibit splitting by defining this macro
6957 with the value zero.  You can override the default splitting-length by
6958 defining this macro as an expression for the length you desire.
6960 @findex DBX_CONTIN_CHAR
6961 @item DBX_CONTIN_CHAR
6962 Normally continuation is indicated by adding a @samp{\} character to
6963 the end of a @code{.stabs} string when a continuation follows.  To use
6964 a different character instead, define this macro as a character
6965 constant for the character you want to use.  Do not define this macro
6966 if backslash is correct for your system.
6968 @findex DBX_STATIC_STAB_DATA_SECTION
6969 @item DBX_STATIC_STAB_DATA_SECTION
6970 Define this macro if it is necessary to go to the data section before
6971 outputting the @samp{.stabs} pseudo-op for a non-global static
6972 variable.
6974 @findex DBX_TYPE_DECL_STABS_CODE
6975 @item DBX_TYPE_DECL_STABS_CODE
6976 The value to use in the ``code'' field of the @code{.stabs} directive
6977 for a typedef.  The default is @code{N_LSYM}.
6979 @findex DBX_STATIC_CONST_VAR_CODE
6980 @item DBX_STATIC_CONST_VAR_CODE
6981 The value to use in the ``code'' field of the @code{.stabs} directive
6982 for a static variable located in the text section.  DBX format does not
6983 provide any ``right'' way to do this.  The default is @code{N_FUN}.
6985 @findex DBX_REGPARM_STABS_CODE
6986 @item DBX_REGPARM_STABS_CODE
6987 The value to use in the ``code'' field of the @code{.stabs} directive
6988 for a parameter passed in registers.  DBX format does not provide any
6989 ``right'' way to do this.  The default is @code{N_RSYM}.
6991 @findex DBX_REGPARM_STABS_LETTER
6992 @item DBX_REGPARM_STABS_LETTER
6993 The letter to use in DBX symbol data to identify a symbol as a parameter
6994 passed in registers.  DBX format does not customarily provide any way to
6995 do this.  The default is @code{'P'}.
6997 @findex DBX_MEMPARM_STABS_LETTER
6998 @item DBX_MEMPARM_STABS_LETTER
6999 The letter to use in DBX symbol data to identify a symbol as a stack
7000 parameter.  The default is @code{'p'}.
7002 @findex DBX_FUNCTION_FIRST
7003 @item DBX_FUNCTION_FIRST
7004 Define this macro if the DBX information for a function and its
7005 arguments should precede the assembler code for the function.  Normally,
7006 in DBX format, the debugging information entirely follows the assembler
7007 code.
7009 @findex DBX_LBRAC_FIRST
7010 @item DBX_LBRAC_FIRST
7011 Define this macro if the @code{N_LBRAC} symbol for a block should
7012 precede the debugging information for variables and functions defined in
7013 that block.  Normally, in DBX format, the @code{N_LBRAC} symbol comes
7014 first.
7016 @findex DBX_BLOCKS_FUNCTION_RELATIVE
7017 @item DBX_BLOCKS_FUNCTION_RELATIVE
7018 Define this macro if the value of a symbol describing the scope of a
7019 block (@code{N_LBRAC} or @code{N_RBRAC}) should be relative to the start
7020 of the enclosing function.  Normally, GNU C uses an absolute address.
7022 @findex DBX_USE_BINCL
7023 @item DBX_USE_BINCL
7024 Define this macro if GNU C should generate @code{N_BINCL} and
7025 @code{N_EINCL} stabs for included header files, as on Sun systems.  This
7026 macro also directs GNU C to output a type number as a pair of a file
7027 number and a type number within the file.  Normally, GNU C does not
7028 generate @code{N_BINCL} or @code{N_EINCL} stabs, and it outputs a single
7029 number for a type number.
7030 @end table
7032 @node DBX Hooks
7033 @subsection Open-Ended Hooks for DBX Format
7035 @c prevent bad page break with this line
7036 These are hooks for DBX format.
7038 @table @code
7039 @findex DBX_OUTPUT_LBRAC
7040 @item DBX_OUTPUT_LBRAC (@var{stream}, @var{name})
7041 Define this macro to say how to output to @var{stream} the debugging
7042 information for the start of a scope level for variable names.  The
7043 argument @var{name} is the name of an assembler symbol (for use with
7044 @code{assemble_name}) whose value is the address where the scope begins.
7046 @findex DBX_OUTPUT_RBRAC
7047 @item DBX_OUTPUT_RBRAC (@var{stream}, @var{name})
7048 Like @code{DBX_OUTPUT_LBRAC}, but for the end of a scope level.
7050 @findex DBX_OUTPUT_ENUM
7051 @item DBX_OUTPUT_ENUM (@var{stream}, @var{type})
7052 Define this macro if the target machine requires special handling to
7053 output an enumeration type.  The definition should be a C statement
7054 (sans semicolon) to output the appropriate information to @var{stream}
7055 for the type @var{type}.
7057 @findex DBX_OUTPUT_FUNCTION_END
7058 @item DBX_OUTPUT_FUNCTION_END (@var{stream}, @var{function})
7059 Define this macro if the target machine requires special output at the
7060 end of the debugging information for a function.  The definition should
7061 be a C statement (sans semicolon) to output the appropriate information
7062 to @var{stream}.  @var{function} is the @code{FUNCTION_DECL} node for
7063 the function.
7065 @findex DBX_OUTPUT_STANDARD_TYPES
7066 @item DBX_OUTPUT_STANDARD_TYPES (@var{syms})
7067 Define this macro if you need to control the order of output of the
7068 standard data types at the beginning of compilation.  The argument
7069 @var{syms} is a @code{tree} which is a chain of all the predefined
7070 global symbols, including names of data types.
7072 Normally, DBX output starts with definitions of the types for integers
7073 and characters, followed by all the other predefined types of the
7074 particular language in no particular order.
7076 On some machines, it is necessary to output different particular types
7077 first.  To do this, define @code{DBX_OUTPUT_STANDARD_TYPES} to output
7078 those symbols in the necessary order.  Any predefined types that you
7079 don't explicitly output will be output afterward in no particular order.
7081 Be careful not to define this macro so that it works only for C.  There
7082 are no global variables to access most of the built-in types, because
7083 another language may have another set of types.  The way to output a
7084 particular type is to look through @var{syms} to see if you can find it.
7085 Here is an example:
7087 @smallexample
7089   tree decl;
7090   for (decl = syms; decl; decl = TREE_CHAIN (decl))
7091     if (!strcmp (IDENTIFIER_POINTER (DECL_NAME (decl)),
7092                  "long int"))
7093       dbxout_symbol (decl);
7094   @dots{}
7096 @end smallexample
7098 @noindent
7099 This does nothing if the expected type does not exist.
7101 See the function @code{init_decl_processing} in @file{c-decl.c} to find
7102 the names to use for all the built-in C types.
7104 Here is another way of finding a particular type:
7106 @c this is still overfull.  --mew 10feb93
7107 @smallexample
7109   tree decl;
7110   for (decl = syms; decl; decl = TREE_CHAIN (decl))
7111     if (TREE_CODE (decl) == TYPE_DECL
7112         && (TREE_CODE (TREE_TYPE (decl))
7113             == INTEGER_CST)
7114         && TYPE_PRECISION (TREE_TYPE (decl)) == 16
7115         && TYPE_UNSIGNED (TREE_TYPE (decl)))
7116 @group
7117       /* @r{This must be @code{unsigned short}.}  */
7118       dbxout_symbol (decl);
7119   @dots{}
7121 @end group
7122 @end smallexample
7124 @findex NO_DBX_FUNCTION_END
7125 @item NO_DBX_FUNCTION_END
7126 Some stabs encapsulation formats (in particular ECOFF), cannot handle the
7127 @code{.stabs "",N_FUN,,0,0,Lscope-function-1} gdb dbx extention construct.
7128 On those machines, define this macro to turn this feature off without
7129 disturbing the rest of the gdb extensions.
7131 @end table
7133 @node File Names and DBX
7134 @subsection File Names in DBX Format
7136 @c prevent bad page break with this line
7137 This describes file names in DBX format.
7139 @table @code
7140 @findex DBX_WORKING_DIRECTORY
7141 @item DBX_WORKING_DIRECTORY
7142 Define this if DBX wants to have the current directory recorded in each
7143 object file.
7145 Note that the working directory is always recorded if GDB extensions are
7146 enabled.
7148 @findex DBX_OUTPUT_MAIN_SOURCE_FILENAME
7149 @item DBX_OUTPUT_MAIN_SOURCE_FILENAME (@var{stream}, @var{name})
7150 A C statement to output DBX debugging information to the stdio stream
7151 @var{stream} which indicates that file @var{name} is the main source
7152 file---the file specified as the input file for compilation.
7153 This macro is called only once, at the beginning of compilation.
7155 This macro need not be defined if the standard form of output
7156 for DBX debugging information is appropriate.
7158 @findex DBX_OUTPUT_MAIN_SOURCE_DIRECTORY
7159 @item DBX_OUTPUT_MAIN_SOURCE_DIRECTORY (@var{stream}, @var{name})
7160 A C statement to output DBX debugging information to the stdio stream
7161 @var{stream} which indicates that the current directory during
7162 compilation is named @var{name}.
7164 This macro need not be defined if the standard form of output
7165 for DBX debugging information is appropriate.
7167 @findex DBX_OUTPUT_MAIN_SOURCE_FILE_END
7168 @item DBX_OUTPUT_MAIN_SOURCE_FILE_END (@var{stream}, @var{name})
7169 A C statement to output DBX debugging information at the end of
7170 compilation of the main source file @var{name}.
7172 If you don't define this macro, nothing special is output at the end
7173 of compilation, which is correct for most machines.
7175 @findex DBX_OUTPUT_SOURCE_FILENAME
7176 @item DBX_OUTPUT_SOURCE_FILENAME (@var{stream}, @var{name})
7177 A C statement to output DBX debugging information to the stdio stream
7178 @var{stream} which indicates that file @var{name} is the current source
7179 file.  This output is generated each time input shifts to a different
7180 source file as a result of @samp{#include}, the end of an included file,
7181 or a @samp{#line} command.
7183 This macro need not be defined if the standard form of output
7184 for DBX debugging information is appropriate.
7185 @end table
7187 @need 2000
7188 @node SDB and DWARF
7189 @subsection Macros for SDB and DWARF Output
7191 @c prevent bad page break with this line
7192 Here are macros for SDB and DWARF output.
7194 @table @code
7195 @findex SDB_DEBUGGING_INFO
7196 @item SDB_DEBUGGING_INFO
7197 Define this macro if GCC should produce COFF-style debugging output
7198 for SDB in response to the @samp{-g} option.
7200 @findex DWARF_DEBUGGING_INFO
7201 @item DWARF_DEBUGGING_INFO
7202 Define this macro if GCC should produce dwarf format debugging output
7203 in response to the @samp{-g} option.
7205 @findex DWARF2_DEBUGGING_INFO
7206 @item DWARF2_DEBUGGING_INFO
7207 Define this macro if GCC should produce dwarf version 2 format
7208 debugging output in response to the @samp{-g} option.
7210 To support optional call frame debugging information, you must also
7211 define @code{INCOMING_RETURN_ADDR_RTX} and either set
7212 @code{RTX_FRAME_RELATED_P} on the prologue insns if you use RTL for the
7213 prologue, or call @code{dwarf2out_def_cfa} and @code{dwarf2out_reg_save}
7214 as appropriate from @code{FUNCTION_PROLOGUE} if you don't.
7216 @findex DWARF2_FRAME_INFO
7217 @item DWARF2_FRAME_INFO
7218 Define this macro to a nonzero value if GCC should always output
7219 Dwarf 2 frame information.  If @code{DWARF2_UNWIND_INFO}
7220 (@pxref{Exception Region Output} is nonzero, GCC will output this
7221 information not matter how you define @code{DWARF2_FRAME_INFO}.
7223 @findex LINKER_DOES_NOT_WORK_WITH_DWARF2
7224 @item LINKER_DOES_NOT_WORK_WITH_DWARF2
7225 Define this macro if the linker does not work with Dwarf version 2.
7226 Normally, if the user specifies only @samp{-ggdb} GCC will use Dwarf
7227 version 2 if available; this macro disables this.  See the description
7228 of the @code{PREFERRED_DEBUGGING_TYPE} macro for more details.
7230 @findex DWARF2_GENERATE_TEXT_SECTION_LABEL
7231 @item DWARF2_GENERATE_TEXT_SECTION_LABEL
7232 By default, the Dwarf 2 debugging information generator will generate a
7233 label to mark the beginning of the text section.  If it is better simply
7234 to use the name of the text section itself, rather than an explicit label,
7235 to indicate the beginning of the text section, define this macro to zero.
7237 @findex DWARF2_ASM_LINE_DEBUG_INFO
7238 @item DWARF2_ASM_LINE_DEBUG_INFO
7239 Define this macro to be a nonzero value if the assembler can generate Dwarf 2
7240 line debug info sections.  This will result in much more compact line number
7241 tables, and hence is desirable if it works.
7243 @findex PUT_SDB_@dots{}
7244 @item PUT_SDB_@dots{}
7245 Define these macros to override the assembler syntax for the special
7246 SDB assembler directives.  See @file{sdbout.c} for a list of these
7247 macros and their arguments.  If the standard syntax is used, you need
7248 not define them yourself.
7250 @findex SDB_DELIM
7251 @item SDB_DELIM
7252 Some assemblers do not support a semicolon as a delimiter, even between
7253 SDB assembler directives.  In that case, define this macro to be the
7254 delimiter to use (usually @samp{\n}).  It is not necessary to define
7255 a new set of @code{PUT_SDB_@var{op}} macros if this is the only change
7256 required.
7258 @findex SDB_GENERATE_FAKE
7259 @item SDB_GENERATE_FAKE
7260 Define this macro to override the usual method of constructing a dummy
7261 name for anonymous structure and union types.  See @file{sdbout.c} for
7262 more information.
7264 @findex SDB_ALLOW_UNKNOWN_REFERENCES
7265 @item SDB_ALLOW_UNKNOWN_REFERENCES
7266 Define this macro to allow references to unknown structure,
7267 union, or enumeration tags to be emitted.  Standard COFF does not
7268 allow handling of unknown references, MIPS ECOFF has support for
7271 @findex SDB_ALLOW_FORWARD_REFERENCES
7272 @item SDB_ALLOW_FORWARD_REFERENCES
7273 Define this macro to allow references to structure, union, or
7274 enumeration tags that have not yet been seen to be handled.  Some
7275 assemblers choke if forward tags are used, while some require it.
7276 @end table
7278 @node Cross-compilation
7279 @section Cross Compilation and Floating Point
7280 @cindex cross compilation and floating point
7281 @cindex floating point and cross compilation
7283 While all modern machines use 2's complement representation for integers,
7284 there are a variety of representations for floating point numbers.  This
7285 means that in a cross-compiler the representation of floating point numbers
7286 in the compiled program may be different from that used in the machine
7287 doing the compilation.
7289 @findex atof
7290 Because different representation systems may offer different amounts of
7291 range and precision, the cross compiler cannot safely use the host
7292 machine's floating point arithmetic.  Therefore, floating point constants
7293 must be represented in the target machine's format.  This means that the
7294 cross compiler cannot use @code{atof} to parse a floating point constant;
7295 it must have its own special routine to use instead.  Also, constant
7296 folding must emulate the target machine's arithmetic (or must not be done
7297 at all).
7299 The macros in the following table should be defined only if you are cross
7300 compiling between different floating point formats.
7302 Otherwise, don't define them.  Then default definitions will be set up which
7303 use @code{double} as the data type, @code{==} to test for equality, etc.
7305 You don't need to worry about how many times you use an operand of any
7306 of these macros.  The compiler never uses operands which have side effects.
7308 @table @code
7309 @findex REAL_VALUE_TYPE
7310 @item REAL_VALUE_TYPE
7311 A macro for the C data type to be used to hold a floating point value
7312 in the target machine's format.  Typically this would be a
7313 @code{struct} containing an array of @code{int}.
7315 @findex REAL_VALUES_EQUAL
7316 @item REAL_VALUES_EQUAL (@var{x}, @var{y})
7317 A macro for a C expression which compares for equality the two values,
7318 @var{x} and @var{y}, both of type @code{REAL_VALUE_TYPE}.
7320 @findex REAL_VALUES_LESS
7321 @item REAL_VALUES_LESS (@var{x}, @var{y})
7322 A macro for a C expression which tests whether @var{x} is less than
7323 @var{y}, both values being of type @code{REAL_VALUE_TYPE} and
7324 interpreted as floating point numbers in the target machine's
7325 representation.
7327 @findex REAL_VALUE_LDEXP
7328 @findex ldexp
7329 @item REAL_VALUE_LDEXP (@var{x}, @var{scale})
7330 A macro for a C expression which performs the standard library
7331 function @code{ldexp}, but using the target machine's floating point
7332 representation.  Both @var{x} and the value of the expression have
7333 type @code{REAL_VALUE_TYPE}.  The second argument, @var{scale}, is an
7334 integer.
7336 @findex REAL_VALUE_FIX
7337 @item REAL_VALUE_FIX (@var{x})
7338 A macro whose definition is a C expression to convert the target-machine
7339 floating point value @var{x} to a signed integer.  @var{x} has type
7340 @code{REAL_VALUE_TYPE}.
7342 @findex REAL_VALUE_UNSIGNED_FIX
7343 @item REAL_VALUE_UNSIGNED_FIX (@var{x})
7344 A macro whose definition is a C expression to convert the target-machine
7345 floating point value @var{x} to an unsigned integer.  @var{x} has type
7346 @code{REAL_VALUE_TYPE}.
7348 @findex REAL_VALUE_RNDZINT
7349 @item REAL_VALUE_RNDZINT (@var{x})
7350 A macro whose definition is a C expression to round the target-machine
7351 floating point value @var{x} towards zero to an integer value (but still
7352 as a floating point number).  @var{x} has type @code{REAL_VALUE_TYPE},
7353 and so does the value.
7355 @findex REAL_VALUE_UNSIGNED_RNDZINT
7356 @item REAL_VALUE_UNSIGNED_RNDZINT (@var{x})
7357 A macro whose definition is a C expression to round the target-machine
7358 floating point value @var{x} towards zero to an unsigned integer value
7359 (but still represented as a floating point number).  @var{x} has type
7360 @code{REAL_VALUE_TYPE}, and so does the value.
7362 @findex REAL_VALUE_ATOF
7363 @item REAL_VALUE_ATOF (@var{string}, @var{mode})
7364 A macro for a C expression which converts @var{string}, an expression of
7365 type @code{char *}, into a floating point number in the target machine's
7366 representation for mode @var{mode}.  The value has type
7367 @code{REAL_VALUE_TYPE}.
7369 @findex REAL_INFINITY
7370 @item REAL_INFINITY
7371 Define this macro if infinity is a possible floating point value, and
7372 therefore division by 0 is legitimate.
7374 @findex REAL_VALUE_ISINF
7375 @findex isinf
7376 @item REAL_VALUE_ISINF (@var{x})
7377 A macro for a C expression which determines whether @var{x}, a floating
7378 point value, is infinity.  The value has type @code{int}.
7379 By default, this is defined to call @code{isinf}.
7381 @findex REAL_VALUE_ISNAN
7382 @findex isnan
7383 @item REAL_VALUE_ISNAN (@var{x})
7384 A macro for a C expression which determines whether @var{x}, a floating
7385 point value, is a ``nan'' (not-a-number).  The value has type
7386 @code{int}.  By default, this is defined to call @code{isnan}.
7387 @end table
7389 @cindex constant folding and floating point
7390 Define the following additional macros if you want to make floating
7391 point constant folding work while cross compiling.  If you don't
7392 define them, cross compilation is still possible, but constant folding
7393 will not happen for floating point values.
7395 @table @code
7396 @findex REAL_ARITHMETIC
7397 @item REAL_ARITHMETIC (@var{output}, @var{code}, @var{x}, @var{y})
7398 A macro for a C statement which calculates an arithmetic operation of
7399 the two floating point values @var{x} and @var{y}, both of type
7400 @code{REAL_VALUE_TYPE} in the target machine's representation, to
7401 produce a result of the same type and representation which is stored
7402 in @var{output} (which will be a variable).
7404 The operation to be performed is specified by @var{code}, a tree code
7405 which will always be one of the following: @code{PLUS_EXPR},
7406 @code{MINUS_EXPR}, @code{MULT_EXPR}, @code{RDIV_EXPR},
7407 @code{MAX_EXPR}, @code{MIN_EXPR}.@refill
7409 @cindex overflow while constant folding
7410 The expansion of this macro is responsible for checking for overflow.
7411 If overflow happens, the macro expansion should execute the statement
7412 @code{return 0;}, which indicates the inability to perform the
7413 arithmetic operation requested.
7415 @findex REAL_VALUE_NEGATE
7416 @item REAL_VALUE_NEGATE (@var{x})
7417 A macro for a C expression which returns the negative of the floating
7418 point value @var{x}.  Both @var{x} and the value of the expression
7419 have type @code{REAL_VALUE_TYPE} and are in the target machine's
7420 floating point representation.
7422 There is no way for this macro to report overflow, since overflow
7423 can't happen in the negation operation.
7425 @findex REAL_VALUE_TRUNCATE
7426 @item REAL_VALUE_TRUNCATE (@var{mode}, @var{x})
7427 A macro for a C expression which converts the floating point value
7428 @var{x} to mode @var{mode}.
7430 Both @var{x} and the value of the expression are in the target machine's
7431 floating point representation and have type @code{REAL_VALUE_TYPE}.
7432 However, the value should have an appropriate bit pattern to be output
7433 properly as a floating constant whose precision accords with mode
7434 @var{mode}.
7436 There is no way for this macro to report overflow.
7438 @findex REAL_VALUE_TO_INT
7439 @item REAL_VALUE_TO_INT (@var{low}, @var{high}, @var{x})
7440 A macro for a C expression which converts a floating point value
7441 @var{x} into a double-precision integer which is then stored into
7442 @var{low} and @var{high}, two variables of type @var{int}.
7444 @item REAL_VALUE_FROM_INT (@var{x}, @var{low}, @var{high}, @var{mode})
7445 @findex REAL_VALUE_FROM_INT
7446 A macro for a C expression which converts a double-precision integer
7447 found in @var{low} and @var{high}, two variables of type @var{int},
7448 into a floating point value which is then stored into @var{x}.
7449 The value is in the target machine's representation for mode @var{mode}
7450 and has the type @code{REAL_VALUE_TYPE}.
7451 @end table
7453 @node Mode Switching
7454 @section Mode Switching Instructions
7455 @cindex mode switching
7456 The following macros control mode switching optimizations:
7458 @table @code
7459 @findex OPTIMIZE_MODE_SWITCHING
7460 @item OPTIMIZE_MODE_SWITCHING (@var{entity})
7461 Define this macro if the port needs extra instructions inserted for mode
7462 switching in an optimizing compilation.
7464 For an example, the SH4 can perform both single and double precision
7465 floating point operations, but to perform a single precision operation,
7466 the FPSCR PR bit has to be cleared, while for a double precision
7467 operation, this bit has to be set.  Changing the PR bit requires a general
7468 purpose register as a scratch register, hence these FPSCR sets have to
7469 be inserted before reload, i.e. you can't put this into instruction emitting
7470 or MACHINE_DEPENDENT_REORG.
7472 You can have multiple entities that are mode-switched, and select at run time
7473 which entities actually need it.  @code{OPTIMIZE_MODE_SWITCHING} should
7474 return non-zero for any @var{entity} that that needs mode-switching.
7475 If you define this macro, you also have to define
7476 @code{NUM_MODES_FOR_MODE_SWITCHING}, @code{MODE_NEEDED},
7477 @code{MODE_PRIORITY_TO_MODE} and @code{EMIT_MODE_SET}.
7478 @code{NORMAL_MODE} is optional.
7480 @findex NUM_MODES_FOR_MODE_SWITCHING
7481 @item NUM_MODES_FOR_MODE_SWITCHING
7482 If you define @code{OPTIMIZE_MODE_SWITCHING}, you have to define this as
7483 initializer for an array of integers.  Each initializer element
7484 N refers to an entity that needs mode switching, and specifies the number
7485 of different modes that might need to be set for this entity.
7486 The position of the initializer in the initializer - starting counting at
7487 zero - determines the integer that is used to refer to the mode-switched
7488 entity in question.
7489 In macros that take mode arguments / yield a mode result, modes are
7490 represented as numbers 0 .. N - 1.  N is used to specify that no mode
7491 switch is needed / supplied.
7493 @findex MODE_NEEDED
7494 @item MODE_NEEDED (@var{entity}, @var{insn})
7495 @var{entity} is an integer specifying a mode-switched entity.  If
7496 @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro to
7497 return an integer value not larger than the corresponding element in
7498 NUM_MODES_FOR_MODE_SWITCHING, to denote the mode that @var{entity} must
7499 be switched into prior to the execution of INSN.
7501 @findex NORMAL_MODE 
7502 @item NORMAL_MODE (@var{entity})
7503 If this macro is defined, it is evaluated for every @var{entity} that needs
7504 mode switching.  It should evaluate to an integer, which is a mode that
7505 @var{entity} is assumed to be switched to at function entry and exit.
7507 @findex MODE_PRIORITY_TO_MODE
7508 @item MODE_PRIORITY_TO_MODE (@var{entity}, @var{n})
7509 This macro specifies the order in which modes for ENTITY are processed.
7510 0 is the highest priority, NUM_MODES_FOR_MODE_SWITCHING[ENTITY] - 1 the
7511 lowest.  The value of the macro should be an integer designating a mode
7512 for ENTITY.  For any fixed @var{entity}, @code{mode_priority_to_mode}
7513 (@var{entity}, @var{n}) shall be a bijection in 0 ..
7514 @code{num_modes_for_mode_switching}[@var{entity}] - 1 .
7516 @findex EMIT_MODE_SET
7517 @item EMIT_MODE_SET (@var{entity}, @var{mode}, @var{hard_regs_live})
7518 Generate one or more insns to set @var{entity} to @var{mode}.
7519 @var{hard_reg_live} is the set of hard registers live at the point where
7520 the insn(s) are to be inserted.
7521 @end table
7523 @node Misc
7524 @section Miscellaneous Parameters
7525 @cindex parameters, miscellaneous
7527 @c prevent bad page break with this line
7528 Here are several miscellaneous parameters.
7530 @table @code
7531 @item PREDICATE_CODES
7532 @findex PREDICATE_CODES
7533 Define this if you have defined special-purpose predicates in the file
7534 @file{@var{machine}.c}.  This macro is called within an initializer of an
7535 array of structures.  The first field in the structure is the name of a
7536 predicate and the second field is an array of rtl codes.  For each
7537 predicate, list all rtl codes that can be in expressions matched by the
7538 predicate.  The list should have a trailing comma.  Here is an example
7539 of two entries in the list for a typical RISC machine:
7541 @smallexample
7542 #define PREDICATE_CODES \
7543   @{"gen_reg_rtx_operand", @{SUBREG, REG@}@},  \
7544   @{"reg_or_short_cint_operand", @{SUBREG, REG, CONST_INT@}@},
7545 @end smallexample
7547 Defining this macro does not affect the generated code (however,
7548 incorrect definitions that omit an rtl code that may be matched by the
7549 predicate can cause the compiler to malfunction).  Instead, it allows
7550 the table built by @file{genrecog} to be more compact and efficient,
7551 thus speeding up the compiler.  The most important predicates to include
7552 in the list specified by this macro are those used in the most insn
7553 patterns.
7555 @item SPECIAL_MODE_PREDICATES
7556 @findex SPECIAL_MODE_PREDICATES
7557 Define this if you have special predicates that know special things
7558 about modes.  Genrecog will warn about certain forms of 
7559 @code{match_operand} without a mode; if the operand predicate is
7560 listed in @code{SPECIAL_MODE_PREDICATES}, the warning will be 
7561 suppressed.
7563 Here is an example from the IA-32 port (@code{ext_register_operand}
7564 specially checks for @code{HImode} or @code{SImode} in preparation
7565 for a byte extraction from @code{%ah} etc.).
7567 @smallexample
7568 #define SPECIAL_MODE_PREDICATES \
7569   "ext_register_operand",
7570 @end smallexample
7572 @findex CASE_VECTOR_MODE
7573 @item CASE_VECTOR_MODE
7574 An alias for a machine mode name.  This is the machine mode that
7575 elements of a jump-table should have.
7577 @findex CASE_VECTOR_SHORTEN_MODE
7578 @item CASE_VECTOR_SHORTEN_MODE (@var{min_offset}, @var{max_offset}, @var{body})
7579 Optional: return the preferred mode for an @code{addr_diff_vec}
7580 when the minimum and maximum offset are known.  If you define this,
7581 it enables extra code in branch shortening to deal with @code{addr_diff_vec}.
7582 To make this work, you also have to define INSN_ALIGN and 
7583 make the alignment for @code{addr_diff_vec} explicit.
7584 The @var{body} argument is provided so that the offset_unsigned and scale
7585 flags can be updated.
7587 @findex CASE_VECTOR_PC_RELATIVE
7588 @item CASE_VECTOR_PC_RELATIVE
7589 Define this macro to be a C expression to indicate when jump-tables
7590 should contain relative addresses.  If jump-tables never contain
7591 relative addresses, then you need not define this macro.
7593 @findex CASE_DROPS_THROUGH
7594 @item CASE_DROPS_THROUGH
7595 Define this if control falls through a @code{case} insn when the index
7596 value is out of range.  This means the specified default-label is
7597 actually ignored by the @code{case} insn proper.
7599 @findex CASE_VALUES_THRESHOLD
7600 @item CASE_VALUES_THRESHOLD
7601 Define this to be the smallest number of different values for which it
7602 is best to use a jump-table instead of a tree of conditional branches.
7603 The default is four for machines with a @code{casesi} instruction and
7604 five otherwise.  This is best for most machines.
7606 @findex WORD_REGISTER_OPERATIONS
7607 @item WORD_REGISTER_OPERATIONS
7608 Define this macro if operations between registers with integral mode
7609 smaller than a word are always performed on the entire register.
7610 Most RISC machines have this property and most CISC machines do not.
7612 @findex LOAD_EXTEND_OP
7613 @item LOAD_EXTEND_OP (@var{mode})
7614 Define this macro to be a C expression indicating when insns that read
7615 memory in @var{mode}, an integral mode narrower than a word, set the
7616 bits outside of @var{mode} to be either the sign-extension or the
7617 zero-extension of the data read.  Return @code{SIGN_EXTEND} for values
7618 of @var{mode} for which the
7619 insn sign-extends, @code{ZERO_EXTEND} for which it zero-extends, and
7620 @code{NIL} for other modes.
7622 This macro is not called with @var{mode} non-integral or with a width
7623 greater than or equal to @code{BITS_PER_WORD}, so you may return any
7624 value in this case.  Do not define this macro if it would always return
7625 @code{NIL}.  On machines where this macro is defined, you will normally
7626 define it as the constant @code{SIGN_EXTEND} or @code{ZERO_EXTEND}.
7628 @findex SHORT_IMMEDIATES_SIGN_EXTEND
7629 @item SHORT_IMMEDIATES_SIGN_EXTEND
7630 Define this macro if loading short immediate values into registers sign
7631 extends.
7633 @findex IMPLICIT_FIX_EXPR
7634 @item IMPLICIT_FIX_EXPR
7635 An alias for a tree code that should be used by default for conversion
7636 of floating point values to fixed point.  Normally,
7637 @code{FIX_ROUND_EXPR} is used.@refill
7639 @findex FIXUNS_TRUNC_LIKE_FIX_TRUNC
7640 @item FIXUNS_TRUNC_LIKE_FIX_TRUNC
7641 Define this macro if the same instructions that convert a floating
7642 point number to a signed fixed point number also convert validly to an
7643 unsigned one.
7645 @findex EASY_DIV_EXPR
7646 @item EASY_DIV_EXPR
7647 An alias for a tree code that is the easiest kind of division to
7648 compile code for in the general case.  It may be
7649 @code{TRUNC_DIV_EXPR}, @code{FLOOR_DIV_EXPR}, @code{CEIL_DIV_EXPR} or
7650 @code{ROUND_DIV_EXPR}.  These four division operators differ in how
7651 they round the result to an integer.  @code{EASY_DIV_EXPR} is used
7652 when it is permissible to use any of those kinds of division and the
7653 choice should be made on the basis of efficiency.@refill
7655 @findex MOVE_MAX
7656 @item MOVE_MAX
7657 The maximum number of bytes that a single instruction can move quickly
7658 between memory and registers or between two memory locations.
7660 @findex MAX_MOVE_MAX
7661 @item MAX_MOVE_MAX
7662 The maximum number of bytes that a single instruction can move quickly
7663 between memory and registers or between two memory locations.  If this
7664 is undefined, the default is @code{MOVE_MAX}.  Otherwise, it is the
7665 constant value that is the largest value that @code{MOVE_MAX} can have
7666 at run-time.
7668 @findex SHIFT_COUNT_TRUNCATED
7669 @item SHIFT_COUNT_TRUNCATED
7670 A C expression that is nonzero if on this machine the number of bits
7671 actually used for the count of a shift operation is equal to the number
7672 of bits needed to represent the size of the object being shifted.  When
7673 this macro is non-zero, the compiler will assume that it is safe to omit
7674 a sign-extend, zero-extend, and certain bitwise `and' instructions that
7675 truncates the count of a shift operation.  On machines that have
7676 instructions that act on bitfields at variable positions, which may
7677 include `bit test' instructions, a nonzero @code{SHIFT_COUNT_TRUNCATED}
7678 also enables deletion of truncations of the values that serve as
7679 arguments to bitfield instructions.
7681 If both types of instructions truncate the count (for shifts) and
7682 position (for bitfield operations), or if no variable-position bitfield
7683 instructions exist, you should define this macro.
7685 However, on some machines, such as the 80386 and the 680x0, truncation
7686 only applies to shift operations and not the (real or pretended)
7687 bitfield operations.  Define @code{SHIFT_COUNT_TRUNCATED} to be zero on
7688 such machines.  Instead, add patterns to the @file{md} file that include
7689 the implied truncation of the shift instructions.
7691 You need not define this macro if it would always have the value of zero.
7693 @findex TRULY_NOOP_TRUNCATION
7694 @item TRULY_NOOP_TRUNCATION (@var{outprec}, @var{inprec})
7695 A C expression which is nonzero if on this machine it is safe to
7696 ``convert'' an integer of @var{inprec} bits to one of @var{outprec}
7697 bits (where @var{outprec} is smaller than @var{inprec}) by merely
7698 operating on it as if it had only @var{outprec} bits.
7700 On many machines, this expression can be 1.
7702 @c rearranged this, removed the phrase "it is reported that".  this was
7703 @c to fix an overfull hbox.  --mew 10feb93
7704 When @code{TRULY_NOOP_TRUNCATION} returns 1 for a pair of sizes for
7705 modes for which @code{MODES_TIEABLE_P} is 0, suboptimal code can result.
7706 If this is the case, making @code{TRULY_NOOP_TRUNCATION} return 0 in
7707 such cases may improve things.
7709 @findex STORE_FLAG_VALUE
7710 @item STORE_FLAG_VALUE
7711 A C expression describing the value returned by a comparison operator
7712 with an integral mode and stored by a store-flag instruction
7713 (@samp{s@var{cond}}) when the condition is true.  This description must
7714 apply to @emph{all} the @samp{s@var{cond}} patterns and all the
7715 comparison operators whose results have a @code{MODE_INT} mode.
7717 A value of 1 or -1 means that the instruction implementing the
7718 comparison operator returns exactly 1 or -1 when the comparison is true
7719 and 0 when the comparison is false.  Otherwise, the value indicates
7720 which bits of the result are guaranteed to be 1 when the comparison is
7721 true.  This value is interpreted in the mode of the comparison
7722 operation, which is given by the mode of the first operand in the
7723 @samp{s@var{cond}} pattern.  Either the low bit or the sign bit of
7724 @code{STORE_FLAG_VALUE} be on.  Presently, only those bits are used by
7725 the compiler.
7727 If @code{STORE_FLAG_VALUE} is neither 1 or -1, the compiler will
7728 generate code that depends only on the specified bits.  It can also
7729 replace comparison operators with equivalent operations if they cause
7730 the required bits to be set, even if the remaining bits are undefined.
7731 For example, on a machine whose comparison operators return an
7732 @code{SImode} value and where @code{STORE_FLAG_VALUE} is defined as
7733 @samp{0x80000000}, saying that just the sign bit is relevant, the
7734 expression
7736 @smallexample
7737 (ne:SI (and:SI @var{x} (const_int @var{power-of-2})) (const_int 0))
7738 @end smallexample
7740 @noindent
7741 can be converted to
7743 @smallexample
7744 (ashift:SI @var{x} (const_int @var{n}))
7745 @end smallexample
7747 @noindent
7748 where @var{n} is the appropriate shift count to move the bit being
7749 tested into the sign bit.
7751 There is no way to describe a machine that always sets the low-order bit
7752 for a true value, but does not guarantee the value of any other bits,
7753 but we do not know of any machine that has such an instruction.  If you
7754 are trying to port GCC to such a machine, include an instruction to
7755 perform a logical-and of the result with 1 in the pattern for the
7756 comparison operators and let us know
7757 @ifset USING
7758 (@pxref{Bug Reporting,,How to Report Bugs}).
7759 @end ifset
7760 @ifclear USING
7761 (@pxref{Bug Reporting,,How to Report Bugs,gcc.info,Using GCC}).
7762 @end ifclear
7764 Often, a machine will have multiple instructions that obtain a value
7765 from a comparison (or the condition codes).  Here are rules to guide the
7766 choice of value for @code{STORE_FLAG_VALUE}, and hence the instructions
7767 to be used:
7769 @itemize @bullet
7770 @item
7771 Use the shortest sequence that yields a valid definition for
7772 @code{STORE_FLAG_VALUE}.  It is more efficient for the compiler to
7773 ``normalize'' the value (convert it to, e.g., 1 or 0) than for the
7774 comparison operators to do so because there may be opportunities to
7775 combine the normalization with other operations.
7777 @item
7778 For equal-length sequences, use a value of 1 or -1, with -1 being
7779 slightly preferred on machines with expensive jumps and 1 preferred on
7780 other machines.
7782 @item
7783 As a second choice, choose a value of @samp{0x80000001} if instructions
7784 exist that set both the sign and low-order bits but do not define the
7785 others.
7787 @item
7788 Otherwise, use a value of @samp{0x80000000}.
7789 @end itemize
7791 Many machines can produce both the value chosen for
7792 @code{STORE_FLAG_VALUE} and its negation in the same number of
7793 instructions.  On those machines, you should also define a pattern for
7794 those cases, e.g., one matching
7796 @smallexample
7797 (set @var{A} (neg:@var{m} (ne:@var{m} @var{B} @var{C})))
7798 @end smallexample
7800 Some machines can also perform @code{and} or @code{plus} operations on
7801 condition code values with less instructions than the corresponding
7802 @samp{s@var{cond}} insn followed by @code{and} or @code{plus}.  On those
7803 machines, define the appropriate patterns.  Use the names @code{incscc}
7804 and @code{decscc}, respectively, for the patterns which perform
7805 @code{plus} or @code{minus} operations on condition code values.  See
7806 @file{rs6000.md} for some examples.  The GNU Superoptizer can be used to
7807 find such instruction sequences on other machines.
7809 You need not define @code{STORE_FLAG_VALUE} if the machine has no store-flag
7810 instructions.
7812 @findex FLOAT_STORE_FLAG_VALUE
7813 @item FLOAT_STORE_FLAG_VALUE (@var{mode})
7814 A C expression that gives a non-zero @code{REAL_VALUE_TYPE} value that is
7815 returned when comparison operators with floating-point results are true.
7816 Define this macro on machine that have comparison operations that return
7817 floating-point values.  If there are no such operations, do not define
7818 this macro.
7820 @findex Pmode
7821 @item Pmode
7822 An alias for the machine mode for pointers.  On most machines, define
7823 this to be the integer mode corresponding to the width of a hardware
7824 pointer; @code{SImode} on 32-bit machine or @code{DImode} on 64-bit machines.
7825 On some machines you must define this to be one of the partial integer
7826 modes, such as @code{PSImode}.
7828 The width of @code{Pmode} must be at least as large as the value of
7829 @code{POINTER_SIZE}.  If it is not equal, you must define the macro
7830 @code{POINTERS_EXTEND_UNSIGNED} to specify how pointers are extended
7831 to @code{Pmode}.
7833 @findex FUNCTION_MODE
7834 @item FUNCTION_MODE
7835 An alias for the machine mode used for memory references to functions
7836 being called, in @code{call} RTL expressions.  On most machines this
7837 should be @code{QImode}.
7839 @findex INTEGRATE_THRESHOLD
7840 @item INTEGRATE_THRESHOLD (@var{decl})
7841 A C expression for the maximum number of instructions above which the
7842 function @var{decl} should not be inlined.  @var{decl} is a
7843 @code{FUNCTION_DECL} node.
7845 The default definition of this macro is 64 plus 8 times the number of
7846 arguments that the function accepts.  Some people think a larger
7847 threshold should be used on RISC machines.
7849 @findex SCCS_DIRECTIVE
7850 @item SCCS_DIRECTIVE
7851 Define this if the preprocessor should ignore @code{#sccs} directives
7852 and print no error message.
7854 @findex NO_IMPLICIT_EXTERN_C
7855 @item NO_IMPLICIT_EXTERN_C
7856 Define this macro if the system header files support C++ as well as C.
7857 This macro inhibits the usual method of using system header files in
7858 C++, which is to pretend that the file's contents are enclosed in
7859 @samp{extern "C" @{@dots{}@}}.
7861 @findex HANDLE_PRAGMA
7862 @item HANDLE_PRAGMA (@var{getc}, @var{ungetc}, @var{name})
7863 This macro is no longer supported.  You must use
7864 @code{REGISTER_TARGET_PRAGMAS} instead.
7866 @findex REGISTER_TARGET_PRAGMAS
7867 @findex #pragma
7868 @findex pragma
7869 @item REGISTER_TARGET_PRAGMAS (@var{pfile})
7870 Define this macro if you want to implement any target-specific pragmas.
7871 If defined, it is a C expression which makes a series of calls to the
7872 @code{cpp_register_pragma} and/or @code{cpp_register_pragma_space}
7873 functions.  The @var{pfile} argument is the first argument to supply to
7874 these functions.  The macro may also do setup required for the pragmas.
7876 The primary reason to define this macro is to provide compatibility with
7877 other compilers for the same target.  In general, we discourage
7878 definition of target-specific pragmas for GCC.
7880 If the pragma can be implemented by attributes then the macro
7881 @samp{INSERT_ATTRIBUTES} might be a useful one to define as well.
7883 Preprocessor macros that appear on pragma lines are not expanded.  All
7884 @samp{#pragma} directives that do not match any registered pragma are
7885 silently ignored, unless the user specifies @samp{-Wunknown-pragmas}.
7887 @deftypefun void cpp_register_pragma (cpp_reader *@var{pfile}, const char *@var{space}, const char *@var{name}, void (*@var{callback}) (cpp_reader *))
7889 Each call to @code{cpp_register_pragma} establishes one pragma.  The
7890 @var{callback} routine will be called when the preprocessor encounters a
7891 pragma of the form
7893 @smallexample
7894 #pragma [@var{space}] @var{name} @dots{}
7895 @end smallexample
7897 @var{space} must have been the subject of a previous call to
7898 @code{cpp_register_pragma_space}, or else be a null pointer.  The
7899 callback routine receives @var{pfile} as its first argument, but must
7900 not use it for anything (this may change in the future).  It may read
7901 any text after the @var{name} by making calls to @code{c_lex}.  Text
7902 which is not read by the callback will be silently ignored.
7904 Note that both @var{space} and @var{name} are case sensitive.
7906 For an example use of this routine, see @file{c4x.h} and the callback
7907 routines defined in @file{c4x.c}.
7909 Note that the use of @code{c_lex} is specific to the C and C++
7910 compilers.  It will not work in the Java or Fortran compilers, or any
7911 other language compilers for that matter.  Thus if @code{c_lex} is going
7912 to be called from target-specific code, it must only be done so when
7913 building hte C and C++ compilers.  This can be done by defining the
7914 variables @code{c_target_objs} and @code{cxx_target_objs} in the
7915 target entry in the @code{config.gcc} file.  These variables should name
7916 the target-specific, language-specific object file which contains the
7917 code that uses @code{c_lex}.  Note it will also be necessary to add a
7918 rule to the makefile fragment pointed to by @code{tmake_file} that shows
7919 how to build this object file.
7920 @end deftypefun
7922 @deftypefun void cpp_register_pragma_space (cpp_reader *@var{pfile}, const char *@var{space})
7923 This routine establishes a namespace for pragmas, which will be
7924 registered by subsequent calls to @code{cpp_register_pragma}.  For
7925 example, pragmas defined by the C standard are in the @samp{STDC}
7926 namespace, and pragmas specific to GCC are in the @samp{GCC} namespace.
7928 For an example use of this routine in a target header, see @file{v850.h}.
7929 @end deftypefun
7931 @findex HANDLE_SYSV_PRAGMA
7932 @findex #pragma
7933 @findex pragma
7934 @item HANDLE_SYSV_PRAGMA
7935 Define this macro (to a value of 1) if you want the System V style
7936 pragmas @samp{#pragma pack(<n>)} and @samp{#pragma weak <name>
7937 [=<value>]} to be supported by gcc.
7939 The pack pragma specifies the maximum alignment (in bytes) of fields
7940 within a structure, in much the same way as the @samp{__aligned__} and
7941 @samp{__packed__} @code{__attribute__}s do.  A pack value of zero resets
7942 the behaviour to the default.
7944 The weak pragma only works if @code{SUPPORTS_WEAK} and
7945 @code{ASM_WEAKEN_LABEL} are defined.  If enabled it allows the creation
7946 of specifically named weak labels, optionally with a value.
7948 @findex HANDLE_PRAGMA_PACK_PUSH_POP
7949 @findex #pragma
7950 @findex pragma
7951 @item HANDLE_PRAGMA_PACK_PUSH_POP
7952 Define this macro (to a value of 1) if you want to support the Win32
7953 style pragmas @samp{#pragma pack(push,<n>)} and @samp{#pragma
7954 pack(pop)}.  The pack(push,<n>) pragma specifies the maximum alignment
7955 (in bytes) of fields within a structure, in much the same way as the
7956 @samp{__aligned__} and @samp{__packed__} @code{__attribute__}s do.  A
7957 pack value of zero resets the behaviour to the default.  Successive
7958 invocations of this pragma cause the previous values to be stacked, so
7959 that invocations of @samp{#pragma pack(pop)} will return to the previous
7960 value.
7962 @findex VALID_MACHINE_DECL_ATTRIBUTE
7963 @item VALID_MACHINE_DECL_ATTRIBUTE (@var{decl}, @var{attributes}, @var{identifier}, @var{args})
7964 If defined, a C expression whose value is nonzero if @var{identifier} with
7965 arguments @var{args} is a valid machine specific attribute for @var{decl}.
7966 The attributes in @var{attributes} have previously been assigned to @var{decl}.
7968 @findex VALID_MACHINE_TYPE_ATTRIBUTE
7969 @item VALID_MACHINE_TYPE_ATTRIBUTE (@var{type}, @var{attributes}, @var{identifier}, @var{args})
7970 If defined, a C expression whose value is nonzero if @var{identifier} with
7971 arguments @var{args} is a valid machine specific attribute for @var{type}.
7972 The attributes in @var{attributes} have previously been assigned to @var{type}.
7974 @findex COMP_TYPE_ATTRIBUTES
7975 @item COMP_TYPE_ATTRIBUTES (@var{type1}, @var{type2})
7976 If defined, a C expression whose value is zero if the attributes on
7977 @var{type1} and @var{type2} are incompatible, one if they are compatible,
7978 and two if they are nearly compatible (which causes a warning to be
7979 generated).
7981 @findex SET_DEFAULT_TYPE_ATTRIBUTES
7982 @item SET_DEFAULT_TYPE_ATTRIBUTES (@var{type})
7983 If defined, a C statement that assigns default attributes to
7984 newly defined @var{type}.
7986 @findex MERGE_MACHINE_TYPE_ATTRIBUTES
7987 @item MERGE_MACHINE_TYPE_ATTRIBUTES (@var{type1}, @var{type2})
7988 Define this macro if the merging of type attributes needs special handling.
7989 If defined, the result is a list of the combined TYPE_ATTRIBUTES of
7990 @var{type1} and @var{type2}.  It is assumed that comptypes has already been
7991 called and returned 1.
7993 @findex MERGE_MACHINE_DECL_ATTRIBUTES
7994 @item MERGE_MACHINE_DECL_ATTRIBUTES (@var{olddecl}, @var{newdecl})
7995 Define this macro if the merging of decl attributes needs special handling.
7996 If defined, the result is a list of the combined DECL_MACHINE_ATTRIBUTES of
7997 @var{olddecl} and @var{newdecl}.  @var{newdecl} is a duplicate declaration
7998 of @var{olddecl}.  Examples of when this is needed are when one attribute
7999 overrides another, or when an attribute is nullified by a subsequent
8000 definition.
8002 @findex INSERT_ATTRIBUTES
8003 @item INSERT_ATTRIBUTES (@var{node}, @var{attr_ptr}, @var{prefix_ptr})
8004 Define this macro if you want to be able to add attributes to a decl
8005 when it is being created.  This is normally useful for backends which
8006 wish to implement a pragma by using the attributes which correspond to
8007 the pragma's effect.  The @var{node} argument is the decl which is being
8008 created.  The @var{attr_ptr} argument is a pointer to the attribute list
8009 for this decl.  The @var{prefix_ptr} is a pointer to the list of
8010 attributes that have appeared after the specifiers and modifiers of the
8011 declaration, but before the declaration proper.
8013 @findex SET_DEFAULT_DECL_ATTRIBUTES
8014 @item SET_DEFAULT_DECL_ATTRIBUTES (@var{decl}, @var{attributes})
8015 If defined, a C statement that assigns default attributes to
8016 newly defined @var{decl}.
8018 @findex DOLLARS_IN_IDENTIFIERS
8019 @item DOLLARS_IN_IDENTIFIERS
8020 Define this macro to control use of the character @samp{$} in identifier
8021 names.  0 means @samp{$} is not allowed by default; 1 means it is allowed.
8022 1 is the default; there is no need to define this macro in that case.
8023 This macro controls the compiler proper; it does not affect the preprocessor.
8025 @findex NO_DOLLAR_IN_LABEL
8026 @item NO_DOLLAR_IN_LABEL
8027 Define this macro if the assembler does not accept the character
8028 @samp{$} in label names.  By default constructors and destructors in
8029 G++ have @samp{$} in the identifiers.  If this macro is defined,
8030 @samp{.} is used instead.
8032 @findex NO_DOT_IN_LABEL
8033 @item NO_DOT_IN_LABEL
8034 Define this macro if the assembler does not accept the character
8035 @samp{.} in label names.  By default constructors and destructors in G++
8036 have names that use @samp{.}.  If this macro is defined, these names
8037 are rewritten to avoid @samp{.}.
8039 @findex DEFAULT_MAIN_RETURN
8040 @item DEFAULT_MAIN_RETURN
8041 Define this macro if the target system expects every program's @code{main}
8042 function to return a standard ``success'' value by default (if no other
8043 value is explicitly returned).
8045 The definition should be a C statement (sans semicolon) to generate the
8046 appropriate rtl instructions.  It is used only when compiling the end of
8047 @code{main}.
8049 @item NEED_ATEXIT
8050 @findex NEED_ATEXIT
8051 Define this if the target system lacks the function @code{atexit}
8052 from the ANSI C standard.  If this macro is defined, a default definition
8053 will be provided to support C++.  If @code{ON_EXIT} is not defined,
8054 a default @code{exit} function will also be provided.
8056 @item ON_EXIT
8057 @findex ON_EXIT
8058 Define this macro if the target has another way to implement atexit
8059 functionality without replacing @code{exit}.  For instance, SunOS 4 has
8060 a similar @code{on_exit} library function.
8062 The definition should be a functional macro which can be used just like
8063 the @code{atexit} function.
8065 @item EXIT_BODY
8066 @findex EXIT_BODY
8067 Define this if your @code{exit} function needs to do something
8068 besides calling an external function @code{_cleanup} before
8069 terminating with @code{_exit}.  The @code{EXIT_BODY} macro is
8070 only needed if neither @code{HAVE_ATEXIT} nor
8071 @code{INIT_SECTION_ASM_OP} are defined.
8073 @findex INSN_SETS_ARE_DELAYED
8074 @item INSN_SETS_ARE_DELAYED (@var{insn})
8075 Define this macro as a C expression that is nonzero if it is safe for the
8076 delay slot scheduler to place instructions in the delay slot of @var{insn},
8077 even if they appear to use a resource set or clobbered in @var{insn}.
8078 @var{insn} is always a @code{jump_insn} or an @code{insn}; GCC knows that
8079 every @code{call_insn} has this behavior.  On machines where some @code{insn}
8080 or @code{jump_insn} is really a function call and hence has this behavior,
8081 you should define this macro.
8083 You need not define this macro if it would always return zero.
8085 @findex INSN_REFERENCES_ARE_DELAYED
8086 @item INSN_REFERENCES_ARE_DELAYED (@var{insn})
8087 Define this macro as a C expression that is nonzero if it is safe for the
8088 delay slot scheduler to place instructions in the delay slot of @var{insn},
8089 even if they appear to set or clobber a resource referenced in @var{insn}.
8090 @var{insn} is always a @code{jump_insn} or an @code{insn}.  On machines where
8091 some @code{insn} or @code{jump_insn} is really a function call and its operands
8092 are registers whose use is actually in the subroutine it calls, you should
8093 define this macro.  Doing so allows the delay slot scheduler to move
8094 instructions which copy arguments into the argument registers into the delay
8095 slot of @var{insn}.
8097 You need not define this macro if it would always return zero.
8099 @findex MACHINE_DEPENDENT_REORG
8100 @item MACHINE_DEPENDENT_REORG (@var{insn})
8101 In rare cases, correct code generation requires extra machine
8102 dependent processing between the second jump optimization pass and
8103 delayed branch scheduling.  On those machines, define this macro as a C
8104 statement to act on the code starting at @var{insn}.
8106 @findex MULTIPLE_SYMBOL_SPACES
8107 @item MULTIPLE_SYMBOL_SPACES
8108 Define this macro if in some cases global symbols from one translation
8109 unit may not be bound to undefined symbols in another translation unit
8110 without user intervention.  For instance, under Microsoft Windows
8111 symbols must be explicitly imported from shared libraries (DLLs).
8113 @findex MD_ASM_CLOBBERS
8114 @item MD_ASM_CLOBBERS
8115 A C statement that adds to @var{CLOBBERS} @code{STRING_CST} trees for
8116 any hard regs the port wishes to automatically clobber for all asms.
8118 @findex ISSUE_RATE
8119 @item ISSUE_RATE
8120 A C expression that returns how many instructions can be issued at the
8121 same time if the machine is a superscalar machine.
8123 @findex MD_SCHED_INIT
8124 @item MD_SCHED_INIT (@var{file}, @var{verbose})
8125 A C statement which is executed by the scheduler at the
8126 beginning of each block of instructions that are to be scheduled.
8127 @var{file} is either a null pointer, or a stdio stream to write any
8128 debug output to.  @var{verbose} is the verbose level provided by
8129 @samp{-fsched-verbose-}@var{n}.
8131 @findex MD_SCHED_REORDER
8132 @item MD_SCHED_REORDER (@var{file}, @var{verbose}, @var{ready}, @var{n_ready}, @var{clock}, @var{can_issue_more})
8133 A C statement which is executed by the scheduler after it
8134 has scheduled the ready list to allow the machine description to reorder
8135 it (for example to combine two small instructions together on
8136 @samp{VLIW} machines).  @var{file} is either a null pointer, or a stdio
8137 stream to write any debug output to.  @var{verbose} is the verbose level
8138 provided by @samp{-fsched-verbose-}@var{n}.  @var{ready} is a pointer to
8139 the ready list of instructions that are ready to be scheduled.
8140 @var{n_ready} is the number of elements in the ready list.  The
8141 scheduler reads the ready list in reverse order, starting with
8142 @var{ready}[@var{n_ready}-1] and going to @var{ready}[0].  @var{clock}
8143 is the timer tick of the scheduler.  @var{can_issue_more} is an output
8144 parameter that is set to the number of insns that can issue this clock;
8145 normally this is just @code{issue_rate}.
8147 @findex MD_SCHED_VARIABLE_ISSUE
8148 @item MD_SCHED_VARIABLE_ISSUE (@var{file}, @var{verbose}, @var{insn}, @var{more})
8149 A C statement which is executed by the scheduler after it
8150 has scheduled an insn from the ready list.  @var{file} is either a null
8151 pointer, or a stdio stream to write any debug output to.  @var{verbose}
8152 is the verbose level provided by @samp{-fsched-verbose-}@var{n}.
8153 @var{insn} is the instruction that was scheduled.  @var{more} is the
8154 number of instructions that can be issued in the current cycle.  The
8155 @samp{MD_SCHED_VARIABLE_ISSUE} macro is responsible for updating the
8156 value of @var{more} (typically by @var{more}--).
8158 @findex MAX_INTEGER_COMPUTATION_MODE
8159 @item MAX_INTEGER_COMPUTATION_MODE
8160 Define this to the largest integer machine mode which can be used for
8161 operations other than load, store and copy operations.
8163 You need only define this macro if the target holds values larger than
8164 @code{word_mode} in general purpose registers.  Most targets should not define
8165 this macro.
8167 @findex MATH_LIBRARY
8168 @item MATH_LIBRARY
8169 Define this macro as a C string constant for the linker argument to link
8170 in the system math library, or @samp{""} if the target does not have a
8171 separate math library.
8173 You need only define this macro if the default of @samp{"-lm"} is wrong.
8175 @findex LIBRARY_PATH_ENV
8176 @item LIBRARY_PATH_ENV
8177 Define this macro as a C string constant for the environment variable that
8178 specifies where the linker should look for libraries.
8180 You need only define this macro if the default of @samp{"LIBRARY_PATH"}
8181 is wrong.
8183 @findex TARGET_HAS_F_SETLKW
8184 @item TARGET_HAS_F_SETLKW
8185 Define this macro if the target supports file locking with fcntl / F_SETLKW.
8186 Note that this functionality is part of POSIX.
8187 Defining @code{TARGET_HAS_F_SETLKW} will enable the test coverage code
8188 to use file locking when exiting a program, which avoids race conditions
8189 if the program has forked.
8191 @findex MAX_CONDITIONAL_EXECUTE
8192 @item MAX_CONDITIONAL_EXECUTE
8194 A C expression for the maximum number of instructions to execute via
8195 conditional execution instructions instead of a branch.  A value of
8196 @code{BRANCH_COST}+1 is the default if the machine does not use cc0, and
8197 1 if it does use cc0.
8199 @findex IFCVT_MODIFY_TESTS
8200 @item IFCVT_MODIFY_TESTS
8201 A C expression to modify the tests in @code{TRUE_EXPR}, and
8202 @code{FALSE_EXPPR} for use in converting insns in @code{TEST_BB},
8203 @code{THEN_BB}, @code{ELSE_BB}, and @code{JOIN_BB} basic blocks to
8204 conditional execution.  Set either @code{TRUE_EXPR} or @code{FALSE_EXPR}
8205 to a null pointer if the tests cannot be converted.
8207 @findex IFCVT_MODIFY_INSN
8208 @item IFCVT_MODIFY_INSN
8209 A C expression to modify the @code{PATTERN} of an @code{INSN} that is to
8210 be converted to conditional execution format.
8212 @findex IFCVT_MODIFY_FINAL
8213 @item IFCVT_MODIFY_FINAL
8214 A C expression to perform any final machine dependent modifications in
8215 converting code to conditional execution in the basic blocks
8216 @code{TEST_BB}, @code{THEN_BB}, @code{ELSE_BB}, and @code{JOIN_BB}.
8218 @findex IFCVT_MODIFY_CANCEL
8219 @item IFCVT_MODIFY_CANCEL
8220 A C expression to cancel any machine dependent modifications in
8221 converting code to conditional execution in the basic blocks
8222 @code{TEST_BB}, @code{THEN_BB}, @code{ELSE_BB}, and @code{JOIN_BB}.
8223 @end table