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 void* version for STDC case. This is to be compatible with
47 the declaration in bison.simple, used for m68k operand parsing.
49 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
56 /* Indented so that pre-ansi C compilers will ignore it, rather than
57 choke on it. Some versions of AIX require this to be the first
61 # ifndef alloca /* predefined by HP cc +Olibcalls */
62 # if !defined (__STDC__) && !defined (__hpux)
63 extern char *alloca ();
65 extern void *alloca ();
66 # endif /* __STDC__, __hpux */
69 # endif /* HAVE_ALLOCA_H */
72 /* Now, tend to the rest of the configuration. */
74 /* System include files first... */
90 #ifdef HAVE_SYS_TYPES_H
91 /* for size_t, pid_t */
92 #include <sys/types.h>
96 /* The first getopt value for machine-independent long options.
97 150 isn't special; it's just an arbitrary non-ASCII char value. */
98 #define OPTION_STD_BASE 150
99 /* The first getopt value for machine-dependent long options.
100 190 gives the standard options room to grow. */
101 #define OPTION_MD_BASE 190
106 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
107 #define __PRETTY_FUNCTION__ ((char*)0)
111 /* Handle lossage with assert.h. */
112 #ifndef BROKEN_ASSERT
114 #else /* BROKEN_ASSERT */
116 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
118 #define assert(p) ((p), 0)
120 #endif /* BROKEN_ASSERT */
124 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
126 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
130 /* Now GNU header files... */
131 #include "ansidecl.h"
135 #include "libiberty.h"
137 /* Define the standard progress macros. */
138 #include "progress.h"
140 /* This doesn't get taken care of anywhere. */
141 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
142 #if !defined (__GNUC__) && !defined (inline)
145 #endif /* !__MWERKS__ */
147 /* Other stuff from config.h. */
148 #ifdef NEED_DECLARATION_STRSTR
149 extern char *strstr ();
151 #ifdef NEED_DECLARATION_MALLOC
152 extern PTR malloc ();
153 extern PTR realloc ();
155 #ifdef NEED_DECLARATION_FREE
158 #ifdef NEED_DECLARATION_ERRNO
161 #ifdef NEED_DECLARATION_ENVIRON
162 extern char **environ;
165 /* This is needed for VMS. */
166 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
167 #define unlink remove
170 /* Hack to make "gcc -Wall" not complain about obstack macros. */
171 #if !defined (memcpy) && !defined (bcopy)
172 #define bcopy(src,dest,size) memcpy(dest,src,size)
175 /* Make Saber happier on obstack.h. */
178 #define __PTR_TO_INT(P) ((int) (P))
180 #define __INT_TO_PTR(P) ((char *) (P))
184 #define __LINE__ "unknown"
185 #endif /* __LINE__ */
188 #define __FILE__ "unknown"
189 #endif /* __FILE__ */
193 #include "fopen-bin.h"
195 #include "fopen-same.h"
200 #define EXIT_SUCCESS 0
201 #define EXIT_FAILURE 1
208 #define obstack_chunk_alloc xmalloc
209 #define obstack_chunk_free xfree
215 #define BAD_CASE(val) \
217 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
218 (long) val, __LINE__, __FILE__); \
223 /* These are assembler-wide concepts */
226 extern bfd *stdoutput;
227 typedef bfd_vma addressT;
228 typedef bfd_signed_vma offsetT;
230 typedef unsigned long addressT;
231 typedef long offsetT;
234 /* Type of symbol value, etc. For use in prototypes. */
235 typedef addressT valueT;
239 #define COMMON /* declare our COMMONs storage here. */
241 #define COMMON extern /* our commons live elswhere */
244 /* COMMON now defined */
248 #define know(p) assert(p) /* Verify our assumptions! */
249 #endif /* not yet defined */
251 #define know(p) /* know() checks are no-op.ed */
256 /* Supplies sanitised buffers to read.c.
257 Also understands printing line-number part of error messages. */
259 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
261 #ifndef BFD_ASSEMBLER
265 #define N_SEGMENTS 40
266 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
267 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
268 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
269 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
270 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
271 #define SEG_TEXT SEG_E0
272 #define SEG_DATA SEG_E1
273 #define SEG_BSS SEG_E2
274 #define SEG_LAST SEG_E39
277 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
278 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
285 SEG_GOOF, /* Only happens if AS has a logic error. */
286 /* Invented so we don't crash printing */
287 /* error message involving weird segment. */
288 SEG_EXPR, /* Intermediate expression values. */
289 SEG_DEBUG, /* Debug segment */
290 SEG_NTV, /* Transfert vector preload segment */
291 SEG_PTV, /* Transfert vector postload segment */
292 SEG_REGISTER /* Mythical: a register-valued expression */
295 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
297 typedef asection *segT;
298 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
299 && (SEG) != undefined_section \
300 && (SEG) != reg_section \
301 && (SEG) != expr_section)
305 /* What subseg we are accreting now? */
306 COMMON subsegT now_subseg;
308 /* Segment our instructions emit to. */
312 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
314 extern char const *const seg_name[];
315 #define segment_name(SEG) seg_name[(int) (SEG)]
318 #ifndef BFD_ASSEMBLER
319 extern int section_alignment[];
323 extern segT reg_section, expr_section;
324 /* Shouldn't these be eliminated someday? */
325 extern segT text_section, data_section, bss_section;
326 #define absolute_section bfd_abs_section_ptr
327 #define undefined_section bfd_und_section_ptr
329 #define reg_section SEG_REGISTER
330 #define expr_section SEG_EXPR
331 #define text_section SEG_TEXT
332 #define data_section SEG_DATA
333 #define bss_section SEG_BSS
334 #define absolute_section SEG_ABSOLUTE
335 #define undefined_section SEG_UNKNOWN
341 /* Variable chars to be repeated fr_offset times.
342 Fr_symbol unused. Used with fr_offset == 0 for a
343 constant length frag. */
346 /* Align. The fr_offset field holds the power of 2 to which to
347 align. The fr_var field holds the number of characters in the
348 fill pattern. The fr_subtype field holds the maximum number of
349 bytes to skip when aligning, or 0 if there is no maximum. */
352 /* Align code. The fr_offset field holds the power of 2 to which
353 to align. This type is only generated by machine specific
354 code, which is normally responsible for handling the fill
355 pattern. The fr_subtype field holds the maximum number of
356 bytes to skip when aligning, or 0 if there is no maximum. */
359 /* Test for alignment. Like rs_align, but used by several targets
360 to warn if data is not properly aligned. */
363 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
367 #ifndef WORKING_DOT_WORD
372 /* machine-specific relaxable (or similarly alterable) instruction */
373 rs_machine_dependent,
375 /* .space directive with expression operand that needs to be computed
376 later. Similar to rs_org, but different.
378 1 variable char: fill character */
381 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
382 unsigned, 1 for signed. */
385 /* Exception frame information which we may be able to optimize. */
388 /* Cross-fragment dwarf2 line number optimization. */
392 typedef enum _relax_state relax_stateT;
394 /* This type is used in prototypes, so it can't be a type that will be
395 widened for argument passing. */
396 typedef unsigned int relax_substateT;
398 /* Enough bits for address, but still an integer type.
399 Could be a problem, cross-assembling for 64-bit machines. */
400 typedef addressT relax_addressT;
402 /* main program "as.c" (command arguments etc) */
404 COMMON unsigned char flag_no_comments; /* -f */
405 COMMON unsigned char flag_debug; /* -D */
406 COMMON unsigned char flag_signed_overflow_ok; /* -J */
407 #ifndef WORKING_DOT_WORD
408 COMMON unsigned char flag_warn_displacement; /* -K */
411 /* True if local symbols should be retained. */
412 COMMON int flag_keep_locals; /* -L */
414 /* True if we are assembling in MRI mode. */
417 /* Should the data section be made read-only and appended to the text
419 COMMON unsigned char flag_readonly_data_in_text; /* -R */
421 /* True if warnings should be inhibited. */
422 COMMON int flag_no_warnings; /* -W */
424 /* True if warnings count as errors. */
425 COMMON int flag_fatal_warnings; /* --fatal-warnings */
427 /* True if we should attempt to generate output even if non-fatal errors
429 COMMON unsigned char flag_always_generate_output; /* -Z */
431 /* This is true if the assembler should output time and space usage. */
432 COMMON unsigned char flag_print_statistics;
434 /* True if local absolute symbols are to be stripped. */
435 COMMON int flag_strip_local_absolute;
437 /* True if we should generate a traditional format object file. */
438 COMMON int flag_traditional_format;
440 /* name of emitted object file */
441 COMMON char *out_file_name;
443 /* name of file defining extensions to the basic instruction set */
444 COMMON char *insttbl_file_name;
446 /* TRUE if we need a second pass. */
447 COMMON int need_pass_2;
449 /* TRUE if we should do no relaxing, and
450 leave lots of padding. */
451 COMMON int linkrelax;
453 /* TRUE if we should produce a listing. */
456 /* Type of debugging information we should generate. We currently support
457 stabs, ECOFF, and DWARF2.
459 NOTE! This means debug information about the assembly source code itself
460 and _not_ about possible debug information from a high-level language.
461 This is especially relevant to DWARF2, since the compiler may emit line
462 number directives that the assembler resolves. */
464 enum debug_info_type {
473 extern enum debug_info_type debug_type;
475 /* Maximum level of macro nesting. */
476 extern int max_macro_nest;
478 /* Obstack chunk size. Keep large for efficient space use, make small to
479 increase malloc calls for monitoring memory allocation. */
480 extern int chunksize;
482 struct _pseudo_type {
483 /* assembler mnemonic, lower case, no '.' */
484 const char *poc_name;
486 void (*poc_handler) PARAMS ((int));
487 /* Value to pass to handler */
491 typedef struct _pseudo_type pseudo_typeS;
493 /* Prefer varargs for non-ANSI compiler, since some will barf if the
494 ellipsis definition is used with a no-arguments declaration. */
495 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
499 #if defined (HAVE_STDARG_H)
502 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
507 #if (__GNUC__ >= 2) && !defined(VMS)
508 /* for use with -Wformat */
510 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
511 /* Support for double underscores in attribute names was added in gcc
512 2.6, so avoid them if we are using an earlier version. */
513 #define __printf__ printf
514 #define __format__ format
517 #define PRINTF_LIKE(FCN) \
518 void FCN (const char *format, ...) \
519 __attribute__ ((__format__ (__printf__, 1, 2)))
520 #define PRINTF_WHERE_LIKE(FCN) \
521 void FCN (char *file, unsigned int line, const char *format, ...) \
522 __attribute__ ((__format__ (__printf__, 3, 4)))
524 #else /* __GNUC__ < 2 || defined(VMS) */
526 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
527 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
529 const char *format, ...))
531 #endif /* __GNUC__ < 2 || defined(VMS) */
533 #else /* ! USE_STDARG */
535 #define PRINTF_LIKE(FCN) void FCN ()
536 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
538 #endif /* ! USE_STDARG */
540 PRINTF_LIKE (as_bad);
541 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
542 PRINTF_LIKE (as_tsktsk);
543 PRINTF_LIKE (as_warn);
544 PRINTF_WHERE_LIKE (as_bad_where);
545 PRINTF_WHERE_LIKE (as_warn_where);
547 void as_assert PARAMS ((const char *, int, const char *));
548 void as_abort PARAMS ((const char *, int, const char *)) ATTRIBUTE_NORETURN;
550 void fprint_value PARAMS ((FILE *file, addressT value));
551 void sprint_value PARAMS ((char *buf, addressT value));
553 int had_errors PARAMS ((void));
554 int had_warnings PARAMS ((void));
556 void print_version_id PARAMS ((void));
557 char *app_push PARAMS ((void));
558 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
559 char *input_scrub_include_file PARAMS ((char *filename, char *position));
560 extern void input_scrub_insert_line PARAMS((const char *line));
561 extern void input_scrub_insert_file PARAMS((char *path));
562 char *input_scrub_new_file PARAMS ((char *filename));
563 char *input_scrub_next_buffer PARAMS ((char **bufp));
564 int do_scrub_chars PARAMS ((int (*get) (char *, int), char *to, int tolen));
565 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
566 long exponent_bits));
567 int had_err PARAMS ((void));
568 int ignore_input PARAMS ((void));
569 void cond_finish_check PARAMS ((int));
570 void cond_exit_macro PARAMS ((int));
571 int seen_at_least_1_file PARAMS ((void));
572 void app_pop PARAMS ((char *arg));
573 void as_howmuch PARAMS ((FILE * stream));
574 void as_perror PARAMS ((const char *gripe, const char *filename));
575 void as_where PARAMS ((char **namep, unsigned int *linep));
576 void bump_line_counters PARAMS ((void));
577 void do_scrub_begin PARAMS ((int));
578 void input_scrub_begin PARAMS ((void));
579 void input_scrub_close PARAMS ((void));
580 void input_scrub_end PARAMS ((void));
581 int new_logical_line PARAMS ((char *fname, int line_number));
582 void subsegs_begin PARAMS ((void));
583 void subseg_change PARAMS ((segT seg, int subseg));
584 segT subseg_new PARAMS ((const char *name, subsegT subseg));
585 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
586 void subseg_set PARAMS ((segT seg, subsegT subseg));
588 segT subseg_get PARAMS ((const char *, int));
590 int subseg_text_p PARAMS ((segT));
592 void start_dependencies PARAMS ((char *));
593 void register_dependency PARAMS ((char *));
594 void print_dependencies PARAMS ((void));
598 typedef struct symbol symbolS;
600 typedef struct frag fragS;
604 valueT add_to_literal_pool PARAMS ((symbolS *, valueT, segT, int));
607 int check_eh_frame PARAMS ((struct expressionS *, unsigned int *));
608 int eh_frame_estimate_size_before_relax PARAMS ((fragS *));
609 int eh_frame_relax_frag PARAMS ((fragS *));
610 void eh_frame_convert_frag PARAMS ((fragS *));
612 #include "expr.h" /* Before targ-*.h */
614 /* this one starts the chain of target dependant headers */
615 #include "targ-env.h"
618 #include "struc-symbol.h"
630 #ifdef USE_EMULATIONS
636 /* True if we are assembling in m68k MRI mode. */
637 COMMON int flag_m68k_mri;
639 #define flag_m68k_mri 0
643 COMMON int warn_comment;
644 COMMON unsigned int found_comment;
645 COMMON char *found_comment_file;
648 #ifndef NUMBERS_WITH_SUFFIX
649 #define NUMBERS_WITH_SUFFIX 0
652 #ifndef LOCAL_LABELS_DOLLAR
653 #define LOCAL_LABELS_DOLLAR 0
656 #ifndef LOCAL_LABELS_FB
657 #define LOCAL_LABELS_FB 0
660 #ifndef LABELS_WITHOUT_COLONS
661 #define LABELS_WITHOUT_COLONS 0
664 #ifndef NO_PSEUDO_DOT
665 #define NO_PSEUDO_DOT 0
668 #ifndef TEXT_SECTION_NAME
669 #define TEXT_SECTION_NAME ".text"
670 #define DATA_SECTION_NAME ".data"
671 #define BSS_SECTION_NAME ".bss"
674 #ifndef OCTETS_PER_BYTE_POWER
675 #define OCTETS_PER_BYTE_POWER 0
677 #ifndef OCTETS_PER_BYTE
678 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
680 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
681 #error "Octets per byte conflicts with its power-of-two definition!"