Replace "if (x) free (x)" with "free (x)", gas
[deliverable/binutils-gdb.git] / gas / as.h
... / ...
CommitLineData
1/* as.h - global header file
2 Copyright (C) 1987-2020 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_section_name (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 /* .nop directive with expression operand that needs to be computed
283 later. Similar to rs_space, but different. It fills with no-op
284 instructions.
285 fr_symbol: operand
286 1 constant byte: no-op fill control byte. */
287 rs_space_nop,
288
289 /* Similar to rs_fill. It is used to implement .nop directive . */
290 rs_fill_nop,
291
292 /* A DWARF leb128 value; only ELF uses this. The subtype is 0 for
293 unsigned, 1 for signed. */
294 rs_leb128,
295
296 /* Exception frame information which we may be able to optimize. */
297 rs_cfa,
298
299 /* Cross-fragment dwarf2 line number optimization. */
300 rs_dwarf2dbg
301};
302
303typedef enum _relax_state relax_stateT;
304
305/* This type is used in prototypes, so it can't be a type that will be
306 widened for argument passing. */
307typedef unsigned int relax_substateT;
308
309/* Enough bits for address, but still an integer type.
310 Could be a problem, cross-assembling for 64-bit machines. */
311typedef addressT relax_addressT;
312
313struct relax_type
314{
315 /* Forward reach. Signed number. > 0. */
316 offsetT rlx_forward;
317 /* Backward reach. Signed number. < 0. */
318 offsetT rlx_backward;
319
320 /* Bytes length of this address. */
321 unsigned char rlx_length;
322
323 /* Next longer relax-state. 0 means there is no 'next' relax-state. */
324 relax_substateT rlx_more;
325};
326
327typedef struct relax_type relax_typeS;
328\f
329/* main program "as.c" (command arguments etc). */
330
331COMMON unsigned char flag_no_comments; /* -f */
332COMMON unsigned char flag_debug; /* -D */
333COMMON unsigned char flag_signed_overflow_ok; /* -J */
334#ifndef WORKING_DOT_WORD
335COMMON unsigned char flag_warn_displacement; /* -K */
336#endif
337
338/* True if local symbols should be retained. */
339COMMON int flag_keep_locals; /* -L */
340
341/* True if we are assembling in MRI mode. */
342COMMON int flag_mri;
343
344/* Should the data section be made read-only and appended to the text
345 section? */
346COMMON unsigned char flag_readonly_data_in_text; /* -R */
347
348/* True if warnings should be inhibited. */
349COMMON int flag_no_warnings; /* -W */
350
351/* True if warnings count as errors. */
352COMMON int flag_fatal_warnings; /* --fatal-warnings */
353
354/* True if we should attempt to generate output even if non-fatal errors
355 are detected. */
356COMMON unsigned char flag_always_generate_output; /* -Z */
357
358/* This is true if the assembler should output time and space usage. */
359COMMON unsigned char flag_print_statistics;
360
361/* True if local absolute symbols are to be stripped. */
362COMMON int flag_strip_local_absolute;
363
364/* True if we should generate a traditional format object file. */
365COMMON int flag_traditional_format;
366
367/* Type of compressed debug sections we should generate. */
368COMMON enum compressed_debug_section_type flag_compress_debug;
369
370/* TRUE if .note.GNU-stack section with SEC_CODE should be created */
371COMMON int flag_execstack;
372
373/* TRUE if .note.GNU-stack section with SEC_CODE should be created */
374COMMON int flag_noexecstack;
375
376/* name of emitted object file */
377COMMON const char *out_file_name;
378
379/* name of file defining extensions to the basic instruction set */
380COMMON char *insttbl_file_name;
381
382/* TRUE if we need a second pass. */
383COMMON int need_pass_2;
384
385/* TRUE if we should do no relaxing, and
386 leave lots of padding. */
387COMMON int linkrelax;
388
389COMMON int do_not_pad_sections_to_alignment;
390
391/* TRUE if we should produce a listing. */
392extern int listing;
393
394/* Type of debugging information we should generate. We currently support
395 stabs, ECOFF, and DWARF2.
396
397 NOTE! This means debug information about the assembly source code itself
398 and _not_ about possible debug information from a high-level language.
399 This is especially relevant to DWARF2, since the compiler may emit line
400 number directives that the assembler resolves. */
401
402enum debug_info_type
403{
404 DEBUG_UNSPECIFIED,
405 DEBUG_NONE,
406 DEBUG_STABS,
407 DEBUG_ECOFF,
408 DEBUG_DWARF,
409 DEBUG_DWARF2
410};
411
412extern enum debug_info_type debug_type;
413extern int use_gnu_debug_info_extensions;
414COMMON bfd_boolean flag_dwarf_sections;
415extern int flag_dwarf_cie_version;
416extern unsigned int dwarf_level;
417\f
418/* Maximum level of macro nesting. */
419extern int max_macro_nest;
420
421/* Verbosity level. */
422extern int verbose;
423
424/* Obstack chunk size. Keep large for efficient space use, make small to
425 increase malloc calls for monitoring memory allocation. */
426extern int chunksize;
427
428struct _pseudo_type
429{
430 /* assembler mnemonic, lower case, no '.' */
431 const char *poc_name;
432 /* Do the work */
433 void (*poc_handler) (int);
434 /* Value to pass to handler */
435 int poc_val;
436};
437
438typedef struct _pseudo_type pseudo_typeS;
439
440#if (__GNUC__ >= 2) && !defined(VMS)
441/* for use with -Wformat */
442
443#if __GNUC__ == 2 && __GNUC_MINOR__ < 6
444/* Support for double underscores in attribute names was added in gcc
445 2.6, so avoid them if we are using an earlier version. */
446#define __printf__ printf
447#define __format__ format
448#endif
449
450#define PRINTF_LIKE(FCN) \
451 void FCN (const char *format, ...) \
452 __attribute__ ((__format__ (__printf__, 1, 2)))
453#define PRINTF_WHERE_LIKE(FCN) \
454 void FCN (const char *file, unsigned int line, const char *format, ...) \
455 __attribute__ ((__format__ (__printf__, 3, 4)))
456
457#else /* __GNUC__ < 2 || defined(VMS) */
458
459#define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
460#define PRINTF_WHERE_LIKE(FCN) void FCN (const char *file, \
461 unsigned int line, \
462 const char *format, ...)
463
464#endif /* __GNUC__ < 2 || defined(VMS) */
465
466PRINTF_LIKE (as_bad);
467PRINTF_LIKE (as_fatal) ATTRIBUTE_NORETURN;
468PRINTF_LIKE (as_tsktsk);
469PRINTF_LIKE (as_warn);
470PRINTF_WHERE_LIKE (as_bad_where);
471PRINTF_WHERE_LIKE (as_warn_where);
472
473void as_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
474void signal_init (void);
475void sprint_value (char *, addressT);
476int had_errors (void);
477int had_warnings (void);
478void as_warn_value_out_of_range (const char *, offsetT, offsetT, offsetT,
479 const char *, unsigned);
480void as_bad_value_out_of_range (const char *, offsetT, offsetT, offsetT,
481 const char *, unsigned);
482void print_version_id (void);
483char * app_push (void);
484
485/* Number of littlenums required to hold an extended precision number. */
486#define MAX_LITTLENUMS 6
487
488char * atof_ieee (char *, int, LITTLENUM_TYPE *);
489char * atof_ieee_detail (char *, int, int, LITTLENUM_TYPE *, FLONUM_TYPE *);
490const char * ieee_md_atof (int, char *, int *, bfd_boolean);
491const char * vax_md_atof (int, char *, int *);
492char * input_scrub_include_file (const char *, char *);
493void input_scrub_insert_line (const char *);
494void input_scrub_insert_file (char *);
495char * input_scrub_new_file (const char *);
496char * input_scrub_next_buffer (char **bufp);
497size_t do_scrub_chars (size_t (*get) (char *, size_t), char *, size_t);
498int gen_to_words (LITTLENUM_TYPE *, int, long);
499int had_err (void);
500int ignore_input (void);
501void cond_finish_check (int);
502void cond_exit_macro (int);
503int seen_at_least_1_file (void);
504void app_pop (char *);
505const char * as_where (unsigned int *);
506const char * as_where_physical (unsigned int *);
507void bump_line_counters (void);
508void do_scrub_begin (int);
509void input_scrub_begin (void);
510void input_scrub_close (void);
511void input_scrub_end (void);
512int new_logical_line (const char *, int);
513int new_logical_line_flags (const char *, int, int);
514void subsegs_begin (void);
515void subseg_change (segT, int);
516segT subseg_new (const char *, subsegT);
517segT subseg_force_new (const char *, subsegT);
518void subseg_set (segT, subsegT);
519int subseg_text_p (segT);
520int seg_not_empty_p (segT);
521void start_dependencies (char *);
522void register_dependency (const char *);
523void print_dependencies (void);
524segT subseg_get (const char *, int);
525
526const char *remap_debug_filename (const char *);
527void add_debug_prefix_map (const char *);
528
529static inline char *
530xmemdup0 (const char *in, size_t len)
531{
532 char *out = (char *) xmalloc (len + 1);
533 out[len] = 0;
534 return (char *) memcpy (out, in, len);
535}
536
537struct expressionS;
538struct fix;
539typedef struct symbol symbolS;
540typedef struct frag fragS;
541
542/* literal.c */
543valueT add_to_literal_pool (symbolS *, valueT, segT, int);
544
545int check_eh_frame (struct expressionS *, unsigned int *);
546int eh_frame_estimate_size_before_relax (fragS *);
547int eh_frame_relax_frag (fragS *);
548void eh_frame_convert_frag (fragS *);
549int generic_force_reloc (struct fix *);
550
551#include "expr.h" /* Before targ-*.h */
552
553/* This one starts the chain of target dependent headers. */
554#include "targ-env.h"
555
556#ifdef OBJ_MAYBE_ELF
557#define IS_ELF (OUTPUT_FLAVOR == bfd_target_elf_flavour)
558#else
559#ifdef OBJ_ELF
560#define IS_ELF 1
561#else
562#define IS_ELF 0
563#endif
564#endif
565
566#include "write.h"
567#include "frags.h"
568#include "hash.h"
569#include "read.h"
570#include "symbols.h"
571
572#include "tc.h"
573#include "obj.h"
574
575#ifdef USE_EMULATIONS
576#include "emul.h"
577#endif
578#include "listing.h"
579
580#ifdef H_TICK_HEX
581extern int enable_h_tick_hex;
582#endif
583
584#ifdef TC_M68K
585/* True if we are assembling in m68k MRI mode. */
586COMMON int flag_m68k_mri;
587#define DOLLAR_AMBIGU flag_m68k_mri
588#else
589#define flag_m68k_mri 0
590#endif
591
592#ifndef TC_STRING_ESCAPES
593#define TC_STRING_ESCAPES 1
594#endif
595
596#ifdef WARN_COMMENTS
597COMMON int warn_comment;
598COMMON unsigned int found_comment;
599COMMON const char * found_comment_file;
600#endif
601
602#if defined OBJ_ELF || defined OBJ_MAYBE_ELF
603/* If .size directive failure should be error or warning. */
604COMMON int flag_allow_nonconst_size;
605
606/* If we should generate ELF common symbols with the STT_COMMON type. */
607extern int flag_use_elf_stt_common;
608
609/* TRUE iff GNU Build attribute notes should
610 be generated if none are in the input files. */
611extern bfd_boolean flag_generate_build_notes;
612
613/* If section name substitution sequences should be honored */
614COMMON int flag_sectname_subst;
615#endif
616
617#ifndef DOLLAR_AMBIGU
618#define DOLLAR_AMBIGU 0
619#endif
620
621#ifndef NUMBERS_WITH_SUFFIX
622#define NUMBERS_WITH_SUFFIX 0
623#endif
624
625#ifndef LOCAL_LABELS_DOLLAR
626#define LOCAL_LABELS_DOLLAR 0
627#endif
628
629#ifndef LOCAL_LABELS_FB
630#define LOCAL_LABELS_FB 0
631#endif
632
633#ifndef LABELS_WITHOUT_COLONS
634#define LABELS_WITHOUT_COLONS 0
635#endif
636
637#ifndef NO_PSEUDO_DOT
638#define NO_PSEUDO_DOT 0
639#endif
640
641#ifndef TEXT_SECTION_NAME
642#define TEXT_SECTION_NAME ".text"
643#define DATA_SECTION_NAME ".data"
644#define BSS_SECTION_NAME ".bss"
645#endif
646
647#ifndef OCTETS_PER_BYTE_POWER
648#define OCTETS_PER_BYTE_POWER 0
649#endif
650#ifndef OCTETS_PER_BYTE
651#define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
652#endif
653#if OCTETS_PER_BYTE != (1<<OCTETS_PER_BYTE_POWER)
654 #error "Octets per byte conflicts with its power-of-two definition!"
655#endif
656
657#if defined OBJ_ELF || defined OBJ_MAYBE_ELF
658/* On ELF platforms, mark debug sections with SEC_ELF_OCTETS */
659#define SEC_OCTETS (IS_ELF ? SEC_ELF_OCTETS : 0)
660#else
661#define SEC_OCTETS 0
662#endif
663
664#endif /* GAS */
This page took 0.024003 seconds and 4 git commands to generate.