2 * Copyright (c) 2002-2003 The Regents of The University of Michigan
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.
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.
29 #ifndef __BASE_INET_HH__
30 #define __BASE_INET_HH__
37 #include "base/range.hh"
38 #include "dev/etherpkt.hh"
39 #include "sim/host.hh"
45 #include "dnet/addr.h"
47 #include "dnet/icmp.h"
50 #include "dnet/intf.h"
51 #include "dnet/route.h"
53 #include "dnet/blob.h"
54 #include "dnet/rand.h"
61 struct EthAddr : protected eth_addr
64 void parse(const std::string &addr);
68 EthAddr(const uint8_t ea[ETH_ADDR_LEN]);
69 EthAddr(const eth_addr &ea);
70 EthAddr(const std::string &addr);
71 const EthAddr &operator=(const eth_addr &ea);
72 const EthAddr &operator=(const std::string &addr);
74 int size() const { return sizeof(eth_addr); }
76 const uint8_t *bytes() const { return &data[0]; }
77 uint8_t *bytes() { return &data[0]; }
79 const uint8_t *addr() const { return &data[0]; }
80 bool unicast() const { return data[0] == 0x00; }
81 bool multicast() const { return data[0] == 0x01; }
82 bool broadcast() const { return data[0] == 0xff; }
83 std::string string() const;
85 operator uint64_t() const
88 reg |= ((uint64_t)data[0]) << 40;
89 reg |= ((uint64_t)data[1]) << 32;
90 reg |= ((uint64_t)data[2]) << 24;
91 reg |= ((uint64_t)data[3]) << 16;
92 reg |= ((uint64_t)data[4]) << 8;
93 reg |= ((uint64_t)data[5]) << 0;
99 std::ostream &operator<<(std::ostream &stream, const EthAddr &ea);
100 bool operator==(const EthAddr &left, const EthAddr &right);
102 struct EthHdr : public eth_hdr
104 uint16_t type() const { return ntohs(eth_type); }
105 const EthAddr &src() const { return *(EthAddr *)ð_src; }
106 const EthAddr &dst() const { return *(EthAddr *)ð_dst; }
108 int size() const { return sizeof(eth_hdr); }
110 const uint8_t *bytes() const { return (const uint8_t *)this; }
111 const uint8_t *payload() const { return bytes() + size(); }
112 uint8_t *bytes() { return (uint8_t *)this; }
113 uint8_t *payload() { return bytes() + size(); }
124 EthPtr(const PacketPtr &ptr) : p(ptr) { }
126 EthHdr *operator->() { return (EthHdr *)p->data; }
127 EthHdr &operator*() { return *(EthHdr *)p->data; }
128 operator EthHdr *() { return (EthHdr *)p->data; }
130 const EthHdr *operator->() const { return (const EthHdr *)p->data; }
131 const EthHdr &operator*() const { return *(const EthHdr *)p->data; }
132 operator const EthHdr *() const { return (const EthHdr *)p->data; }
134 const EthPtr &operator=(const PacketPtr &ptr) { p = ptr; return *this; }
136 const PacketPtr packet() const { return p; }
137 PacketPtr packet() { return p; }
138 bool operator!() const { return !p; }
139 operator bool() const { return p; }
146 struct IpHdr : public ip_hdr
148 uint8_t version() const { return ip_v; }
149 uint8_t hlen() const { return ip_hl * 4; }
150 uint8_t tos() const { return ip_tos; }
151 uint16_t len() const { return ntohs(ip_len); }
152 uint16_t id() const { return ntohs(ip_id); }
153 uint16_t frag_flags() const { return ntohs(ip_off) >> 13; }
154 uint16_t frag_off() const { return ntohs(ip_off) & 0x1fff; }
155 uint8_t ttl() const { return ip_ttl; }
156 uint8_t proto() const { return ip_p; }
157 uint16_t sum() const { return ip_sum; }
158 uint32_t src() const { return ntohl(ip_src); }
159 uint32_t dst() const { return ntohl(ip_dst); }
161 void sum(uint16_t sum) { ip_sum = sum; }
163 bool options(std::vector<const IpOpt *> &vec) const;
165 int size() const { return hlen(); }
166 const uint8_t *bytes() const { return (const uint8_t *)this; }
167 const uint8_t *payload() const { return bytes() + size(); }
168 uint8_t *bytes() { return (uint8_t *)this; }
169 uint8_t *payload() { return bytes() + size(); }
179 const IpHdr *h() const
180 { return (const IpHdr *)(p->data + sizeof(eth_hdr)); }
181 IpHdr *h() { return (IpHdr *)(p->data + sizeof(eth_hdr)); }
183 void set(const PacketPtr &ptr)
185 EthHdr *eth = (EthHdr *)ptr->data;
186 if (eth->type() == ETH_TYPE_IP)
194 IpPtr(const PacketPtr &ptr) { set(ptr); }
195 IpPtr(const EthPtr &ptr) { set(ptr.p); }
196 IpPtr(const IpPtr &ptr) : p(ptr.p) { }
198 IpHdr *operator->() { return h(); }
199 IpHdr &operator*() { return *h(); }
200 operator IpHdr *() { return h(); }
202 const IpHdr *operator->() const { return h(); }
203 const IpHdr &operator*() const { return *h(); }
204 operator const IpHdr *() const { return h(); }
206 const IpPtr &operator=(const PacketPtr &ptr) { set(ptr); return *this; }
207 const IpPtr &operator=(const EthPtr &ptr) { set(ptr.p); return *this; }
208 const IpPtr &operator=(const IpPtr &ptr) { p = ptr.p; return *this; }
210 const PacketPtr packet() const { return p; }
211 PacketPtr packet() { return p; }
212 bool operator!() const { return !p; }
213 operator bool() const { return p; }
214 operator bool() { return p; }
217 uint16_t cksum(const IpPtr &ptr);
219 struct IpOpt : public ip_opt
221 uint8_t type() const { return opt_type; }
222 uint8_t typeNumber() const { return IP_OPT_NUMBER(opt_type); }
223 uint8_t typeClass() const { return IP_OPT_CLASS(opt_type); }
224 uint8_t typeCopied() const { return IP_OPT_COPIED(opt_type); }
225 uint8_t len() const { return IP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
227 bool isNumber(int num) const { return typeNumber() == IP_OPT_NUMBER(num); }
228 bool isClass(int cls) const { return typeClass() == IP_OPT_CLASS(cls); }
229 bool isCopied(int cpy) const { return typeCopied() == IP_OPT_COPIED(cpy); }
231 const uint8_t *data() const { return opt_data.data8; }
232 void sec(ip_opt_data_sec &sec) const;
233 void lsrr(ip_opt_data_rr &rr) const;
234 void ssrr(ip_opt_data_rr &rr) const;
235 void ts(ip_opt_data_ts &ts) const;
236 uint16_t satid() const { return ntohs(opt_data.satid); }
237 uint16_t mtup() const { return ntohs(opt_data.mtu); }
238 uint16_t mtur() const { return ntohs(opt_data.mtu); }
239 void tr(ip_opt_data_tr &tr) const;
240 const uint32_t *addext() const { return &opt_data.addext[0]; }
241 uint16_t rtralt() const { return ntohs(opt_data.rtralt); }
242 void sdb(std::vector<uint32_t> &vec) const;
249 struct TcpHdr : public tcp_hdr
251 uint16_t sport() const { return ntohs(th_sport); }
252 uint16_t dport() const { return ntohs(th_dport); }
253 uint32_t seq() const { return ntohl(th_seq); }
254 uint32_t ack() const { return ntohl(th_ack); }
255 uint8_t off() const { return th_off; }
256 uint8_t flags() const { return th_flags & 0x3f; }
257 uint16_t win() const { return ntohs(th_win); }
258 uint16_t sum() const { return th_sum; }
259 uint16_t urp() const { return ntohs(th_urp); }
261 void sum(uint16_t sum) { th_sum = sum; }
263 bool options(std::vector<const TcpOpt *> &vec) const;
265 int size() const { return off(); }
266 const uint8_t *bytes() const { return (const uint8_t *)this; }
267 const uint8_t *payload() const { return bytes() + size(); }
268 uint8_t *bytes() { return (uint8_t *)this; }
269 uint8_t *payload() { return bytes() + size(); }
278 const TcpHdr *h() const { return (const TcpHdr *)(p->data + off); }
279 TcpHdr *h() { return (TcpHdr *)(p->data + off); }
281 void set(const PacketPtr &ptr, int offset) { p = ptr; off = offset; }
282 void set(const IpPtr &ptr)
284 if (ptr->proto() == IP_PROTO_TCP)
285 set(ptr.p, sizeof(eth_hdr) + ptr->hlen());
292 TcpPtr(const IpPtr &ptr) { set(ptr); }
293 TcpPtr(const TcpPtr &ptr) : p(ptr.p), off(ptr.off) {}
295 TcpHdr *operator->() { return h(); }
296 TcpHdr &operator*() { return *h(); }
297 operator TcpHdr *() { return h(); }
299 const TcpHdr *operator->() const { return h(); }
300 const TcpHdr &operator*() const { return *h(); }
301 operator const TcpHdr *() const { return h(); }
303 const TcpPtr &operator=(const IpPtr &i) { set(i); return *this; }
304 const TcpPtr &operator=(const TcpPtr &t) { set(t.p, t.off); return *this; }
306 const PacketPtr packet() const { return p; }
307 PacketPtr packet() { return p; }
308 bool operator!() const { return !p; }
309 operator bool() const { return p; }
310 operator bool() { return p; }
313 uint16_t cksum(const TcpPtr &ptr);
315 typedef Range<uint16_t> SackRange;
317 struct TcpOpt : public tcp_opt
319 uint8_t type() const { return opt_type; }
320 uint8_t len() const { return TCP_OPT_TYPEONLY(type()) ? 1 : opt_len; }
322 bool isopt(int opt) const { return type() == opt; }
324 const uint8_t *data() const { return opt_data.data8; }
326 uint16_t mss() const { return ntohs(opt_data.mss); }
327 uint8_t wscale() const { return opt_data.wscale; }
328 bool sack(std::vector<SackRange> &vec) const;
329 uint32_t echo() const { return ntohl(opt_data.echo); }
330 uint32_t tsval() const { return ntohl(opt_data.timestamp[0]); }
331 uint32_t tsecr() const { return ntohl(opt_data.timestamp[1]); }
332 uint32_t cc() const { return ntohl(opt_data.cc); }
333 uint8_t cksum() const{ return opt_data.cksum; }
334 const uint8_t *md5() const { return opt_data.md5; }
336 int size() const { return len(); }
337 const uint8_t *bytes() const { return (const uint8_t *)this; }
338 const uint8_t *payload() const { return bytes() + size(); }
339 uint8_t *bytes() { return (uint8_t *)this; }
340 uint8_t *payload() { return bytes() + size(); }
346 struct UdpHdr : public udp_hdr
348 uint16_t sport() const { return ntohs(uh_sport); }
349 uint16_t dport() const { return ntohs(uh_dport); }
350 uint16_t len() const { return ntohs(uh_ulen); }
351 uint16_t sum() const { return ntohs(uh_sum); }
353 void sum(uint16_t sum) { uh_sum = htons(sum); }
355 int size() const { return sizeof(udp_hdr); }
356 const uint8_t *bytes() const { return (const uint8_t *)this; }
357 const uint8_t *payload() const { return bytes() + size(); }
358 uint8_t *bytes() { return (uint8_t *)this; }
359 uint8_t *payload() { return bytes() + size(); }
368 const UdpHdr *h() const { return (const UdpHdr *)(p->data + off); }
369 UdpHdr *h() { return (UdpHdr *)(p->data + off); }
371 void set(const PacketPtr &ptr, int offset) { p = ptr; off = offset; }
372 void set(const IpPtr &ptr)
374 if (ptr->proto() == IP_PROTO_UDP)
375 set(ptr.p, sizeof(eth_hdr) + ptr->hlen());
382 UdpPtr(const IpPtr &ptr) { set(ptr); }
383 UdpPtr(const UdpPtr &ptr) : p(ptr.p), off(ptr.off) {}
385 UdpHdr *operator->() { return h(); }
386 UdpHdr &operator*() { return *h(); }
387 operator UdpHdr *() { return h(); }
389 const UdpHdr *operator->() const { return h(); }
390 const UdpHdr &operator*() const { return *h(); }
391 operator const UdpHdr *() const { return h(); }
393 const UdpPtr &operator=(const IpPtr &i) { set(i); return *this; }
394 const UdpPtr &operator=(const UdpPtr &t) { set(t.p, t.off); return *this; }
396 const PacketPtr packet() const { return p; }
397 PacketPtr packet() { return p; }
398 bool operator!() const { return !p; }
399 operator bool() const { return p; }
400 operator bool() { return p; }
403 uint16_t cksum(const UdpPtr &ptr);
405 /* namespace Net */ }
407 #endif // __BASE_INET_HH__