Very minor formatting glitches.
[gem5.git] / dev / etherpkt.hh
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 * Reference counted class containing ethernet packet data
31 */
32
33 #ifndef __ETHERPKT_HH__
34 #define __ETHERPKT_HH__
35
36 #include <iosfwd>
37 #include <memory>
38 #include <assert.h>
39
40 #include "base/refcnt.hh"
41 #include "base/inet.hh"
42 #include "sim/host.hh"
43
44 /*
45 * Reference counted class containing ethernet packet data
46 */
47 class Checkpoint;
48 class PacketData : public RefCounted
49 {
50 public:
51 uint8_t *data;
52 int length;
53
54 public:
55 PacketData() : data(NULL), length(0) { }
56 PacketData(std::auto_ptr<uint8_t> d, int l)
57 : data(d.release()), length(l) { }
58 ~PacketData() { if (data) delete [] data; }
59
60 public:
61 const EthHdr *eth() const { return (const EthHdr *)data; }
62 const IpHdr *ip() const {const EthHdr *h = eth(); return h ? h->ip() : 0;}
63 const TcpHdr *tcp() const {const IpHdr *h = ip(); return h ? h->tcp() : 0;}
64 const UdpHdr *udp() const {const IpHdr *h = ip(); return h ? h->udp() : 0;}
65
66 EthHdr *eth() { return (EthHdr *)data; }
67 IpHdr *ip() { EthHdr *h = eth(); return h ? h->ip() : 0; }
68 TcpHdr *tcp() { IpHdr *h = ip(); return h ? h->tcp() : 0; }
69 UdpHdr *udp() { IpHdr *h = ip(); return h ? h->udp() : 0; }
70
71 public:
72 void serialize(std::ostream &os);
73 void unserialize(Checkpoint *cp, const std::string &section);
74 };
75
76 typedef RefCountingPtr<PacketData> PacketPtr;
77
78 #endif // __ETHERPKT_HH__