This commit was generated by cvs2svn to track changes on a CVS vendor
[external/binutils.git] / gas / as.h
1 /* as.h - global header file
2    Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 97, 98, 1999
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__
57 extern void *alloca ();
58 #  else
59 extern 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)
71 extern char *alloca ();
72 #    else
73 extern 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
158 extern char *strstr ();
159 #endif
160 #ifdef NEED_DECLARATION_MALLOC
161 extern PTR malloc ();
162 extern PTR realloc ();
163 #endif
164 #ifdef NEED_DECLARATION_FREE
165 extern void free ();
166 #endif
167 #ifdef NEED_DECLARATION_ERRNO
168 extern int errno;
169 #endif
170 #ifdef NEED_DECLARATION_ENVIRON
171 extern char **environ;
172 #endif
173
174 /* This is needed for VMS.  */
175 #if ! defined (HAVE_UNLINK) && defined (HAVE_REMOVE)
176 #define unlink remove
177 #endif
178
179 /* Hack to make "gcc -Wall" not complain about obstack macros.  */
180 #if !defined (memcpy) && !defined (bcopy)
181 #define bcopy(src,dest,size)    memcpy(dest,src,size)
182 #endif
183
184 /* Make Saber happier on obstack.h.  */
185 #ifdef SABER
186 #undef  __PTR_TO_INT
187 #define __PTR_TO_INT(P) ((int)(P))
188 #undef  __INT_TO_PTR
189 #define __INT_TO_PTR(P) ((char *)(P))
190 #endif
191
192 #ifndef __LINE__
193 #define __LINE__ "unknown"
194 #endif /* __LINE__ */
195
196 #ifndef __FILE__
197 #define __FILE__ "unknown"
198 #endif /* __FILE__ */
199
200 #ifndef FOPEN_WB
201 #ifdef GO32
202 #include "fopen-bin.h"
203 #else
204 #include "fopen-same.h"
205 #endif
206 #endif
207
208 #ifndef EXIT_SUCCESS
209 #define EXIT_SUCCESS 0
210 #define EXIT_FAILURE 1
211 #endif
212
213 #define obstack_chunk_alloc xmalloc
214 #define obstack_chunk_free xfree
215
216 #define xfree free
217
218 #include "asintl.h"
219
220 #define BAD_CASE(val) \
221 { \
222       as_fatal(_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
223                (long) val, __LINE__, __FILE__); \
224            }
225 \f
226 #include "flonum.h"
227
228 /* These are assembler-wide concepts */
229
230 #ifdef BFD_ASSEMBLER
231 extern bfd *stdoutput;
232 typedef bfd_vma addressT;
233 typedef bfd_signed_vma offsetT;
234 #else
235 typedef unsigned long addressT;
236 typedef long offsetT;
237 #endif
238
239 /* Type of symbol value, etc.  For use in prototypes.  */
240 typedef addressT valueT;
241
242 #ifndef COMMON
243 #ifdef TEST
244 #define COMMON                  /* declare our COMMONs storage here. */
245 #else
246 #define COMMON extern           /* our commons live elswhere */
247 #endif
248 #endif
249 /* COMMON now defined */
250
251 #ifdef DEBUG
252 #ifndef know
253 #define know(p) assert(p)       /* Verify our assumptions! */
254 #endif /* not yet defined */
255 #else
256 #define know(p)                 /* know() checks are no-op.ed */
257 #endif
258 \f
259 /* input_scrub.c */
260
261 /*
262  * Supplies sanitised buffers to read.c.
263  * Also understands printing line-number part of error messages.
264  */
265 \f
266
267 /* subsegs.c     Sub-segments. Also, segment(=expression type)s.*/
268
269 #ifndef BFD_ASSEMBLER
270
271 #ifdef MANY_SEGMENTS
272 #include "bfd.h"
273 #define N_SEGMENTS 40
274 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E39)
275 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9,\
276                  SEG_E10,SEG_E11,SEG_E12,SEG_E13,SEG_E14,SEG_E15,SEG_E16,SEG_E17,SEG_E18,SEG_E19,\
277                  SEG_E20,SEG_E21,SEG_E22,SEG_E23,SEG_E24,SEG_E25,SEG_E26,SEG_E27,SEG_E28,SEG_E29,\
278                  SEG_E30,SEG_E31,SEG_E32,SEG_E33,SEG_E34,SEG_E35,SEG_E36,SEG_E37,SEG_E38,SEG_E39
279 #define SEG_TEXT SEG_E0
280 #define SEG_DATA SEG_E1
281 #define SEG_BSS SEG_E2
282 #define SEG_LAST SEG_E39
283 #else
284 #define N_SEGMENTS 3
285 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
286 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
287 #endif
288
289 typedef enum _segT
290   {
291     SEG_ABSOLUTE = 0,
292     SEG_LIST,
293     SEG_UNKNOWN,
294     SEG_GOOF,                   /* Only happens if AS has a logic error. */
295     /* Invented so we don't crash printing */
296     /* error message involving weird segment. */
297     SEG_EXPR,                   /* Intermediate expression values. */
298     SEG_DEBUG,                  /* Debug segment */
299     SEG_NTV,                    /* Transfert vector preload segment */
300     SEG_PTV,                    /* Transfert vector postload segment */
301     SEG_REGISTER                /* Mythical: a register-valued expression */
302   } segT;
303
304 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
305 #else
306 typedef asection *segT;
307 #define SEG_NORMAL(SEG)         ((SEG) != absolute_section      \
308                                  && (SEG) != undefined_section  \
309                                  && (SEG) != reg_section        \
310                                  && (SEG) != expr_section)
311 #endif
312 typedef int subsegT;
313
314 /* What subseg we are accreting now? */
315 COMMON subsegT now_subseg;
316
317 /* Segment our instructions emit to. */
318 COMMON segT now_seg;
319
320 #ifdef BFD_ASSEMBLER
321 #define segment_name(SEG)       bfd_get_section_name (stdoutput, SEG)
322 #else
323 extern char const *const seg_name[];
324 #define segment_name(SEG)       seg_name[(int) (SEG)]
325 #endif
326
327 #ifndef BFD_ASSEMBLER
328 extern int section_alignment[];
329 #endif
330
331 #ifdef BFD_ASSEMBLER
332 extern segT reg_section, expr_section;
333 /* Shouldn't these be eliminated someday?  */
334 extern segT text_section, data_section, bss_section;
335 #define absolute_section        bfd_abs_section_ptr
336 #define undefined_section       bfd_und_section_ptr
337 #else
338 #define reg_section             SEG_REGISTER
339 #define expr_section            SEG_EXPR
340 #define text_section            SEG_TEXT
341 #define data_section            SEG_DATA
342 #define bss_section             SEG_BSS
343 #define absolute_section        SEG_ABSOLUTE
344 #define undefined_section       SEG_UNKNOWN
345 #endif
346
347 /* relax() */
348
349 enum _relax_state
350   {
351     /* Variable chars to be repeated fr_offset times.
352        Fr_symbol unused. Used with fr_offset == 0 for a
353        constant length frag. */
354     rs_fill = 1,
355
356     /* Align.  The fr_offset field holds the power of 2 to which to
357        align.  The fr_var field holds the number of characters in the
358        fill pattern.  The fr_subtype field holds the maximum number of
359        bytes to skip when aligning, or 0 if there is no maximum.  */
360     rs_align,
361
362     /* Align code.  The fr_offset field holds the power of 2 to which
363        to align.  This type is only generated by machine specific
364        code, which is normally responsible for handling the fill
365        pattern.  The fr_subtype field holds the maximum number of
366        bytes to skip when aligning, or 0 if there is no maximum.  */
367     rs_align_code,
368
369     /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
370        character. */
371     rs_org,
372
373 #ifndef WORKING_DOT_WORD
374     /* JF: gunpoint */
375     rs_broken_word,
376 #endif
377
378     /* machine-specific relaxable (or similarly alterable) instruction */
379     rs_machine_dependent,
380
381     /* .space directive with expression operand that needs to be computed
382        later.  Similar to rs_org, but different.
383        fr_symbol: operand
384        1 variable char: fill character  */
385     rs_space,
386
387     /* A DWARF leb128 value; only ELF uses this.  The subtype is 0 for
388        unsigned, 1 for signed.  */
389     rs_leb128,
390
391     /* Exception frame information which we may be able to optimize.  */
392     rs_cfa
393   };
394
395 typedef enum _relax_state relax_stateT;
396
397 /* This type is used in prototypes, so it can't be a type that will be
398    widened for argument passing.  */
399 typedef unsigned int relax_substateT;
400
401 /* Enough bits for address, but still an integer type.
402    Could be a problem, cross-assembling for 64-bit machines.  */
403 typedef addressT relax_addressT;
404 \f
405 /* main program "as.c" (command arguments etc) */
406
407 COMMON unsigned char flag_no_comments; /* -f */
408 COMMON unsigned char flag_debug; /* -D */
409 COMMON unsigned char flag_signed_overflow_ok; /* -J */
410 #ifndef WORKING_DOT_WORD
411 COMMON unsigned char flag_warn_displacement; /* -K */
412 #endif
413
414 /* True if local symbols should be retained.  */
415 COMMON int flag_keep_locals; /* -L */
416
417 /* True if we are assembling in MRI mode.  */
418 COMMON int flag_mri;
419
420 /* True if we are assembling in m68k MRI mode.  */
421 COMMON int flag_m68k_mri;
422
423 /* Should the data section be made read-only and appended to the text
424    section?  */
425 COMMON unsigned char flag_readonly_data_in_text; /* -R */
426
427 /* True if warnings should be inhibited.  */
428 COMMON int flag_no_warnings; /* -W */
429
430 /* True if we should attempt to generate output even if non-fatal errors
431    are detected.  */
432 COMMON unsigned char flag_always_generate_output; /* -Z */
433
434 /* This is true if the assembler should output time and space usage. */
435 COMMON unsigned char flag_print_statistics;
436
437 /* True if local absolute symbols are to be stripped.  */
438 COMMON int flag_strip_local_absolute;
439
440 /* True if we should generate a traditional format object file.  */
441 COMMON int flag_traditional_format;
442
443 /* name of emitted object file */
444 COMMON char *out_file_name;
445
446 /* name of file defining extensions to the basic instruction set */
447 COMMON char *insttbl_file_name;
448
449 /* TRUE if we need a second pass. */
450 COMMON int need_pass_2;
451
452 /* TRUE if we should do no relaxing, and
453    leave lots of padding.  */
454 COMMON int linkrelax;
455
456 /* TRUE if we should produce a listing.  */
457 extern int listing;
458
459 /* Type of debugging information we should generate.  We currently
460    support stabs, ECOFF, and DWARF2.  */
461
462 enum debug_info_type
463   {
464     DEBUG_UNSPECIFIED,
465     DEBUG_NONE,
466     DEBUG_STABS,
467     DEBUG_ECOFF,
468     DEBUG_DWARF,
469     DEBUG_DWARF2
470   };
471
472 extern enum debug_info_type debug_type;
473 \f
474 /* Maximum level of macro nesting.  */
475 extern int max_macro_nest;
476
477 /* Obstack chunk size.  Keep large for efficient space use, make small to
478    increase malloc calls for monitoring memory allocation.  */
479 extern int chunksize;
480
481 struct _pseudo_type
482   {
483     /* assembler mnemonic, lower case, no '.' */
484     const char *poc_name;
485     /* Do the work */
486     void (*poc_handler) PARAMS ((int));
487     /* Value to pass to handler */
488     int poc_val;
489   };
490
491 typedef struct _pseudo_type pseudo_typeS;
492
493 /* Prefer varargs for non-ANSI compiler, since some will barf if the
494    ellipsis definition is used with a no-arguments declaration.  */
495 #if defined (HAVE_VARARGS_H) && !defined (__STDC__)
496 #undef HAVE_STDARG_H
497 #endif
498
499 #if defined (HAVE_STDARG_H)
500 #define USE_STDARG
501 #endif
502 #if !defined (USE_STDARG) && defined (HAVE_VARARGS_H)
503 #define USE_VARARGS
504 #endif
505
506 #ifdef USE_STDARG
507 #if (__GNUC__ >= 2) && !defined(VMS)
508 /* for use with -Wformat */
509
510 #if __GNUC_MINOR__ < 6
511 /* Support for double underscores in attribute names was added in gcc
512    2.6, so avoid them if we are using an earlier version.  */
513 #define __printf__ printf
514 #define __format__ format
515 #endif
516
517 #define PRINTF_LIKE(FCN) \
518   void FCN (const char *format, ...) \
519     __attribute__ ((__format__ (__printf__, 1, 2)))
520 #define PRINTF_WHERE_LIKE(FCN) \
521   void FCN (char *file, unsigned int line, const char *format, ...) \
522     __attribute__ ((__format__ (__printf__, 3, 4)))
523
524 #else /* __GNUC__ < 2 || defined(VMS) */
525
526 #define PRINTF_LIKE(FCN)        void FCN PARAMS ((const char *format, ...))
527 #define PRINTF_WHERE_LIKE(FCN)  void FCN PARAMS ((char *file, \
528                                                   unsigned int line, \
529                                                   const char *format, ...))
530
531 #endif /* __GNUC__ < 2 || defined(VMS) */
532
533 #else /* ! USE_STDARG */
534
535 #define PRINTF_LIKE(FCN)        void FCN ()
536 #define PRINTF_WHERE_LIKE(FCN)  void FCN ()
537
538 #endif /* ! USE_STDARG */
539
540 PRINTF_LIKE (as_bad);
541 PRINTF_LIKE (as_fatal);
542 PRINTF_LIKE (as_tsktsk);
543 PRINTF_LIKE (as_warn);
544 PRINTF_WHERE_LIKE (as_bad_where);
545 PRINTF_WHERE_LIKE (as_warn_where);
546
547 void as_assert PARAMS ((const char *, int, const char *));
548 void as_abort PARAMS ((const char *, int, const char *));
549
550 void fprint_value PARAMS ((FILE *file, addressT value));
551 void sprint_value PARAMS ((char *buf, addressT value));
552
553 int had_errors PARAMS ((void));
554 int had_warnings PARAMS ((void));
555
556 void print_version_id PARAMS ((void));
557 char *app_push PARAMS ((void));
558 char *atof_ieee PARAMS ((char *str, int what_kind, LITTLENUM_TYPE * words));
559 char *input_scrub_include_file PARAMS ((char *filename, char *position));
560 char *input_scrub_new_file PARAMS ((char *filename));
561 char *input_scrub_next_buffer PARAMS ((char **bufp));
562 int do_scrub_chars PARAMS ((int (*get) (char *, int), char *to, int tolen));
563 int gen_to_words PARAMS ((LITTLENUM_TYPE * words, int precision,
564                           long exponent_bits));
565 int had_err PARAMS ((void));
566 int ignore_input PARAMS ((void));
567 void cond_finish_check PARAMS ((int));
568 void cond_exit_macro PARAMS ((int));
569 int seen_at_least_1_file PARAMS ((void));
570 void app_pop PARAMS ((char *arg));
571 void as_howmuch PARAMS ((FILE * stream));
572 void as_perror PARAMS ((const char *gripe, const char *filename));
573 void as_where PARAMS ((char **namep, unsigned int *linep));
574 void bump_line_counters PARAMS ((void));
575 void do_scrub_begin PARAMS ((int));
576 void input_scrub_begin PARAMS ((void));
577 void input_scrub_close PARAMS ((void));
578 void input_scrub_end PARAMS ((void));
579 int new_logical_line PARAMS ((char *fname, int line_number));
580 void subsegs_begin PARAMS ((void));
581 void subseg_change PARAMS ((segT seg, int subseg));
582 segT subseg_new PARAMS ((const char *name, subsegT subseg));
583 segT subseg_force_new PARAMS ((const char *name, subsegT subseg));
584 void subseg_set PARAMS ((segT seg, subsegT subseg));
585 #ifdef BFD_ASSEMBLER
586 segT subseg_get PARAMS ((const char *, int));
587 #endif
588 int subseg_text_p PARAMS ((segT));
589
590 void start_dependencies PARAMS ((char *));
591 void register_dependency PARAMS ((char *));
592 void print_dependencies PARAMS ((void));
593
594 struct expressionS;
595 struct fix;
596 typedef struct symbol symbolS;
597 struct relax_type;
598 typedef struct frag fragS;
599
600 #ifdef BFD_ASSEMBLER
601 /* literal.c */
602 valueT add_to_literal_pool PARAMS ((symbolS *, valueT, segT, int));
603 #endif
604
605 int check_eh_frame PARAMS ((struct expressionS *, unsigned int *));
606 int eh_frame_estimate_size_before_relax PARAMS ((fragS *));
607 int eh_frame_relax_frag PARAMS ((fragS *));
608 void eh_frame_convert_frag PARAMS ((fragS *));
609
610 #include "expr.h"               /* Before targ-*.h */
611
612 /* this one starts the chain of target dependant headers */
613 #include "targ-env.h"
614
615 #include "write.h"
616 #include "frags.h"
617 #include "hash.h"
618 #include "read.h"
619 #include "symbols.h"
620
621 #include "tc.h"
622 #include "obj.h"
623
624 #ifdef USE_EMULATIONS
625 #include "emul.h"
626 #endif
627 #include "listing.h"
628
629 #ifndef LOCAL_LABELS_DOLLAR
630 #define LOCAL_LABELS_DOLLAR 0
631 #endif
632
633 #ifndef LOCAL_LABELS_FB
634 #define LOCAL_LABELS_FB 0
635 #endif
636
637 #ifndef TEXT_SECTION_NAME
638 #define TEXT_SECTION_NAME       ".text"
639 #define DATA_SECTION_NAME       ".data"
640 #define BSS_SECTION_NAME        ".bss"
641 #endif
642
643 #endif /* GAS */
644
645 /* end of as.h */