2011-12-22 15:19:25 +00:00
|
|
|
/*
|
|
|
|
* \brief Internet protocol version 4.
|
|
|
|
* \author Stefan Kalkowski
|
|
|
|
* \date 2010-08-19
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2017-02-20 12:23:52 +00:00
|
|
|
* Copyright (C) 2010-2017 Genode Labs GmbH
|
2011-12-22 15:19:25 +00:00
|
|
|
*
|
|
|
|
* This file is part of the Genode OS framework, which is distributed
|
2017-02-20 12:23:52 +00:00
|
|
|
* under the terms of the GNU Affero General Public License version 3.
|
2011-12-22 15:19:25 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _IPV4_H_
|
|
|
|
#define _IPV4_H_
|
|
|
|
|
|
|
|
/* Genode */
|
|
|
|
#include <base/exception.h>
|
|
|
|
#include <util/string.h>
|
2016-08-25 13:47:44 +00:00
|
|
|
#include <util/token.h>
|
2011-12-22 15:19:25 +00:00
|
|
|
|
|
|
|
#include <util/endian.h>
|
|
|
|
#include <net/netaddress.h>
|
|
|
|
|
2016-09-22 10:33:45 +00:00
|
|
|
namespace Genode { class Output; }
|
|
|
|
|
2016-08-15 10:50:33 +00:00
|
|
|
namespace Net
|
|
|
|
{
|
|
|
|
enum { IPV4_ADDR_LEN = 4 };
|
2016-09-22 10:33:45 +00:00
|
|
|
|
|
|
|
class Ipv4_address;
|
2016-08-15 10:50:33 +00:00
|
|
|
|
|
|
|
class Ipv4_packet;
|
|
|
|
}
|
2011-12-22 15:19:25 +00:00
|
|
|
|
2015-03-04 20:12:14 +00:00
|
|
|
|
2016-09-22 10:33:45 +00:00
|
|
|
struct Net::Ipv4_address : Network_address<IPV4_ADDR_LEN, '.', false>
|
|
|
|
{
|
|
|
|
Ipv4_address(Genode::uint8_t value = 0) : Network_address(value) { }
|
|
|
|
|
|
|
|
Ipv4_address(void *src) : Network_address(src) { }
|
|
|
|
|
|
|
|
bool valid() const { return *this != Ipv4_address(); }
|
2017-09-27 11:54:58 +00:00
|
|
|
|
|
|
|
Genode::uint32_t to_uint32_big_endian() const;
|
|
|
|
|
|
|
|
static Ipv4_address from_uint32_big_endian(Genode::uint32_t ip_raw);
|
|
|
|
|
|
|
|
Genode::uint32_t to_uint32_little_endian() const;
|
|
|
|
|
|
|
|
static Ipv4_address from_uint32_little_endian(Genode::uint32_t ip_raw);
|
2017-10-06 11:00:05 +00:00
|
|
|
|
|
|
|
bool is_in_range(Ipv4_address const &first,
|
|
|
|
Ipv4_address const &last) const;
|
2016-10-24 09:46:14 +00:00
|
|
|
}
|
|
|
|
__attribute__((packed));
|
2016-09-22 10:33:45 +00:00
|
|
|
|
|
|
|
|
2015-03-04 20:12:14 +00:00
|
|
|
/**
|
|
|
|
* Data layout of this class conforms to an IPv4 packet (RFC 791)
|
|
|
|
*
|
|
|
|
* IPv4-header-format:
|
|
|
|
*
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
* | 0-3 | 4-7 | 8-11 | 12-15 | 16-18 | 19-23 | 24-27 | 28-31 |
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
* | version | IHL | service-type | total-length |
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
* | identifikation | flags | fragment-offset |
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
* | ttl | protocol | header-checksum |
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
* | source-ip-address |
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
* | destination-ip-address |
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
* | options ... |
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
class Net::Ipv4_packet
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
enum Size {
|
2016-08-15 10:50:33 +00:00
|
|
|
ADDR_LEN = IPV4_ADDR_LEN, /* Ip address length in bytes */
|
2016-06-03 14:21:45 +00:00
|
|
|
};
|
2015-03-04 20:12:14 +00:00
|
|
|
|
|
|
|
static const Ipv4_address CURRENT; /* current network */
|
|
|
|
static const Ipv4_address BROADCAST; /* broadcast address */
|
|
|
|
|
|
|
|
static Ipv4_address ip_from_string(const char *ip);
|
|
|
|
|
2016-03-18 18:41:00 +00:00
|
|
|
static Genode::uint16_t calculate_checksum(Ipv4_packet const &packet);
|
|
|
|
|
2015-03-04 20:12:14 +00:00
|
|
|
private:
|
|
|
|
|
|
|
|
/************************
|
|
|
|
** IPv4 header fields **
|
|
|
|
************************/
|
|
|
|
|
|
|
|
unsigned _header_length : 4;
|
2016-03-18 18:40:13 +00:00
|
|
|
unsigned _version : 4;
|
2017-09-14 13:10:32 +00:00
|
|
|
unsigned _diff_service : 6;
|
|
|
|
unsigned _ecn : 2;
|
2015-03-04 20:12:14 +00:00
|
|
|
Genode::uint16_t _total_length;
|
|
|
|
Genode::uint16_t _identification;
|
|
|
|
unsigned _flags : 3;
|
|
|
|
unsigned _fragment_offset : 13;
|
|
|
|
Genode::uint8_t _time_to_live;
|
|
|
|
Genode::uint8_t _protocol;
|
2017-09-14 13:10:32 +00:00
|
|
|
Genode::uint16_t _checksum;
|
|
|
|
Genode::uint8_t _src[ADDR_LEN];
|
|
|
|
Genode::uint8_t _dst[ADDR_LEN];
|
2015-03-04 20:12:14 +00:00
|
|
|
unsigned _data[0];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Bitmasks for differentiated services field.
|
|
|
|
*/
|
|
|
|
enum Differentiated_services {
|
|
|
|
PRECEDENCE = 0x7,
|
|
|
|
DELAY = 0x8,
|
|
|
|
THROUGHPUT = 0x10,
|
|
|
|
RELIABILITY = 0x20,
|
|
|
|
COST = 0x40
|
|
|
|
};
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
2017-09-14 13:10:32 +00:00
|
|
|
enum class Protocol : Genode::uint8_t
|
|
|
|
{
|
|
|
|
TCP = 6,
|
|
|
|
UDP = 17,
|
|
|
|
};
|
|
|
|
|
2015-03-04 20:12:14 +00:00
|
|
|
enum Precedence {
|
|
|
|
NETWORK_CONTROL = 7,
|
|
|
|
INTERNETWORK_CONTROL = 6,
|
|
|
|
CRITIC_ECP = 5,
|
|
|
|
FLASH_OVERRIDE = 4,
|
|
|
|
FLASH = 3,
|
|
|
|
IMMEDIATE = 2,
|
|
|
|
PRIORITY = 1,
|
|
|
|
ROUTINE = 0
|
|
|
|
};
|
|
|
|
|
|
|
|
enum Flags {
|
|
|
|
NO_FRAGMENT = 0x2,
|
|
|
|
MORE_FRAGMENTS = 0x4
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Exception used to indicate protocol violation.
|
|
|
|
*/
|
|
|
|
class No_ip_packet : Genode::Exception {};
|
|
|
|
|
Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
2017-12-21 14:42:15 +00:00
|
|
|
static void validate_size(Genode::size_t size) {
|
2015-03-04 20:12:14 +00:00
|
|
|
/* ip header needs to fit in */
|
|
|
|
if (size < sizeof(Ipv4_packet))
|
|
|
|
throw No_ip_packet();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-09-14 13:10:32 +00:00
|
|
|
/***************
|
|
|
|
** Accessors **
|
|
|
|
***************/
|
|
|
|
|
|
|
|
Genode::size_t header_length() const { return _header_length; }
|
|
|
|
Genode::uint8_t version() const { return _version; }
|
|
|
|
Genode::uint8_t diff_service() const { return _diff_service; }
|
|
|
|
Genode::uint8_t ecn() const { return _ecn; }
|
|
|
|
Genode::size_t total_length() const { return host_to_big_endian(_total_length); }
|
|
|
|
Genode::uint16_t identification() const { return host_to_big_endian(_identification); }
|
|
|
|
Genode::uint8_t flags() const { return _flags; }
|
|
|
|
Genode::size_t fragment_offset() const { return _fragment_offset; }
|
|
|
|
Genode::uint8_t time_to_live() const { return _time_to_live; }
|
|
|
|
Protocol protocol() const { return (Protocol)_protocol; }
|
|
|
|
Genode::uint16_t checksum() const { return host_to_big_endian(_checksum); }
|
|
|
|
Ipv4_address src() const { return Ipv4_address((void *)&_src); }
|
|
|
|
Ipv4_address dst() const { return Ipv4_address((void *)&_dst); }
|
|
|
|
template <typename T> T const * data() const { return (T const *)(_data); }
|
|
|
|
template <typename T> T * data() { return (T *)(_data); }
|
|
|
|
|
|
|
|
void header_length(Genode::size_t v) { _header_length = v; }
|
|
|
|
void version(Genode::uint8_t v) { _version = v; }
|
|
|
|
void diff_service(Genode::uint8_t v) { _diff_service = v; ; }
|
|
|
|
void ecn(Genode::uint8_t v) { _ecn = v; ; }
|
|
|
|
void total_length(Genode::size_t v) { _total_length = host_to_big_endian((Genode::uint16_t)v); }
|
|
|
|
void identification(Genode::uint16_t v) { _identification = host_to_big_endian(v); }
|
|
|
|
void flags(Genode::uint8_t v) { _flags = v; ; }
|
|
|
|
void fragment_offset(Genode::size_t v) { _fragment_offset = v; ; }
|
|
|
|
void time_to_live(Genode::uint8_t v) { _time_to_live = v; }
|
|
|
|
void protocol(Protocol v) { _protocol = (Genode::uint8_t)v; }
|
|
|
|
void checksum(Genode::uint16_t checksum) { _checksum = host_to_big_endian(checksum); }
|
|
|
|
void src(Ipv4_address v) { v.copy(&_src); }
|
|
|
|
void dst(Ipv4_address v) { v.copy(&_dst); }
|
2016-03-18 18:41:00 +00:00
|
|
|
|
2015-03-04 20:12:14 +00:00
|
|
|
|
|
|
|
/***************
|
|
|
|
** Operators **
|
|
|
|
***************/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Placement new.
|
|
|
|
*/
|
Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
2017-12-21 14:42:15 +00:00
|
|
|
void * operator new(__SIZE_TYPE__, void* addr) { return addr; }
|
2015-03-04 20:12:14 +00:00
|
|
|
|
2016-11-02 00:00:59 +00:00
|
|
|
|
|
|
|
/*********
|
|
|
|
** log **
|
|
|
|
*********/
|
|
|
|
|
|
|
|
void print(Genode::Output &output) const;
|
|
|
|
|
2015-03-04 20:12:14 +00:00
|
|
|
} __attribute__((packed));
|
2011-12-22 15:19:25 +00:00
|
|
|
|
2016-08-25 13:47:44 +00:00
|
|
|
|
|
|
|
namespace Genode {
|
|
|
|
|
|
|
|
inline size_t ascii_to(char const *s, Net::Ipv4_address &result);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
Genode::size_t Genode::ascii_to(char const *s, Net::Ipv4_address &result)
|
|
|
|
{
|
2016-12-22 02:08:12 +00:00
|
|
|
Net::Ipv4_address buf;
|
|
|
|
size_t number_idx = 0;
|
|
|
|
size_t read_len = 0;
|
|
|
|
while (1) {
|
|
|
|
|
|
|
|
/* read the current number, fail if there's no number */
|
|
|
|
size_t number_len = ascii_to_unsigned(s, buf.addr[number_idx], 10);
|
|
|
|
if (!number_len) {
|
|
|
|
return 0; }
|
|
|
|
|
|
|
|
/* update read length and number index */
|
|
|
|
read_len += number_len;
|
|
|
|
number_idx++;
|
|
|
|
|
|
|
|
/* if we have all numbers, fill result and return read length */
|
|
|
|
if (number_idx == sizeof(buf.addr) / sizeof(buf.addr[0])) {
|
|
|
|
result = buf;
|
|
|
|
return read_len;
|
2016-08-25 13:47:44 +00:00
|
|
|
}
|
2016-12-22 02:08:12 +00:00
|
|
|
/* as it was not the last number, check for the following dot */
|
|
|
|
s += number_len;
|
|
|
|
if (*s != '.') {
|
|
|
|
return 0; }
|
|
|
|
read_len++;
|
|
|
|
s++;
|
2016-08-25 13:47:44 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-12-22 15:19:25 +00:00
|
|
|
#endif /* _IPV4_H_ */
|