1/* as.h - global header file
2   Copyright 1987, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3   1999, 2000, 2001, 2002, 2003, 2004, 2005
4   Free Software Foundation, Inc.
5
6   This file is part of GAS, the GNU Assembler.
7
8   GAS is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2, or (at your option)
11   any later version.
12
13   GAS is distributed in the hope that it will be useful,
14   but WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16   GNU General Public License for more details.
17
18   You should have received a copy of the GNU General Public License
19   along with GAS; see the file COPYING.  If not, write to the Free
20   Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
21   02110-1301, USA.  */
22
23#ifndef GAS
24#define GAS 1
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#include "config.h"
40#include "bin-bugs.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 void* version for STDC case.  This is to be compatible with
46   the declaration in bison.simple, used for m68k operand parsing.
47   --KR 1995.08.08 */
48/* Force void* decl for hpux.  This is what Bison uses.  --KR 1995.08.16 */
49
50#ifndef __GNUC__
51# if HAVE_ALLOCA_H
52#  include <alloca.h>
53# else
54#  ifdef _AIX
55/* Indented so that pre-ansi C compilers will ignore it, rather than
56   choke on it.  Some versions of AIX require this to be the first
57   thing in the file.  */
58 #pragma alloca
59#  else
60#   ifndef alloca /* predefined by HP cc +Olibcalls */
61#    if !defined (__STDC__) && !defined (__hpux)
62extern char *alloca ();
63#    else
64extern void *alloca ();
65#    endif /* __STDC__, __hpux */
66#   endif /* alloca */
67#  endif /* _AIX */
68# endif /* HAVE_ALLOCA_H */
69#endif /* __GNUC__ */
70
71/* Prefer varargs for non-ANSI compiler, since some will barf if the
72   ellipsis definition is used with a no-arguments declaration.  */
73#if defined (HAVE_VARARGS_H) && !defined (__STDC__)
74#undef HAVE_STDARG_H
75#endif
76
77#if defined (HAVE_STDARG_H)
78#define USE_STDARG
79#endif
80#if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
81#define USE_VARARGS
82#endif
83
84/* Now, tend to the rest of the configuration.  */
85
86/* System include files first...  */
87#include <stdio.h>
88#ifdef HAVE_STRING_H
89#include <string.h>
90#else
91#ifdef HAVE_STRINGS_H
92#include <strings.h>
93#endif
94#endif
95#ifdef HAVE_STDLIB_H
96#include <stdlib.h>
97#endif
98#ifdef HAVE_UNISTD_H
99#include <unistd.h>
100#endif
101#ifdef HAVE_SYS_TYPES_H
102/* for size_t, pid_t */
103#include <sys/types.h>
104#endif
105
106#ifdef HAVE_ERRNO_H
107#include <errno.h>
108#endif
109
110#ifdef USE_STDARG
111#include <stdarg.h>
112#endif
113
114#ifdef USE_VARARGS
115#include <varargs.h>
116#endif
117
118#if !defined (USE_STDARG) && !defined (USE_VARARGS)
119/* Roll our own.  */
120#define va_alist REST
121#define va_dcl
122typedef int * va_list;
123#define va_start(ARGS)	ARGS = &REST
124#define va_end(ARGS)
125#endif
126
127#include "getopt.h"
128/* The first getopt value for machine-independent long options.
129   150 isn't special; it's just an arbitrary non-ASCII char value.  */
130#define OPTION_STD_BASE 150
131/* The first getopt value for machine-dependent long options.
132   190 gives the standard options room to grow.  */
133#define OPTION_MD_BASE 190
134
135#ifdef DEBUG
136#undef NDEBUG
137#endif
138#if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
139#define __PRETTY_FUNCTION__  ((char*)0)
140#endif
141#define assert(P) \
142  ((void) ((P) ? 0 : (as_assert (__FILE__, __LINE__, __PRETTY_FUNCTION__), 0)))
143#undef abort
144#define abort()		as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
145
146/* Now GNU header files...  */
147#include "ansidecl.h"
148#include "bfd.h"
149#include "libiberty.h"
150
151/* Define the standard progress macros.  */
152#include "progress.h"
153
154/* This doesn't get taken care of anywhere.  */
155#ifndef __MWERKS__  /* Metrowerks C chokes on the "defined (inline)"  */
156#if !defined (__GNUC__) && !defined (inline)
157#define inline
158#endif
159#endif /* !__MWERKS__ */
160
161/* Other stuff from config.h.  */
162#ifdef NEED_DECLARATION_ENVIRON
163extern char **environ;
164#endif
165#ifdef NEED_DECLARATION_ERRNO
166extern int errno;
167#endif
168#ifdef NEED_DECLARATION_FFS
169extern int ffs (int);
170#endif
171#ifdef NEED_DECLARATION_FREE
172extern void free ();
173#endif
174#ifdef NEED_DECLARATION_MALLOC
175extern PTR malloc ();
176extern PTR realloc ();
177#endif
178#ifdef NEED_DECLARATION_STRSTR
179extern char *strstr ();
180#endif
181
182#if !HAVE_DECL_VSNPRINTF
183extern int vsnprintf(char *, size_t, const char *, va_list);
184#endif
185
186/* This is needed for VMS.  */
187#if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
188#define unlink remove
189#endif
190
191/* Hack to make "gcc -Wall" not complain about obstack macros.  */
192#if !defined (memcpy) && !defined (bcopy)
193#define bcopy(src,dest,size)	memcpy (dest, src, size)
194#endif
195
196/* Make Saber happier on obstack.h.  */
197#ifdef SABER
198#undef  __PTR_TO_INT
199#define __PTR_TO_INT(P) ((int) (P))
200#undef  __INT_TO_PTR
201#define __INT_TO_PTR(P) ((char *) (P))
202#endif
203
204#ifndef __LINE__
205#define __LINE__ "unknown"
206#endif /* __LINE__ */
207
208#ifndef __FILE__
209#define __FILE__ "unknown"
210#endif /* __FILE__ */
211
212#ifndef FOPEN_WB
213#if defined GO32 || defined __MINGW32__
214#include "fopen-bin.h"
215#else
216#include "fopen-same.h"
217#endif
218#endif
219
220#ifndef EXIT_SUCCESS
221#define EXIT_SUCCESS 0
222#define EXIT_FAILURE 1
223#endif
224
225#ifndef SEEK_SET
226#define SEEK_SET 0
227#endif
228
229#define obstack_chunk_alloc xmalloc
230#define obstack_chunk_free xfree
231
232#define xfree free
233
234#include "asintl.h"
235
236#define BAD_CASE(val)							    \
237  {									    \
238    as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"),   \
239	      (long) val, __LINE__, __FILE__);				    \
240  }
241
242#include "flonum.h"
243
244/* These are assembler-wide concepts */
245
246extern bfd *stdoutput;
247typedef bfd_vma addressT;
248typedef bfd_signed_vma offsetT;
249
250/* Type of symbol value, etc.  For use in prototypes.  */
251typedef addressT valueT;
252
253#ifndef COMMON
254#ifdef TEST
255#define COMMON			/* Declare our COMMONs storage here.  */
256#else
257#define COMMON extern		/* Our commons live elsewhere.  */
258#endif
259#endif
260/* COMMON now defined */
261
262#ifdef DEBUG
263#ifndef know
264#define know(p) assert(p)	/* Verify our assumptions!  */
265#endif /* not yet defined */
266#else
267#define know(p)			/* know() checks are no-op.ed  */
268#endif
269
270/* input_scrub.c */
271
272/* Supplies sanitised buffers to read.c.
273   Also understands printing line-number part of error messages.  */
274
275/* subsegs.c     Sub-segments. Also, segment(=expression type)s.*/
276
277typedef asection *segT;
278#define SEG_NORMAL(SEG)		(   (SEG) != absolute_section	\
279				 && (SEG) != undefined_section	\
280				 && (SEG) != reg_section	\
281				 && (SEG) != expr_section)
282typedef int subsegT;
283
284/* What subseg we are accessing now?  */
285COMMON subsegT now_subseg;
286
287/* Segment our instructions emit to.  */
288COMMON segT now_seg;
289
290#define segment_name(SEG)	bfd_get_section_name (stdoutput, SEG)
291
292extern segT reg_section, expr_section;
293/* Shouldn't these be eliminated someday?  */
294extern segT text_section, data_section, bss_section;
295#define absolute_section	bfd_abs_section_ptr
296#define undefined_section	bfd_und_section_ptr
297
298enum _relax_state
299{
300  /* Dummy frag used by listing code.  */
301  rs_dummy = 0,
302
303  /* Variable chars to be repeated fr_offset times.
304     Fr_symbol unused. Used with fr_offset == 0 for a
305     constant length frag.  */
306  rs_fill,
307
308  /* Align.  The fr_offset field holds the power of 2 to which to
309     align.  The fr_var field holds the number of characters in the
310     fill pattern.  The fr_subtype field holds the maximum number of
311     bytes to skip when aligning, or 0 if there is no maximum.  */
312  rs_align,
313
314  /* Align code.  The fr_offset field holds the power of 2 to which
315     to align.  This type is only generated by machine specific
316     code, which is normally responsible for handling the fill
317     pattern.  The fr_subtype field holds the maximum number of
318     bytes to skip when aligning, or 0 if there is no maximum.  */
319  rs_align_code,
320
321  /* Test for alignment.  Like rs_align, but used by several targets
322     to warn if data is not properly aligned.  */
323  rs_align_test,
324
325  /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
326     character.  */
327  rs_org,
328
329#ifndef WORKING_DOT_WORD
330  /* JF: gunpoint */
331  rs_broken_word,
332#endif
333
334  /* Machine specific relaxable (or similarly alterable) instruction.  */
335  rs_machine_dependent,
336
337  /* .space directive with expression operand that needs to be computed
338     later.  Similar to rs_org, but different.
339     fr_symbol: operand
340     1 variable char: fill character  */
341  rs_space,
342
343  /* A DWARF leb128 value; only ELF uses this.  The subtype is 0 for
344     unsigned, 1 for signed.  */
345  rs_leb128,
346
347  /* Exception frame information which we may be able to optimize.  */
348  rs_cfa,
349
350  /* Cross-fragment dwarf2 line number optimization.  */
351  rs_dwarf2dbg
352};
353
354typedef enum _relax_state relax_stateT;
355
356/* This type is used in prototypes, so it can't be a type that will be
357   widened for argument passing.  */
358typedef unsigned int relax_substateT;
359
360/* Enough bits for address, but still an integer type.
361   Could be a problem, cross-assembling for 64-bit machines.  */
362typedef addressT relax_addressT;
363
364struct relax_type
365{
366  /* Forward reach. Signed number. > 0.  */
367  offsetT rlx_forward;
368  /* Backward reach. Signed number. < 0.  */
369  offsetT rlx_backward;
370
371  /* Bytes length of this address.  */
372  unsigned char rlx_length;
373
374  /* Next longer relax-state.  0 means there is no 'next' relax-state.  */
375  relax_substateT rlx_more;
376};
377
378typedef struct relax_type relax_typeS;
379
380/* main program "as.c" (command arguments etc).  */
381
382COMMON unsigned char flag_no_comments; /* -f */
383COMMON unsigned char flag_debug; /* -D */
384COMMON unsigned char flag_signed_overflow_ok; /* -J */
385#ifndef WORKING_DOT_WORD
386COMMON unsigned char flag_warn_displacement; /* -K */
387#endif
388
389/* True if local symbols should be retained.  */
390COMMON int flag_keep_locals; /* -L */
391
392/* True if we are assembling in MRI mode.  */
393COMMON int flag_mri;
394
395/* Should the data section be made read-only and appended to the text
396   section?  */
397COMMON unsigned char flag_readonly_data_in_text; /* -R */
398
399/* True if warnings should be inhibited.  */
400COMMON int flag_no_warnings; /* -W */
401
402/* True if warnings count as errors.  */
403COMMON int flag_fatal_warnings; /* --fatal-warnings */
404
405/* True if we should attempt to generate output even if non-fatal errors
406   are detected.  */
407COMMON unsigned char flag_always_generate_output; /* -Z */
408
409/* This is true if the assembler should output time and space usage.  */
410COMMON unsigned char flag_print_statistics;
411
412/* True if local absolute symbols are to be stripped.  */
413COMMON int flag_strip_local_absolute;
414
415/* True if we should generate a traditional format object file.  */
416COMMON int flag_traditional_format;
417
418/* TRUE if .note.GNU-stack section with SEC_CODE should be created */
419COMMON int flag_execstack;
420
421/* TRUE if .note.GNU-stack section with SEC_CODE should be created */
422COMMON int flag_noexecstack;
423
424/* name of emitted object file */
425COMMON char *out_file_name;
426
427/* name of file defining extensions to the basic instruction set */
428COMMON char *insttbl_file_name;
429
430/* TRUE if we need a second pass.  */
431COMMON int need_pass_2;
432
433/* TRUE if we should do no relaxing, and
434   leave lots of padding.  */
435COMMON int linkrelax;
436
437/* TRUE if we should produce a listing.  */
438extern int listing;
439
440/* Type of debugging information we should generate.  We currently support
441   stabs, ECOFF, and DWARF2.
442
443   NOTE!  This means debug information about the assembly source code itself
444   and _not_ about possible debug information from a high-level language.
445   This is especially relevant to DWARF2, since the compiler may emit line
446   number directives that the assembler resolves.  */
447
448enum debug_info_type
449{
450  DEBUG_UNSPECIFIED,
451  DEBUG_NONE,
452  DEBUG_STABS,
453  DEBUG_ECOFF,
454  DEBUG_DWARF,
455  DEBUG_DWARF2
456};
457
458extern enum debug_info_type debug_type;
459extern int use_gnu_debug_info_extensions;
460
461/* Maximum level of macro nesting.  */
462extern int max_macro_nest;
463
464/* Verbosity level.  */
465extern int verbose;
466
467/* Obstack chunk size.  Keep large for efficient space use, make small to
468   increase malloc calls for monitoring memory allocation.  */
469extern int chunksize;
470
471struct _pseudo_type
472{
473  /* assembler mnemonic, lower case, no '.' */
474  const char *poc_name;
475  /* Do the work */
476  void (*poc_handler) (int);
477  /* Value to pass to handler */
478  int poc_val;
479};
480
481typedef struct _pseudo_type pseudo_typeS;
482
483#ifdef USE_STDARG
484#if (__GNUC__ >= 2) && !defined(VMS)
485/* for use with -Wformat */
486
487#if __GNUC__ == 2 && __GNUC_MINOR__ < 6
488/* Support for double underscores in attribute names was added in gcc
489   2.6, so avoid them if we are using an earlier version.  */
490#define __printf__ printf
491#define __format__ format
492#endif
493
494#define PRINTF_LIKE(FCN) \
495  void FCN (const char *format, ...) \
496    __attribute__ ((__format__ (__printf__, 1, 2)))
497#define PRINTF_WHERE_LIKE(FCN) \
498  void FCN (char *file, unsigned int line, const char *format, ...) \
499    __attribute__ ((__format__ (__printf__, 3, 4)))
500
501#else /* __GNUC__ < 2 || defined(VMS) */
502
503#define PRINTF_LIKE(FCN)	void FCN (const char *format, ...)
504#define PRINTF_WHERE_LIKE(FCN)	void FCN (char *file, \
505					  unsigned int line, \
506					  const char *format, ...)
507
508#endif /* __GNUC__ < 2 || defined(VMS) */
509
510#else /* ! USE_STDARG */
511
512#define PRINTF_LIKE(FCN)	void FCN ()
513#define PRINTF_WHERE_LIKE(FCN)	void FCN ()
514
515#endif /* ! USE_STDARG */
516
517PRINTF_LIKE (as_bad);
518PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
519PRINTF_LIKE (as_tsktsk);
520PRINTF_LIKE (as_warn);
521PRINTF_WHERE_LIKE (as_bad_where);
522PRINTF_WHERE_LIKE (as_warn_where);
523
524void   as_assert (const char *, int, const char *);
525void   as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
526void   sprint_value (char *, addressT);
527int    had_errors (void);
528int    had_warnings (void);
529void   as_warn_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
530void   as_bad_value_out_of_range (char *, offsetT, offsetT, offsetT, char *, unsigned);
531void   print_version_id (void);
532char * app_push (void);
533char * atof_ieee (char *, int, LITTLENUM_TYPE *);
534char * input_scrub_include_file (char *, char *);
535void   input_scrub_insert_line (const char *);
536void   input_scrub_insert_file (char *);
537char * input_scrub_new_file (char *);
538char * input_scrub_next_buffer (char **bufp);
539int    do_scrub_chars (int (*get) (char *, int), char *, int);
540int    gen_to_words (LITTLENUM_TYPE *, int, long);
541int    had_err (void);
542int    ignore_input (void);
543void   cond_finish_check (int);
544void   cond_exit_macro (int);
545int    seen_at_least_1_file (void);
546void   app_pop (char *);
547void   as_perror (const char *, const char *);
548void   as_where (char **, unsigned int *);
549void   bump_line_counters (void);
550void   do_scrub_begin (int);
551void   input_scrub_begin (void);
552void   input_scrub_close (void);
553void   input_scrub_end (void);
554int    new_logical_line (char *, int);
555void   subsegs_begin (void);
556void   subseg_change (segT, int);
557segT   subseg_new (const char *, subsegT);
558segT   subseg_force_new (const char *, subsegT);
559void   subseg_set (segT, subsegT);
560int    subseg_text_p (segT);
561int    seg_not_empty_p (segT);
562void   start_dependencies (char *);
563void   register_dependency (char *);
564void   print_dependencies (void);
565segT   subseg_get (const char *, int);
566
567struct expressionS;
568struct fix;
569typedef struct symbol symbolS;
570typedef struct frag fragS;
571
572/* literal.c */
573valueT add_to_literal_pool (symbolS *, valueT, segT, int);
574
575int check_eh_frame (struct expressionS *, unsigned int *);
576int eh_frame_estimate_size_before_relax (fragS *);
577int eh_frame_relax_frag (fragS *);
578void eh_frame_convert_frag (fragS *);
579int generic_force_reloc (struct fix *);
580
581#include "expr.h"		/* Before targ-*.h */
582
583/* This one starts the chain of target dependant headers.  */
584#include "targ-env.h"
585
586#ifdef OBJ_MAYBE_ELF
587#define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
588#else
589#ifdef OBJ_ELF
590#define IS_ELF 1
591#else
592#define IS_ELF 0
593#endif
594#endif
595
596#include "write.h"
597#include "frags.h"
598#include "hash.h"
599#include "read.h"
600#include "symbols.h"
601
602#include "tc.h"
603#include "obj.h"
604
605#ifdef USE_EMULATIONS
606#include "emul.h"
607#endif
608#include "listing.h"
609
610#ifdef TC_M68K
611/* True if we are assembling in m68k MRI mode.  */
612COMMON int flag_m68k_mri;
613#define DOLLAR_AMBIGU flag_m68k_mri
614#else
615#define flag_m68k_mri 0
616#endif
617
618#ifdef WARN_COMMENTS
619COMMON int           warn_comment;
620COMMON unsigned int  found_comment;
621COMMON char *        found_comment_file;
622#endif
623
624#ifndef DOLLAR_AMBIGU
625#define DOLLAR_AMBIGU 0
626#endif
627
628#ifndef NUMBERS_WITH_SUFFIX
629#define NUMBERS_WITH_SUFFIX 0
630#endif
631
632#ifndef LOCAL_LABELS_DOLLAR
633#define LOCAL_LABELS_DOLLAR 0
634#endif
635
636#ifndef LOCAL_LABELS_FB
637#define LOCAL_LABELS_FB 0
638#endif
639
640#ifndef LABELS_WITHOUT_COLONS
641#define LABELS_WITHOUT_COLONS 0
642#endif
643
644#ifndef NO_PSEUDO_DOT
645#define NO_PSEUDO_DOT 0
646#endif
647
648#ifndef TEXT_SECTION_NAME
649#define TEXT_SECTION_NAME	".text"
650#define DATA_SECTION_NAME	".data"
651#define BSS_SECTION_NAME	".bss"
652#endif
653
654#ifndef OCTETS_PER_BYTE_POWER
655#define OCTETS_PER_BYTE_POWER 0
656#endif
657#ifndef OCTETS_PER_BYTE
658#define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
659#endif
660#if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
661 #error "Octets per byte conflicts with its power-of-two definition!"
662#endif
663
664#endif /* GAS */
665