14#ifndef ZEPHYR_INCLUDE_NET_NET_CONTEXT_H_
15#define ZEPHYR_INCLUDE_NET_NET_CONTEXT_H_
38#define NET_CONTEXT_IN_USE BIT(0)
43enum net_context_state {
45 NET_CONTEXT_UNCONNECTED = 0,
46 NET_CONTEXT_CONFIGURING = 1,
47 NET_CONTEXT_CONNECTING = 1,
48 NET_CONTEXT_READY = 2,
49 NET_CONTEXT_CONNECTED = 2,
50 NET_CONTEXT_LISTENING = 3,
60#define NET_CONTEXT_FAMILY (BIT(3) | BIT(4) | BIT(5))
63#define NET_CONTEXT_TYPE (BIT(6) | BIT(7))
66#define NET_CONTEXT_REMOTE_ADDR_SET BIT(8)
69#define NET_CONTEXT_ACCEPTING_SOCK BIT(9)
72#define NET_CONTEXT_CLOSING_SOCK BIT(10)
75#define NET_CONTEXT_BOUND_TO_IFACE BIT(11)
101 union net_ip_header *ip_hdr,
102 union net_proto_header *proto_hdr,
182typedef struct k_mem_slab *(*net_pkt_get_slab_func_t)(void);
195typedef struct net_buf_pool *(*net_pkt_get_pool_func_t)(void);
199struct net_conn_handle;
252#if defined(CONFIG_NET_CONTEXT_NET_PKT_POOL)
262#if defined(CONFIG_NET_TCP)
267#if defined(CONFIG_NET_CONTEXT_SYNC_RECV)
271 struct k_sem recv_data_wait;
274#if defined(CONFIG_NET_SOCKETS)
293#if defined(CONFIG_NET_OFFLOAD)
295 void *offload_context;
298#if defined(CONFIG_NET_SOCKETS_CAN)
304#if defined(CONFIG_NET_CONTEXT_PRIORITY)
308#if defined(CONFIG_NET_CONTEXT_TXTIME)
312#if defined(CONFIG_SOCKS)
319#if defined(CONFIG_NET_CONTEXT_RCVTIMEO)
323#if defined(CONFIG_NET_CONTEXT_SNDTIMEO)
327#if defined(CONFIG_NET_CONTEXT_RCVBUF)
331#if defined(CONFIG_NET_CONTEXT_SNDBUF)
335#if defined(CONFIG_NET_CONTEXT_DSCP_ECN)
342#if defined(CONFIG_NET_CONTEXT_REUSEADDR)
346#if defined(CONFIG_NET_CONTEXT_REUSEPORT)
350#if defined(CONFIG_NET_IPV4_MAPPING_TO_IPV6)
354#if defined(CONFIG_NET_CONTEXT_RECV_PKTINFO)
358#if defined(CONFIG_NET_IPV6)
365#if defined(CONFIG_NET_CONTEXT_TIMESTAMPING)
392#if defined(CONFIG_SOCKS)
493#define NET_CONTEXT_STATE_SHIFT 1
494#define NET_CONTEXT_STATE_MASK 0x03
512 return (
enum net_context_state)
513 ((context->
flags >> NET_CONTEXT_STATE_SHIFT) &
514 NET_CONTEXT_STATE_MASK);
526 enum net_context_state
state)
530 context->
flags &= ~(NET_CONTEXT_STATE_MASK << NET_CONTEXT_STATE_SHIFT);
531 context->
flags |= ((
state & NET_CONTEXT_STATE_MASK) <<
532 NET_CONTEXT_STATE_SHIFT);
574 context->
flags |= flag;
616 context->
flags |= flag;
627#if defined(CONFIG_NET_SOCKETS_CAN)
633 context->can_filter_id = filter_id;
640 ARG_UNUSED(filter_id);
653#if defined(CONFIG_NET_SOCKETS_CAN)
658 return context->can_filter_id;
681 return context->
proto;
697 context->
proto = proto;
879#if defined(CONFIG_SOCKS)
883 context->proxy_enabled = enable;
904#if defined(CONFIG_SOCKS)
907 return context->proxy_enabled;
993#if defined(CONFIG_NET_IPV4)
1018#if defined(CONFIG_NET_IPV6)
1029 ARG_UNUSED(context);
1309 const void *value,
size_t len);
1323 void *value,
size_t *len);
1363#if defined(CONFIG_NET_CONTEXT_NET_PKT_POOL)
1368 NET_ASSERT(context);
1370 context->tx_slab = tx_slab;
1371 context->data_pool = data_pool;
1374#define net_context_setup_pools(context, tx_pool, data_pool)
long atomic_t
Definition atomic_types.h:15
static ssize_t recv(int sock, void *buf, size_t max_len, int flags)
POSIX wrapper for zsock_recv.
Definition socket.h:926
unsigned short int sa_family_t
Socket address family type.
Definition net_ip.h:166
#define AF_CAN
Controller Area Network.
Definition net_ip.h:58
#define AF_INET
IP protocol family version 4.
Definition net_ip.h:55
#define AF_INET6
IP protocol family version 6.
Definition net_ip.h:56
#define AF_PACKET
Packet family.
Definition net_ip.h:57
net_sock_type
Socket type.
Definition net_ip.h:86
size_t socklen_t
Length of a socket address.
Definition net_ip.h:170
#define AF_UNSPEC
Unspecified address family.
Definition net_ip.h:54
net_ip_protocol
Protocol numbers from IANA/BSD.
Definition net_ip.h:64
@ SOCK_DGRAM
Datagram socket type.
Definition net_ip.h:88
@ SOCK_RAW
RAW socket type
Definition net_ip.h:89
@ SOCK_STREAM
Stream socket type
Definition net_ip.h:87
static void net_context_set_type(struct net_context *context, enum net_sock_type type)
Set context type for this network context.
Definition net_context.h:604
static void net_context_set_ipv6_hop_limit(struct net_context *context, uint8_t hop_limit)
Set IPv6 hop limit value for this context.
Definition net_context.h:834
int net_context_unref(struct net_context *context)
Decrement the reference count to a network context.
int net_context_bind(struct net_context *context, const struct sockaddr *addr, socklen_t addrlen)
Assign a socket a local address.
static void net_context_set_iface(struct net_context *context, struct net_if *iface)
Set network interface for this context.
Definition net_context.h:726
static void net_context_set_ipv4_ttl(struct net_context *context, uint8_t ttl)
Set IPv4 TTL (time-to-live) value for this context.
Definition net_context.h:775
void(* net_context_connect_cb_t)(struct net_context *context, int status, void *user_data)
Connection callback.
Definition net_context.h:167
int net_context_accept(struct net_context *context, net_tcp_accept_cb_t cb, k_timeout_t timeout, void *user_data)
Accept a network connection attempt.
int net_context_put(struct net_context *context)
Close and unref a network context.
static enum net_sock_type net_context_get_type(struct net_context *context)
Get context type for this network context.
Definition net_context.h:588
static bool net_context_is_accepting(struct net_context *context)
Is this context is accepting data now.
Definition net_context.h:434
static sa_family_t net_context_get_family(struct net_context *context)
Get address family for this network context.
Definition net_context.h:545
static bool net_context_is_bound_to_iface(struct net_context *context)
Is this context bound to a network interface.
Definition net_context.h:420
static void net_context_bind_iface(struct net_context *context, struct net_if *iface)
Bind network interface to this context.
Definition net_context.h:742
int net_context_listen(struct net_context *context, int backlog)
Mark the context as a listening one.
struct k_mem_slab *(* net_pkt_get_slab_func_t)(void)
Function that is called to get the slab that is used for net_pkt allocations.
Definition net_context.h:182
static uint8_t net_context_get_ipv4_mcast_ttl(struct net_context *context)
Get IPv4 multicast TTL (time-to-live) value for this context.
Definition net_context.h:791
static bool net_context_is_used(struct net_context *context)
Is this context used or not.
Definition net_context.h:406
int net_context_sendmsg(struct net_context *context, const struct msghdr *msghdr, int flags, net_context_send_cb_t cb, k_timeout_t timeout, void *user_data)
Send data in iovec to a peer specified in msghdr struct.
int net_context_ref(struct net_context *context)
Take a reference count to a net_context, preventing destruction.
static enum net_context_state net_context_get_state(struct net_context *context)
Get state for this network context.
Definition net_context.h:508
int net_context_connect(struct net_context *context, const struct sockaddr *addr, socklen_t addrlen, net_context_connect_cb_t cb, k_timeout_t timeout, void *user_data)
Create a network connection.
static void net_context_set_can_filter_id(struct net_context *context, int filter_id)
Set CAN filter id for this network context.
Definition net_context.h:636
static bool net_context_is_proxy_enabled(struct net_context *context)
Is socks proxy support enabled or disabled for this context.
Definition net_context.h:910
#define NET_CONTEXT_IN_USE
Is this context used or not.
Definition net_context.h:38
static void net_context_set_accepting(struct net_context *context, bool accepting)
Set this context to accept data now.
Definition net_context.h:447
bool net_context_port_in_use(enum net_ip_protocol ip_proto, uint16_t local_port, const struct sockaddr *local_addr)
Check if a port is in use (bound)
static void net_context_set_family(struct net_context *context, sa_family_t family)
Set address family for this network context.
Definition net_context.h:561
static int net_context_create_ipv6_new(struct net_context *context, struct net_pkt *pkt, const struct in6_addr *src, const struct in6_addr *dst)
Create IPv6 packet in provided net_pkt from context.
Definition net_context.h:1024
static int net_context_create_ipv4_new(struct net_context *context, struct net_pkt *pkt, const struct in_addr *src, const struct in_addr *dst)
Create IPv4 packet in provided net_pkt from context.
Definition net_context.h:999
int net_context_recv(struct net_context *context, net_context_recv_cb_t cb, k_timeout_t timeout, void *user_data)
Receive network data from a peer specified by context.
static int net_context_get_can_filter_id(struct net_context *context)
Get CAN filter id for this network context.
Definition net_context.h:661
#define NET_CONTEXT_CLOSING_SOCK
Is the socket closing / closed.
Definition net_context.h:72
static uint8_t net_context_get_ipv6_hop_limit(struct net_context *context)
Get IPv6 hop limit value for this context.
Definition net_context.h:821
static void net_context_set_closing(struct net_context *context, bool closing)
Set this context to closing.
Definition net_context.h:479
static uint8_t net_context_get_ipv6_mcast_hop_limit(struct net_context *context)
Get IPv6 multicast hop limit value for this context.
Definition net_context.h:850
static void net_context_set_proxy_enabled(struct net_context *context, bool enable)
Enable or disable socks proxy support for this context.
Definition net_context.h:886
static uint8_t net_context_get_ipv4_ttl(struct net_context *context)
Get IPv4 TTL (time-to-live) value for this context.
Definition net_context.h:761
#define NET_CONTEXT_BOUND_TO_IFACE
Context is bound to a specific interface.
Definition net_context.h:75
void(* net_context_cb_t)(struct net_context *context, void *user_data)
Callback used while iterating over network contexts.
Definition net_context.h:1332
static void net_context_set_state(struct net_context *context, enum net_context_state state)
Set state for this network context.
Definition net_context.h:525
net_context_option
Network context options.
Definition net_context.h:1276
static void net_context_set_ipv4_mcast_ttl(struct net_context *context, uint8_t ttl)
Set IPv4 multicast TTL (time-to-live) value for this context.
Definition net_context.h:805
void(* net_context_send_cb_t)(struct net_context *context, int status, void *user_data)
Network data send callback.
Definition net_context.h:120
int net_context_update_recv_wnd(struct net_context *context, int32_t delta)
Update TCP receive window for context.
void net_context_foreach(net_context_cb_t cb, void *user_data)
Go through all the network connections and call callback for each network context.
int net_context_set_option(struct net_context *context, enum net_context_option option, const void *value, size_t len)
Set an connection option for this context.
void(* net_tcp_accept_cb_t)(struct net_context *new_context, struct sockaddr *addr, socklen_t addrlen, int status, void *user_data)
Accept callback.
Definition net_context.h:140
int net_context_send(struct net_context *context, const void *buf, size_t len, net_context_send_cb_t cb, k_timeout_t timeout, void *user_data)
Send data to a peer.
static bool net_context_is_closing(struct net_context *context)
Is this context closing.
Definition net_context.h:466
#define NET_CONTEXT_FAMILY
The address family, connection type and IP protocol are stored into a bit field to save space.
Definition net_context.h:60
#define NET_CONTEXT_TYPE
Type of the connection (datagram / stream / raw)
Definition net_context.h:63
static void net_context_set_proto(struct net_context *context, uint16_t proto)
Set context IP protocol for this network context.
Definition net_context.h:694
#define net_context_setup_pools(context, tx_pool, data_pool)
Set custom network buffer pools for context send operations.
Definition net_context.h:1374
static uint16_t net_context_get_proto(struct net_context *context)
Get context IP protocol for this network context.
Definition net_context.h:679
int net_context_get(sa_family_t family, enum net_sock_type type, uint16_t ip_proto, struct net_context **context)
Get network context.
struct net_buf_pool *(* net_pkt_get_pool_func_t)(void)
Function that is called to get the pool that is used for net_buf allocations.
Definition net_context.h:195
#define NET_CONTEXT_ACCEPTING_SOCK
Is the socket accepting connections.
Definition net_context.h:69
int net_context_get_option(struct net_context *context, enum net_context_option option, void *value, size_t *len)
Get connection option value for this context.
static void net_context_set_ipv6_mcast_hop_limit(struct net_context *context, uint8_t hop_limit)
Set IPv6 multicast hop limit value for this context.
Definition net_context.h:864
void(* net_context_recv_cb_t)(struct net_context *context, struct net_pkt *pkt, union net_ip_header *ip_hdr, union net_proto_header *proto_hdr, int status, void *user_data)
Network data receive callback.
Definition net_context.h:99
int net_context_sendto(struct net_context *context, const void *buf, size_t len, const struct sockaddr *dst_addr, socklen_t addrlen, net_context_send_cb_t cb, k_timeout_t timeout, void *user_data)
Send data to a peer specified by address.
static struct net_if * net_context_get_iface(struct net_context *context)
Get network interface for this context.
Definition net_context.h:711
@ NET_OPT_ADDR_PREFERENCES
IPv6 address preference.
Definition net_context.h:1293
@ NET_OPT_MCAST_TTL
IPv4 multicast TTL.
Definition net_context.h:1289
@ NET_OPT_REUSEADDR
Re-use address.
Definition net_context.h:1285
@ NET_OPT_SNDBUF
Send buffer.
Definition net_context.h:1283
@ NET_OPT_RECV_PKTINFO
Receive packet information.
Definition net_context.h:1288
@ NET_OPT_PRIORITY
Context priority.
Definition net_context.h:1277
@ NET_OPT_REUSEPORT
Re-use port.
Definition net_context.h:1286
@ NET_OPT_MCAST_HOP_LIMIT
IPv6 multicast hop limit.
Definition net_context.h:1290
@ NET_OPT_RCVTIMEO
Receive timeout.
Definition net_context.h:1280
@ NET_OPT_TXTIME
TX time.
Definition net_context.h:1278
@ NET_OPT_SNDTIMEO
Send timeout.
Definition net_context.h:1281
@ NET_OPT_SOCKS5
SOCKS5.
Definition net_context.h:1279
@ NET_OPT_TTL
IPv4 unicast TTL.
Definition net_context.h:1292
@ NET_OPT_RCVBUF
Receive buffer.
Definition net_context.h:1282
@ NET_OPT_UNICAST_HOP_LIMIT
IPv6 unicast hop limit.
Definition net_context.h:1291
@ NET_OPT_DSCP_ECN
DSCP ECN.
Definition net_context.h:1284
@ NET_OPT_TIMESTAMPING
Packet timestamping.
Definition net_context.h:1294
@ NET_OPT_IPV6_V6ONLY
Share IPv4 and IPv6 port space.
Definition net_context.h:1287
int net_if_get_by_iface(struct net_if *iface)
Get interface index according to pointer.
struct net_if * net_if_get_by_index(int index)
Get interface according to index.
Public API for network interface.
IPv6 and IPv4 definitions.
flags
Definition parser.h:96
state
Definition parser_state.h:29
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT8_TYPE__ int8_t
Definition stdint.h:72
IPv6 address struct.
Definition net_ip.h:141
IPv4 address struct.
Definition net_ip.h:153
Mutex Structure.
Definition kernel.h:2994
Kernel timeout type.
Definition sys_clock.h:65
Message struct.
Definition net_ip.h:249
Network buffer pool representation.
Definition net_buf.h:1078
Note that we do not store the actual source IP address in the context because the address is already ...
Definition net_context.h:207
atomic_t refcount
Reference count.
Definition net_context.h:218
void * user_data
User data associated with a context.
Definition net_context.h:214
void * fifo_reserved
First member of the structure to allow to put contexts into a FIFO.
Definition net_context.h:210
uint16_t flags
Flags for the context.
Definition net_context.h:375
uint8_t ipv4_mcast_ttl
IPv4 multicast TTL.
Definition net_context.h:388
net_context_send_cb_t send_cb
Send callback to be called when the packet has been sent successfully.
Definition net_context.h:245
struct sockaddr remote
Remote endpoint address.
Definition net_context.h:232
struct k_mutex lock
Internal lock for protecting this context from multiple access.
Definition net_context.h:222
struct sockaddr_ptr local
Local endpoint address.
Definition net_context.h:227
struct net_context::@357 options
Option values.
uint8_t ipv4_ttl
IPv4 TTL.
Definition net_context.h:387
uint8_t ipv6_mcast_hop_limit
IPv6 multicast hop limit.
Definition net_context.h:384
net_context_connect_cb_t connect_cb
Connect callback to be called when a connection has been established.
Definition net_context.h:250
struct net_conn_handle * conn_handler
Connection handle.
Definition net_context.h:235
uint16_t proto
Protocol (UDP, TCP or IEEE 802.3 protocol value)
Definition net_context.h:372
int8_t iface
Network interface assigned to this context.
Definition net_context.h:378
void * tcp
TCP connection information.
Definition net_context.h:264
net_context_recv_cb_t recv_cb
Receive callback to be called when desired packet has been received.
Definition net_context.h:240
uint8_t ipv6_hop_limit
IPv6 hop limit.
Definition net_context.h:383
Network Interface structure.
Definition net_if.h:680
Network packet.
Definition net_pkt.h:69
Generic sockaddr struct.
Definition net_ip.h:387