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
43 djm@gnu.ai.mit.edu as well. */
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... */
90 #ifdef HAVE_SYS_TYPES_H
91 /* for size_t, pid_t */
92 #include <sys/types.h>
96 /* The first getopt value for machine-independent long options.
97 150 isn't special; it's just an arbitrary non-ASCII char value. */
98 #define OPTION_STD_BASE 150
99 /* The first getopt value for machine-dependent long options.
100 170 gives the standard options room to grow. */
101 #define OPTION_MD_BASE 170
106 #if !defined (__GNUC__) || __GNUC_MINOR__ <= 5
107 #define __PRETTY_FUNCTION__ ((char*)0)
111 /* Handle lossage with assert.h. */
112 #ifndef BROKEN_ASSERT
114 #else /* BROKEN_ASSERT */
116 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
118 #define assert(p) ((p), 0)
120 #endif /* BROKEN_ASSERT */
124 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
126 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
131 /* Now GNU header files... */
132 #include <ansidecl.h>
137 /* Define the standard progress macros. */
138 #include <progress.h>
140 /* This doesn't get taken care of anywhere. */
141 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
142 #if !defined (__GNUC__) && !defined (inline)
145 #endif /* !__MWERKS__ */
147 /* Other stuff from config.h. */
148 #ifdef NEED_DECLARATION_MALLOC
149 extern PTR malloc ();
150 extern PTR realloc ();
152 #ifdef NEED_DECLARATION_FREE
155 #ifdef NEED_DECLARATION_ERRNO
159 /* This is needed for VMS. */
160 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
161 #define unlink remove
164 /* Hack to make "gcc -Wall" not complain about obstack macros. */
165 #if !defined (memcpy) && !defined (bcopy)
166 #define bcopy(src,dest,size) memcpy(dest,src,size)
170 /* This one doesn't get declared, but we're using it anyways. This
171 should be fixed -- either it's part of the external interface or
173 extern PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t sz));
176 /* Make Saber happier on obstack.h. */
179 #define __PTR_TO_INT(P) ((int)(P))
181 #define __INT_TO_PTR(P) ((char *)(P))
185 #define __LINE__ "unknown"
186 #endif /* __LINE__ */
189 #define __FILE__ "unknown"
190 #endif /* __FILE__ */
199 #endif /* ! __STDC__ */
203 #include "fopen-bin.h"
205 #include "fopen-same.h"
210 #define EXIT_SUCCESS 0
211 #define EXIT_FAILURE 1
214 #define obstack_chunk_alloc xmalloc
215 #define obstack_chunk_free xfree
219 #define BAD_CASE(val) \
221 as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
222 (long) val, __LINE__, __FILE__); \
225 /* Version 2.1 of Solaris had problems with this declaration, but I
226 think that bug has since been fixed. If it causes problems on your
227 system, just delete it. */
228 extern char *strstr ();
232 /* These are assembler-wide concepts */
235 extern bfd *stdoutput;
236 typedef bfd_vma addressT;
237 typedef bfd_signed_vma offsetT;
239 typedef unsigned long addressT;
240 typedef long offsetT;
243 /* Type of symbol value, etc. For use in prototypes. */
244 typedef addressT valueT;
248 #define COMMON /* declare our COMMONs storage here. */
250 #define COMMON extern /* our commons live elswhere */
253 /* COMMON now defined */
257 #define know(p) assert(p) /* Verify our assumptions! */
258 #endif /* not yet defined */
260 #define know(p) /* know() checks are no-op.ed */
266 * Supplies sanitised buffers to read.c.
267 * Also understands printing line-number part of error messages.
271 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
273 #ifndef BFD_ASSEMBLER
277 #define N_SEGMENTS 40
278 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
279 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
280 SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
281 SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
282 SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
283 #define SEG_TEXT SEG_E0
284 #define SEG_DATA SEG_E1
285 #define SEG_BSS SEG_E2
286 #define SEG_LAST SEG_E39
289 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
290 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
298 SEG_GOOF, /* Only happens if AS has a logic error. */
299 /* Invented so we don't crash printing */
300 /* error message involving weird segment. */
301 SEG_EXPR, /* Intermediate expression values. */
302 SEG_DEBUG, /* Debug segment */
303 SEG_NTV, /* Transfert vector preload segment */
304 SEG_PTV, /* Transfert vector postload segment */
305 SEG_REGISTER /* Mythical: a register-valued expression */
308 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
310 typedef asection *segT;
311 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
312 && (SEG) != undefined_section \
313 && (SEG) != reg_section \
314 && (SEG) != expr_section)
318 /* What subseg we are accreting now? */
319 COMMON subsegT now_subseg;
321 /* Segment our instructions emit to. */
325 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
327 extern char const *const seg_name[];
328 #define segment_name(SEG) seg_name[(int) (SEG)]
331 #ifndef BFD_ASSEMBLER
332 extern int section_alignment[];
336 extern segT reg_section, expr_section;
337 /* Shouldn't these be eliminated someday? */
338 extern segT text_section, data_section, bss_section;
339 #define absolute_section bfd_abs_section_ptr
340 #define undefined_section bfd_und_section_ptr
342 #define reg_section SEG_REGISTER
343 #define expr_section SEG_EXPR
344 #define text_section SEG_TEXT
345 #define data_section SEG_DATA
346 #define bss_section SEG_BSS
347 #define absolute_section SEG_ABSOLUTE
348 #define undefined_section SEG_UNKNOWN
355 /* Variable chars to be repeated fr_offset times.
356 Fr_symbol unused. Used with fr_offset == 0 for a
357 constant length frag. */
360 /* Align: Fr_offset: power of 2. Variable chars: fill pattern. */
363 /* Align code: fr_offset: power of 2. Fill pattern is machine
364 specific, defaulting to all zeros. */
367 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
371 #ifndef WORKING_DOT_WORD
376 /* machine-specific relaxable (or similarly alterable) instruction */
377 rs_machine_dependent,
379 /* .space directive with expression operand that needs to be computed
380 later. Similar to rs_org, but different.
382 1 variable char: fill character */
386 typedef enum _relax_state relax_stateT;
388 /* This type is used in prototypes, so it can't be a type that will be
389 widened for argument passing. */
390 typedef unsigned int relax_substateT;
392 /* Enough bits for address, but still an integer type.
393 Could be a problem, cross-assembling for 64-bit machines. */
394 typedef addressT relax_addressT;
400 * A code fragment (frag) is some known number of chars, followed by some
401 * unknown number of chars. Typically the unknown number of chars is an
402 * instruction address whose size is yet unknown. We always know the greatest
403 * possible size the unknown number of chars may become, and reserve that
404 * much room at the end of the frag.
405 * Once created, frags do not change address during assembly.
406 * We chain the frags in (a) forward-linked list(s). The object-file address
407 * of the 1st char of a frag is generally not known until after relax().
408 * Many things at assembly time describe an address by {object-file-address
409 * of a particular frag}+offset.
411 BUG: it may be smarter to have a single pointer off to various different
412 notes for different frag kinds. See how code pans
416 /* Object file address. */
418 /* Chain forward; ascending address order. Rooted in frch_root. */
419 struct frag *fr_next;
421 /* (Fixed) number of chars we know we have. May be 0. */
423 /* (Variable) number of chars after above. May be 0. */
425 /* For variable-length tail. */
426 struct symbol *fr_symbol;
427 /* For variable-length tail. */
429 /* Points to opcode low addr byte, for relaxation. */
433 struct list_info_struct *line;
436 /* What state is my tail in? */
437 relax_stateT fr_type;
438 relax_substateT fr_subtype;
440 /* These are needed only on the NS32K machines. But since we don't
441 include targ-cpu.h until after this structure has been defined,
442 we can't really conditionalize it. This code should be
443 rearranged a bit to make that possible.
445 In the meantime, if we get stuck like this with any other target,
446 create a union here. */
447 char fr_pcrel_adjust, fr_bsr;
449 /* Data begins here. */
453 #define SIZEOF_STRUCT_FRAG \
454 ((char *)zero_address_frag.fr_literal-(char *)&zero_address_frag)
455 /* We want to say fr_literal[0] above. */
457 typedef struct frag fragS;
459 /* Current frag we are building. This frag is incomplete. It is, however,
460 included in frchain_now. The fr_fix field is bogus; instead, use:
461 obstack_next_free(&frags)-frag_now->fr_literal. */
462 COMMON fragS *frag_now;
463 extern int frag_now_fix ();
465 /* For foreign-segment symbol fixups. */
466 COMMON fragS zero_address_frag;
467 /* For local common (N_BSS segment) fixups. */
468 COMMON fragS bss_address_frag;
470 /* main program "as.c" (command arguments etc) */
472 COMMON unsigned char flag_no_comments; /* -f */
473 COMMON unsigned char flag_debug; /* -D */
474 COMMON unsigned char flag_signed_overflow_ok; /* -J */
475 #ifndef WORKING_DOT_WORD
476 COMMON unsigned char flag_warn_displacement; /* -K */
479 /* True if local symbols should be retained. */
480 COMMON int flag_keep_locals; /* -L */
482 /* True if we are assembling in MRI mode. */
485 /* True if we are assembling in m68k MRI mode. */
486 COMMON int flag_m68k_mri;
488 /* Should the data section be made read-only and appended to the text
490 COMMON unsigned char flag_readonly_data_in_text; /* -R */
492 /* True if warnings should be inhibited. */
493 COMMON int flag_no_warnings; /* -W */
495 /* True if we should attempt to generate output even if non-fatal errors
497 COMMON unsigned char flag_always_generate_output; /* -Z */
499 /* This is true if the assembler should output time and space usage. */
501 COMMON unsigned char flag_print_statistics;
503 /* name of emitted object file */
504 COMMON char *out_file_name;
506 /* TRUE if we need a second pass. */
507 COMMON int need_pass_2;
509 /* TRUE if we should do no relaxing, and
510 leave lots of padding. */
511 COMMON int linkrelax;
513 /* TRUE if we should produce a listing. */
516 /* Maximum level of macro nesting. */
517 extern int max_macro_nest;
519 /* Obstack chunk size. Keep large for efficient space use, make small to
520 increase malloc calls for monitoring memory allocation. */
521 extern int chunksize;
525 /* assembler mnemonic, lower case, no '.' */
526 const char *poc_name;
528 void (*poc_handler) PARAMS ((int));
529 /* Value to pass to handler */
533 typedef struct _pseudo_type pseudo_typeS;
535 /* Prefer varargs for non-ANSI compiler, since some will barf if the
536 ellipsis definition is used with a no-arguments declaration. */
537 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
541 #if defined (HAVE_STDARG_H)
544 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
550 /* for use with -Wformat */
551 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...) \
552 __attribute__ ((format (printf, 1, 2)))
553 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, unsigned int line, \
554 const char *format, ...) \
555 __attribute__ ((format (printf, 3, 4)))
556 #else /* ANSI C with stdarg, but not GNU C */
557 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
558 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
560 const char *format, ...))
562 #else /* not using stdarg */
563 #define PRINTF_LIKE(FCN) void FCN ()
564 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
567 PRINTF_LIKE (as_bad);
568 PRINTF_LIKE (as_fatal);
569 PRINTF_LIKE (as_tsktsk);
570 PRINTF_LIKE (as_warn);
571 PRINTF_WHERE_LIKE (as_bad_where);
572 PRINTF_WHERE_LIKE (as_warn_where);
573 void as_assert PARAMS ((const char *, int, const char *));
574 void as_abort PARAMS ((const char *, int, const char *));
576 void fprint_value PARAMS ((FILE *file, addressT value));
577 void sprint_value PARAMS ((char *buf, addressT value));
579 int had_errors PARAMS ((void));
580 int had_warnings PARAMS ((void));
582 void print_version_id PARAMS ((void));
583 char *app_push PARAMS ((void));
584 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
585 char *input_scrub_include_file PARAMS ((char *filename, char *position));
586 char *input_scrub_new_file PARAMS ((char *filename));
587 char *input_scrub_next_buffer PARAMS ((char **bufp));
588 PTR xmalloc PARAMS ((unsigned long size));
589 PTR xrealloc PARAMS ((PTR ptr, unsigned long n));
590 int do_scrub_chars PARAMS ((int (*get) (char **), char *to, int tolen));
591 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
592 long exponent_bits));
593 int had_err PARAMS ((void));
594 int ignore_input PARAMS ((void));
595 int seen_at_least_1_file PARAMS ((void));
596 void app_pop PARAMS ((char *arg));
597 void as_howmuch PARAMS ((FILE * stream));
598 void as_perror PARAMS ((const char *gripe, const char *filename));
599 void as_where PARAMS ((char **namep, unsigned int *linep));
600 void bump_line_counters PARAMS ((void));
601 void do_scrub_begin PARAMS ((int));
602 void input_scrub_begin PARAMS ((void));
603 void input_scrub_close PARAMS ((void));
604 void input_scrub_end PARAMS ((void));
605 void new_logical_line PARAMS ((char *fname, int line_number));
606 void subsegs_begin PARAMS ((void));
607 void subseg_change PARAMS ((segT seg, int subseg));
608 segT subseg_new PARAMS ((const char *name, subsegT subseg));
609 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
610 void subseg_set PARAMS ((segT seg, subsegT subseg));
612 segT subseg_get PARAMS ((const char *, int));
622 valueT add_to_literal_pool PARAMS ((struct symbol *, valueT, segT, int));
625 #include "expr.h" /* Before targ-*.h */
627 /* this one starts the chain of target dependant headers */
628 #include "targ-env.h"
630 #include "struc-symbol.h"
640 #ifdef USE_EMULATIONS
645 #ifndef LOCAL_LABELS_DOLLAR
646 #define LOCAL_LABELS_DOLLAR 0
649 #ifndef LOCAL_LABELS_FB
650 #define LOCAL_LABELS_FB 0