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. 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$
  35  */
  36
  37 #include <sys/endian.h>
  38 #include <sys/linker_set.h>
  39 #include <gelf.h>
  40
  41 struct kvm_arch {
  42         int     (*ka_probe)(kvm_t *);
  43         int     (*ka_initvtop)(kvm_t *);
  44         void    (*ka_freevtop)(kvm_t *);
  45         int     (*ka_kvatop)(kvm_t *, kvaddr_t, off_t *);
  46         int     (*ka_native)(kvm_t *);
  47 };
  48
  49 #define KVM_ARCH(ka)    DATA_SET(kvm_arch, ka)
  50
  51 struct __kvm {
  52         struct kvm_arch *arch;
  53         /*
  54          * a string to be prepended to error messages
  55          * provided for compatibility with sun's interface
  56          * if this value is null, errors are saved in errbuf[]
  57          */
  58         const char *program;
  59         char    *errp;          /* XXX this can probably go away */
  60         char    errbuf[_POSIX2_LINE_MAX];
  61 #define ISALIVE(kd) ((kd)->vmfd >= 0)
  62         int     pmfd;           /* physical memory file (or crashdump) */
  63         int     vmfd;           /* virtual memory file (-1 if crashdump) */
  64         int     nlfd;           /* namelist file (e.g., /kernel) */
  65         GElf_Ehdr nlehdr;       /* ELF file header for namelist file */
  66         int     (*resolve_symbol)(const char *, kvaddr_t *);
  67         struct kinfo_proc *procbase;
  68         char    *argspc;        /* (dynamic) storage for argv strings */
  69         int     arglen;         /* length of the above */
  70         char    **argv;         /* (dynamic) storage for argv pointers */
  71         int     argc;           /* length of above (not actual # present) */
  72         char    *argbuf;        /* (dynamic) temporary storage */
  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;
  80         int     rawdump;        /* raw dump format */
  81         int     writable;       /* physical memory is writable */
  82
  83         int             vnet_initialized;       /* vnet fields set up */
  84         kvaddr_t        vnet_start;     /* start of kernel's vnet region */
  85         kvaddr_t        vnet_stop;      /* stop of kernel's vnet region */
  86         kvaddr_t        vnet_current;   /* vnet we're working with */
  87         kvaddr_t        vnet_base;      /* vnet base of current vnet */
  88
  89         /*
  90          * Dynamic per-CPU kernel memory.  We translate symbols, on-demand,
  91          * to the data associated with dpcpu_curcpu, set with
  92          * kvm_dpcpu_setcpu().
  93          */
  94         int             dpcpu_initialized;      /* dpcpu fields set up */
  95         kvaddr_t        dpcpu_start;    /* start of kernel's dpcpu region */
  96         kvaddr_t        dpcpu_stop;     /* stop of kernel's dpcpu region */
  97         u_int           dpcpu_maxcpus;  /* size of base array */
  98         uintptr_t       *dpcpu_off;     /* base array, indexed by CPU ID */
  99         u_int           dpcpu_curcpu;   /* CPU we're currently working with */
 100         kvaddr_t        dpcpu_curoff;   /* dpcpu base of current CPU */
 101
 102         /* Page table lookup structures. */
 103         uint64_t        *pt_map;
 104         size_t          pt_map_size;
 105         off_t           pt_sparse_off;
 106         uint64_t        pt_sparse_size;
 107         uint32_t        *pt_popcounts;
 108         unsigned int    pt_page_size;
 109         unsigned int    pt_word_size;
 110 };
 111
 112 /* Page table lookup constants. */
 113 #define POPCOUNT_BITS   1024
 114 #define BITS_IN(v)      (sizeof(v) * NBBY)
 115 #define POPCOUNTS_IN(v) (POPCOUNT_BITS / BITS_IN(v))
 116
 117 /*
 118  * Functions used internally by kvm, but across kvm modules.
 119  */
 120 static inline uint32_t
 121 _kvm32toh(kvm_t *kd, uint32_t val)
 122 {
 123
 124         if (kd->nlehdr.e_ident[EI_DATA] == ELFDATA2LSB)
 125                 return (le32toh(val));
 126         else
 127                 return (be32toh(val));
 128 }
 129
 130 static inline uint64_t
 131 _kvm64toh(kvm_t *kd, uint64_t val)
 132 {
 133
 134         if (kd->nlehdr.e_ident[EI_DATA] == ELFDATA2LSB)
 135                 return (le64toh(val));
 136         else
 137                 return (be64toh(val));
 138 }
 139
 140 void     _kvm_err(kvm_t *kd, const char *program, const char *fmt, ...)
 141             __printflike(3, 4);
 142 void     _kvm_freeprocs(kvm_t *kd);
 143 void    *_kvm_malloc(kvm_t *kd, size_t);
 144 int      _kvm_nlist(kvm_t *, struct kvm_nlist *, int);
 145 void    *_kvm_realloc(kvm_t *kd, void *, size_t);
 146 void     _kvm_syserr (kvm_t *kd, const char *program, const char *fmt, ...)
 147             __printflike(3, 4);
 148 int      _kvm_vnet_selectpid(kvm_t *, pid_t);
 149 int      _kvm_vnet_initialized(kvm_t *, int);
 150 kvaddr_t _kvm_vnet_validaddr(kvm_t *, kvaddr_t);
 151 int      _kvm_dpcpu_initialized(kvm_t *, int);
 152 kvaddr_t _kvm_dpcpu_validaddr(kvm_t *, kvaddr_t);
 153 int      _kvm_probe_elf_kernel(kvm_t *, int, int);
 154 int      _kvm_is_minidump(kvm_t *);
 155 int      _kvm_read_core_phdrs(kvm_t *, size_t *, GElf_Phdr **);
 156 int      _kvm_pt_init(kvm_t *, size_t, off_t, off_t, int, int);
 157 off_t    _kvm_pt_find(kvm_t *, uint64_t);