Fixup interrupting of the ethernet device.
[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 "sim/host.hh"
41 #include "base/refcnt.hh"
42 #include "base/inet_hdrs.hh"
43
44 class Checkpoint;
45 /*
46 * Reference counted class containing ethernet packet data
47 */
48 class EtherPacket : public RefCounted
49 {
50 public:
51 uint8_t *data;
52 int length;
53
54 public:
55 EtherPacket() : data(NULL), length(0) {}
56 EtherPacket(std::auto_ptr<uint8_t> d, int l)
57 : data(d.release()), length(l) {}
58 ~EtherPacket() { if (data) delete [] data; }
59
60 public:
61 bool IsUnicast() { return data[0] == 0x00; }
62 bool IsMulticast() { return data[0] == 0x01; }
63 bool IsBroadcast() { return data[0] == 0xff; }
64
65 bool isIpPkt() {
66 eth_header *eth = (eth_header *) data;
67 return (eth->type == 0x8);
68 }
69 bool isTcpPkt(ip_header *ip) {
70 return (ip->protocol == 0x6);
71 }
72 bool isTcpPkt() {
73 ip_header *ip = getIpHdr();
74 return (ip->protocol == 0x6);
75 }
76 bool isUdpPkt(ip_header *ip) {
77 return (ip->protocol == 17);
78 }
79 bool isUdpPkt() {
80 ip_header *ip = getIpHdr();
81 return (ip->protocol == 17);
82 }
83
84 ip_header *getIpHdr() {
85 assert(isIpPkt());
86 return (ip_header *) (data + sizeof(eth_header));
87 }
88
89 tcp_header *getTcpHdr(ip_header *ip) {
90 assert(isTcpPkt(ip));
91 return (tcp_header *) ((uint8_t *) ip + (ip->vers_len & 0xf)*4);
92 }
93
94 udp_header *getUdpHdr(ip_header *ip) {
95 assert(isUdpPkt(ip));
96 return (udp_header *) ((uint8_t *) ip + (ip->vers_len & 0xf)*4);
97 }
98 typedef RefCountingPtr<EtherPacket> PacketPtr;
99
100 void serialize(std::ostream &os);
101 void unserialize(Checkpoint *cp, const std::string &section);
102 };
103
104 typedef RefCountingPtr<EtherPacket> PacketPtr;
105
106 #endif // __ETHERPKT_HH__