net_ip.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_NET_IP_H_
#define ZEPHYR_INCLUDE_NET_NET_IP_H_
 
#include <string.h>
#include <zephyr/types.h>
#include <stdbool.h>
#include <zephyr/sys/util.h>
#include <zephyr/sys/byteorder.h>
#include <zephyr/toolchain.h>
 
#include <zephyr/net/net_linkaddr.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Specifying VLAN tag here in order to avoid circular dependencies */
#define NET_VLAN_TAG_UNSPEC 0x0fff
/* Protocol families. */
#define PF_UNSPEC       0          
#define PF_INET         1          
#define PF_INET6        2          
#define PF_PACKET       3          
#define PF_CAN          4          
#define PF_NET_MGMT     5          
#define PF_LOCAL        6          
#define PF_UNIX         PF_LOCAL   
/* Address families. */
#define AF_UNSPEC      PF_UNSPEC   
#define AF_INET        PF_INET     
#define AF_INET6       PF_INET6    
#define AF_PACKET      PF_PACKET   
#define AF_CAN         PF_CAN      
#define AF_NET_MGMT    PF_NET_MGMT 
#define AF_LOCAL       PF_LOCAL    
#define AF_UNIX        PF_UNIX     
enum net_ip_protocol {
        IPPROTO_IP = 0,            
        IPPROTO_ICMP = 1,          
        IPPROTO_IGMP = 2,          
        IPPROTO_IPIP = 4,          
        IPPROTO_TCP = 6,           
        IPPROTO_UDP = 17,          
        IPPROTO_IPV6 = 41,         
        IPPROTO_ICMPV6 = 58,       
        IPPROTO_RAW = 255,         
};
 
enum net_ip_protocol_secure {
        IPPROTO_TLS_1_0 = 256,     
        IPPROTO_TLS_1_1 = 257,     
        IPPROTO_TLS_1_2 = 258,     
        IPPROTO_DTLS_1_0 = 272,    
        IPPROTO_DTLS_1_2 = 273,    
};
 
enum net_sock_type {
        SOCK_STREAM = 1,           
        SOCK_DGRAM,                
        SOCK_RAW                   
};
 
#define ntohs(x) sys_be16_to_cpu(x)
 
#define ntohl(x) sys_be32_to_cpu(x)
 
#define ntohll(x) sys_be64_to_cpu(x)
 
#define htons(x) sys_cpu_to_be16(x)
 
#define htonl(x) sys_cpu_to_be32(x)
 
#define htonll(x) sys_cpu_to_be64(x)
 
struct in6_addr {
        union {
                uint8_t s6_addr[16];   
                uint16_t s6_addr16[8]; 
                uint32_t s6_addr32[4]; 
        };
};
 
#define NET_IPV6_ADDR_SIZE 16
 
struct in_addr {
        union {
                uint8_t s4_addr[4];    
                uint16_t s4_addr16[2]; 
                uint32_t s4_addr32[1]; 
                uint32_t s_addr; 
        };
};
 
#define NET_IPV4_ADDR_SIZE 4
 
typedef unsigned short int sa_family_t;
 
#ifndef __socklen_t_defined
typedef size_t socklen_t;
#define __socklen_t_defined
#endif
 
/*
 * Note that the sin_port and sin6_port are in network byte order
 * in various sockaddr* structs.
 */
 
struct sockaddr_in6 {
        sa_family_t             sin6_family;   
        uint16_t                sin6_port;     
        struct in6_addr         sin6_addr;     
        uint8_t                 sin6_scope_id; 
};
 
struct sockaddr_in {
        sa_family_t             sin_family;    
        uint16_t                sin_port;      
        struct in_addr          sin_addr;      
};
 
struct sockaddr_ll {
        sa_family_t sll_family;   
        uint16_t    sll_protocol; 
        int         sll_ifindex;  
        uint16_t    sll_hatype;   
        uint8_t     sll_pkttype;  
        uint8_t     sll_halen;    
        uint8_t     sll_addr[8];  
};
 
struct sockaddr_in6_ptr {
        sa_family_t             sin6_family;   
        uint16_t                sin6_port;     
        struct in6_addr         *sin6_addr;    
        uint8_t                 sin6_scope_id; 
};
 
struct sockaddr_in_ptr {
        sa_family_t             sin_family;    
        uint16_t                sin_port;      
        struct in_addr          *sin_addr;     
};
 
struct sockaddr_ll_ptr {
        sa_family_t sll_family;   
        uint16_t    sll_protocol; 
        int         sll_ifindex;  
        uint16_t    sll_hatype;   
        uint8_t     sll_pkttype;  
        uint8_t     sll_halen;    
        uint8_t     *sll_addr;    
};
 
struct sockaddr_can_ptr {
        sa_family_t can_family;
        int         can_ifindex;
};
 
#if !defined(HAVE_IOVEC)
struct iovec {
        void  *iov_base; 
        size_t iov_len;  
};
#endif
 
struct msghdr {
        void         *msg_name;       
        socklen_t     msg_namelen;    
        struct iovec *msg_iov;        
        size_t        msg_iovlen;     
        void         *msg_control;    
        size_t        msg_controllen; 
        int           msg_flags;      
};
 
struct cmsghdr {
        socklen_t cmsg_len;    
        int       cmsg_level;  
        int       cmsg_type;   
        z_max_align_t cmsg_data[]; 
};
 
/* Alignment for headers and data. These are arch specific but define
 * them here atm if not found alredy.
 */
#if !defined(ALIGN_H)
#define ALIGN_H(x) ROUND_UP(x, __alignof__(struct cmsghdr))
#endif
#if !defined(ALIGN_D)
#define ALIGN_D(x) ROUND_UP(x, __alignof__(z_max_align_t))
#endif
 
#if !defined(CMSG_FIRSTHDR)
#define CMSG_FIRSTHDR(msghdr)                                   \
        ((msghdr)->msg_controllen >= sizeof(struct cmsghdr) ?   \
         (struct cmsghdr *)((msghdr)->msg_control) : NULL)
#endif
 
#if !defined(CMSG_NXTHDR)
#define CMSG_NXTHDR(msghdr, cmsg)                                        \
        (((cmsg) == NULL) ? CMSG_FIRSTHDR(msghdr) :                      \
         (((uint8_t *)(cmsg) + ALIGN_H((cmsg)->cmsg_len) +               \
           ALIGN_D(sizeof(struct cmsghdr)) >                             \
           (uint8_t *)((msghdr)->msg_control) + (msghdr)->msg_controllen) ? \
          NULL :                                                         \
          (struct cmsghdr *)((uint8_t *)(cmsg) +                         \
                             ALIGN_H((cmsg)->cmsg_len))))
#endif
 
#if !defined(CMSG_DATA)
#define CMSG_DATA(cmsg) ((uint8_t *)(cmsg) + ALIGN_D(sizeof(struct cmsghdr)))
#endif
 
#if !defined(CMSG_SPACE)
#define CMSG_SPACE(length) (ALIGN_D(sizeof(struct cmsghdr)) + ALIGN_H(length))
#endif
 
#if !defined(CMSG_LEN)
#define CMSG_LEN(length) (ALIGN_D(sizeof(struct cmsghdr)) + length)
#endif
 
/* Packet types.  */
#define PACKET_HOST         0     /* To us            */
#define PACKET_BROADCAST    1     /* To all           */
#define PACKET_MULTICAST    2     /* To group         */
#define PACKET_OTHERHOST    3     /* To someone else  */
#define PACKET_OUTGOING     4     /* Originated by us */
#define PACKET_LOOPBACK     5
#define PACKET_FASTROUTE    6
 
/* ARP protocol HARDWARE identifiers. */
#define ARPHRD_ETHER 1
 
/* Note: These macros are defined in a specific order.
 * The largest sockaddr size is the last one.
 */
#if defined(CONFIG_NET_IPV4)
#undef NET_SOCKADDR_MAX_SIZE
#undef NET_SOCKADDR_PTR_MAX_SIZE
#define NET_SOCKADDR_MAX_SIZE (sizeof(struct sockaddr_in))
#define NET_SOCKADDR_PTR_MAX_SIZE (sizeof(struct sockaddr_in_ptr))
#endif
 
#if defined(CONFIG_NET_SOCKETS_PACKET)
#undef NET_SOCKADDR_MAX_SIZE
#undef NET_SOCKADDR_PTR_MAX_SIZE
#define NET_SOCKADDR_MAX_SIZE (sizeof(struct sockaddr_ll))
#define NET_SOCKADDR_PTR_MAX_SIZE (sizeof(struct sockaddr_ll_ptr))
#endif
 
#if defined(CONFIG_NET_IPV6)
#undef NET_SOCKADDR_MAX_SIZE
#define NET_SOCKADDR_MAX_SIZE (sizeof(struct sockaddr_in6))
#if !defined(CONFIG_NET_SOCKETS_PACKET)
#undef NET_SOCKADDR_PTR_MAX_SIZE
#define NET_SOCKADDR_PTR_MAX_SIZE (sizeof(struct sockaddr_in6_ptr))
#endif
#endif
 
#if !defined(CONFIG_NET_IPV4)
#if !defined(CONFIG_NET_IPV6)
#if !defined(CONFIG_NET_SOCKETS_PACKET)
#define NET_SOCKADDR_MAX_SIZE (sizeof(struct sockaddr_in6))
#define NET_SOCKADDR_PTR_MAX_SIZE (sizeof(struct sockaddr_in6_ptr))
#endif
#endif
#endif
 
struct sockaddr {
        sa_family_t sa_family; 
        char data[NET_SOCKADDR_MAX_SIZE - sizeof(sa_family_t)];
};
 
struct sockaddr_ptr {
        sa_family_t family;
        char data[NET_SOCKADDR_PTR_MAX_SIZE - sizeof(sa_family_t)];
};
 
/* Same as sockaddr in our case */
struct sockaddr_storage {
        sa_family_t ss_family;
        char data[NET_SOCKADDR_MAX_SIZE - sizeof(sa_family_t)];
};
 
/* Socket address struct for UNIX domain sockets */
struct sockaddr_un {
        sa_family_t sun_family;    /* AF_UNIX */
        char        sun_path[NET_SOCKADDR_MAX_SIZE - sizeof(sa_family_t)];
};
 
struct net_addr {
        sa_family_t family;
        union {
                struct in6_addr in6_addr;
                struct in_addr in_addr;
        };
};
 
extern const struct in6_addr in6addr_any;
 
extern const struct in6_addr in6addr_loopback;
 
#define IN6ADDR_ANY_INIT { { { 0, 0, 0, 0, 0, 0, 0, 0, 0, \
                                0, 0, 0, 0, 0, 0, 0 } } }
 
#define IN6ADDR_LOOPBACK_INIT { { { 0, 0, 0, 0, 0, 0, 0, \
                                0, 0, 0, 0, 0, 0, 0, 0, 1 } } }
 
#define INADDR_ANY 0
 
#define INADDR_ANY_INIT { { { INADDR_ANY } } }
 
#define INADDR_LOOPBACK_INIT  { { { 127, 0, 0, 1 } } }
 
#define INET_ADDRSTRLEN 16
#define INET6_ADDRSTRLEN 46
 
/* These are for internal usage of the stack */
#define NET_IPV6_ADDR_LEN sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx")
#define NET_IPV4_ADDR_LEN sizeof("xxx.xxx.xxx.xxx")
 
enum net_ip_mtu {
#if defined(CONFIG_NET_NATIVE_IPV6)
        NET_IPV6_MTU = CONFIG_NET_IPV6_MTU,
#else
        NET_IPV6_MTU = 1280,
#endif
 
        NET_IPV4_MTU = 576,
};
 
enum net_priority {
        NET_PRIORITY_BK = 1, 
        NET_PRIORITY_BE = 0, 
        NET_PRIORITY_EE = 2, 
        NET_PRIORITY_CA = 3, 
        NET_PRIORITY_VI = 4, 
        NET_PRIORITY_VO = 5, 
        NET_PRIORITY_IC = 6, 
        NET_PRIORITY_NC = 7  
} __packed;
 
#define NET_MAX_PRIORITIES 8 
struct net_tuple {
        struct net_addr *remote_addr;  
        struct net_addr *local_addr;   
        uint16_t remote_port;          
        uint16_t local_port;           
        enum net_ip_protocol ip_proto; 
};
 
enum net_addr_state {
        NET_ADDR_ANY_STATE = -1, 
        NET_ADDR_TENTATIVE = 0,  
        NET_ADDR_PREFERRED,      
        NET_ADDR_DEPRECATED,     
} __packed;
 
enum net_addr_type {
        NET_ADDR_ANY = 0,
        NET_ADDR_AUTOCONF,
        NET_ADDR_DHCP,
        NET_ADDR_MANUAL,
        NET_ADDR_OVERRIDABLE,
} __packed;
 
struct net_ipv6_hdr {
        uint8_t vtc;
        uint8_t tcflow;
        uint16_t flow;
        uint16_t len;
        uint8_t nexthdr;
        uint8_t hop_limit;
        uint8_t src[NET_IPV6_ADDR_SIZE];
        uint8_t dst[NET_IPV6_ADDR_SIZE];
} __packed;
 
struct net_ipv6_frag_hdr {
        uint8_t nexthdr;
        uint8_t reserved;
        uint16_t offset;
        uint32_t id;
} __packed;
 
struct net_ipv4_hdr {
        uint8_t vhl;
        uint8_t tos;
        uint16_t len;
        uint8_t id[2];
        uint8_t offset[2];
        uint8_t ttl;
        uint8_t proto;
        uint16_t chksum;
        uint8_t src[NET_IPV4_ADDR_SIZE];
        uint8_t dst[NET_IPV4_ADDR_SIZE];
} __packed;
 
struct net_icmp_hdr {
        uint8_t type;
        uint8_t code;
        uint16_t chksum;
} __packed;
 
struct net_udp_hdr {
        uint16_t src_port;
        uint16_t dst_port;
        uint16_t len;
        uint16_t chksum;
} __packed;
 
struct net_tcp_hdr {
        uint16_t src_port;
        uint16_t dst_port;
        uint8_t seq[4];
        uint8_t ack[4];
        uint8_t offset;
        uint8_t flags;
        uint8_t wnd[2];
        uint16_t chksum;
        uint8_t urg[2];
        uint8_t optdata[0];
} __packed;
 
static inline const char *net_addr_type2str(enum net_addr_type type)
{
        switch (type) {
        case NET_ADDR_AUTOCONF:
                return "AUTO";
        case NET_ADDR_DHCP:
                return "DHCP";
        case NET_ADDR_MANUAL:
                return "MANUAL";
        case NET_ADDR_OVERRIDABLE:
                return "OVERRIDE";
        case NET_ADDR_ANY:
        default:
                break;
        }
 
        return "<unknown>";
}
 
/* IPv6 extension headers types */
#define NET_IPV6_NEXTHDR_HBHO        0
#define NET_IPV6_NEXTHDR_DESTO       60
#define NET_IPV6_NEXTHDR_ROUTING     43
#define NET_IPV6_NEXTHDR_FRAG        44
#define NET_IPV6_NEXTHDR_NONE        59
 
union net_ip_header {
        struct net_ipv4_hdr *ipv4;
        struct net_ipv6_hdr *ipv6;
};
 
union net_proto_header {
        struct net_udp_hdr *udp;
        struct net_tcp_hdr *tcp;
};
 
#define NET_UDPH_LEN    8                       /* Size of UDP header */
#define NET_TCPH_LEN    20                      /* Size of TCP header */
#define NET_ICMPH_LEN   4                       /* Size of ICMP header */
 
#define NET_IPV6H_LEN      40                   /* Size of IPv6 header */
#define NET_ICMPV6H_LEN    NET_ICMPH_LEN        /* Size of ICMPv6 header */
#define NET_IPV6UDPH_LEN   (NET_UDPH_LEN + NET_IPV6H_LEN) /* IPv6 + UDP */
#define NET_IPV6TCPH_LEN   (NET_TCPH_LEN + NET_IPV6H_LEN) /* IPv6 + TCP */
#define NET_IPV6ICMPH_LEN  (NET_IPV6H_LEN + NET_ICMPH_LEN) /* ICMPv6 + IPv6 */
#define NET_IPV6_FRAGH_LEN 8
 
#define NET_IPV4H_LEN      20                   /* Size of IPv4 header */
#define NET_ICMPV4H_LEN    NET_ICMPH_LEN        /* Size of ICMPv4 header */
#define NET_IPV4UDPH_LEN   (NET_UDPH_LEN + NET_IPV4H_LEN) /* IPv4 + UDP */
#define NET_IPV4TCPH_LEN   (NET_TCPH_LEN + NET_IPV4H_LEN) /* IPv4 + TCP */
#define NET_IPV4ICMPH_LEN  (NET_IPV4H_LEN + NET_ICMPH_LEN) /* ICMPv4 + IPv4 */
 
#define NET_IPV6H_LENGTH_OFFSET         0x04    /* Offset of the Length field in the IPv6 header */
 
#define NET_IPV6_FRAGH_OFFSET_MASK      0xfff8  /* Mask for the 13-bit Fragment Offset field */
#define NET_IPV4_FRAGH_OFFSET_MASK      0x1fff  /* Mask for the 13-bit Fragment Offset field */
#define NET_IPV4_MORE_FRAG_MASK         0x2000  /* Mask for the 1-bit More Fragments field */
#define NET_IPV4_DO_NOT_FRAG_MASK       0x4000  /* Mask for the 1-bit Do Not Fragment field */
 
static inline bool net_ipv6_is_addr_loopback(struct in6_addr *addr)
{
        return UNALIGNED_GET(&addr->s6_addr32[0]) == 0 &&
                UNALIGNED_GET(&addr->s6_addr32[1]) == 0 &&
                UNALIGNED_GET(&addr->s6_addr32[2]) == 0 &&
                ntohl(UNALIGNED_GET(&addr->s6_addr32[3])) == 1;
}
 
static inline bool net_ipv6_is_addr_mcast(const struct in6_addr *addr)
{
        return addr->s6_addr[0] == 0xFF;
}
 
struct net_if;
struct net_if_config;
 
extern struct net_if_addr *net_if_ipv6_addr_lookup(const struct in6_addr *addr,
                                                   struct net_if **iface);
 
static inline bool net_ipv6_is_my_addr(struct in6_addr *addr)
{
        return net_if_ipv6_addr_lookup(addr, NULL) != NULL;
}
 
extern struct net_if_mcast_addr *net_if_ipv6_maddr_lookup(
        const struct in6_addr *addr, struct net_if **iface);
 
static inline bool net_ipv6_is_my_maddr(struct in6_addr *maddr)
{
        return net_if_ipv6_maddr_lookup(maddr, NULL) != NULL;
}
 
static inline bool net_ipv6_is_prefix(const uint8_t *addr1,
                                      const uint8_t *addr2,
                                      uint8_t length)
{
        uint8_t bits = 128 - length;
        uint8_t bytes = length / 8U;
        uint8_t remain = bits % 8;
        uint8_t mask;
 
        if (length > 128) {
                return false;
        }
 
        if (memcmp(addr1, addr2, bytes)) {
                return false;
        }
 
        if (!remain) {
                /* No remaining bits, the prefixes are the same as first
                 * bytes are the same.
                 */
                return true;
        }
 
        /* Create a mask that has remaining most significant bits set */
        mask = (uint8_t)((0xff << (8 - remain)) ^ 0xff) << remain;
 
        return (addr1[bytes] & mask) == (addr2[bytes] & mask);
}
 
static inline bool net_ipv4_is_addr_loopback(struct in_addr *addr)
{
        return addr->s4_addr[0] == 127U;
}
 
static inline bool net_ipv4_is_addr_unspecified(const struct in_addr *addr)
{
        return UNALIGNED_GET(&addr->s_addr) == 0;
}
 
static inline bool net_ipv4_is_addr_mcast(const struct in_addr *addr)
{
        return (ntohl(UNALIGNED_GET(&addr->s_addr)) & 0xF0000000) == 0xE0000000;
}
 
static inline bool net_ipv4_is_ll_addr(const struct in_addr *addr)
{
        return (ntohl(UNALIGNED_GET(&addr->s_addr)) & 0xFFFF0000) == 0xA9FE0000;
}
 
static inline bool net_ipv4_is_private_addr(const struct in_addr *addr)
{
        uint32_t masked_24, masked_16, masked_12, masked_10, masked_8;
 
        masked_24 = ntohl(UNALIGNED_GET(&addr->s_addr)) & 0xFFFFFF00;
        masked_16 = masked_24 & 0xFFFF0000;
        masked_12 = masked_24 & 0xFFF00000;
        masked_10 = masked_24 & 0xFFC00000;
        masked_8 = masked_24 & 0xFF000000;
 
        return masked_8  == 0x0A000000 || /* 10.0.0.0/8      */
               masked_10 == 0x64400000 || /* 100.64.0.0/10   */
               masked_12 == 0xAC100000 || /* 172.16.0.0/12   */
               masked_16 == 0xC0A80000 || /* 192.168.0.0/16  */
               masked_24 == 0xC0000200 || /* 192.0.2.0/24    */
               masked_24 == 0xC0336400 || /* 192.51.100.0/24 */
               masked_24 == 0xCB007100;   /* 203.0.113.0/24  */
}
 
#define net_ipaddr_copy(dest, src) \
        UNALIGNED_PUT(UNALIGNED_GET(src), dest)
 
static inline void net_ipv4_addr_copy_raw(uint8_t *dest,
                                          const uint8_t *src)
{
        net_ipaddr_copy((struct in_addr *)dest, (const struct in_addr *)src);
}
 
static inline void net_ipv6_addr_copy_raw(uint8_t *dest,
                                          const uint8_t *src)
{
        memcpy(dest, src, sizeof(struct in6_addr));
}
 
static inline bool net_ipv4_addr_cmp(const struct in_addr *addr1,
                                     const struct in_addr *addr2)
{
        return UNALIGNED_GET(&addr1->s_addr) == UNALIGNED_GET(&addr2->s_addr);
}
 
static inline bool net_ipv4_addr_cmp_raw(const uint8_t *addr1,
                                         const uint8_t *addr2)
{
        return net_ipv4_addr_cmp((const struct in_addr *)addr1,
                                 (const struct in_addr *)addr2);
}
 
static inline bool net_ipv6_addr_cmp(const struct in6_addr *addr1,
                                     const struct in6_addr *addr2)
{
        return !memcmp(addr1, addr2, sizeof(struct in6_addr));
}
 
static inline bool net_ipv6_addr_cmp_raw(const uint8_t *addr1,
                                         const uint8_t *addr2)
{
        return net_ipv6_addr_cmp((const struct in6_addr *)addr1,
                                 (const struct in6_addr *)addr2);
}
 
static inline bool net_ipv6_is_ll_addr(const struct in6_addr *addr)
{
        return UNALIGNED_GET(&addr->s6_addr16[0]) == htons(0xFE80);
}
 
static inline bool net_ipv6_is_sl_addr(const struct in6_addr *addr)
{
        return UNALIGNED_GET(&addr->s6_addr16[0]) == htons(0xFEC0);
}
 
 
static inline bool net_ipv6_is_ula_addr(const struct in6_addr *addr)
{
        return addr->s6_addr[0] == 0xFD;
}
 
static inline bool net_ipv6_is_global_addr(const struct in6_addr *addr)
{
        return (addr->s6_addr[0] & 0xE0) == 0x20;
}
 
static inline bool net_ipv6_is_private_addr(const struct in6_addr *addr)
{
        uint32_t masked_32, masked_7;
 
        masked_32 = ntohl(UNALIGNED_GET(&addr->s6_addr32[0]));
        masked_7 = masked_32 & 0xfc000000;
 
        return masked_32 == 0x20010db8 || /* 2001:db8::/32 */
               masked_7  == 0xfc000000;   /* fc00::/7      */
}
 
const struct in6_addr *net_ipv6_unspecified_address(void);
 
const struct in_addr *net_ipv4_unspecified_address(void);
 
const struct in_addr *net_ipv4_broadcast_address(void);
 
struct net_if;
extern bool net_if_ipv4_addr_mask_cmp(struct net_if *iface,
                                      const struct in_addr *addr);
 
static inline bool net_ipv4_addr_mask_cmp(struct net_if *iface,
                                          const struct in_addr *addr)
{
        return net_if_ipv4_addr_mask_cmp(iface, addr);
}
 
extern bool net_if_ipv4_is_addr_bcast(struct net_if *iface,
                                      const struct in_addr *addr);
 
#if defined(CONFIG_NET_NATIVE_IPV4)
static inline bool net_ipv4_is_addr_bcast(struct net_if *iface,
                                          const struct in_addr *addr)
{
        if (net_ipv4_addr_cmp(addr, net_ipv4_broadcast_address())) {
                return true;
        }
 
        return net_if_ipv4_is_addr_bcast(iface, addr);
}
#else
static inline bool net_ipv4_is_addr_bcast(struct net_if *iface,
                                          const struct in_addr *addr)
{
        ARG_UNUSED(iface);
        ARG_UNUSED(addr);
 
        return false;
}
#endif
 
extern struct net_if_addr *net_if_ipv4_addr_lookup(const struct in_addr *addr,
                                                   struct net_if **iface);
 
static inline bool net_ipv4_is_my_addr(const struct in_addr *addr)
{
        bool ret;
 
        ret = net_if_ipv4_addr_lookup(addr, NULL) != NULL;
        if (!ret) {
                ret = net_ipv4_is_addr_bcast(NULL, addr);
        }
 
        return ret;
}
 
static inline bool net_ipv6_is_addr_unspecified(const struct in6_addr *addr)
{
        return UNALIGNED_GET(&addr->s6_addr32[0]) == 0 &&
                UNALIGNED_GET(&addr->s6_addr32[1]) == 0 &&
                UNALIGNED_GET(&addr->s6_addr32[2]) == 0 &&
                UNALIGNED_GET(&addr->s6_addr32[3]) == 0;
}
 
static inline bool net_ipv6_is_addr_solicited_node(const struct in6_addr *addr)
{
        return UNALIGNED_GET(&addr->s6_addr32[0]) == htonl(0xff020000) &&
                UNALIGNED_GET(&addr->s6_addr32[1]) == 0x00000000 &&
                UNALIGNED_GET(&addr->s6_addr32[2]) == htonl(0x00000001) &&
                ((UNALIGNED_GET(&addr->s6_addr32[3]) & htonl(0xff000000)) ==
                 htonl(0xff000000));
}
 
static inline bool net_ipv6_is_addr_mcast_scope(const struct in6_addr *addr,
                                                int scope)
{
        return (addr->s6_addr[0] == 0xff) && (addr->s6_addr[1] == scope);
}
 
static inline bool net_ipv6_is_same_mcast_scope(const struct in6_addr *addr_1,
                                                const struct in6_addr *addr_2)
{
        return (addr_1->s6_addr[0] == 0xff) && (addr_2->s6_addr[0] == 0xff) &&
                        (addr_1->s6_addr[1] == addr_2->s6_addr[1]);
}
 
static inline bool net_ipv6_is_addr_mcast_global(const struct in6_addr *addr)
{
        return net_ipv6_is_addr_mcast_scope(addr, 0x0e);
}
 
static inline bool net_ipv6_is_addr_mcast_iface(const struct in6_addr *addr)
{
        return net_ipv6_is_addr_mcast_scope(addr, 0x01);
}
 
static inline bool net_ipv6_is_addr_mcast_link(const struct in6_addr *addr)
{
        return net_ipv6_is_addr_mcast_scope(addr, 0x02);
}
 
static inline bool net_ipv6_is_addr_mcast_mesh(const struct in6_addr *addr)
{
        return net_ipv6_is_addr_mcast_scope(addr, 0x03);
}
 
static inline bool net_ipv6_is_addr_mcast_site(const struct in6_addr *addr)
{
        return net_ipv6_is_addr_mcast_scope(addr, 0x05);
}
 
static inline bool net_ipv6_is_addr_mcast_org(const struct in6_addr *addr)
{
        return net_ipv6_is_addr_mcast_scope(addr, 0x08);
}
 
static inline bool net_ipv6_is_addr_mcast_group(const struct in6_addr *addr,
                                                const struct in6_addr *group)
{
        return UNALIGNED_GET(&addr->s6_addr16[1]) == group->s6_addr16[1] &&
                UNALIGNED_GET(&addr->s6_addr16[2]) == group->s6_addr16[2] &&
                UNALIGNED_GET(&addr->s6_addr16[3]) == group->s6_addr16[3] &&
                UNALIGNED_GET(&addr->s6_addr32[1]) == group->s6_addr32[1] &&
                UNALIGNED_GET(&addr->s6_addr32[2]) == group->s6_addr32[1] &&
                UNALIGNED_GET(&addr->s6_addr32[3]) == group->s6_addr32[3];
}
 
static inline bool
net_ipv6_is_addr_mcast_all_nodes_group(const struct in6_addr *addr)
{
        static const struct in6_addr all_nodes_mcast_group = {
                { { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                    0x00, 0x00, 0x00, 0x00, 0x00, 0x01 } }
        };
 
        return net_ipv6_is_addr_mcast_group(addr, &all_nodes_mcast_group);
}
 
static inline bool
net_ipv6_is_addr_mcast_iface_all_nodes(const struct in6_addr *addr)
{
        return net_ipv6_is_addr_mcast_iface(addr) &&
               net_ipv6_is_addr_mcast_all_nodes_group(addr);
}
 
static inline bool
net_ipv6_is_addr_mcast_link_all_nodes(const struct in6_addr *addr)
{
        return net_ipv6_is_addr_mcast_link(addr) &&
               net_ipv6_is_addr_mcast_all_nodes_group(addr);
}
 
static inline
void net_ipv6_addr_create_solicited_node(const struct in6_addr *src,
                                         struct in6_addr *dst)
{
        dst->s6_addr[0]   = 0xFF;
        dst->s6_addr[1]   = 0x02;
        UNALIGNED_PUT(0, &dst->s6_addr16[1]);
        UNALIGNED_PUT(0, &dst->s6_addr16[2]);
        UNALIGNED_PUT(0, &dst->s6_addr16[3]);
        UNALIGNED_PUT(0, &dst->s6_addr16[4]);
        dst->s6_addr[10]  = 0U;
        dst->s6_addr[11]  = 0x01;
        dst->s6_addr[12]  = 0xFF;
        dst->s6_addr[13]  = src->s6_addr[13];
        UNALIGNED_PUT(UNALIGNED_GET(&src->s6_addr16[7]), &dst->s6_addr16[7]);
}
 
static inline void net_ipv6_addr_create(struct in6_addr *addr,
                                        uint16_t addr0, uint16_t addr1,
                                        uint16_t addr2, uint16_t addr3,
                                        uint16_t addr4, uint16_t addr5,
                                        uint16_t addr6, uint16_t addr7)
{
        UNALIGNED_PUT(htons(addr0), &addr->s6_addr16[0]);
        UNALIGNED_PUT(htons(addr1), &addr->s6_addr16[1]);
        UNALIGNED_PUT(htons(addr2), &addr->s6_addr16[2]);
        UNALIGNED_PUT(htons(addr3), &addr->s6_addr16[3]);
        UNALIGNED_PUT(htons(addr4), &addr->s6_addr16[4]);
        UNALIGNED_PUT(htons(addr5), &addr->s6_addr16[5]);
        UNALIGNED_PUT(htons(addr6), &addr->s6_addr16[6]);
        UNALIGNED_PUT(htons(addr7), &addr->s6_addr16[7]);
}
 
static inline void net_ipv6_addr_create_ll_allnodes_mcast(struct in6_addr *addr)
{
        net_ipv6_addr_create(addr, 0xff02, 0, 0, 0, 0, 0, 0, 0x0001);
}
 
static inline void net_ipv6_addr_create_ll_allrouters_mcast(struct in6_addr *addr)
{
        net_ipv6_addr_create(addr, 0xff02, 0, 0, 0, 0, 0, 0, 0x0002);
}
 
static inline void net_ipv6_addr_create_v4_mapped(const struct in_addr *addr4,
                                                  struct in6_addr *addr6)
{
        net_ipv6_addr_create(addr6, 0, 0, 0, 0, 0, 0xffff,
                             ntohs(addr4->s4_addr16[0]),
                             ntohs(addr4->s4_addr16[1]));
}
 
static inline bool net_ipv6_addr_is_v4_mapped(const struct in6_addr *addr)
{
        if (UNALIGNED_GET(&addr->s6_addr32[0]) == 0 &&
            UNALIGNED_GET(&addr->s6_addr32[1]) == 0 &&
            UNALIGNED_GET(&addr->s6_addr16[5]) == 0xffff) {
                return true;
        }
 
        return false;
}
 
static inline void net_ipv6_addr_create_iid(struct in6_addr *addr,
                                            struct net_linkaddr *lladdr)
{
        UNALIGNED_PUT(htonl(0xfe800000), &addr->s6_addr32[0]);
        UNALIGNED_PUT(0, &addr->s6_addr32[1]);
 
        switch (lladdr->len) {
        case 2:
                /* The generated IPv6 shall not toggle the
                 * Universal/Local bit. RFC 6282 ch 3.2.2
                 */
                if (lladdr->type == NET_LINK_IEEE802154) {
                        UNALIGNED_PUT(0, &addr->s6_addr32[2]);
                        addr->s6_addr[11] = 0xff;
                        addr->s6_addr[12] = 0xfe;
                        addr->s6_addr[13] = 0U;
                        addr->s6_addr[14] = lladdr->addr[0];
                        addr->s6_addr[15] = lladdr->addr[1];
                }
 
                break;
        case 6:
                /* We do not toggle the Universal/Local bit
                 * in Bluetooth. See RFC 7668 ch 3.2.2
                 */
                memcpy(&addr->s6_addr[8], lladdr->addr, 3);
                addr->s6_addr[11] = 0xff;
                addr->s6_addr[12] = 0xfe;
                memcpy(&addr->s6_addr[13], lladdr->addr + 3, 3);
 
                if (lladdr->type == NET_LINK_ETHERNET) {
                        addr->s6_addr[8] ^= 0x02;
                }
 
                break;
        case 8:
                memcpy(&addr->s6_addr[8], lladdr->addr, lladdr->len);
                addr->s6_addr[8] ^= 0x02;
                break;
        }
}
 
static inline bool net_ipv6_addr_based_on_ll(const struct in6_addr *addr,
                                             const struct net_linkaddr *lladdr)
{
        if (!addr || !lladdr) {
                return false;
        }
 
        switch (lladdr->len) {
        case 2:
                if (!memcmp(&addr->s6_addr[14], lladdr->addr, lladdr->len) &&
                    addr->s6_addr[8]  == 0U &&
                    addr->s6_addr[9]  == 0U &&
                    addr->s6_addr[10] == 0U &&
                    addr->s6_addr[11] == 0xff &&
                    addr->s6_addr[12] == 0xfe) {
                        return true;
                }
 
                break;
        case 6:
                if (lladdr->type == NET_LINK_ETHERNET) {
                        if (!memcmp(&addr->s6_addr[9], &lladdr->addr[1], 2) &&
                            !memcmp(&addr->s6_addr[13], &lladdr->addr[3], 3) &&
                            addr->s6_addr[11] == 0xff &&
                            addr->s6_addr[12] == 0xfe &&
                            (addr->s6_addr[8] ^ 0x02) == lladdr->addr[0]) {
                                return true;
                        }
                }
 
                break;
        case 8:
                if (!memcmp(&addr->s6_addr[9], &lladdr->addr[1],
                            lladdr->len - 1) &&
                    (addr->s6_addr[8] ^ 0x02) == lladdr->addr[0]) {
                        return true;
                }
 
                break;
        }
 
        return false;
}
 
static inline struct sockaddr_in6 *net_sin6(const struct sockaddr *addr)
{
        return (struct sockaddr_in6 *)addr;
}
 
static inline struct sockaddr_in *net_sin(const struct sockaddr *addr)
{
        return (struct sockaddr_in *)addr;
}
 
static inline
struct sockaddr_in6_ptr *net_sin6_ptr(const struct sockaddr_ptr *addr)
{
        return (struct sockaddr_in6_ptr *)addr;
}
 
static inline
struct sockaddr_in_ptr *net_sin_ptr(const struct sockaddr_ptr *addr)
{
        return (struct sockaddr_in_ptr *)addr;
}
 
static inline
struct sockaddr_ll_ptr *net_sll_ptr(const struct sockaddr_ptr *addr)
{
        return (struct sockaddr_ll_ptr *)addr;
}
 
static inline
struct sockaddr_can_ptr *net_can_ptr(const struct sockaddr_ptr *addr)
{
        return (struct sockaddr_can_ptr *)addr;
}
 
__syscall int net_addr_pton(sa_family_t family, const char *src, void *dst);
 
__syscall char *net_addr_ntop(sa_family_t family, const void *src,
                              char *dst, size_t size);
 
bool net_ipaddr_parse(const char *str, size_t str_len,
                      struct sockaddr *addr);
 
int net_port_set_default(struct sockaddr *addr, uint16_t default_port);
 
static inline int32_t net_tcp_seq_cmp(uint32_t seq1, uint32_t seq2)
{
        return (int32_t)(seq1 - seq2);
}
 
static inline bool net_tcp_seq_greater(uint32_t seq1, uint32_t seq2)
{
        return net_tcp_seq_cmp(seq1, seq2) > 0;
}
 
int net_bytes_from_str(uint8_t *buf, int buf_len, const char *src);
 
int net_tx_priority2tc(enum net_priority prio);
 
int net_rx_priority2tc(enum net_priority prio);
 
static inline enum net_priority net_vlan2priority(uint8_t priority)
{
        /* Map according to IEEE 802.1Q */
        static const uint8_t vlan2priority[] = {
                NET_PRIORITY_BE,
                NET_PRIORITY_BK,
                NET_PRIORITY_EE,
                NET_PRIORITY_CA,
                NET_PRIORITY_VI,
                NET_PRIORITY_VO,
                NET_PRIORITY_IC,
                NET_PRIORITY_NC
        };
 
        if (priority >= ARRAY_SIZE(vlan2priority)) {
                /* Use Best Effort as the default priority */
                return NET_PRIORITY_BE;
        }
 
        return (enum net_priority)vlan2priority[priority];
}
 
static inline uint8_t net_priority2vlan(enum net_priority priority)
{
        /* The conversion works both ways */
        return (uint8_t)net_vlan2priority(priority);
}
 
const char *net_family2str(sa_family_t family);
 
#if defined(CONFIG_NET_IPV6_PE)
int net_ipv6_pe_add_filter(struct in6_addr *addr, bool is_denylist);
#else
static inline int net_ipv6_pe_add_filter(struct in6_addr *addr,
                                         bool is_denylist)
{
        ARG_UNUSED(addr);
        ARG_UNUSED(is_denylist);
 
        return -ENOTSUP;
}
#endif /* CONFIG_NET_IPV6_PE */
 
#if defined(CONFIG_NET_IPV6_PE)
int net_ipv6_pe_del_filter(struct in6_addr *addr);
#else
static inline int net_ipv6_pe_del_filter(struct in6_addr *addr)
{
        ARG_UNUSED(addr);
 
        return -ENOTSUP;
}
#endif /* CONFIG_NET_IPV6_PE */
 
#ifdef __cplusplus
}
#endif
 
#include <syscalls/net_ip.h>
 
#endif /* ZEPHYR_INCLUDE_NET_NET_IP_H_ */