gas/as.h

   1 /* as.h - global header file
   2    Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 1997
   3    Free Software Foundation, Inc.
   4
   5    This file is part of GAS, the GNU Assembler.
   6
   7    GAS is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2, or (at your option)
  10    any later version.
  11
  12    GAS is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GAS; see the file COPYING.  If not, write to the Free
  19    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20    02111-1307, USA.  */
  21
  22 #ifndef GAS
  23 #define GAS 1
  24 /*
  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
  40 #include "config.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 #undef for DJ Delorie.  The right fix is to ensure that as.h
  46    is included first, before even any system header files, in all files
  47    that use it.  KR 1994.11.03 */
  48 /* Added void* version for STDC case.  This is to be compatible with
  49    the declaration in bison.simple, used for m68k operand parsing.
  50    --KR 1995.08.08 */
  51 /* Force void* decl for hpux.  This is what Bison uses.  --KR 1995.08.16 */
  52
  53 /* AIX requires this to be the first thing in the file.  */
  54 #ifdef __GNUC__
  55 # ifndef alloca
  56 #  ifdef __STDC__
  57 extern void *alloca ();
  58 #  else
  59 extern char *alloca ();
  60 #  endif
  61 # endif
  62 #else
  63 # if HAVE_ALLOCA_H
  64 #  include <alloca.h>
  65 # else
  66 #  ifdef _AIX
  67  #pragma alloca
  68 #  else
  69 #   ifndef alloca /* predefined by HP cc +Olibcalls */
  70 #    if !defined (__STDC__) && !defined (__hpux)
  71 extern char *alloca ();
  72 #    else
  73 extern void *alloca ();
  74 #    endif /* __STDC__, __hpux */
  75 #   endif /* alloca */
  76 #  endif /* _AIX */
  77 # endif /* HAVE_ALLOCA_H */
  78 #endif
  79
  80 /* Now, tend to the rest of the configuration.  */
  81
  82 /* System include files first... */
  83 #include <stdio.h>
  84 #include <ctype.h>
  85 #ifdef HAVE_STRING_H
  86 #include <string.h>
  87 #else
  88 #ifdef HAVE_STRINGS_H
  89 #include <strings.h>
  90 #endif
  91 #endif
  92 #ifdef HAVE_STDLIB_H
  93 #include <stdlib.h>
  94 #endif
  95 #ifdef HAVE_UNISTD_H
  96 #include <unistd.h>
  97 #endif
  98 #ifdef HAVE_SYS_TYPES_H
  99 /* for size_t, pid_t */
 100 #include <sys/types.h>
 101 #endif
 102
 103 #include <getopt.h>
 104 /* The first getopt value for machine-independent long options.
 105    150 isn't special; it's just an arbitrary non-ASCII char value.  */
 106 #define OPTION_STD_BASE 150
 107 /* The first getopt value for machine-dependent long options.
 108    170 gives the standard options room to grow.  */
 109 #define OPTION_MD_BASE 170
 110
 111 #ifdef DEBUG
 112 #undef NDEBUG
 113 #endif
 114 #if !defined (__GNUC__) || __GNUC_MINOR__ <= 5
 115 #define __PRETTY_FUNCTION__  ((char*)0)
 116 #endif
 117 #if 0
 118
 119 /* Handle lossage with assert.h.  */
 120 #ifndef BROKEN_ASSERT
 121 #include <assert.h>
 122 #else /* BROKEN_ASSERT */
 123 #ifndef NDEBUG
 124 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
 125 #else
 126 #define assert(p) ((p), 0)
 127 #endif
 128 #endif /* BROKEN_ASSERT */
 129
 130 #else
 131
 132 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
 133 #undef abort
 134 #define abort()         as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 135
 136 #endif
 137
 138
 139 /* Now GNU header files... */
 140 #include <ansidecl.h>
 141 #ifdef BFD_ASSEMBLER
 142 #include <bfd.h>
 143 #endif
 144 #include <libiberty.h>
 145
 146 /* Define the standard progress macros.  */
 147 #include <progress.h>
 148
 149 /* This doesn't get taken care of anywhere.  */
 150 #ifndef __MWERKS__  /* Metrowerks C chokes on the "defined (inline)" */
 151 #if !defined (__GNUC__) && !defined (inline)
 152 #define inline
 153 #endif
 154 #endif /* !__MWERKS__ */
 155
 156 /* Other stuff from config.h.  */
 157 #ifdef NEED_DECLARATION_STRSTR
 158 extern char *strstr ();
 159 #endif
 160 #ifdef NEED_DECLARATION_MALLOC
 161 extern PTR malloc ();
 162 extern PTR realloc ();
 163 #endif
 164 #ifdef NEED_DECLARATION_FREE
 165 extern void free ();
 166 #endif
 167 #ifdef NEED_DECLARATION_ERRNO
 168 extern int errno;
 169 #endif
 170
 171 /* This is needed for VMS with DEC C.  */
 172 #if ! defined (__GNUC__) && ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
 173 #define unlink remove
 174 #endif
 175
 176 /* Hack to make "gcc -Wall" not complain about obstack macros.  */
 177 #if !defined (memcpy) && !defined (bcopy)
 178 #define bcopy(src,dest,size)    memcpy(dest,src,size)
 179 #endif
 180
 181 /* Make Saber happier on obstack.h.  */
 182 #ifdef SABER
 183 #undef  __PTR_TO_INT
 184 #define __PTR_TO_INT(P) ((int)(P))
 185 #undef  __INT_TO_PTR
 186 #define __INT_TO_PTR(P) ((char *)(P))
 187 #endif
 188
 189 #ifndef __LINE__
 190 #define __LINE__ "unknown"
 191 #endif /* __LINE__ */
 192
 193 #ifndef __FILE__
 194 #define __FILE__ "unknown"
 195 #endif /* __FILE__ */
 196
 197 #ifndef FOPEN_WB
 198 #ifdef GO32
 199 #include "fopen-bin.h"
 200 #else
 201 #include "fopen-same.h"
 202 #endif
 203 #endif
 204
 205 #ifndef EXIT_SUCCESS
 206 #define EXIT_SUCCESS 0
 207 #define EXIT_FAILURE 1
 208 #endif
 209
 210 #define obstack_chunk_alloc xmalloc
 211 #define obstack_chunk_free xfree
 212
 213 #define xfree free
 214
 215 #define BAD_CASE(val) \
 216 { \
 217       as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
 218                (long) val, __LINE__, __FILE__); \
 219            }
 220 \f
 221 #include "flonum.h"
 222
 223 /* These are assembler-wide concepts */
 224
 225 #ifdef BFD_ASSEMBLER
 226 extern bfd *stdoutput;
 227 typedef bfd_vma addressT;
 228 typedef bfd_signed_vma offsetT;
 229 #else
 230 typedef unsigned long addressT;
 231 typedef long offsetT;
 232 #endif
 233
 234 /* Type of symbol value, etc.  For use in prototypes.  */
 235 typedef addressT valueT;
 236
 237 #ifndef COMMON
 238 #ifdef TEST
 239 #define COMMON                  /* declare our COMMONs storage here. */
 240 #else
 241 #define COMMON extern           /* our commons live elswhere */
 242 #endif
 243 #endif
 244 /* COMMON now defined */
 245
 246 #ifdef DEBUG
 247 #ifndef know
 248 #define know(p) assert(p)       /* Verify our assumptions! */
 249 #endif /* not yet defined */
 250 #else
 251 #define know(p)                 /* know() checks are no-op.ed */
 252 #endif
 253 \f
 254 /* input_scrub.c */
 255
 256 /*
 257  * Supplies sanitised buffers to read.c.
 258  * Also understands printing line-number part of error messages.
 259  */
 260 \f
 261
 262 /* subsegs.c     Sub-segments. Also, segment(=expression type)s.*/
 263
 264 #ifndef BFD_ASSEMBLER
 265
 266 #ifdef MANY_SEGMENTS
 267 #include "bfd.h"
 268 #define N_SEGMENTS 40
 269 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
 270 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
 271                  SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
 272                  SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
 273                  SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
 274 #define SEG_TEXT SEG_E0
 275 #define SEG_DATA SEG_E1
 276 #define SEG_BSS SEG_E2
 277 #define SEG_LAST SEG_E39
 278 #else
 279 #define N_SEGMENTS 3
 280 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
 281 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
 282 #endif
 283
 284 typedef enum _segT
 285   {
 286     SEG_ABSOLUTE = 0,
 287     SEG_LIST,
 288     SEG_UNKNOWN,
 289     SEG_GOOF,                   /* Only happens if AS has a logic error. */
 290     /* Invented so we don't crash printing */
 291     /* error message involving weird segment. */
 292     SEG_EXPR,                   /* Intermediate expression values. */
 293     SEG_DEBUG,                  /* Debug segment */
 294     SEG_NTV,                    /* Transfert vector preload segment */
 295     SEG_PTV,                    /* Transfert vector postload segment */
 296     SEG_REGISTER                /* Mythical: a register-valued expression */
 297   } segT;
 298
 299 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
 300 #else
 301 typedef asection *segT;
 302 #define SEG_NORMAL(SEG)         ((SEG) != absolute_section      \
 303                                  && (SEG) != undefined_section  \
 304                                  && (SEG) != reg_section        \
 305                                  && (SEG) != expr_section)
 306 #endif
 307 typedef int subsegT;
 308
 309 /* What subseg we are accreting now? */
 310 COMMON subsegT now_subseg;
 311
 312 /* Segment our instructions emit to. */
 313 COMMON segT now_seg;
 314
 315 #ifdef BFD_ASSEMBLER
 316 #define segment_name(SEG)       bfd_get_section_name (stdoutput, SEG)
 317 #else
 318 extern char const *const seg_name[];
 319 #define segment_name(SEG)       seg_name[(int) (SEG)]
 320 #endif
 321
 322 #ifndef BFD_ASSEMBLER
 323 extern int section_alignment[];
 324 #endif
 325
 326 #ifdef BFD_ASSEMBLER
 327 extern segT reg_section, expr_section;
 328 /* Shouldn't these be eliminated someday?  */
 329 extern segT text_section, data_section, bss_section;
 330 #define absolute_section        bfd_abs_section_ptr
 331 #define undefined_section       bfd_und_section_ptr
 332 #else
 333 #define reg_section             SEG_REGISTER
 334 #define expr_section            SEG_EXPR
 335 #define text_section            SEG_TEXT
 336 #define data_section            SEG_DATA
 337 #define bss_section             SEG_BSS
 338 #define absolute_section        SEG_ABSOLUTE
 339 #define undefined_section       SEG_UNKNOWN
 340 #endif
 341
 342 /* relax() */
 343
 344 enum _relax_state
 345   {
 346     /* Variable chars to be repeated fr_offset times.
 347        Fr_symbol unused. Used with fr_offset == 0 for a
 348        constant length frag. */
 349     rs_fill = 1,
 350
 351     /* Align.  The fr_offset field holds the power of 2 to which to
 352        align.  The fr_var field holds the number of characters in the
 353        fill pattern.  The fr_subtype field holds the maximum number of
 354        bytes to skip when aligning, or 0 if there is no maximum.  */
 355     rs_align,
 356
 357     /* Align code.  The fr_offset field holds the power of 2 to which
 358        to align.  This type is only generated by machine specific
 359        code, which is normally responsible for handling the fill
 360        pattern.  The fr_subtype field holds the maximum number of
 361        bytes to skip when aligning, or 0 if there is no maximum.  */
 362     rs_align_code,
 363
 364     /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
 365        character. */
 366     rs_org,
 367
 368 #ifndef WORKING_DOT_WORD
 369     /* JF: gunpoint */
 370     rs_broken_word,
 371 #endif
 372
 373     /* machine-specific relaxable (or similarly alterable) instruction */
 374     rs_machine_dependent,
 375
 376     /* .space directive with expression operand that needs to be computed
 377        later.  Similar to rs_org, but different.
 378        fr_symbol: operand
 379        1 variable char: fill character  */
 380     rs_space,
 381
 382     /* A DWARF leb128 value; only ELF uses this.  The subtype is 0 for
 383        unsigned, 1 for signed.  */
 384     rs_leb128
 385   };
 386
 387 typedef enum _relax_state relax_stateT;
 388
 389 /* This type is used in prototypes, so it can't be a type that will be
 390    widened for argument passing.  */
 391 typedef unsigned int relax_substateT;
 392
 393 /* Enough bits for address, but still an integer type.
 394    Could be a problem, cross-assembling for 64-bit machines.  */
 395 typedef addressT relax_addressT;
 396 \f
 397 /* main program "as.c" (command arguments etc) */
 398
 399 COMMON unsigned char flag_no_comments; /* -f */
 400 COMMON unsigned char flag_debug; /* -D */
 401 COMMON unsigned char flag_signed_overflow_ok; /* -J */
 402 #ifndef WORKING_DOT_WORD
 403 COMMON unsigned char flag_warn_displacement; /* -K */
 404 #endif
 405
 406 /* True if local symbols should be retained.  */
 407 COMMON int flag_keep_locals; /* -L */
 408
 409 /* True if we are assembling in MRI mode.  */
 410 COMMON int flag_mri;
 411
 412 /* True if we are assembling in m68k MRI mode.  */
 413 COMMON int flag_m68k_mri;
 414
 415 /* Should the data section be made read-only and appended to the text
 416    section?  */
 417 COMMON unsigned char flag_readonly_data_in_text; /* -R */
 418
 419 /* True if warnings should be inhibited.  */
 420 COMMON int flag_no_warnings; /* -W */
 421
 422 /* True if we should attempt to generate output even if non-fatal errors
 423    are detected.  */
 424 COMMON unsigned char flag_always_generate_output; /* -Z */
 425
 426 /* True if instruction swapping warnings should be inhibited.  */
 427 COMMON unsigned char flag_warn_instructionswap; /* --nowarnswap */
 428
 429 /* This is true if the assembler should output time and space usage. */
 430 COMMON unsigned char flag_print_statistics;
 431
 432 /* True if local absolute symbols are to be stripped.  */
 433 COMMON int flag_strip_local_absolute;
 434
 435 /* name of emitted object file */
 436 COMMON char *out_file_name;
 437
 438 /* name of file defining extensions to the basic instruction set */
 439 COMMON char *insttbl_file_name;
 440
 441 /* TRUE if we need a second pass. */
 442 COMMON int need_pass_2;
 443
 444 /* TRUE if we should do no relaxing, and
 445    leave lots of padding.  */
 446 COMMON int linkrelax;
 447
 448 /* TRUE if we should produce a listing.  */
 449 extern int listing;
 450
 451 /* Type of debugging information we should generate.  We currently
 452    only support stabs and ECOFF.  */
 453
 454 enum debug_info_type { DEBUG_NONE, DEBUG_STABS, DEBUG_ECOFF };
 455
 456 extern enum debug_info_type debug_type;
 457 \f
 458 /* Maximum level of macro nesting.  */
 459 extern int max_macro_nest;
 460
 461 /* Obstack chunk size.  Keep large for efficient space use, make small to
 462    increase malloc calls for monitoring memory allocation.  */
 463 extern int chunksize;
 464
 465 struct _pseudo_type
 466   {
 467     /* assembler mnemonic, lower case, no '.' */
 468     const char *poc_name;
 469     /* Do the work */
 470     void (*poc_handler) PARAMS ((int));
 471     /* Value to pass to handler */
 472     int poc_val;
 473   };
 474
 475 typedef struct _pseudo_type pseudo_typeS;
 476
 477 /* Prefer varargs for non-ANSI compiler, since some will barf if the
 478    ellipsis definition is used with a no-arguments declaration.  */
 479 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
 480 #undef HAVE_STDARG_H
 481 #endif
 482
 483 #if defined (HAVE_STDARG_H)
 484 #define USE_STDARG
 485 #endif
 486 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
 487 #define USE_VARARGS
 488 #endif
 489
 490 #ifdef USE_STDARG
 491 #if (__GNUC__ >= 2) && !defined(VMS)
 492 /* for use with -Wformat */
 493 #define PRINTF_LIKE(FCN)        void FCN (const char *format, ...) \
 494                                         __attribute__ ((format (printf, 1, 2)))
 495 #define PRINTF_WHERE_LIKE(FCN)  void FCN (char *file, unsigned int line, \
 496                                           const char *format, ...) \
 497                                         __attribute__ ((format (printf, 3, 4)))
 498 #else /* ANSI C with stdarg, but not GNU C */
 499 #define PRINTF_LIKE(FCN)        void FCN PARAMS ((const char *format, ...))
 500 #define PRINTF_WHERE_LIKE(FCN)  void FCN PARAMS ((char *file, \
 501                                                   unsigned int line, \
 502                                                   const char *format, ...))
 503 #endif
 504 #else /* not using stdarg */
 505 #define PRINTF_LIKE(FCN)        void FCN ()
 506 #define PRINTF_WHERE_LIKE(FCN)  void FCN ()
 507 #endif
 508
 509 PRINTF_LIKE (as_bad);
 510 PRINTF_LIKE (as_fatal);
 511 PRINTF_LIKE (as_tsktsk);
 512 PRINTF_LIKE (as_warn);
 513 PRINTF_WHERE_LIKE (as_bad_where);
 514 PRINTF_WHERE_LIKE (as_warn_where);
 515 void as_assert PARAMS ((const char *, int, const char *));
 516 void as_abort PARAMS ((const char *, int, const char *));
 517
 518 void fprint_value PARAMS ((FILE *file, addressT value));
 519 void sprint_value PARAMS ((char *buf, addressT value));
 520
 521 int had_errors PARAMS ((void));
 522 int had_warnings PARAMS ((void));
 523
 524 void print_version_id PARAMS ((void));
 525 char *app_push PARAMS ((void));
 526 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
 527 char *input_scrub_include_file PARAMS ((char *filename, char *position));
 528 char *input_scrub_new_file PARAMS ((char *filename));
 529 char *input_scrub_next_buffer PARAMS ((char **bufp));
 530 int do_scrub_chars PARAMS ((int (*get) (char **), char *to, int tolen));
 531 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
 532                           long exponent_bits));
 533 int had_err PARAMS ((void));
 534 int ignore_input PARAMS ((void));
 535 void cond_finish_check PARAMS ((int));
 536 void cond_exit_macro PARAMS ((int));
 537 int seen_at_least_1_file PARAMS ((void));
 538 void app_pop PARAMS ((char *arg));
 539 void as_howmuch PARAMS ((FILE * stream));
 540 void as_perror PARAMS ((const char *gripe, const char *filename));
 541 void as_where PARAMS ((char **namep, unsigned int *linep));
 542 void bump_line_counters PARAMS ((void));
 543 void do_scrub_begin PARAMS ((int));
 544 void input_scrub_begin PARAMS ((void));
 545 void input_scrub_close PARAMS ((void));
 546 void input_scrub_end PARAMS ((void));
 547 int new_logical_line PARAMS ((char *fname, int line_number));
 548 void subsegs_begin PARAMS ((void));
 549 void subseg_change PARAMS ((segT seg, int subseg));
 550 segT subseg_new PARAMS ((const char *name, subsegT subseg));
 551 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
 552 void subseg_set PARAMS ((segT seg, subsegT subseg));
 553 #ifdef BFD_ASSEMBLER
 554 segT subseg_get PARAMS ((const char *, int));
 555 #endif
 556
 557 void start_dependencies PARAMS ((char *));
 558 void register_dependency PARAMS ((char *));
 559 void print_dependencies PARAMS ((void));
 560
 561 struct expressionS;
 562 struct fix;
 563 struct symbol;
 564 struct relax_type;
 565 typedef struct frag fragS;
 566
 567 #ifdef BFD_ASSEMBLER
 568 /* literal.c */
 569 valueT add_to_literal_pool PARAMS ((struct symbol *, valueT, segT, int));
 570 #endif
 571
 572 #include "expr.h"               /* Before targ-*.h */
 573
 574 /* this one starts the chain of target dependant headers */
 575 #include "targ-env.h"
 576
 577 #include "struc-symbol.h"
 578 #include "write.h"
 579 #include "frags.h"
 580 #include "hash.h"
 581 #include "read.h"
 582 #include "symbols.h"
 583
 584 #include "tc.h"
 585 #include "obj.h"
 586
 587 #ifdef USE_EMULATIONS
 588 #include "emul.h"
 589 #endif
 590 #include "listing.h"
 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 #endif /* GAS */
 601
 602 /* end of as.h */