1 /**	$MirOS: src/lib/libkvm/kvm_private.h,v 1.4 2013/10/31 20:06:32 tg Exp $ */
2 /*	$OpenBSD: kvm_private.h,v 1.9 2004/01/07 02:16:33 millert Exp $ */
3 /*	$NetBSD: kvm_private.h,v 1.7 1996/05/05 04:32:15 gwr Exp $	*/
4 
5 /*-
6  * Copyright © 2013
7  *	Thorsten “mirabilos” Glaser <tg@mirbsd.org>
8  * Copyright (c) 1992, 1993
9  *	The Regents of the University of California.  All rights reserved.
10  *
11  * This code is derived from software developed by the Computer Systems
12  * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
13  * BG 91-66 and contributed to Berkeley.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  * 3. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)kvm_private.h	8.1 (Berkeley) 6/4/93
40  */
41 
42 struct __kvm {
43 	/*
44 	 * a string to be prepended to error messages
45 	 * provided for compatibility with sun's interface
46 	 * if this value is null, errors are saved in errbuf[]
47 	 */
48 	const char *program;
49 	char	*errp;		/* XXX this can probably go away */
50 	char	errbuf[_POSIX2_LINE_MAX];
51 	DB	*db;
52 	int	pmfd;		/* physical memory file (or crashdump) */
53 	int	vmfd;		/* virtual memory file (-1 if crashdump) */
54 	int	swfd;		/* swap file (e.g., /dev/drum) */
55 	int	nlfd;		/* namelist file (e.g., /vmunix) */
56 	FILE	*nl_f;		/* stdio access to nlfd if required */
57 	struct kinfo_proc *procbase;
58 	struct kinfo_proc2 *procbase2;
59 	int	nbpg;		/* page size */
60 	char	*swapspc;	/* (dynamic) storage for swapped pages */
61 	char	*argspc, *argbuf; /* (dynamic) storage for argv strings */
62 	int	arglen;		/* length of the above */
63 	char	**argv;		/* (dynamic) storage for argv pointers */
64 	int	argc;		/* length of above (not actual # present) */
65 
66 	/*
67 	 * Header structures for kernel dumps. Only gets filled in for
68 	 * dead kernels.
69 	 */
70 	struct kcore_hdr	*kcore_hdr;
71 	size_t	cpu_dsize;
72 	void	*cpu_data;
73 	off_t	dump_off;	/* Where the actual dump starts	*/
74 
75 	/*
76 	 * Kernel virtual address translation state.  This only gets filled
77 	 * in for dead kernels; otherwise, the running kernel (i.e. kmem)
78 	 * will do the translations for us.  It could be big, so we
79 	 * only allocate it if necessary.
80 	 */
81 	struct vmstate *vmst; /* XXX: should become obsoleted */
82 	/*
83 	 * These kernel variables are used for looking up user addresses,
84 	 * and are cached for efficiency.
85 	 */
86 	struct pglist *vm_page_buckets;
87 	int vm_page_hash_mask;
88 	int alive;	/* Dead or alive. */
89 #define ISALIVE(kd) ((kd)->alive)
90 };
91 
92 /*
93  * Functions used internally by kvm, but across kvm modules.
94  */
95 void	 _kvm_err(kvm_t *kd, const char *program, const char *fmt, ...)
96 		__attribute__((__format__(__printf__, 3, 4)));
97 int	 _kvm_dump_mkheader(kvm_t *kd_live, kvm_t *kd_dump);
98 void	 _kvm_freeprocs(kvm_t *kd);
99 void	 _kvm_freevtop(kvm_t *);
100 int	 _kvm_initvtop(kvm_t *);
101 int	 _kvm_kvatop(kvm_t *, u_long, u_long *);
102 void	*_kvm_malloc(kvm_t *kd, size_t);
103 off_t	 _kvm_pa2off(kvm_t *, u_long);
104 void	*_kvm_realloc(kvm_t *kd, void *, size_t);
105 void	 _kvm_syserr
106 (kvm_t *kd, const char *program, const char *fmt, ...);
107 ssize_t	_kvm_pread
108 (kvm_t *, int, void *, size_t, off_t);
109 ssize_t	_kvm_pwrite
110 (kvm_t *, int, void *, size_t, off_t);
111