1 /* as.h - global header file
2 Copyright (C) 1987, 1990, 1991, 1992 Free Software Foundation, Inc.
4 This file is part of GAS, the GNU Assembler.
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)
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.
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, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
23 * I think this stuff is largely out of date. xoxorich.
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.
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
35 * If TEST is #defined, then we are testing a module: #define COMMON as "".
40 /* This is the code recommended in the autoconf documentation, almost
41 verbatim. If it doesn't work for you, let me know, and notify
42 djm@gnu.ai.mit.edu as well. */
43 /* Added #undef for DJ Delorie. The right fix is to ensure that as.h
44 is included first, before even any system header files, in all files
45 that use it. KR 1994.11.03 */
46 /* Added void* version for STDC case. This is to be compatible with
47 the declaration in bison.simple, used for m68k operand parsing.
50 /* AIX requires this to be the first thing in the file. */
53 # define alloca __builtin_alloca
61 # ifndef alloca /* predefined by HP cc +Olibcalls */
72 /* Now, tend to the rest of the configuration. */
74 /* System include files first... */
88 #ifdef HAVE_SYS_TYPES_H
89 /* for size_t, pid_t */
90 #include <sys/types.h>
93 /* Some systems do declare this, but this seems to be the universal
94 declaration, though the parameter type varies. (It ought to use
95 `const' but many systems prototype it without.) Include it here
96 for systems that don't declare it. If conflicts arise, just add
97 another autoconf test... */
98 extern char *strdup (/* const char * */);
101 /* The first getopt value for machine-independent long options.
102 150 isn't special; it's just an arbitrary non-ASCII char value. */
103 #define OPTION_STD_BASE 150
104 /* The first getopt value for machine-dependent long options.
105 170 gives the standard options room to grow. */
106 #define OPTION_MD_BASE 170
111 #if !defined (__GNUC__) || __GNUC_MINOR__ <= 5
112 #define __PRETTY_FUNCTION__ ((char*)0)
116 /* Handle lossage with assert.h. */
117 #ifndef BROKEN_ASSERT
119 #else /* BROKEN_ASSERT */
121 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
123 #define assert(p) ((p), 0)
125 #endif /* BROKEN_ASSERT */
129 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
131 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
136 /* Now GNU header files... */
137 #include <ansidecl.h>
142 /* Define the standard progress macros. */
143 #include <progress.h>
145 /* This doesn't get taken care of anywhere. */
146 #if !defined (__GNUC__) && !defined (inline)
150 /* Other stuff from config.h. */
151 #ifdef NEED_DECLARATION_MALLOC
152 extern PTR malloc ();
153 extern PTR realloc ();
155 #ifdef NEED_DECLARATION_FREE
158 #ifdef NEED_DECLARATION_ERRNO
162 /* This is needed for VMS. */
163 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
164 #define unlink remove
167 /* Hack to make "gcc -Wall" not complain about obstack macros. */
168 #if !defined (memcpy) && !defined (bcopy)
169 #define bcopy(src,dest,size) memcpy(dest,src,size)
173 /* This one doesn't get declared, but we're using it anyways. This
174 should be fixed -- either it's part of the external interface or
176 extern PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t sz));
179 /* Make Saber happier on obstack.h. */
182 #define __PTR_TO_INT(P) ((int)(P))
184 #define __INT_TO_PTR(P) ((char *)(P))
188 #define __LINE__ "unknown"
189 #endif /* __LINE__ */
192 #define __FILE__ "unknown"
193 #endif /* __FILE__ */
202 #endif /* ! __STDC__ */
204 #if !defined (__GNUC__) && !defined (inline)
210 #include "fopen-bin.h"
212 #include "fopen-same.h"
217 #define EXIT_SUCCESS 0
218 #define EXIT_FAILURE 1
221 #define obstack_chunk_alloc xmalloc
222 #define obstack_chunk_free xfree
226 #define BAD_CASE(val) \
228 as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
229 (long) val, __LINE__, __FILE__); \
232 /* Version 2.1 of Solaris had problems with this declaration, but I
233 think that bug has since been fixed. If it causes problems on your
234 system, just delete it. */
235 extern char *strstr ();
239 /* These are assembler-wide concepts */
242 extern bfd *stdoutput;
243 typedef bfd_vma addressT;
244 typedef bfd_signed_vma offsetT;
246 typedef unsigned long addressT;
247 typedef long offsetT;
250 /* Type of symbol value, etc. For use in prototypes. */
251 typedef addressT valueT;
255 #define COMMON /* declare our COMMONs storage here. */
257 #define COMMON extern /* our commons live elswhere */
260 /* COMMON now defined */
264 #define know(p) assert(p) /* Verify our assumptions! */
265 #endif /* not yet defined */
267 #define know(p) /* know() checks are no-op.ed */
273 * Supplies sanitised buffers to read.c.
274 * Also understands printing line-number part of error messages.
278 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
280 #ifndef BFD_ASSEMBLER
284 #define N_SEGMENTS 10
285 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E9)
286 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9
287 #define SEG_TEXT SEG_E0
288 #define SEG_DATA SEG_E1
289 #define SEG_BSS SEG_E2
292 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
293 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
301 SEG_GOOF, /* Only happens if AS has a logic error. */
302 /* Invented so we don't crash printing */
303 /* error message involving weird segment. */
304 SEG_EXPR, /* Intermediate expression values. */
305 SEG_DEBUG, /* Debug segment */
306 SEG_NTV, /* Transfert vector preload segment */
307 SEG_PTV, /* Transfert vector postload segment */
308 SEG_REGISTER /* Mythical: a register-valued expression */
311 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
313 typedef asection *segT;
314 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
315 && (SEG) != undefined_section \
316 && (SEG) != reg_section \
317 && (SEG) != expr_section)
321 /* What subseg we are accreting now? */
322 COMMON subsegT now_subseg;
324 /* Segment our instructions emit to. */
328 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
330 extern char const *const seg_name[];
331 #define segment_name(SEG) seg_name[(int) (SEG)]
334 #ifndef BFD_ASSEMBLER
335 extern int section_alignment[];
339 extern segT reg_section, expr_section;
340 /* Shouldn't these be eliminated someday? */
341 extern segT text_section, data_section, bss_section;
342 #define absolute_section bfd_abs_section_ptr
343 #define undefined_section bfd_und_section_ptr
345 #define reg_section SEG_REGISTER
346 #define expr_section SEG_EXPR
347 #define text_section SEG_TEXT
348 #define data_section SEG_DATA
349 #define bss_section SEG_BSS
350 #define absolute_section SEG_ABSOLUTE
351 #define undefined_section SEG_UNKNOWN
358 /* Variable chars to be repeated fr_offset times.
359 Fr_symbol unused. Used with fr_offset == 0 for a
360 constant length frag. */
363 /* Align: Fr_offset: power of 2. Variable chars: fill pattern. */
366 /* Align code: fr_offset: power of 2. Fill pattern is machine
367 specific, defaulting to all zeros. */
370 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
374 #ifndef WORKING_DOT_WORD
379 /* machine-specific relaxable (or similarly alterable) instruction */
380 rs_machine_dependent,
382 /* .space directive with expression operand that needs to be computed
383 later. Similar to rs_org, but different.
385 1 variable char: fill character */
389 typedef enum _relax_state relax_stateT;
391 /* This type is used in prototypes, so it can't be a type that will be
392 widened for argument passing. */
393 typedef unsigned int relax_substateT;
395 /* Enough bits for address, but still an integer type.
396 Could be a problem, cross-assembling for 64-bit machines. */
397 typedef addressT relax_addressT;
403 * A code fragment (frag) is some known number of chars, followed by some
404 * unknown number of chars. Typically the unknown number of chars is an
405 * instruction address whose size is yet unknown. We always know the greatest
406 * possible size the unknown number of chars may become, and reserve that
407 * much room at the end of the frag.
408 * Once created, frags do not change address during assembly.
409 * We chain the frags in (a) forward-linked list(s). The object-file address
410 * of the 1st char of a frag is generally not known until after relax().
411 * Many things at assembly time describe an address by {object-file-address
412 * of a particular frag}+offset.
414 BUG: it may be smarter to have a single pointer off to various different
415 notes for different frag kinds. See how code pans
419 /* Object file address. */
421 /* Chain forward; ascending address order. Rooted in frch_root. */
422 struct frag *fr_next;
424 /* (Fixed) number of chars we know we have. May be 0. */
426 /* (Variable) number of chars after above. May be 0. */
428 /* For variable-length tail. */
429 struct symbol *fr_symbol;
430 /* For variable-length tail. */
432 /* Points to opcode low addr byte, for relaxation. */
436 struct list_info_struct *line;
439 /* What state is my tail in? */
440 relax_stateT fr_type;
441 relax_substateT fr_subtype;
443 /* Track the alignment and offset of the current frag. With this,
444 sometimes we can avoid creating new frags for .align directives. */
445 unsigned short align_mask;
446 unsigned short align_offset;
448 /* These are needed only on the NS32K machines. But since we don't
449 include targ-cpu.h until after this structure has been defined,
450 we can't really conditionalize it. This code should be
451 rearranged a bit to make that possible.
453 In the meantime, if we get stuck like this with any other target,
454 create a union here. */
455 char fr_pcrel_adjust, fr_bsr;
457 /* Data begins here. */
461 #define SIZEOF_STRUCT_FRAG \
462 ((char *)zero_address_frag.fr_literal-(char *)&zero_address_frag)
463 /* We want to say fr_literal[0] above. */
465 typedef struct frag fragS;
467 /* Current frag we are building. This frag is incomplete. It is, however,
468 included in frchain_now. The fr_fix field is bogus; instead, use:
469 obstack_next_free(&frags)-frag_now->fr_literal. */
470 COMMON fragS *frag_now;
471 extern int frag_now_fix ();
473 /* For foreign-segment symbol fixups. */
474 COMMON fragS zero_address_frag;
475 /* For local common (N_BSS segment) fixups. */
476 COMMON fragS bss_address_frag;
478 /* main program "as.c" (command arguments etc) */
480 COMMON unsigned char flag_no_comments; /* -f */
481 COMMON unsigned char flag_debug; /* -D */
482 COMMON unsigned char flag_signed_overflow_ok; /* -J */
483 #ifndef WORKING_DOT_WORD
484 COMMON unsigned char flag_warn_displacement; /* -K */
487 /* True if local symbols should be retained. */
488 COMMON unsigned char flag_keep_locals; /* -L */
490 /* True if we are assembling using MRI syntax. */
493 /* Should the data section be made read-only and appended to the text
495 COMMON unsigned char flag_readonly_data_in_text; /* -R */
497 /* True if warnings should be inhibited. */
498 COMMON unsigned char flag_no_warnings; /* -W */
500 /* True if we should attempt to generate output even if non-fatal errors
502 COMMON unsigned char flag_always_generate_output; /* -Z */
504 /* This is true if the assembler should output time and space usage. */
506 COMMON unsigned char flag_print_statistics;
508 /* name of emitted object file */
509 COMMON char *out_file_name;
511 /* TRUE if we need a second pass. */
512 COMMON int need_pass_2;
514 /* TRUE if we should do no relaxing, and
515 leave lots of padding. */
516 COMMON int linkrelax;
518 /* TRUE if we should produce a listing. */
523 /* assembler mnemonic, lower case, no '.' */
524 const char *poc_name;
526 void (*poc_handler) PARAMS ((int));
527 /* Value to pass to handler */
531 typedef struct _pseudo_type pseudo_typeS;
533 /* Prefer varargs for non-ANSI compiler, since some will barf if the
534 ellipsis definition is used with a no-arguments declaration. */
535 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
539 #if defined (HAVE_STDARG_H)
542 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
548 /* for use with -Wformat */
549 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...) \
550 __attribute__ ((format (printf, 1, 2)))
551 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, unsigned int line, \
552 const char *format, ...) \
553 __attribute__ ((format (printf, 3, 4)))
554 #else /* ANSI C with stdarg, but not GNU C */
555 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
556 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
558 const char *format, ...))
560 #else /* not using stdarg */
561 #define PRINTF_LIKE(FCN) void FCN ()
562 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
565 PRINTF_LIKE (as_bad);
566 PRINTF_LIKE (as_fatal);
567 PRINTF_LIKE (as_tsktsk);
568 PRINTF_LIKE (as_warn);
569 PRINTF_WHERE_LIKE (as_bad_where);
570 PRINTF_WHERE_LIKE (as_warn_where);
571 void as_assert PARAMS ((const char *, int, const char *));
572 void as_abort PARAMS ((const char *, int, const char *));
574 void fprint_value PARAMS ((FILE *file, addressT value));
575 void sprint_value PARAMS ((char *buf, addressT value));
577 int had_errors PARAMS ((void));
578 int had_warnings PARAMS ((void));
580 void print_version_id PARAMS ((void));
581 char *app_push PARAMS ((void));
582 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
583 char *input_scrub_include_file PARAMS ((char *filename, char *position));
584 char *input_scrub_new_file PARAMS ((char *filename));
585 char *input_scrub_next_buffer PARAMS ((char **bufp));
586 PTR xmalloc PARAMS ((unsigned long size));
587 PTR xrealloc PARAMS ((PTR ptr, unsigned long n));
588 int do_scrub_next_char PARAMS ((int (*get) (void), void (*unget) (int)));
589 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
590 long exponent_bits));
591 int had_err PARAMS ((void));
592 int ignore_input PARAMS ((void));
593 int scrub_from_file PARAMS ((void));
594 int scrub_from_string PARAMS ((void));
595 int seen_at_least_1_file PARAMS ((void));
596 void app_pop PARAMS ((char *arg));
597 void as_howmuch PARAMS ((FILE * stream));
598 void as_perror PARAMS ((const char *gripe, const char *filename));
599 void as_where PARAMS ((char **namep, unsigned int *linep));
600 void bump_line_counters PARAMS ((void));
601 void do_scrub_begin PARAMS ((void));
602 void input_scrub_begin PARAMS ((void));
603 void input_scrub_close PARAMS ((void));
604 void input_scrub_end PARAMS ((void));
605 void new_logical_line PARAMS ((char *fname, int line_number));
606 void scrub_to_file PARAMS ((int ch));
607 void scrub_to_string PARAMS ((int ch));
608 void subsegs_begin PARAMS ((void));
609 void subseg_change PARAMS ((segT seg, int subseg));
610 segT subseg_new PARAMS ((const char *name, subsegT subseg));
611 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
612 void subseg_set PARAMS ((segT seg, subsegT subseg));
614 segT subseg_get PARAMS ((const char *, int));
624 valueT add_to_literal_pool PARAMS ((struct symbol *, valueT, segT, int));
627 #include "expr.h" /* Before targ-*.h */
629 /* this one starts the chain of target dependant headers */
630 #include "targ-env.h"
632 #include "struc-symbol.h"
642 #ifdef USE_EMULATIONS
647 #ifndef LOCAL_LABELS_DOLLAR
648 #define LOCAL_LABELS_DOLLAR 0
651 #ifndef LOCAL_LABELS_FB
652 #define LOCAL_LABELS_FB 0