inet.hh revision 5484:dc6a459769a1 
1/*
2 * Copyright (c) 2002-2005 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 * Authors: Nathan Binkert
29 *          Steve Reinhardt
30 */
31
32#ifndef __BASE_INET_HH__
33#define __BASE_INET_HH__
34
35#include <iosfwd>
36#include <string>
37#include <utility>
38#include <vector>
39
40#include "base/range.hh"
41#include "dev/etherpkt.hh"
42#include "sim/host.hh"
43
44#include "dnet/os.h"
45#include "dnet/eth.h"
46#include "dnet/ip.h"
47#include "dnet/ip6.h"
48#include "dnet/addr.h"
49#include "dnet/arp.h"
50#include "dnet/icmp.h"
51#include "dnet/tcp.h"
52#include "dnet/udp.h"
53#include "dnet/intf.h"
54#include "dnet/route.h"
55#include "dnet/fw.h"
56#include "dnet/blob.h"
57#include "dnet/rand.h"
58
59namespace Net {
60
61/*
62 * Ethernet Stuff
63 */
64struct EthAddr : protected eth_addr
65{
66  protected:
67    void parse(const std::string &addr);
68
69  public:
70    EthAddr();
71    EthAddr(const uint8_t ea[ETH_ADDR_LEN]);
72    EthAddr(const eth_addr &ea);
73    EthAddr(const std::string &addr);
74    const EthAddr &operator=(const eth_addr &ea);
75    const EthAddr &operator=(const std::string &addr);
76
77    int size() const { return sizeof(eth_addr); }
78
79    const uint8_t *bytes() const { return &data[0]; }
80    uint8_t *bytes() { return &data[0]; }
81
82    const uint8_t *addr() const { return &data[0]; }
83    bool unicast() const { return data[0] == 0x00; }
84    bool multicast() const { return data[0] == 0x01; }
85    bool broadcast() const { return data[0] == 0xff; }
86    std::string string() const;
87
88    operator uint64_t() const
89    {
90        uint64_t reg = 0;
91        reg |= ((uint64_t)data[0]) << 40;
92        reg |= ((uint64_t)data[1]) << 32;
93        reg |= ((uint64_t)data[2]) << 24;
94        reg |= ((uint64_t)data[3]) << 16;
95        reg |= ((uint64_t)data[4]) << 8;
96        reg |= ((uint64_t)data[5]) << 0;
97        return reg;
98    }
99
100};
101
102std::ostream &operator<<(std::ostream &stream, const EthAddr &ea);
103bool operator==(const EthAddr &left, const EthAddr &right);
104
105struct EthHdr : public eth_hdr
106{
107    uint16_t type() const { return ntohs(eth_type); }
108    const EthAddr &src() const { return *(EthAddr *)&eth_src; }
109    const EthAddr &dst() const { return *(EthAddr *)&eth_dst; }
110
111    int size() const { return sizeof(eth_hdr); }
112
113    const uint8_t *bytes() const { return (const uint8_t *)this; }
114    const uint8_t *payload() const { return bytes() + size(); }
115    uint8_t *bytes() { return (uint8_t *)this; }
116    uint8_t *payload() { return bytes() + size(); }
117};
118
119class EthPtr
120{
121  protected:
122    friend class IpPtr;
123    EthPacketPtr p;
124
125  public:
126    EthPtr() {}
127    EthPtr(const EthPacketPtr &ptr) : p(ptr) { }
128
129    EthHdr *operator->() { return (EthHdr *)p->data; }
130    EthHdr &operator*() { return *(EthHdr *)p->data; }
131    operator EthHdr *() { return (EthHdr *)p->data; }
132
133    const EthHdr *operator->() const { return (const EthHdr *)p->data; }
134    const EthHdr &operator*() const { return *(const EthHdr *)p->data; }
135    operator const EthHdr *() const { return (const EthHdr *)p->data; }
136
137    const EthPtr &operator=(const EthPacketPtr &ptr) { p = ptr; return *this; }
138
139    const EthPacketPtr packet() const { return p; }
140    EthPacketPtr packet() { return p; }
141    bool operator!() const { return !p; }
142    operator bool() const { return p; }
143};
144
145/*
146 * IP Stuff
147 */
148struct IpOpt;
149struct IpHdr : public ip_hdr
150{
151    uint8_t  version() const { return ip_v; }
152    uint8_t  hlen() const { return ip_hl * 4; }
153    uint8_t  tos() const { return ip_tos; }
154    uint16_t len() const { return ntohs(ip_len); }
155    uint16_t id() const { return ntohs(ip_id); }
156    uint16_t frag_flags() const { return ntohs(ip_off) >> 13; }
157    uint16_t frag_off() const { return ntohs(ip_off) & 0x1fff; }
158    uint8_t  ttl() const { return ip_ttl; }
159    uint8_t  proto() const { return ip_p; }
160    uint16_t sum() const { return ip_sum; }
161    uint32_t src() const { return ntohl(ip_src); }
162    uint32_t dst() const { return ntohl(ip_dst); }
163
164    void sum(uint16_t sum) { ip_sum = sum; }
165
166    bool options(std::vector<const IpOpt *> &vec) const;
167
168    int size() const { return hlen(); }
169    const uint8_t *bytes() const { return (const uint8_t *)this; }
170    const uint8_t *payload() const { return bytes() + size(); }
171    uint8_t *bytes() { return (uint8_t *)this; }
172    uint8_t *payload() { return bytes() + size(); }
173};
174
175class IpPtr
176{
177  protected:
178    friend class TcpPtr;
179    friend class UdpPtr;
180    EthPacketPtr p;
181
182    void set(const EthPacketPtr &ptr)
183    {
184        p = 0;
185
186        if (ptr) {
187            EthHdr *eth = (EthHdr *)ptr->data;
188            if (eth->type() == ETH_TYPE_IP)
189                p = ptr;
190        }
191    }
192
193  public:
194    IpPtr() : p(0) {}
195    IpPtr(const EthPacketPtr &ptr) : p(0) { set(ptr); }
196    IpPtr(const EthPtr &ptr) : p(0) { set(ptr.p); }
197    IpPtr(const IpPtr &ptr) : p(ptr.p) { }
198
199    IpHdr *get() { return (IpHdr *)(p->data + sizeof(eth_hdr)); }
200    IpHdr *operator->() { return get(); }
201    IpHdr &operator*() { return *get(); }
202
203    const IpHdr *get() const
204    { return (const IpHdr *)(p->data + sizeof(eth_hdr)); }
205    const IpHdr *operator->() const { return get(); }
206    const IpHdr &operator*() const { return *get(); }
207
208    const IpPtr &operator=(const EthPacketPtr &ptr) { set(ptr); return *this; }
209    const IpPtr &operator=(const EthPtr &ptr) { set(ptr.p); return *this; }
210    const IpPtr &operator=(const IpPtr &ptr) { p = ptr.p; return *this; }
211
212    const EthPacketPtr packet() const { return p; }
213    EthPacketPtr packet() { return p; }
214    bool operator!() const { return !p; }
215    operator bool() const { return p; }
216};
217
218uint16_t cksum(const IpPtr &ptr);
219
220struct IpOpt : public ip_opt
221{
222    uint8_t type() const { return opt_type; }
223    uint8_t typeNumber() const { return IP_OPT_NUMBER(opt_type); }
224    uint8_t typeClass() const { return IP_OPT_CLASS(opt_type); }
225    uint8_t typeCopied() const { return IP_OPT_COPIED(opt_type); }
226    uint8_t len() const { return IP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
227
228    bool isNumber(int num) const { return typeNumber() == IP_OPT_NUMBER(num); }
229    bool isClass(int cls) const { return typeClass() == IP_OPT_CLASS(cls); }
230    bool isCopied(int cpy) const { return typeCopied() == IP_OPT_COPIED(cpy); }
231
232    const uint8_t *data() const { return opt_data.data8; }
233    void sec(ip_opt_data_sec &sec) const;
234    void lsrr(ip_opt_data_rr &rr) const;
235    void ssrr(ip_opt_data_rr &rr) const;
236    void ts(ip_opt_data_ts &ts) const;
237    uint16_t satid() const { return ntohs(opt_data.satid); }
238    uint16_t mtup() const { return ntohs(opt_data.mtu); }
239    uint16_t mtur() const { return ntohs(opt_data.mtu); }
240    void tr(ip_opt_data_tr &tr) const;
241    const uint32_t *addext() const { return &opt_data.addext[0]; }
242    uint16_t rtralt() const { return ntohs(opt_data.rtralt); }
243    void sdb(std::vector<uint32_t> &vec) const;
244};
245
246/*
247 * TCP Stuff
248 */
249struct TcpOpt;
250struct TcpHdr : public tcp_hdr
251{
252    uint16_t sport() const { return ntohs(th_sport); }
253    uint16_t dport() const { return ntohs(th_dport); }
254    uint32_t seq() const { return ntohl(th_seq); }
255    uint32_t ack() const { return ntohl(th_ack); }
256    uint8_t  off() const { return th_off; }
257    uint8_t  flags() const { return th_flags & 0x3f; }
258    uint16_t win() const { return ntohs(th_win); }
259    uint16_t sum() const { return th_sum; }
260    uint16_t urp() const { return ntohs(th_urp); }
261
262    void sum(uint16_t sum) { th_sum = sum; }
263
264    bool options(std::vector<const TcpOpt *> &vec) const;
265
266    int size() const { return off(); }
267    const uint8_t *bytes() const { return (const uint8_t *)this; }
268    const uint8_t *payload() const { return bytes() + size(); }
269    uint8_t *bytes() { return (uint8_t *)this; }
270    uint8_t *payload() { return bytes() + size(); }
271};
272
273class TcpPtr
274{
275  protected:
276    EthPacketPtr p;
277    int off;
278
279    void set(const EthPacketPtr &ptr, int offset) { p = ptr; off = offset; }
280    void set(const IpPtr &ptr)
281    {
282        if (ptr && ptr->proto() == IP_PROTO_TCP)
283            set(ptr.p, sizeof(eth_hdr) + ptr->hlen());
284        else
285            set(0, 0);
286    }
287
288  public:
289    TcpPtr() : p(0), off(0) {}
290    TcpPtr(const IpPtr &ptr) : p(0), off(0) { set(ptr); }
291    TcpPtr(const TcpPtr &ptr) : p(ptr.p), off(ptr.off) {}
292
293    TcpHdr *get() { return (TcpHdr *)(p->data + off); }
294    TcpHdr *operator->() { return get(); }
295    TcpHdr &operator*() { return *get(); }
296
297    const TcpHdr *get() const { return (const TcpHdr *)(p->data + off); }
298    const TcpHdr *operator->() const { return get(); }
299    const TcpHdr &operator*() const { return *get(); }
300
301    const TcpPtr &operator=(const IpPtr &i) { set(i); return *this; }
302    const TcpPtr &operator=(const TcpPtr &t) { set(t.p, t.off); return *this; }
303
304    const EthPacketPtr packet() const { return p; }
305    EthPacketPtr packet() { return p; }
306    bool operator!() const { return !p; }
307    operator bool() const { return p; }
308};
309
310uint16_t cksum(const TcpPtr &ptr);
311
312typedef Range<uint16_t> SackRange;
313
314struct TcpOpt : public tcp_opt
315{
316    uint8_t type() const { return opt_type; }
317    uint8_t len() const { return TCP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
318
319    bool isopt(int opt) const { return type() == opt; }
320
321    const uint8_t *data() const { return opt_data.data8; }
322
323    uint16_t mss() const { return ntohs(opt_data.mss); }
324    uint8_t wscale() const { return opt_data.wscale; }
325    bool sack(std::vector<SackRange> &vec) const;
326    uint32_t echo() const { return ntohl(opt_data.echo); }
327    uint32_t tsval() const { return ntohl(opt_data.timestamp[0]); }
328    uint32_t tsecr() const { return ntohl(opt_data.timestamp[1]); }
329    uint32_t cc() const { return ntohl(opt_data.cc); }
330    uint8_t cksum() const{ return opt_data.cksum; }
331    const uint8_t *md5() const { return opt_data.md5; }
332
333    int size() const { return len(); }
334    const uint8_t *bytes() const { return (const uint8_t *)this; }
335    const uint8_t *payload() const { return bytes() + size(); }
336    uint8_t *bytes() { return (uint8_t *)this; }
337    uint8_t *payload() { return bytes() + size(); }
338};
339
340/*
341 * UDP Stuff
342 */
343struct UdpHdr : public udp_hdr
344{
345    uint16_t sport() const { return ntohs(uh_sport); }
346    uint16_t dport() const { return ntohs(uh_dport); }
347    uint16_t len() const { return ntohs(uh_ulen); }
348    uint16_t sum() const { return uh_sum; }
349
350    void sum(uint16_t sum) { uh_sum = sum; }
351
352    int size() const { return sizeof(udp_hdr); }
353    const uint8_t *bytes() const { return (const uint8_t *)this; }
354    const uint8_t *payload() const { return bytes() + size(); }
355    uint8_t *bytes() { return (uint8_t *)this; }
356    uint8_t *payload() { return bytes() + size(); }
357};
358
359class UdpPtr
360{
361  protected:
362    EthPacketPtr p;
363    int off;
364
365    void set(const EthPacketPtr &ptr, int offset) { p = ptr; off = offset; }
366    void set(const IpPtr &ptr)
367    {
368        if (ptr && ptr->proto() == IP_PROTO_UDP)
369            set(ptr.p, sizeof(eth_hdr) + ptr->hlen());
370        else
371            set(0, 0);
372    }
373
374  public:
375    UdpPtr() : p(0), off(0) {}
376    UdpPtr(const IpPtr &ptr) : p(0), off(0) { set(ptr); }
377    UdpPtr(const UdpPtr &ptr) : p(ptr.p), off(ptr.off) {}
378
379    UdpHdr *get() { return (UdpHdr *)(p->data + off); }
380    UdpHdr *operator->() { return get(); }
381    UdpHdr &operator*() { return *get(); }
382
383    const UdpHdr *get() const { return (const UdpHdr *)(p->data + off); }
384    const UdpHdr *operator->() const { return get(); }
385    const UdpHdr &operator*() const { return *get(); }
386
387    const UdpPtr &operator=(const IpPtr &i) { set(i); return *this; }
388    const UdpPtr &operator=(const UdpPtr &t) { set(t.p, t.off); return *this; }
389
390    const EthPacketPtr packet() const { return p; }
391    EthPacketPtr packet() { return p; }
392    bool operator!() const { return !p; }
393    operator bool() const { return p; }
394};
395
396uint16_t cksum(const UdpPtr &ptr);
397
398/* namespace Net */ }
399
400#endif // __BASE_INET_HH__
401