xref: /freebsd/lib/libkvm/kvm.h (revision 2008043f386721d58158e37e0d7e50df8095942d)
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  * 3. 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  */
33 
34 #ifndef _KVM_H_
35 #define	_KVM_H_
36 
37 #include <sys/cdefs.h>
38 #include <sys/types.h>
39 #include <nlist.h>
40 
41 /*
42  * Including vm/vm.h causes namespace pollution issues.  For the
43  * most part, only things using kvm_walk_pages() need to #include it.
44  */
45 #ifndef VM_H
46 typedef u_char vm_prot_t;
47 #endif
48 
49 /* Default version symbol. */
50 #define	VRS_SYM		"_version"
51 #define	VRS_KEY		"VERSION"
52 
53 #ifndef _SIZE_T_DECLARED
54 typedef	__size_t	size_t;
55 #define	_SIZE_T_DECLARED
56 #endif
57 
58 #ifndef _SSIZE_T_DECLARED
59 typedef	__ssize_t	ssize_t;
60 #define	_SSIZE_T_DECLARED
61 #endif
62 
63 struct kvm_nlist {
64 	const char *n_name;
65 	unsigned char n_type;
66 	kvaddr_t n_value;
67 };
68 
69 typedef struct __kvm kvm_t;
70 
71 struct kinfo_proc;
72 struct proc;
73 
74 struct kvm_swap {
75 	char	ksw_devname[32];
76 	u_int	ksw_used;
77 	u_int	ksw_total;
78 	int	ksw_flags;
79 	u_int	ksw_reserved1;
80 	u_int	ksw_reserved2;
81 };
82 
83 struct kvm_page {
84 	u_int		kp_version;
85 	kpaddr_t	kp_paddr;
86 	kvaddr_t	kp_kmap_vaddr;
87 	kvaddr_t	kp_dmap_vaddr;
88 	vm_prot_t	kp_prot;
89 	off_t		kp_offset;
90 	size_t		kp_len;
91 	/* end of version 2 */
92 };
93 
94 #define SWIF_DEV_PREFIX	0x0002
95 #define	LIBKVM_WALK_PAGES_VERSION	2
96 
97 __BEGIN_DECLS
98 int	  kvm_close(kvm_t *);
99 int	  kvm_dpcpu_setcpu(kvm_t *, unsigned int);
100 char	**kvm_getargv(kvm_t *, const struct kinfo_proc *, int);
101 int	  kvm_getcptime(kvm_t *, long *);
102 char	**kvm_getenvv(kvm_t *, const struct kinfo_proc *, int);
103 char	 *kvm_geterr(kvm_t *);
104 int	  kvm_getloadavg(kvm_t *, double [], int);
105 int	  kvm_getmaxcpu(kvm_t *);
106 int	  kvm_getncpus(kvm_t *);
107 void	 *kvm_getpcpu(kvm_t *, int);
108 uint64_t  kvm_counter_u64_fetch(kvm_t *, u_long);
109 struct kinfo_proc *
110 	  kvm_getprocs(kvm_t *, int, int, int *);
111 int	  kvm_getswapinfo(kvm_t *, struct kvm_swap *, int, int);
112 int	  kvm_native(kvm_t *);
113 int	  kvm_nlist(kvm_t *, struct nlist *);
114 int	  kvm_nlist2(kvm_t *, struct kvm_nlist *);
115 kvm_t	 *kvm_open
116 	    (const char *, const char *, const char *, int, const char *);
117 kvm_t	 *kvm_openfiles
118 	    (const char *, const char *, const char *, int, char *);
119 kvm_t	 *kvm_open2
120 	    (const char *, const char *, int, char *,
121 	    int (*)(const char *, kvaddr_t *));
122 ssize_t	  kvm_read(kvm_t *, unsigned long, void *, size_t);
123 ssize_t	  kvm_read_zpcpu(kvm_t *, unsigned long, void *, size_t, int);
124 ssize_t	  kvm_read2(kvm_t *, kvaddr_t, void *, size_t);
125 ssize_t	  kvm_write(kvm_t *, unsigned long, const void *, size_t);
126 kssize_t  kvm_kerndisp(kvm_t *);
127 
128 typedef int kvm_walk_pages_cb_t(struct kvm_page *, void *);
129 int kvm_walk_pages(kvm_t *, kvm_walk_pages_cb_t *, void *);
130 __END_DECLS
131 
132 #endif /* !_KVM_H_ */
133