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