1 /* as.h - global header file
2 Copyright (C) 1987-2023 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 /* Other stuff from config.h. */
81 #ifdef NEED_DECLARATION_ENVIRON
82 extern char **environ
;
84 #ifdef NEED_DECLARATION_FFS
88 #if !HAVE_DECL_MEMPCPY
89 void *mempcpy(void *, const void *, size_t);
93 #define __LINE__ "unknown"
97 #define __FILE__ "unknown"
101 #ifdef USE_BINARY_FOPEN
102 #include "fopen-bin.h"
104 #include "fopen-same.h"
109 #define EXIT_SUCCESS 0
110 #define EXIT_FAILURE 1
117 #define obstack_chunk_alloc xmalloc
118 #define obstack_chunk_free xfree
122 #if GCC_VERSION >= 7000
123 #define gas_mul_overflow(a, b, res) __builtin_mul_overflow (a, b, res)
125 /* Assumes unsigned values. Careful! Args evaluated multiple times. */
126 #define gas_mul_overflow(a, b, res) \
127 ((*res) = (a), (*res) *= (b), (b) != 0 && (*res) / (b) != (a))
132 #define BAD_CASE(val) \
134 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
135 (long) val, __LINE__, __FILE__); \
140 /* These are assembler-wide concepts */
142 extern bfd
*stdoutput
;
143 typedef bfd_vma addressT
;
144 typedef bfd_signed_vma offsetT
;
146 /* Type of symbol value, etc. For use in prototypes. */
147 typedef addressT valueT
;
151 #define COMMON /* Declare our COMMONs storage here. */
153 #define COMMON extern /* Our commons live elsewhere. */
156 /* COMMON now defined */
158 #ifndef ENABLE_CHECKING
159 #define ENABLE_CHECKING 0
162 #if ENABLE_CHECKING || defined (DEBUG)
164 #define know(p) gas_assert(p) /* Verify our assumptions! */
165 #endif /* not yet defined */
167 #define know(p) do {} while (0) /* know() checks are no-op.ed */
172 /* Supplies sanitised buffers to read.c.
173 Also understands printing line-number part of error messages. */
175 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
177 typedef asection
*segT
;
178 #define SEG_NORMAL(SEG) ( (SEG) != absolute_section \
179 && (SEG) != undefined_section \
180 && (SEG) != reg_section \
181 && (SEG) != expr_section)
184 /* What subseg we are accessing now? */
185 COMMON subsegT now_subseg
;
187 /* Segment our instructions emit to. */
190 #define segment_name(SEG) bfd_section_name (SEG)
192 extern segT reg_section
, expr_section
;
193 /* Shouldn't these be eliminated someday? */
194 extern segT text_section
, data_section
, bss_section
;
195 #define absolute_section bfd_abs_section_ptr
196 #define undefined_section bfd_und_section_ptr
200 /* Dummy frag used by listing code. */
203 /* Variable chars to be repeated fr_offset times.
204 Fr_symbol unused. Used with fr_offset == 0 for a
205 constant length frag. */
208 /* Align. The fr_offset field holds the power of 2 to which to
209 align. The fr_var field holds the number of characters in the
210 fill pattern. The fr_subtype field holds the maximum number of
211 bytes to skip when aligning, or 0 if there is no maximum. */
214 /* Align code. The fr_offset field holds the power of 2 to which
215 to align. This type is only generated by machine specific
216 code, which is normally responsible for handling the fill
217 pattern. The fr_subtype field holds the maximum number of
218 bytes to skip when aligning, or 0 if there is no maximum. */
221 /* Test for alignment. Like rs_align, but used by several targets
222 to warn if data is not properly aligned. */
225 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
229 #ifndef WORKING_DOT_WORD
234 /* Machine specific relaxable (or similarly alterable) instruction. */
235 rs_machine_dependent
,
237 /* .space directive with expression operand that needs to be computed
238 later. Similar to rs_org, but different.
240 1 variable char: fill character */
243 /* .nop directive with expression operand that needs to be computed
244 later. Similar to rs_space, but different. It fills with no-op
247 1 constant byte: no-op fill control byte. */
250 /* Similar to rs_fill. It is used to implement .nops directive.
251 When listings are enabled, fr_opcode gets the buffer assigned, once
255 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
256 unsigned, 1 for signed. */
259 /* Exception frame information which we may be able to optimize. */
262 /* Cross-fragment dwarf2 line number optimization. */
265 /* SFrame FRE type selection optimization. */
269 typedef enum _relax_state relax_stateT
;
271 /* This type is used in prototypes, so it can't be a type that will be
272 widened for argument passing. */
273 typedef unsigned int relax_substateT
;
275 /* Enough bits for address, but still an integer type.
276 Could be a problem, cross-assembling for 64-bit machines. */
277 typedef addressT relax_addressT
;
281 /* Forward reach. Signed number. > 0. */
283 /* Backward reach. Signed number. < 0. */
284 offsetT rlx_backward
;
286 /* Bytes length of this address. */
287 unsigned char rlx_length
;
289 /* Next longer relax-state. 0 means there is no 'next' relax-state. */
290 relax_substateT rlx_more
;
293 typedef struct relax_type relax_typeS
;
295 /* main program "as.c" (command arguments etc). */
297 COMMON
unsigned char flag_no_comments
; /* -f */
298 COMMON
unsigned char flag_debug
; /* -D */
299 COMMON
unsigned char flag_signed_overflow_ok
; /* -J */
300 #ifndef WORKING_DOT_WORD
301 COMMON
unsigned char flag_warn_displacement
; /* -K */
304 /* True if local symbols should be retained. */
305 COMMON
int flag_keep_locals
; /* -L */
307 /* True if we are assembling in MRI mode. */
310 /* True if alternate macro mode is in effect. */
311 COMMON
bool flag_macro_alternate
;
313 /* Should the data section be made read-only and appended to the text
315 COMMON
unsigned char flag_readonly_data_in_text
; /* -R */
317 /* True if warnings should be inhibited. */
318 COMMON
int flag_no_warnings
; /* -W */
320 /* True if warnings count as errors. */
321 COMMON
int flag_fatal_warnings
; /* --fatal-warnings */
323 /* True if we should attempt to generate output even if non-fatal errors
325 COMMON
unsigned char flag_always_generate_output
; /* -Z */
327 /* This is true if the assembler should output time and space usage. */
328 COMMON
unsigned char flag_print_statistics
;
330 /* True if local absolute symbols are to be stripped. */
331 COMMON
int flag_strip_local_absolute
;
333 /* True if we should generate a traditional format object file. */
334 COMMON
int flag_traditional_format
;
336 /* Type of compressed debug sections we should generate. */
337 COMMON
enum compressed_debug_section_type flag_compress_debug
;
339 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
340 COMMON
int flag_execstack
;
342 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
343 COMMON
int flag_noexecstack
;
345 /* TRUE if .sframe section should be created. */
346 COMMON
int flag_gen_sframe
;
348 /* name of emitted object file */
349 COMMON
const char *out_file_name
;
351 /* Keep the output file. */
354 /* name of file defining extensions to the basic instruction set */
355 COMMON
char *insttbl_file_name
;
357 /* TRUE if we need a second pass. */
358 COMMON
int need_pass_2
;
360 /* TRUE if we should do no relaxing, and
361 leave lots of padding. */
362 COMMON
int linkrelax
;
364 COMMON
int do_not_pad_sections_to_alignment
;
366 enum multibyte_input_handling
372 COMMON
enum multibyte_input_handling multibyte_handling
;
374 /* TRUE if we should produce a listing. */
377 /* Type of debugging information we should generate. We currently support
378 stabs, ECOFF, and DWARF2.
380 NOTE! This means debug information about the assembly source code itself
381 and _not_ about possible debug information from a high-level language.
382 This is especially relevant to DWARF2, since the compiler may emit line
383 number directives that the assembler resolves. */
396 extern enum debug_info_type debug_type
;
397 extern int use_gnu_debug_info_extensions
;
398 COMMON
bool flag_dwarf_sections
;
399 extern int flag_dwarf_cie_version
;
400 extern unsigned int dwarf_level
;
402 /* Maximum level of macro nesting. */
403 extern int max_macro_nest
;
405 /* Verbosity level. */
410 /* Obstack chunk size. Keep large for efficient space use, make small to
411 increase malloc calls for monitoring memory allocation. */
412 extern int chunksize
;
416 /* assembler mnemonic, lower case, no '.' */
417 const char *poc_name
;
419 void (*poc_handler
) (int);
420 /* Value to pass to handler */
424 typedef struct _pseudo_type pseudo_typeS
;
426 #if (__GNUC__ >= 2) && !defined(VMS)
427 /* for use with -Wformat */
429 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
430 /* Support for double underscores in attribute names was added in gcc
431 2.6, so avoid them if we are using an earlier version. */
432 #define __printf__ printf
433 #define __format__ format
436 #define PRINTF_LIKE(FCN) \
437 void FCN (const char *format, ...) \
438 __attribute__ ((__format__ (__printf__, 1, 2)))
439 #define PRINTF_WHERE_LIKE(FCN) \
440 void FCN (const char *file, unsigned int line, const char *format, ...) \
441 __attribute__ ((__format__ (__printf__, 3, 4)))
442 #define PRINTF_INDENT_LIKE(FCN) \
443 void FCN (const char *file, unsigned int line, unsigned int indent, \
444 const char *format, ...) \
445 __attribute__ ((__format__ (__printf__, 4, 5)))
447 #else /* __GNUC__ < 2 || defined(VMS) */
449 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
450 #define PRINTF_WHERE_LIKE(FCN) void FCN (const char *file, \
452 const char *format, ...)
453 #define PRINTF_INDENT_LIKE(FCN) void FCN (const char *file, \
455 unsigned int indent, \
456 const char *format, ...)
458 #endif /* __GNUC__ < 2 || defined(VMS) */
460 PRINTF_LIKE (as_bad
);
461 PRINTF_LIKE (as_fatal
) ATTRIBUTE_NORETURN
;
462 PRINTF_LIKE (as_tsktsk
);
463 PRINTF_LIKE (as_warn
);
464 PRINTF_WHERE_LIKE (as_bad_where
);
465 PRINTF_WHERE_LIKE (as_warn_where
);
466 PRINTF_INDENT_LIKE (as_info_where
);
468 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN
;
469 void signal_init (void);
470 int had_errors (void);
471 int had_warnings (void);
472 void as_warn_value_out_of_range (const char *, offsetT
, offsetT
, offsetT
,
473 const char *, unsigned);
474 void as_bad_value_out_of_range (const char *, offsetT
, offsetT
, offsetT
,
475 const char *, unsigned);
476 void print_version_id (void);
477 char * app_push (void);
479 /* Number of littlenums required to hold an extended precision number. */
480 #define MAX_LITTLENUMS 6
482 char * atof_ieee (char *, int, LITTLENUM_TYPE
*);
483 char * atof_ieee_detail (char *, int, int, LITTLENUM_TYPE
*, FLONUM_TYPE
*);
484 const char * ieee_md_atof (int, char *, int *, bool);
485 const char * vax_md_atof (int, char *, int *);
486 char * input_scrub_include_file (const char *, char *);
487 void input_scrub_insert_line (const char *);
488 void input_scrub_insert_file (char *);
489 char * input_scrub_new_file (const char *);
490 char * input_scrub_next_buffer (char **bufp
);
491 size_t do_scrub_chars (size_t (*get
) (char *, size_t), char *, size_t);
492 size_t do_scrub_pending (void);
493 bool scan_for_multibyte_characters (const unsigned char *, const unsigned char *, bool);
494 int gen_to_words (LITTLENUM_TYPE
*, int, long);
496 int ignore_input (void);
497 void cond_finish_check (int);
498 void cond_exit_macro (int);
499 int seen_at_least_1_file (void);
500 void app_pop (char *);
501 void as_report_context (void);
502 const char * as_where (unsigned int *);
503 const char * as_where_top (unsigned int *);
504 const char * as_where_physical (unsigned int *);
505 void bump_line_counters (void);
506 void do_scrub_begin (int);
507 void input_scrub_begin (void);
508 void input_scrub_close (void);
509 void input_scrub_end (void);
510 void new_logical_line (const char *, int);
511 void new_logical_line_flags (const char *, int, int);
512 void subsegs_begin (void);
513 void subsegs_end (struct obstack
**);
514 void subseg_change (segT
, int);
515 segT
subseg_new (const char *, subsegT
);
516 segT
subseg_force_new (const char *, subsegT
);
517 void subseg_set (segT
, subsegT
);
518 int subseg_text_p (segT
);
519 int seg_not_empty_p (segT
);
520 void start_dependencies (char *);
521 void register_dependency (const char *);
522 void print_dependencies (void);
523 segT
subseg_get (const char *, int);
525 char *remap_debug_filename (const char *);
526 void add_debug_prefix_map (const char *);
529 xmemdup0 (const char *in
, size_t len
)
531 return xmemdup (in
, len
, len
+ 1);
536 typedef struct symbol symbolS
;
537 typedef struct frag fragS
;
540 valueT
add_to_literal_pool (symbolS
*, valueT
, segT
, int);
542 int check_eh_frame (struct expressionS
*, unsigned int *);
543 int eh_frame_estimate_size_before_relax (fragS
*);
544 int eh_frame_relax_frag (fragS
*);
545 void eh_frame_convert_frag (fragS
*);
546 void eh_begin (void);
547 int generic_force_reloc (struct fix
*);
549 /* SFrame FRE optimization. */
550 int sframe_estimate_size_before_relax (fragS
*);
551 int sframe_relax_frag (fragS
*);
552 void sframe_convert_frag (fragS
*);
554 #include "expr.h" /* Before targ-*.h */
556 /* This one starts the chain of target dependent headers. */
557 #include "targ-env.h"
560 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
579 #ifdef USE_EMULATIONS
585 extern int enable_h_tick_hex
;
589 /* True if we are assembling in m68k MRI mode. */
590 COMMON
int flag_m68k_mri
;
591 #define DOLLAR_AMBIGU flag_m68k_mri
593 #define flag_m68k_mri 0
596 #ifndef TC_STRING_ESCAPES
597 #define TC_STRING_ESCAPES 1
601 COMMON
int warn_comment
;
602 COMMON
unsigned int found_comment
;
603 COMMON
const char * found_comment_file
;
606 #if defined OBJ_ELF || defined OBJ_MAYBE_ELF
607 /* If .size directive failure should be error or warning. */
608 COMMON
int flag_allow_nonconst_size
;
610 /* If we should generate ELF common symbols with the STT_COMMON type. */
611 extern int flag_use_elf_stt_common
;
613 /* TRUE iff GNU Build attribute notes should
614 be generated if none are in the input files. */
615 extern bool flag_generate_build_notes
;
617 /* If section name substitution sequences should be honored */
618 COMMON
int flag_sectname_subst
;
621 #ifndef DOLLAR_AMBIGU
622 #define DOLLAR_AMBIGU 0
625 #ifndef NUMBERS_WITH_SUFFIX
626 #define NUMBERS_WITH_SUFFIX 0
629 #ifndef LOCAL_LABELS_DOLLAR
630 #define LOCAL_LABELS_DOLLAR 0
633 #ifndef LOCAL_LABELS_FB
634 #define LOCAL_LABELS_FB 0
637 #ifndef LABELS_WITHOUT_COLONS
638 #define LABELS_WITHOUT_COLONS 0
641 #ifndef NO_PSEUDO_DOT
642 #define NO_PSEUDO_DOT 0
645 #ifndef TEXT_SECTION_NAME
646 #define TEXT_SECTION_NAME ".text"
647 #define DATA_SECTION_NAME ".data"
648 #define BSS_SECTION_NAME ".bss"
651 #ifndef OCTETS_PER_BYTE_POWER
652 #define OCTETS_PER_BYTE_POWER 0
654 #ifndef OCTETS_PER_BYTE
655 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
657 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
658 #error "Octets per byte conflicts with its power-of-two definition!"
661 #if defined OBJ_ELF || defined OBJ_MAYBE_ELF
662 /* On ELF platforms, mark debug sections with SEC_ELF_OCTETS */
663 #define SEC_OCTETS (IS_ELF ? SEC_ELF_OCTETS : 0)
668 #define POISON_BFD_BOOLEAN 1