xref: /plan9-contrib/sys/include/mach.h (revision ce95e1b3727b9cb1c223ffbed69aff21a8ced255)
1 /*
2  *	Architecture-dependent application data
3  */
4 #include "a.out.h"
5 #pragma	src	"/sys/src/libmach"
6 #pragma	lib	"libmach.a"
7 /*
8  *	Supported architectures:
9  *		mips,
10  *		68020,
11  *		i386,
12  *		amd64,
13  *		sparc,
14  *		mips2 (R4000)
15  *		arm
16  *		powerpc,
17  *		powerpc64
18  *		arm64
19  *		riscv
20  *		riscv64
21  */
22 enum
23 {
24 	MMIPS,			/* machine types */
25 	MSPARC,
26 	M68020,
27 	MI386,
28 	MI960,			/* retired */
29 	M3210,			/* retired */
30 	MMIPS2,
31 	NMIPS2,
32 	M29000,			/* retired */
33 	MARM,
34 	MPOWER,
35 	MALPHA,			/* retired */
36 	NMIPS,
37 	MSPARC64,		/* retired */
38 	MAMD64,
39 	MPOWER64,
40 	MARM64,
41 	MRISCV,
42 	MRISCV64,
43 				/* types of executables */
44 	FNONE = 0,		/* unidentified */
45 	FMIPS,			/* v.out */
46 	FMIPSB,			/* mips bootable */
47 	FSPARC,			/* k.out */
48 	FSPARCB,		/* Sparc bootable */
49 	F68020,			/* 2.out */
50 	F68020B,		/* 68020 bootable */
51 	FNEXTB,			/* Next bootable */
52 	FI386,			/* 8.out */
53 	FI386B,			/* I386 bootable */
54 	FI960,			/* retired */
55 	FI960B,			/* retired */
56 	F3210,			/* retired */
57 	FMIPS2BE,		/* 4.out */
58 	F29000,			/* retired */
59 	FARM,			/* 5.out */
60 	FARMB,			/* ARM bootable */
61 	FPOWER,			/* q.out */
62 	FPOWERB,		/* power pc bootable */
63 	FMIPS2LE,		/* 0.out */
64 	FALPHA,			/* retired */
65 	FALPHAB,		/* retired DEC Alpha bootable */
66 	FMIPSLE,		/* 3k little endian */
67 	FSPARC64,		/* retired */
68 	FAMD64,			/* 6.out */
69 	FAMD64B,		/* 6.out bootable */
70 	FPOWER64,		/* 9.out */
71 	FPOWER64B,		/* 9.out bootable */
72 	FARM64,			/* arm64 */
73 	FARM64B,		/* arm64 bootable */
74 	FRISCV,			/* riscv */
75 	FRISCVB,		/* riscv bootable */
76 	FRISCV64,		/* riscv64 */
77 	FRISCV64B,		/* riscv64 bootable */
78 
79 	ANONE = 0,		/* dissembler types */
80 	AMIPS,
81 	AMIPSCO,		/* native mips */
82 	ASPARC,
83 	ASUNSPARC,		/* native sun */
84 	A68020,
85 	AI386,
86 	AI8086,			/* oh god */
87 	AI960,			/* retired */
88 	A29000,			/* retired */
89 	AARM,
90 	APOWER,
91 	AALPHA,			/* retired */
92 	ASPARC64,		/* retired */
93 	AAMD64,
94 	APOWER64,
95 	AARM64,
96 	ARISCV,
97 	ARISCV64,
98 				/* object file types */
99 	Obj68020 = 0,		/* .2 */
100 	ObjSparc,		/* .k */
101 	ObjMips,		/* .v */
102 	Obj386,			/* .8 */
103 	Obj960,			/* retired */
104 	Obj3210,		/* retired */
105 	ObjMips2,		/* .4 */
106 	Obj29000,		/* retired */
107 	ObjArm,			/* .5 */
108 	ObjPower,		/* .q */
109 	ObjMips2le,		/* .0 */
110 	ObjAlpha,		/* retired */
111 	ObjSparc64,		/* retired */
112 	ObjAmd64,		/* .6 */
113 	ObjSpim,		/* .0 */
114 	ObjPower64,		/* .9 */
115 	ObjArm64,		/* .4? */
116 	ObjRiscv,		/* .i */
117 	ObjRiscv64,		/* .j */
118 	Maxobjtype,
119 
120 	CNONE  = 0,		/* symbol table classes */
121 	CAUTO,
122 	CPARAM,
123 	CSTAB,
124 	CTEXT,
125 	CDATA,
126 	CANY,			/* to look for any class */
127 };
128 
129 typedef	struct	Map	Map;
130 typedef struct	Symbol	Symbol;
131 typedef	struct	Reglist	Reglist;
132 typedef	struct	Mach	Mach;
133 typedef	struct	Machdata Machdata;
134 
135 /*
136  * 	Structure to map a segment to a position in a file
137  */
138 struct Map {
139 	int	nsegs;			/* number of segments */
140 	struct segment {		/* per-segment map */
141 		char	*name;		/* the segment name */
142 		int	fd;		/* file descriptor */
143 		int	inuse;		/* in use - not in use */
144 		int	cache;		/* should cache reads? */
145 		uvlong	b;		/* base */
146 		uvlong	e;		/* end */
147 		vlong	f;		/* offset within file */
148 	} seg[1];			/* actually n of these */
149 };
150 
151 /*
152  *	Internal structure describing a symbol table entry
153  */
154 struct Symbol {
155 	void 	*handle;		/* used internally - owning func */
156 	struct {
157 		char	*name;
158 		vlong	value;		/* address or stack offset */
159 		char	type;		/* as in a.out.h */
160 		char	class;		/* as above */
161 		int	index;		/* in findlocal, globalsym, textsym */
162 	};
163 };
164 
165 /*
166  *	machine register description
167  */
168 struct Reglist {
169 	char	*rname;			/* register name */
170 	short	roffs;			/* offset in u-block */
171 	char	rflags;			/* INTEGER/FLOAT, WRITABLE */
172 	char	rformat;		/* print format: 'x', 'X', 'f', '8', '3', 'Y', 'W' */
173 };
174 
175 enum {					/* bits in rflags field */
176 	RINT	= (0<<0),
177 	RFLT	= (1<<0),
178 	RRDONLY	= (1<<1),
179 };
180 
181 /*
182  *	Machine-dependent data is stored in two structures:
183  *		Mach  - miscellaneous general parameters
184  *		Machdata - jump vector of service functions used by debuggers
185  *
186  *	Mach is defined in ?.c and set in executable.c
187  *
188  *	Machdata is defined in ?db.c
189  *		and set in the debugger startup.
190  */
191 struct Mach{
192 	char	*name;
193 	int	mtype;			/* machine type code */
194 	Reglist *reglist;		/* register set */
195 	long	regsize;		/* sizeof registers in bytes */
196 	long	fpregsize;		/* sizeof fp registers in bytes */
197 	char	*pc;			/* pc name */
198 	char	*sp;			/* sp name */
199 	char	*link;			/* link register name */
200 	char	*sbreg;			/* static base register name */
201 	uvlong	sb;			/* static base register value */
202 	int	pgsize;			/* page size */
203 	uvlong	kbase;			/* kernel base address */
204 	uvlong	ktmask;			/* ktzero = kbase & ~ktmask */
205 	uvlong	utop;			/* user stack top */
206 	int	pcquant;		/* quantization of pc */
207 	int	szaddr;			/* sizeof(void*) */
208 	int	szreg;			/* sizeof(register) */
209 	int	szfloat;		/* sizeof(float) */
210 	int	szdouble;		/* sizeof(double) */
211 };
212 
213 extern	Mach	*mach;			/* Current machine */
214 
215 typedef uvlong	(*Rgetter)(Map*, char*);
216 typedef	void	(*Tracer)(Map*, uvlong, uvlong, Symbol*);
217 
218 struct	Machdata {		/* Machine-dependent debugger support */
219 	uchar	bpinst[4];			/* break point instr. */
220 	short	bpsize;				/* size of break point instr. */
221 
222 	ushort	(*swab)(ushort);		/* ushort to local byte order */
223 	ulong	(*swal)(ulong);			/* ulong to local byte order */
224 	uvlong	(*swav)(uvlong);		/* uvlong to local byte order */
225 	int	(*ctrace)(Map*, uvlong, uvlong, uvlong, Tracer); /* C traceback */
226 	uvlong	(*findframe)(Map*, uvlong, uvlong, uvlong, uvlong);/* frame finder */
227 	char*	(*excep)(Map*, Rgetter);	/* last exception */
228 	ulong	(*bpfix)(uvlong);		/* breakpoint fixup */
229 	int	(*sftos)(char*, int, void*);	/* single precision float */
230 	int	(*dftos)(char*, int, void*);	/* double precision float */
231 	int	(*foll)(Map*, uvlong, Rgetter, uvlong*);/* follow set */
232 	int	(*das)(Map*, uvlong, char, char*, int);	/* symbolic disassembly */
233 	int	(*hexinst)(Map*, uvlong, char*, int); 	/* hex disassembly */
234 	int	(*instsize)(Map*, uvlong);	/* instruction size */
235 };
236 
237 /*
238  *	Common a.out header describing all architectures
239  */
240 typedef struct Fhdr
241 {
242 	char	*name;		/* identifier of executable */
243 	uchar	type;		/* file type - see codes above */
244 	uchar	hdrsz;		/* header size */
245 	uchar	_magic;		/* _MAGIC() magic */
246 	uchar	spare;
247 	long	magic;		/* magic number */
248 	uvlong	txtaddr;	/* text address */
249 	vlong	txtoff;		/* start of text in file */
250 	uvlong	dataddr;	/* start of data segment */
251 	vlong	datoff;		/* offset to data seg in file */
252 	vlong	symoff;		/* offset of symbol table in file */
253 	uvlong	entry;		/* entry point */
254 	vlong	sppcoff;	/* offset of sp-pc table in file */
255 	vlong	lnpcoff;	/* offset of line number-pc table in file */
256 	long	txtsz;		/* text size */
257 	long	datsz;		/* size of data seg */
258 	long	bsssz;		/* size of bss */
259 	long	symsz;		/* size of symbol table */
260 	long	sppcsz;		/* size of sp-pc table */
261 	long	lnpcsz;		/* size of line number-pc table */
262 } Fhdr;
263 
264 extern	int	asstype;	/* dissembler type - machdata.c */
265 extern	Machdata *machdata;	/* jump vector - machdata.c */
266 
267 Map*		attachproc(int, int, int, Fhdr*);
268 int		beieee80ftos(char*, int, void*);
269 int		beieeesftos(char*, int, void*);
270 int		beieeedftos(char*, int, void*);
271 ushort		beswab(ushort);
272 ulong		beswal(ulong);
273 uvlong		beswav(uvlong);
274 uvlong		ciscframe(Map*, uvlong, uvlong, uvlong, uvlong);
275 int		cisctrace(Map*, uvlong, uvlong, uvlong, Tracer);
276 int		crackhdr(int fd, Fhdr*);
277 uvlong		file2pc(char*, long);
278 int		fileelem(Sym**, uchar *, char*, int);
279 long		fileline(char*, int, uvlong);
280 int		filesym(int, char*, int);
281 int		findlocal(Symbol*, char*, Symbol*);
282 int		findseg(Map*, char*);
283 int		findsym(uvlong, int, Symbol *);
284 int		fnbound(uvlong, uvlong*);
285 int		fpformat(Map*, Reglist*, char*, int, int);
286 int		get1(Map*, uvlong, uchar*, int);
287 int		get2(Map*, uvlong, ushort*);
288 int		get4(Map*, uvlong, ulong*);
289 int		get8(Map*, uvlong, uvlong*);
290 int		geta(Map*, uvlong, uvlong*);
291 int		getauto(Symbol*, int, int, Symbol*);
292 Sym*		getsym(int);
293 int		globalsym(Symbol *, int);
294 char*		_hexify(char*, ulong, int);
295 int		ieeesftos(char*, int, ulong);
296 int		ieeedftos(char*, int, ulong, ulong);
297 int		isar(Biobuf*);
298 int		leieee80ftos(char*, int, void*);
299 int		leieeesftos(char*, int, void*);
300 int		leieeedftos(char*, int, void*);
301 ushort		leswab(ushort);
302 ulong		leswal(ulong);
303 uvlong		leswav(uvlong);
304 uvlong		line2addr(long, uvlong, uvlong);
305 Map*		loadmap(Map*, int, Fhdr*);
306 int		localaddr(Map*, char*, char*, uvlong*, Rgetter);
307 int		localsym(Symbol*, int);
308 int		lookup(char*, char*, Symbol*);
309 void		machbytype(int);
310 int		machbyname(char*);
311 int		nextar(Biobuf*, int, char*);
312 Map*		newmap(Map*, int);
313 void		objtraverse(void(*)(Sym*, void*), void*);
314 int		objtype(Biobuf*, char**);
315 uvlong		pc2sp(uvlong);
316 long		pc2line(uvlong);
317 int		put1(Map*, uvlong, uchar*, int);
318 int		put2(Map*, uvlong, ushort);
319 int		put4(Map*, uvlong, ulong);
320 int		put8(Map*, uvlong, uvlong);
321 int		puta(Map*, uvlong, uvlong);
322 int		readar(Biobuf*, int, vlong, int);
323 int		readobj(Biobuf*, int);
324 uvlong		riscframe(Map*, uvlong, uvlong, uvlong, uvlong);
325 int		risctrace(Map*, uvlong, uvlong, uvlong, Tracer);
326 int		setmap(Map*, int, uvlong, uvlong, vlong, char*);
327 Sym*		symbase(long*);
328 int		syminit(int, Fhdr*);
329 int		symoff(char*, int, uvlong, int);
330 void		textseg(uvlong, Fhdr*);
331 int		textsym(Symbol*, int);
332 void		unusemap(Map*, int);
333