oops - omitted from previous delta
[binutils.git] / gas / as.h
blobff434cbed0cc1cec3ce56710871a0f588937ecbd
1 /* as.h - global header file
2 Copyright 1987, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002
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 "".
40 #include "config.h"
41 #include "bin-bugs.h"
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.
48 --KR 1995.08.08 */
49 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
51 #ifndef __GNUC__
52 # if HAVE_ALLOCA_H
53 # include <alloca.h>
54 # else
55 # ifdef _AIX
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
58 thing in the file. */
59 #pragma alloca
60 # else
61 # ifndef alloca /* predefined by HP cc +Olibcalls */
62 # if !defined (__STDC__) && !defined (__hpux)
63 extern char *alloca ();
64 # else
65 extern void *alloca ();
66 # endif /* __STDC__, __hpux */
67 # endif /* alloca */
68 # endif /* _AIX */
69 # endif /* HAVE_ALLOCA_H */
70 #endif /* __GNUC__ */
72 /* Now, tend to the rest of the configuration. */
74 /* System include files first... */
75 #include <stdio.h>
76 #ifdef HAVE_STRING_H
77 #include <string.h>
78 #else
79 #ifdef HAVE_STRINGS_H
80 #include <strings.h>
81 #endif
82 #endif
83 #ifdef HAVE_STDLIB_H
84 #include <stdlib.h>
85 #endif
86 #ifdef HAVE_UNISTD_H
87 #include <unistd.h>
88 #endif
89 #ifdef HAVE_SYS_TYPES_H
90 /* for size_t, pid_t */
91 #include <sys/types.h>
92 #endif
94 #include "getopt.h"
95 /* The first getopt value for machine-independent long options.
96 150 isn't special; it's just an arbitrary non-ASCII char value. */
97 #define OPTION_STD_BASE 150
98 /* The first getopt value for machine-dependent long options.
99 190 gives the standard options room to grow. */
100 #define OPTION_MD_BASE 190
102 #ifdef DEBUG
103 #undef NDEBUG
104 #endif
105 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
106 #define __PRETTY_FUNCTION__ ((char*)0)
107 #endif
108 #if 0
110 /* Handle lossage with assert.h. */
111 #ifndef BROKEN_ASSERT
112 #include <assert.h>
113 #else /* BROKEN_ASSERT */
114 #ifndef NDEBUG
115 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
116 #else
117 #define assert(p) ((p), 0)
118 #endif
119 #endif /* BROKEN_ASSERT */
121 #else
123 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
124 #undef abort
125 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
127 #endif
129 /* Now GNU header files... */
130 #include "ansidecl.h"
131 #ifdef BFD_ASSEMBLER
132 #include "bfd.h"
133 #endif
134 #include "libiberty.h"
136 /* Define the standard progress macros. */
137 #include "progress.h"
139 /* This doesn't get taken care of anywhere. */
140 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
141 #if !defined (__GNUC__) && !defined (inline)
142 #define inline
143 #endif
144 #endif /* !__MWERKS__ */
146 /* Other stuff from config.h. */
147 #ifdef NEED_DECLARATION_STRSTR
148 extern char *strstr ();
149 #endif
150 #ifdef NEED_DECLARATION_MALLOC
151 extern PTR malloc ();
152 extern PTR realloc ();
153 #endif
154 #ifdef NEED_DECLARATION_FREE
155 extern void free ();
156 #endif
157 #ifdef NEED_DECLARATION_ERRNO
158 extern int errno;
159 #endif
160 #ifdef NEED_DECLARATION_ENVIRON
161 extern char **environ;
162 #endif
164 /* This is needed for VMS. */
165 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
166 #define unlink remove
167 #endif
169 /* Hack to make "gcc -Wall" not complain about obstack macros. */
170 #if !defined (memcpy) && !defined (bcopy)
171 #define bcopy(src,dest,size) memcpy (dest, src, size)
172 #endif
174 /* Make Saber happier on obstack.h. */
175 #ifdef SABER
176 #undef __PTR_TO_INT
177 #define __PTR_TO_INT(P) ((int) (P))
178 #undef __INT_TO_PTR
179 #define __INT_TO_PTR(P) ((char *) (P))
180 #endif
182 #ifndef __LINE__
183 #define __LINE__ "unknown"
184 #endif /* __LINE__ */
186 #ifndef __FILE__
187 #define __FILE__ "unknown"
188 #endif /* __FILE__ */
190 #ifndef FOPEN_WB
191 #ifdef GO32
192 #include "fopen-bin.h"
193 #else
194 #include "fopen-same.h"
195 #endif
196 #endif
198 #ifndef EXIT_SUCCESS
199 #define EXIT_SUCCESS 0
200 #define EXIT_FAILURE 1
201 #endif
203 #ifndef SEEK_SET
204 #define SEEK_SET 0
205 #endif
207 #define obstack_chunk_alloc xmalloc
208 #define obstack_chunk_free xfree
210 #define xfree free
212 #include "asintl.h"
214 #define BAD_CASE(val) \
216 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
217 (long) val, __LINE__, __FILE__); \
220 #include "flonum.h"
222 /* These are assembler-wide concepts */
224 #ifdef BFD_ASSEMBLER
225 extern bfd *stdoutput;
226 typedef bfd_vma addressT;
227 typedef bfd_signed_vma offsetT;
228 #else
229 typedef unsigned long addressT;
230 typedef long offsetT;
231 #endif
233 /* Type of symbol value, etc. For use in prototypes. */
234 typedef addressT valueT;
236 #ifndef COMMON
237 #ifdef TEST
238 #define COMMON /* declare our COMMONs storage here. */
239 #else
240 #define COMMON extern /* our commons live elswhere */
241 #endif
242 #endif
243 /* COMMON now defined */
245 #ifdef DEBUG
246 #ifndef know
247 #define know(p) assert(p) /* Verify our assumptions! */
248 #endif /* not yet defined */
249 #else
250 #define know(p) /* know() checks are no-op.ed */
251 #endif
253 /* input_scrub.c */
255 /* Supplies sanitised buffers to read.c.
256 Also understands printing line-number part of error messages. */
258 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
260 #ifndef BFD_ASSEMBLER
262 #ifdef MANY_SEGMENTS
263 #include "bfd.h"
264 #define N_SEGMENTS 40
265 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
266 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
267 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
268 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
269 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
270 #define SEG_TEXT SEG_E0
271 #define SEG_DATA SEG_E1
272 #define SEG_BSS SEG_E2
273 #define SEG_LAST SEG_E39
274 #else
275 #define N_SEGMENTS 3
276 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
277 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
278 #endif
280 typedef enum _segT {
281 SEG_ABSOLUTE = 0,
282 SEG_LIST,
283 SEG_UNKNOWN,
284 SEG_GOOF, /* Only happens if AS has a logic error. */
285 /* Invented so we don't crash printing */
286 /* error message involving weird segment. */
287 SEG_EXPR, /* Intermediate expression values. */
288 SEG_DEBUG, /* Debug segment */
289 SEG_NTV, /* Transfert vector preload segment */
290 SEG_PTV, /* Transfert vector postload segment */
291 SEG_REGISTER /* Mythical: a register-valued expression */
292 } segT;
294 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
295 #else
296 typedef asection *segT;
297 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
298 && (SEG) != undefined_section \
299 && (SEG) != reg_section \
300 && (SEG) != expr_section)
301 #endif
302 typedef int subsegT;
304 /* What subseg we are accreting now? */
305 COMMON subsegT now_subseg;
307 /* Segment our instructions emit to. */
308 COMMON segT now_seg;
310 #ifdef BFD_ASSEMBLER
311 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
312 #else
313 extern char const *const seg_name[];
314 #define segment_name(SEG) seg_name[(int) (SEG)]
315 #endif
317 #ifndef BFD_ASSEMBLER
318 extern int section_alignment[];
319 #endif
321 #ifdef BFD_ASSEMBLER
322 extern segT reg_section, expr_section;
323 /* Shouldn't these be eliminated someday? */
324 extern segT text_section, data_section, bss_section;
325 #define absolute_section bfd_abs_section_ptr
326 #define undefined_section bfd_und_section_ptr
327 #else
328 #define reg_section SEG_REGISTER
329 #define expr_section SEG_EXPR
330 #define text_section SEG_TEXT
331 #define data_section SEG_DATA
332 #define bss_section SEG_BSS
333 #define absolute_section SEG_ABSOLUTE
334 #define undefined_section SEG_UNKNOWN
335 #endif
337 /* relax() */
339 enum _relax_state {
340 /* Variable chars to be repeated fr_offset times.
341 Fr_symbol unused. Used with fr_offset == 0 for a
342 constant length frag. */
343 rs_fill = 1,
345 /* Align. The fr_offset field holds the power of 2 to which to
346 align. The fr_var field holds the number of characters in the
347 fill pattern. The fr_subtype field holds the maximum number of
348 bytes to skip when aligning, or 0 if there is no maximum. */
349 rs_align,
351 /* Align code. The fr_offset field holds the power of 2 to which
352 to align. This type is only generated by machine specific
353 code, which is normally responsible for handling the fill
354 pattern. The fr_subtype field holds the maximum number of
355 bytes to skip when aligning, or 0 if there is no maximum. */
356 rs_align_code,
358 /* Test for alignment. Like rs_align, but used by several targets
359 to warn if data is not properly aligned. */
360 rs_align_test,
362 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
363 character. */
364 rs_org,
366 #ifndef WORKING_DOT_WORD
367 /* JF: gunpoint */
368 rs_broken_word,
369 #endif
371 /* machine-specific relaxable (or similarly alterable) instruction */
372 rs_machine_dependent,
374 /* .space directive with expression operand that needs to be computed
375 later. Similar to rs_org, but different.
376 fr_symbol: operand
377 1 variable char: fill character */
378 rs_space,
380 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
381 unsigned, 1 for signed. */
382 rs_leb128,
384 /* Exception frame information which we may be able to optimize. */
385 rs_cfa,
387 /* Cross-fragment dwarf2 line number optimization. */
388 rs_dwarf2dbg
391 typedef enum _relax_state relax_stateT;
393 /* This type is used in prototypes, so it can't be a type that will be
394 widened for argument passing. */
395 typedef unsigned int relax_substateT;
397 /* Enough bits for address, but still an integer type.
398 Could be a problem, cross-assembling for 64-bit machines. */
399 typedef addressT relax_addressT;
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 /* name of emitted object file */
440 COMMON char *out_file_name;
442 /* name of file defining extensions to the basic instruction set */
443 COMMON char *insttbl_file_name;
445 /* TRUE if we need a second pass. */
446 COMMON int need_pass_2;
448 /* TRUE if we should do no relaxing, and
449 leave lots of padding. */
450 COMMON int linkrelax;
452 /* TRUE if we should produce a listing. */
453 extern int listing;
455 /* Type of debugging information we should generate. We currently support
456 stabs, ECOFF, and DWARF2.
458 NOTE! This means debug information about the assembly source code itself
459 and _not_ about possible debug information from a high-level language.
460 This is especially relevant to DWARF2, since the compiler may emit line
461 number directives that the assembler resolves. */
463 enum debug_info_type {
464 DEBUG_UNSPECIFIED,
465 DEBUG_NONE,
466 DEBUG_STABS,
467 DEBUG_ECOFF,
468 DEBUG_DWARF,
469 DEBUG_DWARF2
472 extern enum debug_info_type debug_type;
474 /* Maximum level of macro nesting. */
475 extern int max_macro_nest;
477 /* Obstack chunk size. Keep large for efficient space use, make small to
478 increase malloc calls for monitoring memory allocation. */
479 extern int chunksize;
481 struct _pseudo_type {
482 /* assembler mnemonic, lower case, no '.' */
483 const char *poc_name;
484 /* Do the work */
485 void (*poc_handler) PARAMS ((int));
486 /* Value to pass to handler */
487 int poc_val;
490 typedef struct _pseudo_type pseudo_typeS;
492 /* Prefer varargs for non-ANSI compiler, since some will barf if the
493 ellipsis definition is used with a no-arguments declaration. */
494 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
495 #undef HAVE_STDARG_H
496 #endif
498 #if defined (HAVE_STDARG_H)
499 #define USE_STDARG
500 #endif
501 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
502 #define USE_VARARGS
503 #endif
505 #ifdef USE_STDARG
506 #if (__GNUC__ >= 2) && !defined(VMS)
507 /* for use with -Wformat */
509 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
510 /* Support for double underscores in attribute names was added in gcc
511 2.6, so avoid them if we are using an earlier version. */
512 #define __printf__ printf
513 #define __format__ format
514 #endif
516 #define PRINTF_LIKE(FCN) \
517 void FCN (const char *format, ...) \
518 __attribute__ ((__format__ (__printf__, 1, 2)))
519 #define PRINTF_WHERE_LIKE(FCN) \
520 void FCN (char *file, unsigned int line, const char *format, ...) \
521 __attribute__ ((__format__ (__printf__, 3, 4)))
523 #else /* __GNUC__ < 2 || defined(VMS) */
525 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
526 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
527 unsigned int line, \
528 const char *format, ...))
530 #endif /* __GNUC__ < 2 || defined(VMS) */
532 #else /* ! USE_STDARG */
534 #define PRINTF_LIKE(FCN) void FCN ()
535 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
537 #endif /* ! USE_STDARG */
539 PRINTF_LIKE (as_bad);
540 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
541 PRINTF_LIKE (as_tsktsk);
542 PRINTF_LIKE (as_warn);
543 PRINTF_WHERE_LIKE (as_bad_where);
544 PRINTF_WHERE_LIKE (as_warn_where);
546 void as_assert PARAMS ((const char *, int, const char *));
547 void as_abort PARAMS ((const char *, int, const char *)) ATTRIBUTE_NORETURN;
549 void fprint_value PARAMS ((FILE *file, addressT value));
550 void sprint_value PARAMS ((char *buf, addressT value));
552 int had_errors PARAMS ((void));
553 int had_warnings PARAMS ((void));
555 void print_version_id PARAMS ((void));
556 char *app_push PARAMS ((void));
557 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
558 char *input_scrub_include_file PARAMS ((char *filename, char *position));
559 extern void input_scrub_insert_line PARAMS((const char *line));
560 extern void input_scrub_insert_file PARAMS((char *path));
561 char *input_scrub_new_file PARAMS ((char *filename));
562 char *input_scrub_next_buffer PARAMS ((char **bufp));
563 int do_scrub_chars PARAMS ((int (*get) (char *, int), char *to, int tolen));
564 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
565 long exponent_bits));
566 int had_err PARAMS ((void));
567 int ignore_input PARAMS ((void));
568 void cond_finish_check PARAMS ((int));
569 void cond_exit_macro PARAMS ((int));
570 int seen_at_least_1_file PARAMS ((void));
571 void app_pop PARAMS ((char *arg));
572 void as_howmuch PARAMS ((FILE * stream));
573 void as_perror PARAMS ((const char *gripe, const char *filename));
574 void as_where PARAMS ((char **namep, unsigned int *linep));
575 void bump_line_counters PARAMS ((void));
576 void do_scrub_begin PARAMS ((int));
577 void input_scrub_begin PARAMS ((void));
578 void input_scrub_close PARAMS ((void));
579 void input_scrub_end PARAMS ((void));
580 int new_logical_line PARAMS ((char *fname, int line_number));
581 void subsegs_begin PARAMS ((void));
582 void subseg_change PARAMS ((segT seg, int subseg));
583 segT subseg_new PARAMS ((const char *name, subsegT subseg));
584 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
585 void subseg_set PARAMS ((segT seg, subsegT subseg));
586 #ifdef BFD_ASSEMBLER
587 segT subseg_get PARAMS ((const char *, int));
588 #endif
589 int subseg_text_p PARAMS ((segT));
591 void start_dependencies PARAMS ((char *));
592 void register_dependency PARAMS ((char *));
593 void print_dependencies PARAMS ((void));
595 struct expressionS;
596 struct fix;
597 typedef struct symbol symbolS;
598 struct relax_type;
599 typedef struct frag fragS;
601 #ifdef BFD_ASSEMBLER
602 /* literal.c */
603 valueT add_to_literal_pool PARAMS ((symbolS *, valueT, segT, int));
604 #endif
606 int check_eh_frame PARAMS ((struct expressionS *, unsigned int *));
607 int eh_frame_estimate_size_before_relax PARAMS ((fragS *));
608 int eh_frame_relax_frag PARAMS ((fragS *));
609 void eh_frame_convert_frag PARAMS ((fragS *));
611 #include "expr.h" /* Before targ-*.h */
613 /* this one starts the chain of target dependant headers */
614 #include "targ-env.h"
616 #ifdef TC_ARC
617 #include "struc-symbol.h"
618 #endif
620 #include "write.h"
621 #include "frags.h"
622 #include "hash.h"
623 #include "read.h"
624 #include "symbols.h"
626 #include "tc.h"
627 #include "obj.h"
629 #ifdef USE_EMULATIONS
630 #include "emul.h"
631 #endif
632 #include "listing.h"
634 #ifdef TC_M68K
635 /* True if we are assembling in m68k MRI mode. */
636 COMMON int flag_m68k_mri;
637 #else
638 #define flag_m68k_mri 0
639 #endif
641 #ifdef WARN_COMMENTS
642 COMMON int warn_comment;
643 COMMON unsigned int found_comment;
644 COMMON char *found_comment_file;
645 #endif
647 #ifndef NUMBERS_WITH_SUFFIX
648 #define NUMBERS_WITH_SUFFIX 0
649 #endif
651 #ifndef LOCAL_LABELS_DOLLAR
652 #define LOCAL_LABELS_DOLLAR 0
653 #endif
655 #ifndef LOCAL_LABELS_FB
656 #define LOCAL_LABELS_FB 0
657 #endif
659 #ifndef LABELS_WITHOUT_COLONS
660 #define LABELS_WITHOUT_COLONS 0
661 #endif
663 #ifndef NO_PSEUDO_DOT
664 #define NO_PSEUDO_DOT 0
665 #endif
667 #ifndef TEXT_SECTION_NAME
668 #define TEXT_SECTION_NAME ".text"
669 #define DATA_SECTION_NAME ".data"
670 #define BSS_SECTION_NAME ".bss"
671 #endif
673 #ifndef OCTETS_PER_BYTE_POWER
674 #define OCTETS_PER_BYTE_POWER 0
675 #endif
676 #ifndef OCTETS_PER_BYTE
677 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
678 #endif
679 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
680 #error "Octets per byte conflicts with its power-of-two definition!"
681 #endif
683 #endif /* GAS */