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