ipv6_frag.h File Reference

IPv6 fragmentation and reassembly. More...

#include "core/net.h"
#include "ipv6/ipv6.h"

Go to the source code of this file.

Data Structures
struct	Ipv6ReassemblyBuffer
	Reassembly buffer. More...
struct	Ipv6FragDesc
	Fragmented packet descriptor. More...

Macros
#define	IPV6_FRAG_SUPPORT   ENABLED
#define	IPV6_OVERLAPPING_FRAG_SUPPORT   DISABLED
#define	IPV6_FRAG_TICK_INTERVAL   1000
#define	IPV6_MAX_FRAG_DATAGRAMS   4
#define	IPV6_MAX_FRAG_DATAGRAM_SIZE   8192
#define	IPV6_FRAG_TIME_TO_LIVE   15000
#define	IPV6_INFINITY   0xFFFF

Functions
error_t	ipv6FragmentDatagram (NetInterface *interface, const Ipv6PseudoHeader *pseudoHeader, const NetBuffer *payload, size_t payloadOffset, size_t pathMtu, NetTxAncillary *ancillary)
	Fragment IPv6 datagram into smaller packets. More...
void	ipv6ParseFragmentHeader (NetInterface *interface, const NetBuffer *ipPacket, size_t ipPacketOffset, size_t fragHeaderOffset, size_t nextHeaderOffset, NetRxAncillary *ancillary)
	Parse Fragment header and reassemble original datagram. More...
void	ipv6FragTick (NetInterface *interface)
	Fragment reassembly timeout handler. More...
Ipv6FragDesc *	ipv6SearchFragQueue (NetInterface *interface, const Ipv6Header *packet, const Ipv6FragmentHeader *header)
	Search for a matching datagram in the reassembly queue. More...
void	ipv6FlushFragQueue (NetInterface *interface)
	Flush IPv6 reassembly queue. More...
Ipv6HoleDesc *	ipv6FindHole (Ipv6FragDesc *frag, uint16_t offset)
	Retrieve hole descriptor. More...
void	ipv6DumpHoleList (Ipv6FragDesc *frag)
	Dump hole descriptor list. More...

Variables
typedef	__packed_struct
	Hole descriptor. More...
uint16_t	last
uint16_t	next
	Ipv6HoleDesc
systime_t	ipv6FragTickCounter

Detailed Description

IPv6 fragmentation and reassembly.

License

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

Copyright (C) 2010-2024 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.

Author

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

Version

2.4.4

Definition in file ipv6_frag.h.

Macro Definition Documentation

IPV6_FRAG_SUPPORT

#define IPV6_FRAG_SUPPORT   ENABLED

Definition at line 40 of file ipv6_frag.h.

IPV6_FRAG_TICK_INTERVAL

#define IPV6_FRAG_TICK_INTERVAL   1000

Definition at line 54 of file ipv6_frag.h.

IPV6_FRAG_TIME_TO_LIVE

#define IPV6_FRAG_TIME_TO_LIVE   15000

Definition at line 76 of file ipv6_frag.h.

IPV6_INFINITY

#define IPV6_INFINITY   0xFFFF

Definition at line 82 of file ipv6_frag.h.

IPV6_MAX_FRAG_DATAGRAM_SIZE

#define IPV6_MAX_FRAG_DATAGRAM_SIZE   8192

Definition at line 69 of file ipv6_frag.h.

IPV6_MAX_FRAG_DATAGRAMS

#define IPV6_MAX_FRAG_DATAGRAMS   4

Definition at line 62 of file ipv6_frag.h.

IPV6_OVERLAPPING_FRAG_SUPPORT

#define IPV6_OVERLAPPING_FRAG_SUPPORT   DISABLED

Definition at line 47 of file ipv6_frag.h.

Function Documentation

ipv6DumpHoleList()

void ipv6DumpHoleList

(

Ipv6FragDesc *

frag

)

Dump hole descriptor list.

Parameters

[in]

frag

IPv6 fragment descriptor

Definition at line 756 of file ipv6_frag.c.

ipv6FindHole()

Ipv6HoleDesc* ipv6FindHole	(	Ipv6FragDesc *	frag,
		uint16_t	offset
	)

Retrieve hole descriptor.

Parameters

[in]	frag	IPv6 fragment descriptor
[in]	offset	Offset of the hole

Returns

A pointer to the hole descriptor is returned if the specified offset is valid. Otherwise NULL is returned

Definition at line 744 of file ipv6_frag.c.

ipv6FlushFragQueue()

void ipv6FlushFragQueue

(

NetInterface *

interface

)

Flush IPv6 reassembly queue.

Parameters

[in]

interface

Underlying network interface

Definition at line 723 of file ipv6_frag.c.

ipv6FragmentDatagram()

error_t ipv6FragmentDatagram	(	NetInterface *	interface,
		const Ipv6PseudoHeader *	pseudoHeader,
		const NetBuffer *	payload,
		size_t	payloadOffset,
		size_t	pathMtu,
		NetTxAncillary *	ancillary
	)

Fragment IPv6 datagram into smaller packets.

Parameters

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

Returns

Error code

Definition at line 62 of file ipv6_frag.c.

ipv6FragTick()

void ipv6FragTick

(

NetInterface *

interface

)

Fragment reassembly timeout handler.

This routine must be periodically called by the TCP/IP stack to handle IPv6 fragment reassembly timeout

Parameters

[in]

interface

Underlying network interface

Definition at line 550 of file ipv6_frag.c.

ipv6ParseFragmentHeader()

void ipv6ParseFragmentHeader	(	NetInterface *	interface,
		const NetBuffer *	ipPacket,
		size_t	ipPacketOffset,
		size_t	fragHeaderOffset,
		size_t	nextHeaderOffset,
		NetRxAncillary *	ancillary
	)

Parse Fragment header and reassemble original datagram.

Parameters

[in]	interface	Underlying network interface
[in]	ipPacket	Multi-part buffer containing the incoming IPv6 packet
[in]	ipPacketOffset	Offset to the first byte of the IPv6 packet
[in]	fragHeaderOffset	Offset to the Fragment header
[in]	nextHeaderOffset	Offset to the Next Header field of the previous header
[in]	ancillary	Additional options passed to the stack along with the packet

Definition at line 179 of file ipv6_frag.c.

ipv6SearchFragQueue()

Ipv6FragDesc* ipv6SearchFragQueue	(	NetInterface *	interface,
		const Ipv6Header *	packet,
		const Ipv6FragmentHeader *	header
	)

Search for a matching datagram in the reassembly queue.

Parameters

[in]	interface	Underlying network interface
[in]	packet	Incoming IPv6 packet
[in]	header	Pointer to the Fragment header

Returns

Matching fragment descriptor

Definition at line 619 of file ipv6_frag.c.

Variable Documentation

__packed_struct

typedef __packed_struct

Initial value:

{
   uint16_t first

Hole descriptor.

Definition at line 102 of file ipv6_frag.h.

ipv6FragTickCounter

systime_t ipv6FragTickCounter

extern

Definition at line 47 of file ipv6_frag.c.

Ipv6HoleDesc

Ipv6HoleDesc

Definition at line 107 of file ipv6_frag.h.

last

uint16_t last

Definition at line 105 of file ipv6_frag.h.

next

uint16_t next

Definition at line 106 of file ipv6_frag.h.