1 /* as.h - global header file
2 Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 1996
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)
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
19 the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
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
36 * If TEST is #defined, then we are testing a module: #define COMMON as "".
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
44 /* Added #undef for DJ Delorie. The right fix is to ensure that as.h
45 is included first, before even any system header files, in all files
46 that use it. KR 1994.11.03 */
47 /* Added void* version for STDC case. This is to be compatible with
48 the declaration in bison.simple, used for m68k operand parsing.
50 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
52 /* AIX requires this to be the first thing in the file. */
55 # define alloca __builtin_alloca
63 # ifndef alloca /* predefined by HP cc +Olibcalls */
64 # if !defined (__STDC__) && !defined (__hpux)
68 # endif /* __STDC__, __hpux */
71 # endif /* HAVE_ALLOCA_H */
74 /* Now, tend to the rest of the configuration. */
76 /* System include files first... */
92 #ifdef HAVE_SYS_TYPES_H
93 /* for size_t, pid_t */
94 #include <sys/types.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 170 gives the standard options room to grow. */
103 #define OPTION_MD_BASE 170
108 #if !defined (__GNUC__) || __GNUC_MINOR__ <= 5
109 #define __PRETTY_FUNCTION__ ((char*)0)
113 /* Handle lossage with assert.h. */
114 #ifndef BROKEN_ASSERT
116 #else /* BROKEN_ASSERT */
118 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
120 #define assert(p) ((p), 0)
122 #endif /* BROKEN_ASSERT */
126 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
128 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
133 /* Now GNU header files... */
134 #include <ansidecl.h>
139 /* Define the standard progress macros. */
140 #include <progress.h>
142 /* This doesn't get taken care of anywhere. */
143 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
144 #if !defined (__GNUC__) && !defined (inline)
147 #endif /* !__MWERKS__ */
149 /* Other stuff from config.h. */
150 #ifdef NEED_DECLARATION_STRSTR
151 extern char *strstr ();
153 #ifdef NEED_DECLARATION_MALLOC
154 extern PTR malloc ();
155 extern PTR realloc ();
157 #ifdef NEED_DECLARATION_FREE
160 #ifdef NEED_DECLARATION_ERRNO
164 /* This is needed for VMS. */
165 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
166 #define unlink remove
169 /* Hack to make "gcc -Wall" not complain about obstack macros. */
170 #if !defined (memcpy) && !defined (bcopy)
171 #define bcopy(src,dest,size) memcpy(dest,src,size)
175 /* This one doesn't get declared, but we're using it anyways. This
176 should be fixed -- either it's part of the external interface or
178 extern PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t sz));
181 /* Make Saber happier on obstack.h. */
184 #define __PTR_TO_INT(P) ((int)(P))
186 #define __INT_TO_PTR(P) ((char *)(P))
190 #define __LINE__ "unknown"
191 #endif /* __LINE__ */
194 #define __FILE__ "unknown"
195 #endif /* __FILE__ */
199 #include "fopen-bin.h"
201 #include "fopen-same.h"
206 #define EXIT_SUCCESS 0
207 #define EXIT_FAILURE 1
210 #define obstack_chunk_alloc xmalloc
211 #define obstack_chunk_free xfree
215 #define BAD_CASE(val) \
217 as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
218 (long) val, __LINE__, __FILE__); \
223 /* These are assembler-wide concepts */
226 extern bfd *stdoutput;
227 typedef bfd_vma addressT;
228 typedef bfd_signed_vma offsetT;
230 typedef unsigned long addressT;
231 typedef long offsetT;
234 /* Type of symbol value, etc. For use in prototypes. */
235 typedef addressT valueT;
239 #define COMMON /* declare our COMMONs storage here. */
241 #define COMMON extern /* our commons live elswhere */
244 /* COMMON now defined */
248 #define know(p) assert(p) /* Verify our assumptions! */
249 #endif /* not yet defined */
251 #define know(p) /* know() checks are no-op.ed */
257 * Supplies sanitised buffers to read.c.
258 * Also understands printing line-number part of error messages.
262 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
264 #ifndef BFD_ASSEMBLER
268 #define N_SEGMENTS 40
269 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
270 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
271 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
272 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
273 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
274 #define SEG_TEXT SEG_E0
275 #define SEG_DATA SEG_E1
276 #define SEG_BSS SEG_E2
277 #define SEG_LAST SEG_E39
280 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
281 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
289 SEG_GOOF, /* Only happens if AS has a logic error. */
290 /* Invented so we don't crash printing */
291 /* error message involving weird segment. */
292 SEG_EXPR, /* Intermediate expression values. */
293 SEG_DEBUG, /* Debug segment */
294 SEG_NTV, /* Transfert vector preload segment */
295 SEG_PTV, /* Transfert vector postload segment */
296 SEG_REGISTER /* Mythical: a register-valued expression */
299 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
301 typedef asection *segT;
302 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
303 && (SEG) != undefined_section \
304 && (SEG) != reg_section \
305 && (SEG) != expr_section)
309 /* What subseg we are accreting now? */
310 COMMON subsegT now_subseg;
312 /* Segment our instructions emit to. */
316 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
318 extern char const *const seg_name[];
319 #define segment_name(SEG) seg_name[(int) (SEG)]
322 #ifndef BFD_ASSEMBLER
323 extern int section_alignment[];
327 extern segT reg_section, expr_section;
328 /* Shouldn't these be eliminated someday? */
329 extern segT text_section, data_section, bss_section;
330 #define absolute_section bfd_abs_section_ptr
331 #define undefined_section bfd_und_section_ptr
333 #define reg_section SEG_REGISTER
334 #define expr_section SEG_EXPR
335 #define text_section SEG_TEXT
336 #define data_section SEG_DATA
337 #define bss_section SEG_BSS
338 #define absolute_section SEG_ABSOLUTE
339 #define undefined_section SEG_UNKNOWN
346 /* Variable chars to be repeated fr_offset times.
347 Fr_symbol unused. Used with fr_offset == 0 for a
348 constant length frag. */
351 /* Align: Fr_offset: power of 2. Variable chars: fill pattern. */
354 /* Align code: fr_offset: power of 2. Fill pattern is machine
355 specific, defaulting to all zeros. */
358 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
362 #ifndef WORKING_DOT_WORD
367 /* machine-specific relaxable (or similarly alterable) instruction */
368 rs_machine_dependent,
370 /* .space directive with expression operand that needs to be computed
371 later. Similar to rs_org, but different.
373 1 variable char: fill character */
377 typedef enum _relax_state relax_stateT;
379 /* This type is used in prototypes, so it can't be a type that will be
380 widened for argument passing. */
381 typedef unsigned int relax_substateT;
383 /* Enough bits for address, but still an integer type.
384 Could be a problem, cross-assembling for 64-bit machines. */
385 typedef addressT relax_addressT;
391 * A code fragment (frag) is some known number of chars, followed by some
392 * unknown number of chars. Typically the unknown number of chars is an
393 * instruction address whose size is yet unknown. We always know the greatest
394 * possible size the unknown number of chars may become, and reserve that
395 * much room at the end of the frag.
396 * Once created, frags do not change address during assembly.
397 * We chain the frags in (a) forward-linked list(s). The object-file address
398 * of the 1st char of a frag is generally not known until after relax().
399 * Many things at assembly time describe an address by {object-file-address
400 * of a particular frag}+offset.
402 BUG: it may be smarter to have a single pointer off to various different
403 notes for different frag kinds. See how code pans
407 /* Object file address. */
409 /* Chain forward; ascending address order. Rooted in frch_root. */
410 struct frag *fr_next;
412 /* (Fixed) number of chars we know we have. May be 0. */
414 /* (Variable) number of chars after above. May be 0. */
416 /* For variable-length tail. */
417 struct symbol *fr_symbol;
418 /* For variable-length tail. */
420 /* Points to opcode low addr byte, for relaxation. */
424 struct list_info_struct *line;
427 /* What state is my tail in? */
428 relax_stateT fr_type;
429 relax_substateT fr_subtype;
431 /* These are needed only on the NS32K machines. But since we don't
432 include targ-cpu.h until after this structure has been defined,
433 we can't really conditionalize it. This code should be
434 rearranged a bit to make that possible.
436 In the meantime, if we get stuck like this with any other target,
437 create a union here. */
438 char fr_pcrel_adjust, fr_bsr;
440 /* Where the frag was created, or where it became a variant frag. */
442 unsigned int fr_line;
444 /* Data begins here. */
448 #define SIZEOF_STRUCT_FRAG \
449 ((char *)zero_address_frag.fr_literal-(char *)&zero_address_frag)
450 /* We want to say fr_literal[0] above. */
452 typedef struct frag fragS;
454 /* Current frag we are building. This frag is incomplete. It is, however,
455 included in frchain_now. The fr_fix field is bogus; instead, use:
456 obstack_next_free(&frags)-frag_now->fr_literal. */
457 COMMON fragS *frag_now;
458 extern int frag_now_fix ();
460 /* For foreign-segment symbol fixups. */
461 COMMON fragS zero_address_frag;
462 /* For local common (N_BSS segment) fixups. */
463 COMMON fragS bss_address_frag;
465 /* main program "as.c" (command arguments etc) */
467 COMMON unsigned char flag_no_comments; /* -f */
468 COMMON unsigned char flag_debug; /* -D */
469 COMMON unsigned char flag_signed_overflow_ok; /* -J */
470 #ifndef WORKING_DOT_WORD
471 COMMON unsigned char flag_warn_displacement; /* -K */
474 /* True if local symbols should be retained. */
475 COMMON int flag_keep_locals; /* -L */
477 /* True if we are assembling in MRI mode. */
480 /* True if we are assembling in m68k MRI mode. */
481 COMMON int flag_m68k_mri;
483 /* Should the data section be made read-only and appended to the text
485 COMMON unsigned char flag_readonly_data_in_text; /* -R */
487 /* True if warnings should be inhibited. */
488 COMMON int flag_no_warnings; /* -W */
490 /* True if we should attempt to generate output even if non-fatal errors
492 COMMON unsigned char flag_always_generate_output; /* -Z */
494 /* This is true if the assembler should output time and space usage. */
496 COMMON unsigned char flag_print_statistics;
498 /* name of emitted object file */
499 COMMON char *out_file_name;
501 /* TRUE if we need a second pass. */
502 COMMON int need_pass_2;
504 /* TRUE if we should do no relaxing, and
505 leave lots of padding. */
506 COMMON int linkrelax;
508 /* TRUE if we should produce a listing. */
511 /* Maximum level of macro nesting. */
512 extern int max_macro_nest;
514 /* Obstack chunk size. Keep large for efficient space use, make small to
515 increase malloc calls for monitoring memory allocation. */
516 extern int chunksize;
520 /* assembler mnemonic, lower case, no '.' */
521 const char *poc_name;
523 void (*poc_handler) PARAMS ((int));
524 /* Value to pass to handler */
528 typedef struct _pseudo_type pseudo_typeS;
530 /* Prefer varargs for non-ANSI compiler, since some will barf if the
531 ellipsis definition is used with a no-arguments declaration. */
532 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
536 #if defined (HAVE_STDARG_H)
539 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
545 /* for use with -Wformat */
546 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...) \
547 __attribute__ ((format (printf, 1, 2)))
548 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, unsigned int line, \
549 const char *format, ...) \
550 __attribute__ ((format (printf, 3, 4)))
551 #else /* ANSI C with stdarg, but not GNU C */
552 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
553 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
555 const char *format, ...))
557 #else /* not using stdarg */
558 #define PRINTF_LIKE(FCN) void FCN ()
559 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
562 PRINTF_LIKE (as_bad);
563 PRINTF_LIKE (as_fatal);
564 PRINTF_LIKE (as_tsktsk);
565 PRINTF_LIKE (as_warn);
566 PRINTF_WHERE_LIKE (as_bad_where);
567 PRINTF_WHERE_LIKE (as_warn_where);
568 void as_assert PARAMS ((const char *, int, const char *));
569 void as_abort PARAMS ((const char *, int, const char *));
571 void fprint_value PARAMS ((FILE *file, addressT value));
572 void sprint_value PARAMS ((char *buf, addressT value));
574 int had_errors PARAMS ((void));
575 int had_warnings PARAMS ((void));
577 void print_version_id PARAMS ((void));
578 char *app_push PARAMS ((void));
579 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
580 char *input_scrub_include_file PARAMS ((char *filename, char *position));
581 char *input_scrub_new_file PARAMS ((char *filename));
582 char *input_scrub_next_buffer PARAMS ((char **bufp));
583 PTR xmalloc PARAMS ((unsigned long size));
584 PTR xrealloc PARAMS ((PTR ptr, unsigned long n));
585 int do_scrub_chars PARAMS ((int (*get) (char **), char *to, int tolen));
586 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
587 long exponent_bits));
588 int had_err PARAMS ((void));
589 int ignore_input PARAMS ((void));
590 int seen_at_least_1_file PARAMS ((void));
591 void app_pop PARAMS ((char *arg));
592 void as_howmuch PARAMS ((FILE * stream));
593 void as_perror PARAMS ((const char *gripe, const char *filename));
594 void as_where PARAMS ((char **namep, unsigned int *linep));
595 void bump_line_counters PARAMS ((void));
596 void do_scrub_begin PARAMS ((int));
597 void input_scrub_begin PARAMS ((void));
598 void input_scrub_close PARAMS ((void));
599 void input_scrub_end PARAMS ((void));
600 void new_logical_line PARAMS ((char *fname, int line_number));
601 void subsegs_begin PARAMS ((void));
602 void subseg_change PARAMS ((segT seg, int subseg));
603 segT subseg_new PARAMS ((const char *name, subsegT subseg));
604 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
605 void subseg_set PARAMS ((segT seg, subsegT subseg));
607 segT subseg_get PARAMS ((const char *, int));
617 valueT add_to_literal_pool PARAMS ((struct symbol *, valueT, segT, int));
620 #include "expr.h" /* Before targ-*.h */
622 /* this one starts the chain of target dependant headers */
623 #include "targ-env.h"
625 #include "struc-symbol.h"
635 #ifdef USE_EMULATIONS
640 #ifndef LOCAL_LABELS_DOLLAR
641 #define LOCAL_LABELS_DOLLAR 0
644 #ifndef LOCAL_LABELS_FB
645 #define LOCAL_LABELS_FB 0