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