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