Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 | /** @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 <net/net_ip.h>
#include <net/net_pkt.h>
#include <net/net_if.h>
#include <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
/**
* @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. */
s64_t reachable;
/** Reachable timeout */
s32_t reachable_timeout;
/** Neighbor Solicitation reply timer */
s64_t send_ns;
/** State of the neighbor discovery */
enum net_ipv6_nbr_state state;
/** Link metric for the neighbor */
u16_t link_metric;
/** How many times we have sent NS */
u8_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.
*/
u32_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,
u8_t flags);
static inline bool net_ipv6_is_nexthdr_upper_layer(u8_t nexthdr)
{
return (nexthdr == IPPROTO_ICMPV6 || nexthdr == IPPROTO_UDP ||
nexthdr == IPPROTO_TCP);
}
/**
* @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.
*/
int net_ipv6_create(struct net_pkt *pkt,
const struct in6_addr *src,
const struct in6_addr *dst);
/**
* @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.
*/
int net_ipv6_finalize(struct net_pkt *pkt, u8_t next_header_proto);
/**
* @brief Join a given multicast group.
*
* @param iface Network interface where join message is sent
* @param addr Multicast group to join
*
* @return Return 0 if joining was done, <0 otherwise.
*/
#if defined(CONFIG_NET_IPV6_MLD)
int net_ipv6_mld_join(struct net_if *iface, const struct in6_addr *addr);
#else
#define net_ipv6_mld_join(...)
#endif /* CONFIG_NET_IPV6_MLD */
/**
* @brief Leave a given multicast group.
*
* @param iface Network interface where leave message is sent
* @param addr Multicast group to leave
*
* @return Return 0 if leaving is done, <0 otherwise.
*/
#if defined(CONFIG_NET_IPV6_MLD)
int net_ipv6_mld_leave(struct net_if *iface, const struct in6_addr *addr);
#else
#define net_ipv6_mld_leave(...)
#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)
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 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)
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, u8_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)
struct in6_addr *net_ipv6_nbr_lookup_by_index(struct net_if *iface,
u8_t idx);
#else
static inline
struct in6_addr *net_ipv6_nbr_lookup_by_index(struct net_if *iface,
u8_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)
struct net_nbr *net_ipv6_nbr_add(struct net_if *iface,
struct in6_addr *addr,
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,
struct in6_addr *addr,
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)
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)
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 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)
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
/* We do not have to accept larger than 1500 byte IPv6 packet (RFC 2460 ch 5).
* This means that we should receive everything within first two fragments.
* The first one being 1280 bytes and the second one 220 bytes.
*/
#if !defined(NET_IPV6_FRAGMENTS_MAX_PKT)
#define NET_IPV6_FRAGMENTS_MAX_PKT 2
#endif
/** 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_delayed_work timer;
/** Pointers to pending fragments */
struct net_pkt *pkt[NET_IPV6_FRAGMENTS_MAX_PKT];
/** IPv6 fragment identification */
u32_t id;
};
/**
* @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, u16_t *next_hdr_off,
u16_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)
enum net_verdict net_ipv6_handle_fragment_hdr(struct net_pkt *pkt,
struct net_ipv6_hdr *hdr,
u8_t nexthdr);
#else
static inline
enum net_verdict net_ipv6_handle_fragment_hdr(struct net_pkt *pkt,
struct net_ipv6_hdr *hdr,
u8_t nexthdr)
{
ARG_UNUSED(pkt);
ARG_UNUSED(hdr);
ARG_UNUSED(nexthdr);
return NET_DROP;
}
#endif /* CONFIG_NET_IPV6_FRAGMENT */
#if defined(CONFIG_NET_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
#endif /* __IPV6_H */
|