Module Name: src
Committed By: pooka
Date: Wed Jan 12 16:14:24 UTC 2011
Modified Files:
src/usr.bin: Makefile
Added Files:
src/usr.bin/shmif_dumpbus: Makefile shmif_dumpbus.1 shmif_dumpbus.c
Log Message:
shmif(4) bus dumping utility
To generate a diff of this commit:
cvs rdiff -u -r1.197 -r1.198 src/usr.bin/Makefile
cvs rdiff -u -r0 -r1.1 src/usr.bin/shmif_dumpbus/Makefile \
src/usr.bin/shmif_dumpbus/shmif_dumpbus.1 \
src/usr.bin/shmif_dumpbus/shmif_dumpbus.c
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/Makefile
diff -u src/usr.bin/Makefile:1.197 src/usr.bin/Makefile:1.198
--- src/usr.bin/Makefile:1.197 Sun Dec 26 11:31:43 2010
+++ src/usr.bin/Makefile Wed Jan 12 16:14:24 2011
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.197 2010/12/26 11:31:43 jmcneill Exp $
+# $NetBSD: Makefile,v 1.198 2011/01/12 16:14:24 pooka Exp $
# from: @(#)Makefile 8.3 (Berkeley) 1/7/94
.include <bsd.own.mk>
@@ -23,7 +23,7 @@
printenv printf progress pwhash qsubst quota radioctl rdist \
renice rev revoke rfcomm_sppd rlogin rpcgen rpcinfo rs rsh \
rump_allserver rump_halt rump_server rup ruptime rusers rwall rwho \
- script sdiff sdpquery sed seq shar shlock \
+ script sdiff sdpquery sed seq shar shlock shmif_dumpbus \
showmount shuffle sockstat soelim sort spell split stat su systat \
tabs tail talk tcopy tee telnet tftp tic time tip touch tput \
tr true tset tsort tty ul uname unexpand unifdef \
Added files:
Index: src/usr.bin/shmif_dumpbus/Makefile
diff -u /dev/null src/usr.bin/shmif_dumpbus/Makefile:1.1
--- /dev/null Wed Jan 12 16:14:24 2011
+++ src/usr.bin/shmif_dumpbus/Makefile Wed Jan 12 16:14:24 2011
@@ -0,0 +1,13 @@
+# $NetBSD: Makefile,v 1.1 2011/01/12 16:14:24 pooka Exp $
+#
+
+.include <bsd.own.mk>
+
+SHMIFD= ${NETBSDSRCDIR}/sys/rump/net/lib/libshmif
+.PATH: ${SHMIFD}
+
+PROG= shmif_dumpbus
+SRCS+= shmif_dumpbus.c shmif_busops.c
+CPPFLAGS+= -I${SHMIFD}
+
+.include <bsd.prog.mk>
Index: src/usr.bin/shmif_dumpbus/shmif_dumpbus.1
diff -u /dev/null src/usr.bin/shmif_dumpbus/shmif_dumpbus.1:1.1
--- /dev/null Wed Jan 12 16:14:24 2011
+++ src/usr.bin/shmif_dumpbus/shmif_dumpbus.1 Wed Jan 12 16:14:24 2011
@@ -0,0 +1,80 @@
+.\" $NetBSD: shmif_dumpbus.1,v 1.1 2011/01/12 16:14:24 pooka Exp $
+.\"
+.\" Copyright (c) 2011 Antti Kantee. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd January 12, 2011
+.Dt SHMIF_DUMPBUS 1
+.Os
+.Sh NAME
+.Nm shmif_dumpbus
+.Nd examine shmif bus contents
+.Sh SYNOPSIS
+.Nm
+.Op Fl h
+.Op Fl p Ar pcapfile
+.Ar busfile
+.Sh DESCRIPTION
+The
+.Nm
+utility examines the bus of an
+.Xr shmif 4
+Ethernet interface.
+The most useful feature is converting the bus to the
+.Xr pcap 3
+file format for later examination.
+.Nm
+itself is limited to displaying only very basic information about
+each frame.
+.Pp
+.Nm
+accepts the following flags:
+.Bl -tag -width xxxpcapfilexxx
+.It Fl h
+Print bus header only and skip contents.
+.It Fl p Ar pcapfile
+Convert bus contents to the
+.Xr pcap 3
+format and write the result to
+.Ar pcapfile .
+The file
+.Fl
+signifies stdout.
+.El
+.Sh EXAMPLES
+Feed the busfile contents to pcap:
+.Bd -literal -offset indent
+$ shmif_dumpbus -p - busfile | tcpdump -r -
+.Ed
+.Sh SEE ALSO
+.Xr tcpdump 1 ,
+.Xr pcap 3 ,
+.Xr shmif 4
+.Sh CAVEATS
+.Nm
+does not lock the busfile and is best used for post-mortem analysis
+of the bus traffic.
+.Pp
+The timestamp for each frame contains the sender's timestamp and
+may not be monotonically increasing with respect to the frame order
+in the dump.
Index: src/usr.bin/shmif_dumpbus/shmif_dumpbus.c
diff -u /dev/null src/usr.bin/shmif_dumpbus/shmif_dumpbus.c:1.1
--- /dev/null Wed Jan 12 16:14:24 2011
+++ src/usr.bin/shmif_dumpbus/shmif_dumpbus.c Wed Jan 12 16:14:24 2011
@@ -0,0 +1,196 @@
+/* $NetBSD: shmif_dumpbus.c,v 1.1 2011/01/12 16:14:24 pooka Exp $ */
+
+/*-
+ * Copyright (c) 2010 Antti Kantee. All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+/*
+ * Convert shmif bus traffic to a pcap file which can be then
+ * examined with tcpdump -r, wireshark, etc.
+ */
+
+#include <sys/types.h>
+#include <sys/mman.h>
+#include <sys/stat.h>
+
+#include <assert.h>
+#include <err.h>
+#include <fcntl.h>
+#include <inttypes.h>
+#include <pcap.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "shmifvar.h"
+
+static void
+usage(void)
+{
+
+ fprintf(stderr, "usage: %s [-h] [-p pcapfile] buspath\n",getprogname());
+ exit(1);
+}
+
+#define BUFSIZE 64*1024
+int
+main(int argc, char *argv[])
+{
+ struct stat sb;
+ void *busmem;
+ const char *pcapfile = NULL;
+ uint32_t curbus, buslast;
+ struct shmif_mem *bmem;
+ int fd, pfd, i, ch;
+ int bonus;
+ char *buf;
+ bool hflag = false;
+
+ setprogname(argv[0]);
+ while ((ch = getopt(argc, argv, "hp:")) != -1) {
+ switch (ch) {
+ case 'h':
+ hflag = true;
+ break;
+ case 'p':
+ pcapfile = optarg;
+ break;
+ default:
+ usage();
+ }
+ }
+
+ argc -= optind;
+ argv += optind;
+
+ if (argc != 1)
+ usage();
+
+ buf = malloc(BUFSIZE);
+ if (buf == NULL)
+ err(1, "malloc");
+
+ fd = open(argv[0], O_RDONLY);
+ if (fd == -1)
+ err(1, "open bus");
+
+ if (fstat(fd, &sb) == -1)
+ err(1, "stat");
+
+ busmem = mmap(NULL, sb.st_size, PROT_READ, MAP_FILE|MAP_SHARED, fd, 0);
+ if (busmem == MAP_FAILED)
+ err(1, "mmap");
+ bmem = busmem;
+
+ if (bmem->shm_magic != SHMIF_MAGIC)
+ errx(1, "%s not a shmif bus", argv[0]);
+ if (bmem->shm_version != SHMIF_VERSION)
+ errx(1, "bus vesrsion %d, program %d",
+ bmem->shm_version, SHMIF_VERSION);
+ printf("bus version %d, lock: %d, generation: %" PRIu64
+ ", firstoff: 0x%04x, lastoff: 0x%04x\n",
+ bmem->shm_version, bmem->shm_lock, bmem->shm_gen,
+ bmem->shm_first, bmem->shm_last);
+
+ if (hflag)
+ exit(0);
+
+ if (pcapfile) {
+ struct pcap_file_header phdr;
+
+ if (strcmp(pcapfile, "-") == 0) {
+ pfd = STDOUT_FILENO;
+ } else {
+ pfd = open(pcapfile, O_RDWR | O_CREAT | O_TRUNC, 0777);
+ if (pfd == -1)
+ err(1, "create pcap dump");
+ }
+
+ memset(&phdr, 0, sizeof(phdr));
+ phdr.magic = 0xa1b2c3d4; /* tcpdump magic */
+ phdr.version_major = PCAP_VERSION_MAJOR;
+ phdr.version_minor = PCAP_VERSION_MINOR;
+ phdr.snaplen = 1518;
+ phdr.linktype = DLT_EN10MB;
+
+ if (write(pfd, &phdr, sizeof(phdr)) != sizeof(phdr))
+ err(1, "phdr write");
+ } else {
+ pfd = 0; /* XXXgcc */
+ }
+
+ curbus = bmem->shm_first;
+ buslast = bmem->shm_last;
+ if (curbus == BUSMEM_DATASIZE)
+ curbus = 0;
+
+ bonus = 0;
+ if (buslast < curbus)
+ bonus = 1;
+
+ i = 0;
+ while (curbus <= buslast || bonus) {
+ struct pcap_pkthdr packhdr;
+ struct shmif_pkthdr sp;
+ uint32_t oldoff;
+ bool wrap;
+
+ wrap = false;
+ oldoff = curbus;
+ curbus = shmif_busread(bmem, &sp, oldoff, sizeof(sp), &wrap);
+ if (wrap)
+ bonus = 0;
+
+ if (sp.sp_len == 0)
+ continue;
+
+ printf("packet %d, offset 0x%04x, length 0x%04x, ts %d/%06d\n",
+ i++, curbus, sp.sp_len, sp.sp_sec, sp.sp_usec);
+
+ if (!pcapfile || sp.sp_len == 0) {
+ curbus = shmif_busread(bmem,
+ buf, curbus, sp.sp_len, &wrap);
+ if (wrap)
+ bonus = 0;
+ continue;
+ }
+
+ memset(&packhdr, 0, sizeof(packhdr));
+ packhdr.caplen = packhdr.len = sp.sp_len;
+ packhdr.ts.tv_sec = sp.sp_sec;
+ packhdr.ts.tv_usec = sp.sp_usec;
+
+ if (write(pfd, &packhdr, sizeof(packhdr)) != sizeof(packhdr))
+ err(1, "error writing packethdr");
+ curbus = shmif_busread(bmem, buf, curbus, sp.sp_len, &wrap);
+ if (write(pfd, buf, sp.sp_len) != (ssize_t)sp.sp_len)
+ err(1, "write packet");
+ if (wrap)
+ bonus = 0;
+ }
+
+ return 0;
+}
