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