]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gas/config/obj-coff.h
Update year range in copyright notice of binutils files
[thirdparty/binutils-gdb.git] / gas / config / obj-coff.h
CommitLineData
252b5132 1/* coff object file format
a2c58332 2 Copyright (C) 1989-2022 Free Software Foundation, Inc.
252b5132
RH
3
4 This file is part of GAS.
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
ec2655a6 8 the Free Software Foundation; either version 3, or (at your option)
252b5132
RH
9 any later version.
10
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.
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
4b4da160
NC
18 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
19 02110-1301, USA. */
252b5132
RH
20
21#ifndef OBJ_FORMAT_H
22#define OBJ_FORMAT_H
23
24#define OBJ_COFF 1
25
252b5132
RH
26#include "targ-cpu.h"
27
252b5132 28/* This internal_lineno crap is to stop namespace pollution from the
dcd619be 29 bfd internal coff headerfile. */
252b5132
RH
30#define internal_lineno bfd_internal_lineno
31#include "coff/internal.h"
32#undef internal_lineno
33
34/* CPU-specific setup: */
35
36#ifdef TC_ARM
37#include "coff/arm.h"
38#ifndef TARGET_FORMAT
39#define TARGET_FORMAT "coff-arm"
40#endif
41#endif
42
43#ifdef TC_PPC
252b5132
RH
44#include "coff/rs6000.h"
45#endif
252b5132 46
252b5132 47#ifdef TC_I386
321098a5 48#ifdef TE_PEP
99ad8390
NC
49#include "coff/x86_64.h"
50#else
252b5132 51#include "coff/i386.h"
99ad8390 52#endif
252b5132 53
252b5132 54#ifndef TARGET_FORMAT
99ad8390
NC
55#ifdef TE_PEP
56#define TARGET_FORMAT "coff-x86-64"
57#else
252b5132
RH
58#define TARGET_FORMAT "coff-i386"
59#endif
60#endif
99ad8390 61#endif
252b5132 62
3c9b82ba
NC
63#ifdef TC_Z80
64#include "coff/z80.h"
65#define TARGET_FORMAT "coff-z80"
66#endif
67
252b5132
RH
68#ifdef TC_Z8K
69#include "coff/z8k.h"
70#define TARGET_FORMAT "coff-z8k"
71#endif
72
252b5132 73#ifdef TC_SH
056350c6
NC
74
75#ifdef TE_PE
76#define COFF_WITH_PE
77#endif
78
252b5132 79#include "coff/sh.h"
056350c6
NC
80
81#ifdef TE_PE
82#define TARGET_FORMAT "pe-shl"
83#else
94f592af 84
252b5132 85#define TARGET_FORMAT \
a245a9aa 86 (!target_big_endian \
252b5132
RH
87 ? (sh_small ? "coff-shl-small" : "coff-shl") \
88 : (sh_small ? "coff-sh-small" : "coff-sh"))
94f592af 89
252b5132 90#endif
056350c6
NC
91#endif
92
252b5132
RH
93#ifdef TC_TIC30
94#include "coff/tic30.h"
95#define TARGET_FORMAT "coff-tic30"
96#endif
97
026df7c5
NC
98#ifdef TC_TIC4X
99#include "coff/tic4x.h"
be33c5dd 100#define TARGET_FORMAT "coff2-tic4x"
026df7c5
NC
101#endif
102
39bec121
TW
103#ifdef TC_TIC54X
104#include "coff/tic54x.h"
105#define TARGET_FORMAT "coff1-c54x"
106#endif
107
252b5132
RH
108#ifdef TC_MCORE
109#include "coff/mcore.h"
110#ifndef TARGET_FORMAT
111#define TARGET_FORMAT "pe-mcore"
112#endif
113#endif
114
977cdf5a 115#ifdef TE_PE
06e77878
AO
116#define obj_set_weak_hook pecoff_obj_set_weak_hook
117#define obj_clear_weak_hook pecoff_obj_clear_weak_hook
977cdf5a
NC
118#endif
119
252b5132
RH
120#ifndef OBJ_COFF_MAX_AUXENTRIES
121#define OBJ_COFF_MAX_AUXENTRIES 1
977cdf5a 122#endif
252b5132 123
252b5132 124#define obj_symbol_new_hook coff_obj_symbol_new_hook
6a2b6326 125#define obj_symbol_clone_hook coff_obj_symbol_clone_hook
252b5132
RH
126#define obj_read_begin_hook coff_obj_read_begin_hook
127
252b5132
RH
128#include "bfd/libcoff.h"
129
130#define OUTPUT_FLAVOR bfd_target_coff_flavour
131
252b5132
RH
132/* Alter the field names, for now, until we've fixed up the other
133 references to use the new name. */
252b5132 134#define OBJ_SYMFIELD_TYPE unsigned long
0a4734dc 135#define sy_obj sy_obj_flags
252b5132 136
a161fe53
AM
137/* We can't use the predefined section symbols in bfd/section.c, as
138 COFF symbols have extra fields. See bfd/libcoff.h:coff_symbol_type. */
139#ifndef obj_sec_sym_ok_for_reloc
140#define obj_sec_sym_ok_for_reloc(SEC) ((SEC)->owner != 0)
141#endif
142
49309057
ILT
143#define SYM_AUXENT(S) \
144 (&coffsymbol (symbol_get_bfdsym (S))->native[1].u.auxent)
145#define SYM_AUXINFO(S) \
146 (&coffsymbol (symbol_get_bfdsym (S))->native[1])
252b5132 147
3b16e843 148/* The number of auxiliary entries. */
49309057
ILT
149#define S_GET_NUMBER_AUXILIARY(s) \
150 (coffsymbol (symbol_get_bfdsym (s))->native->u.syment.n_numaux)
3b16e843 151/* The number of auxiliary entries. */
a5324a3e 152#define S_SET_NUMBER_AUXILIARY(s, v) (S_GET_NUMBER_AUXILIARY (s) = (v))
252b5132 153
dcd619be 154/* True if a symbol name is in the string table, i.e. its length is > 8. */
a5324a3e 155#define S_IS_STRING(s) (strlen (S_GET_NAME (s)) > 8 ? 1 : 0)
252b5132 156
3b16e843
NC
157/* Auxiliary entry macros. SA_ stands for symbol auxiliary. */
158/* Omit the tv related fields. */
159/* Accessors. */
252b5132
RH
160
161#define SA_GET_SYM_TAGNDX(s) (SYM_AUXENT (s)->x_sym.x_tagndx.l)
162#define SA_GET_SYM_LNNO(s) (SYM_AUXENT (s)->x_sym.x_misc.x_lnsz.x_lnno)
163#define SA_GET_SYM_SIZE(s) (SYM_AUXENT (s)->x_sym.x_misc.x_lnsz.x_size)
164#define SA_GET_SYM_FSIZE(s) (SYM_AUXENT (s)->x_sym.x_misc.x_fsize)
165#define SA_GET_SYM_LNNOPTR(s) (SYM_AUXENT (s)->x_sym.x_fcnary.x_fcn.x_lnnoptr)
166#define SA_GET_SYM_ENDNDX(s) (SYM_AUXENT (s)->x_sym.x_fcnary.x_fcn.x_endndx)
167#define SA_GET_SYM_DIMEN(s,i) (SYM_AUXENT (s)->x_sym.x_fcnary.x_ary.x_dimen[(i)])
168#define SA_GET_FILE_FNAME(s) (SYM_AUXENT (s)->x_file.x_fname)
169#define SA_GET_SCN_SCNLEN(s) (SYM_AUXENT (s)->x_scn.x_scnlen)
170#define SA_GET_SCN_NRELOC(s) (SYM_AUXENT (s)->x_scn.x_nreloc)
171#define SA_GET_SCN_NLINNO(s) (SYM_AUXENT (s)->x_scn.x_nlinno)
172
a5324a3e
NC
173#define SA_SET_SYM_LNNO(s,v) (SYM_AUXENT (s)->x_sym.x_misc.x_lnsz.x_lnno = (v))
174#define SA_SET_SYM_SIZE(s,v) (SYM_AUXENT (s)->x_sym.x_misc.x_lnsz.x_size = (v))
175#define SA_SET_SYM_FSIZE(s,v) (SYM_AUXENT (s)->x_sym.x_misc.x_fsize = (v))
176#define SA_SET_SYM_LNNOPTR(s,v) (SYM_AUXENT (s)->x_sym.x_fcnary.x_fcn.x_lnnoptr = (v))
177#define SA_SET_SYM_DIMEN(s,i,v) (SYM_AUXENT (s)->x_sym.x_fcnary.x_ary.x_dimen[(i)] = (v))
178#define SA_SET_FILE_FNAME(s,v) strncpy (SYM_AUXENT (s)->x_file.x_fname, (v), FILNMLEN)
179#define SA_SET_SCN_SCNLEN(s,v) (SYM_AUXENT (s)->x_scn.x_scnlen = (v))
180#define SA_SET_SCN_NRELOC(s,v) (SYM_AUXENT (s)->x_scn.x_nreloc = (v))
181#define SA_SET_SCN_NLINNO(s,v) (SYM_AUXENT (s)->x_scn.x_nlinno = (v))
252b5132 182
97834047
CC
183#ifdef OBJ_XCOFF
184#define SA_GET_SECT_SCNLEN(s) (SYM_AUXENT (s)->x_sect.x_scnlen)
185#define SA_GET_SECT_NRELOC(s) (SYM_AUXENT (s)->x_sect.x_nreloc)
186#define SA_SET_SECT_SCNLEN(s,v) (SYM_AUXENT (s)->x_sect.x_scnlen = (v))
187#define SA_SET_SECT_NRELOC(s,v) (SYM_AUXENT (s)->x_sect.x_nreloc = (v))
188#endif
189
3b16e843 190/* Internal use only definitions. SF_ stands for symbol flags.
5d6255fe 191
a8eb42a8 192 These values can be assigned to sy_symbol.ost_flags field of a symbolS. */
3739860c 193
a5324a3e 194#define SF_NORMAL_MASK 0x0000ffff /* bits 12-15 are general purpose. */
3739860c 195
a5324a3e
NC
196#define SF_STATICS 0x00001000 /* Mark the .text & all symbols. */
197#define SF_DEFINED 0x00002000 /* Symbol is defined in this file. */
198#define SF_STRING 0x00004000 /* Symbol name length > 8. */
199#define SF_LOCAL 0x00008000 /* Symbol must not be emitted. */
3739860c 200
a5324a3e 201#define SF_DEBUG_MASK 0xffff0000 /* bits 16-31 are debug info. */
3739860c 202
a5324a3e
NC
203#define SF_FUNCTION 0x00010000 /* The symbol is a function. */
204#define SF_PROCESS 0x00020000 /* Process symbol before write. */
205#define SF_TAGGED 0x00040000 /* Is associated with a tag. */
206#define SF_TAG 0x00080000 /* Is a tag. */
207#define SF_DEBUG 0x00100000 /* Is in debug or abs section. */
208#define SF_GET_SEGMENT 0x00200000 /* Get the section of the forward symbol. */
dcd619be 209/* All other bits are unused. */
252b5132 210
3b16e843 211/* Accessors. */
a5324a3e 212#define SF_GET(s) (* symbol_get_obj (s))
49309057
ILT
213#define SF_GET_DEBUG(s) (symbol_get_bfdsym (s)->flags & BSF_DEBUGGING)
214#define SF_SET_DEBUG(s) (symbol_get_bfdsym (s)->flags |= BSF_DEBUGGING)
252b5132
RH
215#define SF_GET_NORMAL_FIELD(s) (SF_GET (s) & SF_NORMAL_MASK)
216#define SF_GET_DEBUG_FIELD(s) (SF_GET (s) & SF_DEBUG_MASK)
217#define SF_GET_FILE(s) (SF_GET (s) & SF_FILE)
218#define SF_GET_STATICS(s) (SF_GET (s) & SF_STATICS)
219#define SF_GET_DEFINED(s) (SF_GET (s) & SF_DEFINED)
220#define SF_GET_STRING(s) (SF_GET (s) & SF_STRING)
221#define SF_GET_LOCAL(s) (SF_GET (s) & SF_LOCAL)
222#define SF_GET_FUNCTION(s) (SF_GET (s) & SF_FUNCTION)
223#define SF_GET_PROCESS(s) (SF_GET (s) & SF_PROCESS)
224#define SF_GET_TAGGED(s) (SF_GET (s) & SF_TAGGED)
225#define SF_GET_TAG(s) (SF_GET (s) & SF_TAG)
226#define SF_GET_GET_SEGMENT(s) (SF_GET (s) & SF_GET_SEGMENT)
252b5132 227
3b16e843 228/* Modifiers. */
252b5132 229#define SF_SET(s,v) (SF_GET (s) = (v))
a5324a3e 230#define SF_SET_NORMAL_FIELD(s,v)(SF_GET (s) |= ((v) & SF_NORMAL_MASK))
252b5132
RH
231#define SF_SET_DEBUG_FIELD(s,v) (SF_GET (s) |= ((v) & SF_DEBUG_MASK))
232#define SF_SET_FILE(s) (SF_GET (s) |= SF_FILE)
233#define SF_SET_STATICS(s) (SF_GET (s) |= SF_STATICS)
234#define SF_SET_DEFINED(s) (SF_GET (s) |= SF_DEFINED)
235#define SF_SET_STRING(s) (SF_GET (s) |= SF_STRING)
236#define SF_SET_LOCAL(s) (SF_GET (s) |= SF_LOCAL)
237#define SF_CLEAR_LOCAL(s) (SF_GET (s) &= ~SF_LOCAL)
238#define SF_SET_FUNCTION(s) (SF_GET (s) |= SF_FUNCTION)
239#define SF_SET_PROCESS(s) (SF_GET (s) |= SF_PROCESS)
240#define SF_SET_TAGGED(s) (SF_GET (s) |= SF_TAGGED)
241#define SF_SET_TAG(s) (SF_GET (s) |= SF_TAG)
242#define SF_SET_GET_SEGMENT(s) (SF_GET (s) |= SF_GET_SEGMENT)
252b5132 243
a5324a3e
NC
244
245/* Line number handling. */
252b5132
RH
246extern int text_lineno_number;
247extern int coff_line_base;
248extern int coff_n_line_nos;
a5324a3e 249extern symbolS *coff_last_function;
252b5132 250
a5324a3e
NC
251#define obj_emit_lineno(WHERE, LINE, FILE_START) abort ()
252#define obj_app_file(name, app) c_dot_file_symbol (name, app)
253#define obj_frob_symbol(S,P) coff_frob_symbol (S, & P)
254#define obj_frob_section(S) coff_frob_section (S)
255#define obj_frob_file_after_relocs() coff_frob_file_after_relocs ()
252b5132 256#ifndef obj_adjust_symtab
a5324a3e 257#define obj_adjust_symtab() coff_adjust_symtab ()
252b5132 258#endif
252b5132
RH
259
260/* Forward the segment of a forwarded symbol, handle assignments that
261 just copy symbol values, etc. */
2c1c4c62 262#ifndef OBJ_COPY_SYMBOL_ATTRIBUTES
252b5132 263#ifndef TE_I386AIX
a5324a3e 264#define OBJ_COPY_SYMBOL_ATTRIBUTES(dest, src) \
252b5132
RH
265 (SF_GET_GET_SEGMENT (dest) \
266 ? (S_SET_SEGMENT (dest, S_GET_SEGMENT (src)), 0) \
267 : 0)
268#else
a5324a3e 269#define OBJ_COPY_SYMBOL_ATTRIBUTES(dest, src) \
252b5132
RH
270 (SF_GET_GET_SEGMENT (dest) && S_GET_SEGMENT (dest) == SEG_UNKNOWN \
271 ? (S_SET_SEGMENT (dest, S_GET_SEGMENT (src)), 0) \
272 : 0)
273#endif
2c1c4c62 274#endif
252b5132 275
3b16e843 276/* Sanity check. */
252b5132 277
4c63da97
AM
278extern const pseudo_typeS coff_pseudo_table[];
279
280#ifndef obj_pop_insert
281#define obj_pop_insert() pop_insert (coff_pseudo_table)
282#endif
283
252b5132
RH
284/* In COFF, if a symbol is defined using .def/.val SYM/.endef, it's OK
285 to redefine the symbol later on. This can happen if C symbols use
286 a prefix, and a symbol is defined both with and without the prefix,
287 as in start/_start/__start in gcc/libgcc1-test.c. */
288#define RESOLVE_SYMBOL_REDEFINITION(sym) \
289(SF_GET_GET_SEGMENT (sym) \
3c0d9d71 290 ? (sym->frag = frag_now, \
252b5132
RH
291 S_SET_VALUE (sym, frag_now_fix ()), \
292 S_SET_SEGMENT (sym, now_seg), \
293 0) \
294 : 0)
295
296/* Stabs in a coff file go into their own section. */
297#define SEPARATE_STAB_SECTIONS 1
298
299/* We need 12 bytes at the start of the section to hold some initial
300 information. */
252b5132
RH
301#define INIT_STAB_SECTION(seg) obj_coff_init_stab_section (seg)
302
945a1a6b 303/* Store the number of relocations in the section aux entry. */
97834047
CC
304#ifdef OBJ_XCOFF
305#define SET_SECTION_RELOCS(sec, relocs, n) \
306 do { \
307 symbolS * sectSym = section_symbol (sec); \
308 if (S_GET_STORAGE_CLASS (sectSym) == C_DWARF) \
309 SA_SET_SECT_NRELOC (sectSym, n); \
310 else \
311 SA_SET_SCN_NRELOC (sectSym, n); \
312 } while (0)
313#else
945a1a6b
ILT
314#define SET_SECTION_RELOCS(sec, relocs, n) \
315 SA_SET_SCN_NRELOC (section_symbol (sec), n)
97834047 316#endif
945a1a6b 317
a5324a3e
NC
318#define obj_app_file(name, app) c_dot_file_symbol (name, app)
319
a5324a3e
NC
320extern int S_SET_DATA_TYPE (symbolS *, int);
321extern int S_SET_STORAGE_CLASS (symbolS *, int);
322extern int S_GET_STORAGE_CLASS (symbolS *);
323extern void SA_SET_SYM_ENDNDX (symbolS *, symbolS *);
324extern void coff_add_linesym (symbolS *);
325extern void c_dot_file_symbol (const char *, int);
326extern void coff_frob_symbol (symbolS *, int *);
327extern void coff_adjust_symtab (void);
328extern void coff_frob_section (segT);
329extern void coff_adjust_section_syms (bfd *, asection *, void *);
330extern void coff_frob_file_after_relocs (void);
a5324a3e 331extern void coff_obj_symbol_new_hook (symbolS *);
6a2b6326 332extern void coff_obj_symbol_clone_hook (symbolS *, symbolS *);
a5324a3e 333extern void coff_obj_read_begin_hook (void);
06e77878
AO
334#ifdef TE_PE
335extern void pecoff_obj_set_weak_hook (symbolS *);
336extern void pecoff_obj_clear_weak_hook (symbolS *);
337#endif
a5324a3e
NC
338extern void obj_coff_section (int);
339extern segT obj_coff_add_segment (const char *);
340extern void obj_coff_section (int);
341extern void c_dot_file_symbol (const char *, int);
342extern segT s_get_segment (symbolS *);
36bfbdd3 343#ifndef tc_coff_symbol_emit_hook
a5324a3e 344extern void tc_coff_symbol_emit_hook (symbolS *);
36bfbdd3 345#endif
a5324a3e
NC
346extern void obj_coff_pe_handle_link_once (void);
347extern void obj_coff_init_stab_section (segT);
348extern void c_section_header (struct internal_scnhdr *,
349 char *, long, long, long, long,
350 long, long, long, long);
f3d2b04b
KT
351extern void obj_coff_seh_do_final (void);
352
353#ifndef obj_coff_generate_pdata
354#define obj_coff_generate_pdata obj_coff_seh_do_final
355#endif
356
357
252b5132 358#endif /* OBJ_FORMAT_H */