zephyr/subsys/net/ip/ipv6.h
Robert Lubos c6498bb68d net: ipv6: Make Multicast Listener Discovery API public
IPv6 MLD API was so far defined in an internal header. This does not
seem correct though, as application code should be able to join/leave
multicast groups, hence the API should be exposed in a public header,
just as it is done for its IPv4 countepart - IGMP.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2024-10-08 17:00:06 +02:00

669 lines
18 KiB
C

/** @file
@brief IPv6 data handler
This is not to be included by the application.
*/
/*
* Copyright (c) 2016 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef __IPV6_H
#define __IPV6_H
#include <zephyr/types.h>
#include <zephyr/net/net_ip.h>
#include <zephyr/net/net_pkt.h>
#include <zephyr/net/net_if.h>
#include <zephyr/net/net_context.h>
#include "icmpv6.h"
#include "nbr.h"
#define NET_IPV6_ND_HOP_LIMIT 255
#define NET_IPV6_ND_INFINITE_LIFETIME 0xFFFFFFFF
#define NET_IPV6_DEFAULT_PREFIX_LEN 64
#define NET_MAX_RS_COUNT 3
#define NET_IPV6_DSCP_MASK 0xFC
#define NET_IPV6_DSCP_OFFSET 2
#define NET_IPV6_ECN_MASK 0x03
/**
* @brief Bitmaps for IPv6 extension header processing
*
* When processing extension headers, we record which one we have seen.
* This is done as the network packet cannot have twice the same header,
* except for destination option.
* This information is stored in bitfield variable.
* The order of the bitmap is the order recommended in RFC 2460.
*/
#define NET_IPV6_EXT_HDR_BITMAP_HBHO 0x01
#define NET_IPV6_EXT_HDR_BITMAP_DESTO1 0x02
#define NET_IPV6_EXT_HDR_BITMAP_ROUTING 0x04
#define NET_IPV6_EXT_HDR_BITMAP_FRAG 0x08
#define NET_IPV6_EXT_HDR_BITMAP_AH 0x10
#define NET_IPV6_EXT_HDR_BITMAP_ESP 0x20
#define NET_IPV6_EXT_HDR_BITMAP_DESTO2 0x40
/**
* @brief Destination and Hop By Hop extension headers option types
*/
#define NET_IPV6_EXT_HDR_OPT_PAD1 0
#define NET_IPV6_EXT_HDR_OPT_PADN 1
#define NET_IPV6_EXT_HDR_OPT_RPL 0x63
/**
* @brief Multicast Listener Record v2 record types.
*/
#define NET_IPV6_MLDv2_MODE_IS_INCLUDE 1
#define NET_IPV6_MLDv2_MODE_IS_EXCLUDE 2
#define NET_IPV6_MLDv2_CHANGE_TO_INCLUDE_MODE 3
#define NET_IPV6_MLDv2_CHANGE_TO_EXCLUDE_MODE 4
#define NET_IPV6_MLDv2_ALLOW_NEW_SOURCES 5
#define NET_IPV6_MLDv2_BLOCK_OLD_SOURCES 6
/* State of the neighbor */
enum net_ipv6_nbr_state {
NET_IPV6_NBR_STATE_INCOMPLETE,
NET_IPV6_NBR_STATE_REACHABLE,
NET_IPV6_NBR_STATE_STALE,
NET_IPV6_NBR_STATE_DELAY,
NET_IPV6_NBR_STATE_PROBE,
NET_IPV6_NBR_STATE_STATIC,
};
const char *net_ipv6_nbr_state2str(enum net_ipv6_nbr_state state);
/**
* @brief IPv6 neighbor information.
*/
struct net_ipv6_nbr_data {
/** Any pending packet waiting ND to finish. */
struct net_pkt *pending;
/** IPv6 address. */
struct in6_addr addr;
/** Reachable timer. */
int64_t reachable;
/** Reachable timeout */
int32_t reachable_timeout;
/** Neighbor Solicitation reply timer */
int64_t send_ns;
/** State of the neighbor discovery */
enum net_ipv6_nbr_state state;
/** Link metric for the neighbor */
uint16_t link_metric;
/** How many times we have sent NS */
uint8_t ns_count;
/** Is the neighbor a router */
bool is_router;
#if defined(CONFIG_NET_IPV6_NBR_CACHE) || defined(CONFIG_NET_IPV6_ND)
/** Stale counter used to removed oldest nbr in STALE state,
* when table is full.
*/
uint32_t stale_counter;
#endif
};
static inline struct net_ipv6_nbr_data *net_ipv6_nbr_data(struct net_nbr *nbr)
{
return (struct net_ipv6_nbr_data *)nbr->data;
}
#if defined(CONFIG_NET_IPV6_DAD)
int net_ipv6_start_dad(struct net_if *iface, struct net_if_addr *ifaddr);
#endif
int net_ipv6_send_ns(struct net_if *iface, struct net_pkt *pending,
const struct in6_addr *src, const struct in6_addr *dst,
const struct in6_addr *tgt, bool is_my_address);
int net_ipv6_send_rs(struct net_if *iface);
int net_ipv6_start_rs(struct net_if *iface);
int net_ipv6_send_na(struct net_if *iface, const struct in6_addr *src,
const struct in6_addr *dst, const struct in6_addr *tgt,
uint8_t flags);
static inline bool net_ipv6_is_nexthdr_upper_layer(uint8_t nexthdr)
{
return (nexthdr == IPPROTO_ICMPV6 || nexthdr == IPPROTO_UDP ||
nexthdr == IPPROTO_TCP ||
(IS_ENABLED(CONFIG_NET_L2_VIRTUAL) &&
((nexthdr == IPPROTO_IPV6) || (nexthdr == IPPROTO_IPIP))));
}
/**
* @brief Create IPv6 packet in provided net_pkt.
*
* @param pkt Network packet
* @param src Source IPv6 address
* @param dst Destination IPv6 address
*
* @return 0 on success, negative errno otherwise.
*/
#if defined(CONFIG_NET_NATIVE_IPV6)
int net_ipv6_create(struct net_pkt *pkt,
const struct in6_addr *src,
const struct in6_addr *dst);
#else
static inline int net_ipv6_create(struct net_pkt *pkt,
const struct in6_addr *src,
const struct in6_addr *dst)
{
ARG_UNUSED(pkt);
ARG_UNUSED(src);
ARG_UNUSED(dst);
return -ENOTSUP;
}
#endif
/**
* @brief Finalize IPv6 packet. It should be called right before
* sending the packet and after all the data has been added into
* the packet. This function will set the length of the
* packet and calculate the higher protocol checksum if needed.
*
* @param pkt Network packet
* @param next_header_proto Protocol type of the next header after IPv6 header.
*
* @return 0 on success, negative errno otherwise.
*/
#if defined(CONFIG_NET_NATIVE_IPV6)
int net_ipv6_finalize(struct net_pkt *pkt, uint8_t next_header_proto);
#else
static inline int net_ipv6_finalize(struct net_pkt *pkt,
uint8_t next_header_proto)
{
ARG_UNUSED(pkt);
ARG_UNUSED(next_header_proto);
return -ENOTSUP;
}
#endif
/**
* @brief Send MLDv2 report message with a single entry.
*
* @param iface Network interface where message is sent
* @param addr Multicast group
* @param mode MLDv2 mode (NET_IPV6_MLDv2_MODE_IS_INCLUDE NET_IPV6_MLDv2_MODE_IS_EXCLUDE)
*
* @return Return 0 if leaving is done, <0 otherwise.
*/
#if defined(CONFIG_NET_IPV6_MLD)
int net_ipv6_mld_send_single(struct net_if *iface, const struct in6_addr *addr, uint8_t mode);
#else
static inline int
net_ipv6_mld_send_single(struct net_if *iface, const struct in6_addr *addr, uint8_t mode)
{
ARG_UNUSED(iface);
ARG_UNUSED(addr);
ARG_UNUSED(mode);
return -ENOTSUP;
}
#endif /* CONFIG_NET_IPV6_MLD */
/**
* @typedef net_nbr_cb_t
* @brief Callback used while iterating over neighbors.
*
* @param nbr A valid pointer on current neighbor.
* @param user_data A valid pointer on some user data or NULL
*/
typedef void (*net_nbr_cb_t)(struct net_nbr *nbr, void *user_data);
/**
* @brief Make sure the link layer address is set according to
* destination address. If the ll address is not yet known, then
* start neighbor discovery to find it out. If ND needs to be done
* then the returned packet is the Neighbor Solicitation message
* and the original message is sent after Neighbor Advertisement
* message is received.
*
* @param pkt Network packet
*
* @return Return a verdict.
*/
#if defined(CONFIG_NET_IPV6_NBR_CACHE) && defined(CONFIG_NET_NATIVE_IPV6)
enum net_verdict net_ipv6_prepare_for_send(struct net_pkt *pkt);
#else
static inline enum net_verdict net_ipv6_prepare_for_send(struct net_pkt *pkt)
{
return NET_OK;
}
#endif
/**
* @brief Lock IPv6 Neighbor table mutex
*
* Neighbor table mutex is used by IPv6 Neighbor cache and IPv6 Routing module.
* Mutex shall be held whenever accessing or manipulating neighbor or routing
* table entries (for example when obtaining a pointer to the neighbor table
* entry). Neighbor and Routing API functions will lock the mutex when called.
*/
void net_ipv6_nbr_lock(void);
/**
* @brief Unlock IPv6 Neighbor table mutex
*/
void net_ipv6_nbr_unlock(void);
/**
* @brief Look for a neighbor from it's address on an iface
*
* @param iface A valid pointer on a network interface
* @param addr The IPv6 address to match
*
* @return A valid pointer on a neighbor on success, NULL otherwise
*/
#if defined(CONFIG_NET_IPV6_NBR_CACHE) && defined(CONFIG_NET_NATIVE_IPV6)
struct net_nbr *net_ipv6_nbr_lookup(struct net_if *iface,
struct in6_addr *addr);
#else
static inline struct net_nbr *net_ipv6_nbr_lookup(struct net_if *iface,
struct in6_addr *addr)
{
return NULL;
}
#endif
/**
* @brief Get neighbor from its index.
*
* @param iface Network interface to match. If NULL, then use
* whatever interface there is configured for the neighbor address.
* @param idx Index of the link layer address in the address array
*
* @return A valid pointer on a neighbor on success, NULL otherwise
*/
struct net_nbr *net_ipv6_get_nbr(struct net_if *iface, uint8_t idx);
/**
* @brief Look for a neighbor from it's link local address index
*
* @param iface Network interface to match. If NULL, then use
* whatever interface there is configured for the neighbor address.
* @param idx Index of the link layer address in the address array
*
* @return A valid pointer on a neighbor on success, NULL otherwise
*/
#if defined(CONFIG_NET_IPV6_NBR_CACHE) && defined(CONFIG_NET_NATIVE_IPV6)
struct in6_addr *net_ipv6_nbr_lookup_by_index(struct net_if *iface,
uint8_t idx);
#else
static inline
struct in6_addr *net_ipv6_nbr_lookup_by_index(struct net_if *iface,
uint8_t idx)
{
return NULL;
}
#endif
/**
* @brief Add a neighbor to neighbor cache
*
* Add a neighbor to the cache after performing a lookup and in case
* there exists an entry in the cache update its state and lladdr.
*
* @param iface A valid pointer on a network interface
* @param addr Neighbor IPv6 address
* @param lladdr Neighbor link layer address
* @param is_router Set to true if the neighbor is a router, false
* otherwise
* @param state Initial state of the neighbor entry in the cache
*
* @return A valid pointer on a neighbor on success, NULL otherwise
*/
#if defined(CONFIG_NET_IPV6_NBR_CACHE) && defined(CONFIG_NET_NATIVE_IPV6)
struct net_nbr *net_ipv6_nbr_add(struct net_if *iface,
const struct in6_addr *addr,
const struct net_linkaddr *lladdr,
bool is_router,
enum net_ipv6_nbr_state state);
#else
static inline struct net_nbr *net_ipv6_nbr_add(struct net_if *iface,
const struct in6_addr *addr,
const struct net_linkaddr *lladdr,
bool is_router,
enum net_ipv6_nbr_state state)
{
return NULL;
}
#endif
/**
* @brief Remove a neighbor from neighbor cache.
*
* @param iface A valid pointer on a network interface
* @param addr Neighbor IPv6 address
*
* @return True if neighbor could be removed, False otherwise
*/
#if defined(CONFIG_NET_IPV6_NBR_CACHE) && defined(CONFIG_NET_NATIVE_IPV6)
bool net_ipv6_nbr_rm(struct net_if *iface, struct in6_addr *addr);
#else
static inline bool net_ipv6_nbr_rm(struct net_if *iface, struct in6_addr *addr)
{
return true;
}
#endif
/**
* @brief Go through all the neighbors and call callback for each of them.
*
* @param cb User supplied callback function to call.
* @param user_data User specified data.
*/
#if defined(CONFIG_NET_IPV6_NBR_CACHE) && defined(CONFIG_NET_NATIVE_IPV6)
void net_ipv6_nbr_foreach(net_nbr_cb_t cb, void *user_data);
#else /* CONFIG_NET_IPV6_NBR_CACHE */
static inline void net_ipv6_nbr_foreach(net_nbr_cb_t cb, void *user_data)
{
return;
}
#endif /* CONFIG_NET_IPV6_NBR_CACHE */
/**
* @brief Provide a reachability hint for IPv6 Neighbor Discovery.
*
* This function is intended for upper-layer protocols to inform the IPv6
* Neighbor Discovery process about the active link to a specific neighbor.
* By signaling recent "forward progress" event, such as the reception of
* an ACK, this function can help reducing unnecessary ND traffic as per the
* guidelines in RFC 4861 (section 7.3).
*
* @param iface A pointer to the network interface.
* @param ipv6_addr Pointer to the IPv6 address of the neighbor node.
*/
#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
void net_ipv6_nbr_reachability_hint(struct net_if *iface, const struct in6_addr *ipv6_addr);
#else
static inline void net_ipv6_nbr_reachability_hint(struct net_if *iface,
const struct in6_addr *ipv6_addr)
{
ARG_UNUSED(iface);
ARG_UNUSED(ipv6_addr);
}
#endif
/**
* @brief Set the neighbor reachable timer.
*
* @param iface A valid pointer on a network interface
* @param nbr Neighbor struct pointer
*/
#if defined(CONFIG_NET_IPV6_ND) && defined(CONFIG_NET_NATIVE_IPV6)
void net_ipv6_nbr_set_reachable_timer(struct net_if *iface,
struct net_nbr *nbr);
#else /* CONFIG_NET_IPV6_ND */
static inline void net_ipv6_nbr_set_reachable_timer(struct net_if *iface,
struct net_nbr *nbr)
{
}
#endif
#if defined(CONFIG_NET_IPV6_FRAGMENT)
/** Store pending IPv6 fragment information that is needed for reassembly. */
struct net_ipv6_reassembly {
/** IPv6 source address of the fragment */
struct in6_addr src;
/** IPv6 destination address of the fragment */
struct in6_addr dst;
/**
* Timeout for cancelling the reassembly. The timer is used
* also to detect if this reassembly slot is used or not.
*/
struct k_work_delayable timer;
/** Pointers to pending fragments */
struct net_pkt *pkt[CONFIG_NET_IPV6_FRAGMENT_MAX_PKT];
/** IPv6 fragment identification */
uint32_t id;
};
#else
struct net_ipv6_reassembly;
#endif
/**
* @typedef net_ipv6_frag_cb_t
* @brief Callback used while iterating over pending IPv6 fragments.
*
* @param reass IPv6 fragment reassembly struct
* @param user_data A valid pointer on some user data or NULL
*/
typedef void (*net_ipv6_frag_cb_t)(struct net_ipv6_reassembly *reass,
void *user_data);
/**
* @brief Go through all the currently pending IPv6 fragments.
*
* @param cb Callback to call for each pending IPv6 fragment.
* @param user_data User specified data or NULL.
*/
void net_ipv6_frag_foreach(net_ipv6_frag_cb_t cb, void *user_data);
/**
* @brief Find the last IPv6 extension header in the network packet.
*
* @param pkt Network head packet.
* @param next_hdr_off Offset of the next header field that points
* to last header. This is returned to caller.
* @param last_hdr_off Offset of the last header field in the packet.
* This is returned to caller.
*
* @return 0 on success, a negative errno otherwise.
*/
int net_ipv6_find_last_ext_hdr(struct net_pkt *pkt, uint16_t *next_hdr_off,
uint16_t *last_hdr_off);
/**
* @brief Handles IPv6 fragmented packets.
*
* @param pkt Network head packet.
* @param hdr The IPv6 header of the current packet
* @param nexthdr IPv6 next header after fragment header part
*
* @return Return verdict about the packet
*/
#if defined(CONFIG_NET_IPV6_FRAGMENT) && defined(CONFIG_NET_NATIVE_IPV6)
enum net_verdict net_ipv6_handle_fragment_hdr(struct net_pkt *pkt,
struct net_ipv6_hdr *hdr,
uint8_t nexthdr);
#else
static inline
enum net_verdict net_ipv6_handle_fragment_hdr(struct net_pkt *pkt,
struct net_ipv6_hdr *hdr,
uint8_t nexthdr)
{
ARG_UNUSED(pkt);
ARG_UNUSED(hdr);
ARG_UNUSED(nexthdr);
return NET_DROP;
}
#endif /* CONFIG_NET_IPV6_FRAGMENT */
#if defined(CONFIG_NET_NATIVE_IPV6)
void net_ipv6_init(void);
void net_ipv6_nbr_init(void);
#if defined(CONFIG_NET_IPV6_MLD)
void net_ipv6_mld_init(void);
#else
#define net_ipv6_mld_init(...)
#endif
#else
#define net_ipv6_init(...)
#define net_ipv6_nbr_init(...)
#endif
/**
* @brief Decode DSCP value from TC field.
*
* @param tc TC field value from the IPv6 header.
*
* @return Decoded DSCP value.
*/
static inline uint8_t net_ipv6_get_dscp(uint8_t tc)
{
return (tc & NET_IPV6_DSCP_MASK) >> NET_IPV6_DSCP_OFFSET;
}
/**
* @brief Encode DSCP value into TC field.
*
* @param tc A pointer to the TC field.
* @param dscp DSCP value to set.
*/
static inline void net_ipv6_set_dscp(uint8_t *tc, uint8_t dscp)
{
*tc &= ~NET_IPV6_DSCP_MASK;
*tc |= (dscp << NET_IPV6_DSCP_OFFSET) & NET_IPV6_DSCP_MASK;
}
/**
* @brief Convert DSCP value to priority.
*
* @param dscp DSCP value.
*/
static inline uint8_t net_ipv6_dscp_to_priority(uint8_t dscp)
{
return dscp >> 3;
}
/**
* @brief Decode ECN value from TC field.
*
* @param tc TC field value from the IPv6 header.
*
* @return Decoded ECN value.
*/
static inline uint8_t net_ipv6_get_ecn(uint8_t tc)
{
return tc & NET_IPV6_ECN_MASK;
}
/**
* @brief Encode ECN value into TC field.
*
* @param tc A pointer to the TC field.
* @param ecn ECN value to set.
*/
static inline void net_ipv6_set_ecn(uint8_t *tc, uint8_t ecn)
{
*tc &= ~NET_IPV6_ECN_MASK;
*tc |= ecn & NET_IPV6_ECN_MASK;
}
/**
* @brief Start IPv6 privacy extension procedure.
*
* @param iface Interface to use.
* @param prefix IPv6 prefix to use.
* @param vlifetime Lifetime of this IPv6 prefix (in seconds).
* @param preferred_lifetime Preferred lifetime of this IPv6 prefix (in seconds)
*/
#if defined(CONFIG_NET_IPV6_PE)
void net_ipv6_pe_start(struct net_if *iface, const struct in6_addr *prefix,
uint32_t vlifetime, uint32_t preferred_lifetime);
#else
static inline void net_ipv6_pe_start(struct net_if *iface,
const struct in6_addr *prefix,
uint32_t vlifetime,
uint32_t preferred_lifetime)
{
ARG_UNUSED(iface);
ARG_UNUSED(prefix);
ARG_UNUSED(vlifetime);
ARG_UNUSED(preferred_lifetime);
}
#endif /* CONFIG_NET_IPV6_PE */
/**
* @brief Check if maximum number of Duplicate Address Detection (DAD) requests
* have been done.
*
* @param count Number of DAD requests done.
*
* @return Return True if DAD can continue, False if max amount of DAD
* requests have been done.
*/
#if defined(CONFIG_NET_IPV6_PE)
bool net_ipv6_pe_check_dad(int count);
#else
static inline bool net_ipv6_pe_check_dad(int count)
{
ARG_UNUSED(count);
return false;
}
#endif /* CONFIG_NET_IPV6_PE */
/**
* @brief Initialize IPv6 privacy extension support for a network interface.
*
* @param iface Network interface
*
* @return Return 0 if ok or <0 if there is an error.
*/
#if defined(CONFIG_NET_IPV6_PE)
int net_ipv6_pe_init(struct net_if *iface);
#else
static inline int net_ipv6_pe_init(struct net_if *iface)
{
iface->pe_enabled = false;
iface->pe_prefer_public = false;
return 0;
}
#endif /* CONFIG_NET_IPV6_PE */
typedef void (*net_ipv6_pe_filter_cb_t)(struct in6_addr *prefix,
bool is_blacklist,
void *user_data);
/**
* @brief Go through all the IPv6 privacy extension filters and call callback
* for each IPv6 prefix.
*
* @param cb User supplied callback function to call.
* @param user_data User specified data.
*
* @return Total number of filters found.
*/
#if defined(CONFIG_NET_IPV6_PE)
int net_ipv6_pe_filter_foreach(net_ipv6_pe_filter_cb_t cb, void *user_data);
#else
static inline int net_ipv6_pe_filter_foreach(net_ipv6_pe_filter_cb_t cb,
void *user_data)
{
ARG_UNUSED(cb);
ARG_UNUSED(user_data);
return 0;
}
#endif
#endif /* __IPV6_H */