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