]>
Commit | Line | Data |
---|---|---|
23a5b65a | 1 | @c Copyright (C) 1988-2014 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. | |
35 | * Old Constraints:: The old way to define machine-specific constraints. | |
36 | * Stack and Calling:: Defining which way the stack grows and by how much. | |
37 | * Varargs:: Defining the varargs macros. | |
38 | * Trampolines:: Code set up at run time to enter a nested function. | |
39 | * Library Calls:: Controlling how library routines are implicitly called. | |
40 | * Addressing Modes:: Defining addressing modes valid for memory operands. | |
41 | * Anchored Addresses:: Defining how @option{-fsection-anchors} should work. | |
42 | * Condition Code:: Defining how insns update the condition code. | |
43 | * Costs:: Defining relative costs of different operations. | |
44 | * Scheduling:: Adjusting the behavior of the instruction scheduler. | |
45 | * Sections:: Dividing storage into text, data, and other sections. | |
46 | * PIC:: Macros for position independent code. | |
47 | * Assembler Format:: Defining how to write insns and pseudo-ops to output. | |
48 | * Debugging Info:: Defining the format of debugging output. | |
49 | * Floating Point:: Handling floating point for cross-compilers. | |
50 | * Mode Switching:: Insertion of mode-switching instructions. | |
51 | * Target Attributes:: Defining target-specific uses of @code{__attribute__}. | |
52 | * Emulated TLS:: Emulated TLS support. | |
53 | * MIPS Coprocessors:: MIPS coprocessor support and how to customize it. | |
54 | * PCH Target:: Validity checking for precompiled headers. | |
55 | * C++ ABI:: Controlling C++ ABI changes. | |
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 | ||
38f8b050 JR |
110 | @node Driver |
111 | @section Controlling the Compilation Driver, @file{gcc} | |
112 | @cindex driver | |
113 | @cindex controlling the compilation driver | |
114 | ||
115 | @c prevent bad page break with this line | |
116 | You can control the compilation driver. | |
117 | ||
38f8b050 JR |
118 | @defmac DRIVER_SELF_SPECS |
119 | A list of specs for the driver itself. It should be a suitable | |
120 | initializer for an array of strings, with no surrounding braces. | |
121 | ||
122 | The driver applies these specs to its own command line between loading | |
123 | default @file{specs} files (but not command-line specified ones) and | |
124 | choosing the multilib directory or running any subcommands. It | |
125 | applies them in the order given, so each spec can depend on the | |
126 | options added by earlier ones. It is also possible to remove options | |
127 | using @samp{%<@var{option}} in the usual way. | |
128 | ||
129 | This macro can be useful when a port has several interdependent target | |
130 | options. It provides a way of standardizing the command line so | |
131 | that the other specs are easier to write. | |
132 | ||
133 | Do not define this macro if it does not need to do anything. | |
134 | @end defmac | |
135 | ||
136 | @defmac OPTION_DEFAULT_SPECS | |
137 | A list of specs used to support configure-time default options (i.e.@: | |
138 | @option{--with} options) in the driver. It should be a suitable initializer | |
139 | for an array of structures, each containing two strings, without the | |
140 | outermost pair of surrounding braces. | |
141 | ||
142 | The first item in the pair is the name of the default. This must match | |
143 | the code in @file{config.gcc} for the target. The second item is a spec | |
144 | to apply if a default with this name was specified. The string | |
145 | @samp{%(VALUE)} in the spec will be replaced by the value of the default | |
146 | everywhere it occurs. | |
147 | ||
148 | The driver will apply these specs to its own command line between loading | |
149 | default @file{specs} files and processing @code{DRIVER_SELF_SPECS}, using | |
150 | the same mechanism as @code{DRIVER_SELF_SPECS}. | |
151 | ||
152 | Do not define this macro if it does not need to do anything. | |
153 | @end defmac | |
154 | ||
155 | @defmac CPP_SPEC | |
156 | A C string constant that tells the GCC driver program options to | |
157 | pass to CPP@. It can also specify how to translate options you | |
158 | give to GCC into options for GCC to pass to the CPP@. | |
159 | ||
160 | Do not define this macro if it does not need to do anything. | |
161 | @end defmac | |
162 | ||
163 | @defmac CPLUSPLUS_CPP_SPEC | |
164 | This macro is just like @code{CPP_SPEC}, but is used for C++, rather | |
165 | than C@. If you do not define this macro, then the value of | |
166 | @code{CPP_SPEC} (if any) will be used instead. | |
167 | @end defmac | |
168 | ||
169 | @defmac CC1_SPEC | |
170 | A C string constant that tells the GCC driver program options to | |
171 | pass to @code{cc1}, @code{cc1plus}, @code{f771}, and the other language | |
172 | front ends. | |
173 | It can also specify how to translate options you give to GCC into options | |
174 | for GCC to pass to front ends. | |
175 | ||
176 | Do not define this macro if it does not need to do anything. | |
177 | @end defmac | |
178 | ||
179 | @defmac CC1PLUS_SPEC | |
180 | A C string constant that tells the GCC driver program options to | |
181 | pass to @code{cc1plus}. It can also specify how to translate options you | |
182 | give to GCC into options for GCC to pass to the @code{cc1plus}. | |
183 | ||
184 | Do not define this macro if it does not need to do anything. | |
185 | Note that everything defined in CC1_SPEC is already passed to | |
186 | @code{cc1plus} so there is no need to duplicate the contents of | |
187 | CC1_SPEC in CC1PLUS_SPEC@. | |
188 | @end defmac | |
189 | ||
190 | @defmac ASM_SPEC | |
191 | A C string constant that tells the GCC driver program options to | |
192 | pass to the assembler. It can also specify how to translate options | |
193 | you give to GCC into options for GCC to pass to the assembler. | |
194 | See the file @file{sun3.h} for an example of this. | |
195 | ||
196 | Do not define this macro if it does not need to do anything. | |
197 | @end defmac | |
198 | ||
199 | @defmac ASM_FINAL_SPEC | |
200 | A C string constant that tells the GCC driver program how to | |
201 | run any programs which cleanup after the normal assembler. | |
202 | Normally, this is not needed. See the file @file{mips.h} for | |
203 | an example of this. | |
204 | ||
205 | Do not define this macro if it does not need to do anything. | |
206 | @end defmac | |
207 | ||
208 | @defmac AS_NEEDS_DASH_FOR_PIPED_INPUT | |
209 | Define this macro, with no value, if the driver should give the assembler | |
210 | an argument consisting of a single dash, @option{-}, to instruct it to | |
211 | read from its standard input (which will be a pipe connected to the | |
212 | output of the compiler proper). This argument is given after any | |
213 | @option{-o} option specifying the name of the output file. | |
214 | ||
215 | If you do not define this macro, the assembler is assumed to read its | |
216 | standard input if given no non-option arguments. If your assembler | |
217 | cannot read standard input at all, use a @samp{%@{pipe:%e@}} construct; | |
218 | see @file{mips.h} for instance. | |
219 | @end defmac | |
220 | ||
221 | @defmac LINK_SPEC | |
222 | A C string constant that tells the GCC driver program options to | |
223 | pass to the linker. It can also specify how to translate options you | |
224 | give to GCC into options for GCC to pass to the linker. | |
225 | ||
226 | Do not define this macro if it does not need to do anything. | |
227 | @end defmac | |
228 | ||
229 | @defmac LIB_SPEC | |
230 | Another C string constant used much like @code{LINK_SPEC}. The difference | |
231 | between the two is that @code{LIB_SPEC} is used at the end of the | |
232 | command given to the linker. | |
233 | ||
234 | If this macro is not defined, a default is provided that | |
235 | loads the standard C library from the usual place. See @file{gcc.c}. | |
236 | @end defmac | |
237 | ||
238 | @defmac LIBGCC_SPEC | |
239 | Another C string constant that tells the GCC driver program | |
240 | how and when to place a reference to @file{libgcc.a} into the | |
241 | linker command line. This constant is placed both before and after | |
242 | the value of @code{LIB_SPEC}. | |
243 | ||
244 | If this macro is not defined, the GCC driver provides a default that | |
245 | passes the string @option{-lgcc} to the linker. | |
246 | @end defmac | |
247 | ||
248 | @defmac REAL_LIBGCC_SPEC | |
249 | By default, if @code{ENABLE_SHARED_LIBGCC} is defined, the | |
250 | @code{LIBGCC_SPEC} is not directly used by the driver program but is | |
251 | instead modified to refer to different versions of @file{libgcc.a} | |
252 | depending on the values of the command line flags @option{-static}, | |
253 | @option{-shared}, @option{-static-libgcc}, and @option{-shared-libgcc}. On | |
254 | targets where these modifications are inappropriate, define | |
255 | @code{REAL_LIBGCC_SPEC} instead. @code{REAL_LIBGCC_SPEC} tells the | |
256 | driver how to place a reference to @file{libgcc} on the link command | |
257 | line, but, unlike @code{LIBGCC_SPEC}, it is used unmodified. | |
258 | @end defmac | |
259 | ||
260 | @defmac USE_LD_AS_NEEDED | |
261 | A macro that controls the modifications to @code{LIBGCC_SPEC} | |
262 | mentioned in @code{REAL_LIBGCC_SPEC}. If nonzero, a spec will be | |
e927b6ad RO |
263 | generated that uses @option{--as-needed} or equivalent options and the |
264 | shared @file{libgcc} in place of the | |
38f8b050 JR |
265 | static exception handler library, when linking without any of |
266 | @code{-static}, @code{-static-libgcc}, or @code{-shared-libgcc}. | |
267 | @end defmac | |
268 | ||
269 | @defmac LINK_EH_SPEC | |
270 | If defined, this C string constant is added to @code{LINK_SPEC}. | |
271 | When @code{USE_LD_AS_NEEDED} is zero or undefined, it also affects | |
272 | the modifications to @code{LIBGCC_SPEC} mentioned in | |
273 | @code{REAL_LIBGCC_SPEC}. | |
274 | @end defmac | |
275 | ||
276 | @defmac STARTFILE_SPEC | |
277 | Another C string constant used much like @code{LINK_SPEC}. The | |
278 | difference between the two is that @code{STARTFILE_SPEC} is used at | |
279 | the very beginning of the command given to the linker. | |
280 | ||
281 | If this macro is not defined, a default is provided that loads the | |
282 | standard C startup file from the usual place. See @file{gcc.c}. | |
283 | @end defmac | |
284 | ||
285 | @defmac ENDFILE_SPEC | |
286 | Another C string constant used much like @code{LINK_SPEC}. The | |
287 | difference between the two is that @code{ENDFILE_SPEC} is used at | |
288 | the very end of the command given to the linker. | |
289 | ||
290 | Do not define this macro if it does not need to do anything. | |
291 | @end defmac | |
292 | ||
293 | @defmac THREAD_MODEL_SPEC | |
294 | GCC @code{-v} will print the thread model GCC was configured to use. | |
295 | However, this doesn't work on platforms that are multilibbed on thread | |
296 | models, such as AIX 4.3. On such platforms, define | |
297 | @code{THREAD_MODEL_SPEC} such that it evaluates to a string without | |
298 | blanks that names one of the recognized thread models. @code{%*}, the | |
299 | default value of this macro, will expand to the value of | |
300 | @code{thread_file} set in @file{config.gcc}. | |
301 | @end defmac | |
302 | ||
303 | @defmac SYSROOT_SUFFIX_SPEC | |
304 | Define this macro to add a suffix to the target sysroot when GCC is | |
305 | configured with a sysroot. This will cause GCC to search for usr/lib, | |
306 | et al, within sysroot+suffix. | |
307 | @end defmac | |
308 | ||
309 | @defmac SYSROOT_HEADERS_SUFFIX_SPEC | |
310 | Define this macro to add a headers_suffix to the target sysroot when | |
311 | GCC is configured with a sysroot. This will cause GCC to pass the | |
312 | updated sysroot+headers_suffix to CPP, causing it to search for | |
313 | usr/include, et al, within sysroot+headers_suffix. | |
314 | @end defmac | |
315 | ||
316 | @defmac EXTRA_SPECS | |
317 | Define this macro to provide additional specifications to put in the | |
318 | @file{specs} file that can be used in various specifications like | |
319 | @code{CC1_SPEC}. | |
320 | ||
321 | The definition should be an initializer for an array of structures, | |
322 | containing a string constant, that defines the specification name, and a | |
323 | string constant that provides the specification. | |
324 | ||
325 | Do not define this macro if it does not need to do anything. | |
326 | ||
327 | @code{EXTRA_SPECS} is useful when an architecture contains several | |
328 | related targets, which have various @code{@dots{}_SPECS} which are similar | |
329 | to each other, and the maintainer would like one central place to keep | |
330 | these definitions. | |
331 | ||
332 | For example, the PowerPC System V.4 targets use @code{EXTRA_SPECS} to | |
333 | define either @code{_CALL_SYSV} when the System V calling sequence is | |
334 | used or @code{_CALL_AIX} when the older AIX-based calling sequence is | |
335 | used. | |
336 | ||
337 | The @file{config/rs6000/rs6000.h} target file defines: | |
338 | ||
339 | @smallexample | |
340 | #define EXTRA_SPECS \ | |
341 | @{ "cpp_sysv_default", CPP_SYSV_DEFAULT @}, | |
342 | ||
343 | #define CPP_SYS_DEFAULT "" | |
344 | @end smallexample | |
345 | ||
346 | The @file{config/rs6000/sysv.h} target file defines: | |
347 | @smallexample | |
348 | #undef CPP_SPEC | |
349 | #define CPP_SPEC \ | |
350 | "%@{posix: -D_POSIX_SOURCE @} \ | |
351 | %@{mcall-sysv: -D_CALL_SYSV @} \ | |
352 | %@{!mcall-sysv: %(cpp_sysv_default) @} \ | |
353 | %@{msoft-float: -D_SOFT_FLOAT@} %@{mcpu=403: -D_SOFT_FLOAT@}" | |
354 | ||
355 | #undef CPP_SYSV_DEFAULT | |
356 | #define CPP_SYSV_DEFAULT "-D_CALL_SYSV" | |
357 | @end smallexample | |
358 | ||
359 | while the @file{config/rs6000/eabiaix.h} target file defines | |
360 | @code{CPP_SYSV_DEFAULT} as: | |
361 | ||
362 | @smallexample | |
363 | #undef CPP_SYSV_DEFAULT | |
364 | #define CPP_SYSV_DEFAULT "-D_CALL_AIX" | |
365 | @end smallexample | |
366 | @end defmac | |
367 | ||
368 | @defmac LINK_LIBGCC_SPECIAL_1 | |
369 | Define this macro if the driver program should find the library | |
370 | @file{libgcc.a}. If you do not define this macro, the driver program will pass | |
371 | the argument @option{-lgcc} to tell the linker to do the search. | |
372 | @end defmac | |
373 | ||
374 | @defmac LINK_GCC_C_SEQUENCE_SPEC | |
375 | The sequence in which libgcc and libc are specified to the linker. | |
376 | By default this is @code{%G %L %G}. | |
377 | @end defmac | |
378 | ||
379 | @defmac LINK_COMMAND_SPEC | |
380 | A C string constant giving the complete command line need to execute the | |
381 | linker. When you do this, you will need to update your port each time a | |
382 | change is made to the link command line within @file{gcc.c}. Therefore, | |
383 | define this macro only if you need to completely redefine the command | |
384 | line for invoking the linker and there is no other way to accomplish | |
385 | the effect you need. Overriding this macro may be avoidable by overriding | |
386 | @code{LINK_GCC_C_SEQUENCE_SPEC} instead. | |
387 | @end defmac | |
388 | ||
c49a6962 JM |
389 | @hook TARGET_ALWAYS_STRIP_DOTDOT |
390 | ||
38f8b050 JR |
391 | @defmac MULTILIB_DEFAULTS |
392 | Define this macro as a C expression for the initializer of an array of | |
393 | string to tell the driver program which options are defaults for this | |
394 | target and thus do not need to be handled specially when using | |
395 | @code{MULTILIB_OPTIONS}. | |
396 | ||
397 | Do not define this macro if @code{MULTILIB_OPTIONS} is not defined in | |
398 | the target makefile fragment or if none of the options listed in | |
399 | @code{MULTILIB_OPTIONS} are set by default. | |
400 | @xref{Target Fragment}. | |
401 | @end defmac | |
402 | ||
403 | @defmac RELATIVE_PREFIX_NOT_LINKDIR | |
404 | Define this macro to tell @command{gcc} that it should only translate | |
405 | a @option{-B} prefix into a @option{-L} linker option if the prefix | |
406 | indicates an absolute file name. | |
407 | @end defmac | |
408 | ||
409 | @defmac MD_EXEC_PREFIX | |
410 | If defined, this macro is an additional prefix to try after | |
411 | @code{STANDARD_EXEC_PREFIX}. @code{MD_EXEC_PREFIX} is not searched | |
412 | when the compiler is built as a cross | |
413 | compiler. If you define @code{MD_EXEC_PREFIX}, then be sure to add it | |
414 | to the list of directories used to find the assembler in @file{configure.in}. | |
415 | @end defmac | |
416 | ||
417 | @defmac STANDARD_STARTFILE_PREFIX | |
418 | Define this macro as a C string constant if you wish to override the | |
419 | standard choice of @code{libdir} as the default prefix to | |
420 | try when searching for startup files such as @file{crt0.o}. | |
421 | @code{STANDARD_STARTFILE_PREFIX} is not searched when the compiler | |
422 | is built as a cross compiler. | |
423 | @end defmac | |
424 | ||
425 | @defmac STANDARD_STARTFILE_PREFIX_1 | |
426 | Define this macro as a C string constant if you wish to override the | |
427 | standard choice of @code{/lib} as a prefix to try after the default prefix | |
428 | when searching for startup files such as @file{crt0.o}. | |
429 | @code{STANDARD_STARTFILE_PREFIX_1} is not searched when the compiler | |
430 | is built as a cross compiler. | |
431 | @end defmac | |
432 | ||
433 | @defmac STANDARD_STARTFILE_PREFIX_2 | |
434 | Define this macro as a C string constant if you wish to override the | |
435 | standard choice of @code{/lib} as yet another prefix to try after the | |
436 | default prefix when searching for startup files such as @file{crt0.o}. | |
437 | @code{STANDARD_STARTFILE_PREFIX_2} is not searched when the compiler | |
438 | is built as a cross compiler. | |
439 | @end defmac | |
440 | ||
441 | @defmac MD_STARTFILE_PREFIX | |
442 | If defined, this macro supplies an additional prefix to try after the | |
443 | standard prefixes. @code{MD_EXEC_PREFIX} is not searched when the | |
444 | compiler is built as a cross compiler. | |
445 | @end defmac | |
446 | ||
447 | @defmac MD_STARTFILE_PREFIX_1 | |
448 | If defined, this macro supplies yet another prefix to try after the | |
449 | standard prefixes. It is not searched when the compiler is built as a | |
450 | cross compiler. | |
451 | @end defmac | |
452 | ||
453 | @defmac INIT_ENVIRONMENT | |
454 | Define this macro as a C string constant if you wish to set environment | |
455 | variables for programs called by the driver, such as the assembler and | |
456 | loader. The driver passes the value of this macro to @code{putenv} to | |
457 | initialize the necessary environment variables. | |
458 | @end defmac | |
459 | ||
460 | @defmac LOCAL_INCLUDE_DIR | |
461 | Define this macro as a C string constant if you wish to override the | |
462 | standard choice of @file{/usr/local/include} as the default prefix to | |
463 | try when searching for local header files. @code{LOCAL_INCLUDE_DIR} | |
08b2bad2 SB |
464 | comes before @code{NATIVE_SYSTEM_HEADER_DIR} (set in |
465 | @file{config.gcc}, normally @file{/usr/include}) in the search order. | |
38f8b050 JR |
466 | |
467 | Cross compilers do not search either @file{/usr/local/include} or its | |
468 | replacement. | |
469 | @end defmac | |
470 | ||
08b2bad2 SB |
471 | @defmac NATIVE_SYSTEM_HEADER_COMPONENT |
472 | The ``component'' corresponding to @code{NATIVE_SYSTEM_HEADER_DIR}. | |
38f8b050 JR |
473 | See @code{INCLUDE_DEFAULTS}, below, for the description of components. |
474 | If you do not define this macro, no component is used. | |
475 | @end defmac | |
476 | ||
477 | @defmac INCLUDE_DEFAULTS | |
478 | Define this macro if you wish to override the entire default search path | |
479 | for include files. For a native compiler, the default search path | |
480 | usually consists of @code{GCC_INCLUDE_DIR}, @code{LOCAL_INCLUDE_DIR}, | |
08b2bad2 SB |
481 | @code{GPLUSPLUS_INCLUDE_DIR}, and |
482 | @code{NATIVE_SYSTEM_HEADER_DIR}. In addition, @code{GPLUSPLUS_INCLUDE_DIR} | |
38f8b050 JR |
483 | and @code{GCC_INCLUDE_DIR} are defined automatically by @file{Makefile}, |
484 | and specify private search areas for GCC@. The directory | |
485 | @code{GPLUSPLUS_INCLUDE_DIR} is used only for C++ programs. | |
486 | ||
487 | The definition should be an initializer for an array of structures. | |
488 | Each array element should have four elements: the directory name (a | |
489 | string constant), the component name (also a string constant), a flag | |
490 | for C++-only directories, | |
491 | and a flag showing that the includes in the directory don't need to be | |
492 | wrapped in @code{extern @samp{C}} when compiling C++. Mark the end of | |
493 | the array with a null element. | |
494 | ||
495 | The component name denotes what GNU package the include file is part of, | |
496 | if any, in all uppercase letters. For example, it might be @samp{GCC} | |
497 | or @samp{BINUTILS}. If the package is part of a vendor-supplied | |
498 | operating system, code the component name as @samp{0}. | |
499 | ||
500 | For example, here is the definition used for VAX/VMS: | |
501 | ||
502 | @smallexample | |
503 | #define INCLUDE_DEFAULTS \ | |
504 | @{ \ | |
505 | @{ "GNU_GXX_INCLUDE:", "G++", 1, 1@}, \ | |
506 | @{ "GNU_CC_INCLUDE:", "GCC", 0, 0@}, \ | |
507 | @{ "SYS$SYSROOT:[SYSLIB.]", 0, 0, 0@}, \ | |
508 | @{ ".", 0, 0, 0@}, \ | |
509 | @{ 0, 0, 0, 0@} \ | |
510 | @} | |
511 | @end smallexample | |
512 | @end defmac | |
513 | ||
514 | Here is the order of prefixes tried for exec files: | |
515 | ||
516 | @enumerate | |
517 | @item | |
518 | Any prefixes specified by the user with @option{-B}. | |
519 | ||
520 | @item | |
521 | The environment variable @code{GCC_EXEC_PREFIX} or, if @code{GCC_EXEC_PREFIX} | |
ff2ce160 | 522 | is not set and the compiler has not been installed in the configure-time |
38f8b050 JR |
523 | @var{prefix}, the location in which the compiler has actually been installed. |
524 | ||
525 | @item | |
526 | The directories specified by the environment variable @code{COMPILER_PATH}. | |
527 | ||
528 | @item | |
529 | The macro @code{STANDARD_EXEC_PREFIX}, if the compiler has been installed | |
ff2ce160 | 530 | in the configured-time @var{prefix}. |
38f8b050 JR |
531 | |
532 | @item | |
ff2ce160 | 533 | The location @file{/usr/libexec/gcc/}, but only if this is a native compiler. |
38f8b050 JR |
534 | |
535 | @item | |
ff2ce160 | 536 | The location @file{/usr/lib/gcc/}, but only if this is a native compiler. |
38f8b050 JR |
537 | |
538 | @item | |
ff2ce160 | 539 | The macro @code{MD_EXEC_PREFIX}, if defined, but only if this is a native |
38f8b050 JR |
540 | compiler. |
541 | @end enumerate | |
542 | ||
543 | Here is the order of prefixes tried for startfiles: | |
544 | ||
545 | @enumerate | |
546 | @item | |
547 | Any prefixes specified by the user with @option{-B}. | |
548 | ||
549 | @item | |
550 | The environment variable @code{GCC_EXEC_PREFIX} or its automatically determined | |
551 | value based on the installed toolchain location. | |
552 | ||
553 | @item | |
554 | The directories specified by the environment variable @code{LIBRARY_PATH} | |
555 | (or port-specific name; native only, cross compilers do not use this). | |
556 | ||
557 | @item | |
558 | The macro @code{STANDARD_EXEC_PREFIX}, but only if the toolchain is installed | |
ff2ce160 | 559 | in the configured @var{prefix} or this is a native compiler. |
38f8b050 JR |
560 | |
561 | @item | |
562 | The location @file{/usr/lib/gcc/}, but only if this is a native compiler. | |
563 | ||
564 | @item | |
ff2ce160 | 565 | The macro @code{MD_EXEC_PREFIX}, if defined, but only if this is a native |
38f8b050 JR |
566 | compiler. |
567 | ||
568 | @item | |
ff2ce160 | 569 | The macro @code{MD_STARTFILE_PREFIX}, if defined, but only if this is a |
38f8b050 JR |
570 | native compiler, or we have a target system root. |
571 | ||
572 | @item | |
ff2ce160 | 573 | The macro @code{MD_STARTFILE_PREFIX_1}, if defined, but only if this is a |
38f8b050 JR |
574 | native compiler, or we have a target system root. |
575 | ||
576 | @item | |
577 | The macro @code{STANDARD_STARTFILE_PREFIX}, with any sysroot modifications. | |
578 | If this path is relative it will be prefixed by @code{GCC_EXEC_PREFIX} and | |
579 | the machine suffix or @code{STANDARD_EXEC_PREFIX} and the machine suffix. | |
580 | ||
581 | @item | |
582 | The macro @code{STANDARD_STARTFILE_PREFIX_1}, but only if this is a native | |
583 | compiler, or we have a target system root. The default for this macro is | |
584 | @file{/lib/}. | |
585 | ||
586 | @item | |
587 | The macro @code{STANDARD_STARTFILE_PREFIX_2}, but only if this is a native | |
588 | compiler, or we have a target system root. The default for this macro is | |
589 | @file{/usr/lib/}. | |
590 | @end enumerate | |
591 | ||
592 | @node Run-time Target | |
593 | @section Run-time Target Specification | |
594 | @cindex run-time target specification | |
595 | @cindex predefined macros | |
596 | @cindex target specifications | |
597 | ||
598 | @c prevent bad page break with this line | |
599 | Here are run-time target specifications. | |
600 | ||
601 | @defmac TARGET_CPU_CPP_BUILTINS () | |
602 | This function-like macro expands to a block of code that defines | |
603 | built-in preprocessor macros and assertions for the target CPU, using | |
604 | the functions @code{builtin_define}, @code{builtin_define_std} and | |
605 | @code{builtin_assert}. When the front end | |
606 | calls this macro it provides a trailing semicolon, and since it has | |
607 | finished command line option processing your code can use those | |
608 | results freely. | |
609 | ||
610 | @code{builtin_assert} takes a string in the form you pass to the | |
611 | command-line option @option{-A}, such as @code{cpu=mips}, and creates | |
612 | the assertion. @code{builtin_define} takes a string in the form | |
613 | accepted by option @option{-D} and unconditionally defines the macro. | |
614 | ||
615 | @code{builtin_define_std} takes a string representing the name of an | |
616 | object-like macro. If it doesn't lie in the user's namespace, | |
617 | @code{builtin_define_std} defines it unconditionally. Otherwise, it | |
618 | defines a version with two leading underscores, and another version | |
619 | with two leading and trailing underscores, and defines the original | |
620 | only if an ISO standard was not requested on the command line. For | |
621 | example, passing @code{unix} defines @code{__unix}, @code{__unix__} | |
622 | and possibly @code{unix}; passing @code{_mips} defines @code{__mips}, | |
623 | @code{__mips__} and possibly @code{_mips}, and passing @code{_ABI64} | |
624 | defines only @code{_ABI64}. | |
625 | ||
626 | You can also test for the C dialect being compiled. The variable | |
627 | @code{c_language} is set to one of @code{clk_c}, @code{clk_cplusplus} | |
628 | or @code{clk_objective_c}. Note that if we are preprocessing | |
629 | assembler, this variable will be @code{clk_c} but the function-like | |
630 | macro @code{preprocessing_asm_p()} will return true, so you might want | |
631 | to check for that first. If you need to check for strict ANSI, the | |
632 | variable @code{flag_iso} can be used. The function-like macro | |
633 | @code{preprocessing_trad_p()} can be used to check for traditional | |
634 | preprocessing. | |
635 | @end defmac | |
636 | ||
637 | @defmac TARGET_OS_CPP_BUILTINS () | |
638 | Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional | |
639 | and is used for the target operating system instead. | |
640 | @end defmac | |
641 | ||
642 | @defmac TARGET_OBJFMT_CPP_BUILTINS () | |
643 | Similarly to @code{TARGET_CPU_CPP_BUILTINS} but this macro is optional | |
644 | and is used for the target object format. @file{elfos.h} uses this | |
645 | macro to define @code{__ELF__}, so you probably do not need to define | |
646 | it yourself. | |
647 | @end defmac | |
648 | ||
649 | @deftypevar {extern int} target_flags | |
650 | This variable is declared in @file{options.h}, which is included before | |
651 | any target-specific headers. | |
652 | @end deftypevar | |
653 | ||
654 | @hook TARGET_DEFAULT_TARGET_FLAGS | |
655 | This variable specifies the initial value of @code{target_flags}. | |
656 | Its default setting is 0. | |
657 | @end deftypevr | |
658 | ||
659 | @cindex optional hardware or system features | |
660 | @cindex features, optional, in system conventions | |
661 | ||
662 | @hook TARGET_HANDLE_OPTION | |
663 | This hook is called whenever the user specifies one of the | |
664 | target-specific options described by the @file{.opt} definition files | |
665 | (@pxref{Options}). It has the opportunity to do some option-specific | |
666 | processing and should return true if the option is valid. The default | |
667 | definition does nothing but return true. | |
668 | ||
96e45421 JM |
669 | @var{decoded} specifies the option and its arguments. @var{opts} and |
670 | @var{opts_set} are the @code{gcc_options} structures to be used for | |
671 | storing option state, and @var{loc} is the location at which the | |
672 | option was passed (@code{UNKNOWN_LOCATION} except for options passed | |
673 | via attributes). | |
38f8b050 JR |
674 | @end deftypefn |
675 | ||
676 | @hook TARGET_HANDLE_C_OPTION | |
677 | This target hook is called whenever the user specifies one of the | |
678 | target-specific C language family options described by the @file{.opt} | |
679 | definition files(@pxref{Options}). It has the opportunity to do some | |
680 | option-specific processing and should return true if the option is | |
681 | valid. The arguments are like for @code{TARGET_HANDLE_OPTION}. The | |
682 | default definition does nothing but return false. | |
683 | ||
684 | In general, you should use @code{TARGET_HANDLE_OPTION} to handle | |
685 | options. However, if processing an option requires routines that are | |
686 | only available in the C (and related language) front ends, then you | |
687 | should use @code{TARGET_HANDLE_C_OPTION} instead. | |
688 | @end deftypefn | |
689 | ||
91ebb981 IS |
690 | @hook TARGET_OBJC_CONSTRUCT_STRING_OBJECT |
691 | ||
70f42967 SB |
692 | @hook TARGET_OBJC_DECLARE_UNRESOLVED_CLASS_REFERENCE |
693 | ||
694 | @hook TARGET_OBJC_DECLARE_CLASS_DEFINITION | |
695 | ||
91ebb981 IS |
696 | @hook TARGET_STRING_OBJECT_REF_TYPE_P |
697 | ||
698 | @hook TARGET_CHECK_STRING_OBJECT_FORMAT_ARG | |
26705988 | 699 | |
38f8b050 | 700 | @hook TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE |
38f8b050 JR |
701 | |
702 | @defmac C_COMMON_OVERRIDE_OPTIONS | |
c5387660 JM |
703 | This is similar to the @code{TARGET_OPTION_OVERRIDE} hook |
704 | but is only used in the C | |
38f8b050 JR |
705 | language frontends (C, Objective-C, C++, Objective-C++) and so can be |
706 | used to alter option flag variables which only exist in those | |
707 | frontends. | |
708 | @end defmac | |
709 | ||
3020190e | 710 | @hook TARGET_OPTION_OPTIMIZATION_TABLE |
38f8b050 | 711 | Some machines may desire to change what optimizations are performed for |
3020190e JM |
712 | various optimization levels. This variable, if defined, describes |
713 | options to enable at particular sets of optimization levels. These | |
714 | options are processed once | |
38f8b050 | 715 | just after the optimization level is determined and before the remainder |
3020190e | 716 | of the command options have been parsed, so may be overridden by other |
2b0d3573 | 717 | options passed explicitly. |
38f8b050 | 718 | |
3020190e | 719 | This processing is run once at program startup and when the optimization |
38f8b050 JR |
720 | options are changed via @code{#pragma GCC optimize} or by using the |
721 | @code{optimize} attribute. | |
3020190e | 722 | @end deftypevr |
38f8b050 | 723 | |
7e4aae92 JM |
724 | @hook TARGET_OPTION_INIT_STRUCT |
725 | ||
128dc8e2 JM |
726 | @hook TARGET_OPTION_DEFAULT_PARAMS |
727 | ||
3bd36029 RS |
728 | @defmac SWITCHABLE_TARGET |
729 | Some targets need to switch between substantially different subtargets | |
730 | during compilation. For example, the MIPS target has one subtarget for | |
731 | the traditional MIPS architecture and another for MIPS16. Source code | |
732 | can switch between these two subarchitectures using the @code{mips16} | |
733 | and @code{nomips16} attributes. | |
734 | ||
735 | Such subtargets can differ in things like the set of available | |
736 | registers, the set of available instructions, the costs of various | |
737 | operations, and so on. GCC caches a lot of this type of information | |
738 | in global variables, and recomputing them for each subtarget takes a | |
739 | significant amount of time. The compiler therefore provides a facility | |
740 | for maintaining several versions of the global variables and quickly | |
741 | switching between them; see @file{target-globals.h} for details. | |
742 | ||
743 | Define this macro to 1 if your target needs this facility. The default | |
744 | is 0. | |
745 | @end defmac | |
746 | ||
9193fb05 JM |
747 | @hook TARGET_FLOAT_EXCEPTIONS_ROUNDING_SUPPORTED_P |
748 | ||
38f8b050 JR |
749 | @node Per-Function Data |
750 | @section Defining data structures for per-function information. | |
751 | @cindex per-function data | |
752 | @cindex data structures | |
753 | ||
754 | If the target needs to store information on a per-function basis, GCC | |
755 | provides a macro and a couple of variables to allow this. Note, just | |
756 | using statics to store the information is a bad idea, since GCC supports | |
757 | nested functions, so you can be halfway through encoding one function | |
758 | when another one comes along. | |
759 | ||
760 | GCC defines a data structure called @code{struct function} which | |
761 | contains all of the data specific to an individual function. This | |
762 | structure contains a field called @code{machine} whose type is | |
763 | @code{struct machine_function *}, which can be used by targets to point | |
764 | to their own specific data. | |
765 | ||
766 | If a target needs per-function specific data it should define the type | |
767 | @code{struct machine_function} and also the macro @code{INIT_EXPANDERS}. | |
768 | This macro should be used to initialize the function pointer | |
769 | @code{init_machine_status}. This pointer is explained below. | |
770 | ||
771 | One typical use of per-function, target specific data is to create an | |
772 | RTX to hold the register containing the function's return address. This | |
773 | RTX can then be used to implement the @code{__builtin_return_address} | |
774 | function, for level 0. | |
775 | ||
776 | Note---earlier implementations of GCC used a single data area to hold | |
777 | all of the per-function information. Thus when processing of a nested | |
778 | function began the old per-function data had to be pushed onto a | |
779 | stack, and when the processing was finished, it had to be popped off the | |
780 | stack. GCC used to provide function pointers called | |
781 | @code{save_machine_status} and @code{restore_machine_status} to handle | |
782 | the saving and restoring of the target specific information. Since the | |
783 | single data area approach is no longer used, these pointers are no | |
784 | longer supported. | |
785 | ||
786 | @defmac INIT_EXPANDERS | |
787 | Macro called to initialize any target specific information. This macro | |
788 | is called once per function, before generation of any RTL has begun. | |
789 | The intention of this macro is to allow the initialization of the | |
790 | function pointer @code{init_machine_status}. | |
791 | @end defmac | |
792 | ||
793 | @deftypevar {void (*)(struct function *)} init_machine_status | |
794 | If this function pointer is non-@code{NULL} it will be called once per | |
795 | function, before function compilation starts, in order to allow the | |
796 | target to perform any target specific initialization of the | |
797 | @code{struct function} structure. It is intended that this would be | |
798 | used to initialize the @code{machine} of that structure. | |
799 | ||
800 | @code{struct machine_function} structures are expected to be freed by GC@. | |
801 | Generally, any memory that they reference must be allocated by using | |
802 | GC allocation, including the structure itself. | |
803 | @end deftypevar | |
804 | ||
805 | @node Storage Layout | |
806 | @section Storage Layout | |
807 | @cindex storage layout | |
808 | ||
809 | Note that the definitions of the macros in this table which are sizes or | |
810 | alignments measured in bits do not need to be constant. They can be C | |
811 | expressions that refer to static variables, such as the @code{target_flags}. | |
812 | @xref{Run-time Target}. | |
813 | ||
814 | @defmac BITS_BIG_ENDIAN | |
815 | Define this macro to have the value 1 if the most significant bit in a | |
816 | byte has the lowest number; otherwise define it to have the value zero. | |
817 | This means that bit-field instructions count from the most significant | |
818 | bit. If the machine has no bit-field instructions, then this must still | |
819 | be defined, but it doesn't matter which value it is defined to. This | |
820 | macro need not be a constant. | |
821 | ||
822 | This macro does not affect the way structure fields are packed into | |
823 | bytes or words; that is controlled by @code{BYTES_BIG_ENDIAN}. | |
824 | @end defmac | |
825 | ||
826 | @defmac BYTES_BIG_ENDIAN | |
827 | Define this macro to have the value 1 if the most significant byte in a | |
828 | word has the lowest number. This macro need not be a constant. | |
829 | @end defmac | |
830 | ||
831 | @defmac WORDS_BIG_ENDIAN | |
832 | Define this macro to have the value 1 if, in a multiword object, the | |
833 | most significant word has the lowest number. This applies to both | |
c0a6a1ef BS |
834 | memory locations and registers; see @code{REG_WORDS_BIG_ENDIAN} if the |
835 | order of words in memory is not the same as the order in registers. This | |
38f8b050 JR |
836 | macro need not be a constant. |
837 | @end defmac | |
838 | ||
c0a6a1ef BS |
839 | @defmac REG_WORDS_BIG_ENDIAN |
840 | On some machines, the order of words in a multiword object differs between | |
841 | registers in memory. In such a situation, define this macro to describe | |
842 | the order of words in a register. The macro @code{WORDS_BIG_ENDIAN} controls | |
843 | the order of words in memory. | |
844 | @end defmac | |
845 | ||
38f8b050 JR |
846 | @defmac FLOAT_WORDS_BIG_ENDIAN |
847 | Define this macro to have the value 1 if @code{DFmode}, @code{XFmode} or | |
848 | @code{TFmode} floating point numbers are stored in memory with the word | |
849 | containing the sign bit at the lowest address; otherwise define it to | |
850 | have the value 0. This macro need not be a constant. | |
851 | ||
852 | You need not define this macro if the ordering is the same as for | |
853 | multi-word integers. | |
854 | @end defmac | |
855 | ||
38f8b050 JR |
856 | @defmac BITS_PER_WORD |
857 | Number of bits in a word. If you do not define this macro, the default | |
858 | is @code{BITS_PER_UNIT * UNITS_PER_WORD}. | |
859 | @end defmac | |
860 | ||
861 | @defmac MAX_BITS_PER_WORD | |
862 | Maximum number of bits in a word. If this is undefined, the default is | |
863 | @code{BITS_PER_WORD}. Otherwise, it is the constant value that is the | |
864 | largest value that @code{BITS_PER_WORD} can have at run-time. | |
865 | @end defmac | |
866 | ||
867 | @defmac UNITS_PER_WORD | |
868 | Number of storage units in a word; normally the size of a general-purpose | |
869 | register, a power of two from 1 or 8. | |
870 | @end defmac | |
871 | ||
872 | @defmac MIN_UNITS_PER_WORD | |
873 | Minimum number of units in a word. If this is undefined, the default is | |
874 | @code{UNITS_PER_WORD}. Otherwise, it is the constant value that is the | |
875 | smallest value that @code{UNITS_PER_WORD} can have at run-time. | |
876 | @end defmac | |
877 | ||
38f8b050 JR |
878 | @defmac POINTER_SIZE |
879 | Width of a pointer, in bits. You must specify a value no wider than the | |
880 | width of @code{Pmode}. If it is not equal to the width of @code{Pmode}, | |
881 | you must define @code{POINTERS_EXTEND_UNSIGNED}. If you do not specify | |
882 | a value the default is @code{BITS_PER_WORD}. | |
883 | @end defmac | |
884 | ||
885 | @defmac POINTERS_EXTEND_UNSIGNED | |
886 | A C expression that determines how pointers should be extended from | |
887 | @code{ptr_mode} to either @code{Pmode} or @code{word_mode}. It is | |
888 | greater than zero if pointers should be zero-extended, zero if they | |
889 | should be sign-extended, and negative if some other sort of conversion | |
890 | is needed. In the last case, the extension is done by the target's | |
891 | @code{ptr_extend} instruction. | |
892 | ||
893 | You need not define this macro if the @code{ptr_mode}, @code{Pmode} | |
894 | and @code{word_mode} are all the same width. | |
895 | @end defmac | |
896 | ||
897 | @defmac PROMOTE_MODE (@var{m}, @var{unsignedp}, @var{type}) | |
898 | A macro to update @var{m} and @var{unsignedp} when an object whose type | |
899 | is @var{type} and which has the specified mode and signedness is to be | |
900 | stored in a register. This macro is only called when @var{type} is a | |
901 | scalar type. | |
902 | ||
903 | On most RISC machines, which only have operations that operate on a full | |
904 | register, define this macro to set @var{m} to @code{word_mode} if | |
905 | @var{m} is an integer mode narrower than @code{BITS_PER_WORD}. In most | |
906 | cases, only integer modes should be widened because wider-precision | |
907 | floating-point operations are usually more expensive than their narrower | |
908 | counterparts. | |
909 | ||
910 | For most machines, the macro definition does not change @var{unsignedp}. | |
911 | However, some machines, have instructions that preferentially handle | |
912 | either signed or unsigned quantities of certain modes. For example, on | |
913 | the DEC Alpha, 32-bit loads from memory and 32-bit add instructions | |
914 | sign-extend the result to 64 bits. On such machines, set | |
915 | @var{unsignedp} according to which kind of extension is more efficient. | |
916 | ||
917 | Do not define this macro if it would never modify @var{m}. | |
918 | @end defmac | |
919 | ||
920 | @hook TARGET_PROMOTE_FUNCTION_MODE | |
38f8b050 JR |
921 | |
922 | @defmac PARM_BOUNDARY | |
923 | Normal alignment required for function parameters on the stack, in | |
924 | bits. All stack parameters receive at least this much alignment | |
925 | regardless of data type. On most machines, this is the same as the | |
926 | size of an integer. | |
927 | @end defmac | |
928 | ||
929 | @defmac STACK_BOUNDARY | |
930 | Define this macro to the minimum alignment enforced by hardware for the | |
931 | stack pointer on this machine. The definition is a C expression for the | |
932 | desired alignment (measured in bits). This value is used as a default | |
933 | if @code{PREFERRED_STACK_BOUNDARY} is not defined. On most machines, | |
934 | this should be the same as @code{PARM_BOUNDARY}. | |
935 | @end defmac | |
936 | ||
937 | @defmac PREFERRED_STACK_BOUNDARY | |
938 | Define this macro if you wish to preserve a certain alignment for the | |
939 | stack pointer, greater than what the hardware enforces. The definition | |
940 | is a C expression for the desired alignment (measured in bits). This | |
941 | macro must evaluate to a value equal to or larger than | |
942 | @code{STACK_BOUNDARY}. | |
943 | @end defmac | |
944 | ||
945 | @defmac INCOMING_STACK_BOUNDARY | |
946 | Define this macro if the incoming stack boundary may be different | |
947 | from @code{PREFERRED_STACK_BOUNDARY}. This macro must evaluate | |
948 | to a value equal to or larger than @code{STACK_BOUNDARY}. | |
949 | @end defmac | |
950 | ||
951 | @defmac FUNCTION_BOUNDARY | |
952 | Alignment required for a function entry point, in bits. | |
953 | @end defmac | |
954 | ||
955 | @defmac BIGGEST_ALIGNMENT | |
956 | Biggest alignment that any data type can require on this machine, in | |
957 | bits. Note that this is not the biggest alignment that is supported, | |
958 | just the biggest alignment that, when violated, may cause a fault. | |
959 | @end defmac | |
960 | ||
961 | @defmac MALLOC_ABI_ALIGNMENT | |
962 | Alignment, in bits, a C conformant malloc implementation has to | |
963 | provide. If not defined, the default value is @code{BITS_PER_WORD}. | |
964 | @end defmac | |
965 | ||
966 | @defmac ATTRIBUTE_ALIGNED_VALUE | |
967 | Alignment used by the @code{__attribute__ ((aligned))} construct. If | |
968 | not defined, the default value is @code{BIGGEST_ALIGNMENT}. | |
969 | @end defmac | |
970 | ||
971 | @defmac MINIMUM_ATOMIC_ALIGNMENT | |
972 | If defined, the smallest alignment, in bits, that can be given to an | |
973 | object that can be referenced in one operation, without disturbing any | |
974 | nearby object. Normally, this is @code{BITS_PER_UNIT}, but may be larger | |
975 | on machines that don't have byte or half-word store operations. | |
976 | @end defmac | |
977 | ||
978 | @defmac BIGGEST_FIELD_ALIGNMENT | |
979 | Biggest alignment that any structure or union field can require on this | |
980 | machine, in bits. If defined, this overrides @code{BIGGEST_ALIGNMENT} for | |
981 | structure and union fields only, unless the field alignment has been set | |
982 | by the @code{__attribute__ ((aligned (@var{n})))} construct. | |
983 | @end defmac | |
984 | ||
985 | @defmac ADJUST_FIELD_ALIGN (@var{field}, @var{computed}) | |
986 | An expression for the alignment of a structure field @var{field} if the | |
987 | alignment computed in the usual way (including applying of | |
988 | @code{BIGGEST_ALIGNMENT} and @code{BIGGEST_FIELD_ALIGNMENT} to the | |
989 | alignment) is @var{computed}. It overrides alignment only if the | |
990 | field alignment has not been set by the | |
991 | @code{__attribute__ ((aligned (@var{n})))} construct. | |
992 | @end defmac | |
993 | ||
994 | @defmac MAX_STACK_ALIGNMENT | |
995 | Biggest stack alignment guaranteed by the backend. Use this macro | |
996 | to specify the maximum alignment of a variable on stack. | |
997 | ||
998 | If not defined, the default value is @code{STACK_BOUNDARY}. | |
999 | ||
1000 | @c FIXME: The default should be @code{PREFERRED_STACK_BOUNDARY}. | |
1001 | @c But the fix for PR 32893 indicates that we can only guarantee | |
1002 | @c maximum stack alignment on stack up to @code{STACK_BOUNDARY}, not | |
1003 | @c @code{PREFERRED_STACK_BOUNDARY}, if stack alignment isn't supported. | |
1004 | @end defmac | |
1005 | ||
1006 | @defmac MAX_OFILE_ALIGNMENT | |
1007 | Biggest alignment supported by the object file format of this machine. | |
1008 | Use this macro to limit the alignment which can be specified using the | |
1009 | @code{__attribute__ ((aligned (@var{n})))} construct. If not defined, | |
1010 | the default value is @code{BIGGEST_ALIGNMENT}. | |
1011 | ||
1012 | On systems that use ELF, the default (in @file{config/elfos.h}) is | |
1013 | the largest supported 32-bit ELF section alignment representable on | |
1014 | a 32-bit host e.g. @samp{(((unsigned HOST_WIDEST_INT) 1 << 28) * 8)}. | |
1015 | On 32-bit ELF the largest supported section alignment in bits is | |
1016 | @samp{(0x80000000 * 8)}, but this is not representable on 32-bit hosts. | |
1017 | @end defmac | |
1018 | ||
1019 | @defmac DATA_ALIGNMENT (@var{type}, @var{basic-align}) | |
1020 | If defined, a C expression to compute the alignment for a variable in | |
1021 | the static store. @var{type} is the data type, and @var{basic-align} is | |
1022 | the alignment that the object would ordinarily have. The value of this | |
1023 | macro is used instead of that alignment to align the object. | |
1024 | ||
1025 | If this macro is not defined, then @var{basic-align} is used. | |
1026 | ||
1027 | @findex strcpy | |
1028 | One use of this macro is to increase alignment of medium-size data to | |
1029 | make it all fit in fewer cache lines. Another is to cause character | |
1030 | arrays to be word-aligned so that @code{strcpy} calls that copy | |
1031 | constants to character arrays can be done inline. | |
1032 | @end defmac | |
1033 | ||
df8a1d28 JJ |
1034 | @defmac DATA_ABI_ALIGNMENT (@var{type}, @var{basic-align}) |
1035 | Similar to @code{DATA_ALIGNMENT}, but for the cases where the ABI mandates | |
1036 | some alignment increase, instead of optimization only purposes. E.g.@ | |
1037 | AMD x86-64 psABI says that variables with array type larger than 15 bytes | |
1038 | must be aligned to 16 byte boundaries. | |
1039 | ||
1040 | If this macro is not defined, then @var{basic-align} is used. | |
1041 | @end defmac | |
1042 | ||
38f8b050 JR |
1043 | @defmac CONSTANT_ALIGNMENT (@var{constant}, @var{basic-align}) |
1044 | If defined, a C expression to compute the alignment given to a constant | |
1045 | that is being placed in memory. @var{constant} is the constant and | |
1046 | @var{basic-align} is the alignment that the object would ordinarily | |
1047 | have. The value of this macro is used instead of that alignment to | |
1048 | align the object. | |
1049 | ||
1050 | If this macro is not defined, then @var{basic-align} is used. | |
1051 | ||
1052 | The typical use of this macro is to increase alignment for string | |
1053 | constants to be word aligned so that @code{strcpy} calls that copy | |
1054 | constants can be done inline. | |
1055 | @end defmac | |
1056 | ||
1057 | @defmac LOCAL_ALIGNMENT (@var{type}, @var{basic-align}) | |
1058 | If defined, a C expression to compute the alignment for a variable in | |
1059 | the local store. @var{type} is the data type, and @var{basic-align} is | |
1060 | the alignment that the object would ordinarily have. The value of this | |
1061 | macro is used instead of that alignment to align the object. | |
1062 | ||
1063 | If this macro is not defined, then @var{basic-align} is used. | |
1064 | ||
1065 | One use of this macro is to increase alignment of medium-size data to | |
1066 | make it all fit in fewer cache lines. | |
4a6336ad | 1067 | |
64ad7c99 | 1068 | If the value of this macro has a type, it should be an unsigned type. |
38f8b050 JR |
1069 | @end defmac |
1070 | ||
5aea1e76 UW |
1071 | @hook TARGET_VECTOR_ALIGNMENT |
1072 | ||
38f8b050 JR |
1073 | @defmac STACK_SLOT_ALIGNMENT (@var{type}, @var{mode}, @var{basic-align}) |
1074 | If defined, a C expression to compute the alignment for stack slot. | |
1075 | @var{type} is the data type, @var{mode} is the widest mode available, | |
1076 | and @var{basic-align} is the alignment that the slot would ordinarily | |
1077 | have. The value of this macro is used instead of that alignment to | |
1078 | align the slot. | |
1079 | ||
1080 | If this macro is not defined, then @var{basic-align} is used when | |
1081 | @var{type} is @code{NULL}. Otherwise, @code{LOCAL_ALIGNMENT} will | |
1082 | be used. | |
1083 | ||
1084 | This macro is to set alignment of stack slot to the maximum alignment | |
1085 | of all possible modes which the slot may have. | |
4a6336ad | 1086 | |
64ad7c99 | 1087 | If the value of this macro has a type, it should be an unsigned type. |
38f8b050 JR |
1088 | @end defmac |
1089 | ||
1090 | @defmac LOCAL_DECL_ALIGNMENT (@var{decl}) | |
1091 | If defined, a C expression to compute the alignment for a local | |
1092 | variable @var{decl}. | |
1093 | ||
1094 | If this macro is not defined, then | |
1095 | @code{LOCAL_ALIGNMENT (TREE_TYPE (@var{decl}), DECL_ALIGN (@var{decl}))} | |
1096 | is used. | |
1097 | ||
1098 | One use of this macro is to increase alignment of medium-size data to | |
1099 | make it all fit in fewer cache lines. | |
4a6336ad | 1100 | |
64ad7c99 | 1101 | If the value of this macro has a type, it should be an unsigned type. |
38f8b050 JR |
1102 | @end defmac |
1103 | ||
1104 | @defmac MINIMUM_ALIGNMENT (@var{exp}, @var{mode}, @var{align}) | |
1105 | If defined, a C expression to compute the minimum required alignment | |
1106 | for dynamic stack realignment purposes for @var{exp} (a type or decl), | |
1107 | @var{mode}, assuming normal alignment @var{align}. | |
1108 | ||
1109 | If this macro is not defined, then @var{align} will be used. | |
1110 | @end defmac | |
1111 | ||
1112 | @defmac EMPTY_FIELD_BOUNDARY | |
1113 | Alignment in bits to be given to a structure bit-field that follows an | |
1114 | empty field such as @code{int : 0;}. | |
1115 | ||
1116 | If @code{PCC_BITFIELD_TYPE_MATTERS} is true, it overrides this macro. | |
1117 | @end defmac | |
1118 | ||
1119 | @defmac STRUCTURE_SIZE_BOUNDARY | |
1120 | Number of bits which any structure or union's size must be a multiple of. | |
1121 | Each structure or union's size is rounded up to a multiple of this. | |
1122 | ||
1123 | If you do not define this macro, the default is the same as | |
1124 | @code{BITS_PER_UNIT}. | |
1125 | @end defmac | |
1126 | ||
1127 | @defmac STRICT_ALIGNMENT | |
1128 | Define this macro to be the value 1 if instructions will fail to work | |
1129 | if given data not on the nominal alignment. If instructions will merely | |
1130 | go slower in that case, define this macro as 0. | |
1131 | @end defmac | |
1132 | ||
1133 | @defmac PCC_BITFIELD_TYPE_MATTERS | |
1134 | Define this if you wish to imitate the way many other C compilers handle | |
1135 | alignment of bit-fields and the structures that contain them. | |
1136 | ||
1137 | The behavior is that the type written for a named bit-field (@code{int}, | |
1138 | @code{short}, or other integer type) imposes an alignment for the entire | |
1139 | structure, as if the structure really did contain an ordinary field of | |
1140 | that type. In addition, the bit-field is placed within the structure so | |
1141 | that it would fit within such a field, not crossing a boundary for it. | |
1142 | ||
1143 | Thus, on most machines, a named bit-field whose type is written as | |
1144 | @code{int} would not cross a four-byte boundary, and would force | |
1145 | four-byte alignment for the whole structure. (The alignment used may | |
1146 | not be four bytes; it is controlled by the other alignment parameters.) | |
1147 | ||
1148 | An unnamed bit-field will not affect the alignment of the containing | |
1149 | structure. | |
1150 | ||
1151 | If the macro is defined, its definition should be a C expression; | |
1152 | a nonzero value for the expression enables this behavior. | |
1153 | ||
1154 | Note that if this macro is not defined, or its value is zero, some | |
1155 | bit-fields may cross more than one alignment boundary. The compiler can | |
1156 | support such references if there are @samp{insv}, @samp{extv}, and | |
1157 | @samp{extzv} insns that can directly reference memory. | |
1158 | ||
1159 | The other known way of making bit-fields work is to define | |
1160 | @code{STRUCTURE_SIZE_BOUNDARY} as large as @code{BIGGEST_ALIGNMENT}. | |
1161 | Then every structure can be accessed with fullwords. | |
1162 | ||
1163 | Unless the machine has bit-field instructions or you define | |
1164 | @code{STRUCTURE_SIZE_BOUNDARY} that way, you must define | |
1165 | @code{PCC_BITFIELD_TYPE_MATTERS} to have a nonzero value. | |
1166 | ||
1167 | If your aim is to make GCC use the same conventions for laying out | |
1168 | bit-fields as are used by another compiler, here is how to investigate | |
1169 | what the other compiler does. Compile and run this program: | |
1170 | ||
1171 | @smallexample | |
1172 | struct foo1 | |
1173 | @{ | |
1174 | char x; | |
1175 | char :0; | |
1176 | char y; | |
1177 | @}; | |
1178 | ||
1179 | struct foo2 | |
1180 | @{ | |
1181 | char x; | |
1182 | int :0; | |
1183 | char y; | |
1184 | @}; | |
1185 | ||
1186 | main () | |
1187 | @{ | |
1188 | printf ("Size of foo1 is %d\n", | |
1189 | sizeof (struct foo1)); | |
1190 | printf ("Size of foo2 is %d\n", | |
1191 | sizeof (struct foo2)); | |
1192 | exit (0); | |
1193 | @} | |
1194 | @end smallexample | |
1195 | ||
1196 | If this prints 2 and 5, then the compiler's behavior is what you would | |
1197 | get from @code{PCC_BITFIELD_TYPE_MATTERS}. | |
1198 | @end defmac | |
1199 | ||
1200 | @defmac BITFIELD_NBYTES_LIMITED | |
1201 | Like @code{PCC_BITFIELD_TYPE_MATTERS} except that its effect is limited | |
1202 | to aligning a bit-field within the structure. | |
1203 | @end defmac | |
1204 | ||
1205 | @hook TARGET_ALIGN_ANON_BITFIELD | |
38f8b050 JR |
1206 | |
1207 | @hook TARGET_NARROW_VOLATILE_BITFIELD | |
38f8b050 | 1208 | |
d9886a9e | 1209 | @hook TARGET_MEMBER_TYPE_FORCES_BLK |
38f8b050 JR |
1210 | |
1211 | @defmac ROUND_TYPE_ALIGN (@var{type}, @var{computed}, @var{specified}) | |
1212 | Define this macro as an expression for the alignment of a type (given | |
1213 | by @var{type} as a tree node) if the alignment computed in the usual | |
1214 | way is @var{computed} and the alignment explicitly specified was | |
1215 | @var{specified}. | |
1216 | ||
1217 | The default is to use @var{specified} if it is larger; otherwise, use | |
1218 | the smaller of @var{computed} and @code{BIGGEST_ALIGNMENT} | |
1219 | @end defmac | |
1220 | ||
1221 | @defmac MAX_FIXED_MODE_SIZE | |
1222 | An integer expression for the size in bits of the largest integer | |
1223 | machine mode that should actually be used. All integer machine modes of | |
1224 | this size or smaller can be used for structures and unions with the | |
1225 | appropriate sizes. If this macro is undefined, @code{GET_MODE_BITSIZE | |
1226 | (DImode)} is assumed. | |
1227 | @end defmac | |
1228 | ||
1229 | @defmac STACK_SAVEAREA_MODE (@var{save_level}) | |
1230 | If defined, an expression of type @code{enum machine_mode} that | |
1231 | specifies the mode of the save area operand of a | |
1232 | @code{save_stack_@var{level}} named pattern (@pxref{Standard Names}). | |
1233 | @var{save_level} is one of @code{SAVE_BLOCK}, @code{SAVE_FUNCTION}, or | |
1234 | @code{SAVE_NONLOCAL} and selects which of the three named patterns is | |
1235 | having its mode specified. | |
1236 | ||
1237 | You need not define this macro if it always returns @code{Pmode}. You | |
1238 | would most commonly define this macro if the | |
1239 | @code{save_stack_@var{level}} patterns need to support both a 32- and a | |
1240 | 64-bit mode. | |
1241 | @end defmac | |
1242 | ||
1243 | @defmac STACK_SIZE_MODE | |
1244 | If defined, an expression of type @code{enum machine_mode} that | |
1245 | specifies the mode of the size increment operand of an | |
1246 | @code{allocate_stack} named pattern (@pxref{Standard Names}). | |
1247 | ||
1248 | You need not define this macro if it always returns @code{word_mode}. | |
1249 | You would most commonly define this macro if the @code{allocate_stack} | |
1250 | pattern needs to support both a 32- and a 64-bit mode. | |
1251 | @end defmac | |
1252 | ||
1253 | @hook TARGET_LIBGCC_CMP_RETURN_MODE | |
38f8b050 JR |
1254 | |
1255 | @hook TARGET_LIBGCC_SHIFT_COUNT_MODE | |
38f8b050 JR |
1256 | |
1257 | @hook TARGET_UNWIND_WORD_MODE | |
38f8b050 JR |
1258 | |
1259 | @defmac ROUND_TOWARDS_ZERO | |
1260 | If defined, this macro should be true if the prevailing rounding | |
1261 | mode is towards zero. | |
1262 | ||
1263 | Defining this macro only affects the way @file{libgcc.a} emulates | |
1264 | floating-point arithmetic. | |
1265 | ||
1266 | Not defining this macro is equivalent to returning zero. | |
1267 | @end defmac | |
1268 | ||
1269 | @defmac LARGEST_EXPONENT_IS_NORMAL (@var{size}) | |
1270 | This macro should return true if floats with @var{size} | |
1271 | bits do not have a NaN or infinity representation, but use the largest | |
1272 | exponent for normal numbers instead. | |
1273 | ||
1274 | Defining this macro only affects the way @file{libgcc.a} emulates | |
1275 | floating-point arithmetic. | |
1276 | ||
1277 | The default definition of this macro returns false for all sizes. | |
1278 | @end defmac | |
1279 | ||
1280 | @hook TARGET_MS_BITFIELD_LAYOUT_P | |
38f8b050 JR |
1281 | |
1282 | @hook TARGET_DECIMAL_FLOAT_SUPPORTED_P | |
38f8b050 JR |
1283 | |
1284 | @hook TARGET_FIXED_POINT_SUPPORTED_P | |
38f8b050 JR |
1285 | |
1286 | @hook TARGET_EXPAND_TO_RTL_HOOK | |
38f8b050 JR |
1287 | |
1288 | @hook TARGET_INSTANTIATE_DECLS | |
38f8b050 JR |
1289 | |
1290 | @hook TARGET_MANGLE_TYPE | |
38f8b050 JR |
1291 | |
1292 | @node Type Layout | |
1293 | @section Layout of Source Language Data Types | |
1294 | ||
1295 | These macros define the sizes and other characteristics of the standard | |
1296 | basic data types used in programs being compiled. Unlike the macros in | |
1297 | the previous section, these apply to specific features of C and related | |
1298 | languages, rather than to fundamental aspects of storage layout. | |
1299 | ||
1300 | @defmac INT_TYPE_SIZE | |
1301 | A C expression for the size in bits of the type @code{int} on the | |
1302 | target machine. If you don't define this, the default is one word. | |
1303 | @end defmac | |
1304 | ||
1305 | @defmac SHORT_TYPE_SIZE | |
1306 | A C expression for the size in bits of the type @code{short} on the | |
1307 | target machine. If you don't define this, the default is half a word. | |
1308 | (If this would be less than one storage unit, it is rounded up to one | |
1309 | unit.) | |
1310 | @end defmac | |
1311 | ||
1312 | @defmac LONG_TYPE_SIZE | |
1313 | A C expression for the size in bits of the type @code{long} on the | |
1314 | target machine. If you don't define this, the default is one word. | |
1315 | @end defmac | |
1316 | ||
1317 | @defmac ADA_LONG_TYPE_SIZE | |
1318 | On some machines, the size used for the Ada equivalent of the type | |
1319 | @code{long} by a native Ada compiler differs from that used by C@. In | |
1320 | that situation, define this macro to be a C expression to be used for | |
1321 | the size of that type. If you don't define this, the default is the | |
1322 | value of @code{LONG_TYPE_SIZE}. | |
1323 | @end defmac | |
1324 | ||
1325 | @defmac LONG_LONG_TYPE_SIZE | |
1326 | A C expression for the size in bits of the type @code{long long} on the | |
1327 | target machine. If you don't define this, the default is two | |
1328 | words. If you want to support GNU Ada on your machine, the value of this | |
1329 | macro must be at least 64. | |
1330 | @end defmac | |
1331 | ||
1332 | @defmac CHAR_TYPE_SIZE | |
1333 | A C expression for the size in bits of the type @code{char} on the | |
1334 | target machine. If you don't define this, the default is | |
1335 | @code{BITS_PER_UNIT}. | |
1336 | @end defmac | |
1337 | ||
1338 | @defmac BOOL_TYPE_SIZE | |
1339 | A C expression for the size in bits of the C++ type @code{bool} and | |
1340 | C99 type @code{_Bool} on the target machine. If you don't define | |
1341 | this, and you probably shouldn't, the default is @code{CHAR_TYPE_SIZE}. | |
1342 | @end defmac | |
1343 | ||
1344 | @defmac FLOAT_TYPE_SIZE | |
1345 | A C expression for the size in bits of the type @code{float} on the | |
1346 | target machine. If you don't define this, the default is one word. | |
1347 | @end defmac | |
1348 | ||
1349 | @defmac DOUBLE_TYPE_SIZE | |
1350 | A C expression for the size in bits of the type @code{double} on the | |
1351 | target machine. If you don't define this, the default is two | |
1352 | words. | |
1353 | @end defmac | |
1354 | ||
1355 | @defmac LONG_DOUBLE_TYPE_SIZE | |
1356 | A C expression for the size in bits of the type @code{long double} on | |
1357 | the target machine. If you don't define this, the default is two | |
1358 | words. | |
1359 | @end defmac | |
1360 | ||
1361 | @defmac SHORT_FRACT_TYPE_SIZE | |
1362 | A C expression for the size in bits of the type @code{short _Fract} on | |
1363 | the target machine. If you don't define this, the default is | |
1364 | @code{BITS_PER_UNIT}. | |
1365 | @end defmac | |
1366 | ||
1367 | @defmac FRACT_TYPE_SIZE | |
1368 | A C expression for the size in bits of the type @code{_Fract} on | |
1369 | the target machine. If you don't define this, the default is | |
1370 | @code{BITS_PER_UNIT * 2}. | |
1371 | @end defmac | |
1372 | ||
1373 | @defmac LONG_FRACT_TYPE_SIZE | |
1374 | A C expression for the size in bits of the type @code{long _Fract} on | |
1375 | the target machine. If you don't define this, the default is | |
1376 | @code{BITS_PER_UNIT * 4}. | |
1377 | @end defmac | |
1378 | ||
1379 | @defmac LONG_LONG_FRACT_TYPE_SIZE | |
1380 | A C expression for the size in bits of the type @code{long long _Fract} on | |
1381 | the target machine. If you don't define this, the default is | |
1382 | @code{BITS_PER_UNIT * 8}. | |
1383 | @end defmac | |
1384 | ||
1385 | @defmac SHORT_ACCUM_TYPE_SIZE | |
1386 | A C expression for the size in bits of the type @code{short _Accum} on | |
1387 | the target machine. If you don't define this, the default is | |
1388 | @code{BITS_PER_UNIT * 2}. | |
1389 | @end defmac | |
1390 | ||
1391 | @defmac ACCUM_TYPE_SIZE | |
1392 | A C expression for the size in bits of the type @code{_Accum} on | |
1393 | the target machine. If you don't define this, the default is | |
1394 | @code{BITS_PER_UNIT * 4}. | |
1395 | @end defmac | |
1396 | ||
1397 | @defmac LONG_ACCUM_TYPE_SIZE | |
1398 | A C expression for the size in bits of the type @code{long _Accum} on | |
1399 | the target machine. If you don't define this, the default is | |
1400 | @code{BITS_PER_UNIT * 8}. | |
1401 | @end defmac | |
1402 | ||
1403 | @defmac LONG_LONG_ACCUM_TYPE_SIZE | |
1404 | A C expression for the size in bits of the type @code{long long _Accum} on | |
1405 | the target machine. If you don't define this, the default is | |
1406 | @code{BITS_PER_UNIT * 16}. | |
1407 | @end defmac | |
1408 | ||
1409 | @defmac LIBGCC2_LONG_DOUBLE_TYPE_SIZE | |
1410 | Define this macro if @code{LONG_DOUBLE_TYPE_SIZE} is not constant or | |
1411 | if you want routines in @file{libgcc2.a} for a size other than | |
1412 | @code{LONG_DOUBLE_TYPE_SIZE}. If you don't define this, the | |
1413 | default is @code{LONG_DOUBLE_TYPE_SIZE}. | |
1414 | @end defmac | |
1415 | ||
1416 | @defmac LIBGCC2_HAS_DF_MODE | |
a18bdccd | 1417 | Define this macro if neither @code{DOUBLE_TYPE_SIZE} nor |
38f8b050 JR |
1418 | @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is |
1419 | @code{DFmode} but you want @code{DFmode} routines in @file{libgcc2.a} | |
a18bdccd | 1420 | anyway. If you don't define this and either @code{DOUBLE_TYPE_SIZE} |
38f8b050 JR |
1421 | or @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is 64 then the default is 1, |
1422 | otherwise it is 0. | |
1423 | @end defmac | |
1424 | ||
1425 | @defmac LIBGCC2_HAS_XF_MODE | |
1426 | Define this macro if @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is not | |
1427 | @code{XFmode} but you want @code{XFmode} routines in @file{libgcc2.a} | |
1428 | anyway. If you don't define this and @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} | |
1429 | is 80 then the default is 1, otherwise it is 0. | |
1430 | @end defmac | |
1431 | ||
1432 | @defmac LIBGCC2_HAS_TF_MODE | |
1433 | Define this macro if @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is not | |
1434 | @code{TFmode} but you want @code{TFmode} routines in @file{libgcc2.a} | |
1435 | anyway. If you don't define this and @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} | |
1436 | is 128 then the default is 1, otherwise it is 0. | |
1437 | @end defmac | |
1438 | ||
cdbf4541 BS |
1439 | @defmac LIBGCC2_GNU_PREFIX |
1440 | This macro corresponds to the @code{TARGET_LIBFUNC_GNU_PREFIX} target | |
1441 | hook and should be defined if that hook is overriden to be true. It | |
1442 | causes function names in libgcc to be changed to use a @code{__gnu_} | |
1443 | prefix for their name rather than the default @code{__}. A port which | |
1444 | uses this macro should also arrange to use @file{t-gnu-prefix} in | |
1445 | the libgcc @file{config.host}. | |
1446 | @end defmac | |
1447 | ||
38f8b050 JR |
1448 | @defmac SF_SIZE |
1449 | @defmacx DF_SIZE | |
1450 | @defmacx XF_SIZE | |
1451 | @defmacx TF_SIZE | |
1452 | Define these macros to be the size in bits of the mantissa of | |
1453 | @code{SFmode}, @code{DFmode}, @code{XFmode} and @code{TFmode} values, | |
1454 | if the defaults in @file{libgcc2.h} are inappropriate. By default, | |
1455 | @code{FLT_MANT_DIG} is used for @code{SF_SIZE}, @code{LDBL_MANT_DIG} | |
1456 | for @code{XF_SIZE} and @code{TF_SIZE}, and @code{DBL_MANT_DIG} or | |
1457 | @code{LDBL_MANT_DIG} for @code{DF_SIZE} according to whether | |
a18bdccd | 1458 | @code{DOUBLE_TYPE_SIZE} or |
38f8b050 JR |
1459 | @code{LIBGCC2_LONG_DOUBLE_TYPE_SIZE} is 64. |
1460 | @end defmac | |
1461 | ||
1462 | @defmac TARGET_FLT_EVAL_METHOD | |
1463 | A C expression for the value for @code{FLT_EVAL_METHOD} in @file{float.h}, | |
1464 | assuming, if applicable, that the floating-point control word is in its | |
1465 | default state. If you do not define this macro the value of | |
1466 | @code{FLT_EVAL_METHOD} will be zero. | |
1467 | @end defmac | |
1468 | ||
1469 | @defmac WIDEST_HARDWARE_FP_SIZE | |
1470 | A C expression for the size in bits of the widest floating-point format | |
1471 | supported by the hardware. If you define this macro, you must specify a | |
1472 | value less than or equal to the value of @code{LONG_DOUBLE_TYPE_SIZE}. | |
1473 | If you do not define this macro, the value of @code{LONG_DOUBLE_TYPE_SIZE} | |
1474 | is the default. | |
1475 | @end defmac | |
1476 | ||
1477 | @defmac DEFAULT_SIGNED_CHAR | |
1478 | An expression whose value is 1 or 0, according to whether the type | |
1479 | @code{char} should be signed or unsigned by default. The user can | |
1480 | always override this default with the options @option{-fsigned-char} | |
1481 | and @option{-funsigned-char}. | |
1482 | @end defmac | |
1483 | ||
1484 | @hook TARGET_DEFAULT_SHORT_ENUMS | |
38f8b050 JR |
1485 | |
1486 | @defmac SIZE_TYPE | |
1487 | A C expression for a string describing the name of the data type to use | |
1488 | for size values. The typedef name @code{size_t} is defined using the | |
1489 | contents of the string. | |
1490 | ||
1491 | The string can contain more than one keyword. If so, separate them with | |
1492 | spaces, and write first any length keyword, then @code{unsigned} if | |
1493 | appropriate, and finally @code{int}. The string must exactly match one | |
1494 | of the data type names defined in the function | |
176a96de HPN |
1495 | @code{c_common_nodes_and_builtins} in the file @file{c-family/c-common.c}. |
1496 | You may not omit @code{int} or change the order---that would cause the | |
1497 | compiler to crash on startup. | |
38f8b050 JR |
1498 | |
1499 | If you don't define this macro, the default is @code{"long unsigned | |
1500 | int"}. | |
1501 | @end defmac | |
1502 | ||
18dae016 TG |
1503 | @defmac SIZETYPE |
1504 | GCC defines internal types (@code{sizetype}, @code{ssizetype}, | |
1505 | @code{bitsizetype} and @code{sbitsizetype}) for expressions | |
1506 | dealing with size. This macro is a C expression for a string describing | |
1507 | the name of the data type from which the precision of @code{sizetype} | |
1508 | is extracted. | |
1509 | ||
1510 | The string has the same restrictions as @code{SIZE_TYPE} string. | |
1511 | ||
1512 | If you don't define this macro, the default is @code{SIZE_TYPE}. | |
1513 | @end defmac | |
1514 | ||
38f8b050 JR |
1515 | @defmac PTRDIFF_TYPE |
1516 | A C expression for a string describing the name of the data type to use | |
1517 | for the result of subtracting two pointers. The typedef name | |
1518 | @code{ptrdiff_t} is defined using the contents of the string. See | |
1519 | @code{SIZE_TYPE} above for more information. | |
1520 | ||
1521 | If you don't define this macro, the default is @code{"long int"}. | |
1522 | @end defmac | |
1523 | ||
1524 | @defmac WCHAR_TYPE | |
1525 | A C expression for a string describing the name of the data type to use | |
1526 | for wide characters. The typedef name @code{wchar_t} is defined using | |
1527 | the contents of the string. See @code{SIZE_TYPE} above for more | |
1528 | information. | |
1529 | ||
1530 | If you don't define this macro, the default is @code{"int"}. | |
1531 | @end defmac | |
1532 | ||
1533 | @defmac WCHAR_TYPE_SIZE | |
1534 | A C expression for the size in bits of the data type for wide | |
1535 | characters. This is used in @code{cpp}, which cannot make use of | |
1536 | @code{WCHAR_TYPE}. | |
1537 | @end defmac | |
1538 | ||
1539 | @defmac WINT_TYPE | |
1540 | A C expression for a string describing the name of the data type to | |
1541 | use for wide characters passed to @code{printf} and returned from | |
1542 | @code{getwc}. The typedef name @code{wint_t} is defined using the | |
1543 | contents of the string. See @code{SIZE_TYPE} above for more | |
1544 | information. | |
1545 | ||
1546 | If you don't define this macro, the default is @code{"unsigned int"}. | |
1547 | @end defmac | |
1548 | ||
1549 | @defmac INTMAX_TYPE | |
1550 | A C expression for a string describing the name of the data type that | |
1551 | can represent any value of any standard or extended signed integer type. | |
1552 | The typedef name @code{intmax_t} is defined using the contents of the | |
1553 | string. See @code{SIZE_TYPE} above for more information. | |
1554 | ||
1555 | If you don't define this macro, the default is the first of | |
1556 | @code{"int"}, @code{"long int"}, or @code{"long long int"} that has as | |
1557 | much precision as @code{long long int}. | |
1558 | @end defmac | |
1559 | ||
1560 | @defmac UINTMAX_TYPE | |
1561 | A C expression for a string describing the name of the data type that | |
1562 | can represent any value of any standard or extended unsigned integer | |
1563 | type. The typedef name @code{uintmax_t} is defined using the contents | |
1564 | of the string. See @code{SIZE_TYPE} above for more information. | |
1565 | ||
1566 | If you don't define this macro, the default is the first of | |
1567 | @code{"unsigned int"}, @code{"long unsigned int"}, or @code{"long long | |
1568 | unsigned int"} that has as much precision as @code{long long unsigned | |
1569 | int}. | |
1570 | @end defmac | |
1571 | ||
1572 | @defmac SIG_ATOMIC_TYPE | |
1573 | @defmacx INT8_TYPE | |
1574 | @defmacx INT16_TYPE | |
1575 | @defmacx INT32_TYPE | |
1576 | @defmacx INT64_TYPE | |
1577 | @defmacx UINT8_TYPE | |
1578 | @defmacx UINT16_TYPE | |
1579 | @defmacx UINT32_TYPE | |
1580 | @defmacx UINT64_TYPE | |
1581 | @defmacx INT_LEAST8_TYPE | |
1582 | @defmacx INT_LEAST16_TYPE | |
1583 | @defmacx INT_LEAST32_TYPE | |
1584 | @defmacx INT_LEAST64_TYPE | |
1585 | @defmacx UINT_LEAST8_TYPE | |
1586 | @defmacx UINT_LEAST16_TYPE | |
1587 | @defmacx UINT_LEAST32_TYPE | |
1588 | @defmacx UINT_LEAST64_TYPE | |
1589 | @defmacx INT_FAST8_TYPE | |
1590 | @defmacx INT_FAST16_TYPE | |
1591 | @defmacx INT_FAST32_TYPE | |
1592 | @defmacx INT_FAST64_TYPE | |
1593 | @defmacx UINT_FAST8_TYPE | |
1594 | @defmacx UINT_FAST16_TYPE | |
1595 | @defmacx UINT_FAST32_TYPE | |
1596 | @defmacx UINT_FAST64_TYPE | |
1597 | @defmacx INTPTR_TYPE | |
1598 | @defmacx UINTPTR_TYPE | |
1599 | C expressions for the standard types @code{sig_atomic_t}, | |
1600 | @code{int8_t}, @code{int16_t}, @code{int32_t}, @code{int64_t}, | |
1601 | @code{uint8_t}, @code{uint16_t}, @code{uint32_t}, @code{uint64_t}, | |
1602 | @code{int_least8_t}, @code{int_least16_t}, @code{int_least32_t}, | |
1603 | @code{int_least64_t}, @code{uint_least8_t}, @code{uint_least16_t}, | |
1604 | @code{uint_least32_t}, @code{uint_least64_t}, @code{int_fast8_t}, | |
1605 | @code{int_fast16_t}, @code{int_fast32_t}, @code{int_fast64_t}, | |
1606 | @code{uint_fast8_t}, @code{uint_fast16_t}, @code{uint_fast32_t}, | |
1607 | @code{uint_fast64_t}, @code{intptr_t}, and @code{uintptr_t}. See | |
1608 | @code{SIZE_TYPE} above for more information. | |
1609 | ||
1610 | If any of these macros evaluates to a null pointer, the corresponding | |
1611 | type is not supported; if GCC is configured to provide | |
1612 | @code{<stdint.h>} in such a case, the header provided may not conform | |
1613 | to C99, depending on the type in question. The defaults for all of | |
1614 | these macros are null pointers. | |
1615 | @end defmac | |
1616 | ||
1617 | @defmac TARGET_PTRMEMFUNC_VBIT_LOCATION | |
1618 | The C++ compiler represents a pointer-to-member-function with a struct | |
1619 | that looks like: | |
1620 | ||
1621 | @smallexample | |
1622 | struct @{ | |
1623 | union @{ | |
1624 | void (*fn)(); | |
1625 | ptrdiff_t vtable_index; | |
1626 | @}; | |
1627 | ptrdiff_t delta; | |
1628 | @}; | |
1629 | @end smallexample | |
1630 | ||
1631 | @noindent | |
1632 | The C++ compiler must use one bit to indicate whether the function that | |
1633 | will be called through a pointer-to-member-function is virtual. | |
1634 | Normally, we assume that the low-order bit of a function pointer must | |
1635 | always be zero. Then, by ensuring that the vtable_index is odd, we can | |
1636 | distinguish which variant of the union is in use. But, on some | |
1637 | platforms function pointers can be odd, and so this doesn't work. In | |
1638 | that case, we use the low-order bit of the @code{delta} field, and shift | |
1639 | the remainder of the @code{delta} field to the left. | |
1640 | ||
1641 | GCC will automatically make the right selection about where to store | |
1642 | this bit using the @code{FUNCTION_BOUNDARY} setting for your platform. | |
1643 | However, some platforms such as ARM/Thumb have @code{FUNCTION_BOUNDARY} | |
1644 | set such that functions always start at even addresses, but the lowest | |
1645 | bit of pointers to functions indicate whether the function at that | |
1646 | address is in ARM or Thumb mode. If this is the case of your | |
1647 | architecture, you should define this macro to | |
1648 | @code{ptrmemfunc_vbit_in_delta}. | |
1649 | ||
1650 | In general, you should not have to define this macro. On architectures | |
1651 | in which function addresses are always even, according to | |
1652 | @code{FUNCTION_BOUNDARY}, GCC will automatically define this macro to | |
1653 | @code{ptrmemfunc_vbit_in_pfn}. | |
1654 | @end defmac | |
1655 | ||
1656 | @defmac TARGET_VTABLE_USES_DESCRIPTORS | |
1657 | Normally, the C++ compiler uses function pointers in vtables. This | |
1658 | macro allows the target to change to use ``function descriptors'' | |
1659 | instead. Function descriptors are found on targets for whom a | |
1660 | function pointer is actually a small data structure. Normally the | |
1661 | data structure consists of the actual code address plus a data | |
1662 | pointer to which the function's data is relative. | |
1663 | ||
1664 | If vtables are used, the value of this macro should be the number | |
1665 | of words that the function descriptor occupies. | |
1666 | @end defmac | |
1667 | ||
1668 | @defmac TARGET_VTABLE_ENTRY_ALIGN | |
1669 | By default, the vtable entries are void pointers, the so the alignment | |
1670 | is the same as pointer alignment. The value of this macro specifies | |
1671 | the alignment of the vtable entry in bits. It should be defined only | |
1672 | when special alignment is necessary. */ | |
1673 | @end defmac | |
1674 | ||
1675 | @defmac TARGET_VTABLE_DATA_ENTRY_DISTANCE | |
1676 | There are a few non-descriptor entries in the vtable at offsets below | |
1677 | zero. If these entries must be padded (say, to preserve the alignment | |
1678 | specified by @code{TARGET_VTABLE_ENTRY_ALIGN}), set this to the number | |
1679 | of words in each data entry. | |
1680 | @end defmac | |
1681 | ||
1682 | @node Registers | |
1683 | @section Register Usage | |
1684 | @cindex register usage | |
1685 | ||
1686 | This section explains how to describe what registers the target machine | |
1687 | has, and how (in general) they can be used. | |
1688 | ||
1689 | The description of which registers a specific instruction can use is | |
1690 | done with register classes; see @ref{Register Classes}. For information | |
1691 | on using registers to access a stack frame, see @ref{Frame Registers}. | |
1692 | For passing values in registers, see @ref{Register Arguments}. | |
1693 | For returning values in registers, see @ref{Scalar Return}. | |
1694 | ||
1695 | @menu | |
1696 | * Register Basics:: Number and kinds of registers. | |
1697 | * Allocation Order:: Order in which registers are allocated. | |
1698 | * Values in Registers:: What kinds of values each reg can hold. | |
1699 | * Leaf Functions:: Renumbering registers for leaf functions. | |
1700 | * Stack Registers:: Handling a register stack such as 80387. | |
1701 | @end menu | |
1702 | ||
1703 | @node Register Basics | |
1704 | @subsection Basic Characteristics of Registers | |
1705 | ||
1706 | @c prevent bad page break with this line | |
1707 | Registers have various characteristics. | |
1708 | ||
1709 | @defmac FIRST_PSEUDO_REGISTER | |
1710 | Number of hardware registers known to the compiler. They receive | |
1711 | numbers 0 through @code{FIRST_PSEUDO_REGISTER-1}; thus, the first | |
1712 | pseudo register's number really is assigned the number | |
1713 | @code{FIRST_PSEUDO_REGISTER}. | |
1714 | @end defmac | |
1715 | ||
1716 | @defmac FIXED_REGISTERS | |
1717 | @cindex fixed register | |
1718 | An initializer that says which registers are used for fixed purposes | |
1719 | all throughout the compiled code and are therefore not available for | |
1720 | general allocation. These would include the stack pointer, the frame | |
1721 | pointer (except on machines where that can be used as a general | |
1722 | register when no frame pointer is needed), the program counter on | |
1723 | machines where that is considered one of the addressable registers, | |
1724 | and any other numbered register with a standard use. | |
1725 | ||
1726 | This information is expressed as a sequence of numbers, separated by | |
1727 | commas and surrounded by braces. The @var{n}th number is 1 if | |
1728 | register @var{n} is fixed, 0 otherwise. | |
1729 | ||
1730 | The table initialized from this macro, and the table initialized by | |
1731 | the following one, may be overridden at run time either automatically, | |
1732 | by the actions of the macro @code{CONDITIONAL_REGISTER_USAGE}, or by | |
1733 | the user with the command options @option{-ffixed-@var{reg}}, | |
1734 | @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}. | |
1735 | @end defmac | |
1736 | ||
1737 | @defmac CALL_USED_REGISTERS | |
1738 | @cindex call-used register | |
1739 | @cindex call-clobbered register | |
1740 | @cindex call-saved register | |
1741 | Like @code{FIXED_REGISTERS} but has 1 for each register that is | |
1742 | clobbered (in general) by function calls as well as for fixed | |
1743 | registers. This macro therefore identifies the registers that are not | |
1744 | available for general allocation of values that must live across | |
1745 | function calls. | |
1746 | ||
1747 | If a register has 0 in @code{CALL_USED_REGISTERS}, the compiler | |
1748 | automatically saves it on function entry and restores it on function | |
1749 | exit, if the register is used within the function. | |
1750 | @end defmac | |
1751 | ||
1752 | @defmac CALL_REALLY_USED_REGISTERS | |
1753 | @cindex call-used register | |
1754 | @cindex call-clobbered register | |
1755 | @cindex call-saved register | |
1756 | Like @code{CALL_USED_REGISTERS} except this macro doesn't require | |
1757 | that the entire set of @code{FIXED_REGISTERS} be included. | |
1758 | (@code{CALL_USED_REGISTERS} must be a superset of @code{FIXED_REGISTERS}). | |
1759 | This macro is optional. If not specified, it defaults to the value | |
1760 | of @code{CALL_USED_REGISTERS}. | |
1761 | @end defmac | |
1762 | ||
1763 | @defmac HARD_REGNO_CALL_PART_CLOBBERED (@var{regno}, @var{mode}) | |
1764 | @cindex call-used register | |
1765 | @cindex call-clobbered register | |
1766 | @cindex call-saved register | |
1767 | A C expression that is nonzero if it is not permissible to store a | |
1768 | value of mode @var{mode} in hard register number @var{regno} across a | |
1769 | call without some part of it being clobbered. For most machines this | |
1770 | macro need not be defined. It is only required for machines that do not | |
1771 | preserve the entire contents of a register across a call. | |
1772 | @end defmac | |
1773 | ||
1774 | @findex fixed_regs | |
1775 | @findex call_used_regs | |
1776 | @findex global_regs | |
1777 | @findex reg_names | |
1778 | @findex reg_class_contents | |
5efd84c5 | 1779 | @hook TARGET_CONDITIONAL_REGISTER_USAGE |
38f8b050 JR |
1780 | |
1781 | @defmac INCOMING_REGNO (@var{out}) | |
1782 | Define this macro if the target machine has register windows. This C | |
1783 | expression returns the register number as seen by the called function | |
1784 | corresponding to the register number @var{out} as seen by the calling | |
1785 | function. Return @var{out} if register number @var{out} is not an | |
1786 | outbound register. | |
1787 | @end defmac | |
1788 | ||
1789 | @defmac OUTGOING_REGNO (@var{in}) | |
1790 | Define this macro if the target machine has register windows. This C | |
1791 | expression returns the register number as seen by the calling function | |
1792 | corresponding to the register number @var{in} as seen by the called | |
1793 | function. Return @var{in} if register number @var{in} is not an inbound | |
1794 | register. | |
1795 | @end defmac | |
1796 | ||
1797 | @defmac LOCAL_REGNO (@var{regno}) | |
1798 | Define this macro if the target machine has register windows. This C | |
1799 | expression returns true if the register is call-saved but is in the | |
1800 | register window. Unlike most call-saved registers, such registers | |
1801 | need not be explicitly restored on function exit or during non-local | |
1802 | gotos. | |
1803 | @end defmac | |
1804 | ||
1805 | @defmac PC_REGNUM | |
1806 | If the program counter has a register number, define this as that | |
1807 | register number. Otherwise, do not define it. | |
1808 | @end defmac | |
1809 | ||
1810 | @node Allocation Order | |
1811 | @subsection Order of Allocation of Registers | |
1812 | @cindex order of register allocation | |
1813 | @cindex register allocation order | |
1814 | ||
1815 | @c prevent bad page break with this line | |
1816 | Registers are allocated in order. | |
1817 | ||
1818 | @defmac REG_ALLOC_ORDER | |
1819 | If defined, an initializer for a vector of integers, containing the | |
1820 | numbers of hard registers in the order in which GCC should prefer | |
1821 | to use them (from most preferred to least). | |
1822 | ||
1823 | If this macro is not defined, registers are used lowest numbered first | |
1824 | (all else being equal). | |
1825 | ||
1826 | One use of this macro is on machines where the highest numbered | |
1827 | registers must always be saved and the save-multiple-registers | |
1828 | instruction supports only sequences of consecutive registers. On such | |
1829 | machines, define @code{REG_ALLOC_ORDER} to be an initializer that lists | |
1830 | the highest numbered allocable register first. | |
1831 | @end defmac | |
1832 | ||
1833 | @defmac ADJUST_REG_ALLOC_ORDER | |
1834 | A C statement (sans semicolon) to choose the order in which to allocate | |
1835 | hard registers for pseudo-registers local to a basic block. | |
1836 | ||
1837 | Store the desired register order in the array @code{reg_alloc_order}. | |
1838 | Element 0 should be the register to allocate first; element 1, the next | |
1839 | register; and so on. | |
1840 | ||
1841 | The macro body should not assume anything about the contents of | |
1842 | @code{reg_alloc_order} before execution of the macro. | |
1843 | ||
1844 | On most machines, it is not necessary to define this macro. | |
1845 | @end defmac | |
1846 | ||
1847 | @defmac HONOR_REG_ALLOC_ORDER | |
1848 | Normally, IRA tries to estimate the costs for saving a register in the | |
1849 | prologue and restoring it in the epilogue. This discourages it from | |
1850 | using call-saved registers. If a machine wants to ensure that IRA | |
1851 | allocates registers in the order given by REG_ALLOC_ORDER even if some | |
ed15c598 KC |
1852 | call-saved registers appear earlier than call-used ones, then define this |
1853 | macro as a C expression to nonzero. Default is 0. | |
38f8b050 JR |
1854 | @end defmac |
1855 | ||
1856 | @defmac IRA_HARD_REGNO_ADD_COST_MULTIPLIER (@var{regno}) | |
1857 | In some case register allocation order is not enough for the | |
1858 | Integrated Register Allocator (@acronym{IRA}) to generate a good code. | |
1859 | If this macro is defined, it should return a floating point value | |
1860 | based on @var{regno}. The cost of using @var{regno} for a pseudo will | |
1861 | be increased by approximately the pseudo's usage frequency times the | |
1862 | value returned by this macro. Not defining this macro is equivalent | |
1863 | to having it always return @code{0.0}. | |
1864 | ||
1865 | On most machines, it is not necessary to define this macro. | |
1866 | @end defmac | |
1867 | ||
1868 | @node Values in Registers | |
1869 | @subsection How Values Fit in Registers | |
1870 | ||
1871 | This section discusses the macros that describe which kinds of values | |
1872 | (specifically, which machine modes) each register can hold, and how many | |
1873 | consecutive registers are needed for a given mode. | |
1874 | ||
1875 | @defmac HARD_REGNO_NREGS (@var{regno}, @var{mode}) | |
1876 | A C expression for the number of consecutive hard registers, starting | |
1877 | at register number @var{regno}, required to hold a value of mode | |
1878 | @var{mode}. This macro must never return zero, even if a register | |
1879 | cannot hold the requested mode - indicate that with HARD_REGNO_MODE_OK | |
1880 | and/or CANNOT_CHANGE_MODE_CLASS instead. | |
1881 | ||
1882 | On a machine where all registers are exactly one word, a suitable | |
1883 | definition of this macro is | |
1884 | ||
1885 | @smallexample | |
1886 | #define HARD_REGNO_NREGS(REGNO, MODE) \ | |
1887 | ((GET_MODE_SIZE (MODE) + UNITS_PER_WORD - 1) \ | |
1888 | / UNITS_PER_WORD) | |
1889 | @end smallexample | |
1890 | @end defmac | |
1891 | ||
1892 | @defmac HARD_REGNO_NREGS_HAS_PADDING (@var{regno}, @var{mode}) | |
1893 | A C expression that is nonzero if a value of mode @var{mode}, stored | |
1894 | in memory, ends with padding that causes it to take up more space than | |
1895 | in registers starting at register number @var{regno} (as determined by | |
1896 | multiplying GCC's notion of the size of the register when containing | |
1897 | this mode by the number of registers returned by | |
1898 | @code{HARD_REGNO_NREGS}). By default this is zero. | |
1899 | ||
1900 | For example, if a floating-point value is stored in three 32-bit | |
1901 | registers but takes up 128 bits in memory, then this would be | |
1902 | nonzero. | |
1903 | ||
1904 | This macros only needs to be defined if there are cases where | |
1905 | @code{subreg_get_info} | |
1906 | would otherwise wrongly determine that a @code{subreg} can be | |
1907 | represented by an offset to the register number, when in fact such a | |
1908 | @code{subreg} would contain some of the padding not stored in | |
1909 | registers and so not be representable. | |
1910 | @end defmac | |
1911 | ||
1912 | @defmac HARD_REGNO_NREGS_WITH_PADDING (@var{regno}, @var{mode}) | |
1913 | For values of @var{regno} and @var{mode} for which | |
1914 | @code{HARD_REGNO_NREGS_HAS_PADDING} returns nonzero, a C expression | |
1915 | returning the greater number of registers required to hold the value | |
1916 | including any padding. In the example above, the value would be four. | |
1917 | @end defmac | |
1918 | ||
1919 | @defmac REGMODE_NATURAL_SIZE (@var{mode}) | |
1920 | Define this macro if the natural size of registers that hold values | |
1921 | of mode @var{mode} is not the word size. It is a C expression that | |
1922 | should give the natural size in bytes for the specified mode. It is | |
1923 | used by the register allocator to try to optimize its results. This | |
1924 | happens for example on SPARC 64-bit where the natural size of | |
1925 | floating-point registers is still 32-bit. | |
1926 | @end defmac | |
1927 | ||
1928 | @defmac HARD_REGNO_MODE_OK (@var{regno}, @var{mode}) | |
1929 | A C expression that is nonzero if it is permissible to store a value | |
1930 | of mode @var{mode} in hard register number @var{regno} (or in several | |
1931 | registers starting with that one). For a machine where all registers | |
1932 | are equivalent, a suitable definition is | |
1933 | ||
1934 | @smallexample | |
1935 | #define HARD_REGNO_MODE_OK(REGNO, MODE) 1 | |
1936 | @end smallexample | |
1937 | ||
1938 | You need not include code to check for the numbers of fixed registers, | |
1939 | because the allocation mechanism considers them to be always occupied. | |
1940 | ||
1941 | @cindex register pairs | |
1942 | On some machines, double-precision values must be kept in even/odd | |
1943 | register pairs. You can implement that by defining this macro to reject | |
1944 | odd register numbers for such modes. | |
1945 | ||
1946 | The minimum requirement for a mode to be OK in a register is that the | |
1947 | @samp{mov@var{mode}} instruction pattern support moves between the | |
1948 | register and other hard register in the same class and that moving a | |
1949 | value into the register and back out not alter it. | |
1950 | ||
1951 | Since the same instruction used to move @code{word_mode} will work for | |
1952 | all narrower integer modes, it is not necessary on any machine for | |
1953 | @code{HARD_REGNO_MODE_OK} to distinguish between these modes, provided | |
1954 | you define patterns @samp{movhi}, etc., to take advantage of this. This | |
1955 | is useful because of the interaction between @code{HARD_REGNO_MODE_OK} | |
1956 | and @code{MODES_TIEABLE_P}; it is very desirable for all integer modes | |
1957 | to be tieable. | |
1958 | ||
1959 | Many machines have special registers for floating point arithmetic. | |
1960 | Often people assume that floating point machine modes are allowed only | |
1961 | in floating point registers. This is not true. Any registers that | |
1962 | can hold integers can safely @emph{hold} a floating point machine | |
1963 | mode, whether or not floating arithmetic can be done on it in those | |
1964 | registers. Integer move instructions can be used to move the values. | |
1965 | ||
1966 | On some machines, though, the converse is true: fixed-point machine | |
1967 | modes may not go in floating registers. This is true if the floating | |
1968 | registers normalize any value stored in them, because storing a | |
1969 | non-floating value there would garble it. In this case, | |
1970 | @code{HARD_REGNO_MODE_OK} should reject fixed-point machine modes in | |
1971 | floating registers. But if the floating registers do not automatically | |
1972 | normalize, if you can store any bit pattern in one and retrieve it | |
1973 | unchanged without a trap, then any machine mode may go in a floating | |
1974 | register, so you can define this macro to say so. | |
1975 | ||
1976 | The primary significance of special floating registers is rather that | |
1977 | they are the registers acceptable in floating point arithmetic | |
1978 | instructions. However, this is of no concern to | |
1979 | @code{HARD_REGNO_MODE_OK}. You handle it by writing the proper | |
1980 | constraints for those instructions. | |
1981 | ||
1982 | On some machines, the floating registers are especially slow to access, | |
1983 | so that it is better to store a value in a stack frame than in such a | |
1984 | register if floating point arithmetic is not being done. As long as the | |
1985 | floating registers are not in class @code{GENERAL_REGS}, they will not | |
1986 | be used unless some pattern's constraint asks for one. | |
1987 | @end defmac | |
1988 | ||
1989 | @defmac HARD_REGNO_RENAME_OK (@var{from}, @var{to}) | |
1990 | A C expression that is nonzero if it is OK to rename a hard register | |
1991 | @var{from} to another hard register @var{to}. | |
1992 | ||
1993 | One common use of this macro is to prevent renaming of a register to | |
1994 | another register that is not saved by a prologue in an interrupt | |
1995 | handler. | |
1996 | ||
1997 | The default is always nonzero. | |
1998 | @end defmac | |
1999 | ||
2000 | @defmac MODES_TIEABLE_P (@var{mode1}, @var{mode2}) | |
2001 | A C expression that is nonzero if a value of mode | |
2002 | @var{mode1} is accessible in mode @var{mode2} without copying. | |
2003 | ||
2004 | If @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and | |
2005 | @code{HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always the same for | |
2006 | any @var{r}, then @code{MODES_TIEABLE_P (@var{mode1}, @var{mode2})} | |
2007 | should be nonzero. If they differ for any @var{r}, you should define | |
2008 | this macro to return zero unless some other mechanism ensures the | |
2009 | accessibility of the value in a narrower mode. | |
2010 | ||
2011 | You should define this macro to return nonzero in as many cases as | |
2012 | possible since doing so will allow GCC to perform better register | |
2013 | allocation. | |
2014 | @end defmac | |
2015 | ||
2016 | @hook TARGET_HARD_REGNO_SCRATCH_OK | |
38f8b050 JR |
2017 | |
2018 | @defmac AVOID_CCMODE_COPIES | |
2019 | Define this macro if the compiler should avoid copies to/from @code{CCmode} | |
2020 | registers. You should only define this macro if support for copying to/from | |
2021 | @code{CCmode} is incomplete. | |
2022 | @end defmac | |
2023 | ||
2024 | @node Leaf Functions | |
2025 | @subsection Handling Leaf Functions | |
2026 | ||
2027 | @cindex leaf functions | |
2028 | @cindex functions, leaf | |
2029 | On some machines, a leaf function (i.e., one which makes no calls) can run | |
2030 | more efficiently if it does not make its own register window. Often this | |
2031 | means it is required to receive its arguments in the registers where they | |
2032 | are passed by the caller, instead of the registers where they would | |
2033 | normally arrive. | |
2034 | ||
2035 | The special treatment for leaf functions generally applies only when | |
2036 | other conditions are met; for example, often they may use only those | |
2037 | registers for its own variables and temporaries. We use the term ``leaf | |
2038 | function'' to mean a function that is suitable for this special | |
2039 | handling, so that functions with no calls are not necessarily ``leaf | |
2040 | functions''. | |
2041 | ||
2042 | GCC assigns register numbers before it knows whether the function is | |
2043 | suitable for leaf function treatment. So it needs to renumber the | |
2044 | registers in order to output a leaf function. The following macros | |
2045 | accomplish this. | |
2046 | ||
2047 | @defmac LEAF_REGISTERS | |
2048 | Name of a char vector, indexed by hard register number, which | |
2049 | contains 1 for a register that is allowable in a candidate for leaf | |
2050 | function treatment. | |
2051 | ||
2052 | If leaf function treatment involves renumbering the registers, then the | |
2053 | registers marked here should be the ones before renumbering---those that | |
2054 | GCC would ordinarily allocate. The registers which will actually be | |
2055 | used in the assembler code, after renumbering, should not be marked with 1 | |
2056 | in this vector. | |
2057 | ||
2058 | Define this macro only if the target machine offers a way to optimize | |
2059 | the treatment of leaf functions. | |
2060 | @end defmac | |
2061 | ||
2062 | @defmac LEAF_REG_REMAP (@var{regno}) | |
2063 | A C expression whose value is the register number to which @var{regno} | |
2064 | should be renumbered, when a function is treated as a leaf function. | |
2065 | ||
2066 | If @var{regno} is a register number which should not appear in a leaf | |
2067 | function before renumbering, then the expression should yield @minus{}1, which | |
2068 | will cause the compiler to abort. | |
2069 | ||
2070 | Define this macro only if the target machine offers a way to optimize the | |
2071 | treatment of leaf functions, and registers need to be renumbered to do | |
2072 | this. | |
2073 | @end defmac | |
2074 | ||
2075 | @findex current_function_is_leaf | |
2076 | @findex current_function_uses_only_leaf_regs | |
2077 | @code{TARGET_ASM_FUNCTION_PROLOGUE} and | |
2078 | @code{TARGET_ASM_FUNCTION_EPILOGUE} must usually treat leaf functions | |
2079 | specially. They can test the C variable @code{current_function_is_leaf} | |
2080 | which is nonzero for leaf functions. @code{current_function_is_leaf} is | |
2081 | set prior to local register allocation and is valid for the remaining | |
2082 | compiler passes. They can also test the C variable | |
2083 | @code{current_function_uses_only_leaf_regs} which is nonzero for leaf | |
2084 | functions which only use leaf registers. | |
2085 | @code{current_function_uses_only_leaf_regs} is valid after all passes | |
2086 | that modify the instructions have been run and is only useful if | |
2087 | @code{LEAF_REGISTERS} is defined. | |
2088 | @c changed this to fix overfull. ALSO: why the "it" at the beginning | |
2089 | @c of the next paragraph?! --mew 2feb93 | |
2090 | ||
2091 | @node Stack Registers | |
2092 | @subsection Registers That Form a Stack | |
2093 | ||
2094 | There are special features to handle computers where some of the | |
2095 | ``registers'' form a stack. Stack registers are normally written by | |
2096 | pushing onto the stack, and are numbered relative to the top of the | |
2097 | stack. | |
2098 | ||
2099 | Currently, GCC can only handle one group of stack-like registers, and | |
2100 | they must be consecutively numbered. Furthermore, the existing | |
2101 | support for stack-like registers is specific to the 80387 floating | |
2102 | point coprocessor. If you have a new architecture that uses | |
2103 | stack-like registers, you will need to do substantial work on | |
2104 | @file{reg-stack.c} and write your machine description to cooperate | |
2105 | with it, as well as defining these macros. | |
2106 | ||
2107 | @defmac STACK_REGS | |
2108 | Define this if the machine has any stack-like registers. | |
2109 | @end defmac | |
2110 | ||
2111 | @defmac STACK_REG_COVER_CLASS | |
2112 | This is a cover class containing the stack registers. Define this if | |
2113 | the machine has any stack-like registers. | |
2114 | @end defmac | |
2115 | ||
2116 | @defmac FIRST_STACK_REG | |
2117 | The number of the first stack-like register. This one is the top | |
2118 | of the stack. | |
2119 | @end defmac | |
2120 | ||
2121 | @defmac LAST_STACK_REG | |
2122 | The number of the last stack-like register. This one is the bottom of | |
2123 | the stack. | |
2124 | @end defmac | |
2125 | ||
2126 | @node Register Classes | |
2127 | @section Register Classes | |
2128 | @cindex register class definitions | |
2129 | @cindex class definitions, register | |
2130 | ||
2131 | On many machines, the numbered registers are not all equivalent. | |
2132 | For example, certain registers may not be allowed for indexed addressing; | |
2133 | certain registers may not be allowed in some instructions. These machine | |
2134 | restrictions are described to the compiler using @dfn{register classes}. | |
2135 | ||
2136 | You define a number of register classes, giving each one a name and saying | |
2137 | which of the registers belong to it. Then you can specify register classes | |
2138 | that are allowed as operands to particular instruction patterns. | |
2139 | ||
2140 | @findex ALL_REGS | |
2141 | @findex NO_REGS | |
2142 | In general, each register will belong to several classes. In fact, one | |
2143 | class must be named @code{ALL_REGS} and contain all the registers. Another | |
2144 | class must be named @code{NO_REGS} and contain no registers. Often the | |
2145 | union of two classes will be another class; however, this is not required. | |
2146 | ||
2147 | @findex GENERAL_REGS | |
2148 | One of the classes must be named @code{GENERAL_REGS}. There is nothing | |
2149 | terribly special about the name, but the operand constraint letters | |
2150 | @samp{r} and @samp{g} specify this class. If @code{GENERAL_REGS} is | |
2151 | the same as @code{ALL_REGS}, just define it as a macro which expands | |
2152 | to @code{ALL_REGS}. | |
2153 | ||
2154 | Order the classes so that if class @var{x} is contained in class @var{y} | |
2155 | then @var{x} has a lower class number than @var{y}. | |
2156 | ||
2157 | The way classes other than @code{GENERAL_REGS} are specified in operand | |
2158 | constraints is through machine-dependent operand constraint letters. | |
2159 | You can define such letters to correspond to various classes, then use | |
2160 | them in operand constraints. | |
2161 | ||
6049a4c8 HPN |
2162 | You must define the narrowest register classes for allocatable |
2163 | registers, so that each class either has no subclasses, or that for | |
2164 | some mode, the move cost between registers within the class is | |
2165 | cheaper than moving a register in the class to or from memory | |
2166 | (@pxref{Costs}). | |
2167 | ||
38f8b050 JR |
2168 | You should define a class for the union of two classes whenever some |
2169 | instruction allows both classes. For example, if an instruction allows | |
2170 | either a floating point (coprocessor) register or a general register for a | |
2171 | certain operand, you should define a class @code{FLOAT_OR_GENERAL_REGS} | |
b899fd78 JR |
2172 | which includes both of them. Otherwise you will get suboptimal code, |
2173 | or even internal compiler errors when reload cannot find a register in the | |
dd5a833e | 2174 | class computed via @code{reg_class_subunion}. |
38f8b050 JR |
2175 | |
2176 | You must also specify certain redundant information about the register | |
2177 | classes: for each class, which classes contain it and which ones are | |
2178 | contained in it; for each pair of classes, the largest class contained | |
2179 | in their union. | |
2180 | ||
2181 | When a value occupying several consecutive registers is expected in a | |
2182 | certain class, all the registers used must belong to that class. | |
2183 | Therefore, register classes cannot be used to enforce a requirement for | |
2184 | a register pair to start with an even-numbered register. The way to | |
2185 | specify this requirement is with @code{HARD_REGNO_MODE_OK}. | |
2186 | ||
2187 | Register classes used for input-operands of bitwise-and or shift | |
2188 | instructions have a special requirement: each such class must have, for | |
2189 | each fixed-point machine mode, a subclass whose registers can transfer that | |
2190 | mode to or from memory. For example, on some machines, the operations for | |
2191 | single-byte values (@code{QImode}) are limited to certain registers. When | |
2192 | this is so, each register class that is used in a bitwise-and or shift | |
2193 | instruction must have a subclass consisting of registers from which | |
2194 | single-byte values can be loaded or stored. This is so that | |
2195 | @code{PREFERRED_RELOAD_CLASS} can always have a possible value to return. | |
2196 | ||
2197 | @deftp {Data type} {enum reg_class} | |
2198 | An enumerated type that must be defined with all the register class names | |
2199 | as enumerated values. @code{NO_REGS} must be first. @code{ALL_REGS} | |
2200 | must be the last register class, followed by one more enumerated value, | |
2201 | @code{LIM_REG_CLASSES}, which is not a register class but rather | |
2202 | tells how many classes there are. | |
2203 | ||
2204 | Each register class has a number, which is the value of casting | |
2205 | the class name to type @code{int}. The number serves as an index | |
2206 | in many of the tables described below. | |
2207 | @end deftp | |
2208 | ||
2209 | @defmac N_REG_CLASSES | |
2210 | The number of distinct register classes, defined as follows: | |
2211 | ||
2212 | @smallexample | |
2213 | #define N_REG_CLASSES (int) LIM_REG_CLASSES | |
2214 | @end smallexample | |
2215 | @end defmac | |
2216 | ||
2217 | @defmac REG_CLASS_NAMES | |
2218 | An initializer containing the names of the register classes as C string | |
2219 | constants. These names are used in writing some of the debugging dumps. | |
2220 | @end defmac | |
2221 | ||
2222 | @defmac REG_CLASS_CONTENTS | |
2223 | An initializer containing the contents of the register classes, as integers | |
2224 | which are bit masks. The @var{n}th integer specifies the contents of class | |
2225 | @var{n}. The way the integer @var{mask} is interpreted is that | |
2226 | register @var{r} is in the class if @code{@var{mask} & (1 << @var{r})} is 1. | |
2227 | ||
2228 | When the machine has more than 32 registers, an integer does not suffice. | |
2229 | Then the integers are replaced by sub-initializers, braced groupings containing | |
2230 | several integers. Each sub-initializer must be suitable as an initializer | |
2231 | for the type @code{HARD_REG_SET} which is defined in @file{hard-reg-set.h}. | |
2232 | In this situation, the first integer in each sub-initializer corresponds to | |
2233 | registers 0 through 31, the second integer to registers 32 through 63, and | |
2234 | so on. | |
2235 | @end defmac | |
2236 | ||
2237 | @defmac REGNO_REG_CLASS (@var{regno}) | |
2238 | A C expression whose value is a register class containing hard register | |
2239 | @var{regno}. In general there is more than one such class; choose a class | |
2240 | which is @dfn{minimal}, meaning that no smaller class also contains the | |
2241 | register. | |
2242 | @end defmac | |
2243 | ||
2244 | @defmac BASE_REG_CLASS | |
2245 | A macro whose definition is the name of the class to which a valid | |
2246 | base register must belong. A base register is one used in an address | |
2247 | which is the register value plus a displacement. | |
2248 | @end defmac | |
2249 | ||
2250 | @defmac MODE_BASE_REG_CLASS (@var{mode}) | |
2251 | This is a variation of the @code{BASE_REG_CLASS} macro which allows | |
2252 | the selection of a base register in a mode dependent manner. If | |
2253 | @var{mode} is VOIDmode then it should return the same value as | |
2254 | @code{BASE_REG_CLASS}. | |
2255 | @end defmac | |
2256 | ||
2257 | @defmac MODE_BASE_REG_REG_CLASS (@var{mode}) | |
2258 | A C expression whose value is the register class to which a valid | |
2259 | base register must belong in order to be used in a base plus index | |
2260 | register address. You should define this macro if base plus index | |
2261 | addresses have different requirements than other base register uses. | |
2262 | @end defmac | |
2263 | ||
86fc3d06 | 2264 | @defmac MODE_CODE_BASE_REG_CLASS (@var{mode}, @var{address_space}, @var{outer_code}, @var{index_code}) |
38f8b050 | 2265 | A C expression whose value is the register class to which a valid |
86fc3d06 UW |
2266 | base register for a memory reference in mode @var{mode} to address |
2267 | space @var{address_space} must belong. @var{outer_code} and @var{index_code} | |
2268 | define the context in which the base register occurs. @var{outer_code} is | |
2269 | the code of the immediately enclosing expression (@code{MEM} for the top level | |
2270 | of an address, @code{ADDRESS} for something that occurs in an | |
38f8b050 JR |
2271 | @code{address_operand}). @var{index_code} is the code of the corresponding |
2272 | index expression if @var{outer_code} is @code{PLUS}; @code{SCRATCH} otherwise. | |
2273 | @end defmac | |
2274 | ||
2275 | @defmac INDEX_REG_CLASS | |
2276 | A macro whose definition is the name of the class to which a valid | |
2277 | index register must belong. An index register is one used in an | |
2278 | address where its value is either multiplied by a scale factor or | |
2279 | added to another register (as well as added to a displacement). | |
2280 | @end defmac | |
2281 | ||
2282 | @defmac REGNO_OK_FOR_BASE_P (@var{num}) | |
2283 | A C expression which is nonzero if register number @var{num} is | |
2284 | suitable for use as a base register in operand addresses. | |
38f8b050 JR |
2285 | @end defmac |
2286 | ||
2287 | @defmac REGNO_MODE_OK_FOR_BASE_P (@var{num}, @var{mode}) | |
2288 | A C expression that is just like @code{REGNO_OK_FOR_BASE_P}, except that | |
2289 | that expression may examine the mode of the memory reference in | |
2290 | @var{mode}. You should define this macro if the mode of the memory | |
2291 | reference affects whether a register may be used as a base register. If | |
2292 | you define this macro, the compiler will use it instead of | |
2293 | @code{REGNO_OK_FOR_BASE_P}. The mode may be @code{VOIDmode} for | |
2294 | addresses that appear outside a @code{MEM}, i.e., as an | |
2295 | @code{address_operand}. | |
38f8b050 JR |
2296 | @end defmac |
2297 | ||
2298 | @defmac REGNO_MODE_OK_FOR_REG_BASE_P (@var{num}, @var{mode}) | |
2299 | A C expression which is nonzero if register number @var{num} is suitable for | |
2300 | use as a base register in base plus index operand addresses, accessing | |
2301 | memory in mode @var{mode}. It may be either a suitable hard register or a | |
2302 | pseudo register that has been allocated such a hard register. You should | |
2303 | define this macro if base plus index addresses have different requirements | |
2304 | than other base register uses. | |
2305 | ||
2306 | Use of this macro is deprecated; please use the more general | |
2307 | @code{REGNO_MODE_CODE_OK_FOR_BASE_P}. | |
38f8b050 JR |
2308 | @end defmac |
2309 | ||
86fc3d06 UW |
2310 | @defmac REGNO_MODE_CODE_OK_FOR_BASE_P (@var{num}, @var{mode}, @var{address_space}, @var{outer_code}, @var{index_code}) |
2311 | A C expression which is nonzero if register number @var{num} is | |
2312 | suitable for use as a base register in operand addresses, accessing | |
2313 | memory in mode @var{mode} in address space @var{address_space}. | |
2314 | This is similar to @code{REGNO_MODE_OK_FOR_BASE_P}, except | |
38f8b050 JR |
2315 | that that expression may examine the context in which the register |
2316 | appears in the memory reference. @var{outer_code} is the code of the | |
2317 | immediately enclosing expression (@code{MEM} if at the top level of the | |
2318 | address, @code{ADDRESS} for something that occurs in an | |
2319 | @code{address_operand}). @var{index_code} is the code of the | |
2320 | corresponding index expression if @var{outer_code} is @code{PLUS}; | |
2321 | @code{SCRATCH} otherwise. The mode may be @code{VOIDmode} for addresses | |
2322 | that appear outside a @code{MEM}, i.e., as an @code{address_operand}. | |
38f8b050 JR |
2323 | @end defmac |
2324 | ||
2325 | @defmac REGNO_OK_FOR_INDEX_P (@var{num}) | |
2326 | A C expression which is nonzero if register number @var{num} is | |
2327 | suitable for use as an index register in operand addresses. It may be | |
2328 | either a suitable hard register or a pseudo register that has been | |
2329 | allocated such a hard register. | |
2330 | ||
2331 | The difference between an index register and a base register is that | |
2332 | the index register may be scaled. If an address involves the sum of | |
2333 | two registers, neither one of them scaled, then either one may be | |
2334 | labeled the ``base'' and the other the ``index''; but whichever | |
2335 | labeling is used must fit the machine's constraints of which registers | |
2336 | may serve in each capacity. The compiler will try both labelings, | |
2337 | looking for one that is valid, and will reload one or both registers | |
2338 | only if neither labeling works. | |
38f8b050 JR |
2339 | @end defmac |
2340 | ||
5f286f4a YQ |
2341 | @hook TARGET_PREFERRED_RENAME_CLASS |
2342 | ||
fba42e24 | 2343 | @hook TARGET_PREFERRED_RELOAD_CLASS |
fba42e24 | 2344 | |
38f8b050 JR |
2345 | @defmac PREFERRED_RELOAD_CLASS (@var{x}, @var{class}) |
2346 | A C expression that places additional restrictions on the register class | |
2347 | to use when it is necessary to copy value @var{x} into a register in class | |
2348 | @var{class}. The value is a register class; perhaps @var{class}, or perhaps | |
2349 | another, smaller class. On many machines, the following definition is | |
2350 | safe: | |
2351 | ||
2352 | @smallexample | |
2353 | #define PREFERRED_RELOAD_CLASS(X,CLASS) CLASS | |
2354 | @end smallexample | |
2355 | ||
2356 | Sometimes returning a more restrictive class makes better code. For | |
2357 | example, on the 68000, when @var{x} is an integer constant that is in range | |
2358 | for a @samp{moveq} instruction, the value of this macro is always | |
2359 | @code{DATA_REGS} as long as @var{class} includes the data registers. | |
2360 | Requiring a data register guarantees that a @samp{moveq} will be used. | |
2361 | ||
2362 | One case where @code{PREFERRED_RELOAD_CLASS} must not return | |
2363 | @var{class} is if @var{x} is a legitimate constant which cannot be | |
2364 | loaded into some register class. By returning @code{NO_REGS} you can | |
2365 | force @var{x} into a memory location. For example, rs6000 can load | |
2366 | immediate values into general-purpose registers, but does not have an | |
2367 | instruction for loading an immediate value into a floating-point | |
2368 | register, so @code{PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when | |
2369 | @var{x} is a floating-point constant. If the constant can't be loaded | |
2370 | into any kind of register, code generation will be better if | |
1a627b35 RS |
2371 | @code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead |
2372 | of using @code{TARGET_PREFERRED_RELOAD_CLASS}. | |
38f8b050 JR |
2373 | |
2374 | If an insn has pseudos in it after register allocation, reload will go | |
2375 | through the alternatives and call repeatedly @code{PREFERRED_RELOAD_CLASS} | |
2376 | to find the best one. Returning @code{NO_REGS}, in this case, makes | |
2377 | reload add a @code{!} in front of the constraint: the x86 back-end uses | |
2378 | this feature to discourage usage of 387 registers when math is done in | |
2379 | the SSE registers (and vice versa). | |
2380 | @end defmac | |
2381 | ||
abd26bfb | 2382 | @hook TARGET_PREFERRED_OUTPUT_RELOAD_CLASS |
abd26bfb | 2383 | |
38f8b050 JR |
2384 | @defmac LIMIT_RELOAD_CLASS (@var{mode}, @var{class}) |
2385 | A C expression that places additional restrictions on the register class | |
2386 | to use when it is necessary to be able to hold a value of mode | |
2387 | @var{mode} in a reload register for which class @var{class} would | |
2388 | ordinarily be used. | |
2389 | ||
2390 | Unlike @code{PREFERRED_RELOAD_CLASS}, this macro should be used when | |
2391 | there are certain modes that simply can't go in certain reload classes. | |
2392 | ||
2393 | The value is a register class; perhaps @var{class}, or perhaps another, | |
2394 | smaller class. | |
2395 | ||
2396 | Don't define this macro unless the target machine has limitations which | |
2397 | require the macro to do something nontrivial. | |
2398 | @end defmac | |
2399 | ||
2400 | @hook TARGET_SECONDARY_RELOAD | |
38f8b050 JR |
2401 | |
2402 | @defmac SECONDARY_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
2403 | @defmacx SECONDARY_INPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
2404 | @defmacx SECONDARY_OUTPUT_RELOAD_CLASS (@var{class}, @var{mode}, @var{x}) | |
2405 | These macros are obsolete, new ports should use the target hook | |
2406 | @code{TARGET_SECONDARY_RELOAD} instead. | |
2407 | ||
2408 | These are obsolete macros, replaced by the @code{TARGET_SECONDARY_RELOAD} | |
2409 | target hook. Older ports still define these macros to indicate to the | |
2410 | reload phase that it may | |
2411 | need to allocate at least one register for a reload in addition to the | |
2412 | register to contain the data. Specifically, if copying @var{x} to a | |
2413 | register @var{class} in @var{mode} requires an intermediate register, | |
2414 | you were supposed to define @code{SECONDARY_INPUT_RELOAD_CLASS} to return the | |
2415 | largest register class all of whose registers can be used as | |
2416 | intermediate registers or scratch registers. | |
2417 | ||
2418 | If copying a register @var{class} in @var{mode} to @var{x} requires an | |
2419 | intermediate or scratch register, @code{SECONDARY_OUTPUT_RELOAD_CLASS} | |
2420 | was supposed to be defined be defined to return the largest register | |
2421 | class required. If the | |
2422 | requirements for input and output reloads were the same, the macro | |
2423 | @code{SECONDARY_RELOAD_CLASS} should have been used instead of defining both | |
2424 | macros identically. | |
2425 | ||
2426 | The values returned by these macros are often @code{GENERAL_REGS}. | |
2427 | Return @code{NO_REGS} if no spare register is needed; i.e., if @var{x} | |
2428 | can be directly copied to or from a register of @var{class} in | |
2429 | @var{mode} without requiring a scratch register. Do not define this | |
2430 | macro if it would always return @code{NO_REGS}. | |
2431 | ||
2432 | If a scratch register is required (either with or without an | |
2433 | intermediate register), you were supposed to define patterns for | |
2434 | @samp{reload_in@var{m}} or @samp{reload_out@var{m}}, as required | |
2435 | (@pxref{Standard Names}. These patterns, which were normally | |
2436 | implemented with a @code{define_expand}, should be similar to the | |
2437 | @samp{mov@var{m}} patterns, except that operand 2 is the scratch | |
2438 | register. | |
2439 | ||
2440 | These patterns need constraints for the reload register and scratch | |
2441 | register that | |
2442 | contain a single register class. If the original reload register (whose | |
2443 | class is @var{class}) can meet the constraint given in the pattern, the | |
2444 | value returned by these macros is used for the class of the scratch | |
2445 | register. Otherwise, two additional reload registers are required. | |
2446 | Their classes are obtained from the constraints in the insn pattern. | |
2447 | ||
2448 | @var{x} might be a pseudo-register or a @code{subreg} of a | |
2449 | pseudo-register, which could either be in a hard register or in memory. | |
2450 | Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is | |
2451 | in memory and the hard register number if it is in a register. | |
2452 | ||
2453 | These macros should not be used in the case where a particular class of | |
2454 | registers can only be copied to memory and not to another class of | |
2455 | registers. In that case, secondary reload registers are not needed and | |
2456 | would not be helpful. Instead, a stack location must be used to perform | |
2457 | the copy and the @code{mov@var{m}} pattern should use memory as an | |
2458 | intermediate storage. This case often occurs between floating-point and | |
2459 | general registers. | |
2460 | @end defmac | |
2461 | ||
2462 | @defmac SECONDARY_MEMORY_NEEDED (@var{class1}, @var{class2}, @var{m}) | |
2463 | Certain machines have the property that some registers cannot be copied | |
2464 | to some other registers without using memory. Define this macro on | |
2465 | those machines to be a C expression that is nonzero if objects of mode | |
2466 | @var{m} in registers of @var{class1} can only be copied to registers of | |
2467 | class @var{class2} by storing a register of @var{class1} into memory | |
2468 | and loading that memory location into a register of @var{class2}. | |
2469 | ||
2470 | Do not define this macro if its value would always be zero. | |
2471 | @end defmac | |
2472 | ||
2473 | @defmac SECONDARY_MEMORY_NEEDED_RTX (@var{mode}) | |
2474 | Normally when @code{SECONDARY_MEMORY_NEEDED} is defined, the compiler | |
2475 | allocates a stack slot for a memory location needed for register copies. | |
2476 | If this macro is defined, the compiler instead uses the memory location | |
2477 | defined by this macro. | |
2478 | ||
2479 | Do not define this macro if you do not define | |
2480 | @code{SECONDARY_MEMORY_NEEDED}. | |
2481 | @end defmac | |
2482 | ||
2483 | @defmac SECONDARY_MEMORY_NEEDED_MODE (@var{mode}) | |
2484 | When the compiler needs a secondary memory location to copy between two | |
2485 | registers of mode @var{mode}, it normally allocates sufficient memory to | |
2486 | hold a quantity of @code{BITS_PER_WORD} bits and performs the store and | |
2487 | load operations in a mode that many bits wide and whose class is the | |
2488 | same as that of @var{mode}. | |
2489 | ||
2490 | This is right thing to do on most machines because it ensures that all | |
2491 | bits of the register are copied and prevents accesses to the registers | |
2492 | in a narrower mode, which some machines prohibit for floating-point | |
2493 | registers. | |
2494 | ||
2495 | However, this default behavior is not correct on some machines, such as | |
2496 | the DEC Alpha, that store short integers in floating-point registers | |
2497 | differently than in integer registers. On those machines, the default | |
2498 | widening will not work correctly and you must define this macro to | |
2499 | suppress that widening in some cases. See the file @file{alpha.h} for | |
2500 | details. | |
2501 | ||
2502 | Do not define this macro if you do not define | |
2503 | @code{SECONDARY_MEMORY_NEEDED} or if widening @var{mode} to a mode that | |
2504 | is @code{BITS_PER_WORD} bits wide is correct for your machine. | |
2505 | @end defmac | |
2506 | ||
07b8f0a8 | 2507 | @hook TARGET_CLASS_LIKELY_SPILLED_P |
a8c44c52 AS |
2508 | |
2509 | @hook TARGET_CLASS_MAX_NREGS | |
07b8f0a8 | 2510 | |
38f8b050 JR |
2511 | @defmac CLASS_MAX_NREGS (@var{class}, @var{mode}) |
2512 | A C expression for the maximum number of consecutive registers | |
2513 | of class @var{class} needed to hold a value of mode @var{mode}. | |
2514 | ||
2515 | This is closely related to the macro @code{HARD_REGNO_NREGS}. In fact, | |
2516 | the value of the macro @code{CLASS_MAX_NREGS (@var{class}, @var{mode})} | |
2517 | should be the maximum value of @code{HARD_REGNO_NREGS (@var{regno}, | |
2518 | @var{mode})} for all @var{regno} values in the class @var{class}. | |
2519 | ||
2520 | This macro helps control the handling of multiple-word values | |
2521 | in the reload pass. | |
2522 | @end defmac | |
2523 | ||
2524 | @defmac CANNOT_CHANGE_MODE_CLASS (@var{from}, @var{to}, @var{class}) | |
2525 | If defined, a C expression that returns nonzero for a @var{class} for which | |
2526 | a change from mode @var{from} to mode @var{to} is invalid. | |
2527 | ||
2528 | For the example, loading 32-bit integer or floating-point objects into | |
2529 | floating-point registers on the Alpha extends them to 64 bits. | |
2530 | Therefore loading a 64-bit object and then storing it as a 32-bit object | |
2531 | does not store the low-order 32 bits, as would be the case for a normal | |
2532 | register. Therefore, @file{alpha.h} defines @code{CANNOT_CHANGE_MODE_CLASS} | |
2533 | as below: | |
2534 | ||
2535 | @smallexample | |
2536 | #define CANNOT_CHANGE_MODE_CLASS(FROM, TO, CLASS) \ | |
2537 | (GET_MODE_SIZE (FROM) != GET_MODE_SIZE (TO) \ | |
2538 | ? reg_classes_intersect_p (FLOAT_REGS, (CLASS)) : 0) | |
2539 | @end smallexample | |
2540 | @end defmac | |
2541 | ||
55a2c322 VM |
2542 | @hook TARGET_LRA_P |
2543 | ||
2544 | @hook TARGET_REGISTER_PRIORITY | |
2545 | ||
3b9ceb4b VM |
2546 | @hook TARGET_REGISTER_USAGE_LEVELING_P |
2547 | ||
55a2c322 VM |
2548 | @hook TARGET_DIFFERENT_ADDR_DISPLACEMENT_P |
2549 | ||
2550 | @hook TARGET_SPILL_CLASS | |
2551 | ||
42e37616 DM |
2552 | @hook TARGET_CSTORE_MODE |
2553 | ||
38f8b050 JR |
2554 | @node Old Constraints |
2555 | @section Obsolete Macros for Defining Constraints | |
2556 | @cindex defining constraints, obsolete method | |
2557 | @cindex constraints, defining, obsolete method | |
2558 | ||
2559 | Machine-specific constraints can be defined with these macros instead | |
2560 | of the machine description constructs described in @ref{Define | |
2561 | Constraints}. This mechanism is obsolete. New ports should not use | |
2562 | it; old ports should convert to the new mechanism. | |
2563 | ||
2564 | @defmac CONSTRAINT_LEN (@var{char}, @var{str}) | |
2565 | For the constraint at the start of @var{str}, which starts with the letter | |
2566 | @var{c}, return the length. This allows you to have register class / | |
2567 | constant / extra constraints that are longer than a single letter; | |
2568 | you don't need to define this macro if you can do with single-letter | |
2569 | constraints only. The definition of this macro should use | |
2570 | DEFAULT_CONSTRAINT_LEN for all the characters that you don't want | |
2571 | to handle specially. | |
2572 | There are some sanity checks in genoutput.c that check the constraint lengths | |
2573 | for the md file, so you can also use this macro to help you while you are | |
2574 | transitioning from a byzantine single-letter-constraint scheme: when you | |
2575 | return a negative length for a constraint you want to re-use, genoutput | |
2576 | will complain about every instance where it is used in the md file. | |
2577 | @end defmac | |
2578 | ||
2579 | @defmac REG_CLASS_FROM_LETTER (@var{char}) | |
2580 | A C expression which defines the machine-dependent operand constraint | |
2581 | letters for register classes. If @var{char} is such a letter, the | |
2582 | value should be the register class corresponding to it. Otherwise, | |
2583 | the value should be @code{NO_REGS}. The register letter @samp{r}, | |
2584 | corresponding to class @code{GENERAL_REGS}, will not be passed | |
2585 | to this macro; you do not need to handle it. | |
2586 | @end defmac | |
2587 | ||
2588 | @defmac REG_CLASS_FROM_CONSTRAINT (@var{char}, @var{str}) | |
2589 | Like @code{REG_CLASS_FROM_LETTER}, but you also get the constraint string | |
2590 | passed in @var{str}, so that you can use suffixes to distinguish between | |
2591 | different variants. | |
2592 | @end defmac | |
2593 | ||
2594 | @defmac CONST_OK_FOR_LETTER_P (@var{value}, @var{c}) | |
2595 | A C expression that defines the machine-dependent operand constraint | |
2596 | letters (@samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}) that specify | |
2597 | particular ranges of integer values. If @var{c} is one of those | |
2598 | letters, the expression should check that @var{value}, an integer, is in | |
2599 | the appropriate range and return 1 if so, 0 otherwise. If @var{c} is | |
2600 | not one of those letters, the value should be 0 regardless of | |
2601 | @var{value}. | |
2602 | @end defmac | |
2603 | ||
2604 | @defmac CONST_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str}) | |
2605 | Like @code{CONST_OK_FOR_LETTER_P}, but you also get the constraint | |
2606 | string passed in @var{str}, so that you can use suffixes to distinguish | |
2607 | between different variants. | |
2608 | @end defmac | |
2609 | ||
2610 | @defmac CONST_DOUBLE_OK_FOR_LETTER_P (@var{value}, @var{c}) | |
2611 | A C expression that defines the machine-dependent operand constraint | |
2612 | letters that specify particular ranges of @code{const_double} values | |
2613 | (@samp{G} or @samp{H}). | |
2614 | ||
2615 | If @var{c} is one of those letters, the expression should check that | |
2616 | @var{value}, an RTX of code @code{const_double}, is in the appropriate | |
2617 | range and return 1 if so, 0 otherwise. If @var{c} is not one of those | |
2618 | letters, the value should be 0 regardless of @var{value}. | |
2619 | ||
2620 | @code{const_double} is used for all floating-point constants and for | |
2621 | @code{DImode} fixed-point constants. A given letter can accept either | |
2622 | or both kinds of values. It can use @code{GET_MODE} to distinguish | |
2623 | between these kinds. | |
2624 | @end defmac | |
2625 | ||
2626 | @defmac CONST_DOUBLE_OK_FOR_CONSTRAINT_P (@var{value}, @var{c}, @var{str}) | |
2627 | Like @code{CONST_DOUBLE_OK_FOR_LETTER_P}, but you also get the constraint | |
2628 | string passed in @var{str}, so that you can use suffixes to distinguish | |
2629 | between different variants. | |
2630 | @end defmac | |
2631 | ||
2632 | @defmac EXTRA_CONSTRAINT (@var{value}, @var{c}) | |
2633 | A C expression that defines the optional machine-dependent constraint | |
2634 | letters that can be used to segregate specific types of operands, usually | |
2635 | memory references, for the target machine. Any letter that is not | |
2636 | elsewhere defined and not matched by @code{REG_CLASS_FROM_LETTER} / | |
2637 | @code{REG_CLASS_FROM_CONSTRAINT} | |
2638 | may be used. Normally this macro will not be defined. | |
2639 | ||
2640 | If it is required for a particular target machine, it should return 1 | |
2641 | if @var{value} corresponds to the operand type represented by the | |
2642 | constraint letter @var{c}. If @var{c} is not defined as an extra | |
2643 | constraint, the value returned should be 0 regardless of @var{value}. | |
2644 | ||
2645 | For example, on the ROMP, load instructions cannot have their output | |
2646 | in r0 if the memory reference contains a symbolic address. Constraint | |
2647 | letter @samp{Q} is defined as representing a memory address that does | |
2648 | @emph{not} contain a symbolic address. An alternative is specified with | |
2649 | a @samp{Q} constraint on the input and @samp{r} on the output. The next | |
2650 | alternative specifies @samp{m} on the input and a register class that | |
2651 | does not include r0 on the output. | |
2652 | @end defmac | |
2653 | ||
2654 | @defmac EXTRA_CONSTRAINT_STR (@var{value}, @var{c}, @var{str}) | |
2655 | Like @code{EXTRA_CONSTRAINT}, but you also get the constraint string passed | |
2656 | in @var{str}, so that you can use suffixes to distinguish between different | |
2657 | variants. | |
2658 | @end defmac | |
2659 | ||
2660 | @defmac EXTRA_MEMORY_CONSTRAINT (@var{c}, @var{str}) | |
2661 | A C expression that defines the optional machine-dependent constraint | |
2662 | letters, amongst those accepted by @code{EXTRA_CONSTRAINT}, that should | |
2663 | be treated like memory constraints by the reload pass. | |
2664 | ||
2665 | It should return 1 if the operand type represented by the constraint | |
2666 | at the start of @var{str}, the first letter of which is the letter @var{c}, | |
2667 | comprises a subset of all memory references including | |
2668 | all those whose address is simply a base register. This allows the reload | |
2669 | pass to reload an operand, if it does not directly correspond to the operand | |
2670 | type of @var{c}, by copying its address into a base register. | |
2671 | ||
2672 | For example, on the S/390, some instructions do not accept arbitrary | |
2673 | memory references, but only those that do not make use of an index | |
2674 | register. The constraint letter @samp{Q} is defined via | |
2675 | @code{EXTRA_CONSTRAINT} as representing a memory address of this type. | |
2676 | If the letter @samp{Q} is marked as @code{EXTRA_MEMORY_CONSTRAINT}, | |
2677 | a @samp{Q} constraint can handle any memory operand, because the | |
2678 | reload pass knows it can be reloaded by copying the memory address | |
2679 | into a base register if required. This is analogous to the way | |
2680 | an @samp{o} constraint can handle any memory operand. | |
2681 | @end defmac | |
2682 | ||
2683 | @defmac EXTRA_ADDRESS_CONSTRAINT (@var{c}, @var{str}) | |
2684 | A C expression that defines the optional machine-dependent constraint | |
2685 | letters, amongst those accepted by @code{EXTRA_CONSTRAINT} / | |
2686 | @code{EXTRA_CONSTRAINT_STR}, that should | |
2687 | be treated like address constraints by the reload pass. | |
2688 | ||
2689 | It should return 1 if the operand type represented by the constraint | |
2690 | at the start of @var{str}, which starts with the letter @var{c}, comprises | |
2691 | a subset of all memory addresses including | |
2692 | all those that consist of just a base register. This allows the reload | |
2693 | pass to reload an operand, if it does not directly correspond to the operand | |
2694 | type of @var{str}, by copying it into a base register. | |
2695 | ||
2696 | Any constraint marked as @code{EXTRA_ADDRESS_CONSTRAINT} can only | |
2697 | be used with the @code{address_operand} predicate. It is treated | |
2698 | analogously to the @samp{p} constraint. | |
2699 | @end defmac | |
2700 | ||
2701 | @node Stack and Calling | |
2702 | @section Stack Layout and Calling Conventions | |
2703 | @cindex calling conventions | |
2704 | ||
2705 | @c prevent bad page break with this line | |
2706 | This describes the stack layout and calling conventions. | |
2707 | ||
2708 | @menu | |
2709 | * Frame Layout:: | |
2710 | * Exception Handling:: | |
2711 | * Stack Checking:: | |
2712 | * Frame Registers:: | |
2713 | * Elimination:: | |
2714 | * Stack Arguments:: | |
2715 | * Register Arguments:: | |
2716 | * Scalar Return:: | |
2717 | * Aggregate Return:: | |
2718 | * Caller Saves:: | |
2719 | * Function Entry:: | |
2720 | * Profiling:: | |
2721 | * Tail Calls:: | |
2722 | * Stack Smashing Protection:: | |
aaeaa9a9 | 2723 | * Miscellaneous Register Hooks:: |
38f8b050 JR |
2724 | @end menu |
2725 | ||
2726 | @node Frame Layout | |
2727 | @subsection Basic Stack Layout | |
2728 | @cindex stack frame layout | |
2729 | @cindex frame layout | |
2730 | ||
2731 | @c prevent bad page break with this line | |
2732 | Here is the basic stack layout. | |
2733 | ||
2734 | @defmac STACK_GROWS_DOWNWARD | |
2735 | Define this macro if pushing a word onto the stack moves the stack | |
2736 | pointer to a smaller address. | |
2737 | ||
2738 | When we say, ``define this macro if @dots{}'', it means that the | |
2739 | compiler checks this macro only with @code{#ifdef} so the precise | |
2740 | definition used does not matter. | |
2741 | @end defmac | |
2742 | ||
2743 | @defmac STACK_PUSH_CODE | |
2744 | This macro defines the operation used when something is pushed | |
2745 | on the stack. In RTL, a push operation will be | |
2746 | @code{(set (mem (STACK_PUSH_CODE (reg sp))) @dots{})} | |
2747 | ||
2748 | The choices are @code{PRE_DEC}, @code{POST_DEC}, @code{PRE_INC}, | |
2749 | and @code{POST_INC}. Which of these is correct depends on | |
2750 | the stack direction and on whether the stack pointer points | |
2751 | to the last item on the stack or whether it points to the | |
2752 | space for the next item on the stack. | |
2753 | ||
2754 | The default is @code{PRE_DEC} when @code{STACK_GROWS_DOWNWARD} is | |
2755 | defined, which is almost always right, and @code{PRE_INC} otherwise, | |
2756 | which is often wrong. | |
2757 | @end defmac | |
2758 | ||
2759 | @defmac FRAME_GROWS_DOWNWARD | |
2760 | Define this macro to nonzero value if the addresses of local variable slots | |
2761 | are at negative offsets from the frame pointer. | |
2762 | @end defmac | |
2763 | ||
2764 | @defmac ARGS_GROW_DOWNWARD | |
2765 | Define this macro if successive arguments to a function occupy decreasing | |
2766 | addresses on the stack. | |
2767 | @end defmac | |
2768 | ||
2769 | @defmac STARTING_FRAME_OFFSET | |
2770 | Offset from the frame pointer to the first local variable slot to be allocated. | |
2771 | ||
2772 | If @code{FRAME_GROWS_DOWNWARD}, find the next slot's offset by | |
2773 | subtracting the first slot's length from @code{STARTING_FRAME_OFFSET}. | |
2774 | Otherwise, it is found by adding the length of the first slot to the | |
2775 | value @code{STARTING_FRAME_OFFSET}. | |
2776 | @c i'm not sure if the above is still correct.. had to change it to get | |
2777 | @c rid of an overfull. --mew 2feb93 | |
2778 | @end defmac | |
2779 | ||
2780 | @defmac STACK_ALIGNMENT_NEEDED | |
2781 | Define to zero to disable final alignment of the stack during reload. | |
2782 | The nonzero default for this macro is suitable for most ports. | |
2783 | ||
2784 | On ports where @code{STARTING_FRAME_OFFSET} is nonzero or where there | |
2785 | is a register save block following the local block that doesn't require | |
2786 | alignment to @code{STACK_BOUNDARY}, it may be beneficial to disable | |
2787 | stack alignment and do it in the backend. | |
2788 | @end defmac | |
2789 | ||
2790 | @defmac STACK_POINTER_OFFSET | |
2791 | Offset from the stack pointer register to the first location at which | |
2792 | outgoing arguments are placed. If not specified, the default value of | |
2793 | zero is used. This is the proper value for most machines. | |
2794 | ||
2795 | If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above | |
2796 | the first location at which outgoing arguments are placed. | |
2797 | @end defmac | |
2798 | ||
2799 | @defmac FIRST_PARM_OFFSET (@var{fundecl}) | |
2800 | Offset from the argument pointer register to the first argument's | |
2801 | address. On some machines it may depend on the data type of the | |
2802 | function. | |
2803 | ||
2804 | If @code{ARGS_GROW_DOWNWARD}, this is the offset to the location above | |
2805 | the first argument's address. | |
2806 | @end defmac | |
2807 | ||
2808 | @defmac STACK_DYNAMIC_OFFSET (@var{fundecl}) | |
2809 | Offset from the stack pointer register to an item dynamically allocated | |
2810 | on the stack, e.g., by @code{alloca}. | |
2811 | ||
2812 | The default value for this macro is @code{STACK_POINTER_OFFSET} plus the | |
2813 | length of the outgoing arguments. The default is correct for most | |
2814 | machines. See @file{function.c} for details. | |
2815 | @end defmac | |
2816 | ||
2817 | @defmac INITIAL_FRAME_ADDRESS_RTX | |
2818 | A C expression whose value is RTL representing the address of the initial | |
2819 | stack frame. This address is passed to @code{RETURN_ADDR_RTX} and | |
2820 | @code{DYNAMIC_CHAIN_ADDRESS}. If you don't define this macro, a reasonable | |
2821 | default value will be used. Define this macro in order to make frame pointer | |
2822 | elimination work in the presence of @code{__builtin_frame_address (count)} and | |
2823 | @code{__builtin_return_address (count)} for @code{count} not equal to zero. | |
2824 | @end defmac | |
2825 | ||
2826 | @defmac DYNAMIC_CHAIN_ADDRESS (@var{frameaddr}) | |
2827 | A C expression whose value is RTL representing the address in a stack | |
2828 | frame where the pointer to the caller's frame is stored. Assume that | |
2829 | @var{frameaddr} is an RTL expression for the address of the stack frame | |
2830 | itself. | |
2831 | ||
2832 | If you don't define this macro, the default is to return the value | |
2833 | of @var{frameaddr}---that is, the stack frame address is also the | |
2834 | address of the stack word that points to the previous frame. | |
2835 | @end defmac | |
2836 | ||
2837 | @defmac SETUP_FRAME_ADDRESSES | |
2838 | If defined, a C expression that produces the machine-specific code to | |
2839 | setup the stack so that arbitrary frames can be accessed. For example, | |
2840 | on the SPARC, we must flush all of the register windows to the stack | |
2841 | before we can access arbitrary stack frames. You will seldom need to | |
2842 | define this macro. | |
2843 | @end defmac | |
2844 | ||
2845 | @hook TARGET_BUILTIN_SETJMP_FRAME_VALUE | |
38f8b050 JR |
2846 | |
2847 | @defmac FRAME_ADDR_RTX (@var{frameaddr}) | |
2848 | A C expression whose value is RTL representing the value of the frame | |
2849 | address for the current frame. @var{frameaddr} is the frame pointer | |
2850 | of the current frame. This is used for __builtin_frame_address. | |
2851 | You need only define this macro if the frame address is not the same | |
2852 | as the frame pointer. Most machines do not need to define it. | |
2853 | @end defmac | |
2854 | ||
2855 | @defmac RETURN_ADDR_RTX (@var{count}, @var{frameaddr}) | |
2856 | A C expression whose value is RTL representing the value of the return | |
2857 | address for the frame @var{count} steps up from the current frame, after | |
2858 | the prologue. @var{frameaddr} is the frame pointer of the @var{count} | |
2859 | frame, or the frame pointer of the @var{count} @minus{} 1 frame if | |
2860 | @code{RETURN_ADDR_IN_PREVIOUS_FRAME} is defined. | |
2861 | ||
2862 | The value of the expression must always be the correct address when | |
2863 | @var{count} is zero, but may be @code{NULL_RTX} if there is no way to | |
2864 | determine the return address of other frames. | |
2865 | @end defmac | |
2866 | ||
2867 | @defmac RETURN_ADDR_IN_PREVIOUS_FRAME | |
2868 | Define this if the return address of a particular stack frame is accessed | |
2869 | from the frame pointer of the previous stack frame. | |
2870 | @end defmac | |
2871 | ||
2872 | @defmac INCOMING_RETURN_ADDR_RTX | |
2873 | A C expression whose value is RTL representing the location of the | |
2874 | incoming return address at the beginning of any function, before the | |
2875 | prologue. This RTL is either a @code{REG}, indicating that the return | |
2876 | value is saved in @samp{REG}, or a @code{MEM} representing a location in | |
2877 | the stack. | |
2878 | ||
2879 | You only need to define this macro if you want to support call frame | |
2880 | debugging information like that provided by DWARF 2. | |
2881 | ||
2882 | If this RTL is a @code{REG}, you should also define | |
2883 | @code{DWARF_FRAME_RETURN_COLUMN} to @code{DWARF_FRAME_REGNUM (REGNO)}. | |
2884 | @end defmac | |
2885 | ||
2886 | @defmac DWARF_ALT_FRAME_RETURN_COLUMN | |
2887 | A C expression whose value is an integer giving a DWARF 2 column | |
2888 | number that may be used as an alternative return column. The column | |
2889 | must not correspond to any gcc hard register (that is, it must not | |
2890 | be in the range of @code{DWARF_FRAME_REGNUM}). | |
2891 | ||
2892 | This macro can be useful if @code{DWARF_FRAME_RETURN_COLUMN} is set to a | |
2893 | general register, but an alternative column needs to be used for signal | |
2894 | frames. Some targets have also used different frame return columns | |
2895 | over time. | |
2896 | @end defmac | |
2897 | ||
2898 | @defmac DWARF_ZERO_REG | |
2899 | A C expression whose value is an integer giving a DWARF 2 register | |
2900 | number that is considered to always have the value zero. This should | |
2901 | only be defined if the target has an architected zero register, and | |
2902 | someone decided it was a good idea to use that register number to | |
2903 | terminate the stack backtrace. New ports should avoid this. | |
2904 | @end defmac | |
2905 | ||
2906 | @hook TARGET_DWARF_HANDLE_FRAME_UNSPEC | |
38f8b050 JR |
2907 | |
2908 | @defmac INCOMING_FRAME_SP_OFFSET | |
2909 | A C expression whose value is an integer giving the offset, in bytes, | |
2910 | from the value of the stack pointer register to the top of the stack | |
2911 | frame at the beginning of any function, before the prologue. The top of | |
2912 | the frame is defined to be the value of the stack pointer in the | |
2913 | previous frame, just before the call instruction. | |
2914 | ||
2915 | You only need to define this macro if you want to support call frame | |
2916 | debugging information like that provided by DWARF 2. | |
2917 | @end defmac | |
2918 | ||
2919 | @defmac ARG_POINTER_CFA_OFFSET (@var{fundecl}) | |
2920 | A C expression whose value is an integer giving the offset, in bytes, | |
2921 | from the argument pointer to the canonical frame address (cfa). The | |
2922 | final value should coincide with that calculated by | |
2923 | @code{INCOMING_FRAME_SP_OFFSET}. Which is unfortunately not usable | |
2924 | during virtual register instantiation. | |
2925 | ||
2926 | The default value for this macro is | |
2927 | @code{FIRST_PARM_OFFSET (fundecl) + crtl->args.pretend_args_size}, | |
2928 | which is correct for most machines; in general, the arguments are found | |
2929 | immediately before the stack frame. Note that this is not the case on | |
2930 | some targets that save registers into the caller's frame, such as SPARC | |
2931 | and rs6000, and so such targets need to define this macro. | |
2932 | ||
2933 | You only need to define this macro if the default is incorrect, and you | |
2934 | want to support call frame debugging information like that provided by | |
2935 | DWARF 2. | |
2936 | @end defmac | |
2937 | ||
2938 | @defmac FRAME_POINTER_CFA_OFFSET (@var{fundecl}) | |
2939 | If defined, a C expression whose value is an integer giving the offset | |
2940 | in bytes from the frame pointer to the canonical frame address (cfa). | |
2941 | The final value should coincide with that calculated by | |
2942 | @code{INCOMING_FRAME_SP_OFFSET}. | |
2943 | ||
2944 | Normally the CFA is calculated as an offset from the argument pointer, | |
2945 | via @code{ARG_POINTER_CFA_OFFSET}, but if the argument pointer is | |
2946 | variable due to the ABI, this may not be possible. If this macro is | |
2947 | defined, it implies that the virtual register instantiation should be | |
2948 | based on the frame pointer instead of the argument pointer. Only one | |
2949 | of @code{FRAME_POINTER_CFA_OFFSET} and @code{ARG_POINTER_CFA_OFFSET} | |
2950 | should be defined. | |
2951 | @end defmac | |
2952 | ||
2953 | @defmac CFA_FRAME_BASE_OFFSET (@var{fundecl}) | |
2954 | If defined, a C expression whose value is an integer giving the offset | |
2955 | in bytes from the canonical frame address (cfa) to the frame base used | |
2956 | in DWARF 2 debug information. The default is zero. A different value | |
2957 | may reduce the size of debug information on some ports. | |
2958 | @end defmac | |
2959 | ||
2960 | @node Exception Handling | |
2961 | @subsection Exception Handling Support | |
2962 | @cindex exception handling | |
2963 | ||
2964 | @defmac EH_RETURN_DATA_REGNO (@var{N}) | |
2965 | A C expression whose value is the @var{N}th register number used for | |
2966 | data by exception handlers, or @code{INVALID_REGNUM} if fewer than | |
2967 | @var{N} registers are usable. | |
2968 | ||
2969 | The exception handling library routines communicate with the exception | |
2970 | handlers via a set of agreed upon registers. Ideally these registers | |
2971 | should be call-clobbered; it is possible to use call-saved registers, | |
2972 | but may negatively impact code size. The target must support at least | |
2973 | 2 data registers, but should define 4 if there are enough free registers. | |
2974 | ||
2975 | You must define this macro if you want to support call frame exception | |
2976 | handling like that provided by DWARF 2. | |
2977 | @end defmac | |
2978 | ||
2979 | @defmac EH_RETURN_STACKADJ_RTX | |
2980 | A C expression whose value is RTL representing a location in which | |
2981 | to store a stack adjustment to be applied before function return. | |
2982 | This is used to unwind the stack to an exception handler's call frame. | |
2983 | It will be assigned zero on code paths that return normally. | |
2984 | ||
2985 | Typically this is a call-clobbered hard register that is otherwise | |
2986 | untouched by the epilogue, but could also be a stack slot. | |
2987 | ||
2988 | Do not define this macro if the stack pointer is saved and restored | |
2989 | by the regular prolog and epilog code in the call frame itself; in | |
2990 | this case, the exception handling library routines will update the | |
2991 | stack location to be restored in place. Otherwise, you must define | |
2992 | this macro if you want to support call frame exception handling like | |
2993 | that provided by DWARF 2. | |
2994 | @end defmac | |
2995 | ||
2996 | @defmac EH_RETURN_HANDLER_RTX | |
2997 | A C expression whose value is RTL representing a location in which | |
2998 | to store the address of an exception handler to which we should | |
2999 | return. It will not be assigned on code paths that return normally. | |
3000 | ||
3001 | Typically this is the location in the call frame at which the normal | |
3002 | return address is stored. For targets that return by popping an | |
3003 | address off the stack, this might be a memory address just below | |
3004 | the @emph{target} call frame rather than inside the current call | |
3005 | frame. If defined, @code{EH_RETURN_STACKADJ_RTX} will have already | |
3006 | been assigned, so it may be used to calculate the location of the | |
3007 | target call frame. | |
3008 | ||
3009 | Some targets have more complex requirements than storing to an | |
3010 | address calculable during initial code generation. In that case | |
3011 | the @code{eh_return} instruction pattern should be used instead. | |
3012 | ||
3013 | If you want to support call frame exception handling, you must | |
3014 | define either this macro or the @code{eh_return} instruction pattern. | |
3015 | @end defmac | |
3016 | ||
3017 | @defmac RETURN_ADDR_OFFSET | |
3018 | If defined, an integer-valued C expression for which rtl will be generated | |
3019 | to add it to the exception handler address before it is searched in the | |
3020 | exception handling tables, and to subtract it again from the address before | |
3021 | using it to return to the exception handler. | |
3022 | @end defmac | |
3023 | ||
3024 | @defmac ASM_PREFERRED_EH_DATA_FORMAT (@var{code}, @var{global}) | |
3025 | This macro chooses the encoding of pointers embedded in the exception | |
3026 | handling sections. If at all possible, this should be defined such | |
3027 | that the exception handling section will not require dynamic relocations, | |
3028 | and so may be read-only. | |
3029 | ||
3030 | @var{code} is 0 for data, 1 for code labels, 2 for function pointers. | |
3031 | @var{global} is true if the symbol may be affected by dynamic relocations. | |
3032 | The macro should return a combination of the @code{DW_EH_PE_*} defines | |
3033 | as found in @file{dwarf2.h}. | |
3034 | ||
3035 | If this macro is not defined, pointers will not be encoded but | |
3036 | represented directly. | |
3037 | @end defmac | |
3038 | ||
3039 | @defmac ASM_MAYBE_OUTPUT_ENCODED_ADDR_RTX (@var{file}, @var{encoding}, @var{size}, @var{addr}, @var{done}) | |
3040 | This macro allows the target to emit whatever special magic is required | |
3041 | to represent the encoding chosen by @code{ASM_PREFERRED_EH_DATA_FORMAT}. | |
3042 | Generic code takes care of pc-relative and indirect encodings; this must | |
3043 | be defined if the target uses text-relative or data-relative encodings. | |
3044 | ||
3045 | This is a C statement that branches to @var{done} if the format was | |
3046 | handled. @var{encoding} is the format chosen, @var{size} is the number | |
3047 | of bytes that the format occupies, @var{addr} is the @code{SYMBOL_REF} | |
3048 | to be emitted. | |
3049 | @end defmac | |
3050 | ||
38f8b050 JR |
3051 | @defmac MD_FALLBACK_FRAME_STATE_FOR (@var{context}, @var{fs}) |
3052 | This macro allows the target to add CPU and operating system specific | |
3053 | code to the call-frame unwinder for use when there is no unwind data | |
3054 | available. The most common reason to implement this macro is to unwind | |
3055 | through signal frames. | |
3056 | ||
3057 | This macro is called from @code{uw_frame_state_for} in | |
3058 | @file{unwind-dw2.c}, @file{unwind-dw2-xtensa.c} and | |
3059 | @file{unwind-ia64.c}. @var{context} is an @code{_Unwind_Context}; | |
3060 | @var{fs} is an @code{_Unwind_FrameState}. Examine @code{context->ra} | |
3061 | for the address of the code being executed and @code{context->cfa} for | |
3062 | the stack pointer value. If the frame can be decoded, the register | |
3063 | save addresses should be updated in @var{fs} and the macro should | |
3064 | evaluate to @code{_URC_NO_REASON}. If the frame cannot be decoded, | |
3065 | the macro should evaluate to @code{_URC_END_OF_STACK}. | |
3066 | ||
3067 | For proper signal handling in Java this macro is accompanied by | |
3068 | @code{MAKE_THROW_FRAME}, defined in @file{libjava/include/*-signal.h} headers. | |
3069 | @end defmac | |
3070 | ||
3071 | @defmac MD_HANDLE_UNWABI (@var{context}, @var{fs}) | |
3072 | This macro allows the target to add operating system specific code to the | |
3073 | call-frame unwinder to handle the IA-64 @code{.unwabi} unwinding directive, | |
3074 | usually used for signal or interrupt frames. | |
3075 | ||
0c93ed52 SB |
3076 | This macro is called from @code{uw_update_context} in libgcc's |
3077 | @file{unwind-ia64.c}. @var{context} is an @code{_Unwind_Context}; | |
38f8b050 JR |
3078 | @var{fs} is an @code{_Unwind_FrameState}. Examine @code{fs->unwabi} |
3079 | for the abi and context in the @code{.unwabi} directive. If the | |
3080 | @code{.unwabi} directive can be handled, the register save addresses should | |
3081 | be updated in @var{fs}. | |
3082 | @end defmac | |
3083 | ||
3084 | @defmac TARGET_USES_WEAK_UNWIND_INFO | |
3085 | A C expression that evaluates to true if the target requires unwind | |
3086 | info to be given comdat linkage. Define it to be @code{1} if comdat | |
3087 | linkage is necessary. The default is @code{0}. | |
3088 | @end defmac | |
3089 | ||
3090 | @node Stack Checking | |
3091 | @subsection Specifying How Stack Checking is Done | |
3092 | ||
3093 | GCC will check that stack references are within the boundaries of the | |
3094 | stack, if the option @option{-fstack-check} is specified, in one of | |
3095 | three ways: | |
3096 | ||
3097 | @enumerate | |
3098 | @item | |
3099 | If the value of the @code{STACK_CHECK_BUILTIN} macro is nonzero, GCC | |
3100 | will assume that you have arranged for full stack checking to be done | |
3101 | at appropriate places in the configuration files. GCC will not do | |
3102 | other special processing. | |
3103 | ||
3104 | @item | |
3105 | If @code{STACK_CHECK_BUILTIN} is zero and the value of the | |
3106 | @code{STACK_CHECK_STATIC_BUILTIN} macro is nonzero, GCC will assume | |
3107 | that you have arranged for static stack checking (checking of the | |
3108 | static stack frame of functions) to be done at appropriate places | |
3109 | in the configuration files. GCC will only emit code to do dynamic | |
3110 | stack checking (checking on dynamic stack allocations) using the third | |
3111 | approach below. | |
3112 | ||
3113 | @item | |
3114 | If neither of the above are true, GCC will generate code to periodically | |
3115 | ``probe'' the stack pointer using the values of the macros defined below. | |
3116 | @end enumerate | |
3117 | ||
3118 | If neither STACK_CHECK_BUILTIN nor STACK_CHECK_STATIC_BUILTIN is defined, | |
3119 | GCC will change its allocation strategy for large objects if the option | |
3120 | @option{-fstack-check} is specified: they will always be allocated | |
3121 | dynamically if their size exceeds @code{STACK_CHECK_MAX_VAR_SIZE} bytes. | |
3122 | ||
3123 | @defmac STACK_CHECK_BUILTIN | |
3124 | A nonzero value if stack checking is done by the configuration files in a | |
3125 | machine-dependent manner. You should define this macro if stack checking | |
3126 | is required by the ABI of your machine or if you would like to do stack | |
3127 | checking in some more efficient way than the generic approach. The default | |
3128 | value of this macro is zero. | |
3129 | @end defmac | |
3130 | ||
3131 | @defmac STACK_CHECK_STATIC_BUILTIN | |
3132 | A nonzero value if static stack checking is done by the configuration files | |
3133 | in a machine-dependent manner. You should define this macro if you would | |
3134 | like to do static stack checking in some more efficient way than the generic | |
3135 | approach. The default value of this macro is zero. | |
3136 | @end defmac | |
3137 | ||
3138 | @defmac STACK_CHECK_PROBE_INTERVAL_EXP | |
3139 | An integer specifying the interval at which GCC must generate stack probe | |
3140 | instructions, defined as 2 raised to this integer. You will normally | |
3141 | define this macro so that the interval be no larger than the size of | |
3142 | the ``guard pages'' at the end of a stack area. The default value | |
3143 | of 12 (4096-byte interval) is suitable for most systems. | |
3144 | @end defmac | |
3145 | ||
3146 | @defmac STACK_CHECK_MOVING_SP | |
3147 | An integer which is nonzero if GCC should move the stack pointer page by page | |
3148 | when doing probes. This can be necessary on systems where the stack pointer | |
3149 | contains the bottom address of the memory area accessible to the executing | |
3150 | thread at any point in time. In this situation an alternate signal stack | |
3151 | is required in order to be able to recover from a stack overflow. The | |
3152 | default value of this macro is zero. | |
3153 | @end defmac | |
3154 | ||
3155 | @defmac STACK_CHECK_PROTECT | |
3156 | The number of bytes of stack needed to recover from a stack overflow, for | |
3157 | languages where such a recovery is supported. The default value of 75 words | |
3158 | with the @code{setjmp}/@code{longjmp}-based exception handling mechanism and | |
3159 | 8192 bytes with other exception handling mechanisms should be adequate for | |
3160 | most machines. | |
3161 | @end defmac | |
3162 | ||
3163 | The following macros are relevant only if neither STACK_CHECK_BUILTIN | |
3164 | nor STACK_CHECK_STATIC_BUILTIN is defined; you can omit them altogether | |
3165 | in the opposite case. | |
3166 | ||
3167 | @defmac STACK_CHECK_MAX_FRAME_SIZE | |
3168 | The maximum size of a stack frame, in bytes. GCC will generate probe | |
3169 | instructions in non-leaf functions to ensure at least this many bytes of | |
3170 | stack are available. If a stack frame is larger than this size, stack | |
3171 | checking will not be reliable and GCC will issue a warning. The | |
3172 | default is chosen so that GCC only generates one instruction on most | |
3173 | systems. You should normally not change the default value of this macro. | |
3174 | @end defmac | |
3175 | ||
3176 | @defmac STACK_CHECK_FIXED_FRAME_SIZE | |
3177 | GCC uses this value to generate the above warning message. It | |
3178 | represents the amount of fixed frame used by a function, not including | |
3179 | space for any callee-saved registers, temporaries and user variables. | |
3180 | You need only specify an upper bound for this amount and will normally | |
3181 | use the default of four words. | |
3182 | @end defmac | |
3183 | ||
3184 | @defmac STACK_CHECK_MAX_VAR_SIZE | |
3185 | The maximum size, in bytes, of an object that GCC will place in the | |
3186 | fixed area of the stack frame when the user specifies | |
3187 | @option{-fstack-check}. | |
3188 | GCC computed the default from the values of the above macros and you will | |
3189 | normally not need to override that default. | |
3190 | @end defmac | |
3191 | ||
3192 | @need 2000 | |
3193 | @node Frame Registers | |
3194 | @subsection Registers That Address the Stack Frame | |
3195 | ||
3196 | @c prevent bad page break with this line | |
3197 | This discusses registers that address the stack frame. | |
3198 | ||
3199 | @defmac STACK_POINTER_REGNUM | |
3200 | The register number of the stack pointer register, which must also be a | |
3201 | fixed register according to @code{FIXED_REGISTERS}. On most machines, | |
3202 | the hardware determines which register this is. | |
3203 | @end defmac | |
3204 | ||
3205 | @defmac FRAME_POINTER_REGNUM | |
3206 | The register number of the frame pointer register, which is used to | |
3207 | access automatic variables in the stack frame. On some machines, the | |
3208 | hardware determines which register this is. On other machines, you can | |
3209 | choose any register you wish for this purpose. | |
3210 | @end defmac | |
3211 | ||
3212 | @defmac HARD_FRAME_POINTER_REGNUM | |
3213 | On some machines the offset between the frame pointer and starting | |
3214 | offset of the automatic variables is not known until after register | |
3215 | allocation has been done (for example, because the saved registers are | |
3216 | between these two locations). On those machines, define | |
3217 | @code{FRAME_POINTER_REGNUM} the number of a special, fixed register to | |
3218 | be used internally until the offset is known, and define | |
3219 | @code{HARD_FRAME_POINTER_REGNUM} to be the actual hard register number | |
3220 | used for the frame pointer. | |
3221 | ||
3222 | You should define this macro only in the very rare circumstances when it | |
3223 | is not possible to calculate the offset between the frame pointer and | |
3224 | the automatic variables until after register allocation has been | |
3225 | completed. When this macro is defined, you must also indicate in your | |
3226 | definition of @code{ELIMINABLE_REGS} how to eliminate | |
3227 | @code{FRAME_POINTER_REGNUM} into either @code{HARD_FRAME_POINTER_REGNUM} | |
3228 | or @code{STACK_POINTER_REGNUM}. | |
3229 | ||
3230 | Do not define this macro if it would be the same as | |
3231 | @code{FRAME_POINTER_REGNUM}. | |
3232 | @end defmac | |
3233 | ||
3234 | @defmac ARG_POINTER_REGNUM | |
3235 | The register number of the arg pointer register, which is used to access | |
3236 | the function's argument list. On some machines, this is the same as the | |
3237 | frame pointer register. On some machines, the hardware determines which | |
3238 | register this is. On other machines, you can choose any register you | |
3239 | wish for this purpose. If this is not the same register as the frame | |
3240 | pointer register, then you must mark it as a fixed register according to | |
3241 | @code{FIXED_REGISTERS}, or arrange to be able to eliminate it | |
3242 | (@pxref{Elimination}). | |
3243 | @end defmac | |
3244 | ||
e3339d0f JM |
3245 | @defmac HARD_FRAME_POINTER_IS_FRAME_POINTER |
3246 | Define this to a preprocessor constant that is nonzero if | |
3247 | @code{hard_frame_pointer_rtx} and @code{frame_pointer_rtx} should be | |
3248 | the same. The default definition is @samp{(HARD_FRAME_POINTER_REGNUM | |
3249 | == FRAME_POINTER_REGNUM)}; you only need to define this macro if that | |
3250 | definition is not suitable for use in preprocessor conditionals. | |
3251 | @end defmac | |
3252 | ||
3253 | @defmac HARD_FRAME_POINTER_IS_ARG_POINTER | |
3254 | Define this to a preprocessor constant that is nonzero if | |
3255 | @code{hard_frame_pointer_rtx} and @code{arg_pointer_rtx} should be the | |
3256 | same. The default definition is @samp{(HARD_FRAME_POINTER_REGNUM == | |
3257 | ARG_POINTER_REGNUM)}; you only need to define this macro if that | |
3258 | definition is not suitable for use in preprocessor conditionals. | |
3259 | @end defmac | |
3260 | ||
38f8b050 JR |
3261 | @defmac RETURN_ADDRESS_POINTER_REGNUM |
3262 | The register number of the return address pointer register, which is used to | |
3263 | access the current function's return address from the stack. On some | |
3264 | machines, the return address is not at a fixed offset from the frame | |
3265 | pointer or stack pointer or argument pointer. This register can be defined | |
3266 | to point to the return address on the stack, and then be converted by | |
3267 | @code{ELIMINABLE_REGS} into either the frame pointer or stack pointer. | |
3268 | ||
3269 | Do not define this macro unless there is no other way to get the return | |
3270 | address from the stack. | |
3271 | @end defmac | |
3272 | ||
3273 | @defmac STATIC_CHAIN_REGNUM | |
3274 | @defmacx STATIC_CHAIN_INCOMING_REGNUM | |
3275 | Register numbers used for passing a function's static chain pointer. If | |
3276 | register windows are used, the register number as seen by the called | |
3277 | function is @code{STATIC_CHAIN_INCOMING_REGNUM}, while the register | |
3278 | number as seen by the calling function is @code{STATIC_CHAIN_REGNUM}. If | |
3279 | these registers are the same, @code{STATIC_CHAIN_INCOMING_REGNUM} need | |
3280 | not be defined. | |
3281 | ||
3282 | The static chain register need not be a fixed register. | |
3283 | ||
3284 | If the static chain is passed in memory, these macros should not be | |
3285 | defined; instead, the @code{TARGET_STATIC_CHAIN} hook should be used. | |
3286 | @end defmac | |
3287 | ||
3288 | @hook TARGET_STATIC_CHAIN | |
38f8b050 JR |
3289 | |
3290 | @defmac DWARF_FRAME_REGISTERS | |
3291 | This macro specifies the maximum number of hard registers that can be | |
3292 | saved in a call frame. This is used to size data structures used in | |
3293 | DWARF2 exception handling. | |
3294 | ||
3295 | Prior to GCC 3.0, this macro was needed in order to establish a stable | |
3296 | exception handling ABI in the face of adding new hard registers for ISA | |
3297 | extensions. In GCC 3.0 and later, the EH ABI is insulated from changes | |
3298 | in the number of hard registers. Nevertheless, this macro can still be | |
3299 | used to reduce the runtime memory requirements of the exception handling | |
3300 | routines, which can be substantial if the ISA contains a lot of | |
3301 | registers that are not call-saved. | |
3302 | ||
3303 | If this macro is not defined, it defaults to | |
3304 | @code{FIRST_PSEUDO_REGISTER}. | |
3305 | @end defmac | |
3306 | ||
3307 | @defmac PRE_GCC3_DWARF_FRAME_REGISTERS | |
3308 | ||
3309 | This macro is similar to @code{DWARF_FRAME_REGISTERS}, but is provided | |
3310 | for backward compatibility in pre GCC 3.0 compiled code. | |
3311 | ||
3312 | If this macro is not defined, it defaults to | |
3313 | @code{DWARF_FRAME_REGISTERS}. | |
3314 | @end defmac | |
3315 | ||
3316 | @defmac DWARF_REG_TO_UNWIND_COLUMN (@var{regno}) | |
3317 | ||
3318 | Define this macro if the target's representation for dwarf registers | |
3319 | is different than the internal representation for unwind column. | |
3320 | Given a dwarf register, this macro should return the internal unwind | |
3321 | column number to use instead. | |
3322 | ||
3323 | See the PowerPC's SPE target for an example. | |
3324 | @end defmac | |
3325 | ||
3326 | @defmac DWARF_FRAME_REGNUM (@var{regno}) | |
3327 | ||
3328 | Define this macro if the target's representation for dwarf registers | |
3329 | used in .eh_frame or .debug_frame is different from that used in other | |
3330 | debug info sections. Given a GCC hard register number, this macro | |
3331 | should return the .eh_frame register number. The default is | |
3332 | @code{DBX_REGISTER_NUMBER (@var{regno})}. | |
3333 | ||
3334 | @end defmac | |
3335 | ||
3336 | @defmac DWARF2_FRAME_REG_OUT (@var{regno}, @var{for_eh}) | |
3337 | ||
3338 | Define this macro to map register numbers held in the call frame info | |
3339 | that GCC has collected using @code{DWARF_FRAME_REGNUM} to those that | |
3340 | should be output in .debug_frame (@code{@var{for_eh}} is zero) and | |
3341 | .eh_frame (@code{@var{for_eh}} is nonzero). The default is to | |
3342 | return @code{@var{regno}}. | |
3343 | ||
3344 | @end defmac | |
3345 | ||
cca2207a L |
3346 | @defmac REG_VALUE_IN_UNWIND_CONTEXT |
3347 | ||
3348 | Define this macro if the target stores register values as | |
3349 | @code{_Unwind_Word} type in unwind context. It should be defined if | |
3350 | target register size is larger than the size of @code{void *}. The | |
3351 | default is to store register values as @code{void *} type. | |
3352 | ||
3353 | @end defmac | |
3354 | ||
3355 | @defmac ASSUME_EXTENDED_UNWIND_CONTEXT | |
3356 | ||
3357 | Define this macro to be 1 if the target always uses extended unwind | |
3358 | context with version, args_size and by_value fields. If it is undefined, | |
3359 | it will be defined to 1 when @code{REG_VALUE_IN_UNWIND_CONTEXT} is | |
3360 | defined and 0 otherwise. | |
3361 | ||
3362 | @end defmac | |
3363 | ||
38f8b050 JR |
3364 | @node Elimination |
3365 | @subsection Eliminating Frame Pointer and Arg Pointer | |
3366 | ||
3367 | @c prevent bad page break with this line | |
3368 | This is about eliminating the frame pointer and arg pointer. | |
3369 | ||
3370 | @hook TARGET_FRAME_POINTER_REQUIRED | |
38f8b050 JR |
3371 | |
3372 | @findex get_frame_size | |
3373 | @defmac INITIAL_FRAME_POINTER_OFFSET (@var{depth-var}) | |
3374 | A C statement to store in the variable @var{depth-var} the difference | |
3375 | between the frame pointer and the stack pointer values immediately after | |
3376 | the function prologue. The value would be computed from information | |
3377 | such as the result of @code{get_frame_size ()} and the tables of | |
3378 | registers @code{regs_ever_live} and @code{call_used_regs}. | |
3379 | ||
3380 | If @code{ELIMINABLE_REGS} is defined, this macro will be not be used and | |
3381 | need not be defined. Otherwise, it must be defined even if | |
3382 | @code{TARGET_FRAME_POINTER_REQUIRED} always returns true; in that | |
3383 | case, you may set @var{depth-var} to anything. | |
3384 | @end defmac | |
3385 | ||
3386 | @defmac ELIMINABLE_REGS | |
3387 | If defined, this macro specifies a table of register pairs used to | |
3388 | eliminate unneeded registers that point into the stack frame. If it is not | |
3389 | defined, the only elimination attempted by the compiler is to replace | |
3390 | references to the frame pointer with references to the stack pointer. | |
3391 | ||
3392 | The definition of this macro is a list of structure initializations, each | |
3393 | of which specifies an original and replacement register. | |
3394 | ||
3395 | On some machines, the position of the argument pointer is not known until | |
3396 | the compilation is completed. In such a case, a separate hard register | |
3397 | must be used for the argument pointer. This register can be eliminated by | |
3398 | replacing it with either the frame pointer or the argument pointer, | |
3399 | depending on whether or not the frame pointer has been eliminated. | |
3400 | ||
3401 | In this case, you might specify: | |
3402 | @smallexample | |
3403 | #define ELIMINABLE_REGS \ | |
3404 | @{@{ARG_POINTER_REGNUM, STACK_POINTER_REGNUM@}, \ | |
3405 | @{ARG_POINTER_REGNUM, FRAME_POINTER_REGNUM@}, \ | |
3406 | @{FRAME_POINTER_REGNUM, STACK_POINTER_REGNUM@}@} | |
3407 | @end smallexample | |
3408 | ||
3409 | Note that the elimination of the argument pointer with the stack pointer is | |
3410 | specified first since that is the preferred elimination. | |
3411 | @end defmac | |
3412 | ||
3413 | @hook TARGET_CAN_ELIMINATE | |
38f8b050 JR |
3414 | |
3415 | @defmac INITIAL_ELIMINATION_OFFSET (@var{from-reg}, @var{to-reg}, @var{offset-var}) | |
3416 | This macro is similar to @code{INITIAL_FRAME_POINTER_OFFSET}. It | |
3417 | specifies the initial difference between the specified pair of | |
3418 | registers. This macro must be defined if @code{ELIMINABLE_REGS} is | |
3419 | defined. | |
3420 | @end defmac | |
3421 | ||
3422 | @node Stack Arguments | |
3423 | @subsection Passing Function Arguments on the Stack | |
3424 | @cindex arguments on stack | |
3425 | @cindex stack arguments | |
3426 | ||
3427 | The macros in this section control how arguments are passed | |
3428 | on the stack. See the following section for other macros that | |
3429 | control passing certain arguments in registers. | |
3430 | ||
3431 | @hook TARGET_PROMOTE_PROTOTYPES | |
38f8b050 JR |
3432 | |
3433 | @defmac PUSH_ARGS | |
3434 | A C expression. If nonzero, push insns will be used to pass | |
3435 | outgoing arguments. | |
3436 | If the target machine does not have a push instruction, set it to zero. | |
3437 | That directs GCC to use an alternate strategy: to | |
3438 | allocate the entire argument block and then store the arguments into | |
3439 | it. When @code{PUSH_ARGS} is nonzero, @code{PUSH_ROUNDING} must be defined too. | |
3440 | @end defmac | |
3441 | ||
3442 | @defmac PUSH_ARGS_REVERSED | |
3443 | A C expression. If nonzero, function arguments will be evaluated from | |
3444 | last to first, rather than from first to last. If this macro is not | |
3445 | defined, it defaults to @code{PUSH_ARGS} on targets where the stack | |
3446 | and args grow in opposite directions, and 0 otherwise. | |
3447 | @end defmac | |
3448 | ||
3449 | @defmac PUSH_ROUNDING (@var{npushed}) | |
3450 | A C expression that is the number of bytes actually pushed onto the | |
3451 | stack when an instruction attempts to push @var{npushed} bytes. | |
3452 | ||
3453 | On some machines, the definition | |
3454 | ||
3455 | @smallexample | |
3456 | #define PUSH_ROUNDING(BYTES) (BYTES) | |
3457 | @end smallexample | |
3458 | ||
3459 | @noindent | |
3460 | will suffice. But on other machines, instructions that appear | |
3461 | to push one byte actually push two bytes in an attempt to maintain | |
3462 | alignment. Then the definition should be | |
3463 | ||
3464 | @smallexample | |
3465 | #define PUSH_ROUNDING(BYTES) (((BYTES) + 1) & ~1) | |
3466 | @end smallexample | |
4a6336ad | 3467 | |
64ad7c99 | 3468 | If the value of this macro has a type, it should be an unsigned type. |
38f8b050 JR |
3469 | @end defmac |
3470 | ||
29454ff5 SL |
3471 | @findex outgoing_args_size |
3472 | @findex crtl->outgoing_args_size | |
38f8b050 JR |
3473 | @defmac ACCUMULATE_OUTGOING_ARGS |
3474 | A C expression. If nonzero, the maximum amount of space required for outgoing arguments | |
29454ff5 SL |
3475 | will be computed and placed into |
3476 | @code{crtl->outgoing_args_size}. No space will be pushed | |
38f8b050 JR |
3477 | onto the stack for each call; instead, the function prologue should |
3478 | increase the stack frame size by this amount. | |
3479 | ||
3480 | Setting both @code{PUSH_ARGS} and @code{ACCUMULATE_OUTGOING_ARGS} | |
3481 | is not proper. | |
3482 | @end defmac | |
3483 | ||
3484 | @defmac REG_PARM_STACK_SPACE (@var{fndecl}) | |
3485 | Define this macro if functions should assume that stack space has been | |
3486 | allocated for arguments even when their values are passed in | |
3487 | registers. | |
3488 | ||
3489 | The value of this macro is the size, in bytes, of the area reserved for | |
3490 | arguments passed in registers for the function represented by @var{fndecl}, | |
3491 | which can be zero if GCC is calling a library function. | |
3492 | The argument @var{fndecl} can be the FUNCTION_DECL, or the type itself | |
3493 | of the function. | |
3494 | ||
3495 | This space can be allocated by the caller, or be a part of the | |
3496 | machine-dependent stack frame: @code{OUTGOING_REG_PARM_STACK_SPACE} says | |
3497 | which. | |
3498 | @end defmac | |
3499 | @c above is overfull. not sure what to do. --mew 5feb93 did | |
3500 | @c something, not sure if it looks good. --mew 10feb93 | |
3501 | ||
3502 | @defmac OUTGOING_REG_PARM_STACK_SPACE (@var{fntype}) | |
3503 | Define this to a nonzero value if it is the responsibility of the | |
3504 | caller to allocate the area reserved for arguments passed in registers | |
3505 | when calling a function of @var{fntype}. @var{fntype} may be NULL | |
3506 | if the function called is a library function. | |
3507 | ||
3508 | If @code{ACCUMULATE_OUTGOING_ARGS} is defined, this macro controls | |
3509 | whether the space for these arguments counts in the value of | |
29454ff5 | 3510 | @code{crtl->outgoing_args_size}. |
38f8b050 JR |
3511 | @end defmac |
3512 | ||
3513 | @defmac STACK_PARMS_IN_REG_PARM_AREA | |
3514 | Define this macro if @code{REG_PARM_STACK_SPACE} is defined, but the | |
3515 | stack parameters don't skip the area specified by it. | |
3516 | @c i changed this, makes more sens and it should have taken care of the | |
3517 | @c overfull.. not as specific, tho. --mew 5feb93 | |
3518 | ||
3519 | Normally, when a parameter is not passed in registers, it is placed on the | |
3520 | stack beyond the @code{REG_PARM_STACK_SPACE} area. Defining this macro | |
3521 | suppresses this behavior and causes the parameter to be passed on the | |
3522 | stack in its natural location. | |
3523 | @end defmac | |
3524 | ||
893d13d5 | 3525 | @hook TARGET_RETURN_POPS_ARGS |
38f8b050 JR |
3526 | |
3527 | @defmac CALL_POPS_ARGS (@var{cum}) | |
3528 | A C expression that should indicate the number of bytes a call sequence | |
3529 | pops off the stack. It is added to the value of @code{RETURN_POPS_ARGS} | |
3530 | when compiling a function call. | |
3531 | ||
3532 | @var{cum} is the variable in which all arguments to the called function | |
3533 | have been accumulated. | |
3534 | ||
3535 | On certain architectures, such as the SH5, a call trampoline is used | |
3536 | that pops certain registers off the stack, depending on the arguments | |
3537 | that have been passed to the function. Since this is a property of the | |
3538 | call site, not of the called function, @code{RETURN_POPS_ARGS} is not | |
3539 | appropriate. | |
3540 | @end defmac | |
3541 | ||
3542 | @node Register Arguments | |
3543 | @subsection Passing Arguments in Registers | |
3544 | @cindex arguments in registers | |
3545 | @cindex registers arguments | |
3546 | ||
3547 | This section describes the macros which let you control how various | |
3548 | types of arguments are passed in registers or how they are arranged in | |
3549 | the stack. | |
3550 | ||
b25b9e8f | 3551 | @hook TARGET_FUNCTION_ARG |
38f8b050 JR |
3552 | |
3553 | @hook TARGET_MUST_PASS_IN_STACK | |
38f8b050 | 3554 | |
b25b9e8f | 3555 | @hook TARGET_FUNCTION_INCOMING_ARG |
38f8b050 JR |
3556 | |
3557 | @hook TARGET_ARG_PARTIAL_BYTES | |
38f8b050 | 3558 | |
ec9f85e5 | 3559 | @hook TARGET_PASS_BY_REFERENCE |
38f8b050 JR |
3560 | |
3561 | @hook TARGET_CALLEE_COPIES | |
38f8b050 JR |
3562 | |
3563 | @defmac CUMULATIVE_ARGS | |
b25b9e8f NF |
3564 | A C type for declaring a variable that is used as the first argument |
3565 | of @code{TARGET_FUNCTION_ARG} and other related values. For some | |
3566 | target machines, the type @code{int} suffices and can hold the number | |
3567 | of bytes of argument so far. | |
38f8b050 JR |
3568 | |
3569 | There is no need to record in @code{CUMULATIVE_ARGS} anything about the | |
3570 | arguments that have been passed on the stack. The compiler has other | |
3571 | variables to keep track of that. For target machines on which all | |
3572 | arguments are passed on the stack, there is no need to store anything in | |
3573 | @code{CUMULATIVE_ARGS}; however, the data structure must exist and | |
3574 | should not be empty, so use @code{int}. | |
3575 | @end defmac | |
3576 | ||
3577 | @defmac OVERRIDE_ABI_FORMAT (@var{fndecl}) | |
3578 | If defined, this macro is called before generating any code for a | |
3579 | function, but after the @var{cfun} descriptor for the function has been | |
3580 | created. The back end may use this macro to update @var{cfun} to | |
3581 | reflect an ABI other than that which would normally be used by default. | |
3582 | If the compiler is generating code for a compiler-generated function, | |
3583 | @var{fndecl} may be @code{NULL}. | |
3584 | @end defmac | |
3585 | ||
3586 | @defmac INIT_CUMULATIVE_ARGS (@var{cum}, @var{fntype}, @var{libname}, @var{fndecl}, @var{n_named_args}) | |
3587 | A C statement (sans semicolon) for initializing the variable | |
3588 | @var{cum} for the state at the beginning of the argument list. The | |
3589 | variable has type @code{CUMULATIVE_ARGS}. The value of @var{fntype} | |
3590 | is the tree node for the data type of the function which will receive | |
3591 | the args, or 0 if the args are to a compiler support library function. | |
3592 | For direct calls that are not libcalls, @var{fndecl} contain the | |
3593 | declaration node of the function. @var{fndecl} is also set when | |
3594 | @code{INIT_CUMULATIVE_ARGS} is used to find arguments for the function | |
3595 | being compiled. @var{n_named_args} is set to the number of named | |
3596 | arguments, including a structure return address if it is passed as a | |
3597 | parameter, when making a call. When processing incoming arguments, | |
3598 | @var{n_named_args} is set to @minus{}1. | |
3599 | ||
3600 | When processing a call to a compiler support library function, | |
3601 | @var{libname} identifies which one. It is a @code{symbol_ref} rtx which | |
3602 | contains the name of the function, as a string. @var{libname} is 0 when | |
3603 | an ordinary C function call is being processed. Thus, each time this | |
3604 | macro is called, either @var{libname} or @var{fntype} is nonzero, but | |
3605 | never both of them at once. | |
3606 | @end defmac | |
3607 | ||
3608 | @defmac INIT_CUMULATIVE_LIBCALL_ARGS (@var{cum}, @var{mode}, @var{libname}) | |
3609 | Like @code{INIT_CUMULATIVE_ARGS} but only used for outgoing libcalls, | |
3610 | it gets a @code{MODE} argument instead of @var{fntype}, that would be | |
3611 | @code{NULL}. @var{indirect} would always be zero, too. If this macro | |
3612 | is not defined, @code{INIT_CUMULATIVE_ARGS (cum, NULL_RTX, libname, | |
3613 | 0)} is used instead. | |
3614 | @end defmac | |
3615 | ||
3616 | @defmac INIT_CUMULATIVE_INCOMING_ARGS (@var{cum}, @var{fntype}, @var{libname}) | |
3617 | Like @code{INIT_CUMULATIVE_ARGS} but overrides it for the purposes of | |
3618 | finding the arguments for the function being compiled. If this macro is | |
3619 | undefined, @code{INIT_CUMULATIVE_ARGS} is used instead. | |
3620 | ||
3621 | The value passed for @var{libname} is always 0, since library routines | |
3622 | with special calling conventions are never compiled with GCC@. The | |
3623 | argument @var{libname} exists for symmetry with | |
3624 | @code{INIT_CUMULATIVE_ARGS}. | |
3625 | @c could use "this macro" in place of @code{INIT_CUMULATIVE_ARGS}, maybe. | |
3626 | @c --mew 5feb93 i switched the order of the sentences. --mew 10feb93 | |
3627 | @end defmac | |
3628 | ||
b25b9e8f | 3629 | @hook TARGET_FUNCTION_ARG_ADVANCE |
38f8b050 JR |
3630 | |
3631 | @defmac FUNCTION_ARG_OFFSET (@var{mode}, @var{type}) | |
3632 | If defined, a C expression that is the number of bytes to add to the | |
3633 | offset of the argument passed in memory. This is needed for the SPU, | |
3634 | which passes @code{char} and @code{short} arguments in the preferred | |
3635 | slot that is in the middle of the quad word instead of starting at the | |
3636 | top. | |
3637 | @end defmac | |
3638 | ||
3639 | @defmac FUNCTION_ARG_PADDING (@var{mode}, @var{type}) | |
3640 | If defined, a C expression which determines whether, and in which direction, | |
3641 | to pad out an argument with extra space. The value should be of type | |
3642 | @code{enum direction}: either @code{upward} to pad above the argument, | |
3643 | @code{downward} to pad below, or @code{none} to inhibit padding. | |
3644 | ||
123148b5 BS |
3645 | The @emph{amount} of padding is not controlled by this macro, but by the |
3646 | target hook @code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is | |
3647 | always just enough to reach the next multiple of that boundary. | |
38f8b050 JR |
3648 | |
3649 | This macro has a default definition which is right for most systems. | |
3650 | For little-endian machines, the default is to pad upward. For | |
3651 | big-endian machines, the default is to pad downward for an argument of | |
3652 | constant size shorter than an @code{int}, and upward otherwise. | |
3653 | @end defmac | |
3654 | ||
3655 | @defmac PAD_VARARGS_DOWN | |
3656 | If defined, a C expression which determines whether the default | |
3657 | implementation of va_arg will attempt to pad down before reading the | |
3658 | next argument, if that argument is smaller than its aligned space as | |
3659 | controlled by @code{PARM_BOUNDARY}. If this macro is not defined, all such | |
3660 | arguments are padded down if @code{BYTES_BIG_ENDIAN} is true. | |
3661 | @end defmac | |
3662 | ||
3663 | @defmac BLOCK_REG_PADDING (@var{mode}, @var{type}, @var{first}) | |
3664 | Specify padding for the last element of a block move between registers and | |
3665 | memory. @var{first} is nonzero if this is the only element. Defining this | |
3666 | macro allows better control of register function parameters on big-endian | |
3667 | machines, without using @code{PARALLEL} rtl. In particular, | |
3668 | @code{MUST_PASS_IN_STACK} need not test padding and mode of types in | |
3669 | registers, as there is no longer a "wrong" part of a register; For example, | |
3670 | a three byte aggregate may be passed in the high part of a register if so | |
3671 | required. | |
3672 | @end defmac | |
3673 | ||
c2ed6cf8 | 3674 | @hook TARGET_FUNCTION_ARG_BOUNDARY |
38f8b050 | 3675 | |
123148b5 BS |
3676 | @hook TARGET_FUNCTION_ARG_ROUND_BOUNDARY |
3677 | ||
38f8b050 JR |
3678 | @defmac FUNCTION_ARG_REGNO_P (@var{regno}) |
3679 | A C expression that is nonzero if @var{regno} is the number of a hard | |
3680 | register in which function arguments are sometimes passed. This does | |
3681 | @emph{not} include implicit arguments such as the static chain and | |
3682 | the structure-value address. On many machines, no registers can be | |
3683 | used for this purpose since all function arguments are pushed on the | |
3684 | stack. | |
3685 | @end defmac | |
3686 | ||
3687 | @hook TARGET_SPLIT_COMPLEX_ARG | |
38f8b050 JR |
3688 | |
3689 | @hook TARGET_BUILD_BUILTIN_VA_LIST | |
38f8b050 | 3690 | |
07a5b2bc | 3691 | @hook TARGET_ENUM_VA_LIST_P |
38f8b050 JR |
3692 | |
3693 | @hook TARGET_FN_ABI_VA_LIST | |
38f8b050 JR |
3694 | |
3695 | @hook TARGET_CANONICAL_VA_LIST_TYPE | |
38f8b050 JR |
3696 | |
3697 | @hook TARGET_GIMPLIFY_VA_ARG_EXPR | |
38f8b050 JR |
3698 | |
3699 | @hook TARGET_VALID_POINTER_MODE | |
38f8b050 | 3700 | |
7352c013 RG |
3701 | @hook TARGET_REF_MAY_ALIAS_ERRNO |
3702 | ||
38f8b050 | 3703 | @hook TARGET_SCALAR_MODE_SUPPORTED_P |
38f8b050 JR |
3704 | |
3705 | @hook TARGET_VECTOR_MODE_SUPPORTED_P | |
38f8b050 | 3706 | |
0f6d54f7 RS |
3707 | @hook TARGET_ARRAY_MODE_SUPPORTED_P |
3708 | ||
38f8b050 | 3709 | @hook TARGET_SMALL_REGISTER_CLASSES_FOR_MODE_P |
38f8b050 | 3710 | |
e692f276 RH |
3711 | @hook TARGET_FLAGS_REGNUM |
3712 | ||
38f8b050 JR |
3713 | @node Scalar Return |
3714 | @subsection How Scalar Function Values Are Returned | |
3715 | @cindex return values in registers | |
3716 | @cindex values, returned by functions | |
3717 | @cindex scalars, returned as values | |
3718 | ||
3719 | This section discusses the macros that control returning scalars as | |
3720 | values---values that can fit in registers. | |
3721 | ||
3722 | @hook TARGET_FUNCTION_VALUE | |
3723 | ||
38f8b050 JR |
3724 | @defmac FUNCTION_VALUE (@var{valtype}, @var{func}) |
3725 | This macro has been deprecated. Use @code{TARGET_FUNCTION_VALUE} for | |
3726 | a new target instead. | |
3727 | @end defmac | |
3728 | ||
3729 | @defmac LIBCALL_VALUE (@var{mode}) | |
3730 | A C expression to create an RTX representing the place where a library | |
3731 | function returns a value of mode @var{mode}. | |
3732 | ||
3733 | Note that ``library function'' in this context means a compiler | |
3734 | support routine, used to perform arithmetic, whose name is known | |
3735 | specially by the compiler and was not mentioned in the C code being | |
3736 | compiled. | |
3737 | @end defmac | |
3738 | ||
3739 | @hook TARGET_LIBCALL_VALUE | |
38f8b050 JR |
3740 | |
3741 | @defmac FUNCTION_VALUE_REGNO_P (@var{regno}) | |
3742 | A C expression that is nonzero if @var{regno} is the number of a hard | |
3743 | register in which the values of called function may come back. | |
3744 | ||
3745 | A register whose use for returning values is limited to serving as the | |
3746 | second of a pair (for a value of type @code{double}, say) need not be | |
3747 | recognized by this macro. So for most machines, this definition | |
3748 | suffices: | |
3749 | ||
3750 | @smallexample | |
3751 | #define FUNCTION_VALUE_REGNO_P(N) ((N) == 0) | |
3752 | @end smallexample | |
3753 | ||
3754 | If the machine has register windows, so that the caller and the called | |
3755 | function use different registers for the return value, this macro | |
3756 | should recognize only the caller's register numbers. | |
3757 | ||
3758 | This macro has been deprecated. Use @code{TARGET_FUNCTION_VALUE_REGNO_P} | |
3759 | for a new target instead. | |
3760 | @end defmac | |
3761 | ||
3762 | @hook TARGET_FUNCTION_VALUE_REGNO_P | |
38f8b050 JR |
3763 | |
3764 | @defmac APPLY_RESULT_SIZE | |
3765 | Define this macro if @samp{untyped_call} and @samp{untyped_return} | |
3766 | need more space than is implied by @code{FUNCTION_VALUE_REGNO_P} for | |
3767 | saving and restoring an arbitrary return value. | |
3768 | @end defmac | |
3769 | ||
3770 | @hook TARGET_RETURN_IN_MSB | |
38f8b050 JR |
3771 | |
3772 | @node Aggregate Return | |
3773 | @subsection How Large Values Are Returned | |
3774 | @cindex aggregates as return values | |
3775 | @cindex large return values | |
3776 | @cindex returning aggregate values | |
3777 | @cindex structure value address | |
3778 | ||
3779 | When a function value's mode is @code{BLKmode} (and in some other | |
3780 | cases), the value is not returned according to | |
3781 | @code{TARGET_FUNCTION_VALUE} (@pxref{Scalar Return}). Instead, the | |
3782 | caller passes the address of a block of memory in which the value | |
3783 | should be stored. This address is called the @dfn{structure value | |
3784 | address}. | |
3785 | ||
3786 | This section describes how to control returning structure values in | |
3787 | memory. | |
3788 | ||
3789 | @hook TARGET_RETURN_IN_MEMORY | |
38f8b050 JR |
3790 | |
3791 | @defmac DEFAULT_PCC_STRUCT_RETURN | |
3792 | Define this macro to be 1 if all structure and union return values must be | |
3793 | in memory. Since this results in slower code, this should be defined | |
3794 | only if needed for compatibility with other compilers or with an ABI@. | |
3795 | If you define this macro to be 0, then the conventions used for structure | |
3796 | and union return values are decided by the @code{TARGET_RETURN_IN_MEMORY} | |
3797 | target hook. | |
3798 | ||
3799 | If not defined, this defaults to the value 1. | |
3800 | @end defmac | |
3801 | ||
3802 | @hook TARGET_STRUCT_VALUE_RTX | |
38f8b050 JR |
3803 | |
3804 | @defmac PCC_STATIC_STRUCT_RETURN | |
3805 | Define this macro if the usual system convention on the target machine | |
3806 | for returning structures and unions is for the called function to return | |
3807 | the address of a static variable containing the value. | |
3808 | ||
3809 | Do not define this if the usual system convention is for the caller to | |
3810 | pass an address to the subroutine. | |
3811 | ||
3812 | This macro has effect in @option{-fpcc-struct-return} mode, but it does | |
3813 | nothing when you use @option{-freg-struct-return} mode. | |
3814 | @end defmac | |
3815 | ||
ffa88471 SE |
3816 | @hook TARGET_GET_RAW_RESULT_MODE |
3817 | ||
3818 | @hook TARGET_GET_RAW_ARG_MODE | |
3819 | ||
38f8b050 JR |
3820 | @node Caller Saves |
3821 | @subsection Caller-Saves Register Allocation | |
3822 | ||
3823 | If you enable it, GCC can save registers around function calls. This | |
3824 | makes it possible to use call-clobbered registers to hold variables that | |
3825 | must live across calls. | |
3826 | ||
3827 | @defmac CALLER_SAVE_PROFITABLE (@var{refs}, @var{calls}) | |
3828 | A C expression to determine whether it is worthwhile to consider placing | |
3829 | a pseudo-register in a call-clobbered hard register and saving and | |
3830 | restoring it around each function call. The expression should be 1 when | |
3831 | this is worth doing, and 0 otherwise. | |
3832 | ||
3833 | If you don't define this macro, a default is used which is good on most | |
3834 | machines: @code{4 * @var{calls} < @var{refs}}. | |
3835 | @end defmac | |
3836 | ||
3837 | @defmac HARD_REGNO_CALLER_SAVE_MODE (@var{regno}, @var{nregs}) | |
3838 | A C expression specifying which mode is required for saving @var{nregs} | |
3839 | of a pseudo-register in call-clobbered hard register @var{regno}. If | |
3840 | @var{regno} is unsuitable for caller save, @code{VOIDmode} should be | |
3841 | returned. For most machines this macro need not be defined since GCC | |
3842 | will select the smallest suitable mode. | |
3843 | @end defmac | |
3844 | ||
3845 | @node Function Entry | |
3846 | @subsection Function Entry and Exit | |
3847 | @cindex function entry and exit | |
3848 | @cindex prologue | |
3849 | @cindex epilogue | |
3850 | ||
3851 | This section describes the macros that output function entry | |
3852 | (@dfn{prologue}) and exit (@dfn{epilogue}) code. | |
3853 | ||
3854 | @hook TARGET_ASM_FUNCTION_PROLOGUE | |
38f8b050 JR |
3855 | |
3856 | @hook TARGET_ASM_FUNCTION_END_PROLOGUE | |
38f8b050 JR |
3857 | |
3858 | @hook TARGET_ASM_FUNCTION_BEGIN_EPILOGUE | |
38f8b050 JR |
3859 | |
3860 | @hook TARGET_ASM_FUNCTION_EPILOGUE | |
38f8b050 JR |
3861 | |
3862 | @itemize @bullet | |
3863 | @item | |
29454ff5 SL |
3864 | @findex pretend_args_size |
3865 | @findex crtl->args.pretend_args_size | |
3866 | A region of @code{crtl->args.pretend_args_size} bytes of | |
38f8b050 JR |
3867 | uninitialized space just underneath the first argument arriving on the |
3868 | stack. (This may not be at the very start of the allocated stack region | |
3869 | if the calling sequence has pushed anything else since pushing the stack | |
3870 | arguments. But usually, on such machines, nothing else has been pushed | |
3871 | yet, because the function prologue itself does all the pushing.) This | |
3872 | region is used on machines where an argument may be passed partly in | |
3873 | registers and partly in memory, and, in some cases to support the | |
3874 | features in @code{<stdarg.h>}. | |
3875 | ||
3876 | @item | |
3877 | An area of memory used to save certain registers used by the function. | |
3878 | The size of this area, which may also include space for such things as | |
3879 | the return address and pointers to previous stack frames, is | |
3880 | machine-specific and usually depends on which registers have been used | |
3881 | in the function. Machines with register windows often do not require | |
3882 | a save area. | |
3883 | ||
3884 | @item | |
3885 | A region of at least @var{size} bytes, possibly rounded up to an allocation | |
3886 | boundary, to contain the local variables of the function. On some machines, | |
3887 | this region and the save area may occur in the opposite order, with the | |
3888 | save area closer to the top of the stack. | |
3889 | ||
3890 | @item | |
3891 | @cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames | |
3892 | Optionally, when @code{ACCUMULATE_OUTGOING_ARGS} is defined, a region of | |
29454ff5 | 3893 | @code{crtl->outgoing_args_size} bytes to be used for outgoing |
38f8b050 JR |
3894 | argument lists of the function. @xref{Stack Arguments}. |
3895 | @end itemize | |
3896 | ||
3897 | @defmac EXIT_IGNORE_STACK | |
3898 | Define this macro as a C expression that is nonzero if the return | |
3899 | instruction or the function epilogue ignores the value of the stack | |
3900 | pointer; in other words, if it is safe to delete an instruction to | |
3901 | adjust the stack pointer before a return from the function. The | |
3902 | default is 0. | |
3903 | ||
3904 | Note that this macro's value is relevant only for functions for which | |
3905 | frame pointers are maintained. It is never safe to delete a final | |
3906 | stack adjustment in a function that has no frame pointer, and the | |
3907 | compiler knows this regardless of @code{EXIT_IGNORE_STACK}. | |
3908 | @end defmac | |
3909 | ||
3910 | @defmac EPILOGUE_USES (@var{regno}) | |
3911 | Define this macro as a C expression that is nonzero for registers that are | |
3912 | used by the epilogue or the @samp{return} pattern. The stack and frame | |
3913 | pointer registers are already assumed to be used as needed. | |
3914 | @end defmac | |
3915 | ||
3916 | @defmac EH_USES (@var{regno}) | |
3917 | Define this macro as a C expression that is nonzero for registers that are | |
3918 | used by the exception handling mechanism, and so should be considered live | |
3919 | on entry to an exception edge. | |
3920 | @end defmac | |
3921 | ||
38f8b050 | 3922 | @hook TARGET_ASM_OUTPUT_MI_THUNK |
38f8b050 JR |
3923 | |
3924 | @hook TARGET_ASM_CAN_OUTPUT_MI_THUNK | |
38f8b050 JR |
3925 | |
3926 | @node Profiling | |
3927 | @subsection Generating Code for Profiling | |
3928 | @cindex profiling, code generation | |
3929 | ||
3930 | These macros will help you generate code for profiling. | |
3931 | ||
3932 | @defmac FUNCTION_PROFILER (@var{file}, @var{labelno}) | |
3933 | A C statement or compound statement to output to @var{file} some | |
3934 | assembler code to call the profiling subroutine @code{mcount}. | |
3935 | ||
3936 | @findex mcount | |
3937 | The details of how @code{mcount} expects to be called are determined by | |
3938 | your operating system environment, not by GCC@. To figure them out, | |
3939 | compile a small program for profiling using the system's installed C | |
3940 | compiler and look at the assembler code that results. | |
3941 | ||
3942 | Older implementations of @code{mcount} expect the address of a counter | |
3943 | variable to be loaded into some register. The name of this variable is | |
3944 | @samp{LP} followed by the number @var{labelno}, so you would generate | |
3945 | the name using @samp{LP%d} in a @code{fprintf}. | |
3946 | @end defmac | |
3947 | ||
3948 | @defmac PROFILE_HOOK | |
3949 | A C statement or compound statement to output to @var{file} some assembly | |
3950 | code to call the profiling subroutine @code{mcount} even the target does | |
3951 | not support profiling. | |
3952 | @end defmac | |
3953 | ||
3954 | @defmac NO_PROFILE_COUNTERS | |
3955 | Define this macro to be an expression with a nonzero value if the | |
3956 | @code{mcount} subroutine on your system does not need a counter variable | |
3957 | allocated for each function. This is true for almost all modern | |
3958 | implementations. If you define this macro, you must not use the | |
3959 | @var{labelno} argument to @code{FUNCTION_PROFILER}. | |
3960 | @end defmac | |
3961 | ||
3962 | @defmac PROFILE_BEFORE_PROLOGUE | |
3963 | Define this macro if the code for function profiling should come before | |
3964 | the function prologue. Normally, the profiling code comes after. | |
3965 | @end defmac | |
3966 | ||
d56a43a0 AK |
3967 | @hook TARGET_KEEP_LEAF_WHEN_PROFILED |
3968 | ||
38f8b050 JR |
3969 | @node Tail Calls |
3970 | @subsection Permitting tail calls | |
3971 | @cindex tail calls | |
3972 | ||
3973 | @hook TARGET_FUNCTION_OK_FOR_SIBCALL | |
38f8b050 JR |
3974 | |
3975 | @hook TARGET_EXTRA_LIVE_ON_ENTRY | |
38f8b050 | 3976 | |
ee3d2ecd JJ |
3977 | @hook TARGET_SET_UP_BY_PROLOGUE |
3978 | ||
d45eae79 SL |
3979 | @hook TARGET_WARN_FUNC_RETURN |
3980 | ||
38f8b050 JR |
3981 | @node Stack Smashing Protection |
3982 | @subsection Stack smashing protection | |
3983 | @cindex stack smashing protection | |
3984 | ||
3985 | @hook TARGET_STACK_PROTECT_GUARD | |
38f8b050 JR |
3986 | |
3987 | @hook TARGET_STACK_PROTECT_FAIL | |
38f8b050 | 3988 | |
7458026b ILT |
3989 | @hook TARGET_SUPPORTS_SPLIT_STACK |
3990 | ||
aaeaa9a9 RO |
3991 | @node Miscellaneous Register Hooks |
3992 | @subsection Miscellaneous register hooks | |
3993 | @cindex miscellaneous register hooks | |
3994 | ||
3995 | @hook TARGET_CALL_FUSAGE_CONTAINS_NON_CALLEE_CLOBBERS | |
3996 | ||
38f8b050 JR |
3997 | @node Varargs |
3998 | @section Implementing the Varargs Macros | |
3999 | @cindex varargs implementation | |
4000 | ||
4001 | GCC comes with an implementation of @code{<varargs.h>} and | |
4002 | @code{<stdarg.h>} that work without change on machines that pass arguments | |
4003 | on the stack. Other machines require their own implementations of | |
4004 | varargs, and the two machine independent header files must have | |
4005 | conditionals to include it. | |
4006 | ||
4007 | ISO @code{<stdarg.h>} differs from traditional @code{<varargs.h>} mainly in | |
4008 | the calling convention for @code{va_start}. The traditional | |
4009 | implementation takes just one argument, which is the variable in which | |
4010 | to store the argument pointer. The ISO implementation of | |
4011 | @code{va_start} takes an additional second argument. The user is | |
4012 | supposed to write the last named argument of the function here. | |
4013 | ||
4014 | However, @code{va_start} should not use this argument. The way to find | |
4015 | the end of the named arguments is with the built-in functions described | |
4016 | below. | |
4017 | ||
4018 | @defmac __builtin_saveregs () | |
4019 | Use this built-in function to save the argument registers in memory so | |
4020 | that the varargs mechanism can access them. Both ISO and traditional | |
4021 | versions of @code{va_start} must use @code{__builtin_saveregs}, unless | |
4022 | you use @code{TARGET_SETUP_INCOMING_VARARGS} (see below) instead. | |
4023 | ||
4024 | On some machines, @code{__builtin_saveregs} is open-coded under the | |
4025 | control of the target hook @code{TARGET_EXPAND_BUILTIN_SAVEREGS}. On | |
4026 | other machines, it calls a routine written in assembler language, | |
4027 | found in @file{libgcc2.c}. | |
4028 | ||
4029 | Code generated for the call to @code{__builtin_saveregs} appears at the | |
4030 | beginning of the function, as opposed to where the call to | |
4031 | @code{__builtin_saveregs} is written, regardless of what the code is. | |
4032 | This is because the registers must be saved before the function starts | |
4033 | to use them for its own purposes. | |
4034 | @c i rewrote the first sentence above to fix an overfull hbox. --mew | |
4035 | @c 10feb93 | |
4036 | @end defmac | |
4037 | ||
38f8b050 | 4038 | @defmac __builtin_next_arg (@var{lastarg}) |
c59a0a1d | 4039 | This builtin returns the address of the first anonymous stack |
38f8b050 JR |
4040 | argument, as type @code{void *}. If @code{ARGS_GROW_DOWNWARD}, it |
4041 | returns the address of the location above the first anonymous stack | |
4042 | argument. Use it in @code{va_start} to initialize the pointer for | |
4043 | fetching arguments from the stack. Also use it in @code{va_start} to | |
4044 | verify that the second parameter @var{lastarg} is the last named argument | |
4045 | of the current function. | |
4046 | @end defmac | |
4047 | ||
4048 | @defmac __builtin_classify_type (@var{object}) | |
4049 | Since each machine has its own conventions for which data types are | |
4050 | passed in which kind of register, your implementation of @code{va_arg} | |
4051 | has to embody these conventions. The easiest way to categorize the | |
4052 | specified data type is to use @code{__builtin_classify_type} together | |
4053 | with @code{sizeof} and @code{__alignof__}. | |
4054 | ||
4055 | @code{__builtin_classify_type} ignores the value of @var{object}, | |
4056 | considering only its data type. It returns an integer describing what | |
4057 | kind of type that is---integer, floating, pointer, structure, and so on. | |
4058 | ||
4059 | The file @file{typeclass.h} defines an enumeration that you can use to | |
4060 | interpret the values of @code{__builtin_classify_type}. | |
4061 | @end defmac | |
4062 | ||
4063 | These machine description macros help implement varargs: | |
4064 | ||
4065 | @hook TARGET_EXPAND_BUILTIN_SAVEREGS | |
38f8b050 JR |
4066 | |
4067 | @hook TARGET_SETUP_INCOMING_VARARGS | |
38f8b050 JR |
4068 | |
4069 | @hook TARGET_STRICT_ARGUMENT_NAMING | |
38f8b050 JR |
4070 | |
4071 | @hook TARGET_PRETEND_OUTGOING_VARARGS_NAMED | |
38f8b050 JR |
4072 | |
4073 | @node Trampolines | |
4074 | @section Trampolines for Nested Functions | |
4075 | @cindex trampolines for nested functions | |
4076 | @cindex nested functions, trampolines for | |
4077 | ||
4078 | A @dfn{trampoline} is a small piece of code that is created at run time | |
4079 | when the address of a nested function is taken. It normally resides on | |
4080 | the stack, in the stack frame of the containing function. These macros | |
4081 | tell GCC how to generate code to allocate and initialize a | |
4082 | trampoline. | |
4083 | ||
4084 | The instructions in the trampoline must do two things: load a constant | |
4085 | address into the static chain register, and jump to the real address of | |
4086 | the nested function. On CISC machines such as the m68k, this requires | |
4087 | two instructions, a move immediate and a jump. Then the two addresses | |
4088 | exist in the trampoline as word-long immediate operands. On RISC | |
4089 | machines, it is often necessary to load each address into a register in | |
4090 | two parts. Then pieces of each address form separate immediate | |
4091 | operands. | |
4092 | ||
4093 | The code generated to initialize the trampoline must store the variable | |
4094 | parts---the static chain value and the function address---into the | |
4095 | immediate operands of the instructions. On a CISC machine, this is | |
4096 | simply a matter of copying each address to a memory reference at the | |
4097 | proper offset from the start of the trampoline. On a RISC machine, it | |
4098 | may be necessary to take out pieces of the address and store them | |
4099 | separately. | |
4100 | ||
4101 | @hook TARGET_ASM_TRAMPOLINE_TEMPLATE | |
38f8b050 JR |
4102 | |
4103 | @defmac TRAMPOLINE_SECTION | |
4104 | Return the section into which the trampoline template is to be placed | |
4105 | (@pxref{Sections}). The default value is @code{readonly_data_section}. | |
4106 | @end defmac | |
4107 | ||
4108 | @defmac TRAMPOLINE_SIZE | |
4109 | A C expression for the size in bytes of the trampoline, as an integer. | |
4110 | @end defmac | |
4111 | ||
4112 | @defmac TRAMPOLINE_ALIGNMENT | |
4113 | Alignment required for trampolines, in bits. | |
4114 | ||
4115 | If you don't define this macro, the value of @code{FUNCTION_ALIGNMENT} | |
4116 | is used for aligning trampolines. | |
4117 | @end defmac | |
4118 | ||
4119 | @hook TARGET_TRAMPOLINE_INIT | |
38f8b050 JR |
4120 | |
4121 | @hook TARGET_TRAMPOLINE_ADJUST_ADDRESS | |
38f8b050 JR |
4122 | |
4123 | Implementing trampolines is difficult on many machines because they have | |
4124 | separate instruction and data caches. Writing into a stack location | |
4125 | fails to clear the memory in the instruction cache, so when the program | |
4126 | jumps to that location, it executes the old contents. | |
4127 | ||
4128 | Here are two possible solutions. One is to clear the relevant parts of | |
4129 | the instruction cache whenever a trampoline is set up. The other is to | |
4130 | make all trampolines identical, by having them jump to a standard | |
4131 | subroutine. The former technique makes trampoline execution faster; the | |
4132 | latter makes initialization faster. | |
4133 | ||
4134 | To clear the instruction cache when a trampoline is initialized, define | |
4135 | the following macro. | |
4136 | ||
4137 | @defmac CLEAR_INSN_CACHE (@var{beg}, @var{end}) | |
4138 | If defined, expands to a C expression clearing the @emph{instruction | |
4139 | cache} in the specified interval. The definition of this macro would | |
4140 | typically be a series of @code{asm} statements. Both @var{beg} and | |
4141 | @var{end} are both pointer expressions. | |
4142 | @end defmac | |
4143 | ||
38f8b050 JR |
4144 | To use a standard subroutine, define the following macro. In addition, |
4145 | you must make sure that the instructions in a trampoline fill an entire | |
4146 | cache line with identical instructions, or else ensure that the | |
4147 | beginning of the trampoline code is always aligned at the same point in | |
4148 | its cache line. Look in @file{m68k.h} as a guide. | |
4149 | ||
4150 | @defmac TRANSFER_FROM_TRAMPOLINE | |
4151 | Define this macro if trampolines need a special subroutine to do their | |
4152 | work. The macro should expand to a series of @code{asm} statements | |
4153 | which will be compiled with GCC@. They go in a library function named | |
4154 | @code{__transfer_from_trampoline}. | |
4155 | ||
4156 | If you need to avoid executing the ordinary prologue code of a compiled | |
4157 | C function when you jump to the subroutine, you can do so by placing a | |
4158 | special label of your own in the assembler code. Use one @code{asm} | |
4159 | statement to generate an assembler label, and another to make the label | |
4160 | global. Then trampolines can use that label to jump directly to your | |
4161 | special assembler code. | |
4162 | @end defmac | |
4163 | ||
4164 | @node Library Calls | |
4165 | @section Implicit Calls to Library Routines | |
4166 | @cindex library subroutine names | |
4167 | @cindex @file{libgcc.a} | |
4168 | ||
4169 | @c prevent bad page break with this line | |
4170 | Here is an explanation of implicit calls to library routines. | |
4171 | ||
4172 | @defmac DECLARE_LIBRARY_RENAMES | |
4173 | This macro, if defined, should expand to a piece of C code that will get | |
4174 | expanded when compiling functions for libgcc.a. It can be used to | |
4175 | provide alternate names for GCC's internal library functions if there | |
4176 | are ABI-mandated names that the compiler should provide. | |
4177 | @end defmac | |
4178 | ||
4179 | @findex set_optab_libfunc | |
4180 | @findex init_one_libfunc | |
4181 | @hook TARGET_INIT_LIBFUNCS | |
38f8b050 | 4182 | |
cdbf4541 BS |
4183 | @hook TARGET_LIBFUNC_GNU_PREFIX |
4184 | ||
38f8b050 JR |
4185 | @defmac FLOAT_LIB_COMPARE_RETURNS_BOOL (@var{mode}, @var{comparison}) |
4186 | This macro should return @code{true} if the library routine that | |
4187 | implements the floating point comparison operator @var{comparison} in | |
4188 | mode @var{mode} will return a boolean, and @var{false} if it will | |
4189 | return a tristate. | |
4190 | ||
4191 | GCC's own floating point libraries return tristates from the | |
4192 | comparison operators, so the default returns false always. Most ports | |
4193 | don't need to define this macro. | |
4194 | @end defmac | |
4195 | ||
4196 | @defmac TARGET_LIB_INT_CMP_BIASED | |
4197 | This macro should evaluate to @code{true} if the integer comparison | |
4198 | functions (like @code{__cmpdi2}) return 0 to indicate that the first | |
4199 | operand is smaller than the second, 1 to indicate that they are equal, | |
4200 | and 2 to indicate that the first operand is greater than the second. | |
4201 | If this macro evaluates to @code{false} the comparison functions return | |
4202 | @minus{}1, 0, and 1 instead of 0, 1, and 2. If the target uses the routines | |
4203 | in @file{libgcc.a}, you do not need to define this macro. | |
4204 | @end defmac | |
4205 | ||
30b8f78b KV |
4206 | @defmac TARGET_HAS_NO_HW_DIVIDE |
4207 | This macro should be defined if the target has no hardware divide | |
4208 | instructions. If this macro is defined, GCC will use an algorithm which | |
4209 | make use of simple logical and arithmetic operations for 64-bit | |
4210 | division. If the macro is not defined, GCC will use an algorithm which | |
4211 | make use of a 64-bit by 32-bit divide primitive. | |
4212 | @end defmac | |
4213 | ||
38f8b050 JR |
4214 | @cindex @code{EDOM}, implicit usage |
4215 | @findex matherr | |
4216 | @defmac TARGET_EDOM | |
4217 | The value of @code{EDOM} on the target machine, as a C integer constant | |
4218 | expression. If you don't define this macro, GCC does not attempt to | |
4219 | deposit the value of @code{EDOM} into @code{errno} directly. Look in | |
4220 | @file{/usr/include/errno.h} to find the value of @code{EDOM} on your | |
4221 | system. | |
4222 | ||
4223 | If you do not define @code{TARGET_EDOM}, then compiled code reports | |
4224 | domain errors by calling the library function and letting it report the | |
4225 | error. If mathematical functions on your system use @code{matherr} when | |
4226 | there is an error, then you should leave @code{TARGET_EDOM} undefined so | |
4227 | that @code{matherr} is used normally. | |
4228 | @end defmac | |
4229 | ||
4230 | @cindex @code{errno}, implicit usage | |
4231 | @defmac GEN_ERRNO_RTX | |
4232 | Define this macro as a C expression to create an rtl expression that | |
4233 | refers to the global ``variable'' @code{errno}. (On certain systems, | |
4234 | @code{errno} may not actually be a variable.) If you don't define this | |
4235 | macro, a reasonable default is used. | |
4236 | @end defmac | |
4237 | ||
d33d9e47 | 4238 | @hook TARGET_LIBC_HAS_FUNCTION |
38f8b050 JR |
4239 | |
4240 | @defmac NEXT_OBJC_RUNTIME | |
fea3ca91 IS |
4241 | Set this macro to 1 to use the "NeXT" Objective-C message sending conventions |
4242 | by default. This calling convention involves passing the object, the selector | |
4243 | and the method arguments all at once to the method-lookup library function. | |
4244 | This is the usual setting when targeting Darwin/Mac OS X systems, which have | |
4245 | the NeXT runtime installed. | |
4246 | ||
4247 | If the macro is set to 0, the "GNU" Objective-C message sending convention | |
4248 | will be used by default. This convention passes just the object and the | |
4249 | selector to the method-lookup function, which returns a pointer to the method. | |
4250 | ||
4251 | In either case, it remains possible to select code-generation for the alternate | |
4252 | scheme, by means of compiler command line switches. | |
38f8b050 JR |
4253 | @end defmac |
4254 | ||
4255 | @node Addressing Modes | |
4256 | @section Addressing Modes | |
4257 | @cindex addressing modes | |
4258 | ||
4259 | @c prevent bad page break with this line | |
4260 | This is about addressing modes. | |
4261 | ||
4262 | @defmac HAVE_PRE_INCREMENT | |
4263 | @defmacx HAVE_PRE_DECREMENT | |
4264 | @defmacx HAVE_POST_INCREMENT | |
4265 | @defmacx HAVE_POST_DECREMENT | |
4266 | A C expression that is nonzero if the machine supports pre-increment, | |
4267 | pre-decrement, post-increment, or post-decrement addressing respectively. | |
4268 | @end defmac | |
4269 | ||
4270 | @defmac HAVE_PRE_MODIFY_DISP | |
4271 | @defmacx HAVE_POST_MODIFY_DISP | |
4272 | A C expression that is nonzero if the machine supports pre- or | |
4273 | post-address side-effect generation involving constants other than | |
4274 | the size of the memory operand. | |
4275 | @end defmac | |
4276 | ||
4277 | @defmac HAVE_PRE_MODIFY_REG | |
4278 | @defmacx HAVE_POST_MODIFY_REG | |
4279 | A C expression that is nonzero if the machine supports pre- or | |
4280 | post-address side-effect generation involving a register displacement. | |
4281 | @end defmac | |
4282 | ||
4283 | @defmac CONSTANT_ADDRESS_P (@var{x}) | |
4284 | A C expression that is 1 if the RTX @var{x} is a constant which | |
4285 | is a valid address. On most machines the default definition of | |
4286 | @code{(CONSTANT_P (@var{x}) && GET_CODE (@var{x}) != CONST_DOUBLE)} | |
4287 | is acceptable, but a few machines are more restrictive as to which | |
ff2ce160 | 4288 | constant addresses are supported. |
38f8b050 JR |
4289 | @end defmac |
4290 | ||
4291 | @defmac CONSTANT_P (@var{x}) | |
4292 | @code{CONSTANT_P}, which is defined by target-independent code, | |
4293 | accepts integer-values expressions whose values are not explicitly | |
4294 | known, such as @code{symbol_ref}, @code{label_ref}, and @code{high} | |
4295 | expressions and @code{const} arithmetic expressions, in addition to | |
4296 | @code{const_int} and @code{const_double} expressions. | |
4297 | @end defmac | |
4298 | ||
4299 | @defmac MAX_REGS_PER_ADDRESS | |
4300 | A number, the maximum number of registers that can appear in a valid | |
4301 | memory address. Note that it is up to you to specify a value equal to | |
4302 | the maximum number that @code{TARGET_LEGITIMATE_ADDRESS_P} would ever | |
4303 | accept. | |
4304 | @end defmac | |
4305 | ||
4306 | @hook TARGET_LEGITIMATE_ADDRESS_P | |
38f8b050 JR |
4307 | |
4308 | @defmac TARGET_MEM_CONSTRAINT | |
4309 | A single character to be used instead of the default @code{'m'} | |
4310 | character for general memory addresses. This defines the constraint | |
4311 | letter which matches the memory addresses accepted by | |
4312 | @code{TARGET_LEGITIMATE_ADDRESS_P}. Define this macro if you want to | |
4313 | support new address formats in your back end without changing the | |
4314 | semantics of the @code{'m'} constraint. This is necessary in order to | |
4315 | preserve functionality of inline assembly constructs using the | |
4316 | @code{'m'} constraint. | |
4317 | @end defmac | |
4318 | ||
4319 | @defmac FIND_BASE_TERM (@var{x}) | |
4320 | A C expression to determine the base term of address @var{x}, | |
4321 | or to provide a simplified version of @var{x} from which @file{alias.c} | |
4322 | can easily find the base term. This macro is used in only two places: | |
4323 | @code{find_base_value} and @code{find_base_term} in @file{alias.c}. | |
4324 | ||
4325 | It is always safe for this macro to not be defined. It exists so | |
4326 | that alias analysis can understand machine-dependent addresses. | |
4327 | ||
4328 | The typical use of this macro is to handle addresses containing | |
4329 | a label_ref or symbol_ref within an UNSPEC@. | |
4330 | @end defmac | |
4331 | ||
4332 | @hook TARGET_LEGITIMIZE_ADDRESS | |
38f8b050 JR |
4333 | |
4334 | @defmac LEGITIMIZE_RELOAD_ADDRESS (@var{x}, @var{mode}, @var{opnum}, @var{type}, @var{ind_levels}, @var{win}) | |
4335 | A C compound statement that attempts to replace @var{x}, which is an address | |
4336 | that needs reloading, with a valid memory address for an operand of mode | |
4337 | @var{mode}. @var{win} will be a C statement label elsewhere in the code. | |
4338 | It is not necessary to define this macro, but it might be useful for | |
4339 | performance reasons. | |
4340 | ||
4341 | For example, on the i386, it is sometimes possible to use a single | |
4342 | reload register instead of two by reloading a sum of two pseudo | |
4343 | registers into a register. On the other hand, for number of RISC | |
4344 | processors offsets are limited so that often an intermediate address | |
4345 | needs to be generated in order to address a stack slot. By defining | |
4346 | @code{LEGITIMIZE_RELOAD_ADDRESS} appropriately, the intermediate addresses | |
4347 | generated for adjacent some stack slots can be made identical, and thus | |
4348 | be shared. | |
4349 | ||
4350 | @emph{Note}: This macro should be used with caution. It is necessary | |
4351 | to know something of how reload works in order to effectively use this, | |
4352 | and it is quite easy to produce macros that build in too much knowledge | |
4353 | of reload internals. | |
4354 | ||
4355 | @emph{Note}: This macro must be able to reload an address created by a | |
4356 | previous invocation of this macro. If it fails to handle such addresses | |
4357 | then the compiler may generate incorrect code or abort. | |
4358 | ||
4359 | @findex push_reload | |
4360 | The macro definition should use @code{push_reload} to indicate parts that | |
4361 | need reloading; @var{opnum}, @var{type} and @var{ind_levels} are usually | |
4362 | suitable to be passed unaltered to @code{push_reload}. | |
4363 | ||
4364 | The code generated by this macro must not alter the substructure of | |
4365 | @var{x}. If it transforms @var{x} into a more legitimate form, it | |
4366 | should assign @var{x} (which will always be a C variable) a new value. | |
4367 | This also applies to parts that you change indirectly by calling | |
4368 | @code{push_reload}. | |
4369 | ||
4370 | @findex strict_memory_address_p | |
4371 | The macro definition may use @code{strict_memory_address_p} to test if | |
4372 | the address has become legitimate. | |
4373 | ||
4374 | @findex copy_rtx | |
4375 | If you want to change only a part of @var{x}, one standard way of doing | |
4376 | this is to use @code{copy_rtx}. Note, however, that it unshares only a | |
4377 | single level of rtl. Thus, if the part to be changed is not at the | |
4378 | top level, you'll need to replace first the top level. | |
4379 | It is not necessary for this macro to come up with a legitimate | |
4380 | address; but often a machine-dependent strategy can generate better code. | |
4381 | @end defmac | |
4382 | ||
4383 | @hook TARGET_MODE_DEPENDENT_ADDRESS_P | |
38f8b050 | 4384 | |
1a627b35 | 4385 | @hook TARGET_LEGITIMATE_CONSTANT_P |
38f8b050 JR |
4386 | |
4387 | @hook TARGET_DELEGITIMIZE_ADDRESS | |
38f8b050 | 4388 | |
93bcc8c9 | 4389 | @hook TARGET_CONST_NOT_OK_FOR_DEBUG_P |
93bcc8c9 | 4390 | |
38f8b050 | 4391 | @hook TARGET_CANNOT_FORCE_CONST_MEM |
38f8b050 JR |
4392 | |
4393 | @hook TARGET_USE_BLOCKS_FOR_CONSTANT_P | |
38f8b050 | 4394 | |
361a58da | 4395 | @hook TARGET_USE_BLOCKS_FOR_DECL_P |
361a58da | 4396 | |
89356d17 | 4397 | @hook TARGET_BUILTIN_RECIPROCAL |
38f8b050 JR |
4398 | |
4399 | @hook TARGET_VECTORIZE_BUILTIN_MASK_FOR_LOAD | |
38f8b050 | 4400 | |
38f8b050 | 4401 | @hook TARGET_VECTORIZE_BUILTIN_VECTORIZATION_COST |
38f8b050 JR |
4402 | |
4403 | @hook TARGET_VECTORIZE_VECTOR_ALIGNMENT_REACHABLE | |
38f8b050 | 4404 | |
5a3c0068 | 4405 | @hook TARGET_VECTORIZE_VEC_PERM_CONST_OK |
38f8b050 JR |
4406 | |
4407 | @hook TARGET_VECTORIZE_BUILTIN_CONVERSION | |
38f8b050 JR |
4408 | |
4409 | @hook TARGET_VECTORIZE_BUILTIN_VECTORIZED_FUNCTION | |
38f8b050 JR |
4410 | |
4411 | @hook TARGET_VECTORIZE_SUPPORT_VECTOR_MISALIGNMENT | |
38f8b050 | 4412 | |
cc4b5170 | 4413 | @hook TARGET_VECTORIZE_PREFERRED_SIMD_MODE |
26983c22 | 4414 | |
767f865f | 4415 | @hook TARGET_VECTORIZE_AUTOVECTORIZE_VECTOR_SIZES |
767f865f | 4416 | |
c3e7ee41 BS |
4417 | @hook TARGET_VECTORIZE_INIT_COST |
4418 | ||
4419 | @hook TARGET_VECTORIZE_ADD_STMT_COST | |
4420 | ||
4421 | @hook TARGET_VECTORIZE_FINISH_COST | |
4422 | ||
4423 | @hook TARGET_VECTORIZE_DESTROY_COST_DATA | |
4424 | ||
0a35513e AH |
4425 | @hook TARGET_VECTORIZE_BUILTIN_TM_LOAD |
4426 | ||
4427 | @hook TARGET_VECTORIZE_BUILTIN_TM_STORE | |
4428 | ||
aec7ae7d | 4429 | @hook TARGET_VECTORIZE_BUILTIN_GATHER |
aec7ae7d | 4430 | |
0136f8f0 AH |
4431 | @hook TARGET_SIMD_CLONE_COMPUTE_VECSIZE_AND_SIMDLEN |
4432 | ||
4433 | @hook TARGET_SIMD_CLONE_ADJUST | |
4434 | ||
4435 | @hook TARGET_SIMD_CLONE_USABLE | |
4436 | ||
38f8b050 JR |
4437 | @node Anchored Addresses |
4438 | @section Anchored Addresses | |
4439 | @cindex anchored addresses | |
4440 | @cindex @option{-fsection-anchors} | |
4441 | ||
4442 | GCC usually addresses every static object as a separate entity. | |
4443 | For example, if we have: | |
4444 | ||
4445 | @smallexample | |
4446 | static int a, b, c; | |
4447 | int foo (void) @{ return a + b + c; @} | |
4448 | @end smallexample | |
4449 | ||
4450 | the code for @code{foo} will usually calculate three separate symbolic | |
4451 | addresses: those of @code{a}, @code{b} and @code{c}. On some targets, | |
4452 | it would be better to calculate just one symbolic address and access | |
4453 | the three variables relative to it. The equivalent pseudocode would | |
4454 | be something like: | |
4455 | ||
4456 | @smallexample | |
4457 | int foo (void) | |
4458 | @{ | |
4459 | register int *xr = &x; | |
4460 | return xr[&a - &x] + xr[&b - &x] + xr[&c - &x]; | |
4461 | @} | |
4462 | @end smallexample | |
4463 | ||
4464 | (which isn't valid C). We refer to shared addresses like @code{x} as | |
4465 | ``section anchors''. Their use is controlled by @option{-fsection-anchors}. | |
4466 | ||
4467 | The hooks below describe the target properties that GCC needs to know | |
4468 | in order to make effective use of section anchors. It won't use | |
4469 | section anchors at all unless either @code{TARGET_MIN_ANCHOR_OFFSET} | |
4470 | or @code{TARGET_MAX_ANCHOR_OFFSET} is set to a nonzero value. | |
4471 | ||
4472 | @hook TARGET_MIN_ANCHOR_OFFSET | |
38f8b050 JR |
4473 | |
4474 | @hook TARGET_MAX_ANCHOR_OFFSET | |
38f8b050 JR |
4475 | |
4476 | @hook TARGET_ASM_OUTPUT_ANCHOR | |
38f8b050 JR |
4477 | |
4478 | @hook TARGET_USE_ANCHORS_FOR_SYMBOL_P | |
38f8b050 JR |
4479 | |
4480 | @node Condition Code | |
4481 | @section Condition Code Status | |
4482 | @cindex condition code status | |
4483 | ||
4484 | The macros in this section can be split in two families, according to the | |
4485 | two ways of representing condition codes in GCC. | |
4486 | ||
4487 | The first representation is the so called @code{(cc0)} representation | |
4488 | (@pxref{Jump Patterns}), where all instructions can have an implicit | |
4489 | clobber of the condition codes. The second is the condition code | |
4490 | register representation, which provides better schedulability for | |
4491 | architectures that do have a condition code register, but on which | |
4492 | most instructions do not affect it. The latter category includes | |
4493 | most RISC machines. | |
4494 | ||
4495 | The implicit clobbering poses a strong restriction on the placement of | |
c4f6267b L |
4496 | the definition and use of the condition code. In the past the definition |
4497 | and use were always adjacent. However, recent changes to support trapping | |
4498 | arithmatic may result in the definition and user being in different blocks. | |
4499 | Thus, there may be a @code{NOTE_INSN_BASIC_BLOCK} between them. Additionally, | |
4500 | the definition may be the source of exception handling edges. | |
4501 | ||
4502 | These restrictions can prevent important | |
38f8b050 JR |
4503 | optimizations on some machines. For example, on the IBM RS/6000, there |
4504 | is a delay for taken branches unless the condition code register is set | |
4505 | three instructions earlier than the conditional branch. The instruction | |
4506 | scheduler cannot perform this optimization if it is not permitted to | |
4507 | separate the definition and use of the condition code register. | |
4508 | ||
4509 | For this reason, it is possible and suggested to use a register to | |
4510 | represent the condition code for new ports. If there is a specific | |
4511 | condition code register in the machine, use a hard register. If the | |
4512 | condition code or comparison result can be placed in any general register, | |
4513 | or if there are multiple condition registers, use a pseudo register. | |
4514 | Registers used to store the condition code value will usually have a mode | |
4515 | that is in class @code{MODE_CC}. | |
4516 | ||
4517 | Alternatively, you can use @code{BImode} if the comparison operator is | |
4518 | specified already in the compare instruction. In this case, you are not | |
4519 | interested in most macros in this section. | |
4520 | ||
4521 | @menu | |
4522 | * CC0 Condition Codes:: Old style representation of condition codes. | |
4523 | * MODE_CC Condition Codes:: Modern representation of condition codes. | |
38f8b050 JR |
4524 | @end menu |
4525 | ||
4526 | @node CC0 Condition Codes | |
4527 | @subsection Representation of condition codes using @code{(cc0)} | |
4528 | @findex cc0 | |
4529 | ||
4530 | @findex cc_status | |
4531 | The file @file{conditions.h} defines a variable @code{cc_status} to | |
4532 | describe how the condition code was computed (in case the interpretation of | |
4533 | the condition code depends on the instruction that it was set by). This | |
4534 | variable contains the RTL expressions on which the condition code is | |
4535 | currently based, and several standard flags. | |
4536 | ||
4537 | Sometimes additional machine-specific flags must be defined in the machine | |
4538 | description header file. It can also add additional machine-specific | |
4539 | information by defining @code{CC_STATUS_MDEP}. | |
4540 | ||
4541 | @defmac CC_STATUS_MDEP | |
4542 | C code for a data type which is used for declaring the @code{mdep} | |
4543 | component of @code{cc_status}. It defaults to @code{int}. | |
4544 | ||
4545 | This macro is not used on machines that do not use @code{cc0}. | |
4546 | @end defmac | |
4547 | ||
4548 | @defmac CC_STATUS_MDEP_INIT | |
4549 | A C expression to initialize the @code{mdep} field to ``empty''. | |
4550 | The default definition does nothing, since most machines don't use | |
4551 | the field anyway. If you want to use the field, you should probably | |
4552 | define this macro to initialize it. | |
4553 | ||
4554 | This macro is not used on machines that do not use @code{cc0}. | |
4555 | @end defmac | |
4556 | ||
4557 | @defmac NOTICE_UPDATE_CC (@var{exp}, @var{insn}) | |
4558 | A C compound statement to set the components of @code{cc_status} | |
4559 | appropriately for an insn @var{insn} whose body is @var{exp}. It is | |
4560 | this macro's responsibility to recognize insns that set the condition | |
4561 | code as a byproduct of other activity as well as those that explicitly | |
4562 | set @code{(cc0)}. | |
4563 | ||
4564 | This macro is not used on machines that do not use @code{cc0}. | |
4565 | ||
4566 | If there are insns that do not set the condition code but do alter | |
4567 | other machine registers, this macro must check to see whether they | |
4568 | invalidate the expressions that the condition code is recorded as | |
4569 | reflecting. For example, on the 68000, insns that store in address | |
4570 | registers do not set the condition code, which means that usually | |
4571 | @code{NOTICE_UPDATE_CC} can leave @code{cc_status} unaltered for such | |
4572 | insns. But suppose that the previous insn set the condition code | |
4573 | based on location @samp{a4@@(102)} and the current insn stores a new | |
4574 | value in @samp{a4}. Although the condition code is not changed by | |
4575 | this, it will no longer be true that it reflects the contents of | |
4576 | @samp{a4@@(102)}. Therefore, @code{NOTICE_UPDATE_CC} must alter | |
4577 | @code{cc_status} in this case to say that nothing is known about the | |
4578 | condition code value. | |
4579 | ||
4580 | The definition of @code{NOTICE_UPDATE_CC} must be prepared to deal | |
4581 | with the results of peephole optimization: insns whose patterns are | |
4582 | @code{parallel} RTXs containing various @code{reg}, @code{mem} or | |
4583 | constants which are just the operands. The RTL structure of these | |
4584 | insns is not sufficient to indicate what the insns actually do. What | |
4585 | @code{NOTICE_UPDATE_CC} should do when it sees one is just to run | |
4586 | @code{CC_STATUS_INIT}. | |
4587 | ||
4588 | A possible definition of @code{NOTICE_UPDATE_CC} is to call a function | |
4589 | that looks at an attribute (@pxref{Insn Attributes}) named, for example, | |
4590 | @samp{cc}. This avoids having detailed information about patterns in | |
4591 | two places, the @file{md} file and in @code{NOTICE_UPDATE_CC}. | |
4592 | @end defmac | |
4593 | ||
4594 | @node MODE_CC Condition Codes | |
4595 | @subsection Representation of condition codes using registers | |
4596 | @findex CCmode | |
4597 | @findex MODE_CC | |
4598 | ||
4599 | @defmac SELECT_CC_MODE (@var{op}, @var{x}, @var{y}) | |
4600 | On many machines, the condition code may be produced by other instructions | |
4601 | than compares, for example the branch can use directly the condition | |
4602 | code set by a subtract instruction. However, on some machines | |
4603 | when the condition code is set this way some bits (such as the overflow | |
4604 | bit) are not set in the same way as a test instruction, so that a different | |
4605 | branch instruction must be used for some conditional branches. When | |
4606 | this happens, use the machine mode of the condition code register to | |
4607 | record different formats of the condition code register. Modes can | |
4608 | also be used to record which compare instruction (e.g. a signed or an | |
4609 | unsigned comparison) produced the condition codes. | |
4610 | ||
4611 | If other modes than @code{CCmode} are required, add them to | |
4612 | @file{@var{machine}-modes.def} and define @code{SELECT_CC_MODE} to choose | |
4613 | a mode given an operand of a compare. This is needed because the modes | |
4614 | have to be chosen not only during RTL generation but also, for example, | |
4615 | by instruction combination. The result of @code{SELECT_CC_MODE} should | |
4616 | be consistent with the mode used in the patterns; for example to support | |
4617 | the case of the add on the SPARC discussed above, we have the pattern | |
4618 | ||
4619 | @smallexample | |
4620 | (define_insn "" | |
4621 | [(set (reg:CC_NOOV 0) | |
4622 | (compare:CC_NOOV | |
4623 | (plus:SI (match_operand:SI 0 "register_operand" "%r") | |
4624 | (match_operand:SI 1 "arith_operand" "rI")) | |
4625 | (const_int 0)))] | |
4626 | "" | |
4627 | "@dots{}") | |
4628 | @end smallexample | |
4629 | ||
4630 | @noindent | |
4631 | together with a @code{SELECT_CC_MODE} that returns @code{CC_NOOVmode} | |
4632 | for comparisons whose argument is a @code{plus}: | |
4633 | ||
4634 | @smallexample | |
4635 | #define SELECT_CC_MODE(OP,X,Y) \ | |
4636 | (GET_MODE_CLASS (GET_MODE (X)) == MODE_FLOAT \ | |
4637 | ? ((OP == EQ || OP == NE) ? CCFPmode : CCFPEmode) \ | |
4638 | : ((GET_CODE (X) == PLUS || GET_CODE (X) == MINUS \ | |
4639 | || GET_CODE (X) == NEG) \ | |
4640 | ? CC_NOOVmode : CCmode)) | |
4641 | @end smallexample | |
4642 | ||
4643 | Another reason to use modes is to retain information on which operands | |
4644 | were used by the comparison; see @code{REVERSIBLE_CC_MODE} later in | |
4645 | this section. | |
4646 | ||
4647 | You should define this macro if and only if you define extra CC modes | |
4648 | in @file{@var{machine}-modes.def}. | |
4649 | @end defmac | |
4650 | ||
d331d374 | 4651 | @hook TARGET_CANONICALIZE_COMPARISON |
38f8b050 JR |
4652 | |
4653 | @defmac REVERSIBLE_CC_MODE (@var{mode}) | |
4654 | A C expression whose value is one if it is always safe to reverse a | |
4655 | comparison whose mode is @var{mode}. If @code{SELECT_CC_MODE} | |
4656 | can ever return @var{mode} for a floating-point inequality comparison, | |
4657 | then @code{REVERSIBLE_CC_MODE (@var{mode})} must be zero. | |
4658 | ||
4659 | You need not define this macro if it would always returns zero or if the | |
4660 | floating-point format is anything other than @code{IEEE_FLOAT_FORMAT}. | |
4661 | For example, here is the definition used on the SPARC, where floating-point | |
4662 | inequality comparisons are always given @code{CCFPEmode}: | |
4663 | ||
4664 | @smallexample | |
4665 | #define REVERSIBLE_CC_MODE(MODE) ((MODE) != CCFPEmode) | |
4666 | @end smallexample | |
4667 | @end defmac | |
4668 | ||
4669 | @defmac REVERSE_CONDITION (@var{code}, @var{mode}) | |
4670 | A C expression whose value is reversed condition code of the @var{code} for | |
4671 | comparison done in CC_MODE @var{mode}. The macro is used only in case | |
4672 | @code{REVERSIBLE_CC_MODE (@var{mode})} is nonzero. Define this macro in case | |
4673 | machine has some non-standard way how to reverse certain conditionals. For | |
4674 | instance in case all floating point conditions are non-trapping, compiler may | |
4675 | freely convert unordered compares to ordered one. Then definition may look | |
4676 | like: | |
4677 | ||
4678 | @smallexample | |
4679 | #define REVERSE_CONDITION(CODE, MODE) \ | |
4680 | ((MODE) != CCFPmode ? reverse_condition (CODE) \ | |
4681 | : reverse_condition_maybe_unordered (CODE)) | |
4682 | @end smallexample | |
4683 | @end defmac | |
4684 | ||
4685 | @hook TARGET_FIXED_CONDITION_CODE_REGS | |
38f8b050 JR |
4686 | |
4687 | @hook TARGET_CC_MODES_COMPATIBLE | |
38f8b050 | 4688 | |
38f8b050 JR |
4689 | @node Costs |
4690 | @section Describing Relative Costs of Operations | |
4691 | @cindex costs of instructions | |
4692 | @cindex relative costs | |
4693 | @cindex speed of instructions | |
4694 | ||
4695 | These macros let you describe the relative speed of various operations | |
4696 | on the target machine. | |
4697 | ||
4698 | @defmac REGISTER_MOVE_COST (@var{mode}, @var{from}, @var{to}) | |
4699 | A C expression for the cost of moving data of mode @var{mode} from a | |
4700 | register in class @var{from} to one in class @var{to}. The classes are | |
4701 | expressed using the enumeration values such as @code{GENERAL_REGS}. A | |
4702 | value of 2 is the default; other values are interpreted relative to | |
4703 | that. | |
4704 | ||
4705 | It is not required that the cost always equal 2 when @var{from} is the | |
4706 | same as @var{to}; on some machines it is expensive to move between | |
4707 | registers if they are not general registers. | |
4708 | ||
4709 | If reload sees an insn consisting of a single @code{set} between two | |
4710 | hard registers, and if @code{REGISTER_MOVE_COST} applied to their | |
4711 | classes returns a value of 2, reload does not check to ensure that the | |
4712 | constraints of the insn are met. Setting a cost of other than 2 will | |
4713 | allow reload to verify that the constraints are met. You should do this | |
4714 | if the @samp{mov@var{m}} pattern's constraints do not allow such copying. | |
4715 | ||
4716 | These macros are obsolete, new ports should use the target hook | |
4717 | @code{TARGET_REGISTER_MOVE_COST} instead. | |
4718 | @end defmac | |
4719 | ||
4720 | @hook TARGET_REGISTER_MOVE_COST | |
38f8b050 JR |
4721 | |
4722 | @defmac MEMORY_MOVE_COST (@var{mode}, @var{class}, @var{in}) | |
4723 | A C expression for the cost of moving data of mode @var{mode} between a | |
4724 | register of class @var{class} and memory; @var{in} is zero if the value | |
4725 | is to be written to memory, nonzero if it is to be read in. This cost | |
4726 | is relative to those in @code{REGISTER_MOVE_COST}. If moving between | |
4727 | registers and memory is more expensive than between two registers, you | |
4728 | should define this macro to express the relative cost. | |
4729 | ||
4730 | If you do not define this macro, GCC uses a default cost of 4 plus | |
4731 | the cost of copying via a secondary reload register, if one is | |
4732 | needed. If your machine requires a secondary reload register to copy | |
4733 | between memory and a register of @var{class} but the reload mechanism is | |
4734 | more complex than copying via an intermediate, define this macro to | |
4735 | reflect the actual cost of the move. | |
4736 | ||
4737 | GCC defines the function @code{memory_move_secondary_cost} if | |
4738 | secondary reloads are needed. It computes the costs due to copying via | |
4739 | a secondary register. If your machine copies from memory using a | |
4740 | secondary register in the conventional way but the default base value of | |
4741 | 4 is not correct for your machine, define this macro to add some other | |
4742 | value to the result of that function. The arguments to that function | |
4743 | are the same as to this macro. | |
4744 | ||
4745 | These macros are obsolete, new ports should use the target hook | |
4746 | @code{TARGET_MEMORY_MOVE_COST} instead. | |
4747 | @end defmac | |
4748 | ||
911852ff | 4749 | @hook TARGET_MEMORY_MOVE_COST |
38f8b050 JR |
4750 | |
4751 | @defmac BRANCH_COST (@var{speed_p}, @var{predictable_p}) | |
525d13b0 MS |
4752 | A C expression for the cost of a branch instruction. A value of 1 is |
4753 | the default; other values are interpreted relative to that. Parameter | |
4754 | @var{speed_p} is true when the branch in question should be optimized | |
4755 | for speed. When it is false, @code{BRANCH_COST} should return a value | |
4756 | optimal for code size rather than performance. @var{predictable_p} is | |
4757 | true for well-predicted branches. On many architectures the | |
4758 | @code{BRANCH_COST} can be reduced then. | |
38f8b050 JR |
4759 | @end defmac |
4760 | ||
4761 | Here are additional macros which do not specify precise relative costs, | |
4762 | but only that certain actions are more expensive than GCC would | |
4763 | ordinarily expect. | |
4764 | ||
4765 | @defmac SLOW_BYTE_ACCESS | |
4766 | Define this macro as a C expression which is nonzero if accessing less | |
4767 | than a word of memory (i.e.@: a @code{char} or a @code{short}) is no | |
4768 | faster than accessing a word of memory, i.e., if such access | |
4769 | require more than one instruction or if there is no difference in cost | |
4770 | between byte and (aligned) word loads. | |
4771 | ||
4772 | When this macro is not defined, the compiler will access a field by | |
4773 | finding the smallest containing object; when it is defined, a fullword | |
4774 | load will be used if alignment permits. Unless bytes accesses are | |
4775 | faster than word accesses, using word accesses is preferable since it | |
4776 | may eliminate subsequent memory access if subsequent accesses occur to | |
4777 | other fields in the same word of the structure, but to different bytes. | |
4778 | @end defmac | |
4779 | ||
4780 | @defmac SLOW_UNALIGNED_ACCESS (@var{mode}, @var{alignment}) | |
4781 | Define this macro to be the value 1 if memory accesses described by the | |
4782 | @var{mode} and @var{alignment} parameters have a cost many times greater | |
4783 | than aligned accesses, for example if they are emulated in a trap | |
4784 | handler. | |
4785 | ||
4786 | When this macro is nonzero, the compiler will act as if | |
4787 | @code{STRICT_ALIGNMENT} were nonzero when generating code for block | |
4788 | moves. This can cause significantly more instructions to be produced. | |
4789 | Therefore, do not set this macro nonzero if unaligned accesses only add a | |
4790 | cycle or two to the time for a memory access. | |
4791 | ||
4792 | If the value of this macro is always zero, it need not be defined. If | |
4793 | this macro is defined, it should produce a nonzero value when | |
4794 | @code{STRICT_ALIGNMENT} is nonzero. | |
4795 | @end defmac | |
4796 | ||
4797 | @defmac MOVE_RATIO (@var{speed}) | |
4798 | The threshold of number of scalar memory-to-memory move insns, @emph{below} | |
4799 | which a sequence of insns should be generated instead of a | |
4800 | string move insn or a library call. Increasing the value will always | |
4801 | make code faster, but eventually incurs high cost in increased code size. | |
4802 | ||
4803 | Note that on machines where the corresponding move insn is a | |
4804 | @code{define_expand} that emits a sequence of insns, this macro counts | |
4805 | the number of such sequences. | |
4806 | ||
4807 | The parameter @var{speed} is true if the code is currently being | |
4808 | optimized for speed rather than size. | |
4809 | ||
4810 | If you don't define this, a reasonable default is used. | |
4811 | @end defmac | |
4812 | ||
4813 | @defmac MOVE_BY_PIECES_P (@var{size}, @var{alignment}) | |
4814 | A C expression used to determine whether @code{move_by_pieces} will be used to | |
4815 | copy a chunk of memory, or whether some other block move mechanism | |
4816 | will be used. Defaults to 1 if @code{move_by_pieces_ninsns} returns less | |
4817 | than @code{MOVE_RATIO}. | |
4818 | @end defmac | |
4819 | ||
4820 | @defmac MOVE_MAX_PIECES | |
4821 | A C expression used by @code{move_by_pieces} to determine the largest unit | |
4822 | a load or store used to copy memory is. Defaults to @code{MOVE_MAX}. | |
4823 | @end defmac | |
4824 | ||
4825 | @defmac CLEAR_RATIO (@var{speed}) | |
4826 | The threshold of number of scalar move insns, @emph{below} which a sequence | |
4827 | of insns should be generated to clear memory instead of a string clear insn | |
4828 | or a library call. Increasing the value will always make code faster, but | |
4829 | eventually incurs high cost in increased code size. | |
4830 | ||
4831 | The parameter @var{speed} is true if the code is currently being | |
4832 | optimized for speed rather than size. | |
4833 | ||
4834 | If you don't define this, a reasonable default is used. | |
4835 | @end defmac | |
4836 | ||
4837 | @defmac CLEAR_BY_PIECES_P (@var{size}, @var{alignment}) | |
4838 | A C expression used to determine whether @code{clear_by_pieces} will be used | |
4839 | to clear a chunk of memory, or whether some other block clear mechanism | |
4840 | will be used. Defaults to 1 if @code{move_by_pieces_ninsns} returns less | |
4841 | than @code{CLEAR_RATIO}. | |
4842 | @end defmac | |
4843 | ||
4844 | @defmac SET_RATIO (@var{speed}) | |
4845 | The threshold of number of scalar move insns, @emph{below} which a sequence | |
4846 | of insns should be generated to set memory to a constant value, instead of | |
ff2ce160 | 4847 | a block set insn or a library call. |
38f8b050 JR |
4848 | Increasing the value will always make code faster, but |
4849 | eventually incurs high cost in increased code size. | |
4850 | ||
4851 | The parameter @var{speed} is true if the code is currently being | |
4852 | optimized for speed rather than size. | |
4853 | ||
4854 | If you don't define this, it defaults to the value of @code{MOVE_RATIO}. | |
4855 | @end defmac | |
4856 | ||
4857 | @defmac SET_BY_PIECES_P (@var{size}, @var{alignment}) | |
4858 | A C expression used to determine whether @code{store_by_pieces} will be | |
ff2ce160 MS |
4859 | used to set a chunk of memory to a constant value, or whether some |
4860 | other mechanism will be used. Used by @code{__builtin_memset} when | |
38f8b050 JR |
4861 | storing values other than constant zero. |
4862 | Defaults to 1 if @code{move_by_pieces_ninsns} returns less | |
4863 | than @code{SET_RATIO}. | |
4864 | @end defmac | |
4865 | ||
4866 | @defmac STORE_BY_PIECES_P (@var{size}, @var{alignment}) | |
4867 | A C expression used to determine whether @code{store_by_pieces} will be | |
4868 | used to set a chunk of memory to a constant string value, or whether some | |
4869 | other mechanism will be used. Used by @code{__builtin_strcpy} when | |
4870 | called with a constant source string. | |
4871 | Defaults to 1 if @code{move_by_pieces_ninsns} returns less | |
4872 | than @code{MOVE_RATIO}. | |
4873 | @end defmac | |
4874 | ||
4875 | @defmac USE_LOAD_POST_INCREMENT (@var{mode}) | |
4876 | A C expression used to determine whether a load postincrement is a good | |
4877 | thing to use for a given mode. Defaults to the value of | |
4878 | @code{HAVE_POST_INCREMENT}. | |
4879 | @end defmac | |
4880 | ||
4881 | @defmac USE_LOAD_POST_DECREMENT (@var{mode}) | |
4882 | A C expression used to determine whether a load postdecrement is a good | |
4883 | thing to use for a given mode. Defaults to the value of | |
4884 | @code{HAVE_POST_DECREMENT}. | |
4885 | @end defmac | |
4886 | ||
4887 | @defmac USE_LOAD_PRE_INCREMENT (@var{mode}) | |
4888 | A C expression used to determine whether a load preincrement is a good | |
4889 | thing to use for a given mode. Defaults to the value of | |
4890 | @code{HAVE_PRE_INCREMENT}. | |
4891 | @end defmac | |
4892 | ||
4893 | @defmac USE_LOAD_PRE_DECREMENT (@var{mode}) | |
4894 | A C expression used to determine whether a load predecrement is a good | |
4895 | thing to use for a given mode. Defaults to the value of | |
4896 | @code{HAVE_PRE_DECREMENT}. | |
4897 | @end defmac | |
4898 | ||
4899 | @defmac USE_STORE_POST_INCREMENT (@var{mode}) | |
4900 | A C expression used to determine whether a store postincrement is a good | |
4901 | thing to use for a given mode. Defaults to the value of | |
4902 | @code{HAVE_POST_INCREMENT}. | |
4903 | @end defmac | |
4904 | ||
4905 | @defmac USE_STORE_POST_DECREMENT (@var{mode}) | |
4906 | A C expression used to determine whether a store postdecrement is a good | |
4907 | thing to use for a given mode. Defaults to the value of | |
4908 | @code{HAVE_POST_DECREMENT}. | |
4909 | @end defmac | |
4910 | ||
4911 | @defmac USE_STORE_PRE_INCREMENT (@var{mode}) | |
4912 | This macro is used to determine whether a store preincrement is a good | |
4913 | thing to use for a given mode. Defaults to the value of | |
4914 | @code{HAVE_PRE_INCREMENT}. | |
4915 | @end defmac | |
4916 | ||
4917 | @defmac USE_STORE_PRE_DECREMENT (@var{mode}) | |
4918 | This macro is used to determine whether a store predecrement is a good | |
4919 | thing to use for a given mode. Defaults to the value of | |
4920 | @code{HAVE_PRE_DECREMENT}. | |
4921 | @end defmac | |
4922 | ||
4923 | @defmac NO_FUNCTION_CSE | |
4924 | Define this macro if it is as good or better to call a constant | |
4925 | function address than to call an address kept in a register. | |
4926 | @end defmac | |
4927 | ||
a8d56c30 SB |
4928 | @defmac LOGICAL_OP_NON_SHORT_CIRCUIT |
4929 | Define this macro if a non-short-circuit operation produced by | |
4930 | @samp{fold_range_test ()} is optimal. This macro defaults to true if | |
4931 | @code{BRANCH_COST} is greater than or equal to the value 2. | |
4932 | @end defmac | |
4933 | ||
38f8b050 | 4934 | @hook TARGET_RTX_COSTS |
38f8b050 JR |
4935 | |
4936 | @hook TARGET_ADDRESS_COST | |
38f8b050 JR |
4937 | |
4938 | @node Scheduling | |
4939 | @section Adjusting the Instruction Scheduler | |
4940 | ||
4941 | The instruction scheduler may need a fair amount of machine-specific | |
4942 | adjustment in order to produce good code. GCC provides several target | |
4943 | hooks for this purpose. It is usually enough to define just a few of | |
4944 | them: try the first ones in this list first. | |
4945 | ||
4946 | @hook TARGET_SCHED_ISSUE_RATE | |
38f8b050 JR |
4947 | |
4948 | @hook TARGET_SCHED_VARIABLE_ISSUE | |
38f8b050 JR |
4949 | |
4950 | @hook TARGET_SCHED_ADJUST_COST | |
38f8b050 JR |
4951 | |
4952 | @hook TARGET_SCHED_ADJUST_PRIORITY | |
38f8b050 JR |
4953 | |
4954 | @hook TARGET_SCHED_REORDER | |
38f8b050 JR |
4955 | |
4956 | @hook TARGET_SCHED_REORDER2 | |
38f8b050 | 4957 | |
0dc41f28 WM |
4958 | @hook TARGET_SCHED_MACRO_FUSION_P |
4959 | ||
4960 | @hook TARGET_SCHED_MACRO_FUSION_PAIR_P | |
4961 | ||
38f8b050 | 4962 | @hook TARGET_SCHED_DEPENDENCIES_EVALUATION_HOOK |
38f8b050 JR |
4963 | |
4964 | @hook TARGET_SCHED_INIT | |
38f8b050 JR |
4965 | |
4966 | @hook TARGET_SCHED_FINISH | |
38f8b050 JR |
4967 | |
4968 | @hook TARGET_SCHED_INIT_GLOBAL | |
38f8b050 JR |
4969 | |
4970 | @hook TARGET_SCHED_FINISH_GLOBAL | |
38f8b050 JR |
4971 | |
4972 | @hook TARGET_SCHED_DFA_PRE_CYCLE_INSN | |
38f8b050 JR |
4973 | |
4974 | @hook TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN | |
38f8b050 JR |
4975 | |
4976 | @hook TARGET_SCHED_DFA_POST_CYCLE_INSN | |
38f8b050 JR |
4977 | |
4978 | @hook TARGET_SCHED_INIT_DFA_POST_CYCLE_INSN | |
38f8b050 JR |
4979 | |
4980 | @hook TARGET_SCHED_DFA_PRE_ADVANCE_CYCLE | |
38f8b050 JR |
4981 | |
4982 | @hook TARGET_SCHED_DFA_POST_ADVANCE_CYCLE | |
38f8b050 JR |
4983 | |
4984 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD | |
38f8b050 JR |
4985 | |
4986 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD | |
4987 | ||
894fd6f2 | 4988 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_BEGIN |
894fd6f2 MK |
4989 | |
4990 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_ISSUE | |
894fd6f2 MK |
4991 | |
4992 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_BACKTRACK | |
894fd6f2 MK |
4993 | |
4994 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_END | |
894fd6f2 MK |
4995 | |
4996 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_INIT | |
894fd6f2 MK |
4997 | |
4998 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_FINI | |
894fd6f2 | 4999 | |
c06bbdf7 | 5000 | @hook TARGET_SCHED_DFA_NEW_CYCLE |
38f8b050 JR |
5001 | |
5002 | @hook TARGET_SCHED_IS_COSTLY_DEPENDENCE | |
38f8b050 JR |
5003 | |
5004 | @hook TARGET_SCHED_H_I_D_EXTENDED | |
38f8b050 JR |
5005 | |
5006 | @hook TARGET_SCHED_ALLOC_SCHED_CONTEXT | |
38f8b050 JR |
5007 | |
5008 | @hook TARGET_SCHED_INIT_SCHED_CONTEXT | |
38f8b050 JR |
5009 | |
5010 | @hook TARGET_SCHED_SET_SCHED_CONTEXT | |
38f8b050 JR |
5011 | |
5012 | @hook TARGET_SCHED_CLEAR_SCHED_CONTEXT | |
38f8b050 JR |
5013 | |
5014 | @hook TARGET_SCHED_FREE_SCHED_CONTEXT | |
38f8b050 JR |
5015 | |
5016 | @hook TARGET_SCHED_SPECULATE_INSN | |
38f8b050 JR |
5017 | |
5018 | @hook TARGET_SCHED_NEEDS_BLOCK_P | |
38f8b050 JR |
5019 | |
5020 | @hook TARGET_SCHED_GEN_SPEC_CHECK | |
38f8b050 JR |
5021 | |
5022 | @hook TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD_SPEC | |
38f8b050 JR |
5023 | |
5024 | @hook TARGET_SCHED_SET_SCHED_FLAGS | |
38f8b050 JR |
5025 | |
5026 | @hook TARGET_SCHED_SMS_RES_MII | |
38f8b050 | 5027 | |
7942e47e | 5028 | @hook TARGET_SCHED_DISPATCH |
7942e47e RY |
5029 | |
5030 | @hook TARGET_SCHED_DISPATCH_DO | |
7942e47e | 5031 | |
b0bd15f7 BS |
5032 | @hook TARGET_SCHED_EXPOSED_PIPELINE |
5033 | ||
df7b0cc4 EI |
5034 | @hook TARGET_SCHED_REASSOCIATION_WIDTH |
5035 | ||
38f8b050 JR |
5036 | @node Sections |
5037 | @section Dividing the Output into Sections (Texts, Data, @dots{}) | |
5038 | @c the above section title is WAY too long. maybe cut the part between | |
5039 | @c the (...)? --mew 10feb93 | |
5040 | ||
5041 | An object file is divided into sections containing different types of | |
5042 | data. In the most common case, there are three sections: the @dfn{text | |
5043 | section}, which holds instructions and read-only data; the @dfn{data | |
5044 | section}, which holds initialized writable data; and the @dfn{bss | |
5045 | section}, which holds uninitialized data. Some systems have other kinds | |
5046 | of sections. | |
5047 | ||
5048 | @file{varasm.c} provides several well-known sections, such as | |
5049 | @code{text_section}, @code{data_section} and @code{bss_section}. | |
5050 | The normal way of controlling a @code{@var{foo}_section} variable | |
5051 | is to define the associated @code{@var{FOO}_SECTION_ASM_OP} macro, | |
5052 | as described below. The macros are only read once, when @file{varasm.c} | |
5053 | initializes itself, so their values must be run-time constants. | |
5054 | They may however depend on command-line flags. | |
5055 | ||
5056 | @emph{Note:} Some run-time files, such @file{crtstuff.c}, also make | |
5057 | use of the @code{@var{FOO}_SECTION_ASM_OP} macros, and expect them | |
5058 | to be string literals. | |
5059 | ||
5060 | Some assemblers require a different string to be written every time a | |
5061 | section is selected. If your assembler falls into this category, you | |
5062 | should define the @code{TARGET_ASM_INIT_SECTIONS} hook and use | |
5063 | @code{get_unnamed_section} to set up the sections. | |
5064 | ||
5065 | You must always create a @code{text_section}, either by defining | |
5066 | @code{TEXT_SECTION_ASM_OP} or by initializing @code{text_section} | |
5067 | in @code{TARGET_ASM_INIT_SECTIONS}. The same is true of | |
5068 | @code{data_section} and @code{DATA_SECTION_ASM_OP}. If you do not | |
5069 | create a distinct @code{readonly_data_section}, the default is to | |
5070 | reuse @code{text_section}. | |
5071 | ||
5072 | All the other @file{varasm.c} sections are optional, and are null | |
5073 | if the target does not provide them. | |
5074 | ||
5075 | @defmac TEXT_SECTION_ASM_OP | |
5076 | A C expression whose value is a string, including spacing, containing the | |
5077 | assembler operation that should precede instructions and read-only data. | |
5078 | Normally @code{"\t.text"} is right. | |
5079 | @end defmac | |
5080 | ||
5081 | @defmac HOT_TEXT_SECTION_NAME | |
5082 | If defined, a C string constant for the name of the section containing most | |
5083 | frequently executed functions of the program. If not defined, GCC will provide | |
5084 | a default definition if the target supports named sections. | |
5085 | @end defmac | |
5086 | ||
5087 | @defmac UNLIKELY_EXECUTED_TEXT_SECTION_NAME | |
5088 | If defined, a C string constant for the name of the section containing unlikely | |
5089 | executed functions in the program. | |
5090 | @end defmac | |
5091 | ||
5092 | @defmac DATA_SECTION_ASM_OP | |
5093 | A C expression whose value is a string, including spacing, containing the | |
5094 | assembler operation to identify the following data as writable initialized | |
5095 | data. Normally @code{"\t.data"} is right. | |
5096 | @end defmac | |
5097 | ||
5098 | @defmac SDATA_SECTION_ASM_OP | |
5099 | If defined, a C expression whose value is a string, including spacing, | |
5100 | containing the assembler operation to identify the following data as | |
5101 | initialized, writable small data. | |
5102 | @end defmac | |
5103 | ||
5104 | @defmac READONLY_DATA_SECTION_ASM_OP | |
5105 | A C expression whose value is a string, including spacing, containing the | |
5106 | assembler operation to identify the following data as read-only initialized | |
5107 | data. | |
5108 | @end defmac | |
5109 | ||
5110 | @defmac BSS_SECTION_ASM_OP | |
5111 | If defined, a C expression whose value is a string, including spacing, | |
5112 | containing the assembler operation to identify the following data as | |
07c5f94e AS |
5113 | uninitialized global data. If not defined, and |
5114 | @code{ASM_OUTPUT_ALIGNED_BSS} not defined, | |
38f8b050 JR |
5115 | uninitialized global data will be output in the data section if |
5116 | @option{-fno-common} is passed, otherwise @code{ASM_OUTPUT_COMMON} will be | |
5117 | used. | |
5118 | @end defmac | |
5119 | ||
5120 | @defmac SBSS_SECTION_ASM_OP | |
5121 | If defined, a C expression whose value is a string, including spacing, | |
5122 | containing the assembler operation to identify the following data as | |
5123 | uninitialized, writable small data. | |
5124 | @end defmac | |
5125 | ||
5126 | @defmac TLS_COMMON_ASM_OP | |
5127 | If defined, a C expression whose value is a string containing the | |
5128 | assembler operation to identify the following data as thread-local | |
5129 | common data. The default is @code{".tls_common"}. | |
5130 | @end defmac | |
5131 | ||
5132 | @defmac TLS_SECTION_ASM_FLAG | |
5133 | If defined, a C expression whose value is a character constant | |
5134 | containing the flag used to mark a section as a TLS section. The | |
5135 | default is @code{'T'}. | |
5136 | @end defmac | |
5137 | ||
5138 | @defmac INIT_SECTION_ASM_OP | |
5139 | If defined, a C expression whose value is a string, including spacing, | |
5140 | containing the assembler operation to identify the following data as | |
5141 | initialization code. If not defined, GCC will assume such a section does | |
5142 | not exist. This section has no corresponding @code{init_section} | |
5143 | variable; it is used entirely in runtime code. | |
5144 | @end defmac | |
5145 | ||
5146 | @defmac FINI_SECTION_ASM_OP | |
5147 | If defined, a C expression whose value is a string, including spacing, | |
5148 | containing the assembler operation to identify the following data as | |
5149 | finalization code. If not defined, GCC will assume such a section does | |
5150 | not exist. This section has no corresponding @code{fini_section} | |
5151 | variable; it is used entirely in runtime code. | |
5152 | @end defmac | |
5153 | ||
5154 | @defmac INIT_ARRAY_SECTION_ASM_OP | |
5155 | If defined, a C expression whose value is a string, including spacing, | |
5156 | containing the assembler operation to identify the following data as | |
5157 | part of the @code{.init_array} (or equivalent) section. If not | |
5158 | defined, GCC will assume such a section does not exist. Do not define | |
5159 | both this macro and @code{INIT_SECTION_ASM_OP}. | |
5160 | @end defmac | |
5161 | ||
5162 | @defmac FINI_ARRAY_SECTION_ASM_OP | |
5163 | If defined, a C expression whose value is a string, including spacing, | |
5164 | containing the assembler operation to identify the following data as | |
5165 | part of the @code{.fini_array} (or equivalent) section. If not | |
5166 | defined, GCC will assume such a section does not exist. Do not define | |
5167 | both this macro and @code{FINI_SECTION_ASM_OP}. | |
5168 | @end defmac | |
5169 | ||
5170 | @defmac CRT_CALL_STATIC_FUNCTION (@var{section_op}, @var{function}) | |
5171 | If defined, an ASM statement that switches to a different section | |
5172 | via @var{section_op}, calls @var{function}, and switches back to | |
5173 | the text section. This is used in @file{crtstuff.c} if | |
5174 | @code{INIT_SECTION_ASM_OP} or @code{FINI_SECTION_ASM_OP} to calls | |
5175 | to initialization and finalization functions from the init and fini | |
5176 | sections. By default, this macro uses a simple function call. Some | |
5177 | ports need hand-crafted assembly code to avoid dependencies on | |
5178 | registers initialized in the function prologue or to ensure that | |
5179 | constant pools don't end up too far way in the text section. | |
5180 | @end defmac | |
5181 | ||
5182 | @defmac TARGET_LIBGCC_SDATA_SECTION | |
5183 | If defined, a string which names the section into which small | |
5184 | variables defined in crtstuff and libgcc should go. This is useful | |
5185 | when the target has options for optimizing access to small data, and | |
5186 | you want the crtstuff and libgcc routines to be conservative in what | |
5187 | they expect of your application yet liberal in what your application | |
5188 | expects. For example, for targets with a @code{.sdata} section (like | |
5189 | MIPS), you could compile crtstuff with @code{-G 0} so that it doesn't | |
5190 | require small data support from your application, but use this macro | |
5191 | to put small data into @code{.sdata} so that your application can | |
5192 | access these variables whether it uses small data or not. | |
5193 | @end defmac | |
5194 | ||
5195 | @defmac FORCE_CODE_SECTION_ALIGN | |
5196 | If defined, an ASM statement that aligns a code section to some | |
5197 | arbitrary boundary. This is used to force all fragments of the | |
5198 | @code{.init} and @code{.fini} sections to have to same alignment | |
5199 | and thus prevent the linker from having to add any padding. | |
5200 | @end defmac | |
5201 | ||
5202 | @defmac JUMP_TABLES_IN_TEXT_SECTION | |
5203 | Define this macro to be an expression with a nonzero value if jump | |
5204 | tables (for @code{tablejump} insns) should be output in the text | |
5205 | section, along with the assembler instructions. Otherwise, the | |
5206 | readonly data section is used. | |
5207 | ||
5208 | This macro is irrelevant if there is no separate readonly data section. | |
5209 | @end defmac | |
5210 | ||
5211 | @hook TARGET_ASM_INIT_SECTIONS | |
38f8b050 JR |
5212 | |
5213 | @hook TARGET_ASM_RELOC_RW_MASK | |
38f8b050 JR |
5214 | |
5215 | @hook TARGET_ASM_SELECT_SECTION | |
38f8b050 JR |
5216 | |
5217 | @defmac USE_SELECT_SECTION_FOR_FUNCTIONS | |
5218 | Define this macro if you wish TARGET_ASM_SELECT_SECTION to be called | |
5219 | for @code{FUNCTION_DECL}s as well as for variables and constants. | |
5220 | ||
5221 | In the case of a @code{FUNCTION_DECL}, @var{reloc} will be zero if the | |
5222 | function has been determined to be likely to be called, and nonzero if | |
5223 | it is unlikely to be called. | |
5224 | @end defmac | |
5225 | ||
5226 | @hook TARGET_ASM_UNIQUE_SECTION | |
38f8b050 JR |
5227 | |
5228 | @hook TARGET_ASM_FUNCTION_RODATA_SECTION | |
38f8b050 | 5229 | |
727a65e6 BS |
5230 | @hook TARGET_ASM_MERGEABLE_RODATA_PREFIX |
5231 | ||
50b0b78a IS |
5232 | @hook TARGET_ASM_TM_CLONE_TABLE_SECTION |
5233 | ||
38f8b050 | 5234 | @hook TARGET_ASM_SELECT_RTX_SECTION |
38f8b050 JR |
5235 | |
5236 | @hook TARGET_MANGLE_DECL_ASSEMBLER_NAME | |
38f8b050 JR |
5237 | |
5238 | @hook TARGET_ENCODE_SECTION_INFO | |
38f8b050 JR |
5239 | |
5240 | @hook TARGET_STRIP_NAME_ENCODING | |
38f8b050 JR |
5241 | |
5242 | @hook TARGET_IN_SMALL_DATA_P | |
38f8b050 JR |
5243 | |
5244 | @hook TARGET_HAVE_SRODATA_SECTION | |
38f8b050 | 5245 | |
3c5273a9 KT |
5246 | @hook TARGET_PROFILE_BEFORE_PROLOGUE |
5247 | ||
38f8b050 | 5248 | @hook TARGET_BINDS_LOCAL_P |
38f8b050 JR |
5249 | |
5250 | @hook TARGET_HAVE_TLS | |
38f8b050 JR |
5251 | |
5252 | ||
5253 | @node PIC | |
5254 | @section Position Independent Code | |
5255 | @cindex position independent code | |
5256 | @cindex PIC | |
5257 | ||
5258 | This section describes macros that help implement generation of position | |
5259 | independent code. Simply defining these macros is not enough to | |
5260 | generate valid PIC; you must also add support to the hook | |
5261 | @code{TARGET_LEGITIMATE_ADDRESS_P} and to the macro | |
5262 | @code{PRINT_OPERAND_ADDRESS}, as well as @code{LEGITIMIZE_ADDRESS}. You | |
5263 | must modify the definition of @samp{movsi} to do something appropriate | |
5264 | when the source operand contains a symbolic address. You may also | |
5265 | need to alter the handling of switch statements so that they use | |
5266 | relative addresses. | |
ff2ce160 | 5267 | @c i rearranged the order of the macros above to try to force one of |
38f8b050 JR |
5268 | @c them to the next line, to eliminate an overfull hbox. --mew 10feb93 |
5269 | ||
5270 | @defmac PIC_OFFSET_TABLE_REGNUM | |
5271 | The register number of the register used to address a table of static | |
5272 | data addresses in memory. In some cases this register is defined by a | |
5273 | processor's ``application binary interface'' (ABI)@. When this macro | |
5274 | is defined, RTL is generated for this register once, as with the stack | |
5275 | pointer and frame pointer registers. If this macro is not defined, it | |
5276 | is up to the machine-dependent files to allocate such a register (if | |
5277 | necessary). Note that this register must be fixed when in use (e.g.@: | |
5278 | when @code{flag_pic} is true). | |
5279 | @end defmac | |
5280 | ||
5281 | @defmac PIC_OFFSET_TABLE_REG_CALL_CLOBBERED | |
f8fe0a4a JM |
5282 | A C expression that is nonzero if the register defined by |
5283 | @code{PIC_OFFSET_TABLE_REGNUM} is clobbered by calls. If not defined, | |
5284 | the default is zero. Do not define | |
38f8b050 JR |
5285 | this macro if @code{PIC_OFFSET_TABLE_REGNUM} is not defined. |
5286 | @end defmac | |
5287 | ||
5288 | @defmac LEGITIMATE_PIC_OPERAND_P (@var{x}) | |
5289 | A C expression that is nonzero if @var{x} is a legitimate immediate | |
5290 | operand on the target machine when generating position independent code. | |
5291 | You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not | |
5292 | check this. You can also assume @var{flag_pic} is true, so you need not | |
5293 | check it either. You need not define this macro if all constants | |
5294 | (including @code{SYMBOL_REF}) can be immediate operands when generating | |
5295 | position independent code. | |
5296 | @end defmac | |
5297 | ||
5298 | @node Assembler Format | |
5299 | @section Defining the Output Assembler Language | |
5300 | ||
5301 | This section describes macros whose principal purpose is to describe how | |
5302 | to write instructions in assembler language---rather than what the | |
5303 | instructions do. | |
5304 | ||
5305 | @menu | |
5306 | * File Framework:: Structural information for the assembler file. | |
5307 | * Data Output:: Output of constants (numbers, strings, addresses). | |
5308 | * Uninitialized Data:: Output of uninitialized variables. | |
5309 | * Label Output:: Output and generation of labels. | |
5310 | * Initialization:: General principles of initialization | |
5311 | and termination routines. | |
5312 | * Macros for Initialization:: | |
5313 | Specific macros that control the handling of | |
5314 | initialization and termination routines. | |
5315 | * Instruction Output:: Output of actual instructions. | |
5316 | * Dispatch Tables:: Output of jump tables. | |
5317 | * Exception Region Output:: Output of exception region code. | |
5318 | * Alignment Output:: Pseudo ops for alignment and skipping data. | |
5319 | @end menu | |
5320 | ||
5321 | @node File Framework | |
5322 | @subsection The Overall Framework of an Assembler File | |
5323 | @cindex assembler format | |
5324 | @cindex output of assembler code | |
5325 | ||
5326 | @c prevent bad page break with this line | |
5327 | This describes the overall framework of an assembly file. | |
5328 | ||
5329 | @findex default_file_start | |
5330 | @hook TARGET_ASM_FILE_START | |
38f8b050 JR |
5331 | |
5332 | @hook TARGET_ASM_FILE_START_APP_OFF | |
38f8b050 JR |
5333 | |
5334 | @hook TARGET_ASM_FILE_START_FILE_DIRECTIVE | |
38f8b050 JR |
5335 | |
5336 | @hook TARGET_ASM_FILE_END | |
38f8b050 JR |
5337 | |
5338 | @deftypefun void file_end_indicate_exec_stack () | |
5339 | Some systems use a common convention, the @samp{.note.GNU-stack} | |
5340 | special section, to indicate whether or not an object file relies on | |
5341 | the stack being executable. If your system uses this convention, you | |
5342 | should define @code{TARGET_ASM_FILE_END} to this function. If you | |
5343 | need to do other things in that hook, have your hook function call | |
5344 | this function. | |
5345 | @end deftypefun | |
5346 | ||
5347 | @hook TARGET_ASM_LTO_START | |
38f8b050 JR |
5348 | |
5349 | @hook TARGET_ASM_LTO_END | |
38f8b050 JR |
5350 | |
5351 | @hook TARGET_ASM_CODE_END | |
38f8b050 JR |
5352 | |
5353 | @defmac ASM_COMMENT_START | |
5354 | A C string constant describing how to begin a comment in the target | |
5355 | assembler language. The compiler assumes that the comment will end at | |
5356 | the end of the line. | |
5357 | @end defmac | |
5358 | ||
5359 | @defmac ASM_APP_ON | |
5360 | A C string constant for text to be output before each @code{asm} | |
5361 | statement or group of consecutive ones. Normally this is | |
5362 | @code{"#APP"}, which is a comment that has no effect on most | |
5363 | assemblers but tells the GNU assembler that it must check the lines | |
5364 | that follow for all valid assembler constructs. | |
5365 | @end defmac | |
5366 | ||
5367 | @defmac ASM_APP_OFF | |
5368 | A C string constant for text to be output after each @code{asm} | |
5369 | statement or group of consecutive ones. Normally this is | |
5370 | @code{"#NO_APP"}, which tells the GNU assembler to resume making the | |
5371 | time-saving assumptions that are valid for ordinary compiler output. | |
5372 | @end defmac | |
5373 | ||
5374 | @defmac ASM_OUTPUT_SOURCE_FILENAME (@var{stream}, @var{name}) | |
5375 | A C statement to output COFF information or DWARF debugging information | |
5376 | which indicates that filename @var{name} is the current source file to | |
5377 | the stdio stream @var{stream}. | |
5378 | ||
5379 | This macro need not be defined if the standard form of output | |
5380 | for the file format in use is appropriate. | |
5381 | @end defmac | |
5382 | ||
b5f5d41d AS |
5383 | @hook TARGET_ASM_OUTPUT_SOURCE_FILENAME |
5384 | ||
a8781821 SB |
5385 | @hook TARGET_ASM_OUTPUT_IDENT |
5386 | ||
38f8b050 JR |
5387 | @defmac OUTPUT_QUOTED_STRING (@var{stream}, @var{string}) |
5388 | A C statement to output the string @var{string} to the stdio stream | |
5389 | @var{stream}. If you do not call the function @code{output_quoted_string} | |
5390 | in your config files, GCC will only call it to output filenames to | |
5391 | the assembler source. So you can use it to canonicalize the format | |
5392 | of the filename using this macro. | |
5393 | @end defmac | |
5394 | ||
38f8b050 | 5395 | @hook TARGET_ASM_NAMED_SECTION |
38f8b050 | 5396 | |
f16d3f39 | 5397 | @hook TARGET_ASM_FUNCTION_SECTION |
f16d3f39 | 5398 | |
14d11d40 IS |
5399 | @hook TARGET_ASM_FUNCTION_SWITCHED_TEXT_SECTIONS |
5400 | ||
38f8b050 JR |
5401 | @hook TARGET_HAVE_NAMED_SECTIONS |
5402 | This flag is true if the target supports @code{TARGET_ASM_NAMED_SECTION}. | |
d5fabb58 | 5403 | It must not be modified by command-line option processing. |
38f8b050 JR |
5404 | @end deftypevr |
5405 | ||
5406 | @anchor{TARGET_HAVE_SWITCHABLE_BSS_SECTIONS} | |
5407 | @hook TARGET_HAVE_SWITCHABLE_BSS_SECTIONS | |
38f8b050 JR |
5408 | |
5409 | @hook TARGET_SECTION_TYPE_FLAGS | |
38f8b050 JR |
5410 | |
5411 | @hook TARGET_ASM_RECORD_GCC_SWITCHES | |
38f8b050 JR |
5412 | |
5413 | @hook TARGET_ASM_RECORD_GCC_SWITCHES_SECTION | |
38f8b050 JR |
5414 | |
5415 | @need 2000 | |
5416 | @node Data Output | |
5417 | @subsection Output of Data | |
5418 | ||
5419 | ||
5420 | @hook TARGET_ASM_BYTE_OP | |
38f8b050 JR |
5421 | |
5422 | @hook TARGET_ASM_INTEGER | |
38f8b050 | 5423 | |
6cbd8875 | 5424 | @hook TARGET_ASM_OUTPUT_ADDR_CONST_EXTRA |
6cbd8875 | 5425 | |
38f8b050 JR |
5426 | @defmac ASM_OUTPUT_ASCII (@var{stream}, @var{ptr}, @var{len}) |
5427 | A C statement to output to the stdio stream @var{stream} an assembler | |
5428 | instruction to assemble a string constant containing the @var{len} | |
5429 | bytes at @var{ptr}. @var{ptr} will be a C expression of type | |
5430 | @code{char *} and @var{len} a C expression of type @code{int}. | |
5431 | ||
5432 | If the assembler has a @code{.ascii} pseudo-op as found in the | |
5433 | Berkeley Unix assembler, do not define the macro | |
5434 | @code{ASM_OUTPUT_ASCII}. | |
5435 | @end defmac | |
5436 | ||
5437 | @defmac ASM_OUTPUT_FDESC (@var{stream}, @var{decl}, @var{n}) | |
5438 | A C statement to output word @var{n} of a function descriptor for | |
5439 | @var{decl}. This must be defined if @code{TARGET_VTABLE_USES_DESCRIPTORS} | |
5440 | is defined, and is otherwise unused. | |
5441 | @end defmac | |
5442 | ||
5443 | @defmac CONSTANT_POOL_BEFORE_FUNCTION | |
5444 | You may define this macro as a C expression. You should define the | |
5445 | expression to have a nonzero value if GCC should output the constant | |
5446 | pool for a function before the code for the function, or a zero value if | |
5447 | GCC should output the constant pool after the function. If you do | |
5448 | not define this macro, the usual case, GCC will output the constant | |
5449 | pool before the function. | |
5450 | @end defmac | |
5451 | ||
5452 | @defmac ASM_OUTPUT_POOL_PROLOGUE (@var{file}, @var{funname}, @var{fundecl}, @var{size}) | |
5453 | A C statement to output assembler commands to define the start of the | |
5454 | constant pool for a function. @var{funname} is a string giving | |
5455 | the name of the function. Should the return type of the function | |
5456 | be required, it can be obtained via @var{fundecl}. @var{size} | |
5457 | is the size, in bytes, of the constant pool that will be written | |
5458 | immediately after this call. | |
5459 | ||
5460 | If no constant-pool prefix is required, the usual case, this macro need | |
5461 | not be defined. | |
5462 | @end defmac | |
5463 | ||
5464 | @defmac ASM_OUTPUT_SPECIAL_POOL_ENTRY (@var{file}, @var{x}, @var{mode}, @var{align}, @var{labelno}, @var{jumpto}) | |
5465 | A C statement (with or without semicolon) to output a constant in the | |
5466 | constant pool, if it needs special treatment. (This macro need not do | |
5467 | anything for RTL expressions that can be output normally.) | |
5468 | ||
5469 | The argument @var{file} is the standard I/O stream to output the | |
5470 | assembler code on. @var{x} is the RTL expression for the constant to | |
5471 | output, and @var{mode} is the machine mode (in case @var{x} is a | |
5472 | @samp{const_int}). @var{align} is the required alignment for the value | |
5473 | @var{x}; you should output an assembler directive to force this much | |
5474 | alignment. | |
5475 | ||
5476 | The argument @var{labelno} is a number to use in an internal label for | |
5477 | the address of this pool entry. The definition of this macro is | |
5478 | responsible for outputting the label definition at the proper place. | |
5479 | Here is how to do this: | |
5480 | ||
5481 | @smallexample | |
5482 | @code{(*targetm.asm_out.internal_label)} (@var{file}, "LC", @var{labelno}); | |
5483 | @end smallexample | |
5484 | ||
5485 | When you output a pool entry specially, you should end with a | |
5486 | @code{goto} to the label @var{jumpto}. This will prevent the same pool | |
5487 | entry from being output a second time in the usual manner. | |
5488 | ||
5489 | You need not define this macro if it would do nothing. | |
5490 | @end defmac | |
5491 | ||
5492 | @defmac ASM_OUTPUT_POOL_EPILOGUE (@var{file} @var{funname} @var{fundecl} @var{size}) | |
5493 | A C statement to output assembler commands to at the end of the constant | |
5494 | pool for a function. @var{funname} is a string giving the name of the | |
5495 | function. Should the return type of the function be required, you can | |
5496 | obtain it via @var{fundecl}. @var{size} is the size, in bytes, of the | |
5497 | constant pool that GCC wrote immediately before this call. | |
5498 | ||
5499 | If no constant-pool epilogue is required, the usual case, you need not | |
5500 | define this macro. | |
5501 | @end defmac | |
5502 | ||
5503 | @defmac IS_ASM_LOGICAL_LINE_SEPARATOR (@var{C}, @var{STR}) | |
5504 | Define this macro as a C expression which is nonzero if @var{C} is | |
5505 | used as a logical line separator by the assembler. @var{STR} points | |
5506 | to the position in the string where @var{C} was found; this can be used if | |
5507 | a line separator uses multiple characters. | |
5508 | ||
5509 | If you do not define this macro, the default is that only | |
5510 | the character @samp{;} is treated as a logical line separator. | |
5511 | @end defmac | |
5512 | ||
5513 | @hook TARGET_ASM_OPEN_PAREN | |
38f8b050 JR |
5514 | |
5515 | These macros are provided by @file{real.h} for writing the definitions | |
5516 | of @code{ASM_OUTPUT_DOUBLE} and the like: | |
5517 | ||
5518 | @defmac REAL_VALUE_TO_TARGET_SINGLE (@var{x}, @var{l}) | |
5519 | @defmacx REAL_VALUE_TO_TARGET_DOUBLE (@var{x}, @var{l}) | |
5520 | @defmacx REAL_VALUE_TO_TARGET_LONG_DOUBLE (@var{x}, @var{l}) | |
5521 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL32 (@var{x}, @var{l}) | |
5522 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL64 (@var{x}, @var{l}) | |
5523 | @defmacx REAL_VALUE_TO_TARGET_DECIMAL128 (@var{x}, @var{l}) | |
5524 | These translate @var{x}, of type @code{REAL_VALUE_TYPE}, to the | |
5525 | target's floating point representation, and store its bit pattern in | |
5526 | the variable @var{l}. For @code{REAL_VALUE_TO_TARGET_SINGLE} and | |
5527 | @code{REAL_VALUE_TO_TARGET_DECIMAL32}, this variable should be a | |
5528 | simple @code{long int}. For the others, it should be an array of | |
5529 | @code{long int}. The number of elements in this array is determined | |
5530 | by the size of the desired target floating point data type: 32 bits of | |
5531 | it go in each @code{long int} array element. Each array element holds | |
5532 | 32 bits of the result, even if @code{long int} is wider than 32 bits | |
5533 | on the host machine. | |
5534 | ||
5535 | The array element values are designed so that you can print them out | |
5536 | using @code{fprintf} in the order they should appear in the target | |
5537 | machine's memory. | |
5538 | @end defmac | |
5539 | ||
5540 | @node Uninitialized Data | |
5541 | @subsection Output of Uninitialized Variables | |
5542 | ||
5543 | Each of the macros in this section is used to do the whole job of | |
5544 | outputting a single uninitialized variable. | |
5545 | ||
5546 | @defmac ASM_OUTPUT_COMMON (@var{stream}, @var{name}, @var{size}, @var{rounded}) | |
5547 | A C statement (sans semicolon) to output to the stdio stream | |
5548 | @var{stream} the assembler definition of a common-label named | |
5549 | @var{name} whose size is @var{size} bytes. The variable @var{rounded} | |
5550 | is the size rounded up to whatever alignment the caller wants. It is | |
5551 | possible that @var{size} may be zero, for instance if a struct with no | |
5552 | other member than a zero-length array is defined. In this case, the | |
5553 | backend must output a symbol definition that allocates at least one | |
5554 | byte, both so that the address of the resulting object does not compare | |
5555 | equal to any other, and because some object formats cannot even express | |
5556 | the concept of a zero-sized common symbol, as that is how they represent | |
5557 | an ordinary undefined external. | |
5558 | ||
5559 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
5560 | output the name itself; before and after that, output the additional | |
5561 | assembler syntax for defining the name, and a newline. | |
5562 | ||
5563 | This macro controls how the assembler definitions of uninitialized | |
5564 | common global variables are output. | |
5565 | @end defmac | |
5566 | ||
5567 | @defmac ASM_OUTPUT_ALIGNED_COMMON (@var{stream}, @var{name}, @var{size}, @var{alignment}) | |
5568 | Like @code{ASM_OUTPUT_COMMON} except takes the required alignment as a | |
5569 | separate, explicit argument. If you define this macro, it is used in | |
5570 | place of @code{ASM_OUTPUT_COMMON}, and gives you more flexibility in | |
5571 | handling the required alignment of the variable. The alignment is specified | |
5572 | as the number of bits. | |
5573 | @end defmac | |
5574 | ||
5575 | @defmac ASM_OUTPUT_ALIGNED_DECL_COMMON (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) | |
5576 | Like @code{ASM_OUTPUT_ALIGNED_COMMON} except that @var{decl} of the | |
5577 | variable to be output, if there is one, or @code{NULL_TREE} if there | |
5578 | is no corresponding variable. If you define this macro, GCC will use it | |
5579 | in place of both @code{ASM_OUTPUT_COMMON} and | |
5580 | @code{ASM_OUTPUT_ALIGNED_COMMON}. Define this macro when you need to see | |
5581 | the variable's decl in order to chose what to output. | |
5582 | @end defmac | |
5583 | ||
07c5f94e | 5584 | @defmac ASM_OUTPUT_ALIGNED_BSS (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) |
38f8b050 JR |
5585 | A C statement (sans semicolon) to output to the stdio stream |
5586 | @var{stream} the assembler definition of uninitialized global @var{decl} named | |
07c5f94e AS |
5587 | @var{name} whose size is @var{size} bytes. The variable @var{alignment} |
5588 | is the alignment specified as the number of bits. | |
38f8b050 | 5589 | |
07c5f94e AS |
5590 | Try to use function @code{asm_output_aligned_bss} defined in file |
5591 | @file{varasm.c} when defining this macro. If unable, use the expression | |
38f8b050 JR |
5592 | @code{assemble_name (@var{stream}, @var{name})} to output the name itself; |
5593 | before and after that, output the additional assembler syntax for defining | |
5594 | the name, and a newline. | |
5595 | ||
07c5f94e | 5596 | There are two ways of handling global BSS@. One is to define this macro. |
38f8b050 JR |
5597 | The other is to have @code{TARGET_ASM_SELECT_SECTION} return a |
5598 | switchable BSS section (@pxref{TARGET_HAVE_SWITCHABLE_BSS_SECTIONS}). | |
5599 | You do not need to do both. | |
5600 | ||
5601 | Some languages do not have @code{common} data, and require a | |
5602 | non-common form of global BSS in order to handle uninitialized globals | |
5603 | efficiently. C++ is one example of this. However, if the target does | |
5604 | not support global BSS, the front end may choose to make globals | |
5605 | common in order to save space in the object file. | |
5606 | @end defmac | |
5607 | ||
38f8b050 JR |
5608 | @defmac ASM_OUTPUT_LOCAL (@var{stream}, @var{name}, @var{size}, @var{rounded}) |
5609 | A C statement (sans semicolon) to output to the stdio stream | |
5610 | @var{stream} the assembler definition of a local-common-label named | |
5611 | @var{name} whose size is @var{size} bytes. The variable @var{rounded} | |
5612 | is the size rounded up to whatever alignment the caller wants. | |
5613 | ||
5614 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
5615 | output the name itself; before and after that, output the additional | |
5616 | assembler syntax for defining the name, and a newline. | |
5617 | ||
5618 | This macro controls how the assembler definitions of uninitialized | |
5619 | static variables are output. | |
5620 | @end defmac | |
5621 | ||
5622 | @defmac ASM_OUTPUT_ALIGNED_LOCAL (@var{stream}, @var{name}, @var{size}, @var{alignment}) | |
5623 | Like @code{ASM_OUTPUT_LOCAL} except takes the required alignment as a | |
5624 | separate, explicit argument. If you define this macro, it is used in | |
5625 | place of @code{ASM_OUTPUT_LOCAL}, and gives you more flexibility in | |
5626 | handling the required alignment of the variable. The alignment is specified | |
5627 | as the number of bits. | |
5628 | @end defmac | |
5629 | ||
5630 | @defmac ASM_OUTPUT_ALIGNED_DECL_LOCAL (@var{stream}, @var{decl}, @var{name}, @var{size}, @var{alignment}) | |
5631 | Like @code{ASM_OUTPUT_ALIGNED_DECL} except that @var{decl} of the | |
5632 | variable to be output, if there is one, or @code{NULL_TREE} if there | |
5633 | is no corresponding variable. If you define this macro, GCC will use it | |
5634 | in place of both @code{ASM_OUTPUT_DECL} and | |
5635 | @code{ASM_OUTPUT_ALIGNED_DECL}. Define this macro when you need to see | |
5636 | the variable's decl in order to chose what to output. | |
5637 | @end defmac | |
5638 | ||
5639 | @node Label Output | |
5640 | @subsection Output and Generation of Labels | |
5641 | ||
5642 | @c prevent bad page break with this line | |
5643 | This is about outputting labels. | |
5644 | ||
5645 | @findex assemble_name | |
5646 | @defmac ASM_OUTPUT_LABEL (@var{stream}, @var{name}) | |
5647 | A C statement (sans semicolon) to output to the stdio stream | |
5648 | @var{stream} the assembler definition of a label named @var{name}. | |
5649 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
5650 | output the name itself; before and after that, output the additional | |
5651 | assembler syntax for defining the name, and a newline. A default | |
5652 | definition of this macro is provided which is correct for most systems. | |
5653 | @end defmac | |
5654 | ||
135a687e KT |
5655 | @defmac ASM_OUTPUT_FUNCTION_LABEL (@var{stream}, @var{name}, @var{decl}) |
5656 | A C statement (sans semicolon) to output to the stdio stream | |
5657 | @var{stream} the assembler definition of a label named @var{name} of | |
5658 | a function. | |
5659 | Use the expression @code{assemble_name (@var{stream}, @var{name})} to | |
5660 | output the name itself; before and after that, output the additional | |
5661 | assembler syntax for defining the name, and a newline. A default | |
5662 | definition of this macro is provided which is correct for most systems. | |
5663 | ||
5664 | If this macro is not defined, then the function name is defined in the | |
5665 | usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}). | |
5666 | @end defmac | |
5667 | ||
38f8b050 JR |
5668 | @findex assemble_name_raw |
5669 | @defmac ASM_OUTPUT_INTERNAL_LABEL (@var{stream}, @var{name}) | |
5670 | Identical to @code{ASM_OUTPUT_LABEL}, except that @var{name} is known | |
5671 | to refer to a compiler-generated label. The default definition uses | |
5672 | @code{assemble_name_raw}, which is like @code{assemble_name} except | |
5673 | that it is more efficient. | |
5674 | @end defmac | |
5675 | ||
5676 | @defmac SIZE_ASM_OP | |
5677 | A C string containing the appropriate assembler directive to specify the | |
5678 | size of a symbol, without any arguments. On systems that use ELF, the | |
5679 | default (in @file{config/elfos.h}) is @samp{"\t.size\t"}; on other | |
5680 | systems, the default is not to define this macro. | |
5681 | ||
5682 | Define this macro only if it is correct to use the default definitions | |
5683 | of @code{ASM_OUTPUT_SIZE_DIRECTIVE} and @code{ASM_OUTPUT_MEASURED_SIZE} | |
5684 | for your system. If you need your own custom definitions of those | |
5685 | macros, or if you do not need explicit symbol sizes at all, do not | |
5686 | define this macro. | |
5687 | @end defmac | |
5688 | ||
5689 | @defmac ASM_OUTPUT_SIZE_DIRECTIVE (@var{stream}, @var{name}, @var{size}) | |
5690 | A C statement (sans semicolon) to output to the stdio stream | |
5691 | @var{stream} a directive telling the assembler that the size of the | |
5692 | symbol @var{name} is @var{size}. @var{size} is a @code{HOST_WIDE_INT}. | |
5693 | If you define @code{SIZE_ASM_OP}, a default definition of this macro is | |
5694 | provided. | |
5695 | @end defmac | |
5696 | ||
5697 | @defmac ASM_OUTPUT_MEASURED_SIZE (@var{stream}, @var{name}) | |
5698 | A C statement (sans semicolon) to output to the stdio stream | |
5699 | @var{stream} a directive telling the assembler to calculate the size of | |
5700 | the symbol @var{name} by subtracting its address from the current | |
5701 | address. | |
5702 | ||
5703 | If you define @code{SIZE_ASM_OP}, a default definition of this macro is | |
5704 | provided. The default assumes that the assembler recognizes a special | |
5705 | @samp{.} symbol as referring to the current address, and can calculate | |
5706 | the difference between this and another symbol. If your assembler does | |
5707 | not recognize @samp{.} or cannot do calculations with it, you will need | |
5708 | to redefine @code{ASM_OUTPUT_MEASURED_SIZE} to use some other technique. | |
5709 | @end defmac | |
5710 | ||
e537ef59 GP |
5711 | @defmac NO_DOLLAR_IN_LABEL |
5712 | Define this macro if the assembler does not accept the character | |
5713 | @samp{$} in label names. By default constructors and destructors in | |
5714 | G++ have @samp{$} in the identifiers. If this macro is defined, | |
5715 | @samp{.} is used instead. | |
5716 | @end defmac | |
5717 | ||
5718 | @defmac NO_DOT_IN_LABEL | |
5719 | Define this macro if the assembler does not accept the character | |
5720 | @samp{.} in label names. By default constructors and destructors in G++ | |
5721 | have names that use @samp{.}. If this macro is defined, these names | |
5722 | are rewritten to avoid @samp{.}. | |
5723 | @end defmac | |
5724 | ||
38f8b050 JR |
5725 | @defmac TYPE_ASM_OP |
5726 | A C string containing the appropriate assembler directive to specify the | |
5727 | type of a symbol, without any arguments. On systems that use ELF, the | |
5728 | default (in @file{config/elfos.h}) is @samp{"\t.type\t"}; on other | |
5729 | systems, the default is not to define this macro. | |
5730 | ||
5731 | Define this macro only if it is correct to use the default definition of | |
5732 | @code{ASM_OUTPUT_TYPE_DIRECTIVE} for your system. If you need your own | |
5733 | custom definition of this macro, or if you do not need explicit symbol | |
5734 | types at all, do not define this macro. | |
5735 | @end defmac | |
5736 | ||
5737 | @defmac TYPE_OPERAND_FMT | |
5738 | A C string which specifies (using @code{printf} syntax) the format of | |
5739 | the second operand to @code{TYPE_ASM_OP}. On systems that use ELF, the | |
5740 | default (in @file{config/elfos.h}) is @samp{"@@%s"}; on other systems, | |
5741 | the default is not to define this macro. | |
5742 | ||
5743 | Define this macro only if it is correct to use the default definition of | |
5744 | @code{ASM_OUTPUT_TYPE_DIRECTIVE} for your system. If you need your own | |
5745 | custom definition of this macro, or if you do not need explicit symbol | |
5746 | types at all, do not define this macro. | |
5747 | @end defmac | |
5748 | ||
5749 | @defmac ASM_OUTPUT_TYPE_DIRECTIVE (@var{stream}, @var{type}) | |
5750 | A C statement (sans semicolon) to output to the stdio stream | |
5751 | @var{stream} a directive telling the assembler that the type of the | |
5752 | symbol @var{name} is @var{type}. @var{type} is a C string; currently, | |
5753 | that string is always either @samp{"function"} or @samp{"object"}, but | |
5754 | you should not count on this. | |
5755 | ||
5756 | If you define @code{TYPE_ASM_OP} and @code{TYPE_OPERAND_FMT}, a default | |
5757 | definition of this macro is provided. | |
5758 | @end defmac | |
5759 | ||
5760 | @defmac ASM_DECLARE_FUNCTION_NAME (@var{stream}, @var{name}, @var{decl}) | |
5761 | A C statement (sans semicolon) to output to the stdio stream | |
5762 | @var{stream} any text necessary for declaring the name @var{name} of a | |
5763 | function which is being defined. This macro is responsible for | |
5764 | outputting the label definition (perhaps using | |
135a687e | 5765 | @code{ASM_OUTPUT_FUNCTION_LABEL}). The argument @var{decl} is the |
38f8b050 JR |
5766 | @code{FUNCTION_DECL} tree node representing the function. |
5767 | ||
5768 | If this macro is not defined, then the function name is defined in the | |
135a687e | 5769 | usual manner as a label (by means of @code{ASM_OUTPUT_FUNCTION_LABEL}). |
38f8b050 JR |
5770 | |
5771 | You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in the definition | |
5772 | of this macro. | |
5773 | @end defmac | |
5774 | ||
5775 | @defmac ASM_DECLARE_FUNCTION_SIZE (@var{stream}, @var{name}, @var{decl}) | |
5776 | A C statement (sans semicolon) to output to the stdio stream | |
5777 | @var{stream} any text necessary for declaring the size of a function | |
5778 | which is being defined. The argument @var{name} is the name of the | |
5779 | function. The argument @var{decl} is the @code{FUNCTION_DECL} tree node | |
5780 | representing the function. | |
5781 | ||
5782 | If this macro is not defined, then the function size is not defined. | |
5783 | ||
5784 | You may wish to use @code{ASM_OUTPUT_MEASURED_SIZE} in the definition | |
5785 | of this macro. | |
5786 | @end defmac | |
5787 | ||
5788 | @defmac ASM_DECLARE_OBJECT_NAME (@var{stream}, @var{name}, @var{decl}) | |
5789 | A C statement (sans semicolon) to output to the stdio stream | |
5790 | @var{stream} any text necessary for declaring the name @var{name} of an | |
5791 | initialized variable which is being defined. This macro must output the | |
5792 | label definition (perhaps using @code{ASM_OUTPUT_LABEL}). The argument | |
5793 | @var{decl} is the @code{VAR_DECL} tree node representing the variable. | |
5794 | ||
5795 | If this macro is not defined, then the variable name is defined in the | |
5796 | usual manner as a label (by means of @code{ASM_OUTPUT_LABEL}). | |
5797 | ||
5798 | You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} and/or | |
5799 | @code{ASM_OUTPUT_SIZE_DIRECTIVE} in the definition of this macro. | |
5800 | @end defmac | |
5801 | ||
ad78130c | 5802 | @hook TARGET_ASM_DECLARE_CONSTANT_NAME |
38f8b050 JR |
5803 | |
5804 | @defmac ASM_DECLARE_REGISTER_GLOBAL (@var{stream}, @var{decl}, @var{regno}, @var{name}) | |
5805 | A C statement (sans semicolon) to output to the stdio stream | |
5806 | @var{stream} any text necessary for claiming a register @var{regno} | |
5807 | for a global variable @var{decl} with name @var{name}. | |
5808 | ||
5809 | If you don't define this macro, that is equivalent to defining it to do | |
5810 | nothing. | |
5811 | @end defmac | |
5812 | ||
5813 | @defmac ASM_FINISH_DECLARE_OBJECT (@var{stream}, @var{decl}, @var{toplevel}, @var{atend}) | |
5814 | A C statement (sans semicolon) to finish up declaring a variable name | |
5815 | once the compiler has processed its initializer fully and thus has had a | |
5816 | chance to determine the size of an array when controlled by an | |
5817 | initializer. This is used on systems where it's necessary to declare | |
5818 | something about the size of the object. | |
5819 | ||
5820 | If you don't define this macro, that is equivalent to defining it to do | |
5821 | nothing. | |
5822 | ||
5823 | You may wish to use @code{ASM_OUTPUT_SIZE_DIRECTIVE} and/or | |
5824 | @code{ASM_OUTPUT_MEASURED_SIZE} in the definition of this macro. | |
5825 | @end defmac | |
5826 | ||
5827 | @hook TARGET_ASM_GLOBALIZE_LABEL | |
38f8b050 JR |
5828 | |
5829 | @hook TARGET_ASM_GLOBALIZE_DECL_NAME | |
38f8b050 JR |
5830 | |
5831 | @defmac ASM_WEAKEN_LABEL (@var{stream}, @var{name}) | |
5832 | A C statement (sans semicolon) to output to the stdio stream | |
5833 | @var{stream} some commands that will make the label @var{name} weak; | |
5834 | that is, available for reference from other files but only used if | |
5835 | no other definition is available. Use the expression | |
5836 | @code{assemble_name (@var{stream}, @var{name})} to output the name | |
5837 | itself; before and after that, output the additional assembler syntax | |
5838 | for making that name weak, and a newline. | |
5839 | ||
5840 | If you don't define this macro or @code{ASM_WEAKEN_DECL}, GCC will not | |
5841 | support weak symbols and you should not define the @code{SUPPORTS_WEAK} | |
5842 | macro. | |
5843 | @end defmac | |
5844 | ||
5845 | @defmac ASM_WEAKEN_DECL (@var{stream}, @var{decl}, @var{name}, @var{value}) | |
5846 | Combines (and replaces) the function of @code{ASM_WEAKEN_LABEL} and | |
5847 | @code{ASM_OUTPUT_WEAK_ALIAS}, allowing access to the associated function | |
5848 | or variable decl. If @var{value} is not @code{NULL}, this C statement | |
5849 | should output to the stdio stream @var{stream} assembler code which | |
5850 | defines (equates) the weak symbol @var{name} to have the value | |
5851 | @var{value}. If @var{value} is @code{NULL}, it should output commands | |
5852 | to make @var{name} weak. | |
5853 | @end defmac | |
5854 | ||
5855 | @defmac ASM_OUTPUT_WEAKREF (@var{stream}, @var{decl}, @var{name}, @var{value}) | |
5856 | Outputs a directive that enables @var{name} to be used to refer to | |
5857 | symbol @var{value} with weak-symbol semantics. @code{decl} is the | |
5858 | declaration of @code{name}. | |
5859 | @end defmac | |
5860 | ||
5861 | @defmac SUPPORTS_WEAK | |
74b90fe2 JDA |
5862 | A preprocessor constant expression which evaluates to true if the target |
5863 | supports weak symbols. | |
38f8b050 JR |
5864 | |
5865 | If you don't define this macro, @file{defaults.h} provides a default | |
5866 | definition. If either @code{ASM_WEAKEN_LABEL} or @code{ASM_WEAKEN_DECL} | |
74b90fe2 JDA |
5867 | is defined, the default definition is @samp{1}; otherwise, it is @samp{0}. |
5868 | @end defmac | |
5869 | ||
5870 | @defmac TARGET_SUPPORTS_WEAK | |
5871 | A C expression which evaluates to true if the target supports weak symbols. | |
5872 | ||
5873 | If you don't define this macro, @file{defaults.h} provides a default | |
5874 | definition. The default definition is @samp{(SUPPORTS_WEAK)}. Define | |
5875 | this macro if you want to control weak symbol support with a compiler | |
5876 | flag such as @option{-melf}. | |
38f8b050 JR |
5877 | @end defmac |
5878 | ||
5879 | @defmac MAKE_DECL_ONE_ONLY (@var{decl}) | |
5880 | A C statement (sans semicolon) to mark @var{decl} to be emitted as a | |
5881 | public symbol such that extra copies in multiple translation units will | |
5882 | be discarded by the linker. Define this macro if your object file | |
5883 | format provides support for this concept, such as the @samp{COMDAT} | |
5884 | section flags in the Microsoft Windows PE/COFF format, and this support | |
5885 | requires changes to @var{decl}, such as putting it in a separate section. | |
5886 | @end defmac | |
5887 | ||
5888 | @defmac SUPPORTS_ONE_ONLY | |
5889 | A C expression which evaluates to true if the target supports one-only | |
5890 | semantics. | |
5891 | ||
5892 | If you don't define this macro, @file{varasm.c} provides a default | |
5893 | definition. If @code{MAKE_DECL_ONE_ONLY} is defined, the default | |
5894 | definition is @samp{1}; otherwise, it is @samp{0}. Define this macro if | |
5895 | you want to control one-only symbol support with a compiler flag, or if | |
5896 | setting the @code{DECL_ONE_ONLY} flag is enough to mark a declaration to | |
5897 | be emitted as one-only. | |
5898 | @end defmac | |
5899 | ||
5900 | @hook TARGET_ASM_ASSEMBLE_VISIBILITY | |
38f8b050 JR |
5901 | |
5902 | @defmac TARGET_WEAK_NOT_IN_ARCHIVE_TOC | |
5903 | A C expression that evaluates to true if the target's linker expects | |
5904 | that weak symbols do not appear in a static archive's table of contents. | |
5905 | The default is @code{0}. | |
5906 | ||
5907 | Leaving weak symbols out of an archive's table of contents means that, | |
5908 | if a symbol will only have a definition in one translation unit and | |
5909 | will have undefined references from other translation units, that | |
5910 | symbol should not be weak. Defining this macro to be nonzero will | |
5911 | thus have the effect that certain symbols that would normally be weak | |
5912 | (explicit template instantiations, and vtables for polymorphic classes | |
5913 | with noninline key methods) will instead be nonweak. | |
5914 | ||
5915 | The C++ ABI requires this macro to be zero. Define this macro for | |
5916 | targets where full C++ ABI compliance is impossible and where linker | |
5917 | restrictions require weak symbols to be left out of a static archive's | |
5918 | table of contents. | |
5919 | @end defmac | |
5920 | ||
5921 | @defmac ASM_OUTPUT_EXTERNAL (@var{stream}, @var{decl}, @var{name}) | |
5922 | A C statement (sans semicolon) to output to the stdio stream | |
5923 | @var{stream} any text necessary for declaring the name of an external | |
5924 | symbol named @var{name} which is referenced in this compilation but | |
5925 | not defined. The value of @var{decl} is the tree node for the | |
5926 | declaration. | |
5927 | ||
5928 | This macro need not be defined if it does not need to output anything. | |
5929 | The GNU assembler and most Unix assemblers don't require anything. | |
5930 | @end defmac | |
5931 | ||
5932 | @hook TARGET_ASM_EXTERNAL_LIBCALL | |
38f8b050 JR |
5933 | |
5934 | @hook TARGET_ASM_MARK_DECL_PRESERVED | |
38f8b050 JR |
5935 | |
5936 | @defmac ASM_OUTPUT_LABELREF (@var{stream}, @var{name}) | |
5937 | A C statement (sans semicolon) to output to the stdio stream | |
5938 | @var{stream} a reference in assembler syntax to a label named | |
5939 | @var{name}. This should add @samp{_} to the front of the name, if that | |
5940 | is customary on your operating system, as it is in most Berkeley Unix | |
5941 | systems. This macro is used in @code{assemble_name}. | |
5942 | @end defmac | |
5943 | ||
77754180 DK |
5944 | @hook TARGET_MANGLE_ASSEMBLER_NAME |
5945 | ||
38f8b050 JR |
5946 | @defmac ASM_OUTPUT_SYMBOL_REF (@var{stream}, @var{sym}) |
5947 | A C statement (sans semicolon) to output a reference to | |
5948 | @code{SYMBOL_REF} @var{sym}. If not defined, @code{assemble_name} | |
5949 | will be used to output the name of the symbol. This macro may be used | |
5950 | to modify the way a symbol is referenced depending on information | |
5951 | encoded by @code{TARGET_ENCODE_SECTION_INFO}. | |
5952 | @end defmac | |
5953 | ||
5954 | @defmac ASM_OUTPUT_LABEL_REF (@var{stream}, @var{buf}) | |
5955 | A C statement (sans semicolon) to output a reference to @var{buf}, the | |
5956 | result of @code{ASM_GENERATE_INTERNAL_LABEL}. If not defined, | |
5957 | @code{assemble_name} will be used to output the name of the symbol. | |
5958 | This macro is not used by @code{output_asm_label}, or the @code{%l} | |
5959 | specifier that calls it; the intention is that this macro should be set | |
5960 | when it is necessary to output a label differently when its address is | |
5961 | being taken. | |
5962 | @end defmac | |
5963 | ||
5964 | @hook TARGET_ASM_INTERNAL_LABEL | |
38f8b050 JR |
5965 | |
5966 | @defmac ASM_OUTPUT_DEBUG_LABEL (@var{stream}, @var{prefix}, @var{num}) | |
5967 | A C statement to output to the stdio stream @var{stream} a debug info | |
5968 | label whose name is made from the string @var{prefix} and the number | |
5969 | @var{num}. This is useful for VLIW targets, where debug info labels | |
5970 | may need to be treated differently than branch target labels. On some | |
5971 | systems, branch target labels must be at the beginning of instruction | |
5972 | bundles, but debug info labels can occur in the middle of instruction | |
5973 | bundles. | |
5974 | ||
5975 | If this macro is not defined, then @code{(*targetm.asm_out.internal_label)} will be | |
5976 | used. | |
5977 | @end defmac | |
5978 | ||
5979 | @defmac ASM_GENERATE_INTERNAL_LABEL (@var{string}, @var{prefix}, @var{num}) | |
5980 | A C statement to store into the string @var{string} a label whose name | |
5981 | is made from the string @var{prefix} and the number @var{num}. | |
5982 | ||
5983 | This string, when output subsequently by @code{assemble_name}, should | |
5984 | produce the output that @code{(*targetm.asm_out.internal_label)} would produce | |
5985 | with the same @var{prefix} and @var{num}. | |
5986 | ||
5987 | If the string begins with @samp{*}, then @code{assemble_name} will | |
5988 | output the rest of the string unchanged. It is often convenient for | |
5989 | @code{ASM_GENERATE_INTERNAL_LABEL} to use @samp{*} in this way. If the | |
5990 | string doesn't start with @samp{*}, then @code{ASM_OUTPUT_LABELREF} gets | |
5991 | to output the string, and may change it. (Of course, | |
5992 | @code{ASM_OUTPUT_LABELREF} is also part of your machine description, so | |
5993 | you should know what it does on your machine.) | |
5994 | @end defmac | |
5995 | ||
5996 | @defmac ASM_FORMAT_PRIVATE_NAME (@var{outvar}, @var{name}, @var{number}) | |
5997 | A C expression to assign to @var{outvar} (which is a variable of type | |
5998 | @code{char *}) a newly allocated string made from the string | |
5999 | @var{name} and the number @var{number}, with some suitable punctuation | |
6000 | added. Use @code{alloca} to get space for the string. | |
6001 | ||
6002 | The string will be used as an argument to @code{ASM_OUTPUT_LABELREF} to | |
6003 | produce an assembler label for an internal static variable whose name is | |
6004 | @var{name}. Therefore, the string must be such as to result in valid | |
6005 | assembler code. The argument @var{number} is different each time this | |
6006 | macro is executed; it prevents conflicts between similarly-named | |
6007 | internal static variables in different scopes. | |
6008 | ||
6009 | Ideally this string should not be a valid C identifier, to prevent any | |
6010 | conflict with the user's own symbols. Most assemblers allow periods | |
6011 | or percent signs in assembler symbols; putting at least one of these | |
6012 | between the name and the number will suffice. | |
6013 | ||
6014 | If this macro is not defined, a default definition will be provided | |
6015 | which is correct for most systems. | |
6016 | @end defmac | |
6017 | ||
6018 | @defmac ASM_OUTPUT_DEF (@var{stream}, @var{name}, @var{value}) | |
6019 | A C statement to output to the stdio stream @var{stream} assembler code | |
6020 | which defines (equates) the symbol @var{name} to have the value @var{value}. | |
6021 | ||
6022 | @findex SET_ASM_OP | |
6023 | If @code{SET_ASM_OP} is defined, a default definition is provided which is | |
6024 | correct for most systems. | |
6025 | @end defmac | |
6026 | ||
6027 | @defmac ASM_OUTPUT_DEF_FROM_DECLS (@var{stream}, @var{decl_of_name}, @var{decl_of_value}) | |
6028 | A C statement to output to the stdio stream @var{stream} assembler code | |
6029 | which defines (equates) the symbol whose tree node is @var{decl_of_name} | |
6030 | to have the value of the tree node @var{decl_of_value}. This macro will | |
6031 | be used in preference to @samp{ASM_OUTPUT_DEF} if it is defined and if | |
6032 | the tree nodes are available. | |
6033 | ||
6034 | @findex SET_ASM_OP | |
6035 | If @code{SET_ASM_OP} is defined, a default definition is provided which is | |
6036 | correct for most systems. | |
6037 | @end defmac | |
6038 | ||
6039 | @defmac TARGET_DEFERRED_OUTPUT_DEFS (@var{decl_of_name}, @var{decl_of_value}) | |
6040 | A C statement that evaluates to true if the assembler code which defines | |
6041 | (equates) the symbol whose tree node is @var{decl_of_name} to have the value | |
6042 | of the tree node @var{decl_of_value} should be emitted near the end of the | |
6043 | current compilation unit. The default is to not defer output of defines. | |
6044 | This macro affects defines output by @samp{ASM_OUTPUT_DEF} and | |
6045 | @samp{ASM_OUTPUT_DEF_FROM_DECLS}. | |
6046 | @end defmac | |
6047 | ||
6048 | @defmac ASM_OUTPUT_WEAK_ALIAS (@var{stream}, @var{name}, @var{value}) | |
6049 | A C statement to output to the stdio stream @var{stream} assembler code | |
6050 | which defines (equates) the weak symbol @var{name} to have the value | |
6051 | @var{value}. If @var{value} is @code{NULL}, it defines @var{name} as | |
6052 | an undefined weak symbol. | |
6053 | ||
6054 | Define this macro if the target only supports weak aliases; define | |
6055 | @code{ASM_OUTPUT_DEF} instead if possible. | |
6056 | @end defmac | |
6057 | ||
6058 | @defmac OBJC_GEN_METHOD_LABEL (@var{buf}, @var{is_inst}, @var{class_name}, @var{cat_name}, @var{sel_name}) | |
6059 | Define this macro to override the default assembler names used for | |
6060 | Objective-C methods. | |
6061 | ||
6062 | The default name is a unique method number followed by the name of the | |
6063 | class (e.g.@: @samp{_1_Foo}). For methods in categories, the name of | |
6064 | the category is also included in the assembler name (e.g.@: | |
6065 | @samp{_1_Foo_Bar}). | |
6066 | ||
6067 | These names are safe on most systems, but make debugging difficult since | |
6068 | the method's selector is not present in the name. Therefore, particular | |
6069 | systems define other ways of computing names. | |
6070 | ||
6071 | @var{buf} is an expression of type @code{char *} which gives you a | |
6072 | buffer in which to store the name; its length is as long as | |
6073 | @var{class_name}, @var{cat_name} and @var{sel_name} put together, plus | |
6074 | 50 characters extra. | |
6075 | ||
6076 | The argument @var{is_inst} specifies whether the method is an instance | |
6077 | method or a class method; @var{class_name} is the name of the class; | |
6078 | @var{cat_name} is the name of the category (or @code{NULL} if the method is not | |
6079 | in a category); and @var{sel_name} is the name of the selector. | |
6080 | ||
6081 | On systems where the assembler can handle quoted names, you can use this | |
6082 | macro to provide more human-readable names. | |
6083 | @end defmac | |
6084 | ||
38f8b050 JR |
6085 | @node Initialization |
6086 | @subsection How Initialization Functions Are Handled | |
6087 | @cindex initialization routines | |
6088 | @cindex termination routines | |
6089 | @cindex constructors, output of | |
6090 | @cindex destructors, output of | |
6091 | ||
6092 | The compiled code for certain languages includes @dfn{constructors} | |
6093 | (also called @dfn{initialization routines})---functions to initialize | |
6094 | data in the program when the program is started. These functions need | |
6095 | to be called before the program is ``started''---that is to say, before | |
6096 | @code{main} is called. | |
6097 | ||
6098 | Compiling some languages generates @dfn{destructors} (also called | |
6099 | @dfn{termination routines}) that should be called when the program | |
6100 | terminates. | |
6101 | ||
6102 | To make the initialization and termination functions work, the compiler | |
6103 | must output something in the assembler code to cause those functions to | |
6104 | be called at the appropriate time. When you port the compiler to a new | |
6105 | system, you need to specify how to do this. | |
6106 | ||
6107 | There are two major ways that GCC currently supports the execution of | |
6108 | initialization and termination functions. Each way has two variants. | |
6109 | Much of the structure is common to all four variations. | |
6110 | ||
6111 | @findex __CTOR_LIST__ | |
6112 | @findex __DTOR_LIST__ | |
6113 | The linker must build two lists of these functions---a list of | |
6114 | initialization functions, called @code{__CTOR_LIST__}, and a list of | |
6115 | termination functions, called @code{__DTOR_LIST__}. | |
6116 | ||
6117 | Each list always begins with an ignored function pointer (which may hold | |
6118 | 0, @minus{}1, or a count of the function pointers after it, depending on | |
6119 | the environment). This is followed by a series of zero or more function | |
6120 | pointers to constructors (or destructors), followed by a function | |
6121 | pointer containing zero. | |
6122 | ||
6123 | Depending on the operating system and its executable file format, either | |
6124 | @file{crtstuff.c} or @file{libgcc2.c} traverses these lists at startup | |
6125 | time and exit time. Constructors are called in reverse order of the | |
6126 | list; destructors in forward order. | |
6127 | ||
6128 | The best way to handle static constructors works only for object file | |
6129 | formats which provide arbitrarily-named sections. A section is set | |
6130 | aside for a list of constructors, and another for a list of destructors. | |
6131 | Traditionally these are called @samp{.ctors} and @samp{.dtors}. Each | |
6132 | object file that defines an initialization function also puts a word in | |
6133 | the constructor section to point to that function. The linker | |
6134 | accumulates all these words into one contiguous @samp{.ctors} section. | |
6135 | Termination functions are handled similarly. | |
6136 | ||
6137 | This method will be chosen as the default by @file{target-def.h} if | |
6138 | @code{TARGET_ASM_NAMED_SECTION} is defined. A target that does not | |
6139 | support arbitrary sections, but does support special designated | |
6140 | constructor and destructor sections may define @code{CTORS_SECTION_ASM_OP} | |
6141 | and @code{DTORS_SECTION_ASM_OP} to achieve the same effect. | |
6142 | ||
6143 | When arbitrary sections are available, there are two variants, depending | |
6144 | upon how the code in @file{crtstuff.c} is called. On systems that | |
6145 | support a @dfn{.init} section which is executed at program startup, | |
6146 | parts of @file{crtstuff.c} are compiled into that section. The | |
6147 | program is linked by the @command{gcc} driver like this: | |
6148 | ||
6149 | @smallexample | |
6150 | ld -o @var{output_file} crti.o crtbegin.o @dots{} -lgcc crtend.o crtn.o | |
6151 | @end smallexample | |
6152 | ||
6153 | The prologue of a function (@code{__init}) appears in the @code{.init} | |
6154 | section of @file{crti.o}; the epilogue appears in @file{crtn.o}. Likewise | |
6155 | for the function @code{__fini} in the @dfn{.fini} section. Normally these | |
6156 | files are provided by the operating system or by the GNU C library, but | |
6157 | are provided by GCC for a few targets. | |
6158 | ||
6159 | The objects @file{crtbegin.o} and @file{crtend.o} are (for most targets) | |
6160 | compiled from @file{crtstuff.c}. They contain, among other things, code | |
6161 | fragments within the @code{.init} and @code{.fini} sections that branch | |
6162 | to routines in the @code{.text} section. The linker will pull all parts | |
6163 | of a section together, which results in a complete @code{__init} function | |
6164 | that invokes the routines we need at startup. | |
6165 | ||
6166 | To use this variant, you must define the @code{INIT_SECTION_ASM_OP} | |
6167 | macro properly. | |
6168 | ||
6169 | If no init section is available, when GCC compiles any function called | |
6170 | @code{main} (or more accurately, any function designated as a program | |
6171 | entry point by the language front end calling @code{expand_main_function}), | |
6172 | it inserts a procedure call to @code{__main} as the first executable code | |
6173 | after the function prologue. The @code{__main} function is defined | |
6174 | in @file{libgcc2.c} and runs the global constructors. | |
6175 | ||
6176 | In file formats that don't support arbitrary sections, there are again | |
6177 | two variants. In the simplest variant, the GNU linker (GNU @code{ld}) | |
6178 | and an `a.out' format must be used. In this case, | |
6179 | @code{TARGET_ASM_CONSTRUCTOR} is defined to produce a @code{.stabs} | |
6180 | entry of type @samp{N_SETT}, referencing the name @code{__CTOR_LIST__}, | |
6181 | and with the address of the void function containing the initialization | |
6182 | code as its value. The GNU linker recognizes this as a request to add | |
6183 | the value to a @dfn{set}; the values are accumulated, and are eventually | |
6184 | placed in the executable as a vector in the format described above, with | |
6185 | a leading (ignored) count and a trailing zero element. | |
6186 | @code{TARGET_ASM_DESTRUCTOR} is handled similarly. Since no init | |
6187 | section is available, the absence of @code{INIT_SECTION_ASM_OP} causes | |
6188 | the compilation of @code{main} to call @code{__main} as above, starting | |
6189 | the initialization process. | |
6190 | ||
6191 | The last variant uses neither arbitrary sections nor the GNU linker. | |
6192 | This is preferable when you want to do dynamic linking and when using | |
6193 | file formats which the GNU linker does not support, such as `ECOFF'@. In | |
6194 | this case, @code{TARGET_HAVE_CTORS_DTORS} is false, initialization and | |
6195 | termination functions are recognized simply by their names. This requires | |
6196 | an extra program in the linkage step, called @command{collect2}. This program | |
6197 | pretends to be the linker, for use with GCC; it does its job by running | |
6198 | the ordinary linker, but also arranges to include the vectors of | |
6199 | initialization and termination functions. These functions are called | |
6200 | via @code{__main} as described above. In order to use this method, | |
6201 | @code{use_collect2} must be defined in the target in @file{config.gcc}. | |
6202 | ||
6203 | @ifinfo | |
6204 | The following section describes the specific macros that control and | |
6205 | customize the handling of initialization and termination functions. | |
6206 | @end ifinfo | |
6207 | ||
6208 | @node Macros for Initialization | |
6209 | @subsection Macros Controlling Initialization Routines | |
6210 | ||
6211 | Here are the macros that control how the compiler handles initialization | |
6212 | and termination functions: | |
6213 | ||
6214 | @defmac INIT_SECTION_ASM_OP | |
6215 | If defined, a C string constant, including spacing, for the assembler | |
6216 | operation to identify the following data as initialization code. If not | |
6217 | defined, GCC will assume such a section does not exist. When you are | |
6218 | using special sections for initialization and termination functions, this | |
6219 | macro also controls how @file{crtstuff.c} and @file{libgcc2.c} arrange to | |
6220 | run the initialization functions. | |
6221 | @end defmac | |
6222 | ||
6223 | @defmac HAS_INIT_SECTION | |
6224 | If defined, @code{main} will not call @code{__main} as described above. | |
6225 | This macro should be defined for systems that control start-up code | |
6226 | on a symbol-by-symbol basis, such as OSF/1, and should not | |
6227 | be defined explicitly for systems that support @code{INIT_SECTION_ASM_OP}. | |
6228 | @end defmac | |
6229 | ||
6230 | @defmac LD_INIT_SWITCH | |
6231 | If defined, a C string constant for a switch that tells the linker that | |
6232 | the following symbol is an initialization routine. | |
6233 | @end defmac | |
6234 | ||
6235 | @defmac LD_FINI_SWITCH | |
6236 | If defined, a C string constant for a switch that tells the linker that | |
6237 | the following symbol is a finalization routine. | |
6238 | @end defmac | |
6239 | ||
6240 | @defmac COLLECT_SHARED_INIT_FUNC (@var{stream}, @var{func}) | |
6241 | If defined, a C statement that will write a function that can be | |
6242 | automatically called when a shared library is loaded. The function | |
6243 | should call @var{func}, which takes no arguments. If not defined, and | |
6244 | the object format requires an explicit initialization function, then a | |
6245 | function called @code{_GLOBAL__DI} will be generated. | |
6246 | ||
6247 | This function and the following one are used by collect2 when linking a | |
6248 | shared library that needs constructors or destructors, or has DWARF2 | |
6249 | exception tables embedded in the code. | |
6250 | @end defmac | |
6251 | ||
6252 | @defmac COLLECT_SHARED_FINI_FUNC (@var{stream}, @var{func}) | |
6253 | If defined, a C statement that will write a function that can be | |
6254 | automatically called when a shared library is unloaded. The function | |
6255 | should call @var{func}, which takes no arguments. If not defined, and | |
6256 | the object format requires an explicit finalization function, then a | |
6257 | function called @code{_GLOBAL__DD} will be generated. | |
6258 | @end defmac | |
6259 | ||
6260 | @defmac INVOKE__main | |
6261 | If defined, @code{main} will call @code{__main} despite the presence of | |
6262 | @code{INIT_SECTION_ASM_OP}. This macro should be defined for systems | |
6263 | where the init section is not actually run automatically, but is still | |
6264 | useful for collecting the lists of constructors and destructors. | |
6265 | @end defmac | |
6266 | ||
6267 | @defmac SUPPORTS_INIT_PRIORITY | |
6268 | If nonzero, the C++ @code{init_priority} attribute is supported and the | |
6269 | compiler should emit instructions to control the order of initialization | |
6270 | of objects. If zero, the compiler will issue an error message upon | |
6271 | encountering an @code{init_priority} attribute. | |
6272 | @end defmac | |
6273 | ||
6274 | @hook TARGET_HAVE_CTORS_DTORS | |
38f8b050 JR |
6275 | |
6276 | @hook TARGET_ASM_CONSTRUCTOR | |
38f8b050 JR |
6277 | |
6278 | @hook TARGET_ASM_DESTRUCTOR | |
38f8b050 JR |
6279 | |
6280 | If @code{TARGET_HAVE_CTORS_DTORS} is true, the initialization routine | |
6281 | generated for the generated object file will have static linkage. | |
6282 | ||
6283 | If your system uses @command{collect2} as the means of processing | |
6284 | constructors, then that program normally uses @command{nm} to scan | |
6285 | an object file for constructor functions to be called. | |
6286 | ||
6287 | On certain kinds of systems, you can define this macro to make | |
6288 | @command{collect2} work faster (and, in some cases, make it work at all): | |
6289 | ||
6290 | @defmac OBJECT_FORMAT_COFF | |
6291 | Define this macro if the system uses COFF (Common Object File Format) | |
6292 | object files, so that @command{collect2} can assume this format and scan | |
6293 | object files directly for dynamic constructor/destructor functions. | |
6294 | ||
6295 | This macro is effective only in a native compiler; @command{collect2} as | |
6296 | part of a cross compiler always uses @command{nm} for the target machine. | |
6297 | @end defmac | |
6298 | ||
6299 | @defmac REAL_NM_FILE_NAME | |
6300 | Define this macro as a C string constant containing the file name to use | |
6301 | to execute @command{nm}. The default is to search the path normally for | |
6302 | @command{nm}. | |
3e794bfe RO |
6303 | @end defmac |
6304 | ||
6305 | @defmac NM_FLAGS | |
6306 | @command{collect2} calls @command{nm} to scan object files for static | |
6307 | constructors and destructors and LTO info. By default, @option{-n} is | |
6308 | passed. Define @code{NM_FLAGS} to a C string constant if other options | |
2b0d3573 | 6309 | are needed to get the same output format as GNU @command{nm -n} |
3e794bfe RO |
6310 | produces. |
6311 | @end defmac | |
38f8b050 JR |
6312 | |
6313 | If your system supports shared libraries and has a program to list the | |
6314 | dynamic dependencies of a given library or executable, you can define | |
6315 | these macros to enable support for running initialization and | |
6316 | termination functions in shared libraries: | |
38f8b050 JR |
6317 | |
6318 | @defmac LDD_SUFFIX | |
6319 | Define this macro to a C string constant containing the name of the program | |
3e794bfe | 6320 | which lists dynamic dependencies, like @command{ldd} under SunOS 4. |
38f8b050 JR |
6321 | @end defmac |
6322 | ||
6323 | @defmac PARSE_LDD_OUTPUT (@var{ptr}) | |
6324 | Define this macro to be C code that extracts filenames from the output | |
6325 | of the program denoted by @code{LDD_SUFFIX}. @var{ptr} is a variable | |
6326 | of type @code{char *} that points to the beginning of a line of output | |
6327 | from @code{LDD_SUFFIX}. If the line lists a dynamic dependency, the | |
6328 | code must advance @var{ptr} to the beginning of the filename on that | |
6329 | line. Otherwise, it must set @var{ptr} to @code{NULL}. | |
6330 | @end defmac | |
6331 | ||
6332 | @defmac SHLIB_SUFFIX | |
6333 | Define this macro to a C string constant containing the default shared | |
6334 | library extension of the target (e.g., @samp{".so"}). @command{collect2} | |
6335 | strips version information after this suffix when generating global | |
6336 | constructor and destructor names. This define is only needed on targets | |
6337 | that use @command{collect2} to process constructors and destructors. | |
6338 | @end defmac | |
6339 | ||
6340 | @node Instruction Output | |
6341 | @subsection Output of Assembler Instructions | |
6342 | ||
6343 | @c prevent bad page break with this line | |
6344 | This describes assembler instruction output. | |
6345 | ||
6346 | @defmac REGISTER_NAMES | |
6347 | A C initializer containing the assembler's names for the machine | |
6348 | registers, each one as a C string constant. This is what translates | |
6349 | register numbers in the compiler into assembler language. | |
6350 | @end defmac | |
6351 | ||
6352 | @defmac ADDITIONAL_REGISTER_NAMES | |
6353 | If defined, a C initializer for an array of structures containing a name | |
6354 | and a register number. This macro defines additional names for hard | |
6355 | registers, thus allowing the @code{asm} option in declarations to refer | |
6356 | to registers using alternate names. | |
6357 | @end defmac | |
6358 | ||
0c6d290e RE |
6359 | @defmac OVERLAPPING_REGISTER_NAMES |
6360 | If defined, a C initializer for an array of structures containing a | |
6361 | name, a register number and a count of the number of consecutive | |
6362 | machine registers the name overlaps. This macro defines additional | |
6363 | names for hard registers, thus allowing the @code{asm} option in | |
6364 | declarations to refer to registers using alternate names. Unlike | |
6365 | @code{ADDITIONAL_REGISTER_NAMES}, this macro should be used when the | |
6366 | register name implies multiple underlying registers. | |
6367 | ||
6368 | This macro should be used when it is important that a clobber in an | |
6369 | @code{asm} statement clobbers all the underlying values implied by the | |
6370 | register name. For example, on ARM, clobbering the double-precision | |
6371 | VFP register ``d0'' implies clobbering both single-precision registers | |
6372 | ``s0'' and ``s1''. | |
6373 | @end defmac | |
6374 | ||
38f8b050 JR |
6375 | @defmac ASM_OUTPUT_OPCODE (@var{stream}, @var{ptr}) |
6376 | Define this macro if you are using an unusual assembler that | |
6377 | requires different names for the machine instructions. | |
6378 | ||
6379 | The definition is a C statement or statements which output an | |
6380 | assembler instruction opcode to the stdio stream @var{stream}. The | |
6381 | macro-operand @var{ptr} is a variable of type @code{char *} which | |
6382 | points to the opcode name in its ``internal'' form---the form that is | |
6383 | written in the machine description. The definition should output the | |
6384 | opcode name to @var{stream}, performing any translation you desire, and | |
6385 | increment the variable @var{ptr} to point at the end of the opcode | |
6386 | so that it will not be output twice. | |
6387 | ||
6388 | In fact, your macro definition may process less than the entire opcode | |
6389 | name, or more than the opcode name; but if you want to process text | |
6390 | that includes @samp{%}-sequences to substitute operands, you must take | |
6391 | care of the substitution yourself. Just be sure to increment | |
6392 | @var{ptr} over whatever text should not be output normally. | |
6393 | ||
6394 | @findex recog_data.operand | |
6395 | If you need to look at the operand values, they can be found as the | |
6396 | elements of @code{recog_data.operand}. | |
6397 | ||
6398 | If the macro definition does nothing, the instruction is output | |
6399 | in the usual way. | |
6400 | @end defmac | |
6401 | ||
6402 | @defmac FINAL_PRESCAN_INSN (@var{insn}, @var{opvec}, @var{noperands}) | |
6403 | If defined, a C statement to be executed just prior to the output of | |
6404 | assembler code for @var{insn}, to modify the extracted operands so | |
6405 | they will be output differently. | |
6406 | ||
6407 | Here the argument @var{opvec} is the vector containing the operands | |
6408 | extracted from @var{insn}, and @var{noperands} is the number of | |
6409 | elements of the vector which contain meaningful data for this insn. | |
6410 | The contents of this vector are what will be used to convert the insn | |
6411 | template into assembler code, so you can change the assembler output | |
6412 | by changing the contents of the vector. | |
6413 | ||
6414 | This macro is useful when various assembler syntaxes share a single | |
6415 | file of instruction patterns; by defining this macro differently, you | |
6416 | can cause a large class of instructions to be output differently (such | |
6417 | as with rearranged operands). Naturally, variations in assembler | |
6418 | syntax affecting individual insn patterns ought to be handled by | |
6419 | writing conditional output routines in those patterns. | |
6420 | ||
6421 | If this macro is not defined, it is equivalent to a null statement. | |
6422 | @end defmac | |
6423 | ||
6424 | @hook TARGET_ASM_FINAL_POSTSCAN_INSN | |
38f8b050 JR |
6425 | |
6426 | @defmac PRINT_OPERAND (@var{stream}, @var{x}, @var{code}) | |
6427 | A C compound statement to output to stdio stream @var{stream} the | |
6428 | assembler syntax for an instruction operand @var{x}. @var{x} is an | |
6429 | RTL expression. | |
6430 | ||
6431 | @var{code} is a value that can be used to specify one of several ways | |
6432 | of printing the operand. It is used when identical operands must be | |
6433 | printed differently depending on the context. @var{code} comes from | |
6434 | the @samp{%} specification that was used to request printing of the | |
6435 | operand. If the specification was just @samp{%@var{digit}} then | |
6436 | @var{code} is 0; if the specification was @samp{%@var{ltr} | |
6437 | @var{digit}} then @var{code} is the ASCII code for @var{ltr}. | |
6438 | ||
6439 | @findex reg_names | |
6440 | If @var{x} is a register, this macro should print the register's name. | |
6441 | The names can be found in an array @code{reg_names} whose type is | |
6442 | @code{char *[]}. @code{reg_names} is initialized from | |
6443 | @code{REGISTER_NAMES}. | |
6444 | ||
6445 | When the machine description has a specification @samp{%@var{punct}} | |
6446 | (a @samp{%} followed by a punctuation character), this macro is called | |
6447 | with a null pointer for @var{x} and the punctuation character for | |
6448 | @var{code}. | |
6449 | @end defmac | |
6450 | ||
6451 | @defmac PRINT_OPERAND_PUNCT_VALID_P (@var{code}) | |
6452 | A C expression which evaluates to true if @var{code} is a valid | |
6453 | punctuation character for use in the @code{PRINT_OPERAND} macro. If | |
6454 | @code{PRINT_OPERAND_PUNCT_VALID_P} is not defined, it means that no | |
6455 | punctuation characters (except for the standard one, @samp{%}) are used | |
6456 | in this way. | |
6457 | @end defmac | |
6458 | ||
6459 | @defmac PRINT_OPERAND_ADDRESS (@var{stream}, @var{x}) | |
6460 | A C compound statement to output to stdio stream @var{stream} the | |
6461 | assembler syntax for an instruction operand that is a memory reference | |
6462 | whose address is @var{x}. @var{x} is an RTL expression. | |
6463 | ||
6464 | @cindex @code{TARGET_ENCODE_SECTION_INFO} usage | |
6465 | On some machines, the syntax for a symbolic address depends on the | |
6466 | section that the address refers to. On these machines, define the hook | |
6467 | @code{TARGET_ENCODE_SECTION_INFO} to store the information into the | |
6468 | @code{symbol_ref}, and then check for it here. @xref{Assembler | |
6469 | Format}. | |
6470 | @end defmac | |
6471 | ||
6472 | @findex dbr_sequence_length | |
6473 | @defmac DBR_OUTPUT_SEQEND (@var{file}) | |
6474 | A C statement, to be executed after all slot-filler instructions have | |
6475 | been output. If necessary, call @code{dbr_sequence_length} to | |
6476 | determine the number of slots filled in a sequence (zero if not | |
6477 | currently outputting a sequence), to decide how many no-ops to output, | |
6478 | or whatever. | |
6479 | ||
6480 | Don't define this macro if it has nothing to do, but it is helpful in | |
6481 | reading assembly output if the extent of the delay sequence is made | |
6482 | explicit (e.g.@: with white space). | |
6483 | @end defmac | |
6484 | ||
6485 | @findex final_sequence | |
6486 | Note that output routines for instructions with delay slots must be | |
6487 | prepared to deal with not being output as part of a sequence | |
6488 | (i.e.@: when the scheduling pass is not run, or when no slot fillers could be | |
6489 | found.) The variable @code{final_sequence} is null when not | |
6490 | processing a sequence, otherwise it contains the @code{sequence} rtx | |
6491 | being output. | |
6492 | ||
6493 | @findex asm_fprintf | |
6494 | @defmac REGISTER_PREFIX | |
6495 | @defmacx LOCAL_LABEL_PREFIX | |
6496 | @defmacx USER_LABEL_PREFIX | |
6497 | @defmacx IMMEDIATE_PREFIX | |
6498 | If defined, C string expressions to be used for the @samp{%R}, @samp{%L}, | |
6499 | @samp{%U}, and @samp{%I} options of @code{asm_fprintf} (see | |
6500 | @file{final.c}). These are useful when a single @file{md} file must | |
6501 | support multiple assembler formats. In that case, the various @file{tm.h} | |
6502 | files can define these macros differently. | |
6503 | @end defmac | |
6504 | ||
6505 | @defmac ASM_FPRINTF_EXTENSIONS (@var{file}, @var{argptr}, @var{format}) | |
6506 | If defined this macro should expand to a series of @code{case} | |
6507 | statements which will be parsed inside the @code{switch} statement of | |
6508 | the @code{asm_fprintf} function. This allows targets to define extra | |
6509 | printf formats which may useful when generating their assembler | |
6510 | statements. Note that uppercase letters are reserved for future | |
6511 | generic extensions to asm_fprintf, and so are not available to target | |
6512 | specific code. The output file is given by the parameter @var{file}. | |
6513 | The varargs input pointer is @var{argptr} and the rest of the format | |
6514 | string, starting the character after the one that is being switched | |
6515 | upon, is pointed to by @var{format}. | |
6516 | @end defmac | |
6517 | ||
6518 | @defmac ASSEMBLER_DIALECT | |
6519 | If your target supports multiple dialects of assembler language (such as | |
6520 | different opcodes), define this macro as a C expression that gives the | |
6521 | numeric index of the assembler language dialect to use, with zero as the | |
6522 | first variant. | |
6523 | ||
6524 | If this macro is defined, you may use constructs of the form | |
6525 | @smallexample | |
6526 | @samp{@{option0|option1|option2@dots{}@}} | |
6527 | @end smallexample | |
6528 | @noindent | |
6529 | in the output templates of patterns (@pxref{Output Template}) or in the | |
6530 | first argument of @code{asm_fprintf}. This construct outputs | |
6531 | @samp{option0}, @samp{option1}, @samp{option2}, etc., if the value of | |
6532 | @code{ASSEMBLER_DIALECT} is zero, one, two, etc. Any special characters | |
6533 | within these strings retain their usual meaning. If there are fewer | |
6534 | alternatives within the braces than the value of | |
382522cb MK |
6535 | @code{ASSEMBLER_DIALECT}, the construct outputs nothing. If it's needed |
6536 | to print curly braces or @samp{|} character in assembler output directly, | |
6537 | @samp{%@{}, @samp{%@}} and @samp{%|} can be used. | |
38f8b050 JR |
6538 | |
6539 | If you do not define this macro, the characters @samp{@{}, @samp{|} and | |
6540 | @samp{@}} do not have any special meaning when used in templates or | |
6541 | operands to @code{asm_fprintf}. | |
6542 | ||
6543 | Define the macros @code{REGISTER_PREFIX}, @code{LOCAL_LABEL_PREFIX}, | |
6544 | @code{USER_LABEL_PREFIX} and @code{IMMEDIATE_PREFIX} if you can express | |
6545 | the variations in assembler language syntax with that mechanism. Define | |
6546 | @code{ASSEMBLER_DIALECT} and use the @samp{@{option0|option1@}} syntax | |
6547 | if the syntax variant are larger and involve such things as different | |
6548 | opcodes or operand order. | |
6549 | @end defmac | |
6550 | ||
6551 | @defmac ASM_OUTPUT_REG_PUSH (@var{stream}, @var{regno}) | |
6552 | A C expression to output to @var{stream} some assembler code | |
6553 | which will push hard register number @var{regno} onto the stack. | |
6554 | The code need not be optimal, since this macro is used only when | |
6555 | profiling. | |
6556 | @end defmac | |
6557 | ||
6558 | @defmac ASM_OUTPUT_REG_POP (@var{stream}, @var{regno}) | |
6559 | A C expression to output to @var{stream} some assembler code | |
6560 | which will pop hard register number @var{regno} off of the stack. | |
6561 | The code need not be optimal, since this macro is used only when | |
6562 | profiling. | |
6563 | @end defmac | |
6564 | ||
6565 | @node Dispatch Tables | |
6566 | @subsection Output of Dispatch Tables | |
6567 | ||
6568 | @c prevent bad page break with this line | |
6569 | This concerns dispatch tables. | |
6570 | ||
6571 | @cindex dispatch table | |
6572 | @defmac ASM_OUTPUT_ADDR_DIFF_ELT (@var{stream}, @var{body}, @var{value}, @var{rel}) | |
6573 | A C statement to output to the stdio stream @var{stream} an assembler | |
6574 | pseudo-instruction to generate a difference between two labels. | |
6575 | @var{value} and @var{rel} are the numbers of two internal labels. The | |
6576 | definitions of these labels are output using | |
6577 | @code{(*targetm.asm_out.internal_label)}, and they must be printed in the same | |
6578 | way here. For example, | |
6579 | ||
6580 | @smallexample | |
6581 | fprintf (@var{stream}, "\t.word L%d-L%d\n", | |
6582 | @var{value}, @var{rel}) | |
6583 | @end smallexample | |
6584 | ||
6585 | You must provide this macro on machines where the addresses in a | |
6586 | dispatch table are relative to the table's own address. If defined, GCC | |
6587 | will also use this macro on all machines when producing PIC@. | |
6588 | @var{body} is the body of the @code{ADDR_DIFF_VEC}; it is provided so that the | |
6589 | mode and flags can be read. | |
6590 | @end defmac | |
6591 | ||
6592 | @defmac ASM_OUTPUT_ADDR_VEC_ELT (@var{stream}, @var{value}) | |
6593 | This macro should be provided on machines where the addresses | |
6594 | in a dispatch table are absolute. | |
6595 | ||
6596 | The definition should be a C statement to output to the stdio stream | |
6597 | @var{stream} an assembler pseudo-instruction to generate a reference to | |
6598 | a label. @var{value} is the number of an internal label whose | |
6599 | definition is output using @code{(*targetm.asm_out.internal_label)}. | |
6600 | For example, | |
6601 | ||
6602 | @smallexample | |
6603 | fprintf (@var{stream}, "\t.word L%d\n", @var{value}) | |
6604 | @end smallexample | |
6605 | @end defmac | |
6606 | ||
6607 | @defmac ASM_OUTPUT_CASE_LABEL (@var{stream}, @var{prefix}, @var{num}, @var{table}) | |
6608 | Define this if the label before a jump-table needs to be output | |
6609 | specially. The first three arguments are the same as for | |
6610 | @code{(*targetm.asm_out.internal_label)}; the fourth argument is the | |
da5c6bde | 6611 | jump-table which follows (a @code{jump_table_data} containing an |
38f8b050 JR |
6612 | @code{addr_vec} or @code{addr_diff_vec}). |
6613 | ||
6614 | This feature is used on system V to output a @code{swbeg} statement | |
6615 | for the table. | |
6616 | ||
6617 | If this macro is not defined, these labels are output with | |
6618 | @code{(*targetm.asm_out.internal_label)}. | |
6619 | @end defmac | |
6620 | ||
6621 | @defmac ASM_OUTPUT_CASE_END (@var{stream}, @var{num}, @var{table}) | |
6622 | Define this if something special must be output at the end of a | |
6623 | jump-table. The definition should be a C statement to be executed | |
6624 | after the assembler code for the table is written. It should write | |
6625 | the appropriate code to stdio stream @var{stream}. The argument | |
6626 | @var{table} is the jump-table insn, and @var{num} is the label-number | |
6627 | of the preceding label. | |
6628 | ||
6629 | If this macro is not defined, nothing special is output at the end of | |
6630 | the jump-table. | |
6631 | @end defmac | |
6632 | ||
6633 | @hook TARGET_ASM_EMIT_UNWIND_LABEL | |
38f8b050 JR |
6634 | |
6635 | @hook TARGET_ASM_EMIT_EXCEPT_TABLE_LABEL | |
38f8b050 | 6636 | |
a68b5e52 RH |
6637 | @hook TARGET_ASM_EMIT_EXCEPT_PERSONALITY |
6638 | ||
38f8b050 | 6639 | @hook TARGET_ASM_UNWIND_EMIT |
38f8b050 | 6640 | |
3bc6b3e6 RH |
6641 | @hook TARGET_ASM_UNWIND_EMIT_BEFORE_INSN |
6642 | ||
38f8b050 JR |
6643 | @node Exception Region Output |
6644 | @subsection Assembler Commands for Exception Regions | |
6645 | ||
6646 | @c prevent bad page break with this line | |
6647 | ||
6648 | This describes commands marking the start and the end of an exception | |
6649 | region. | |
6650 | ||
6651 | @defmac EH_FRAME_SECTION_NAME | |
6652 | If defined, a C string constant for the name of the section containing | |
6653 | exception handling frame unwind information. If not defined, GCC will | |
6654 | provide a default definition if the target supports named sections. | |
6655 | @file{crtstuff.c} uses this macro to switch to the appropriate section. | |
6656 | ||
6657 | You should define this symbol if your target supports DWARF 2 frame | |
6658 | unwind information and the default definition does not work. | |
6659 | @end defmac | |
6660 | ||
6661 | @defmac EH_FRAME_IN_DATA_SECTION | |
6662 | If defined, DWARF 2 frame unwind information will be placed in the | |
6663 | data section even though the target supports named sections. This | |
6664 | might be necessary, for instance, if the system linker does garbage | |
6665 | collection and sections cannot be marked as not to be collected. | |
6666 | ||
6667 | Do not define this macro unless @code{TARGET_ASM_NAMED_SECTION} is | |
6668 | also defined. | |
6669 | @end defmac | |
6670 | ||
6671 | @defmac EH_TABLES_CAN_BE_READ_ONLY | |
6672 | Define this macro to 1 if your target is such that no frame unwind | |
6673 | information encoding used with non-PIC code will ever require a | |
6674 | runtime relocation, but the linker may not support merging read-only | |
6675 | and read-write sections into a single read-write section. | |
6676 | @end defmac | |
6677 | ||
6678 | @defmac MASK_RETURN_ADDR | |
6679 | An rtx used to mask the return address found via @code{RETURN_ADDR_RTX}, so | |
6680 | that it does not contain any extraneous set bits in it. | |
6681 | @end defmac | |
6682 | ||
6683 | @defmac DWARF2_UNWIND_INFO | |
6684 | Define this macro to 0 if your target supports DWARF 2 frame unwind | |
6685 | information, but it does not yet work with exception handling. | |
6686 | Otherwise, if your target supports this information (if it defines | |
01a07a64 SB |
6687 | @code{INCOMING_RETURN_ADDR_RTX} and @code{OBJECT_FORMAT_ELF}), |
6688 | GCC will provide a default definition of 1. | |
f0a0390e | 6689 | @end defmac |
38f8b050 | 6690 | |
f0a0390e RH |
6691 | @hook TARGET_EXCEPT_UNWIND_INFO |
6692 | This hook defines the mechanism that will be used for exception handling | |
6693 | by the target. If the target has ABI specified unwind tables, the hook | |
6694 | should return @code{UI_TARGET}. If the target is to use the | |
6695 | @code{setjmp}/@code{longjmp}-based exception handling scheme, the hook | |
6696 | should return @code{UI_SJLJ}. If the target supports DWARF 2 frame unwind | |
6697 | information, the hook should return @code{UI_DWARF2}. | |
38f8b050 | 6698 | |
f0a0390e RH |
6699 | A target may, if exceptions are disabled, choose to return @code{UI_NONE}. |
6700 | This may end up simplifying other parts of target-specific code. The | |
6701 | default implementation of this hook never returns @code{UI_NONE}. | |
38f8b050 | 6702 | |
f0a0390e | 6703 | Note that the value returned by this hook should be constant. It should |
d5fabb58 JM |
6704 | not depend on anything except the command-line switches described by |
6705 | @var{opts}. In particular, the | |
f0a0390e RH |
6706 | setting @code{UI_SJLJ} must be fixed at compiler start-up as C pre-processor |
6707 | macros and builtin functions related to exception handling are set up | |
6708 | depending on this setting. | |
6709 | ||
6710 | The default implementation of the hook first honors the | |
6711 | @option{--enable-sjlj-exceptions} configure option, then | |
d5fabb58 JM |
6712 | @code{DWARF2_UNWIND_INFO}, and finally defaults to @code{UI_SJLJ}. If |
6713 | @code{DWARF2_UNWIND_INFO} depends on command-line options, the target | |
6714 | must define this hook so that @var{opts} is used correctly. | |
f0a0390e | 6715 | @end deftypefn |
38f8b050 JR |
6716 | |
6717 | @hook TARGET_UNWIND_TABLES_DEFAULT | |
6718 | This variable should be set to @code{true} if the target ABI requires unwinding | |
d5fabb58 JM |
6719 | tables even when exceptions are not used. It must not be modified by |
6720 | command-line option processing. | |
38f8b050 JR |
6721 | @end deftypevr |
6722 | ||
38f8b050 JR |
6723 | @defmac DONT_USE_BUILTIN_SETJMP |
6724 | Define this macro to 1 if the @code{setjmp}/@code{longjmp}-based scheme | |
6725 | should use the @code{setjmp}/@code{longjmp} functions from the C library | |
6726 | instead of the @code{__builtin_setjmp}/@code{__builtin_longjmp} machinery. | |
6727 | @end defmac | |
6728 | ||
39ce30d8 SB |
6729 | @defmac JMP_BUF_SIZE |
6730 | This macro has no effect unless @code{DONT_USE_BUILTIN_SETJMP} is also | |
6731 | defined. Define this macro if the default size of @code{jmp_buf} buffer | |
6732 | for the @code{setjmp}/@code{longjmp}-based exception handling mechanism | |
6733 | is not large enough, or if it is much too large. | |
6734 | The default size is @code{FIRST_PSEUDO_REGISTER * sizeof(void *)}. | |
6735 | @end defmac | |
6736 | ||
38f8b050 JR |
6737 | @defmac DWARF_CIE_DATA_ALIGNMENT |
6738 | This macro need only be defined if the target might save registers in the | |
6739 | function prologue at an offset to the stack pointer that is not aligned to | |
6740 | @code{UNITS_PER_WORD}. The definition should be the negative minimum | |
6741 | alignment if @code{STACK_GROWS_DOWNWARD} is defined, and the positive | |
6742 | minimum alignment otherwise. @xref{SDB and DWARF}. Only applicable if | |
6743 | the target supports DWARF 2 frame unwind information. | |
6744 | @end defmac | |
6745 | ||
6746 | @hook TARGET_TERMINATE_DW2_EH_FRAME_INFO | |
38f8b050 JR |
6747 | |
6748 | @hook TARGET_DWARF_REGISTER_SPAN | |
38f8b050 JR |
6749 | |
6750 | @hook TARGET_INIT_DWARF_REG_SIZES_EXTRA | |
38f8b050 JR |
6751 | |
6752 | @hook TARGET_ASM_TTYPE | |
38f8b050 JR |
6753 | |
6754 | @hook TARGET_ARM_EABI_UNWINDER | |
38f8b050 JR |
6755 | |
6756 | @node Alignment Output | |
6757 | @subsection Assembler Commands for Alignment | |
6758 | ||
6759 | @c prevent bad page break with this line | |
6760 | This describes commands for alignment. | |
6761 | ||
6762 | @defmac JUMP_ALIGN (@var{label}) | |
6763 | The alignment (log base 2) to put in front of @var{label}, which is | |
6764 | a common destination of jumps and has no fallthru incoming edge. | |
6765 | ||
6766 | This macro need not be defined if you don't want any special alignment | |
6767 | to be done at such a time. Most machine descriptions do not currently | |
6768 | define the macro. | |
6769 | ||
6770 | Unless it's necessary to inspect the @var{label} parameter, it is better | |
6771 | to set the variable @var{align_jumps} in the target's | |
6772 | @code{TARGET_OPTION_OVERRIDE}. Otherwise, you should try to honor the user's | |
6773 | selection in @var{align_jumps} in a @code{JUMP_ALIGN} implementation. | |
6774 | @end defmac | |
6775 | ||
ad0c4c36 | 6776 | @hook TARGET_ASM_JUMP_ALIGN_MAX_SKIP |
ad0c4c36 | 6777 | |
38f8b050 JR |
6778 | @defmac LABEL_ALIGN_AFTER_BARRIER (@var{label}) |
6779 | The alignment (log base 2) to put in front of @var{label}, which follows | |
6780 | a @code{BARRIER}. | |
6781 | ||
6782 | This macro need not be defined if you don't want any special alignment | |
6783 | to be done at such a time. Most machine descriptions do not currently | |
6784 | define the macro. | |
6785 | @end defmac | |
6786 | ||
ad0c4c36 | 6787 | @hook TARGET_ASM_LABEL_ALIGN_AFTER_BARRIER_MAX_SKIP |
38f8b050 JR |
6788 | |
6789 | @defmac LOOP_ALIGN (@var{label}) | |
58a51369 SB |
6790 | The alignment (log base 2) to put in front of @var{label} that heads |
6791 | a frequently executed basic block (usually the header of a loop). | |
38f8b050 JR |
6792 | |
6793 | This macro need not be defined if you don't want any special alignment | |
6794 | to be done at such a time. Most machine descriptions do not currently | |
6795 | define the macro. | |
6796 | ||
6797 | Unless it's necessary to inspect the @var{label} parameter, it is better | |
6798 | to set the variable @code{align_loops} in the target's | |
6799 | @code{TARGET_OPTION_OVERRIDE}. Otherwise, you should try to honor the user's | |
6800 | selection in @code{align_loops} in a @code{LOOP_ALIGN} implementation. | |
6801 | @end defmac | |
6802 | ||
ad0c4c36 | 6803 | @hook TARGET_ASM_LOOP_ALIGN_MAX_SKIP |
38f8b050 JR |
6804 | |
6805 | @defmac LABEL_ALIGN (@var{label}) | |
6806 | The alignment (log base 2) to put in front of @var{label}. | |
6807 | If @code{LABEL_ALIGN_AFTER_BARRIER} / @code{LOOP_ALIGN} specify a different alignment, | |
6808 | the maximum of the specified values is used. | |
6809 | ||
6810 | Unless it's necessary to inspect the @var{label} parameter, it is better | |
6811 | to set the variable @code{align_labels} in the target's | |
6812 | @code{TARGET_OPTION_OVERRIDE}. Otherwise, you should try to honor the user's | |
6813 | selection in @code{align_labels} in a @code{LABEL_ALIGN} implementation. | |
6814 | @end defmac | |
6815 | ||
ad0c4c36 | 6816 | @hook TARGET_ASM_LABEL_ALIGN_MAX_SKIP |
38f8b050 JR |
6817 | |
6818 | @defmac ASM_OUTPUT_SKIP (@var{stream}, @var{nbytes}) | |
6819 | A C statement to output to the stdio stream @var{stream} an assembler | |
6820 | instruction to advance the location counter by @var{nbytes} bytes. | |
6821 | Those bytes should be zero when loaded. @var{nbytes} will be a C | |
6822 | expression of type @code{unsigned HOST_WIDE_INT}. | |
6823 | @end defmac | |
6824 | ||
6825 | @defmac ASM_NO_SKIP_IN_TEXT | |
6826 | Define this macro if @code{ASM_OUTPUT_SKIP} should not be used in the | |
6827 | text section because it fails to put zeros in the bytes that are skipped. | |
6828 | This is true on many Unix systems, where the pseudo--op to skip bytes | |
6829 | produces no-op instructions rather than zeros when used in the text | |
6830 | section. | |
6831 | @end defmac | |
6832 | ||
6833 | @defmac ASM_OUTPUT_ALIGN (@var{stream}, @var{power}) | |
6834 | A C statement to output to the stdio stream @var{stream} an assembler | |
6835 | command to advance the location counter to a multiple of 2 to the | |
6836 | @var{power} bytes. @var{power} will be a C expression of type @code{int}. | |
6837 | @end defmac | |
6838 | ||
6839 | @defmac ASM_OUTPUT_ALIGN_WITH_NOP (@var{stream}, @var{power}) | |
6840 | Like @code{ASM_OUTPUT_ALIGN}, except that the ``nop'' instruction is used | |
6841 | for padding, if necessary. | |
6842 | @end defmac | |
6843 | ||
6844 | @defmac ASM_OUTPUT_MAX_SKIP_ALIGN (@var{stream}, @var{power}, @var{max_skip}) | |
6845 | A C statement to output to the stdio stream @var{stream} an assembler | |
6846 | command to advance the location counter to a multiple of 2 to the | |
6847 | @var{power} bytes, but only if @var{max_skip} or fewer bytes are needed to | |
6848 | satisfy the alignment request. @var{power} and @var{max_skip} will be | |
6849 | a C expression of type @code{int}. | |
6850 | @end defmac | |
6851 | ||
6852 | @need 3000 | |
6853 | @node Debugging Info | |
6854 | @section Controlling Debugging Information Format | |
6855 | ||
6856 | @c prevent bad page break with this line | |
6857 | This describes how to specify debugging information. | |
6858 | ||
6859 | @menu | |
6860 | * All Debuggers:: Macros that affect all debugging formats uniformly. | |
6861 | * DBX Options:: Macros enabling specific options in DBX format. | |
6862 | * DBX Hooks:: Hook macros for varying DBX format. | |
6863 | * File Names and DBX:: Macros controlling output of file names in DBX format. | |
6864 | * SDB and DWARF:: Macros for SDB (COFF) and DWARF formats. | |
6865 | * VMS Debug:: Macros for VMS debug format. | |
6866 | @end menu | |
6867 | ||
6868 | @node All Debuggers | |
6869 | @subsection Macros Affecting All Debugging Formats | |
6870 | ||
6871 | @c prevent bad page break with this line | |
6872 | These macros affect all debugging formats. | |
6873 | ||
6874 | @defmac DBX_REGISTER_NUMBER (@var{regno}) | |
6875 | A C expression that returns the DBX register number for the compiler | |
6876 | register number @var{regno}. In the default macro provided, the value | |
6877 | of this expression will be @var{regno} itself. But sometimes there are | |
6878 | some registers that the compiler knows about and DBX does not, or vice | |
6879 | versa. In such cases, some register may need to have one number in the | |
6880 | compiler and another for DBX@. | |
6881 | ||
6882 | If two registers have consecutive numbers inside GCC, and they can be | |
6883 | used as a pair to hold a multiword value, then they @emph{must} have | |
6884 | consecutive numbers after renumbering with @code{DBX_REGISTER_NUMBER}. | |
6885 | Otherwise, debuggers will be unable to access such a pair, because they | |
6886 | expect register pairs to be consecutive in their own numbering scheme. | |
6887 | ||
6888 | If you find yourself defining @code{DBX_REGISTER_NUMBER} in way that | |
6889 | does not preserve register pairs, then what you must do instead is | |
6890 | redefine the actual register numbering scheme. | |
6891 | @end defmac | |
6892 | ||
6893 | @defmac DEBUGGER_AUTO_OFFSET (@var{x}) | |
6894 | A C expression that returns the integer offset value for an automatic | |
6895 | variable having address @var{x} (an RTL expression). The default | |
6896 | computation assumes that @var{x} is based on the frame-pointer and | |
6897 | gives the offset from the frame-pointer. This is required for targets | |
6898 | that produce debugging output for DBX or COFF-style debugging output | |
6899 | for SDB and allow the frame-pointer to be eliminated when the | |
6900 | @option{-g} options is used. | |
6901 | @end defmac | |
6902 | ||
6903 | @defmac DEBUGGER_ARG_OFFSET (@var{offset}, @var{x}) | |
6904 | A C expression that returns the integer offset value for an argument | |
6905 | having address @var{x} (an RTL expression). The nominal offset is | |
6906 | @var{offset}. | |
6907 | @end defmac | |
6908 | ||
6909 | @defmac PREFERRED_DEBUGGING_TYPE | |
6910 | A C expression that returns the type of debugging output GCC should | |
6911 | produce when the user specifies just @option{-g}. Define | |
6912 | this if you have arranged for GCC to support more than one format of | |
6913 | debugging output. Currently, the allowable values are @code{DBX_DEBUG}, | |
6914 | @code{SDB_DEBUG}, @code{DWARF_DEBUG}, @code{DWARF2_DEBUG}, | |
6915 | @code{XCOFF_DEBUG}, @code{VMS_DEBUG}, and @code{VMS_AND_DWARF2_DEBUG}. | |
6916 | ||
6917 | When the user specifies @option{-ggdb}, GCC normally also uses the | |
6918 | value of this macro to select the debugging output format, but with two | |
6919 | exceptions. If @code{DWARF2_DEBUGGING_INFO} is defined, GCC uses the | |
6920 | value @code{DWARF2_DEBUG}. Otherwise, if @code{DBX_DEBUGGING_INFO} is | |
6921 | defined, GCC uses @code{DBX_DEBUG}. | |
6922 | ||
6923 | The value of this macro only affects the default debugging output; the | |
6924 | user can always get a specific type of output by using @option{-gstabs}, | |
6925 | @option{-gcoff}, @option{-gdwarf-2}, @option{-gxcoff}, or @option{-gvms}. | |
6926 | @end defmac | |
6927 | ||
6928 | @node DBX Options | |
6929 | @subsection Specific Options for DBX Output | |
6930 | ||
6931 | @c prevent bad page break with this line | |
6932 | These are specific options for DBX output. | |
6933 | ||
6934 | @defmac DBX_DEBUGGING_INFO | |
6935 | Define this macro if GCC should produce debugging output for DBX | |
6936 | in response to the @option{-g} option. | |
6937 | @end defmac | |
6938 | ||
6939 | @defmac XCOFF_DEBUGGING_INFO | |
6940 | Define this macro if GCC should produce XCOFF format debugging output | |
6941 | in response to the @option{-g} option. This is a variant of DBX format. | |
6942 | @end defmac | |
6943 | ||
6944 | @defmac DEFAULT_GDB_EXTENSIONS | |
6945 | Define this macro to control whether GCC should by default generate | |
6946 | GDB's extended version of DBX debugging information (assuming DBX-format | |
6947 | debugging information is enabled at all). If you don't define the | |
6948 | macro, the default is 1: always generate the extended information | |
6949 | if there is any occasion to. | |
6950 | @end defmac | |
6951 | ||
6952 | @defmac DEBUG_SYMS_TEXT | |
6953 | Define this macro if all @code{.stabs} commands should be output while | |
6954 | in the text section. | |
6955 | @end defmac | |
6956 | ||
6957 | @defmac ASM_STABS_OP | |
6958 | A C string constant, including spacing, naming the assembler pseudo op to | |
6959 | use instead of @code{"\t.stabs\t"} to define an ordinary debugging symbol. | |
6960 | If you don't define this macro, @code{"\t.stabs\t"} is used. This macro | |
6961 | applies only to DBX debugging information format. | |
6962 | @end defmac | |
6963 | ||
6964 | @defmac ASM_STABD_OP | |
6965 | A C string constant, including spacing, naming the assembler pseudo op to | |
6966 | use instead of @code{"\t.stabd\t"} to define a debugging symbol whose | |
6967 | value is the current location. If you don't define this macro, | |
6968 | @code{"\t.stabd\t"} is used. This macro applies only to DBX debugging | |
6969 | information format. | |
6970 | @end defmac | |
6971 | ||
6972 | @defmac ASM_STABN_OP | |
6973 | A C string constant, including spacing, naming the assembler pseudo op to | |
6974 | use instead of @code{"\t.stabn\t"} to define a debugging symbol with no | |
6975 | name. If you don't define this macro, @code{"\t.stabn\t"} is used. This | |
6976 | macro applies only to DBX debugging information format. | |
6977 | @end defmac | |
6978 | ||
6979 | @defmac DBX_NO_XREFS | |
6980 | Define this macro if DBX on your system does not support the construct | |
6981 | @samp{xs@var{tagname}}. On some systems, this construct is used to | |
6982 | describe a forward reference to a structure named @var{tagname}. | |
6983 | On other systems, this construct is not supported at all. | |
6984 | @end defmac | |
6985 | ||
6986 | @defmac DBX_CONTIN_LENGTH | |
6987 | A symbol name in DBX-format debugging information is normally | |
6988 | continued (split into two separate @code{.stabs} directives) when it | |
6989 | exceeds a certain length (by default, 80 characters). On some | |
6990 | operating systems, DBX requires this splitting; on others, splitting | |
6991 | must not be done. You can inhibit splitting by defining this macro | |
6992 | with the value zero. You can override the default splitting-length by | |
6993 | defining this macro as an expression for the length you desire. | |
6994 | @end defmac | |
6995 | ||
6996 | @defmac DBX_CONTIN_CHAR | |
6997 | Normally continuation is indicated by adding a @samp{\} character to | |
6998 | the end of a @code{.stabs} string when a continuation follows. To use | |
6999 | a different character instead, define this macro as a character | |
7000 | constant for the character you want to use. Do not define this macro | |
7001 | if backslash is correct for your system. | |
7002 | @end defmac | |
7003 | ||
7004 | @defmac DBX_STATIC_STAB_DATA_SECTION | |
7005 | Define this macro if it is necessary to go to the data section before | |
7006 | outputting the @samp{.stabs} pseudo-op for a non-global static | |
7007 | variable. | |
7008 | @end defmac | |
7009 | ||
7010 | @defmac DBX_TYPE_DECL_STABS_CODE | |
7011 | The value to use in the ``code'' field of the @code{.stabs} directive | |
7012 | for a typedef. The default is @code{N_LSYM}. | |
7013 | @end defmac | |
7014 | ||
7015 | @defmac DBX_STATIC_CONST_VAR_CODE | |
7016 | The value to use in the ``code'' field of the @code{.stabs} directive | |
7017 | for a static variable located in the text section. DBX format does not | |
7018 | provide any ``right'' way to do this. The default is @code{N_FUN}. | |
7019 | @end defmac | |
7020 | ||
7021 | @defmac DBX_REGPARM_STABS_CODE | |
7022 | The value to use in the ``code'' field of the @code{.stabs} directive | |
7023 | for a parameter passed in registers. DBX format does not provide any | |
7024 | ``right'' way to do this. The default is @code{N_RSYM}. | |
7025 | @end defmac | |
7026 | ||
7027 | @defmac DBX_REGPARM_STABS_LETTER | |
7028 | The letter to use in DBX symbol data to identify a symbol as a parameter | |
7029 | passed in registers. DBX format does not customarily provide any way to | |
7030 | do this. The default is @code{'P'}. | |
7031 | @end defmac | |
7032 | ||
7033 | @defmac DBX_FUNCTION_FIRST | |
7034 | Define this macro if the DBX information for a function and its | |
7035 | arguments should precede the assembler code for the function. Normally, | |
7036 | in DBX format, the debugging information entirely follows the assembler | |
7037 | code. | |
7038 | @end defmac | |
7039 | ||
7040 | @defmac DBX_BLOCKS_FUNCTION_RELATIVE | |
7041 | Define this macro, with value 1, if the value of a symbol describing | |
7042 | the scope of a block (@code{N_LBRAC} or @code{N_RBRAC}) should be | |
7043 | relative to the start of the enclosing function. Normally, GCC uses | |
7044 | an absolute address. | |
7045 | @end defmac | |
7046 | ||
7047 | @defmac DBX_LINES_FUNCTION_RELATIVE | |
7048 | Define this macro, with value 1, if the value of a symbol indicating | |
7049 | the current line number (@code{N_SLINE}) should be relative to the | |
7050 | start of the enclosing function. Normally, GCC uses an absolute address. | |
7051 | @end defmac | |
7052 | ||
7053 | @defmac DBX_USE_BINCL | |
7054 | Define this macro if GCC should generate @code{N_BINCL} and | |
7055 | @code{N_EINCL} stabs for included header files, as on Sun systems. This | |
7056 | macro also directs GCC to output a type number as a pair of a file | |
7057 | number and a type number within the file. Normally, GCC does not | |
7058 | generate @code{N_BINCL} or @code{N_EINCL} stabs, and it outputs a single | |
7059 | number for a type number. | |
7060 | @end defmac | |
7061 | ||
7062 | @node DBX Hooks | |
7063 | @subsection Open-Ended Hooks for DBX Format | |
7064 | ||
7065 | @c prevent bad page break with this line | |
7066 | These are hooks for DBX format. | |
7067 | ||
38f8b050 JR |
7068 | @defmac DBX_OUTPUT_SOURCE_LINE (@var{stream}, @var{line}, @var{counter}) |
7069 | A C statement to output DBX debugging information before code for line | |
7070 | number @var{line} of the current source file to the stdio stream | |
7071 | @var{stream}. @var{counter} is the number of time the macro was | |
7072 | invoked, including the current invocation; it is intended to generate | |
7073 | unique labels in the assembly output. | |
7074 | ||
7075 | This macro should not be defined if the default output is correct, or | |
7076 | if it can be made correct by defining @code{DBX_LINES_FUNCTION_RELATIVE}. | |
7077 | @end defmac | |
7078 | ||
7079 | @defmac NO_DBX_FUNCTION_END | |
7080 | Some stabs encapsulation formats (in particular ECOFF), cannot handle the | |
7081 | @code{.stabs "",N_FUN,,0,0,Lscope-function-1} gdb dbx extension construct. | |
7082 | On those machines, define this macro to turn this feature off without | |
7083 | disturbing the rest of the gdb extensions. | |
7084 | @end defmac | |
7085 | ||
7086 | @defmac NO_DBX_BNSYM_ENSYM | |
7087 | Some assemblers cannot handle the @code{.stabd BNSYM/ENSYM,0,0} gdb dbx | |
7088 | extension construct. On those machines, define this macro to turn this | |
7089 | feature off without disturbing the rest of the gdb extensions. | |
7090 | @end defmac | |
7091 | ||
7092 | @node File Names and DBX | |
7093 | @subsection File Names in DBX Format | |
7094 | ||
7095 | @c prevent bad page break with this line | |
7096 | This describes file names in DBX format. | |
7097 | ||
7098 | @defmac DBX_OUTPUT_MAIN_SOURCE_FILENAME (@var{stream}, @var{name}) | |
7099 | A C statement to output DBX debugging information to the stdio stream | |
7100 | @var{stream}, which indicates that file @var{name} is the main source | |
7101 | file---the file specified as the input file for compilation. | |
7102 | This macro is called only once, at the beginning of compilation. | |
7103 | ||
7104 | This macro need not be defined if the standard form of output | |
7105 | for DBX debugging information is appropriate. | |
7106 | ||
7107 | It may be necessary to refer to a label equal to the beginning of the | |
7108 | text section. You can use @samp{assemble_name (stream, ltext_label_name)} | |
7109 | to do so. If you do this, you must also set the variable | |
7110 | @var{used_ltext_label_name} to @code{true}. | |
7111 | @end defmac | |
7112 | ||
7113 | @defmac NO_DBX_MAIN_SOURCE_DIRECTORY | |
7114 | Define this macro, with value 1, if GCC should not emit an indication | |
7115 | of the current directory for compilation and current source language at | |
7116 | the beginning of the file. | |
7117 | @end defmac | |
7118 | ||
7119 | @defmac NO_DBX_GCC_MARKER | |
7120 | Define this macro, with value 1, if GCC should not emit an indication | |
7121 | that this object file was compiled by GCC@. The default is to emit | |
7122 | an @code{N_OPT} stab at the beginning of every source file, with | |
7123 | @samp{gcc2_compiled.} for the string and value 0. | |
7124 | @end defmac | |
7125 | ||
7126 | @defmac DBX_OUTPUT_MAIN_SOURCE_FILE_END (@var{stream}, @var{name}) | |
7127 | A C statement to output DBX debugging information at the end of | |
7128 | compilation of the main source file @var{name}. Output should be | |
7129 | written to the stdio stream @var{stream}. | |
7130 | ||
7131 | If you don't define this macro, nothing special is output at the end | |
7132 | of compilation, which is correct for most machines. | |
7133 | @end defmac | |
7134 | ||
7135 | @defmac DBX_OUTPUT_NULL_N_SO_AT_MAIN_SOURCE_FILE_END | |
7136 | Define this macro @emph{instead of} defining | |
7137 | @code{DBX_OUTPUT_MAIN_SOURCE_FILE_END}, if what needs to be output at | |
7138 | the end of compilation is an @code{N_SO} stab with an empty string, | |
7139 | whose value is the highest absolute text address in the file. | |
7140 | @end defmac | |
7141 | ||
7142 | @need 2000 | |
7143 | @node SDB and DWARF | |
7144 | @subsection Macros for SDB and DWARF Output | |
7145 | ||
7146 | @c prevent bad page break with this line | |
7147 | Here are macros for SDB and DWARF output. | |
7148 | ||
7149 | @defmac SDB_DEBUGGING_INFO | |
7150 | Define this macro if GCC should produce COFF-style debugging output | |
7151 | for SDB in response to the @option{-g} option. | |
7152 | @end defmac | |
7153 | ||
7154 | @defmac DWARF2_DEBUGGING_INFO | |
7155 | Define this macro if GCC should produce dwarf version 2 format | |
7156 | debugging output in response to the @option{-g} option. | |
7157 | ||
7158 | @hook TARGET_DWARF_CALLING_CONVENTION | |
38f8b050 JR |
7159 | |
7160 | To support optional call frame debugging information, you must also | |
7161 | define @code{INCOMING_RETURN_ADDR_RTX} and either set | |
7162 | @code{RTX_FRAME_RELATED_P} on the prologue insns if you use RTL for the | |
7163 | prologue, or call @code{dwarf2out_def_cfa} and @code{dwarf2out_reg_save} | |
7164 | as appropriate from @code{TARGET_ASM_FUNCTION_PROLOGUE} if you don't. | |
7165 | @end defmac | |
7166 | ||
7167 | @defmac DWARF2_FRAME_INFO | |
7168 | Define this macro to a nonzero value if GCC should always output | |
f0a0390e RH |
7169 | Dwarf 2 frame information. If @code{TARGET_EXCEPT_UNWIND_INFO} |
7170 | (@pxref{Exception Region Output}) returns @code{UI_DWARF2}, and | |
7171 | exceptions are enabled, GCC will output this information not matter | |
7172 | how you define @code{DWARF2_FRAME_INFO}. | |
38f8b050 JR |
7173 | @end defmac |
7174 | ||
f0a0390e | 7175 | @hook TARGET_DEBUG_UNWIND_INFO |
f0a0390e | 7176 | |
38f8b050 JR |
7177 | @defmac DWARF2_ASM_LINE_DEBUG_INFO |
7178 | Define this macro to be a nonzero value if the assembler can generate Dwarf 2 | |
7179 | line debug info sections. This will result in much more compact line number | |
7180 | tables, and hence is desirable if it works. | |
7181 | @end defmac | |
7182 | ||
9730bc27 TT |
7183 | @hook TARGET_WANT_DEBUG_PUB_SECTIONS |
7184 | ||
638c962f JH |
7185 | @hook TARGET_FORCE_AT_COMP_DIR |
7186 | ||
2ba42841 AO |
7187 | @hook TARGET_DELAY_SCHED2 |
7188 | ||
7189 | @hook TARGET_DELAY_VARTRACK | |
7190 | ||
38f8b050 JR |
7191 | @defmac ASM_OUTPUT_DWARF_DELTA (@var{stream}, @var{size}, @var{label1}, @var{label2}) |
7192 | A C statement to issue assembly directives that create a difference | |
7193 | @var{lab1} minus @var{lab2}, using an integer of the given @var{size}. | |
7194 | @end defmac | |
7195 | ||
7196 | @defmac ASM_OUTPUT_DWARF_VMS_DELTA (@var{stream}, @var{size}, @var{label1}, @var{label2}) | |
7197 | A C statement to issue assembly directives that create a difference | |
7198 | between the two given labels in system defined units, e.g. instruction | |
7199 | slots on IA64 VMS, using an integer of the given size. | |
7200 | @end defmac | |
7201 | ||
7202 | @defmac ASM_OUTPUT_DWARF_OFFSET (@var{stream}, @var{size}, @var{label}, @var{section}) | |
7203 | A C statement to issue assembly directives that create a | |
7204 | section-relative reference to the given @var{label}, using an integer of the | |
7205 | given @var{size}. The label is known to be defined in the given @var{section}. | |
7206 | @end defmac | |
7207 | ||
7208 | @defmac ASM_OUTPUT_DWARF_PCREL (@var{stream}, @var{size}, @var{label}) | |
7209 | A C statement to issue assembly directives that create a self-relative | |
7210 | reference to the given @var{label}, using an integer of the given @var{size}. | |
7211 | @end defmac | |
7212 | ||
7213 | @defmac ASM_OUTPUT_DWARF_TABLE_REF (@var{label}) | |
7214 | A C statement to issue assembly directives that create a reference to | |
7215 | the DWARF table identifier @var{label} from the current section. This | |
7216 | is used on some systems to avoid garbage collecting a DWARF table which | |
7217 | is referenced by a function. | |
7218 | @end defmac | |
7219 | ||
7220 | @hook TARGET_ASM_OUTPUT_DWARF_DTPREL | |
38f8b050 JR |
7221 | |
7222 | @defmac PUT_SDB_@dots{} | |
7223 | Define these macros to override the assembler syntax for the special | |
7224 | SDB assembler directives. See @file{sdbout.c} for a list of these | |
7225 | macros and their arguments. If the standard syntax is used, you need | |
7226 | not define them yourself. | |
7227 | @end defmac | |
7228 | ||
7229 | @defmac SDB_DELIM | |
7230 | Some assemblers do not support a semicolon as a delimiter, even between | |
7231 | SDB assembler directives. In that case, define this macro to be the | |
7232 | delimiter to use (usually @samp{\n}). It is not necessary to define | |
7233 | a new set of @code{PUT_SDB_@var{op}} macros if this is the only change | |
7234 | required. | |
7235 | @end defmac | |
7236 | ||
7237 | @defmac SDB_ALLOW_UNKNOWN_REFERENCES | |
7238 | Define this macro to allow references to unknown structure, | |
7239 | union, or enumeration tags to be emitted. Standard COFF does not | |
7240 | allow handling of unknown references, MIPS ECOFF has support for | |
7241 | it. | |
7242 | @end defmac | |
7243 | ||
7244 | @defmac SDB_ALLOW_FORWARD_REFERENCES | |
7245 | Define this macro to allow references to structure, union, or | |
7246 | enumeration tags that have not yet been seen to be handled. Some | |
7247 | assemblers choke if forward tags are used, while some require it. | |
7248 | @end defmac | |
7249 | ||
7250 | @defmac SDB_OUTPUT_SOURCE_LINE (@var{stream}, @var{line}) | |
7251 | A C statement to output SDB debugging information before code for line | |
7252 | number @var{line} of the current source file to the stdio stream | |
7253 | @var{stream}. The default is to emit an @code{.ln} directive. | |
7254 | @end defmac | |
7255 | ||
7256 | @need 2000 | |
7257 | @node VMS Debug | |
7258 | @subsection Macros for VMS Debug Format | |
7259 | ||
7260 | @c prevent bad page break with this line | |
7261 | Here are macros for VMS debug format. | |
7262 | ||
7263 | @defmac VMS_DEBUGGING_INFO | |
7264 | Define this macro if GCC should produce debugging output for VMS | |
7265 | in response to the @option{-g} option. The default behavior for VMS | |
7266 | is to generate minimal debug info for a traceback in the absence of | |
7267 | @option{-g} unless explicitly overridden with @option{-g0}. This | |
fac0f722 | 7268 | behavior is controlled by @code{TARGET_OPTION_OPTIMIZATION} and |
38f8b050 JR |
7269 | @code{TARGET_OPTION_OVERRIDE}. |
7270 | @end defmac | |
7271 | ||
7272 | @node Floating Point | |
7273 | @section Cross Compilation and Floating Point | |
7274 | @cindex cross compilation and floating point | |
7275 | @cindex floating point and cross compilation | |
7276 | ||
7277 | While all modern machines use twos-complement representation for integers, | |
7278 | there are a variety of representations for floating point numbers. This | |
7279 | means that in a cross-compiler the representation of floating point numbers | |
7280 | in the compiled program may be different from that used in the machine | |
7281 | doing the compilation. | |
7282 | ||
7283 | Because different representation systems may offer different amounts of | |
7284 | range and precision, all floating point constants must be represented in | |
7285 | the target machine's format. Therefore, the cross compiler cannot | |
7286 | safely use the host machine's floating point arithmetic; it must emulate | |
7287 | the target's arithmetic. To ensure consistency, GCC always uses | |
7288 | emulation to work with floating point values, even when the host and | |
7289 | target floating point formats are identical. | |
7290 | ||
7291 | The following macros are provided by @file{real.h} for the compiler to | |
7292 | use. All parts of the compiler which generate or optimize | |
7293 | floating-point calculations must use these macros. They may evaluate | |
7294 | their operands more than once, so operands must not have side effects. | |
7295 | ||
7296 | @defmac REAL_VALUE_TYPE | |
7297 | The C data type to be used to hold a floating point value in the target | |
7298 | machine's format. Typically this is a @code{struct} containing an | |
7299 | array of @code{HOST_WIDE_INT}, but all code should treat it as an opaque | |
7300 | quantity. | |
7301 | @end defmac | |
7302 | ||
7303 | @deftypefn Macro int REAL_VALUES_EQUAL (REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y}) | |
7304 | Compares for equality the two values, @var{x} and @var{y}. If the target | |
7305 | floating point format supports negative zeroes and/or NaNs, | |
7306 | @samp{REAL_VALUES_EQUAL (-0.0, 0.0)} is true, and | |
7307 | @samp{REAL_VALUES_EQUAL (NaN, NaN)} is false. | |
7308 | @end deftypefn | |
7309 | ||
7310 | @deftypefn Macro int REAL_VALUES_LESS (REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y}) | |
7311 | Tests whether @var{x} is less than @var{y}. | |
7312 | @end deftypefn | |
7313 | ||
7314 | @deftypefn Macro HOST_WIDE_INT REAL_VALUE_FIX (REAL_VALUE_TYPE @var{x}) | |
7315 | Truncates @var{x} to a signed integer, rounding toward zero. | |
7316 | @end deftypefn | |
7317 | ||
7318 | @deftypefn Macro {unsigned HOST_WIDE_INT} REAL_VALUE_UNSIGNED_FIX (REAL_VALUE_TYPE @var{x}) | |
7319 | Truncates @var{x} to an unsigned integer, rounding toward zero. If | |
7320 | @var{x} is negative, returns zero. | |
7321 | @end deftypefn | |
7322 | ||
7323 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_ATOF (const char *@var{string}, enum machine_mode @var{mode}) | |
7324 | Converts @var{string} into a floating point number in the target machine's | |
7325 | representation for mode @var{mode}. This routine can handle both | |
7326 | decimal and hexadecimal floating point constants, using the syntax | |
7327 | defined by the C language for both. | |
7328 | @end deftypefn | |
7329 | ||
7330 | @deftypefn Macro int REAL_VALUE_NEGATIVE (REAL_VALUE_TYPE @var{x}) | |
7331 | Returns 1 if @var{x} is negative (including negative zero), 0 otherwise. | |
7332 | @end deftypefn | |
7333 | ||
7334 | @deftypefn Macro int REAL_VALUE_ISINF (REAL_VALUE_TYPE @var{x}) | |
7335 | Determines whether @var{x} represents infinity (positive or negative). | |
7336 | @end deftypefn | |
7337 | ||
7338 | @deftypefn Macro int REAL_VALUE_ISNAN (REAL_VALUE_TYPE @var{x}) | |
7339 | Determines whether @var{x} represents a ``NaN'' (not-a-number). | |
7340 | @end deftypefn | |
7341 | ||
7342 | @deftypefn Macro void REAL_ARITHMETIC (REAL_VALUE_TYPE @var{output}, enum tree_code @var{code}, REAL_VALUE_TYPE @var{x}, REAL_VALUE_TYPE @var{y}) | |
7343 | Calculates an arithmetic operation on the two floating point values | |
7344 | @var{x} and @var{y}, storing the result in @var{output} (which must be a | |
7345 | variable). | |
7346 | ||
7347 | The operation to be performed is specified by @var{code}. Only the | |
7348 | following codes are supported: @code{PLUS_EXPR}, @code{MINUS_EXPR}, | |
7349 | @code{MULT_EXPR}, @code{RDIV_EXPR}, @code{MAX_EXPR}, @code{MIN_EXPR}. | |
7350 | ||
7351 | If @code{REAL_ARITHMETIC} is asked to evaluate division by zero and the | |
7352 | target's floating point format cannot represent infinity, it will call | |
7353 | @code{abort}. Callers should check for this situation first, using | |
7354 | @code{MODE_HAS_INFINITIES}. @xref{Storage Layout}. | |
7355 | @end deftypefn | |
7356 | ||
7357 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_NEGATE (REAL_VALUE_TYPE @var{x}) | |
7358 | Returns the negative of the floating point value @var{x}. | |
7359 | @end deftypefn | |
7360 | ||
7361 | @deftypefn Macro REAL_VALUE_TYPE REAL_VALUE_ABS (REAL_VALUE_TYPE @var{x}) | |
7362 | Returns the absolute value of @var{x}. | |
7363 | @end deftypefn | |
7364 | ||
38f8b050 JR |
7365 | @node Mode Switching |
7366 | @section Mode Switching Instructions | |
7367 | @cindex mode switching | |
7368 | The following macros control mode switching optimizations: | |
7369 | ||
7370 | @defmac OPTIMIZE_MODE_SWITCHING (@var{entity}) | |
7371 | Define this macro if the port needs extra instructions inserted for mode | |
7372 | switching in an optimizing compilation. | |
7373 | ||
7374 | For an example, the SH4 can perform both single and double precision | |
7375 | floating point operations, but to perform a single precision operation, | |
7376 | the FPSCR PR bit has to be cleared, while for a double precision | |
7377 | operation, this bit has to be set. Changing the PR bit requires a general | |
7378 | purpose register as a scratch register, hence these FPSCR sets have to | |
7379 | be inserted before reload, i.e.@: you can't put this into instruction emitting | |
7380 | or @code{TARGET_MACHINE_DEPENDENT_REORG}. | |
7381 | ||
7382 | You can have multiple entities that are mode-switched, and select at run time | |
7383 | which entities actually need it. @code{OPTIMIZE_MODE_SWITCHING} should | |
7384 | return nonzero for any @var{entity} that needs mode-switching. | |
7385 | If you define this macro, you also have to define | |
7386 | @code{NUM_MODES_FOR_MODE_SWITCHING}, @code{MODE_NEEDED}, | |
7387 | @code{MODE_PRIORITY_TO_MODE} and @code{EMIT_MODE_SET}. | |
7388 | @code{MODE_AFTER}, @code{MODE_ENTRY}, and @code{MODE_EXIT} | |
7389 | are optional. | |
7390 | @end defmac | |
7391 | ||
7392 | @defmac NUM_MODES_FOR_MODE_SWITCHING | |
7393 | If you define @code{OPTIMIZE_MODE_SWITCHING}, you have to define this as | |
7394 | initializer for an array of integers. Each initializer element | |
7395 | N refers to an entity that needs mode switching, and specifies the number | |
7396 | of different modes that might need to be set for this entity. | |
7397 | The position of the initializer in the initializer---starting counting at | |
7398 | zero---determines the integer that is used to refer to the mode-switched | |
7399 | entity in question. | |
7400 | In macros that take mode arguments / yield a mode result, modes are | |
7401 | represented as numbers 0 @dots{} N @minus{} 1. N is used to specify that no mode | |
7402 | switch is needed / supplied. | |
7403 | @end defmac | |
7404 | ||
7405 | @defmac MODE_NEEDED (@var{entity}, @var{insn}) | |
7406 | @var{entity} is an integer specifying a mode-switched entity. If | |
7407 | @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro to | |
7408 | return an integer value not larger than the corresponding element in | |
7409 | @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity} must | |
7410 | be switched into prior to the execution of @var{insn}. | |
7411 | @end defmac | |
7412 | ||
9786913b UB |
7413 | @defmac MODE_AFTER (@var{entity}, @var{mode}, @var{insn}) |
7414 | @var{entity} is an integer specifying a mode-switched entity. If | |
7415 | this macro is defined, it is evaluated for every @var{insn} during | |
38f8b050 JR |
7416 | mode switching. It determines the mode that an insn results in (if |
7417 | different from the incoming mode). | |
7418 | @end defmac | |
7419 | ||
7420 | @defmac MODE_ENTRY (@var{entity}) | |
7421 | If this macro is defined, it is evaluated for every @var{entity} that needs | |
7422 | mode switching. It should evaluate to an integer, which is a mode that | |
7423 | @var{entity} is assumed to be switched to at function entry. If @code{MODE_ENTRY} | |
7424 | is defined then @code{MODE_EXIT} must be defined. | |
7425 | @end defmac | |
7426 | ||
7427 | @defmac MODE_EXIT (@var{entity}) | |
7428 | If this macro is defined, it is evaluated for every @var{entity} that needs | |
7429 | mode switching. It should evaluate to an integer, which is a mode that | |
7430 | @var{entity} is assumed to be switched to at function exit. If @code{MODE_EXIT} | |
7431 | is defined then @code{MODE_ENTRY} must be defined. | |
7432 | @end defmac | |
7433 | ||
7434 | @defmac MODE_PRIORITY_TO_MODE (@var{entity}, @var{n}) | |
7435 | This macro specifies the order in which modes for @var{entity} are processed. | |
7436 | 0 is the highest priority, @code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the | |
7437 | lowest. The value of the macro should be an integer designating a mode | |
7438 | for @var{entity}. For any fixed @var{entity}, @code{mode_priority_to_mode} | |
7439 | (@var{entity}, @var{n}) shall be a bijection in 0 @dots{} | |
7440 | @code{num_modes_for_mode_switching[@var{entity}] - 1}. | |
7441 | @end defmac | |
7442 | ||
7443 | @defmac EMIT_MODE_SET (@var{entity}, @var{mode}, @var{hard_regs_live}) | |
7444 | Generate one or more insns to set @var{entity} to @var{mode}. | |
7445 | @var{hard_reg_live} is the set of hard registers live at the point where | |
7446 | the insn(s) are to be inserted. | |
473fd99a JR |
7447 | Sets of a lower numbered entity will be emitted before sets of a higher |
7448 | numbered entity to a mode of the same or lower priority. | |
38f8b050 JR |
7449 | @end defmac |
7450 | ||
7451 | @node Target Attributes | |
7452 | @section Defining target-specific uses of @code{__attribute__} | |
7453 | @cindex target attributes | |
7454 | @cindex machine attributes | |
7455 | @cindex attributes, target-specific | |
7456 | ||
7457 | Target-specific attributes may be defined for functions, data and types. | |
7458 | These are described using the following target hooks; they also need to | |
7459 | be documented in @file{extend.texi}. | |
7460 | ||
7461 | @hook TARGET_ATTRIBUTE_TABLE | |
38f8b050 JR |
7462 | |
7463 | @hook TARGET_ATTRIBUTE_TAKES_IDENTIFIER_P | |
38f8b050 JR |
7464 | |
7465 | @hook TARGET_COMP_TYPE_ATTRIBUTES | |
38f8b050 JR |
7466 | |
7467 | @hook TARGET_SET_DEFAULT_TYPE_ATTRIBUTES | |
38f8b050 JR |
7468 | |
7469 | @hook TARGET_MERGE_TYPE_ATTRIBUTES | |
38f8b050 JR |
7470 | |
7471 | @hook TARGET_MERGE_DECL_ATTRIBUTES | |
38f8b050 JR |
7472 | |
7473 | @hook TARGET_VALID_DLLIMPORT_ATTRIBUTE_P | |
7474 | ||
7475 | @defmac TARGET_DECLSPEC | |
7476 | Define this macro to a nonzero value if you want to treat | |
7477 | @code{__declspec(X)} as equivalent to @code{__attribute((X))}. By | |
7478 | default, this behavior is enabled only for targets that define | |
7479 | @code{TARGET_DLLIMPORT_DECL_ATTRIBUTES}. The current implementation | |
7480 | of @code{__declspec} is via a built-in macro, but you should not rely | |
7481 | on this implementation detail. | |
7482 | @end defmac | |
7483 | ||
7484 | @hook TARGET_INSERT_ATTRIBUTES | |
38f8b050 JR |
7485 | |
7486 | @hook TARGET_FUNCTION_ATTRIBUTE_INLINABLE_P | |
38f8b050 JR |
7487 | |
7488 | @hook TARGET_OPTION_VALID_ATTRIBUTE_P | |
38f8b050 JR |
7489 | |
7490 | @hook TARGET_OPTION_SAVE | |
38f8b050 JR |
7491 | |
7492 | @hook TARGET_OPTION_RESTORE | |
38f8b050 JR |
7493 | |
7494 | @hook TARGET_OPTION_PRINT | |
38f8b050 | 7495 | |
56cb42ea | 7496 | @hook TARGET_OPTION_PRAGMA_PARSE |
38f8b050 JR |
7497 | |
7498 | @hook TARGET_OPTION_OVERRIDE | |
38f8b050 | 7499 | |
3649b9b7 | 7500 | @hook TARGET_OPTION_FUNCTION_VERSIONS |
3649b9b7 | 7501 | |
38f8b050 | 7502 | @hook TARGET_CAN_INLINE_P |
38f8b050 JR |
7503 | |
7504 | @node Emulated TLS | |
7505 | @section Emulating TLS | |
7506 | @cindex Emulated TLS | |
7507 | ||
7508 | For targets whose psABI does not provide Thread Local Storage via | |
7509 | specific relocations and instruction sequences, an emulation layer is | |
7510 | used. A set of target hooks allows this emulation layer to be | |
7511 | configured for the requirements of a particular target. For instance | |
7512 | the psABI may in fact specify TLS support in terms of an emulation | |
7513 | layer. | |
7514 | ||
7515 | The emulation layer works by creating a control object for every TLS | |
7516 | object. To access the TLS object, a lookup function is provided | |
7517 | which, when given the address of the control object, will return the | |
7518 | address of the current thread's instance of the TLS object. | |
7519 | ||
7520 | @hook TARGET_EMUTLS_GET_ADDRESS | |
38f8b050 JR |
7521 | |
7522 | @hook TARGET_EMUTLS_REGISTER_COMMON | |
38f8b050 JR |
7523 | |
7524 | @hook TARGET_EMUTLS_VAR_SECTION | |
38f8b050 JR |
7525 | |
7526 | @hook TARGET_EMUTLS_TMPL_SECTION | |
38f8b050 JR |
7527 | |
7528 | @hook TARGET_EMUTLS_VAR_PREFIX | |
38f8b050 JR |
7529 | |
7530 | @hook TARGET_EMUTLS_TMPL_PREFIX | |
38f8b050 JR |
7531 | |
7532 | @hook TARGET_EMUTLS_VAR_FIELDS | |
38f8b050 JR |
7533 | |
7534 | @hook TARGET_EMUTLS_VAR_INIT | |
38f8b050 JR |
7535 | |
7536 | @hook TARGET_EMUTLS_VAR_ALIGN_FIXED | |
38f8b050 JR |
7537 | |
7538 | @hook TARGET_EMUTLS_DEBUG_FORM_TLS_ADDRESS | |
38f8b050 JR |
7539 | |
7540 | @node MIPS Coprocessors | |
7541 | @section Defining coprocessor specifics for MIPS targets. | |
7542 | @cindex MIPS coprocessor-definition macros | |
7543 | ||
7544 | The MIPS specification allows MIPS implementations to have as many as 4 | |
7545 | coprocessors, each with as many as 32 private registers. GCC supports | |
7546 | accessing these registers and transferring values between the registers | |
7547 | and memory using asm-ized variables. For example: | |
7548 | ||
7549 | @smallexample | |
7550 | register unsigned int cp0count asm ("c0r1"); | |
7551 | unsigned int d; | |
7552 | ||
7553 | d = cp0count + 3; | |
7554 | @end smallexample | |
7555 | ||
7556 | (``c0r1'' is the default name of register 1 in coprocessor 0; alternate | |
7557 | names may be added as described below, or the default names may be | |
7558 | overridden entirely in @code{SUBTARGET_CONDITIONAL_REGISTER_USAGE}.) | |
7559 | ||
7560 | Coprocessor registers are assumed to be epilogue-used; sets to them will | |
7561 | be preserved even if it does not appear that the register is used again | |
7562 | later in the function. | |
7563 | ||
7564 | Another note: according to the MIPS spec, coprocessor 1 (if present) is | |
7565 | the FPU@. One accesses COP1 registers through standard mips | |
7566 | floating-point support; they are not included in this mechanism. | |
7567 | ||
7568 | There is one macro used in defining the MIPS coprocessor interface which | |
7569 | you may want to override in subtargets; it is described below. | |
7570 | ||
38f8b050 JR |
7571 | @node PCH Target |
7572 | @section Parameters for Precompiled Header Validity Checking | |
7573 | @cindex parameters, precompiled headers | |
7574 | ||
7575 | @hook TARGET_GET_PCH_VALIDITY | |
38f8b050 JR |
7576 | |
7577 | @hook TARGET_PCH_VALID_P | |
38f8b050 JR |
7578 | |
7579 | @hook TARGET_CHECK_PCH_TARGET_FLAGS | |
38f8b050 | 7580 | |
e32ea2d1 RS |
7581 | @hook TARGET_PREPARE_PCH_SAVE |
7582 | ||
38f8b050 JR |
7583 | @node C++ ABI |
7584 | @section C++ ABI parameters | |
7585 | @cindex parameters, c++ abi | |
7586 | ||
7587 | @hook TARGET_CXX_GUARD_TYPE | |
38f8b050 JR |
7588 | |
7589 | @hook TARGET_CXX_GUARD_MASK_BIT | |
38f8b050 JR |
7590 | |
7591 | @hook TARGET_CXX_GET_COOKIE_SIZE | |
38f8b050 JR |
7592 | |
7593 | @hook TARGET_CXX_COOKIE_HAS_SIZE | |
38f8b050 JR |
7594 | |
7595 | @hook TARGET_CXX_IMPORT_EXPORT_CLASS | |
38f8b050 JR |
7596 | |
7597 | @hook TARGET_CXX_CDTOR_RETURNS_THIS | |
38f8b050 JR |
7598 | |
7599 | @hook TARGET_CXX_KEY_METHOD_MAY_BE_INLINE | |
38f8b050 JR |
7600 | |
7601 | @hook TARGET_CXX_DETERMINE_CLASS_DATA_VISIBILITY | |
7602 | ||
7603 | @hook TARGET_CXX_CLASS_DATA_ALWAYS_COMDAT | |
38f8b050 JR |
7604 | |
7605 | @hook TARGET_CXX_LIBRARY_RTTI_COMDAT | |
38f8b050 JR |
7606 | |
7607 | @hook TARGET_CXX_USE_AEABI_ATEXIT | |
38f8b050 JR |
7608 | |
7609 | @hook TARGET_CXX_USE_ATEXIT_FOR_CXA_ATEXIT | |
38f8b050 JR |
7610 | |
7611 | @hook TARGET_CXX_ADJUST_CLASS_AT_DEFINITION | |
7612 | ||
17c4f786 AS |
7613 | @hook TARGET_CXX_DECL_MANGLING_CONTEXT |
7614 | ||
38f8b050 JR |
7615 | @node Named Address Spaces |
7616 | @section Adding support for named address spaces | |
7617 | @cindex named address spaces | |
7618 | ||
7619 | The draft technical report of the ISO/IEC JTC1 S22 WG14 N1275 | |
7620 | standards committee, @cite{Programming Languages - C - Extensions to | |
7621 | support embedded processors}, specifies a syntax for embedded | |
7622 | processors to specify alternate address spaces. You can configure a | |
7623 | GCC port to support section 5.1 of the draft report to add support for | |
7624 | address spaces other than the default address space. These address | |
7625 | spaces are new keywords that are similar to the @code{volatile} and | |
7626 | @code{const} type attributes. | |
7627 | ||
7628 | Pointers to named address spaces can have a different size than | |
7629 | pointers to the generic address space. | |
7630 | ||
7631 | For example, the SPU port uses the @code{__ea} address space to refer | |
7632 | to memory in the host processor, rather than memory local to the SPU | |
7633 | processor. Access to memory in the @code{__ea} address space involves | |
7634 | issuing DMA operations to move data between the host processor and the | |
7635 | local processor memory address space. Pointers in the @code{__ea} | |
7636 | address space are either 32 bits or 64 bits based on the | |
7637 | @option{-mea32} or @option{-mea64} switches (native SPU pointers are | |
7638 | always 32 bits). | |
7639 | ||
7640 | Internally, address spaces are represented as a small integer in the | |
7641 | range 0 to 15 with address space 0 being reserved for the generic | |
7642 | address space. | |
7643 | ||
7644 | To register a named address space qualifier keyword with the C front end, | |
7645 | the target may call the @code{c_register_addr_space} routine. For example, | |
7646 | the SPU port uses the following to declare @code{__ea} as the keyword for | |
7647 | named address space #1: | |
7648 | @smallexample | |
7649 | #define ADDR_SPACE_EA 1 | |
7650 | c_register_addr_space ("__ea", ADDR_SPACE_EA); | |
7651 | @end smallexample | |
7652 | ||
7653 | @hook TARGET_ADDR_SPACE_POINTER_MODE | |
38f8b050 JR |
7654 | |
7655 | @hook TARGET_ADDR_SPACE_ADDRESS_MODE | |
38f8b050 JR |
7656 | |
7657 | @hook TARGET_ADDR_SPACE_VALID_POINTER_MODE | |
38f8b050 JR |
7658 | |
7659 | @hook TARGET_ADDR_SPACE_LEGITIMATE_ADDRESS_P | |
38f8b050 JR |
7660 | |
7661 | @hook TARGET_ADDR_SPACE_LEGITIMIZE_ADDRESS | |
38f8b050 JR |
7662 | |
7663 | @hook TARGET_ADDR_SPACE_SUBSET_P | |
38f8b050 JR |
7664 | |
7665 | @hook TARGET_ADDR_SPACE_CONVERT | |
38f8b050 JR |
7666 | |
7667 | @node Misc | |
7668 | @section Miscellaneous Parameters | |
7669 | @cindex parameters, miscellaneous | |
7670 | ||
7671 | @c prevent bad page break with this line | |
7672 | Here are several miscellaneous parameters. | |
7673 | ||
7674 | @defmac HAS_LONG_COND_BRANCH | |
7675 | Define this boolean macro to indicate whether or not your architecture | |
7676 | has conditional branches that can span all of memory. It is used in | |
7677 | conjunction with an optimization that partitions hot and cold basic | |
7678 | blocks into separate sections of the executable. If this macro is | |
7679 | set to false, gcc will convert any conditional branches that attempt | |
7680 | to cross between sections into unconditional branches or indirect jumps. | |
7681 | @end defmac | |
7682 | ||
7683 | @defmac HAS_LONG_UNCOND_BRANCH | |
7684 | Define this boolean macro to indicate whether or not your architecture | |
7685 | has unconditional branches that can span all of memory. It is used in | |
7686 | conjunction with an optimization that partitions hot and cold basic | |
7687 | blocks into separate sections of the executable. If this macro is | |
7688 | set to false, gcc will convert any unconditional branches that attempt | |
7689 | to cross between sections into indirect jumps. | |
7690 | @end defmac | |
7691 | ||
7692 | @defmac CASE_VECTOR_MODE | |
7693 | An alias for a machine mode name. This is the machine mode that | |
7694 | elements of a jump-table should have. | |
7695 | @end defmac | |
7696 | ||
7697 | @defmac CASE_VECTOR_SHORTEN_MODE (@var{min_offset}, @var{max_offset}, @var{body}) | |
7698 | Optional: return the preferred mode for an @code{addr_diff_vec} | |
7699 | when the minimum and maximum offset are known. If you define this, | |
7700 | it enables extra code in branch shortening to deal with @code{addr_diff_vec}. | |
7701 | To make this work, you also have to define @code{INSN_ALIGN} and | |
7702 | make the alignment for @code{addr_diff_vec} explicit. | |
7703 | The @var{body} argument is provided so that the offset_unsigned and scale | |
7704 | flags can be updated. | |
7705 | @end defmac | |
7706 | ||
7707 | @defmac CASE_VECTOR_PC_RELATIVE | |
7708 | Define this macro to be a C expression to indicate when jump-tables | |
7709 | should contain relative addresses. You need not define this macro if | |
7710 | jump-tables never contain relative addresses, or jump-tables should | |
7711 | contain relative addresses only when @option{-fPIC} or @option{-fPIC} | |
7712 | is in effect. | |
7713 | @end defmac | |
7714 | ||
7715 | @hook TARGET_CASE_VALUES_THRESHOLD | |
38f8b050 | 7716 | |
38f8b050 JR |
7717 | @defmac WORD_REGISTER_OPERATIONS |
7718 | Define this macro if operations between registers with integral mode | |
7719 | smaller than a word are always performed on the entire register. | |
7720 | Most RISC machines have this property and most CISC machines do not. | |
7721 | @end defmac | |
7722 | ||
7723 | @defmac LOAD_EXTEND_OP (@var{mem_mode}) | |
7724 | Define this macro to be a C expression indicating when insns that read | |
7725 | memory in @var{mem_mode}, an integral mode narrower than a word, set the | |
7726 | bits outside of @var{mem_mode} to be either the sign-extension or the | |
7727 | zero-extension of the data read. Return @code{SIGN_EXTEND} for values | |
7728 | of @var{mem_mode} for which the | |
7729 | insn sign-extends, @code{ZERO_EXTEND} for which it zero-extends, and | |
7730 | @code{UNKNOWN} for other modes. | |
7731 | ||
7732 | This macro is not called with @var{mem_mode} non-integral or with a width | |
7733 | greater than or equal to @code{BITS_PER_WORD}, so you may return any | |
7734 | value in this case. Do not define this macro if it would always return | |
7735 | @code{UNKNOWN}. On machines where this macro is defined, you will normally | |
7736 | define it as the constant @code{SIGN_EXTEND} or @code{ZERO_EXTEND}. | |
7737 | ||
7738 | You may return a non-@code{UNKNOWN} value even if for some hard registers | |
7739 | the sign extension is not performed, if for the @code{REGNO_REG_CLASS} | |
7740 | of these hard registers @code{CANNOT_CHANGE_MODE_CLASS} returns nonzero | |
7741 | when the @var{from} mode is @var{mem_mode} and the @var{to} mode is any | |
7742 | integral mode larger than this but not larger than @code{word_mode}. | |
7743 | ||
7744 | You must return @code{UNKNOWN} if for some hard registers that allow this | |
7745 | mode, @code{CANNOT_CHANGE_MODE_CLASS} says that they cannot change to | |
7746 | @code{word_mode}, but that they can change to another integral mode that | |
7747 | is larger then @var{mem_mode} but still smaller than @code{word_mode}. | |
7748 | @end defmac | |
7749 | ||
7750 | @defmac SHORT_IMMEDIATES_SIGN_EXTEND | |
7751 | Define this macro if loading short immediate values into registers sign | |
7752 | extends. | |
7753 | @end defmac | |
7754 | ||
38f8b050 | 7755 | @hook TARGET_MIN_DIVISIONS_FOR_RECIP_MUL |
38f8b050 JR |
7756 | |
7757 | @defmac MOVE_MAX | |
7758 | The maximum number of bytes that a single instruction can move quickly | |
7759 | between memory and registers or between two memory locations. | |
7760 | @end defmac | |
7761 | ||
7762 | @defmac MAX_MOVE_MAX | |
7763 | The maximum number of bytes that a single instruction can move quickly | |
7764 | between memory and registers or between two memory locations. If this | |
7765 | is undefined, the default is @code{MOVE_MAX}. Otherwise, it is the | |
7766 | constant value that is the largest value that @code{MOVE_MAX} can have | |
7767 | at run-time. | |
7768 | @end defmac | |
7769 | ||
7770 | @defmac SHIFT_COUNT_TRUNCATED | |
7771 | A C expression that is nonzero if on this machine the number of bits | |
7772 | actually used for the count of a shift operation is equal to the number | |
7773 | of bits needed to represent the size of the object being shifted. When | |
7774 | this macro is nonzero, the compiler will assume that it is safe to omit | |
7775 | a sign-extend, zero-extend, and certain bitwise `and' instructions that | |
7776 | truncates the count of a shift operation. On machines that have | |
7777 | instructions that act on bit-fields at variable positions, which may | |
7778 | include `bit test' instructions, a nonzero @code{SHIFT_COUNT_TRUNCATED} | |
7779 | also enables deletion of truncations of the values that serve as | |
7780 | arguments to bit-field instructions. | |
7781 | ||
7782 | If both types of instructions truncate the count (for shifts) and | |
7783 | position (for bit-field operations), or if no variable-position bit-field | |
7784 | instructions exist, you should define this macro. | |
7785 | ||
7786 | However, on some machines, such as the 80386 and the 680x0, truncation | |
7787 | only applies to shift operations and not the (real or pretended) | |
7788 | bit-field operations. Define @code{SHIFT_COUNT_TRUNCATED} to be zero on | |
7789 | such machines. Instead, add patterns to the @file{md} file that include | |
7790 | the implied truncation of the shift instructions. | |
7791 | ||
7792 | You need not define this macro if it would always have the value of zero. | |
7793 | @end defmac | |
7794 | ||
7795 | @anchor{TARGET_SHIFT_TRUNCATION_MASK} | |
7796 | @hook TARGET_SHIFT_TRUNCATION_MASK | |
38f8b050 JR |
7797 | |
7798 | @defmac TRULY_NOOP_TRUNCATION (@var{outprec}, @var{inprec}) | |
7799 | A C expression which is nonzero if on this machine it is safe to | |
7800 | ``convert'' an integer of @var{inprec} bits to one of @var{outprec} | |
7801 | bits (where @var{outprec} is smaller than @var{inprec}) by merely | |
7802 | operating on it as if it had only @var{outprec} bits. | |
7803 | ||
7804 | On many machines, this expression can be 1. | |
7805 | ||
7806 | @c rearranged this, removed the phrase "it is reported that". this was | |
7807 | @c to fix an overfull hbox. --mew 10feb93 | |
7808 | When @code{TRULY_NOOP_TRUNCATION} returns 1 for a pair of sizes for | |
7809 | modes for which @code{MODES_TIEABLE_P} is 0, suboptimal code can result. | |
7810 | If this is the case, making @code{TRULY_NOOP_TRUNCATION} return 0 in | |
7811 | such cases may improve things. | |
7812 | @end defmac | |
7813 | ||
7814 | @hook TARGET_MODE_REP_EXTENDED | |
38f8b050 JR |
7815 | |
7816 | @defmac STORE_FLAG_VALUE | |
7817 | A C expression describing the value returned by a comparison operator | |
7818 | with an integral mode and stored by a store-flag instruction | |
7819 | (@samp{cstore@var{mode}4}) when the condition is true. This description must | |
7820 | apply to @emph{all} the @samp{cstore@var{mode}4} patterns and all the | |
7821 | comparison operators whose results have a @code{MODE_INT} mode. | |
7822 | ||
7823 | A value of 1 or @minus{}1 means that the instruction implementing the | |
7824 | comparison operator returns exactly 1 or @minus{}1 when the comparison is true | |
7825 | and 0 when the comparison is false. Otherwise, the value indicates | |
7826 | which bits of the result are guaranteed to be 1 when the comparison is | |
7827 | true. This value is interpreted in the mode of the comparison | |
7828 | operation, which is given by the mode of the first operand in the | |
7829 | @samp{cstore@var{mode}4} pattern. Either the low bit or the sign bit of | |
7830 | @code{STORE_FLAG_VALUE} be on. Presently, only those bits are used by | |
7831 | the compiler. | |
7832 | ||
7833 | If @code{STORE_FLAG_VALUE} is neither 1 or @minus{}1, the compiler will | |
7834 | generate code that depends only on the specified bits. It can also | |
7835 | replace comparison operators with equivalent operations if they cause | |
7836 | the required bits to be set, even if the remaining bits are undefined. | |
7837 | For example, on a machine whose comparison operators return an | |
7838 | @code{SImode} value and where @code{STORE_FLAG_VALUE} is defined as | |
7839 | @samp{0x80000000}, saying that just the sign bit is relevant, the | |
7840 | expression | |
7841 | ||
7842 | @smallexample | |
7843 | (ne:SI (and:SI @var{x} (const_int @var{power-of-2})) (const_int 0)) | |
7844 | @end smallexample | |
7845 | ||
7846 | @noindent | |
7847 | can be converted to | |
7848 | ||
7849 | @smallexample | |
7850 | (ashift:SI @var{x} (const_int @var{n})) | |
7851 | @end smallexample | |
7852 | ||
7853 | @noindent | |
7854 | where @var{n} is the appropriate shift count to move the bit being | |
7855 | tested into the sign bit. | |
7856 | ||
7857 | There is no way to describe a machine that always sets the low-order bit | |
7858 | for a true value, but does not guarantee the value of any other bits, | |
7859 | but we do not know of any machine that has such an instruction. If you | |
7860 | are trying to port GCC to such a machine, include an instruction to | |
7861 | perform a logical-and of the result with 1 in the pattern for the | |
7862 | comparison operators and let us know at @email{gcc@@gcc.gnu.org}. | |
7863 | ||
7864 | Often, a machine will have multiple instructions that obtain a value | |
7865 | from a comparison (or the condition codes). Here are rules to guide the | |
7866 | choice of value for @code{STORE_FLAG_VALUE}, and hence the instructions | |
7867 | to be used: | |
7868 | ||
7869 | @itemize @bullet | |
7870 | @item | |
7871 | Use the shortest sequence that yields a valid definition for | |
7872 | @code{STORE_FLAG_VALUE}. It is more efficient for the compiler to | |
7873 | ``normalize'' the value (convert it to, e.g., 1 or 0) than for the | |
7874 | comparison operators to do so because there may be opportunities to | |
7875 | combine the normalization with other operations. | |
7876 | ||
7877 | @item | |
7878 | For equal-length sequences, use a value of 1 or @minus{}1, with @minus{}1 being | |
7879 | slightly preferred on machines with expensive jumps and 1 preferred on | |
7880 | other machines. | |
7881 | ||
7882 | @item | |
7883 | As a second choice, choose a value of @samp{0x80000001} if instructions | |
7884 | exist that set both the sign and low-order bits but do not define the | |
7885 | others. | |
7886 | ||
7887 | @item | |
7888 | Otherwise, use a value of @samp{0x80000000}. | |
7889 | @end itemize | |
7890 | ||
7891 | Many machines can produce both the value chosen for | |
7892 | @code{STORE_FLAG_VALUE} and its negation in the same number of | |
7893 | instructions. On those machines, you should also define a pattern for | |
7894 | those cases, e.g., one matching | |
7895 | ||
7896 | @smallexample | |
7897 | (set @var{A} (neg:@var{m} (ne:@var{m} @var{B} @var{C}))) | |
7898 | @end smallexample | |
7899 | ||
7900 | Some machines can also perform @code{and} or @code{plus} operations on | |
7901 | condition code values with less instructions than the corresponding | |
7902 | @samp{cstore@var{mode}4} insn followed by @code{and} or @code{plus}. On those | |
7903 | machines, define the appropriate patterns. Use the names @code{incscc} | |
7904 | and @code{decscc}, respectively, for the patterns which perform | |
7905 | @code{plus} or @code{minus} operations on condition code values. See | |
2b0d3573 | 7906 | @file{rs6000.md} for some examples. The GNU Superoptimizer can be used to |
38f8b050 JR |
7907 | find such instruction sequences on other machines. |
7908 | ||
7909 | If this macro is not defined, the default value, 1, is used. You need | |
7910 | not define @code{STORE_FLAG_VALUE} if the machine has no store-flag | |
7911 | instructions, or if the value generated by these instructions is 1. | |
7912 | @end defmac | |
7913 | ||
7914 | @defmac FLOAT_STORE_FLAG_VALUE (@var{mode}) | |
7915 | A C expression that gives a nonzero @code{REAL_VALUE_TYPE} value that is | |
7916 | returned when comparison operators with floating-point results are true. | |
7917 | Define this macro on machines that have comparison operations that return | |
7918 | floating-point values. If there are no such operations, do not define | |
7919 | this macro. | |
7920 | @end defmac | |
7921 | ||
7922 | @defmac VECTOR_STORE_FLAG_VALUE (@var{mode}) | |
7923 | A C expression that gives a rtx representing the nonzero true element | |
7924 | for vector comparisons. The returned rtx should be valid for the inner | |
7925 | mode of @var{mode} which is guaranteed to be a vector mode. Define | |
7926 | this macro on machines that have vector comparison operations that | |
7927 | return a vector result. If there are no such operations, do not define | |
7928 | this macro. Typically, this macro is defined as @code{const1_rtx} or | |
7929 | @code{constm1_rtx}. This macro may return @code{NULL_RTX} to prevent | |
7930 | the compiler optimizing such vector comparison operations for the | |
7931 | given mode. | |
7932 | @end defmac | |
7933 | ||
7934 | @defmac CLZ_DEFINED_VALUE_AT_ZERO (@var{mode}, @var{value}) | |
7935 | @defmacx CTZ_DEFINED_VALUE_AT_ZERO (@var{mode}, @var{value}) | |
7936 | A C expression that indicates whether the architecture defines a value | |
ff2ce160 | 7937 | for @code{clz} or @code{ctz} with a zero operand. |
38f8b050 JR |
7938 | A result of @code{0} indicates the value is undefined. |
7939 | If the value is defined for only the RTL expression, the macro should | |
7940 | evaluate to @code{1}; if the value applies also to the corresponding optab | |
7941 | entry (which is normally the case if it expands directly into | |
ff2ce160 | 7942 | the corresponding RTL), then the macro should evaluate to @code{2}. |
38f8b050 | 7943 | In the cases where the value is defined, @var{value} should be set to |
ff2ce160 | 7944 | this value. |
38f8b050 JR |
7945 | |
7946 | If this macro is not defined, the value of @code{clz} or | |
7947 | @code{ctz} at zero is assumed to be undefined. | |
7948 | ||
7949 | This macro must be defined if the target's expansion for @code{ffs} | |
7950 | relies on a particular value to get correct results. Otherwise it | |
7951 | is not necessary, though it may be used to optimize some corner cases, and | |
7952 | to provide a default expansion for the @code{ffs} optab. | |
7953 | ||
7954 | Note that regardless of this macro the ``definedness'' of @code{clz} | |
7955 | and @code{ctz} at zero do @emph{not} extend to the builtin functions | |
7956 | visible to the user. Thus one may be free to adjust the value at will | |
7957 | to match the target expansion of these operations without fear of | |
7958 | breaking the API@. | |
7959 | @end defmac | |
7960 | ||
7961 | @defmac Pmode | |
7962 | An alias for the machine mode for pointers. On most machines, define | |
7963 | this to be the integer mode corresponding to the width of a hardware | |
7964 | pointer; @code{SImode} on 32-bit machine or @code{DImode} on 64-bit machines. | |
7965 | On some machines you must define this to be one of the partial integer | |
7966 | modes, such as @code{PSImode}. | |
7967 | ||
7968 | The width of @code{Pmode} must be at least as large as the value of | |
7969 | @code{POINTER_SIZE}. If it is not equal, you must define the macro | |
7970 | @code{POINTERS_EXTEND_UNSIGNED} to specify how pointers are extended | |
7971 | to @code{Pmode}. | |
7972 | @end defmac | |
7973 | ||
7974 | @defmac FUNCTION_MODE | |
7975 | An alias for the machine mode used for memory references to functions | |
7976 | being called, in @code{call} RTL expressions. On most CISC machines, | |
ff2ce160 | 7977 | where an instruction can begin at any byte address, this should be |
38f8b050 JR |
7978 | @code{QImode}. On most RISC machines, where all instructions have fixed |
7979 | size and alignment, this should be a mode with the same size and alignment | |
7980 | as the machine instruction words - typically @code{SImode} or @code{HImode}. | |
7981 | @end defmac | |
7982 | ||
7983 | @defmac STDC_0_IN_SYSTEM_HEADERS | |
7984 | In normal operation, the preprocessor expands @code{__STDC__} to the | |
7985 | constant 1, to signify that GCC conforms to ISO Standard C@. On some | |
7986 | hosts, like Solaris, the system compiler uses a different convention, | |
7987 | where @code{__STDC__} is normally 0, but is 1 if the user specifies | |
7988 | strict conformance to the C Standard. | |
7989 | ||
7990 | Defining @code{STDC_0_IN_SYSTEM_HEADERS} makes GNU CPP follows the host | |
7991 | convention when processing system header files, but when processing user | |
7992 | files @code{__STDC__} will always expand to 1. | |
7993 | @end defmac | |
7994 | ||
1efcb8c6 JM |
7995 | @hook TARGET_C_PREINCLUDE |
7996 | ||
88b0e79e JC |
7997 | @hook TARGET_CXX_IMPLICIT_EXTERN_C |
7998 | ||
38f8b050 JR |
7999 | @defmac NO_IMPLICIT_EXTERN_C |
8000 | Define this macro if the system header files support C++ as well as C@. | |
8001 | This macro inhibits the usual method of using system header files in | |
8002 | C++, which is to pretend that the file's contents are enclosed in | |
8003 | @samp{extern "C" @{@dots{}@}}. | |
8004 | @end defmac | |
8005 | ||
8006 | @findex #pragma | |
8007 | @findex pragma | |
8008 | @defmac REGISTER_TARGET_PRAGMAS () | |
8009 | Define this macro if you want to implement any target-specific pragmas. | |
8010 | If defined, it is a C expression which makes a series of calls to | |
8011 | @code{c_register_pragma} or @code{c_register_pragma_with_expansion} | |
8012 | for each pragma. The macro may also do any | |
8013 | setup required for the pragmas. | |
8014 | ||
8015 | The primary reason to define this macro is to provide compatibility with | |
8016 | other compilers for the same target. In general, we discourage | |
8017 | definition of target-specific pragmas for GCC@. | |
8018 | ||
8019 | If the pragma can be implemented by attributes then you should consider | |
8020 | defining the target hook @samp{TARGET_INSERT_ATTRIBUTES} as well. | |
8021 | ||
8022 | Preprocessor macros that appear on pragma lines are not expanded. All | |
8023 | @samp{#pragma} directives that do not match any registered pragma are | |
8024 | silently ignored, unless the user specifies @option{-Wunknown-pragmas}. | |
8025 | @end defmac | |
8026 | ||
8027 | @deftypefun void c_register_pragma (const char *@var{space}, const char *@var{name}, void (*@var{callback}) (struct cpp_reader *)) | |
8028 | @deftypefunx void c_register_pragma_with_expansion (const char *@var{space}, const char *@var{name}, void (*@var{callback}) (struct cpp_reader *)) | |
8029 | ||
8030 | Each call to @code{c_register_pragma} or | |
8031 | @code{c_register_pragma_with_expansion} establishes one pragma. The | |
8032 | @var{callback} routine will be called when the preprocessor encounters a | |
8033 | pragma of the form | |
8034 | ||
8035 | @smallexample | |
8036 | #pragma [@var{space}] @var{name} @dots{} | |
8037 | @end smallexample | |
8038 | ||
8039 | @var{space} is the case-sensitive namespace of the pragma, or | |
8040 | @code{NULL} to put the pragma in the global namespace. The callback | |
8041 | routine receives @var{pfile} as its first argument, which can be passed | |
8042 | on to cpplib's functions if necessary. You can lex tokens after the | |
8043 | @var{name} by calling @code{pragma_lex}. Tokens that are not read by the | |
8044 | callback will be silently ignored. The end of the line is indicated by | |
8045 | a token of type @code{CPP_EOF}. Macro expansion occurs on the | |
8046 | arguments of pragmas registered with | |
8047 | @code{c_register_pragma_with_expansion} but not on the arguments of | |
8048 | pragmas registered with @code{c_register_pragma}. | |
8049 | ||
8050 | Note that the use of @code{pragma_lex} is specific to the C and C++ | |
8051 | compilers. It will not work in the Java or Fortran compilers, or any | |
8052 | other language compilers for that matter. Thus if @code{pragma_lex} is going | |
8053 | to be called from target-specific code, it must only be done so when | |
8054 | building the C and C++ compilers. This can be done by defining the | |
8055 | variables @code{c_target_objs} and @code{cxx_target_objs} in the | |
8056 | target entry in the @file{config.gcc} file. These variables should name | |
8057 | the target-specific, language-specific object file which contains the | |
8058 | code that uses @code{pragma_lex}. Note it will also be necessary to add a | |
8059 | rule to the makefile fragment pointed to by @code{tmake_file} that shows | |
8060 | how to build this object file. | |
8061 | @end deftypefun | |
8062 | ||
38f8b050 | 8063 | @defmac HANDLE_PRAGMA_PACK_WITH_EXPANSION |
24a57808 | 8064 | Define this macro if macros should be expanded in the |
38f8b050 JR |
8065 | arguments of @samp{#pragma pack}. |
8066 | @end defmac | |
8067 | ||
38f8b050 JR |
8068 | @defmac TARGET_DEFAULT_PACK_STRUCT |
8069 | If your target requires a structure packing default other than 0 (meaning | |
8070 | the machine default), define this macro to the necessary value (in bytes). | |
8071 | This must be a value that would also be valid to use with | |
8072 | @samp{#pragma pack()} (that is, a small power of two). | |
8073 | @end defmac | |
8074 | ||
8075 | @defmac DOLLARS_IN_IDENTIFIERS | |
8076 | Define this macro to control use of the character @samp{$} in | |
8077 | identifier names for the C family of languages. 0 means @samp{$} is | |
8078 | not allowed by default; 1 means it is allowed. 1 is the default; | |
8079 | there is no need to define this macro in that case. | |
8080 | @end defmac | |
8081 | ||
38f8b050 JR |
8082 | @defmac INSN_SETS_ARE_DELAYED (@var{insn}) |
8083 | Define this macro as a C expression that is nonzero if it is safe for the | |
8084 | delay slot scheduler to place instructions in the delay slot of @var{insn}, | |
8085 | even if they appear to use a resource set or clobbered in @var{insn}. | |
8086 | @var{insn} is always a @code{jump_insn} or an @code{insn}; GCC knows that | |
8087 | every @code{call_insn} has this behavior. On machines where some @code{insn} | |
8088 | or @code{jump_insn} is really a function call and hence has this behavior, | |
8089 | you should define this macro. | |
8090 | ||
8091 | You need not define this macro if it would always return zero. | |
8092 | @end defmac | |
8093 | ||
8094 | @defmac INSN_REFERENCES_ARE_DELAYED (@var{insn}) | |
8095 | Define this macro as a C expression that is nonzero if it is safe for the | |
8096 | delay slot scheduler to place instructions in the delay slot of @var{insn}, | |
8097 | even if they appear to set or clobber a resource referenced in @var{insn}. | |
8098 | @var{insn} is always a @code{jump_insn} or an @code{insn}. On machines where | |
8099 | some @code{insn} or @code{jump_insn} is really a function call and its operands | |
8100 | are registers whose use is actually in the subroutine it calls, you should | |
8101 | define this macro. Doing so allows the delay slot scheduler to move | |
8102 | instructions which copy arguments into the argument registers into the delay | |
8103 | slot of @var{insn}. | |
8104 | ||
8105 | You need not define this macro if it would always return zero. | |
8106 | @end defmac | |
8107 | ||
8108 | @defmac MULTIPLE_SYMBOL_SPACES | |
8109 | Define this macro as a C expression that is nonzero if, in some cases, | |
8110 | global symbols from one translation unit may not be bound to undefined | |
8111 | symbols in another translation unit without user intervention. For | |
8112 | instance, under Microsoft Windows symbols must be explicitly imported | |
8113 | from shared libraries (DLLs). | |
8114 | ||
8115 | You need not define this macro if it would always evaluate to zero. | |
8116 | @end defmac | |
8117 | ||
8118 | @hook TARGET_MD_ASM_CLOBBERS | |
38f8b050 JR |
8119 | |
8120 | @defmac MATH_LIBRARY | |
8121 | Define this macro as a C string constant for the linker argument to link | |
d9d16a19 JM |
8122 | in the system math library, minus the initial @samp{"-l"}, or |
8123 | @samp{""} if the target does not have a | |
38f8b050 JR |
8124 | separate math library. |
8125 | ||
d9d16a19 | 8126 | You need only define this macro if the default of @samp{"m"} is wrong. |
38f8b050 JR |
8127 | @end defmac |
8128 | ||
8129 | @defmac LIBRARY_PATH_ENV | |
8130 | Define this macro as a C string constant for the environment variable that | |
8131 | specifies where the linker should look for libraries. | |
8132 | ||
8133 | You need only define this macro if the default of @samp{"LIBRARY_PATH"} | |
8134 | is wrong. | |
8135 | @end defmac | |
8136 | ||
8137 | @defmac TARGET_POSIX_IO | |
8138 | Define this macro if the target supports the following POSIX@ file | |
8139 | functions, access, mkdir and file locking with fcntl / F_SETLKW@. | |
8140 | Defining @code{TARGET_POSIX_IO} will enable the test coverage code | |
8141 | to use file locking when exiting a program, which avoids race conditions | |
8142 | if the program has forked. It will also create directories at run-time | |
8143 | for cross-profiling. | |
8144 | @end defmac | |
8145 | ||
8146 | @defmac MAX_CONDITIONAL_EXECUTE | |
8147 | ||
8148 | A C expression for the maximum number of instructions to execute via | |
8149 | conditional execution instructions instead of a branch. A value of | |
8150 | @code{BRANCH_COST}+1 is the default if the machine does not use cc0, and | |
8151 | 1 if it does use cc0. | |
8152 | @end defmac | |
8153 | ||
8154 | @defmac IFCVT_MODIFY_TESTS (@var{ce_info}, @var{true_expr}, @var{false_expr}) | |
8155 | Used if the target needs to perform machine-dependent modifications on the | |
8156 | conditionals used for turning basic blocks into conditionally executed code. | |
8157 | @var{ce_info} points to a data structure, @code{struct ce_if_block}, which | |
8158 | contains information about the currently processed blocks. @var{true_expr} | |
8159 | and @var{false_expr} are the tests that are used for converting the | |
8160 | then-block and the else-block, respectively. Set either @var{true_expr} or | |
8161 | @var{false_expr} to a null pointer if the tests cannot be converted. | |
8162 | @end defmac | |
8163 | ||
8164 | @defmac IFCVT_MODIFY_MULTIPLE_TESTS (@var{ce_info}, @var{bb}, @var{true_expr}, @var{false_expr}) | |
8165 | Like @code{IFCVT_MODIFY_TESTS}, but used when converting more complicated | |
8166 | if-statements into conditions combined by @code{and} and @code{or} operations. | |
8167 | @var{bb} contains the basic block that contains the test that is currently | |
8168 | being processed and about to be turned into a condition. | |
8169 | @end defmac | |
8170 | ||
8171 | @defmac IFCVT_MODIFY_INSN (@var{ce_info}, @var{pattern}, @var{insn}) | |
8172 | A C expression to modify the @var{PATTERN} of an @var{INSN} that is to | |
8173 | be converted to conditional execution format. @var{ce_info} points to | |
8174 | a data structure, @code{struct ce_if_block}, which contains information | |
8175 | about the currently processed blocks. | |
8176 | @end defmac | |
8177 | ||
8178 | @defmac IFCVT_MODIFY_FINAL (@var{ce_info}) | |
8179 | A C expression to perform any final machine dependent modifications in | |
8180 | converting code to conditional execution. The involved basic blocks | |
8181 | can be found in the @code{struct ce_if_block} structure that is pointed | |
8182 | to by @var{ce_info}. | |
8183 | @end defmac | |
8184 | ||
8185 | @defmac IFCVT_MODIFY_CANCEL (@var{ce_info}) | |
8186 | A C expression to cancel any machine dependent modifications in | |
8187 | converting code to conditional execution. The involved basic blocks | |
8188 | can be found in the @code{struct ce_if_block} structure that is pointed | |
8189 | to by @var{ce_info}. | |
8190 | @end defmac | |
8191 | ||
67a0732f SB |
8192 | @defmac IFCVT_MACHDEP_INIT (@var{ce_info}) |
8193 | A C expression to initialize any machine specific data for if-conversion | |
8194 | of the if-block in the @code{struct ce_if_block} structure that is pointed | |
8195 | to by @var{ce_info}. | |
38f8b050 JR |
8196 | @end defmac |
8197 | ||
8198 | @hook TARGET_MACHINE_DEPENDENT_REORG | |
38f8b050 JR |
8199 | |
8200 | @hook TARGET_INIT_BUILTINS | |
38f8b050 JR |
8201 | |
8202 | @hook TARGET_BUILTIN_DECL | |
38f8b050 JR |
8203 | |
8204 | @hook TARGET_EXPAND_BUILTIN | |
8205 | ||
d66f5459 | 8206 | @hook TARGET_RESOLVE_OVERLOADED_BUILTIN |
38f8b050 | 8207 | |
08914aaa | 8208 | @hook TARGET_FOLD_BUILTIN |
38f8b050 | 8209 | |
ea679d55 JG |
8210 | @hook TARGET_GIMPLE_FOLD_BUILTIN |
8211 | ||
3649b9b7 | 8212 | @hook TARGET_COMPARE_VERSION_PRIORITY |
3649b9b7 ST |
8213 | |
8214 | @hook TARGET_GET_FUNCTION_VERSIONS_DISPATCHER | |
3649b9b7 ST |
8215 | |
8216 | @hook TARGET_GENERATE_VERSION_DISPATCHER_BODY | |
3649b9b7 | 8217 | |
1d0216c8 RS |
8218 | @hook TARGET_CAN_USE_DOLOOP_P |
8219 | ||
38f8b050 JR |
8220 | @hook TARGET_INVALID_WITHIN_DOLOOP |
8221 | ||
78e4f1ad UB |
8222 | @hook TARGET_LEGITIMATE_COMBINED_INSN |
8223 | ||
38f8b050 JR |
8224 | @defmac MD_CAN_REDIRECT_BRANCH (@var{branch1}, @var{branch2}) |
8225 | ||
8226 | Take a branch insn in @var{branch1} and another in @var{branch2}. | |
8227 | Return true if redirecting @var{branch1} to the destination of | |
8228 | @var{branch2} is possible. | |
8229 | ||
8230 | On some targets, branches may have a limited range. Optimizing the | |
8231 | filling of delay slots can result in branches being redirected, and this | |
8232 | may in turn cause a branch offset to overflow. | |
8233 | @end defmac | |
8234 | ||
4b4de898 JR |
8235 | @hook TARGET_CAN_FOLLOW_JUMP |
8236 | ||
38f8b050 | 8237 | @hook TARGET_COMMUTATIVE_P |
38f8b050 JR |
8238 | |
8239 | @hook TARGET_ALLOCATE_INITIAL_VALUE | |
8240 | ||
38f8b050 | 8241 | @hook TARGET_UNSPEC_MAY_TRAP_P |
38f8b050 JR |
8242 | |
8243 | @hook TARGET_SET_CURRENT_FUNCTION | |
38f8b050 JR |
8244 | |
8245 | @defmac TARGET_OBJECT_SUFFIX | |
8246 | Define this macro to be a C string representing the suffix for object | |
8247 | files on your target machine. If you do not define this macro, GCC will | |
8248 | use @samp{.o} as the suffix for object files. | |
8249 | @end defmac | |
8250 | ||
8251 | @defmac TARGET_EXECUTABLE_SUFFIX | |
8252 | Define this macro to be a C string representing the suffix to be | |
8253 | automatically added to executable files on your target machine. If you | |
8254 | do not define this macro, GCC will use the null string as the suffix for | |
8255 | executable files. | |
8256 | @end defmac | |
8257 | ||
8258 | @defmac COLLECT_EXPORT_LIST | |
8259 | If defined, @code{collect2} will scan the individual object files | |
8260 | specified on its command line and create an export list for the linker. | |
8261 | Define this macro for systems like AIX, where the linker discards | |
8262 | object files that are not referenced from @code{main} and uses export | |
8263 | lists. | |
8264 | @end defmac | |
8265 | ||
8266 | @defmac MODIFY_JNI_METHOD_CALL (@var{mdecl}) | |
8267 | Define this macro to a C expression representing a variant of the | |
8268 | method call @var{mdecl}, if Java Native Interface (JNI) methods | |
8269 | must be invoked differently from other methods on your target. | |
8270 | For example, on 32-bit Microsoft Windows, JNI methods must be invoked using | |
8271 | the @code{stdcall} calling convention and this macro is then | |
8272 | defined as this expression: | |
8273 | ||
8274 | @smallexample | |
8275 | build_type_attribute_variant (@var{mdecl}, | |
8276 | build_tree_list | |
8277 | (get_identifier ("stdcall"), | |
8278 | NULL)) | |
8279 | @end smallexample | |
8280 | @end defmac | |
8281 | ||
8282 | @hook TARGET_CANNOT_MODIFY_JUMPS_P | |
38f8b050 JR |
8283 | |
8284 | @hook TARGET_BRANCH_TARGET_REGISTER_CLASS | |
38f8b050 JR |
8285 | |
8286 | @hook TARGET_BRANCH_TARGET_REGISTER_CALLEE_SAVED | |
38f8b050 JR |
8287 | |
8288 | @hook TARGET_HAVE_CONDITIONAL_EXECUTION | |
38f8b050 JR |
8289 | |
8290 | @hook TARGET_LOOP_UNROLL_ADJUST | |
38f8b050 JR |
8291 | |
8292 | @defmac POWI_MAX_MULTS | |
8293 | If defined, this macro is interpreted as a signed integer C expression | |
8294 | that specifies the maximum number of floating point multiplications | |
8295 | that should be emitted when expanding exponentiation by an integer | |
8296 | constant inline. When this value is defined, exponentiation requiring | |
8297 | more than this number of multiplications is implemented by calling the | |
8298 | system library's @code{pow}, @code{powf} or @code{powl} routines. | |
8299 | The default value places no upper bound on the multiplication count. | |
8300 | @end defmac | |
8301 | ||
8302 | @deftypefn Macro void TARGET_EXTRA_INCLUDES (const char *@var{sysroot}, const char *@var{iprefix}, int @var{stdinc}) | |
8303 | This target hook should register any extra include files for the | |
8304 | target. The parameter @var{stdinc} indicates if normal include files | |
8305 | are present. The parameter @var{sysroot} is the system root directory. | |
8306 | The parameter @var{iprefix} is the prefix for the gcc directory. | |
8307 | @end deftypefn | |
8308 | ||
8309 | @deftypefn Macro void TARGET_EXTRA_PRE_INCLUDES (const char *@var{sysroot}, const char *@var{iprefix}, int @var{stdinc}) | |
8310 | This target hook should register any extra include files for the | |
8311 | target before any standard headers. The parameter @var{stdinc} | |
8312 | indicates if normal include files are present. The parameter | |
8313 | @var{sysroot} is the system root directory. The parameter | |
8314 | @var{iprefix} is the prefix for the gcc directory. | |
8315 | @end deftypefn | |
8316 | ||
8317 | @deftypefn Macro void TARGET_OPTF (char *@var{path}) | |
8318 | This target hook should register special include paths for the target. | |
8319 | The parameter @var{path} is the include to register. On Darwin | |
8320 | systems, this is used for Framework includes, which have semantics | |
8321 | that are different from @option{-I}. | |
8322 | @end deftypefn | |
8323 | ||
8324 | @defmac bool TARGET_USE_LOCAL_THUNK_ALIAS_P (tree @var{fndecl}) | |
8325 | This target macro returns @code{true} if it is safe to use a local alias | |
8326 | for a virtual function @var{fndecl} when constructing thunks, | |
8327 | @code{false} otherwise. By default, the macro returns @code{true} for all | |
8328 | functions, if a target supports aliases (i.e.@: defines | |
8329 | @code{ASM_OUTPUT_DEF}), @code{false} otherwise, | |
8330 | @end defmac | |
8331 | ||
8332 | @defmac TARGET_FORMAT_TYPES | |
8333 | If defined, this macro is the name of a global variable containing | |
8334 | target-specific format checking information for the @option{-Wformat} | |
8335 | option. The default is to have no target-specific format checks. | |
8336 | @end defmac | |
8337 | ||
8338 | @defmac TARGET_N_FORMAT_TYPES | |
8339 | If defined, this macro is the number of entries in | |
8340 | @code{TARGET_FORMAT_TYPES}. | |
8341 | @end defmac | |
8342 | ||
8343 | @defmac TARGET_OVERRIDES_FORMAT_ATTRIBUTES | |
8344 | If defined, this macro is the name of a global variable containing | |
8345 | target-specific format overrides for the @option{-Wformat} option. The | |
8346 | default is to have no target-specific format overrides. If defined, | |
8347 | @code{TARGET_FORMAT_TYPES} must be defined, too. | |
8348 | @end defmac | |
8349 | ||
8350 | @defmac TARGET_OVERRIDES_FORMAT_ATTRIBUTES_COUNT | |
8351 | If defined, this macro specifies the number of entries in | |
8352 | @code{TARGET_OVERRIDES_FORMAT_ATTRIBUTES}. | |
8353 | @end defmac | |
8354 | ||
8355 | @defmac TARGET_OVERRIDES_FORMAT_INIT | |
8356 | If defined, this macro specifies the optional initialization | |
8357 | routine for target specific customizations of the system printf | |
8358 | and scanf formatter settings. | |
8359 | @end defmac | |
8360 | ||
8361 | @hook TARGET_RELAXED_ORDERING | |
38f8b050 JR |
8362 | |
8363 | @hook TARGET_INVALID_ARG_FOR_UNPROTOTYPED_FN | |
38f8b050 JR |
8364 | |
8365 | @hook TARGET_INVALID_CONVERSION | |
38f8b050 JR |
8366 | |
8367 | @hook TARGET_INVALID_UNARY_OP | |
38f8b050 JR |
8368 | |
8369 | @hook TARGET_INVALID_BINARY_OP | |
38f8b050 JR |
8370 | |
8371 | @hook TARGET_INVALID_PARAMETER_TYPE | |
38f8b050 JR |
8372 | |
8373 | @hook TARGET_INVALID_RETURN_TYPE | |
38f8b050 JR |
8374 | |
8375 | @hook TARGET_PROMOTED_TYPE | |
38f8b050 JR |
8376 | |
8377 | @hook TARGET_CONVERT_TO_TYPE | |
38f8b050 JR |
8378 | |
8379 | @defmac TARGET_USE_JCR_SECTION | |
8380 | This macro determines whether to use the JCR section to register Java | |
8381 | classes. By default, TARGET_USE_JCR_SECTION is defined to 1 if both | |
8382 | SUPPORTS_WEAK and TARGET_HAVE_NAMED_SECTIONS are true, else 0. | |
8383 | @end defmac | |
8384 | ||
8385 | @defmac OBJC_JBLEN | |
8386 | This macro determines the size of the objective C jump buffer for the | |
8387 | NeXT runtime. By default, OBJC_JBLEN is defined to an innocuous value. | |
8388 | @end defmac | |
8389 | ||
8390 | @defmac LIBGCC2_UNWIND_ATTRIBUTE | |
8391 | Define this macro if any target-specific attributes need to be attached | |
ff2ce160 | 8392 | to the functions in @file{libgcc} that provide low-level support for |
38f8b050 JR |
8393 | call stack unwinding. It is used in declarations in @file{unwind-generic.h} |
8394 | and the associated definitions of those functions. | |
8395 | @end defmac | |
8396 | ||
8397 | @hook TARGET_UPDATE_STACK_BOUNDARY | |
38f8b050 JR |
8398 | |
8399 | @hook TARGET_GET_DRAP_RTX | |
38f8b050 JR |
8400 | |
8401 | @hook TARGET_ALLOCATE_STACK_SLOTS_FOR_ARGS | |
38f8b050 JR |
8402 | |
8403 | @hook TARGET_CONST_ANCHOR | |
57c5ab1b | 8404 | |
dfe06d3e JJ |
8405 | @hook TARGET_ASAN_SHADOW_OFFSET |
8406 | ||
5dcfdccd | 8407 | @hook TARGET_MEMMODEL_CHECK |
5dcfdccd | 8408 | |
57c5ab1b | 8409 | @hook TARGET_ATOMIC_TEST_AND_SET_TRUEVAL |
2f251a05 AI |
8410 | |
8411 | @hook TARGET_HAS_IFUNC_P | |
267bac10 | 8412 | |
fceec4d3 AM |
8413 | @hook TARGET_ATOMIC_ALIGN_FOR_MODE |
8414 | ||
267bac10 | 8415 | @hook TARGET_ATOMIC_ASSIGN_EXPAND_FENV |
807e902e KZ |
8416 | |
8417 | @defmac TARGET_SUPPORTS_WIDE_INT | |
8418 | ||
8419 | On older ports, large integers are stored in @code{CONST_DOUBLE} rtl | |
8420 | objects. Newer ports define @code{TARGET_SUPPORTS_WIDE_INT} to be nonzero | |
8421 | to indicate that large integers are stored in | |
8422 | @code{CONST_WIDE_INT} rtl objects. The @code{CONST_WIDE_INT} allows | |
8423 | very large integer constants to be represented. @code{CONST_DOUBLE} | |
8424 | is limited to twice the size of the host's @code{HOST_WIDE_INT} | |
8425 | representation. | |
8426 | ||
8427 | Converting a port mostly requires looking for the places where | |
8428 | @code{CONST_DOUBLE}s are used with @code{VOIDmode} and replacing that | |
8429 | code with code that accesses @code{CONST_WIDE_INT}s. @samp{"grep -i | |
8430 | const_double"} at the port level gets you to 95% of the changes that | |
8431 | need to be made. There are a few places that require a deeper look. | |
8432 | ||
8433 | @itemize @bullet | |
8434 | @item | |
8435 | There is no equivalent to @code{hval} and @code{lval} for | |
8436 | @code{CONST_WIDE_INT}s. This would be difficult to express in the md | |
8437 | language since there are a variable number of elements. | |
8438 | ||
8439 | Most ports only check that @code{hval} is either 0 or -1 to see if the | |
8440 | value is small. As mentioned above, this will no longer be necessary | |
8441 | since small constants are always @code{CONST_INT}. Of course there | |
8442 | are still a few exceptions, the alpha's constraint used by the zap | |
8443 | instruction certainly requires careful examination by C code. | |
8444 | However, all the current code does is pass the hval and lval to C | |
8445 | code, so evolving the c code to look at the @code{CONST_WIDE_INT} is | |
8446 | not really a large change. | |
8447 | ||
8448 | @item | |
8449 | Because there is no standard template that ports use to materialize | |
8450 | constants, there is likely to be some futzing that is unique to each | |
8451 | port in this code. | |
8452 | ||
8453 | @item | |
8454 | The rtx costs may have to be adjusted to properly account for larger | |
8455 | constants that are represented as @code{CONST_WIDE_INT}. | |
8456 | @end itemize | |
8457 | ||
8458 | All and all it does not take long to convert ports that the | |
8459 | maintainer is familiar with. | |
8460 | ||
8461 | @end defmac |