_nib-arsm.h

/*
 * Copyright (C) 2017 Freie Universität Berlin
 *
 * 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.
 */
 
#ifndef PRIV_NIB_ARSM_H
#define PRIV_NIB_ARSM_H
 
#include <kernel_defines.h>
#include <stdint.h>
 
#include "net/gnrc/ipv6/nib/conf.h"
#include "net/gnrc/netif.h"
#include "net/ndp.h"
#include "net/icmpv6.h"
#include "net/ipv6/hdr.h"
 
#include "_nib-internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
void _snd_ns(const ipv6_addr_t *tgt, gnrc_netif_t *netif,
             const ipv6_addr_t *src, const ipv6_addr_t *dst);
 
void _snd_uc_ns(_nib_onl_entry_t *nbr, bool reset);
 
void _handle_sl2ao(gnrc_netif_t *netif, const ipv6_hdr_t *ipv6,
                   const icmpv6_hdr_t *icmpv6, const ndp_opt_t *sl2ao);
 
static inline uint32_t _exp_backoff_retrans_timer_factor(uint8_t ns_sent,
                                                         uint32_t retrans_timer,
                                                         uint32_t factor)
{
    assert(NDP_MIN_RANDOM_FACTOR <= factor);
    assert(factor < NDP_MAX_RANDOM_FACTOR);
    assert(ns_sent <= NDP_MAX_NS_NUMOF);
    /* backoff according to  https://tools.ietf.org/html/rfc7048 with
     * BACKOFF_MULTIPLE == 2 */
    uint32_t res = (uint32_t)(((uint64_t)(((uint32_t) 1) << ns_sent) *
                               retrans_timer * factor) / US_PER_MS);
    /* random factors were statically multiplied with 1000 */
    if (res > NDP_MAX_RETRANS_TIMER_MS) {
        res = NDP_MAX_RETRANS_TIMER_MS;
    }
    return res;
}
 
#if IS_ACTIVE(CONFIG_GNRC_IPV6_NIB_ARSM) || defined(DOXYGEN)
void _handle_snd_ns(_nib_onl_entry_t *nbr);
 
void _handle_state_timeout(_nib_onl_entry_t *nbr);
 
void _probe_nbr(_nib_onl_entry_t *nbr, bool reset);
 
void _handle_adv_l2(gnrc_netif_t *netif, _nib_onl_entry_t *nce,
                    const icmpv6_hdr_t *icmpv6, const ndp_opt_t *tl2ao);
 
void _recalc_reach_time(gnrc_netif_ipv6_t *netif);
 
void _set_reachable(gnrc_netif_t *netif, _nib_onl_entry_t *nce);
 
void _set_unreachable(gnrc_netif_t *netif, _nib_onl_entry_t *nce);
 
static inline void _init_iface_arsm(gnrc_netif_t *netif)
{
    netif->ipv6.reach_time_base = NDP_REACH_MS;
    _recalc_reach_time(&netif->ipv6);
}
 
static inline void _deinit_iface_arsm(gnrc_netif_t *netif)
{
    _evtimer_del(&netif->ipv6.recalc_reach_time);
}
 
static inline uint16_t _get_nud_state(_nib_onl_entry_t *nbr)
{
    return (nbr->info & GNRC_IPV6_NIB_NC_INFO_NUD_STATE_MASK);
}
 
void _set_nud_state(gnrc_netif_t *netif, _nib_onl_entry_t *nbr,
                    uint16_t state);
 
bool _is_reachable(_nib_onl_entry_t *entry);
#else   /* CONFIG_GNRC_IPV6_NIB_ARSM || defined(DOXYGEN) */
#define _handle_snd_ns(ctx)                         (void)ctx
#define _handle_state_timeout(ctx)                  (void)ctx
#define _probe_nbr(nbr, reset)                      (void)nbr; (void)reset
#define _init_iface_arsm(netif)                     (void)netif
#define _deinit_iface_arsm(netif)                   (void)netif
#define _handle_adv_l2(netif, nce, icmpv6, tl2ao)   (void)netif; (void)nce; \
                                                    (void)icmpv6; (void)tl2ao
#define _recalc_reach_time(netif)                   (void)netif
#define _set_reachable(netif, nce)                  (void)netif; (void)nce
 
#define _get_nud_state(nbr)                 (GNRC_IPV6_NIB_NC_INFO_NUD_STATE_UNMANAGED)
#define _set_nud_state(netif, nce, state)   (void)netif; (void)nce; (void)state
#define _is_reachable(entry)                (true)
#endif  /* CONFIG_GNRC_IPV6_NIB_ARSM || defined(DOXYGEN) */
 
#ifdef __cplusplus
}
#endif
 
#endif /* PRIV_NIB_ARSM_H */