Update my e-mail address.
[binutils-gdb.git] / include / coff / xcoff.h
blobc8ba2e432c174a6abe0a5c68445e354a3a4410d8
1 /* Internal format of XCOFF object file data structures for BFD.
3 Copyright (C) 1995-2017 Free Software Foundation, Inc.
4 Written by Ian Lance Taylor <ian@cygnus.com>, Cygnus Support.
6 This file is part of BFD, the Binary File Descriptor library.
8 This program 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 3 of the License, or
11 (at your option) any later version.
13 This program 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 this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 MA 02110-1301, USA. */
23 #ifndef _INTERNAL_XCOFF_H
24 #define _INTERNAL_XCOFF_H
26 /* XCOFF specific f_flags. */
28 /* File was profiled with fdpr. */
29 #define F_FDPR_PROF 0x0010
31 /* File was reordered with fdpr. */
32 #define F_FDPR_OPTI 0x0020
34 /* File use very large program support. */
35 #define F_DSA 0x0040
37 /* One aux header specifying medium page sizes is non-zero. */
38 #define F_VARPG 0x0100
40 /* Read/write sections are non-executable. */
41 #define F_NONEXEC 0x8000
43 /* Linker */
45 /* Names of "special" sections. */
46 #define _TEXT ".text"
47 #define _DATA ".data"
48 #define _BSS ".bss"
49 #define _PAD ".pad"
50 #define _LOADER ".loader"
51 #define _EXCEPT ".except"
52 #define _TYPCHK ".typchk"
54 /* XCOFF uses special .dwXXX sections with the type STYP_DWARF. */
55 #define STYP_DWARF 0x0010
57 /* High-order 16-bits dwarf subtypes. */
58 #define SSUBTYP_DWINFO 0x10000
59 #define SSUBTYP_DWLINE 0x20000
60 #define SSUBTYP_DWPBNMS 0x30000
61 #define SSUBTYP_DWPBTYP 0x40000
62 #define SSUBTYP_DWARNGE 0x50000
63 #define SSUBTYP_DWABREV 0x60000
64 #define SSUBTYP_DWSTR 0x70000
65 #define SSUBTYP_DWRNGES 0x80000
67 /* XCOFF uses a special .loader section with type STYP_LOADER. */
68 #define STYP_LOADER 0x1000
70 /* Specifies an exception section. A section of this type provides
71 information to identify the reason that a trap or ececptin occured within
72 and executable object program */
73 #define STYP_EXCEPT 0x0100
75 /* Specifies an initialized thread-local data section. */
76 #define STYP_TDATA 0x0400
78 /* Specifies an uninitialized thread-local data section. */
79 #define STYP_TBSS 0x0800
81 /* XCOFF uses a special .debug section with type STYP_DEBUG. */
82 #define STYP_DEBUG 0x2000
84 /* Specifies a type check section. A section of this type contains parameter
85 argument type check strings used by the AIX binder. */
86 #define STYP_TYPCHK 0x4000
88 /* XCOFF handles line number or relocation overflow by creating
89 another section header with STYP_OVRFLO set. */
90 #define STYP_OVRFLO 0x8000
92 #define RS6K_AOUTHDR_OMAGIC 0x0107 /* old: text & data writeable */
93 #define RS6K_AOUTHDR_NMAGIC 0x0108 /* new: text r/o, data r/w */
94 #define RS6K_AOUTHDR_ZMAGIC 0x010B /* paged: text r/o, both page-aligned */
96 /* XCOFF relocation types.
97 The relocations are described in the function
98 xcoff[64]_ppc_relocate_section in coff64-rs6000.c and coff-rs6000.c */
100 #define R_POS (0x00)
101 #define R_NEG (0x01)
102 #define R_REL (0x02)
103 #define R_TOC (0x03)
104 #define R_RTB (0x04)
105 #define R_GL (0x05)
106 #define R_TCL (0x06)
107 #define R_BA (0x08)
108 #define R_BR (0x0a)
109 #define R_RL (0x0c)
110 #define R_RLA (0x0d)
111 #define R_REF (0x0f)
112 #define R_TRL (0x12)
113 #define R_TRLA (0x13)
114 #define R_RRTBI (0x14)
115 #define R_RRTBA (0x15)
116 #define R_CAI (0x16)
117 #define R_CREL (0x17)
118 #define R_RBA (0x18)
119 #define R_RBAC (0x19)
120 #define R_RBR (0x1a)
121 #define R_RBRC (0x1b)
122 #define R_TLS (0x20)
123 #define R_TLS_IE (0x21)
124 #define R_TLS_LD (0x22)
125 #define R_TLS_LE (0x23)
126 #define R_TLSM (0x24)
127 #define R_TLSML (0x25)
128 #define R_TOCU (0x30)
129 #define R_TOCL (0x31)
131 /* Storage class #defines, from /usr/include/storclass.h that are not already
132 defined in internal.h */
134 /* Comment string in .info section */
135 #define C_INFO 110
137 /* Dwarf symbol. */
138 #define C_DWARF 112
140 /* Auxillary Symbol Entries */
142 /* x_smtyp values: */
143 #define SMTYP_ALIGN(x) ((x) >> 3) /* log2 of alignment */
144 #define SMTYP_SMTYP(x) ((x) & 0x7) /* symbol type */
145 /* Symbol type values: */
146 #define XTY_ER 0 /* External reference */
147 #define XTY_SD 1 /* Csect definition */
148 #define XTY_LD 2 /* Label definition */
149 #define XTY_CM 3 /* .BSS */
150 #define XTY_EM 4 /* Error message */
151 #define XTY_US 5 /* "Reserved for internal use" */
153 /* x_smclas values: */
154 #define XMC_PR 0 /* Read-only program code */
155 #define XMC_RO 1 /* Read-only constant */
156 #define XMC_DB 2 /* Read-only debug dictionary table */
157 #define XMC_TC 3 /* Read-write general TOC entry */
158 #define XMC_UA 4 /* Read-write unclassified */
159 #define XMC_RW 5 /* Read-write data */
160 #define XMC_GL 6 /* Read-only global linkage */
161 #define XMC_XO 7 /* Read-only extended operation */
162 #define XMC_SV 8 /* Read-only supervisor call */
163 #define XMC_BS 9 /* Read-write BSS */
164 #define XMC_DS 10 /* Read-write descriptor csect */
165 #define XMC_UC 11 /* Read-write unnamed Fortran common */
166 #define XMC_TI 12 /* Read-only traceback index csect */
167 #define XMC_TB 13 /* Read-only traceback table csect */
168 /* 14 ??? */
169 #define XMC_TC0 15 /* Read-write TOC anchor */
170 #define XMC_TD 16 /* Read-write data in TOC */
171 #define XMC_SV64 17 /* Read-only 64 bit supervisor call */
172 #define XMC_SV3264 18 /* Read-only 32 or 64 bit supervisor call */
173 /* 19 ??? */
174 #define XMC_TL 20 /* Read-write initialized TLS data */
175 #define XMC_TU 21 /* Read-write uninitialized TLS data */
176 #define XMC_TE 22 /* Same as XMC_TC but mapped after it */
178 /* The ldhdr structure. This appears at the start of the .loader
179 section. */
181 struct internal_ldhdr
183 /* The version number:
184 1 : 32 bit
185 2 : 64 bit */
186 unsigned long l_version;
188 /* The number of symbol table entries. */
189 bfd_size_type l_nsyms;
191 /* The number of relocation table entries. */
192 bfd_size_type l_nreloc;
194 /* The length of the import file string table. */
195 bfd_size_type l_istlen;
197 /* The number of import files. */
198 bfd_size_type l_nimpid;
200 /* The offset from the start of the .loader section to the first
201 entry in the import file table. */
202 bfd_size_type l_impoff;
204 /* The length of the string table. */
205 bfd_size_type l_stlen;
207 /* The offset from the start of the .loader section to the first
208 entry in the string table. */
209 bfd_size_type l_stoff;
211 /* The offset to start of the symbol table, only in XCOFF64 */
212 bfd_vma l_symoff;
214 /* The offset to the start of the relocation table, only in XCOFF64 */
215 bfd_vma l_rldoff;
218 /* The ldsym structure. This is used to represent a symbol in the
219 .loader section. */
221 struct internal_ldsym
223 union
225 /* The symbol name if <= SYMNMLEN characters. */
226 char _l_name[SYMNMLEN];
227 struct
229 /* Zero if the symbol name is more than SYMNMLEN characters. */
230 long _l_zeroes;
232 /* The offset in the string table if the symbol name is more
233 than SYMNMLEN characters. */
234 long _l_offset;
236 _l_l;
240 /* The symbol value. */
241 bfd_vma l_value;
243 /* The symbol section number. */
244 short l_scnum;
246 /* The symbol type and flags. */
247 char l_smtype;
249 /* The symbol storage class. */
250 char l_smclas;
252 /* The import file ID. */
253 bfd_size_type l_ifile;
255 /* Offset to the parameter type check string. */
256 bfd_size_type l_parm;
259 /* These flags are for the l_smtype field (the lower three bits are an
260 XTY_* value). */
262 /* Imported symbol. */
263 #define L_IMPORT (0x40)
264 /* Entry point. */
265 #define L_ENTRY (0x20)
266 /* Exported symbol. */
267 #define L_EXPORT (0x10)
268 /* Weak symbol. */
269 #define L_WEAK (0x08)
271 /* The ldrel structure. This is used to represent a reloc in the
272 .loader section. */
274 struct internal_ldrel
276 /* The reloc address. */
277 bfd_vma l_vaddr;
279 /* The symbol table index in the .loader section symbol table. */
280 bfd_size_type l_symndx;
282 /* The relocation type and size. */
283 short l_rtype;
285 /* The section number this relocation applies to. */
286 short l_rsecnm;
289 /* An entry in the XCOFF linker hash table. */
290 struct xcoff_link_hash_entry
292 struct bfd_link_hash_entry root;
294 /* Symbol index in output file. Set to -1 initially. Set to -2 if
295 there is a reloc against this symbol. */
296 long indx;
298 /* If we have created a TOC entry for this symbol, this is the .tc
299 section which holds it. */
300 asection *toc_section;
302 union
304 /* If we have created a TOC entry (the XCOFF_SET_TOC flag is
305 set), this is the offset in toc_section. */
306 bfd_vma toc_offset;
308 /* If the TOC entry comes from an input file, this is set to the
309 symbol index of the C_HIDEXT XMC_TC or XMC_TD symbol. */
310 long toc_indx;
314 /* If this symbol is a function entry point which is called, this
315 field holds a pointer to the function descriptor. If this symbol
316 is a function descriptor, this field holds a pointer to the
317 function entry point. */
318 struct xcoff_link_hash_entry *descriptor;
320 /* The .loader symbol table entry, if there is one. */
321 struct internal_ldsym *ldsym;
323 /* If XCOFF_BUILT_LDSYM is set, this is the .loader symbol table
324 index. If XCOFF_BUILD_LDSYM is clear, and XCOFF_IMPORT is set,
325 this is the l_ifile value. */
326 long ldindx;
328 /* Some linker flags. */
329 unsigned long flags;
331 /* The storage mapping class. */
332 unsigned char smclas;
335 /* Flags for xcoff_link_hash_entry. */
337 /* Symbol is referenced by a regular object. */
338 #define XCOFF_REF_REGULAR 0x00000001
339 /* Symbol is defined by a regular object. */
340 #define XCOFF_DEF_REGULAR 0x00000002
341 /* Symbol is defined by a dynamic object. */
342 #define XCOFF_DEF_DYNAMIC 0x00000004
343 /* Symbol is used in a reloc being copied into the .loader section. */
344 #define XCOFF_LDREL 0x00000008
345 /* Symbol is the entry point. */
346 #define XCOFF_ENTRY 0x00000010
347 /* Symbol is for a function and is the target of a relocation.
348 The relocation may or may not be a branch-type relocation. */
349 #define XCOFF_CALLED 0x00000020
350 /* Symbol needs the TOC entry filled in. */
351 #define XCOFF_SET_TOC 0x00000040
352 /* Symbol is implicitly or explicitly imported. */
353 #define XCOFF_IMPORT 0x00000080
354 /* Symbol is explicitly exported. */
355 #define XCOFF_EXPORT 0x00000100
356 /* Symbol has been processed by xcoff_build_ldsyms. */
357 #define XCOFF_BUILT_LDSYM 0x00000200
358 /* Symbol is mentioned by a section which was not garbage collected. */
359 #define XCOFF_MARK 0x00000400
360 /* Symbol size is recorded in size_list list from hash table. */
361 #define XCOFF_HAS_SIZE 0x00000800
362 /* Symbol is a function descriptor. */
363 #define XCOFF_DESCRIPTOR 0x00001000
364 /* Multiple definitions have been for the symbol. */
365 #define XCOFF_MULTIPLY_DEFINED 0x00002000
366 /* Symbol is the __rtinit symbol. */
367 #define XCOFF_RTINIT 0x00004000
368 /* Symbol is an imported 32 bit syscall. */
369 #define XCOFF_SYSCALL32 0x00008000
370 /* Symbol is an imported 64 bit syscall. */
371 #define XCOFF_SYSCALL64 0x00010000
372 /* Symbol was not explicitly defined by the time it was marked. */
373 #define XCOFF_WAS_UNDEFINED 0x00020000
374 /* We have assigned an output XCOFF entry to this symbol. */
375 #define XCOFF_ALLOCATED 0x00040000
377 /* The XCOFF linker hash table. */
379 #define XCOFF_NUMBER_OF_SPECIAL_SECTIONS 6
380 #define XCOFF_SPECIAL_SECTION_TEXT 0
381 #define XCOFF_SPECIAL_SECTION_ETEXT 1
382 #define XCOFF_SPECIAL_SECTION_DATA 2
383 #define XCOFF_SPECIAL_SECTION_EDATA 3
384 #define XCOFF_SPECIAL_SECTION_END 4
385 #define XCOFF_SPECIAL_SECTION_END2 5
387 /* These flags indicate which of -bexpall and -bexpfull are in effect. */
388 #define XCOFF_EXPALL 1
389 #define XCOFF_EXPFULL 2
391 /* This structure is used to pass information through
392 xcoff_link_hash_traverse. */
394 struct xcoff_loader_info
396 /* Set if a problem occurred. */
397 bfd_boolean failed;
399 /* Output BFD. */
400 bfd *output_bfd;
402 /* Link information structure. */
403 struct bfd_link_info *info;
405 /* A mask of XCOFF_EXPALL and XCOFF_EXPFULL flags. */
406 unsigned int auto_export_flags;
408 /* Number of ldsym structures. */
409 size_t ldsym_count;
411 /* Size of string table. */
412 size_t string_size;
414 /* String table. */
415 char *strings;
417 /* Allocated size of string table. */
418 size_t string_alc;
421 /* In case we're on a 32-bit machine, construct a 64-bit "-1" value
422 from smaller values. Start with zero, widen, *then* decrement. */
423 #define MINUS_ONE (((bfd_vma) 0) - 1)
425 /* __rtinit, from /usr/include/rtinit.h. */
426 struct __rtinit
428 /* Pointer to runtime linker.
429 XXX: Is the parameter really void? */
430 int (*rtl) (void);
432 /* Offset to array of init functions, 0 if none. */
433 int init_offset;
435 /* Offset to array of fini functions, 0 if none. */
436 int fini_offset;
438 /* Size of __RTINIT_DESCRIPTOR. This value should be used instead of
439 sizeof(__RTINIT_DESCRIPTOR). */
440 int __rtinit_descriptor_size;
443 #define RTINIT_DESCRIPTOR_SIZE (12)
445 struct __rtinit_descriptor
447 /* Init/fini function. */
448 int f;
450 /* Offset, relative to the start of the __rtinit symbol, to name of the
451 function. */
453 int name_offset;
455 /* Flags */
456 unsigned char flags;
459 /* Archive */
461 #define XCOFFARMAG "<aiaff>\012"
462 #define XCOFFARMAGBIG "<bigaf>\012"
463 #define SXCOFFARMAG 8
465 /* The size of the ascii archive elements */
466 #define XCOFFARMAG_ELEMENT_SIZE 12
467 #define XCOFFARMAGBIG_ELEMENT_SIZE 20
469 /* This terminates an XCOFF archive member name. */
471 #define XCOFFARFMAG "`\012"
472 #define SXCOFFARFMAG 2
474 /* XCOFF archives start with this (printable) structure. */
476 struct xcoff_ar_file_hdr
478 /* Magic string. */
479 char magic[SXCOFFARMAG];
481 /* Offset of the member table (decimal ASCII string). */
482 char memoff[XCOFFARMAG_ELEMENT_SIZE];
484 /* Offset of the global symbol table (decimal ASCII string). */
485 char symoff[XCOFFARMAG_ELEMENT_SIZE];
487 /* Offset of the first member in the archive (decimal ASCII string). */
488 char firstmemoff[XCOFFARMAG_ELEMENT_SIZE];
490 /* Offset of the last member in the archive (decimal ASCII string). */
491 char lastmemoff[XCOFFARMAG_ELEMENT_SIZE];
493 /* Offset of the first member on the free list (decimal ASCII
494 string). */
495 char freeoff[XCOFFARMAG_ELEMENT_SIZE];
498 #define SIZEOF_AR_FILE_HDR (SXCOFFARMAG + 5 * XCOFFARMAG_ELEMENT_SIZE)
500 /* This is the equivalent data structure for the big archive format. */
502 struct xcoff_ar_file_hdr_big
504 /* Magic string. */
505 char magic[SXCOFFARMAG];
507 /* Offset of the member table (decimal ASCII string). */
508 char memoff[XCOFFARMAGBIG_ELEMENT_SIZE];
510 /* Offset of the global symbol table for 32-bit objects (decimal ASCII
511 string). */
512 char symoff[XCOFFARMAGBIG_ELEMENT_SIZE];
514 /* Offset of the global symbol table for 64-bit objects (decimal ASCII
515 string). */
516 char symoff64[XCOFFARMAGBIG_ELEMENT_SIZE];
518 /* Offset of the first member in the archive (decimal ASCII string). */
519 char firstmemoff[XCOFFARMAGBIG_ELEMENT_SIZE];
521 /* Offset of the last member in the archive (decimal ASCII string). */
522 char lastmemoff[XCOFFARMAGBIG_ELEMENT_SIZE];
524 /* Offset of the first member on the free list (decimal ASCII
525 string). */
526 char freeoff[XCOFFARMAGBIG_ELEMENT_SIZE];
529 #define SIZEOF_AR_FILE_HDR_BIG (SXCOFFARMAG + 6 * XCOFFARMAGBIG_ELEMENT_SIZE)
531 /* Each XCOFF archive member starts with this (printable) structure. */
533 struct xcoff_ar_hdr
535 /* File size not including the header (decimal ASCII string). */
536 char size[XCOFFARMAG_ELEMENT_SIZE];
538 /* File offset of next archive member (decimal ASCII string). */
539 char nextoff[XCOFFARMAG_ELEMENT_SIZE];
541 /* File offset of previous archive member (decimal ASCII string). */
542 char prevoff[XCOFFARMAG_ELEMENT_SIZE];
544 /* File mtime (decimal ASCII string). */
545 char date[12];
547 /* File UID (decimal ASCII string). */
548 char uid[12];
550 /* File GID (decimal ASCII string). */
551 char gid[12];
553 /* File mode (octal ASCII string). */
554 char mode[12];
556 /* Length of file name (decimal ASCII string). */
557 char namlen[4];
559 /* This structure is followed by the file name. The length of the
560 name is given in the namlen field. If the length of the name is
561 odd, the name is followed by a null byte. The name and optional
562 null byte are followed by XCOFFARFMAG, which is not included in
563 namlen. The contents of the archive member follow; the number of
564 bytes is given in the size field. */
567 #define SIZEOF_AR_HDR (3 * XCOFFARMAG_ELEMENT_SIZE + 4 * 12 + 4)
569 /* The equivalent for the big archive format. */
571 struct xcoff_ar_hdr_big
573 /* File size not including the header (decimal ASCII string). */
574 char size[XCOFFARMAGBIG_ELEMENT_SIZE];
576 /* File offset of next archive member (decimal ASCII string). */
577 char nextoff[XCOFFARMAGBIG_ELEMENT_SIZE];
579 /* File offset of previous archive member (decimal ASCII string). */
580 char prevoff[XCOFFARMAGBIG_ELEMENT_SIZE];
582 /* File mtime (decimal ASCII string). */
583 char date[12];
585 /* File UID (decimal ASCII string). */
586 char uid[12];
588 /* File GID (decimal ASCII string). */
589 char gid[12];
591 /* File mode (octal ASCII string). */
592 char mode[12];
594 /* Length of file name (decimal ASCII string). */
595 char namlen[4];
597 /* This structure is followed by the file name. The length of the
598 name is given in the namlen field. If the length of the name is
599 odd, the name is followed by a null byte. The name and optional
600 null byte are followed by XCOFFARFMAG, which is not included in
601 namlen. The contents of the archive member follow; the number of
602 bytes is given in the size field. */
605 #define SIZEOF_AR_HDR_BIG (3 * XCOFFARMAGBIG_ELEMENT_SIZE + 4 * 12 + 4)
607 /* We often have to distinguish between the old and big file format.
608 Make it a bit cleaner. We can use `xcoff_ardata' here because the
609 `hdr' member has the same size and position in both formats.
610 <bigaf> is the default format, return TRUE even when xcoff_ardata is
611 NULL. */
612 #ifndef SMALL_ARCHIVE
613 /* Creates big archives by default */
614 #define xcoff_big_format_p(abfd) \
615 ((NULL != bfd_ardata (abfd) && NULL == xcoff_ardata (abfd)) || \
616 ((NULL != bfd_ardata (abfd)) && \
617 (NULL != xcoff_ardata (abfd)) && \
618 (xcoff_ardata (abfd)->magic[1] == 'b')))
619 #else
620 /* Creates small archives by default. */
621 #define xcoff_big_format_p(abfd) \
622 (((NULL != bfd_ardata (abfd)) && \
623 (NULL != xcoff_ardata (abfd)) && \
624 (xcoff_ardata (abfd)->magic[1] == 'b')))
625 #endif
627 /* We store a copy of the xcoff_ar_file_hdr in the tdata field of the
628 artdata structure. Similar for the big archive. */
629 #define xcoff_ardata(abfd) \
630 ((struct xcoff_ar_file_hdr *) bfd_ardata (abfd)->tdata)
631 #define xcoff_ardata_big(abfd) \
632 ((struct xcoff_ar_file_hdr_big *) bfd_ardata (abfd)->tdata)
634 /* We store a copy of the xcoff_ar_hdr in the arelt_data field of an
635 archive element. Similar for the big archive. */
636 #define arch_eltdata(bfd) ((struct areltdata *) ((bfd)->arelt_data))
637 #define arch_xhdr(bfd) \
638 ((struct xcoff_ar_hdr *) arch_eltdata (bfd)->arch_header)
639 #define arch_xhdr_big(bfd) \
640 ((struct xcoff_ar_hdr_big *) arch_eltdata (bfd)->arch_header)
642 /* True if symbols of class CLASS are external. */
643 #define EXTERN_SYM_P(CLASS) \
644 ((CLASS) == C_EXT || (CLASS) == C_AIX_WEAKEXT)
646 #endif /* _INTERNAL_XCOFF_H */