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 */
36
37 #ifndef _KVM_PRIVATE_H_
38 #define _KVM_PRIVATE_H_
39
40 #include <sys/cdefs.h>
41 #include <sys/types.h>
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 int pmfd; /* physical memory file (or crashdump) */
53 int vmfd; /* virtual memory file (-1 if crashdump) */
54 int flags; /* was: swap file (e.g., /dev/drum) */
55 int nlfd; /* namelist file (e.g., /kernel) */
56 struct kinfo_proc *procbase;
57 struct kinfo_proc *procend;
58 char *argspc; /* (dynamic) storage for argv strings */
59 int arglen; /* length of the above */
60 char **argv; /* (dynamic) storage for argv pointers */
61 int argc; /* length of above (not actual # present) */
62 char *argbuf; /* (dynamic) temporary storage */
63 /*
64 * Kernel virtual address translation state. This only gets filled
65 * in for dead kernels; otherwise, the running kernel (i.e. kmem)
66 * will do the translations for us. It could be big, so we
67 * only allocate it if necessary.
68 */
69 struct vmstate *vmst;
70 int rawdump; /* raw dump format */
71 };
72
73 enum {
74 KVMF_HOST = 0x1,
75 KVMF_VKERN = 0x2,
76 };
77
78 static inline
79 int
kvm_ishost(kvm_t * kd)80 kvm_ishost(kvm_t *kd)
81 {
82 return kd->flags & KVMF_HOST;
83 }
84
85 static inline
86 int
kvm_isvkernel(kvm_t * kd)87 kvm_isvkernel(kvm_t *kd)
88 {
89 return kd->flags & KVMF_VKERN;
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 __printflike(3, 4);
97 void _kvm_freeprocs (kvm_t *kd);
98 void _kvm_freevtop (kvm_t *);
99 int _kvm_initvtop (kvm_t *);
100 int _kvm_kvatop (kvm_t *, u_long, off_t *);
101 void *_kvm_malloc (kvm_t *kd, size_t);
102 void *_kvm_realloc (kvm_t *kd, void *, size_t);
103 void _kvm_syserr (kvm_t *kd, const char *program, const char *fmt, ...)
104 __printflike(3, 4);
105 int _kvm_uvatop (kvm_t *, const struct proc *, u_long, u_long *);
106 void _kvm_minidump_freevtop(kvm_t *);
107 int _kvm_minidump_initvtop(kvm_t *);
108 int _kvm_minidump_kvatop(kvm_t *, u_long, off_t *);
109
110 #endif /* !_KVM_PRIVATE_H_ */
111