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