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
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)
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
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
37 If TEST is #defined, then we are testing a module: #define COMMON as "". */
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 void* version for STDC case. This is to be compatible with
46 the declaration in bison.simple, used for m68k operand parsing.
48 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
55 /* Indented so that pre-ansi C compilers will ignore it, rather than
56 choke on it. Some versions of AIX require this to be the first
60 # ifndef alloca /* predefined by HP cc +Olibcalls */
61 # if !defined (__STDC__) && !defined (__hpux)
62 extern char *alloca ();
64 extern void *alloca ();
65 # endif /* __STDC__, __hpux */
68 # endif /* HAVE_ALLOCA_H */
71 /* Now, tend to the rest of the configuration. */
73 /* System include files first... */
88 #ifdef HAVE_SYS_TYPES_H
89 /* for size_t, pid_t */
90 #include <sys/types.h>
94 /* The first getopt value for machine-independent long options.
95 150 isn't special; it's just an arbitrary non-ASCII char value. */
96 #define OPTION_STD_BASE 150
97 /* The first getopt value for machine-dependent long options.
98 190 gives the standard options room to grow. */
99 #define OPTION_MD_BASE 190
104 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
105 #define __PRETTY_FUNCTION__ ((char*)0)
108 ((void) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0)))
110 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
112 /* Now GNU header files... */
113 #include "ansidecl.h"
117 #include "libiberty.h"
119 /* Define the standard progress macros. */
120 #include "progress.h"
122 /* This doesn't get taken care of anywhere. */
123 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
124 #if !defined (__GNUC__) && !defined (inline)
127 #endif /* !__MWERKS__ */
129 /* Other stuff from config.h. */
130 #ifdef NEED_DECLARATION_ENVIRON
131 extern char **environ
;
133 #ifdef NEED_DECLARATION_ERRNO
136 #ifdef NEED_DECLARATION_FFS
137 extern int ffs (int);
139 #ifdef NEED_DECLARATION_FREE
142 #ifdef NEED_DECLARATION_MALLOC
143 extern PTR
malloc ();
144 extern PTR
realloc ();
146 #ifdef NEED_DECLARATION_STRSTR
147 extern char *strstr ();
150 /* This is needed for VMS. */
151 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
152 #define unlink remove
155 /* Hack to make "gcc -Wall" not complain about obstack macros. */
156 #if !defined (memcpy) && !defined (bcopy)
157 #define bcopy(src,dest,size) memcpy (dest, src, size)
160 /* Make Saber happier on obstack.h. */
163 #define __PTR_TO_INT(P) ((int) (P))
165 #define __INT_TO_PTR(P) ((char *) (P))
169 #define __LINE__ "unknown"
170 #endif /* __LINE__ */
173 #define __FILE__ "unknown"
174 #endif /* __FILE__ */
177 #if defined GO32 || defined __MINGW32__
178 #include "fopen-bin.h"
180 #include "fopen-same.h"
185 #define EXIT_SUCCESS 0
186 #define EXIT_FAILURE 1
193 #define obstack_chunk_alloc xmalloc
194 #define obstack_chunk_free xfree
200 #define BAD_CASE(val) \
202 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
203 (long) val, __LINE__, __FILE__); \
208 /* These are assembler-wide concepts */
211 extern bfd
*stdoutput
;
212 typedef bfd_vma addressT
;
213 typedef bfd_signed_vma offsetT
;
215 typedef unsigned long addressT
;
216 typedef long offsetT
;
219 /* Type of symbol value, etc. For use in prototypes. */
220 typedef addressT valueT
;
224 #define COMMON /* Declare our COMMONs storage here. */
226 #define COMMON extern /* Our commons live elsewhere. */
229 /* COMMON now defined */
233 #define know(p) assert(p) /* Verify our assumptions! */
234 #endif /* not yet defined */
236 #define know(p) /* know() checks are no-op.ed */
241 /* Supplies sanitised buffers to read.c.
242 Also understands printing line-number part of error messages. */
244 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
246 #ifndef BFD_ASSEMBLER
250 #define N_SEGMENTS 40
251 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
252 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
253 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
254 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
255 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
256 #define SEG_TEXT SEG_E0
257 #define SEG_DATA SEG_E1
258 #define SEG_BSS SEG_E2
259 #define SEG_LAST SEG_E39
262 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
263 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
271 SEG_GOOF
, /* Only happens if AS has a logic error. */
272 /* Invented so we don't crash printing
273 error message involving weird segment. */
274 SEG_EXPR
, /* Intermediate expression values. */
275 SEG_DEBUG
, /* Debug segment */
276 SEG_NTV
, /* Transfert vector preload segment. */
277 SEG_PTV
, /* Transfert vector postload segment. */
278 SEG_REGISTER
/* Mythical: a register-valued expression. */
281 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
283 typedef asection
*segT
;
284 #define SEG_NORMAL(SEG) ( (SEG) != absolute_section \
285 && (SEG) != undefined_section \
286 && (SEG) != reg_section \
287 && (SEG) != expr_section)
291 /* What subseg we are accessing now? */
292 COMMON subsegT now_subseg
;
294 /* Segment our instructions emit to. */
298 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
300 extern char const *const seg_name
[];
301 #define segment_name(SEG) seg_name[(int) (SEG)]
304 #ifndef BFD_ASSEMBLER
305 extern int section_alignment
[];
309 extern segT reg_section
, expr_section
;
310 /* Shouldn't these be eliminated someday? */
311 extern segT text_section
, data_section
, bss_section
;
312 #define absolute_section bfd_abs_section_ptr
313 #define undefined_section bfd_und_section_ptr
315 #define reg_section SEG_REGISTER
316 #define expr_section SEG_EXPR
317 #define text_section SEG_TEXT
318 #define data_section SEG_DATA
319 #define bss_section SEG_BSS
320 #define absolute_section SEG_ABSOLUTE
321 #define undefined_section SEG_UNKNOWN
327 /* Dummy frag used by listing code. */
330 /* Variable chars to be repeated fr_offset times.
331 Fr_symbol unused. Used with fr_offset == 0 for a
332 constant length frag. */
335 /* Align. The fr_offset field holds the power of 2 to which to
336 align. The fr_var field holds the number of characters in the
337 fill pattern. The fr_subtype field holds the maximum number of
338 bytes to skip when aligning, or 0 if there is no maximum. */
341 /* Align code. The fr_offset field holds the power of 2 to which
342 to align. This type is only generated by machine specific
343 code, which is normally responsible for handling the fill
344 pattern. The fr_subtype field holds the maximum number of
345 bytes to skip when aligning, or 0 if there is no maximum. */
348 /* Test for alignment. Like rs_align, but used by several targets
349 to warn if data is not properly aligned. */
352 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
356 #ifndef WORKING_DOT_WORD
361 /* Machine specific relaxable (or similarly alterable) instruction. */
362 rs_machine_dependent
,
364 /* .space directive with expression operand that needs to be computed
365 later. Similar to rs_org, but different.
367 1 variable char: fill character */
370 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
371 unsigned, 1 for signed. */
374 /* Exception frame information which we may be able to optimize. */
377 /* Cross-fragment dwarf2 line number optimization. */
381 typedef enum _relax_state relax_stateT
;
383 /* This type is used in prototypes, so it can't be a type that will be
384 widened for argument passing. */
385 typedef unsigned int relax_substateT
;
387 /* Enough bits for address, but still an integer type.
388 Could be a problem, cross-assembling for 64-bit machines. */
389 typedef addressT relax_addressT
;
393 /* Forward reach. Signed number. > 0. */
395 /* Backward reach. Signed number. < 0. */
396 offsetT rlx_backward
;
398 /* Bytes length of this address. */
399 unsigned char rlx_length
;
401 /* Next longer relax-state. 0 means there is no 'next' relax-state. */
402 relax_substateT rlx_more
;
405 typedef struct relax_type relax_typeS
;
407 /* main program "as.c" (command arguments etc). */
409 COMMON
unsigned char flag_no_comments
; /* -f */
410 COMMON
unsigned char flag_debug
; /* -D */
411 COMMON
unsigned char flag_signed_overflow_ok
; /* -J */
412 #ifndef WORKING_DOT_WORD
413 COMMON
unsigned char flag_warn_displacement
; /* -K */
416 /* True if local symbols should be retained. */
417 COMMON
int flag_keep_locals
; /* -L */
419 /* True if we are assembling in MRI mode. */
422 /* Should the data section be made read-only and appended to the text
424 COMMON
unsigned char flag_readonly_data_in_text
; /* -R */
426 /* True if warnings should be inhibited. */
427 COMMON
int flag_no_warnings
; /* -W */
429 /* True if warnings count as errors. */
430 COMMON
int flag_fatal_warnings
; /* --fatal-warnings */
432 /* True if we should attempt to generate output even if non-fatal errors
434 COMMON
unsigned char flag_always_generate_output
; /* -Z */
436 /* This is true if the assembler should output time and space usage. */
437 COMMON
unsigned char flag_print_statistics
;
439 /* True if local absolute symbols are to be stripped. */
440 COMMON
int flag_strip_local_absolute
;
442 /* True if we should generate a traditional format object file. */
443 COMMON
int flag_traditional_format
;
445 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
446 COMMON
int flag_execstack
;
448 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
449 COMMON
int flag_noexecstack
;
451 /* name of emitted object file */
452 COMMON
char *out_file_name
;
454 /* name of file defining extensions to the basic instruction set */
455 COMMON
char *insttbl_file_name
;
457 /* TRUE if we need a second pass. */
458 COMMON
int need_pass_2
;
460 /* TRUE if we should do no relaxing, and
461 leave lots of padding. */
462 COMMON
int linkrelax
;
464 /* TRUE if we should produce a listing. */
467 /* Type of debugging information we should generate. We currently support
468 stabs, ECOFF, and DWARF2.
470 NOTE! This means debug information about the assembly source code itself
471 and _not_ about possible debug information from a high-level language.
472 This is especially relevant to DWARF2, since the compiler may emit line
473 number directives that the assembler resolves. */
485 extern enum debug_info_type debug_type
;
486 extern int use_gnu_debug_info_extensions
;
488 /* Maximum level of macro nesting. */
489 extern int max_macro_nest
;
491 /* Verbosity level. */
494 /* Obstack chunk size. Keep large for efficient space use, make small to
495 increase malloc calls for monitoring memory allocation. */
496 extern int chunksize
;
500 /* assembler mnemonic, lower case, no '.' */
501 const char *poc_name
;
503 void (*poc_handler
) (int);
504 /* Value to pass to handler */
508 typedef struct _pseudo_type pseudo_typeS
;
510 /* Prefer varargs for non-ANSI compiler, since some will barf if the
511 ellipsis definition is used with a no-arguments declaration. */
512 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
516 #if defined (HAVE_STDARG_H)
519 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
524 #if (__GNUC__ >= 2) && !defined(VMS)
525 /* for use with -Wformat */
527 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
528 /* Support for double underscores in attribute names was added in gcc
529 2.6, so avoid them if we are using an earlier version. */
530 #define __printf__ printf
531 #define __format__ format
534 #define PRINTF_LIKE(FCN) \
535 void FCN (const char *format, ...) \
536 __attribute__ ((__format__ (__printf__, 1, 2)))
537 #define PRINTF_WHERE_LIKE(FCN) \
538 void FCN (char *file, unsigned int line, const char *format, ...) \
539 __attribute__ ((__format__ (__printf__, 3, 4)))
541 #else /* __GNUC__ < 2 || defined(VMS) */
543 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
544 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, \
546 const char *format, ...)
548 #endif /* __GNUC__ < 2 || defined(VMS) */
550 #else /* ! USE_STDARG */
552 #define PRINTF_LIKE(FCN) void FCN ()
553 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
555 #endif /* ! USE_STDARG */
557 PRINTF_LIKE (as_bad
);
558 PRINTF_LIKE (as_fatal
) ATTRIBUTE_NORETURN
;
559 PRINTF_LIKE (as_tsktsk
);
560 PRINTF_LIKE (as_warn
);
561 PRINTF_WHERE_LIKE (as_bad_where
);
562 PRINTF_WHERE_LIKE (as_warn_where
);
564 void as_assert (const char *, int, const char *);
565 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN
;
566 void fprint_value (FILE *, addressT
);
567 void sprint_value (char *, addressT
);
568 int had_errors (void);
569 int had_warnings (void);
570 void as_warn_value_out_of_range (char *, offsetT
, offsetT
, offsetT
, char *, unsigned);
571 void as_bad_value_out_of_range (char *, offsetT
, offsetT
, offsetT
, char *, unsigned);
572 void print_version_id (void);
573 char * app_push (void);
574 char * atof_ieee (char *, int, LITTLENUM_TYPE
*);
575 char * input_scrub_include_file (char *, char *);
576 void input_scrub_insert_line (const char *);
577 void input_scrub_insert_file (char *);
578 char * input_scrub_new_file (char *);
579 char * input_scrub_next_buffer (char **bufp
);
580 int do_scrub_chars (int (*get
) (char *, int), char *, int);
581 int gen_to_words (LITTLENUM_TYPE
*, int, long);
583 int ignore_input (void);
584 void cond_finish_check (int);
585 void cond_exit_macro (int);
586 int seen_at_least_1_file (void);
587 void app_pop (char *);
588 void as_howmuch (FILE *);
589 void as_perror (const char *, const char *);
590 void as_where (char **, unsigned int *);
591 void bump_line_counters (void);
592 void do_scrub_begin (int);
593 void input_scrub_begin (void);
594 void input_scrub_close (void);
595 void input_scrub_end (void);
596 int new_logical_line (char *, int);
597 void subsegs_begin (void);
598 void subseg_change (segT
, int);
599 segT
subseg_new (const char *, subsegT
);
600 segT
subseg_force_new (const char *, subsegT
);
601 void subseg_set (segT
, subsegT
);
602 int subseg_text_p (segT
);
603 int seg_not_empty_p (segT
);
604 void start_dependencies (char *);
605 void register_dependency (char *);
606 void print_dependencies (void);
608 segT
subseg_get (const char *, int);
613 typedef struct symbol symbolS
;
615 typedef struct frag fragS
;
619 valueT
add_to_literal_pool (symbolS
*, valueT
, segT
, int);
622 int check_eh_frame (struct expressionS
*, unsigned int *);
623 int eh_frame_estimate_size_before_relax (fragS
*);
624 int eh_frame_relax_frag (fragS
*);
625 void eh_frame_convert_frag (fragS
*);
626 int generic_force_reloc (struct fix
*);
628 #include "expr.h" /* Before targ-*.h */
630 /* This one starts the chain of target dependant headers. */
631 #include "targ-env.h"
634 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
652 #ifdef USE_EMULATIONS
658 /* True if we are assembling in m68k MRI mode. */
659 COMMON
int flag_m68k_mri
;
661 #define flag_m68k_mri 0
665 COMMON
int warn_comment
;
666 COMMON
unsigned int found_comment
;
667 COMMON
char * found_comment_file
;
670 #ifndef NUMBERS_WITH_SUFFIX
671 #define NUMBERS_WITH_SUFFIX 0
674 #ifndef LOCAL_LABELS_DOLLAR
675 #define LOCAL_LABELS_DOLLAR 0
678 #ifndef LOCAL_LABELS_FB
679 #define LOCAL_LABELS_FB 0
682 #ifndef LABELS_WITHOUT_COLONS
683 #define LABELS_WITHOUT_COLONS 0
686 #ifndef NO_PSEUDO_DOT
687 #define NO_PSEUDO_DOT 0
690 #ifndef TEXT_SECTION_NAME
691 #define TEXT_SECTION_NAME ".text"
692 #define DATA_SECTION_NAME ".data"
693 #define BSS_SECTION_NAME ".bss"
696 #ifndef OCTETS_PER_BYTE_POWER
697 #define OCTETS_PER_BYTE_POWER 0
699 #ifndef OCTETS_PER_BYTE
700 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
702 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
703 #error "Octets per byte conflicts with its power-of-two definition!"