arm: Support pac_key_* register operand for MRS/MSR in Armv8.1-M Mainline
[binutils-gdb.git] / gas / as.h
blob3d5f710c5c5e9d71c440356430b1f51ed2f6f464
1 /* as.h - global header file
2 Copyright (C) 1987-2024 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)
9 any later version.
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
19 02110-1301, USA. */
21 #ifndef GAS
22 #define GAS 1
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
34 COMMON as "".
35 If TEST is #defined, then we are testing a module: #define COMMON as "". */
37 #include "config.h"
39 /* Now, tend to the rest of the configuration. */
41 /* System include files first... */
42 #include <stdio.h>
43 #include <string.h>
44 #include <stdlib.h>
46 #ifdef HAVE_UNISTD_H
47 #include <unistd.h>
48 #endif
49 #ifdef HAVE_SYS_TYPES_H
50 /* for size_t, pid_t */
51 #include <sys/types.h>
52 #endif
54 #include <errno.h>
55 #include <stdarg.h>
57 #include "getopt.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
65 #ifdef DEBUG
66 #undef NDEBUG
67 #endif
68 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
69 #define __PRETTY_FUNCTION__ ((char *) NULL)
70 #endif
71 #define gas_assert(P) ((void) ((P) ? 0 : (abort (), 0)))
72 #undef abort
73 #define abort() as_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
75 /* Now GNU header files... */
76 #include "ansidecl.h"
77 #include "bfd.h"
78 #include "libiberty.h"
80 /* Other stuff from config.h. */
81 #ifdef NEED_DECLARATION_ENVIRON
82 extern char **environ;
83 #endif
84 #ifdef NEED_DECLARATION_FFS
85 extern int ffs (int);
86 #endif
88 #if !HAVE_DECL_MEMPCPY
89 void *mempcpy(void *, const void *, size_t);
90 #endif
92 #ifndef __LINE__
93 #define __LINE__ "unknown"
94 #endif /* __LINE__ */
96 #ifndef __FILE__
97 #define __FILE__ "unknown"
98 #endif /* __FILE__ */
100 #ifndef FOPEN_WB
101 #ifdef USE_BINARY_FOPEN
102 #include "fopen-bin.h"
103 #else
104 #include "fopen-same.h"
105 #endif
106 #endif
108 #ifndef EXIT_SUCCESS
109 #define EXIT_SUCCESS 0
110 #define EXIT_FAILURE 1
111 #endif
113 #ifndef SEEK_SET
114 #define SEEK_SET 0
115 #endif
117 #define obstack_chunk_alloc xmalloc
118 #define obstack_chunk_free xfree
120 #define xfree free
122 #if GCC_VERSION >= 7000
123 #define gas_mul_overflow(a, b, res) __builtin_mul_overflow (a, b, res)
124 #else
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))
128 #endif
130 #include "asintl.h"
132 #define BAD_CASE(val) \
134 as_fatal (_("Case value %ld unexpected at line %d of file \"%s\"\n"), \
135 (long) val, __LINE__, __FILE__); \
138 #include "flonum.h"
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;
149 #ifndef COMMON
150 #ifdef TEST
151 #define COMMON /* Declare our COMMONs storage here. */
152 #else
153 #define COMMON extern /* Our commons live elsewhere. */
154 #endif
155 #endif
156 /* COMMON now defined */
158 #ifndef ENABLE_CHECKING
159 #define ENABLE_CHECKING 0
160 #endif
162 #if ENABLE_CHECKING || defined (DEBUG)
163 #ifndef know
164 #define know(p) gas_assert(p) /* Verify our assumptions! */
165 #endif /* not yet defined */
166 #else
167 #define know(p) do {} while (0) /* know() checks are no-op.ed */
168 #endif
170 /* input_scrub.c */
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)
182 typedef int subsegT;
184 /* What subseg we are accessing now? */
185 COMMON subsegT now_subseg;
187 /* Segment our instructions emit to. */
188 COMMON segT now_seg;
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
198 enum _relax_state
200 /* Dummy frag used by listing code. */
201 rs_dummy = 0,
203 /* Variable chars to be repeated fr_offset times.
204 Fr_symbol unused. Used with fr_offset == 0 for a
205 constant length frag. */
206 rs_fill,
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. */
212 rs_align,
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. */
219 rs_align_code,
221 /* Test for alignment. Like rs_align, but used by several targets
222 to warn if data is not properly aligned. */
223 rs_align_test,
225 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
226 character. */
227 rs_org,
229 #ifndef WORKING_DOT_WORD
230 /* JF: gunpoint */
231 rs_broken_word,
232 #endif
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.
239 fr_symbol: operand
240 1 variable char: fill character */
241 rs_space,
243 /* .nop directive with expression operand that needs to be computed
244 later. Similar to rs_space, but different. It fills with no-op
245 instructions.
246 fr_symbol: operand
247 1 constant byte: no-op fill control byte. */
248 rs_space_nop,
250 /* Similar to rs_fill. It is used to implement .nops directive.
251 When listings are enabled, fr_opcode gets the buffer assigned, once
252 that's available. */
253 rs_fill_nop,
255 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
256 unsigned, 1 for signed. */
257 rs_leb128,
259 /* Exception frame information which we may be able to optimize. */
260 rs_cfa,
262 /* Cross-fragment dwarf2 line number optimization. */
263 rs_dwarf2dbg,
265 /* SFrame FRE type selection optimization. */
266 rs_sframe,
268 /* CodeView compressed integer. */
269 rs_cv_comp,
272 typedef enum _relax_state relax_stateT;
274 /* This type is used in prototypes, so it can't be a type that will be
275 widened for argument passing. */
276 typedef unsigned int relax_substateT;
278 /* Enough bits for address, but still an integer type.
279 Could be a problem, cross-assembling for 64-bit machines. */
280 typedef addressT relax_addressT;
282 struct relax_type
284 /* Forward reach. Signed number. > 0. */
285 offsetT rlx_forward;
286 /* Backward reach. Signed number. < 0. */
287 offsetT rlx_backward;
289 /* Bytes length of this address. */
290 unsigned char rlx_length;
292 /* Next longer relax-state. 0 means there is no 'next' relax-state. */
293 relax_substateT rlx_more;
296 typedef struct relax_type relax_typeS;
298 /* main program "as.c" (command arguments etc). */
300 COMMON unsigned char flag_no_comments; /* -f */
301 COMMON unsigned char flag_debug; /* -D */
302 COMMON unsigned char flag_signed_overflow_ok; /* -J */
303 #ifndef WORKING_DOT_WORD
304 COMMON unsigned char flag_warn_displacement; /* -K */
305 #endif
307 /* True if local symbols should be retained. */
308 COMMON int flag_keep_locals; /* -L */
310 /* True if we are assembling in MRI mode. */
311 COMMON int flag_mri;
313 /* True if alternate macro mode is in effect. */
314 COMMON bool flag_macro_alternate;
316 /* Should the data section be made read-only and appended to the text
317 section? */
318 COMMON unsigned char flag_readonly_data_in_text; /* -R */
320 /* True if warnings should be inhibited. */
321 COMMON int flag_no_warnings; /* -W, --no-warn */
323 /* True if warnings count as errors. */
324 COMMON int flag_fatal_warnings; /* --fatal-warnings */
326 /* True if we should attempt to generate output even if non-fatal errors
327 are detected. */
328 COMMON unsigned char flag_always_generate_output; /* -Z */
330 enum synth_cfi_type
332 SYNTH_CFI_NONE = 0,
333 SYNTH_CFI_EXPERIMENTAL,
336 COMMON enum synth_cfi_type flag_synth_cfi;
338 /* This is true if the assembler should output time and space usage. */
339 COMMON unsigned char flag_print_statistics;
341 /* True if local absolute symbols are to be stripped. */
342 COMMON int flag_strip_local_absolute;
344 /* True if we should generate a traditional format object file. */
345 COMMON int flag_traditional_format;
347 /* Type of compressed debug sections we should generate. */
348 COMMON enum compressed_debug_section_type flag_compress_debug;
350 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
351 COMMON int flag_execstack;
353 /* TRUE if .note.GNU-stack section with SEC_CODE should be created */
354 COMMON int flag_noexecstack;
356 /* TRUE if .sframe section should be created. */
357 COMMON int flag_gen_sframe;
359 /* name of emitted object file */
360 COMMON const char *out_file_name;
362 /* Keep the output file. */
363 COMMON int keep_it;
365 /* name of file defining extensions to the basic instruction set */
366 COMMON char *insttbl_file_name;
368 /* TRUE if we need a second pass. */
369 COMMON int need_pass_2;
371 /* TRUE if we should do no relaxing, and
372 leave lots of padding. */
373 COMMON int linkrelax;
375 COMMON int do_not_pad_sections_to_alignment;
377 enum multibyte_input_handling
379 multibyte_allow = 0,
380 multibyte_warn,
381 multibyte_warn_syms
383 COMMON enum multibyte_input_handling multibyte_handling;
385 /* TRUE if we should produce a listing. */
386 extern int listing;
388 /* Type of debugging information we should generate. We currently support
389 stabs, ECOFF, and DWARF2.
391 NOTE! This means debug information about the assembly source code itself
392 and _not_ about possible debug information from a high-level language.
393 This is especially relevant to DWARF2, since the compiler may emit line
394 number directives that the assembler resolves. */
396 enum debug_info_type
398 DEBUG_UNSPECIFIED,
399 DEBUG_NONE,
400 DEBUG_STABS,
401 DEBUG_ECOFF,
402 DEBUG_DWARF,
403 DEBUG_DWARF2,
404 DEBUG_CODEVIEW
407 extern enum debug_info_type debug_type;
408 extern int use_gnu_debug_info_extensions;
409 COMMON bool flag_dwarf_sections;
410 extern int flag_dwarf_cie_version;
411 extern unsigned int dwarf_level;
413 /* Maximum level of macro nesting. */
414 extern int max_macro_nest;
416 /* Verbosity level. */
417 extern int verbose;
419 struct obstack;
421 /* Obstack chunk size. Keep large for efficient space use, make small to
422 increase malloc calls for monitoring memory allocation. */
423 extern int chunksize;
425 struct _pseudo_type
427 /* assembler mnemonic, lower case, no '.' */
428 const char *poc_name;
429 /* Do the work */
430 void (*poc_handler) (int);
431 /* Value to pass to handler */
432 int poc_val;
435 typedef struct _pseudo_type pseudo_typeS;
437 #if (__GNUC__ >= 2) && !defined(VMS)
438 /* for use with -Wformat */
440 #if __GNUC__ == 2 && __GNUC_MINOR__ < 6
441 /* Support for double underscores in attribute names was added in gcc
442 2.6, so avoid them if we are using an earlier version. */
443 #define __printf__ printf
444 #define __format__ format
445 #endif
447 #define PRINTF_LIKE(FCN) \
448 void FCN (const char *format, ...) \
449 __attribute__ ((__format__ (__printf__, 1, 2)))
450 #define PRINTF_WHERE_LIKE(FCN) \
451 void FCN (const char *file, unsigned int line, const char *format, ...) \
452 __attribute__ ((__format__ (__printf__, 3, 4)))
453 #define PRINTF_INDENT_LIKE(FCN) \
454 void FCN (const char *file, unsigned int line, unsigned int indent, \
455 const char *format, ...) \
456 __attribute__ ((__format__ (__printf__, 4, 5)))
458 #else /* __GNUC__ < 2 || defined(VMS) */
460 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
461 #define PRINTF_WHERE_LIKE(FCN) void FCN (const char *file, \
462 unsigned int line, \
463 const char *format, ...)
464 #define PRINTF_INDENT_LIKE(FCN) void FCN (const char *file, \
465 unsigned int line, \
466 unsigned int indent, \
467 const char *format, ...)
469 #endif /* __GNUC__ < 2 || defined(VMS) */
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 PRINTF_INDENT_LIKE (as_info_where);
479 void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
480 void signal_init (void);
481 int had_errors (void);
482 int had_warnings (void);
483 void as_warn_value_out_of_range (const char *, offsetT, offsetT, offsetT,
484 const char *, unsigned);
485 void as_bad_value_out_of_range (const char *, offsetT, offsetT, offsetT,
486 const char *, unsigned);
487 void print_version_id (void);
488 char * app_push (void);
490 /* Number of littlenums required to hold an extended precision number. */
491 #define MAX_LITTLENUMS 6
493 char * atof_ieee (char *, int, LITTLENUM_TYPE *);
494 char * atof_ieee_detail (char *, int, int, LITTLENUM_TYPE *, FLONUM_TYPE *);
495 const char * ieee_md_atof (int, char *, int *, bool);
496 const char * vax_md_atof (int, char *, int *);
497 char * input_scrub_include_file (const char *, char *);
498 void input_scrub_insert_line (const char *);
499 void input_scrub_insert_file (char *);
500 char * input_scrub_new_file (const char *);
501 char * input_scrub_next_buffer (char **bufp);
502 size_t do_scrub_chars (size_t (*get) (char *, size_t), char *, size_t, bool);
503 size_t do_scrub_pending (void);
504 bool scan_for_multibyte_characters (const unsigned char *, const unsigned char *, bool);
505 int gen_to_words (LITTLENUM_TYPE *, int, long);
506 int had_err (void);
507 int ignore_input (void);
508 void cond_finish_check (int);
509 void cond_exit_macro (int);
510 int seen_at_least_1_file (void);
511 void app_pop (char *);
512 void as_report_context (void);
513 const char * as_where (unsigned int *);
514 const char * as_where_top (unsigned int *);
515 const char * as_where_physical (unsigned int *);
516 void bump_line_counters (void);
517 void do_scrub_begin (int);
518 void input_scrub_begin (void);
519 void input_scrub_close (void);
520 void input_scrub_end (void);
521 void new_logical_line (const char *, int);
522 void new_logical_line_flags (const char *, int, int);
523 void subsegs_begin (void);
524 void subsegs_end (struct obstack **);
525 void subseg_change (segT, int);
526 segT subseg_new (const char *, subsegT);
527 segT subseg_force_new (const char *, subsegT);
528 void subseg_set (segT, subsegT);
529 int subseg_text_p (segT);
530 int seg_not_empty_p (segT);
531 void start_dependencies (char *);
532 void register_dependency (const char *);
533 void print_dependencies (void);
534 segT subseg_get (const char *, int);
536 char *remap_debug_filename (const char *);
537 void add_debug_prefix_map (const char *);
539 static inline char *
540 xmemdup0 (const char *in, size_t len)
542 return xmemdup (in, len, len + 1);
545 struct expressionS;
546 struct fix;
547 typedef struct symbol symbolS;
548 typedef struct frag fragS;
550 /* literal.c */
551 valueT add_to_literal_pool (symbolS *, valueT, segT, int);
553 int check_eh_frame (struct expressionS *, unsigned int *);
554 int eh_frame_estimate_size_before_relax (fragS *);
555 int eh_frame_relax_frag (fragS *);
556 void eh_frame_convert_frag (fragS *);
557 void eh_begin (void);
558 int generic_force_reloc (struct fix *);
560 /* SFrame FRE optimization. */
561 int sframe_estimate_size_before_relax (fragS *);
562 int sframe_relax_frag (fragS *);
563 void sframe_convert_frag (fragS *);
565 #include "expr.h" /* Before targ-*.h */
567 /* This one starts the chain of target dependent headers. */
568 #include "targ-env.h"
570 #ifdef OBJ_MAYBE_ELF
571 #define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
572 #else
573 #ifdef OBJ_ELF
574 #define IS_ELF 1
575 #else
576 #define IS_ELF 0
577 #endif
578 #endif
580 #include "write.h"
581 #include "frags.h"
582 #include "read.h"
583 #include "symbols.h"
584 #include "hashtab.h"
585 #include "hash.h"
587 #include "tc.h"
588 #include "obj.h"
590 #ifdef USE_EMULATIONS
591 #include "emul.h"
592 #endif
593 #include "listing.h"
595 #ifdef H_TICK_HEX
596 extern int enable_h_tick_hex;
597 #endif
599 #ifdef TC_M68K
600 /* True if we are assembling in m68k MRI mode. */
601 COMMON int flag_m68k_mri;
602 #define DOLLAR_AMBIGU flag_m68k_mri
603 #else
604 #define flag_m68k_mri 0
605 #endif
607 #ifndef TC_STRING_ESCAPES
608 #define TC_STRING_ESCAPES 1
609 #endif
611 #ifdef WARN_COMMENTS
612 COMMON int warn_comment;
613 COMMON unsigned int found_comment;
614 COMMON const char * found_comment_file;
615 #endif
617 #if defined OBJ_ELF || defined OBJ_MAYBE_ELF
618 /* If .size directive failure should be error or warning. */
619 COMMON int flag_allow_nonconst_size;
621 /* If we should generate ELF common symbols with the STT_COMMON type. */
622 extern int flag_use_elf_stt_common;
624 /* TRUE iff GNU Build attribute notes should
625 be generated if none are in the input files. */
626 extern bool flag_generate_build_notes;
628 /* If section name substitution sequences should be honored */
629 COMMON int flag_sectname_subst;
630 #endif
632 #ifndef DOLLAR_AMBIGU
633 #define DOLLAR_AMBIGU 0
634 #endif
636 #ifndef NUMBERS_WITH_SUFFIX
637 #define NUMBERS_WITH_SUFFIX 0
638 #endif
640 #ifndef LOCAL_LABELS_DOLLAR
641 #define LOCAL_LABELS_DOLLAR 0
642 #endif
644 #ifndef LOCAL_LABELS_FB
645 #define LOCAL_LABELS_FB 0
646 #endif
648 #ifndef LABELS_WITHOUT_COLONS
649 #define LABELS_WITHOUT_COLONS 0
650 #endif
652 #ifndef NO_PSEUDO_DOT
653 #define NO_PSEUDO_DOT 0
654 #endif
656 #ifndef TEXT_SECTION_NAME
657 #define TEXT_SECTION_NAME ".text"
658 #define DATA_SECTION_NAME ".data"
659 #define BSS_SECTION_NAME ".bss"
660 #endif
662 #ifndef OCTETS_PER_BYTE_POWER
663 #define OCTETS_PER_BYTE_POWER 0
664 #endif
665 #ifndef OCTETS_PER_BYTE
666 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
667 #endif
668 #if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
669 #error "Octets per byte conflicts with its power-of-two definition!"
670 #endif
672 #if defined OBJ_ELF || defined OBJ_MAYBE_ELF
673 /* On ELF platforms, mark debug sections with SEC_ELF_OCTETS */
674 #define SEC_OCTETS (IS_ELF ? SEC_ELF_OCTETS : 0)
675 #else
676 #define SEC_OCTETS 0
677 #endif
679 #define POISON_BFD_BOOLEAN 1
681 #endif /* GAS */