xref: /freebsd/lib/libkvm/kvm_private.h (revision 6ae1554a5d9b318f8ad53ccc39fa5a961403da73)
1 /*-
2  * Copyright (c) 1992, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software developed by the Computer Systems
6  * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
7  * BG 91-66 and contributed to Berkeley.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)kvm_private.h	8.1 (Berkeley) 6/4/93
34  * $FreeBSD$
35  */
36 
37 struct __kvm {
38 	/*
39 	 * a string to be prepended to error messages
40 	 * provided for compatibility with sun's interface
41 	 * if this value is null, errors are saved in errbuf[]
42 	 */
43 	const char *program;
44 	char	*errp;		/* XXX this can probably go away */
45 	char	errbuf[_POSIX2_LINE_MAX];
46 #define ISALIVE(kd) ((kd)->vmfd >= 0)
47 	int	pmfd;		/* physical memory file (or crashdump) */
48 	int	vmfd;		/* virtual memory file (-1 if crashdump) */
49 	int	unused;		/* was: swap file (e.g., /dev/drum) */
50 	int	nlfd;		/* namelist file (e.g., /kernel) */
51 	struct kinfo_proc *procbase;
52 	char	*argspc;	/* (dynamic) storage for argv strings */
53 	int	arglen;		/* length of the above */
54 	char	**argv;		/* (dynamic) storage for argv pointers */
55 	int	argc;		/* length of above (not actual # present) */
56 	char	*argbuf;	/* (dynamic) temporary storage */
57 	/*
58 	 * Kernel virtual address translation state.  This only gets filled
59 	 * in for dead kernels; otherwise, the running kernel (i.e. kmem)
60 	 * will do the translations for us.  It could be big, so we
61 	 * only allocate it if necessary.
62 	 */
63 	struct vmstate *vmst;
64 	int	rawdump;	/* raw dump format */
65 
66 	int		vnet_initialized;	/* vnet fields set up */
67 	uintptr_t	vnet_start;	/* start of kernel's vnet region */
68 	uintptr_t	vnet_stop;	/* stop of kernel's vnet region */
69 	uintptr_t	vnet_current;	/* vnet we're working with */
70 	uintptr_t	vnet_base;	/* vnet base of current vnet */
71 
72 	/*
73 	 * Dynamic per-CPU kernel memory.  We translate symbols, on-demand,
74 	 * to the data associated with dpcpu_curcpu, set with
75 	 * kvm_dpcpu_setcpu().
76 	 */
77 	int		dpcpu_initialized;	/* dpcpu fields set up */
78 	uintptr_t	dpcpu_start;	/* start of kernel's dpcpu region */
79 	uintptr_t	dpcpu_stop;	/* stop of kernel's dpcpu region */
80 	u_int		dpcpu_maxcpus;	/* size of base array */
81 	uintptr_t	*dpcpu_off;	/* base array, indexed by CPU ID */
82 	u_int		dpcpu_curcpu;	/* CPU we're currently working with */
83 	uintptr_t	dpcpu_curoff;	/* dpcpu base of current CPU */
84 };
85 
86 /*
87  * Functions used internally by kvm, but across kvm modules.
88  */
89 void	 _kvm_err(kvm_t *kd, const char *program, const char *fmt, ...)
90 	    __printflike(3, 4);
91 void	 _kvm_freeprocs(kvm_t *kd);
92 void	 _kvm_freevtop(kvm_t *);
93 int	 _kvm_initvtop(kvm_t *);
94 int	 _kvm_kvatop(kvm_t *, u_long, off_t *);
95 void	*_kvm_malloc(kvm_t *kd, size_t);
96 int	 _kvm_nlist(kvm_t *, struct nlist *, int);
97 void	*_kvm_realloc(kvm_t *kd, void *, size_t);
98 void	 _kvm_syserr (kvm_t *kd, const char *program, const char *fmt, ...)
99 	    __printflike(3, 4);
100 int	 _kvm_uvatop(kvm_t *, const struct proc *, u_long, u_long *);
101 int	 _kvm_vnet_selectpid(kvm_t *, pid_t);
102 int	 _kvm_vnet_initialized(kvm_t *, int);
103 uintptr_t _kvm_vnet_validaddr(kvm_t *, uintptr_t);
104 int	 _kvm_dpcpu_initialized(kvm_t *, int);
105 uintptr_t _kvm_dpcpu_validaddr(kvm_t *, uintptr_t);
106 
107 #if defined(__aarch64__) || defined(__amd64__) || defined(__arm__) || \
108     defined(__i386__) || defined(__mips__)
109 void	 _kvm_minidump_freevtop(kvm_t *);
110 int	 _kvm_minidump_initvtop(kvm_t *);
111 int	 _kvm_minidump_kvatop(kvm_t *, u_long, off_t *);
112 #endif
113