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