RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity
ca37cde142
RIOT/sys/include/net/gnrc/sixlowpan/frag.h

101 lines
3.1 KiB
C
Raw Normal View History

ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
/*
* Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
gnrc_sixlowpan_frag: msg based fragmentation
2015-12-02 10:57:22 +01:00
* Copyright (C) 2015 Hamburg University of Applied Sciences
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
gnrc: make all gnrc modules sub-modules of gnrc
2015-08-17 15:41:29 +02:00
* @defgroup net_gnrc_sixlowpan_frag 6LoWPAN Fragmentation
* @ingroup net_gnrc_sixlowpan
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
* @brief 6LoWPAN Fragmentation headers and functionality
* @see <a href="https://tools.ietf.org/html/rfc4944#section-5.3">
* RFC 4944, section 5.3
* </a>
* @{
*
* @file
* @brief 6LoWPAN Fragmentation definitions
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
gnrc_sixlowpan_frag: msg based fragmentation
2015-12-02 10:57:22 +01:00
* @author Peter Kietzmann <peter.kietzmann@haw-hamburg.de>
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
*/
cleanup: apply headerguard script output
2017-05-23 18:19:52 +02:00
#ifndef NET_GNRC_SIXLOWPAN_FRAG_H
#define NET_GNRC_SIXLOWPAN_FRAG_H
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
#include <inttypes.h>
#include "byteorder.h"
gnrc: make all gnrc modules sub-modules of gnrc
2015-08-17 15:41:29 +02:00
#include "net/gnrc/pkt.h"
gnrc_sixlowpan_frag: Expose functions to finish datagram This will be used in the IPHC refactoring to control the reassembly buffer as a context. I also adapted the name of `gnrc_sixlowpan_frag_gc_rbuf()` to be in line with the rest of the newer functions.
2018-06-28 23:10:48 +02:00
#include "net/gnrc/netif/hdr.h"
gnrc_sixlowpan_frag: Initial import of a fragment size hint feature This allows for sending of fragments smaller than the restrictions set by the link-layer PDU. E.g. to put some slack for IPHC into the first fragment (see https://tools.ietf.org/html/draft-ietf-6lo-fragment-recovery-02#section-4.1).
2019-02-25 16:41:27 +01:00
#ifdef MODULE_GNRC_SIXLOWPAN_FRAG_HINT
#include "net/gnrc/sixlowpan/frag/hint.h"
#endif /* MODULE_GNRC_SIXLOWPAN_FRAG_HINT */
gnrc_sixlowpan_frag: factor-out and rename fragmentation buffer The name `fragment_msg` or `frag_msg`/`msg_frag` always to me was a bit misplaced, as it basically implements an asynchronous fragmentation buffer and doesn't necessarily have anything to do with messages. This change 1. changes the name to `fb` (for fragmentation buffer) 2. factors its code out to its own sub-module so it can be re-used by other 6LoWPAN fragmentation schemes like [Selective Fragment Recovery] [Selective Fragment Recovery]: https://tools.ietf.org/html/draft-ietf-6lo-fragment-recovery-05
2019-10-17 16:56:38 +02:00
#include "net/gnrc/sixlowpan/frag/fb.h"
gnrc_sixlowpan_frag: encapsulate msg_send_to_self() This makes it easier to access this functionality for test cases e.g. from the `main` thread.
2019-02-25 17:08:30 +01:00
#include "net/gnrc/sixlowpan/internal.h"
gnrc_sixlowpan_frag: expose (parts of) reassembly buffer This exposes the parts of the reassembly buffer to be usable as context as proposed in #8511. I only exposed *parts of* for two reasons: 1. I don't need to expose further types (like `rbuf_int_t`), that are not of interest outside of fragmentation. 2. This allows for an easy future extension for the virtual reassembly buffer as proposed in [[1]]. This makes this change a little bit more involved, because instead of just renaming the type, I also need to add the usage of the `super` member, but I think in the end this little preparation work will be beneficial in the future. [1]: https://tools.ietf.org/html/draft-watteyne-6lo-minimal-fragment-01#section-3
2018-06-14 17:13:51 +02:00
#include "net/ieee802154.h"
sixlowpan: move non-GNRC stuff to its own module
2015-08-17 15:06:44 +02:00
#include "net/sixlowpan.h"
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
#ifdef __cplusplus
extern "C" {
#endif
gnrc_sixlowpan_frag_stats: initial import of frag statistics
2019-04-09 12:53:44 +02:00
#if defined(MODULE_GNRC_SIXLOWPAN_FRAG_STATS) || DOXYGEN
/**
* @brief Statistics on fragmentation and reassembly
*
* @note Only available with the `gnrc_sixlowpan_frag_stats` module
*/
typedef struct {
unsigned rbuf_full; /**< counts the number of events where the
* reassembly buffer is full */
unsigned frag_full; /**< counts the number of events that there where
gnrc_sixlowpan_frag: factor-out and rename fragmentation buffer The name `fragment_msg` or `frag_msg`/`msg_frag` always to me was a bit misplaced, as it basically implements an asynchronous fragmentation buffer and doesn't necessarily have anything to do with messages. This change 1. changes the name to `fb` (for fragmentation buffer) 2. factors its code out to its own sub-module so it can be re-used by other 6LoWPAN fragmentation schemes like [Selective Fragment Recovery] [Selective Fragment Recovery]: https://tools.ietf.org/html/draft-ietf-6lo-fragment-recovery-05
2019-10-17 16:56:38 +02:00
* no @ref gnrc_sixlowpan_frag_fb_t available */
gnrc_sixlowpan_frag_stats: initial import of frag statistics
2019-04-09 12:53:44 +02:00
#if defined(MODULE_GNRC_SIXLOWPAN_FRAG_VRB) || DOXYGEN
unsigned vrb_full; /**< counts the number of events where the virtual
* reassembly buffer is full */
#endif
} gnrc_sixlowpan_frag_stats_t;
/**
* @brief Get the current statistics on fragmentation and reassembly
*
* @return The current statistics on fragmentation and reassembly
*/
gnrc_sixlowpan_frag_stats_t *gnrc_sixlowpan_frag_stats_get(void);
#endif
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
/**
gnrc_sixlowpan_frag: adapt for #8511 This refactors the `gnrc_sixlowpan_frag` module for the API proposed in #8511. The `ctx` for `gnrc_sixlowpan_frag_send()` is required to be a `gnrc_sixlowpan_msg_frag_t` object, so IPHC can later on use it to provide the *original* datagram size (otherwise, we would need to adapt the API just for that, which seems to me as convoluted as this proposal). I also provide an expose function with a future possibility to provide more than just one `gnrc_sixlowpan_msg_frag_t` object later on (plus having cleaner module separation in general).
2018-06-19 14:59:49 +02:00
* @brief Sends a packet fragmented
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
*
gnrc_sixlowpan_frag: adapt for #8511 This refactors the `gnrc_sixlowpan_frag` module for the API proposed in #8511. The `ctx` for `gnrc_sixlowpan_frag_send()` is required to be a `gnrc_sixlowpan_msg_frag_t` object, so IPHC can later on use it to provide the *original* datagram size (otherwise, we would need to adapt the API just for that, which seems to me as convoluted as this proposal). I also provide an expose function with a future possibility to provide more than just one `gnrc_sixlowpan_msg_frag_t` object later on (plus having cleaner module separation in general).
2018-06-19 14:59:49 +02:00
* @pre `ctx != NULL`
gnrc_sixlowpan_frag: factor-out and rename fragmentation buffer The name `fragment_msg` or `frag_msg`/`msg_frag` always to me was a bit misplaced, as it basically implements an asynchronous fragmentation buffer and doesn't necessarily have anything to do with messages. This change 1. changes the name to `fb` (for fragmentation buffer) 2. factors its code out to its own sub-module so it can be re-used by other 6LoWPAN fragmentation schemes like [Selective Fragment Recovery] [Selective Fragment Recovery]: https://tools.ietf.org/html/draft-ietf-6lo-fragment-recovery-05
2019-10-17 16:56:38 +02:00
* @pre gnrc_sixlowpan_frag_fb_t::pkt of @p ctx is equal to @p pkt or
gnrc_sixlowpan_frag: adapt for #8511 This refactors the `gnrc_sixlowpan_frag` module for the API proposed in #8511. The `ctx` for `gnrc_sixlowpan_frag_send()` is required to be a `gnrc_sixlowpan_msg_frag_t` object, so IPHC can later on use it to provide the *original* datagram size (otherwise, we would need to adapt the API just for that, which seems to me as convoluted as this proposal). I also provide an expose function with a future possibility to provide more than just one `gnrc_sixlowpan_msg_frag_t` object later on (plus having cleaner module separation in general).
2018-06-19 14:59:49 +02:00
* `pkt == NULL`.
*
* @param[in] pkt A packet. May be NULL.
gnrc_sixlowpan_frag: factor-out and rename fragmentation buffer The name `fragment_msg` or `frag_msg`/`msg_frag` always to me was a bit misplaced, as it basically implements an asynchronous fragmentation buffer and doesn't necessarily have anything to do with messages. This change 1. changes the name to `fb` (for fragmentation buffer) 2. factors its code out to its own sub-module so it can be re-used by other 6LoWPAN fragmentation schemes like [Selective Fragment Recovery] [Selective Fragment Recovery]: https://tools.ietf.org/html/draft-ietf-6lo-fragment-recovery-05
2019-10-17 16:56:38 +02:00
* @param[in] ctx A fragmentation buffer entry. Expected to be of type
* @ref gnrc_sixlowpan_frag_fb_t, with
* gnrc_sixlowpan_frag_fb_t set to @p pkt. Must not be
gnrc_sixlowpan_frag: adapt for #8511 This refactors the `gnrc_sixlowpan_frag` module for the API proposed in #8511. The `ctx` for `gnrc_sixlowpan_frag_send()` is required to be a `gnrc_sixlowpan_msg_frag_t` object, so IPHC can later on use it to provide the *original* datagram size (otherwise, we would need to adapt the API just for that, which seems to me as convoluted as this proposal). I also provide an expose function with a future possibility to provide more than just one `gnrc_sixlowpan_msg_frag_t` object later on (plus having cleaner module separation in general).
2018-06-19 14:59:49 +02:00
* NULL.
* @param[in] page Current 6Lo dispatch parsing page.
*/
void gnrc_sixlowpan_frag_send(gnrc_pktsnip_t *pkt, void *ctx, unsigned page);
/**
* @brief Handles a packet containing a fragment header
*
* @param[in] pkt The packet to handle
* @param[in] ctx Context for the packet. May be NULL.
* @param[in] page Current 6Lo dispatch parsing page.
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
*/
gnrc_sixlowpan_frag: adapt for #8511 This refactors the `gnrc_sixlowpan_frag` module for the API proposed in #8511. The `ctx` for `gnrc_sixlowpan_frag_send()` is required to be a `gnrc_sixlowpan_msg_frag_t` object, so IPHC can later on use it to provide the *original* datagram size (otherwise, we would need to adapt the API just for that, which seems to me as convoluted as this proposal). I also provide an expose function with a future possibility to provide more than just one `gnrc_sixlowpan_msg_frag_t` object later on (plus having cleaner module separation in general).
2018-06-19 14:59:49 +02:00
void gnrc_sixlowpan_frag_recv(gnrc_pktsnip_t *pkt, void *ctx, unsigned page);
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
#ifdef __cplusplus
}
#endif
cleanup: apply headerguard script output
2017-05-23 18:19:52 +02:00
#endif /* NET_GNRC_SIXLOWPAN_FRAG_H */
ng_sixlowpan: Initial import of datagram fragmentation
2015-04-08 11:56:10 +02:00
/** @} */
Copy Permalink