inet.hh revision 9554:406fbcf60223 
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
3 * Copyright (c) 2010 Advanced Micro Devices, Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Nathan Binkert
30 *          Steve Reinhardt
31 *          Gabe Black
32 */
33
34#ifndef __BASE_INET_HH__
35#define __BASE_INET_HH__
36
37#include <iosfwd>
38#include <string>
39#include <utility>
40#include <vector>
41
42#include "base/types.hh"
43#include "dev/etherpkt.hh"
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    int off() const { return 0; }
144    int pstart() const { return off() + ((const EthHdr*)p->data)->size(); }
145};
146
147/*
148 * IP Stuff
149 */
150struct IpAddress
151{
152  protected:
153    uint32_t _ip;
154
155  public:
156    IpAddress() : _ip(0)
157    {}
158    IpAddress(const uint32_t __ip) : _ip(__ip)
159    {}
160
161    uint32_t ip() const { return _ip; }
162
163    std::string string() const;
164};
165
166std::ostream &operator<<(std::ostream &stream, const IpAddress &ia);
167bool operator==(const IpAddress &left, const IpAddress &right);
168
169struct IpNetmask : public IpAddress
170{
171  protected:
172    uint8_t _netmask;
173
174  public:
175    IpNetmask() : IpAddress(), _netmask(0)
176    {}
177    IpNetmask(const uint32_t __ip, const uint8_t __netmask) :
178        IpAddress(__ip), _netmask(__netmask)
179    {}
180
181    uint8_t netmask() const { return _netmask; }
182
183    std::string string() const;
184};
185
186std::ostream &operator<<(std::ostream &stream, const IpNetmask &in);
187bool operator==(const IpNetmask &left, const IpNetmask &right);
188
189struct IpWithPort : public IpAddress
190{
191  protected:
192    uint16_t _port;
193
194  public:
195    IpWithPort() : IpAddress(), _port(0)
196    {}
197    IpWithPort(const uint32_t __ip, const uint16_t __port) :
198        IpAddress(__ip), _port(__port)
199    {}
200
201    uint8_t port() const { return _port; }
202
203    std::string string() const;
204};
205
206std::ostream &operator<<(std::ostream &stream, const IpWithPort &iwp);
207bool operator==(const IpWithPort &left, const IpWithPort &right);
208
209struct IpOpt;
210struct IpHdr : public ip_hdr
211{
212    uint8_t  version() const { return ip_v; }
213    uint8_t  hlen() const { return ip_hl * 4; }
214    uint8_t  tos() const { return ip_tos; }
215    uint16_t len() const { return ntohs(ip_len); }
216    uint16_t id() const { return ntohs(ip_id); }
217    uint16_t frag_flags() const { return ntohs(ip_off) >> 13; }
218    uint16_t frag_off() const { return ntohs(ip_off) & 0x1fff; }
219    uint8_t  ttl() const { return ip_ttl; }
220    uint8_t  proto() const { return ip_p; }
221    uint16_t sum() const { return ip_sum; }
222    uint32_t src() const { return ntohl(ip_src); }
223    uint32_t dst() const { return ntohl(ip_dst); }
224
225    void sum(uint16_t sum) { ip_sum = sum; }
226    void id(uint16_t _id) { ip_id = htons(_id); }
227    void len(uint16_t _len) { ip_len = htons(_len); }
228
229
230    bool options(std::vector<const IpOpt *> &vec) const;
231
232    int size() const { return hlen(); }
233    const uint8_t *bytes() const { return (const uint8_t *)this; }
234    const uint8_t *payload() const { return bytes() + size(); }
235    uint8_t *bytes() { return (uint8_t *)this; }
236    uint8_t *payload() { return bytes() + size(); }
237};
238
239class IpPtr
240{
241  protected:
242    friend class TcpPtr;
243    friend class UdpPtr;
244    EthPacketPtr p;
245
246    void set(const EthPacketPtr &ptr)
247    {
248        p = 0;
249
250        if (ptr) {
251            EthHdr *eth = (EthHdr *)ptr->data;
252            if (eth->type() == ETH_TYPE_IP)
253                p = ptr;
254        }
255    }
256
257  public:
258    IpPtr() : p(0) {}
259    IpPtr(const EthPacketPtr &ptr) : p(0) { set(ptr); }
260    IpPtr(const EthPtr &ptr) : p(0) { set(ptr.p); }
261    IpPtr(const IpPtr &ptr) : p(ptr.p) { }
262
263    IpHdr *get() { return (IpHdr *)(p->data + sizeof(eth_hdr)); }
264    IpHdr *operator->() { return get(); }
265    IpHdr &operator*() { return *get(); }
266
267    const IpHdr *get() const
268    { return (const IpHdr *)(p->data + sizeof(eth_hdr)); }
269    const IpHdr *operator->() const { return get(); }
270    const IpHdr &operator*() const { return *get(); }
271
272    const IpPtr &operator=(const EthPacketPtr &ptr) { set(ptr); return *this; }
273    const IpPtr &operator=(const EthPtr &ptr) { set(ptr.p); return *this; }
274    const IpPtr &operator=(const IpPtr &ptr) { p = ptr.p; return *this; }
275
276    const EthPacketPtr packet() const { return p; }
277    EthPacketPtr packet() { return p; }
278    bool operator!() const { return !p; }
279    operator bool() const { return p; }
280    int off() const { return sizeof(eth_hdr); }
281    int pstart() const { return off() + get()->size(); }
282};
283
284uint16_t cksum(const IpPtr &ptr);
285
286struct IpOpt : public ip_opt
287{
288    uint8_t type() const { return opt_type; }
289    uint8_t typeNumber() const { return IP_OPT_NUMBER(opt_type); }
290    uint8_t typeClass() const { return IP_OPT_CLASS(opt_type); }
291    uint8_t typeCopied() const { return IP_OPT_COPIED(opt_type); }
292    uint8_t len() const { return IP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
293
294    bool isNumber(int num) const { return typeNumber() == IP_OPT_NUMBER(num); }
295    bool isClass(int cls) const { return typeClass() == IP_OPT_CLASS(cls); }
296    bool isCopied(int cpy) const { return typeCopied() == IP_OPT_COPIED(cpy); }
297
298    const uint8_t *data() const { return opt_data.data8; }
299    void sec(ip_opt_data_sec &sec) const;
300    void lsrr(ip_opt_data_rr &rr) const;
301    void ssrr(ip_opt_data_rr &rr) const;
302    void ts(ip_opt_data_ts &ts) const;
303    uint16_t satid() const { return ntohs(opt_data.satid); }
304    uint16_t mtup() const { return ntohs(opt_data.mtu); }
305    uint16_t mtur() const { return ntohs(opt_data.mtu); }
306    void tr(ip_opt_data_tr &tr) const;
307    const uint32_t *addext() const { return &opt_data.addext[0]; }
308    uint16_t rtralt() const { return ntohs(opt_data.rtralt); }
309    void sdb(std::vector<uint32_t> &vec) const;
310};
311
312/*
313 * TCP Stuff
314 */
315struct TcpOpt;
316struct TcpHdr : public tcp_hdr
317{
318    uint16_t sport() const { return ntohs(th_sport); }
319    uint16_t dport() const { return ntohs(th_dport); }
320    uint32_t seq() const { return ntohl(th_seq); }
321    uint32_t ack() const { return ntohl(th_ack); }
322    uint8_t  off() const { return th_off; }
323    uint8_t  flags() const { return th_flags & 0x3f; }
324    uint16_t win() const { return ntohs(th_win); }
325    uint16_t sum() const { return th_sum; }
326    uint16_t urp() const { return ntohs(th_urp); }
327
328    void sum(uint16_t sum) { th_sum = sum; }
329    void seq(uint32_t _seq) { th_seq = htonl(_seq); }
330    void flags(uint8_t _flags) { th_flags  = _flags; }
331
332    bool options(std::vector<const TcpOpt *> &vec) const;
333
334    int size() const { return off(); }
335    const uint8_t *bytes() const { return (const uint8_t *)this; }
336    const uint8_t *payload() const { return bytes() + size(); }
337    uint8_t *bytes() { return (uint8_t *)this; }
338    uint8_t *payload() { return bytes() + size(); }
339};
340
341class TcpPtr
342{
343  protected:
344    EthPacketPtr p;
345    int _off;
346
347    void set(const EthPacketPtr &ptr, int offset) { p = ptr; _off = offset; }
348    void set(const IpPtr &ptr)
349    {
350        if (ptr && ptr->proto() == IP_PROTO_TCP)
351            set(ptr.p, sizeof(eth_hdr) + ptr->hlen());
352        else
353            set(0, 0);
354    }
355
356  public:
357    TcpPtr() : p(0), _off(0) {}
358    TcpPtr(const IpPtr &ptr) : p(0), _off(0) { set(ptr); }
359    TcpPtr(const TcpPtr &ptr) : p(ptr.p), _off(ptr._off) {}
360
361    TcpHdr *get() { return (TcpHdr *)(p->data + _off); }
362    TcpHdr *operator->() { return get(); }
363    TcpHdr &operator*() { return *get(); }
364
365    const TcpHdr *get() const { return (const TcpHdr *)(p->data + _off); }
366    const TcpHdr *operator->() const { return get(); }
367    const TcpHdr &operator*() const { return *get(); }
368
369    const TcpPtr &operator=(const IpPtr &i) { set(i); return *this; }
370    const TcpPtr &operator=(const TcpPtr &t) { set(t.p, t._off); return *this; }
371
372    const EthPacketPtr packet() const { return p; }
373    EthPacketPtr packet() { return p; }
374    bool operator!() const { return !p; }
375    operator bool() const { return p; }
376    int off() const { return _off; }
377    int pstart() const { return off() + get()->size(); }
378};
379
380uint16_t cksum(const TcpPtr &ptr);
381
382struct TcpOpt : public tcp_opt
383{
384    uint8_t type() const { return opt_type; }
385    uint8_t len() const { return TCP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
386
387    bool isopt(int opt) const { return type() == opt; }
388
389    const uint8_t *data() const { return opt_data.data8; }
390
391    uint16_t mss() const { return ntohs(opt_data.mss); }
392    uint8_t wscale() const { return opt_data.wscale; }
393    uint32_t echo() const { return ntohl(opt_data.echo); }
394    uint32_t tsval() const { return ntohl(opt_data.timestamp[0]); }
395    uint32_t tsecr() const { return ntohl(opt_data.timestamp[1]); }
396    uint32_t cc() const { return ntohl(opt_data.cc); }
397    uint8_t cksum() const{ return opt_data.cksum; }
398    const uint8_t *md5() const { return opt_data.md5; }
399
400    int size() const { return len(); }
401    const uint8_t *bytes() const { return (const uint8_t *)this; }
402    const uint8_t *payload() const { return bytes() + size(); }
403    uint8_t *bytes() { return (uint8_t *)this; }
404    uint8_t *payload() { return bytes() + size(); }
405};
406
407/*
408 * UDP Stuff
409 */
410struct UdpHdr : public udp_hdr
411{
412    uint16_t sport() const { return ntohs(uh_sport); }
413    uint16_t dport() const { return ntohs(uh_dport); }
414    uint16_t len() const { return ntohs(uh_ulen); }
415    uint16_t sum() const { return uh_sum; }
416
417    void sum(uint16_t sum) { uh_sum = sum; }
418    void len(uint16_t _len) { uh_ulen = htons(_len); }
419
420    int size() const { return sizeof(udp_hdr); }
421    const uint8_t *bytes() const { return (const uint8_t *)this; }
422    const uint8_t *payload() const { return bytes() + size(); }
423    uint8_t *bytes() { return (uint8_t *)this; }
424    uint8_t *payload() { return bytes() + size(); }
425};
426
427class UdpPtr
428{
429  protected:
430    EthPacketPtr p;
431    int _off;
432
433    void set(const EthPacketPtr &ptr, int offset) { p = ptr; _off = offset; }
434    void set(const IpPtr &ptr)
435    {
436        if (ptr && ptr->proto() == IP_PROTO_UDP)
437            set(ptr.p, sizeof(eth_hdr) + ptr->hlen());
438        else
439            set(0, 0);
440    }
441
442  public:
443    UdpPtr() : p(0), _off(0) {}
444    UdpPtr(const IpPtr &ptr) : p(0), _off(0) { set(ptr); }
445    UdpPtr(const UdpPtr &ptr) : p(ptr.p), _off(ptr._off) {}
446
447    UdpHdr *get() { return (UdpHdr *)(p->data + _off); }
448    UdpHdr *operator->() { return get(); }
449    UdpHdr &operator*() { return *get(); }
450
451    const UdpHdr *get() const { return (const UdpHdr *)(p->data + _off); }
452    const UdpHdr *operator->() const { return get(); }
453    const UdpHdr &operator*() const { return *get(); }
454
455    const UdpPtr &operator=(const IpPtr &i) { set(i); return *this; }
456    const UdpPtr &operator=(const UdpPtr &t) { set(t.p, t._off); return *this; }
457
458    const EthPacketPtr packet() const { return p; }
459    EthPacketPtr packet() { return p; }
460    bool operator!() const { return !p; }
461    operator bool() const { return p; }
462    int off() const { return _off; }
463    int pstart() const { return off() + get()->size(); }
464};
465
466uint16_t __tu_cksum(const IpPtr &ip);
467uint16_t cksum(const UdpPtr &ptr);
468
469int hsplit(const EthPacketPtr &ptr);
470
471} // namespace Net
472
473#endif // __BASE_INET_HH__
474