1 /* as.h - global header file
2 Copyright (C) 1987, 1990, 1991, 1992 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 2, or (at your option)
11 GAS is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public 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
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
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 "".
38 /* These #defines are for parameters of entire assembler. */
40 /* These #includes are for type definitions etc. */
46 /* The first getopt value for machine-independent long options.
47 150 isn't special; it's just an arbitrary non-ASCII char value. */
48 #define OPTION_STD_BASE 150
49 /* The first getopt value for machine-dependent long options.
50 170 gives the standard options room to grow. */
51 #define OPTION_MD_BASE 170
65 /* Make Saber happier on obstack.h. */
68 #define __PTR_TO_INT(P) ((int)(P))
70 #define __INT_TO_PTR(P) ((char *)(P))
74 #define __LINE__ "unknown"
78 #define __FILE__ "unknown"
88 #endif /* ! __STDC__ */
90 #if !defined (__GNUC__) && !defined (inline)
95 #include "fopen-same.h"
98 #define obstack_chunk_alloc xmalloc
99 #define obstack_chunk_free xfree
103 #define BAD_CASE(val) \
105 as_fatal("Case value %ld unexpected at line %d of file \"%s\"\n", \
106 (long) val, __LINE__, __FILE__); \
109 /* Version 2.1 of Solaris had problems with this declaration, but I
110 think that bug has since been fixed. If it causes problems on your
111 system, just delete it. */
112 extern char *strstr ();
115 /* These are assembler-wide concepts */
118 extern bfd
*stdoutput
;
119 typedef bfd_vma addressT
;
120 typedef bfd_signed_vma offsetT
;
122 typedef unsigned long addressT
;
123 typedef long offsetT
;
126 /* Type of symbol value, etc. For use in prototypes. */
127 typedef addressT valueT
;
131 #define COMMON /* declare our COMMONs storage here. */
133 #define COMMON extern /* our commons live elswhere */
136 /* COMMON now defined */
140 #define know(p) assert(p) /* Verify our assumptions! */
141 #endif /* not yet defined */
143 #define know(p) /* know() checks are no-op.ed */
146 #if defined (BROKEN_ASSERT) && !defined (NDEBUG)
147 /* Used on machines where the "assert" macro is buggy. (For example, on the
148 RS/6000, Reiser-cpp substitution is done to put the condition into a
149 string, so if the condition contains a string, parse errors result.) If
150 the condition fails, just drop core file. */
152 #define assert(p) ((p) ? 0 : (abort (), 0))
158 * Supplies sanitised buffers to read.c.
159 * Also understands printing line-number part of error messages.
163 /* subsegs.c Sub-segments. Also, segment(=expression type)s.*/
165 #ifndef BFD_ASSEMBLER
169 #define N_SEGMENTS 10
170 #define SEG_NORMAL(x) ((x) >= SEG_E0 && (x) <= SEG_E9)
171 #define SEG_LIST SEG_E0,SEG_E1,SEG_E2,SEG_E3,SEG_E4,SEG_E5,SEG_E6,SEG_E7,SEG_E8,SEG_E9
172 #define SEG_TEXT SEG_E0
173 #define SEG_DATA SEG_E1
174 #define SEG_BSS SEG_E2
177 #define SEG_NORMAL(x) ((x) == SEG_TEXT || (x) == SEG_DATA || (x) == SEG_BSS)
178 #define SEG_LIST SEG_TEXT,SEG_DATA,SEG_BSS
186 SEG_GOOF
, /* Only happens if AS has a logic error. */
187 /* Invented so we don't crash printing */
188 /* error message involving weird segment. */
189 SEG_EXPR
, /* Intermediate expression values. */
190 SEG_DEBUG
, /* Debug segment */
191 SEG_NTV
, /* Transfert vector preload segment */
192 SEG_PTV
, /* Transfert vector postload segment */
193 SEG_REGISTER
/* Mythical: a register-valued expression */
196 #define SEG_MAXIMUM_ORDINAL (SEG_REGISTER)
198 typedef asection
*segT
;
199 #define SEG_NORMAL(SEG) ((SEG) != absolute_section \
200 && (SEG) != undefined_section \
201 && (SEG) != reg_section \
202 && (SEG) != expr_section)
206 /* What subseg we are accreting now? */
207 COMMON subsegT now_subseg
;
209 /* Segment our instructions emit to. */
213 #define segment_name(SEG) bfd_get_section_name (stdoutput, SEG)
215 extern char *const seg_name
[];
216 #define segment_name(SEG) seg_name[(int) (SEG)]
219 #ifndef BFD_ASSEMBLER
220 extern int section_alignment
[];
224 extern segT reg_section
, expr_section
;
225 /* Shouldn't these be eliminated someday? */
226 extern segT text_section
, data_section
, bss_section
;
227 #define absolute_section (&bfd_abs_section)
228 #define undefined_section (&bfd_und_section)
230 #define reg_section SEG_REGISTER
231 #define expr_section SEG_EXPR
232 #define text_section SEG_TEXT
233 #define data_section SEG_DATA
234 #define bss_section SEG_BSS
235 #define absolute_section SEG_ABSOLUTE
236 #define undefined_section SEG_UNKNOWN
241 typedef enum _relax_state
243 /* Variable chars to be repeated fr_offset times.
244 Fr_symbol unused. Used with fr_offset == 0 for a
245 constant length frag. */
248 /* Align: Fr_offset: power of 2. Variable chars: fill pattern. */
251 /* Org: Fr_offset, fr_symbol: address. 1 variable char: fill
257 #ifndef WORKING_DOT_WORD
263 /* typedef unsigned char relax_substateT; */
264 /* JF this is more likely to leave the end of a struct frag on an align
265 boundry. Be very careful with this. */
266 typedef unsigned long relax_substateT
;
268 /* Enough bits for address, but still an integer type.
269 Could be a problem, cross-assembling for 64-bit machines. */
270 typedef addressT relax_addressT
;
276 * A code fragment (frag) is some known number of chars, followed by some
277 * unknown number of chars. Typically the unknown number of chars is an
278 * instruction address whose size is yet unknown. We always know the greatest
279 * possible size the unknown number of chars may become, and reserve that
280 * much room at the end of the frag.
281 * Once created, frags do not change address during assembly.
282 * We chain the frags in (a) forward-linked list(s). The object-file address
283 * of the 1st char of a frag is generally not known until after relax().
284 * Many things at assembly time describe an address by {object-file-address
285 * of a particular frag}+offset.
287 BUG: it may be smarter to have a single pointer off to various different
288 notes for different frag kinds. See how code pans
292 /* Object file address. */
294 /* Chain forward; ascending address order. Rooted in frch_root. */
295 struct frag
*fr_next
;
297 /* (Fixed) number of chars we know we have. May be 0. */
299 /* (Variable) number of chars after above. May be 0. */
301 /* For variable-length tail. */
302 struct symbol
*fr_symbol
;
303 /* For variable-length tail. */
305 /* Points to opcode low addr byte, for relaxation. */
309 struct list_info_struct
*line
;
312 /* What state is my tail in? */
313 relax_stateT fr_type
;
314 relax_substateT fr_subtype
;
316 /* These are needed only on the NS32K machines */
317 char fr_pcrel_adjust
;
321 One day we will compile fr_literal[0]. */
325 #define SIZEOF_STRUCT_FRAG \
326 ((int)zero_address_frag.fr_literal-(int)&zero_address_frag)
327 /* We want to say fr_literal[0] above. */
329 typedef struct frag fragS
;
331 /* Current frag we are building. This frag is incomplete. It is, however,
332 included in frchain_now. The fr_fix field is bogus; instead, use:
333 obstack_next_free(&frags)-frag_now->fr_literal. */
334 COMMON fragS
*frag_now
;
335 #define frag_now_fix() ((char*)obstack_next_free (&frags) - frag_now->fr_literal)
337 /* For foreign-segment symbol fixups. */
338 COMMON fragS zero_address_frag
;
339 /* For local common (N_BSS segment) fixups. */
340 COMMON fragS bss_address_frag
;
342 /* main program "as.c" (command arguments etc) */
344 COMMON
unsigned char flag_no_comments
; /* -f */
345 COMMON
unsigned char flag_debug
; /* -D */
346 COMMON
unsigned char flag_signed_overflow_ok
; /* -J */
347 COMMON
unsigned char flag_warn_displacement
; /* -K */
348 COMMON
unsigned char flag_keep_locals
; /* -L */
349 COMMON
unsigned char flag_readonly_data_in_text
; /* -R */
350 COMMON
unsigned char flag_no_warnings
; /* -W */
351 COMMON
unsigned char flag_always_generate_output
; /* -Z */
353 /* name of emitted object file */
354 COMMON
char *out_file_name
;
356 /* TRUE if we need a second pass. */
357 COMMON
int need_pass_2
;
359 /* TRUE if we should do no relaxing, and
360 leave lots of padding. */
361 COMMON
int linkrelax
;
363 /* TRUE if we should produce a listing. */
368 /* assembler mnemonic, lower case, no '.' */
371 void (*poc_handler
) PARAMS ((int));
372 /* Value to pass to handler */
376 typedef struct _pseudo_type pseudo_typeS
;
378 #ifdef BFD_ASSEMBLER_xxx
383 struct lineno_struct
*next
;
385 typedef struct lineno_struct lineno
;
388 #if defined (__STDC__) && !defined(NO_STDARG)
391 /* for use with -Wformat */
392 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...) \
393 __attribute__ ((format (printf, 1, 2)))
394 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, unsigned int line, \
395 const char *format, ...) \
396 __attribute__ ((format (printf, 3, 4)))
397 #else /* ANSI C with stdarg, but not GNU C */
398 #define PRINTF_LIKE(FCN) void FCN (const char *format, ...)
399 #define PRINTF_WHERE_LIKE(FCN) void FCN (char *file, unsigned int line, \
400 const char *format, ...)
402 #else /* not ANSI C, or not stdarg */
403 #define PRINTF_LIKE(FCN) void FCN ()
404 #define PRINTF_WHERE_LIKE(FCN) void FCN ()
407 PRINTF_LIKE (as_bad
);
408 PRINTF_LIKE (as_fatal
);
409 PRINTF_LIKE (as_tsktsk
);
410 PRINTF_LIKE (as_warn
);
411 PRINTF_WHERE_LIKE (as_bad_where
);
412 PRINTF_WHERE_LIKE (as_warn_where
);
414 void fprint_value
PARAMS ((FILE *file
, addressT value
));
415 void sprint_value
PARAMS ((char *buf
, addressT value
));
417 int had_errors
PARAMS ((void));
418 int had_warnings
PARAMS ((void));
420 void print_version_id
PARAMS ((void));
421 char *app_push
PARAMS ((void));
422 char *atof_ieee
PARAMS ((char *str
, int what_kind
, LITTLENUM_TYPE
* words
));
423 char *input_scrub_include_file
PARAMS ((char *filename
, char *position
));
424 char *input_scrub_new_file
PARAMS ((char *filename
));
425 char *input_scrub_next_buffer
PARAMS ((char **bufp
));
426 PTR xmalloc
PARAMS ((unsigned long size
));
427 PTR xrealloc
PARAMS ((PTR ptr
, unsigned long n
));
428 int do_scrub_next_char
PARAMS ((int (*get
) (void), void (*unget
) (int)));
429 int gen_to_words
PARAMS ((LITTLENUM_TYPE
* words
, int precision
,
430 long exponent_bits
));
431 int had_err
PARAMS ((void));
432 int ignore_input
PARAMS ((void));
433 int scrub_from_file
PARAMS ((void));
434 int scrub_from_string
PARAMS ((void));
435 int seen_at_least_1_file
PARAMS ((void));
436 void app_pop
PARAMS ((char *arg
));
437 void as_howmuch
PARAMS ((FILE * stream
));
438 void as_perror
PARAMS ((const char *gripe
, const char *filename
));
439 void as_where
PARAMS ((char **namep
, unsigned int *linep
));
440 void bump_line_counters
PARAMS ((void));
441 void do_scrub_begin
PARAMS ((void));
442 void input_scrub_begin
PARAMS ((void));
443 void input_scrub_close
PARAMS ((void));
444 void input_scrub_end
PARAMS ((void));
445 void new_logical_line
PARAMS ((char *fname
, int line_number
));
446 void scrub_to_file
PARAMS ((int ch
));
447 void scrub_to_string
PARAMS ((int ch
));
448 void subsegs_begin
PARAMS ((void));
449 void subseg_change
PARAMS ((segT seg
, int subseg
));
450 segT subseg_new
PARAMS ((const char *name
, subsegT subseg
));
451 segT subseg_force_new
PARAMS ((const char *name
, subsegT subseg
));
452 void subseg_set
PARAMS ((segT seg
, subsegT subseg
));
454 segT subseg_get
PARAMS ((const char *, int));
463 valueT add_to_literal_pool
PARAMS ((struct symbol
*, valueT
, segT
, int));
466 /* this one starts the chain of target dependant headers */
467 #include "targ-env.h"
470 #include "struc-symbol.h"
483 /* Someday perhaps this will be selectable at run-time. */
484 #if defined (OBJ_AOUT) || defined (OBJ_BOUT)
485 #define OUTPUT_FLAVOR bfd_target_aout_flavour
488 #define OUTPUT_FLAVOR bfd_target_coff_flavour
491 #define OUTPUT_FLAVOR bfd_target_ecoff_flavour
494 #define OUTPUT_FLAVOR bfd_target_elf_flavour
496 #endif /* BFD_ASSEMBLER */