1 /* as.h - global header file
2 Copyright 1987, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 Free Software Foundation, Inc.
6 This file is part of GAS, the GNU Assembler.
8 GAS is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GAS is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GAS; see the file COPYING. If not, write to the Free
20 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 "".
43 /* This is the code recommended in the autoconf documentation, almost
44 verbatim. If it doesn't work for you, let me know, and notify
45 djm@gnu.ai.mit.edu as well. */
46 /* Added #undef for DJ Delorie. The right fix is to ensure that as.h
47 is included first, before even any system header files, in all files
48 that use it. KR 1994.11.03 */
49 /* Added void* version for STDC case. This is to be compatible with
50 the declaration in bison.simple, used for m68k operand parsing.
52 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
54 /* AIX requires this to be the first thing in the file. */
58 extern void *alloca ();
60 extern char *alloca ();
70 # ifndef alloca /* predefined by HP cc +Olibcalls */
71 # if !defined (__STDC__) && !defined (__hpux)
72 extern char *alloca ();
74 extern void *alloca ();
75 # endif /* __STDC__, __hpux */
78 # endif /* HAVE_ALLOCA_H */
81 /* Now, tend to the rest of the configuration. */
83 /* System include files first... */
99 #ifdef HAVE_SYS_TYPES_H
100 /* for size_t, pid_t */
101 #include <sys/types.h>
105 /* The first getopt value for machine-independent long options.
106 150 isn't special; it's just an arbitrary non-ASCII char value. */
107 #define OPTION_STD_BASE 150
108 /* The first getopt value for machine-dependent long options.
109 190 gives the standard options room to grow. */
110 #define OPTION_MD_BASE 190
115 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
116 #define __PRETTY_FUNCTION__ ((char*)0)
120 /* Handle lossage with assert.h. */
121 #ifndef BROKEN_ASSERT
123 #else /* BROKEN_ASSERT */
125 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
127 #define assert(p) ((p), 0)
129 #endif /* BROKEN_ASSERT */
133 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
135 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
139 /* Now GNU header files... */
140 #include "ansidecl.h"
144 #include "libiberty.h"
146 /* Define the standard progress macros. */
147 #include "progress.h"
149 /* This doesn't get taken care of anywhere. */
150 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
151 #if !defined (__GNUC__) && !defined (inline)
154 #endif /* !__MWERKS__ */
156 /* Other stuff from config.h. */
157 #ifdef NEED_DECLARATION_STRSTR
158 extern char *strstr ();
160 #ifdef NEED_DECLARATION_MALLOC
161 extern PTR
malloc ();
162 extern PTR
realloc ();
164 #ifdef NEED_DECLARATION_FREE
167 #ifdef NEED_DECLARATION_ERRNO
170 #ifdef NEED_DECLARATION_ENVIRON
171 extern char **environ
;
174 /* This is needed for VMS. */
175 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
176 #define unlink remove
179 /* Hack to make "gcc -Wall" not complain about obstack macros. */
180 #if !defined (memcpy) && !defined (bcopy)
181 #define bcopy(src,dest,size) memcpy(dest,src,size)
184 /* Make Saber happier on obstack.h. */
187 #define __PTR_TO_INT(P) ((int) (P))
189 #define __INT_TO_PTR(P) ((char *) (P))
193 #define __LINE__ "unknown"
194 #endif /* __LINE__ */
197 #define __FILE__ "unknown"
198 #endif /* __FILE__ */
202 #include "fopen-bin.h"
204 #include "fopen-same.h"
209 #define EXIT_SUCCESS 0
210 #define EXIT_FAILURE 1
217 #define obstack_chunk_alloc xmalloc
218 #define obstack_chunk_free xfree
224 #define BAD_CASE(val) \
226 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
227 (long) val, __LINE__, __FILE__); \
232 /* These are assembler-wide concepts */
235 extern bfd
*stdoutput
;
236 typedef bfd_vma addressT
;
237 typedef bfd_signed_vma offsetT
;
239 typedef unsigned long addressT
;
240 typedef long offsetT
;
243 /* Type of symbol value, etc. For use in prototypes. */
244 typedef addressT valueT
;
248 #define COMMON /* declare our COMMONs storage here. */
250 #define COMMON extern /* our commons live elswhere */
253 /* COMMON now defined */
257 #define know(p) assert(p) /* Verify our assumptions! */
258 #endif /* not yet defined */
260 #define know(p) /* know() checks are no-op.ed */
265 /* Supplies sanitised buffers to read.c.
266 Also understands printing line-number part of error messages. */
268 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
270 #ifndef BFD_ASSEMBLER
274 #define N_SEGMENTS 40
275 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
276 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
277 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
278 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
279 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
280 #define SEG_TEXT SEG_E0
281 #define SEG_DATA SEG_E1
282 #define SEG_BSS SEG_E2
283 #define SEG_LAST SEG_E39
286 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
287 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
294 SEG_GOOF
, /* Only happens if AS has a logic error. */
295 /* Invented so we don't crash printing */
296 /* error message involving weird segment. */
297 SEG_EXPR
, /* Intermediate expression values. */
298 SEG_DEBUG
, /* Debug segment */
299 SEG_NTV
, /* Transfert vector preload segment */
300 SEG_PTV
, /* Transfert vector postload segment */
301 SEG_REGISTER
/* Mythical: a register-valued expression */
304 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
306 typedef asection
*segT
;
307 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
308 && (SEG) != undefined_section \
309 && (SEG) != reg_section \
310 && (SEG) != expr_section)
314 /* What subseg we are accreting now? */
315 COMMON subsegT now_subseg
;
317 /* Segment our instructions emit to. */
321 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
323 extern char const *const seg_name
[];
324 #define segment_name(SEG) seg_name[(int) (SEG)]
327 #ifndef BFD_ASSEMBLER
328 extern int section_alignment
[];
332 extern segT reg_section
, expr_section
;
333 /* Shouldn't these be eliminated someday? */
334 extern segT text_section
, data_section
, bss_section
;
335 #define absolute_section bfd_abs_section_ptr
336 #define undefined_section bfd_und_section_ptr
338 #define reg_section SEG_REGISTER
339 #define expr_section SEG_EXPR
340 #define text_section SEG_TEXT
341 #define data_section SEG_DATA
342 #define bss_section SEG_BSS
343 #define absolute_section SEG_ABSOLUTE
344 #define undefined_section SEG_UNKNOWN
350 /* Variable chars to be repeated fr_offset times.
351 Fr_symbol unused. Used with fr_offset == 0 for a
352 constant length frag. */
355 /* Align. The fr_offset field holds the power of 2 to which to
356 align. The fr_var field holds the number of characters in the
357 fill pattern. The fr_subtype field holds the maximum number of
358 bytes to skip when aligning, or 0 if there is no maximum. */
361 /* Align code. The fr_offset field holds the power of 2 to which
362 to align. This type is only generated by machine specific
363 code, which is normally responsible for handling the fill
364 pattern. The fr_subtype field holds the maximum number of
365 bytes to skip when aligning, or 0 if there is no maximum. */
368 /* Test for alignment. Like rs_align, but used by several targets
369 to warn if data is not properly aligned. */
372 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
376 #ifndef WORKING_DOT_WORD
381 /* machine-specific relaxable (or similarly alterable) instruction */
382 rs_machine_dependent
,
384 /* .space directive with expression operand that needs to be computed
385 later. Similar to rs_org, but different.
387 1 variable char: fill character */
390 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
391 unsigned, 1 for signed. */
394 /* Exception frame information which we may be able to optimize. */
397 /* Cross-fragment dwarf2 line number optimization. */
401 typedef enum _relax_state relax_stateT
;
403 /* This type is used in prototypes, so it can't be a type that will be
404 widened for argument passing. */
405 typedef unsigned int relax_substateT
;
407 /* Enough bits for address, but still an integer type.
408 Could be a problem, cross-assembling for 64-bit machines. */
409 typedef addressT relax_addressT
;
411 /* main program "as.c" (command arguments etc) */
413 COMMON
unsigned char flag_no_comments
; /* -f */
414 COMMON
unsigned char flag_debug
; /* -D */
415 COMMON
unsigned char flag_signed_overflow_ok
; /* -J */
416 #ifndef WORKING_DOT_WORD
417 COMMON
unsigned char flag_warn_displacement
; /* -K */
420 /* True if local symbols should be retained. */
421 COMMON
int flag_keep_locals
; /* -L */
423 /* True if we are assembling in MRI mode. */
426 /* Should the data section be made read-only and appended to the text
428 COMMON
unsigned char flag_readonly_data_in_text
; /* -R */
430 /* True if warnings should be inhibited. */
431 COMMON
int flag_no_warnings
; /* -W */
433 /* True if warnings count as errors. */
434 COMMON
int flag_fatal_warnings
; /* --fatal-warnings */
436 /* True if we should attempt to generate output even if non-fatal errors
438 COMMON
unsigned char flag_always_generate_output
; /* -Z */
440 /* This is true if the assembler should output time and space usage. */
441 COMMON
unsigned char flag_print_statistics
;
443 /* True if local absolute symbols are to be stripped. */
444 COMMON
int flag_strip_local_absolute
;
446 /* True if we should generate a traditional format object file. */
447 COMMON
int flag_traditional_format
;
449 /* name of emitted object file */
450 COMMON
char *out_file_name
;
452 /* name of file defining extensions to the basic instruction set */
453 COMMON
char *insttbl_file_name
;
455 /* TRUE if we need a second pass. */
456 COMMON
int need_pass_2
;
458 /* TRUE if we should do no relaxing, and
459 leave lots of padding. */
460 COMMON
int linkrelax
;
462 /* TRUE if we should produce a listing. */
465 /* Type of debugging information we should generate. We currently support
466 stabs, ECOFF, and DWARF2.
468 NOTE! This means debug information about the assembly source code itself
469 and _not_ about possible debug information from a high-level language.
470 This is especially relevant to DWARF2, since the compiler may emit line
471 number directives that the assembler resolves. */
473 enum debug_info_type
{
482 extern enum debug_info_type debug_type
;
484 /* Maximum level of macro nesting. */
485 extern int max_macro_nest
;
487 /* Obstack chunk size. Keep large for efficient space use, make small to
488 increase malloc calls for monitoring memory allocation. */
489 extern int chunksize
;
491 struct _pseudo_type
{
492 /* assembler mnemonic, lower case, no '.' */
493 const char *poc_name
;
495 void (*poc_handler
) PARAMS ((int));
496 /* Value to pass to handler */
500 typedef struct _pseudo_type pseudo_typeS
;
502 /* Prefer varargs for non-ANSI compiler, since some will barf if the
503 ellipsis definition is used with a no-arguments declaration. */
504 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
508 #if defined (HAVE_STDARG_H)
511 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
516 #if (__GNUC__ >= 2) && !defined(VMS)
517 /* for use with -Wformat */
519 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
520 /* Support for double underscores in attribute names was added in gcc
521 2.6, so avoid them if we are using an earlier version. */
522 #define __printf__ printf
523 #define __format__ format
526 #define PRINTF_LIKE(FCN) \
527 void FCN (const char *format, ...) \
528 __attribute__ ((__format__ (__printf__, 1, 2)))
529 #define PRINTF_WHERE_LIKE(FCN) \
530 void FCN (char *file, unsigned int line, const char *format, ...) \
531 __attribute__ ((__format__ (__printf__, 3, 4)))
533 #else /* __GNUC__ < 2 || defined(VMS) */
535 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
536 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
538 const char *format, ...))
540 #endif /* __GNUC__ < 2 || defined(VMS) */
542 #else /* ! USE_STDARG */
544 #define PRINTF_LIKE(FCN) void FCN ()
545 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
547 #endif /* ! USE_STDARG */
549 PRINTF_LIKE (as_bad
);
550 PRINTF_LIKE (as_fatal
) ATTRIBUTE_NORETURN
;
551 PRINTF_LIKE (as_tsktsk
);
552 PRINTF_LIKE (as_warn
);
553 PRINTF_WHERE_LIKE (as_bad_where
);
554 PRINTF_WHERE_LIKE (as_warn_where
);
556 void as_assert
PARAMS ((const char *, int, const char *));
557 void as_abort
PARAMS ((const char *, int, const char *)) ATTRIBUTE_NORETURN
;
559 void fprint_value
PARAMS ((FILE *file
, addressT value
));
560 void sprint_value
PARAMS ((char *buf
, addressT value
));
562 int had_errors
PARAMS ((void));
563 int had_warnings
PARAMS ((void));
565 void print_version_id
PARAMS ((void));
566 char *app_push
PARAMS ((void));
567 char *atof_ieee
PARAMS ((char *str
, int what_kind
, LITTLENUM_TYPE
* words
));
568 char *input_scrub_include_file
PARAMS ((char *filename
, char *position
));
569 extern void input_scrub_insert_line
PARAMS((const char *line
));
570 extern void input_scrub_insert_file
PARAMS((char *path
));
571 char *input_scrub_new_file
PARAMS ((char *filename
));
572 char *input_scrub_next_buffer
PARAMS ((char **bufp
));
573 int do_scrub_chars
PARAMS ((int (*get
) (char *, int), char *to
, int tolen
));
574 int gen_to_words
PARAMS ((LITTLENUM_TYPE
* words
, int precision
,
575 long exponent_bits
));
576 int had_err
PARAMS ((void));
577 int ignore_input
PARAMS ((void));
578 void cond_finish_check
PARAMS ((int));
579 void cond_exit_macro
PARAMS ((int));
580 int seen_at_least_1_file
PARAMS ((void));
581 void app_pop
PARAMS ((char *arg
));
582 void as_howmuch
PARAMS ((FILE * stream
));
583 void as_perror
PARAMS ((const char *gripe
, const char *filename
));
584 void as_where
PARAMS ((char **namep
, unsigned int *linep
));
585 void bump_line_counters
PARAMS ((void));
586 void do_scrub_begin
PARAMS ((int));
587 void input_scrub_begin
PARAMS ((void));
588 void input_scrub_close
PARAMS ((void));
589 void input_scrub_end
PARAMS ((void));
590 int new_logical_line
PARAMS ((char *fname
, int line_number
));
591 void subsegs_begin
PARAMS ((void));
592 void subseg_change
PARAMS ((segT seg
, int subseg
));
593 segT subseg_new
PARAMS ((const char *name
, subsegT subseg
));
594 segT subseg_force_new
PARAMS ((const char *name
, subsegT subseg
));
595 void subseg_set
PARAMS ((segT seg
, subsegT subseg
));
597 segT subseg_get
PARAMS ((const char *, int));
599 int subseg_text_p
PARAMS ((segT
));
601 void start_dependencies
PARAMS ((char *));
602 void register_dependency
PARAMS ((char *));
603 void print_dependencies
PARAMS ((void));
607 typedef struct symbol symbolS
;
609 typedef struct frag fragS
;
613 valueT add_to_literal_pool
PARAMS ((symbolS
*, valueT
, segT
, int));
616 int check_eh_frame
PARAMS ((struct expressionS
*, unsigned int *));
617 int eh_frame_estimate_size_before_relax
PARAMS ((fragS
*));
618 int eh_frame_relax_frag
PARAMS ((fragS
*));
619 void eh_frame_convert_frag
PARAMS ((fragS
*));
621 #include "expr.h" /* Before targ-*.h */
623 /* this one starts the chain of target dependant headers */
624 #include "targ-env.h"
627 #include "struc-symbol.h"
639 #ifdef USE_EMULATIONS
645 /* True if we are assembling in m68k MRI mode. */
646 COMMON
int flag_m68k_mri
;
648 #define flag_m68k_mri 0
652 COMMON
int warn_comment
;
653 COMMON
unsigned int found_comment
;
654 COMMON
char *found_comment_file
;
657 #ifndef NUMBERS_WITH_SUFFIX
658 #define NUMBERS_WITH_SUFFIX 0
661 #ifndef LOCAL_LABELS_DOLLAR
662 #define LOCAL_LABELS_DOLLAR 0
665 #ifndef LOCAL_LABELS_FB
666 #define LOCAL_LABELS_FB 0
669 #ifndef LABELS_WITHOUT_COLONS
670 #define LABELS_WITHOUT_COLONS 0
673 #ifndef NO_PSEUDO_DOT
674 #define NO_PSEUDO_DOT 0
677 #ifndef TEXT_SECTION_NAME
678 #define TEXT_SECTION_NAME ".text"
679 #define DATA_SECTION_NAME ".data"
680 #define BSS_SECTION_NAME ".bss"
683 #ifndef OCTETS_PER_BYTE_POWER
684 #define OCTETS_PER_BYTE_POWER 0
686 #ifndef OCTETS_PER_BYTE
687 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
689 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
690 #error "Octets per byte conflicts with its power-of-two definition!"