]>
Commit | Line | Data |
---|---|---|
c58b209a | 1 | @c Copyright (C) 1988,1989,1992,1993,1994,1995,1996,1997,1998,1999,2000,2001, |
fe037b8a | 2 | @c 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
feca2ed3 JW |
3 | @c This is part of the GCC manual. |
4 | @c For copying conditions, see the file gcc.texi. | |
5 | ||
6 | @node Target Macros | |
672a6f42 | 7 | @chapter Target Description Macros and Functions |
feca2ed3 JW |
8 | @cindex machine description macros |
9 | @cindex target description macros | |
10 | @cindex macros, target description | |
11 | @cindex @file{tm.h} macros | |
12 | ||
13 | In addition to the file @file{@var{machine}.md}, a machine description | |
14 | includes a C header file conventionally given the name | |
672a6f42 NB |
15 | @file{@var{machine}.h} and a C source file named @file{@var{machine}.c}. |
16 | The header file defines numerous macros that convey the information | |
17 | about the target machine that does not fit into the scheme of the | |
18 | @file{.md} file. The file @file{tm.h} should be a link to | |
19 | @file{@var{machine}.h}. The header file @file{config.h} includes | |
20 | @file{tm.h} and most compiler source files include @file{config.h}. The | |
648c546a | 21 | source file defines a variable @code{targetm}, which is a structure |
672a6f42 NB |
22 | containing pointers to functions and data relating to the target |
23 | machine. @file{@var{machine}.c} should also contain their definitions, | |
24 | if they are not defined elsewhere in GCC, and other functions called | |
25 | through the macros defined in the @file{.h} file. | |
feca2ed3 JW |
26 | |
27 | @menu | |
648c546a | 28 | * Target Structure:: The @code{targetm} variable. |
feca2ed3 | 29 | * Driver:: Controlling how the driver runs the compilation passes. |
630d3d5a | 30 | * Run-time Target:: Defining @samp{-m} options like @option{-m68000} and @option{-m68020}. |
414c4dc4 | 31 | * Per-Function Data:: Defining data structures for per-function information. |
feca2ed3 JW |
32 | * Storage Layout:: Defining sizes and alignments of data. |
33 | * Type Layout:: Defining sizes and properties of basic user data types. | |
34 | * Registers:: Naming and describing the hardware registers. | |
35 | * Register Classes:: Defining the classes of hardware registers. | |
f38840db | 36 | * Old Constraints:: The old way to define machine-specific constraints. |
feca2ed3 JW |
37 | * Stack and Calling:: Defining which way the stack grows and by how much. |
38 | * Varargs:: Defining the varargs macros. | |
39 | * Trampolines:: Code set up at run time to enter a nested function. | |
40 | * Library Calls:: Controlling how library routines are implicitly called. | |
41 | * Addressing Modes:: Defining addressing modes valid for memory operands. | |
aacd3885 | 42 | * Anchored Addresses:: Defining how @option{-fsection-anchors} should work. |
feca2ed3 JW |
43 | * Condition Code:: Defining how insns update the condition code. |
44 | * Costs:: Defining relative costs of different operations. | |
c237e94a | 45 | * Scheduling:: Adjusting the behavior of the instruction scheduler. |
feca2ed3 JW |
46 | * Sections:: Dividing storage into text, data, and other sections. |
47 | * PIC:: Macros for position independent code. | |
48 | * Assembler Format:: Defining how to write insns and pseudo-ops to output. | |
49 | * Debugging Info:: Defining the format of debugging output. | |
b216cd4a | 50 | * Floating Point:: Handling floating point for cross-compilers. |
9f09b1f2 | 51 | * Mode Switching:: Insertion of mode-switching instructions. |
91d231cb | 52 | * Target Attributes:: Defining target-specific uses of @code{__attribute__}. |
d604bca3 | 53 | * MIPS Coprocessors:: MIPS coprocessor support and how to customize it. |
7bb1ad93 | 54 | * PCH Target:: Validity checking for precompiled headers. |
4185ae53 | 55 | * C++ ABI:: Controlling C++ ABI changes. |
feca2ed3 JW |
56 | * Misc:: Everything else. |
57 | @end menu | |
58 | ||
672a6f42 | 59 | @node Target Structure |
648c546a | 60 | @section The Global @code{targetm} Variable |
672a6f42 NB |
61 | @cindex target hooks |
62 | @cindex target functions | |
63 | ||
f6897b10 SS |
64 | @deftypevar {struct gcc_target} targetm |
65 | The target @file{.c} file must define the global @code{targetm} variable | |
672a6f42 NB |
66 | which contains pointers to functions and data relating to the target |
67 | machine. The variable is declared in @file{target.h}; | |
68 | @file{target-def.h} defines the macro @code{TARGET_INITIALIZER} which is | |
69 | used to initialize the variable, and macros for the default initializers | |
70 | for elements of the structure. The @file{.c} file should override those | |
71 | macros for which the default definition is inappropriate. For example: | |
72 | @smallexample | |
73 | #include "target.h" | |
74 | #include "target-def.h" | |
75 | ||
76 | /* @r{Initialize the GCC target structure.} */ | |
77 | ||
91d231cb JM |
78 | #undef TARGET_COMP_TYPE_ATTRIBUTES |
79 | #define TARGET_COMP_TYPE_ATTRIBUTES @var{machine}_comp_type_attributes | |
672a6f42 | 80 | |
f6897b10 | 81 | struct gcc_target targetm = TARGET_INITIALIZER; |
672a6f42 NB |
82 | @end smallexample |
83 | @end deftypevar | |
84 | ||
85 | Where a macro should be defined in the @file{.c} file in this manner to | |
648c546a | 86 | form part of the @code{targetm} structure, it is documented below as a |
672a6f42 NB |
87 | ``Target Hook'' with a prototype. Many macros will change in future |
88 | from being defined in the @file{.h} file to being part of the | |
648c546a | 89 | @code{targetm} structure. |
672a6f42 | 90 | |
feca2ed3 JW |
91 | @node Driver |
92 | @section Controlling the Compilation Driver, @file{gcc} | |
93 | @cindex driver | |
94 | @cindex controlling the compilation driver | |
95 | ||
96 | @c prevent bad page break with this line | |
97 | You can control the compilation driver. | |
98 | ||
a2c4f8e0 | 99 | @defmac SWITCH_TAKES_ARG (@var{char}) |
630d3d5a | 100 | A C expression which determines whether the option @option{-@var{char}} |
feca2ed3 JW |
101 | takes arguments. The value should be the number of arguments that |
102 | option takes--zero, for many options. | |
103 | ||
104 | By default, this macro is defined as | |
105 | @code{DEFAULT_SWITCH_TAKES_ARG}, which handles the standard options | |
106 | properly. You need not define @code{SWITCH_TAKES_ARG} unless you | |
107 | wish to add additional options which take arguments. Any redefinition | |
108 | should call @code{DEFAULT_SWITCH_TAKES_ARG} and then check for | |
109 | additional options. | |
a2c4f8e0 | 110 | @end defmac |
feca2ed3 | 111 | |
a2c4f8e0 | 112 | @defmac WORD_SWITCH_TAKES_ARG (@var{name}) |
630d3d5a | 113 | A C expression which determines whether the option @option{-@var{name}} |
feca2ed3 JW |
114 | takes arguments. The value should be the number of arguments that |
115 | option takes--zero, for many options. This macro rather than | |
116 | @code{SWITCH_TAKES_ARG} is used for multi-character option names. | |
117 | ||
118 | By default, this macro is defined as | |
119 | @code{DEFAULT_WORD_SWITCH_TAKES_ARG}, which handles the standard options | |
120 | properly. You need not define @code{WORD_SWITCH_TAKES_ARG} unless you | |
121 | wish to add additional options which take arguments. Any redefinition | |
122 | should call @code{DEFAULT_WORD_SWITCH_TAKES_ARG} and then check for | |
123 | additional options. | |
a2c4f8e0 | 124 | @end defmac |
feca2ed3 | 125 | |
a2c4f8e0 | 126 | @defmac SWITCH_CURTAILS_COMPILATION (@var{char}) |
630d3d5a | 127 | A C expression which determines whether the option @option{-@var{char}} |
88117d44 | 128 | stops compilation before the generation of an executable. The value is |
df2a54e9 | 129 | boolean, nonzero if the option does stop an executable from being |
88117d44 NC |
130 | generated, zero otherwise. |
131 | ||
132 | By default, this macro is defined as | |
133 | @code{DEFAULT_SWITCH_CURTAILS_COMPILATION}, which handles the standard | |
134 | options properly. You need not define | |
135 | @code{SWITCH_CURTAILS_COMPILATION} unless you wish to add additional | |
136 | options which affect the generation of an executable. Any redefinition | |
137 | should call @code{DEFAULT_SWITCH_CURTAILS_COMPILATION} and then check | |
138 | for additional options. | |
a2c4f8e0 | 139 | @end defmac |
88117d44 | 140 | |
a2c4f8e0 | 141 | @defmac SWITCHES_NEED_SPACES |
feca2ed3 JW |
142 | A string-valued C expression which enumerates the options for which |
143 | the linker needs a space between the option and its argument. | |
144 | ||
145 | If this macro is not defined, the default value is @code{""}. | |
a2c4f8e0 | 146 | @end defmac |
feca2ed3 | 147 | |
a2c4f8e0 | 148 | @defmac TARGET_OPTION_TRANSLATE_TABLE |
0259b07a DD |
149 | If defined, a list of pairs of strings, the first of which is a |
150 | potential command line target to the @file{gcc} driver program, and the | |
151 | second of which is a space-separated (tabs and other whitespace are not | |
152 | supported) list of options with which to replace the first option. The | |
153 | target defining this list is responsible for assuring that the results | |
154 | are valid. Replacement options may not be the @code{--opt} style, they | |
155 | must be the @code{-opt} style. It is the intention of this macro to | |
156 | provide a mechanism for substitution that affects the multilibs chosen, | |
157 | such as one option that enables many options, some of which select | |
4ec7afd7 KH |
158 | multilibs. Example nonsensical definition, where @option{-malt-abi}, |
159 | @option{-EB}, and @option{-mspoo} cause different multilibs to be chosen: | |
0259b07a | 160 | |
478c9e72 | 161 | @smallexample |
0259b07a DD |
162 | #define TARGET_OPTION_TRANSLATE_TABLE \ |
163 | @{ "-fast", "-march=fast-foo -malt-abi -I/usr/fast-foo" @}, \ | |
164 | @{ "-compat", "-EB -malign=4 -mspoo" @} | |
478c9e72 | 165 | @end smallexample |
a2c4f8e0 | 166 | @end defmac |
0259b07a | 167 | |
a2c4f8e0 | 168 | @defmac DRIVER_SELF_SPECS |
db36994b RS |
169 | A list of specs for the driver itself. It should be a suitable |
170 | initializer for an array of strings, with no surrounding braces. | |
171 | ||
3bd6d4c4 AO |
172 | The driver applies these specs to its own command line between loading |
173 | default @file{specs} files (but not command-line specified ones) and | |
174 | choosing the multilib directory or running any subcommands. It | |
175 | applies them in the order given, so each spec can depend on the | |
176 | options added by earlier ones. It is also possible to remove options | |
177 | using @samp{%<@var{option}} in the usual way. | |
db36994b RS |
178 | |
179 | This macro can be useful when a port has several interdependent target | |
180 | options. It provides a way of standardizing the command line so | |
181 | that the other specs are easier to write. | |
182 | ||
183 | Do not define this macro if it does not need to do anything. | |
a2c4f8e0 | 184 | @end defmac |
db36994b | 185 | |
a2c4f8e0 | 186 | @defmac OPTION_DEFAULT_SPECS |
7816bea0 DJ |
187 | A list of specs used to support configure-time default options (i.e.@: |
188 | @option{--with} options) in the driver. It should be a suitable initializer | |
189 | for an array of structures, each containing two strings, without the | |
190 | outermost pair of surrounding braces. | |
191 | ||
192 | The first item in the pair is the name of the default. This must match | |
193 | the code in @file{config.gcc} for the target. The second item is a spec | |
194 | to apply if a default with this name was specified. The string | |
195 | @samp{%(VALUE)} in the spec will be replaced by the value of the default | |
196 | everywhere it occurs. | |
197 | ||
198 | The driver will apply these specs to its own command line between loading | |
199 | default @file{specs} files and processing @code{DRIVER_SELF_SPECS}, using | |
200 | the same mechanism as @code{DRIVER_SELF_SPECS}. | |
201 | ||
202 | Do not define this macro if it does not need to do anything. | |
a2c4f8e0 | 203 | @end defmac |
7816bea0 | 204 | |
a2c4f8e0 | 205 | @defmac CPP_SPEC |
a3a15b4d | 206 | A C string constant that tells the GCC driver program options to |
161d7b59 JM |
207 | pass to CPP@. It can also specify how to translate options you |
208 | give to GCC into options for GCC to pass to the CPP@. | |
feca2ed3 JW |
209 | |
210 | Do not define this macro if it does not need to do anything. | |
a2c4f8e0 | 211 | @end defmac |
feca2ed3 | 212 | |
a2c4f8e0 | 213 | @defmac CPLUSPLUS_CPP_SPEC |
a9374841 | 214 | This macro is just like @code{CPP_SPEC}, but is used for C++, rather |
161d7b59 | 215 | than C@. If you do not define this macro, then the value of |
a9374841 | 216 | @code{CPP_SPEC} (if any) will be used instead. |
a2c4f8e0 | 217 | @end defmac |
a9374841 | 218 | |
a2c4f8e0 | 219 | @defmac CC1_SPEC |
a3a15b4d | 220 | A C string constant that tells the GCC driver program options to |
66519c70 JL |
221 | pass to @code{cc1}, @code{cc1plus}, @code{f771}, and the other language |
222 | front ends. | |
a3a15b4d | 223 | It can also specify how to translate options you give to GCC into options |
630d3d5a | 224 | for GCC to pass to front ends. |
feca2ed3 JW |
225 | |
226 | Do not define this macro if it does not need to do anything. | |
a2c4f8e0 | 227 | @end defmac |
feca2ed3 | 228 | |
a2c4f8e0 | 229 | @defmac CC1PLUS_SPEC |
a3a15b4d | 230 | A C string constant that tells the GCC driver program options to |
feca2ed3 | 231 | pass to @code{cc1plus}. It can also specify how to translate options you |
a3a15b4d | 232 | give to GCC into options for GCC to pass to the @code{cc1plus}. |
feca2ed3 JW |
233 | |
234 | Do not define this macro if it does not need to do anything. | |
1d96e5b4 FF |
235 | Note that everything defined in CC1_SPEC is already passed to |
236 | @code{cc1plus} so there is no need to duplicate the contents of | |
161d7b59 | 237 | CC1_SPEC in CC1PLUS_SPEC@. |
a2c4f8e0 | 238 | @end defmac |
feca2ed3 | 239 | |
a2c4f8e0 | 240 | @defmac ASM_SPEC |
a3a15b4d | 241 | A C string constant that tells the GCC driver program options to |
feca2ed3 | 242 | pass to the assembler. It can also specify how to translate options |
a3a15b4d | 243 | you give to GCC into options for GCC to pass to the assembler. |
feca2ed3 JW |
244 | See the file @file{sun3.h} for an example of this. |
245 | ||
246 | Do not define this macro if it does not need to do anything. | |
a2c4f8e0 | 247 | @end defmac |
feca2ed3 | 248 | |
a2c4f8e0 | 249 | @defmac ASM_FINAL_SPEC |
a3a15b4d | 250 | A C string constant that tells the GCC driver program how to |
feca2ed3 JW |
251 | run any programs which cleanup after the normal assembler. |
252 | Normally, this is not needed. See the file @file{mips.h} for | |
253 | an example of this. | |
254 | ||
255 | Do not define this macro if it does not need to do anything. | |
a2c4f8e0 | 256 | @end defmac |
feca2ed3 | 257 | |
a2c4f8e0 | 258 | @defmac AS_NEEDS_DASH_FOR_PIPED_INPUT |
4977bab6 ZW |
259 | Define this macro, with no value, if the driver should give the assembler |
260 | an argument consisting of a single dash, @option{-}, to instruct it to | |
261 | read from its standard input (which will be a pipe connected to the | |
262 | output of the compiler proper). This argument is given after any | |
263 | @option{-o} option specifying the name of the output file. | |
264 | ||
265 | If you do not define this macro, the assembler is assumed to read its | |
266 | standard input if given no non-option arguments. If your assembler | |
267 | cannot read standard input at all, use a @samp{%@{pipe:%e@}} construct; | |
268 | see @file{mips.h} for instance. | |
a2c4f8e0 | 269 | @end defmac |
4977bab6 | 270 | |
a2c4f8e0 | 271 | @defmac LINK_SPEC |
a3a15b4d | 272 | A C string constant that tells the GCC driver program options to |
feca2ed3 | 273 | pass to the linker. It can also specify how to translate options you |
a3a15b4d | 274 | give to GCC into options for GCC to pass to the linker. |
feca2ed3 JW |
275 | |
276 | Do not define this macro if it does not need to do anything. | |
a2c4f8e0 | 277 | @end defmac |
feca2ed3 | 278 | |
a2c4f8e0 | 279 | @defmac LIB_SPEC |
feca2ed3 JW |
280 | Another C string constant used much like @code{LINK_SPEC}. The difference |
281 | between the two is that @code{LIB_SPEC} is used at the end of the | |
282 | command given to the linker. | |
283 | ||
284 | If this macro is not defined, a default is provided that | |
285 | loads the standard C library from the usual place. See @file{gcc.c}. | |
a2c4f8e0 | 286 | @end defmac |
feca2ed3 | 287 | |
a2c4f8e0 | 288 | @defmac LIBGCC_SPEC |
a3a15b4d | 289 | Another C string constant that tells the GCC driver program |
feca2ed3 JW |
290 | how and when to place a reference to @file{libgcc.a} into the |
291 | linker command line. This constant is placed both before and after | |
292 | the value of @code{LIB_SPEC}. | |
293 | ||
a3a15b4d | 294 | If this macro is not defined, the GCC driver provides a default that |
630d3d5a | 295 | passes the string @option{-lgcc} to the linker. |
a2c4f8e0 | 296 | @end defmac |
feca2ed3 | 297 | |
328163dc MA |
298 | @defmac REAL_LIBGCC_SPEC |
299 | By default, if @code{ENABLE_SHARED_LIBGCC} is defined, the | |
300 | @code{LIBGCC_SPEC} is not directly used by the driver program but is | |
301 | instead modified to refer to different versions of @file{libgcc.a} | |
4ec7afd7 KH |
302 | depending on the values of the command line flags @option{-static}, |
303 | @option{-shared}, @option{-static-libgcc}, and @option{-shared-libgcc}. On | |
328163dc MA |
304 | targets where these modifications are inappropriate, define |
305 | @code{REAL_LIBGCC_SPEC} instead. @code{REAL_LIBGCC_SPEC} tells the | |
306 | driver how to place a reference to @file{libgcc} on the link command | |
307 | line, but, unlike @code{LIBGCC_SPEC}, it is used unmodified. | |
308 | @end defmac | |
309 | ||
743eeb5a AM |
310 | @defmac USE_LD_AS_NEEDED |
311 | A macro that controls the modifications to @code{LIBGCC_SPEC} | |
312 | mentioned in @code{REAL_LIBGCC_SPEC}. If nonzero, a spec will be | |
313 | generated that uses --as-needed and the shared libgcc in place of the | |
314 | static exception handler library, when linking without any of | |
315 | @code{-static}, @code{-static-libgcc}, or @code{-shared-libgcc}. | |
316 | @end defmac | |
317 | ||
318 | @defmac LINK_EH_SPEC | |
319 | If defined, this C string constant is added to @code{LINK_SPEC}. | |
320 | When @code{USE_LD_AS_NEEDED} is zero or undefined, it also affects | |
321 | the modifications to @code{LIBGCC_SPEC} mentioned in | |
322 | @code{REAL_LIBGCC_SPEC}. | |
323 | @end defmac | |
324 | ||
a2c4f8e0 | 325 | @defmac STARTFILE_SPEC |
feca2ed3 JW |
326 | Another C string constant used much like @code{LINK_SPEC}. The |
327 | difference between the two is that @code{STARTFILE_SPEC} is used at | |
328 | the very beginning of the command given to the linker. | |
329 | ||
330 | If this macro is not defined, a default is provided that loads the | |
331 | standard C startup file from the usual place. See @file{gcc.c}. | |
a2c4f8e0 | 332 | @end defmac |
feca2ed3 | 333 | |
a2c4f8e0 | 334 | @defmac ENDFILE_SPEC |
feca2ed3 JW |
335 | Another C string constant used much like @code{LINK_SPEC}. The |
336 | difference between the two is that @code{ENDFILE_SPEC} is used at | |
337 | the very end of the command given to the linker. | |
338 | ||
339 | Do not define this macro if it does not need to do anything. | |
a2c4f8e0 | 340 | @end defmac |
feca2ed3 | 341 | |
a2c4f8e0 | 342 | @defmac THREAD_MODEL_SPEC |
008355a6 AO |
343 | GCC @code{-v} will print the thread model GCC was configured to use. |
344 | However, this doesn't work on platforms that are multilibbed on thread | |
345 | models, such as AIX 4.3. On such platforms, define | |
346 | @code{THREAD_MODEL_SPEC} such that it evaluates to a string without | |
347 | blanks that names one of the recognized thread models. @code{%*}, the | |
348 | default value of this macro, will expand to the value of | |
349 | @code{thread_file} set in @file{config.gcc}. | |
a2c4f8e0 | 350 | @end defmac |
008355a6 | 351 | |
a2c4f8e0 | 352 | @defmac SYSROOT_SUFFIX_SPEC |
73774972 EC |
353 | Define this macro to add a suffix to the target sysroot when GCC is |
354 | configured with a sysroot. This will cause GCC to search for usr/lib, | |
355 | et al, within sysroot+suffix. | |
a2c4f8e0 | 356 | @end defmac |
e7f13528 | 357 | |
a2c4f8e0 | 358 | @defmac SYSROOT_HEADERS_SUFFIX_SPEC |
73774972 EC |
359 | Define this macro to add a headers_suffix to the target sysroot when |
360 | GCC is configured with a sysroot. This will cause GCC to pass the | |
f4314bb6 | 361 | updated sysroot+headers_suffix to CPP, causing it to search for |
e7f13528 | 362 | usr/include, et al, within sysroot+headers_suffix. |
a2c4f8e0 | 363 | @end defmac |
e7f13528 | 364 | |
a2c4f8e0 | 365 | @defmac EXTRA_SPECS |
feca2ed3 JW |
366 | Define this macro to provide additional specifications to put in the |
367 | @file{specs} file that can be used in various specifications like | |
368 | @code{CC1_SPEC}. | |
369 | ||
370 | The definition should be an initializer for an array of structures, | |
371 | containing a string constant, that defines the specification name, and a | |
372 | string constant that provides the specification. | |
373 | ||
374 | Do not define this macro if it does not need to do anything. | |
375 | ||
376 | @code{EXTRA_SPECS} is useful when an architecture contains several | |
630d3d5a | 377 | related targets, which have various @code{@dots{}_SPECS} which are similar |
feca2ed3 JW |
378 | to each other, and the maintainer would like one central place to keep |
379 | these definitions. | |
380 | ||
381 | For example, the PowerPC System V.4 targets use @code{EXTRA_SPECS} to | |
382 | define either @code{_CALL_SYSV} when the System V calling sequence is | |
383 | used or @code{_CALL_AIX} when the older AIX-based calling sequence is | |
384 | used. | |
385 | ||
386 | The @file{config/rs6000/rs6000.h} target file defines: | |
387 | ||
3ab51846 | 388 | @smallexample |
feca2ed3 JW |
389 | #define EXTRA_SPECS \ |
390 | @{ "cpp_sysv_default", CPP_SYSV_DEFAULT @}, | |
391 | ||
392 | #define CPP_SYS_DEFAULT "" | |
3ab51846 | 393 | @end smallexample |
feca2ed3 JW |
394 | |
395 | The @file{config/rs6000/sysv.h} target file defines: | |
396 | @smallexample | |
397 | #undef CPP_SPEC | |
398 | #define CPP_SPEC \ | |
399 | "%@{posix: -D_POSIX_SOURCE @} \ | |
50d440bc NC |
400 | %@{mcall-sysv: -D_CALL_SYSV @} \ |
401 | %@{!mcall-sysv: %(cpp_sysv_default) @} \ | |
feca2ed3 JW |
402 | %@{msoft-float: -D_SOFT_FLOAT@} %@{mcpu=403: -D_SOFT_FLOAT@}" |
403 | ||
404 | #undef CPP_SYSV_DEFAULT | |
405 | #define CPP_SYSV_DEFAULT "-D_CALL_SYSV" | |
406 | @end smallexample | |
407 | ||
408 | while the @file{config/rs6000/eabiaix.h} target file defines | |
409 | @code{CPP_SYSV_DEFAULT} as: | |
410 | ||
411 | @smallexample | |
412 | #undef CPP_SYSV_DEFAULT | |
413 | #define CPP_SYSV_DEFAULT "-D_CALL_AIX" | |
414 | @end smallexample | |
a2c4f8e0 | 415 | @end defmac |
feca2ed3 | 416 | |
a2c4f8e0 | 417 | @defmac LINK_LIBGCC_SPECIAL_1 |
feca2ed3 JW |
418 | Define this macro if the driver program should find the library |
419 | @file{libgcc.a}. If you do not define this macro, the driver program will pass | |
630d3d5a | 420 | the argument @option{-lgcc} to tell the linker to do the search. |
a2c4f8e0 | 421 | @end defmac |
feca2ed3 | 422 | |
a2c4f8e0 | 423 | @defmac LINK_GCC_C_SEQUENCE_SPEC |
bbd7687d DM |
424 | The sequence in which libgcc and libc are specified to the linker. |
425 | By default this is @code{%G %L %G}. | |
a2c4f8e0 | 426 | @end defmac |
bbd7687d | 427 | |
a2c4f8e0 | 428 | @defmac LINK_COMMAND_SPEC |
9ec36da5 JL |
429 | A C string constant giving the complete command line need to execute the |
430 | linker. When you do this, you will need to update your port each time a | |
431 | change is made to the link command line within @file{gcc.c}. Therefore, | |
432 | define this macro only if you need to completely redefine the command | |
433 | line for invoking the linker and there is no other way to accomplish | |
bbd7687d DM |
434 | the effect you need. Overriding this macro may be avoidable by overriding |
435 | @code{LINK_GCC_C_SEQUENCE_SPEC} instead. | |
a2c4f8e0 | 436 | @end defmac |
9ec36da5 | 437 | |
a2c4f8e0 | 438 | @defmac LINK_ELIMINATE_DUPLICATE_LDIRECTORIES |
2cc07db4 | 439 | A nonzero value causes @command{collect2} to remove duplicate @option{-L@var{directory}} search |
5897739e JO |
440 | directories from linking commands. Do not give it a nonzero value if |
441 | removing duplicate search directories changes the linker's semantics. | |
a2c4f8e0 | 442 | @end defmac |
5897739e | 443 | |
a2c4f8e0 | 444 | @defmac MULTILIB_DEFAULTS |
feca2ed3 JW |
445 | Define this macro as a C expression for the initializer of an array of |
446 | string to tell the driver program which options are defaults for this | |
447 | target and thus do not need to be handled specially when using | |
448 | @code{MULTILIB_OPTIONS}. | |
449 | ||
450 | Do not define this macro if @code{MULTILIB_OPTIONS} is not defined in | |
451 | the target makefile fragment or if none of the options listed in | |
452 | @code{MULTILIB_OPTIONS} are set by default. | |
453 | @xref{Target Fragment}. | |
a2c4f8e0 | 454 | @end defmac |
feca2ed3 | 455 | |
a2c4f8e0 | 456 | @defmac RELATIVE_PREFIX_NOT_LINKDIR |
05739753 | 457 | Define this macro to tell @command{gcc} that it should only translate |
630d3d5a | 458 | a @option{-B} prefix into a @option{-L} linker option if the prefix |
feca2ed3 | 459 | indicates an absolute file name. |
a2c4f8e0 | 460 | @end defmac |
feca2ed3 | 461 | |
a2c4f8e0 | 462 | @defmac MD_EXEC_PREFIX |
feca2ed3 JW |
463 | If defined, this macro is an additional prefix to try after |
464 | @code{STANDARD_EXEC_PREFIX}. @code{MD_EXEC_PREFIX} is not searched | |
630d3d5a | 465 | when the @option{-b} option is used, or the compiler is built as a cross |
5505263f JL |
466 | compiler. If you define @code{MD_EXEC_PREFIX}, then be sure to add it |
467 | to the list of directories used to find the assembler in @file{configure.in}. | |
a2c4f8e0 | 468 | @end defmac |
feca2ed3 | 469 | |
a2c4f8e0 | 470 | @defmac STANDARD_STARTFILE_PREFIX |
feca2ed3 | 471 | Define this macro as a C string constant if you wish to override the |
0d037580 | 472 | standard choice of @code{libdir} as the default prefix to |
feca2ed3 | 473 | try when searching for startup files such as @file{crt0.o}. |
0d037580 DJ |
474 | @code{STANDARD_STARTFILE_PREFIX} is not searched when the compiler |
475 | is built as a cross compiler. | |
a2c4f8e0 | 476 | @end defmac |
feca2ed3 | 477 | |
656c7a3a AL |
478 | @defmac STANDARD_STARTFILE_PREFIX_1 |
479 | Define this macro as a C string constant if you wish to override the | |
480 | standard choice of @code{/lib} as a prefix to try after the default prefix | |
481 | when searching for startup files such as @file{crt0.o}. | |
482 | @code{STANDARD_STARTFILE_PREFIX_1} is not searched when the compiler | |
483 | is built as a cross compiler. | |
484 | @end defmac | |
485 | ||
486 | @defmac STANDARD_STARTFILE_PREFIX_2 | |
487 | Define this macro as a C string constant if you wish to override the | |
488 | standard choice of @code{/lib} as yet another prefix to try after the | |
489 | default prefix when searching for startup files such as @file{crt0.o}. | |
490 | @code{STANDARD_STARTFILE_PREFIX_2} is not searched when the compiler | |
491 | is built as a cross compiler. | |
492 | @end defmac | |
493 | ||
a2c4f8e0 | 494 | @defmac MD_STARTFILE_PREFIX |
feca2ed3 JW |
495 | If defined, this macro supplies an additional prefix to try after the |
496 | standard prefixes. @code{MD_EXEC_PREFIX} is not searched when the | |
630d3d5a | 497 | @option{-b} option is used, or when the compiler is built as a cross |
feca2ed3 | 498 | compiler. |
a2c4f8e0 | 499 | @end defmac |
feca2ed3 | 500 | |
a2c4f8e0 | 501 | @defmac MD_STARTFILE_PREFIX_1 |
feca2ed3 | 502 | If defined, this macro supplies yet another prefix to try after the |
630d3d5a | 503 | standard prefixes. It is not searched when the @option{-b} option is |
feca2ed3 | 504 | used, or when the compiler is built as a cross compiler. |
a2c4f8e0 | 505 | @end defmac |
feca2ed3 | 506 | |
a2c4f8e0 | 507 | @defmac INIT_ENVIRONMENT |
e9a25f70 | 508 | Define this macro as a C string constant if you wish to set environment |
feca2ed3 JW |
509 | variables for programs called by the driver, such as the assembler and |
510 | loader. The driver passes the value of this macro to @code{putenv} to | |
511 | initialize the necessary environment variables. | |
a2c4f8e0 | 512 | @end defmac |
feca2ed3 | 513 | |
a2c4f8e0 | 514 | @defmac LOCAL_INCLUDE_DIR |
feca2ed3 JW |
515 | Define this macro as a C string constant if you wish to override the |
516 | standard choice of @file{/usr/local/include} as the default prefix to | |
517 | try when searching for local header files. @code{LOCAL_INCLUDE_DIR} | |
518 | comes before @code{SYSTEM_INCLUDE_DIR} in the search order. | |
519 | ||
c237e94a ZW |
520 | Cross compilers do not search either @file{/usr/local/include} or its |
521 | replacement. | |
a2c4f8e0 | 522 | @end defmac |
feca2ed3 | 523 | |
a2c4f8e0 ZW |
524 | @defmac MODIFY_TARGET_NAME |
525 | Define this macro if you wish to define command-line switches that | |
526 | modify the default target name. | |
dc36ec2c RK |
527 | |
528 | For each switch, you can include a string to be appended to the first | |
529 | part of the configuration name or a string to be deleted from the | |
530 | configuration name, if present. The definition should be an initializer | |
531 | for an array of structures. Each array element should have three | |
532 | elements: the switch name (a string constant, including the initial | |
533 | dash), one of the enumeration codes @code{ADD} or @code{DELETE} to | |
534 | indicate whether the string should be inserted or deleted, and the string | |
535 | to be inserted or deleted (a string constant). | |
536 | ||
537 | For example, on a machine where @samp{64} at the end of the | |
630d3d5a JM |
538 | configuration name denotes a 64-bit target and you want the @option{-32} |
539 | and @option{-64} switches to select between 32- and 64-bit targets, you would | |
dc36ec2c RK |
540 | code |
541 | ||
542 | @smallexample | |
543 | #define MODIFY_TARGET_NAME \ | |
544 | @{ @{ "-32", DELETE, "64"@}, \ | |
545 | @{"-64", ADD, "64"@}@} | |
546 | @end smallexample | |
a2c4f8e0 | 547 | @end defmac |
dc36ec2c | 548 | |
a2c4f8e0 | 549 | @defmac SYSTEM_INCLUDE_DIR |
feca2ed3 JW |
550 | Define this macro as a C string constant if you wish to specify a |
551 | system-specific directory to search for header files before the standard | |
552 | directory. @code{SYSTEM_INCLUDE_DIR} comes before | |
553 | @code{STANDARD_INCLUDE_DIR} in the search order. | |
554 | ||
555 | Cross compilers do not use this macro and do not search the directory | |
556 | specified. | |
a2c4f8e0 | 557 | @end defmac |
feca2ed3 | 558 | |
a2c4f8e0 | 559 | @defmac STANDARD_INCLUDE_DIR |
feca2ed3 JW |
560 | Define this macro as a C string constant if you wish to override the |
561 | standard choice of @file{/usr/include} as the default prefix to | |
562 | try when searching for header files. | |
563 | ||
a2c4f8e0 | 564 | Cross compilers ignore this macro and do not search either |
feca2ed3 | 565 | @file{/usr/include} or its replacement. |
a2c4f8e0 | 566 | @end defmac |
feca2ed3 | 567 | |
a2c4f8e0 | 568 | @defmac STANDARD_INCLUDE_COMPONENT |
e9a25f70 JL |
569 | The ``component'' corresponding to @code{STANDARD_INCLUDE_DIR}. |
570 | See @code{INCLUDE_DEFAULTS}, below, for the description of components. | |
571 | If you do not define this macro, no component is used. | |
a2c4f8e0 | 572 | @end defmac |
e9a25f70 | 573 | |
a2c4f8e0 | 574 | @defmac INCLUDE_DEFAULTS |
feca2ed3 | 575 | Define this macro if you wish to override the entire default search path |
e9a25f70 JL |
576 | for include files. For a native compiler, the default search path |
577 | usually consists of @code{GCC_INCLUDE_DIR}, @code{LOCAL_INCLUDE_DIR}, | |
feca2ed3 JW |
578 | @code{SYSTEM_INCLUDE_DIR}, @code{GPLUSPLUS_INCLUDE_DIR}, and |
579 | @code{STANDARD_INCLUDE_DIR}. In addition, @code{GPLUSPLUS_INCLUDE_DIR} | |
580 | and @code{GCC_INCLUDE_DIR} are defined automatically by @file{Makefile}, | |
161d7b59 | 581 | and specify private search areas for GCC@. The directory |
feca2ed3 JW |
582 | @code{GPLUSPLUS_INCLUDE_DIR} is used only for C++ programs. |
583 | ||
584 | The definition should be an initializer for an array of structures. | |
e9a25f70 | 585 | Each array element should have four elements: the directory name (a |
9f6dc500 HPN |
586 | string constant), the component name (also a string constant), a flag |
587 | for C++-only directories, | |
e9a25f70 JL |
588 | and a flag showing that the includes in the directory don't need to be |
589 | wrapped in @code{extern @samp{C}} when compiling C++. Mark the end of | |
590 | the array with a null element. | |
591 | ||
592 | The component name denotes what GNU package the include file is part of, | |
4bd0bee9 | 593 | if any, in all uppercase letters. For example, it might be @samp{GCC} |
9f6dc500 | 594 | or @samp{BINUTILS}. If the package is part of a vendor-supplied |
e9a25f70 JL |
595 | operating system, code the component name as @samp{0}. |
596 | ||
e9a25f70 | 597 | For example, here is the definition used for VAX/VMS: |
feca2ed3 | 598 | |
3ab51846 | 599 | @smallexample |
feca2ed3 JW |
600 | #define INCLUDE_DEFAULTS \ |
601 | @{ \ | |
e9a25f70 JL |
602 | @{ "GNU_GXX_INCLUDE:", "G++", 1, 1@}, \ |
603 | @{ "GNU_CC_INCLUDE:", "GCC", 0, 0@}, \ | |
604 | @{ "SYS$SYSROOT:[SYSLIB.]", 0, 0, 0@}, \ | |
605 | @{ ".", 0, 0, 0@}, \ | |
606 | @{ 0, 0, 0, 0@} \ | |
feca2ed3 | 607 | @} |
3ab51846 | 608 | @end smallexample |
a2c4f8e0 | 609 | @end defmac |
feca2ed3 JW |
610 | |
611 | Here is the order of prefixes tried for exec files: | |
612 | ||
613 | @enumerate | |
614 | @item | |
630d3d5a | 615 | Any prefixes specified by the user with @option{-B}. |
feca2ed3 JW |
616 | |
617 | @item | |
fe037b8a CD |
618 | The environment variable @code{GCC_EXEC_PREFIX} or, if @code{GCC_EXEC_PREFIX} |
619 | is not set and the compiler has not been installed in the configure-time | |
620 | @var{prefix}, the location in which the compiler has actually been installed. | |
feca2ed3 JW |
621 | |
622 | @item | |
623 | The directories specified by the environment variable @code{COMPILER_PATH}. | |
624 | ||
625 | @item | |
fe037b8a CD |
626 | The macro @code{STANDARD_EXEC_PREFIX}, if the compiler has been installed |
627 | in the configured-time @var{prefix}. | |
feca2ed3 JW |
628 | |
629 | @item | |
fe037b8a | 630 | The location @file{/usr/libexec/gcc/}, but only if this is a native compiler. |
feca2ed3 JW |
631 | |
632 | @item | |
fe037b8a CD |
633 | The location @file{/usr/lib/gcc/}, but only if this is a native compiler. |
634 | ||
635 | @item | |
636 | The macro @code{MD_EXEC_PREFIX}, if defined, but only if this is a native | |
637 | compiler. | |
feca2ed3 JW |
638 | @end enumerate |
639 | ||
640 | Here is the order of prefixes tried for startfiles: | |
641 | ||
642 | @enumerate | |
643 | @item | |
630d3d5a | 644 | Any prefixes specified by the user with @option{-B}. |
feca2ed3 JW |
645 | |
646 | @item | |
fe037b8a CD |
647 | The environment variable @code{GCC_EXEC_PREFIX} or its automatically determined |
648 | value based on the installed toolchain location. | |
feca2ed3 JW |
649 | |
650 | @item | |
651 | The directories specified by the environment variable @code{LIBRARY_PATH} | |
512b62fb | 652 | (or port-specific name; native only, cross compilers do not use this). |
feca2ed3 JW |
653 | |
654 | @item | |
fe037b8a CD |
655 | The macro @code{STANDARD_EXEC_PREFIX}, but only if the toolchain is installed |
656 | in the configured @var{prefix} or this is a native compiler. | |
feca2ed3 JW |
657 | |
658 | @item | |
fe037b8a CD |
659 | The location @file{/usr/lib/gcc/}, but only if this is a native compiler. |
660 | ||
661 | @item | |
662 | The macro @code{MD_EXEC_PREFIX}, if defined, but only if this is a native | |
663 | compiler. | |
feca2ed3 JW |
664 | |
665 | @item | |
fe037b8a CD |
666 | The macro @code{MD_STARTFILE_PREFIX}, if defined, but only if this is a |
667 | native compiler, or we have a target system root. | |
feca2ed3 JW |
668 | |
669 | @item | |
fe037b8a CD |
670 | The macro @code{MD_STARTFILE_PREFIX_1}, if defined, but only if this is a |
671 | native compiler, or we have a target system root. | |
feca2ed3 JW |
672 | |
673 | @item | |
fe037b8a CD |
674 | The macro @code{STANDARD_STARTFILE_PREFIX}, with any sysroot modifications. |
675 | If this path is relative it will be prefixed by @code{GCC_EXEC_PREFIX} and | |
676 | the machine suffix or @code{STANDARD_EXEC_PREFIX} and the machine suffix. | |
feca2ed3 JW |
677 | |
678 | @item | |
fe037b8a CD |
679 | The macro @code{STANDARD_STARTFILE_PREFIX_1}, but only if this is a native |
680 | compiler, or we have a target system root. The default for this macro is | |
feca2ed3 JW |
681 | @file{/lib/}. |
682 | ||
683 | @item | |
fe037b8a CD |
684 | The macro @code{STANDARD_STARTFILE_PREFIX_2}, but only if this is a native |
685 | compiler, or we have a target system root. The default for this macro is | |
feca2ed3 JW |
686 | @file{/usr/lib/}. |
687 | @end enumerate | |
688 | ||
689 | @node Run-time Target | |
690 | @section Run-time Target Specification | |
691 | @cindex run-time target specification | |
692 | @cindex predefined macros | |
693 | @cindex target specifications | |
694 | ||
695 | @c prevent bad page break with this line | |
696 | Here are run-time target specifications. | |
697 | ||
a2c4f8e0 | 698 | @defmac TARGET_CPU_CPP_BUILTINS () |
12a41c22 NB |
699 | This function-like macro expands to a block of code that defines |
700 | built-in preprocessor macros and assertions for the target cpu, using | |
1f95326c | 701 | the functions @code{builtin_define}, @code{builtin_define_std} and |
cb60f38d | 702 | @code{builtin_assert}. When the front end |
12a41c22 NB |
703 | calls this macro it provides a trailing semicolon, and since it has |
704 | finished command line option processing your code can use those | |
705 | results freely. | |
3df89291 NB |
706 | |
707 | @code{builtin_assert} takes a string in the form you pass to the | |
708 | command-line option @option{-A}, such as @code{cpu=mips}, and creates | |
d90a95fb | 709 | the assertion. @code{builtin_define} takes a string in the form |
3df89291 NB |
710 | accepted by option @option{-D} and unconditionally defines the macro. |
711 | ||
d90a95fb | 712 | @code{builtin_define_std} takes a string representing the name of an |
3df89291 | 713 | object-like macro. If it doesn't lie in the user's namespace, |
d90a95fb | 714 | @code{builtin_define_std} defines it unconditionally. Otherwise, it |
3df89291 NB |
715 | defines a version with two leading underscores, and another version |
716 | with two leading and trailing underscores, and defines the original | |
717 | only if an ISO standard was not requested on the command line. For | |
718 | example, passing @code{unix} defines @code{__unix}, @code{__unix__} | |
719 | and possibly @code{unix}; passing @code{_mips} defines @code{__mips}, | |
720 | @code{__mips__} and possibly @code{_mips}, and passing @code{_ABI64} | |
721 | defines only @code{_ABI64}. | |
722 | ||
e0322d5c NB |
723 | You can also test for the C dialect being compiled. The variable |
724 | @code{c_language} is set to one of @code{clk_c}, @code{clk_cplusplus} | |
725 | or @code{clk_objective_c}. Note that if we are preprocessing | |
726 | assembler, this variable will be @code{clk_c} but the function-like | |
727 | macro @code{preprocessing_asm_p()} will return true, so you might want | |
ce3649d2 | 728 | to check for that first. If you need to check for strict ANSI, the |
c219e1da JDA |
729 | variable @code{flag_iso} can be used. The function-like macro |
730 | @code{preprocessing_trad_p()} can be used to check for traditional | |
731 | preprocessing. | |
a2c4f8e0 | 732 | @end defmac |
e0322d5c | 733 | |
a2c4f8e0 | 734 | @defmac TARGET_OS_CPP_BUILTINS () |
12a41c22 NB |
735 | Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional |
736 | and is used for the target operating system instead. | |
a2c4f8e0 | 737 | @end defmac |
12a41c22 | 738 | |
a2c4f8e0 | 739 | @defmac TARGET_OBJFMT_CPP_BUILTINS () |
4e2e315f NB |
740 | Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional |
741 | and is used for the target object format. @file{elfos.h} uses this | |
742 | macro to define @code{__ELF__}, so you probably do not need to define | |
743 | it yourself. | |
a2c4f8e0 | 744 | @end defmac |
4e2e315f | 745 | |
a2c4f8e0 | 746 | @deftypevar {extern int} target_flags |
75685792 RS |
747 | This variable is declared in @file{options.h}, which is included before |
748 | any target-specific headers. | |
a2c4f8e0 | 749 | @end deftypevar |
feca2ed3 | 750 | |
75685792 RS |
751 | @deftypevar {Target Hook} int TARGET_DEFAULT_TARGET_FLAGS |
752 | This variable specifies the initial value of @code{target_flags}. | |
753 | Its default setting is 0. | |
75685792 RS |
754 | @end deftypevar |
755 | ||
bacf5b96 RS |
756 | @cindex optional hardware or system features |
757 | @cindex features, optional, in system conventions | |
758 | ||
75685792 RS |
759 | @deftypefn {Target Hook} bool TARGET_HANDLE_OPTION (size_t @var{code}, const char *@var{arg}, int @var{value}) |
760 | This hook is called whenever the user specifies one of the | |
761 | target-specific options described by the @file{.opt} definition files | |
762 | (@pxref{Options}). It has the opportunity to do some option-specific | |
763 | processing and should return true if the option is valid. The default | |
764 | definition does nothing but return true. | |
765 | ||
766 | @var{code} specifies the @code{OPT_@var{name}} enumeration value | |
767 | associated with the selected option; @var{name} is just a rendering of | |
768 | the option name in which non-alphanumeric characters are replaced by | |
769 | underscores. @var{arg} specifies the string argument and is null if | |
770 | no argument was given. If the option is flagged as a @code{UInteger} | |
771 | (@pxref{Option properties}), @var{value} is the numeric value of the | |
772 | argument. Otherwise @var{value} is 1 if the positive form of the | |
773 | option was used and 0 if the ``no-'' form was. | |
774 | @end deftypefn | |
775 | ||
a2c4f8e0 | 776 | @defmac TARGET_VERSION |
feca2ed3 JW |
777 | This macro is a C statement to print on @code{stderr} a string |
778 | describing the particular machine description choice. Every machine | |
779 | description should define @code{TARGET_VERSION}. For example: | |
780 | ||
781 | @smallexample | |
782 | #ifdef MOTOROLA | |
783 | #define TARGET_VERSION \ | |
784 | fprintf (stderr, " (68k, Motorola syntax)"); | |
785 | #else | |
786 | #define TARGET_VERSION \ | |
787 | fprintf (stderr, " (68k, MIT syntax)"); | |
788 | #endif | |
789 | @end smallexample | |
a2c4f8e0 | 790 | @end defmac |
feca2ed3 | 791 | |
a2c4f8e0 | 792 | @defmac OVERRIDE_OPTIONS |
feca2ed3 JW |
793 | Sometimes certain combinations of command options do not make sense on |
794 | a particular target machine. You can define a macro | |
795 | @code{OVERRIDE_OPTIONS} to take account of this. This macro, if | |
796 | defined, is executed once just after all the command options have been | |
797 | parsed. | |
798 | ||
799 | Don't use this macro to turn on various extra optimizations for | |
630d3d5a | 800 | @option{-O}. That is what @code{OPTIMIZATION_OPTIONS} is for. |
a2c4f8e0 | 801 | @end defmac |
feca2ed3 | 802 | |
c7b5e395 GK |
803 | @defmac C_COMMON_OVERRIDE_OPTIONS |
804 | This is similar to @code{OVERRIDE_OPTIONS} but is only used in the C | |
805 | language frontends (C, Objective-C, C++, Objective-C++) and so can be | |
806 | used to alter option flag variables which only exist in those | |
807 | frontends. | |
808 | @end defmac | |
809 | ||
a2c4f8e0 | 810 | @defmac OPTIMIZATION_OPTIONS (@var{level}, @var{size}) |
feca2ed3 JW |
811 | Some machines may desire to change what optimizations are performed for |
812 | various optimization levels. This macro, if defined, is executed once | |
813 | just after the optimization level is determined and before the remainder | |
814 | of the command options have been parsed. Values set in this macro are | |
815 | used as the default values for the other command line options. | |
816 | ||
630d3d5a JM |
817 | @var{level} is the optimization level specified; 2 if @option{-O2} is |
818 | specified, 1 if @option{-O} is specified, and 0 if neither is specified. | |
feca2ed3 | 819 | |
df2a54e9 | 820 | @var{size} is nonzero if @option{-Os} is specified and zero otherwise. |
c6aded7c | 821 | |
feca2ed3 JW |
822 | You should not use this macro to change options that are not |
823 | machine-specific. These should uniformly selected by the same | |
824 | optimization level on all supported machines. Use this macro to enable | |
825 | machine-specific optimizations. | |
826 | ||
827 | @strong{Do not examine @code{write_symbols} in | |
828 | this macro!} The debugging options are not supposed to alter the | |
829 | generated code. | |
a2c4f8e0 | 830 | @end defmac |
feca2ed3 | 831 | |
a2c4f8e0 | 832 | @defmac CAN_DEBUG_WITHOUT_FP |
feca2ed3 | 833 | Define this macro if debugging can be performed even without a frame |
a3a15b4d | 834 | pointer. If this macro is defined, GCC will turn on the |
630d3d5a | 835 | @option{-fomit-frame-pointer} option whenever @option{-O} is specified. |
a2c4f8e0 | 836 | @end defmac |
feca2ed3 | 837 | |
414c4dc4 NC |
838 | @node Per-Function Data |
839 | @section Defining data structures for per-function information. | |
840 | @cindex per-function data | |
841 | @cindex data structures | |
842 | ||
843 | If the target needs to store information on a per-function basis, GCC | |
844 | provides a macro and a couple of variables to allow this. Note, just | |
845 | using statics to store the information is a bad idea, since GCC supports | |
846 | nested functions, so you can be halfway through encoding one function | |
847 | when another one comes along. | |
848 | ||
849 | GCC defines a data structure called @code{struct function} which | |
850 | contains all of the data specific to an individual function. This | |
851 | structure contains a field called @code{machine} whose type is | |
852 | @code{struct machine_function *}, which can be used by targets to point | |
853 | to their own specific data. | |
854 | ||
855 | If a target needs per-function specific data it should define the type | |
e2500fed GK |
856 | @code{struct machine_function} and also the macro @code{INIT_EXPANDERS}. |
857 | This macro should be used to initialize the function pointer | |
858 | @code{init_machine_status}. This pointer is explained below. | |
414c4dc4 NC |
859 | |
860 | One typical use of per-function, target specific data is to create an | |
861 | RTX to hold the register containing the function's return address. This | |
862 | RTX can then be used to implement the @code{__builtin_return_address} | |
863 | function, for level 0. | |
864 | ||
aee96fe9 | 865 | Note---earlier implementations of GCC used a single data area to hold |
414c4dc4 NC |
866 | all of the per-function information. Thus when processing of a nested |
867 | function began the old per-function data had to be pushed onto a | |
868 | stack, and when the processing was finished, it had to be popped off the | |
869 | stack. GCC used to provide function pointers called | |
02f52e19 | 870 | @code{save_machine_status} and @code{restore_machine_status} to handle |
414c4dc4 NC |
871 | the saving and restoring of the target specific information. Since the |
872 | single data area approach is no longer used, these pointers are no | |
873 | longer supported. | |
874 | ||
a2c4f8e0 | 875 | @defmac INIT_EXPANDERS |
c21cd8b1 | 876 | Macro called to initialize any target specific information. This macro |
414c4dc4 | 877 | is called once per function, before generation of any RTL has begun. |
c21cd8b1 | 878 | The intention of this macro is to allow the initialization of the |
a2c4f8e0 ZW |
879 | function pointer @code{init_machine_status}. |
880 | @end defmac | |
414c4dc4 | 881 | |
a2c4f8e0 ZW |
882 | @deftypevar {void (*)(struct function *)} init_machine_status |
883 | If this function pointer is non-@code{NULL} it will be called once per | |
884 | function, before function compilation starts, in order to allow the | |
885 | target to perform any target specific initialization of the | |
886 | @code{struct function} structure. It is intended that this would be | |
887 | used to initialize the @code{machine} of that structure. | |
414c4dc4 | 888 | |
8a36672b | 889 | @code{struct machine_function} structures are expected to be freed by GC@. |
e2500fed GK |
890 | Generally, any memory that they reference must be allocated by using |
891 | @code{ggc_alloc}, including the structure itself. | |
a2c4f8e0 | 892 | @end deftypevar |
414c4dc4 | 893 | |
feca2ed3 JW |
894 | @node Storage Layout |
895 | @section Storage Layout | |
896 | @cindex storage layout | |
897 | ||
898 | Note that the definitions of the macros in this table which are sizes or | |
899 | alignments measured in bits do not need to be constant. They can be C | |
900 | expressions that refer to static variables, such as the @code{target_flags}. | |
901 | @xref{Run-time Target}. | |
902 | ||
a2c4f8e0 | 903 | @defmac BITS_BIG_ENDIAN |
feca2ed3 JW |
904 | Define this macro to have the value 1 if the most significant bit in a |
905 | byte has the lowest number; otherwise define it to have the value zero. | |
906 | This means that bit-field instructions count from the most significant | |
907 | bit. If the machine has no bit-field instructions, then this must still | |
908 | be defined, but it doesn't matter which value it is defined to. This | |
909 | macro need not be a constant. | |
910 | ||
911 | This macro does not affect the way structure fields are packed into | |
912 | bytes or words; that is controlled by @code{BYTES_BIG_ENDIAN}. | |
a2c4f8e0 | 913 | @end defmac |
feca2ed3 | 914 | |
a2c4f8e0 | 915 | @defmac BYTES_BIG_ENDIAN |
feca2ed3 JW |
916 | Define this macro to have the value 1 if the most significant byte in a |
917 | word has the lowest number. This macro need not be a constant. | |
a2c4f8e0 | 918 | @end defmac |
feca2ed3 | 919 | |
a2c4f8e0 | 920 | @defmac WORDS_BIG_ENDIAN |
feca2ed3 JW |
921 | Define this macro to have the value 1 if, in a multiword object, the |
922 | most significant word has the lowest number. This applies to both | |
a3a15b4d | 923 | memory locations and registers; GCC fundamentally assumes that the |
feca2ed3 JW |
924 | order of words in memory is the same as the order in registers. This |
925 | macro need not be a constant. | |
a2c4f8e0 | 926 | @end defmac |
feca2ed3 | 927 | |
a2c4f8e0 | 928 | @defmac LIBGCC2_WORDS_BIG_ENDIAN |
aee96fe9 JM |
929 | Define this macro if @code{WORDS_BIG_ENDIAN} is not constant. This must be a |
930 | constant value with the same meaning as @code{WORDS_BIG_ENDIAN}, which will be | |
931 | used only when compiling @file{libgcc2.c}. Typically the value will be set | |
feca2ed3 | 932 | based on preprocessor defines. |
a2c4f8e0 | 933 | @end defmac |
feca2ed3 | 934 | |
a2c4f8e0 | 935 | @defmac FLOAT_WORDS_BIG_ENDIAN |
feca2ed3 JW |
936 | Define this macro to have the value 1 if @code{DFmode}, @code{XFmode} or |
937 | @code{TFmode} floating point numbers are stored in memory with the word | |
938 | containing the sign bit at the lowest address; otherwise define it to | |
939 | have the value 0. This macro need not be a constant. | |
940 | ||
941 | You need not define this macro if the ordering is the same as for | |
942 | multi-word integers. | |
a2c4f8e0 | 943 | @end defmac |
feca2ed3 | 944 | |
a2c4f8e0 | 945 | @defmac BITS_PER_UNIT |
feca2ed3 | 946 | Define this macro to be the number of bits in an addressable storage |
5c60f03d | 947 | unit (byte). If you do not define this macro the default is 8. |
a2c4f8e0 | 948 | @end defmac |
feca2ed3 | 949 | |
a2c4f8e0 | 950 | @defmac BITS_PER_WORD |
e81dd381 KG |
951 | Number of bits in a word. If you do not define this macro, the default |
952 | is @code{BITS_PER_UNIT * UNITS_PER_WORD}. | |
a2c4f8e0 | 953 | @end defmac |
feca2ed3 | 954 | |
a2c4f8e0 | 955 | @defmac MAX_BITS_PER_WORD |
feca2ed3 JW |
956 | Maximum number of bits in a word. If this is undefined, the default is |
957 | @code{BITS_PER_WORD}. Otherwise, it is the constant value that is the | |
958 | largest value that @code{BITS_PER_WORD} can have at run-time. | |
a2c4f8e0 | 959 | @end defmac |
feca2ed3 | 960 | |
a2c4f8e0 | 961 | @defmac UNITS_PER_WORD |
c4336539 PB |
962 | Number of storage units in a word; normally the size of a general-purpose |
963 | register, a power of two from 1 or 8. | |
a2c4f8e0 | 964 | @end defmac |
feca2ed3 | 965 | |
a2c4f8e0 | 966 | @defmac MIN_UNITS_PER_WORD |
feca2ed3 JW |
967 | Minimum number of units in a word. If this is undefined, the default is |
968 | @code{UNITS_PER_WORD}. Otherwise, it is the constant value that is the | |
969 | smallest value that @code{UNITS_PER_WORD} can have at run-time. | |
a2c4f8e0 | 970 | @end defmac |
feca2ed3 | 971 | |
c4336539 PB |
972 | @defmac UNITS_PER_SIMD_WORD |
973 | Number of units in the vectors that the vectorizer can produce. | |
974 | The default is equal to @code{UNITS_PER_WORD}, because the vectorizer | |
975 | can do some transformations even in absence of specialized @acronym{SIMD} | |
976 | hardware. | |
977 | @end defmac | |
978 | ||
a2c4f8e0 | 979 | @defmac POINTER_SIZE |
feca2ed3 JW |
980 | Width of a pointer, in bits. You must specify a value no wider than the |
981 | width of @code{Pmode}. If it is not equal to the width of @code{Pmode}, | |
2465bf76 KG |
982 | you must define @code{POINTERS_EXTEND_UNSIGNED}. If you do not specify |
983 | a value the default is @code{BITS_PER_WORD}. | |
a2c4f8e0 | 984 | @end defmac |
feca2ed3 | 985 | |
a2c4f8e0 | 986 | @defmac POINTERS_EXTEND_UNSIGNED |
6dd12198 | 987 | A C expression whose value is greater than zero if pointers that need to be |
f5963e61 | 988 | extended from being @code{POINTER_SIZE} bits wide to @code{Pmode} are to |
6dd12198 SE |
989 | be zero-extended and zero if they are to be sign-extended. If the value |
990 | is less then zero then there must be an "ptr_extend" instruction that | |
991 | extends a pointer from @code{POINTER_SIZE} to @code{Pmode}. | |
feca2ed3 JW |
992 | |
993 | You need not define this macro if the @code{POINTER_SIZE} is equal | |
994 | to the width of @code{Pmode}. | |
a2c4f8e0 | 995 | @end defmac |
feca2ed3 | 996 | |
a2c4f8e0 | 997 | @defmac PROMOTE_MODE (@var{m}, @var{unsignedp}, @var{type}) |
feca2ed3 JW |
998 | A macro to update @var{m} and @var{unsignedp} when an object whose type |
999 | is @var{type} and which has the specified mode and signedness is to be | |
1000 | stored in a register. This macro is only called when @var{type} is a | |
1001 | scalar type. | |
1002 | ||
1003 | On most RISC machines, which only have operations that operate on a full | |
1004 | register, define this macro to set @var{m} to @code{word_mode} if | |
1005 | @var{m} is an integer mode narrower than @code{BITS_PER_WORD}. In most | |
1006 | cases, only integer modes should be widened because wider-precision | |
1007 | floating-point operations are usually more expensive than their narrower | |
1008 | counterparts. | |
1009 | ||
1010 | For most machines, the macro definition does not change @var{unsignedp}. | |
1011 | However, some machines, have instructions that preferentially handle | |
1012 | either signed or unsigned quantities of certain modes. For example, on | |
1013 | the DEC Alpha, 32-bit loads from memory and 32-bit add instructions | |
1014 | sign-extend the result to 64 bits. On such machines, set | |
1015 | @var{unsignedp} according to which kind of extension is more efficient. | |
1016 | ||
1017 | Do not define this macro if it would never modify @var{m}. | |
a2c4f8e0 | 1018 | @end defmac |
feca2ed3 | 1019 | |
d4453b7a PB |
1020 | @defmac PROMOTE_FUNCTION_MODE |
1021 | Like @code{PROMOTE_MODE}, but is applied to outgoing function arguments or | |
1022 | function return values, as specified by @code{TARGET_PROMOTE_FUNCTION_ARGS} | |
1023 | and @code{TARGET_PROMOTE_FUNCTION_RETURN}, respectively. | |
1024 | ||
1025 | The default is @code{PROMOTE_MODE}. | |
1026 | @end defmac | |
1027 | ||
61f71b34 DD |
1028 | @deftypefn {Target Hook} bool TARGET_PROMOTE_FUNCTION_ARGS (tree @var{fntype}) |
1029 | This target hook should return @code{true} if the promotion described by | |
d4453b7a PB |
1030 | @code{PROMOTE_FUNCTION_MODE} should be done for outgoing function |
1031 | arguments. | |
61f71b34 | 1032 | @end deftypefn |
feca2ed3 | 1033 | |
61f71b34 DD |
1034 | @deftypefn {Target Hook} bool TARGET_PROMOTE_FUNCTION_RETURN (tree @var{fntype}) |
1035 | This target hook should return @code{true} if the promotion described by | |
d4453b7a | 1036 | @code{PROMOTE_FUNCTION_MODE} should be done for the return value of |
61f71b34 | 1037 | functions. |
feca2ed3 | 1038 | |
1b03c58a RG |
1039 | If this target hook returns @code{true}, @code{TARGET_FUNCTION_VALUE} |
1040 | must perform the same promotions done by @code{PROMOTE_FUNCTION_MODE}. | |
61f71b34 | 1041 | @end deftypefn |
feca2ed3 | 1042 | |
a2c4f8e0 | 1043 | @defmac PARM_BOUNDARY |
feca2ed3 JW |
1044 | Normal alignment required for function parameters on the stack, in |
1045 | bits. All stack parameters receive at least this much alignment | |
1046 | regardless of data type. On most machines, this is the same as the | |
1047 | size of an integer. | |
a2c4f8e0 | 1048 | @end defmac |
feca2ed3 | 1049 | |
a2c4f8e0 | 1050 | @defmac STACK_BOUNDARY |
31cdd499 ZW |
1051 | Define this macro to the minimum alignment enforced by hardware for the |
1052 | stack pointer on this machine. The definition is a C expression for the | |
1053 | desired alignment (measured in bits). This value is used as a default | |
1054 | if @code{PREFERRED_STACK_BOUNDARY} is not defined. On most machines, | |
1055 | this should be the same as @code{PARM_BOUNDARY}. | |
a2c4f8e0 | 1056 | @end defmac |
c795bca9 | 1057 | |
a2c4f8e0 | 1058 | @defmac PREFERRED_STACK_BOUNDARY |
31cdd499 ZW |
1059 | Define this macro if you wish to preserve a certain alignment for the |
1060 | stack pointer, greater than what the hardware enforces. The definition | |
1061 | is a C expression for the desired alignment (measured in bits). This | |
1062 | macro must evaluate to a value equal to or larger than | |
1063 | @code{STACK_BOUNDARY}. | |
a2c4f8e0 | 1064 | @end defmac |
feca2ed3 | 1065 | |
a2c4f8e0 | 1066 | @defmac FUNCTION_BOUNDARY |
feca2ed3 | 1067 | Alignment required for a function entry point, in bits. |
a2c4f8e0 | 1068 | @end defmac |
feca2ed3 | 1069 | |
a2c4f8e0 | 1070 | @defmac BIGGEST_ALIGNMENT |
feca2ed3 | 1071 | Biggest alignment that any data type can require on this machine, in bits. |
a2c4f8e0 | 1072 | @end defmac |
feca2ed3 | 1073 | |
a2c4f8e0 | 1074 | @defmac MINIMUM_ATOMIC_ALIGNMENT |
861bb6c1 JL |
1075 | If defined, the smallest alignment, in bits, that can be given to an |
1076 | object that can be referenced in one operation, without disturbing any | |
1077 | nearby object. Normally, this is @code{BITS_PER_UNIT}, but may be larger | |
1078 | on machines that don't have byte or half-word store operations. | |
a2c4f8e0 | 1079 | @end defmac |
861bb6c1 | 1080 | |
a2c4f8e0 | 1081 | @defmac BIGGEST_FIELD_ALIGNMENT |
11cf4d18 JJ |
1082 | Biggest alignment that any structure or union field can require on this |
1083 | machine, in bits. If defined, this overrides @code{BIGGEST_ALIGNMENT} for | |
1084 | structure and union fields only, unless the field alignment has been set | |
1085 | by the @code{__attribute__ ((aligned (@var{n})))} construct. | |
a2c4f8e0 | 1086 | @end defmac |
feca2ed3 | 1087 | |
a2c4f8e0 | 1088 | @defmac ADJUST_FIELD_ALIGN (@var{field}, @var{computed}) |
feca2ed3 | 1089 | An expression for the alignment of a structure field @var{field} if the |
ad9335eb JJ |
1090 | alignment computed in the usual way (including applying of |
1091 | @code{BIGGEST_ALIGNMENT} and @code{BIGGEST_FIELD_ALIGNMENT} to the | |
1092 | alignment) is @var{computed}. It overrides alignment only if the | |
1093 | field alignment has not been set by the | |
1094 | @code{__attribute__ ((aligned (@var{n})))} construct. | |
a2c4f8e0 | 1095 | @end defmac |
feca2ed3 | 1096 | |
a2c4f8e0 | 1097 | @defmac MAX_OFILE_ALIGNMENT |
feca2ed3 JW |
1098 | Biggest alignment supported by the object file format of this machine. |
1099 | Use this macro to limit the alignment which can be specified using the | |
1100 | @code{__attribute__ ((aligned (@var{n})))} construct. If not defined, | |
1101 | the default value is @code{BIGGEST_ALIGNMENT}. | |
11d90e2d CD |
1102 | |
1103 | On systems that use ELF, the default (in @file{config/elfos.h}) is | |
1104 | the largest supported 32-bit ELF section alignment representable on | |
1105 | a 32-bit host e.g. @samp{(((unsigned HOST_WIDEST_INT) 1 << 28) * 8)}. | |
1106 | On 32-bit ELF the largest supported section alignment in bits is | |
1107 | @samp{(0x80000000 * 8)}, but this is not representable on 32-bit hosts. | |
a2c4f8e0 | 1108 | @end defmac |
feca2ed3 | 1109 | |
a2c4f8e0 | 1110 | @defmac DATA_ALIGNMENT (@var{type}, @var{basic-align}) |
a8d1550a | 1111 | If defined, a C expression to compute the alignment for a variable in |
8a198bd2 JW |
1112 | the static store. @var{type} is the data type, and @var{basic-align} is |
1113 | the alignment that the object would ordinarily have. The value of this | |
feca2ed3 JW |
1114 | macro is used instead of that alignment to align the object. |
1115 | ||
1116 | If this macro is not defined, then @var{basic-align} is used. | |
1117 | ||
1118 | @findex strcpy | |
1119 | One use of this macro is to increase alignment of medium-size data to | |
1120 | make it all fit in fewer cache lines. Another is to cause character | |
1121 | arrays to be word-aligned so that @code{strcpy} calls that copy | |
1122 | constants to character arrays can be done inline. | |
a2c4f8e0 | 1123 | @end defmac |
feca2ed3 | 1124 | |
a2c4f8e0 | 1125 | @defmac CONSTANT_ALIGNMENT (@var{constant}, @var{basic-align}) |
feca2ed3 JW |
1126 | If defined, a C expression to compute the alignment given to a constant |
1127 | that is being placed in memory. @var{constant} is the constant and | |
1128 | @var{basic-align} is the alignment that the object would ordinarily | |
1129 | have. The value of this macro is used instead of that alignment to | |
1130 | align the object. | |
1131 | ||
1132 | If this macro is not defined, then @var{basic-align} is used. | |
1133 | ||
1134 | The typical use of this macro is to increase alignment for string | |
1135 | constants to be word aligned so that @code{strcpy} calls that copy | |
1136 | constants can be done inline. | |
a2c4f8e0 | 1137 | @end defmac |
feca2ed3 | 1138 | |
a2c4f8e0 | 1139 | @defmac LOCAL_ALIGNMENT (@var{type}, @var{basic-align}) |
a8d1550a | 1140 | If defined, a C expression to compute the alignment for a variable in |
d16790f2 JW |
1141 | the local store. @var{type} is the data type, and @var{basic-align} is |
1142 | the alignment that the object would ordinarily have. The value of this | |
1143 | macro is used instead of that alignment to align the object. | |
1144 | ||
1145 | If this macro is not defined, then @var{basic-align} is used. | |
1146 | ||
1147 | One use of this macro is to increase alignment of medium-size data to | |
1148 | make it all fit in fewer cache lines. | |
a2c4f8e0 | 1149 | @end defmac |
d16790f2 | 1150 | |
a2c4f8e0 | 1151 | @defmac EMPTY_FIELD_BOUNDARY |
c771326b | 1152 | Alignment in bits to be given to a structure bit-field that follows an |
feca2ed3 JW |
1153 | empty field such as @code{int : 0;}. |
1154 | ||
78d55cc8 | 1155 | If @code{PCC_BITFIELD_TYPE_MATTERS} is true, it overrides this macro. |
a2c4f8e0 | 1156 | @end defmac |
feca2ed3 | 1157 | |
a2c4f8e0 | 1158 | @defmac STRUCTURE_SIZE_BOUNDARY |
feca2ed3 JW |
1159 | Number of bits which any structure or union's size must be a multiple of. |
1160 | Each structure or union's size is rounded up to a multiple of this. | |
1161 | ||
1162 | If you do not define this macro, the default is the same as | |
1163 | @code{BITS_PER_UNIT}. | |
a2c4f8e0 | 1164 | @end defmac |
feca2ed3 | 1165 | |
a2c4f8e0 | 1166 | @defmac STRICT_ALIGNMENT |
feca2ed3 JW |
1167 | Define this macro to be the value 1 if instructions will fail to work |
1168 | if given data not on the nominal alignment. If instructions will merely | |
1169 | go slower in that case, define this macro as 0. | |
a2c4f8e0 | 1170 | @end defmac |
feca2ed3 | 1171 | |
a2c4f8e0 | 1172 | @defmac PCC_BITFIELD_TYPE_MATTERS |
feca2ed3 | 1173 | Define this if you wish to imitate the way many other C compilers handle |
c771326b | 1174 | alignment of bit-fields and the structures that contain them. |
feca2ed3 | 1175 | |
8dc65b6e MM |
1176 | The behavior is that the type written for a named bit-field (@code{int}, |
1177 | @code{short}, or other integer type) imposes an alignment for the entire | |
1178 | structure, as if the structure really did contain an ordinary field of | |
1179 | that type. In addition, the bit-field is placed within the structure so | |
1180 | that it would fit within such a field, not crossing a boundary for it. | |
1181 | ||
1182 | Thus, on most machines, a named bit-field whose type is written as | |
1183 | @code{int} would not cross a four-byte boundary, and would force | |
1184 | four-byte alignment for the whole structure. (The alignment used may | |
1185 | not be four bytes; it is controlled by the other alignment parameters.) | |
1186 | ||
1187 | An unnamed bit-field will not affect the alignment of the containing | |
1188 | structure. | |
feca2ed3 JW |
1189 | |
1190 | If the macro is defined, its definition should be a C expression; | |
1191 | a nonzero value for the expression enables this behavior. | |
1192 | ||
1193 | Note that if this macro is not defined, or its value is zero, some | |
c771326b | 1194 | bit-fields may cross more than one alignment boundary. The compiler can |
feca2ed3 JW |
1195 | support such references if there are @samp{insv}, @samp{extv}, and |
1196 | @samp{extzv} insns that can directly reference memory. | |
1197 | ||
c771326b | 1198 | The other known way of making bit-fields work is to define |
feca2ed3 JW |
1199 | @code{STRUCTURE_SIZE_BOUNDARY} as large as @code{BIGGEST_ALIGNMENT}. |
1200 | Then every structure can be accessed with fullwords. | |
1201 | ||
c771326b | 1202 | Unless the machine has bit-field instructions or you define |
feca2ed3 JW |
1203 | @code{STRUCTURE_SIZE_BOUNDARY} that way, you must define |
1204 | @code{PCC_BITFIELD_TYPE_MATTERS} to have a nonzero value. | |
1205 | ||
a3a15b4d | 1206 | If your aim is to make GCC use the same conventions for laying out |
c771326b | 1207 | bit-fields as are used by another compiler, here is how to investigate |
feca2ed3 JW |
1208 | what the other compiler does. Compile and run this program: |
1209 | ||
3ab51846 | 1210 | @smallexample |
feca2ed3 JW |
1211 | struct foo1 |
1212 | @{ | |
1213 | char x; | |
1214 | char :0; | |
1215 | char y; | |
1216 | @}; | |
1217 | ||
1218 | struct foo2 | |
1219 | @{ | |
1220 | char x; | |
1221 | int :0; | |
1222 | char y; | |
1223 | @}; | |
1224 | ||
1225 | main () | |
1226 | @{ | |
1227 | printf ("Size of foo1 is %d\n", | |
1228 | sizeof (struct foo1)); | |
1229 | printf ("Size of foo2 is %d\n", | |
1230 | sizeof (struct foo2)); | |
1231 | exit (0); | |
1232 | @} | |
3ab51846 | 1233 | @end smallexample |
feca2ed3 JW |
1234 | |
1235 | If this prints 2 and 5, then the compiler's behavior is what you would | |
1236 | get from @code{PCC_BITFIELD_TYPE_MATTERS}. | |
a2c4f8e0 | 1237 | @end defmac |
feca2ed3 | 1238 | |
a2c4f8e0 | 1239 | @defmac BITFIELD_NBYTES_LIMITED |
f913c102 AO |
1240 | Like @code{PCC_BITFIELD_TYPE_MATTERS} except that its effect is limited |
1241 | to aligning a bit-field within the structure. | |
a2c4f8e0 | 1242 | @end defmac |
feca2ed3 | 1243 | |
13c1cd82 PB |
1244 | @deftypefn {Target Hook} bool TARGET_ALIGN_ANON_BITFIELDS (void) |
1245 | When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine | |
1246 | whether unnamed bitfields affect the alignment of the containing | |
1247 | structure. The hook should return true if the structure should inherit | |
1248 | the alignment requirements of an unnamed bitfield's type. | |
1249 | @end deftypefn | |
1250 | ||
c2a64439 PB |
1251 | @deftypefn {Target Hook} bool TARGET_NARROW_VOLATILE_BITFIELDS (void) |
1252 | This target hook should return @code{true} if accesses to volatile bitfields | |
1253 | should use the narrowest mode possible. It should return @code{false} if | |
1254 | these accesses should use the bitfield container type. | |
1255 | ||
1256 | The default is @code{!TARGET_STRICT_ALIGN}. | |
1257 | @end deftypefn | |
1258 | ||
a2c4f8e0 | 1259 | @defmac MEMBER_TYPE_FORCES_BLK (@var{field}, @var{mode}) |
31a02448 | 1260 | Return 1 if a structure or array containing @var{field} should be accessed using |
9f6dc500 HPN |
1261 | @code{BLKMODE}. |
1262 | ||
182e515e AH |
1263 | If @var{field} is the only field in the structure, @var{mode} is its |
1264 | mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the | |
1265 | case where structures of one field would require the structure's mode to | |
1266 | retain the field's mode. | |
1267 | ||
9f6dc500 HPN |
1268 | Normally, this is not needed. See the file @file{c4x.h} for an example |
1269 | of how to use this macro to prevent a structure having a floating point | |
1270 | field from being accessed in an integer mode. | |
a2c4f8e0 | 1271 | @end defmac |
9f6dc500 | 1272 | |
a2c4f8e0 | 1273 | @defmac ROUND_TYPE_ALIGN (@var{type}, @var{computed}, @var{specified}) |
0003feb2 VM |
1274 | Define this macro as an expression for the alignment of a type (given |
1275 | by @var{type} as a tree node) if the alignment computed in the usual | |
1276 | way is @var{computed} and the alignment explicitly specified was | |
feca2ed3 JW |
1277 | @var{specified}. |
1278 | ||
1279 | The default is to use @var{specified} if it is larger; otherwise, use | |
1280 | the smaller of @var{computed} and @code{BIGGEST_ALIGNMENT} | |
a2c4f8e0 | 1281 | @end defmac |
feca2ed3 | 1282 | |
a2c4f8e0 | 1283 | @defmac MAX_FIXED_MODE_SIZE |
feca2ed3 JW |
1284 | An integer expression for the size in bits of the largest integer |
1285 | machine mode that should actually be used. All integer machine modes of | |
1286 | this size or smaller can be used for structures and unions with the | |
1287 | appropriate sizes. If this macro is undefined, @code{GET_MODE_BITSIZE | |
1288 | (DImode)} is assumed. | |
a2c4f8e0 | 1289 | @end defmac |
feca2ed3 | 1290 | |
a2c4f8e0 | 1291 | @defmac STACK_SAVEAREA_MODE (@var{save_level}) |
73c8090f | 1292 | If defined, an expression of type @code{enum machine_mode} that |
39403d82 DE |
1293 | specifies the mode of the save area operand of a |
1294 | @code{save_stack_@var{level}} named pattern (@pxref{Standard Names}). | |
1295 | @var{save_level} is one of @code{SAVE_BLOCK}, @code{SAVE_FUNCTION}, or | |
1296 | @code{SAVE_NONLOCAL} and selects which of the three named patterns is | |
1297 | having its mode specified. | |
73c8090f DE |
1298 | |
1299 | You need not define this macro if it always returns @code{Pmode}. You | |
1300 | would most commonly define this macro if the | |
1301 | @code{save_stack_@var{level}} patterns need to support both a 32- and a | |
1302 | 64-bit mode. | |
a2c4f8e0 | 1303 | @end defmac |
73c8090f | 1304 | |
a2c4f8e0 | 1305 | @defmac STACK_SIZE_MODE |
39403d82 DE |
1306 | If defined, an expression of type @code{enum machine_mode} that |
1307 | specifies the mode of the size increment operand of an | |
1308 | @code{allocate_stack} named pattern (@pxref{Standard Names}). | |
1309 | ||
1310 | You need not define this macro if it always returns @code{word_mode}. | |
1311 | You would most commonly define this macro if the @code{allocate_stack} | |
1312 | pattern needs to support both a 32- and a 64-bit mode. | |
a2c4f8e0 | 1313 | @end defmac |
39403d82 | 1314 | |
a2c4f8e0 | 1315 | @defmac TARGET_FLOAT_FORMAT |
feca2ed3 | 1316 | A code distinguishing the floating point format of the target machine. |
a2c4f8e0 | 1317 | There are four defined values: |
feca2ed3 | 1318 | |
a2c4f8e0 | 1319 | @ftable @code |
feca2ed3 JW |
1320 | @item IEEE_FLOAT_FORMAT |
1321 | This code indicates IEEE floating point. It is the default; there is no | |
a2c4f8e0 | 1322 | need to define @code{TARGET_FLOAT_FORMAT} when the format is IEEE@. |
feca2ed3 | 1323 | |
feca2ed3 | 1324 | @item VAX_FLOAT_FORMAT |
4226378a PK |
1325 | This code indicates the ``F float'' (for @code{float}) and ``D float'' |
1326 | or ``G float'' formats (for @code{double}) used on the VAX and PDP-11@. | |
feca2ed3 | 1327 | |
68eb4fb9 LB |
1328 | @item IBM_FLOAT_FORMAT |
1329 | This code indicates the format used on the IBM System/370. | |
1330 | ||
68eb4fb9 LB |
1331 | @item C4X_FLOAT_FORMAT |
1332 | This code indicates the format used on the TMS320C3x/C4x. | |
a2c4f8e0 | 1333 | @end ftable |
68eb4fb9 | 1334 | |
a2c4f8e0 ZW |
1335 | If your target uses a floating point format other than these, you must |
1336 | define a new @var{name}_FLOAT_FORMAT code for it, and add support for | |
1337 | it to @file{real.c}. | |
feca2ed3 JW |
1338 | |
1339 | The ordering of the component words of floating point values stored in | |
807633e5 | 1340 | memory is controlled by @code{FLOAT_WORDS_BIG_ENDIAN}. |
a2c4f8e0 | 1341 | @end defmac |
e9a25f70 | 1342 | |
a2c4f8e0 | 1343 | @defmac MODE_HAS_NANS (@var{mode}) |
71925bc0 RS |
1344 | When defined, this macro should be true if @var{mode} has a NaN |
1345 | representation. The compiler assumes that NaNs are not equal to | |
1346 | anything (including themselves) and that addition, subtraction, | |
1347 | multiplication and division all return NaNs when one operand is | |
1348 | NaN@. | |
1349 | ||
1350 | By default, this macro is true if @var{mode} is a floating-point | |
1351 | mode and the target floating-point format is IEEE@. | |
a2c4f8e0 | 1352 | @end defmac |
71925bc0 | 1353 | |
a2c4f8e0 | 1354 | @defmac MODE_HAS_INFINITIES (@var{mode}) |
71925bc0 RS |
1355 | This macro should be true if @var{mode} can represent infinity. At |
1356 | present, the compiler uses this macro to decide whether @samp{x - x} | |
1357 | is always defined. By default, the macro is true when @var{mode} | |
1358 | is a floating-point mode and the target format is IEEE@. | |
a2c4f8e0 | 1359 | @end defmac |
71925bc0 | 1360 | |
a2c4f8e0 | 1361 | @defmac MODE_HAS_SIGNED_ZEROS (@var{mode}) |
71925bc0 RS |
1362 | True if @var{mode} distinguishes between positive and negative zero. |
1363 | The rules are expected to follow the IEEE standard: | |
1364 | ||
1365 | @itemize @bullet | |
1366 | @item | |
1367 | @samp{x + x} has the same sign as @samp{x}. | |
1368 | ||
1369 | @item | |
1370 | If the sum of two values with opposite sign is zero, the result is | |
1371 | positive for all rounding modes expect towards @minus{}infinity, for | |
1372 | which it is negative. | |
1373 | ||
1374 | @item | |
1375 | The sign of a product or quotient is negative when exactly one | |
1376 | of the operands is negative. | |
1377 | @end itemize | |
1378 | ||
1379 | The default definition is true if @var{mode} is a floating-point | |
1380 | mode and the target format is IEEE@. | |
a2c4f8e0 | 1381 | @end defmac |
71925bc0 | 1382 | |
a2c4f8e0 | 1383 | @defmac MODE_HAS_SIGN_DEPENDENT_ROUNDING (@var{mode}) |
71925bc0 RS |
1384 | If defined, this macro should be true for @var{mode} if it has at |
1385 | least one rounding mode in which @samp{x} and @samp{-x} can be | |
1386 | rounded to numbers of different magnitude. Two such modes are | |
1387 | towards @minus{}infinity and towards +infinity. | |
1388 | ||
1389 | The default definition of this macro is true if @var{mode} is | |
1390 | a floating-point mode and the target format is IEEE@. | |
a2c4f8e0 | 1391 | @end defmac |
3fcaac1d | 1392 | |
a2c4f8e0 | 1393 | @defmac ROUND_TOWARDS_ZERO |
3fcaac1d RS |
1394 | If defined, this macro should be true if the prevailing rounding |
1395 | mode is towards zero. A true value has the following effects: | |
1396 | ||
1397 | @itemize @bullet | |
1398 | @item | |
1399 | @code{MODE_HAS_SIGN_DEPENDENT_ROUNDING} will be false for all modes. | |
1400 | ||
1401 | @item | |
1402 | @file{libgcc.a}'s floating-point emulator will round towards zero | |
1403 | rather than towards nearest. | |
1404 | ||
1405 | @item | |
1406 | The compiler's floating-point emulator will round towards zero after | |
1407 | doing arithmetic, and when converting from the internal float format to | |
1408 | the target format. | |
1409 | @end itemize | |
1410 | ||
1411 | The macro does not affect the parsing of string literals. When the | |
1412 | primary rounding mode is towards zero, library functions like | |
1413 | @code{strtod} might still round towards nearest, and the compiler's | |
1414 | parser should behave like the target's @code{strtod} where possible. | |
1415 | ||
1416 | Not defining this macro is equivalent to returning zero. | |
a2c4f8e0 | 1417 | @end defmac |
3fcaac1d | 1418 | |
a2c4f8e0 | 1419 | @defmac LARGEST_EXPONENT_IS_NORMAL (@var{size}) |
4226378a | 1420 | This macro should return true if floats with @var{size} |
3fcaac1d RS |
1421 | bits do not have a NaN or infinity representation, but use the largest |
1422 | exponent for normal numbers instead. | |
1423 | ||
1424 | Defining this macro to true for @var{size} causes @code{MODE_HAS_NANS} | |
1425 | and @code{MODE_HAS_INFINITIES} to be false for @var{size}-bit modes. | |
1426 | It also affects the way @file{libgcc.a} and @file{real.c} emulate | |
1427 | floating-point arithmetic. | |
1428 | ||
1429 | The default definition of this macro returns false for all sizes. | |
a2c4f8e0 | 1430 | @end defmac |
feca2ed3 | 1431 | |
c8e4f0e9 AH |
1432 | @deftypefn {Target Hook} bool TARGET_VECTOR_OPAQUE_P (tree @var{type}) |
1433 | This target hook should return @code{true} a vector is opaque. That | |
1434 | is, if no cast is needed when copying a vector value of type | |
1435 | @var{type} into another vector lvalue of the same size. Vector opaque | |
1436 | types cannot be initialized. The default is that there are no such | |
1437 | types. | |
62e1dfcf NC |
1438 | @end deftypefn |
1439 | ||
f913c102 AO |
1440 | @deftypefn {Target Hook} bool TARGET_MS_BITFIELD_LAYOUT_P (tree @var{record_type}) |
1441 | This target hook returns @code{true} if bit-fields in the given | |
1442 | @var{record_type} are to be laid out following the rules of Microsoft | |
1443 | Visual C/C++, namely: (i) a bit-field won't share the same storage | |
1444 | unit with the previous bit-field if their underlying types have | |
1445 | different sizes, and the bit-field will be aligned to the highest | |
1446 | alignment of the underlying types of itself and of the previous | |
1447 | bit-field; (ii) a zero-sized bit-field will affect the alignment of | |
1448 | the whole enclosing structure, even if it is unnamed; except that | |
1449 | (iii) a zero-sized bit-field will be disregarded unless it follows | |
6335b0aa | 1450 | another bit-field of nonzero size. If this hook returns @code{true}, |
f913c102 | 1451 | other macros that control bit-field layout are ignored. |
e4850f36 DR |
1452 | |
1453 | When a bit-field is inserted into a packed record, the whole size | |
1454 | of the underlying type is used by one or more same-size adjacent | |
1455 | bit-fields (that is, if its long:3, 32 bits is used in the record, | |
1456 | and any additional adjacent long bit-fields are packed into the same | |
8a36672b JM |
1457 | chunk of 32 bits. However, if the size changes, a new field of that |
1458 | size is allocated). In an unpacked record, this is the same as using | |
e4850f36 DR |
1459 | alignment, but not equivalent when packing. |
1460 | ||
1461 | If both MS bit-fields and @samp{__attribute__((packed))} are used, | |
8a36672b | 1462 | the latter will take precedence. If @samp{__attribute__((packed))} is |
e4850f36 DR |
1463 | used on a single field when MS bit-fields are in use, it will take |
1464 | precedence for that field, but the alignment of the rest of the structure | |
1465 | may affect its placement. | |
f913c102 AO |
1466 | @end deftypefn |
1467 | ||
9a8ce21f JG |
1468 | @deftypefn {Target Hook} {bool} TARGET_DECIMAL_FLOAT_SUPPORTED_P (void) |
1469 | Returns true if the target supports decimal floating point. | |
9a8ce21f JG |
1470 | @end deftypefn |
1471 | ||
f18eca82 ZL |
1472 | @deftypefn {Target Hook} {const char *} TARGET_MANGLE_FUNDAMENTAL_TYPE (tree @var{type}) |
1473 | If your target defines any fundamental types, define this hook to | |
1474 | return the appropriate encoding for these types as part of a C++ | |
1475 | mangled name. The @var{type} argument is the tree structure | |
1476 | representing the type to be mangled. The hook may be applied to trees | |
1477 | which are not target-specific fundamental types; it should return | |
1478 | @code{NULL} for all such types, as well as arguments it does not | |
1479 | recognize. If the return value is not @code{NULL}, it must point to | |
1480 | a statically-allocated string constant. | |
1481 | ||
1482 | Target-specific fundamental types might be new fundamental types or | |
1483 | qualified versions of ordinary fundamental types. Encode new | |
1484 | fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name} | |
1485 | is the name used for the type in source code, and @var{n} is the | |
1486 | length of @var{name} in decimal. Encode qualified versions of | |
1487 | ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where | |
1488 | @var{name} is the name used for the type qualifier in source code, | |
1489 | @var{n} is the length of @var{name} as above, and @var{code} is the | |
1490 | code used to represent the unqualified version of this type. (See | |
1491 | @code{write_builtin_type} in @file{cp/mangle.c} for the list of | |
1492 | codes.) In both cases the spaces are for clarity; do not include any | |
1493 | spaces in your string. | |
1494 | ||
1495 | The default version of this hook always returns @code{NULL}, which is | |
1496 | appropriate for a target that does not define any new fundamental | |
1497 | types. | |
1498 | @end deftypefn | |
1499 | ||
feca2ed3 JW |
1500 | @node Type Layout |
1501 | @section Layout of Source Language Data Types | |
1502 | ||
1503 | These macros define the sizes and other characteristics of the standard | |
1504 | basic data types used in programs being compiled. Unlike the macros in | |
1505 | the previous section, these apply to specific features of C and related | |
1506 | languages, rather than to fundamental aspects of storage layout. | |
1507 | ||
a2c4f8e0 | 1508 | @defmac INT_TYPE_SIZE |
feca2ed3 JW |
1509 | A C expression for the size in bits of the type @code{int} on the |
1510 | target machine. If you don't define this, the default is one word. | |
a2c4f8e0 | 1511 | @end defmac |
feca2ed3 | 1512 | |
a2c4f8e0 | 1513 | @defmac SHORT_TYPE_SIZE |
feca2ed3 JW |
1514 | A C expression for the size in bits of the type @code{short} on the |
1515 | target machine. If you don't define this, the default is half a word. | |
1516 | (If this would be less than one storage unit, it is rounded up to one | |
1517 | unit.) | |
a2c4f8e0 | 1518 | @end defmac |
feca2ed3 | 1519 | |
a2c4f8e0 | 1520 | @defmac LONG_TYPE_SIZE |
feca2ed3 JW |
1521 | A C expression for the size in bits of the type @code{long} on the |
1522 | target machine. If you don't define this, the default is one word. | |
a2c4f8e0 | 1523 | @end defmac |
feca2ed3 | 1524 | |
a2c4f8e0 | 1525 | @defmac ADA_LONG_TYPE_SIZE |
1615c261 | 1526 | On some machines, the size used for the Ada equivalent of the type |
8a36672b | 1527 | @code{long} by a native Ada compiler differs from that used by C@. In |
1615c261 RK |
1528 | that situation, define this macro to be a C expression to be used for |
1529 | the size of that type. If you don't define this, the default is the | |
1530 | value of @code{LONG_TYPE_SIZE}. | |
a2c4f8e0 | 1531 | @end defmac |
1615c261 | 1532 | |
a2c4f8e0 | 1533 | @defmac LONG_LONG_TYPE_SIZE |
feca2ed3 JW |
1534 | A C expression for the size in bits of the type @code{long long} on the |
1535 | target machine. If you don't define this, the default is two | |
047c1c92 | 1536 | words. If you want to support GNU Ada on your machine, the value of this |
feca2ed3 | 1537 | macro must be at least 64. |
a2c4f8e0 | 1538 | @end defmac |
feca2ed3 | 1539 | |
a2c4f8e0 | 1540 | @defmac CHAR_TYPE_SIZE |
feca2ed3 | 1541 | A C expression for the size in bits of the type @code{char} on the |
c294bd99 HPN |
1542 | target machine. If you don't define this, the default is |
1543 | @code{BITS_PER_UNIT}. | |
a2c4f8e0 | 1544 | @end defmac |
feca2ed3 | 1545 | |
a2c4f8e0 | 1546 | @defmac BOOL_TYPE_SIZE |
3d1ad9e5 JM |
1547 | A C expression for the size in bits of the C++ type @code{bool} and |
1548 | C99 type @code{_Bool} on the target machine. If you don't define | |
1549 | this, and you probably shouldn't, the default is @code{CHAR_TYPE_SIZE}. | |
a2c4f8e0 | 1550 | @end defmac |
68eb4fb9 | 1551 | |
a2c4f8e0 | 1552 | @defmac FLOAT_TYPE_SIZE |
feca2ed3 JW |
1553 | A C expression for the size in bits of the type @code{float} on the |
1554 | target machine. If you don't define this, the default is one word. | |
a2c4f8e0 | 1555 | @end defmac |
feca2ed3 | 1556 | |
a2c4f8e0 | 1557 | @defmac DOUBLE_TYPE_SIZE |
feca2ed3 JW |
1558 | A C expression for the size in bits of the type @code{double} on the |
1559 | target machine. If you don't define this, the default is two | |
1560 | words. | |
a2c4f8e0 | 1561 | @end defmac |
feca2ed3 | 1562 | |
a2c4f8e0 | 1563 | @defmac LONG_DOUBLE_TYPE_SIZE |
feca2ed3 JW |
1564 | A C expression for the size in bits of the type @code{long double} on |
1565 | the target machine. If you don't define this, the default is two | |
1566 | words. | |
a2c4f8e0 | 1567 | @end defmac |
feca2ed3 | 1568 | |
4e9db8b2 SE |
1569 | @defmac LIBGCC2_LONG_DOUBLE_TYPE_SIZE |
1570 | Define this macro if @code{LONG_DOUBLE_TYPE_SIZE} is not constant or | |
1571 | if you want routines in @file{libgcc2.a} for a size other than | |
1572 | @code{LONG_DOUBLE_TYPE_SIZE}. If you don't define this, the | |
1573 | default is @code{LONG_DOUBLE_TYPE_SIZE}. | |
1574 | @end defmac | |
1575 | ||
1576 | @defmac LIBGCC2_HAS_DF_MODE | |
083cad55 | 1577 | Define this macro if neither @code{LIBGCC2_DOUBLE_TYPE_SIZE} nor |
4e9db8b2 SE |
1578 | @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is |
1579 | @code{DFmode} but you want @code{DFmode} routines in @file{libgcc2.a} | |
1580 | anyway. If you don't define this and either @code{LIBGCC2_DOUBLE_TYPE_SIZE} | |
1581 | or @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is 64 then the default is 1, | |
1582 | otherwise it is 0. | |
1583 | @end defmac | |
1584 | ||
1585 | @defmac LIBGCC2_HAS_XF_MODE | |
083cad55 | 1586 | Define this macro if @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is not |
4e9db8b2 SE |
1587 | @code{XFmode} but you want @code{XFmode} routines in @file{libgcc2.a} |
1588 | anyway. If you don't define this and @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} | |
1589 | is 80 then the default is 1, otherwise it is 0. | |
1590 | @end defmac | |
1591 | ||
1592 | @defmac LIBGCC2_HAS_TF_MODE | |
083cad55 | 1593 | Define this macro if @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is not |
4e9db8b2 SE |
1594 | @code{TFmode} but you want @code{TFmode} routines in @file{libgcc2.a} |
1595 | anyway. If you don't define this and @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} | |
1596 | is 128 then the default is 1, otherwise it is 0. | |
1597 | @end defmac | |
1598 | ||
4a73d865 JM |
1599 | @defmac SF_SIZE |
1600 | @defmacx DF_SIZE | |
1601 | @defmacx XF_SIZE | |
1602 | @defmacx TF_SIZE | |
1603 | Define these macros to be the size in bits of the mantissa of | |
1604 | @code{SFmode}, @code{DFmode}, @code{XFmode} and @code{TFmode} values, | |
1605 | if the defaults in @file{libgcc2.h} are inappropriate. By default, | |
1606 | @code{FLT_MANT_DIG} is used for @code{SF_SIZE}, @code{LDBL_MANT_DIG} | |
1607 | for @code{XF_SIZE} and @code{TF_SIZE}, and @code{DBL_MANT_DIG} or | |
1608 | @code{LDBL_MANT_DIG} for @code{DF_SIZE} according to whether | |
1609 | @code{LIBGCC2_DOUBLE_TYPE_SIZE} or | |
1610 | @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is 64. | |
1611 | @end defmac | |
1612 | ||
a2c4f8e0 | 1613 | @defmac TARGET_FLT_EVAL_METHOD |
d57a4b98 RH |
1614 | A C expression for the value for @code{FLT_EVAL_METHOD} in @file{float.h}, |
1615 | assuming, if applicable, that the floating-point control word is in its | |
1616 | default state. If you do not define this macro the value of | |
1617 | @code{FLT_EVAL_METHOD} will be zero. | |
a2c4f8e0 | 1618 | @end defmac |
aaa2e8ef | 1619 | |
a2c4f8e0 | 1620 | @defmac WIDEST_HARDWARE_FP_SIZE |
e9a25f70 JL |
1621 | A C expression for the size in bits of the widest floating-point format |
1622 | supported by the hardware. If you define this macro, you must specify a | |
1623 | value less than or equal to the value of @code{LONG_DOUBLE_TYPE_SIZE}. | |
1624 | If you do not define this macro, the value of @code{LONG_DOUBLE_TYPE_SIZE} | |
1625 | is the default. | |
a2c4f8e0 | 1626 | @end defmac |
e9a25f70 | 1627 | |
a2c4f8e0 | 1628 | @defmac DEFAULT_SIGNED_CHAR |
feca2ed3 JW |
1629 | An expression whose value is 1 or 0, according to whether the type |
1630 | @code{char} should be signed or unsigned by default. The user can | |
630d3d5a JM |
1631 | always override this default with the options @option{-fsigned-char} |
1632 | and @option{-funsigned-char}. | |
a2c4f8e0 | 1633 | @end defmac |
feca2ed3 | 1634 | |
221ee7c9 KH |
1635 | @deftypefn {Target Hook} bool TARGET_DEFAULT_SHORT_ENUMS (void) |
1636 | This target hook should return true if the compiler should give an | |
1637 | @code{enum} type only as many bytes as it takes to represent the range | |
1638 | of possible values of that type. It should return false if all | |
35afa569 KH |
1639 | @code{enum} types should be allocated like @code{int}. |
1640 | ||
221ee7c9 KH |
1641 | The default is to return false. |
1642 | @end deftypefn | |
35afa569 | 1643 | |
a2c4f8e0 | 1644 | @defmac SIZE_TYPE |
feca2ed3 JW |
1645 | A C expression for a string describing the name of the data type to use |
1646 | for size values. The typedef name @code{size_t} is defined using the | |
1647 | contents of the string. | |
1648 | ||
1649 | The string can contain more than one keyword. If so, separate them with | |
1650 | spaces, and write first any length keyword, then @code{unsigned} if | |
1651 | appropriate, and finally @code{int}. The string must exactly match one | |
1652 | of the data type names defined in the function | |
1653 | @code{init_decl_processing} in the file @file{c-decl.c}. You may not | |
1654 | omit @code{int} or change the order---that would cause the compiler to | |
1655 | crash on startup. | |
1656 | ||
1657 | If you don't define this macro, the default is @code{"long unsigned | |
1658 | int"}. | |
a2c4f8e0 | 1659 | @end defmac |
feca2ed3 | 1660 | |
a2c4f8e0 | 1661 | @defmac PTRDIFF_TYPE |
feca2ed3 JW |
1662 | A C expression for a string describing the name of the data type to use |
1663 | for the result of subtracting two pointers. The typedef name | |
1664 | @code{ptrdiff_t} is defined using the contents of the string. See | |
1665 | @code{SIZE_TYPE} above for more information. | |
1666 | ||
1667 | If you don't define this macro, the default is @code{"long int"}. | |
a2c4f8e0 | 1668 | @end defmac |
feca2ed3 | 1669 | |
a2c4f8e0 | 1670 | @defmac WCHAR_TYPE |
feca2ed3 JW |
1671 | A C expression for a string describing the name of the data type to use |
1672 | for wide characters. The typedef name @code{wchar_t} is defined using | |
1673 | the contents of the string. See @code{SIZE_TYPE} above for more | |
1674 | information. | |
1675 | ||
1676 | If you don't define this macro, the default is @code{"int"}. | |
a2c4f8e0 | 1677 | @end defmac |
feca2ed3 | 1678 | |
a2c4f8e0 | 1679 | @defmac WCHAR_TYPE_SIZE |
feca2ed3 JW |
1680 | A C expression for the size in bits of the data type for wide |
1681 | characters. This is used in @code{cpp}, which cannot make use of | |
1682 | @code{WCHAR_TYPE}. | |
a2c4f8e0 | 1683 | @end defmac |
feca2ed3 | 1684 | |
a2c4f8e0 | 1685 | @defmac WINT_TYPE |
1a67c7d3 JL |
1686 | A C expression for a string describing the name of the data type to |
1687 | use for wide characters passed to @code{printf} and returned from | |
1688 | @code{getwc}. The typedef name @code{wint_t} is defined using the | |
1689 | contents of the string. See @code{SIZE_TYPE} above for more | |
1690 | information. | |
1691 | ||
1692 | If you don't define this macro, the default is @code{"unsigned int"}. | |
a2c4f8e0 | 1693 | @end defmac |
1a67c7d3 | 1694 | |
a2c4f8e0 | 1695 | @defmac INTMAX_TYPE |
b15ad712 JM |
1696 | A C expression for a string describing the name of the data type that |
1697 | can represent any value of any standard or extended signed integer type. | |
1698 | The typedef name @code{intmax_t} is defined using the contents of the | |
1699 | string. See @code{SIZE_TYPE} above for more information. | |
1700 | ||
1701 | If you don't define this macro, the default is the first of | |
1702 | @code{"int"}, @code{"long int"}, or @code{"long long int"} that has as | |
1703 | much precision as @code{long long int}. | |
a2c4f8e0 | 1704 | @end defmac |
b15ad712 | 1705 | |
a2c4f8e0 | 1706 | @defmac UINTMAX_TYPE |
b15ad712 JM |
1707 | A C expression for a string describing the name of the data type that |
1708 | can represent any value of any standard or extended unsigned integer | |
1709 | type. The typedef name @code{uintmax_t} is defined using the contents | |
1710 | of the string. See @code{SIZE_TYPE} above for more information. | |
1711 | ||
1712 | If you don't define this macro, the default is the first of | |
1713 | @code{"unsigned int"}, @code{"long unsigned int"}, or @code{"long long | |
1714 | unsigned int"} that has as much precision as @code{long long unsigned | |
1715 | int}. | |
a2c4f8e0 | 1716 | @end defmac |
b15ad712 | 1717 | |
a2c4f8e0 | 1718 | @defmac TARGET_PTRMEMFUNC_VBIT_LOCATION |
f3c55c97 AO |
1719 | The C++ compiler represents a pointer-to-member-function with a struct |
1720 | that looks like: | |
1721 | ||
3ab51846 | 1722 | @smallexample |
f3c55c97 AO |
1723 | struct @{ |
1724 | union @{ | |
1725 | void (*fn)(); | |
1726 | ptrdiff_t vtable_index; | |
1727 | @}; | |
1728 | ptrdiff_t delta; | |
1729 | @}; | |
3ab51846 | 1730 | @end smallexample |
f3c55c97 AO |
1731 | |
1732 | @noindent | |
1733 | The C++ compiler must use one bit to indicate whether the function that | |
1734 | will be called through a pointer-to-member-function is virtual. | |
1735 | Normally, we assume that the low-order bit of a function pointer must | |
1736 | always be zero. Then, by ensuring that the vtable_index is odd, we can | |
1737 | distinguish which variant of the union is in use. But, on some | |
1738 | platforms function pointers can be odd, and so this doesn't work. In | |
1739 | that case, we use the low-order bit of the @code{delta} field, and shift | |
1740 | the remainder of the @code{delta} field to the left. | |
1741 | ||
1742 | GCC will automatically make the right selection about where to store | |
1743 | this bit using the @code{FUNCTION_BOUNDARY} setting for your platform. | |
1744 | However, some platforms such as ARM/Thumb have @code{FUNCTION_BOUNDARY} | |
1745 | set such that functions always start at even addresses, but the lowest | |
1746 | bit of pointers to functions indicate whether the function at that | |
1747 | address is in ARM or Thumb mode. If this is the case of your | |
1748 | architecture, you should define this macro to | |
1749 | @code{ptrmemfunc_vbit_in_delta}. | |
1750 | ||
1751 | In general, you should not have to define this macro. On architectures | |
1752 | in which function addresses are always even, according to | |
1753 | @code{FUNCTION_BOUNDARY}, GCC will automatically define this macro to | |
1754 | @code{ptrmemfunc_vbit_in_pfn}. | |
a2c4f8e0 | 1755 | @end defmac |
67231816 | 1756 | |
a2c4f8e0 | 1757 | @defmac TARGET_VTABLE_USES_DESCRIPTORS |
67231816 | 1758 | Normally, the C++ compiler uses function pointers in vtables. This |
f282ffb3 | 1759 | macro allows the target to change to use ``function descriptors'' |
67231816 RH |
1760 | instead. Function descriptors are found on targets for whom a |
1761 | function pointer is actually a small data structure. Normally the | |
f282ffb3 | 1762 | data structure consists of the actual code address plus a data |
67231816 RH |
1763 | pointer to which the function's data is relative. |
1764 | ||
1765 | If vtables are used, the value of this macro should be the number | |
1766 | of words that the function descriptor occupies. | |
a2c4f8e0 | 1767 | @end defmac |
a6f5e048 | 1768 | |
a2c4f8e0 | 1769 | @defmac TARGET_VTABLE_ENTRY_ALIGN |
a6f5e048 RH |
1770 | By default, the vtable entries are void pointers, the so the alignment |
1771 | is the same as pointer alignment. The value of this macro specifies | |
1772 | the alignment of the vtable entry in bits. It should be defined only | |
1773 | when special alignment is necessary. */ | |
a2c4f8e0 | 1774 | @end defmac |
a6f5e048 | 1775 | |
a2c4f8e0 | 1776 | @defmac TARGET_VTABLE_DATA_ENTRY_DISTANCE |
a6f5e048 RH |
1777 | There are a few non-descriptor entries in the vtable at offsets below |
1778 | zero. If these entries must be padded (say, to preserve the alignment | |
1779 | specified by @code{TARGET_VTABLE_ENTRY_ALIGN}), set this to the number | |
1780 | of words in each data entry. | |
a2c4f8e0 | 1781 | @end defmac |
b2b263e1 | 1782 | |
feca2ed3 JW |
1783 | @node Registers |
1784 | @section Register Usage | |
1785 | @cindex register usage | |
1786 | ||
1787 | This section explains how to describe what registers the target machine | |
1788 | has, and how (in general) they can be used. | |
1789 | ||
1790 | The description of which registers a specific instruction can use is | |
1791 | done with register classes; see @ref{Register Classes}. For information | |
1792 | on using registers to access a stack frame, see @ref{Frame Registers}. | |
1793 | For passing values in registers, see @ref{Register Arguments}. | |
1794 | For returning values in registers, see @ref{Scalar Return}. | |
1795 | ||
1796 | @menu | |
1797 | * Register Basics:: Number and kinds of registers. | |
1798 | * Allocation Order:: Order in which registers are allocated. | |
1799 | * Values in Registers:: What kinds of values each reg can hold. | |
1800 | * Leaf Functions:: Renumbering registers for leaf functions. | |
1801 | * Stack Registers:: Handling a register stack such as 80387. | |
feca2ed3 JW |
1802 | @end menu |
1803 | ||
1804 | @node Register Basics | |
1805 | @subsection Basic Characteristics of Registers | |
1806 | ||
1807 | @c prevent bad page break with this line | |
1808 | Registers have various characteristics. | |
1809 | ||
a2c4f8e0 | 1810 | @defmac FIRST_PSEUDO_REGISTER |
feca2ed3 JW |
1811 | Number of hardware registers known to the compiler. They receive |
1812 | numbers 0 through @code{FIRST_PSEUDO_REGISTER-1}; thus, the first | |
1813 | pseudo register's number really is assigned the number | |
1814 | @code{FIRST_PSEUDO_REGISTER}. | |
a2c4f8e0 | 1815 | @end defmac |
feca2ed3 | 1816 | |
a2c4f8e0 | 1817 | @defmac FIXED_REGISTERS |
feca2ed3 JW |
1818 | @cindex fixed register |
1819 | An initializer that says which registers are used for fixed purposes | |
1820 | all throughout the compiled code and are therefore not available for | |
1821 | general allocation. These would include the stack pointer, the frame | |
1822 | pointer (except on machines where that can be used as a general | |
1823 | register when no frame pointer is needed), the program counter on | |
1824 | machines where that is considered one of the addressable registers, | |
1825 | and any other numbered register with a standard use. | |
1826 | ||
1827 | This information is expressed as a sequence of numbers, separated by | |
1828 | commas and surrounded by braces. The @var{n}th number is 1 if | |
1829 | register @var{n} is fixed, 0 otherwise. | |
1830 | ||
1831 | The table initialized from this macro, and the table initialized by | |
1832 | the following one, may be overridden at run time either automatically, | |
1833 | by the actions of the macro @code{CONDITIONAL_REGISTER_USAGE}, or by | |
630d3d5a JM |
1834 | the user with the command options @option{-ffixed-@var{reg}}, |
1835 | @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}. | |
a2c4f8e0 | 1836 | @end defmac |
feca2ed3 | 1837 | |
a2c4f8e0 | 1838 | @defmac CALL_USED_REGISTERS |
feca2ed3 JW |
1839 | @cindex call-used register |
1840 | @cindex call-clobbered register | |
1841 | @cindex call-saved register | |
1842 | Like @code{FIXED_REGISTERS} but has 1 for each register that is | |
1843 | clobbered (in general) by function calls as well as for fixed | |
1844 | registers. This macro therefore identifies the registers that are not | |
1845 | available for general allocation of values that must live across | |
1846 | function calls. | |
1847 | ||
1848 | If a register has 0 in @code{CALL_USED_REGISTERS}, the compiler | |
1849 | automatically saves it on function entry and restores it on function | |
1850 | exit, if the register is used within the function. | |
a2c4f8e0 | 1851 | @end defmac |
feca2ed3 | 1852 | |
a2c4f8e0 | 1853 | @defmac CALL_REALLY_USED_REGISTERS |
fc1296b7 AM |
1854 | @cindex call-used register |
1855 | @cindex call-clobbered register | |
1856 | @cindex call-saved register | |
f282ffb3 JM |
1857 | Like @code{CALL_USED_REGISTERS} except this macro doesn't require |
1858 | that the entire set of @code{FIXED_REGISTERS} be included. | |
fc1296b7 | 1859 | (@code{CALL_USED_REGISTERS} must be a superset of @code{FIXED_REGISTERS}). |
f282ffb3 | 1860 | This macro is optional. If not specified, it defaults to the value |
fc1296b7 | 1861 | of @code{CALL_USED_REGISTERS}. |
a2c4f8e0 | 1862 | @end defmac |
fc1296b7 | 1863 | |
a2c4f8e0 | 1864 | @defmac HARD_REGNO_CALL_PART_CLOBBERED (@var{regno}, @var{mode}) |
1e326708 MH |
1865 | @cindex call-used register |
1866 | @cindex call-clobbered register | |
1867 | @cindex call-saved register | |
df2a54e9 | 1868 | A C expression that is nonzero if it is not permissible to store a |
1e326708 MH |
1869 | value of mode @var{mode} in hard register number @var{regno} across a |
1870 | call without some part of it being clobbered. For most machines this | |
1871 | macro need not be defined. It is only required for machines that do not | |
1872 | preserve the entire contents of a register across a call. | |
a2c4f8e0 | 1873 | @end defmac |
1e326708 | 1874 | |
feca2ed3 JW |
1875 | @findex fixed_regs |
1876 | @findex call_used_regs | |
a2c4f8e0 ZW |
1877 | @findex global_regs |
1878 | @findex reg_names | |
1879 | @findex reg_class_contents | |
1880 | @defmac CONDITIONAL_REGISTER_USAGE | |
055177dc NC |
1881 | Zero or more C statements that may conditionally modify five variables |
1882 | @code{fixed_regs}, @code{call_used_regs}, @code{global_regs}, | |
c237e94a ZW |
1883 | @code{reg_names}, and @code{reg_class_contents}, to take into account |
1884 | any dependence of these register sets on target flags. The first three | |
1885 | of these are of type @code{char []} (interpreted as Boolean vectors). | |
1886 | @code{global_regs} is a @code{const char *[]}, and | |
1887 | @code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is | |
1888 | called, @code{fixed_regs}, @code{call_used_regs}, | |
1889 | @code{reg_class_contents}, and @code{reg_names} have been initialized | |
055177dc | 1890 | from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS}, |
c237e94a | 1891 | @code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively. |
630d3d5a | 1892 | @code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}}, |
c237e94a ZW |
1893 | @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}} |
1894 | command options have been applied. | |
feca2ed3 JW |
1895 | |
1896 | You need not define this macro if it has no work to do. | |
1897 | ||
1898 | @cindex disabling certain registers | |
1899 | @cindex controlling register usage | |
1900 | If the usage of an entire class of registers depends on the target | |
1901 | flags, you may indicate this to GCC by using this macro to modify | |
1902 | @code{fixed_regs} and @code{call_used_regs} to 1 for each of the | |
161d7b59 | 1903 | registers in the classes which should not be used by GCC@. Also define |
97488870 R |
1904 | the macro @code{REG_CLASS_FROM_LETTER} / @code{REG_CLASS_FROM_CONSTRAINT} |
1905 | to return @code{NO_REGS} if it | |
feca2ed3 JW |
1906 | is called with a letter for a class that shouldn't be used. |
1907 | ||
1908 | (However, if this class is not included in @code{GENERAL_REGS} and all | |
1909 | of the insn patterns whose constraints permit this class are | |
1910 | controlled by target switches, then GCC will automatically avoid using | |
1911 | these registers when the target switches are opposed to them.) | |
a2c4f8e0 | 1912 | @end defmac |
feca2ed3 | 1913 | |
a2c4f8e0 | 1914 | @defmac INCOMING_REGNO (@var{out}) |
feca2ed3 JW |
1915 | Define this macro if the target machine has register windows. This C |
1916 | expression returns the register number as seen by the called function | |
1917 | corresponding to the register number @var{out} as seen by the calling | |
1918 | function. Return @var{out} if register number @var{out} is not an | |
1919 | outbound register. | |
a2c4f8e0 | 1920 | @end defmac |
feca2ed3 | 1921 | |
a2c4f8e0 | 1922 | @defmac OUTGOING_REGNO (@var{in}) |
feca2ed3 JW |
1923 | Define this macro if the target machine has register windows. This C |
1924 | expression returns the register number as seen by the calling function | |
1925 | corresponding to the register number @var{in} as seen by the called | |
1926 | function. Return @var{in} if register number @var{in} is not an inbound | |
1927 | register. | |
a2c4f8e0 | 1928 | @end defmac |
feca2ed3 | 1929 | |
a2c4f8e0 | 1930 | @defmac LOCAL_REGNO (@var{regno}) |
fa80e43d JL |
1931 | Define this macro if the target machine has register windows. This C |
1932 | expression returns true if the register is call-saved but is in the | |
1933 | register window. Unlike most call-saved registers, such registers | |
1934 | need not be explicitly restored on function exit or during non-local | |
1935 | gotos. | |
a2c4f8e0 | 1936 | @end defmac |
fa80e43d | 1937 | |
a2c4f8e0 | 1938 | @defmac PC_REGNUM |
feca2ed3 JW |
1939 | If the program counter has a register number, define this as that |
1940 | register number. Otherwise, do not define it. | |
a2c4f8e0 | 1941 | @end defmac |
feca2ed3 JW |
1942 | |
1943 | @node Allocation Order | |
1944 | @subsection Order of Allocation of Registers | |
1945 | @cindex order of register allocation | |
1946 | @cindex register allocation order | |
1947 | ||
1948 | @c prevent bad page break with this line | |
1949 | Registers are allocated in order. | |
1950 | ||
a2c4f8e0 | 1951 | @defmac REG_ALLOC_ORDER |
feca2ed3 | 1952 | If defined, an initializer for a vector of integers, containing the |
a3a15b4d | 1953 | numbers of hard registers in the order in which GCC should prefer |
feca2ed3 JW |
1954 | to use them (from most preferred to least). |
1955 | ||
1956 | If this macro is not defined, registers are used lowest numbered first | |
1957 | (all else being equal). | |
1958 | ||
1959 | One use of this macro is on machines where the highest numbered | |
1960 | registers must always be saved and the save-multiple-registers | |
1961 | instruction supports only sequences of consecutive registers. On such | |
1962 | machines, define @code{REG_ALLOC_ORDER} to be an initializer that lists | |
956d6950 | 1963 | the highest numbered allocable register first. |
a2c4f8e0 | 1964 | @end defmac |
feca2ed3 | 1965 | |
a2c4f8e0 | 1966 | @defmac ORDER_REGS_FOR_LOCAL_ALLOC |
feca2ed3 JW |
1967 | A C statement (sans semicolon) to choose the order in which to allocate |
1968 | hard registers for pseudo-registers local to a basic block. | |
1969 | ||
1970 | Store the desired register order in the array @code{reg_alloc_order}. | |
1971 | Element 0 should be the register to allocate first; element 1, the next | |
1972 | register; and so on. | |
1973 | ||
1974 | The macro body should not assume anything about the contents of | |
1975 | @code{reg_alloc_order} before execution of the macro. | |
1976 | ||
1977 | On most machines, it is not necessary to define this macro. | |
a2c4f8e0 | 1978 | @end defmac |
feca2ed3 JW |
1979 | |
1980 | @node Values in Registers | |
1981 | @subsection How Values Fit in Registers | |
1982 | ||
1983 | This section discusses the macros that describe which kinds of values | |
1984 | (specifically, which machine modes) each register can hold, and how many | |
1985 | consecutive registers are needed for a given mode. | |
1986 | ||
a2c4f8e0 | 1987 | @defmac HARD_REGNO_NREGS (@var{regno}, @var{mode}) |
feca2ed3 JW |
1988 | A C expression for the number of consecutive hard registers, starting |
1989 | at register number @var{regno}, required to hold a value of mode | |
1990 | @var{mode}. | |
1991 | ||
1992 | On a machine where all registers are exactly one word, a suitable | |
1993 | definition of this macro is | |
1994 | ||
1995 | @smallexample | |
1996 | #define HARD_REGNO_NREGS(REGNO, MODE) \ | |
1997 | ((GET_MODE_SIZE (MODE) + UNITS_PER_WORD - 1) \ | |
32bd3974 | 1998 | / UNITS_PER_WORD) |
feca2ed3 | 1999 | @end smallexample |
a2c4f8e0 | 2000 | @end defmac |
feca2ed3 | 2001 | |
8521c414 JM |
2002 | @defmac HARD_REGNO_NREGS_HAS_PADDING (@var{regno}, @var{mode}) |
2003 | A C expression that is nonzero if a value of mode @var{mode}, stored | |
2004 | in memory, ends with padding that causes it to take up more space than | |
2005 | in registers starting at register number @var{regno} (as determined by | |
2006 | multiplying GCC's notion of the size of the register when containing | |
2007 | this mode by the number of registers returned by | |
2008 | @code{HARD_REGNO_NREGS}). By default this is zero. | |
2009 | ||
2010 | For example, if a floating-point value is stored in three 32-bit | |
2011 | registers but takes up 128 bits in memory, then this would be | |
2012 | nonzero. | |
2013 | ||
2014 | This macros only needs to be defined if there are cases where | |
f1f4e530 | 2015 | @code{subreg_get_info} |
8521c414 JM |
2016 | would otherwise wrongly determine that a @code{subreg} can be |
2017 | represented by an offset to the register number, when in fact such a | |
2018 | @code{subreg} would contain some of the padding not stored in | |
2019 | registers and so not be representable. | |
2020 | @end defmac | |
2021 | ||
2022 | @defmac HARD_REGNO_NREGS_WITH_PADDING (@var{regno}, @var{mode}) | |
2023 | For values of @var{regno} and @var{mode} for which | |
2024 | @code{HARD_REGNO_NREGS_HAS_PADDING} returns nonzero, a C expression | |
2025 | returning the greater number of registers required to hold the value | |
2026 | including any padding. In the example above, the value would be four. | |
2027 | @end defmac | |
2028 | ||
ca0b6e3b EB |
2029 | @defmac REGMODE_NATURAL_SIZE (@var{mode}) |
2030 | Define this macro if the natural size of registers that hold values | |
2031 | of mode @var{mode} is not the word size. It is a C expression that | |
2032 | should give the natural size in bytes for the specified mode. It is | |
2033 | used by the register allocator to try to optimize its results. This | |
2034 | happens for example on SPARC 64-bit where the natural size of | |
2035 | floating-point registers is still 32-bit. | |
2036 | @end defmac | |
2037 | ||
a2c4f8e0 | 2038 | @defmac HARD_REGNO_MODE_OK (@var{regno}, @var{mode}) |
feca2ed3 JW |
2039 | A C expression that is nonzero if it is permissible to store a value |
2040 | of mode @var{mode} in hard register number @var{regno} (or in several | |
2041 | registers starting with that one). For a machine where all registers | |
2042 | are equivalent, a suitable definition is | |
2043 | ||
2044 | @smallexample | |
2045 | #define HARD_REGNO_MODE_OK(REGNO, MODE) 1 | |
2046 | @end smallexample | |
2047 | ||
e9a25f70 JL |
2048 | You need not include code to check for the numbers of fixed registers, |
2049 | because the allocation mechanism considers them to be always occupied. | |
feca2ed3 JW |
2050 | |
2051 | @cindex register pairs | |
2052 | On some machines, double-precision values must be kept in even/odd | |
e9a25f70 JL |
2053 | register pairs. You can implement that by defining this macro to reject |
2054 | odd register numbers for such modes. | |
feca2ed3 JW |
2055 | |
2056 | The minimum requirement for a mode to be OK in a register is that the | |
2057 | @samp{mov@var{mode}} instruction pattern support moves between the | |
e9a25f70 JL |
2058 | register and other hard register in the same class and that moving a |
2059 | value into the register and back out not alter it. | |
feca2ed3 | 2060 | |
e9a25f70 JL |
2061 | Since the same instruction used to move @code{word_mode} will work for |
2062 | all narrower integer modes, it is not necessary on any machine for | |
feca2ed3 JW |
2063 | @code{HARD_REGNO_MODE_OK} to distinguish between these modes, provided |
2064 | you define patterns @samp{movhi}, etc., to take advantage of this. This | |
2065 | is useful because of the interaction between @code{HARD_REGNO_MODE_OK} | |
2066 | and @code{MODES_TIEABLE_P}; it is very desirable for all integer modes | |
2067 | to be tieable. | |
2068 | ||
2069 | Many machines have special registers for floating point arithmetic. | |
2070 | Often people assume that floating point machine modes are allowed only | |
2071 | in floating point registers. This is not true. Any registers that | |
2072 | can hold integers can safely @emph{hold} a floating point machine | |
2073 | mode, whether or not floating arithmetic can be done on it in those | |
2074 | registers. Integer move instructions can be used to move the values. | |
2075 | ||
2076 | On some machines, though, the converse is true: fixed-point machine | |
2077 | modes may not go in floating registers. This is true if the floating | |
2078 | registers normalize any value stored in them, because storing a | |
2079 | non-floating value there would garble it. In this case, | |
2080 | @code{HARD_REGNO_MODE_OK} should reject fixed-point machine modes in | |
2081 | floating registers. But if the floating registers do not automatically | |
2082 | normalize, if you can store any bit pattern in one and retrieve it | |
2083 | unchanged without a trap, then any machine mode may go in a floating | |
2084 | register, so you can define this macro to say so. | |
2085 | ||
2086 | The primary significance of special floating registers is rather that | |
2087 | they are the registers acceptable in floating point arithmetic | |
2088 | instructions. However, this is of no concern to | |
2089 | @code{HARD_REGNO_MODE_OK}. You handle it by writing the proper | |
2090 | constraints for those instructions. | |
2091 | ||
2092 | On some machines, the floating registers are especially slow to access, | |
2093 | so that it is better to store a value in a stack frame than in such a | |
2094 | register if floating point arithmetic is not being done. As long as the | |
2095 | floating registers are not in class @code{GENERAL_REGS}, they will not | |
2096 | be used unless some pattern's constraint asks for one. | |
a2c4f8e0 | 2097 | @end defmac |
feca2ed3 | 2098 | |
150c9fe8 KH |
2099 | @defmac HARD_REGNO_RENAME_OK (@var{from}, @var{to}) |
2100 | A C expression that is nonzero if it is OK to rename a hard register | |
2101 | @var{from} to another hard register @var{to}. | |
2102 | ||
2103 | One common use of this macro is to prevent renaming of a register to | |
2104 | another register that is not saved by a prologue in an interrupt | |
2105 | handler. | |
2106 | ||
2107 | The default is always nonzero. | |
2108 | @end defmac | |
2109 | ||
a2c4f8e0 | 2110 | @defmac MODES_TIEABLE_P (@var{mode1}, @var{mode2}) |
e9a25f70 | 2111 | A C expression that is nonzero if a value of mode |
956d6950 | 2112 | @var{mode1} is accessible in mode @var{mode2} without copying. |
feca2ed3 JW |
2113 | |
2114 | If @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and | |
e9a25f70 JL |
2115 | @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always the same for |
2116 | any @var{r}, then @code{MODES_TIEABLE_P (@var{mode1}, @var{mode2})} | |
2117 | should be nonzero. If they differ for any @var{r}, you should define | |
2118 | this macro to return zero unless some other mechanism ensures the | |
956d6950 | 2119 | accessibility of the value in a narrower mode. |
e9a25f70 JL |
2120 | |
2121 | You should define this macro to return nonzero in as many cases as | |
a3a15b4d | 2122 | possible since doing so will allow GCC to perform better register |
e9a25f70 | 2123 | allocation. |
a2c4f8e0 | 2124 | @end defmac |
7506f491 | 2125 | |
a2c4f8e0 | 2126 | @defmac AVOID_CCMODE_COPIES |
7506f491 | 2127 | Define this macro if the compiler should avoid copies to/from @code{CCmode} |
a89608cb | 2128 | registers. You should only define this macro if support for copying to/from |
7506f491 | 2129 | @code{CCmode} is incomplete. |
a2c4f8e0 | 2130 | @end defmac |
feca2ed3 JW |
2131 | |
2132 | @node Leaf Functions | |
2133 | @subsection Handling Leaf Functions | |
2134 | ||
2135 | @cindex leaf functions | |
2136 | @cindex functions, leaf | |
2137 | On some machines, a leaf function (i.e., one which makes no calls) can run | |
2138 | more efficiently if it does not make its own register window. Often this | |
2139 | means it is required to receive its arguments in the registers where they | |
2140 | are passed by the caller, instead of the registers where they would | |
2141 | normally arrive. | |
2142 | ||
2143 | The special treatment for leaf functions generally applies only when | |
2144 | other conditions are met; for example, often they may use only those | |
2145 | registers for its own variables and temporaries. We use the term ``leaf | |
2146 | function'' to mean a function that is suitable for this special | |
2147 | handling, so that functions with no calls are not necessarily ``leaf | |
2148 | functions''. | |
2149 | ||
a3a15b4d | 2150 | GCC assigns register numbers before it knows whether the function is |
feca2ed3 JW |
2151 | suitable for leaf function treatment. So it needs to renumber the |
2152 | registers in order to output a leaf function. The following macros | |
2153 | accomplish this. | |
2154 | ||
a2c4f8e0 | 2155 | @defmac LEAF_REGISTERS |
7d167afd | 2156 | Name of a char vector, indexed by hard register number, which |
feca2ed3 JW |
2157 | contains 1 for a register that is allowable in a candidate for leaf |
2158 | function treatment. | |
2159 | ||
2160 | If leaf function treatment involves renumbering the registers, then the | |
2161 | registers marked here should be the ones before renumbering---those that | |
a3a15b4d | 2162 | GCC would ordinarily allocate. The registers which will actually be |
feca2ed3 JW |
2163 | used in the assembler code, after renumbering, should not be marked with 1 |
2164 | in this vector. | |
2165 | ||
2166 | Define this macro only if the target machine offers a way to optimize | |
2167 | the treatment of leaf functions. | |
a2c4f8e0 | 2168 | @end defmac |
feca2ed3 | 2169 | |
a2c4f8e0 | 2170 | @defmac LEAF_REG_REMAP (@var{regno}) |
feca2ed3 JW |
2171 | A C expression whose value is the register number to which @var{regno} |
2172 | should be renumbered, when a function is treated as a leaf function. | |
2173 | ||
2174 | If @var{regno} is a register number which should not appear in a leaf | |
630d3d5a | 2175 | function before renumbering, then the expression should yield @minus{}1, which |
feca2ed3 JW |
2176 | will cause the compiler to abort. |
2177 | ||
2178 | Define this macro only if the target machine offers a way to optimize the | |
2179 | treatment of leaf functions, and registers need to be renumbered to do | |
2180 | this. | |
a2c4f8e0 | 2181 | @end defmac |
feca2ed3 | 2182 | |
54ff41b7 JW |
2183 | @findex current_function_is_leaf |
2184 | @findex current_function_uses_only_leaf_regs | |
c237e94a ZW |
2185 | @code{TARGET_ASM_FUNCTION_PROLOGUE} and |
2186 | @code{TARGET_ASM_FUNCTION_EPILOGUE} must usually treat leaf functions | |
2187 | specially. They can test the C variable @code{current_function_is_leaf} | |
2188 | which is nonzero for leaf functions. @code{current_function_is_leaf} is | |
2189 | set prior to local register allocation and is valid for the remaining | |
08c148a8 NB |
2190 | compiler passes. They can also test the C variable |
2191 | @code{current_function_uses_only_leaf_regs} which is nonzero for leaf | |
2192 | functions which only use leaf registers. | |
9ac617d4 EB |
2193 | @code{current_function_uses_only_leaf_regs} is valid after all passes |
2194 | that modify the instructions have been run and is only useful if | |
2195 | @code{LEAF_REGISTERS} is defined. | |
feca2ed3 JW |
2196 | @c changed this to fix overfull. ALSO: why the "it" at the beginning |
2197 | @c of the next paragraph?! --mew 2feb93 | |
2198 | ||
2199 | @node Stack Registers | |
2200 | @subsection Registers That Form a Stack | |
2201 | ||
2202 | There are special features to handle computers where some of the | |
a2c4f8e0 ZW |
2203 | ``registers'' form a stack. Stack registers are normally written by |
2204 | pushing onto the stack, and are numbered relative to the top of the | |
2205 | stack. | |
feca2ed3 | 2206 | |
a3a15b4d | 2207 | Currently, GCC can only handle one group of stack-like registers, and |
a2c4f8e0 ZW |
2208 | they must be consecutively numbered. Furthermore, the existing |
2209 | support for stack-like registers is specific to the 80387 floating | |
2210 | point coprocessor. If you have a new architecture that uses | |
2211 | stack-like registers, you will need to do substantial work on | |
2212 | @file{reg-stack.c} and write your machine description to cooperate | |
2213 | with it, as well as defining these macros. | |
2214 | ||
2215 | @defmac STACK_REGS | |
feca2ed3 | 2216 | Define this if the machine has any stack-like registers. |
a2c4f8e0 | 2217 | @end defmac |
feca2ed3 | 2218 | |
a2c4f8e0 | 2219 | @defmac FIRST_STACK_REG |
feca2ed3 JW |
2220 | The number of the first stack-like register. This one is the top |
2221 | of the stack. | |
a2c4f8e0 | 2222 | @end defmac |
feca2ed3 | 2223 | |
a2c4f8e0 | 2224 | @defmac LAST_STACK_REG |
feca2ed3 JW |
2225 | The number of the last stack-like register. This one is the bottom of |
2226 | the stack. | |
a2c4f8e0 | 2227 | @end defmac |
feca2ed3 | 2228 | |
feca2ed3 JW |
2229 | @node Register Classes |
2230 | @section Register Classes | |
2231 | @cindex register class definitions | |
2232 | @cindex class definitions, register | |
2233 | ||
2234 | On many machines, the numbered registers are not all equivalent. | |
2235 | For example, certain registers may not be allowed for indexed addressing; | |
2236 | certain registers may not be allowed in some instructions. These machine | |
2237 | restrictions are described to the compiler using @dfn{register classes}. | |
2238 | ||
2239 | You define a number of register classes, giving each one a name and saying | |
2240 | which of the registers belong to it. Then you can specify register classes | |
2241 | that are allowed as operands to particular instruction patterns. | |
2242 | ||
2243 | @findex ALL_REGS | |
2244 | @findex NO_REGS | |
2245 | In general, each register will belong to several classes. In fact, one | |
2246 | class must be named @code{ALL_REGS} and contain all the registers. Another | |
2247 | class must be named @code{NO_REGS} and contain no registers. Often the | |
2248 | union of two classes will be another class; however, this is not required. | |
2249 | ||
2250 | @findex GENERAL_REGS | |
2251 | One of the classes must be named @code{GENERAL_REGS}. There is nothing | |
2252 | terribly special about the name, but the operand constraint letters | |
2253 | @samp{r} and @samp{g} specify this class. If @code{GENERAL_REGS} is | |
2254 | the same as @code{ALL_REGS}, just define it as a macro which expands | |
2255 | to @code{ALL_REGS}. | |
2256 | ||
2257 | Order the classes so that if class @var{x} is contained in class @var{y} | |
2258 | then @var{x} has a lower class number than @var{y}. | |
2259 | ||
2260 | The way classes other than @code{GENERAL_REGS} are specified in operand | |
2261 | constraints is through machine-dependent operand constraint letters. | |
2262 | You can define such letters to correspond to various classes, then use | |
2263 | them in operand constraints. | |
2264 | ||
2265 | You should define a class for the union of two classes whenever some | |
2266 | instruction allows both classes. For example, if an instruction allows | |
2267 | either a floating point (coprocessor) register or a general register for a | |
2268 | certain operand, you should define a class @code{FLOAT_OR_GENERAL_REGS} | |
2269 | which includes both of them. Otherwise you will get suboptimal code. | |
2270 | ||
2271 | You must also specify certain redundant information about the register | |
2272 | classes: for each class, which classes contain it and which ones are | |
2273 | contained in it; for each pair of classes, the largest class contained | |
2274 | in their union. | |
2275 | ||
2276 | When a value occupying several consecutive registers is expected in a | |
2277 | certain class, all the registers used must belong to that class. | |
2278 | Therefore, register classes cannot be used to enforce a requirement for | |
2279 | a register pair to start with an even-numbered register. The way to | |
2280 | specify this requirement is with @code{HARD_REGNO_MODE_OK}. | |
2281 | ||
2282 | Register classes used for input-operands of bitwise-and or shift | |
2283 | instructions have a special requirement: each such class must have, for | |
2284 | each fixed-point machine mode, a subclass whose registers can transfer that | |
2285 | mode to or from memory. For example, on some machines, the operations for | |
2286 | single-byte values (@code{QImode}) are limited to certain registers. When | |
2287 | this is so, each register class that is used in a bitwise-and or shift | |
2288 | instruction must have a subclass consisting of registers from which | |
2289 | single-byte values can be loaded or stored. This is so that | |
2290 | @code{PREFERRED_RELOAD_CLASS} can always have a possible value to return. | |
2291 | ||
a2c4f8e0 | 2292 | @deftp {Data type} {enum reg_class} |
2eac577f JM |
2293 | An enumerated type that must be defined with all the register class names |
2294 | as enumerated values. @code{NO_REGS} must be first. @code{ALL_REGS} | |
2295 | must be the last register class, followed by one more enumerated value, | |
feca2ed3 JW |
2296 | @code{LIM_REG_CLASSES}, which is not a register class but rather |
2297 | tells how many classes there are. | |
2298 | ||
2299 | Each register class has a number, which is the value of casting | |
2300 | the class name to type @code{int}. The number serves as an index | |
2301 | in many of the tables described below. | |
a2c4f8e0 | 2302 | @end deftp |
feca2ed3 | 2303 | |
a2c4f8e0 | 2304 | @defmac N_REG_CLASSES |
feca2ed3 JW |
2305 | The number of distinct register classes, defined as follows: |
2306 | ||
3ab51846 | 2307 | @smallexample |
feca2ed3 | 2308 | #define N_REG_CLASSES (int) LIM_REG_CLASSES |
3ab51846 | 2309 | @end smallexample |
a2c4f8e0 | 2310 | @end defmac |
feca2ed3 | 2311 | |
a2c4f8e0 | 2312 | @defmac REG_CLASS_NAMES |
feca2ed3 JW |
2313 | An initializer containing the names of the register classes as C string |
2314 | constants. These names are used in writing some of the debugging dumps. | |
a2c4f8e0 | 2315 | @end defmac |
feca2ed3 | 2316 | |
a2c4f8e0 | 2317 | @defmac REG_CLASS_CONTENTS |
feca2ed3 JW |
2318 | An initializer containing the contents of the register classes, as integers |
2319 | which are bit masks. The @var{n}th integer specifies the contents of class | |
2320 | @var{n}. The way the integer @var{mask} is interpreted is that | |
2321 | register @var{r} is in the class if @code{@var{mask} & (1 << @var{r})} is 1. | |
2322 | ||
2323 | When the machine has more than 32 registers, an integer does not suffice. | |
2324 | Then the integers are replaced by sub-initializers, braced groupings containing | |
2325 | several integers. Each sub-initializer must be suitable as an initializer | |
2326 | for the type @code{HARD_REG_SET} which is defined in @file{hard-reg-set.h}. | |
7c272079 MP |
2327 | In this situation, the first integer in each sub-initializer corresponds to |
2328 | registers 0 through 31, the second integer to registers 32 through 63, and | |
2329 | so on. | |
a2c4f8e0 | 2330 | @end defmac |
feca2ed3 | 2331 | |
a2c4f8e0 | 2332 | @defmac REGNO_REG_CLASS (@var{regno}) |
feca2ed3 JW |
2333 | A C expression whose value is a register class containing hard register |
2334 | @var{regno}. In general there is more than one such class; choose a class | |
2335 | which is @dfn{minimal}, meaning that no smaller class also contains the | |
2336 | register. | |
a2c4f8e0 | 2337 | @end defmac |
feca2ed3 | 2338 | |
a2c4f8e0 | 2339 | @defmac BASE_REG_CLASS |
feca2ed3 JW |
2340 | A macro whose definition is the name of the class to which a valid |
2341 | base register must belong. A base register is one used in an address | |
2342 | which is the register value plus a displacement. | |
a2c4f8e0 | 2343 | @end defmac |
feca2ed3 | 2344 | |
a2c4f8e0 | 2345 | @defmac MODE_BASE_REG_CLASS (@var{mode}) |
3dcc68a4 | 2346 | This is a variation of the @code{BASE_REG_CLASS} macro which allows |
c0478a66 | 2347 | the selection of a base register in a mode dependent manner. If |
3dcc68a4 NC |
2348 | @var{mode} is VOIDmode then it should return the same value as |
2349 | @code{BASE_REG_CLASS}. | |
a2c4f8e0 | 2350 | @end defmac |
3dcc68a4 | 2351 | |
888d2cd6 DJ |
2352 | @defmac MODE_BASE_REG_REG_CLASS (@var{mode}) |
2353 | A C expression whose value is the register class to which a valid | |
2354 | base register must belong in order to be used in a base plus index | |
2355 | register address. You should define this macro if base plus index | |
2356 | addresses have different requirements than other base register uses. | |
2357 | @end defmac | |
2358 | ||
c4963a0a BS |
2359 | @defmac MODE_CODE_BASE_REG_CLASS (@var{mode}, @var{outer_code}, @var{index_code}) |
2360 | A C expression whose value is the register class to which a valid | |
2361 | base register must belong. @var{outer_code} and @var{index_code} define the | |
2362 | context in which the base register occurs. @var{outer_code} is the code of | |
2363 | the immediately enclosing expression (@code{MEM} for the top level of an | |
2364 | address, @code{ADDRESS} for something that occurs in an | |
2365 | @code{address_operand}). @var{index_code} is the code of the corresponding | |
2366 | index expression if @var{outer_code} is @code{PLUS}; @code{SCRATCH} otherwise. | |
2367 | @end defmac | |
2368 | ||
a2c4f8e0 | 2369 | @defmac INDEX_REG_CLASS |
feca2ed3 JW |
2370 | A macro whose definition is the name of the class to which a valid |
2371 | index register must belong. An index register is one used in an | |
2372 | address where its value is either multiplied by a scale factor or | |
2373 | added to another register (as well as added to a displacement). | |
a2c4f8e0 | 2374 | @end defmac |
feca2ed3 | 2375 | |
a2c4f8e0 | 2376 | @defmac REGNO_OK_FOR_BASE_P (@var{num}) |
feca2ed3 JW |
2377 | A C expression which is nonzero if register number @var{num} is |
2378 | suitable for use as a base register in operand addresses. It may be | |
2379 | either a suitable hard register or a pseudo register that has been | |
2380 | allocated such a hard register. | |
a2c4f8e0 | 2381 | @end defmac |
feca2ed3 | 2382 | |
a2c4f8e0 | 2383 | @defmac REGNO_MODE_OK_FOR_BASE_P (@var{num}, @var{mode}) |
861bb6c1 JL |
2384 | A C expression that is just like @code{REGNO_OK_FOR_BASE_P}, except that |
2385 | that expression may examine the mode of the memory reference in | |
2386 | @var{mode}. You should define this macro if the mode of the memory | |
2387 | reference affects whether a register may be used as a base register. If | |
2388 | you define this macro, the compiler will use it instead of | |
c4963a0a BS |
2389 | @code{REGNO_OK_FOR_BASE_P}. The mode may be @code{VOIDmode} for addresses |
2390 | that appear outside a @code{MEM}, i.e. as an @code{address_operand}. | |
2391 | ||
a2c4f8e0 | 2392 | @end defmac |
861bb6c1 | 2393 | |
888d2cd6 DJ |
2394 | @defmac REGNO_MODE_OK_FOR_REG_BASE_P (@var{num}, @var{mode}) |
2395 | A C expression which is nonzero if register number @var{num} is suitable for | |
2396 | use as a base register in base plus index operand addresses, accessing | |
2397 | memory in mode @var{mode}. It may be either a suitable hard register or a | |
2398 | pseudo register that has been allocated such a hard register. You should | |
2399 | define this macro if base plus index addresses have different requirements | |
2400 | than other base register uses. | |
c4963a0a BS |
2401 | |
2402 | Use of this macro is deprecated; please use the more general | |
2403 | @code{REGNO_MODE_CODE_OK_FOR_BASE_P}. | |
2404 | @end defmac | |
2405 | ||
2406 | @defmac REGNO_MODE_CODE_OK_FOR_BASE_P (@var{num}, @var{mode}, @var{outer_code}, @var{index_code}) | |
2407 | A C expression that is just like @code{REGNO_MODE_OK_FOR_BASE_P}, except that | |
2408 | that expression may examine the context in which the register appears in the | |
2409 | memory reference. @var{outer_code} is the code of the immediately enclosing | |
2410 | expression (@code{MEM} if at the top level of the address, @code{ADDRESS} for | |
2411 | something that occurs in an @code{address_operand}). @var{index_code} is the | |
2412 | code of the corresponding index expression if @var{outer_code} is @code{PLUS}; | |
2413 | @code{SCRATCH} otherwise. The mode may be @code{VOIDmode} for addresses | |
2414 | that appear outside a @code{MEM}, i.e. as an @code{address_operand}. | |
888d2cd6 DJ |
2415 | @end defmac |
2416 | ||
a2c4f8e0 | 2417 | @defmac REGNO_OK_FOR_INDEX_P (@var{num}) |
feca2ed3 JW |
2418 | A C expression which is nonzero if register number @var{num} is |
2419 | suitable for use as an index register in operand addresses. It may be | |
2420 | either a suitable hard register or a pseudo register that has been | |
2421 | allocated such a hard register. | |
2422 | ||
2423 | The difference between an index register and a base register is that | |
2424 | the index register may be scaled. If an address involves the sum of | |
2425 | two registers, neither one of them scaled, then either one may be | |
2426 | labeled the ``base'' and the other the ``index''; but whichever | |
2427 | labeling is used must fit the machine's constraints of which registers | |
2428 | may serve in each capacity. The compiler will try both labelings, | |
2429 | looking for one that is valid, and will reload one or both registers | |
2430 | only if neither labeling works. | |
a2c4f8e0 | 2431 | @end defmac |
feca2ed3 | 2432 | |
a2c4f8e0 | 2433 | @defmac PREFERRED_RELOAD_CLASS (@var{x}, @var{class}) |
feca2ed3 JW |
2434 | A C expression that places additional restrictions on the register class |
2435 | to use when it is necessary to copy value @var{x} into a register in class | |
2436 | @var{class}. The value is a register class; perhaps @var{class}, or perhaps | |
2437 | another, smaller class. On many machines, the following definition is | |
2438 | safe: | |
2439 | ||
3ab51846 | 2440 | @smallexample |
feca2ed3 | 2441 | #define PREFERRED_RELOAD_CLASS(X,CLASS) CLASS |
3ab51846 | 2442 | @end smallexample |
feca2ed3 JW |
2443 | |
2444 | Sometimes returning a more restrictive class makes better code. For | |
2445 | example, on the 68000, when @var{x} is an integer constant that is in range | |
2446 | for a @samp{moveq} instruction, the value of this macro is always | |
2447 | @code{DATA_REGS} as long as @var{class} includes the data registers. | |
2448 | Requiring a data register guarantees that a @samp{moveq} will be used. | |
2449 | ||
222a2f1a GK |
2450 | One case where @code{PREFERRED_RELOAD_CLASS} must not return |
2451 | @var{class} is if @var{x} is a legitimate constant which cannot be | |
2452 | loaded into some register class. By returning @code{NO_REGS} you can | |
2453 | force @var{x} into a memory location. For example, rs6000 can load | |
2454 | immediate values into general-purpose registers, but does not have an | |
2455 | instruction for loading an immediate value into a floating-point | |
2456 | register, so @code{PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when | |
2457 | @var{x} is a floating-point constant. If the constant can't be loaded | |
2458 | into any kind of register, code generation will be better if | |
2459 | @code{LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead | |
2460 | of using @code{PREFERRED_RELOAD_CLASS}. | |
b5c82fa1 PB |
2461 | |
2462 | If an insn has pseudos in it after register allocation, reload will go | |
2463 | through the alternatives and call repeatedly @code{PREFERRED_RELOAD_CLASS} | |
2464 | to find the best one. Returning @code{NO_REGS}, in this case, makes | |
2465 | reload add a @code{!} in front of the constraint: the x86 back-end uses | |
2466 | this feature to discourage usage of 387 registers when math is done in | |
2467 | the SSE registers (and vice versa). | |
a2c4f8e0 | 2468 | @end defmac |
feca2ed3 | 2469 | |
a2c4f8e0 | 2470 | @defmac PREFERRED_OUTPUT_RELOAD_CLASS (@var{x}, @var{class}) |
feca2ed3 JW |
2471 | Like @code{PREFERRED_RELOAD_CLASS}, but for output reloads instead of |
2472 | input reloads. If you don't define this macro, the default is to use | |
2473 | @var{class}, unchanged. | |
b5c82fa1 PB |
2474 | |
2475 | You can also use @code{PREFERRED_OUTPUT_RELOAD_CLASS} to discourage | |
2476 | reload from using some alternatives, like @code{PREFERRED_RELOAD_CLASS}. | |
a2c4f8e0 | 2477 | @end defmac |
feca2ed3 | 2478 | |
a2c4f8e0 | 2479 | @defmac LIMIT_RELOAD_CLASS (@var{mode}, @var{class}) |
feca2ed3 JW |
2480 | A C expression that places additional restrictions on the register class |
2481 | to use when it is necessary to be able to hold a value of mode | |
2482 | @var{mode} in a reload register for which class @var{class} would | |
2483 | ordinarily be used. | |
2484 | ||
2485 | Unlike @code{PREFERRED_RELOAD_CLASS}, this macro should be used when | |
2486 | there are certain modes that simply can't go in certain reload classes. | |
2487 | ||
2488 | The value is a register class; perhaps @var{class}, or perhaps another, | |
2489 | smaller class. | |
2490 | ||
2491 | Don't define this macro unless the target machine has limitations which | |
2492 | require the macro to do something nontrivial. | |
a2c4f8e0 | 2493 | @end defmac |
feca2ed3 | 2494 | |
8a99f6f9 | 2495 | @deftypefn {Target Hook} enum reg_class TARGET_SECONDARY_RELOAD (bool @var{in_p}, rtx @var{x}, enum reg_class @var{reload_class}, enum machine_mode @var{reload_mode}, secondary_reload_info *@var{sri}) |
feca2ed3 JW |
2496 | Many machines have some registers that cannot be copied directly to or |
2497 | from memory or even from other types of registers. An example is the | |
2498 | @samp{MQ} register, which on most machines, can only be copied to or | |
8a99f6f9 R |
2499 | from general registers, but not memory. Below, we shall be using the |
2500 | term 'intermediate register' when a move operation cannot be performed | |
2501 | directly, but has to be done by copying the source into the intermediate | |
2502 | register first, and then copying the intermediate register to the | |
2503 | destination. An intermediate register always has the same mode as | |
2504 | source and destination. Since it holds the actual value being copied, | |
2505 | reload might apply optimizations to re-use an intermediate register | |
2506 | and eliding the copy from the source when it can determine that the | |
2507 | intermediate register still holds the required value. | |
2508 | ||
2509 | Another kind of secondary reload is required on some machines which | |
2510 | allow copying all registers to and from memory, but require a scratch | |
2511 | register for stores to some memory locations (e.g., those with symbolic | |
2512 | address on the RT, and those with certain symbolic address on the SPARC | |
2513 | when compiling PIC)@. Scratch registers need not have the same mode | |
2514 | as the value being copied, and usually hold a different value that | |
2515 | that being copied. Special patterns in the md file are needed to | |
2516 | describe how the copy is performed with the help of the scratch register; | |
2517 | these patterns also describe the number, register class(es) and mode(s) | |
2518 | of the scratch register(s). | |
2519 | ||
2520 | In some cases, both an intermediate and a scratch register are required. | |
2521 | ||
2522 | For input reloads, this target hook is called with nonzero @var{in_p}, | |
2523 | and @var{x} is an rtx that needs to be copied to a register in of class | |
2524 | @var{reload_class} in @var{reload_mode}. For output reloads, this target | |
2525 | hook is called with zero @var{in_p}, and a register of class @var{reload_mode} | |
2526 | needs to be copied to rtx @var{x} in @var{reload_mode}. | |
2527 | ||
2528 | If copying a register of @var{reload_class} from/to @var{x} requires | |
2529 | an intermediate register, the hook @code{secondary_reload} should | |
2530 | return the register class required for this intermediate register. | |
2531 | If no intermediate register is required, it should return NO_REGS. | |
2532 | If more than one intermediate register is required, describe the one | |
2533 | that is closest in the copy chain to the reload register. | |
2534 | ||
2535 | If scratch registers are needed, you also have to describe how to | |
2536 | perform the copy from/to the reload register to/from this | |
2537 | closest intermediate register. Or if no intermediate register is | |
2538 | required, but still a scratch register is needed, describe the | |
2539 | copy from/to the reload register to/from the reload operand @var{x}. | |
2540 | ||
2541 | You do this by setting @code{sri->icode} to the instruction code of a pattern | |
2542 | in the md file which performs the move. Operands 0 and 1 are the output | |
2543 | and input of this copy, respectively. Operands from operand 2 onward are | |
2544 | for scratch operands. These scratch operands must have a mode, and a | |
2545 | single-register-class | |
2546 | @c [later: or memory] | |
2547 | output constraint. | |
2548 | ||
2549 | When an intermediate register is used, the @code{secondary_reload} | |
2550 | hook will be called again to determine how to copy the intermediate | |
2551 | register to/from the reload operand @var{x}, so your hook must also | |
2552 | have code to handle the register class of the intermediate operand. | |
2553 | ||
2554 | @c [For later: maybe we'll allow multi-alternative reload patterns - | |
2555 | @c the port maintainer could name a mov<mode> pattern that has clobbers - | |
2556 | @c and match the constraints of input and output to determine the required | |
2557 | @c alternative. A restriction would be that constraints used to match | |
2558 | @c against reloads registers would have to be written as register class | |
2559 | @c constraints, or we need a new target macro / hook that tells us if an | |
2560 | @c arbitrary constraint can match an unknown register of a given class. | |
2561 | @c Such a macro / hook would also be useful in other places.] | |
2562 | ||
2563 | ||
2564 | @var{x} might be a pseudo-register or a @code{subreg} of a | |
2565 | pseudo-register, which could either be in a hard register or in memory. | |
2566 | Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is | |
2567 | in memory and the hard register number if it is in a register. | |
2568 | ||
2569 | Scratch operands in memory (constraint @code{"=m"} / @code{"=&m"}) are | |
2570 | currently not supported. For the time being, you will have to continue | |
2571 | to use @code{SECONDARY_MEMORY_NEEDED} for that purpose. | |
2572 | ||
2573 | @code{copy_cost} also uses this target hook to find out how values are | |
2574 | copied. If you want it to include some extra cost for the need to allocate | |
2575 | (a) scratch register(s), set @code{sri->extra_cost} to the additional cost. | |
2576 | Or if two dependent moves are supposed to have a lower cost than the sum | |
2577 | of the individual moves due to expected fortuitous scheduling and/or special | |
2578 | forwarding logic, you can set @code{sri->extra_cost} to a negative amount. | |
2579 | @end deftypefn | |
2580 | ||
2581 | @defmac SECONDARY_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
2582 | @defmacx SECONDARY_INPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
2583 | @defmacx SECONDARY_OUTPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
083cad55 | 2584 | These macros are obsolete, new ports should use the target hook |
8a99f6f9 R |
2585 | @code{TARGET_SECONDARY_RELOAD} instead. |
2586 | ||
2587 | These are obsolete macros, replaced by the @code{TARGET_SECONDARY_RELOAD} | |
2588 | target hook. Older ports still define these macros to indicate to the | |
2589 | reload phase that it may | |
feca2ed3 JW |
2590 | need to allocate at least one register for a reload in addition to the |
2591 | register to contain the data. Specifically, if copying @var{x} to a | |
2592 | register @var{class} in @var{mode} requires an intermediate register, | |
8a99f6f9 | 2593 | you were supposed to define @code{SECONDARY_INPUT_RELOAD_CLASS} to return the |
feca2ed3 JW |
2594 | largest register class all of whose registers can be used as |
2595 | intermediate registers or scratch registers. | |
2596 | ||
2597 | If copying a register @var{class} in @var{mode} to @var{x} requires an | |
2598 | intermediate or scratch register, @code{SECONDARY_OUTPUT_RELOAD_CLASS} | |
8a99f6f9 R |
2599 | was supposed to be defined be defined to return the largest register |
2600 | class required. If the | |
2601 | requirements for input and output reloads were the same, the macro | |
2602 | @code{SECONDARY_RELOAD_CLASS} should have been used instead of defining both | |
feca2ed3 JW |
2603 | macros identically. |
2604 | ||
2605 | The values returned by these macros are often @code{GENERAL_REGS}. | |
2606 | Return @code{NO_REGS} if no spare register is needed; i.e., if @var{x} | |
2607 | can be directly copied to or from a register of @var{class} in | |
2608 | @var{mode} without requiring a scratch register. Do not define this | |
2609 | macro if it would always return @code{NO_REGS}. | |
2610 | ||
2611 | If a scratch register is required (either with or without an | |
8a99f6f9 | 2612 | intermediate register), you were supposed to define patterns for |
feca2ed3 | 2613 | @samp{reload_in@var{m}} or @samp{reload_out@var{m}}, as required |
8a99f6f9 | 2614 | (@pxref{Standard Names}. These patterns, which were normally |
feca2ed3 JW |
2615 | implemented with a @code{define_expand}, should be similar to the |
2616 | @samp{mov@var{m}} patterns, except that operand 2 is the scratch | |
2617 | register. | |
2618 | ||
8a99f6f9 R |
2619 | These patterns need constraints for the reload register and scratch |
2620 | register that | |
feca2ed3 JW |
2621 | contain a single register class. If the original reload register (whose |
2622 | class is @var{class}) can meet the constraint given in the pattern, the | |
2623 | value returned by these macros is used for the class of the scratch | |
2624 | register. Otherwise, two additional reload registers are required. | |
2625 | Their classes are obtained from the constraints in the insn pattern. | |
2626 | ||
2627 | @var{x} might be a pseudo-register or a @code{subreg} of a | |
2628 | pseudo-register, which could either be in a hard register or in memory. | |
630d3d5a | 2629 | Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is |
feca2ed3 JW |
2630 | in memory and the hard register number if it is in a register. |
2631 | ||
2632 | These macros should not be used in the case where a particular class of | |
2633 | registers can only be copied to memory and not to another class of | |
2634 | registers. In that case, secondary reload registers are not needed and | |
2635 | would not be helpful. Instead, a stack location must be used to perform | |
a8154559 | 2636 | the copy and the @code{mov@var{m}} pattern should use memory as an |
feca2ed3 JW |
2637 | intermediate storage. This case often occurs between floating-point and |
2638 | general registers. | |
a2c4f8e0 | 2639 | @end defmac |
feca2ed3 | 2640 | |
a2c4f8e0 | 2641 | @defmac SECONDARY_MEMORY_NEEDED (@var{class1}, @var{class2}, @var{m}) |
feca2ed3 JW |
2642 | Certain machines have the property that some registers cannot be copied |
2643 | to some other registers without using memory. Define this macro on | |
df2a54e9 | 2644 | those machines to be a C expression that is nonzero if objects of mode |
feca2ed3 JW |
2645 | @var{m} in registers of @var{class1} can only be copied to registers of |
2646 | class @var{class2} by storing a register of @var{class1} into memory | |
2647 | and loading that memory location into a register of @var{class2}. | |
2648 | ||
2649 | Do not define this macro if its value would always be zero. | |
a2c4f8e0 | 2650 | @end defmac |
feca2ed3 | 2651 | |
a2c4f8e0 | 2652 | @defmac SECONDARY_MEMORY_NEEDED_RTX (@var{mode}) |
feca2ed3 JW |
2653 | Normally when @code{SECONDARY_MEMORY_NEEDED} is defined, the compiler |
2654 | allocates a stack slot for a memory location needed for register copies. | |
2655 | If this macro is defined, the compiler instead uses the memory location | |
2656 | defined by this macro. | |
2657 | ||
2658 | Do not define this macro if you do not define | |
2659 | @code{SECONDARY_MEMORY_NEEDED}. | |
a2c4f8e0 | 2660 | @end defmac |
feca2ed3 | 2661 | |
a2c4f8e0 | 2662 | @defmac SECONDARY_MEMORY_NEEDED_MODE (@var{mode}) |
feca2ed3 JW |
2663 | When the compiler needs a secondary memory location to copy between two |
2664 | registers of mode @var{mode}, it normally allocates sufficient memory to | |
2665 | hold a quantity of @code{BITS_PER_WORD} bits and performs the store and | |
2666 | load operations in a mode that many bits wide and whose class is the | |
2667 | same as that of @var{mode}. | |
2668 | ||
2669 | This is right thing to do on most machines because it ensures that all | |
2670 | bits of the register are copied and prevents accesses to the registers | |
2671 | in a narrower mode, which some machines prohibit for floating-point | |
2672 | registers. | |
2673 | ||
2674 | However, this default behavior is not correct on some machines, such as | |
2675 | the DEC Alpha, that store short integers in floating-point registers | |
2676 | differently than in integer registers. On those machines, the default | |
2677 | widening will not work correctly and you must define this macro to | |
2678 | suppress that widening in some cases. See the file @file{alpha.h} for | |
2679 | details. | |
2680 | ||
2681 | Do not define this macro if you do not define | |
2682 | @code{SECONDARY_MEMORY_NEEDED} or if widening @var{mode} to a mode that | |
2683 | is @code{BITS_PER_WORD} bits wide is correct for your machine. | |
a2c4f8e0 | 2684 | @end defmac |
feca2ed3 | 2685 | |
a2c4f8e0 | 2686 | @defmac SMALL_REGISTER_CLASSES |
faa9eb19 BS |
2687 | On some machines, it is risky to let hard registers live across arbitrary |
2688 | insns. Typically, these machines have instructions that require values | |
2689 | to be in specific registers (like an accumulator), and reload will fail | |
2690 | if the required hard register is used for another purpose across such an | |
2691 | insn. | |
feca2ed3 | 2692 | |
df2a54e9 JM |
2693 | Define @code{SMALL_REGISTER_CLASSES} to be an expression with a nonzero |
2694 | value on these machines. When this macro has a nonzero value, the | |
faa9eb19 | 2695 | compiler will try to minimize the lifetime of hard registers. |
feca2ed3 | 2696 | |
df2a54e9 | 2697 | It is always safe to define this macro with a nonzero value, but if you |
861bb6c1 JL |
2698 | unnecessarily define it, you will reduce the amount of optimizations |
2699 | that can be performed in some cases. If you do not define this macro | |
df2a54e9 | 2700 | with a nonzero value when it is required, the compiler will run out of |
861bb6c1 JL |
2701 | spill registers and print a fatal error message. For most machines, you |
2702 | should not define this macro at all. | |
a2c4f8e0 | 2703 | @end defmac |
feca2ed3 | 2704 | |
a2c4f8e0 | 2705 | @defmac CLASS_LIKELY_SPILLED_P (@var{class}) |
feca2ed3 JW |
2706 | A C expression whose value is nonzero if pseudos that have been assigned |
2707 | to registers of class @var{class} would likely be spilled because | |
2708 | registers of @var{class} are needed for spill registers. | |
2709 | ||
2710 | The default value of this macro returns 1 if @var{class} has exactly one | |
2711 | register and zero otherwise. On most machines, this default should be | |
40687a9e | 2712 | used. Only define this macro to some other expression if pseudos |
feca2ed3 JW |
2713 | allocated by @file{local-alloc.c} end up in memory because their hard |
2714 | registers were needed for spill registers. If this macro returns nonzero | |
2715 | for those classes, those pseudos will only be allocated by | |
2716 | @file{global.c}, which knows how to reallocate the pseudo to another | |
2717 | register. If there would not be another register available for | |
2718 | reallocation, you should not change the definition of this macro since | |
2719 | the only effect of such a definition would be to slow down register | |
2720 | allocation. | |
a2c4f8e0 | 2721 | @end defmac |
feca2ed3 | 2722 | |
a2c4f8e0 | 2723 | @defmac CLASS_MAX_NREGS (@var{class}, @var{mode}) |
feca2ed3 JW |
2724 | A C expression for the maximum number of consecutive registers |
2725 | of class @var{class} needed to hold a value of mode @var{mode}. | |
2726 | ||
2727 | This is closely related to the macro @code{HARD_REGNO_NREGS}. In fact, | |
2728 | the value of the macro @code{CLASS_MAX_NREGS (@var{class}, @var{mode})} | |
2729 | should be the maximum value of @code{HARD_REGNO_NREGS (@var{regno}, | |
2730 | @var{mode})} for all @var{regno} values in the class @var{class}. | |
2731 | ||
2732 | This macro helps control the handling of multiple-word values | |
2733 | in the reload pass. | |
a2c4f8e0 | 2734 | @end defmac |
feca2ed3 | 2735 | |
a2c4f8e0 | 2736 | @defmac CANNOT_CHANGE_MODE_CLASS (@var{from}, @var{to}, @var{class}) |
b0c42aed JH |
2737 | If defined, a C expression that returns nonzero for a @var{class} for which |
2738 | a change from mode @var{from} to mode @var{to} is invalid. | |
feca2ed3 JW |
2739 | |
2740 | For the example, loading 32-bit integer or floating-point objects into | |
57694e40 | 2741 | floating-point registers on the Alpha extends them to 64 bits. |
feca2ed3 | 2742 | Therefore loading a 64-bit object and then storing it as a 32-bit object |
57694e40 | 2743 | does not store the low-order 32 bits, as would be the case for a normal |
cff9f8d5 AH |
2744 | register. Therefore, @file{alpha.h} defines @code{CANNOT_CHANGE_MODE_CLASS} |
2745 | as below: | |
02188693 | 2746 | |
3ab51846 | 2747 | @smallexample |
b0c42aed JH |
2748 | #define CANNOT_CHANGE_MODE_CLASS(FROM, TO, CLASS) \ |
2749 | (GET_MODE_SIZE (FROM) != GET_MODE_SIZE (TO) \ | |
2750 | ? reg_classes_intersect_p (FLOAT_REGS, (CLASS)) : 0) | |
3ab51846 | 2751 | @end smallexample |
a2c4f8e0 | 2752 | @end defmac |
feca2ed3 | 2753 | |
f38840db ZW |
2754 | @node Old Constraints |
2755 | @section Obsolete Macros for Defining Constraints | |
2756 | @cindex defining constraints, obsolete method | |
2757 | @cindex constraints, defining, obsolete method | |
2758 | ||
2759 | Machine-specific constraints can be defined with these macros instead | |
2760 | of the machine description constructs described in @ref{Define | |
2761 | Constraints}. This mechanism is obsolete. New ports should not use | |
2762 | it; old ports should convert to the new mechanism. | |
2763 | ||
2764 | @defmac CONSTRAINT_LEN (@var{char}, @var{str}) | |
2765 | For the constraint at the start of @var{str}, which starts with the letter | |
2766 | @var{c}, return the length. This allows you to have register class / | |
2767 | constant / extra constraints that are longer than a single letter; | |
2768 | you don't need to define this macro if you can do with single-letter | |
2769 | constraints only. The definition of this macro should use | |
2770 | DEFAULT_CONSTRAINT_LEN for all the characters that you don't want | |
2771 | to handle specially. | |
2772 | There are some sanity checks in genoutput.c that check the constraint lengths | |
2773 | for the md file, so you can also use this macro to help you while you are | |
2774 | transitioning from a byzantine single-letter-constraint scheme: when you | |
2775 | return a negative length for a constraint you want to re-use, genoutput | |
2776 | will complain about every instance where it is used in the md file. | |
2777 | @end defmac | |
2778 | ||
2779 | @defmac REG_CLASS_FROM_LETTER (@var{char}) | |
2780 | A C expression which defines the machine-dependent operand constraint | |
2781 | letters for register classes. If @var{char} is such a letter, the | |
2782 | value should be the register class corresponding to it. Otherwise, | |
2783 | the value should be @code{NO_REGS}. The register letter @samp{r}, | |
2784 | corresponding to class @code{GENERAL_REGS}, will not be passed | |
2785 | to this macro; you do not need to handle it. | |
2786 | @end defmac | |
2787 | ||
2788 | @defmac REG_CLASS_FROM_CONSTRAINT (@var{char}, @var{str}) | |
2789 | Like @code{REG_CLASS_FROM_LETTER}, but you also get the constraint string | |
2790 | passed in @var{str}, so that you can use suffixes to distinguish between | |
2791 | different variants. | |
2792 | @end defmac | |
feca2ed3 | 2793 | |
a2c4f8e0 | 2794 | @defmac CONST_OK_FOR_LETTER_P (@var{value}, @var{c}) |
e119b68c MM |
2795 | A C expression that defines the machine-dependent operand constraint |
2796 | letters (@samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}) that specify | |
2797 | particular ranges of integer values. If @var{c} is one of those | |
2798 | letters, the expression should check that @var{value}, an integer, is in | |
2799 | the appropriate range and return 1 if so, 0 otherwise. If @var{c} is | |
2800 | not one of those letters, the value should be 0 regardless of | |
2801 | @var{value}. | |
a2c4f8e0 | 2802 | @end defmac |
feca2ed3 | 2803 | |
a2c4f8e0 | 2804 | @defmac CONST_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str}) |
97488870 R |
2805 | Like @code{CONST_OK_FOR_LETTER_P}, but you also get the constraint |
2806 | string passed in @var{str}, so that you can use suffixes to distinguish | |
2807 | between different variants. | |
a2c4f8e0 | 2808 | @end defmac |
97488870 | 2809 | |
a2c4f8e0 | 2810 | @defmac CONST_DOUBLE_OK_FOR_LETTER_P (@var{value}, @var{c}) |
feca2ed3 | 2811 | A C expression that defines the machine-dependent operand constraint |
e119b68c MM |
2812 | letters that specify particular ranges of @code{const_double} values |
2813 | (@samp{G} or @samp{H}). | |
feca2ed3 JW |
2814 | |
2815 | If @var{c} is one of those letters, the expression should check that | |
2816 | @var{value}, an RTX of code @code{const_double}, is in the appropriate | |
2817 | range and return 1 if so, 0 otherwise. If @var{c} is not one of those | |
2818 | letters, the value should be 0 regardless of @var{value}. | |
2819 | ||
2820 | @code{const_double} is used for all floating-point constants and for | |
2821 | @code{DImode} fixed-point constants. A given letter can accept either | |
2822 | or both kinds of values. It can use @code{GET_MODE} to distinguish | |
2823 | between these kinds. | |
a2c4f8e0 | 2824 | @end defmac |
feca2ed3 | 2825 | |
a2c4f8e0 | 2826 | @defmac CONST_DOUBLE_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str}) |
97488870 R |
2827 | Like @code{CONST_DOUBLE_OK_FOR_LETTER_P}, but you also get the constraint |
2828 | string passed in @var{str}, so that you can use suffixes to distinguish | |
2829 | between different variants. | |
a2c4f8e0 | 2830 | @end defmac |
97488870 | 2831 | |
a2c4f8e0 | 2832 | @defmac EXTRA_CONSTRAINT (@var{value}, @var{c}) |
feca2ed3 | 2833 | A C expression that defines the optional machine-dependent constraint |
c2cba7a9 RH |
2834 | letters that can be used to segregate specific types of operands, usually |
2835 | memory references, for the target machine. Any letter that is not | |
97488870 R |
2836 | elsewhere defined and not matched by @code{REG_CLASS_FROM_LETTER} / |
2837 | @code{REG_CLASS_FROM_CONSTRAINT} | |
c2cba7a9 RH |
2838 | may be used. Normally this macro will not be defined. |
2839 | ||
2840 | If it is required for a particular target machine, it should return 1 | |
2841 | if @var{value} corresponds to the operand type represented by the | |
2842 | constraint letter @var{c}. If @var{c} is not defined as an extra | |
e119b68c | 2843 | constraint, the value returned should be 0 regardless of @var{value}. |
feca2ed3 | 2844 | |
c2cba7a9 RH |
2845 | For example, on the ROMP, load instructions cannot have their output |
2846 | in r0 if the memory reference contains a symbolic address. Constraint | |
2847 | letter @samp{Q} is defined as representing a memory address that does | |
feca2ed3 JW |
2848 | @emph{not} contain a symbolic address. An alternative is specified with |
2849 | a @samp{Q} constraint on the input and @samp{r} on the output. The next | |
2850 | alternative specifies @samp{m} on the input and a register class that | |
2851 | does not include r0 on the output. | |
a2c4f8e0 | 2852 | @end defmac |
ccfc6cc8 | 2853 | |
a2c4f8e0 | 2854 | @defmac EXTRA_CONSTRAINT_STR (@var{value}, @var{c}, @var{str}) |
97488870 R |
2855 | Like @code{EXTRA_CONSTRAINT}, but you also get the constraint string passed |
2856 | in @var{str}, so that you can use suffixes to distinguish between different | |
2857 | variants. | |
a2c4f8e0 | 2858 | @end defmac |
97488870 | 2859 | |
a2c4f8e0 | 2860 | @defmac EXTRA_MEMORY_CONSTRAINT (@var{c}, @var{str}) |
ccfc6cc8 UW |
2861 | A C expression that defines the optional machine-dependent constraint |
2862 | letters, amongst those accepted by @code{EXTRA_CONSTRAINT}, that should | |
2863 | be treated like memory constraints by the reload pass. | |
2864 | ||
73774972 | 2865 | It should return 1 if the operand type represented by the constraint |
97488870 R |
2866 | at the start of @var{str}, the first letter of which is the letter @var{c}, |
2867 | comprises a subset of all memory references including | |
73774972 EC |
2868 | all those whose address is simply a base register. This allows the reload |
2869 | pass to reload an operand, if it does not directly correspond to the operand | |
ccfc6cc8 UW |
2870 | type of @var{c}, by copying its address into a base register. |
2871 | ||
2872 | For example, on the S/390, some instructions do not accept arbitrary | |
2873 | memory references, but only those that do not make use of an index | |
2874 | register. The constraint letter @samp{Q} is defined via | |
2875 | @code{EXTRA_CONSTRAINT} as representing a memory address of this type. | |
2876 | If the letter @samp{Q} is marked as @code{EXTRA_MEMORY_CONSTRAINT}, | |
2877 | a @samp{Q} constraint can handle any memory operand, because the | |
2878 | reload pass knows it can be reloaded by copying the memory address | |
2879 | into a base register if required. This is analogous to the way | |
2880 | a @samp{o} constraint can handle any memory operand. | |
a2c4f8e0 | 2881 | @end defmac |
ccfc6cc8 | 2882 | |
a2c4f8e0 | 2883 | @defmac EXTRA_ADDRESS_CONSTRAINT (@var{c}, @var{str}) |
ccfc6cc8 | 2884 | A C expression that defines the optional machine-dependent constraint |
97488870 R |
2885 | letters, amongst those accepted by @code{EXTRA_CONSTRAINT} / |
2886 | @code{EXTRA_CONSTRAINT_STR}, that should | |
ccfc6cc8 UW |
2887 | be treated like address constraints by the reload pass. |
2888 | ||
73774972 | 2889 | It should return 1 if the operand type represented by the constraint |
3a6e2189 | 2890 | at the start of @var{str}, which starts with the letter @var{c}, comprises |
97488870 | 2891 | a subset of all memory addresses including |
73774972 EC |
2892 | all those that consist of just a base register. This allows the reload |
2893 | pass to reload an operand, if it does not directly correspond to the operand | |
97488870 | 2894 | type of @var{str}, by copying it into a base register. |
ccfc6cc8 UW |
2895 | |
2896 | Any constraint marked as @code{EXTRA_ADDRESS_CONSTRAINT} can only | |
73774972 | 2897 | be used with the @code{address_operand} predicate. It is treated |
ccfc6cc8 | 2898 | analogously to the @samp{p} constraint. |
a2c4f8e0 | 2899 | @end defmac |
feca2ed3 JW |
2900 | |
2901 | @node Stack and Calling | |
2902 | @section Stack Layout and Calling Conventions | |
2903 | @cindex calling conventions | |
2904 | ||
2905 | @c prevent bad page break with this line | |
2906 | This describes the stack layout and calling conventions. | |
2907 | ||
2908 | @menu | |
2909 | * Frame Layout:: | |
7c16328b | 2910 | * Exception Handling:: |
861bb6c1 | 2911 | * Stack Checking:: |
feca2ed3 JW |
2912 | * Frame Registers:: |
2913 | * Elimination:: | |
2914 | * Stack Arguments:: | |
2915 | * Register Arguments:: | |
2916 | * Scalar Return:: | |
2917 | * Aggregate Return:: | |
2918 | * Caller Saves:: | |
2919 | * Function Entry:: | |
2920 | * Profiling:: | |
91d231cb | 2921 | * Tail Calls:: |
7d69de61 | 2922 | * Stack Smashing Protection:: |
feca2ed3 JW |
2923 | @end menu |
2924 | ||
2925 | @node Frame Layout | |
2926 | @subsection Basic Stack Layout | |
2927 | @cindex stack frame layout | |
2928 | @cindex frame layout | |
2929 | ||
2930 | @c prevent bad page break with this line | |
2931 | Here is the basic stack layout. | |
2932 | ||
a2c4f8e0 | 2933 | @defmac STACK_GROWS_DOWNWARD |
feca2ed3 JW |
2934 | Define this macro if pushing a word onto the stack moves the stack |
2935 | pointer to a smaller address. | |
2936 | ||
d78aa55c | 2937 | When we say, ``define this macro if @dots{}'', it means that the |
feca2ed3 JW |
2938 | compiler checks this macro only with @code{#ifdef} so the precise |
2939 | definition used does not matter. | |
a2c4f8e0 | 2940 | @end defmac |
feca2ed3 | 2941 | |
a2c4f8e0 | 2942 | @defmac STACK_PUSH_CODE |
918a6124 GK |
2943 | This macro defines the operation used when something is pushed |
2944 | on the stack. In RTL, a push operation will be | |
04a5176a | 2945 | @code{(set (mem (STACK_PUSH_CODE (reg sp))) @dots{})} |
918a6124 GK |
2946 | |
2947 | The choices are @code{PRE_DEC}, @code{POST_DEC}, @code{PRE_INC}, | |
2948 | and @code{POST_INC}. Which of these is correct depends on | |
2949 | the stack direction and on whether the stack pointer points | |
2950 | to the last item on the stack or whether it points to the | |
2951 | space for the next item on the stack. | |
2952 | ||
2953 | The default is @code{PRE_DEC} when @code{STACK_GROWS_DOWNWARD} is | |
2954 | defined, which is almost always right, and @code{PRE_INC} otherwise, | |
2955 | which is often wrong. | |
a2c4f8e0 | 2956 | @end defmac |
918a6124 | 2957 | |
a2c4f8e0 | 2958 | @defmac FRAME_GROWS_DOWNWARD |
a4d05547 | 2959 | Define this macro to nonzero value if the addresses of local variable slots |
f62c8a5c | 2960 | are at negative offsets from the frame pointer. |
a2c4f8e0 | 2961 | @end defmac |
feca2ed3 | 2962 | |
a2c4f8e0 | 2963 | @defmac ARGS_GROW_DOWNWARD |
feca2ed3 JW |
2964 | Define this macro if successive arguments to a function occupy decreasing |
2965 | addresses on the stack. | |
a2c4f8e0 | 2966 | @end defmac |
feca2ed3 | 2967 | |
a2c4f8e0 | 2968 | @defmac STARTING_FRAME_OFFSET |
feca2ed3 JW |
2969 | Offset from the frame pointer to the first local variable slot to be allocated. |
2970 | ||
2971 | If @code{FRAME_GROWS_DOWNWARD}, find the next slot's offset by | |
2972 | subtracting the first slot's length from @code{STARTING_FRAME_OFFSET}. | |
2973 | Otherwise, it is found by adding the length of the first slot to the | |
2974 | value @code{STARTING_FRAME_OFFSET}. | |
2975 | @c i'm not sure if the above is still correct.. had to change it to get | |
2976 | @c rid of an overfull. --mew 2feb93 | |
a2c4f8e0 | 2977 | @end defmac |
feca2ed3 | 2978 | |
a2c4f8e0 | 2979 | @defmac STACK_ALIGNMENT_NEEDED |
95f3f59e | 2980 | Define to zero to disable final alignment of the stack during reload. |
0b4be7de | 2981 | The nonzero default for this macro is suitable for most ports. |
95f3f59e | 2982 | |
0b4be7de | 2983 | On ports where @code{STARTING_FRAME_OFFSET} is nonzero or where there |
95f3f59e JDA |
2984 | is a register save block following the local block that doesn't require |
2985 | alignment to @code{STACK_BOUNDARY}, it may be beneficial to disable | |
2986 | stack alignment and do it in the backend. | |
a2c4f8e0 | 2987 | @end defmac |
95f3f59e | 2988 | |
a2c4f8e0 | 2989 | @defmac STACK_POINTER_OFFSET |
feca2ed3 JW |
2990 | Offset from the stack pointer register to the first location at which |
2991 | outgoing arguments are placed. If not specified, the default value of | |
2992 | zero is used. This is the proper value for most machines. | |
2993 | ||
2994 | If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above | |
2995 | the first location at which outgoing arguments are placed. | |
a2c4f8e0 | 2996 | @end defmac |
feca2ed3 | 2997 | |
a2c4f8e0 | 2998 | @defmac FIRST_PARM_OFFSET (@var{fundecl}) |
feca2ed3 JW |
2999 | Offset from the argument pointer register to the first argument's |
3000 | address. On some machines it may depend on the data type of the | |
3001 | function. | |
3002 | ||
3003 | If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above | |
3004 | the first argument's address. | |
a2c4f8e0 | 3005 | @end defmac |
feca2ed3 | 3006 | |
a2c4f8e0 | 3007 | @defmac STACK_DYNAMIC_OFFSET (@var{fundecl}) |
feca2ed3 JW |
3008 | Offset from the stack pointer register to an item dynamically allocated |
3009 | on the stack, e.g., by @code{alloca}. | |
3010 | ||
3011 | The default value for this macro is @code{STACK_POINTER_OFFSET} plus the | |
3012 | length of the outgoing arguments. The default is correct for most | |
3013 | machines. See @file{function.c} for details. | |
a2c4f8e0 | 3014 | @end defmac |
feca2ed3 | 3015 | |
c6d01079 AK |
3016 | @defmac INITIAL_FRAME_ADDRESS_RTX |
3017 | A C expression whose value is RTL representing the address of the initial | |
083cad55 | 3018 | stack frame. This address is passed to @code{RETURN_ADDR_RTX} and |
c8f27794 JW |
3019 | @code{DYNAMIC_CHAIN_ADDRESS}. If you don't define this macro, a reasonable |
3020 | default value will be used. Define this macro in order to make frame pointer | |
083cad55 | 3021 | elimination work in the presence of @code{__builtin_frame_address (count)} and |
c8f27794 | 3022 | @code{__builtin_return_address (count)} for @code{count} not equal to zero. |
c6d01079 AK |
3023 | @end defmac |
3024 | ||
a2c4f8e0 | 3025 | @defmac DYNAMIC_CHAIN_ADDRESS (@var{frameaddr}) |
feca2ed3 JW |
3026 | A C expression whose value is RTL representing the address in a stack |
3027 | frame where the pointer to the caller's frame is stored. Assume that | |
3028 | @var{frameaddr} is an RTL expression for the address of the stack frame | |
3029 | itself. | |
3030 | ||
3031 | If you don't define this macro, the default is to return the value | |
3032 | of @var{frameaddr}---that is, the stack frame address is also the | |
3033 | address of the stack word that points to the previous frame. | |
a2c4f8e0 | 3034 | @end defmac |
feca2ed3 | 3035 | |
a2c4f8e0 | 3036 | @defmac SETUP_FRAME_ADDRESSES |
feca2ed3 JW |
3037 | If defined, a C expression that produces the machine-specific code to |
3038 | setup the stack so that arbitrary frames can be accessed. For example, | |
981f6289 | 3039 | on the SPARC, we must flush all of the register windows to the stack |
0bc02db4 MS |
3040 | before we can access arbitrary stack frames. You will seldom need to |
3041 | define this macro. | |
a2c4f8e0 | 3042 | @end defmac |
0bc02db4 | 3043 | |
d6da68b9 KH |
3044 | @deftypefn {Target Hook} bool TARGET_BUILTIN_SETJMP_FRAME_VALUE () |
3045 | This target hook should return an rtx that is used to store | |
0bc02db4 MS |
3046 | the address of the current frame into the built in @code{setjmp} buffer. |
3047 | The default value, @code{virtual_stack_vars_rtx}, is correct for most | |
d6da68b9 | 3048 | machines. One reason you may need to define this target hook is if |
0bc02db4 | 3049 | @code{hard_frame_pointer_rtx} is the appropriate value on your machine. |
d6da68b9 | 3050 | @end deftypefn |
feca2ed3 | 3051 | |
224869d9 EB |
3052 | @defmac FRAME_ADDR_RTX (@var{frameaddr}) |
3053 | A C expression whose value is RTL representing the value of the frame | |
3054 | address for the current frame. @var{frameaddr} is the frame pointer | |
3055 | of the current frame. This is used for __builtin_frame_address. | |
3056 | You need only define this macro if the frame address is not the same | |
3057 | as the frame pointer. Most machines do not need to define it. | |
3058 | @end defmac | |
3059 | ||
a2c4f8e0 | 3060 | @defmac RETURN_ADDR_RTX (@var{count}, @var{frameaddr}) |
feca2ed3 | 3061 | A C expression whose value is RTL representing the value of the return |
861bb6c1 JL |
3062 | address for the frame @var{count} steps up from the current frame, after |
3063 | the prologue. @var{frameaddr} is the frame pointer of the @var{count} | |
3064 | frame, or the frame pointer of the @var{count} @minus{} 1 frame if | |
feca2ed3 JW |
3065 | @code{RETURN_ADDR_IN_PREVIOUS_FRAME} is defined. |
3066 | ||
e9a25f70 JL |
3067 | The value of the expression must always be the correct address when |
3068 | @var{count} is zero, but may be @code{NULL_RTX} if there is not way to | |
3069 | determine the return address of other frames. | |
a2c4f8e0 | 3070 | @end defmac |
e9a25f70 | 3071 | |
a2c4f8e0 | 3072 | @defmac RETURN_ADDR_IN_PREVIOUS_FRAME |
feca2ed3 JW |
3073 | Define this if the return address of a particular stack frame is accessed |
3074 | from the frame pointer of the previous stack frame. | |
a2c4f8e0 | 3075 | @end defmac |
861bb6c1 | 3076 | |
a2c4f8e0 | 3077 | @defmac INCOMING_RETURN_ADDR_RTX |
861bb6c1 JL |
3078 | A C expression whose value is RTL representing the location of the |
3079 | incoming return address at the beginning of any function, before the | |
3080 | prologue. This RTL is either a @code{REG}, indicating that the return | |
3081 | value is saved in @samp{REG}, or a @code{MEM} representing a location in | |
3082 | the stack. | |
3083 | ||
3084 | You only need to define this macro if you want to support call frame | |
3085 | debugging information like that provided by DWARF 2. | |
3086 | ||
2c849145 | 3087 | If this RTL is a @code{REG}, you should also define |
aee96fe9 | 3088 | @code{DWARF_FRAME_RETURN_COLUMN} to @code{DWARF_FRAME_REGNUM (REGNO)}. |
a2c4f8e0 | 3089 | @end defmac |
2c849145 | 3090 | |
ed80cd68 | 3091 | @defmac DWARF_ALT_FRAME_RETURN_COLUMN |
73774972 | 3092 | A C expression whose value is an integer giving a DWARF 2 column |
ed80cd68 | 3093 | number that may be used as an alternate return column. This should |
73774972 | 3094 | be defined only if @code{DWARF_FRAME_RETURN_COLUMN} is set to a |
ed80cd68 RH |
3095 | general register, but an alternate column needs to be used for |
3096 | signal frames. | |
3097 | @end defmac | |
3098 | ||
282efe1c RH |
3099 | @defmac DWARF_ZERO_REG |
3100 | A C expression whose value is an integer giving a DWARF 2 register | |
3101 | number that is considered to always have the value zero. This should | |
3102 | only be defined if the target has an architected zero register, and | |
3103 | someone decided it was a good idea to use that register number to | |
3104 | terminate the stack backtrace. New ports should avoid this. | |
3105 | @end defmac | |
3106 | ||
e54c7471 EB |
3107 | @deftypefn {Target Hook} void TARGET_DWARF_HANDLE_FRAME_UNSPEC (const char *@var{label}, rtx @var{pattern}, int @var{index}) |
3108 | This target hook allows the backend to emit frame-related insns that | |
3109 | contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging | |
3110 | info engine will invoke it on insns of the form | |
3111 | @smallexample | |
3112 | (set (reg) (unspec [...] UNSPEC_INDEX)) | |
3113 | @end smallexample | |
3114 | and | |
3115 | @smallexample | |
3116 | (set (reg) (unspec_volatile [...] UNSPECV_INDEX)). | |
3117 | @end smallexample | |
3118 | to let the backend emit the call frame instructions. @var{label} is | |
3119 | the CFI label attached to the insn, @var{pattern} is the pattern of | |
3120 | the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}. | |
3121 | @end deftypefn | |
3122 | ||
a2c4f8e0 | 3123 | @defmac INCOMING_FRAME_SP_OFFSET |
861bb6c1 JL |
3124 | A C expression whose value is an integer giving the offset, in bytes, |
3125 | from the value of the stack pointer register to the top of the stack | |
3126 | frame at the beginning of any function, before the prologue. The top of | |
3127 | the frame is defined to be the value of the stack pointer in the | |
3128 | previous frame, just before the call instruction. | |
3129 | ||
71038426 RH |
3130 | You only need to define this macro if you want to support call frame |
3131 | debugging information like that provided by DWARF 2. | |
a2c4f8e0 | 3132 | @end defmac |
71038426 | 3133 | |
a2c4f8e0 | 3134 | @defmac ARG_POINTER_CFA_OFFSET (@var{fundecl}) |
71038426 RH |
3135 | A C expression whose value is an integer giving the offset, in bytes, |
3136 | from the argument pointer to the canonical frame address (cfa). The | |
02f52e19 | 3137 | final value should coincide with that calculated by |
71038426 RH |
3138 | @code{INCOMING_FRAME_SP_OFFSET}. Which is unfortunately not usable |
3139 | during virtual register instantiation. | |
3140 | ||
2c849145 JM |
3141 | The default value for this macro is @code{FIRST_PARM_OFFSET (fundecl)}, |
3142 | which is correct for most machines; in general, the arguments are found | |
208e52d9 JM |
3143 | immediately before the stack frame. Note that this is not the case on |
3144 | some targets that save registers into the caller's frame, such as SPARC | |
3145 | and rs6000, and so such targets need to define this macro. | |
2c849145 | 3146 | |
208e52d9 | 3147 | You only need to define this macro if the default is incorrect, and you |
2c849145 JM |
3148 | want to support call frame debugging information like that provided by |
3149 | DWARF 2. | |
a2c4f8e0 | 3150 | @end defmac |
512b62fb | 3151 | |
f6672e8e RH |
3152 | @defmac FRAME_POINTER_CFA_OFFSET (@var{fundecl}) |
3153 | If defined, a C expression whose value is an integer giving the offset | |
3154 | in bytes from the frame pointer to the canonical frame address (cfa). | |
6fc0bb99 | 3155 | The final value should coincide with that calculated by |
f6672e8e RH |
3156 | @code{INCOMING_FRAME_SP_OFFSET}. |
3157 | ||
3158 | Normally the CFA is calculated as an offset from the argument pointer, | |
083cad55 | 3159 | via @code{ARG_POINTER_CFA_OFFSET}, but if the argument pointer is |
f6672e8e | 3160 | variable due to the ABI, this may not be possible. If this macro is |
6416ae7f | 3161 | defined, it implies that the virtual register instantiation should be |
f6672e8e RH |
3162 | based on the frame pointer instead of the argument pointer. Only one |
3163 | of @code{FRAME_POINTER_CFA_OFFSET} and @code{ARG_POINTER_CFA_OFFSET} | |
3164 | should be defined. | |
3165 | @end defmac | |
3166 | ||
35d177a2 AO |
3167 | @defmac CFA_FRAME_BASE_OFFSET (@var{fundecl}) |
3168 | If defined, a C expression whose value is an integer giving the offset | |
3169 | in bytes from the canonical frame address (cfa) to the frame base used | |
3170 | in DWARF 2 debug information. The default is zero. A different value | |
3171 | may reduce the size of debug information on some ports. | |
3172 | @end defmac | |
3173 | ||
7c16328b RH |
3174 | @node Exception Handling |
3175 | @subsection Exception Handling Support | |
3176 | @cindex exception handling | |
3177 | ||
a2c4f8e0 | 3178 | @defmac EH_RETURN_DATA_REGNO (@var{N}) |
52a11cbf RH |
3179 | A C expression whose value is the @var{N}th register number used for |
3180 | data by exception handlers, or @code{INVALID_REGNUM} if fewer than | |
3181 | @var{N} registers are usable. | |
3182 | ||
3183 | The exception handling library routines communicate with the exception | |
3184 | handlers via a set of agreed upon registers. Ideally these registers | |
3185 | should be call-clobbered; it is possible to use call-saved registers, | |
3186 | but may negatively impact code size. The target must support at least | |
3187 | 2 data registers, but should define 4 if there are enough free registers. | |
3188 | ||
3189 | You must define this macro if you want to support call frame exception | |
3190 | handling like that provided by DWARF 2. | |
a2c4f8e0 | 3191 | @end defmac |
52a11cbf | 3192 | |
a2c4f8e0 | 3193 | @defmac EH_RETURN_STACKADJ_RTX |
52a11cbf RH |
3194 | A C expression whose value is RTL representing a location in which |
3195 | to store a stack adjustment to be applied before function return. | |
3196 | This is used to unwind the stack to an exception handler's call frame. | |
3197 | It will be assigned zero on code paths that return normally. | |
3198 | ||
02f52e19 | 3199 | Typically this is a call-clobbered hard register that is otherwise |
52a11cbf RH |
3200 | untouched by the epilogue, but could also be a stack slot. |
3201 | ||
34dc173c | 3202 | Do not define this macro if the stack pointer is saved and restored |
73774972 EC |
3203 | by the regular prolog and epilog code in the call frame itself; in |
3204 | this case, the exception handling library routines will update the | |
3205 | stack location to be restored in place. Otherwise, you must define | |
3206 | this macro if you want to support call frame exception handling like | |
34dc173c | 3207 | that provided by DWARF 2. |
a2c4f8e0 | 3208 | @end defmac |
52a11cbf | 3209 | |
a2c4f8e0 | 3210 | @defmac EH_RETURN_HANDLER_RTX |
52a11cbf | 3211 | A C expression whose value is RTL representing a location in which |
02f52e19 | 3212 | to store the address of an exception handler to which we should |
52a11cbf RH |
3213 | return. It will not be assigned on code paths that return normally. |
3214 | ||
3215 | Typically this is the location in the call frame at which the normal | |
02f52e19 AJ |
3216 | return address is stored. For targets that return by popping an |
3217 | address off the stack, this might be a memory address just below | |
52a11cbf | 3218 | the @emph{target} call frame rather than inside the current call |
73774972 EC |
3219 | frame. If defined, @code{EH_RETURN_STACKADJ_RTX} will have already |
3220 | been assigned, so it may be used to calculate the location of the | |
34dc173c | 3221 | target call frame. |
52a11cbf RH |
3222 | |
3223 | Some targets have more complex requirements than storing to an | |
3224 | address calculable during initial code generation. In that case | |
3225 | the @code{eh_return} instruction pattern should be used instead. | |
3226 | ||
3227 | If you want to support call frame exception handling, you must | |
3228 | define either this macro or the @code{eh_return} instruction pattern. | |
a2c4f8e0 | 3229 | @end defmac |
52a11cbf | 3230 | |
1e60c057 R |
3231 | @defmac RETURN_ADDR_OFFSET |
3232 | If defined, an integer-valued C expression for which rtl will be generated | |
3233 | to add it to the exception handler address before it is searched in the | |
3234 | exception handling tables, and to subtract it again from the address before | |
3235 | using it to return to the exception handler. | |
3236 | @end defmac | |
3237 | ||
a2c4f8e0 | 3238 | @defmac ASM_PREFERRED_EH_DATA_FORMAT (@var{code}, @var{global}) |
2a1ee410 RH |
3239 | This macro chooses the encoding of pointers embedded in the exception |
3240 | handling sections. If at all possible, this should be defined such | |
3241 | that the exception handling section will not require dynamic relocations, | |
3242 | and so may be read-only. | |
3243 | ||
aee96fe9 JM |
3244 | @var{code} is 0 for data, 1 for code labels, 2 for function pointers. |
3245 | @var{global} is true if the symbol may be affected by dynamic relocations. | |
2a1ee410 RH |
3246 | The macro should return a combination of the @code{DW_EH_PE_*} defines |
3247 | as found in @file{dwarf2.h}. | |
3248 | ||
ebb48a4d | 3249 | If this macro is not defined, pointers will not be encoded but |
2a1ee410 | 3250 | represented directly. |
a2c4f8e0 | 3251 | @end defmac |
2a1ee410 | 3252 | |
a2c4f8e0 | 3253 | @defmac ASM_MAYBE_OUTPUT_ENCODED_ADDR_RTX (@var{file}, @var{encoding}, @var{size}, @var{addr}, @var{done}) |
2a1ee410 RH |
3254 | This macro allows the target to emit whatever special magic is required |
3255 | to represent the encoding chosen by @code{ASM_PREFERRED_EH_DATA_FORMAT}. | |
3256 | Generic code takes care of pc-relative and indirect encodings; this must | |
3257 | be defined if the target uses text-relative or data-relative encodings. | |
3258 | ||
aee96fe9 JM |
3259 | This is a C statement that branches to @var{done} if the format was |
3260 | handled. @var{encoding} is the format chosen, @var{size} is the number | |
3261 | of bytes that the format occupies, @var{addr} is the @code{SYMBOL_REF} | |
2a1ee410 | 3262 | to be emitted. |
a2c4f8e0 | 3263 | @end defmac |
2a1ee410 | 3264 | |
8662eb14 AM |
3265 | @defmac MD_UNWIND_SUPPORT |
3266 | A string specifying a file to be #include'd in unwind-dw2.c. The file | |
3267 | so included typically defines @code{MD_FALLBACK_FRAME_STATE_FOR}. | |
3268 | @end defmac | |
3269 | ||
3270 | @defmac MD_FALLBACK_FRAME_STATE_FOR (@var{context}, @var{fs}) | |
7c16328b RH |
3271 | This macro allows the target to add cpu and operating system specific |
3272 | code to the call-frame unwinder for use when there is no unwind data | |
3273 | available. The most common reason to implement this macro is to unwind | |
3274 | through signal frames. | |
3275 | ||
3276 | This macro is called from @code{uw_frame_state_for} in @file{unwind-dw2.c} | |
3277 | and @file{unwind-ia64.c}. @var{context} is an @code{_Unwind_Context}; | |
3278 | @var{fs} is an @code{_Unwind_FrameState}. Examine @code{context->ra} | |
3279 | for the address of the code being executed and @code{context->cfa} for | |
3280 | the stack pointer value. If the frame can be decoded, the register save | |
8662eb14 AM |
3281 | addresses should be updated in @var{fs} and the macro should evaluate to |
3282 | @code{_URC_NO_REASON}. If the frame cannot be decoded, the macro should | |
3283 | evaluate to @code{_URC_END_OF_STACK}. | |
8207b189 FS |
3284 | |
3285 | For proper signal handling in Java this macro is accompanied by | |
3286 | @code{MAKE_THROW_FRAME}, defined in @file{libjava/include/*-signal.h} headers. | |
a2c4f8e0 | 3287 | @end defmac |
861bb6c1 | 3288 | |
3950dcdf JJ |
3289 | @defmac MD_HANDLE_UNWABI (@var{context}, @var{fs}) |
3290 | This macro allows the target to add operating system specific code to the | |
3291 | call-frame unwinder to handle the IA-64 @code{.unwabi} unwinding directive, | |
3292 | usually used for signal or interrupt frames. | |
3293 | ||
3294 | This macro is called from @code{uw_update_context} in @file{unwind-ia64.c}. | |
3295 | @var{context} is an @code{_Unwind_Context}; | |
3296 | @var{fs} is an @code{_Unwind_FrameState}. Examine @code{fs->unwabi} | |
3297 | for the abi and context in the @code{.unwabi} directive. If the | |
3298 | @code{.unwabi} directive can be handled, the register save addresses should | |
3299 | be updated in @var{fs}. | |
3300 | @end defmac | |
3301 | ||
4746cf84 MA |
3302 | @defmac TARGET_USES_WEAK_UNWIND_INFO |
3303 | A C expression that evaluates to true if the target requires unwind | |
3304 | info to be given comdat linkage. Define it to be @code{1} if comdat | |
3305 | linkage is necessary. The default is @code{0}. | |
3306 | @end defmac | |
3307 | ||
861bb6c1 JL |
3308 | @node Stack Checking |
3309 | @subsection Specifying How Stack Checking is Done | |
3310 | ||
a3a15b4d | 3311 | GCC will check that stack references are within the boundaries of |
630d3d5a | 3312 | the stack, if the @option{-fstack-check} is specified, in one of three ways: |
861bb6c1 JL |
3313 | |
3314 | @enumerate | |
3315 | @item | |
a3a15b4d | 3316 | If the value of the @code{STACK_CHECK_BUILTIN} macro is nonzero, GCC |
861bb6c1 JL |
3317 | will assume that you have arranged for stack checking to be done at |
3318 | appropriate places in the configuration files, e.g., in | |
08c148a8 NB |
3319 | @code{TARGET_ASM_FUNCTION_PROLOGUE}. GCC will do not other special |
3320 | processing. | |
861bb6c1 JL |
3321 | |
3322 | @item | |
3323 | If @code{STACK_CHECK_BUILTIN} is zero and you defined a named pattern | |
a3a15b4d | 3324 | called @code{check_stack} in your @file{md} file, GCC will call that |
861bb6c1 JL |
3325 | pattern with one argument which is the address to compare the stack |
3326 | value against. You must arrange for this pattern to report an error if | |
3327 | the stack pointer is out of range. | |
3328 | ||
3329 | @item | |
a3a15b4d | 3330 | If neither of the above are true, GCC will generate code to periodically |
861bb6c1 JL |
3331 | ``probe'' the stack pointer using the values of the macros defined below. |
3332 | @end enumerate | |
3333 | ||
a3a15b4d | 3334 | Normally, you will use the default values of these macros, so GCC |
861bb6c1 JL |
3335 | will use the third approach. |
3336 | ||
a2c4f8e0 | 3337 | @defmac STACK_CHECK_BUILTIN |
861bb6c1 | 3338 | A nonzero value if stack checking is done by the configuration files in a |
02f52e19 AJ |
3339 | machine-dependent manner. You should define this macro if stack checking |
3340 | is require by the ABI of your machine or if you would like to have to stack | |
a3a15b4d | 3341 | checking in some more efficient way than GCC's portable approach. |
861bb6c1 | 3342 | The default value of this macro is zero. |
a2c4f8e0 | 3343 | @end defmac |
861bb6c1 | 3344 | |
a2c4f8e0 | 3345 | @defmac STACK_CHECK_PROBE_INTERVAL |
a3a15b4d | 3346 | An integer representing the interval at which GCC must generate stack |
861bb6c1 JL |
3347 | probe instructions. You will normally define this macro to be no larger |
3348 | than the size of the ``guard pages'' at the end of a stack area. The | |
3349 | default value of 4096 is suitable for most systems. | |
a2c4f8e0 | 3350 | @end defmac |
861bb6c1 | 3351 | |
a2c4f8e0 | 3352 | @defmac STACK_CHECK_PROBE_LOAD |
02f52e19 | 3353 | A integer which is nonzero if GCC should perform the stack probe |
a3a15b4d | 3354 | as a load instruction and zero if GCC should use a store instruction. |
861bb6c1 | 3355 | The default is zero, which is the most efficient choice on most systems. |
a2c4f8e0 | 3356 | @end defmac |
861bb6c1 | 3357 | |
a2c4f8e0 | 3358 | @defmac STACK_CHECK_PROTECT |
861bb6c1 JL |
3359 | The number of bytes of stack needed to recover from a stack overflow, |
3360 | for languages where such a recovery is supported. The default value of | |
3361 | 75 words should be adequate for most machines. | |
a2c4f8e0 | 3362 | @end defmac |
861bb6c1 | 3363 | |
a2c4f8e0 | 3364 | @defmac STACK_CHECK_MAX_FRAME_SIZE |
a3a15b4d | 3365 | The maximum size of a stack frame, in bytes. GCC will generate probe |
861bb6c1 JL |
3366 | instructions in non-leaf functions to ensure at least this many bytes of |
3367 | stack are available. If a stack frame is larger than this size, stack | |
a3a15b4d JL |
3368 | checking will not be reliable and GCC will issue a warning. The |
3369 | default is chosen so that GCC only generates one instruction on most | |
861bb6c1 | 3370 | systems. You should normally not change the default value of this macro. |
a2c4f8e0 | 3371 | @end defmac |
861bb6c1 | 3372 | |
a2c4f8e0 | 3373 | @defmac STACK_CHECK_FIXED_FRAME_SIZE |
a3a15b4d | 3374 | GCC uses this value to generate the above warning message. It |
861bb6c1 JL |
3375 | represents the amount of fixed frame used by a function, not including |
3376 | space for any callee-saved registers, temporaries and user variables. | |
3377 | You need only specify an upper bound for this amount and will normally | |
3378 | use the default of four words. | |
a2c4f8e0 | 3379 | @end defmac |
861bb6c1 | 3380 | |
a2c4f8e0 | 3381 | @defmac STACK_CHECK_MAX_VAR_SIZE |
a3a15b4d | 3382 | The maximum size, in bytes, of an object that GCC will place in the |
861bb6c1 | 3383 | fixed area of the stack frame when the user specifies |
630d3d5a | 3384 | @option{-fstack-check}. |
a3a15b4d | 3385 | GCC computed the default from the values of the above macros and you will |
861bb6c1 | 3386 | normally not need to override that default. |
a2c4f8e0 | 3387 | @end defmac |
feca2ed3 JW |
3388 | |
3389 | @need 2000 | |
3390 | @node Frame Registers | |
3391 | @subsection Registers That Address the Stack Frame | |
3392 | ||
3393 | @c prevent bad page break with this line | |
3394 | This discusses registers that address the stack frame. | |
3395 | ||
a2c4f8e0 | 3396 | @defmac STACK_POINTER_REGNUM |
feca2ed3 JW |
3397 | The register number of the stack pointer register, which must also be a |
3398 | fixed register according to @code{FIXED_REGISTERS}. On most machines, | |
3399 | the hardware determines which register this is. | |
a2c4f8e0 | 3400 | @end defmac |
feca2ed3 | 3401 | |
a2c4f8e0 | 3402 | @defmac FRAME_POINTER_REGNUM |
feca2ed3 JW |
3403 | The register number of the frame pointer register, which is used to |
3404 | access automatic variables in the stack frame. On some machines, the | |
3405 | hardware determines which register this is. On other machines, you can | |
3406 | choose any register you wish for this purpose. | |
a2c4f8e0 | 3407 | @end defmac |
feca2ed3 | 3408 | |
a2c4f8e0 | 3409 | @defmac HARD_FRAME_POINTER_REGNUM |
feca2ed3 JW |
3410 | On some machines the offset between the frame pointer and starting |
3411 | offset of the automatic variables is not known until after register | |
3412 | allocation has been done (for example, because the saved registers are | |
3413 | between these two locations). On those machines, define | |
3414 | @code{FRAME_POINTER_REGNUM} the number of a special, fixed register to | |
3415 | be used internally until the offset is known, and define | |
556e0f21 | 3416 | @code{HARD_FRAME_POINTER_REGNUM} to be the actual hard register number |
feca2ed3 JW |
3417 | used for the frame pointer. |
3418 | ||
3419 | You should define this macro only in the very rare circumstances when it | |
3420 | is not possible to calculate the offset between the frame pointer and | |
3421 | the automatic variables until after register allocation has been | |
3422 | completed. When this macro is defined, you must also indicate in your | |
3423 | definition of @code{ELIMINABLE_REGS} how to eliminate | |
3424 | @code{FRAME_POINTER_REGNUM} into either @code{HARD_FRAME_POINTER_REGNUM} | |
3425 | or @code{STACK_POINTER_REGNUM}. | |
3426 | ||
3427 | Do not define this macro if it would be the same as | |
3428 | @code{FRAME_POINTER_REGNUM}. | |
a2c4f8e0 | 3429 | @end defmac |
feca2ed3 | 3430 | |
a2c4f8e0 | 3431 | @defmac ARG_POINTER_REGNUM |
feca2ed3 JW |
3432 | The register number of the arg pointer register, which is used to access |
3433 | the function's argument list. On some machines, this is the same as the | |
3434 | frame pointer register. On some machines, the hardware determines which | |
3435 | register this is. On other machines, you can choose any register you | |
3436 | wish for this purpose. If this is not the same register as the frame | |
3437 | pointer register, then you must mark it as a fixed register according to | |
3438 | @code{FIXED_REGISTERS}, or arrange to be able to eliminate it | |
3439 | (@pxref{Elimination}). | |
a2c4f8e0 | 3440 | @end defmac |
feca2ed3 | 3441 | |
a2c4f8e0 | 3442 | @defmac RETURN_ADDRESS_POINTER_REGNUM |
feca2ed3 JW |
3443 | The register number of the return address pointer register, which is used to |
3444 | access the current function's return address from the stack. On some | |
3445 | machines, the return address is not at a fixed offset from the frame | |
3446 | pointer or stack pointer or argument pointer. This register can be defined | |
3447 | to point to the return address on the stack, and then be converted by | |
3448 | @code{ELIMINABLE_REGS} into either the frame pointer or stack pointer. | |
3449 | ||
3450 | Do not define this macro unless there is no other way to get the return | |
3451 | address from the stack. | |
a2c4f8e0 | 3452 | @end defmac |
feca2ed3 | 3453 | |
a2c4f8e0 ZW |
3454 | @defmac STATIC_CHAIN_REGNUM |
3455 | @defmacx STATIC_CHAIN_INCOMING_REGNUM | |
feca2ed3 JW |
3456 | Register numbers used for passing a function's static chain pointer. If |
3457 | register windows are used, the register number as seen by the called | |
3458 | function is @code{STATIC_CHAIN_INCOMING_REGNUM}, while the register | |
3459 | number as seen by the calling function is @code{STATIC_CHAIN_REGNUM}. If | |
3460 | these registers are the same, @code{STATIC_CHAIN_INCOMING_REGNUM} need | |
bd819a4a | 3461 | not be defined. |
feca2ed3 JW |
3462 | |
3463 | The static chain register need not be a fixed register. | |
3464 | ||
3465 | If the static chain is passed in memory, these macros should not be | |
3466 | defined; instead, the next two macros should be defined. | |
a2c4f8e0 | 3467 | @end defmac |
feca2ed3 | 3468 | |
a2c4f8e0 ZW |
3469 | @defmac STATIC_CHAIN |
3470 | @defmacx STATIC_CHAIN_INCOMING | |
feca2ed3 JW |
3471 | If the static chain is passed in memory, these macros provide rtx giving |
3472 | @code{mem} expressions that denote where they are stored. | |
3473 | @code{STATIC_CHAIN} and @code{STATIC_CHAIN_INCOMING} give the locations | |
3474 | as seen by the calling and called functions, respectively. Often the former | |
3475 | will be at an offset from the stack pointer and the latter at an offset from | |
bd819a4a | 3476 | the frame pointer. |
feca2ed3 JW |
3477 | |
3478 | @findex stack_pointer_rtx | |
3479 | @findex frame_pointer_rtx | |
3480 | @findex arg_pointer_rtx | |
3481 | The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and | |
3482 | @code{arg_pointer_rtx} will have been initialized prior to the use of these | |
3483 | macros and should be used to refer to those items. | |
3484 | ||
3485 | If the static chain is passed in a register, the two previous macros should | |
3486 | be defined instead. | |
a2c4f8e0 | 3487 | @end defmac |
919543ab | 3488 | |
a2c4f8e0 | 3489 | @defmac DWARF_FRAME_REGISTERS |
919543ab AH |
3490 | This macro specifies the maximum number of hard registers that can be |
3491 | saved in a call frame. This is used to size data structures used in | |
3492 | DWARF2 exception handling. | |
3493 | ||
3494 | Prior to GCC 3.0, this macro was needed in order to establish a stable | |
3495 | exception handling ABI in the face of adding new hard registers for ISA | |
3496 | extensions. In GCC 3.0 and later, the EH ABI is insulated from changes | |
3497 | in the number of hard registers. Nevertheless, this macro can still be | |
3498 | used to reduce the runtime memory requirements of the exception handling | |
3499 | routines, which can be substantial if the ISA contains a lot of | |
3500 | registers that are not call-saved. | |
3501 | ||
3502 | If this macro is not defined, it defaults to | |
3503 | @code{FIRST_PSEUDO_REGISTER}. | |
a2c4f8e0 | 3504 | @end defmac |
919543ab | 3505 | |
a2c4f8e0 | 3506 | @defmac PRE_GCC3_DWARF_FRAME_REGISTERS |
919543ab AH |
3507 | |
3508 | This macro is similar to @code{DWARF_FRAME_REGISTERS}, but is provided | |
3509 | for backward compatibility in pre GCC 3.0 compiled code. | |
3510 | ||
3511 | If this macro is not defined, it defaults to | |
3512 | @code{DWARF_FRAME_REGISTERS}. | |
a2c4f8e0 | 3513 | @end defmac |
919543ab | 3514 | |
a2c4f8e0 | 3515 | @defmac DWARF_REG_TO_UNWIND_COLUMN (@var{regno}) |
41f3a930 AH |
3516 | |
3517 | Define this macro if the target's representation for dwarf registers | |
3518 | is different than the internal representation for unwind column. | |
61aeb06f | 3519 | Given a dwarf register, this macro should return the internal unwind |
41f3a930 AH |
3520 | column number to use instead. |
3521 | ||
73774972 | 3522 | See the PowerPC's SPE target for an example. |
a2c4f8e0 | 3523 | @end defmac |
feca2ed3 | 3524 | |
34c80057 AM |
3525 | @defmac DWARF_FRAME_REGNUM (@var{regno}) |
3526 | ||
3527 | Define this macro if the target's representation for dwarf registers | |
3528 | used in .eh_frame or .debug_frame is different from that used in other | |
2dd76960 | 3529 | debug info sections. Given a GCC hard register number, this macro |
34c80057 AM |
3530 | should return the .eh_frame register number. The default is |
3531 | @code{DBX_REGISTER_NUMBER (@var{regno})}. | |
3532 | ||
3533 | @end defmac | |
3534 | ||
3535 | @defmac DWARF2_FRAME_REG_OUT (@var{regno}, @var{for_eh}) | |
3536 | ||
3537 | Define this macro to map register numbers held in the call frame info | |
2dd76960 | 3538 | that GCC has collected using @code{DWARF_FRAME_REGNUM} to those that |
34c80057 | 3539 | should be output in .debug_frame (@code{@var{for_eh}} is zero) and |
f676971a | 3540 | .eh_frame (@code{@var{for_eh}} is nonzero). The default is to |
34c80057 AM |
3541 | return @code{@var{regno}}. |
3542 | ||
3543 | @end defmac | |
3544 | ||
feca2ed3 JW |
3545 | @node Elimination |
3546 | @subsection Eliminating Frame Pointer and Arg Pointer | |
3547 | ||
3548 | @c prevent bad page break with this line | |
3549 | This is about eliminating the frame pointer and arg pointer. | |
3550 | ||
a2c4f8e0 | 3551 | @defmac FRAME_POINTER_REQUIRED |
feca2ed3 JW |
3552 | A C expression which is nonzero if a function must have and use a frame |
3553 | pointer. This expression is evaluated in the reload pass. If its value is | |
3554 | nonzero the function will have a frame pointer. | |
3555 | ||
3556 | The expression can in principle examine the current function and decide | |
3557 | according to the facts, but on most machines the constant 0 or the | |
3558 | constant 1 suffices. Use 0 when the machine allows code to be generated | |
3559 | with no frame pointer, and doing so saves some time or space. Use 1 | |
3560 | when there is no possible advantage to avoiding a frame pointer. | |
3561 | ||
3562 | In certain cases, the compiler does not know how to produce valid code | |
3563 | without a frame pointer. The compiler recognizes those cases and | |
3564 | automatically gives the function a frame pointer regardless of what | |
3565 | @code{FRAME_POINTER_REQUIRED} says. You don't need to worry about | |
bd819a4a | 3566 | them. |
feca2ed3 JW |
3567 | |
3568 | In a function that does not require a frame pointer, the frame pointer | |
3569 | register can be allocated for ordinary usage, unless you mark it as a | |
3570 | fixed register. See @code{FIXED_REGISTERS} for more information. | |
a2c4f8e0 | 3571 | @end defmac |
feca2ed3 | 3572 | |
feca2ed3 | 3573 | @findex get_frame_size |
a2c4f8e0 | 3574 | @defmac INITIAL_FRAME_POINTER_OFFSET (@var{depth-var}) |
feca2ed3 JW |
3575 | A C statement to store in the variable @var{depth-var} the difference |
3576 | between the frame pointer and the stack pointer values immediately after | |
3577 | the function prologue. The value would be computed from information | |
3578 | such as the result of @code{get_frame_size ()} and the tables of | |
3579 | registers @code{regs_ever_live} and @code{call_used_regs}. | |
3580 | ||
3581 | If @code{ELIMINABLE_REGS} is defined, this macro will be not be used and | |
3582 | need not be defined. Otherwise, it must be defined even if | |
3583 | @code{FRAME_POINTER_REQUIRED} is defined to always be true; in that | |
3584 | case, you may set @var{depth-var} to anything. | |
a2c4f8e0 | 3585 | @end defmac |
feca2ed3 | 3586 | |
a2c4f8e0 | 3587 | @defmac ELIMINABLE_REGS |
feca2ed3 JW |
3588 | If defined, this macro specifies a table of register pairs used to |
3589 | eliminate unneeded registers that point into the stack frame. If it is not | |
3590 | defined, the only elimination attempted by the compiler is to replace | |
3591 | references to the frame pointer with references to the stack pointer. | |
3592 | ||
3593 | The definition of this macro is a list of structure initializations, each | |
3594 | of which specifies an original and replacement register. | |
3595 | ||
3596 | On some machines, the position of the argument pointer is not known until | |
3597 | the compilation is completed. In such a case, a separate hard register | |
3598 | must be used for the argument pointer. This register can be eliminated by | |
3599 | replacing it with either the frame pointer or the argument pointer, | |
3600 | depending on whether or not the frame pointer has been eliminated. | |
3601 | ||
3602 | In this case, you might specify: | |
3ab51846 | 3603 | @smallexample |
feca2ed3 JW |
3604 | #define ELIMINABLE_REGS \ |
3605 | @{@{ARG_POINTER_REGNUM, STACK_POINTER_REGNUM@}, \ | |
3606 | @{ARG_POINTER_REGNUM, FRAME_POINTER_REGNUM@}, \ | |
3607 | @{FRAME_POINTER_REGNUM, STACK_POINTER_REGNUM@}@} | |
3ab51846 | 3608 | @end smallexample |
feca2ed3 JW |
3609 | |
3610 | Note that the elimination of the argument pointer with the stack pointer is | |
3611 | specified first since that is the preferred elimination. | |
a2c4f8e0 | 3612 | @end defmac |
feca2ed3 | 3613 | |
a2c4f8e0 | 3614 | @defmac CAN_ELIMINATE (@var{from-reg}, @var{to-reg}) |
df2a54e9 | 3615 | A C expression that returns nonzero if the compiler is allowed to try |
feca2ed3 JW |
3616 | to replace register number @var{from-reg} with register number |
3617 | @var{to-reg}. This macro need only be defined if @code{ELIMINABLE_REGS} | |
3618 | is defined, and will usually be the constant 1, since most of the cases | |
3619 | preventing register elimination are things that the compiler already | |
3620 | knows about. | |
a2c4f8e0 | 3621 | @end defmac |
feca2ed3 | 3622 | |
a2c4f8e0 | 3623 | @defmac INITIAL_ELIMINATION_OFFSET (@var{from-reg}, @var{to-reg}, @var{offset-var}) |
feca2ed3 JW |
3624 | This macro is similar to @code{INITIAL_FRAME_POINTER_OFFSET}. It |
3625 | specifies the initial difference between the specified pair of | |
3626 | registers. This macro must be defined if @code{ELIMINABLE_REGS} is | |
3627 | defined. | |
a2c4f8e0 | 3628 | @end defmac |
feca2ed3 JW |
3629 | |
3630 | @node Stack Arguments | |
3631 | @subsection Passing Function Arguments on the Stack | |
3632 | @cindex arguments on stack | |
3633 | @cindex stack arguments | |
3634 | ||
3635 | The macros in this section control how arguments are passed | |
3636 | on the stack. See the following section for other macros that | |
3637 | control passing certain arguments in registers. | |
3638 | ||
61f71b34 DD |
3639 | @deftypefn {Target Hook} bool TARGET_PROMOTE_PROTOTYPES (tree @var{fntype}) |
3640 | This target hook returns @code{true} if an argument declared in a | |
3641 | prototype as an integral type smaller than @code{int} should actually be | |
3642 | passed as an @code{int}. In addition to avoiding errors in certain | |
3643 | cases of mismatch, it also makes for better code on certain machines. | |
3644 | The default is to not promote prototypes. | |
3645 | @end deftypefn | |
feca2ed3 | 3646 | |
a2c4f8e0 | 3647 | @defmac PUSH_ARGS |
767094dd | 3648 | A C expression. If nonzero, push insns will be used to pass |
f73ad30e JH |
3649 | outgoing arguments. |
3650 | If the target machine does not have a push instruction, set it to zero. | |
3651 | That directs GCC to use an alternate strategy: to | |
3652 | allocate the entire argument block and then store the arguments into | |
aee96fe9 | 3653 | it. When @code{PUSH_ARGS} is nonzero, @code{PUSH_ROUNDING} must be defined too. |
a2c4f8e0 | 3654 | @end defmac |
f73ad30e | 3655 | |
9d6bef95 JM |
3656 | @defmac PUSH_ARGS_REVERSED |
3657 | A C expression. If nonzero, function arguments will be evaluated from | |
3658 | last to first, rather than from first to last. If this macro is not | |
3659 | defined, it defaults to @code{PUSH_ARGS} on targets where the stack | |
3660 | and args grow in opposite directions, and 0 otherwise. | |
3661 | @end defmac | |
3662 | ||
a2c4f8e0 | 3663 | @defmac PUSH_ROUNDING (@var{npushed}) |
feca2ed3 JW |
3664 | A C expression that is the number of bytes actually pushed onto the |
3665 | stack when an instruction attempts to push @var{npushed} bytes. | |
feca2ed3 JW |
3666 | |
3667 | On some machines, the definition | |
3668 | ||
3ab51846 | 3669 | @smallexample |
feca2ed3 | 3670 | #define PUSH_ROUNDING(BYTES) (BYTES) |
3ab51846 | 3671 | @end smallexample |
feca2ed3 JW |
3672 | |
3673 | @noindent | |
3674 | will suffice. But on other machines, instructions that appear | |
3675 | to push one byte actually push two bytes in an attempt to maintain | |
3676 | alignment. Then the definition should be | |
3677 | ||
3ab51846 | 3678 | @smallexample |
feca2ed3 | 3679 | #define PUSH_ROUNDING(BYTES) (((BYTES) + 1) & ~1) |
3ab51846 | 3680 | @end smallexample |
a2c4f8e0 | 3681 | @end defmac |
feca2ed3 | 3682 | |
feca2ed3 | 3683 | @findex current_function_outgoing_args_size |
a2c4f8e0 | 3684 | @defmac ACCUMULATE_OUTGOING_ARGS |
767094dd | 3685 | A C expression. If nonzero, the maximum amount of space required for outgoing arguments |
feca2ed3 JW |
3686 | will be computed and placed into the variable |
3687 | @code{current_function_outgoing_args_size}. No space will be pushed | |
3688 | onto the stack for each call; instead, the function prologue should | |
3689 | increase the stack frame size by this amount. | |
3690 | ||
f73ad30e | 3691 | Setting both @code{PUSH_ARGS} and @code{ACCUMULATE_OUTGOING_ARGS} |
feca2ed3 | 3692 | is not proper. |
a2c4f8e0 | 3693 | @end defmac |
feca2ed3 | 3694 | |
a2c4f8e0 | 3695 | @defmac REG_PARM_STACK_SPACE (@var{fndecl}) |
feca2ed3 JW |
3696 | Define this macro if functions should assume that stack space has been |
3697 | allocated for arguments even when their values are passed in | |
3698 | registers. | |
3699 | ||
3700 | The value of this macro is the size, in bytes, of the area reserved for | |
ab87f8c8 | 3701 | arguments passed in registers for the function represented by @var{fndecl}, |
a3a15b4d | 3702 | which can be zero if GCC is calling a library function. |
feca2ed3 JW |
3703 | |
3704 | This space can be allocated by the caller, or be a part of the | |
3705 | machine-dependent stack frame: @code{OUTGOING_REG_PARM_STACK_SPACE} says | |
3706 | which. | |
a2c4f8e0 | 3707 | @end defmac |
feca2ed3 JW |
3708 | @c above is overfull. not sure what to do. --mew 5feb93 did |
3709 | @c something, not sure if it looks good. --mew 10feb93 | |
3710 | ||
a2c4f8e0 | 3711 | @defmac OUTGOING_REG_PARM_STACK_SPACE |
feca2ed3 JW |
3712 | Define this if it is the responsibility of the caller to allocate the area |
3713 | reserved for arguments passed in registers. | |
3714 | ||
3715 | If @code{ACCUMULATE_OUTGOING_ARGS} is defined, this macro controls | |
3716 | whether the space for these arguments counts in the value of | |
3717 | @code{current_function_outgoing_args_size}. | |
a2c4f8e0 | 3718 | @end defmac |
feca2ed3 | 3719 | |
a2c4f8e0 | 3720 | @defmac STACK_PARMS_IN_REG_PARM_AREA |
feca2ed3 JW |
3721 | Define this macro if @code{REG_PARM_STACK_SPACE} is defined, but the |
3722 | stack parameters don't skip the area specified by it. | |
3723 | @c i changed this, makes more sens and it should have taken care of the | |
3724 | @c overfull.. not as specific, tho. --mew 5feb93 | |
3725 | ||
3726 | Normally, when a parameter is not passed in registers, it is placed on the | |
3727 | stack beyond the @code{REG_PARM_STACK_SPACE} area. Defining this macro | |
3728 | suppresses this behavior and causes the parameter to be passed on the | |
3729 | stack in its natural location. | |
a2c4f8e0 | 3730 | @end defmac |
feca2ed3 | 3731 | |
a2c4f8e0 | 3732 | @defmac RETURN_POPS_ARGS (@var{fundecl}, @var{funtype}, @var{stack-size}) |
feca2ed3 JW |
3733 | A C expression that should indicate the number of bytes of its own |
3734 | arguments that a function pops on returning, or 0 if the | |
3735 | function pops no arguments and the caller must therefore pop them all | |
3736 | after the function returns. | |
3737 | ||
3738 | @var{fundecl} is a C variable whose value is a tree node that describes | |
3739 | the function in question. Normally it is a node of type | |
3740 | @code{FUNCTION_DECL} that describes the declaration of the function. | |
91d231cb | 3741 | From this you can obtain the @code{DECL_ATTRIBUTES} of the function. |
feca2ed3 JW |
3742 | |
3743 | @var{funtype} is a C variable whose value is a tree node that | |
3744 | describes the function in question. Normally it is a node of type | |
3745 | @code{FUNCTION_TYPE} that describes the data type of the function. | |
3746 | From this it is possible to obtain the data types of the value and | |
3747 | arguments (if known). | |
3748 | ||
861bb6c1 | 3749 | When a call to a library function is being considered, @var{fundecl} |
feca2ed3 JW |
3750 | will contain an identifier node for the library function. Thus, if |
3751 | you need to distinguish among various library functions, you can do so | |
3752 | by their names. Note that ``library function'' in this context means | |
3753 | a function used to perform arithmetic, whose name is known specially | |
3754 | in the compiler and was not mentioned in the C code being compiled. | |
3755 | ||
3756 | @var{stack-size} is the number of bytes of arguments passed on the | |
3757 | stack. If a variable number of bytes is passed, it is zero, and | |
3758 | argument popping will always be the responsibility of the calling function. | |
3759 | ||
8aeea6e6 | 3760 | On the VAX, all functions always pop their arguments, so the definition |
feca2ed3 JW |
3761 | of this macro is @var{stack-size}. On the 68000, using the standard |
3762 | calling convention, no functions pop their arguments, so the value of | |
3763 | the macro is always 0 in this case. But an alternative calling | |
3764 | convention is available in which functions that take a fixed number of | |
3765 | arguments pop them but other functions (such as @code{printf}) pop | |
3766 | nothing (the caller pops all). When this convention is in use, | |
3767 | @var{funtype} is examined to determine whether a function takes a fixed | |
3768 | number of arguments. | |
a2c4f8e0 | 3769 | @end defmac |
fa5322fa | 3770 | |
a2c4f8e0 | 3771 | @defmac CALL_POPS_ARGS (@var{cum}) |
fa5322fa AO |
3772 | A C expression that should indicate the number of bytes a call sequence |
3773 | pops off the stack. It is added to the value of @code{RETURN_POPS_ARGS} | |
3774 | when compiling a function call. | |
3775 | ||
3776 | @var{cum} is the variable in which all arguments to the called function | |
3777 | have been accumulated. | |
3778 | ||
3779 | On certain architectures, such as the SH5, a call trampoline is used | |
3780 | that pops certain registers off the stack, depending on the arguments | |
3781 | that have been passed to the function. Since this is a property of the | |
3782 | call site, not of the called function, @code{RETURN_POPS_ARGS} is not | |
3783 | appropriate. | |
a2c4f8e0 | 3784 | @end defmac |
feca2ed3 JW |
3785 | |
3786 | @node Register Arguments | |
3787 | @subsection Passing Arguments in Registers | |
3788 | @cindex arguments in registers | |
3789 | @cindex registers arguments | |
3790 | ||
3791 | This section describes the macros which let you control how various | |
3792 | types of arguments are passed in registers or how they are arranged in | |
3793 | the stack. | |
3794 | ||
a2c4f8e0 | 3795 | @defmac FUNCTION_ARG (@var{cum}, @var{mode}, @var{type}, @var{named}) |
feca2ed3 JW |
3796 | A C expression that controls whether a function argument is passed |
3797 | in a register, and which register. | |
3798 | ||
3799 | The arguments are @var{cum}, which summarizes all the previous | |
3800 | arguments; @var{mode}, the machine mode of the argument; @var{type}, | |
3801 | the data type of the argument as a tree node or 0 if that is not known | |
3802 | (which happens for C support library functions); and @var{named}, | |
3803 | which is 1 for an ordinary argument and 0 for nameless arguments that | |
3804 | correspond to @samp{@dots{}} in the called function's prototype. | |
3719d27b JO |
3805 | @var{type} can be an incomplete type if a syntax error has previously |
3806 | occurred. | |
feca2ed3 JW |
3807 | |
3808 | The value of the expression is usually either a @code{reg} RTX for the | |
3809 | hard register in which to pass the argument, or zero to pass the | |
3810 | argument on the stack. | |
3811 | ||
8aeea6e6 | 3812 | For machines like the VAX and 68000, where normally all arguments are |
feca2ed3 JW |
3813 | pushed, zero suffices as a definition. |
3814 | ||
161d7b59 | 3815 | The value of the expression can also be a @code{parallel} RTX@. This is |
feca2ed3 | 3816 | used when an argument is passed in multiple locations. The mode of the |
ce376beb | 3817 | @code{parallel} should be the mode of the entire argument. The |
feca2ed3 | 3818 | @code{parallel} holds any number of @code{expr_list} pairs; each one |
f797c10b NC |
3819 | describes where part of the argument is passed. In each |
3820 | @code{expr_list} the first operand must be a @code{reg} RTX for the hard | |
3821 | register in which to pass this part of the argument, and the mode of the | |
3822 | register RTX indicates how large this part of the argument is. The | |
3823 | second operand of the @code{expr_list} is a @code{const_int} which gives | |
3824 | the offset in bytes into the entire argument of where this part starts. | |
02f52e19 | 3825 | As a special exception the first @code{expr_list} in the @code{parallel} |
c980b85b NC |
3826 | RTX may have a first operand of zero. This indicates that the entire |
3827 | argument is also stored on the stack. | |
feca2ed3 | 3828 | |
1cc5e432 GK |
3829 | The last time this macro is called, it is called with @code{MODE == |
3830 | VOIDmode}, and its result is passed to the @code{call} or @code{call_value} | |
3831 | pattern as operands 2 and 3 respectively. | |
3832 | ||
feca2ed3 | 3833 | @cindex @file{stdarg.h} and register arguments |
5490d604 | 3834 | The usual way to make the ISO library @file{stdarg.h} work on a machine |
feca2ed3 JW |
3835 | where some arguments are usually passed in registers, is to cause |
3836 | nameless arguments to be passed on the stack instead. This is done | |
3837 | by making @code{FUNCTION_ARG} return 0 whenever @var{named} is 0. | |
3838 | ||
fe984136 | 3839 | @cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{FUNCTION_ARG} |
feca2ed3 | 3840 | @cindex @code{REG_PARM_STACK_SPACE}, and @code{FUNCTION_ARG} |
fe984136 | 3841 | You may use the hook @code{targetm.calls.must_pass_in_stack} |
feca2ed3 JW |
3842 | in the definition of this macro to determine if this argument is of a |
3843 | type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE} | |
df2a54e9 | 3844 | is not defined and @code{FUNCTION_ARG} returns nonzero for such an |
feca2ed3 JW |
3845 | argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is |
3846 | defined, the argument will be computed in the stack and then loaded into | |
3847 | a register. | |
a2c4f8e0 | 3848 | @end defmac |
feca2ed3 | 3849 | |
fe984136 RH |
3850 | @deftypefn {Target Hook} bool TARGET_MUST_PASS_IN_STACK (enum machine_mode @var{mode}, tree @var{type}) |
3851 | This target hook should return @code{true} if we should not pass @var{type} | |
3852 | solely in registers. The file @file{expr.h} defines a | |
d9a4ee00 JL |
3853 | definition that is usually appropriate, refer to @file{expr.h} for additional |
3854 | documentation. | |
fe984136 | 3855 | @end deftypefn |
d9a4ee00 | 3856 | |
a2c4f8e0 | 3857 | @defmac FUNCTION_INCOMING_ARG (@var{cum}, @var{mode}, @var{type}, @var{named}) |
feca2ed3 JW |
3858 | Define this macro if the target machine has ``register windows'', so |
3859 | that the register in which a function sees an arguments is not | |
3860 | necessarily the same as the one in which the caller passed the | |
3861 | argument. | |
3862 | ||
3863 | For such machines, @code{FUNCTION_ARG} computes the register in which | |
3864 | the caller passes the value, and @code{FUNCTION_INCOMING_ARG} should | |
3865 | be defined in a similar fashion to tell the function being called | |
3866 | where the arguments will arrive. | |
3867 | ||
3868 | If @code{FUNCTION_INCOMING_ARG} is not defined, @code{FUNCTION_ARG} | |
bd819a4a | 3869 | serves both purposes. |
a2c4f8e0 | 3870 | @end defmac |
feca2ed3 | 3871 | |
78a52f11 RH |
3872 | @deftypefn {Target Hook} int TARGET_ARG_PARTIAL_BYTES (CUMULATIVE_ARGS *@var{cum}, enum machine_mode @var{mode}, tree @var{type}, bool @var{named}) |
3873 | This target hook returns the number of bytes at the beginning of an | |
3874 | argument that must be put in registers. The value must be zero for | |
feca2ed3 JW |
3875 | arguments that are passed entirely in registers or that are entirely |
3876 | pushed on the stack. | |
3877 | ||
3878 | On some machines, certain arguments must be passed partially in | |
3879 | registers and partially in memory. On these machines, typically the | |
78a52f11 | 3880 | first few words of arguments are passed in registers, and the rest |
feca2ed3 JW |
3881 | on the stack. If a multi-word argument (a @code{double} or a |
3882 | structure) crosses that boundary, its first few words must be passed | |
3883 | in registers and the rest must be pushed. This macro tells the | |
78a52f11 | 3884 | compiler when this occurs, and how many bytes should go in registers. |
feca2ed3 JW |
3885 | |
3886 | @code{FUNCTION_ARG} for these arguments should return the first | |
3887 | register to be used by the caller for this argument; likewise | |
3888 | @code{FUNCTION_INCOMING_ARG}, for the called function. | |
78a52f11 | 3889 | @end deftypefn |
feca2ed3 | 3890 | |
8cd5a4e0 | 3891 | @deftypefn {Target Hook} bool TARGET_PASS_BY_REFERENCE (CUMULATIVE_ARGS *@var{cum}, enum machine_mode @var{mode}, tree @var{type}, bool @var{named}) |
f676971a | 3892 | This target hook should return @code{true} if an argument at the |
8cd5a4e0 | 3893 | position indicated by @var{cum} should be passed by reference. This |
f676971a | 3894 | predicate is queried after target independent reasons for being |
8cd5a4e0 RH |
3895 | passed by reference, such as @code{TREE_ADDRESSABLE (type)}. |
3896 | ||
3897 | If the hook returns true, a copy of that argument is made in memory and a | |
feca2ed3 JW |
3898 | pointer to the argument is passed instead of the argument itself. |
3899 | The pointer is passed in whatever way is appropriate for passing a pointer | |
3900 | to that type. | |
8cd5a4e0 | 3901 | @end deftypefn |
feca2ed3 | 3902 | |
6cdd5672 RH |
3903 | @deftypefn {Target Hook} bool TARGET_CALLEE_COPIES (CUMULATIVE_ARGS *@var{cum}, enum machine_mode @var{mode}, tree @var{type}, bool @var{named}) |
3904 | The function argument described by the parameters to this hook is | |
3905 | known to be passed by reference. The hook should return true if the | |
3906 | function argument should be copied by the callee instead of copied | |
3907 | by the caller. | |
3908 | ||
a1c496cb | 3909 | For any argument for which the hook returns true, if it can be |
6cdd5672 RH |
3910 | determined that the argument is not modified, then a copy need |
3911 | not be generated. | |
3912 | ||
3913 | The default version of this hook always returns false. | |
3914 | @end deftypefn | |
feca2ed3 | 3915 | |
a2c4f8e0 | 3916 | @defmac CUMULATIVE_ARGS |
feca2ed3 JW |
3917 | A C type for declaring a variable that is used as the first argument of |
3918 | @code{FUNCTION_ARG} and other related values. For some target machines, | |
3919 | the type @code{int} suffices and can hold the number of bytes of | |
3920 | argument so far. | |
3921 | ||
3922 | There is no need to record in @code{CUMULATIVE_ARGS} anything about the | |
3923 | arguments that have been passed on the stack. The compiler has other | |
3924 | variables to keep track of that. For target machines on which all | |
3925 | arguments are passed on the stack, there is no need to store anything in | |
3926 | @code{CUMULATIVE_ARGS}; however, the data structure must exist and | |
3927 | should not be empty, so use @code{int}. | |
a2c4f8e0 | 3928 | @end defmac |
feca2ed3 | 3929 | |
0f6937fe | 3930 | @defmac INIT_CUMULATIVE_ARGS (@var{cum}, @var{fntype}, @var{libname}, @var{fndecl}, @var{n_named_args}) |
a2c4f8e0 ZW |
3931 | A C statement (sans semicolon) for initializing the variable |
3932 | @var{cum} for the state at the beginning of the argument list. The | |
3933 | variable has type @code{CUMULATIVE_ARGS}. The value of @var{fntype} | |
3934 | is the tree node for the data type of the function which will receive | |
3935 | the args, or 0 if the args are to a compiler support library function. | |
3936 | For direct calls that are not libcalls, @var{fndecl} contain the | |
3937 | declaration node of the function. @var{fndecl} is also set when | |
3938 | @code{INIT_CUMULATIVE_ARGS} is used to find arguments for the function | |
0f6937fe AM |
3939 | being compiled. @var{n_named_args} is set to the number of named |
3940 | arguments, including a structure return address if it is passed as a | |
3941 | parameter, when making a call. When processing incoming arguments, | |
78466c0e | 3942 | @var{n_named_args} is set to @minus{}1. |
feca2ed3 JW |
3943 | |
3944 | When processing a call to a compiler support library function, | |
3945 | @var{libname} identifies which one. It is a @code{symbol_ref} rtx which | |
3946 | contains the name of the function, as a string. @var{libname} is 0 when | |
3947 | an ordinary C function call is being processed. Thus, each time this | |
3948 | macro is called, either @var{libname} or @var{fntype} is nonzero, but | |
3949 | never both of them at once. | |
a2c4f8e0 | 3950 | @end defmac |
feca2ed3 | 3951 | |
a2c4f8e0 | 3952 | @defmac INIT_CUMULATIVE_LIBCALL_ARGS (@var{cum}, @var{mode}, @var{libname}) |
97fc4caf AO |
3953 | Like @code{INIT_CUMULATIVE_ARGS} but only used for outgoing libcalls, |
3954 | it gets a @code{MODE} argument instead of @var{fntype}, that would be | |
3955 | @code{NULL}. @var{indirect} would always be zero, too. If this macro | |
3956 | is not defined, @code{INIT_CUMULATIVE_ARGS (cum, NULL_RTX, libname, | |
3957 | 0)} is used instead. | |
a2c4f8e0 | 3958 | @end defmac |
97fc4caf | 3959 | |
a2c4f8e0 | 3960 | @defmac INIT_CUMULATIVE_INCOMING_ARGS (@var{cum}, @var{fntype}, @var{libname}) |
feca2ed3 JW |
3961 | Like @code{INIT_CUMULATIVE_ARGS} but overrides it for the purposes of |
3962 | finding the arguments for the function being compiled. If this macro is | |
3963 | undefined, @code{INIT_CUMULATIVE_ARGS} is used instead. | |
3964 | ||
3965 | The value passed for @var{libname} is always 0, since library routines | |
161d7b59 | 3966 | with special calling conventions are never compiled with GCC@. The |
feca2ed3 JW |
3967 | argument @var{libname} exists for symmetry with |
3968 | @code{INIT_CUMULATIVE_ARGS}. | |
3969 | @c could use "this macro" in place of @code{INIT_CUMULATIVE_ARGS}, maybe. | |
3970 | @c --mew 5feb93 i switched the order of the sentences. --mew 10feb93 | |
a2c4f8e0 | 3971 | @end defmac |
feca2ed3 | 3972 | |
a2c4f8e0 | 3973 | @defmac FUNCTION_ARG_ADVANCE (@var{cum}, @var{mode}, @var{type}, @var{named}) |
feca2ed3 JW |
3974 | A C statement (sans semicolon) to update the summarizer variable |
3975 | @var{cum} to advance past an argument in the argument list. The | |
3976 | values @var{mode}, @var{type} and @var{named} describe that argument. | |
3977 | Once this is done, the variable @var{cum} is suitable for analyzing | |
bd819a4a | 3978 | the @emph{following} argument with @code{FUNCTION_ARG}, etc. |
feca2ed3 JW |
3979 | |
3980 | This macro need not do anything if the argument in question was passed | |
3981 | on the stack. The compiler knows how to track the amount of stack space | |
3982 | used for arguments without any special help. | |
a2c4f8e0 | 3983 | @end defmac |
feca2ed3 | 3984 | |
a2c4f8e0 | 3985 | @defmac FUNCTION_ARG_PADDING (@var{mode}, @var{type}) |
feca2ed3 JW |
3986 | If defined, a C expression which determines whether, and in which direction, |
3987 | to pad out an argument with extra space. The value should be of type | |
3988 | @code{enum direction}: either @code{upward} to pad above the argument, | |
3989 | @code{downward} to pad below, or @code{none} to inhibit padding. | |
3990 | ||
3991 | The @emph{amount} of padding is always just enough to reach the next | |
3992 | multiple of @code{FUNCTION_ARG_BOUNDARY}; this macro does not control | |
3993 | it. | |
3994 | ||
3995 | This macro has a default definition which is right for most systems. | |
3996 | For little-endian machines, the default is to pad upward. For | |
3997 | big-endian machines, the default is to pad downward for an argument of | |
3998 | constant size shorter than an @code{int}, and upward otherwise. | |
a2c4f8e0 | 3999 | @end defmac |
feca2ed3 | 4000 | |
a2c4f8e0 | 4001 | @defmac PAD_VARARGS_DOWN |
02f52e19 AJ |
4002 | If defined, a C expression which determines whether the default |
4003 | implementation of va_arg will attempt to pad down before reading the | |
5e4f6244 CP |
4004 | next argument, if that argument is smaller than its aligned space as |
4005 | controlled by @code{PARM_BOUNDARY}. If this macro is not defined, all such | |
4006 | arguments are padded down if @code{BYTES_BIG_ENDIAN} is true. | |
a2c4f8e0 | 4007 | @end defmac |
5e4f6244 | 4008 | |
6e985040 AM |
4009 | @defmac BLOCK_REG_PADDING (@var{mode}, @var{type}, @var{first}) |
4010 | Specify padding for the last element of a block move between registers and | |
4011 | memory. @var{first} is nonzero if this is the only element. Defining this | |
4012 | macro allows better control of register function parameters on big-endian | |
4013 | machines, without using @code{PARALLEL} rtl. In particular, | |
4014 | @code{MUST_PASS_IN_STACK} need not test padding and mode of types in | |
4015 | registers, as there is no longer a "wrong" part of a register; For example, | |
4016 | a three byte aggregate may be passed in the high part of a register if so | |
4017 | required. | |
4018 | @end defmac | |
4019 | ||
a2c4f8e0 | 4020 | @defmac FUNCTION_ARG_BOUNDARY (@var{mode}, @var{type}) |
feca2ed3 JW |
4021 | If defined, a C expression that gives the alignment boundary, in bits, |
4022 | of an argument with the specified mode and type. If it is not defined, | |
4023 | @code{PARM_BOUNDARY} is used for all arguments. | |
a2c4f8e0 | 4024 | @end defmac |
feca2ed3 | 4025 | |
a2c4f8e0 | 4026 | @defmac FUNCTION_ARG_REGNO_P (@var{regno}) |
feca2ed3 JW |
4027 | A C expression that is nonzero if @var{regno} is the number of a hard |
4028 | register in which function arguments are sometimes passed. This does | |
4029 | @emph{not} include implicit arguments such as the static chain and | |
4030 | the structure-value address. On many machines, no registers can be | |
4031 | used for this purpose since all function arguments are pushed on the | |
4032 | stack. | |
a2c4f8e0 | 4033 | @end defmac |
bb1b857a | 4034 | |
42ba5130 RH |
4035 | @deftypefn {Target Hook} bool TARGET_SPLIT_COMPLEX_ARG (tree @var{type}) |
4036 | This hook should return true if parameter of type @var{type} are passed | |
4037 | as two scalar parameters. By default, GCC will attempt to pack complex | |
4038 | arguments into the target's word size. Some ABIs require complex arguments | |
4039 | to be split and treated as their individual components. For example, on | |
4040 | AIX64, complex floats should be passed in a pair of floating point | |
4041 | registers, even though a complex float would fit in one 64-bit floating | |
4042 | point register. | |
4043 | ||
4044 | The default value of this hook is @code{NULL}, which is treated as always | |
4045 | false. | |
4046 | @end deftypefn | |
ded9bf77 | 4047 | |
d3da4d14 RH |
4048 | @deftypefn {Target Hook} tree TARGET_BUILD_BUILTIN_VA_LIST (void) |
4049 | This hook returns a type node for @code{va_list} for the target. | |
4050 | The default version of the hook returns @code{void*}. | |
4051 | @end deftypefn | |
4052 | ||
23a60a04 JM |
4053 | @deftypefn {Target Hook} tree TARGET_GIMPLIFY_VA_ARG_EXPR (tree @var{valist}, tree @var{type}, tree *@var{pre_p}, tree *@var{post_p}) |
4054 | This hook performs target-specific gimplification of | |
4055 | @code{VA_ARG_EXPR}. The first two parameters correspond to the | |
4056 | arguments to @code{va_arg}; the latter two are as in | |
4057 | @code{gimplify.c:gimplify_expr}. | |
23a60a04 JM |
4058 | @end deftypefn |
4059 | ||
e09ec166 EC |
4060 | @deftypefn {Target Hook} bool TARGET_VALID_POINTER_MODE (enum machine_mode @var{mode}) |
4061 | Define this to return nonzero if the port can handle pointers | |
4062 | with machine mode @var{mode}. The default version of this | |
4063 | hook returns true for both @code{ptr_mode} and @code{Pmode}. | |
4064 | @end deftypefn | |
4065 | ||
6dd53648 RH |
4066 | @deftypefn {Target Hook} bool TARGET_SCALAR_MODE_SUPPORTED_P (enum machine_mode @var{mode}) |
4067 | Define this to return nonzero if the port is prepared to handle | |
4068 | insns involving scalar mode @var{mode}. For a scalar mode to be | |
4069 | considered supported, all the basic arithmetic and comparisons | |
4070 | must work. | |
4071 | ||
4072 | The default version of this hook returns true for any mode | |
4073 | required to handle the basic C types (as defined by the port). | |
4074 | Included here are the double-word arithmetic supported by the | |
4075 | code in @file{optabs.c}. | |
4076 | @end deftypefn | |
4077 | ||
f676971a EC |
4078 | @deftypefn {Target Hook} bool TARGET_VECTOR_MODE_SUPPORTED_P (enum machine_mode @var{mode}) |
4079 | Define this to return nonzero if the port is prepared to handle | |
4080 | insns involving vector mode @var{mode}. At the very least, it | |
4081 | must have move patterns for this mode. | |
4082 | @end deftypefn | |
4083 | ||
feca2ed3 JW |
4084 | @node Scalar Return |
4085 | @subsection How Scalar Function Values Are Returned | |
4086 | @cindex return values in registers | |
4087 | @cindex values, returned by functions | |
4088 | @cindex scalars, returned as values | |
4089 | ||
4090 | This section discusses the macros that control returning scalars as | |
4091 | values---values that can fit in registers. | |
4092 | ||
0b35aac2 | 4093 | @deftypefn {Target Hook} rtx TARGET_FUNCTION_VALUE (tree @var{ret_type}, tree @var{fn_decl_or_type}, bool @var{outgoing}) |
1b03c58a RG |
4094 | |
4095 | Define this to return an RTX representing the place where a function | |
4096 | returns or receives a value of data type @var{ret_type}, a tree node | |
4097 | node representing a data type. @var{fn_decl_or_type} is a tree node | |
4098 | representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a | |
4099 | function being called. If @var{outgoing} is false, the hook should | |
4100 | compute the register in which the caller will see the return value. | |
4101 | Otherwise, the hook should return an RTX representing the place where | |
4102 | a function returns a value. | |
4103 | ||
4104 | On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant. | |
4105 | (Actually, on most machines, scalar values are returned in the same | |
4106 | place regardless of mode.) The value of the expression is usually a | |
4107 | @code{reg} RTX for the hard register where the return value is stored. | |
4108 | The value can also be a @code{parallel} RTX, if the return value is in | |
4109 | multiple places. See @code{FUNCTION_ARG} for an explanation of the | |
576c9028 KH |
4110 | @code{parallel} form. Note that the callee will populate every |
4111 | location specified in the @code{parallel}, but if the first element of | |
4112 | the @code{parallel} contains the whole return value, callers will use | |
4113 | that element as the canonical location and ignore the others. The m68k | |
4114 | port uses this type of @code{parallel} to return pointers in both | |
4115 | @samp{%a0} (the canonical location) and @samp{%d0}. | |
1b03c58a RG |
4116 | |
4117 | If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply | |
4118 | the same promotion rules specified in @code{PROMOTE_MODE} if | |
4119 | @var{valtype} is a scalar type. | |
feca2ed3 JW |
4120 | |
4121 | If the precise function being called is known, @var{func} is a tree | |
4122 | node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null | |
4123 | pointer. This makes it possible to use a different value-returning | |
4124 | convention for specific functions when all their calls are | |
bd819a4a | 4125 | known. |
feca2ed3 | 4126 | |
1b03c58a RG |
4127 | Some target machines have ``register windows'' so that the register in |
4128 | which a function returns its value is not the same as the one in which | |
4129 | the caller sees the value. For such machines, you should return | |
4130 | different RTX depending on @var{outgoing}. | |
4131 | ||
4132 | @code{TARGET_FUNCTION_VALUE} is not used for return values with | |
4133 | aggregate data types, because these are returned in another way. See | |
cea28603 | 4134 | @code{TARGET_STRUCT_VALUE_RTX} and related macros, below. |
1b03c58a RG |
4135 | @end deftypefn |
4136 | ||
4137 | @defmac FUNCTION_VALUE (@var{valtype}, @var{func}) | |
4138 | This macro has been deprecated. Use @code{TARGET_FUNCTION_VALUE} for | |
4139 | a new target instead. | |
a2c4f8e0 | 4140 | @end defmac |
feca2ed3 | 4141 | |
a2c4f8e0 | 4142 | @defmac FUNCTION_OUTGOING_VALUE (@var{valtype}, @var{func}) |
1b03c58a RG |
4143 | This macro has been deprecated. Use @code{TARGET_FUNCTION_VALUE} for |
4144 | a new target instead. | |
a2c4f8e0 | 4145 | @end defmac |
feca2ed3 | 4146 | |
a2c4f8e0 | 4147 | @defmac LIBCALL_VALUE (@var{mode}) |
feca2ed3 JW |
4148 | A C expression to create an RTX representing the place where a library |
4149 | function returns a value of mode @var{mode}. If the precise function | |
4150 | being called is known, @var{func} is a tree node | |
4151 | (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null | |
4152 | pointer. This makes it possible to use a different value-returning | |
4153 | convention for specific functions when all their calls are | |
bd819a4a | 4154 | known. |
feca2ed3 JW |
4155 | |
4156 | Note that ``library function'' in this context means a compiler | |
4157 | support routine, used to perform arithmetic, whose name is known | |
4158 | specially by the compiler and was not mentioned in the C code being | |
4159 | compiled. | |
4160 | ||
4161 | The definition of @code{LIBRARY_VALUE} need not be concerned aggregate | |
4162 | data types, because none of the library functions returns such types. | |
a2c4f8e0 | 4163 | @end defmac |
feca2ed3 | 4164 | |
a2c4f8e0 | 4165 | @defmac FUNCTION_VALUE_REGNO_P (@var{regno}) |
feca2ed3 JW |
4166 | A C expression that is nonzero if @var{regno} is the number of a hard |
4167 | register in which the values of called function may come back. | |
4168 | ||
4169 | A register whose use for returning values is limited to serving as the | |
4170 | second of a pair (for a value of type @code{double}, say) need not be | |
4171 | recognized by this macro. So for most machines, this definition | |
4172 | suffices: | |
4173 | ||
3ab51846 | 4174 | @smallexample |
feca2ed3 | 4175 | #define FUNCTION_VALUE_REGNO_P(N) ((N) == 0) |
3ab51846 | 4176 | @end smallexample |
feca2ed3 JW |
4177 | |
4178 | If the machine has register windows, so that the caller and the called | |
4179 | function use different registers for the return value, this macro | |
4180 | should recognize only the caller's register numbers. | |
a2c4f8e0 | 4181 | @end defmac |
feca2ed3 | 4182 | |
a2c4f8e0 | 4183 | @defmac APPLY_RESULT_SIZE |
feca2ed3 JW |
4184 | Define this macro if @samp{untyped_call} and @samp{untyped_return} |
4185 | need more space than is implied by @code{FUNCTION_VALUE_REGNO_P} for | |
4186 | saving and restoring an arbitrary return value. | |
a2c4f8e0 | 4187 | @end defmac |
feca2ed3 | 4188 | |
c988af2b RS |
4189 | @deftypefn {Target Hook} bool TARGET_RETURN_IN_MSB (tree @var{type}) |
4190 | This hook should return true if values of type @var{type} are returned | |
4191 | at the most significant end of a register (in other words, if they are | |
4192 | padded at the least significant end). You can assume that @var{type} | |
4193 | is returned in a register; the caller is required to check this. | |
4194 | ||
1b03c58a RG |
4195 | Note that the register provided by @code{TARGET_FUNCTION_VALUE} must |
4196 | be able to hold the complete return value. For example, if a 1-, 2- | |
4197 | or 3-byte structure is returned at the most significant end of a | |
4198 | 4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an | |
4199 | @code{SImode} rtx. | |
c988af2b RS |
4200 | @end deftypefn |
4201 | ||
feca2ed3 JW |
4202 | @node Aggregate Return |
4203 | @subsection How Large Values Are Returned | |
4204 | @cindex aggregates as return values | |
4205 | @cindex large return values | |
4206 | @cindex returning aggregate values | |
4207 | @cindex structure value address | |
4208 | ||
4209 | When a function value's mode is @code{BLKmode} (and in some other | |
1b03c58a RG |
4210 | cases), the value is not returned according to |
4211 | @code{TARGET_FUNCTION_VALUE} (@pxref{Scalar Return}). Instead, the | |
4212 | caller passes the address of a block of memory in which the value | |
4213 | should be stored. This address is called the @dfn{structure value | |
4214 | address}. | |
feca2ed3 JW |
4215 | |
4216 | This section describes how to control returning structure values in | |
4217 | memory. | |
4218 | ||
d624465f | 4219 | @deftypefn {Target Hook} bool TARGET_RETURN_IN_MEMORY (tree @var{type}, tree @var{fntype}) |
61f71b34 DD |
4220 | This target hook should return a nonzero value to say to return the |
4221 | function value in memory, just as large structures are always returned. | |
4222 | Here @var{type} will be the data type of the value, and @var{fntype} | |
4223 | will be the type of the function doing the returning, or @code{NULL} for | |
4224 | libcalls. | |
feca2ed3 JW |
4225 | |
4226 | Note that values of mode @code{BLKmode} must be explicitly handled | |
61f71b34 | 4227 | by this function. Also, the option @option{-fpcc-struct-return} |
feca2ed3 | 4228 | takes effect regardless of this macro. On most systems, it is |
61f71b34 | 4229 | possible to leave the hook undefined; this causes a default |
feca2ed3 JW |
4230 | definition to be used, whose value is the constant 1 for @code{BLKmode} |
4231 | values, and 0 otherwise. | |
4232 | ||
61f71b34 | 4233 | Do not use this hook to indicate that structures and unions should always |
feca2ed3 JW |
4234 | be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN} |
4235 | to indicate this. | |
61f71b34 | 4236 | @end deftypefn |
feca2ed3 | 4237 | |
a2c4f8e0 | 4238 | @defmac DEFAULT_PCC_STRUCT_RETURN |
feca2ed3 JW |
4239 | Define this macro to be 1 if all structure and union return values must be |
4240 | in memory. Since this results in slower code, this should be defined | |
161d7b59 | 4241 | only if needed for compatibility with other compilers or with an ABI@. |
feca2ed3 | 4242 | If you define this macro to be 0, then the conventions used for structure |
d624465f KH |
4243 | and union return values are decided by the @code{TARGET_RETURN_IN_MEMORY} |
4244 | target hook. | |
feca2ed3 JW |
4245 | |
4246 | If not defined, this defaults to the value 1. | |
a2c4f8e0 | 4247 | @end defmac |
feca2ed3 | 4248 | |
61f71b34 DD |
4249 | @deftypefn {Target Hook} rtx TARGET_STRUCT_VALUE_RTX (tree @var{fndecl}, int @var{incoming}) |
4250 | This target hook should return the location of the structure value | |
4251 | address (normally a @code{mem} or @code{reg}), or 0 if the address is | |
4252 | passed as an ``invisible'' first argument. Note that @var{fndecl} may | |
1f6acb82 KH |
4253 | be @code{NULL}, for libcalls. You do not need to define this target |
4254 | hook if the address is always passed as an ``invisible'' first | |
4255 | argument. | |
feca2ed3 | 4256 | |
feca2ed3 JW |
4257 | On some architectures the place where the structure value address |
4258 | is found by the called function is not the same place that the | |
4259 | caller put it. This can be due to register windows, or it could | |
4260 | be because the function prologue moves it to a different place. | |
2225b57c CD |
4261 | @var{incoming} is @code{1} or @code{2} when the location is needed in |
4262 | the context of the called function, and @code{0} in the context of | |
61f71b34 | 4263 | the caller. |
feca2ed3 | 4264 | |
917f1b7e | 4265 | If @var{incoming} is nonzero and the address is to be found on the |
2225b57c CD |
4266 | stack, return a @code{mem} which refers to the frame pointer. If |
4267 | @var{incoming} is @code{2}, the result is being used to fetch the | |
64ee9490 | 4268 | structure value address at the beginning of a function. If you need |
2225b57c | 4269 | to emit adjusting code, you should do it at this point. |
61f71b34 | 4270 | @end deftypefn |
feca2ed3 | 4271 | |
a2c4f8e0 | 4272 | @defmac PCC_STATIC_STRUCT_RETURN |
feca2ed3 JW |
4273 | Define this macro if the usual system convention on the target machine |
4274 | for returning structures and unions is for the called function to return | |
4275 | the address of a static variable containing the value. | |
4276 | ||
4277 | Do not define this if the usual system convention is for the caller to | |
4278 | pass an address to the subroutine. | |
4279 | ||
630d3d5a JM |
4280 | This macro has effect in @option{-fpcc-struct-return} mode, but it does |
4281 | nothing when you use @option{-freg-struct-return} mode. | |
a2c4f8e0 | 4282 | @end defmac |
feca2ed3 JW |
4283 | |
4284 | @node Caller Saves | |
4285 | @subsection Caller-Saves Register Allocation | |
4286 | ||
a3a15b4d | 4287 | If you enable it, GCC can save registers around function calls. This |
feca2ed3 JW |
4288 | makes it possible to use call-clobbered registers to hold variables that |
4289 | must live across calls. | |
4290 | ||
a2c4f8e0 | 4291 | @defmac CALLER_SAVE_PROFITABLE (@var{refs}, @var{calls}) |
feca2ed3 JW |
4292 | A C expression to determine whether it is worthwhile to consider placing |
4293 | a pseudo-register in a call-clobbered hard register and saving and | |
4294 | restoring it around each function call. The expression should be 1 when | |
4295 | this is worth doing, and 0 otherwise. | |
4296 | ||
4297 | If you don't define this macro, a default is used which is good on most | |
4298 | machines: @code{4 * @var{calls} < @var{refs}}. | |
a2c4f8e0 | 4299 | @end defmac |
8d5c8167 | 4300 | |
a2c4f8e0 | 4301 | @defmac HARD_REGNO_CALLER_SAVE_MODE (@var{regno}, @var{nregs}) |
8d5c8167 JL |
4302 | A C expression specifying which mode is required for saving @var{nregs} |
4303 | of a pseudo-register in call-clobbered hard register @var{regno}. If | |
4304 | @var{regno} is unsuitable for caller save, @code{VOIDmode} should be | |
4305 | returned. For most machines this macro need not be defined since GCC | |
4306 | will select the smallest suitable mode. | |
a2c4f8e0 | 4307 | @end defmac |
feca2ed3 JW |
4308 | |
4309 | @node Function Entry | |
4310 | @subsection Function Entry and Exit | |
4311 | @cindex function entry and exit | |
4312 | @cindex prologue | |
4313 | @cindex epilogue | |
4314 | ||
4315 | This section describes the macros that output function entry | |
4316 | (@dfn{prologue}) and exit (@dfn{epilogue}) code. | |
4317 | ||
08c148a8 NB |
4318 | @deftypefn {Target Hook} void TARGET_ASM_FUNCTION_PROLOGUE (FILE *@var{file}, HOST_WIDE_INT @var{size}) |
4319 | If defined, a function that outputs the assembler code for entry to a | |
feca2ed3 JW |
4320 | function. The prologue is responsible for setting up the stack frame, |
4321 | initializing the frame pointer register, saving registers that must be | |
4322 | saved, and allocating @var{size} additional bytes of storage for the | |
4323 | local variables. @var{size} is an integer. @var{file} is a stdio | |
4324 | stream to which the assembler code should be output. | |
4325 | ||
4326 | The label for the beginning of the function need not be output by this | |
4327 | macro. That has already been done when the macro is run. | |
4328 | ||
4329 | @findex regs_ever_live | |
4330 | To determine which registers to save, the macro can refer to the array | |
4331 | @code{regs_ever_live}: element @var{r} is nonzero if hard register | |
4332 | @var{r} is used anywhere within the function. This implies the function | |
4333 | prologue should save register @var{r}, provided it is not one of the | |
08c148a8 | 4334 | call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use |
feca2ed3 JW |
4335 | @code{regs_ever_live}.) |
4336 | ||
4337 | On machines that have ``register windows'', the function entry code does | |
4338 | not save on the stack the registers that are in the windows, even if | |
4339 | they are supposed to be preserved by function calls; instead it takes | |
4340 | appropriate steps to ``push'' the register stack, if any non-call-used | |
4341 | registers are used in the function. | |
4342 | ||
4343 | @findex frame_pointer_needed | |
4344 | On machines where functions may or may not have frame-pointers, the | |
4345 | function entry code must vary accordingly; it must set up the frame | |
4346 | pointer if one is wanted, and not otherwise. To determine whether a | |
4347 | frame pointer is in wanted, the macro can refer to the variable | |
4348 | @code{frame_pointer_needed}. The variable's value will be 1 at run | |
4349 | time in a function that needs a frame pointer. @xref{Elimination}. | |
4350 | ||
4351 | The function entry code is responsible for allocating any stack space | |
4352 | required for the function. This stack space consists of the regions | |
4353 | listed below. In most cases, these regions are allocated in the | |
4354 | order listed, with the last listed region closest to the top of the | |
4355 | stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and | |
4356 | the highest address if it is not defined). You can use a different order | |
4357 | for a machine if doing so is more convenient or required for | |
4358 | compatibility reasons. Except in cases where required by standard | |
4359 | or by a debugger, there is no reason why the stack layout used by GCC | |
4360 | need agree with that used by other compilers for a machine. | |
08c148a8 NB |
4361 | @end deftypefn |
4362 | ||
17b53c33 NB |
4363 | @deftypefn {Target Hook} void TARGET_ASM_FUNCTION_END_PROLOGUE (FILE *@var{file}) |
4364 | If defined, a function that outputs assembler code at the end of a | |
4365 | prologue. This should be used when the function prologue is being | |
4366 | emitted as RTL, and you have some extra assembler that needs to be | |
4367 | emitted. @xref{prologue instruction pattern}. | |
4368 | @end deftypefn | |
4369 | ||
4370 | @deftypefn {Target Hook} void TARGET_ASM_FUNCTION_BEGIN_EPILOGUE (FILE *@var{file}) | |
4371 | If defined, a function that outputs assembler code at the start of an | |
4372 | epilogue. This should be used when the function epilogue is being | |
4373 | emitted as RTL, and you have some extra assembler that needs to be | |
4374 | emitted. @xref{epilogue instruction pattern}. | |
4375 | @end deftypefn | |
4376 | ||
08c148a8 NB |
4377 | @deftypefn {Target Hook} void TARGET_ASM_FUNCTION_EPILOGUE (FILE *@var{file}, HOST_WIDE_INT @var{size}) |
4378 | If defined, a function that outputs the assembler code for exit from a | |
4379 | function. The epilogue is responsible for restoring the saved | |
4380 | registers and stack pointer to their values when the function was | |
4381 | called, and returning control to the caller. This macro takes the | |
4382 | same arguments as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the | |
4383 | registers to restore are determined from @code{regs_ever_live} and | |
4384 | @code{CALL_USED_REGISTERS} in the same way. | |
4385 | ||
4386 | On some machines, there is a single instruction that does all the work | |
4387 | of returning from the function. On these machines, give that | |
4388 | instruction the name @samp{return} and do not define the macro | |
4389 | @code{TARGET_ASM_FUNCTION_EPILOGUE} at all. | |
4390 | ||
4391 | Do not define a pattern named @samp{return} if you want the | |
4392 | @code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target | |
4393 | switches to control whether return instructions or epilogues are used, | |
4394 | define a @samp{return} pattern with a validity condition that tests the | |
4395 | target switches appropriately. If the @samp{return} pattern's validity | |
4396 | condition is false, epilogues will be used. | |
4397 | ||
4398 | On machines where functions may or may not have frame-pointers, the | |
4399 | function exit code must vary accordingly. Sometimes the code for these | |
4400 | two cases is completely different. To determine whether a frame pointer | |
4401 | is wanted, the macro can refer to the variable | |
4402 | @code{frame_pointer_needed}. The variable's value will be 1 when compiling | |
4403 | a function that needs a frame pointer. | |
4404 | ||
4405 | Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and | |
4406 | @code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially. | |
4407 | The C variable @code{current_function_is_leaf} is nonzero for such a | |
4408 | function. @xref{Leaf Functions}. | |
4409 | ||
4410 | On some machines, some functions pop their arguments on exit while | |
4411 | others leave that for the caller to do. For example, the 68020 when | |
4412 | given @option{-mrtd} pops arguments in functions that take a fixed | |
4413 | number of arguments. | |
4414 | ||
4415 | @findex current_function_pops_args | |
4416 | Your definition of the macro @code{RETURN_POPS_ARGS} decides which | |
4417 | functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE} | |
4418 | needs to know what was decided. The variable that is called | |
4419 | @code{current_function_pops_args} is the number of bytes of its | |
4420 | arguments that a function should pop. @xref{Scalar Return}. | |
4421 | @c what is the "its arguments" in the above sentence referring to, pray | |
4422 | @c tell? --mew 5feb93 | |
4423 | @end deftypefn | |
4424 | ||
feca2ed3 JW |
4425 | @itemize @bullet |
4426 | @item | |
4427 | @findex current_function_pretend_args_size | |
4428 | A region of @code{current_function_pretend_args_size} bytes of | |
4429 | uninitialized space just underneath the first argument arriving on the | |
4430 | stack. (This may not be at the very start of the allocated stack region | |
4431 | if the calling sequence has pushed anything else since pushing the stack | |
4432 | arguments. But usually, on such machines, nothing else has been pushed | |
4433 | yet, because the function prologue itself does all the pushing.) This | |
4434 | region is used on machines where an argument may be passed partly in | |
4435 | registers and partly in memory, and, in some cases to support the | |
6c535c69 | 4436 | features in @code{<stdarg.h>}. |
feca2ed3 JW |
4437 | |
4438 | @item | |
4439 | An area of memory used to save certain registers used by the function. | |
4440 | The size of this area, which may also include space for such things as | |
4441 | the return address and pointers to previous stack frames, is | |
4442 | machine-specific and usually depends on which registers have been used | |
4443 | in the function. Machines with register windows often do not require | |
4444 | a save area. | |
4445 | ||
4446 | @item | |
4447 | A region of at least @var{size} bytes, possibly rounded up to an allocation | |
4448 | boundary, to contain the local variables of the function. On some machines, | |
4449 | this region and the save area may occur in the opposite order, with the | |
4450 | save area closer to the top of the stack. | |
4451 | ||
4452 | @item | |
4453 | @cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames | |
4454 | Optionally, when @code{ACCUMULATE_OUTGOING_ARGS} is defined, a region of | |
4455 | @code{current_function_outgoing_args_size} bytes to be used for outgoing | |
4456 | argument lists of the function. @xref{Stack Arguments}. | |
4457 | @end itemize | |
4458 | ||
a2c4f8e0 | 4459 | @defmac EXIT_IGNORE_STACK |
feca2ed3 JW |
4460 | Define this macro as a C expression that is nonzero if the return |
4461 | instruction or the function epilogue ignores the value of the stack | |
4462 | pointer; in other words, if it is safe to delete an instruction to | |
9d05bbce KH |
4463 | adjust the stack pointer before a return from the function. The |
4464 | default is 0. | |
feca2ed3 JW |
4465 | |
4466 | Note that this macro's value is relevant only for functions for which | |
4467 | frame pointers are maintained. It is never safe to delete a final | |
4468 | stack adjustment in a function that has no frame pointer, and the | |
4469 | compiler knows this regardless of @code{EXIT_IGNORE_STACK}. | |
a2c4f8e0 | 4470 | @end defmac |
feca2ed3 | 4471 | |
a2c4f8e0 | 4472 | @defmac EPILOGUE_USES (@var{regno}) |
8760eaae | 4473 | Define this macro as a C expression that is nonzero for registers that are |
feca2ed3 | 4474 | used by the epilogue or the @samp{return} pattern. The stack and frame |
86c33cd0 | 4475 | pointer registers are already assumed to be used as needed. |
a2c4f8e0 | 4476 | @end defmac |
feca2ed3 | 4477 | |
a2c4f8e0 | 4478 | @defmac EH_USES (@var{regno}) |
15b5aef3 RH |
4479 | Define this macro as a C expression that is nonzero for registers that are |
4480 | used by the exception handling mechanism, and so should be considered live | |
4481 | on entry to an exception edge. | |
a2c4f8e0 | 4482 | @end defmac |
15b5aef3 | 4483 | |
a2c4f8e0 | 4484 | @defmac DELAY_SLOTS_FOR_EPILOGUE |
feca2ed3 JW |
4485 | Define this macro if the function epilogue contains delay slots to which |
4486 | instructions from the rest of the function can be ``moved''. The | |
4487 | definition should be a C expression whose value is an integer | |
4488 | representing the number of delay slots there. | |
a2c4f8e0 | 4489 | @end defmac |
feca2ed3 | 4490 | |
a2c4f8e0 | 4491 | @defmac ELIGIBLE_FOR_EPILOGUE_DELAY (@var{insn}, @var{n}) |
feca2ed3 JW |
4492 | A C expression that returns 1 if @var{insn} can be placed in delay |
4493 | slot number @var{n} of the epilogue. | |
4494 | ||
4495 | The argument @var{n} is an integer which identifies the delay slot now | |
4496 | being considered (since different slots may have different rules of | |
4497 | eligibility). It is never negative and is always less than the number | |
4498 | of epilogue delay slots (what @code{DELAY_SLOTS_FOR_EPILOGUE} returns). | |
4499 | If you reject a particular insn for a given delay slot, in principle, it | |
4500 | may be reconsidered for a subsequent delay slot. Also, other insns may | |
4501 | (at least in principle) be considered for the so far unfilled delay | |
4502 | slot. | |
4503 | ||
4504 | @findex current_function_epilogue_delay_list | |
4505 | @findex final_scan_insn | |
4506 | The insns accepted to fill the epilogue delay slots are put in an RTL | |
4507 | list made with @code{insn_list} objects, stored in the variable | |
4508 | @code{current_function_epilogue_delay_list}. The insn for the first | |
4509 | delay slot comes first in the list. Your definition of the macro | |
08c148a8 NB |
4510 | @code{TARGET_ASM_FUNCTION_EPILOGUE} should fill the delay slots by |
4511 | outputting the insns in this list, usually by calling | |
4512 | @code{final_scan_insn}. | |
feca2ed3 JW |
4513 | |
4514 | You need not define this macro if you did not define | |
4515 | @code{DELAY_SLOTS_FOR_EPILOGUE}. | |
a2c4f8e0 | 4516 | @end defmac |
feca2ed3 | 4517 | |
65e71cd6 | 4518 | @deftypefn {Target Hook} void TARGET_ASM_OUTPUT_MI_THUNK (FILE *@var{file}, tree @var{thunk_fndecl}, HOST_WIDE_INT @var{delta}, HOST_WIDE_INT @var{vcall_offset}, tree @var{function}) |
483ab821 | 4519 | A function that outputs the assembler code for a thunk |
feca2ed3 JW |
4520 | function, used to implement C++ virtual function calls with multiple |
4521 | inheritance. The thunk acts as a wrapper around a virtual function, | |
4522 | adjusting the implicit object parameter before handing control off to | |
4523 | the real function. | |
4524 | ||
4525 | First, emit code to add the integer @var{delta} to the location that | |
4526 | contains the incoming first argument. Assume that this argument | |
4527 | contains a pointer, and is the one used to pass the @code{this} pointer | |
4528 | in C++. This is the incoming argument @emph{before} the function prologue, | |
e979f9e8 | 4529 | e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of |
feca2ed3 JW |
4530 | all other incoming arguments. |
4531 | ||
65e71cd6 EB |
4532 | Then, if @var{vcall_offset} is nonzero, an additional adjustment should be |
4533 | made after adding @code{delta}. In particular, if @var{p} is the | |
4534 | adjusted pointer, the following adjustment should be made: | |
4535 | ||
4536 | @smallexample | |
4537 | p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)] | |
4538 | @end smallexample | |
4539 | ||
4540 | After the additions, emit code to jump to @var{function}, which is a | |
feca2ed3 JW |
4541 | @code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does |
4542 | not touch the return address. Hence returning from @var{FUNCTION} will | |
4543 | return to whoever called the current @samp{thunk}. | |
4544 | ||
4545 | The effect must be as if @var{function} had been called directly with | |
4546 | the adjusted first argument. This macro is responsible for emitting all | |
08c148a8 NB |
4547 | of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE} |
4548 | and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked. | |
feca2ed3 JW |
4549 | |
4550 | The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function} | |
4551 | have already been extracted from it.) It might possibly be useful on | |
4552 | some targets, but probably not. | |
4553 | ||
861bb6c1 | 4554 | If you do not define this macro, the target-independent code in the C++ |
c771326b | 4555 | front end will generate a less efficient heavyweight thunk that calls |
861bb6c1 JL |
4556 | @var{function} instead of jumping to it. The generic approach does |
4557 | not support varargs. | |
483ab821 MM |
4558 | @end deftypefn |
4559 | ||
65e71cd6 EB |
4560 | @deftypefn {Target Hook} bool TARGET_ASM_CAN_OUTPUT_MI_THUNK (tree @var{thunk_fndecl}, HOST_WIDE_INT @var{delta}, HOST_WIDE_INT @var{vcall_offset}, tree @var{function}) |
4561 | A function that returns true if TARGET_ASM_OUTPUT_MI_THUNK would be able | |
4562 | to output the assembler code for the thunk function specified by the | |
4563 | arguments it is passed, and false otherwise. In the latter case, the | |
4564 | generic approach will be used by the C++ front end, with the limitations | |
4565 | previously exposed. | |
483ab821 | 4566 | @end deftypefn |
feca2ed3 JW |
4567 | |
4568 | @node Profiling | |
4569 | @subsection Generating Code for Profiling | |
4570 | @cindex profiling, code generation | |
4571 | ||
4572 | These macros will help you generate code for profiling. | |
4573 | ||
a2c4f8e0 | 4574 | @defmac FUNCTION_PROFILER (@var{file}, @var{labelno}) |
feca2ed3 JW |
4575 | A C statement or compound statement to output to @var{file} some |
4576 | assembler code to call the profiling subroutine @code{mcount}. | |
feca2ed3 JW |
4577 | |
4578 | @findex mcount | |
980e2067 | 4579 | The details of how @code{mcount} expects to be called are determined by |
161d7b59 | 4580 | your operating system environment, not by GCC@. To figure them out, |
980e2067 JL |
4581 | compile a small program for profiling using the system's installed C |
4582 | compiler and look at the assembler code that results. | |
4583 | ||
4584 | Older implementations of @code{mcount} expect the address of a counter | |
4585 | variable to be loaded into some register. The name of this variable is | |
4586 | @samp{LP} followed by the number @var{labelno}, so you would generate | |
4587 | the name using @samp{LP%d} in a @code{fprintf}. | |
a2c4f8e0 | 4588 | @end defmac |
980e2067 | 4589 | |
a2c4f8e0 | 4590 | @defmac PROFILE_HOOK |
411707f4 CC |
4591 | A C statement or compound statement to output to @var{file} some assembly |
4592 | code to call the profiling subroutine @code{mcount} even the target does | |
4593 | not support profiling. | |
a2c4f8e0 | 4594 | @end defmac |
411707f4 | 4595 | |
a2c4f8e0 | 4596 | @defmac NO_PROFILE_COUNTERS |
8b65a354 JZ |
4597 | Define this macro to be an expression with a nonzero value if the |
4598 | @code{mcount} subroutine on your system does not need a counter variable | |
4599 | allocated for each function. This is true for almost all modern | |
4600 | implementations. If you define this macro, you must not use the | |
4601 | @var{labelno} argument to @code{FUNCTION_PROFILER}. | |
a2c4f8e0 | 4602 | @end defmac |
feca2ed3 | 4603 | |
a2c4f8e0 | 4604 | @defmac PROFILE_BEFORE_PROLOGUE |
feca2ed3 JW |
4605 | Define this macro if the code for function profiling should come before |
4606 | the function prologue. Normally, the profiling code comes after. | |
a2c4f8e0 | 4607 | @end defmac |
feca2ed3 | 4608 | |
91d231cb JM |
4609 | @node Tail Calls |
4610 | @subsection Permitting tail calls | |
4611 | @cindex tail calls | |
b36f4ed3 | 4612 | |
4977bab6 ZW |
4613 | @deftypefn {Target Hook} bool TARGET_FUNCTION_OK_FOR_SIBCALL (tree @var{decl}, tree @var{exp}) |
4614 | True if it is ok to do sibling call optimization for the specified | |
4615 | call expression @var{exp}. @var{decl} will be the called function, | |
4616 | or @code{NULL} if this is an indirect call. | |
4cb1433c RH |
4617 | |
4618 | It is not uncommon for limitations of calling conventions to prevent | |
4619 | tail calls to functions outside the current unit of translation, or | |
4977bab6 | 4620 | during PIC compilation. The hook is used to enforce these restrictions, |
02f52e19 | 4621 | as the @code{sibcall} md pattern can not fail, or fall over to a |
4977bab6 ZW |
4622 | ``normal'' call. The criteria for successful sibling call optimization |
4623 | may vary greatly between different architectures. | |
4624 | @end deftypefn | |
4cb1433c | 4625 | |
912f2dac DB |
4626 | @deftypefn {Target Hook} void TARGET_EXTRA_LIVE_ON_ENTRY (bitmap *@var{regs}) |
4627 | Add any hard registers to @var{regs} that are live on entry to the | |
4628 | function. This hook only needs to be defined to provide registers that | |
4629 | cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved | |
4630 | registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM, | |
4631 | TARGET_STRUCT_VALUE_RTX, FRAME_POINTER_REGNUM, EH_USES, | |
4632 | FRAME_POINTER_REGNUM, ARG_POINTER_REGNUM, and the PIC_OFFSET_TABLE_REGNUM. | |
4633 | @end deftypefn | |
4634 | ||
7d69de61 RH |
4635 | @node Stack Smashing Protection |
4636 | @subsection Stack smashing protection | |
4637 | @cindex stack smashing protection | |
4638 | ||
4639 | @deftypefn {Target Hook} tree TARGET_STACK_PROTECT_GUARD (void) | |
4640 | This hook returns a @code{DECL} node for the external variable to use | |
083cad55 | 4641 | for the stack protection guard. This variable is initialized by the |
7d69de61 RH |
4642 | runtime to some random value and is used to initialize the guard value |
4643 | that is placed at the top of the local stack frame. The type of this | |
4644 | variable must be @code{ptr_type_node}. | |
4645 | ||
4646 | The default version of this hook creates a variable called | |
4647 | @samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}. | |
4648 | @end deftypefn | |
4649 | ||
4650 | @deftypefn {Target Hook} tree TARGET_STACK_PROTECT_FAIL (void) | |
4651 | This hook returns a tree expression that alerts the runtime that the | |
4652 | stack protect guard variable has been modified. This expression should | |
4653 | involve a call to a @code{noreturn} function. | |
4654 | ||
4655 | The default version of this hook invokes a function called | |
083cad55 | 4656 | @samp{__stack_chk_fail}, taking no arguments. This function is |
7d69de61 RH |
4657 | normally defined in @file{libgcc2.c}. |
4658 | @end deftypefn | |
4659 | ||
feca2ed3 JW |
4660 | @node Varargs |
4661 | @section Implementing the Varargs Macros | |
4662 | @cindex varargs implementation | |
4663 | ||
aee96fe9 JM |
4664 | GCC comes with an implementation of @code{<varargs.h>} and |
4665 | @code{<stdarg.h>} that work without change on machines that pass arguments | |
feca2ed3 JW |
4666 | on the stack. Other machines require their own implementations of |
4667 | varargs, and the two machine independent header files must have | |
4668 | conditionals to include it. | |
4669 | ||
aee96fe9 | 4670 | ISO @code{<stdarg.h>} differs from traditional @code{<varargs.h>} mainly in |
feca2ed3 JW |
4671 | the calling convention for @code{va_start}. The traditional |
4672 | implementation takes just one argument, which is the variable in which | |
5490d604 | 4673 | to store the argument pointer. The ISO implementation of |
feca2ed3 JW |
4674 | @code{va_start} takes an additional second argument. The user is |
4675 | supposed to write the last named argument of the function here. | |
4676 | ||
4677 | However, @code{va_start} should not use this argument. The way to find | |
4678 | the end of the named arguments is with the built-in functions described | |
4679 | below. | |
4680 | ||
a2c4f8e0 | 4681 | @defmac __builtin_saveregs () |
feca2ed3 | 4682 | Use this built-in function to save the argument registers in memory so |
5490d604 | 4683 | that the varargs mechanism can access them. Both ISO and traditional |
feca2ed3 | 4684 | versions of @code{va_start} must use @code{__builtin_saveregs}, unless |
c2379679 | 4685 | you use @code{TARGET_SETUP_INCOMING_VARARGS} (see below) instead. |
feca2ed3 JW |
4686 | |
4687 | On some machines, @code{__builtin_saveregs} is open-coded under the | |
f61c92c3 KH |
4688 | control of the target hook @code{TARGET_EXPAND_BUILTIN_SAVEREGS}. On |
4689 | other machines, it calls a routine written in assembler language, | |
4690 | found in @file{libgcc2.c}. | |
feca2ed3 JW |
4691 | |
4692 | Code generated for the call to @code{__builtin_saveregs} appears at the | |
4693 | beginning of the function, as opposed to where the call to | |
4694 | @code{__builtin_saveregs} is written, regardless of what the code is. | |
4695 | This is because the registers must be saved before the function starts | |
4696 | to use them for its own purposes. | |
4697 | @c i rewrote the first sentence above to fix an overfull hbox. --mew | |
4698 | @c 10feb93 | |
a2c4f8e0 | 4699 | @end defmac |
feca2ed3 | 4700 | |
a2c4f8e0 | 4701 | @defmac __builtin_args_info (@var{category}) |
feca2ed3 JW |
4702 | Use this built-in function to find the first anonymous arguments in |
4703 | registers. | |
4704 | ||
4705 | In general, a machine may have several categories of registers used for | |
4706 | arguments, each for a particular category of data types. (For example, | |
4707 | on some machines, floating-point registers are used for floating-point | |
4708 | arguments while other arguments are passed in the general registers.) | |
4709 | To make non-varargs functions use the proper calling convention, you | |
4710 | have defined the @code{CUMULATIVE_ARGS} data type to record how many | |
4711 | registers in each category have been used so far | |
4712 | ||
4713 | @code{__builtin_args_info} accesses the same data structure of type | |
4714 | @code{CUMULATIVE_ARGS} after the ordinary argument layout is finished | |
4715 | with it, with @var{category} specifying which word to access. Thus, the | |
4716 | value indicates the first unused register in a given category. | |
4717 | ||
4718 | Normally, you would use @code{__builtin_args_info} in the implementation | |
4719 | of @code{va_start}, accessing each category just once and storing the | |
4720 | value in the @code{va_list} object. This is because @code{va_list} will | |
4721 | have to update the values, and there is no way to alter the | |
4722 | values accessed by @code{__builtin_args_info}. | |
a2c4f8e0 | 4723 | @end defmac |
feca2ed3 | 4724 | |
a2c4f8e0 | 4725 | @defmac __builtin_next_arg (@var{lastarg}) |
feca2ed3 JW |
4726 | This is the equivalent of @code{__builtin_args_info}, for stack |
4727 | arguments. It returns the address of the first anonymous stack | |
767094dd | 4728 | argument, as type @code{void *}. If @code{ARGS_GROW_DOWNWARD}, it |
feca2ed3 JW |
4729 | returns the address of the location above the first anonymous stack |
4730 | argument. Use it in @code{va_start} to initialize the pointer for | |
4731 | fetching arguments from the stack. Also use it in @code{va_start} to | |
4732 | verify that the second parameter @var{lastarg} is the last named argument | |
4733 | of the current function. | |
a2c4f8e0 | 4734 | @end defmac |
feca2ed3 | 4735 | |
a2c4f8e0 | 4736 | @defmac __builtin_classify_type (@var{object}) |
feca2ed3 JW |
4737 | Since each machine has its own conventions for which data types are |
4738 | passed in which kind of register, your implementation of @code{va_arg} | |
4739 | has to embody these conventions. The easiest way to categorize the | |
4740 | specified data type is to use @code{__builtin_classify_type} together | |
4741 | with @code{sizeof} and @code{__alignof__}. | |
4742 | ||
4743 | @code{__builtin_classify_type} ignores the value of @var{object}, | |
4744 | considering only its data type. It returns an integer describing what | |
4745 | kind of type that is---integer, floating, pointer, structure, and so on. | |
4746 | ||
4747 | The file @file{typeclass.h} defines an enumeration that you can use to | |
4748 | interpret the values of @code{__builtin_classify_type}. | |
a2c4f8e0 | 4749 | @end defmac |
feca2ed3 JW |
4750 | |
4751 | These machine description macros help implement varargs: | |
4752 | ||
61f71b34 DD |
4753 | @deftypefn {Target Hook} rtx TARGET_EXPAND_BUILTIN_SAVEREGS (void) |
4754 | If defined, this hook produces the machine-specific code for a call to | |
4755 | @code{__builtin_saveregs}. This code will be moved to the very | |
4756 | beginning of the function, before any parameter access are made. The | |
4757 | return value of this function should be an RTX that contains the value | |
4758 | to use as the return of @code{__builtin_saveregs}. | |
4759 | @end deftypefn | |
feca2ed3 | 4760 | |
61f71b34 DD |
4761 | @deftypefn {Target Hook} void TARGET_SETUP_INCOMING_VARARGS (CUMULATIVE_ARGS *@var{args_so_far}, enum machine_mode @var{mode}, tree @var{type}, int *@var{pretend_args_size}, int @var{second_time}) |
4762 | This target hook offers an alternative to using | |
4763 | @code{__builtin_saveregs} and defining the hook | |
4764 | @code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous | |
4765 | register arguments into the stack so that all the arguments appear to | |
4766 | have been passed consecutively on the stack. Once this is done, you can | |
4767 | use the standard implementation of varargs that works for machines that | |
4768 | pass all their arguments on the stack. | |
feca2ed3 | 4769 | |
61f71b34 | 4770 | The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data |
8760eaae | 4771 | structure, containing the values that are obtained after processing the |
feca2ed3 JW |
4772 | named arguments. The arguments @var{mode} and @var{type} describe the |
4773 | last named argument---its machine mode and its data type as a tree node. | |
4774 | ||
61f71b34 DD |
4775 | The target hook should do two things: first, push onto the stack all the |
4776 | argument registers @emph{not} used for the named arguments, and second, | |
4777 | store the size of the data thus pushed into the @code{int}-valued | |
4778 | variable pointed to by @var{pretend_args_size}. The value that you | |
4779 | store here will serve as additional offset for setting up the stack | |
4780 | frame. | |
feca2ed3 JW |
4781 | |
4782 | Because you must generate code to push the anonymous arguments at | |
4783 | compile time without knowing their data types, | |
61f71b34 DD |
4784 | @code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that |
4785 | have just a single category of argument register and use it uniformly | |
4786 | for all data types. | |
feca2ed3 JW |
4787 | |
4788 | If the argument @var{second_time} is nonzero, it means that the | |
4789 | arguments of the function are being analyzed for the second time. This | |
4790 | happens for an inline function, which is not actually compiled until the | |
61f71b34 | 4791 | end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should |
feca2ed3 | 4792 | not generate any instructions in this case. |
61f71b34 | 4793 | @end deftypefn |
feca2ed3 | 4794 | |
61f71b34 DD |
4795 | @deftypefn {Target Hook} bool TARGET_STRICT_ARGUMENT_NAMING (CUMULATIVE_ARGS *@var{ca}) |
4796 | Define this hook to return @code{true} if the location where a function | |
e5e809f4 | 4797 | argument is passed depends on whether or not it is a named argument. |
feca2ed3 | 4798 | |
61f71b34 DD |
4799 | This hook controls how the @var{named} argument to @code{FUNCTION_ARG} |
4800 | is set for varargs and stdarg functions. If this hook returns | |
4801 | @code{true}, the @var{named} argument is always true for named | |
4802 | arguments, and false for unnamed arguments. If it returns @code{false}, | |
5b4ef0b1 | 4803 | but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true}, |
61f71b34 DD |
4804 | then all arguments are treated as named. Otherwise, all named arguments |
4805 | except the last are treated as named. | |
e5e809f4 | 4806 | |
61f71b34 DD |
4807 | You need not define this hook if it always returns zero. |
4808 | @end deftypefn | |
9ab70a9b | 4809 | |
61f71b34 | 4810 | @deftypefn {Target Hook} bool TARGET_PRETEND_OUTGOING_VARARGS_NAMED |
9ab70a9b | 4811 | If you need to conditionally change ABIs so that one works with |
61f71b34 DD |
4812 | @code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither |
4813 | @code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was | |
4814 | defined, then define this hook to return @code{true} if | |
c2379679 | 4815 | @code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise. |
61f71b34 DD |
4816 | Otherwise, you should not define this hook. |
4817 | @end deftypefn | |
feca2ed3 JW |
4818 | |
4819 | @node Trampolines | |
4820 | @section Trampolines for Nested Functions | |
4821 | @cindex trampolines for nested functions | |
4822 | @cindex nested functions, trampolines for | |
4823 | ||
4824 | A @dfn{trampoline} is a small piece of code that is created at run time | |
4825 | when the address of a nested function is taken. It normally resides on | |
4826 | the stack, in the stack frame of the containing function. These macros | |
a3a15b4d | 4827 | tell GCC how to generate code to allocate and initialize a |
feca2ed3 JW |
4828 | trampoline. |
4829 | ||
4830 | The instructions in the trampoline must do two things: load a constant | |
4831 | address into the static chain register, and jump to the real address of | |
4832 | the nested function. On CISC machines such as the m68k, this requires | |
4833 | two instructions, a move immediate and a jump. Then the two addresses | |
4834 | exist in the trampoline as word-long immediate operands. On RISC | |
4835 | machines, it is often necessary to load each address into a register in | |
4836 | two parts. Then pieces of each address form separate immediate | |
4837 | operands. | |
4838 | ||
4839 | The code generated to initialize the trampoline must store the variable | |
4840 | parts---the static chain value and the function address---into the | |
4841 | immediate operands of the instructions. On a CISC machine, this is | |
4842 | simply a matter of copying each address to a memory reference at the | |
4843 | proper offset from the start of the trampoline. On a RISC machine, it | |
4844 | may be necessary to take out pieces of the address and store them | |
4845 | separately. | |
4846 | ||
a2c4f8e0 | 4847 | @defmac TRAMPOLINE_TEMPLATE (@var{file}) |
feca2ed3 JW |
4848 | A C statement to output, on the stream @var{file}, assembler code for a |
4849 | block of data that contains the constant parts of a trampoline. This | |
4850 | code should not include a label---the label is taken care of | |
4851 | automatically. | |
4852 | ||
4853 | If you do not define this macro, it means no template is needed | |
4854 | for the target. Do not define this macro on systems where the block move | |
4855 | code to copy the trampoline into place would be larger than the code | |
4856 | to generate it on the spot. | |
a2c4f8e0 | 4857 | @end defmac |
feca2ed3 | 4858 | |
a2c4f8e0 | 4859 | @defmac TRAMPOLINE_SECTION |
d6b5193b RS |
4860 | Return the section into which the trampoline template is to be placed |
4861 | (@pxref{Sections}). The default value is @code{readonly_data_section}. | |
a2c4f8e0 | 4862 | @end defmac |
feca2ed3 | 4863 | |
a2c4f8e0 | 4864 | @defmac TRAMPOLINE_SIZE |
feca2ed3 | 4865 | A C expression for the size in bytes of the trampoline, as an integer. |
a2c4f8e0 | 4866 | @end defmac |
feca2ed3 | 4867 | |
a2c4f8e0 | 4868 | @defmac TRAMPOLINE_ALIGNMENT |
feca2ed3 JW |
4869 | Alignment required for trampolines, in bits. |
4870 | ||
4871 | If you don't define this macro, the value of @code{BIGGEST_ALIGNMENT} | |
4872 | is used for aligning trampolines. | |
a2c4f8e0 | 4873 | @end defmac |
feca2ed3 | 4874 | |
a2c4f8e0 | 4875 | @defmac INITIALIZE_TRAMPOLINE (@var{addr}, @var{fnaddr}, @var{static_chain}) |
feca2ed3 JW |
4876 | A C statement to initialize the variable parts of a trampoline. |
4877 | @var{addr} is an RTX for the address of the trampoline; @var{fnaddr} is | |
4878 | an RTX for the address of the nested function; @var{static_chain} is an | |
4879 | RTX for the static chain value that should be passed to the function | |
4880 | when it is called. | |
a2c4f8e0 | 4881 | @end defmac |
feca2ed3 | 4882 | |
a2c4f8e0 | 4883 | @defmac TRAMPOLINE_ADJUST_ADDRESS (@var{addr}) |
b33493e3 AO |
4884 | A C statement that should perform any machine-specific adjustment in |
4885 | the address of the trampoline. Its argument contains the address that | |
4886 | was passed to @code{INITIALIZE_TRAMPOLINE}. In case the address to be | |
4887 | used for a function call should be different from the address in which | |
4888 | the template was stored, the different address should be assigned to | |
4889 | @var{addr}. If this macro is not defined, @var{addr} will be used for | |
4890 | function calls. | |
4891 | ||
08c148a8 NB |
4892 | @cindex @code{TARGET_ASM_FUNCTION_EPILOGUE} and trampolines |
4893 | @cindex @code{TARGET_ASM_FUNCTION_PROLOGUE} and trampolines | |
feca2ed3 JW |
4894 | If this macro is not defined, by default the trampoline is allocated as |
4895 | a stack slot. This default is right for most machines. The exceptions | |
4896 | are machines where it is impossible to execute instructions in the stack | |
4897 | area. On such machines, you may have to implement a separate stack, | |
08c148a8 NB |
4898 | using this macro in conjunction with @code{TARGET_ASM_FUNCTION_PROLOGUE} |
4899 | and @code{TARGET_ASM_FUNCTION_EPILOGUE}. | |
feca2ed3 JW |
4900 | |
4901 | @var{fp} points to a data structure, a @code{struct function}, which | |
4902 | describes the compilation status of the immediate containing function of | |
0d569849 | 4903 | the function which the trampoline is for. The stack slot for the |
feca2ed3 JW |
4904 | trampoline is in the stack frame of this containing function. Other |
4905 | allocation strategies probably must do something analogous with this | |
4906 | information. | |
a2c4f8e0 | 4907 | @end defmac |
feca2ed3 JW |
4908 | |
4909 | Implementing trampolines is difficult on many machines because they have | |
4910 | separate instruction and data caches. Writing into a stack location | |
4911 | fails to clear the memory in the instruction cache, so when the program | |
4912 | jumps to that location, it executes the old contents. | |
4913 | ||
4914 | Here are two possible solutions. One is to clear the relevant parts of | |
4915 | the instruction cache whenever a trampoline is set up. The other is to | |
4916 | make all trampolines identical, by having them jump to a standard | |
4917 | subroutine. The former technique makes trampoline execution faster; the | |
4918 | latter makes initialization faster. | |
4919 | ||
4920 | To clear the instruction cache when a trampoline is initialized, define | |
f691dc3b | 4921 | the following macro. |
feca2ed3 | 4922 | |
a2c4f8e0 | 4923 | @defmac CLEAR_INSN_CACHE (@var{beg}, @var{end}) |
feca2ed3 | 4924 | If defined, expands to a C expression clearing the @emph{instruction |
f691dc3b AJ |
4925 | cache} in the specified interval. The definition of this macro would |
4926 | typically be a series of @code{asm} statements. Both @var{beg} and | |
4927 | @var{end} are both pointer expressions. | |
a2c4f8e0 | 4928 | @end defmac |
feca2ed3 | 4929 | |
e7a742ec EB |
4930 | The operating system may also require the stack to be made executable |
4931 | before calling the trampoline. To implement this requirement, define | |
4932 | the following macro. | |
4933 | ||
4934 | @defmac ENABLE_EXECUTE_STACK | |
4935 | Define this macro if certain operations must be performed before executing | |
4936 | code located on the stack. The macro should expand to a series of C | |
431ae0bf | 4937 | file-scope constructs (e.g.@: functions) and provide a unique entry point |
e7a742ec EB |
4938 | named @code{__enable_execute_stack}. The target is responsible for |
4939 | emitting calls to the entry point in the code, for example from the | |
4940 | @code{INITIALIZE_TRAMPOLINE} macro. | |
4941 | @end defmac | |
4942 | ||
feca2ed3 JW |
4943 | To use a standard subroutine, define the following macro. In addition, |
4944 | you must make sure that the instructions in a trampoline fill an entire | |
4945 | cache line with identical instructions, or else ensure that the | |
4946 | beginning of the trampoline code is always aligned at the same point in | |
4947 | its cache line. Look in @file{m68k.h} as a guide. | |
4948 | ||
a2c4f8e0 | 4949 | @defmac TRANSFER_FROM_TRAMPOLINE |
feca2ed3 JW |
4950 | Define this macro if trampolines need a special subroutine to do their |
4951 | work. The macro should expand to a series of @code{asm} statements | |
161d7b59 | 4952 | which will be compiled with GCC@. They go in a library function named |
feca2ed3 JW |
4953 | @code{__transfer_from_trampoline}. |
4954 | ||
4955 | If you need to avoid executing the ordinary prologue code of a compiled | |
4956 | C function when you jump to the subroutine, you can do so by placing a | |
4957 | special label of your own in the assembler code. Use one @code{asm} | |
4958 | statement to generate an assembler label, and another to make the label | |
4959 | global. Then trampolines can use that label to jump directly to your | |
4960 | special assembler code. | |
a2c4f8e0 | 4961 | @end defmac |
feca2ed3 JW |
4962 | |
4963 | @node Library Calls | |
4964 | @section Implicit Calls to Library Routines | |
4965 | @cindex library subroutine names | |
4966 | @cindex @file{libgcc.a} | |
4967 | ||
4968 | @c prevent bad page break with this line | |
4969 | Here is an explanation of implicit calls to library routines. | |
4970 | ||
a2c4f8e0 | 4971 | @defmac DECLARE_LIBRARY_RENAMES |
d8088c6f BS |
4972 | This macro, if defined, should expand to a piece of C code that will get |
4973 | expanded when compiling functions for libgcc.a. It can be used to | |
2dd76960 | 4974 | provide alternate names for GCC's internal library functions if there |
d8088c6f | 4975 | are ABI-mandated names that the compiler should provide. |
a2c4f8e0 | 4976 | @end defmac |
d8088c6f | 4977 | |
c15c90bb ZW |
4978 | @findex init_one_libfunc |
4979 | @findex set_optab_libfunc | |
4980 | @deftypefn {Target Hook} void TARGET_INIT_LIBFUNCS (void) | |
4981 | This hook should declare additional library routines or rename | |
4982 | existing ones, using the functions @code{set_optab_libfunc} and | |
4983 | @code{init_one_libfunc} defined in @file{optabs.c}. | |
4984 | @code{init_optabs} calls this macro after initializing all the normal | |
4985 | library routines. | |
feca2ed3 | 4986 | |
c15c90bb ZW |
4987 | The default is to do nothing. Most ports don't need to define this hook. |
4988 | @end deftypefn | |
c5c60e15 | 4989 | |
9c917669 | 4990 | @defmac FLOAT_LIB_COMPARE_RETURNS_BOOL (@var{mode}, @var{comparison}) |
c15c90bb ZW |
4991 | This macro should return @code{true} if the library routine that |
4992 | implements the floating point comparison operator @var{comparison} in | |
4993 | mode @var{mode} will return a boolean, and @var{false} if it will | |
4994 | return a tristate. | |
4995 | ||
4996 | GCC's own floating point libraries return tristates from the | |
4997 | comparison operators, so the default returns false always. Most ports | |
4998 | don't need to define this macro. | |
4999 | @end defmac | |
5000 | ||
b3f8d95d MM |
5001 | @defmac TARGET_LIB_INT_CMP_BIASED |
5002 | This macro should evaluate to @code{true} if the integer comparison | |
5003 | functions (like @code{__cmpdi2}) return 0 to indicate that the first | |
5004 | operand is smaller than the second, 1 to indicate that they are equal, | |
5005 | and 2 to indicate that the first operand is greater than the second. | |
38b974a6 | 5006 | If this macro evaluates to @code{false} the comparison functions return |
78466c0e | 5007 | @minus{}1, 0, and 1 instead of 0, 1, and 2. If the target uses the routines |
b3f8d95d MM |
5008 | in @file{libgcc.a}, you do not need to define this macro. |
5009 | @end defmac | |
5010 | ||
c15c90bb ZW |
5011 | @cindex US Software GOFAST, floating point emulation library |
5012 | @cindex floating point emulation library, US Software GOFAST | |
5013 | @cindex GOFAST, floating point emulation library | |
5014 | @findex gofast_maybe_init_libfuncs | |
5015 | @defmac US_SOFTWARE_GOFAST | |
5016 | Define this macro if your system C library uses the US Software GOFAST | |
73774972 | 5017 | library to provide floating point emulation. |
c15c90bb ZW |
5018 | |
5019 | In addition to defining this macro, your architecture must set | |
5020 | @code{TARGET_INIT_LIBFUNCS} to @code{gofast_maybe_init_libfuncs}, or | |
5021 | else call that function from its version of that hook. It is defined | |
5022 | in @file{config/gofast.h}, which must be included by your | |
5023 | architecture's @file{@var{cpu}.c} file. See @file{sparc/sparc.c} for | |
5024 | an example. | |
5025 | ||
5026 | If this macro is defined, the | |
5027 | @code{TARGET_FLOAT_LIB_COMPARE_RETURNS_BOOL} target hook must return | |
5028 | false for @code{SFmode} and @code{DFmode} comparisons. | |
a2c4f8e0 | 5029 | @end defmac |
c5c60e15 | 5030 | |
feca2ed3 | 5031 | @cindex @code{EDOM}, implicit usage |
a2c4f8e0 ZW |
5032 | @findex matherr |
5033 | @defmac TARGET_EDOM | |
feca2ed3 | 5034 | The value of @code{EDOM} on the target machine, as a C integer constant |
a3a15b4d | 5035 | expression. If you don't define this macro, GCC does not attempt to |
feca2ed3 JW |
5036 | deposit the value of @code{EDOM} into @code{errno} directly. Look in |
5037 | @file{/usr/include/errno.h} to find the value of @code{EDOM} on your | |
5038 | system. | |
5039 | ||
5040 | If you do not define @code{TARGET_EDOM}, then compiled code reports | |
5041 | domain errors by calling the library function and letting it report the | |
5042 | error. If mathematical functions on your system use @code{matherr} when | |
5043 | there is an error, then you should leave @code{TARGET_EDOM} undefined so | |
5044 | that @code{matherr} is used normally. | |
a2c4f8e0 | 5045 | @end defmac |
feca2ed3 | 5046 | |
feca2ed3 | 5047 | @cindex @code{errno}, implicit usage |
a2c4f8e0 | 5048 | @defmac GEN_ERRNO_RTX |
feca2ed3 JW |
5049 | Define this macro as a C expression to create an rtl expression that |
5050 | refers to the global ``variable'' @code{errno}. (On certain systems, | |
5051 | @code{errno} may not actually be a variable.) If you don't define this | |
5052 | macro, a reasonable default is used. | |
a2c4f8e0 | 5053 | @end defmac |
feca2ed3 | 5054 | |
272f51a3 | 5055 | @cindex C99 math functions, implicit usage |
a2c4f8e0 | 5056 | @defmac TARGET_C99_FUNCTIONS |
272f51a3 | 5057 | When this macro is nonzero, GCC will implicitly optimize @code{sin} calls into |
3bcf1b13 | 5058 | @code{sinf} and similarly for other functions defined by C99 standard. The |
272f51a3 JH |
5059 | default is nonzero that should be proper value for most modern systems, however |
5060 | number of existing systems lacks support for these functions in the runtime so | |
5061 | they needs this macro to be redefined to 0. | |
a2c4f8e0 | 5062 | @end defmac |
272f51a3 | 5063 | |
006339cd RG |
5064 | @cindex sincos math function, implicit usage |
5065 | @defmac TARGET_HAS_SINCOS | |
5066 | When this macro is nonzero, GCC will implicitly optimize calls to @code{sin} | |
5067 | and @code{cos} with the same argument to a call to @code{sincos}. The | |
5068 | default is zero. The target has to provide the following functions: | |
5069 | @smallexample | |
5070 | void sincos(double x, double *sin, double *cos); | |
5071 | void sincosf(float x, float *sin, float *cos); | |
5072 | void sincosl(long double x, long double *sin, long double *cos); | |
5073 | @end smallexample | |
5074 | @end defmac | |
5075 | ||
a2c4f8e0 | 5076 | @defmac NEXT_OBJC_RUNTIME |
2147b154 | 5077 | Define this macro to generate code for Objective-C message sending using |
feca2ed3 JW |
5078 | the calling convention of the NeXT system. This calling convention |
5079 | involves passing the object, the selector and the method arguments all | |
5080 | at once to the method-lookup library function. | |
5081 | ||
5082 | The default calling convention passes just the object and the selector | |
5083 | to the lookup function, which returns a pointer to the method. | |
a2c4f8e0 | 5084 | @end defmac |
feca2ed3 JW |
5085 | |
5086 | @node Addressing Modes | |
5087 | @section Addressing Modes | |
5088 | @cindex addressing modes | |
5089 | ||
5090 | @c prevent bad page break with this line | |
5091 | This is about addressing modes. | |
5092 | ||
a2c4f8e0 ZW |
5093 | @defmac HAVE_PRE_INCREMENT |
5094 | @defmacx HAVE_PRE_DECREMENT | |
5095 | @defmacx HAVE_POST_INCREMENT | |
5096 | @defmacx HAVE_POST_DECREMENT | |
df2a54e9 | 5097 | A C expression that is nonzero if the machine supports pre-increment, |
7a6bd5ae | 5098 | pre-decrement, post-increment, or post-decrement addressing respectively. |
a2c4f8e0 | 5099 | @end defmac |
feca2ed3 | 5100 | |
a2c4f8e0 ZW |
5101 | @defmac HAVE_PRE_MODIFY_DISP |
5102 | @defmacx HAVE_POST_MODIFY_DISP | |
df2a54e9 | 5103 | A C expression that is nonzero if the machine supports pre- or |
7a6bd5ae JL |
5104 | post-address side-effect generation involving constants other than |
5105 | the size of the memory operand. | |
a2c4f8e0 | 5106 | @end defmac |
864bcaa7 | 5107 | |
a2c4f8e0 ZW |
5108 | @defmac HAVE_PRE_MODIFY_REG |
5109 | @defmacx HAVE_POST_MODIFY_REG | |
df2a54e9 | 5110 | A C expression that is nonzero if the machine supports pre- or |
7a6bd5ae | 5111 | post-address side-effect generation involving a register displacement. |
a2c4f8e0 | 5112 | @end defmac |
864bcaa7 | 5113 | |
a2c4f8e0 | 5114 | @defmac CONSTANT_ADDRESS_P (@var{x}) |
feca2ed3 JW |
5115 | A C expression that is 1 if the RTX @var{x} is a constant which |
5116 | is a valid address. On most machines, this can be defined as | |
5117 | @code{CONSTANT_P (@var{x})}, but a few machines are more restrictive | |
5118 | in which constant addresses are supported. | |
a2c4f8e0 | 5119 | @end defmac |
feca2ed3 | 5120 | |
a2c4f8e0 ZW |
5121 | @defmac CONSTANT_P (@var{x}) |
5122 | @code{CONSTANT_P}, which is defined by target-independent code, | |
5123 | accepts integer-values expressions whose values are not explicitly | |
5124 | known, such as @code{symbol_ref}, @code{label_ref}, and @code{high} | |
5125 | expressions and @code{const} arithmetic expressions, in addition to | |
5126 | @code{const_int} and @code{const_double} expressions. | |
5127 | @end defmac | |
feca2ed3 | 5128 | |
a2c4f8e0 | 5129 | @defmac MAX_REGS_PER_ADDRESS |
feca2ed3 JW |
5130 | A number, the maximum number of registers that can appear in a valid |
5131 | memory address. Note that it is up to you to specify a value equal to | |
5132 | the maximum number that @code{GO_IF_LEGITIMATE_ADDRESS} would ever | |
5133 | accept. | |
a2c4f8e0 | 5134 | @end defmac |
feca2ed3 | 5135 | |
a2c4f8e0 | 5136 | @defmac GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label}) |
feca2ed3 JW |
5137 | A C compound statement with a conditional @code{goto @var{label};} |
5138 | executed if @var{x} (an RTX) is a legitimate memory address on the | |
5139 | target machine for a memory operand of mode @var{mode}. | |
5140 | ||
5141 | It usually pays to define several simpler macros to serve as | |
5142 | subroutines for this one. Otherwise it may be too complicated to | |
5143 | understand. | |
5144 | ||
5145 | This macro must exist in two variants: a strict variant and a | |
5146 | non-strict one. The strict variant is used in the reload pass. It | |
5147 | must be defined so that any pseudo-register that has not been | |
5148 | allocated a hard register is considered a memory reference. In | |
5149 | contexts where some kind of register is required, a pseudo-register | |
5150 | with no hard register must be rejected. | |
5151 | ||
5152 | The non-strict variant is used in other passes. It must be defined to | |
5153 | accept all pseudo-registers in every context where some kind of | |
5154 | register is required. | |
5155 | ||
5156 | @findex REG_OK_STRICT | |
5157 | Compiler source files that want to use the strict variant of this | |
5158 | macro define the macro @code{REG_OK_STRICT}. You should use an | |
5159 | @code{#ifdef REG_OK_STRICT} conditional to define the strict variant | |
5160 | in that case and the non-strict variant otherwise. | |
5161 | ||
5162 | Subroutines to check for acceptable registers for various purposes (one | |
5163 | for base registers, one for index registers, and so on) are typically | |
5164 | among the subroutines used to define @code{GO_IF_LEGITIMATE_ADDRESS}. | |
5165 | Then only these subroutine macros need have two variants; the higher | |
bd819a4a | 5166 | levels of macros may be the same whether strict or not. |
feca2ed3 JW |
5167 | |
5168 | Normally, constant addresses which are the sum of a @code{symbol_ref} | |
5169 | and an integer are stored inside a @code{const} RTX to mark them as | |
5170 | constant. Therefore, there is no need to recognize such sums | |
5171 | specifically as legitimate addresses. Normally you would simply | |
5172 | recognize any @code{const} as legitimate. | |
5173 | ||
5174 | Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant | |
5175 | sums that are not marked with @code{const}. It assumes that a naked | |
5176 | @code{plus} indicates indexing. If so, then you @emph{must} reject such | |
5177 | naked constant sums as illegitimate addresses, so that none of them will | |
5178 | be given to @code{PRINT_OPERAND_ADDRESS}. | |
5179 | ||
fb49053f | 5180 | @cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation |
feca2ed3 JW |
5181 | On some machines, whether a symbolic address is legitimate depends on |
5182 | the section that the address refers to. On these machines, define the | |
fb49053f RH |
5183 | target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information |
5184 | into the @code{symbol_ref}, and then check for it here. When you see a | |
feca2ed3 JW |
5185 | @code{const}, you will have to look inside it to find the |
5186 | @code{symbol_ref} in order to determine the section. @xref{Assembler | |
5187 | Format}. | |
a2c4f8e0 | 5188 | @end defmac |
feca2ed3 | 5189 | |
a2c4f8e0 | 5190 | @defmac FIND_BASE_TERM (@var{x}) |
b949ea8b JW |
5191 | A C expression to determine the base term of address @var{x}. |
5192 | This macro is used in only one place: `find_base_term' in alias.c. | |
5193 | ||
5194 | It is always safe for this macro to not be defined. It exists so | |
5195 | that alias analysis can understand machine-dependent addresses. | |
5196 | ||
5197 | The typical use of this macro is to handle addresses containing | |
161d7b59 | 5198 | a label_ref or symbol_ref within an UNSPEC@. |
a2c4f8e0 | 5199 | @end defmac |
b949ea8b | 5200 | |
a2c4f8e0 | 5201 | @defmac LEGITIMIZE_ADDRESS (@var{x}, @var{oldx}, @var{mode}, @var{win}) |
feca2ed3 JW |
5202 | A C compound statement that attempts to replace @var{x} with a valid |
5203 | memory address for an operand of mode @var{mode}. @var{win} will be a | |
5204 | C statement label elsewhere in the code; the macro definition may use | |
5205 | ||
3ab51846 | 5206 | @smallexample |
feca2ed3 | 5207 | GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{win}); |
3ab51846 | 5208 | @end smallexample |
feca2ed3 JW |
5209 | |
5210 | @noindent | |
5211 | to avoid further processing if the address has become legitimate. | |
5212 | ||
5213 | @findex break_out_memory_refs | |
5214 | @var{x} will always be the result of a call to @code{break_out_memory_refs}, | |
5215 | and @var{oldx} will be the operand that was given to that function to produce | |
5216 | @var{x}. | |
5217 | ||
5218 | The code generated by this macro should not alter the substructure of | |
5219 | @var{x}. If it transforms @var{x} into a more legitimate form, it | |
5220 | should assign @var{x} (which will always be a C variable) a new value. | |
5221 | ||
5222 | It is not necessary for this macro to come up with a legitimate | |
5223 | address. The compiler has standard ways of doing so in all cases. In | |
3e759eda | 5224 | fact, it is safe to omit this macro. But often a |
feca2ed3 | 5225 | machine-dependent strategy can generate better code. |
a2c4f8e0 | 5226 | @end defmac |
feca2ed3 | 5227 | |
a2c4f8e0 | 5228 | @defmac LEGITIMIZE_RELOAD_ADDRESS (@var{x}, @var{mode}, @var{opnum}, @var{type}, @var{ind_levels}, @var{win}) |
a9a2595b JR |
5229 | A C compound statement that attempts to replace @var{x}, which is an address |
5230 | that needs reloading, with a valid memory address for an operand of mode | |
5231 | @var{mode}. @var{win} will be a C statement label elsewhere in the code. | |
5232 | It is not necessary to define this macro, but it might be useful for | |
02f52e19 | 5233 | performance reasons. |
a9a2595b JR |
5234 | |
5235 | For example, on the i386, it is sometimes possible to use a single | |
5236 | reload register instead of two by reloading a sum of two pseudo | |
5237 | registers into a register. On the other hand, for number of RISC | |
5238 | processors offsets are limited so that often an intermediate address | |
5239 | needs to be generated in order to address a stack slot. By defining | |
aee96fe9 | 5240 | @code{LEGITIMIZE_RELOAD_ADDRESS} appropriately, the intermediate addresses |
a9a2595b JR |
5241 | generated for adjacent some stack slots can be made identical, and thus |
5242 | be shared. | |
5243 | ||
39bdfaa0 RH |
5244 | @emph{Note}: This macro should be used with caution. It is necessary |
5245 | to know something of how reload works in order to effectively use this, | |
5246 | and it is quite easy to produce macros that build in too much knowledge | |
5247 | of reload internals. | |
a9a2595b | 5248 | |
5f0c590d JL |
5249 | @emph{Note}: This macro must be able to reload an address created by a |
5250 | previous invocation of this macro. If it fails to handle such addresses | |
5251 | then the compiler may generate incorrect code or abort. | |
5252 | ||
a9a2595b | 5253 | @findex push_reload |
39bdfaa0 RH |
5254 | The macro definition should use @code{push_reload} to indicate parts that |
5255 | need reloading; @var{opnum}, @var{type} and @var{ind_levels} are usually | |
5256 | suitable to be passed unaltered to @code{push_reload}. | |
a9a2595b | 5257 | |
39bdfaa0 | 5258 | The code generated by this macro must not alter the substructure of |
a9a2595b JR |
5259 | @var{x}. If it transforms @var{x} into a more legitimate form, it |
5260 | should assign @var{x} (which will always be a C variable) a new value. | |
5261 | This also applies to parts that you change indirectly by calling | |
5262 | @code{push_reload}. | |
5263 | ||
39bdfaa0 RH |
5264 | @findex strict_memory_address_p |
5265 | The macro definition may use @code{strict_memory_address_p} to test if | |
5266 | the address has become legitimate. | |
5267 | ||
a9a2595b JR |
5268 | @findex copy_rtx |
5269 | If you want to change only a part of @var{x}, one standard way of doing | |
5270 | this is to use @code{copy_rtx}. Note, however, that is unshares only a | |
5271 | single level of rtl. Thus, if the part to be changed is not at the | |
c771326b | 5272 | top level, you'll need to replace first the top level. |
a9a2595b JR |
5273 | It is not necessary for this macro to come up with a legitimate |
5274 | address; but often a machine-dependent strategy can generate better code. | |
a2c4f8e0 | 5275 | @end defmac |
a9a2595b | 5276 | |
a2c4f8e0 | 5277 | @defmac GO_IF_MODE_DEPENDENT_ADDRESS (@var{addr}, @var{label}) |
feca2ed3 JW |
5278 | A C statement or compound statement with a conditional @code{goto |
5279 | @var{label};} executed if memory address @var{x} (an RTX) can have | |
5280 | different meanings depending on the machine mode of the memory | |
5281 | reference it is used for or if the address is valid for some modes | |
5282 | but not others. | |
5283 | ||
5284 | Autoincrement and autodecrement addresses typically have mode-dependent | |
5285 | effects because the amount of the increment or decrement is the size | |
5286 | of the operand being addressed. Some machines have other mode-dependent | |
5287 | addresses. Many RISC machines have no mode-dependent addresses. | |
5288 | ||
5289 | You may assume that @var{addr} is a valid address for the machine. | |
a2c4f8e0 | 5290 | @end defmac |
feca2ed3 | 5291 | |
a2c4f8e0 | 5292 | @defmac LEGITIMATE_CONSTANT_P (@var{x}) |
feca2ed3 JW |
5293 | A C expression that is nonzero if @var{x} is a legitimate constant for |
5294 | an immediate operand on the target machine. You can assume that | |
5295 | @var{x} satisfies @code{CONSTANT_P}, so you need not check this. In fact, | |
5296 | @samp{1} is a suitable definition for this macro on machines where | |
bd819a4a | 5297 | anything @code{CONSTANT_P} is valid. |
a2c4f8e0 | 5298 | @end defmac |
feca2ed3 | 5299 | |
73f8783a RS |
5300 | @deftypefn {Target Hook} rtx TARGET_DELEGITIMIZE_ADDRESS (rtx @var{x}) |
5301 | This hook is used to undo the possibly obfuscating effects of the | |
5302 | @code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target | |
5303 | macros. Some backend implementations of these macros wrap symbol | |
5304 | references inside an @code{UNSPEC} rtx to represent PIC or similar | |
5305 | addressing modes. This target hook allows GCC's optimizers to understand | |
5306 | the semantics of these opaque @code{UNSPEC}s by converting them back | |
5307 | into their original form. | |
5308 | @end deftypefn | |
5309 | ||
d3da4d14 RH |
5310 | @deftypefn {Target Hook} bool TARGET_CANNOT_FORCE_CONST_MEM (rtx @var{x}) |
5311 | This hook should return true if @var{x} is of a form that cannot (or | |
5312 | should not) be spilled to the constant pool. The default version of | |
5313 | this hook returns false. | |
5314 | ||
5315 | The primary reason to define this hook is to prevent reload from | |
5316 | deciding that a non-legitimate constant would be better reloaded | |
5317 | from the constant pool instead of spilling and reloading a register | |
5318 | holding the constant. This restriction is often true of addresses | |
5319 | of TLS symbols for various targets. | |
5320 | @end deftypefn | |
5321 | ||
aacd3885 RS |
5322 | @deftypefn {Target Hook} bool TARGET_USE_BLOCKS_FOR_CONSTANT_P (enum machine_mode @var{mode}, rtx @var{x}) |
5323 | This hook should return true if pool entries for constant @var{x} can | |
5324 | be placed in an @code{object_block} structure. @var{mode} is the mode | |
5325 | of @var{x}. | |
5326 | ||
5327 | The default version returns false for all constants. | |
5328 | @end deftypefn | |
5329 | ||
d16b59fa DN |
5330 | @deftypefn {Target Hook} tree TARGET_VECTORIZE_BUILTIN_MASK_FOR_LOAD (void) |
5331 | This hook should return the DECL of a function @var{f} that given an | |
5332 | address @var{addr} as an argument returns a mask @var{m} that can be | |
083cad55 | 5333 | used to extract from two vectors the relevant data that resides in |
d16b59fa DN |
5334 | @var{addr} in case @var{addr} is not properly aligned. |
5335 | ||
5336 | The autovectrizer, when vectorizing a load operation from an address | |
5337 | @var{addr} that may be unaligned, will generate two vector loads from | |
5338 | the two aligned addresses around @var{addr}. It then generates a | |
5339 | @code{REALIGN_LOAD} operation to extract the relevant data from the | |
5340 | two loaded vectors. The first two arguments to @code{REALIGN_LOAD}, | |
5341 | @var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and | |
5342 | the third argument, @var{OFF}, defines how the data will be extracted | |
5343 | from these two vectors: if @var{OFF} is 0, then the returned vector is | |
083cad55 EC |
5344 | @var{v2}; otherwise, the returned vector is composed from the last |
5345 | @var{VS}-@var{OFF} elements of @var{v1} concatenated to the first | |
d16b59fa DN |
5346 | @var{OFF} elements of @var{v2}. |
5347 | ||
5348 | If this hook is defined, the autovectorizer will generate a call | |
5349 | to @var{f} (using the DECL tree that this hook returns) and will | |
5350 | use the return value of @var{f} as the argument @var{OFF} to | |
5351 | @code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f} | |
083cad55 | 5352 | should comply with the semantics expected by @code{REALIGN_LOAD} |
d16b59fa DN |
5353 | described above. |
5354 | If this hook is not defined, then @var{addr} will be used as | |
5355 | the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low | |
5356 | log2(@var{VS})-1 bits of @var{addr} will be considered. | |
5357 | @end deftypefn | |
5358 | ||
89d67cca DN |
5359 | @deftypefn {Target Hook} tree TARGET_VECTORIZE_BUILTIN_MUL_WIDEN_EVEN (tree @var{x}) |
5360 | This hook should return the DECL of a function @var{f} that implements | |
5361 | widening multiplication of the even elements of two input vectors of type @var{x}. | |
5362 | ||
5363 | If this hook is defined, the autovectorizer will use it along with the | |
5364 | @code{TARGET_VECTORIZE_BUILTIN_MUL_WIDEN_ODD} target hook when vectorizing | |
5365 | widening multiplication in cases that the order of the results does not have to be | |
5366 | preserved (e.g. used only by a reduction computation). Otherwise, the | |
5367 | @code{widen_mult_hi/lo} idioms will be used. | |
5368 | @end deftypefn | |
5369 | ||
5370 | @deftypefn {Target Hook} tree TARGET_VECTORIZE_BUILTIN_MUL_WIDEN_ODD (tree @var{x}) | |
5371 | This hook should return the DECL of a function @var{f} that implements | |
5372 | widening multiplication of the odd elements of two input vectors of type @var{x}. | |
5373 | ||
5374 | If this hook is defined, the autovectorizer will use it along with the | |
5375 | @code{TARGET_VECTORIZE_BUILTIN_MUL_WIDEN_EVEN} target hook when vectorizing | |
5376 | widening multiplication in cases that the order of the results does not have to be | |
5377 | preserved (e.g. used only by a reduction computation). Otherwise, the | |
5378 | @code{widen_mult_hi/lo} idioms will be used. | |
5379 | @end deftypefn | |
5380 | ||
2505a3f2 RG |
5381 | @deftypefn {Target Hook} tree TARGET_VECTORIZE_BUILTIN_VECTORIZED_FUNCTION (enum built_in_function @var{code}, tree @var{vec_type}) |
5382 | This hook should return the decl of a function that implements the vectorized | |
5383 | variant of the builtin function with builtin function code @var{code} or | |
5384 | @code{NULL_TREE} if such a function is not available. The return type of | |
5385 | the vectorized function shall be of vector type @var{vec_type}. | |
5386 | @end deftypefn | |
5387 | ||
aacd3885 RS |
5388 | @node Anchored Addresses |
5389 | @section Anchored Addresses | |
5390 | @cindex anchored addresses | |
5391 | @cindex @option{-fsection-anchors} | |
5392 | ||
5393 | GCC usually addresses every static object as a separate entity. | |
5394 | For example, if we have: | |
5395 | ||
5396 | @smallexample | |
5397 | static int a, b, c; | |
5398 | int foo (void) @{ return a + b + c; @} | |
5399 | @end smallexample | |
5400 | ||
5401 | the code for @code{foo} will usually calculate three separate symbolic | |
5402 | addresses: those of @code{a}, @code{b} and @code{c}. On some targets, | |
5403 | it would be better to calculate just one symbolic address and access | |
5404 | the three variables relative to it. The equivalent pseudocode would | |
5405 | be something like: | |
5406 | ||
5407 | @smallexample | |
5408 | int foo (void) | |
5409 | @{ | |
5410 | register int *xr = &x; | |
5411 | return xr[&a - &x] + xr[&b - &x] + xr[&c - &x]; | |
5412 | @} | |
5413 | @end smallexample | |
5414 | ||
5415 | (which isn't valid C). We refer to shared addresses like @code{x} as | |
5416 | ``section anchors''. Their use is controlled by @option{-fsection-anchors}. | |
5417 | ||
5418 | The hooks below describe the target properties that GCC needs to know | |
5419 | in order to make effective use of section anchors. It won't use | |
5420 | section anchors at all unless either @code{TARGET_MIN_ANCHOR_OFFSET} | |
5421 | or @code{TARGET_MAX_ANCHOR_OFFSET} is set to a nonzero value. | |
5422 | ||
5423 | @deftypevar {Target Hook} HOST_WIDE_INT TARGET_MIN_ANCHOR_OFFSET | |
5424 | The minimum offset that should be applied to a section anchor. | |
5425 | On most targets, it should be the smallest offset that can be | |
5426 | applied to a base register while still giving a legitimate address | |
5427 | for every mode. The default value is 0. | |
5428 | @end deftypevar | |
5429 | ||
5430 | @deftypevar {Target Hook} HOST_WIDE_INT TARGET_MAX_ANCHOR_OFFSET | |
5431 | Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive) | |
5432 | offset that should be applied to section anchors. The default | |
5433 | value is 0. | |
5434 | @end deftypevar | |
5435 | ||
5436 | @deftypefn {Target Hook} void TARGET_ASM_OUTPUT_ANCHOR (rtx @var{x}) | |
5437 | Write the assembly code to define section anchor @var{x}, which is a | |
5438 | @code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true. | |
5439 | The hook is called with the assembly output position set to the beginning | |
5440 | of @code{SYMBOL_REF_BLOCK (@var{x})}. | |
5441 | ||
5442 | If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses | |
5443 | it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}. | |
5444 | If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition | |
5445 | is @code{NULL}, which disables the use of section anchors altogether. | |
5446 | @end deftypefn | |
5447 | ||
5448 | @deftypefn {Target Hook} bool TARGET_USE_ANCHORS_FOR_SYMBOL_P (rtx @var{x}) | |
5449 | Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF} | |
3fa9c136 | 5450 | @var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and |
aacd3885 RS |
5451 | @samp{!SYMBOL_REF_ANCHOR_P (@var{x})}. |
5452 | ||
5453 | The default version is correct for most targets, but you might need to | |
5454 | intercept this hook to handle things like target-specific attributes | |
5455 | or target-specific sections. | |
5456 | @end deftypefn | |
5457 | ||
feca2ed3 JW |
5458 | @node Condition Code |
5459 | @section Condition Code Status | |
5460 | @cindex condition code status | |
5461 | ||
5462 | @c prevent bad page break with this line | |
5463 | This describes the condition code status. | |
5464 | ||
5465 | @findex cc_status | |
5466 | The file @file{conditions.h} defines a variable @code{cc_status} to | |
5467 | describe how the condition code was computed (in case the interpretation of | |
5468 | the condition code depends on the instruction that it was set by). This | |
5469 | variable contains the RTL expressions on which the condition code is | |
5470 | currently based, and several standard flags. | |
5471 | ||
5472 | Sometimes additional machine-specific flags must be defined in the machine | |
5473 | description header file. It can also add additional machine-specific | |
5474 | information by defining @code{CC_STATUS_MDEP}. | |
5475 | ||
a2c4f8e0 | 5476 | @defmac CC_STATUS_MDEP |
feca2ed3 JW |
5477 | C code for a data type which is used for declaring the @code{mdep} |
5478 | component of @code{cc_status}. It defaults to @code{int}. | |
5479 | ||
5480 | This macro is not used on machines that do not use @code{cc0}. | |
a2c4f8e0 | 5481 | @end defmac |
feca2ed3 | 5482 | |
a2c4f8e0 | 5483 | @defmac CC_STATUS_MDEP_INIT |
feca2ed3 JW |
5484 | A C expression to initialize the @code{mdep} field to ``empty''. |
5485 | The default definition does nothing, since most machines don't use | |
5486 | the field anyway. If you want to use the field, you should probably | |
5487 | define this macro to initialize it. | |
5488 | ||
5489 | This macro is not used on machines that do not use @code{cc0}. | |
a2c4f8e0 | 5490 | @end defmac |
feca2ed3 | 5491 | |
a2c4f8e0 | 5492 | @defmac NOTICE_UPDATE_CC (@var{exp}, @var{insn}) |
feca2ed3 JW |
5493 | A C compound statement to set the components of @code{cc_status} |
5494 | appropriately for an insn @var{insn} whose body is @var{exp}. It is | |
5495 | this macro's responsibility to recognize insns that set the condition | |
5496 | code as a byproduct of other activity as well as those that explicitly | |
5497 | set @code{(cc0)}. | |
5498 | ||
5499 | This macro is not used on machines that do not use @code{cc0}. | |
5500 | ||
5501 | If there are insns that do not set the condition code but do alter | |
5502 | other machine registers, this macro must check to see whether they | |
5503 | invalidate the expressions that the condition code is recorded as | |
5504 | reflecting. For example, on the 68000, insns that store in address | |
5505 | registers do not set the condition code, which means that usually | |
5506 | @code{NOTICE_UPDATE_CC} can leave @code{cc_status} unaltered for such | |
5507 | insns. But suppose that the previous insn set the condition code | |
5508 | based on location @samp{a4@@(102)} and the current insn stores a new | |
5509 | value in @samp{a4}. Although the condition code is not changed by | |
5510 | this, it will no longer be true that it reflects the contents of | |
5511 | @samp{a4@@(102)}. Therefore, @code{NOTICE_UPDATE_CC} must alter | |
5512 | @code{cc_status} in this case to say that nothing is known about the | |
5513 | condition code value. | |
5514 | ||
5515 | The definition of @code{NOTICE_UPDATE_CC} must be prepared to deal | |
5516 | with the results of peephole optimization: insns whose patterns are | |
5517 | @code{parallel} RTXs containing various @code{reg}, @code{mem} or | |
5518 | constants which are just the operands. The RTL structure of these | |
5519 | insns is not sufficient to indicate what the insns actually do. What | |
5520 | @code{NOTICE_UPDATE_CC} should do when it sees one is just to run | |
5521 | @code{CC_STATUS_INIT}. | |
5522 | ||
5523 | A possible definition of @code{NOTICE_UPDATE_CC} is to call a function | |
5524 | that looks at an attribute (@pxref{Insn Attributes}) named, for example, | |
5525 | @samp{cc}. This avoids having detailed information about patterns in | |
5526 | two places, the @file{md} file and in @code{NOTICE_UPDATE_CC}. | |
a2c4f8e0 | 5527 | @end defmac |
feca2ed3 | 5528 | |
a2c4f8e0 | 5529 | @defmac SELECT_CC_MODE (@var{op}, @var{x}, @var{y}) |
feca2ed3 JW |
5530 | Returns a mode from class @code{MODE_CC} to be used when comparison |
5531 | operation code @var{op} is applied to rtx @var{x} and @var{y}. For | |
981f6289 | 5532 | example, on the SPARC, @code{SELECT_CC_MODE} is defined as (see |
feca2ed3 JW |
5533 | @pxref{Jump Patterns} for a description of the reason for this |
5534 | definition) | |
5535 | ||
5536 | @smallexample | |
5537 | #define SELECT_CC_MODE(OP,X,Y) \ | |
5538 | (GET_MODE_CLASS (GET_MODE (X)) == MODE_FLOAT \ | |
5539 | ? ((OP == EQ || OP == NE) ? CCFPmode : CCFPEmode) \ | |
5540 | : ((GET_CODE (X) == PLUS || GET_CODE (X) == MINUS \ | |
5541 | || GET_CODE (X) == NEG) \ | |
5542 | ? CC_NOOVmode : CCmode)) | |
5543 | @end smallexample | |
5544 | ||
94134f42 ZW |
5545 | You should define this macro if and only if you define extra CC modes |
5546 | in @file{@var{machine}-modes.def}. | |
a2c4f8e0 | 5547 | @end defmac |
feca2ed3 | 5548 | |
a2c4f8e0 | 5549 | @defmac CANONICALIZE_COMPARISON (@var{code}, @var{op0}, @var{op1}) |
8760eaae | 5550 | On some machines not all possible comparisons are defined, but you can |
feca2ed3 JW |
5551 | convert an invalid comparison into a valid one. For example, the Alpha |
5552 | does not have a @code{GT} comparison, but you can use an @code{LT} | |
5553 | comparison instead and swap the order of the operands. | |
5554 | ||
5555 | On such machines, define this macro to be a C statement to do any | |
5556 | required conversions. @var{code} is the initial comparison code | |
5557 | and @var{op0} and @var{op1} are the left and right operands of the | |
5558 | comparison, respectively. You should modify @var{code}, @var{op0}, and | |
5559 | @var{op1} as required. | |
5560 | ||
a3a15b4d | 5561 | GCC will not assume that the comparison resulting from this macro is |
feca2ed3 JW |
5562 | valid but will see if the resulting insn matches a pattern in the |
5563 | @file{md} file. | |
5564 | ||
5565 | You need not define this macro if it would never change the comparison | |
5566 | code or operands. | |
a2c4f8e0 | 5567 | @end defmac |
feca2ed3 | 5568 | |
a2c4f8e0 | 5569 | @defmac REVERSIBLE_CC_MODE (@var{mode}) |
feca2ed3 JW |
5570 | A C expression whose value is one if it is always safe to reverse a |
5571 | comparison whose mode is @var{mode}. If @code{SELECT_CC_MODE} | |
5572 | can ever return @var{mode} for a floating-point inequality comparison, | |
5573 | then @code{REVERSIBLE_CC_MODE (@var{mode})} must be zero. | |
5574 | ||
5575 | You need not define this macro if it would always returns zero or if the | |
5576 | floating-point format is anything other than @code{IEEE_FLOAT_FORMAT}. | |
981f6289 | 5577 | For example, here is the definition used on the SPARC, where floating-point |
feca2ed3 JW |
5578 | inequality comparisons are always given @code{CCFPEmode}: |
5579 | ||
5580 | @smallexample | |
5581 | #define REVERSIBLE_CC_MODE(MODE) ((MODE) != CCFPEmode) | |
5582 | @end smallexample | |
a2c4f8e0 | 5583 | @end defmac |
feca2ed3 | 5584 | |
a2c4f8e0 | 5585 | @defmac REVERSE_CONDITION (@var{code}, @var{mode}) |
9e7adcb3 JH |
5586 | A C expression whose value is reversed condition code of the @var{code} for |
5587 | comparison done in CC_MODE @var{mode}. The macro is used only in case | |
5588 | @code{REVERSIBLE_CC_MODE (@var{mode})} is nonzero. Define this macro in case | |
5589 | machine has some non-standard way how to reverse certain conditionals. For | |
5590 | instance in case all floating point conditions are non-trapping, compiler may | |
5591 | freely convert unordered compares to ordered one. Then definition may look | |
5592 | like: | |
5593 | ||
5594 | @smallexample | |
5595 | #define REVERSE_CONDITION(CODE, MODE) \ | |
c771326b | 5596 | ((MODE) != CCFPmode ? reverse_condition (CODE) \ |
9e7adcb3 JH |
5597 | : reverse_condition_maybe_unordered (CODE)) |
5598 | @end smallexample | |
a2c4f8e0 | 5599 | @end defmac |
9e7adcb3 | 5600 | |
15dce812 | 5601 | @defmac REVERSE_CONDEXEC_PREDICATES_P (@var{op1}, @var{op2}) |
7e6d8ba1 | 5602 | A C expression that returns true if the conditional execution predicate |
15dce812 RE |
5603 | @var{op1}, a comparison operation, is the inverse of @var{op2} and vice |
5604 | versa. Define this to return 0 if the target has conditional execution | |
5605 | predicates that cannot be reversed safely. There is no need to validate | |
5606 | that the arguments of op1 and op2 are the same, this is done separately. | |
5607 | If no expansion is specified, this macro is defined as follows: | |
7e6d8ba1 AH |
5608 | |
5609 | @smallexample | |
aee96fe9 | 5610 | #define REVERSE_CONDEXEC_PREDICATES_P (x, y) \ |
15dce812 | 5611 | (GET_CODE ((x)) == reversed_comparison_code ((y), NULL)) |
7e6d8ba1 | 5612 | @end smallexample |
a2c4f8e0 | 5613 | @end defmac |
feca2ed3 | 5614 | |
e129d93a ILT |
5615 | @deftypefn {Target Hook} bool TARGET_FIXED_CONDITION_CODE_REGS (unsigned int *, unsigned int *) |
5616 | On targets which do not use @code{(cc0)}, and which use a hard | |
5617 | register rather than a pseudo-register to hold condition codes, the | |
5618 | regular CSE passes are often not able to identify cases in which the | |
5619 | hard register is set to a common value. Use this hook to enable a | |
5620 | small pass which optimizes such cases. This hook should return true | |
5621 | to enable this pass, and it should set the integers to which its | |
5622 | arguments point to the hard register numbers used for condition codes. | |
5623 | When there is only one such register, as is true on most systems, the | |
5624 | integer pointed to by the second argument should be set to | |
5625 | @code{INVALID_REGNUM}. | |
5626 | ||
5627 | The default version of this hook returns false. | |
5628 | @end deftypefn | |
5629 | ||
5630 | @deftypefn {Target Hook} enum machine_mode TARGET_CC_MODES_COMPATIBLE (enum machine_mode, enum machine_mode) | |
5631 | On targets which use multiple condition code modes in class | |
5632 | @code{MODE_CC}, it is sometimes the case that a comparison can be | |
5633 | validly done in more than one mode. On such a system, define this | |
5634 | target hook to take two mode arguments and to return a mode in which | |
5635 | both comparisons may be validly done. If there is no such mode, | |
5636 | return @code{VOIDmode}. | |
5637 | ||
5638 | The default version of this hook checks whether the modes are the | |
5639 | same. If they are, it returns that mode. If they are different, it | |
5640 | returns @code{VOIDmode}. | |
5641 | @end deftypefn | |
5642 | ||
feca2ed3 JW |
5643 | @node Costs |
5644 | @section Describing Relative Costs of Operations | |
5645 | @cindex costs of instructions | |
5646 | @cindex relative costs | |
5647 | @cindex speed of instructions | |
5648 | ||
5649 | These macros let you describe the relative speed of various operations | |
5650 | on the target machine. | |
5651 | ||
a2c4f8e0 | 5652 | @defmac REGISTER_MOVE_COST (@var{mode}, @var{from}, @var{to}) |
e56b4594 AO |
5653 | A C expression for the cost of moving data of mode @var{mode} from a |
5654 | register in class @var{from} to one in class @var{to}. The classes are | |
5655 | expressed using the enumeration values such as @code{GENERAL_REGS}. A | |
5656 | value of 2 is the default; other values are interpreted relative to | |
5657 | that. | |
feca2ed3 JW |
5658 | |
5659 | It is not required that the cost always equal 2 when @var{from} is the | |
5660 | same as @var{to}; on some machines it is expensive to move between | |
5661 | registers if they are not general registers. | |
5662 | ||
5663 | If reload sees an insn consisting of a single @code{set} between two | |
5664 | hard registers, and if @code{REGISTER_MOVE_COST} applied to their | |
5665 | classes returns a value of 2, reload does not check to ensure that the | |
5666 | constraints of the insn are met. Setting a cost of other than 2 will | |
5667 | allow reload to verify that the constraints are met. You should do this | |
5668 | if the @samp{mov@var{m}} pattern's constraints do not allow such copying. | |
a2c4f8e0 | 5669 | @end defmac |
feca2ed3 | 5670 | |
a2c4f8e0 | 5671 | @defmac MEMORY_MOVE_COST (@var{mode}, @var{class}, @var{in}) |
cbd5b9a2 KR |
5672 | A C expression for the cost of moving data of mode @var{mode} between a |
5673 | register of class @var{class} and memory; @var{in} is zero if the value | |
df2a54e9 | 5674 | is to be written to memory, nonzero if it is to be read in. This cost |
473fe49b KR |
5675 | is relative to those in @code{REGISTER_MOVE_COST}. If moving between |
5676 | registers and memory is more expensive than between two registers, you | |
5677 | should define this macro to express the relative cost. | |
5678 | ||
a3a15b4d | 5679 | If you do not define this macro, GCC uses a default cost of 4 plus |
38e01259 | 5680 | the cost of copying via a secondary reload register, if one is |
473fe49b KR |
5681 | needed. If your machine requires a secondary reload register to copy |
5682 | between memory and a register of @var{class} but the reload mechanism is | |
5683 | more complex than copying via an intermediate, define this macro to | |
5684 | reflect the actual cost of the move. | |
5685 | ||
a3a15b4d | 5686 | GCC defines the function @code{memory_move_secondary_cost} if |
473fe49b KR |
5687 | secondary reloads are needed. It computes the costs due to copying via |
5688 | a secondary register. If your machine copies from memory using a | |
5689 | secondary register in the conventional way but the default base value of | |
5690 | 4 is not correct for your machine, define this macro to add some other | |
5691 | value to the result of that function. The arguments to that function | |
5692 | are the same as to this macro. | |
a2c4f8e0 | 5693 | @end defmac |
cbd5b9a2 | 5694 | |
a2c4f8e0 | 5695 | @defmac BRANCH_COST |
feca2ed3 JW |
5696 | A C expression for the cost of a branch instruction. A value of 1 is |
5697 | the default; other values are interpreted relative to that. | |
a2c4f8e0 | 5698 | @end defmac |
feca2ed3 JW |
5699 | |
5700 | Here are additional macros which do not specify precise relative costs, | |
a3a15b4d | 5701 | but only that certain actions are more expensive than GCC would |
feca2ed3 JW |
5702 | ordinarily expect. |
5703 | ||
a2c4f8e0 | 5704 | @defmac SLOW_BYTE_ACCESS |
feca2ed3 | 5705 | Define this macro as a C expression which is nonzero if accessing less |
e979f9e8 | 5706 | than a word of memory (i.e.@: a @code{char} or a @code{short}) is no |
feca2ed3 JW |
5707 | faster than accessing a word of memory, i.e., if such access |
5708 | require more than one instruction or if there is no difference in cost | |
5709 | between byte and (aligned) word loads. | |
5710 | ||
5711 | When this macro is not defined, the compiler will access a field by | |
5712 | finding the smallest containing object; when it is defined, a fullword | |
5713 | load will be used if alignment permits. Unless bytes accesses are | |
5714 | faster than word accesses, using word accesses is preferable since it | |
5715 | may eliminate subsequent memory access if subsequent accesses occur to | |
5716 | other fields in the same word of the structure, but to different bytes. | |
a2c4f8e0 | 5717 | @end defmac |
feca2ed3 | 5718 | |
a2c4f8e0 | 5719 | @defmac SLOW_UNALIGNED_ACCESS (@var{mode}, @var{alignment}) |
5fad8ebf DE |
5720 | Define this macro to be the value 1 if memory accesses described by the |
5721 | @var{mode} and @var{alignment} parameters have a cost many times greater | |
5722 | than aligned accesses, for example if they are emulated in a trap | |
5723 | handler. | |
feca2ed3 | 5724 | |
df2a54e9 JM |
5725 | When this macro is nonzero, the compiler will act as if |
5726 | @code{STRICT_ALIGNMENT} were nonzero when generating code for block | |
feca2ed3 | 5727 | moves. This can cause significantly more instructions to be produced. |
df2a54e9 | 5728 | Therefore, do not set this macro nonzero if unaligned accesses only add a |
feca2ed3 JW |
5729 | cycle or two to the time for a memory access. |
5730 | ||
6be57663 | 5731 | If the value of this macro is always zero, it need not be defined. If |
df2a54e9 JM |
5732 | this macro is defined, it should produce a nonzero value when |
5733 | @code{STRICT_ALIGNMENT} is nonzero. | |
a2c4f8e0 | 5734 | @end defmac |
feca2ed3 | 5735 | |
a2c4f8e0 | 5736 | @defmac MOVE_RATIO |
9862dea9 | 5737 | The threshold of number of scalar memory-to-memory move insns, @emph{below} |
c5c76735 | 5738 | which a sequence of insns should be generated instead of a |
feca2ed3 JW |
5739 | string move insn or a library call. Increasing the value will always |
5740 | make code faster, but eventually incurs high cost in increased code size. | |
5741 | ||
c5c76735 JL |
5742 | Note that on machines where the corresponding move insn is a |
5743 | @code{define_expand} that emits a sequence of insns, this macro counts | |
5744 | the number of such sequences. | |
9862dea9 | 5745 | |
feca2ed3 | 5746 | If you don't define this, a reasonable default is used. |
a2c4f8e0 | 5747 | @end defmac |
feca2ed3 | 5748 | |
a2c4f8e0 | 5749 | @defmac MOVE_BY_PIECES_P (@var{size}, @var{alignment}) |
fbe1758d AM |
5750 | A C expression used to determine whether @code{move_by_pieces} will be used to |
5751 | copy a chunk of memory, or whether some other block move mechanism | |
6e01bd94 | 5752 | will be used. Defaults to 1 if @code{move_by_pieces_ninsns} returns less |
fbe1758d | 5753 | than @code{MOVE_RATIO}. |
a2c4f8e0 | 5754 | @end defmac |
fbe1758d | 5755 | |
a2c4f8e0 | 5756 | @defmac MOVE_MAX_PIECES |
fbe1758d | 5757 | A C expression used by @code{move_by_pieces} to determine the largest unit |
6e01bd94 | 5758 | a load or store used to copy memory is. Defaults to @code{MOVE_MAX}. |
a2c4f8e0 | 5759 | @end defmac |
fbe1758d | 5760 | |
a2c4f8e0 | 5761 | @defmac CLEAR_RATIO |
78762e3b RS |
5762 | The threshold of number of scalar move insns, @emph{below} which a sequence |
5763 | of insns should be generated to clear memory instead of a string clear insn | |
5764 | or a library call. Increasing the value will always make code faster, but | |
5765 | eventually incurs high cost in increased code size. | |
5766 | ||
5767 | If you don't define this, a reasonable default is used. | |
a2c4f8e0 | 5768 | @end defmac |
78762e3b | 5769 | |
a2c4f8e0 | 5770 | @defmac CLEAR_BY_PIECES_P (@var{size}, @var{alignment}) |
78762e3b RS |
5771 | A C expression used to determine whether @code{clear_by_pieces} will be used |
5772 | to clear a chunk of memory, or whether some other block clear mechanism | |
5773 | will be used. Defaults to 1 if @code{move_by_pieces_ninsns} returns less | |
5774 | than @code{CLEAR_RATIO}. | |
a2c4f8e0 | 5775 | @end defmac |
78762e3b | 5776 | |
a2c4f8e0 | 5777 | @defmac STORE_BY_PIECES_P (@var{size}, @var{alignment}) |
4977bab6 ZW |
5778 | A C expression used to determine whether @code{store_by_pieces} will be |
5779 | used to set a chunk of memory to a constant value, or whether some other | |
5780 | mechanism will be used. Used by @code{__builtin_memset} when storing | |
5781 | values other than constant zero and by @code{__builtin_strcpy} when | |
5782 | when called with a constant source string. | |
0bdcd332 | 5783 | Defaults to 1 if @code{move_by_pieces_ninsns} returns less |
45d78e7f | 5784 | than @code{MOVE_RATIO}. |
a2c4f8e0 | 5785 | @end defmac |
4977bab6 | 5786 | |
a2c4f8e0 | 5787 | @defmac USE_LOAD_POST_INCREMENT (@var{mode}) |
6e01bd94 MH |
5788 | A C expression used to determine whether a load postincrement is a good |
5789 | thing to use for a given mode. Defaults to the value of | |
5790 | @code{HAVE_POST_INCREMENT}. | |
a2c4f8e0 | 5791 | @end defmac |
6e01bd94 | 5792 | |
a2c4f8e0 | 5793 | @defmac USE_LOAD_POST_DECREMENT (@var{mode}) |
6e01bd94 MH |
5794 | A C expression used to determine whether a load postdecrement is a good |
5795 | thing to use for a given mode. Defaults to the value of | |
5796 | @code{HAVE_POST_DECREMENT}. | |
a2c4f8e0 | 5797 | @end defmac |
fbe1758d | 5798 | |
a2c4f8e0 | 5799 | @defmac USE_LOAD_PRE_INCREMENT (@var{mode}) |
6e01bd94 MH |
5800 | A C expression used to determine whether a load preincrement is a good |
5801 | thing to use for a given mode. Defaults to the value of | |
5802 | @code{HAVE_PRE_INCREMENT}. | |
a2c4f8e0 | 5803 | @end defmac |
6e01bd94 | 5804 | |
a2c4f8e0 | 5805 | @defmac USE_LOAD_PRE_DECREMENT (@var{mode}) |
6e01bd94 MH |
5806 | A C expression used to determine whether a load predecrement is a good |
5807 | thing to use for a given mode. Defaults to the value of | |
5808 | @code{HAVE_PRE_DECREMENT}. | |
a2c4f8e0 | 5809 | @end defmac |
fbe1758d | 5810 | |
a2c4f8e0 | 5811 | @defmac USE_STORE_POST_INCREMENT (@var{mode}) |
6e01bd94 MH |
5812 | A C expression used to determine whether a store postincrement is a good |
5813 | thing to use for a given mode. Defaults to the value of | |
5814 | @code{HAVE_POST_INCREMENT}. | |
a2c4f8e0 | 5815 | @end defmac |
6e01bd94 | 5816 | |
a2c4f8e0 | 5817 | @defmac USE_STORE_POST_DECREMENT (@var{mode}) |
c771326b | 5818 | A C expression used to determine whether a store postdecrement is a good |
6e01bd94 MH |
5819 | thing to use for a given mode. Defaults to the value of |
5820 | @code{HAVE_POST_DECREMENT}. | |
a2c4f8e0 | 5821 | @end defmac |
fbe1758d | 5822 | |
a2c4f8e0 | 5823 | @defmac USE_STORE_PRE_INCREMENT (@var{mode}) |
6e01bd94 MH |
5824 | This macro is used to determine whether a store preincrement is a good |
5825 | thing to use for a given mode. Defaults to the value of | |
5826 | @code{HAVE_PRE_INCREMENT}. | |
a2c4f8e0 | 5827 | @end defmac |
6e01bd94 | 5828 | |
a2c4f8e0 | 5829 | @defmac USE_STORE_PRE_DECREMENT (@var{mode}) |
6e01bd94 MH |
5830 | This macro is used to determine whether a store predecrement is a good |
5831 | thing to use for a given mode. Defaults to the value of | |
5832 | @code{HAVE_PRE_DECREMENT}. | |
a2c4f8e0 | 5833 | @end defmac |
fbe1758d | 5834 | |
a2c4f8e0 | 5835 | @defmac NO_FUNCTION_CSE |
feca2ed3 JW |
5836 | Define this macro if it is as good or better to call a constant |
5837 | function address than to call an address kept in a register. | |
a2c4f8e0 | 5838 | @end defmac |
feca2ed3 | 5839 | |
a2c4f8e0 | 5840 | @defmac RANGE_TEST_NON_SHORT_CIRCUIT |
85e50b6b DE |
5841 | Define this macro if a non-short-circuit operation produced by |
5842 | @samp{fold_range_test ()} is optimal. This macro defaults to true if | |
5843 | @code{BRANCH_COST} is greater than or equal to the value 2. | |
a2c4f8e0 | 5844 | @end defmac |
feca2ed3 | 5845 | |
3c50106f RH |
5846 | @deftypefn {Target Hook} bool TARGET_RTX_COSTS (rtx @var{x}, int @var{code}, int @var{outer_code}, int *@var{total}) |
5847 | This target hook describes the relative costs of RTL expressions. | |
5848 | ||
5849 | The cost may depend on the precise form of the expression, which is | |
5850 | available for examination in @var{x}, and the rtx code of the expression | |
5851 | in which it is contained, found in @var{outer_code}. @var{code} is the | |
5852 | expression code---redundant, since it can be obtained with | |
5853 | @code{GET_CODE (@var{x})}. | |
5854 | ||
5855 | In implementing this hook, you can use the construct | |
5856 | @code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast | |
5857 | instructions. | |
5858 | ||
5859 | On entry to the hook, @code{*@var{total}} contains a default estimate | |
5860 | for the cost of the expression. The hook should modify this value as | |
31a52b86 RS |
5861 | necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)} |
5862 | for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus | |
5863 | operations, and @code{COSTS_N_INSNS (1)} for all other operations. | |
5864 | ||
8a36672b | 5865 | When optimizing for code size, i.e.@: when @code{optimize_size} is |
1a141fe1 | 5866 | nonzero, this target hook should be used to estimate the relative |
31a52b86 | 5867 | size cost of an expression, again relative to @code{COSTS_N_INSNS}. |
3c50106f RH |
5868 | |
5869 | The hook returns true when all subexpressions of @var{x} have been | |
5870 | processed, and false when @code{rtx_cost} should recurse. | |
5871 | @end deftypefn | |
5872 | ||
10154ff8 RH |
5873 | @deftypefn {Target Hook} int TARGET_ADDRESS_COST (rtx @var{address}) |
5874 | This hook computes the cost of an addressing mode that contains | |
5875 | @var{address}. If not defined, the cost is computed from | |
5876 | the @var{address} expression and the @code{TARGET_RTX_COST} hook. | |
5877 | ||
5878 | For most CISC machines, the default cost is a good approximation of the | |
5879 | true cost of the addressing mode. However, on RISC machines, all | |
5880 | instructions normally have the same length and execution time. Hence | |
5881 | all addresses will have equal costs. | |
5882 | ||
5883 | In cases where more than one form of an address is known, the form with | |
5884 | the lowest cost will be used. If multiple forms have the same, lowest, | |
5885 | cost, the one that is the most complex will be used. | |
5886 | ||
5887 | For example, suppose an address that is equal to the sum of a register | |
5888 | and a constant is used twice in the same basic block. When this macro | |
5889 | is not defined, the address will be computed in a register and memory | |
5890 | references will be indirect through that register. On machines where | |
5891 | the cost of the addressing mode containing the sum is no higher than | |
5892 | that of a simple indirect reference, this will produce an additional | |
5893 | instruction and possibly require an additional register. Proper | |
5894 | specification of this macro eliminates this overhead for such machines. | |
5895 | ||
5896 | This hook is never called with an invalid address. | |
5897 | ||
5898 | On machines where an address involving more than one register is as | |
5899 | cheap as an address computation involving only one register, defining | |
5900 | @code{TARGET_ADDRESS_COST} to reflect this can cause two registers to | |
5901 | be live over a region of code where only one would have been if | |
5902 | @code{TARGET_ADDRESS_COST} were not defined in that manner. This effect | |
5903 | should be considered in the definition of this macro. Equivalent costs | |
5904 | should probably only be given to addresses with different numbers of | |
5905 | registers on machines with lots of registers. | |
5906 | @end deftypefn | |
5907 | ||
c237e94a ZW |
5908 | @node Scheduling |
5909 | @section Adjusting the Instruction Scheduler | |
5910 | ||
5911 | The instruction scheduler may need a fair amount of machine-specific | |
5912 | adjustment in order to produce good code. GCC provides several target | |
5913 | hooks for this purpose. It is usually enough to define just a few of | |
5914 | them: try the first ones in this list first. | |
5915 | ||
5916 | @deftypefn {Target Hook} int TARGET_SCHED_ISSUE_RATE (void) | |
fae15c93 VM |
5917 | This hook returns the maximum number of instructions that can ever |
5918 | issue at the same time on the target machine. The default is one. | |
5919 | Although the insn scheduler can define itself the possibility of issue | |
5920 | an insn on the same cycle, the value can serve as an additional | |
5921 | constraint to issue insns on the same simulated processor cycle (see | |
5922 | hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}). | |
5923 | This value must be constant over the entire compilation. If you need | |
5924 | it to vary depending on what the instructions are, you must use | |
c237e94a ZW |
5925 | @samp{TARGET_SCHED_VARIABLE_ISSUE}. |
5926 | @end deftypefn | |
5927 | ||
5928 | @deftypefn {Target Hook} int TARGET_SCHED_VARIABLE_ISSUE (FILE *@var{file}, int @var{verbose}, rtx @var{insn}, int @var{more}) | |
5929 | This hook is executed by the scheduler after it has scheduled an insn | |
5930 | from the ready list. It should return the number of insns which can | |
3ee04299 DE |
5931 | still be issued in the current cycle. The default is |
5932 | @samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and | |
5933 | @code{USE}, which normally are not counted against the issue rate. | |
5934 | You should define this hook if some insns take more machine resources | |
5935 | than others, so that fewer insns can follow them in the same cycle. | |
5936 | @var{file} is either a null pointer, or a stdio stream to write any | |
5937 | debug output to. @var{verbose} is the verbose level provided by | |
5938 | @option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that | |
5939 | was scheduled. | |
c237e94a ZW |
5940 | @end deftypefn |
5941 | ||
5942 | @deftypefn {Target Hook} int TARGET_SCHED_ADJUST_COST (rtx @var{insn}, rtx @var{link}, rtx @var{dep_insn}, int @var{cost}) | |
fae15c93 VM |
5943 | This function corrects the value of @var{cost} based on the |
5944 | relationship between @var{insn} and @var{dep_insn} through the | |
5945 | dependence @var{link}. It should return the new value. The default | |
5946 | is to make no adjustment to @var{cost}. This can be used for example | |
5947 | to specify to the scheduler using the traditional pipeline description | |
c237e94a | 5948 | that an output- or anti-dependence does not incur the same cost as a |
fae15c93 VM |
5949 | data-dependence. If the scheduler using the automaton based pipeline |
5950 | description, the cost of anti-dependence is zero and the cost of | |
5951 | output-dependence is maximum of one and the difference of latency | |
5952 | times of the first and the second insns. If these values are not | |
5953 | acceptable, you could use the hook to modify them too. See also | |
fa0aee89 | 5954 | @pxref{Processor pipeline description}. |
c237e94a ZW |
5955 | @end deftypefn |
5956 | ||
5957 | @deftypefn {Target Hook} int TARGET_SCHED_ADJUST_PRIORITY (rtx @var{insn}, int @var{priority}) | |
5958 | This hook adjusts the integer scheduling priority @var{priority} of | |
496d7bb0 MK |
5959 | @var{insn}. It should return the new priority. Increase the priority to |
5960 | execute @var{insn} earlier, reduce the priority to execute @var{insn} | |
c237e94a ZW |
5961 | later. Do not define this hook if you do not need to adjust the |
5962 | scheduling priorities of insns. | |
5963 | @end deftypefn | |
5964 | ||
5965 | @deftypefn {Target Hook} int TARGET_SCHED_REORDER (FILE *@var{file}, int @var{verbose}, rtx *@var{ready}, int *@var{n_readyp}, int @var{clock}) | |
5966 | This hook is executed by the scheduler after it has scheduled the ready | |
5967 | list, to allow the machine description to reorder it (for example to | |
5968 | combine two small instructions together on @samp{VLIW} machines). | |
5969 | @var{file} is either a null pointer, or a stdio stream to write any | |
5970 | debug output to. @var{verbose} is the verbose level provided by | |
5971 | @option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready | |
5972 | list of instructions that are ready to be scheduled. @var{n_readyp} is | |
5973 | a pointer to the number of elements in the ready list. The scheduler | |
5974 | reads the ready list in reverse order, starting with | |
5975 | @var{ready}[@var{*n_readyp}-1] and going to @var{ready}[0]. @var{clock} | |
5976 | is the timer tick of the scheduler. You may modify the ready list and | |
5977 | the number of ready insns. The return value is the number of insns that | |
5978 | can issue this cycle; normally this is just @code{issue_rate}. See also | |
5979 | @samp{TARGET_SCHED_REORDER2}. | |
5980 | @end deftypefn | |
5981 | ||
5982 | @deftypefn {Target Hook} int TARGET_SCHED_REORDER2 (FILE *@var{file}, int @var{verbose}, rtx *@var{ready}, int *@var{n_ready}, @var{clock}) | |
5983 | Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That | |
5984 | function is called whenever the scheduler starts a new cycle. This one | |
5985 | is called once per iteration over a cycle, immediately after | |
5986 | @samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and | |
5987 | return the number of insns to be scheduled in the same cycle. Defining | |
5988 | this hook can be useful if there are frequent situations where | |
5989 | scheduling one insn causes other insns to become ready in the same | |
5990 | cycle. These other insns can then be taken into account properly. | |
5991 | @end deftypefn | |
5992 | ||
30028c85 VM |
5993 | @deftypefn {Target Hook} void TARGET_SCHED_DEPENDENCIES_EVALUATION_HOOK (rtx @var{head}, rtx @var{tail}) |
5994 | This hook is called after evaluation forward dependencies of insns in | |
5995 | chain given by two parameter values (@var{head} and @var{tail} | |
5996 | correspondingly) but before insns scheduling of the insn chain. For | |
5997 | example, it can be used for better insn classification if it requires | |
5998 | analysis of dependencies. This hook can use backward and forward | |
5999 | dependencies of the insn scheduler because they are already | |
6000 | calculated. | |
6001 | @end deftypefn | |
6002 | ||
c237e94a ZW |
6003 | @deftypefn {Target Hook} void TARGET_SCHED_INIT (FILE *@var{file}, int @var{verbose}, int @var{max_ready}) |
6004 | This hook is executed by the scheduler at the beginning of each block of | |
6005 | instructions that are to be scheduled. @var{file} is either a null | |
6006 | pointer, or a stdio stream to write any debug output to. @var{verbose} | |
6007 | is the verbose level provided by @option{-fsched-verbose-@var{n}}. | |
6008 | @var{max_ready} is the maximum number of insns in the current scheduling | |
6009 | region that can be live at the same time. This can be used to allocate | |
431ae0bf | 6010 | scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}. |
c237e94a ZW |
6011 | @end deftypefn |
6012 | ||
6013 | @deftypefn {Target Hook} void TARGET_SCHED_FINISH (FILE *@var{file}, int @var{verbose}) | |
6014 | This hook is executed by the scheduler at the end of each block of | |
6015 | instructions that are to be scheduled. It can be used to perform | |
6016 | cleanup of any actions done by the other scheduling hooks. @var{file} | |
6017 | is either a null pointer, or a stdio stream to write any debug output | |
6018 | to. @var{verbose} is the verbose level provided by | |
6019 | @option{-fsched-verbose-@var{n}}. | |
6020 | @end deftypefn | |
6021 | ||
58565a33 SKG |
6022 | @deftypefn {Target Hook} void TARGET_SCHED_INIT_GLOBAL (FILE *@var{file}, int @var{verbose}, int @var{old_max_uid}) |
6023 | This hook is executed by the scheduler after function level initializations. | |
6024 | @var{file} is either a null pointer, or a stdio stream to write any debug output to. | |
6025 | @var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}. | |
6026 | @var{old_max_uid} is the maximum insn uid when scheduling begins. | |
6027 | @end deftypefn | |
6028 | ||
6029 | @deftypefn {Target Hook} void TARGET_SCHED_FINISH_GLOBAL (FILE *@var{file}, int @var{verbose}) | |
8a36672b | 6030 | This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}. |
58565a33 SKG |
6031 | @var{file} is either a null pointer, or a stdio stream to write any debug output to. |
6032 | @var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}. | |
6033 | @end deftypefn | |
6034 | ||
fae15c93 VM |
6035 | @deftypefn {Target Hook} int TARGET_SCHED_DFA_PRE_CYCLE_INSN (void) |
6036 | The hook returns an RTL insn. The automaton state used in the | |
6037 | pipeline hazard recognizer is changed as if the insn were scheduled | |
6038 | when the new simulated processor cycle starts. Usage of the hook may | |
6039 | simplify the automaton pipeline description for some @acronym{VLIW} | |
6040 | processors. If the hook is defined, it is used only for the automaton | |
6041 | based pipeline description. The default is not to change the state | |
6042 | when the new simulated processor cycle starts. | |
6043 | @end deftypefn | |
6044 | ||
6045 | @deftypefn {Target Hook} void TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN (void) | |
6046 | The hook can be used to initialize data used by the previous hook. | |
6047 | @end deftypefn | |
6048 | ||
6049 | @deftypefn {Target Hook} int TARGET_SCHED_DFA_POST_CYCLE_INSN (void) | |
6050 | The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used | |
6051 | to changed the state as if the insn were scheduled when the new | |
6052 | simulated processor cycle finishes. | |
6053 | @end deftypefn | |
6054 | ||
6055 | @deftypefn {Target Hook} void TARGET_SCHED_INIT_DFA_POST_CYCLE_INSN (void) | |
6056 | The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but | |
6057 | used to initialize data used by the previous hook. | |
6058 | @end deftypefn | |
6059 | ||
6060 | @deftypefn {Target Hook} int TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD (void) | |
6061 | This hook controls better choosing an insn from the ready insn queue | |
6062 | for the @acronym{DFA}-based insn scheduler. Usually the scheduler | |
6063 | chooses the first insn from the queue. If the hook returns a positive | |
6064 | value, an additional scheduler code tries all permutations of | |
6065 | @samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()} | |
6066 | subsequent ready insns to choose an insn whose issue will result in | |
6067 | maximal number of issued insns on the same cycle. For the | |
6068 | @acronym{VLIW} processor, the code could actually solve the problem of | |
6069 | packing simple insns into the @acronym{VLIW} insn. Of course, if the | |
6070 | rules of @acronym{VLIW} packing are described in the automaton. | |
6071 | ||
6072 | This code also could be used for superscalar @acronym{RISC} | |
6073 | processors. Let us consider a superscalar @acronym{RISC} processor | |
6074 | with 3 pipelines. Some insns can be executed in pipelines @var{A} or | |
6075 | @var{B}, some insns can be executed only in pipelines @var{B} or | |
6076 | @var{C}, and one insn can be executed in pipeline @var{B}. The | |
6077 | processor may issue the 1st insn into @var{A} and the 2nd one into | |
6078 | @var{B}. In this case, the 3rd insn will wait for freeing @var{B} | |
6079 | until the next cycle. If the scheduler issues the 3rd insn the first, | |
6080 | the processor could issue all 3 insns per cycle. | |
6081 | ||
6082 | Actually this code demonstrates advantages of the automaton based | |
6083 | pipeline hazard recognizer. We try quickly and easy many insn | |
6084 | schedules to choose the best one. | |
6085 | ||
6086 | The default is no multipass scheduling. | |
6087 | @end deftypefn | |
6088 | ||
30028c85 VM |
6089 | @deftypefn {Target Hook} int TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD (rtx) |
6090 | ||
6091 | This hook controls what insns from the ready insn queue will be | |
6092 | considered for the multipass insn scheduling. If the hook returns | |
6093 | zero for insn passed as the parameter, the insn will be not chosen to | |
6094 | be issued. | |
6095 | ||
62b9c42c | 6096 | The default is that any ready insns can be chosen to be issued. |
30028c85 VM |
6097 | @end deftypefn |
6098 | ||
6099 | @deftypefn {Target Hook} int TARGET_SCHED_DFA_NEW_CYCLE (FILE *, int, rtx, int, int, int *) | |
6100 | ||
6101 | This hook is called by the insn scheduler before issuing insn passed | |
6102 | as the third parameter on given cycle. If the hook returns nonzero, | |
6103 | the insn is not issued on given processors cycle. Instead of that, | |
6104 | the processor cycle is advanced. If the value passed through the last | |
6105 | parameter is zero, the insn ready queue is not sorted on the new cycle | |
6106 | start as usually. The first parameter passes file for debugging | |
6107 | output. The second one passes the scheduler verbose level of the | |
6108 | debugging output. The forth and the fifth parameter values are | |
6109 | correspondingly processor cycle on which the previous insn has been | |
6110 | issued and the current processor cycle. | |
6111 | @end deftypefn | |
6112 | ||
1b2c3767 | 6113 | @deftypefn {Target Hook} bool TARGET_SCHED_IS_COSTLY_DEPENDENCE (rtx @var{insn1}, rtx @var{insn2}, rtx @var{dep_link}, int @var{dep_cost}, int @var{distance}) |
569fa502 | 6114 | This hook is used to define which dependences are considered costly by |
daf2f129 | 6115 | the target, so costly that it is not advisable to schedule the insns that |
569fa502 | 6116 | are involved in the dependence too close to one another. The parameters |
daf2f129 JM |
6117 | to this hook are as follows: The second parameter @var{insn2} is dependent |
6118 | upon the first parameter @var{insn1}. The dependence between @var{insn1} | |
6119 | and @var{insn2} is represented by the third parameter @var{dep_link}. The | |
6120 | fourth parameter @var{cost} is the cost of the dependence, and the fifth | |
6121 | parameter @var{distance} is the distance in cycles between the two insns. | |
569fa502 DN |
6122 | The hook returns @code{true} if considering the distance between the two |
6123 | insns the dependence between them is considered costly by the target, | |
6124 | and @code{false} otherwise. | |
6125 | ||
6126 | Defining this hook can be useful in multiple-issue out-of-order machines, | |
daf2f129 | 6127 | where (a) it's practically hopeless to predict the actual data/resource |
569fa502 | 6128 | delays, however: (b) there's a better chance to predict the actual grouping |
daf2f129 | 6129 | that will be formed, and (c) correctly emulating the grouping can be very |
569fa502 | 6130 | important. In such targets one may want to allow issuing dependent insns |
78466c0e | 6131 | closer to one another---i.e., closer than the dependence distance; however, |
569fa502 DN |
6132 | not in cases of "costly dependences", which this hooks allows to define. |
6133 | @end deftypefn | |
6134 | ||
496d7bb0 MK |
6135 | @deftypefn {Target Hook} int TARGET_SCHED_ADJUST_COST_2 (rtx @var{insn}, int @var{dep_type}, rtx @var{dep_insn}, int @var{cost}) |
6136 | This hook is a modified version of @samp{TARGET_SCHED_ADJUST_COST}. Instead | |
6137 | of passing dependence as a second parameter, it passes a type of that | |
6138 | dependence. This is useful to calculate cost of dependence between insns | |
6139 | not having the corresponding link. If @samp{TARGET_SCHED_ADJUST_COST_2} is | |
917f1b7e | 6140 | defined it is used instead of @samp{TARGET_SCHED_ADJUST_COST}. |
496d7bb0 MK |
6141 | @end deftypefn |
6142 | ||
6143 | @deftypefn {Target Hook} void TARGET_SCHED_H_I_D_EXTENDED (void) | |
6144 | This hook is called by the insn scheduler after emitting a new instruction to | |
6145 | the instruction stream. The hook notifies a target backend to extend its | |
6146 | per instruction data structures. | |
6147 | @end deftypefn | |
6148 | ||
6149 | @deftypefn {Target Hook} int TARGET_SCHED_SPECULATE_INSN (rtx @var{insn}, int @var{request}, rtx *@var{new_pat}) | |
64ee9490 EC |
6150 | This hook is called by the insn scheduler when @var{insn} has only |
6151 | speculative dependencies and therefore can be scheduled speculatively. | |
6152 | The hook is used to check if the pattern of @var{insn} has a speculative | |
6153 | version and, in case of successful check, to generate that speculative | |
6154 | pattern. The hook should return 1, if the instruction has a speculative form, | |
6155 | or -1, if it doesn't. @var{request} describes the type of requested | |
496d7bb0 MK |
6156 | speculation. If the return value equals 1 then @var{new_pat} is assigned |
6157 | the generated speculative pattern. | |
6158 | @end deftypefn | |
6159 | ||
6160 | @deftypefn {Target Hook} int TARGET_SCHED_NEEDS_BLOCK_P (rtx @var{insn}) | |
6161 | This hook is called by the insn scheduler during generation of recovery code | |
917f1b7e | 6162 | for @var{insn}. It should return nonzero, if the corresponding check |
496d7bb0 MK |
6163 | instruction should branch to recovery code, or zero otherwise. |
6164 | @end deftypefn | |
6165 | ||
6166 | @deftypefn {Target Hook} rtx TARGET_SCHED_GEN_CHECK (rtx @var{insn}, rtx @var{label}, int @var{mutate_p}) | |
6167 | This hook is called by the insn scheduler to generate a pattern for recovery | |
64ee9490 EC |
6168 | check instruction. If @var{mutate_p} is zero, then @var{insn} is a |
6169 | speculative instruction for which the check should be generated. | |
6170 | @var{label} is either a label of a basic block, where recovery code should | |
6171 | be emitted, or a null pointer, when requested check doesn't branch to | |
6172 | recovery code (a simple check). If @var{mutate_p} is nonzero, then | |
6173 | a pattern for a branchy check corresponding to a simple check denoted by | |
496d7bb0 MK |
6174 | @var{insn} should be generated. In this case @var{label} can't be null. |
6175 | @end deftypefn | |
6176 | ||
6177 | @deftypefn {Target Hook} int TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD_SPEC (rtx @var{insn}) | |
6178 | This hook is used as a workaround for | |
6179 | @samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD} not being | |
6180 | called on the first instruction of the ready list. The hook is used to | |
6181 | discard speculative instruction that stand first in the ready list from | |
64ee9490 | 6182 | being scheduled on the current cycle. For non-speculative instructions, |
917f1b7e | 6183 | the hook should always return nonzero. For example, in the ia64 backend |
496d7bb0 MK |
6184 | the hook is used to cancel data speculative insns when the ALAT table |
6185 | is nearly full. | |
6186 | @end deftypefn | |
6187 | ||
6188 | @deftypefn {Target Hook} void TARGET_SCHED_SET_SCHED_FLAGS (unsigned int *@var{flags}, spec_info_t @var{spec_info}) | |
64ee9490 | 6189 | This hook is used by the insn scheduler to find out what features should be |
496d7bb0 | 6190 | enabled/used. @var{flags} initially may have either the SCHED_RGN or SCHED_EBB |
64ee9490 | 6191 | bit set. This denotes the scheduler pass for which the data should be |
496d7bb0 | 6192 | provided. The target backend should modify @var{flags} by modifying |
917f1b7e | 6193 | the bits corresponding to the following features: USE_DEPS_LIST, USE_GLAT, |
64ee9490 EC |
6194 | DETACH_LIFE_INFO, and DO_SPECULATION. For the DO_SPECULATION feature |
6195 | an additional structure @var{spec_info} should be filled by the target. | |
496d7bb0 MK |
6196 | The structure describes speculation types that can be used in the scheduler. |
6197 | @end deftypefn | |
6198 | ||
feca2ed3 JW |
6199 | @node Sections |
6200 | @section Dividing the Output into Sections (Texts, Data, @dots{}) | |
6201 | @c the above section title is WAY too long. maybe cut the part between | |
6202 | @c the (...)? --mew 10feb93 | |
6203 | ||
6204 | An object file is divided into sections containing different types of | |
6205 | data. In the most common case, there are three sections: the @dfn{text | |
6206 | section}, which holds instructions and read-only data; the @dfn{data | |
6207 | section}, which holds initialized writable data; and the @dfn{bss | |
6208 | section}, which holds uninitialized data. Some systems have other kinds | |
6209 | of sections. | |
6210 | ||
d6b5193b RS |
6211 | @file{varasm.c} provides several well-known sections, such as |
6212 | @code{text_section}, @code{data_section} and @code{bss_section}. | |
6213 | The normal way of controlling a @code{@var{foo}_section} variable | |
6214 | is to define the associated @code{@var{FOO}_SECTION_ASM_OP} macro, | |
6215 | as described below. The macros are only read once, when @file{varasm.c} | |
6216 | initializes itself, so their values must be run-time constants. | |
6217 | They may however depend on command-line flags. | |
6218 | ||
6219 | @emph{Note:} Some run-time files, such @file{crtstuff.c}, also make | |
6220 | use of the @code{@var{FOO}_SECTION_ASM_OP} macros, and expect them | |
6221 | to be string literals. | |
6222 | ||
6223 | Some assemblers require a different string to be written every time a | |
6224 | section is selected. If your assembler falls into this category, you | |
6225 | should define the @code{TARGET_ASM_INIT_SECTIONS} hook and use | |
6226 | @code{get_unnamed_section} to set up the sections. | |
6227 | ||
6228 | You must always create a @code{text_section}, either by defining | |
6229 | @code{TEXT_SECTION_ASM_OP} or by initializing @code{text_section} | |
6230 | in @code{TARGET_ASM_INIT_SECTIONS}. The same is true of | |
6231 | @code{data_section} and @code{DATA_SECTION_ASM_OP}. If you do not | |
6232 | create a distinct @code{readonly_data_section}, the default is to | |
6233 | reuse @code{text_section}. | |
6234 | ||
6235 | All the other @file{varasm.c} sections are optional, and are null | |
6236 | if the target does not provide them. | |
feca2ed3 | 6237 | |
a2c4f8e0 | 6238 | @defmac TEXT_SECTION_ASM_OP |
047c1c92 HPN |
6239 | A C expression whose value is a string, including spacing, containing the |
6240 | assembler operation that should precede instructions and read-only data. | |
6241 | Normally @code{"\t.text"} is right. | |
a2c4f8e0 | 6242 | @end defmac |
33c09f2f | 6243 | |
a2c4f8e0 | 6244 | @defmac HOT_TEXT_SECTION_NAME |
194734e9 JH |
6245 | If defined, a C string constant for the name of the section containing most |
6246 | frequently executed functions of the program. If not defined, GCC will provide | |
6247 | a default definition if the target supports named sections. | |
a2c4f8e0 | 6248 | @end defmac |
194734e9 | 6249 | |
a2c4f8e0 | 6250 | @defmac UNLIKELY_EXECUTED_TEXT_SECTION_NAME |
194734e9 JH |
6251 | If defined, a C string constant for the name of the section containing unlikely |
6252 | executed functions in the program. | |
a2c4f8e0 | 6253 | @end defmac |
194734e9 | 6254 | |
a2c4f8e0 | 6255 | @defmac DATA_SECTION_ASM_OP |
047c1c92 HPN |
6256 | A C expression whose value is a string, including spacing, containing the |
6257 | assembler operation to identify the following data as writable initialized | |
6258 | data. Normally @code{"\t.data"} is right. | |
a2c4f8e0 | 6259 | @end defmac |
feca2ed3 | 6260 | |
d6b5193b RS |
6261 | @defmac SDATA_SECTION_ASM_OP |
6262 | If defined, a C expression whose value is a string, including spacing, | |
6263 | containing the assembler operation to identify the following data as | |
6264 | initialized, writable small data. | |
6265 | @end defmac | |
6266 | ||
a2c4f8e0 | 6267 | @defmac READONLY_DATA_SECTION_ASM_OP |
d48bc59a RH |
6268 | A C expression whose value is a string, including spacing, containing the |
6269 | assembler operation to identify the following data as read-only initialized | |
6270 | data. | |
a2c4f8e0 | 6271 | @end defmac |
d48bc59a | 6272 | |
a2c4f8e0 | 6273 | @defmac BSS_SECTION_ASM_OP |
047c1c92 HPN |
6274 | If defined, a C expression whose value is a string, including spacing, |
6275 | containing the assembler operation to identify the following data as | |
6276 | uninitialized global data. If not defined, and neither | |
6277 | @code{ASM_OUTPUT_BSS} nor @code{ASM_OUTPUT_ALIGNED_BSS} are defined, | |
6278 | uninitialized global data will be output in the data section if | |
630d3d5a | 6279 | @option{-fno-common} is passed, otherwise @code{ASM_OUTPUT_COMMON} will be |
047c1c92 | 6280 | used. |
a2c4f8e0 | 6281 | @end defmac |
feca2ed3 | 6282 | |
d6b5193b RS |
6283 | @defmac SBSS_SECTION_ASM_OP |
6284 | If defined, a C expression whose value is a string, including spacing, | |
6285 | containing the assembler operation to identify the following data as | |
6286 | uninitialized, writable small data. | |
6287 | @end defmac | |
6288 | ||
a2c4f8e0 | 6289 | @defmac INIT_SECTION_ASM_OP |
047c1c92 HPN |
6290 | If defined, a C expression whose value is a string, including spacing, |
6291 | containing the assembler operation to identify the following data as | |
6292 | initialization code. If not defined, GCC will assume such a section does | |
98bfa2fb RS |
6293 | not exist. This section has no corresponding @code{init_section} |
6294 | variable; it is used entirely in runtime code. | |
a2c4f8e0 | 6295 | @end defmac |
feca2ed3 | 6296 | |
a2c4f8e0 | 6297 | @defmac FINI_SECTION_ASM_OP |
047c1c92 HPN |
6298 | If defined, a C expression whose value is a string, including spacing, |
6299 | containing the assembler operation to identify the following data as | |
6300 | finalization code. If not defined, GCC will assume such a section does | |
98bfa2fb RS |
6301 | not exist. This section has no corresponding @code{fini_section} |
6302 | variable; it is used entirely in runtime code. | |
a2c4f8e0 | 6303 | @end defmac |
750054a2 | 6304 | |
7abc66b1 JB |
6305 | @defmac INIT_ARRAY_SECTION_ASM_OP |
6306 | If defined, a C expression whose value is a string, including spacing, | |
6307 | containing the assembler operation to identify the following data as | |
6308 | part of the @code{.init_array} (or equivalent) section. If not | |
6309 | defined, GCC will assume such a section does not exist. Do not define | |
6310 | both this macro and @code{INIT_SECTION_ASM_OP}. | |
6311 | @end defmac | |
083cad55 | 6312 | |
7abc66b1 JB |
6313 | @defmac FINI_ARRAY_SECTION_ASM_OP |
6314 | If defined, a C expression whose value is a string, including spacing, | |
6315 | containing the assembler operation to identify the following data as | |
6316 | part of the @code{.fini_array} (or equivalent) section. If not | |
6317 | defined, GCC will assume such a section does not exist. Do not define | |
6318 | both this macro and @code{FINI_SECTION_ASM_OP}. | |
6319 | @end defmac | |
6320 | ||
a2c4f8e0 | 6321 | @defmac CRT_CALL_STATIC_FUNCTION (@var{section_op}, @var{function}) |
cea3bd3e RH |
6322 | If defined, an ASM statement that switches to a different section |
6323 | via @var{section_op}, calls @var{function}, and switches back to | |
6324 | the text section. This is used in @file{crtstuff.c} if | |
6325 | @code{INIT_SECTION_ASM_OP} or @code{FINI_SECTION_ASM_OP} to calls | |
6326 | to initialization and finalization functions from the init and fini | |
6327 | sections. By default, this macro uses a simple function call. Some | |
1b2dd04a AO |
6328 | ports need hand-crafted assembly code to avoid dependencies on |
6329 | registers initialized in the function prologue or to ensure that | |
6330 | constant pools don't end up too far way in the text section. | |
a2c4f8e0 | 6331 | @end defmac |
1b2dd04a | 6332 | |
a0cfeb0f DD |
6333 | @defmac TARGET_LIBGCC_SDATA_SECTION |
6334 | If defined, a string which names the section into which small | |
6335 | variables defined in crtstuff and libgcc should go. This is useful | |
6336 | when the target has options for optimizing access to small data, and | |
6337 | you want the crtstuff and libgcc routines to be conservative in what | |
6338 | they expect of your application yet liberal in what your application | |
6339 | expects. For example, for targets with a @code{.sdata} section (like | |
6340 | MIPS), you could compile crtstuff with @code{-G 0} so that it doesn't | |
6341 | require small data support from your application, but use this macro | |
6342 | to put small data into @code{.sdata} so that your application can | |
6343 | access these variables whether it uses small data or not. | |
726e9992 | 6344 | @end defmac |
a0cfeb0f | 6345 | |
a2c4f8e0 | 6346 | @defmac FORCE_CODE_SECTION_ALIGN |
cea3bd3e RH |
6347 | If defined, an ASM statement that aligns a code section to some |
6348 | arbitrary boundary. This is used to force all fragments of the | |
6349 | @code{.init} and @code{.fini} sections to have to same alignment | |
6350 | and thus prevent the linker from having to add any padding. | |
a2c4f8e0 | 6351 | @end defmac |
cea3bd3e | 6352 | |
a2c4f8e0 | 6353 | @defmac JUMP_TABLES_IN_TEXT_SECTION |
df2a54e9 | 6354 | Define this macro to be an expression with a nonzero value if jump |
75197b37 BS |
6355 | tables (for @code{tablejump} insns) should be output in the text |
6356 | section, along with the assembler instructions. Otherwise, the | |
6357 | readonly data section is used. | |
feca2ed3 JW |
6358 | |
6359 | This macro is irrelevant if there is no separate readonly data section. | |
a2c4f8e0 | 6360 | @end defmac |
feca2ed3 | 6361 | |
d6b5193b RS |
6362 | @deftypefn {Target Hook} void TARGET_ASM_INIT_SECTIONS (void) |
6363 | Define this hook if you need to do something special to set up the | |
6364 | @file{varasm.c} sections, or if your target has some special sections | |
6365 | of its own that you need to create. | |
6366 | ||
6367 | GCC calls this hook after processing the command line, but before writing | |
6368 | any assembly code, and before calling any of the section-returning hooks | |
6369 | described below. | |
6370 | @end deftypefn | |
6371 | ||
6372 | @deftypefn {Target Hook} {section *} TARGET_ASM_SELECT_SECTION (tree @var{exp}, int @var{reloc}, unsigned HOST_WIDE_INT @var{align}) | |
6373 | Return the section into which @var{exp} should be placed. You can | |
ae46c4e0 RH |
6374 | assume that @var{exp} is either a @code{VAR_DECL} node or a constant of |
6375 | some sort. @var{reloc} indicates whether the initial value of @var{exp} | |
6376 | requires link-time relocations. Bit 0 is set when variable contains | |
6377 | local relocations only, while bit 1 is set for global relocations. | |
d6b5193b | 6378 | @var{align} is the constant alignment in bits. |
ae46c4e0 RH |
6379 | |
6380 | The default version of this function takes care of putting read-only | |
6381 | variables in @code{readonly_data_section}. | |
09afda70 GK |
6382 | |
6383 | See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}. | |
ae46c4e0 RH |
6384 | @end deftypefn |
6385 | ||
09afda70 GK |
6386 | @defmac USE_SELECT_SECTION_FOR_FUNCTIONS |
6387 | Define this macro if you wish TARGET_ASM_SELECT_SECTION to be called | |
6388 | for @code{FUNCTION_DECL}s as well as for variables and constants. | |
6389 | ||
6390 | In the case of a @code{FUNCTION_DECL}, @var{reloc} will be zero if the | |
6391 | function has been determined to be likely to be called, and nonzero if | |
6392 | it is unlikely to be called. | |
6393 | @end defmac | |
6394 | ||
ae46c4e0 RH |
6395 | @deftypefn {Target Hook} void TARGET_ASM_UNIQUE_SECTION (tree @var{decl}, int @var{reloc}) |
6396 | Build up a unique section name, expressed as a @code{STRING_CST} node, | |
6397 | and assign it to @samp{DECL_SECTION_NAME (@var{decl})}. | |
6398 | As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether | |
6399 | the initial value of @var{exp} requires link-time relocations. | |
6400 | ||
6401 | The default version of this function appends the symbol name to the | |
6402 | ELF section name that would normally be used for the symbol. For | |
6403 | example, the function @code{foo} would be placed in @code{.text.foo}. | |
6404 | Whatever the actual target object format, this is often good enough. | |
6405 | @end deftypefn | |
6406 | ||
d6b5193b RS |
6407 | @deftypefn {Target Hook} {section *} TARGET_ASM_FUNCTION_RODATA_SECTION (tree @var{decl}) |
6408 | Return the readonly data section associated with | |
ab5c8549 | 6409 | @samp{DECL_SECTION_NAME (@var{decl})}. |
d6b5193b RS |
6410 | The default version of this function selects @code{.gnu.linkonce.r.name} if |
6411 | the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name} | |
6412 | if function is in @code{.text.name}, and the normal readonly-data section | |
6413 | otherwise. | |
ab5c8549 JJ |
6414 | @end deftypefn |
6415 | ||
d6b5193b RS |
6416 | @deftypefn {Target Hook} {section *} TARGET_ASM_SELECT_RTX_SECTION (enum machine_mode @var{mode}, rtx @var{x}, unsigned HOST_WIDE_INT @var{align}) |
6417 | Return the section into which a constant @var{x}, of mode @var{mode}, | |
6418 | should be placed. You can assume that @var{x} is some kind of | |
b64a1b53 | 6419 | constant in RTL@. The argument @var{mode} is redundant except in the |
d6b5193b RS |
6420 | case of a @code{const_int} rtx. @var{align} is the constant alignment |
6421 | in bits. | |
b64a1b53 RH |
6422 | |
6423 | The default version of this function takes care of putting symbolic | |
6424 | constants in @code{flag_pic} mode in @code{data_section} and everything | |
6425 | else in @code{readonly_data_section}. | |
6426 | @end deftypefn | |
6427 | ||
c6a2438a | 6428 | @deftypefn {Target Hook} void TARGET_ENCODE_SECTION_INFO (tree @var{decl}, rtx @var{rtl}, int @var{new_decl_p}) |
fb49053f RH |
6429 | Define this hook if references to a symbol or a constant must be |
6430 | treated differently depending on something about the variable or | |
6431 | function named by the symbol (such as what section it is in). | |
6432 | ||
c6a2438a ZW |
6433 | The hook is executed immediately after rtl has been created for |
6434 | @var{decl}, which may be a variable or function declaration or | |
6435 | an entry in the constant pool. In either case, @var{rtl} is the | |
6436 | rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})} | |
0864034e | 6437 | in this hook; that field may not have been initialized yet. |
c6a2438a ZW |
6438 | |
6439 | In the case of a constant, it is safe to assume that the rtl is | |
6440 | a @code{mem} whose address is a @code{symbol_ref}. Most decls | |
6441 | will also have this form, but that is not guaranteed. Global | |
6442 | register variables, for instance, will have a @code{reg} for their | |
6443 | rtl. (Normally the right thing to do with such unusual rtl is | |
6444 | leave it alone.) | |
fb49053f RH |
6445 | |
6446 | The @var{new_decl_p} argument will be true if this is the first time | |
c6a2438a | 6447 | that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will |
fb49053f RH |
6448 | be false for subsequent invocations, which will happen for duplicate |
6449 | declarations. Whether or not anything must be done for the duplicate | |
6450 | declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}. | |
c6a2438a | 6451 | @var{new_decl_p} is always true when the hook is called for a constant. |
fb49053f RH |
6452 | |
6453 | @cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO} | |
c6a2438a ZW |
6454 | The usual thing for this hook to do is to record flags in the |
6455 | @code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}. | |
6456 | Historically, the name string was modified if it was necessary to | |
6457 | encode more than one bit of information, but this practice is now | |
6458 | discouraged; use @code{SYMBOL_REF_FLAGS}. | |
6459 | ||
6460 | The default definition of this hook, @code{default_encode_section_info} | |
6461 | in @file{varasm.c}, sets a number of commonly-useful bits in | |
6462 | @code{SYMBOL_REF_FLAGS}. Check whether the default does what you need | |
6463 | before overriding it. | |
fb49053f RH |
6464 | @end deftypefn |
6465 | ||
772c5265 RH |
6466 | @deftypefn {Target Hook} const char *TARGET_STRIP_NAME_ENCODING (const char *name) |
6467 | Decode @var{name} and return the real name part, sans | |
6468 | the characters that @code{TARGET_ENCODE_SECTION_INFO} | |
6469 | may have added. | |
6470 | @end deftypefn | |
6471 | ||
47754fd5 RH |
6472 | @deftypefn {Target Hook} bool TARGET_IN_SMALL_DATA_P (tree @var{exp}) |
6473 | Returns true if @var{exp} should be placed into a ``small data'' section. | |
6474 | The default version of this hook always returns false. | |
6475 | @end deftypefn | |
6476 | ||
e2a6476e DE |
6477 | @deftypevar {Target Hook} bool TARGET_HAVE_SRODATA_SECTION |
6478 | Contains the value true if the target places read-only | |
6479 | ``small data'' into a separate section. The default value is false. | |
6480 | @end deftypevar | |
6481 | ||
47754fd5 RH |
6482 | @deftypefn {Target Hook} bool TARGET_BINDS_LOCAL_P (tree @var{exp}) |
6483 | Returns true if @var{exp} names an object for which name resolution | |
6484 | rules must resolve to the current ``module'' (dynamic shared library | |
6485 | or executable image). | |
6486 | ||
6487 | The default version of this hook implements the name resolution rules | |
6488 | for ELF, which has a looser model of global name binding than other | |
6489 | currently supported object file formats. | |
6490 | @end deftypefn | |
6491 | ||
e2a6476e DE |
6492 | @deftypevar {Target Hook} bool TARGET_HAVE_TLS |
6493 | Contains the value true if the target supports thread-local storage. | |
6494 | The default value is false. | |
6495 | @end deftypevar | |
6496 | ||
6497 | ||
feca2ed3 JW |
6498 | @node PIC |
6499 | @section Position Independent Code | |
6500 | @cindex position independent code | |
6501 | @cindex PIC | |
6502 | ||
6503 | This section describes macros that help implement generation of position | |
6504 | independent code. Simply defining these macros is not enough to | |
6505 | generate valid PIC; you must also add support to the macros | |
6506 | @code{GO_IF_LEGITIMATE_ADDRESS} and @code{PRINT_OPERAND_ADDRESS}, as | |
6507 | well as @code{LEGITIMIZE_ADDRESS}. You must modify the definition of | |
6508 | @samp{movsi} to do something appropriate when the source operand | |
6509 | contains a symbolic address. You may also need to alter the handling of | |
6510 | switch statements so that they use relative addresses. | |
6511 | @c i rearranged the order of the macros above to try to force one of | |
6512 | @c them to the next line, to eliminate an overfull hbox. --mew 10feb93 | |
6513 | ||
a2c4f8e0 | 6514 | @defmac PIC_OFFSET_TABLE_REGNUM |
feca2ed3 JW |
6515 | The register number of the register used to address a table of static |
6516 | data addresses in memory. In some cases this register is defined by a | |
161d7b59 | 6517 | processor's ``application binary interface'' (ABI)@. When this macro |
feca2ed3 JW |
6518 | is defined, RTL is generated for this register once, as with the stack |
6519 | pointer and frame pointer registers. If this macro is not defined, it | |
6520 | is up to the machine-dependent files to allocate such a register (if | |
003b9f78 | 6521 | necessary). Note that this register must be fixed when in use (e.g.@: |
12beba6f | 6522 | when @code{flag_pic} is true). |
a2c4f8e0 | 6523 | @end defmac |
feca2ed3 | 6524 | |
a2c4f8e0 | 6525 | @defmac PIC_OFFSET_TABLE_REG_CALL_CLOBBERED |
feca2ed3 JW |
6526 | Define this macro if the register defined by |
6527 | @code{PIC_OFFSET_TABLE_REGNUM} is clobbered by calls. Do not define | |
ed4db1ee | 6528 | this macro if @code{PIC_OFFSET_TABLE_REGNUM} is not defined. |
a2c4f8e0 | 6529 | @end defmac |
feca2ed3 | 6530 | |
a2c4f8e0 | 6531 | @defmac LEGITIMATE_PIC_OPERAND_P (@var{x}) |
feca2ed3 JW |
6532 | A C expression that is nonzero if @var{x} is a legitimate immediate |
6533 | operand on the target machine when generating position independent code. | |
6534 | You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not | |
6535 | check this. You can also assume @var{flag_pic} is true, so you need not | |
6536 | check it either. You need not define this macro if all constants | |
6537 | (including @code{SYMBOL_REF}) can be immediate operands when generating | |
6538 | position independent code. | |
a2c4f8e0 | 6539 | @end defmac |
feca2ed3 JW |
6540 | |
6541 | @node Assembler Format | |
6542 | @section Defining the Output Assembler Language | |
6543 | ||
6544 | This section describes macros whose principal purpose is to describe how | |
648c546a | 6545 | to write instructions in assembler language---rather than what the |
feca2ed3 JW |
6546 | instructions do. |
6547 | ||
6548 | @menu | |
6549 | * File Framework:: Structural information for the assembler file. | |
6550 | * Data Output:: Output of constants (numbers, strings, addresses). | |
6551 | * Uninitialized Data:: Output of uninitialized variables. | |
6552 | * Label Output:: Output and generation of labels. | |
6553 | * Initialization:: General principles of initialization | |
6554 | and termination routines. | |
6555 | * Macros for Initialization:: | |
6556 | Specific macros that control the handling of | |
6557 | initialization and termination routines. | |
6558 | * Instruction Output:: Output of actual instructions. | |
6559 | * Dispatch Tables:: Output of jump tables. | |
6560 | * Exception Region Output:: Output of exception region code. | |
6561 | * Alignment Output:: Pseudo ops for alignment and skipping data. | |
6562 | @end menu | |
6563 | ||
6564 | @node File Framework | |
6565 | @subsection The Overall Framework of an Assembler File | |
6566 | @cindex assembler format | |
6567 | @cindex output of assembler code | |
6568 | ||
6569 | @c prevent bad page break with this line | |
1bc7c5b6 ZW |
6570 | This describes the overall framework of an assembly file. |
6571 | ||
6572 | @deftypefn {Target Hook} void TARGET_ASM_FILE_START () | |
6573 | @findex default_file_start | |
6574 | Output to @code{asm_out_file} any text which the assembler expects to | |
6575 | find at the beginning of a file. The default behavior is controlled | |
6576 | by two flags, documented below. Unless your target's assembler is | |
6577 | quite unusual, if you override the default, you should call | |
6578 | @code{default_file_start} at some point in your target hook. This | |
6579 | lets other target files rely on these variables. | |
6580 | @end deftypefn | |
feca2ed3 | 6581 | |
1bc7c5b6 ZW |
6582 | @deftypevr {Target Hook} bool TARGET_ASM_FILE_START_APP_OFF |
6583 | If this flag is true, the text of the macro @code{ASM_APP_OFF} will be | |
6584 | printed as the very first line in the assembly file, unless | |
6585 | @option{-fverbose-asm} is in effect. (If that macro has been defined | |
6586 | to the empty string, this variable has no effect.) With the normal | |
6587 | definition of @code{ASM_APP_OFF}, the effect is to notify the GNU | |
6588 | assembler that it need not bother stripping comments or extra | |
6589 | whitespace from its input. This allows it to work a bit faster. | |
6590 | ||
6591 | The default is false. You should not set it to true unless you have | |
6592 | verified that your port does not generate any extra whitespace or | |
6593 | comments that will cause GAS to issue errors in NO_APP mode. | |
6594 | @end deftypevr | |
6595 | ||
6596 | @deftypevr {Target Hook} bool TARGET_ASM_FILE_START_FILE_DIRECTIVE | |
6597 | If this flag is true, @code{output_file_directive} will be called | |
6598 | for the primary source file, immediately after printing | |
6599 | @code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect | |
6600 | this to be done. The default is false. | |
6601 | @end deftypevr | |
feca2ed3 | 6602 | |
a5fe455b ZW |
6603 | @deftypefn {Target Hook} void TARGET_ASM_FILE_END () |
6604 | Output to @code{asm_out_file} any text which the assembler expects | |
6605 | to find at the end of a file. The default is to output nothing. | |
6606 | @end deftypefn | |
feca2ed3 | 6607 | |
a5fe455b ZW |
6608 | @deftypefun void file_end_indicate_exec_stack () |
6609 | Some systems use a common convention, the @samp{.note.GNU-stack} | |
6610 | special section, to indicate whether or not an object file relies on | |
6611 | the stack being executable. If your system uses this convention, you | |
6612 | should define @code{TARGET_ASM_FILE_END} to this function. If you | |
6613 | need to do other things in that hook, have your hook function call | |
6614 | this function. | |
6615 | @end deftypefun | |
feca2ed3 | 6616 | |
a2c4f8e0 | 6617 | @defmac ASM_COMMENT_START |
feca2ed3 JW |
6618 | A C string constant describing how to begin a comment in the target |
6619 | assembler language. The compiler assumes that the comment will end at | |
6620 | the end of the line. | |
a2c4f8e0 | 6621 | @end defmac |
feca2ed3 | 6622 | |
a2c4f8e0 | 6623 | @defmac ASM_APP_ON |
feca2ed3 JW |
6624 | A C string constant for text to be output before each @code{asm} |
6625 | statement or group of consecutive ones. Normally this is | |
6626 | @code{"#APP"}, which is a comment that has no effect on most | |
6627 | assemblers but tells the GNU assembler that it must check the lines | |
6628 | that follow for all valid assembler constructs. | |
a2c4f8e0 | 6629 | @end defmac |
feca2ed3 | 6630 | |
a2c4f8e0 | 6631 | @defmac ASM_APP_OFF |
feca2ed3 JW |
6632 | A C string constant for text to be output after each @code{asm} |
6633 | statement or group of consecutive ones. Normally this is | |
6634 | @code{"#NO_APP"}, which tells the GNU assembler to resume making the | |
6635 | time-saving assumptions that are valid for ordinary compiler output. | |
a2c4f8e0 | 6636 | @end defmac |
feca2ed3 | 6637 | |
a2c4f8e0 | 6638 | @defmac ASM_OUTPUT_SOURCE_FILENAME (@var{stream}, @var{name}) |
feca2ed3 JW |
6639 | A C statement to output COFF information or DWARF debugging information |
6640 | which indicates that filename @var{name} is the current source file to | |
6641 | the stdio stream @var{stream}. | |
6642 | ||
6643 | This macro need not be defined if the standard form of output | |
6644 | for the file format in use is appropriate. | |
a2c4f8e0 | 6645 | @end defmac |
feca2ed3 | 6646 | |
a2c4f8e0 | 6647 | @defmac OUTPUT_QUOTED_STRING (@var{stream}, @var{string}) |
e9a25f70 JL |
6648 | A C statement to output the string @var{string} to the stdio stream |
6649 | @var{stream}. If you do not call the function @code{output_quoted_string} | |
a3a15b4d | 6650 | in your config files, GCC will only call it to output filenames to |
e9a25f70 JL |
6651 | the assembler source. So you can use it to canonicalize the format |
6652 | of the filename using this macro. | |
a2c4f8e0 | 6653 | @end defmac |
e9a25f70 | 6654 | |
a2c4f8e0 | 6655 | @defmac ASM_OUTPUT_IDENT (@var{stream}, @var{string}) |
feca2ed3 JW |
6656 | A C statement to output something to the assembler file to handle a |
6657 | @samp{#ident} directive containing the text @var{string}. If this | |
6658 | macro is not defined, nothing is output for a @samp{#ident} directive. | |
a2c4f8e0 | 6659 | @end defmac |
feca2ed3 | 6660 | |
7c262518 RH |
6661 | @deftypefn {Target Hook} void TARGET_ASM_NAMED_SECTION (const char *@var{name}, unsigned int @var{flags}, unsigned int @var{align}) |
6662 | Output assembly directives to switch to section @var{name}. The section | |
6663 | should have attributes as specified by @var{flags}, which is a bit mask | |
6664 | of the @code{SECTION_*} flags defined in @file{output.h}. If @var{align} | |
df2a54e9 | 6665 | is nonzero, it contains an alignment in bytes to be used for the section, |
f282ffb3 | 6666 | otherwise some target default should be used. Only targets that must |
7c262518 RH |
6667 | specify an alignment within the section directive need pay attention to |
6668 | @var{align} -- we will still use @code{ASM_OUTPUT_ALIGN}. | |
6669 | @end deftypefn | |
6670 | ||
6671 | @deftypefn {Target Hook} bool TARGET_HAVE_NAMED_SECTIONS | |
6672 | This flag is true if the target supports @code{TARGET_ASM_NAMED_SECTION}. | |
6673 | @end deftypefn | |
6674 | ||
434aeebb RS |
6675 | @anchor{TARGET_HAVE_SWITCHABLE_BSS_SECTIONS} |
6676 | @deftypefn {Target Hook} bool TARGET_HAVE_SWITCHABLE_BSS_SECTIONS | |
6677 | This flag is true if we can create zeroed data by switching to a BSS | |
6678 | section and then using @code{ASM_OUTPUT_SKIP} to allocate the space. | |
6679 | This is true on most ELF targets. | |
6680 | @end deftypefn | |
6681 | ||
7c262518 RH |
6682 | @deftypefn {Target Hook} {unsigned int} TARGET_SECTION_TYPE_FLAGS (tree @var{decl}, const char *@var{name}, int @var{reloc}) |
6683 | Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION} | |
6684 | based on a variable or function decl, a section name, and whether or not the | |
6685 | declaration's initializer may contain runtime relocations. @var{decl} may be | |
6686 | null, in which case read-write data should be assumed. | |
6687 | ||
224504d2 | 6688 | The default version of this function handles choosing code vs data, |
7c262518 RH |
6689 | read-only vs read-write data, and @code{flag_pic}. You should only |
6690 | need to override this if your target has special flags that might be | |
6691 | set via @code{__attribute__}. | |
6692 | @end deftypefn | |
6693 | ||
e0d9d0dd NC |
6694 | @deftypefn {Target Hook} {int} TARGET_ASM_RECORD_GCC_SWITCHES (print_switch_type @var{type}, const char * @var{text}) |
6695 | Provides the target with the ability to record the gcc command line | |
6696 | switches that have been passed to the compiler, and options that are | |
6697 | enabled. The @var{type} argument specifies what is being recorded. | |
6698 | It can take the following values: | |
6699 | ||
6700 | @table @gcctabopt | |
6701 | @item SWITCH_TYPE_PASSED | |
6702 | @var{text} is a command line switch that has been set by the user. | |
6703 | ||
6704 | @item SWITCH_TYPE_ENABLED | |
6705 | @var{text} is an option which has been enabled. This might be as a | |
6706 | direct result of a command line switch, or because it is enabled by | |
6707 | default or because it has been enabled as a side effect of a different | |
6708 | command line switch. For example, the @option{-O2} switch enables | |
6709 | various different individual optimization passes. | |
6710 | ||
6711 | @item SWITCH_TYPE_DESCRIPTIVE | |
6712 | @var{text} is either NULL or some descriptive text which should be | |
6713 | ignored. If @var{text} is NULL then it is being used to warn the | |
6714 | target hook that either recording is starting or ending. The first | |
6715 | time @var{type} is SWITCH_TYPE_DESCRIPTIVE and @var{text} is NULL, the | |
6716 | warning is for start up and the second time the warning is for | |
6717 | wind down. This feature is to allow the target hook to make any | |
6718 | necessary preparations before it starts to record switches and to | |
6719 | perform any necessary tidying up after it has finished recording | |
6720 | switches. | |
6721 | ||
6722 | @item SWITCH_TYPE_LINE_START | |
6723 | This option can be ignored by this target hook. | |
6724 | ||
6725 | @item SWITCH_TYPE_LINE_END | |
6726 | This option can be ignored by this target hook. | |
6727 | @end table | |
6728 | ||
6729 | The hook's return value must be zero. Other return values may be | |
6730 | supported in the future. | |
6731 | ||
6732 | By default this hook is set to NULL, but an example implementation is | |
6733 | provided for ELF based targets. Called @var{elf_record_gcc_switches}, | |
6734 | it records the switches as ASCII text inside a new, string mergeable | |
6735 | section in the assembler output file. The name of the new section is | |
6736 | provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target | |
6737 | hook. | |
6738 | @end deftypefn | |
6739 | ||
6740 | @deftypefn {Target Hook} {const char *} TARGET_ASM_RECORD_GCC_SWITCHES_SECTION | |
6741 | This is the name of the section that will be created by the example | |
6742 | ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target | |
6743 | hook. | |
6744 | @end deftypefn | |
6745 | ||
feca2ed3 JW |
6746 | @need 2000 |
6747 | @node Data Output | |
6748 | @subsection Output of Data | |
6749 | ||
301d03af RS |
6750 | |
6751 | @deftypevr {Target Hook} {const char *} TARGET_ASM_BYTE_OP | |
6752 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP | |
6753 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP | |
6754 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP | |
6755 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP | |
6756 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP | |
6757 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP | |
6758 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP | |
6759 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP | |
6760 | These hooks specify assembly directives for creating certain kinds | |
6761 | of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a | |
6762 | byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an | |
6763 | aligned two-byte object, and so on. Any of the hooks may be | |
6764 | @code{NULL}, indicating that no suitable directive is available. | |
6765 | ||
6766 | The compiler will print these strings at the start of a new line, | |
6767 | followed immediately by the object's initial value. In most cases, | |
6768 | the string should contain a tab, a pseudo-op, and then another tab. | |
6769 | @end deftypevr | |
6770 | ||
6771 | @deftypefn {Target Hook} bool TARGET_ASM_INTEGER (rtx @var{x}, unsigned int @var{size}, int @var{aligned_p}) | |
6772 | The @code{assemble_integer} function uses this hook to output an | |
6773 | integer object. @var{x} is the object's value, @var{size} is its size | |
6774 | in bytes and @var{aligned_p} indicates whether it is aligned. The | |
6775 | function should return @code{true} if it was able to output the | |
6776 | object. If it returns false, @code{assemble_integer} will try to | |
6777 | split the object into smaller parts. | |
6778 | ||
6779 | The default implementation of this hook will use the | |
6780 | @code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false} | |
6781 | when the relevant string is @code{NULL}. | |
6782 | @end deftypefn | |
feca2ed3 | 6783 | |
a2c4f8e0 | 6784 | @defmac OUTPUT_ADDR_CONST_EXTRA (@var{stream}, @var{x}, @var{fail}) |
422be3c3 AO |
6785 | A C statement to recognize @var{rtx} patterns that |
6786 | @code{output_addr_const} can't deal with, and output assembly code to | |
6787 | @var{stream} corresponding to the pattern @var{x}. This may be used to | |
6788 | allow machine-dependent @code{UNSPEC}s to appear within constants. | |
6789 | ||
6790 | If @code{OUTPUT_ADDR_CONST_EXTRA} fails to recognize a pattern, it must | |
6791 | @code{goto fail}, so that a standard error message is printed. If it | |
6792 | prints an error message itself, by calling, for example, | |
6793 | @code{output_operand_lossage}, it may just complete normally. | |
a2c4f8e0 | 6794 | @end defmac |
422be3c3 | 6795 | |
a2c4f8e0 | 6796 | @defmac ASM_OUTPUT_ASCII (@var{stream}, @var{ptr}, @var{len}) |
feca2ed3 JW |
6797 | A C statement to output to the stdio stream @var{stream} an assembler |
6798 | instruction to assemble a string constant containing the @var{len} | |
6799 | bytes at @var{ptr}. @var{ptr} will be a C expression of type | |
6800 | @code{char *} and @var{len} a C expression of type @code{int}. | |
6801 | ||
6802 | If the assembler has a @code{.ascii} pseudo-op as found in the | |
6803 | Berkeley Unix assembler, do not define the macro | |
6804 | @code{ASM_OUTPUT_ASCII}. | |
a2c4f8e0 | 6805 | @end defmac |
feca2ed3 | 6806 | |
a2c4f8e0 | 6807 | @defmac ASM_OUTPUT_FDESC (@var{stream}, @var{decl}, @var{n}) |
67231816 RH |
6808 | A C statement to output word @var{n} of a function descriptor for |
6809 | @var{decl}. This must be defined if @code{TARGET_VTABLE_USES_DESCRIPTORS} | |
6810 | is defined, and is otherwise unused. | |
a2c4f8e0 | 6811 | @end defmac |
67231816 | 6812 | |
a2c4f8e0 | 6813 | @defmac CONSTANT_POOL_BEFORE_FUNCTION |
861bb6c1 | 6814 | You may define this macro as a C expression. You should define the |
df2a54e9 | 6815 | expression to have a nonzero value if GCC should output the constant |
861bb6c1 | 6816 | pool for a function before the code for the function, or a zero value if |
a3a15b4d JL |
6817 | GCC should output the constant pool after the function. If you do |
6818 | not define this macro, the usual case, GCC will output the constant | |
861bb6c1 | 6819 | pool before the function. |
a2c4f8e0 | 6820 | @end defmac |
861bb6c1 | 6821 | |
a2c4f8e0 | 6822 | @defmac ASM_OUTPUT_POOL_PROLOGUE (@var{file}, @var{funname}, @var{fundecl}, @var{size}) |
feca2ed3 JW |
6823 | A C statement to output assembler commands to define the start of the |
6824 | constant pool for a function. @var{funname} is a string giving | |
6825 | the name of the function. Should the return type of the function | |
6826 | be required, it can be obtained via @var{fundecl}. @var{size} | |
6827 | is the size, in bytes, of the constant pool that will be written | |
6828 | immediately after this call. | |
6829 | ||
6830 | If no constant-pool prefix is required, the usual case, this macro need | |
6831 | not be defined. | |
a2c4f8e0 | 6832 | @end defmac |
feca2ed3 | 6833 | |
a2c4f8e0 | 6834 | @defmac ASM_OUTPUT_SPECIAL_POOL_ENTRY (@var{file}, @var{x}, @var{mode}, @var{align}, @var{labelno}, @var{jumpto}) |
feca2ed3 JW |
6835 | A C statement (with or without semicolon) to output a constant in the |
6836 | constant pool, if it needs special treatment. (This macro need not do | |
6837 | anything for RTL expressions that can be output normally.) | |
6838 | ||
6839 | The argument @var{file} is the standard I/O stream to output the | |
6840 | assembler code on. @var{x} is the RTL expression for the constant to | |
6841 | output, and @var{mode} is the machine mode (in case @var{x} is a | |
6842 | @samp{const_int}). @var{align} is the required alignment for the value | |
6843 | @var{x}; you should output an assembler directive to force this much | |
6844 | alignment. | |
6845 | ||
6846 | The argument @var{labelno} is a number to use in an internal label for | |
6847 | the address of this pool entry. The definition of this macro is | |
6848 | responsible for outputting the label definition at the proper place. | |
6849 | Here is how to do this: | |
6850 | ||
3ab51846 | 6851 | @smallexample |
4977bab6 | 6852 | @code{(*targetm.asm_out.internal_label)} (@var{file}, "LC", @var{labelno}); |
3ab51846 | 6853 | @end smallexample |
feca2ed3 JW |
6854 | |
6855 | When you output a pool entry specially, you should end with a | |
6856 | @code{goto} to the label @var{jumpto}. This will prevent the same pool | |
6857 | entry from being output a second time in the usual manner. | |
6858 | ||
6859 | You need not define this macro if it would do nothing. | |
a2c4f8e0 | 6860 | @end defmac |
feca2ed3 | 6861 | |
a2c4f8e0 | 6862 | @defmac ASM_OUTPUT_POOL_EPILOGUE (@var{file} @var{funname} @var{fundecl} @var{size}) |
861bb6c1 JL |
6863 | A C statement to output assembler commands to at the end of the constant |
6864 | pool for a function. @var{funname} is a string giving the name of the | |
6865 | function. Should the return type of the function be required, you can | |
6866 | obtain it via @var{fundecl}. @var{size} is the size, in bytes, of the | |
a3a15b4d | 6867 | constant pool that GCC wrote immediately before this call. |
861bb6c1 JL |
6868 | |
6869 | If no constant-pool epilogue is required, the usual case, you need not | |
6870 | define this macro. | |
a2c4f8e0 | 6871 | @end defmac |
861bb6c1 | 6872 | |
a2c4f8e0 | 6873 | @defmac IS_ASM_LOGICAL_LINE_SEPARATOR (@var{C}) |
feca2ed3 JW |
6874 | Define this macro as a C expression which is nonzero if @var{C} is |
6875 | used as a logical line separator by the assembler. | |
6876 | ||
6877 | If you do not define this macro, the default is that only | |
6878 | the character @samp{;} is treated as a logical line separator. | |
a2c4f8e0 | 6879 | @end defmac |
feca2ed3 | 6880 | |
8ca83838 | 6881 | @deftypevr {Target Hook} {const char *} TARGET_ASM_OPEN_PAREN |
baed53ac | 6882 | @deftypevrx {Target Hook} {const char *} TARGET_ASM_CLOSE_PAREN |
17b53c33 NB |
6883 | These target hooks are C string constants, describing the syntax in the |
6884 | assembler for grouping arithmetic expressions. If not overridden, they | |
6885 | default to normal parentheses, which is correct for most assemblers. | |
8ca83838 | 6886 | @end deftypevr |
17b53c33 | 6887 | |
feca2ed3 JW |
6888 | These macros are provided by @file{real.h} for writing the definitions |
6889 | of @code{ASM_OUTPUT_DOUBLE} and the like: | |
6890 | ||
a2c4f8e0 ZW |
6891 | @defmac REAL_VALUE_TO_TARGET_SINGLE (@var{x}, @var{l}) |
6892 | @defmacx REAL_VALUE_TO_TARGET_DOUBLE (@var{x}, @var{l}) | |
6893 | @defmacx REAL_VALUE_TO_TARGET_LONG_DOUBLE (@var{x}, @var{l}) | |
dadb213f BE |
6894 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL32 (@var{x}, @var{l}) |
6895 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL64 (@var{x}, @var{l}) | |
6896 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL128 (@var{x}, @var{l}) | |
6897 | These translate @var{x}, of type @code{REAL_VALUE_TYPE}, to the | |
6898 | target's floating point representation, and store its bit pattern in | |
6899 | the variable @var{l}. For @code{REAL_VALUE_TO_TARGET_SINGLE} and | |
6900 | @code{REAL_VALUE_TO_TARGET_DECIMAL32}, this variable should be a | |
6901 | simple @code{long int}. For the others, it should be an array of | |
6902 | @code{long int}. The number of elements in this array is determined | |
6903 | by the size of the desired target floating point data type: 32 bits of | |
6904 | it go in each @code{long int} array element. Each array element holds | |
6905 | 32 bits of the result, even if @code{long int} is wider than 32 bits | |
6906 | on the host machine. | |
feca2ed3 JW |
6907 | |
6908 | The array element values are designed so that you can print them out | |
6909 | using @code{fprintf} in the order they should appear in the target | |
6910 | machine's memory. | |
a2c4f8e0 | 6911 | @end defmac |
feca2ed3 JW |
6912 | |
6913 | @node Uninitialized Data | |
6914 | @subsection Output of Uninitialized Variables | |
6915 | ||
6916 | Each of the macros in this section is used to do the whole job of | |
6917 | outputting a single uninitialized variable. | |
6918 | ||
a2c4f8e0 | 6919 | @defmac ASM_OUTPUT_COMMON (@var{stream}, @var{name}, @var{size}, @var{rounded}) |
feca2ed3 JW |
6920 | A C statement (sans semicolon) to output to the stdio stream |
6921 | @var{stream} the assembler definition of a common-label named | |
6922 | @var{name} whose size is @var{size} bytes. The variable @var{rounded} | |
6923 | is the size rounded up to whatever alignment the caller wants. | |
6924 | ||
6925 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
6926 | output the name itself; before and after that, output the additional | |
6927 | assembler syntax for defining the name, and a newline. | |
6928 | ||
6929 | This macro controls how the assembler definitions of uninitialized | |
6930 | common global variables are output. | |
a2c4f8e0 | 6931 | @end defmac |
feca2ed3 | 6932 | |
a2c4f8e0 | 6933 | @defmac ASM_OUTPUT_ALIGNED_COMMON (@var{stream}, @var{name}, @var{size}, @var{alignment}) |
feca2ed3 JW |
6934 | Like @code{ASM_OUTPUT_COMMON} except takes the required alignment as a |
6935 | separate, explicit argument. If you define this macro, it is used in | |
6936 | place of @code{ASM_OUTPUT_COMMON}, and gives you more flexibility in | |
6937 | handling the required alignment of the variable. The alignment is specified | |
6938 | as the number of bits. | |
a2c4f8e0 | 6939 | @end defmac |
feca2ed3 | 6940 | |
a2c4f8e0 | 6941 | @defmac ASM_OUTPUT_ALIGNED_DECL_COMMON (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) |
e9a25f70 JL |
6942 | Like @code{ASM_OUTPUT_ALIGNED_COMMON} except that @var{decl} of the |
6943 | variable to be output, if there is one, or @code{NULL_TREE} if there | |
8760eaae | 6944 | is no corresponding variable. If you define this macro, GCC will use it |
e9a25f70 JL |
6945 | in place of both @code{ASM_OUTPUT_COMMON} and |
6946 | @code{ASM_OUTPUT_ALIGNED_COMMON}. Define this macro when you need to see | |
6947 | the variable's decl in order to chose what to output. | |
a2c4f8e0 | 6948 | @end defmac |
e9a25f70 | 6949 | |
a2c4f8e0 | 6950 | @defmac ASM_OUTPUT_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{rounded}) |
feca2ed3 JW |
6951 | A C statement (sans semicolon) to output to the stdio stream |
6952 | @var{stream} the assembler definition of uninitialized global @var{decl} named | |
6953 | @var{name} whose size is @var{size} bytes. The variable @var{rounded} | |
6954 | is the size rounded up to whatever alignment the caller wants. | |
6955 | ||
6956 | Try to use function @code{asm_output_bss} defined in @file{varasm.c} when | |
6957 | defining this macro. If unable, use the expression | |
6958 | @code{assemble_name (@var{stream}, @var{name})} to output the name itself; | |
6959 | before and after that, output the additional assembler syntax for defining | |
6960 | the name, and a newline. | |
6961 | ||
434aeebb RS |
6962 | There are two ways of handling global BSS. One is to define either |
6963 | this macro or its aligned counterpart, @code{ASM_OUTPUT_ALIGNED_BSS}. | |
6964 | The other is to have @code{TARGET_ASM_SELECT_SECTION} return a | |
6965 | switchable BSS section (@pxref{TARGET_HAVE_SWITCHABLE_BSS_SECTIONS}). | |
6966 | You do not need to do both. | |
6967 | ||
6968 | Some languages do not have @code{common} data, and require a | |
6969 | non-common form of global BSS in order to handle uninitialized globals | |
6970 | efficiently. C++ is one example of this. However, if the target does | |
6971 | not support global BSS, the front end may choose to make globals | |
6972 | common in order to save space in the object file. | |
a2c4f8e0 | 6973 | @end defmac |
feca2ed3 | 6974 | |
a2c4f8e0 | 6975 | @defmac ASM_OUTPUT_ALIGNED_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) |
feca2ed3 JW |
6976 | Like @code{ASM_OUTPUT_BSS} except takes the required alignment as a |
6977 | separate, explicit argument. If you define this macro, it is used in | |
6978 | place of @code{ASM_OUTPUT_BSS}, and gives you more flexibility in | |
6979 | handling the required alignment of the variable. The alignment is specified | |
6980 | as the number of bits. | |
6981 | ||
6982 | Try to use function @code{asm_output_aligned_bss} defined in file | |
6983 | @file{varasm.c} when defining this macro. | |
a2c4f8e0 | 6984 | @end defmac |
feca2ed3 | 6985 | |
a2c4f8e0 | 6986 | @defmac ASM_OUTPUT_LOCAL (@var{stream}, @var{name}, @var{size}, @var{rounded}) |
feca2ed3 JW |
6987 | A C statement (sans semicolon) to output to the stdio stream |
6988 | @var{stream} the assembler definition of a local-common-label named | |
6989 | @var{name} whose size is @var{size} bytes. The variable @var{rounded} | |
6990 | is the size rounded up to whatever alignment the caller wants. | |
6991 | ||
6992 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
6993 | output the name itself; before and after that, output the additional | |
6994 | assembler syntax for defining the name, and a newline. | |
6995 | ||
6996 | This macro controls how the assembler definitions of uninitialized | |
6997 | static variables are output. | |
a2c4f8e0 | 6998 | @end defmac |
feca2ed3 | 6999 | |
a2c4f8e0 | 7000 | @defmac ASM_OUTPUT_ALIGNED_LOCAL (@var{stream}, @var{name}, @var{size}, @var{alignment}) |
feca2ed3 JW |
7001 | Like @code{ASM_OUTPUT_LOCAL} except takes the required alignment as a |
7002 | separate, explicit argument. If you define this macro, it is used in | |
7003 | place of @code{ASM_OUTPUT_LOCAL}, and gives you more flexibility in | |
7004 | handling the required alignment of the variable. The alignment is specified | |
7005 | as the number of bits. | |
a2c4f8e0 | 7006 | @end defmac |
feca2ed3 | 7007 | |
a2c4f8e0 | 7008 | @defmac ASM_OUTPUT_ALIGNED_DECL_LOCAL (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) |
e9a25f70 JL |
7009 | Like @code{ASM_OUTPUT_ALIGNED_DECL} except that @var{decl} of the |
7010 | variable to be output, if there is one, or @code{NULL_TREE} if there | |
8760eaae | 7011 | is no corresponding variable. If you define this macro, GCC will use it |
e9a25f70 JL |
7012 | in place of both @code{ASM_OUTPUT_DECL} and |
7013 | @code{ASM_OUTPUT_ALIGNED_DECL}. Define this macro when you need to see | |
7014 | the variable's decl in order to chose what to output. | |
a2c4f8e0 | 7015 | @end defmac |
e9a25f70 | 7016 | |
feca2ed3 JW |
7017 | @node Label Output |
7018 | @subsection Output and Generation of Labels | |
7019 | ||
7020 | @c prevent bad page break with this line | |
7021 | This is about outputting labels. | |
7022 | ||
feca2ed3 | 7023 | @findex assemble_name |
a2c4f8e0 | 7024 | @defmac ASM_OUTPUT_LABEL (@var{stream}, @var{name}) |
feca2ed3 JW |
7025 | A C statement (sans semicolon) to output to the stdio stream |
7026 | @var{stream} the assembler definition of a label named @var{name}. | |
7027 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
7028 | output the name itself; before and after that, output the additional | |
4ad5e05d KG |
7029 | assembler syntax for defining the name, and a newline. A default |
7030 | definition of this macro is provided which is correct for most systems. | |
a2c4f8e0 | 7031 | @end defmac |
feca2ed3 | 7032 | |
57829bc4 MM |
7033 | @findex assemble_name_raw |
7034 | @defmac ASM_OUTPUT_INTERNAL_LABEL (@var{stream}, @var{name}) | |
e374d5c9 | 7035 | Identical to @code{ASM_OUTPUT_LABEL}, except that @var{name} is known |
57829bc4 MM |
7036 | to refer to a compiler-generated label. The default definition uses |
7037 | @code{assemble_name_raw}, which is like @code{assemble_name} except | |
7038 | that it is more efficient. | |
7039 | @end defmac | |
7040 | ||
a2c4f8e0 | 7041 | @defmac SIZE_ASM_OP |
2be2ac70 ZW |
7042 | A C string containing the appropriate assembler directive to specify the |
7043 | size of a symbol, without any arguments. On systems that use ELF, the | |
7044 | default (in @file{config/elfos.h}) is @samp{"\t.size\t"}; on other | |
7045 | systems, the default is not to define this macro. | |
7046 | ||
7047 | Define this macro only if it is correct to use the default definitions | |
7048 | of @code{ASM_OUTPUT_SIZE_DIRECTIVE} and @code{ASM_OUTPUT_MEASURED_SIZE} | |
7049 | for your system. If you need your own custom definitions of those | |
7050 | macros, or if you do not need explicit symbol sizes at all, do not | |
7051 | define this macro. | |
a2c4f8e0 | 7052 | @end defmac |
2be2ac70 | 7053 | |
a2c4f8e0 | 7054 | @defmac ASM_OUTPUT_SIZE_DIRECTIVE (@var{stream}, @var{name}, @var{size}) |
2be2ac70 ZW |
7055 | A C statement (sans semicolon) to output to the stdio stream |
7056 | @var{stream} a directive telling the assembler that the size of the | |
7057 | symbol @var{name} is @var{size}. @var{size} is a @code{HOST_WIDE_INT}. | |
7058 | If you define @code{SIZE_ASM_OP}, a default definition of this macro is | |
7059 | provided. | |
a2c4f8e0 | 7060 | @end defmac |
2be2ac70 | 7061 | |
a2c4f8e0 | 7062 | @defmac ASM_OUTPUT_MEASURED_SIZE (@var{stream}, @var{name}) |
2be2ac70 ZW |
7063 | A C statement (sans semicolon) to output to the stdio stream |
7064 | @var{stream} a directive telling the assembler to calculate the size of | |
99086d59 | 7065 | the symbol @var{name} by subtracting its address from the current |
73774972 | 7066 | address. |
99086d59 ZW |
7067 | |
7068 | If you define @code{SIZE_ASM_OP}, a default definition of this macro is | |
7069 | provided. The default assumes that the assembler recognizes a special | |
7070 | @samp{.} symbol as referring to the current address, and can calculate | |
7071 | the difference between this and another symbol. If your assembler does | |
7072 | not recognize @samp{.} or cannot do calculations with it, you will need | |
7073 | to redefine @code{ASM_OUTPUT_MEASURED_SIZE} to use some other technique. | |
a2c4f8e0 | 7074 | @end defmac |
2be2ac70 | 7075 | |
a2c4f8e0 | 7076 | @defmac TYPE_ASM_OP |
2be2ac70 ZW |
7077 | A C string containing the appropriate assembler directive to specify the |
7078 | type of a symbol, without any arguments. On systems that use ELF, the | |
7079 | default (in @file{config/elfos.h}) is @samp{"\t.type\t"}; on other | |
7080 | systems, the default is not to define this macro. | |
7081 | ||
7082 | Define this macro only if it is correct to use the default definition of | |
7083 | @code{ASM_OUTPUT_TYPE_DIRECTIVE} for your system. If you need your own | |
7084 | custom definition of this macro, or if you do not need explicit symbol | |
7085 | types at all, do not define this macro. | |
a2c4f8e0 | 7086 | @end defmac |
2be2ac70 | 7087 | |
a2c4f8e0 | 7088 | @defmac TYPE_OPERAND_FMT |
2be2ac70 ZW |
7089 | A C string which specifies (using @code{printf} syntax) the format of |
7090 | the second operand to @code{TYPE_ASM_OP}. On systems that use ELF, the | |
7091 | default (in @file{config/elfos.h}) is @samp{"@@%s"}; on other systems, | |
7092 | the default is not to define this macro. | |
7093 | ||
7094 | Define this macro only if it is correct to use the default definition of | |
7095 | @code{ASM_OUTPUT_TYPE_DIRECTIVE} for your system. If you need your own | |
7096 | custom definition of this macro, or if you do not need explicit symbol | |
7097 | types at all, do not define this macro. | |
a2c4f8e0 | 7098 | @end defmac |
2be2ac70 | 7099 | |
a2c4f8e0 | 7100 | @defmac ASM_OUTPUT_TYPE_DIRECTIVE (@var{stream}, @var{type}) |
2be2ac70 ZW |
7101 | A C statement (sans semicolon) to output to the stdio stream |
7102 | @var{stream} a directive telling the assembler that the type of the | |
7103 | symbol @var{name} is @var{type}. @var{type} is a C string; currently, | |
7104 | that string is always either @samp{"function"} or @samp{"object"}, but | |
7105 | you should not count on this. | |
7106 | ||
7107 | If you define @code{TYPE_ASM_OP} and @code{TYPE_OPERAND_FMT}, a default | |
7108 | definition of this macro is provided. | |
a2c4f8e0 | 7109 | @end defmac |
2be2ac70 | 7110 | |
a2c4f8e0 | 7111 | @defmac ASM_DECLARE_FUNCTION_NAME (@var{stream}, @var{name}, @var{decl}) |
feca2ed3 JW |
7112 | A C statement (sans semicolon) to output to the stdio stream |
7113 | @var{stream} any text necessary for declaring the name @var{name} of a | |
7114 | function which is being defined. This macro is responsible for | |
7115 | outputting the label definition (perhaps using | |
7116 | @code{ASM_OUTPUT_LABEL}). The argument @var{decl} is the | |
7117 | @code{FUNCTION_DECL} tree node representing the function. | |
7118 | ||
7119 | If this macro is not defined, then the function name is defined in the | |
7120 | usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}). | |
7121 | ||
2be2ac70 ZW |
7122 | You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in the definition |
7123 | of this macro. | |
a2c4f8e0 | 7124 | @end defmac |
2be2ac70 | 7125 | |
a2c4f8e0 | 7126 | @defmac ASM_DECLARE_FUNCTION_SIZE (@var{stream}, @var{name}, @var{decl}) |
feca2ed3 JW |
7127 | A C statement (sans semicolon) to output to the stdio stream |
7128 | @var{stream} any text necessary for declaring the size of a function | |
7129 | which is being defined. The argument @var{name} is the name of the | |
7130 | function. The argument @var{decl} is the @code{FUNCTION_DECL} tree node | |
7131 | representing the function. | |
7132 | ||
7133 | If this macro is not defined, then the function size is not defined. | |
7134 | ||
2be2ac70 ZW |
7135 | You may wish to use @code{ASM_OUTPUT_MEASURED_SIZE} in the definition |
7136 | of this macro. | |
a2c4f8e0 | 7137 | @end defmac |
2be2ac70 | 7138 | |
a2c4f8e0 | 7139 | @defmac ASM_DECLARE_OBJECT_NAME (@var{stream}, @var{name}, @var{decl}) |
feca2ed3 JW |
7140 | A C statement (sans semicolon) to output to the stdio stream |
7141 | @var{stream} any text necessary for declaring the name @var{name} of an | |
7142 | initialized variable which is being defined. This macro must output the | |
7143 | label definition (perhaps using @code{ASM_OUTPUT_LABEL}). The argument | |
7144 | @var{decl} is the @code{VAR_DECL} tree node representing the variable. | |
7145 | ||
7146 | If this macro is not defined, then the variable name is defined in the | |
7147 | usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}). | |
7148 | ||
2be2ac70 ZW |
7149 | You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} and/or |
7150 | @code{ASM_OUTPUT_SIZE_DIRECTIVE} in the definition of this macro. | |
a2c4f8e0 | 7151 | @end defmac |
2be2ac70 | 7152 | |
18f3e349 GK |
7153 | @defmac ASM_DECLARE_CONSTANT_NAME (@var{stream}, @var{name}, @var{exp}, @var{size}) |
7154 | A C statement (sans semicolon) to output to the stdio stream | |
7155 | @var{stream} any text necessary for declaring the name @var{name} of a | |
7156 | constant which is being defined. This macro is responsible for | |
7157 | outputting the label definition (perhaps using | |
7158 | @code{ASM_OUTPUT_LABEL}). The argument @var{exp} is the | |
7159 | value of the constant, and @var{size} is the size of the constant | |
7160 | in bytes. @var{name} will be an internal label. | |
7161 | ||
7162 | If this macro is not defined, then the @var{name} is defined in the | |
7163 | usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}). | |
7164 | ||
7165 | You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in the definition | |
7166 | of this macro. | |
7167 | @end defmac | |
7168 | ||
a2c4f8e0 | 7169 | @defmac ASM_DECLARE_REGISTER_GLOBAL (@var{stream}, @var{decl}, @var{regno}, @var{name}) |
1cb36a98 RH |
7170 | A C statement (sans semicolon) to output to the stdio stream |
7171 | @var{stream} any text necessary for claiming a register @var{regno} | |
7172 | for a global variable @var{decl} with name @var{name}. | |
7173 | ||
7174 | If you don't define this macro, that is equivalent to defining it to do | |
7175 | nothing. | |
a2c4f8e0 | 7176 | @end defmac |
1cb36a98 | 7177 | |
a2c4f8e0 | 7178 | @defmac ASM_FINISH_DECLARE_OBJECT (@var{stream}, @var{decl}, @var{toplevel}, @var{atend}) |
feca2ed3 JW |
7179 | A C statement (sans semicolon) to finish up declaring a variable name |
7180 | once the compiler has processed its initializer fully and thus has had a | |
7181 | chance to determine the size of an array when controlled by an | |
7182 | initializer. This is used on systems where it's necessary to declare | |
7183 | something about the size of the object. | |
7184 | ||
7185 | If you don't define this macro, that is equivalent to defining it to do | |
7186 | nothing. | |
7187 | ||
2be2ac70 ZW |
7188 | You may wish to use @code{ASM_OUTPUT_SIZE_DIRECTIVE} and/or |
7189 | @code{ASM_OUTPUT_MEASURED_SIZE} in the definition of this macro. | |
a2c4f8e0 | 7190 | @end defmac |
2be2ac70 | 7191 | |
5eb99654 KG |
7192 | @deftypefn {Target Hook} void TARGET_ASM_GLOBALIZE_LABEL (FILE *@var{stream}, const char *@var{name}) |
7193 | This target hook is a function to output to the stdio stream | |
feca2ed3 | 7194 | @var{stream} some commands that will make the label @var{name} global; |
5eb99654 | 7195 | that is, available for reference from other files. |
feca2ed3 | 7196 | |
5eb99654 KG |
7197 | The default implementation relies on a proper definition of |
7198 | @code{GLOBAL_ASM_OP}. | |
b65d23aa | 7199 | @end deftypefn |
072cdaed | 7200 | |
812b587e SE |
7201 | @deftypefn {Target Hook} void TARGET_ASM_GLOBALIZE_DECL_NAME (FILE *@var{stream}, tree @var{decl}) |
7202 | This target hook is a function to output to the stdio stream | |
7203 | @var{stream} some commands that will make the name associated with @var{decl} | |
7204 | global; that is, available for reference from other files. | |
7205 | ||
7206 | The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook. | |
7207 | @end deftypefn | |
7208 | ||
a2c4f8e0 | 7209 | @defmac ASM_WEAKEN_LABEL (@var{stream}, @var{name}) |
feca2ed3 JW |
7210 | A C statement (sans semicolon) to output to the stdio stream |
7211 | @var{stream} some commands that will make the label @var{name} weak; | |
7212 | that is, available for reference from other files but only used if | |
7213 | no other definition is available. Use the expression | |
7214 | @code{assemble_name (@var{stream}, @var{name})} to output the name | |
7215 | itself; before and after that, output the additional assembler syntax | |
7216 | for making that name weak, and a newline. | |
7217 | ||
79c4e63f AM |
7218 | If you don't define this macro or @code{ASM_WEAKEN_DECL}, GCC will not |
7219 | support weak symbols and you should not define the @code{SUPPORTS_WEAK} | |
7220 | macro. | |
a2c4f8e0 | 7221 | @end defmac |
79c4e63f | 7222 | |
a2c4f8e0 | 7223 | @defmac ASM_WEAKEN_DECL (@var{stream}, @var{decl}, @var{name}, @var{value}) |
79c4e63f AM |
7224 | Combines (and replaces) the function of @code{ASM_WEAKEN_LABEL} and |
7225 | @code{ASM_OUTPUT_WEAK_ALIAS}, allowing access to the associated function | |
7226 | or variable decl. If @var{value} is not @code{NULL}, this C statement | |
7227 | should output to the stdio stream @var{stream} assembler code which | |
7228 | defines (equates) the weak symbol @var{name} to have the value | |
7229 | @var{value}. If @var{value} is @code{NULL}, it should output commands | |
7230 | to make @var{name} weak. | |
a2c4f8e0 | 7231 | @end defmac |
feca2ed3 | 7232 | |
ff2d10c1 AO |
7233 | @defmac ASM_OUTPUT_WEAKREF (@var{stream}, @var{decl}, @var{name}, @var{value}) |
7234 | Outputs a directive that enables @var{name} to be used to refer to | |
7235 | symbol @var{value} with weak-symbol semantics. @code{decl} is the | |
7236 | declaration of @code{name}. | |
7237 | @end defmac | |
7238 | ||
a2c4f8e0 | 7239 | @defmac SUPPORTS_WEAK |
feca2ed3 JW |
7240 | A C expression which evaluates to true if the target supports weak symbols. |
7241 | ||
7242 | If you don't define this macro, @file{defaults.h} provides a default | |
79c4e63f AM |
7243 | definition. If either @code{ASM_WEAKEN_LABEL} or @code{ASM_WEAKEN_DECL} |
7244 | is defined, the default definition is @samp{1}; otherwise, it is | |
7245 | @samp{0}. Define this macro if you want to control weak symbol support | |
7246 | with a compiler flag such as @option{-melf}. | |
a2c4f8e0 | 7247 | @end defmac |
feca2ed3 | 7248 | |
a2c4f8e0 | 7249 | @defmac MAKE_DECL_ONE_ONLY (@var{decl}) |
feca2ed3 JW |
7250 | A C statement (sans semicolon) to mark @var{decl} to be emitted as a |
7251 | public symbol such that extra copies in multiple translation units will | |
7252 | be discarded by the linker. Define this macro if your object file | |
7253 | format provides support for this concept, such as the @samp{COMDAT} | |
7254 | section flags in the Microsoft Windows PE/COFF format, and this support | |
7255 | requires changes to @var{decl}, such as putting it in a separate section. | |
a2c4f8e0 | 7256 | @end defmac |
feca2ed3 | 7257 | |
a2c4f8e0 | 7258 | @defmac SUPPORTS_ONE_ONLY |
feca2ed3 JW |
7259 | A C expression which evaluates to true if the target supports one-only |
7260 | semantics. | |
7261 | ||
7262 | If you don't define this macro, @file{varasm.c} provides a default | |
7263 | definition. If @code{MAKE_DECL_ONE_ONLY} is defined, the default | |
7264 | definition is @samp{1}; otherwise, it is @samp{0}. Define this macro if | |
e9a25f70 | 7265 | you want to control one-only symbol support with a compiler flag, or if |
feca2ed3 JW |
7266 | setting the @code{DECL_ONE_ONLY} flag is enough to mark a declaration to |
7267 | be emitted as one-only. | |
a2c4f8e0 | 7268 | @end defmac |
feca2ed3 | 7269 | |
93638d7a AM |
7270 | @deftypefn {Target Hook} void TARGET_ASM_ASSEMBLE_VISIBILITY (tree @var{decl}, const char *@var{visibility}) |
7271 | This target hook is a function to output to @var{asm_out_file} some | |
7272 | commands that will make the symbol(s) associated with @var{decl} have | |
7273 | hidden, protected or internal visibility as specified by @var{visibility}. | |
7274 | @end deftypefn | |
7275 | ||
0524c91d | 7276 | @defmac TARGET_WEAK_NOT_IN_ARCHIVE_TOC |
4746cf84 | 7277 | A C expression that evaluates to true if the target's linker expects |
0524c91d | 7278 | that weak symbols do not appear in a static archive's table of contents. |
f676971a | 7279 | The default is @code{0}. |
0524c91d MA |
7280 | |
7281 | Leaving weak symbols out of an archive's table of contents means that, | |
7282 | if a symbol will only have a definition in one translation unit and | |
7283 | will have undefined references from other translation units, that | |
7284 | symbol should not be weak. Defining this macro to be nonzero will | |
7285 | thus have the effect that certain symbols that would normally be weak | |
7286 | (explicit template instantiations, and vtables for polymorphic classes | |
7287 | with noninline key methods) will instead be nonweak. | |
7288 | ||
7289 | The C++ ABI requires this macro to be zero. Define this macro for | |
7290 | targets where full C++ ABI compliance is impossible and where linker | |
7291 | restrictions require weak symbols to be left out of a static archive's | |
7292 | table of contents. | |
4746cf84 MA |
7293 | @end defmac |
7294 | ||
a2c4f8e0 | 7295 | @defmac ASM_OUTPUT_EXTERNAL (@var{stream}, @var{decl}, @var{name}) |
feca2ed3 JW |
7296 | A C statement (sans semicolon) to output to the stdio stream |
7297 | @var{stream} any text necessary for declaring the name of an external | |
7298 | symbol named @var{name} which is referenced in this compilation but | |
7299 | not defined. The value of @var{decl} is the tree node for the | |
7300 | declaration. | |
7301 | ||
7302 | This macro need not be defined if it does not need to output anything. | |
7303 | The GNU assembler and most Unix assemblers don't require anything. | |
a2c4f8e0 | 7304 | @end defmac |
feca2ed3 | 7305 | |
6773a41c RO |
7306 | @deftypefn {Target Hook} void TARGET_ASM_EXTERNAL_LIBCALL (rtx @var{symref}) |
7307 | This target hook is a function to output to @var{asm_out_file} an assembler | |
feca2ed3 | 7308 | pseudo-op to declare a library function name external. The name of the |
6773a41c RO |
7309 | library function is given by @var{symref}, which is a @code{symbol_ref}. |
7310 | @end deftypefn | |
feca2ed3 | 7311 | |
8e3e233b DP |
7312 | @deftypefn {Target Hook} void TARGET_ASM_MARK_DECL_PRESERVED (tree @var{decl}) |
7313 | This target hook is a function to output to @var{asm_out_file} an assembler | |
7314 | directive to annotate used symbol. Darwin target use .no_dead_code_strip | |
7315 | directive. | |
7316 | @end deftypefn | |
7317 | ||
a2c4f8e0 | 7318 | @defmac ASM_OUTPUT_LABELREF (@var{stream}, @var{name}) |
feca2ed3 JW |
7319 | A C statement (sans semicolon) to output to the stdio stream |
7320 | @var{stream} a reference in assembler syntax to a label named | |
7321 | @var{name}. This should add @samp{_} to the front of the name, if that | |
7322 | is customary on your operating system, as it is in most Berkeley Unix | |
7323 | systems. This macro is used in @code{assemble_name}. | |
a2c4f8e0 | 7324 | @end defmac |
feca2ed3 | 7325 | |
a2c4f8e0 | 7326 | @defmac ASM_OUTPUT_SYMBOL_REF (@var{stream}, @var{sym}) |
99c8c61c | 7327 | A C statement (sans semicolon) to output a reference to |
2f0b7af6 | 7328 | @code{SYMBOL_REF} @var{sym}. If not defined, @code{assemble_name} |
99c8c61c AO |
7329 | will be used to output the name of the symbol. This macro may be used |
7330 | to modify the way a symbol is referenced depending on information | |
fb49053f | 7331 | encoded by @code{TARGET_ENCODE_SECTION_INFO}. |
a2c4f8e0 | 7332 | @end defmac |
99c8c61c | 7333 | |
a2c4f8e0 | 7334 | @defmac ASM_OUTPUT_LABEL_REF (@var{stream}, @var{buf}) |
2f0b7af6 | 7335 | A C statement (sans semicolon) to output a reference to @var{buf}, the |
4226378a | 7336 | result of @code{ASM_GENERATE_INTERNAL_LABEL}. If not defined, |
2f0b7af6 GK |
7337 | @code{assemble_name} will be used to output the name of the symbol. |
7338 | This macro is not used by @code{output_asm_label}, or the @code{%l} | |
7339 | specifier that calls it; the intention is that this macro should be set | |
4226378a PK |
7340 | when it is necessary to output a label differently when its address is |
7341 | being taken. | |
a2c4f8e0 | 7342 | @end defmac |
2f0b7af6 | 7343 | |
4977bab6 ZW |
7344 | @deftypefn {Target Hook} void TARGET_ASM_INTERNAL_LABEL (FILE *@var{stream}, const char *@var{prefix}, unsigned long @var{labelno}) |
7345 | A function to output to the stdio stream @var{stream} a label whose | |
7346 | name is made from the string @var{prefix} and the number @var{labelno}. | |
feca2ed3 JW |
7347 | |
7348 | It is absolutely essential that these labels be distinct from the labels | |
7349 | used for user-level functions and variables. Otherwise, certain programs | |
7350 | will have name conflicts with internal labels. | |
7351 | ||
7352 | It is desirable to exclude internal labels from the symbol table of the | |
7353 | object file. Most assemblers have a naming convention for labels that | |
7354 | should be excluded; on many systems, the letter @samp{L} at the | |
7355 | beginning of a label has this effect. You should find out what | |
7356 | convention your system uses, and follow it. | |
7357 | ||
8a36672b | 7358 | The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}. |
4977bab6 | 7359 | @end deftypefn |
feca2ed3 | 7360 | |
a2c4f8e0 | 7361 | @defmac ASM_OUTPUT_DEBUG_LABEL (@var{stream}, @var{prefix}, @var{num}) |
8215347e JW |
7362 | A C statement to output to the stdio stream @var{stream} a debug info |
7363 | label whose name is made from the string @var{prefix} and the number | |
7364 | @var{num}. This is useful for VLIW targets, where debug info labels | |
7365 | may need to be treated differently than branch target labels. On some | |
7366 | systems, branch target labels must be at the beginning of instruction | |
7367 | bundles, but debug info labels can occur in the middle of instruction | |
7368 | bundles. | |
7369 | ||
4977bab6 | 7370 | If this macro is not defined, then @code{(*targetm.asm_out.internal_label)} will be |
8215347e | 7371 | used. |
a2c4f8e0 | 7372 | @end defmac |
8215347e | 7373 | |
a2c4f8e0 | 7374 | @defmac ASM_GENERATE_INTERNAL_LABEL (@var{string}, @var{prefix}, @var{num}) |
feca2ed3 JW |
7375 | A C statement to store into the string @var{string} a label whose name |
7376 | is made from the string @var{prefix} and the number @var{num}. | |
7377 | ||
7378 | This string, when output subsequently by @code{assemble_name}, should | |
4977bab6 | 7379 | produce the output that @code{(*targetm.asm_out.internal_label)} would produce |
feca2ed3 JW |
7380 | with the same @var{prefix} and @var{num}. |
7381 | ||
7382 | If the string begins with @samp{*}, then @code{assemble_name} will | |
7383 | output the rest of the string unchanged. It is often convenient for | |
7384 | @code{ASM_GENERATE_INTERNAL_LABEL} to use @samp{*} in this way. If the | |
7385 | string doesn't start with @samp{*}, then @code{ASM_OUTPUT_LABELREF} gets | |
7386 | to output the string, and may change it. (Of course, | |
7387 | @code{ASM_OUTPUT_LABELREF} is also part of your machine description, so | |
7388 | you should know what it does on your machine.) | |
a2c4f8e0 | 7389 | @end defmac |
feca2ed3 | 7390 | |
a2c4f8e0 | 7391 | @defmac ASM_FORMAT_PRIVATE_NAME (@var{outvar}, @var{name}, @var{number}) |
feca2ed3 JW |
7392 | A C expression to assign to @var{outvar} (which is a variable of type |
7393 | @code{char *}) a newly allocated string made from the string | |
7394 | @var{name} and the number @var{number}, with some suitable punctuation | |
7395 | added. Use @code{alloca} to get space for the string. | |
7396 | ||
7397 | The string will be used as an argument to @code{ASM_OUTPUT_LABELREF} to | |
7398 | produce an assembler label for an internal static variable whose name is | |
7399 | @var{name}. Therefore, the string must be such as to result in valid | |
7400 | assembler code. The argument @var{number} is different each time this | |
7401 | macro is executed; it prevents conflicts between similarly-named | |
7402 | internal static variables in different scopes. | |
7403 | ||
7404 | Ideally this string should not be a valid C identifier, to prevent any | |
7405 | conflict with the user's own symbols. Most assemblers allow periods | |
7406 | or percent signs in assembler symbols; putting at least one of these | |
7407 | between the name and the number will suffice. | |
7408 | ||
4977bab6 ZW |
7409 | If this macro is not defined, a default definition will be provided |
7410 | which is correct for most systems. | |
a2c4f8e0 | 7411 | @end defmac |
4977bab6 | 7412 | |
a2c4f8e0 | 7413 | @defmac ASM_OUTPUT_DEF (@var{stream}, @var{name}, @var{value}) |
feca2ed3 JW |
7414 | A C statement to output to the stdio stream @var{stream} assembler code |
7415 | which defines (equates) the symbol @var{name} to have the value @var{value}. | |
7416 | ||
203cb4ef | 7417 | @findex SET_ASM_OP |
aee96fe9 | 7418 | If @code{SET_ASM_OP} is defined, a default definition is provided which is |
feca2ed3 | 7419 | correct for most systems. |
a2c4f8e0 | 7420 | @end defmac |
810e3c45 | 7421 | |
a2c4f8e0 | 7422 | @defmac ASM_OUTPUT_DEF_FROM_DECLS (@var{stream}, @var{decl_of_name}, @var{decl_of_value}) |
e4faf1eb | 7423 | A C statement to output to the stdio stream @var{stream} assembler code |
3b7a2e58 | 7424 | which defines (equates) the symbol whose tree node is @var{decl_of_name} |
e4faf1eb NC |
7425 | to have the value of the tree node @var{decl_of_value}. This macro will |
7426 | be used in preference to @samp{ASM_OUTPUT_DEF} if it is defined and if | |
7427 | the tree nodes are available. | |
7428 | ||
203cb4ef | 7429 | @findex SET_ASM_OP |
aee96fe9 | 7430 | If @code{SET_ASM_OP} is defined, a default definition is provided which is |
956d6950 | 7431 | correct for most systems. |
a2c4f8e0 | 7432 | @end defmac |
956d6950 | 7433 | |
083b6717 JDA |
7434 | @defmac TARGET_DEFERRED_OUTPUT_DEFS (@var{decl_of_name}, @var{decl_of_value}) |
7435 | A C statement that evaluates to true if the assembler code which defines | |
7436 | (equates) the symbol whose tree node is @var{decl_of_name} to have the value | |
7437 | of the tree node @var{decl_of_value} should be emitted near the end of the | |
7438 | current compilation unit. The default is to not defer output of defines. | |
7439 | This macro affects defines output by @samp{ASM_OUTPUT_DEF} and | |
7440 | @samp{ASM_OUTPUT_DEF_FROM_DECLS}. | |
7441 | @end defmac | |
7442 | ||
a2c4f8e0 | 7443 | @defmac ASM_OUTPUT_WEAK_ALIAS (@var{stream}, @var{name}, @var{value}) |
810e3c45 JM |
7444 | A C statement to output to the stdio stream @var{stream} assembler code |
7445 | which defines (equates) the weak symbol @var{name} to have the value | |
3aa8ab7b L |
7446 | @var{value}. If @var{value} is @code{NULL}, it defines @var{name} as |
7447 | an undefined weak symbol. | |
810e3c45 JM |
7448 | |
7449 | Define this macro if the target only supports weak aliases; define | |
aee96fe9 | 7450 | @code{ASM_OUTPUT_DEF} instead if possible. |
a2c4f8e0 | 7451 | @end defmac |
810e3c45 | 7452 | |
a2c4f8e0 | 7453 | @defmac OBJC_GEN_METHOD_LABEL (@var{buf}, @var{is_inst}, @var{class_name}, @var{cat_name}, @var{sel_name}) |
feca2ed3 | 7454 | Define this macro to override the default assembler names used for |
2147b154 | 7455 | Objective-C methods. |
feca2ed3 JW |
7456 | |
7457 | The default name is a unique method number followed by the name of the | |
7458 | class (e.g.@: @samp{_1_Foo}). For methods in categories, the name of | |
7459 | the category is also included in the assembler name (e.g.@: | |
7460 | @samp{_1_Foo_Bar}). | |
7461 | ||
7462 | These names are safe on most systems, but make debugging difficult since | |
7463 | the method's selector is not present in the name. Therefore, particular | |
7464 | systems define other ways of computing names. | |
7465 | ||
7466 | @var{buf} is an expression of type @code{char *} which gives you a | |
7467 | buffer in which to store the name; its length is as long as | |
7468 | @var{class_name}, @var{cat_name} and @var{sel_name} put together, plus | |
7469 | 50 characters extra. | |
7470 | ||
7471 | The argument @var{is_inst} specifies whether the method is an instance | |
7472 | method or a class method; @var{class_name} is the name of the class; | |
59d42021 | 7473 | @var{cat_name} is the name of the category (or @code{NULL} if the method is not |
feca2ed3 JW |
7474 | in a category); and @var{sel_name} is the name of the selector. |
7475 | ||
7476 | On systems where the assembler can handle quoted names, you can use this | |
7477 | macro to provide more human-readable names. | |
a2c4f8e0 | 7478 | @end defmac |
28df0b5a | 7479 | |
a2c4f8e0 | 7480 | @defmac ASM_DECLARE_CLASS_REFERENCE (@var{stream}, @var{name}) |
f60b945b SS |
7481 | A C statement (sans semicolon) to output to the stdio stream |
7482 | @var{stream} commands to declare that the label @var{name} is an | |
7483 | Objective-C class reference. This is only needed for targets whose | |
7484 | linkers have special support for NeXT-style runtimes. | |
a2c4f8e0 | 7485 | @end defmac |
f60b945b | 7486 | |
a2c4f8e0 | 7487 | @defmac ASM_DECLARE_UNRESOLVED_REFERENCE (@var{stream}, @var{name}) |
28df0b5a SS |
7488 | A C statement (sans semicolon) to output to the stdio stream |
7489 | @var{stream} commands to declare that the label @var{name} is an | |
7490 | unresolved Objective-C class reference. This is only needed for targets | |
7491 | whose linkers have special support for NeXT-style runtimes. | |
a2c4f8e0 | 7492 | @end defmac |
feca2ed3 JW |
7493 | |
7494 | @node Initialization | |
7495 | @subsection How Initialization Functions Are Handled | |
7496 | @cindex initialization routines | |
7497 | @cindex termination routines | |
7498 | @cindex constructors, output of | |
7499 | @cindex destructors, output of | |
7500 | ||
7501 | The compiled code for certain languages includes @dfn{constructors} | |
7502 | (also called @dfn{initialization routines})---functions to initialize | |
7503 | data in the program when the program is started. These functions need | |
7504 | to be called before the program is ``started''---that is to say, before | |
7505 | @code{main} is called. | |
7506 | ||
7507 | Compiling some languages generates @dfn{destructors} (also called | |
7508 | @dfn{termination routines}) that should be called when the program | |
7509 | terminates. | |
7510 | ||
7511 | To make the initialization and termination functions work, the compiler | |
7512 | must output something in the assembler code to cause those functions to | |
7513 | be called at the appropriate time. When you port the compiler to a new | |
7514 | system, you need to specify how to do this. | |
7515 | ||
7516 | There are two major ways that GCC currently supports the execution of | |
7517 | initialization and termination functions. Each way has two variants. | |
7518 | Much of the structure is common to all four variations. | |
7519 | ||
7520 | @findex __CTOR_LIST__ | |
7521 | @findex __DTOR_LIST__ | |
7522 | The linker must build two lists of these functions---a list of | |
7523 | initialization functions, called @code{__CTOR_LIST__}, and a list of | |
7524 | termination functions, called @code{__DTOR_LIST__}. | |
7525 | ||
7526 | Each list always begins with an ignored function pointer (which may hold | |
7527 | 0, @minus{}1, or a count of the function pointers after it, depending on | |
7528 | the environment). This is followed by a series of zero or more function | |
7529 | pointers to constructors (or destructors), followed by a function | |
7530 | pointer containing zero. | |
7531 | ||
7532 | Depending on the operating system and its executable file format, either | |
7533 | @file{crtstuff.c} or @file{libgcc2.c} traverses these lists at startup | |
7534 | time and exit time. Constructors are called in reverse order of the | |
7535 | list; destructors in forward order. | |
7536 | ||
7537 | The best way to handle static constructors works only for object file | |
7538 | formats which provide arbitrarily-named sections. A section is set | |
7539 | aside for a list of constructors, and another for a list of destructors. | |
7540 | Traditionally these are called @samp{.ctors} and @samp{.dtors}. Each | |
7541 | object file that defines an initialization function also puts a word in | |
7542 | the constructor section to point to that function. The linker | |
7543 | accumulates all these words into one contiguous @samp{.ctors} section. | |
7544 | Termination functions are handled similarly. | |
7545 | ||
2cc07db4 RH |
7546 | This method will be chosen as the default by @file{target-def.h} if |
7547 | @code{TARGET_ASM_NAMED_SECTION} is defined. A target that does not | |
f282ffb3 | 7548 | support arbitrary sections, but does support special designated |
2cc07db4 RH |
7549 | constructor and destructor sections may define @code{CTORS_SECTION_ASM_OP} |
7550 | and @code{DTORS_SECTION_ASM_OP} to achieve the same effect. | |
feca2ed3 JW |
7551 | |
7552 | When arbitrary sections are available, there are two variants, depending | |
7553 | upon how the code in @file{crtstuff.c} is called. On systems that | |
2cc07db4 | 7554 | support a @dfn{.init} section which is executed at program startup, |
feca2ed3 | 7555 | parts of @file{crtstuff.c} are compiled into that section. The |
05739753 | 7556 | program is linked by the @command{gcc} driver like this: |
feca2ed3 | 7557 | |
3ab51846 | 7558 | @smallexample |
2cc07db4 | 7559 | ld -o @var{output_file} crti.o crtbegin.o @dots{} -lgcc crtend.o crtn.o |
3ab51846 | 7560 | @end smallexample |
feca2ed3 | 7561 | |
2cc07db4 RH |
7562 | The prologue of a function (@code{__init}) appears in the @code{.init} |
7563 | section of @file{crti.o}; the epilogue appears in @file{crtn.o}. Likewise | |
7564 | for the function @code{__fini} in the @dfn{.fini} section. Normally these | |
7565 | files are provided by the operating system or by the GNU C library, but | |
7566 | are provided by GCC for a few targets. | |
7567 | ||
7568 | The objects @file{crtbegin.o} and @file{crtend.o} are (for most targets) | |
7569 | compiled from @file{crtstuff.c}. They contain, among other things, code | |
7570 | fragments within the @code{.init} and @code{.fini} sections that branch | |
7571 | to routines in the @code{.text} section. The linker will pull all parts | |
7572 | of a section together, which results in a complete @code{__init} function | |
7573 | that invokes the routines we need at startup. | |
feca2ed3 JW |
7574 | |
7575 | To use this variant, you must define the @code{INIT_SECTION_ASM_OP} | |
7576 | macro properly. | |
7577 | ||
2cc07db4 RH |
7578 | If no init section is available, when GCC compiles any function called |
7579 | @code{main} (or more accurately, any function designated as a program | |
7580 | entry point by the language front end calling @code{expand_main_function}), | |
7581 | it inserts a procedure call to @code{__main} as the first executable code | |
7582 | after the function prologue. The @code{__main} function is defined | |
7583 | in @file{libgcc2.c} and runs the global constructors. | |
feca2ed3 JW |
7584 | |
7585 | In file formats that don't support arbitrary sections, there are again | |
7586 | two variants. In the simplest variant, the GNU linker (GNU @code{ld}) | |
7587 | and an `a.out' format must be used. In this case, | |
2cc07db4 | 7588 | @code{TARGET_ASM_CONSTRUCTOR} is defined to produce a @code{.stabs} |
feca2ed3 JW |
7589 | entry of type @samp{N_SETT}, referencing the name @code{__CTOR_LIST__}, |
7590 | and with the address of the void function containing the initialization | |
7591 | code as its value. The GNU linker recognizes this as a request to add | |
2cc07db4 | 7592 | the value to a @dfn{set}; the values are accumulated, and are eventually |
feca2ed3 JW |
7593 | placed in the executable as a vector in the format described above, with |
7594 | a leading (ignored) count and a trailing zero element. | |
2cc07db4 | 7595 | @code{TARGET_ASM_DESTRUCTOR} is handled similarly. Since no init |
feca2ed3 JW |
7596 | section is available, the absence of @code{INIT_SECTION_ASM_OP} causes |
7597 | the compilation of @code{main} to call @code{__main} as above, starting | |
7598 | the initialization process. | |
7599 | ||
7600 | The last variant uses neither arbitrary sections nor the GNU linker. | |
7601 | This is preferable when you want to do dynamic linking and when using | |
161d7b59 | 7602 | file formats which the GNU linker does not support, such as `ECOFF'@. In |
2cc07db4 RH |
7603 | this case, @code{TARGET_HAVE_CTORS_DTORS} is false, initialization and |
7604 | termination functions are recognized simply by their names. This requires | |
7605 | an extra program in the linkage step, called @command{collect2}. This program | |
7606 | pretends to be the linker, for use with GCC; it does its job by running | |
7607 | the ordinary linker, but also arranges to include the vectors of | |
7608 | initialization and termination functions. These functions are called | |
7609 | via @code{__main} as described above. In order to use this method, | |
7610 | @code{use_collect2} must be defined in the target in @file{config.gcc}. | |
feca2ed3 JW |
7611 | |
7612 | @ifinfo | |
7613 | The following section describes the specific macros that control and | |
7614 | customize the handling of initialization and termination functions. | |
7615 | @end ifinfo | |
7616 | ||
7617 | @node Macros for Initialization | |
7618 | @subsection Macros Controlling Initialization Routines | |
7619 | ||
7620 | Here are the macros that control how the compiler handles initialization | |
7621 | and termination functions: | |
7622 | ||
a2c4f8e0 | 7623 | @defmac INIT_SECTION_ASM_OP |
047c1c92 HPN |
7624 | If defined, a C string constant, including spacing, for the assembler |
7625 | operation to identify the following data as initialization code. If not | |
7626 | defined, GCC will assume such a section does not exist. When you are | |
7627 | using special sections for initialization and termination functions, this | |
7628 | macro also controls how @file{crtstuff.c} and @file{libgcc2.c} arrange to | |
7629 | run the initialization functions. | |
a2c4f8e0 | 7630 | @end defmac |
feca2ed3 | 7631 | |
a2c4f8e0 | 7632 | @defmac HAS_INIT_SECTION |
feca2ed3 | 7633 | If defined, @code{main} will not call @code{__main} as described above. |
2cc07db4 RH |
7634 | This macro should be defined for systems that control start-up code |
7635 | on a symbol-by-symbol basis, such as OSF/1, and should not | |
7636 | be defined explicitly for systems that support @code{INIT_SECTION_ASM_OP}. | |
a2c4f8e0 | 7637 | @end defmac |
feca2ed3 | 7638 | |
a2c4f8e0 | 7639 | @defmac LD_INIT_SWITCH |
feca2ed3 JW |
7640 | If defined, a C string constant for a switch that tells the linker that |
7641 | the following symbol is an initialization routine. | |
a2c4f8e0 | 7642 | @end defmac |
feca2ed3 | 7643 | |
a2c4f8e0 | 7644 | @defmac LD_FINI_SWITCH |
feca2ed3 JW |
7645 | If defined, a C string constant for a switch that tells the linker that |
7646 | the following symbol is a finalization routine. | |
a2c4f8e0 | 7647 | @end defmac |
feca2ed3 | 7648 | |
a2c4f8e0 | 7649 | @defmac COLLECT_SHARED_INIT_FUNC (@var{stream}, @var{func}) |
414e05cf RE |
7650 | If defined, a C statement that will write a function that can be |
7651 | automatically called when a shared library is loaded. The function | |
7652 | should call @var{func}, which takes no arguments. If not defined, and | |
7653 | the object format requires an explicit initialization function, then a | |
172270b3 | 7654 | function called @code{_GLOBAL__DI} will be generated. |
414e05cf RE |
7655 | |
7656 | This function and the following one are used by collect2 when linking a | |
f282ffb3 | 7657 | shared library that needs constructors or destructors, or has DWARF2 |
414e05cf | 7658 | exception tables embedded in the code. |
a2c4f8e0 | 7659 | @end defmac |
414e05cf | 7660 | |
a2c4f8e0 | 7661 | @defmac COLLECT_SHARED_FINI_FUNC (@var{stream}, @var{func}) |
414e05cf RE |
7662 | If defined, a C statement that will write a function that can be |
7663 | automatically called when a shared library is unloaded. The function | |
7664 | should call @var{func}, which takes no arguments. If not defined, and | |
7665 | the object format requires an explicit finalization function, then a | |
172270b3 | 7666 | function called @code{_GLOBAL__DD} will be generated. |
a2c4f8e0 | 7667 | @end defmac |
414e05cf | 7668 | |
a2c4f8e0 | 7669 | @defmac INVOKE__main |
feca2ed3 JW |
7670 | If defined, @code{main} will call @code{__main} despite the presence of |
7671 | @code{INIT_SECTION_ASM_OP}. This macro should be defined for systems | |
7672 | where the init section is not actually run automatically, but is still | |
7673 | useful for collecting the lists of constructors and destructors. | |
a2c4f8e0 | 7674 | @end defmac |
feca2ed3 | 7675 | |
a2c4f8e0 | 7676 | @defmac SUPPORTS_INIT_PRIORITY |
ea4f1fce JO |
7677 | If nonzero, the C++ @code{init_priority} attribute is supported and the |
7678 | compiler should emit instructions to control the order of initialization | |
7679 | of objects. If zero, the compiler will issue an error message upon | |
7680 | encountering an @code{init_priority} attribute. | |
a2c4f8e0 | 7681 | @end defmac |
2cc07db4 RH |
7682 | |
7683 | @deftypefn {Target Hook} bool TARGET_HAVE_CTORS_DTORS | |
7684 | This value is true if the target supports some ``native'' method of | |
7685 | collecting constructors and destructors to be run at startup and exit. | |
7686 | It is false if we must use @command{collect2}. | |
7687 | @end deftypefn | |
7688 | ||
7689 | @deftypefn {Target Hook} void TARGET_ASM_CONSTRUCTOR (rtx @var{symbol}, int @var{priority}) | |
7690 | If defined, a function that outputs assembler code to arrange to call | |
7691 | the function referenced by @var{symbol} at initialization time. | |
ea4f1fce | 7692 | |
2cc07db4 RH |
7693 | Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking |
7694 | no arguments and with no return value. If the target supports initialization | |
7695 | priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY}; | |
7696 | otherwise it must be @code{DEFAULT_INIT_PRIORITY}. | |
7697 | ||
14976c58 | 7698 | If this macro is not defined by the target, a suitable default will |
2cc07db4 RH |
7699 | be chosen if (1) the target supports arbitrary section names, (2) the |
7700 | target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2} | |
7701 | is not defined. | |
7702 | @end deftypefn | |
7703 | ||
7704 | @deftypefn {Target Hook} void TARGET_ASM_DESTRUCTOR (rtx @var{symbol}, int @var{priority}) | |
7705 | This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination | |
feca2ed3 | 7706 | functions rather than initialization functions. |
2cc07db4 | 7707 | @end deftypefn |
14686fcd | 7708 | |
2cc07db4 RH |
7709 | If @code{TARGET_HAVE_CTORS_DTORS} is true, the initialization routine |
7710 | generated for the generated object file will have static linkage. | |
feca2ed3 | 7711 | |
2cc07db4 RH |
7712 | If your system uses @command{collect2} as the means of processing |
7713 | constructors, then that program normally uses @command{nm} to scan | |
7714 | an object file for constructor functions to be called. | |
14686fcd | 7715 | |
4a023207 | 7716 | On certain kinds of systems, you can define this macro to make |
2cc07db4 | 7717 | @command{collect2} work faster (and, in some cases, make it work at all): |
feca2ed3 | 7718 | |
a2c4f8e0 | 7719 | @defmac OBJECT_FORMAT_COFF |
feca2ed3 | 7720 | Define this macro if the system uses COFF (Common Object File Format) |
2cc07db4 | 7721 | object files, so that @command{collect2} can assume this format and scan |
feca2ed3 | 7722 | object files directly for dynamic constructor/destructor functions. |
feca2ed3 | 7723 | |
4a023207 | 7724 | This macro is effective only in a native compiler; @command{collect2} as |
2cc07db4 | 7725 | part of a cross compiler always uses @command{nm} for the target machine. |
a2c4f8e0 | 7726 | @end defmac |
feca2ed3 | 7727 | |
a2c4f8e0 | 7728 | @defmac REAL_NM_FILE_NAME |
feca2ed3 | 7729 | Define this macro as a C string constant containing the file name to use |
2cc07db4 RH |
7730 | to execute @command{nm}. The default is to search the path normally for |
7731 | @command{nm}. | |
feca2ed3 JW |
7732 | |
7733 | If your system supports shared libraries and has a program to list the | |
7734 | dynamic dependencies of a given library or executable, you can define | |
7735 | these macros to enable support for running initialization and | |
7736 | termination functions in shared libraries: | |
a2c4f8e0 | 7737 | @end defmac |
feca2ed3 | 7738 | |
a2c4f8e0 | 7739 | @defmac LDD_SUFFIX |
2cc07db4 RH |
7740 | Define this macro to a C string constant containing the name of the program |
7741 | which lists dynamic dependencies, like @command{"ldd"} under SunOS 4. | |
a2c4f8e0 | 7742 | @end defmac |
feca2ed3 | 7743 | |
a2c4f8e0 | 7744 | @defmac PARSE_LDD_OUTPUT (@var{ptr}) |
feca2ed3 | 7745 | Define this macro to be C code that extracts filenames from the output |
aee96fe9 | 7746 | of the program denoted by @code{LDD_SUFFIX}. @var{ptr} is a variable |
feca2ed3 JW |
7747 | of type @code{char *} that points to the beginning of a line of output |
7748 | from @code{LDD_SUFFIX}. If the line lists a dynamic dependency, the | |
aee96fe9 JM |
7749 | code must advance @var{ptr} to the beginning of the filename on that |
7750 | line. Otherwise, it must set @var{ptr} to @code{NULL}. | |
a2c4f8e0 | 7751 | @end defmac |
feca2ed3 JW |
7752 | |
7753 | @node Instruction Output | |
7754 | @subsection Output of Assembler Instructions | |
7755 | ||
7756 | @c prevent bad page break with this line | |
7757 | This describes assembler instruction output. | |
7758 | ||
a2c4f8e0 | 7759 | @defmac REGISTER_NAMES |
feca2ed3 JW |
7760 | A C initializer containing the assembler's names for the machine |
7761 | registers, each one as a C string constant. This is what translates | |
7762 | register numbers in the compiler into assembler language. | |
a2c4f8e0 | 7763 | @end defmac |
feca2ed3 | 7764 | |
a2c4f8e0 | 7765 | @defmac ADDITIONAL_REGISTER_NAMES |
feca2ed3 JW |
7766 | If defined, a C initializer for an array of structures containing a name |
7767 | and a register number. This macro defines additional names for hard | |
7768 | registers, thus allowing the @code{asm} option in declarations to refer | |
7769 | to registers using alternate names. | |
a2c4f8e0 | 7770 | @end defmac |
feca2ed3 | 7771 | |
a2c4f8e0 | 7772 | @defmac ASM_OUTPUT_OPCODE (@var{stream}, @var{ptr}) |
feca2ed3 JW |
7773 | Define this macro if you are using an unusual assembler that |
7774 | requires different names for the machine instructions. | |
7775 | ||
7776 | The definition is a C statement or statements which output an | |
7777 | assembler instruction opcode to the stdio stream @var{stream}. The | |
7778 | macro-operand @var{ptr} is a variable of type @code{char *} which | |
7779 | points to the opcode name in its ``internal'' form---the form that is | |
7780 | written in the machine description. The definition should output the | |
7781 | opcode name to @var{stream}, performing any translation you desire, and | |
7782 | increment the variable @var{ptr} to point at the end of the opcode | |
7783 | so that it will not be output twice. | |
7784 | ||
7785 | In fact, your macro definition may process less than the entire opcode | |
7786 | name, or more than the opcode name; but if you want to process text | |
7787 | that includes @samp{%}-sequences to substitute operands, you must take | |
7788 | care of the substitution yourself. Just be sure to increment | |
7789 | @var{ptr} over whatever text should not be output normally. | |
7790 | ||
37bef197 | 7791 | @findex recog_data.operand |
feca2ed3 | 7792 | If you need to look at the operand values, they can be found as the |
37bef197 | 7793 | elements of @code{recog_data.operand}. |
feca2ed3 JW |
7794 | |
7795 | If the macro definition does nothing, the instruction is output | |
7796 | in the usual way. | |
a2c4f8e0 | 7797 | @end defmac |
feca2ed3 | 7798 | |
a2c4f8e0 | 7799 | @defmac FINAL_PRESCAN_INSN (@var{insn}, @var{opvec}, @var{noperands}) |
feca2ed3 JW |
7800 | If defined, a C statement to be executed just prior to the output of |
7801 | assembler code for @var{insn}, to modify the extracted operands so | |
7802 | they will be output differently. | |
7803 | ||
7804 | Here the argument @var{opvec} is the vector containing the operands | |
7805 | extracted from @var{insn}, and @var{noperands} is the number of | |
7806 | elements of the vector which contain meaningful data for this insn. | |
7807 | The contents of this vector are what will be used to convert the insn | |
7808 | template into assembler code, so you can change the assembler output | |
7809 | by changing the contents of the vector. | |
7810 | ||
7811 | This macro is useful when various assembler syntaxes share a single | |
7812 | file of instruction patterns; by defining this macro differently, you | |
7813 | can cause a large class of instructions to be output differently (such | |
7814 | as with rearranged operands). Naturally, variations in assembler | |
7815 | syntax affecting individual insn patterns ought to be handled by | |
7816 | writing conditional output routines in those patterns. | |
7817 | ||
7818 | If this macro is not defined, it is equivalent to a null statement. | |
a2c4f8e0 | 7819 | @end defmac |
feca2ed3 | 7820 | |
a2c4f8e0 | 7821 | @defmac PRINT_OPERAND (@var{stream}, @var{x}, @var{code}) |
feca2ed3 JW |
7822 | A C compound statement to output to stdio stream @var{stream} the |
7823 | assembler syntax for an instruction operand @var{x}. @var{x} is an | |
7824 | RTL expression. | |
7825 | ||
7826 | @var{code} is a value that can be used to specify one of several ways | |
7827 | of printing the operand. It is used when identical operands must be | |
7828 | printed differently depending on the context. @var{code} comes from | |
7829 | the @samp{%} specification that was used to request printing of the | |
7830 | operand. If the specification was just @samp{%@var{digit}} then | |
7831 | @var{code} is 0; if the specification was @samp{%@var{ltr} | |
7832 | @var{digit}} then @var{code} is the ASCII code for @var{ltr}. | |
7833 | ||
7834 | @findex reg_names | |
7835 | If @var{x} is a register, this macro should print the register's name. | |
7836 | The names can be found in an array @code{reg_names} whose type is | |
7837 | @code{char *[]}. @code{reg_names} is initialized from | |
7838 | @code{REGISTER_NAMES}. | |
7839 | ||
7840 | When the machine description has a specification @samp{%@var{punct}} | |
7841 | (a @samp{%} followed by a punctuation character), this macro is called | |
7842 | with a null pointer for @var{x} and the punctuation character for | |
7843 | @var{code}. | |
a2c4f8e0 | 7844 | @end defmac |
feca2ed3 | 7845 | |
a2c4f8e0 | 7846 | @defmac PRINT_OPERAND_PUNCT_VALID_P (@var{code}) |
feca2ed3 JW |
7847 | A C expression which evaluates to true if @var{code} is a valid |
7848 | punctuation character for use in the @code{PRINT_OPERAND} macro. If | |
7849 | @code{PRINT_OPERAND_PUNCT_VALID_P} is not defined, it means that no | |
7850 | punctuation characters (except for the standard one, @samp{%}) are used | |
7851 | in this way. | |
a2c4f8e0 | 7852 | @end defmac |
feca2ed3 | 7853 | |
a2c4f8e0 | 7854 | @defmac PRINT_OPERAND_ADDRESS (@var{stream}, @var{x}) |
feca2ed3 JW |
7855 | A C compound statement to output to stdio stream @var{stream} the |
7856 | assembler syntax for an instruction operand that is a memory reference | |
7857 | whose address is @var{x}. @var{x} is an RTL expression. | |
7858 | ||
fb49053f | 7859 | @cindex @code{TARGET_ENCODE_SECTION_INFO} usage |
feca2ed3 | 7860 | On some machines, the syntax for a symbolic address depends on the |
fb49053f RH |
7861 | section that the address refers to. On these machines, define the hook |
7862 | @code{TARGET_ENCODE_SECTION_INFO} to store the information into the | |
a2c4f8e0 ZW |
7863 | @code{symbol_ref}, and then check for it here. @xref{Assembler |
7864 | Format}. | |
7865 | @end defmac | |
feca2ed3 | 7866 | |
feca2ed3 | 7867 | @findex dbr_sequence_length |
a2c4f8e0 | 7868 | @defmac DBR_OUTPUT_SEQEND (@var{file}) |
feca2ed3 JW |
7869 | A C statement, to be executed after all slot-filler instructions have |
7870 | been output. If necessary, call @code{dbr_sequence_length} to | |
7871 | determine the number of slots filled in a sequence (zero if not | |
7872 | currently outputting a sequence), to decide how many no-ops to output, | |
7873 | or whatever. | |
7874 | ||
7875 | Don't define this macro if it has nothing to do, but it is helpful in | |
7876 | reading assembly output if the extent of the delay sequence is made | |
e979f9e8 | 7877 | explicit (e.g.@: with white space). |
a2c4f8e0 | 7878 | @end defmac |
feca2ed3 JW |
7879 | |
7880 | @findex final_sequence | |
7881 | Note that output routines for instructions with delay slots must be | |
e979f9e8 JM |
7882 | prepared to deal with not being output as part of a sequence |
7883 | (i.e.@: when the scheduling pass is not run, or when no slot fillers could be | |
feca2ed3 JW |
7884 | found.) The variable @code{final_sequence} is null when not |
7885 | processing a sequence, otherwise it contains the @code{sequence} rtx | |
7886 | being output. | |
7887 | ||
feca2ed3 | 7888 | @findex asm_fprintf |
a2c4f8e0 ZW |
7889 | @defmac REGISTER_PREFIX |
7890 | @defmacx LOCAL_LABEL_PREFIX | |
7891 | @defmacx USER_LABEL_PREFIX | |
7892 | @defmacx IMMEDIATE_PREFIX | |
feca2ed3 JW |
7893 | If defined, C string expressions to be used for the @samp{%R}, @samp{%L}, |
7894 | @samp{%U}, and @samp{%I} options of @code{asm_fprintf} (see | |
7895 | @file{final.c}). These are useful when a single @file{md} file must | |
7896 | support multiple assembler formats. In that case, the various @file{tm.h} | |
7897 | files can define these macros differently. | |
a2c4f8e0 | 7898 | @end defmac |
feca2ed3 | 7899 | |
a2c4f8e0 | 7900 | @defmac ASM_FPRINTF_EXTENSIONS (@var{file}, @var{argptr}, @var{format}) |
3b7a2e58 | 7901 | If defined this macro should expand to a series of @code{case} |
fe0503ea NC |
7902 | statements which will be parsed inside the @code{switch} statement of |
7903 | the @code{asm_fprintf} function. This allows targets to define extra | |
7904 | printf formats which may useful when generating their assembler | |
4bd0bee9 | 7905 | statements. Note that uppercase letters are reserved for future |
fe0503ea NC |
7906 | generic extensions to asm_fprintf, and so are not available to target |
7907 | specific code. The output file is given by the parameter @var{file}. | |
7908 | The varargs input pointer is @var{argptr} and the rest of the format | |
7909 | string, starting the character after the one that is being switched | |
7910 | upon, is pointed to by @var{format}. | |
a2c4f8e0 | 7911 | @end defmac |
fe0503ea | 7912 | |
a2c4f8e0 | 7913 | @defmac ASSEMBLER_DIALECT |
feca2ed3 JW |
7914 | If your target supports multiple dialects of assembler language (such as |
7915 | different opcodes), define this macro as a C expression that gives the | |
7916 | numeric index of the assembler language dialect to use, with zero as the | |
7917 | first variant. | |
7918 | ||
7919 | If this macro is defined, you may use constructs of the form | |
c237e94a | 7920 | @smallexample |
f282ffb3 | 7921 | @samp{@{option0|option1|option2@dots{}@}} |
c237e94a ZW |
7922 | @end smallexample |
7923 | @noindent | |
7924 | in the output templates of patterns (@pxref{Output Template}) or in the | |
7925 | first argument of @code{asm_fprintf}. This construct outputs | |
7926 | @samp{option0}, @samp{option1}, @samp{option2}, etc., if the value of | |
7927 | @code{ASSEMBLER_DIALECT} is zero, one, two, etc. Any special characters | |
7928 | within these strings retain their usual meaning. If there are fewer | |
7929 | alternatives within the braces than the value of | |
7930 | @code{ASSEMBLER_DIALECT}, the construct outputs nothing. | |
feca2ed3 JW |
7931 | |
7932 | If you do not define this macro, the characters @samp{@{}, @samp{|} and | |
7933 | @samp{@}} do not have any special meaning when used in templates or | |
7934 | operands to @code{asm_fprintf}. | |
7935 | ||
7936 | Define the macros @code{REGISTER_PREFIX}, @code{LOCAL_LABEL_PREFIX}, | |
7937 | @code{USER_LABEL_PREFIX} and @code{IMMEDIATE_PREFIX} if you can express | |
e5e809f4 | 7938 | the variations in assembler language syntax with that mechanism. Define |
feca2ed3 JW |
7939 | @code{ASSEMBLER_DIALECT} and use the @samp{@{option0|option1@}} syntax |
7940 | if the syntax variant are larger and involve such things as different | |
7941 | opcodes or operand order. | |
a2c4f8e0 | 7942 | @end defmac |
feca2ed3 | 7943 | |
a2c4f8e0 | 7944 | @defmac ASM_OUTPUT_REG_PUSH (@var{stream}, @var{regno}) |
feca2ed3 JW |
7945 | A C expression to output to @var{stream} some assembler code |
7946 | which will push hard register number @var{regno} onto the stack. | |
7947 | The code need not be optimal, since this macro is used only when | |
7948 | profiling. | |
a2c4f8e0 | 7949 | @end defmac |
feca2ed3 | 7950 | |
a2c4f8e0 | 7951 | @defmac ASM_OUTPUT_REG_POP (@var{stream}, @var{regno}) |
feca2ed3 JW |
7952 | A C expression to output to @var{stream} some assembler code |
7953 | which will pop hard register number @var{regno} off of the stack. | |
7954 | The code need not be optimal, since this macro is used only when | |
7955 | profiling. | |
a2c4f8e0 | 7956 | @end defmac |
feca2ed3 JW |
7957 | |
7958 | @node Dispatch Tables | |
7959 | @subsection Output of Dispatch Tables | |
7960 | ||
7961 | @c prevent bad page break with this line | |
7962 | This concerns dispatch tables. | |
7963 | ||
feca2ed3 | 7964 | @cindex dispatch table |
a2c4f8e0 | 7965 | @defmac ASM_OUTPUT_ADDR_DIFF_ELT (@var{stream}, @var{body}, @var{value}, @var{rel}) |
feca2ed3 JW |
7966 | A C statement to output to the stdio stream @var{stream} an assembler |
7967 | pseudo-instruction to generate a difference between two labels. | |
7968 | @var{value} and @var{rel} are the numbers of two internal labels. The | |
7969 | definitions of these labels are output using | |
4977bab6 | 7970 | @code{(*targetm.asm_out.internal_label)}, and they must be printed in the same |
feca2ed3 JW |
7971 | way here. For example, |
7972 | ||
3ab51846 | 7973 | @smallexample |
feca2ed3 JW |
7974 | fprintf (@var{stream}, "\t.word L%d-L%d\n", |
7975 | @var{value}, @var{rel}) | |
3ab51846 | 7976 | @end smallexample |
feca2ed3 JW |
7977 | |
7978 | You must provide this macro on machines where the addresses in a | |
f0523f02 | 7979 | dispatch table are relative to the table's own address. If defined, GCC |
161d7b59 | 7980 | will also use this macro on all machines when producing PIC@. |
aee96fe9 | 7981 | @var{body} is the body of the @code{ADDR_DIFF_VEC}; it is provided so that the |
33f7f353 | 7982 | mode and flags can be read. |
a2c4f8e0 | 7983 | @end defmac |
feca2ed3 | 7984 | |
a2c4f8e0 | 7985 | @defmac ASM_OUTPUT_ADDR_VEC_ELT (@var{stream}, @var{value}) |
feca2ed3 JW |
7986 | This macro should be provided on machines where the addresses |
7987 | in a dispatch table are absolute. | |
7988 | ||
7989 | The definition should be a C statement to output to the stdio stream | |
7990 | @var{stream} an assembler pseudo-instruction to generate a reference to | |
7991 | a label. @var{value} is the number of an internal label whose | |
4977bab6 | 7992 | definition is output using @code{(*targetm.asm_out.internal_label)}. |
feca2ed3 JW |
7993 | For example, |
7994 | ||
3ab51846 | 7995 | @smallexample |
feca2ed3 | 7996 | fprintf (@var{stream}, "\t.word L%d\n", @var{value}) |
3ab51846 | 7997 | @end smallexample |
a2c4f8e0 | 7998 | @end defmac |
feca2ed3 | 7999 | |
a2c4f8e0 | 8000 | @defmac ASM_OUTPUT_CASE_LABEL (@var{stream}, @var{prefix}, @var{num}, @var{table}) |
feca2ed3 JW |
8001 | Define this if the label before a jump-table needs to be output |
8002 | specially. The first three arguments are the same as for | |
4977bab6 | 8003 | @code{(*targetm.asm_out.internal_label)}; the fourth argument is the |
feca2ed3 JW |
8004 | jump-table which follows (a @code{jump_insn} containing an |
8005 | @code{addr_vec} or @code{addr_diff_vec}). | |
8006 | ||
8007 | This feature is used on system V to output a @code{swbeg} statement | |
8008 | for the table. | |
8009 | ||
8010 | If this macro is not defined, these labels are output with | |
4977bab6 | 8011 | @code{(*targetm.asm_out.internal_label)}. |
a2c4f8e0 | 8012 | @end defmac |
feca2ed3 | 8013 | |
a2c4f8e0 | 8014 | @defmac ASM_OUTPUT_CASE_END (@var{stream}, @var{num}, @var{table}) |
feca2ed3 JW |
8015 | Define this if something special must be output at the end of a |
8016 | jump-table. The definition should be a C statement to be executed | |
8017 | after the assembler code for the table is written. It should write | |
8018 | the appropriate code to stdio stream @var{stream}. The argument | |
8019 | @var{table} is the jump-table insn, and @var{num} is the label-number | |
8020 | of the preceding label. | |
8021 | ||
8022 | If this macro is not defined, nothing special is output at the end of | |
8023 | the jump-table. | |
a2c4f8e0 | 8024 | @end defmac |
feca2ed3 | 8025 | |
eeab4d81 | 8026 | @deftypefn {Target Hook} void TARGET_ASM_EMIT_UNWIND_LABEL (@var{stream}, @var{decl}, @var{for_eh}, @var{empty}) |
8a36672b | 8027 | This target hook emits a label at the beginning of each FDE@. It |
4746cf84 MA |
8028 | should be defined on targets where FDEs need special labels, and it |
8029 | should write the appropriate label, for the FDE associated with the | |
8030 | function declaration @var{decl}, to the stdio stream @var{stream}. | |
eeab4d81 MS |
8031 | The third argument, @var{for_eh}, is a boolean: true if this is for an |
8032 | exception table. The fourth argument, @var{empty}, is a boolean: | |
8a36672b | 8033 | true if this is a placeholder label for an omitted FDE@. |
4746cf84 MA |
8034 | |
8035 | The default is that FDEs are not given nonlocal labels. | |
8036 | @end deftypefn | |
8037 | ||
083cad55 EC |
8038 | @deftypefn {Target Hook} void TARGET_ASM_EMIT_EXCEPT_TABLE_LABEL (@var{stream}) |
8039 | This target hook emits a label at the beginning of the exception table. | |
8040 | It should be defined on targets where it is desirable for the table | |
8041 | to be broken up according to function. | |
8042 | ||
8043 | The default is that no label is emitted. | |
8044 | @end deftypefn | |
8045 | ||
8046 | @deftypefn {Target Hook} void TARGET_UNWIND_EMIT (FILE * @var{stream}, rtx @var{insn}) | |
951120ea PB |
8047 | This target hook emits and assembly directives required to unwind the |
8048 | given instruction. This is only used when TARGET_UNWIND_INFO is set. | |
8049 | @end deftypefn | |
8050 | ||
02f52e19 | 8051 | @node Exception Region Output |
feca2ed3 JW |
8052 | @subsection Assembler Commands for Exception Regions |
8053 | ||
8054 | @c prevent bad page break with this line | |
8055 | ||
8056 | This describes commands marking the start and the end of an exception | |
8057 | region. | |
8058 | ||
a2c4f8e0 | 8059 | @defmac EH_FRAME_SECTION_NAME |
7c262518 RH |
8060 | If defined, a C string constant for the name of the section containing |
8061 | exception handling frame unwind information. If not defined, GCC will | |
8062 | provide a default definition if the target supports named sections. | |
8063 | @file{crtstuff.c} uses this macro to switch to the appropriate section. | |
0021b564 JM |
8064 | |
8065 | You should define this symbol if your target supports DWARF 2 frame | |
8066 | unwind information and the default definition does not work. | |
a2c4f8e0 | 8067 | @end defmac |
0021b564 | 8068 | |
a2c4f8e0 | 8069 | @defmac EH_FRAME_IN_DATA_SECTION |
02c9b1ca RH |
8070 | If defined, DWARF 2 frame unwind information will be placed in the |
8071 | data section even though the target supports named sections. This | |
8072 | might be necessary, for instance, if the system linker does garbage | |
8073 | collection and sections cannot be marked as not to be collected. | |
8074 | ||
8075 | Do not define this macro unless @code{TARGET_ASM_NAMED_SECTION} is | |
8076 | also defined. | |
a2c4f8e0 | 8077 | @end defmac |
02c9b1ca | 8078 | |
1a35e62d MM |
8079 | @defmac EH_TABLES_CAN_BE_READ_ONLY |
8080 | Define this macro to 1 if your target is such that no frame unwind | |
8081 | information encoding used with non-PIC code will ever require a | |
8082 | runtime relocation, but the linker may not support merging read-only | |
8083 | and read-write sections into a single read-write section. | |
8084 | @end defmac | |
8085 | ||
a2c4f8e0 | 8086 | @defmac MASK_RETURN_ADDR |
aee96fe9 | 8087 | An rtx used to mask the return address found via @code{RETURN_ADDR_RTX}, so |
feca2ed3 | 8088 | that it does not contain any extraneous set bits in it. |
a2c4f8e0 | 8089 | @end defmac |
0021b564 | 8090 | |
a2c4f8e0 | 8091 | @defmac DWARF2_UNWIND_INFO |
0021b564 JM |
8092 | Define this macro to 0 if your target supports DWARF 2 frame unwind |
8093 | information, but it does not yet work with exception handling. | |
8094 | Otherwise, if your target supports this information (if it defines | |
8095 | @samp{INCOMING_RETURN_ADDR_RTX} and either @samp{UNALIGNED_INT_ASM_OP} | |
4f6c2131 | 8096 | or @samp{OBJECT_FORMAT_ELF}), GCC will provide a default definition of 1. |
0021b564 | 8097 | |
5cf58f28 PB |
8098 | If @code{TARGET_UNWIND_INFO} is defined, the target specific unwinder |
8099 | will be used in all cases. Defining this macro will enable the generation | |
8100 | of DWARF 2 frame debugging information. | |
0021b564 | 8101 | |
5cf58f28 PB |
8102 | If @code{TARGET_UNWIND_INFO} is not defined, and this macro is defined to 1, |
8103 | the DWARF 2 unwinder will be the default exception handling mechanism; | |
4f6c2131 EB |
8104 | otherwise, the @code{setjmp}/@code{longjmp}-based scheme will be used by |
8105 | default. | |
a2c4f8e0 | 8106 | @end defmac |
0021b564 | 8107 | |
951120ea PB |
8108 | @defmac TARGET_UNWIND_INFO |
8109 | Define this macro if your target has ABI specified unwind tables. Usually | |
8110 | these will be output by @code{TARGET_UNWIND_EMIT}. | |
8111 | @end defmac | |
8112 | ||
4f6c2131 | 8113 | @deftypevar {Target Hook} bool TARGET_UNWIND_TABLES_DEFAULT |
617a1b71 PB |
8114 | This variable should be set to @code{true} if the target ABI requires unwinding |
8115 | tables even when exceptions are not used. | |
8116 | @end deftypevar | |
8117 | ||
c14aea87 RO |
8118 | @defmac MUST_USE_SJLJ_EXCEPTIONS |
8119 | This macro need only be defined if @code{DWARF2_UNWIND_INFO} is | |
8120 | runtime-variable. In that case, @file{except.h} cannot correctly | |
4f6c2131 EB |
8121 | determine the corresponding definition of @code{MUST_USE_SJLJ_EXCEPTIONS}, |
8122 | so the target must provide it directly. | |
8123 | @end defmac | |
8124 | ||
8125 | @defmac DONT_USE_BUILTIN_SETJMP | |
8126 | Define this macro to 1 if the @code{setjmp}/@code{longjmp}-based scheme | |
8127 | should use the @code{setjmp}/@code{longjmp} functions from the C library | |
8128 | instead of the @code{__builtin_setjmp}/@code{__builtin_longjmp} machinery. | |
c14aea87 RO |
8129 | @end defmac |
8130 | ||
a2c4f8e0 | 8131 | @defmac DWARF_CIE_DATA_ALIGNMENT |
27c35f4b HPN |
8132 | This macro need only be defined if the target might save registers in the |
8133 | function prologue at an offset to the stack pointer that is not aligned to | |
8134 | @code{UNITS_PER_WORD}. The definition should be the negative minimum | |
8135 | alignment if @code{STACK_GROWS_DOWNWARD} is defined, and the positive | |
8136 | minimum alignment otherwise. @xref{SDB and DWARF}. Only applicable if | |
8137 | the target supports DWARF 2 frame unwind information. | |
a2c4f8e0 | 8138 | @end defmac |
feca2ed3 | 8139 | |
7606e68f SS |
8140 | @deftypevar {Target Hook} bool TARGET_TERMINATE_DW2_EH_FRAME_INFO |
8141 | Contains the value true if the target should add a zero word onto the | |
8142 | end of a Dwarf-2 frame info section when used for exception handling. | |
8143 | Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and | |
8144 | true otherwise. | |
8145 | @end deftypevar | |
8146 | ||
96714395 AH |
8147 | @deftypefn {Target Hook} rtx TARGET_DWARF_REGISTER_SPAN (rtx @var{reg}) |
8148 | Given a register, this hook should return a parallel of registers to | |
8149 | represent where to find the register pieces. Define this hook if the | |
8150 | register and its mode are represented in Dwarf in non-contiguous | |
8151 | locations, or if the register should be represented in more than one | |
8152 | register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}. | |
8153 | If not defined, the default is to return @code{NULL_RTX}. | |
8154 | @end deftypefn | |
8155 | ||
617a1b71 PB |
8156 | @deftypefn {Target Hook} bool TARGET_ASM_TTYPE (rtx @var{sym}) |
8157 | This hook is used to output a reference from a frame unwinding table to | |
8158 | the type_info object identified by @var{sym}. It should return @code{true} | |
8159 | if the reference was output. Returning @code{false} will cause the | |
8160 | reference to be output using the normal Dwarf2 routines. | |
8161 | @end deftypefn | |
8162 | ||
8163 | @deftypefn {Target Hook} bool TARGET_ARM_EABI_UNWINDER | |
8164 | This hook should be set to @code{true} on targets that use an ARM EABI | |
8165 | based unwinding library, and @code{false} on other targets. This effects | |
8166 | the format of unwinding tables, and how the unwinder in entered after | |
8167 | running a cleanup. The default is @code{false}. | |
8168 | @end deftypefn | |
8169 | ||
feca2ed3 JW |
8170 | @node Alignment Output |
8171 | @subsection Assembler Commands for Alignment | |
8172 | ||
8173 | @c prevent bad page break with this line | |
8174 | This describes commands for alignment. | |
8175 | ||
a2c4f8e0 | 8176 | @defmac JUMP_ALIGN (@var{label}) |
247a370b | 8177 | The alignment (log base 2) to put in front of @var{label}, which is |
f710504c | 8178 | a common destination of jumps and has no fallthru incoming edge. |
25e22dc0 JH |
8179 | |
8180 | This macro need not be defined if you don't want any special alignment | |
8181 | to be done at such a time. Most machine descriptions do not currently | |
8182 | define the macro. | |
efa3896a | 8183 | |
3446405d JH |
8184 | Unless it's necessary to inspect the @var{label} parameter, it is better |
8185 | to set the variable @var{align_jumps} in the target's | |
c21cd8b1 | 8186 | @code{OVERRIDE_OPTIONS}. Otherwise, you should try to honor the user's |
247a370b | 8187 | selection in @var{align_jumps} in a @code{JUMP_ALIGN} implementation. |
a2c4f8e0 | 8188 | @end defmac |
247a370b | 8189 | |
a2c4f8e0 | 8190 | @defmac LABEL_ALIGN_AFTER_BARRIER (@var{label}) |
247a370b JH |
8191 | The alignment (log base 2) to put in front of @var{label}, which follows |
8192 | a @code{BARRIER}. | |
8193 | ||
8194 | This macro need not be defined if you don't want any special alignment | |
8195 | to be done at such a time. Most machine descriptions do not currently | |
8196 | define the macro. | |
a2c4f8e0 | 8197 | @end defmac |
3446405d | 8198 | |
a2c4f8e0 | 8199 | @defmac LABEL_ALIGN_AFTER_BARRIER_MAX_SKIP |
02f52e19 | 8200 | The maximum number of bytes to skip when applying |
efa3896a GK |
8201 | @code{LABEL_ALIGN_AFTER_BARRIER}. This works only if |
8202 | @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined. | |
a2c4f8e0 | 8203 | @end defmac |
efa3896a | 8204 | |
a2c4f8e0 | 8205 | @defmac LOOP_ALIGN (@var{label}) |
fc470718 | 8206 | The alignment (log base 2) to put in front of @var{label}, which follows |
aee96fe9 | 8207 | a @code{NOTE_INSN_LOOP_BEG} note. |
feca2ed3 JW |
8208 | |
8209 | This macro need not be defined if you don't want any special alignment | |
8210 | to be done at such a time. Most machine descriptions do not currently | |
8211 | define the macro. | |
8212 | ||
efa3896a | 8213 | Unless it's necessary to inspect the @var{label} parameter, it is better |
aee96fe9 | 8214 | to set the variable @code{align_loops} in the target's |
c21cd8b1 | 8215 | @code{OVERRIDE_OPTIONS}. Otherwise, you should try to honor the user's |
aee96fe9 | 8216 | selection in @code{align_loops} in a @code{LOOP_ALIGN} implementation. |
a2c4f8e0 | 8217 | @end defmac |
efa3896a | 8218 | |
a2c4f8e0 | 8219 | @defmac LOOP_ALIGN_MAX_SKIP |
efa3896a GK |
8220 | The maximum number of bytes to skip when applying @code{LOOP_ALIGN}. |
8221 | This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined. | |
a2c4f8e0 | 8222 | @end defmac |
efa3896a | 8223 | |
a2c4f8e0 | 8224 | @defmac LABEL_ALIGN (@var{label}) |
fc470718 | 8225 | The alignment (log base 2) to put in front of @var{label}. |
aee96fe9 | 8226 | If @code{LABEL_ALIGN_AFTER_BARRIER} / @code{LOOP_ALIGN} specify a different alignment, |
fc470718 R |
8227 | the maximum of the specified values is used. |
8228 | ||
efa3896a | 8229 | Unless it's necessary to inspect the @var{label} parameter, it is better |
aee96fe9 | 8230 | to set the variable @code{align_labels} in the target's |
c21cd8b1 | 8231 | @code{OVERRIDE_OPTIONS}. Otherwise, you should try to honor the user's |
aee96fe9 | 8232 | selection in @code{align_labels} in a @code{LABEL_ALIGN} implementation. |
a2c4f8e0 | 8233 | @end defmac |
efa3896a | 8234 | |
a2c4f8e0 | 8235 | @defmac LABEL_ALIGN_MAX_SKIP |
efa3896a GK |
8236 | The maximum number of bytes to skip when applying @code{LABEL_ALIGN}. |
8237 | This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined. | |
a2c4f8e0 | 8238 | @end defmac |
efa3896a | 8239 | |
a2c4f8e0 | 8240 | @defmac ASM_OUTPUT_SKIP (@var{stream}, @var{nbytes}) |
feca2ed3 JW |
8241 | A C statement to output to the stdio stream @var{stream} an assembler |
8242 | instruction to advance the location counter by @var{nbytes} bytes. | |
8243 | Those bytes should be zero when loaded. @var{nbytes} will be a C | |
606e938d | 8244 | expression of type @code{unsigned HOST_WIDE_INT}. |
a2c4f8e0 | 8245 | @end defmac |
feca2ed3 | 8246 | |
a2c4f8e0 | 8247 | @defmac ASM_NO_SKIP_IN_TEXT |
feca2ed3 | 8248 | Define this macro if @code{ASM_OUTPUT_SKIP} should not be used in the |
556e0f21 | 8249 | text section because it fails to put zeros in the bytes that are skipped. |
feca2ed3 JW |
8250 | This is true on many Unix systems, where the pseudo--op to skip bytes |
8251 | produces no-op instructions rather than zeros when used in the text | |
8252 | section. | |
a2c4f8e0 | 8253 | @end defmac |
feca2ed3 | 8254 | |
a2c4f8e0 | 8255 | @defmac ASM_OUTPUT_ALIGN (@var{stream}, @var{power}) |
feca2ed3 JW |
8256 | A C statement to output to the stdio stream @var{stream} an assembler |
8257 | command to advance the location counter to a multiple of 2 to the | |
8258 | @var{power} bytes. @var{power} will be a C expression of type @code{int}. | |
a2c4f8e0 | 8259 | @end defmac |
26f63a77 | 8260 | |
a2c4f8e0 | 8261 | @defmac ASM_OUTPUT_ALIGN_WITH_NOP (@var{stream}, @var{power}) |
8e16ab99 SF |
8262 | Like @code{ASM_OUTPUT_ALIGN}, except that the ``nop'' instruction is used |
8263 | for padding, if necessary. | |
a2c4f8e0 | 8264 | @end defmac |
8e16ab99 | 8265 | |
a2c4f8e0 | 8266 | @defmac ASM_OUTPUT_MAX_SKIP_ALIGN (@var{stream}, @var{power}, @var{max_skip}) |
26f63a77 JL |
8267 | A C statement to output to the stdio stream @var{stream} an assembler |
8268 | command to advance the location counter to a multiple of 2 to the | |
8269 | @var{power} bytes, but only if @var{max_skip} or fewer bytes are needed to | |
8270 | satisfy the alignment request. @var{power} and @var{max_skip} will be | |
8271 | a C expression of type @code{int}. | |
a2c4f8e0 | 8272 | @end defmac |
feca2ed3 JW |
8273 | |
8274 | @need 3000 | |
8275 | @node Debugging Info | |
8276 | @section Controlling Debugging Information Format | |
8277 | ||
8278 | @c prevent bad page break with this line | |
8279 | This describes how to specify debugging information. | |
8280 | ||
8281 | @menu | |
8282 | * All Debuggers:: Macros that affect all debugging formats uniformly. | |
8283 | * DBX Options:: Macros enabling specific options in DBX format. | |
8284 | * DBX Hooks:: Hook macros for varying DBX format. | |
8285 | * File Names and DBX:: Macros controlling output of file names in DBX format. | |
8286 | * SDB and DWARF:: Macros for SDB (COFF) and DWARF formats. | |
5f98259a | 8287 | * VMS Debug:: Macros for VMS debug format. |
feca2ed3 JW |
8288 | @end menu |
8289 | ||
8290 | @node All Debuggers | |
8291 | @subsection Macros Affecting All Debugging Formats | |
8292 | ||
8293 | @c prevent bad page break with this line | |
8294 | These macros affect all debugging formats. | |
8295 | ||
a2c4f8e0 | 8296 | @defmac DBX_REGISTER_NUMBER (@var{regno}) |
feca2ed3 | 8297 | A C expression that returns the DBX register number for the compiler |
4617e3b5 KG |
8298 | register number @var{regno}. In the default macro provided, the value |
8299 | of this expression will be @var{regno} itself. But sometimes there are | |
8300 | some registers that the compiler knows about and DBX does not, or vice | |
8301 | versa. In such cases, some register may need to have one number in the | |
8302 | compiler and another for DBX@. | |
feca2ed3 | 8303 | |
a3a15b4d | 8304 | If two registers have consecutive numbers inside GCC, and they can be |
feca2ed3 JW |
8305 | used as a pair to hold a multiword value, then they @emph{must} have |
8306 | consecutive numbers after renumbering with @code{DBX_REGISTER_NUMBER}. | |
8307 | Otherwise, debuggers will be unable to access such a pair, because they | |
8308 | expect register pairs to be consecutive in their own numbering scheme. | |
8309 | ||
8310 | If you find yourself defining @code{DBX_REGISTER_NUMBER} in way that | |
8311 | does not preserve register pairs, then what you must do instead is | |
8312 | redefine the actual register numbering scheme. | |
a2c4f8e0 | 8313 | @end defmac |
feca2ed3 | 8314 | |
a2c4f8e0 | 8315 | @defmac DEBUGGER_AUTO_OFFSET (@var{x}) |
feca2ed3 JW |
8316 | A C expression that returns the integer offset value for an automatic |
8317 | variable having address @var{x} (an RTL expression). The default | |
8318 | computation assumes that @var{x} is based on the frame-pointer and | |
8319 | gives the offset from the frame-pointer. This is required for targets | |
8320 | that produce debugging output for DBX or COFF-style debugging output | |
8321 | for SDB and allow the frame-pointer to be eliminated when the | |
630d3d5a | 8322 | @option{-g} options is used. |
a2c4f8e0 | 8323 | @end defmac |
feca2ed3 | 8324 | |
a2c4f8e0 | 8325 | @defmac DEBUGGER_ARG_OFFSET (@var{offset}, @var{x}) |
feca2ed3 JW |
8326 | A C expression that returns the integer offset value for an argument |
8327 | having address @var{x} (an RTL expression). The nominal offset is | |
8328 | @var{offset}. | |
a2c4f8e0 | 8329 | @end defmac |
feca2ed3 | 8330 | |
a2c4f8e0 | 8331 | @defmac PREFERRED_DEBUGGING_TYPE |
a3a15b4d | 8332 | A C expression that returns the type of debugging output GCC should |
630d3d5a | 8333 | produce when the user specifies just @option{-g}. Define |
a3a15b4d | 8334 | this if you have arranged for GCC to support more than one format of |
e5e809f4 | 8335 | debugging output. Currently, the allowable values are @code{DBX_DEBUG}, |
5f98259a RK |
8336 | @code{SDB_DEBUG}, @code{DWARF_DEBUG}, @code{DWARF2_DEBUG}, |
8337 | @code{XCOFF_DEBUG}, @code{VMS_DEBUG}, and @code{VMS_AND_DWARF2_DEBUG}. | |
feca2ed3 | 8338 | |
630d3d5a | 8339 | When the user specifies @option{-ggdb}, GCC normally also uses the |
e5e809f4 | 8340 | value of this macro to select the debugging output format, but with two |
16201823 | 8341 | exceptions. If @code{DWARF2_DEBUGGING_INFO} is defined, GCC uses the |
e5e809f4 | 8342 | value @code{DWARF2_DEBUG}. Otherwise, if @code{DBX_DEBUGGING_INFO} is |
a3a15b4d | 8343 | defined, GCC uses @code{DBX_DEBUG}. |
deabc777 | 8344 | |
feca2ed3 | 8345 | The value of this macro only affects the default debugging output; the |
630d3d5a | 8346 | user can always get a specific type of output by using @option{-gstabs}, |
def66b10 | 8347 | @option{-gcoff}, @option{-gdwarf-2}, @option{-gxcoff}, or @option{-gvms}. |
a2c4f8e0 | 8348 | @end defmac |
feca2ed3 JW |
8349 | |
8350 | @node DBX Options | |
8351 | @subsection Specific Options for DBX Output | |
8352 | ||
8353 | @c prevent bad page break with this line | |
8354 | These are specific options for DBX output. | |
8355 | ||
a2c4f8e0 | 8356 | @defmac DBX_DEBUGGING_INFO |
a3a15b4d | 8357 | Define this macro if GCC should produce debugging output for DBX |
630d3d5a | 8358 | in response to the @option{-g} option. |
a2c4f8e0 | 8359 | @end defmac |
feca2ed3 | 8360 | |
a2c4f8e0 | 8361 | @defmac XCOFF_DEBUGGING_INFO |
a3a15b4d | 8362 | Define this macro if GCC should produce XCOFF format debugging output |
630d3d5a | 8363 | in response to the @option{-g} option. This is a variant of DBX format. |
a2c4f8e0 | 8364 | @end defmac |
feca2ed3 | 8365 | |
a2c4f8e0 | 8366 | @defmac DEFAULT_GDB_EXTENSIONS |
a3a15b4d | 8367 | Define this macro to control whether GCC should by default generate |
feca2ed3 JW |
8368 | GDB's extended version of DBX debugging information (assuming DBX-format |
8369 | debugging information is enabled at all). If you don't define the | |
8370 | macro, the default is 1: always generate the extended information | |
8371 | if there is any occasion to. | |
a2c4f8e0 | 8372 | @end defmac |
feca2ed3 | 8373 | |
a2c4f8e0 | 8374 | @defmac DEBUG_SYMS_TEXT |
feca2ed3 JW |
8375 | Define this macro if all @code{.stabs} commands should be output while |
8376 | in the text section. | |
a2c4f8e0 | 8377 | @end defmac |
feca2ed3 | 8378 | |
a2c4f8e0 | 8379 | @defmac ASM_STABS_OP |
047c1c92 HPN |
8380 | A C string constant, including spacing, naming the assembler pseudo op to |
8381 | use instead of @code{"\t.stabs\t"} to define an ordinary debugging symbol. | |
8382 | If you don't define this macro, @code{"\t.stabs\t"} is used. This macro | |
8383 | applies only to DBX debugging information format. | |
a2c4f8e0 | 8384 | @end defmac |
feca2ed3 | 8385 | |
a2c4f8e0 | 8386 | @defmac ASM_STABD_OP |
047c1c92 HPN |
8387 | A C string constant, including spacing, naming the assembler pseudo op to |
8388 | use instead of @code{"\t.stabd\t"} to define a debugging symbol whose | |
8389 | value is the current location. If you don't define this macro, | |
8390 | @code{"\t.stabd\t"} is used. This macro applies only to DBX debugging | |
8391 | information format. | |
a2c4f8e0 | 8392 | @end defmac |
feca2ed3 | 8393 | |
a2c4f8e0 | 8394 | @defmac ASM_STABN_OP |
047c1c92 HPN |
8395 | A C string constant, including spacing, naming the assembler pseudo op to |
8396 | use instead of @code{"\t.stabn\t"} to define a debugging symbol with no | |
8397 | name. If you don't define this macro, @code{"\t.stabn\t"} is used. This | |
8398 | macro applies only to DBX debugging information format. | |
a2c4f8e0 | 8399 | @end defmac |
feca2ed3 | 8400 | |
a2c4f8e0 | 8401 | @defmac DBX_NO_XREFS |
feca2ed3 JW |
8402 | Define this macro if DBX on your system does not support the construct |
8403 | @samp{xs@var{tagname}}. On some systems, this construct is used to | |
8404 | describe a forward reference to a structure named @var{tagname}. | |
8405 | On other systems, this construct is not supported at all. | |
a2c4f8e0 | 8406 | @end defmac |
feca2ed3 | 8407 | |
a2c4f8e0 | 8408 | @defmac DBX_CONTIN_LENGTH |
feca2ed3 JW |
8409 | A symbol name in DBX-format debugging information is normally |
8410 | continued (split into two separate @code{.stabs} directives) when it | |
8411 | exceeds a certain length (by default, 80 characters). On some | |
8412 | operating systems, DBX requires this splitting; on others, splitting | |
8413 | must not be done. You can inhibit splitting by defining this macro | |
8414 | with the value zero. You can override the default splitting-length by | |
8415 | defining this macro as an expression for the length you desire. | |
a2c4f8e0 | 8416 | @end defmac |
feca2ed3 | 8417 | |
a2c4f8e0 | 8418 | @defmac DBX_CONTIN_CHAR |
feca2ed3 JW |
8419 | Normally continuation is indicated by adding a @samp{\} character to |
8420 | the end of a @code{.stabs} string when a continuation follows. To use | |
8421 | a different character instead, define this macro as a character | |
8422 | constant for the character you want to use. Do not define this macro | |
8423 | if backslash is correct for your system. | |
a2c4f8e0 | 8424 | @end defmac |
feca2ed3 | 8425 | |
a2c4f8e0 | 8426 | @defmac DBX_STATIC_STAB_DATA_SECTION |
feca2ed3 JW |
8427 | Define this macro if it is necessary to go to the data section before |
8428 | outputting the @samp{.stabs} pseudo-op for a non-global static | |
8429 | variable. | |
a2c4f8e0 | 8430 | @end defmac |
feca2ed3 | 8431 | |
a2c4f8e0 | 8432 | @defmac DBX_TYPE_DECL_STABS_CODE |
feca2ed3 JW |
8433 | The value to use in the ``code'' field of the @code{.stabs} directive |
8434 | for a typedef. The default is @code{N_LSYM}. | |
a2c4f8e0 | 8435 | @end defmac |
feca2ed3 | 8436 | |
a2c4f8e0 | 8437 | @defmac DBX_STATIC_CONST_VAR_CODE |
feca2ed3 JW |
8438 | The value to use in the ``code'' field of the @code{.stabs} directive |
8439 | for a static variable located in the text section. DBX format does not | |
8440 | provide any ``right'' way to do this. The default is @code{N_FUN}. | |
a2c4f8e0 | 8441 | @end defmac |
feca2ed3 | 8442 | |
a2c4f8e0 | 8443 | @defmac DBX_REGPARM_STABS_CODE |
feca2ed3 JW |
8444 | The value to use in the ``code'' field of the @code{.stabs} directive |
8445 | for a parameter passed in registers. DBX format does not provide any | |
8446 | ``right'' way to do this. The default is @code{N_RSYM}. | |
a2c4f8e0 | 8447 | @end defmac |
feca2ed3 | 8448 | |
a2c4f8e0 | 8449 | @defmac DBX_REGPARM_STABS_LETTER |
feca2ed3 JW |
8450 | The letter to use in DBX symbol data to identify a symbol as a parameter |
8451 | passed in registers. DBX format does not customarily provide any way to | |
8452 | do this. The default is @code{'P'}. | |
a2c4f8e0 | 8453 | @end defmac |
feca2ed3 | 8454 | |
a2c4f8e0 | 8455 | @defmac DBX_FUNCTION_FIRST |
feca2ed3 JW |
8456 | Define this macro if the DBX information for a function and its |
8457 | arguments should precede the assembler code for the function. Normally, | |
8458 | in DBX format, the debugging information entirely follows the assembler | |
8459 | code. | |
a2c4f8e0 | 8460 | @end defmac |
feca2ed3 | 8461 | |
a2c4f8e0 | 8462 | @defmac DBX_BLOCKS_FUNCTION_RELATIVE |
3e487b21 ZW |
8463 | Define this macro, with value 1, if the value of a symbol describing |
8464 | the scope of a block (@code{N_LBRAC} or @code{N_RBRAC}) should be | |
8465 | relative to the start of the enclosing function. Normally, GCC uses | |
8466 | an absolute address. | |
8467 | @end defmac | |
8468 | ||
8469 | @defmac DBX_LINES_FUNCTION_RELATIVE | |
8470 | Define this macro, with value 1, if the value of a symbol indicating | |
8471 | the current line number (@code{N_SLINE}) should be relative to the | |
8472 | start of the enclosing function. Normally, GCC uses an absolute address. | |
a2c4f8e0 | 8473 | @end defmac |
feca2ed3 | 8474 | |
a2c4f8e0 | 8475 | @defmac DBX_USE_BINCL |
f0523f02 | 8476 | Define this macro if GCC should generate @code{N_BINCL} and |
feca2ed3 | 8477 | @code{N_EINCL} stabs for included header files, as on Sun systems. This |
f0523f02 JM |
8478 | macro also directs GCC to output a type number as a pair of a file |
8479 | number and a type number within the file. Normally, GCC does not | |
feca2ed3 JW |
8480 | generate @code{N_BINCL} or @code{N_EINCL} stabs, and it outputs a single |
8481 | number for a type number. | |
a2c4f8e0 | 8482 | @end defmac |
feca2ed3 JW |
8483 | |
8484 | @node DBX Hooks | |
8485 | @subsection Open-Ended Hooks for DBX Format | |
8486 | ||
8487 | @c prevent bad page break with this line | |
8488 | These are hooks for DBX format. | |
8489 | ||
a2c4f8e0 | 8490 | @defmac DBX_OUTPUT_LBRAC (@var{stream}, @var{name}) |
feca2ed3 JW |
8491 | Define this macro to say how to output to @var{stream} the debugging |
8492 | information for the start of a scope level for variable names. The | |
8493 | argument @var{name} is the name of an assembler symbol (for use with | |
8494 | @code{assemble_name}) whose value is the address where the scope begins. | |
a2c4f8e0 | 8495 | @end defmac |
feca2ed3 | 8496 | |
a2c4f8e0 | 8497 | @defmac DBX_OUTPUT_RBRAC (@var{stream}, @var{name}) |
feca2ed3 | 8498 | Like @code{DBX_OUTPUT_LBRAC}, but for the end of a scope level. |
a2c4f8e0 | 8499 | @end defmac |
feca2ed3 | 8500 | |
a2c4f8e0 | 8501 | @defmac DBX_OUTPUT_NFUN (@var{stream}, @var{lscope_label}, @var{decl}) |
374b0b7d AM |
8502 | Define this macro if the target machine requires special handling to |
8503 | output an @code{N_FUN} entry for the function @var{decl}. | |
a2c4f8e0 | 8504 | @end defmac |
374b0b7d | 8505 | |
3e487b21 ZW |
8506 | @defmac DBX_OUTPUT_SOURCE_LINE (@var{stream}, @var{line}, @var{counter}) |
8507 | A C statement to output DBX debugging information before code for line | |
8508 | number @var{line} of the current source file to the stdio stream | |
8a36672b | 8509 | @var{stream}. @var{counter} is the number of time the macro was |
3e487b21 ZW |
8510 | invoked, including the current invocation; it is intended to generate |
8511 | unique labels in the assembly output. | |
8512 | ||
8513 | This macro should not be defined if the default output is correct, or | |
8514 | if it can be made correct by defining @code{DBX_LINES_FUNCTION_RELATIVE}. | |
8515 | @end defmac | |
8516 | ||
a2c4f8e0 | 8517 | @defmac NO_DBX_FUNCTION_END |
feca2ed3 | 8518 | Some stabs encapsulation formats (in particular ECOFF), cannot handle the |
c771326b | 8519 | @code{.stabs "",N_FUN,,0,0,Lscope-function-1} gdb dbx extension construct. |
feca2ed3 JW |
8520 | On those machines, define this macro to turn this feature off without |
8521 | disturbing the rest of the gdb extensions. | |
a2c4f8e0 | 8522 | @end defmac |
feca2ed3 | 8523 | |
5d865dac EB |
8524 | @defmac NO_DBX_BNSYM_ENSYM |
8525 | Some assemblers cannot handle the @code{.stabd BNSYM/ENSYM,0,0} gdb dbx | |
8526 | extension construct. On those machines, define this macro to turn this | |
8527 | feature off without disturbing the rest of the gdb extensions. | |
8528 | @end defmac | |
8529 | ||
feca2ed3 JW |
8530 | @node File Names and DBX |
8531 | @subsection File Names in DBX Format | |
8532 | ||
8533 | @c prevent bad page break with this line | |
8534 | This describes file names in DBX format. | |
8535 | ||
a2c4f8e0 | 8536 | @defmac DBX_OUTPUT_MAIN_SOURCE_FILENAME (@var{stream}, @var{name}) |
feca2ed3 | 8537 | A C statement to output DBX debugging information to the stdio stream |
93a27b7b | 8538 | @var{stream}, which indicates that file @var{name} is the main source |
feca2ed3 JW |
8539 | file---the file specified as the input file for compilation. |
8540 | This macro is called only once, at the beginning of compilation. | |
8541 | ||
8542 | This macro need not be defined if the standard form of output | |
8543 | for DBX debugging information is appropriate. | |
93a27b7b ZW |
8544 | |
8545 | It may be necessary to refer to a label equal to the beginning of the | |
8546 | text section. You can use @samp{assemble_name (stream, ltext_label_name)} | |
8547 | to do so. If you do this, you must also set the variable | |
8548 | @var{used_ltext_label_name} to @code{true}. | |
a2c4f8e0 | 8549 | @end defmac |
feca2ed3 | 8550 | |
93a27b7b ZW |
8551 | @defmac NO_DBX_MAIN_SOURCE_DIRECTORY |
8552 | Define this macro, with value 1, if GCC should not emit an indication | |
8553 | of the current directory for compilation and current source language at | |
8554 | the beginning of the file. | |
8555 | @end defmac | |
feca2ed3 | 8556 | |
93a27b7b ZW |
8557 | @defmac NO_DBX_GCC_MARKER |
8558 | Define this macro, with value 1, if GCC should not emit an indication | |
8559 | that this object file was compiled by GCC@. The default is to emit | |
8560 | an @code{N_OPT} stab at the beginning of every source file, with | |
8561 | @samp{gcc2_compiled.} for the string and value 0. | |
a2c4f8e0 | 8562 | @end defmac |
feca2ed3 | 8563 | |
a2c4f8e0 | 8564 | @defmac DBX_OUTPUT_MAIN_SOURCE_FILE_END (@var{stream}, @var{name}) |
feca2ed3 | 8565 | A C statement to output DBX debugging information at the end of |
93a27b7b ZW |
8566 | compilation of the main source file @var{name}. Output should be |
8567 | written to the stdio stream @var{stream}. | |
feca2ed3 JW |
8568 | |
8569 | If you don't define this macro, nothing special is output at the end | |
8570 | of compilation, which is correct for most machines. | |
a2c4f8e0 | 8571 | @end defmac |
feca2ed3 | 8572 | |
3e487b21 ZW |
8573 | @defmac DBX_OUTPUT_NULL_N_SO_AT_MAIN_SOURCE_FILE_END |
8574 | Define this macro @emph{instead of} defining | |
8575 | @code{DBX_OUTPUT_MAIN_SOURCE_FILE_END}, if what needs to be output at | |
8576 | the end of compilation is a @code{N_SO} stab with an empty string, | |
8577 | whose value is the highest absolute text address in the file. | |
8578 | @end defmac | |
8579 | ||
feca2ed3 JW |
8580 | @need 2000 |
8581 | @node SDB and DWARF | |
8582 | @subsection Macros for SDB and DWARF Output | |
8583 | ||
8584 | @c prevent bad page break with this line | |
8585 | Here are macros for SDB and DWARF output. | |
8586 | ||
a2c4f8e0 | 8587 | @defmac SDB_DEBUGGING_INFO |
a3a15b4d | 8588 | Define this macro if GCC should produce COFF-style debugging output |
630d3d5a | 8589 | for SDB in response to the @option{-g} option. |
a2c4f8e0 | 8590 | @end defmac |
feca2ed3 | 8591 | |
a2c4f8e0 | 8592 | @defmac DWARF2_DEBUGGING_INFO |
a3a15b4d | 8593 | Define this macro if GCC should produce dwarf version 2 format |
630d3d5a | 8594 | debugging output in response to the @option{-g} option. |
f3ff3f4a | 8595 | |
a1c496cb EC |
8596 | @deftypefn {Target Hook} int TARGET_DWARF_CALLING_CONVENTION (tree @var{function}) |
8597 | Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to | |
8598 | be emitted for each function. Instead of an integer return the enum | |
8599 | value for the @code{DW_CC_} tag. | |
8600 | @end deftypefn | |
8601 | ||
861bb6c1 JL |
8602 | To support optional call frame debugging information, you must also |
8603 | define @code{INCOMING_RETURN_ADDR_RTX} and either set | |
8604 | @code{RTX_FRAME_RELATED_P} on the prologue insns if you use RTL for the | |
8605 | prologue, or call @code{dwarf2out_def_cfa} and @code{dwarf2out_reg_save} | |
08c148a8 | 8606 | as appropriate from @code{TARGET_ASM_FUNCTION_PROLOGUE} if you don't. |
a2c4f8e0 | 8607 | @end defmac |
861bb6c1 | 8608 | |
a2c4f8e0 | 8609 | @defmac DWARF2_FRAME_INFO |
a3a15b4d | 8610 | Define this macro to a nonzero value if GCC should always output |
9ec36da5 | 8611 | Dwarf 2 frame information. If @code{DWARF2_UNWIND_INFO} |
a3a15b4d | 8612 | (@pxref{Exception Region Output} is nonzero, GCC will output this |
9ec36da5 | 8613 | information not matter how you define @code{DWARF2_FRAME_INFO}. |
a2c4f8e0 | 8614 | @end defmac |
9ec36da5 | 8615 | |
a2c4f8e0 | 8616 | @defmac DWARF2_ASM_LINE_DEBUG_INFO |
b2244e22 JW |
8617 | Define this macro to be a nonzero value if the assembler can generate Dwarf 2 |
8618 | line debug info sections. This will result in much more compact line number | |
8619 | tables, and hence is desirable if it works. | |
a2c4f8e0 | 8620 | @end defmac |
b2244e22 | 8621 | |
a2c4f8e0 | 8622 | @defmac ASM_OUTPUT_DWARF_DELTA (@var{stream}, @var{size}, @var{label1}, @var{label2}) |
7606e68f | 8623 | A C statement to issue assembly directives that create a difference |
192d0f89 | 8624 | @var{lab1} minus @var{lab2}, using an integer of the given @var{size}. |
a2c4f8e0 | 8625 | @end defmac |
7606e68f | 8626 | |
192d0f89 | 8627 | @defmac ASM_OUTPUT_DWARF_OFFSET (@var{stream}, @var{size}, @var{label}, @var{section}) |
7606e68f | 8628 | A C statement to issue assembly directives that create a |
192d0f89 GK |
8629 | section-relative reference to the given @var{label}, using an integer of the |
8630 | given @var{size}. The label is known to be defined in the given @var{section}. | |
a2c4f8e0 | 8631 | @end defmac |
7606e68f | 8632 | |
a2c4f8e0 | 8633 | @defmac ASM_OUTPUT_DWARF_PCREL (@var{stream}, @var{size}, @var{label}) |
7606e68f | 8634 | A C statement to issue assembly directives that create a self-relative |
192d0f89 | 8635 | reference to the given @var{label}, using an integer of the given @var{size}. |
a2c4f8e0 | 8636 | @end defmac |
7606e68f | 8637 | |
fdbe66f2 EB |
8638 | @deftypefn {Target Hook} void TARGET_ASM_OUTPUT_DWARF_DTPREL (FILE *@var{FILE}, int @var{size}, rtx @var{x}) |
8639 | If defined, this target hook is a function which outputs a DTP-relative | |
8640 | reference to the given TLS symbol of the specified size. | |
8641 | @end deftypefn | |
8642 | ||
a2c4f8e0 | 8643 | @defmac PUT_SDB_@dots{} |
feca2ed3 JW |
8644 | Define these macros to override the assembler syntax for the special |
8645 | SDB assembler directives. See @file{sdbout.c} for a list of these | |
8646 | macros and their arguments. If the standard syntax is used, you need | |
8647 | not define them yourself. | |
a2c4f8e0 | 8648 | @end defmac |
feca2ed3 | 8649 | |
a2c4f8e0 | 8650 | @defmac SDB_DELIM |
feca2ed3 JW |
8651 | Some assemblers do not support a semicolon as a delimiter, even between |
8652 | SDB assembler directives. In that case, define this macro to be the | |
8653 | delimiter to use (usually @samp{\n}). It is not necessary to define | |
8654 | a new set of @code{PUT_SDB_@var{op}} macros if this is the only change | |
8655 | required. | |
a2c4f8e0 | 8656 | @end defmac |
feca2ed3 | 8657 | |
a2c4f8e0 | 8658 | @defmac SDB_ALLOW_UNKNOWN_REFERENCES |
feca2ed3 JW |
8659 | Define this macro to allow references to unknown structure, |
8660 | union, or enumeration tags to be emitted. Standard COFF does not | |
8661 | allow handling of unknown references, MIPS ECOFF has support for | |
8662 | it. | |
a2c4f8e0 | 8663 | @end defmac |
feca2ed3 | 8664 | |
a2c4f8e0 | 8665 | @defmac SDB_ALLOW_FORWARD_REFERENCES |
feca2ed3 JW |
8666 | Define this macro to allow references to structure, union, or |
8667 | enumeration tags that have not yet been seen to be handled. Some | |
8668 | assemblers choke if forward tags are used, while some require it. | |
a2c4f8e0 | 8669 | @end defmac |
feca2ed3 | 8670 | |
3e487b21 ZW |
8671 | @defmac SDB_OUTPUT_SOURCE_LINE (@var{stream}, @var{line}) |
8672 | A C statement to output SDB debugging information before code for line | |
8673 | number @var{line} of the current source file to the stdio stream | |
8674 | @var{stream}. The default is to emit an @code{.ln} directive. | |
8675 | @end defmac | |
8676 | ||
5f98259a RK |
8677 | @need 2000 |
8678 | @node VMS Debug | |
8679 | @subsection Macros for VMS Debug Format | |
8680 | ||
8681 | @c prevent bad page break with this line | |
8682 | Here are macros for VMS debug format. | |
8683 | ||
a2c4f8e0 | 8684 | @defmac VMS_DEBUGGING_INFO |
5f98259a RK |
8685 | Define this macro if GCC should produce debugging output for VMS |
8686 | in response to the @option{-g} option. The default behavior for VMS | |
8687 | is to generate minimal debug info for a traceback in the absence of | |
8688 | @option{-g} unless explicitly overridden with @option{-g0}. This | |
8689 | behavior is controlled by @code{OPTIMIZATION_OPTIONS} and | |
8690 | @code{OVERRIDE_OPTIONS}. | |
a2c4f8e0 | 8691 | @end defmac |
5f98259a | 8692 | |
b216cd4a | 8693 | @node Floating Point |
feca2ed3 JW |
8694 | @section Cross Compilation and Floating Point |
8695 | @cindex cross compilation and floating point | |
8696 | @cindex floating point and cross compilation | |
8697 | ||
b216cd4a | 8698 | While all modern machines use twos-complement representation for integers, |
feca2ed3 JW |
8699 | there are a variety of representations for floating point numbers. This |
8700 | means that in a cross-compiler the representation of floating point numbers | |
8701 | in the compiled program may be different from that used in the machine | |
8702 | doing the compilation. | |
8703 | ||
feca2ed3 | 8704 | Because different representation systems may offer different amounts of |
b216cd4a ZW |
8705 | range and precision, all floating point constants must be represented in |
8706 | the target machine's format. Therefore, the cross compiler cannot | |
8707 | safely use the host machine's floating point arithmetic; it must emulate | |
8708 | the target's arithmetic. To ensure consistency, GCC always uses | |
8709 | emulation to work with floating point values, even when the host and | |
8710 | target floating point formats are identical. | |
8711 | ||
8712 | The following macros are provided by @file{real.h} for the compiler to | |
8713 | use. All parts of the compiler which generate or optimize | |
ba31d94e ZW |
8714 | floating-point calculations must use these macros. They may evaluate |
8715 | their operands more than once, so operands must not have side effects. | |
feca2ed3 | 8716 | |
b216cd4a ZW |
8717 | @defmac REAL_VALUE_TYPE |
8718 | The C data type to be used to hold a floating point value in the target | |
8719 | machine's format. Typically this is a @code{struct} containing an | |
8720 | array of @code{HOST_WIDE_INT}, but all code should treat it as an opaque | |
8721 | quantity. | |
8722 | @end defmac | |
8723 | ||
8724 | @deftypefn Macro int REAL_VALUES_EQUAL (REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y}) | |
8725 | Compares for equality the two values, @var{x} and @var{y}. If the target | |
8726 | floating point format supports negative zeroes and/or NaNs, | |
8727 | @samp{REAL_VALUES_EQUAL (-0.0, 0.0)} is true, and | |
8728 | @samp{REAL_VALUES_EQUAL (NaN, NaN)} is false. | |
8729 | @end deftypefn | |
8730 | ||
8731 | @deftypefn Macro int REAL_VALUES_LESS (REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y}) | |
8732 | Tests whether @var{x} is less than @var{y}. | |
8733 | @end deftypefn | |
8734 | ||
b216cd4a ZW |
8735 | @deftypefn Macro HOST_WIDE_INT REAL_VALUE_FIX (REAL_VALUE_TYPE @var{x}) |
8736 | Truncates @var{x} to a signed integer, rounding toward zero. | |
8737 | @end deftypefn | |
8738 | ||
8739 | @deftypefn Macro {unsigned HOST_WIDE_INT} REAL_VALUE_UNSIGNED_FIX (REAL_VALUE_TYPE @var{x}) | |
8740 | Truncates @var{x} to an unsigned integer, rounding toward zero. If | |
8741 | @var{x} is negative, returns zero. | |
8742 | @end deftypefn | |
8743 | ||
b216cd4a ZW |
8744 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_ATOF (const char *@var{string}, enum machine_mode @var{mode}) |
8745 | Converts @var{string} into a floating point number in the target machine's | |
8746 | representation for mode @var{mode}. This routine can handle both | |
8747 | decimal and hexadecimal floating point constants, using the syntax | |
8748 | defined by the C language for both. | |
8749 | @end deftypefn | |
feca2ed3 | 8750 | |
15e5ad76 | 8751 | @deftypefn Macro int REAL_VALUE_NEGATIVE (REAL_VALUE_TYPE @var{x}) |
ce3649d2 | 8752 | Returns 1 if @var{x} is negative (including negative zero), 0 otherwise. |
15e5ad76 ZW |
8753 | @end deftypefn |
8754 | ||
b216cd4a ZW |
8755 | @deftypefn Macro int REAL_VALUE_ISINF (REAL_VALUE_TYPE @var{x}) |
8756 | Determines whether @var{x} represents infinity (positive or negative). | |
8757 | @end deftypefn | |
8758 | ||
8759 | @deftypefn Macro int REAL_VALUE_ISNAN (REAL_VALUE_TYPE @var{x}) | |
8760 | Determines whether @var{x} represents a ``NaN'' (not-a-number). | |
8761 | @end deftypefn | |
8762 | ||
8763 | @deftypefn Macro void REAL_ARITHMETIC (REAL_VALUE_TYPE @var{output}, enum tree_code @var{code}, REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y}) | |
8764 | Calculates an arithmetic operation on the two floating point values | |
8765 | @var{x} and @var{y}, storing the result in @var{output} (which must be a | |
8766 | variable). | |
8767 | ||
8768 | The operation to be performed is specified by @var{code}. Only the | |
8769 | following codes are supported: @code{PLUS_EXPR}, @code{MINUS_EXPR}, | |
8770 | @code{MULT_EXPR}, @code{RDIV_EXPR}, @code{MAX_EXPR}, @code{MIN_EXPR}. | |
8771 | ||
8772 | If @code{REAL_ARITHMETIC} is asked to evaluate division by zero and the | |
8773 | target's floating point format cannot represent infinity, it will call | |
8774 | @code{abort}. Callers should check for this situation first, using | |
8775 | @code{MODE_HAS_INFINITIES}. @xref{Storage Layout}. | |
8776 | @end deftypefn | |
8777 | ||
8778 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_NEGATE (REAL_VALUE_TYPE @var{x}) | |
8779 | Returns the negative of the floating point value @var{x}. | |
8780 | @end deftypefn | |
8781 | ||
15e5ad76 ZW |
8782 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_ABS (REAL_VALUE_TYPE @var{x}) |
8783 | Returns the absolute value of @var{x}. | |
8784 | @end deftypefn | |
8785 | ||
b216cd4a ZW |
8786 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_TRUNCATE (REAL_VALUE_TYPE @var{mode}, enum machine_mode @var{x}) |
8787 | Truncates the floating point value @var{x} to fit in @var{mode}. The | |
8788 | return value is still a full-size @code{REAL_VALUE_TYPE}, but it has an | |
8789 | appropriate bit pattern to be output asa floating constant whose | |
8790 | precision accords with mode @var{mode}. | |
8791 | @end deftypefn | |
8792 | ||
8793 | @deftypefn Macro void REAL_VALUE_TO_INT (HOST_WIDE_INT @var{low}, HOST_WIDE_INT @var{high}, REAL_VALUE_TYPE @var{x}) | |
8794 | Converts a floating point value @var{x} into a double-precision integer | |
8795 | which is then stored into @var{low} and @var{high}. If the value is not | |
8796 | integral, it is truncated. | |
8797 | @end deftypefn | |
8798 | ||
8799 | @deftypefn Macro void REAL_VALUE_FROM_INT (REAL_VALUE_TYPE @var{x}, HOST_WIDE_INT @var{low}, HOST_WIDE_INT @var{high}, enum machine_mode @var{mode}) | |
b216cd4a ZW |
8800 | Converts a double-precision integer found in @var{low} and @var{high}, |
8801 | into a floating point value which is then stored into @var{x}. The | |
8802 | value is truncated to fit in mode @var{mode}. | |
8803 | @end deftypefn | |
feca2ed3 | 8804 | |
9f09b1f2 R |
8805 | @node Mode Switching |
8806 | @section Mode Switching Instructions | |
8807 | @cindex mode switching | |
8808 | The following macros control mode switching optimizations: | |
8809 | ||
a2c4f8e0 | 8810 | @defmac OPTIMIZE_MODE_SWITCHING (@var{entity}) |
9f09b1f2 R |
8811 | Define this macro if the port needs extra instructions inserted for mode |
8812 | switching in an optimizing compilation. | |
8813 | ||
8814 | For an example, the SH4 can perform both single and double precision | |
8815 | floating point operations, but to perform a single precision operation, | |
8816 | the FPSCR PR bit has to be cleared, while for a double precision | |
8817 | operation, this bit has to be set. Changing the PR bit requires a general | |
8818 | purpose register as a scratch register, hence these FPSCR sets have to | |
e979f9e8 | 8819 | be inserted before reload, i.e.@: you can't put this into instruction emitting |
18dbd950 | 8820 | or @code{TARGET_MACHINE_DEPENDENT_REORG}. |
9f09b1f2 R |
8821 | |
8822 | You can have multiple entities that are mode-switched, and select at run time | |
8823 | which entities actually need it. @code{OPTIMIZE_MODE_SWITCHING} should | |
14976c58 | 8824 | return nonzero for any @var{entity} that needs mode-switching. |
9f09b1f2 R |
8825 | If you define this macro, you also have to define |
8826 | @code{NUM_MODES_FOR_MODE_SWITCHING}, @code{MODE_NEEDED}, | |
8827 | @code{MODE_PRIORITY_TO_MODE} and @code{EMIT_MODE_SET}. | |
73774972 EC |
8828 | @code{MODE_AFTER}, @code{MODE_ENTRY}, and @code{MODE_EXIT} |
8829 | are optional. | |
a2c4f8e0 | 8830 | @end defmac |
9f09b1f2 | 8831 | |
a2c4f8e0 | 8832 | @defmac NUM_MODES_FOR_MODE_SWITCHING |
9f09b1f2 R |
8833 | If you define @code{OPTIMIZE_MODE_SWITCHING}, you have to define this as |
8834 | initializer for an array of integers. Each initializer element | |
8835 | N refers to an entity that needs mode switching, and specifies the number | |
8836 | of different modes that might need to be set for this entity. | |
78466c0e JM |
8837 | The position of the initializer in the initializer---starting counting at |
8838 | zero---determines the integer that is used to refer to the mode-switched | |
9f09b1f2 R |
8839 | entity in question. |
8840 | In macros that take mode arguments / yield a mode result, modes are | |
630d3d5a | 8841 | represented as numbers 0 @dots{} N @minus{} 1. N is used to specify that no mode |
9f09b1f2 | 8842 | switch is needed / supplied. |
a2c4f8e0 | 8843 | @end defmac |
9f09b1f2 | 8844 | |
a2c4f8e0 | 8845 | @defmac MODE_NEEDED (@var{entity}, @var{insn}) |
9f09b1f2 R |
8846 | @var{entity} is an integer specifying a mode-switched entity. If |
8847 | @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro to | |
8848 | return an integer value not larger than the corresponding element in | |
aee96fe9 JM |
8849 | @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity} must |
8850 | be switched into prior to the execution of @var{insn}. | |
a2c4f8e0 | 8851 | @end defmac |
9f09b1f2 | 8852 | |
73774972 EC |
8853 | @defmac MODE_AFTER (@var{mode}, @var{insn}) |
8854 | If this macro is defined, it is evaluated for every @var{insn} during | |
8a36672b | 8855 | mode switching. It determines the mode that an insn results in (if |
73774972 EC |
8856 | different from the incoming mode). |
8857 | @end defmac | |
8858 | ||
8859 | @defmac MODE_ENTRY (@var{entity}) | |
8860 | If this macro is defined, it is evaluated for every @var{entity} that needs | |
8a36672b JM |
8861 | mode switching. It should evaluate to an integer, which is a mode that |
8862 | @var{entity} is assumed to be switched to at function entry. If @code{MODE_ENTRY} | |
73774972 EC |
8863 | is defined then @code{MODE_EXIT} must be defined. |
8864 | @end defmac | |
8865 | ||
8866 | @defmac MODE_EXIT (@var{entity}) | |
9f09b1f2 | 8867 | If this macro is defined, it is evaluated for every @var{entity} that needs |
8a36672b JM |
8868 | mode switching. It should evaluate to an integer, which is a mode that |
8869 | @var{entity} is assumed to be switched to at function exit. If @code{MODE_EXIT} | |
73774972 | 8870 | is defined then @code{MODE_ENTRY} must be defined. |
a2c4f8e0 | 8871 | @end defmac |
9f09b1f2 | 8872 | |
a2c4f8e0 | 8873 | @defmac MODE_PRIORITY_TO_MODE (@var{entity}, @var{n}) |
aee96fe9 JM |
8874 | This macro specifies the order in which modes for @var{entity} are processed. |
8875 | 0 is the highest priority, @code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the | |
9f09b1f2 | 8876 | lowest. The value of the macro should be an integer designating a mode |
aee96fe9 | 8877 | for @var{entity}. For any fixed @var{entity}, @code{mode_priority_to_mode} |
630d3d5a | 8878 | (@var{entity}, @var{n}) shall be a bijection in 0 @dots{} |
aee96fe9 | 8879 | @code{num_modes_for_mode_switching[@var{entity}] - 1}. |
a2c4f8e0 | 8880 | @end defmac |
9f09b1f2 | 8881 | |
a2c4f8e0 | 8882 | @defmac EMIT_MODE_SET (@var{entity}, @var{mode}, @var{hard_regs_live}) |
9f09b1f2 R |
8883 | Generate one or more insns to set @var{entity} to @var{mode}. |
8884 | @var{hard_reg_live} is the set of hard registers live at the point where | |
8885 | the insn(s) are to be inserted. | |
a2c4f8e0 | 8886 | @end defmac |
9f09b1f2 | 8887 | |
91d231cb JM |
8888 | @node Target Attributes |
8889 | @section Defining target-specific uses of @code{__attribute__} | |
8890 | @cindex target attributes | |
8891 | @cindex machine attributes | |
8892 | @cindex attributes, target-specific | |
8893 | ||
8894 | Target-specific attributes may be defined for functions, data and types. | |
8895 | These are described using the following target hooks; they also need to | |
8896 | be documented in @file{extend.texi}. | |
8897 | ||
8898 | @deftypevr {Target Hook} {const struct attribute_spec *} TARGET_ATTRIBUTE_TABLE | |
8899 | If defined, this target hook points to an array of @samp{struct | |
8900 | attribute_spec} (defined in @file{tree.h}) specifying the machine | |
8901 | specific attributes for this target and some of the restrictions on the | |
8902 | entities to which these attributes are applied and the arguments they | |
8903 | take. | |
8904 | @end deftypevr | |
8905 | ||
8906 | @deftypefn {Target Hook} int TARGET_COMP_TYPE_ATTRIBUTES (tree @var{type1}, tree @var{type2}) | |
8907 | If defined, this target hook is a function which returns zero if the attributes on | |
8908 | @var{type1} and @var{type2} are incompatible, one if they are compatible, | |
8909 | and two if they are nearly compatible (which causes a warning to be | |
8910 | generated). If this is not defined, machine-specific attributes are | |
8911 | supposed always to be compatible. | |
8912 | @end deftypefn | |
8913 | ||
8914 | @deftypefn {Target Hook} void TARGET_SET_DEFAULT_TYPE_ATTRIBUTES (tree @var{type}) | |
8915 | If defined, this target hook is a function which assigns default attributes to | |
8916 | newly defined @var{type}. | |
8917 | @end deftypefn | |
8918 | ||
8919 | @deftypefn {Target Hook} tree TARGET_MERGE_TYPE_ATTRIBUTES (tree @var{type1}, tree @var{type2}) | |
8920 | Define this target hook if the merging of type attributes needs special | |
8921 | handling. If defined, the result is a list of the combined | |
8922 | @code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed | |
8923 | that @code{comptypes} has already been called and returned 1. This | |
8924 | function may call @code{merge_attributes} to handle machine-independent | |
8925 | merging. | |
8926 | @end deftypefn | |
8927 | ||
8928 | @deftypefn {Target Hook} tree TARGET_MERGE_DECL_ATTRIBUTES (tree @var{olddecl}, tree @var{newdecl}) | |
8929 | Define this target hook if the merging of decl attributes needs special | |
8930 | handling. If defined, the result is a list of the combined | |
8931 | @code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}. | |
8932 | @var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of | |
8933 | when this is needed are when one attribute overrides another, or when an | |
8934 | attribute is nullified by a subsequent definition. This function may | |
8935 | call @code{merge_attributes} to handle machine-independent merging. | |
8936 | ||
8937 | @findex TARGET_DLLIMPORT_DECL_ATTRIBUTES | |
b2ca3702 MM |
8938 | If the only target-specific handling you require is @samp{dllimport} |
8939 | for Microsoft Windows targets, you should define the macro | |
8940 | @code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler | |
8941 | will then define a function called | |
8942 | @code{merge_dllimport_decl_attributes} which can then be defined as | |
8943 | the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also | |
8944 | add @code{handle_dll_attribute} in the attribute table for your port | |
8945 | to perform initial processing of the @samp{dllimport} and | |
8946 | @samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and | |
8947 | @file{i386/i386.c}, for example. | |
91d231cb JM |
8948 | @end deftypefn |
8949 | ||
43d9ad1d DS |
8950 | @deftypefn {Target Hook} bool TARGET_VALID_DLLIMPORT_ATTRIBUTE_P (tree @var{decl}) |
8951 | @var{decl} is a variable or function with @code{__attribute__((dllimport))} | |
8952 | specified. Use this hook if the target needs to add extra validation | |
8953 | checks to @code{handle_dll_attribute}. | |
8954 | @end deftypefn | |
8955 | ||
63c5b495 | 8956 | @defmac TARGET_DECLSPEC |
1a141fe1 | 8957 | Define this macro to a nonzero value if you want to treat |
63c5b495 MM |
8958 | @code{__declspec(X)} as equivalent to @code{__attribute((X))}. By |
8959 | default, this behavior is enabled only for targets that define | |
8960 | @code{TARGET_DLLIMPORT_DECL_ATTRIBUTES}. The current implementation | |
8961 | of @code{__declspec} is via a built-in macro, but you should not rely | |
8962 | on this implementation detail. | |
8963 | @end defmac | |
8964 | ||
91d231cb JM |
8965 | @deftypefn {Target Hook} void TARGET_INSERT_ATTRIBUTES (tree @var{node}, tree *@var{attr_ptr}) |
8966 | Define this target hook if you want to be able to add attributes to a decl | |
8967 | when it is being created. This is normally useful for back ends which | |
8968 | wish to implement a pragma by using the attributes which correspond to | |
8969 | the pragma's effect. The @var{node} argument is the decl which is being | |
8970 | created. The @var{attr_ptr} argument is a pointer to the attribute list | |
8971 | for this decl. The list itself should not be modified, since it may be | |
8972 | shared with other decls, but attributes may be chained on the head of | |
8973 | the list and @code{*@var{attr_ptr}} modified to point to the new | |
8974 | attributes, or a copy of the list may be made if further changes are | |
8975 | needed. | |
8976 | @end deftypefn | |
8977 | ||
8978 | @deftypefn {Target Hook} bool TARGET_FUNCTION_ATTRIBUTE_INLINABLE_P (tree @var{fndecl}) | |
8979 | @cindex inlining | |
8980 | This target hook returns @code{true} if it is ok to inline @var{fndecl} | |
8981 | into the current function, despite its having target-specific | |
8982 | attributes, @code{false} otherwise. By default, if a function has a | |
8983 | target specific attribute attached to it, it will not be inlined. | |
8984 | @end deftypefn | |
8985 | ||
d604bca3 MH |
8986 | @node MIPS Coprocessors |
8987 | @section Defining coprocessor specifics for MIPS targets. | |
8988 | @cindex MIPS coprocessor-definition macros | |
8989 | ||
8990 | The MIPS specification allows MIPS implementations to have as many as 4 | |
2dd76960 | 8991 | coprocessors, each with as many as 32 private registers. GCC supports |
d604bca3 MH |
8992 | accessing these registers and transferring values between the registers |
8993 | and memory using asm-ized variables. For example: | |
8994 | ||
8995 | @smallexample | |
8996 | register unsigned int cp0count asm ("c0r1"); | |
8997 | unsigned int d; | |
8998 | ||
8999 | d = cp0count + 3; | |
9000 | @end smallexample | |
9001 | ||
9002 | (``c0r1'' is the default name of register 1 in coprocessor 0; alternate | |
9003 | names may be added as described below, or the default names may be | |
9004 | overridden entirely in @code{SUBTARGET_CONDITIONAL_REGISTER_USAGE}.) | |
9005 | ||
9006 | Coprocessor registers are assumed to be epilogue-used; sets to them will | |
9007 | be preserved even if it does not appear that the register is used again | |
9008 | later in the function. | |
9009 | ||
9010 | Another note: according to the MIPS spec, coprocessor 1 (if present) is | |
8a36672b | 9011 | the FPU@. One accesses COP1 registers through standard mips |
d604bca3 MH |
9012 | floating-point support; they are not included in this mechanism. |
9013 | ||
9014 | There is one macro used in defining the MIPS coprocessor interface which | |
9015 | you may want to override in subtargets; it is described below. | |
9016 | ||
a2c4f8e0 | 9017 | @defmac ALL_COP_ADDITIONAL_REGISTER_NAMES |
d604bca3 MH |
9018 | A comma-separated list (with leading comma) of pairs describing the |
9019 | alternate names of coprocessor registers. The format of each entry should be | |
9020 | @smallexample | |
9021 | @{ @var{alternatename}, @var{register_number}@} | |
9022 | @end smallexample | |
9023 | Default: empty. | |
a2c4f8e0 | 9024 | @end defmac |
d604bca3 | 9025 | |
7bb1ad93 GK |
9026 | @node PCH Target |
9027 | @section Parameters for Precompiled Header Validity Checking | |
9028 | @cindex parameters, precompiled headers | |
9029 | ||
8d932be3 RS |
9030 | @deftypefn {Target Hook} void *TARGET_GET_PCH_VALIDITY (size_t *@var{sz}) |
9031 | This hook returns the data needed by @code{TARGET_PCH_VALID_P} and sets | |
9032 | @samp{*@var{sz}} to the size of the data in bytes. | |
7bb1ad93 GK |
9033 | @end deftypefn |
9034 | ||
8d932be3 RS |
9035 | @deftypefn {Target Hook} const char *TARGET_PCH_VALID_P (const void *@var{data}, size_t @var{sz}) |
9036 | This hook checks whether the options used to create a PCH file are | |
9037 | compatible with the current settings. It returns @code{NULL} | |
9038 | if so and a suitable error message if not. Error messages will | |
9039 | be presented to the user and must be localized using @samp{_(@var{msg})}. | |
9040 | ||
9041 | @var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY} | |
9042 | when the PCH file was created and @var{sz} is the size of that data in bytes. | |
9043 | It's safe to assume that the data was created by the same version of the | |
9044 | compiler, so no format checking is needed. | |
9045 | ||
9046 | The default definition of @code{default_pch_valid_p} should be | |
9047 | suitable for most targets. | |
9048 | @end deftypefn | |
9049 | ||
9050 | @deftypefn {Target Hook} const char *TARGET_CHECK_PCH_TARGET_FLAGS (int @var{pch_flags}) | |
9051 | If this hook is nonnull, the default implementation of | |
9052 | @code{TARGET_PCH_VALID_P} will use it to check for compatible values | |
9053 | of @code{target_flags}. @var{pch_flags} specifies the value that | |
9054 | @code{target_flags} had when the PCH file was created. The return | |
9055 | value is the same as for @code{TARGET_PCH_VALID_P}. | |
7bb1ad93 GK |
9056 | @end deftypefn |
9057 | ||
4185ae53 PB |
9058 | @node C++ ABI |
9059 | @section C++ ABI parameters | |
9060 | @cindex parameters, c++ abi | |
9061 | ||
9062 | @deftypefn {Target Hook} tree TARGET_CXX_GUARD_TYPE (void) | |
9063 | Define this hook to override the integer type used for guard variables. | |
9064 | These are used to implement one-time construction of static objects. The | |
9065 | default is long_long_integer_type_node. | |
9066 | @end deftypefn | |
9067 | ||
9068 | @deftypefn {Target Hook} bool TARGET_CXX_GUARD_MASK_BIT (void) | |
f676971a | 9069 | This hook determines how guard variables are used. It should return |
4185ae53 PB |
9070 | @code{false} (the default) if first byte should be used. A return value of |
9071 | @code{true} indicates the least significant bit should be used. | |
9072 | @end deftypefn | |
9073 | ||
46e995e0 PB |
9074 | @deftypefn {Target Hook} tree TARGET_CXX_GET_COOKIE_SIZE (tree @var{type}) |
9075 | This hook returns the size of the cookie to use when allocating an array | |
9076 | whose elements have the indicated @var{type}. Assumes that it is already | |
9077 | known that a cookie is needed. The default is | |
9078 | @code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the | |
8a36672b | 9079 | IA64/Generic C++ ABI@. |
46e995e0 PB |
9080 | @end deftypefn |
9081 | ||
9082 | @deftypefn {Target Hook} bool TARGET_CXX_COOKIE_HAS_SIZE (void) | |
9083 | This hook should return @code{true} if the element size should be stored in | |
9084 | array cookies. The default is to return @code{false}. | |
9085 | @end deftypefn | |
9086 | ||
d59c7b4b NC |
9087 | @deftypefn {Target Hook} int TARGET_CXX_IMPORT_EXPORT_CLASS (tree @var{type}, int @var{import_export}) |
9088 | If defined by a backend this hook allows the decision made to export | |
9089 | class @var{type} to be overruled. Upon entry @var{import_export} | |
78466c0e | 9090 | will contain 1 if the class is going to be exported, @minus{}1 if it is going |
d59c7b4b NC |
9091 | to be imported and 0 otherwise. This function should return the |
9092 | modified value and perform any other actions necessary to support the | |
9093 | backend's targeted operating system. | |
9094 | @end deftypefn | |
9095 | ||
44d10c10 PB |
9096 | @deftypefn {Target Hook} bool TARGET_CXX_CDTOR_RETURNS_THIS (void) |
9097 | This hook should return @code{true} if constructors and destructors return | |
9098 | the address of the object created/destroyed. The default is to return | |
9099 | @code{false}. | |
9100 | @end deftypefn | |
9101 | ||
af287697 MM |
9102 | @deftypefn {Target Hook} bool TARGET_CXX_KEY_METHOD_MAY_BE_INLINE (void) |
9103 | This hook returns true if the key method for a class (i.e., the method | |
9104 | which, if defined in the current translation unit, causes the virtual | |
9105 | table to be emitted) may be an inline function. Under the standard | |
9106 | Itanium C++ ABI the key method may be an inline function so long as | |
9107 | the function is not declared inline in the class definition. Under | |
9108 | some variants of the ABI, an inline function can never be the key | |
9109 | method. The default is to return @code{true}. | |
9110 | @end deftypefn | |
9111 | ||
1e731102 MM |
9112 | @deftypefn {Target Hook} void TARGET_CXX_DETERMINE_CLASS_DATA_VISIBILITY (tree @var{decl}) |
9113 | @var{decl} is a virtual table, virtual table table, typeinfo object, | |
9114 | or other similar implicit class data object that will be emitted with | |
9115 | external linkage in this translation unit. No ELF visibility has been | |
9116 | explicitly specified. If the target needs to specify a visibility | |
9117 | other than that of the containing class, use this hook to set | |
9118 | @code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}. | |
9119 | @end deftypefn | |
9120 | ||
9121 | @deftypefn {Target Hook} bool TARGET_CXX_CLASS_DATA_ALWAYS_COMDAT (void) | |
9122 | This hook returns true (the default) if virtual tables and other | |
9123 | similar implicit class data objects are always COMDAT if they have | |
9124 | external linkage. If this hook returns false, then class data for | |
9125 | classes whose virtual table will be emitted in only one translation | |
9126 | unit will not be COMDAT. | |
505970fc MM |
9127 | @end deftypefn |
9128 | ||
157600d0 GK |
9129 | @deftypefn {Target Hook} bool TARGET_CXX_LIBRARY_RTTI_COMDAT (void) |
9130 | This hook returns true (the default) if the RTTI information for | |
9131 | the basic types which is defined in the C++ runtime should always | |
9132 | be COMDAT, false if it should not be COMDAT. | |
9133 | @end deftypefn | |
9134 | ||
9f62c3e3 PB |
9135 | @deftypefn {Target Hook} bool TARGET_CXX_USE_AEABI_ATEXIT (void) |
9136 | This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI) | |
9137 | should be used to register static destructors when @option{-fuse-cxa-atexit} | |
9138 | is in effect. The default is to return false to use @code{__cxa_atexit}. | |
9139 | @end deftypefn | |
9140 | ||
97388150 DS |
9141 | @deftypefn {Target Hook} bool TARGET_CXX_USE_ATEXIT_FOR_CXA_ATEXIT (void) |
9142 | This hook returns true if the target @code{atexit} function can be used | |
9143 | in the same manner as @code{__cxa_atexit} to register C++ static | |
9144 | destructors. This requires that @code{atexit}-registered functions in | |
9145 | shared libraries are run in the correct order when the libraries are | |
9146 | unloaded. The default is to return false. | |
9147 | @end deftypefn | |
9148 | ||
43d9ad1d DS |
9149 | @deftypefn {Target Hook} void TARGET_CXX_ADJUST_CLASS_AT_DEFINITION (tree @var{type}) |
9150 | @var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just been | |
9151 | defined. Use this hook to make adjustments to the class (eg, tweak | |
9152 | visibility or perform any other required target modifications). | |
9153 | @end deftypefn | |
9154 | ||
feca2ed3 JW |
9155 | @node Misc |
9156 | @section Miscellaneous Parameters | |
9157 | @cindex parameters, miscellaneous | |
9158 | ||
9159 | @c prevent bad page break with this line | |
9160 | Here are several miscellaneous parameters. | |
9161 | ||
e543e219 ZW |
9162 | @defmac HAS_LONG_COND_BRANCH |
9163 | Define this boolean macro to indicate whether or not your architecture | |
9164 | has conditional branches that can span all of memory. It is used in | |
9165 | conjunction with an optimization that partitions hot and cold basic | |
9166 | blocks into separate sections of the executable. If this macro is | |
9167 | set to false, gcc will convert any conditional branches that attempt | |
9168 | to cross between sections into unconditional branches or indirect jumps. | |
9169 | @end defmac | |
9170 | ||
9171 | @defmac HAS_LONG_UNCOND_BRANCH | |
9172 | Define this boolean macro to indicate whether or not your architecture | |
9173 | has unconditional branches that can span all of memory. It is used in | |
9174 | conjunction with an optimization that partitions hot and cold basic | |
9175 | blocks into separate sections of the executable. If this macro is | |
9176 | set to false, gcc will convert any unconditional branches that attempt | |
9177 | to cross between sections into indirect jumps. | |
a2c4f8e0 | 9178 | @end defmac |
8fe0ca0c | 9179 | |
a2c4f8e0 | 9180 | @defmac CASE_VECTOR_MODE |
feca2ed3 JW |
9181 | An alias for a machine mode name. This is the machine mode that |
9182 | elements of a jump-table should have. | |
a2c4f8e0 | 9183 | @end defmac |
feca2ed3 | 9184 | |
a2c4f8e0 | 9185 | @defmac CASE_VECTOR_SHORTEN_MODE (@var{min_offset}, @var{max_offset}, @var{body}) |
33f7f353 JR |
9186 | Optional: return the preferred mode for an @code{addr_diff_vec} |
9187 | when the minimum and maximum offset are known. If you define this, | |
9188 | it enables extra code in branch shortening to deal with @code{addr_diff_vec}. | |
4226378a | 9189 | To make this work, you also have to define @code{INSN_ALIGN} and |
33f7f353 | 9190 | make the alignment for @code{addr_diff_vec} explicit. |
391aaa6b | 9191 | The @var{body} argument is provided so that the offset_unsigned and scale |
33f7f353 | 9192 | flags can be updated. |
a2c4f8e0 | 9193 | @end defmac |
33f7f353 | 9194 | |
a2c4f8e0 | 9195 | @defmac CASE_VECTOR_PC_RELATIVE |
18543a22 | 9196 | Define this macro to be a C expression to indicate when jump-tables |
9c49953c KH |
9197 | should contain relative addresses. You need not define this macro if |
9198 | jump-tables never contain relative addresses, or jump-tables should | |
9199 | contain relative addresses only when @option{-fPIC} or @option{-fPIC} | |
9200 | is in effect. | |
a2c4f8e0 | 9201 | @end defmac |
feca2ed3 | 9202 | |
a2c4f8e0 | 9203 | @defmac CASE_VALUES_THRESHOLD |
feca2ed3 JW |
9204 | Define this to be the smallest number of different values for which it |
9205 | is best to use a jump-table instead of a tree of conditional branches. | |
9206 | The default is four for machines with a @code{casesi} instruction and | |
9207 | five otherwise. This is best for most machines. | |
a2c4f8e0 | 9208 | @end defmac |
feca2ed3 | 9209 | |
a2c4f8e0 | 9210 | @defmac CASE_USE_BIT_TESTS |
9bb231fd RS |
9211 | Define this macro to be a C expression to indicate whether C switch |
9212 | statements may be implemented by a sequence of bit tests. This is | |
9213 | advantageous on processors that can efficiently implement left shift | |
9214 | of 1 by the number of bits held in a register, but inappropriate on | |
9215 | targets that would require a loop. By default, this macro returns | |
9216 | @code{true} if the target defines an @code{ashlsi3} pattern, and | |
9217 | @code{false} otherwise. | |
a2c4f8e0 | 9218 | @end defmac |
9bb231fd | 9219 | |
a2c4f8e0 | 9220 | @defmac WORD_REGISTER_OPERATIONS |
feca2ed3 JW |
9221 | Define this macro if operations between registers with integral mode |
9222 | smaller than a word are always performed on the entire register. | |
9223 | Most RISC machines have this property and most CISC machines do not. | |
a2c4f8e0 | 9224 | @end defmac |
feca2ed3 | 9225 | |
7be4d808 | 9226 | @defmac LOAD_EXTEND_OP (@var{mem_mode}) |
feca2ed3 | 9227 | Define this macro to be a C expression indicating when insns that read |
7be4d808 R |
9228 | memory in @var{mem_mode}, an integral mode narrower than a word, set the |
9229 | bits outside of @var{mem_mode} to be either the sign-extension or the | |
feca2ed3 | 9230 | zero-extension of the data read. Return @code{SIGN_EXTEND} for values |
7be4d808 | 9231 | of @var{mem_mode} for which the |
feca2ed3 | 9232 | insn sign-extends, @code{ZERO_EXTEND} for which it zero-extends, and |
f822d252 | 9233 | @code{UNKNOWN} for other modes. |
feca2ed3 | 9234 | |
7be4d808 | 9235 | This macro is not called with @var{mem_mode} non-integral or with a width |
feca2ed3 JW |
9236 | greater than or equal to @code{BITS_PER_WORD}, so you may return any |
9237 | value in this case. Do not define this macro if it would always return | |
f822d252 | 9238 | @code{UNKNOWN}. On machines where this macro is defined, you will normally |
feca2ed3 | 9239 | define it as the constant @code{SIGN_EXTEND} or @code{ZERO_EXTEND}. |
7be4d808 | 9240 | |
f822d252 | 9241 | You may return a non-@code{UNKNOWN} value even if for some hard registers |
7be4d808 R |
9242 | the sign extension is not performed, if for the @code{REGNO_REG_CLASS} |
9243 | of these hard registers @code{CANNOT_CHANGE_MODE_CLASS} returns nonzero | |
9244 | when the @var{from} mode is @var{mem_mode} and the @var{to} mode is any | |
9245 | integral mode larger than this but not larger than @code{word_mode}. | |
9246 | ||
f822d252 | 9247 | You must return @code{UNKNOWN} if for some hard registers that allow this |
7be4d808 R |
9248 | mode, @code{CANNOT_CHANGE_MODE_CLASS} says that they cannot change to |
9249 | @code{word_mode}, but that they can change to another integral mode that | |
9250 | is larger then @var{mem_mode} but still smaller than @code{word_mode}. | |
a2c4f8e0 | 9251 | @end defmac |
feca2ed3 | 9252 | |
a2c4f8e0 | 9253 | @defmac SHORT_IMMEDIATES_SIGN_EXTEND |
77643ab8 MM |
9254 | Define this macro if loading short immediate values into registers sign |
9255 | extends. | |
a2c4f8e0 | 9256 | @end defmac |
77643ab8 | 9257 | |
a2c4f8e0 | 9258 | @defmac FIXUNS_TRUNC_LIKE_FIX_TRUNC |
feca2ed3 JW |
9259 | Define this macro if the same instructions that convert a floating |
9260 | point number to a signed fixed point number also convert validly to an | |
9261 | unsigned one. | |
a2c4f8e0 | 9262 | @end defmac |
feca2ed3 | 9263 | |
bc23502b PB |
9264 | @deftypefn {Target Hook} int TARGET_MIN_DIVISIONS_FOR_RECIP_MUL (enum machine_mode @var{mode}) |
9265 | When @option{-ffast-math} is in effect, GCC tries to optimize | |
9266 | divisions by the same divisor, by turning them into multiplications by | |
9267 | the reciprocal. This target hook specifies the minimum number of divisions | |
9268 | that should be there for GCC to perform the optimization for a variable | |
9269 | of mode @var{mode}. The default implementation returns 3 if the machine | |
9270 | has an instruction for the division, and 2 if it does not. | |
9271 | @end deftypefn | |
9272 | ||
a2c4f8e0 | 9273 | @defmac MOVE_MAX |
feca2ed3 JW |
9274 | The maximum number of bytes that a single instruction can move quickly |
9275 | between memory and registers or between two memory locations. | |
a2c4f8e0 | 9276 | @end defmac |
feca2ed3 | 9277 | |
a2c4f8e0 | 9278 | @defmac MAX_MOVE_MAX |
feca2ed3 JW |
9279 | The maximum number of bytes that a single instruction can move quickly |
9280 | between memory and registers or between two memory locations. If this | |
9281 | is undefined, the default is @code{MOVE_MAX}. Otherwise, it is the | |
9282 | constant value that is the largest value that @code{MOVE_MAX} can have | |
9283 | at run-time. | |
a2c4f8e0 | 9284 | @end defmac |
feca2ed3 | 9285 | |
a2c4f8e0 | 9286 | @defmac SHIFT_COUNT_TRUNCATED |
feca2ed3 JW |
9287 | A C expression that is nonzero if on this machine the number of bits |
9288 | actually used for the count of a shift operation is equal to the number | |
9289 | of bits needed to represent the size of the object being shifted. When | |
df2a54e9 | 9290 | this macro is nonzero, the compiler will assume that it is safe to omit |
feca2ed3 JW |
9291 | a sign-extend, zero-extend, and certain bitwise `and' instructions that |
9292 | truncates the count of a shift operation. On machines that have | |
c771326b | 9293 | instructions that act on bit-fields at variable positions, which may |
feca2ed3 JW |
9294 | include `bit test' instructions, a nonzero @code{SHIFT_COUNT_TRUNCATED} |
9295 | also enables deletion of truncations of the values that serve as | |
c771326b | 9296 | arguments to bit-field instructions. |
feca2ed3 JW |
9297 | |
9298 | If both types of instructions truncate the count (for shifts) and | |
c771326b | 9299 | position (for bit-field operations), or if no variable-position bit-field |
feca2ed3 JW |
9300 | instructions exist, you should define this macro. |
9301 | ||
9302 | However, on some machines, such as the 80386 and the 680x0, truncation | |
9303 | only applies to shift operations and not the (real or pretended) | |
c771326b | 9304 | bit-field operations. Define @code{SHIFT_COUNT_TRUNCATED} to be zero on |
feca2ed3 JW |
9305 | such machines. Instead, add patterns to the @file{md} file that include |
9306 | the implied truncation of the shift instructions. | |
9307 | ||
9308 | You need not define this macro if it would always have the value of zero. | |
a2c4f8e0 | 9309 | @end defmac |
feca2ed3 | 9310 | |
273a2526 RS |
9311 | @anchor{TARGET_SHIFT_TRUNCATION_MASK} |
9312 | @deftypefn {Target Hook} int TARGET_SHIFT_TRUNCATION_MASK (enum machine_mode @var{mode}) | |
9313 | This function describes how the standard shift patterns for @var{mode} | |
9314 | deal with shifts by negative amounts or by more than the width of the mode. | |
9315 | @xref{shift patterns}. | |
9316 | ||
9317 | On many machines, the shift patterns will apply a mask @var{m} to the | |
9318 | shift count, meaning that a fixed-width shift of @var{x} by @var{y} is | |
9319 | equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If | |
9320 | this is true for mode @var{mode}, the function should return @var{m}, | |
9321 | otherwise it should return 0. A return value of 0 indicates that no | |
9322 | particular behavior is guaranteed. | |
9323 | ||
9324 | Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does | |
9325 | @emph{not} apply to general shift rtxes; it applies only to instructions | |
9326 | that are generated by the named shift patterns. | |
9327 | ||
9328 | The default implementation of this function returns | |
9329 | @code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED} | |
9330 | and 0 otherwise. This definition is always safe, but if | |
9331 | @code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns | |
9332 | nevertheless truncate the shift count, you may get better code | |
9333 | by overriding it. | |
9334 | @end deftypefn | |
9335 | ||
a2c4f8e0 | 9336 | @defmac TRULY_NOOP_TRUNCATION (@var{outprec}, @var{inprec}) |
feca2ed3 JW |
9337 | A C expression which is nonzero if on this machine it is safe to |
9338 | ``convert'' an integer of @var{inprec} bits to one of @var{outprec} | |
9339 | bits (where @var{outprec} is smaller than @var{inprec}) by merely | |
9340 | operating on it as if it had only @var{outprec} bits. | |
9341 | ||
9342 | On many machines, this expression can be 1. | |
9343 | ||
9344 | @c rearranged this, removed the phrase "it is reported that". this was | |
9345 | @c to fix an overfull hbox. --mew 10feb93 | |
9346 | When @code{TRULY_NOOP_TRUNCATION} returns 1 for a pair of sizes for | |
9347 | modes for which @code{MODES_TIEABLE_P} is 0, suboptimal code can result. | |
9348 | If this is the case, making @code{TRULY_NOOP_TRUNCATION} return 0 in | |
9349 | such cases may improve things. | |
a2c4f8e0 | 9350 | @end defmac |
feca2ed3 | 9351 | |
b12cbf2c | 9352 | @deftypefn {Target Hook} int TARGET_MODE_REP_EXTENDED (enum machine_mode @var{mode}, enum machine_mode @var{rep_mode}) |
66a4ad37 | 9353 | The representation of an integral mode can be such that the values |
b12cbf2c AN |
9354 | are always extended to a wider integral mode. Return |
9355 | @code{SIGN_EXTEND} if values of @var{mode} are represented in | |
9356 | sign-extended form to @var{rep_mode}. Return @code{UNKNOWN} | |
9357 | otherwise. (Currently, none of the targets use zero-extended | |
9358 | representation this way so unlike @code{LOAD_EXTEND_OP}, | |
9359 | @code{TARGET_MODE_REP_EXTENDED} is expected to return either | |
9360 | @code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends | |
9361 | @var{mode} to @var{mode_rep} so that @var{mode_rep} is not the next | |
9362 | widest integral mode and currently we take advantage of this fact.) | |
9363 | ||
9364 | Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN} | |
9365 | value even if the extension is not performed on certain hard registers | |
9366 | as long as for the @code{REGNO_REG_CLASS} of these hard registers | |
9367 | @code{CANNOT_CHANGE_MODE_CLASS} returns nonzero. | |
9368 | ||
9369 | Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP} | |
9370 | describe two related properties. If you define | |
9371 | @code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want | |
9372 | to define @code{LOAD_EXTEND_OP (mode)} to return the same type of | |
9373 | extension. | |
9374 | ||
9375 | In order to enforce the representation of @code{mode}, | |
9376 | @code{TRULY_NOOP_TRUNCATION} should return false when truncating to | |
9377 | @code{mode}. | |
9378 | @end deftypefn | |
9379 | ||
a2c4f8e0 | 9380 | @defmac STORE_FLAG_VALUE |
feca2ed3 JW |
9381 | A C expression describing the value returned by a comparison operator |
9382 | with an integral mode and stored by a store-flag instruction | |
9383 | (@samp{s@var{cond}}) when the condition is true. This description must | |
9384 | apply to @emph{all} the @samp{s@var{cond}} patterns and all the | |
9385 | comparison operators whose results have a @code{MODE_INT} mode. | |
9386 | ||
630d3d5a JM |
9387 | A value of 1 or @minus{}1 means that the instruction implementing the |
9388 | comparison operator returns exactly 1 or @minus{}1 when the comparison is true | |
feca2ed3 JW |
9389 | and 0 when the comparison is false. Otherwise, the value indicates |
9390 | which bits of the result are guaranteed to be 1 when the comparison is | |
9391 | true. This value is interpreted in the mode of the comparison | |
9392 | operation, which is given by the mode of the first operand in the | |
9393 | @samp{s@var{cond}} pattern. Either the low bit or the sign bit of | |
9394 | @code{STORE_FLAG_VALUE} be on. Presently, only those bits are used by | |
9395 | the compiler. | |
9396 | ||
630d3d5a | 9397 | If @code{STORE_FLAG_VALUE} is neither 1 or @minus{}1, the compiler will |
feca2ed3 JW |
9398 | generate code that depends only on the specified bits. It can also |
9399 | replace comparison operators with equivalent operations if they cause | |
9400 | the required bits to be set, even if the remaining bits are undefined. | |
9401 | For example, on a machine whose comparison operators return an | |
9402 | @code{SImode} value and where @code{STORE_FLAG_VALUE} is defined as | |
9403 | @samp{0x80000000}, saying that just the sign bit is relevant, the | |
9404 | expression | |
9405 | ||
9406 | @smallexample | |
9407 | (ne:SI (and:SI @var{x} (const_int @var{power-of-2})) (const_int 0)) | |
9408 | @end smallexample | |
9409 | ||
9410 | @noindent | |
9411 | can be converted to | |
9412 | ||
9413 | @smallexample | |
9414 | (ashift:SI @var{x} (const_int @var{n})) | |
9415 | @end smallexample | |
9416 | ||
9417 | @noindent | |
9418 | where @var{n} is the appropriate shift count to move the bit being | |
9419 | tested into the sign bit. | |
9420 | ||
9421 | There is no way to describe a machine that always sets the low-order bit | |
9422 | for a true value, but does not guarantee the value of any other bits, | |
9423 | but we do not know of any machine that has such an instruction. If you | |
a3a15b4d | 9424 | are trying to port GCC to such a machine, include an instruction to |
feca2ed3 | 9425 | perform a logical-and of the result with 1 in the pattern for the |
b11cc610 | 9426 | comparison operators and let us know at @email{gcc@@gcc.gnu.org}. |
feca2ed3 JW |
9427 | |
9428 | Often, a machine will have multiple instructions that obtain a value | |
9429 | from a comparison (or the condition codes). Here are rules to guide the | |
9430 | choice of value for @code{STORE_FLAG_VALUE}, and hence the instructions | |
9431 | to be used: | |
9432 | ||
9433 | @itemize @bullet | |
9434 | @item | |
9435 | Use the shortest sequence that yields a valid definition for | |
9436 | @code{STORE_FLAG_VALUE}. It is more efficient for the compiler to | |
9437 | ``normalize'' the value (convert it to, e.g., 1 or 0) than for the | |
9438 | comparison operators to do so because there may be opportunities to | |
9439 | combine the normalization with other operations. | |
9440 | ||
9441 | @item | |
630d3d5a | 9442 | For equal-length sequences, use a value of 1 or @minus{}1, with @minus{}1 being |
feca2ed3 JW |
9443 | slightly preferred on machines with expensive jumps and 1 preferred on |
9444 | other machines. | |
9445 | ||
9446 | @item | |
9447 | As a second choice, choose a value of @samp{0x80000001} if instructions | |
9448 | exist that set both the sign and low-order bits but do not define the | |
9449 | others. | |
9450 | ||
9451 | @item | |
9452 | Otherwise, use a value of @samp{0x80000000}. | |
9453 | @end itemize | |
9454 | ||
9455 | Many machines can produce both the value chosen for | |
9456 | @code{STORE_FLAG_VALUE} and its negation in the same number of | |
9457 | instructions. On those machines, you should also define a pattern for | |
9458 | those cases, e.g., one matching | |
9459 | ||
9460 | @smallexample | |
9461 | (set @var{A} (neg:@var{m} (ne:@var{m} @var{B} @var{C}))) | |
9462 | @end smallexample | |
9463 | ||
9464 | Some machines can also perform @code{and} or @code{plus} operations on | |
9465 | condition code values with less instructions than the corresponding | |
9466 | @samp{s@var{cond}} insn followed by @code{and} or @code{plus}. On those | |
9467 | machines, define the appropriate patterns. Use the names @code{incscc} | |
9468 | and @code{decscc}, respectively, for the patterns which perform | |
9469 | @code{plus} or @code{minus} operations on condition code values. See | |
9470 | @file{rs6000.md} for some examples. The GNU Superoptizer can be used to | |
9471 | find such instruction sequences on other machines. | |
9472 | ||
06f31100 RS |
9473 | If this macro is not defined, the default value, 1, is used. You need |
9474 | not define @code{STORE_FLAG_VALUE} if the machine has no store-flag | |
9475 | instructions, or if the value generated by these instructions is 1. | |
a2c4f8e0 | 9476 | @end defmac |
feca2ed3 | 9477 | |
a2c4f8e0 | 9478 | @defmac FLOAT_STORE_FLAG_VALUE (@var{mode}) |
df2a54e9 | 9479 | A C expression that gives a nonzero @code{REAL_VALUE_TYPE} value that is |
feca2ed3 | 9480 | returned when comparison operators with floating-point results are true. |
fc7ca5fd | 9481 | Define this macro on machines that have comparison operations that return |
feca2ed3 JW |
9482 | floating-point values. If there are no such operations, do not define |
9483 | this macro. | |
a2c4f8e0 | 9484 | @end defmac |
feca2ed3 | 9485 | |
fc7ca5fd | 9486 | @defmac VECTOR_STORE_FLAG_VALUE (@var{mode}) |
a4d05547 | 9487 | A C expression that gives a rtx representing the nonzero true element |
fc7ca5fd RS |
9488 | for vector comparisons. The returned rtx should be valid for the inner |
9489 | mode of @var{mode} which is guaranteed to be a vector mode. Define | |
9490 | this macro on machines that have vector comparison operations that | |
9491 | return a vector result. If there are no such operations, do not define | |
9492 | this macro. Typically, this macro is defined as @code{const1_rtx} or | |
9493 | @code{constm1_rtx}. This macro may return @code{NULL_RTX} to prevent | |
9494 | the compiler optimizing such vector comparison operations for the | |
9495 | given mode. | |
9496 | @end defmac | |
9497 | ||
a2c4f8e0 ZW |
9498 | @defmac CLZ_DEFINED_VALUE_AT_ZERO (@var{mode}, @var{value}) |
9499 | @defmacx CTZ_DEFINED_VALUE_AT_ZERO (@var{mode}, @var{value}) | |
7dba8395 RH |
9500 | A C expression that evaluates to true if the architecture defines a value |
9501 | for @code{clz} or @code{ctz} with a zero operand. If so, @var{value} | |
9502 | should be set to this value. If this macro is not defined, the value of | |
9503 | @code{clz} or @code{ctz} is assumed to be undefined. | |
9504 | ||
9505 | This macro must be defined if the target's expansion for @code{ffs} | |
9506 | relies on a particular value to get correct results. Otherwise it | |
9507 | is not necessary, though it may be used to optimize some corner cases. | |
9508 | ||
9509 | Note that regardless of this macro the ``definedness'' of @code{clz} | |
9510 | and @code{ctz} at zero do @emph{not} extend to the builtin functions | |
9511 | visible to the user. Thus one may be free to adjust the value at will | |
9512 | to match the target expansion of these operations without fear of | |
8a36672b | 9513 | breaking the API@. |
a2c4f8e0 | 9514 | @end defmac |
7dba8395 | 9515 | |
a2c4f8e0 | 9516 | @defmac Pmode |
feca2ed3 JW |
9517 | An alias for the machine mode for pointers. On most machines, define |
9518 | this to be the integer mode corresponding to the width of a hardware | |
9519 | pointer; @code{SImode} on 32-bit machine or @code{DImode} on 64-bit machines. | |
9520 | On some machines you must define this to be one of the partial integer | |
9521 | modes, such as @code{PSImode}. | |
9522 | ||
9523 | The width of @code{Pmode} must be at least as large as the value of | |
9524 | @code{POINTER_SIZE}. If it is not equal, you must define the macro | |
9525 | @code{POINTERS_EXTEND_UNSIGNED} to specify how pointers are extended | |
9526 | to @code{Pmode}. | |
a2c4f8e0 | 9527 | @end defmac |
feca2ed3 | 9528 | |
a2c4f8e0 | 9529 | @defmac FUNCTION_MODE |
feca2ed3 JW |
9530 | An alias for the machine mode used for memory references to functions |
9531 | being called, in @code{call} RTL expressions. On most machines this | |
9532 | should be @code{QImode}. | |
a2c4f8e0 | 9533 | @end defmac |
feca2ed3 | 9534 | |
a2c4f8e0 | 9535 | @defmac STDC_0_IN_SYSTEM_HEADERS |
ee773fcc NB |
9536 | In normal operation, the preprocessor expands @code{__STDC__} to the |
9537 | constant 1, to signify that GCC conforms to ISO Standard C@. On some | |
9538 | hosts, like Solaris, the system compiler uses a different convention, | |
9539 | where @code{__STDC__} is normally 0, but is 1 if the user specifies | |
9540 | strict conformance to the C Standard. | |
9541 | ||
9542 | Defining @code{STDC_0_IN_SYSTEM_HEADERS} makes GNU CPP follows the host | |
9543 | convention when processing system header files, but when processing user | |
9544 | files @code{__STDC__} will always expand to 1. | |
a2c4f8e0 | 9545 | @end defmac |
ee773fcc | 9546 | |
a2c4f8e0 | 9547 | @defmac NO_IMPLICIT_EXTERN_C |
161d7b59 | 9548 | Define this macro if the system header files support C++ as well as C@. |
feca2ed3 JW |
9549 | This macro inhibits the usual method of using system header files in |
9550 | C++, which is to pretend that the file's contents are enclosed in | |
9551 | @samp{extern "C" @{@dots{}@}}. | |
a2c4f8e0 | 9552 | @end defmac |
feca2ed3 | 9553 | |
feca2ed3 JW |
9554 | @findex #pragma |
9555 | @findex pragma | |
a2c4f8e0 | 9556 | @defmac REGISTER_TARGET_PRAGMAS () |
8b97c5f8 | 9557 | Define this macro if you want to implement any target-specific pragmas. |
a5da89c6 | 9558 | If defined, it is a C expression which makes a series of calls to |
b5b3e36a DJ |
9559 | @code{c_register_pragma} or @code{c_register_pragma_with_expansion} |
9560 | for each pragma. The macro may also do any | |
a5da89c6 | 9561 | setup required for the pragmas. |
8b97c5f8 ZW |
9562 | |
9563 | The primary reason to define this macro is to provide compatibility with | |
9564 | other compilers for the same target. In general, we discourage | |
161d7b59 | 9565 | definition of target-specific pragmas for GCC@. |
feca2ed3 | 9566 | |
c237e94a | 9567 | If the pragma can be implemented by attributes then you should consider |
91d231cb | 9568 | defining the target hook @samp{TARGET_INSERT_ATTRIBUTES} as well. |
f09db6e0 | 9569 | |
8b97c5f8 ZW |
9570 | Preprocessor macros that appear on pragma lines are not expanded. All |
9571 | @samp{#pragma} directives that do not match any registered pragma are | |
630d3d5a | 9572 | silently ignored, unless the user specifies @option{-Wunknown-pragmas}. |
a2c4f8e0 | 9573 | @end defmac |
8b97c5f8 | 9574 | |
c58b209a | 9575 | @deftypefun void c_register_pragma (const char *@var{space}, const char *@var{name}, void (*@var{callback}) (struct cpp_reader *)) |
b5b3e36a | 9576 | @deftypefunx void c_register_pragma_with_expansion (const char *@var{space}, const char *@var{name}, void (*@var{callback}) (struct cpp_reader *)) |
8b97c5f8 | 9577 | |
b5b3e36a DJ |
9578 | Each call to @code{c_register_pragma} or |
9579 | @code{c_register_pragma_with_expansion} establishes one pragma. The | |
8b97c5f8 ZW |
9580 | @var{callback} routine will be called when the preprocessor encounters a |
9581 | pragma of the form | |
9582 | ||
9583 | @smallexample | |
9584 | #pragma [@var{space}] @var{name} @dots{} | |
9585 | @end smallexample | |
9586 | ||
a5da89c6 NB |
9587 | @var{space} is the case-sensitive namespace of the pragma, or |
9588 | @code{NULL} to put the pragma in the global namespace. The callback | |
9589 | routine receives @var{pfile} as its first argument, which can be passed | |
51fabca5 | 9590 | on to cpplib's functions if necessary. You can lex tokens after the |
75ce3d48 | 9591 | @var{name} by calling @code{pragma_lex}. Tokens that are not read by the |
51fabca5 | 9592 | callback will be silently ignored. The end of the line is indicated by |
b5b3e36a DJ |
9593 | a token of type @code{CPP_EOF}. Macro expansion occurs on the |
9594 | arguments of pragmas registered with | |
9595 | @code{c_register_pragma_with_expansion} but not on the arguments of | |
9596 | pragmas registered with @code{c_register_pragma}. | |
8b97c5f8 ZW |
9597 | |
9598 | For an example use of this routine, see @file{c4x.h} and the callback | |
51fabca5 | 9599 | routines defined in @file{c4x-c.c}. |
aac69a49 | 9600 | |
75ce3d48 | 9601 | Note that the use of @code{pragma_lex} is specific to the C and C++ |
aac69a49 | 9602 | compilers. It will not work in the Java or Fortran compilers, or any |
75ce3d48 | 9603 | other language compilers for that matter. Thus if @code{pragma_lex} is going |
aac69a49 | 9604 | to be called from target-specific code, it must only be done so when |
c771326b | 9605 | building the C and C++ compilers. This can be done by defining the |
aac69a49 | 9606 | variables @code{c_target_objs} and @code{cxx_target_objs} in the |
aee96fe9 | 9607 | target entry in the @file{config.gcc} file. These variables should name |
aac69a49 | 9608 | the target-specific, language-specific object file which contains the |
75ce3d48 | 9609 | code that uses @code{pragma_lex}. Note it will also be necessary to add a |
aac69a49 NC |
9610 | rule to the makefile fragment pointed to by @code{tmake_file} that shows |
9611 | how to build this object file. | |
8b97c5f8 ZW |
9612 | @end deftypefun |
9613 | ||
e2af664c NC |
9614 | @findex #pragma |
9615 | @findex pragma | |
a2c4f8e0 | 9616 | @defmac HANDLE_SYSV_PRAGMA |
e2af664c NC |
9617 | Define this macro (to a value of 1) if you want the System V style |
9618 | pragmas @samp{#pragma pack(<n>)} and @samp{#pragma weak <name> | |
9619 | [=<value>]} to be supported by gcc. | |
9620 | ||
9621 | The pack pragma specifies the maximum alignment (in bytes) of fields | |
9622 | within a structure, in much the same way as the @samp{__aligned__} and | |
9623 | @samp{__packed__} @code{__attribute__}s do. A pack value of zero resets | |
c21cd8b1 | 9624 | the behavior to the default. |
e2af664c | 9625 | |
e4850f36 | 9626 | A subtlety for Microsoft Visual C/C++ style bit-field packing |
431ae0bf | 9627 | (e.g.@: -mms-bitfields) for targets that support it: |
e4850f36 DR |
9628 | When a bit-field is inserted into a packed record, the whole size |
9629 | of the underlying type is used by one or more same-size adjacent | |
9630 | bit-fields (that is, if its long:3, 32 bits is used in the record, | |
9631 | and any additional adjacent long bit-fields are packed into the same | |
8a36672b | 9632 | chunk of 32 bits. However, if the size changes, a new field of that |
e4850f36 DR |
9633 | size is allocated). |
9634 | ||
9635 | If both MS bit-fields and @samp{__attribute__((packed))} are used, | |
8a36672b | 9636 | the latter will take precedence. If @samp{__attribute__((packed))} is |
e4850f36 DR |
9637 | used on a single field when MS bit-fields are in use, it will take |
9638 | precedence for that field, but the alignment of the rest of the structure | |
9639 | may affect its placement. | |
9640 | ||
e2af664c NC |
9641 | The weak pragma only works if @code{SUPPORTS_WEAK} and |
9642 | @code{ASM_WEAKEN_LABEL} are defined. If enabled it allows the creation | |
9643 | of specifically named weak labels, optionally with a value. | |
a2c4f8e0 | 9644 | @end defmac |
e2af664c | 9645 | |
e2af664c NC |
9646 | @findex #pragma |
9647 | @findex pragma | |
a2c4f8e0 | 9648 | @defmac HANDLE_PRAGMA_PACK_PUSH_POP |
e2af664c | 9649 | Define this macro (to a value of 1) if you want to support the Win32 |
467cecf3 JB |
9650 | style pragmas @samp{#pragma pack(push[,@var{n}])} and @samp{#pragma |
9651 | pack(pop)}. The @samp{pack(push,[@var{n}])} pragma specifies the maximum | |
9652 | alignment (in bytes) of fields within a structure, in much the same way as | |
9653 | the @samp{__aligned__} and @samp{__packed__} @code{__attribute__}s do. A | |
c21cd8b1 | 9654 | pack value of zero resets the behavior to the default. Successive |
e2af664c NC |
9655 | invocations of this pragma cause the previous values to be stacked, so |
9656 | that invocations of @samp{#pragma pack(pop)} will return to the previous | |
9657 | value. | |
a2c4f8e0 | 9658 | @end defmac |
feca2ed3 | 9659 | |
b5b3e36a DJ |
9660 | @defmac HANDLE_PRAGMA_PACK_WITH_EXPANSION |
9661 | Define this macro, as well as | |
9662 | @code{HANDLE_SYSV_PRAGMA}, if macros should be expanded in the | |
9663 | arguments of @samp{#pragma pack}. | |
9664 | @end defmac | |
9665 | ||
467cecf3 JB |
9666 | @defmac TARGET_DEFAULT_PACK_STRUCT |
9667 | If your target requires a structure packing default other than 0 (meaning | |
0bdcd332 | 9668 | the machine default), define this macro to the necessary value (in bytes). |
8b7d4300 | 9669 | This must be a value that would also be valid to use with |
467cecf3 JB |
9670 | @samp{#pragma pack()} (that is, a small power of two). |
9671 | @end defmac | |
9672 | ||
a2c4f8e0 | 9673 | @defmac DOLLARS_IN_IDENTIFIERS |
b1822ccc NB |
9674 | Define this macro to control use of the character @samp{$} in |
9675 | identifier names for the C family of languages. 0 means @samp{$} is | |
9676 | not allowed by default; 1 means it is allowed. 1 is the default; | |
9677 | there is no need to define this macro in that case. | |
a2c4f8e0 | 9678 | @end defmac |
feca2ed3 | 9679 | |
a2c4f8e0 | 9680 | @defmac NO_DOLLAR_IN_LABEL |
feca2ed3 JW |
9681 | Define this macro if the assembler does not accept the character |
9682 | @samp{$} in label names. By default constructors and destructors in | |
9683 | G++ have @samp{$} in the identifiers. If this macro is defined, | |
9684 | @samp{.} is used instead. | |
a2c4f8e0 | 9685 | @end defmac |
feca2ed3 | 9686 | |
a2c4f8e0 | 9687 | @defmac NO_DOT_IN_LABEL |
feca2ed3 JW |
9688 | Define this macro if the assembler does not accept the character |
9689 | @samp{.} in label names. By default constructors and destructors in G++ | |
9690 | have names that use @samp{.}. If this macro is defined, these names | |
9691 | are rewritten to avoid @samp{.}. | |
a2c4f8e0 | 9692 | @end defmac |
feca2ed3 | 9693 | |
a2c4f8e0 | 9694 | @defmac INSN_SETS_ARE_DELAYED (@var{insn}) |
feca2ed3 JW |
9695 | Define this macro as a C expression that is nonzero if it is safe for the |
9696 | delay slot scheduler to place instructions in the delay slot of @var{insn}, | |
9697 | even if they appear to use a resource set or clobbered in @var{insn}. | |
a3a15b4d | 9698 | @var{insn} is always a @code{jump_insn} or an @code{insn}; GCC knows that |
feca2ed3 JW |
9699 | every @code{call_insn} has this behavior. On machines where some @code{insn} |
9700 | or @code{jump_insn} is really a function call and hence has this behavior, | |
9701 | you should define this macro. | |
9702 | ||
9703 | You need not define this macro if it would always return zero. | |
a2c4f8e0 | 9704 | @end defmac |
feca2ed3 | 9705 | |
a2c4f8e0 | 9706 | @defmac INSN_REFERENCES_ARE_DELAYED (@var{insn}) |
feca2ed3 JW |
9707 | Define this macro as a C expression that is nonzero if it is safe for the |
9708 | delay slot scheduler to place instructions in the delay slot of @var{insn}, | |
9709 | even if they appear to set or clobber a resource referenced in @var{insn}. | |
9710 | @var{insn} is always a @code{jump_insn} or an @code{insn}. On machines where | |
9711 | some @code{insn} or @code{jump_insn} is really a function call and its operands | |
9712 | are registers whose use is actually in the subroutine it calls, you should | |
9713 | define this macro. Doing so allows the delay slot scheduler to move | |
9714 | instructions which copy arguments into the argument registers into the delay | |
9715 | slot of @var{insn}. | |
9716 | ||
9717 | You need not define this macro if it would always return zero. | |
a2c4f8e0 | 9718 | @end defmac |
feca2ed3 | 9719 | |
a2c4f8e0 | 9720 | @defmac MULTIPLE_SYMBOL_SPACES |
15072eb1 ZW |
9721 | Define this macro as a C expression that is nonzero if, in some cases, |
9722 | global symbols from one translation unit may not be bound to undefined | |
9723 | symbols in another translation unit without user intervention. For | |
9724 | instance, under Microsoft Windows symbols must be explicitly imported | |
9725 | from shared libraries (DLLs). | |
9726 | ||
9727 | You need not define this macro if it would always evaluate to zero. | |
a2c4f8e0 | 9728 | @end defmac |
861bb6c1 | 9729 | |
61158923 | 9730 | @deftypefn {Target Hook} tree TARGET_MD_ASM_CLOBBERS (tree @var{outputs}, tree @var{inputs}, tree @var{clobbers}) |
67dfe110 | 9731 | This target hook should add to @var{clobbers} @code{STRING_CST} trees for |
61158923 | 9732 | any hard regs the port wishes to automatically clobber for an asm. |
67dfe110 | 9733 | It should return the result of the last @code{tree_cons} used to add a |
61158923 HPN |
9734 | clobber. The @var{outputs}, @var{inputs} and @var{clobber} lists are the |
9735 | corresponding parameters to the asm and may be inspected to avoid | |
9736 | clobbering a register that is an input or output of the asm. You can use | |
91b4415a | 9737 | @code{tree_overlaps_hard_reg_set}, declared in @file{tree.h}, to test |
61158923 | 9738 | for overlap with regards to asm-declared registers. |
67dfe110 | 9739 | @end deftypefn |
57bcb97a | 9740 | |
a2c4f8e0 | 9741 | @defmac MATH_LIBRARY |
71d718e0 JM |
9742 | Define this macro as a C string constant for the linker argument to link |
9743 | in the system math library, or @samp{""} if the target does not have a | |
9744 | separate math library. | |
9745 | ||
9746 | You need only define this macro if the default of @samp{"-lm"} is wrong. | |
a2c4f8e0 | 9747 | @end defmac |
512b62fb | 9748 | |
a2c4f8e0 | 9749 | @defmac LIBRARY_PATH_ENV |
512b62fb JM |
9750 | Define this macro as a C string constant for the environment variable that |
9751 | specifies where the linker should look for libraries. | |
9752 | ||
9753 | You need only define this macro if the default of @samp{"LIBRARY_PATH"} | |
9754 | is wrong. | |
a2c4f8e0 | 9755 | @end defmac |
e09d24ff | 9756 | |
4969c0d8 L |
9757 | @defmac TARGET_POSIX_IO |
9758 | Define this macro if the target supports the following POSIX@ file | |
9759 | functions, access, mkdir and file locking with fcntl / F_SETLKW@. | |
9760 | Defining @code{TARGET_POSIX_IO} will enable the test coverage code | |
e09d24ff | 9761 | to use file locking when exiting a program, which avoids race conditions |
4969c0d8 | 9762 | if the program has forked. It will also create directories at run-time |
709a840a | 9763 | for cross-profiling. |
a2c4f8e0 | 9764 | @end defmac |
0c99ec5c | 9765 | |
a2c4f8e0 | 9766 | @defmac MAX_CONDITIONAL_EXECUTE |
0c99ec5c RH |
9767 | |
9768 | A C expression for the maximum number of instructions to execute via | |
9769 | conditional execution instructions instead of a branch. A value of | |
9770 | @code{BRANCH_COST}+1 is the default if the machine does not use cc0, and | |
9771 | 1 if it does use cc0. | |
a2c4f8e0 | 9772 | @end defmac |
90280148 | 9773 | |
a2c4f8e0 | 9774 | @defmac IFCVT_MODIFY_TESTS (@var{ce_info}, @var{true_expr}, @var{false_expr}) |
c05ffc49 BS |
9775 | Used if the target needs to perform machine-dependent modifications on the |
9776 | conditionals used for turning basic blocks into conditionally executed code. | |
9777 | @var{ce_info} points to a data structure, @code{struct ce_if_block}, which | |
9778 | contains information about the currently processed blocks. @var{true_expr} | |
9779 | and @var{false_expr} are the tests that are used for converting the | |
9780 | then-block and the else-block, respectively. Set either @var{true_expr} or | |
9781 | @var{false_expr} to a null pointer if the tests cannot be converted. | |
a2c4f8e0 | 9782 | @end defmac |
c05ffc49 | 9783 | |
a2c4f8e0 | 9784 | @defmac IFCVT_MODIFY_MULTIPLE_TESTS (@var{ce_info}, @var{bb}, @var{true_expr}, @var{false_expr}) |
c05ffc49 BS |
9785 | Like @code{IFCVT_MODIFY_TESTS}, but used when converting more complicated |
9786 | if-statements into conditions combined by @code{and} and @code{or} operations. | |
9787 | @var{bb} contains the basic block that contains the test that is currently | |
9788 | being processed and about to be turned into a condition. | |
a2c4f8e0 | 9789 | @end defmac |
90280148 | 9790 | |
a2c4f8e0 | 9791 | @defmac IFCVT_MODIFY_INSN (@var{ce_info}, @var{pattern}, @var{insn}) |
c05ffc49 BS |
9792 | A C expression to modify the @var{PATTERN} of an @var{INSN} that is to |
9793 | be converted to conditional execution format. @var{ce_info} points to | |
9794 | a data structure, @code{struct ce_if_block}, which contains information | |
9795 | about the currently processed blocks. | |
a2c4f8e0 | 9796 | @end defmac |
90280148 | 9797 | |
a2c4f8e0 | 9798 | @defmac IFCVT_MODIFY_FINAL (@var{ce_info}) |
90280148 | 9799 | A C expression to perform any final machine dependent modifications in |
c05ffc49 BS |
9800 | converting code to conditional execution. The involved basic blocks |
9801 | can be found in the @code{struct ce_if_block} structure that is pointed | |
9802 | to by @var{ce_info}. | |
a2c4f8e0 | 9803 | @end defmac |
90280148 | 9804 | |
a2c4f8e0 | 9805 | @defmac IFCVT_MODIFY_CANCEL (@var{ce_info}) |
90280148 | 9806 | A C expression to cancel any machine dependent modifications in |
c05ffc49 BS |
9807 | converting code to conditional execution. The involved basic blocks |
9808 | can be found in the @code{struct ce_if_block} structure that is pointed | |
9809 | to by @var{ce_info}. | |
a2c4f8e0 | 9810 | @end defmac |
c05ffc49 | 9811 | |
a2c4f8e0 | 9812 | @defmac IFCVT_INIT_EXTRA_FIELDS (@var{ce_info}) |
c05ffc49 BS |
9813 | A C expression to initialize any extra fields in a @code{struct ce_if_block} |
9814 | structure, which are defined by the @code{IFCVT_EXTRA_FIELDS} macro. | |
a2c4f8e0 | 9815 | @end defmac |
c05ffc49 | 9816 | |
a2c4f8e0 | 9817 | @defmac IFCVT_EXTRA_FIELDS |
c05ffc49 | 9818 | If defined, it should expand to a set of field declarations that will be |
c0478a66 | 9819 | added to the @code{struct ce_if_block} structure. These should be initialized |
c05ffc49 | 9820 | by the @code{IFCVT_INIT_EXTRA_FIELDS} macro. |
a2c4f8e0 | 9821 | @end defmac |
c05ffc49 | 9822 | |
18dbd950 RS |
9823 | @deftypefn {Target Hook} void TARGET_MACHINE_DEPENDENT_REORG () |
9824 | If non-null, this hook performs a target-specific pass over the | |
9825 | instruction stream. The compiler will run it at all optimization levels, | |
9826 | just before the point at which it normally does delayed-branch scheduling. | |
9827 | ||
9828 | The exact purpose of the hook varies from target to target. Some use | |
9829 | it to do transformations that are necessary for correctness, such as | |
9830 | laying out in-function constant pools or avoiding hardware hazards. | |
9831 | Others use it as an opportunity to do some machine-dependent optimizations. | |
9832 | ||
9833 | You need not implement the hook if it has nothing to do. The default | |
9834 | definition is null. | |
9835 | @end deftypefn | |
9836 | ||
f6155fda SS |
9837 | @deftypefn {Target Hook} void TARGET_INIT_BUILTINS () |
9838 | Define this hook if you have any machine-specific built-in functions | |
9839 | that need to be defined. It should be a function that performs the | |
4a1d48f6 BS |
9840 | necessary setup. |
9841 | ||
c771326b | 9842 | Machine specific built-in functions can be useful to expand special machine |
4a1d48f6 BS |
9843 | instructions that would otherwise not normally be generated because |
9844 | they have no equivalent in the source language (for example, SIMD vector | |
9845 | instructions or prefetch instructions). | |
9846 | ||
6e34d3a3 JM |
9847 | To create a built-in function, call the function |
9848 | @code{lang_hooks.builtin_function} | |
c771326b | 9849 | which is defined by the language front end. You can use any type nodes set |
4a1d48f6 | 9850 | up by @code{build_common_tree_nodes} and @code{build_common_tree_nodes_2}; |
c237e94a | 9851 | only language front ends that use those two functions will call |
f6155fda | 9852 | @samp{TARGET_INIT_BUILTINS}. |
acdcefcc | 9853 | @end deftypefn |
4a1d48f6 | 9854 | |
f6155fda | 9855 | @deftypefn {Target Hook} rtx TARGET_EXPAND_BUILTIN (tree @var{exp}, rtx @var{target}, rtx @var{subtarget}, enum machine_mode @var{mode}, int @var{ignore}) |
4a1d48f6 | 9856 | |
c771326b | 9857 | Expand a call to a machine specific built-in function that was set up by |
f6155fda SS |
9858 | @samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the |
9859 | function call; the result should go to @var{target} if that is | |
9860 | convenient, and have mode @var{mode} if that is convenient. | |
9861 | @var{subtarget} may be used as the target for computing one of | |
9862 | @var{exp}'s operands. @var{ignore} is nonzero if the value is to be | |
9863 | ignored. This function should return the result of the call to the | |
9864 | built-in function. | |
acdcefcc | 9865 | @end deftypefn |
4a1d48f6 | 9866 | |
4268e4cf PB |
9867 | @deftypefn {Target Hook} tree TARGET_RESOLVE_OVERLOADED_BUILTIN (tree @var{fndecl}, tree @var{arglist}) |
9868 | ||
9869 | Select a replacement for a machine specific built-in function that | |
9870 | was set up by @samp{TARGET_INIT_BUILTINS}. This is done | |
9871 | @emph{before} regular type checking, and so allows the target to | |
9872 | implement a crude form of function overloading. @var{fndecl} is the | |
9873 | declaration of the built-in function. @var{arglist} is the list of | |
9874 | arguments passed to the built-in function. The result is a | |
9875 | complete expression that implements the operation, usually | |
9876 | another @code{CALL_EXPR}. | |
9877 | @end deftypefn | |
9878 | ||
a05a80fc KH |
9879 | @deftypefn {Target Hook} tree TARGET_FOLD_BUILTIN (tree @var{fndecl}, tree @var{arglist}, bool @var{ignore}) |
9880 | ||
9881 | Fold a call to a machine specific built-in function that was set up by | |
9882 | @samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the | |
9883 | built-in function. @var{arglist} is the list of arguments passed to | |
9884 | the built-in function. The result is another tree containing a | |
9885 | simplified expression for the call's result. If @var{ignore} is true | |
9886 | the value will be ignored. | |
d6c2b67d PB |
9887 | @end deftypefn |
9888 | ||
e7e64a25 | 9889 | @deftypefn {Target Hook} const char * TARGET_INVALID_WITHIN_DOLOOP (rtx @var{insn}) |
a71a498d | 9890 | |
e7e64a25 AS |
9891 | Take an instruction in @var{insn} and return NULL if it is valid within a |
9892 | low-overhead loop, otherwise return a string why doloop could not be applied. | |
a71a498d | 9893 | |
e7e64a25 AS |
9894 | Many targets use special registers for low-overhead looping. For any |
9895 | instruction that clobbers these this function should return a string indicating | |
083cad55 | 9896 | the reason why the doloop could not be applied. |
a71a498d | 9897 | By default, the RTL loop optimizer does not use a present doloop pattern for |
083cad55 | 9898 | loops containing function calls or branch on table instructions. |
a71a498d AS |
9899 | @end deftypefn |
9900 | ||
a2c4f8e0 | 9901 | @defmac MD_CAN_REDIRECT_BRANCH (@var{branch1}, @var{branch2}) |
6e7b03e1 | 9902 | |
4fe9b91c | 9903 | Take a branch insn in @var{branch1} and another in @var{branch2}. |
6e7b03e1 AH |
9904 | Return true if redirecting @var{branch1} to the destination of |
9905 | @var{branch2} is possible. | |
9906 | ||
9907 | On some targets, branches may have a limited range. Optimizing the | |
9908 | filling of delay slots can result in branches being redirected, and this | |
9909 | may in turn cause a branch offset to overflow. | |
a2c4f8e0 | 9910 | @end defmac |
6e7b03e1 | 9911 | |
8ddf681a R |
9912 | @deftypefn {Target Hook} bool TARGET_COMMUTATIVE_P (rtx @var{x}, @var{outer_code}) |
9913 | This target hook returns @code{true} if @var{x} is considered to be commutative. | |
9914 | Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider | |
9915 | PLUS to be commutative inside a MEM. @var{outer_code} is the rtx code | |
9916 | of the enclosing rtl, if known, otherwise it is UNKNOWN. | |
9917 | @end deftypefn | |
9918 | ||
b48f503c | 9919 | @deftypefn {Target Hook} rtx TARGET_ALLOCATE_INITIAL_VALUE (rtx @var{hard_reg}) |
385b6e2d R |
9920 | |
9921 | When the initial value of a hard register has been copied in a pseudo | |
4fe9b91c | 9922 | register, it is often not necessary to actually allocate another register |
385b6e2d | 9923 | to this pseudo register, because the original hard register or a stack slot |
b48f503c KK |
9924 | it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE} |
9925 | is called at the start of register allocation once for each hard register | |
9926 | that had its initial value copied by using | |
385b6e2d R |
9927 | @code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}. |
9928 | Possible values are @code{NULL_RTX}, if you don't want | |
9929 | to do any special allocation, a @code{REG} rtx---that would typically be | |
9930 | the hard register itself, if it is known not to be clobbered---or a | |
9931 | @code{MEM}. | |
9932 | If you are returning a @code{MEM}, this is only a hint for the allocator; | |
9933 | it might decide to use another register anyways. | |
b48f503c KK |
9934 | You may use @code{current_function_leaf_function} in the hook, functions |
9935 | that use @code{REG_N_SETS}, to determine if the hard | |
385b6e2d | 9936 | register in question will not be clobbered. |
b48f503c KK |
9937 | The default value of this hook is @code{NULL}, which disables any special |
9938 | allocation. | |
9939 | @end deftypefn | |
385b6e2d | 9940 | |
a2c4f8e0 | 9941 | @defmac TARGET_OBJECT_SUFFIX |
807633e5 ZW |
9942 | Define this macro to be a C string representing the suffix for object |
9943 | files on your target machine. If you do not define this macro, GCC will | |
9944 | use @samp{.o} as the suffix for object files. | |
a2c4f8e0 | 9945 | @end defmac |
807633e5 | 9946 | |
a2c4f8e0 | 9947 | @defmac TARGET_EXECUTABLE_SUFFIX |
807633e5 ZW |
9948 | Define this macro to be a C string representing the suffix to be |
9949 | automatically added to executable files on your target machine. If you | |
9950 | do not define this macro, GCC will use the null string as the suffix for | |
9951 | executable files. | |
a2c4f8e0 | 9952 | @end defmac |
807633e5 | 9953 | |
a2c4f8e0 | 9954 | @defmac COLLECT_EXPORT_LIST |
807633e5 ZW |
9955 | If defined, @code{collect2} will scan the individual object files |
9956 | specified on its command line and create an export list for the linker. | |
9957 | Define this macro for systems like AIX, where the linker discards | |
9958 | object files that are not referenced from @code{main} and uses export | |
9959 | lists. | |
a2c4f8e0 | 9960 | @end defmac |
807633e5 | 9961 | |
a2c4f8e0 | 9962 | @defmac MODIFY_JNI_METHOD_CALL (@var{mdecl}) |
55ae46b1 RM |
9963 | Define this macro to a C expression representing a variant of the |
9964 | method call @var{mdecl}, if Java Native Interface (JNI) methods | |
9965 | must be invoked differently from other methods on your target. | |
95fef11f | 9966 | For example, on 32-bit Microsoft Windows, JNI methods must be invoked using |
55ae46b1 RM |
9967 | the @code{stdcall} calling convention and this macro is then |
9968 | defined as this expression: | |
9969 | ||
9970 | @smallexample | |
9971 | build_type_attribute_variant (@var{mdecl}, | |
9972 | build_tree_list | |
9973 | (get_identifier ("stdcall"), | |
9974 | NULL)) | |
9975 | @end smallexample | |
a2c4f8e0 | 9976 | @end defmac |
e4ec2cac AO |
9977 | |
9978 | @deftypefn {Target Hook} bool TARGET_CANNOT_MODIFY_JUMPS_P (void) | |
9979 | This target hook returns @code{true} past the point in which new jump | |
9980 | instructions could be created. On machines that require a register for | |
9981 | every jump such as the SHmedia ISA of SH5, this point would typically be | |
9982 | reload, so this target hook should be defined to a function such as: | |
9983 | ||
9984 | @smallexample | |
9985 | static bool | |
9986 | cannot_modify_jumps_past_reload_p () | |
9987 | @{ | |
9988 | return (reload_completed || reload_in_progress); | |
9989 | @} | |
9990 | @end smallexample | |
9991 | @end deftypefn | |
fe3ad572 | 9992 | |
a3424f5c | 9993 | @deftypefn {Target Hook} int TARGET_BRANCH_TARGET_REGISTER_CLASS (void) |
fe3ad572 SC |
9994 | This target hook returns a register class for which branch target register |
9995 | optimizations should be applied. All registers in this class should be | |
c0cbdbd9 | 9996 | usable interchangeably. After reload, registers in this class will be |
fe3ad572 SC |
9997 | re-allocated and loads will be hoisted out of loops and be subjected |
9998 | to inter-block scheduling. | |
9999 | @end deftypefn | |
10000 | ||
10001 | @deftypefn {Target Hook} bool TARGET_BRANCH_TARGET_REGISTER_CALLEE_SAVED (bool @var{after_prologue_epilogue_gen}) | |
10002 | Branch target register optimization will by default exclude callee-saved | |
10003 | registers | |
10004 | that are not already live during the current function; if this target hook | |
10005 | returns true, they will be included. The target code must than make sure | |
10006 | that all target registers in the class returned by | |
10007 | @samp{TARGET_BRANCH_TARGET_REGISTER_CLASS} that might need saving are | |
10008 | saved. @var{after_prologue_epilogue_gen} indicates if prologues and | |
10009 | epilogues have already been generated. Note, even if you only return | |
10010 | true when @var{after_prologue_epilogue_gen} is false, you still are likely | |
10011 | to have to make special provisions in @code{INITIAL_ELIMINATION_OFFSET} | |
10012 | to reserve space for caller-saved target registers. | |
10013 | @end deftypefn | |
2082e02f RS |
10014 | |
10015 | @defmac POWI_MAX_MULTS | |
73774972 | 10016 | If defined, this macro is interpreted as a signed integer C expression |
2082e02f RS |
10017 | that specifies the maximum number of floating point multiplications |
10018 | that should be emitted when expanding exponentiation by an integer | |
10019 | constant inline. When this value is defined, exponentiation requiring | |
10020 | more than this number of multiplications is implemented by calling the | |
10021 | system library's @code{pow}, @code{powf} or @code{powl} routines. | |
10022 | The default value places no upper bound on the multiplication count. | |
10023 | @end defmac | |
94d1613b | 10024 | |
3dd53121 | 10025 | @deftypefn Macro void TARGET_EXTRA_INCLUDES (const char *@var{sysroot}, const char *@var{iprefix}, int @var{stdinc}) |
94d1613b MS |
10026 | This target hook should register any extra include files for the |
10027 | target. The parameter @var{stdinc} indicates if normal include files | |
3dd53121 AP |
10028 | are present. The parameter @var{sysroot} is the system root directory. |
10029 | The parameter @var{iprefix} is the prefix for the gcc directory. | |
10030 | @end deftypefn | |
10031 | ||
10032 | @deftypefn Macro void TARGET_EXTRA_PRE_INCLUDES (const char *@var{sysroot}, const char *@var{iprefix}, int @var{stdinc}) | |
10033 | This target hook should register any extra include files for the | |
10034 | target before any standard headers. The parameter @var{stdinc} | |
10035 | indicates if normal include files are present. The parameter | |
10036 | @var{sysroot} is the system root directory. The parameter | |
10037 | @var{iprefix} is the prefix for the gcc directory. | |
94d1613b MS |
10038 | @end deftypefn |
10039 | ||
10040 | @deftypefn Macro void TARGET_OPTF (char *@var{path}) | |
10041 | This target hook should register special include paths for the target. | |
10042 | The parameter @var{path} is the include to register. On Darwin | |
10043 | systems, this is used for Framework includes, which have semantics | |
10044 | that are different from @option{-I}. | |
10045 | @end deftypefn | |
4a77e08c DS |
10046 | |
10047 | @deftypefn {Target Hook} bool TARGET_USE_LOCAL_THUNK_ALIAS_P (tree @var{fndecl}) | |
10048 | This target hook returns @code{true} if it is safe to use a local alias | |
10049 | for a virtual function @var{fndecl} when constructing thunks, | |
8a36672b | 10050 | @code{false} otherwise. By default, the hook returns @code{true} for all |
431ae0bf | 10051 | functions, if a target supports aliases (i.e.@: defines |
4a77e08c DS |
10052 | @code{ASM_OUTPUT_DEF}), @code{false} otherwise, |
10053 | @end deftypefn | |
a2bec818 DJ |
10054 | |
10055 | @defmac TARGET_FORMAT_TYPES | |
10056 | If defined, this macro is the name of a global variable containing | |
10057 | target-specific format checking information for the @option{-Wformat} | |
10058 | option. The default is to have no target-specific format checks. | |
10059 | @end defmac | |
10060 | ||
10061 | @defmac TARGET_N_FORMAT_TYPES | |
10062 | If defined, this macro is the number of entries in | |
10063 | @code{TARGET_FORMAT_TYPES}. | |
10064 | @end defmac | |
e50e6b88 | 10065 | |
445cf5eb JM |
10066 | @deftypefn {Target Hook} bool TARGET_RELAXED_ORDERING |
10067 | If set to @code{true}, means that the target's memory model does not | |
10068 | guarantee that loads which do not depend on one another will access | |
10069 | main memory in the order of the instruction stream; if ordering is | |
10070 | important, an explicit memory barrier must be used. This is true of | |
10071 | many recent processors which implement a policy of ``relaxed,'' | |
10072 | ``weak,'' or ``release'' memory consistency, such as Alpha, PowerPC, | |
10073 | and ia64. The default is @code{false}. | |
10074 | @end deftypefn | |
10075 | ||
4d3e6fae | 10076 | @deftypefn {Target Hook} const char *TARGET_INVALID_ARG_FOR_UNPROTOTYPED_FN (tree @var{typelist}, tree @var{funcdecl}, tree @var{val}) |
083cad55 EC |
10077 | If defined, this macro returns the diagnostic message when it is |
10078 | illegal to pass argument @var{val} to function @var{funcdecl} | |
4d3e6fae FJ |
10079 | with prototype @var{typelist}. |
10080 | @end deftypefn | |
10081 | ||
4de67c26 JM |
10082 | @deftypefn {Target Hook} {const char *} TARGET_INVALID_CONVERSION (tree @var{fromtype}, tree @var{totype}) |
10083 | If defined, this macro returns the diagnostic message when it is | |
10084 | invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL} | |
10085 | if validity should be determined by the front end. | |
10086 | @end deftypefn | |
10087 | ||
10088 | @deftypefn {Target Hook} {const char *} TARGET_INVALID_UNARY_OP (int @var{op}, tree @var{type}) | |
10089 | If defined, this macro returns the diagnostic message when it is | |
10090 | invalid to apply operation @var{op} (where unary plus is denoted by | |
10091 | @code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL} | |
10092 | if validity should be determined by the front end. | |
10093 | @end deftypefn | |
10094 | ||
10095 | @deftypefn {Target Hook} {const char *} TARGET_INVALID_BINARY_OP (int @var{op}, tree @var{type1}, tree @var{type2}) | |
10096 | If defined, this macro returns the diagnostic message when it is | |
10097 | invalid to apply operation @var{op} to operands of types @var{type1} | |
10098 | and @var{type2}, or @code{NULL} if validity should be determined by | |
10099 | the front end. | |
10100 | @end deftypefn | |
10101 | ||
e50e6b88 DS |
10102 | @defmac TARGET_USE_JCR_SECTION |
10103 | This macro determines whether to use the JCR section to register Java | |
10104 | classes. By default, TARGET_USE_JCR_SECTION is defined to 1 if both | |
10105 | SUPPORTS_WEAK and TARGET_HAVE_NAMED_SECTIONS are true, else 0. | |
10106 | @end defmac | |
64ee9490 EC |
10107 | |
10108 | @defmac OBJC_JBLEN | |
10109 | This macro determines the size of the objective C jump buffer for the | |
10110 | NeXT runtime. By default, OBJC_JBLEN is defined to an innocuous value. | |
10111 | @end defmac |