2 * Copyright (c) 2013 ARM Limited
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
14 * Copyright (c) 2002-2005 The Regents of The University of Michigan
15 * Copyright (c) 2010 Advanced Micro Devices, Inc.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * Authors: Nathan Binkert
47 #ifndef __BASE_INET_HH__
48 #define __BASE_INET_HH__
55 #include "base/types.hh"
56 #include "dev/net/etherpkt.hh"
61 #include "dnet/addr.h"
63 #include "dnet/icmp.h"
66 #include "dnet/intf.h"
67 #include "dnet/route.h"
69 #include "dnet/blob.h"
70 #include "dnet/rand.h"
77 struct EthAddr : protected eth_addr
80 void parse(const std::string &addr);
84 EthAddr(const uint8_t ea[ETH_ADDR_LEN]);
85 EthAddr(const eth_addr &ea);
86 EthAddr(const std::string &addr);
87 const EthAddr &operator=(const eth_addr &ea);
88 const EthAddr &operator=(const std::string &addr);
90 int size() const { return sizeof(eth_addr); }
92 const uint8_t *bytes() const { return &data[0]; }
93 uint8_t *bytes() { return &data[0]; }
95 const uint8_t *addr() const { return &data[0]; }
96 bool unicast() const { return !(data[0] & 0x01); }
97 bool multicast() const { return !unicast() && !broadcast(); }
98 bool broadcast() const
100 bool isBroadcast = true;
101 for (int i = 0; i < ETH_ADDR_LEN; ++i) {
102 isBroadcast = isBroadcast && data[i] == 0xff;
108 std::string string() const;
110 operator uint64_t() const
113 reg |= ((uint64_t)data[0]) << 40;
114 reg |= ((uint64_t)data[1]) << 32;
115 reg |= ((uint64_t)data[2]) << 24;
116 reg |= ((uint64_t)data[3]) << 16;
117 reg |= ((uint64_t)data[4]) << 8;
118 reg |= ((uint64_t)data[5]) << 0;
124 std::ostream &operator<<(std::ostream &stream, const EthAddr &ea);
125 bool operator==(const EthAddr &left, const EthAddr &right);
127 struct EthHdr : public eth_hdr
129 bool isVlan() const { return (ntohs(eth_type) == ETH_TYPE_8021Q); }
130 uint16_t type() const {
132 return ntohs(eth_type);
134 // L3 type is now 16 bytes into the hdr with 802.1Q
135 // instead of 12. dnet/eth.h only supports 802.1
136 return ntohs(*((uint16_t*)(((uint8_t *)this) + 16)));
138 uint16_t vlanId() const {
140 return ntohs(*((uint16_t*)(((uint8_t *)this) + 14)));
145 const EthAddr &src() const { return *(EthAddr *)ð_src; }
146 const EthAddr &dst() const { return *(EthAddr *)ð_dst; }
150 return sizeof(eth_hdr);
152 return (sizeof(eth_hdr)+4);
155 const uint8_t *bytes() const { return (const uint8_t *)this; }
156 const uint8_t *payload() const { return bytes() + size(); }
157 uint8_t *bytes() { return (uint8_t *)this; }
158 uint8_t *payload() { return bytes() + size(); }
170 EthPtr(const EthPacketPtr &ptr) : p(ptr) { }
172 EthHdr *operator->() { return (EthHdr *)p->data; }
173 EthHdr &operator*() { return *(EthHdr *)p->data; }
174 operator EthHdr *() { return (EthHdr *)p->data; }
176 const EthHdr *operator->() const { return (const EthHdr *)p->data; }
177 const EthHdr &operator*() const { return *(const EthHdr *)p->data; }
178 operator const EthHdr *() const { return (const EthHdr *)p->data; }
180 const EthPtr &operator=(const EthPacketPtr &ptr) { p = ptr; return *this; }
182 const EthPacketPtr packet() const { return p; }
183 EthPacketPtr packet() { return p; }
184 bool operator!() const { return !p; }
185 operator bool() const { return (p != nullptr); }
186 int off() const { return 0; }
187 int pstart() const { return off() + ((const EthHdr*)p->data)->size(); }
201 IpAddress(const uint32_t __ip) : _ip(__ip)
204 uint32_t ip() const { return _ip; }
206 std::string string() const;
209 std::ostream &operator<<(std::ostream &stream, const IpAddress &ia);
210 bool operator==(const IpAddress &left, const IpAddress &right);
212 struct IpNetmask : public IpAddress
218 IpNetmask() : IpAddress(), _netmask(0)
220 IpNetmask(const uint32_t __ip, const uint8_t __netmask) :
221 IpAddress(__ip), _netmask(__netmask)
224 uint8_t netmask() const { return _netmask; }
226 std::string string() const;
229 std::ostream &operator<<(std::ostream &stream, const IpNetmask &in);
230 bool operator==(const IpNetmask &left, const IpNetmask &right);
232 struct IpWithPort : public IpAddress
238 IpWithPort() : IpAddress(), _port(0)
240 IpWithPort(const uint32_t __ip, const uint16_t __port) :
241 IpAddress(__ip), _port(__port)
244 uint8_t port() const { return _port; }
246 std::string string() const;
249 std::ostream &operator<<(std::ostream &stream, const IpWithPort &iwp);
250 bool operator==(const IpWithPort &left, const IpWithPort &right);
253 struct IpHdr : public ip_hdr
255 uint8_t version() const { return ip_v; }
256 uint8_t hlen() const { return ip_hl * 4; }
257 uint8_t tos() const { return ip_tos; }
258 uint16_t len() const { return ntohs(ip_len); }
259 uint16_t id() const { return ntohs(ip_id); }
260 uint16_t frag_flags() const { return ntohs(ip_off) >> 13; }
261 uint16_t frag_off() const { return ntohs(ip_off) & 0x1fff; }
262 uint8_t ttl() const { return ip_ttl; }
263 uint8_t proto() const { return ip_p; }
264 uint16_t sum() const { return ip_sum; }
265 uint32_t src() const { return ntohl(ip_src); }
266 uint32_t dst() const { return ntohl(ip_dst); }
268 void sum(uint16_t sum) { ip_sum = sum; }
269 void id(uint16_t _id) { ip_id = htons(_id); }
270 void len(uint16_t _len) { ip_len = htons(_len); }
272 bool options(std::vector<const IpOpt *> &vec) const;
274 int size() const { return hlen(); }
275 const uint8_t *bytes() const { return (const uint8_t *)this; }
276 const uint8_t *payload() const { return bytes() + size(); }
277 uint8_t *bytes() { return (uint8_t *)this; }
278 uint8_t *payload() { return bytes() + size(); }
289 void set(const EthPacketPtr &ptr)
292 eth_hdr_vlan = false;
295 EthHdr *eth = (EthHdr *)ptr->data;
296 if (eth->type() == ETH_TYPE_IP)
304 IpPtr() : p(0), eth_hdr_vlan(false) {}
305 IpPtr(const EthPacketPtr &ptr) : p(0), eth_hdr_vlan(false) { set(ptr); }
306 IpPtr(const EthPtr &ptr) : p(0), eth_hdr_vlan(false) { set(ptr.p); }
307 IpPtr(const IpPtr &ptr) : p(ptr.p), eth_hdr_vlan(ptr.eth_hdr_vlan) { }
309 IpHdr *get() { return (IpHdr *)(p->data + sizeof(eth_hdr) +
310 ((eth_hdr_vlan) ? 4 : 0)); }
311 IpHdr *operator->() { return get(); }
312 IpHdr &operator*() { return *get(); }
314 const IpHdr *get() const
315 { return (const IpHdr *)(p->data + sizeof(eth_hdr) +
316 ((eth_hdr_vlan) ? 4 : 0)); }
317 const IpHdr *operator->() const { return get(); }
318 const IpHdr &operator*() const { return *get(); }
320 const IpPtr &operator=(const EthPacketPtr &ptr) { set(ptr); return *this; }
321 const IpPtr &operator=(const EthPtr &ptr) { set(ptr.p); return *this; }
322 const IpPtr &operator=(const IpPtr &ptr) { p = ptr.p; return *this; }
324 const EthPacketPtr packet() const { return p; }
325 EthPacketPtr packet() { return p; }
326 bool operator!() const { return !p; }
327 operator bool() const { return (p != nullptr); }
328 int off() const { return (sizeof(eth_hdr) + ((eth_hdr_vlan) ? 4 : 0)); }
329 int pstart() const { return (off() + get()->size()); }
332 uint16_t cksum(const IpPtr &ptr);
334 struct IpOpt : public ip_opt
336 uint8_t type() const { return opt_type; }
337 uint8_t typeNumber() const { return IP_OPT_NUMBER(opt_type); }
338 uint8_t typeClass() const { return IP_OPT_CLASS(opt_type); }
339 uint8_t typeCopied() const { return IP_OPT_COPIED(opt_type); }
340 uint8_t len() const { return IP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
342 bool isNumber(int num) const { return typeNumber() == IP_OPT_NUMBER(num); }
343 bool isClass(int cls) const { return typeClass() == IP_OPT_CLASS(cls); }
344 bool isCopied(int cpy) const { return typeCopied() == IP_OPT_COPIED(cpy); }
346 const uint8_t *data() const { return opt_data.data8; }
347 void sec(ip_opt_data_sec &sec) const;
348 void lsrr(ip_opt_data_rr &rr) const;
349 void ssrr(ip_opt_data_rr &rr) const;
350 void ts(ip_opt_data_ts &ts) const;
351 uint16_t satid() const { return ntohs(opt_data.satid); }
352 uint16_t mtup() const { return ntohs(opt_data.mtu); }
353 uint16_t mtur() const { return ntohs(opt_data.mtu); }
354 void tr(ip_opt_data_tr &tr) const;
355 const uint32_t *addext() const { return &opt_data.addext[0]; }
356 uint16_t rtralt() const { return ntohs(opt_data.rtralt); }
357 void sdb(std::vector<uint32_t> &vec) const;
364 struct Ip6Hdr : public ip6_hdr
366 uint8_t version() const { return ip6_vfc; }
367 uint32_t flow() const { return ntohl(ip6_flow); }
368 uint16_t plen() const { return ntohs(ip6_plen); }
369 uint16_t hlen() const { return IP6_HDR_LEN; }
370 uint8_t nxt() const { return ip6_nxt; }
371 uint8_t hlim() const { return ip6_hlim; }
373 const uint8_t* src() const { return ip6_src.data; }
374 const uint8_t* dst() const { return ip6_dst.data; }
376 int extensionLength() const;
377 const Ip6Opt* getExt(uint8_t ext) const;
378 const Ip6Opt* fragmentExt() const { return getExt(IP_PROTO_FRAGMENT); }
379 const Ip6Opt* rtTypeExt() const { return getExt(IP_PROTO_ROUTING); }
380 const Ip6Opt* dstOptExt() const { return getExt(IP_PROTO_DSTOPTS); }
381 uint8_t proto() const;
383 void plen(uint16_t _plen) { ip6_plen = htons(_plen); }
385 int size() const { return IP6_HDR_LEN + extensionLength(); }
386 const uint8_t *bytes() const { return (const uint8_t *)this; }
387 const uint8_t *payload() const { return bytes() + IP6_HDR_LEN
388 + extensionLength(); }
389 uint8_t *bytes() { return (uint8_t *)this; }
390 uint8_t *payload() { return bytes() + IP6_HDR_LEN
391 + extensionLength(); }
402 void set(const EthPacketPtr &ptr)
405 eth_hdr_vlan = false;
408 EthHdr *eth = (EthHdr *)ptr->data;
409 if (eth->type() == ETH_TYPE_IPV6)
417 Ip6Ptr() : p(0), eth_hdr_vlan(false) {}
418 Ip6Ptr(const EthPacketPtr &ptr) : p(0), eth_hdr_vlan(false) { set(ptr); }
419 Ip6Ptr(const EthPtr &ptr) : p(0), eth_hdr_vlan(false) { set(ptr.p); }
420 Ip6Ptr(const Ip6Ptr &ptr) : p(ptr.p), eth_hdr_vlan(ptr.eth_hdr_vlan) { }
422 Ip6Hdr *get() { return (Ip6Hdr *)(p->data + sizeof(eth_hdr)
423 + ((eth_hdr_vlan) ? 4 : 0)); }
424 Ip6Hdr *operator->() { return get(); }
425 Ip6Hdr &operator*() { return *get(); }
427 const Ip6Hdr *get() const
428 { return (const Ip6Hdr *)(p->data + sizeof(eth_hdr)
429 + ((eth_hdr_vlan) ? 4 : 0)); }
430 const Ip6Hdr *operator->() const { return get(); }
431 const Ip6Hdr &operator*() const { return *get(); }
433 const Ip6Ptr &operator=(const EthPacketPtr &ptr)
434 { set(ptr); return *this; }
435 const Ip6Ptr &operator=(const EthPtr &ptr)
436 { set(ptr.p); return *this; }
437 const Ip6Ptr &operator=(const Ip6Ptr &ptr)
438 { p = ptr.p; return *this; }
440 const EthPacketPtr packet() const { return p; }
441 EthPacketPtr packet() { return p; }
442 bool operator!() const { return !p; }
443 operator bool() const { return (p != nullptr); }
444 int off() const { return sizeof(eth_hdr) + ((eth_hdr_vlan) ? 4 : 0); }
445 int pstart() const { return off() + get()->size(); }
448 // Dnet supplied ipv6 opt header is incomplete and
449 // newer NIC card filters expect a more robust
450 // ipv6 header option declaration.
451 struct ip6_opt_fragment {
456 struct ip6_opt_routing_type2 {
463 #define HOME_ADDRESS_OPTION 0xC9
464 struct ip6_opt_dstopts {
468 } __attribute__((packed));
475 struct ip6_opt_fragment fragment;
476 struct ip6_opt_routing_type2 rtType2;
477 struct ip6_opt_dstopts dstOpts;
479 } __attribute__((packed));
481 struct Ip6Opt : public ip6_opt_hdr
483 uint8_t nxt() const { return ext_nxt; }
484 uint8_t extlen() const { return ext_len; }
485 uint8_t len() const { return extlen() + 8; }
487 // Supporting the types of header extensions likely to be encountered:
488 // fragment, routing type 2 and dstopts.
491 uint8_t rtType2Type() const { return ext_data.rtType2.type; }
492 uint8_t rtType2SegLft() const { return ext_data.rtType2.segleft; }
493 const uint8_t* rtType2Addr() const { return ext_data.rtType2.addr.data; }
496 uint16_t fragmentOfflg() const { return ntohs(ext_data.fragment.offlg); }
497 uint32_t fragmentIdent() const { return ntohl(ext_data.fragment.ident); }
499 // Dst Options/Home Address Option
500 uint8_t dstOptType() const { return ext_data.dstOpts.type; }
501 uint8_t dstOptLength() const { return ext_data.dstOpts.length; }
502 const uint8_t* dstOptAddr() const { return ext_data.dstOpts.addr.data; }
510 struct TcpHdr : public tcp_hdr
512 uint16_t sport() const { return ntohs(th_sport); }
513 uint16_t dport() const { return ntohs(th_dport); }
514 uint32_t seq() const { return ntohl(th_seq); }
515 uint32_t ack() const { return ntohl(th_ack); }
516 uint8_t off() const { return th_off*4; }
517 uint8_t flags() const { return th_flags & 0x3f; }
518 uint16_t win() const { return ntohs(th_win); }
519 uint16_t sum() const { return th_sum; }
520 uint16_t urp() const { return ntohs(th_urp); }
522 void sum(uint16_t sum) { th_sum = sum; }
523 void seq(uint32_t _seq) { th_seq = htonl(_seq); }
524 void flags(uint8_t _flags) { th_flags = _flags; }
526 bool options(std::vector<const TcpOpt *> &vec) const;
528 int size() const { return off(); }
529 const uint8_t *bytes() const { return (const uint8_t *)this; }
530 const uint8_t *payload() const { return bytes() + size(); }
531 uint8_t *bytes() { return (uint8_t *)this; }
532 uint8_t *payload() { return bytes() + size(); }
541 void set(const EthPacketPtr &ptr, int offset) { p = ptr; _off = offset; }
542 void set(const IpPtr &ptr)
544 if (ptr && ptr->proto() == IP_PROTO_TCP)
545 set(ptr.p, ptr.pstart());
549 void set(const Ip6Ptr &ptr)
551 if (ptr && ptr->proto() == IP_PROTO_TCP)
552 set(ptr.p, ptr.pstart());
558 TcpPtr() : p(0), _off(0) {}
559 TcpPtr(const IpPtr &ptr) : p(0), _off(0) { set(ptr); }
560 TcpPtr(const Ip6Ptr &ptr) : p(0), _off(0) { set(ptr); }
561 TcpPtr(const TcpPtr &ptr) : p(ptr.p), _off(ptr._off) {}
563 TcpHdr *get() { return (TcpHdr *)(p->data + _off); }
564 TcpHdr *operator->() { return get(); }
565 TcpHdr &operator*() { return *get(); }
567 const TcpHdr *get() const { return (const TcpHdr *)(p->data + _off); }
568 const TcpHdr *operator->() const { return get(); }
569 const TcpHdr &operator*() const { return *get(); }
571 const TcpPtr &operator=(const IpPtr &i)
572 { set(i); return *this; }
573 const TcpPtr &operator=(const TcpPtr &t)
574 { set(t.p, t._off); return *this; }
576 const EthPacketPtr packet() const { return p; }
577 EthPacketPtr packet() { return p; }
578 bool operator!() const { return !p; }
579 operator bool() const { return (p != nullptr); }
580 int off() const { return _off; }
581 int pstart() const { return off() + get()->size(); }
584 uint16_t cksum(const TcpPtr &ptr);
586 struct TcpOpt : public tcp_opt
588 uint8_t type() const { return opt_type; }
589 uint8_t len() const { return TCP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
591 bool isopt(int opt) const { return type() == opt; }
593 const uint8_t *data() const { return opt_data.data8; }
595 uint16_t mss() const { return ntohs(opt_data.mss); }
596 uint8_t wscale() const { return opt_data.wscale; }
597 uint32_t echo() const { return ntohl(opt_data.echo); }
598 uint32_t tsval() const { return ntohl(opt_data.timestamp[0]); }
599 uint32_t tsecr() const { return ntohl(opt_data.timestamp[1]); }
600 uint32_t cc() const { return ntohl(opt_data.cc); }
601 uint8_t cksum() const{ return opt_data.cksum; }
602 const uint8_t *md5() const { return opt_data.md5; }
604 int size() const { return len(); }
605 const uint8_t *bytes() const { return (const uint8_t *)this; }
606 const uint8_t *payload() const { return bytes() + size(); }
607 uint8_t *bytes() { return (uint8_t *)this; }
608 uint8_t *payload() { return bytes() + size(); }
614 struct UdpHdr : public udp_hdr
616 uint16_t sport() const { return ntohs(uh_sport); }
617 uint16_t dport() const { return ntohs(uh_dport); }
618 uint16_t len() const { return ntohs(uh_ulen); }
619 uint16_t sum() const { return uh_sum; }
621 void sum(uint16_t sum) { uh_sum = sum; }
622 void len(uint16_t _len) { uh_ulen = htons(_len); }
624 int size() const { return sizeof(udp_hdr); }
625 const uint8_t *bytes() const { return (const uint8_t *)this; }
626 const uint8_t *payload() const { return bytes() + size(); }
627 uint8_t *bytes() { return (uint8_t *)this; }
628 uint8_t *payload() { return bytes() + size(); }
637 void set(const EthPacketPtr &ptr, int offset) { p = ptr; _off = offset; }
638 void set(const IpPtr &ptr)
640 if (ptr && ptr->proto() == IP_PROTO_UDP)
641 set(ptr.p, ptr.pstart());
645 void set(const Ip6Ptr &ptr)
647 if (ptr && ptr->proto() == IP_PROTO_UDP)
648 set(ptr.p, ptr.pstart());
654 UdpPtr() : p(0), _off(0) {}
655 UdpPtr(const IpPtr &ptr) : p(0), _off(0) { set(ptr); }
656 UdpPtr(const Ip6Ptr &ptr) : p(0), _off(0) { set(ptr); }
657 UdpPtr(const UdpPtr &ptr) : p(ptr.p), _off(ptr._off) {}
659 UdpHdr *get() { return (UdpHdr *)(p->data + _off); }
660 UdpHdr *operator->() { return get(); }
661 UdpHdr &operator*() { return *get(); }
663 const UdpHdr *get() const { return (const UdpHdr *)(p->data + _off); }
664 const UdpHdr *operator->() const { return get(); }
665 const UdpHdr &operator*() const { return *get(); }
667 const UdpPtr &operator=(const IpPtr &i) { set(i); return *this; }
668 const UdpPtr &operator=(const UdpPtr &t)
669 { set(t.p, t._off); return *this; }
671 const EthPacketPtr packet() const { return p; }
672 EthPacketPtr packet() { return p; }
673 bool operator!() const { return !p; }
674 operator bool() const { return (p != nullptr); }
675 int off() const { return _off; }
676 int pstart() const { return off() + get()->size(); }
679 uint16_t __tu_cksum6(const Ip6Ptr &ip6);
680 uint16_t __tu_cksum(const IpPtr &ip);
681 uint16_t cksum(const UdpPtr &ptr);
683 int hsplit(const EthPacketPtr &ptr);
687 #endif // __BASE_INET_HH__