* config/tc-mips.h (mips_flush_pending_output): Delete.
[binutils.git] / gas / as.h
blob3c764f5573d6626fab9ea733c4d815152885cca5
1 /* as.h - global header file
2 Copyright 1987, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005
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)
11 any later version.
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
21 02111-1307, USA. */
23 #ifndef GAS
24 #define GAS 1
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
36 COMMON as "".
37 If TEST is #defined, then we are testing a module: #define COMMON as "". */
39 #include "config.h"
40 #include "bin-bugs.h"
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.
47 --KR 1995.08.08 */
48 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
50 #ifndef __GNUC__
51 # if HAVE_ALLOCA_H
52 # include <alloca.h>
53 # else
54 # ifdef _AIX
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
57 thing in the file. */
58 #pragma alloca
59 # else
60 # ifndef alloca /* predefined by HP cc +Olibcalls */
61 # if !defined (__STDC__) && !defined (__hpux)
62 extern char *alloca ();
63 # else
64 extern void *alloca ();
65 # endif /* __STDC__, __hpux */
66 # endif /* alloca */
67 # endif /* _AIX */
68 # endif /* HAVE_ALLOCA_H */
69 #endif /* __GNUC__ */
71 /* Now, tend to the rest of the configuration. */
73 /* System include files first... */
74 #include <stdio.h>
75 #ifdef HAVE_STRING_H
76 #include <string.h>
77 #else
78 #ifdef HAVE_STRINGS_H
79 #include <strings.h>
80 #endif
81 #endif
82 #ifdef HAVE_STDLIB_H
83 #include <stdlib.h>
84 #endif
85 #ifdef HAVE_UNISTD_H
86 #include <unistd.h>
87 #endif
88 #ifdef HAVE_SYS_TYPES_H
89 /* for size_t, pid_t */
90 #include <sys/types.h>
91 #endif
93 #include "getopt.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
101 #ifdef DEBUG
102 #undef NDEBUG
103 #endif
104 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
105 #define __PRETTY_FUNCTION__ ((char*)0)
106 #endif
107 #define assert(P) \
108 ((void) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0)))
109 #undef abort
110 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
112 /* Now GNU header files... */
113 #include "ansidecl.h"
114 #ifdef BFD_ASSEMBLER
115 #include "bfd.h"
116 #endif
117 #include "libiberty.h"
119 /* Define the standard progress macros. */
120 #include "progress.h"
122 /* This doesn't get taken care of anywhere. */
123 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
124 #if !defined (__GNUC__) && !defined (inline)
125 #define inline
126 #endif
127 #endif /* !__MWERKS__ */
129 /* Other stuff from config.h. */
130 #ifdef NEED_DECLARATION_STRSTR
131 extern char *strstr ();
132 #endif
133 #ifdef NEED_DECLARATION_MALLOC
134 extern PTR malloc ();
135 extern PTR realloc ();
136 #endif
137 #ifdef NEED_DECLARATION_FREE
138 extern void free ();
139 #endif
140 #ifdef NEED_DECLARATION_ERRNO
141 extern int errno;
142 #endif
143 #ifdef NEED_DECLARATION_ENVIRON
144 extern char **environ;
145 #endif
147 /* This is needed for VMS. */
148 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
149 #define unlink remove
150 #endif
152 /* Hack to make "gcc -Wall" not complain about obstack macros. */
153 #if !defined (memcpy) && !defined (bcopy)
154 #define bcopy(src,dest,size) memcpy (dest, src, size)
155 #endif
157 /* Make Saber happier on obstack.h. */
158 #ifdef SABER
159 #undef __PTR_TO_INT
160 #define __PTR_TO_INT(P) ((int) (P))
161 #undef __INT_TO_PTR
162 #define __INT_TO_PTR(P) ((char *) (P))
163 #endif
165 #ifndef __LINE__
166 #define __LINE__ "unknown"
167 #endif /* __LINE__ */
169 #ifndef __FILE__
170 #define __FILE__ "unknown"
171 #endif /* __FILE__ */
173 #ifndef FOPEN_WB
174 #if defined GO32 || defined __MINGW32__
175 #include "fopen-bin.h"
176 #else
177 #include "fopen-same.h"
178 #endif
179 #endif
181 #ifndef EXIT_SUCCESS
182 #define EXIT_SUCCESS 0
183 #define EXIT_FAILURE 1
184 #endif
186 #ifndef SEEK_SET
187 #define SEEK_SET 0
188 #endif
190 #define obstack_chunk_alloc xmalloc
191 #define obstack_chunk_free xfree
193 #define xfree free
195 #include "asintl.h"
197 #define BAD_CASE(val) \
199 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
200 (long) val, __LINE__, __FILE__); \
203 #include "flonum.h"
205 /* These are assembler-wide concepts */
207 #ifdef BFD_ASSEMBLER
208 extern bfd *stdoutput;
209 typedef bfd_vma addressT;
210 typedef bfd_signed_vma offsetT;
211 #else
212 typedef unsigned long addressT;
213 typedef long offsetT;
214 #endif
216 /* Type of symbol value, etc. For use in prototypes. */
217 typedef addressT valueT;
219 #ifndef COMMON
220 #ifdef TEST
221 #define COMMON /* Declare our COMMONs storage here. */
222 #else
223 #define COMMON extern /* Our commons live elsewhere. */
224 #endif
225 #endif
226 /* COMMON now defined */
228 #ifdef DEBUG
229 #ifndef know
230 #define know(p) assert(p) /* Verify our assumptions! */
231 #endif /* not yet defined */
232 #else
233 #define know(p) /* know() checks are no-op.ed */
234 #endif
236 /* input_scrub.c */
238 /* Supplies sanitised buffers to read.c.
239 Also understands printing line-number part of error messages. */
241 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
243 #ifndef BFD_ASSEMBLER
245 #ifdef MANY_SEGMENTS
246 #include "bfd.h"
247 #define N_SEGMENTS 40
248 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
249 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
250 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
251 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
252 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
253 #define SEG_TEXT SEG_E0
254 #define SEG_DATA SEG_E1
255 #define SEG_BSS SEG_E2
256 #define SEG_LAST SEG_E39
257 #else
258 #define N_SEGMENTS 3
259 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
260 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
261 #endif
263 typedef enum _segT
265 SEG_ABSOLUTE = 0,
266 SEG_LIST,
267 SEG_UNKNOWN,
268 SEG_GOOF, /* Only happens if AS has a logic error. */
269 /* Invented so we don't crash printing
270 error message involving weird segment. */
271 SEG_EXPR, /* Intermediate expression values. */
272 SEG_DEBUG, /* Debug segment */
273 SEG_NTV, /* Transfert vector preload segment. */
274 SEG_PTV, /* Transfert vector postload segment. */
275 SEG_REGISTER /* Mythical: a register-valued expression. */
276 } segT;
278 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
279 #else
280 typedef asection *segT;
281 #define SEG_NORMAL(SEG) ( (SEG) != absolute_section \
282 && (SEG) != undefined_section \
283 && (SEG) != reg_section \
284 && (SEG) != expr_section)
285 #endif
286 typedef int subsegT;
288 /* What subseg we are accessing now? */
289 COMMON subsegT now_subseg;
291 /* Segment our instructions emit to. */
292 COMMON segT now_seg;
294 #ifdef BFD_ASSEMBLER
295 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
296 #else
297 extern char const *const seg_name[];
298 #define segment_name(SEG) seg_name[(int) (SEG)]
299 #endif
301 #ifndef BFD_ASSEMBLER
302 extern int section_alignment[];
303 #endif
305 #ifdef BFD_ASSEMBLER
306 extern segT reg_section, expr_section;
307 /* Shouldn't these be eliminated someday? */
308 extern segT text_section, data_section, bss_section;
309 #define absolute_section bfd_abs_section_ptr
310 #define undefined_section bfd_und_section_ptr
311 #else
312 #define reg_section SEG_REGISTER
313 #define expr_section SEG_EXPR
314 #define text_section SEG_TEXT
315 #define data_section SEG_DATA
316 #define bss_section SEG_BSS
317 #define absolute_section SEG_ABSOLUTE
318 #define undefined_section SEG_UNKNOWN
319 #endif
322 enum _relax_state
324 /* Variable chars to be repeated fr_offset times.
325 Fr_symbol unused. Used with fr_offset == 0 for a
326 constant length frag. */
327 rs_fill = 1,
329 /* Align. The fr_offset field holds the power of 2 to which to
330 align. The fr_var field holds the number of characters in the
331 fill pattern. The fr_subtype field holds the maximum number of
332 bytes to skip when aligning, or 0 if there is no maximum. */
333 rs_align,
335 /* Align code. The fr_offset field holds the power of 2 to which
336 to align. This type is only generated by machine specific
337 code, which is normally responsible for handling the fill
338 pattern. The fr_subtype field holds the maximum number of
339 bytes to skip when aligning, or 0 if there is no maximum. */
340 rs_align_code,
342 /* Test for alignment. Like rs_align, but used by several targets
343 to warn if data is not properly aligned. */
344 rs_align_test,
346 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
347 character. */
348 rs_org,
350 #ifndef WORKING_DOT_WORD
351 /* JF: gunpoint */
352 rs_broken_word,
353 #endif
355 /* Machine specific relaxable (or similarly alterable) instruction. */
356 rs_machine_dependent,
358 /* .space directive with expression operand that needs to be computed
359 later. Similar to rs_org, but different.
360 fr_symbol: operand
361 1 variable char: fill character */
362 rs_space,
364 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
365 unsigned, 1 for signed. */
366 rs_leb128,
368 /* Exception frame information which we may be able to optimize. */
369 rs_cfa,
371 /* Cross-fragment dwarf2 line number optimization. */
372 rs_dwarf2dbg
375 typedef enum _relax_state relax_stateT;
377 /* This type is used in prototypes, so it can't be a type that will be
378 widened for argument passing. */
379 typedef unsigned int relax_substateT;
381 /* Enough bits for address, but still an integer type.
382 Could be a problem, cross-assembling for 64-bit machines. */
383 typedef addressT relax_addressT;
385 struct relax_type
387 /* Forward reach. Signed number. > 0. */
388 offsetT rlx_forward;
389 /* Backward reach. Signed number. < 0. */
390 offsetT rlx_backward;
392 /* Bytes length of this address. */
393 unsigned char rlx_length;
395 /* Next longer relax-state. 0 means there is no 'next' relax-state. */
396 relax_substateT rlx_more;
399 typedef struct relax_type relax_typeS;
401 /* main program "as.c" (command arguments etc). */
403 COMMON unsigned char flag_no_comments; /* -f */
404 COMMON unsigned char flag_debug; /* -D */
405 COMMON unsigned char flag_signed_overflow_ok; /* -J */
406 #ifndef WORKING_DOT_WORD
407 COMMON unsigned char flag_warn_displacement; /* -K */
408 #endif
410 /* True if local symbols should be retained. */
411 COMMON int flag_keep_locals; /* -L */
413 /* True if we are assembling in MRI mode. */
414 COMMON int flag_mri;
416 /* Should the data section be made read-only and appended to the text
417 section? */
418 COMMON unsigned char flag_readonly_data_in_text; /* -R */
420 /* True if warnings should be inhibited. */
421 COMMON int flag_no_warnings; /* -W */
423 /* True if warnings count as errors. */
424 COMMON int flag_fatal_warnings; /* --fatal-warnings */
426 /* True if we should attempt to generate output even if non-fatal errors
427 are detected. */
428 COMMON unsigned char flag_always_generate_output; /* -Z */
430 /* This is true if the assembler should output time and space usage. */
431 COMMON unsigned char flag_print_statistics;
433 /* True if local absolute symbols are to be stripped. */
434 COMMON int flag_strip_local_absolute;
436 /* True if we should generate a traditional format object file. */
437 COMMON int flag_traditional_format;
439 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
440 COMMON int flag_execstack;
442 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
443 COMMON int flag_noexecstack;
445 /* name of emitted object file */
446 COMMON char *out_file_name;
448 /* name of file defining extensions to the basic instruction set */
449 COMMON char *insttbl_file_name;
451 /* TRUE if we need a second pass. */
452 COMMON int need_pass_2;
454 /* TRUE if we should do no relaxing, and
455 leave lots of padding. */
456 COMMON int linkrelax;
458 /* TRUE if we should produce a listing. */
459 extern int listing;
461 /* Type of debugging information we should generate. We currently support
462 stabs, ECOFF, and DWARF2.
464 NOTE! This means debug information about the assembly source code itself
465 and _not_ about possible debug information from a high-level language.
466 This is especially relevant to DWARF2, since the compiler may emit line
467 number directives that the assembler resolves. */
469 enum debug_info_type
471 DEBUG_UNSPECIFIED,
472 DEBUG_NONE,
473 DEBUG_STABS,
474 DEBUG_ECOFF,
475 DEBUG_DWARF,
476 DEBUG_DWARF2
479 extern enum debug_info_type debug_type;
480 extern int use_gnu_debug_info_extensions;
482 /* Maximum level of macro nesting. */
483 extern int max_macro_nest;
485 /* Verbosity level. */
486 extern int verbose;
488 /* Obstack chunk size. Keep large for efficient space use, make small to
489 increase malloc calls for monitoring memory allocation. */
490 extern int chunksize;
492 struct _pseudo_type
494 /* assembler mnemonic, lower case, no '.' */
495 const char *poc_name;
496 /* Do the work */
497 void (*poc_handler) (int);
498 /* Value to pass to handler */
499 int poc_val;
502 typedef struct _pseudo_type pseudo_typeS;
504 /* Prefer varargs for non-ANSI compiler, since some will barf if the
505 ellipsis definition is used with a no-arguments declaration. */
506 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
507 #undef HAVE_STDARG_H
508 #endif
510 #if defined (HAVE_STDARG_H)
511 #define USE_STDARG
512 #endif
513 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
514 #define USE_VARARGS
515 #endif
517 #ifdef USE_STDARG
518 #if (__GNUC__ >= 2) && !defined(VMS)
519 /* for use with -Wformat */
521 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
522 /* Support for double underscores in attribute names was added in gcc
523 2.6, so avoid them if we are using an earlier version. */
524 #define __printf__ printf
525 #define __format__ format
526 #endif
528 #define PRINTF_LIKE(FCN) \
529 void FCN (const char *format, ...) \
530 __attribute__ ((__format__ (__printf__, 1, 2)))
531 #define PRINTF_WHERE_LIKE(FCN) \
532 void FCN (char *file, unsigned int line, const char *format, ...) \
533 __attribute__ ((__format__ (__printf__, 3, 4)))
535 #else /* __GNUC__ < 2 || defined(VMS) */
537 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
538 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, \
539 unsigned int line, \
540 const char *format, ...)
542 #endif /* __GNUC__ < 2 || defined(VMS) */
544 #else /* ! USE_STDARG */
546 #define PRINTF_LIKE(FCN) void FCN ()
547 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
549 #endif /* ! USE_STDARG */
551 PRINTF_LIKE (as_bad);
552 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
553 PRINTF_LIKE (as_tsktsk);
554 PRINTF_LIKE (as_warn);
555 PRINTF_WHERE_LIKE (as_bad_where);
556 PRINTF_WHERE_LIKE (as_warn_where);
558 void as_assert (const char *, int, const char *);
559 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
560 void fprint_value (FILE *, addressT);
561 void sprint_value (char *, addressT);
562 int had_errors (void);
563 int had_warnings (void);
564 void as_warn_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
565 void as_bad_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
566 void print_version_id (void);
567 char * app_push (void);
568 char * atof_ieee (char *, int, LITTLENUM_TYPE *);
569 char * input_scrub_include_file (char *, char *);
570 void input_scrub_insert_line (const char *);
571 void input_scrub_insert_file (char *);
572 char * input_scrub_new_file (char *);
573 char * input_scrub_next_buffer (char **bufp);
574 int do_scrub_chars (int (*get) (char *, int), char *, int);
575 int gen_to_words (LITTLENUM_TYPE *, int, long);
576 int had_err (void);
577 int ignore_input (void);
578 void cond_finish_check (int);
579 void cond_exit_macro (int);
580 int seen_at_least_1_file (void);
581 void app_pop (char *);
582 void as_howmuch (FILE *);
583 void as_perror (const char *, const char *);
584 void as_where (char **, unsigned int *);
585 void bump_line_counters (void);
586 void do_scrub_begin (int);
587 void input_scrub_begin (void);
588 void input_scrub_close (void);
589 void input_scrub_end (void);
590 int new_logical_line (char *, int);
591 void subsegs_begin (void);
592 void subseg_change (segT, int);
593 segT subseg_new (const char *, subsegT);
594 segT subseg_force_new (const char *, subsegT);
595 void subseg_set (segT, subsegT);
596 int subseg_text_p (segT);
597 int seg_not_empty_p (segT);
598 void start_dependencies (char *);
599 void register_dependency (char *);
600 void print_dependencies (void);
601 #ifdef BFD_ASSEMBLER
602 segT subseg_get (const char *, int);
603 #endif
605 struct expressionS;
606 struct fix;
607 typedef struct symbol symbolS;
608 struct relax_type;
609 typedef struct frag fragS;
611 #ifdef BFD_ASSEMBLER
612 /* literal.c */
613 valueT add_to_literal_pool (symbolS *, valueT, segT, int);
614 #endif
616 int check_eh_frame (struct expressionS *, unsigned int *);
617 int eh_frame_estimate_size_before_relax (fragS *);
618 int eh_frame_relax_frag (fragS *);
619 void eh_frame_convert_frag (fragS *);
620 int generic_force_reloc (struct fix *);
622 #include "expr.h" /* Before targ-*.h */
624 /* This one starts the chain of target dependant headers. */
625 #include "targ-env.h"
627 #ifdef OBJ_MAYBE_ELF
628 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
629 #else
630 #ifdef OBJ_ELF
631 #define IS_ELF 1
632 #else
633 #define IS_ELF 0
634 #endif
635 #endif
637 #include "write.h"
638 #include "frags.h"
639 #include "hash.h"
640 #include "read.h"
641 #include "symbols.h"
643 #include "tc.h"
644 #include "obj.h"
646 #ifdef USE_EMULATIONS
647 #include "emul.h"
648 #endif
649 #include "listing.h"
651 #ifdef TC_M68K
652 /* True if we are assembling in m68k MRI mode. */
653 COMMON int flag_m68k_mri;
654 #else
655 #define flag_m68k_mri 0
656 #endif
658 #ifdef WARN_COMMENTS
659 COMMON int warn_comment;
660 COMMON unsigned int found_comment;
661 COMMON char * found_comment_file;
662 #endif
664 #ifndef NUMBERS_WITH_SUFFIX
665 #define NUMBERS_WITH_SUFFIX 0
666 #endif
668 #ifndef LOCAL_LABELS_DOLLAR
669 #define LOCAL_LABELS_DOLLAR 0
670 #endif
672 #ifndef LOCAL_LABELS_FB
673 #define LOCAL_LABELS_FB 0
674 #endif
676 #ifndef LABELS_WITHOUT_COLONS
677 #define LABELS_WITHOUT_COLONS 0
678 #endif
680 #ifndef NO_PSEUDO_DOT
681 #define NO_PSEUDO_DOT 0
682 #endif
684 #ifndef TEXT_SECTION_NAME
685 #define TEXT_SECTION_NAME ".text"
686 #define DATA_SECTION_NAME ".data"
687 #define BSS_SECTION_NAME ".bss"
688 #endif
690 #ifndef OCTETS_PER_BYTE_POWER
691 #define OCTETS_PER_BYTE_POWER 0
692 #endif
693 #ifndef OCTETS_PER_BYTE
694 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
695 #endif
696 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
697 #error "Octets per byte conflicts with its power-of-two definition!"
698 #endif
700 #endif /* GAS */