* ltcf-cxx.sh: Added file, required by 2000-11-18 merge.
[binutils.git] / gas / as.h
blobb78b77cd74888e7fac449984d59bc5f3275b052b
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
24 /* I think this stuff is largely out of date. xoxorich.
26 * CAPITALISED names are #defined.
27 * "lowercaseH" is #defined if "lowercase.h" has been #include-d.
28 * "lowercaseT" is a typedef of "lowercase" objects.
29 * "lowercaseP" is type "pointer to object of type 'lowercase'".
30 * "lowercaseS" is typedef struct ... lowercaseS.
32 * #define DEBUG to enable all the "know" assertion tests.
33 * #define SUSPECT when debugging hash code.
34 * #define COMMON as "extern" for all modules except one, where you #define
35 * COMMON as "".
36 * 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 #undef for DJ Delorie. The right fix is to ensure that as.h
46 is included first, before even any system header files, in all files
47 that use it. KR 1994.11.03 */
48 /* Added void* version for STDC case. This is to be compatible with
49 the declaration in bison.simple, used for m68k operand parsing.
50 --KR 1995.08.08 */
51 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
53 /* AIX requires this to be the first thing in the file. */
54 #ifdef __GNUC__
55 # ifndef alloca
56 # ifdef __STDC__
57 extern void *alloca ();
58 # else
59 extern char *alloca ();
60 # endif
61 # endif
62 #else
63 # if HAVE_ALLOCA_H
64 # include <alloca.h>
65 # else
66 # ifdef _AIX
67 #pragma alloca
68 # else
69 # ifndef alloca /* predefined by HP cc +Olibcalls */
70 # if !defined (__STDC__) && !defined (__hpux)
71 extern char *alloca ();
72 # else
73 extern void *alloca ();
74 # endif /* __STDC__, __hpux */
75 # endif /* alloca */
76 # endif /* _AIX */
77 # endif /* HAVE_ALLOCA_H */
78 #endif
80 /* Now, tend to the rest of the configuration. */
82 /* System include files first... */
83 #include <stdio.h>
84 #include <ctype.h>
85 #ifdef HAVE_STRING_H
86 #include <string.h>
87 #else
88 #ifdef HAVE_STRINGS_H
89 #include <strings.h>
90 #endif
91 #endif
92 #ifdef HAVE_STDLIB_H
93 #include <stdlib.h>
94 #endif
95 #ifdef HAVE_UNISTD_H
96 #include <unistd.h>
97 #endif
98 #ifdef HAVE_SYS_TYPES_H
99 /* for size_t, pid_t */
100 #include <sys/types.h>
101 #endif
103 #include <getopt.h>
104 /* The first getopt value for machine-independent long options.
105 150 isn't special; it's just an arbitrary non-ASCII char value. */
106 #define OPTION_STD_BASE 150
107 /* The first getopt value for machine-dependent long options.
108 190 gives the standard options room to grow. */
109 #define OPTION_MD_BASE 190
111 #ifdef DEBUG
112 #undef NDEBUG
113 #endif
114 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
115 #define __PRETTY_FUNCTION__ ((char*)0)
116 #endif
117 #if 0
119 /* Handle lossage with assert.h. */
120 #ifndef BROKEN_ASSERT
121 #include <assert.h>
122 #else /* BROKEN_ASSERT */
123 #ifndef NDEBUG
124 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
125 #else
126 #define assert(p) ((p), 0)
127 #endif
128 #endif /* BROKEN_ASSERT */
130 #else
132 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
133 #undef abort
134 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
136 #endif
138 /* Now GNU header files... */
139 #include "ansidecl.h"
140 #ifdef BFD_ASSEMBLER
141 #include "bfd.h"
142 #endif
143 #include "libiberty.h"
145 /* Define the standard progress macros. */
146 #include "progress.h"
148 /* This doesn't get taken care of anywhere. */
149 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
150 #if !defined (__GNUC__) && !defined (inline)
151 #define inline
152 #endif
153 #endif /* !__MWERKS__ */
155 /* Other stuff from config.h. */
156 #ifdef NEED_DECLARATION_STRSTR
157 extern char *strstr ();
158 #endif
159 #ifdef NEED_DECLARATION_MALLOC
160 extern PTR malloc ();
161 extern PTR realloc ();
162 #endif
163 #ifdef NEED_DECLARATION_FREE
164 extern void free ();
165 #endif
166 #ifdef NEED_DECLARATION_ERRNO
167 extern int errno;
168 #endif
169 #ifdef NEED_DECLARATION_ENVIRON
170 extern char **environ;
171 #endif
173 /* This is needed for VMS. */
174 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
175 #define unlink remove
176 #endif
178 /* Hack to make "gcc -Wall" not complain about obstack macros. */
179 #if !defined (memcpy) && !defined (bcopy)
180 #define bcopy(src,dest,size) memcpy(dest,src,size)
181 #endif
183 /* Make Saber happier on obstack.h. */
184 #ifdef SABER
185 #undef __PTR_TO_INT
186 #define __PTR_TO_INT(P) ((int)(P))
187 #undef __INT_TO_PTR
188 #define __INT_TO_PTR(P) ((char *)(P))
189 #endif
191 #ifndef __LINE__
192 #define __LINE__ "unknown"
193 #endif /* __LINE__ */
195 #ifndef __FILE__
196 #define __FILE__ "unknown"
197 #endif /* __FILE__ */
199 #ifndef FOPEN_WB
200 #ifdef GO32
201 #include "fopen-bin.h"
202 #else
203 #include "fopen-same.h"
204 #endif
205 #endif
207 #ifndef EXIT_SUCCESS
208 #define EXIT_SUCCESS 0
209 #define EXIT_FAILURE 1
210 #endif
212 #ifndef SEEK_SET
213 #define SEEK_SET 0
214 #endif
216 #define obstack_chunk_alloc xmalloc
217 #define obstack_chunk_free xfree
219 #define xfree free
221 #include "asintl.h"
223 #define BAD_CASE(val) \
225 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
226 (long) val, __LINE__, __FILE__); \
229 #include "flonum.h"
231 /* These are assembler-wide concepts */
233 #ifdef BFD_ASSEMBLER
234 extern bfd *stdoutput;
235 typedef bfd_vma addressT;
236 typedef bfd_signed_vma offsetT;
237 #else
238 typedef unsigned long addressT;
239 typedef long offsetT;
240 #endif
242 /* Type of symbol value, etc. For use in prototypes. */
243 typedef addressT valueT;
245 #ifndef COMMON
246 #ifdef TEST
247 #define COMMON /* declare our COMMONs storage here. */
248 #else
249 #define COMMON extern /* our commons live elswhere */
250 #endif
251 #endif
252 /* COMMON now defined */
254 #ifdef DEBUG
255 #ifndef know
256 #define know(p) assert(p) /* Verify our assumptions! */
257 #endif /* not yet defined */
258 #else
259 #define know(p) /* know() checks are no-op.ed */
260 #endif
262 /* input_scrub.c */
264 /* Supplies sanitised buffers to read.c.
265 Also understands printing line-number part of error messages. */
267 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
269 #ifndef BFD_ASSEMBLER
271 #ifdef MANY_SEGMENTS
272 #include "bfd.h"
273 #define N_SEGMENTS 40
274 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
275 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
276 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
277 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
278 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
279 #define SEG_TEXT SEG_E0
280 #define SEG_DATA SEG_E1
281 #define SEG_BSS SEG_E2
282 #define SEG_LAST SEG_E39
283 #else
284 #define N_SEGMENTS 3
285 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
286 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
287 #endif
289 typedef enum _segT {
290 SEG_ABSOLUTE = 0,
291 SEG_LIST,
292 SEG_UNKNOWN,
293 SEG_GOOF, /* Only happens if AS has a logic error. */
294 /* Invented so we don't crash printing */
295 /* error message involving weird segment. */
296 SEG_EXPR, /* Intermediate expression values. */
297 SEG_DEBUG, /* Debug segment */
298 SEG_NTV, /* Transfert vector preload segment */
299 SEG_PTV, /* Transfert vector postload segment */
300 SEG_REGISTER /* Mythical: a register-valued expression */
301 } segT;
303 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
304 #else
305 typedef asection *segT;
306 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
307 && (SEG) != undefined_section \
308 && (SEG) != reg_section \
309 && (SEG) != expr_section)
310 #endif
311 typedef int subsegT;
313 /* What subseg we are accreting now? */
314 COMMON subsegT now_subseg;
316 /* Segment our instructions emit to. */
317 COMMON segT now_seg;
319 #ifdef BFD_ASSEMBLER
320 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
321 #else
322 extern char const *const seg_name[];
323 #define segment_name(SEG) seg_name[(int) (SEG)]
324 #endif
326 #ifndef BFD_ASSEMBLER
327 extern int section_alignment[];
328 #endif
330 #ifdef BFD_ASSEMBLER
331 extern segT reg_section, expr_section;
332 /* Shouldn't these be eliminated someday? */
333 extern segT text_section, data_section, bss_section;
334 #define absolute_section bfd_abs_section_ptr
335 #define undefined_section bfd_und_section_ptr
336 #else
337 #define reg_section SEG_REGISTER
338 #define expr_section SEG_EXPR
339 #define text_section SEG_TEXT
340 #define data_section SEG_DATA
341 #define bss_section SEG_BSS
342 #define absolute_section SEG_ABSOLUTE
343 #define undefined_section SEG_UNKNOWN
344 #endif
346 /* relax() */
348 enum _relax_state {
349 /* Variable chars to be repeated fr_offset times.
350 Fr_symbol unused. Used with fr_offset == 0 for a
351 constant length frag. */
352 rs_fill = 1,
354 /* Align. The fr_offset field holds the power of 2 to which to
355 align. The fr_var field holds the number of characters in the
356 fill pattern. The fr_subtype field holds the maximum number of
357 bytes to skip when aligning, or 0 if there is no maximum. */
358 rs_align,
360 /* Align code. The fr_offset field holds the power of 2 to which
361 to align. This type is only generated by machine specific
362 code, which is normally responsible for handling the fill
363 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_code,
367 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
368 character. */
369 rs_org,
371 #ifndef WORKING_DOT_WORD
372 /* JF: gunpoint */
373 rs_broken_word,
374 #endif
376 /* machine-specific relaxable (or similarly alterable) instruction */
377 rs_machine_dependent,
379 /* .space directive with expression operand that needs to be computed
380 later. Similar to rs_org, but different.
381 fr_symbol: operand
382 1 variable char: fill character */
383 rs_space,
385 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
386 unsigned, 1 for signed. */
387 rs_leb128,
389 /* Exception frame information which we may be able to optimize. */
390 rs_cfa
393 typedef enum _relax_state relax_stateT;
395 /* This type is used in prototypes, so it can't be a type that will be
396 widened for argument passing. */
397 typedef unsigned int relax_substateT;
399 /* Enough bits for address, but still an integer type.
400 Could be a problem, cross-assembling for 64-bit machines. */
401 typedef addressT relax_addressT;
403 /* main program "as.c" (command arguments etc) */
405 COMMON unsigned char flag_no_comments; /* -f */
406 COMMON unsigned char flag_debug; /* -D */
407 COMMON unsigned char flag_signed_overflow_ok; /* -J */
408 #ifndef WORKING_DOT_WORD
409 COMMON unsigned char flag_warn_displacement; /* -K */
410 #endif
412 /* True if local symbols should be retained. */
413 COMMON int flag_keep_locals; /* -L */
415 /* True if we are assembling in MRI mode. */
416 COMMON int flag_mri;
418 /* Should the data section be made read-only and appended to the text
419 section? */
420 COMMON unsigned char flag_readonly_data_in_text; /* -R */
422 /* True if warnings should be inhibited. */
423 COMMON int flag_no_warnings; /* -W */
425 /* True if warnings count as errors. */
426 COMMON int flag_fatal_warnings; /* --fatal-warnings */
428 /* True if we should attempt to generate output even if non-fatal errors
429 are detected. */
430 COMMON unsigned char flag_always_generate_output; /* -Z */
432 /* This is true if the assembler should output time and space usage. */
433 COMMON unsigned char flag_print_statistics;
435 /* True if local absolute symbols are to be stripped. */
436 COMMON int flag_strip_local_absolute;
438 /* True if we should generate a traditional format object file. */
439 COMMON int flag_traditional_format;
441 /* name of emitted object file */
442 COMMON char *out_file_name;
444 /* name of file defining extensions to the basic instruction set */
445 COMMON char *insttbl_file_name;
447 /* TRUE if we need a second pass. */
448 COMMON int need_pass_2;
450 /* TRUE if we should do no relaxing, and
451 leave lots of padding. */
452 COMMON int linkrelax;
454 /* TRUE if we should produce a listing. */
455 extern int listing;
457 /* Type of debugging information we should generate. We currently support
458 stabs, ECOFF, and DWARF2.
460 NOTE! This means debug information about the assembly source code itself
461 and _not_ about possible debug information from a high-level language.
462 This is especially relevant to DWARF2, since the compiler may emit line
463 number directives that the assembler resolves. */
465 enum debug_info_type {
466 DEBUG_UNSPECIFIED,
467 DEBUG_NONE,
468 DEBUG_STABS,
469 DEBUG_ECOFF,
470 DEBUG_DWARF,
471 DEBUG_DWARF2
474 extern enum debug_info_type debug_type;
476 /* Maximum level of macro nesting. */
477 extern int max_macro_nest;
479 /* Obstack chunk size. Keep large for efficient space use, make small to
480 increase malloc calls for monitoring memory allocation. */
481 extern int chunksize;
483 struct _pseudo_type {
484 /* assembler mnemonic, lower case, no '.' */
485 const char *poc_name;
486 /* Do the work */
487 void (*poc_handler) PARAMS ((int));
488 /* Value to pass to handler */
489 int poc_val;
492 typedef struct _pseudo_type pseudo_typeS;
494 /* Prefer varargs for non-ANSI compiler, since some will barf if the
495 ellipsis definition is used with a no-arguments declaration. */
496 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
497 #undef HAVE_STDARG_H
498 #endif
500 #if defined (HAVE_STDARG_H)
501 #define USE_STDARG
502 #endif
503 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
504 #define USE_VARARGS
505 #endif
507 #ifdef USE_STDARG
508 #if (__GNUC__ >= 2) && !defined(VMS)
509 /* for use with -Wformat */
511 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
512 /* Support for double underscores in attribute names was added in gcc
513 2.6, so avoid them if we are using an earlier version. */
514 #define __printf__ printf
515 #define __format__ format
516 #endif
518 #define PRINTF_LIKE(FCN) \
519 void FCN (const char *format, ...) \
520 __attribute__ ((__format__ (__printf__, 1, 2)))
521 #define PRINTF_WHERE_LIKE(FCN) \
522 void FCN (char *file, unsigned int line, const char *format, ...) \
523 __attribute__ ((__format__ (__printf__, 3, 4)))
525 #else /* __GNUC__ < 2 || defined(VMS) */
527 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
528 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
529 unsigned int line, \
530 const char *format, ...))
532 #endif /* __GNUC__ < 2 || defined(VMS) */
534 #else /* ! USE_STDARG */
536 #define PRINTF_LIKE(FCN) void FCN ()
537 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
539 #endif /* ! USE_STDARG */
541 PRINTF_LIKE (as_bad);
542 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
543 PRINTF_LIKE (as_tsktsk);
544 PRINTF_LIKE (as_warn);
545 PRINTF_WHERE_LIKE (as_bad_where);
546 PRINTF_WHERE_LIKE (as_warn_where);
548 void as_assert PARAMS ((const char *, int, const char *));
549 void as_abort PARAMS ((const char *, int, const char *)) ATTRIBUTE_NORETURN;
551 void fprint_value PARAMS ((FILE *file, addressT value));
552 void sprint_value PARAMS ((char *buf, addressT value));
554 int had_errors PARAMS ((void));
555 int had_warnings PARAMS ((void));
557 void print_version_id PARAMS ((void));
558 char *app_push PARAMS ((void));
559 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
560 char *input_scrub_include_file PARAMS ((char *filename, char *position));
561 extern void input_scrub_insert_line PARAMS((const char *line));
562 extern void input_scrub_insert_file PARAMS((char *path));
563 char *input_scrub_new_file PARAMS ((char *filename));
564 char *input_scrub_next_buffer PARAMS ((char **bufp));
565 int do_scrub_chars PARAMS ((int (*get) (char *, int), char *to, int tolen));
566 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
567 long exponent_bits));
568 int had_err PARAMS ((void));
569 int ignore_input PARAMS ((void));
570 void cond_finish_check PARAMS ((int));
571 void cond_exit_macro PARAMS ((int));
572 int seen_at_least_1_file PARAMS ((void));
573 void app_pop PARAMS ((char *arg));
574 void as_howmuch PARAMS ((FILE * stream));
575 void as_perror PARAMS ((const char *gripe, const char *filename));
576 void as_where PARAMS ((char **namep, unsigned int *linep));
577 void bump_line_counters PARAMS ((void));
578 void do_scrub_begin PARAMS ((int));
579 void input_scrub_begin PARAMS ((void));
580 void input_scrub_close PARAMS ((void));
581 void input_scrub_end PARAMS ((void));
582 int new_logical_line PARAMS ((char *fname, int line_number));
583 void subsegs_begin PARAMS ((void));
584 void subseg_change PARAMS ((segT seg, int subseg));
585 segT subseg_new PARAMS ((const char *name, subsegT subseg));
586 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
587 void subseg_set PARAMS ((segT seg, subsegT subseg));
588 #ifdef BFD_ASSEMBLER
589 segT subseg_get PARAMS ((const char *, int));
590 #endif
591 int subseg_text_p PARAMS ((segT));
593 void start_dependencies PARAMS ((char *));
594 void register_dependency PARAMS ((char *));
595 void print_dependencies PARAMS ((void));
597 struct expressionS;
598 struct fix;
599 typedef struct symbol symbolS;
600 struct relax_type;
601 typedef struct frag fragS;
603 #ifdef BFD_ASSEMBLER
604 /* literal.c */
605 valueT add_to_literal_pool PARAMS ((symbolS *, valueT, segT, int));
606 #endif
608 int check_eh_frame PARAMS ((struct expressionS *, unsigned int *));
609 int eh_frame_estimate_size_before_relax PARAMS ((fragS *));
610 int eh_frame_relax_frag PARAMS ((fragS *));
611 void eh_frame_convert_frag PARAMS ((fragS *));
613 #include "expr.h" /* Before targ-*.h */
615 /* this one starts the chain of target dependant headers */
616 #include "targ-env.h"
618 #include "write.h"
619 #include "frags.h"
620 #include "hash.h"
621 #include "read.h"
622 #include "symbols.h"
624 #include "tc.h"
625 #include "obj.h"
627 #ifdef USE_EMULATIONS
628 #include "emul.h"
629 #endif
630 #include "listing.h"
632 #ifdef TC_M68K
633 /* True if we are assembling in m68k MRI mode. */
634 COMMON int flag_m68k_mri;
635 #else
636 #define flag_m68k_mri 0
637 #endif
639 #ifdef WARN_COMMENTS
640 COMMON int warn_comment;
641 COMMON unsigned int found_comment;
642 COMMON char *found_comment_file;
643 #endif
645 #ifndef NUMBERS_WITH_SUFFIX
646 #define NUMBERS_WITH_SUFFIX 0
647 #endif
649 #ifndef LOCAL_LABELS_DOLLAR
650 #define LOCAL_LABELS_DOLLAR 0
651 #endif
653 #ifndef LOCAL_LABELS_FB
654 #define LOCAL_LABELS_FB 0
655 #endif
657 #ifndef LABELS_WITHOUT_COLONS
658 #define LABELS_WITHOUT_COLONS 0
659 #endif
661 #ifndef NO_PSEUDO_DOT
662 #define NO_PSEUDO_DOT 0
663 #endif
665 #ifndef TEXT_SECTION_NAME
666 #define TEXT_SECTION_NAME ".text"
667 #define DATA_SECTION_NAME ".data"
668 #define BSS_SECTION_NAME ".bss"
669 #endif
671 #ifndef OCTETS_PER_BYTE_POWER
672 #define OCTETS_PER_BYTE_POWER 0
673 #endif
674 #ifndef OCTETS_PER_BYTE
675 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
676 #endif
677 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
678 #error "Octets per byte conflicts with its power-of-two definition!"
679 #endif
681 #endif /* GAS */