xref: /netbsd-src/usr.bin/pmap/pmap.h (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: pmap.h,v 1.10 2017/06/09 00:13:29 chs Exp $ */
2 
3 /*
4  * Copyright (c) 2002, 2003 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Andrew Brown.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * only pull in the headers once.  if we attempt to pull them in
34  * again, we get namespace collisions on some structures, and we don't
35  * want to redefine some of them since it will affect the layout of
36  * the struct kbit.
37  */
38 #ifndef PMAP_HEADERS
39 
40 #include <err.h>
41 #include <kvm.h>
42 #include <stddef.h>
43 #include <stdlib.h>
44 
45 #include <sys/types.h>
46 #include <sys/param.h>
47 #include <sys/time.h>
48 #include <sys/vnode.h>
49 #define __EXPOSE_MOUNT
50 #include <sys/mount.h>
51 #include <sys/uio.h>
52 #include <sys/namei.h>
53 #include <sys/sysctl.h>
54 
55 #include <uvm/uvm.h>
56 #include <uvm/uvm_device.h>
57 
58 #include <ufs/ufs/inode.h>
59 #undef doff_t
60 #undef IN_ACCESS
61 #include <isofs/cd9660/iso.h>
62 #include <isofs/cd9660/cd9660_node.h>
63 
64 #define PMAP_HEADERS
65 #endif /* PMAP_HEADERS */
66 
67 /*
68  * if the definition of the kbit structure (and the accessor macros)
69  * is already established, don't redefine it.
70  */
71 #ifndef struct_kbit
72 
73 /*
74  * stolen (and munged) from #include <uvm/uvm_object.h>
75  */
76 #define UVM_OBJ_IS_VNODE(uobj)    ((uobj)->pgops == uvm_vnodeops)
77 #define UVM_OBJ_IS_AOBJ(uobj)     ((uobj)->pgops == aobj_pager)
78 #define UVM_OBJ_IS_DEVICE(uobj)   ((uobj)->pgops == uvm_deviceops)
79 #define UVM_OBJ_IS_UBCPAGER(uobj) ((uobj)->pgops == ubc_pager)
80 
81 /*
82  * stolen from #include <uvm/uvm_amap.h>
83  */
84 #define PPREF_NONE ((int *) -1)
85 
86 /* the size of the object in the kernel */
87 #define S(x)	((x)->k_size)
88 /* the address of the object in kernel, two forms */
89 #define A(x)	((x)->k_addr.k_addr_ul)
90 #define P(x)	((x)->k_addr.k_addr_p)
91 /* the data from the kernel */
92 #define D(x,d)	(&((x)->k_data.d))
93 
94 /* suck the data from the kernel */
95 #define _KDEREFOK(kd, addr, dst, sz) \
96 	((size_t)kvm_read((kd), (addr), (dst), (sz)) == (size_t)(sz))
97 #define _KDEREF(kd, addr, dst, sz) do { \
98 	if (!_KDEREFOK((kd), (addr), (dst), (sz))) \
99 		errx(1, "trying to read %lu (%s) bytes from %lx: %s", \
100 		    (unsigned long)(sz), #sz, (addr), kvm_geterr(kd)); \
101 } while (0/*CONSTCOND*/)
102 
103 /* suck the data using the structure */
104 #define KDEREFOK(kd, item) _KDEREFOK((kd), A(item), D(item, data), S(item))
105 #define KDEREF(kd, item) _KDEREF((kd), A(item), D(item, data), S(item))
106 
107 struct kbit {
108 	/*
109 	 * size of data chunk
110 	 */
111 	size_t k_size;
112 
113 	/*
114 	 * something for printf() and something for kvm_read()
115 	 */
116 	union {
117 		void *k_addr_p;
118 		u_long k_addr_ul;
119 	} k_addr;
120 
121 	/*
122 	 * where we actually put the "stuff"
123 	 */
124 	union {
125 		char data[1];
126 		struct vmspace vmspace;
127 		struct vm_map vm_map;
128 		struct vm_map_entry vm_map_entry;
129 		struct vnode vnode;
130 		struct uvm_object uvm_object;
131 		struct mount mount;
132 		struct namecache namecache;
133 		struct inode inode;
134 		struct iso_node iso_node;
135 		struct uvm_device uvm_device;
136 		struct vm_amap amap;
137 		struct vm_anon anon;
138 	} k_data;
139 };
140 #define struct_kbit
141 #endif /* struct_kbit */
142 
143 /*
144  * this is the *actual* module interface
145  */
146 
147 void process_map(kvm_t *, struct kinfo_proc2 *,
148 				   struct kbit *, const char *);
149 void dump_vm_map(kvm_t *, struct kinfo_proc2 *,
150 				   struct kbit *, struct kbit *, const char *);
151 size_t dump_vm_map_entry(kvm_t *, struct kinfo_proc2 *,
152 					   struct kbit *, struct kbit *, int);
153 void dump_amap(kvm_t *, struct kbit *);
154