Home | History | Annotate | Line # | Download | only in libkvm
kvm_private.h revision 1.14
      1 /*	$NetBSD: kvm_private.h,v 1.14 2003/08/07 16:44:39 agc 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 
     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 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 	u_long	usrstack;		/* address of end of user stack */
     56 	u_long	min_uva, max_uva;	/* min/max user virtual address */
     57 	int	nbpg;		/* page size */
     58 	char	*swapspc;	/* (dynamic) storage for swapped pages */
     59 	char	*argspc, *argbuf; /* (dynamic) storage for argv strings */
     60 	int	arglen;		/* length of the above */
     61 	char	**argv;		/* (dynamic) storage for argv pointers */
     62 	int	argc;		/* length of above (not actual # present) */
     63 
     64 	/*
     65 	 * Header structures for kernel dumps. Only gets filled in for
     66 	 * dead kernels.
     67 	 */
     68 	struct kcore_hdr	*kcore_hdr;
     69 	size_t	cpu_dsize;
     70 	void	*cpu_data;
     71 	off_t	dump_off;	/* Where the actual dump starts	*/
     72 
     73 	/*
     74 	 * Kernel virtual address translation state.  This only gets filled
     75 	 * in for dead kernels; otherwise, the running kernel (i.e. kmem)
     76 	 * will do the translations for us.  It could be big, so we
     77 	 * only allocate it if necessary.
     78 	 */
     79 	struct vmstate *vmst; /* XXX: should become obsoleted */
     80 	/*
     81 	 * These kernel variables are used for looking up user addresses,
     82 	 * and are cached for efficiency.
     83 	 */
     84 	struct pglist *vm_page_buckets;
     85 	int vm_page_hash_mask;
     86 };
     87 
     88 /* Levels of aliveness */
     89 #define	KVM_ALIVE_DEAD		0	/* dead, working from core file */
     90 #define	KVM_ALIVE_FILES		1	/* alive, working from open kmem/drum */
     91 #define	KVM_ALIVE_SYSCTL	2	/* alive, sysctl-type calls only */
     92 
     93 #define	ISALIVE(kd)	((kd)->alive != KVM_ALIVE_DEAD)
     94 #define	ISKMEM(kd)	((kd)->alive == KVM_ALIVE_FILES)
     95 #define	ISSYSCTL(kd)	((kd)->alive == KVM_ALIVE_SYSCTL || ISKMEM(kd))
     96 
     97 /*
     98  * Functions used internally by kvm, but across kvm modules.
     99  */
    100 void	 _kvm_err __P((kvm_t *kd, const char *program, const char *fmt, ...))
    101 	__attribute__((__format__(__printf__, 3, 4)));
    102 int	 _kvm_dump_mkheader __P((kvm_t *kd_live, kvm_t *kd_dump));
    103 void	 _kvm_freeprocs __P((kvm_t *kd));
    104 void	 _kvm_freevtop __P((kvm_t *));
    105 int	 _kvm_mdopen __P((kvm_t *));
    106 int	 _kvm_initvtop __P((kvm_t *));
    107 int	 _kvm_kvatop __P((kvm_t *, u_long, u_long *));
    108 void	*_kvm_malloc __P((kvm_t *kd, size_t));
    109 off_t	 _kvm_pa2off __P((kvm_t *, u_long));
    110 void	*_kvm_realloc __P((kvm_t *kd, void *, size_t));
    111 void	 _kvm_syserr
    112 	    __P((kvm_t *kd, const char *program, const char *fmt, ...))
    113 	    __attribute__((__format__(__printf__, 3, 4)));
    114 
    115