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