bfd/
[binutils/dougsmingw.git] / gas / as.h
blobc670536b9fcc087ddf68da6d6d62b3f20856771e
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, 2008, 2009
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 "alloca-conf.h"
41 /* Prefer varargs for non-ANSI compiler, since some will barf if the
42 ellipsis definition is used with a no-arguments declaration. */
43 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
44 #undef HAVE_STDARG_H
45 #endif
47 #if defined (HAVE_STDARG_H)
48 #define USE_STDARG
49 #endif
50 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
51 #define USE_VARARGS
52 #endif
54 /* Now, tend to the rest of the configuration. */
56 /* System include files first... */
57 #include <stdio.h>
58 #ifdef HAVE_STRING_H
59 #include <string.h>
60 #else
61 #ifdef HAVE_STRINGS_H
62 #include <strings.h>
63 #endif
64 #endif
65 #ifdef HAVE_STDLIB_H
66 #include <stdlib.h>
67 #endif
68 #ifdef HAVE_UNISTD_H
69 #include <unistd.h>
70 #endif
71 #ifdef HAVE_SYS_TYPES_H
72 /* for size_t, pid_t */
73 #include <sys/types.h>
74 #endif
76 #ifdef HAVE_ERRNO_H
77 #include <errno.h>
78 #endif
80 #ifdef USE_STDARG
81 #include <stdarg.h>
82 #endif
84 #ifdef USE_VARARGS
85 #include <varargs.h>
86 #endif
88 #if !defined (USE_STDARG) && !defined (USE_VARARGS)
89 /* Roll our own. */
90 #define va_alist REST
91 #define va_dcl
92 typedef int * va_list;
93 #define va_start(ARGS) ARGS = &REST
94 #define va_end(ARGS)
95 #endif
97 #include "getopt.h"
98 /* The first getopt value for machine-independent long options.
99 150 isn't special; it's just an arbitrary non-ASCII char value. */
100 #define OPTION_STD_BASE 150
101 /* The first getopt value for machine-dependent long options.
102 190 gives the standard options room to grow. */
103 #define OPTION_MD_BASE 190
105 #ifdef DEBUG
106 #undef NDEBUG
107 #endif
108 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
109 #define __PRETTY_FUNCTION__ ((char *) NULL)
110 #endif
111 #define gas_assert(P) \
112 ((void) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0)))
113 #undef abort
114 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
116 /* Now GNU header files... */
117 #include "ansidecl.h"
118 #include "bfd.h"
119 #include "libiberty.h"
121 /* Define the standard progress macros. */
122 #include "progress.h"
124 /* This doesn't get taken care of anywhere. */
125 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
126 #if !defined (__GNUC__) && !defined (inline)
127 #define inline
128 #endif
129 #endif /* !__MWERKS__ */
131 /* Other stuff from config.h. */
132 #ifdef NEED_DECLARATION_ENVIRON
133 extern char **environ;
134 #endif
135 #ifdef NEED_DECLARATION_ERRNO
136 extern int errno;
137 #endif
138 #ifdef NEED_DECLARATION_FFS
139 extern int ffs (int);
140 #endif
141 #ifdef NEED_DECLARATION_FREE
142 extern void free ();
143 #endif
144 #ifdef NEED_DECLARATION_MALLOC
145 extern void *malloc ();
146 extern void *realloc ();
147 #endif
148 #ifdef NEED_DECLARATION_STRSTR
149 extern char *strstr ();
150 #endif
152 #if !HAVE_DECL_MEMPCPY
153 void *mempcpy(void *, const void *, size_t);
154 #endif
156 #if !HAVE_DECL_VSNPRINTF
157 extern int vsnprintf(char *, size_t, const char *, va_list);
158 #endif
160 /* This is needed for VMS. */
161 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
162 #define unlink remove
163 #endif
165 /* Hack to make "gcc -Wall" not complain about obstack macros. */
166 #if !defined (memcpy) && !defined (bcopy)
167 #define bcopy(src,dest,size) memcpy (dest, src, size)
168 #endif
170 /* Make Saber happier on obstack.h. */
171 #ifdef SABER
172 #undef __PTR_TO_INT
173 #define __PTR_TO_INT(P) ((int) (P))
174 #undef __INT_TO_PTR
175 #define __INT_TO_PTR(P) ((char *) (P))
176 #endif
178 #ifndef __LINE__
179 #define __LINE__ "unknown"
180 #endif /* __LINE__ */
182 #ifndef __FILE__
183 #define __FILE__ "unknown"
184 #endif /* __FILE__ */
186 #ifndef FOPEN_WB
187 #ifdef USE_BINARY_FOPEN
188 #include "fopen-bin.h"
189 #else
190 #include "fopen-same.h"
191 #endif
192 #endif
194 #ifndef EXIT_SUCCESS
195 #define EXIT_SUCCESS 0
196 #define EXIT_FAILURE 1
197 #endif
199 #ifndef SEEK_SET
200 #define SEEK_SET 0
201 #endif
203 #define obstack_chunk_alloc xmalloc
204 #define obstack_chunk_free xfree
206 #define xfree free
208 #include "asintl.h"
210 #define BAD_CASE(val) \
212 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
213 (long) val, __LINE__, __FILE__); \
216 #include "flonum.h"
218 /* These are assembler-wide concepts */
220 extern bfd *stdoutput;
221 typedef bfd_vma addressT;
222 typedef bfd_signed_vma offsetT;
224 /* Type of symbol value, etc. For use in prototypes. */
225 typedef addressT valueT;
227 #ifndef COMMON
228 #ifdef TEST
229 #define COMMON /* Declare our COMMONs storage here. */
230 #else
231 #define COMMON extern /* Our commons live elsewhere. */
232 #endif
233 #endif
234 /* COMMON now defined */
236 #ifndef ENABLE_CHECKING
237 #define ENABLE_CHECKING 0
238 #endif
240 #if ENABLE_CHECKING || defined (DEBUG)
241 #ifndef know
242 #define know(p) gas_assert(p) /* Verify our assumptions! */
243 #endif /* not yet defined */
244 #else
245 #define know(p) do {} while (0) /* know() checks are no-op.ed */
246 #endif
248 /* input_scrub.c */
250 /* Supplies sanitised buffers to read.c.
251 Also understands printing line-number part of error messages. */
253 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
255 typedef asection *segT;
256 #define SEG_NORMAL(SEG) ( (SEG) != absolute_section \
257 && (SEG) != undefined_section \
258 && (SEG) != reg_section \
259 && (SEG) != expr_section)
260 typedef int subsegT;
262 /* What subseg we are accessing now? */
263 COMMON subsegT now_subseg;
265 /* Segment our instructions emit to. */
266 COMMON segT now_seg;
268 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
270 extern segT reg_section, expr_section;
271 /* Shouldn't these be eliminated someday? */
272 extern segT text_section, data_section, bss_section;
273 #define absolute_section bfd_abs_section_ptr
274 #define undefined_section bfd_und_section_ptr
276 enum _relax_state
278 /* Dummy frag used by listing code. */
279 rs_dummy = 0,
281 /* Variable chars to be repeated fr_offset times.
282 Fr_symbol unused. Used with fr_offset == 0 for a
283 constant length frag. */
284 rs_fill,
286 /* Align. The fr_offset field holds the power of 2 to which to
287 align. The fr_var field holds the number of characters in the
288 fill pattern. The fr_subtype field holds the maximum number of
289 bytes to skip when aligning, or 0 if there is no maximum. */
290 rs_align,
292 /* Align code. The fr_offset field holds the power of 2 to which
293 to align. This type is only generated by machine specific
294 code, which is normally responsible for handling the fill
295 pattern. The fr_subtype field holds the maximum number of
296 bytes to skip when aligning, or 0 if there is no maximum. */
297 rs_align_code,
299 /* Test for alignment. Like rs_align, but used by several targets
300 to warn if data is not properly aligned. */
301 rs_align_test,
303 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
304 character. */
305 rs_org,
307 #ifndef WORKING_DOT_WORD
308 /* JF: gunpoint */
309 rs_broken_word,
310 #endif
312 /* Machine specific relaxable (or similarly alterable) instruction. */
313 rs_machine_dependent,
315 /* .space directive with expression operand that needs to be computed
316 later. Similar to rs_org, but different.
317 fr_symbol: operand
318 1 variable char: fill character */
319 rs_space,
321 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
322 unsigned, 1 for signed. */
323 rs_leb128,
325 /* Exception frame information which we may be able to optimize. */
326 rs_cfa,
328 /* Cross-fragment dwarf2 line number optimization. */
329 rs_dwarf2dbg
332 typedef enum _relax_state relax_stateT;
334 /* This type is used in prototypes, so it can't be a type that will be
335 widened for argument passing. */
336 typedef unsigned int relax_substateT;
338 /* Enough bits for address, but still an integer type.
339 Could be a problem, cross-assembling for 64-bit machines. */
340 typedef addressT relax_addressT;
342 struct relax_type
344 /* Forward reach. Signed number. > 0. */
345 offsetT rlx_forward;
346 /* Backward reach. Signed number. < 0. */
347 offsetT rlx_backward;
349 /* Bytes length of this address. */
350 unsigned char rlx_length;
352 /* Next longer relax-state. 0 means there is no 'next' relax-state. */
353 relax_substateT rlx_more;
356 typedef struct relax_type relax_typeS;
358 /* main program "as.c" (command arguments etc). */
360 COMMON unsigned char flag_no_comments; /* -f */
361 COMMON unsigned char flag_debug; /* -D */
362 COMMON unsigned char flag_signed_overflow_ok; /* -J */
363 #ifndef WORKING_DOT_WORD
364 COMMON unsigned char flag_warn_displacement; /* -K */
365 #endif
367 /* True if local symbols should be retained. */
368 COMMON int flag_keep_locals; /* -L */
370 /* True if we are assembling in MRI mode. */
371 COMMON int flag_mri;
373 /* Should the data section be made read-only and appended to the text
374 section? */
375 COMMON unsigned char flag_readonly_data_in_text; /* -R */
377 /* True if warnings should be inhibited. */
378 COMMON int flag_no_warnings; /* -W */
380 /* True if warnings count as errors. */
381 COMMON int flag_fatal_warnings; /* --fatal-warnings */
383 /* True if we should attempt to generate output even if non-fatal errors
384 are detected. */
385 COMMON unsigned char flag_always_generate_output; /* -Z */
387 /* This is true if the assembler should output time and space usage. */
388 COMMON unsigned char flag_print_statistics;
390 /* True if local absolute symbols are to be stripped. */
391 COMMON int flag_strip_local_absolute;
393 /* True if we should generate a traditional format object file. */
394 COMMON int flag_traditional_format;
396 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
397 COMMON int flag_execstack;
399 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
400 COMMON int flag_noexecstack;
402 /* name of emitted object file */
403 COMMON char *out_file_name;
405 /* name of file defining extensions to the basic instruction set */
406 COMMON char *insttbl_file_name;
408 /* TRUE if we need a second pass. */
409 COMMON int need_pass_2;
411 /* TRUE if we should do no relaxing, and
412 leave lots of padding. */
413 COMMON int linkrelax;
415 /* TRUE if we should produce a listing. */
416 extern int listing;
418 /* Type of debugging information we should generate. We currently support
419 stabs, ECOFF, and DWARF2.
421 NOTE! This means debug information about the assembly source code itself
422 and _not_ about possible debug information from a high-level language.
423 This is especially relevant to DWARF2, since the compiler may emit line
424 number directives that the assembler resolves. */
426 enum debug_info_type
428 DEBUG_UNSPECIFIED,
429 DEBUG_NONE,
430 DEBUG_STABS,
431 DEBUG_ECOFF,
432 DEBUG_DWARF,
433 DEBUG_DWARF2
436 extern enum debug_info_type debug_type;
437 extern int use_gnu_debug_info_extensions;
439 /* Maximum level of macro nesting. */
440 extern int max_macro_nest;
442 /* Verbosity level. */
443 extern int verbose;
445 /* Obstack chunk size. Keep large for efficient space use, make small to
446 increase malloc calls for monitoring memory allocation. */
447 extern int chunksize;
449 struct _pseudo_type
451 /* assembler mnemonic, lower case, no '.' */
452 const char *poc_name;
453 /* Do the work */
454 void (*poc_handler) (int);
455 /* Value to pass to handler */
456 int poc_val;
459 typedef struct _pseudo_type pseudo_typeS;
461 #ifdef USE_STDARG
462 #if (__GNUC__ >= 2) && !defined(VMS)
463 /* for use with -Wformat */
465 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
466 /* Support for double underscores in attribute names was added in gcc
467 2.6, so avoid them if we are using an earlier version. */
468 #define __printf__ printf
469 #define __format__ format
470 #endif
472 #define PRINTF_LIKE(FCN) \
473 void FCN (const char *format, ...) \
474 __attribute__ ((__format__ (__printf__, 1, 2)))
475 #define PRINTF_WHERE_LIKE(FCN) \
476 void FCN (char *file, unsigned int line, const char *format, ...) \
477 __attribute__ ((__format__ (__printf__, 3, 4)))
479 #else /* __GNUC__ < 2 || defined(VMS) */
481 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
482 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, \
483 unsigned int line, \
484 const char *format, ...)
486 #endif /* __GNUC__ < 2 || defined(VMS) */
488 #else /* ! USE_STDARG */
490 #define PRINTF_LIKE(FCN) void FCN ()
491 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
493 #endif /* ! USE_STDARG */
495 PRINTF_LIKE (as_bad);
496 PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
497 PRINTF_LIKE (as_tsktsk);
498 PRINTF_LIKE (as_warn);
499 PRINTF_WHERE_LIKE (as_bad_where);
500 PRINTF_WHERE_LIKE (as_warn_where);
502 void as_assert (const char *, int, const char *);
503 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
504 void sprint_value (char *, addressT);
505 int had_errors (void);
506 int had_warnings (void);
507 void as_warn_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
508 void as_bad_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
509 void print_version_id (void);
510 char * app_push (void);
511 char * atof_ieee (char *, int, LITTLENUM_TYPE *);
512 char * ieee_md_atof (int, char *, int *, bfd_boolean);
513 char * vax_md_atof (int, char *, int *);
514 char * input_scrub_include_file (char *, char *);
515 void input_scrub_insert_line (const char *);
516 void input_scrub_insert_file (char *);
517 char * input_scrub_new_file (char *);
518 char * input_scrub_next_buffer (char **bufp);
519 int do_scrub_chars (int (*get) (char *, int), char *, int);
520 int gen_to_words (LITTLENUM_TYPE *, int, long);
521 int had_err (void);
522 int ignore_input (void);
523 void cond_finish_check (int);
524 void cond_exit_macro (int);
525 int seen_at_least_1_file (void);
526 void app_pop (char *);
527 void as_where (char **, unsigned int *);
528 void bump_line_counters (void);
529 void do_scrub_begin (int);
530 void input_scrub_begin (void);
531 void input_scrub_close (void);
532 void input_scrub_end (void);
533 int new_logical_line (char *, int);
534 int new_logical_line_flags (char *, int, int);
535 void subsegs_begin (void);
536 void subseg_change (segT, int);
537 segT subseg_new (const char *, subsegT);
538 segT subseg_force_new (const char *, subsegT);
539 void subseg_set (segT, subsegT);
540 int subseg_text_p (segT);
541 int seg_not_empty_p (segT);
542 void start_dependencies (char *);
543 void register_dependency (char *);
544 void print_dependencies (void);
545 segT subseg_get (const char *, int);
547 const char *remap_debug_filename (const char *);
548 void add_debug_prefix_map (const char *);
550 struct expressionS;
551 struct fix;
552 typedef struct symbol symbolS;
553 typedef struct frag fragS;
555 /* literal.c */
556 valueT add_to_literal_pool (symbolS *, valueT, segT, int);
558 int check_eh_frame (struct expressionS *, unsigned int *);
559 int eh_frame_estimate_size_before_relax (fragS *);
560 int eh_frame_relax_frag (fragS *);
561 void eh_frame_convert_frag (fragS *);
562 int generic_force_reloc (struct fix *);
564 #include "expr.h" /* Before targ-*.h */
566 /* This one starts the chain of target dependant headers. */
567 #include "targ-env.h"
569 #ifdef OBJ_MAYBE_ELF
570 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
571 #else
572 #ifdef OBJ_ELF
573 #define IS_ELF 1
574 #else
575 #define IS_ELF 0
576 #endif
577 #endif
579 #include "write.h"
580 #include "frags.h"
581 #include "hash.h"
582 #include "read.h"
583 #include "symbols.h"
585 #include "tc.h"
586 #include "obj.h"
588 #ifdef USE_EMULATIONS
589 #include "emul.h"
590 #endif
591 #include "listing.h"
593 #ifdef H_TICK_HEX
594 extern int enable_h_tick_hex;
595 #endif
597 #ifdef TC_M68K
598 /* True if we are assembling in m68k MRI mode. */
599 COMMON int flag_m68k_mri;
600 #define DOLLAR_AMBIGU flag_m68k_mri
601 #else
602 #define flag_m68k_mri 0
603 #endif
605 #ifdef WARN_COMMENTS
606 COMMON int warn_comment;
607 COMMON unsigned int found_comment;
608 COMMON char * found_comment_file;
609 #endif
611 #ifndef DOLLAR_AMBIGU
612 #define DOLLAR_AMBIGU 0
613 #endif
615 #ifndef NUMBERS_WITH_SUFFIX
616 #define NUMBERS_WITH_SUFFIX 0
617 #endif
619 #ifndef LOCAL_LABELS_DOLLAR
620 #define LOCAL_LABELS_DOLLAR 0
621 #endif
623 #ifndef LOCAL_LABELS_FB
624 #define LOCAL_LABELS_FB 0
625 #endif
627 #ifndef LABELS_WITHOUT_COLONS
628 #define LABELS_WITHOUT_COLONS 0
629 #endif
631 #ifndef NO_PSEUDO_DOT
632 #define NO_PSEUDO_DOT 0
633 #endif
635 #ifndef TEXT_SECTION_NAME
636 #define TEXT_SECTION_NAME ".text"
637 #define DATA_SECTION_NAME ".data"
638 #define BSS_SECTION_NAME ".bss"
639 #endif
641 #ifndef OCTETS_PER_BYTE_POWER
642 #define OCTETS_PER_BYTE_POWER 0
643 #endif
644 #ifndef OCTETS_PER_BYTE
645 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
646 #endif
647 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
648 #error "Octets per byte conflicts with its power-of-two definition!"
649 #endif
651 #endif /* GAS */