etherdump.cc revision 1388 
1/*
2 * Copyright (c) 2002-2004 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/* @file
30 * Simple object for creating a simple pcap style packet trace
31 */
32
33#include <sys/time.h>
34
35#include <algorithm>
36#include <string>
37
38#include "base/misc.hh"
39#include "base/output.hh"
40#include "dev/etherdump.hh"
41#include "sim/builder.hh"
42#include "sim/universe.hh"
43
44using std::string;
45
46EtherDump::EtherDump(const string &name, const string &file, int max)
47    : SimObject(name), stream(file.c_str()), maxlen(max)
48{
49}
50
51#define DLT_EN10MB		1       	// Ethernet (10Mb)
52#define TCPDUMP_MAGIC		0xa1b2c3d4
53#define PCAP_VERSION_MAJOR	2
54#define PCAP_VERSION_MINOR	4
55
56struct pcap_file_header {
57    uint32_t magic;
58    uint16_t version_major;
59    uint16_t version_minor;
60    int32_t thiszone;		// gmt to local correction
61    uint32_t sigfigs;		// accuracy of timestamps
62    uint32_t snaplen;		// max length saved portion of each pkt
63    uint32_t linktype;		// data link type (DLT_*)
64};
65
66struct pcap_pkthdr {
67    uint32_t seconds;
68    uint32_t microseconds;
69    uint32_t caplen;		// length of portion present
70    uint32_t len;		// length this packet (off wire)
71};
72
73void
74EtherDump::init()
75{
76    curtime = time(NULL);
77    s_freq = ticksPerSecond;
78    us_freq = ticksPerSecond / ULL(1000000);
79
80    struct pcap_file_header hdr;
81    hdr.magic = TCPDUMP_MAGIC;
82    hdr.version_major = PCAP_VERSION_MAJOR;
83    hdr.version_minor = PCAP_VERSION_MINOR;
84
85    hdr.thiszone = -5 * 3600;
86    hdr.snaplen = 1500;
87    hdr.sigfigs = 0;
88    hdr.linktype = DLT_EN10MB;
89
90    stream.write(reinterpret_cast<char *>(&hdr), sizeof(hdr));
91
92    /*
93     * output an empty packet with the current time so that we know
94     * when the simulation began.  This allows us to correlate packets
95     * to sim_cycles.
96     */
97    pcap_pkthdr pkthdr;
98    pkthdr.seconds = curtime;
99    pkthdr.microseconds = 0;
100    pkthdr.caplen = 0;
101    pkthdr.len = 0;
102    stream.write(reinterpret_cast<char *>(&pkthdr), sizeof(pkthdr));
103
104    stream.flush();
105}
106
107void
108EtherDump::dumpPacket(PacketPtr &packet)
109{
110    pcap_pkthdr pkthdr;
111    pkthdr.seconds = curtime + (curTick / s_freq);
112    pkthdr.microseconds = (curTick / us_freq) % ULL(1000000);
113    pkthdr.caplen = std::min(packet->length, maxlen);
114    pkthdr.len = packet->length;
115    stream.write(reinterpret_cast<char *>(&pkthdr), sizeof(pkthdr));
116    stream.write(reinterpret_cast<char *>(packet->data), pkthdr.caplen);
117    stream.flush();
118}
119
120BEGIN_DECLARE_SIM_OBJECT_PARAMS(EtherDump)
121
122    Param<string> file;
123    Param<int> maxlen;
124
125END_DECLARE_SIM_OBJECT_PARAMS(EtherDump)
126
127BEGIN_INIT_SIM_OBJECT_PARAMS(EtherDump)
128
129    INIT_PARAM_DFLT(file, "file to dump packets to", "etherdump"),
130    INIT_PARAM_DFLT(maxlen, "max portion of packet data to dump", 96)
131
132END_INIT_SIM_OBJECT_PARAMS(EtherDump)
133
134CREATE_SIM_OBJECT(EtherDump)
135{
136    return new EtherDump(getInstanceName(), simout.resolve(file), maxlen);
137}
138
139REGISTER_SIM_OBJECT("EtherDump", EtherDump)
140