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