1 /* as.h - global header file 2 Copyright (C) 1987-2022 Free Software Foundation, Inc. 3 4 This file is part of GAS, the GNU Assembler. 5 6 GAS is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 3, or (at your option) 9 any later version. 10 11 GAS is distributed in the hope that it will be useful, but WITHOUT 12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 13 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public 14 License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GAS; see the file COPYING. If not, write to the Free 18 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA 19 02110-1301, USA. */ 20 21 #ifndef GAS 22 #define GAS 1 23 /* I think this stuff is largely out of date. xoxorich. 24 25 CAPITALISED names are #defined. 26 "lowercaseH" is #defined if "lowercase.h" has been #include-d. 27 "lowercaseT" is a typedef of "lowercase" objects. 28 "lowercaseP" is type "pointer to object of type 'lowercase'". 29 "lowercaseS" is typedef struct ... lowercaseS. 30 31 #define DEBUG to enable all the "know" assertion tests. 32 #define SUSPECT when debugging hash code. 33 #define COMMON as "extern" for all modules except one, where you #define 34 COMMON as "". 35 If TEST is #defined, then we are testing a module: #define COMMON as "". */ 36 37 #include "config.h" 38 39 /* Now, tend to the rest of the configuration. */ 40 41 /* System include files first... */ 42 #include <stdio.h> 43 #include <string.h> 44 #include <stdlib.h> 45 46 #ifdef HAVE_UNISTD_H 47 #include <unistd.h> 48 #endif 49 #ifdef HAVE_SYS_TYPES_H 50 /* for size_t, pid_t */ 51 #include <sys/types.h> 52 #endif 53 54 #include <errno.h> 55 #include <stdarg.h> 56 57 #include "getopt.h" 58 /* The first getopt value for machine-independent long options. 59 150 isn't special; it's just an arbitrary non-ASCII char value. */ 60 #define OPTION_STD_BASE 150 61 /* The first getopt value for machine-dependent long options. 62 290 gives the standard options room to grow. */ 63 #define OPTION_MD_BASE 290 64 65 #ifdef DEBUG 66 #undef NDEBUG 67 #endif 68 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6) 69 #define __PRETTY_FUNCTION__ ((char *) NULL) 70 #endif 71 #define gas_assert(P) ((void) ((P) ? 0 : (abort (), 0))) 72 #undef abort 73 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__) 74 75 /* Now GNU header files... */ 76 #include "ansidecl.h" 77 #include "bfd.h" 78 #include "libiberty.h" 79 80 /* Define the standard progress macros. */ 81 #include "progress.h" 82 83 /* Other stuff from config.h. */ 84 #ifdef NEED_DECLARATION_ENVIRON 85 extern char **environ; 86 #endif 87 #ifdef NEED_DECLARATION_FFS 88 extern int ffs (int); 89 #endif 90 91 #if !HAVE_DECL_MEMPCPY 92 void *mempcpy(void *, const void *, size_t); 93 #endif 94 95 #ifndef __LINE__ 96 #define __LINE__ "unknown" 97 #endif /* __LINE__ */ 98 99 #ifndef __FILE__ 100 #define __FILE__ "unknown" 101 #endif /* __FILE__ */ 102 103 #ifndef FOPEN_WB 104 #ifdef USE_BINARY_FOPEN 105 #include "fopen-bin.h" 106 #else 107 #include "fopen-same.h" 108 #endif 109 #endif 110 111 #ifndef EXIT_SUCCESS 112 #define EXIT_SUCCESS 0 113 #define EXIT_FAILURE 1 114 #endif 115 116 #ifndef SEEK_SET 117 #define SEEK_SET 0 118 #endif 119 120 #define obstack_chunk_alloc xmalloc 121 #define obstack_chunk_free xfree 122 123 #define xfree free 124 125 #include "asintl.h" 126 127 #define BAD_CASE(val) \ 128 { \ 129 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \ 130 (long) val, __LINE__, __FILE__); \ 131 } 132 133 #include "flonum.h" 134 135 /* These are assembler-wide concepts */ 136 137 extern bfd *stdoutput; 138 typedef bfd_vma addressT; 139 typedef bfd_signed_vma offsetT; 140 141 /* Type of symbol value, etc. For use in prototypes. */ 142 typedef addressT valueT; 143 144 #ifndef COMMON 145 #ifdef TEST 146 #define COMMON /* Declare our COMMONs storage here. */ 147 #else 148 #define COMMON extern /* Our commons live elsewhere. */ 149 #endif 150 #endif 151 /* COMMON now defined */ 152 153 #ifndef ENABLE_CHECKING 154 #define ENABLE_CHECKING 0 155 #endif 156 157 #if ENABLE_CHECKING || defined (DEBUG) 158 #ifndef know 159 #define know(p) gas_assert(p) /* Verify our assumptions! */ 160 #endif /* not yet defined */ 161 #else 162 #define know(p) do {} while (0) /* know() checks are no-op.ed */ 163 #endif 164 165 /* input_scrub.c */ 166 167 /* Supplies sanitised buffers to read.c. 168 Also understands printing line-number part of error messages. */ 169 170 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/ 171 172 typedef asection *segT; 173 #define SEG_NORMAL(SEG) ( (SEG) != absolute_section \ 174 && (SEG) != undefined_section \ 175 && (SEG) != reg_section \ 176 && (SEG) != expr_section) 177 typedef int subsegT; 178 179 /* What subseg we are accessing now? */ 180 COMMON subsegT now_subseg; 181 182 /* Segment our instructions emit to. */ 183 COMMON segT now_seg; 184 185 #define segment_name(SEG) bfd_section_name (SEG) 186 187 extern segT reg_section, expr_section; 188 /* Shouldn't these be eliminated someday? */ 189 extern segT text_section, data_section, bss_section; 190 #define absolute_section bfd_abs_section_ptr 191 #define undefined_section bfd_und_section_ptr 192 193 enum _relax_state 194 { 195 /* Dummy frag used by listing code. */ 196 rs_dummy = 0, 197 198 /* Variable chars to be repeated fr_offset times. 199 Fr_symbol unused. Used with fr_offset == 0 for a 200 constant length frag. */ 201 rs_fill, 202 203 /* Align. The fr_offset field holds the power of 2 to which to 204 align. The fr_var field holds the number of characters in the 205 fill pattern. The fr_subtype field holds the maximum number of 206 bytes to skip when aligning, or 0 if there is no maximum. */ 207 rs_align, 208 209 /* Align code. The fr_offset field holds the power of 2 to which 210 to align. This type is only generated by machine specific 211 code, which is normally responsible for handling the fill 212 pattern. The fr_subtype field holds the maximum number of 213 bytes to skip when aligning, or 0 if there is no maximum. */ 214 rs_align_code, 215 216 /* Test for alignment. Like rs_align, but used by several targets 217 to warn if data is not properly aligned. */ 218 rs_align_test, 219 220 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill 221 character. */ 222 rs_org, 223 224 #ifndef WORKING_DOT_WORD 225 /* JF: gunpoint */ 226 rs_broken_word, 227 #endif 228 229 /* Machine specific relaxable (or similarly alterable) instruction. */ 230 rs_machine_dependent, 231 232 /* .space directive with expression operand that needs to be computed 233 later. Similar to rs_org, but different. 234 fr_symbol: operand 235 1 variable char: fill character */ 236 rs_space, 237 238 /* .nop directive with expression operand that needs to be computed 239 later. Similar to rs_space, but different. It fills with no-op 240 instructions. 241 fr_symbol: operand 242 1 constant byte: no-op fill control byte. */ 243 rs_space_nop, 244 245 /* Similar to rs_fill. It is used to implement .nop directive . */ 246 rs_fill_nop, 247 248 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for 249 unsigned, 1 for signed. */ 250 rs_leb128, 251 252 /* Exception frame information which we may be able to optimize. */ 253 rs_cfa, 254 255 /* Cross-fragment dwarf2 line number optimization. */ 256 rs_dwarf2dbg 257 }; 258 259 typedef enum _relax_state relax_stateT; 260 261 /* This type is used in prototypes, so it can't be a type that will be 262 widened for argument passing. */ 263 typedef unsigned int relax_substateT; 264 265 /* Enough bits for address, but still an integer type. 266 Could be a problem, cross-assembling for 64-bit machines. */ 267 typedef addressT relax_addressT; 268 269 struct relax_type 270 { 271 /* Forward reach. Signed number. > 0. */ 272 offsetT rlx_forward; 273 /* Backward reach. Signed number. < 0. */ 274 offsetT rlx_backward; 275 276 /* Bytes length of this address. */ 277 unsigned char rlx_length; 278 279 /* Next longer relax-state. 0 means there is no 'next' relax-state. */ 280 relax_substateT rlx_more; 281 }; 282 283 typedef struct relax_type relax_typeS; 284 285 /* main program "as.c" (command arguments etc). */ 286 287 COMMON unsigned char flag_no_comments; /* -f */ 288 COMMON unsigned char flag_debug; /* -D */ 289 COMMON unsigned char flag_signed_overflow_ok; /* -J */ 290 #ifndef WORKING_DOT_WORD 291 COMMON unsigned char flag_warn_displacement; /* -K */ 292 #endif 293 294 /* True if local symbols should be retained. */ 295 COMMON int flag_keep_locals; /* -L */ 296 297 /* True if we are assembling in MRI mode. */ 298 COMMON int flag_mri; 299 300 /* Should the data section be made read-only and appended to the text 301 section? */ 302 COMMON unsigned char flag_readonly_data_in_text; /* -R */ 303 304 /* True if warnings should be inhibited. */ 305 COMMON int flag_no_warnings; /* -W */ 306 307 /* True if warnings count as errors. */ 308 COMMON int flag_fatal_warnings; /* --fatal-warnings */ 309 310 /* True if we should attempt to generate output even if non-fatal errors 311 are detected. */ 312 COMMON unsigned char flag_always_generate_output; /* -Z */ 313 314 /* This is true if the assembler should output time and space usage. */ 315 COMMON unsigned char flag_print_statistics; 316 317 /* True if local absolute symbols are to be stripped. */ 318 COMMON int flag_strip_local_absolute; 319 320 /* True if we should generate a traditional format object file. */ 321 COMMON int flag_traditional_format; 322 323 /* Type of compressed debug sections we should generate. */ 324 COMMON enum compressed_debug_section_type flag_compress_debug; 325 326 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */ 327 COMMON int flag_execstack; 328 329 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */ 330 COMMON int flag_noexecstack; 331 332 /* name of emitted object file */ 333 COMMON const char *out_file_name; 334 335 /* name of file defining extensions to the basic instruction set */ 336 COMMON char *insttbl_file_name; 337 338 /* TRUE if we need a second pass. */ 339 COMMON int need_pass_2; 340 341 /* TRUE if we should do no relaxing, and 342 leave lots of padding. */ 343 COMMON int linkrelax; 344 345 COMMON int do_not_pad_sections_to_alignment; 346 347 enum multibyte_input_handling 348 { 349 multibyte_allow = 0, 350 multibyte_warn, 351 multibyte_warn_syms 352 }; 353 COMMON enum multibyte_input_handling multibyte_handling; 354 355 /* TRUE if we should produce a listing. */ 356 extern int listing; 357 358 /* Type of debugging information we should generate. We currently support 359 stabs, ECOFF, and DWARF2. 360 361 NOTE! This means debug information about the assembly source code itself 362 and _not_ about possible debug information from a high-level language. 363 This is especially relevant to DWARF2, since the compiler may emit line 364 number directives that the assembler resolves. */ 365 366 enum debug_info_type 367 { 368 DEBUG_UNSPECIFIED, 369 DEBUG_NONE, 370 DEBUG_STABS, 371 DEBUG_ECOFF, 372 DEBUG_DWARF, 373 DEBUG_DWARF2 374 }; 375 376 extern enum debug_info_type debug_type; 377 extern int use_gnu_debug_info_extensions; 378 COMMON bool flag_dwarf_sections; 379 extern int flag_dwarf_cie_version; 380 extern unsigned int dwarf_level; 381 382 /* Maximum level of macro nesting. */ 383 extern int max_macro_nest; 384 385 /* Verbosity level. */ 386 extern int verbose; 387 388 struct obstack; 389 390 /* Obstack chunk size. Keep large for efficient space use, make small to 391 increase malloc calls for monitoring memory allocation. */ 392 extern int chunksize; 393 394 struct _pseudo_type 395 { 396 /* assembler mnemonic, lower case, no '.' */ 397 const char *poc_name; 398 /* Do the work */ 399 void (*poc_handler) (int); 400 /* Value to pass to handler */ 401 int poc_val; 402 }; 403 404 typedef struct _pseudo_type pseudo_typeS; 405 406 #if (__GNUC__ >= 2) && !defined(VMS) 407 /* for use with -Wformat */ 408 409 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6 410 /* Support for double underscores in attribute names was added in gcc 411 2.6, so avoid them if we are using an earlier version. */ 412 #define __printf__ printf 413 #define __format__ format 414 #endif 415 416 #define PRINTF_LIKE(FCN) \ 417 void FCN (const char *format, ...) \ 418 __attribute__ ((__format__ (__printf__, 1, 2))) 419 #define PRINTF_WHERE_LIKE(FCN) \ 420 void FCN (const char *file, unsigned int line, const char *format, ...) \ 421 __attribute__ ((__format__ (__printf__, 3, 4))) 422 423 #else /* __GNUC__ < 2 || defined(VMS) */ 424 425 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...) 426 #define PRINTF_WHERE_LIKE(FCN) void FCN (const char *file, \ 427 unsigned int line, \ 428 const char *format, ...) 429 430 #endif /* __GNUC__ < 2 || defined(VMS) */ 431 432 PRINTF_LIKE (as_bad); 433 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN; 434 PRINTF_LIKE (as_tsktsk); 435 PRINTF_LIKE (as_warn); 436 PRINTF_WHERE_LIKE (as_bad_where); 437 PRINTF_WHERE_LIKE (as_warn_where); 438 439 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN; 440 void signal_init (void); 441 int had_errors (void); 442 int had_warnings (void); 443 void as_warn_value_out_of_range (const char *, offsetT, offsetT, offsetT, 444 const char *, unsigned); 445 void as_bad_value_out_of_range (const char *, offsetT, offsetT, offsetT, 446 const char *, unsigned); 447 void print_version_id (void); 448 char * app_push (void); 449 450 /* Number of littlenums required to hold an extended precision number. */ 451 #define MAX_LITTLENUMS 6 452 453 char * atof_ieee (char *, int, LITTLENUM_TYPE *); 454 char * atof_ieee_detail (char *, int, int, LITTLENUM_TYPE *, FLONUM_TYPE *); 455 const char * ieee_md_atof (int, char *, int *, bool); 456 const char * vax_md_atof (int, char *, int *); 457 char * input_scrub_include_file (const char *, char *); 458 void input_scrub_insert_line (const char *); 459 void input_scrub_insert_file (char *); 460 char * input_scrub_new_file (const char *); 461 char * input_scrub_next_buffer (char **bufp); 462 size_t do_scrub_chars (size_t (*get) (char *, size_t), char *, size_t); 463 size_t do_scrub_pending (void); 464 bool scan_for_multibyte_characters (const unsigned char *, const unsigned char *, bool); 465 int gen_to_words (LITTLENUM_TYPE *, int, long); 466 int had_err (void); 467 int ignore_input (void); 468 void cond_finish_check (int); 469 void cond_exit_macro (int); 470 int seen_at_least_1_file (void); 471 void app_pop (char *); 472 const char * as_where (unsigned int *); 473 const char * as_where_physical (unsigned int *); 474 void bump_line_counters (void); 475 void do_scrub_begin (int); 476 void input_scrub_begin (void); 477 void input_scrub_close (void); 478 void input_scrub_end (void); 479 void new_logical_line (const char *, int); 480 void new_logical_line_flags (const char *, int, int); 481 void subsegs_begin (void); 482 void subsegs_end (struct obstack **); 483 void subseg_change (segT, int); 484 segT subseg_new (const char *, subsegT); 485 segT subseg_force_new (const char *, subsegT); 486 void subseg_set (segT, subsegT); 487 int subseg_text_p (segT); 488 int seg_not_empty_p (segT); 489 void start_dependencies (char *); 490 void register_dependency (const char *); 491 void print_dependencies (void); 492 segT subseg_get (const char *, int); 493 494 char *remap_debug_filename (const char *); 495 void add_debug_prefix_map (const char *); 496 497 static inline char * 498 xmemdup0 (const char *in, size_t len) 499 { 500 return xmemdup (in, len, len + 1); 501 } 502 503 struct expressionS; 504 struct fix; 505 typedef struct symbol symbolS; 506 typedef struct frag fragS; 507 508 /* literal.c */ 509 valueT add_to_literal_pool (symbolS *, valueT, segT, int); 510 511 int check_eh_frame (struct expressionS *, unsigned int *); 512 int eh_frame_estimate_size_before_relax (fragS *); 513 int eh_frame_relax_frag (fragS *); 514 void eh_frame_convert_frag (fragS *); 515 int generic_force_reloc (struct fix *); 516 517 #include "expr.h" /* Before targ-*.h */ 518 519 /* This one starts the chain of target dependent headers. */ 520 #include "targ-env.h" 521 522 #ifdef OBJ_MAYBE_ELF 523 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour) 524 #else 525 #ifdef OBJ_ELF 526 #define IS_ELF 1 527 #else 528 #define IS_ELF 0 529 #endif 530 #endif 531 532 #include "write.h" 533 #include "frags.h" 534 #include "hashtab.h" 535 #include "hash.h" 536 #include "read.h" 537 #include "symbols.h" 538 539 #include "tc.h" 540 #include "obj.h" 541 542 #ifdef USE_EMULATIONS 543 #include "emul.h" 544 #endif 545 #include "listing.h" 546 547 #ifdef H_TICK_HEX 548 extern int enable_h_tick_hex; 549 #endif 550 551 #ifdef TC_M68K 552 /* True if we are assembling in m68k MRI mode. */ 553 COMMON int flag_m68k_mri; 554 #define DOLLAR_AMBIGU flag_m68k_mri 555 #else 556 #define flag_m68k_mri 0 557 #endif 558 559 #ifndef TC_STRING_ESCAPES 560 #define TC_STRING_ESCAPES 1 561 #endif 562 563 #ifdef WARN_COMMENTS 564 COMMON int warn_comment; 565 COMMON unsigned int found_comment; 566 COMMON const char * found_comment_file; 567 #endif 568 569 #if defined OBJ_ELF || defined OBJ_MAYBE_ELF 570 /* If .size directive failure should be error or warning. */ 571 COMMON int flag_allow_nonconst_size; 572 573 /* If we should generate ELF common symbols with the STT_COMMON type. */ 574 extern int flag_use_elf_stt_common; 575 576 /* TRUE iff GNU Build attribute notes should 577 be generated if none are in the input files. */ 578 extern bool flag_generate_build_notes; 579 580 /* If section name substitution sequences should be honored */ 581 COMMON int flag_sectname_subst; 582 #endif 583 584 #ifndef DOLLAR_AMBIGU 585 #define DOLLAR_AMBIGU 0 586 #endif 587 588 #ifndef NUMBERS_WITH_SUFFIX 589 #define NUMBERS_WITH_SUFFIX 0 590 #endif 591 592 #ifndef LOCAL_LABELS_DOLLAR 593 #define LOCAL_LABELS_DOLLAR 0 594 #endif 595 596 #ifndef LOCAL_LABELS_FB 597 #define LOCAL_LABELS_FB 0 598 #endif 599 600 #ifndef LABELS_WITHOUT_COLONS 601 #define LABELS_WITHOUT_COLONS 0 602 #endif 603 604 #ifndef NO_PSEUDO_DOT 605 #define NO_PSEUDO_DOT 0 606 #endif 607 608 #ifndef TEXT_SECTION_NAME 609 #define TEXT_SECTION_NAME ".text" 610 #define DATA_SECTION_NAME ".data" 611 #define BSS_SECTION_NAME ".bss" 612 #endif 613 614 #ifndef OCTETS_PER_BYTE_POWER 615 #define OCTETS_PER_BYTE_POWER 0 616 #endif 617 #ifndef OCTETS_PER_BYTE 618 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER) 619 #endif 620 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER) 621 #error "Octets per byte conflicts with its power-of-two definition!" 622 #endif 623 624 #if defined OBJ_ELF || defined OBJ_MAYBE_ELF 625 /* On ELF platforms, mark debug sections with SEC_ELF_OCTETS */ 626 #define SEC_OCTETS (IS_ELF ? SEC_ELF_OCTETS : 0) 627 #else 628 #define SEC_OCTETS 0 629 #endif 630 631 #define POISON_BFD_BOOLEAN 1 632 633 #endif /* GAS */ 634