1
/* `a.out' object-file definitions, including extensions to 64-bit fields
3
Copyright 2001 Free Software Foundation, Inc.
5
This program is free software; you can redistribute it and/or modify
6
it under the terms of the GNU General Public License as published by
7
the Free Software Foundation; either version 2 of the License, or
8
(at your option) any later version.
10
This program is distributed in the hope that it will be useful,
11
but WITHOUT ANY WARRANTY; without even the implied warranty of
12
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
GNU General Public License for more details.
15
You should have received a copy of the GNU General Public License
16
along with this program; if not, write to the Free Software
17
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
19
#ifndef __A_OUT_64_H__
20
#define __A_OUT_64_H__
22
/* This is the layout on disk of the 32-bit or 64-bit exec header. */
27
bfd_byte e_info[4]; /* magic number and stuff */
28
bfd_byte e_text[BYTES_IN_WORD]; /* length of text section in bytes */
29
bfd_byte e_data[BYTES_IN_WORD]; /* length of data section in bytes */
30
bfd_byte e_bss[BYTES_IN_WORD]; /* length of bss area in bytes */
31
bfd_byte e_syms[BYTES_IN_WORD]; /* length of symbol table in bytes */
32
bfd_byte e_entry[BYTES_IN_WORD]; /* start address */
33
bfd_byte e_trsize[BYTES_IN_WORD]; /* length of text relocation info */
34
bfd_byte e_drsize[BYTES_IN_WORD]; /* length of data relocation info */
37
#define EXEC_BYTES_SIZE (4 + BYTES_IN_WORD * 7)
39
/* Magic numbers for a.out files */
42
#define OMAGIC 0x1001 /* Code indicating object file */
43
#define ZMAGIC 0x1002 /* Code indicating demand-paged executable. */
44
#define NMAGIC 0x1003 /* Code indicating pure executable. */
46
/* There is no 64-bit QMAGIC as far as I know. */
48
#define N_BADMAG(x) (N_MAGIC(x) != OMAGIC \
49
&& N_MAGIC(x) != NMAGIC \
50
&& N_MAGIC(x) != ZMAGIC)
52
#define OMAGIC 0407 /* ...object file or impure executable. */
53
#define NMAGIC 0410 /* Code indicating pure executable. */
54
#define ZMAGIC 0413 /* Code indicating demand-paged executable. */
55
#define BMAGIC 0415 /* Used by a b.out object. */
57
/* This indicates a demand-paged executable with the header in the text.
58
It is used by 386BSD (and variants) and Linux, at least. */
63
# define N_BADMAG(x) (N_MAGIC(x) != OMAGIC \
64
&& N_MAGIC(x) != NMAGIC \
65
&& N_MAGIC(x) != ZMAGIC \
66
&& N_MAGIC(x) != QMAGIC)
67
# endif /* N_BADMAG */
73
#define N_IS_QMAGIC(x) (N_MAGIC (x) == QMAGIC)
75
#define N_IS_QMAGIC(x) (0)
78
/* The difference between TARGET_PAGE_SIZE and N_SEGSIZE is that TARGET_PAGE_SIZE is
79
the finest granularity at which you can page something, thus it
80
controls the padding (if any) before the text segment of a ZMAGIC
81
file. N_SEGSIZE is the resolution at which things can be marked as
82
read-only versus read/write, so it controls the padding between the
83
text segment and the data segment (in memory; on disk the padding
84
between them is TARGET_PAGE_SIZE). TARGET_PAGE_SIZE and N_SEGSIZE are the same
85
for most machines, but different for sun3. */
87
/* By default, segment size is constant. But some machines override this
88
to be a function of the a.out header (e.g. machine type). */
91
#define N_SEGSIZE(x) SEGMENT_SIZE
94
/* Virtual memory address of the text section.
95
This is getting very complicated. A good reason to discard a.out format
96
for something that specifies these fields explicitly. But til then...
98
* OMAGIC and NMAGIC files:
99
(object files: text for "relocatable addr 0" right after the header)
100
start at 0, offset is EXEC_BYTES_SIZE, size as stated.
101
* The text address, offset, and size of ZMAGIC files depend
102
on the entry point of the file:
103
* entry point below TEXT_START_ADDR:
104
(hack for SunOS shared libraries)
105
start at 0, offset is 0, size as stated.
106
* If N_HEADER_IN_TEXT(x) is true (which defaults to being the
107
case when the entry point is EXEC_BYTES_SIZE or further into a page):
108
no padding is needed; text can start after exec header. Sun
109
considers the text segment of such files to include the exec header;
110
for BFD's purposes, we don't, which makes more work for us.
111
start at TEXT_START_ADDR + EXEC_BYTES_SIZE, offset is EXEC_BYTES_SIZE,
112
size as stated minus EXEC_BYTES_SIZE.
113
* If N_HEADER_IN_TEXT(x) is false (which defaults to being the case when
114
the entry point is less than EXEC_BYTES_SIZE into a page (e.g. page
115
aligned)): (padding is needed so that text can start at a page boundary)
116
start at TEXT_START_ADDR, offset TARGET_PAGE_SIZE, size as stated.
118
Specific configurations may want to hardwire N_HEADER_IN_TEXT,
119
for efficiency or to allow people to play games with the entry point.
120
In that case, you would #define N_HEADER_IN_TEXT(x) as 1 for sunos,
121
and as 0 for most other hosts (Sony News, Vax Ultrix, etc).
122
(Do this in the appropriate bfd target file.)
123
(The default is a heuristic that will break if people try changing
124
the entry point, perhaps with the ld -e flag.)
126
* QMAGIC is always like a ZMAGIC for which N_HEADER_IN_TEXT is true,
127
and for which the starting address is TARGET_PAGE_SIZE (or should this be
128
SEGMENT_SIZE?) (TEXT_START_ADDR only applies to ZMAGIC, not to QMAGIC).
131
/* This macro is only relevant for ZMAGIC files; QMAGIC always has the header
133
#ifndef N_HEADER_IN_TEXT
134
#define N_HEADER_IN_TEXT(x) \
135
(((x).a_entry & (TARGET_PAGE_SIZE-1)) >= EXEC_BYTES_SIZE)
138
/* Sun shared libraries, not linux. This macro is only relevant for ZMAGIC
141
#if defined (TEXT_START_ADDR) && TEXT_START_ADDR == 0
142
#define N_SHARED_LIB(x) (0)
144
#define N_SHARED_LIB(x) ((x).a_entry < TEXT_START_ADDR)
148
/* Returning 0 not TEXT_START_ADDR for OMAGIC and NMAGIC is based on
149
the assumption that we are dealing with a .o file, not an
150
executable. This is necessary for OMAGIC (but means we don't work
151
right on the output from ld -N); more questionable for NMAGIC. */
154
#define N_TXTADDR(x) \
155
(/* The address of a QMAGIC file is always one page in, */ \
156
/* with the header in the text. */ \
158
? (bfd_vma) TARGET_PAGE_SIZE + EXEC_BYTES_SIZE \
159
: (N_MAGIC (x) != ZMAGIC \
160
? (bfd_vma) 0 /* object file or NMAGIC */ \
161
: (N_SHARED_LIB (x) \
163
: (N_HEADER_IN_TEXT (x) \
164
? (bfd_vma) TEXT_START_ADDR + EXEC_BYTES_SIZE \
165
: (bfd_vma) TEXT_START_ADDR))))
168
/* If N_HEADER_IN_TEXT is not true for ZMAGIC, there is some padding
169
to make the text segment start at a certain boundary. For most
170
systems, this boundary is TARGET_PAGE_SIZE. But for Linux, in the
171
time-honored tradition of crazy ZMAGIC hacks, it is 1024 which is
172
not what TARGET_PAGE_SIZE needs to be for QMAGIC. */
174
#ifndef ZMAGIC_DISK_BLOCK_SIZE
175
#define ZMAGIC_DISK_BLOCK_SIZE TARGET_PAGE_SIZE
178
#define N_DISK_BLOCK_SIZE(x) \
179
(N_MAGIC(x) == ZMAGIC ? ZMAGIC_DISK_BLOCK_SIZE : TARGET_PAGE_SIZE)
181
/* Offset in an a.out of the start of the text section. */
183
#define N_TXTOFF(x) \
184
(/* For {O,N,Q}MAGIC, no padding. */ \
185
N_MAGIC (x) != ZMAGIC \
187
: (N_SHARED_LIB (x) \
189
: (N_HEADER_IN_TEXT (x) \
190
? EXEC_BYTES_SIZE /* no padding */ \
191
: ZMAGIC_DISK_BLOCK_SIZE /* a page of padding */)))
193
/* Size of the text section. It's always as stated, except that we
194
offset it to `undo' the adjustment to N_TXTADDR and N_TXTOFF
195
for ZMAGIC files that nominally include the exec header
196
as part of the first page of text. (BFD doesn't consider the
197
exec header to be part of the text segment.) */
199
#define N_TXTSIZE(x) \
200
(/* For QMAGIC, we don't consider the header part of the text section. */\
202
? (x).a_text - EXEC_BYTES_SIZE \
203
: ((N_MAGIC (x) != ZMAGIC || N_SHARED_LIB (x)) \
205
: (N_HEADER_IN_TEXT (x) \
206
? (x).a_text - EXEC_BYTES_SIZE /* no padding */ \
207
: (x).a_text /* a page of padding */ )))
209
/* The address of the data segment in virtual memory.
210
It is the text segment address, plus text segment size, rounded
211
up to a N_SEGSIZE boundary for pure or pageable files. */
213
#define N_DATADDR(x) \
214
(N_MAGIC (x) == OMAGIC \
215
? (N_TXTADDR (x) + N_TXTSIZE (x)) \
216
: (N_SEGSIZE (x) + ((N_TXTADDR (x) + N_TXTSIZE (x) - 1) \
217
& ~ (bfd_vma) (N_SEGSIZE (x) - 1))))
219
/* The address of the BSS segment -- immediately after the data segment. */
221
#define N_BSSADDR(x) (N_DATADDR (x) + (x).a_data)
223
/* Offsets of the various portions of the file after the text segment. */
225
/* For {Q,Z}MAGIC, there is padding to make the data segment start on
226
a page boundary. Most of the time the a_text field (and thus
227
N_TXTSIZE) already contains this padding. It is possible that for
228
BSDI and/or 386BSD it sometimes doesn't contain the padding, and
229
perhaps we should be adding it here. But this seems kind of
230
questionable and probably should be BSDI/386BSD-specific if we do
233
For NMAGIC (at least for hp300 BSD, probably others), there is
234
padding in memory only, not on disk, so we must *not* ever pad here
238
#define N_DATOFF(x) ( N_TXTOFF (x) + N_TXTSIZE (x) )
241
#define N_TRELOFF(x) ( N_DATOFF (x) + (x).a_data )
244
#define N_DRELOFF(x) ( N_TRELOFF (x) + (x).a_trsize )
247
#define N_SYMOFF(x) ( N_DRELOFF (x) + (x).a_drsize )
250
#define N_STROFF(x) ( N_SYMOFF (x) + (x).a_syms )
254
#ifndef external_nlist
255
struct external_nlist {
256
bfd_byte e_strx[BYTES_IN_WORD]; /* index into string table of name */
257
bfd_byte e_type[1]; /* type of symbol */
258
bfd_byte e_other[1]; /* misc info (usually empty) */
259
bfd_byte e_desc[2]; /* description field */
260
bfd_byte e_value[BYTES_IN_WORD]; /* value of symbol */
262
#define EXTERNAL_NLIST_SIZE (BYTES_IN_WORD+4+BYTES_IN_WORD)
265
struct internal_nlist {
266
unsigned long n_strx; /* index into string table of name */
267
unsigned char n_type; /* type of symbol */
268
unsigned char n_other; /* misc info (usually empty) */
269
unsigned short n_desc; /* description field */
270
bfd_vma n_value; /* value of symbol */
273
/* The n_type field is the symbol type, containing: */
275
#define N_UNDF 0 /* Undefined symbol */
276
#define N_ABS 2 /* Absolute symbol -- defined at particular addr */
277
#define N_TEXT 4 /* Text sym -- defined at offset in text seg */
278
#define N_DATA 6 /* Data sym -- defined at offset in data seg */
279
#define N_BSS 8 /* BSS sym -- defined at offset in zero'd seg */
280
#define N_COMM 0x12 /* Common symbol (visible after shared lib dynlink) */
281
#define N_FN 0x1f /* File name of .o file */
282
#define N_FN_SEQ 0x0C /* N_FN from Sequent compilers (sigh) */
283
/* Note: N_EXT can only be usefully OR-ed with N_UNDF, N_ABS, N_TEXT,
284
N_DATA, or N_BSS. When the low-order bit of other types is set,
285
(e.g. N_WARNING versus N_FN), they are two different types. */
286
#define N_EXT 1 /* External symbol (as opposed to local-to-this-file) */
288
#define N_STAB 0xe0 /* If any of these bits are on, it's a debug symbol */
292
/* The following symbols refer to set elements.
293
All the N_SET[ATDB] symbols with the same name form one set.
294
Space is allocated for the set in the text section, and each set
295
elements value is stored into one word of the space.
296
The first word of the space is the length of the set (number of elements).
298
The address of the set is made into an N_SETV symbol
299
whose name is the same as the name of the set.
300
This symbol acts like a N_DATA global symbol
301
in that it can satisfy undefined external references. */
303
/* These appear as input to LD, in a .o file. */
304
#define N_SETA 0x14 /* Absolute set element symbol */
305
#define N_SETT 0x16 /* Text set element symbol */
306
#define N_SETD 0x18 /* Data set element symbol */
307
#define N_SETB 0x1A /* Bss set element symbol */
309
/* This is output from LD. */
310
#define N_SETV 0x1C /* Pointer to set vector in data area. */
312
/* Warning symbol. The text gives a warning message, the next symbol
313
in the table will be undefined. When the symbol is referenced, the
314
message is printed. */
316
#define N_WARNING 0x1e
318
/* Weak symbols. These are a GNU extension to the a.out format. The
319
semantics are those of ELF weak symbols. Weak symbols are always
320
externally visible. The N_WEAK? values are squeezed into the
321
available slots. The value of a N_WEAKU symbol is 0. The values
322
of the other types are the definitions. */
323
#define N_WEAKU 0x0d /* Weak undefined symbol. */
324
#define N_WEAKA 0x0e /* Weak absolute symbol. */
325
#define N_WEAKT 0x0f /* Weak text symbol. */
326
#define N_WEAKD 0x10 /* Weak data symbol. */
327
#define N_WEAKB 0x11 /* Weak bss symbol. */
331
There are two types of relocation flavours for a.out systems,
332
standard and extended. The standard form is used on systems where the
333
instruction has room for all the bits of an offset to the operand, whilst
334
the extended form is used when an address operand has to be split over n
335
instructions. Eg, on the 68k, each move instruction can reference
336
the target with a displacement of 16 or 32 bits. On the sparc, move
337
instructions use an offset of 14 bits, so the offset is stored in
338
the reloc field, and the data in the section is ignored.
341
/* This structure describes a single relocation to be performed.
342
The text-relocation section of the file is a vector of these structures,
343
all of which apply to the text section.
344
Likewise, the data-relocation section applies to the data section. */
346
struct reloc_std_external {
347
bfd_byte r_address[BYTES_IN_WORD]; /* offset of of data to relocate */
348
bfd_byte r_index[3]; /* symbol table index of symbol */
349
bfd_byte r_type[1]; /* relocation type */
352
#define RELOC_STD_BITS_PCREL_BIG ((unsigned int) 0x80)
353
#define RELOC_STD_BITS_PCREL_LITTLE ((unsigned int) 0x01)
355
#define RELOC_STD_BITS_LENGTH_BIG ((unsigned int) 0x60)
356
#define RELOC_STD_BITS_LENGTH_SH_BIG 5
357
#define RELOC_STD_BITS_LENGTH_LITTLE ((unsigned int) 0x06)
358
#define RELOC_STD_BITS_LENGTH_SH_LITTLE 1
360
#define RELOC_STD_BITS_EXTERN_BIG ((unsigned int) 0x10)
361
#define RELOC_STD_BITS_EXTERN_LITTLE ((unsigned int) 0x08)
363
#define RELOC_STD_BITS_BASEREL_BIG ((unsigned int) 0x08)
364
#define RELOC_STD_BITS_BASEREL_LITTLE ((unsigned int) 0x10)
366
#define RELOC_STD_BITS_JMPTABLE_BIG ((unsigned int) 0x04)
367
#define RELOC_STD_BITS_JMPTABLE_LITTLE ((unsigned int) 0x20)
369
#define RELOC_STD_BITS_RELATIVE_BIG ((unsigned int) 0x02)
370
#define RELOC_STD_BITS_RELATIVE_LITTLE ((unsigned int) 0x40)
372
#define RELOC_STD_SIZE (BYTES_IN_WORD + 3 + 1) /* Bytes per relocation entry */
374
struct reloc_std_internal
376
bfd_vma r_address; /* Address (within segment) to be relocated. */
377
/* The meaning of r_symbolnum depends on r_extern. */
378
unsigned int r_symbolnum:24;
379
/* Nonzero means value is a pc-relative offset
380
and it should be relocated for changes in its own address
381
as well as for changes in the symbol or section specified. */
382
unsigned int r_pcrel:1;
383
/* Length (as exponent of 2) of the field to be relocated.
384
Thus, a value of 2 indicates 1<<2 bytes. */
385
unsigned int r_length:2;
386
/* 1 => relocate with value of symbol.
387
r_symbolnum is the index of the symbol
388
in files the symbol table.
389
0 => relocate with the address of a segment.
390
r_symbolnum is N_TEXT, N_DATA, N_BSS or N_ABS
391
(the N_EXT bit may be set also, but signifies nothing). */
392
unsigned int r_extern:1;
393
/* The next three bits are for SunOS shared libraries, and seem to
395
unsigned int r_baserel:1; /* Linkage table relative */
396
unsigned int r_jmptable:1; /* pc-relative to jump table */
397
unsigned int r_relative:1; /* "relative relocation" */
399
unsigned int r_pad:1; /* Padding -- set to zero */
403
/* EXTENDED RELOCS */
405
struct reloc_ext_external {
406
bfd_byte r_address[BYTES_IN_WORD]; /* offset of of data to relocate */
407
bfd_byte r_index[3]; /* symbol table index of symbol */
408
bfd_byte r_type[1]; /* relocation type */
409
bfd_byte r_addend[BYTES_IN_WORD]; /* datum addend */
412
#ifndef RELOC_EXT_BITS_EXTERN_BIG
413
#define RELOC_EXT_BITS_EXTERN_BIG ((unsigned int) 0x80)
416
#ifndef RELOC_EXT_BITS_EXTERN_LITTLE
417
#define RELOC_EXT_BITS_EXTERN_LITTLE ((unsigned int) 0x01)
420
#ifndef RELOC_EXT_BITS_TYPE_BIG
421
#define RELOC_EXT_BITS_TYPE_BIG ((unsigned int) 0x1F)
424
#ifndef RELOC_EXT_BITS_TYPE_SH_BIG
425
#define RELOC_EXT_BITS_TYPE_SH_BIG 0
428
#ifndef RELOC_EXT_BITS_TYPE_LITTLE
429
#define RELOC_EXT_BITS_TYPE_LITTLE ((unsigned int) 0xF8)
432
#ifndef RELOC_EXT_BITS_TYPE_SH_LITTLE
433
#define RELOC_EXT_BITS_TYPE_SH_LITTLE 3
436
/* Bytes per relocation entry */
437
#define RELOC_EXT_SIZE (BYTES_IN_WORD + 3 + 1 + BYTES_IN_WORD)
441
/* simple relocations */
442
RELOC_8, /* data[0:7] = addend + sv */
443
RELOC_16, /* data[0:15] = addend + sv */
444
RELOC_32, /* data[0:31] = addend + sv */
445
/* pc-rel displacement */
446
RELOC_DISP8, /* data[0:7] = addend - pc + sv */
447
RELOC_DISP16, /* data[0:15] = addend - pc + sv */
448
RELOC_DISP32, /* data[0:31] = addend - pc + sv */
450
RELOC_WDISP30, /* data[0:29] = (addend + sv - pc)>>2 */
451
RELOC_WDISP22, /* data[0:21] = (addend + sv - pc)>>2 */
452
RELOC_HI22, /* data[0:21] = (addend + sv)>>10 */
453
RELOC_22, /* data[0:21] = (addend + sv) */
454
RELOC_13, /* data[0:12] = (addend + sv) */
455
RELOC_LO10, /* data[0:9] = (addend + sv) */
458
/* P.I.C. (base-relative) */
459
RELOC_BASE10, /* Not sure - maybe we can do this the */
460
RELOC_BASE13, /* right way now */
462
/* for some sort of pc-rel P.I.C. (?) */
465
/* P.I.C. jump table */
467
/* reputedly for shared libraries somehow */
476
RELOC_HHI22, /* data[0:21] = (addend + sv) >> 42 */
477
RELOC_HLO10, /* data[0:9] = (addend + sv) >> 32 */
479
/* 29K relocation types */
484
/* All the new ones I can think of, for sparc v9 */
486
RELOC_64, /* data[0:63] = addend + sv */
487
RELOC_DISP64, /* data[0:63] = addend - pc + sv */
488
RELOC_WDISP21, /* data[0:20] = (addend + sv - pc)>>2 */
489
RELOC_DISP21, /* data[0:20] = addend - pc + sv */
490
RELOC_DISP14, /* data[0:13] = addend - pc + sv */
492
What are the other ones,
493
Since this is a clean slate, can we throw away the ones we dont
494
understand ? Should we sort the values ? What about using a
495
microcode format like the 68k ?
501
struct reloc_internal {
502
bfd_vma r_address; /* offset of of data to relocate */
503
long r_index; /* symbol table index of symbol */
504
enum reloc_type r_type; /* relocation type */
505
bfd_vma r_addend; /* datum addend */
509
Should the length of the string table be 4 bytes or 8 bytes ?
512
What about archive indexes ?
516
#endif /* __A_OUT_64_H__ */