kvm.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1989, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 4. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 *	@(#)kvm.h	8.1 (Berkeley) 6/2/93
32 * $FreeBSD: stable/11/lib/libkvm/kvm.h 330897 2018-03-14 03:19:51Z eadler $
33 */
34
35#ifndef _KVM_H_
36#define	_KVM_H_
37
38#include <sys/cdefs.h>
39#include <sys/types.h>
40#include <nlist.h>
41
42/* Default version symbol. */
43#define	VRS_SYM		"_version"
44#define	VRS_KEY		"VERSION"
45
46#ifndef _SIZE_T_DECLARED
47typedef	__size_t	size_t;
48#define	_SIZE_T_DECLARED
49#endif
50
51#ifndef _SSIZE_T_DECLARED
52typedef	__ssize_t	ssize_t;
53#define	_SSIZE_T_DECLARED
54#endif
55
56typedef	uint64_t kvaddr_t;		/* An address in a target image. */
57
58struct kvm_nlist {
59	const char *n_name;
60	unsigned char n_type;
61	kvaddr_t n_value;
62};
63
64typedef struct __kvm kvm_t;
65
66struct kinfo_proc;
67struct proc;
68
69struct kvm_swap {
70	char	ksw_devname[32];
71	u_int	ksw_used;
72	u_int	ksw_total;
73	int	ksw_flags;
74	u_int	ksw_reserved1;
75	u_int	ksw_reserved2;
76};
77
78#define SWIF_DEV_PREFIX	0x0002
79
80__BEGIN_DECLS
81int	  kvm_close(kvm_t *);
82int	  kvm_dpcpu_setcpu(kvm_t *, unsigned int);
83char	**kvm_getargv(kvm_t *, const struct kinfo_proc *, int);
84int	  kvm_getcptime(kvm_t *, long *);
85char	**kvm_getenvv(kvm_t *, const struct kinfo_proc *, int);
86char	 *kvm_geterr(kvm_t *);
87int	  kvm_getloadavg(kvm_t *, double [], int);
88int	  kvm_getmaxcpu(kvm_t *);
89int	  kvm_getncpus(kvm_t *);
90void	 *kvm_getpcpu(kvm_t *, int);
91uint64_t  kvm_counter_u64_fetch(kvm_t *, u_long);
92struct kinfo_proc *
93	  kvm_getprocs(kvm_t *, int, int, int *);
94int	  kvm_getswapinfo(kvm_t *, struct kvm_swap *, int, int);
95int	  kvm_native(kvm_t *);
96int	  kvm_nlist(kvm_t *, struct nlist *);
97int	  kvm_nlist2(kvm_t *, struct kvm_nlist *);
98kvm_t	 *kvm_open
99	    (const char *, const char *, const char *, int, const char *);
100kvm_t	 *kvm_openfiles
101	    (const char *, const char *, const char *, int, char *);
102kvm_t	 *kvm_open2
103	    (const char *, const char *, int, char *,
104	    int (*)(const char *, kvaddr_t *));
105ssize_t	  kvm_read(kvm_t *, unsigned long, void *, size_t);
106ssize_t	  kvm_read_zpcpu(kvm_t *, unsigned long, void *, size_t, int);
107ssize_t	  kvm_read2(kvm_t *, kvaddr_t, void *, size_t);
108ssize_t	  kvm_write(kvm_t *, unsigned long, const void *, size_t);
109__END_DECLS
110
111#endif /* !_KVM_H_ */
112