socket.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2017-2018 Linaro Limited
 * Copyright (c) 2021 Nordic Semiconductor
 * Copyright (c) 2025 Aerlync Labs Inc.
 * Copyright 2025 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_SOCKET_H_
#define ZEPHYR_INCLUDE_NET_SOCKET_H_

 
#include <zephyr/kernel.h>
#include <sys/types.h>
#include <zephyr/types.h>
#include <zephyr/device.h>
#include <zephyr/net/net_ip.h>
#include <zephyr/net/socket_select.h>
#include <zephyr/net/socket_poll.h>
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/sys/fdtable.h>
#include <zephyr/net/dns_resolve.h>
#include <stdlib.h>
 
#ifdef __cplusplus
extern "C" {
#endif

/* ZSOCK_POLL* values are compatible with Linux */
#define ZSOCK_POLLIN 1
#define ZSOCK_POLLPRI 2
#define ZSOCK_POLLOUT 4
#define ZSOCK_POLLERR 8
#define ZSOCK_POLLHUP 0x10
#define ZSOCK_POLLNVAL 0x20

#define ZSOCK_MSG_PEEK 0x02
#define ZSOCK_MSG_CTRUNC 0x08
#define ZSOCK_MSG_TRUNC 0x20
#define ZSOCK_MSG_DONTWAIT 0x40
#define ZSOCK_MSG_WAITALL 0x100

/* Well-known values, e.g. from Linux man 2 shutdown:
 * "The constants SHUT_RD, SHUT_WR, SHUT_RDWR have the value 0, 1, 2,
 * respectively". Some software uses numeric values.
 */
#define ZSOCK_SHUT_RD 0
#define ZSOCK_SHUT_WR 1
#define ZSOCK_SHUT_RDWR 2


#define ZSOCK_SOL_TLS 282

#define ZSOCK_TLS_SEC_TAG_LIST 1
#define ZSOCK_TLS_HOSTNAME 2
#define ZSOCK_TLS_CIPHERSUITE_LIST 3
#define ZSOCK_TLS_CIPHERSUITE_USED 4
#define ZSOCK_TLS_PEER_VERIFY 5
#define ZSOCK_TLS_DTLS_ROLE 6
#define ZSOCK_TLS_ALPN_LIST 7
#define ZSOCK_TLS_DTLS_HANDSHAKE_TIMEOUT_MIN 8

#define ZSOCK_TLS_DTLS_HANDSHAKE_TIMEOUT_MAX 9

#define ZSOCK_TLS_CERT_NOCOPY          10
#define ZSOCK_TLS_NATIVE 11
#define ZSOCK_TLS_SESSION_CACHE 12
#define ZSOCK_TLS_SESSION_CACHE_PURGE 13
#define ZSOCK_TLS_DTLS_CID 14
#define ZSOCK_TLS_DTLS_CID_STATUS 15
#define ZSOCK_TLS_DTLS_CID_VALUE 16
#define ZSOCK_TLS_DTLS_PEER_CID_VALUE 17
#define ZSOCK_TLS_DTLS_HANDSHAKE_ON_CONNECT 18
#define ZSOCK_TLS_CERT_VERIFY_RESULT 19
#define ZSOCK_TLS_CERT_VERIFY_CALLBACK 20
#define ZSOCK_TLS_MAX_FRAGMENT_LENGTH 21
 
/* Valid values for @ref ZSOCK_TLS_MAX_FRAGMENT_LENGTH option */
#define ZSOCK_TLS_MFL_DEFAULT -1 
#define ZSOCK_TLS_MFL_DISABLED 0 
#define ZSOCK_TLS_MFL_512 1      
#define ZSOCK_TLS_MFL_1024 2     
#define ZSOCK_TLS_MFL_2048 3     
#define ZSOCK_TLS_MFL_4096 4     
 
/* Valid values for @ref TLS_PEER_VERIFY option */
#define ZSOCK_TLS_PEER_VERIFY_NONE 0     
#define ZSOCK_TLS_PEER_VERIFY_OPTIONAL 1 
#define ZSOCK_TLS_PEER_VERIFY_REQUIRED 2 
 
/* Valid values for @ref TLS_DTLS_ROLE option */
#define ZSOCK_TLS_DTLS_ROLE_CLIENT 0 
#define ZSOCK_TLS_DTLS_ROLE_SERVER 1 
 
/* Valid values for @ref TLS_CERT_NOCOPY option */
#define ZSOCK_TLS_CERT_NOCOPY_NONE 0     
#define ZSOCK_TLS_CERT_NOCOPY_OPTIONAL 1 
 
/* Valid values for @ref TLS_SESSION_CACHE option */
#define ZSOCK_TLS_SESSION_CACHE_DISABLED 0 
#define ZSOCK_TLS_SESSION_CACHE_ENABLED 1 
 
/* Valid values for @ref TLS_DTLS_CID (Connection ID) option */
#define ZSOCK_TLS_DTLS_CID_DISABLED             0 
#define ZSOCK_TLS_DTLS_CID_SUPPORTED            1 
#define ZSOCK_TLS_DTLS_CID_ENABLED              2 
 
/* Valid values for @ref TLS_DTLS_CID_STATUS option */
#define ZSOCK_TLS_DTLS_CID_STATUS_DISABLED      0 
#define ZSOCK_TLS_DTLS_CID_STATUS_DOWNLINK      1 
#define ZSOCK_TLS_DTLS_CID_STATUS_UPLINK        2 
#define ZSOCK_TLS_DTLS_CID_STATUS_BIDIRECTIONAL 3 

struct zsock_tls_cert_verify_cb {
        void *cb;

        void *ctx;
};
 /* for @name */ /* for @defgroup */

struct zsock_addrinfo {
        struct zsock_addrinfo *ai_next; 
        int ai_flags;             
        int ai_family;            
        int ai_socktype;          
        int ai_protocol;          
        int ai_eflags;            
        net_socklen_t ai_addrlen; 
        struct net_sockaddr *ai_addr; 
        char *ai_canonname;       

        struct net_sockaddr_storage _ai_addr;
        char _ai_canonname[DNS_MAX_NAME_SIZE + 1];
};

__syscall void *zsock_get_context_object(int sock);

 
/* Offloaded sockets bind their local port in the offload engine, outside the
 * net_context list, so net_context_port_in_use() cannot see them. The socket
 * layer tracks those bindings and answers this query for them.
 */
#if defined(CONFIG_NET_SOCKETS_OFFLOAD_PORT_TRACKING)
bool net_socket_offloaded_port_in_use(enum net_ip_protocol ip_proto, uint16_t local_port,
                                      const struct net_sockaddr *local_addr);
#else
static inline bool net_socket_offloaded_port_in_use(enum net_ip_protocol ip_proto,
                                                    uint16_t local_port,
                                                    const struct net_sockaddr *local_addr)
{
        ARG_UNUSED(ip_proto);
        ARG_UNUSED(local_port);
        ARG_UNUSED(local_addr);
 
        return false;
}
#endif /* CONFIG_NET_SOCKETS_OFFLOAD_PORT_TRACKING */
 
/* Port-in-use check across both socket backends: native sockets tracked by
 * net_context and offloaded sockets tracked by the socket layer.
 */
bool net_socket_port_in_use(enum net_ip_protocol ip_proto, uint16_t local_port,
                            const struct net_sockaddr *local_addr);


__syscall int zsock_socket(int family, int type, int proto);

__syscall int zsock_socketpair(int family, int type, int proto, int *sv);

__syscall int zsock_close(int sock);

__syscall int zsock_shutdown(int sock, int how);

__syscall int zsock_bind(int sock, const struct net_sockaddr *addr,
                         net_socklen_t addrlen);

__syscall int zsock_connect(int sock, const struct net_sockaddr *addr,
                            net_socklen_t addrlen);

__syscall int zsock_listen(int sock, int backlog);

__syscall int zsock_accept(int sock, struct net_sockaddr *addr, net_socklen_t *addrlen);

__syscall ssize_t zsock_sendto(int sock, const void *buf, size_t len,
                               int flags, const struct net_sockaddr *dest_addr,
                               net_socklen_t addrlen);

static inline ssize_t zsock_send(int sock, const void *buf, size_t len,
                                 int flags)
{
        return zsock_sendto(sock, buf, len, flags, NULL, 0);
}

__syscall ssize_t zsock_sendmsg(int sock, const struct net_msghdr *msg,
                                int flags);

__syscall ssize_t zsock_recvfrom(int sock, void *buf, size_t max_len,
                                 int flags, struct net_sockaddr *src_addr,
                                 net_socklen_t *addrlen);

__syscall ssize_t zsock_recvmsg(int sock, struct net_msghdr *msg, int flags);

static inline ssize_t zsock_recv(int sock, void *buf, size_t max_len,
                                 int flags)
{
        return zsock_recvfrom(sock, buf, max_len, flags, NULL, NULL);
}

__syscall int zsock_fcntl_impl(int sock, int cmd, int flags);

 
/*
 * Need this wrapper because newer GCC versions got too smart and "typecheck"
 * even macros.
 */
static inline int zsock_fcntl_wrapper(int sock, int cmd, ...)
{
        va_list args;
        int flags;
 
        va_start(args, cmd);
        flags = va_arg(args, int);
        va_end(args);
        return zsock_fcntl_impl(sock, cmd, flags);
}
 
#define zsock_fcntl zsock_fcntl_wrapper


__syscall int zsock_ioctl_impl(int sock, unsigned long request, va_list ap);

 
static inline int zsock_ioctl_wrapper(int sock, unsigned long request, ...)
{
        int ret;
        va_list args;
 
        va_start(args, request);
        ret = zsock_ioctl_impl(sock, request, args);
        va_end(args);
 
        return ret;
}
 
#define zsock_ioctl zsock_ioctl_wrapper


static inline int zsock_poll(struct zsock_pollfd *fds, int nfds, int timeout)
{
        return zvfs_poll(fds, nfds, timeout);
}

__syscall int zsock_getsockopt(int sock, int level, int optname,
                               void *optval, net_socklen_t *optlen);

__syscall int zsock_setsockopt(int sock, int level, int optname,
                               const void *optval, net_socklen_t optlen);

__syscall int zsock_getpeername(int sock, struct net_sockaddr *addr,
                                net_socklen_t *addrlen);

__syscall int zsock_getsockname(int sock, struct net_sockaddr *addr,
                                net_socklen_t *addrlen);

__syscall int zsock_gethostname(char *buf, size_t len);

static inline char *zsock_inet_ntop(net_sa_family_t family, const void *src,
                                    char *dst, size_t size)
{
        return net_addr_ntop(family, src, dst, size);
}

__syscall int zsock_inet_pton(net_sa_family_t family, const char *src, void *dst);

__syscall int z_zsock_getaddrinfo_internal(const char *host,
                                           const char *service,
                                           const struct zsock_addrinfo *hints,
                                           struct zsock_addrinfo *res);
 
/* Flags for getaddrinfo() hints. */

#define ZSOCK_AI_PASSIVE 0x1
#define ZSOCK_AI_CANONNAME 0x2
#define ZSOCK_AI_NUMERICHOST 0x4
#define ZSOCK_AI_V4MAPPED 0x8
#define ZSOCK_AI_ALL 0x10
#define ZSOCK_AI_ADDRCONFIG 0x20
#define ZSOCK_AI_NUMERICSERV 0x400
#define ZSOCK_AI_EXTFLAGS 0x800

int zsock_getaddrinfo(const char *host, const char *service,
                      const struct zsock_addrinfo *hints,
                      struct zsock_addrinfo **res);

void zsock_freeaddrinfo(struct zsock_addrinfo *ai);

const char *zsock_gai_strerror(int errcode);

#define ZSOCK_NI_NUMERICHOST 1
#define ZSOCK_NI_NUMERICSERV 2
#define ZSOCK_NI_NOFQDN 4
#define ZSOCK_NI_NAMEREQD 8
#define ZSOCK_NI_DGRAM 16
 
/* POSIX extensions */

#ifndef ZSOCK_NI_MAXHOST
#define ZSOCK_NI_MAXHOST 64
#endif

int zsock_getnameinfo(const struct net_sockaddr *addr, net_socklen_t addrlen,
                      char *host, net_socklen_t hostlen,
                      char *serv, net_socklen_t servlen, int flags);

int zsock_send_all(int sock, const void *buf, size_t len, int flags,
                   k_timeout_t timeout, size_t *sent_len);

int zsock_sendmsg_all(int sock, const struct net_msghdr *msg, int flags,
                      k_timeout_t timeout, size_t *sent_len);

#define ZSOCK_SOL_SOCKET 1
 
/* Socket options for SOL_SOCKET level */

#define ZSOCK_SO_DEBUG 1
#define ZSOCK_SO_REUSEADDR 2
#define ZSOCK_SO_TYPE 3
#define ZSOCK_SO_ERROR 4
#define ZSOCK_SO_DONTROUTE 5
#define ZSOCK_SO_BROADCAST 6

#define ZSOCK_SO_SNDBUF 7
#define ZSOCK_SO_RCVBUF 8

#define ZSOCK_SO_KEEPALIVE 9
#define ZSOCK_SO_OOBINLINE 10
#define ZSOCK_SO_PRIORITY 12
#define ZSOCK_SO_LINGER 13
#define ZSOCK_SO_REUSEPORT 15

#define ZSOCK_SO_RCVLOWAT 18
#define ZSOCK_SO_SNDLOWAT 19

#define ZSOCK_SO_RCVTIMEO 20
#define ZSOCK_SO_SNDTIMEO 21

#define ZSOCK_SO_BINDTODEVICE   25

#define ZSOCK_SO_ACCEPTCONN 30

#define ZSOCK_SO_TIMESTAMPING 37

#define ZSOCK_SO_PROTOCOL 38

#define ZSOCK_SO_DOMAIN 39

#define ZSOCK_SO_SOCKS5 60

#define ZSOCK_SO_TXTIME 61
#define ZSOCK_SCM_TXTIME ZSOCK_SO_TXTIME


#define ZSOCK_SOF_TIMESTAMPING_RX_HARDWARE BIT(0)
#define ZSOCK_SOF_TIMESTAMPING_TX_HARDWARE BIT(1)



/* Socket options for NET_IPPROTO_TCP level */
#define ZSOCK_TCP_NODELAY 1
#define ZSOCK_TCP_KEEPIDLE 2
#define ZSOCK_TCP_KEEPINTVL 3
#define ZSOCK_TCP_KEEPCNT 4


/* Socket options for NET_IPPROTO_UDP level */

#define ZSOCK_UDP_OPT      1
#define ZSOCK_UDP_OPT_OCS  2
#define ZSOCK_UDP_OPT_APC  3
#define ZSOCK_UDP_OPT_FRAG 4
#define ZSOCK_UDP_OPT_MDS  5
#define ZSOCK_UDP_OPT_MRDS 6
#define ZSOCK_UDP_OPT_REQ  7
#define ZSOCK_UDP_OPT_RES  8
#define ZSOCK_UDP_OPT_TIME 9
#define ZSOCK_UDP_OPT_AUTH 10
#define ZSOCK_UDP_OPT_EXP  11
#define ZSOCK_UDP_OPT_UCMP 12
#define ZSOCK_UDP_OPT_UENC 13
#define ZSOCK_UDP_OPT_UEXP 14
#define ZSOCK_UDP_OPT_DPLPMTUD 15
#define ZSOCK_UDP_OPT_DPLPMTUD_APP_RESPOND 16

#define ZSOCK_UDP_OPT_CMSG_APC    1  
#define ZSOCK_UDP_OPT_CMSG_MDS    2  
#define ZSOCK_UDP_OPT_CMSG_MRDS   3  
#define ZSOCK_UDP_OPT_CMSG_REQ    4  
#define ZSOCK_UDP_OPT_CMSG_RES    5  
#define ZSOCK_UDP_OPT_CMSG_TIME   6  



 
/* Socket options for NET_IPPROTO_IP level */
#define ZSOCK_IP_TOS 1

#define ZSOCK_IP_TTL 2

#define ZSOCK_IP_PKTINFO 8

#define ZSOCK_IP_RECVTTL 12

#define ZSOCK_IP_MTU 14

#define ZSOCK_IP_DONTFRAG 15

#define ZSOCK_IP_MULTICAST_IF 32
#define ZSOCK_IP_MULTICAST_TTL 33
#define ZSOCK_IP_MULTICAST_LOOP 34
#define ZSOCK_IP_ADD_MEMBERSHIP 35
#define ZSOCK_IP_DROP_MEMBERSHIP 36

#define ZSOCK_IP_LOCAL_PORT_RANGE 51
 /* for @name */ /* for @defgroup */

/* Socket options for NET_IPPROTO_IPV6 level */
#define ZSOCK_IPV6_UNICAST_HOPS 16

#define ZSOCK_IPV6_MULTICAST_IF       17

#define ZSOCK_IPV6_MULTICAST_HOPS 18

#define ZSOCK_IPV6_MULTICAST_LOOP 19

#define ZSOCK_IPV6_ADD_MEMBERSHIP 20

#define ZSOCK_IPV6_DROP_MEMBERSHIP 21

#define ZSOCK_IPV6_JOIN_GROUP ZSOCK_IPV6_ADD_MEMBERSHIP

#define ZSOCK_IPV6_LEAVE_GROUP ZSOCK_IPV6_DROP_MEMBERSHIP

#define ZSOCK_IPV6_MTU 24

#define ZSOCK_IPV6_DONTFRAG 62

#define ZSOCK_IPV6_V6ONLY 26

#define ZSOCK_IPV6_RECVPKTINFO 49

#define ZSOCK_IPV6_PKTINFO 50

#define ZSOCK_IPV6_RECVHOPLIMIT 51

#define ZSOCK_IPV6_HOPLIMIT 52

#define ZSOCK_IPV6_ADDR_PREFERENCES   72

#define ZSOCK_IPV6_PREFER_SRC_TMP             0x0001
#define ZSOCK_IPV6_PREFER_SRC_PUBLIC          0x0002
#define ZSOCK_IPV6_PREFER_SRC_PUBTMP_DEFAULT  0x0100
#define ZSOCK_IPV6_PREFER_SRC_COA             0x0004
#define ZSOCK_IPV6_PREFER_SRC_HOME            0x0400
#define ZSOCK_IPV6_PREFER_SRC_CGA             0x0008
#define ZSOCK_IPV6_PREFER_SRC_NONCGA          0x0800

#define ZSOCK_IPV6_TCLASS 67 /* for @name */ /* for @defgroup */

#define ZSOCK_SOMAXCONN 128

#define ZSOCK_IN6_IS_ADDR_UNSPECIFIED(addr) \
        net_ipv6_addr_cmp(net_ipv6_unspecified_address(), addr)

#define ZSOCK_IN6_IS_ADDR_LOOPBACK(addr) net_ipv6_is_addr_loopback(addr)

#define ZSOCK_IN6_IS_ADDR_MULTICAST(addr) net_ipv6_is_addr_mcast(addr)

#define ZSOCK_IN6_IS_ADDR_LINKLOCAL(addr) net_ipv6_is_ll_addr(addr)

#define ZSOCK_IN6_IS_ADDR_SITELOCAL(addr) net_ipv6_is_sl_addr(addr)

#define ZSOCK_IN6_IS_ADDR_V4MAPPED(addr) net_ipv6_addr_is_v4_mapped(addr)

#define ZSOCK_IN6_IS_ADDR_MC_GLOBAL(addr) net_ipv6_is_addr_mcast_global(addr)

#define ZSOCK_IN6_IS_ADDR_MC_NODELOCAL(addr) net_ipv6_is_addr_mcast_iface(addr)

#define ZSOCK_IN6_IS_ADDR_MC_LINKLOCAL(addr) net_ipv6_is_addr_mcast_link(addr)

#define ZSOCK_IN6_IS_ADDR_MC_SITELOCAL(addr) net_ipv6_is_addr_mcast_site(addr)

#define ZSOCK_IN6_IS_ADDR_MC_ORGLOCAL(addr) net_ipv6_is_addr_mcast_org(addr)




#define ZSOCK_SOL_PACKET 263

#define ZSOCK_PACKET_ADD_MEMBERSHIP           1

#define ZSOCK_PACKET_DROP_MEMBERSHIP          2
 /* for @name */ /* for @defgroup */

struct net_socket_register {
        int family;
        bool is_offloaded;
        bool (*is_supported)(int family, int type, int proto);
        int (*handler)(int family, int type, int proto);
#if defined(CONFIG_NET_SOCKETS_OBJ_CORE)
        /* Store also the name of the socket type in order to be able to
         * print it later.
         */
        const char * const name;
#endif
};
 
#define NET_SOCKET_DEFAULT_PRIO CONFIG_NET_SOCKETS_PRIORITY_DEFAULT
 
#define NET_SOCKET_GET_NAME(socket_name, prio)  \
        __net_socket_register_##prio##_##socket_name
 
#if defined(CONFIG_NET_SOCKETS_OBJ_CORE)
#define K_OBJ_TYPE_SOCK  K_OBJ_TYPE_ID_GEN("SOCK")
 
#define NET_SOCKET_REGISTER_NAME(_name)         \
        .name = STRINGIFY(_name),
#else
#define NET_SOCKET_REGISTER_NAME(_name)
#endif
 
#define _NET_SOCKET_REGISTER(socket_name, prio, _family, _is_supported, _handler, _is_offloaded) \
        static const STRUCT_SECTION_ITERABLE(net_socket_register,       \
                        NET_SOCKET_GET_NAME(socket_name, prio)) = {     \
                .family = _family,                                      \
                .is_offloaded = _is_offloaded,                          \
                .is_supported = _is_supported,                          \
                .handler = _handler,                                    \
                NET_SOCKET_REGISTER_NAME(socket_name)                   \
        }
 
#define NET_SOCKET_REGISTER(socket_name, prio, _family, _is_supported, _handler) \
        _NET_SOCKET_REGISTER(socket_name, prio, _family, _is_supported, _handler, false)
 
#define NET_SOCKET_OFFLOAD_REGISTER(socket_name, prio, _family, _is_supported, _handler) \
        _NET_SOCKET_REGISTER(socket_name, prio, _family, _is_supported, _handler, true)
 
struct socket_op_vtable {
        struct fd_op_vtable fd_vtable;
        int (*shutdown)(void *obj, int how);
        int (*bind)(void *obj, const struct net_sockaddr *addr, net_socklen_t addrlen);
        int (*connect)(void *obj, const struct net_sockaddr *addr,
                       net_socklen_t addrlen);
        int (*listen)(void *obj, int backlog);
        int (*accept)(void *obj, struct net_sockaddr *addr, net_socklen_t *addrlen);
        ssize_t (*sendto)(void *obj, const void *buf, size_t len, int flags,
                          const struct net_sockaddr *dest_addr, net_socklen_t addrlen);
        ssize_t (*recvfrom)(void *obj, void *buf, size_t max_len, int flags,
                            struct net_sockaddr *src_addr, net_socklen_t *addrlen);
        int (*getsockopt)(void *obj, int level, int optname,
                          void *optval, net_socklen_t *optlen);
        int (*setsockopt)(void *obj, int level, int optname,
                          const void *optval, net_socklen_t optlen);
        ssize_t (*sendmsg)(void *obj, const struct net_msghdr *msg, int flags);
        ssize_t (*recvmsg)(void *obj, struct net_msghdr *msg, int flags);
        int (*getpeername)(void *obj, struct net_sockaddr *addr,
                           net_socklen_t *addrlen);
        int (*getsockname)(void *obj, struct net_sockaddr *addr,
                           net_socklen_t *addrlen);
};

 
#ifdef __cplusplus
}
#endif
 
#include <zephyr/syscalls/socket.h>

 
#endif /* ZEPHYR_INCLUDE_NET_SOCKET_H_ */