1 /* as.h - global header file
2 Copyright (C) 1987-2021 Free Software Foundation, Inc.
4 This file is part of GAS, the GNU Assembler.
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)
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.
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
23 /* I think this stuff is largely out of date. xoxorich.
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.
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
35 If TEST is #defined, then we are testing a module: #define COMMON as "". */
39 /* Now, tend to the rest of the configuration. */
41 /* System include files first... */
49 #ifdef HAVE_SYS_TYPES_H
50 /* for size_t, pid_t */
51 #include <sys/types.h>
58 /* The first getopt value for machine-independent long options.
59 150 isn't special; it's just an arbitrary non-ASCII char value. */
60 #define OPTION_STD_BASE 150
61 /* The first getopt value for machine-dependent long options.
62 290 gives the standard options room to grow. */
63 #define OPTION_MD_BASE 290
68 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
69 #define __PRETTY_FUNCTION__ ((char *) NULL)
71 #define gas_assert(P) ((void) ((P) ? 0 : (abort (), 0)))
73 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
75 /* Now GNU header files... */
78 #include "libiberty.h"
80 /* Define the standard progress macros. */
83 /* Other stuff from config.h. */
84 #ifdef NEED_DECLARATION_ENVIRON
85 extern char **environ
;
87 #ifdef NEED_DECLARATION_FFS
91 #if !HAVE_DECL_MEMPCPY
92 void *mempcpy(void *, const void *, size_t);
96 #define __LINE__ "unknown"
100 #define __FILE__ "unknown"
101 #endif /* __FILE__ */
104 #ifdef USE_BINARY_FOPEN
105 #include "fopen-bin.h"
107 #include "fopen-same.h"
112 #define EXIT_SUCCESS 0
113 #define EXIT_FAILURE 1
120 #define obstack_chunk_alloc xmalloc
121 #define obstack_chunk_free xfree
127 #define BAD_CASE(val) \
129 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
130 (long) val, __LINE__, __FILE__); \
135 /* These are assembler-wide concepts */
137 extern bfd
*stdoutput
;
138 typedef bfd_vma addressT
;
139 typedef bfd_signed_vma offsetT
;
141 /* Type of symbol value, etc. For use in prototypes. */
142 typedef addressT valueT
;
146 #define COMMON /* Declare our COMMONs storage here. */
148 #define COMMON extern /* Our commons live elsewhere. */
151 /* COMMON now defined */
153 #ifndef ENABLE_CHECKING
154 #define ENABLE_CHECKING 0
157 #if ENABLE_CHECKING || defined (DEBUG)
159 #define know(p) gas_assert(p) /* Verify our assumptions! */
160 #endif /* not yet defined */
162 #define know(p) do {} while (0) /* know() checks are no-op.ed */
167 /* Supplies sanitised buffers to read.c.
168 Also understands printing line-number part of error messages. */
170 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
172 typedef asection
*segT
;
173 #define SEG_NORMAL(SEG) ( (SEG) != absolute_section \
174 && (SEG) != undefined_section \
175 && (SEG) != reg_section \
176 && (SEG) != expr_section)
179 /* What subseg we are accessing now? */
180 COMMON subsegT now_subseg
;
182 /* Segment our instructions emit to. */
185 #define segment_name(SEG) bfd_section_name (SEG)
187 extern segT reg_section
, expr_section
;
188 /* Shouldn't these be eliminated someday? */
189 extern segT text_section
, data_section
, bss_section
;
190 #define absolute_section bfd_abs_section_ptr
191 #define undefined_section bfd_und_section_ptr
195 /* Dummy frag used by listing code. */
198 /* Variable chars to be repeated fr_offset times.
199 Fr_symbol unused. Used with fr_offset == 0 for a
200 constant length frag. */
203 /* Align. The fr_offset field holds the power of 2 to which to
204 align. The fr_var field holds the number of characters in the
205 fill pattern. The fr_subtype field holds the maximum number of
206 bytes to skip when aligning, or 0 if there is no maximum. */
209 /* Align code. The fr_offset field holds the power of 2 to which
210 to align. This type is only generated by machine specific
211 code, which is normally responsible for handling the fill
212 pattern. The fr_subtype field holds the maximum number of
213 bytes to skip when aligning, or 0 if there is no maximum. */
216 /* Test for alignment. Like rs_align, but used by several targets
217 to warn if data is not properly aligned. */
220 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
224 #ifndef WORKING_DOT_WORD
229 /* Machine specific relaxable (or similarly alterable) instruction. */
230 rs_machine_dependent
,
232 /* .space directive with expression operand that needs to be computed
233 later. Similar to rs_org, but different.
235 1 variable char: fill character */
238 /* .nop directive with expression operand that needs to be computed
239 later. Similar to rs_space, but different. It fills with no-op
242 1 constant byte: no-op fill control byte. */
245 /* Similar to rs_fill. It is used to implement .nop directive . */
248 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
249 unsigned, 1 for signed. */
252 /* Exception frame information which we may be able to optimize. */
255 /* Cross-fragment dwarf2 line number optimization. */
259 typedef enum _relax_state relax_stateT
;
261 /* This type is used in prototypes, so it can't be a type that will be
262 widened for argument passing. */
263 typedef unsigned int relax_substateT
;
265 /* Enough bits for address, but still an integer type.
266 Could be a problem, cross-assembling for 64-bit machines. */
267 typedef addressT relax_addressT
;
271 /* Forward reach. Signed number. > 0. */
273 /* Backward reach. Signed number. < 0. */
274 offsetT rlx_backward
;
276 /* Bytes length of this address. */
277 unsigned char rlx_length
;
279 /* Next longer relax-state. 0 means there is no 'next' relax-state. */
280 relax_substateT rlx_more
;
283 typedef struct relax_type relax_typeS
;
285 /* main program "as.c" (command arguments etc). */
287 COMMON
unsigned char flag_no_comments
; /* -f */
288 COMMON
unsigned char flag_debug
; /* -D */
289 COMMON
unsigned char flag_signed_overflow_ok
; /* -J */
290 #ifndef WORKING_DOT_WORD
291 COMMON
unsigned char flag_warn_displacement
; /* -K */
294 /* True if local symbols should be retained. */
295 COMMON
int flag_keep_locals
; /* -L */
297 /* True if we are assembling in MRI mode. */
300 /* Should the data section be made read-only and appended to the text
302 COMMON
unsigned char flag_readonly_data_in_text
; /* -R */
304 /* True if warnings should be inhibited. */
305 COMMON
int flag_no_warnings
; /* -W */
307 /* True if warnings count as errors. */
308 COMMON
int flag_fatal_warnings
; /* --fatal-warnings */
310 /* True if we should attempt to generate output even if non-fatal errors
312 COMMON
unsigned char flag_always_generate_output
; /* -Z */
314 /* This is true if the assembler should output time and space usage. */
315 COMMON
unsigned char flag_print_statistics
;
317 /* True if local absolute symbols are to be stripped. */
318 COMMON
int flag_strip_local_absolute
;
320 /* True if we should generate a traditional format object file. */
321 COMMON
int flag_traditional_format
;
323 /* Type of compressed debug sections we should generate. */
324 COMMON
enum compressed_debug_section_type flag_compress_debug
;
326 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
327 COMMON
int flag_execstack
;
329 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
330 COMMON
int flag_noexecstack
;
332 /* name of emitted object file */
333 COMMON
const char *out_file_name
;
335 /* name of file defining extensions to the basic instruction set */
336 COMMON
char *insttbl_file_name
;
338 /* TRUE if we need a second pass. */
339 COMMON
int need_pass_2
;
341 /* TRUE if we should do no relaxing, and
342 leave lots of padding. */
343 COMMON
int linkrelax
;
345 COMMON
int do_not_pad_sections_to_alignment
;
347 /* TRUE if we should produce a listing. */
350 /* Type of debugging information we should generate. We currently support
351 stabs, ECOFF, and DWARF2.
353 NOTE! This means debug information about the assembly source code itself
354 and _not_ about possible debug information from a high-level language.
355 This is especially relevant to DWARF2, since the compiler may emit line
356 number directives that the assembler resolves. */
368 extern enum debug_info_type debug_type
;
369 extern int use_gnu_debug_info_extensions
;
370 COMMON
bool flag_dwarf_sections
;
371 extern int flag_dwarf_cie_version
;
372 extern unsigned int dwarf_level
;
374 /* Maximum level of macro nesting. */
375 extern int max_macro_nest
;
377 /* Verbosity level. */
380 /* Obstack chunk size. Keep large for efficient space use, make small to
381 increase malloc calls for monitoring memory allocation. */
382 extern int chunksize
;
386 /* assembler mnemonic, lower case, no '.' */
387 const char *poc_name
;
389 void (*poc_handler
) (int);
390 /* Value to pass to handler */
394 typedef struct _pseudo_type pseudo_typeS
;
396 #if (__GNUC__ >= 2) && !defined(VMS)
397 /* for use with -Wformat */
399 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
400 /* Support for double underscores in attribute names was added in gcc
401 2.6, so avoid them if we are using an earlier version. */
402 #define __printf__ printf
403 #define __format__ format
406 #define PRINTF_LIKE(FCN) \
407 void FCN (const char *format, ...) \
408 __attribute__ ((__format__ (__printf__, 1, 2)))
409 #define PRINTF_WHERE_LIKE(FCN) \
410 void FCN (const char *file, unsigned int line, const char *format, ...) \
411 __attribute__ ((__format__ (__printf__, 3, 4)))
413 #else /* __GNUC__ < 2 || defined(VMS) */
415 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
416 #define PRINTF_WHERE_LIKE(FCN) void FCN (const char *file, \
418 const char *format, ...)
420 #endif /* __GNUC__ < 2 || defined(VMS) */
422 PRINTF_LIKE (as_bad
);
423 PRINTF_LIKE (as_fatal
) ATTRIBUTE_NORETURN
;
424 PRINTF_LIKE (as_tsktsk
);
425 PRINTF_LIKE (as_warn
);
426 PRINTF_WHERE_LIKE (as_bad_where
);
427 PRINTF_WHERE_LIKE (as_warn_where
);
429 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN
;
430 void signal_init (void);
431 int had_errors (void);
432 int had_warnings (void);
433 void as_warn_value_out_of_range (const char *, offsetT
, offsetT
, offsetT
,
434 const char *, unsigned);
435 void as_bad_value_out_of_range (const char *, offsetT
, offsetT
, offsetT
,
436 const char *, unsigned);
437 void print_version_id (void);
438 char * app_push (void);
440 /* Number of littlenums required to hold an extended precision number. */
441 #define MAX_LITTLENUMS 6
443 char * atof_ieee (char *, int, LITTLENUM_TYPE
*);
444 char * atof_ieee_detail (char *, int, int, LITTLENUM_TYPE
*, FLONUM_TYPE
*);
445 const char * ieee_md_atof (int, char *, int *, bool);
446 const char * vax_md_atof (int, char *, int *);
447 char * input_scrub_include_file (const char *, char *);
448 void input_scrub_insert_line (const char *);
449 void input_scrub_insert_file (char *);
450 char * input_scrub_new_file (const char *);
451 char * input_scrub_next_buffer (char **bufp
);
452 size_t do_scrub_chars (size_t (*get
) (char *, size_t), char *, size_t);
453 int gen_to_words (LITTLENUM_TYPE
*, int, long);
455 int ignore_input (void);
456 void cond_finish_check (int);
457 void cond_exit_macro (int);
458 int seen_at_least_1_file (void);
459 void app_pop (char *);
460 const char * as_where (unsigned int *);
461 const char * as_where_physical (unsigned int *);
462 void bump_line_counters (void);
463 void do_scrub_begin (int);
464 void input_scrub_begin (void);
465 void input_scrub_close (void);
466 void input_scrub_end (void);
467 int new_logical_line (const char *, int);
468 int new_logical_line_flags (const char *, int, int);
469 void subsegs_begin (void);
470 void subseg_change (segT
, int);
471 segT
subseg_new (const char *, subsegT
);
472 segT
subseg_force_new (const char *, subsegT
);
473 void subseg_set (segT
, subsegT
);
474 int subseg_text_p (segT
);
475 int seg_not_empty_p (segT
);
476 void start_dependencies (char *);
477 void register_dependency (const char *);
478 void print_dependencies (void);
479 segT
subseg_get (const char *, int);
481 const char *remap_debug_filename (const char *);
482 void add_debug_prefix_map (const char *);
485 xmemdup0 (const char *in
, size_t len
)
487 char *out
= (char *) xmalloc (len
+ 1);
489 return (char *) memcpy (out
, in
, len
);
494 typedef struct symbol symbolS
;
495 typedef struct frag fragS
;
498 valueT
add_to_literal_pool (symbolS
*, valueT
, segT
, int);
500 int check_eh_frame (struct expressionS
*, unsigned int *);
501 int eh_frame_estimate_size_before_relax (fragS
*);
502 int eh_frame_relax_frag (fragS
*);
503 void eh_frame_convert_frag (fragS
*);
504 int generic_force_reloc (struct fix
*);
506 #include "expr.h" /* Before targ-*.h */
508 /* This one starts the chain of target dependent headers. */
509 #include "targ-env.h"
512 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
531 #ifdef USE_EMULATIONS
537 extern int enable_h_tick_hex
;
541 /* True if we are assembling in m68k MRI mode. */
542 COMMON
int flag_m68k_mri
;
543 #define DOLLAR_AMBIGU flag_m68k_mri
545 #define flag_m68k_mri 0
548 #ifndef TC_STRING_ESCAPES
549 #define TC_STRING_ESCAPES 1
553 COMMON
int warn_comment
;
554 COMMON
unsigned int found_comment
;
555 COMMON
const char * found_comment_file
;
558 #if defined OBJ_ELF || defined OBJ_MAYBE_ELF
559 /* If .size directive failure should be error or warning. */
560 COMMON
int flag_allow_nonconst_size
;
562 /* If we should generate ELF common symbols with the STT_COMMON type. */
563 extern int flag_use_elf_stt_common
;
565 /* TRUE iff GNU Build attribute notes should
566 be generated if none are in the input files. */
567 extern bool flag_generate_build_notes
;
569 /* If section name substitution sequences should be honored */
570 COMMON
int flag_sectname_subst
;
573 #ifndef DOLLAR_AMBIGU
574 #define DOLLAR_AMBIGU 0
577 #ifndef NUMBERS_WITH_SUFFIX
578 #define NUMBERS_WITH_SUFFIX 0
581 #ifndef LOCAL_LABELS_DOLLAR
582 #define LOCAL_LABELS_DOLLAR 0
585 #ifndef LOCAL_LABELS_FB
586 #define LOCAL_LABELS_FB 0
589 #ifndef LABELS_WITHOUT_COLONS
590 #define LABELS_WITHOUT_COLONS 0
593 #ifndef NO_PSEUDO_DOT
594 #define NO_PSEUDO_DOT 0
597 #ifndef TEXT_SECTION_NAME
598 #define TEXT_SECTION_NAME ".text"
599 #define DATA_SECTION_NAME ".data"
600 #define BSS_SECTION_NAME ".bss"
603 #ifndef OCTETS_PER_BYTE_POWER
604 #define OCTETS_PER_BYTE_POWER 0
606 #ifndef OCTETS_PER_BYTE
607 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
609 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
610 #error "Octets per byte conflicts with its power-of-two definition!"
613 #if defined OBJ_ELF || defined OBJ_MAYBE_ELF
614 /* On ELF platforms, mark debug sections with SEC_ELF_OCTETS */
615 #define SEC_OCTETS (IS_ELF ? SEC_ELF_OCTETS : 0)
620 #define POISON_BFD_BOOLEAN 1