NDP (Neighbor Discovery Protocol) More...

#include <limits.h>
#include "core/net.h"
#include "ipv6/ipv6.h"
#include "ipv6/ipv6_misc.h"
#include "ipv6/icmpv6.h"
#include "ipv6/ndp.h"
#include "ipv6/ndp_cache.h"
#include "ipv6/ndp_misc.h"
#include "ipv6/slaac.h"
#include "ipv6/slaac_misc.h"
#include "mibs/ip_mib_module.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NDP_TRACE_LEVEL

Functions
error_t	ndpInit (NetInterface *interface)
	Neighbor cache initialization. More...

error_t	ndpEnable (NetInterface *interface, bool_t enable)
	Enable address resolution using Neighbor Discovery protocol. More...

error_t	ndpAddStaticEntry (NetInterface interface, const Ipv6Addr ipAddr, const MacAddr *macAddr)
	Add a static entry in the Neighbor cache. More...

error_t	ndpRemoveStaticEntry (NetInterface interface, const Ipv6Addr ipAddr)
	Remove a static entry from the Neighbor cache. More...

error_t	ndpResolve (NetInterface interface, const Ipv6Addr ipAddr, MacAddr *macAddr)
	Address resolution using Neighbor Discovery protocol. More...

error_t	ndpEnqueuePacket (NetInterface srcInterface, NetInterface destInterface, const Ipv6Addr ipAddr, NetBuffer buffer, size_t offset, NetTxAncillary *ancillary)
	Enqueue an IPv6 packet waiting for address resolution. More...

void	ndpTick (NetInterface *interface)
	NDP timer handler. More...

void	ndpLinkChangeEvent (NetInterface *interface)
	Callback function for link change event. More...

void	ndpProcessRouterAdv (NetInterface interface, const Ipv6PseudoHeader pseudoHeader, const NetBuffer buffer, size_t offset, const NetRxAncillary ancillary)
	Router Advertisement message processing. More...

void	ndpProcessNeighborSol (NetInterface interface, const Ipv6PseudoHeader pseudoHeader, const NetBuffer buffer, size_t offset, const NetRxAncillary ancillary)
	Neighbor Solicitation message processing. More...

void	ndpProcessNeighborAdv (NetInterface interface, const Ipv6PseudoHeader pseudoHeader, const NetBuffer buffer, size_t offset, const NetRxAncillary ancillary)
	Neighbor Advertisement message processing. More...

void	ndpProcessRedirect (NetInterface interface, const Ipv6PseudoHeader pseudoHeader, const NetBuffer buffer, size_t offset, const NetRxAncillary ancillary)
	Redirect message processing. More...

error_t	ndpSendRouterSol (NetInterface *interface)
	Send a Router Solicitation message. More...

error_t	ndpSendNeighborSol (NetInterface interface, const Ipv6Addr targetIpAddr, bool_t multicast)
	Send a Neighbor Solicitation message. More...

error_t	ndpSendNeighborAdv (NetInterface interface, const Ipv6Addr targetIpAddr, const Ipv6Addr *destIpAddr)
	Send a Neighbor Advertisement message. More...

error_t	ndpSendRedirect (NetInterface interface, const Ipv6Addr targetAddr, const NetBuffer *ipPacket, size_t ipPacketOffset)
	Send a Redirect message. More...

void	ndpDumpRouterSolMessage (const NdpRouterSolMessage *message)
	Dump Router Solicitation message for debugging purpose. More...

void	ndpDumpRouterAdvMessage (const NdpRouterAdvMessage *message)
	Dump Router Advertisement message for debugging purpose. More...

void	ndpDumpNeighborSolMessage (const NdpNeighborSolMessage *message)
	Dump Neighbor Solicitation message for debugging purpose. More...

void	ndpDumpNeighborAdvMessage (const NdpNeighborAdvMessage *message)
	Dump Neighbor Advertisement message for debugging purpose. More...

void	ndpDumpRedirectMessage (const NdpRedirectMessage *message)
	Dump Redirect message for debugging purpose. More...

Variables
systime_t	ndpTickCounter

Detailed Description

NDP (Neighbor Discovery Protocol)

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.

Description

The Neighbor Discovery Protocol is responsible for address autoconfiguration of nodes, discovery of the link-layer addresses of other nodes, duplicate address detection, finding available routers and address prefix discovery. Refer to RFC 4861 for more details

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

Version: 2.4.4

Definition in file ndp.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NDP_TRACE_LEVEL

Definition at line 39 of file ndp.c.

Function Documentation

◆ ndpAddStaticEntry()

error_t ndpAddStaticEntry	(	NetInterface *	interface,
		const Ipv6Addr *	ipAddr,
		const MacAddr *	macAddr
	)

Add a static entry in the Neighbor cache.

Parameters

[in]	interface	Underlying network interface
[in]	ipAddr	IPv6 address
[in]	macAddr	MAC address

Returns: Error code

Definition at line 141 of file ndp.c.

◆ ndpDumpNeighborAdvMessage()

void ndpDumpNeighborAdvMessage ( const NdpNeighborAdvMessage * message )

Dump Neighbor Advertisement message for debugging purpose.

Parameters

[in] message Neighbor Advertisement message

Definition at line 2215 of file ndp.c.

◆ ndpDumpNeighborSolMessage()

void ndpDumpNeighborSolMessage ( const NdpNeighborSolMessage * message )

Dump Neighbor Solicitation message for debugging purpose.

Parameters

[in] message Neighbor Solicitation message

Definition at line 2200 of file ndp.c.

◆ ndpDumpRedirectMessage()

void ndpDumpRedirectMessage ( const NdpRedirectMessage * message )

Dump Redirect message for debugging purpose.

Parameters

[in] message Redirect message

Definition at line 2233 of file ndp.c.

◆ ndpDumpRouterAdvMessage()

void ndpDumpRouterAdvMessage ( const NdpRouterAdvMessage * message )

Dump Router Advertisement message for debugging purpose.

Parameters

[in] message Router Advertisement message

Definition at line 2180 of file ndp.c.

◆ ndpDumpRouterSolMessage()

void ndpDumpRouterSolMessage ( const NdpRouterSolMessage * message )

Dump Router Solicitation message for debugging purpose.

Parameters

[in] message Router Solicitation message

Definition at line 2166 of file ndp.c.

◆ ndpEnable()

error_t ndpEnable	(	NetInterface *	interface,
		bool_t	enable
	)

Enable address resolution using Neighbor Discovery protocol.

Parameters

[in]	interface	Underlying network interface
[in]	enable	This flag specifies whether the host is allowed to send Neighbor solicitations and respond to incoming Neighbor solicitations. When the flag is set to FALSE, the host relies exclusively on static Neighbor cache entries to map IPv6 addresses into MAC addresses and silently drop incoming Neighbor solicitations

Returns: Error code

Definition at line 106 of file ndp.c.

◆ ndpEnqueuePacket()

error_t ndpEnqueuePacket	(	NetInterface *	srcInterface,
		NetInterface *	destInterface,
		const Ipv6Addr *	ipAddr,
		NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Enqueue an IPv6 packet waiting for address resolution.

Parameters

[in]	srcInterface	Interface from which the packet has been received
[in]	destInterface	Interface on which the packet should be sent
[in]	ipAddr	IPv6 address of the destination host
[in]	buffer	Multi-part buffer containing the packet to be enqueued
[in]	offset	Offset to the first byte of the packet
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 360 of file ndp.c.

◆ ndpInit()

error_t ndpInit ( NetInterface * interface )

Neighbor cache initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 68 of file ndp.c.

◆ ndpLinkChangeEvent()

void ndpLinkChangeEvent ( NetInterface * interface )

Callback function for link change event.

Parameters

[in] interface Underlying network interface

Definition at line 541 of file ndp.c.

◆ ndpProcessNeighborAdv()

void ndpProcessNeighborAdv	(	NetInterface *	interface,
		const Ipv6PseudoHeader *	pseudoHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		const NetRxAncillary *	ancillary
	)

Neighbor Advertisement message processing.

Parameters

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

Definition at line 1115 of file ndp.c.

◆ ndpProcessNeighborSol()

void ndpProcessNeighborSol	(	NetInterface *	interface,
		const Ipv6PseudoHeader *	pseudoHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		const NetRxAncillary *	ancillary
	)

Neighbor Solicitation message processing.

Parameters

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

Definition at line 869 of file ndp.c.

◆ ndpProcessRedirect()

void ndpProcessRedirect	(	NetInterface *	interface,
		const Ipv6PseudoHeader *	pseudoHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		const NetRxAncillary *	ancillary
	)

Redirect message processing.

Parameters

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

Definition at line 1363 of file ndp.c.

◆ ndpProcessRouterAdv()

void ndpProcessRouterAdv	(	NetInterface *	interface,
		const Ipv6PseudoHeader *	pseudoHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		const NetRxAncillary *	ancillary
	)

Router Advertisement message processing.

Parameters

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

Definition at line 579 of file ndp.c.

◆ ndpRemoveStaticEntry()

error_t ndpRemoveStaticEntry	(	NetInterface *	interface,
		const Ipv6Addr *	ipAddr
	)

Remove a static entry from the Neighbor cache.

Parameters

[in]	interface	Underlying network interface
[in]	ipAddr	IPv6 address

Returns: Error code

Definition at line 215 of file ndp.c.

◆ ndpResolve()

error_t ndpResolve	(	NetInterface *	interface,
		const Ipv6Addr *	ipAddr,
		MacAddr *	macAddr
	)

Address resolution using Neighbor Discovery protocol.

Parameters

[in]	interface	Underlying network interface
[in]	ipAddr	IPv6 address
[in]	macAddr	Physical address matching the specified IPv6 address

Returns: Error code

Definition at line 260 of file ndp.c.

◆ ndpSendNeighborAdv()

error_t ndpSendNeighborAdv	(	NetInterface *	interface,
		const Ipv6Addr *	targetIpAddr,
		const Ipv6Addr *	destIpAddr
	)

Send a Neighbor Advertisement message.

Parameters

[in]	interface	Underlying network interface
[in]	targetIpAddr	Target IPv6 address
[in]	destIpAddr	Destination IPv6 address

Returns: Error code

Definition at line 1826 of file ndp.c.

◆ ndpSendNeighborSol()

error_t ndpSendNeighborSol	(	NetInterface *	interface,
		const Ipv6Addr *	targetIpAddr,
		bool_t	multicast
	)

Send a Neighbor Solicitation message.

Parameters

[in]	interface	Underlying network interface
[in]	targetIpAddr	Target IPv6 address
[in]	multicast	Unicast or unicast Neighbor Solicitation message

Returns: Error code

Definition at line 1693 of file ndp.c.

◆ ndpSendRedirect()

error_t ndpSendRedirect	(	NetInterface *	interface,
		const Ipv6Addr *	targetAddr,
		const NetBuffer *	ipPacket,
		size_t	ipPacketOffset
	)

Send a Redirect message.

Parameters

[in]	interface	Underlying network interface
[in]	targetAddr	IPv6 address that is a better first hop to use for the destination address
[in]	ipPacket	Multi-part buffer that holds the IPv6 packet that triggered the sending of the Redirect
[in]	ipPacketOffset	Offset to the first byte of the IPv6 packet

Returns: Error code

Definition at line 1995 of file ndp.c.

◆ ndpSendRouterSol()

error_t ndpSendRouterSol ( NetInterface * interface )

Send a Router Solicitation message.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 1573 of file ndp.c.

◆ ndpTick()

void ndpTick ( NetInterface * interface )

NDP timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 450 of file ndp.c.

Variable Documentation

◆ ndpTickCounter

systime_t ndpTickCounter

Definition at line 59 of file ndp.c.

Macros

Functions

Variables

Detailed Description

License

Description

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ndpAddStaticEntry()

◆ ndpDumpNeighborAdvMessage()

◆ ndpDumpNeighborSolMessage()

◆ ndpDumpRedirectMessage()

◆ ndpDumpRouterAdvMessage()

◆ ndpDumpRouterSolMessage()

◆ ndpEnable()

◆ ndpEnqueuePacket()

◆ ndpInit()

◆ ndpLinkChangeEvent()

◆ ndpProcessNeighborAdv()

◆ ndpProcessNeighborSol()

◆ ndpProcessRedirect()

◆ ndpProcessRouterAdv()

◆ ndpRemoveStaticEntry()

◆ ndpResolve()

◆ ndpSendNeighborAdv()

◆ ndpSendNeighborSol()

◆ ndpSendRedirect()

◆ ndpSendRouterSol()

◆ ndpTick()

Variable Documentation

◆ ndpTickCounter