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