1/* $NetBSD: kvm_private.h,v 1.20 2011/09/12 21:11:32 christos Exp $ */
2
3/*-
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software developed by the Computer Systems
8 * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
9 * BG 91-66 and contributed to Berkeley.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * @(#)kvm_private.h 8.1 (Berkeley) 6/4/93
36 */
37
38struct __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 crash dump) */
48 int vmfd; /* virtual memory file (-1 if crash dump) */
49 int swfd; /* swap file (e.g., /dev/drum) */
50 int nlfd; /* namelist file (e.g., /vmunix) */
51 char alive; /* live kernel? */
52 struct kinfo_proc *procbase;
53 struct kinfo_proc2 *procbase2;
54 struct kinfo_lwp *lwpbase;
55 size_t procbase_len;
56 size_t procbase2_len;
57 size_t lwpbase_len;
58 u_long usrstack; /* address of end of user stack */
59 u_long min_uva, max_uva; /* min/max user virtual address */
60 int nbpg; /* page size */
61 char *swapspc; /* (dynamic) storage for swapped pages */
62 char *argspc, *argbuf; /* (dynamic) storage for argv strings */
63 size_t argspc_len; /* length of the above */
64 char **argv; /* (dynamic) storage for argv pointers */
65 int argc; /* length of above (not actual # present) */
66
67 /*
68 * Header structures for kernel dumps. Only gets filled in for
69 * dead kernels.
70 */
71 struct kcore_hdr *kcore_hdr;
72 size_t cpu_dsize;
73 void *cpu_data;
74 off_t dump_off; /* Where the actual dump starts */
75
76 /*
77 * Kernel virtual address translation state. This only gets filled
78 * in for dead kernels; otherwise, the running kernel (i.e. kmem)
79 * will do the translations for us. It could be big, so we
80 * only allocate it if necessary.
81 */
82 struct vmstate *vmst; /* XXX: should become obsoleted */
83 /*
84 * These kernel variables are used for looking up user addresses,
85 * and are cached for efficiency.
86 */
87 struct pglist *vm_page_buckets;
88 int vm_page_hash_mask;
89 /* Buffer for raw disk I/O. */
90 size_t fdalign;
91 uint8_t *iobuf;
92 size_t iobufsz;
93 char kernelname[MAXPATHLEN];
94};
95
96/* Levels of aliveness */
97#define KVM_ALIVE_DEAD 0 /* dead, working from core file */
98#define KVM_ALIVE_FILES 1 /* alive, working from open kmem/drum */
99#define KVM_ALIVE_SYSCTL 2 /* alive, sysctl-type calls only */
100
101#define ISALIVE(kd) ((kd)->alive != KVM_ALIVE_DEAD)
102#define ISKMEM(kd) ((kd)->alive == KVM_ALIVE_FILES)
103#define ISSYSCTL(kd) ((kd)->alive == KVM_ALIVE_SYSCTL || ISKMEM(kd))
104
105/*
106 * Functions used internally by kvm, but across kvm modules.
107 */
108void _kvm_err(kvm_t *, const char *, const char *, ...)
109 __attribute__((__format__(__printf__, 3, 4)));
110int _kvm_dump_mkheader(kvm_t *, kvm_t *);
111void _kvm_freeprocs(kvm_t *);
112void _kvm_freevtop(kvm_t *);
113int _kvm_mdopen(kvm_t *);
114int _kvm_initvtop(kvm_t *);
115int _kvm_kvatop(kvm_t *, vaddr_t, paddr_t *);
116void *_kvm_malloc(kvm_t *, size_t);
117off_t _kvm_pa2off(kvm_t *, paddr_t);
118void *_kvm_realloc(kvm_t *, void *, size_t);
119void _kvm_syserr(kvm_t *, const char *, const char *, ...)
120 __attribute__((__format__(__printf__, 3, 4)));
121ssize_t _kvm_pread(kvm_t *, int, void *, size_t, off_t);
122
123#define KREAD(kd, addr, obj) \
124 (kvm_read(kd, addr, (obj), sizeof(*obj)) != sizeof(*obj))
125
126#define KVM_ALLOC(kd, member, size) \
127 do { \
128 if (kd->member == NULL) \
129 kd->member = _kvm_malloc(kd, kd->member ## _len = size); \
130 else if (kd->member ## _len < size) \
131 kd->member = _kvm_realloc(kd, kd->member, \
132 kd->member ## _len = size); \
133 if (kd->member == NULL) { \
134 kd->member ## _len = 0; \
135 return (NULL); \
136 } \
137 } while (/*CONSTCOND*/0)
138