1 /* as.h - global header file
2 Copyright (C) 1987, 1990, 1991, 1992 Free Software Foundation, Inc.
4 This file is part of GAS, the GNU Assembler.
6 GAS is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GAS is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GAS; see the file COPYING. If not, write to
18 the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
23 * I think this stuff is largely out of date. xoxorich.
25 * CAPITALISED names are #defined.
26 * "lowercaseH" is #defined if "lowercase.h" has been #include-d.
27 * "lowercaseT" is a typedef of "lowercase" objects.
28 * "lowercaseP" is type "pointer to object of type 'lowercase'".
29 * "lowercaseS" is typedef struct ... lowercaseS.
31 * #define DEBUG to enable all the "know" assertion tests.
32 * #define SUSPECT when debugging hash code.
33 * #define COMMON as "extern" for all modules except one, where you #define
35 * If TEST is #defined, then we are testing a module: #define COMMON as "".
40 /* This is the code recommended in the autoconf documentation, almost
41 verbatim. If it doesn't work for you, let me know, and notify
42 djm@gnu.ai.mit.edu as well. */
43 /* Added #undef for DJ Delorie. The right fix is to ensure that as.h
44 is included first, before even any system header files, in all files
45 that use it. KR 1994.11.03 */
46 /* Added void* version for STDC case. This is to be compatible with
47 the declaration in bison.simple, used for m68k operand parsing.
49 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
51 /* AIX requires this to be the first thing in the file. */
54 # define alloca __builtin_alloca
62 # ifndef alloca /* predefined by HP cc +Olibcalls */
63 # if !defined (__STDC__) && !defined (__hpux)
67 # endif /* __STDC__, __hpux */
70 # endif /* HAVE_ALLOCA_H */
73 /* Now, tend to the rest of the configuration. */
75 /* System include files first... */
89 #ifdef HAVE_SYS_TYPES_H
90 /* for size_t, pid_t */
91 #include <sys/types.h>
94 /* Some systems do declare this, but this seems to be the universal
95 declaration, though the parameter type varies. (It ought to use
96 `const' but many systems prototype it without.) Include it here
97 for systems that don't declare it. If conflicts arise, just add
98 another autoconf test... */
99 extern char *strdup (/* const char * */);
102 /* The first getopt value for machine-independent long options.
103 150 isn't special; it's just an arbitrary non-ASCII char value. */
104 #define OPTION_STD_BASE 150
105 /* The first getopt value for machine-dependent long options.
106 170 gives the standard options room to grow. */
107 #define OPTION_MD_BASE 170
112 #if !defined (__GNUC__) || __GNUC_MINOR__ <= 5
113 #define __PRETTY_FUNCTION__ ((char*)0)
117 /* Handle lossage with assert.h. */
118 #ifndef BROKEN_ASSERT
120 #else /* BROKEN_ASSERT */
122 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
124 #define assert(p) ((p), 0)
126 #endif /* BROKEN_ASSERT */
130 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
132 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
137 /* Now GNU header files... */
138 #include <ansidecl.h>
143 /* Define the standard progress macros. */
144 #include <progress.h>
146 /* This doesn't get taken care of anywhere. */
147 #if !defined (__GNUC__) && !defined (inline)
151 /* Other stuff from config.h. */
152 #ifdef NEED_DECLARATION_MALLOC
153 extern PTR
malloc ();
154 extern PTR
realloc ();
156 #ifdef NEED_DECLARATION_FREE
159 #ifdef NEED_DECLARATION_ERRNO
163 /* This is needed for VMS. */
164 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
165 #define unlink remove
168 /* Hack to make "gcc -Wall" not complain about obstack macros. */
169 #if !defined (memcpy) && !defined (bcopy)
170 #define bcopy(src,dest,size) memcpy(dest,src,size)
174 /* This one doesn't get declared, but we're using it anyways. This
175 should be fixed -- either it's part of the external interface or
177 extern PTR bfd_alloc_by_size_t
PARAMS ((bfd
*abfd
, size_t sz
));
180 /* Make Saber happier on obstack.h. */
183 #define __PTR_TO_INT(P) ((int)(P))
185 #define __INT_TO_PTR(P) ((char *)(P))
189 #define __LINE__ "unknown"
190 #endif /* __LINE__ */
193 #define __FILE__ "unknown"
194 #endif /* __FILE__ */
203 #endif /* ! __STDC__ */
205 #if !defined (__GNUC__) && !defined (inline)
211 #include "fopen-bin.h"
213 #include "fopen-same.h"
218 #define EXIT_SUCCESS 0
219 #define EXIT_FAILURE 1
222 #define obstack_chunk_alloc xmalloc
223 #define obstack_chunk_free xfree
227 #define BAD_CASE(val) \
229 as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
230 (long) val, __LINE__, __FILE__); \
233 /* Version 2.1 of Solaris had problems with this declaration, but I
234 think that bug has since been fixed. If it causes problems on your
235 system, just delete it. */
236 extern char *strstr ();
240 /* These are assembler-wide concepts */
243 extern bfd
*stdoutput
;
244 typedef bfd_vma addressT
;
245 typedef bfd_signed_vma offsetT
;
247 typedef unsigned long addressT
;
248 typedef long offsetT
;
251 /* Type of symbol value, etc. For use in prototypes. */
252 typedef addressT valueT
;
256 #define COMMON /* declare our COMMONs storage here. */
258 #define COMMON extern /* our commons live elswhere */
261 /* COMMON now defined */
265 #define know(p) assert(p) /* Verify our assumptions! */
266 #endif /* not yet defined */
268 #define know(p) /* know() checks are no-op.ed */
274 * Supplies sanitised buffers to read.c.
275 * Also understands printing line-number part of error messages.
279 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
281 #ifndef BFD_ASSEMBLER
285 #define N_SEGMENTS 10
286 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E9)
287 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9
288 #define SEG_TEXT SEG_E0
289 #define SEG_DATA SEG_E1
290 #define SEG_BSS SEG_E2
293 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
294 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
302 SEG_GOOF
, /* Only happens if AS has a logic error. */
303 /* Invented so we don't crash printing */
304 /* error message involving weird segment. */
305 SEG_EXPR
, /* Intermediate expression values. */
306 SEG_DEBUG
, /* Debug segment */
307 SEG_NTV
, /* Transfert vector preload segment */
308 SEG_PTV
, /* Transfert vector postload segment */
309 SEG_REGISTER
/* Mythical: a register-valued expression */
312 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
314 typedef asection
*segT
;
315 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
316 && (SEG) != undefined_section \
317 && (SEG) != reg_section \
318 && (SEG) != expr_section)
322 /* What subseg we are accreting now? */
323 COMMON subsegT now_subseg
;
325 /* Segment our instructions emit to. */
329 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
331 extern char const *const seg_name
[];
332 #define segment_name(SEG) seg_name[(int) (SEG)]
335 #ifndef BFD_ASSEMBLER
336 extern int section_alignment
[];
340 extern segT reg_section
, expr_section
;
341 /* Shouldn't these be eliminated someday? */
342 extern segT text_section
, data_section
, bss_section
;
343 #define absolute_section bfd_abs_section_ptr
344 #define undefined_section bfd_und_section_ptr
346 #define reg_section SEG_REGISTER
347 #define expr_section SEG_EXPR
348 #define text_section SEG_TEXT
349 #define data_section SEG_DATA
350 #define bss_section SEG_BSS
351 #define absolute_section SEG_ABSOLUTE
352 #define undefined_section SEG_UNKNOWN
359 /* Variable chars to be repeated fr_offset times.
360 Fr_symbol unused. Used with fr_offset == 0 for a
361 constant length frag. */
364 /* Align: Fr_offset: power of 2. Variable chars: fill pattern. */
367 /* Align code: fr_offset: power of 2. Fill pattern is machine
368 specific, defaulting to all zeros. */
371 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
375 #ifndef WORKING_DOT_WORD
380 /* machine-specific relaxable (or similarly alterable) instruction */
381 rs_machine_dependent
,
383 /* .space directive with expression operand that needs to be computed
384 later. Similar to rs_org, but different.
386 1 variable char: fill character */
390 typedef enum _relax_state relax_stateT
;
392 /* This type is used in prototypes, so it can't be a type that will be
393 widened for argument passing. */
394 typedef unsigned int relax_substateT
;
396 /* Enough bits for address, but still an integer type.
397 Could be a problem, cross-assembling for 64-bit machines. */
398 typedef addressT relax_addressT
;
404 * A code fragment (frag) is some known number of chars, followed by some
405 * unknown number of chars. Typically the unknown number of chars is an
406 * instruction address whose size is yet unknown. We always know the greatest
407 * possible size the unknown number of chars may become, and reserve that
408 * much room at the end of the frag.
409 * Once created, frags do not change address during assembly.
410 * We chain the frags in (a) forward-linked list(s). The object-file address
411 * of the 1st char of a frag is generally not known until after relax().
412 * Many things at assembly time describe an address by {object-file-address
413 * of a particular frag}+offset.
415 BUG: it may be smarter to have a single pointer off to various different
416 notes for different frag kinds. See how code pans
420 /* Object file address. */
422 /* Chain forward; ascending address order. Rooted in frch_root. */
423 struct frag
*fr_next
;
425 /* (Fixed) number of chars we know we have. May be 0. */
427 /* (Variable) number of chars after above. May be 0. */
429 /* For variable-length tail. */
430 struct symbol
*fr_symbol
;
431 /* For variable-length tail. */
433 /* Points to opcode low addr byte, for relaxation. */
437 struct list_info_struct
*line
;
440 /* What state is my tail in? */
441 relax_stateT fr_type
;
442 relax_substateT fr_subtype
;
444 /* Track the alignment and offset of the current frag. With this,
445 sometimes we can avoid creating new frags for .align directives. */
446 unsigned short align_mask
;
447 unsigned short align_offset
;
449 /* These are needed only on the NS32K machines. But since we don't
450 include targ-cpu.h until after this structure has been defined,
451 we can't really conditionalize it. This code should be
452 rearranged a bit to make that possible.
454 In the meantime, if we get stuck like this with any other target,
455 create a union here. */
456 char fr_pcrel_adjust
, fr_bsr
;
458 /* Data begins here. */
462 #define SIZEOF_STRUCT_FRAG \
463 ((char *)zero_address_frag.fr_literal-(char *)&zero_address_frag)
464 /* We want to say fr_literal[0] above. */
466 typedef struct frag fragS
;
468 /* Current frag we are building. This frag is incomplete. It is, however,
469 included in frchain_now. The fr_fix field is bogus; instead, use:
470 obstack_next_free(&frags)-frag_now->fr_literal. */
471 COMMON fragS
*frag_now
;
472 extern int frag_now_fix ();
474 /* For foreign-segment symbol fixups. */
475 COMMON fragS zero_address_frag
;
476 /* For local common (N_BSS segment) fixups. */
477 COMMON fragS bss_address_frag
;
479 /* main program "as.c" (command arguments etc) */
481 COMMON
unsigned char flag_no_comments
; /* -f */
482 COMMON
unsigned char flag_debug
; /* -D */
483 COMMON
unsigned char flag_signed_overflow_ok
; /* -J */
484 #ifndef WORKING_DOT_WORD
485 COMMON
unsigned char flag_warn_displacement
; /* -K */
488 /* True if local symbols should be retained. */
489 COMMON
int flag_keep_locals
; /* -L */
491 /* True if we are assembling using MRI syntax. */
494 /* Should the data section be made read-only and appended to the text
496 COMMON
unsigned char flag_readonly_data_in_text
; /* -R */
498 /* True if warnings should be inhibited. */
499 COMMON
int flag_no_warnings
; /* -W */
501 /* True if we should attempt to generate output even if non-fatal errors
503 COMMON
unsigned char flag_always_generate_output
; /* -Z */
505 /* This is true if the assembler should output time and space usage. */
507 COMMON
unsigned char flag_print_statistics
;
509 /* name of emitted object file */
510 COMMON
char *out_file_name
;
512 /* TRUE if we need a second pass. */
513 COMMON
int need_pass_2
;
515 /* TRUE if we should do no relaxing, and
516 leave lots of padding. */
517 COMMON
int linkrelax
;
519 /* TRUE if we should produce a listing. */
522 /* Maximum level of macro nesting. */
523 extern int max_macro_nest
;
527 /* assembler mnemonic, lower case, no '.' */
528 const char *poc_name
;
530 void (*poc_handler
) PARAMS ((int));
531 /* Value to pass to handler */
535 typedef struct _pseudo_type pseudo_typeS
;
537 /* Prefer varargs for non-ANSI compiler, since some will barf if the
538 ellipsis definition is used with a no-arguments declaration. */
539 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
543 #if defined (HAVE_STDARG_H)
546 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
552 /* for use with -Wformat */
553 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...) \
554 __attribute__ ((format (printf, 1, 2)))
555 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, unsigned int line, \
556 const char *format, ...) \
557 __attribute__ ((format (printf, 3, 4)))
558 #else /* ANSI C with stdarg, but not GNU C */
559 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
560 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
562 const char *format, ...))
564 #else /* not using stdarg */
565 #define PRINTF_LIKE(FCN) void FCN ()
566 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
569 PRINTF_LIKE (as_bad
);
570 PRINTF_LIKE (as_fatal
);
571 PRINTF_LIKE (as_tsktsk
);
572 PRINTF_LIKE (as_warn
);
573 PRINTF_WHERE_LIKE (as_bad_where
);
574 PRINTF_WHERE_LIKE (as_warn_where
);
575 void as_assert
PARAMS ((const char *, int, const char *));
576 void as_abort
PARAMS ((const char *, int, const char *));
578 void fprint_value
PARAMS ((FILE *file
, addressT value
));
579 void sprint_value
PARAMS ((char *buf
, addressT value
));
581 int had_errors
PARAMS ((void));
582 int had_warnings
PARAMS ((void));
584 void print_version_id
PARAMS ((void));
585 char *app_push
PARAMS ((void));
586 char *atof_ieee
PARAMS ((char *str
, int what_kind
, LITTLENUM_TYPE
* words
));
587 char *input_scrub_include_file
PARAMS ((char *filename
, char *position
));
588 char *input_scrub_new_file
PARAMS ((char *filename
));
589 char *input_scrub_next_buffer
PARAMS ((char **bufp
));
590 PTR xmalloc
PARAMS ((unsigned long size
));
591 PTR xrealloc
PARAMS ((PTR ptr
, unsigned long n
));
592 int do_scrub_next_char
PARAMS ((int (*get
) (void), void (*unget
) (int)));
593 int gen_to_words
PARAMS ((LITTLENUM_TYPE
* words
, int precision
,
594 long exponent_bits
));
595 int had_err
PARAMS ((void));
596 int ignore_input
PARAMS ((void));
597 int scrub_from_file
PARAMS ((void));
598 int scrub_from_string
PARAMS ((void));
599 int seen_at_least_1_file
PARAMS ((void));
600 void app_pop
PARAMS ((char *arg
));
601 void as_howmuch
PARAMS ((FILE * stream
));
602 void as_perror
PARAMS ((const char *gripe
, const char *filename
));
603 void as_where
PARAMS ((char **namep
, unsigned int *linep
));
604 void bump_line_counters
PARAMS ((void));
605 void do_scrub_begin
PARAMS ((void));
606 void input_scrub_begin
PARAMS ((void));
607 void input_scrub_close
PARAMS ((void));
608 void input_scrub_end
PARAMS ((void));
609 void new_logical_line
PARAMS ((char *fname
, int line_number
));
610 void scrub_to_file
PARAMS ((int ch
));
611 void scrub_to_string
PARAMS ((int ch
));
612 void subsegs_begin
PARAMS ((void));
613 void subseg_change
PARAMS ((segT seg
, int subseg
));
614 segT subseg_new
PARAMS ((const char *name
, subsegT subseg
));
615 segT subseg_force_new
PARAMS ((const char *name
, subsegT subseg
));
616 void subseg_set
PARAMS ((segT seg
, subsegT subseg
));
618 segT subseg_get
PARAMS ((const char *, int));
628 valueT add_to_literal_pool
PARAMS ((struct symbol
*, valueT
, segT
, int));
631 #include "expr.h" /* Before targ-*.h */
633 /* this one starts the chain of target dependant headers */
634 #include "targ-env.h"
636 #include "struc-symbol.h"
646 #ifdef USE_EMULATIONS
651 #ifndef LOCAL_LABELS_DOLLAR
652 #define LOCAL_LABELS_DOLLAR 0
655 #ifndef LOCAL_LABELS_FB
656 #define LOCAL_LABELS_FB 0