file as.info-5 was initially added on branch binutils-2_10-branch.
[binutils.git] / gas / as.h
blobe56d6cda7821ecd776fb69091f39263abf76a364
1 /* as.h - global header file
2 Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000
3 Free Software Foundation, Inc.
5 This file is part of GAS, the GNU Assembler.
7 GAS is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GAS is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GAS; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA. */
22 #ifndef GAS
23 #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 #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.
51 --KR 1995.08.08 */
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. */
55 #ifdef __GNUC__
56 # ifndef alloca
57 # ifdef __STDC__
58 extern void *alloca ();
59 # else
60 extern char *alloca ();
61 # endif
62 # endif
63 #else
64 # if HAVE_ALLOCA_H
65 # include <alloca.h>
66 # else
67 # ifdef _AIX
68 #pragma alloca
69 # else
70 # ifndef alloca /* predefined by HP cc +Olibcalls */
71 # if !defined (__STDC__) && !defined (__hpux)
72 extern char *alloca ();
73 # else
74 extern void *alloca ();
75 # endif /* __STDC__, __hpux */
76 # endif /* alloca */
77 # endif /* _AIX */
78 # endif /* HAVE_ALLOCA_H */
79 #endif
81 /* Now, tend to the rest of the configuration. */
83 /* System include files first... */
84 #include <stdio.h>
85 #include <ctype.h>
86 #ifdef HAVE_STRING_H
87 #include <string.h>
88 #else
89 #ifdef HAVE_STRINGS_H
90 #include <strings.h>
91 #endif
92 #endif
93 #ifdef HAVE_STDLIB_H
94 #include <stdlib.h>
95 #endif
96 #ifdef HAVE_UNISTD_H
97 #include <unistd.h>
98 #endif
99 #ifdef HAVE_SYS_TYPES_H
100 /* for size_t, pid_t */
101 #include <sys/types.h>
102 #endif
104 #include <getopt.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 170 gives the standard options room to grow. */
110 #define OPTION_MD_BASE 170
112 #ifdef DEBUG
113 #undef NDEBUG
114 #endif
115 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
116 #define __PRETTY_FUNCTION__ ((char*)0)
117 #endif
118 #if 0
120 /* Handle lossage with assert.h. */
121 #ifndef BROKEN_ASSERT
122 #include <assert.h>
123 #else /* BROKEN_ASSERT */
124 #ifndef NDEBUG
125 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
126 #else
127 #define assert(p) ((p), 0)
128 #endif
129 #endif /* BROKEN_ASSERT */
131 #else
133 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
134 #undef abort
135 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
137 #endif
140 /* Now GNU header files... */
141 #include "ansidecl.h"
142 #ifdef BFD_ASSEMBLER
143 #include "bfd.h"
144 #endif
145 #include "libiberty.h"
147 /* Define the standard progress macros. */
148 #include "progress.h"
150 /* This doesn't get taken care of anywhere. */
151 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
152 #if !defined (__GNUC__) && !defined (inline)
153 #define inline
154 #endif
155 #endif /* !__MWERKS__ */
157 /* Other stuff from config.h. */
158 #ifdef NEED_DECLARATION_STRSTR
159 extern char *strstr ();
160 #endif
161 #ifdef NEED_DECLARATION_MALLOC
162 extern PTR malloc ();
163 extern PTR realloc ();
164 #endif
165 #ifdef NEED_DECLARATION_FREE
166 extern void free ();
167 #endif
168 #ifdef NEED_DECLARATION_ERRNO
169 extern int errno;
170 #endif
171 #ifdef NEED_DECLARATION_ENVIRON
172 extern char **environ;
173 #endif
175 /* This is needed for VMS. */
176 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
177 #define unlink remove
178 #endif
180 /* Hack to make "gcc -Wall" not complain about obstack macros. */
181 #if !defined (memcpy) && !defined (bcopy)
182 #define bcopy(src,dest,size) memcpy(dest,src,size)
183 #endif
185 /* Make Saber happier on obstack.h. */
186 #ifdef SABER
187 #undef __PTR_TO_INT
188 #define __PTR_TO_INT(P) ((int)(P))
189 #undef __INT_TO_PTR
190 #define __INT_TO_PTR(P) ((char *)(P))
191 #endif
193 #ifndef __LINE__
194 #define __LINE__ "unknown"
195 #endif /* __LINE__ */
197 #ifndef __FILE__
198 #define __FILE__ "unknown"
199 #endif /* __FILE__ */
201 #ifndef FOPEN_WB
202 #ifdef GO32
203 #include "fopen-bin.h"
204 #else
205 #include "fopen-same.h"
206 #endif
207 #endif
209 #ifndef EXIT_SUCCESS
210 #define EXIT_SUCCESS 0
211 #define EXIT_FAILURE 1
212 #endif
214 #ifndef SEEK_SET
215 #define SEEK_SET 0
216 #endif
218 #define obstack_chunk_alloc xmalloc
219 #define obstack_chunk_free xfree
221 #define xfree free
223 #include "asintl.h"
225 #define BAD_CASE(val) \
227 as_fatal(_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
228 (long) val, __LINE__, __FILE__); \
231 #include "flonum.h"
233 /* These are assembler-wide concepts */
235 #ifdef BFD_ASSEMBLER
236 extern bfd *stdoutput;
237 typedef bfd_vma addressT;
238 typedef bfd_signed_vma offsetT;
239 #else
240 typedef unsigned long addressT;
241 typedef long offsetT;
242 #endif
244 /* Type of symbol value, etc. For use in prototypes. */
245 typedef addressT valueT;
247 #ifndef COMMON
248 #ifdef TEST
249 #define COMMON /* declare our COMMONs storage here. */
250 #else
251 #define COMMON extern /* our commons live elswhere */
252 #endif
253 #endif
254 /* COMMON now defined */
256 #ifdef DEBUG
257 #ifndef know
258 #define know(p) assert(p) /* Verify our assumptions! */
259 #endif /* not yet defined */
260 #else
261 #define know(p) /* know() checks are no-op.ed */
262 #endif
264 /* input_scrub.c */
267 * Supplies sanitised buffers to read.c.
268 * Also understands printing line-number part of error messages.
272 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
274 #ifndef BFD_ASSEMBLER
276 #ifdef MANY_SEGMENTS
277 #include "bfd.h"
278 #define N_SEGMENTS 40
279 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
280 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
281 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
282 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
283 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
284 #define SEG_TEXT SEG_E0
285 #define SEG_DATA SEG_E1
286 #define SEG_BSS SEG_E2
287 #define SEG_LAST SEG_E39
288 #else
289 #define N_SEGMENTS 3
290 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
291 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
292 #endif
294 typedef enum _segT
296 SEG_ABSOLUTE = 0,
297 SEG_LIST,
298 SEG_UNKNOWN,
299 SEG_GOOF, /* Only happens if AS has a logic error. */
300 /* Invented so we don't crash printing */
301 /* error message involving weird segment. */
302 SEG_EXPR, /* Intermediate expression values. */
303 SEG_DEBUG, /* Debug segment */
304 SEG_NTV, /* Transfert vector preload segment */
305 SEG_PTV, /* Transfert vector postload segment */
306 SEG_REGISTER /* Mythical: a register-valued expression */
307 } segT;
309 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
310 #else
311 typedef asection *segT;
312 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
313 && (SEG) != undefined_section \
314 && (SEG) != reg_section \
315 && (SEG) != expr_section)
316 #endif
317 typedef int subsegT;
319 /* What subseg we are accreting now? */
320 COMMON subsegT now_subseg;
322 /* Segment our instructions emit to. */
323 COMMON segT now_seg;
325 #ifdef BFD_ASSEMBLER
326 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
327 #else
328 extern char const *const seg_name[];
329 #define segment_name(SEG) seg_name[(int) (SEG)]
330 #endif
332 #ifndef BFD_ASSEMBLER
333 extern int section_alignment[];
334 #endif
336 #ifdef BFD_ASSEMBLER
337 extern segT reg_section, expr_section;
338 /* Shouldn't these be eliminated someday? */
339 extern segT text_section, data_section, bss_section;
340 #define absolute_section bfd_abs_section_ptr
341 #define undefined_section bfd_und_section_ptr
342 #else
343 #define reg_section SEG_REGISTER
344 #define expr_section SEG_EXPR
345 #define text_section SEG_TEXT
346 #define data_section SEG_DATA
347 #define bss_section SEG_BSS
348 #define absolute_section SEG_ABSOLUTE
349 #define undefined_section SEG_UNKNOWN
350 #endif
352 /* relax() */
354 enum _relax_state
356 /* Variable chars to be repeated fr_offset times.
357 Fr_symbol unused. Used with fr_offset == 0 for a
358 constant length frag. */
359 rs_fill = 1,
361 /* Align. The fr_offset field holds the power of 2 to which to
362 align. The fr_var field holds the number of characters in the
363 fill pattern. The fr_subtype field holds the maximum number of
364 bytes to skip when aligning, or 0 if there is no maximum. */
365 rs_align,
367 /* Align code. The fr_offset field holds the power of 2 to which
368 to align. This type is only generated by machine specific
369 code, which is normally responsible for handling the fill
370 pattern. The fr_subtype field holds the maximum number of
371 bytes to skip when aligning, or 0 if there is no maximum. */
372 rs_align_code,
374 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
375 character. */
376 rs_org,
378 #ifndef WORKING_DOT_WORD
379 /* JF: gunpoint */
380 rs_broken_word,
381 #endif
383 /* machine-specific relaxable (or similarly alterable) instruction */
384 rs_machine_dependent,
386 /* .space directive with expression operand that needs to be computed
387 later. Similar to rs_org, but different.
388 fr_symbol: operand
389 1 variable char: fill character */
390 rs_space,
392 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
393 unsigned, 1 for signed. */
394 rs_leb128,
396 /* Exception frame information which we may be able to optimize. */
397 rs_cfa
400 typedef enum _relax_state relax_stateT;
402 /* This type is used in prototypes, so it can't be a type that will be
403 widened for argument passing. */
404 typedef unsigned int relax_substateT;
406 /* Enough bits for address, but still an integer type.
407 Could be a problem, cross-assembling for 64-bit machines. */
408 typedef addressT relax_addressT;
410 /* main program "as.c" (command arguments etc) */
412 COMMON unsigned char flag_no_comments; /* -f */
413 COMMON unsigned char flag_debug; /* -D */
414 COMMON unsigned char flag_signed_overflow_ok; /* -J */
415 #ifndef WORKING_DOT_WORD
416 COMMON unsigned char flag_warn_displacement; /* -K */
417 #endif
419 /* True if local symbols should be retained. */
420 COMMON int flag_keep_locals; /* -L */
422 /* True if we are assembling in MRI mode. */
423 COMMON int flag_mri;
425 /* Should the data section be made read-only and appended to the text
426 section? */
427 COMMON unsigned char flag_readonly_data_in_text; /* -R */
429 /* True if warnings should be inhibited. */
430 COMMON int flag_no_warnings; /* -W */
432 /* True if warnings count as errors. */
433 COMMON int flag_fatal_warnings; /* --fatal-warnings */
435 /* True if we should attempt to generate output even if non-fatal errors
436 are detected. */
437 COMMON unsigned char flag_always_generate_output; /* -Z */
439 /* This is true if the assembler should output time and space usage. */
440 COMMON unsigned char flag_print_statistics;
442 /* True if local absolute symbols are to be stripped. */
443 COMMON int flag_strip_local_absolute;
445 /* True if we should generate a traditional format object file. */
446 COMMON int flag_traditional_format;
448 /* name of emitted object file */
449 COMMON char *out_file_name;
451 /* name of file defining extensions to the basic instruction set */
452 COMMON char *insttbl_file_name;
454 /* TRUE if we need a second pass. */
455 COMMON int need_pass_2;
457 /* TRUE if we should do no relaxing, and
458 leave lots of padding. */
459 COMMON int linkrelax;
461 /* TRUE if we should produce a listing. */
462 extern int listing;
464 /* Type of debugging information we should generate. We currently
465 support stabs, ECOFF, and DWARF2. */
467 enum debug_info_type
469 DEBUG_UNSPECIFIED,
470 DEBUG_NONE,
471 DEBUG_STABS,
472 DEBUG_ECOFF,
473 DEBUG_DWARF,
474 DEBUG_DWARF2
477 extern enum debug_info_type debug_type;
479 /* Maximum level of macro nesting. */
480 extern int max_macro_nest;
482 /* Obstack chunk size. Keep large for efficient space use, make small to
483 increase malloc calls for monitoring memory allocation. */
484 extern int chunksize;
486 struct _pseudo_type
488 /* assembler mnemonic, lower case, no '.' */
489 const char *poc_name;
490 /* Do the work */
491 void (*poc_handler) PARAMS ((int));
492 /* Value to pass to handler */
493 int poc_val;
496 typedef struct _pseudo_type pseudo_typeS;
498 /* Prefer varargs for non-ANSI compiler, since some will barf if the
499 ellipsis definition is used with a no-arguments declaration. */
500 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
501 #undef HAVE_STDARG_H
502 #endif
504 #if defined (HAVE_STDARG_H)
505 #define USE_STDARG
506 #endif
507 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
508 #define USE_VARARGS
509 #endif
511 #ifdef USE_STDARG
512 #if (__GNUC__ >= 2) && !defined(VMS)
513 /* for use with -Wformat */
515 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
516 /* Support for double underscores in attribute names was added in gcc
517 2.6, so avoid them if we are using an earlier version. */
518 #define __printf__ printf
519 #define __format__ format
520 #endif
522 #define PRINTF_LIKE(FCN) \
523 void FCN (const char *format, ...) \
524 __attribute__ ((__format__ (__printf__, 1, 2)))
525 #define PRINTF_WHERE_LIKE(FCN) \
526 void FCN (char *file, unsigned int line, const char *format, ...) \
527 __attribute__ ((__format__ (__printf__, 3, 4)))
529 #else /* __GNUC__ < 2 || defined(VMS) */
531 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
532 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
533 unsigned int line, \
534 const char *format, ...))
536 #endif /* __GNUC__ < 2 || defined(VMS) */
538 #else /* ! USE_STDARG */
540 #define PRINTF_LIKE(FCN) void FCN ()
541 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
543 #endif /* ! USE_STDARG */
545 PRINTF_LIKE (as_bad);
546 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
547 PRINTF_LIKE (as_tsktsk);
548 PRINTF_LIKE (as_warn);
549 PRINTF_WHERE_LIKE (as_bad_where);
550 PRINTF_WHERE_LIKE (as_warn_where);
552 void as_assert PARAMS ((const char *, int, const char *));
553 void as_abort PARAMS ((const char *, int, const char *)) ATTRIBUTE_NORETURN;
555 void fprint_value PARAMS ((FILE *file, addressT value));
556 void sprint_value PARAMS ((char *buf, addressT value));
558 int had_errors PARAMS ((void));
559 int had_warnings PARAMS ((void));
561 void print_version_id PARAMS ((void));
562 char *app_push PARAMS ((void));
563 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
564 char *input_scrub_include_file PARAMS ((char *filename, char *position));
565 extern void input_scrub_insert_line PARAMS((const char *line));
566 extern void input_scrub_insert_file PARAMS((char *path));
567 char *input_scrub_new_file PARAMS ((char *filename));
568 char *input_scrub_next_buffer PARAMS ((char **bufp));
569 int do_scrub_chars PARAMS ((int (*get) (char *, int), char *to, int tolen));
570 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
571 long exponent_bits));
572 int had_err PARAMS ((void));
573 int ignore_input PARAMS ((void));
574 void cond_finish_check PARAMS ((int));
575 void cond_exit_macro PARAMS ((int));
576 int seen_at_least_1_file PARAMS ((void));
577 void app_pop PARAMS ((char *arg));
578 void as_howmuch PARAMS ((FILE * stream));
579 void as_perror PARAMS ((const char *gripe, const char *filename));
580 void as_where PARAMS ((char **namep, unsigned int *linep));
581 void bump_line_counters PARAMS ((void));
582 void do_scrub_begin PARAMS ((int));
583 void input_scrub_begin PARAMS ((void));
584 void input_scrub_close PARAMS ((void));
585 void input_scrub_end PARAMS ((void));
586 int new_logical_line PARAMS ((char *fname, int line_number));
587 void subsegs_begin PARAMS ((void));
588 void subseg_change PARAMS ((segT seg, int subseg));
589 segT subseg_new PARAMS ((const char *name, subsegT subseg));
590 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
591 void subseg_set PARAMS ((segT seg, subsegT subseg));
592 #ifdef BFD_ASSEMBLER
593 segT subseg_get PARAMS ((const char *, int));
594 #endif
595 int subseg_text_p PARAMS ((segT));
597 void start_dependencies PARAMS ((char *));
598 void register_dependency PARAMS ((char *));
599 void print_dependencies PARAMS ((void));
601 struct expressionS;
602 struct fix;
603 typedef struct symbol symbolS;
604 struct relax_type;
605 typedef struct frag fragS;
607 #ifdef BFD_ASSEMBLER
608 /* literal.c */
609 valueT add_to_literal_pool PARAMS ((symbolS *, valueT, segT, int));
610 #endif
612 int check_eh_frame PARAMS ((struct expressionS *, unsigned int *));
613 int eh_frame_estimate_size_before_relax PARAMS ((fragS *));
614 int eh_frame_relax_frag PARAMS ((fragS *));
615 void eh_frame_convert_frag PARAMS ((fragS *));
617 #include "expr.h" /* Before targ-*.h */
619 /* this one starts the chain of target dependant headers */
620 #include "targ-env.h"
622 #include "write.h"
623 #include "frags.h"
624 #include "hash.h"
625 #include "read.h"
626 #include "symbols.h"
628 #include "tc.h"
629 #include "obj.h"
631 #ifdef USE_EMULATIONS
632 #include "emul.h"
633 #endif
634 #include "listing.h"
636 #ifdef TC_M68K
637 /* True if we are assembling in m68k MRI mode. */
638 COMMON int flag_m68k_mri;
639 #else
640 #define flag_m68k_mri 0
641 #endif
643 #ifndef NUMBERS_WITH_SUFFIX
644 #define NUMBERS_WITH_SUFFIX 0
645 #endif
647 #ifndef LOCAL_LABELS_DOLLAR
648 #define LOCAL_LABELS_DOLLAR 0
649 #endif
651 #ifndef LOCAL_LABELS_FB
652 #define LOCAL_LABELS_FB 0
653 #endif
655 #ifndef LABELS_WITHOUT_COLONS
656 #define LABELS_WITHOUT_COLONS 0
657 #endif
659 #ifndef NO_PSEUDO_DOT
660 #define NO_PSEUDO_DOT 0
661 #endif
663 #ifndef TEXT_SECTION_NAME
664 #define TEXT_SECTION_NAME ".text"
665 #define DATA_SECTION_NAME ".data"
666 #define BSS_SECTION_NAME ".bss"
667 #endif
669 #ifndef OCTETS_PER_BYTE_POWER
670 #define OCTETS_PER_BYTE_POWER 0
671 #endif
672 #ifndef OCTETS_PER_BYTE
673 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
674 #endif
675 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
676 #error "Octets per byte conflicts with its power-of-two definition!"
677 #endif
679 #endif /* GAS */
681 /* end of as.h */