gas/as.h

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