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 * 4. 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: stable/11/lib/libkvm/kvm_private.h 312381 2017-01-18 14:13:28Z avg $
35 */
36
37#include <sys/endian.h>
38#include <sys/linker_set.h>
39#include <gelf.h>
40
41struct 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
51struct __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
103/*
104 * Page table hash used by minidump backends to map physical addresses
105 * to file offsets.
106 */
107struct hpte {
108	struct hpte	*next;
109	uint64_t	pa;
110	off_t		off;
111};
112
113#define HPT_SIZE 1024
114
115struct hpt {
116	struct hpte	*hpt_head[HPT_SIZE];
117};
118
119/*
120 * Functions used internally by kvm, but across kvm modules.
121 */
122static inline uint32_t
123_kvm32toh(kvm_t *kd, uint32_t val)
124{
125
126	if (kd->nlehdr.e_ident[EI_DATA] == ELFDATA2LSB)
127		return (le32toh(val));
128	else
129		return (be32toh(val));
130}
131
132static inline uint64_t
133_kvm64toh(kvm_t *kd, uint64_t val)
134{
135
136	if (kd->nlehdr.e_ident[EI_DATA] == ELFDATA2LSB)
137		return (le64toh(val));
138	else
139		return (be64toh(val));
140}
141
142void	 _kvm_err(kvm_t *kd, const char *program, const char *fmt, ...)
143	    __printflike(3, 4);
144void	 _kvm_freeprocs(kvm_t *kd);
145void	*_kvm_malloc(kvm_t *kd, size_t);
146int	 _kvm_nlist(kvm_t *, struct kvm_nlist *, int);
147void	*_kvm_realloc(kvm_t *kd, void *, size_t);
148void	 _kvm_syserr (kvm_t *kd, const char *program, const char *fmt, ...)
149	    __printflike(3, 4);
150int	 _kvm_vnet_selectpid(kvm_t *, pid_t);
151int	 _kvm_vnet_initialized(kvm_t *, int);
152kvaddr_t _kvm_vnet_validaddr(kvm_t *, kvaddr_t);
153int	 _kvm_dpcpu_initialized(kvm_t *, int);
154kvaddr_t _kvm_dpcpu_validaddr(kvm_t *, kvaddr_t);
155int	 _kvm_probe_elf_kernel(kvm_t *, int, int);
156int	 _kvm_is_minidump(kvm_t *);
157int	 _kvm_read_core_phdrs(kvm_t *, size_t *, GElf_Phdr **);
158void	 _kvm_hpt_init(kvm_t *, struct hpt *, void *, size_t, off_t, int, int);
159off_t	 _kvm_hpt_find(struct hpt *, uint64_t);
160void	 _kvm_hpt_free(struct hpt *);
161