xref: /freebsd/lib/libkvm/kvm.h (revision ee2ea5ceafed78a5bd9810beb9e3ca927180c226)
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. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
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.h	8.1 (Berkeley) 6/2/93
34  * $FreeBSD$
35  */
36 
37 #ifndef _KVM_H_
38 #define	_KVM_H_
39 
40 #include <sys/cdefs.h>
41 #include <machine/ansi.h>
42 #include <nlist.h>
43 
44 /* Default version symbol. */
45 #define	VRS_SYM		"_version"
46 #define	VRS_KEY		"VERSION"
47 
48 #ifdef	_BSD_SIZE_T_
49 typedef	_BSD_SIZE_T_	size_t;
50 #undef	_BSD_SIZE_T_
51 #endif
52 
53 #ifdef	_BSD_SSIZE_T_
54 typedef	_BSD_SSIZE_T_	ssize_t;
55 #undef	_BSD_SSIZE_T_
56 #endif
57 
58 typedef struct __kvm kvm_t;
59 
60 struct kinfo_proc;
61 struct proc;
62 
63 struct kvm_swap {
64 	char	ksw_devname[32];
65 	int	ksw_used;
66 	int	ksw_total;
67 	int	ksw_flags;
68 	int	ksw_reserved1;
69 	int	ksw_reserved2;
70 };
71 
72 #define SWIF_DUMP_TREE	0x0001
73 #define SWIF_DEV_PREFIX	0x0002
74 
75 __BEGIN_DECLS
76 int	  kvm_close(kvm_t *);
77 char	**kvm_getargv(kvm_t *, const struct kinfo_proc *, int);
78 char	**kvm_getenvv(kvm_t *, const struct kinfo_proc *, int);
79 char	 *kvm_geterr(kvm_t *);
80 char	 *kvm_getfiles(kvm_t *, int, int, int *);
81 int	  kvm_getloadavg(kvm_t *, double [], int);
82 struct kinfo_proc *
83 	  kvm_getprocs(kvm_t *, int, int, int *);
84 int	  kvm_getswapinfo(kvm_t *, struct kvm_swap *, int, int);
85 int	  kvm_nlist(kvm_t *, struct nlist *);
86 kvm_t	 *kvm_open
87 (const char *, const char *, const char *, int, const char *);
88 kvm_t	 *kvm_openfiles
89 (const char *, const char *, const char *, int, char *);
90 ssize_t	  kvm_read(kvm_t *, unsigned long, void *, size_t);
91 ssize_t	  kvm_uread
92 (kvm_t *, struct kinfo_proc *, unsigned long, char *, size_t);
93 ssize_t	  kvm_write(kvm_t *, unsigned long, const void *, size_t);
94 __END_DECLS
95 
96 #endif /* !_KVM_H_ */
97