1/* BFD XCOFF object file private structure.
2   Copyright 2001, 2002, 2005 Free Software Foundation, Inc.
3   Written by Tom Rix, Redhat.
4
5   This file is part of BFD, the Binary File Descriptor library.
6
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.
11
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.
16
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
21#ifndef LIBXCOFF_H
22#define LIBXCOFF_H
23
24/* This is the backend information kept for XCOFF files.  This
25   structure is constant for a particular backend.  The first element
26   is the COFF backend data structure, so that XCOFF targets can use
27   the generic COFF code.  */
28
29struct xcoff_backend_data_rec
30{
31  /* COFF backend information.  */
32  bfd_coff_backend_data coff;
33
34  /* Magic number.  */
35  unsigned short _xcoff_magic_number;
36
37  /* Architecture and machine for coff_set_arch_mach_hook.  */
38  enum bfd_architecture _xcoff_architecture;
39  long _xcoff_machine;
40
41  /* Function pointers to xcoff specific swap routines.  */
42  void (* _xcoff_swap_ldhdr_in) (bfd *, const void *, struct internal_ldhdr *);
43  void (* _xcoff_swap_ldhdr_out)(bfd *, const struct internal_ldhdr *, void *);
44  void (* _xcoff_swap_ldsym_in) (bfd *, const void *, struct internal_ldsym *);
45  void (* _xcoff_swap_ldsym_out)(bfd *, const struct internal_ldsym *, void *);
46  void (* _xcoff_swap_ldrel_in) (bfd *, const void *, struct internal_ldrel *);
47  void (* _xcoff_swap_ldrel_out)(bfd *, const struct internal_ldrel *, void *);
48
49  /* Size of the external struct.  */
50  unsigned int _xcoff_ldhdrsz;
51  unsigned int _xcoff_ldsymsz;
52  unsigned int _xcoff_ldrelsz;
53
54  /* Size an entry in a descriptor section.  */
55  unsigned int _xcoff_function_descriptor_size;
56
57  /* Size of the small aout file header.  */
58  unsigned int _xcoff_small_aout_header_size;
59
60  /* Loader version
61     1 : XCOFF32
62     2 : XCOFF64.  */
63  unsigned long _xcoff_ldhdr_version;
64
65  bfd_boolean (* _xcoff_put_symbol_name)
66    (bfd *, struct bfd_strtab_hash *, struct internal_syment *,
67     const char *);
68
69  bfd_boolean (* _xcoff_put_ldsymbol_name)
70    (bfd *, struct xcoff_loader_info *, struct internal_ldsym *,
71     const char *);
72
73  reloc_howto_type *_xcoff_dynamic_reloc;
74
75  asection * (* _xcoff_create_csect_from_smclas)
76    (bfd *, union internal_auxent *, const char *);
77
78  /* Line number and relocation overflow.
79     XCOFF32 overflows to another section when the line number or the
80     relocation count exceeds 0xffff.  XCOFF64 does not overflow.  */
81  bfd_boolean (*_xcoff_is_lineno_count_overflow) (bfd *, bfd_vma);
82  bfd_boolean (*_xcoff_is_reloc_count_overflow)  (bfd *, bfd_vma);
83
84  /* Loader section symbol and relocation table offset
85     XCOFF32 is after the .loader header
86     XCOFF64 is offset in .loader header.  */
87  bfd_vma (*_xcoff_loader_symbol_offset) (bfd *, struct internal_ldhdr *);
88  bfd_vma (*_xcoff_loader_reloc_offset)  (bfd *, struct internal_ldhdr *);
89
90  /* Global linkage.  The first word of global linkage code must be be
91     modified by filling in the correct TOC offset.  */
92  unsigned long *_xcoff_glink_code;
93
94  /* Size of the global link code in bytes of the xcoff_glink_code table.  */
95  unsigned long _xcoff_glink_size;
96
97  /* rtinit.  */
98  unsigned int _xcoff_rtinit_size;
99  bfd_boolean (*_xcoff_generate_rtinit)
100    (bfd *, const char *, const char *, bfd_boolean);
101};
102
103/* Look up an entry in an XCOFF link hash table.  */
104#define xcoff_link_hash_lookup(table, string, create, copy, follow) \
105  ((struct xcoff_link_hash_entry *) \
106   bfd_link_hash_lookup (&(table)->root, (string), (create), (copy),\
107			 (follow)))
108
109/* Traverse an XCOFF link hash table.  */
110#define xcoff_link_hash_traverse(table, func, info)			\
111  (bfd_link_hash_traverse						\
112   (&(table)->root,							\
113    (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (func),	\
114    (info)))
115
116/* Get the XCOFF link hash table from the info structure.  This is
117   just a cast.  */
118#define xcoff_hash_table(p) ((struct xcoff_link_hash_table *) ((p)->hash))
119
120
121#define xcoff_backend(abfd) \
122  ((struct xcoff_backend_data_rec *) (abfd)->xvec->backend_data)
123
124#define bfd_xcoff_magic_number(a) ((xcoff_backend (a)->_xcoff_magic_number))
125#define bfd_xcoff_architecture(a) ((xcoff_backend (a)->_xcoff_architecture))
126#define bfd_xcoff_machine(a)      ((xcoff_backend (a)->_xcoff_machine))
127
128#define bfd_xcoff_swap_ldhdr_in(a, b, c) \
129  ((xcoff_backend (a)->_xcoff_swap_ldhdr_in) ((a), (b), (c)))
130
131#define bfd_xcoff_swap_ldhdr_out(a, b, c) \
132  ((xcoff_backend (a)->_xcoff_swap_ldhdr_out) ((a), (b), (c)))
133
134#define bfd_xcoff_swap_ldsym_in(a, b, c) \
135  ((xcoff_backend (a)->_xcoff_swap_ldsym_in) ((a), (b), (c)))
136
137#define bfd_xcoff_swap_ldsym_out(a, b, c) \
138  ((xcoff_backend (a)->_xcoff_swap_ldsym_out) ((a), (b), (c)))
139
140#define bfd_xcoff_swap_ldrel_in(a, b, c) \
141  ((xcoff_backend (a)->_xcoff_swap_ldrel_in) ((a), (b), (c)))
142
143#define bfd_xcoff_swap_ldrel_out(a, b, c) \
144  ((xcoff_backend (a)->_xcoff_swap_ldrel_out) ((a), (b), (c)))
145
146#define bfd_xcoff_ldhdrsz(a) ((xcoff_backend (a)->_xcoff_ldhdrsz))
147#define bfd_xcoff_ldsymsz(a) ((xcoff_backend (a)->_xcoff_ldsymsz))
148#define bfd_xcoff_ldrelsz(a) ((xcoff_backend (a)->_xcoff_ldrelsz))
149#define bfd_xcoff_function_descriptor_size(a) \
150  ((xcoff_backend (a)->_xcoff_function_descriptor_size))
151#define bfd_xcoff_small_aout_header_size(a) \
152  ((xcoff_backend (a)->_xcoff_small_aout_header_size))
153
154#define bfd_xcoff_ldhdr_version(a) ((xcoff_backend (a)->_xcoff_ldhdr_version))
155
156#define bfd_xcoff_put_symbol_name(a, b, c, d) \
157  ((xcoff_backend (a)->_xcoff_put_symbol_name) ((a), (b), (c), (d)))
158
159#define bfd_xcoff_put_ldsymbol_name(a, b, c, d) \
160  ((xcoff_backend (a)->_xcoff_put_ldsymbol_name) ((a), (b), (c), (d)))
161
162/* Get the XCOFF hash table entries for a BFD.  */
163#define obj_xcoff_sym_hashes(bfd) \
164  ((struct xcoff_link_hash_entry **) obj_coff_sym_hashes (bfd))
165
166#define bfd_xcoff_dynamic_reloc_howto(a) \
167   ((xcoff_backend (a)->_xcoff_dynamic_reloc))
168
169#define bfd_xcoff_create_csect_from_smclas(a, b, c) \
170   ((xcoff_backend (a)->_xcoff_create_csect_from_smclas((a), (b), (c))))
171
172#define bfd_xcoff_is_lineno_count_overflow(a, b) \
173   ((xcoff_backend (a)->_xcoff_is_lineno_count_overflow((a), (b))))
174
175#define bfd_xcoff_is_reloc_count_overflow(a, b) \
176   ((xcoff_backend (a)->_xcoff_is_reloc_count_overflow((a), (b))))
177
178#define bfd_xcoff_loader_symbol_offset(a, b) \
179 ((xcoff_backend (a)->_xcoff_loader_symbol_offset((a), (b))))
180
181#define bfd_xcoff_loader_reloc_offset(a, b) \
182 ((xcoff_backend (a)->_xcoff_loader_reloc_offset((a), (b))))
183
184#define bfd_xcoff_glink_code(a, b)   ((xcoff_backend (a)->_xcoff_glink_code[(b)]))
185#define bfd_xcoff_glink_code_size(a) ((xcoff_backend (a)->_xcoff_glink_size))
186
187/* Check for the magic number U803XTOCMAGIC or U64_TOCMAGIC for 64 bit
188   targets.  */
189#define bfd_xcoff_is_xcoff64(a) \
190  (   (0x01EF == (bfd_xcoff_magic_number (a))) \
191   || (0x01F7 == (bfd_xcoff_magic_number (a))))
192
193/* Check for the magic number U802TOMAGIC for 32 bit targets.  */
194#define bfd_xcoff_is_xcoff32(a) (0x01DF == (bfd_xcoff_magic_number (a)))
195
196#define bfd_xcoff_rtinit_size(a)              ((xcoff_backend (a)->_xcoff_rtinit_size))
197#define bfd_xcoff_generate_rtinit(a, b, c, d) ((xcoff_backend (a)->_xcoff_generate_rtinit ((a), (b), (c), (d))))
198
199/* Accessor macros for tdata.  */
200#define bfd_xcoff_text_align_power(a) ((xcoff_data (a)->text_align_power))
201#define bfd_xcoff_data_align_power(a) ((xcoff_data (a)->data_align_power))
202
203/* xcoff*_ppc_relocate_section macros  */
204#define XCOFF_MAX_CALCULATE_RELOCATION (0x1c)
205#define XCOFF_MAX_COMPLAIN_OVERFLOW (4)
206/* N_ONES produces N one bits, without overflowing machine arithmetic.  */
207#ifdef N_ONES
208#undef N_ONES
209#endif
210#define N_ONES(n) (((((bfd_vma) 1 << ((n) - 1)) - 1) << 1) | 1)
211
212#define XCOFF_RELOC_FUNCTION_ARGS \
213  bfd *, asection *, bfd *, struct internal_reloc *, \
214  struct internal_syment *, struct reloc_howto_struct *, bfd_vma, bfd_vma, \
215  bfd_vma *relocation, bfd_byte *contents
216
217#define XCOFF_COMPLAIN_FUNCTION_ARGS \
218  bfd *, bfd_vma, bfd_vma, struct reloc_howto_struct *howto
219
220extern bfd_boolean (*xcoff_calculate_relocation[XCOFF_MAX_CALCULATE_RELOCATION])
221  (XCOFF_RELOC_FUNCTION_ARGS);
222extern bfd_boolean (*xcoff_complain_overflow[XCOFF_MAX_COMPLAIN_OVERFLOW])
223  (XCOFF_COMPLAIN_FUNCTION_ARGS);
224
225/* Relocation functions */
226bfd_boolean xcoff_reloc_type_noop (XCOFF_RELOC_FUNCTION_ARGS);
227bfd_boolean xcoff_reloc_type_fail (XCOFF_RELOC_FUNCTION_ARGS);
228bfd_boolean xcoff_reloc_type_pos  (XCOFF_RELOC_FUNCTION_ARGS);
229bfd_boolean xcoff_reloc_type_neg  (XCOFF_RELOC_FUNCTION_ARGS);
230bfd_boolean xcoff_reloc_type_rel  (XCOFF_RELOC_FUNCTION_ARGS);
231bfd_boolean xcoff_reloc_type_toc  (XCOFF_RELOC_FUNCTION_ARGS);
232bfd_boolean xcoff_reloc_type_ba   (XCOFF_RELOC_FUNCTION_ARGS);
233bfd_boolean xcoff_reloc_type_crel (XCOFF_RELOC_FUNCTION_ARGS);
234
235#endif /* LIBXCOFF_H */
236