file config.texi was initially added on branch binutils-2_17-branch.
[binutils.git] / gas / config / obj-coff.h
blob6fcbc9f06cbbdf088a1c408bdba0e5546f3ab979
1 /* coff object file format
2 Copyright 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005
4 Free Software Foundation, Inc.
6 This file is part of GAS.
8 GAS is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GAS is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GAS; see the file COPYING. If not, write to the Free
20 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
21 02110-1301, USA. */
23 #ifndef OBJ_FORMAT_H
24 #define OBJ_FORMAT_H
26 #define OBJ_COFF 1
28 #include "targ-cpu.h"
30 #include "bfd.h"
32 /* This internal_lineno crap is to stop namespace pollution from the
33 bfd internal coff headerfile. */
34 #define internal_lineno bfd_internal_lineno
35 #include "coff/internal.h"
36 #undef internal_lineno
38 /* CPU-specific setup: */
40 #ifdef TC_ARM
41 #include "coff/arm.h"
42 #ifndef TARGET_FORMAT
43 #define TARGET_FORMAT "coff-arm"
44 #endif
45 #endif
47 #ifdef TC_PPC
48 #ifdef TE_PE
49 #include "coff/powerpc.h"
50 #else
51 #include "coff/rs6000.h"
52 #endif
53 #endif
55 #ifdef TC_SPARC
56 #include "coff/sparc.h"
57 #endif
59 #ifdef TC_I386
60 #include "coff/i386.h"
62 #ifdef TE_PE
63 #define TARGET_FORMAT "pe-i386"
64 #endif
66 #ifndef TARGET_FORMAT
67 #define TARGET_FORMAT "coff-i386"
68 #endif
69 #endif
71 #ifdef TC_M68K
72 #include "coff/m68k.h"
73 #ifndef TARGET_FORMAT
74 #define TARGET_FORMAT "coff-m68k"
75 #endif
76 #endif
78 #ifdef TC_OR32
79 #include "coff/or32.h"
80 #define TARGET_FORMAT "coff-or32-big"
81 #endif
83 #ifdef TC_I960
84 #include "coff/i960.h"
85 #define TARGET_FORMAT "coff-Intel-little"
86 #endif
88 #ifdef TC_Z80
89 #include "coff/z80.h"
90 #define TARGET_FORMAT "coff-z80"
91 #endif
93 #ifdef TC_Z8K
94 #include "coff/z8k.h"
95 #define TARGET_FORMAT "coff-z8k"
96 #endif
98 #ifdef TC_H8300
99 #include "coff/h8300.h"
100 #define TARGET_FORMAT "coff-h8300"
101 #endif
103 #ifdef TC_H8500
104 #include "coff/h8500.h"
105 #define TARGET_FORMAT "coff-h8500"
106 #endif
108 #ifdef TC_MAXQ20
109 #include "coff/maxq.h"
110 #define TARGET_FORMAT "coff-maxq"
111 #endif
113 #ifdef TC_SH
115 #ifdef TE_PE
116 #define COFF_WITH_PE
117 #endif
119 #include "coff/sh.h"
121 #ifdef TE_PE
122 #define TARGET_FORMAT "pe-shl"
123 #else
125 #define TARGET_FORMAT \
126 (!target_big_endian \
127 ? (sh_small ? "coff-shl-small" : "coff-shl") \
128 : (sh_small ? "coff-sh-small" : "coff-sh"))
130 #endif
131 #endif
133 #ifdef TC_MIPS
134 #define COFF_WITH_PE
135 #include "coff/mipspe.h"
136 #undef TARGET_FORMAT
137 #define TARGET_FORMAT "pe-mips"
138 #endif
140 #ifdef TC_TIC30
141 #include "coff/tic30.h"
142 #define TARGET_FORMAT "coff-tic30"
143 #endif
145 #ifdef TC_TIC4X
146 #include "coff/tic4x.h"
147 #define TARGET_FORMAT "coff2-tic4x"
148 #endif
150 #ifdef TC_TIC54X
151 #include "coff/tic54x.h"
152 #define TARGET_FORMAT "coff1-c54x"
153 #endif
155 #ifdef TC_MCORE
156 #include "coff/mcore.h"
157 #ifndef TARGET_FORMAT
158 #define TARGET_FORMAT "pe-mcore"
159 #endif
160 #endif
162 #ifdef TE_PE
163 /* PE weak symbols need USE_UNIQUE. */
164 #define USE_UNIQUE 1
166 #define obj_set_weak_hook pecoff_obj_set_weak_hook
167 #define obj_clear_weak_hook pecoff_obj_clear_weak_hook
168 #endif
170 #ifndef OBJ_COFF_MAX_AUXENTRIES
171 #define OBJ_COFF_MAX_AUXENTRIES 1
172 #endif
174 #define obj_symbol_new_hook coff_obj_symbol_new_hook
175 #define obj_symbol_clone_hook coff_obj_symbol_clone_hook
176 #define obj_read_begin_hook coff_obj_read_begin_hook
178 #include "bfd/libcoff.h"
180 #define OUTPUT_FLAVOR bfd_target_coff_flavour
182 /* Alter the field names, for now, until we've fixed up the other
183 references to use the new name. */
184 #ifdef TC_I960
185 #define TC_SYMFIELD_TYPE symbolS *
186 #define sy_tc bal
187 #endif
189 #define OBJ_SYMFIELD_TYPE unsigned long
190 #define sy_obj sy_flags
192 /* We can't use the predefined section symbols in bfd/section.c, as
193 COFF symbols have extra fields. See bfd/libcoff.h:coff_symbol_type. */
194 #ifndef obj_sec_sym_ok_for_reloc
195 #define obj_sec_sym_ok_for_reloc(SEC) ((SEC)->owner != 0)
196 #endif
198 #define SYM_AUXENT(S) \
199 (&coffsymbol (symbol_get_bfdsym (S))->native[1].u.auxent)
200 #define SYM_AUXINFO(S) \
201 (&coffsymbol (symbol_get_bfdsym (S))->native[1])
203 /* The number of auxiliary entries. */
204 #define S_GET_NUMBER_AUXILIARY(s) \
205 (coffsymbol (symbol_get_bfdsym (s))->native->u.syment.n_numaux)
206 /* The number of auxiliary entries. */
207 #define S_SET_NUMBER_AUXILIARY(s, v) (S_GET_NUMBER_AUXILIARY (s) = (v))
209 /* True if a symbol name is in the string table, i.e. its length is > 8. */
210 #define S_IS_STRING(s) (strlen (S_GET_NAME (s)) > 8 ? 1 : 0)
212 /* Auxiliary entry macros. SA_ stands for symbol auxiliary. */
213 /* Omit the tv related fields. */
214 /* Accessors. */
216 #define SA_GET_SYM_TAGNDX(s) (SYM_AUXENT (s)->x_sym.x_tagndx.l)
217 #define SA_GET_SYM_LNNO(s) (SYM_AUXENT (s)->x_sym.x_misc.x_lnsz.x_lnno)
218 #define SA_GET_SYM_SIZE(s) (SYM_AUXENT (s)->x_sym.x_misc.x_lnsz.x_size)
219 #define SA_GET_SYM_FSIZE(s) (SYM_AUXENT (s)->x_sym.x_misc.x_fsize)
220 #define SA_GET_SYM_LNNOPTR(s) (SYM_AUXENT (s)->x_sym.x_fcnary.x_fcn.x_lnnoptr)
221 #define SA_GET_SYM_ENDNDX(s) (SYM_AUXENT (s)->x_sym.x_fcnary.x_fcn.x_endndx)
222 #define SA_GET_SYM_DIMEN(s,i) (SYM_AUXENT (s)->x_sym.x_fcnary.x_ary.x_dimen[(i)])
223 #define SA_GET_FILE_FNAME(s) (SYM_AUXENT (s)->x_file.x_fname)
224 #define SA_GET_SCN_SCNLEN(s) (SYM_AUXENT (s)->x_scn.x_scnlen)
225 #define SA_GET_SCN_NRELOC(s) (SYM_AUXENT (s)->x_scn.x_nreloc)
226 #define SA_GET_SCN_NLINNO(s) (SYM_AUXENT (s)->x_scn.x_nlinno)
228 #define SA_SET_SYM_LNNO(s,v) (SYM_AUXENT (s)->x_sym.x_misc.x_lnsz.x_lnno = (v))
229 #define SA_SET_SYM_SIZE(s,v) (SYM_AUXENT (s)->x_sym.x_misc.x_lnsz.x_size = (v))
230 #define SA_SET_SYM_FSIZE(s,v) (SYM_AUXENT (s)->x_sym.x_misc.x_fsize = (v))
231 #define SA_SET_SYM_LNNOPTR(s,v) (SYM_AUXENT (s)->x_sym.x_fcnary.x_fcn.x_lnnoptr = (v))
232 #define SA_SET_SYM_DIMEN(s,i,v) (SYM_AUXENT (s)->x_sym.x_fcnary.x_ary.x_dimen[(i)] = (v))
233 #define SA_SET_FILE_FNAME(s,v) strncpy (SYM_AUXENT (s)->x_file.x_fname, (v), FILNMLEN)
234 #define SA_SET_SCN_SCNLEN(s,v) (SYM_AUXENT (s)->x_scn.x_scnlen = (v))
235 #define SA_SET_SCN_NRELOC(s,v) (SYM_AUXENT (s)->x_scn.x_nreloc = (v))
236 #define SA_SET_SCN_NLINNO(s,v) (SYM_AUXENT (s)->x_scn.x_nlinno = (v))
238 /* Internal use only definitions. SF_ stands for symbol flags.
240 These values can be assigned to sy_symbol.ost_flags field of a symbolS.
242 You'll break i960 if you shift the SYSPROC bits anywhere else. for
243 more on the balname/callname hack, see tc-i960.h. b.out is done
244 differently. */
246 #define SF_I960_MASK 0x000001ff /* Bits 0-8 are used by the i960 port. */
247 #define SF_SYSPROC 0x0000003f /* bits 0-5 are used to store the sysproc number. */
248 #define SF_IS_SYSPROC 0x00000040 /* bit 6 marks symbols that are sysprocs. */
249 #define SF_BALNAME 0x00000080 /* bit 7 marks BALNAME symbols. */
250 #define SF_CALLNAME 0x00000100 /* bit 8 marks CALLNAME symbols. */
252 #define SF_NORMAL_MASK 0x0000ffff /* bits 12-15 are general purpose. */
254 #define SF_STATICS 0x00001000 /* Mark the .text & all symbols. */
255 #define SF_DEFINED 0x00002000 /* Symbol is defined in this file. */
256 #define SF_STRING 0x00004000 /* Symbol name length > 8. */
257 #define SF_LOCAL 0x00008000 /* Symbol must not be emitted. */
259 #define SF_DEBUG_MASK 0xffff0000 /* bits 16-31 are debug info. */
261 #define SF_FUNCTION 0x00010000 /* The symbol is a function. */
262 #define SF_PROCESS 0x00020000 /* Process symbol before write. */
263 #define SF_TAGGED 0x00040000 /* Is associated with a tag. */
264 #define SF_TAG 0x00080000 /* Is a tag. */
265 #define SF_DEBUG 0x00100000 /* Is in debug or abs section. */
266 #define SF_GET_SEGMENT 0x00200000 /* Get the section of the forward symbol. */
267 /* All other bits are unused. */
269 /* Accessors. */
270 #define SF_GET(s) (* symbol_get_obj (s))
271 #define SF_GET_DEBUG(s) (symbol_get_bfdsym (s)->flags & BSF_DEBUGGING)
272 #define SF_SET_DEBUG(s) (symbol_get_bfdsym (s)->flags |= BSF_DEBUGGING)
273 #define SF_GET_NORMAL_FIELD(s) (SF_GET (s) & SF_NORMAL_MASK)
274 #define SF_GET_DEBUG_FIELD(s) (SF_GET (s) & SF_DEBUG_MASK)
275 #define SF_GET_FILE(s) (SF_GET (s) & SF_FILE)
276 #define SF_GET_STATICS(s) (SF_GET (s) & SF_STATICS)
277 #define SF_GET_DEFINED(s) (SF_GET (s) & SF_DEFINED)
278 #define SF_GET_STRING(s) (SF_GET (s) & SF_STRING)
279 #define SF_GET_LOCAL(s) (SF_GET (s) & SF_LOCAL)
280 #define SF_GET_FUNCTION(s) (SF_GET (s) & SF_FUNCTION)
281 #define SF_GET_PROCESS(s) (SF_GET (s) & SF_PROCESS)
282 #define SF_GET_TAGGED(s) (SF_GET (s) & SF_TAGGED)
283 #define SF_GET_TAG(s) (SF_GET (s) & SF_TAG)
284 #define SF_GET_GET_SEGMENT(s) (SF_GET (s) & SF_GET_SEGMENT)
285 #define SF_GET_I960(s) (SF_GET (s) & SF_I960_MASK) /* Used by i960. */
286 #define SF_GET_BALNAME(s) (SF_GET (s) & SF_BALNAME) /* Used by i960. */
287 #define SF_GET_CALLNAME(s) (SF_GET (s) & SF_CALLNAME) /* Used by i960. */
288 #define SF_GET_IS_SYSPROC(s) (SF_GET (s) & SF_IS_SYSPROC) /* Used by i960. */
289 #define SF_GET_SYSPROC(s) (SF_GET (s) & SF_SYSPROC) /* Used by i960. */
291 /* Modifiers. */
292 #define SF_SET(s,v) (SF_GET (s) = (v))
293 #define SF_SET_NORMAL_FIELD(s,v)(SF_GET (s) |= ((v) & SF_NORMAL_MASK))
294 #define SF_SET_DEBUG_FIELD(s,v) (SF_GET (s) |= ((v) & SF_DEBUG_MASK))
295 #define SF_SET_FILE(s) (SF_GET (s) |= SF_FILE)
296 #define SF_SET_STATICS(s) (SF_GET (s) |= SF_STATICS)
297 #define SF_SET_DEFINED(s) (SF_GET (s) |= SF_DEFINED)
298 #define SF_SET_STRING(s) (SF_GET (s) |= SF_STRING)
299 #define SF_SET_LOCAL(s) (SF_GET (s) |= SF_LOCAL)
300 #define SF_CLEAR_LOCAL(s) (SF_GET (s) &= ~SF_LOCAL)
301 #define SF_SET_FUNCTION(s) (SF_GET (s) |= SF_FUNCTION)
302 #define SF_SET_PROCESS(s) (SF_GET (s) |= SF_PROCESS)
303 #define SF_SET_TAGGED(s) (SF_GET (s) |= SF_TAGGED)
304 #define SF_SET_TAG(s) (SF_GET (s) |= SF_TAG)
305 #define SF_SET_GET_SEGMENT(s) (SF_GET (s) |= SF_GET_SEGMENT)
306 #define SF_SET_I960(s,v) (SF_GET (s) |= ((v) & SF_I960_MASK)) /* Used by i960. */
307 #define SF_SET_BALNAME(s) (SF_GET (s) |= SF_BALNAME) /* Used by i960. */
308 #define SF_SET_CALLNAME(s) (SF_GET (s) |= SF_CALLNAME) /* Used by i960. */
309 #define SF_SET_IS_SYSPROC(s) (SF_GET (s) |= SF_IS_SYSPROC) /* Used by i960. */
310 #define SF_SET_SYSPROC(s,v) (SF_GET (s) |= ((v) & SF_SYSPROC)) /* Used by i960. */
313 /* Line number handling. */
314 extern int text_lineno_number;
315 extern int coff_line_base;
316 extern int coff_n_line_nos;
317 extern symbolS *coff_last_function;
319 #define obj_emit_lineno(WHERE, LINE, FILE_START) abort ()
320 #define obj_app_file(name, app) c_dot_file_symbol (name, app)
321 #define obj_frob_symbol(S,P) coff_frob_symbol (S, & P)
322 #define obj_frob_section(S) coff_frob_section (S)
323 #define obj_frob_file_after_relocs() coff_frob_file_after_relocs ()
324 #ifndef obj_adjust_symtab
325 #define obj_adjust_symtab() coff_adjust_symtab ()
326 #endif
328 /* Forward the segment of a forwarded symbol, handle assignments that
329 just copy symbol values, etc. */
330 #ifndef OBJ_COPY_SYMBOL_ATTRIBUTES
331 #ifndef TE_I386AIX
332 #define OBJ_COPY_SYMBOL_ATTRIBUTES(dest, src) \
333 (SF_GET_GET_SEGMENT (dest) \
334 ? (S_SET_SEGMENT (dest, S_GET_SEGMENT (src)), 0) \
335 : 0)
336 #else
337 #define OBJ_COPY_SYMBOL_ATTRIBUTES(dest, src) \
338 (SF_GET_GET_SEGMENT (dest) && S_GET_SEGMENT (dest) == SEG_UNKNOWN \
339 ? (S_SET_SEGMENT (dest, S_GET_SEGMENT (src)), 0) \
340 : 0)
341 #endif
342 #endif
344 /* Sanity check. */
346 #ifdef TC_I960
347 #ifndef C_LEAFSTAT
348 hey ! Where is the C_LEAFSTAT definition ? i960 - coff support is depending on it.
349 #endif /* no C_LEAFSTAT */
350 #endif /* TC_I960 */
352 extern const pseudo_typeS coff_pseudo_table[];
354 #ifndef obj_pop_insert
355 #define obj_pop_insert() pop_insert (coff_pseudo_table)
356 #endif
358 /* In COFF, if a symbol is defined using .def/.val SYM/.endef, it's OK
359 to redefine the symbol later on. This can happen if C symbols use
360 a prefix, and a symbol is defined both with and without the prefix,
361 as in start/_start/__start in gcc/libgcc1-test.c. */
362 #define RESOLVE_SYMBOL_REDEFINITION(sym) \
363 (SF_GET_GET_SEGMENT (sym) \
364 ? (sym->sy_frag = frag_now, \
365 S_SET_VALUE (sym, frag_now_fix ()), \
366 S_SET_SEGMENT (sym, now_seg), \
367 0) \
368 : 0)
370 /* Stabs in a coff file go into their own section. */
371 #define SEPARATE_STAB_SECTIONS 1
373 /* We need 12 bytes at the start of the section to hold some initial
374 information. */
375 #define INIT_STAB_SECTION(seg) obj_coff_init_stab_section (seg)
377 /* Store the number of relocations in the section aux entry. */
378 #define SET_SECTION_RELOCS(sec, relocs, n) \
379 SA_SET_SCN_NRELOC (section_symbol (sec), n)
381 #define obj_app_file(name, app) c_dot_file_symbol (name, app)
383 extern int S_SET_DATA_TYPE (symbolS *, int);
384 extern int S_SET_STORAGE_CLASS (symbolS *, int);
385 extern int S_GET_STORAGE_CLASS (symbolS *);
386 extern void SA_SET_SYM_ENDNDX (symbolS *, symbolS *);
387 extern void coff_add_linesym (symbolS *);
388 extern void c_dot_file_symbol (const char *, int);
389 extern void coff_frob_symbol (symbolS *, int *);
390 extern void coff_adjust_symtab (void);
391 extern void coff_frob_section (segT);
392 extern void coff_adjust_section_syms (bfd *, asection *, void *);
393 extern void coff_frob_file_after_relocs (void);
394 extern void coff_obj_symbol_new_hook (symbolS *);
395 extern void coff_obj_symbol_clone_hook (symbolS *, symbolS *);
396 extern void coff_obj_read_begin_hook (void);
397 #ifdef TE_PE
398 extern void pecoff_obj_set_weak_hook (symbolS *);
399 extern void pecoff_obj_clear_weak_hook (symbolS *);
400 #endif
401 extern void obj_coff_section (int);
402 extern segT obj_coff_add_segment (const char *);
403 extern void obj_coff_section (int);
404 extern void c_dot_file_symbol (const char *, int);
405 extern segT s_get_segment (symbolS *);
406 #ifndef tc_coff_symbol_emit_hook
407 extern void tc_coff_symbol_emit_hook (symbolS *);
408 #endif
409 extern void obj_coff_pe_handle_link_once (void);
410 extern void obj_coff_init_stab_section (segT);
411 extern void c_section_header (struct internal_scnhdr *,
412 char *, long, long, long, long,
413 long, long, long, long);
414 #endif /* OBJ_FORMAT_H */