xref: /freebsd/sys/sys/imgact_aout.h (revision 29363fb446372cb3f10bc98664e9767c53fbb457)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef	_IMGACT_AOUT_H_
33 #define	_IMGACT_AOUT_H_
34 
35 #define N_GETMAGIC(ex) \
36 	( le32toh((ex).a_midmag) & 0xffff )
37 #define N_GETMID(ex) \
38 	( (N_GETMAGIC_NET(ex) == ZMAGIC) ? N_GETMID_NET(ex) : \
39 	((ex).a_midmag >> 16) & 0x03ff )
40 #define N_GETFLAG(ex) \
41 	( (N_GETMAGIC_NET(ex) == ZMAGIC) ? N_GETFLAG_NET(ex) : \
42 	((ex).a_midmag >> 26) & 0x3f )
43 #define N_SETMAGIC(ex,mag,mid,flag) \
44 	( (ex).a_midmag = htole32((((flag) & 0x3f) <<26) | \
45 	(((mid) & 0x03ff) << 16) | \
46 	((mag) & 0xffff)) )
47 
48 #define N_GETMAGIC_NET(ex) \
49 	(ntohl((ex).a_midmag) & 0xffff)
50 #define N_GETMID_NET(ex) \
51 	((ntohl((ex).a_midmag) >> 16) & 0x03ff)
52 #define N_GETFLAG_NET(ex) \
53 	((ntohl((ex).a_midmag) >> 26) & 0x3f)
54 #define N_SETMAGIC_NET(ex,mag,mid,flag) \
55 	( (ex).a_midmag = htonl( (((flag)&0x3f)<<26) | (((mid)&0x03ff)<<16) \
56 	| (((mag)&0xffff)) ) )
57 
58 #define N_ALIGN(ex,x) \
59 	(N_GETMAGIC(ex) == ZMAGIC || N_GETMAGIC(ex) == QMAGIC || \
60 	 N_GETMAGIC_NET(ex) == ZMAGIC || N_GETMAGIC_NET(ex) == QMAGIC ? \
61 	 ((x) + __LDPGSZ - 1) & ~(uint32_t)(__LDPGSZ - 1) : (x))
62 
63 /* Valid magic number check. */
64 #define	N_BADMAG(ex) \
65 	(N_GETMAGIC(ex) != OMAGIC && N_GETMAGIC(ex) != NMAGIC && \
66 	 N_GETMAGIC(ex) != ZMAGIC && N_GETMAGIC(ex) != QMAGIC && \
67 	 N_GETMAGIC_NET(ex) != OMAGIC && N_GETMAGIC_NET(ex) != NMAGIC && \
68 	 N_GETMAGIC_NET(ex) != ZMAGIC && N_GETMAGIC_NET(ex) != QMAGIC)
69 
70 /* Address of the bottom of the text segment. */
71 /*
72  * This can not be done right.  Abuse a_entry in some cases to handle kernels.
73  */
74 #define N_TXTADDR(ex) \
75 	((N_GETMAGIC(ex) == OMAGIC || N_GETMAGIC(ex) == NMAGIC || \
76 	N_GETMAGIC(ex) == ZMAGIC) ? \
77 	(le32toh((ex).a_entry) < le32toh((ex).a_text) ? 0 : \
78 	le32toh((ex).a_entry) & ~__LDPGSZ) : __LDPGSZ)
79 
80 /* Address of the bottom of the data segment. */
81 #define N_DATADDR(ex) \
82 	N_ALIGN(ex, N_TXTADDR(ex) + le32toh((ex).a_text))
83 
84 /* Text segment offset. */
85 #define	N_TXTOFF(ex) \
86 	(N_GETMAGIC(ex) == ZMAGIC ? __LDPGSZ : (N_GETMAGIC(ex) == QMAGIC || \
87 	N_GETMAGIC_NET(ex) == ZMAGIC) ? 0 : sizeof(struct exec))
88 
89 /* Data segment offset. */
90 #define	N_DATOFF(ex) \
91 	N_ALIGN(ex, N_TXTOFF(ex) + le32toh((ex).a_text))
92 
93 /* Relocation table offset. */
94 #define N_RELOFF(ex) \
95 	N_ALIGN(ex, N_DATOFF(ex) + le32toh((ex).a_data))
96 
97 /* Symbol table offset. */
98 #define N_SYMOFF(ex) \
99 	(N_RELOFF(ex) + le32toh((ex).a_trsize) + le32toh((ex).a_drsize))
100 
101 /* String table offset. */
102 #define	N_STROFF(ex) 	(N_SYMOFF(ex) + le32toh((ex).a_syms))
103 
104 /*
105  * Header prepended to each a.out file.
106  * Only manipulate the a_midmag field via the
107  * N_SETMAGIC/N_GET{MAGIC,MID,FLAG} macros.
108  */
109 
110 struct exec {
111      uint32_t	a_midmag;	/* flags<<26 | mid<<16 | magic */
112      uint32_t	a_text;		/* text segment size */
113      uint32_t	a_data;		/* initialized data size */
114      uint32_t	a_bss;		/* uninitialized data size */
115      uint32_t	a_syms;		/* symbol table size */
116      uint32_t	a_entry;	/* entry point */
117      uint32_t	a_trsize;	/* text relocation size */
118      uint32_t	a_drsize;	/* data relocation size */
119 };
120 #define a_magic a_midmag	/* Hack for emulators */
121 
122 /* a_magic */
123 #define	OMAGIC		0407	/* old impure format */
124 #define	NMAGIC		0410	/* read-only text */
125 #define	ZMAGIC		0413	/* demand load format */
126 #define QMAGIC          0314    /* "compact" demand load format */
127 
128 /* a_mid */
129 #define	MID_ZERO	0	/* unknown - implementation dependent */
130 #define	MID_SUN010	1	/* sun 68010/68020 binary */
131 #define	MID_SUN020	2	/* sun 68020-only binary */
132 #define MID_I386	134	/* i386 BSD binary */
133 #define MID_SPARC	138	/* sparc */
134 #define MID_ARM6	143	/* ARM6 */
135 #define	MID_HP200	200	/* hp200 (68010) BSD binary */
136 #define	MID_HP300	300	/* hp300 (68020+68881) BSD binary */
137 #define	MID_HPUX	0x20C	/* hp200/300 HP-UX binary */
138 #define	MID_HPUX800     0x20B   /* hp800 HP-UX binary */
139 
140 /*
141  * a_flags
142  */
143 #define EX_PIC		0x10	/* contains position independent code */
144 #define EX_DYNAMIC	0x20	/* contains run-time link-edit info */
145 #define EX_DPMASK	0x30	/* mask for the above */
146 
147 #ifdef _KERNEL
148 struct thread;
149 struct vnode;
150 
151 int	aout_coredump(struct thread *td, struct vnode *vp, off_t limit,
152     int flags);
153 #endif
154 
155 #endif /* !_IMGACT_AOUT_H_ */
156