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...


#define IPV6_FRAG_TICK_INTERVAL   1000
#define IPV6_FRAG_TIME_TO_LIVE   15000
#define IPV6_INFINITY   0xFFFF


struct {
   uint16_t   first
   uint16_t   last
   uint16_t   next
 Hole descriptor. More...


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


systime_t ipv6FragTickCounter

Detailed Description

IPv6 fragmentation and reassembly.


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

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

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

Definition in file ipv6_frag.h.

Macro Definition Documentation



Definition at line 40 of file ipv6_frag.h.


#define IPV6_FRAG_TICK_INTERVAL   1000

Definition at line 54 of file ipv6_frag.h.


#define IPV6_FRAG_TIME_TO_LIVE   15000

Definition at line 76 of file ipv6_frag.h.


#define IPV6_INFINITY   0xFFFF

Definition at line 82 of file ipv6_frag.h.



Definition at line 69 of file ipv6_frag.h.



Definition at line 62 of file ipv6_frag.h.



Definition at line 47 of file ipv6_frag.h.

Typedef Documentation

◆ Ipv6HoleDesc

typedef { ... } Ipv6HoleDesc

Hole descriptor.

Function Documentation

◆ ipv6DumpHoleList()

void ipv6DumpHoleList ( Ipv6FragDesc frag)

Dump hole descriptor list.

[in]fragIPv6 fragment descriptor

Definition at line 731 of file ipv6_frag.c.

◆ ipv6FindHole()

Ipv6HoleDesc* ipv6FindHole ( Ipv6FragDesc frag,
uint16_t  offset 

Retrieve hole descriptor.

[in]fragIPv6 fragment descriptor
[in]offsetOffset of the hole
A pointer to the hole descriptor is returned if the specified offset is valid. Otherwise NULL is returned

Definition at line 719 of file ipv6_frag.c.

◆ ipv6FlushFragQueue()

void ipv6FlushFragQueue ( NetInterface interface)

Flush IPv6 reassembly queue.

[in]interfaceUnderlying network interface

Definition at line 698 of file ipv6_frag.c.

◆ ipv6FragmentDatagram()

error_t ipv6FragmentDatagram ( NetInterface interface,
Ipv6PseudoHeader pseudoHeader,
const NetBuffer payload,
size_t  payloadOffset,
size_t  pathMtu,
uint_t  flags 

Fragment IPv6 datagram into smaller packets.

[in]interfaceUnderlying network interface
[in]pseudoHeaderIPv6 pseudo header
[in]payloadMulti-part buffer containing the payload
[in]payloadOffsetOffset to the first payload byte
[in]pathMtuPMTU value
[in]flagsSet of flags that influences the behavior of this function
Error code

Definition at line 61 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

[in]interfaceUnderlying network interface

Definition at line 527 of file ipv6_frag.c.

◆ ipv6ParseFragmentHeader()

void ipv6ParseFragmentHeader ( NetInterface interface,
const NetBuffer ipPacket,
size_t  ipPacketOffset,
size_t  fragHeaderOffset,
size_t  nextHeaderOffset 

Parse Fragment header and reassemble original datagram.

[in]interfaceUnderlying network interface
[in]ipPacketMulti-part buffer containing the incoming IPv6 packet
[in]ipPacketOffsetOffset to the first byte of the IPv6 packet
[in]fragHeaderOffsetOffset to the Fragment header
[in]nextHeaderOffsetOffset to the Next Header field of the previous header

Definition at line 175 of file ipv6_frag.c.

◆ ipv6SearchFragQueue()

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

Search for a matching datagram in the reassembly queue.

[in]interfaceUnderlying network interface
[in]packetIncoming IPv6 packet
[in]headerPointer to the Fragment header
Matching fragment descriptor

Definition at line 595 of file ipv6_frag.c.

Variable Documentation

◆ first

uint16_t first

Definition at line 102 of file ipv6_frag.h.

◆ ipv6FragTickCounter

systime_t ipv6FragTickCounter

Definition at line 47 of file ipv6_frag.c.

◆ last

uint16_t last

Definition at line 103 of file ipv6_frag.h.

◆ next

uint16_t next

Definition at line 104 of file ipv6_frag.h.