xref: /netbsd-src/usr.bin/kdump/setemul.c (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: setemul.c,v 1.20 2005/01/15 17:55:38 jdolecek Exp $	*/
2 
3 /*-
4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
5  * 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. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the NetBSD
18  *	Foundation, Inc. and its contributors.
19  * 4. Neither the name of The NetBSD Foundation nor the names of its
20  *    contributors may be used to endorse or promote products derived
21  *    from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 /*
37  * Copyright (c) 1988, 1993
38  *	The Regents of the University of California.  All rights reserved.
39  * (c) UNIX System Laboratories, Inc.
40  * All or some portions of this file are derived from material licensed
41  * to the University of California by American Telephone and Telegraph
42  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
43  * the permission of UNIX System Laboratories, Inc.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  * 1. Redistributions of source code must retain the above copyright
49  *    notice, this list of conditions and the following disclaimer.
50  * 2. Redistributions in binary form must reproduce the above copyright
51  *    notice, this list of conditions and the following disclaimer in the
52  *    documentation and/or other materials provided with the distribution.
53  * 3. Neither the name of the University nor the names of its contributors
54  *    may be used to endorse or promote products derived from this software
55  *    without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
58  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
60  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
61  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
62  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
63  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
64  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
65  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67  * SUCH DAMAGE.
68  */
69 
70 #include <sys/cdefs.h>
71 #ifndef lint
72 __RCSID("$NetBSD: setemul.c,v 1.20 2005/01/15 17:55:38 jdolecek Exp $");
73 #endif /* not lint */
74 
75 #include <sys/param.h>
76 #include <sys/errno.h>
77 #include <sys/time.h>
78 #include <sys/queue.h>
79 
80 #include <err.h>
81 #include <stdio.h>
82 #include <stdlib.h>
83 #include <string.h>
84 #include <unistd.h>
85 #include <vis.h>
86 
87 #include "setemul.h"
88 
89 #include <sys/syscall.h>
90 
91 #include "../../sys/compat/netbsd32/netbsd32_syscall.h"
92 #include "../../sys/compat/freebsd/freebsd_syscall.h"
93 #include "../../sys/compat/hpux/hpux_syscall.h"
94 #include "../../sys/compat/ibcs2/ibcs2_syscall.h"
95 #include "../../sys/compat/irix/irix_syscall.h"
96 #include "../../sys/compat/linux/linux_syscall.h"
97 #include "../../sys/compat/mach/mach_syscall.h"
98 #include "../../sys/compat/darwin/darwin_syscall.h"
99 #include "../../sys/compat/mach/arch/powerpc/ppccalls/mach_ppccalls_syscall.h"
100 #include "../../sys/compat/mach/arch/powerpc/fasttraps/mach_fasttraps_syscall.h"
101 #include "../../sys/compat/osf1/osf1_syscall.h"
102 #include "../../sys/compat/sunos32/sunos32_syscall.h"
103 #include "../../sys/compat/sunos/sunos_syscall.h"
104 #include "../../sys/compat/svr4/svr4_syscall.h"
105 #include "../../sys/compat/svr4_32/svr4_32_syscall.h"
106 #include "../../sys/compat/ultrix/ultrix_syscall.h"
107 
108 #define KTRACE
109 #include "../../sys/kern/syscalls.c"
110 
111 #include "../../sys/compat/netbsd32/netbsd32_syscalls.c"
112 #include "../../sys/compat/freebsd/freebsd_syscalls.c"
113 #include "../../sys/compat/hpux/hpux_syscalls.c"
114 #include "../../sys/compat/ibcs2/ibcs2_syscalls.c"
115 #include "../../sys/compat/irix/irix_syscalls.c"
116 #include "../../sys/compat/linux/linux_syscalls.c"
117 #include "../../sys/compat/darwin/darwin_syscalls.c"
118 #include "../../sys/compat/mach/mach_syscalls.c"
119 #include "../../sys/compat/mach/arch/powerpc/ppccalls/mach_ppccalls_syscalls.c"
120 #include "../../sys/compat/mach/arch/powerpc/fasttraps/mach_fasttraps_syscalls.c"
121 #include "../../sys/compat/osf1/osf1_syscalls.c"
122 #include "../../sys/compat/sunos/sunos_syscalls.c"
123 #include "../../sys/compat/sunos32/sunos32_syscalls.c"
124 #include "../../sys/compat/svr4/svr4_syscalls.c"
125 #include "../../sys/compat/svr4_32/svr4_32_syscalls.c"
126 #include "../../sys/compat/ultrix/ultrix_syscalls.c"
127 
128 #include "../../sys/compat/hpux/hpux_errno.c"
129 #include "../../sys/compat/svr4/svr4_errno.c"
130 #include "../../sys/compat/ibcs2/ibcs2_errno.c"
131 #include "../../sys/compat/irix/irix_errno.c"
132 #include "../../sys/compat/osf1/osf1_errno.c"
133 #include "../../sys/compat/linux/common/linux_errno.c"
134 #undef KTRACE
135 
136 #define SIGRTMIN	33	/* XXX */
137 #include "../../sys/compat/hpux/hpux_signo.c"
138 #include "../../sys/compat/svr4/svr4_signo.c"
139 #include "../../sys/compat/ibcs2/ibcs2_signo.c"
140 /* irix uses svr4 */
141 #include "../../sys/compat/osf1/osf1_signo.c"
142 #include "../../sys/compat/linux/common/linux_signo.c"
143 
144 /* For Mach services names in MMSG traces */
145 #ifndef LETS_GET_SMALL
146 #include "../../sys/compat/mach/mach_services_names.c"
147 #endif
148 
149 #define NELEM(a) (sizeof(a) / sizeof(a[0]))
150 
151 /* static */
152 const struct emulation emulations[] = {
153 	{ "netbsd",	syscallnames,		SYS_MAXSYSCALL,
154 	  NULL,				0,
155 	  NULL,				0,	0 },
156 
157 	{ "netbsd32",	netbsd32_syscallnames,	SYS_MAXSYSCALL,
158 	  NULL,				0,
159 	  NULL,				0,	EMUL_FLAG_NETBSD32 },
160 
161 	{ "freebsd",	freebsd_syscallnames,	FREEBSD_SYS_MAXSYSCALL,
162 	  NULL,				0,
163 	  NULL,				0,	0 },
164 
165 	{ "hpux",	hpux_syscallnames,	HPUX_SYS_MAXSYSCALL,
166 	  native_to_hpux_errno,		NELEM(native_to_hpux_errno),
167 	  hpux_to_native_signo,		NSIG,	0 },
168 
169 	{ "ibcs2",	ibcs2_syscallnames,	IBCS2_SYS_MAXSYSCALL,
170 	  native_to_ibcs2_errno,	NELEM(native_to_ibcs2_errno),
171 	  ibcs2_to_native_signo,	NSIG,	0 },
172 
173 	{ "irix o32",	irix_syscallnames,	IRIX_SYS_MAXSYSCALL,
174 	  native_to_irix_errno,		NELEM(native_to_irix_errno),
175 	  svr4_to_native_signo,		NSIG,	0 },
176 
177 	{ "irix n32",	irix_syscallnames,	IRIX_SYS_MAXSYSCALL,
178 	  native_to_irix_errno,		NELEM(native_to_irix_errno),
179 	  svr4_to_native_signo,		NSIG,	0 },
180 
181 	{ "linux",	linux_syscallnames,	LINUX_SYS_MAXSYSCALL,
182 	  native_to_linux_errno,	NELEM(native_to_linux_errno),
183 	  linux_to_native_signo,	NSIG,	0 },
184 
185 	{ "darwin",	darwin_syscallnames,	DARWIN_SYS_MAXSYSCALL,
186 	  NULL,				0,
187 	  NULL,				0,	0 },
188 
189 	{ "mach",	mach_syscallnames,	MACH_SYS_MAXSYSCALL,
190 	  NULL,				0,
191 	  NULL,				0,	0 },
192 
193 	{ "mach ppccalls",	mach_ppccalls_syscallnames,
194 	  MACH_PPCCALLS_SYS_MAXSYSCALL,
195 	  NULL,				0,
196 	  NULL,				0,	0 },
197 
198 	{ "mach fasttraps",	mach_fasttraps_syscallnames,
199 	  MACH_FASTTRAPS_SYS_MAXSYSCALL,
200 	  NULL,				0,
201 	  NULL,				0,	0 },
202 
203 	{ "osf1",	osf1_syscallnames,	OSF1_SYS_MAXSYSCALL,
204 	  native_to_osf1_errno,		NELEM(native_to_osf1_errno),
205 	  osf1_to_native_signo,		NSIG,	0 },
206 
207 	{ "sunos32",	sunos32_syscallnames,	SUNOS32_SYS_MAXSYSCALL,
208 	  NULL,				0,
209 	  NULL,				0,	EMUL_FLAG_NETBSD32 },
210 
211 	{ "sunos",	sunos_syscallnames,	SUNOS_SYS_MAXSYSCALL,
212 	  NULL,				0,
213 	  NULL,				0,	0 },
214 
215 	{ "svr4",	svr4_syscallnames,	SVR4_SYS_MAXSYSCALL,
216 	  native_to_svr4_errno,		NELEM(native_to_svr4_errno),
217 	  svr4_to_native_signo,		NSIG,	0 },
218 
219 	{ "svr4_32",	svr4_syscallnames,	SVR4_SYS_MAXSYSCALL,
220 	  native_to_svr4_errno,		NELEM(native_to_svr4_errno),
221 	  svr4_to_native_signo,		NSIG,	EMUL_FLAG_NETBSD32 },
222 
223 	{ "ultrix",	ultrix_syscallnames,	ULTRIX_SYS_MAXSYSCALL,
224 	  NULL,				0,
225 	  NULL,				0,	0 },
226 
227 	{ "pecoff",	syscallnames,		SYS_MAXSYSCALL,
228 	  NULL,				0,
229 	  NULL,				0,	0 },
230 
231 	{ NULL,		NULL,			0,
232 	  NULL,				0,
233 	  NULL,				0,	0 }
234 };
235 
236 struct emulation_ctx {
237 	pid_t	pid;
238 	const struct emulation *emulation;
239 	LIST_ENTRY(emulation_ctx) ctx_link;
240 };
241 
242 const struct emulation *cur_emul;
243 const struct emulation *prev_emul;
244 /* Mach emulation require extra emulation contexts */
245 static const struct emulation *mach;
246 static const struct emulation *mach_ppccalls;
247 static const struct emulation *mach_fasttraps;
248 
249 static const struct emulation *default_emul = &emulations[0];
250 
251 struct emulation_ctx *current_ctx;
252 static LIST_HEAD(, emulation_ctx) emul_ctx =
253 	LIST_HEAD_INITIALIZER(emul_ctx);
254 
255 static struct emulation_ctx *ectx_find(pid_t);
256 static void	ectx_update(pid_t, const struct emulation *);
257 
258 void
259 setemul(const char *name, pid_t pid, int update_ectx)
260 {
261 	int i;
262 	const struct emulation *match = NULL;
263 
264 	for (i = 0; emulations[i].name != NULL; i++) {
265 		if (strcmp(emulations[i].name, name) == 0) {
266 			match = &emulations[i];
267 			break;
268 		}
269 	}
270 
271 	if (!match) {
272 		warnx("Emulation `%s' unknown", name);
273 		return;
274 	}
275 
276 	if (update_ectx)
277 		ectx_update(pid, match);
278 	else
279 		default_emul = match;
280 
281 	if (cur_emul != NULL)
282 		prev_emul = cur_emul;
283 	else
284 		prev_emul = match;
285 
286 	cur_emul = match;
287 }
288 
289 /*
290  * Emulation context list is very simple chained list, not even hashed.
291  * We expect the number of separate traced contexts/processes to be
292  * fairly low, so it's not worth it to optimize this.
293  * MMMmmmm not when I use it, it is only bounded PID_MAX!
294  * Requeue looked up item at start of list to cache result since the
295  * trace file tendes to have a burst of calls for a single process.
296  */
297 
298 /*
299  * Find an emulation context appropriate for the given pid.
300  */
301 static struct emulation_ctx *
302 ectx_find(pid_t pid)
303 {
304 	struct emulation_ctx *ctx;
305 
306 	/* Find an existing entry */
307 	LIST_FOREACH(ctx, &emul_ctx, ctx_link) {
308 		if (ctx->pid == pid)
309 			break;
310 	}
311 
312 	if (ctx == NULL) {
313 		/* create entry with default emulation */
314 		ctx = malloc(sizeof *ctx);
315 		if (ctx == NULL)
316 			err(1, "malloc emul context");
317 		ctx->pid = pid;
318 		ctx->emulation = default_emul;
319 
320 		/* chain into the list */
321 		LIST_INSERT_HEAD(&emul_ctx, ctx, ctx_link);
322 	} else {
323 		/* move entry to head to optimize lookup for syscall bursts */
324 		LIST_REMOVE(ctx, ctx_link);
325 		LIST_INSERT_HEAD(&emul_ctx, ctx, ctx_link);
326 	}
327 
328 	return ctx;
329 }
330 
331 /*
332  * Update emulation context for given pid, or create new if no context
333  * for this pid exists.
334  */
335 static void
336 ectx_update(pid_t pid, const struct emulation *emul)
337 {
338 	struct emulation_ctx *ctx;
339 
340 	ctx = ectx_find(pid);
341 	ctx->emulation = emul;
342 }
343 
344 /*
345  * Ensure current emulation context is correct for given pid.
346  */
347 void
348 ectx_sanify(pid_t pid)
349 {
350 	struct emulation_ctx *ctx;
351 
352 	ctx = ectx_find(pid);
353 	cur_emul = ctx->emulation;
354 }
355 
356 /*
357  * Delete emulation context for current pid.
358  * (eg when tracing exit())
359  * Defer delete just in case we've cached a pointer...
360  */
361 void
362 ectx_delete(void)
363 {
364 	static struct emulation_ctx *ctx = NULL;
365 
366 	if (ctx != NULL)
367 		free(ctx);
368 
369 	/*
370 	 * The emulation for current syscall entry is always on HEAD, due
371 	 * to code in ectx_find().
372 	 */
373 	ctx = LIST_FIRST(&emul_ctx);
374 
375 	if (ctx)
376 		LIST_REMOVE(ctx, ctx_link);
377 }
378 
379 /*
380  * Temporarily modify code and emulations to handle Mach traps
381  * XXX The define are duplicated from sys/arch/powerpc/include/mach_syscall.c
382  */
383 #define MACH_FASTTRAPS		0x00007ff0
384 #define MACH_PPCCALLS		0x00006000
385 #define MACH_ODD_SYSCALL_MASK	0x0000fff0
386 int
387 mach_traps_dispatch(int *code, const struct emulation **emul)
388 {
389 	switch (*code & MACH_ODD_SYSCALL_MASK) {
390 	case MACH_FASTTRAPS:
391 		*emul = mach_fasttraps;
392 		*code -= MACH_FASTTRAPS;
393 		return 1;
394 
395 	case MACH_PPCCALLS:
396 		*emul = mach_ppccalls;
397 		*code -= MACH_PPCCALLS;
398 		return 1;
399 
400 	default:
401 		if (*code < 0) {
402 			*emul = mach;
403 			*code = -*code;
404 			return 1;
405 		}
406 		return 0;
407 	}
408 }
409 
410 /*
411  * Lookup Machs emulations
412  */
413 void
414 mach_lookup_emul(void)
415 {
416 	const struct emulation *emul_idx;
417 
418 	for (emul_idx = emulations; emul_idx->name; emul_idx++) {
419 		if (strcmp("mach", emul_idx->name) == 0)
420 			mach = emul_idx;
421 		if (strcmp("mach fasttraps", emul_idx->name) == 0)
422 			mach_fasttraps = emul_idx;
423 		if (strcmp("mach ppccalls", emul_idx->name) == 0)
424 			mach_ppccalls = emul_idx;
425 	}
426 	if (mach == NULL || mach_fasttraps == NULL || mach_ppccalls == NULL) {
427 		errx(1, "Cannot load mach emulations");
428 		exit(1);
429 	}
430 	return;
431 }
432 
433 /*
434  * Find the name of the Mach service responsible to a given message Id
435  */
436 const char *
437 mach_service_name(id)
438 	int id;
439 {
440 	const char *retval = NULL;
441 #ifndef LETS_GET_SMALL
442 	struct mach_service_name *srv;
443 
444 	for (srv = mach_services_names; srv->srv_id; srv++)
445 		if (srv->srv_id == id)
446 			break;
447 	retval = srv->srv_name;
448 #endif /* LETS_GET_SMALL */
449 
450 	return retval;
451 }
452