dev/etherpkt.hh

   1 /*
   2  * Copyright (c) 2003 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
  39 #include "sim/host.hh"
  40 #include "base/refcnt.hh"
  41
  42 #define EADDR_LEN 6
  43
  44 class Checkpoint;
  45
  46 struct pseudo_header
  47 {
  48     uint32_t src_ip_addr;
  49     uint32_t dest_ip_addr;
  50     uint16_t protocol;
  51     uint16_t len;
  52 };
  53
  54 /** Ethernet header struct for casting purposes */
  55 struct eth_header
  56 {
  57     uint8_t dest[EADDR_LEN];
  58     uint8_t src[EADDR_LEN];
  59     uint16_t type;
  60 };
  61
  62 struct ip_header
  63 {
  64     uint8_t vers_len;
  65     uint8_t service_type;
  66     uint16_t dgram_len;
  67     uint16_t ID;
  68     uint16_t flags_frag_offset;
  69     uint8_t TTL;
  70     uint8_t protocol;
  71     uint16_t hdr_chksum;
  72     uint32_t src_ip_addr;
  73     uint32_t dest_ip_addr;
  74     uint8_t *options;
  75     uint8_t *transport_header;
  76 };
  77
  78 struct tcp_header
  79 {
  80     uint16_t src_port_num;
  81     uint16_t dest_port_num;
  82     uint32_t seq_num;
  83     uint32_t ack_num;
  84     uint8_t hdr_len;
  85     uint8_t flags;
  86     uint16_t rcv_window;
  87     uint16_t chksum;
  88     uint16_t urgent;
  89     uint8_t *options;
  90     uint8_t *data;
  91 };
  92
  93 struct udp_header
  94 {
  95     uint16_t src_port_num;
  96     uint16_t dest_port_num;
  97     uint16_t len;
  98     uint16_t chksum;
  99     uint8_t *data;
 100 };
 101
 102 /*
 103  * Reference counted class containing ethernet packet data
 104  */
 105 class EtherPacket : public RefCounted
 106 {
 107   public:
 108     uint8_t *data;
 109     int length;
 110
 111   public:
 112     EtherPacket() : data(NULL), length(0) {}
 113     EtherPacket(std::auto_ptr<uint8_t> d, int l)
 114         : data(d.release()), length(l) {}
 115     ~EtherPacket() { if (data) delete [] data; }
 116
 117   public:
 118     bool IsUnicast() { return data[0] == 0x00; }
 119     bool IsMulticast() { return data[0] == 0x01; }
 120     bool IsBroadcast() { return data[0] == 0xff; }
 121
 122     ip_header *getIpHdr() { return (ip_header *) (data + 14); }
 123
 124     void *getTransportHdr() {
 125         ip_header *ip = getIpHdr();
 126         return (void *) (ip + (ip->vers_len & 0xf));
 127     }
 128
 129
 130     typedef RefCountingPtr<EtherPacket> PacketPtr;
 131
 132     void serialize(std::ostream &os);
 133     void unserialize(Checkpoint *cp, const std::string &section);
 134 };
 135
 136 typedef RefCountingPtr<EtherPacket> PacketPtr;
 137
 138 #endif // __ETHERPKT_HH__