]>
Commit | Line | Data |
---|---|---|
99dee823 | 1 | @c Copyright (C) 1988-2021 Free Software Foundation, Inc. |
38f8b050 JR |
2 | @c This is part of the GCC manual. |
3 | @c For copying conditions, see the file gcc.texi. | |
4 | ||
5 | @node Target Macros | |
6 | @chapter Target Description Macros and Functions | |
7 | @cindex machine description macros | |
8 | @cindex target description macros | |
9 | @cindex macros, target description | |
10 | @cindex @file{tm.h} macros | |
11 | ||
12 | In addition to the file @file{@var{machine}.md}, a machine description | |
13 | includes a C header file conventionally given the name | |
14 | @file{@var{machine}.h} and a C source file named @file{@var{machine}.c}. | |
15 | The header file defines numerous macros that convey the information | |
16 | about the target machine that does not fit into the scheme of the | |
17 | @file{.md} file. The file @file{tm.h} should be a link to | |
18 | @file{@var{machine}.h}. The header file @file{config.h} includes | |
19 | @file{tm.h} and most compiler source files include @file{config.h}. The | |
20 | source file defines a variable @code{targetm}, which is a structure | |
21 | containing pointers to functions and data relating to the target | |
22 | machine. @file{@var{machine}.c} should also contain their definitions, | |
23 | if they are not defined elsewhere in GCC, and other functions called | |
24 | through the macros defined in the @file{.h} file. | |
25 | ||
26 | @menu | |
27 | * Target Structure:: The @code{targetm} variable. | |
28 | * Driver:: Controlling how the driver runs the compilation passes. | |
29 | * Run-time Target:: Defining @samp{-m} options like @option{-m68000} and @option{-m68020}. | |
30 | * Per-Function Data:: Defining data structures for per-function information. | |
31 | * Storage Layout:: Defining sizes and alignments of data. | |
32 | * Type Layout:: Defining sizes and properties of basic user data types. | |
33 | * Registers:: Naming and describing the hardware registers. | |
34 | * Register Classes:: Defining the classes of hardware registers. | |
38f8b050 JR |
35 | * Stack and Calling:: Defining which way the stack grows and by how much. |
36 | * Varargs:: Defining the varargs macros. | |
37 | * Trampolines:: Code set up at run time to enter a nested function. | |
38 | * Library Calls:: Controlling how library routines are implicitly called. | |
39 | * Addressing Modes:: Defining addressing modes valid for memory operands. | |
40 | * Anchored Addresses:: Defining how @option{-fsection-anchors} should work. | |
41 | * Condition Code:: Defining how insns update the condition code. | |
42 | * Costs:: Defining relative costs of different operations. | |
43 | * Scheduling:: Adjusting the behavior of the instruction scheduler. | |
44 | * Sections:: Dividing storage into text, data, and other sections. | |
45 | * PIC:: Macros for position independent code. | |
46 | * Assembler Format:: Defining how to write insns and pseudo-ops to output. | |
47 | * Debugging Info:: Defining the format of debugging output. | |
48 | * Floating Point:: Handling floating point for cross-compilers. | |
49 | * Mode Switching:: Insertion of mode-switching instructions. | |
50 | * Target Attributes:: Defining target-specific uses of @code{__attribute__}. | |
51 | * Emulated TLS:: Emulated TLS support. | |
52 | * MIPS Coprocessors:: MIPS coprocessor support and how to customize it. | |
53 | * PCH Target:: Validity checking for precompiled headers. | |
54 | * C++ ABI:: Controlling C++ ABI changes. | |
b4c522fa | 55 | * D Language and ABI:: Controlling D ABI changes. |
38f8b050 JR |
56 | * Named Address Spaces:: Adding support for named address spaces |
57 | * Misc:: Everything else. | |
58 | @end menu | |
59 | ||
60 | @node Target Structure | |
61 | @section The Global @code{targetm} Variable | |
62 | @cindex target hooks | |
63 | @cindex target functions | |
64 | ||
65 | @deftypevar {struct gcc_target} targetm | |
66 | The target @file{.c} file must define the global @code{targetm} variable | |
67 | which contains pointers to functions and data relating to the target | |
68 | machine. The variable is declared in @file{target.h}; | |
69 | @file{target-def.h} defines the macro @code{TARGET_INITIALIZER} which is | |
70 | used to initialize the variable, and macros for the default initializers | |
71 | for elements of the structure. The @file{.c} file should override those | |
72 | macros for which the default definition is inappropriate. For example: | |
73 | @smallexample | |
74 | #include "target.h" | |
75 | #include "target-def.h" | |
76 | ||
77 | /* @r{Initialize the GCC target structure.} */ | |
78 | ||
79 | #undef TARGET_COMP_TYPE_ATTRIBUTES | |
80 | #define TARGET_COMP_TYPE_ATTRIBUTES @var{machine}_comp_type_attributes | |
81 | ||
82 | struct gcc_target targetm = TARGET_INITIALIZER; | |
83 | @end smallexample | |
84 | @end deftypevar | |
85 | ||
86 | Where a macro should be defined in the @file{.c} file in this manner to | |
87 | form part of the @code{targetm} structure, it is documented below as a | |
88 | ``Target Hook'' with a prototype. Many macros will change in future | |
89 | from being defined in the @file{.h} file to being part of the | |
90 | @code{targetm} structure. | |
91 | ||
acce4e77 JM |
92 | Similarly, there is a @code{targetcm} variable for hooks that are |
93 | specific to front ends for C-family languages, documented as ``C | |
94 | Target Hook''. This is declared in @file{c-family/c-target.h}, the | |
dd5a833e | 95 | initializer @code{TARGETCM_INITIALIZER} in |
acce4e77 JM |
96 | @file{c-family/c-target-def.h}. If targets initialize @code{targetcm} |
97 | themselves, they should set @code{target_has_targetcm=yes} in | |
98 | @file{config.gcc}; otherwise a default definition is used. | |
99 | ||
c49a6962 JM |
100 | Similarly, there is a @code{targetm_common} variable for hooks that |
101 | are shared between the compiler driver and the compilers proper, | |
102 | documented as ``Common Target Hook''. This is declared in | |
103 | @file{common/common-target.h}, the initializer | |
104 | @code{TARGETM_COMMON_INITIALIZER} in | |
105 | @file{common/common-target-def.h}. If targets initialize | |
106 | @code{targetm_common} themselves, they should set | |
107 | @code{target_has_targetm_common=yes} in @file{config.gcc}; otherwise a | |
108 | default definition is used. | |
109 | ||
b4c522fa IB |
110 | Similarly, there is a @code{targetdm} variable for hooks that are |
111 | specific to the D language front end, documented as ``D Target Hook''. | |
112 | This is declared in @file{d/d-target.h}, the initializer | |
113 | @code{TARGETDM_INITIALIZER} in @file{d/d-target-def.h}. If targets | |
114 | initialize @code{targetdm} themselves, they should set | |
115 | @code{target_has_targetdm=yes} in @file{config.gcc}; otherwise a default | |
116 | definition is used. | |
117 | ||
38f8b050 JR |
118 | @node Driver |
119 | @section Controlling the Compilation Driver, @file{gcc} | |
120 | @cindex driver | |
121 | @cindex controlling the compilation driver | |
122 | ||
123 | @c prevent bad page break with this line | |
124 | You can control the compilation driver. | |
125 | ||
38f8b050 JR |
126 | @defmac DRIVER_SELF_SPECS |
127 | A list of specs for the driver itself. It should be a suitable | |
128 | initializer for an array of strings, with no surrounding braces. | |
129 | ||
130 | The driver applies these specs to its own command line between loading | |
131 | default @file{specs} files (but not command-line specified ones) and | |
132 | choosing the multilib directory or running any subcommands. It | |
133 | applies them in the order given, so each spec can depend on the | |
134 | options added by earlier ones. It is also possible to remove options | |
135 | using @samp{%<@var{option}} in the usual way. | |
136 | ||
137 | This macro can be useful when a port has several interdependent target | |
138 | options. It provides a way of standardizing the command line so | |
139 | that the other specs are easier to write. | |
140 | ||
141 | Do not define this macro if it does not need to do anything. | |
142 | @end defmac | |
143 | ||
144 | @defmac OPTION_DEFAULT_SPECS | |
145 | A list of specs used to support configure-time default options (i.e.@: | |
146 | @option{--with} options) in the driver. It should be a suitable initializer | |
147 | for an array of structures, each containing two strings, without the | |
148 | outermost pair of surrounding braces. | |
149 | ||
150 | The first item in the pair is the name of the default. This must match | |
151 | the code in @file{config.gcc} for the target. The second item is a spec | |
152 | to apply if a default with this name was specified. The string | |
153 | @samp{%(VALUE)} in the spec will be replaced by the value of the default | |
154 | everywhere it occurs. | |
155 | ||
156 | The driver will apply these specs to its own command line between loading | |
157 | default @file{specs} files and processing @code{DRIVER_SELF_SPECS}, using | |
158 | the same mechanism as @code{DRIVER_SELF_SPECS}. | |
159 | ||
160 | Do not define this macro if it does not need to do anything. | |
161 | @end defmac | |
162 | ||
163 | @defmac CPP_SPEC | |
164 | A C string constant that tells the GCC driver program options to | |
165 | pass to CPP@. It can also specify how to translate options you | |
166 | give to GCC into options for GCC to pass to the CPP@. | |
167 | ||
168 | Do not define this macro if it does not need to do anything. | |
169 | @end defmac | |
170 | ||
171 | @defmac CPLUSPLUS_CPP_SPEC | |
172 | This macro is just like @code{CPP_SPEC}, but is used for C++, rather | |
173 | than C@. If you do not define this macro, then the value of | |
174 | @code{CPP_SPEC} (if any) will be used instead. | |
175 | @end defmac | |
176 | ||
177 | @defmac CC1_SPEC | |
178 | A C string constant that tells the GCC driver program options to | |
179 | pass to @code{cc1}, @code{cc1plus}, @code{f771}, and the other language | |
180 | front ends. | |
181 | It can also specify how to translate options you give to GCC into options | |
182 | for GCC to pass to front ends. | |
183 | ||
184 | Do not define this macro if it does not need to do anything. | |
185 | @end defmac | |
186 | ||
187 | @defmac CC1PLUS_SPEC | |
188 | A C string constant that tells the GCC driver program options to | |
189 | pass to @code{cc1plus}. It can also specify how to translate options you | |
190 | give to GCC into options for GCC to pass to the @code{cc1plus}. | |
191 | ||
192 | Do not define this macro if it does not need to do anything. | |
193 | Note that everything defined in CC1_SPEC is already passed to | |
194 | @code{cc1plus} so there is no need to duplicate the contents of | |
195 | CC1_SPEC in CC1PLUS_SPEC@. | |
196 | @end defmac | |
197 | ||
198 | @defmac ASM_SPEC | |
199 | A C string constant that tells the GCC driver program options to | |
200 | pass to the assembler. It can also specify how to translate options | |
201 | you give to GCC into options for GCC to pass to the assembler. | |
202 | See the file @file{sun3.h} for an example of this. | |
203 | ||
204 | Do not define this macro if it does not need to do anything. | |
205 | @end defmac | |
206 | ||
207 | @defmac ASM_FINAL_SPEC | |
208 | A C string constant that tells the GCC driver program how to | |
209 | run any programs which cleanup after the normal assembler. | |
210 | Normally, this is not needed. See the file @file{mips.h} for | |
211 | an example of this. | |
212 | ||
213 | Do not define this macro if it does not need to do anything. | |
214 | @end defmac | |
215 | ||
216 | @defmac AS_NEEDS_DASH_FOR_PIPED_INPUT | |
217 | Define this macro, with no value, if the driver should give the assembler | |
218 | an argument consisting of a single dash, @option{-}, to instruct it to | |
219 | read from its standard input (which will be a pipe connected to the | |
220 | output of the compiler proper). This argument is given after any | |
221 | @option{-o} option specifying the name of the output file. | |
222 | ||
223 | If you do not define this macro, the assembler is assumed to read its | |
224 | standard input if given no non-option arguments. If your assembler | |
225 | cannot read standard input at all, use a @samp{%@{pipe:%e@}} construct; | |
226 | see @file{mips.h} for instance. | |
227 | @end defmac | |
228 | ||
229 | @defmac LINK_SPEC | |
230 | A C string constant that tells the GCC driver program options to | |
231 | pass to the linker. It can also specify how to translate options you | |
232 | give to GCC into options for GCC to pass to the linker. | |
233 | ||
234 | Do not define this macro if it does not need to do anything. | |
235 | @end defmac | |
236 | ||
237 | @defmac LIB_SPEC | |
238 | Another C string constant used much like @code{LINK_SPEC}. The difference | |
239 | between the two is that @code{LIB_SPEC} is used at the end of the | |
240 | command given to the linker. | |
241 | ||
242 | If this macro is not defined, a default is provided that | |
243 | loads the standard C library from the usual place. See @file{gcc.c}. | |
244 | @end defmac | |
245 | ||
246 | @defmac LIBGCC_SPEC | |
247 | Another C string constant that tells the GCC driver program | |
248 | how and when to place a reference to @file{libgcc.a} into the | |
249 | linker command line. This constant is placed both before and after | |
250 | the value of @code{LIB_SPEC}. | |
251 | ||
252 | If this macro is not defined, the GCC driver provides a default that | |
253 | passes the string @option{-lgcc} to the linker. | |
254 | @end defmac | |
255 | ||
256 | @defmac REAL_LIBGCC_SPEC | |
257 | By default, if @code{ENABLE_SHARED_LIBGCC} is defined, the | |
258 | @code{LIBGCC_SPEC} is not directly used by the driver program but is | |
259 | instead modified to refer to different versions of @file{libgcc.a} | |
260 | depending on the values of the command line flags @option{-static}, | |
261 | @option{-shared}, @option{-static-libgcc}, and @option{-shared-libgcc}. On | |
262 | targets where these modifications are inappropriate, define | |
263 | @code{REAL_LIBGCC_SPEC} instead. @code{REAL_LIBGCC_SPEC} tells the | |
264 | driver how to place a reference to @file{libgcc} on the link command | |
265 | line, but, unlike @code{LIBGCC_SPEC}, it is used unmodified. | |
266 | @end defmac | |
267 | ||
268 | @defmac USE_LD_AS_NEEDED | |
269 | A macro that controls the modifications to @code{LIBGCC_SPEC} | |
270 | mentioned in @code{REAL_LIBGCC_SPEC}. If nonzero, a spec will be | |
e927b6ad RO |
271 | generated that uses @option{--as-needed} or equivalent options and the |
272 | shared @file{libgcc} in place of the | |
38f8b050 JR |
273 | static exception handler library, when linking without any of |
274 | @code{-static}, @code{-static-libgcc}, or @code{-shared-libgcc}. | |
275 | @end defmac | |
276 | ||
277 | @defmac LINK_EH_SPEC | |
278 | If defined, this C string constant is added to @code{LINK_SPEC}. | |
279 | When @code{USE_LD_AS_NEEDED} is zero or undefined, it also affects | |
280 | the modifications to @code{LIBGCC_SPEC} mentioned in | |
281 | @code{REAL_LIBGCC_SPEC}. | |
282 | @end defmac | |
283 | ||
284 | @defmac STARTFILE_SPEC | |
285 | Another C string constant used much like @code{LINK_SPEC}. The | |
286 | difference between the two is that @code{STARTFILE_SPEC} is used at | |
287 | the very beginning of the command given to the linker. | |
288 | ||
289 | If this macro is not defined, a default is provided that loads the | |
290 | standard C startup file from the usual place. See @file{gcc.c}. | |
291 | @end defmac | |
292 | ||
293 | @defmac ENDFILE_SPEC | |
294 | Another C string constant used much like @code{LINK_SPEC}. The | |
295 | difference between the two is that @code{ENDFILE_SPEC} is used at | |
296 | the very end of the command given to the linker. | |
297 | ||
298 | Do not define this macro if it does not need to do anything. | |
299 | @end defmac | |
300 | ||
301 | @defmac THREAD_MODEL_SPEC | |
302 | GCC @code{-v} will print the thread model GCC was configured to use. | |
303 | However, this doesn't work on platforms that are multilibbed on thread | |
304 | models, such as AIX 4.3. On such platforms, define | |
305 | @code{THREAD_MODEL_SPEC} such that it evaluates to a string without | |
306 | blanks that names one of the recognized thread models. @code{%*}, the | |
307 | default value of this macro, will expand to the value of | |
308 | @code{thread_file} set in @file{config.gcc}. | |
309 | @end defmac | |
310 | ||
311 | @defmac SYSROOT_SUFFIX_SPEC | |
312 | Define this macro to add a suffix to the target sysroot when GCC is | |
313 | configured with a sysroot. This will cause GCC to search for usr/lib, | |
314 | et al, within sysroot+suffix. | |
315 | @end defmac | |
316 | ||
317 | @defmac SYSROOT_HEADERS_SUFFIX_SPEC | |
318 | Define this macro to add a headers_suffix to the target sysroot when | |
319 | GCC is configured with a sysroot. This will cause GCC to pass the | |
320 | updated sysroot+headers_suffix to CPP, causing it to search for | |
321 | usr/include, et al, within sysroot+headers_suffix. | |
322 | @end defmac | |
323 | ||
324 | @defmac EXTRA_SPECS | |
325 | Define this macro to provide additional specifications to put in the | |
326 | @file{specs} file that can be used in various specifications like | |
327 | @code{CC1_SPEC}. | |
328 | ||
329 | The definition should be an initializer for an array of structures, | |
330 | containing a string constant, that defines the specification name, and a | |
331 | string constant that provides the specification. | |
332 | ||
333 | Do not define this macro if it does not need to do anything. | |
334 | ||
335 | @code{EXTRA_SPECS} is useful when an architecture contains several | |
336 | related targets, which have various @code{@dots{}_SPECS} which are similar | |
337 | to each other, and the maintainer would like one central place to keep | |
338 | these definitions. | |
339 | ||
340 | For example, the PowerPC System V.4 targets use @code{EXTRA_SPECS} to | |
341 | define either @code{_CALL_SYSV} when the System V calling sequence is | |
342 | used or @code{_CALL_AIX} when the older AIX-based calling sequence is | |
343 | used. | |
344 | ||
345 | The @file{config/rs6000/rs6000.h} target file defines: | |
346 | ||
347 | @smallexample | |
348 | #define EXTRA_SPECS \ | |
349 | @{ "cpp_sysv_default", CPP_SYSV_DEFAULT @}, | |
350 | ||
351 | #define CPP_SYS_DEFAULT "" | |
352 | @end smallexample | |
353 | ||
354 | The @file{config/rs6000/sysv.h} target file defines: | |
355 | @smallexample | |
356 | #undef CPP_SPEC | |
357 | #define CPP_SPEC \ | |
358 | "%@{posix: -D_POSIX_SOURCE @} \ | |
359 | %@{mcall-sysv: -D_CALL_SYSV @} \ | |
360 | %@{!mcall-sysv: %(cpp_sysv_default) @} \ | |
361 | %@{msoft-float: -D_SOFT_FLOAT@} %@{mcpu=403: -D_SOFT_FLOAT@}" | |
362 | ||
363 | #undef CPP_SYSV_DEFAULT | |
364 | #define CPP_SYSV_DEFAULT "-D_CALL_SYSV" | |
365 | @end smallexample | |
366 | ||
367 | while the @file{config/rs6000/eabiaix.h} target file defines | |
368 | @code{CPP_SYSV_DEFAULT} as: | |
369 | ||
370 | @smallexample | |
371 | #undef CPP_SYSV_DEFAULT | |
372 | #define CPP_SYSV_DEFAULT "-D_CALL_AIX" | |
373 | @end smallexample | |
374 | @end defmac | |
375 | ||
376 | @defmac LINK_LIBGCC_SPECIAL_1 | |
377 | Define this macro if the driver program should find the library | |
378 | @file{libgcc.a}. If you do not define this macro, the driver program will pass | |
379 | the argument @option{-lgcc} to tell the linker to do the search. | |
380 | @end defmac | |
381 | ||
382 | @defmac LINK_GCC_C_SEQUENCE_SPEC | |
383 | The sequence in which libgcc and libc are specified to the linker. | |
384 | By default this is @code{%G %L %G}. | |
385 | @end defmac | |
386 | ||
d9386123 AP |
387 | @defmac POST_LINK_SPEC |
388 | Define this macro to add additional steps to be executed after linker. | |
389 | The default value of this macro is empty string. | |
390 | @end defmac | |
391 | ||
38f8b050 JR |
392 | @defmac LINK_COMMAND_SPEC |
393 | A C string constant giving the complete command line need to execute the | |
394 | linker. When you do this, you will need to update your port each time a | |
395 | change is made to the link command line within @file{gcc.c}. Therefore, | |
396 | define this macro only if you need to completely redefine the command | |
397 | line for invoking the linker and there is no other way to accomplish | |
398 | the effect you need. Overriding this macro may be avoidable by overriding | |
399 | @code{LINK_GCC_C_SEQUENCE_SPEC} instead. | |
400 | @end defmac | |
401 | ||
c49a6962 JM |
402 | @hook TARGET_ALWAYS_STRIP_DOTDOT |
403 | ||
38f8b050 JR |
404 | @defmac MULTILIB_DEFAULTS |
405 | Define this macro as a C expression for the initializer of an array of | |
406 | string to tell the driver program which options are defaults for this | |
407 | target and thus do not need to be handled specially when using | |
408 | @code{MULTILIB_OPTIONS}. | |
409 | ||
410 | Do not define this macro if @code{MULTILIB_OPTIONS} is not defined in | |
411 | the target makefile fragment or if none of the options listed in | |
412 | @code{MULTILIB_OPTIONS} are set by default. | |
413 | @xref{Target Fragment}. | |
414 | @end defmac | |
415 | ||
416 | @defmac RELATIVE_PREFIX_NOT_LINKDIR | |
417 | Define this macro to tell @command{gcc} that it should only translate | |
418 | a @option{-B} prefix into a @option{-L} linker option if the prefix | |
419 | indicates an absolute file name. | |
420 | @end defmac | |
421 | ||
422 | @defmac MD_EXEC_PREFIX | |
423 | If defined, this macro is an additional prefix to try after | |
424 | @code{STANDARD_EXEC_PREFIX}. @code{MD_EXEC_PREFIX} is not searched | |
425 | when the compiler is built as a cross | |
426 | compiler. If you define @code{MD_EXEC_PREFIX}, then be sure to add it | |
6b1786aa | 427 | to the list of directories used to find the assembler in @file{configure.ac}. |
38f8b050 JR |
428 | @end defmac |
429 | ||
430 | @defmac STANDARD_STARTFILE_PREFIX | |
431 | Define this macro as a C string constant if you wish to override the | |
432 | standard choice of @code{libdir} as the default prefix to | |
433 | try when searching for startup files such as @file{crt0.o}. | |
434 | @code{STANDARD_STARTFILE_PREFIX} is not searched when the compiler | |
435 | is built as a cross compiler. | |
436 | @end defmac | |
437 | ||
438 | @defmac STANDARD_STARTFILE_PREFIX_1 | |
439 | Define this macro as a C string constant if you wish to override the | |
440 | standard choice of @code{/lib} as a prefix to try after the default prefix | |
441 | when searching for startup files such as @file{crt0.o}. | |
442 | @code{STANDARD_STARTFILE_PREFIX_1} is not searched when the compiler | |
443 | is built as a cross compiler. | |
444 | @end defmac | |
445 | ||
446 | @defmac STANDARD_STARTFILE_PREFIX_2 | |
447 | Define this macro as a C string constant if you wish to override the | |
448 | standard choice of @code{/lib} as yet another prefix to try after the | |
449 | default prefix when searching for startup files such as @file{crt0.o}. | |
450 | @code{STANDARD_STARTFILE_PREFIX_2} is not searched when the compiler | |
451 | is built as a cross compiler. | |
452 | @end defmac | |
453 | ||
454 | @defmac MD_STARTFILE_PREFIX | |
455 | If defined, this macro supplies an additional prefix to try after the | |
456 | standard prefixes. @code{MD_EXEC_PREFIX} is not searched when the | |
457 | compiler is built as a cross compiler. | |
458 | @end defmac | |
459 | ||
460 | @defmac MD_STARTFILE_PREFIX_1 | |
461 | If defined, this macro supplies yet another prefix to try after the | |
462 | standard prefixes. It is not searched when the compiler is built as a | |
463 | cross compiler. | |
464 | @end defmac | |
465 | ||
466 | @defmac INIT_ENVIRONMENT | |
467 | Define this macro as a C string constant if you wish to set environment | |
468 | variables for programs called by the driver, such as the assembler and | |
469 | loader. The driver passes the value of this macro to @code{putenv} to | |
470 | initialize the necessary environment variables. | |
471 | @end defmac | |
472 | ||
473 | @defmac LOCAL_INCLUDE_DIR | |
474 | Define this macro as a C string constant if you wish to override the | |
475 | standard choice of @file{/usr/local/include} as the default prefix to | |
476 | try when searching for local header files. @code{LOCAL_INCLUDE_DIR} | |
08b2bad2 SB |
477 | comes before @code{NATIVE_SYSTEM_HEADER_DIR} (set in |
478 | @file{config.gcc}, normally @file{/usr/include}) in the search order. | |
38f8b050 JR |
479 | |
480 | Cross compilers do not search either @file{/usr/local/include} or its | |
481 | replacement. | |
482 | @end defmac | |
483 | ||
08b2bad2 SB |
484 | @defmac NATIVE_SYSTEM_HEADER_COMPONENT |
485 | The ``component'' corresponding to @code{NATIVE_SYSTEM_HEADER_DIR}. | |
38f8b050 JR |
486 | See @code{INCLUDE_DEFAULTS}, below, for the description of components. |
487 | If you do not define this macro, no component is used. | |
488 | @end defmac | |
489 | ||
490 | @defmac INCLUDE_DEFAULTS | |
491 | Define this macro if you wish to override the entire default search path | |
492 | for include files. For a native compiler, the default search path | |
493 | usually consists of @code{GCC_INCLUDE_DIR}, @code{LOCAL_INCLUDE_DIR}, | |
08b2bad2 SB |
494 | @code{GPLUSPLUS_INCLUDE_DIR}, and |
495 | @code{NATIVE_SYSTEM_HEADER_DIR}. In addition, @code{GPLUSPLUS_INCLUDE_DIR} | |
38f8b050 JR |
496 | and @code{GCC_INCLUDE_DIR} are defined automatically by @file{Makefile}, |
497 | and specify private search areas for GCC@. The directory | |
498 | @code{GPLUSPLUS_INCLUDE_DIR} is used only for C++ programs. | |
499 | ||
500 | The definition should be an initializer for an array of structures. | |
501 | Each array element should have four elements: the directory name (a | |
502 | string constant), the component name (also a string constant), a flag | |
503 | for C++-only directories, | |
504 | and a flag showing that the includes in the directory don't need to be | |
505 | wrapped in @code{extern @samp{C}} when compiling C++. Mark the end of | |
506 | the array with a null element. | |
507 | ||
508 | The component name denotes what GNU package the include file is part of, | |
509 | if any, in all uppercase letters. For example, it might be @samp{GCC} | |
510 | or @samp{BINUTILS}. If the package is part of a vendor-supplied | |
511 | operating system, code the component name as @samp{0}. | |
512 | ||
513 | For example, here is the definition used for VAX/VMS: | |
514 | ||
515 | @smallexample | |
516 | #define INCLUDE_DEFAULTS \ | |
517 | @{ \ | |
518 | @{ "GNU_GXX_INCLUDE:", "G++", 1, 1@}, \ | |
519 | @{ "GNU_CC_INCLUDE:", "GCC", 0, 0@}, \ | |
520 | @{ "SYS$SYSROOT:[SYSLIB.]", 0, 0, 0@}, \ | |
521 | @{ ".", 0, 0, 0@}, \ | |
522 | @{ 0, 0, 0, 0@} \ | |
523 | @} | |
524 | @end smallexample | |
525 | @end defmac | |
526 | ||
527 | Here is the order of prefixes tried for exec files: | |
528 | ||
529 | @enumerate | |
530 | @item | |
531 | Any prefixes specified by the user with @option{-B}. | |
532 | ||
533 | @item | |
534 | The environment variable @code{GCC_EXEC_PREFIX} or, if @code{GCC_EXEC_PREFIX} | |
ff2ce160 | 535 | is not set and the compiler has not been installed in the configure-time |
38f8b050 JR |
536 | @var{prefix}, the location in which the compiler has actually been installed. |
537 | ||
538 | @item | |
539 | The directories specified by the environment variable @code{COMPILER_PATH}. | |
540 | ||
541 | @item | |
542 | The macro @code{STANDARD_EXEC_PREFIX}, if the compiler has been installed | |
ff2ce160 | 543 | in the configured-time @var{prefix}. |
38f8b050 JR |
544 | |
545 | @item | |
ff2ce160 | 546 | The location @file{/usr/libexec/gcc/}, but only if this is a native compiler. |
38f8b050 JR |
547 | |
548 | @item | |
ff2ce160 | 549 | The location @file{/usr/lib/gcc/}, but only if this is a native compiler. |
38f8b050 JR |
550 | |
551 | @item | |
ff2ce160 | 552 | The macro @code{MD_EXEC_PREFIX}, if defined, but only if this is a native |
38f8b050 JR |
553 | compiler. |
554 | @end enumerate | |
555 | ||
556 | Here is the order of prefixes tried for startfiles: | |
557 | ||
558 | @enumerate | |
559 | @item | |
560 | Any prefixes specified by the user with @option{-B}. | |
561 | ||
562 | @item | |
563 | The environment variable @code{GCC_EXEC_PREFIX} or its automatically determined | |
564 | value based on the installed toolchain location. | |
565 | ||
566 | @item | |
567 | The directories specified by the environment variable @code{LIBRARY_PATH} | |
568 | (or port-specific name; native only, cross compilers do not use this). | |
569 | ||
570 | @item | |
571 | The macro @code{STANDARD_EXEC_PREFIX}, but only if the toolchain is installed | |
ff2ce160 | 572 | in the configured @var{prefix} or this is a native compiler. |
38f8b050 JR |
573 | |
574 | @item | |
575 | The location @file{/usr/lib/gcc/}, but only if this is a native compiler. | |
576 | ||
577 | @item | |
ff2ce160 | 578 | The macro @code{MD_EXEC_PREFIX}, if defined, but only if this is a native |
38f8b050 JR |
579 | compiler. |
580 | ||
581 | @item | |
ff2ce160 | 582 | The macro @code{MD_STARTFILE_PREFIX}, if defined, but only if this is a |
38f8b050 JR |
583 | native compiler, or we have a target system root. |
584 | ||
585 | @item | |
ff2ce160 | 586 | The macro @code{MD_STARTFILE_PREFIX_1}, if defined, but only if this is a |
38f8b050 JR |
587 | native compiler, or we have a target system root. |
588 | ||
589 | @item | |
590 | The macro @code{STANDARD_STARTFILE_PREFIX}, with any sysroot modifications. | |
591 | If this path is relative it will be prefixed by @code{GCC_EXEC_PREFIX} and | |
592 | the machine suffix or @code{STANDARD_EXEC_PREFIX} and the machine suffix. | |
593 | ||
594 | @item | |
595 | The macro @code{STANDARD_STARTFILE_PREFIX_1}, but only if this is a native | |
596 | compiler, or we have a target system root. The default for this macro is | |
597 | @file{/lib/}. | |
598 | ||
599 | @item | |
600 | The macro @code{STANDARD_STARTFILE_PREFIX_2}, but only if this is a native | |
601 | compiler, or we have a target system root. The default for this macro is | |
602 | @file{/usr/lib/}. | |
603 | @end enumerate | |
604 | ||
605 | @node Run-time Target | |
606 | @section Run-time Target Specification | |
607 | @cindex run-time target specification | |
608 | @cindex predefined macros | |
609 | @cindex target specifications | |
610 | ||
611 | @c prevent bad page break with this line | |
612 | Here are run-time target specifications. | |
613 | ||
614 | @defmac TARGET_CPU_CPP_BUILTINS () | |
615 | This function-like macro expands to a block of code that defines | |
616 | built-in preprocessor macros and assertions for the target CPU, using | |
617 | the functions @code{builtin_define}, @code{builtin_define_std} and | |
618 | @code{builtin_assert}. When the front end | |
619 | calls this macro it provides a trailing semicolon, and since it has | |
620 | finished command line option processing your code can use those | |
621 | results freely. | |
622 | ||
623 | @code{builtin_assert} takes a string in the form you pass to the | |
624 | command-line option @option{-A}, such as @code{cpu=mips}, and creates | |
625 | the assertion. @code{builtin_define} takes a string in the form | |
626 | accepted by option @option{-D} and unconditionally defines the macro. | |
627 | ||
628 | @code{builtin_define_std} takes a string representing the name of an | |
629 | object-like macro. If it doesn't lie in the user's namespace, | |
630 | @code{builtin_define_std} defines it unconditionally. Otherwise, it | |
631 | defines a version with two leading underscores, and another version | |
632 | with two leading and trailing underscores, and defines the original | |
633 | only if an ISO standard was not requested on the command line. For | |
634 | example, passing @code{unix} defines @code{__unix}, @code{__unix__} | |
635 | and possibly @code{unix}; passing @code{_mips} defines @code{__mips}, | |
636 | @code{__mips__} and possibly @code{_mips}, and passing @code{_ABI64} | |
637 | defines only @code{_ABI64}. | |
638 | ||
639 | You can also test for the C dialect being compiled. The variable | |
640 | @code{c_language} is set to one of @code{clk_c}, @code{clk_cplusplus} | |
641 | or @code{clk_objective_c}. Note that if we are preprocessing | |
642 | assembler, this variable will be @code{clk_c} but the function-like | |
643 | macro @code{preprocessing_asm_p()} will return true, so you might want | |
644 | to check for that first. If you need to check for strict ANSI, the | |
645 | variable @code{flag_iso} can be used. The function-like macro | |
646 | @code{preprocessing_trad_p()} can be used to check for traditional | |
647 | preprocessing. | |
648 | @end defmac | |
649 | ||
650 | @defmac TARGET_OS_CPP_BUILTINS () | |
651 | Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional | |
652 | and is used for the target operating system instead. | |
653 | @end defmac | |
654 | ||
655 | @defmac TARGET_OBJFMT_CPP_BUILTINS () | |
656 | Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional | |
657 | and is used for the target object format. @file{elfos.h} uses this | |
658 | macro to define @code{__ELF__}, so you probably do not need to define | |
659 | it yourself. | |
660 | @end defmac | |
661 | ||
662 | @deftypevar {extern int} target_flags | |
663 | This variable is declared in @file{options.h}, which is included before | |
664 | any target-specific headers. | |
665 | @end deftypevar | |
666 | ||
667 | @hook TARGET_DEFAULT_TARGET_FLAGS | |
668 | This variable specifies the initial value of @code{target_flags}. | |
669 | Its default setting is 0. | |
670 | @end deftypevr | |
671 | ||
672 | @cindex optional hardware or system features | |
673 | @cindex features, optional, in system conventions | |
674 | ||
675 | @hook TARGET_HANDLE_OPTION | |
676 | This hook is called whenever the user specifies one of the | |
677 | target-specific options described by the @file{.opt} definition files | |
678 | (@pxref{Options}). It has the opportunity to do some option-specific | |
679 | processing and should return true if the option is valid. The default | |
680 | definition does nothing but return true. | |
681 | ||
96e45421 JM |
682 | @var{decoded} specifies the option and its arguments. @var{opts} and |
683 | @var{opts_set} are the @code{gcc_options} structures to be used for | |
684 | storing option state, and @var{loc} is the location at which the | |
685 | option was passed (@code{UNKNOWN_LOCATION} except for options passed | |
686 | via attributes). | |
38f8b050 JR |
687 | @end deftypefn |
688 | ||
689 | @hook TARGET_HANDLE_C_OPTION | |
690 | This target hook is called whenever the user specifies one of the | |
691 | target-specific C language family options described by the @file{.opt} | |
692 | definition files(@pxref{Options}). It has the opportunity to do some | |
693 | option-specific processing and should return true if the option is | |
694 | valid. The arguments are like for @code{TARGET_HANDLE_OPTION}. The | |
695 | default definition does nothing but return false. | |
696 | ||
697 | In general, you should use @code{TARGET_HANDLE_OPTION} to handle | |
698 | options. However, if processing an option requires routines that are | |
699 | only available in the C (and related language) front ends, then you | |
700 | should use @code{TARGET_HANDLE_C_OPTION} instead. | |
701 | @end deftypefn | |
702 | ||
91ebb981 IS |
703 | @hook TARGET_OBJC_CONSTRUCT_STRING_OBJECT |
704 | ||
70f42967 SB |
705 | @hook TARGET_OBJC_DECLARE_UNRESOLVED_CLASS_REFERENCE |
706 | ||
707 | @hook TARGET_OBJC_DECLARE_CLASS_DEFINITION | |
708 | ||
91ebb981 IS |
709 | @hook TARGET_STRING_OBJECT_REF_TYPE_P |
710 | ||
711 | @hook TARGET_CHECK_STRING_OBJECT_FORMAT_ARG | |
26705988 | 712 | |
38f8b050 | 713 | @hook TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE |
38f8b050 JR |
714 | |
715 | @defmac C_COMMON_OVERRIDE_OPTIONS | |
c5387660 JM |
716 | This is similar to the @code{TARGET_OPTION_OVERRIDE} hook |
717 | but is only used in the C | |
38f8b050 JR |
718 | language frontends (C, Objective-C, C++, Objective-C++) and so can be |
719 | used to alter option flag variables which only exist in those | |
720 | frontends. | |
721 | @end defmac | |
722 | ||
3020190e | 723 | @hook TARGET_OPTION_OPTIMIZATION_TABLE |
38f8b050 | 724 | Some machines may desire to change what optimizations are performed for |
3020190e JM |
725 | various optimization levels. This variable, if defined, describes |
726 | options to enable at particular sets of optimization levels. These | |
727 | options are processed once | |
38f8b050 | 728 | just after the optimization level is determined and before the remainder |
3020190e | 729 | of the command options have been parsed, so may be overridden by other |
2b0d3573 | 730 | options passed explicitly. |
38f8b050 | 731 | |
3020190e | 732 | This processing is run once at program startup and when the optimization |
38f8b050 JR |
733 | options are changed via @code{#pragma GCC optimize} or by using the |
734 | @code{optimize} attribute. | |
3020190e | 735 | @end deftypevr |
38f8b050 | 736 | |
7e4aae92 JM |
737 | @hook TARGET_OPTION_INIT_STRUCT |
738 | ||
3bd36029 RS |
739 | @defmac SWITCHABLE_TARGET |
740 | Some targets need to switch between substantially different subtargets | |
741 | during compilation. For example, the MIPS target has one subtarget for | |
742 | the traditional MIPS architecture and another for MIPS16. Source code | |
743 | can switch between these two subarchitectures using the @code{mips16} | |
744 | and @code{nomips16} attributes. | |
745 | ||
746 | Such subtargets can differ in things like the set of available | |
747 | registers, the set of available instructions, the costs of various | |
748 | operations, and so on. GCC caches a lot of this type of information | |
749 | in global variables, and recomputing them for each subtarget takes a | |
750 | significant amount of time. The compiler therefore provides a facility | |
751 | for maintaining several versions of the global variables and quickly | |
752 | switching between them; see @file{target-globals.h} for details. | |
753 | ||
754 | Define this macro to 1 if your target needs this facility. The default | |
755 | is 0. | |
756 | @end defmac | |
757 | ||
9193fb05 JM |
758 | @hook TARGET_FLOAT_EXCEPTIONS_ROUNDING_SUPPORTED_P |
759 | ||
38f8b050 JR |
760 | @node Per-Function Data |
761 | @section Defining data structures for per-function information. | |
762 | @cindex per-function data | |
763 | @cindex data structures | |
764 | ||
765 | If the target needs to store information on a per-function basis, GCC | |
766 | provides a macro and a couple of variables to allow this. Note, just | |
767 | using statics to store the information is a bad idea, since GCC supports | |
768 | nested functions, so you can be halfway through encoding one function | |
769 | when another one comes along. | |
770 | ||
771 | GCC defines a data structure called @code{struct function} which | |
772 | contains all of the data specific to an individual function. This | |
773 | structure contains a field called @code{machine} whose type is | |
774 | @code{struct machine_function *}, which can be used by targets to point | |
775 | to their own specific data. | |
776 | ||
777 | If a target needs per-function specific data it should define the type | |
778 | @code{struct machine_function} and also the macro @code{INIT_EXPANDERS}. | |
779 | This macro should be used to initialize the function pointer | |
780 | @code{init_machine_status}. This pointer is explained below. | |
781 | ||
782 | One typical use of per-function, target specific data is to create an | |
783 | RTX to hold the register containing the function's return address. This | |
784 | RTX can then be used to implement the @code{__builtin_return_address} | |
785 | function, for level 0. | |
786 | ||
787 | Note---earlier implementations of GCC used a single data area to hold | |
788 | all of the per-function information. Thus when processing of a nested | |
789 | function began the old per-function data had to be pushed onto a | |
790 | stack, and when the processing was finished, it had to be popped off the | |
791 | stack. GCC used to provide function pointers called | |
792 | @code{save_machine_status} and @code{restore_machine_status} to handle | |
793 | the saving and restoring of the target specific information. Since the | |
794 | single data area approach is no longer used, these pointers are no | |
795 | longer supported. | |
796 | ||
797 | @defmac INIT_EXPANDERS | |
798 | Macro called to initialize any target specific information. This macro | |
799 | is called once per function, before generation of any RTL has begun. | |
800 | The intention of this macro is to allow the initialization of the | |
801 | function pointer @code{init_machine_status}. | |
802 | @end defmac | |
803 | ||
804 | @deftypevar {void (*)(struct function *)} init_machine_status | |
805 | If this function pointer is non-@code{NULL} it will be called once per | |
806 | function, before function compilation starts, in order to allow the | |
807 | target to perform any target specific initialization of the | |
808 | @code{struct function} structure. It is intended that this would be | |
809 | used to initialize the @code{machine} of that structure. | |
810 | ||
811 | @code{struct machine_function} structures are expected to be freed by GC@. | |
812 | Generally, any memory that they reference must be allocated by using | |
813 | GC allocation, including the structure itself. | |
814 | @end deftypevar | |
815 | ||
816 | @node Storage Layout | |
817 | @section Storage Layout | |
818 | @cindex storage layout | |
819 | ||
820 | Note that the definitions of the macros in this table which are sizes or | |
821 | alignments measured in bits do not need to be constant. They can be C | |
822 | expressions that refer to static variables, such as the @code{target_flags}. | |
823 | @xref{Run-time Target}. | |
824 | ||
825 | @defmac BITS_BIG_ENDIAN | |
826 | Define this macro to have the value 1 if the most significant bit in a | |
827 | byte has the lowest number; otherwise define it to have the value zero. | |
828 | This means that bit-field instructions count from the most significant | |
829 | bit. If the machine has no bit-field instructions, then this must still | |
830 | be defined, but it doesn't matter which value it is defined to. This | |
831 | macro need not be a constant. | |
832 | ||
833 | This macro does not affect the way structure fields are packed into | |
834 | bytes or words; that is controlled by @code{BYTES_BIG_ENDIAN}. | |
835 | @end defmac | |
836 | ||
837 | @defmac BYTES_BIG_ENDIAN | |
838 | Define this macro to have the value 1 if the most significant byte in a | |
839 | word has the lowest number. This macro need not be a constant. | |
840 | @end defmac | |
841 | ||
842 | @defmac WORDS_BIG_ENDIAN | |
843 | Define this macro to have the value 1 if, in a multiword object, the | |
844 | most significant word has the lowest number. This applies to both | |
c0a6a1ef BS |
845 | memory locations and registers; see @code{REG_WORDS_BIG_ENDIAN} if the |
846 | order of words in memory is not the same as the order in registers. This | |
38f8b050 JR |
847 | macro need not be a constant. |
848 | @end defmac | |
849 | ||
c0a6a1ef BS |
850 | @defmac REG_WORDS_BIG_ENDIAN |
851 | On some machines, the order of words in a multiword object differs between | |
852 | registers in memory. In such a situation, define this macro to describe | |
853 | the order of words in a register. The macro @code{WORDS_BIG_ENDIAN} controls | |
854 | the order of words in memory. | |
855 | @end defmac | |
856 | ||
38f8b050 JR |
857 | @defmac FLOAT_WORDS_BIG_ENDIAN |
858 | Define this macro to have the value 1 if @code{DFmode}, @code{XFmode} or | |
859 | @code{TFmode} floating point numbers are stored in memory with the word | |
860 | containing the sign bit at the lowest address; otherwise define it to | |
861 | have the value 0. This macro need not be a constant. | |
862 | ||
863 | You need not define this macro if the ordering is the same as for | |
864 | multi-word integers. | |
865 | @end defmac | |
866 | ||
38f8b050 JR |
867 | @defmac BITS_PER_WORD |
868 | Number of bits in a word. If you do not define this macro, the default | |
869 | is @code{BITS_PER_UNIT * UNITS_PER_WORD}. | |
870 | @end defmac | |
871 | ||
872 | @defmac MAX_BITS_PER_WORD | |
873 | Maximum number of bits in a word. If this is undefined, the default is | |
874 | @code{BITS_PER_WORD}. Otherwise, it is the constant value that is the | |
875 | largest value that @code{BITS_PER_WORD} can have at run-time. | |
876 | @end defmac | |
877 | ||
878 | @defmac UNITS_PER_WORD | |
879 | Number of storage units in a word; normally the size of a general-purpose | |
880 | register, a power of two from 1 or 8. | |
881 | @end defmac | |
882 | ||
883 | @defmac MIN_UNITS_PER_WORD | |
884 | Minimum number of units in a word. If this is undefined, the default is | |
885 | @code{UNITS_PER_WORD}. Otherwise, it is the constant value that is the | |
886 | smallest value that @code{UNITS_PER_WORD} can have at run-time. | |
887 | @end defmac | |
888 | ||
38f8b050 JR |
889 | @defmac POINTER_SIZE |
890 | Width of a pointer, in bits. You must specify a value no wider than the | |
891 | width of @code{Pmode}. If it is not equal to the width of @code{Pmode}, | |
892 | you must define @code{POINTERS_EXTEND_UNSIGNED}. If you do not specify | |
893 | a value the default is @code{BITS_PER_WORD}. | |
894 | @end defmac | |
895 | ||
896 | @defmac POINTERS_EXTEND_UNSIGNED | |
897 | A C expression that determines how pointers should be extended from | |
898 | @code{ptr_mode} to either @code{Pmode} or @code{word_mode}. It is | |
899 | greater than zero if pointers should be zero-extended, zero if they | |
900 | should be sign-extended, and negative if some other sort of conversion | |
901 | is needed. In the last case, the extension is done by the target's | |
902 | @code{ptr_extend} instruction. | |
903 | ||
904 | You need not define this macro if the @code{ptr_mode}, @code{Pmode} | |
905 | and @code{word_mode} are all the same width. | |
906 | @end defmac | |
907 | ||
908 | @defmac PROMOTE_MODE (@var{m}, @var{unsignedp}, @var{type}) | |
909 | A macro to update @var{m} and @var{unsignedp} when an object whose type | |
910 | is @var{type} and which has the specified mode and signedness is to be | |
911 | stored in a register. This macro is only called when @var{type} is a | |
912 | scalar type. | |
913 | ||
914 | On most RISC machines, which only have operations that operate on a full | |
915 | register, define this macro to set @var{m} to @code{word_mode} if | |
916 | @var{m} is an integer mode narrower than @code{BITS_PER_WORD}. In most | |
917 | cases, only integer modes should be widened because wider-precision | |
918 | floating-point operations are usually more expensive than their narrower | |
919 | counterparts. | |
920 | ||
921 | For most machines, the macro definition does not change @var{unsignedp}. | |
922 | However, some machines, have instructions that preferentially handle | |
923 | either signed or unsigned quantities of certain modes. For example, on | |
924 | the DEC Alpha, 32-bit loads from memory and 32-bit add instructions | |
925 | sign-extend the result to 64 bits. On such machines, set | |
926 | @var{unsignedp} according to which kind of extension is more efficient. | |
927 | ||
928 | Do not define this macro if it would never modify @var{m}. | |
929 | @end defmac | |
930 | ||
42e02b20 | 931 | @hook TARGET_C_EXCESS_PRECISION |
f19a3270 | 932 | Return a value, with the same meaning as the C99 macro |
933 | @code{FLT_EVAL_METHOD} that describes which excess precision should be | |
934 | applied. | |
42e02b20 | 935 | |
38f8b050 | 936 | @hook TARGET_PROMOTE_FUNCTION_MODE |
38f8b050 JR |
937 | |
938 | @defmac PARM_BOUNDARY | |
939 | Normal alignment required for function parameters on the stack, in | |
940 | bits. All stack parameters receive at least this much alignment | |
941 | regardless of data type. On most machines, this is the same as the | |
942 | size of an integer. | |
943 | @end defmac | |
944 | ||
945 | @defmac STACK_BOUNDARY | |
946 | Define this macro to the minimum alignment enforced by hardware for the | |
947 | stack pointer on this machine. The definition is a C expression for the | |
948 | desired alignment (measured in bits). This value is used as a default | |
949 | if @code{PREFERRED_STACK_BOUNDARY} is not defined. On most machines, | |
950 | this should be the same as @code{PARM_BOUNDARY}. | |
951 | @end defmac | |
952 | ||
953 | @defmac PREFERRED_STACK_BOUNDARY | |
954 | Define this macro if you wish to preserve a certain alignment for the | |
955 | stack pointer, greater than what the hardware enforces. The definition | |
956 | is a C expression for the desired alignment (measured in bits). This | |
957 | macro must evaluate to a value equal to or larger than | |
958 | @code{STACK_BOUNDARY}. | |
959 | @end defmac | |
960 | ||
961 | @defmac INCOMING_STACK_BOUNDARY | |
962 | Define this macro if the incoming stack boundary may be different | |
963 | from @code{PREFERRED_STACK_BOUNDARY}. This macro must evaluate | |
964 | to a value equal to or larger than @code{STACK_BOUNDARY}. | |
965 | @end defmac | |
966 | ||
967 | @defmac FUNCTION_BOUNDARY | |
968 | Alignment required for a function entry point, in bits. | |
969 | @end defmac | |
970 | ||
971 | @defmac BIGGEST_ALIGNMENT | |
972 | Biggest alignment that any data type can require on this machine, in | |
973 | bits. Note that this is not the biggest alignment that is supported, | |
974 | just the biggest alignment that, when violated, may cause a fault. | |
975 | @end defmac | |
976 | ||
6d2b7199 BS |
977 | @hook TARGET_ABSOLUTE_BIGGEST_ALIGNMENT |
978 | ||
38f8b050 JR |
979 | @defmac MALLOC_ABI_ALIGNMENT |
980 | Alignment, in bits, a C conformant malloc implementation has to | |
981 | provide. If not defined, the default value is @code{BITS_PER_WORD}. | |
982 | @end defmac | |
983 | ||
984 | @defmac ATTRIBUTE_ALIGNED_VALUE | |
985 | Alignment used by the @code{__attribute__ ((aligned))} construct. If | |
986 | not defined, the default value is @code{BIGGEST_ALIGNMENT}. | |
987 | @end defmac | |
988 | ||
989 | @defmac MINIMUM_ATOMIC_ALIGNMENT | |
990 | If defined, the smallest alignment, in bits, that can be given to an | |
991 | object that can be referenced in one operation, without disturbing any | |
992 | nearby object. Normally, this is @code{BITS_PER_UNIT}, but may be larger | |
993 | on machines that don't have byte or half-word store operations. | |
994 | @end defmac | |
995 | ||
996 | @defmac BIGGEST_FIELD_ALIGNMENT | |
997 | Biggest alignment that any structure or union field can require on this | |
998 | machine, in bits. If defined, this overrides @code{BIGGEST_ALIGNMENT} for | |
999 | structure and union fields only, unless the field alignment has been set | |
1000 | by the @code{__attribute__ ((aligned (@var{n})))} construct. | |
1001 | @end defmac | |
1002 | ||
a4cf4b64 RB |
1003 | @defmac ADJUST_FIELD_ALIGN (@var{field}, @var{type}, @var{computed}) |
1004 | An expression for the alignment of a structure field @var{field} of | |
1005 | type @var{type} if the alignment computed in the usual way (including | |
1006 | applying of @code{BIGGEST_ALIGNMENT} and @code{BIGGEST_FIELD_ALIGNMENT} to the | |
38f8b050 JR |
1007 | alignment) is @var{computed}. It overrides alignment only if the |
1008 | field alignment has not been set by the | |
a4cf4b64 RB |
1009 | @code{__attribute__ ((aligned (@var{n})))} construct. Note that @var{field} |
1010 | may be @code{NULL_TREE} in case we just query for the minimum alignment | |
1011 | of a field of type @var{type} in structure context. | |
38f8b050 JR |
1012 | @end defmac |
1013 | ||
1014 | @defmac MAX_STACK_ALIGNMENT | |
1015 | Biggest stack alignment guaranteed by the backend. Use this macro | |
1016 | to specify the maximum alignment of a variable on stack. | |
1017 | ||
1018 | If not defined, the default value is @code{STACK_BOUNDARY}. | |
1019 | ||
1020 | @c FIXME: The default should be @code{PREFERRED_STACK_BOUNDARY}. | |
1021 | @c But the fix for PR 32893 indicates that we can only guarantee | |
1022 | @c maximum stack alignment on stack up to @code{STACK_BOUNDARY}, not | |
1023 | @c @code{PREFERRED_STACK_BOUNDARY}, if stack alignment isn't supported. | |
1024 | @end defmac | |
1025 | ||
1026 | @defmac MAX_OFILE_ALIGNMENT | |
1027 | Biggest alignment supported by the object file format of this machine. | |
1028 | Use this macro to limit the alignment which can be specified using the | |
4c7bd361 MS |
1029 | @code{__attribute__ ((aligned (@var{n})))} construct for functions and |
1030 | objects with static storage duration. The alignment of automatic | |
1031 | objects may exceed the object file format maximum up to the maximum | |
1032 | supported by GCC. If not defined, the default value is | |
1033 | @code{BIGGEST_ALIGNMENT}. | |
38f8b050 JR |
1034 | |
1035 | On systems that use ELF, the default (in @file{config/elfos.h}) is | |
1036 | the largest supported 32-bit ELF section alignment representable on | |
630ba2fd | 1037 | a 32-bit host e.g.@: @samp{(((uint64_t) 1 << 28) * 8)}. |
38f8b050 JR |
1038 | On 32-bit ELF the largest supported section alignment in bits is |
1039 | @samp{(0x80000000 * 8)}, but this is not representable on 32-bit hosts. | |
1040 | @end defmac | |
1041 | ||
0a9d711d SP |
1042 | @hook TARGET_LOWER_LOCAL_DECL_ALIGNMENT |
1043 | ||
f073de07 RS |
1044 | @hook TARGET_STATIC_RTX_ALIGNMENT |
1045 | ||
38f8b050 JR |
1046 | @defmac DATA_ALIGNMENT (@var{type}, @var{basic-align}) |
1047 | If defined, a C expression to compute the alignment for a variable in | |
1048 | the static store. @var{type} is the data type, and @var{basic-align} is | |
1049 | the alignment that the object would ordinarily have. The value of this | |
1050 | macro is used instead of that alignment to align the object. | |
1051 | ||
1052 | If this macro is not defined, then @var{basic-align} is used. | |
1053 | ||
1054 | @findex strcpy | |
1055 | One use of this macro is to increase alignment of medium-size data to | |
1056 | make it all fit in fewer cache lines. Another is to cause character | |
1057 | arrays to be word-aligned so that @code{strcpy} calls that copy | |
1058 | constants to character arrays can be done inline. | |
1059 | @end defmac | |
1060 | ||
df8a1d28 JJ |
1061 | @defmac DATA_ABI_ALIGNMENT (@var{type}, @var{basic-align}) |
1062 | Similar to @code{DATA_ALIGNMENT}, but for the cases where the ABI mandates | |
1063 | some alignment increase, instead of optimization only purposes. E.g.@ | |
1064 | AMD x86-64 psABI says that variables with array type larger than 15 bytes | |
1065 | must be aligned to 16 byte boundaries. | |
1066 | ||
1067 | If this macro is not defined, then @var{basic-align} is used. | |
1068 | @end defmac | |
1069 | ||
58e17cf8 | 1070 | @hook TARGET_CONSTANT_ALIGNMENT |
38f8b050 JR |
1071 | |
1072 | @defmac LOCAL_ALIGNMENT (@var{type}, @var{basic-align}) | |
1073 | If defined, a C expression to compute the alignment for a variable in | |
1074 | the local store. @var{type} is the data type, and @var{basic-align} is | |
1075 | the alignment that the object would ordinarily have. The value of this | |
1076 | macro is used instead of that alignment to align the object. | |
1077 | ||
1078 | If this macro is not defined, then @var{basic-align} is used. | |
1079 | ||
1080 | One use of this macro is to increase alignment of medium-size data to | |
1081 | make it all fit in fewer cache lines. | |
4a6336ad | 1082 | |
64ad7c99 | 1083 | If the value of this macro has a type, it should be an unsigned type. |
38f8b050 JR |
1084 | @end defmac |
1085 | ||
5aea1e76 UW |
1086 | @hook TARGET_VECTOR_ALIGNMENT |
1087 | ||
38f8b050 JR |
1088 | @defmac STACK_SLOT_ALIGNMENT (@var{type}, @var{mode}, @var{basic-align}) |
1089 | If defined, a C expression to compute the alignment for stack slot. | |
1090 | @var{type} is the data type, @var{mode} is the widest mode available, | |
1091 | and @var{basic-align} is the alignment that the slot would ordinarily | |
1092 | have. The value of this macro is used instead of that alignment to | |
1093 | align the slot. | |
1094 | ||
1095 | If this macro is not defined, then @var{basic-align} is used when | |
1096 | @var{type} is @code{NULL}. Otherwise, @code{LOCAL_ALIGNMENT} will | |
1097 | be used. | |
1098 | ||
1099 | This macro is to set alignment of stack slot to the maximum alignment | |
1100 | of all possible modes which the slot may have. | |
4a6336ad | 1101 | |
64ad7c99 | 1102 | If the value of this macro has a type, it should be an unsigned type. |
38f8b050 JR |
1103 | @end defmac |
1104 | ||
1105 | @defmac LOCAL_DECL_ALIGNMENT (@var{decl}) | |
1106 | If defined, a C expression to compute the alignment for a local | |
1107 | variable @var{decl}. | |
1108 | ||
1109 | If this macro is not defined, then | |
1110 | @code{LOCAL_ALIGNMENT (TREE_TYPE (@var{decl}), DECL_ALIGN (@var{decl}))} | |
1111 | is used. | |
1112 | ||
1113 | One use of this macro is to increase alignment of medium-size data to | |
1114 | make it all fit in fewer cache lines. | |
4a6336ad | 1115 | |
64ad7c99 | 1116 | If the value of this macro has a type, it should be an unsigned type. |
38f8b050 JR |
1117 | @end defmac |
1118 | ||
1119 | @defmac MINIMUM_ALIGNMENT (@var{exp}, @var{mode}, @var{align}) | |
1120 | If defined, a C expression to compute the minimum required alignment | |
1121 | for dynamic stack realignment purposes for @var{exp} (a type or decl), | |
1122 | @var{mode}, assuming normal alignment @var{align}. | |
1123 | ||
1124 | If this macro is not defined, then @var{align} will be used. | |
1125 | @end defmac | |
1126 | ||
1127 | @defmac EMPTY_FIELD_BOUNDARY | |
1128 | Alignment in bits to be given to a structure bit-field that follows an | |
1129 | empty field such as @code{int : 0;}. | |
1130 | ||
1131 | If @code{PCC_BITFIELD_TYPE_MATTERS} is true, it overrides this macro. | |
1132 | @end defmac | |
1133 | ||
1134 | @defmac STRUCTURE_SIZE_BOUNDARY | |
1135 | Number of bits which any structure or union's size must be a multiple of. | |
1136 | Each structure or union's size is rounded up to a multiple of this. | |
1137 | ||
1138 | If you do not define this macro, the default is the same as | |
1139 | @code{BITS_PER_UNIT}. | |
1140 | @end defmac | |
1141 | ||
1142 | @defmac STRICT_ALIGNMENT | |
1143 | Define this macro to be the value 1 if instructions will fail to work | |
1144 | if given data not on the nominal alignment. If instructions will merely | |
1145 | go slower in that case, define this macro as 0. | |
1146 | @end defmac | |
1147 | ||
1148 | @defmac PCC_BITFIELD_TYPE_MATTERS | |
1149 | Define this if you wish to imitate the way many other C compilers handle | |
1150 | alignment of bit-fields and the structures that contain them. | |
1151 | ||
1152 | The behavior is that the type written for a named bit-field (@code{int}, | |
1153 | @code{short}, or other integer type) imposes an alignment for the entire | |
1154 | structure, as if the structure really did contain an ordinary field of | |
1155 | that type. In addition, the bit-field is placed within the structure so | |
1156 | that it would fit within such a field, not crossing a boundary for it. | |
1157 | ||
1158 | Thus, on most machines, a named bit-field whose type is written as | |
1159 | @code{int} would not cross a four-byte boundary, and would force | |
1160 | four-byte alignment for the whole structure. (The alignment used may | |
1161 | not be four bytes; it is controlled by the other alignment parameters.) | |
1162 | ||
1163 | An unnamed bit-field will not affect the alignment of the containing | |
1164 | structure. | |
1165 | ||
1166 | If the macro is defined, its definition should be a C expression; | |
1167 | a nonzero value for the expression enables this behavior. | |
1168 | ||
1169 | Note that if this macro is not defined, or its value is zero, some | |
1170 | bit-fields may cross more than one alignment boundary. The compiler can | |
1171 | support such references if there are @samp{insv}, @samp{extv}, and | |
1172 | @samp{extzv} insns that can directly reference memory. | |
1173 | ||
1174 | The other known way of making bit-fields work is to define | |
1175 | @code{STRUCTURE_SIZE_BOUNDARY} as large as @code{BIGGEST_ALIGNMENT}. | |
1176 | Then every structure can be accessed with fullwords. | |
1177 | ||
1178 | Unless the machine has bit-field instructions or you define | |
1179 | @code{STRUCTURE_SIZE_BOUNDARY} that way, you must define | |
1180 | @code{PCC_BITFIELD_TYPE_MATTERS} to have a nonzero value. | |
1181 | ||
1182 | If your aim is to make GCC use the same conventions for laying out | |
1183 | bit-fields as are used by another compiler, here is how to investigate | |
1184 | what the other compiler does. Compile and run this program: | |
1185 | ||
1186 | @smallexample | |
1187 | struct foo1 | |
1188 | @{ | |
1189 | char x; | |
1190 | char :0; | |
1191 | char y; | |
1192 | @}; | |
1193 | ||
1194 | struct foo2 | |
1195 | @{ | |
1196 | char x; | |
1197 | int :0; | |
1198 | char y; | |
1199 | @}; | |
1200 | ||
1201 | main () | |
1202 | @{ | |
1203 | printf ("Size of foo1 is %d\n", | |
1204 | sizeof (struct foo1)); | |
1205 | printf ("Size of foo2 is %d\n", | |
1206 | sizeof (struct foo2)); | |
1207 | exit (0); | |
1208 | @} | |
1209 | @end smallexample | |
1210 | ||
1211 | If this prints 2 and 5, then the compiler's behavior is what you would | |
1212 | get from @code{PCC_BITFIELD_TYPE_MATTERS}. | |
1213 | @end defmac | |
1214 | ||
1215 | @defmac BITFIELD_NBYTES_LIMITED | |
1216 | Like @code{PCC_BITFIELD_TYPE_MATTERS} except that its effect is limited | |
1217 | to aligning a bit-field within the structure. | |
1218 | @end defmac | |
1219 | ||
1220 | @hook TARGET_ALIGN_ANON_BITFIELD | |
38f8b050 JR |
1221 | |
1222 | @hook TARGET_NARROW_VOLATILE_BITFIELD | |
38f8b050 | 1223 | |
d9886a9e | 1224 | @hook TARGET_MEMBER_TYPE_FORCES_BLK |
38f8b050 JR |
1225 | |
1226 | @defmac ROUND_TYPE_ALIGN (@var{type}, @var{computed}, @var{specified}) | |
1227 | Define this macro as an expression for the alignment of a type (given | |
1228 | by @var{type} as a tree node) if the alignment computed in the usual | |
1229 | way is @var{computed} and the alignment explicitly specified was | |
1230 | @var{specified}. | |
1231 | ||
1232 | The default is to use @var{specified} if it is larger; otherwise, use | |
1233 | the smaller of @var{computed} and @code{BIGGEST_ALIGNMENT} | |
1234 | @end defmac | |
1235 | ||
1236 | @defmac MAX_FIXED_MODE_SIZE | |
1237 | An integer expression for the size in bits of the largest integer | |
1238 | machine mode that should actually be used. All integer machine modes of | |
1239 | this size or smaller can be used for structures and unions with the | |
1240 | appropriate sizes. If this macro is undefined, @code{GET_MODE_BITSIZE | |
1241 | (DImode)} is assumed. | |
1242 | @end defmac | |
1243 | ||
1244 | @defmac STACK_SAVEAREA_MODE (@var{save_level}) | |
ef4bddc2 | 1245 | If defined, an expression of type @code{machine_mode} that |
38f8b050 JR |
1246 | specifies the mode of the save area operand of a |
1247 | @code{save_stack_@var{level}} named pattern (@pxref{Standard Names}). | |
1248 | @var{save_level} is one of @code{SAVE_BLOCK}, @code{SAVE_FUNCTION}, or | |
1249 | @code{SAVE_NONLOCAL} and selects which of the three named patterns is | |
1250 | having its mode specified. | |
1251 | ||
1252 | You need not define this macro if it always returns @code{Pmode}. You | |
1253 | would most commonly define this macro if the | |
1254 | @code{save_stack_@var{level}} patterns need to support both a 32- and a | |
1255 | 64-bit mode. | |
1256 | @end defmac | |
1257 | ||
1258 | @defmac STACK_SIZE_MODE | |
ef4bddc2 | 1259 | If defined, an expression of type @code{machine_mode} that |
38f8b050 JR |
1260 | specifies the mode of the size increment operand of an |
1261 | @code{allocate_stack} named pattern (@pxref{Standard Names}). | |
1262 | ||
1263 | You need not define this macro if it always returns @code{word_mode}. | |
1264 | You would most commonly define this macro if the @code{allocate_stack} | |
1265 | pattern needs to support both a 32- and a 64-bit mode. | |
1266 | @end defmac | |
1267 | ||
1268 | @hook TARGET_LIBGCC_CMP_RETURN_MODE | |
38f8b050 JR |
1269 | |
1270 | @hook TARGET_LIBGCC_SHIFT_COUNT_MODE | |
38f8b050 JR |
1271 | |
1272 | @hook TARGET_UNWIND_WORD_MODE | |
38f8b050 | 1273 | |
38f8b050 | 1274 | @hook TARGET_MS_BITFIELD_LAYOUT_P |
38f8b050 JR |
1275 | |
1276 | @hook TARGET_DECIMAL_FLOAT_SUPPORTED_P | |
38f8b050 JR |
1277 | |
1278 | @hook TARGET_FIXED_POINT_SUPPORTED_P | |
38f8b050 JR |
1279 | |
1280 | @hook TARGET_EXPAND_TO_RTL_HOOK | |
38f8b050 JR |
1281 | |
1282 | @hook TARGET_INSTANTIATE_DECLS | |
38f8b050 JR |
1283 | |
1284 | @hook TARGET_MANGLE_TYPE | |
38f8b050 JR |
1285 | |
1286 | @node Type Layout | |
1287 | @section Layout of Source Language Data Types | |
1288 | ||
1289 | These macros define the sizes and other characteristics of the standard | |
1290 | basic data types used in programs being compiled. Unlike the macros in | |
1291 | the previous section, these apply to specific features of C and related | |
1292 | languages, rather than to fundamental aspects of storage layout. | |
1293 | ||
1294 | @defmac INT_TYPE_SIZE | |
1295 | A C expression for the size in bits of the type @code{int} on the | |
1296 | target machine. If you don't define this, the default is one word. | |
1297 | @end defmac | |
1298 | ||
1299 | @defmac SHORT_TYPE_SIZE | |
1300 | A C expression for the size in bits of the type @code{short} on the | |
1301 | target machine. If you don't define this, the default is half a word. | |
1302 | (If this would be less than one storage unit, it is rounded up to one | |
1303 | unit.) | |
1304 | @end defmac | |
1305 | ||
1306 | @defmac LONG_TYPE_SIZE | |
1307 | A C expression for the size in bits of the type @code{long} on the | |
1308 | target machine. If you don't define this, the default is one word. | |
1309 | @end defmac | |
1310 | ||
1311 | @defmac ADA_LONG_TYPE_SIZE | |
1312 | On some machines, the size used for the Ada equivalent of the type | |
1313 | @code{long} by a native Ada compiler differs from that used by C@. In | |
1314 | that situation, define this macro to be a C expression to be used for | |
1315 | the size of that type. If you don't define this, the default is the | |
1316 | value of @code{LONG_TYPE_SIZE}. | |
1317 | @end defmac | |
1318 | ||
1319 | @defmac LONG_LONG_TYPE_SIZE | |
1320 | A C expression for the size in bits of the type @code{long long} on the | |
1321 | target machine. If you don't define this, the default is two | |
1322 | words. If you want to support GNU Ada on your machine, the value of this | |
1323 | macro must be at least 64. | |
1324 | @end defmac | |
1325 | ||
1326 | @defmac CHAR_TYPE_SIZE | |
1327 | A C expression for the size in bits of the type @code{char} on the | |
1328 | target machine. If you don't define this, the default is | |
1329 | @code{BITS_PER_UNIT}. | |
1330 | @end defmac | |
1331 | ||
1332 | @defmac BOOL_TYPE_SIZE | |
1333 | A C expression for the size in bits of the C++ type @code{bool} and | |
1334 | C99 type @code{_Bool} on the target machine. If you don't define | |
1335 | this, and you probably shouldn't, the default is @code{CHAR_TYPE_SIZE}. | |
1336 | @end defmac | |
1337 | ||
1338 | @defmac FLOAT_TYPE_SIZE | |
1339 | A C expression for the size in bits of the type @code{float} on the | |
1340 | target machine. If you don't define this, the default is one word. | |
1341 | @end defmac | |
1342 | ||
1343 | @defmac DOUBLE_TYPE_SIZE | |
1344 | A C expression for the size in bits of the type @code{double} on the | |
1345 | target machine. If you don't define this, the default is two | |
1346 | words. | |
1347 | @end defmac | |
1348 | ||
1349 | @defmac LONG_DOUBLE_TYPE_SIZE | |
1350 | A C expression for the size in bits of the type @code{long double} on | |
1351 | the target machine. If you don't define this, the default is two | |
1352 | words. | |
1353 | @end defmac | |
1354 | ||
1355 | @defmac SHORT_FRACT_TYPE_SIZE | |
1356 | A C expression for the size in bits of the type @code{short _Fract} on | |
1357 | the target machine. If you don't define this, the default is | |
1358 | @code{BITS_PER_UNIT}. | |
1359 | @end defmac | |
1360 | ||
1361 | @defmac FRACT_TYPE_SIZE | |
1362 | A C expression for the size in bits of the type @code{_Fract} on | |
1363 | the target machine. If you don't define this, the default is | |
1364 | @code{BITS_PER_UNIT * 2}. | |
1365 | @end defmac | |
1366 | ||
1367 | @defmac LONG_FRACT_TYPE_SIZE | |
1368 | A C expression for the size in bits of the type @code{long _Fract} on | |
1369 | the target machine. If you don't define this, the default is | |
1370 | @code{BITS_PER_UNIT * 4}. | |
1371 | @end defmac | |
1372 | ||
1373 | @defmac LONG_LONG_FRACT_TYPE_SIZE | |
1374 | A C expression for the size in bits of the type @code{long long _Fract} on | |
1375 | the target machine. If you don't define this, the default is | |
1376 | @code{BITS_PER_UNIT * 8}. | |
1377 | @end defmac | |
1378 | ||
1379 | @defmac SHORT_ACCUM_TYPE_SIZE | |
1380 | A C expression for the size in bits of the type @code{short _Accum} on | |
1381 | the target machine. If you don't define this, the default is | |
1382 | @code{BITS_PER_UNIT * 2}. | |
1383 | @end defmac | |
1384 | ||
1385 | @defmac ACCUM_TYPE_SIZE | |
1386 | A C expression for the size in bits of the type @code{_Accum} on | |
1387 | the target machine. If you don't define this, the default is | |
1388 | @code{BITS_PER_UNIT * 4}. | |
1389 | @end defmac | |
1390 | ||
1391 | @defmac LONG_ACCUM_TYPE_SIZE | |
1392 | A C expression for the size in bits of the type @code{long _Accum} on | |
1393 | the target machine. If you don't define this, the default is | |
1394 | @code{BITS_PER_UNIT * 8}. | |
1395 | @end defmac | |
1396 | ||
1397 | @defmac LONG_LONG_ACCUM_TYPE_SIZE | |
1398 | A C expression for the size in bits of the type @code{long long _Accum} on | |
1399 | the target machine. If you don't define this, the default is | |
1400 | @code{BITS_PER_UNIT * 16}. | |
1401 | @end defmac | |
1402 | ||
cdbf4541 BS |
1403 | @defmac LIBGCC2_GNU_PREFIX |
1404 | This macro corresponds to the @code{TARGET_LIBFUNC_GNU_PREFIX} target | |
1405 | hook and should be defined if that hook is overriden to be true. It | |
1406 | causes function names in libgcc to be changed to use a @code{__gnu_} | |
1407 | prefix for their name rather than the default @code{__}. A port which | |
1408 | uses this macro should also arrange to use @file{t-gnu-prefix} in | |
1409 | the libgcc @file{config.host}. | |
1410 | @end defmac | |
1411 | ||
38f8b050 JR |
1412 | @defmac WIDEST_HARDWARE_FP_SIZE |
1413 | A C expression for the size in bits of the widest floating-point format | |
1414 | supported by the hardware. If you define this macro, you must specify a | |
1415 | value less than or equal to the value of @code{LONG_DOUBLE_TYPE_SIZE}. | |
1416 | If you do not define this macro, the value of @code{LONG_DOUBLE_TYPE_SIZE} | |
1417 | is the default. | |
1418 | @end defmac | |
1419 | ||
1420 | @defmac DEFAULT_SIGNED_CHAR | |
1421 | An expression whose value is 1 or 0, according to whether the type | |
1422 | @code{char} should be signed or unsigned by default. The user can | |
1423 | always override this default with the options @option{-fsigned-char} | |
1424 | and @option{-funsigned-char}. | |
1425 | @end defmac | |
1426 | ||
1427 | @hook TARGET_DEFAULT_SHORT_ENUMS | |
38f8b050 JR |
1428 | |
1429 | @defmac SIZE_TYPE | |
1430 | A C expression for a string describing the name of the data type to use | |
1431 | for size values. The typedef name @code{size_t} is defined using the | |
1432 | contents of the string. | |
1433 | ||
1434 | The string can contain more than one keyword. If so, separate them with | |
1435 | spaces, and write first any length keyword, then @code{unsigned} if | |
1436 | appropriate, and finally @code{int}. The string must exactly match one | |
1437 | of the data type names defined in the function | |
176a96de HPN |
1438 | @code{c_common_nodes_and_builtins} in the file @file{c-family/c-common.c}. |
1439 | You may not omit @code{int} or change the order---that would cause the | |
1440 | compiler to crash on startup. | |
38f8b050 JR |
1441 | |
1442 | If you don't define this macro, the default is @code{"long unsigned | |
1443 | int"}. | |
1444 | @end defmac | |
1445 | ||
18dae016 TG |
1446 | @defmac SIZETYPE |
1447 | GCC defines internal types (@code{sizetype}, @code{ssizetype}, | |
1448 | @code{bitsizetype} and @code{sbitsizetype}) for expressions | |
1449 | dealing with size. This macro is a C expression for a string describing | |
1450 | the name of the data type from which the precision of @code{sizetype} | |
1451 | is extracted. | |
1452 | ||
1453 | The string has the same restrictions as @code{SIZE_TYPE} string. | |
1454 | ||
1455 | If you don't define this macro, the default is @code{SIZE_TYPE}. | |
1456 | @end defmac | |
1457 | ||
38f8b050 JR |
1458 | @defmac PTRDIFF_TYPE |
1459 | A C expression for a string describing the name of the data type to use | |
1460 | for the result of subtracting two pointers. The typedef name | |
1461 | @code{ptrdiff_t} is defined using the contents of the string. See | |
1462 | @code{SIZE_TYPE} above for more information. | |
1463 | ||
1464 | If you don't define this macro, the default is @code{"long int"}. | |
1465 | @end defmac | |
1466 | ||
1467 | @defmac WCHAR_TYPE | |
1468 | A C expression for a string describing the name of the data type to use | |
1469 | for wide characters. The typedef name @code{wchar_t} is defined using | |
1470 | the contents of the string. See @code{SIZE_TYPE} above for more | |
1471 | information. | |
1472 | ||
1473 | If you don't define this macro, the default is @code{"int"}. | |
1474 | @end defmac | |
1475 | ||
1476 | @defmac WCHAR_TYPE_SIZE | |
1477 | A C expression for the size in bits of the data type for wide | |
1478 | characters. This is used in @code{cpp}, which cannot make use of | |
1479 | @code{WCHAR_TYPE}. | |
1480 | @end defmac | |
1481 | ||
1482 | @defmac WINT_TYPE | |
1483 | A C expression for a string describing the name of the data type to | |
1484 | use for wide characters passed to @code{printf} and returned from | |
1485 | @code{getwc}. The typedef name @code{wint_t} is defined using the | |
1486 | contents of the string. See @code{SIZE_TYPE} above for more | |
1487 | information. | |
1488 | ||
1489 | If you don't define this macro, the default is @code{"unsigned int"}. | |
1490 | @end defmac | |
1491 | ||
1492 | @defmac INTMAX_TYPE | |
1493 | A C expression for a string describing the name of the data type that | |
1494 | can represent any value of any standard or extended signed integer type. | |
1495 | The typedef name @code{intmax_t} is defined using the contents of the | |
1496 | string. See @code{SIZE_TYPE} above for more information. | |
1497 | ||
1498 | If you don't define this macro, the default is the first of | |
1499 | @code{"int"}, @code{"long int"}, or @code{"long long int"} that has as | |
1500 | much precision as @code{long long int}. | |
1501 | @end defmac | |
1502 | ||
1503 | @defmac UINTMAX_TYPE | |
1504 | A C expression for a string describing the name of the data type that | |
1505 | can represent any value of any standard or extended unsigned integer | |
1506 | type. The typedef name @code{uintmax_t} is defined using the contents | |
1507 | of the string. See @code{SIZE_TYPE} above for more information. | |
1508 | ||
1509 | If you don't define this macro, the default is the first of | |
1510 | @code{"unsigned int"}, @code{"long unsigned int"}, or @code{"long long | |
1511 | unsigned int"} that has as much precision as @code{long long unsigned | |
1512 | int}. | |
1513 | @end defmac | |
1514 | ||
1515 | @defmac SIG_ATOMIC_TYPE | |
1516 | @defmacx INT8_TYPE | |
1517 | @defmacx INT16_TYPE | |
1518 | @defmacx INT32_TYPE | |
1519 | @defmacx INT64_TYPE | |
1520 | @defmacx UINT8_TYPE | |
1521 | @defmacx UINT16_TYPE | |
1522 | @defmacx UINT32_TYPE | |
1523 | @defmacx UINT64_TYPE | |
1524 | @defmacx INT_LEAST8_TYPE | |
1525 | @defmacx INT_LEAST16_TYPE | |
1526 | @defmacx INT_LEAST32_TYPE | |
1527 | @defmacx INT_LEAST64_TYPE | |
1528 | @defmacx UINT_LEAST8_TYPE | |
1529 | @defmacx UINT_LEAST16_TYPE | |
1530 | @defmacx UINT_LEAST32_TYPE | |
1531 | @defmacx UINT_LEAST64_TYPE | |
1532 | @defmacx INT_FAST8_TYPE | |
1533 | @defmacx INT_FAST16_TYPE | |
1534 | @defmacx INT_FAST32_TYPE | |
1535 | @defmacx INT_FAST64_TYPE | |
1536 | @defmacx UINT_FAST8_TYPE | |
1537 | @defmacx UINT_FAST16_TYPE | |
1538 | @defmacx UINT_FAST32_TYPE | |
1539 | @defmacx UINT_FAST64_TYPE | |
1540 | @defmacx INTPTR_TYPE | |
1541 | @defmacx UINTPTR_TYPE | |
1542 | C expressions for the standard types @code{sig_atomic_t}, | |
1543 | @code{int8_t}, @code{int16_t}, @code{int32_t}, @code{int64_t}, | |
1544 | @code{uint8_t}, @code{uint16_t}, @code{uint32_t}, @code{uint64_t}, | |
1545 | @code{int_least8_t}, @code{int_least16_t}, @code{int_least32_t}, | |
1546 | @code{int_least64_t}, @code{uint_least8_t}, @code{uint_least16_t}, | |
1547 | @code{uint_least32_t}, @code{uint_least64_t}, @code{int_fast8_t}, | |
1548 | @code{int_fast16_t}, @code{int_fast32_t}, @code{int_fast64_t}, | |
1549 | @code{uint_fast8_t}, @code{uint_fast16_t}, @code{uint_fast32_t}, | |
1550 | @code{uint_fast64_t}, @code{intptr_t}, and @code{uintptr_t}. See | |
1551 | @code{SIZE_TYPE} above for more information. | |
1552 | ||
1553 | If any of these macros evaluates to a null pointer, the corresponding | |
1554 | type is not supported; if GCC is configured to provide | |
1555 | @code{<stdint.h>} in such a case, the header provided may not conform | |
1556 | to C99, depending on the type in question. The defaults for all of | |
1557 | these macros are null pointers. | |
1558 | @end defmac | |
1559 | ||
1560 | @defmac TARGET_PTRMEMFUNC_VBIT_LOCATION | |
1561 | The C++ compiler represents a pointer-to-member-function with a struct | |
1562 | that looks like: | |
1563 | ||
1564 | @smallexample | |
1565 | struct @{ | |
1566 | union @{ | |
1567 | void (*fn)(); | |
1568 | ptrdiff_t vtable_index; | |
1569 | @}; | |
1570 | ptrdiff_t delta; | |
1571 | @}; | |
1572 | @end smallexample | |
1573 | ||
1574 | @noindent | |
1575 | The C++ compiler must use one bit to indicate whether the function that | |
1576 | will be called through a pointer-to-member-function is virtual. | |
1577 | Normally, we assume that the low-order bit of a function pointer must | |
1578 | always be zero. Then, by ensuring that the vtable_index is odd, we can | |
1579 | distinguish which variant of the union is in use. But, on some | |
1580 | platforms function pointers can be odd, and so this doesn't work. In | |
1581 | that case, we use the low-order bit of the @code{delta} field, and shift | |
1582 | the remainder of the @code{delta} field to the left. | |
1583 | ||
1584 | GCC will automatically make the right selection about where to store | |
1585 | this bit using the @code{FUNCTION_BOUNDARY} setting for your platform. | |
1586 | However, some platforms such as ARM/Thumb have @code{FUNCTION_BOUNDARY} | |
1587 | set such that functions always start at even addresses, but the lowest | |
1588 | bit of pointers to functions indicate whether the function at that | |
1589 | address is in ARM or Thumb mode. If this is the case of your | |
1590 | architecture, you should define this macro to | |
1591 | @code{ptrmemfunc_vbit_in_delta}. | |
1592 | ||
1593 | In general, you should not have to define this macro. On architectures | |
1594 | in which function addresses are always even, according to | |
1595 | @code{FUNCTION_BOUNDARY}, GCC will automatically define this macro to | |
1596 | @code{ptrmemfunc_vbit_in_pfn}. | |
1597 | @end defmac | |
1598 | ||
1599 | @defmac TARGET_VTABLE_USES_DESCRIPTORS | |
1600 | Normally, the C++ compiler uses function pointers in vtables. This | |
1601 | macro allows the target to change to use ``function descriptors'' | |
1602 | instead. Function descriptors are found on targets for whom a | |
1603 | function pointer is actually a small data structure. Normally the | |
1604 | data structure consists of the actual code address plus a data | |
1605 | pointer to which the function's data is relative. | |
1606 | ||
1607 | If vtables are used, the value of this macro should be the number | |
1608 | of words that the function descriptor occupies. | |
1609 | @end defmac | |
1610 | ||
1611 | @defmac TARGET_VTABLE_ENTRY_ALIGN | |
1612 | By default, the vtable entries are void pointers, the so the alignment | |
1613 | is the same as pointer alignment. The value of this macro specifies | |
1614 | the alignment of the vtable entry in bits. It should be defined only | |
1615 | when special alignment is necessary. */ | |
1616 | @end defmac | |
1617 | ||
1618 | @defmac TARGET_VTABLE_DATA_ENTRY_DISTANCE | |
1619 | There are a few non-descriptor entries in the vtable at offsets below | |
1620 | zero. If these entries must be padded (say, to preserve the alignment | |
1621 | specified by @code{TARGET_VTABLE_ENTRY_ALIGN}), set this to the number | |
1622 | of words in each data entry. | |
1623 | @end defmac | |
1624 | ||
1625 | @node Registers | |
1626 | @section Register Usage | |
1627 | @cindex register usage | |
1628 | ||
1629 | This section explains how to describe what registers the target machine | |
1630 | has, and how (in general) they can be used. | |
1631 | ||
1632 | The description of which registers a specific instruction can use is | |
1633 | done with register classes; see @ref{Register Classes}. For information | |
1634 | on using registers to access a stack frame, see @ref{Frame Registers}. | |
1635 | For passing values in registers, see @ref{Register Arguments}. | |
1636 | For returning values in registers, see @ref{Scalar Return}. | |
1637 | ||
1638 | @menu | |
1639 | * Register Basics:: Number and kinds of registers. | |
1640 | * Allocation Order:: Order in which registers are allocated. | |
1641 | * Values in Registers:: What kinds of values each reg can hold. | |
1642 | * Leaf Functions:: Renumbering registers for leaf functions. | |
1643 | * Stack Registers:: Handling a register stack such as 80387. | |
1644 | @end menu | |
1645 | ||
1646 | @node Register Basics | |
1647 | @subsection Basic Characteristics of Registers | |
1648 | ||
1649 | @c prevent bad page break with this line | |
1650 | Registers have various characteristics. | |
1651 | ||
1652 | @defmac FIRST_PSEUDO_REGISTER | |
1653 | Number of hardware registers known to the compiler. They receive | |
1654 | numbers 0 through @code{FIRST_PSEUDO_REGISTER-1}; thus, the first | |
1655 | pseudo register's number really is assigned the number | |
1656 | @code{FIRST_PSEUDO_REGISTER}. | |
1657 | @end defmac | |
1658 | ||
1659 | @defmac FIXED_REGISTERS | |
1660 | @cindex fixed register | |
1661 | An initializer that says which registers are used for fixed purposes | |
1662 | all throughout the compiled code and are therefore not available for | |
1663 | general allocation. These would include the stack pointer, the frame | |
1664 | pointer (except on machines where that can be used as a general | |
1665 | register when no frame pointer is needed), the program counter on | |
1666 | machines where that is considered one of the addressable registers, | |
1667 | and any other numbered register with a standard use. | |
1668 | ||
1669 | This information is expressed as a sequence of numbers, separated by | |
1670 | commas and surrounded by braces. The @var{n}th number is 1 if | |
1671 | register @var{n} is fixed, 0 otherwise. | |
1672 | ||
1673 | The table initialized from this macro, and the table initialized by | |
1674 | the following one, may be overridden at run time either automatically, | |
1675 | by the actions of the macro @code{CONDITIONAL_REGISTER_USAGE}, or by | |
1676 | the user with the command options @option{-ffixed-@var{reg}}, | |
1677 | @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}. | |
1678 | @end defmac | |
1679 | ||
1680 | @defmac CALL_USED_REGISTERS | |
1681 | @cindex call-used register | |
1682 | @cindex call-clobbered register | |
1683 | @cindex call-saved register | |
1684 | Like @code{FIXED_REGISTERS} but has 1 for each register that is | |
1685 | clobbered (in general) by function calls as well as for fixed | |
1686 | registers. This macro therefore identifies the registers that are not | |
1687 | available for general allocation of values that must live across | |
1688 | function calls. | |
1689 | ||
1690 | If a register has 0 in @code{CALL_USED_REGISTERS}, the compiler | |
1691 | automatically saves it on function entry and restores it on function | |
1692 | exit, if the register is used within the function. | |
d7fb4c31 RS |
1693 | |
1694 | Exactly one of @code{CALL_USED_REGISTERS} and @code{CALL_REALLY_USED_REGISTERS} | |
1695 | must be defined. Modern ports should define @code{CALL_REALLY_USED_REGISTERS}. | |
38f8b050 JR |
1696 | @end defmac |
1697 | ||
1698 | @defmac CALL_REALLY_USED_REGISTERS | |
1699 | @cindex call-used register | |
1700 | @cindex call-clobbered register | |
1701 | @cindex call-saved register | |
1702 | Like @code{CALL_USED_REGISTERS} except this macro doesn't require | |
1703 | that the entire set of @code{FIXED_REGISTERS} be included. | |
1704 | (@code{CALL_USED_REGISTERS} must be a superset of @code{FIXED_REGISTERS}). | |
d7fb4c31 RS |
1705 | |
1706 | Exactly one of @code{CALL_USED_REGISTERS} and @code{CALL_REALLY_USED_REGISTERS} | |
1707 | must be defined. Modern ports should define @code{CALL_REALLY_USED_REGISTERS}. | |
38f8b050 JR |
1708 | @end defmac |
1709 | ||
002ffd3c RS |
1710 | @cindex call-used register |
1711 | @cindex call-clobbered register | |
1712 | @cindex call-saved register | |
1713 | @hook TARGET_FNTYPE_ABI | |
1714 | ||
5a5a3bc5 RS |
1715 | @hook TARGET_INSN_CALLEE_ABI |
1716 | ||
38f8b050 JR |
1717 | @cindex call-used register |
1718 | @cindex call-clobbered register | |
1719 | @cindex call-saved register | |
80ec73f4 | 1720 | @hook TARGET_HARD_REGNO_CALL_PART_CLOBBERED |
38f8b050 | 1721 | |
e8cecccc ML |
1722 | @hook TARGET_GET_MULTILIB_ABI_NAME |
1723 | ||
38f8b050 JR |
1724 | @findex fixed_regs |
1725 | @findex call_used_regs | |
1726 | @findex global_regs | |
1727 | @findex reg_names | |
1728 | @findex reg_class_contents | |
5efd84c5 | 1729 | @hook TARGET_CONDITIONAL_REGISTER_USAGE |
38f8b050 JR |
1730 | |
1731 | @defmac INCOMING_REGNO (@var{out}) | |
1732 | Define this macro if the target machine has register windows. This C | |
1733 | expression returns the register number as seen by the called function | |
1734 | corresponding to the register number @var{out} as seen by the calling | |
1735 | function. Return @var{out} if register number @var{out} is not an | |
1736 | outbound register. | |
1737 | @end defmac | |
1738 | ||
1739 | @defmac OUTGOING_REGNO (@var{in}) | |
1740 | Define this macro if the target machine has register windows. This C | |
1741 | expression returns the register number as seen by the calling function | |
1742 | corresponding to the register number @var{in} as seen by the called | |
1743 | function. Return @var{in} if register number @var{in} is not an inbound | |
1744 | register. | |
1745 | @end defmac | |
1746 | ||
1747 | @defmac LOCAL_REGNO (@var{regno}) | |
1748 | Define this macro if the target machine has register windows. This C | |
1749 | expression returns true if the register is call-saved but is in the | |
1750 | register window. Unlike most call-saved registers, such registers | |
1751 | need not be explicitly restored on function exit or during non-local | |
1752 | gotos. | |
1753 | @end defmac | |
1754 | ||
1755 | @defmac PC_REGNUM | |
1756 | If the program counter has a register number, define this as that | |
1757 | register number. Otherwise, do not define it. | |
1758 | @end defmac | |
1759 | ||
1760 | @node Allocation Order | |
1761 | @subsection Order of Allocation of Registers | |
1762 | @cindex order of register allocation | |
1763 | @cindex register allocation order | |
1764 | ||
1765 | @c prevent bad page break with this line | |
1766 | Registers are allocated in order. | |
1767 | ||
1768 | @defmac REG_ALLOC_ORDER | |
1769 | If defined, an initializer for a vector of integers, containing the | |
1770 | numbers of hard registers in the order in which GCC should prefer | |
1771 | to use them (from most preferred to least). | |
1772 | ||
1773 | If this macro is not defined, registers are used lowest numbered first | |
1774 | (all else being equal). | |
1775 | ||
1776 | One use of this macro is on machines where the highest numbered | |
1777 | registers must always be saved and the save-multiple-registers | |
1778 | instruction supports only sequences of consecutive registers. On such | |
1779 | machines, define @code{REG_ALLOC_ORDER} to be an initializer that lists | |
1780 | the highest numbered allocable register first. | |
1781 | @end defmac | |
1782 | ||
1783 | @defmac ADJUST_REG_ALLOC_ORDER | |
1784 | A C statement (sans semicolon) to choose the order in which to allocate | |
1785 | hard registers for pseudo-registers local to a basic block. | |
1786 | ||
1787 | Store the desired register order in the array @code{reg_alloc_order}. | |
1788 | Element 0 should be the register to allocate first; element 1, the next | |
1789 | register; and so on. | |
1790 | ||
1791 | The macro body should not assume anything about the contents of | |
1792 | @code{reg_alloc_order} before execution of the macro. | |
1793 | ||
1794 | On most machines, it is not necessary to define this macro. | |
1795 | @end defmac | |
1796 | ||
1797 | @defmac HONOR_REG_ALLOC_ORDER | |
1798 | Normally, IRA tries to estimate the costs for saving a register in the | |
1799 | prologue and restoring it in the epilogue. This discourages it from | |
1800 | using call-saved registers. If a machine wants to ensure that IRA | |
1801 | allocates registers in the order given by REG_ALLOC_ORDER even if some | |
ed15c598 KC |
1802 | call-saved registers appear earlier than call-used ones, then define this |
1803 | macro as a C expression to nonzero. Default is 0. | |
38f8b050 JR |
1804 | @end defmac |
1805 | ||
1806 | @defmac IRA_HARD_REGNO_ADD_COST_MULTIPLIER (@var{regno}) | |
1807 | In some case register allocation order is not enough for the | |
1808 | Integrated Register Allocator (@acronym{IRA}) to generate a good code. | |
1809 | If this macro is defined, it should return a floating point value | |
1810 | based on @var{regno}. The cost of using @var{regno} for a pseudo will | |
1811 | be increased by approximately the pseudo's usage frequency times the | |
1812 | value returned by this macro. Not defining this macro is equivalent | |
1813 | to having it always return @code{0.0}. | |
1814 | ||
1815 | On most machines, it is not necessary to define this macro. | |
1816 | @end defmac | |
1817 | ||
1818 | @node Values in Registers | |
1819 | @subsection How Values Fit in Registers | |
1820 | ||
1821 | This section discusses the macros that describe which kinds of values | |
1822 | (specifically, which machine modes) each register can hold, and how many | |
1823 | consecutive registers are needed for a given mode. | |
1824 | ||
c43f4279 | 1825 | @hook TARGET_HARD_REGNO_NREGS |
38f8b050 JR |
1826 | |
1827 | @defmac HARD_REGNO_NREGS_HAS_PADDING (@var{regno}, @var{mode}) | |
1828 | A C expression that is nonzero if a value of mode @var{mode}, stored | |
1829 | in memory, ends with padding that causes it to take up more space than | |
1830 | in registers starting at register number @var{regno} (as determined by | |
1831 | multiplying GCC's notion of the size of the register when containing | |
1832 | this mode by the number of registers returned by | |
c43f4279 | 1833 | @code{TARGET_HARD_REGNO_NREGS}). By default this is zero. |
38f8b050 JR |
1834 | |
1835 | For example, if a floating-point value is stored in three 32-bit | |
1836 | registers but takes up 128 bits in memory, then this would be | |
1837 | nonzero. | |
1838 | ||
1839 | This macros only needs to be defined if there are cases where | |
1840 | @code{subreg_get_info} | |
1841 | would otherwise wrongly determine that a @code{subreg} can be | |
1842 | represented by an offset to the register number, when in fact such a | |
1843 | @code{subreg} would contain some of the padding not stored in | |
1844 | registers and so not be representable. | |
1845 | @end defmac | |
1846 | ||
1847 | @defmac HARD_REGNO_NREGS_WITH_PADDING (@var{regno}, @var{mode}) | |
1848 | For values of @var{regno} and @var{mode} for which | |
1849 | @code{HARD_REGNO_NREGS_HAS_PADDING} returns nonzero, a C expression | |
1850 | returning the greater number of registers required to hold the value | |
1851 | including any padding. In the example above, the value would be four. | |
1852 | @end defmac | |
1853 | ||
1854 | @defmac REGMODE_NATURAL_SIZE (@var{mode}) | |
1855 | Define this macro if the natural size of registers that hold values | |
1856 | of mode @var{mode} is not the word size. It is a C expression that | |
1857 | should give the natural size in bytes for the specified mode. It is | |
1858 | used by the register allocator to try to optimize its results. This | |
1859 | happens for example on SPARC 64-bit where the natural size of | |
1860 | floating-point registers is still 32-bit. | |
1861 | @end defmac | |
1862 | ||
f939c3e6 | 1863 | @hook TARGET_HARD_REGNO_MODE_OK |
38f8b050 JR |
1864 | |
1865 | @defmac HARD_REGNO_RENAME_OK (@var{from}, @var{to}) | |
1866 | A C expression that is nonzero if it is OK to rename a hard register | |
1867 | @var{from} to another hard register @var{to}. | |
1868 | ||
1869 | One common use of this macro is to prevent renaming of a register to | |
1870 | another register that is not saved by a prologue in an interrupt | |
1871 | handler. | |
1872 | ||
1873 | The default is always nonzero. | |
1874 | @end defmac | |
1875 | ||
99e1629f | 1876 | @hook TARGET_MODES_TIEABLE_P |
38f8b050 JR |
1877 | |
1878 | @hook TARGET_HARD_REGNO_SCRATCH_OK | |
38f8b050 JR |
1879 | |
1880 | @defmac AVOID_CCMODE_COPIES | |
1881 | Define this macro if the compiler should avoid copies to/from @code{CCmode} | |
1882 | registers. You should only define this macro if support for copying to/from | |
1883 | @code{CCmode} is incomplete. | |
1884 | @end defmac | |
1885 | ||
1886 | @node Leaf Functions | |
1887 | @subsection Handling Leaf Functions | |
1888 | ||
1889 | @cindex leaf functions | |
1890 | @cindex functions, leaf | |
1891 | On some machines, a leaf function (i.e., one which makes no calls) can run | |
1892 | more efficiently if it does not make its own register window. Often this | |
1893 | means it is required to receive its arguments in the registers where they | |
1894 | are passed by the caller, instead of the registers where they would | |
1895 | normally arrive. | |
1896 | ||
1897 | The special treatment for leaf functions generally applies only when | |
1898 | other conditions are met; for example, often they may use only those | |
1899 | registers for its own variables and temporaries. We use the term ``leaf | |
1900 | function'' to mean a function that is suitable for this special | |
1901 | handling, so that functions with no calls are not necessarily ``leaf | |
1902 | functions''. | |
1903 | ||
1904 | GCC assigns register numbers before it knows whether the function is | |
1905 | suitable for leaf function treatment. So it needs to renumber the | |
1906 | registers in order to output a leaf function. The following macros | |
1907 | accomplish this. | |
1908 | ||
1909 | @defmac LEAF_REGISTERS | |
1910 | Name of a char vector, indexed by hard register number, which | |
1911 | contains 1 for a register that is allowable in a candidate for leaf | |
1912 | function treatment. | |
1913 | ||
1914 | If leaf function treatment involves renumbering the registers, then the | |
1915 | registers marked here should be the ones before renumbering---those that | |
1916 | GCC would ordinarily allocate. The registers which will actually be | |
1917 | used in the assembler code, after renumbering, should not be marked with 1 | |
1918 | in this vector. | |
1919 | ||
1920 | Define this macro only if the target machine offers a way to optimize | |
1921 | the treatment of leaf functions. | |
1922 | @end defmac | |
1923 | ||
1924 | @defmac LEAF_REG_REMAP (@var{regno}) | |
1925 | A C expression whose value is the register number to which @var{regno} | |
1926 | should be renumbered, when a function is treated as a leaf function. | |
1927 | ||
1928 | If @var{regno} is a register number which should not appear in a leaf | |
1929 | function before renumbering, then the expression should yield @minus{}1, which | |
1930 | will cause the compiler to abort. | |
1931 | ||
1932 | Define this macro only if the target machine offers a way to optimize the | |
1933 | treatment of leaf functions, and registers need to be renumbered to do | |
1934 | this. | |
1935 | @end defmac | |
1936 | ||
1937 | @findex current_function_is_leaf | |
1938 | @findex current_function_uses_only_leaf_regs | |
1939 | @code{TARGET_ASM_FUNCTION_PROLOGUE} and | |
1940 | @code{TARGET_ASM_FUNCTION_EPILOGUE} must usually treat leaf functions | |
1941 | specially. They can test the C variable @code{current_function_is_leaf} | |
1942 | which is nonzero for leaf functions. @code{current_function_is_leaf} is | |
1943 | set prior to local register allocation and is valid for the remaining | |
1944 | compiler passes. They can also test the C variable | |
1945 | @code{current_function_uses_only_leaf_regs} which is nonzero for leaf | |
1946 | functions which only use leaf registers. | |
1947 | @code{current_function_uses_only_leaf_regs} is valid after all passes | |
1948 | that modify the instructions have been run and is only useful if | |
1949 | @code{LEAF_REGISTERS} is defined. | |
1950 | @c changed this to fix overfull. ALSO: why the "it" at the beginning | |
1951 | @c of the next paragraph?! --mew 2feb93 | |
1952 | ||
1953 | @node Stack Registers | |
1954 | @subsection Registers That Form a Stack | |
1955 | ||
1956 | There are special features to handle computers where some of the | |
1957 | ``registers'' form a stack. Stack registers are normally written by | |
1958 | pushing onto the stack, and are numbered relative to the top of the | |
1959 | stack. | |
1960 | ||
1961 | Currently, GCC can only handle one group of stack-like registers, and | |
1962 | they must be consecutively numbered. Furthermore, the existing | |
1963 | support for stack-like registers is specific to the 80387 floating | |
1964 | point coprocessor. If you have a new architecture that uses | |
1965 | stack-like registers, you will need to do substantial work on | |
1966 | @file{reg-stack.c} and write your machine description to cooperate | |
1967 | with it, as well as defining these macros. | |
1968 | ||
1969 | @defmac STACK_REGS | |
1970 | Define this if the machine has any stack-like registers. | |
1971 | @end defmac | |
1972 | ||
1973 | @defmac STACK_REG_COVER_CLASS | |
1974 | This is a cover class containing the stack registers. Define this if | |
1975 | the machine has any stack-like registers. | |
1976 | @end defmac | |
1977 | ||
1978 | @defmac FIRST_STACK_REG | |
1979 | The number of the first stack-like register. This one is the top | |
1980 | of the stack. | |
1981 | @end defmac | |
1982 | ||
1983 | @defmac LAST_STACK_REG | |
1984 | The number of the last stack-like register. This one is the bottom of | |
1985 | the stack. | |
1986 | @end defmac | |
1987 | ||
1988 | @node Register Classes | |
1989 | @section Register Classes | |
1990 | @cindex register class definitions | |
1991 | @cindex class definitions, register | |
1992 | ||
1993 | On many machines, the numbered registers are not all equivalent. | |
1994 | For example, certain registers may not be allowed for indexed addressing; | |
1995 | certain registers may not be allowed in some instructions. These machine | |
1996 | restrictions are described to the compiler using @dfn{register classes}. | |
1997 | ||
1998 | You define a number of register classes, giving each one a name and saying | |
1999 | which of the registers belong to it. Then you can specify register classes | |
2000 | that are allowed as operands to particular instruction patterns. | |
2001 | ||
2002 | @findex ALL_REGS | |
2003 | @findex NO_REGS | |
2004 | In general, each register will belong to several classes. In fact, one | |
2005 | class must be named @code{ALL_REGS} and contain all the registers. Another | |
2006 | class must be named @code{NO_REGS} and contain no registers. Often the | |
2007 | union of two classes will be another class; however, this is not required. | |
2008 | ||
2009 | @findex GENERAL_REGS | |
2010 | One of the classes must be named @code{GENERAL_REGS}. There is nothing | |
2011 | terribly special about the name, but the operand constraint letters | |
2012 | @samp{r} and @samp{g} specify this class. If @code{GENERAL_REGS} is | |
2013 | the same as @code{ALL_REGS}, just define it as a macro which expands | |
2014 | to @code{ALL_REGS}. | |
2015 | ||
2016 | Order the classes so that if class @var{x} is contained in class @var{y} | |
2017 | then @var{x} has a lower class number than @var{y}. | |
2018 | ||
2019 | The way classes other than @code{GENERAL_REGS} are specified in operand | |
2020 | constraints is through machine-dependent operand constraint letters. | |
2021 | You can define such letters to correspond to various classes, then use | |
2022 | them in operand constraints. | |
2023 | ||
6049a4c8 HPN |
2024 | You must define the narrowest register classes for allocatable |
2025 | registers, so that each class either has no subclasses, or that for | |
2026 | some mode, the move cost between registers within the class is | |
2027 | cheaper than moving a register in the class to or from memory | |
2028 | (@pxref{Costs}). | |
2029 | ||
38f8b050 JR |
2030 | You should define a class for the union of two classes whenever some |
2031 | instruction allows both classes. For example, if an instruction allows | |
2032 | either a floating point (coprocessor) register or a general register for a | |
2033 | certain operand, you should define a class @code{FLOAT_OR_GENERAL_REGS} | |
b899fd78 JR |
2034 | which includes both of them. Otherwise you will get suboptimal code, |
2035 | or even internal compiler errors when reload cannot find a register in the | |
dd5a833e | 2036 | class computed via @code{reg_class_subunion}. |
38f8b050 JR |
2037 | |
2038 | You must also specify certain redundant information about the register | |
2039 | classes: for each class, which classes contain it and which ones are | |
2040 | contained in it; for each pair of classes, the largest class contained | |
2041 | in their union. | |
2042 | ||
2043 | When a value occupying several consecutive registers is expected in a | |
2044 | certain class, all the registers used must belong to that class. | |
2045 | Therefore, register classes cannot be used to enforce a requirement for | |
2046 | a register pair to start with an even-numbered register. The way to | |
f939c3e6 | 2047 | specify this requirement is with @code{TARGET_HARD_REGNO_MODE_OK}. |
38f8b050 JR |
2048 | |
2049 | Register classes used for input-operands of bitwise-and or shift | |
2050 | instructions have a special requirement: each such class must have, for | |
2051 | each fixed-point machine mode, a subclass whose registers can transfer that | |
2052 | mode to or from memory. For example, on some machines, the operations for | |
2053 | single-byte values (@code{QImode}) are limited to certain registers. When | |
2054 | this is so, each register class that is used in a bitwise-and or shift | |
2055 | instruction must have a subclass consisting of registers from which | |
2056 | single-byte values can be loaded or stored. This is so that | |
2057 | @code{PREFERRED_RELOAD_CLASS} can always have a possible value to return. | |
2058 | ||
2059 | @deftp {Data type} {enum reg_class} | |
2060 | An enumerated type that must be defined with all the register class names | |
2061 | as enumerated values. @code{NO_REGS} must be first. @code{ALL_REGS} | |
2062 | must be the last register class, followed by one more enumerated value, | |
2063 | @code{LIM_REG_CLASSES}, which is not a register class but rather | |
2064 | tells how many classes there are. | |
2065 | ||
2066 | Each register class has a number, which is the value of casting | |
2067 | the class name to type @code{int}. The number serves as an index | |
2068 | in many of the tables described below. | |
2069 | @end deftp | |
2070 | ||
2071 | @defmac N_REG_CLASSES | |
2072 | The number of distinct register classes, defined as follows: | |
2073 | ||
2074 | @smallexample | |
2075 | #define N_REG_CLASSES (int) LIM_REG_CLASSES | |
2076 | @end smallexample | |
2077 | @end defmac | |
2078 | ||
2079 | @defmac REG_CLASS_NAMES | |
2080 | An initializer containing the names of the register classes as C string | |
2081 | constants. These names are used in writing some of the debugging dumps. | |
2082 | @end defmac | |
2083 | ||
2084 | @defmac REG_CLASS_CONTENTS | |
2085 | An initializer containing the contents of the register classes, as integers | |
2086 | which are bit masks. The @var{n}th integer specifies the contents of class | |
2087 | @var{n}. The way the integer @var{mask} is interpreted is that | |
2088 | register @var{r} is in the class if @code{@var{mask} & (1 << @var{r})} is 1. | |
2089 | ||
2090 | When the machine has more than 32 registers, an integer does not suffice. | |
2091 | Then the integers are replaced by sub-initializers, braced groupings containing | |
2092 | several integers. Each sub-initializer must be suitable as an initializer | |
2093 | for the type @code{HARD_REG_SET} which is defined in @file{hard-reg-set.h}. | |
2094 | In this situation, the first integer in each sub-initializer corresponds to | |
2095 | registers 0 through 31, the second integer to registers 32 through 63, and | |
2096 | so on. | |
2097 | @end defmac | |
2098 | ||
2099 | @defmac REGNO_REG_CLASS (@var{regno}) | |
2100 | A C expression whose value is a register class containing hard register | |
2101 | @var{regno}. In general there is more than one such class; choose a class | |
2102 | which is @dfn{minimal}, meaning that no smaller class also contains the | |
2103 | register. | |
2104 | @end defmac | |
2105 | ||
2106 | @defmac BASE_REG_CLASS | |
2107 | A macro whose definition is the name of the class to which a valid | |
2108 | base register must belong. A base register is one used in an address | |
2109 | which is the register value plus a displacement. | |
2110 | @end defmac | |
2111 | ||
2112 | @defmac MODE_BASE_REG_CLASS (@var{mode}) | |
2113 | This is a variation of the @code{BASE_REG_CLASS} macro which allows | |
2114 | the selection of a base register in a mode dependent manner. If | |
2115 | @var{mode} is VOIDmode then it should return the same value as | |
2116 | @code{BASE_REG_CLASS}. | |
2117 | @end defmac | |
2118 | ||
2119 | @defmac MODE_BASE_REG_REG_CLASS (@var{mode}) | |
2120 | A C expression whose value is the register class to which a valid | |
2121 | base register must belong in order to be used in a base plus index | |
2122 | register address. You should define this macro if base plus index | |
2123 | addresses have different requirements than other base register uses. | |
2124 | @end defmac | |
2125 | ||
86fc3d06 | 2126 | @defmac MODE_CODE_BASE_REG_CLASS (@var{mode}, @var{address_space}, @var{outer_code}, @var{index_code}) |
38f8b050 | 2127 | A C expression whose value is the register class to which a valid |
86fc3d06 UW |
2128 | base register for a memory reference in mode @var{mode} to address |
2129 | space @var{address_space} must belong. @var{outer_code} and @var{index_code} | |
2130 | define the context in which the base register occurs. @var{outer_code} is | |
2131 | the code of the immediately enclosing expression (@code{MEM} for the top level | |
2132 | of an address, @code{ADDRESS} for something that occurs in an | |
38f8b050 JR |
2133 | @code{address_operand}). @var{index_code} is the code of the corresponding |
2134 | index expression if @var{outer_code} is @code{PLUS}; @code{SCRATCH} otherwise. | |
2135 | @end defmac | |
2136 | ||
2137 | @defmac INDEX_REG_CLASS | |
2138 | A macro whose definition is the name of the class to which a valid | |
2139 | index register must belong. An index register is one used in an | |
2140 | address where its value is either multiplied by a scale factor or | |
2141 | added to another register (as well as added to a displacement). | |
2142 | @end defmac | |
2143 | ||
2144 | @defmac REGNO_OK_FOR_BASE_P (@var{num}) | |
2145 | A C expression which is nonzero if register number @var{num} is | |
2146 | suitable for use as a base register in operand addresses. | |
38f8b050 JR |
2147 | @end defmac |
2148 | ||
2149 | @defmac REGNO_MODE_OK_FOR_BASE_P (@var{num}, @var{mode}) | |
2150 | A C expression that is just like @code{REGNO_OK_FOR_BASE_P}, except that | |
2151 | that expression may examine the mode of the memory reference in | |
2152 | @var{mode}. You should define this macro if the mode of the memory | |
2153 | reference affects whether a register may be used as a base register. If | |
2154 | you define this macro, the compiler will use it instead of | |
2155 | @code{REGNO_OK_FOR_BASE_P}. The mode may be @code{VOIDmode} for | |
2156 | addresses that appear outside a @code{MEM}, i.e., as an | |
2157 | @code{address_operand}. | |
38f8b050 JR |
2158 | @end defmac |
2159 | ||
2160 | @defmac REGNO_MODE_OK_FOR_REG_BASE_P (@var{num}, @var{mode}) | |
2161 | A C expression which is nonzero if register number @var{num} is suitable for | |
2162 | use as a base register in base plus index operand addresses, accessing | |
2163 | memory in mode @var{mode}. It may be either a suitable hard register or a | |
2164 | pseudo register that has been allocated such a hard register. You should | |
2165 | define this macro if base plus index addresses have different requirements | |
2166 | than other base register uses. | |
2167 | ||
2168 | Use of this macro is deprecated; please use the more general | |
2169 | @code{REGNO_MODE_CODE_OK_FOR_BASE_P}. | |
38f8b050 JR |
2170 | @end defmac |
2171 | ||
86fc3d06 UW |
2172 | @defmac REGNO_MODE_CODE_OK_FOR_BASE_P (@var{num}, @var{mode}, @var{address_space}, @var{outer_code}, @var{index_code}) |
2173 | A C expression which is nonzero if register number @var{num} is | |
2174 | suitable for use as a base register in operand addresses, accessing | |
2175 | memory in mode @var{mode} in address space @var{address_space}. | |
2176 | This is similar to @code{REGNO_MODE_OK_FOR_BASE_P}, except | |
38f8b050 JR |
2177 | that that expression may examine the context in which the register |
2178 | appears in the memory reference. @var{outer_code} is the code of the | |
2179 | immediately enclosing expression (@code{MEM} if at the top level of the | |
2180 | address, @code{ADDRESS} for something that occurs in an | |
2181 | @code{address_operand}). @var{index_code} is the code of the | |
2182 | corresponding index expression if @var{outer_code} is @code{PLUS}; | |
2183 | @code{SCRATCH} otherwise. The mode may be @code{VOIDmode} for addresses | |
2184 | that appear outside a @code{MEM}, i.e., as an @code{address_operand}. | |
38f8b050 JR |
2185 | @end defmac |
2186 | ||
2187 | @defmac REGNO_OK_FOR_INDEX_P (@var{num}) | |
2188 | A C expression which is nonzero if register number @var{num} is | |
2189 | suitable for use as an index register in operand addresses. It may be | |
2190 | either a suitable hard register or a pseudo register that has been | |
2191 | allocated such a hard register. | |
2192 | ||
2193 | The difference between an index register and a base register is that | |
2194 | the index register may be scaled. If an address involves the sum of | |
2195 | two registers, neither one of them scaled, then either one may be | |
2196 | labeled the ``base'' and the other the ``index''; but whichever | |
2197 | labeling is used must fit the machine's constraints of which registers | |
2198 | may serve in each capacity. The compiler will try both labelings, | |
2199 | looking for one that is valid, and will reload one or both registers | |
2200 | only if neither labeling works. | |
38f8b050 JR |
2201 | @end defmac |
2202 | ||
5f286f4a YQ |
2203 | @hook TARGET_PREFERRED_RENAME_CLASS |
2204 | ||
fba42e24 | 2205 | @hook TARGET_PREFERRED_RELOAD_CLASS |
fba42e24 | 2206 | |
38f8b050 JR |
2207 | @defmac PREFERRED_RELOAD_CLASS (@var{x}, @var{class}) |
2208 | A C expression that places additional restrictions on the register class | |
2209 | to use when it is necessary to copy value @var{x} into a register in class | |
2210 | @var{class}. The value is a register class; perhaps @var{class}, or perhaps | |
2211 | another, smaller class. On many machines, the following definition is | |
2212 | safe: | |
2213 | ||
2214 | @smallexample | |
2215 | #define PREFERRED_RELOAD_CLASS(X,CLASS) CLASS | |
2216 | @end smallexample | |
2217 | ||
2218 | Sometimes returning a more restrictive class makes better code. For | |
2219 | example, on the 68000, when @var{x} is an integer constant that is in range | |
2220 | for a @samp{moveq} instruction, the value of this macro is always | |
2221 | @code{DATA_REGS} as long as @var{class} includes the data registers. | |
2222 | Requiring a data register guarantees that a @samp{moveq} will be used. | |
2223 | ||
2224 | One case where @code{PREFERRED_RELOAD_CLASS} must not return | |
2225 | @var{class} is if @var{x} is a legitimate constant which cannot be | |
2226 | loaded into some register class. By returning @code{NO_REGS} you can | |
2227 | force @var{x} into a memory location. For example, rs6000 can load | |
2228 | immediate values into general-purpose registers, but does not have an | |
2229 | instruction for loading an immediate value into a floating-point | |
2230 | register, so @code{PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when | |
fd250f0d | 2231 | @var{x} is a floating-point constant. If the constant cannot be loaded |
38f8b050 | 2232 | into any kind of register, code generation will be better if |
1a627b35 RS |
2233 | @code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead |
2234 | of using @code{TARGET_PREFERRED_RELOAD_CLASS}. | |
38f8b050 JR |
2235 | |
2236 | If an insn has pseudos in it after register allocation, reload will go | |
2237 | through the alternatives and call repeatedly @code{PREFERRED_RELOAD_CLASS} | |
2238 | to find the best one. Returning @code{NO_REGS}, in this case, makes | |
2239 | reload add a @code{!} in front of the constraint: the x86 back-end uses | |
2240 | this feature to discourage usage of 387 registers when math is done in | |
2241 | the SSE registers (and vice versa). | |
2242 | @end defmac | |
2243 | ||
abd26bfb | 2244 | @hook TARGET_PREFERRED_OUTPUT_RELOAD_CLASS |
abd26bfb | 2245 | |
38f8b050 JR |
2246 | @defmac LIMIT_RELOAD_CLASS (@var{mode}, @var{class}) |
2247 | A C expression that places additional restrictions on the register class | |
2248 | to use when it is necessary to be able to hold a value of mode | |
2249 | @var{mode} in a reload register for which class @var{class} would | |
2250 | ordinarily be used. | |
2251 | ||
2252 | Unlike @code{PREFERRED_RELOAD_CLASS}, this macro should be used when | |
fd250f0d | 2253 | there are certain modes that simply cannot go in certain reload classes. |
38f8b050 JR |
2254 | |
2255 | The value is a register class; perhaps @var{class}, or perhaps another, | |
2256 | smaller class. | |
2257 | ||
2258 | Don't define this macro unless the target machine has limitations which | |
2259 | require the macro to do something nontrivial. | |
2260 | @end defmac | |
2261 | ||
2262 | @hook TARGET_SECONDARY_RELOAD | |
38f8b050 JR |
2263 | |
2264 | @defmac SECONDARY_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
2265 | @defmacx SECONDARY_INPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
2266 | @defmacx SECONDARY_OUTPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
2267 | These macros are obsolete, new ports should use the target hook | |
2268 | @code{TARGET_SECONDARY_RELOAD} instead. | |
2269 | ||
2270 | These are obsolete macros, replaced by the @code{TARGET_SECONDARY_RELOAD} | |
2271 | target hook. Older ports still define these macros to indicate to the | |
2272 | reload phase that it may | |
2273 | need to allocate at least one register for a reload in addition to the | |
2274 | register to contain the data. Specifically, if copying @var{x} to a | |
2275 | register @var{class} in @var{mode} requires an intermediate register, | |
2276 | you were supposed to define @code{SECONDARY_INPUT_RELOAD_CLASS} to return the | |
2277 | largest register class all of whose registers can be used as | |
2278 | intermediate registers or scratch registers. | |
2279 | ||
2280 | If copying a register @var{class} in @var{mode} to @var{x} requires an | |
2281 | intermediate or scratch register, @code{SECONDARY_OUTPUT_RELOAD_CLASS} | |
2282 | was supposed to be defined be defined to return the largest register | |
2283 | class required. If the | |
2284 | requirements for input and output reloads were the same, the macro | |
2285 | @code{SECONDARY_RELOAD_CLASS} should have been used instead of defining both | |
2286 | macros identically. | |
2287 | ||
2288 | The values returned by these macros are often @code{GENERAL_REGS}. | |
2289 | Return @code{NO_REGS} if no spare register is needed; i.e., if @var{x} | |
2290 | can be directly copied to or from a register of @var{class} in | |
2291 | @var{mode} without requiring a scratch register. Do not define this | |
2292 | macro if it would always return @code{NO_REGS}. | |
2293 | ||
2294 | If a scratch register is required (either with or without an | |
2295 | intermediate register), you were supposed to define patterns for | |
2296 | @samp{reload_in@var{m}} or @samp{reload_out@var{m}}, as required | |
2297 | (@pxref{Standard Names}. These patterns, which were normally | |
2298 | implemented with a @code{define_expand}, should be similar to the | |
2299 | @samp{mov@var{m}} patterns, except that operand 2 is the scratch | |
2300 | register. | |
2301 | ||
2302 | These patterns need constraints for the reload register and scratch | |
2303 | register that | |
2304 | contain a single register class. If the original reload register (whose | |
2305 | class is @var{class}) can meet the constraint given in the pattern, the | |
2306 | value returned by these macros is used for the class of the scratch | |
2307 | register. Otherwise, two additional reload registers are required. | |
2308 | Their classes are obtained from the constraints in the insn pattern. | |
2309 | ||
2310 | @var{x} might be a pseudo-register or a @code{subreg} of a | |
2311 | pseudo-register, which could either be in a hard register or in memory. | |
2312 | Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is | |
2313 | in memory and the hard register number if it is in a register. | |
2314 | ||
2315 | These macros should not be used in the case where a particular class of | |
2316 | registers can only be copied to memory and not to another class of | |
2317 | registers. In that case, secondary reload registers are not needed and | |
2318 | would not be helpful. Instead, a stack location must be used to perform | |
2319 | the copy and the @code{mov@var{m}} pattern should use memory as an | |
2320 | intermediate storage. This case often occurs between floating-point and | |
2321 | general registers. | |
2322 | @end defmac | |
2323 | ||
f15643d4 | 2324 | @hook TARGET_SECONDARY_MEMORY_NEEDED |
38f8b050 JR |
2325 | |
2326 | @defmac SECONDARY_MEMORY_NEEDED_RTX (@var{mode}) | |
f15643d4 | 2327 | Normally when @code{TARGET_SECONDARY_MEMORY_NEEDED} is defined, the compiler |
38f8b050 JR |
2328 | allocates a stack slot for a memory location needed for register copies. |
2329 | If this macro is defined, the compiler instead uses the memory location | |
2330 | defined by this macro. | |
2331 | ||
2332 | Do not define this macro if you do not define | |
f15643d4 | 2333 | @code{TARGET_SECONDARY_MEMORY_NEEDED}. |
38f8b050 JR |
2334 | @end defmac |
2335 | ||
94e23f53 | 2336 | @hook TARGET_SECONDARY_MEMORY_NEEDED_MODE |
38f8b050 | 2337 | |
5cce8171 RS |
2338 | @hook TARGET_SELECT_EARLY_REMAT_MODES |
2339 | ||
07b8f0a8 | 2340 | @hook TARGET_CLASS_LIKELY_SPILLED_P |
a8c44c52 AS |
2341 | |
2342 | @hook TARGET_CLASS_MAX_NREGS | |
07b8f0a8 | 2343 | |
38f8b050 JR |
2344 | @defmac CLASS_MAX_NREGS (@var{class}, @var{mode}) |
2345 | A C expression for the maximum number of consecutive registers | |
2346 | of class @var{class} needed to hold a value of mode @var{mode}. | |
2347 | ||
c43f4279 | 2348 | This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}. In fact, |
38f8b050 | 2349 | the value of the macro @code{CLASS_MAX_NREGS (@var{class}, @var{mode})} |
c43f4279 | 2350 | should be the maximum value of @code{TARGET_HARD_REGNO_NREGS (@var{regno}, |
38f8b050 JR |
2351 | @var{mode})} for all @var{regno} values in the class @var{class}. |
2352 | ||
2353 | This macro helps control the handling of multiple-word values | |
2354 | in the reload pass. | |
2355 | @end defmac | |
2356 | ||
0d803030 | 2357 | @hook TARGET_CAN_CHANGE_MODE_CLASS |
38f8b050 | 2358 | |
5074a1f8 VM |
2359 | @hook TARGET_IRA_CHANGE_PSEUDO_ALLOCNO_CLASS |
2360 | ||
55a2c322 VM |
2361 | @hook TARGET_LRA_P |
2362 | ||
2363 | @hook TARGET_REGISTER_PRIORITY | |
2364 | ||
3b9ceb4b VM |
2365 | @hook TARGET_REGISTER_USAGE_LEVELING_P |
2366 | ||
55a2c322 VM |
2367 | @hook TARGET_DIFFERENT_ADDR_DISPLACEMENT_P |
2368 | ||
d6220b11 KK |
2369 | @hook TARGET_CANNOT_SUBSTITUTE_MEM_EQUIV_P |
2370 | ||
14133a4d KK |
2371 | @hook TARGET_LEGITIMIZE_ADDRESS_DISPLACEMENT |
2372 | ||
55a2c322 VM |
2373 | @hook TARGET_SPILL_CLASS |
2374 | ||
e93f30a6 VM |
2375 | @hook TARGET_ADDITIONAL_ALLOCNO_CLASS_P |
2376 | ||
42e37616 DM |
2377 | @hook TARGET_CSTORE_MODE |
2378 | ||
b4ff394c PH |
2379 | @hook TARGET_COMPUTE_PRESSURE_CLASSES |
2380 | ||
38f8b050 JR |
2381 | @node Stack and Calling |
2382 | @section Stack Layout and Calling Conventions | |
2383 | @cindex calling conventions | |
2384 | ||
2385 | @c prevent bad page break with this line | |
2386 | This describes the stack layout and calling conventions. | |
2387 | ||
2388 | @menu | |
2389 | * Frame Layout:: | |
2390 | * Exception Handling:: | |
2391 | * Stack Checking:: | |
2392 | * Frame Registers:: | |
2393 | * Elimination:: | |
2394 | * Stack Arguments:: | |
2395 | * Register Arguments:: | |
2396 | * Scalar Return:: | |
2397 | * Aggregate Return:: | |
2398 | * Caller Saves:: | |
2399 | * Function Entry:: | |
2400 | * Profiling:: | |
2401 | * Tail Calls:: | |
20a6ece0 | 2402 | * Shrink-wrapping separate components:: |
38f8b050 | 2403 | * Stack Smashing Protection:: |
aaeaa9a9 | 2404 | * Miscellaneous Register Hooks:: |
38f8b050 JR |
2405 | @end menu |
2406 | ||
2407 | @node Frame Layout | |
2408 | @subsection Basic Stack Layout | |
2409 | @cindex stack frame layout | |
2410 | @cindex frame layout | |
2411 | ||
2412 | @c prevent bad page break with this line | |
2413 | Here is the basic stack layout. | |
2414 | ||
2415 | @defmac STACK_GROWS_DOWNWARD | |
62f9f30b TS |
2416 | Define this macro to be true if pushing a word onto the stack moves the stack |
2417 | pointer to a smaller address, and false otherwise. | |
38f8b050 JR |
2418 | @end defmac |
2419 | ||
2420 | @defmac STACK_PUSH_CODE | |
2421 | This macro defines the operation used when something is pushed | |
2422 | on the stack. In RTL, a push operation will be | |
2423 | @code{(set (mem (STACK_PUSH_CODE (reg sp))) @dots{})} | |
2424 | ||
2425 | The choices are @code{PRE_DEC}, @code{POST_DEC}, @code{PRE_INC}, | |
2426 | and @code{POST_INC}. Which of these is correct depends on | |
2427 | the stack direction and on whether the stack pointer points | |
2428 | to the last item on the stack or whether it points to the | |
2429 | space for the next item on the stack. | |
2430 | ||
2431 | The default is @code{PRE_DEC} when @code{STACK_GROWS_DOWNWARD} is | |
62f9f30b | 2432 | true, which is almost always right, and @code{PRE_INC} otherwise, |
38f8b050 JR |
2433 | which is often wrong. |
2434 | @end defmac | |
2435 | ||
2436 | @defmac FRAME_GROWS_DOWNWARD | |
2437 | Define this macro to nonzero value if the addresses of local variable slots | |
2438 | are at negative offsets from the frame pointer. | |
2439 | @end defmac | |
2440 | ||
2441 | @defmac ARGS_GROW_DOWNWARD | |
2442 | Define this macro if successive arguments to a function occupy decreasing | |
2443 | addresses on the stack. | |
2444 | @end defmac | |
2445 | ||
2a31c321 | 2446 | @hook TARGET_STARTING_FRAME_OFFSET |
38f8b050 JR |
2447 | |
2448 | @defmac STACK_ALIGNMENT_NEEDED | |
2449 | Define to zero to disable final alignment of the stack during reload. | |
2450 | The nonzero default for this macro is suitable for most ports. | |
2451 | ||
2a31c321 | 2452 | On ports where @code{TARGET_STARTING_FRAME_OFFSET} is nonzero or where there |
38f8b050 JR |
2453 | is a register save block following the local block that doesn't require |
2454 | alignment to @code{STACK_BOUNDARY}, it may be beneficial to disable | |
2455 | stack alignment and do it in the backend. | |
2456 | @end defmac | |
2457 | ||
2458 | @defmac STACK_POINTER_OFFSET | |
2459 | Offset from the stack pointer register to the first location at which | |
2460 | outgoing arguments are placed. If not specified, the default value of | |
2461 | zero is used. This is the proper value for most machines. | |
2462 | ||
2463 | If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above | |
2464 | the first location at which outgoing arguments are placed. | |
2465 | @end defmac | |
2466 | ||
2467 | @defmac FIRST_PARM_OFFSET (@var{fundecl}) | |
2468 | Offset from the argument pointer register to the first argument's | |
2469 | address. On some machines it may depend on the data type of the | |
2470 | function. | |
2471 | ||
2472 | If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above | |
2473 | the first argument's address. | |
2474 | @end defmac | |
2475 | ||
2476 | @defmac STACK_DYNAMIC_OFFSET (@var{fundecl}) | |
2477 | Offset from the stack pointer register to an item dynamically allocated | |
2478 | on the stack, e.g., by @code{alloca}. | |
2479 | ||
2480 | The default value for this macro is @code{STACK_POINTER_OFFSET} plus the | |
2481 | length of the outgoing arguments. The default is correct for most | |
2482 | machines. See @file{function.c} for details. | |
2483 | @end defmac | |
2484 | ||
2485 | @defmac INITIAL_FRAME_ADDRESS_RTX | |
2486 | A C expression whose value is RTL representing the address of the initial | |
2487 | stack frame. This address is passed to @code{RETURN_ADDR_RTX} and | |
2488 | @code{DYNAMIC_CHAIN_ADDRESS}. If you don't define this macro, a reasonable | |
2489 | default value will be used. Define this macro in order to make frame pointer | |
2490 | elimination work in the presence of @code{__builtin_frame_address (count)} and | |
2491 | @code{__builtin_return_address (count)} for @code{count} not equal to zero. | |
2492 | @end defmac | |
2493 | ||
2494 | @defmac DYNAMIC_CHAIN_ADDRESS (@var{frameaddr}) | |
2495 | A C expression whose value is RTL representing the address in a stack | |
2496 | frame where the pointer to the caller's frame is stored. Assume that | |
2497 | @var{frameaddr} is an RTL expression for the address of the stack frame | |
2498 | itself. | |
2499 | ||
2500 | If you don't define this macro, the default is to return the value | |
2501 | of @var{frameaddr}---that is, the stack frame address is also the | |
2502 | address of the stack word that points to the previous frame. | |
2503 | @end defmac | |
2504 | ||
2505 | @defmac SETUP_FRAME_ADDRESSES | |
baf37960 | 2506 | A C expression that produces the machine-specific code to |
38f8b050 JR |
2507 | setup the stack so that arbitrary frames can be accessed. For example, |
2508 | on the SPARC, we must flush all of the register windows to the stack | |
2509 | before we can access arbitrary stack frames. You will seldom need to | |
baf37960 | 2510 | define this macro. The default is to do nothing. |
38f8b050 JR |
2511 | @end defmac |
2512 | ||
2513 | @hook TARGET_BUILTIN_SETJMP_FRAME_VALUE | |
38f8b050 JR |
2514 | |
2515 | @defmac FRAME_ADDR_RTX (@var{frameaddr}) | |
2516 | A C expression whose value is RTL representing the value of the frame | |
2517 | address for the current frame. @var{frameaddr} is the frame pointer | |
2518 | of the current frame. This is used for __builtin_frame_address. | |
2519 | You need only define this macro if the frame address is not the same | |
2520 | as the frame pointer. Most machines do not need to define it. | |
2521 | @end defmac | |
2522 | ||
2523 | @defmac RETURN_ADDR_RTX (@var{count}, @var{frameaddr}) | |
2524 | A C expression whose value is RTL representing the value of the return | |
2525 | address for the frame @var{count} steps up from the current frame, after | |
2526 | the prologue. @var{frameaddr} is the frame pointer of the @var{count} | |
2527 | frame, or the frame pointer of the @var{count} @minus{} 1 frame if | |
2e612c47 | 2528 | @code{RETURN_ADDR_IN_PREVIOUS_FRAME} is nonzero. |
38f8b050 JR |
2529 | |
2530 | The value of the expression must always be the correct address when | |
2531 | @var{count} is zero, but may be @code{NULL_RTX} if there is no way to | |
2532 | determine the return address of other frames. | |
2533 | @end defmac | |
2534 | ||
2535 | @defmac RETURN_ADDR_IN_PREVIOUS_FRAME | |
2e612c47 MF |
2536 | Define this macro to nonzero value if the return address of a particular |
2537 | stack frame is accessed from the frame pointer of the previous stack | |
2538 | frame. The zero default for this macro is suitable for most ports. | |
38f8b050 JR |
2539 | @end defmac |
2540 | ||
2541 | @defmac INCOMING_RETURN_ADDR_RTX | |
2542 | A C expression whose value is RTL representing the location of the | |
2543 | incoming return address at the beginning of any function, before the | |
2544 | prologue. This RTL is either a @code{REG}, indicating that the return | |
2545 | value is saved in @samp{REG}, or a @code{MEM} representing a location in | |
2546 | the stack. | |
2547 | ||
2548 | You only need to define this macro if you want to support call frame | |
2549 | debugging information like that provided by DWARF 2. | |
2550 | ||
2551 | If this RTL is a @code{REG}, you should also define | |
2552 | @code{DWARF_FRAME_RETURN_COLUMN} to @code{DWARF_FRAME_REGNUM (REGNO)}. | |
2553 | @end defmac | |
2554 | ||
2555 | @defmac DWARF_ALT_FRAME_RETURN_COLUMN | |
2556 | A C expression whose value is an integer giving a DWARF 2 column | |
2557 | number that may be used as an alternative return column. The column | |
2558 | must not correspond to any gcc hard register (that is, it must not | |
2559 | be in the range of @code{DWARF_FRAME_REGNUM}). | |
2560 | ||
2561 | This macro can be useful if @code{DWARF_FRAME_RETURN_COLUMN} is set to a | |
2562 | general register, but an alternative column needs to be used for signal | |
2563 | frames. Some targets have also used different frame return columns | |
2564 | over time. | |
2565 | @end defmac | |
2566 | ||
2567 | @defmac DWARF_ZERO_REG | |
2568 | A C expression whose value is an integer giving a DWARF 2 register | |
2569 | number that is considered to always have the value zero. This should | |
2570 | only be defined if the target has an architected zero register, and | |
2571 | someone decided it was a good idea to use that register number to | |
2572 | terminate the stack backtrace. New ports should avoid this. | |
2573 | @end defmac | |
2574 | ||
2575 | @hook TARGET_DWARF_HANDLE_FRAME_UNSPEC | |
38f8b050 | 2576 | |
74c74aa0 RS |
2577 | @hook TARGET_DWARF_POLY_INDETERMINATE_VALUE |
2578 | ||
38f8b050 JR |
2579 | @defmac INCOMING_FRAME_SP_OFFSET |
2580 | A C expression whose value is an integer giving the offset, in bytes, | |
2581 | from the value of the stack pointer register to the top of the stack | |
2582 | frame at the beginning of any function, before the prologue. The top of | |
2583 | the frame is defined to be the value of the stack pointer in the | |
2584 | previous frame, just before the call instruction. | |
2585 | ||
2586 | You only need to define this macro if you want to support call frame | |
2587 | debugging information like that provided by DWARF 2. | |
2588 | @end defmac | |
2589 | ||
26fc730d JJ |
2590 | @defmac DEFAULT_INCOMING_FRAME_SP_OFFSET |
2591 | Like @code{INCOMING_FRAME_SP_OFFSET}, but must be the same for all | |
2592 | functions of the same ABI, and when using GAS @code{.cfi_*} directives | |
2593 | must also agree with the default CFI GAS emits. Define this macro | |
2594 | only if @code{INCOMING_FRAME_SP_OFFSET} can have different values | |
2595 | between different functions of the same ABI or when | |
2596 | @code{INCOMING_FRAME_SP_OFFSET} does not agree with GAS default CFI. | |
2597 | @end defmac | |
2598 | ||
38f8b050 JR |
2599 | @defmac ARG_POINTER_CFA_OFFSET (@var{fundecl}) |
2600 | A C expression whose value is an integer giving the offset, in bytes, | |
2601 | from the argument pointer to the canonical frame address (cfa). The | |
2602 | final value should coincide with that calculated by | |
2603 | @code{INCOMING_FRAME_SP_OFFSET}. Which is unfortunately not usable | |
2604 | during virtual register instantiation. | |
2605 | ||
2606 | The default value for this macro is | |
2607 | @code{FIRST_PARM_OFFSET (fundecl) + crtl->args.pretend_args_size}, | |
2608 | which is correct for most machines; in general, the arguments are found | |
2609 | immediately before the stack frame. Note that this is not the case on | |
2610 | some targets that save registers into the caller's frame, such as SPARC | |
2611 | and rs6000, and so such targets need to define this macro. | |
2612 | ||
2613 | You only need to define this macro if the default is incorrect, and you | |
2614 | want to support call frame debugging information like that provided by | |
2615 | DWARF 2. | |
2616 | @end defmac | |
2617 | ||
2618 | @defmac FRAME_POINTER_CFA_OFFSET (@var{fundecl}) | |
2619 | If defined, a C expression whose value is an integer giving the offset | |
2620 | in bytes from the frame pointer to the canonical frame address (cfa). | |
2621 | The final value should coincide with that calculated by | |
2622 | @code{INCOMING_FRAME_SP_OFFSET}. | |
2623 | ||
2624 | Normally the CFA is calculated as an offset from the argument pointer, | |
2625 | via @code{ARG_POINTER_CFA_OFFSET}, but if the argument pointer is | |
2626 | variable due to the ABI, this may not be possible. If this macro is | |
2627 | defined, it implies that the virtual register instantiation should be | |
2628 | based on the frame pointer instead of the argument pointer. Only one | |
2629 | of @code{FRAME_POINTER_CFA_OFFSET} and @code{ARG_POINTER_CFA_OFFSET} | |
2630 | should be defined. | |
2631 | @end defmac | |
2632 | ||
2633 | @defmac CFA_FRAME_BASE_OFFSET (@var{fundecl}) | |
2634 | If defined, a C expression whose value is an integer giving the offset | |
2635 | in bytes from the canonical frame address (cfa) to the frame base used | |
2636 | in DWARF 2 debug information. The default is zero. A different value | |
2637 | may reduce the size of debug information on some ports. | |
2638 | @end defmac | |
2639 | ||
2640 | @node Exception Handling | |
2641 | @subsection Exception Handling Support | |
2642 | @cindex exception handling | |
2643 | ||
2644 | @defmac EH_RETURN_DATA_REGNO (@var{N}) | |
2645 | A C expression whose value is the @var{N}th register number used for | |
2646 | data by exception handlers, or @code{INVALID_REGNUM} if fewer than | |
2647 | @var{N} registers are usable. | |
2648 | ||
2649 | The exception handling library routines communicate with the exception | |
2650 | handlers via a set of agreed upon registers. Ideally these registers | |
2651 | should be call-clobbered; it is possible to use call-saved registers, | |
2652 | but may negatively impact code size. The target must support at least | |
2653 | 2 data registers, but should define 4 if there are enough free registers. | |
2654 | ||
2655 | You must define this macro if you want to support call frame exception | |
2656 | handling like that provided by DWARF 2. | |
2657 | @end defmac | |
2658 | ||
2659 | @defmac EH_RETURN_STACKADJ_RTX | |
2660 | A C expression whose value is RTL representing a location in which | |
2661 | to store a stack adjustment to be applied before function return. | |
2662 | This is used to unwind the stack to an exception handler's call frame. | |
2663 | It will be assigned zero on code paths that return normally. | |
2664 | ||
2665 | Typically this is a call-clobbered hard register that is otherwise | |
2666 | untouched by the epilogue, but could also be a stack slot. | |
2667 | ||
2668 | Do not define this macro if the stack pointer is saved and restored | |
2669 | by the regular prolog and epilog code in the call frame itself; in | |
2670 | this case, the exception handling library routines will update the | |
2671 | stack location to be restored in place. Otherwise, you must define | |
2672 | this macro if you want to support call frame exception handling like | |
2673 | that provided by DWARF 2. | |
2674 | @end defmac | |
2675 | ||
2676 | @defmac EH_RETURN_HANDLER_RTX | |
2677 | A C expression whose value is RTL representing a location in which | |
2678 | to store the address of an exception handler to which we should | |
2679 | return. It will not be assigned on code paths that return normally. | |
2680 | ||
2681 | Typically this is the location in the call frame at which the normal | |
2682 | return address is stored. For targets that return by popping an | |
2683 | address off the stack, this might be a memory address just below | |
2684 | the @emph{target} call frame rather than inside the current call | |
2685 | frame. If defined, @code{EH_RETURN_STACKADJ_RTX} will have already | |
2686 | been assigned, so it may be used to calculate the location of the | |
2687 | target call frame. | |
2688 | ||
2689 | Some targets have more complex requirements than storing to an | |
2690 | address calculable during initial code generation. In that case | |
2691 | the @code{eh_return} instruction pattern should be used instead. | |
2692 | ||
2693 | If you want to support call frame exception handling, you must | |
2694 | define either this macro or the @code{eh_return} instruction pattern. | |
2695 | @end defmac | |
2696 | ||
2697 | @defmac RETURN_ADDR_OFFSET | |
2698 | If defined, an integer-valued C expression for which rtl will be generated | |
2699 | to add it to the exception handler address before it is searched in the | |
2700 | exception handling tables, and to subtract it again from the address before | |
2701 | using it to return to the exception handler. | |
2702 | @end defmac | |
2703 | ||
2704 | @defmac ASM_PREFERRED_EH_DATA_FORMAT (@var{code}, @var{global}) | |
2705 | This macro chooses the encoding of pointers embedded in the exception | |
2706 | handling sections. If at all possible, this should be defined such | |
2707 | that the exception handling section will not require dynamic relocations, | |
2708 | and so may be read-only. | |
2709 | ||
2710 | @var{code} is 0 for data, 1 for code labels, 2 for function pointers. | |
2711 | @var{global} is true if the symbol may be affected by dynamic relocations. | |
2712 | The macro should return a combination of the @code{DW_EH_PE_*} defines | |
2713 | as found in @file{dwarf2.h}. | |
2714 | ||
2715 | If this macro is not defined, pointers will not be encoded but | |
2716 | represented directly. | |
2717 | @end defmac | |
2718 | ||
2719 | @defmac ASM_MAYBE_OUTPUT_ENCODED_ADDR_RTX (@var{file}, @var{encoding}, @var{size}, @var{addr}, @var{done}) | |
2720 | This macro allows the target to emit whatever special magic is required | |
2721 | to represent the encoding chosen by @code{ASM_PREFERRED_EH_DATA_FORMAT}. | |
2722 | Generic code takes care of pc-relative and indirect encodings; this must | |
2723 | be defined if the target uses text-relative or data-relative encodings. | |
2724 | ||
2725 | This is a C statement that branches to @var{done} if the format was | |
2726 | handled. @var{encoding} is the format chosen, @var{size} is the number | |
2727 | of bytes that the format occupies, @var{addr} is the @code{SYMBOL_REF} | |
2728 | to be emitted. | |
2729 | @end defmac | |
2730 | ||
38f8b050 JR |
2731 | @defmac MD_FALLBACK_FRAME_STATE_FOR (@var{context}, @var{fs}) |
2732 | This macro allows the target to add CPU and operating system specific | |
2733 | code to the call-frame unwinder for use when there is no unwind data | |
2734 | available. The most common reason to implement this macro is to unwind | |
2735 | through signal frames. | |
2736 | ||
2737 | This macro is called from @code{uw_frame_state_for} in | |
2738 | @file{unwind-dw2.c}, @file{unwind-dw2-xtensa.c} and | |
2739 | @file{unwind-ia64.c}. @var{context} is an @code{_Unwind_Context}; | |
2740 | @var{fs} is an @code{_Unwind_FrameState}. Examine @code{context->ra} | |
2741 | for the address of the code being executed and @code{context->cfa} for | |
2742 | the stack pointer value. If the frame can be decoded, the register | |
2743 | save addresses should be updated in @var{fs} and the macro should | |
2744 | evaluate to @code{_URC_NO_REASON}. If the frame cannot be decoded, | |
2745 | the macro should evaluate to @code{_URC_END_OF_STACK}. | |
2746 | ||
2747 | For proper signal handling in Java this macro is accompanied by | |
2748 | @code{MAKE_THROW_FRAME}, defined in @file{libjava/include/*-signal.h} headers. | |
2749 | @end defmac | |
2750 | ||
2751 | @defmac MD_HANDLE_UNWABI (@var{context}, @var{fs}) | |
2752 | This macro allows the target to add operating system specific code to the | |
2753 | call-frame unwinder to handle the IA-64 @code{.unwabi} unwinding directive, | |
2754 | usually used for signal or interrupt frames. | |
2755 | ||
0c93ed52 SB |
2756 | This macro is called from @code{uw_update_context} in libgcc's |
2757 | @file{unwind-ia64.c}. @var{context} is an @code{_Unwind_Context}; | |
38f8b050 JR |
2758 | @var{fs} is an @code{_Unwind_FrameState}. Examine @code{fs->unwabi} |
2759 | for the abi and context in the @code{.unwabi} directive. If the | |
2760 | @code{.unwabi} directive can be handled, the register save addresses should | |
2761 | be updated in @var{fs}. | |
2762 | @end defmac | |
2763 | ||
2764 | @defmac TARGET_USES_WEAK_UNWIND_INFO | |
2765 | A C expression that evaluates to true if the target requires unwind | |
2766 | info to be given comdat linkage. Define it to be @code{1} if comdat | |
2767 | linkage is necessary. The default is @code{0}. | |
2768 | @end defmac | |
2769 | ||
2770 | @node Stack Checking | |
2771 | @subsection Specifying How Stack Checking is Done | |
2772 | ||
2773 | GCC will check that stack references are within the boundaries of the | |
2774 | stack, if the option @option{-fstack-check} is specified, in one of | |
2775 | three ways: | |
2776 | ||
2777 | @enumerate | |
2778 | @item | |
2779 | If the value of the @code{STACK_CHECK_BUILTIN} macro is nonzero, GCC | |
2780 | will assume that you have arranged for full stack checking to be done | |
2781 | at appropriate places in the configuration files. GCC will not do | |
2782 | other special processing. | |
2783 | ||
2784 | @item | |
2785 | If @code{STACK_CHECK_BUILTIN} is zero and the value of the | |
2786 | @code{STACK_CHECK_STATIC_BUILTIN} macro is nonzero, GCC will assume | |
2787 | that you have arranged for static stack checking (checking of the | |
2788 | static stack frame of functions) to be done at appropriate places | |
2789 | in the configuration files. GCC will only emit code to do dynamic | |
2790 | stack checking (checking on dynamic stack allocations) using the third | |
2791 | approach below. | |
2792 | ||
2793 | @item | |
2794 | If neither of the above are true, GCC will generate code to periodically | |
2795 | ``probe'' the stack pointer using the values of the macros defined below. | |
2796 | @end enumerate | |
2797 | ||
2798 | If neither STACK_CHECK_BUILTIN nor STACK_CHECK_STATIC_BUILTIN is defined, | |
2799 | GCC will change its allocation strategy for large objects if the option | |
2800 | @option{-fstack-check} is specified: they will always be allocated | |
2801 | dynamically if their size exceeds @code{STACK_CHECK_MAX_VAR_SIZE} bytes. | |
2802 | ||
2803 | @defmac STACK_CHECK_BUILTIN | |
2804 | A nonzero value if stack checking is done by the configuration files in a | |
2805 | machine-dependent manner. You should define this macro if stack checking | |
2806 | is required by the ABI of your machine or if you would like to do stack | |
2807 | checking in some more efficient way than the generic approach. The default | |
2808 | value of this macro is zero. | |
2809 | @end defmac | |
2810 | ||
2811 | @defmac STACK_CHECK_STATIC_BUILTIN | |
2812 | A nonzero value if static stack checking is done by the configuration files | |
2813 | in a machine-dependent manner. You should define this macro if you would | |
2814 | like to do static stack checking in some more efficient way than the generic | |
2815 | approach. The default value of this macro is zero. | |
2816 | @end defmac | |
2817 | ||
2818 | @defmac STACK_CHECK_PROBE_INTERVAL_EXP | |
2819 | An integer specifying the interval at which GCC must generate stack probe | |
2820 | instructions, defined as 2 raised to this integer. You will normally | |
2821 | define this macro so that the interval be no larger than the size of | |
2822 | the ``guard pages'' at the end of a stack area. The default value | |
2823 | of 12 (4096-byte interval) is suitable for most systems. | |
2824 | @end defmac | |
2825 | ||
2826 | @defmac STACK_CHECK_MOVING_SP | |
2827 | An integer which is nonzero if GCC should move the stack pointer page by page | |
2828 | when doing probes. This can be necessary on systems where the stack pointer | |
2829 | contains the bottom address of the memory area accessible to the executing | |
2830 | thread at any point in time. In this situation an alternate signal stack | |
2831 | is required in order to be able to recover from a stack overflow. The | |
2832 | default value of this macro is zero. | |
2833 | @end defmac | |
2834 | ||
2835 | @defmac STACK_CHECK_PROTECT | |
2836 | The number of bytes of stack needed to recover from a stack overflow, for | |
c55721c0 | 2837 | languages where such a recovery is supported. The default value of 4KB/8KB |
38f8b050 | 2838 | with the @code{setjmp}/@code{longjmp}-based exception handling mechanism and |
c55721c0 EB |
2839 | 8KB/12KB with other exception handling mechanisms should be adequate for most |
2840 | architectures and operating systems. | |
38f8b050 JR |
2841 | @end defmac |
2842 | ||
2843 | The following macros are relevant only if neither STACK_CHECK_BUILTIN | |
2844 | nor STACK_CHECK_STATIC_BUILTIN is defined; you can omit them altogether | |
2845 | in the opposite case. | |
2846 | ||
2847 | @defmac STACK_CHECK_MAX_FRAME_SIZE | |
2848 | The maximum size of a stack frame, in bytes. GCC will generate probe | |
2849 | instructions in non-leaf functions to ensure at least this many bytes of | |
2850 | stack are available. If a stack frame is larger than this size, stack | |
2851 | checking will not be reliable and GCC will issue a warning. The | |
2852 | default is chosen so that GCC only generates one instruction on most | |
2853 | systems. You should normally not change the default value of this macro. | |
2854 | @end defmac | |
2855 | ||
2856 | @defmac STACK_CHECK_FIXED_FRAME_SIZE | |
2857 | GCC uses this value to generate the above warning message. It | |
2858 | represents the amount of fixed frame used by a function, not including | |
2859 | space for any callee-saved registers, temporaries and user variables. | |
2860 | You need only specify an upper bound for this amount and will normally | |
2861 | use the default of four words. | |
2862 | @end defmac | |
2863 | ||
2864 | @defmac STACK_CHECK_MAX_VAR_SIZE | |
2865 | The maximum size, in bytes, of an object that GCC will place in the | |
2866 | fixed area of the stack frame when the user specifies | |
2867 | @option{-fstack-check}. | |
2868 | GCC computed the default from the values of the above macros and you will | |
2869 | normally not need to override that default. | |
2870 | @end defmac | |
2871 | ||
2c25083e | 2872 | @hook TARGET_STACK_CLASH_PROTECTION_ALLOCA_PROBE_RANGE |
8c1dd970 | 2873 | |
38f8b050 JR |
2874 | @need 2000 |
2875 | @node Frame Registers | |
2876 | @subsection Registers That Address the Stack Frame | |
2877 | ||
2878 | @c prevent bad page break with this line | |
2879 | This discusses registers that address the stack frame. | |
2880 | ||
2881 | @defmac STACK_POINTER_REGNUM | |
2882 | The register number of the stack pointer register, which must also be a | |
2883 | fixed register according to @code{FIXED_REGISTERS}. On most machines, | |
2884 | the hardware determines which register this is. | |
2885 | @end defmac | |
2886 | ||
2887 | @defmac FRAME_POINTER_REGNUM | |
2888 | The register number of the frame pointer register, which is used to | |
2889 | access automatic variables in the stack frame. On some machines, the | |
2890 | hardware determines which register this is. On other machines, you can | |
2891 | choose any register you wish for this purpose. | |
2892 | @end defmac | |
2893 | ||
2894 | @defmac HARD_FRAME_POINTER_REGNUM | |
2895 | On some machines the offset between the frame pointer and starting | |
2896 | offset of the automatic variables is not known until after register | |
2897 | allocation has been done (for example, because the saved registers are | |
2898 | between these two locations). On those machines, define | |
2899 | @code{FRAME_POINTER_REGNUM} the number of a special, fixed register to | |
2900 | be used internally until the offset is known, and define | |
2901 | @code{HARD_FRAME_POINTER_REGNUM} to be the actual hard register number | |
2902 | used for the frame pointer. | |
2903 | ||
2904 | You should define this macro only in the very rare circumstances when it | |
2905 | is not possible to calculate the offset between the frame pointer and | |
2906 | the automatic variables until after register allocation has been | |
2907 | completed. When this macro is defined, you must also indicate in your | |
2908 | definition of @code{ELIMINABLE_REGS} how to eliminate | |
2909 | @code{FRAME_POINTER_REGNUM} into either @code{HARD_FRAME_POINTER_REGNUM} | |
2910 | or @code{STACK_POINTER_REGNUM}. | |
2911 | ||
2912 | Do not define this macro if it would be the same as | |
2913 | @code{FRAME_POINTER_REGNUM}. | |
2914 | @end defmac | |
2915 | ||
2916 | @defmac ARG_POINTER_REGNUM | |
2917 | The register number of the arg pointer register, which is used to access | |
2918 | the function's argument list. On some machines, this is the same as the | |
2919 | frame pointer register. On some machines, the hardware determines which | |
2920 | register this is. On other machines, you can choose any register you | |
2921 | wish for this purpose. If this is not the same register as the frame | |
2922 | pointer register, then you must mark it as a fixed register according to | |
2923 | @code{FIXED_REGISTERS}, or arrange to be able to eliminate it | |
2924 | (@pxref{Elimination}). | |
2925 | @end defmac | |
2926 | ||
e3339d0f JM |
2927 | @defmac HARD_FRAME_POINTER_IS_FRAME_POINTER |
2928 | Define this to a preprocessor constant that is nonzero if | |
2929 | @code{hard_frame_pointer_rtx} and @code{frame_pointer_rtx} should be | |
2930 | the same. The default definition is @samp{(HARD_FRAME_POINTER_REGNUM | |
2931 | == FRAME_POINTER_REGNUM)}; you only need to define this macro if that | |
2932 | definition is not suitable for use in preprocessor conditionals. | |
2933 | @end defmac | |
2934 | ||
2935 | @defmac HARD_FRAME_POINTER_IS_ARG_POINTER | |
2936 | Define this to a preprocessor constant that is nonzero if | |
2937 | @code{hard_frame_pointer_rtx} and @code{arg_pointer_rtx} should be the | |
2938 | same. The default definition is @samp{(HARD_FRAME_POINTER_REGNUM == | |
2939 | ARG_POINTER_REGNUM)}; you only need to define this macro if that | |
2940 | definition is not suitable for use in preprocessor conditionals. | |
2941 | @end defmac | |
2942 | ||
38f8b050 JR |
2943 | @defmac RETURN_ADDRESS_POINTER_REGNUM |
2944 | The register number of the return address pointer register, which is used to | |
2945 | access the current function's return address from the stack. On some | |
2946 | machines, the return address is not at a fixed offset from the frame | |
2947 | pointer or stack pointer or argument pointer. This register can be defined | |
2948 | to point to the return address on the stack, and then be converted by | |
2949 | @code{ELIMINABLE_REGS} into either the frame pointer or stack pointer. | |
2950 | ||
2951 | Do not define this macro unless there is no other way to get the return | |
2952 | address from the stack. | |
2953 | @end defmac | |
2954 | ||
2955 | @defmac STATIC_CHAIN_REGNUM | |
2956 | @defmacx STATIC_CHAIN_INCOMING_REGNUM | |
2957 | Register numbers used for passing a function's static chain pointer. If | |
2958 | register windows are used, the register number as seen by the called | |
2959 | function is @code{STATIC_CHAIN_INCOMING_REGNUM}, while the register | |
2960 | number as seen by the calling function is @code{STATIC_CHAIN_REGNUM}. If | |
2961 | these registers are the same, @code{STATIC_CHAIN_INCOMING_REGNUM} need | |
2962 | not be defined. | |
2963 | ||
2964 | The static chain register need not be a fixed register. | |
2965 | ||
2966 | If the static chain is passed in memory, these macros should not be | |
2967 | defined; instead, the @code{TARGET_STATIC_CHAIN} hook should be used. | |
2968 | @end defmac | |
2969 | ||
2970 | @hook TARGET_STATIC_CHAIN | |
38f8b050 JR |
2971 | |
2972 | @defmac DWARF_FRAME_REGISTERS | |
2973 | This macro specifies the maximum number of hard registers that can be | |
2974 | saved in a call frame. This is used to size data structures used in | |
2975 | DWARF2 exception handling. | |
2976 | ||
2977 | Prior to GCC 3.0, this macro was needed in order to establish a stable | |
2978 | exception handling ABI in the face of adding new hard registers for ISA | |
2979 | extensions. In GCC 3.0 and later, the EH ABI is insulated from changes | |
2980 | in the number of hard registers. Nevertheless, this macro can still be | |
2981 | used to reduce the runtime memory requirements of the exception handling | |
2982 | routines, which can be substantial if the ISA contains a lot of | |
2983 | registers that are not call-saved. | |
2984 | ||
2985 | If this macro is not defined, it defaults to | |
2986 | @code{FIRST_PSEUDO_REGISTER}. | |
2987 | @end defmac | |
2988 | ||
2989 | @defmac PRE_GCC3_DWARF_FRAME_REGISTERS | |
2990 | ||
2991 | This macro is similar to @code{DWARF_FRAME_REGISTERS}, but is provided | |
2992 | for backward compatibility in pre GCC 3.0 compiled code. | |
2993 | ||
2994 | If this macro is not defined, it defaults to | |
2995 | @code{DWARF_FRAME_REGISTERS}. | |
2996 | @end defmac | |
2997 | ||
2998 | @defmac DWARF_REG_TO_UNWIND_COLUMN (@var{regno}) | |
2999 | ||
3000 | Define this macro if the target's representation for dwarf registers | |
3001 | is different than the internal representation for unwind column. | |
3002 | Given a dwarf register, this macro should return the internal unwind | |
3003 | column number to use instead. | |
38f8b050 JR |
3004 | @end defmac |
3005 | ||
3006 | @defmac DWARF_FRAME_REGNUM (@var{regno}) | |
3007 | ||
3008 | Define this macro if the target's representation for dwarf registers | |
3009 | used in .eh_frame or .debug_frame is different from that used in other | |
3010 | debug info sections. Given a GCC hard register number, this macro | |
3011 | should return the .eh_frame register number. The default is | |
3012 | @code{DBX_REGISTER_NUMBER (@var{regno})}. | |
3013 | ||
3014 | @end defmac | |
3015 | ||
3016 | @defmac DWARF2_FRAME_REG_OUT (@var{regno}, @var{for_eh}) | |
3017 | ||
3018 | Define this macro to map register numbers held in the call frame info | |
3019 | that GCC has collected using @code{DWARF_FRAME_REGNUM} to those that | |
3020 | should be output in .debug_frame (@code{@var{for_eh}} is zero) and | |
3021 | .eh_frame (@code{@var{for_eh}} is nonzero). The default is to | |
3022 | return @code{@var{regno}}. | |
3023 | ||
3024 | @end defmac | |
3025 | ||
cca2207a L |
3026 | @defmac REG_VALUE_IN_UNWIND_CONTEXT |
3027 | ||
3028 | Define this macro if the target stores register values as | |
3029 | @code{_Unwind_Word} type in unwind context. It should be defined if | |
3030 | target register size is larger than the size of @code{void *}. The | |
3031 | default is to store register values as @code{void *} type. | |
3032 | ||
3033 | @end defmac | |
3034 | ||
3035 | @defmac ASSUME_EXTENDED_UNWIND_CONTEXT | |
3036 | ||
3037 | Define this macro to be 1 if the target always uses extended unwind | |
3038 | context with version, args_size and by_value fields. If it is undefined, | |
3039 | it will be defined to 1 when @code{REG_VALUE_IN_UNWIND_CONTEXT} is | |
3040 | defined and 0 otherwise. | |
3041 | ||
3042 | @end defmac | |
3043 | ||
dbc3af4f RS |
3044 | @defmac DWARF_LAZY_REGISTER_VALUE (@var{regno}, @var{value}) |
3045 | Define this macro if the target has pseudo DWARF registers whose | |
3046 | values need to be computed lazily on demand by the unwinder (such as when | |
3047 | referenced in a CFA expression). The macro returns true if @var{regno} | |
3048 | is such a register and stores its value in @samp{*@var{value}} if so. | |
3049 | @end defmac | |
3050 | ||
38f8b050 JR |
3051 | @node Elimination |
3052 | @subsection Eliminating Frame Pointer and Arg Pointer | |
3053 | ||
3054 | @c prevent bad page break with this line | |
3055 | This is about eliminating the frame pointer and arg pointer. | |
3056 | ||
3057 | @hook TARGET_FRAME_POINTER_REQUIRED | |
38f8b050 | 3058 | |
38f8b050 | 3059 | @defmac ELIMINABLE_REGS |
53680238 BE |
3060 | This macro specifies a table of register pairs used to eliminate |
3061 | unneeded registers that point into the stack frame. | |
38f8b050 JR |
3062 | |
3063 | The definition of this macro is a list of structure initializations, each | |
3064 | of which specifies an original and replacement register. | |
3065 | ||
3066 | On some machines, the position of the argument pointer is not known until | |
3067 | the compilation is completed. In such a case, a separate hard register | |
3068 | must be used for the argument pointer. This register can be eliminated by | |
3069 | replacing it with either the frame pointer or the argument pointer, | |
3070 | depending on whether or not the frame pointer has been eliminated. | |
3071 | ||
3072 | In this case, you might specify: | |
3073 | @smallexample | |
3074 | #define ELIMINABLE_REGS \ | |
3075 | @{@{ARG_POINTER_REGNUM, STACK_POINTER_REGNUM@}, \ | |
3076 | @{ARG_POINTER_REGNUM, FRAME_POINTER_REGNUM@}, \ | |
3077 | @{FRAME_POINTER_REGNUM, STACK_POINTER_REGNUM@}@} | |
3078 | @end smallexample | |
3079 | ||
3080 | Note that the elimination of the argument pointer with the stack pointer is | |
3081 | specified first since that is the preferred elimination. | |
3082 | @end defmac | |
3083 | ||
3084 | @hook TARGET_CAN_ELIMINATE | |
38f8b050 JR |
3085 | |
3086 | @defmac INITIAL_ELIMINATION_OFFSET (@var{from-reg}, @var{to-reg}, @var{offset-var}) | |
53680238 BE |
3087 | This macro returns the initial difference between the specified pair |
3088 | of registers. The value would be computed from information | |
3089 | such as the result of @code{get_frame_size ()} and the tables of | |
3090 | registers @code{df_regs_ever_live_p} and @code{call_used_regs}. | |
38f8b050 JR |
3091 | @end defmac |
3092 | ||
29eb9a44 BE |
3093 | @hook TARGET_COMPUTE_FRAME_LAYOUT |
3094 | ||
38f8b050 JR |
3095 | @node Stack Arguments |
3096 | @subsection Passing Function Arguments on the Stack | |
3097 | @cindex arguments on stack | |
3098 | @cindex stack arguments | |
3099 | ||
3100 | The macros in this section control how arguments are passed | |
3101 | on the stack. See the following section for other macros that | |
3102 | control passing certain arguments in registers. | |
3103 | ||
3104 | @hook TARGET_PROMOTE_PROTOTYPES | |
38f8b050 | 3105 | |
967b4653 | 3106 | @hook TARGET_PUSH_ARGUMENT |
38f8b050 JR |
3107 | |
3108 | @defmac PUSH_ARGS_REVERSED | |
3109 | A C expression. If nonzero, function arguments will be evaluated from | |
3110 | last to first, rather than from first to last. If this macro is not | |
3111 | defined, it defaults to @code{PUSH_ARGS} on targets where the stack | |
3112 | and args grow in opposite directions, and 0 otherwise. | |
3113 | @end defmac | |
3114 | ||
3115 | @defmac PUSH_ROUNDING (@var{npushed}) | |
3116 | A C expression that is the number of bytes actually pushed onto the | |
3117 | stack when an instruction attempts to push @var{npushed} bytes. | |
3118 | ||
3119 | On some machines, the definition | |
3120 | ||
3121 | @smallexample | |
3122 | #define PUSH_ROUNDING(BYTES) (BYTES) | |
3123 | @end smallexample | |
3124 | ||
3125 | @noindent | |
3126 | will suffice. But on other machines, instructions that appear | |
3127 | to push one byte actually push two bytes in an attempt to maintain | |
3128 | alignment. Then the definition should be | |
3129 | ||
3130 | @smallexample | |
3131 | #define PUSH_ROUNDING(BYTES) (((BYTES) + 1) & ~1) | |
3132 | @end smallexample | |
4a6336ad | 3133 | |
64ad7c99 | 3134 | If the value of this macro has a type, it should be an unsigned type. |
38f8b050 JR |
3135 | @end defmac |
3136 | ||
29454ff5 SL |
3137 | @findex outgoing_args_size |
3138 | @findex crtl->outgoing_args_size | |
38f8b050 JR |
3139 | @defmac ACCUMULATE_OUTGOING_ARGS |
3140 | A C expression. If nonzero, the maximum amount of space required for outgoing arguments | |
29454ff5 SL |
3141 | will be computed and placed into |
3142 | @code{crtl->outgoing_args_size}. No space will be pushed | |
38f8b050 JR |
3143 | onto the stack for each call; instead, the function prologue should |
3144 | increase the stack frame size by this amount. | |
3145 | ||
3146 | Setting both @code{PUSH_ARGS} and @code{ACCUMULATE_OUTGOING_ARGS} | |
3147 | is not proper. | |
3148 | @end defmac | |
3149 | ||
3150 | @defmac REG_PARM_STACK_SPACE (@var{fndecl}) | |
3151 | Define this macro if functions should assume that stack space has been | |
3152 | allocated for arguments even when their values are passed in | |
3153 | registers. | |
3154 | ||
3155 | The value of this macro is the size, in bytes, of the area reserved for | |
3156 | arguments passed in registers for the function represented by @var{fndecl}, | |
3157 | which can be zero if GCC is calling a library function. | |
3158 | The argument @var{fndecl} can be the FUNCTION_DECL, or the type itself | |
3159 | of the function. | |
3160 | ||
3161 | This space can be allocated by the caller, or be a part of the | |
3162 | machine-dependent stack frame: @code{OUTGOING_REG_PARM_STACK_SPACE} says | |
3163 | which. | |
3164 | @end defmac | |
3165 | @c above is overfull. not sure what to do. --mew 5feb93 did | |
3166 | @c something, not sure if it looks good. --mew 10feb93 | |
3167 | ||
ddbb449f AM |
3168 | @defmac INCOMING_REG_PARM_STACK_SPACE (@var{fndecl}) |
3169 | Like @code{REG_PARM_STACK_SPACE}, but for incoming register arguments. | |
3170 | Define this macro if space guaranteed when compiling a function body | |
3171 | is different to space required when making a call, a situation that | |
3172 | can arise with K&R style function definitions. | |
3173 | @end defmac | |
3174 | ||
38f8b050 JR |
3175 | @defmac OUTGOING_REG_PARM_STACK_SPACE (@var{fntype}) |
3176 | Define this to a nonzero value if it is the responsibility of the | |
3177 | caller to allocate the area reserved for arguments passed in registers | |
3178 | when calling a function of @var{fntype}. @var{fntype} may be NULL | |
3179 | if the function called is a library function. | |
3180 | ||
3181 | If @code{ACCUMULATE_OUTGOING_ARGS} is defined, this macro controls | |
3182 | whether the space for these arguments counts in the value of | |
29454ff5 | 3183 | @code{crtl->outgoing_args_size}. |
38f8b050 JR |
3184 | @end defmac |
3185 | ||
3186 | @defmac STACK_PARMS_IN_REG_PARM_AREA | |
3187 | Define this macro if @code{REG_PARM_STACK_SPACE} is defined, but the | |
3188 | stack parameters don't skip the area specified by it. | |
3189 | @c i changed this, makes more sens and it should have taken care of the | |
3190 | @c overfull.. not as specific, tho. --mew 5feb93 | |
3191 | ||
3192 | Normally, when a parameter is not passed in registers, it is placed on the | |
3193 | stack beyond the @code{REG_PARM_STACK_SPACE} area. Defining this macro | |
3194 | suppresses this behavior and causes the parameter to be passed on the | |
3195 | stack in its natural location. | |
3196 | @end defmac | |
3197 | ||
893d13d5 | 3198 | @hook TARGET_RETURN_POPS_ARGS |
38f8b050 JR |
3199 | |
3200 | @defmac CALL_POPS_ARGS (@var{cum}) | |
3201 | A C expression that should indicate the number of bytes a call sequence | |
3202 | pops off the stack. It is added to the value of @code{RETURN_POPS_ARGS} | |
3203 | when compiling a function call. | |
3204 | ||
3205 | @var{cum} is the variable in which all arguments to the called function | |
3206 | have been accumulated. | |
3207 | ||
3208 | On certain architectures, such as the SH5, a call trampoline is used | |
3209 | that pops certain registers off the stack, depending on the arguments | |
3210 | that have been passed to the function. Since this is a property of the | |
3211 | call site, not of the called function, @code{RETURN_POPS_ARGS} is not | |
3212 | appropriate. | |
3213 | @end defmac | |
3214 | ||
3215 | @node Register Arguments | |
3216 | @subsection Passing Arguments in Registers | |
3217 | @cindex arguments in registers | |
3218 | @cindex registers arguments | |
3219 | ||
3220 | This section describes the macros which let you control how various | |
3221 | types of arguments are passed in registers or how they are arranged in | |
3222 | the stack. | |
3223 | ||
b25b9e8f | 3224 | @hook TARGET_FUNCTION_ARG |
38f8b050 JR |
3225 | |
3226 | @hook TARGET_MUST_PASS_IN_STACK | |
38f8b050 | 3227 | |
b25b9e8f | 3228 | @hook TARGET_FUNCTION_INCOMING_ARG |
38f8b050 | 3229 | |
bcb21886 KY |
3230 | @hook TARGET_USE_PSEUDO_PIC_REG |
3231 | ||
3232 | @hook TARGET_INIT_PIC_REG | |
3233 | ||
38f8b050 | 3234 | @hook TARGET_ARG_PARTIAL_BYTES |
38f8b050 | 3235 | |
ec9f85e5 | 3236 | @hook TARGET_PASS_BY_REFERENCE |
38f8b050 JR |
3237 | |
3238 | @hook TARGET_CALLEE_COPIES | |
38f8b050 JR |
3239 | |
3240 | @defmac CUMULATIVE_ARGS | |
b25b9e8f NF |
3241 | A C type for declaring a variable that is used as the first argument |
3242 | of @code{TARGET_FUNCTION_ARG} and other related values. For some | |
3243 | target machines, the type @code{int} suffices and can hold the number | |
3244 | of bytes of argument so far. | |
38f8b050 JR |
3245 | |
3246 | There is no need to record in @code{CUMULATIVE_ARGS} anything about the | |
3247 | arguments that have been passed on the stack. The compiler has other | |
3248 | variables to keep track of that. For target machines on which all | |
3249 | arguments are passed on the stack, there is no need to store anything in | |
3250 | @code{CUMULATIVE_ARGS}; however, the data structure must exist and | |
3251 | should not be empty, so use @code{int}. | |
3252 | @end defmac | |
3253 | ||
3254 | @defmac OVERRIDE_ABI_FORMAT (@var{fndecl}) | |
3255 | If defined, this macro is called before generating any code for a | |
3256 | function, but after the @var{cfun} descriptor for the function has been | |
3257 | created. The back end may use this macro to update @var{cfun} to | |
3258 | reflect an ABI other than that which would normally be used by default. | |
3259 | If the compiler is generating code for a compiler-generated function, | |
3260 | @var{fndecl} may be @code{NULL}. | |
3261 | @end defmac | |
3262 | ||
3263 | @defmac INIT_CUMULATIVE_ARGS (@var{cum}, @var{fntype}, @var{libname}, @var{fndecl}, @var{n_named_args}) | |
3264 | A C statement (sans semicolon) for initializing the variable | |
3265 | @var{cum} for the state at the beginning of the argument list. The | |
3266 | variable has type @code{CUMULATIVE_ARGS}. The value of @var{fntype} | |
3267 | is the tree node for the data type of the function which will receive | |
3268 | the args, or 0 if the args are to a compiler support library function. | |
3269 | For direct calls that are not libcalls, @var{fndecl} contain the | |
3270 | declaration node of the function. @var{fndecl} is also set when | |
3271 | @code{INIT_CUMULATIVE_ARGS} is used to find arguments for the function | |
3272 | being compiled. @var{n_named_args} is set to the number of named | |
3273 | arguments, including a structure return address if it is passed as a | |
3274 | parameter, when making a call. When processing incoming arguments, | |
3275 | @var{n_named_args} is set to @minus{}1. | |
3276 | ||
3277 | When processing a call to a compiler support library function, | |
3278 | @var{libname} identifies which one. It is a @code{symbol_ref} rtx which | |
3279 | contains the name of the function, as a string. @var{libname} is 0 when | |
3280 | an ordinary C function call is being processed. Thus, each time this | |
3281 | macro is called, either @var{libname} or @var{fntype} is nonzero, but | |
3282 | never both of them at once. | |
3283 | @end defmac | |
3284 | ||
3285 | @defmac INIT_CUMULATIVE_LIBCALL_ARGS (@var{cum}, @var{mode}, @var{libname}) | |
3286 | Like @code{INIT_CUMULATIVE_ARGS} but only used for outgoing libcalls, | |
3287 | it gets a @code{MODE} argument instead of @var{fntype}, that would be | |
3288 | @code{NULL}. @var{indirect} would always be zero, too. If this macro | |
3289 | is not defined, @code{INIT_CUMULATIVE_ARGS (cum, NULL_RTX, libname, | |
3290 | 0)} is used instead. | |
3291 | @end defmac | |
3292 | ||
3293 | @defmac INIT_CUMULATIVE_INCOMING_ARGS (@var{cum}, @var{fntype}, @var{libname}) | |
3294 | Like @code{INIT_CUMULATIVE_ARGS} but overrides it for the purposes of | |
3295 | finding the arguments for the function being compiled. If this macro is | |
3296 | undefined, @code{INIT_CUMULATIVE_ARGS} is used instead. | |
3297 | ||
3298 | The value passed for @var{libname} is always 0, since library routines | |
3299 | with special calling conventions are never compiled with GCC@. The | |
3300 | argument @var{libname} exists for symmetry with | |
3301 | @code{INIT_CUMULATIVE_ARGS}. | |
3302 | @c could use "this macro" in place of @code{INIT_CUMULATIVE_ARGS}, maybe. | |
3303 | @c --mew 5feb93 i switched the order of the sentences. --mew 10feb93 | |
3304 | @end defmac | |
3305 | ||
b25b9e8f | 3306 | @hook TARGET_FUNCTION_ARG_ADVANCE |
38f8b050 | 3307 | |
870118b7 | 3308 | @hook TARGET_FUNCTION_ARG_OFFSET |
38f8b050 | 3309 | |
76b0cbf8 | 3310 | @hook TARGET_FUNCTION_ARG_PADDING |
38f8b050 JR |
3311 | |
3312 | @defmac PAD_VARARGS_DOWN | |
3313 | If defined, a C expression which determines whether the default | |
3314 | implementation of va_arg will attempt to pad down before reading the | |
3315 | next argument, if that argument is smaller than its aligned space as | |
3316 | controlled by @code{PARM_BOUNDARY}. If this macro is not defined, all such | |
3317 | arguments are padded down if @code{BYTES_BIG_ENDIAN} is true. | |
3318 | @end defmac | |
3319 | ||
3320 | @defmac BLOCK_REG_PADDING (@var{mode}, @var{type}, @var{first}) | |
3321 | Specify padding for the last element of a block move between registers and | |
3322 | memory. @var{first} is nonzero if this is the only element. Defining this | |
3323 | macro allows better control of register function parameters on big-endian | |
3324 | machines, without using @code{PARALLEL} rtl. In particular, | |
3325 | @code{MUST_PASS_IN_STACK} need not test padding and mode of types in | |
3326 | registers, as there is no longer a "wrong" part of a register; For example, | |
3327 | a three byte aggregate may be passed in the high part of a register if so | |
3328 | required. | |
3329 | @end defmac | |
3330 | ||
c2ed6cf8 | 3331 | @hook TARGET_FUNCTION_ARG_BOUNDARY |
38f8b050 | 3332 | |
123148b5 BS |
3333 | @hook TARGET_FUNCTION_ARG_ROUND_BOUNDARY |
3334 | ||
38f8b050 JR |
3335 | @defmac FUNCTION_ARG_REGNO_P (@var{regno}) |
3336 | A C expression that is nonzero if @var{regno} is the number of a hard | |
3337 | register in which function arguments are sometimes passed. This does | |
3338 | @emph{not} include implicit arguments such as the static chain and | |
3339 | the structure-value address. On many machines, no registers can be | |
3340 | used for this purpose since all function arguments are pushed on the | |
3341 | stack. | |
3342 | @end defmac | |
3343 | ||
3344 | @hook TARGET_SPLIT_COMPLEX_ARG | |
38f8b050 JR |
3345 | |
3346 | @hook TARGET_BUILD_BUILTIN_VA_LIST | |
38f8b050 | 3347 | |
07a5b2bc | 3348 | @hook TARGET_ENUM_VA_LIST_P |
38f8b050 JR |
3349 | |
3350 | @hook TARGET_FN_ABI_VA_LIST | |
38f8b050 JR |
3351 | |
3352 | @hook TARGET_CANONICAL_VA_LIST_TYPE | |
38f8b050 JR |
3353 | |
3354 | @hook TARGET_GIMPLIFY_VA_ARG_EXPR | |
38f8b050 JR |
3355 | |
3356 | @hook TARGET_VALID_POINTER_MODE | |
38f8b050 | 3357 | |
7352c013 RG |
3358 | @hook TARGET_REF_MAY_ALIAS_ERRNO |
3359 | ||
8de583fc PB |
3360 | @hook TARGET_TRANSLATE_MODE_ATTRIBUTE |
3361 | ||
38f8b050 | 3362 | @hook TARGET_SCALAR_MODE_SUPPORTED_P |
38f8b050 JR |
3363 | |
3364 | @hook TARGET_VECTOR_MODE_SUPPORTED_P | |
38f8b050 | 3365 | |
482b2b43 RS |
3366 | @hook TARGET_COMPATIBLE_VECTOR_TYPES_P |
3367 | ||
695da534 RS |
3368 | @hook TARGET_ARRAY_MODE |
3369 | ||
0f6d54f7 RS |
3370 | @hook TARGET_ARRAY_MODE_SUPPORTED_P |
3371 | ||
8cc4b7a2 JM |
3372 | @hook TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P |
3373 | ||
c65699ef JM |
3374 | @hook TARGET_FLOATN_MODE |
3375 | ||
c6762423 MM |
3376 | @hook TARGET_FLOATN_BUILTIN_P |
3377 | ||
38f8b050 | 3378 | @hook TARGET_SMALL_REGISTER_CLASSES_FOR_MODE_P |
38f8b050 JR |
3379 | |
3380 | @node Scalar Return | |
3381 | @subsection How Scalar Function Values Are Returned | |
3382 | @cindex return values in registers | |
3383 | @cindex values, returned by functions | |
3384 | @cindex scalars, returned as values | |
3385 | ||
3386 | This section discusses the macros that control returning scalars as | |
3387 | values---values that can fit in registers. | |
3388 | ||
3389 | @hook TARGET_FUNCTION_VALUE | |
3390 | ||
38f8b050 JR |
3391 | @defmac FUNCTION_VALUE (@var{valtype}, @var{func}) |
3392 | This macro has been deprecated. Use @code{TARGET_FUNCTION_VALUE} for | |
3393 | a new target instead. | |
3394 | @end defmac | |
3395 | ||
3396 | @defmac LIBCALL_VALUE (@var{mode}) | |
3397 | A C expression to create an RTX representing the place where a library | |
3398 | function returns a value of mode @var{mode}. | |
3399 | ||
3400 | Note that ``library function'' in this context means a compiler | |
3401 | support routine, used to perform arithmetic, whose name is known | |
3402 | specially by the compiler and was not mentioned in the C code being | |
3403 | compiled. | |
3404 | @end defmac | |
3405 | ||
3406 | @hook TARGET_LIBCALL_VALUE | |
38f8b050 JR |
3407 | |
3408 | @defmac FUNCTION_VALUE_REGNO_P (@var{regno}) | |
3409 | A C expression that is nonzero if @var{regno} is the number of a hard | |
3410 | register in which the values of called function may come back. | |
3411 | ||
3412 | A register whose use for returning values is limited to serving as the | |
3413 | second of a pair (for a value of type @code{double}, say) need not be | |
3414 | recognized by this macro. So for most machines, this definition | |
3415 | suffices: | |
3416 | ||
3417 | @smallexample | |
3418 | #define FUNCTION_VALUE_REGNO_P(N) ((N) == 0) | |
3419 | @end smallexample | |
3420 | ||
3421 | If the machine has register windows, so that the caller and the called | |
3422 | function use different registers for the return value, this macro | |
3423 | should recognize only the caller's register numbers. | |
3424 | ||
3425 | This macro has been deprecated. Use @code{TARGET_FUNCTION_VALUE_REGNO_P} | |
3426 | for a new target instead. | |
3427 | @end defmac | |
3428 | ||
3429 | @hook TARGET_FUNCTION_VALUE_REGNO_P | |
38f8b050 JR |
3430 | |
3431 | @defmac APPLY_RESULT_SIZE | |
3432 | Define this macro if @samp{untyped_call} and @samp{untyped_return} | |
3433 | need more space than is implied by @code{FUNCTION_VALUE_REGNO_P} for | |
3434 | saving and restoring an arbitrary return value. | |
3435 | @end defmac | |
3436 | ||
e0d14c39 BS |
3437 | @hook TARGET_OMIT_STRUCT_RETURN_REG |
3438 | ||
38f8b050 | 3439 | @hook TARGET_RETURN_IN_MSB |
38f8b050 JR |
3440 | |
3441 | @node Aggregate Return | |
3442 | @subsection How Large Values Are Returned | |
3443 | @cindex aggregates as return values | |
3444 | @cindex large return values | |
3445 | @cindex returning aggregate values | |
3446 | @cindex structure value address | |
3447 | ||
3448 | When a function value's mode is @code{BLKmode} (and in some other | |
3449 | cases), the value is not returned according to | |
3450 | @code{TARGET_FUNCTION_VALUE} (@pxref{Scalar Return}). Instead, the | |
3451 | caller passes the address of a block of memory in which the value | |
3452 | should be stored. This address is called the @dfn{structure value | |
3453 | address}. | |
3454 | ||
3455 | This section describes how to control returning structure values in | |
3456 | memory. | |
3457 | ||
3458 | @hook TARGET_RETURN_IN_MEMORY | |
38f8b050 JR |
3459 | |
3460 | @defmac DEFAULT_PCC_STRUCT_RETURN | |
3461 | Define this macro to be 1 if all structure and union return values must be | |
3462 | in memory. Since this results in slower code, this should be defined | |
3463 | only if needed for compatibility with other compilers or with an ABI@. | |
3464 | If you define this macro to be 0, then the conventions used for structure | |
3465 | and union return values are decided by the @code{TARGET_RETURN_IN_MEMORY} | |
3466 | target hook. | |
3467 | ||
3468 | If not defined, this defaults to the value 1. | |
3469 | @end defmac | |
3470 | ||
3471 | @hook TARGET_STRUCT_VALUE_RTX | |
38f8b050 JR |
3472 | |
3473 | @defmac PCC_STATIC_STRUCT_RETURN | |
3474 | Define this macro if the usual system convention on the target machine | |
3475 | for returning structures and unions is for the called function to return | |
3476 | the address of a static variable containing the value. | |
3477 | ||
3478 | Do not define this if the usual system convention is for the caller to | |
3479 | pass an address to the subroutine. | |
3480 | ||
3481 | This macro has effect in @option{-fpcc-struct-return} mode, but it does | |
3482 | nothing when you use @option{-freg-struct-return} mode. | |
3483 | @end defmac | |
3484 | ||
ffa88471 SE |
3485 | @hook TARGET_GET_RAW_RESULT_MODE |
3486 | ||
3487 | @hook TARGET_GET_RAW_ARG_MODE | |
3488 | ||
974aedcc MP |
3489 | @hook TARGET_EMPTY_RECORD_P |
3490 | ||
3491 | @hook TARGET_WARN_PARAMETER_PASSING_ABI | |
3492 | ||
38f8b050 JR |
3493 | @node Caller Saves |
3494 | @subsection Caller-Saves Register Allocation | |
3495 | ||
3496 | If you enable it, GCC can save registers around function calls. This | |
3497 | makes it possible to use call-clobbered registers to hold variables that | |
3498 | must live across calls. | |
3499 | ||
38f8b050 JR |
3500 | @defmac HARD_REGNO_CALLER_SAVE_MODE (@var{regno}, @var{nregs}) |
3501 | A C expression specifying which mode is required for saving @var{nregs} | |
3502 | of a pseudo-register in call-clobbered hard register @var{regno}. If | |
3503 | @var{regno} is unsuitable for caller save, @code{VOIDmode} should be | |
3504 | returned. For most machines this macro need not be defined since GCC | |
3505 | will select the smallest suitable mode. | |
3506 | @end defmac | |
3507 | ||
3508 | @node Function Entry | |
3509 | @subsection Function Entry and Exit | |
3510 | @cindex function entry and exit | |
3511 | @cindex prologue | |
3512 | @cindex epilogue | |
3513 | ||
3514 | This section describes the macros that output function entry | |
3515 | (@dfn{prologue}) and exit (@dfn{epilogue}) code. | |
3516 | ||
417ca011 TD |
3517 | @hook TARGET_ASM_PRINT_PATCHABLE_FUNCTION_ENTRY |
3518 | ||
38f8b050 | 3519 | @hook TARGET_ASM_FUNCTION_PROLOGUE |
38f8b050 JR |
3520 | |
3521 | @hook TARGET_ASM_FUNCTION_END_PROLOGUE | |
38f8b050 JR |
3522 | |
3523 | @hook TARGET_ASM_FUNCTION_BEGIN_EPILOGUE | |
38f8b050 JR |
3524 | |
3525 | @hook TARGET_ASM_FUNCTION_EPILOGUE | |
38f8b050 JR |
3526 | |
3527 | @itemize @bullet | |
3528 | @item | |
29454ff5 SL |
3529 | @findex pretend_args_size |
3530 | @findex crtl->args.pretend_args_size | |
3531 | A region of @code{crtl->args.pretend_args_size} bytes of | |
38f8b050 JR |
3532 | uninitialized space just underneath the first argument arriving on the |
3533 | stack. (This may not be at the very start of the allocated stack region | |
3534 | if the calling sequence has pushed anything else since pushing the stack | |
3535 | arguments. But usually, on such machines, nothing else has been pushed | |
3536 | yet, because the function prologue itself does all the pushing.) This | |
3537 | region is used on machines where an argument may be passed partly in | |
3538 | registers and partly in memory, and, in some cases to support the | |
3539 | features in @code{<stdarg.h>}. | |
3540 | ||
3541 | @item | |
3542 | An area of memory used to save certain registers used by the function. | |
3543 | The size of this area, which may also include space for such things as | |
3544 | the return address and pointers to previous stack frames, is | |
3545 | machine-specific and usually depends on which registers have been used | |
3546 | in the function. Machines with register windows often do not require | |
3547 | a save area. | |
3548 | ||
3549 | @item | |
3550 | A region of at least @var{size} bytes, possibly rounded up to an allocation | |
3551 | boundary, to contain the local variables of the function. On some machines, | |
3552 | this region and the save area may occur in the opposite order, with the | |
3553 | save area closer to the top of the stack. | |
3554 | ||
3555 | @item | |
3556 | @cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames | |
3557 | Optionally, when @code{ACCUMULATE_OUTGOING_ARGS} is defined, a region of | |
29454ff5 | 3558 | @code{crtl->outgoing_args_size} bytes to be used for outgoing |
38f8b050 JR |
3559 | argument lists of the function. @xref{Stack Arguments}. |
3560 | @end itemize | |
3561 | ||
3562 | @defmac EXIT_IGNORE_STACK | |
3563 | Define this macro as a C expression that is nonzero if the return | |
3564 | instruction or the function epilogue ignores the value of the stack | |
3565 | pointer; in other words, if it is safe to delete an instruction to | |
3566 | adjust the stack pointer before a return from the function. The | |
3567 | default is 0. | |
3568 | ||
3569 | Note that this macro's value is relevant only for functions for which | |
3570 | frame pointers are maintained. It is never safe to delete a final | |
3571 | stack adjustment in a function that has no frame pointer, and the | |
3572 | compiler knows this regardless of @code{EXIT_IGNORE_STACK}. | |
3573 | @end defmac | |
3574 | ||
3575 | @defmac EPILOGUE_USES (@var{regno}) | |
3576 | Define this macro as a C expression that is nonzero for registers that are | |
3577 | used by the epilogue or the @samp{return} pattern. The stack and frame | |
3578 | pointer registers are already assumed to be used as needed. | |
3579 | @end defmac | |
3580 | ||
3581 | @defmac EH_USES (@var{regno}) | |
3582 | Define this macro as a C expression that is nonzero for registers that are | |
3583 | used by the exception handling mechanism, and so should be considered live | |
3584 | on entry to an exception edge. | |
3585 | @end defmac | |
3586 | ||
38f8b050 | 3587 | @hook TARGET_ASM_OUTPUT_MI_THUNK |
38f8b050 JR |
3588 | |
3589 | @hook TARGET_ASM_CAN_OUTPUT_MI_THUNK | |
38f8b050 JR |
3590 | |
3591 | @node Profiling | |
3592 | @subsection Generating Code for Profiling | |
3593 | @cindex profiling, code generation | |
3594 | ||
3595 | These macros will help you generate code for profiling. | |
3596 | ||
3597 | @defmac FUNCTION_PROFILER (@var{file}, @var{labelno}) | |
3598 | A C statement or compound statement to output to @var{file} some | |
3599 | assembler code to call the profiling subroutine @code{mcount}. | |
3600 | ||
3601 | @findex mcount | |
3602 | The details of how @code{mcount} expects to be called are determined by | |
3603 | your operating system environment, not by GCC@. To figure them out, | |
3604 | compile a small program for profiling using the system's installed C | |
3605 | compiler and look at the assembler code that results. | |
3606 | ||
3607 | Older implementations of @code{mcount} expect the address of a counter | |
3608 | variable to be loaded into some register. The name of this variable is | |
3609 | @samp{LP} followed by the number @var{labelno}, so you would generate | |
3610 | the name using @samp{LP%d} in a @code{fprintf}. | |
3611 | @end defmac | |
3612 | ||
3613 | @defmac PROFILE_HOOK | |
3614 | A C statement or compound statement to output to @var{file} some assembly | |
3615 | code to call the profiling subroutine @code{mcount} even the target does | |
3616 | not support profiling. | |
3617 | @end defmac | |
3618 | ||
3619 | @defmac NO_PROFILE_COUNTERS | |
3620 | Define this macro to be an expression with a nonzero value if the | |
3621 | @code{mcount} subroutine on your system does not need a counter variable | |
3622 | allocated for each function. This is true for almost all modern | |
3623 | implementations. If you define this macro, you must not use the | |
3624 | @var{labelno} argument to @code{FUNCTION_PROFILER}. | |
3625 | @end defmac | |
3626 | ||
3627 | @defmac PROFILE_BEFORE_PROLOGUE | |
3628 | Define this macro if the code for function profiling should come before | |
3629 | the function prologue. Normally, the profiling code comes after. | |
3630 | @end defmac | |
3631 | ||
d56a43a0 AK |
3632 | @hook TARGET_KEEP_LEAF_WHEN_PROFILED |
3633 | ||
38f8b050 JR |
3634 | @node Tail Calls |
3635 | @subsection Permitting tail calls | |
3636 | @cindex tail calls | |
3637 | ||
3638 | @hook TARGET_FUNCTION_OK_FOR_SIBCALL | |
38f8b050 JR |
3639 | |
3640 | @hook TARGET_EXTRA_LIVE_ON_ENTRY | |
38f8b050 | 3641 | |
ee3d2ecd JJ |
3642 | @hook TARGET_SET_UP_BY_PROLOGUE |
3643 | ||
d45eae79 SL |
3644 | @hook TARGET_WARN_FUNC_RETURN |
3645 | ||
20a6ece0 SB |
3646 | @node Shrink-wrapping separate components |
3647 | @subsection Shrink-wrapping separate components | |
3648 | @cindex shrink-wrapping separate components | |
3649 | ||
3650 | The prologue may perform a variety of target dependent tasks such as | |
3651 | saving callee-saved registers, saving the return address, aligning the | |
3652 | stack, creating a stack frame, initializing the PIC register, setting | |
3653 | up the static chain, etc. | |
3654 | ||
3655 | On some targets some of these tasks may be independent of others and | |
3656 | thus may be shrink-wrapped separately. These independent tasks are | |
3657 | referred to as components and are handled generically by the target | |
3658 | independent parts of GCC. | |
3659 | ||
3660 | Using the following hooks those prologue or epilogue components can be | |
3661 | shrink-wrapped separately, so that the initialization (and possibly | |
3662 | teardown) those components do is not done as frequently on execution | |
3663 | paths where this would unnecessary. | |
3664 | ||
3665 | What exactly those components are is up to the target code; the generic | |
3666 | code treats them abstractly, as a bit in an @code{sbitmap}. These | |
3667 | @code{sbitmap}s are allocated by the @code{shrink_wrap.get_separate_components} | |
3668 | and @code{shrink_wrap.components_for_bb} hooks, and deallocated by the | |
3669 | generic code. | |
3670 | ||
3671 | @hook TARGET_SHRINK_WRAP_GET_SEPARATE_COMPONENTS | |
3672 | ||
3673 | @hook TARGET_SHRINK_WRAP_COMPONENTS_FOR_BB | |
3674 | ||
3675 | @hook TARGET_SHRINK_WRAP_DISQUALIFY_COMPONENTS | |
3676 | ||
3677 | @hook TARGET_SHRINK_WRAP_EMIT_PROLOGUE_COMPONENTS | |
3678 | ||
3679 | @hook TARGET_SHRINK_WRAP_EMIT_EPILOGUE_COMPONENTS | |
3680 | ||
3681 | @hook TARGET_SHRINK_WRAP_SET_HANDLED_COMPONENTS | |
3682 | ||
38f8b050 JR |
3683 | @node Stack Smashing Protection |
3684 | @subsection Stack smashing protection | |
3685 | @cindex stack smashing protection | |
3686 | ||
3687 | @hook TARGET_STACK_PROTECT_GUARD | |
38f8b050 JR |
3688 | |
3689 | @hook TARGET_STACK_PROTECT_FAIL | |
38f8b050 | 3690 | |
87a5dc2d JW |
3691 | @hook TARGET_STACK_PROTECT_RUNTIME_ENABLED_P |
3692 | ||
7458026b ILT |
3693 | @hook TARGET_SUPPORTS_SPLIT_STACK |
3694 | ||
c98c2430 ML |
3695 | @hook TARGET_GET_VALID_OPTION_VALUES |
3696 | ||
aaeaa9a9 RO |
3697 | @node Miscellaneous Register Hooks |
3698 | @subsection Miscellaneous register hooks | |
3699 | @cindex miscellaneous register hooks | |
3700 | ||
3701 | @hook TARGET_CALL_FUSAGE_CONTAINS_NON_CALLEE_CLOBBERS | |
3702 | ||
38f8b050 JR |
3703 | @node Varargs |
3704 | @section Implementing the Varargs Macros | |
3705 | @cindex varargs implementation | |
3706 | ||
3707 | GCC comes with an implementation of @code{<varargs.h>} and | |
3708 | @code{<stdarg.h>} that work without change on machines that pass arguments | |
3709 | on the stack. Other machines require their own implementations of | |
3710 | varargs, and the two machine independent header files must have | |
3711 | conditionals to include it. | |
3712 | ||
3713 | ISO @code{<stdarg.h>} differs from traditional @code{<varargs.h>} mainly in | |
3714 | the calling convention for @code{va_start}. The traditional | |
3715 | implementation takes just one argument, which is the variable in which | |
3716 | to store the argument pointer. The ISO implementation of | |
3717 | @code{va_start} takes an additional second argument. The user is | |
3718 | supposed to write the last named argument of the function here. | |
3719 | ||
3720 | However, @code{va_start} should not use this argument. The way to find | |
3721 | the end of the named arguments is with the built-in functions described | |
3722 | below. | |
3723 | ||
3724 | @defmac __builtin_saveregs () | |
3725 | Use this built-in function to save the argument registers in memory so | |
3726 | that the varargs mechanism can access them. Both ISO and traditional | |
3727 | versions of @code{va_start} must use @code{__builtin_saveregs}, unless | |
3728 | you use @code{TARGET_SETUP_INCOMING_VARARGS} (see below) instead. | |
3729 | ||
3730 | On some machines, @code{__builtin_saveregs} is open-coded under the | |
3731 | control of the target hook @code{TARGET_EXPAND_BUILTIN_SAVEREGS}. On | |
3732 | other machines, it calls a routine written in assembler language, | |
3733 | found in @file{libgcc2.c}. | |
3734 | ||
3735 | Code generated for the call to @code{__builtin_saveregs} appears at the | |
3736 | beginning of the function, as opposed to where the call to | |
3737 | @code{__builtin_saveregs} is written, regardless of what the code is. | |
3738 | This is because the registers must be saved before the function starts | |
3739 | to use them for its own purposes. | |
3740 | @c i rewrote the first sentence above to fix an overfull hbox. --mew | |
3741 | @c 10feb93 | |
3742 | @end defmac | |
3743 | ||
38f8b050 | 3744 | @defmac __builtin_next_arg (@var{lastarg}) |
c59a0a1d | 3745 | This builtin returns the address of the first anonymous stack |
38f8b050 JR |
3746 | argument, as type @code{void *}. If @code{ARGS_GROW_DOWNWARD}, it |
3747 | returns the address of the location above the first anonymous stack | |
3748 | argument. Use it in @code{va_start} to initialize the pointer for | |
3749 | fetching arguments from the stack. Also use it in @code{va_start} to | |
3750 | verify that the second parameter @var{lastarg} is the last named argument | |
3751 | of the current function. | |
3752 | @end defmac | |
3753 | ||
3754 | @defmac __builtin_classify_type (@var{object}) | |
3755 | Since each machine has its own conventions for which data types are | |
3756 | passed in which kind of register, your implementation of @code{va_arg} | |
3757 | has to embody these conventions. The easiest way to categorize the | |
3758 | specified data type is to use @code{__builtin_classify_type} together | |
3759 | with @code{sizeof} and @code{__alignof__}. | |
3760 | ||
3761 | @code{__builtin_classify_type} ignores the value of @var{object}, | |
3762 | considering only its data type. It returns an integer describing what | |
3763 | kind of type that is---integer, floating, pointer, structure, and so on. | |
3764 | ||
3765 | The file @file{typeclass.h} defines an enumeration that you can use to | |
3766 | interpret the values of @code{__builtin_classify_type}. | |
3767 | @end defmac | |
3768 | ||
3769 | These machine description macros help implement varargs: | |
3770 | ||
3771 | @hook TARGET_EXPAND_BUILTIN_SAVEREGS | |
38f8b050 JR |
3772 | |
3773 | @hook TARGET_SETUP_INCOMING_VARARGS | |
38f8b050 JR |
3774 | |
3775 | @hook TARGET_STRICT_ARGUMENT_NAMING | |
38f8b050 | 3776 | |
2f21e1ba BS |
3777 | @hook TARGET_CALL_ARGS |
3778 | ||
3779 | @hook TARGET_END_CALL_ARGS | |
3780 | ||
38f8b050 | 3781 | @hook TARGET_PRETEND_OUTGOING_VARARGS_NAMED |
38f8b050 | 3782 | |
d5e254e1 IE |
3783 | @hook TARGET_LOAD_BOUNDS_FOR_ARG |
3784 | ||
3785 | @hook TARGET_STORE_BOUNDS_FOR_ARG | |
3786 | ||
3787 | @hook TARGET_LOAD_RETURNED_BOUNDS | |
3788 | ||
3789 | @hook TARGET_STORE_RETURNED_BOUNDS | |
3790 | ||
38f8b050 | 3791 | @node Trampolines |
92b6df43 SL |
3792 | @section Support for Nested Functions |
3793 | @cindex support for nested functions | |
38f8b050 | 3794 | @cindex trampolines for nested functions |
92b6df43 SL |
3795 | @cindex descriptors for nested functions |
3796 | @cindex nested functions, support for | |
3797 | ||
3798 | Taking the address of a nested function requires special compiler | |
3799 | handling to ensure that the static chain register is loaded when | |
3800 | the function is invoked via an indirect call. | |
3801 | ||
3802 | GCC has traditionally supported nested functions by creating an | |
3803 | executable @dfn{trampoline} at run time when the address of a nested | |
3804 | function is taken. This is a small piece of code which normally | |
3805 | resides on the stack, in the stack frame of the containing function. | |
3806 | The trampoline loads the static chain register and then jumps to the | |
3807 | real address of the nested function. | |
3808 | ||
3809 | The use of trampolines requires an executable stack, which is a | |
3810 | security risk. To avoid this problem, GCC also supports another | |
3811 | strategy: using descriptors for nested functions. Under this model, | |
3812 | taking the address of a nested function results in a pointer to a | |
3813 | non-executable function descriptor object. Initializing the static chain | |
3814 | from the descriptor is handled at indirect call sites. | |
3815 | ||
3816 | On some targets, including HPPA and IA-64, function descriptors may be | |
3817 | mandated by the ABI or be otherwise handled in a target-specific way | |
3818 | by the back end in its code generation strategy for indirect calls. | |
3819 | GCC also provides its own generic descriptor implementation to support the | |
3820 | @option{-fno-trampolines} option. In this case runtime detection of | |
3821 | function descriptors at indirect call sites relies on descriptor | |
3822 | pointers being tagged with a bit that is never set in bare function | |
3823 | addresses. Since GCC's generic function descriptors are | |
3824 | not ABI-compliant, this option is typically used only on a | |
3825 | per-language basis (notably by Ada) or when it can otherwise be | |
3826 | applied to the whole program. | |
8f0d7f32 | 3827 | |
4a0c4eae PE |
3828 | For languages other than Ada, the @code{-ftrampolines} and |
3829 | @code{-fno-trampolines} options currently have no effect, and | |
3830 | trampolines are always generated on platforms that need them | |
3831 | for nested functions. | |
92b6df43 SL |
3832 | |
3833 | Define the following hook if your backend either implements ABI-specified | |
3834 | descriptor support, or can use GCC's generic descriptor implementation | |
3835 | for nested functions. | |
3836 | ||
3837 | @hook TARGET_CUSTOM_FUNCTION_DESCRIPTORS | |
3838 | ||
3839 | The following macros tell GCC how to generate code to allocate and | |
3840 | initialize an executable trampoline. You can also use this interface | |
3841 | if your back end needs to create ABI-specified non-executable descriptors; in | |
3842 | this case the "trampoline" created is the descriptor containing data only. | |
3843 | ||
3844 | The instructions in an executable trampoline must do two things: load | |
3845 | a constant address into the static chain register, and jump to the real | |
3846 | address of the nested function. On CISC machines such as the m68k, | |
3847 | this requires two instructions, a move immediate and a jump. Then the | |
3848 | two addresses exist in the trampoline as word-long immediate operands. | |
3849 | On RISC machines, it is often necessary to load each address into a | |
3850 | register in two parts. Then pieces of each address form separate | |
3851 | immediate operands. | |
38f8b050 JR |
3852 | |
3853 | The code generated to initialize the trampoline must store the variable | |
3854 | parts---the static chain value and the function address---into the | |
3855 | immediate operands of the instructions. On a CISC machine, this is | |
3856 | simply a matter of copying each address to a memory reference at the | |
3857 | proper offset from the start of the trampoline. On a RISC machine, it | |
3858 | may be necessary to take out pieces of the address and store them | |
3859 | separately. | |
3860 | ||
3861 | @hook TARGET_ASM_TRAMPOLINE_TEMPLATE | |
38f8b050 JR |
3862 | |
3863 | @defmac TRAMPOLINE_SECTION | |
3864 | Return the section into which the trampoline template is to be placed | |
3865 | (@pxref{Sections}). The default value is @code{readonly_data_section}. | |
3866 | @end defmac | |
3867 | ||
3868 | @defmac TRAMPOLINE_SIZE | |
3869 | A C expression for the size in bytes of the trampoline, as an integer. | |
3870 | @end defmac | |
3871 | ||
3872 | @defmac TRAMPOLINE_ALIGNMENT | |
3873 | Alignment required for trampolines, in bits. | |
3874 | ||
3875 | If you don't define this macro, the value of @code{FUNCTION_ALIGNMENT} | |
3876 | is used for aligning trampolines. | |
3877 | @end defmac | |
3878 | ||
3879 | @hook TARGET_TRAMPOLINE_INIT | |
38f8b050 | 3880 | |
c05ece92 AO |
3881 | @hook TARGET_EMIT_CALL_BUILTIN___CLEAR_CACHE |
3882 | ||
38f8b050 | 3883 | @hook TARGET_TRAMPOLINE_ADJUST_ADDRESS |
38f8b050 JR |
3884 | |
3885 | Implementing trampolines is difficult on many machines because they have | |
3886 | separate instruction and data caches. Writing into a stack location | |
3887 | fails to clear the memory in the instruction cache, so when the program | |
3888 | jumps to that location, it executes the old contents. | |
3889 | ||
3890 | Here are two possible solutions. One is to clear the relevant parts of | |
3891 | the instruction cache whenever a trampoline is set up. The other is to | |
3892 | make all trampolines identical, by having them jump to a standard | |
3893 | subroutine. The former technique makes trampoline execution faster; the | |
3894 | latter makes initialization faster. | |
3895 | ||
3896 | To clear the instruction cache when a trampoline is initialized, define | |
3897 | the following macro. | |
3898 | ||
3899 | @defmac CLEAR_INSN_CACHE (@var{beg}, @var{end}) | |
3900 | If defined, expands to a C expression clearing the @emph{instruction | |
3901 | cache} in the specified interval. The definition of this macro would | |
3902 | typically be a series of @code{asm} statements. Both @var{beg} and | |
c05ece92 | 3903 | @var{end} are pointer expressions. |
38f8b050 JR |
3904 | @end defmac |
3905 | ||
38f8b050 JR |
3906 | To use a standard subroutine, define the following macro. In addition, |
3907 | you must make sure that the instructions in a trampoline fill an entire | |
3908 | cache line with identical instructions, or else ensure that the | |
3909 | beginning of the trampoline code is always aligned at the same point in | |
3910 | its cache line. Look in @file{m68k.h} as a guide. | |
3911 | ||
3912 | @defmac TRANSFER_FROM_TRAMPOLINE | |
3913 | Define this macro if trampolines need a special subroutine to do their | |
3914 | work. The macro should expand to a series of @code{asm} statements | |
3915 | which will be compiled with GCC@. They go in a library function named | |
3916 | @code{__transfer_from_trampoline}. | |
3917 | ||
3918 | If you need to avoid executing the ordinary prologue code of a compiled | |
3919 | C function when you jump to the subroutine, you can do so by placing a | |
3920 | special label of your own in the assembler code. Use one @code{asm} | |
3921 | statement to generate an assembler label, and another to make the label | |
3922 | global. Then trampolines can use that label to jump directly to your | |
3923 | special assembler code. | |
3924 | @end defmac | |
3925 | ||
3926 | @node Library Calls | |
3927 | @section Implicit Calls to Library Routines | |
3928 | @cindex library subroutine names | |
3929 | @cindex @file{libgcc.a} | |
3930 | ||
3931 | @c prevent bad page break with this line | |
3932 | Here is an explanation of implicit calls to library routines. | |
3933 | ||
3934 | @defmac DECLARE_LIBRARY_RENAMES | |
3935 | This macro, if defined, should expand to a piece of C code that will get | |
3936 | expanded when compiling functions for libgcc.a. It can be used to | |
3937 | provide alternate names for GCC's internal library functions if there | |
3938 | are ABI-mandated names that the compiler should provide. | |
3939 | @end defmac | |
3940 | ||
3941 | @findex set_optab_libfunc | |
3942 | @findex init_one_libfunc | |
3943 | @hook TARGET_INIT_LIBFUNCS | |
38f8b050 | 3944 | |
cdbf4541 BS |
3945 | @hook TARGET_LIBFUNC_GNU_PREFIX |
3946 | ||
38f8b050 JR |
3947 | @defmac FLOAT_LIB_COMPARE_RETURNS_BOOL (@var{mode}, @var{comparison}) |
3948 | This macro should return @code{true} if the library routine that | |
3949 | implements the floating point comparison operator @var{comparison} in | |
3950 | mode @var{mode} will return a boolean, and @var{false} if it will | |
3951 | return a tristate. | |
3952 | ||
3953 | GCC's own floating point libraries return tristates from the | |
3954 | comparison operators, so the default returns false always. Most ports | |
3955 | don't need to define this macro. | |
3956 | @end defmac | |
3957 | ||
3958 | @defmac TARGET_LIB_INT_CMP_BIASED | |
3959 | This macro should evaluate to @code{true} if the integer comparison | |
3960 | functions (like @code{__cmpdi2}) return 0 to indicate that the first | |
3961 | operand is smaller than the second, 1 to indicate that they are equal, | |
3962 | and 2 to indicate that the first operand is greater than the second. | |
3963 | If this macro evaluates to @code{false} the comparison functions return | |
3964 | @minus{}1, 0, and 1 instead of 0, 1, and 2. If the target uses the routines | |
3965 | in @file{libgcc.a}, you do not need to define this macro. | |
3966 | @end defmac | |
3967 | ||
30b8f78b KV |
3968 | @defmac TARGET_HAS_NO_HW_DIVIDE |
3969 | This macro should be defined if the target has no hardware divide | |
3970 | instructions. If this macro is defined, GCC will use an algorithm which | |
3971 | make use of simple logical and arithmetic operations for 64-bit | |
3972 | division. If the macro is not defined, GCC will use an algorithm which | |
3973 | make use of a 64-bit by 32-bit divide primitive. | |
3974 | @end defmac | |
3975 | ||
38f8b050 JR |
3976 | @cindex @code{EDOM}, implicit usage |
3977 | @findex matherr | |
3978 | @defmac TARGET_EDOM | |
3979 | The value of @code{EDOM} on the target machine, as a C integer constant | |
3980 | expression. If you don't define this macro, GCC does not attempt to | |
3981 | deposit the value of @code{EDOM} into @code{errno} directly. Look in | |
3982 | @file{/usr/include/errno.h} to find the value of @code{EDOM} on your | |
3983 | system. | |
3984 | ||
3985 | If you do not define @code{TARGET_EDOM}, then compiled code reports | |
3986 | domain errors by calling the library function and letting it report the | |
3987 | error. If mathematical functions on your system use @code{matherr} when | |
3988 | there is an error, then you should leave @code{TARGET_EDOM} undefined so | |
3989 | that @code{matherr} is used normally. | |
3990 | @end defmac | |
3991 | ||
3992 | @cindex @code{errno}, implicit usage | |
3993 | @defmac GEN_ERRNO_RTX | |
3994 | Define this macro as a C expression to create an rtl expression that | |
3995 | refers to the global ``variable'' @code{errno}. (On certain systems, | |
3996 | @code{errno} may not actually be a variable.) If you don't define this | |
3997 | macro, a reasonable default is used. | |
3998 | @end defmac | |
3999 | ||
d33d9e47 | 4000 | @hook TARGET_LIBC_HAS_FUNCTION |
38f8b050 | 4001 | |
db91c7cf ML |
4002 | @hook TARGET_LIBC_HAS_FAST_FUNCTION |
4003 | ||
38f8b050 | 4004 | @defmac NEXT_OBJC_RUNTIME |
fea3ca91 IS |
4005 | Set this macro to 1 to use the "NeXT" Objective-C message sending conventions |
4006 | by default. This calling convention involves passing the object, the selector | |
4007 | and the method arguments all at once to the method-lookup library function. | |
4008 | This is the usual setting when targeting Darwin/Mac OS X systems, which have | |
4009 | the NeXT runtime installed. | |
4010 | ||
4011 | If the macro is set to 0, the "GNU" Objective-C message sending convention | |
4012 | will be used by default. This convention passes just the object and the | |
4013 | selector to the method-lookup function, which returns a pointer to the method. | |
4014 | ||
4015 | In either case, it remains possible to select code-generation for the alternate | |
4016 | scheme, by means of compiler command line switches. | |
38f8b050 JR |
4017 | @end defmac |
4018 | ||
4019 | @node Addressing Modes | |
4020 | @section Addressing Modes | |
4021 | @cindex addressing modes | |
4022 | ||
4023 | @c prevent bad page break with this line | |
4024 | This is about addressing modes. | |
4025 | ||
4026 | @defmac HAVE_PRE_INCREMENT | |
4027 | @defmacx HAVE_PRE_DECREMENT | |
4028 | @defmacx HAVE_POST_INCREMENT | |
4029 | @defmacx HAVE_POST_DECREMENT | |
4030 | A C expression that is nonzero if the machine supports pre-increment, | |
4031 | pre-decrement, post-increment, or post-decrement addressing respectively. | |
4032 | @end defmac | |
4033 | ||
4034 | @defmac HAVE_PRE_MODIFY_DISP | |
4035 | @defmacx HAVE_POST_MODIFY_DISP | |
4036 | A C expression that is nonzero if the machine supports pre- or | |
4037 | post-address side-effect generation involving constants other than | |
4038 | the size of the memory operand. | |
4039 | @end defmac | |
4040 | ||
4041 | @defmac HAVE_PRE_MODIFY_REG | |
4042 | @defmacx HAVE_POST_MODIFY_REG | |
4043 | A C expression that is nonzero if the machine supports pre- or | |
4044 | post-address side-effect generation involving a register displacement. | |
4045 | @end defmac | |
4046 | ||
4047 | @defmac CONSTANT_ADDRESS_P (@var{x}) | |
4048 | A C expression that is 1 if the RTX @var{x} is a constant which | |
4049 | is a valid address. On most machines the default definition of | |
4050 | @code{(CONSTANT_P (@var{x}) && GET_CODE (@var{x}) != CONST_DOUBLE)} | |
4051 | is acceptable, but a few machines are more restrictive as to which | |
ff2ce160 | 4052 | constant addresses are supported. |
38f8b050 JR |
4053 | @end defmac |
4054 | ||
4055 | @defmac CONSTANT_P (@var{x}) | |
4056 | @code{CONSTANT_P}, which is defined by target-independent code, | |
4057 | accepts integer-values expressions whose values are not explicitly | |
4058 | known, such as @code{symbol_ref}, @code{label_ref}, and @code{high} | |
4059 | expressions and @code{const} arithmetic expressions, in addition to | |
4060 | @code{const_int} and @code{const_double} expressions. | |
4061 | @end defmac | |
4062 | ||
4063 | @defmac MAX_REGS_PER_ADDRESS | |
4064 | A number, the maximum number of registers that can appear in a valid | |
4065 | memory address. Note that it is up to you to specify a value equal to | |
4066 | the maximum number that @code{TARGET_LEGITIMATE_ADDRESS_P} would ever | |
4067 | accept. | |
4068 | @end defmac | |
4069 | ||
4070 | @hook TARGET_LEGITIMATE_ADDRESS_P | |
38f8b050 JR |
4071 | |
4072 | @defmac TARGET_MEM_CONSTRAINT | |
4073 | A single character to be used instead of the default @code{'m'} | |
4074 | character for general memory addresses. This defines the constraint | |
4075 | letter which matches the memory addresses accepted by | |
4076 | @code{TARGET_LEGITIMATE_ADDRESS_P}. Define this macro if you want to | |
4077 | support new address formats in your back end without changing the | |
4078 | semantics of the @code{'m'} constraint. This is necessary in order to | |
4079 | preserve functionality of inline assembly constructs using the | |
4080 | @code{'m'} constraint. | |
4081 | @end defmac | |
4082 | ||
4083 | @defmac FIND_BASE_TERM (@var{x}) | |
4084 | A C expression to determine the base term of address @var{x}, | |
4085 | or to provide a simplified version of @var{x} from which @file{alias.c} | |
4086 | can easily find the base term. This macro is used in only two places: | |
4087 | @code{find_base_value} and @code{find_base_term} in @file{alias.c}. | |
4088 | ||
4089 | It is always safe for this macro to not be defined. It exists so | |
4090 | that alias analysis can understand machine-dependent addresses. | |
4091 | ||
4092 | The typical use of this macro is to handle addresses containing | |
4093 | a label_ref or symbol_ref within an UNSPEC@. | |
4094 | @end defmac | |
4095 | ||
4096 | @hook TARGET_LEGITIMIZE_ADDRESS | |
38f8b050 JR |
4097 | |
4098 | @defmac LEGITIMIZE_RELOAD_ADDRESS (@var{x}, @var{mode}, @var{opnum}, @var{type}, @var{ind_levels}, @var{win}) | |
4099 | A C compound statement that attempts to replace @var{x}, which is an address | |
4100 | that needs reloading, with a valid memory address for an operand of mode | |
4101 | @var{mode}. @var{win} will be a C statement label elsewhere in the code. | |
4102 | It is not necessary to define this macro, but it might be useful for | |
4103 | performance reasons. | |
4104 | ||
4105 | For example, on the i386, it is sometimes possible to use a single | |
4106 | reload register instead of two by reloading a sum of two pseudo | |
4107 | registers into a register. On the other hand, for number of RISC | |
4108 | processors offsets are limited so that often an intermediate address | |
4109 | needs to be generated in order to address a stack slot. By defining | |
4110 | @code{LEGITIMIZE_RELOAD_ADDRESS} appropriately, the intermediate addresses | |
4111 | generated for adjacent some stack slots can be made identical, and thus | |
4112 | be shared. | |
4113 | ||
4114 | @emph{Note}: This macro should be used with caution. It is necessary | |
4115 | to know something of how reload works in order to effectively use this, | |
4116 | and it is quite easy to produce macros that build in too much knowledge | |
4117 | of reload internals. | |
4118 | ||
4119 | @emph{Note}: This macro must be able to reload an address created by a | |
4120 | previous invocation of this macro. If it fails to handle such addresses | |
4121 | then the compiler may generate incorrect code or abort. | |
4122 | ||
4123 | @findex push_reload | |
4124 | The macro definition should use @code{push_reload} to indicate parts that | |
4125 | need reloading; @var{opnum}, @var{type} and @var{ind_levels} are usually | |
4126 | suitable to be passed unaltered to @code{push_reload}. | |
4127 | ||
4128 | The code generated by this macro must not alter the substructure of | |
4129 | @var{x}. If it transforms @var{x} into a more legitimate form, it | |
4130 | should assign @var{x} (which will always be a C variable) a new value. | |
4131 | This also applies to parts that you change indirectly by calling | |
4132 | @code{push_reload}. | |
4133 | ||
4134 | @findex strict_memory_address_p | |
4135 | The macro definition may use @code{strict_memory_address_p} to test if | |
4136 | the address has become legitimate. | |
4137 | ||
4138 | @findex copy_rtx | |
4139 | If you want to change only a part of @var{x}, one standard way of doing | |
4140 | this is to use @code{copy_rtx}. Note, however, that it unshares only a | |
4141 | single level of rtl. Thus, if the part to be changed is not at the | |
4142 | top level, you'll need to replace first the top level. | |
4143 | It is not necessary for this macro to come up with a legitimate | |
4144 | address; but often a machine-dependent strategy can generate better code. | |
4145 | @end defmac | |
4146 | ||
4147 | @hook TARGET_MODE_DEPENDENT_ADDRESS_P | |
38f8b050 | 4148 | |
1a627b35 | 4149 | @hook TARGET_LEGITIMATE_CONSTANT_P |
38f8b050 | 4150 | |
a21b3997 DE |
4151 | @hook TARGET_PRECOMPUTE_TLS_P |
4152 | ||
38f8b050 | 4153 | @hook TARGET_DELEGITIMIZE_ADDRESS |
38f8b050 | 4154 | |
93bcc8c9 | 4155 | @hook TARGET_CONST_NOT_OK_FOR_DEBUG_P |
93bcc8c9 | 4156 | |
38f8b050 | 4157 | @hook TARGET_CANNOT_FORCE_CONST_MEM |
38f8b050 JR |
4158 | |
4159 | @hook TARGET_USE_BLOCKS_FOR_CONSTANT_P | |
38f8b050 | 4160 | |
361a58da | 4161 | @hook TARGET_USE_BLOCKS_FOR_DECL_P |
361a58da | 4162 | |
89356d17 | 4163 | @hook TARGET_BUILTIN_RECIPROCAL |
38f8b050 JR |
4164 | |
4165 | @hook TARGET_VECTORIZE_BUILTIN_MASK_FOR_LOAD | |
38f8b050 | 4166 | |
38f8b050 | 4167 | @hook TARGET_VECTORIZE_BUILTIN_VECTORIZATION_COST |
38f8b050 | 4168 | |
f702e7d4 RS |
4169 | @hook TARGET_VECTORIZE_PREFERRED_VECTOR_ALIGNMENT |
4170 | ||
38f8b050 | 4171 | @hook TARGET_VECTORIZE_VECTOR_ALIGNMENT_REACHABLE |
38f8b050 | 4172 | |
f151c9e1 | 4173 | @hook TARGET_VECTORIZE_VEC_PERM_CONST |
38f8b050 | 4174 | |
38f8b050 | 4175 | @hook TARGET_VECTORIZE_BUILTIN_VECTORIZED_FUNCTION |
38f8b050 | 4176 | |
10766209 RS |
4177 | @hook TARGET_VECTORIZE_BUILTIN_MD_VECTORIZED_FUNCTION |
4178 | ||
38f8b050 | 4179 | @hook TARGET_VECTORIZE_SUPPORT_VECTOR_MISALIGNMENT |
38f8b050 | 4180 | |
cc4b5170 | 4181 | @hook TARGET_VECTORIZE_PREFERRED_SIMD_MODE |
26983c22 | 4182 | |
c803b2a9 RB |
4183 | @hook TARGET_VECTORIZE_SPLIT_REDUCTION |
4184 | ||
e021fb86 | 4185 | @hook TARGET_VECTORIZE_AUTOVECTORIZE_VECTOR_MODES |
767f865f | 4186 | |
f0955233 RS |
4187 | @hook TARGET_VECTORIZE_RELATED_MODE |
4188 | ||
9f47c7e5 IE |
4189 | @hook TARGET_VECTORIZE_GET_MASK_MODE |
4190 | ||
76a34e3f RS |
4191 | @hook TARGET_VECTORIZE_EMPTY_MASK_IS_EXPENSIVE |
4192 | ||
c3e7ee41 BS |
4193 | @hook TARGET_VECTORIZE_INIT_COST |
4194 | ||
4195 | @hook TARGET_VECTORIZE_ADD_STMT_COST | |
4196 | ||
4197 | @hook TARGET_VECTORIZE_FINISH_COST | |
4198 | ||
4199 | @hook TARGET_VECTORIZE_DESTROY_COST_DATA | |
4200 | ||
aec7ae7d | 4201 | @hook TARGET_VECTORIZE_BUILTIN_GATHER |
aec7ae7d | 4202 | |
3bab6342 AT |
4203 | @hook TARGET_VECTORIZE_BUILTIN_SCATTER |
4204 | ||
0136f8f0 AH |
4205 | @hook TARGET_SIMD_CLONE_COMPUTE_VECSIZE_AND_SIMDLEN |
4206 | ||
4207 | @hook TARGET_SIMD_CLONE_ADJUST | |
4208 | ||
4209 | @hook TARGET_SIMD_CLONE_USABLE | |
4210 | ||
5012919d AM |
4211 | @hook TARGET_SIMT_VF |
4212 | ||
9ba66bf5 JJ |
4213 | @hook TARGET_OMP_DEVICE_KIND_ARCH_ISA |
4214 | ||
94829f87 NS |
4215 | @hook TARGET_GOACC_VALIDATE_DIMS |
4216 | ||
bd751975 NS |
4217 | @hook TARGET_GOACC_DIM_LIMIT |
4218 | ||
6e91acf8 NS |
4219 | @hook TARGET_GOACC_FORK_JOIN |
4220 | ||
e5014671 NS |
4221 | @hook TARGET_GOACC_REDUCTION |
4222 | ||
6a86928d RS |
4223 | @hook TARGET_PREFERRED_ELSE_VALUE |
4224 | ||
29a2f518 JB |
4225 | @hook TARGET_GOACC_ADJUST_PRIVATE_DECL |
4226 | ||
4227 | @hook TARGET_GOACC_EXPAND_VAR_DECL | |
4228 | ||
e2a58ed6 JB |
4229 | @hook TARGET_GOACC_CREATE_WORKER_BROADCAST_RECORD |
4230 | ||
2a3f9f65 JB |
4231 | @hook TARGET_GOACC_SHARED_MEM_LAYOUT |
4232 | ||
38f8b050 JR |
4233 | @node Anchored Addresses |
4234 | @section Anchored Addresses | |
4235 | @cindex anchored addresses | |
4236 | @cindex @option{-fsection-anchors} | |
4237 | ||
4238 | GCC usually addresses every static object as a separate entity. | |
4239 | For example, if we have: | |
4240 | ||
4241 | @smallexample | |
4242 | static int a, b, c; | |
4243 | int foo (void) @{ return a + b + c; @} | |
4244 | @end smallexample | |
4245 | ||
4246 | the code for @code{foo} will usually calculate three separate symbolic | |
4247 | addresses: those of @code{a}, @code{b} and @code{c}. On some targets, | |
4248 | it would be better to calculate just one symbolic address and access | |
4249 | the three variables relative to it. The equivalent pseudocode would | |
4250 | be something like: | |
4251 | ||
4252 | @smallexample | |
4253 | int foo (void) | |
4254 | @{ | |
4255 | register int *xr = &x; | |
4256 | return xr[&a - &x] + xr[&b - &x] + xr[&c - &x]; | |
4257 | @} | |
4258 | @end smallexample | |
4259 | ||
4260 | (which isn't valid C). We refer to shared addresses like @code{x} as | |
4261 | ``section anchors''. Their use is controlled by @option{-fsection-anchors}. | |
4262 | ||
4263 | The hooks below describe the target properties that GCC needs to know | |
4264 | in order to make effective use of section anchors. It won't use | |
4265 | section anchors at all unless either @code{TARGET_MIN_ANCHOR_OFFSET} | |
4266 | or @code{TARGET_MAX_ANCHOR_OFFSET} is set to a nonzero value. | |
4267 | ||
4268 | @hook TARGET_MIN_ANCHOR_OFFSET | |
38f8b050 JR |
4269 | |
4270 | @hook TARGET_MAX_ANCHOR_OFFSET | |
38f8b050 JR |
4271 | |
4272 | @hook TARGET_ASM_OUTPUT_ANCHOR | |
38f8b050 JR |
4273 | |
4274 | @hook TARGET_USE_ANCHORS_FOR_SYMBOL_P | |
38f8b050 JR |
4275 | |
4276 | @node Condition Code | |
4277 | @section Condition Code Status | |
4278 | @cindex condition code status | |
4279 | ||
bd1cd0d0 SB |
4280 | Condition codes in GCC are represented as registers, |
4281 | which provides better schedulability for | |
38f8b050 JR |
4282 | architectures that do have a condition code register, but on which |
4283 | most instructions do not affect it. The latter category includes | |
4284 | most RISC machines. | |
4285 | ||
bd1cd0d0 | 4286 | Implicit clobbering would pose a strong restriction on the placement of |
c4f6267b L |
4287 | the definition and use of the condition code. In the past the definition |
4288 | and use were always adjacent. However, recent changes to support trapping | |
bd1cd0d0 | 4289 | arithmetic may result in the definition and user being in different blocks. |
c4f6267b L |
4290 | Thus, there may be a @code{NOTE_INSN_BASIC_BLOCK} between them. Additionally, |
4291 | the definition may be the source of exception handling edges. | |
4292 | ||
4293 | These restrictions can prevent important | |
38f8b050 JR |
4294 | optimizations on some machines. For example, on the IBM RS/6000, there |
4295 | is a delay for taken branches unless the condition code register is set | |
4296 | three instructions earlier than the conditional branch. The instruction | |
4297 | scheduler cannot perform this optimization if it is not permitted to | |
4298 | separate the definition and use of the condition code register. | |
4299 | ||
bd1cd0d0 | 4300 | If there is a specific |
38f8b050 JR |
4301 | condition code register in the machine, use a hard register. If the |
4302 | condition code or comparison result can be placed in any general register, | |
4303 | or if there are multiple condition registers, use a pseudo register. | |
4304 | Registers used to store the condition code value will usually have a mode | |
4305 | that is in class @code{MODE_CC}. | |
4306 | ||
4307 | Alternatively, you can use @code{BImode} if the comparison operator is | |
4308 | specified already in the compare instruction. In this case, you are not | |
4309 | interested in most macros in this section. | |
4310 | ||
4311 | @menu | |
38f8b050 | 4312 | * MODE_CC Condition Codes:: Modern representation of condition codes. |
38f8b050 JR |
4313 | @end menu |
4314 | ||
38f8b050 JR |
4315 | @node MODE_CC Condition Codes |
4316 | @subsection Representation of condition codes using registers | |
4317 | @findex CCmode | |
4318 | @findex MODE_CC | |
4319 | ||
4320 | @defmac SELECT_CC_MODE (@var{op}, @var{x}, @var{y}) | |
4321 | On many machines, the condition code may be produced by other instructions | |
4322 | than compares, for example the branch can use directly the condition | |
4323 | code set by a subtract instruction. However, on some machines | |
4324 | when the condition code is set this way some bits (such as the overflow | |
4325 | bit) are not set in the same way as a test instruction, so that a different | |
4326 | branch instruction must be used for some conditional branches. When | |
4327 | this happens, use the machine mode of the condition code register to | |
4328 | record different formats of the condition code register. Modes can | |
630ba2fd | 4329 | also be used to record which compare instruction (e.g.@: a signed or an |
38f8b050 JR |
4330 | unsigned comparison) produced the condition codes. |
4331 | ||
4332 | If other modes than @code{CCmode} are required, add them to | |
4333 | @file{@var{machine}-modes.def} and define @code{SELECT_CC_MODE} to choose | |
4334 | a mode given an operand of a compare. This is needed because the modes | |
4335 | have to be chosen not only during RTL generation but also, for example, | |
4336 | by instruction combination. The result of @code{SELECT_CC_MODE} should | |
4337 | be consistent with the mode used in the patterns; for example to support | |
4338 | the case of the add on the SPARC discussed above, we have the pattern | |
4339 | ||
4340 | @smallexample | |
4341 | (define_insn "" | |
ff7e7ee0 EB |
4342 | [(set (reg:CCNZ 0) |
4343 | (compare:CCNZ | |
38f8b050 JR |
4344 | (plus:SI (match_operand:SI 0 "register_operand" "%r") |
4345 | (match_operand:SI 1 "arith_operand" "rI")) | |
4346 | (const_int 0)))] | |
4347 | "" | |
4348 | "@dots{}") | |
4349 | @end smallexample | |
4350 | ||
4351 | @noindent | |
ff7e7ee0 | 4352 | together with a @code{SELECT_CC_MODE} that returns @code{CCNZmode} |
38f8b050 JR |
4353 | for comparisons whose argument is a @code{plus}: |
4354 | ||
4355 | @smallexample | |
4356 | #define SELECT_CC_MODE(OP,X,Y) \ | |
95cc11e1 EB |
4357 | (GET_MODE_CLASS (GET_MODE (X)) == MODE_FLOAT \ |
4358 | ? ((OP == LT || OP == LE || OP == GT || OP == GE) \ | |
4359 | ? CCFPEmode : CCFPmode) \ | |
4360 | : ((GET_CODE (X) == PLUS || GET_CODE (X) == MINUS \ | |
4361 | || GET_CODE (X) == NEG || GET_CODE (x) == ASHIFT) \ | |
ff7e7ee0 | 4362 | ? CCNZmode : CCmode)) |
38f8b050 JR |
4363 | @end smallexample |
4364 | ||
4365 | Another reason to use modes is to retain information on which operands | |
4366 | were used by the comparison; see @code{REVERSIBLE_CC_MODE} later in | |
4367 | this section. | |
4368 | ||
4369 | You should define this macro if and only if you define extra CC modes | |
4370 | in @file{@var{machine}-modes.def}. | |
4371 | @end defmac | |
4372 | ||
d331d374 | 4373 | @hook TARGET_CANONICALIZE_COMPARISON |
38f8b050 JR |
4374 | |
4375 | @defmac REVERSIBLE_CC_MODE (@var{mode}) | |
4376 | A C expression whose value is one if it is always safe to reverse a | |
4377 | comparison whose mode is @var{mode}. If @code{SELECT_CC_MODE} | |
4378 | can ever return @var{mode} for a floating-point inequality comparison, | |
4379 | then @code{REVERSIBLE_CC_MODE (@var{mode})} must be zero. | |
4380 | ||
4381 | You need not define this macro if it would always returns zero or if the | |
4382 | floating-point format is anything other than @code{IEEE_FLOAT_FORMAT}. | |
4383 | For example, here is the definition used on the SPARC, where floating-point | |
95cc11e1 | 4384 | inequality comparisons are given either @code{CCFPEmode} or @code{CCFPmode}: |
38f8b050 JR |
4385 | |
4386 | @smallexample | |
95cc11e1 EB |
4387 | #define REVERSIBLE_CC_MODE(MODE) \ |
4388 | ((MODE) != CCFPEmode && (MODE) != CCFPmode) | |
38f8b050 JR |
4389 | @end smallexample |
4390 | @end defmac | |
4391 | ||
4392 | @defmac REVERSE_CONDITION (@var{code}, @var{mode}) | |
4393 | A C expression whose value is reversed condition code of the @var{code} for | |
4394 | comparison done in CC_MODE @var{mode}. The macro is used only in case | |
4395 | @code{REVERSIBLE_CC_MODE (@var{mode})} is nonzero. Define this macro in case | |
4396 | machine has some non-standard way how to reverse certain conditionals. For | |
4397 | instance in case all floating point conditions are non-trapping, compiler may | |
95cc11e1 | 4398 | freely convert unordered compares to ordered ones. Then definition may look |
38f8b050 JR |
4399 | like: |
4400 | ||
4401 | @smallexample | |
4402 | #define REVERSE_CONDITION(CODE, MODE) \ | |
4403 | ((MODE) != CCFPmode ? reverse_condition (CODE) \ | |
4404 | : reverse_condition_maybe_unordered (CODE)) | |
4405 | @end smallexample | |
4406 | @end defmac | |
4407 | ||
4408 | @hook TARGET_FIXED_CONDITION_CODE_REGS | |
38f8b050 JR |
4409 | |
4410 | @hook TARGET_CC_MODES_COMPATIBLE | |
38f8b050 | 4411 | |
8f048116 EB |
4412 | @hook TARGET_FLAGS_REGNUM |
4413 | ||
38f8b050 JR |
4414 | @node Costs |
4415 | @section Describing Relative Costs of Operations | |
4416 | @cindex costs of instructions | |
4417 | @cindex relative costs | |
4418 | @cindex speed of instructions | |
4419 | ||
4420 | These macros let you describe the relative speed of various operations | |
4421 | on the target machine. | |
4422 | ||
4423 | @defmac REGISTER_MOVE_COST (@var{mode}, @var{from}, @var{to}) | |
4424 | A C expression for the cost of moving data of mode @var{mode} from a | |
4425 | register in class @var{from} to one in class @var{to}. The classes are | |
4426 | expressed using the enumeration values such as @code{GENERAL_REGS}. A | |
4427 | value of 2 is the default; other values are interpreted relative to | |
4428 | that. | |
4429 | ||
4430 | It is not required that the cost always equal 2 when @var{from} is the | |
4431 | same as @var{to}; on some machines it is expensive to move between | |
4432 | registers if they are not general registers. | |
4433 | ||
4434 | If reload sees an insn consisting of a single @code{set} between two | |
4435 | hard registers, and if @code{REGISTER_MOVE_COST} applied to their | |
4436 | classes returns a value of 2, reload does not check to ensure that the | |
4437 | constraints of the insn are met. Setting a cost of other than 2 will | |
4438 | allow reload to verify that the constraints are met. You should do this | |
4439 | if the @samp{mov@var{m}} pattern's constraints do not allow such copying. | |
4440 | ||
4441 | These macros are obsolete, new ports should use the target hook | |
4442 | @code{TARGET_REGISTER_MOVE_COST} instead. | |
4443 | @end defmac | |
4444 | ||
4445 | @hook TARGET_REGISTER_MOVE_COST | |
38f8b050 JR |
4446 | |
4447 | @defmac MEMORY_MOVE_COST (@var{mode}, @var{class}, @var{in}) | |
4448 | A C expression for the cost of moving data of mode @var{mode} between a | |
4449 | register of class @var{class} and memory; @var{in} is zero if the value | |
4450 | is to be written to memory, nonzero if it is to be read in. This cost | |
4451 | is relative to those in @code{REGISTER_MOVE_COST}. If moving between | |
4452 | registers and memory is more expensive than between two registers, you | |
4453 | should define this macro to express the relative cost. | |
4454 | ||
4455 | If you do not define this macro, GCC uses a default cost of 4 plus | |
4456 | the cost of copying via a secondary reload register, if one is | |
4457 | needed. If your machine requires a secondary reload register to copy | |
4458 | between memory and a register of @var{class} but the reload mechanism is | |
4459 | more complex than copying via an intermediate, define this macro to | |
4460 | reflect the actual cost of the move. | |
4461 | ||
4462 | GCC defines the function @code{memory_move_secondary_cost} if | |
4463 | secondary reloads are needed. It computes the costs due to copying via | |
4464 | a secondary register. If your machine copies from memory using a | |
4465 | secondary register in the conventional way but the default base value of | |
4466 | 4 is not correct for your machine, define this macro to add some other | |
4467 | value to the result of that function. The arguments to that function | |
4468 | are the same as to this macro. | |
4469 | ||
4470 | These macros are obsolete, new ports should use the target hook | |
4471 | @code{TARGET_MEMORY_MOVE_COST} instead. | |
4472 | @end defmac | |
4473 | ||
911852ff | 4474 | @hook TARGET_MEMORY_MOVE_COST |
38f8b050 JR |
4475 | |
4476 | @defmac BRANCH_COST (@var{speed_p}, @var{predictable_p}) | |
525d13b0 MS |
4477 | A C expression for the cost of a branch instruction. A value of 1 is |
4478 | the default; other values are interpreted relative to that. Parameter | |
4479 | @var{speed_p} is true when the branch in question should be optimized | |
4480 | for speed. When it is false, @code{BRANCH_COST} should return a value | |
4481 | optimal for code size rather than performance. @var{predictable_p} is | |
4482 | true for well-predicted branches. On many architectures the | |
4483 | @code{BRANCH_COST} can be reduced then. | |
38f8b050 JR |
4484 | @end defmac |
4485 | ||
4486 | Here are additional macros which do not specify precise relative costs, | |
4487 | but only that certain actions are more expensive than GCC would | |
4488 | ordinarily expect. | |
4489 | ||
4490 | @defmac SLOW_BYTE_ACCESS | |
4491 | Define this macro as a C expression which is nonzero if accessing less | |
4492 | than a word of memory (i.e.@: a @code{char} or a @code{short}) is no | |
4493 | faster than accessing a word of memory, i.e., if such access | |
4494 | require more than one instruction or if there is no difference in cost | |
4495 | between byte and (aligned) word loads. | |
4496 | ||
4497 | When this macro is not defined, the compiler will access a field by | |
4498 | finding the smallest containing object; when it is defined, a fullword | |
4499 | load will be used if alignment permits. Unless bytes accesses are | |
4500 | faster than word accesses, using word accesses is preferable since it | |
4501 | may eliminate subsequent memory access if subsequent accesses occur to | |
4502 | other fields in the same word of the structure, but to different bytes. | |
4503 | @end defmac | |
4504 | ||
e0bd6c9f | 4505 | @hook TARGET_SLOW_UNALIGNED_ACCESS |
38f8b050 JR |
4506 | |
4507 | @defmac MOVE_RATIO (@var{speed}) | |
4508 | The threshold of number of scalar memory-to-memory move insns, @emph{below} | |
4509 | which a sequence of insns should be generated instead of a | |
4510 | string move insn or a library call. Increasing the value will always | |
4511 | make code faster, but eventually incurs high cost in increased code size. | |
4512 | ||
4513 | Note that on machines where the corresponding move insn is a | |
4514 | @code{define_expand} that emits a sequence of insns, this macro counts | |
4515 | the number of such sequences. | |
4516 | ||
4517 | The parameter @var{speed} is true if the code is currently being | |
4518 | optimized for speed rather than size. | |
4519 | ||
4520 | If you don't define this, a reasonable default is used. | |
4521 | @end defmac | |
4522 | ||
7cbed008 JG |
4523 | @hook TARGET_USE_BY_PIECES_INFRASTRUCTURE_P |
4524 | ||
985b3a68 L |
4525 | @hook TARGET_OVERLAP_OP_BY_PIECES_P |
4526 | ||
36b85e43 BS |
4527 | @hook TARGET_COMPARE_BY_PIECES_BRANCH_RATIO |
4528 | ||
38f8b050 JR |
4529 | @defmac MOVE_MAX_PIECES |
4530 | A C expression used by @code{move_by_pieces} to determine the largest unit | |
4531 | a load or store used to copy memory is. Defaults to @code{MOVE_MAX}. | |
4532 | @end defmac | |
4533 | ||
36b85e43 BS |
4534 | @defmac STORE_MAX_PIECES |
4535 | A C expression used by @code{store_by_pieces} to determine the largest unit | |
4536 | a store used to memory is. Defaults to @code{MOVE_MAX_PIECES}, or two times | |
4537 | the size of @code{HOST_WIDE_INT}, whichever is smaller. | |
4538 | @end defmac | |
4539 | ||
4540 | @defmac COMPARE_MAX_PIECES | |
4541 | A C expression used by @code{compare_by_pieces} to determine the largest unit | |
4542 | a load or store used to compare memory is. Defaults to | |
4543 | @code{MOVE_MAX_PIECES}. | |
4544 | @end defmac | |
4545 | ||
38f8b050 JR |
4546 | @defmac CLEAR_RATIO (@var{speed}) |
4547 | The threshold of number of scalar move insns, @emph{below} which a sequence | |
4548 | of insns should be generated to clear memory instead of a string clear insn | |
4549 | or a library call. Increasing the value will always make code faster, but | |
4550 | eventually incurs high cost in increased code size. | |
4551 | ||
4552 | The parameter @var{speed} is true if the code is currently being | |
4553 | optimized for speed rather than size. | |
4554 | ||
4555 | If you don't define this, a reasonable default is used. | |
4556 | @end defmac | |
4557 | ||
38f8b050 JR |
4558 | @defmac SET_RATIO (@var{speed}) |
4559 | The threshold of number of scalar move insns, @emph{below} which a sequence | |
4560 | of insns should be generated to set memory to a constant value, instead of | |
ff2ce160 | 4561 | a block set insn or a library call. |
38f8b050 JR |
4562 | Increasing the value will always make code faster, but |
4563 | eventually incurs high cost in increased code size. | |
4564 | ||
4565 | The parameter @var{speed} is true if the code is currently being | |
4566 | optimized for speed rather than size. | |
4567 | ||
4568 | If you don't define this, it defaults to the value of @code{MOVE_RATIO}. | |
4569 | @end defmac | |
4570 | ||
38f8b050 JR |
4571 | @defmac USE_LOAD_POST_INCREMENT (@var{mode}) |
4572 | A C expression used to determine whether a load postincrement is a good | |
4573 | thing to use for a given mode. Defaults to the value of | |
4574 | @code{HAVE_POST_INCREMENT}. | |
4575 | @end defmac | |
4576 | ||
4577 | @defmac USE_LOAD_POST_DECREMENT (@var{mode}) | |
4578 | A C expression used to determine whether a load postdecrement is a good | |
4579 | thing to use for a given mode. Defaults to the value of | |
4580 | @code{HAVE_POST_DECREMENT}. | |
4581 | @end defmac | |
4582 | ||
4583 | @defmac USE_LOAD_PRE_INCREMENT (@var{mode}) | |
4584 | A C expression used to determine whether a load preincrement is a good | |
4585 | thing to use for a given mode. Defaults to the value of | |
4586 | @code{HAVE_PRE_INCREMENT}. | |
4587 | @end defmac | |
4588 | ||
4589 | @defmac USE_LOAD_PRE_DECREMENT (@var{mode}) | |
4590 | A C expression used to determine whether a load predecrement is a good | |
4591 | thing to use for a given mode. Defaults to the value of | |
4592 | @code{HAVE_PRE_DECREMENT}. | |
4593 | @end defmac | |
4594 | ||
4595 | @defmac USE_STORE_POST_INCREMENT (@var{mode}) | |
4596 | A C expression used to determine whether a store postincrement is a good | |
4597 | thing to use for a given mode. Defaults to the value of | |
4598 | @code{HAVE_POST_INCREMENT}. | |
4599 | @end defmac | |
4600 | ||
4601 | @defmac USE_STORE_POST_DECREMENT (@var{mode}) | |
4602 | A C expression used to determine whether a store postdecrement is a good | |
4603 | thing to use for a given mode. Defaults to the value of | |
4604 | @code{HAVE_POST_DECREMENT}. | |
4605 | @end defmac | |
4606 | ||
4607 | @defmac USE_STORE_PRE_INCREMENT (@var{mode}) | |
4608 | This macro is used to determine whether a store preincrement is a good | |
4609 | thing to use for a given mode. Defaults to the value of | |
4610 | @code{HAVE_PRE_INCREMENT}. | |
4611 | @end defmac | |
4612 | ||
4613 | @defmac USE_STORE_PRE_DECREMENT (@var{mode}) | |
4614 | This macro is used to determine whether a store predecrement is a good | |
4615 | thing to use for a given mode. Defaults to the value of | |
4616 | @code{HAVE_PRE_DECREMENT}. | |
4617 | @end defmac | |
4618 | ||
4619 | @defmac NO_FUNCTION_CSE | |
1e8552c2 | 4620 | Define this macro to be true if it is as good or better to call a constant |
38f8b050 JR |
4621 | function address than to call an address kept in a register. |
4622 | @end defmac | |
4623 | ||
a8d56c30 SB |
4624 | @defmac LOGICAL_OP_NON_SHORT_CIRCUIT |
4625 | Define this macro if a non-short-circuit operation produced by | |
4626 | @samp{fold_range_test ()} is optimal. This macro defaults to true if | |
4627 | @code{BRANCH_COST} is greater than or equal to the value 2. | |
4628 | @end defmac | |
4629 | ||
d95ab70a RS |
4630 | @hook TARGET_OPTAB_SUPPORTED_P |
4631 | ||
38f8b050 | 4632 | @hook TARGET_RTX_COSTS |
38f8b050 JR |
4633 | |
4634 | @hook TARGET_ADDRESS_COST | |
38f8b050 | 4635 | |
94105f5c SB |
4636 | @hook TARGET_INSN_COST |
4637 | ||
e914c11a JG |
4638 | @hook TARGET_MAX_NOCE_IFCVT_SEQ_COST |
4639 | ||
d16e2ddd JJ |
4640 | @hook TARGET_NOCE_CONVERSION_PROFITABLE_P |
4641 | ||
de6320a8 CB |
4642 | @hook TARGET_NEW_ADDRESS_PROFITABLE_P |
4643 | ||
f52a73a4 SD |
4644 | @hook TARGET_NO_SPECULATION_IN_DELAY_SLOTS_P |
4645 | ||
e535b963 RS |
4646 | @hook TARGET_ESTIMATED_POLY_VALUE |
4647 | ||
38f8b050 JR |
4648 | @node Scheduling |
4649 | @section Adjusting the Instruction Scheduler | |
4650 | ||
4651 | The instruction scheduler may need a fair amount of machine-specific | |
4652 | adjustment in order to produce good code. GCC provides several target | |
4653 | hooks for this purpose. It is usually enough to define just a few of | |
4654 | them: try the first ones in this list first. | |
4655 | ||
4656 | @hook TARGET_SCHED_ISSUE_RATE | |
38f8b050 JR |
4657 | |
4658 | @hook TARGET_SCHED_VARIABLE_ISSUE | |
38f8b050 JR |
4659 | |
4660 | @hook TARGET_SCHED_ADJUST_COST | |
38f8b050 JR |
4661 | |
4662 | @hook TARGET_SCHED_ADJUST_PRIORITY | |
38f8b050 JR |
4663 | |
4664 | @hook TARGET_SCHED_REORDER | |
38f8b050 JR |
4665 | |
4666 | @hook TARGET_SCHED_REORDER2 | |
38f8b050 | 4667 | |
0dc41f28 WM |
4668 | @hook TARGET_SCHED_MACRO_FUSION_P |
4669 | ||
4670 | @hook TARGET_SCHED_MACRO_FUSION_PAIR_P | |
4671 | ||
38f8b050 | 4672 | @hook TARGET_SCHED_DEPENDENCIES_EVALUATION_HOOK |
38f8b050 JR |
4673 | |
4674 | @hook TARGET_SCHED_INIT | |
38f8b050 JR |
4675 | |
4676 | @hook TARGET_SCHED_FINISH | |
38f8b050 JR |
4677 | |
4678 | @hook TARGET_SCHED_INIT_GLOBAL | |
38f8b050 JR |
4679 | |
4680 | @hook TARGET_SCHED_FINISH_GLOBAL | |
38f8b050 JR |
4681 | |
4682 | @hook TARGET_SCHED_DFA_PRE_CYCLE_INSN | |
38f8b050 JR |
4683 | |
4684 | @hook TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN | |
38f8b050 JR |
4685 | |
4686 | @hook TARGET_SCHED_DFA_POST_CYCLE_INSN | |
38f8b050 JR |
4687 | |
4688 | @hook TARGET_SCHED_INIT_DFA_POST_CYCLE_INSN | |
38f8b050 JR |
4689 | |
4690 | @hook TARGET_SCHED_DFA_PRE_ADVANCE_CYCLE | |
38f8b050 JR |
4691 | |
4692 | @hook TARGET_SCHED_DFA_POST_ADVANCE_CYCLE | |
38f8b050 JR |
4693 | |
4694 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD | |
38f8b050 JR |
4695 | |
4696 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD | |
4697 | ||
894fd6f2 | 4698 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_BEGIN |
894fd6f2 MK |
4699 | |
4700 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_ISSUE | |
894fd6f2 MK |
4701 | |
4702 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_BACKTRACK | |
894fd6f2 MK |
4703 | |
4704 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_END | |
894fd6f2 MK |
4705 | |
4706 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_INIT | |
894fd6f2 MK |
4707 | |
4708 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_FINI | |
894fd6f2 | 4709 | |
c06bbdf7 | 4710 | @hook TARGET_SCHED_DFA_NEW_CYCLE |
38f8b050 JR |
4711 | |
4712 | @hook TARGET_SCHED_IS_COSTLY_DEPENDENCE | |
38f8b050 JR |
4713 | |
4714 | @hook TARGET_SCHED_H_I_D_EXTENDED | |
38f8b050 JR |
4715 | |
4716 | @hook TARGET_SCHED_ALLOC_SCHED_CONTEXT | |
38f8b050 JR |
4717 | |
4718 | @hook TARGET_SCHED_INIT_SCHED_CONTEXT | |
38f8b050 JR |
4719 | |
4720 | @hook TARGET_SCHED_SET_SCHED_CONTEXT | |
38f8b050 JR |
4721 | |
4722 | @hook TARGET_SCHED_CLEAR_SCHED_CONTEXT | |
38f8b050 JR |
4723 | |
4724 | @hook TARGET_SCHED_FREE_SCHED_CONTEXT | |
38f8b050 JR |
4725 | |
4726 | @hook TARGET_SCHED_SPECULATE_INSN | |
38f8b050 JR |
4727 | |
4728 | @hook TARGET_SCHED_NEEDS_BLOCK_P | |
38f8b050 JR |
4729 | |
4730 | @hook TARGET_SCHED_GEN_SPEC_CHECK | |
38f8b050 | 4731 | |
38f8b050 | 4732 | @hook TARGET_SCHED_SET_SCHED_FLAGS |
38f8b050 | 4733 | |
176274c9 SB |
4734 | @hook TARGET_SCHED_CAN_SPECULATE_INSN |
4735 | ||
38f8b050 | 4736 | @hook TARGET_SCHED_SMS_RES_MII |
38f8b050 | 4737 | |
7942e47e | 4738 | @hook TARGET_SCHED_DISPATCH |
7942e47e RY |
4739 | |
4740 | @hook TARGET_SCHED_DISPATCH_DO | |
7942e47e | 4741 | |
b0bd15f7 BS |
4742 | @hook TARGET_SCHED_EXPOSED_PIPELINE |
4743 | ||
df7b0cc4 EI |
4744 | @hook TARGET_SCHED_REASSOCIATION_WIDTH |
4745 | ||
b16abbcb BC |
4746 | @hook TARGET_SCHED_FUSION_PRIORITY |
4747 | ||
e72531b9 PK |
4748 | @hook TARGET_EXPAND_DIVMOD_LIBFUNC |
4749 | ||
38f8b050 JR |
4750 | @node Sections |
4751 | @section Dividing the Output into Sections (Texts, Data, @dots{}) | |
4752 | @c the above section title is WAY too long. maybe cut the part between | |
4753 | @c the (...)? --mew 10feb93 | |
4754 | ||
4755 | An object file is divided into sections containing different types of | |
4756 | data. In the most common case, there are three sections: the @dfn{text | |
4757 | section}, which holds instructions and read-only data; the @dfn{data | |
4758 | section}, which holds initialized writable data; and the @dfn{bss | |
4759 | section}, which holds uninitialized data. Some systems have other kinds | |
4760 | of sections. | |
4761 | ||
4762 | @file{varasm.c} provides several well-known sections, such as | |
4763 | @code{text_section}, @code{data_section} and @code{bss_section}. | |
4764 | The normal way of controlling a @code{@var{foo}_section} variable | |
4765 | is to define the associated @code{@var{FOO}_SECTION_ASM_OP} macro, | |
4766 | as described below. The macros are only read once, when @file{varasm.c} | |
4767 | initializes itself, so their values must be run-time constants. | |
4768 | They may however depend on command-line flags. | |
4769 | ||
4770 | @emph{Note:} Some run-time files, such @file{crtstuff.c}, also make | |
4771 | use of the @code{@var{FOO}_SECTION_ASM_OP} macros, and expect them | |
4772 | to be string literals. | |
4773 | ||
4774 | Some assemblers require a different string to be written every time a | |
4775 | section is selected. If your assembler falls into this category, you | |
4776 | should define the @code{TARGET_ASM_INIT_SECTIONS} hook and use | |
4777 | @code{get_unnamed_section} to set up the sections. | |
4778 | ||
4779 | You must always create a @code{text_section}, either by defining | |
4780 | @code{TEXT_SECTION_ASM_OP} or by initializing @code{text_section} | |
4781 | in @code{TARGET_ASM_INIT_SECTIONS}. The same is true of | |
4782 | @code{data_section} and @code{DATA_SECTION_ASM_OP}. If you do not | |
4783 | create a distinct @code{readonly_data_section}, the default is to | |
4784 | reuse @code{text_section}. | |
4785 | ||
4786 | All the other @file{varasm.c} sections are optional, and are null | |
4787 | if the target does not provide them. | |
4788 | ||
4789 | @defmac TEXT_SECTION_ASM_OP | |
4790 | A C expression whose value is a string, including spacing, containing the | |
4791 | assembler operation that should precede instructions and read-only data. | |
4792 | Normally @code{"\t.text"} is right. | |
4793 | @end defmac | |
4794 | ||
4795 | @defmac HOT_TEXT_SECTION_NAME | |
4796 | If defined, a C string constant for the name of the section containing most | |
4797 | frequently executed functions of the program. If not defined, GCC will provide | |
4798 | a default definition if the target supports named sections. | |
4799 | @end defmac | |
4800 | ||
4801 | @defmac UNLIKELY_EXECUTED_TEXT_SECTION_NAME | |
4802 | If defined, a C string constant for the name of the section containing unlikely | |
4803 | executed functions in the program. | |
4804 | @end defmac | |
4805 | ||
4806 | @defmac DATA_SECTION_ASM_OP | |
4807 | A C expression whose value is a string, including spacing, containing the | |
4808 | assembler operation to identify the following data as writable initialized | |
4809 | data. Normally @code{"\t.data"} is right. | |
4810 | @end defmac | |
4811 | ||
4812 | @defmac SDATA_SECTION_ASM_OP | |
4813 | If defined, a C expression whose value is a string, including spacing, | |
4814 | containing the assembler operation to identify the following data as | |
4815 | initialized, writable small data. | |
4816 | @end defmac | |
4817 | ||
4818 | @defmac READONLY_DATA_SECTION_ASM_OP | |
4819 | A C expression whose value is a string, including spacing, containing the | |
4820 | assembler operation to identify the following data as read-only initialized | |
4821 | data. | |
4822 | @end defmac | |
4823 | ||
4824 | @defmac BSS_SECTION_ASM_OP | |
4825 | If defined, a C expression whose value is a string, including spacing, | |
4826 | containing the assembler operation to identify the following data as | |
07c5f94e AS |
4827 | uninitialized global data. If not defined, and |
4828 | @code{ASM_OUTPUT_ALIGNED_BSS} not defined, | |
38f8b050 JR |
4829 | uninitialized global data will be output in the data section if |
4830 | @option{-fno-common} is passed, otherwise @code{ASM_OUTPUT_COMMON} will be | |
4831 | used. | |
4832 | @end defmac | |
4833 | ||
4834 | @defmac SBSS_SECTION_ASM_OP | |
4835 | If defined, a C expression whose value is a string, including spacing, | |
4836 | containing the assembler operation to identify the following data as | |
4837 | uninitialized, writable small data. | |
4838 | @end defmac | |
4839 | ||
4840 | @defmac TLS_COMMON_ASM_OP | |
4841 | If defined, a C expression whose value is a string containing the | |
4842 | assembler operation to identify the following data as thread-local | |
4843 | common data. The default is @code{".tls_common"}. | |
4844 | @end defmac | |
4845 | ||
4846 | @defmac TLS_SECTION_ASM_FLAG | |
4847 | If defined, a C expression whose value is a character constant | |
4848 | containing the flag used to mark a section as a TLS section. The | |
4849 | default is @code{'T'}. | |
4850 | @end defmac | |
4851 | ||
4852 | @defmac INIT_SECTION_ASM_OP | |
4853 | If defined, a C expression whose value is a string, including spacing, | |
4854 | containing the assembler operation to identify the following data as | |
4855 | initialization code. If not defined, GCC will assume such a section does | |
4856 | not exist. This section has no corresponding @code{init_section} | |
4857 | variable; it is used entirely in runtime code. | |
4858 | @end defmac | |
4859 | ||
4860 | @defmac FINI_SECTION_ASM_OP | |
4861 | If defined, a C expression whose value is a string, including spacing, | |
4862 | containing the assembler operation to identify the following data as | |
4863 | finalization code. If not defined, GCC will assume such a section does | |
4864 | not exist. This section has no corresponding @code{fini_section} | |
4865 | variable; it is used entirely in runtime code. | |
4866 | @end defmac | |
4867 | ||
4868 | @defmac INIT_ARRAY_SECTION_ASM_OP | |
4869 | If defined, a C expression whose value is a string, including spacing, | |
4870 | containing the assembler operation to identify the following data as | |
4871 | part of the @code{.init_array} (or equivalent) section. If not | |
4872 | defined, GCC will assume such a section does not exist. Do not define | |
4873 | both this macro and @code{INIT_SECTION_ASM_OP}. | |
4874 | @end defmac | |
4875 | ||
4876 | @defmac FINI_ARRAY_SECTION_ASM_OP | |
4877 | If defined, a C expression whose value is a string, including spacing, | |
4878 | containing the assembler operation to identify the following data as | |
4879 | part of the @code{.fini_array} (or equivalent) section. If not | |
4880 | defined, GCC will assume such a section does not exist. Do not define | |
4881 | both this macro and @code{FINI_SECTION_ASM_OP}. | |
4882 | @end defmac | |
4883 | ||
b2eb4ed5 RO |
4884 | @defmac MACH_DEP_SECTION_ASM_FLAG |
4885 | If defined, a C expression whose value is a character constant | |
4886 | containing the flag used to mark a machine-dependent section. This | |
4887 | corresponds to the @code{SECTION_MACH_DEP} section flag. | |
4888 | @end defmac | |
4889 | ||
38f8b050 JR |
4890 | @defmac CRT_CALL_STATIC_FUNCTION (@var{section_op}, @var{function}) |
4891 | If defined, an ASM statement that switches to a different section | |
4892 | via @var{section_op}, calls @var{function}, and switches back to | |
4893 | the text section. This is used in @file{crtstuff.c} if | |
4894 | @code{INIT_SECTION_ASM_OP} or @code{FINI_SECTION_ASM_OP} to calls | |
4895 | to initialization and finalization functions from the init and fini | |
4896 | sections. By default, this macro uses a simple function call. Some | |
4897 | ports need hand-crafted assembly code to avoid dependencies on | |
4898 | registers initialized in the function prologue or to ensure that | |
4899 | constant pools don't end up too far way in the text section. | |
4900 | @end defmac | |
4901 | ||
4902 | @defmac TARGET_LIBGCC_SDATA_SECTION | |
4903 | If defined, a string which names the section into which small | |
4904 | variables defined in crtstuff and libgcc should go. This is useful | |
4905 | when the target has options for optimizing access to small data, and | |
4906 | you want the crtstuff and libgcc routines to be conservative in what | |
4907 | they expect of your application yet liberal in what your application | |
4908 | expects. For example, for targets with a @code{.sdata} section (like | |
4909 | MIPS), you could compile crtstuff with @code{-G 0} so that it doesn't | |
4910 | require small data support from your application, but use this macro | |
4911 | to put small data into @code{.sdata} so that your application can | |
4912 | access these variables whether it uses small data or not. | |
4913 | @end defmac | |
4914 | ||
4915 | @defmac FORCE_CODE_SECTION_ALIGN | |
4916 | If defined, an ASM statement that aligns a code section to some | |
4917 | arbitrary boundary. This is used to force all fragments of the | |
4918 | @code{.init} and @code{.fini} sections to have to same alignment | |
4919 | and thus prevent the linker from having to add any padding. | |
4920 | @end defmac | |
4921 | ||
4922 | @defmac JUMP_TABLES_IN_TEXT_SECTION | |
4923 | Define this macro to be an expression with a nonzero value if jump | |
4924 | tables (for @code{tablejump} insns) should be output in the text | |
4925 | section, along with the assembler instructions. Otherwise, the | |
4926 | readonly data section is used. | |
4927 | ||
4928 | This macro is irrelevant if there is no separate readonly data section. | |
4929 | @end defmac | |
4930 | ||
4931 | @hook TARGET_ASM_INIT_SECTIONS | |
38f8b050 JR |
4932 | |
4933 | @hook TARGET_ASM_RELOC_RW_MASK | |
38f8b050 | 4934 | |
af1682fc AS |
4935 | @hook TARGET_ASM_GENERATE_PIC_ADDR_DIFF_VEC |
4936 | ||
38f8b050 | 4937 | @hook TARGET_ASM_SELECT_SECTION |
38f8b050 JR |
4938 | |
4939 | @defmac USE_SELECT_SECTION_FOR_FUNCTIONS | |
4940 | Define this macro if you wish TARGET_ASM_SELECT_SECTION to be called | |
4941 | for @code{FUNCTION_DECL}s as well as for variables and constants. | |
4942 | ||
4943 | In the case of a @code{FUNCTION_DECL}, @var{reloc} will be zero if the | |
4944 | function has been determined to be likely to be called, and nonzero if | |
4945 | it is unlikely to be called. | |
4946 | @end defmac | |
4947 | ||
4948 | @hook TARGET_ASM_UNIQUE_SECTION | |
38f8b050 JR |
4949 | |
4950 | @hook TARGET_ASM_FUNCTION_RODATA_SECTION | |
38f8b050 | 4951 | |
727a65e6 BS |
4952 | @hook TARGET_ASM_MERGEABLE_RODATA_PREFIX |
4953 | ||
50b0b78a IS |
4954 | @hook TARGET_ASM_TM_CLONE_TABLE_SECTION |
4955 | ||
38f8b050 | 4956 | @hook TARGET_ASM_SELECT_RTX_SECTION |
38f8b050 JR |
4957 | |
4958 | @hook TARGET_MANGLE_DECL_ASSEMBLER_NAME | |
38f8b050 JR |
4959 | |
4960 | @hook TARGET_ENCODE_SECTION_INFO | |
38f8b050 JR |
4961 | |
4962 | @hook TARGET_STRIP_NAME_ENCODING | |
38f8b050 JR |
4963 | |
4964 | @hook TARGET_IN_SMALL_DATA_P | |
38f8b050 JR |
4965 | |
4966 | @hook TARGET_HAVE_SRODATA_SECTION | |
38f8b050 | 4967 | |
3c5273a9 KT |
4968 | @hook TARGET_PROFILE_BEFORE_PROLOGUE |
4969 | ||
38f8b050 | 4970 | @hook TARGET_BINDS_LOCAL_P |
38f8b050 JR |
4971 | |
4972 | @hook TARGET_HAVE_TLS | |
38f8b050 JR |
4973 | |
4974 | ||
4975 | @node PIC | |
4976 | @section Position Independent Code | |
4977 | @cindex position independent code | |
4978 | @cindex PIC | |
4979 | ||
4980 | This section describes macros that help implement generation of position | |
4981 | independent code. Simply defining these macros is not enough to | |
4982 | generate valid PIC; you must also add support to the hook | |
4983 | @code{TARGET_LEGITIMATE_ADDRESS_P} and to the macro | |
4984 | @code{PRINT_OPERAND_ADDRESS}, as well as @code{LEGITIMIZE_ADDRESS}. You | |
4985 | must modify the definition of @samp{movsi} to do something appropriate | |
4986 | when the source operand contains a symbolic address. You may also | |
4987 | need to alter the handling of switch statements so that they use | |
4988 | relative addresses. | |
ff2ce160 | 4989 | @c i rearranged the order of the macros above to try to force one of |
38f8b050 JR |
4990 | @c them to the next line, to eliminate an overfull hbox. --mew 10feb93 |
4991 | ||
4992 | @defmac PIC_OFFSET_TABLE_REGNUM | |
4993 | The register number of the register used to address a table of static | |
4994 | data addresses in memory. In some cases this register is defined by a | |
4995 | processor's ``application binary interface'' (ABI)@. When this macro | |
4996 | is defined, RTL is generated for this register once, as with the stack | |
4997 | pointer and frame pointer registers. If this macro is not defined, it | |
4998 | is up to the machine-dependent files to allocate such a register (if | |
4999 | necessary). Note that this register must be fixed when in use (e.g.@: | |
5000 | when @code{flag_pic} is true). | |
5001 | @end defmac | |
5002 | ||
5003 | @defmac PIC_OFFSET_TABLE_REG_CALL_CLOBBERED | |
f8fe0a4a JM |
5004 | A C expression that is nonzero if the register defined by |
5005 | @code{PIC_OFFSET_TABLE_REGNUM} is clobbered by calls. If not defined, | |
5006 | the default is zero. Do not define | |
38f8b050 JR |
5007 | this macro if @code{PIC_OFFSET_TABLE_REGNUM} is not defined. |
5008 | @end defmac | |
5009 | ||
5010 | @defmac LEGITIMATE_PIC_OPERAND_P (@var{x}) | |
5011 | A C expression that is nonzero if @var{x} is a legitimate immediate | |
5012 | operand on the target machine when generating position independent code. | |
5013 | You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not | |
5014 | check this. You can also assume @var{flag_pic} is true, so you need not | |
5015 | check it either. You need not define this macro if all constants | |
5016 | (including @code{SYMBOL_REF}) can be immediate operands when generating | |
5017 | position independent code. | |
5018 | @end defmac | |
5019 | ||
5020 | @node Assembler Format | |
5021 | @section Defining the Output Assembler Language | |
5022 | ||
5023 | This section describes macros whose principal purpose is to describe how | |
5024 | to write instructions in assembler language---rather than what the | |
5025 | instructions do. | |
5026 | ||
5027 | @menu | |
5028 | * File Framework:: Structural information for the assembler file. | |
5029 | * Data Output:: Output of constants (numbers, strings, addresses). | |
5030 | * Uninitialized Data:: Output of uninitialized variables. | |
5031 | * Label Output:: Output and generation of labels. | |
5032 | * Initialization:: General principles of initialization | |
5033 | and termination routines. | |
5034 | * Macros for Initialization:: | |
5035 | Specific macros that control the handling of | |
5036 | initialization and termination routines. | |
5037 | * Instruction Output:: Output of actual instructions. | |
5038 | * Dispatch Tables:: Output of jump tables. | |
5039 | * Exception Region Output:: Output of exception region code. | |
5040 | * Alignment Output:: Pseudo ops for alignment and skipping data. | |
5041 | @end menu | |
5042 | ||
5043 | @node File Framework | |
5044 | @subsection The Overall Framework of an Assembler File | |
5045 | @cindex assembler format | |
5046 | @cindex output of assembler code | |
5047 | ||
5048 | @c prevent bad page break with this line | |
5049 | This describes the overall framework of an assembly file. | |
5050 | ||
5051 | @findex default_file_start | |
5052 | @hook TARGET_ASM_FILE_START | |
38f8b050 JR |
5053 | |
5054 | @hook TARGET_ASM_FILE_START_APP_OFF | |
38f8b050 JR |
5055 | |
5056 | @hook TARGET_ASM_FILE_START_FILE_DIRECTIVE | |
38f8b050 JR |
5057 | |
5058 | @hook TARGET_ASM_FILE_END | |
38f8b050 JR |
5059 | |
5060 | @deftypefun void file_end_indicate_exec_stack () | |
5061 | Some systems use a common convention, the @samp{.note.GNU-stack} | |
5062 | special section, to indicate whether or not an object file relies on | |
5063 | the stack being executable. If your system uses this convention, you | |
5064 | should define @code{TARGET_ASM_FILE_END} to this function. If you | |
5065 | need to do other things in that hook, have your hook function call | |
5066 | this function. | |
5067 | @end deftypefun | |
5068 | ||
5069 | @hook TARGET_ASM_LTO_START | |
38f8b050 JR |
5070 | |
5071 | @hook TARGET_ASM_LTO_END | |
38f8b050 JR |
5072 | |
5073 | @hook TARGET_ASM_CODE_END | |
38f8b050 JR |
5074 | |
5075 | @defmac ASM_COMMENT_START | |
5076 | A C string constant describing how to begin a comment in the target | |
5077 | assembler language. The compiler assumes that the comment will end at | |
5078 | the end of the line. | |
5079 | @end defmac | |
5080 | ||
5081 | @defmac ASM_APP_ON | |
5082 | A C string constant for text to be output before each @code{asm} | |
5083 | statement or group of consecutive ones. Normally this is | |
5084 | @code{"#APP"}, which is a comment that has no effect on most | |
5085 | assemblers but tells the GNU assembler that it must check the lines | |
5086 | that follow for all valid assembler constructs. | |
5087 | @end defmac | |
5088 | ||
5089 | @defmac ASM_APP_OFF | |
5090 | A C string constant for text to be output after each @code{asm} | |
5091 | statement or group of consecutive ones. Normally this is | |
5092 | @code{"#NO_APP"}, which tells the GNU assembler to resume making the | |
5093 | time-saving assumptions that are valid for ordinary compiler output. | |
5094 | @end defmac | |
5095 | ||
5096 | @defmac ASM_OUTPUT_SOURCE_FILENAME (@var{stream}, @var{name}) | |
5097 | A C statement to output COFF information or DWARF debugging information | |
5098 | which indicates that filename @var{name} is the current source file to | |
5099 | the stdio stream @var{stream}. | |
5100 | ||
5101 | This macro need not be defined if the standard form of output | |
5102 | for the file format in use is appropriate. | |
5103 | @end defmac | |
5104 | ||
b5f5d41d AS |
5105 | @hook TARGET_ASM_OUTPUT_SOURCE_FILENAME |
5106 | ||
a8781821 SB |
5107 | @hook TARGET_ASM_OUTPUT_IDENT |
5108 | ||
38f8b050 JR |
5109 | @defmac OUTPUT_QUOTED_STRING (@var{stream}, @var{string}) |
5110 | A C statement to output the string @var{string} to the stdio stream | |
5111 | @var{stream}. If you do not call the function @code{output_quoted_string} | |
5112 | in your config files, GCC will only call it to output filenames to | |
5113 | the assembler source. So you can use it to canonicalize the format | |
5114 | of the filename using this macro. | |
5115 | @end defmac | |
5116 | ||
38f8b050 | 5117 | @hook TARGET_ASM_NAMED_SECTION |
38f8b050 | 5118 | |
0ee70cc0 AV |
5119 | @hook TARGET_ASM_ELF_FLAGS_NUMERIC |
5120 | ||
f16d3f39 | 5121 | @hook TARGET_ASM_FUNCTION_SECTION |
f16d3f39 | 5122 | |
14d11d40 IS |
5123 | @hook TARGET_ASM_FUNCTION_SWITCHED_TEXT_SECTIONS |
5124 | ||
38f8b050 JR |
5125 | @hook TARGET_HAVE_NAMED_SECTIONS |
5126 | This flag is true if the target supports @code{TARGET_ASM_NAMED_SECTION}. | |
d5fabb58 | 5127 | It must not be modified by command-line option processing. |
38f8b050 JR |
5128 | @end deftypevr |
5129 | ||
5130 | @anchor{TARGET_HAVE_SWITCHABLE_BSS_SECTIONS} | |
5131 | @hook TARGET_HAVE_SWITCHABLE_BSS_SECTIONS | |
38f8b050 JR |
5132 | |
5133 | @hook TARGET_SECTION_TYPE_FLAGS | |
38f8b050 JR |
5134 | |
5135 | @hook TARGET_ASM_RECORD_GCC_SWITCHES | |
38f8b050 JR |
5136 | |
5137 | @hook TARGET_ASM_RECORD_GCC_SWITCHES_SECTION | |
38f8b050 JR |
5138 | |
5139 | @need 2000 | |
5140 | @node Data Output | |
5141 | @subsection Output of Data | |
5142 | ||
5143 | ||
5144 | @hook TARGET_ASM_BYTE_OP | |
38f8b050 JR |
5145 | |
5146 | @hook TARGET_ASM_INTEGER | |
38f8b050 | 5147 | |
dc2af904 BS |
5148 | @hook TARGET_ASM_DECL_END |
5149 | ||
6cbd8875 | 5150 | @hook TARGET_ASM_OUTPUT_ADDR_CONST_EXTRA |
6cbd8875 | 5151 | |
38f8b050 JR |
5152 | @defmac ASM_OUTPUT_ASCII (@var{stream}, @var{ptr}, @var{len}) |
5153 | A C statement to output to the stdio stream @var{stream} an assembler | |
5154 | instruction to assemble a string constant containing the @var{len} | |
5155 | bytes at @var{ptr}. @var{ptr} will be a C expression of type | |
5156 | @code{char *} and @var{len} a C expression of type @code{int}. | |
5157 | ||
5158 | If the assembler has a @code{.ascii} pseudo-op as found in the | |
5159 | Berkeley Unix assembler, do not define the macro | |
5160 | @code{ASM_OUTPUT_ASCII}. | |
5161 | @end defmac | |
5162 | ||
5163 | @defmac ASM_OUTPUT_FDESC (@var{stream}, @var{decl}, @var{n}) | |
5164 | A C statement to output word @var{n} of a function descriptor for | |
5165 | @var{decl}. This must be defined if @code{TARGET_VTABLE_USES_DESCRIPTORS} | |
5166 | is defined, and is otherwise unused. | |
5167 | @end defmac | |
5168 | ||
5169 | @defmac CONSTANT_POOL_BEFORE_FUNCTION | |
5170 | You may define this macro as a C expression. You should define the | |
5171 | expression to have a nonzero value if GCC should output the constant | |
5172 | pool for a function before the code for the function, or a zero value if | |
5173 | GCC should output the constant pool after the function. If you do | |
5174 | not define this macro, the usual case, GCC will output the constant | |
5175 | pool before the function. | |
5176 | @end defmac | |
5177 | ||
5178 | @defmac ASM_OUTPUT_POOL_PROLOGUE (@var{file}, @var{funname}, @var{fundecl}, @var{size}) | |
5179 | A C statement to output assembler commands to define the start of the | |
5180 | constant pool for a function. @var{funname} is a string giving | |
5181 | the name of the function. Should the return type of the function | |
5182 | be required, it can be obtained via @var{fundecl}. @var{size} | |
5183 | is the size, in bytes, of the constant pool that will be written | |
5184 | immediately after this call. | |
5185 | ||
5186 | If no constant-pool prefix is required, the usual case, this macro need | |
5187 | not be defined. | |
5188 | @end defmac | |
5189 | ||
5190 | @defmac ASM_OUTPUT_SPECIAL_POOL_ENTRY (@var{file}, @var{x}, @var{mode}, @var{align}, @var{labelno}, @var{jumpto}) | |
5191 | A C statement (with or without semicolon) to output a constant in the | |
5192 | constant pool, if it needs special treatment. (This macro need not do | |
5193 | anything for RTL expressions that can be output normally.) | |
5194 | ||
5195 | The argument @var{file} is the standard I/O stream to output the | |
5196 | assembler code on. @var{x} is the RTL expression for the constant to | |
5197 | output, and @var{mode} is the machine mode (in case @var{x} is a | |
5198 | @samp{const_int}). @var{align} is the required alignment for the value | |
5199 | @var{x}; you should output an assembler directive to force this much | |
5200 | alignment. | |
5201 | ||
5202 | The argument @var{labelno} is a number to use in an internal label for | |
5203 | the address of this pool entry. The definition of this macro is | |
5204 | responsible for outputting the label definition at the proper place. | |
5205 | Here is how to do this: | |
5206 | ||
5207 | @smallexample | |
5208 | @code{(*targetm.asm_out.internal_label)} (@var{file}, "LC", @var{labelno}); | |
5209 | @end smallexample | |
5210 | ||
5211 | When you output a pool entry specially, you should end with a | |
5212 | @code{goto} to the label @var{jumpto}. This will prevent the same pool | |
5213 | entry from being output a second time in the usual manner. | |
5214 | ||
5215 | You need not define this macro if it would do nothing. | |
5216 | @end defmac | |
5217 | ||
5218 | @defmac ASM_OUTPUT_POOL_EPILOGUE (@var{file} @var{funname} @var{fundecl} @var{size}) | |
5219 | A C statement to output assembler commands to at the end of the constant | |
5220 | pool for a function. @var{funname} is a string giving the name of the | |
5221 | function. Should the return type of the function be required, you can | |
5222 | obtain it via @var{fundecl}. @var{size} is the size, in bytes, of the | |
5223 | constant pool that GCC wrote immediately before this call. | |
5224 | ||
5225 | If no constant-pool epilogue is required, the usual case, you need not | |
5226 | define this macro. | |
5227 | @end defmac | |
5228 | ||
5229 | @defmac IS_ASM_LOGICAL_LINE_SEPARATOR (@var{C}, @var{STR}) | |
5230 | Define this macro as a C expression which is nonzero if @var{C} is | |
5231 | used as a logical line separator by the assembler. @var{STR} points | |
5232 | to the position in the string where @var{C} was found; this can be used if | |
5233 | a line separator uses multiple characters. | |
5234 | ||
5235 | If you do not define this macro, the default is that only | |
5236 | the character @samp{;} is treated as a logical line separator. | |
5237 | @end defmac | |
5238 | ||
5239 | @hook TARGET_ASM_OPEN_PAREN | |
38f8b050 JR |
5240 | |
5241 | These macros are provided by @file{real.h} for writing the definitions | |
5242 | of @code{ASM_OUTPUT_DOUBLE} and the like: | |
5243 | ||
5244 | @defmac REAL_VALUE_TO_TARGET_SINGLE (@var{x}, @var{l}) | |
5245 | @defmacx REAL_VALUE_TO_TARGET_DOUBLE (@var{x}, @var{l}) | |
5246 | @defmacx REAL_VALUE_TO_TARGET_LONG_DOUBLE (@var{x}, @var{l}) | |
5247 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL32 (@var{x}, @var{l}) | |
5248 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL64 (@var{x}, @var{l}) | |
5249 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL128 (@var{x}, @var{l}) | |
5250 | These translate @var{x}, of type @code{REAL_VALUE_TYPE}, to the | |
5251 | target's floating point representation, and store its bit pattern in | |
5252 | the variable @var{l}. For @code{REAL_VALUE_TO_TARGET_SINGLE} and | |
5253 | @code{REAL_VALUE_TO_TARGET_DECIMAL32}, this variable should be a | |
5254 | simple @code{long int}. For the others, it should be an array of | |
5255 | @code{long int}. The number of elements in this array is determined | |
5256 | by the size of the desired target floating point data type: 32 bits of | |
5257 | it go in each @code{long int} array element. Each array element holds | |
5258 | 32 bits of the result, even if @code{long int} is wider than 32 bits | |
5259 | on the host machine. | |
5260 | ||
5261 | The array element values are designed so that you can print them out | |
5262 | using @code{fprintf} in the order they should appear in the target | |
5263 | machine's memory. | |
5264 | @end defmac | |
5265 | ||
5266 | @node Uninitialized Data | |
5267 | @subsection Output of Uninitialized Variables | |
5268 | ||
5269 | Each of the macros in this section is used to do the whole job of | |
5270 | outputting a single uninitialized variable. | |
5271 | ||
5272 | @defmac ASM_OUTPUT_COMMON (@var{stream}, @var{name}, @var{size}, @var{rounded}) | |
5273 | A C statement (sans semicolon) to output to the stdio stream | |
5274 | @var{stream} the assembler definition of a common-label named | |
5275 | @var{name} whose size is @var{size} bytes. The variable @var{rounded} | |
5276 | is the size rounded up to whatever alignment the caller wants. It is | |
5277 | possible that @var{size} may be zero, for instance if a struct with no | |
5278 | other member than a zero-length array is defined. In this case, the | |
5279 | backend must output a symbol definition that allocates at least one | |
5280 | byte, both so that the address of the resulting object does not compare | |
5281 | equal to any other, and because some object formats cannot even express | |
5282 | the concept of a zero-sized common symbol, as that is how they represent | |
5283 | an ordinary undefined external. | |
5284 | ||
5285 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
5286 | output the name itself; before and after that, output the additional | |
5287 | assembler syntax for defining the name, and a newline. | |
5288 | ||
5289 | This macro controls how the assembler definitions of uninitialized | |
5290 | common global variables are output. | |
5291 | @end defmac | |
5292 | ||
5293 | @defmac ASM_OUTPUT_ALIGNED_COMMON (@var{stream}, @var{name}, @var{size}, @var{alignment}) | |
5294 | Like @code{ASM_OUTPUT_COMMON} except takes the required alignment as a | |
5295 | separate, explicit argument. If you define this macro, it is used in | |
5296 | place of @code{ASM_OUTPUT_COMMON}, and gives you more flexibility in | |
5297 | handling the required alignment of the variable. The alignment is specified | |
5298 | as the number of bits. | |
5299 | @end defmac | |
5300 | ||
5301 | @defmac ASM_OUTPUT_ALIGNED_DECL_COMMON (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) | |
5302 | Like @code{ASM_OUTPUT_ALIGNED_COMMON} except that @var{decl} of the | |
5303 | variable to be output, if there is one, or @code{NULL_TREE} if there | |
5304 | is no corresponding variable. If you define this macro, GCC will use it | |
5305 | in place of both @code{ASM_OUTPUT_COMMON} and | |
5306 | @code{ASM_OUTPUT_ALIGNED_COMMON}. Define this macro when you need to see | |
5307 | the variable's decl in order to chose what to output. | |
5308 | @end defmac | |
5309 | ||
07c5f94e | 5310 | @defmac ASM_OUTPUT_ALIGNED_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) |
38f8b050 JR |
5311 | A C statement (sans semicolon) to output to the stdio stream |
5312 | @var{stream} the assembler definition of uninitialized global @var{decl} named | |
07c5f94e AS |
5313 | @var{name} whose size is @var{size} bytes. The variable @var{alignment} |
5314 | is the alignment specified as the number of bits. | |
38f8b050 | 5315 | |
07c5f94e AS |
5316 | Try to use function @code{asm_output_aligned_bss} defined in file |
5317 | @file{varasm.c} when defining this macro. If unable, use the expression | |
38f8b050 JR |
5318 | @code{assemble_name (@var{stream}, @var{name})} to output the name itself; |
5319 | before and after that, output the additional assembler syntax for defining | |
5320 | the name, and a newline. | |
5321 | ||
07c5f94e | 5322 | There are two ways of handling global BSS@. One is to define this macro. |
38f8b050 JR |
5323 | The other is to have @code{TARGET_ASM_SELECT_SECTION} return a |
5324 | switchable BSS section (@pxref{TARGET_HAVE_SWITCHABLE_BSS_SECTIONS}). | |
5325 | You do not need to do both. | |
5326 | ||
5327 | Some languages do not have @code{common} data, and require a | |
5328 | non-common form of global BSS in order to handle uninitialized globals | |
5329 | efficiently. C++ is one example of this. However, if the target does | |
5330 | not support global BSS, the front end may choose to make globals | |
5331 | common in order to save space in the object file. | |
5332 | @end defmac | |
5333 | ||
38f8b050 JR |
5334 | @defmac ASM_OUTPUT_LOCAL (@var{stream}, @var{name}, @var{size}, @var{rounded}) |
5335 | A C statement (sans semicolon) to output to the stdio stream | |
5336 | @var{stream} the assembler definition of a local-common-label named | |
5337 | @var{name} whose size is @var{size} bytes. The variable @var{rounded} | |
5338 | is the size rounded up to whatever alignment the caller wants. | |
5339 | ||
5340 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
5341 | output the name itself; before and after that, output the additional | |
5342 | assembler syntax for defining the name, and a newline. | |
5343 | ||
5344 | This macro controls how the assembler definitions of uninitialized | |
5345 | static variables are output. | |
5346 | @end defmac | |
5347 | ||
5348 | @defmac ASM_OUTPUT_ALIGNED_LOCAL (@var{stream}, @var{name}, @var{size}, @var{alignment}) | |
5349 | Like @code{ASM_OUTPUT_LOCAL} except takes the required alignment as a | |
5350 | separate, explicit argument. If you define this macro, it is used in | |
5351 | place of @code{ASM_OUTPUT_LOCAL}, and gives you more flexibility in | |
5352 | handling the required alignment of the variable. The alignment is specified | |
5353 | as the number of bits. | |
5354 | @end defmac | |
5355 | ||
5356 | @defmac ASM_OUTPUT_ALIGNED_DECL_LOCAL (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) | |
b73f6902 | 5357 | Like @code{ASM_OUTPUT_ALIGNED_LOCAL} except that @var{decl} of the |
38f8b050 JR |
5358 | variable to be output, if there is one, or @code{NULL_TREE} if there |
5359 | is no corresponding variable. If you define this macro, GCC will use it | |
b73f6902 JJ |
5360 | in place of both @code{ASM_OUTPUT_LOCAL} and |
5361 | @code{ASM_OUTPUT_ALIGNED_LOCAL}. Define this macro when you need to see | |
38f8b050 JR |
5362 | the variable's decl in order to chose what to output. |
5363 | @end defmac | |
5364 | ||
5365 | @node Label Output | |
5366 | @subsection Output and Generation of Labels | |
5367 | ||
5368 | @c prevent bad page break with this line | |
5369 | This is about outputting labels. | |
5370 | ||
5371 | @findex assemble_name | |
5372 | @defmac ASM_OUTPUT_LABEL (@var{stream}, @var{name}) | |
5373 | A C statement (sans semicolon) to output to the stdio stream | |
5374 | @var{stream} the assembler definition of a label named @var{name}. | |
5375 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
5376 | output the name itself; before and after that, output the additional | |
5377 | assembler syntax for defining the name, and a newline. A default | |
5378 | definition of this macro is provided which is correct for most systems. | |
5379 | @end defmac | |
5380 | ||
135a687e KT |
5381 | @defmac ASM_OUTPUT_FUNCTION_LABEL (@var{stream}, @var{name}, @var{decl}) |
5382 | A C statement (sans semicolon) to output to the stdio stream | |
5383 | @var{stream} the assembler definition of a label named @var{name} of | |
5384 | a function. | |
5385 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
5386 | output the name itself; before and after that, output the additional | |
5387 | assembler syntax for defining the name, and a newline. A default | |
5388 | definition of this macro is provided which is correct for most systems. | |
5389 | ||
5390 | If this macro is not defined, then the function name is defined in the | |
5391 | usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}). | |
5392 | @end defmac | |
5393 | ||
38f8b050 JR |
5394 | @findex assemble_name_raw |
5395 | @defmac ASM_OUTPUT_INTERNAL_LABEL (@var{stream}, @var{name}) | |
5396 | Identical to @code{ASM_OUTPUT_LABEL}, except that @var{name} is known | |
5397 | to refer to a compiler-generated label. The default definition uses | |
5398 | @code{assemble_name_raw}, which is like @code{assemble_name} except | |
5399 | that it is more efficient. | |
5400 | @end defmac | |
5401 | ||
5402 | @defmac SIZE_ASM_OP | |
5403 | A C string containing the appropriate assembler directive to specify the | |
5404 | size of a symbol, without any arguments. On systems that use ELF, the | |
5405 | default (in @file{config/elfos.h}) is @samp{"\t.size\t"}; on other | |
5406 | systems, the default is not to define this macro. | |
5407 | ||
5408 | Define this macro only if it is correct to use the default definitions | |
5409 | of @code{ASM_OUTPUT_SIZE_DIRECTIVE} and @code{ASM_OUTPUT_MEASURED_SIZE} | |
5410 | for your system. If you need your own custom definitions of those | |
5411 | macros, or if you do not need explicit symbol sizes at all, do not | |
5412 | define this macro. | |
5413 | @end defmac | |
5414 | ||
5415 | @defmac ASM_OUTPUT_SIZE_DIRECTIVE (@var{stream}, @var{name}, @var{size}) | |
5416 | A C statement (sans semicolon) to output to the stdio stream | |
5417 | @var{stream} a directive telling the assembler that the size of the | |
5418 | symbol @var{name} is @var{size}. @var{size} is a @code{HOST_WIDE_INT}. | |
5419 | If you define @code{SIZE_ASM_OP}, a default definition of this macro is | |
5420 | provided. | |
5421 | @end defmac | |
5422 | ||
5423 | @defmac ASM_OUTPUT_MEASURED_SIZE (@var{stream}, @var{name}) | |
5424 | A C statement (sans semicolon) to output to the stdio stream | |
5425 | @var{stream} a directive telling the assembler to calculate the size of | |
5426 | the symbol @var{name} by subtracting its address from the current | |
5427 | address. | |
5428 | ||
5429 | If you define @code{SIZE_ASM_OP}, a default definition of this macro is | |
5430 | provided. The default assumes that the assembler recognizes a special | |
5431 | @samp{.} symbol as referring to the current address, and can calculate | |
5432 | the difference between this and another symbol. If your assembler does | |
5433 | not recognize @samp{.} or cannot do calculations with it, you will need | |
5434 | to redefine @code{ASM_OUTPUT_MEASURED_SIZE} to use some other technique. | |
5435 | @end defmac | |
5436 | ||
e537ef59 GP |
5437 | @defmac NO_DOLLAR_IN_LABEL |
5438 | Define this macro if the assembler does not accept the character | |
5439 | @samp{$} in label names. By default constructors and destructors in | |
5440 | G++ have @samp{$} in the identifiers. If this macro is defined, | |
5441 | @samp{.} is used instead. | |
5442 | @end defmac | |
5443 | ||
5444 | @defmac NO_DOT_IN_LABEL | |
5445 | Define this macro if the assembler does not accept the character | |
5446 | @samp{.} in label names. By default constructors and destructors in G++ | |
5447 | have names that use @samp{.}. If this macro is defined, these names | |
5448 | are rewritten to avoid @samp{.}. | |
5449 | @end defmac | |
5450 | ||
38f8b050 JR |
5451 | @defmac TYPE_ASM_OP |
5452 | A C string containing the appropriate assembler directive to specify the | |
5453 | type of a symbol, without any arguments. On systems that use ELF, the | |
5454 | default (in @file{config/elfos.h}) is @samp{"\t.type\t"}; on other | |
5455 | systems, the default is not to define this macro. | |
5456 | ||
5457 | Define this macro only if it is correct to use the default definition of | |
5458 | @code{ASM_OUTPUT_TYPE_DIRECTIVE} for your system. If you need your own | |
5459 | custom definition of this macro, or if you do not need explicit symbol | |
5460 | types at all, do not define this macro. | |
5461 | @end defmac | |
5462 | ||
5463 | @defmac TYPE_OPERAND_FMT | |
5464 | A C string which specifies (using @code{printf} syntax) the format of | |
5465 | the second operand to @code{TYPE_ASM_OP}. On systems that use ELF, the | |
5466 | default (in @file{config/elfos.h}) is @samp{"@@%s"}; on other systems, | |
5467 | the default is not to define this macro. | |
5468 | ||
5469 | Define this macro only if it is correct to use the default definition of | |
5470 | @code{ASM_OUTPUT_TYPE_DIRECTIVE} for your system. If you need your own | |
5471 | custom definition of this macro, or if you do not need explicit symbol | |
5472 | types at all, do not define this macro. | |
5473 | @end defmac | |
5474 | ||
5475 | @defmac ASM_OUTPUT_TYPE_DIRECTIVE (@var{stream}, @var{type}) | |
5476 | A C statement (sans semicolon) to output to the stdio stream | |
5477 | @var{stream} a directive telling the assembler that the type of the | |
5478 | symbol @var{name} is @var{type}. @var{type} is a C string; currently, | |
5479 | that string is always either @samp{"function"} or @samp{"object"}, but | |
5480 | you should not count on this. | |
5481 | ||
5482 | If you define @code{TYPE_ASM_OP} and @code{TYPE_OPERAND_FMT}, a default | |
5483 | definition of this macro is provided. | |
5484 | @end defmac | |
5485 | ||
5486 | @defmac ASM_DECLARE_FUNCTION_NAME (@var{stream}, @var{name}, @var{decl}) | |
5487 | A C statement (sans semicolon) to output to the stdio stream | |
5488 | @var{stream} any text necessary for declaring the name @var{name} of a | |
5489 | function which is being defined. This macro is responsible for | |
5490 | outputting the label definition (perhaps using | |
135a687e | 5491 | @code{ASM_OUTPUT_FUNCTION_LABEL}). The argument @var{decl} is the |
38f8b050 JR |
5492 | @code{FUNCTION_DECL} tree node representing the function. |
5493 | ||
5494 | If this macro is not defined, then the function name is defined in the | |
135a687e | 5495 | usual manner as a label (by means of @code{ASM_OUTPUT_FUNCTION_LABEL}). |
38f8b050 JR |
5496 | |
5497 | You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in the definition | |
5498 | of this macro. | |
5499 | @end defmac | |
5500 | ||
5501 | @defmac ASM_DECLARE_FUNCTION_SIZE (@var{stream}, @var{name}, @var{decl}) | |
5502 | A C statement (sans semicolon) to output to the stdio stream | |
5503 | @var{stream} any text necessary for declaring the size of a function | |
5504 | which is being defined. The argument @var{name} is the name of the | |
5505 | function. The argument @var{decl} is the @code{FUNCTION_DECL} tree node | |
5506 | representing the function. | |
5507 | ||
5508 | If this macro is not defined, then the function size is not defined. | |
5509 | ||
5510 | You may wish to use @code{ASM_OUTPUT_MEASURED_SIZE} in the definition | |
5511 | of this macro. | |
5512 | @end defmac | |
5513 | ||
11c3d071 CT |
5514 | @defmac ASM_DECLARE_COLD_FUNCTION_NAME (@var{stream}, @var{name}, @var{decl}) |
5515 | A C statement (sans semicolon) to output to the stdio stream | |
5516 | @var{stream} any text necessary for declaring the name @var{name} of a | |
5517 | cold function partition which is being defined. This macro is responsible | |
5518 | for outputting the label definition (perhaps using | |
5519 | @code{ASM_OUTPUT_FUNCTION_LABEL}). The argument @var{decl} is the | |
5520 | @code{FUNCTION_DECL} tree node representing the function. | |
5521 | ||
5522 | If this macro is not defined, then the cold partition name is defined in the | |
5523 | usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}). | |
5524 | ||
5525 | You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in the definition | |
5526 | of this macro. | |
5527 | @end defmac | |
5528 | ||
5529 | @defmac ASM_DECLARE_COLD_FUNCTION_SIZE (@var{stream}, @var{name}, @var{decl}) | |
5530 | A C statement (sans semicolon) to output to the stdio stream | |
5531 | @var{stream} any text necessary for declaring the size of a cold function | |
5532 | partition which is being defined. The argument @var{name} is the name of the | |
5533 | cold partition of the function. The argument @var{decl} is the | |
5534 | @code{FUNCTION_DECL} tree node representing the function. | |
5535 | ||
5536 | If this macro is not defined, then the partition size is not defined. | |
5537 | ||
5538 | You may wish to use @code{ASM_OUTPUT_MEASURED_SIZE} in the definition | |
5539 | of this macro. | |
5540 | @end defmac | |
5541 | ||
38f8b050 JR |
5542 | @defmac ASM_DECLARE_OBJECT_NAME (@var{stream}, @var{name}, @var{decl}) |
5543 | A C statement (sans semicolon) to output to the stdio stream | |
5544 | @var{stream} any text necessary for declaring the name @var{name} of an | |
5545 | initialized variable which is being defined. This macro must output the | |
5546 | label definition (perhaps using @code{ASM_OUTPUT_LABEL}). The argument | |
5547 | @var{decl} is the @code{VAR_DECL} tree node representing the variable. | |
5548 | ||
5549 | If this macro is not defined, then the variable name is defined in the | |
5550 | usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}). | |
5551 | ||
5552 | You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} and/or | |
5553 | @code{ASM_OUTPUT_SIZE_DIRECTIVE} in the definition of this macro. | |
5554 | @end defmac | |
5555 | ||
ad78130c | 5556 | @hook TARGET_ASM_DECLARE_CONSTANT_NAME |
38f8b050 JR |
5557 | |
5558 | @defmac ASM_DECLARE_REGISTER_GLOBAL (@var{stream}, @var{decl}, @var{regno}, @var{name}) | |
5559 | A C statement (sans semicolon) to output to the stdio stream | |
5560 | @var{stream} any text necessary for claiming a register @var{regno} | |
5561 | for a global variable @var{decl} with name @var{name}. | |
5562 | ||
5563 | If you don't define this macro, that is equivalent to defining it to do | |
5564 | nothing. | |
5565 | @end defmac | |
5566 | ||
5567 | @defmac ASM_FINISH_DECLARE_OBJECT (@var{stream}, @var{decl}, @var{toplevel}, @var{atend}) | |
5568 | A C statement (sans semicolon) to finish up declaring a variable name | |
5569 | once the compiler has processed its initializer fully and thus has had a | |
5570 | chance to determine the size of an array when controlled by an | |
5571 | initializer. This is used on systems where it's necessary to declare | |
5572 | something about the size of the object. | |
5573 | ||
5574 | If you don't define this macro, that is equivalent to defining it to do | |
5575 | nothing. | |
5576 | ||
5577 | You may wish to use @code{ASM_OUTPUT_SIZE_DIRECTIVE} and/or | |
5578 | @code{ASM_OUTPUT_MEASURED_SIZE} in the definition of this macro. | |
5579 | @end defmac | |
5580 | ||
5581 | @hook TARGET_ASM_GLOBALIZE_LABEL | |
38f8b050 JR |
5582 | |
5583 | @hook TARGET_ASM_GLOBALIZE_DECL_NAME | |
38f8b050 | 5584 | |
0d4b5b86 BS |
5585 | @hook TARGET_ASM_ASSEMBLE_UNDEFINED_DECL |
5586 | ||
38f8b050 JR |
5587 | @defmac ASM_WEAKEN_LABEL (@var{stream}, @var{name}) |
5588 | A C statement (sans semicolon) to output to the stdio stream | |
5589 | @var{stream} some commands that will make the label @var{name} weak; | |
5590 | that is, available for reference from other files but only used if | |
5591 | no other definition is available. Use the expression | |
5592 | @code{assemble_name (@var{stream}, @var{name})} to output the name | |
5593 | itself; before and after that, output the additional assembler syntax | |
5594 | for making that name weak, and a newline. | |
5595 | ||
5596 | If you don't define this macro or @code{ASM_WEAKEN_DECL}, GCC will not | |
5597 | support weak symbols and you should not define the @code{SUPPORTS_WEAK} | |
5598 | macro. | |
5599 | @end defmac | |
5600 | ||
5601 | @defmac ASM_WEAKEN_DECL (@var{stream}, @var{decl}, @var{name}, @var{value}) | |
5602 | Combines (and replaces) the function of @code{ASM_WEAKEN_LABEL} and | |
5603 | @code{ASM_OUTPUT_WEAK_ALIAS}, allowing access to the associated function | |
5604 | or variable decl. If @var{value} is not @code{NULL}, this C statement | |
5605 | should output to the stdio stream @var{stream} assembler code which | |
5606 | defines (equates) the weak symbol @var{name} to have the value | |
5607 | @var{value}. If @var{value} is @code{NULL}, it should output commands | |
5608 | to make @var{name} weak. | |
5609 | @end defmac | |
5610 | ||
5611 | @defmac ASM_OUTPUT_WEAKREF (@var{stream}, @var{decl}, @var{name}, @var{value}) | |
5612 | Outputs a directive that enables @var{name} to be used to refer to | |
5613 | symbol @var{value} with weak-symbol semantics. @code{decl} is the | |
5614 | declaration of @code{name}. | |
5615 | @end defmac | |
5616 | ||
5617 | @defmac SUPPORTS_WEAK | |
74b90fe2 JDA |
5618 | A preprocessor constant expression which evaluates to true if the target |
5619 | supports weak symbols. | |
38f8b050 JR |
5620 | |
5621 | If you don't define this macro, @file{defaults.h} provides a default | |
5622 | definition. If either @code{ASM_WEAKEN_LABEL} or @code{ASM_WEAKEN_DECL} | |
74b90fe2 JDA |
5623 | is defined, the default definition is @samp{1}; otherwise, it is @samp{0}. |
5624 | @end defmac | |
5625 | ||
5626 | @defmac TARGET_SUPPORTS_WEAK | |
5627 | A C expression which evaluates to true if the target supports weak symbols. | |
5628 | ||
5629 | If you don't define this macro, @file{defaults.h} provides a default | |
5630 | definition. The default definition is @samp{(SUPPORTS_WEAK)}. Define | |
5631 | this macro if you want to control weak symbol support with a compiler | |
5632 | flag such as @option{-melf}. | |
38f8b050 JR |
5633 | @end defmac |
5634 | ||
5635 | @defmac MAKE_DECL_ONE_ONLY (@var{decl}) | |
5636 | A C statement (sans semicolon) to mark @var{decl} to be emitted as a | |
5637 | public symbol such that extra copies in multiple translation units will | |
5638 | be discarded by the linker. Define this macro if your object file | |
5639 | format provides support for this concept, such as the @samp{COMDAT} | |
5640 | section flags in the Microsoft Windows PE/COFF format, and this support | |
5641 | requires changes to @var{decl}, such as putting it in a separate section. | |
5642 | @end defmac | |
5643 | ||
5644 | @defmac SUPPORTS_ONE_ONLY | |
5645 | A C expression which evaluates to true if the target supports one-only | |
5646 | semantics. | |
5647 | ||
5648 | If you don't define this macro, @file{varasm.c} provides a default | |
5649 | definition. If @code{MAKE_DECL_ONE_ONLY} is defined, the default | |
5650 | definition is @samp{1}; otherwise, it is @samp{0}. Define this macro if | |
5651 | you want to control one-only symbol support with a compiler flag, or if | |
5652 | setting the @code{DECL_ONE_ONLY} flag is enough to mark a declaration to | |
5653 | be emitted as one-only. | |
5654 | @end defmac | |
5655 | ||
5656 | @hook TARGET_ASM_ASSEMBLE_VISIBILITY | |
38f8b050 JR |
5657 | |
5658 | @defmac TARGET_WEAK_NOT_IN_ARCHIVE_TOC | |
5659 | A C expression that evaluates to true if the target's linker expects | |
5660 | that weak symbols do not appear in a static archive's table of contents. | |
5661 | The default is @code{0}. | |
5662 | ||
5663 | Leaving weak symbols out of an archive's table of contents means that, | |
5664 | if a symbol will only have a definition in one translation unit and | |
5665 | will have undefined references from other translation units, that | |
5666 | symbol should not be weak. Defining this macro to be nonzero will | |
5667 | thus have the effect that certain symbols that would normally be weak | |
5668 | (explicit template instantiations, and vtables for polymorphic classes | |
5669 | with noninline key methods) will instead be nonweak. | |
5670 | ||
5671 | The C++ ABI requires this macro to be zero. Define this macro for | |
5672 | targets where full C++ ABI compliance is impossible and where linker | |
5673 | restrictions require weak symbols to be left out of a static archive's | |
5674 | table of contents. | |
5675 | @end defmac | |
5676 | ||
5677 | @defmac ASM_OUTPUT_EXTERNAL (@var{stream}, @var{decl}, @var{name}) | |
5678 | A C statement (sans semicolon) to output to the stdio stream | |
5679 | @var{stream} any text necessary for declaring the name of an external | |
5680 | symbol named @var{name} which is referenced in this compilation but | |
5681 | not defined. The value of @var{decl} is the tree node for the | |
5682 | declaration. | |
5683 | ||
5684 | This macro need not be defined if it does not need to output anything. | |
5685 | The GNU assembler and most Unix assemblers don't require anything. | |
5686 | @end defmac | |
5687 | ||
5688 | @hook TARGET_ASM_EXTERNAL_LIBCALL | |
38f8b050 JR |
5689 | |
5690 | @hook TARGET_ASM_MARK_DECL_PRESERVED | |
38f8b050 JR |
5691 | |
5692 | @defmac ASM_OUTPUT_LABELREF (@var{stream}, @var{name}) | |
5693 | A C statement (sans semicolon) to output to the stdio stream | |
5694 | @var{stream} a reference in assembler syntax to a label named | |
5695 | @var{name}. This should add @samp{_} to the front of the name, if that | |
5696 | is customary on your operating system, as it is in most Berkeley Unix | |
5697 | systems. This macro is used in @code{assemble_name}. | |
5698 | @end defmac | |
5699 | ||
77754180 DK |
5700 | @hook TARGET_MANGLE_ASSEMBLER_NAME |
5701 | ||
38f8b050 JR |
5702 | @defmac ASM_OUTPUT_SYMBOL_REF (@var{stream}, @var{sym}) |
5703 | A C statement (sans semicolon) to output a reference to | |
5704 | @code{SYMBOL_REF} @var{sym}. If not defined, @code{assemble_name} | |
5705 | will be used to output the name of the symbol. This macro may be used | |
5706 | to modify the way a symbol is referenced depending on information | |
5707 | encoded by @code{TARGET_ENCODE_SECTION_INFO}. | |
5708 | @end defmac | |
5709 | ||
5710 | @defmac ASM_OUTPUT_LABEL_REF (@var{stream}, @var{buf}) | |
5711 | A C statement (sans semicolon) to output a reference to @var{buf}, the | |
5712 | result of @code{ASM_GENERATE_INTERNAL_LABEL}. If not defined, | |
5713 | @code{assemble_name} will be used to output the name of the symbol. | |
5714 | This macro is not used by @code{output_asm_label}, or the @code{%l} | |
5715 | specifier that calls it; the intention is that this macro should be set | |
5716 | when it is necessary to output a label differently when its address is | |
5717 | being taken. | |
5718 | @end defmac | |
5719 | ||
5720 | @hook TARGET_ASM_INTERNAL_LABEL | |
38f8b050 JR |
5721 | |
5722 | @defmac ASM_OUTPUT_DEBUG_LABEL (@var{stream}, @var{prefix}, @var{num}) | |
5723 | A C statement to output to the stdio stream @var{stream} a debug info | |
5724 | label whose name is made from the string @var{prefix} and the number | |
5725 | @var{num}. This is useful for VLIW targets, where debug info labels | |
5726 | may need to be treated differently than branch target labels. On some | |
5727 | systems, branch target labels must be at the beginning of instruction | |
5728 | bundles, but debug info labels can occur in the middle of instruction | |
5729 | bundles. | |
5730 | ||
5731 | If this macro is not defined, then @code{(*targetm.asm_out.internal_label)} will be | |
5732 | used. | |
5733 | @end defmac | |
5734 | ||
5735 | @defmac ASM_GENERATE_INTERNAL_LABEL (@var{string}, @var{prefix}, @var{num}) | |
5736 | A C statement to store into the string @var{string} a label whose name | |
5737 | is made from the string @var{prefix} and the number @var{num}. | |
5738 | ||
5739 | This string, when output subsequently by @code{assemble_name}, should | |
5740 | produce the output that @code{(*targetm.asm_out.internal_label)} would produce | |
5741 | with the same @var{prefix} and @var{num}. | |
5742 | ||
5743 | If the string begins with @samp{*}, then @code{assemble_name} will | |
5744 | output the rest of the string unchanged. It is often convenient for | |
5745 | @code{ASM_GENERATE_INTERNAL_LABEL} to use @samp{*} in this way. If the | |
5746 | string doesn't start with @samp{*}, then @code{ASM_OUTPUT_LABELREF} gets | |
5747 | to output the string, and may change it. (Of course, | |
5748 | @code{ASM_OUTPUT_LABELREF} is also part of your machine description, so | |
5749 | you should know what it does on your machine.) | |
5750 | @end defmac | |
5751 | ||
5752 | @defmac ASM_FORMAT_PRIVATE_NAME (@var{outvar}, @var{name}, @var{number}) | |
5753 | A C expression to assign to @var{outvar} (which is a variable of type | |
5754 | @code{char *}) a newly allocated string made from the string | |
5755 | @var{name} and the number @var{number}, with some suitable punctuation | |
5756 | added. Use @code{alloca} to get space for the string. | |
5757 | ||
5758 | The string will be used as an argument to @code{ASM_OUTPUT_LABELREF} to | |
5759 | produce an assembler label for an internal static variable whose name is | |
5760 | @var{name}. Therefore, the string must be such as to result in valid | |
5761 | assembler code. The argument @var{number} is different each time this | |
5762 | macro is executed; it prevents conflicts between similarly-named | |
5763 | internal static variables in different scopes. | |
5764 | ||
5765 | Ideally this string should not be a valid C identifier, to prevent any | |
5766 | conflict with the user's own symbols. Most assemblers allow periods | |
5767 | or percent signs in assembler symbols; putting at least one of these | |
5768 | between the name and the number will suffice. | |
5769 | ||
5770 | If this macro is not defined, a default definition will be provided | |
5771 | which is correct for most systems. | |
5772 | @end defmac | |
5773 | ||
5774 | @defmac ASM_OUTPUT_DEF (@var{stream}, @var{name}, @var{value}) | |
5775 | A C statement to output to the stdio stream @var{stream} assembler code | |
5776 | which defines (equates) the symbol @var{name} to have the value @var{value}. | |
5777 | ||
5778 | @findex SET_ASM_OP | |
5779 | If @code{SET_ASM_OP} is defined, a default definition is provided which is | |
5780 | correct for most systems. | |
5781 | @end defmac | |
5782 | ||
5783 | @defmac ASM_OUTPUT_DEF_FROM_DECLS (@var{stream}, @var{decl_of_name}, @var{decl_of_value}) | |
5784 | A C statement to output to the stdio stream @var{stream} assembler code | |
5785 | which defines (equates) the symbol whose tree node is @var{decl_of_name} | |
5786 | to have the value of the tree node @var{decl_of_value}. This macro will | |
5787 | be used in preference to @samp{ASM_OUTPUT_DEF} if it is defined and if | |
5788 | the tree nodes are available. | |
5789 | ||
5790 | @findex SET_ASM_OP | |
5791 | If @code{SET_ASM_OP} is defined, a default definition is provided which is | |
5792 | correct for most systems. | |
5793 | @end defmac | |
5794 | ||
5795 | @defmac TARGET_DEFERRED_OUTPUT_DEFS (@var{decl_of_name}, @var{decl_of_value}) | |
5796 | A C statement that evaluates to true if the assembler code which defines | |
5797 | (equates) the symbol whose tree node is @var{decl_of_name} to have the value | |
5798 | of the tree node @var{decl_of_value} should be emitted near the end of the | |
5799 | current compilation unit. The default is to not defer output of defines. | |
5800 | This macro affects defines output by @samp{ASM_OUTPUT_DEF} and | |
5801 | @samp{ASM_OUTPUT_DEF_FROM_DECLS}. | |
5802 | @end defmac | |
5803 | ||
5804 | @defmac ASM_OUTPUT_WEAK_ALIAS (@var{stream}, @var{name}, @var{value}) | |
5805 | A C statement to output to the stdio stream @var{stream} assembler code | |
5806 | which defines (equates) the weak symbol @var{name} to have the value | |
5807 | @var{value}. If @var{value} is @code{NULL}, it defines @var{name} as | |
5808 | an undefined weak symbol. | |
5809 | ||
5810 | Define this macro if the target only supports weak aliases; define | |
5811 | @code{ASM_OUTPUT_DEF} instead if possible. | |
5812 | @end defmac | |
5813 | ||
5814 | @defmac OBJC_GEN_METHOD_LABEL (@var{buf}, @var{is_inst}, @var{class_name}, @var{cat_name}, @var{sel_name}) | |
5815 | Define this macro to override the default assembler names used for | |
5816 | Objective-C methods. | |
5817 | ||
5818 | The default name is a unique method number followed by the name of the | |
5819 | class (e.g.@: @samp{_1_Foo}). For methods in categories, the name of | |
5820 | the category is also included in the assembler name (e.g.@: | |
5821 | @samp{_1_Foo_Bar}). | |
5822 | ||
5823 | These names are safe on most systems, but make debugging difficult since | |
5824 | the method's selector is not present in the name. Therefore, particular | |
5825 | systems define other ways of computing names. | |
5826 | ||
5827 | @var{buf} is an expression of type @code{char *} which gives you a | |
5828 | buffer in which to store the name; its length is as long as | |
5829 | @var{class_name}, @var{cat_name} and @var{sel_name} put together, plus | |
5830 | 50 characters extra. | |
5831 | ||
5832 | The argument @var{is_inst} specifies whether the method is an instance | |
5833 | method or a class method; @var{class_name} is the name of the class; | |
5834 | @var{cat_name} is the name of the category (or @code{NULL} if the method is not | |
5835 | in a category); and @var{sel_name} is the name of the selector. | |
5836 | ||
5837 | On systems where the assembler can handle quoted names, you can use this | |
5838 | macro to provide more human-readable names. | |
5839 | @end defmac | |
5840 | ||
38f8b050 JR |
5841 | @node Initialization |
5842 | @subsection How Initialization Functions Are Handled | |
5843 | @cindex initialization routines | |
5844 | @cindex termination routines | |
5845 | @cindex constructors, output of | |
5846 | @cindex destructors, output of | |
5847 | ||
5848 | The compiled code for certain languages includes @dfn{constructors} | |
5849 | (also called @dfn{initialization routines})---functions to initialize | |
5850 | data in the program when the program is started. These functions need | |
5851 | to be called before the program is ``started''---that is to say, before | |
5852 | @code{main} is called. | |
5853 | ||
5854 | Compiling some languages generates @dfn{destructors} (also called | |
5855 | @dfn{termination routines}) that should be called when the program | |
5856 | terminates. | |
5857 | ||
5858 | To make the initialization and termination functions work, the compiler | |
5859 | must output something in the assembler code to cause those functions to | |
5860 | be called at the appropriate time. When you port the compiler to a new | |
5861 | system, you need to specify how to do this. | |
5862 | ||
5863 | There are two major ways that GCC currently supports the execution of | |
5864 | initialization and termination functions. Each way has two variants. | |
5865 | Much of the structure is common to all four variations. | |
5866 | ||
5867 | @findex __CTOR_LIST__ | |
5868 | @findex __DTOR_LIST__ | |
5869 | The linker must build two lists of these functions---a list of | |
5870 | initialization functions, called @code{__CTOR_LIST__}, and a list of | |
5871 | termination functions, called @code{__DTOR_LIST__}. | |
5872 | ||
5873 | Each list always begins with an ignored function pointer (which may hold | |
5874 | 0, @minus{}1, or a count of the function pointers after it, depending on | |
5875 | the environment). This is followed by a series of zero or more function | |
5876 | pointers to constructors (or destructors), followed by a function | |
5877 | pointer containing zero. | |
5878 | ||
5879 | Depending on the operating system and its executable file format, either | |
5880 | @file{crtstuff.c} or @file{libgcc2.c} traverses these lists at startup | |
5881 | time and exit time. Constructors are called in reverse order of the | |
5882 | list; destructors in forward order. | |
5883 | ||
5884 | The best way to handle static constructors works only for object file | |
5885 | formats which provide arbitrarily-named sections. A section is set | |
5886 | aside for a list of constructors, and another for a list of destructors. | |
5887 | Traditionally these are called @samp{.ctors} and @samp{.dtors}. Each | |
5888 | object file that defines an initialization function also puts a word in | |
5889 | the constructor section to point to that function. The linker | |
5890 | accumulates all these words into one contiguous @samp{.ctors} section. | |
5891 | Termination functions are handled similarly. | |
5892 | ||
5893 | This method will be chosen as the default by @file{target-def.h} if | |
5894 | @code{TARGET_ASM_NAMED_SECTION} is defined. A target that does not | |
5895 | support arbitrary sections, but does support special designated | |
5896 | constructor and destructor sections may define @code{CTORS_SECTION_ASM_OP} | |
5897 | and @code{DTORS_SECTION_ASM_OP} to achieve the same effect. | |
5898 | ||
5899 | When arbitrary sections are available, there are two variants, depending | |
5900 | upon how the code in @file{crtstuff.c} is called. On systems that | |
5901 | support a @dfn{.init} section which is executed at program startup, | |
5902 | parts of @file{crtstuff.c} are compiled into that section. The | |
5903 | program is linked by the @command{gcc} driver like this: | |
5904 | ||
5905 | @smallexample | |
5906 | ld -o @var{output_file} crti.o crtbegin.o @dots{} -lgcc crtend.o crtn.o | |
5907 | @end smallexample | |
5908 | ||
5909 | The prologue of a function (@code{__init}) appears in the @code{.init} | |
5910 | section of @file{crti.o}; the epilogue appears in @file{crtn.o}. Likewise | |
5911 | for the function @code{__fini} in the @dfn{.fini} section. Normally these | |
5912 | files are provided by the operating system or by the GNU C library, but | |
5913 | are provided by GCC for a few targets. | |
5914 | ||
5915 | The objects @file{crtbegin.o} and @file{crtend.o} are (for most targets) | |
5916 | compiled from @file{crtstuff.c}. They contain, among other things, code | |
5917 | fragments within the @code{.init} and @code{.fini} sections that branch | |
5918 | to routines in the @code{.text} section. The linker will pull all parts | |
5919 | of a section together, which results in a complete @code{__init} function | |
5920 | that invokes the routines we need at startup. | |
5921 | ||
5922 | To use this variant, you must define the @code{INIT_SECTION_ASM_OP} | |
5923 | macro properly. | |
5924 | ||
5925 | If no init section is available, when GCC compiles any function called | |
5926 | @code{main} (or more accurately, any function designated as a program | |
5927 | entry point by the language front end calling @code{expand_main_function}), | |
5928 | it inserts a procedure call to @code{__main} as the first executable code | |
5929 | after the function prologue. The @code{__main} function is defined | |
5930 | in @file{libgcc2.c} and runs the global constructors. | |
5931 | ||
5932 | In file formats that don't support arbitrary sections, there are again | |
5933 | two variants. In the simplest variant, the GNU linker (GNU @code{ld}) | |
5934 | and an `a.out' format must be used. In this case, | |
5935 | @code{TARGET_ASM_CONSTRUCTOR} is defined to produce a @code{.stabs} | |
5936 | entry of type @samp{N_SETT}, referencing the name @code{__CTOR_LIST__}, | |
5937 | and with the address of the void function containing the initialization | |
5938 | code as its value. The GNU linker recognizes this as a request to add | |
5939 | the value to a @dfn{set}; the values are accumulated, and are eventually | |
5940 | placed in the executable as a vector in the format described above, with | |
5941 | a leading (ignored) count and a trailing zero element. | |
5942 | @code{TARGET_ASM_DESTRUCTOR} is handled similarly. Since no init | |
5943 | section is available, the absence of @code{INIT_SECTION_ASM_OP} causes | |
5944 | the compilation of @code{main} to call @code{__main} as above, starting | |
5945 | the initialization process. | |
5946 | ||
5947 | The last variant uses neither arbitrary sections nor the GNU linker. | |
5948 | This is preferable when you want to do dynamic linking and when using | |
5949 | file formats which the GNU linker does not support, such as `ECOFF'@. In | |
5950 | this case, @code{TARGET_HAVE_CTORS_DTORS} is false, initialization and | |
5951 | termination functions are recognized simply by their names. This requires | |
5952 | an extra program in the linkage step, called @command{collect2}. This program | |
5953 | pretends to be the linker, for use with GCC; it does its job by running | |
5954 | the ordinary linker, but also arranges to include the vectors of | |
5955 | initialization and termination functions. These functions are called | |
5956 | via @code{__main} as described above. In order to use this method, | |
5957 | @code{use_collect2} must be defined in the target in @file{config.gcc}. | |
5958 | ||
5959 | @ifinfo | |
5960 | The following section describes the specific macros that control and | |
5961 | customize the handling of initialization and termination functions. | |
5962 | @end ifinfo | |
5963 | ||
5964 | @node Macros for Initialization | |
5965 | @subsection Macros Controlling Initialization Routines | |
5966 | ||
5967 | Here are the macros that control how the compiler handles initialization | |
5968 | and termination functions: | |
5969 | ||
5970 | @defmac INIT_SECTION_ASM_OP | |
5971 | If defined, a C string constant, including spacing, for the assembler | |
5972 | operation to identify the following data as initialization code. If not | |
5973 | defined, GCC will assume such a section does not exist. When you are | |
5974 | using special sections for initialization and termination functions, this | |
5975 | macro also controls how @file{crtstuff.c} and @file{libgcc2.c} arrange to | |
5976 | run the initialization functions. | |
5977 | @end defmac | |
5978 | ||
5979 | @defmac HAS_INIT_SECTION | |
5980 | If defined, @code{main} will not call @code{__main} as described above. | |
5981 | This macro should be defined for systems that control start-up code | |
5982 | on a symbol-by-symbol basis, such as OSF/1, and should not | |
5983 | be defined explicitly for systems that support @code{INIT_SECTION_ASM_OP}. | |
5984 | @end defmac | |
5985 | ||
5986 | @defmac LD_INIT_SWITCH | |
5987 | If defined, a C string constant for a switch that tells the linker that | |
5988 | the following symbol is an initialization routine. | |
5989 | @end defmac | |
5990 | ||
5991 | @defmac LD_FINI_SWITCH | |
5992 | If defined, a C string constant for a switch that tells the linker that | |
5993 | the following symbol is a finalization routine. | |
5994 | @end defmac | |
5995 | ||
5996 | @defmac COLLECT_SHARED_INIT_FUNC (@var{stream}, @var{func}) | |
5997 | If defined, a C statement that will write a function that can be | |
5998 | automatically called when a shared library is loaded. The function | |
5999 | should call @var{func}, which takes no arguments. If not defined, and | |
6000 | the object format requires an explicit initialization function, then a | |
6001 | function called @code{_GLOBAL__DI} will be generated. | |
6002 | ||
6003 | This function and the following one are used by collect2 when linking a | |
6004 | shared library that needs constructors or destructors, or has DWARF2 | |
6005 | exception tables embedded in the code. | |
6006 | @end defmac | |
6007 | ||
6008 | @defmac COLLECT_SHARED_FINI_FUNC (@var{stream}, @var{func}) | |
6009 | If defined, a C statement that will write a function that can be | |
6010 | automatically called when a shared library is unloaded. The function | |
6011 | should call @var{func}, which takes no arguments. If not defined, and | |
6012 | the object format requires an explicit finalization function, then a | |
6013 | function called @code{_GLOBAL__DD} will be generated. | |
6014 | @end defmac | |
6015 | ||
6016 | @defmac INVOKE__main | |
6017 | If defined, @code{main} will call @code{__main} despite the presence of | |
6018 | @code{INIT_SECTION_ASM_OP}. This macro should be defined for systems | |
6019 | where the init section is not actually run automatically, but is still | |
6020 | useful for collecting the lists of constructors and destructors. | |
6021 | @end defmac | |
6022 | ||
6023 | @defmac SUPPORTS_INIT_PRIORITY | |
6024 | If nonzero, the C++ @code{init_priority} attribute is supported and the | |
6025 | compiler should emit instructions to control the order of initialization | |
6026 | of objects. If zero, the compiler will issue an error message upon | |
6027 | encountering an @code{init_priority} attribute. | |
6028 | @end defmac | |
6029 | ||
6030 | @hook TARGET_HAVE_CTORS_DTORS | |
38f8b050 JR |
6031 | |
6032 | @hook TARGET_ASM_CONSTRUCTOR | |
38f8b050 JR |
6033 | |
6034 | @hook TARGET_ASM_DESTRUCTOR | |
38f8b050 JR |
6035 | |
6036 | If @code{TARGET_HAVE_CTORS_DTORS} is true, the initialization routine | |
6037 | generated for the generated object file will have static linkage. | |
6038 | ||
6039 | If your system uses @command{collect2} as the means of processing | |
6040 | constructors, then that program normally uses @command{nm} to scan | |
6041 | an object file for constructor functions to be called. | |
6042 | ||
6043 | On certain kinds of systems, you can define this macro to make | |
6044 | @command{collect2} work faster (and, in some cases, make it work at all): | |
6045 | ||
6046 | @defmac OBJECT_FORMAT_COFF | |
6047 | Define this macro if the system uses COFF (Common Object File Format) | |
6048 | object files, so that @command{collect2} can assume this format and scan | |
6049 | object files directly for dynamic constructor/destructor functions. | |
6050 | ||
6051 | This macro is effective only in a native compiler; @command{collect2} as | |
6052 | part of a cross compiler always uses @command{nm} for the target machine. | |
6053 | @end defmac | |
6054 | ||
6055 | @defmac REAL_NM_FILE_NAME | |
6056 | Define this macro as a C string constant containing the file name to use | |
6057 | to execute @command{nm}. The default is to search the path normally for | |
6058 | @command{nm}. | |
3e794bfe RO |
6059 | @end defmac |
6060 | ||
6061 | @defmac NM_FLAGS | |
6062 | @command{collect2} calls @command{nm} to scan object files for static | |
6063 | constructors and destructors and LTO info. By default, @option{-n} is | |
6064 | passed. Define @code{NM_FLAGS} to a C string constant if other options | |
2b0d3573 | 6065 | are needed to get the same output format as GNU @command{nm -n} |
3e794bfe RO |
6066 | produces. |
6067 | @end defmac | |
38f8b050 JR |
6068 | |
6069 | If your system supports shared libraries and has a program to list the | |
6070 | dynamic dependencies of a given library or executable, you can define | |
6071 | these macros to enable support for running initialization and | |
6072 | termination functions in shared libraries: | |
38f8b050 JR |
6073 | |
6074 | @defmac LDD_SUFFIX | |
6075 | Define this macro to a C string constant containing the name of the program | |
3e794bfe | 6076 | which lists dynamic dependencies, like @command{ldd} under SunOS 4. |
38f8b050 JR |
6077 | @end defmac |
6078 | ||
6079 | @defmac PARSE_LDD_OUTPUT (@var{ptr}) | |
6080 | Define this macro to be C code that extracts filenames from the output | |
6081 | of the program denoted by @code{LDD_SUFFIX}. @var{ptr} is a variable | |
6082 | of type @code{char *} that points to the beginning of a line of output | |
6083 | from @code{LDD_SUFFIX}. If the line lists a dynamic dependency, the | |
6084 | code must advance @var{ptr} to the beginning of the filename on that | |
6085 | line. Otherwise, it must set @var{ptr} to @code{NULL}. | |
6086 | @end defmac | |
6087 | ||
6088 | @defmac SHLIB_SUFFIX | |
6089 | Define this macro to a C string constant containing the default shared | |
6090 | library extension of the target (e.g., @samp{".so"}). @command{collect2} | |
6091 | strips version information after this suffix when generating global | |
6092 | constructor and destructor names. This define is only needed on targets | |
6093 | that use @command{collect2} to process constructors and destructors. | |
6094 | @end defmac | |
6095 | ||
6096 | @node Instruction Output | |
6097 | @subsection Output of Assembler Instructions | |
6098 | ||
6099 | @c prevent bad page break with this line | |
6100 | This describes assembler instruction output. | |
6101 | ||
6102 | @defmac REGISTER_NAMES | |
6103 | A C initializer containing the assembler's names for the machine | |
6104 | registers, each one as a C string constant. This is what translates | |
6105 | register numbers in the compiler into assembler language. | |
6106 | @end defmac | |
6107 | ||
6108 | @defmac ADDITIONAL_REGISTER_NAMES | |
6109 | If defined, a C initializer for an array of structures containing a name | |
6110 | and a register number. This macro defines additional names for hard | |
6111 | registers, thus allowing the @code{asm} option in declarations to refer | |
6112 | to registers using alternate names. | |
6113 | @end defmac | |
6114 | ||
0c6d290e RE |
6115 | @defmac OVERLAPPING_REGISTER_NAMES |
6116 | If defined, a C initializer for an array of structures containing a | |
6117 | name, a register number and a count of the number of consecutive | |
6118 | machine registers the name overlaps. This macro defines additional | |
6119 | names for hard registers, thus allowing the @code{asm} option in | |
6120 | declarations to refer to registers using alternate names. Unlike | |
6121 | @code{ADDITIONAL_REGISTER_NAMES}, this macro should be used when the | |
6122 | register name implies multiple underlying registers. | |
6123 | ||
6124 | This macro should be used when it is important that a clobber in an | |
6125 | @code{asm} statement clobbers all the underlying values implied by the | |
6126 | register name. For example, on ARM, clobbering the double-precision | |
6127 | VFP register ``d0'' implies clobbering both single-precision registers | |
6128 | ``s0'' and ``s1''. | |
6129 | @end defmac | |
6130 | ||
38f8b050 JR |
6131 | @defmac ASM_OUTPUT_OPCODE (@var{stream}, @var{ptr}) |
6132 | Define this macro if you are using an unusual assembler that | |
6133 | requires different names for the machine instructions. | |
6134 | ||
6135 | The definition is a C statement or statements which output an | |
6136 | assembler instruction opcode to the stdio stream @var{stream}. The | |
6137 | macro-operand @var{ptr} is a variable of type @code{char *} which | |
6138 | points to the opcode name in its ``internal'' form---the form that is | |
6139 | written in the machine description. The definition should output the | |
6140 | opcode name to @var{stream}, performing any translation you desire, and | |
6141 | increment the variable @var{ptr} to point at the end of the opcode | |
6142 | so that it will not be output twice. | |
6143 | ||
6144 | In fact, your macro definition may process less than the entire opcode | |
6145 | name, or more than the opcode name; but if you want to process text | |
6146 | that includes @samp{%}-sequences to substitute operands, you must take | |
6147 | care of the substitution yourself. Just be sure to increment | |
6148 | @var{ptr} over whatever text should not be output normally. | |
6149 | ||
6150 | @findex recog_data.operand | |
6151 | If you need to look at the operand values, they can be found as the | |
6152 | elements of @code{recog_data.operand}. | |
6153 | ||
6154 | If the macro definition does nothing, the instruction is output | |
6155 | in the usual way. | |
6156 | @end defmac | |
6157 | ||
6158 | @defmac FINAL_PRESCAN_INSN (@var{insn}, @var{opvec}, @var{noperands}) | |
6159 | If defined, a C statement to be executed just prior to the output of | |
6160 | assembler code for @var{insn}, to modify the extracted operands so | |
6161 | they will be output differently. | |
6162 | ||
6163 | Here the argument @var{opvec} is the vector containing the operands | |
6164 | extracted from @var{insn}, and @var{noperands} is the number of | |
6165 | elements of the vector which contain meaningful data for this insn. | |
6166 | The contents of this vector are what will be used to convert the insn | |
6167 | template into assembler code, so you can change the assembler output | |
6168 | by changing the contents of the vector. | |
6169 | ||
6170 | This macro is useful when various assembler syntaxes share a single | |
6171 | file of instruction patterns; by defining this macro differently, you | |
6172 | can cause a large class of instructions to be output differently (such | |
6173 | as with rearranged operands). Naturally, variations in assembler | |
6174 | syntax affecting individual insn patterns ought to be handled by | |
6175 | writing conditional output routines in those patterns. | |
6176 | ||
6177 | If this macro is not defined, it is equivalent to a null statement. | |
6178 | @end defmac | |
6179 | ||
6180 | @hook TARGET_ASM_FINAL_POSTSCAN_INSN | |
38f8b050 JR |
6181 | |
6182 | @defmac PRINT_OPERAND (@var{stream}, @var{x}, @var{code}) | |
6183 | A C compound statement to output to stdio stream @var{stream} the | |
6184 | assembler syntax for an instruction operand @var{x}. @var{x} is an | |
6185 | RTL expression. | |
6186 | ||
6187 | @var{code} is a value that can be used to specify one of several ways | |
6188 | of printing the operand. It is used when identical operands must be | |
6189 | printed differently depending on the context. @var{code} comes from | |
6190 | the @samp{%} specification that was used to request printing of the | |
6191 | operand. If the specification was just @samp{%@var{digit}} then | |
6192 | @var{code} is 0; if the specification was @samp{%@var{ltr} | |
6193 | @var{digit}} then @var{code} is the ASCII code for @var{ltr}. | |
6194 | ||
6195 | @findex reg_names | |
6196 | If @var{x} is a register, this macro should print the register's name. | |
6197 | The names can be found in an array @code{reg_names} whose type is | |
6198 | @code{char *[]}. @code{reg_names} is initialized from | |
6199 | @code{REGISTER_NAMES}. | |
6200 | ||
6201 | When the machine description has a specification @samp{%@var{punct}} | |
6202 | (a @samp{%} followed by a punctuation character), this macro is called | |
6203 | with a null pointer for @var{x} and the punctuation character for | |
6204 | @var{code}. | |
6205 | @end defmac | |
6206 | ||
6207 | @defmac PRINT_OPERAND_PUNCT_VALID_P (@var{code}) | |
6208 | A C expression which evaluates to true if @var{code} is a valid | |
6209 | punctuation character for use in the @code{PRINT_OPERAND} macro. If | |
6210 | @code{PRINT_OPERAND_PUNCT_VALID_P} is not defined, it means that no | |
6211 | punctuation characters (except for the standard one, @samp{%}) are used | |
6212 | in this way. | |
6213 | @end defmac | |
6214 | ||
6215 | @defmac PRINT_OPERAND_ADDRESS (@var{stream}, @var{x}) | |
6216 | A C compound statement to output to stdio stream @var{stream} the | |
6217 | assembler syntax for an instruction operand that is a memory reference | |
6218 | whose address is @var{x}. @var{x} is an RTL expression. | |
6219 | ||
6220 | @cindex @code{TARGET_ENCODE_SECTION_INFO} usage | |
6221 | On some machines, the syntax for a symbolic address depends on the | |
6222 | section that the address refers to. On these machines, define the hook | |
6223 | @code{TARGET_ENCODE_SECTION_INFO} to store the information into the | |
6224 | @code{symbol_ref}, and then check for it here. @xref{Assembler | |
6225 | Format}. | |
6226 | @end defmac | |
6227 | ||
6228 | @findex dbr_sequence_length | |
6229 | @defmac DBR_OUTPUT_SEQEND (@var{file}) | |
6230 | A C statement, to be executed after all slot-filler instructions have | |
6231 | been output. If necessary, call @code{dbr_sequence_length} to | |
6232 | determine the number of slots filled in a sequence (zero if not | |
6233 | currently outputting a sequence), to decide how many no-ops to output, | |
6234 | or whatever. | |
6235 | ||
6236 | Don't define this macro if it has nothing to do, but it is helpful in | |
6237 | reading assembly output if the extent of the delay sequence is made | |
6238 | explicit (e.g.@: with white space). | |
6239 | @end defmac | |
6240 | ||
6241 | @findex final_sequence | |
6242 | Note that output routines for instructions with delay slots must be | |
6243 | prepared to deal with not being output as part of a sequence | |
6244 | (i.e.@: when the scheduling pass is not run, or when no slot fillers could be | |
6245 | found.) The variable @code{final_sequence} is null when not | |
6246 | processing a sequence, otherwise it contains the @code{sequence} rtx | |
6247 | being output. | |
6248 | ||
6249 | @findex asm_fprintf | |
6250 | @defmac REGISTER_PREFIX | |
6251 | @defmacx LOCAL_LABEL_PREFIX | |
6252 | @defmacx USER_LABEL_PREFIX | |
6253 | @defmacx IMMEDIATE_PREFIX | |
6254 | If defined, C string expressions to be used for the @samp{%R}, @samp{%L}, | |
6255 | @samp{%U}, and @samp{%I} options of @code{asm_fprintf} (see | |
6256 | @file{final.c}). These are useful when a single @file{md} file must | |
6257 | support multiple assembler formats. In that case, the various @file{tm.h} | |
6258 | files can define these macros differently. | |
6259 | @end defmac | |
6260 | ||
6261 | @defmac ASM_FPRINTF_EXTENSIONS (@var{file}, @var{argptr}, @var{format}) | |
6262 | If defined this macro should expand to a series of @code{case} | |
6263 | statements which will be parsed inside the @code{switch} statement of | |
6264 | the @code{asm_fprintf} function. This allows targets to define extra | |
6265 | printf formats which may useful when generating their assembler | |
6266 | statements. Note that uppercase letters are reserved for future | |
6267 | generic extensions to asm_fprintf, and so are not available to target | |
6268 | specific code. The output file is given by the parameter @var{file}. | |
6269 | The varargs input pointer is @var{argptr} and the rest of the format | |
6270 | string, starting the character after the one that is being switched | |
6271 | upon, is pointed to by @var{format}. | |
6272 | @end defmac | |
6273 | ||
6274 | @defmac ASSEMBLER_DIALECT | |
6275 | If your target supports multiple dialects of assembler language (such as | |
6276 | different opcodes), define this macro as a C expression that gives the | |
6277 | numeric index of the assembler language dialect to use, with zero as the | |
6278 | first variant. | |
6279 | ||
6280 | If this macro is defined, you may use constructs of the form | |
6281 | @smallexample | |
6282 | @samp{@{option0|option1|option2@dots{}@}} | |
6283 | @end smallexample | |
6284 | @noindent | |
6285 | in the output templates of patterns (@pxref{Output Template}) or in the | |
6286 | first argument of @code{asm_fprintf}. This construct outputs | |
6287 | @samp{option0}, @samp{option1}, @samp{option2}, etc., if the value of | |
6288 | @code{ASSEMBLER_DIALECT} is zero, one, two, etc. Any special characters | |
6289 | within these strings retain their usual meaning. If there are fewer | |
6290 | alternatives within the braces than the value of | |
382522cb MK |
6291 | @code{ASSEMBLER_DIALECT}, the construct outputs nothing. If it's needed |
6292 | to print curly braces or @samp{|} character in assembler output directly, | |
6293 | @samp{%@{}, @samp{%@}} and @samp{%|} can be used. | |
38f8b050 JR |
6294 | |
6295 | If you do not define this macro, the characters @samp{@{}, @samp{|} and | |
6296 | @samp{@}} do not have any special meaning when used in templates or | |
6297 | operands to @code{asm_fprintf}. | |
6298 | ||
6299 | Define the macros @code{REGISTER_PREFIX}, @code{LOCAL_LABEL_PREFIX}, | |
6300 | @code{USER_LABEL_PREFIX} and @code{IMMEDIATE_PREFIX} if you can express | |
6301 | the variations in assembler language syntax with that mechanism. Define | |
6302 | @code{ASSEMBLER_DIALECT} and use the @samp{@{option0|option1@}} syntax | |
6303 | if the syntax variant are larger and involve such things as different | |
6304 | opcodes or operand order. | |
6305 | @end defmac | |
6306 | ||
6307 | @defmac ASM_OUTPUT_REG_PUSH (@var{stream}, @var{regno}) | |
6308 | A C expression to output to @var{stream} some assembler code | |
6309 | which will push hard register number @var{regno} onto the stack. | |
6310 | The code need not be optimal, since this macro is used only when | |
6311 | profiling. | |
6312 | @end defmac | |
6313 | ||
6314 | @defmac ASM_OUTPUT_REG_POP (@var{stream}, @var{regno}) | |
6315 | A C expression to output to @var{stream} some assembler code | |
6316 | which will pop hard register number @var{regno} off of the stack. | |
6317 | The code need not be optimal, since this macro is used only when | |
6318 | profiling. | |
6319 | @end defmac | |
6320 | ||
6321 | @node Dispatch Tables | |
6322 | @subsection Output of Dispatch Tables | |
6323 | ||
6324 | @c prevent bad page break with this line | |
6325 | This concerns dispatch tables. | |
6326 | ||
6327 | @cindex dispatch table | |
6328 | @defmac ASM_OUTPUT_ADDR_DIFF_ELT (@var{stream}, @var{body}, @var{value}, @var{rel}) | |
6329 | A C statement to output to the stdio stream @var{stream} an assembler | |
6330 | pseudo-instruction to generate a difference between two labels. | |
6331 | @var{value} and @var{rel} are the numbers of two internal labels. The | |
6332 | definitions of these labels are output using | |
6333 | @code{(*targetm.asm_out.internal_label)}, and they must be printed in the same | |
6334 | way here. For example, | |
6335 | ||
6336 | @smallexample | |
6337 | fprintf (@var{stream}, "\t.word L%d-L%d\n", | |
6338 | @var{value}, @var{rel}) | |
6339 | @end smallexample | |
6340 | ||
6341 | You must provide this macro on machines where the addresses in a | |
6342 | dispatch table are relative to the table's own address. If defined, GCC | |
6343 | will also use this macro on all machines when producing PIC@. | |
6344 | @var{body} is the body of the @code{ADDR_DIFF_VEC}; it is provided so that the | |
6345 | mode and flags can be read. | |
6346 | @end defmac | |
6347 | ||
6348 | @defmac ASM_OUTPUT_ADDR_VEC_ELT (@var{stream}, @var{value}) | |
6349 | This macro should be provided on machines where the addresses | |
6350 | in a dispatch table are absolute. | |
6351 | ||
6352 | The definition should be a C statement to output to the stdio stream | |
6353 | @var{stream} an assembler pseudo-instruction to generate a reference to | |
6354 | a label. @var{value} is the number of an internal label whose | |
6355 | definition is output using @code{(*targetm.asm_out.internal_label)}. | |
6356 | For example, | |
6357 | ||
6358 | @smallexample | |
6359 | fprintf (@var{stream}, "\t.word L%d\n", @var{value}) | |
6360 | @end smallexample | |
6361 | @end defmac | |
6362 | ||
6363 | @defmac ASM_OUTPUT_CASE_LABEL (@var{stream}, @var{prefix}, @var{num}, @var{table}) | |
6364 | Define this if the label before a jump-table needs to be output | |
6365 | specially. The first three arguments are the same as for | |
6366 | @code{(*targetm.asm_out.internal_label)}; the fourth argument is the | |
da5c6bde | 6367 | jump-table which follows (a @code{jump_table_data} containing an |
38f8b050 JR |
6368 | @code{addr_vec} or @code{addr_diff_vec}). |
6369 | ||
6370 | This feature is used on system V to output a @code{swbeg} statement | |
6371 | for the table. | |
6372 | ||
6373 | If this macro is not defined, these labels are output with | |
6374 | @code{(*targetm.asm_out.internal_label)}. | |
6375 | @end defmac | |
6376 | ||
6377 | @defmac ASM_OUTPUT_CASE_END (@var{stream}, @var{num}, @var{table}) | |
6378 | Define this if something special must be output at the end of a | |
6379 | jump-table. The definition should be a C statement to be executed | |
6380 | after the assembler code for the table is written. It should write | |
6381 | the appropriate code to stdio stream @var{stream}. The argument | |
6382 | @var{table} is the jump-table insn, and @var{num} is the label-number | |
6383 | of the preceding label. | |
6384 | ||
6385 | If this macro is not defined, nothing special is output at the end of | |
6386 | the jump-table. | |
6387 | @end defmac | |
6388 | ||
dddb7af4 ST |
6389 | @hook TARGET_ASM_POST_CFI_STARTPROC |
6390 | ||
38f8b050 | 6391 | @hook TARGET_ASM_EMIT_UNWIND_LABEL |
38f8b050 JR |
6392 | |
6393 | @hook TARGET_ASM_EMIT_EXCEPT_TABLE_LABEL | |
38f8b050 | 6394 | |
a68b5e52 RH |
6395 | @hook TARGET_ASM_EMIT_EXCEPT_PERSONALITY |
6396 | ||
38f8b050 | 6397 | @hook TARGET_ASM_UNWIND_EMIT |
38f8b050 | 6398 | |
5d46ec3d IS |
6399 | @hook TARGET_ASM_MAKE_EH_SYMBOL_INDIRECT |
6400 | ||
3bc6b3e6 RH |
6401 | @hook TARGET_ASM_UNWIND_EMIT_BEFORE_INSN |
6402 | ||
491d5b3c IS |
6403 | @hook TARGET_ASM_SHOULD_RESTORE_CFA_STATE |
6404 | ||
38f8b050 JR |
6405 | @node Exception Region Output |
6406 | @subsection Assembler Commands for Exception Regions | |
6407 | ||
6408 | @c prevent bad page break with this line | |
6409 | ||
6410 | This describes commands marking the start and the end of an exception | |
6411 | region. | |
6412 | ||
6413 | @defmac EH_FRAME_SECTION_NAME | |
6414 | If defined, a C string constant for the name of the section containing | |
6415 | exception handling frame unwind information. If not defined, GCC will | |
6416 | provide a default definition if the target supports named sections. | |
6417 | @file{crtstuff.c} uses this macro to switch to the appropriate section. | |
6418 | ||
6419 | You should define this symbol if your target supports DWARF 2 frame | |
6420 | unwind information and the default definition does not work. | |
6421 | @end defmac | |
6422 | ||
04218b35 AD |
6423 | @defmac EH_FRAME_THROUGH_COLLECT2 |
6424 | If defined, DWARF 2 frame unwind information will identified by | |
6425 | specially named labels. The collect2 process will locate these | |
6426 | labels and generate code to register the frames. | |
38f8b050 | 6427 | |
04218b35 AD |
6428 | This might be necessary, for instance, if the system linker will not |
6429 | place the eh_frames in-between the sentinals from @file{crtstuff.c}, | |
6430 | or if the system linker does garbage collection and sections cannot | |
6431 | be marked as not to be collected. | |
38f8b050 JR |
6432 | @end defmac |
6433 | ||
6434 | @defmac EH_TABLES_CAN_BE_READ_ONLY | |
6435 | Define this macro to 1 if your target is such that no frame unwind | |
6436 | information encoding used with non-PIC code will ever require a | |
6437 | runtime relocation, but the linker may not support merging read-only | |
6438 | and read-write sections into a single read-write section. | |
6439 | @end defmac | |
6440 | ||
6441 | @defmac MASK_RETURN_ADDR | |
6442 | An rtx used to mask the return address found via @code{RETURN_ADDR_RTX}, so | |
6443 | that it does not contain any extraneous set bits in it. | |
6444 | @end defmac | |
6445 | ||
6446 | @defmac DWARF2_UNWIND_INFO | |
6447 | Define this macro to 0 if your target supports DWARF 2 frame unwind | |
6448 | information, but it does not yet work with exception handling. | |
6449 | Otherwise, if your target supports this information (if it defines | |
01a07a64 SB |
6450 | @code{INCOMING_RETURN_ADDR_RTX} and @code{OBJECT_FORMAT_ELF}), |
6451 | GCC will provide a default definition of 1. | |
f0a0390e | 6452 | @end defmac |
38f8b050 | 6453 | |
f0a0390e RH |
6454 | @hook TARGET_EXCEPT_UNWIND_INFO |
6455 | This hook defines the mechanism that will be used for exception handling | |
6456 | by the target. If the target has ABI specified unwind tables, the hook | |
6457 | should return @code{UI_TARGET}. If the target is to use the | |
6458 | @code{setjmp}/@code{longjmp}-based exception handling scheme, the hook | |
6459 | should return @code{UI_SJLJ}. If the target supports DWARF 2 frame unwind | |
6460 | information, the hook should return @code{UI_DWARF2}. | |
38f8b050 | 6461 | |
f0a0390e RH |
6462 | A target may, if exceptions are disabled, choose to return @code{UI_NONE}. |
6463 | This may end up simplifying other parts of target-specific code. The | |
6464 | default implementation of this hook never returns @code{UI_NONE}. | |
38f8b050 | 6465 | |
f0a0390e | 6466 | Note that the value returned by this hook should be constant. It should |
d5fabb58 JM |
6467 | not depend on anything except the command-line switches described by |
6468 | @var{opts}. In particular, the | |
f0a0390e RH |
6469 | setting @code{UI_SJLJ} must be fixed at compiler start-up as C pre-processor |
6470 | macros and builtin functions related to exception handling are set up | |
6471 | depending on this setting. | |
6472 | ||
6473 | The default implementation of the hook first honors the | |
6474 | @option{--enable-sjlj-exceptions} configure option, then | |
d5fabb58 JM |
6475 | @code{DWARF2_UNWIND_INFO}, and finally defaults to @code{UI_SJLJ}. If |
6476 | @code{DWARF2_UNWIND_INFO} depends on command-line options, the target | |
6477 | must define this hook so that @var{opts} is used correctly. | |
f0a0390e | 6478 | @end deftypefn |
38f8b050 JR |
6479 | |
6480 | @hook TARGET_UNWIND_TABLES_DEFAULT | |
6481 | This variable should be set to @code{true} if the target ABI requires unwinding | |
d5fabb58 JM |
6482 | tables even when exceptions are not used. It must not be modified by |
6483 | command-line option processing. | |
38f8b050 JR |
6484 | @end deftypevr |
6485 | ||
38f8b050 JR |
6486 | @defmac DONT_USE_BUILTIN_SETJMP |
6487 | Define this macro to 1 if the @code{setjmp}/@code{longjmp}-based scheme | |
6488 | should use the @code{setjmp}/@code{longjmp} functions from the C library | |
6489 | instead of the @code{__builtin_setjmp}/@code{__builtin_longjmp} machinery. | |
6490 | @end defmac | |
6491 | ||
39ce30d8 SB |
6492 | @defmac JMP_BUF_SIZE |
6493 | This macro has no effect unless @code{DONT_USE_BUILTIN_SETJMP} is also | |
6494 | defined. Define this macro if the default size of @code{jmp_buf} buffer | |
6495 | for the @code{setjmp}/@code{longjmp}-based exception handling mechanism | |
6496 | is not large enough, or if it is much too large. | |
6497 | The default size is @code{FIRST_PSEUDO_REGISTER * sizeof(void *)}. | |
6498 | @end defmac | |
6499 | ||
38f8b050 JR |
6500 | @defmac DWARF_CIE_DATA_ALIGNMENT |
6501 | This macro need only be defined if the target might save registers in the | |
6502 | function prologue at an offset to the stack pointer that is not aligned to | |
6503 | @code{UNITS_PER_WORD}. The definition should be the negative minimum | |
62f9f30b | 6504 | alignment if @code{STACK_GROWS_DOWNWARD} is true, and the positive |
180295ed | 6505 | minimum alignment otherwise. @xref{DWARF}. Only applicable if |
38f8b050 JR |
6506 | the target supports DWARF 2 frame unwind information. |
6507 | @end defmac | |
6508 | ||
6509 | @hook TARGET_TERMINATE_DW2_EH_FRAME_INFO | |
38f8b050 JR |
6510 | |
6511 | @hook TARGET_DWARF_REGISTER_SPAN | |
38f8b050 | 6512 | |
ff050c66 MF |
6513 | @hook TARGET_DWARF_FRAME_REG_MODE |
6514 | ||
38f8b050 | 6515 | @hook TARGET_INIT_DWARF_REG_SIZES_EXTRA |
38f8b050 JR |
6516 | |
6517 | @hook TARGET_ASM_TTYPE | |
38f8b050 JR |
6518 | |
6519 | @hook TARGET_ARM_EABI_UNWINDER | |
38f8b050 JR |
6520 | |
6521 | @node Alignment Output | |
6522 | @subsection Assembler Commands for Alignment | |
6523 | ||
6524 | @c prevent bad page break with this line | |
6525 | This describes commands for alignment. | |
6526 | ||
6527 | @defmac JUMP_ALIGN (@var{label}) | |
6528 | The alignment (log base 2) to put in front of @var{label}, which is | |
6529 | a common destination of jumps and has no fallthru incoming edge. | |
6530 | ||
6531 | This macro need not be defined if you don't want any special alignment | |
6532 | to be done at such a time. Most machine descriptions do not currently | |
6533 | define the macro. | |
6534 | ||
6535 | Unless it's necessary to inspect the @var{label} parameter, it is better | |
6536 | to set the variable @var{align_jumps} in the target's | |
6537 | @code{TARGET_OPTION_OVERRIDE}. Otherwise, you should try to honor the user's | |
6538 | selection in @var{align_jumps} in a @code{JUMP_ALIGN} implementation. | |
6539 | @end defmac | |
6540 | ||
6541 | @defmac LABEL_ALIGN_AFTER_BARRIER (@var{label}) | |
6542 | The alignment (log base 2) to put in front of @var{label}, which follows | |
6543 | a @code{BARRIER}. | |
6544 | ||
6545 | This macro need not be defined if you don't want any special alignment | |
6546 | to be done at such a time. Most machine descriptions do not currently | |
6547 | define the macro. | |
6548 | @end defmac | |
6549 | ||
38f8b050 | 6550 | @defmac LOOP_ALIGN (@var{label}) |
58a51369 SB |
6551 | The alignment (log base 2) to put in front of @var{label} that heads |
6552 | a frequently executed basic block (usually the header of a loop). | |
38f8b050 JR |
6553 | |
6554 | This macro need not be defined if you don't want any special alignment | |
6555 | to be done at such a time. Most machine descriptions do not currently | |
6556 | define the macro. | |
6557 | ||
6558 | Unless it's necessary to inspect the @var{label} parameter, it is better | |
6559 | to set the variable @code{align_loops} in the target's | |
6560 | @code{TARGET_OPTION_OVERRIDE}. Otherwise, you should try to honor the user's | |
6561 | selection in @code{align_loops} in a @code{LOOP_ALIGN} implementation. | |
6562 | @end defmac | |
6563 | ||
38f8b050 JR |
6564 | @defmac LABEL_ALIGN (@var{label}) |
6565 | The alignment (log base 2) to put in front of @var{label}. | |
6566 | If @code{LABEL_ALIGN_AFTER_BARRIER} / @code{LOOP_ALIGN} specify a different alignment, | |
6567 | the maximum of the specified values is used. | |
6568 | ||
6569 | Unless it's necessary to inspect the @var{label} parameter, it is better | |
6570 | to set the variable @code{align_labels} in the target's | |
6571 | @code{TARGET_OPTION_OVERRIDE}. Otherwise, you should try to honor the user's | |
6572 | selection in @code{align_labels} in a @code{LABEL_ALIGN} implementation. | |
6573 | @end defmac | |
6574 | ||
38f8b050 JR |
6575 | @defmac ASM_OUTPUT_SKIP (@var{stream}, @var{nbytes}) |
6576 | A C statement to output to the stdio stream @var{stream} an assembler | |
6577 | instruction to advance the location counter by @var{nbytes} bytes. | |
6578 | Those bytes should be zero when loaded. @var{nbytes} will be a C | |
6579 | expression of type @code{unsigned HOST_WIDE_INT}. | |
6580 | @end defmac | |
6581 | ||
6582 | @defmac ASM_NO_SKIP_IN_TEXT | |
6583 | Define this macro if @code{ASM_OUTPUT_SKIP} should not be used in the | |
6584 | text section because it fails to put zeros in the bytes that are skipped. | |
6585 | This is true on many Unix systems, where the pseudo--op to skip bytes | |
6586 | produces no-op instructions rather than zeros when used in the text | |
6587 | section. | |
6588 | @end defmac | |
6589 | ||
6590 | @defmac ASM_OUTPUT_ALIGN (@var{stream}, @var{power}) | |
6591 | A C statement to output to the stdio stream @var{stream} an assembler | |
6592 | command to advance the location counter to a multiple of 2 to the | |
6593 | @var{power} bytes. @var{power} will be a C expression of type @code{int}. | |
6594 | @end defmac | |
6595 | ||
6596 | @defmac ASM_OUTPUT_ALIGN_WITH_NOP (@var{stream}, @var{power}) | |
6597 | Like @code{ASM_OUTPUT_ALIGN}, except that the ``nop'' instruction is used | |
6598 | for padding, if necessary. | |
6599 | @end defmac | |
6600 | ||
6601 | @defmac ASM_OUTPUT_MAX_SKIP_ALIGN (@var{stream}, @var{power}, @var{max_skip}) | |
6602 | A C statement to output to the stdio stream @var{stream} an assembler | |
6603 | command to advance the location counter to a multiple of 2 to the | |
6604 | @var{power} bytes, but only if @var{max_skip} or fewer bytes are needed to | |
6605 | satisfy the alignment request. @var{power} and @var{max_skip} will be | |
6606 | a C expression of type @code{int}. | |
6607 | @end defmac | |
6608 | ||
6609 | @need 3000 | |
6610 | @node Debugging Info | |
6611 | @section Controlling Debugging Information Format | |
6612 | ||
6613 | @c prevent bad page break with this line | |
6614 | This describes how to specify debugging information. | |
6615 | ||
6616 | @menu | |
6617 | * All Debuggers:: Macros that affect all debugging formats uniformly. | |
6618 | * DBX Options:: Macros enabling specific options in DBX format. | |
6619 | * DBX Hooks:: Hook macros for varying DBX format. | |
6620 | * File Names and DBX:: Macros controlling output of file names in DBX format. | |
180295ed | 6621 | * DWARF:: Macros for DWARF format. |
38f8b050 | 6622 | * VMS Debug:: Macros for VMS debug format. |
f007a638 IB |
6623 | * CTF Debug:: Macros for CTF debug format. |
6624 | * BTF Debug:: Macros for BTF debug format. | |
38f8b050 JR |
6625 | @end menu |
6626 | ||
6627 | @node All Debuggers | |
6628 | @subsection Macros Affecting All Debugging Formats | |
6629 | ||
6630 | @c prevent bad page break with this line | |
6631 | These macros affect all debugging formats. | |
6632 | ||
6633 | @defmac DBX_REGISTER_NUMBER (@var{regno}) | |
6634 | A C expression that returns the DBX register number for the compiler | |
6635 | register number @var{regno}. In the default macro provided, the value | |
6636 | of this expression will be @var{regno} itself. But sometimes there are | |
6637 | some registers that the compiler knows about and DBX does not, or vice | |
6638 | versa. In such cases, some register may need to have one number in the | |
6639 | compiler and another for DBX@. | |
6640 | ||
6641 | If two registers have consecutive numbers inside GCC, and they can be | |
6642 | used as a pair to hold a multiword value, then they @emph{must} have | |
6643 | consecutive numbers after renumbering with @code{DBX_REGISTER_NUMBER}. | |
6644 | Otherwise, debuggers will be unable to access such a pair, because they | |
6645 | expect register pairs to be consecutive in their own numbering scheme. | |
6646 | ||
6647 | If you find yourself defining @code{DBX_REGISTER_NUMBER} in way that | |
6648 | does not preserve register pairs, then what you must do instead is | |
6649 | redefine the actual register numbering scheme. | |
6650 | @end defmac | |
6651 | ||
6652 | @defmac DEBUGGER_AUTO_OFFSET (@var{x}) | |
6653 | A C expression that returns the integer offset value for an automatic | |
6654 | variable having address @var{x} (an RTL expression). The default | |
6655 | computation assumes that @var{x} is based on the frame-pointer and | |
6656 | gives the offset from the frame-pointer. This is required for targets | |
180295ed JW |
6657 | that produce debugging output for DBX and allow the frame-pointer to be |
6658 | eliminated when the @option{-g} option is used. | |
38f8b050 JR |
6659 | @end defmac |
6660 | ||
6661 | @defmac DEBUGGER_ARG_OFFSET (@var{offset}, @var{x}) | |
6662 | A C expression that returns the integer offset value for an argument | |
6663 | having address @var{x} (an RTL expression). The nominal offset is | |
6664 | @var{offset}. | |
6665 | @end defmac | |
6666 | ||
6667 | @defmac PREFERRED_DEBUGGING_TYPE | |
6668 | A C expression that returns the type of debugging output GCC should | |
6669 | produce when the user specifies just @option{-g}. Define | |
6670 | this if you have arranged for GCC to support more than one format of | |
6671 | debugging output. Currently, the allowable values are @code{DBX_DEBUG}, | |
d7d5f241 JW |
6672 | @code{DWARF2_DEBUG}, @code{XCOFF_DEBUG}, @code{VMS_DEBUG}, |
6673 | and @code{VMS_AND_DWARF2_DEBUG}. | |
38f8b050 JR |
6674 | |
6675 | When the user specifies @option{-ggdb}, GCC normally also uses the | |
6676 | value of this macro to select the debugging output format, but with two | |
6677 | exceptions. If @code{DWARF2_DEBUGGING_INFO} is defined, GCC uses the | |
6678 | value @code{DWARF2_DEBUG}. Otherwise, if @code{DBX_DEBUGGING_INFO} is | |
6679 | defined, GCC uses @code{DBX_DEBUG}. | |
6680 | ||
6681 | The value of this macro only affects the default debugging output; the | |
6682 | user can always get a specific type of output by using @option{-gstabs}, | |
180295ed | 6683 | @option{-gdwarf-2}, @option{-gxcoff}, or @option{-gvms}. |
38f8b050 JR |
6684 | @end defmac |
6685 | ||
6686 | @node DBX Options | |
6687 | @subsection Specific Options for DBX Output | |
6688 | ||
6689 | @c prevent bad page break with this line | |
6690 | These are specific options for DBX output. | |
6691 | ||
6692 | @defmac DBX_DEBUGGING_INFO | |
6693 | Define this macro if GCC should produce debugging output for DBX | |
6694 | in response to the @option{-g} option. | |
6695 | @end defmac | |
6696 | ||
6697 | @defmac XCOFF_DEBUGGING_INFO | |
6698 | Define this macro if GCC should produce XCOFF format debugging output | |
6699 | in response to the @option{-g} option. This is a variant of DBX format. | |
6700 | @end defmac | |
6701 | ||
6702 | @defmac DEFAULT_GDB_EXTENSIONS | |
6703 | Define this macro to control whether GCC should by default generate | |
6704 | GDB's extended version of DBX debugging information (assuming DBX-format | |
6705 | debugging information is enabled at all). If you don't define the | |
6706 | macro, the default is 1: always generate the extended information | |
6707 | if there is any occasion to. | |
6708 | @end defmac | |
6709 | ||
6710 | @defmac DEBUG_SYMS_TEXT | |
6711 | Define this macro if all @code{.stabs} commands should be output while | |
6712 | in the text section. | |
6713 | @end defmac | |
6714 | ||
6715 | @defmac ASM_STABS_OP | |
6716 | A C string constant, including spacing, naming the assembler pseudo op to | |
6717 | use instead of @code{"\t.stabs\t"} to define an ordinary debugging symbol. | |
6718 | If you don't define this macro, @code{"\t.stabs\t"} is used. This macro | |
6719 | applies only to DBX debugging information format. | |
6720 | @end defmac | |
6721 | ||
6722 | @defmac ASM_STABD_OP | |
6723 | A C string constant, including spacing, naming the assembler pseudo op to | |
6724 | use instead of @code{"\t.stabd\t"} to define a debugging symbol whose | |
6725 | value is the current location. If you don't define this macro, | |
6726 | @code{"\t.stabd\t"} is used. This macro applies only to DBX debugging | |
6727 | information format. | |
6728 | @end defmac | |
6729 | ||
6730 | @defmac ASM_STABN_OP | |
6731 | A C string constant, including spacing, naming the assembler pseudo op to | |
6732 | use instead of @code{"\t.stabn\t"} to define a debugging symbol with no | |
6733 | name. If you don't define this macro, @code{"\t.stabn\t"} is used. This | |
6734 | macro applies only to DBX debugging information format. | |
6735 | @end defmac | |
6736 | ||
6737 | @defmac DBX_NO_XREFS | |
6738 | Define this macro if DBX on your system does not support the construct | |
6739 | @samp{xs@var{tagname}}. On some systems, this construct is used to | |
6740 | describe a forward reference to a structure named @var{tagname}. | |
6741 | On other systems, this construct is not supported at all. | |
6742 | @end defmac | |
6743 | ||
6744 | @defmac DBX_CONTIN_LENGTH | |
6745 | A symbol name in DBX-format debugging information is normally | |
6746 | continued (split into two separate @code{.stabs} directives) when it | |
6747 | exceeds a certain length (by default, 80 characters). On some | |
6748 | operating systems, DBX requires this splitting; on others, splitting | |
6749 | must not be done. You can inhibit splitting by defining this macro | |
6750 | with the value zero. You can override the default splitting-length by | |
6751 | defining this macro as an expression for the length you desire. | |
6752 | @end defmac | |
6753 | ||
6754 | @defmac DBX_CONTIN_CHAR | |
6755 | Normally continuation is indicated by adding a @samp{\} character to | |
6756 | the end of a @code{.stabs} string when a continuation follows. To use | |
6757 | a different character instead, define this macro as a character | |
6758 | constant for the character you want to use. Do not define this macro | |
6759 | if backslash is correct for your system. | |
6760 | @end defmac | |
6761 | ||
6762 | @defmac DBX_STATIC_STAB_DATA_SECTION | |
6763 | Define this macro if it is necessary to go to the data section before | |
6764 | outputting the @samp{.stabs} pseudo-op for a non-global static | |
6765 | variable. | |
6766 | @end defmac | |
6767 | ||
6768 | @defmac DBX_TYPE_DECL_STABS_CODE | |
6769 | The value to use in the ``code'' field of the @code{.stabs} directive | |
6770 | for a typedef. The default is @code{N_LSYM}. | |
6771 | @end defmac | |
6772 | ||
6773 | @defmac DBX_STATIC_CONST_VAR_CODE | |
6774 | The value to use in the ``code'' field of the @code{.stabs} directive | |
6775 | for a static variable located in the text section. DBX format does not | |
6776 | provide any ``right'' way to do this. The default is @code{N_FUN}. | |
6777 | @end defmac | |
6778 | ||
6779 | @defmac DBX_REGPARM_STABS_CODE | |
6780 | The value to use in the ``code'' field of the @code{.stabs} directive | |
6781 | for a parameter passed in registers. DBX format does not provide any | |
6782 | ``right'' way to do this. The default is @code{N_RSYM}. | |
6783 | @end defmac | |
6784 | ||
6785 | @defmac DBX_REGPARM_STABS_LETTER | |
6786 | The letter to use in DBX symbol data to identify a symbol as a parameter | |
6787 | passed in registers. DBX format does not customarily provide any way to | |
6788 | do this. The default is @code{'P'}. | |
6789 | @end defmac | |
6790 | ||
6791 | @defmac DBX_FUNCTION_FIRST | |
6792 | Define this macro if the DBX information for a function and its | |
6793 | arguments should precede the assembler code for the function. Normally, | |
6794 | in DBX format, the debugging information entirely follows the assembler | |
6795 | code. | |
6796 | @end defmac | |
6797 | ||
6798 | @defmac DBX_BLOCKS_FUNCTION_RELATIVE | |
6799 | Define this macro, with value 1, if the value of a symbol describing | |
6800 | the scope of a block (@code{N_LBRAC} or @code{N_RBRAC}) should be | |
6801 | relative to the start of the enclosing function. Normally, GCC uses | |
6802 | an absolute address. | |
6803 | @end defmac | |
6804 | ||
6805 | @defmac DBX_LINES_FUNCTION_RELATIVE | |
6806 | Define this macro, with value 1, if the value of a symbol indicating | |
6807 | the current line number (@code{N_SLINE}) should be relative to the | |
6808 | start of the enclosing function. Normally, GCC uses an absolute address. | |
6809 | @end defmac | |
6810 | ||
6811 | @defmac DBX_USE_BINCL | |
6812 | Define this macro if GCC should generate @code{N_BINCL} and | |
6813 | @code{N_EINCL} stabs for included header files, as on Sun systems. This | |
6814 | macro also directs GCC to output a type number as a pair of a file | |
6815 | number and a type number within the file. Normally, GCC does not | |
6816 | generate @code{N_BINCL} or @code{N_EINCL} stabs, and it outputs a single | |
6817 | number for a type number. | |
6818 | @end defmac | |
6819 | ||
6820 | @node DBX Hooks | |
6821 | @subsection Open-Ended Hooks for DBX Format | |
6822 | ||
6823 | @c prevent bad page break with this line | |
6824 | These are hooks for DBX format. | |
6825 | ||
38f8b050 JR |
6826 | @defmac DBX_OUTPUT_SOURCE_LINE (@var{stream}, @var{line}, @var{counter}) |
6827 | A C statement to output DBX debugging information before code for line | |
6828 | number @var{line} of the current source file to the stdio stream | |
6829 | @var{stream}. @var{counter} is the number of time the macro was | |
6830 | invoked, including the current invocation; it is intended to generate | |
6831 | unique labels in the assembly output. | |
6832 | ||
6833 | This macro should not be defined if the default output is correct, or | |
6834 | if it can be made correct by defining @code{DBX_LINES_FUNCTION_RELATIVE}. | |
6835 | @end defmac | |
6836 | ||
6837 | @defmac NO_DBX_FUNCTION_END | |
6838 | Some stabs encapsulation formats (in particular ECOFF), cannot handle the | |
6839 | @code{.stabs "",N_FUN,,0,0,Lscope-function-1} gdb dbx extension construct. | |
6840 | On those machines, define this macro to turn this feature off without | |
6841 | disturbing the rest of the gdb extensions. | |
6842 | @end defmac | |
6843 | ||
6844 | @defmac NO_DBX_BNSYM_ENSYM | |
6845 | Some assemblers cannot handle the @code{.stabd BNSYM/ENSYM,0,0} gdb dbx | |
6846 | extension construct. On those machines, define this macro to turn this | |
6847 | feature off without disturbing the rest of the gdb extensions. | |
6848 | @end defmac | |
6849 | ||
6850 | @node File Names and DBX | |
6851 | @subsection File Names in DBX Format | |
6852 | ||
6853 | @c prevent bad page break with this line | |
6854 | This describes file names in DBX format. | |
6855 | ||
6856 | @defmac DBX_OUTPUT_MAIN_SOURCE_FILENAME (@var{stream}, @var{name}) | |
6857 | A C statement to output DBX debugging information to the stdio stream | |
6858 | @var{stream}, which indicates that file @var{name} is the main source | |
6859 | file---the file specified as the input file for compilation. | |
6860 | This macro is called only once, at the beginning of compilation. | |
6861 | ||
6862 | This macro need not be defined if the standard form of output | |
6863 | for DBX debugging information is appropriate. | |
6864 | ||
6865 | It may be necessary to refer to a label equal to the beginning of the | |
6866 | text section. You can use @samp{assemble_name (stream, ltext_label_name)} | |
6867 | to do so. If you do this, you must also set the variable | |
6868 | @var{used_ltext_label_name} to @code{true}. | |
6869 | @end defmac | |
6870 | ||
6871 | @defmac NO_DBX_MAIN_SOURCE_DIRECTORY | |
6872 | Define this macro, with value 1, if GCC should not emit an indication | |
6873 | of the current directory for compilation and current source language at | |
6874 | the beginning of the file. | |
6875 | @end defmac | |
6876 | ||
6877 | @defmac NO_DBX_GCC_MARKER | |
6878 | Define this macro, with value 1, if GCC should not emit an indication | |
6879 | that this object file was compiled by GCC@. The default is to emit | |
6880 | an @code{N_OPT} stab at the beginning of every source file, with | |
6881 | @samp{gcc2_compiled.} for the string and value 0. | |
6882 | @end defmac | |
6883 | ||
6884 | @defmac DBX_OUTPUT_MAIN_SOURCE_FILE_END (@var{stream}, @var{name}) | |
6885 | A C statement to output DBX debugging information at the end of | |
6886 | compilation of the main source file @var{name}. Output should be | |
6887 | written to the stdio stream @var{stream}. | |
6888 | ||
6889 | If you don't define this macro, nothing special is output at the end | |
6890 | of compilation, which is correct for most machines. | |
6891 | @end defmac | |
6892 | ||
6893 | @defmac DBX_OUTPUT_NULL_N_SO_AT_MAIN_SOURCE_FILE_END | |
6894 | Define this macro @emph{instead of} defining | |
6895 | @code{DBX_OUTPUT_MAIN_SOURCE_FILE_END}, if what needs to be output at | |
6896 | the end of compilation is an @code{N_SO} stab with an empty string, | |
6897 | whose value is the highest absolute text address in the file. | |
6898 | @end defmac | |
6899 | ||
6900 | @need 2000 | |
180295ed JW |
6901 | @node DWARF |
6902 | @subsection Macros for DWARF Output | |
38f8b050 JR |
6903 | |
6904 | @c prevent bad page break with this line | |
180295ed | 6905 | Here are macros for DWARF output. |
38f8b050 JR |
6906 | |
6907 | @defmac DWARF2_DEBUGGING_INFO | |
6908 | Define this macro if GCC should produce dwarf version 2 format | |
6909 | debugging output in response to the @option{-g} option. | |
6910 | ||
6911 | @hook TARGET_DWARF_CALLING_CONVENTION | |
38f8b050 JR |
6912 | |
6913 | To support optional call frame debugging information, you must also | |
6914 | define @code{INCOMING_RETURN_ADDR_RTX} and either set | |
6915 | @code{RTX_FRAME_RELATED_P} on the prologue insns if you use RTL for the | |
6916 | prologue, or call @code{dwarf2out_def_cfa} and @code{dwarf2out_reg_save} | |
6917 | as appropriate from @code{TARGET_ASM_FUNCTION_PROLOGUE} if you don't. | |
6918 | @end defmac | |
6919 | ||
6920 | @defmac DWARF2_FRAME_INFO | |
6921 | Define this macro to a nonzero value if GCC should always output | |
f0a0390e RH |
6922 | Dwarf 2 frame information. If @code{TARGET_EXCEPT_UNWIND_INFO} |
6923 | (@pxref{Exception Region Output}) returns @code{UI_DWARF2}, and | |
6924 | exceptions are enabled, GCC will output this information not matter | |
6925 | how you define @code{DWARF2_FRAME_INFO}. | |
38f8b050 JR |
6926 | @end defmac |
6927 | ||
f0a0390e | 6928 | @hook TARGET_DEBUG_UNWIND_INFO |
f0a0390e | 6929 | |
38f8b050 JR |
6930 | @defmac DWARF2_ASM_LINE_DEBUG_INFO |
6931 | Define this macro to be a nonzero value if the assembler can generate Dwarf 2 | |
6932 | line debug info sections. This will result in much more compact line number | |
6933 | tables, and hence is desirable if it works. | |
6934 | @end defmac | |
6935 | ||
924c9e3e AO |
6936 | @defmac DWARF2_ASM_VIEW_DEBUG_INFO |
6937 | Define this macro to be a nonzero value if the assembler supports view | |
6938 | assignment and verification in @code{.loc}. If it does not, but the | |
6939 | user enables location views, the compiler may have to fallback to | |
6940 | internal line number tables. | |
6941 | @end defmac | |
6942 | ||
6943 | @hook TARGET_RESET_LOCATION_VIEW | |
6944 | ||
9730bc27 TT |
6945 | @hook TARGET_WANT_DEBUG_PUB_SECTIONS |
6946 | ||
2ba42841 AO |
6947 | @hook TARGET_DELAY_SCHED2 |
6948 | ||
6949 | @hook TARGET_DELAY_VARTRACK | |
6950 | ||
a50fa76a BS |
6951 | @hook TARGET_NO_REGISTER_ALLOCATION |
6952 | ||
38f8b050 JR |
6953 | @defmac ASM_OUTPUT_DWARF_DELTA (@var{stream}, @var{size}, @var{label1}, @var{label2}) |
6954 | A C statement to issue assembly directives that create a difference | |
6955 | @var{lab1} minus @var{lab2}, using an integer of the given @var{size}. | |
6956 | @end defmac | |
6957 | ||
6958 | @defmac ASM_OUTPUT_DWARF_VMS_DELTA (@var{stream}, @var{size}, @var{label1}, @var{label2}) | |
6959 | A C statement to issue assembly directives that create a difference | |
630ba2fd | 6960 | between the two given labels in system defined units, e.g.@: instruction |
38f8b050 JR |
6961 | slots on IA64 VMS, using an integer of the given size. |
6962 | @end defmac | |
6963 | ||
7180b1a6 | 6964 | @defmac ASM_OUTPUT_DWARF_OFFSET (@var{stream}, @var{size}, @var{label}, @var{offset}, @var{section}) |
38f8b050 | 6965 | A C statement to issue assembly directives that create a |
7180b1a6 RB |
6966 | section-relative reference to the given @var{label} plus @var{offset}, using |
6967 | an integer of the given @var{size}. The label is known to be defined in the | |
6968 | given @var{section}. | |
38f8b050 JR |
6969 | @end defmac |
6970 | ||
6971 | @defmac ASM_OUTPUT_DWARF_PCREL (@var{stream}, @var{size}, @var{label}) | |
6972 | A C statement to issue assembly directives that create a self-relative | |
6973 | reference to the given @var{label}, using an integer of the given @var{size}. | |
6974 | @end defmac | |
6975 | ||
04218b35 AD |
6976 | @defmac ASM_OUTPUT_DWARF_DATAREL (@var{stream}, @var{size}, @var{label}) |
6977 | A C statement to issue assembly directives that create a reference to the | |
6978 | given @var{label} relative to the dbase, using an integer of the given @var{size}. | |
6979 | @end defmac | |
6980 | ||
38f8b050 JR |
6981 | @defmac ASM_OUTPUT_DWARF_TABLE_REF (@var{label}) |
6982 | A C statement to issue assembly directives that create a reference to | |
6983 | the DWARF table identifier @var{label} from the current section. This | |
6984 | is used on some systems to avoid garbage collecting a DWARF table which | |
6985 | is referenced by a function. | |
6986 | @end defmac | |
6987 | ||
6988 | @hook TARGET_ASM_OUTPUT_DWARF_DTPREL | |
38f8b050 | 6989 | |
38f8b050 JR |
6990 | @need 2000 |
6991 | @node VMS Debug | |
6992 | @subsection Macros for VMS Debug Format | |
6993 | ||
6994 | @c prevent bad page break with this line | |
6995 | Here are macros for VMS debug format. | |
6996 | ||
6997 | @defmac VMS_DEBUGGING_INFO | |
6998 | Define this macro if GCC should produce debugging output for VMS | |
6999 | in response to the @option{-g} option. The default behavior for VMS | |
7000 | is to generate minimal debug info for a traceback in the absence of | |
7001 | @option{-g} unless explicitly overridden with @option{-g0}. This | |
fac0f722 | 7002 | behavior is controlled by @code{TARGET_OPTION_OPTIMIZATION} and |
38f8b050 JR |
7003 | @code{TARGET_OPTION_OVERRIDE}. |
7004 | @end defmac | |
7005 | ||
f007a638 IB |
7006 | @need 2000 |
7007 | @node CTF Debug | |
7008 | @subsection Macros for CTF Debug Format | |
7009 | ||
7010 | @c prevent bad page break with this line | |
7011 | Here are macros for CTF debug format. | |
7012 | ||
7013 | @defmac CTF_DEBUGGING_INFO | |
7014 | Define this macro if GCC should produce debugging output in CTF debug | |
7015 | format in response to the @option{-gctf} option. | |
7016 | @end defmac | |
7017 | ||
7018 | @need 2000 | |
7019 | @node BTF Debug | |
7020 | @subsection Macros for BTF Debug Format | |
7021 | ||
7022 | @c prevent bad page break with this line | |
7023 | Here are macros for BTF debug format. | |
7024 | ||
7025 | @defmac BTF_DEBUGGING_INFO | |
7026 | Define this macro if GCC should produce debugging output in BTF debug | |
7027 | format in response to the @option{-gbtf} option. | |
7028 | @end defmac | |
7029 | ||
38f8b050 JR |
7030 | @node Floating Point |
7031 | @section Cross Compilation and Floating Point | |
7032 | @cindex cross compilation and floating point | |
7033 | @cindex floating point and cross compilation | |
7034 | ||
7035 | While all modern machines use twos-complement representation for integers, | |
7036 | there are a variety of representations for floating point numbers. This | |
7037 | means that in a cross-compiler the representation of floating point numbers | |
7038 | in the compiled program may be different from that used in the machine | |
7039 | doing the compilation. | |
7040 | ||
7041 | Because different representation systems may offer different amounts of | |
7042 | range and precision, all floating point constants must be represented in | |
7043 | the target machine's format. Therefore, the cross compiler cannot | |
7044 | safely use the host machine's floating point arithmetic; it must emulate | |
7045 | the target's arithmetic. To ensure consistency, GCC always uses | |
7046 | emulation to work with floating point values, even when the host and | |
7047 | target floating point formats are identical. | |
7048 | ||
7049 | The following macros are provided by @file{real.h} for the compiler to | |
7050 | use. All parts of the compiler which generate or optimize | |
7051 | floating-point calculations must use these macros. They may evaluate | |
7052 | their operands more than once, so operands must not have side effects. | |
7053 | ||
7054 | @defmac REAL_VALUE_TYPE | |
7055 | The C data type to be used to hold a floating point value in the target | |
7056 | machine's format. Typically this is a @code{struct} containing an | |
7057 | array of @code{HOST_WIDE_INT}, but all code should treat it as an opaque | |
7058 | quantity. | |
7059 | @end defmac | |
7060 | ||
38f8b050 JR |
7061 | @deftypefn Macro HOST_WIDE_INT REAL_VALUE_FIX (REAL_VALUE_TYPE @var{x}) |
7062 | Truncates @var{x} to a signed integer, rounding toward zero. | |
7063 | @end deftypefn | |
7064 | ||
7065 | @deftypefn Macro {unsigned HOST_WIDE_INT} REAL_VALUE_UNSIGNED_FIX (REAL_VALUE_TYPE @var{x}) | |
7066 | Truncates @var{x} to an unsigned integer, rounding toward zero. If | |
7067 | @var{x} is negative, returns zero. | |
7068 | @end deftypefn | |
7069 | ||
ef4bddc2 | 7070 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_ATOF (const char *@var{string}, machine_mode @var{mode}) |
38f8b050 JR |
7071 | Converts @var{string} into a floating point number in the target machine's |
7072 | representation for mode @var{mode}. This routine can handle both | |
7073 | decimal and hexadecimal floating point constants, using the syntax | |
7074 | defined by the C language for both. | |
7075 | @end deftypefn | |
7076 | ||
7077 | @deftypefn Macro int REAL_VALUE_NEGATIVE (REAL_VALUE_TYPE @var{x}) | |
7078 | Returns 1 if @var{x} is negative (including negative zero), 0 otherwise. | |
7079 | @end deftypefn | |
7080 | ||
7081 | @deftypefn Macro int REAL_VALUE_ISINF (REAL_VALUE_TYPE @var{x}) | |
7082 | Determines whether @var{x} represents infinity (positive or negative). | |
7083 | @end deftypefn | |
7084 | ||
7085 | @deftypefn Macro int REAL_VALUE_ISNAN (REAL_VALUE_TYPE @var{x}) | |
7086 | Determines whether @var{x} represents a ``NaN'' (not-a-number). | |
7087 | @end deftypefn | |
7088 | ||
38f8b050 JR |
7089 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_NEGATE (REAL_VALUE_TYPE @var{x}) |
7090 | Returns the negative of the floating point value @var{x}. | |
7091 | @end deftypefn | |
7092 | ||
7093 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_ABS (REAL_VALUE_TYPE @var{x}) | |
7094 | Returns the absolute value of @var{x}. | |
7095 | @end deftypefn | |
7096 | ||
38f8b050 JR |
7097 | @node Mode Switching |
7098 | @section Mode Switching Instructions | |
7099 | @cindex mode switching | |
7100 | The following macros control mode switching optimizations: | |
7101 | ||
7102 | @defmac OPTIMIZE_MODE_SWITCHING (@var{entity}) | |
7103 | Define this macro if the port needs extra instructions inserted for mode | |
7104 | switching in an optimizing compilation. | |
7105 | ||
7106 | For an example, the SH4 can perform both single and double precision | |
7107 | floating point operations, but to perform a single precision operation, | |
7108 | the FPSCR PR bit has to be cleared, while for a double precision | |
7109 | operation, this bit has to be set. Changing the PR bit requires a general | |
7110 | purpose register as a scratch register, hence these FPSCR sets have to | |
fd250f0d | 7111 | be inserted before reload, i.e.@: you cannot put this into instruction emitting |
38f8b050 JR |
7112 | or @code{TARGET_MACHINE_DEPENDENT_REORG}. |
7113 | ||
7114 | You can have multiple entities that are mode-switched, and select at run time | |
7115 | which entities actually need it. @code{OPTIMIZE_MODE_SWITCHING} should | |
7116 | return nonzero for any @var{entity} that needs mode-switching. | |
7117 | If you define this macro, you also have to define | |
06b90602 CB |
7118 | @code{NUM_MODES_FOR_MODE_SWITCHING}, @code{TARGET_MODE_NEEDED}, |
7119 | @code{TARGET_MODE_PRIORITY} and @code{TARGET_MODE_EMIT}. | |
7120 | @code{TARGET_MODE_AFTER}, @code{TARGET_MODE_ENTRY}, and @code{TARGET_MODE_EXIT} | |
38f8b050 JR |
7121 | are optional. |
7122 | @end defmac | |
7123 | ||
7124 | @defmac NUM_MODES_FOR_MODE_SWITCHING | |
7125 | If you define @code{OPTIMIZE_MODE_SWITCHING}, you have to define this as | |
7126 | initializer for an array of integers. Each initializer element | |
7127 | N refers to an entity that needs mode switching, and specifies the number | |
7128 | of different modes that might need to be set for this entity. | |
7129 | The position of the initializer in the initializer---starting counting at | |
7130 | zero---determines the integer that is used to refer to the mode-switched | |
7131 | entity in question. | |
7132 | In macros that take mode arguments / yield a mode result, modes are | |
7133 | represented as numbers 0 @dots{} N @minus{} 1. N is used to specify that no mode | |
7134 | switch is needed / supplied. | |
7135 | @end defmac | |
7136 | ||
06b90602 | 7137 | @hook TARGET_MODE_EMIT |
38f8b050 | 7138 | |
06b90602 | 7139 | @hook TARGET_MODE_NEEDED |
38f8b050 | 7140 | |
06b90602 | 7141 | @hook TARGET_MODE_AFTER |
38f8b050 | 7142 | |
06b90602 | 7143 | @hook TARGET_MODE_ENTRY |
38f8b050 | 7144 | |
06b90602 | 7145 | @hook TARGET_MODE_EXIT |
38f8b050 | 7146 | |
06b90602 | 7147 | @hook TARGET_MODE_PRIORITY |
38f8b050 JR |
7148 | |
7149 | @node Target Attributes | |
7150 | @section Defining target-specific uses of @code{__attribute__} | |
7151 | @cindex target attributes | |
7152 | @cindex machine attributes | |
7153 | @cindex attributes, target-specific | |
7154 | ||
7155 | Target-specific attributes may be defined for functions, data and types. | |
7156 | These are described using the following target hooks; they also need to | |
7157 | be documented in @file{extend.texi}. | |
7158 | ||
7159 | @hook TARGET_ATTRIBUTE_TABLE | |
38f8b050 JR |
7160 | |
7161 | @hook TARGET_ATTRIBUTE_TAKES_IDENTIFIER_P | |
38f8b050 JR |
7162 | |
7163 | @hook TARGET_COMP_TYPE_ATTRIBUTES | |
38f8b050 JR |
7164 | |
7165 | @hook TARGET_SET_DEFAULT_TYPE_ATTRIBUTES | |
38f8b050 JR |
7166 | |
7167 | @hook TARGET_MERGE_TYPE_ATTRIBUTES | |
38f8b050 JR |
7168 | |
7169 | @hook TARGET_MERGE_DECL_ATTRIBUTES | |
38f8b050 JR |
7170 | |
7171 | @hook TARGET_VALID_DLLIMPORT_ATTRIBUTE_P | |
7172 | ||
7173 | @defmac TARGET_DECLSPEC | |
7174 | Define this macro to a nonzero value if you want to treat | |
7175 | @code{__declspec(X)} as equivalent to @code{__attribute((X))}. By | |
7176 | default, this behavior is enabled only for targets that define | |
7177 | @code{TARGET_DLLIMPORT_DECL_ATTRIBUTES}. The current implementation | |
7178 | of @code{__declspec} is via a built-in macro, but you should not rely | |
7179 | on this implementation detail. | |
7180 | @end defmac | |
7181 | ||
7182 | @hook TARGET_INSERT_ATTRIBUTES | |
38f8b050 | 7183 | |
7a4418a5 JL |
7184 | @hook TARGET_HANDLE_GENERIC_ATTRIBUTE |
7185 | ||
38f8b050 | 7186 | @hook TARGET_FUNCTION_ATTRIBUTE_INLINABLE_P |
38f8b050 JR |
7187 | |
7188 | @hook TARGET_OPTION_VALID_ATTRIBUTE_P | |
38f8b050 JR |
7189 | |
7190 | @hook TARGET_OPTION_SAVE | |
38f8b050 JR |
7191 | |
7192 | @hook TARGET_OPTION_RESTORE | |
38f8b050 | 7193 | |
59913123 JJ |
7194 | @hook TARGET_OPTION_POST_STREAM_IN |
7195 | ||
38f8b050 | 7196 | @hook TARGET_OPTION_PRINT |
38f8b050 | 7197 | |
56cb42ea | 7198 | @hook TARGET_OPTION_PRAGMA_PARSE |
38f8b050 JR |
7199 | |
7200 | @hook TARGET_OPTION_OVERRIDE | |
38f8b050 | 7201 | |
3649b9b7 | 7202 | @hook TARGET_OPTION_FUNCTION_VERSIONS |
3649b9b7 | 7203 | |
38f8b050 | 7204 | @hook TARGET_CAN_INLINE_P |
38f8b050 | 7205 | |
63b0cb04 CB |
7206 | @hook TARGET_RELAYOUT_FUNCTION |
7207 | ||
38f8b050 JR |
7208 | @node Emulated TLS |
7209 | @section Emulating TLS | |
7210 | @cindex Emulated TLS | |
7211 | ||
7212 | For targets whose psABI does not provide Thread Local Storage via | |
7213 | specific relocations and instruction sequences, an emulation layer is | |
7214 | used. A set of target hooks allows this emulation layer to be | |
7215 | configured for the requirements of a particular target. For instance | |
7216 | the psABI may in fact specify TLS support in terms of an emulation | |
7217 | layer. | |
7218 | ||
7219 | The emulation layer works by creating a control object for every TLS | |
7220 | object. To access the TLS object, a lookup function is provided | |
7221 | which, when given the address of the control object, will return the | |
7222 | address of the current thread's instance of the TLS object. | |
7223 | ||
7224 | @hook TARGET_EMUTLS_GET_ADDRESS | |
38f8b050 JR |
7225 | |
7226 | @hook TARGET_EMUTLS_REGISTER_COMMON | |
38f8b050 JR |
7227 | |
7228 | @hook TARGET_EMUTLS_VAR_SECTION | |
38f8b050 JR |
7229 | |
7230 | @hook TARGET_EMUTLS_TMPL_SECTION | |
38f8b050 JR |
7231 | |
7232 | @hook TARGET_EMUTLS_VAR_PREFIX | |
38f8b050 JR |
7233 | |
7234 | @hook TARGET_EMUTLS_TMPL_PREFIX | |
38f8b050 JR |
7235 | |
7236 | @hook TARGET_EMUTLS_VAR_FIELDS | |
38f8b050 JR |
7237 | |
7238 | @hook TARGET_EMUTLS_VAR_INIT | |
38f8b050 JR |
7239 | |
7240 | @hook TARGET_EMUTLS_VAR_ALIGN_FIXED | |
38f8b050 JR |
7241 | |
7242 | @hook TARGET_EMUTLS_DEBUG_FORM_TLS_ADDRESS | |
38f8b050 JR |
7243 | |
7244 | @node MIPS Coprocessors | |
7245 | @section Defining coprocessor specifics for MIPS targets. | |
7246 | @cindex MIPS coprocessor-definition macros | |
7247 | ||
7248 | The MIPS specification allows MIPS implementations to have as many as 4 | |
7249 | coprocessors, each with as many as 32 private registers. GCC supports | |
7250 | accessing these registers and transferring values between the registers | |
7251 | and memory using asm-ized variables. For example: | |
7252 | ||
7253 | @smallexample | |
7254 | register unsigned int cp0count asm ("c0r1"); | |
7255 | unsigned int d; | |
7256 | ||
7257 | d = cp0count + 3; | |
7258 | @end smallexample | |
7259 | ||
7260 | (``c0r1'' is the default name of register 1 in coprocessor 0; alternate | |
7261 | names may be added as described below, or the default names may be | |
7262 | overridden entirely in @code{SUBTARGET_CONDITIONAL_REGISTER_USAGE}.) | |
7263 | ||
7264 | Coprocessor registers are assumed to be epilogue-used; sets to them will | |
7265 | be preserved even if it does not appear that the register is used again | |
7266 | later in the function. | |
7267 | ||
7268 | Another note: according to the MIPS spec, coprocessor 1 (if present) is | |
7269 | the FPU@. One accesses COP1 registers through standard mips | |
7270 | floating-point support; they are not included in this mechanism. | |
7271 | ||
38f8b050 JR |
7272 | @node PCH Target |
7273 | @section Parameters for Precompiled Header Validity Checking | |
7274 | @cindex parameters, precompiled headers | |
7275 | ||
7276 | @hook TARGET_GET_PCH_VALIDITY | |
38f8b050 JR |
7277 | |
7278 | @hook TARGET_PCH_VALID_P | |
38f8b050 JR |
7279 | |
7280 | @hook TARGET_CHECK_PCH_TARGET_FLAGS | |
38f8b050 | 7281 | |
e32ea2d1 RS |
7282 | @hook TARGET_PREPARE_PCH_SAVE |
7283 | ||
38f8b050 JR |
7284 | @node C++ ABI |
7285 | @section C++ ABI parameters | |
7286 | @cindex parameters, c++ abi | |
7287 | ||
7288 | @hook TARGET_CXX_GUARD_TYPE | |
38f8b050 JR |
7289 | |
7290 | @hook TARGET_CXX_GUARD_MASK_BIT | |
38f8b050 JR |
7291 | |
7292 | @hook TARGET_CXX_GET_COOKIE_SIZE | |
38f8b050 JR |
7293 | |
7294 | @hook TARGET_CXX_COOKIE_HAS_SIZE | |
38f8b050 JR |
7295 | |
7296 | @hook TARGET_CXX_IMPORT_EXPORT_CLASS | |
38f8b050 JR |
7297 | |
7298 | @hook TARGET_CXX_CDTOR_RETURNS_THIS | |
38f8b050 JR |
7299 | |
7300 | @hook TARGET_CXX_KEY_METHOD_MAY_BE_INLINE | |
38f8b050 JR |
7301 | |
7302 | @hook TARGET_CXX_DETERMINE_CLASS_DATA_VISIBILITY | |
7303 | ||
7304 | @hook TARGET_CXX_CLASS_DATA_ALWAYS_COMDAT | |
38f8b050 JR |
7305 | |
7306 | @hook TARGET_CXX_LIBRARY_RTTI_COMDAT | |
38f8b050 JR |
7307 | |
7308 | @hook TARGET_CXX_USE_AEABI_ATEXIT | |
38f8b050 JR |
7309 | |
7310 | @hook TARGET_CXX_USE_ATEXIT_FOR_CXA_ATEXIT | |
38f8b050 JR |
7311 | |
7312 | @hook TARGET_CXX_ADJUST_CLASS_AT_DEFINITION | |
7313 | ||
17c4f786 AS |
7314 | @hook TARGET_CXX_DECL_MANGLING_CONTEXT |
7315 | ||
b4c522fa IB |
7316 | @node D Language and ABI |
7317 | @section D ABI parameters | |
7318 | @cindex parameters, d abi | |
7319 | ||
7320 | @hook TARGET_D_CPU_VERSIONS | |
7321 | ||
7322 | @hook TARGET_D_OS_VERSIONS | |
7323 | ||
3785d2b2 IB |
7324 | @hook TARGET_D_REGISTER_CPU_TARGET_INFO |
7325 | ||
527bc018 IB |
7326 | @hook TARGET_D_REGISTER_OS_TARGET_INFO |
7327 | ||
4dce3b05 IB |
7328 | @hook TARGET_D_MINFO_SECTION |
7329 | ||
7330 | @hook TARGET_D_MINFO_START_NAME | |
7331 | ||
7332 | @hook TARGET_D_MINFO_END_NAME | |
7333 | ||
d253a6f7 IB |
7334 | @hook TARGET_D_HAS_STDCALL_CONVENTION |
7335 | ||
bda51959 IB |
7336 | @hook TARGET_D_TEMPLATES_ALWAYS_COMDAT |
7337 | ||
38f8b050 JR |
7338 | @node Named Address Spaces |
7339 | @section Adding support for named address spaces | |
7340 | @cindex named address spaces | |
7341 | ||
7342 | The draft technical report of the ISO/IEC JTC1 S22 WG14 N1275 | |
7343 | standards committee, @cite{Programming Languages - C - Extensions to | |
7344 | support embedded processors}, specifies a syntax for embedded | |
7345 | processors to specify alternate address spaces. You can configure a | |
7346 | GCC port to support section 5.1 of the draft report to add support for | |
7347 | address spaces other than the default address space. These address | |
7348 | spaces are new keywords that are similar to the @code{volatile} and | |
7349 | @code{const} type attributes. | |
7350 | ||
7351 | Pointers to named address spaces can have a different size than | |
7352 | pointers to the generic address space. | |
7353 | ||
7354 | For example, the SPU port uses the @code{__ea} address space to refer | |
7355 | to memory in the host processor, rather than memory local to the SPU | |
7356 | processor. Access to memory in the @code{__ea} address space involves | |
7357 | issuing DMA operations to move data between the host processor and the | |
7358 | local processor memory address space. Pointers in the @code{__ea} | |
7359 | address space are either 32 bits or 64 bits based on the | |
7360 | @option{-mea32} or @option{-mea64} switches (native SPU pointers are | |
7361 | always 32 bits). | |
7362 | ||
7363 | Internally, address spaces are represented as a small integer in the | |
7364 | range 0 to 15 with address space 0 being reserved for the generic | |
7365 | address space. | |
7366 | ||
7367 | To register a named address space qualifier keyword with the C front end, | |
7368 | the target may call the @code{c_register_addr_space} routine. For example, | |
7369 | the SPU port uses the following to declare @code{__ea} as the keyword for | |
7370 | named address space #1: | |
7371 | @smallexample | |
7372 | #define ADDR_SPACE_EA 1 | |
7373 | c_register_addr_space ("__ea", ADDR_SPACE_EA); | |
7374 | @end smallexample | |
7375 | ||
7376 | @hook TARGET_ADDR_SPACE_POINTER_MODE | |
38f8b050 JR |
7377 | |
7378 | @hook TARGET_ADDR_SPACE_ADDRESS_MODE | |
38f8b050 JR |
7379 | |
7380 | @hook TARGET_ADDR_SPACE_VALID_POINTER_MODE | |
38f8b050 JR |
7381 | |
7382 | @hook TARGET_ADDR_SPACE_LEGITIMATE_ADDRESS_P | |
38f8b050 JR |
7383 | |
7384 | @hook TARGET_ADDR_SPACE_LEGITIMIZE_ADDRESS | |
38f8b050 JR |
7385 | |
7386 | @hook TARGET_ADDR_SPACE_SUBSET_P | |
38f8b050 | 7387 | |
6626f970 RH |
7388 | @hook TARGET_ADDR_SPACE_ZERO_ADDRESS_VALID |
7389 | ||
38f8b050 | 7390 | @hook TARGET_ADDR_SPACE_CONVERT |
38f8b050 | 7391 | |
f736b911 RH |
7392 | @hook TARGET_ADDR_SPACE_DEBUG |
7393 | ||
ffc22840 GJL |
7394 | @hook TARGET_ADDR_SPACE_DIAGNOSE_USAGE |
7395 | ||
38f8b050 JR |
7396 | @node Misc |
7397 | @section Miscellaneous Parameters | |
7398 | @cindex parameters, miscellaneous | |
7399 | ||
7400 | @c prevent bad page break with this line | |
7401 | Here are several miscellaneous parameters. | |
7402 | ||
7403 | @defmac HAS_LONG_COND_BRANCH | |
7404 | Define this boolean macro to indicate whether or not your architecture | |
7405 | has conditional branches that can span all of memory. It is used in | |
7406 | conjunction with an optimization that partitions hot and cold basic | |
7407 | blocks into separate sections of the executable. If this macro is | |
7408 | set to false, gcc will convert any conditional branches that attempt | |
7409 | to cross between sections into unconditional branches or indirect jumps. | |
7410 | @end defmac | |
7411 | ||
7412 | @defmac HAS_LONG_UNCOND_BRANCH | |
7413 | Define this boolean macro to indicate whether or not your architecture | |
7414 | has unconditional branches that can span all of memory. It is used in | |
7415 | conjunction with an optimization that partitions hot and cold basic | |
7416 | blocks into separate sections of the executable. If this macro is | |
7417 | set to false, gcc will convert any unconditional branches that attempt | |
7418 | to cross between sections into indirect jumps. | |
7419 | @end defmac | |
7420 | ||
7421 | @defmac CASE_VECTOR_MODE | |
7422 | An alias for a machine mode name. This is the machine mode that | |
7423 | elements of a jump-table should have. | |
7424 | @end defmac | |
7425 | ||
7426 | @defmac CASE_VECTOR_SHORTEN_MODE (@var{min_offset}, @var{max_offset}, @var{body}) | |
7427 | Optional: return the preferred mode for an @code{addr_diff_vec} | |
7428 | when the minimum and maximum offset are known. If you define this, | |
7429 | it enables extra code in branch shortening to deal with @code{addr_diff_vec}. | |
7430 | To make this work, you also have to define @code{INSN_ALIGN} and | |
7431 | make the alignment for @code{addr_diff_vec} explicit. | |
7432 | The @var{body} argument is provided so that the offset_unsigned and scale | |
7433 | flags can be updated. | |
7434 | @end defmac | |
7435 | ||
7436 | @defmac CASE_VECTOR_PC_RELATIVE | |
7437 | Define this macro to be a C expression to indicate when jump-tables | |
7438 | should contain relative addresses. You need not define this macro if | |
7439 | jump-tables never contain relative addresses, or jump-tables should | |
7440 | contain relative addresses only when @option{-fPIC} or @option{-fPIC} | |
7441 | is in effect. | |
7442 | @end defmac | |
7443 | ||
7444 | @hook TARGET_CASE_VALUES_THRESHOLD | |
38f8b050 | 7445 | |
38f8b050 | 7446 | @defmac WORD_REGISTER_OPERATIONS |
9e11bfef | 7447 | Define this macro to 1 if operations between registers with integral mode |
bcec133f EB |
7448 | smaller than a word are always performed on the entire register. To be |
7449 | more explicit, if you start with a pair of @code{word_mode} registers with | |
7450 | known values and you do a subword, for example @code{QImode}, addition on | |
7451 | the low part of the registers, then the compiler may consider that the | |
7452 | result has a known value in @code{word_mode} too if the macro is defined | |
7453 | to 1. Most RISC machines have this property and most CISC machines do not. | |
38f8b050 JR |
7454 | @end defmac |
7455 | ||
894d8b41 EB |
7456 | @hook TARGET_MIN_ARITHMETIC_PRECISION |
7457 | ||
38f8b050 JR |
7458 | @defmac LOAD_EXTEND_OP (@var{mem_mode}) |
7459 | Define this macro to be a C expression indicating when insns that read | |
7460 | memory in @var{mem_mode}, an integral mode narrower than a word, set the | |
7461 | bits outside of @var{mem_mode} to be either the sign-extension or the | |
7462 | zero-extension of the data read. Return @code{SIGN_EXTEND} for values | |
7463 | of @var{mem_mode} for which the | |
7464 | insn sign-extends, @code{ZERO_EXTEND} for which it zero-extends, and | |
7465 | @code{UNKNOWN} for other modes. | |
7466 | ||
7467 | This macro is not called with @var{mem_mode} non-integral or with a width | |
7468 | greater than or equal to @code{BITS_PER_WORD}, so you may return any | |
7469 | value in this case. Do not define this macro if it would always return | |
7470 | @code{UNKNOWN}. On machines where this macro is defined, you will normally | |
7471 | define it as the constant @code{SIGN_EXTEND} or @code{ZERO_EXTEND}. | |
7472 | ||
7473 | You may return a non-@code{UNKNOWN} value even if for some hard registers | |
7474 | the sign extension is not performed, if for the @code{REGNO_REG_CLASS} | |
0d803030 | 7475 | of these hard registers @code{TARGET_CAN_CHANGE_MODE_CLASS} returns false |
38f8b050 JR |
7476 | when the @var{from} mode is @var{mem_mode} and the @var{to} mode is any |
7477 | integral mode larger than this but not larger than @code{word_mode}. | |
7478 | ||
7479 | You must return @code{UNKNOWN} if for some hard registers that allow this | |
0d803030 | 7480 | mode, @code{TARGET_CAN_CHANGE_MODE_CLASS} says that they cannot change to |
38f8b050 JR |
7481 | @code{word_mode}, but that they can change to another integral mode that |
7482 | is larger then @var{mem_mode} but still smaller than @code{word_mode}. | |
7483 | @end defmac | |
7484 | ||
7485 | @defmac SHORT_IMMEDIATES_SIGN_EXTEND | |
58f2ae18 | 7486 | Define this macro to 1 if loading short immediate values into registers sign |
38f8b050 JR |
7487 | extends. |
7488 | @end defmac | |
7489 | ||
38f8b050 | 7490 | @hook TARGET_MIN_DIVISIONS_FOR_RECIP_MUL |
38f8b050 JR |
7491 | |
7492 | @defmac MOVE_MAX | |
7493 | The maximum number of bytes that a single instruction can move quickly | |
7494 | between memory and registers or between two memory locations. | |
7495 | @end defmac | |
7496 | ||
7497 | @defmac MAX_MOVE_MAX | |
7498 | The maximum number of bytes that a single instruction can move quickly | |
7499 | between memory and registers or between two memory locations. If this | |
7500 | is undefined, the default is @code{MOVE_MAX}. Otherwise, it is the | |
7501 | constant value that is the largest value that @code{MOVE_MAX} can have | |
7502 | at run-time. | |
7503 | @end defmac | |
7504 | ||
7505 | @defmac SHIFT_COUNT_TRUNCATED | |
7506 | A C expression that is nonzero if on this machine the number of bits | |
7507 | actually used for the count of a shift operation is equal to the number | |
7508 | of bits needed to represent the size of the object being shifted. When | |
7509 | this macro is nonzero, the compiler will assume that it is safe to omit | |
7510 | a sign-extend, zero-extend, and certain bitwise `and' instructions that | |
7511 | truncates the count of a shift operation. On machines that have | |
7512 | instructions that act on bit-fields at variable positions, which may | |
7513 | include `bit test' instructions, a nonzero @code{SHIFT_COUNT_TRUNCATED} | |
7514 | also enables deletion of truncations of the values that serve as | |
7515 | arguments to bit-field instructions. | |
7516 | ||
7517 | If both types of instructions truncate the count (for shifts) and | |
7518 | position (for bit-field operations), or if no variable-position bit-field | |
7519 | instructions exist, you should define this macro. | |
7520 | ||
7521 | However, on some machines, such as the 80386 and the 680x0, truncation | |
7522 | only applies to shift operations and not the (real or pretended) | |
7523 | bit-field operations. Define @code{SHIFT_COUNT_TRUNCATED} to be zero on | |
7524 | such machines. Instead, add patterns to the @file{md} file that include | |
7525 | the implied truncation of the shift instructions. | |
7526 | ||
7527 | You need not define this macro if it would always have the value of zero. | |
7528 | @end defmac | |
7529 | ||
7530 | @anchor{TARGET_SHIFT_TRUNCATION_MASK} | |
7531 | @hook TARGET_SHIFT_TRUNCATION_MASK | |
38f8b050 | 7532 | |
bb149ca2 | 7533 | @hook TARGET_TRULY_NOOP_TRUNCATION |
38f8b050 JR |
7534 | |
7535 | @hook TARGET_MODE_REP_EXTENDED | |
38f8b050 | 7536 | |
82957a73 PB |
7537 | @hook TARGET_SETJMP_PRESERVES_NONVOLATILE_REGS_P |
7538 | ||
38f8b050 JR |
7539 | @defmac STORE_FLAG_VALUE |
7540 | A C expression describing the value returned by a comparison operator | |
7541 | with an integral mode and stored by a store-flag instruction | |
7542 | (@samp{cstore@var{mode}4}) when the condition is true. This description must | |
7543 | apply to @emph{all} the @samp{cstore@var{mode}4} patterns and all the | |
7544 | comparison operators whose results have a @code{MODE_INT} mode. | |
7545 | ||
7546 | A value of 1 or @minus{}1 means that the instruction implementing the | |
7547 | comparison operator returns exactly 1 or @minus{}1 when the comparison is true | |
7548 | and 0 when the comparison is false. Otherwise, the value indicates | |
7549 | which bits of the result are guaranteed to be 1 when the comparison is | |
7550 | true. This value is interpreted in the mode of the comparison | |
7551 | operation, which is given by the mode of the first operand in the | |
7552 | @samp{cstore@var{mode}4} pattern. Either the low bit or the sign bit of | |
7553 | @code{STORE_FLAG_VALUE} be on. Presently, only those bits are used by | |
7554 | the compiler. | |
7555 | ||
7556 | If @code{STORE_FLAG_VALUE} is neither 1 or @minus{}1, the compiler will | |
7557 | generate code that depends only on the specified bits. It can also | |
7558 | replace comparison operators with equivalent operations if they cause | |
7559 | the required bits to be set, even if the remaining bits are undefined. | |
7560 | For example, on a machine whose comparison operators return an | |
7561 | @code{SImode} value and where @code{STORE_FLAG_VALUE} is defined as | |
7562 | @samp{0x80000000}, saying that just the sign bit is relevant, the | |
7563 | expression | |
7564 | ||
7565 | @smallexample | |
7566 | (ne:SI (and:SI @var{x} (const_int @var{power-of-2})) (const_int 0)) | |
7567 | @end smallexample | |
7568 | ||
7569 | @noindent | |
7570 | can be converted to | |
7571 | ||
7572 | @smallexample | |
7573 | (ashift:SI @var{x} (const_int @var{n})) | |
7574 | @end smallexample | |
7575 | ||
7576 | @noindent | |
7577 | where @var{n} is the appropriate shift count to move the bit being | |
7578 | tested into the sign bit. | |
7579 | ||
7580 | There is no way to describe a machine that always sets the low-order bit | |
7581 | for a true value, but does not guarantee the value of any other bits, | |
7582 | but we do not know of any machine that has such an instruction. If you | |
7583 | are trying to port GCC to such a machine, include an instruction to | |
7584 | perform a logical-and of the result with 1 in the pattern for the | |
7585 | comparison operators and let us know at @email{gcc@@gcc.gnu.org}. | |
7586 | ||
7587 | Often, a machine will have multiple instructions that obtain a value | |
7588 | from a comparison (or the condition codes). Here are rules to guide the | |
7589 | choice of value for @code{STORE_FLAG_VALUE}, and hence the instructions | |
7590 | to be used: | |
7591 | ||
7592 | @itemize @bullet | |
7593 | @item | |
7594 | Use the shortest sequence that yields a valid definition for | |
7595 | @code{STORE_FLAG_VALUE}. It is more efficient for the compiler to | |
7596 | ``normalize'' the value (convert it to, e.g., 1 or 0) than for the | |
7597 | comparison operators to do so because there may be opportunities to | |
7598 | combine the normalization with other operations. | |
7599 | ||
7600 | @item | |
7601 | For equal-length sequences, use a value of 1 or @minus{}1, with @minus{}1 being | |
7602 | slightly preferred on machines with expensive jumps and 1 preferred on | |
7603 | other machines. | |
7604 | ||
7605 | @item | |
7606 | As a second choice, choose a value of @samp{0x80000001} if instructions | |
7607 | exist that set both the sign and low-order bits but do not define the | |
7608 | others. | |
7609 | ||
7610 | @item | |
7611 | Otherwise, use a value of @samp{0x80000000}. | |
7612 | @end itemize | |
7613 | ||
7614 | Many machines can produce both the value chosen for | |
7615 | @code{STORE_FLAG_VALUE} and its negation in the same number of | |
7616 | instructions. On those machines, you should also define a pattern for | |
7617 | those cases, e.g., one matching | |
7618 | ||
7619 | @smallexample | |
7620 | (set @var{A} (neg:@var{m} (ne:@var{m} @var{B} @var{C}))) | |
7621 | @end smallexample | |
7622 | ||
7623 | Some machines can also perform @code{and} or @code{plus} operations on | |
7624 | condition code values with less instructions than the corresponding | |
7625 | @samp{cstore@var{mode}4} insn followed by @code{and} or @code{plus}. On those | |
7626 | machines, define the appropriate patterns. Use the names @code{incscc} | |
7627 | and @code{decscc}, respectively, for the patterns which perform | |
7628 | @code{plus} or @code{minus} operations on condition code values. See | |
2b0d3573 | 7629 | @file{rs6000.md} for some examples. The GNU Superoptimizer can be used to |
38f8b050 JR |
7630 | find such instruction sequences on other machines. |
7631 | ||
7632 | If this macro is not defined, the default value, 1, is used. You need | |
7633 | not define @code{STORE_FLAG_VALUE} if the machine has no store-flag | |
7634 | instructions, or if the value generated by these instructions is 1. | |
7635 | @end defmac | |
7636 | ||
7637 | @defmac FLOAT_STORE_FLAG_VALUE (@var{mode}) | |
7638 | A C expression that gives a nonzero @code{REAL_VALUE_TYPE} value that is | |
7639 | returned when comparison operators with floating-point results are true. | |
7640 | Define this macro on machines that have comparison operations that return | |
7641 | floating-point values. If there are no such operations, do not define | |
7642 | this macro. | |
7643 | @end defmac | |
7644 | ||
7645 | @defmac VECTOR_STORE_FLAG_VALUE (@var{mode}) | |
5e97638b | 7646 | A C expression that gives an rtx representing the nonzero true element |
38f8b050 JR |
7647 | for vector comparisons. The returned rtx should be valid for the inner |
7648 | mode of @var{mode} which is guaranteed to be a vector mode. Define | |
7649 | this macro on machines that have vector comparison operations that | |
7650 | return a vector result. If there are no such operations, do not define | |
7651 | this macro. Typically, this macro is defined as @code{const1_rtx} or | |
7652 | @code{constm1_rtx}. This macro may return @code{NULL_RTX} to prevent | |
7653 | the compiler optimizing such vector comparison operations for the | |
7654 | given mode. | |
7655 | @end defmac | |
7656 | ||
7657 | @defmac CLZ_DEFINED_VALUE_AT_ZERO (@var{mode}, @var{value}) | |
7658 | @defmacx CTZ_DEFINED_VALUE_AT_ZERO (@var{mode}, @var{value}) | |
7659 | A C expression that indicates whether the architecture defines a value | |
ff2ce160 | 7660 | for @code{clz} or @code{ctz} with a zero operand. |
38f8b050 JR |
7661 | A result of @code{0} indicates the value is undefined. |
7662 | If the value is defined for only the RTL expression, the macro should | |
7663 | evaluate to @code{1}; if the value applies also to the corresponding optab | |
7664 | entry (which is normally the case if it expands directly into | |
ff2ce160 | 7665 | the corresponding RTL), then the macro should evaluate to @code{2}. |
38f8b050 | 7666 | In the cases where the value is defined, @var{value} should be set to |
ff2ce160 | 7667 | this value. |
38f8b050 JR |
7668 | |
7669 | If this macro is not defined, the value of @code{clz} or | |
7670 | @code{ctz} at zero is assumed to be undefined. | |
7671 | ||
7672 | This macro must be defined if the target's expansion for @code{ffs} | |
7673 | relies on a particular value to get correct results. Otherwise it | |
7674 | is not necessary, though it may be used to optimize some corner cases, and | |
7675 | to provide a default expansion for the @code{ffs} optab. | |
7676 | ||
7677 | Note that regardless of this macro the ``definedness'' of @code{clz} | |
7678 | and @code{ctz} at zero do @emph{not} extend to the builtin functions | |
7679 | visible to the user. Thus one may be free to adjust the value at will | |
7680 | to match the target expansion of these operations without fear of | |
7681 | breaking the API@. | |
7682 | @end defmac | |
7683 | ||
7684 | @defmac Pmode | |
7685 | An alias for the machine mode for pointers. On most machines, define | |
7686 | this to be the integer mode corresponding to the width of a hardware | |
7687 | pointer; @code{SImode} on 32-bit machine or @code{DImode} on 64-bit machines. | |
7688 | On some machines you must define this to be one of the partial integer | |
7689 | modes, such as @code{PSImode}. | |
7690 | ||
7691 | The width of @code{Pmode} must be at least as large as the value of | |
7692 | @code{POINTER_SIZE}. If it is not equal, you must define the macro | |
7693 | @code{POINTERS_EXTEND_UNSIGNED} to specify how pointers are extended | |
7694 | to @code{Pmode}. | |
7695 | @end defmac | |
7696 | ||
7697 | @defmac FUNCTION_MODE | |
7698 | An alias for the machine mode used for memory references to functions | |
7699 | being called, in @code{call} RTL expressions. On most CISC machines, | |
ff2ce160 | 7700 | where an instruction can begin at any byte address, this should be |
38f8b050 JR |
7701 | @code{QImode}. On most RISC machines, where all instructions have fixed |
7702 | size and alignment, this should be a mode with the same size and alignment | |
7703 | as the machine instruction words - typically @code{SImode} or @code{HImode}. | |
7704 | @end defmac | |
7705 | ||
7706 | @defmac STDC_0_IN_SYSTEM_HEADERS | |
7707 | In normal operation, the preprocessor expands @code{__STDC__} to the | |
7708 | constant 1, to signify that GCC conforms to ISO Standard C@. On some | |
7709 | hosts, like Solaris, the system compiler uses a different convention, | |
7710 | where @code{__STDC__} is normally 0, but is 1 if the user specifies | |
7711 | strict conformance to the C Standard. | |
7712 | ||
7713 | Defining @code{STDC_0_IN_SYSTEM_HEADERS} makes GNU CPP follows the host | |
7714 | convention when processing system header files, but when processing user | |
7715 | files @code{__STDC__} will always expand to 1. | |
7716 | @end defmac | |
7717 | ||
1efcb8c6 JM |
7718 | @hook TARGET_C_PREINCLUDE |
7719 | ||
88b0e79e JC |
7720 | @hook TARGET_CXX_IMPLICIT_EXTERN_C |
7721 | ||
09cff37b NS |
7722 | @defmac SYSTEM_IMPLICIT_EXTERN_C |
7723 | Define this macro if the system header files do not support C++@. | |
7724 | This macro handles system header files by pretending that system | |
7725 | header files are enclosed in @samp{extern "C" @{@dots{}@}}. | |
38f8b050 JR |
7726 | @end defmac |
7727 | ||
7728 | @findex #pragma | |
7729 | @findex pragma | |
7730 | @defmac REGISTER_TARGET_PRAGMAS () | |
7731 | Define this macro if you want to implement any target-specific pragmas. | |
7732 | If defined, it is a C expression which makes a series of calls to | |
7733 | @code{c_register_pragma} or @code{c_register_pragma_with_expansion} | |
7734 | for each pragma. The macro may also do any | |
7735 | setup required for the pragmas. | |
7736 | ||
7737 | The primary reason to define this macro is to provide compatibility with | |
7738 | other compilers for the same target. In general, we discourage | |
7739 | definition of target-specific pragmas for GCC@. | |
7740 | ||
7741 | If the pragma can be implemented by attributes then you should consider | |
7742 | defining the target hook @samp{TARGET_INSERT_ATTRIBUTES} as well. | |
7743 | ||
7744 | Preprocessor macros that appear on pragma lines are not expanded. All | |
7745 | @samp{#pragma} directives that do not match any registered pragma are | |
7746 | silently ignored, unless the user specifies @option{-Wunknown-pragmas}. | |
7747 | @end defmac | |
7748 | ||
7749 | @deftypefun void c_register_pragma (const char *@var{space}, const char *@var{name}, void (*@var{callback}) (struct cpp_reader *)) | |
7750 | @deftypefunx void c_register_pragma_with_expansion (const char *@var{space}, const char *@var{name}, void (*@var{callback}) (struct cpp_reader *)) | |
7751 | ||
7752 | Each call to @code{c_register_pragma} or | |
7753 | @code{c_register_pragma_with_expansion} establishes one pragma. The | |
7754 | @var{callback} routine will be called when the preprocessor encounters a | |
7755 | pragma of the form | |
7756 | ||
7757 | @smallexample | |
7758 | #pragma [@var{space}] @var{name} @dots{} | |
7759 | @end smallexample | |
7760 | ||
7761 | @var{space} is the case-sensitive namespace of the pragma, or | |
7762 | @code{NULL} to put the pragma in the global namespace. The callback | |
7763 | routine receives @var{pfile} as its first argument, which can be passed | |
7764 | on to cpplib's functions if necessary. You can lex tokens after the | |
7765 | @var{name} by calling @code{pragma_lex}. Tokens that are not read by the | |
7766 | callback will be silently ignored. The end of the line is indicated by | |
7767 | a token of type @code{CPP_EOF}. Macro expansion occurs on the | |
7768 | arguments of pragmas registered with | |
7769 | @code{c_register_pragma_with_expansion} but not on the arguments of | |
7770 | pragmas registered with @code{c_register_pragma}. | |
7771 | ||
7772 | Note that the use of @code{pragma_lex} is specific to the C and C++ | |
7773 | compilers. It will not work in the Java or Fortran compilers, or any | |
7774 | other language compilers for that matter. Thus if @code{pragma_lex} is going | |
7775 | to be called from target-specific code, it must only be done so when | |
7776 | building the C and C++ compilers. This can be done by defining the | |
7777 | variables @code{c_target_objs} and @code{cxx_target_objs} in the | |
7778 | target entry in the @file{config.gcc} file. These variables should name | |
7779 | the target-specific, language-specific object file which contains the | |
7780 | code that uses @code{pragma_lex}. Note it will also be necessary to add a | |
7781 | rule to the makefile fragment pointed to by @code{tmake_file} that shows | |
7782 | how to build this object file. | |
7783 | @end deftypefun | |
7784 | ||
38f8b050 | 7785 | @defmac HANDLE_PRAGMA_PACK_WITH_EXPANSION |
24a57808 | 7786 | Define this macro if macros should be expanded in the |
38f8b050 JR |
7787 | arguments of @samp{#pragma pack}. |
7788 | @end defmac | |
7789 | ||
38f8b050 JR |
7790 | @defmac TARGET_DEFAULT_PACK_STRUCT |
7791 | If your target requires a structure packing default other than 0 (meaning | |
7792 | the machine default), define this macro to the necessary value (in bytes). | |
7793 | This must be a value that would also be valid to use with | |
7794 | @samp{#pragma pack()} (that is, a small power of two). | |
7795 | @end defmac | |
7796 | ||
7797 | @defmac DOLLARS_IN_IDENTIFIERS | |
7798 | Define this macro to control use of the character @samp{$} in | |
7799 | identifier names for the C family of languages. 0 means @samp{$} is | |
7800 | not allowed by default; 1 means it is allowed. 1 is the default; | |
7801 | there is no need to define this macro in that case. | |
7802 | @end defmac | |
7803 | ||
38f8b050 JR |
7804 | @defmac INSN_SETS_ARE_DELAYED (@var{insn}) |
7805 | Define this macro as a C expression that is nonzero if it is safe for the | |
7806 | delay slot scheduler to place instructions in the delay slot of @var{insn}, | |
7807 | even if they appear to use a resource set or clobbered in @var{insn}. | |
7808 | @var{insn} is always a @code{jump_insn} or an @code{insn}; GCC knows that | |
7809 | every @code{call_insn} has this behavior. On machines where some @code{insn} | |
7810 | or @code{jump_insn} is really a function call and hence has this behavior, | |
7811 | you should define this macro. | |
7812 | ||
7813 | You need not define this macro if it would always return zero. | |
7814 | @end defmac | |
7815 | ||
7816 | @defmac INSN_REFERENCES_ARE_DELAYED (@var{insn}) | |
7817 | Define this macro as a C expression that is nonzero if it is safe for the | |
7818 | delay slot scheduler to place instructions in the delay slot of @var{insn}, | |
7819 | even if they appear to set or clobber a resource referenced in @var{insn}. | |
7820 | @var{insn} is always a @code{jump_insn} or an @code{insn}. On machines where | |
7821 | some @code{insn} or @code{jump_insn} is really a function call and its operands | |
7822 | are registers whose use is actually in the subroutine it calls, you should | |
7823 | define this macro. Doing so allows the delay slot scheduler to move | |
7824 | instructions which copy arguments into the argument registers into the delay | |
7825 | slot of @var{insn}. | |
7826 | ||
7827 | You need not define this macro if it would always return zero. | |
7828 | @end defmac | |
7829 | ||
7830 | @defmac MULTIPLE_SYMBOL_SPACES | |
7831 | Define this macro as a C expression that is nonzero if, in some cases, | |
7832 | global symbols from one translation unit may not be bound to undefined | |
7833 | symbols in another translation unit without user intervention. For | |
7834 | instance, under Microsoft Windows symbols must be explicitly imported | |
7835 | from shared libraries (DLLs). | |
7836 | ||
7837 | You need not define this macro if it would always evaluate to zero. | |
7838 | @end defmac | |
7839 | ||
7ca35180 | 7840 | @hook TARGET_MD_ASM_ADJUST |
38f8b050 JR |
7841 | |
7842 | @defmac MATH_LIBRARY | |
7843 | Define this macro as a C string constant for the linker argument to link | |
d9d16a19 JM |
7844 | in the system math library, minus the initial @samp{"-l"}, or |
7845 | @samp{""} if the target does not have a | |
38f8b050 JR |
7846 | separate math library. |
7847 | ||
d9d16a19 | 7848 | You need only define this macro if the default of @samp{"m"} is wrong. |
38f8b050 JR |
7849 | @end defmac |
7850 | ||
7851 | @defmac LIBRARY_PATH_ENV | |
7852 | Define this macro as a C string constant for the environment variable that | |
7853 | specifies where the linker should look for libraries. | |
7854 | ||
7855 | You need only define this macro if the default of @samp{"LIBRARY_PATH"} | |
7856 | is wrong. | |
7857 | @end defmac | |
7858 | ||
7859 | @defmac TARGET_POSIX_IO | |
7860 | Define this macro if the target supports the following POSIX@ file | |
7861 | functions, access, mkdir and file locking with fcntl / F_SETLKW@. | |
7862 | Defining @code{TARGET_POSIX_IO} will enable the test coverage code | |
7863 | to use file locking when exiting a program, which avoids race conditions | |
7864 | if the program has forked. It will also create directories at run-time | |
7865 | for cross-profiling. | |
7866 | @end defmac | |
7867 | ||
7868 | @defmac MAX_CONDITIONAL_EXECUTE | |
7869 | ||
7870 | A C expression for the maximum number of instructions to execute via | |
7871 | conditional execution instructions instead of a branch. A value of | |
bd1cd0d0 | 7872 | @code{BRANCH_COST}+1 is the default. |
38f8b050 JR |
7873 | @end defmac |
7874 | ||
7875 | @defmac IFCVT_MODIFY_TESTS (@var{ce_info}, @var{true_expr}, @var{false_expr}) | |
7876 | Used if the target needs to perform machine-dependent modifications on the | |
7877 | conditionals used for turning basic blocks into conditionally executed code. | |
7878 | @var{ce_info} points to a data structure, @code{struct ce_if_block}, which | |
7879 | contains information about the currently processed blocks. @var{true_expr} | |
7880 | and @var{false_expr} are the tests that are used for converting the | |
7881 | then-block and the else-block, respectively. Set either @var{true_expr} or | |
7882 | @var{false_expr} to a null pointer if the tests cannot be converted. | |
7883 | @end defmac | |
7884 | ||
7885 | @defmac IFCVT_MODIFY_MULTIPLE_TESTS (@var{ce_info}, @var{bb}, @var{true_expr}, @var{false_expr}) | |
7886 | Like @code{IFCVT_MODIFY_TESTS}, but used when converting more complicated | |
7887 | if-statements into conditions combined by @code{and} and @code{or} operations. | |
7888 | @var{bb} contains the basic block that contains the test that is currently | |
7889 | being processed and about to be turned into a condition. | |
7890 | @end defmac | |
7891 | ||
7892 | @defmac IFCVT_MODIFY_INSN (@var{ce_info}, @var{pattern}, @var{insn}) | |
7893 | A C expression to modify the @var{PATTERN} of an @var{INSN} that is to | |
7894 | be converted to conditional execution format. @var{ce_info} points to | |
7895 | a data structure, @code{struct ce_if_block}, which contains information | |
7896 | about the currently processed blocks. | |
7897 | @end defmac | |
7898 | ||
7899 | @defmac IFCVT_MODIFY_FINAL (@var{ce_info}) | |
7900 | A C expression to perform any final machine dependent modifications in | |
7901 | converting code to conditional execution. The involved basic blocks | |
7902 | can be found in the @code{struct ce_if_block} structure that is pointed | |
7903 | to by @var{ce_info}. | |
7904 | @end defmac | |
7905 | ||
7906 | @defmac IFCVT_MODIFY_CANCEL (@var{ce_info}) | |
7907 | A C expression to cancel any machine dependent modifications in | |
7908 | converting code to conditional execution. The involved basic blocks | |
7909 | can be found in the @code{struct ce_if_block} structure that is pointed | |
7910 | to by @var{ce_info}. | |
7911 | @end defmac | |
7912 | ||
67a0732f SB |
7913 | @defmac IFCVT_MACHDEP_INIT (@var{ce_info}) |
7914 | A C expression to initialize any machine specific data for if-conversion | |
7915 | of the if-block in the @code{struct ce_if_block} structure that is pointed | |
7916 | to by @var{ce_info}. | |
38f8b050 JR |
7917 | @end defmac |
7918 | ||
7919 | @hook TARGET_MACHINE_DEPENDENT_REORG | |
38f8b050 JR |
7920 | |
7921 | @hook TARGET_INIT_BUILTINS | |
38f8b050 JR |
7922 | |
7923 | @hook TARGET_BUILTIN_DECL | |
38f8b050 JR |
7924 | |
7925 | @hook TARGET_EXPAND_BUILTIN | |
7926 | ||
d66f5459 | 7927 | @hook TARGET_RESOLVE_OVERLOADED_BUILTIN |
38f8b050 | 7928 | |
c6447c20 RS |
7929 | @hook TARGET_CHECK_BUILTIN_CALL |
7930 | ||
08914aaa | 7931 | @hook TARGET_FOLD_BUILTIN |
38f8b050 | 7932 | |
ea679d55 JG |
7933 | @hook TARGET_GIMPLE_FOLD_BUILTIN |
7934 | ||
3649b9b7 | 7935 | @hook TARGET_COMPARE_VERSION_PRIORITY |
3649b9b7 ST |
7936 | |
7937 | @hook TARGET_GET_FUNCTION_VERSIONS_DISPATCHER | |
3649b9b7 ST |
7938 | |
7939 | @hook TARGET_GENERATE_VERSION_DISPATCHER_BODY | |
3649b9b7 | 7940 | |
74b5fcf7 KL |
7941 | @hook TARGET_PREDICT_DOLOOP_P |
7942 | ||
603a4ad4 KL |
7943 | @hook TARGET_HAVE_COUNT_REG_DECR_P |
7944 | ||
7945 | @hook TARGET_DOLOOP_COST_FOR_GENERIC | |
7946 | ||
7947 | @hook TARGET_DOLOOP_COST_FOR_ADDRESS | |
7948 | ||
1d0216c8 RS |
7949 | @hook TARGET_CAN_USE_DOLOOP_P |
7950 | ||
38f8b050 JR |
7951 | @hook TARGET_INVALID_WITHIN_DOLOOP |
7952 | ||
aafa38b5 JG |
7953 | @hook TARGET_PREFERRED_DOLOOP_MODE |
7954 | ||
78e4f1ad UB |
7955 | @hook TARGET_LEGITIMATE_COMBINED_INSN |
7956 | ||
4b4de898 JR |
7957 | @hook TARGET_CAN_FOLLOW_JUMP |
7958 | ||
38f8b050 | 7959 | @hook TARGET_COMMUTATIVE_P |
38f8b050 JR |
7960 | |
7961 | @hook TARGET_ALLOCATE_INITIAL_VALUE | |
7962 | ||
38f8b050 | 7963 | @hook TARGET_UNSPEC_MAY_TRAP_P |
38f8b050 JR |
7964 | |
7965 | @hook TARGET_SET_CURRENT_FUNCTION | |
38f8b050 JR |
7966 | |
7967 | @defmac TARGET_OBJECT_SUFFIX | |
7968 | Define this macro to be a C string representing the suffix for object | |
7969 | files on your target machine. If you do not define this macro, GCC will | |
7970 | use @samp{.o} as the suffix for object files. | |
7971 | @end defmac | |
7972 | ||
7973 | @defmac TARGET_EXECUTABLE_SUFFIX | |
7974 | Define this macro to be a C string representing the suffix to be | |
7975 | automatically added to executable files on your target machine. If you | |
7976 | do not define this macro, GCC will use the null string as the suffix for | |
7977 | executable files. | |
7978 | @end defmac | |
7979 | ||
7980 | @defmac COLLECT_EXPORT_LIST | |
7981 | If defined, @code{collect2} will scan the individual object files | |
7982 | specified on its command line and create an export list for the linker. | |
7983 | Define this macro for systems like AIX, where the linker discards | |
7984 | object files that are not referenced from @code{main} and uses export | |
7985 | lists. | |
7986 | @end defmac | |
7987 | ||
38f8b050 | 7988 | @hook TARGET_CANNOT_MODIFY_JUMPS_P |
38f8b050 | 7989 | |
38f8b050 | 7990 | @hook TARGET_HAVE_CONDITIONAL_EXECUTION |
38f8b050 | 7991 | |
2e0f1341 ZC |
7992 | @hook TARGET_GEN_CCMP_FIRST |
7993 | ||
7994 | @hook TARGET_GEN_CCMP_NEXT | |
7995 | ||
e5e164ef L |
7996 | @hook TARGET_GEN_MEMSET_SCRATCH_RTX |
7997 | ||
38f8b050 | 7998 | @hook TARGET_LOOP_UNROLL_ADJUST |
38f8b050 JR |
7999 | |
8000 | @defmac POWI_MAX_MULTS | |
8001 | If defined, this macro is interpreted as a signed integer C expression | |
8002 | that specifies the maximum number of floating point multiplications | |
8003 | that should be emitted when expanding exponentiation by an integer | |
8004 | constant inline. When this value is defined, exponentiation requiring | |
8005 | more than this number of multiplications is implemented by calling the | |
8006 | system library's @code{pow}, @code{powf} or @code{powl} routines. | |
8007 | The default value places no upper bound on the multiplication count. | |
8008 | @end defmac | |
8009 | ||
8010 | @deftypefn Macro void TARGET_EXTRA_INCLUDES (const char *@var{sysroot}, const char *@var{iprefix}, int @var{stdinc}) | |
8011 | This target hook should register any extra include files for the | |
8012 | target. The parameter @var{stdinc} indicates if normal include files | |
8013 | are present. The parameter @var{sysroot} is the system root directory. | |
8014 | The parameter @var{iprefix} is the prefix for the gcc directory. | |
8015 | @end deftypefn | |
8016 | ||
8017 | @deftypefn Macro void TARGET_EXTRA_PRE_INCLUDES (const char *@var{sysroot}, const char *@var{iprefix}, int @var{stdinc}) | |
8018 | This target hook should register any extra include files for the | |
8019 | target before any standard headers. The parameter @var{stdinc} | |
8020 | indicates if normal include files are present. The parameter | |
8021 | @var{sysroot} is the system root directory. The parameter | |
8022 | @var{iprefix} is the prefix for the gcc directory. | |
8023 | @end deftypefn | |
8024 | ||
8025 | @deftypefn Macro void TARGET_OPTF (char *@var{path}) | |
8026 | This target hook should register special include paths for the target. | |
8027 | The parameter @var{path} is the include to register. On Darwin | |
8028 | systems, this is used for Framework includes, which have semantics | |
8029 | that are different from @option{-I}. | |
8030 | @end deftypefn | |
8031 | ||
8032 | @defmac bool TARGET_USE_LOCAL_THUNK_ALIAS_P (tree @var{fndecl}) | |
8033 | This target macro returns @code{true} if it is safe to use a local alias | |
8034 | for a virtual function @var{fndecl} when constructing thunks, | |
8035 | @code{false} otherwise. By default, the macro returns @code{true} for all | |
8036 | functions, if a target supports aliases (i.e.@: defines | |
8037 | @code{ASM_OUTPUT_DEF}), @code{false} otherwise, | |
8038 | @end defmac | |
8039 | ||
8040 | @defmac TARGET_FORMAT_TYPES | |
8041 | If defined, this macro is the name of a global variable containing | |
8042 | target-specific format checking information for the @option{-Wformat} | |
8043 | option. The default is to have no target-specific format checks. | |
8044 | @end defmac | |
8045 | ||
8046 | @defmac TARGET_N_FORMAT_TYPES | |
8047 | If defined, this macro is the number of entries in | |
8048 | @code{TARGET_FORMAT_TYPES}. | |
8049 | @end defmac | |
8050 | ||
8051 | @defmac TARGET_OVERRIDES_FORMAT_ATTRIBUTES | |
8052 | If defined, this macro is the name of a global variable containing | |
8053 | target-specific format overrides for the @option{-Wformat} option. The | |
8054 | default is to have no target-specific format overrides. If defined, | |
8055 | @code{TARGET_FORMAT_TYPES} must be defined, too. | |
8056 | @end defmac | |
8057 | ||
8058 | @defmac TARGET_OVERRIDES_FORMAT_ATTRIBUTES_COUNT | |
8059 | If defined, this macro specifies the number of entries in | |
8060 | @code{TARGET_OVERRIDES_FORMAT_ATTRIBUTES}. | |
8061 | @end defmac | |
8062 | ||
8063 | @defmac TARGET_OVERRIDES_FORMAT_INIT | |
8064 | If defined, this macro specifies the optional initialization | |
8065 | routine for target specific customizations of the system printf | |
8066 | and scanf formatter settings. | |
8067 | @end defmac | |
8068 | ||
38f8b050 | 8069 | @hook TARGET_INVALID_ARG_FOR_UNPROTOTYPED_FN |
38f8b050 JR |
8070 | |
8071 | @hook TARGET_INVALID_CONVERSION | |
38f8b050 JR |
8072 | |
8073 | @hook TARGET_INVALID_UNARY_OP | |
38f8b050 JR |
8074 | |
8075 | @hook TARGET_INVALID_BINARY_OP | |
38f8b050 | 8076 | |
38f8b050 | 8077 | @hook TARGET_PROMOTED_TYPE |
38f8b050 JR |
8078 | |
8079 | @hook TARGET_CONVERT_TO_TYPE | |
38f8b050 | 8080 | |
65ef05d0 RS |
8081 | @hook TARGET_VERIFY_TYPE_CONTEXT |
8082 | ||
38f8b050 JR |
8083 | @defmac OBJC_JBLEN |
8084 | This macro determines the size of the objective C jump buffer for the | |
8085 | NeXT runtime. By default, OBJC_JBLEN is defined to an innocuous value. | |
8086 | @end defmac | |
8087 | ||
8088 | @defmac LIBGCC2_UNWIND_ATTRIBUTE | |
8089 | Define this macro if any target-specific attributes need to be attached | |
ff2ce160 | 8090 | to the functions in @file{libgcc} that provide low-level support for |
38f8b050 JR |
8091 | call stack unwinding. It is used in declarations in @file{unwind-generic.h} |
8092 | and the associated definitions of those functions. | |
8093 | @end defmac | |
8094 | ||
8095 | @hook TARGET_UPDATE_STACK_BOUNDARY | |
38f8b050 JR |
8096 | |
8097 | @hook TARGET_GET_DRAP_RTX | |
38f8b050 | 8098 | |
d10f3e90 | 8099 | @hook TARGET_ZERO_CALL_USED_REGS |
8100 | ||
38f8b050 | 8101 | @hook TARGET_ALLOCATE_STACK_SLOTS_FOR_ARGS |
38f8b050 JR |
8102 | |
8103 | @hook TARGET_CONST_ANCHOR | |
57c5ab1b | 8104 | |
dfe06d3e JJ |
8105 | @hook TARGET_ASAN_SHADOW_OFFSET |
8106 | ||
5dcfdccd | 8107 | @hook TARGET_MEMMODEL_CHECK |
5dcfdccd | 8108 | |
57c5ab1b | 8109 | @hook TARGET_ATOMIC_TEST_AND_SET_TRUEVAL |
2f251a05 AI |
8110 | |
8111 | @hook TARGET_HAS_IFUNC_P | |
267bac10 | 8112 | |
fceec4d3 AM |
8113 | @hook TARGET_ATOMIC_ALIGN_FOR_MODE |
8114 | ||
267bac10 | 8115 | @hook TARGET_ATOMIC_ASSIGN_EXPAND_FENV |
807e902e | 8116 | |
ec6fe917 IV |
8117 | @hook TARGET_RECORD_OFFLOAD_SYMBOL |
8118 | ||
c713ddc0 BS |
8119 | @hook TARGET_OFFLOAD_OPTIONS |
8120 | ||
807e902e KZ |
8121 | @defmac TARGET_SUPPORTS_WIDE_INT |
8122 | ||
8123 | On older ports, large integers are stored in @code{CONST_DOUBLE} rtl | |
8124 | objects. Newer ports define @code{TARGET_SUPPORTS_WIDE_INT} to be nonzero | |
8125 | to indicate that large integers are stored in | |
8126 | @code{CONST_WIDE_INT} rtl objects. The @code{CONST_WIDE_INT} allows | |
8127 | very large integer constants to be represented. @code{CONST_DOUBLE} | |
8128 | is limited to twice the size of the host's @code{HOST_WIDE_INT} | |
8129 | representation. | |
8130 | ||
8131 | Converting a port mostly requires looking for the places where | |
8132 | @code{CONST_DOUBLE}s are used with @code{VOIDmode} and replacing that | |
8133 | code with code that accesses @code{CONST_WIDE_INT}s. @samp{"grep -i | |
8134 | const_double"} at the port level gets you to 95% of the changes that | |
8135 | need to be made. There are a few places that require a deeper look. | |
8136 | ||
8137 | @itemize @bullet | |
8138 | @item | |
8139 | There is no equivalent to @code{hval} and @code{lval} for | |
8140 | @code{CONST_WIDE_INT}s. This would be difficult to express in the md | |
8141 | language since there are a variable number of elements. | |
8142 | ||
8143 | Most ports only check that @code{hval} is either 0 or -1 to see if the | |
8144 | value is small. As mentioned above, this will no longer be necessary | |
8145 | since small constants are always @code{CONST_INT}. Of course there | |
8146 | are still a few exceptions, the alpha's constraint used by the zap | |
8147 | instruction certainly requires careful examination by C code. | |
8148 | However, all the current code does is pass the hval and lval to C | |
8149 | code, so evolving the c code to look at the @code{CONST_WIDE_INT} is | |
8150 | not really a large change. | |
8151 | ||
8152 | @item | |
8153 | Because there is no standard template that ports use to materialize | |
8154 | constants, there is likely to be some futzing that is unique to each | |
8155 | port in this code. | |
8156 | ||
8157 | @item | |
8158 | The rtx costs may have to be adjusted to properly account for larger | |
8159 | constants that are represented as @code{CONST_WIDE_INT}. | |
8160 | @end itemize | |
8161 | ||
8162 | All and all it does not take long to convert ports that the | |
8163 | maintainer is familiar with. | |
8164 | ||
8165 | @end defmac | |
40af5894 | 8166 | |
425fc685 RE |
8167 | @hook TARGET_HAVE_SPECULATION_SAFE_VALUE |
8168 | ||
8169 | @hook TARGET_SPECULATION_SAFE_VALUE | |
8170 | ||
40af5894 | 8171 | @hook TARGET_RUN_TARGET_SELFTESTS |
3bd87832 MM |
8172 | |
8173 | @hook TARGET_MEMTAG_CAN_TAG_ADDRESSES | |
0854b584 MM |
8174 | |
8175 | @hook TARGET_MEMTAG_TAG_SIZE | |
8176 | ||
8177 | @hook TARGET_MEMTAG_GRANULE_SIZE | |
8178 | ||
8179 | @hook TARGET_MEMTAG_INSERT_RANDOM_TAG | |
8180 | ||
8181 | @hook TARGET_MEMTAG_ADD_TAG | |
8182 | ||
8183 | @hook TARGET_MEMTAG_SET_TAG | |
8184 | ||
8185 | @hook TARGET_MEMTAG_EXTRACT_TAG | |
8186 | ||
8187 | @hook TARGET_MEMTAG_UNTAGGED_POINTER | |
8cdcea51 SH |
8188 | |
8189 | @hook TARGET_GCOV_TYPE_SIZE |