rb.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2019 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include <stdint.h>
#include <stdbool.h>
#include <stdalign.h>
 
#include "architecture.h"
#include "net/gnrc/netif/hdr.h"
#include "net/gnrc/pkt.h"
#ifdef MODULE_GNRC_SIXLOWPAN_FRAG_SFR
#include "net/sixlowpan/sfr.h"
#endif  /* MODULE_GNRC_SIXLOWPAN_FRAG_SFR */
 
#include "net/gnrc/sixlowpan/config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
#define GNRC_SIXLOWPAN_FRAG_RB_GC_MSG       (0x0226)
 
typedef struct gnrc_sixlowpan_frag_rb_int {
    struct gnrc_sixlowpan_frag_rb_int *next;
    uint16_t start;             
    uint16_t end;               
} gnrc_sixlowpan_frag_rb_int_t;
 
typedef struct {
    gnrc_sixlowpan_frag_rb_int_t *ints;         
    uint8_t src[IEEE802154_LONG_ADDRESS_LEN];   
    uint8_t dst[IEEE802154_LONG_ADDRESS_LEN];   
    uint8_t src_len;                            
    uint8_t dst_len;                            
    uint16_t tag;                               
    uint16_t datagram_size;                     
    uint16_t current_size;
    uint32_t arrival;                           
} gnrc_sixlowpan_frag_rb_base_t;
 
typedef struct {
    gnrc_sixlowpan_frag_rb_base_t super;        
    gnrc_pktsnip_t *pkt;
#if IS_USED(MODULE_GNRC_SIXLOWPAN_FRAG_SFR) || defined(DOXYGEN)
    alignas(gnrc_sixlowpan_frag_sfr_bitmap_t)
    BITFIELD(received, SIXLOWPAN_SFR_ACK_BITMAP_SIZE);
    int8_t offset_diff;                         
#endif /* IS_USED(MODULE_GNRC_SIXLOWPAN_FRAG_SFR) */
} gnrc_sixlowpan_frag_rb_t;
 
gnrc_sixlowpan_frag_rb_t *gnrc_sixlowpan_frag_rb_add(gnrc_netif_hdr_t *netif_hdr,
                                                     gnrc_pktsnip_t *frag,
                                                     size_t offset, unsigned page);
 
gnrc_sixlowpan_frag_rb_t *gnrc_sixlowpan_frag_rb_get_by_datagram(
    const gnrc_netif_hdr_t *netif_hdr,
    uint16_t tag);
 
bool gnrc_sixlowpan_frag_rb_exists(const gnrc_netif_hdr_t *netif_hdr,
                                   uint16_t tag);
 
void gnrc_sixlowpan_frag_rb_rm_by_datagram(const gnrc_netif_hdr_t *netif_hdr,
                                           uint16_t tag);
 
static inline bool gnrc_sixlowpan_frag_rb_entry_empty(
        const gnrc_sixlowpan_frag_rb_t *rbuf) {
    return (rbuf->pkt == NULL);
}
 
#if defined(TEST_SUITES) || defined(DOXYGEN)
void gnrc_sixlowpan_frag_rb_reset(void);
 
const gnrc_sixlowpan_frag_rb_t *gnrc_sixlowpan_frag_rb_array(void);
#endif
 
void gnrc_sixlowpan_frag_rb_base_rm(gnrc_sixlowpan_frag_rb_base_t *entry);
 
void gnrc_sixlowpan_frag_rb_gc(void);
 
int gnrc_sixlowpan_frag_rb_dispatch_when_complete(gnrc_sixlowpan_frag_rb_t *rbuf,
                                                  gnrc_netif_hdr_t *netif);
 
#if defined(MODULE_GNRC_SIXLOWPAN_FRAG_RB) || defined(DOXYGEN)
static inline void gnrc_sixlowpan_frag_rb_remove(gnrc_sixlowpan_frag_rb_t *rbuf)
{
    assert(rbuf != NULL);
    gnrc_sixlowpan_frag_rb_base_rm(&rbuf->super);
    rbuf->pkt = NULL;
}
#else
/* NOPs to be used with gnrc_sixlowpan_iphc if gnrc_sixlowpan_frag_rb is not
 * compiled in */
static inline void gnrc_sixlowpan_frag_rb_remove(gnrc_sixlowpan_frag_rb_t *rbuf)
{
    (void)rbuf;
    return;
}
#endif
 
#if defined(TEST_SUITES) || defined(DOXYGEN)
bool gnrc_sixlowpan_frag_rb_ints_empty(void);
#else   /* defined(TEST_SUITES) || defined(DOXYGEN) */
/* always true without TEST_SUITES defined to optimize out when not testing,
 * as checking the status of the fragment interval pool is unnecessary in
 * production */
static inline bool gnrc_sixlowpan_frag_rb_ints_empty(void)
{
    return true;
}
#endif  /* defined(TEST_SUITES) || defined(DOXYGEN) */
 
#ifdef __cplusplus
}
#endif