1 /* as.h - global header file
2 Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 97, 1998
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 the Free
19 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 #undef for DJ Delorie. The right fix is to ensure that as.h
46 is included first, before even any system header files, in all files
47 that use it. KR 1994.11.03 */
48 /* Added void* version for STDC case. This is to be compatible with
49 the declaration in bison.simple, used for m68k operand parsing.
51 /* Force void* decl for hpux. This is what Bison uses. --KR 1995.08.16 */
53 /* AIX requires this to be the first thing in the file. */
57 extern void *alloca ();
59 extern char *alloca ();
69 # ifndef alloca /* predefined by HP cc +Olibcalls */
70 # if !defined (__STDC__) && !defined (__hpux)
71 extern char *alloca ();
73 extern void *alloca ();
74 # endif /* __STDC__, __hpux */
77 # endif /* HAVE_ALLOCA_H */
80 /* Now, tend to the rest of the configuration. */
82 /* System include files first... */
98 #ifdef HAVE_SYS_TYPES_H
99 /* for size_t, pid_t */
100 #include <sys/types.h>
104 /* The first getopt value for machine-independent long options.
105 150 isn't special; it's just an arbitrary non-ASCII char value. */
106 #define OPTION_STD_BASE 150
107 /* The first getopt value for machine-dependent long options.
108 170 gives the standard options room to grow. */
109 #define OPTION_MD_BASE 170
114 #if !defined (__GNUC__) || __GNUC_MINOR__ <= 5
115 #define __PRETTY_FUNCTION__ ((char*)0)
119 /* Handle lossage with assert.h. */
120 #ifndef BROKEN_ASSERT
122 #else /* BROKEN_ASSERT */
124 #define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
126 #define assert(p) ((p), 0)
128 #endif /* BROKEN_ASSERT */
132 #define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
134 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
139 /* Now GNU header files... */
140 #include <ansidecl.h>
144 #include <libiberty.h>
146 /* Define the standard progress macros. */
147 #include <progress.h>
149 /* This doesn't get taken care of anywhere. */
150 #ifndef __MWERKS__ /* Metrowerks C chokes on the "defined (inline)" */
151 #if !defined (__GNUC__) && !defined (inline)
154 #endif /* !__MWERKS__ */
156 /* Other stuff from config.h. */
157 #ifdef NEED_DECLARATION_STRSTR
158 extern char *strstr ();
160 #ifdef NEED_DECLARATION_MALLOC
161 extern PTR malloc ();
162 extern PTR realloc ();
164 #ifdef NEED_DECLARATION_FREE
167 #ifdef NEED_DECLARATION_ERRNO
171 /* This is needed for VMS. */
172 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
173 #define unlink remove
176 /* Hack to make "gcc -Wall" not complain about obstack macros. */
177 #if !defined (memcpy) && !defined (bcopy)
178 #define bcopy(src,dest,size) memcpy(dest,src,size)
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. The fr_offset field holds the power of 2 to which to
352 align. The fr_var field holds the number of characters in the
353 fill pattern. The fr_subtype field holds the maximum number of
354 bytes to skip when aligning, or 0 if there is no maximum. */
357 /* Align code. The fr_offset field holds the power of 2 to which
358 to align. This type is only generated by machine specific
359 code, which is normally responsible for handling the fill
360 pattern. The fr_subtype field holds the maximum number of
361 bytes to skip when aligning, or 0 if there is no maximum. */
364 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
368 #ifndef WORKING_DOT_WORD
373 /* machine-specific relaxable (or similarly alterable) instruction */
374 rs_machine_dependent,
376 /* .space directive with expression operand that needs to be computed
377 later. Similar to rs_org, but different.
379 1 variable char: fill character */
382 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
383 unsigned, 1 for signed. */
387 typedef enum _relax_state relax_stateT;
389 /* This type is used in prototypes, so it can't be a type that will be
390 widened for argument passing. */
391 typedef unsigned int relax_substateT;
393 /* Enough bits for address, but still an integer type.
394 Could be a problem, cross-assembling for 64-bit machines. */
395 typedef addressT relax_addressT;
397 /* main program "as.c" (command arguments etc) */
399 COMMON unsigned char flag_no_comments; /* -f */
400 COMMON unsigned char flag_debug; /* -D */
401 COMMON unsigned char flag_signed_overflow_ok; /* -J */
402 #ifndef WORKING_DOT_WORD
403 COMMON unsigned char flag_warn_displacement; /* -K */
406 /* True if local symbols should be retained. */
407 COMMON int flag_keep_locals; /* -L */
409 /* True if we are assembling in MRI mode. */
412 /* True if we are assembling in m68k MRI mode. */
413 COMMON int flag_m68k_mri;
415 /* Should the data section be made read-only and appended to the text
417 COMMON unsigned char flag_readonly_data_in_text; /* -R */
419 /* True if warnings should be inhibited. */
420 COMMON int flag_no_warnings; /* -W */
422 /* True if we should attempt to generate output even if non-fatal errors
424 COMMON unsigned char flag_always_generate_output; /* -Z */
426 /* True if instruction swapping warnings should be inhibited. */
427 COMMON unsigned char flag_warn_suppress_instructionswap; /* --nowarnswap */
429 /* This is true if the assembler should output time and space usage. */
430 COMMON unsigned char flag_print_statistics;
432 /* True if local absolute symbols are to be stripped. */
433 COMMON int flag_strip_local_absolute;
435 /* name of emitted object file */
436 COMMON char *out_file_name;
438 /* name of file defining extensions to the basic instruction set */
439 COMMON char *insttbl_file_name;
441 /* TRUE if we need a second pass. */
442 COMMON int need_pass_2;
444 /* TRUE if we should do no relaxing, and
445 leave lots of padding. */
446 COMMON int linkrelax;
448 /* TRUE if we should produce a listing. */
451 /* Type of debugging information we should generate. We currently
452 only support stabs and ECOFF. */
454 enum debug_info_type { DEBUG_NONE, DEBUG_STABS, DEBUG_ECOFF };
456 extern enum debug_info_type debug_type;
458 /* Maximum level of macro nesting. */
459 extern int max_macro_nest;
461 /* Obstack chunk size. Keep large for efficient space use, make small to
462 increase malloc calls for monitoring memory allocation. */
463 extern int chunksize;
467 /* assembler mnemonic, lower case, no '.' */
468 const char *poc_name;
470 void (*poc_handler) PARAMS ((int));
471 /* Value to pass to handler */
475 typedef struct _pseudo_type pseudo_typeS;
477 /* Prefer varargs for non-ANSI compiler, since some will barf if the
478 ellipsis definition is used with a no-arguments declaration. */
479 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
483 #if defined (HAVE_STDARG_H)
486 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
491 #if (__GNUC__ >= 2) && !defined(VMS)
492 /* for use with -Wformat */
493 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...) \
494 __attribute__ ((format (printf, 1, 2)))
495 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, unsigned int line, \
496 const char *format, ...) \
497 __attribute__ ((format (printf, 3, 4)))
498 #else /* ANSI C with stdarg, but not GNU C */
499 #define PRINTF_LIKE(FCN) void FCN PARAMS ((const char *format, ...))
500 #define PRINTF_WHERE_LIKE(FCN) void FCN PARAMS ((char *file, \
502 const char *format, ...))
504 #else /* not using stdarg */
505 #define PRINTF_LIKE(FCN) void FCN ()
506 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
509 PRINTF_LIKE (as_bad);
510 PRINTF_LIKE (as_fatal);
511 PRINTF_LIKE (as_tsktsk);
512 PRINTF_LIKE (as_warn);
513 PRINTF_WHERE_LIKE (as_bad_where);
514 PRINTF_WHERE_LIKE (as_warn_where);
515 void as_assert PARAMS ((const char *, int, const char *));
516 void as_abort PARAMS ((const char *, int, const char *));
518 void fprint_value PARAMS ((FILE *file, addressT value));
519 void sprint_value PARAMS ((char *buf, addressT value));
521 int had_errors PARAMS ((void));
522 int had_warnings PARAMS ((void));
524 void print_version_id PARAMS ((void));
525 char *app_push PARAMS ((void));
526 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
527 char *input_scrub_include_file PARAMS ((char *filename, char *position));
528 char *input_scrub_new_file PARAMS ((char *filename));
529 char *input_scrub_next_buffer PARAMS ((char **bufp));
530 int do_scrub_chars PARAMS ((int (*get) (char **), char *to, int tolen));
531 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
532 long exponent_bits));
533 int had_err PARAMS ((void));
534 int ignore_input PARAMS ((void));
535 void cond_finish_check PARAMS ((int));
536 void cond_exit_macro PARAMS ((int));
537 int seen_at_least_1_file PARAMS ((void));
538 void app_pop PARAMS ((char *arg));
539 void as_howmuch PARAMS ((FILE * stream));
540 void as_perror PARAMS ((const char *gripe, const char *filename));
541 void as_where PARAMS ((char **namep, unsigned int *linep));
542 void bump_line_counters PARAMS ((void));
543 void do_scrub_begin PARAMS ((int));
544 void input_scrub_begin PARAMS ((void));
545 void input_scrub_close PARAMS ((void));
546 void input_scrub_end PARAMS ((void));
547 int new_logical_line PARAMS ((char *fname, int line_number));
548 void subsegs_begin PARAMS ((void));
549 void subseg_change PARAMS ((segT seg, int subseg));
550 segT subseg_new PARAMS ((const char *name, subsegT subseg));
551 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
552 void subseg_set PARAMS ((segT seg, subsegT subseg));
554 segT subseg_get PARAMS ((const char *, int));
557 void start_dependencies PARAMS ((char *));
558 void register_dependency PARAMS ((char *));
559 void print_dependencies PARAMS ((void));
565 typedef struct frag fragS;
569 valueT add_to_literal_pool PARAMS ((struct symbol *, valueT, segT, int));
572 #include "expr.h" /* Before targ-*.h */
574 /* this one starts the chain of target dependant headers */
575 #include "targ-env.h"
577 #include "struc-symbol.h"
587 #ifdef USE_EMULATIONS
592 #ifndef LOCAL_LABELS_DOLLAR
593 #define LOCAL_LABELS_DOLLAR 0
596 #ifndef LOCAL_LABELS_FB
597 #define LOCAL_LABELS_FB 0