Merge from vendor branch LIBARCHIVE:
[dragonfly.git] / lib / libkvm / kvm_private.h
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. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *      This product includes software developed by the University of
20  *      California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *      @(#)kvm_private.h       8.1 (Berkeley) 6/4/93
38  * $FreeBSD: src/lib/libkvm/kvm_private.h,v 1.5 1999/12/27 07:14:58 peter Exp $
39  * $DragonFly: src/lib/libkvm/kvm_private.h,v 1.4 2007/02/01 10:33:25 corecode Exp $
40  */
41
42 struct __kvm {
43         /*
44          * a string to be prepended to error messages
45          * provided for compatibility with sun's interface
46          * if this value is null, errors are saved in errbuf[]
47          */
48         const char *program;
49         char    *errp;          /* XXX this can probably go away */
50         char    errbuf[_POSIX2_LINE_MAX];
51 #define ISALIVE(kd) ((kd)->vmfd >= 0)
52         int     pmfd;           /* physical memory file (or crashdump) */
53         int     vmfd;           /* virtual memory file (-1 if crashdump) */
54         int     unused;         /* 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 };
71
72 /*
73  * Functions used internally by kvm, but across kvm modules.
74  */
75 void     _kvm_err (kvm_t *kd, const char *program, const char *fmt, ...);
76 void     _kvm_freeprocs (kvm_t *kd);
77 void     _kvm_freevtop (kvm_t *);
78 int      _kvm_initvtop (kvm_t *);
79 int      _kvm_kvatop (kvm_t *, u_long, u_long *);
80 void    *_kvm_malloc (kvm_t *kd, size_t);
81 void    *_kvm_realloc (kvm_t *kd, void *, size_t);
82 void     _kvm_syserr
83             (kvm_t *kd, const char *program, const char *fmt, ...);
84 int      _kvm_uvatop (kvm_t *, const struct proc *, u_long, u_long *);