1 /* as.h - global header file
2 Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000
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
24 /* I think this stuff is largely out of date. xoxorich.
26 * CAPITALISED names are #defined.
27 * "lowercaseH" is #defined if "lowercase.h" has been #include-d.
28 * "lowercaseT" is a typedef of "lowercase" objects.
29 * "lowercaseP" is type "pointer to object of type 'lowercase'".
30 * "lowercaseS" is typedef struct ... lowercaseS.
32 * #define DEBUG to enable all the "know" assertion tests.
33 * #define SUSPECT when debugging hash code.
34 * #define COMMON as "extern" for all modules except one, where you #define
36 * 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. */
57 extern void *alloca ();
59 extern char *alloca ();
69 # ifndef alloca /* predefined by HP cc +Olibcalls */
70 # if !defined (__STDC__) && !defined (__hpux)
71 extern char *alloca ();
73 extern void *alloca ();
74 # endif /* __STDC__, __hpux */
77 # endif /* HAVE_ALLOCA_H */
80 /* Now, tend to the rest of the configuration. */
82 /* System include files first... */
98 #ifdef HAVE_SYS_TYPES_H
99 /* for size_t, pid_t */
100 #include <sys/types.h>
104 /* The first getopt value for machine-independent long options.
105 150 isn't special; it's just an arbitrary non-ASCII char value. */
106 #define OPTION_STD_BASE 150
107 /* The first getopt value for machine-dependent long options.
108 190 gives the standard options room to grow. */
109 #define OPTION_MD_BASE 190
114 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
115 #define __PRETTY_FUNCTION__ ((char*)0)
119 /* Handle lossage with assert.h. */
120 #ifndef BROKEN_ASSERT
122 #else /* BROKEN_ASSERT */
124 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
126 #define assert(p) ((p), 0)
128 #endif /* BROKEN_ASSERT */
132 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
134 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
138 /* Now GNU header files... */
139 #include "ansidecl.h"
143 #include "libiberty.h"
145 /* Define the standard progress macros. */
146 #include "progress.h"
148 /* This doesn't get taken care of anywhere. */
149 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
150 #if !defined (__GNUC__) && !defined (inline)
153 #endif /* !__MWERKS__ */
155 /* Other stuff from config.h. */
156 #ifdef NEED_DECLARATION_STRSTR
157 extern char *strstr ();
159 #ifdef NEED_DECLARATION_MALLOC
160 extern PTR
malloc ();
161 extern PTR
realloc ();
163 #ifdef NEED_DECLARATION_FREE
166 #ifdef NEED_DECLARATION_ERRNO
169 #ifdef NEED_DECLARATION_ENVIRON
170 extern char **environ
;
173 /* This is needed for VMS. */
174 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
175 #define unlink remove
178 /* Hack to make "gcc -Wall" not complain about obstack macros. */
179 #if !defined (memcpy) && !defined (bcopy)
180 #define bcopy(src,dest,size) memcpy(dest,src,size)
183 /* Make Saber happier on obstack.h. */
186 #define __PTR_TO_INT(P) ((int) (P))
188 #define __INT_TO_PTR(P) ((char *) (P))
192 #define __LINE__ "unknown"
193 #endif /* __LINE__ */
196 #define __FILE__ "unknown"
197 #endif /* __FILE__ */
201 #include "fopen-bin.h"
203 #include "fopen-same.h"
208 #define EXIT_SUCCESS 0
209 #define EXIT_FAILURE 1
216 #define obstack_chunk_alloc xmalloc
217 #define obstack_chunk_free xfree
223 #define BAD_CASE(val) \
225 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
226 (long) val, __LINE__, __FILE__); \
231 /* These are assembler-wide concepts */
234 extern bfd
*stdoutput
;
235 typedef bfd_vma addressT
;
236 typedef bfd_signed_vma offsetT
;
238 typedef unsigned long addressT
;
239 typedef long offsetT
;
242 /* Type of symbol value, etc. For use in prototypes. */
243 typedef addressT valueT
;
247 #define COMMON /* declare our COMMONs storage here. */
249 #define COMMON extern /* our commons live elswhere */
252 /* COMMON now defined */
256 #define know(p) assert(p) /* Verify our assumptions! */
257 #endif /* not yet defined */
259 #define know(p) /* know() checks are no-op.ed */
264 /* Supplies sanitised buffers to read.c.
265 Also understands printing line-number part of error messages. */
267 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
269 #ifndef BFD_ASSEMBLER
273 #define N_SEGMENTS 40
274 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
275 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
276 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
277 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
278 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
279 #define SEG_TEXT SEG_E0
280 #define SEG_DATA SEG_E1
281 #define SEG_BSS SEG_E2
282 #define SEG_LAST SEG_E39
285 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
286 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
293 SEG_GOOF
, /* Only happens if AS has a logic error. */
294 /* Invented so we don't crash printing */
295 /* error message involving weird segment. */
296 SEG_EXPR
, /* Intermediate expression values. */
297 SEG_DEBUG
, /* Debug segment */
298 SEG_NTV
, /* Transfert vector preload segment */
299 SEG_PTV
, /* Transfert vector postload segment */
300 SEG_REGISTER
/* Mythical: a register-valued expression */
303 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
305 typedef asection
*segT
;
306 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
307 && (SEG) != undefined_section \
308 && (SEG) != reg_section \
309 && (SEG) != expr_section)
313 /* What subseg we are accreting now? */
314 COMMON subsegT now_subseg
;
316 /* Segment our instructions emit to. */
320 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
322 extern char const *const seg_name
[];
323 #define segment_name(SEG) seg_name[(int) (SEG)]
326 #ifndef BFD_ASSEMBLER
327 extern int section_alignment
[];
331 extern segT reg_section
, expr_section
;
332 /* Shouldn't these be eliminated someday? */
333 extern segT text_section
, data_section
, bss_section
;
334 #define absolute_section bfd_abs_section_ptr
335 #define undefined_section bfd_und_section_ptr
337 #define reg_section SEG_REGISTER
338 #define expr_section SEG_EXPR
339 #define text_section SEG_TEXT
340 #define data_section SEG_DATA
341 #define bss_section SEG_BSS
342 #define absolute_section SEG_ABSOLUTE
343 #define undefined_section SEG_UNKNOWN
349 /* Variable chars to be repeated fr_offset times.
350 Fr_symbol unused. Used with fr_offset == 0 for a
351 constant length frag. */
354 /* Align. The fr_offset field holds the power of 2 to which to
355 align. The fr_var field holds the number of characters in the
356 fill pattern. The fr_subtype field holds the maximum number of
357 bytes to skip when aligning, or 0 if there is no maximum. */
360 /* Align code. The fr_offset field holds the power of 2 to which
361 to align. This type is only generated by machine specific
362 code, which is normally responsible for handling the fill
363 pattern. The fr_subtype field holds the maximum number of
364 bytes to skip when aligning, or 0 if there is no maximum. */
367 /* Test for alignment. Like rs_align, but used by several targets
368 to warn if data is not properly aligned. */
371 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
375 #ifndef WORKING_DOT_WORD
380 /* machine-specific relaxable (or similarly alterable) instruction */
381 rs_machine_dependent
,
383 /* .space directive with expression operand that needs to be computed
384 later. Similar to rs_org, but different.
386 1 variable char: fill character */
389 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
390 unsigned, 1 for signed. */
393 /* Exception frame information which we may be able to optimize. */
396 /* Cross-fragment dwarf2 line number optimization. */
400 typedef enum _relax_state relax_stateT
;
402 /* This type is used in prototypes, so it can't be a type that will be
403 widened for argument passing. */
404 typedef unsigned int relax_substateT
;
406 /* Enough bits for address, but still an integer type.
407 Could be a problem, cross-assembling for 64-bit machines. */
408 typedef addressT relax_addressT
;
410 /* main program "as.c" (command arguments etc) */
412 COMMON
unsigned char flag_no_comments
; /* -f */
413 COMMON
unsigned char flag_debug
; /* -D */
414 COMMON
unsigned char flag_signed_overflow_ok
; /* -J */
415 #ifndef WORKING_DOT_WORD
416 COMMON
unsigned char flag_warn_displacement
; /* -K */
419 /* True if local symbols should be retained. */
420 COMMON
int flag_keep_locals
; /* -L */
422 /* True if we are assembling in MRI mode. */
425 /* Should the data section be made read-only and appended to the text
427 COMMON
unsigned char flag_readonly_data_in_text
; /* -R */
429 /* True if warnings should be inhibited. */
430 COMMON
int flag_no_warnings
; /* -W */
432 /* True if warnings count as errors. */
433 COMMON
int flag_fatal_warnings
; /* --fatal-warnings */
435 /* True if we should attempt to generate output even if non-fatal errors
437 COMMON
unsigned char flag_always_generate_output
; /* -Z */
439 /* This is true if the assembler should output time and space usage. */
440 COMMON
unsigned char flag_print_statistics
;
442 /* True if local absolute symbols are to be stripped. */
443 COMMON
int flag_strip_local_absolute
;
445 /* True if we should generate a traditional format object file. */
446 COMMON
int flag_traditional_format
;
448 /* name of emitted object file */
449 COMMON
char *out_file_name
;
451 /* name of file defining extensions to the basic instruction set */
452 COMMON
char *insttbl_file_name
;
454 /* TRUE if we need a second pass. */
455 COMMON
int need_pass_2
;
457 /* TRUE if we should do no relaxing, and
458 leave lots of padding. */
459 COMMON
int linkrelax
;
461 /* TRUE if we should produce a listing. */
464 /* Type of debugging information we should generate. We currently support
465 stabs, ECOFF, and DWARF2.
467 NOTE! This means debug information about the assembly source code itself
468 and _not_ about possible debug information from a high-level language.
469 This is especially relevant to DWARF2, since the compiler may emit line
470 number directives that the assembler resolves. */
472 enum debug_info_type
{
481 extern enum debug_info_type debug_type
;
483 /* Maximum level of macro nesting. */
484 extern int max_macro_nest
;
486 /* Obstack chunk size. Keep large for efficient space use, make small to
487 increase malloc calls for monitoring memory allocation. */
488 extern int chunksize
;
490 struct _pseudo_type
{
491 /* assembler mnemonic, lower case, no '.' */
492 const char *poc_name
;
494 void (*poc_handler
) PARAMS ((int));
495 /* Value to pass to handler */
499 typedef struct _pseudo_type pseudo_typeS
;
501 /* Prefer varargs for non-ANSI compiler, since some will barf if the
502 ellipsis definition is used with a no-arguments declaration. */
503 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
507 #if defined (HAVE_STDARG_H)
510 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
515 #if (__GNUC__ >= 2) && !defined(VMS)
516 /* for use with -Wformat */
518 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
519 /* Support for double underscores in attribute names was added in gcc
520 2.6, so avoid them if we are using an earlier version. */
521 #define __printf__ printf
522 #define __format__ format
525 #define PRINTF_LIKE(FCN) \
526 void FCN (const char *format, ...) \
527 __attribute__ ((__format__ (__printf__, 1, 2)))
528 #define PRINTF_WHERE_LIKE(FCN) \
529 void FCN (char *file, unsigned int line, const char *format, ...) \
530 __attribute__ ((__format__ (__printf__, 3, 4)))
532 #else /* __GNUC__ < 2 || defined(VMS) */
534 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
535 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
537 const char *format, ...))
539 #endif /* __GNUC__ < 2 || defined(VMS) */
541 #else /* ! USE_STDARG */
543 #define PRINTF_LIKE(FCN) void FCN ()
544 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
546 #endif /* ! USE_STDARG */
548 PRINTF_LIKE (as_bad
);
549 PRINTF_LIKE (as_fatal
) ATTRIBUTE_NORETURN
;
550 PRINTF_LIKE (as_tsktsk
);
551 PRINTF_LIKE (as_warn
);
552 PRINTF_WHERE_LIKE (as_bad_where
);
553 PRINTF_WHERE_LIKE (as_warn_where
);
555 void as_assert
PARAMS ((const char *, int, const char *));
556 void as_abort
PARAMS ((const char *, int, const char *)) ATTRIBUTE_NORETURN
;
558 void fprint_value
PARAMS ((FILE *file
, addressT value
));
559 void sprint_value
PARAMS ((char *buf
, addressT value
));
561 int had_errors
PARAMS ((void));
562 int had_warnings
PARAMS ((void));
564 void print_version_id
PARAMS ((void));
565 char *app_push
PARAMS ((void));
566 char *atof_ieee
PARAMS ((char *str
, int what_kind
, LITTLENUM_TYPE
* words
));
567 char *input_scrub_include_file
PARAMS ((char *filename
, char *position
));
568 extern void input_scrub_insert_line
PARAMS((const char *line
));
569 extern void input_scrub_insert_file
PARAMS((char *path
));
570 char *input_scrub_new_file
PARAMS ((char *filename
));
571 char *input_scrub_next_buffer
PARAMS ((char **bufp
));
572 int do_scrub_chars
PARAMS ((int (*get
) (char *, int), char *to
, int tolen
));
573 int gen_to_words
PARAMS ((LITTLENUM_TYPE
* words
, int precision
,
574 long exponent_bits
));
575 int had_err
PARAMS ((void));
576 int ignore_input
PARAMS ((void));
577 void cond_finish_check
PARAMS ((int));
578 void cond_exit_macro
PARAMS ((int));
579 int seen_at_least_1_file
PARAMS ((void));
580 void app_pop
PARAMS ((char *arg
));
581 void as_howmuch
PARAMS ((FILE * stream
));
582 void as_perror
PARAMS ((const char *gripe
, const char *filename
));
583 void as_where
PARAMS ((char **namep
, unsigned int *linep
));
584 void bump_line_counters
PARAMS ((void));
585 void do_scrub_begin
PARAMS ((int));
586 void input_scrub_begin
PARAMS ((void));
587 void input_scrub_close
PARAMS ((void));
588 void input_scrub_end
PARAMS ((void));
589 int new_logical_line
PARAMS ((char *fname
, int line_number
));
590 void subsegs_begin
PARAMS ((void));
591 void subseg_change
PARAMS ((segT seg
, int subseg
));
592 segT subseg_new
PARAMS ((const char *name
, subsegT subseg
));
593 segT subseg_force_new
PARAMS ((const char *name
, subsegT subseg
));
594 void subseg_set
PARAMS ((segT seg
, subsegT subseg
));
596 segT subseg_get
PARAMS ((const char *, int));
598 int subseg_text_p
PARAMS ((segT
));
600 void start_dependencies
PARAMS ((char *));
601 void register_dependency
PARAMS ((char *));
602 void print_dependencies
PARAMS ((void));
606 typedef struct symbol symbolS
;
608 typedef struct frag fragS
;
612 valueT add_to_literal_pool
PARAMS ((symbolS
*, valueT
, segT
, int));
615 int check_eh_frame
PARAMS ((struct expressionS
*, unsigned int *));
616 int eh_frame_estimate_size_before_relax
PARAMS ((fragS
*));
617 int eh_frame_relax_frag
PARAMS ((fragS
*));
618 void eh_frame_convert_frag
PARAMS ((fragS
*));
620 #include "expr.h" /* Before targ-*.h */
622 /* this one starts the chain of target dependant headers */
623 #include "targ-env.h"
626 #include "struc-symbol.h"
638 #ifdef USE_EMULATIONS
644 /* True if we are assembling in m68k MRI mode. */
645 COMMON
int flag_m68k_mri
;
647 #define flag_m68k_mri 0
651 COMMON
int warn_comment
;
652 COMMON
unsigned int found_comment
;
653 COMMON
char *found_comment_file
;
656 #ifndef NUMBERS_WITH_SUFFIX
657 #define NUMBERS_WITH_SUFFIX 0
660 #ifndef LOCAL_LABELS_DOLLAR
661 #define LOCAL_LABELS_DOLLAR 0
664 #ifndef LOCAL_LABELS_FB
665 #define LOCAL_LABELS_FB 0
668 #ifndef LABELS_WITHOUT_COLONS
669 #define LABELS_WITHOUT_COLONS 0
672 #ifndef NO_PSEUDO_DOT
673 #define NO_PSEUDO_DOT 0
676 #ifndef TEXT_SECTION_NAME
677 #define TEXT_SECTION_NAME ".text"
678 #define DATA_SECTION_NAME ".data"
679 #define BSS_SECTION_NAME ".bss"
682 #ifndef OCTETS_PER_BYTE_POWER
683 #define OCTETS_PER_BYTE_POWER 0
685 #ifndef OCTETS_PER_BYTE
686 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
688 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
689 #error "Octets per byte conflicts with its power-of-two definition!"