[deliverable/binutils-gdb.git] / include / coff / rs6000.h

/* IBM RS/6000 "XCOFF" file definitions for BFD.
   Copyright (C) 1990, 1991 Free Software Foundation, Inc.
   FIXME: Can someone provide a transliteration of this name into ASCII?
   Using the following chars caused a compiler warning on HIUX (so I replaced
   them with octal escapes), and isn't useful without an understanding of what
   character set it is.
   Written by Mimi Ph\373\364ng-Th\345o V\365 of IBM
   and John Gilmore of Cygnus Support.  */

/********************** FILE HEADER **********************/

struct external_filehdr {
	char f_magic[2];	/* magic number			*/
	char f_nscns[2];	/* number of sections		*/
	char f_timdat[4];	/* time & date stamp		*/
	char f_symptr[4];	/* file pointer to symtab	*/
	char f_nsyms[4];	/* number of symtab entries	*/
	char f_opthdr[2];	/* sizeof(optional hdr)		*/
	char f_flags[2];	/* flags			*/
};

        /* IBM RS/6000 */
#define U802WRMAGIC     0730    /* writeable text segments **chh**      */
#define U802ROMAGIC     0735    /* readonly sharable text segments      */
#define U802TOCMAGIC    0737    /* readonly text segments and TOC       */

#define BADMAG(x)	\
	((x).f_magic != U802ROMAGIC && (x).f_magic != U802WRMAGIC && \
	 (x).f_magic != U802TOCMAGIC)

#define	FILHDR	struct external_filehdr
#define	FILHSZ	sizeof(FILHDR)


/********************** AOUT "OPTIONAL HEADER" **********************/


typedef struct 
{
  unsigned char	magic[2];	/* type of file			*/
  unsigned char	vstamp[2];	/* version stamp		*/
  unsigned char	tsize[4];	/* text size in bytes, padded to FW bdry */
  unsigned char	dsize[4];	/* initialized data "  "	*/
  unsigned char	bsize[4];	/* uninitialized data "   "	*/
  unsigned char	entry[4];	/* entry pt.			*/
  unsigned char	text_start[4];	/* base of text used for this file */
  unsigned char	data_start[4];	/* base of data used for this file */
  unsigned char	o_toc[4];	/* address of TOC */
  unsigned char	o_snentry[2];	/* section number of entry point */
  unsigned char	o_sntext[2];	/* section number of .text section */
  unsigned char	o_sndata[2];	/* section number of .data section */
  unsigned char	o_sntoc[2];	/* section number of TOC */
  unsigned char	o_snloader[2];	/* section number of .loader section */
  unsigned char	o_snbss[2];	/* section number of .bss section */
  unsigned char	o_algntext[2];	/* .text alignment */
  unsigned char	o_algndata[2];	/* .data alignment */
  unsigned char	o_modtype[2];	/* module type (??) */
  unsigned char	o_resv1[2];	/* reserved */
  unsigned char	o_maxstack[4];	/* max stack size (??) */
  unsigned char o_maxdata[4];	/* max data size (??) */
  unsigned char	o_resv2[12];	/* reserved */
}
AOUTHDR;

#define AOUTSZ (sizeof(AOUTHDR))

#define	RS6K_AOUTHDR_OMAGIC	0x0107	/* old: text & data writeable */
#define	RS6K_AOUTHDR_NMAGIC	0x0108	/* new: text r/o, data r/w */
#define	RS6K_AOUTHDR_ZMAGIC	0x010B	/* paged: text r/o, both page-aligned */


/********************** SECTION HEADER **********************/


struct external_scnhdr {
	char		s_name[8];	/* section name			*/
	char		s_paddr[4];	/* physical address, aliased s_nlib */
	char		s_vaddr[4];	/* virtual address		*/
	char		s_size[4];	/* section size			*/
	char		s_scnptr[4];	/* file ptr to raw data for section */
	char		s_relptr[4];	/* file ptr to relocation	*/
	char		s_lnnoptr[4];	/* file ptr to line numbers	*/
	char		s_nreloc[2];	/* number of relocation entries	*/
	char		s_nlnno[2];	/* number of line number entries*/
	char		s_flags[4];	/* flags			*/
};

/*
 * names of "special" sections
 */
#define _TEXT	".text"
#define _DATA	".data"
#define _BSS	".bss"
#define _PAD	".pad"
#define _LOADER	".loader"

#define	SCNHDR	struct external_scnhdr
#define	SCNHSZ	sizeof(SCNHDR)

/* XCOFF uses a special .loader section with type STYP_LOADER.  */
#define STYP_LOADER 0x1000

/* XCOFF uses a special .debug section with type STYP_DEBUG.  */
#define STYP_DEBUG 0x2000

/********************** LINE NUMBERS **********************/

/* 1 line number entry for every "breakpointable" source line in a section.
 * Line numbers are grouped on a per function basis; first entry in a function
 * grouping will have l_lnno = 0 and in place of physical address will be the
 * symbol table index of the function name.
 */
struct external_lineno {
	union {
		char l_symndx[4];	/* function name symbol index, iff l_lnno == 0*/
		char l_paddr[4];	/* (physical) address of line number	*/
	} l_addr;
	char l_lnno[2];	/* line number		*/
};


#define	LINENO	struct external_lineno
#define	LINESZ	sizeof(LINENO) 


/********************** SYMBOLS **********************/

#define E_SYMNMLEN	8	/* # characters in a symbol name	*/
#define E_FILNMLEN	14	/* # characters in a file name		*/
#define E_DIMNUM	4	/* # array dimensions in auxiliary entry */

struct external_syment 
{
  union {
    char e_name[E_SYMNMLEN];
    struct {
      char e_zeroes[4];
      char e_offset[4];
    } e;
  } e;
  char e_value[4];
  char e_scnum[2];
  char e_type[2];
  char e_sclass[1];
  char e_numaux[1];
};


#define N_BTMASK	(017)
#define N_TMASK		(060)
#define N_BTSHFT	(4)
#define N_TSHIFT	(2)
  

union external_auxent {
	struct {
		char x_tagndx[4];	/* str, un, or enum tag indx */
		union {
			struct {
			    char  x_lnno[2]; /* declaration line number */
			    char  x_size[2]; /* str/union/array size */
			} x_lnsz;
			char x_fsize[4];	/* size of function */
		} x_misc;
		union {
			struct {		/* if ISFCN, tag, or .bb */
			    char x_lnnoptr[4];	/* ptr to fcn line # */
			    char x_endndx[4];	/* entry ndx past block end */
			} x_fcn;
			struct {		/* if ISARY, up to 4 dimen. */
			    char x_dimen[E_DIMNUM][2];
			} x_ary;
		} x_fcnary;
		char x_tvndx[2];		/* tv index */
	} x_sym;

	union {
		char x_fname[E_FILNMLEN];
		struct {
			char x_zeroes[4];
			char x_offset[4];
		} x_n;
	} x_file;

	struct {
		char x_scnlen[4];			/* section length */
		char x_nreloc[2];	/* # relocation entries */
		char x_nlinno[2];	/* # line numbers */
	} x_scn;

        struct {
		char x_tvfill[4];	/* tv fill value */
		char x_tvlen[2];	/* length of .tv */
		char x_tvran[2][2];	/* tv range */
	} x_tv;		/* info about .tv section (in auxent of symbol .tv)) */

	struct {
		unsigned char x_scnlen[4];
		unsigned char x_parmhash[4];
		unsigned char x_snhash[2];
		unsigned char x_smtyp[1];
		unsigned char x_smclas[1];
		unsigned char x_stab[4];
		unsigned char x_snstab[2];
	} x_csect;

};

#define	SYMENT	struct external_syment
#define	SYMESZ	18	
#define	AUXENT	union external_auxent
#define	AUXESZ	18
#define DBXMASK 0x80		/* for dbx storage mask */
#define SYMNAME_IN_DEBUG(symptr) ((symptr)->n_sclass & DBXMASK)


/********************** RELOCATION DIRECTIVES **********************/


struct external_reloc {
  char r_vaddr[4];
  char r_symndx[4];
  char r_size[1];
  char r_type[1];
};


#define RELOC struct external_reloc
#define RELSZ 10

#define DEFAULT_DATA_SECTION_ALIGNMENT 4
#define DEFAULT_BSS_SECTION_ALIGNMENT 4
#define DEFAULT_TEXT_SECTION_ALIGNMENT 4
/* For new sections we havn't heard of before */
#define DEFAULT_SECTION_ALIGNMENT 4
Commit	Line	Data
01f873d2 ILT	1	/* IBM RS/6000 "XCOFF" file definitions for BFD.
	2	Copyright (C) 1990, 1991 Free Software Foundation, Inc.
	3	FIXME: Can someone provide a transliteration of this name into ASCII?
	4	Using the following chars caused a compiler warning on HIUX (so I replaced
	5	them with octal escapes), and isn't useful without an understanding of what
	6	character set it is.
	7	Written by Mimi Ph\373\364ng-Th\345o V\365 of IBM
	8	and John Gilmore of Cygnus Support. */
	9
	10	/******************** FILE HEADER ********************/
	11
	12	struct external_filehdr {
	13	char f_magic[2]; /* magic number */
	14	char f_nscns[2]; /* number of sections */
	15	char f_timdat[4]; /* time & date stamp */
	16	char f_symptr[4]; /* file pointer to symtab */
	17	char f_nsyms[4]; /* number of symtab entries */
	18	char f_opthdr[2]; /* sizeof(optional hdr) */
	19	char f_flags[2]; /* flags */
	20	};
	21
	22	/* IBM RS/6000 */
	23	#define U802WRMAGIC 0730 /* writeable text segments chh */
	24	#define U802ROMAGIC 0735 /* readonly sharable text segments */
	25	#define U802TOCMAGIC 0737 /* readonly text segments and TOC */
	26
	27	#define BADMAG(x) \
	28	((x).f_magic != U802ROMAGIC && (x).f_magic != U802WRMAGIC && \
	29	(x).f_magic != U802TOCMAGIC)
	30
	31	#define FILHDR struct external_filehdr
	32	#define FILHSZ sizeof(FILHDR)
	33
	34
	35	/******************** AOUT "OPTIONAL HEADER" ********************/
	36
	37
	38	typedef struct
	39	{
	40	unsigned char magic[2]; /* type of file */
	41	unsigned char vstamp[2]; /* version stamp */
	42	unsigned char tsize[4]; /* text size in bytes, padded to FW bdry */
	43	unsigned char dsize[4]; /* initialized data " " */
	44	unsigned char bsize[4]; /* uninitialized data " " */
	45	unsigned char entry[4]; /* entry pt. */
	46	unsigned char text_start[4]; /* base of text used for this file */
	47	unsigned char data_start[4]; /* base of data used for this file */
	48	unsigned char o_toc[4]; /* address of TOC */
	49	unsigned char o_snentry[2]; /* section number of entry point */
	50	unsigned char o_sntext[2]; /* section number of .text section */
	51	unsigned char o_sndata[2]; /* section number of .data section */
	52	unsigned char o_sntoc[2]; /* section number of TOC */
	53	unsigned char o_snloader[2]; /* section number of .loader section */
	54	unsigned char o_snbss[2]; /* section number of .bss section */
	55	unsigned char o_algntext[2]; /* .text alignment */
	56	unsigned char o_algndata[2]; /* .data alignment */
	57	unsigned char o_modtype[2]; /* module type (??) */
	58	unsigned char o_resv1[2]; /* reserved */
	59	unsigned char o_maxstack[4]; /* max stack size (??) */
	60	unsigned char o_maxdata[4]; /* max data size (??) */
	61	unsigned char o_resv2[12]; /* reserved */
	62	}
	63	AOUTHDR;
	64
65	#define AOUTSZ (sizeof(AOUTHDR))
66
67	#define RS6K_AOUTHDR_OMAGIC 0x0107 /* old: text & data writeable */
68	#define RS6K_AOUTHDR_NMAGIC 0x0108 /* new: text r/o, data r/w */
69	#define RS6K_AOUTHDR_ZMAGIC 0x010B /* paged: text r/o, both page-aligned */
70
71
72	/******************** SECTION HEADER ********************/
73
74
75	struct external_scnhdr {
76	char s_name[8]; /* section name */
77	char s_paddr[4]; /* physical address, aliased s_nlib */
78	char s_vaddr[4]; /* virtual address */
79	char s_size[4]; /* section size */
80	char s_scnptr[4]; /* file ptr to raw data for section */
81	char s_relptr[4]; /* file ptr to relocation */
82	char s_lnnoptr[4]; /* file ptr to line numbers */
83	char s_nreloc[2]; /* number of relocation entries */
84	char s_nlnno[2]; /* number of line number entries*/
85	char s_flags[4]; /* flags */
86	};
87
88	/*
89	* names of "special" sections
90	*/
91	#define _TEXT ".text"
92	#define _DATA ".data"
93	#define _BSS ".bss"
94	#define _PAD ".pad"
95	#define _LOADER ".loader"
96
97	#define SCNHDR struct external_scnhdr
98	#define SCNHSZ sizeof(SCNHDR)
99
100	/* XCOFF uses a special .loader section with type STYP_LOADER. */
101	#define STYP_LOADER 0x1000
102
103	/* XCOFF uses a special .debug section with type STYP_DEBUG. */
104	#define STYP_DEBUG 0x2000
105
106	/******************** LINE NUMBERS ********************/
107
108	/* 1 line number entry for every "breakpointable" source line in a section.
109	* Line numbers are grouped on a per function basis; first entry in a function
110	* grouping will have l_lnno = 0 and in place of physical address will be the
111	* symbol table index of the function name.
112	*/
113	struct external_lineno {
114	union {
115	char l_symndx[4]; /* function name symbol index, iff l_lnno == 0*/
116	char l_paddr[4]; /* (physical) address of line number */
117	} l_addr;
118	char l_lnno[2]; /* line number */
119	};
120
121
122	#define LINENO struct external_lineno
123	#define LINESZ sizeof(LINENO)
124
125
126	/******************** SYMBOLS ********************/
127
128	#define E_SYMNMLEN 8 /* # characters in a symbol name */
129	#define E_FILNMLEN 14 /* # characters in a file name */
130	#define E_DIMNUM 4 /* # array dimensions in auxiliary entry */
131
132	struct external_syment
133	{
134	union {
135	char e_name[E_SYMNMLEN];
136	struct {
137	char e_zeroes[4];
138	char e_offset[4];
139	} e;
140	} e;
141	char e_value[4];
142	char e_scnum[2];
143	char e_type[2];
144	char e_sclass[1];
145	char e_numaux[1];
146	};
147
148
149
150	#define N_BTMASK (017)
151	#define N_TMASK (060)
152	#define N_BTSHFT (4)
153	#define N_TSHIFT (2)
154
155
156	union external_auxent {
157	struct {
158	char x_tagndx[4]; /* str, un, or enum tag indx */
159	union {
160	struct {
161	char x_lnno[2]; /* declaration line number */
162	char x_size[2]; /* str/union/array size */
163	} x_lnsz;
164	char x_fsize[4]; /* size of function */
165	} x_misc;
166	union {
167	struct { /* if ISFCN, tag, or .bb */
168	char x_lnnoptr[4]; /* ptr to fcn line # */
169	char x_endndx[4]; /* entry ndx past block end */
170	} x_fcn;
171	struct { /* if ISARY, up to 4 dimen. */
172	char x_dimen[E_DIMNUM][2];
173	} x_ary;
174	} x_fcnary;
175	char x_tvndx[2]; /* tv index */
176	} x_sym;
177
178	union {
179	char x_fname[E_FILNMLEN];
180	struct {
181	char x_zeroes[4];
182	char x_offset[4];
183	} x_n;
184	} x_file;
185
186	struct {
187	char x_scnlen[4]; /* section length */
188	char x_nreloc[2]; /* # relocation entries */
189	char x_nlinno[2]; /* # line numbers */
190	} x_scn;
191
192	struct {
193	char x_tvfill[4]; /* tv fill value */
194	char x_tvlen[2]; /* length of .tv */
195	char x_tvran[2][2]; /* tv range */
196	} x_tv; /* info about .tv section (in auxent of symbol .tv)) */
197
198	struct {
199	unsigned char x_scnlen[4];
200	unsigned char x_parmhash[4];
201	unsigned char x_snhash[2];
202	unsigned char x_smtyp[1];
203	unsigned char x_smclas[1];
204	unsigned char x_stab[4];
205	unsigned char x_snstab[2];
206	} x_csect;
207
208	};
209
210	#define SYMENT struct external_syment
211	#define SYMESZ 18
212	#define AUXENT union external_auxent
213	#define AUXESZ 18
214	#define DBXMASK 0x80 /* for dbx storage mask */
215	#define SYMNAME_IN_DEBUG(symptr) ((symptr)->n_sclass & DBXMASK)
216
217
218
219	/******************** RELOCATION DIRECTIVES ********************/
220
221
222	struct external_reloc {
223	char r_vaddr[4];
224	char r_symndx[4];
225	char r_size[1];
226	char r_type[1];
227	};
228
229
230	#define RELOC struct external_reloc
231	#define RELSZ 10
232
233	#define DEFAULT_DATA_SECTION_ALIGNMENT 4
234	#define DEFAULT_BSS_SECTION_ALIGNMENT 4
235	#define DEFAULT_TEXT_SECTION_ALIGNMENT 4
236	/* For new sections we havn't heard of before */
237	#define DEFAULT_SECTION_ALIGNMENT 4