xref: /dragonfly/lib/libkvm/kvm_private.h (revision 7b21e84b)
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  * 3. 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: src/lib/libkvm/kvm_private.h,v 1.5 1999/12/27 07:14:58 peter Exp $
35  * $DragonFly: src/lib/libkvm/kvm_private.h,v 1.4 2007/02/01 10:33:25 corecode Exp $
36  */
37 
38 struct __kvm {
39 	/*
40 	 * a string to be prepended to error messages
41 	 * provided for compatibility with sun's interface
42 	 * if this value is null, errors are saved in errbuf[]
43 	 */
44 	const char *program;
45 	char	*errp;		/* XXX this can probably go away */
46 	char	errbuf[_POSIX2_LINE_MAX];
47 	int	pmfd;		/* physical memory file (or crashdump) */
48 	int	vmfd;		/* virtual memory file (-1 if crashdump) */
49 	int	flags;		/* was: swap file (e.g., /dev/drum) */
50 	int	nlfd;		/* namelist file (e.g., /kernel) */
51 	struct kinfo_proc *procbase;
52 	struct kinfo_proc *procend;
53 	char	*argspc;	/* (dynamic) storage for argv strings */
54 	int	arglen;		/* length of the above */
55 	char	**argv;		/* (dynamic) storage for argv pointers */
56 	int	argc;		/* length of above (not actual # present) */
57 	char	*argbuf;	/* (dynamic) temporary storage */
58 	/*
59 	 * Kernel virtual address translation state.  This only gets filled
60 	 * in for dead kernels; otherwise, the running kernel (i.e. kmem)
61 	 * will do the translations for us.  It could be big, so we
62 	 * only allocate it if necessary.
63 	 */
64 	struct vmstate *vmst;
65 	int	rawdump;	/* raw dump format */
66 };
67 
68 enum {
69 	KVMF_HOST = 0x1,
70 	KVMF_VKERN = 0x2,
71 };
72 
73 static inline
74 int
75 kvm_ishost(kvm_t *kd)
76 {
77 	return kd->flags & KVMF_HOST;
78 }
79 
80 static inline
81 int
82 kvm_isvkernel(kvm_t *kd)
83 {
84 	return kd->flags & KVMF_VKERN;
85 }
86 
87 static inline
88 int
89 kvm_notrans(kvm_t *kd)
90 {
91 	return kvm_ishost(kd) || kvm_isvkernel(kd);
92 }
93 
94 /*
95  * Functions used internally by kvm, but across kvm modules.
96  */
97 void	 _kvm_err (kvm_t *kd, const char *program, const char *fmt, ...)
98 	     __printflike(3, 4);
99 void	 _kvm_freeprocs (kvm_t *kd);
100 void	 _kvm_freevtop (kvm_t *);
101 int	 _kvm_initvtop (kvm_t *);
102 int	 _kvm_kvatop (kvm_t *, u_long, off_t *);
103 void	*_kvm_malloc (kvm_t *kd, size_t);
104 void	*_kvm_realloc (kvm_t *kd, void *, size_t);
105 void	 _kvm_syserr (kvm_t *kd, const char *program, const char *fmt, ...)
106 	     __printflike(3, 4);
107 int	 _kvm_uvatop (kvm_t *, const struct proc *, u_long, u_long *);
108 void     _kvm_minidump_freevtop(kvm_t *);
109 int      _kvm_minidump_initvtop(kvm_t *);
110 int      _kvm_minidump_kvatop(kvm_t *, u_long, off_t *);
111