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