xref: /openbsd-src/lib/libkvm/kvm_private.h (revision a4afd6dad3fba28f80e70208181c06c482259988)
1 /*	$OpenBSD: kvm_private.h,v 1.4 1996/05/10 12:58:33 deraadt Exp $ */
2 /*	$NetBSD: kvm_private.h,v 1.7 1996/05/05 04:32:15 gwr Exp $	*/
3 
4 /*-
5  * Copyright (c) 1992, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software developed by the Computer Systems
9  * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
10  * BG 91-66 and contributed to Berkeley.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *	This product includes software developed by the University of
23  *	California, Berkeley and its contributors.
24  * 4. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *	@(#)kvm_private.h	8.1 (Berkeley) 6/4/93
41  */
42 
43 struct __kvm {
44 	/*
45 	 * a string to be prepended to error messages
46 	 * provided for compatibility with sun's interface
47 	 * if this value is null, errors are saved in errbuf[]
48 	 */
49 	const char *program;
50 	char	*errp;		/* XXX this can probably go away */
51 	char	errbuf[_POSIX2_LINE_MAX];
52 	DB	*db;
53 #define ISALIVE(kd) ((kd)->vmfd >= 0)
54 	int	pmfd;		/* physical memory file (or crashdump) */
55 	int	vmfd;		/* virtual memory file (-1 if crashdump) */
56 	int	swfd;		/* swap file (e.g., /dev/drum) */
57 	int	nlfd;		/* namelist file (e.g., /vmunix) */
58 	struct kinfo_proc *procbase;
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 };
89 
90 /*
91  * Functions used internally by kvm, but across kvm modules.
92  */
93 void	 _kvm_err __P((kvm_t *kd, const char *program, const char *fmt, ...));
94 int	 _kvm_dump_mkheader __P((kvm_t *kd_live, kvm_t *kd_dump));
95 void	 _kvm_freeprocs __P((kvm_t *kd));
96 void	 _kvm_freevtop __P((kvm_t *));
97 int	 _kvm_initvtop __P((kvm_t *));
98 int	 _kvm_kvatop __P((kvm_t *, u_long, u_long *));
99 void	*_kvm_malloc __P((kvm_t *kd, size_t));
100 off_t	 _kvm_pa2off __P((kvm_t *, u_long));
101 void	*_kvm_realloc __P((kvm_t *kd, void *, size_t));
102 void	 _kvm_syserr
103 	    __P((kvm_t *kd, const char *program, const char *fmt, ...));
104