1 /* $OpenBSD: kvm_private.h,v 1.27 2024/05/21 11:13:08 jsg 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 errbuf[_POSIX2_LINE_MAX]; 47 DB *db; 48 int pmfd; /* physical memory file (or crashdump) */ 49 int vmfd; /* virtual memory file (-1 if crashdump) */ 50 int swfd; /* swap file (e.g., /dev/drum) */ 51 int nlfd; /* namelist file (e.g., /vmunix) */ 52 struct kinfo_proc *procbase; 53 struct kinfo_file *filebase; 54 int nbpg; /* page size */ 55 char *swapspc; /* (dynamic) storage for swapped pages */ 56 57 char *argspc, *argbuf; /* (dynamic) storage for argv strings */ 58 int arglen; /* length of the above */ 59 char **argv; /* (dynamic) storage for argv pointers */ 60 int argc; /* length of above (not actual # present) */ 61 62 char *envspc, *envbuf; /* (dynamic) storage for environ strings */ 63 int envlen; /* length of the above */ 64 char **envp; /* (dynamic) storage for environ pointers */ 65 int envc; /* 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 int alive; /* Dead or alive. */ 90 #define ISALIVE(kd) ((kd)->alive) 91 }; 92 93 #define KREAD(kd, addr, obj) \ 94 (kvm_read(kd, addr, (void *)(obj), sizeof(*obj)) != sizeof(*obj)) 95 96 /* 97 * Functions used internally by kvm, but across kvm modules. 98 */ 99 __BEGIN_HIDDEN_DECLS 100 void _kvm_err(kvm_t *kd, const char *program, const char *fmt, ...) 101 __attribute__((__format__ (printf, 3, 4))); 102 void _kvm_freevtop(kvm_t *); 103 int _kvm_initvtop(kvm_t *); 104 int _kvm_kvatop(kvm_t *, u_long, paddr_t *); 105 void *_kvm_malloc(kvm_t *kd, size_t); 106 void *_kvm_realloc(kvm_t *kd, void *, size_t); 107 off_t _kvm_pa2off(kvm_t *, paddr_t); 108 void *_kvm_reallocarray(kvm_t *kd, void *, size_t, size_t); 109 void _kvm_syserr(kvm_t *kd, const char *program, const char *fmt, ...) 110 __attribute__((__format__ (printf, 3, 4))); 111 ssize_t _kvm_pread(kvm_t *, int, void *, size_t, off_t); 112 ssize_t _kvm_pwrite(kvm_t *, int, const void *, size_t, off_t); 113 __END_HIDDEN_DECLS 114 115 116 #define PROTO(x) __dso_hidden typeof(x) x asm("__"#x) 117 #define DEF(x) __strong_alias(x, __##x) 118 119 PROTO(kvm_close); 120 PROTO(kvm_nlist); 121 PROTO(kvm_read); 122