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