Commit | Line | Data |
---|---|---|
252b5132 | 1 | \input texinfo |
b3adc24a | 2 | @c Copyright (C) 1991-2020 Free Software Foundation, Inc. |
252b5132 RH |
3 | @setfilename internals.info |
4 | @node Top | |
5 | @top Assembler Internals | |
6 | @raisesections | |
7 | @cindex internals | |
8 | ||
9 | This chapter describes the internals of the assembler. It is incomplete, but | |
10 | it may help a bit. | |
11 | ||
43da67e8 | 12 | This chapter is not updated regularly, and it may be out of date. |
252b5132 RH |
13 | |
14 | @menu | |
252b5132 RH |
15 | * Data types:: Data types |
16 | * GAS processing:: What GAS does when it runs | |
17 | * Porting GAS:: Porting GAS | |
18 | * Relaxation:: Relaxation | |
19 | * Broken words:: Broken words | |
20 | * Internal functions:: Internal functions | |
21 | * Test suite:: Test suite | |
22 | @end menu | |
23 | ||
252b5132 RH |
24 | @node Data types |
25 | @section Data types | |
26 | @cindex internals, data types | |
27 | ||
28 | This section describes some fundamental GAS data types. | |
29 | ||
30 | @menu | |
31 | * Symbols:: The symbolS structure | |
32 | * Expressions:: The expressionS structure | |
33 | * Fixups:: The fixS structure | |
34 | * Frags:: The fragS structure | |
35 | @end menu | |
36 | ||
37 | @node Symbols | |
38 | @subsection Symbols | |
39 | @cindex internals, symbols | |
40 | @cindex symbols, internal | |
41 | @cindex symbolS structure | |
42 | ||
b4013713 | 43 | The definition for the symbol structure, @code{symbolS}, is located in |
8d1015a8 | 44 | @file{symbols.c}. |
b4013713 | 45 | |
8d1015a8 | 46 | The fields of this structure may not be referred to directly. |
b4013713 | 47 | Instead, you must use one of the accessor functions defined in @file{symbol.h}. |
b4013713 ILT |
48 | |
49 | Symbol structures contain the following fields: | |
252b5132 RH |
50 | |
51 | @table @code | |
52 | @item sy_value | |
53 | This is an @code{expressionS} that describes the value of the symbol. It might | |
54 | refer to one or more other symbols; if so, its true value may not be known | |
6386f3a7 AM |
55 | until @code{resolve_symbol_value} is called with @var{finalize_syms} non-zero |
56 | in @code{write_object_file}. | |
252b5132 RH |
57 | |
58 | The expression is often simply a constant. Before @code{resolve_symbol_value} | |
6386f3a7 AM |
59 | is called with @var{finalize_syms} set, the value is the offset from the frag |
60 | (@pxref{Frags}). Afterward, the frag address has been added in. | |
252b5132 RH |
61 | |
62 | @item sy_resolved | |
63 | This field is non-zero if the symbol's value has been completely resolved. It | |
64 | is used during the final pass over the symbol table. | |
65 | ||
66 | @item sy_resolving | |
67 | This field is used to detect loops while resolving the symbol's value. | |
68 | ||
69 | @item sy_used_in_reloc | |
70 | This field is non-zero if the symbol is used by a relocation entry. If a local | |
71 | symbol is used in a relocation entry, it must be possible to redirect those | |
72 | relocations to other symbols, or this symbol cannot be removed from the final | |
73 | symbol list. | |
74 | ||
75 | @item sy_next | |
76 | @itemx sy_previous | |
829c3ed3 AM |
77 | These pointers to other @code{symbolS} structures describe a doubly |
78 | linked list. These fields should be accessed with | |
252b5132 RH |
79 | the @code{symbol_next} and @code{symbol_previous} macros. |
80 | ||
81 | @item sy_frag | |
82 | This points to the frag (@pxref{Frags}) that this symbol is attached to. | |
83 | ||
84 | @item sy_used | |
85 | Whether the symbol is used as an operand or in an expression. Note: Not all of | |
86 | the backends keep this information accurate; backends which use this bit are | |
87 | responsible for setting it when a symbol is used in backend routines. | |
88 | ||
89 | @item sy_mri_common | |
90 | Whether the symbol is an MRI common symbol created by the @code{COMMON} | |
91 | pseudo-op when assembling in MRI mode. | |
92 | ||
92757bc9 JB |
93 | @item sy_volatile |
94 | Whether the symbol can be re-defined. | |
95 | ||
96 | @item sy_forward_ref | |
97 | Whether the symbol's value must only be evaluated upon use. | |
98 | ||
06e77878 AO |
99 | @item sy_weakrefr |
100 | Whether the symbol is a @code{weakref} alias to another symbol. | |
101 | ||
102 | @item sy_weakrefd | |
103 | Whether the symbol is or was referenced by one or more @code{weakref} aliases, | |
104 | and has not had any direct references. | |
105 | ||
252b5132 | 106 | @item bsym |
829c3ed3 | 107 | This points to the BFD @code{asymbol} that |
252b5132 RH |
108 | will be used in writing the object file. |
109 | ||
252b5132 RH |
110 | @item sy_obj |
111 | This format-specific data is of type @code{OBJ_SYMFIELD_TYPE}. If no macro by | |
112 | that name is defined in @file{obj-format.h}, this field is not defined. | |
113 | ||
114 | @item sy_tc | |
115 | This processor-specific data is of type @code{TC_SYMFIELD_TYPE}. If no macro | |
116 | by that name is defined in @file{targ-cpu.h}, this field is not defined. | |
117 | ||
252b5132 RH |
118 | @end table |
119 | ||
b4013713 ILT |
120 | Here is a description of the accessor functions. These should be used rather |
121 | than referring to the fields of @code{symbolS} directly. | |
252b5132 RH |
122 | |
123 | @table @code | |
124 | @item S_SET_VALUE | |
125 | @cindex S_SET_VALUE | |
126 | Set the symbol's value. | |
127 | ||
128 | @item S_GET_VALUE | |
129 | @cindex S_GET_VALUE | |
130 | Get the symbol's value. This will cause @code{resolve_symbol_value} to be | |
6386f3a7 | 131 | called if necessary. |
252b5132 RH |
132 | |
133 | @item S_SET_SEGMENT | |
134 | @cindex S_SET_SEGMENT | |
135 | Set the section of the symbol. | |
136 | ||
137 | @item S_GET_SEGMENT | |
138 | @cindex S_GET_SEGMENT | |
139 | Get the symbol's section. | |
140 | ||
141 | @item S_GET_NAME | |
142 | @cindex S_GET_NAME | |
143 | Get the name of the symbol. | |
144 | ||
145 | @item S_SET_NAME | |
146 | @cindex S_SET_NAME | |
147 | Set the name of the symbol. | |
148 | ||
149 | @item S_IS_EXTERNAL | |
150 | @cindex S_IS_EXTERNAL | |
151 | Return non-zero if the symbol is externally visible. | |
152 | ||
252b5132 RH |
153 | @item S_IS_WEAK |
154 | @cindex S_IS_WEAK | |
06e77878 AO |
155 | Return non-zero if the symbol is weak, or if it is a @code{weakref} alias or |
156 | symbol that has not been strongly referenced. | |
157 | ||
158 | @item S_IS_WEAKREFR | |
159 | @cindex S_IS_WEAKREFR | |
160 | Return non-zero if the symbol is a @code{weakref} alias. | |
161 | ||
162 | @item S_IS_WEAKREFD | |
163 | @cindex S_IS_WEAKREFD | |
164 | Return non-zero if the symbol was aliased by a @code{weakref} alias and has not | |
165 | had any strong references. | |
252b5132 | 166 | |
92757bc9 JB |
167 | @item S_IS_VOLATILE |
168 | @cindex S_IS_VOLATILE | |
169 | Return non-zero if the symbol may be re-defined. Such symbols get created by | |
170 | the @code{=} operator, @code{equ}, or @code{set}. | |
171 | ||
172 | @item S_IS_FORWARD_REF | |
173 | @cindex S_IS_FORWARD_REF | |
174 | Return non-zero if the symbol is a forward reference, that is its value must | |
175 | only be determined upon use. | |
176 | ||
252b5132 RH |
177 | @item S_IS_COMMON |
178 | @cindex S_IS_COMMON | |
179 | Return non-zero if this is a common symbol. Common symbols are sometimes | |
180 | represented as undefined symbols with a value, in which case this function will | |
181 | not be reliable. | |
182 | ||
183 | @item S_IS_DEFINED | |
184 | @cindex S_IS_DEFINED | |
185 | Return non-zero if this symbol is defined. This function is not reliable when | |
186 | called on a common symbol. | |
187 | ||
188 | @item S_IS_DEBUG | |
189 | @cindex S_IS_DEBUG | |
190 | Return non-zero if this is a debugging symbol. | |
191 | ||
192 | @item S_IS_LOCAL | |
193 | @cindex S_IS_LOCAL | |
194 | Return non-zero if this is a local assembler symbol which should not be | |
195 | included in the final symbol table. Note that this is not the opposite of | |
196 | @code{S_IS_EXTERNAL}. The @samp{-L} assembler option affects the return value | |
197 | of this function. | |
198 | ||
199 | @item S_SET_EXTERNAL | |
200 | @cindex S_SET_EXTERNAL | |
201 | Mark the symbol as externally visible. | |
202 | ||
203 | @item S_CLEAR_EXTERNAL | |
204 | @cindex S_CLEAR_EXTERNAL | |
205 | Mark the symbol as not externally visible. | |
206 | ||
207 | @item S_SET_WEAK | |
208 | @cindex S_SET_WEAK | |
209 | Mark the symbol as weak. | |
210 | ||
06e77878 AO |
211 | @item S_SET_WEAKREFR |
212 | @cindex S_SET_WEAKREFR | |
213 | Mark the symbol as the referrer in a @code{weakref} directive. The symbol it | |
214 | aliases must have been set to the value expression before this point. If the | |
215 | alias has already been used, the symbol is marked as used too. | |
216 | ||
217 | @item S_CLEAR_WEAKREFR | |
218 | @cindex S_CLEAR_WEAKREFR | |
219 | Clear the @code{weakref} alias status of a symbol. This is implicitly called | |
220 | whenever a symbol is defined or set to a new expression. | |
221 | ||
222 | @item S_SET_WEAKREFD | |
223 | @cindex S_SET_WEAKREFD | |
224 | Mark the symbol as the referred symbol in a @code{weakref} directive. | |
225 | Implicitly marks the symbol as weak, but see below. It should only be called | |
226 | if the referenced symbol has just been added to the symbol table. | |
227 | ||
228 | @item S_SET_WEAKREFD | |
229 | @cindex S_SET_WEAKREFD | |
230 | Clear the @code{weakref} aliased status of a symbol. This is implicitly called | |
231 | whenever the symbol is looked up, as part of a direct reference or a | |
232 | definition, but not as part of a @code{weakref} directive. | |
233 | ||
92757bc9 JB |
234 | @item S_SET_VOLATILE |
235 | @cindex S_SET_VOLATILE | |
236 | Indicate that the symbol may be re-defined. | |
237 | ||
238 | @item S_CLEAR_VOLATILE | |
239 | @cindex S_CLEAR_VOLATILE | |
240 | Indicate that the symbol may no longer be re-defined. | |
241 | ||
242 | @item S_SET_FORWARD_REF | |
243 | @cindex S_SET_FORWARD_REF | |
244 | Indicate that the symbol is a forward reference, that is its value must only | |
245 | be determined upon use. | |
246 | ||
252b5132 | 247 | @item S_GET_TYPE |
1f9bb1ca AS |
248 | @itemx S_GET_DESC |
249 | @itemx S_GET_OTHER | |
252b5132 RH |
250 | @cindex S_GET_TYPE |
251 | @cindex S_GET_DESC | |
252 | @cindex S_GET_OTHER | |
253 | Get the @code{type}, @code{desc}, and @code{other} fields of the symbol. These | |
254 | are only defined for object file formats for which they make sense (primarily | |
255 | a.out). | |
256 | ||
257 | @item S_SET_TYPE | |
1f9bb1ca AS |
258 | @itemx S_SET_DESC |
259 | @itemx S_SET_OTHER | |
252b5132 RH |
260 | @cindex S_SET_TYPE |
261 | @cindex S_SET_DESC | |
262 | @cindex S_SET_OTHER | |
263 | Set the @code{type}, @code{desc}, and @code{other} fields of the symbol. These | |
264 | are only defined for object file formats for which they make sense (primarily | |
265 | a.out). | |
266 | ||
267 | @item S_GET_SIZE | |
268 | @cindex S_GET_SIZE | |
269 | Get the size of a symbol. This is only defined for object file formats for | |
270 | which it makes sense (primarily ELF). | |
271 | ||
272 | @item S_SET_SIZE | |
273 | @cindex S_SET_SIZE | |
274 | Set the size of a symbol. This is only defined for object file formats for | |
275 | which it makes sense (primarily ELF). | |
b4013713 ILT |
276 | |
277 | @item symbol_get_value_expression | |
278 | @cindex symbol_get_value_expression | |
279 | Get a pointer to an @code{expressionS} structure which represents the value of | |
280 | the symbol as an expression. | |
281 | ||
282 | @item symbol_set_value_expression | |
283 | @cindex symbol_set_value_expression | |
284 | Set the value of a symbol to an expression. | |
285 | ||
286 | @item symbol_set_frag | |
287 | @cindex symbol_set_frag | |
288 | Set the frag where a symbol is defined. | |
289 | ||
290 | @item symbol_get_frag | |
291 | @cindex symbol_get_frag | |
292 | Get the frag where a symbol is defined. | |
293 | ||
294 | @item symbol_mark_used | |
295 | @cindex symbol_mark_used | |
296 | Mark a symbol as having been used in an expression. | |
297 | ||
298 | @item symbol_clear_used | |
299 | @cindex symbol_clear_used | |
300 | Clear the mark indicating that a symbol was used in an expression. | |
301 | ||
302 | @item symbol_used_p | |
303 | @cindex symbol_used_p | |
304 | Return whether a symbol was used in an expression. | |
305 | ||
306 | @item symbol_mark_used_in_reloc | |
307 | @cindex symbol_mark_used_in_reloc | |
308 | Mark a symbol as having been used by a relocation. | |
309 | ||
310 | @item symbol_clear_used_in_reloc | |
311 | @cindex symbol_clear_used_in_reloc | |
312 | Clear the mark indicating that a symbol was used in a relocation. | |
313 | ||
314 | @item symbol_used_in_reloc_p | |
315 | @cindex symbol_used_in_reloc_p | |
316 | Return whether a symbol was used in a relocation. | |
317 | ||
318 | @item symbol_mark_mri_common | |
319 | @cindex symbol_mark_mri_common | |
320 | Mark a symbol as an MRI common symbol. | |
321 | ||
322 | @item symbol_clear_mri_common | |
323 | @cindex symbol_clear_mri_common | |
324 | Clear the mark indicating that a symbol is an MRI common symbol. | |
325 | ||
326 | @item symbol_mri_common_p | |
327 | @cindex symbol_mri_common_p | |
328 | Return whether a symbol is an MRI common symbol. | |
329 | ||
330 | @item symbol_mark_written | |
331 | @cindex symbol_mark_written | |
332 | Mark a symbol as having been written. | |
333 | ||
334 | @item symbol_clear_written | |
335 | @cindex symbol_clear_written | |
336 | Clear the mark indicating that a symbol was written. | |
337 | ||
338 | @item symbol_written_p | |
339 | @cindex symbol_written_p | |
340 | Return whether a symbol was written. | |
341 | ||
342 | @item symbol_mark_resolved | |
343 | @cindex symbol_mark_resolved | |
344 | Mark a symbol as having been resolved. | |
345 | ||
346 | @item symbol_resolved_p | |
347 | @cindex symbol_resolved_p | |
348 | Return whether a symbol has been resolved. | |
349 | ||
350 | @item symbol_section_p | |
351 | @cindex symbol_section_p | |
352 | Return whether a symbol is a section symbol. | |
353 | ||
354 | @item symbol_equated_p | |
355 | @cindex symbol_equated_p | |
356 | Return whether a symbol is equated to another symbol. | |
357 | ||
358 | @item symbol_constant_p | |
359 | @cindex symbol_constant_p | |
360 | Return whether a symbol has a constant value, including being an offset within | |
361 | some frag. | |
362 | ||
363 | @item symbol_get_bfdsym | |
364 | @cindex symbol_get_bfdsym | |
365 | Return the BFD symbol associated with a symbol. | |
366 | ||
367 | @item symbol_set_bfdsym | |
368 | @cindex symbol_set_bfdsym | |
369 | Set the BFD symbol associated with a symbol. | |
370 | ||
371 | @item symbol_get_obj | |
372 | @cindex symbol_get_obj | |
373 | Return a pointer to the @code{OBJ_SYMFIELD_TYPE} field of a symbol. | |
374 | ||
375 | @item symbol_set_obj | |
376 | @cindex symbol_set_obj | |
377 | Set the @code{OBJ_SYMFIELD_TYPE} field of a symbol. | |
378 | ||
379 | @item symbol_get_tc | |
380 | @cindex symbol_get_tc | |
381 | Return a pointer to the @code{TC_SYMFIELD_TYPE} field of a symbol. | |
382 | ||
383 | @item symbol_set_tc | |
384 | @cindex symbol_set_tc | |
385 | Set the @code{TC_SYMFIELD_TYPE} field of a symbol. | |
386 | ||
252b5132 RH |
387 | @end table |
388 | ||
829c3ed3 | 389 | GAS attempts to store local |
b4013713 ILT |
390 | symbols--symbols which will not be written to the output file--using a |
391 | different structure, @code{struct local_symbol}. This structure can only | |
392 | represent symbols whose value is an offset within a frag. | |
393 | ||
394 | Code outside of the symbol handler will always deal with @code{symbolS} | |
395 | structures and use the accessor functions. The accessor functions correctly | |
396 | deal with local symbols. @code{struct local_symbol} is much smaller than | |
397 | @code{symbolS} (which also automatically creates a bfd @code{asymbol} | |
398 | structure), so this saves space when assembling large files. | |
399 | ||
252b5132 RH |
400 | @node Expressions |
401 | @subsection Expressions | |
402 | @cindex internals, expressions | |
403 | @cindex expressions, internal | |
404 | @cindex expressionS structure | |
405 | ||
406 | Expressions are stored in an @code{expressionS} structure. The structure is | |
407 | defined in @file{expr.h}. | |
408 | ||
409 | @cindex expression | |
410 | The macro @code{expression} will create an @code{expressionS} structure based | |
411 | on the text found at the global variable @code{input_line_pointer}. | |
412 | ||
413 | @cindex make_expr_symbol | |
414 | @cindex expr_symbol_where | |
415 | A single @code{expressionS} structure can represent a single operation. | |
416 | Complex expressions are formed by creating @dfn{expression symbols} and | |
417 | combining them in @code{expressionS} structures. An expression symbol is | |
418 | created by calling @code{make_expr_symbol}. An expression symbol should | |
419 | naturally never appear in a symbol table, and the implementation of | |
420 | @code{S_IS_LOCAL} (@pxref{Symbols}) reflects that. The function | |
421 | @code{expr_symbol_where} returns non-zero if a symbol is an expression symbol, | |
422 | and also returns the file and line for the expression which caused it to be | |
423 | created. | |
424 | ||
425 | The @code{expressionS} structure has two symbol fields, a number field, an | |
426 | operator field, and a field indicating whether the number is unsigned. | |
427 | ||
428 | The operator field is of type @code{operatorT}, and describes how to interpret | |
429 | the other fields; see the definition in @file{expr.h} for the possibilities. | |
430 | ||
431 | An @code{operatorT} value of @code{O_big} indicates either a floating point | |
432 | number, stored in the global variable @code{generic_floating_point_number}, or | |
623aa224 | 433 | an integer too large to store in an @code{offsetT} type, stored in the global |
252b5132 RH |
434 | array @code{generic_bignum}. This rather inflexible approach makes it |
435 | impossible to use floating point numbers or large expressions in complex | |
436 | expressions. | |
437 | ||
438 | @node Fixups | |
439 | @subsection Fixups | |
440 | @cindex internals, fixups | |
441 | @cindex fixups | |
442 | @cindex fixS structure | |
443 | ||
444 | A @dfn{fixup} is basically anything which can not be resolved in the first | |
445 | pass. Sometimes a fixup can be resolved by the end of the assembly; if not, | |
446 | the fixup becomes a relocation entry in the object file. | |
447 | ||
448 | @cindex fix_new | |
449 | @cindex fix_new_exp | |
450 | A fixup is created by a call to @code{fix_new} or @code{fix_new_exp}. Both | |
451 | take a frag (@pxref{Frags}), a position within the frag, a size, an indication | |
829c3ed3 AM |
452 | of whether the fixup is PC relative, and a type. |
453 | The type is nominally a @code{bfd_reloc_code_real_type}, but several | |
252b5132 RH |
454 | targets use other type codes to represent fixups that can not be described as |
455 | relocations. | |
456 | ||
457 | The @code{fixS} structure has a number of fields, several of which are obsolete | |
458 | or are only used by a particular target. The important fields are: | |
459 | ||
460 | @table @code | |
461 | @item fx_frag | |
462 | The frag (@pxref{Frags}) this fixup is in. | |
463 | ||
464 | @item fx_where | |
465 | The location within the frag where the fixup occurs. | |
466 | ||
467 | @item fx_addsy | |
468 | The symbol this fixup is against. Typically, the value of this symbol is added | |
469 | into the object contents. This may be NULL. | |
470 | ||
471 | @item fx_subsy | |
472 | The value of this symbol is subtracted from the object contents. This is | |
473 | normally NULL. | |
474 | ||
475 | @item fx_offset | |
476 | A number which is added into the fixup. | |
477 | ||
478 | @item fx_addnumber | |
479 | Some CPU backends use this field to convey information between | |
55cf6793 | 480 | @code{md_apply_fix} and @code{tc_gen_reloc}. The machine independent code does |
252b5132 RH |
481 | not use it. |
482 | ||
483 | @item fx_next | |
484 | The next fixup in the section. | |
485 | ||
486 | @item fx_r_type | |
829c3ed3 | 487 | The type of the fixup. |
252b5132 RH |
488 | |
489 | @item fx_size | |
490 | The size of the fixup. This is mostly used for error checking. | |
491 | ||
492 | @item fx_pcrel | |
493 | Whether the fixup is PC relative. | |
494 | ||
495 | @item fx_done | |
496 | Non-zero if the fixup has been applied, and no relocation entry needs to be | |
497 | generated. | |
498 | ||
499 | @item fx_file | |
500 | @itemx fx_line | |
501 | The file and line where the fixup was created. | |
502 | ||
503 | @item tc_fix_data | |
504 | This has the type @code{TC_FIX_TYPE}, and is only defined if the target defines | |
505 | that macro. | |
506 | @end table | |
507 | ||
508 | @node Frags | |
509 | @subsection Frags | |
510 | @cindex internals, frags | |
511 | @cindex frags | |
512 | @cindex fragS structure. | |
513 | ||
514 | The @code{fragS} structure is defined in @file{as.h}. Each frag represents a | |
515 | portion of the final object file. As GAS reads the source file, it creates | |
516 | frags to hold the data that it reads. At the end of the assembly the frags and | |
517 | fixups are processed to produce the final contents. | |
518 | ||
519 | @table @code | |
520 | @item fr_address | |
521 | The address of the frag. This is not set until the assembler rescans the list | |
522 | of all frags after the entire input file is parsed. The function | |
523 | @code{relax_segment} fills in this field. | |
524 | ||
525 | @item fr_next | |
526 | Pointer to the next frag in this (sub)section. | |
527 | ||
528 | @item fr_fix | |
529 | Fixed number of characters we know we're going to emit to the output file. May | |
530 | be zero. | |
531 | ||
532 | @item fr_var | |
533 | Variable number of characters we may output, after the initial @code{fr_fix} | |
534 | characters. May be zero. | |
535 | ||
536 | @item fr_offset | |
537 | The interpretation of this field is controlled by @code{fr_type}. Generally, | |
538 | if @code{fr_var} is non-zero, this is a repeat count: the @code{fr_var} | |
539 | characters are output @code{fr_offset} times. | |
540 | ||
541 | @item line | |
542 | Holds line number info when an assembler listing was requested. | |
543 | ||
544 | @item fr_type | |
545 | Relaxation state. This field indicates the interpretation of @code{fr_offset}, | |
546 | @code{fr_symbol} and the variable-length tail of the frag, as well as the | |
547 | treatment it gets in various phases of processing. It does not affect the | |
548 | initial @code{fr_fix} characters; they are always supposed to be output | |
549 | verbatim (fixups aside). See below for specific values this field can have. | |
550 | ||
551 | @item fr_subtype | |
552 | Relaxation substate. If the macro @code{md_relax_frag} isn't defined, this is | |
553 | assumed to be an index into @code{TC_GENERIC_RELAX_TABLE} for the generic | |
554 | relaxation code to process (@pxref{Relaxation}). If @code{md_relax_frag} is | |
555 | defined, this field is available for any use by the CPU-specific code. | |
556 | ||
557 | @item fr_symbol | |
558 | This normally indicates the symbol to use when relaxing the frag according to | |
559 | @code{fr_type}. | |
560 | ||
561 | @item fr_opcode | |
562 | Points to the lowest-addressed byte of the opcode, for use in relaxation. | |
563 | ||
564 | @item tc_frag_data | |
565 | Target specific fragment data of type TC_FRAG_TYPE. | |
566 | Only present if @code{TC_FRAG_TYPE} is defined. | |
567 | ||
568 | @item fr_file | |
569 | @itemx fr_line | |
570 | The file and line where this frag was last modified. | |
571 | ||
572 | @item fr_literal | |
573 | Declared as a one-character array, this last field grows arbitrarily large to | |
574 | hold the actual contents of the frag. | |
575 | @end table | |
576 | ||
577 | These are the possible relaxation states, provided in the enumeration type | |
578 | @code{relax_stateT}, and the interpretations they represent for the other | |
579 | fields: | |
580 | ||
581 | @table @code | |
582 | @item rs_align | |
583 | @itemx rs_align_code | |
584 | The start of the following frag should be aligned on some boundary. In this | |
585 | frag, @code{fr_offset} is the logarithm (base 2) of the alignment in bytes. | |
586 | (For example, if alignment on an 8-byte boundary were desired, @code{fr_offset} | |
587 | would have a value of 3.) The variable characters indicate the fill pattern to | |
588 | be used. The @code{fr_subtype} field holds the maximum number of bytes to skip | |
589 | when doing this alignment. If more bytes are needed, the alignment is not | |
590 | done. An @code{fr_subtype} value of 0 means no maximum, which is the normal | |
591 | case. Target backends can use @code{rs_align_code} to handle certain types of | |
592 | alignment differently. | |
593 | ||
594 | @item rs_broken_word | |
595 | This indicates that ``broken word'' processing should be done (@pxref{Broken | |
596 | words}). If broken word processing is not necessary on the target machine, | |
597 | this enumerator value will not be defined. | |
598 | ||
599 | @item rs_cfa | |
600 | This state is used to implement exception frame optimizations. The | |
601 | @code{fr_symbol} is an expression symbol for the subtraction which may be | |
602 | relaxed. The @code{fr_opcode} field holds the frag for the preceding command | |
603 | byte. The @code{fr_offset} field holds the offset within that frag. The | |
604 | @code{fr_subtype} field is used during relaxation to hold the current size of | |
605 | the frag. | |
606 | ||
607 | @item rs_fill | |
608 | The variable characters are to be repeated @code{fr_offset} times. If | |
609 | @code{fr_offset} is 0, this frag has a length of @code{fr_fix}. Most frags | |
610 | have this type. | |
611 | ||
612 | @item rs_leb128 | |
58a77e41 | 613 | This state is used to implement the DWARF ``little endian base 128'' |
252b5132 RH |
614 | variable length number format. The @code{fr_symbol} is always an expression |
615 | symbol, as constant expressions are emitted directly. The @code{fr_offset} | |
616 | field is used during relaxation to hold the previous size of the number so | |
617 | that we can determine if the fragment changed size. | |
618 | ||
619 | @item rs_machine_dependent | |
620 | Displacement relaxation is to be done on this frag. The target is indicated by | |
621 | @code{fr_symbol} and @code{fr_offset}, and @code{fr_subtype} indicates the | |
622 | particular machine-specific addressing mode desired. @xref{Relaxation}. | |
623 | ||
624 | @item rs_org | |
625 | The start of the following frag should be pushed back to some specific offset | |
626 | within the section. (Some assemblers use the value as an absolute address; GAS | |
627 | does not handle final absolute addresses, but rather requires that the linker | |
628 | set them.) The offset is given by @code{fr_symbol} and @code{fr_offset}; one | |
629 | character from the variable-length tail is used as the fill character. | |
630 | @end table | |
631 | ||
632 | @cindex frchainS structure | |
633 | A chain of frags is built up for each subsection. The data structure | |
634 | describing a chain is called a @code{frchainS}, and contains the following | |
635 | fields: | |
636 | ||
637 | @table @code | |
638 | @item frch_root | |
639 | Points to the first frag in the chain. May be NULL if there are no frags in | |
640 | this chain. | |
641 | @item frch_last | |
642 | Points to the last frag in the chain, or NULL if there are none. | |
643 | @item frch_next | |
644 | Next in the list of @code{frchainS} structures. | |
645 | @item frch_seg | |
646 | Indicates the section this frag chain belongs to. | |
647 | @item frch_subseg | |
648 | Subsection (subsegment) number of this frag chain. | |
649 | @item fix_root, fix_tail | |
829c3ed3 | 650 | Point to first and last @code{fixS} structures associated with this subsection. |
252b5132 RH |
651 | @item frch_obstack |
652 | Not currently used. Intended to be used for frag allocation for this | |
653 | subsection. This should reduce frag generation caused by switching sections. | |
654 | @item frch_frag_now | |
655 | The current frag for this subsegment. | |
656 | @end table | |
657 | ||
658 | A @code{frchainS} corresponds to a subsection; each section has a list of | |
659 | @code{frchainS} records associated with it. In most cases, only one subsection | |
660 | of each section is used, so the list will only be one element long, but any | |
661 | processing of frag chains should be prepared to deal with multiple chains per | |
662 | section. | |
663 | ||
664 | After the input files have been completely processed, and no more frags are to | |
665 | be generated, the frag chains are joined into one per section for further | |
666 | processing. After this point, it is safe to operate on one chain per section. | |
667 | ||
668 | The assembler always has a current frag, named @code{frag_now}. More space is | |
669 | allocated for the current frag using the @code{frag_more} function; this | |
0530d30a RS |
670 | returns a pointer to the amount of requested space. The function |
671 | @code{frag_room} says by how much the current frag can be extended. | |
672 | Relaxing is done using variant frags allocated by @code{frag_var} | |
673 | or @code{frag_variant} (@pxref{Relaxation}). | |
252b5132 RH |
674 | |
675 | @node GAS processing | |
676 | @section What GAS does when it runs | |
677 | @cindex internals, overview | |
678 | ||
679 | This is a quick look at what an assembler run looks like. | |
680 | ||
681 | @itemize @bullet | |
682 | @item | |
683 | The assembler initializes itself by calling various init routines. | |
684 | ||
685 | @item | |
686 | For each source file, the @code{read_a_source_file} function reads in the file | |
687 | and parses it. The global variable @code{input_line_pointer} points to the | |
688 | current text; it is guaranteed to be correct up to the end of the line, but not | |
689 | farther. | |
690 | ||
691 | @item | |
692 | For each line, the assembler passes labels to the @code{colon} function, and | |
693 | isolates the first word. If it looks like a pseudo-op, the word is looked up | |
694 | in the pseudo-op hash table @code{po_hash} and dispatched to a pseudo-op | |
695 | routine. Otherwise, the target dependent @code{md_assemble} routine is called | |
696 | to parse the instruction. | |
697 | ||
698 | @item | |
699 | When pseudo-ops or instructions output data, they add it to a frag, calling | |
700 | @code{frag_more} to get space to store it in. | |
701 | ||
702 | @item | |
703 | Pseudo-ops and instructions can also output fixups created by @code{fix_new} or | |
704 | @code{fix_new_exp}. | |
705 | ||
706 | @item | |
707 | For certain targets, instructions can create variant frags which are used to | |
708 | store relaxation information (@pxref{Relaxation}). | |
709 | ||
710 | @item | |
711 | When the input file is finished, the @code{write_object_file} routine is | |
712 | called. It assigns addresses to all the frags (@code{relax_segment}), resolves | |
713 | all the fixups (@code{fixup_segment}), resolves all the symbol values (using | |
829c3ed3 | 714 | @code{resolve_symbol_value}), and finally writes out the file. |
252b5132 RH |
715 | @end itemize |
716 | ||
717 | @node Porting GAS | |
718 | @section Porting GAS | |
719 | @cindex porting | |
720 | ||
721 | Each GAS target specifies two main things: the CPU file and the object format | |
1110793a | 722 | file. Two main switches in the @file{configure.ac} file handle this. The |
252b5132 RH |
723 | first switches on CPU type to set the shell variable @code{cpu_type}. The |
724 | second switches on the entire target to set the shell variable @code{fmt}. | |
725 | ||
726 | The configure script uses the value of @code{cpu_type} to select two files in | |
727 | the @file{config} directory: @file{tc-@var{CPU}.c} and @file{tc-@var{CPU}.h}. | |
728 | The configuration process will create a file named @file{targ-cpu.h} in the | |
729 | build directory which includes @file{tc-@var{CPU}.h}. | |
730 | ||
731 | The configure script also uses the value of @code{fmt} to select two files: | |
732 | @file{obj-@var{fmt}.c} and @file{obj-@var{fmt}.h}. The configuration process | |
733 | will create a file named @file{obj-format.h} in the build directory which | |
734 | includes @file{obj-@var{fmt}.h}. | |
735 | ||
736 | You can also set the emulation in the configure script by setting the @code{em} | |
737 | variable. Normally the default value of @samp{generic} is fine. The | |
738 | configuration process will create a file named @file{targ-env.h} in the build | |
739 | directory which includes @file{te-@var{em}.h}. | |
740 | ||
56385375 L |
741 | There is a special case for COFF. For historical reason, the GNU COFF |
742 | assembler doesn't follow the documented behavior on certain debug symbols for | |
743 | the compatibility with other COFF assemblers. A port can define | |
744 | @code{STRICTCOFF} in the configure script to make the GNU COFF assembler | |
745 | to follow the documented behavior. | |
746 | ||
252b5132 RH |
747 | Porting GAS to a new CPU requires writing the @file{tc-@var{CPU}} files. |
748 | Porting GAS to a new object file format requires writing the | |
749 | @file{obj-@var{fmt}} files. There is sometimes some interaction between these | |
750 | two files, but it is normally minimal. | |
751 | ||
752 | The best approach is, of course, to copy existing files. The documentation | |
753 | below assumes that you are looking at existing files to see usage details. | |
754 | ||
755 | These interfaces have grown over time, and have never been carefully thought | |
756 | out or designed. Nothing about the interfaces described here is cast in stone. | |
757 | It is possible that they will change from one version of the assembler to the | |
758 | next. Also, new macros are added all the time as they are needed. | |
759 | ||
760 | @menu | |
761 | * CPU backend:: Writing a CPU backend | |
762 | * Object format backend:: Writing an object format backend | |
763 | * Emulations:: Writing emulation files | |
764 | @end menu | |
765 | ||
766 | @node CPU backend | |
767 | @subsection Writing a CPU backend | |
768 | @cindex CPU backend | |
769 | @cindex @file{tc-@var{CPU}} | |
770 | ||
771 | The CPU backend files are the heart of the assembler. They are the only parts | |
772 | of the assembler which actually know anything about the instruction set of the | |
773 | processor. | |
774 | ||
775 | You must define a reasonably small list of macros and functions in the CPU | |
776 | backend files. You may define a large number of additional macros in the CPU | |
777 | backend files, not all of which are documented here. You must, of course, | |
778 | define macros in the @file{.h} file, which is included by every assembler | |
779 | source file. You may define the functions as macros in the @file{.h} file, or | |
780 | as functions in the @file{.c} file. | |
781 | ||
782 | @table @code | |
783 | @item TC_@var{CPU} | |
784 | @cindex TC_@var{CPU} | |
785 | By convention, you should define this macro in the @file{.h} file. For | |
786 | example, @file{tc-m68k.h} defines @code{TC_M68K}. You might have to use this | |
787 | if it is necessary to add CPU specific code to the object format file. | |
788 | ||
789 | @item TARGET_FORMAT | |
790 | This macro is the BFD target name to use when creating the output file. This | |
791 | will normally depend upon the @code{OBJ_@var{FMT}} macro. | |
792 | ||
793 | @item TARGET_ARCH | |
794 | This macro is the BFD architecture to pass to @code{bfd_set_arch_mach}. | |
795 | ||
796 | @item TARGET_MACH | |
797 | This macro is the BFD machine number to pass to @code{bfd_set_arch_mach}. If | |
798 | it is not defined, GAS will use 0. | |
799 | ||
800 | @item TARGET_BYTES_BIG_ENDIAN | |
801 | You should define this macro to be non-zero if the target is big endian, and | |
802 | zero if the target is little endian. | |
803 | ||
804 | @item md_shortopts | |
805 | @itemx md_longopts | |
806 | @itemx md_longopts_size | |
807 | @itemx md_parse_option | |
808 | @itemx md_show_usage | |
acebd4ce | 809 | @itemx md_after_parse_args |
252b5132 RH |
810 | @cindex md_shortopts |
811 | @cindex md_longopts | |
812 | @cindex md_longopts_size | |
813 | @cindex md_parse_option | |
814 | @cindex md_show_usage | |
acebd4ce | 815 | @cindex md_after_parse_args |
252b5132 RH |
816 | GAS uses these variables and functions during option processing. |
817 | @code{md_shortopts} is a @code{const char *} which GAS adds to the machine | |
818 | independent string passed to @code{getopt}. @code{md_longopts} is a | |
819 | @code{struct option []} which GAS adds to the machine independent long options | |
820 | passed to @code{getopt}; you may use @code{OPTION_MD_BASE}, defined in | |
821 | @file{as.h}, as the start of a set of long option indices, if necessary. | |
822 | @code{md_longopts_size} is a @code{size_t} holding the size @code{md_longopts}. | |
329e276d | 823 | |
252b5132 RH |
824 | GAS will call @code{md_parse_option} whenever @code{getopt} returns an |
825 | unrecognized code, presumably indicating a special code value which appears in | |
329e276d NC |
826 | @code{md_longopts}. This function should return non-zero if it handled the |
827 | option and zero otherwise. There is no need to print a message about an option | |
b45619c0 | 828 | not being recognized. This will be handled by the generic code. |
329e276d NC |
829 | |
830 | GAS will call @code{md_show_usage} when a usage message is printed; it should | |
831 | print a description of the machine specific options. @code{md_after_pase_args}, | |
832 | if defined, is called after all options are processed, to let the backend | |
833 | override settings done by the generic option parsing. | |
252b5132 RH |
834 | |
835 | @item md_begin | |
836 | @cindex md_begin | |
837 | GAS will call this function at the start of the assembly, after the command | |
838 | line arguments have been parsed and all the machine independent initializations | |
839 | have been completed. | |
840 | ||
841 | @item md_cleanup | |
842 | @cindex md_cleanup | |
843 | If you define this macro, GAS will call it at the end of each input file. | |
844 | ||
845 | @item md_assemble | |
846 | @cindex md_assemble | |
847 | GAS will call this function for each input line which does not contain a | |
848 | pseudo-op. The argument is a null terminated string. The function should | |
849 | assemble the string as an instruction with operands. Normally | |
850 | @code{md_assemble} will do this by calling @code{frag_more} and writing out | |
851 | some bytes (@pxref{Frags}). @code{md_assemble} will call @code{fix_new} to | |
852 | create fixups as needed (@pxref{Fixups}). Targets which need to do special | |
853 | purpose relaxation will call @code{frag_var}. | |
854 | ||
855 | @item md_pseudo_table | |
856 | @cindex md_pseudo_table | |
857 | This is a const array of type @code{pseudo_typeS}. It is a mapping from | |
858 | pseudo-op names to functions. You should use this table to implement | |
859 | pseudo-ops which are specific to the CPU. | |
860 | ||
861 | @item tc_conditional_pseudoop | |
862 | @cindex tc_conditional_pseudoop | |
863 | If this macro is defined, GAS will call it with a @code{pseudo_typeS} argument. | |
864 | It should return non-zero if the pseudo-op is a conditional which controls | |
865 | whether code is assembled, such as @samp{.if}. GAS knows about the normal | |
8108ad8e | 866 | conditional pseudo-ops, and you should normally not have to define this macro. |
252b5132 RH |
867 | |
868 | @item comment_chars | |
869 | @cindex comment_chars | |
870 | This is a null terminated @code{const char} array of characters which start a | |
871 | comment. | |
872 | ||
873 | @item tc_comment_chars | |
874 | @cindex tc_comment_chars | |
875 | If this macro is defined, GAS will use it instead of @code{comment_chars}. | |
2e6976a8 DG |
876 | This has the advantage that this macro does not have to refer to a constant |
877 | array. | |
252b5132 RH |
878 | |
879 | @item tc_symbol_chars | |
880 | @cindex tc_symbol_chars | |
881 | If this macro is defined, it is a pointer to a null terminated list of | |
882 | characters which may appear in an operand. GAS already assumes that all | |
b45619c0 | 883 | alphanumeric characters, and @samp{$}, @samp{.}, and @samp{_} may appear in an |
252b5132 RH |
884 | operand (see @samp{symbol_chars} in @file{app.c}). This macro may be defined |
885 | to treat additional characters as appearing in an operand. This affects the | |
886 | way in which GAS removes whitespace before passing the string to | |
887 | @samp{md_assemble}. | |
888 | ||
889 | @item line_comment_chars | |
890 | @cindex line_comment_chars | |
891 | This is a null terminated @code{const char} array of characters which start a | |
892 | comment when they appear at the start of a line. | |
893 | ||
894 | @item line_separator_chars | |
895 | @cindex line_separator_chars | |
896 | This is a null terminated @code{const char} array of characters which separate | |
63a0b638 | 897 | lines (null and newline are such characters by default, and need not be |
65fd87bc ILT |
898 | listed in this array). Note that line_separator_chars do not separate lines |
899 | if found in a comment, such as after a character in line_comment_chars or | |
900 | comment_chars. | |
252b5132 | 901 | |
2e6976a8 DG |
902 | @item tc_line_separator_chars |
903 | @cindex tc_line_separator_chars | |
904 | If this macro is defined, GAS will use it instead of | |
905 | @code{line_separator_chars}. This has the advantage that this macro does not | |
906 | have to refer to a constant array. | |
907 | ||
908 | ||
252b5132 RH |
909 | @item EXP_CHARS |
910 | @cindex EXP_CHARS | |
911 | This is a null terminated @code{const char} array of characters which may be | |
912 | used as the exponent character in a floating point number. This is normally | |
913 | @code{"eE"}. | |
914 | ||
915 | @item FLT_CHARS | |
916 | @cindex FLT_CHARS | |
917 | This is a null terminated @code{const char} array of characters which may be | |
918 | used to indicate a floating point constant. A zero followed by one of these | |
919 | characters is assumed to be followed by a floating point number; thus they | |
920 | operate the way that @code{0x} is used to indicate a hexadecimal constant. | |
921 | Usually this includes @samp{r} and @samp{f}. | |
922 | ||
923 | @item LEX_AT | |
924 | @cindex LEX_AT | |
65fd87bc | 925 | You may define this macro to the lexical type of the @kbd{@@} character. The |
252b5132 RH |
926 | default is zero. |
927 | ||
928 | Lexical types are a combination of @code{LEX_NAME} and @code{LEX_BEGIN_NAME}, | |
929 | both defined in @file{read.h}. @code{LEX_NAME} indicates that the character | |
930 | may appear in a name. @code{LEX_BEGIN_NAME} indicates that the character may | |
65fd87bc | 931 | appear at the beginning of a name. |
252b5132 RH |
932 | |
933 | @item LEX_BR | |
934 | @cindex LEX_BR | |
935 | You may define this macro to the lexical type of the brace characters @kbd{@{}, | |
936 | @kbd{@}}, @kbd{[}, and @kbd{]}. The default value is zero. | |
937 | ||
938 | @item LEX_PCT | |
939 | @cindex LEX_PCT | |
940 | You may define this macro to the lexical type of the @kbd{%} character. The | |
941 | default value is zero. | |
942 | ||
943 | @item LEX_QM | |
944 | @cindex LEX_QM | |
945 | You may define this macro to the lexical type of the @kbd{?} character. The | |
946 | default value it zero. | |
947 | ||
948 | @item LEX_DOLLAR | |
949 | @cindex LEX_DOLLAR | |
950 | You may define this macro to the lexical type of the @kbd{$} character. The | |
951 | default value is @code{LEX_NAME | LEX_BEGIN_NAME}. | |
952 | ||
f805106c TW |
953 | @item NUMBERS_WITH_SUFFIX |
954 | @cindex NUMBERS_WITH_SUFFIX | |
955 | When this macro is defined to be non-zero, the parser allows the radix of a | |
58a77e41 | 956 | constant to be indicated with a suffix. Valid suffixes are binary (B), |
f805106c TW |
957 | octal (Q), and hexadecimal (H). Case is not significant. |
958 | ||
252b5132 RH |
959 | @item SINGLE_QUOTE_STRINGS |
960 | @cindex SINGLE_QUOTE_STRINGS | |
961 | If you define this macro, GAS will treat single quotes as string delimiters. | |
962 | Normally only double quotes are accepted as string delimiters. | |
963 | ||
964 | @item NO_STRING_ESCAPES | |
965 | @cindex NO_STRING_ESCAPES | |
966 | If you define this macro, GAS will not permit escape sequences in a string. | |
967 | ||
968 | @item ONLY_STANDARD_ESCAPES | |
969 | @cindex ONLY_STANDARD_ESCAPES | |
970 | If you define this macro, GAS will warn about the use of nonstandard escape | |
971 | sequences in a string. | |
972 | ||
973 | @item md_start_line_hook | |
974 | @cindex md_start_line_hook | |
975 | If you define this macro, GAS will call it at the start of each line. | |
976 | ||
977 | @item LABELS_WITHOUT_COLONS | |
978 | @cindex LABELS_WITHOUT_COLONS | |
979 | If you define this macro, GAS will assume that any text at the start of a line | |
980 | is a label, even if it does not have a colon. | |
981 | ||
982 | @item TC_START_LABEL | |
39bec121 | 983 | @itemx TC_START_LABEL_WITHOUT_COLON |
252b5132 RH |
984 | @cindex TC_START_LABEL |
985 | You may define this macro to control what GAS considers to be a label. The | |
986 | default definition is to accept any name followed by a colon character. | |
987 | ||
f28e8eb3 TW |
988 | @item TC_START_LABEL_WITHOUT_COLON |
989 | @cindex TC_START_LABEL_WITHOUT_COLON | |
990 | Same as TC_START_LABEL, but should be used instead of TC_START_LABEL when | |
58a77e41 | 991 | LABELS_WITHOUT_COLONS is defined. |
f28e8eb3 | 992 | |
c9cd7160 L |
993 | @item TC_FAKE_LABEL |
994 | @cindex TC_FAKE_LABEL | |
995 | You may define this macro to control what GAS considers to be a fake | |
996 | label. The default fake label is FAKE_LABEL_NAME. | |
997 | ||
252b5132 RH |
998 | @item NO_PSEUDO_DOT |
999 | @cindex NO_PSEUDO_DOT | |
1000 | If you define this macro, GAS will not require pseudo-ops to start with a | |
1001 | @kbd{.} character. | |
1002 | ||
ee3c9814 CM |
1003 | @item TC_EQUAL_IN_INSN |
1004 | @cindex TC_EQUAL_IN_INSN | |
1005 | If you define this macro, it should return nonzero if the instruction is | |
1006 | permitted to contain an @kbd{=} character. GAS will call it with two | |
1007 | arguments, the character before the @kbd{=} character, and the value of | |
1008 | the string preceding the equal sign. GAS uses this macro to decide if a | |
1009 | @kbd{=} is an assignment or an instruction. | |
1010 | ||
252b5132 RH |
1011 | @item TC_EOL_IN_INSN |
1012 | @cindex TC_EOL_IN_INSN | |
1013 | If you define this macro, it should return nonzero if the current input line | |
1014 | pointer should be treated as the end of a line. | |
1015 | ||
a8a3b3b2 NS |
1016 | @item TC_CASE_SENSITIVE |
1017 | @cindex TC_CASE_SENSITIVE | |
1018 | Define this macro if instruction mnemonics and pseudos are case sensitive. | |
1019 | The default is to have it undefined giving case insensitive names. | |
1020 | ||
252b5132 RH |
1021 | @item md_parse_name |
1022 | @cindex md_parse_name | |
1023 | If this macro is defined, GAS will call it for any symbol found in an | |
1024 | expression. You can define this to handle special symbols in a special way. | |
1025 | If a symbol always has a certain value, you should normally enter it in the | |
1026 | symbol table, perhaps using @code{reg_section}. | |
1027 | ||
1028 | @item md_undefined_symbol | |
1029 | @cindex md_undefined_symbol | |
1030 | GAS will call this function when a symbol table lookup fails, before it | |
1031 | creates a new symbol. Typically this would be used to supply symbols whose | |
1032 | name or value changes dynamically, possibly in a context sensitive way. | |
1033 | Predefined symbols with fixed values, such as register names or condition | |
1034 | codes, are typically entered directly into the symbol table when @code{md_begin} | |
65fd87bc | 1035 | is called. One argument is passed, a @code{char *} for the symbol. |
252b5132 RH |
1036 | |
1037 | @item md_operand | |
1038 | @cindex md_operand | |
65fd87bc ILT |
1039 | GAS will call this function with one argument, an @code{expressionS} |
1040 | pointer, for any expression that can not be recognized. When the function | |
1041 | is called, @code{input_line_pointer} will point to the start of the | |
1042 | expression. | |
252b5132 | 1043 | |
5a918ce7 JB |
1044 | @item md_register_arithmetic |
1045 | @cindex md_register_arithmetic | |
1046 | If this macro is defined and evaluates to zero then GAS will not fold | |
1047 | expressions that add or subtract a constant to/from a register to give | |
1048 | another register. For example GAS's default behaviour is to fold the | |
1049 | expression "r8 + 1" into "r9", which is probably not the result | |
1050 | intended by the programmer. The default is to allow such folding, | |
1051 | since this maintains backwards compatibility with earlier releases of | |
1052 | GAS. | |
1053 | ||
252b5132 RH |
1054 | @item tc_unrecognized_line |
1055 | @cindex tc_unrecognized_line | |
1056 | If you define this macro, GAS will call it when it finds a line that it can not | |
1057 | parse. | |
1058 | ||
1059 | @item md_do_align | |
1060 | @cindex md_do_align | |
1061 | You may define this macro to handle an alignment directive. GAS will call it | |
1062 | when the directive is seen in the input file. For example, the i386 backend | |
1063 | uses this to generate efficient nop instructions of varying lengths, depending | |
1064 | upon the number of bytes that the alignment will skip. | |
1065 | ||
1066 | @item HANDLE_ALIGN | |
1067 | @cindex HANDLE_ALIGN | |
1068 | You may define this macro to do special handling for an alignment directive. | |
1069 | GAS will call it at the end of the assembly. | |
1070 | ||
8684e216 HPN |
1071 | @item TC_IMPLICIT_LCOMM_ALIGNMENT (@var{size}, @var{p2var}) |
1072 | @cindex TC_IMPLICIT_LCOMM_ALIGNMENT | |
1073 | An @code{.lcomm} directive with no explicit alignment parameter will use this | |
1074 | macro to set @var{p2var} to the alignment that a request for @var{size} bytes | |
1075 | will have. The alignment is expressed as a power of two. If no alignment | |
1076 | should take place, the macro definition should do nothing. Some targets define | |
1077 | a @code{.bss} directive that is also affected by this macro. The default | |
1078 | definition will set @var{p2var} to the truncated power of two of sizes up to | |
1079 | eight bytes. | |
1080 | ||
252b5132 RH |
1081 | @item md_flush_pending_output |
1082 | @cindex md_flush_pending_output | |
1083 | If you define this macro, GAS will call it each time it skips any space because of a | |
1084 | space filling or alignment or data allocation pseudo-op. | |
1085 | ||
1086 | @item TC_PARSE_CONS_EXPRESSION | |
1087 | @cindex TC_PARSE_CONS_EXPRESSION | |
1088 | You may define this macro to parse an expression used in a data allocation | |
1089 | pseudo-op such as @code{.word}. You can use this to recognize relocation | |
1090 | directives that may appear in such directives. | |
1091 | ||
252b5132 RH |
1092 | @item REPEAT_CONS_EXPRESSION |
1093 | @cindex REPEAT_CONS_EXPRESSION | |
1094 | If you define this macro, GAS will recognize repeat counts in data allocation | |
1095 | pseudo-ops, as used on the MIPS. | |
1096 | ||
1097 | @item md_cons_align | |
1098 | @cindex md_cons_align | |
1099 | You may define this macro to do any special alignment before a data allocation | |
1100 | pseudo-op. | |
1101 | ||
1102 | @item TC_CONS_FIX_NEW | |
1103 | @cindex TC_CONS_FIX_NEW | |
1104 | You may define this macro to generate a fixup for a data allocation pseudo-op. | |
1105 | ||
cc1bc22a AM |
1106 | @item TC_ADDRESS_BYTES |
1107 | @cindex TC_ADDRESS_BYTES | |
1108 | Define this macro to specify the number of bytes used to store an address. | |
1109 | Used to implement @code{dc.a}. The target must have a reloc for this size. | |
1110 | ||
252b5132 RH |
1111 | @item TC_INIT_FIX_DATA (@var{fixp}) |
1112 | @cindex TC_INIT_FIX_DATA | |
1113 | A C statement to initialize the target specific fields of fixup @var{fixp}. | |
1114 | These fields are defined with the @code{TC_FIX_TYPE} macro. | |
1115 | ||
1116 | @item TC_FIX_DATA_PRINT (@var{stream}, @var{fixp}) | |
1117 | @cindex TC_FIX_DATA_PRINT | |
1118 | A C statement to output target specific debugging information for | |
1119 | fixup @var{fixp} to @var{stream}. This macro is called by @code{print_fixup}. | |
1120 | ||
db222310 | 1121 | @item TC_FRAG_INIT (@var{fragp}, @var{max_bytes}) |
252b5132 | 1122 | @cindex TC_FRAG_INIT |
db222310 L |
1123 | A C statement to initialize the target specific fields of frag @var{fragp} |
1124 | with maximum number of bytes @var{max_bytes}. These fields are defined | |
1125 | with the @code{TC_FRAG_TYPE} macro. | |
252b5132 RH |
1126 | |
1127 | @item md_number_to_chars | |
1128 | @cindex md_number_to_chars | |
1129 | This should just call either @code{number_to_chars_bigendian} or | |
1130 | @code{number_to_chars_littleendian}, whichever is appropriate. On targets like | |
1131 | the MIPS which support options to change the endianness, which function to call | |
1132 | is a runtime decision. On other targets, @code{md_number_to_chars} can be a | |
1133 | simple macro. | |
1134 | ||
dd9b19ab NC |
1135 | @item md_atof (@var{type},@var{litP},@var{sizeP}) |
1136 | @cindex md_atof | |
1137 | This function is called to convert an ASCII string into a floating point value | |
1138 | in format used by the CPU. It takes three arguments. The first is @var{type} | |
499ac353 | 1139 | which is a byte describing the type of floating point number to be created. It |
adfd7328 | 1140 | is one of the characters defined in the @code{FLT_CHARS} macro. Possible |
499ac353 NC |
1141 | values are @var{'f'} or @var{'s'} for single precision, @var{'d'} or @var{'r'} |
1142 | for double precision and @var{'x'} or @var{'p'} for extended precision. Either | |
1143 | lower or upper case versions of these letters can be used. Note: some targets | |
1144 | do not support all of these types, and some targets may also support other | |
1145 | types not mentioned here. | |
dd9b19ab NC |
1146 | |
1147 | The second parameter is @var{litP} which is a pointer to a byte array where the | |
499ac353 NC |
1148 | converted value should be stored. The value is converted into LITTLENUMs and |
1149 | is stored in the target's endian-ness order. (@var{LITTLENUM} is defined in | |
1150 | gas/bignum.h). Single precision values occupy 2 littlenums. Double precision | |
1151 | values occupy 4 littlenums and extended precision values occupy either 5 or 6 | |
1152 | littlenums, depending upon the target. | |
1153 | ||
1154 | The third argument is @var{sizeP}, which is a pointer to a integer that should | |
1155 | be filled in with the number of chars emitted into the byte array. | |
1156 | ||
1157 | The function should return NULL upon success or an error string upon failure. | |
dd9b19ab | 1158 | |
580a832e RS |
1159 | @item TC_LARGEST_EXPONENT_IS_NORMAL |
1160 | @cindex TC_LARGEST_EXPONENT_IS_NORMAL (@var{precision}) | |
1161 | This macro is used only by @file{atof-ieee.c}. It should evaluate to true | |
1162 | if floats of the given precision use the largest exponent for normal numbers | |
1163 | instead of NaNs and infinities. @var{precision} is @samp{F_PRECISION} for | |
1164 | single precision, @samp{D_PRECISION} for double precision, or | |
1165 | @samp{X_PRECISION} for extended double precision. | |
1166 | ||
1167 | The macro has a default definition which returns 0 for all cases. | |
1168 | ||
252b5132 RH |
1169 | @item WORKING_DOT_WORD |
1170 | @itemx md_short_jump_size | |
1171 | @itemx md_long_jump_size | |
1172 | @itemx md_create_short_jump | |
1173 | @itemx md_create_long_jump | |
e30e5a6a | 1174 | @itemx TC_CHECK_ADJUSTED_BROKEN_DOT_WORD |
252b5132 RH |
1175 | @cindex WORKING_DOT_WORD |
1176 | @cindex md_short_jump_size | |
1177 | @cindex md_long_jump_size | |
1178 | @cindex md_create_short_jump | |
1179 | @cindex md_create_long_jump | |
e30e5a6a | 1180 | @cindex TC_CHECK_ADJUSTED_BROKEN_DOT_WORD |
252b5132 RH |
1181 | If @code{WORKING_DOT_WORD} is defined, GAS will not do broken word processing |
1182 | (@pxref{Broken words}). Otherwise, you should set @code{md_short_jump_size} to | |
65fd87bc ILT |
1183 | the size of a short jump (a jump that is just long enough to jump around a |
1184 | number of long jumps) and @code{md_long_jump_size} to the size of a long jump | |
1185 | (a jump that can go anywhere in the function). You should define | |
1186 | @code{md_create_short_jump} to create a short jump around a number of long | |
1187 | jumps, and define @code{md_create_long_jump} to create a long jump. | |
e30e5a6a HPN |
1188 | If defined, the macro TC_CHECK_ADJUSTED_BROKEN_DOT_WORD will be called for each |
1189 | adjusted word just before the word is output. The macro takes two arguments, | |
1190 | an @code{addressT} with the adjusted word and a pointer to the current | |
1191 | @code{struct broken_word}. | |
252b5132 RH |
1192 | |
1193 | @item md_estimate_size_before_relax | |
1194 | @cindex md_estimate_size_before_relax | |
1195 | This function returns an estimate of the size of a @code{rs_machine_dependent} | |
1196 | frag before any relaxing is done. It may also create any necessary | |
1197 | relocations. | |
1198 | ||
1199 | @item md_relax_frag | |
1200 | @cindex md_relax_frag | |
c842b53a ILT |
1201 | This macro may be defined to relax a frag. GAS will call this with the |
1202 | segment, the frag, and the change in size of all previous frags; | |
1203 | @code{md_relax_frag} should return the change in size of the frag. | |
1204 | @xref{Relaxation}. | |
252b5132 RH |
1205 | |
1206 | @item TC_GENERIC_RELAX_TABLE | |
1207 | @cindex TC_GENERIC_RELAX_TABLE | |
1208 | If you do not define @code{md_relax_frag}, you may define | |
1209 | @code{TC_GENERIC_RELAX_TABLE} as a table of @code{relax_typeS} structures. The | |
1210 | machine independent code knows how to use such a table to relax PC relative | |
1211 | references. See @file{tc-m68k.c} for an example. @xref{Relaxation}. | |
1212 | ||
b65d68b8 L |
1213 | @item md_generic_table_relax_frag |
1214 | @cindex md_generic_table_relax_frag | |
1215 | If defined, it is a C statement that is invoked, instead of | |
1216 | the default implementation, to scan @code{TC_GENERIC_RELAX_TABLE}. | |
1217 | ||
252b5132 RH |
1218 | @item md_prepare_relax_scan |
1219 | @cindex md_prepare_relax_scan | |
1220 | If defined, it is a C statement that is invoked prior to scanning | |
1221 | the relax table. | |
1222 | ||
1223 | @item LINKER_RELAXING_SHRINKS_ONLY | |
1224 | @cindex LINKER_RELAXING_SHRINKS_ONLY | |
1225 | If you define this macro, and the global variable @samp{linkrelax} is set | |
a05a5b64 | 1226 | (because of a command-line option, or unconditionally in @code{md_begin}), a |
252b5132 RH |
1227 | @samp{.align} directive will cause extra space to be allocated. The linker can |
1228 | then discard this space when relaxing the section. | |
1229 | ||
8108ad8e | 1230 | @item TC_LINKRELAX_FIXUP (@var{segT}) |
58a77e41 EC |
1231 | @cindex TC_LINKRELAX_FIXUP |
1232 | If defined, this macro allows control over whether fixups for a | |
1233 | given section will be processed when the @var{linkrelax} variable is | |
1234 | set. The macro is given the N_TYPE bits for the section in its | |
1235 | @var{segT} argument. If the macro evaluates to a non-zero value | |
1236 | then the fixups will be converted into relocs, otherwise they will | |
55cf6793 | 1237 | be passed to @var{md_apply_fix} as normal. |
58a77e41 | 1238 | |
252b5132 RH |
1239 | @item md_convert_frag |
1240 | @cindex md_convert_frag | |
1241 | GAS will call this for each rs_machine_dependent fragment. | |
1242 | The instruction is completed using the data from the relaxation pass. | |
1243 | It may also create any necessary relocations. | |
1244 | @xref{Relaxation}. | |
1245 | ||
87548816 NC |
1246 | @item TC_FINALIZE_SYMS_BEFORE_SIZE_SEG |
1247 | @cindex TC_FINALIZE_SYMS_BEFORE_SIZE_SEG | |
1248 | Specifies the value to be assigned to @code{finalize_syms} before the function | |
1249 | @code{size_segs} is called. Since @code{size_segs} calls @code{cvt_frag_to_fill} | |
34bca508 | 1250 | which can call @code{md_convert_frag}, this constant governs whether the symbols |
87548816 NC |
1251 | accessed in @code{md_convert_frag} will be fully resolved. In particular it |
1252 | governs whether local symbols will have been resolved, and had their frag | |
1253 | information removed. Depending upon the processing performed by | |
1254 | @code{md_convert_frag} the frag information may or may not be necessary, as may | |
1255 | the resolved values of the symbols. The default value is 1. | |
1256 | ||
a161fe53 AM |
1257 | @item TC_VALIDATE_FIX (@var{fixP}, @var{seg}, @var{skip}) |
1258 | @cindex TC_VALIDATE_FIX | |
1259 | This macro is evaluated for each fixup (when @var{linkrelax} is not set). | |
1260 | It may be used to change the fixup in @code{struct fix *@var{fixP}} before | |
1261 | the generic code sees it, or to fully process the fixup. In the latter case, | |
1262 | a @code{goto @var{skip}} will bypass the generic code. | |
252b5132 | 1263 | |
55cf6793 ZW |
1264 | @item md_apply_fix (@var{fixP}, @var{valP}, @var{seg}) |
1265 | @cindex md_apply_fix | |
a161fe53 AM |
1266 | GAS will call this for each fixup that passes the @code{TC_VALIDATE_FIX} test |
1267 | when @var{linkrelax} is not set. It should store the correct value in the | |
55cf6793 | 1268 | object file. @code{struct fix *@var{fixP}} is the fixup @code{md_apply_fix} |
a161fe53 AM |
1269 | is operating on. @code{valueT *@var{valP}} is the value to store into the |
1270 | object files, or at least is the generic code's best guess. Specifically, | |
1271 | *@var{valP} is the value of the fixup symbol, perhaps modified by | |
1272 | @code{MD_APPLY_SYM_VALUE}, plus @code{@var{fixP}->fx_offset} (symbol addend), | |
1273 | less @code{MD_PCREL_FROM_SECTION} for pc-relative fixups. | |
1274 | @code{segT @var{seg}} is the section the fix is in. | |
1275 | @code{fixup_segment} performs a generic overflow check on *@var{valP} after | |
55cf6793 ZW |
1276 | @code{md_apply_fix} returns. If the overflow check is relevant for the target |
1277 | machine, then @code{md_apply_fix} should modify *@var{valP}, typically to the | |
a161fe53 AM |
1278 | value stored in the object file. |
1279 | ||
1280 | @item TC_FORCE_RELOCATION (@var{fix}) | |
1281 | @cindex TC_FORCE_RELOCATION | |
1282 | If this macro returns non-zero, it guarantees that a relocation will be emitted | |
1283 | even when the value can be resolved locally, as @code{fixup_segment} tries to | |
1284 | reduce the number of relocations emitted. For example, a fixup expression | |
1285 | against an absolute symbol will normally not require a reloc. If undefined, | |
1286 | a default of @w{@code{(S_FORCE_RELOC ((@var{fix})->fx_addsy))}} is used. | |
1287 | ||
1288 | @item TC_FORCE_RELOCATION_ABS (@var{fix}) | |
1289 | @cindex TC_FORCE_RELOCATION_ABS | |
1290 | Like @code{TC_FORCE_RELOCATION}, but used only for fixup expressions against an | |
1291 | absolute symbol. If undefined, @code{TC_FORCE_RELOCATION} will be used. | |
1292 | ||
1293 | @item TC_FORCE_RELOCATION_LOCAL (@var{fix}) | |
1294 | @cindex TC_FORCE_RELOCATION_LOCAL | |
1295 | Like @code{TC_FORCE_RELOCATION}, but used only for fixup expressions against a | |
1296 | symbol in the current section. If undefined, fixups that are not | |
20ee54e8 | 1297 | @code{fx_pcrel} or for which @code{TC_FORCE_RELOCATION} |
a161fe53 AM |
1298 | returns non-zero, will emit relocs. |
1299 | ||
1300 | @item TC_FORCE_RELOCATION_SUB_SAME (@var{fix}, @var{seg}) | |
ae6063d4 | 1301 | @cindex TC_FORCE_RELOCATION_SUB_SAME |
a161fe53 AM |
1302 | This macro controls resolution of fixup expressions involving the |
1303 | difference of two symbols in the same section. If this macro returns zero, | |
1304 | the subtrahend will be resolved and @code{fx_subsy} set to @code{NULL} for | |
55cf6793 | 1305 | @code{md_apply_fix}. If undefined, the default of |
621e3db6 | 1306 | @w{@code{! SEG_NORMAL (@var{seg})}} will be used. |
a161fe53 | 1307 | |
adfd7328 | 1308 | @item TC_FORCE_RELOCATION_SUB_ABS (@var{fix}, @var{seg}) |
a161fe53 AM |
1309 | @cindex TC_FORCE_RELOCATION_SUB_ABS |
1310 | Like @code{TC_FORCE_RELOCATION_SUB_SAME}, but used when the subtrahend is an | |
4f3cafa2 | 1311 | absolute symbol. If the macro is undefined a default of @code{0} is used. |
a161fe53 | 1312 | |
adfd7328 | 1313 | @item TC_FORCE_RELOCATION_SUB_LOCAL (@var{fix}, @var{seg}) |
a161fe53 AM |
1314 | @cindex TC_FORCE_RELOCATION_SUB_LOCAL |
1315 | Like @code{TC_FORCE_RELOCATION_SUB_ABS}, but the subtrahend is a symbol in the | |
1316 | same section as the fixup. | |
1317 | ||
5db484ff | 1318 | @item TC_VALIDATE_FIX_SUB (@var{fix}, @var{seg}) |
a161fe53 AM |
1319 | @cindex TC_VALIDATE_FIX_SUB |
1320 | This macro is evaluated for any fixup with a @code{fx_subsy} that | |
1321 | @code{fixup_segment} cannot reduce to a number. If the macro returns | |
1322 | @code{false} an error will be reported. | |
1323 | ||
97c4f2d9 L |
1324 | @item TC_GLOBAL_REGISTER_SYMBOL_OK |
1325 | @cindex TC_GLOBAL_REGISTER_SYMBOL_OK | |
1326 | Define this macro if global register symbols are supported. The default | |
1327 | is to disallow global register symbols. | |
1328 | ||
a161fe53 AM |
1329 | @item MD_APPLY_SYM_VALUE (@var{fix}) |
1330 | @cindex MD_APPLY_SYM_VALUE | |
1331 | This macro controls whether the symbol value becomes part of the value passed | |
55cf6793 | 1332 | to @code{md_apply_fix}. If the macro is undefined, or returns non-zero, the |
a161fe53 AM |
1333 | symbol value will be included. For ELF, a suitable definition might simply be |
1334 | @code{0}, because ELF relocations don't include the symbol value in the addend. | |
1335 | ||
ae6063d4 | 1336 | @item S_FORCE_RELOC (@var{sym}, @var{strict}) |
a161fe53 | 1337 | @cindex S_FORCE_RELOC |
829c3ed3 | 1338 | This function returns true for symbols |
a161fe53 AM |
1339 | that should not be reduced to section symbols or eliminated from expressions, |
1340 | because they may be overridden by the linker. ie. for symbols that are | |
ae6063d4 AM |
1341 | undefined or common, and when @var{strict} is set, weak, or global (for ELF |
1342 | assemblers that support ELF shared library linking semantics). | |
a161fe53 AM |
1343 | |
1344 | @item EXTERN_FORCE_RELOC | |
1345 | @cindex EXTERN_FORCE_RELOC | |
1346 | This macro controls whether @code{S_FORCE_RELOC} returns true for global | |
1347 | symbols. If undefined, the default is @code{true} for ELF assemblers, and | |
1348 | @code{false} for non-ELF. | |
252b5132 RH |
1349 | |
1350 | @item tc_gen_reloc | |
1351 | @cindex tc_gen_reloc | |
829c3ed3 | 1352 | GAS will call this to generate a reloc. GAS will pass |
252b5132 RH |
1353 | the resulting reloc to @code{bfd_install_relocation}. This currently works |
1354 | poorly, as @code{bfd_install_relocation} often does the wrong thing, and | |
1355 | instances of @code{tc_gen_reloc} have been written to work around the problems, | |
1356 | which in turns makes it difficult to fix @code{bfd_install_relocation}. | |
1357 | ||
1358 | @item RELOC_EXPANSION_POSSIBLE | |
1359 | @cindex RELOC_EXPANSION_POSSIBLE | |
1360 | If you define this macro, it means that @code{tc_gen_reloc} may return multiple | |
1361 | relocation entries for a single fixup. In this case, the return value of | |
1362 | @code{tc_gen_reloc} is a pointer to a null terminated array. | |
1363 | ||
1364 | @item MAX_RELOC_EXPANSION | |
1365 | @cindex MAX_RELOC_EXPANSION | |
1366 | You must define this if @code{RELOC_EXPANSION_POSSIBLE} is defined; it | |
1367 | indicates the largest number of relocs which @code{tc_gen_reloc} may return for | |
1368 | a single fixup. | |
1369 | ||
1370 | @item tc_fix_adjustable | |
1371 | @cindex tc_fix_adjustable | |
1372 | You may define this macro to indicate whether a fixup against a locally defined | |
1373 | symbol should be adjusted to be against the section symbol. It should return a | |
1374 | non-zero value if the adjustment is acceptable. | |
1375 | ||
1262d520 | 1376 | @item MD_PCREL_FROM_SECTION (@var{fixp}, @var{section}) |
252b5132 | 1377 | @cindex MD_PCREL_FROM_SECTION |
1262d520 JR |
1378 | If you define this macro, it should return the position from which the PC |
1379 | relative adjustment for a PC relative fixup should be made. On many | |
1380 | processors, the base of a PC relative instruction is the next instruction, | |
1381 | so this macro would return the length of an instruction, plus the address of | |
1382 | the PC relative fixup. The latter can be calculated as | |
1383 | @var{fixp}->fx_where + @var{fixp}->fx_frag->fr_address . | |
252b5132 RH |
1384 | |
1385 | @item md_pcrel_from | |
1386 | @cindex md_pcrel_from | |
1387 | This is the default value of @code{MD_PCREL_FROM_SECTION}. The difference is | |
1388 | that @code{md_pcrel_from} does not take a section argument. | |
1389 | ||
1390 | @item tc_frob_label | |
1391 | @cindex tc_frob_label | |
1392 | If you define this macro, GAS will call it each time a label is defined. | |
1393 | ||
a1facbec MR |
1394 | @item tc_new_dot_label |
1395 | @cindex tc_new_dot_label | |
1396 | If you define this macro, GAS will call it each time a fake label is created | |
1397 | off the special dot symbol. | |
1398 | ||
252b5132 RH |
1399 | @item md_section_align |
1400 | @cindex md_section_align | |
1401 | GAS will call this function for each section at the end of the assembly, to | |
65fd87bc ILT |
1402 | permit the CPU backend to adjust the alignment of a section. The function |
1403 | must take two arguments, a @code{segT} for the section and a @code{valueT} | |
1404 | for the size of the section, and return a @code{valueT} for the rounded | |
1405 | size. | |
252b5132 | 1406 | |
9f10757c TW |
1407 | @item md_macro_start |
1408 | @cindex md_macro_start | |
1409 | If defined, GAS will call this macro when it starts to include a macro | |
1410 | expansion. @code{macro_nest} indicates the current macro nesting level, which | |
58a77e41 | 1411 | includes the one being expanded. |
9f10757c TW |
1412 | |
1413 | @item md_macro_info | |
1414 | @cindex md_macro_info | |
1415 | If defined, GAS will call this macro after the macro expansion has been | |
1416 | included in the input and after parsing the macro arguments. The single | |
1417 | argument is a pointer to the macro processing's internal representation of the | |
1418 | macro (macro_entry *), which includes expansion of the formal arguments. | |
1419 | ||
1420 | @item md_macro_end | |
1421 | @cindex md_macro_end | |
1422 | Complement to md_macro_start. If defined, it is called when finished | |
58a77e41 | 1423 | processing an inserted macro expansion, just before decrementing macro_nest. |
9f10757c | 1424 | |
f28e8eb3 TW |
1425 | @item DOUBLEBAR_PARALLEL |
1426 | @cindex DOUBLEBAR_PARALLEL | |
1427 | Affects the preprocessor so that lines containing '||' don't have their | |
1428 | whitespace stripped following the double bar. This is useful for targets that | |
1429 | implement parallel instructions. | |
1430 | ||
1431 | @item KEEP_WHITE_AROUND_COLON | |
1432 | @cindex KEEP_WHITE_AROUND_COLON | |
1433 | Normally, whitespace is compressed and removed when, in the presence of the | |
1434 | colon, the adjoining tokens can be distinguished. This option affects the | |
1435 | preprocessor so that whitespace around colons is preserved. This is useful | |
1436 | when colons might be removed from the input after preprocessing but before | |
1437 | assembling, so that adjoining tokens can still be distinguished if there is | |
062b7c0c | 1438 | whitespace, or concatenated if there is not. |
f28e8eb3 | 1439 | |
252b5132 RH |
1440 | @item tc_frob_section |
1441 | @cindex tc_frob_section | |
829c3ed3 | 1442 | If you define this macro, GAS will call it for each |
252b5132 RH |
1443 | section at the end of the assembly. |
1444 | ||
1445 | @item tc_frob_file_before_adjust | |
1446 | @cindex tc_frob_file_before_adjust | |
1447 | If you define this macro, GAS will call it after the symbol values are | |
1448 | resolved, but before the fixups have been changed from local symbols to section | |
1449 | symbols. | |
1450 | ||
1451 | @item tc_frob_symbol | |
1452 | @cindex tc_frob_symbol | |
1453 | If you define this macro, GAS will call it for each symbol. You can indicate | |
062b7c0c | 1454 | that the symbol should not be included in the object file by defining this |
252b5132 RH |
1455 | macro to set its second argument to a non-zero value. |
1456 | ||
1457 | @item tc_frob_file | |
1458 | @cindex tc_frob_file | |
1459 | If you define this macro, GAS will call it after the symbol table has been | |
1460 | completed, but before the relocations have been generated. | |
1461 | ||
1462 | @item tc_frob_file_after_relocs | |
1463 | If you define this macro, GAS will call it after the relocs have been | |
1464 | generated. | |
1465 | ||
2f0c68f2 CM |
1466 | @item tc_cfi_reloc_for_encoding |
1467 | @cindex tc_cfi_reloc_for_encoding | |
1468 | This macro is used to indicate whether a cfi encoding requires a relocation. | |
1469 | It should return the required relocation type. Defining this macro implies | |
1470 | that Compact EH is supported. | |
1471 | ||
e0001a05 NC |
1472 | @item md_post_relax_hook |
1473 | If you define this macro, GAS will call it after relaxing and sizing the | |
1474 | segments. | |
1475 | ||
252b5132 RH |
1476 | @item LISTING_HEADER |
1477 | A string to use on the header line of a listing. The default value is simply | |
1478 | @code{"GAS LISTING"}. | |
1479 | ||
1480 | @item LISTING_WORD_SIZE | |
1481 | The number of bytes to put into a word in a listing. This affects the way the | |
1482 | bytes are clumped together in the listing. For example, a value of 2 might | |
1483 | print @samp{1234 5678} where a value of 1 would print @samp{12 34 56 78}. The | |
1484 | default value is 4. | |
1485 | ||
1486 | @item LISTING_LHS_WIDTH | |
1487 | The number of words of data to print on the first line of a listing for a | |
1488 | particular source line, where each word is @code{LISTING_WORD_SIZE} bytes. The | |
1489 | default value is 1. | |
1490 | ||
1491 | @item LISTING_LHS_WIDTH_SECOND | |
1492 | Like @code{LISTING_LHS_WIDTH}, but applying to the second and subsequent line | |
1493 | of the data printed for a particular source line. The default value is 1. | |
1494 | ||
1495 | @item LISTING_LHS_CONT_LINES | |
1496 | The maximum number of continuation lines to print in a listing for a particular | |
1497 | source line. The default value is 4. | |
1498 | ||
1499 | @item LISTING_RHS_WIDTH | |
1500 | The maximum number of characters to print from one line of the input file. The | |
1501 | default value is 100. | |
b8a9dcab NC |
1502 | |
1503 | @item TC_COFF_SECTION_DEFAULT_ATTRIBUTES | |
1504 | @cindex TC_COFF_SECTION_DEFAULT_ATTRIBUTES | |
1505 | The COFF @code{.section} directive will use the value of this macro to set | |
1506 | a new section's attributes when a directive has no valid flags or when the | |
1507 | flag is @code{w}. The default value of the macro is @code{SEC_LOAD | SEC_DATA}. | |
1508 | ||
c3c36456 | 1509 | @item DWARF2_FORMAT (@var{sec}) |
14e777e0 KB |
1510 | @cindex DWARF2_FORMAT |
1511 | If you define this, it should return one of @code{dwarf2_format_32bit}, | |
1512 | @code{dwarf2_format_64bit}, or @code{dwarf2_format_64bit_irix} to indicate | |
1513 | the size of internal DWARF section offsets and the format of the DWARF initial | |
1514 | length fields. When @code{dwarf2_format_32bit} is returned, the initial | |
1515 | length field will be 4 bytes long and section offsets are 32 bits in size. | |
1516 | For @code{dwarf2_format_64bit} and @code{dwarf2_format_64bit_irix}, section | |
1517 | offsets are 64 bits in size, but the initial length field differs. An 8 byte | |
1518 | initial length is indicated by @code{dwarf2_format_64bit_irix} and | |
1519 | @code{dwarf2_format_64bit} indicates a 12 byte initial length field in | |
1520 | which the first four bytes are 0xffffffff and the next 8 bytes are | |
1521 | the section's length. | |
1522 | ||
1523 | If you don't define this, @code{dwarf2_format_32bit} will be used as | |
1524 | the default. | |
1525 | ||
c3c36456 | 1526 | This define only affects debug |
14e777e0 KB |
1527 | sections generated by the assembler. DWARF 2 sections generated by |
1528 | other tools will be unaffected by this setting. | |
1529 | ||
9605f328 AO |
1530 | @item DWARF2_ADDR_SIZE (@var{bfd}) |
1531 | @cindex DWARF2_ADDR_SIZE | |
1532 | It should return the size of an address, as it should be represented in | |
1533 | debugging info. If you don't define this macro, the default definition uses | |
1534 | the number of bits per address, as defined in @var{bfd}, divided by 8. | |
1535 | ||
329e276d NC |
1536 | @item MD_DEBUG_FORMAT_SELECTOR |
1537 | @cindex MD_DEBUG_FORMAT_SELECTOR | |
1538 | If defined this macro is the name of a function to be called when the | |
1539 | @samp{--gen-debug} switch is detected on the assembler's command line. The | |
1540 | prototype for the function looks like this: | |
1541 | ||
1542 | @smallexample | |
1543 | enum debug_info_type MD_DEBUG_FORMAT_SELECTOR (int * use_gnu_extensions) | |
1544 | @end smallexample | |
1545 | ||
1546 | The function should return the debug format that is preferred by the CPU | |
1547 | backend. This format will be used when generating assembler specific debug | |
1548 | information. | |
1549 | ||
bfff1642 NC |
1550 | @item md_allow_local_subtract (@var{left}, @var{right}, @var{section}) |
1551 | If defined, GAS will call this macro when evaluating an expression which is the | |
1552 | difference of two symbols defined in the same section. It takes three | |
1553 | arguments: @code{expressioS * @var{left}} which is the symbolic expression on | |
1554 | the left hand side of the subtraction operation, @code{expressionS * | |
1555 | @var{right}} which is the symbolic expression on the right hand side of the | |
1556 | subtraction, and @code{segT @var{section}} which is the section containing the two | |
1557 | symbols. The macro should return a non-zero value if the expression should be | |
1558 | evaluated. Targets which implement link time relaxation which may change the | |
1559 | position of the two symbols relative to each other should ensure that this | |
1560 | macro returns zero in situations where this can occur. | |
1561 | ||
8c750480 NC |
1562 | @item md_allow_eh_opt |
1563 | If defined, GAS will check this macro before performing any optimizations on | |
1564 | the DWARF call frame debug information that is emitted. Targets which | |
1565 | implement link time relaxation may need to define this macro and set it to zero | |
1566 | if it is possible to change the size of a function's prologue. | |
252b5132 RH |
1567 | @end table |
1568 | ||
1569 | @node Object format backend | |
1570 | @subsection Writing an object format backend | |
1571 | @cindex object format backend | |
1572 | @cindex @file{obj-@var{fmt}} | |
1573 | ||
1574 | As with the CPU backend, the object format backend must define a few things, | |
1575 | and may define some other things. The interface to the object format backend | |
1576 | is generally simpler; most of the support for an object file format consists of | |
1577 | defining a number of pseudo-ops. | |
1578 | ||
1579 | The object format @file{.h} file must include @file{targ-cpu.h}. | |
1580 | ||
252b5132 RH |
1581 | @table @code |
1582 | @item OBJ_@var{format} | |
1583 | @cindex OBJ_@var{format} | |
1584 | By convention, you should define this macro in the @file{.h} file. For | |
1585 | example, @file{obj-elf.h} defines @code{OBJ_ELF}. You might have to use this | |
1586 | if it is necessary to add object file format specific code to the CPU file. | |
1587 | ||
1588 | @item obj_begin | |
1589 | If you define this macro, GAS will call it at the start of the assembly, after | |
a05a5b64 | 1590 | the command-line arguments have been parsed and all the machine independent |
252b5132 RH |
1591 | initializations have been completed. |
1592 | ||
1593 | @item obj_app_file | |
1594 | @cindex obj_app_file | |
1595 | If you define this macro, GAS will invoke it when it sees a @code{.file} | |
1596 | pseudo-op or a @samp{#} line as used by the C preprocessor. | |
1597 | ||
1598 | @item OBJ_COPY_SYMBOL_ATTRIBUTES | |
1599 | @cindex OBJ_COPY_SYMBOL_ATTRIBUTES | |
1600 | You should define this macro to copy object format specific information from | |
1601 | one symbol to another. GAS will call it when one symbol is equated to | |
1602 | another. | |
1603 | ||
252b5132 RH |
1604 | @item obj_sec_sym_ok_for_reloc |
1605 | @cindex obj_sec_sym_ok_for_reloc | |
1606 | You may define this macro to indicate that it is OK to use a section symbol in | |
062b7c0c | 1607 | a relocation entry. If it is not, GAS will define a new symbol at the start |
252b5132 RH |
1608 | of a section. |
1609 | ||
1610 | @item EMIT_SECTION_SYMBOLS | |
1611 | @cindex EMIT_SECTION_SYMBOLS | |
1612 | You should define this macro with a zero value if you do not want to include | |
1613 | section symbols in the output symbol table. The default value for this macro | |
1614 | is one. | |
1615 | ||
1616 | @item obj_adjust_symtab | |
1617 | @cindex obj_adjust_symtab | |
1618 | If you define this macro, GAS will invoke it just before setting the symbol | |
1619 | table of the output BFD. For example, the COFF support uses this macro to | |
1620 | generate a @code{.file} symbol if none was generated previously. | |
1621 | ||
1622 | @item SEPARATE_STAB_SECTIONS | |
1623 | @cindex SEPARATE_STAB_SECTIONS | |
0aa5d426 HPN |
1624 | You may define this macro to a nonzero value to indicate that stabs should be |
1625 | placed in separate sections, as in ELF. | |
252b5132 RH |
1626 | |
1627 | @item INIT_STAB_SECTION | |
1628 | @cindex INIT_STAB_SECTION | |
1629 | You may define this macro to initialize the stabs section in the output file. | |
1630 | ||
1631 | @item OBJ_PROCESS_STAB | |
1632 | @cindex OBJ_PROCESS_STAB | |
1633 | You may define this macro to do specific processing on a stabs entry. | |
1634 | ||
1635 | @item obj_frob_section | |
1636 | @cindex obj_frob_section | |
1637 | If you define this macro, GAS will call it for each section at the end of the | |
1638 | assembly. | |
1639 | ||
1640 | @item obj_frob_file_before_adjust | |
1641 | @cindex obj_frob_file_before_adjust | |
1642 | If you define this macro, GAS will call it after the symbol values are | |
1643 | resolved, but before the fixups have been changed from local symbols to section | |
1644 | symbols. | |
1645 | ||
1646 | @item obj_frob_symbol | |
1647 | @cindex obj_frob_symbol | |
1648 | If you define this macro, GAS will call it for each symbol. You can indicate | |
062b7c0c | 1649 | that the symbol should not be included in the object file by defining this |
252b5132 RH |
1650 | macro to set its second argument to a non-zero value. |
1651 | ||
06e77878 AO |
1652 | @item obj_set_weak_hook |
1653 | @cindex obj_set_weak_hook | |
1654 | If you define this macro, @code{S_SET_WEAK} will call it before modifying the | |
1655 | symbol's flags. | |
1656 | ||
1657 | @item obj_clear_weak_hook | |
1658 | @cindex obj_clear_weak_hook | |
b45619c0 | 1659 | If you define this macro, @code{S_CLEAR_WEAKREFD} will call it after cleaning |
06e77878 AO |
1660 | the @code{weakrefd} flag, but before modifying any other flags. |
1661 | ||
252b5132 RH |
1662 | @item obj_frob_file |
1663 | @cindex obj_frob_file | |
1664 | If you define this macro, GAS will call it after the symbol table has been | |
1665 | completed, but before the relocations have been generated. | |
1666 | ||
1667 | @item obj_frob_file_after_relocs | |
1668 | If you define this macro, GAS will call it after the relocs have been | |
1669 | generated. | |
945a1a6b ILT |
1670 | |
1671 | @item SET_SECTION_RELOCS (@var{sec}, @var{relocs}, @var{n}) | |
1672 | @cindex SET_SECTION_RELOCS | |
1673 | If you define this, it will be called after the relocations have been set for | |
1674 | the section @var{sec}. The list of relocations is in @var{relocs}, and the | |
829c3ed3 | 1675 | number of relocations is in @var{n}. |
252b5132 RH |
1676 | @end table |
1677 | ||
1678 | @node Emulations | |
1679 | @subsection Writing emulation files | |
1680 | ||
1681 | Normally you do not have to write an emulation file. You can just use | |
1682 | @file{te-generic.h}. | |
1683 | ||
1684 | If you do write your own emulation file, it must include @file{obj-format.h}. | |
1685 | ||
1686 | An emulation file will often define @code{TE_@var{EM}}; this may then be used | |
1687 | in other files to change the output. | |
1688 | ||
1689 | @node Relaxation | |
1690 | @section Relaxation | |
1691 | @cindex relaxation | |
1692 | ||
1693 | @dfn{Relaxation} is a generic term used when the size of some instruction or | |
1694 | data depends upon the value of some symbol or other data. | |
1695 | ||
1696 | GAS knows to relax a particular type of PC relative relocation using a table. | |
1697 | You can also define arbitrarily complex forms of relaxation yourself. | |
1698 | ||
1699 | @menu | |
1700 | * Relaxing with a table:: Relaxing with a table | |
1701 | * General relaxing:: General relaxing | |
1702 | @end menu | |
1703 | ||
1704 | @node Relaxing with a table | |
1705 | @subsection Relaxing with a table | |
1706 | ||
1707 | If you do not define @code{md_relax_frag}, and you do define | |
1708 | @code{TC_GENERIC_RELAX_TABLE}, GAS will relax @code{rs_machine_dependent} frags | |
1709 | based on the frag subtype and the displacement to some specified target | |
1710 | address. The basic idea is that several machines have different addressing | |
1711 | modes for instructions that can specify different ranges of values, with | |
1712 | successive modes able to access wider ranges, including the entirety of the | |
1713 | previous range. Smaller ranges are assumed to be more desirable (perhaps the | |
1714 | instruction requires one word instead of two or three); if this is not the | |
1715 | case, don't describe the smaller-range, inferior mode. | |
1716 | ||
1717 | The @code{fr_subtype} field of a frag is an index into a CPU-specific | |
1718 | relaxation table. That table entry indicates the range of values that can be | |
1719 | stored, the number of bytes that will have to be added to the frag to | |
062b7c0c | 1720 | accommodate the addressing mode, and the index of the next entry to examine if |
252b5132 RH |
1721 | the value to be stored is outside the range accessible by the current |
1722 | addressing mode. The @code{fr_symbol} field of the frag indicates what symbol | |
1723 | is to be accessed; the @code{fr_offset} field is added in. | |
1724 | ||
1725 | If the @code{TC_PCREL_ADJUST} macro is defined, which currently should only happen | |
1726 | for the NS32k family, the @code{TC_PCREL_ADJUST} macro is called on the frag to | |
1727 | compute an adjustment to be made to the displacement. | |
1728 | ||
1729 | The value fitted by the relaxation code is always assumed to be a displacement | |
1730 | from the current frag. (More specifically, from @code{fr_fix} bytes into the | |
1731 | frag.) | |
1732 | @ignore | |
1733 | This seems kinda silly. What about fitting small absolute values? I suppose | |
1734 | @code{md_assemble} is supposed to take care of that, but if the operand is a | |
1735 | difference between symbols, it might not be able to, if the difference was not | |
1736 | computable yet. | |
1737 | @end ignore | |
1738 | ||
1739 | The end of the relaxation sequence is indicated by a ``next'' value of 0. This | |
1740 | means that the first entry in the table can't be used. | |
1741 | ||
1742 | For some configurations, the linker can do relaxing within a section of an | |
1743 | object file. If call instructions of various sizes exist, the linker can | |
1744 | determine which should be used in each instance, when a symbol's value is | |
1745 | resolved. In order for the linker to avoid wasting space and having to insert | |
1746 | no-op instructions, it must be able to expand or shrink the section contents | |
1747 | while still preserving intra-section references and meeting alignment | |
1748 | requirements. | |
1749 | ||
252b5132 RH |
1750 | For the H8/300, I think the linker expands calls that can't reach, and doesn't |
1751 | worry about alignment issues; the cpu probably never needs any significant | |
1752 | alignment beyond the instruction size. | |
1753 | ||
1754 | The relaxation table type contains these fields: | |
1755 | ||
1756 | @table @code | |
1757 | @item long rlx_forward | |
1758 | Forward reach, must be non-negative. | |
1759 | @item long rlx_backward | |
1760 | Backward reach, must be zero or negative. | |
1761 | @item rlx_length | |
1762 | Length in bytes of this addressing mode. | |
1763 | @item rlx_more | |
1764 | Index of the next-longer relax state, or zero if there is no next relax state. | |
1765 | @end table | |
1766 | ||
1767 | The relaxation is done in @code{relax_segment} in @file{write.c}. The | |
1768 | difference in the length fields between the original mode and the one finally | |
1769 | chosen by the relaxing code is taken as the size by which the current frag will | |
1770 | be increased in size. For example, if the initial relaxing mode has a length | |
1771 | of 2 bytes, and because of the size of the displacement, it gets upgraded to a | |
1772 | mode with a size of 6 bytes, it is assumed that the frag will grow by 4 bytes. | |
1773 | (The initial two bytes should have been part of the fixed portion of the frag, | |
1774 | since it is already known that they will be output.) This growth must be | |
1775 | effected by @code{md_convert_frag}; it should increase the @code{fr_fix} field | |
1776 | by the appropriate size, and fill in the appropriate bytes of the frag. | |
1777 | (Enough space for the maximum growth should have been allocated in the call to | |
1778 | frag_var as the second argument.) | |
1779 | ||
1780 | If relocation records are needed, they should be emitted by | |
1781 | @code{md_estimate_size_before_relax}. This function should examine the target | |
1782 | symbol of the supplied frag and correct the @code{fr_subtype} of the frag if | |
1783 | needed. When this function is called, if the symbol has not yet been defined, | |
1784 | it will not become defined later; however, its value may still change if the | |
1785 | section it is in gets relaxed. | |
1786 | ||
1787 | Usually, if the symbol is in the same section as the frag (given by the | |
1788 | @var{sec} argument), the narrowest likely relaxation mode is stored in | |
1789 | @code{fr_subtype}, and that's that. | |
1790 | ||
60493797 | 1791 | If the symbol is undefined, or in a different section (and therefore movable |
252b5132 RH |
1792 | to an arbitrarily large distance), the largest available relaxation mode is |
1793 | specified, @code{fix_new} is called to produce the relocation record, | |
1794 | @code{fr_fix} is increased to include the relocated field (remember, this | |
1795 | storage was allocated when @code{frag_var} was called), and @code{frag_wane} is | |
1796 | called to convert the frag to an @code{rs_fill} frag with no variant part. | |
1797 | Sometimes changing addressing modes may also require rewriting the instruction. | |
1798 | It can be accessed via @code{fr_opcode} or @code{fr_fix}. | |
1799 | ||
67db5ab4 HPN |
1800 | If you generate frags separately for the basic insn opcode and any relaxable |
1801 | operands, do not call @code{fix_new} thinking you can emit fixups for the | |
062b7c0c | 1802 | opcode field from the relaxable frag. It is not guaranteed to be the same frag. |
67db5ab4 HPN |
1803 | If you need to emit fixups for the opcode field from inspection of the |
1804 | relaxable frag, then you need to generate a common frag for both the basic | |
1805 | opcode and relaxable fields, or you need to provide the frag for the opcode to | |
1806 | pass to @code{fix_new}. The latter can be done for example by defining | |
1807 | @code{TC_FRAG_TYPE} to include a pointer to it and defining @code{TC_FRAG_INIT} | |
1808 | to set the pointer. | |
1809 | ||
252b5132 RH |
1810 | Sometimes @code{fr_var} is increased instead, and @code{frag_wane} is not |
1811 | called. I'm not sure, but I think this is to keep @code{fr_fix} referring to | |
1812 | an earlier byte, and @code{fr_subtype} set to @code{rs_machine_dependent} so | |
1813 | that @code{md_convert_frag} will get called. | |
1814 | ||
1815 | @node General relaxing | |
1816 | @subsection General relaxing | |
1817 | ||
1818 | If using a simple table is not suitable, you may implement arbitrarily complex | |
1819 | relaxation semantics yourself. For example, the MIPS backend uses this to emit | |
1820 | different instruction sequences depending upon the size of the symbol being | |
1821 | accessed. | |
1822 | ||
1823 | When you assemble an instruction that may need relaxation, you should allocate | |
1824 | a frag using @code{frag_var} or @code{frag_variant} with a type of | |
1825 | @code{rs_machine_dependent}. You should store some sort of information in the | |
1826 | @code{fr_subtype} field so that you can figure out what to do with the frag | |
1827 | later. | |
1828 | ||
1829 | When GAS reaches the end of the input file, it will look through the frags and | |
1830 | work out their final sizes. | |
1831 | ||
1832 | GAS will first call @code{md_estimate_size_before_relax} on each | |
1833 | @code{rs_machine_dependent} frag. This function must return an estimated size | |
1834 | for the frag. | |
1835 | ||
1836 | GAS will then loop over the frags, calling @code{md_relax_frag} on each | |
1837 | @code{rs_machine_dependent} frag. This function should return the change in | |
1838 | size of the frag. GAS will keep looping over the frags until none of the frags | |
1839 | changes size. | |
1840 | ||
1841 | @node Broken words | |
1842 | @section Broken words | |
1843 | @cindex internals, broken words | |
1844 | @cindex broken words | |
1845 | ||
1846 | Some compilers, including GCC, will sometimes emit switch tables specifying | |
1847 | 16-bit @code{.word} displacements to branch targets, and branch instructions | |
1848 | that load entries from that table to compute the target address. If this is | |
1849 | done on a 32-bit machine, there is a chance (at least with really large | |
1850 | functions) that the displacement will not fit in 16 bits. The assembler | |
1851 | handles this using a concept called @dfn{broken words}. This idea is well | |
1852 | named, since there is an implied promise that the 16-bit field will in fact | |
1853 | hold the specified displacement. | |
1854 | ||
1855 | If broken word processing is enabled, and a situation like this is encountered, | |
1856 | the assembler will insert a jump instruction into the instruction stream, close | |
1857 | enough to be reached with the 16-bit displacement. This jump instruction will | |
1858 | transfer to the real desired target address. Thus, as long as the @code{.word} | |
1859 | value really is used as a displacement to compute an address to jump to, the | |
1860 | net effect will be correct (minus a very small efficiency cost). If | |
1861 | @code{.word} directives with label differences for values are used for other | |
1862 | purposes, however, things may not work properly. For targets which use broken | |
1863 | words, the @samp{-K} option will warn when a broken word is discovered. | |
1864 | ||
1865 | The broken word code is turned off by the @code{WORKING_DOT_WORD} macro. It | |
1866 | isn't needed if @code{.word} emits a value large enough to contain an address | |
1867 | (or, more correctly, any possible difference between two addresses). | |
1868 | ||
1869 | @node Internal functions | |
1870 | @section Internal functions | |
1871 | ||
1872 | This section describes basic internal functions used by GAS. | |
1873 | ||
1874 | @menu | |
1875 | * Warning and error messages:: Warning and error messages | |
1876 | * Hash tables:: Hash tables | |
1877 | @end menu | |
1878 | ||
1879 | @node Warning and error messages | |
1880 | @subsection Warning and error messages | |
1881 | ||
1882 | @deftypefun @{@} int had_warnings (void) | |
1883 | @deftypefunx @{@} int had_errors (void) | |
1884 | Returns non-zero if any warnings or errors, respectively, have been printed | |
1885 | during this invocation. | |
1886 | @end deftypefun | |
1887 | ||
252b5132 RH |
1888 | @deftypefun @{@} void as_tsktsk (const char *@var{format}, ...) |
1889 | @deftypefunx @{@} void as_warn (const char *@var{format}, ...) | |
1890 | @deftypefunx @{@} void as_bad (const char *@var{format}, ...) | |
1891 | @deftypefunx @{@} void as_fatal (const char *@var{format}, ...) | |
1892 | These functions display messages about something amiss with the input file, or | |
1893 | internal problems in the assembler itself. The current file name and line | |
1894 | number are printed, followed by the supplied message, formatted using | |
1895 | @code{vfprintf}, and a final newline. | |
1896 | ||
1897 | An error indicated by @code{as_bad} will result in a non-zero exit status when | |
1898 | the assembler has finished. Calling @code{as_fatal} will result in immediate | |
1899 | termination of the assembler process. | |
1900 | @end deftypefun | |
1901 | ||
1902 | @deftypefun @{@} void as_warn_where (char *@var{file}, unsigned int @var{line}, const char *@var{format}, ...) | |
1903 | @deftypefunx @{@} void as_bad_where (char *@var{file}, unsigned int @var{line}, const char *@var{format}, ...) | |
1904 | These variants permit specification of the file name and line number, and are | |
1905 | used when problems are detected when reprocessing information saved away when | |
1906 | processing some earlier part of the file. For example, fixups are processed | |
1907 | after all input has been read, but messages about fixups should refer to the | |
1908 | original filename and line number that they are applicable to. | |
1909 | @end deftypefun | |
1910 | ||
87c245cc BE |
1911 | @deftypefun @{@} void sprint_value (char *@var{buf}, valueT @var{val}) |
1912 | This function is helpful for converting a @code{valueT} value into printable | |
252b5132 RH |
1913 | format, in case it's wider than modes that @code{*printf} can handle. If the |
1914 | type is narrow enough, a decimal number will be produced; otherwise, it will be | |
1915 | in hexadecimal. The value itself is not examined to make this determination. | |
1916 | @end deftypefun | |
1917 | ||
1918 | @node Hash tables | |
1919 | @subsection Hash tables | |
1920 | @cindex hash tables | |
1921 | ||
1922 | @deftypefun @{@} @{struct hash_control *@} hash_new (void) | |
1923 | Creates the hash table control structure. | |
1924 | @end deftypefun | |
1925 | ||
1926 | @deftypefun @{@} void hash_die (struct hash_control *) | |
1927 | Destroy a hash table. | |
1928 | @end deftypefun | |
1929 | ||
5a49b8ac | 1930 | @deftypefun @{@} void *hash_delete (struct hash_control *, const char *, int) |
818236e5 AM |
1931 | Deletes entry from the hash table, returns the value it had. If the last |
1932 | arg is non-zero, free memory allocated for this entry and all entries | |
1933 | allocated more recently than this entry. | |
252b5132 RH |
1934 | @end deftypefun |
1935 | ||
5a49b8ac | 1936 | @deftypefun @{@} void *hash_replace (struct hash_control *, const char *, void *) |
252b5132 RH |
1937 | Updates the value for an entry already in the table, returning the old value. |
1938 | If no entry was found, just returns NULL. | |
1939 | @end deftypefun | |
1940 | ||
5a49b8ac | 1941 | @deftypefun @{@} @{const char *@} hash_insert (struct hash_control *, const char *, void *) |
252b5132 RH |
1942 | Inserting a value already in the table is an error. |
1943 | Returns an error message or NULL. | |
1944 | @end deftypefun | |
1945 | ||
5a49b8ac | 1946 | @deftypefun @{@} @{const char *@} hash_jam (struct hash_control *, const char *, void *) |
252b5132 RH |
1947 | Inserts if the value isn't already present, updates it if it is. |
1948 | @end deftypefun | |
1949 | ||
1950 | @node Test suite | |
1951 | @section Test suite | |
1952 | @cindex test suite | |
1953 | ||
1954 | The test suite is kind of lame for most processors. Often it only checks to | |
1955 | see if a couple of files can be assembled without the assembler reporting any | |
1956 | errors. For more complete testing, write a test which either examines the | |
1957 | assembler listing, or runs @code{objdump} and examines its output. For the | |
1958 | latter, the TCL procedure @code{run_dump_test} may come in handy. It takes the | |
1959 | base name of a file, and looks for @file{@var{file}.d}. This file should | |
1960 | contain as its initial lines a set of variable settings in @samp{#} comments, | |
1961 | in the form: | |
1962 | ||
1963 | @example | |
1964 | #@var{varname}: @var{value} | |
1965 | @end example | |
1966 | ||
1967 | The @var{varname} may be @code{objdump}, @code{nm}, or @code{as}, in which case | |
1968 | it specifies the options to be passed to the specified programs. Exactly one | |
1969 | of @code{objdump} or @code{nm} must be specified, as that also specifies which | |
1970 | program to run after the assembler has finished. If @var{varname} is | |
1971 | @code{source}, it specifies the name of the source file; otherwise, | |
1972 | @file{@var{file}.s} is used. If @var{varname} is @code{name}, it specifies the | |
1973 | name of the test to be used in the @code{pass} or @code{fail} messages. | |
1974 | ||
1975 | The non-commented parts of the file are interpreted as regular expressions, one | |
1976 | per line. Blank lines in the @code{objdump} or @code{nm} output are skipped, | |
1977 | as are blank lines in the @code{.d} file; the other lines are tested to see if | |
1978 | the regular expression matches the program output. If it does not, the test | |
1979 | fails. | |
1980 | ||
1981 | Note that this means the tests must be modified if the @code{objdump} output | |
1982 | style is changed. | |
1983 | ||
1984 | @bye | |
1985 | @c Local Variables: | |
1986 | @c fill-column: 79 | |
1987 | @c End: |