Sync config/ from GCC:
[binutils.git] / include / coff / ti.h
blob7f3ad7e530c23f0f596a5a2e93dc3c5bab496459
1 /* COFF information for TI COFF support. Definitions in this file should be
2 customized in a target-specific file, and then this file included (see
3 tic54x.h for an example).
5 Copyright 2000, 2001, 2002, 2003, 2008 Free Software Foundation, Inc.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
20 #ifndef COFF_TI_H
21 #define COFF_TI_H
23 /* Note "coff/external.h is not used because TI adds extra fields to the structures. */
25 /********************** FILE HEADER **********************/
27 struct external_filehdr
29 char f_magic[2]; /* magic number */
30 char f_nscns[2]; /* number of sections */
31 char f_timdat[4]; /* time & date stamp */
32 char f_symptr[4]; /* file pointer to symtab */
33 char f_nsyms[4]; /* number of symtab entries */
34 char f_opthdr[2]; /* sizeof(optional hdr) */
35 char f_flags[2]; /* flags */
36 char f_target_id[2]; /* magic no. (TI COFF-specific) */
39 /* COFF0 has magic number in f_magic, and omits f_target_id from the file
40 header; for later versions, f_magic is 0xC1 for COFF1 and 0xC2 for COFF2
41 and the target-specific magic number is found in f_target_id */
43 #define TICOFF0MAGIC TI_TARGET_ID
44 #define TICOFF1MAGIC 0x00C1
45 #define TICOFF2MAGIC 0x00C2
46 #define TICOFF_AOUT_MAGIC 0x0108 /* magic number in optional header */
47 #define TICOFF 1 /* customize coffcode.h */
49 /* The target_id field changes depending on the particular CPU target */
50 /* for COFF0, the target id appeared in f_magic, where COFFX magic is now */
51 #ifndef TI_TARGET_ID
52 #error "TI_TARGET_ID needs to be defined for your CPU"
53 #endif
55 /* Which bfd_arch to use... */
56 #ifndef TICOFF_TARGET_ARCH
57 #error "TICOFF_TARGET_ARCH needs to be defined for your CPU"
58 #endif
60 #ifndef TICOFF_TARGET_MACHINE_GET
61 #define TICOFF_TARGET_MACHINE_GET(FLAGS) 0
62 #endif
64 #ifndef TICOFF_TARGET_MACHINE_SET
65 #define TICOFF_TARGET_MACHINE_SET(FLAGSP, MACHINE)
66 #endif
68 /* Default to COFF2 for file output */
69 #ifndef TICOFF_DEFAULT_MAGIC
70 #define TICOFF_DEFAULT_MAGIC TICOFF2MAGIC
71 #endif
73 /* This value is made available in the rare case where a bfd is unavailable */
74 #ifndef OCTETS_PER_BYTE_POWER
75 #error "OCTETS_PER_BYTE_POWER not defined for this CPU"
76 #else
77 #define OCTETS_PER_BYTE (1<<OCTETS_PER_BYTE_POWER)
78 #endif
80 /* default alignment is on a byte (not octet!) boundary */
81 #ifndef COFF_DEFAULT_SECTION_ALIGNMENT_POWER
82 #define COFF_DEFAULT_SECTION_ALIGNMENT_POWER 0
83 #endif
85 /* TI COFF encodes the section alignment in the section header flags */
86 #define COFF_ALIGN_IN_SECTION_HEADER 1
87 #define COFF_ALIGN_IN_S_FLAGS 1
88 /* requires a power-of-two argument */
89 #define COFF_ENCODE_ALIGNMENT(S,X) ((S).s_flags |= (((unsigned)(X)&0xF)<<8))
90 /* result is a power of two */
91 #define COFF_DECODE_ALIGNMENT(X) (((X)>>8)&0xF)
93 #define COFF0_P(ABFD) (bfd_coff_filhsz(ABFD) == FILHSZ_V0)
94 #define COFF2_P(ABFD) (bfd_coff_scnhsz(ABFD) != SCNHSZ_V01)
96 #define COFF0_BADMAG(x) ((x).f_magic != TICOFF0MAGIC)
97 #define COFF1_BADMAG(x) ((x).f_magic != TICOFF1MAGIC || (x).f_target_id != TI_TARGET_ID)
98 #define COFF2_BADMAG(x) ((x).f_magic != TICOFF2MAGIC || (x).f_target_id != TI_TARGET_ID)
100 /* we need to read/write an extra field in the coff file header */
101 #ifndef COFF_ADJUST_FILEHDR_IN_POST
102 #define COFF_ADJUST_FILEHDR_IN_POST(abfd, src, dst) \
103 do \
105 if (!COFF0_P (abfd)) \
106 ((struct internal_filehdr *)(dst))->f_target_id = \
107 H_GET_16 (abfd, ((FILHDR *)(src))->f_target_id); \
109 while (0)
110 #endif
112 #ifndef COFF_ADJUST_FILEHDR_OUT_POST
113 #define COFF_ADJUST_FILEHDR_OUT_POST(abfd, src, dst) \
114 do \
116 if (!COFF0_P (abfd)) \
117 H_PUT_16 (abfd, ((struct internal_filehdr *)(src))->f_target_id, \
118 ((FILHDR *)(dst))->f_target_id); \
120 while (0)
121 #endif
123 #define FILHDR struct external_filehdr
124 #define FILHSZ 22
125 #define FILHSZ_V0 20 /* COFF0 omits target_id field */
127 /* File header flags */
128 #define F_RELFLG (0x0001)
129 #define F_EXEC (0x0002)
130 #define F_LNNO (0x0004)
131 #define F_VERS (0x0010) /* TMS320C4x code */
132 /* F_LSYMS needs to be redefined in your source file */
133 #define F_LSYMS_TICOFF (0x0010) /* normal COFF is 0x8 */
135 #define F_10 0x00 /* file built for TMS320C1x devices */
136 #define F_20 0x10 /* file built for TMS320C2x devices */
137 #define F_25 0x20 /* file built for TMS320C2x/C5x devices */
138 #define F_LENDIAN 0x0100 /* 16 bits/word, LSB first */
139 #define F_SYMMERGE 0x1000 /* duplicate symbols were removed */
141 /********************** OPTIONAL HEADER **********************/
144 typedef struct
146 char magic[2]; /* type of file (0x108) */
147 char vstamp[2]; /* version stamp */
148 char tsize[4]; /* text size in bytes, padded to FW bdry*/
149 char dsize[4]; /* initialized data " " */
150 char bsize[4]; /* uninitialized data " " */
151 char entry[4]; /* entry pt. */
152 char text_start[4]; /* base of text used for this file */
153 char data_start[4]; /* base of data used for this file */
155 AOUTHDR;
158 #define AOUTHDRSZ 28
159 #define AOUTSZ 28
162 /********************** SECTION HEADER **********************/
163 /* COFF0, COFF1 */
164 struct external_scnhdr_v01 {
165 char s_name[8]; /* section name */
166 char s_paddr[4]; /* physical address, aliased s_nlib */
167 char s_vaddr[4]; /* virtual address */
168 char s_size[4]; /* section size (in WORDS) */
169 char s_scnptr[4]; /* file ptr to raw data for section */
170 char s_relptr[4]; /* file ptr to relocation */
171 char s_lnnoptr[4]; /* file ptr to line numbers */
172 char s_nreloc[2]; /* number of relocation entries */
173 char s_nlnno[2]; /* number of line number entries*/
174 char s_flags[2]; /* flags */
175 char s_reserved[1]; /* reserved */
176 char s_page[1]; /* section page number (LOAD) */
179 /* COFF2 */
180 struct external_scnhdr {
181 char s_name[8]; /* section name */
182 char s_paddr[4]; /* physical address, aliased s_nlib */
183 char s_vaddr[4]; /* virtual address */
184 char s_size[4]; /* section size (in WORDS) */
185 char s_scnptr[4]; /* file ptr to raw data for section */
186 char s_relptr[4]; /* file ptr to relocation */
187 char s_lnnoptr[4]; /* file ptr to line numbers */
188 char s_nreloc[4]; /* number of relocation entries */
189 char s_nlnno[4]; /* number of line number entries*/
190 char s_flags[4]; /* flags */
191 char s_reserved[2]; /* reserved */
192 char s_page[2]; /* section page number (LOAD) */
196 * Special section flags
199 /* TI COFF defines these flags;
200 STYP_CLINK: the section should be excluded from the final
201 linker output if there are no references found to any symbol in the section
202 STYP_BLOCK: the section should be blocked, i.e. if the section would cross
203 a page boundary, it is started at a page boundary instead.
204 TI COFF puts the section alignment power of two in the section flags
205 e.g. 2**N is alignment, flags |= (N & 0xF) << 8
207 #define STYP_CLINK (0x4000)
208 #define STYP_BLOCK (0x1000)
209 #define STYP_ALIGN (0x0F00) /* TI COFF stores section alignment here */
211 #define SCNHDR_V01 struct external_scnhdr_v01
212 #define SCNHDR struct external_scnhdr
213 #define SCNHSZ_V01 40 /* for v0 and v1 */
214 #define SCNHSZ 48
216 /* COFF2 changes the offsets and sizes of these fields
217 Assume we're dealing with the COFF2 scnhdr structure, and adjust
218 accordingly. Note: The GNU C versions of some of these macros
219 are necessary in order to avoid compile time warnings triggered
220 gcc's array bounds checking. The PUT_SCNHDR_PAGE macro also has
221 the advantage on not evaluating LOC twice. */
223 #define GET_SCNHDR_NRELOC(ABFD, LOC) \
224 (COFF2_P (ABFD) ? H_GET_32 (ABFD, LOC) : H_GET_16 (ABFD, LOC))
225 #define PUT_SCNHDR_NRELOC(ABFD, VAL, LOC) \
226 (COFF2_P (ABFD) ? H_PUT_32 (ABFD, VAL, LOC) : H_PUT_16 (ABFD, VAL, LOC))
227 #ifdef __GNUC__
228 #define GET_SCNHDR_NLNNO(ABFD, LOC) \
229 ({ \
230 int nlnno; \
231 char * ptr = (LOC); \
232 if (COFF2_P (ABFD)) \
233 nlnno = H_GET_32 (ABFD, ptr); \
234 else \
235 nlnno = H_GET_16 (ABFD, ptr - 2); \
236 nlnno; \
238 #define PUT_SCNHDR_NLNNO(ABFD, VAL, LOC) \
239 do \
241 char * ptr = (LOC); \
242 if (COFF2_P (ABFD)) \
243 H_PUT_32 (ABFD, VAL, ptr); \
244 else \
245 H_PUT_16 (ABFD, VAL, ptr - 2); \
247 while (0)
248 #define GET_SCNHDR_FLAGS(ABFD, LOC) \
249 ({ \
250 int flags; \
251 char * ptr = (LOC); \
252 if (COFF2_P (ABFD)) \
253 flags = H_GET_32 (ABFD, ptr); \
254 else \
255 flags = H_GET_16 (ABFD, ptr - 4); \
256 flags; \
258 #define PUT_SCNHDR_FLAGS(ABFD, VAL, LOC) \
259 do \
261 char * ptr = (LOC); \
262 if (COFF2_P (ABFD)) \
263 H_PUT_32 (ABFD, VAL, ptr); \
264 else \
265 H_PUT_16 (ABFD, VAL, ptr - 4); \
267 while (0)
268 #define GET_SCNHDR_PAGE(ABFD, LOC) \
269 ({ \
270 unsigned page; \
271 char * ptr = (LOC); \
272 if (COFF2_P (ABFD)) \
273 page = H_GET_16 (ABFD, ptr); \
274 else \
275 page = (unsigned) H_GET_8 (ABFD, ptr - 7); \
276 page; \
278 /* On output, make sure that the "reserved" field is zero. */
279 #define PUT_SCNHDR_PAGE(ABFD, VAL, LOC) \
280 do \
282 char * ptr = (LOC); \
283 if (COFF2_P (ABFD)) \
284 H_PUT_16 (ABFD, VAL, ptr); \
285 else \
287 H_PUT_8 (ABFD, VAL, ptr - 7); \
288 H_PUT_8 (ABFD, 0, ptr - 8); \
291 while (0)
292 #else
293 #define GET_SCNHDR_NLNNO(ABFD, LOC) \
294 (COFF2_P (ABFD) ? H_GET_32 (ABFD, LOC) : H_GET_16 (ABFD, (LOC) - 2))
295 #define PUT_SCNHDR_NLNNO(ABFD, VAL, LOC) \
296 (COFF2_P (ABFD) ? H_PUT_32 (ABFD, VAL, LOC) : H_PUT_16 (ABFD, VAL, (LOC) - 2))
297 #define GET_SCNHDR_FLAGS(ABFD, LOC) \
298 (COFF2_P (ABFD) ? H_GET_32 (ABFD, LOC) : H_GET_16 (ABFD, (LOC) - 4))
299 #define PUT_SCNHDR_FLAGS(ABFD, VAL, LOC) \
300 (COFF2_P (ABFD) ? H_PUT_32 (ABFD, VAL, LOC) : H_PUT_16 (ABFD, VAL, (LOC) - 4))
301 #define GET_SCNHDR_PAGE(ABFD, LOC) \
302 (COFF2_P (ABFD) ? H_GET_16 (ABFD, LOC) : (unsigned) H_GET_8 (ABFD, (LOC) - 7))
303 /* On output, make sure that the "reserved" field is zero. */
304 #define PUT_SCNHDR_PAGE(ABFD, VAL, LOC) \
305 (COFF2_P (ABFD) \
306 ? H_PUT_16 (ABFD, VAL, LOC) \
307 : H_PUT_8 (ABFD, VAL, (LOC) - 7), H_PUT_8 (ABFD, 0, (LOC) - 8))
308 #endif
311 /* TI COFF stores section size as number of bytes (address units, not octets),
312 so adjust to be number of octets, which is what BFD expects */
313 #define GET_SCNHDR_SIZE(ABFD, SZP) \
314 (H_GET_32 (ABFD, SZP) * bfd_octets_per_byte (ABFD))
315 #define PUT_SCNHDR_SIZE(ABFD, SZ, SZP) \
316 H_PUT_32 (ABFD, (SZ) / bfd_octets_per_byte (ABFD), SZP)
318 #define COFF_ADJUST_SCNHDR_IN_POST(ABFD, EXT, INT) \
319 do \
321 ((struct internal_scnhdr *)(INT))->s_page = \
322 GET_SCNHDR_PAGE (ABFD, ((SCNHDR *)(EXT))->s_page); \
324 while (0)
326 /* The entire scnhdr may not be assigned.
327 Ensure that everything is initialized. */
328 #define COFF_ADJUST_SCNHDR_OUT_PRE(ABFD, INT, EXT) \
329 do \
331 memset((EXT), 0, sizeof (SCNHDR)); \
333 while (0)
335 /* The line number and reloc overflow checking in coff_swap_scnhdr_out in
336 coffswap.h doesn't use PUT_X for s_nlnno and s_nreloc.
337 Due to different sized v0/v1/v2 section headers, we have to re-write these
338 fields.
340 #define COFF_ADJUST_SCNHDR_OUT_POST(ABFD, INT, EXT) \
341 do \
343 PUT_SCNHDR_NLNNO (ABFD, ((struct internal_scnhdr *)(INT))->s_nlnno, \
344 ((SCNHDR *)(EXT))->s_nlnno); \
345 PUT_SCNHDR_NRELOC (ABFD, ((struct internal_scnhdr *)(INT))->s_nreloc,\
346 ((SCNHDR *)(EXT))->s_nreloc); \
347 PUT_SCNHDR_FLAGS (ABFD, ((struct internal_scnhdr *)(INT))->s_flags, \
348 ((SCNHDR *)(EXT))->s_flags); \
349 PUT_SCNHDR_PAGE (ABFD, ((struct internal_scnhdr *)(INT))->s_page, \
350 ((SCNHDR *)(EXT))->s_page); \
352 while (0)
355 * names of "special" sections
357 #define _TEXT ".text"
358 #define _DATA ".data"
359 #define _BSS ".bss"
360 #define _CINIT ".cinit" /* initialized C data */
361 #define _SCONST ".const" /* constants */
362 #define _SWITCH ".switch" /* switch tables */
363 #define _STACK ".stack" /* C stack */
364 #define _SYSMEM ".sysmem" /* used for malloc et al. syscalls */
366 /********************** LINE NUMBERS **********************/
368 /* 1 line number entry for every "breakpointable" source line in a section.
369 * Line numbers are grouped on a per function basis; first entry in a function
370 * grouping will have l_lnno = 0 and in place of physical address will be the
371 * symbol table index of the function name.
373 struct external_lineno {
374 union {
375 char l_symndx[4]; /* function name symbol index, iff l_lnno == 0*/
376 char l_paddr[4]; /* (physical) address of line number */
377 } l_addr;
378 char l_lnno[2]; /* line number */
381 #define LINENO struct external_lineno
382 #define LINESZ 6
385 /********************** SYMBOLS **********************/
387 /* NOTE: this is what a local label looks like in assembly source; what it
388 looks like in COFF output is undefined */
389 #define TICOFF_LOCAL_LABEL_P(NAME) \
390 ((NAME[0] == '$' && NAME[1] >= '0' && NAME[1] <= '9' && NAME[2] == '\0') \
391 || NAME[strlen(NAME)-1] == '?')
393 #define E_SYMNMLEN 8 /* # characters in a symbol name */
394 #define E_FILNMLEN 14 /* # characters in a file name */
395 #define E_DIMNUM 4 /* # array dimensions in auxiliary entry */
397 struct external_syment
399 union {
400 char e_name[E_SYMNMLEN];
401 struct {
402 char e_zeroes[4];
403 char e_offset[4];
404 } e;
405 } e;
406 char e_value[4];
407 char e_scnum[2];
408 char e_type[2];
409 char e_sclass[1];
410 char e_numaux[1];
414 #define N_BTMASK (017)
415 #define N_TMASK (060)
416 #define N_BTSHFT (4)
417 #define N_TSHIFT (2)
420 union external_auxent {
421 struct {
422 char x_tagndx[4]; /* str, un, or enum tag indx */
423 union {
424 struct {
425 char x_lnno[2]; /* declaration line number */
426 char x_size[2]; /* str/union/array size */
427 } x_lnsz;
428 char x_fsize[4]; /* size of function */
429 } x_misc;
430 union {
431 struct { /* if ISFCN, tag, or .bb */
432 char x_lnnoptr[4]; /* ptr to fcn line # */
433 char x_endndx[4]; /* entry ndx past block end */
434 } x_fcn;
435 struct { /* if ISARY, up to 4 dimen. */
436 char x_dimen[E_DIMNUM][2];
437 } x_ary;
438 } x_fcnary;
439 char x_tvndx[2]; /* tv index */
440 } x_sym;
442 union {
443 char x_fname[E_FILNMLEN];
444 struct {
445 char x_zeroes[4];
446 char x_offset[4];
447 } x_n;
448 } x_file;
450 struct {
451 char x_scnlen[4]; /* section length */
452 char x_nreloc[2]; /* # relocation entries */
453 char x_nlinno[2]; /* # line numbers */
454 } x_scn;
456 struct {
457 char x_tvfill[4]; /* tv fill value */
458 char x_tvlen[2]; /* length of .tv */
459 char x_tvran[2][2]; /* tv range */
460 } x_tv; /* info about .tv section (in auxent of symbol .tv)) */
465 #define SYMENT struct external_syment
466 #define SYMESZ 18
467 #define AUXENT union external_auxent
468 #define AUXESZ 18
470 /* section lengths are in target bytes (not host bytes) */
471 #define GET_SCN_SCNLEN(ABFD, EXT) \
472 (H_GET_32 (ABFD, (EXT)->x_scn.x_scnlen) * bfd_octets_per_byte (ABFD))
473 #define PUT_SCN_SCNLEN(ABFD, INT, EXT) \
474 H_PUT_32 (ABFD, (INT) / bfd_octets_per_byte (ABFD), (EXT)->x_scn.x_scnlen)
476 /* lnsz size is in bits in COFF file, in bytes in BFD */
477 #define GET_LNSZ_SIZE(abfd, ext) \
478 (H_GET_16 (abfd, ext->x_sym.x_misc.x_lnsz.x_size) / (class != C_FIELD ? 8 : 1))
480 #define PUT_LNSZ_SIZE(abfd, in, ext) \
481 H_PUT_16 (abfd, ((class != C_FIELD) ? (in) * 8 : (in)), \
482 ext->x_sym.x_misc.x_lnsz.x_size)
484 /* TI COFF stores offsets for MOS and MOU in bits; BFD expects bytes
485 Also put the load page flag of the section into the symbol value if it's an
486 address. */
487 #ifndef NEEDS_PAGE
488 #define NEEDS_PAGE(X) 0
489 #define PAGE_MASK 0
490 #endif
491 #define COFF_ADJUST_SYM_IN_POST(ABFD, EXT, INT) \
492 do \
494 struct internal_syment *dst = (struct internal_syment *)(INT); \
495 if (dst->n_sclass == C_MOS || dst->n_sclass == C_MOU) \
496 dst->n_value /= 8; \
497 else if (NEEDS_PAGE (dst->n_sclass)) { \
498 asection *scn = coff_section_from_bfd_index (abfd, dst->n_scnum); \
499 dst->n_value |= (scn->lma & PAGE_MASK); \
502 while (0)
504 #define COFF_ADJUST_SYM_OUT_POST(ABFD, INT, EXT) \
505 do \
507 struct internal_syment *src = (struct internal_syment *)(INT); \
508 SYMENT *dst = (SYMENT *)(EXT); \
509 if (src->n_sclass == C_MOU || src->n_sclass == C_MOS) \
510 H_PUT_32 (abfd, src->n_value * 8, dst->e_value); \
511 else if (NEEDS_PAGE (src->n_sclass)) { \
512 H_PUT_32 (abfd, src->n_value &= ~PAGE_MASK, dst->e_value); \
515 while (0)
517 /* Detect section-relative absolute symbols so they get flagged with a sym
518 index of -1.
520 #define SECTION_RELATIVE_ABSOLUTE_SYMBOL_P(RELOC, SECT) \
521 ((*(RELOC)->sym_ptr_ptr)->section->output_section == (SECT) \
522 && (RELOC)->howto->name[0] == 'A')
524 /********************** RELOCATION DIRECTIVES **********************/
526 struct external_reloc_v0
528 char r_vaddr[4];
529 char r_symndx[2];
530 char r_reserved[2];
531 char r_type[2];
534 struct external_reloc
536 char r_vaddr[4];
537 char r_symndx[4];
538 char r_reserved[2]; /* extended pmad byte for COFF2 */
539 char r_type[2];
542 #define RELOC struct external_reloc
543 #define RELSZ_V0 10 /* FIXME -- coffcode.h needs fixing */
544 #define RELSZ 12 /* for COFF1/2 */
546 /* various relocation types. */
547 #define R_ABS 0x0000 /* no relocation */
548 #define R_REL13 0x002A /* 13-bit direct reference (???) */
549 #define R_PARTLS7 0x0028 /* 7 LSBs of an address */
550 #define R_PARTMS9 0x0029 /* 9MSBs of an address */
551 #define R_EXTWORD 0x002B /* 23-bit direct reference */
552 #define R_EXTWORD16 0x002C /* 16-bit direct reference to 23-bit addr*/
553 #define R_EXTWORDMS7 0x002D /* upper 7 bits of 23-bit address */
555 #endif /* COFF_TI_H */