Update FILES section and add a few extra cross references.
[dragonfly.git] / test / debug / vnodeinfo.c
blobfacac153dafa2c9ea2b026172e5797c543b7405b
1 /*
2 * VNODEINFO.C
4 * cc -I/usr/src/sys vnodeinfo.c -o /usr/local/bin/vnodeinfo -lkvm
6 * vnodeinfo
8 * Dump the mountlist and related vnodes.
11 * Copyright (c) 2004 The DragonFly Project. All rights reserved.
13 * This code is derived from software contributed to The DragonFly Project
14 * by Matthew Dillon <dillon@backplane.com>
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
18 * are met:
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in
24 * the documentation and/or other materials provided with the
25 * distribution.
26 * 3. Neither the name of The DragonFly Project nor the names of its
27 * contributors may be used to endorse or promote products derived
28 * from this software without specific, prior written permission.
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
31 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
32 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
33 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
34 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
35 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
36 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
38 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
39 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
40 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 * SUCH DAMAGE.
43 * $DragonFly: src/test/debug/vnodeinfo.c,v 1.13 2007/05/06 20:45:01 dillon Exp $
46 #define _KERNEL_STRUCTURES
47 #include <sys/param.h>
48 #include <sys/user.h>
49 #include <sys/malloc.h>
50 #include <sys/signalvar.h>
51 #include <sys/namecache.h>
52 #include <sys/mount.h>
53 #include <sys/vnode.h>
54 #include <sys/buf.h>
56 #include <vm/vm.h>
57 #include <vm/vm_page.h>
58 #include <vm/vm_kern.h>
59 #include <vm/vm_object.h>
60 #include <vm/swap_pager.h>
61 #include <vm/vnode_pager.h>
63 #include <vfs/ufs/quota.h>
64 #include <vfs/ufs/inode.h>
66 #include <stdio.h>
67 #include <stdlib.h>
68 #include <string.h>
69 #include <fcntl.h>
70 #include <kvm.h>
71 #include <nlist.h>
72 #include <getopt.h>
74 struct nlist Nl[] = {
75 { "_mountlist" },
76 { "_vnode_free_list" },
77 { NULL }
80 static void kkread(kvm_t *kd, u_long addr, void *buf, size_t nbytes);
81 static struct mount *dumpmount(kvm_t *kd, struct mount *mp);
82 static struct vnode *dumpvp(kvm_t *kd, struct vnode *vp, int whichlist);
83 static void dumpbufs(kvm_t *kd, void *bufp, const char *id);
84 static void dumplocks(kvm_t *kd, struct lockf *lockf);
85 static void dumplockinfo(kvm_t *kd, struct lockf_range *item);
86 static int getobjpages(kvm_t *kd, struct vm_object *obj);
87 static int getobjvnpsize(kvm_t *kd, struct vm_object *obj);
89 int tracebufs = 0;
90 int tracelocks = 0;
91 int withnames = 0;
93 int
94 main(int ac, char **av)
96 struct mount *mp;
97 struct vnode *vp;
98 kvm_t *kd;
99 int i;
100 int ch;
101 const char *corefile = NULL;
102 const char *sysfile = NULL;
104 while ((ch = getopt(ac, av, "alnbM:N:")) != -1) {
105 switch(ch) {
106 case 'b':
107 tracebufs = 1;
108 break;
109 case 'n':
110 withnames = 1;
111 break;
112 case 'l':
113 tracelocks = 1;
114 break;
115 case 'a':
116 tracebufs = 1;
117 tracelocks = 1;
118 withnames = 1;
119 break;
120 case 'M':
121 corefile = optarg;
122 break;
123 case 'N':
124 sysfile = optarg;
125 break;
126 default:
127 fprintf(stderr, "%s [-M core] [-N system]\n", av[0]);
128 exit(1);
132 if ((kd = kvm_open(sysfile, corefile, NULL, O_RDONLY, "kvm:")) == NULL) {
133 perror("kvm_open");
134 exit(1);
136 if (kvm_nlist(kd, Nl) != 0) {
137 perror("kvm_nlist");
138 exit(1);
140 kkread(kd, Nl[0].n_value, &mp, sizeof(mp));
141 while (mp)
142 mp = dumpmount(kd, mp);
143 kkread(kd, Nl[1].n_value, &vp, sizeof(vp));
144 printf("VNODEFREELIST {\n");
145 while (vp)
146 vp = dumpvp(kd, vp, 0);
147 printf("}\n");
148 return(0);
151 static struct mount *
152 dumpmount(kvm_t *kd, struct mount *mp)
154 struct mount mnt;
155 struct vnode *vp;
157 kkread(kd, (u_long)mp, &mnt, sizeof(mnt));
158 printf("MOUNTPOINT %s on %s {\n",
159 mnt.mnt_stat.f_mntfromname, mnt.mnt_stat.f_mntonname);
160 printf(" lk_flags %08x share %d wait %d excl %d holder = %p\n",
161 mnt.mnt_lock.lk_flags, mnt.mnt_lock.lk_sharecount,
162 mnt.mnt_lock.lk_waitcount, mnt.mnt_lock.lk_exclusivecount,
163 mnt.mnt_lock.lk_lockholder);
164 printf(" mnt_flag %08x mnt_kern_flag %08x\n",
165 mnt.mnt_flag, mnt.mnt_kern_flag);
166 printf(" mnt_nvnodelistsize %d\n", mnt.mnt_nvnodelistsize);
167 printf(" mnt_stat.f_fsid %08x %08x\n", mnt.mnt_stat.f_fsid.val[0],
168 mnt.mnt_stat.f_fsid.val[1]);
169 vp = mnt.mnt_nvnodelist.tqh_first;
170 while (vp)
171 vp = dumpvp(kd, vp, 1);
173 printf("}\n");
175 return(mnt.mnt_list.tqe_next);
178 static const char *
179 vtype(enum vtype type)
181 static char buf[32];
183 switch(type) {
184 case VNON:
185 return("VNON");
186 case VREG:
187 return("VREG");
188 case VDIR:
189 return("VDIR");
190 case VBLK:
191 return("VBLK");
192 case VCHR:
193 return("VCHR");
194 case VLNK:
195 return("VLNK");
196 case VSOCK:
197 return("VSOCK");
198 case VFIFO:
199 return("VFIFO");
200 case VBAD:
201 return("VBAD");
202 default:
203 break;
205 snprintf(buf, sizeof(buf), "%d", (int)type);
206 return(buf);
209 static struct vnode *
210 dumpvp(kvm_t *kd, struct vnode *vp, int whichlist)
212 struct vnode vn;
214 kkread(kd, (u_long)vp, &vn, sizeof(vn));
216 printf(" vnode %p usecnt %08x holdcnt %d type=%s flags %08x",
217 vp, vn.v_sysref.refcnt, vn.v_auxrefs, vtype(vn.v_type), vn.v_flag);
219 if ((vn.v_flag & VOBJBUF) && vn.v_object) {
220 int npages = getobjpages(kd, vn.v_object);
221 int vnpsize = getobjvnpsize(kd, vn.v_object);
222 if (npages || vnpsize)
223 printf(" vmobjpgs=%d vnpsize=%d", npages, vnpsize);
226 if (vn.v_flag & VROOT)
227 printf(" VROOT");
228 if (vn.v_flag & VTEXT)
229 printf(" VTEXT");
230 if (vn.v_flag & VSYSTEM)
231 printf(" VSYSTEM");
232 if (vn.v_flag & VISTTY)
233 printf(" VISTTY");
234 #ifdef VXLOCK
235 if (vn.v_flag & VXLOCK)
236 printf(" VXLOCK");
237 if (vn.v_flag & VXWANT)
238 printf(" VXWANT");
239 #endif
240 #ifdef VRECLAIMED
241 if (vn.v_flag & VRECLAIMED)
242 printf(" VRECLAIMED");
243 if (vn.v_flag & VINACTIVE)
244 printf(" VINACTIVE");
245 #endif
246 if (vn.v_flag & VOBJBUF)
247 printf(" VOBJBUF");
248 if (vn.v_flag & VAGE)
249 printf(" VAGE");
250 if (vn.v_flag & VOLOCK)
251 printf(" VOLOCK");
252 if (vn.v_flag & VOWANT)
253 printf(" VOWANT");
254 #ifdef VDOOMED
255 if (vn.v_flag & VDOOMED)
256 printf(" VDOOMED");
257 #endif
258 if (vn.v_flag & VFREE)
259 printf(" VFREE");
260 if (vn.v_flag & VCACHED)
261 printf(" VCACHED");
262 #ifdef VINFREE
263 if (vn.v_flag & VINFREE)
264 printf(" VINFREE");
265 #endif
266 if (vn.v_flag & VONWORKLST)
267 printf(" VONWORKLST");
268 if (vn.v_flag & VMOUNT)
269 printf(" VMOUNT");
270 if (vn.v_flag & VOBJDIRTY)
271 printf(" VOBJDIRTY");
272 if (vn.v_flag & VMAYHAVELOCKS)
273 printf(" VMAYHAVELOCKS");
275 printf("\n");
277 if (vn.v_lock.lk_sharecount || vn.v_lock.lk_waitcount ||
278 vn.v_lock.lk_exclusivecount || vn.v_lock.lk_lockholder != LK_NOTHREAD) {
279 printf("\tlk_flags %08x share %d wait %d excl %d holder = %p\n",
280 vn.v_lock.lk_flags, vn.v_lock.lk_sharecount,
281 vn.v_lock.lk_waitcount, vn.v_lock.lk_exclusivecount,
282 vn.v_lock.lk_lockholder);
285 if (withnames && TAILQ_FIRST(&vn.v_namecache)) {
286 struct namecache ncp;
287 int nlen;
288 char buf[1024];
290 kkread(kd, (u_long)TAILQ_FIRST(&vn.v_namecache), &ncp, sizeof(ncp));
291 if ((nlen = ncp.nc_nlen) >= sizeof(buf))
292 nlen = sizeof(buf) - 1;
293 if (nlen < 0)
294 nlen = 0;
295 if (nlen) {
296 kkread(kd, (u_long)ncp.nc_name, buf, nlen);
297 buf[nlen] = 0;
298 printf("\tfilename %s\n", buf);
302 if (tracebufs) {
303 if (vn.v_rbclean_tree.rbh_root) {
304 printf("\tCLEAN BUFFERS\n");
305 dumpbufs(kd, vn.v_rbclean_tree.rbh_root, "ROOT");
307 if (vn.v_rbdirty_tree.rbh_root) {
308 printf("\tDIRTY BUFFERS\n");
309 dumpbufs(kd, vn.v_rbdirty_tree.rbh_root, "ROOT");
313 if (tracelocks) {
314 if (vn.v_tag == VT_UFS && vn.v_data) {
315 struct inode *ip = vn.v_data;
316 struct lockf lockf;
318 kkread(kd, (u_long)&ip->i_lockf, &lockf, sizeof(lockf));
319 dumplocks(kd, &lockf);
324 if (whichlist)
325 return(vn.v_nmntvnodes.tqe_next);
326 else
327 return(vn.v_freelist.tqe_next);
330 static void
331 dumpbufs(kvm_t *kd, void *bufp, const char *id)
333 struct buf buf;
335 kkread(kd, (u_long)bufp, &buf, sizeof(buf));
336 printf("\t %-8s %p loffset %08llx foffset %08llx\n",
337 id, bufp,
338 buf.b_bio1.bio_offset,
339 buf.b_bio2.bio_offset);
341 if (buf.b_rbnode.rbe_left)
342 dumpbufs(kd, buf.b_rbnode.rbe_left, "LEFT");
343 if (buf.b_rbnode.rbe_right)
344 dumpbufs(kd, buf.b_rbnode.rbe_right, "RIGHT");
347 static void
348 dumplocks(kvm_t *kd, struct lockf *lockf)
350 struct lockf_range item;
351 struct lockf_range *scan;
353 if ((scan = TAILQ_FIRST(&lockf->lf_range)) != NULL) {
354 printf("\tLOCKS\n");
355 do {
356 kkread(kd, (u_long)scan, &item, sizeof(item));
357 dumplockinfo(kd, &item);
358 } while ((scan = TAILQ_NEXT(&item, lf_link)) != NULL);
359 printf("\n");
361 if ((scan = TAILQ_FIRST(&lockf->lf_blocked)) != NULL) {
362 printf("\tBLKED\n");
363 do {
364 kkread(kd, (u_long)scan, &item, sizeof(item));
365 dumplockinfo(kd, &item);
366 } while ((scan = TAILQ_NEXT(&item, lf_link)) != NULL);
367 printf("\n");
372 static void
373 dumplockinfo(kvm_t *kd, struct lockf_range *item)
375 int ownerpid;
377 if (item->lf_owner && (item->lf_flags & F_POSIX)) {
378 kkread(kd, (u_long)&item->lf_owner->p_pid,
379 &ownerpid, sizeof(ownerpid));
380 } else {
381 ownerpid = -1;
384 printf("\t ty=%d flgs=%04x %lld-%lld owner=%d\n",
385 item->lf_type, item->lf_flags,
386 item->lf_start, item->lf_end,
387 ownerpid
391 static
393 getobjpages(kvm_t *kd, struct vm_object *obj)
395 struct vm_object vmobj;
397 kkread(kd, (u_long)obj, &vmobj, sizeof(vmobj));
398 return(vmobj.resident_page_count);
401 static
403 getobjvnpsize(kvm_t *kd, struct vm_object *obj)
405 struct vm_object vmobj;
407 kkread(kd, (u_long)obj, &vmobj, sizeof(vmobj));
408 return ((int)vmobj.size);
411 static void
412 kkread(kvm_t *kd, u_long addr, void *buf, size_t nbytes)
414 if (kvm_read(kd, addr, buf, nbytes) != nbytes) {
415 perror("kvm_read");
416 exit(1);