OSDN Git Service

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