Merge zizzer:/bk/m5
[gem5.git] / base / inet.hh
index 86a04aae47d5d9eff9876ae3a04fd3eb05ef9785..e07e01935de3ad9d6627065fd8e9ac9590548310 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2003 The Regents of The University of Michigan
+ * Copyright (c) 2002-2005 The Regents of The University of Michigan
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 #ifndef __BASE_INET_HH__
 #define __BASE_INET_HH__
 
+#include <iosfwd>
 #include <string>
+#include <utility>
+#include <vector>
 
-#include "dnet/os.h"
+#include "base/range.hh"
+#include "dev/etherpkt.hh"
+#include "sim/host.hh"
 
+#include "dnet/os.h"
 #include "dnet/eth.h"
 #include "dnet/ip.h"
 #include "dnet/ip6.h"
 #include "dnet/icmp.h"
 #include "dnet/tcp.h"
 #include "dnet/udp.h"
-
 #include "dnet/intf.h"
 #include "dnet/route.h"
 #include "dnet/fw.h"
-
 #include "dnet/blob.h"
 #include "dnet/rand.h"
 
-#include "sim/host.hh"
+namespace Net {
+
+/*
+ * Ethernet Stuff
+ */
+struct EthAddr : protected eth_addr
+{
+  protected:
+    void parse(const std::string &addr);
+
+  public:
+    EthAddr();
+    EthAddr(const uint8_t ea[ETH_ADDR_LEN]);
+    EthAddr(const eth_addr &ea);
+    EthAddr(const std::string &addr);
+    const EthAddr &operator=(const eth_addr &ea);
+    const EthAddr &operator=(const std::string &addr);
 
-std::string eaddr_string(const uint8_t a[6]);
+    int size() const { return sizeof(eth_addr); }
 
-struct EthHdr : protected eth_hdr
+    const uint8_t *bytes() const { return &data[0]; }
+    uint8_t *bytes() { return &data[0]; }
+
+    const uint8_t *addr() const { return &data[0]; }
+    bool unicast() const { return data[0] == 0x00; }
+    bool multicast() const { return data[0] == 0x01; }
+    bool broadcast() const { return data[0] == 0xff; }
+    std::string string() const;
+
+    operator uint64_t() const
+    {
+        uint64_t reg = 0;
+        reg |= ((uint64_t)data[0]) << 40;
+        reg |= ((uint64_t)data[1]) << 32;
+        reg |= ((uint64_t)data[2]) << 24;
+        reg |= ((uint64_t)data[3]) << 16;
+        reg |= ((uint64_t)data[4]) << 8;
+        reg |= ((uint64_t)data[5]) << 0;
+        return reg;
+    }
+
+};
+
+std::ostream &operator<<(std::ostream &stream, const EthAddr &ea);
+bool operator==(const EthAddr &left, const EthAddr &right);
+
+struct EthHdr : public eth_hdr
 {
     uint16_t type() const { return ntohs(eth_type); }
-    const uint8_t *payload() const { return (const uint8_t *)this + sizeof(*this); }
-    uint8_t *payload() { return (uint8_t *)this + sizeof(*this); }
+    const EthAddr &src() const { return *(EthAddr *)&eth_src; }
+    const EthAddr &dst() const { return *(EthAddr *)&eth_dst; }
+
+    int size() const { return sizeof(eth_hdr); }
 
-    bool unicast() { return eth_dst.data[0] == 0x00; }
-    bool multicast() { return eth_dst.data[0] == 0x01; }
-    bool broadcast() { return eth_dst.data[0] == 0xff; }
+    const uint8_t *bytes() const { return (const uint8_t *)this; }
+    const uint8_t *payload() const { return bytes() + size(); }
+    uint8_t *bytes() { return (uint8_t *)this; }
+    uint8_t *payload() { return bytes() + size(); }
 };
 
-struct IpHdr : protected ip_hdr
+class EthPtr
+{
+  protected:
+    friend class IpPtr;
+    PacketPtr p;
+
+  public:
+    EthPtr() {}
+    EthPtr(const PacketPtr &ptr) : p(ptr) { }
+
+    EthHdr *operator->() { return (EthHdr *)p->data; }
+    EthHdr &operator*() { return *(EthHdr *)p->data; }
+    operator EthHdr *() { return (EthHdr *)p->data; }
+
+    const EthHdr *operator->() const { return (const EthHdr *)p->data; }
+    const EthHdr &operator*() const { return *(const EthHdr *)p->data; }
+    operator const EthHdr *() const { return (const EthHdr *)p->data; }
+
+    const EthPtr &operator=(const PacketPtr &ptr) { p = ptr; return *this; }
+
+    const PacketPtr packet() const { return p; }
+    PacketPtr packet() { return p; }
+    bool operator!() const { return !p; }
+    operator bool() const { return p; }
+};
+
+/*
+ * IP Stuff
+ */
+struct IpOpt;
+struct IpHdr : public ip_hdr
 {
     uint8_t  version() const { return ip_v; }
-    uint8_t  hlen() const { return ip_hl; }
+    uint8_t  hlen() const { return ip_hl * 4; }
     uint8_t  tos() const { return ip_tos; }
     uint16_t len() const { return ntohs(ip_len); }
     uint16_t id() const { return ntohs(ip_id); }
@@ -75,19 +154,99 @@ struct IpHdr : protected ip_hdr
     uint16_t frag_off() const { return ntohs(ip_off) & 0x1fff; }
     uint8_t  ttl() const { return ip_ttl; }
     uint8_t  proto() const { return ip_p; }
-    uint16_t sum() const { return ntohs(ip_sum); }
+    uint16_t sum() const { return ip_sum; }
     uint32_t src() const { return ntohl(ip_src); }
     uint32_t dst() const { return ntohl(ip_dst); }
 
-    void sum(uint16_t sum) { ip_sum = htons(sum); }
+    void sum(uint16_t sum) { ip_sum = sum; }
+
+    bool options(std::vector<const IpOpt *> &vec) const;
+
+    int size() const { return hlen(); }
+    const uint8_t *bytes() const { return (const uint8_t *)this; }
+    const uint8_t *payload() const { return bytes() + size(); }
+    uint8_t *bytes() { return (uint8_t *)this; }
+    uint8_t *payload() { return bytes() + size(); }
+};
+
+class IpPtr
+{
+  protected:
+    friend class TcpPtr;
+    friend class UdpPtr;
+    PacketPtr p;
+
+    const IpHdr *h() const
+    { return (const IpHdr *)(p->data + sizeof(eth_hdr)); }
+    IpHdr *h() { return (IpHdr *)(p->data + sizeof(eth_hdr)); }
+
+    void set(const PacketPtr &ptr)
+    {
+        EthHdr *eth = (EthHdr *)ptr->data;
+        if (eth->type() == ETH_TYPE_IP)
+            p = ptr;
+        else
+            p = 0;
+    }
+
+  public:
+    IpPtr() {}
+    IpPtr(const PacketPtr &ptr) { set(ptr); }
+    IpPtr(const EthPtr &ptr) { set(ptr.p); }
+    IpPtr(const IpPtr &ptr) : p(ptr.p) { }
 
-    uint16_t ip_cksum() const;
-    uint16_t tu_cksum() const;
-    const uint8_t  *payload() const { return (const uint8_t *)this + hlen(); }
-    uint8_t  *payload() { return (uint8_t *)this + hlen(); }
+    IpHdr *operator->() { return h(); }
+    IpHdr &operator*() { return *h(); }
+    operator IpHdr *() { return h(); }
+
+    const IpHdr *operator->() const { return h(); }
+    const IpHdr &operator*() const { return *h(); }
+    operator const IpHdr *() const { return h(); }
+
+    const IpPtr &operator=(const PacketPtr &ptr) { set(ptr); return *this; }
+    const IpPtr &operator=(const EthPtr &ptr) { set(ptr.p); return *this; }
+    const IpPtr &operator=(const IpPtr &ptr) { p = ptr.p; return *this; }
+
+    const PacketPtr packet() const { return p; }
+    PacketPtr packet() { return p; }
+    bool operator!() const { return !p; }
+    operator bool() const { return p; }
+    operator bool() { return p; }
 };
 
-struct TcpHdr : protected tcp_hdr
+uint16_t cksum(const IpPtr &ptr);
+
+struct IpOpt : public ip_opt
+{
+    uint8_t type() const { return opt_type; }
+    uint8_t typeNumber() const { return IP_OPT_NUMBER(opt_type); }
+    uint8_t typeClass() const { return IP_OPT_CLASS(opt_type); }
+    uint8_t typeCopied() const { return IP_OPT_COPIED(opt_type); }
+    uint8_t len() const { return IP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
+
+    bool isNumber(int num) const { return typeNumber() == IP_OPT_NUMBER(num); }
+    bool isClass(int cls) const { return typeClass() == IP_OPT_CLASS(cls); }
+    bool isCopied(int cpy) const { return typeCopied() == IP_OPT_COPIED(cpy); }
+
+    const uint8_t *data() const { return opt_data.data8; }
+    void sec(ip_opt_data_sec &sec) const;
+    void lsrr(ip_opt_data_rr &rr) const;
+    void ssrr(ip_opt_data_rr &rr) const;
+    void ts(ip_opt_data_ts &ts) const;
+    uint16_t satid() const { return ntohs(opt_data.satid); }
+    uint16_t mtup() const { return ntohs(opt_data.mtu); }
+    uint16_t mtur() const { return ntohs(opt_data.mtu); }
+    void tr(ip_opt_data_tr &tr) const;
+    const uint32_t *addext() const { return &opt_data.addext[0]; }
+    uint16_t rtralt() const { return ntohs(opt_data.rtralt); }
+    void sdb(std::vector<uint32_t> &vec) const;
+};
+
+/*
+ * TCP Stuff
+ */
+struct TcpOpt;
+struct TcpHdr : public tcp_hdr
 {
     uint16_t sport() const { return ntohs(th_sport); }
     uint16_t dport() const { return ntohs(th_dport); }
@@ -96,26 +255,153 @@ struct TcpHdr : protected tcp_hdr
     uint8_t  off() const { return th_off; }
     uint8_t  flags() const { return th_flags & 0x3f; }
     uint16_t win() const { return ntohs(th_win); }
-    uint16_t sum() const { return ntohs(th_sum); }
+    uint16_t sum() const { return th_sum; }
     uint16_t urp() const { return ntohs(th_urp); }
 
-    void sum(uint16_t sum) { th_sum = htons(sum); }
+    void sum(uint16_t sum) { th_sum = sum; }
+
+    bool options(std::vector<const TcpOpt *> &vec) const;
+
+    int size() const { return off(); }
+    const uint8_t *bytes() const { return (const uint8_t *)this; }
+    const uint8_t *payload() const { return bytes() + size(); }
+    uint8_t *bytes() { return (uint8_t *)this; }
+    uint8_t *payload() { return bytes() + size(); }
+};
+
+class TcpPtr
+{
+  protected:
+    PacketPtr p;
+    int off;
+
+    const TcpHdr *h() const { return (const TcpHdr *)(p->data + off); }
+    TcpHdr *h() { return (TcpHdr *)(p->data + off); }
+
+    void set(const PacketPtr &ptr, int offset) { p = ptr; off = offset; }
+    void set(const IpPtr &ptr)
+    {
+        if (ptr->proto() == IP_PROTO_TCP)
+            set(ptr.p, sizeof(eth_hdr) + ptr->hlen());
+        else
+            set(0, 0);
+    }
+
+  public:
+    TcpPtr() {}
+    TcpPtr(const IpPtr &ptr) { set(ptr); }
+    TcpPtr(const TcpPtr &ptr) : p(ptr.p), off(ptr.off) {}
+
+    TcpHdr *operator->() { return h(); }
+    TcpHdr &operator*() { return *h(); }
+    operator TcpHdr *() { return h(); }
+
+    const TcpHdr *operator->() const { return h(); }
+    const TcpHdr &operator*() const { return *h(); }
+    operator const TcpHdr *() const { return h(); }
+
+    const TcpPtr &operator=(const IpPtr &i) { set(i); return *this; }
+    const TcpPtr &operator=(const TcpPtr &t) { set(t.p, t.off); return *this; }
+
+    const PacketPtr packet() const { return p; }
+    PacketPtr packet() { return p; }
+    bool operator!() const { return !p; }
+    operator bool() const { return p; }
+    operator bool() { return p; }
+};
+
+uint16_t cksum(const TcpPtr &ptr);
 
-    const uint8_t *payload() const { return (const uint8_t *)this + off(); }
-    uint8_t *payload() { return (uint8_t *)this + off(); }
+typedef Range<uint16_t> SackRange;
+
+struct TcpOpt : public tcp_opt
+{
+    uint8_t type() const { return opt_type; }
+    uint8_t len() const { return TCP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
+
+    bool isopt(int opt) const { return type() == opt; }
+
+    const uint8_t *data() const { return opt_data.data8; }
+
+    uint16_t mss() const { return ntohs(opt_data.mss); }
+    uint8_t wscale() const { return opt_data.wscale; }
+    bool sack(std::vector<SackRange> &vec) const;
+    uint32_t echo() const { return ntohl(opt_data.echo); }
+    uint32_t tsval() const { return ntohl(opt_data.timestamp[0]); }
+    uint32_t tsecr() const { return ntohl(opt_data.timestamp[1]); }
+    uint32_t cc() const { return ntohl(opt_data.cc); }
+    uint8_t cksum() const{ return opt_data.cksum; }
+    const uint8_t *md5() const { return opt_data.md5; }
+
+    int size() const { return len(); }
+    const uint8_t *bytes() const { return (const uint8_t *)this; }
+    const uint8_t *payload() const { return bytes() + size(); }
+    uint8_t *bytes() { return (uint8_t *)this; }
+    uint8_t *payload() { return bytes() + size(); }
 };
 
-struct UdpHdr : protected udp_hdr
+/*
+ * UDP Stuff
+ */
+struct UdpHdr : public udp_hdr
 {
     uint16_t sport() const { return ntohs(uh_sport); }
     uint16_t dport() const { return ntohs(uh_dport); }
     uint16_t len() const { return ntohs(uh_ulen); }
-    uint16_t sum() const { return ntohs(uh_sum); }
+    uint16_t sum() const { return uh_sum; }
+
+    void sum(uint16_t sum) { uh_sum = sum; }
+
+    int size() const { return sizeof(udp_hdr); }
+    const uint8_t *bytes() const { return (const uint8_t *)this; }
+    const uint8_t *payload() const { return bytes() + size(); }
+    uint8_t *bytes() { return (uint8_t *)this; }
+    uint8_t *payload() { return bytes() + size(); }
+};
+
+class UdpPtr
+{
+  protected:
+    PacketPtr p;
+    int off;
+
+    const UdpHdr *h() const { return (const UdpHdr *)(p->data + off); }
+    UdpHdr *h() { return (UdpHdr *)(p->data + off); }
+
+    void set(const PacketPtr &ptr, int offset) { p = ptr; off = offset; }
+    void set(const IpPtr &ptr)
+    {
+        if (ptr->proto() == IP_PROTO_UDP)
+            set(ptr.p, sizeof(eth_hdr) + ptr->hlen());
+        else
+            set(0, 0);
+    }
 
-    void sum(uint16_t sum) { uh_sum = htons(sum); }
+  public:
+    UdpPtr() {}
+    UdpPtr(const IpPtr &ptr) { set(ptr); }
+    UdpPtr(const UdpPtr &ptr) : p(ptr.p), off(ptr.off) {}
 
-    const uint8_t *payload() const { return (const uint8_t *)this + sizeof(*this); }
-    uint8_t *payload() { return (uint8_t *)this + sizeof(*this); }
+    UdpHdr *operator->() { return h(); }
+    UdpHdr &operator*() { return *h(); }
+    operator UdpHdr *() { return h(); }
+
+    const UdpHdr *operator->() const { return h(); }
+    const UdpHdr &operator*() const { return *h(); }
+    operator const UdpHdr *() const { return h(); }
+
+    const UdpPtr &operator=(const IpPtr &i) { set(i); return *this; }
+    const UdpPtr &operator=(const UdpPtr &t) { set(t.p, t.off); return *this; }
+
+    const PacketPtr packet() const { return p; }
+    PacketPtr packet() { return p; }
+    bool operator!() const { return !p; }
+    operator bool() const { return p; }
+    operator bool() { return p; }
 };
 
+uint16_t cksum(const UdpPtr &ptr);
+
+/* namespace Net */ }
+
 #endif // __BASE_INET_HH__