ipv4.c File Reference

IPv4 (Internet Protocol Version 4) More...

#include <string.h>
#include <ctype.h>
#include "core/net.h"
#include "core/ethernet.h"
#include "core/ip.h"
#include "core/udp.h"
#include "core/tcp_fsm.h"
#include "core/raw_socket.h"
#include "ipv4/arp.h"
#include "ipv4/ipv4.h"
#include "ipv4/ipv4_routing.h"
#include "ipv4/icmp.h"
#include "ipv4/igmp.h"
#include "ipv4/auto_ip.h"
#include "dhcp/dhcp_client.h"
#include "mdns/mdns_responder.h"
#include "mibs/mib2_module.h"
#include "mibs/ip_mib_module.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   IPV4_TRACE_LEVEL
 

Functions

error_t ipv4Init (NetInterface *interface)
 IPv4 related initialization. More...
 
error_t ipv4SetHostAddr (NetInterface *interface, Ipv4Addr addr)
 Assign host address. More...
 
error_t ipv4GetHostAddr (NetInterface *interface, Ipv4Addr *addr)
 Retrieve host address. More...
 
error_t ipv4SetSubnetMask (NetInterface *interface, Ipv4Addr mask)
 Configure subnet mask. More...
 
error_t ipv4GetSubnetMask (NetInterface *interface, Ipv4Addr *mask)
 Retrieve subnet mask. More...
 
error_t ipv4SetDefaultGateway (NetInterface *interface, Ipv4Addr addr)
 Configure default gateway. More...
 
error_t ipv4GetDefaultGateway (NetInterface *interface, Ipv4Addr *addr)
 Retrieve default gateway. More...
 
error_t ipv4SetDnsServer (NetInterface *interface, uint_t index, Ipv4Addr addr)
 Configure DNS server. More...
 
error_t ipv4GetDnsServer (NetInterface *interface, uint_t index, Ipv4Addr *addr)
 Retrieve DNS server. More...
 
error_t ipv4GetBroadcastAddr (NetInterface *interface, Ipv4Addr *addr)
 Get IPv4 broadcast address. More...
 
void ipv4LinkChangeEvent (NetInterface *interface)
 Callback function for link change event. More...
 
void ipv4ProcessPacket (NetInterface *interface, Ipv4Header *packet, size_t length)
 Incoming IPv4 packet processing. More...
 
void ipv4ProcessDatagram (NetInterface *interface, const NetBuffer *buffer)
 Incoming IPv4 datagram processing. More...
 
error_t ipv4SendDatagram (NetInterface *interface, Ipv4PseudoHeader *pseudoHeader, NetBuffer *buffer, size_t offset, uint8_t ttl)
 Send an IPv4 datagram. More...
 
error_t ipv4SendPacket (NetInterface *interface, Ipv4PseudoHeader *pseudoHeader, uint16_t fragId, size_t fragOffset, NetBuffer *buffer, size_t offset, uint8_t ttl)
 Send an IPv4 packet. More...
 
error_t ipv4CheckSourceAddr (NetInterface *interface, Ipv4Addr ipAddr)
 Source IPv4 address filtering. More...
 
error_t ipv4CheckDestAddr (NetInterface *interface, Ipv4Addr ipAddr)
 Destination IPv4 address filtering. More...
 
error_t ipv4SelectSourceAddr (NetInterface **interface, Ipv4Addr destAddr, Ipv4Addr *srcAddr)
 IPv4 source address selection. More...
 
bool_t ipv4IsBroadcastAddr (NetInterface *interface, Ipv4Addr ipAddr)
 Check whether an IPv4 address is a broadcast address. More...
 
uint_t ipv4GetAddrScope (Ipv4Addr ipAddr)
 Retrieve the scope of an IPv4 address. More...
 
uint_t ipv4GetPrefixLength (Ipv4Addr mask)
 Calculate prefix length for a given subnet mask. More...
 
error_t ipv4JoinMulticastGroup (NetInterface *interface, Ipv4Addr groupAddr)
 Join the specified host group. More...
 
error_t ipv4LeaveMulticastGroup (NetInterface *interface, Ipv4Addr groupAddr)
 Leave the specified host group. More...
 
error_t ipv4MapMulticastAddrToMac (Ipv4Addr ipAddr, MacAddr *macAddr)
 Map an host group address to a MAC-layer multicast address. More...
 
void ipv4UpdateInStats (NetInterface *interface, Ipv4Addr destIpAddr, size_t length)
 Update IPv4 input statistics. More...
 
void ipv4UpdateOutStats (NetInterface *interface, Ipv4Addr destIpAddr, size_t length)
 Update IPv4 output statistics. More...
 
error_t ipv4StringToAddr (const char_t *str, Ipv4Addr *ipAddr)
 Convert a dot-decimal string to a binary IPv4 address. More...
 
char_tipv4AddrToString (Ipv4Addr ipAddr, char_t *str)
 Convert a binary IPv4 address to dot-decimal notation. More...
 
void ipv4DumpHeader (const Ipv4Header *ipHeader)
 Dump IPv4 header for debugging purpose. More...
 

Detailed Description

IPv4 (Internet Protocol Version 4)

License

Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Description

The Internet Protocol (IP) provides the functions necessary to deliver a datagram from a source to a destination over an interconnected system of networks. Refer to RFC 791 for complete details

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
1.9.0

Definition in file ipv4.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   IPV4_TRACE_LEVEL

Definition at line 36 of file ipv4.c.

Function Documentation

◆ ipv4AddrToString()

char_t* ipv4AddrToString ( Ipv4Addr  ipAddr,
char_t str 
)

Convert a binary IPv4 address to dot-decimal notation.

Parameters
[in]ipAddrBinary representation of the IPv4 address
[out]strNULL-terminated string representing the IPv4 address
Returns
Pointer to the formatted string

Definition at line 1785 of file ipv4.c.

◆ ipv4CheckDestAddr()

error_t ipv4CheckDestAddr ( NetInterface interface,
Ipv4Addr  ipAddr 
)

Destination IPv4 address filtering.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrDestination IPv4 address to be checked
Returns
Error code

Definition at line 1062 of file ipv4.c.

◆ ipv4CheckSourceAddr()

error_t ipv4CheckSourceAddr ( NetInterface interface,
Ipv4Addr  ipAddr 
)

Source IPv4 address filtering.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrSource IPv4 address to be checked
Returns
Error code

Definition at line 1038 of file ipv4.c.

◆ ipv4DumpHeader()

void ipv4DumpHeader ( const Ipv4Header ipHeader)

Dump IPv4 header for debugging purpose.

Parameters
[in]ipHeaderPointer to the IPv4 header

Definition at line 1809 of file ipv4.c.

◆ ipv4GetAddrScope()

uint_t ipv4GetAddrScope ( Ipv4Addr  ipAddr)

Retrieve the scope of an IPv4 address.

Parameters
[in]ipAddrIPv4 address
Returns
IPv4 address scope

Definition at line 1304 of file ipv4.c.

◆ ipv4GetBroadcastAddr()

error_t ipv4GetBroadcastAddr ( NetInterface interface,
Ipv4Addr addr 
)

Get IPv4 broadcast address.

Parameters
[in]interfacePointer to the desired network interface
[out]addrIPv4 broadcast address

Definition at line 371 of file ipv4.c.

◆ ipv4GetDefaultGateway()

error_t ipv4GetDefaultGateway ( NetInterface interface,
Ipv4Addr addr 
)

Retrieve default gateway.

Parameters
[in]interfacePointer to the desired network interface
[out]addrDefault gateway address
Returns
Error code

Definition at line 278 of file ipv4.c.

◆ ipv4GetDnsServer()

error_t ipv4GetDnsServer ( NetInterface interface,
uint_t  index,
Ipv4Addr addr 
)

Retrieve DNS server.

Parameters
[in]interfacePointer to the desired network interface
[in]indexThis parameter selects between the primary and secondary DNS server
[out]addrDNS server address
Returns
Error code

Definition at line 338 of file ipv4.c.

◆ ipv4GetHostAddr()

error_t ipv4GetHostAddr ( NetInterface interface,
Ipv4Addr addr 
)

Retrieve host address.

Parameters
[in]interfacePointer to the desired network interface
[out]addrIPv4 host address
Returns
Error code

Definition at line 163 of file ipv4.c.

◆ ipv4GetPrefixLength()

uint_t ipv4GetPrefixLength ( Ipv4Addr  mask)

Calculate prefix length for a given subnet mask.

Parameters
[in]maskSubnet mask
Returns
Prefix length

Definition at line 1368 of file ipv4.c.

◆ ipv4GetSubnetMask()

error_t ipv4GetSubnetMask ( NetInterface interface,
Ipv4Addr mask 
)

Retrieve subnet mask.

Parameters
[in]interfacePointer to the desired network interface
[out]maskSubnet mask
Returns
Error code

Definition at line 224 of file ipv4.c.

◆ ipv4Init()

error_t ipv4Init ( NetInterface interface)

IPv4 related initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 69 of file ipv4.c.

◆ ipv4IsBroadcastAddr()

bool_t ipv4IsBroadcastAddr ( NetInterface interface,
Ipv4Addr  ipAddr 
)

Check whether an IPv4 address is a broadcast address.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrIPv4 address to be checked
Returns
TRUE if the IPv4 address is a broadcast address, else FALSE

Definition at line 1275 of file ipv4.c.

◆ ipv4JoinMulticastGroup()

error_t ipv4JoinMulticastGroup ( NetInterface interface,
Ipv4Addr  groupAddr 
)

Join the specified host group.

Parameters
[in]interfaceUnderlying network interface
[in]groupAddrIPv4 address identifying the host group to join
Returns
Error code

Definition at line 1395 of file ipv4.c.

◆ ipv4LeaveMulticastGroup()

error_t ipv4LeaveMulticastGroup ( NetInterface interface,
Ipv4Addr  groupAddr 
)

Leave the specified host group.

Parameters
[in]interfaceUnderlying network interface
[in]groupAddrIPv4 address identifying the host group to leave
Returns
Error code

Definition at line 1504 of file ipv4.c.

◆ ipv4LinkChangeEvent()

void ipv4LinkChangeEvent ( NetInterface interface)

Callback function for link change event.

Parameters
[in]interfaceUnderlying network interface

Definition at line 392 of file ipv4.c.

◆ ipv4MapMulticastAddrToMac()

error_t ipv4MapMulticastAddrToMac ( Ipv4Addr  ipAddr,
MacAddr macAddr 
)

Map an host group address to a MAC-layer multicast address.

Parameters
[in]ipAddrIPv4 host group address
[out]macAddrCorresponding MAC-layer multicast address
Returns
Error code

Definition at line 1580 of file ipv4.c.

◆ ipv4ProcessDatagram()

void ipv4ProcessDatagram ( NetInterface interface,
const NetBuffer buffer 
)

Incoming IPv4 datagram processing.

Parameters
[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer that holds the incoming IPv4 datagram

Definition at line 627 of file ipv4.c.

◆ ipv4ProcessPacket()

void ipv4ProcessPacket ( NetInterface interface,
Ipv4Header packet,
size_t  length 
)

Incoming IPv4 packet processing.

Parameters
[in]interfaceUnderlying network interface
[in]packetIncoming IPv4 packet
[in]lengthPacket length including header and payload

Definition at line 440 of file ipv4.c.

◆ ipv4SelectSourceAddr()

error_t ipv4SelectSourceAddr ( NetInterface **  interface,
Ipv4Addr  destAddr,
Ipv4Addr srcAddr 
)

IPv4 source address selection.

This function selects the source address and the relevant network interface to be used in order to join the specified destination address

Parameters
[in,out]interfaceA pointer to a valid network interface may be provided as a hint. The function returns a pointer identifying the interface to be used
[in]destAddrDestination IPv4 address
[out]srcAddrLocal IPv4 address to be used
Returns
Error code

Definition at line 1134 of file ipv4.c.

◆ ipv4SendDatagram()

error_t ipv4SendDatagram ( NetInterface interface,
Ipv4PseudoHeader pseudoHeader,
NetBuffer buffer,
size_t  offset,
uint8_t  ttl 
)

Send an IPv4 datagram.

Parameters
[in]interfaceUnderlying network interface
[in]pseudoHeaderIPv4 pseudo header
[in]bufferMulti-part buffer containing the payload
[in]offsetOffset to the first byte of the payload
[in]ttlTTL value. Default Time-To-Live is used when this parameter is zero
Returns
Error code

Definition at line 774 of file ipv4.c.

◆ ipv4SendPacket()

error_t ipv4SendPacket ( NetInterface interface,
Ipv4PseudoHeader pseudoHeader,
uint16_t  fragId,
size_t  fragOffset,
NetBuffer buffer,
size_t  offset,
uint8_t  ttl 
)

Send an IPv4 packet.

Parameters
[in]interfaceUnderlying network interface
[in]pseudoHeaderIPv4 pseudo header
[in]fragIdFragment identification field
[in]fragOffsetFragment offset field
[in]bufferMulti-part buffer containing the payload
[in]offsetOffset to the first byte of the payload
[in]ttlTime-To-Live value
Returns
Error code

Definition at line 842 of file ipv4.c.

◆ ipv4SetDefaultGateway()

error_t ipv4SetDefaultGateway ( NetInterface interface,
Ipv4Addr  addr 
)

Configure default gateway.

Parameters
[in]interfacePointer to the desired network interface
[in]addrDefault gateway address
Returns
Error code

Definition at line 249 of file ipv4.c.

◆ ipv4SetDnsServer()

error_t ipv4SetDnsServer ( NetInterface interface,
uint_t  index,
Ipv4Addr  addr 
)

Configure DNS server.

Parameters
[in]interfacePointer to the desired network interface
[in]indexThis parameter selects between the primary and secondary DNS server
[in]addrDNS server address
Returns
Error code

Definition at line 304 of file ipv4.c.

◆ ipv4SetHostAddr()

error_t ipv4SetHostAddr ( NetInterface interface,
Ipv4Addr  addr 
)

Assign host address.

Parameters
[in]interfacePointer to the desired network interface
[in]addrIPv4 host address
Returns
Error code

Definition at line 113 of file ipv4.c.

◆ ipv4SetSubnetMask()

error_t ipv4SetSubnetMask ( NetInterface interface,
Ipv4Addr  mask 
)

Configure subnet mask.

Parameters
[in]interfacePointer to the desired network interface
[in]maskSubnet mask
Returns
Error code

Definition at line 199 of file ipv4.c.

◆ ipv4StringToAddr()

error_t ipv4StringToAddr ( const char_t str,
Ipv4Addr ipAddr 
)

Convert a dot-decimal string to a binary IPv4 address.

Parameters
[in]strNULL-terminated string representing the IPv4 address
[out]ipAddrBinary representation of the IPv4 address
Returns
Error code

Definition at line 1698 of file ipv4.c.

◆ ipv4UpdateInStats()

void ipv4UpdateInStats ( NetInterface interface,
Ipv4Addr  destIpAddr,
size_t  length 
)

Update IPv4 input statistics.

Parameters
[in]interfaceUnderlying network interface
[in]destIpAddrDestination IP address
[in]lengthLength of the incoming IP packet

Definition at line 1614 of file ipv4.c.

◆ ipv4UpdateOutStats()

void ipv4UpdateOutStats ( NetInterface interface,
Ipv4Addr  destIpAddr,
size_t  length 
)

Update IPv4 output statistics.

Parameters
[in]interfaceUnderlying network interface
[in]destIpAddrDestination IP address
[in]lengthLength of the outgoing IP packet

Definition at line 1649 of file ipv4.c.