1 /* as.h - global header file
2 Copyright 1987, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003
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 "". */
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 void* version for STDC case. This is to be compatible with
46 the declaration in bison.simple, used for m68k operand parsing.
48 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
55 /* Indented so that pre-ansi C compilers will ignore it, rather than
56 choke on it. Some versions of AIX require this to be the first
60 # ifndef alloca /* predefined by HP cc +Olibcalls */
61 # if !defined (__STDC__) && !defined (__hpux)
62 extern char *alloca ();
64 extern void *alloca ();
65 # endif /* __STDC__, __hpux */
68 # endif /* HAVE_ALLOCA_H */
71 /* Now, tend to the rest of the configuration. */
73 /* System include files first... */
88 #ifdef HAVE_SYS_TYPES_H
89 /* for size_t, pid_t */
90 #include <sys/types.h>
94 /* The first getopt value for machine-independent long options.
95 150 isn't special; it's just an arbitrary non-ASCII char value. */
96 #define OPTION_STD_BASE 150
97 /* The first getopt value for machine-dependent long options.
98 190 gives the standard options room to grow. */
99 #define OPTION_MD_BASE 190
104 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
105 #define __PRETTY_FUNCTION__ ((char*)0)
107 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
109 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
111 /* Now GNU header files... */
112 #include "ansidecl.h"
116 #include "libiberty.h"
118 /* Define the standard progress macros. */
119 #include "progress.h"
121 /* This doesn't get taken care of anywhere. */
122 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
123 #if !defined (__GNUC__) && !defined (inline)
126 #endif /* !__MWERKS__ */
128 /* Other stuff from config.h. */
129 #ifdef NEED_DECLARATION_STRSTR
130 extern char *strstr ();
132 #ifdef NEED_DECLARATION_MALLOC
133 extern PTR malloc ();
134 extern PTR realloc ();
136 #ifdef NEED_DECLARATION_FREE
139 #ifdef NEED_DECLARATION_ERRNO
142 #ifdef NEED_DECLARATION_ENVIRON
143 extern char **environ;
146 /* This is needed for VMS. */
147 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
148 #define unlink remove
151 /* Hack to make "gcc -Wall" not complain about obstack macros. */
152 #if !defined (memcpy) && !defined (bcopy)
153 #define bcopy(src,dest,size) memcpy (dest, src, size)
156 /* Make Saber happier on obstack.h. */
159 #define __PTR_TO_INT(P) ((int) (P))
161 #define __INT_TO_PTR(P) ((char *) (P))
165 #define __LINE__ "unknown"
166 #endif /* __LINE__ */
169 #define __FILE__ "unknown"
170 #endif /* __FILE__ */
173 #if defined GO32 || defined __MINGW32__
174 #include "fopen-bin.h"
176 #include "fopen-same.h"
181 #define EXIT_SUCCESS 0
182 #define EXIT_FAILURE 1
189 #define obstack_chunk_alloc xmalloc
190 #define obstack_chunk_free xfree
196 #define BAD_CASE(val) \
198 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
199 (long) val, __LINE__, __FILE__); \
204 /* These are assembler-wide concepts */
207 extern bfd *stdoutput;
208 typedef bfd_vma addressT;
209 typedef bfd_signed_vma offsetT;
211 typedef unsigned long addressT;
212 typedef long offsetT;
215 /* Type of symbol value, etc. For use in prototypes. */
216 typedef addressT valueT;
220 #define COMMON /* Declare our COMMONs storage here. */
222 #define COMMON extern /* Our commons live elsewhere. */
225 /* COMMON now defined */
229 #define know(p) assert(p) /* Verify our assumptions! */
230 #endif /* not yet defined */
232 #define know(p) /* know() checks are no-op.ed */
237 /* Supplies sanitised buffers to read.c.
238 Also understands printing line-number part of error messages. */
240 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
242 #ifndef BFD_ASSEMBLER
246 #define N_SEGMENTS 40
247 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
248 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
249 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
250 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
251 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
252 #define SEG_TEXT SEG_E0
253 #define SEG_DATA SEG_E1
254 #define SEG_BSS SEG_E2
255 #define SEG_LAST SEG_E39
258 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
259 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
267 SEG_GOOF, /* Only happens if AS has a logic error. */
268 /* Invented so we don't crash printing
269 error message involving weird segment. */
270 SEG_EXPR, /* Intermediate expression values. */
271 SEG_DEBUG, /* Debug segment */
272 SEG_NTV, /* Transfert vector preload segment. */
273 SEG_PTV, /* Transfert vector postload segment. */
274 SEG_REGISTER /* Mythical: a register-valued expression. */
277 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
279 typedef asection *segT;
280 #define SEG_NORMAL(SEG) ( (SEG) != absolute_section \
281 && (SEG) != undefined_section \
282 && (SEG) != reg_section \
283 && (SEG) != expr_section)
287 /* What subseg we are accessing now? */
288 COMMON subsegT now_subseg;
290 /* Segment our instructions emit to. */
294 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
296 extern char const *const seg_name[];
297 #define segment_name(SEG) seg_name[(int) (SEG)]
300 #ifndef BFD_ASSEMBLER
301 extern int section_alignment[];
305 extern segT reg_section, expr_section;
306 /* Shouldn't these be eliminated someday? */
307 extern segT text_section, data_section, bss_section;
308 #define absolute_section bfd_abs_section_ptr
309 #define undefined_section bfd_und_section_ptr
311 #define reg_section SEG_REGISTER
312 #define expr_section SEG_EXPR
313 #define text_section SEG_TEXT
314 #define data_section SEG_DATA
315 #define bss_section SEG_BSS
316 #define absolute_section SEG_ABSOLUTE
317 #define undefined_section SEG_UNKNOWN
323 /* Variable chars to be repeated fr_offset times.
324 Fr_symbol unused. Used with fr_offset == 0 for a
325 constant length frag. */
328 /* Align. The fr_offset field holds the power of 2 to which to
329 align. The fr_var field holds the number of characters in the
330 fill pattern. The fr_subtype field holds the maximum number of
331 bytes to skip when aligning, or 0 if there is no maximum. */
334 /* Align code. The fr_offset field holds the power of 2 to which
335 to align. This type is only generated by machine specific
336 code, which is normally responsible for handling the fill
337 pattern. The fr_subtype field holds the maximum number of
338 bytes to skip when aligning, or 0 if there is no maximum. */
341 /* Test for alignment. Like rs_align, but used by several targets
342 to warn if data is not properly aligned. */
345 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
349 #ifndef WORKING_DOT_WORD
354 /* Machine specific relaxable (or similarly alterable) instruction. */
355 rs_machine_dependent,
357 /* .space directive with expression operand that needs to be computed
358 later. Similar to rs_org, but different.
360 1 variable char: fill character */
363 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
364 unsigned, 1 for signed. */
367 /* Exception frame information which we may be able to optimize. */
370 /* Cross-fragment dwarf2 line number optimization. */
374 typedef enum _relax_state relax_stateT;
376 /* This type is used in prototypes, so it can't be a type that will be
377 widened for argument passing. */
378 typedef unsigned int relax_substateT;
380 /* Enough bits for address, but still an integer type.
381 Could be a problem, cross-assembling for 64-bit machines. */
382 typedef addressT relax_addressT;
384 /* main program "as.c" (command arguments etc). */
386 COMMON unsigned char flag_no_comments; /* -f */
387 COMMON unsigned char flag_debug; /* -D */
388 COMMON unsigned char flag_signed_overflow_ok; /* -J */
389 #ifndef WORKING_DOT_WORD
390 COMMON unsigned char flag_warn_displacement; /* -K */
393 /* True if local symbols should be retained. */
394 COMMON int flag_keep_locals; /* -L */
396 /* True if we are assembling in MRI mode. */
399 /* Should the data section be made read-only and appended to the text
401 COMMON unsigned char flag_readonly_data_in_text; /* -R */
403 /* True if warnings should be inhibited. */
404 COMMON int flag_no_warnings; /* -W */
406 /* True if warnings count as errors. */
407 COMMON int flag_fatal_warnings; /* --fatal-warnings */
409 /* True if we should attempt to generate output even if non-fatal errors
411 COMMON unsigned char flag_always_generate_output; /* -Z */
413 /* This is true if the assembler should output time and space usage. */
414 COMMON unsigned char flag_print_statistics;
416 /* True if local absolute symbols are to be stripped. */
417 COMMON int flag_strip_local_absolute;
419 /* True if we should generate a traditional format object file. */
420 COMMON int flag_traditional_format;
422 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
423 COMMON int flag_execstack;
425 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
426 COMMON int flag_noexecstack;
428 /* name of emitted object file */
429 COMMON char *out_file_name;
431 /* name of file defining extensions to the basic instruction set */
432 COMMON char *insttbl_file_name;
434 /* TRUE if we need a second pass. */
435 COMMON int need_pass_2;
437 /* TRUE if we should do no relaxing, and
438 leave lots of padding. */
439 COMMON int linkrelax;
441 /* TRUE if we should produce a listing. */
444 /* Type of debugging information we should generate. We currently support
445 stabs, ECOFF, and DWARF2.
447 NOTE! This means debug information about the assembly source code itself
448 and _not_ about possible debug information from a high-level language.
449 This is especially relevant to DWARF2, since the compiler may emit line
450 number directives that the assembler resolves. */
462 extern enum debug_info_type debug_type;
463 extern int use_gnu_debug_info_extensions;
465 /* Maximum level of macro nesting. */
466 extern int max_macro_nest;
468 /* Verbosity level. */
471 /* Obstack chunk size. Keep large for efficient space use, make small to
472 increase malloc calls for monitoring memory allocation. */
473 extern int chunksize;
477 /* assembler mnemonic, lower case, no '.' */
478 const char *poc_name;
480 void (*poc_handler) (int);
481 /* Value to pass to handler */
485 typedef struct _pseudo_type pseudo_typeS;
487 /* Prefer varargs for non-ANSI compiler, since some will barf if the
488 ellipsis definition is used with a no-arguments declaration. */
489 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
493 #if defined (HAVE_STDARG_H)
496 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
501 #if (__GNUC__ >= 2) && !defined(VMS)
502 /* for use with -Wformat */
504 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
505 /* Support for double underscores in attribute names was added in gcc
506 2.6, so avoid them if we are using an earlier version. */
507 #define __printf__ printf
508 #define __format__ format
511 #define PRINTF_LIKE(FCN) \
512 void FCN (const char *format, ...) \
513 __attribute__ ((__format__ (__printf__, 1, 2)))
514 #define PRINTF_WHERE_LIKE(FCN) \
515 void FCN (char *file, unsigned int line, const char *format, ...) \
516 __attribute__ ((__format__ (__printf__, 3, 4)))
518 #else /* __GNUC__ < 2 || defined(VMS) */
520 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
521 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, \
523 const char *format, ...)
525 #endif /* __GNUC__ < 2 || defined(VMS) */
527 #else /* ! USE_STDARG */
529 #define PRINTF_LIKE(FCN) void FCN ()
530 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
532 #endif /* ! USE_STDARG */
534 PRINTF_LIKE (as_bad);
535 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
536 PRINTF_LIKE (as_tsktsk);
537 PRINTF_LIKE (as_warn);
538 PRINTF_WHERE_LIKE (as_bad_where);
539 PRINTF_WHERE_LIKE (as_warn_where);
541 void as_assert (const char *, int, const char *);
542 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
543 void fprint_value (FILE *, addressT);
544 void sprint_value (char *, addressT);
545 int had_errors (void);
546 int had_warnings (void);
547 void as_warn_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
548 void as_bad_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
549 void print_version_id (void);
550 char * app_push (void);
551 char * atof_ieee (char *, int, LITTLENUM_TYPE *);
552 char * input_scrub_include_file (char *, char *);
553 void input_scrub_insert_line (const char *);
554 void input_scrub_insert_file (char *);
555 char * input_scrub_new_file (char *);
556 char * input_scrub_next_buffer (char **bufp);
557 int do_scrub_chars (int (*get) (char *, int), char *, int);
558 int gen_to_words (LITTLENUM_TYPE *, int, long);
560 int ignore_input (void);
561 void cond_finish_check (int);
562 void cond_exit_macro (int);
563 int seen_at_least_1_file (void);
564 void app_pop (char *);
565 void as_howmuch (FILE *);
566 void as_perror (const char *, const char *);
567 void as_where (char **, unsigned int *);
568 void bump_line_counters (void);
569 void do_scrub_begin (int);
570 void input_scrub_begin (void);
571 void input_scrub_close (void);
572 void input_scrub_end (void);
573 int new_logical_line (char *, int);
574 void subsegs_begin (void);
575 void subseg_change (segT, int);
576 segT subseg_new (const char *, subsegT);
577 segT subseg_force_new (const char *, subsegT);
578 void subseg_set (segT, subsegT);
579 int subseg_text_p (segT);
580 bfd_boolean seg_not_empty_p (segT);
581 void start_dependencies (char *);
582 void register_dependency (char *);
583 void print_dependencies (void);
585 segT subseg_get (const char *, int);
590 typedef struct symbol symbolS;
592 typedef struct frag fragS;
596 valueT add_to_literal_pool (symbolS *, valueT, segT, int);
599 int check_eh_frame (struct expressionS *, unsigned int *);
600 int eh_frame_estimate_size_before_relax (fragS *);
601 int eh_frame_relax_frag (fragS *);
602 void eh_frame_convert_frag (fragS *);
603 int generic_force_reloc (struct fix *);
605 #include "expr.h" /* Before targ-*.h */
607 /* This one starts the chain of target dependant headers. */
608 #include "targ-env.h"
611 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
629 #ifdef USE_EMULATIONS
635 /* True if we are assembling in m68k MRI mode. */
636 COMMON int flag_m68k_mri;
638 #define flag_m68k_mri 0
642 COMMON int warn_comment;
643 COMMON unsigned int found_comment;
644 COMMON char * found_comment_file;
647 #ifndef NUMBERS_WITH_SUFFIX
648 #define NUMBERS_WITH_SUFFIX 0
651 #ifndef LOCAL_LABELS_DOLLAR
652 #define LOCAL_LABELS_DOLLAR 0
655 #ifndef LOCAL_LABELS_FB
656 #define LOCAL_LABELS_FB 0
659 #ifndef LABELS_WITHOUT_COLONS
660 #define LABELS_WITHOUT_COLONS 0
663 #ifndef NO_PSEUDO_DOT
664 #define NO_PSEUDO_DOT 0
667 #ifndef TEXT_SECTION_NAME
668 #define TEXT_SECTION_NAME ".text"
669 #define DATA_SECTION_NAME ".data"
670 #define BSS_SECTION_NAME ".bss"
673 #ifndef OCTETS_PER_BYTE_POWER
674 #define OCTETS_PER_BYTE_POWER 0
676 #ifndef OCTETS_PER_BYTE
677 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
679 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
680 #error "Octets per byte conflicts with its power-of-two definition!"