* write.c (write_relocs): Use S_IS_DEFINED and S_IS_COMMON rather
[deliverable/binutils-gdb.git] / gas / config / obj-bout.h
CommitLineData
fecd2382 1/* b.out object file format
01170860 2 Copyright (C) 1989, 1990, 1991, 1992 Free Software Foundation, Inc.
355afbcd 3
a39116f1 4 This file is part of GAS, the GNU Assembler.
355afbcd 5
a39116f1
RP
6 GAS is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as
8 published by the Free Software Foundation; either version 2,
9 or (at your option) any later version.
355afbcd 10
a39116f1
RP
11 GAS is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
14 the GNU General Public License for more details.
355afbcd 15
a39116f1
RP
16 You should have received a copy of the GNU General Public
17 License along with GAS; see the file COPYING. If not, write
a2a5a4fa 18 to the Free Software Foundation, 59 Temple Place - Suite 330, Cambridge, MA
a39116f1 19 02139, USA. */
fecd2382 20
fecd2382
RP
21/*
22 * This file is a modified version of 'a.out.h'. It is to be used in all GNU
23 * tools modified to support the i80960 b.out format (or tools that operate on
24 * object files created by such tools).
25 *
26 * All i80960 development is done in a CROSS-DEVELOPMENT environment. I.e.,
27 * object code is generated on, and executed under the direction of a symbolic
28 * debugger running on, a host system. We do not want to be subject to the
29 * vagaries of which host it is or whether it supports COFF or a.out format, or
30 * anything else. We DO want to:
31 *
32 * o always generate the same format object files, regardless of host.
33 *
34 * o have an 'a.out' header that we can modify for our own purposes
35 * (the 80960 is typically an embedded processor and may require
36 * enhanced linker support that the normal a.out.h header can't
37 * accommodate).
38 *
39 * As for byte-ordering, the following rules apply:
40 *
41 * o Text and data that is actually downloaded to the target is always
42 * in i80960 (little-endian) order.
43 *
44 * o All other numbers (in the header, symbols, relocation directives)
45 * are in host byte-order: object files CANNOT be lifted from a
46 * little-end host and used on a big-endian (or vice versa) without
47 * modification.
8ae35e59
ILT
48 * ==> THIS IS NO LONGER TRUE USING BFD. WE CAN GENERATE ANY BYTE ORDER
49 * FOR THE HEADER, AND READ ANY BYTE ORDER. PREFERENCE WOULD BE TO
50 * USE LITTLE-ENDIAN BYTE ORDER THROUGHOUT, REGARDLESS OF HOST. <==
fecd2382
RP
51 *
52 * o The downloader ('comm960') takes care to generate a pseudo-header
53 * with correct (i80960) byte-ordering before shipping text and data
54 * off to the NINDY monitor in the target systems. Symbols and
55 * relocation info are never sent to the target.
56 */
57
58
59#define OBJ_BOUT 1
60
12aab635
KR
61#define OUTPUT_FLAVOR bfd_target_aout_flavour
62
fecd2382
RP
63#include "targ-cpu.h"
64
fecd2382
RP
65#define OBJ_DEFAULT_OUTPUT_FILE_NAME "b.out"
66
67extern const short seg_N_TYPE[];
355afbcd 68extern const segT N_TYPE_seg[];
fecd2382
RP
69
70#define BMAGIC 0415
71/* We don't accept the following (see N_BADMAG macro).
72 * They're just here so GNU code will compile.
73 */
74#define OMAGIC 0407 /* old impure format */
75#define NMAGIC 0410 /* read-only text */
76#define ZMAGIC 0413 /* demand load format */
77
78#ifndef DEFAULT_MAGIC_NUMBER_FOR_OBJECT_FILE
79#define DEFAULT_MAGIC_NUMBER_FOR_OBJECT_FILE (BMAGIC)
80#endif /* DEFAULT_MAGIC_NUMBER_FOR_OBJECT_FILE */
81
82/* FILE HEADER
83 * All 'lengths' are given as a number of bytes.
84 * All 'alignments' are for relinkable files only; an alignment of
85 * 'n' indicates the corresponding segment must begin at an
86 * address that is a multiple of (2**n).
87 */
355afbcd
KR
88struct exec
89 {
90 /* Standard stuff */
91 unsigned long a_magic; /* Identifies this as a b.out file */
92 unsigned long a_text; /* Length of text */
93 unsigned long a_data; /* Length of data */
94 unsigned long a_bss; /* Length of runtime uninitialized data area */
95 unsigned long a_syms; /* Length of symbol table */
96 unsigned long a_entry; /* Runtime start address */
97 unsigned long a_trsize; /* Length of text relocation info */
98 unsigned long a_drsize; /* Length of data relocation info */
99
100 /* Added for i960 */
101 unsigned long a_tload; /* Text runtime load address */
102 unsigned long a_dload; /* Data runtime load address */
103 unsigned char a_talign; /* Alignment of text segment */
104 unsigned char a_dalign; /* Alignment of data segment */
105 unsigned char a_balign; /* Alignment of bss segment */
106 unsigned char a_relaxable; /* Contains enough info to relax */
107 };
fecd2382
RP
108
109#define N_BADMAG(x) (((x).a_magic)!=BMAGIC)
110#define N_TXTOFF(x) ( sizeof(struct exec) )
111#define N_DATOFF(x) ( N_TXTOFF(x) + (x).a_text )
112#define N_TROFF(x) ( N_DATOFF(x) + (x).a_data )
113#define N_DROFF(x) ( N_TROFF(x) + (x).a_trsize )
114#define N_SYMOFF(x) ( N_DROFF(x) + (x).a_drsize )
115#define N_STROFF(x) ( N_SYMOFF(x) + (x).a_syms )
116
117/* A single entry in the symbol table
118 */
355afbcd
KR
119struct nlist
120 {
121 union
122 {
123 char *n_name;
124 struct nlist *n_next;
125 long n_strx; /* Index into string table */
126 }
127 n_un;
128 unsigned char n_type; /* See below */
129 char n_other; /* Used in i80960 support -- see below */
130 short n_desc;
131 unsigned long n_value;
132 };
fecd2382
RP
133
134typedef struct nlist obj_symbol_type;
135
136/* Legal values of n_type
137 */
355afbcd
KR
138#define N_UNDF 0 /* Undefined symbol */
139#define N_ABS 2 /* Absolute symbol */
140#define N_TEXT 4 /* Text symbol */
141#define N_DATA 6 /* Data symbol */
142#define N_BSS 8 /* BSS symbol */
143#define N_FN 31 /* Filename symbol */
fecd2382 144
355afbcd
KR
145#define N_EXT 1 /* External symbol (OR'd in with one of above) */
146#define N_TYPE 036 /* Mask for all the type bits */
147#define N_STAB 0340 /* Mask for all bits used for SDB entries */
fecd2382
RP
148
149#ifndef CUSTOM_RELOC_FORMAT
355afbcd
KR
150struct relocation_info
151 {
152 int r_address; /* File address of item to be relocated */
153 unsigned
154 r_index:24, /* Index of symbol on which relocation is based*/
155 r_pcrel:1, /* 1 => relocate PC-relative; else absolute
a39116f1
RP
156 * On i960, pc-relative implies 24-bit
157 * address, absolute implies 32-bit.
158 */
355afbcd 159 r_length:2, /* Number of bytes to relocate:
a39116f1
RP
160 * 0 => 1 byte
161 * 1 => 2 bytes
162 * 2 => 4 bytes -- only value used for i960
163 */
355afbcd
KR
164 r_extern:1, r_bsr:1, /* Something for the GNU NS32K assembler */
165 r_disp:1, /* Something for the GNU NS32K assembler */
166 r_callj:1, /* 1 if relocation target is an i960 'callj' */
167 nuthin:1; /* Unused */
168 };
169
fecd2382
RP
170#endif /* CUSTOM_RELOC_FORMAT */
171
fecd2382
RP
172/*
173 * Macros to extract information from a symbol table entry.
174 * This syntaxic indirection allows independence regarding a.out or coff.
175 * The argument (s) of all these macros is a pointer to a symbol table entry.
176 */
177
178/* Predicates */
179/* True if the symbol is external */
180#define S_IS_EXTERNAL(s) ((s)->sy_symbol.n_type & N_EXT)
181
182/* True if symbol has been defined, ie is in N_{TEXT,DATA,BSS,ABS} or N_EXT */
183#define S_IS_DEFINED(s) ((S_GET_TYPE(s) != N_UNDF) || (S_GET_DESC(s) != 0))
e24cf2b5
ILT
184
185#define S_IS_COMMON(s) \
186 (S_GET_TYPE (s) == N_UNDF && S_GET_VALUE (s) != 0)
187
fecd2382
RP
188#define S_IS_REGISTER(s) ((s)->sy_symbol.n_type == N_REGISTER)
189
190/* True if a debug special symbol entry */
191#define S_IS_DEBUG(s) ((s)->sy_symbol.n_type & N_STAB)
192/* True if a symbol is local symbol name */
9e396994
ILT
193#define S_IS_LOCAL(s) \
194 (S_GET_NAME (s) \
195 && !S_IS_DEBUG (s) \
196 && (strchr (S_GET_NAME (s), '\001') != NULL \
197 || strchr (S_GET_NAME (s), '\002') != NULL \
198 || (S_LOCAL_NAME(s) && !flag_keep_locals)))
fecd2382
RP
199/* True if a symbol is not defined in this file */
200#define S_IS_EXTERN(s) ((s)->sy_symbol.n_type & N_EXT)
201/* True if the symbol has been generated because of a .stabd directive */
202#define S_IS_STABD(s) (S_GET_NAME(s) == NULL)
203
204/* Accessors */
fecd2382
RP
205/* The name of the symbol */
206#define S_GET_NAME(s) ((s)->sy_symbol.n_un.n_name)
207/* The pointer to the string table */
208#define S_GET_OFFSET(s) ((s)->sy_symbol.n_un.n_strx)
209/* The type of the symbol */
210#define S_GET_TYPE(s) ((s)->sy_symbol.n_type & N_TYPE)
211/* The numeric value of the segment */
212#define S_GET_SEGMENT(s) (N_TYPE_seg[S_GET_TYPE(s)])
213/* The n_other expression value */
214#define S_GET_OTHER(s) ((s)->sy_symbol.n_other)
215/* The n_desc expression value */
216#define S_GET_DESC(s) ((s)->sy_symbol.n_desc)
217
218/* Modifiers */
fecd2382 219/* Assume that a symbol cannot be simultaneously in more than on segment */
a39116f1 220/* set segment */
fecd2382
RP
221#define S_SET_SEGMENT(s,seg) ((s)->sy_symbol.n_type &= ~N_TYPE,(s)->sy_symbol.n_type|=SEGMENT_TO_SYMBOL_TYPE(seg))
222/* The symbol is external */
223#define S_SET_EXTERNAL(s) ((s)->sy_symbol.n_type |= N_EXT)
224/* The symbol is not external */
225#define S_CLEAR_EXTERNAL(s) ((s)->sy_symbol.n_type &= ~N_EXT)
226/* Set the name of the symbol */
227#define S_SET_NAME(s,v) ((s)->sy_symbol.n_un.n_name = (v))
228/* Set the offset in the string table */
229#define S_SET_OFFSET(s,v) ((s)->sy_symbol.n_un.n_strx = (v))
230/* Set the n_other expression value */
231#define S_SET_OTHER(s,v) ((s)->sy_symbol.n_other = (v))
232/* Set the n_desc expression value */
233#define S_SET_DESC(s,v) ((s)->sy_symbol.n_desc = (v))
4f0bccc7
ILT
234/* Set the n_type value */
235#define S_SET_TYPE(s,v) ((s)->sy_symbol.n_type = (v))
fecd2382
RP
236
237/* File header macro and type definition */
238
239#define H_GET_FILE_SIZE(h) (sizeof(struct exec) + \
240 H_GET_TEXT_SIZE(h) + H_GET_DATA_SIZE(h) + \
241 H_GET_SYMBOL_TABLE_SIZE(h) + \
242 H_GET_TEXT_RELOCATION_SIZE(h) + \
243 H_GET_DATA_RELOCATION_SIZE(h) + \
244 (h)->string_table_size)
245
a79c6033 246#define H_GET_HEADER_SIZE(h) (sizeof(struct exec))
fecd2382
RP
247#define H_GET_TEXT_SIZE(h) ((h)->header.a_text)
248#define H_GET_DATA_SIZE(h) ((h)->header.a_data)
249#define H_GET_BSS_SIZE(h) ((h)->header.a_bss)
250#define H_GET_TEXT_RELOCATION_SIZE(h) ((h)->header.a_trsize)
251#define H_GET_DATA_RELOCATION_SIZE(h) ((h)->header.a_drsize)
252#define H_GET_SYMBOL_TABLE_SIZE(h) ((h)->header.a_syms)
253#define H_GET_MAGIC_NUMBER(h) ((h)->header.a_info)
254#define H_GET_ENTRY_POINT(h) ((h)->header.a_entry)
255#define H_GET_STRING_SIZE(h) ((h)->string_table_size)
a79c6033
RP
256#define H_GET_LINENO_SIZE(h) (0)
257
fecd2382
RP
258#ifdef EXEC_MACHINE_TYPE
259#define H_GET_MACHINE_TYPE(h) ((h)->header.a_machtype)
260#endif /* EXEC_MACHINE_TYPE */
261#ifdef EXEC_VERSION
262#define H_GET_VERSION(h) ((h)->header.a_version)
263#endif /* EXEC_VERSION */
264
a79c6033
RP
265#define H_SET_TEXT_SIZE(h,v) ((h)->header.a_text = (v))
266#define H_SET_DATA_SIZE(h,v) ((h)->header.a_data = (v))
267#define H_SET_BSS_SIZE(h,v) ((h)->header.a_bss = (v))
fecd2382
RP
268
269#define H_SET_RELOCATION_SIZE(h,t,d) (H_SET_TEXT_RELOCATION_SIZE((h),(t)),\
270 H_SET_DATA_RELOCATION_SIZE((h),(d)))
271
272#define H_SET_TEXT_RELOCATION_SIZE(h,v) ((h)->header.a_trsize = (v))
273#define H_SET_DATA_RELOCATION_SIZE(h,v) ((h)->header.a_drsize = (v))
274#define H_SET_SYMBOL_TABLE_SIZE(h,v) ((h)->header.a_syms = (v) * \
275 sizeof(struct nlist))
276
277#define H_SET_MAGIC_NUMBER(h,v) ((h)->header.a_magic = (v))
278
279#define H_SET_ENTRY_POINT(h,v) ((h)->header.a_entry = (v))
280#define H_SET_STRING_SIZE(h,v) ((h)->string_table_size = (v))
281#ifdef EXEC_MACHINE_TYPE
282#define H_SET_MACHINE_TYPE(h,v) ((h)->header.a_machtype = (v))
283#endif /* EXEC_MACHINE_TYPE */
284#ifdef EXEC_VERSION
285#define H_SET_VERSION(h,v) ((h)->header.a_version = (v))
286#endif /* EXEC_VERSION */
287
355afbcd
KR
288typedef struct
289 {
290 struct exec header; /* a.out header */
291 long string_table_size; /* names + '\0' + sizeof(int) */
292 }
293
294object_headers;
fecd2382
RP
295
296/* unused hooks. */
9439f48f
RP
297#define OBJ_EMIT_LINENO(a, b, c) {;}
298#define obj_pre_write_hook(a) {;}
fecd2382 299
a87b3269 300#if __STDC__
a79c6033 301struct fix;
4f0bccc7
ILT
302#endif
303extern void tc_aout_fix_to_chars PARAMS ((char *where,
304 struct fix *fixP,
305 relax_addressT segment_address));
306extern void tc_bout_fix_to_chars PARAMS ((char *where,
307 struct fix *fixP,
308 relax_addressT segment_address));
a79c6033 309
8c5e0f5e
KR
310#define AOUT_STABS
311
fecd2382 312/* end of obj-bout.h */
This page took 0.216399 seconds and 4 git commands to generate.