Loading...
Searching...
No Matches
addr.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
3 *
4 * This file is subject to the terms and conditions of the GNU Lesser General
5 * Public License v2.1. See the file LICENSE in the top level directory for
6 * more details.
7 */
8
26#ifndef NET_IPV6_ADDR_H
27#define NET_IPV6_ADDR_H
28
29#include <stdbool.h>
30#include <string.h>
31
32#include "byteorder.h"
33#include "net/ipv4/addr.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
42#define IPV6_ADDR_BIT_LEN (128)
43
44#ifdef MODULE_IPV4_ADDR
48#define IPV6_ADDR_MAX_STR_LEN (sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255"))
49#else
53#define IPV6_ADDR_MAX_STR_LEN (sizeof("ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"))
54#endif
55
67#define IPV6_ADDR_SITE_LOCAL_PREFIX (0xfec0)
68
72typedef union {
73 uint8_t u8[16];
78
86#define IPV6_ADDR_UNSPECIFIED {{ 0x00, 0x00, 0x00, 0x00, \
87 0x00, 0x00, 0x00, 0x00, \
88 0x00, 0x00, 0x00, 0x00, \
89 0x00, 0x00, 0x00, 0x00 }}
90
98#define IPV6_ADDR_LOOPBACK {{ 0x00, 0x00, 0x00, 0x00, \
99 0x00, 0x00, 0x00, 0x00, \
100 0x00, 0x00, 0x00, 0x00, \
101 0x00, 0x00, 0x00, 0x01 }}
109#define IPV6_ADDR_LINK_LOCAL_PREFIX {{ 0xfe, 0x80, 0x00, 0x00, \
110 0x00, 0x00, 0x00, 0x00, \
111 0x00, 0x00, 0x00, 0x00, \
112 0x00, 0x00, 0x00, 0x00 }}
113
122#define IPV6_ADDR_ALL_NODES_IF_LOCAL {{ 0xff, 0x01, 0x00, 0x00, \
123 0x00, 0x00, 0x00, 0x00, \
124 0x00, 0x00, 0x00, 0x00, \
125 0x00, 0x00, 0x00, 0x01 }}
126
135#define IPV6_ADDR_ALL_NODES_LINK_LOCAL {{ 0xff, 0x02, 0x00, 0x00, \
136 0x00, 0x00, 0x00, 0x00, \
137 0x00, 0x00, 0x00, 0x00, \
138 0x00, 0x00, 0x00, 0x01 }}
139
148#define IPV6_ADDR_ALL_ROUTERS_IF_LOCAL {{ 0xff, 0x01, 0x00, 0x00, \
149 0x00, 0x00, 0x00, 0x00, \
150 0x00, 0x00, 0x00, 0x00, \
151 0x00, 0x00, 0x00, 0x02 }}
152
161#define IPV6_ADDR_ALL_ROUTERS_LINK_LOCAL {{ 0xff, 0x02, 0x00, 0x00, \
162 0x00, 0x00, 0x00, 0x00, \
163 0x00, 0x00, 0x00, 0x00, \
164 0x00, 0x00, 0x00, 0x02 }}
165
174#define IPV6_ADDR_ALL_ROUTERS_SITE_LOCAL {{ 0xff, 0x05, 0x00, 0x00, \
175 0x00, 0x00, 0x00, 0x00, \
176 0x00, 0x00, 0x00, 0x00, \
177 0x00, 0x00, 0x00, 0x02 }}
178
187#define IPV6_ADDR_SOLICITED_NODE_PREFIX {{ 0xff, 0x02, 0x00, 0x00, \
188 0x00, 0x00, 0x00, 0x00, \
189 0x00, 0x00, 0x00, 0x01, \
190 0xff, 0x00, 0x00, 0x00 }}
191
205#define IPV6_ADDR_MCAST_FLAG_TRANSIENT (0x01)
206
214#define IPV6_ADDR_MCAST_FLAG_PREFIX_BASED (0x02)
215
223#define IPV6_ADDR_MCAST_FLAG_EMBED_ON_RP (0x04)
235#define IPV6_ADDR_MCAST_SCP_IF_LOCAL (0x1)
236#define IPV6_ADDR_MCAST_SCP_LINK_LOCAL (0x2)
248#define IPV6_ADDR_MCAST_SCP_REALM_LOCAL (0x3)
249#define IPV6_ADDR_MCAST_SCP_ADMIN_LOCAL (0x4)
250#define IPV6_ADDR_MCAST_SCP_SITE_LOCAL (0x5)
251#define IPV6_ADDR_MCAST_SCP_ORG_LOCAL (0x8)
252#define IPV6_ADDR_MCAST_SCP_GLOBAL (0xe)
263
268
273
278
283
288
293
298
319static inline bool ipv6_addr_is_unspecified(const ipv6_addr_t *addr)
320{
321 return (memcmp(addr, &ipv6_addr_unspecified, sizeof(ipv6_addr_t)) == 0);
322}
323
336static inline bool ipv6_addr_is_loopback(const ipv6_addr_t *addr)
337{
338 return (memcmp(addr, &ipv6_addr_loopback, sizeof(ipv6_addr_t)) == 0);
339}
340
353static inline bool ipv6_addr_is_ipv4_compat(const ipv6_addr_t *addr)
354{
355 return (memcmp(addr, &ipv6_addr_unspecified,
356 sizeof(ipv6_addr_t) - sizeof(ipv4_addr_t)) == 0);
357}
358
371static inline bool ipv6_addr_is_ipv4_mapped(const ipv6_addr_t *addr)
372{
373 return ((memcmp(addr, &ipv6_addr_unspecified,
374 sizeof(ipv6_addr_t) - sizeof(ipv4_addr_t) - 2) == 0) &&
375 (addr->u16[5].u16 == 0xffff));
376}
377
390static inline bool ipv6_addr_is_multicast(const ipv6_addr_t *addr)
391{
392 return (addr->u8[0] == 0xff);
393}
394
410static inline bool ipv6_addr_is_link_local(const ipv6_addr_t *addr)
411{
412 return (memcmp(addr, &ipv6_addr_link_local_prefix, sizeof(addr->u64[0])) == 0) ||
413 (ipv6_addr_is_multicast(addr) &&
414 (addr->u8[1] & 0x0f) == IPV6_ADDR_MCAST_SCP_LINK_LOCAL);
415}
416
433static inline bool ipv6_addr_is_site_local(const ipv6_addr_t *addr)
434{
435 return (((byteorder_ntohs(addr->u16[0]) & 0xffc0) ==
437 (ipv6_addr_is_multicast(addr) &&
438 (addr->u8[1] & 0x0f) == IPV6_ADDR_MCAST_SCP_SITE_LOCAL));
439}
440
453static inline bool ipv6_addr_is_unique_local_unicast(const ipv6_addr_t *addr)
454{
455 return ((addr->u8[0] == 0xfc) || (addr->u8[0] == 0xfd));
456}
457
470static inline bool ipv6_addr_is_global(const ipv6_addr_t *addr)
471{
472 /* first check for multicast with global scope */
473 if (ipv6_addr_is_multicast(addr)) {
474 return ((addr->u8[1] & 0x0f) == IPV6_ADDR_MCAST_SCP_GLOBAL);
475 }
476 else {
477 return !(ipv6_addr_is_link_local(addr) ||
480 }
481}
482
495static inline bool ipv6_addr_is_solicited_node(const ipv6_addr_t *addr)
496{
497 return (memcmp(addr, &ipv6_addr_solicited_node_prefix,
498 sizeof(ipv6_addr_t) - 3) == 0);
499}
500
510bool ipv6_addr_equal(const ipv6_addr_t *a, const ipv6_addr_t *b);
511
522
532void ipv6_addr_init_prefix(ipv6_addr_t *out, const ipv6_addr_t *prefix, uint8_t bits);
533
541static inline void ipv6_addr_init(ipv6_addr_t *out, uint64_t prefix, uint64_t iid)
542{
543 out->u64[0] = byteorder_htonll(prefix);
544 out->u64[1] = byteorder_htonll(iid);
545}
546
556void ipv6_addr_init_iid(ipv6_addr_t *out, const uint8_t *iid, uint8_t bits);
557
567static inline void ipv6_addr_set_unspecified(ipv6_addr_t *addr)
568{
569 memset(addr, 0, sizeof(ipv6_addr_t));
570}
571
581static inline void ipv6_addr_set_loopback(ipv6_addr_t *addr)
582{
583 memset(addr, 0, sizeof(ipv6_addr_t));
584 addr->u8[15] = 1;
585}
586
597{
598 memcpy(addr, &ipv6_addr_link_local_prefix, sizeof(addr->u64[0]));
599}
600
612static inline void ipv6_addr_set_iid(ipv6_addr_t *addr, uint64_t iid)
613{
614 addr->u64[1] = byteorder_htonll(iid);
615}
616
628static inline void ipv6_addr_set_aiid(ipv6_addr_t *addr, uint8_t *iid)
629{
630 memcpy(&addr->u64[1], iid, sizeof(addr->u64[1]));
631}
632
644static inline void ipv6_addr_set_multicast(ipv6_addr_t *addr, unsigned int flags,
645 unsigned int scope)
646{
647 addr->u8[0] = 0xff;
648 addr->u8[1] = (((uint8_t)flags) << 4) | (((uint8_t) scope) & 0x0f);
649}
650
662static inline void ipv6_addr_set_all_nodes_multicast(ipv6_addr_t *addr, unsigned int scope)
663{
664 memcpy(addr, &ipv6_addr_all_nodes_if_local, sizeof(ipv6_addr_t));
665 addr->u8[1] = (uint8_t)scope;
666}
667
679static inline void ipv6_addr_set_all_routers_multicast(ipv6_addr_t *addr, unsigned int scope)
680{
681 memcpy(addr, &ipv6_addr_all_routers_if_local, sizeof(ipv6_addr_t));
682 addr->u8[1] = (uint8_t)scope;
683}
684
696static inline void ipv6_addr_set_solicited_nodes(ipv6_addr_t *out, const ipv6_addr_t *in)
697{
698 out->u64[0] = byteorder_htonll(0xff02000000000000ull);
699 out->u32[2] = byteorder_htonl(1);
700 out->u8[12] = 0xff;
701 out->u8[13] = in->u8[13];
702 out->u16[7] = in->u16[7];
703}
704
721char *ipv6_addr_to_str(char *result, const ipv6_addr_t *addr, uint8_t result_len);
722
738ipv6_addr_t *ipv6_addr_from_str(ipv6_addr_t *result, const char *addr);
739
754int ipv6_prefix_from_str(ipv6_addr_t *result, const char *prefix);
755
774ipv6_addr_t *ipv6_addr_from_buf(ipv6_addr_t *result, const char *addr,
775 size_t addr_len);
776
789char *ipv6_addr_split_str(char *addr_str, char separator);
790
803int ipv6_addr_split_int(char *addr_str, char separator, int _default);
804
813static inline int ipv6_addr_split_prefix(char *addr_str)
814{
815 return ipv6_addr_split_int(addr_str, '/', 128);
816}
817
827static inline char *ipv6_addr_split_iface(char *addr_str)
828{
829 return ipv6_addr_split_str(addr_str, '%');
830}
831
837void ipv6_addr_print(const ipv6_addr_t *addr);
838
846void ipv6_addrs_print(const ipv6_addr_t *addrs, size_t num,
847 const char *separator);
848
849#ifdef __cplusplus
850}
851#endif
852
853#endif /* NET_IPV6_ADDR_H */
Functions to work with different byte orders.
static network_uint64_t byteorder_htonll(uint64_t v)
Convert from host byte order to network byte order, 64 bit.
Definition byteorder.h:499
static uint16_t byteorder_ntohs(network_uint16_t v)
Convert from network byte order to host byte order, 16 bit.
Definition byteorder.h:506
static network_uint32_t byteorder_htonl(uint32_t v)
Convert from host byte order to network byte order, 32 bit.
Definition byteorder.h:492
static void ipv6_addr_set_unspecified(ipv6_addr_t *addr)
Sets addr dynamically to the unspecified IPv6 address (::).
Definition addr.h:567
static bool ipv6_addr_is_multicast(const ipv6_addr_t *addr)
Check if addr is a multicast address.
Definition addr.h:390
const ipv6_addr_t ipv6_addr_all_routers_link_local
static void ipv6_addr_set_loopback(ipv6_addr_t *addr)
Sets addr dynamically to the loopback IPv6 address (::1).
Definition addr.h:581
static bool ipv6_addr_is_loopback(const ipv6_addr_t *addr)
Checks if addr is a loopback address.
Definition addr.h:336
static bool ipv6_addr_is_global(const ipv6_addr_t *addr)
Check if addr is global unicast address.
Definition addr.h:470
char * ipv6_addr_to_str(char *result, const ipv6_addr_t *addr, uint8_t result_len)
Converts an IPv6 address to its string representation.
void ipv6_addrs_print(const ipv6_addr_t *addrs, size_t num, const char *separator)
Print IPv6 addresses to stdout.
#define IPV6_ADDR_MCAST_SCP_SITE_LOCAL
site-local scope
Definition addr.h:250
const ipv6_addr_t ipv6_addr_all_nodes_link_local
ipv6_addr_t * ipv6_addr_from_buf(ipv6_addr_t *result, const char *addr, size_t addr_len)
Converts an IPv6 address from a buffer of characters to a byte-represented IPv6 address.
static void ipv6_addr_set_solicited_nodes(ipv6_addr_t *out, const ipv6_addr_t *in)
Set out to the solicited-node multicast address computed from in.
Definition addr.h:696
static void ipv6_addr_set_link_local_prefix(ipv6_addr_t *addr)
Sets the first 64 bit of addr to link local prefix (fe08::/64).
Definition addr.h:596
#define IPV6_ADDR_MCAST_SCP_LINK_LOCAL
link-local scope
Definition addr.h:236
static void ipv6_addr_set_aiid(ipv6_addr_t *addr, uint8_t *iid)
Sets the 64-bit interface ID (as array) of a unicast or anycast IPv6 address.
Definition addr.h:628
#define IPV6_ADDR_SITE_LOCAL_PREFIX
The first 10 bits of a site-local IPv6 unicast address.
Definition addr.h:67
static int ipv6_addr_split_prefix(char *addr_str)
split IPv6 prefix string representation
Definition addr.h:813
const ipv6_addr_t ipv6_addr_all_routers_site_local
void ipv6_addr_print(const ipv6_addr_t *addr)
Print IPv6 address to stdout.
const ipv6_addr_t ipv6_addr_all_nodes_if_local
const ipv6_addr_t ipv6_addr_loopback
void ipv6_addr_init_iid(ipv6_addr_t *out, const uint8_t *iid, uint8_t bits)
Sets the last bits of IPv6 address out to iid.
#define IPV6_ADDR_MCAST_SCP_GLOBAL
global scope
Definition addr.h:252
static bool ipv6_addr_is_link_local(const ipv6_addr_t *addr)
Check if addr is a link-local address.
Definition addr.h:410
static bool ipv6_addr_is_site_local(const ipv6_addr_t *addr)
Checks if addr is a site-local address.
Definition addr.h:433
char * ipv6_addr_split_str(char *addr_str, char separator)
split IPv6 address string representation and return remaining string
static void ipv6_addr_set_all_nodes_multicast(ipv6_addr_t *addr, unsigned int scope)
Sets addr dynamically to an all nodes multicast IPv6 address (ff0S::1, where S is the scope).
Definition addr.h:662
static void ipv6_addr_init(ipv6_addr_t *out, uint64_t prefix, uint64_t iid)
Sets IPv6 address out with a given prefix and interface ID.
Definition addr.h:541
bool ipv6_addr_equal(const ipv6_addr_t *a, const ipv6_addr_t *b)
Checks if two IPv6 addresses are equal.
ipv6_addr_t * ipv6_addr_from_str(ipv6_addr_t *result, const char *addr)
Converts an IPv6 address string representation to a byte-represented IPv6 address.
const ipv6_addr_t ipv6_addr_link_local_prefix
static bool ipv6_addr_is_ipv4_compat(const ipv6_addr_t *addr)
Checks if addr is a IPv4-compatible IPv6 address.
Definition addr.h:353
int ipv6_prefix_from_str(ipv6_addr_t *result, const char *prefix)
Converts an IPv6 prefix string representation to a byte-represented IPv6 address.
static void ipv6_addr_set_all_routers_multicast(ipv6_addr_t *addr, unsigned int scope)
Sets addr dynamically to an all routers multicast IPv6 address (ff0S::2, where S is the scope).
Definition addr.h:679
static bool ipv6_addr_is_unique_local_unicast(const ipv6_addr_t *addr)
Check if addr is unique local unicast address.
Definition addr.h:453
static char * ipv6_addr_split_iface(char *addr_str)
split IPv6 address + interface specifier
Definition addr.h:827
void ipv6_addr_init_prefix(ipv6_addr_t *out, const ipv6_addr_t *prefix, uint8_t bits)
Sets IPv6 address out with the first bits taken from prefix and leaves the remaining bits untouched.
const ipv6_addr_t ipv6_addr_unspecified
In-memory constants of defined addresses and prefixes.
static bool ipv6_addr_is_solicited_node(const ipv6_addr_t *addr)
Check if addr is solicited-node multicast address.
Definition addr.h:495
const ipv6_addr_t ipv6_addr_solicited_node_prefix
int ipv6_addr_split_int(char *addr_str, char separator, int _default)
split IPv6 address string representation
static bool ipv6_addr_is_ipv4_mapped(const ipv6_addr_t *addr)
Checks if addr is a IPv4-mapped IPv6 address.
Definition addr.h:371
static void ipv6_addr_set_multicast(ipv6_addr_t *addr, unsigned int flags, unsigned int scope)
Sets the bits for an address required to be a multicast address.
Definition addr.h:644
uint8_t ipv6_addr_match_prefix(const ipv6_addr_t *a, const ipv6_addr_t *b)
Checks up to which bit-count two IPv6 addresses match in their prefix.
static void ipv6_addr_set_iid(ipv6_addr_t *addr, uint64_t iid)
Sets the 64-bit interface ID (as integer) of a unicast or anycast IPv6 address.
Definition addr.h:612
static bool ipv6_addr_is_unspecified(const ipv6_addr_t *addr)
Checks if addr is unspecified (all zero).
Definition addr.h:319
const ipv6_addr_t ipv6_addr_all_routers_if_local
IPv4 address type and helper functions definitions.
A 16 bit integer in big endian aka network byte order.
Definition byteorder.h:74
uint16_t u16
16 bit representation
Definition byteorder.h:75
A 32 bit integer in big endian aka network byte order.
Definition byteorder.h:84
A 64 bit integer in big endian aka network byte order.
Definition byteorder.h:96
Data type to represent an IPv4 address.
Definition addr.h:53
Data type to represent an IPv6 address.
Definition addr.h:72
uint8_t u8[16]
divided by 16 8-bit words.
Definition addr.h:73
network_uint64_t u64[2]
divided by 2 64-bit words.
Definition addr.h:76
network_uint32_t u32[4]
divided by 4 32-bit words.
Definition addr.h:75
network_uint16_t u16[8]
divided by 8 16-bit words.
Definition addr.h:74