gas/as.h

   1 /* as.h - global header file
   2    Copyright (C) 1987, 1990, 1991, 1992 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 2, or (at your option)
   9    any later version.
  10
  11    GAS is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public 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
  18    the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #ifndef GAS
  21 #define GAS 1
  22 /*
  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
  38 /* These #defines are for parameters of entire assembler. */
  39
  40 /* These #includes are for type definitions etc. */
  41
  42 #include "config.h"
  43
  44 #include <stdio.h>
  45 #include <getopt.h>
  46 /* The first getopt value for machine-independent long options.
  47    150 isn't special; it's just an arbitrary non-ASCII char value.  */
  48 #define OPTION_STD_BASE 150
  49 /* The first getopt value for machine-dependent long options.
  50    170 gives the standard options room to grow.  */
  51 #define OPTION_MD_BASE 170
  52
  53 #ifdef DEBUG
  54 #undef NDEBUG
  55 #endif
  56 #include <assert.h>
  57
  58 #include <ansidecl.h>
  59 #ifdef BFD_ASSEMBLER
  60 #include <bfd.h>
  61 #endif
  62 #include "host.h"
  63 #include "flonum.h"
  64
  65 /* Make Saber happier on obstack.h.  */
  66 #ifdef SABER
  67 #undef  __PTR_TO_INT
  68 #define __PTR_TO_INT(P) ((int)(P))
  69 #undef  __INT_TO_PTR
  70 #define __INT_TO_PTR(P) ((char *)(P))
  71 #endif
  72
  73 #ifndef __LINE__
  74 #define __LINE__ "unknown"
  75 #endif /* __LINE__ */
  76
  77 #ifndef __FILE__
  78 #define __FILE__ "unknown"
  79 #endif /* __FILE__ */
  80
  81 #ifndef __STDC__
  82 #ifndef const
  83 #define const
  84 #endif
  85 #ifndef volatile
  86 #define volatile
  87 #endif
  88 #endif /* ! __STDC__ */
  89
  90 #if !defined (__GNUC__) && !defined (inline)
  91 #define inline
  92 #endif
  93
  94 #ifndef FOPEN_WB
  95 #include "fopen-same.h"
  96 #endif
  97
  98 #define obstack_chunk_alloc xmalloc
  99 #define obstack_chunk_free xfree
 100
 101 #define xfree free
 102
 103 #define BAD_CASE(val) \
 104 { \
 105       as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
 106                (long) val, __LINE__, __FILE__); \
 107            }
 108
 109 /* Version 2.1 of Solaris had problems with this declaration, but I
 110    think that bug has since been fixed.  If it causes problems on your
 111    system, just delete it.  */
 112 extern char *strstr ();
 113 \f
 114
 115 /* These are assembler-wide concepts */
 116
 117 #ifdef BFD_ASSEMBLER
 118 extern bfd *stdoutput;
 119 typedef bfd_vma addressT;
 120 typedef bfd_signed_vma offsetT;
 121 #else
 122 typedef unsigned long addressT;
 123 typedef long offsetT;
 124 #endif
 125
 126 /* Type of symbol value, etc.  For use in prototypes.  */
 127 typedef addressT valueT;
 128
 129 #ifndef COMMON
 130 #ifdef TEST
 131 #define COMMON                  /* declare our COMMONs storage here. */
 132 #else
 133 #define COMMON extern           /* our commons live elswhere */
 134 #endif
 135 #endif
 136 /* COMMON now defined */
 137
 138 #ifdef DEBUG
 139 #ifndef know
 140 #define know(p) assert(p)       /* Verify our assumptions! */
 141 #endif /* not yet defined */
 142 #else
 143 #define know(p)                 /* know() checks are no-op.ed */
 144 #endif
 145
 146 #if defined (BROKEN_ASSERT) && !defined (NDEBUG)
 147 /* Used on machines where the "assert" macro is buggy.  (For example, on the
 148    RS/6000, Reiser-cpp substitution is done to put the condition into a
 149    string, so if the condition contains a string, parse errors result.)  If
 150    the condition fails, just drop core file.  */
 151 #undef assert
 152 #define assert(p) ((p) ? 0 : (abort (), 0))
 153 #endif
 154 \f
 155 /* input_scrub.c */
 156
 157 /*
 158  * Supplies sanitised buffers to read.c.
 159  * Also understands printing line-number part of error messages.
 160  */
 161 \f
 162
 163 /* subsegs.c     Sub-segments. Also, segment(=expression type)s.*/
 164
 165 #ifndef BFD_ASSEMBLER
 166
 167 #ifdef MANY_SEGMENTS
 168 #include "bfd.h"
 169 #define N_SEGMENTS 10
 170 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E9)
 171 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9
 172 #define SEG_TEXT SEG_E0
 173 #define SEG_DATA SEG_E1
 174 #define SEG_BSS SEG_E2
 175 #else
 176 #define N_SEGMENTS 3
 177 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
 178 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
 179 #endif
 180
 181 typedef enum _segT
 182   {
 183     SEG_ABSOLUTE = 0,
 184     SEG_LIST,
 185     SEG_UNKNOWN,
 186     SEG_GOOF,                   /* Only happens if AS has a logic error. */
 187     /* Invented so we don't crash printing */
 188     /* error message involving weird segment. */
 189     SEG_EXPR,                   /* Intermediate expression values. */
 190     SEG_DEBUG,                  /* Debug segment */
 191     SEG_NTV,                    /* Transfert vector preload segment */
 192     SEG_PTV,                    /* Transfert vector postload segment */
 193     SEG_REGISTER                /* Mythical: a register-valued expression */
 194   } segT;
 195
 196 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
 197 #else
 198 typedef asection *segT;
 199 #define SEG_NORMAL(SEG)         ((SEG) != absolute_section      \
 200                                  && (SEG) != undefined_section  \
 201                                  && (SEG) != reg_section        \
 202                                  && (SEG) != expr_section)
 203 #endif
 204 typedef int subsegT;
 205
 206 /* What subseg we are accreting now? */
 207 COMMON subsegT now_subseg;
 208
 209 /* Segment our instructions emit to. */
 210 COMMON segT now_seg;
 211
 212 #ifdef BFD_ASSEMBLER
 213 #define segment_name(SEG)       bfd_get_section_name (stdoutput, SEG)
 214 #else
 215 extern char *const seg_name[];
 216 #define segment_name(SEG)       seg_name[(int) (SEG)]
 217 #endif
 218
 219 #ifndef BFD_ASSEMBLER
 220 extern int section_alignment[];
 221 #endif
 222
 223 #ifdef BFD_ASSEMBLER
 224 extern segT reg_section, expr_section;
 225 /* Shouldn't these be eliminated someday?  */
 226 extern segT text_section, data_section, bss_section;
 227 #define absolute_section        (&bfd_abs_section)
 228 #define undefined_section       (&bfd_und_section)
 229 #else
 230 #define reg_section             SEG_REGISTER
 231 #define expr_section            SEG_EXPR
 232 #define text_section            SEG_TEXT
 233 #define data_section            SEG_DATA
 234 #define bss_section             SEG_BSS
 235 #define absolute_section        SEG_ABSOLUTE
 236 #define undefined_section       SEG_UNKNOWN
 237 #endif
 238
 239 /* relax() */
 240
 241 typedef enum _relax_state
 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 = 1,
 247
 248     /* Align: Fr_offset: power of 2.  Variable chars: fill pattern. */
 249     rs_align,
 250
 251     /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
 252        character. */
 253     rs_org,
 254
 255     rs_machine_dependent
 256
 257 #ifndef WORKING_DOT_WORD
 258     /* JF: gunpoint */
 259       , rs_broken_word
 260 #endif
 261   } relax_stateT;
 262
 263 /* typedef unsigned char relax_substateT; */
 264 /* JF this is more likely to leave the end of a struct frag on an align
 265    boundry.  Be very careful with this.  */
 266 typedef unsigned long relax_substateT;
 267
 268 /* Enough bits for address, but still an integer type.
 269    Could be a problem, cross-assembling for 64-bit machines.  */
 270 typedef addressT relax_addressT;
 271 \f
 272
 273 /* frags.c */
 274
 275 /*
 276  * A code fragment (frag) is some known number of chars, followed by some
 277  * unknown number of chars. Typically the unknown number of chars is an
 278  * instruction address whose size is yet unknown. We always know the greatest
 279  * possible size the unknown number of chars may become, and reserve that
 280  * much room at the end of the frag.
 281  * Once created, frags do not change address during assembly.
 282  * We chain the frags in (a) forward-linked list(s). The object-file address
 283  * of the 1st char of a frag is generally not known until after relax().
 284  * Many things at assembly time describe an address by {object-file-address
 285  * of a particular frag}+offset.
 286
 287  BUG: it may be smarter to have a single pointer off to various different
 288  notes for different frag kinds. See how code pans
 289  */
 290 struct frag
 291 {
 292   /* Object file address. */
 293   addressT fr_address;
 294   /* Chain forward; ascending address order.  Rooted in frch_root. */
 295   struct frag *fr_next;
 296
 297   /* (Fixed) number of chars we know we have.  May be 0. */
 298   offsetT fr_fix;
 299   /* (Variable) number of chars after above.  May be 0. */
 300   offsetT fr_var;
 301   /* For variable-length tail. */
 302   struct symbol *fr_symbol;
 303   /* For variable-length tail. */
 304   offsetT fr_offset;
 305   /* Points to opcode low addr byte, for relaxation.  */
 306   char *fr_opcode;
 307
 308 #ifndef NO_LISTING
 309   struct list_info_struct *line;
 310 #endif
 311
 312   /* What state is my tail in? */
 313   relax_stateT fr_type;
 314   relax_substateT fr_subtype;
 315
 316   /* These are needed only on the NS32K machines */
 317   char fr_pcrel_adjust;
 318   char fr_bsr;
 319
 320   /* Chars begin here.
 321      One day we will compile fr_literal[0]. */
 322   char fr_literal[1];
 323 };
 324
 325 #define SIZEOF_STRUCT_FRAG \
 326 ((int)zero_address_frag.fr_literal-(int)&zero_address_frag)
 327 /* We want to say fr_literal[0] above. */
 328
 329 typedef struct frag fragS;
 330
 331 /* Current frag we are building.  This frag is incomplete.  It is, however,
 332    included in frchain_now.  The fr_fix field is bogus; instead, use:
 333    obstack_next_free(&frags)-frag_now->fr_literal.  */
 334 COMMON fragS *frag_now;
 335 #define frag_now_fix() ((char*)obstack_next_free (&frags) - frag_now->fr_literal)
 336
 337 /* For foreign-segment symbol fixups. */
 338 COMMON fragS zero_address_frag;
 339 /* For local common (N_BSS segment) fixups. */
 340 COMMON fragS bss_address_frag;
 341
 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 COMMON unsigned char flag_warn_displacement; /* -K */
 348 COMMON unsigned char flag_keep_locals; /* -L */
 349 COMMON unsigned char flag_readonly_data_in_text; /* -R */
 350 COMMON unsigned char flag_no_warnings; /* -W */
 351 COMMON unsigned char flag_always_generate_output; /* -Z */
 352
 353 /* name of emitted object file */
 354 COMMON char *out_file_name;
 355
 356 /* TRUE if we need a second pass. */
 357 COMMON int need_pass_2;
 358
 359 /* TRUE if we should do no relaxing, and
 360    leave lots of padding.  */
 361 COMMON int linkrelax;
 362
 363 /* TRUE if we should produce a listing.  */
 364 extern int listing;
 365
 366 struct _pseudo_type
 367   {
 368     /* assembler mnemonic, lower case, no '.' */
 369     char *poc_name;
 370     /* Do the work */
 371     void (*poc_handler) PARAMS ((int));
 372     /* Value to pass to handler */
 373     int poc_val;
 374   };
 375
 376 typedef struct _pseudo_type pseudo_typeS;
 377
 378 #ifdef BFD_ASSEMBLER_xxx
 379 struct lineno_struct
 380   {
 381     alent line;
 382     fragS *frag;
 383     struct lineno_struct *next;
 384   };
 385 typedef struct lineno_struct lineno;
 386 #endif
 387
 388 #if defined (__STDC__) && !defined(NO_STDARG)
 389
 390 #if __GNUC__ >= 2
 391 /* for use with -Wformat */
 392 #define PRINTF_LIKE(FCN)        void FCN (const char *format, ...) \
 393                                         __attribute__ ((format (printf, 1, 2)))
 394 #define PRINTF_WHERE_LIKE(FCN)  void FCN (char *file, unsigned int line, \
 395                                           const char *format, ...) \
 396                                         __attribute__ ((format (printf, 3, 4)))
 397 #else /* ANSI C with stdarg, but not GNU C */
 398 #define PRINTF_LIKE(FCN)        void FCN (const char *format, ...)
 399 #define PRINTF_WHERE_LIKE(FCN)  void FCN (char *file, unsigned int line, \
 400                                           const char *format, ...)
 401 #endif
 402 #else /* not ANSI C, or not stdarg */
 403 #define PRINTF_LIKE(FCN)        void FCN ()
 404 #define PRINTF_WHERE_LIKE(FCN)  void FCN ()
 405 #endif
 406
 407 PRINTF_LIKE (as_bad);
 408 PRINTF_LIKE (as_fatal);
 409 PRINTF_LIKE (as_tsktsk);
 410 PRINTF_LIKE (as_warn);
 411 PRINTF_WHERE_LIKE (as_bad_where);
 412 PRINTF_WHERE_LIKE (as_warn_where);
 413
 414 void fprint_value PARAMS ((FILE *file, addressT value));
 415 void sprint_value PARAMS ((char *buf, addressT value));
 416
 417 int had_errors PARAMS ((void));
 418 int had_warnings PARAMS ((void));
 419
 420 void print_version_id PARAMS ((void));
 421 char *app_push PARAMS ((void));
 422 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
 423 char *input_scrub_include_file PARAMS ((char *filename, char *position));
 424 char *input_scrub_new_file PARAMS ((char *filename));
 425 char *input_scrub_next_buffer PARAMS ((char **bufp));
 426 PTR xmalloc PARAMS ((unsigned long size));
 427 PTR xrealloc PARAMS ((PTR ptr, unsigned long n));
 428 int do_scrub_next_char PARAMS ((int (*get) (void), void (*unget) (int)));
 429 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
 430                           long exponent_bits));
 431 int had_err PARAMS ((void));
 432 int ignore_input PARAMS ((void));
 433 int scrub_from_file PARAMS ((void));
 434 int scrub_from_string PARAMS ((void));
 435 int seen_at_least_1_file PARAMS ((void));
 436 void app_pop PARAMS ((char *arg));
 437 void as_howmuch PARAMS ((FILE * stream));
 438 void as_perror PARAMS ((const char *gripe, const char *filename));
 439 void as_where PARAMS ((char **namep, unsigned int *linep));
 440 void bump_line_counters PARAMS ((void));
 441 void do_scrub_begin PARAMS ((void));
 442 void input_scrub_begin PARAMS ((void));
 443 void input_scrub_close PARAMS ((void));
 444 void input_scrub_end PARAMS ((void));
 445 void new_logical_line PARAMS ((char *fname, int line_number));
 446 void scrub_to_file PARAMS ((int ch));
 447 void scrub_to_string PARAMS ((int ch));
 448 void subsegs_begin PARAMS ((void));
 449 void subseg_change PARAMS ((segT seg, int subseg));
 450 segT subseg_new PARAMS ((const char *name, subsegT subseg));
 451 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
 452 void subseg_set PARAMS ((segT seg, subsegT subseg));
 453 #ifdef BFD_ASSEMBLER
 454 segT subseg_get PARAMS ((const char *, int));
 455 #endif
 456
 457 struct expressionS;
 458 struct fix;
 459 struct symbol;
 460
 461 #ifdef BFD_ASSEMBLER
 462 /* literal.c */
 463 valueT add_to_literal_pool PARAMS ((struct symbol *, valueT, segT, int));
 464 #endif
 465
 466 /* this one starts the chain of target dependant headers */
 467 #include "targ-env.h"
 468
 469 #include "expr.h"
 470 #include "struc-symbol.h"
 471 #include "write.h"
 472 #include "frags.h"
 473 #include "hash.h"
 474 #include "read.h"
 475 #include "symbols.h"
 476
 477 #include "tc.h"
 478 #include "obj.h"
 479
 480 #include "listing.h"
 481
 482 #ifdef BFD_ASSEMBLER
 483 /* Someday perhaps this will be selectable at run-time.  */
 484 #if defined (OBJ_AOUT) || defined (OBJ_BOUT)
 485 #define OUTPUT_FLAVOR bfd_target_aout_flavour
 486 #endif
 487 #ifdef OBJ_COFF
 488 #define OUTPUT_FLAVOR bfd_target_coff_flavour
 489 #endif
 490 #ifdef OBJ_ECOFF
 491 #define OUTPUT_FLAVOR bfd_target_ecoff_flavour
 492 #endif
 493 #ifdef OBJ_ELF
 494 #define OUTPUT_FLAVOR bfd_target_elf_flavour
 495 #endif
 496 #endif /* BFD_ASSEMBLER */
 497
 498 #endif /* GAS */
 499
 500 /* end of as.h */