IPv4 and IPv6 common routines. More...

#include "ipv4/ipv4.h"
#include "ipv6/ipv6.h"

Data Structures
struct	IpAddr
	IP network address. More...

struct	IpPseudoHeader
	IP pseudo header. More...

Enumerations
enum	IpProtocol { IP_PROTOCOL_TCP = 6 , IP_PROTOCOL_UDP = 17 }
	IP supported protocols. More...

enum	IpFlags { IP_FLAG_DONT_ROUTE = 0x0400 , IP_FLAG_TTL = 0x00FF , IP_FLAG_HOP_LIMIT = 0x00FF }
	Flags used by I/O functions. More...

Functions
error_t	ipSendDatagram (NetInterface interface, const IpPseudoHeader pseudoHeader, NetBuffer buffer, size_t offset, NetTxAncillary ancillary)
	Send an IP datagram. More...

error_t	ipSelectSourceAddr (NetInterface *interface, const IpAddr destAddr, IpAddr *srcAddr)
	IP source address selection. More...

bool_t	ipIsUnspecifiedAddr (const IpAddr *ipAddr)
	Compare an IP address against the unspecified address. More...

bool_t	ipIsLinkLocalAddr (const IpAddr *ipAddr)
	Determine whether an IP address is a link-local address. More...

bool_t	ipIsMulticastAddr (const IpAddr *ipAddr)
	Determine whether an IP address is a multicast address. More...

bool_t	ipIsBroadcastAddr (const IpAddr *ipAddr)
	Determine whether an IP address is a broadcast address. More...

bool_t	ipCompAddr (const IpAddr ipAddr1, const IpAddr ipAddr2)
	Compare IP addresses. More...

bool_t	ipCompPrefix (const IpAddr ipAddr1, const IpAddr ipAddr2, size_t length)
	Compare IP address prefixes. More...

error_t	ipJoinMulticastGroup (NetInterface interface, const IpAddr groupAddr)
	Join the specified host group. More...

error_t	ipLeaveMulticastGroup (NetInterface interface, const IpAddr groupAddr)
	Leave the specified host group. More...

uint16_t	ipCalcChecksum (const void *data, size_t length)
	IP checksum calculation. More...

uint16_t	ipCalcChecksumEx (const NetBuffer *buffer, size_t offset, size_t length)
	Calculate IP checksum over a multi-part buffer. More...

uint16_t	ipCalcUpperLayerChecksum (const void pseudoHeader, size_t pseudoHeaderLen, const void data, size_t dataLen)
	Calculate IP upper-layer checksum. More...

uint16_t	ipCalcUpperLayerChecksumEx (const void pseudoHeader, size_t pseudoHeaderLen, const NetBuffer buffer, size_t offset, size_t length)
	Calculate IP upper-layer checksum over a multi-part buffer. More...

NetBuffer *	ipAllocBuffer (size_t length, size_t *offset)
	Allocate a buffer to hold an IP packet. More...

error_t	ipStringToAddr (const char_t str, IpAddr ipAddr)
	Convert a string representation of an IP address to a binary IP address. More...

char_t *	ipAddrToString (const IpAddr ipAddr, char_t str)
	Convert a binary IP address to a string representation. More...

Variables
const IpAddr	IP_ADDR_ANY

const IpAddr	IP_ADDR_UNSPECIFIED

Detailed Description

IPv4 and IPv6 common routines.

License

SPDX-License-Identifier: GPL-2.0-or-later

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.

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

Version: 2.3.2

Definition in file ip.h.

Enumeration Type Documentation

◆ IpFlags

enum IpFlags

Flags used by I/O functions.

Enumerator
IP_FLAG_DONT_ROUTE
IP_FLAG_TTL
IP_FLAG_HOP_LIMIT

Definition at line 59 of file ip.h.

◆ IpProtocol

enum IpProtocol

IP supported protocols.

Enumerator
IP_PROTOCOL_TCP
IP_PROTOCOL_UDP

Definition at line 48 of file ip.h.

Function Documentation

◆ ipAddrToString()

char_t* ipAddrToString	(	const IpAddr *	ipAddr,
		char_t *	str
	)

Convert a binary IP address to a string representation.

Parameters

[in]	ipAddr	Binary representation of the IP address
[out]	str	NULL-terminated string representing the IP address

Returns: Pointer to the formatted string

Definition at line 838 of file ip.c.

◆ ipAllocBuffer()

NetBuffer* ipAllocBuffer	(	size_t	length,
		size_t *	offset
	)

Allocate a buffer to hold an IP packet.

Parameters

[in]	length	Desired payload length
[out]	offset	Offset to the first byte of the payload

Returns: The function returns a pointer to the newly allocated buffer. If the system is out of resources, NULL is returned

Definition at line 744 of file ip.c.

◆ ipCalcChecksum()

uint16_t ipCalcChecksum	(	const void *	data,
		size_t	length
	)

IP checksum calculation.

Parameters

[in]	data	Pointer to the data over which to calculate the IP checksum
[in]	length	Number of bytes to process

Returns: Checksum value

Definition at line 499 of file ip.c.

◆ ipCalcChecksumEx()

uint16_t ipCalcChecksumEx	(	const NetBuffer *	buffer,
		size_t	offset,
		size_t	length
	)

Calculate IP checksum over a multi-part buffer.

Parameters

[in]	buffer	Pointer to the multi-part buffer
[in]	offset	Offset from the beginning of the buffer
[in]	length	Number of bytes to process

Returns: Checksum value

Definition at line 619 of file ip.c.

◆ ipCalcUpperLayerChecksum()

uint16_t ipCalcUpperLayerChecksum	(	const void *	pseudoHeader,
		size_t	pseudoHeaderLen,
		const void *	data,
		size_t	dataLen
	)

Calculate IP upper-layer checksum.

Parameters

[in]	pseudoHeader	Pointer to the pseudo header
[in]	pseudoHeaderLen	Pseudo header length
[in]	data	Pointer to the upper-layer data
[in]	dataLen	Upper-layer data length

Returns: Checksum value

Definition at line 692 of file ip.c.

◆ ipCalcUpperLayerChecksumEx()

uint16_t ipCalcUpperLayerChecksumEx	(	const void *	pseudoHeader,
		size_t	pseudoHeaderLen,
		const NetBuffer *	buffer,
		size_t	offset,
		size_t	length
	)

Calculate IP upper-layer checksum over a multi-part buffer.

Parameters

[in]	pseudoHeader	Pointer to the pseudo header
[in]	pseudoHeaderLen	Pseudo header length
[in]	buffer	Multi-part buffer containing the upper-layer data
[in]	offset	Offset from the first data byte to process
[in]	length	Number of data bytes to process

Returns: Checksum value

Definition at line 719 of file ip.c.

◆ ipCompAddr()

bool_t ipCompAddr	(	const IpAddr *	ipAddr1,
		const IpAddr *	ipAddr2
	)

Compare IP addresses.

Parameters

[in]	ipAddr1	First IP address
[in]	ipAddr2	Second IP address

Returns: Comparison result

Definition at line 315 of file ip.c.

◆ ipCompPrefix()

bool_t ipCompPrefix	(	const IpAddr *	ipAddr1,
		const IpAddr *	ipAddr2,
		size_t	length
	)

Compare IP address prefixes.

Parameters

[in]	ipAddr1	First IP address
[in]	ipAddr2	Second IP address
[in]	length	Prefix length

Returns: TRUE if the prefixes match each other, else FALSE

Definition at line 368 of file ip.c.

◆ ipIsBroadcastAddr()

bool_t ipIsBroadcastAddr ( const IpAddr * ipAddr )

Determine whether an IP address is a broadcast address.

Parameters

[in] ipAddr IP address

Returns: TRUE if the IP address is a broadcast address, else FALSE

Definition at line 286 of file ip.c.

◆ ipIsLinkLocalAddr()

bool_t ipIsLinkLocalAddr ( const IpAddr * ipAddr )

Determine whether an IP address is a link-local address.

Parameters

[in] ipAddr IP address

Returns: TRUE if the IP address is a link-local address, else FALSE

Definition at line 210 of file ip.c.

◆ ipIsMulticastAddr()

bool_t ipIsMulticastAddr ( const IpAddr * ipAddr )

Determine whether an IP address is a multicast address.

Parameters

[in] ipAddr IP address

Returns: TRUE if the IP address is a multicast address, else FALSE

Definition at line 248 of file ip.c.

◆ ipIsUnspecifiedAddr()

bool_t ipIsUnspecifiedAddr ( const IpAddr * ipAddr )

Compare an IP address against the unspecified address.

Parameters

[in] ipAddr IP address

Returns: TRUE if the IP address is unspecified, else FALSE

Definition at line 165 of file ip.c.

◆ ipJoinMulticastGroup()

error_t ipJoinMulticastGroup	(	NetInterface *	interface,
		const IpAddr *	groupAddr
	)

Join the specified host group.

Parameters

[in]	interface	Underlying network interface (optional parameter)
[in]	groupAddr	IP address identifying the host group to join

Returns: Error code

Definition at line 408 of file ip.c.

◆ ipLeaveMulticastGroup()

error_t ipLeaveMulticastGroup	(	NetInterface *	interface,
		const IpAddr *	groupAddr
	)

Leave the specified host group.

Parameters

[in]	interface	Underlying network interface (optional parameter)
[in]	groupAddr	IP address identifying the host group to leave

Returns: Error code

Definition at line 454 of file ip.c.

◆ ipSelectSourceAddr()

error_t ipSelectSourceAddr	(	NetInterface **	interface,
		const IpAddr *	destAddr,
		IpAddr *	srcAddr
	)

IP 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]	interface	A pointer to a valid network interface may be provided as a hint. The function returns a pointer identifying the interface to be used
[in]	destAddr	Destination IP address
[out]	srcAddr	Local IP address to be used

Returns: Error code

Definition at line 117 of file ip.c.

◆ ipSendDatagram()

error_t ipSendDatagram	(	NetInterface *	interface,
		const IpPseudoHeader *	pseudoHeader,
		NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Send an IP datagram.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	IP pseudo header
[in]	buffer	Multi-part buffer containing the payload
[in]	offset	Offset to the first payload byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 66 of file ip.c.

◆ ipStringToAddr()

error_t ipStringToAddr	(	const char_t *	str,
		IpAddr *	ipAddr
	)

Convert a string representation of an IP address to a binary IP address.

Parameters

[in]	str	NULL-terminated string representing the IP address
[out]	ipAddr	Binary representation of the IP address

Returns: Error code

Definition at line 794 of file ip.c.

Variable Documentation

◆ IP_ADDR_ANY

const IpAddr IP_ADDR_ANY

extern

Definition at line 51 of file ip.c.

◆ IP_ADDR_UNSPECIFIED

const IpAddr IP_ADDR_UNSPECIFIED

extern

Definition at line 52 of file ip.c.

Data Structures

Enumerations

Functions

Variables

Detailed Description

License

Enumeration Type Documentation

◆ IpFlags

◆ IpProtocol

Function Documentation

◆ ipAddrToString()

◆ ipAllocBuffer()

◆ ipCalcChecksum()

◆ ipCalcChecksumEx()

◆ ipCalcUpperLayerChecksum()

◆ ipCalcUpperLayerChecksumEx()

◆ ipCompAddr()

◆ ipCompPrefix()

◆ ipIsBroadcastAddr()

◆ ipIsLinkLocalAddr()

◆ ipIsMulticastAddr()

◆ ipIsUnspecifiedAddr()

◆ ipJoinMulticastGroup()

◆ ipLeaveMulticastGroup()

◆ ipSelectSourceAddr()

◆ ipSendDatagram()

◆ ipStringToAddr()

Variable Documentation

◆ IP_ADDR_ANY

◆ IP_ADDR_UNSPECIFIED