as.h revision 38889 
1/* as.h - global header file
2   Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 97, 1998
3   Free Software Foundation, Inc.
4
5   This file is part of GAS, the GNU Assembler.
6
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)
10   any later version.
11
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.
16
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
20   02111-1307, USA.  */
21
22#ifndef GAS
23#define GAS 1
24/*
25 * I think this stuff is largely out of date.  xoxorich.
26 *
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.
32 *
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
36 *	COMMON as "".
37 * If TEST is #defined, then we are testing a module: #define COMMON as "".
38 */
39
40#include "config.h"
41
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.
50   --KR 1995.08.08 */
51/* Force void* decl for hpux.  This is what Bison uses.  --KR 1995.08.16 */
52
53/* AIX requires this to be the first thing in the file.  */
54#ifdef __GNUC__
55# ifndef alloca
56#  ifdef __STDC__
57extern void *alloca ();
58#  else
59extern char *alloca ();
60#  endif
61# endif
62#else
63# if HAVE_ALLOCA_H
64#  include <alloca.h>
65# else
66#  ifdef _AIX
67 #pragma alloca
68#  else
69#   ifndef alloca /* predefined by HP cc +Olibcalls */
70#    if !defined (__STDC__) && !defined (__hpux)
71extern char *alloca ();
72#    else
73extern void *alloca ();
74#    endif /* __STDC__, __hpux */
75#   endif /* alloca */
76#  endif /* _AIX */
77# endif /* HAVE_ALLOCA_H */
78#endif
79
80/* Now, tend to the rest of the configuration.  */
81
82/* System include files first... */
83#include <stdio.h>
84#include <ctype.h>
85#ifdef HAVE_STRING_H
86#include <string.h>
87#else
88#ifdef HAVE_STRINGS_H
89#include <strings.h>
90#endif
91#endif
92#ifdef HAVE_STDLIB_H
93#include <stdlib.h>
94#endif
95#ifdef HAVE_UNISTD_H
96#include <unistd.h>
97#endif
98#ifdef HAVE_SYS_TYPES_H
99/* for size_t, pid_t */
100#include <sys/types.h>
101#endif
102
103#include <getopt.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
110
111#ifdef DEBUG
112#undef NDEBUG
113#endif
114#if !defined (__GNUC__) || __GNUC_MINOR__ <= 5
115#define __PRETTY_FUNCTION__  ((char*)0)
116#endif
117#if 0
118
119/* Handle lossage with assert.h.  */
120#ifndef BROKEN_ASSERT
121#include <assert.h>
122#else /* BROKEN_ASSERT */
123#ifndef NDEBUG
124#define assert(p) ((p) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
125#else
126#define assert(p) ((p), 0)
127#endif
128#endif /* BROKEN_ASSERT */
129
130#else
131
132#define assert(P) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0))
133#undef abort
134#define abort()		as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
135
136#endif
137
138
139/* Now GNU header files... */
140#include <ansidecl.h>
141#ifdef BFD_ASSEMBLER
142#include <bfd.h>
143#endif
144#include <libiberty.h>
145
146/* Define the standard progress macros.  */
147#include <progress.h>
148
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)
152#define inline
153#endif
154#endif /* !__MWERKS__ */
155
156/* Other stuff from config.h.  */
157#ifdef NEED_DECLARATION_STRSTR
158extern char *strstr ();
159#endif
160#ifdef NEED_DECLARATION_MALLOC
161extern PTR malloc ();
162extern PTR realloc ();
163#endif
164#ifdef NEED_DECLARATION_FREE
165extern void free ();
166#endif
167#ifdef NEED_DECLARATION_ERRNO
168extern int errno;
169#endif
170
171/* This is needed for VMS.  */
172#if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
173#define unlink remove
174#endif
175
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)
179#endif
180
181/* Make Saber happier on obstack.h.  */
182#ifdef SABER
183#undef  __PTR_TO_INT
184#define __PTR_TO_INT(P) ((int)(P))
185#undef  __INT_TO_PTR
186#define __INT_TO_PTR(P) ((char *)(P))
187#endif
188
189#ifndef __LINE__
190#define __LINE__ "unknown"
191#endif /* __LINE__ */
192
193#ifndef __FILE__
194#define __FILE__ "unknown"
195#endif /* __FILE__ */
196
197#ifndef FOPEN_WB
198#ifdef GO32
199#include "fopen-bin.h"
200#else
201#include "fopen-same.h"
202#endif
203#endif
204
205#ifndef EXIT_SUCCESS
206#define EXIT_SUCCESS 0
207#define EXIT_FAILURE 1
208#endif
209
210#define obstack_chunk_alloc xmalloc
211#define obstack_chunk_free xfree
212
213#define xfree free
214
215#define BAD_CASE(val) \
216{ \
217      as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
218	       (long) val, __LINE__, __FILE__); \
219	   }
220
221#include "flonum.h"
222
223/* These are assembler-wide concepts */
224
225#ifdef BFD_ASSEMBLER
226extern bfd *stdoutput;
227typedef bfd_vma addressT;
228typedef bfd_signed_vma offsetT;
229#else
230typedef unsigned long addressT;
231typedef long offsetT;
232#endif
233
234/* Type of symbol value, etc.  For use in prototypes.  */
235typedef addressT valueT;
236
237#ifndef COMMON
238#ifdef TEST
239#define COMMON			/* declare our COMMONs storage here. */
240#else
241#define COMMON extern		/* our commons live elswhere */
242#endif
243#endif
244/* COMMON now defined */
245
246#ifdef DEBUG
247#ifndef know
248#define know(p) assert(p)	/* Verify our assumptions! */
249#endif /* not yet defined */
250#else
251#define know(p)			/* know() checks are no-op.ed */
252#endif
253
254/* input_scrub.c */
255
256/*
257 * Supplies sanitised buffers to read.c.
258 * Also understands printing line-number part of error messages.
259 */
260
261
262/* subsegs.c     Sub-segments. Also, segment(=expression type)s.*/
263
264#ifndef BFD_ASSEMBLER
265
266#ifdef MANY_SEGMENTS
267#include "bfd.h"
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
278#else
279#define N_SEGMENTS 3
280#define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
281#define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
282#endif
283
284typedef enum _segT
285  {
286    SEG_ABSOLUTE = 0,
287    SEG_LIST,
288    SEG_UNKNOWN,
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 */
297  } segT;
298
299#define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
300#else
301typedef asection *segT;
302#define SEG_NORMAL(SEG)		((SEG) != absolute_section	\
303				 && (SEG) != undefined_section	\
304				 && (SEG) != reg_section	\
305				 && (SEG) != expr_section)
306#endif
307typedef int subsegT;
308
309/* What subseg we are accreting now? */
310COMMON subsegT now_subseg;
311
312/* Segment our instructions emit to. */
313COMMON segT now_seg;
314
315#ifdef BFD_ASSEMBLER
316#define segment_name(SEG)	bfd_get_section_name (stdoutput, SEG)
317#else
318extern char const *const seg_name[];
319#define segment_name(SEG)	seg_name[(int) (SEG)]
320#endif
321
322#ifndef BFD_ASSEMBLER
323extern int section_alignment[];
324#endif
325
326#ifdef BFD_ASSEMBLER
327extern segT reg_section, expr_section;
328/* Shouldn't these be eliminated someday?  */
329extern segT text_section, data_section, bss_section;
330#define absolute_section	bfd_abs_section_ptr
331#define undefined_section	bfd_und_section_ptr
332#else
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
340#endif
341
342/* relax() */
343
344enum _relax_state
345  {
346    /* Variable chars to be repeated fr_offset times.
347       Fr_symbol unused. Used with fr_offset == 0 for a
348       constant length frag. */
349    rs_fill = 1,
350
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.  */
355    rs_align,
356
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.  */
362    rs_align_code,
363
364    /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
365       character. */
366    rs_org,
367
368#ifndef WORKING_DOT_WORD
369    /* JF: gunpoint */
370    rs_broken_word,
371#endif
372
373    /* machine-specific relaxable (or similarly alterable) instruction */
374    rs_machine_dependent,
375
376    /* .space directive with expression operand that needs to be computed
377       later.  Similar to rs_org, but different.
378       fr_symbol: operand
379       1 variable char: fill character  */
380    rs_space,
381
382    /* A DWARF leb128 value; only ELF uses this.  The subtype is 0 for
383       unsigned, 1 for signed.  */
384    rs_leb128,
385
386    /* Exception frame information which we may be able to optimize.  */
387    rs_cfa
388  };
389
390typedef enum _relax_state relax_stateT;
391
392/* This type is used in prototypes, so it can't be a type that will be
393   widened for argument passing.  */
394typedef unsigned int relax_substateT;
395
396/* Enough bits for address, but still an integer type.
397   Could be a problem, cross-assembling for 64-bit machines.  */
398typedef addressT relax_addressT;
399
400/* main program "as.c" (command arguments etc) */
401
402COMMON unsigned char flag_no_comments; /* -f */
403COMMON unsigned char flag_debug; /* -D */
404COMMON unsigned char flag_signed_overflow_ok; /* -J */
405#ifndef WORKING_DOT_WORD
406COMMON unsigned char flag_warn_displacement; /* -K */
407#endif
408
409/* True if local symbols should be retained.  */
410COMMON int flag_keep_locals; /* -L */
411
412/* True if we are assembling in MRI mode.  */
413COMMON int flag_mri;
414
415/* True if we are assembling in m68k MRI mode.  */
416COMMON int flag_m68k_mri;
417
418/* Should the data section be made read-only and appended to the text
419   section?  */
420COMMON unsigned char flag_readonly_data_in_text; /* -R */
421
422/* True if warnings should be inhibited.  */
423COMMON int flag_no_warnings; /* -W */
424
425/* True if we should attempt to generate output even if non-fatal errors
426   are detected.  */
427COMMON unsigned char flag_always_generate_output; /* -Z */
428
429/* This is true if the assembler should output time and space usage. */
430COMMON unsigned char flag_print_statistics;
431
432/* True if local absolute symbols are to be stripped.  */
433COMMON int flag_strip_local_absolute;
434
435/* True if we should generate a traditional format object file.  */
436COMMON int flag_traditional_format;
437
438/* name of emitted object file */
439COMMON char *out_file_name;
440
441/* name of file defining extensions to the basic instruction set */
442COMMON char *insttbl_file_name;
443
444/* TRUE if we need a second pass. */
445COMMON int need_pass_2;
446
447/* TRUE if we should do no relaxing, and
448   leave lots of padding.  */
449COMMON int linkrelax;
450
451/* TRUE if we should produce a listing.  */
452extern int listing;
453
454/* Type of debugging information we should generate.  We currently
455   only support stabs and ECOFF.  */
456
457enum debug_info_type { DEBUG_NONE, DEBUG_STABS, DEBUG_ECOFF };
458
459extern enum debug_info_type debug_type;
460
461/* Maximum level of macro nesting.  */
462extern int max_macro_nest;
463
464/* Obstack chunk size.  Keep large for efficient space use, make small to
465   increase malloc calls for monitoring memory allocation.  */
466extern int chunksize;
467
468struct _pseudo_type
469  {
470    /* assembler mnemonic, lower case, no '.' */
471    const char *poc_name;
472    /* Do the work */
473    void (*poc_handler) PARAMS ((int));
474    /* Value to pass to handler */
475    int poc_val;
476  };
477
478typedef struct _pseudo_type pseudo_typeS;
479
480/* Prefer varargs for non-ANSI compiler, since some will barf if the
481   ellipsis definition is used with a no-arguments declaration.  */
482#if defined (HAVE_VARARGS_H) && !defined (__STDC__)
483#undef HAVE_STDARG_H
484#endif
485
486#if defined (HAVE_STDARG_H)
487#define USE_STDARG
488#endif
489#if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
490#define USE_VARARGS
491#endif
492
493#ifdef USE_STDARG
494#if (__GNUC__ >= 2) && !defined(VMS)
495/* for use with -Wformat */
496
497#if __GNUC_MINOR__ < 6
498/* Support for double underscores in attribute names was added in gcc
499   2.6, so avoid them if we are using an earlier version.  */
500#define __printf__ printf
501#define __format__ format
502#endif
503
504#define PRINTF_LIKE(FCN) \
505  void FCN (const char *format, ...) \
506    __attribute__ ((__format__ (__printf__, 1, 2)))
507#define PRINTF_WHERE_LIKE(FCN) \
508  void FCN (char *file, unsigned int line, const char *format, ...) \
509    __attribute__ ((__format__ (__printf__, 3, 4)))
510
511#else /* __GNUC__ < 2 || defined(VMS) */
512
513#define PRINTF_LIKE(FCN)	void FCN PARAMS ((const char *format, ...))
514#define PRINTF_WHERE_LIKE(FCN)	void FCN PARAMS ((char *file, \
515						  unsigned int line, \
516					  	  const char *format, ...))
517
518#endif /* __GNUC__ < 2 || defined(VMS) */
519
520#else /* ! USE_STDARG */
521
522#define PRINTF_LIKE(FCN)	void FCN ()
523#define PRINTF_WHERE_LIKE(FCN)	void FCN ()
524
525#endif /* ! USE_STDARG */
526
527PRINTF_LIKE (as_bad);
528PRINTF_LIKE (as_fatal);
529PRINTF_LIKE (as_tsktsk);
530PRINTF_LIKE (as_warn);
531PRINTF_WHERE_LIKE (as_bad_where);
532PRINTF_WHERE_LIKE (as_warn_where);
533
534void as_assert PARAMS ((const char *, int, const char *));
535void as_abort PARAMS ((const char *, int, const char *));
536
537void fprint_value PARAMS ((FILE *file, addressT value));
538void sprint_value PARAMS ((char *buf, addressT value));
539
540int had_errors PARAMS ((void));
541int had_warnings PARAMS ((void));
542
543void print_version_id PARAMS ((void));
544char *app_push PARAMS ((void));
545char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
546char *input_scrub_include_file PARAMS ((char *filename, char *position));
547char *input_scrub_new_file PARAMS ((char *filename));
548char *input_scrub_next_buffer PARAMS ((char **bufp));
549int do_scrub_chars PARAMS ((int (*get) (char **), char *to, int tolen));
550int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
551			  long exponent_bits));
552int had_err PARAMS ((void));
553int ignore_input PARAMS ((void));
554void cond_finish_check PARAMS ((int));
555void cond_exit_macro PARAMS ((int));
556int seen_at_least_1_file PARAMS ((void));
557void app_pop PARAMS ((char *arg));
558void as_howmuch PARAMS ((FILE * stream));
559void as_perror PARAMS ((const char *gripe, const char *filename));
560void as_where PARAMS ((char **namep, unsigned int *linep));
561void bump_line_counters PARAMS ((void));
562void do_scrub_begin PARAMS ((int));
563void input_scrub_begin PARAMS ((void));
564void input_scrub_close PARAMS ((void));
565void input_scrub_end PARAMS ((void));
566int new_logical_line PARAMS ((char *fname, int line_number));
567void subsegs_begin PARAMS ((void));
568void subseg_change PARAMS ((segT seg, int subseg));
569segT subseg_new PARAMS ((const char *name, subsegT subseg));
570segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
571void subseg_set PARAMS ((segT seg, subsegT subseg));
572#ifdef BFD_ASSEMBLER
573segT subseg_get PARAMS ((const char *, int));
574#endif
575
576void start_dependencies PARAMS ((char *));
577void register_dependency PARAMS ((char *));
578void print_dependencies PARAMS ((void));
579
580struct expressionS;
581struct fix;
582struct symbol;
583struct relax_type;
584typedef struct frag fragS;
585
586#ifdef BFD_ASSEMBLER
587/* literal.c */
588valueT add_to_literal_pool PARAMS ((struct symbol *, valueT, segT, int));
589#endif
590
591int check_eh_frame PARAMS ((struct expressionS *, unsigned int *));
592int eh_frame_estimate_size_before_relax PARAMS ((fragS *));
593int eh_frame_relax_frag PARAMS ((fragS *));
594void eh_frame_convert_frag PARAMS ((fragS *));
595
596#include "expr.h"		/* Before targ-*.h */
597
598/* this one starts the chain of target dependant headers */
599#include "targ-env.h"
600
601#include "struc-symbol.h"
602#include "write.h"
603#include "frags.h"
604#include "hash.h"
605#include "read.h"
606#include "symbols.h"
607
608#include "tc.h"
609#include "obj.h"
610
611#ifdef USE_EMULATIONS
612#include "emul.h"
613#endif
614#include "listing.h"
615
616#ifndef LOCAL_LABELS_DOLLAR
617#define LOCAL_LABELS_DOLLAR 0
618#endif
619
620#ifndef LOCAL_LABELS_FB
621#define LOCAL_LABELS_FB 0
622#endif
623
624#ifndef TEXT_SECTION_NAME
625#define TEXT_SECTION_NAME	".text"
626#define DATA_SECTION_NAME	".data"
627#define BSS_SECTION_NAME	".bss"
628#endif
629
630#endif /* GAS */
631
632/* end of as.h */
633