bfd/
[binutils.git] / gas / as.h
blob56c7d2ef86b134939ad77bcd53d4a14fb4e80d9b
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, 2006, 2007
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 3, or (at your option)
11 any later version.
13 GAS is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
16 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, 51 Franklin Street - Fifth Floor, Boston, MA
21 02110-1301, 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"
41 /* This is the code recommended in the autoconf documentation, almost
42 verbatim. If it doesn't work for you, let me know, and notify
43 djm@gnu.ai.mit.edu as well. */
44 /* Added void* version for STDC case. This is to be compatible with
45 the declaration in bison.simple, used for m68k operand parsing.
46 --KR 1995.08.08 */
47 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
49 #ifndef __GNUC__
50 # if HAVE_ALLOCA_H
51 # include <alloca.h>
52 # else
53 # ifdef _AIX
54 /* Indented so that pre-ansi C compilers will ignore it, rather than
55 choke on it. Some versions of AIX require this to be the first
56 thing in the file. */
57 #pragma alloca
58 # else
59 # ifndef alloca /* predefined by HP cc +Olibcalls */
60 # if !defined (__STDC__) && !defined (__hpux)
61 extern char *alloca ();
62 # else
63 extern void *alloca ();
64 # endif /* __STDC__, __hpux */
65 # endif /* alloca */
66 # endif /* _AIX */
67 # endif /* HAVE_ALLOCA_H */
68 #endif /* __GNUC__ */
70 /* Prefer varargs for non-ANSI compiler, since some will barf if the
71 ellipsis definition is used with a no-arguments declaration. */
72 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
73 #undef HAVE_STDARG_H
74 #endif
76 #if defined (HAVE_STDARG_H)
77 #define USE_STDARG
78 #endif
79 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
80 #define USE_VARARGS
81 #endif
83 /* Now, tend to the rest of the configuration. */
85 /* System include files first... */
86 #include <stdio.h>
87 #ifdef HAVE_STRING_H
88 #include <string.h>
89 #else
90 #ifdef HAVE_STRINGS_H
91 #include <strings.h>
92 #endif
93 #endif
94 #ifdef HAVE_STDLIB_H
95 #include <stdlib.h>
96 #endif
97 #ifdef HAVE_UNISTD_H
98 #include <unistd.h>
99 #endif
100 #ifdef HAVE_SYS_TYPES_H
101 /* for size_t, pid_t */
102 #include <sys/types.h>
103 #endif
105 #ifdef HAVE_ERRNO_H
106 #include <errno.h>
107 #endif
109 #ifdef USE_STDARG
110 #include <stdarg.h>
111 #endif
113 #ifdef USE_VARARGS
114 #include <varargs.h>
115 #endif
117 #if !defined (USE_STDARG) && !defined (USE_VARARGS)
118 /* Roll our own. */
119 #define va_alist REST
120 #define va_dcl
121 typedef int * va_list;
122 #define va_start(ARGS) ARGS = &REST
123 #define va_end(ARGS)
124 #endif
126 #include "getopt.h"
127 /* The first getopt value for machine-independent long options.
128 150 isn't special; it's just an arbitrary non-ASCII char value. */
129 #define OPTION_STD_BASE 150
130 /* The first getopt value for machine-dependent long options.
131 190 gives the standard options room to grow. */
132 #define OPTION_MD_BASE 190
134 #ifdef DEBUG
135 #undef NDEBUG
136 #endif
137 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
138 #define __PRETTY_FUNCTION__ ((char*)0)
139 #endif
140 #define assert(P) \
141 ((void) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0)))
142 #undef abort
143 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
145 /* Now GNU header files... */
146 #include "ansidecl.h"
147 #include "bfd.h"
148 #include "libiberty.h"
150 /* Define the standard progress macros. */
151 #include "progress.h"
153 /* This doesn't get taken care of anywhere. */
154 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
155 #if !defined (__GNUC__) && !defined (inline)
156 #define inline
157 #endif
158 #endif /* !__MWERKS__ */
160 /* Other stuff from config.h. */
161 #ifdef NEED_DECLARATION_ENVIRON
162 extern char **environ;
163 #endif
164 #ifdef NEED_DECLARATION_ERRNO
165 extern int errno;
166 #endif
167 #ifdef NEED_DECLARATION_FFS
168 extern int ffs (int);
169 #endif
170 #ifdef NEED_DECLARATION_FREE
171 extern void free ();
172 #endif
173 #ifdef NEED_DECLARATION_MALLOC
174 extern PTR malloc ();
175 extern PTR realloc ();
176 #endif
177 #ifdef NEED_DECLARATION_STRSTR
178 extern char *strstr ();
179 #endif
181 #if !HAVE_DECL_VSNPRINTF
182 extern int vsnprintf(char *, size_t, const char *, va_list);
183 #endif
185 /* This is needed for VMS. */
186 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
187 #define unlink remove
188 #endif
190 /* Hack to make "gcc -Wall" not complain about obstack macros. */
191 #if !defined (memcpy) && !defined (bcopy)
192 #define bcopy(src,dest,size) memcpy (dest, src, size)
193 #endif
195 /* Make Saber happier on obstack.h. */
196 #ifdef SABER
197 #undef __PTR_TO_INT
198 #define __PTR_TO_INT(P) ((int) (P))
199 #undef __INT_TO_PTR
200 #define __INT_TO_PTR(P) ((char *) (P))
201 #endif
203 #ifndef __LINE__
204 #define __LINE__ "unknown"
205 #endif /* __LINE__ */
207 #ifndef __FILE__
208 #define __FILE__ "unknown"
209 #endif /* __FILE__ */
211 #ifndef FOPEN_WB
212 #ifdef USE_BINARY_FOPEN
213 #include "fopen-bin.h"
214 #else
215 #include "fopen-same.h"
216 #endif
217 #endif
219 #ifndef EXIT_SUCCESS
220 #define EXIT_SUCCESS 0
221 #define EXIT_FAILURE 1
222 #endif
224 #ifndef SEEK_SET
225 #define SEEK_SET 0
226 #endif
228 #define obstack_chunk_alloc xmalloc
229 #define obstack_chunk_free xfree
231 #define xfree free
233 #include "asintl.h"
235 #define BAD_CASE(val) \
237 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
238 (long) val, __LINE__, __FILE__); \
241 #include "flonum.h"
243 /* These are assembler-wide concepts */
245 extern bfd *stdoutput;
246 typedef bfd_vma addressT;
247 typedef bfd_signed_vma offsetT;
249 /* Type of symbol value, etc. For use in prototypes. */
250 typedef addressT valueT;
252 #ifndef COMMON
253 #ifdef TEST
254 #define COMMON /* Declare our COMMONs storage here. */
255 #else
256 #define COMMON extern /* Our commons live elsewhere. */
257 #endif
258 #endif
259 /* COMMON now defined */
261 #ifndef ENABLE_CHECKING
262 #define ENABLE_CHECKING 0
263 #endif
265 #if ENABLE_CHECKING || defined (DEBUG)
266 #ifndef know
267 #define know(p) assert(p) /* Verify our assumptions! */
268 #endif /* not yet defined */
269 #else
270 #define know(p) /* know() checks are no-op.ed */
271 #endif
273 /* input_scrub.c */
275 /* Supplies sanitised buffers to read.c.
276 Also understands printing line-number part of error messages. */
278 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
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 typedef int subsegT;
287 /* What subseg we are accessing now? */
288 COMMON subsegT now_subseg;
290 /* Segment our instructions emit to. */
291 COMMON segT now_seg;
293 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
295 extern segT reg_section, expr_section;
296 /* Shouldn't these be eliminated someday? */
297 extern segT text_section, data_section, bss_section;
298 #define absolute_section bfd_abs_section_ptr
299 #define undefined_section bfd_und_section_ptr
301 enum _relax_state
303 /* Dummy frag used by listing code. */
304 rs_dummy = 0,
306 /* Variable chars to be repeated fr_offset times.
307 Fr_symbol unused. Used with fr_offset == 0 for a
308 constant length frag. */
309 rs_fill,
311 /* Align. The fr_offset field holds the power of 2 to which to
312 align. The fr_var field holds the number of characters in the
313 fill pattern. The fr_subtype field holds the maximum number of
314 bytes to skip when aligning, or 0 if there is no maximum. */
315 rs_align,
317 /* Align code. The fr_offset field holds the power of 2 to which
318 to align. This type is only generated by machine specific
319 code, which is normally responsible for handling the fill
320 pattern. The fr_subtype field holds the maximum number of
321 bytes to skip when aligning, or 0 if there is no maximum. */
322 rs_align_code,
324 /* Test for alignment. Like rs_align, but used by several targets
325 to warn if data is not properly aligned. */
326 rs_align_test,
328 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
329 character. */
330 rs_org,
332 #ifndef WORKING_DOT_WORD
333 /* JF: gunpoint */
334 rs_broken_word,
335 #endif
337 /* Machine specific relaxable (or similarly alterable) instruction. */
338 rs_machine_dependent,
340 /* .space directive with expression operand that needs to be computed
341 later. Similar to rs_org, but different.
342 fr_symbol: operand
343 1 variable char: fill character */
344 rs_space,
346 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
347 unsigned, 1 for signed. */
348 rs_leb128,
350 /* Exception frame information which we may be able to optimize. */
351 rs_cfa,
353 /* Cross-fragment dwarf2 line number optimization. */
354 rs_dwarf2dbg
357 typedef enum _relax_state relax_stateT;
359 /* This type is used in prototypes, so it can't be a type that will be
360 widened for argument passing. */
361 typedef unsigned int relax_substateT;
363 /* Enough bits for address, but still an integer type.
364 Could be a problem, cross-assembling for 64-bit machines. */
365 typedef addressT relax_addressT;
367 struct relax_type
369 /* Forward reach. Signed number. > 0. */
370 offsetT rlx_forward;
371 /* Backward reach. Signed number. < 0. */
372 offsetT rlx_backward;
374 /* Bytes length of this address. */
375 unsigned char rlx_length;
377 /* Next longer relax-state. 0 means there is no 'next' relax-state. */
378 relax_substateT rlx_more;
381 typedef struct relax_type relax_typeS;
383 /* main program "as.c" (command arguments etc). */
385 COMMON unsigned char flag_no_comments; /* -f */
386 COMMON unsigned char flag_debug; /* -D */
387 COMMON unsigned char flag_signed_overflow_ok; /* -J */
388 #ifndef WORKING_DOT_WORD
389 COMMON unsigned char flag_warn_displacement; /* -K */
390 #endif
392 /* True if local symbols should be retained. */
393 COMMON int flag_keep_locals; /* -L */
395 /* True if we are assembling in MRI mode. */
396 COMMON int flag_mri;
398 /* Should the data section be made read-only and appended to the text
399 section? */
400 COMMON unsigned char flag_readonly_data_in_text; /* -R */
402 /* True if warnings should be inhibited. */
403 COMMON int flag_no_warnings; /* -W */
405 /* True if warnings count as errors. */
406 COMMON int flag_fatal_warnings; /* --fatal-warnings */
408 /* True if we should attempt to generate output even if non-fatal errors
409 are detected. */
410 COMMON unsigned char flag_always_generate_output; /* -Z */
412 /* This is true if the assembler should output time and space usage. */
413 COMMON unsigned char flag_print_statistics;
415 /* True if local absolute symbols are to be stripped. */
416 COMMON int flag_strip_local_absolute;
418 /* True if we should generate a traditional format object file. */
419 COMMON int flag_traditional_format;
421 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
422 COMMON int flag_execstack;
424 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
425 COMMON int flag_noexecstack;
427 /* name of emitted object file */
428 COMMON char *out_file_name;
430 /* name of file defining extensions to the basic instruction set */
431 COMMON char *insttbl_file_name;
433 /* TRUE if we need a second pass. */
434 COMMON int need_pass_2;
436 /* TRUE if we should do no relaxing, and
437 leave lots of padding. */
438 COMMON int linkrelax;
440 /* TRUE if we should produce a listing. */
441 extern int listing;
443 /* Type of debugging information we should generate. We currently support
444 stabs, ECOFF, and DWARF2.
446 NOTE! This means debug information about the assembly source code itself
447 and _not_ about possible debug information from a high-level language.
448 This is especially relevant to DWARF2, since the compiler may emit line
449 number directives that the assembler resolves. */
451 enum debug_info_type
453 DEBUG_UNSPECIFIED,
454 DEBUG_NONE,
455 DEBUG_STABS,
456 DEBUG_ECOFF,
457 DEBUG_DWARF,
458 DEBUG_DWARF2
461 extern enum debug_info_type debug_type;
462 extern int use_gnu_debug_info_extensions;
464 /* Maximum level of macro nesting. */
465 extern int max_macro_nest;
467 /* Verbosity level. */
468 extern int verbose;
470 /* Obstack chunk size. Keep large for efficient space use, make small to
471 increase malloc calls for monitoring memory allocation. */
472 extern int chunksize;
474 struct _pseudo_type
476 /* assembler mnemonic, lower case, no '.' */
477 const char *poc_name;
478 /* Do the work */
479 void (*poc_handler) (int);
480 /* Value to pass to handler */
481 int poc_val;
484 typedef struct _pseudo_type pseudo_typeS;
486 #ifdef USE_STDARG
487 #if (__GNUC__ >= 2) && !defined(VMS)
488 /* for use with -Wformat */
490 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
491 /* Support for double underscores in attribute names was added in gcc
492 2.6, so avoid them if we are using an earlier version. */
493 #define __printf__ printf
494 #define __format__ format
495 #endif
497 #define PRINTF_LIKE(FCN) \
498 void FCN (const char *format, ...) \
499 __attribute__ ((__format__ (__printf__, 1, 2)))
500 #define PRINTF_WHERE_LIKE(FCN) \
501 void FCN (char *file, unsigned int line, const char *format, ...) \
502 __attribute__ ((__format__ (__printf__, 3, 4)))
504 #else /* __GNUC__ < 2 || defined(VMS) */
506 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
507 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, \
508 unsigned int line, \
509 const char *format, ...)
511 #endif /* __GNUC__ < 2 || defined(VMS) */
513 #else /* ! USE_STDARG */
515 #define PRINTF_LIKE(FCN) void FCN ()
516 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
518 #endif /* ! USE_STDARG */
520 PRINTF_LIKE (as_bad);
521 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
522 PRINTF_LIKE (as_tsktsk);
523 PRINTF_LIKE (as_warn);
524 PRINTF_WHERE_LIKE (as_bad_where);
525 PRINTF_WHERE_LIKE (as_warn_where);
527 void as_assert (const char *, int, const char *);
528 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
529 void sprint_value (char *, addressT);
530 int had_errors (void);
531 int had_warnings (void);
532 void as_warn_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
533 void as_bad_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
534 void print_version_id (void);
535 char * app_push (void);
536 char * atof_ieee (char *, int, LITTLENUM_TYPE *);
537 char * ieee_md_atof (int, char *, int *, bfd_boolean);
538 char * vax_md_atof (int, char *, int *);
539 char * input_scrub_include_file (char *, char *);
540 void input_scrub_insert_line (const char *);
541 void input_scrub_insert_file (char *);
542 char * input_scrub_new_file (char *);
543 char * input_scrub_next_buffer (char **bufp);
544 int do_scrub_chars (int (*get) (char *, int), char *, int);
545 int gen_to_words (LITTLENUM_TYPE *, int, long);
546 int had_err (void);
547 int ignore_input (void);
548 void cond_finish_check (int);
549 void cond_exit_macro (int);
550 int seen_at_least_1_file (void);
551 void app_pop (char *);
552 void as_where (char **, unsigned int *);
553 void bump_line_counters (void);
554 void do_scrub_begin (int);
555 void input_scrub_begin (void);
556 void input_scrub_close (void);
557 void input_scrub_end (void);
558 int new_logical_line (char *, int);
559 int new_logical_line_flags (char *, int, int);
560 void subsegs_begin (void);
561 void subseg_change (segT, int);
562 segT subseg_new (const char *, subsegT);
563 segT subseg_force_new (const char *, subsegT);
564 void subseg_set (segT, subsegT);
565 int subseg_text_p (segT);
566 int seg_not_empty_p (segT);
567 void start_dependencies (char *);
568 void register_dependency (char *);
569 void print_dependencies (void);
570 segT subseg_get (const char *, int);
572 const char *remap_debug_filename (const char *);
573 void add_debug_prefix_map (const char *);
575 struct expressionS;
576 struct fix;
577 typedef struct symbol symbolS;
578 typedef struct frag fragS;
580 /* literal.c */
581 valueT add_to_literal_pool (symbolS *, valueT, segT, int);
583 int check_eh_frame (struct expressionS *, unsigned int *);
584 int eh_frame_estimate_size_before_relax (fragS *);
585 int eh_frame_relax_frag (fragS *);
586 void eh_frame_convert_frag (fragS *);
587 int generic_force_reloc (struct fix *);
589 #include "expr.h" /* Before targ-*.h */
591 /* This one starts the chain of target dependant headers. */
592 #include "targ-env.h"
594 #ifdef OBJ_MAYBE_ELF
595 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
596 #else
597 #ifdef OBJ_ELF
598 #define IS_ELF 1
599 #else
600 #define IS_ELF 0
601 #endif
602 #endif
604 #include "write.h"
605 #include "frags.h"
606 #include "hash.h"
607 #include "read.h"
608 #include "symbols.h"
610 #include "tc.h"
611 #include "obj.h"
613 #ifdef USE_EMULATIONS
614 #include "emul.h"
615 #endif
616 #include "listing.h"
618 #ifdef TC_M68K
619 /* True if we are assembling in m68k MRI mode. */
620 COMMON int flag_m68k_mri;
621 #define DOLLAR_AMBIGU flag_m68k_mri
622 #else
623 #define flag_m68k_mri 0
624 #endif
626 #ifdef WARN_COMMENTS
627 COMMON int warn_comment;
628 COMMON unsigned int found_comment;
629 COMMON char * found_comment_file;
630 #endif
632 #ifndef DOLLAR_AMBIGU
633 #define DOLLAR_AMBIGU 0
634 #endif
636 #ifndef NUMBERS_WITH_SUFFIX
637 #define NUMBERS_WITH_SUFFIX 0
638 #endif
640 #ifndef LOCAL_LABELS_DOLLAR
641 #define LOCAL_LABELS_DOLLAR 0
642 #endif
644 #ifndef LOCAL_LABELS_FB
645 #define LOCAL_LABELS_FB 0
646 #endif
648 #ifndef LABELS_WITHOUT_COLONS
649 #define LABELS_WITHOUT_COLONS 0
650 #endif
652 #ifndef NO_PSEUDO_DOT
653 #define NO_PSEUDO_DOT 0
654 #endif
656 #ifndef TEXT_SECTION_NAME
657 #define TEXT_SECTION_NAME ".text"
658 #define DATA_SECTION_NAME ".data"
659 #define BSS_SECTION_NAME ".bss"
660 #endif
662 #ifndef OCTETS_PER_BYTE_POWER
663 #define OCTETS_PER_BYTE_POWER 0
664 #endif
665 #ifndef OCTETS_PER_BYTE
666 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
667 #endif
668 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
669 #error "Octets per byte conflicts with its power-of-two definition!"
670 #endif
672 #endif /* GAS */