xref: /openbsd/lib/libkvm/kvm_private.h (revision db3296cf)
1 /*	$OpenBSD: kvm_private.h,v 1.8 2003/06/02 20:18:41 millert 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. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)kvm_private.h	8.1 (Berkeley) 6/4/93
37  */
38 
39 struct __kvm {
40 	/*
41 	 * a string to be prepended to error messages
42 	 * provided for compatibility with sun's interface
43 	 * if this value is null, errors are saved in errbuf[]
44 	 */
45 	const char *program;
46 	char	*errp;		/* XXX this can probably go away */
47 	char	errbuf[_POSIX2_LINE_MAX];
48 	DB	*db;
49 	int	pmfd;		/* physical memory file (or crashdump) */
50 	int	vmfd;		/* virtual memory file (-1 if crashdump) */
51 	int	swfd;		/* swap file (e.g., /dev/drum) */
52 	int	nlfd;		/* namelist file (e.g., /vmunix) */
53 	struct kinfo_proc *procbase;
54 	int	nbpg;		/* page size */
55 	char	*swapspc;	/* (dynamic) storage for swapped pages */
56 	char	*argspc, *argbuf; /* (dynamic) storage for argv strings */
57 	int	arglen;		/* length of the above */
58 	char	**argv;		/* (dynamic) storage for argv pointers */
59 	int	argc;		/* length of above (not actual # present) */
60 
61 	/*
62 	 * Header structures for kernel dumps. Only gets filled in for
63 	 * dead kernels.
64 	 */
65 	struct kcore_hdr	*kcore_hdr;
66 	size_t	cpu_dsize;
67 	void	*cpu_data;
68 	off_t	dump_off;	/* Where the actual dump starts	*/
69 
70 	/*
71 	 * Kernel virtual address translation state.  This only gets filled
72 	 * in for dead kernels; otherwise, the running kernel (i.e. kmem)
73 	 * will do the translations for us.  It could be big, so we
74 	 * only allocate it if necessary.
75 	 */
76 	struct vmstate *vmst; /* XXX: should become obsoleted */
77 	/*
78 	 * These kernel variables are used for looking up user addresses,
79 	 * and are cached for efficiency.
80 	 */
81 	struct pglist *vm_page_buckets;
82 	int vm_page_hash_mask;
83 	int alive;	/* Dead or alive. */
84 #define ISALIVE(kd) ((kd)->alive)
85 };
86 
87 /*
88  * Functions used internally by kvm, but across kvm modules.
89  */
90 void	 _kvm_err(kvm_t *kd, const char *program, const char *fmt, ...);
91 int	 _kvm_dump_mkheader(kvm_t *kd_live, kvm_t *kd_dump);
92 void	 _kvm_freeprocs(kvm_t *kd);
93 void	 _kvm_freevtop(kvm_t *);
94 int	 _kvm_initvtop(kvm_t *);
95 int	 _kvm_kvatop(kvm_t *, u_long, u_long *);
96 void	*_kvm_malloc(kvm_t *kd, size_t);
97 off_t	 _kvm_pa2off(kvm_t *, u_long);
98 void	*_kvm_realloc(kvm_t *kd, void *, size_t);
99 void	 _kvm_syserr
100 (kvm_t *kd, const char *program, const char *fmt, ...);
101 ssize_t	_kvm_pread
102 (kvm_t *, int, void *, size_t, off_t);
103 ssize_t	_kvm_pwrite
104 (kvm_t *, int, void *, size_t, off_t);
105