gas/as.h

   1 /* as.h - global header file
   2    Copyright (C) 1987, 1990, 1991 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 #define GAS 1
  21 #include <ansidecl.h>
  22 #include "host.h"
  23 #include "flonum.h"
  24
  25 #ifndef __STDC__
  26 #define volatile        /**/
  27 #ifndef const
  28 #define const           /**/
  29 #endif /* const */
  30 #endif /* __STDC__ */
  31
  32 #ifdef __GNUC__
  33 #define alloca __builtin_alloca
  34 #define register
  35 #endif /* __GNUC__ */
  36
  37 #ifndef __LINE__
  38 #define __LINE__ "unknown"
  39 #endif /* __LINE__ */
  40
  41 #ifndef __FILE__
  42 #define __FILE__ "unknown"
  43 #endif /* __FILE__ */
  44
  45 /*
  46  * I think this stuff is largely out of date.  xoxorich.
  47  *
  48  * CAPITALISED names are #defined.
  49  * "lowercaseH" is #defined if "lowercase.h" has been #include-d.
  50  * "lowercaseT" is a typedef of "lowercase" objects.
  51  * "lowercaseP" is type "pointer to object of type 'lowercase'".
  52  * "lowercaseS" is typedef struct ... lowercaseS.
  53  *
  54  * #define DEBUG to enable all the "know" assertion tests.
  55  * #define SUSPECT when debugging.
  56  * #define COMMON as "extern" for all modules except one, where you #define
  57  *      COMMON as "".
  58  * If TEST is #defined, then we are testing a module: #define COMMON as "".
  59  */
  60
  61 /* These #defines are for parameters of entire assembler. */
  62
  63 /* #define SUSPECT JF remove for speed testing */
  64 /* These #includes are for type definitions etc. */
  65
  66 #include <stdio.h>
  67 #include <assert.h>
  68 #include "listing.h"
  69 #define obstack_chunk_alloc     xmalloc
  70 #define obstack_chunk_free      xfree
  71
  72 #define xfree free
  73
  74 #define BAD_CASE(value) \
  75 { \
  76       as_fatal("Case value %d unexpected at line %d of file \"%s\"\n", \
  77                value, __LINE__, __FILE__); \
  78            }
  79
  80 \f
  81 /* These are assembler-wide concepts */
  82
  83
  84 #ifndef COMMON
  85 #ifdef TEST
  86 #define COMMON                  /* declare our COMMONs storage here. */
  87 #else
  88 #define COMMON extern           /* our commons live elswhere */
  89 #endif
  90 #endif
  91 /* COMMON now defined */
  92 #define DEBUG /* temporary */
  93
  94 #ifdef DEBUG
  95 #undef NDEBUG
  96 #ifndef know
  97 #define know(p) assert(p)       /* Verify our assumptions! */
  98 #endif /* not yet defined */
  99 #else
 100 #define know(p)                 /* know() checks are no-op.ed */
 101 #endif
 102 \f
 103 /* input_scrub.c */
 104
 105 /*
 106  * Supplies sanitised buffers to read.c.
 107  * Also understands printing line-number part of error messages.
 108  */
 109
 110 \f
 111 /* subsegs.c     Sub-segments. Also, segment(=expression type)s.*/
 112
 113 /*
 114  * This table describes the use of segments as EXPRESSION types.
 115  *
 116  *      X_seg   X_add_symbol  X_subtract_symbol X_add_number
 117  * SEG_ABSENT                                           no (legal) expression
 118  * SEG_PASS1                                            no (defined) "
 119  * SEG_BIG                                      *       > 32 bits const.
 120  * SEG_ABSOLUTE                                 0
 121  * SEG_DATA             *                       0
 122  * SEG_TEXT             *                       0
 123  * SEG_BSS              *                       0
 124  * SEG_UNKNOWN          *                       0
 125  * SEG_DIFFERENCE       0               *       0
 126  * SEG_REGISTER                                 *
 127  *
 128  * The blank fields MUST be 0, and are nugatory.
 129  * The '0' fields MAY be 0. The '*' fields MAY NOT be 0.
 130  *
 131  * SEG_BIG: X_add_number is < 0 if the result is in
 132  *      generic_floating_point_number.  The value is -'c' where c is the
 133  *      character that introduced the constant.  e.g. "0f6.9" will have  -'f'
 134  *      as a X_add_number value.
 135  *      X_add_number > 0 is a count of how many littlenums it took to
 136  *      represent a bignum.
 137  * SEG_DIFFERENCE:
 138  * If segments of both symbols are known, they are the same segment.
 139  * X_add_symbol != X_sub_symbol (then we just cancel them, => SEG_ABSOLUTE).
 140  */
 141
 142
 143 #ifdef MANY_SEGMENTS
 144 #define N_SEGMENTS 10
 145 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E9)
 146 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9
 147 #define SEG_DATA SEG_E1
 148 #define SEG_TEXT SEG_E0
 149 #define SEG_BSS SEG_E2
 150 #else
 151 #define N_SEGMENTS 3
 152 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
 153 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
 154 #endif
 155
 156 typedef enum _segT {
 157         SEG_ABSOLUTE = 0,
 158         SEG_LIST,
 159         SEG_UNKNOWN,
 160         SEG_ABSENT,             /* Mythical Segment (absent): NO expression seen. */
 161         SEG_PASS1,              /* Mythical Segment: Need another pass. */
 162         SEG_GOOF,               /* Only happens if AS has a logic error. */
 163         /* Invented so we don't crash printing */
 164         /* error message involving weird segment. */
 165         SEG_BIG,                /* Bigger than 32 bits constant. */
 166         SEG_DIFFERENCE,         /* Mythical Segment: absolute difference. */
 167         SEG_DEBUG,              /* Debug segment */
 168         SEG_NTV,                /* Transfert vector preload segment */
 169         SEG_PTV,                /* Transfert vector postload segment */
 170         SEG_REGISTER,           /* Mythical: a register-valued expression */
 171 } segT;
 172
 173 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
 174
 175 typedef int subsegT;
 176
 177 COMMON subsegT                  now_subseg;
 178 /* What subseg we are accreting now? */
 179
 180
 181 COMMON segT                     now_seg;
 182 /* Segment our instructions emit to. */
 183 /* Only OK values are SEG_TEXT or SEG_DATA. */
 184
 185
 186 extern char *const seg_name[];
 187 extern int section_alignment[];
 188
 189
 190 /* relax() */
 191
 192 typedef enum _relax_state {
 193         rs_fill, /* Variable chars to be repeated fr_offset times. Fr_symbol
 194                     unused. Used with fr_offset == 0 for a constant length
 195                     frag. */
 196
 197         rs_align, /* Align: Fr_offset: power of 2. 1 variable char: fill
 198                      character. */
 199
 200         rs_org, /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
 201                    character. */
 202
 203         rs_machine_dependent,
 204
 205 #ifndef WORKING_DOT_WORD
 206         rs_broken_word,         /* JF: gunpoint */
 207 #endif
 208 } relax_stateT;
 209
 210 /* typedef unsigned char relax_substateT; */
 211 /* JF this is more likely to leave the end of a struct frag on an align
 212    boundry.  Be very careful with this.  */
 213 typedef unsigned long relax_substateT;
 214
 215 typedef unsigned long relax_addressT;/* Enough bits for address. */
 216 /* Still an integer type. */
 217
 218 \f
 219 /* frags.c */
 220
 221 /*
 222  * A code fragment (frag) is some known number of chars, followed by some
 223  * unknown number of chars. Typically the unknown number of chars is an
 224  * instruction address whose size is yet unknown. We always know the greatest
 225  * possible size the unknown number of chars may become, and reserve that
 226  * much room at the end of the frag.
 227  * Once created, frags do not change address during assembly.
 228  * We chain the frags in (a) forward-linked list(s). The object-file address
 229  * of the 1st char of a frag is generally not known until after relax().
 230  * Many things at assembly time describe an address by {object-file-address
 231  * of a particular frag}+offset.
 232
 233  BUG: it may be smarter to have a single pointer off to various different
 234  notes for different frag kinds. See how code pans
 235  */
 236 struct frag                     /* a code fragment */
 237 {
 238         unsigned long fr_address; /* Object file address. */
 239         struct frag *fr_next;   /* Chain forward; ascending address order. */
 240         /* Rooted in frch_root. */
 241
 242         long fr_fix;    /* (Fixed) number of chars we know we have. */
 243         /* May be 0. */
 244         long fr_var;    /* (Variable) number of chars after above. */
 245         /* May be 0. */
 246         struct symbol *fr_symbol; /* For variable-length tail. */
 247         long fr_offset; /* For variable-length tail. */
 248         char    *fr_opcode;     /*->opcode low addr byte,for relax()ation*/
 249         relax_stateT fr_type;   /* What state is my tail in? */
 250         relax_substateT fr_subtype;
 251         /* These are needed only on the NS32K machines */
 252         char    fr_pcrel_adjust;
 253         char    fr_bsr;
 254 #ifndef NO_LISTING
 255         struct list_info_struct *line;
 256 #endif
 257         char    fr_literal [1]; /* Chars begin here. */
 258         /* One day we will compile fr_literal[0]. */
 259 };
 260 #define SIZEOF_STRUCT_FRAG \
 261 ((int)zero_address_frag.fr_literal-(int)&zero_address_frag)
 262 /* We want to say fr_literal[0] above. */
 263
 264 typedef struct frag fragS;
 265
 266 COMMON fragS *  frag_now;       /* -> current frag we are building. */
 267 /* This frag is incomplete. */
 268 /* It is, however, included in frchain_now. */
 269 /* Frag_now->fr_fix is bogus. Use: */
 270 /* Virtual frag_now->fr_fix==obstack_next_free(&frags)-frag_now->fr_literal.*/
 271
 272 COMMON fragS zero_address_frag; /* For foreign-segment symbol fixups. */
 273 COMMON fragS  bss_address_frag; /* For local common (N_BSS segment) fixups. */
 274
 275 /* main program "as.c" (command arguments etc) */
 276
 277 COMMON char
 278     flagseen[128];                      /* ['x'] TRUE if "-x" seen. */
 279
 280 COMMON char *
 281     out_file_name;                      /* name of emitted object file */
 282
 283 COMMON int      need_pass_2;    /* TRUE if we need a second pass. */
 284
 285 typedef struct {
 286         char *  poc_name;       /* assembler mnemonic, lower case, no '.' */
 287         void            (*poc_handler)();       /* Do the work */
 288         int             poc_val;        /* Value to pass to handler */
 289 } pseudo_typeS;
 290
 291 #if defined(__STDC__) & !defined(NO_STDARG)
 292
 293 int had_errors(void);
 294 int had_warnings(void);
 295 void as_bad(const char *Format, ...);
 296 void as_fatal(const char *Format, ...);
 297 void as_tsktsk(const char *Format, ...);
 298 void as_warn(const char *Format, ...);
 299
 300 #else
 301
 302 int had_errors();
 303 int had_warnings();
 304 void as_bad();
 305 void as_fatal();
 306 void as_tsktsk();
 307 void as_warn();
 308
 309 #endif /* __STDC__ & !NO_STDARG */
 310
 311 #ifdef __STDC__
 312
 313 char *app_push(void);
 314 char *atof_ieee(char *str, int what_kind, LITTLENUM_TYPE *words);
 315 char *input_scrub_include_file(char *filename, char *position);
 316 char *input_scrub_new_file(char *filename);
 317 char *input_scrub_next_buffer(char **bufp);
 318 char *strstr(const char *s, const char *wanted);
 319 char *xmalloc(int size);
 320 char *xrealloc(char *ptr, long n);
 321 int do_scrub_next_char(int (*get)(), void (*unget)());
 322 int gen_to_words(LITTLENUM_TYPE *words, int precision, long exponent_bits);
 323 int had_err(void);
 324 int had_errors(void);
 325 int had_warnings(void);
 326 int ignore_input(void);
 327 int scrub_from_file(void);
 328 int scrub_from_file(void);
 329 int scrub_from_string(void);
 330 int seen_at_least_1_file(void);
 331 void app_pop(char *arg);
 332 void as_howmuch(FILE *stream);
 333 void as_perror(char *gripe, char *filename);
 334 void as_where(void);
 335 void bump_line_counters(void);
 336 void do_scrub_begin(void);
 337 void input_scrub_begin(void);
 338 void input_scrub_close(void);
 339 void input_scrub_end(void);
 340 void int_to_gen(long x);
 341 void new_logical_line(char *fname, int line_number);
 342 void scrub_to_file(int ch);
 343 void scrub_to_string(int ch);
 344 void subseg_change(segT seg, int subseg);
 345 void subseg_new(segT seg, subsegT subseg);
 346 void subsegs_begin(void);
 347
 348 #else /* __STDC__ */
 349
 350 char *app_push();
 351 char *atof_ieee();
 352 char *input_scrub_include_file();
 353 char *input_scrub_new_file();
 354 char *input_scrub_next_buffer();
 355 char *strstr();
 356 char *xmalloc();
 357 char *xrealloc();
 358 int do_scrub_next_char();
 359 int gen_to_words();
 360 int had_err();
 361 int had_errors();
 362 int had_warnings();
 363 int ignore_input();
 364 int scrub_from_file();
 365 int scrub_from_file();
 366 int scrub_from_string();
 367 int seen_at_least_1_file();
 368 void app_pop();
 369 void as_howmuch();
 370 void as_perror();
 371 void as_where();
 372 void bump_line_counters();
 373 void do_scrub_begin();
 374 void input_scrub_begin();
 375 void input_scrub_close();
 376 void input_scrub_end();
 377 void int_to_gen();
 378 void new_logical_line();
 379 void scrub_to_file();
 380 void scrub_to_string();
 381 void subseg_change();
 382 void subseg_new();
 383 void subsegs_begin();
 384
 385 #endif /* __STDC__ */
 386
 387 /* this one starts the chain of target dependant headers */
 388 #include "targ-env.h"
 389
 390 /* these define types needed by the interfaces */
 391 #include "struc-symbol.h"
 392 #include "aout/reloc.h"
 393 #include "write.h"
 394 #include "expr.h"
 395 #include "frags.h"
 396 #include "hash.h"
 397 #include "read.h"
 398 #include "symbols.h"
 399
 400 #include "tc.h"
 401 #include "obj.h"
 402
 403 /*
 404  * Local Variables:
 405  * comment-column: 0
 406  * fill-column: 131
 407  * End:
 408  */
 409
 410 /* end of as.h */