1 /* as.h - global header file
2 Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 1997
3 Free Software Foundation, Inc.
5 This file is part of GAS, the GNU Assembler.
7 GAS is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GAS is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GAS; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
25 * I think this stuff is largely out of date. xoxorich.
27 * CAPITALISED names are #defined.
28 * "lowercaseH" is #defined if "lowercase.h" has been #include-d.
29 * "lowercaseT" is a typedef of "lowercase" objects.
30 * "lowercaseP" is type "pointer to object of type 'lowercase'".
31 * "lowercaseS" is typedef struct ... lowercaseS.
33 * #define DEBUG to enable all the "know" assertion tests.
34 * #define SUSPECT when debugging hash code.
35 * #define COMMON as "extern" for all modules except one, where you #define
37 * If TEST is #defined, then we are testing a module: #define COMMON as "".
42 /* This is the code recommended in the autoconf documentation, almost
43 verbatim. If it doesn't work for you, let me know, and notify
44 djm@gnu.ai.mit.edu as well. */
45 /* Added #undef for DJ Delorie. The right fix is to ensure that as.h
46 is included first, before even any system header files, in all files
47 that use it. KR 1994.11.03 */
48 /* Added void* version for STDC case. This is to be compatible with
49 the declaration in bison.simple, used for m68k operand parsing.
51 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
53 /* AIX requires this to be the first thing in the file. */
56 extern void *alloca ();
58 extern char *alloca ();
67 # ifndef alloca /* predefined by HP cc +Olibcalls */
68 # if !defined (__STDC__) && !defined (__hpux)
69 extern char *alloca ();
71 extern void *alloca ();
72 # endif /* __STDC__, __hpux */
75 # endif /* HAVE_ALLOCA_H */
78 /* Now, tend to the rest of the configuration. */
80 /* System include files first... */
96 #ifdef HAVE_SYS_TYPES_H
97 /* for size_t, pid_t */
98 #include <sys/types.h>
102 /* The first getopt value for machine-independent long options.
103 150 isn't special; it's just an arbitrary non-ASCII char value. */
104 #define OPTION_STD_BASE 150
105 /* The first getopt value for machine-dependent long options.
106 170 gives the standard options room to grow. */
107 #define OPTION_MD_BASE 170
112 #if !defined (__GNUC__) || __GNUC_MINOR__ <= 5
113 #define __PRETTY_FUNCTION__ ((char*)0)
117 /* Handle lossage with assert.h. */
118 #ifndef BROKEN_ASSERT
120 #else /* BROKEN_ASSERT */
122 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
124 #define assert(p) ((p), 0)
126 #endif /* BROKEN_ASSERT */
130 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
132 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
137 /* Now GNU header files... */
138 #include <ansidecl.h>
142 #include <libiberty.h>
144 /* Define the standard progress macros. */
145 #include <progress.h>
147 /* This doesn't get taken care of anywhere. */
148 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
149 #if !defined (__GNUC__) && !defined (inline)
152 #endif /* !__MWERKS__ */
154 /* Other stuff from config.h. */
155 #ifdef NEED_DECLARATION_STRSTR
156 extern char *strstr ();
158 #ifdef NEED_DECLARATION_MALLOC
159 extern PTR
malloc ();
160 extern PTR
realloc ();
162 #ifdef NEED_DECLARATION_FREE
165 #ifdef NEED_DECLARATION_ERRNO
169 /* This is needed for VMS with DEC C. */
170 #if ! defined (__GNUC__) && ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
171 #define unlink remove
174 /* Hack to make "gcc -Wall" not complain about obstack macros. */
175 #if !defined (memcpy) && !defined (bcopy)
176 #define bcopy(src,dest,size) memcpy(dest,src,size)
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__ */
197 #include "fopen-bin.h"
199 #include "fopen-same.h"
204 #define EXIT_SUCCESS 0
205 #define EXIT_FAILURE 1
208 #define obstack_chunk_alloc xmalloc
209 #define obstack_chunk_free xfree
213 #define BAD_CASE(val) \
215 as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
216 (long) val, __LINE__, __FILE__); \
221 /* These are assembler-wide concepts */
224 extern bfd
*stdoutput
;
225 typedef bfd_vma addressT
;
226 typedef bfd_signed_vma offsetT
;
228 typedef unsigned long addressT
;
229 typedef long offsetT
;
232 /* Type of symbol value, etc. For use in prototypes. */
233 typedef addressT valueT
;
237 #define COMMON /* declare our COMMONs storage here. */
239 #define COMMON extern /* our commons live elswhere */
242 /* COMMON now defined */
246 #define know(p) assert(p) /* Verify our assumptions! */
247 #endif /* not yet defined */
249 #define know(p) /* know() checks are no-op.ed */
255 * Supplies sanitised buffers to read.c.
256 * Also understands printing line-number part of error messages.
260 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
262 #ifndef BFD_ASSEMBLER
266 #define N_SEGMENTS 40
267 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
268 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
269 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
270 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
271 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
272 #define SEG_TEXT SEG_E0
273 #define SEG_DATA SEG_E1
274 #define SEG_BSS SEG_E2
275 #define SEG_LAST SEG_E39
278 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
279 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
287 SEG_GOOF
, /* Only happens if AS has a logic error. */
288 /* Invented so we don't crash printing */
289 /* error message involving weird segment. */
290 SEG_EXPR
, /* Intermediate expression values. */
291 SEG_DEBUG
, /* Debug segment */
292 SEG_NTV
, /* Transfert vector preload segment */
293 SEG_PTV
, /* Transfert vector postload segment */
294 SEG_REGISTER
/* Mythical: a register-valued expression */
297 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
299 typedef asection
*segT
;
300 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
301 && (SEG) != undefined_section \
302 && (SEG) != reg_section \
303 && (SEG) != expr_section)
307 /* What subseg we are accreting now? */
308 COMMON subsegT now_subseg
;
310 /* Segment our instructions emit to. */
314 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
316 extern char const *const seg_name
[];
317 #define segment_name(SEG) seg_name[(int) (SEG)]
320 #ifndef BFD_ASSEMBLER
321 extern int section_alignment
[];
325 extern segT reg_section
, expr_section
;
326 /* Shouldn't these be eliminated someday? */
327 extern segT text_section
, data_section
, bss_section
;
328 #define absolute_section bfd_abs_section_ptr
329 #define undefined_section bfd_und_section_ptr
331 #define reg_section SEG_REGISTER
332 #define expr_section SEG_EXPR
333 #define text_section SEG_TEXT
334 #define data_section SEG_DATA
335 #define bss_section SEG_BSS
336 #define absolute_section SEG_ABSOLUTE
337 #define undefined_section SEG_UNKNOWN
344 /* Variable chars to be repeated fr_offset times.
345 Fr_symbol unused. Used with fr_offset == 0 for a
346 constant length frag. */
349 /* Align. The fr_offset field holds the power of 2 to which to
350 align. The fr_var field holds the number of characters in the
351 fill pattern. The fr_subtype field holds the maximum number of
352 bytes to skip when aligning, or 0 if there is no maximum. */
355 /* Align code. The fr_offset field holds the power of 2 to which
356 to align. This type is only generated by machine specific
357 code, which is normally responsible for handling the fill
358 pattern. The fr_subtype field holds the maximum number of
359 bytes to skip when aligning, or 0 if there is no maximum. */
362 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
366 #ifndef WORKING_DOT_WORD
371 /* machine-specific relaxable (or similarly alterable) instruction */
372 rs_machine_dependent
,
374 /* .space directive with expression operand that needs to be computed
375 later. Similar to rs_org, but different.
377 1 variable char: fill character */
380 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
381 unsigned, 1 for signed. */
385 typedef enum _relax_state relax_stateT
;
387 /* This type is used in prototypes, so it can't be a type that will be
388 widened for argument passing. */
389 typedef unsigned int relax_substateT
;
391 /* Enough bits for address, but still an integer type.
392 Could be a problem, cross-assembling for 64-bit machines. */
393 typedef addressT relax_addressT
;
399 * A code fragment (frag) is some known number of chars, followed by some
400 * unknown number of chars. Typically the unknown number of chars is an
401 * instruction address whose size is yet unknown. We always know the greatest
402 * possible size the unknown number of chars may become, and reserve that
403 * much room at the end of the frag.
404 * Once created, frags do not change address during assembly.
405 * We chain the frags in (a) forward-linked list(s). The object-file address
406 * of the 1st char of a frag is generally not known until after relax().
407 * Many things at assembly time describe an address by {object-file-address
408 * of a particular frag}+offset.
410 BUG: it may be smarter to have a single pointer off to various different
411 notes for different frag kinds. See how code pans
415 /* Object file address. */
417 /* Chain forward; ascending address order. Rooted in frch_root. */
418 struct frag
*fr_next
;
420 /* (Fixed) number of chars we know we have. May be 0. */
422 /* (Variable) number of chars after above. May be 0. */
424 /* For variable-length tail. */
425 struct symbol
*fr_symbol
;
426 /* For variable-length tail. */
428 /* Points to opcode low addr byte, for relaxation. */
432 struct list_info_struct
*line
;
435 /* What state is my tail in? */
436 relax_stateT fr_type
;
437 relax_substateT fr_subtype
;
440 /* These are needed only on the NS32K machines. But since we don't
441 include targ-cpu.h until after this structure has been defined,
442 we can't really conditionalize it. This code should be
443 rearranged a bit to make that possible. */
445 char pcrel_adjust
, bsr
;
448 /* Don't include this unless using CGEN to keep frag size down. */
450 const struct cgen_insn
*insn
;
451 unsigned char opindex
, opinfo
;
456 /* Where the frag was created, or where it became a variant frag. */
458 unsigned int fr_line
;
460 /* Data begins here. */
464 #define SIZEOF_STRUCT_FRAG \
465 ((char *)zero_address_frag.fr_literal-(char *)&zero_address_frag)
466 /* We want to say fr_literal[0] above. */
468 typedef struct frag fragS
;
470 /* Current frag we are building. This frag is incomplete. It is, however,
471 included in frchain_now. The fr_fix field is bogus; instead, use:
472 obstack_next_free(&frags)-frag_now->fr_literal. */
473 COMMON fragS
*frag_now
;
474 extern int frag_now_fix
PARAMS ((void));
476 /* For foreign-segment symbol fixups. */
477 COMMON fragS zero_address_frag
;
478 /* For local common (N_BSS segment) fixups. */
479 COMMON fragS bss_address_frag
;
481 /* main program "as.c" (command arguments etc) */
483 COMMON
unsigned char flag_no_comments
; /* -f */
484 COMMON
unsigned char flag_debug
; /* -D */
485 COMMON
unsigned char flag_signed_overflow_ok
; /* -J */
486 #ifndef WORKING_DOT_WORD
487 COMMON
unsigned char flag_warn_displacement
; /* -K */
490 /* True if local symbols should be retained. */
491 COMMON
int flag_keep_locals
; /* -L */
493 /* True if we are assembling in MRI mode. */
496 /* True if we are assembling in m68k MRI mode. */
497 COMMON
int flag_m68k_mri
;
499 /* Should the data section be made read-only and appended to the text
501 COMMON
unsigned char flag_readonly_data_in_text
; /* -R */
503 /* True if warnings should be inhibited. */
504 COMMON
int flag_no_warnings
; /* -W */
506 /* True if we should attempt to generate output even if non-fatal errors
508 COMMON
unsigned char flag_always_generate_output
; /* -Z */
510 /* This is true if the assembler should output time and space usage. */
512 COMMON
unsigned char flag_print_statistics
;
514 /* name of emitted object file */
515 COMMON
char *out_file_name
;
517 /* name of file defining extensions to the basic instruction set */
518 COMMON
char *insttbl_file_name
;
520 /* TRUE if we need a second pass. */
521 COMMON
int need_pass_2
;
523 /* TRUE if we should do no relaxing, and
524 leave lots of padding. */
525 COMMON
int linkrelax
;
527 /* TRUE if we should produce a listing. */
530 /* Type of debugging information we should generate. We currently
531 only support stabs and ECOFF. */
533 enum debug_info_type
{ DEBUG_NONE
, DEBUG_STABS
, DEBUG_ECOFF
};
535 extern enum debug_info_type debug_type
;
537 /* Maximum level of macro nesting. */
538 extern int max_macro_nest
;
540 /* Obstack chunk size. Keep large for efficient space use, make small to
541 increase malloc calls for monitoring memory allocation. */
542 extern int chunksize
;
546 /* assembler mnemonic, lower case, no '.' */
547 const char *poc_name
;
549 void (*poc_handler
) PARAMS ((int));
550 /* Value to pass to handler */
554 typedef struct _pseudo_type pseudo_typeS
;
556 /* Prefer varargs for non-ANSI compiler, since some will barf if the
557 ellipsis definition is used with a no-arguments declaration. */
558 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
562 #if defined (HAVE_STDARG_H)
565 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
570 #if (__GNUC__ >= 2) && !defined(VMS)
571 /* for use with -Wformat */
572 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...) \
573 __attribute__ ((format (printf, 1, 2)))
574 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, unsigned int line, \
575 const char *format, ...) \
576 __attribute__ ((format (printf, 3, 4)))
577 #else /* ANSI C with stdarg, but not GNU C */
578 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
579 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
581 const char *format, ...))
583 #else /* not using stdarg */
584 #define PRINTF_LIKE(FCN) void FCN ()
585 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
588 PRINTF_LIKE (as_bad
);
589 PRINTF_LIKE (as_fatal
);
590 PRINTF_LIKE (as_tsktsk
);
591 PRINTF_LIKE (as_warn
);
592 PRINTF_WHERE_LIKE (as_bad_where
);
593 PRINTF_WHERE_LIKE (as_warn_where
);
594 void as_assert
PARAMS ((const char *, int, const char *));
595 void as_abort
PARAMS ((const char *, int, const char *));
597 void fprint_value
PARAMS ((FILE *file
, addressT value
));
598 void sprint_value
PARAMS ((char *buf
, addressT value
));
600 int had_errors
PARAMS ((void));
601 int had_warnings
PARAMS ((void));
603 void print_version_id
PARAMS ((void));
604 char *app_push
PARAMS ((void));
605 char *atof_ieee
PARAMS ((char *str
, int what_kind
, LITTLENUM_TYPE
* words
));
606 char *input_scrub_include_file
PARAMS ((char *filename
, char *position
));
607 char *input_scrub_new_file
PARAMS ((char *filename
));
608 char *input_scrub_next_buffer
PARAMS ((char **bufp
));
609 int do_scrub_chars
PARAMS ((int (*get
) (char **), char *to
, int tolen
));
610 int gen_to_words
PARAMS ((LITTLENUM_TYPE
* words
, int precision
,
611 long exponent_bits
));
612 int had_err
PARAMS ((void));
613 int ignore_input
PARAMS ((void));
614 void cond_finish_check
PARAMS ((int));
615 void cond_exit_macro
PARAMS ((int));
616 int seen_at_least_1_file
PARAMS ((void));
617 void app_pop
PARAMS ((char *arg
));
618 void as_howmuch
PARAMS ((FILE * stream
));
619 void as_perror
PARAMS ((const char *gripe
, const char *filename
));
620 void as_where
PARAMS ((char **namep
, unsigned int *linep
));
621 void bump_line_counters
PARAMS ((void));
622 void do_scrub_begin
PARAMS ((int));
623 void input_scrub_begin
PARAMS ((void));
624 void input_scrub_close
PARAMS ((void));
625 void input_scrub_end
PARAMS ((void));
626 void new_logical_line
PARAMS ((char *fname
, int line_number
));
627 void subsegs_begin
PARAMS ((void));
628 void subseg_change
PARAMS ((segT seg
, int subseg
));
629 segT subseg_new
PARAMS ((const char *name
, subsegT subseg
));
630 segT subseg_force_new
PARAMS ((const char *name
, subsegT subseg
));
631 void subseg_set
PARAMS ((segT seg
, subsegT subseg
));
633 segT subseg_get
PARAMS ((const char *, int));
636 void start_dependencies
PARAMS ((char *));
637 void register_dependency
PARAMS ((char *));
638 void print_dependencies
PARAMS ((void));
647 valueT add_to_literal_pool
PARAMS ((struct symbol
*, valueT
, segT
, int));
650 #include "expr.h" /* Before targ-*.h */
652 /* this one starts the chain of target dependant headers */
653 #include "targ-env.h"
655 #include "struc-symbol.h"
665 #ifdef USE_EMULATIONS
670 #ifndef LOCAL_LABELS_DOLLAR
671 #define LOCAL_LABELS_DOLLAR 0
674 #ifndef LOCAL_LABELS_FB
675 #define LOCAL_LABELS_FB 0