[thirdparty/binutils-gdb.git] / include / elf / external.h

/* ELF support for BFD.
   Copyright 1991, 1992, 1993, 1995, 1997, 1998, 1999, 2001, 2003, 2005,
   2008 Free Software Foundation, Inc.

   Written by Fred Fish @ Cygnus Support, from information published
   in "UNIX System V Release 4, Programmers Guide: ANSI C and
   Programming Support Tools".

This file is part of BFD, the Binary File Descriptor library.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */


/* This file is part of ELF support for BFD, and contains the portions
   that describe how ELF is represented externally by the BFD library.
   I.E. it describes the in-file representation of ELF.  It requires
   the elf/common.h file which contains the portions that are common to
   both the internal and external representations. */

/* The 64-bit stuff is kind of random.  Perhaps someone will publish a
   spec someday.  */

#ifndef _ELF_EXTERNAL_H
#define _ELF_EXTERNAL_H

/* Special section indices, which may show up in st_shndx fields, among
   other places.  */

#define SHN_LORESERVE	0xFF00		/* Begin range of reserved indices */
#define SHN_LOPROC	0xFF00		/* Begin range of appl-specific */
#define SHN_HIPROC	0xFF1F		/* End range of appl-specific */
#define SHN_LOOS	0xFF20		/* OS specific semantics, lo */
#define SHN_HIOS	0xFF3F		/* OS specific semantics, hi */
#define SHN_ABS		0xFFF1		/* Associated symbol is absolute */
#define SHN_COMMON	0xFFF2		/* Associated symbol is in common */
#define SHN_XINDEX	0xFFFF		/* Section index is held elsewhere */
#define SHN_HIRESERVE	0xFFFF		/* End range of reserved indices */

/* ELF Header (32-bit implementations) */

typedef struct {
  unsigned char	e_ident[16];		/* ELF "magic number" */
  unsigned char	e_type[2];		/* Identifies object file type */
  unsigned char	e_machine[2];		/* Specifies required architecture */
  unsigned char	e_version[4];		/* Identifies object file version */
  unsigned char	e_entry[4];		/* Entry point virtual address */
  unsigned char	e_phoff[4];		/* Program header table file offset */
  unsigned char	e_shoff[4];		/* Section header table file offset */
  unsigned char	e_flags[4];		/* Processor-specific flags */
  unsigned char	e_ehsize[2];		/* ELF header size in bytes */
  unsigned char	e_phentsize[2];		/* Program header table entry size */
  unsigned char	e_phnum[2];		/* Program header table entry count */
  unsigned char	e_shentsize[2];		/* Section header table entry size */
  unsigned char	e_shnum[2];		/* Section header table entry count */
  unsigned char	e_shstrndx[2];		/* Section header string table index */
} Elf32_External_Ehdr;

typedef struct {
  unsigned char	e_ident[16];		/* ELF "magic number" */
  unsigned char	e_type[2];		/* Identifies object file type */
  unsigned char	e_machine[2];		/* Specifies required architecture */
  unsigned char	e_version[4];		/* Identifies object file version */
  unsigned char	e_entry[8];		/* Entry point virtual address */
  unsigned char	e_phoff[8];		/* Program header table file offset */
  unsigned char	e_shoff[8];		/* Section header table file offset */
  unsigned char	e_flags[4];		/* Processor-specific flags */
  unsigned char	e_ehsize[2];		/* ELF header size in bytes */
  unsigned char	e_phentsize[2];		/* Program header table entry size */
  unsigned char	e_phnum[2];		/* Program header table entry count */
  unsigned char	e_shentsize[2];		/* Section header table entry size */
  unsigned char	e_shnum[2];		/* Section header table entry count */
  unsigned char	e_shstrndx[2];		/* Section header string table index */
} Elf64_External_Ehdr;

/* Program header */

typedef struct {
  unsigned char	p_type[4];		/* Identifies program segment type */
  unsigned char	p_offset[4];		/* Segment file offset */
  unsigned char	p_vaddr[4];		/* Segment virtual address */
  unsigned char	p_paddr[4];		/* Segment physical address */
  unsigned char	p_filesz[4];		/* Segment size in file */
  unsigned char	p_memsz[4];		/* Segment size in memory */
  unsigned char	p_flags[4];		/* Segment flags */
  unsigned char	p_align[4];		/* Segment alignment, file & memory */
} Elf32_External_Phdr;

typedef struct {
  unsigned char	p_type[4];		/* Identifies program segment type */
  unsigned char	p_flags[4];		/* Segment flags */
  unsigned char	p_offset[8];		/* Segment file offset */
  unsigned char	p_vaddr[8];		/* Segment virtual address */
  unsigned char	p_paddr[8];		/* Segment physical address */
  unsigned char	p_filesz[8];		/* Segment size in file */
  unsigned char	p_memsz[8];		/* Segment size in memory */
  unsigned char	p_align[8];		/* Segment alignment, file & memory */
} Elf64_External_Phdr;

/* Section header */

typedef struct {
  unsigned char	sh_name[4];		/* Section name, index in string tbl */
  unsigned char	sh_type[4];		/* Type of section */
  unsigned char	sh_flags[4];		/* Miscellaneous section attributes */
  unsigned char	sh_addr[4];		/* Section virtual addr at execution */
  unsigned char	sh_offset[4];		/* Section file offset */
  unsigned char	sh_size[4];		/* Size of section in bytes */
  unsigned char	sh_link[4];		/* Index of another section */
  unsigned char	sh_info[4];		/* Additional section information */
  unsigned char	sh_addralign[4];	/* Section alignment */
  unsigned char	sh_entsize[4];		/* Entry size if section holds table */
} Elf32_External_Shdr;

typedef struct {
  unsigned char	sh_name[4];		/* Section name, index in string tbl */
  unsigned char	sh_type[4];		/* Type of section */
  unsigned char	sh_flags[8];		/* Miscellaneous section attributes */
  unsigned char	sh_addr[8];		/* Section virtual addr at execution */
  unsigned char	sh_offset[8];		/* Section file offset */
  unsigned char	sh_size[8];		/* Size of section in bytes */
  unsigned char	sh_link[4];		/* Index of another section */
  unsigned char	sh_info[4];		/* Additional section information */
  unsigned char	sh_addralign[8];	/* Section alignment */
  unsigned char	sh_entsize[8];		/* Entry size if section holds table */
} Elf64_External_Shdr;

/* Symbol table entry */

typedef struct {
  unsigned char	st_name[4];		/* Symbol name, index in string tbl */
  unsigned char	st_value[4];		/* Value of the symbol */
  unsigned char	st_size[4];		/* Associated symbol size */
  unsigned char	st_info[1];		/* Type and binding attributes */
  unsigned char	st_other[1];		/* No defined meaning, 0 */
  unsigned char	st_shndx[2];		/* Associated section index */
} Elf32_External_Sym;

typedef struct {
  unsigned char	st_name[4];		/* Symbol name, index in string tbl */
  unsigned char	st_info[1];		/* Type and binding attributes */
  unsigned char	st_other[1];		/* No defined meaning, 0 */
  unsigned char	st_shndx[2];		/* Associated section index */
  unsigned char	st_value[8];		/* Value of the symbol */
  unsigned char	st_size[8];		/* Associated symbol size */
} Elf64_External_Sym;

typedef struct {
  unsigned char est_shndx[4];		/* Section index */
} Elf_External_Sym_Shndx;

/* Note segments */

typedef struct {
  unsigned char	namesz[4];		/* Size of entry's owner string */
  unsigned char	descsz[4];		/* Size of the note descriptor */
  unsigned char	type[4];		/* Interpretation of the descriptor */
  char		name[1];		/* Start of the name+desc data */
} Elf_External_Note;

/* Relocation Entries */
typedef struct {
  unsigned char r_offset[4];	/* Location at which to apply the action */
  unsigned char	r_info[4];	/* index and type of relocation */
} Elf32_External_Rel;

typedef struct {
  unsigned char r_offset[4];	/* Location at which to apply the action */
  unsigned char	r_info[4];	/* index and type of relocation */
  unsigned char	r_addend[4];	/* Constant addend used to compute value */
} Elf32_External_Rela;

typedef struct {
  unsigned char r_offset[8];	/* Location at which to apply the action */
  unsigned char	r_info[8];	/* index and type of relocation */
} Elf64_External_Rel;

typedef struct {
  unsigned char r_offset[8];	/* Location at which to apply the action */
  unsigned char	r_info[8];	/* index and type of relocation */
  unsigned char	r_addend[8];	/* Constant addend used to compute value */
} Elf64_External_Rela;

/* dynamic section structure */

typedef struct {
  unsigned char	d_tag[4];		/* entry tag value */
  union {
    unsigned char	d_val[4];
    unsigned char	d_ptr[4];
  } d_un;
} Elf32_External_Dyn;

typedef struct {
  unsigned char	d_tag[8];		/* entry tag value */
  union {
    unsigned char	d_val[8];
    unsigned char	d_ptr[8];
  } d_un;
} Elf64_External_Dyn;

/* The version structures are currently size independent.  They are
   named without a 32 or 64.  If that ever changes, these structures
   will need to be renamed.  */

/* This structure appears in a SHT_GNU_verdef section.  */

typedef struct {
  unsigned char		vd_version[2];
  unsigned char		vd_flags[2];
  unsigned char		vd_ndx[2];
  unsigned char		vd_cnt[2];
  unsigned char		vd_hash[4];
  unsigned char		vd_aux[4];
  unsigned char		vd_next[4];
} Elf_External_Verdef;

/* This structure appears in a SHT_GNU_verdef section.  */

typedef struct {
  unsigned char		vda_name[4];
  unsigned char		vda_next[4];
} Elf_External_Verdaux;

/* This structure appears in a SHT_GNU_verneed section.  */

typedef struct {
  unsigned char		vn_version[2];
  unsigned char		vn_cnt[2];
  unsigned char		vn_file[4];
  unsigned char		vn_aux[4];
  unsigned char		vn_next[4];
} Elf_External_Verneed;

/* This structure appears in a SHT_GNU_verneed section.  */

typedef struct {
  unsigned char		vna_hash[4];
  unsigned char		vna_flags[2];
  unsigned char		vna_other[2];
  unsigned char		vna_name[4];
  unsigned char		vna_next[4];
} Elf_External_Vernaux;

/* This structure appears in a SHT_GNU_versym section.  This is not a
   standard ELF structure; ELF just uses Elf32_Half.  */

typedef struct {
  unsigned char		vs_vers[2];
} ATTRIBUTE_PACKED  Elf_External_Versym;

/* Structure for syminfo section.  */
typedef struct
{
  unsigned char		si_boundto[2];
  unsigned char		si_flags[2];
} Elf_External_Syminfo;


/* This structure appears on the stack and in NT_AUXV core file notes.  */
typedef struct
{
  unsigned char		a_type[4];
  unsigned char		a_val[4];
} Elf32_External_Auxv;

typedef struct
{
  unsigned char		a_type[8];
  unsigned char		a_val[8];
} Elf64_External_Auxv;

/* Size of SHT_GROUP section entry.  */

#define GRP_ENTRY_SIZE		4

#endif /* _ELF_EXTERNAL_H */
Commit	Line	Data
252b5132	1	/* ELF support for BFD.
4fbb74a6 AM	2	Copyright 1991, 1992, 1993, 1995, 1997, 1998, 1999, 2001, 2003, 2005,
4fbb74a6 AM	3	2008 Free Software Foundation, Inc.
252b5132 RH	4
	5	Written by Fred Fish @ Cygnus Support, from information published
	6	in "UNIX System V Release 4, Programmers Guide: ANSI C and
	7	Programming Support Tools".
	8
	9	This file is part of BFD, the Binary File Descriptor library.
	10
	11	This program is free software; you can redistribute it and/or modify
	12	it under the terms of the GNU General Public License as published by
	13	the Free Software Foundation; either version 2 of the License, or
	14	(at your option) any later version.
	15
	16	This program is distributed in the hope that it will be useful,
	17	but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	GNU General Public License for more details.
	20
	21	You should have received a copy of the GNU General Public License
	22	along with this program; if not, write to the Free Software
e172dbf8	23	Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
252b5132 RH	24
	25
	26	/* This file is part of ELF support for BFD, and contains the portions
	27	that describe how ELF is represented externally by the BFD library.
	28	I.E. it describes the in-file representation of ELF. It requires
ae990a1a	29	the elf/common.h file which contains the portions that are common to
252b5132 RH	30	both the internal and external representations. */
	31
	32	/* The 64-bit stuff is kind of random. Perhaps someone will publish a
	33	spec someday. */
	34
	35	#ifndef _ELF_EXTERNAL_H
	36	#define _ELF_EXTERNAL_H
	37
4fbb74a6 AM	38	/* Special section indices, which may show up in st_shndx fields, among
	39	other places. */
	40
	41	#define SHN_LORESERVE 0xFF00 /* Begin range of reserved indices */
	42	#define SHN_LOPROC 0xFF00 /* Begin range of appl-specific */
	43	#define SHN_HIPROC 0xFF1F /* End range of appl-specific */
	44	#define SHN_LOOS 0xFF20 /* OS specific semantics, lo */
	45	#define SHN_HIOS 0xFF3F /* OS specific semantics, hi */
	46	#define SHN_ABS 0xFFF1 /* Associated symbol is absolute */
	47	#define SHN_COMMON 0xFFF2 /* Associated symbol is in common */
	48	#define SHN_XINDEX 0xFFFF /* Section index is held elsewhere */
	49	#define SHN_HIRESERVE 0xFFFF /* End range of reserved indices */
	50
252b5132 RH	51	/* ELF Header (32-bit implementations) */
	52
	53	typedef struct {
	54	unsigned char e_ident[16]; /* ELF "magic number" */
	55	unsigned char e_type[2]; /* Identifies object file type */
	56	unsigned char e_machine[2]; /* Specifies required architecture */
	57	unsigned char e_version[4]; /* Identifies object file version */
	58	unsigned char e_entry[4]; /* Entry point virtual address */
	59	unsigned char e_phoff[4]; /* Program header table file offset */
	60	unsigned char e_shoff[4]; /* Section header table file offset */
	61	unsigned char e_flags[4]; /* Processor-specific flags */
	62	unsigned char e_ehsize[2]; /* ELF header size in bytes */
	63	unsigned char e_phentsize[2]; /* Program header table entry size */
	64	unsigned char e_phnum[2]; /* Program header table entry count */
	65	unsigned char e_shentsize[2]; /* Section header table entry size */
	66	unsigned char e_shnum[2]; /* Section header table entry count */
	67	unsigned char e_shstrndx[2]; /* Section header string table index */
	68	} Elf32_External_Ehdr;
	69
	70	typedef struct {
	71	unsigned char e_ident[16]; /* ELF "magic number" */
	72	unsigned char e_type[2]; /* Identifies object file type */
	73	unsigned char e_machine[2]; /* Specifies required architecture */
	74	unsigned char e_version[4]; /* Identifies object file version */
	75	unsigned char e_entry[8]; /* Entry point virtual address */
	76	unsigned char e_phoff[8]; /* Program header table file offset */
	77	unsigned char e_shoff[8]; /* Section header table file offset */
	78	unsigned char e_flags[4]; /* Processor-specific flags */
	79	unsigned char e_ehsize[2]; /* ELF header size in bytes */
	80	unsigned char e_phentsize[2]; /* Program header table entry size */
	81	unsigned char e_phnum[2]; /* Program header table entry count */
	82	unsigned char e_shentsize[2]; /* Section header table entry size */
	83	unsigned char e_shnum[2]; /* Section header table entry count */
	84	unsigned char e_shstrndx[2]; /* Section header string table index */
	85	} Elf64_External_Ehdr;
	86
	87	/* Program header */
	88
	89	typedef struct {
	90	unsigned char p_type[4]; /* Identifies program segment type */
	91	unsigned char p_offset[4]; /* Segment file offset */
	92	unsigned char p_vaddr[4]; /* Segment virtual address */
	93	unsigned char p_paddr[4]; /* Segment physical address */
	94	unsigned char p_filesz[4]; /* Segment size in file */
	95	unsigned char p_memsz[4]; /* Segment size in memory */
	96	unsigned char p_flags[4]; /* Segment flags */
	97	unsigned char p_align[4]; /* Segment alignment, file & memory */
	98	} Elf32_External_Phdr;
	99
	100	typedef struct {
	101	unsigned char p_type[4]; /* Identifies program segment type */
	102	unsigned char p_flags[4]; /* Segment flags */
	103	unsigned char p_offset[8]; /* Segment file offset */
	104	unsigned char p_vaddr[8]; /* Segment virtual address */
	105	unsigned char p_paddr[8]; /* Segment physical address */
	106	unsigned char p_filesz[8]; /* Segment size in file */
	107	unsigned char p_memsz[8]; /* Segment size in memory */
	108	unsigned char p_align[8]; /* Segment alignment, file & memory */
	109	} Elf64_External_Phdr;
	110
	111	/* Section header */
	112
	113	typedef struct {
	114	unsigned char sh_name[4]; /* Section name, index in string tbl */
115	unsigned char sh_type[4]; /* Type of section */
116	unsigned char sh_flags[4]; /* Miscellaneous section attributes */
117	unsigned char sh_addr[4]; /* Section virtual addr at execution */
118	unsigned char sh_offset[4]; /* Section file offset */
119	unsigned char sh_size[4]; /* Size of section in bytes */
120	unsigned char sh_link[4]; /* Index of another section */
121	unsigned char sh_info[4]; /* Additional section information */
122	unsigned char sh_addralign[4]; /* Section alignment */
123	unsigned char sh_entsize[4]; /* Entry size if section holds table */
124	} Elf32_External_Shdr;
125
126	typedef struct {
127	unsigned char sh_name[4]; /* Section name, index in string tbl */
128	unsigned char sh_type[4]; /* Type of section */
129	unsigned char sh_flags[8]; /* Miscellaneous section attributes */
130	unsigned char sh_addr[8]; /* Section virtual addr at execution */
131	unsigned char sh_offset[8]; /* Section file offset */
132	unsigned char sh_size[8]; /* Size of section in bytes */
133	unsigned char sh_link[4]; /* Index of another section */
134	unsigned char sh_info[4]; /* Additional section information */
135	unsigned char sh_addralign[8]; /* Section alignment */
136	unsigned char sh_entsize[8]; /* Entry size if section holds table */
137	} Elf64_External_Shdr;
138
139	/* Symbol table entry */
140
141	typedef struct {
142	unsigned char st_name[4]; /* Symbol name, index in string tbl */
143	unsigned char st_value[4]; /* Value of the symbol */
144	unsigned char st_size[4]; /* Associated symbol size */
145	unsigned char st_info[1]; /* Type and binding attributes */
146	unsigned char st_other[1]; /* No defined meaning, 0 */
147	unsigned char st_shndx[2]; /* Associated section index */
148	} Elf32_External_Sym;
149
150	typedef struct {
151	unsigned char st_name[4]; /* Symbol name, index in string tbl */
152	unsigned char st_info[1]; /* Type and binding attributes */
153	unsigned char st_other[1]; /* No defined meaning, 0 */
154	unsigned char st_shndx[2]; /* Associated section index */
155	unsigned char st_value[8]; /* Value of the symbol */
156	unsigned char st_size[8]; /* Associated symbol size */
157	} Elf64_External_Sym;
158
9ad5cbcf AM	159	typedef struct {
	160	unsigned char est_shndx[4]; /* Section index */
	161	} Elf_External_Sym_Shndx;
	162
252b5132 RH	163	/* Note segments */
	164
	165	typedef struct {
	166	unsigned char namesz[4]; /* Size of entry's owner string */
	167	unsigned char descsz[4]; /* Size of the note descriptor */
	168	unsigned char type[4]; /* Interpretation of the descriptor */
	169	char name[1]; /* Start of the name+desc data */
	170	} Elf_External_Note;
	171
	172	/* Relocation Entries */
	173	typedef struct {
	174	unsigned char r_offset[4]; /* Location at which to apply the action */
	175	unsigned char r_info[4]; /* index and type of relocation */
	176	} Elf32_External_Rel;
	177
	178	typedef struct {
	179	unsigned char r_offset[4]; /* Location at which to apply the action */
	180	unsigned char r_info[4]; /* index and type of relocation */
	181	unsigned char r_addend[4]; /* Constant addend used to compute value */
	182	} Elf32_External_Rela;
	183
	184	typedef struct {
	185	unsigned char r_offset[8]; /* Location at which to apply the action */
	186	unsigned char r_info[8]; /* index and type of relocation */
	187	} Elf64_External_Rel;
	188
	189	typedef struct {
	190	unsigned char r_offset[8]; /* Location at which to apply the action */
	191	unsigned char r_info[8]; /* index and type of relocation */
	192	unsigned char r_addend[8]; /* Constant addend used to compute value */
	193	} Elf64_External_Rela;
	194
	195	/* dynamic section structure */
	196
	197	typedef struct {
	198	unsigned char d_tag[4]; /* entry tag value */
	199	union {
	200	unsigned char d_val[4];
	201	unsigned char d_ptr[4];
	202	} d_un;
	203	} Elf32_External_Dyn;
	204
	205	typedef struct {
	206	unsigned char d_tag[8]; /* entry tag value */
	207	union {
	208	unsigned char d_val[8];
	209	unsigned char d_ptr[8];
	210	} d_un;
	211	} Elf64_External_Dyn;
	212
	213	/* The version structures are currently size independent. They are
	214	named without a 32 or 64. If that ever changes, these structures
	215	will need to be renamed. */
	216
	217	/* This structure appears in a SHT_GNU_verdef section. */
	218
	219	typedef struct {
	220	unsigned char vd_version[2];
	221	unsigned char vd_flags[2];
	222	unsigned char vd_ndx[2];
	223	unsigned char vd_cnt[2];
	224	unsigned char vd_hash[4];
	225	unsigned char vd_aux[4];
	226	unsigned char vd_next[4];
227	} Elf_External_Verdef;
228
229	/* This structure appears in a SHT_GNU_verdef section. */
230
231	typedef struct {
232	unsigned char vda_name[4];
233	unsigned char vda_next[4];
234	} Elf_External_Verdaux;
235
236	/* This structure appears in a SHT_GNU_verneed section. */
237
238	typedef struct {
239	unsigned char vn_version[2];
240	unsigned char vn_cnt[2];
241	unsigned char vn_file[4];
242	unsigned char vn_aux[4];
243	unsigned char vn_next[4];
244	} Elf_External_Verneed;
245
246	/* This structure appears in a SHT_GNU_verneed section. */
247
248	typedef struct {
249	unsigned char vna_hash[4];
250	unsigned char vna_flags[2];
251	unsigned char vna_other[2];
252	unsigned char vna_name[4];
253	unsigned char vna_next[4];
254	} Elf_External_Vernaux;
255
256	/* This structure appears in a SHT_GNU_versym section. This is not a
257	standard ELF structure; ELF just uses Elf32_Half. */
258
259	typedef struct {
260	unsigned char vs_vers[2];
4fd454c8	261	} ATTRIBUTE_PACKED Elf_External_Versym;
252b5132 RH	262
	263	/* Structure for syminfo section. */
	264	typedef struct
	265	{
	266	unsigned char si_boundto[2];
	267	unsigned char si_flags[2];
	268	} Elf_External_Syminfo;
	269
eecca0f7 RM	270
	271	/* This structure appears on the stack and in NT_AUXV core file notes. */
	272	typedef struct
	273	{
	274	unsigned char a_type[4];
	275	unsigned char a_val[4];
	276	} Elf32_External_Auxv;
	277
	278	typedef struct
	279	{
	280	unsigned char a_type[8];
	281	unsigned char a_val[8];
	282	} Elf64_External_Auxv;
	283
08d8fa11 JJ	284	/* Size of SHT_GROUP section entry. */
	285
	286	#define GRP_ENTRY_SIZE 4
eecca0f7	287
252b5132	288	#endif /* _ELF_EXTERNAL_H */