opdump.c revision 1.31
1/*	$NetBSD: opdump.c,v 1.31 2010/05/20 13:07:28 pooka Exp $	*/
2
3/*
4 * Copyright (c) 2005, 2006  Antti Kantee.  All Rights Reserved.
5 *
6 * Development of this software was supported by the
7 * Google Summer of Code program and the Ulla Tuominen Foundation.
8 * The Google SoC project was mentored by Bill Studenmund.
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 AUTHOR ``AS IS'' AND ANY EXPRESS
20 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 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 OR
25 * 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/* Pretty-printing helper routines for VFS/VOP request contents */
33
34/* yes, this is pretty much a mess */
35
36#include <sys/cdefs.h>
37#if !defined(lint)
38__RCSID("$NetBSD: opdump.c,v 1.31 2010/05/20 13:07:28 pooka Exp $");
39#endif /* !lint */
40
41#include <sys/types.h>
42#include <sys/time.h>
43
44#include <puffs.h>
45#include <puffsdump.h>
46#include <stdio.h>
47
48#include "puffs_priv.h"
49
50#define DINT "    "
51
52/* XXX! */
53const char *vfsop_revmap[] = {
54	"PUFFS_VFS_MOUNT",
55	"PUFFS_VFS_START",
56	"PUFFS_VFS_UNMOUNT",
57	"PUFFS_VFS_ROOT",
58	"PUFFS_VFS_STATVFS",
59	"PUFFS_VFS_SYNC",
60	"PUFFS_VFS_VGET",
61	"PUFFS_VFS_FHTOVP",
62	"PUFFS_VFS_VPTOFH",
63	"PUFFS_VFS_INIT",
64	"PUFFS_VFS_DONE",
65	"PUFFS_VFS_SNAPSHOT",
66	"PUFFS_VFS_EXTATTRCTL",
67	"PUFFS_VFS_SUSPEND"
68};
69/* XXX! */
70const char *vnop_revmap[] = {
71	"PUFFS_VN_LOOKUP",
72	"PUFFS_VN_CREATE",
73	"PUFFS_VN_MKNOD",
74	"PUFFS_VN_OPEN",
75	"PUFFS_VN_CLOSE",
76	"PUFFS_VN_ACCESS",
77	"PUFFS_VN_GETATTR",
78	"PUFFS_VN_SETATTR",
79	"PUFFS_VN_READ",
80	"PUFFS_VN_WRITE",
81	"PUFFS_VN_IOCTL",
82	"PUFFS_VN_FCNTL",
83	"PUFFS_VN_POLL",
84	"PUFFS_VN_KQFILTER",
85	"PUFFS_VN_REVOKE",
86	"PUFFS_VN_MMAP",
87	"PUFFS_VN_FSYNC",
88	"PUFFS_VN_SEEK",
89	"PUFFS_VN_REMOVE",
90	"PUFFS_VN_LINK",
91	"PUFFS_VN_RENAME",
92	"PUFFS_VN_MKDIR",
93	"PUFFS_VN_RMDIR",
94	"PUFFS_VN_SYMLINK",
95	"PUFFS_VN_READDIR",
96	"PUFFS_VN_READLINK",
97	"PUFFS_VN_ABORTOP",
98	"PUFFS_VN_INACTIVE",
99	"PUFFS_VN_RECLAIM",
100	"PUFFS_VN_LOCK",
101	"PUFFS_VN_UNLOCK",
102	"PUFFS_VN_BMAP",
103	"PUFFS_VN_STRATEGY",
104	"PUFFS_VN_PRINT",
105	"PUFFS_VN_ISLOCKED",
106	"PUFFS_VN_PATHCONF",
107	"PUFFS_VN_ADVLOCK",
108	"PUFFS_VN_LEASE",
109	"PUFFS_VN_WHITEOUT",
110	"PUFFS_VN_GETPAGES",
111	"PUFFS_VN_PUTPAGES",
112	"PUFFS_VN_GETEXTATTR",
113	"PUFFS_VN_LISTEXTATTR",
114	"PUFFS_VN_OPENEXTATTR",
115	"PUFFS_VN_DELETEEXTATTR",
116	"PUFFS_VN_SETEXTATTR",
117};
118/* XXX! */
119const char *cacheop_revmap[] = {
120	"PUFFS_CACHE_WRITE"
121};
122/* XXX! */
123const char *errnot_revmap[] = {
124	"PUFFS_ERR_MAKENODE",
125	"PUFFS_ERR_LOOKUP",
126	"PUFFS_ERR_READDIR",
127	"PUFFS_ERR_READLINK",
128	"PUFFS_ERR_READ",
129	"PUFFS_ERR_WRITE",
130	"PUFFS_ERR_VPTOFH"
131};
132/* XXX! */
133const char *flush_revmap[] = {
134	"PUFFS_INVAL_NAMECACHE_NODE",
135	"PUFFS_INVAL_NAMECACHE_DIR",
136	"PUFFS_INVAL_NAMECACHE_ALL",
137	"PUFFS_INVAL_PAGECACHE_NODE_RANGE",
138	"PUFFS_FLUSH_PAGECACHE_NODE_RANGE",
139};
140
141void
142puffsdump_req(struct puffs_req *preq)
143{
144	static struct timeval tv_prev;
145	struct timeval tv_now, tv;
146	const char **map;
147	int isvn = 0;
148
149	printf("reqid: %" PRIu64 ", ", preq->preq_id);
150	switch (PUFFSOP_OPCLASS(preq->preq_opclass)) {
151	case PUFFSOP_VFS:
152		map = vfsop_revmap;
153		break;
154	case PUFFSOP_VN:
155		map = vnop_revmap;
156		isvn = 1;
157		break;
158	case PUFFSOP_CACHE:
159		map = cacheop_revmap;
160		break;
161	case PUFFSOP_ERROR:
162		map = errnot_revmap;
163		break;
164	case PUFFSOP_FLUSH:
165		map = flush_revmap;
166		break;
167	default:
168		printf("unhandled opclass\n");
169		return;
170	}
171
172	printf("opclass %d%s, optype: %s, "
173	    "cookie: %p,\n" DINT "aux: %p, auxlen: %zu, pid: %d, lwpid: %d\n",
174	    PUFFSOP_OPCLASS(preq->preq_opclass),
175	    PUFFSOP_WANTREPLY(preq->preq_opclass) ? "" : " (FAF)",
176	    map[preq->preq_optype], preq->preq_cookie,
177	    preq->preq_buf, preq->preq_buflen,
178	    preq->preq_pid, preq->preq_lid);
179
180	if (isvn) {
181		switch (preq->preq_optype) {
182		case PUFFS_VN_LOOKUP:
183			puffsdump_lookup(preq);
184			break;
185		case PUFFS_VN_READ:
186		case PUFFS_VN_WRITE:
187			puffsdump_readwrite(preq);
188			break;
189		case PUFFS_VN_OPEN:
190			puffsdump_open(preq);
191			break;
192		case PUFFS_VN_REMOVE:
193		case PUFFS_VN_RMDIR:
194		case PUFFS_VN_LINK:
195			puffsdump_targ(preq);
196			break;
197		case PUFFS_VN_READDIR:
198			puffsdump_readdir(preq);
199			break;
200		case PUFFS_VN_CREATE:
201		case PUFFS_VN_MKDIR:
202		case PUFFS_VN_MKNOD:
203		case PUFFS_VN_SYMLINK:
204			puffsdump_create(preq);
205			break;
206		case PUFFS_VN_SETATTR:
207			puffsdump_attr(preq);
208			break;
209		default:
210			break;
211		}
212	}
213
214	PU_LOCK();
215	gettimeofday(&tv_now, NULL);
216	timersub(&tv_now, &tv_prev, &tv);
217	printf(DINT "since previous call: %lld.%06ld\n",
218	    (long long)tv.tv_sec, (long)tv.tv_usec);
219	gettimeofday(&tv_prev, NULL);
220	PU_UNLOCK();
221}
222
223void
224puffsdump_rv(struct puffs_req *preq)
225{
226
227	if (PUFFSOP_OPCLASS(preq->preq_opclass) == PUFFSOP_VN) {
228		switch (preq->preq_optype) {
229		case PUFFS_VN_LOOKUP:
230			puffsdump_lookup_rv(preq);
231			break;
232		case PUFFS_VN_CREATE:
233		case PUFFS_VN_MKDIR:
234		case PUFFS_VN_MKNOD:
235		case PUFFS_VN_SYMLINK:
236			puffsdump_create_rv(preq);
237			break;
238		case PUFFS_VN_READ:
239		case PUFFS_VN_WRITE:
240			puffsdump_readwrite_rv(preq);
241			break;
242		case PUFFS_VN_READDIR:
243			puffsdump_readdir_rv(preq);
244			break;
245		case PUFFS_VN_GETATTR:
246			puffsdump_attr(preq);
247			break;
248		default:
249			break;
250		}
251	}
252
253	printf("RV reqid: %" PRIu64 ", result: %d %s\n",
254	    preq->preq_id, preq->preq_rv,
255	    preq->preq_rv ? strerror(preq->preq_rv) : "");
256}
257
258/*
259 * Slightly tedious print-routine so that we get a nice NOVAL instead
260 * of some tedious output representations for -1, especially (uint64_t)-1
261 *
262 * We use typecasting to make this work beyond time_t/dev_t size changes.
263 */
264static void
265dumpattr(struct vattr *vap)
266{
267	const char * const vtypes[] = { VNODE_TYPES };
268	char buf[128];
269
270/* XXX: better readability.  and this is debug, so no cycle-sweat */
271#define DEFAULTBUF() snprintf(buf, sizeof(buf), "NOVAL")
272
273	printf(DINT "vattr:\n");
274	printf(DINT DINT "type: %s, ", vtypes[vap->va_type]);
275
276	DEFAULTBUF();
277	if (vap->va_mode != (mode_t)PUFFS_VNOVAL)
278		snprintf(buf, sizeof(buf), "0%o", vap->va_mode);
279	printf("mode: %s, ", buf);
280
281	DEFAULTBUF();
282	if (vap->va_nlink != (nlink_t)PUFFS_VNOVAL)
283		snprintf(buf, sizeof(buf), "%d", vap->va_nlink);
284	printf("nlink: %s, ", buf);
285
286	DEFAULTBUF();
287	if (vap->va_uid != (uid_t)PUFFS_VNOVAL)
288		snprintf(buf, sizeof(buf), "%d", vap->va_uid);
289	printf("uid: %s, ", buf);
290
291	DEFAULTBUF();
292	if (vap->va_gid != (gid_t)PUFFS_VNOVAL)
293		snprintf(buf, sizeof(buf), "%d", vap->va_gid);
294	printf("gid: %s\n", buf);
295
296	DEFAULTBUF();
297	if ((unsigned long long)vap->va_fsid!=(unsigned long long)PUFFS_VNOVAL)
298		snprintf(buf, sizeof(buf), "0x%llx",
299		    (unsigned long long)vap->va_fsid);
300	printf(DINT DINT "fsid: %s, ", buf);
301
302	DEFAULTBUF();
303	if (vap->va_fileid != (ino_t)PUFFS_VNOVAL)
304		snprintf(buf, sizeof(buf), "%" PRIu64, vap->va_fileid);
305	printf("ino: %s, ", buf);
306
307	DEFAULTBUF();
308	if (vap->va_size != (u_quad_t)PUFFS_VNOVAL)
309		snprintf(buf, sizeof(buf), "%" PRIu64, vap->va_size);
310	printf("size: %s, ", buf);
311
312	DEFAULTBUF();
313	if (vap->va_blocksize != (long)PUFFS_VNOVAL)
314		snprintf(buf, sizeof(buf), "%ld", vap->va_blocksize);
315	printf("bsize: %s\n", buf);
316
317	DEFAULTBUF();
318	if (vap->va_atime.tv_sec != (time_t)PUFFS_VNOVAL)
319		snprintf(buf, sizeof(buf), "%lld",
320		    (long long)vap->va_atime.tv_sec);
321	printf(DINT DINT "a.s: %s, ", buf);
322
323	DEFAULTBUF();
324	if (vap->va_atime.tv_nsec != (long)PUFFS_VNOVAL)
325		snprintf(buf, sizeof(buf), "%ld", vap->va_atime.tv_nsec);
326	printf("a.ns: %s, ", buf);
327
328	DEFAULTBUF();
329	if (vap->va_mtime.tv_sec != (time_t)PUFFS_VNOVAL)
330		snprintf(buf, sizeof(buf), "%lld",
331		    (long long)vap->va_mtime.tv_sec);
332	printf("m.s: %s, ", buf);
333
334	DEFAULTBUF();
335	if (vap->va_mtime.tv_nsec != (long)PUFFS_VNOVAL)
336		snprintf(buf, sizeof(buf), "%ld", vap->va_mtime.tv_nsec);
337	printf("m.ns: %s\n", buf);
338
339	DEFAULTBUF();
340	if (vap->va_ctime.tv_sec != (time_t)PUFFS_VNOVAL)
341		snprintf(buf, sizeof(buf), "%lld",
342		    (long long)vap->va_ctime.tv_sec);
343	printf(DINT DINT "c.s: %s, ", buf);
344
345	DEFAULTBUF();
346	if (vap->va_ctime.tv_nsec != (long)PUFFS_VNOVAL)
347		snprintf(buf, sizeof(buf), "%ld", vap->va_ctime.tv_nsec);
348	printf("c.ns: %s, ", buf);
349
350	DEFAULTBUF();
351	if (vap->va_birthtime.tv_sec != (time_t)PUFFS_VNOVAL)
352		snprintf(buf, sizeof(buf), "%lld",
353		    (long long)vap->va_birthtime.tv_sec);
354	printf("b.s: %s, ", buf);
355
356	DEFAULTBUF();
357	if (vap->va_birthtime.tv_nsec != (long)PUFFS_VNOVAL)
358		snprintf(buf, sizeof(buf), "%ld", vap->va_birthtime.tv_nsec);
359	printf("b.ns: %s\n", buf);
360
361	DEFAULTBUF();
362	if (vap->va_gen != (u_long)PUFFS_VNOVAL)
363		snprintf(buf, sizeof(buf), "%lu", vap->va_gen);
364	printf(DINT DINT "gen: %s, ", buf);
365
366	DEFAULTBUF();
367	if (vap->va_flags != (u_long)PUFFS_VNOVAL)
368		snprintf(buf, sizeof(buf), "0x%lx", vap->va_flags);
369	printf("flags: %s, ", buf);
370
371	DEFAULTBUF();
372	if (vap->va_rdev != (dev_t)PUFFS_VNOVAL)
373		snprintf(buf, sizeof(buf), "0x%llx",
374		    (unsigned long long)vap->va_rdev);
375	printf("rdev: %s\n", buf);
376
377	DEFAULTBUF();
378	if (vap->va_bytes != (u_quad_t)PUFFS_VNOVAL)
379		snprintf(buf, sizeof(buf), "%" PRIu64, vap->va_bytes);
380	printf(DINT DINT "bytes: %s, ", buf);
381
382	snprintf(buf, sizeof(buf), "%" PRIu64, vap->va_filerev);
383	printf("filerev: %s, ", buf);
384
385	snprintf(buf, sizeof(buf), "0x%x", vap->va_vaflags);
386	printf("vaflags: %s\n", buf);
387}
388
389void
390puffsdump_cookie(puffs_cookie_t c, const char *cookiename)
391{
392
393	printf("%scookie: at %p\n", cookiename, c);
394}
395
396static const char *cn_opnames[] = {
397	"LOOKUP",
398	"CREATE",
399	"DELETE",
400	"RENAME"
401};
402
403void
404puffsdump_cn(struct puffs_kcn *pkcn)
405{
406
407	printf(DINT "puffs_cn: \"%s\", len %zu op %s (flags 0x%x)\n",
408	    pkcn->pkcn_name, pkcn->pkcn_namelen,
409	    cn_opnames[pkcn->pkcn_nameiop & NAMEI_OPMASK],
410	    pkcn->pkcn_flags);
411}
412
413void
414puffsdump_lookup(struct puffs_req *preq)
415{
416	struct puffs_vnmsg_lookup *lookup_msg = (void *)preq;
417
418	puffsdump_cn(&lookup_msg->pvnr_cn);
419}
420
421void
422puffsdump_lookup_rv(struct puffs_req *preq)
423{
424	struct puffs_vnmsg_lookup *lookup_msg = (void *)preq;
425
426	printf(DINT "new %p, type 0x%x, size 0x%"PRIu64", dev 0x%llx\n",
427	    lookup_msg->pvnr_newnode, lookup_msg->pvnr_vtype,
428	    lookup_msg->pvnr_size, (unsigned long long)lookup_msg->pvnr_rdev);
429}
430
431void
432puffsdump_create(struct puffs_req *preq)
433{
434	/* XXX: wrong type, but we know it fits the slot */
435	struct puffs_vnmsg_create *create_msg = (void *)preq;
436
437	dumpattr(&create_msg->pvnr_va);
438}
439
440void
441puffsdump_create_rv(struct puffs_req *preq)
442{
443	/* XXX: wrong type, but we know it fits the slot */
444	struct puffs_vnmsg_create *create_msg = (void *)preq;
445
446	printf(DINT "new %p\n", create_msg->pvnr_newnode);
447}
448
449void
450puffsdump_readwrite(struct puffs_req *preq)
451{
452	struct puffs_vnmsg_rw *rw_msg = (void *)preq;
453
454	printf(DINT "offset: %" PRId64 ", resid %zu, ioflag 0x%x\n",
455	    rw_msg->pvnr_offset, rw_msg->pvnr_resid, rw_msg->pvnr_ioflag);
456}
457
458void
459puffsdump_readwrite_rv(struct puffs_req *preq)
460{
461	struct puffs_vnmsg_rw *rw_msg = (void *)preq;
462
463	printf(DINT "resid after op: %zu\n", rw_msg->pvnr_resid);
464}
465
466void
467puffsdump_readdir_rv(struct puffs_req *preq)
468{
469	struct puffs_vnmsg_readdir *readdir_msg = (void *)preq;
470
471	printf(DINT "resid after op: %zu, eofflag %d\n",
472	    readdir_msg->pvnr_resid, readdir_msg->pvnr_eofflag);
473}
474
475void
476puffsdump_open(struct puffs_req *preq)
477{
478	struct puffs_vnmsg_open *open_msg = (void *)preq;
479
480	printf(DINT "mode: 0x%x\n", open_msg->pvnr_mode);
481}
482
483void
484puffsdump_targ(struct puffs_req *preq)
485{
486	struct puffs_vnmsg_remove *remove_msg = (void *)preq; /* XXX! */
487
488	printf(DINT "target cookie: %p\n", remove_msg->pvnr_cookie_targ);
489}
490
491void
492puffsdump_readdir(struct puffs_req *preq)
493{
494	struct puffs_vnmsg_readdir *readdir_msg = (void *)preq;
495
496	printf(DINT "read offset: %" PRId64 "\n", readdir_msg->pvnr_offset);
497}
498
499void
500puffsdump_attr(struct puffs_req *preq)
501{
502	struct puffs_vnmsg_setgetattr *attr_msg = (void *)preq;
503
504	dumpattr(&attr_msg->pvnr_va);
505}
506