16#ifndef ZEPHYR_INCLUDE_NET_NET_PKT_H_
17#define ZEPHYR_INCLUDE_NET_NET_PKT_H_
24#if defined(CONFIG_IEEE802154)
53#if defined(CONFIG_NET_PKT_ALLOC_STATS)
54struct net_pkt_alloc_stats {
60struct net_pkt_alloc_stats_slab {
61 struct net_pkt_alloc_stats ok;
62 struct net_pkt_alloc_stats fail;
63 struct k_mem_slab *slab;
66#define NET_PKT_ALLOC_STATS_DEFINE(alloc_name, slab_name) \
67 STRUCT_SECTION_ITERABLE(net_pkt_alloc_stats_slab, alloc_name) = { \
72#define NET_PKT_ALLOC_STATS_DEFINE(name, slab)
76struct net_pkt_cursor {
118#if defined(CONFIG_NET_TCP)
122#if defined(CONFIG_NET_ROUTING) || defined(CONFIG_NET_ETHERNET_BRIDGE)
123 struct net_if *orig_iface;
126#if defined(CONFIG_NET_PKT_TIMESTAMP) || defined(CONFIG_NET_PKT_TXTIME)
148#if defined(CONFIG_NET_PKT_RXTIME_STATS) || defined(CONFIG_NET_PKT_TXTIME_STATS) || \
149 defined(CONFIG_TRACING_NET_CORE)
154#if defined(CONFIG_NET_PKT_TXTIME_STATS_DETAIL) || \
155 defined(CONFIG_NET_PKT_RXTIME_STATS_DETAIL)
170#if defined(CONFIG_NET_PKT_ALLOC_STATS)
171 struct net_pkt_alloc_stats_slab *alloc_stats;
182#if defined(CONFIG_NET_IP)
199#if defined(CONFIG_NET_IPV4_ACD)
206#if defined(CONFIG_NET_LLDP)
227#if defined(CONFIG_NET_IP_FRAGMENT)
230#if defined(CONFIG_NET_PKT_TIMESTAMP)
236#if defined(CONFIG_NET_IP)
241#if defined(CONFIG_NET_IPV6)
244#if defined(CONFIG_NET_IPV4)
250#if defined(CONFIG_NET_IPV4)
253#if defined(CONFIG_NET_IPV6)
258#if defined(CONFIG_NET_IP_FRAGMENT)
260#if defined(CONFIG_NET_IPV4_FRAGMENT)
266#if defined(CONFIG_NET_IPV6_FRAGMENT)
276#if defined(CONFIG_NET_IPV6)
288#if defined(CONFIG_NET_IP_DSCP_ECN)
297#if defined(CONFIG_NET_VLAN)
306#if defined(NET_PKT_HAS_CONTROL_BLOCK)
311#if defined(CONFIG_IEEE802154)
315 struct net_pkt_cb_ieee802154 cb;
324#if defined(CONFIG_NET_OFFLOAD) || defined(CONFIG_NET_L2_IPIP)
336 struct sockaddr_storage remote_storage;
340#if defined(CONFIG_NET_CAPTURE_COOKED_MODE)
361static inline void net_pkt_set_context(
struct net_pkt *pkt,
367static inline struct net_if *net_pkt_iface(
struct net_pkt *pkt)
372static inline void net_pkt_set_iface(
struct net_pkt *pkt,
struct net_if *iface)
383 pkt->lladdr_src.type = type;
384 pkt->lladdr_dst.type = type;
388static inline struct net_if *net_pkt_orig_iface(
struct net_pkt *pkt)
390#if defined(CONFIG_NET_ROUTING) || defined(CONFIG_NET_ETHERNET_BRIDGE)
391 return pkt->orig_iface;
397static inline void net_pkt_set_orig_iface(
struct net_pkt *pkt,
400#if defined(CONFIG_NET_ROUTING) || defined(CONFIG_NET_ETHERNET_BRIDGE)
401 pkt->orig_iface = iface;
413static inline void net_pkt_set_family(
struct net_pkt *pkt,
uint8_t family)
415 pkt->family = family;
418static inline bool net_pkt_is_ptp(
struct net_pkt *pkt)
420 return !!(pkt->ptp_pkt);
423static inline void net_pkt_set_ptp(
struct net_pkt *pkt,
bool is_ptp)
425 pkt->ptp_pkt = is_ptp;
428static inline bool net_pkt_is_tx_timestamping(
struct net_pkt *pkt)
430#if defined(CONFIG_NET_PKT_TIMESTAMP)
431 return !!(pkt->tx_timestamping);
439static inline void net_pkt_set_tx_timestamping(
struct net_pkt *pkt,
bool is_timestamping)
441#if defined(CONFIG_NET_PKT_TIMESTAMP)
442 pkt->tx_timestamping = is_timestamping;
445 ARG_UNUSED(is_timestamping);
449static inline bool net_pkt_is_rx_timestamping(
struct net_pkt *pkt)
451#if defined(CONFIG_NET_PKT_TIMESTAMP)
452 return !!(pkt->rx_timestamping);
460static inline void net_pkt_set_rx_timestamping(
struct net_pkt *pkt,
bool is_timestamping)
462#if defined(CONFIG_NET_PKT_TIMESTAMP)
463 pkt->rx_timestamping = is_timestamping;
466 ARG_UNUSED(is_timestamping);
470static inline bool net_pkt_is_captured(
struct net_pkt *pkt)
472 return !!(pkt->captured);
475static inline void net_pkt_set_captured(
struct net_pkt *pkt,
bool is_captured)
477 pkt->captured = is_captured;
480static inline bool net_pkt_is_l2_bridged(
struct net_pkt *pkt)
482 return IS_ENABLED(CONFIG_NET_ETHERNET_BRIDGE) ? !!(pkt->l2_bridged) : 0;
485static inline void net_pkt_set_l2_bridged(
struct net_pkt *pkt,
bool is_l2_bridged)
488 pkt->l2_bridged = is_l2_bridged;
492static inline bool net_pkt_is_l2_processed(
struct net_pkt *pkt)
494 return !!(pkt->l2_processed);
497static inline void net_pkt_set_l2_processed(
struct net_pkt *pkt,
498 bool is_l2_processed)
500 pkt->l2_processed = is_l2_processed;
503static inline bool net_pkt_is_chksum_done(
struct net_pkt *pkt)
505 return !!(pkt->chksum_done);
508static inline void net_pkt_set_chksum_done(
struct net_pkt *pkt,
511 pkt->chksum_done = is_chksum_done;
516#if defined(CONFIG_NET_IP)
517 return pkt->ip_hdr_len;
525static inline void net_pkt_set_ip_hdr_len(
struct net_pkt *pkt,
uint8_t len)
527#if defined(CONFIG_NET_IP)
528 pkt->ip_hdr_len = len;
537#if defined(CONFIG_NET_IP_DSCP_ECN)
546static inline void net_pkt_set_ip_dscp(
struct net_pkt *pkt,
uint8_t dscp)
548#if defined(CONFIG_NET_IP_DSCP_ECN)
558#if defined(CONFIG_NET_IP_DSCP_ECN)
567static inline void net_pkt_set_ip_ecn(
struct net_pkt *pkt,
uint8_t ecn)
569#if defined(CONFIG_NET_IP_DSCP_ECN)
582static inline void net_pkt_set_eof(
struct net_pkt *pkt,
bool eof)
587static inline bool net_pkt_forwarding(
struct net_pkt *pkt)
589 return !!(pkt->forwarding);
592static inline void net_pkt_set_forwarding(
struct net_pkt *pkt,
bool forward)
594 pkt->forwarding = forward;
597#if defined(CONFIG_NET_IPV4)
600 return pkt->ipv4_ttl;
603static inline void net_pkt_set_ipv4_ttl(
struct net_pkt *pkt,
611 return pkt->ipv4_opts_len;
614static inline void net_pkt_set_ipv4_opts_len(
struct net_pkt *pkt,
617 pkt->ipv4_opts_len = opts_len;
627static inline void net_pkt_set_ipv4_ttl(
struct net_pkt *pkt,
640static inline void net_pkt_set_ipv4_opts_len(
struct net_pkt *pkt,
644 ARG_UNUSED(opts_len);
648#if defined(CONFIG_NET_IPV6)
649static inline uint8_t net_pkt_ipv6_ext_opt_len(
struct net_pkt *pkt)
651 return pkt->ipv6_ext_opt_len;
654static inline void net_pkt_set_ipv6_ext_opt_len(
struct net_pkt *pkt,
657 pkt->ipv6_ext_opt_len = len;
662 return pkt->ipv6_next_hdr;
665static inline void net_pkt_set_ipv6_next_hdr(
struct net_pkt *pkt,
668 pkt->ipv6_next_hdr = next_hdr;
673 return pkt->ipv6_ext_len;
676static inline void net_pkt_set_ipv6_ext_len(
struct net_pkt *pkt,
uint16_t len)
678 pkt->ipv6_ext_len = len;
683 return pkt->ipv6_prev_hdr_start;
686static inline void net_pkt_set_ipv6_hdr_prev(
struct net_pkt *pkt,
689 pkt->ipv6_prev_hdr_start = offset;
694 return pkt->ipv6_hop_limit;
697static inline void net_pkt_set_ipv6_hop_limit(
struct net_pkt *pkt,
700 pkt->ipv6_hop_limit = hop_limit;
703static inline uint8_t net_pkt_ipv6_ext_opt_len(
struct net_pkt *pkt)
710static inline void net_pkt_set_ipv6_ext_opt_len(
struct net_pkt *pkt,
724static inline void net_pkt_set_ipv6_next_hdr(
struct net_pkt *pkt,
728 ARG_UNUSED(next_hdr);
738static inline void net_pkt_set_ipv6_ext_len(
struct net_pkt *pkt,
uint16_t len)
751static inline void net_pkt_set_ipv6_hdr_prev(
struct net_pkt *pkt,
765static inline void net_pkt_set_ipv6_hop_limit(
struct net_pkt *pkt,
769 ARG_UNUSED(hop_limit);
775#if defined(CONFIG_NET_IPV6)
776 return pkt->ipv6_ext_len;
777#elif defined(CONFIG_NET_IPV4)
778 return pkt->ipv4_opts_len;
786#if defined(CONFIG_NET_IPV4_FRAGMENT)
787static inline uint16_t net_pkt_ipv4_fragment_offset(
struct net_pkt *pkt)
789 return (pkt->ipv4_fragment.flags & NET_IPV4_FRAGH_OFFSET_MASK) * 8;
792static inline bool net_pkt_ipv4_fragment_more(
struct net_pkt *pkt)
794 return (pkt->ipv4_fragment.flags & NET_IPV4_MORE_FRAG_MASK) != 0;
799 pkt->ipv4_fragment.flags =
flags;
804 return pkt->ipv4_fragment.id;
807static inline void net_pkt_set_ipv4_fragment_id(
struct net_pkt *pkt,
uint32_t id)
809 pkt->ipv4_fragment.id = id;
812static inline uint16_t net_pkt_ipv4_fragment_offset(
struct net_pkt *pkt)
819static inline bool net_pkt_ipv4_fragment_more(
struct net_pkt *pkt)
839static inline void net_pkt_set_ipv4_fragment_id(
struct net_pkt *pkt,
uint32_t id)
846#if defined(CONFIG_NET_IPV6_FRAGMENT)
849 return pkt->ipv6_fragment.hdr_start;
852static inline void net_pkt_set_ipv6_fragment_start(
struct net_pkt *pkt,
855 pkt->ipv6_fragment.hdr_start = start;
858static inline uint16_t net_pkt_ipv6_fragment_offset(
struct net_pkt *pkt)
860 return pkt->ipv6_fragment.flags & NET_IPV6_FRAGH_OFFSET_MASK;
862static inline bool net_pkt_ipv6_fragment_more(
struct net_pkt *pkt)
864 return (pkt->ipv6_fragment.flags & 0x01) != 0;
867static inline void net_pkt_set_ipv6_fragment_flags(
struct net_pkt *pkt,
870 pkt->ipv6_fragment.flags =
flags;
875 return pkt->ipv6_fragment.id;
878static inline void net_pkt_set_ipv6_fragment_id(
struct net_pkt *pkt,
881 pkt->ipv6_fragment.id = id;
891static inline void net_pkt_set_ipv6_fragment_start(
struct net_pkt *pkt,
898static inline uint16_t net_pkt_ipv6_fragment_offset(
struct net_pkt *pkt)
905static inline bool net_pkt_ipv6_fragment_more(
struct net_pkt *pkt)
912static inline void net_pkt_set_ipv6_fragment_flags(
struct net_pkt *pkt,
926static inline void net_pkt_set_ipv6_fragment_id(
struct net_pkt *pkt,
934#if defined(CONFIG_NET_IP_FRAGMENT)
935static inline bool net_pkt_is_ip_reassembled(
struct net_pkt *pkt)
937 return !!(pkt->ip_reassembled);
940static inline void net_pkt_set_ip_reassembled(
struct net_pkt *pkt,
943 pkt->ip_reassembled = reassembled;
946static inline bool net_pkt_is_ip_reassembled(
struct net_pkt *pkt)
953static inline void net_pkt_set_ip_reassembled(
struct net_pkt *pkt,
957 ARG_UNUSED(reassembled);
963 return pkt->priority;
966static inline void net_pkt_set_priority(
struct net_pkt *pkt,
969 pkt->priority = priority;
972#if defined(CONFIG_NET_CAPTURE_COOKED_MODE)
973static inline bool net_pkt_is_cooked_mode(
struct net_pkt *pkt)
975 return pkt->cooked_mode_pkt;
978static inline void net_pkt_set_cooked_mode(
struct net_pkt *pkt,
bool value)
980 pkt->cooked_mode_pkt = value;
983static inline bool net_pkt_is_cooked_mode(
struct net_pkt *pkt)
990static inline void net_pkt_set_cooked_mode(
struct net_pkt *pkt,
bool value)
997#if defined(CONFIG_NET_VLAN)
1003static inline void net_pkt_set_vlan_tag(
struct net_pkt *pkt,
uint16_t tag)
1013static inline void net_pkt_set_vlan_priority(
struct net_pkt *pkt,
1019static inline bool net_pkt_vlan_dei(
struct net_pkt *pkt)
1024static inline void net_pkt_set_vlan_dei(
struct net_pkt *pkt,
bool dei)
1029static inline void net_pkt_set_vlan_tci(
struct net_pkt *pkt,
uint16_t tci)
1031 pkt->vlan_tci = tci;
1036 return pkt->vlan_tci;
1046static inline void net_pkt_set_vlan_tag(
struct net_pkt *pkt,
uint16_t tag)
1059static inline bool net_pkt_vlan_dei(
struct net_pkt *pkt)
1066static inline void net_pkt_set_vlan_dei(
struct net_pkt *pkt,
bool dei)
1079static inline void net_pkt_set_vlan_tci(
struct net_pkt *pkt,
uint16_t tci)
1086#if defined(CONFIG_NET_PKT_TIMESTAMP) || defined(CONFIG_NET_PKT_TXTIME)
1089 return &pkt->timestamp;
1092static inline void net_pkt_set_timestamp(
struct net_pkt *pkt,
1095 pkt->timestamp.second = timestamp->
second;
1096 pkt->timestamp.nanosecond = timestamp->
nanosecond;
1104static inline void net_pkt_set_timestamp_ns(
struct net_pkt *pkt,
net_time_t timestamp)
1116static inline void net_pkt_set_timestamp(
struct net_pkt *pkt,
1120 ARG_UNUSED(timestamp);
1130static inline void net_pkt_set_timestamp_ns(
struct net_pkt *pkt,
net_time_t timestamp)
1133 ARG_UNUSED(timestamp);
1137#if defined(CONFIG_NET_PKT_RXTIME_STATS) || defined(CONFIG_NET_PKT_TXTIME_STATS) || \
1138 defined(CONFIG_TRACING_NET_CORE)
1142 return pkt->create_time;
1145static inline void net_pkt_set_create_time(
struct net_pkt *pkt,
1148 pkt->create_time = create_time;
1158static inline void net_pkt_set_create_time(
struct net_pkt *pkt,
1162 ARG_UNUSED(create_time);
1168#if defined(CONFIG_NET_PKT_TXTIME_STATS_DETAIL) || \
1169 defined(CONFIG_NET_PKT_RXTIME_STATS_DETAIL)
1172 return pkt->detail.stat;
1175static inline int net_pkt_stats_tick_count(
struct net_pkt *pkt)
1177 return pkt->detail.count;
1180static inline void net_pkt_stats_tick_reset(
struct net_pkt *pkt)
1182 memset(&pkt->detail, 0,
sizeof(pkt->detail));
1188 if (pkt->detail.count >= NET_PKT_DETAIL_STATS_COUNT) {
1189 NET_ERR(
"Detail stats count overflow (%d >= %d)",
1190 pkt->detail.count, NET_PKT_DETAIL_STATS_COUNT);
1194 pkt->detail.stat[pkt->detail.count++] = tick;
1197#define net_pkt_set_tx_stats_tick(pkt, tick) net_pkt_set_stats_tick(pkt, tick)
1198#define net_pkt_set_rx_stats_tick(pkt, tick) net_pkt_set_stats_tick(pkt, tick)
1207static inline int net_pkt_stats_tick_count(
struct net_pkt *pkt)
1214static inline void net_pkt_stats_tick_reset(
struct net_pkt *pkt)
1219static inline void net_pkt_set_stats_tick(
struct net_pkt *pkt,
uint32_t tick)
1225#define net_pkt_set_tx_stats_tick(pkt, tick)
1226#define net_pkt_set_rx_stats_tick(pkt, tick)
1230static inline size_t net_pkt_get_len(
struct net_pkt *pkt)
1245static inline bool net_pkt_is_empty(
struct net_pkt *pkt)
1252 return &pkt->lladdr_src;
1257 return &pkt->lladdr_dst;
1260static inline void net_pkt_lladdr_swap(
struct net_pkt *pkt)
1264 net_pkt_lladdr_src(pkt)->addr = net_pkt_lladdr_dst(pkt)->addr;
1265 net_pkt_lladdr_dst(pkt)->addr =
addr;
1268static inline void net_pkt_lladdr_clear(
struct net_pkt *pkt)
1270 net_pkt_lladdr_src(pkt)->addr = NULL;
1271 net_pkt_lladdr_src(pkt)->len = 0U;
1276 return pkt->ll_proto_type;
1281 pkt->ll_proto_type =
type;
1284#if defined(CONFIG_NET_IPV4_ACD)
1285static inline bool net_pkt_ipv4_acd(
struct net_pkt *pkt)
1287 return !!(pkt->ipv4_acd_arp_msg);
1290static inline void net_pkt_set_ipv4_acd(
struct net_pkt *pkt,
1291 bool is_acd_arp_msg)
1293 pkt->ipv4_acd_arp_msg = is_acd_arp_msg;
1296static inline bool net_pkt_ipv4_acd(
struct net_pkt *pkt)
1303static inline void net_pkt_set_ipv4_acd(
struct net_pkt *pkt,
1304 bool is_acd_arp_msg)
1307 ARG_UNUSED(is_acd_arp_msg);
1311#if defined(CONFIG_NET_LLDP)
1312static inline bool net_pkt_is_lldp(
struct net_pkt *pkt)
1314 return !!(pkt->lldp_pkt);
1317static inline void net_pkt_set_lldp(
struct net_pkt *pkt,
bool is_lldp)
1319 pkt->lldp_pkt = is_lldp;
1322static inline bool net_pkt_is_lldp(
struct net_pkt *pkt)
1329static inline void net_pkt_set_lldp(
struct net_pkt *pkt,
bool is_lldp)
1332 ARG_UNUSED(is_lldp);
1336#if defined(CONFIG_NET_L2_PPP)
1337static inline bool net_pkt_is_ppp(
struct net_pkt *pkt)
1339 return !!(pkt->ppp_msg);
1342static inline void net_pkt_set_ppp(
struct net_pkt *pkt,
1345 pkt->ppp_msg = is_ppp_msg;
1348static inline bool net_pkt_is_ppp(
struct net_pkt *pkt)
1355static inline void net_pkt_set_ppp(
struct net_pkt *pkt,
1359 ARG_UNUSED(is_ppp_msg);
1363#if defined(NET_PKT_HAS_CONTROL_BLOCK)
1364static inline void *net_pkt_cb(
struct net_pkt *pkt)
1369static inline void *net_pkt_cb(
struct net_pkt *pkt)
1377#define NET_IPV6_HDR(pkt) ((struct net_ipv6_hdr *)net_pkt_ip_data(pkt))
1378#define NET_IPV4_HDR(pkt) ((struct net_ipv4_hdr *)net_pkt_ip_data(pkt))
1380static inline void net_pkt_set_src_ipv6_addr(
struct net_pkt *pkt)
1383 net_pkt_context(pkt)),
1384 (
struct in6_addr *)NET_IPV6_HDR(pkt)->src);
1387static inline void net_pkt_set_overwrite(
struct net_pkt *pkt,
bool overwrite)
1389 pkt->overwrite = overwrite;
1392static inline bool net_pkt_is_being_overwritten(
struct net_pkt *pkt)
1394 return !!(pkt->overwrite);
1397#ifdef CONFIG_NET_PKT_FILTER
1399bool net_pkt_filter_send_ok(
struct net_pkt *pkt);
1400bool net_pkt_filter_recv_ok(
struct net_pkt *pkt);
1404static inline bool net_pkt_filter_send_ok(
struct net_pkt *pkt)
1411static inline bool net_pkt_filter_recv_ok(
struct net_pkt *pkt)
1420#if defined(CONFIG_NET_PKT_FILTER) && \
1421 (defined(CONFIG_NET_PKT_FILTER_IPV4_HOOK) || defined(CONFIG_NET_PKT_FILTER_IPV6_HOOK))
1423bool net_pkt_filter_ip_recv_ok(
struct net_pkt *pkt);
1427static inline bool net_pkt_filter_ip_recv_ok(
struct net_pkt *pkt)
1436#if defined(CONFIG_NET_PKT_FILTER) && defined(CONFIG_NET_PKT_FILTER_LOCAL_IN_HOOK)
1438bool net_pkt_filter_local_in_recv_ok(
struct net_pkt *pkt);
1442static inline bool net_pkt_filter_local_in_recv_ok(
struct net_pkt *pkt)
1451#if defined(CONFIG_NET_OFFLOAD) || defined(CONFIG_NET_L2_IPIP)
1452static inline struct sockaddr *net_pkt_remote_address(
struct net_pkt *pkt)
1454 return &pkt->remote;
1457static inline void net_pkt_set_remote_address(
struct net_pkt *pkt,
1461 memcpy(&pkt->remote, address, len);
1480#define NET_PKT_SLAB_DEFINE(name, count) \
1481 K_MEM_SLAB_DEFINE(name, sizeof(struct net_pkt), count, 4); \
1482 NET_PKT_ALLOC_STATS_DEFINE(pkt_alloc_stats_##name, name)
1487#define NET_PKT_TX_SLAB_DEFINE(name, count) NET_PKT_SLAB_DEFINE(name, count)
1504#define NET_PKT_DATA_POOL_DEFINE(name, count) \
1505 NET_BUF_POOL_DEFINE(name, count, CONFIG_NET_BUF_DATA_SIZE, \
1510#if defined(CONFIG_NET_DEBUG_NET_PKT_ALLOC) || \
1511 (CONFIG_NET_PKT_LOG_LEVEL >= LOG_LEVEL_DBG)
1512#define NET_PKT_DEBUG_ENABLED
1515#if defined(NET_PKT_DEBUG_ENABLED)
1527#define net_pkt_get_reserve_data(pool, min_len, timeout) \
1528 net_pkt_get_reserve_data_debug(pool, min_len, timeout, __func__, __LINE__)
1530struct net_buf *net_pkt_get_reserve_rx_data_debug(
size_t min_len,
1534#define net_pkt_get_reserve_rx_data(min_len, timeout) \
1535 net_pkt_get_reserve_rx_data_debug(min_len, timeout, __func__, __LINE__)
1537struct net_buf *net_pkt_get_reserve_tx_data_debug(
size_t min_len,
1541#define net_pkt_get_reserve_tx_data(min_len, timeout) \
1542 net_pkt_get_reserve_tx_data_debug(min_len, timeout, __func__, __LINE__)
1544struct net_buf *net_pkt_get_frag_debug(
struct net_pkt *pkt,
size_t min_len,
1546 const char *caller,
int line);
1547#define net_pkt_get_frag(pkt, min_len, timeout) \
1548 net_pkt_get_frag_debug(pkt, min_len, timeout, __func__, __LINE__)
1550void net_pkt_unref_debug(
struct net_pkt *pkt,
const char *caller,
int line);
1551#define net_pkt_unref(pkt) net_pkt_unref_debug(pkt, __func__, __LINE__)
1553struct net_pkt *net_pkt_ref_debug(
struct net_pkt *pkt,
const char *caller,
1555#define net_pkt_ref(pkt) net_pkt_ref_debug(pkt, __func__, __LINE__)
1558 const char *caller,
int line);
1559#define net_pkt_frag_ref(frag) net_pkt_frag_ref_debug(frag, __func__, __LINE__)
1561void net_pkt_frag_unref_debug(
struct net_buf *frag,
1562 const char *caller,
int line);
1563#define net_pkt_frag_unref(frag) \
1564 net_pkt_frag_unref_debug(frag, __func__, __LINE__)
1569 const char *caller,
int line);
1570#define net_pkt_frag_del(pkt, parent, frag) \
1571 net_pkt_frag_del_debug(pkt, parent, frag, __func__, __LINE__)
1573void net_pkt_frag_add_debug(
struct net_pkt *pkt,
struct net_buf *frag,
1574 const char *caller,
int line);
1575#define net_pkt_frag_add(pkt, frag) \
1576 net_pkt_frag_add_debug(pkt, frag, __func__, __LINE__)
1578void net_pkt_frag_insert_debug(
struct net_pkt *pkt,
struct net_buf *frag,
1579 const char *caller,
int line);
1580#define net_pkt_frag_insert(pkt, frag) \
1581 net_pkt_frag_insert_debug(pkt, frag, __func__, __LINE__)
1587#if defined(NET_PKT_DEBUG_ENABLED)
1597#define net_pkt_print_frags(pkt)
1600#if !defined(NET_PKT_DEBUG_ENABLED)
1619#if !defined(NET_PKT_DEBUG_ENABLED)
1637#if !defined(NET_PKT_DEBUG_ENABLED)
1655#if !defined(NET_PKT_DEBUG_ENABLED)
1672#if !defined(NET_PKT_DEBUG_ENABLED)
1685#if !defined(NET_PKT_DEBUG_ENABLED)
1698#if !defined(NET_PKT_DEBUG_ENABLED)
1711#if !defined(NET_PKT_DEBUG_ENABLED)
1720#if !defined(NET_PKT_DEBUG_ENABLED)
1736#if !defined(NET_PKT_DEBUG_ENABLED)
1746#if !defined(NET_PKT_DEBUG_ENABLED)
1773 struct k_mem_slab **tx,
1779#if defined(CONFIG_NET_DEBUG_NET_PKT_ALLOC)
1783void net_pkt_print(
void);
1785typedef void (*net_pkt_allocs_cb_t)(
struct net_pkt *pkt,
1787 const char *func_alloc,
1789 const char *func_free,
1794void net_pkt_allocs_foreach(net_pkt_allocs_cb_t cb,
void *
user_data);
1796const char *net_pkt_slab2str(
struct k_mem_slab *slab);
1797const char *net_pkt_pool2str(
struct net_buf_pool *pool);
1800#define net_pkt_print(...)
1806#if defined(NET_PKT_DEBUG_ENABLED)
1809 const char *caller,
int line);
1810#define net_pkt_alloc(_timeout) \
1811 net_pkt_alloc_debug(_timeout, __func__, __LINE__)
1813struct net_pkt *net_pkt_alloc_from_slab_debug(
struct k_mem_slab *
slab,
1815 const char *caller,
int line);
1816#define net_pkt_alloc_from_slab(_slab, _timeout) \
1817 net_pkt_alloc_from_slab_debug(_slab, _timeout, __func__, __LINE__)
1820 const char *caller,
int line);
1821#define net_pkt_rx_alloc(_timeout) \
1822 net_pkt_rx_alloc_debug(_timeout, __func__, __LINE__)
1828#define net_pkt_alloc_on_iface(_iface, _timeout) \
1829 net_pkt_alloc_on_iface_debug(_iface, _timeout, __func__, __LINE__)
1835#define net_pkt_rx_alloc_on_iface(_iface, _timeout) \
1836 net_pkt_rx_alloc_on_iface_debug(_iface, _timeout, \
1839int net_pkt_alloc_buffer_debug(
struct net_pkt *pkt,
1843 const char *caller,
int line);
1844#define net_pkt_alloc_buffer(_pkt, _size, _proto, _timeout) \
1845 net_pkt_alloc_buffer_debug(_pkt, _size, _proto, _timeout, \
1848int net_pkt_alloc_buffer_raw_debug(
struct net_pkt *pkt,
size_t size,
1850 const char *caller,
int line);
1851#define net_pkt_alloc_buffer_raw(_pkt, _size, _timeout) \
1852 net_pkt_alloc_buffer_raw_debug(_pkt, _size, _timeout, \
1862#define net_pkt_alloc_with_buffer(_iface, _size, _family, \
1864 net_pkt_alloc_with_buffer_debug(_iface, _size, _family, \
1875#define net_pkt_rx_alloc_with_buffer(_iface, _size, _family, \
1877 net_pkt_rx_alloc_with_buffer_debug(_iface, _size, _family, \
1883#if !defined(NET_PKT_DEBUG_ENABLED)
1897#if !defined(NET_PKT_DEBUG_ENABLED)
1916#if !defined(NET_PKT_DEBUG_ENABLED)
1930#if !defined(NET_PKT_DEBUG_ENABLED)
1951#if !defined(NET_PKT_DEBUG_ENABLED)
1973#if !defined(NET_PKT_DEBUG_ENABLED)
1991#if !defined(NET_PKT_DEBUG_ENABLED)
2102 struct net_pkt_cursor *backup)
2104 backup->buf = pkt->
cursor.buf;
2105 backup->pos = pkt->
cursor.pos;
2115 struct net_pkt_cursor *backup)
2117 pkt->
cursor.buf = backup->buf;
2118 pkt->
cursor.pos = backup->pos;
2475struct net_pkt_data_access {
2476#if !defined(CONFIG_NET_HEADERS_ALWAYS_CONTIGUOUS)
2482#if defined(CONFIG_NET_HEADERS_ALWAYS_CONTIGUOUS)
2483#define NET_PKT_DATA_ACCESS_DEFINE(_name, _type) \
2484 struct net_pkt_data_access _name = { \
2485 .size = sizeof(_type), \
2488#define NET_PKT_DATA_ACCESS_CONTIGUOUS_DEFINE(_name, _type) \
2489 NET_PKT_DATA_ACCESS_DEFINE(_name, _type)
2492#define NET_PKT_DATA_ACCESS_DEFINE(_name, _type) \
2493 _type _hdr_##_name; \
2494 struct net_pkt_data_access _name = { \
2495 .data = &_hdr_##_name, \
2496 .size = sizeof(_type), \
2499#define NET_PKT_DATA_ACCESS_CONTIGUOUS_DEFINE(_name, _type) \
2500 struct net_pkt_data_access _name = { \
2502 .size = sizeof(_type), \
2523 struct net_pkt_data_access *access);
2539 struct net_pkt_data_access *access);
2546 struct net_pkt_data_access *access)
long atomic_t
Definition atomic_types.h:15
VLAN specific definitions.
unsigned short int sa_family_t
Socket address family type.
Definition net_ip.h:167
#define htons(x)
Convert 16-bit value from host to network byte order.
Definition net_ip.h:123
size_t socklen_t
Length of a socket address.
Definition net_ip.h:171
#define htonl(x)
Convert 32-bit value from host to network byte order.
Definition net_ip.h:131
net_ip_protocol
Protocol numbers from IANA/BSD.
Definition net_ip.h:64
static size_t net_buf_frags_len(const struct net_buf *buf)
Calculate amount of bytes stored in fragments.
Definition net_buf.h:2711
static struct net_if * net_context_get_iface(struct net_context *context)
Get network interface for this context.
Definition net_context.h:711
static struct net_linkaddr * net_if_get_link_addr(struct net_if *iface)
Get an network interface's link address.
Definition net_if.h:1078
static const struct in6_addr * net_if_ipv6_select_src_addr(struct net_if *iface, const struct in6_addr *dst)
Get a IPv6 source address that should be used when sending network data to destination.
Definition net_if.h:2045
void net_pkt_frag_add(struct net_pkt *pkt, struct net_buf *frag)
Add a fragment to a packet at the end of its fragment list.
static int net_pkt_write_be32(struct net_pkt *pkt, uint32_t data)
Write a uint32_t big endian data to a net_pkt.
Definition net_pkt.h:2358
void net_pkt_cursor_init(struct net_pkt *pkt)
Initialize net_pkt cursor.
int net_pkt_skip(struct net_pkt *pkt, size_t length)
Skip some data from a net_pkt.
struct net_pkt * net_pkt_shallow_clone(struct net_pkt *pkt, k_timeout_t timeout)
Clone pkt and increase the refcount of its buffer.
void net_pkt_append_buffer(struct net_pkt *pkt, struct net_buf *buffer)
Append a buffer in packet.
#define net_pkt_print_frags(pkt)
Definition net_pkt.h:1597
int net_pkt_update_length(struct net_pkt *pkt, size_t length)
Update the overall length of a packet.
int net_pkt_pull(struct net_pkt *pkt, size_t length)
Remove data from the packet at current location.
int net_pkt_copy(struct net_pkt *pkt_dst, struct net_pkt *pkt_src, size_t length)
Copy data from a packet into another one.
struct net_pkt * net_pkt_rx_alloc(k_timeout_t timeout)
Allocate an initialized net_pkt for RX.
struct net_pkt * net_pkt_ref(struct net_pkt *pkt)
Increase the packet ref count.
int net_pkt_read_be16(struct net_pkt *pkt, uint16_t *data)
Read uint16_t big endian data from a net_pkt.
int net_pkt_alloc_buffer_raw(struct net_pkt *pkt, size_t size, k_timeout_t timeout)
Allocate buffer for a net_pkt, of specified size, w/o any additional preconditions.
struct net_pkt * net_pkt_alloc_with_buffer(struct net_if *iface, size_t size, sa_family_t family, enum net_ip_protocol proto, k_timeout_t timeout)
Allocate a network packet and buffer at once.
void net_pkt_frag_unref(struct net_buf *frag)
Decrease the packet fragment ref count.
struct net_pkt * net_pkt_rx_clone(struct net_pkt *pkt, k_timeout_t timeout)
Clone pkt and its buffer.
struct net_buf * net_pkt_get_reserve_data(struct net_buf_pool *pool, size_t min_len, k_timeout_t timeout)
Get a data buffer from a given pool.
void net_pkt_trim_buffer(struct net_pkt *pkt)
Trim net_pkt buffer.
struct net_pkt * net_pkt_alloc_on_iface(struct net_if *iface, k_timeout_t timeout)
Allocate a network packet for a specific network interface.
void net_pkt_get_info(struct k_mem_slab **rx, struct k_mem_slab **tx, struct net_buf_pool **rx_data, struct net_buf_pool **tx_data)
Get information about predefined RX, TX and DATA pools.
void net_pkt_unref(struct net_pkt *pkt)
Place packet back into the available packets slab.
static int net_pkt_write_be16(struct net_pkt *pkt, uint16_t data)
Write a uint16_t big endian data to a net_pkt.
Definition net_pkt.h:2339
struct net_pkt * net_pkt_alloc(k_timeout_t timeout)
Allocate an initialized net_pkt.
int net_pkt_read(struct net_pkt *pkt, void *data, size_t length)
Read some data from a net_pkt.
struct net_buf * net_pkt_frag_del(struct net_pkt *pkt, struct net_buf *parent, struct net_buf *frag)
Delete existing fragment from a packet.
int net_pkt_set_data(struct net_pkt *pkt, struct net_pkt_data_access *access)
Set contiguous data into a network packet.
void * net_pkt_get_data(struct net_pkt *pkt, struct net_pkt_data_access *access)
Get data from a network packet in a contiguous way.
static int net_pkt_write_u8(struct net_pkt *pkt, uint8_t data)
Write a byte (uint8_t) data to a net_pkt.
Definition net_pkt.h:2322
size_t net_pkt_available_payload_buffer(struct net_pkt *pkt, enum net_ip_protocol proto)
Get available buffer space for payload from a pkt.
int net_pkt_read_le16(struct net_pkt *pkt, uint16_t *data)
Read uint16_t little endian data from a net_pkt.
int net_pkt_read_be32(struct net_pkt *pkt, uint32_t *data)
Read uint32_t big endian data from a net_pkt.
int net_pkt_remove_tail(struct net_pkt *pkt, size_t length)
Remove length bytes from tail of packet.
struct net_buf * net_pkt_get_reserve_tx_data(size_t min_len, k_timeout_t timeout)
Get TX DATA buffer from pool.
static void * net_pkt_cursor_get_pos(struct net_pkt *pkt)
Returns current position of the cursor.
Definition net_pkt.h:2128
void net_pkt_frag_insert(struct net_pkt *pkt, struct net_buf *frag)
Insert a fragment to a packet at the beginning of its fragment list.
int net_pkt_memset(struct net_pkt *pkt, int byte, size_t length)
Memset some data in a net_pkt.
static void net_pkt_cursor_backup(struct net_pkt *pkt, struct net_pkt_cursor *backup)
Backup net_pkt cursor.
Definition net_pkt.h:2101
void net_pkt_compact(struct net_pkt *pkt)
Compact the fragment list of a packet.
static int net_pkt_acknowledge_data(struct net_pkt *pkt, struct net_pkt_data_access *access)
Acknowledge previously contiguous data taken from a network packet Packet needs to be set to overwrit...
Definition net_pkt.h:2545
static int net_pkt_write_le16(struct net_pkt *pkt, uint16_t data)
Write a uint16_t little endian data to a net_pkt.
Definition net_pkt.h:2396
static void net_pkt_cursor_restore(struct net_pkt *pkt, struct net_pkt_cursor *backup)
Restore net_pkt cursor from a backup.
Definition net_pkt.h:2114
uint16_t net_pkt_get_current_offset(struct net_pkt *pkt)
Get the actual offset in the packet from its cursor.
size_t net_pkt_remaining_data(struct net_pkt *pkt)
Get the amount of data which can be read from current cursor position.
int net_pkt_alloc_buffer(struct net_pkt *pkt, size_t size, enum net_ip_protocol proto, k_timeout_t timeout)
Allocate buffer for a net_pkt.
int net_pkt_write(struct net_pkt *pkt, const void *data, size_t length)
Write data into a net_pkt.
struct net_buf * net_pkt_frag_ref(struct net_buf *frag)
Increase the packet fragment ref count.
size_t net_pkt_available_buffer(struct net_pkt *pkt)
Get available buffer space from a pkt.
struct net_pkt * net_pkt_clone(struct net_pkt *pkt, k_timeout_t timeout)
Clone pkt and its buffer.
struct net_pkt * net_pkt_alloc_from_slab(struct k_mem_slab *slab, k_timeout_t timeout)
Allocate an initialized net_pkt from a specific slab.
static int net_pkt_write_le32(struct net_pkt *pkt, uint32_t data)
Write a uint32_t little endian data to a net_pkt.
Definition net_pkt.h:2377
struct net_buf * net_pkt_get_reserve_rx_data(size_t min_len, k_timeout_t timeout)
Get RX DATA buffer from pool.
bool net_pkt_is_contiguous(struct net_pkt *pkt, size_t size)
Check if a data size could fit contiguously.
static int net_pkt_read_u8(struct net_pkt *pkt, uint8_t *data)
Read a byte (uint8_t) from a net_pkt.
Definition net_pkt.h:2248
struct net_buf * net_pkt_get_frag(struct net_pkt *pkt, size_t min_len, k_timeout_t timeout)
Get a data fragment that might be from user specific buffer pool or from global DATA pool.
size_t net_pkt_get_contiguous_len(struct net_pkt *pkt)
Get the contiguous buffer space.
int64_t net_time_t
Any occurrence of net_time_t specifies a concept of nanosecond resolution scalar time span,...
Definition net_time.h:103
static net_time_t net_ptp_time_to_ns(struct net_ptp_time *ts)
Convert a PTP timestamp to a nanosecond precision timestamp, both related to the local network refere...
Definition ptp_time.h:210
static struct net_ptp_time ns_to_net_ptp_time(net_time_t nsec)
Convert a nanosecond precision timestamp to a PTP timestamp, both related to the local network refere...
Definition ptp_time.h:231
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:140
static uint16_t net_eth_vlan_set_vid(uint16_t tci, uint16_t vid)
Set VLAN identifier to TCI.
Definition ethernet_vlan.h:78
static uint8_t net_eth_vlan_get_dei(uint16_t tci)
Get Drop Eligible Indicator from TCI.
Definition ethernet_vlan.h:53
#define NET_VLAN_TAG_UNSPEC
Unspecified VLAN tag value.
Definition ethernet_vlan.h:32
static uint16_t net_eth_vlan_set_dei(uint16_t tci, bool dei)
Set Drop Eligible Indicator to TCI.
Definition ethernet_vlan.h:91
static uint16_t net_eth_vlan_get_vid(uint16_t tci)
Get VLAN identifier from TCI.
Definition ethernet_vlan.h:41
static uint16_t net_eth_vlan_set_pcp(uint16_t tci, uint8_t pcp)
Set Priority Code Point to TCI.
Definition ethernet_vlan.h:104
static uint8_t net_eth_vlan_get_pcp(uint16_t tci)
Get Priority Code Point from TCI.
Definition ethernet_vlan.h:65
Packet data common to all IEEE 802.15.4 L2 layers.
Network context definitions.
Network core definitions.
Public API for network interface.
IPv6 and IPv4 definitions.
Public API for network link address.
Representation of nanosecond resolution elapsed time and timestamps in the network stack.
flags
Definition parser.h:96
Public functions for the Precision Time Protocol time specification.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INTPTR_TYPE__ intptr_t
Definition stdint.h:104
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
void * memset(void *buf, int c, size_t n)
void * memcpy(void *ZRESTRICT d, const void *ZRESTRICT s, size_t n)
IPv6 address struct.
Definition net_ip.h:142
Kernel timeout type.
Definition sys_clock.h:65
Network buffer pool representation.
Definition net_buf.h:1078
Network buffer representation.
Definition net_buf.h:1006
uint8_t * data
Pointer to the start of data in the buffer.
Definition net_buf.h:1032
uint8_t user_data[]
System metadata for this buffer.
Definition net_buf.h:1053
uint16_t len
Length of the data behind the data pointer.
Definition net_buf.h:1035
Note that we do not store the actual source IP address in the context because the address is already ...
Definition net_context.h:207
Network Interface structure.
Definition net_if.h:680
Hardware link address structure.
Definition net_linkaddr.h:69
uint8_t * addr
The array of byte representing the address.
Definition net_linkaddr.h:71
uint8_t type
What kind of address is this for.
Definition net_linkaddr.h:77
Network packet.
Definition net_pkt.h:91
struct net_buf * frags
buffer fragment
Definition net_pkt.h:103
struct net_context * context
Network connection context.
Definition net_pkt.h:111
struct net_pkt_cursor cursor
Internal buffer iterator used for reading/writing.
Definition net_pkt.h:108
struct net_if * iface
Network interface.
Definition net_pkt.h:114
intptr_t fifo
The fifo is used by RX/TX threads and by socket layer.
Definition net_pkt.h:96
struct net_buf * buffer
alias to a buffer fragment
Definition net_pkt.h:104
struct k_mem_slab * slab
Slab pointer from where it belongs to.
Definition net_pkt.h:99
(Generalized) Precision Time Protocol Timestamp format.
Definition ptp_time.h:111
uint32_t nanosecond
Nanoseconds.
Definition ptp_time.h:134
uint64_t second
Second value.
Definition ptp_time.h:130
Generic sockaddr struct.
Definition net_ip.h:388
#define sys_cpu_to_le32(val)
Convert 32-bit integer from host endianness to little-endian.
Definition byteorder.h:270
#define sys_cpu_to_le16(val)
Convert 16-bit integer from host endianness to little-endian.
Definition byteorder.h:266