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
36 extern "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 
72 typedef union {
73  uint8_t u8[16];
77 } ipv6_addr_t;
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 
267 extern const ipv6_addr_t ipv6_addr_loopback;
268 
273 
278 
283 
288 
293 
298 
319 static 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 
336 static 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 
353 static 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 
371 static 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 
390 static inline bool ipv6_addr_is_multicast(const ipv6_addr_t *addr)
391 {
392  return (addr->u8[0] == 0xff);
393 }
394 
410 static 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 
433 static 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 
453 static 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 
470 static 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) ||
478  ipv6_addr_is_unspecified(addr) ||
479  ipv6_addr_is_loopback(addr));
480  }
481 }
482 
495 static 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 
510 bool ipv6_addr_equal(const ipv6_addr_t *a, const ipv6_addr_t *b);
511 
521 uint8_t ipv6_addr_match_prefix(const ipv6_addr_t *a, const ipv6_addr_t *b);
522 
532 void ipv6_addr_init_prefix(ipv6_addr_t *out, const ipv6_addr_t *prefix, uint8_t bits);
533 
543 void ipv6_addr_init_iid(ipv6_addr_t *out, const uint8_t *iid, uint8_t bits);
544 
554 static inline void ipv6_addr_set_unspecified(ipv6_addr_t *addr)
555 {
556  memset(addr, 0, sizeof(ipv6_addr_t));
557 }
558 
568 static inline void ipv6_addr_set_loopback(ipv6_addr_t *addr)
569 {
570  memset(addr, 0, sizeof(ipv6_addr_t));
571  addr->u8[15] = 1;
572 }
573 
584 {
585  memcpy(addr, &ipv6_addr_link_local_prefix, sizeof(addr->u64[0]));
586 }
587 
599 static inline void ipv6_addr_set_iid(ipv6_addr_t *addr, uint64_t iid)
600 {
601  addr->u64[1] = byteorder_htonll(iid);
602 }
603 
615 static inline void ipv6_addr_set_aiid(ipv6_addr_t *addr, uint8_t *iid)
616 {
617  memcpy(&addr->u64[1], iid, sizeof(addr->u64[1]));
618 }
619 
631 static inline void ipv6_addr_set_multicast(ipv6_addr_t *addr, unsigned int flags,
632  unsigned int scope)
633 {
634  addr->u8[0] = 0xff;
635  addr->u8[1] = (((uint8_t)flags) << 4) | (((uint8_t) scope) & 0x0f);
636 }
637 
649 static inline void ipv6_addr_set_all_nodes_multicast(ipv6_addr_t *addr, unsigned int scope)
650 {
651  memcpy(addr, &ipv6_addr_all_nodes_if_local, sizeof(ipv6_addr_t));
652  addr->u8[1] = (uint8_t)scope;
653 }
654 
666 static inline void ipv6_addr_set_all_routers_multicast(ipv6_addr_t *addr, unsigned int scope)
667 {
668  memcpy(addr, &ipv6_addr_all_routers_if_local, sizeof(ipv6_addr_t));
669  addr->u8[1] = (uint8_t)scope;
670 }
671 
683 static inline void ipv6_addr_set_solicited_nodes(ipv6_addr_t *out, const ipv6_addr_t *in)
684 {
685  out->u64[0] = byteorder_htonll(0xff02000000000000ull);
686  out->u32[2] = byteorder_htonl(1);
687  out->u8[12] = 0xff;
688  out->u8[13] = in->u8[13];
689  out->u16[7] = in->u16[7];
690 }
691 
708 char *ipv6_addr_to_str(char *result, const ipv6_addr_t *addr, uint8_t result_len);
709 
725 ipv6_addr_t *ipv6_addr_from_str(ipv6_addr_t *result, const char *addr);
726 
745 ipv6_addr_t *ipv6_addr_from_buf(ipv6_addr_t *result, const char *addr,
746  size_t addr_len);
747 
760 char *ipv6_addr_split_str(char *addr_str, char separator);
761 
774 int ipv6_addr_split_int(char *addr_str, char separator, int _default);
775 
784 static inline int ipv6_addr_split_prefix(char *addr_str)
785 {
786  return ipv6_addr_split_int(addr_str, '/', 128);
787 }
788 
798 static inline char *ipv6_addr_split_iface(char *addr_str)
799 {
800  return ipv6_addr_split_str(addr_str, '%');
801 }
802 
808 void ipv6_addr_print(const ipv6_addr_t *addr);
809 
810 #ifdef __cplusplus
811 }
812 #endif
813 
814 #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:539
static uint16_t byteorder_ntohs(network_uint16_t v)
Convert from network byte order to host byte order, 16 bit.
Definition: byteorder.h:546
static network_uint32_t byteorder_htonl(uint32_t v)
Convert from host byte order to network byte order, 32 bit.
Definition: byteorder.h:532
static void ipv6_addr_set_unspecified(ipv6_addr_t *addr)
Sets addr dynamically to the unspecified IPv6 address (::).
Definition: addr.h:554
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:568
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
#define IPV6_ADDR_MCAST_SCP_SITE_LOCAL
site-local scope
Definition: addr.h:250
const ipv6_addr_t ipv6_addr_all_nodes_link_local
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:683
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:583
#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:615
#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:784
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
static char * ipv6_addr_split_iface(char *addr_str)
split IPv6 address + interface specifier
Definition: addr.h:798
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.
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.
#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
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 bool ipv6_addr_is_site_local(const ipv6_addr_t *addr)
Checks if addr is a site-local address.
Definition: addr.h:433
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:649
bool ipv6_addr_equal(const ipv6_addr_t *a, const ipv6_addr_t *b)
Checks if two IPv6 addresses are equal.
const ipv6_addr_t ipv6_addr_link_local_prefix
char * ipv6_addr_to_str(char *result, const ipv6_addr_t *addr, uint8_t result_len)
Converts an IPv6 address to its string representation.
char * ipv6_addr_split_str(char *addr_str, char separator)
split IPv6 address string representation and return remaining string
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
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:666
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
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:631
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:599
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
IPv6 address type and helper functions definitions.
A 16 bit integer in big endian aka network byte order.
Definition: byteorder.h:77
uint16_t u16
16 bit representation
Definition: byteorder.h:78
A 32 bit integer in big endian aka network byte order.
Definition: byteorder.h:87
A 64 bit integer in big endian aka network byte order.
Definition: byteorder.h:99
Data type to represent an IPv4 address.
Definition: addr.h:41
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