16#ifndef ZEPHYR_INCLUDE_NET_NET_PKT_H_
17#define ZEPHYR_INCLUDE_NET_NET_PKT_H_
24#if defined(CONFIG_IEEE802154)
90#if defined(CONFIG_NET_TCP)
94#if defined(CONFIG_NET_ROUTING) || defined(CONFIG_NET_ETHERNET_BRIDGE)
98#if defined(CONFIG_NET_PKT_TIMESTAMP) || defined(CONFIG_NET_PKT_TXTIME)
120#if defined(CONFIG_NET_PKT_RXTIME_STATS) || defined(CONFIG_NET_PKT_TXTIME_STATS)
125#if defined(CONFIG_NET_PKT_TXTIME_STATS_DETAIL) || \
126 defined(CONFIG_NET_PKT_RXTIME_STATS_DETAIL)
149#if defined(CONFIG_NET_IP)
166#if defined(CONFIG_NET_IPV4_AUTO)
173#if defined(CONFIG_NET_LLDP)
180#if defined(CONFIG_NET_TCP)
200#if defined(CONFIG_NET_IP_FRAGMENT)
205#if defined(CONFIG_NET_IP)
210#if defined(CONFIG_NET_IPV6)
213#if defined(CONFIG_NET_IPV4)
219#if defined(CONFIG_NET_IPV4)
222#if defined(CONFIG_NET_IPV6)
227#if defined(CONFIG_NET_IP_FRAGMENT)
229#if defined(CONFIG_NET_IPV4_FRAGMENT)
235#if defined(CONFIG_NET_IPV6_FRAGMENT)
245#if defined(CONFIG_NET_IPV6)
257#if defined(CONFIG_NET_IP_DSCP_ECN)
266#if defined(CONFIG_NET_VLAN)
275#if defined(NET_PKT_HAS_CONTROL_BLOCK)
280#if defined(CONFIG_IEEE802154)
284 struct net_pkt_cb_ieee802154 cb;
293#if defined(CONFIG_NET_OFFLOAD)
316static inline void net_pkt_set_context(
struct net_pkt *pkt,
322static inline struct net_if *net_pkt_iface(
struct net_pkt *pkt)
327static inline void net_pkt_set_iface(
struct net_pkt *pkt,
struct net_if *iface)
338 pkt->lladdr_src.type = type;
339 pkt->lladdr_dst.type = type;
343static inline struct net_if *net_pkt_orig_iface(
struct net_pkt *pkt)
345#if defined(CONFIG_NET_ROUTING) || defined(CONFIG_NET_ETHERNET_BRIDGE)
346 return pkt->orig_iface;
352static inline void net_pkt_set_orig_iface(
struct net_pkt *pkt,
355#if defined(CONFIG_NET_ROUTING) || defined(CONFIG_NET_ETHERNET_BRIDGE)
356 pkt->orig_iface = iface;
365static inline void net_pkt_set_family(
struct net_pkt *pkt,
uint8_t family)
367 pkt->family = family;
370static inline bool net_pkt_is_ptp(
struct net_pkt *pkt)
372 return !!(pkt->ptp_pkt);
375static inline void net_pkt_set_ptp(
struct net_pkt *pkt,
bool is_ptp)
377 pkt->ptp_pkt = is_ptp;
380static inline bool net_pkt_is_captured(
struct net_pkt *pkt)
382 return !!(pkt->captured);
385static inline void net_pkt_set_captured(
struct net_pkt *pkt,
bool is_captured)
387 pkt->captured = is_captured;
390static inline bool net_pkt_is_l2_bridged(
struct net_pkt *pkt)
392 return IS_ENABLED(CONFIG_NET_ETHERNET_BRIDGE) ? !!(pkt->l2_bridged) : 0;
395static inline void net_pkt_set_l2_bridged(
struct net_pkt *pkt,
bool is_l2_bridged)
398 pkt->l2_bridged = is_l2_bridged;
402static inline bool net_pkt_is_l2_processed(
struct net_pkt *pkt)
404 return !!(pkt->l2_processed);
407static inline void net_pkt_set_l2_processed(
struct net_pkt *pkt,
408 bool is_l2_processed)
410 pkt->l2_processed = is_l2_processed;
413static inline bool net_pkt_is_chksum_done(
struct net_pkt *pkt)
415 return !!(pkt->chksum_done);
418static inline void net_pkt_set_chksum_done(
struct net_pkt *pkt,
421 pkt->chksum_done = is_chksum_done;
426#if defined(CONFIG_NET_IP)
427 return pkt->ip_hdr_len;
433static inline void net_pkt_set_ip_hdr_len(
struct net_pkt *pkt,
uint8_t len)
435#if defined(CONFIG_NET_IP)
436 pkt->ip_hdr_len = len;
442#if defined(CONFIG_NET_IP_DSCP_ECN)
449static inline void net_pkt_set_ip_dscp(
struct net_pkt *pkt,
uint8_t dscp)
451#if defined(CONFIG_NET_IP_DSCP_ECN)
458#if defined(CONFIG_NET_IP_DSCP_ECN)
465static inline void net_pkt_set_ip_ecn(
struct net_pkt *pkt,
uint8_t ecn)
467#if defined(CONFIG_NET_IP_DSCP_ECN)
474#if defined(CONFIG_NET_TCP)
475 return pkt->tcp_first_msg;
481static inline void net_pkt_set_tcp_1st_msg(
struct net_pkt *pkt,
bool is_1st)
483#if defined(CONFIG_NET_TCP)
484 pkt->tcp_first_msg = is_1st;
496static inline void net_pkt_set_eof(
struct net_pkt *pkt,
bool eof)
501static inline bool net_pkt_forwarding(
struct net_pkt *pkt)
503 return !!(pkt->forwarding);
506static inline void net_pkt_set_forwarding(
struct net_pkt *pkt,
bool forward)
508 pkt->forwarding = forward;
511#if defined(CONFIG_NET_IPV4)
514 return pkt->ipv4_ttl;
517static inline void net_pkt_set_ipv4_ttl(
struct net_pkt *pkt,
525 return pkt->ipv4_opts_len;
528static inline void net_pkt_set_ipv4_opts_len(
struct net_pkt *pkt,
531 pkt->ipv4_opts_len = opts_len;
541static inline void net_pkt_set_ipv4_ttl(
struct net_pkt *pkt,
554static inline void net_pkt_set_ipv4_opts_len(
struct net_pkt *pkt,
558 ARG_UNUSED(opts_len);
562#if defined(CONFIG_NET_IPV6)
563static inline uint8_t net_pkt_ipv6_ext_opt_len(
struct net_pkt *pkt)
565 return pkt->ipv6_ext_opt_len;
568static inline void net_pkt_set_ipv6_ext_opt_len(
struct net_pkt *pkt,
571 pkt->ipv6_ext_opt_len = len;
576 return pkt->ipv6_next_hdr;
579static inline void net_pkt_set_ipv6_next_hdr(
struct net_pkt *pkt,
582 pkt->ipv6_next_hdr = next_hdr;
587 return pkt->ipv6_ext_len;
590static inline void net_pkt_set_ipv6_ext_len(
struct net_pkt *pkt,
uint16_t len)
592 pkt->ipv6_ext_len = len;
597 return pkt->ipv6_prev_hdr_start;
600static inline void net_pkt_set_ipv6_hdr_prev(
struct net_pkt *pkt,
603 pkt->ipv6_prev_hdr_start = offset;
608 return pkt->ipv6_hop_limit;
611static inline void net_pkt_set_ipv6_hop_limit(
struct net_pkt *pkt,
614 pkt->ipv6_hop_limit = hop_limit;
617static inline uint8_t net_pkt_ipv6_ext_opt_len(
struct net_pkt *pkt)
624static inline void net_pkt_set_ipv6_ext_opt_len(
struct net_pkt *pkt,
638static inline void net_pkt_set_ipv6_next_hdr(
struct net_pkt *pkt,
642 ARG_UNUSED(next_hdr);
652static inline void net_pkt_set_ipv6_ext_len(
struct net_pkt *pkt,
uint16_t len)
665static inline void net_pkt_set_ipv6_hdr_prev(
struct net_pkt *pkt,
679static inline void net_pkt_set_ipv6_hop_limit(
struct net_pkt *pkt,
683 ARG_UNUSED(hop_limit);
689#if defined(CONFIG_NET_IPV6)
690 return pkt->ipv6_ext_len;
691#elif defined(CONFIG_NET_IPV4)
692 return pkt->ipv4_opts_len;
700#if defined(CONFIG_NET_IPV4_FRAGMENT)
701static inline uint16_t net_pkt_ipv4_fragment_offset(
struct net_pkt *pkt)
703 return (pkt->ipv4_fragment.flags & NET_IPV4_FRAGH_OFFSET_MASK) * 8;
706static inline bool net_pkt_ipv4_fragment_more(
struct net_pkt *pkt)
708 return (pkt->ipv4_fragment.flags & NET_IPV4_MORE_FRAG_MASK) != 0;
713 pkt->ipv4_fragment.flags =
flags;
718 return pkt->ipv4_fragment.id;
721static inline void net_pkt_set_ipv4_fragment_id(
struct net_pkt *pkt,
uint32_t id)
723 pkt->ipv4_fragment.id = id;
726static inline uint16_t net_pkt_ipv4_fragment_offset(
struct net_pkt *pkt)
733static inline bool net_pkt_ipv4_fragment_more(
struct net_pkt *pkt)
753static inline void net_pkt_set_ipv4_fragment_id(
struct net_pkt *pkt,
uint32_t id)
760#if defined(CONFIG_NET_IPV6_FRAGMENT)
763 return pkt->ipv6_fragment.hdr_start;
766static inline void net_pkt_set_ipv6_fragment_start(
struct net_pkt *pkt,
769 pkt->ipv6_fragment.hdr_start = start;
772static inline uint16_t net_pkt_ipv6_fragment_offset(
struct net_pkt *pkt)
774 return pkt->ipv6_fragment.flags & NET_IPV6_FRAGH_OFFSET_MASK;
776static inline bool net_pkt_ipv6_fragment_more(
struct net_pkt *pkt)
778 return (pkt->ipv6_fragment.flags & 0x01) != 0;
781static inline void net_pkt_set_ipv6_fragment_flags(
struct net_pkt *pkt,
784 pkt->ipv6_fragment.flags =
flags;
789 return pkt->ipv6_fragment.id;
792static inline void net_pkt_set_ipv6_fragment_id(
struct net_pkt *pkt,
795 pkt->ipv6_fragment.id = id;
805static inline void net_pkt_set_ipv6_fragment_start(
struct net_pkt *pkt,
812static inline uint16_t net_pkt_ipv6_fragment_offset(
struct net_pkt *pkt)
819static inline bool net_pkt_ipv6_fragment_more(
struct net_pkt *pkt)
826static inline void net_pkt_set_ipv6_fragment_flags(
struct net_pkt *pkt,
840static inline void net_pkt_set_ipv6_fragment_id(
struct net_pkt *pkt,
848#if defined(CONFIG_NET_IP_FRAGMENT)
849static inline bool net_pkt_is_ip_reassembled(
struct net_pkt *pkt)
851 return !!(pkt->ip_reassembled);
854static inline void net_pkt_set_ip_reassembled(
struct net_pkt *pkt,
857 pkt->ip_reassembled = reassembled;
860static inline bool net_pkt_is_ip_reassembled(
struct net_pkt *pkt)
867static inline void net_pkt_set_ip_reassembled(
struct net_pkt *pkt,
871 ARG_UNUSED(reassembled);
877 return pkt->priority;
880static inline void net_pkt_set_priority(
struct net_pkt *pkt,
883 pkt->priority = priority;
886#if defined(CONFIG_NET_VLAN)
892static inline void net_pkt_set_vlan_tag(
struct net_pkt *pkt,
uint16_t tag)
902static inline void net_pkt_set_vlan_priority(
struct net_pkt *pkt,
908static inline bool net_pkt_vlan_dei(
struct net_pkt *pkt)
913static inline void net_pkt_set_vlan_dei(
struct net_pkt *pkt,
bool dei)
918static inline void net_pkt_set_vlan_tci(
struct net_pkt *pkt,
uint16_t tci)
925 return pkt->vlan_tci;
933static inline void net_pkt_set_vlan_tag(
struct net_pkt *pkt,
uint16_t tag)
945static inline bool net_pkt_vlan_dei(
struct net_pkt *pkt)
950static inline void net_pkt_set_vlan_dei(
struct net_pkt *pkt,
bool dei)
961static inline void net_pkt_set_vlan_tci(
struct net_pkt *pkt,
uint16_t tci)
968#if defined(CONFIG_NET_PKT_TIMESTAMP) || defined(CONFIG_NET_PKT_TXTIME)
971 return &pkt->timestamp;
974static inline void net_pkt_set_timestamp(
struct net_pkt *pkt,
977 pkt->timestamp.second = timestamp->
second;
978 pkt->timestamp.nanosecond = timestamp->
nanosecond;
986static inline void net_pkt_set_timestamp_ns(
struct net_pkt *pkt,
net_time_t timestamp)
998static inline void net_pkt_set_timestamp(
struct net_pkt *pkt,
1002 ARG_UNUSED(timestamp);
1012static inline void net_pkt_set_timestamp_ns(
struct net_pkt *pkt,
net_time_t timestamp)
1015 ARG_UNUSED(timestamp);
1019#if defined(CONFIG_NET_PKT_RXTIME_STATS) || defined(CONFIG_NET_PKT_TXTIME_STATS)
1022 return pkt->create_time;
1025static inline void net_pkt_set_create_time(
struct net_pkt *pkt,
1028 pkt->create_time = create_time;
1038static inline void net_pkt_set_create_time(
struct net_pkt *pkt,
1042 ARG_UNUSED(create_time);
1051#if defined(CONFIG_NET_PKT_TXTIME)
1052 return pkt->timestamp.second *
NSEC_PER_SEC + pkt->timestamp.nanosecond;
1064static inline void net_pkt_set_txtime(
struct net_pkt *pkt,
uint64_t txtime)
1066#if defined(CONFIG_NET_PKT_TXTIME)
1075#if defined(CONFIG_NET_PKT_TXTIME_STATS_DETAIL) || \
1076 defined(CONFIG_NET_PKT_RXTIME_STATS_DETAIL)
1079 return pkt->detail.stat;
1082static inline int net_pkt_stats_tick_count(
struct net_pkt *pkt)
1084 return pkt->detail.count;
1087static inline void net_pkt_stats_tick_reset(
struct net_pkt *pkt)
1089 memset(&pkt->detail, 0,
sizeof(pkt->detail));
1095 if (pkt->detail.count >= NET_PKT_DETAIL_STATS_COUNT) {
1096 NET_ERR(
"Detail stats count overflow (%d >= %d)",
1097 pkt->detail.count, NET_PKT_DETAIL_STATS_COUNT);
1101 pkt->detail.stat[pkt->detail.count++] = tick;
1104#define net_pkt_set_tx_stats_tick(pkt, tick) net_pkt_set_stats_tick(pkt, tick)
1105#define net_pkt_set_rx_stats_tick(pkt, tick) net_pkt_set_stats_tick(pkt, tick)
1114static inline int net_pkt_stats_tick_count(
struct net_pkt *pkt)
1121static inline void net_pkt_stats_tick_reset(
struct net_pkt *pkt)
1126static inline void net_pkt_set_stats_tick(
struct net_pkt *pkt,
uint32_t tick)
1132#define net_pkt_set_tx_stats_tick(pkt, tick)
1133#define net_pkt_set_rx_stats_tick(pkt, tick)
1137static inline size_t net_pkt_get_len(
struct net_pkt *pkt)
1152static inline bool net_pkt_is_empty(
struct net_pkt *pkt)
1159 return &pkt->lladdr_src;
1164 return &pkt->lladdr_dst;
1167static inline void net_pkt_lladdr_swap(
struct net_pkt *pkt)
1171 net_pkt_lladdr_src(pkt)->addr = net_pkt_lladdr_dst(pkt)->addr;
1172 net_pkt_lladdr_dst(pkt)->addr =
addr;
1175static inline void net_pkt_lladdr_clear(
struct net_pkt *pkt)
1177 net_pkt_lladdr_src(pkt)->addr = NULL;
1178 net_pkt_lladdr_src(pkt)->len = 0U;
1183 return pkt->ll_proto_type;
1188 pkt->ll_proto_type =
type;
1191#if defined(CONFIG_NET_IPV4_AUTO)
1192static inline bool net_pkt_ipv4_auto(
struct net_pkt *pkt)
1194 return !!(pkt->ipv4_auto_arp_msg);
1197static inline void net_pkt_set_ipv4_auto(
struct net_pkt *pkt,
1198 bool is_auto_arp_msg)
1200 pkt->ipv4_auto_arp_msg = is_auto_arp_msg;
1203static inline bool net_pkt_ipv4_auto(
struct net_pkt *pkt)
1210static inline void net_pkt_set_ipv4_auto(
struct net_pkt *pkt,
1211 bool is_auto_arp_msg)
1214 ARG_UNUSED(is_auto_arp_msg);
1218#if defined(CONFIG_NET_LLDP)
1219static inline bool net_pkt_is_lldp(
struct net_pkt *pkt)
1221 return !!(pkt->lldp_pkt);
1224static inline void net_pkt_set_lldp(
struct net_pkt *pkt,
bool is_lldp)
1226 pkt->lldp_pkt = is_lldp;
1229static inline bool net_pkt_is_lldp(
struct net_pkt *pkt)
1236static inline void net_pkt_set_lldp(
struct net_pkt *pkt,
bool is_lldp)
1239 ARG_UNUSED(is_lldp);
1243#if defined(CONFIG_NET_L2_PPP)
1244static inline bool net_pkt_is_ppp(
struct net_pkt *pkt)
1246 return !!(pkt->ppp_msg);
1249static inline void net_pkt_set_ppp(
struct net_pkt *pkt,
1252 pkt->ppp_msg = is_ppp_msg;
1255static inline bool net_pkt_is_ppp(
struct net_pkt *pkt)
1262static inline void net_pkt_set_ppp(
struct net_pkt *pkt,
1266 ARG_UNUSED(is_ppp_msg);
1270#if defined(NET_PKT_HAS_CONTROL_BLOCK)
1271static inline void *net_pkt_cb(
struct net_pkt *pkt)
1276static inline void *net_pkt_cb(
struct net_pkt *pkt)
1284#define NET_IPV6_HDR(pkt) ((struct net_ipv6_hdr *)net_pkt_ip_data(pkt))
1285#define NET_IPV4_HDR(pkt) ((struct net_ipv4_hdr *)net_pkt_ip_data(pkt))
1287static inline void net_pkt_set_src_ipv6_addr(
struct net_pkt *pkt)
1290 net_pkt_context(pkt)),
1291 (
struct in6_addr *)NET_IPV6_HDR(pkt)->src);
1294static inline void net_pkt_set_overwrite(
struct net_pkt *pkt,
bool overwrite)
1296 pkt->overwrite = overwrite;
1299static inline bool net_pkt_is_being_overwritten(
struct net_pkt *pkt)
1301 return !!(pkt->overwrite);
1304#ifdef CONFIG_NET_PKT_FILTER
1306bool net_pkt_filter_send_ok(
struct net_pkt *pkt);
1307bool net_pkt_filter_recv_ok(
struct net_pkt *pkt);
1311static inline bool net_pkt_filter_send_ok(
struct net_pkt *pkt)
1318static inline bool net_pkt_filter_recv_ok(
struct net_pkt *pkt)
1327#if defined(CONFIG_NET_PKT_FILTER) && \
1328 (defined(CONFIG_NET_PKT_FILTER_IPV4_HOOK) || defined(CONFIG_NET_PKT_FILTER_IPV6_HOOK))
1330bool net_pkt_filter_ip_recv_ok(
struct net_pkt *pkt);
1334static inline bool net_pkt_filter_ip_recv_ok(
struct net_pkt *pkt)
1343#if defined(CONFIG_NET_PKT_FILTER) && defined(CONFIG_NET_PKT_FILTER_LOCAL_IN_HOOK)
1345bool net_pkt_filter_local_in_recv_ok(
struct net_pkt *pkt);
1349static inline bool net_pkt_filter_local_in_recv_ok(
struct net_pkt *pkt)
1373#define NET_PKT_SLAB_DEFINE(name, count) \
1374 K_MEM_SLAB_DEFINE(name, sizeof(struct net_pkt), count, 4)
1377#define NET_PKT_TX_SLAB_DEFINE(name, count) NET_PKT_SLAB_DEFINE(name, count)
1392#define NET_PKT_DATA_POOL_DEFINE(name, count) \
1393 NET_BUF_POOL_DEFINE(name, count, CONFIG_NET_BUF_DATA_SIZE, \
1398#if defined(CONFIG_NET_DEBUG_NET_PKT_ALLOC) || \
1399 (CONFIG_NET_PKT_LOG_LEVEL >= LOG_LEVEL_DBG)
1400#define NET_PKT_DEBUG_ENABLED
1403#if defined(NET_PKT_DEBUG_ENABLED)
1415#define net_pkt_get_reserve_data(pool, min_len, timeout) \
1416 net_pkt_get_reserve_data_debug(pool, min_len, timeout, __func__, __LINE__)
1418struct net_buf *net_pkt_get_reserve_rx_data_debug(
size_t min_len,
1422#define net_pkt_get_reserve_rx_data(min_len, timeout) \
1423 net_pkt_get_reserve_rx_data_debug(min_len, timeout, __func__, __LINE__)
1425struct net_buf *net_pkt_get_reserve_tx_data_debug(
size_t min_len,
1429#define net_pkt_get_reserve_tx_data(min_len, timeout) \
1430 net_pkt_get_reserve_tx_data_debug(min_len, timeout, __func__, __LINE__)
1432struct net_buf *net_pkt_get_frag_debug(
struct net_pkt *pkt,
size_t min_len,
1434 const char *caller,
int line);
1435#define net_pkt_get_frag(pkt, min_len, timeout) \
1436 net_pkt_get_frag_debug(pkt, min_len, timeout, __func__, __LINE__)
1438void net_pkt_unref_debug(
struct net_pkt *pkt,
const char *caller,
int line);
1439#define net_pkt_unref(pkt) net_pkt_unref_debug(pkt, __func__, __LINE__)
1441struct net_pkt *net_pkt_ref_debug(
struct net_pkt *pkt,
const char *caller,
1443#define net_pkt_ref(pkt) net_pkt_ref_debug(pkt, __func__, __LINE__)
1446 const char *caller,
int line);
1447#define net_pkt_frag_ref(frag) net_pkt_frag_ref_debug(frag, __func__, __LINE__)
1449void net_pkt_frag_unref_debug(
struct net_buf *frag,
1450 const char *caller,
int line);
1451#define net_pkt_frag_unref(frag) \
1452 net_pkt_frag_unref_debug(frag, __func__, __LINE__)
1457 const char *caller,
int line);
1458#define net_pkt_frag_del(pkt, parent, frag) \
1459 net_pkt_frag_del_debug(pkt, parent, frag, __func__, __LINE__)
1461void net_pkt_frag_add_debug(
struct net_pkt *pkt,
struct net_buf *frag,
1462 const char *caller,
int line);
1463#define net_pkt_frag_add(pkt, frag) \
1464 net_pkt_frag_add_debug(pkt, frag, __func__, __LINE__)
1466void net_pkt_frag_insert_debug(
struct net_pkt *pkt,
struct net_buf *frag,
1467 const char *caller,
int line);
1468#define net_pkt_frag_insert(pkt, frag) \
1469 net_pkt_frag_insert_debug(pkt, frag, __func__, __LINE__)
1482#if defined(NET_PKT_DEBUG_ENABLED)
1485#define net_pkt_print_frags(pkt)
1502#if !defined(NET_PKT_DEBUG_ENABLED)
1520#if !defined(NET_PKT_DEBUG_ENABLED)
1536#if !defined(NET_PKT_DEBUG_ENABLED)
1550#if !defined(NET_PKT_DEBUG_ENABLED)
1563#if !defined(NET_PKT_DEBUG_ENABLED)
1576#if !defined(NET_PKT_DEBUG_ENABLED)
1585#if !defined(NET_PKT_DEBUG_ENABLED)
1599#if !defined(NET_PKT_DEBUG_ENABLED)
1611#if !defined(NET_PKT_DEBUG_ENABLED)
1621#if !defined(NET_PKT_DEBUG_ENABLED)
1642 struct k_mem_slab **tx,
1648#if defined(CONFIG_NET_DEBUG_NET_PKT_ALLOC)
1652void net_pkt_print(
void);
1654typedef void (*net_pkt_allocs_cb_t)(
struct net_pkt *pkt,
1656 const char *func_alloc,
1658 const char *func_free,
1663void net_pkt_allocs_foreach(net_pkt_allocs_cb_t cb,
void *
user_data);
1665const char *net_pkt_slab2str(
struct k_mem_slab *slab);
1666const char *net_pkt_pool2str(
struct net_buf_pool *pool);
1669#define net_pkt_print(...)
1675#if defined(NET_PKT_DEBUG_ENABLED)
1678 const char *caller,
int line);
1679#define net_pkt_alloc(_timeout) \
1680 net_pkt_alloc_debug(_timeout, __func__, __LINE__)
1682struct net_pkt *net_pkt_alloc_from_slab_debug(
struct k_mem_slab *
slab,
1684 const char *caller,
int line);
1685#define net_pkt_alloc_from_slab(_slab, _timeout) \
1686 net_pkt_alloc_from_slab_debug(_slab, _timeout, __func__, __LINE__)
1689 const char *caller,
int line);
1690#define net_pkt_rx_alloc(_timeout) \
1691 net_pkt_rx_alloc_debug(_timeout, __func__, __LINE__)
1697#define net_pkt_alloc_on_iface(_iface, _timeout) \
1698 net_pkt_alloc_on_iface_debug(_iface, _timeout, __func__, __LINE__)
1704#define net_pkt_rx_alloc_on_iface(_iface, _timeout) \
1705 net_pkt_rx_alloc_on_iface_debug(_iface, _timeout, \
1708int net_pkt_alloc_buffer_debug(
struct net_pkt *pkt,
1712 const char *caller,
int line);
1713#define net_pkt_alloc_buffer(_pkt, _size, _proto, _timeout) \
1714 net_pkt_alloc_buffer_debug(_pkt, _size, _proto, _timeout, \
1717int net_pkt_alloc_buffer_raw_debug(
struct net_pkt *pkt,
size_t size,
1719 const char *caller,
int line);
1720#define net_pkt_alloc_buffer_raw(_pkt, _size, _timeout) \
1721 net_pkt_alloc_buffer_raw_debug(_pkt, _size, _timeout, \
1731#define net_pkt_alloc_with_buffer(_iface, _size, _family, \
1733 net_pkt_alloc_with_buffer_debug(_iface, _size, _family, \
1744#define net_pkt_rx_alloc_with_buffer(_iface, _size, _family, \
1746 net_pkt_rx_alloc_with_buffer_debug(_iface, _size, _family, \
1762#if !defined(NET_PKT_DEBUG_ENABLED)
1780#if !defined(NET_PKT_DEBUG_ENABLED)
1795#if !defined(NET_PKT_DEBUG_ENABLED)
1807#if !defined(NET_PKT_DEBUG_ENABLED)
1831#if !defined(NET_PKT_DEBUG_ENABLED)
1851#if !defined(NET_PKT_DEBUG_ENABLED)
1867#if !defined(NET_PKT_DEBUG_ENABLED)
2268#if !defined(CONFIG_NET_HEADERS_ALWAYS_CONTIGUOUS)
2274#if defined(CONFIG_NET_HEADERS_ALWAYS_CONTIGUOUS)
2275#define NET_PKT_DATA_ACCESS_DEFINE(_name, _type) \
2276 struct net_pkt_data_access _name = { \
2277 .size = sizeof(_type), \
2280#define NET_PKT_DATA_ACCESS_CONTIGUOUS_DEFINE(_name, _type) \
2281 NET_PKT_DATA_ACCESS_DEFINE(_name, _type)
2284#define NET_PKT_DATA_ACCESS_DEFINE(_name, _type) \
2285 _type _hdr_##_name; \
2286 struct net_pkt_data_access _name = { \
2287 .data = &_hdr_##_name, \
2288 .size = sizeof(_type), \
2291#define NET_PKT_DATA_ACCESS_CONTIGUOUS_DEFINE(_name, _type) \
2292 struct net_pkt_data_access _name = { \
2294 .size = sizeof(_type), \
long atomic_t
Definition: atomic_types.h:15
#define ALWAYS_INLINE
Definition: common.h:129
VLAN specific definitions.
#define NSEC_PER_SEC
number of nanoseconds per second
Definition: sys_clock.h:107
unsigned short int sa_family_t
Socket address family type.
Definition: net_ip.h:164
#define htons(x)
Convert 16-bit value from host to network byte order.
Definition: net_ip.h:120
#define htonl(x)
Convert 32-bit value from host to network byte order.
Definition: net_ip.h:128
net_ip_protocol
Protocol numbers from IANA/BSD.
Definition: net_ip.h:62
static size_t net_buf_frags_len(struct net_buf *buf)
Calculate amount of bytes stored in fragments.
Definition: buf.h:2471
static struct net_if * net_context_get_iface(struct net_context *context)
Get network interface for this context.
Definition: net_context.h:690
static struct net_linkaddr * net_if_get_link_addr(struct net_if *iface)
Get an network interface's link address.
Definition: net_if.h:991
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:1836
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)
Definition: net_pkt.h:2174
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)
Print fragment list and the fragment sizes.
Definition: net_pkt.h:1485
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_alloc_with_buffer(struct net_if *iface, size_t size, sa_family_t family, enum net_ip_protocol proto, k_timeout_t timeout)
struct net_pkt * net_pkt_rx_clone(struct net_pkt *pkt, k_timeout_t timeout)
Clone pkt and its buffer.
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)
Definition: net_pkt.h:2166
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)
Definition: net_pkt.h:2160
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.
struct net_pkt * net_pkt_rx_alloc_on_iface(struct net_if *iface, k_timeout_t timeout)
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:1988
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:1961
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:2335
static int net_pkt_write_le16(struct net_pkt *pkt, uint16_t data)
Definition: net_pkt.h:2190
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:1974
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)
Definition: net_pkt.h:2182
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)
Definition: net_pkt.h:2097
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:101
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:193
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:214
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:124
static uint16_t net_eth_vlan_set_vid(uint16_t tci, uint16_t vid)
Set VLAN identifier to TCI.
Definition: ethernet_vlan.h:76
static uint8_t net_eth_vlan_get_dei(uint16_t tci)
Get Drop Eligible Indicator from TCI.
Definition: ethernet_vlan.h:51
#define NET_VLAN_TAG_UNSPEC
Unspecified VLAN tag value.
Definition: ethernet_vlan.h:30
static uint16_t net_eth_vlan_set_dei(uint16_t tci, bool dei)
Set Drop Eligible Indicator to TCI.
Definition: ethernet_vlan.h:89
static uint16_t net_eth_vlan_get_vid(uint16_t tci)
Get VLAN identifier from TCI.
Definition: ethernet_vlan.h:39
static uint16_t net_eth_vlan_set_pcp(uint16_t tci, uint8_t pcp)
Set Priority Code Point to TCI.
Definition: ethernet_vlan.h:102
static uint8_t net_eth_vlan_get_pcp(uint16_t tci)
Get Priority Code Point from TCI.
Definition: ethernet_vlan.h:63
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)
IPv6 address struct.
Definition: net_ip.h:139
Kernel timeout type.
Definition: sys_clock.h:65
Network buffer pool representation.
Definition: buf.h:976
Network buffer representation.
Definition: buf.h:910
uint8_t * data
Pointer to the start of data in the buffer.
Definition: buf.h:936
uint8_t user_data[]
System metadata for this buffer.
Definition: buf.h:955
uint16_t len
Length of the data behind the data pointer.
Definition: buf.h:939
Note that we do not store the actual source IP address in the context because the address is already ...
Definition: net_context.h:201
Network Interface structure.
Definition: net_if.h:615
Hardware link address structure.
Definition: net_linkaddr.h:67
uint8_t * addr
The array of byte representing the address.
Definition: net_linkaddr.h:69
uint8_t type
What kind of address is this for.
Definition: net_linkaddr.h:75
uint8_t * pos
Current position in the data buffer of the net_buf.
Definition: net_pkt.h:54
struct net_buf * buf
Current net_buf pointer by the cursor.
Definition: net_pkt.h:52
Definition: net_pkt.h:2267
const size_t size
Definition: net_pkt.h:2271
void * data
Definition: net_pkt.h:2269
Network packet.
Definition: net_pkt.h:63
struct net_buf * frags
Definition: net_pkt.h:75
struct net_context * context
Network connection context.
Definition: net_pkt.h:83
struct net_pkt_cursor cursor
Internal buffer iterator used for reading/writing.
Definition: net_pkt.h:80
struct net_if * iface
Network interface.
Definition: net_pkt.h:86
intptr_t fifo
The fifo is used by RX/TX threads and by socket layer.
Definition: net_pkt.h:68
struct net_buf * buffer
Definition: net_pkt.h:76
struct k_mem_slab * slab
Slab pointer from where it belongs to.
Definition: net_pkt.h:71
(Generalized) Precision Time Protocol Timestamp format.
Definition: ptp_time.h:109
uint32_t nanosecond
Nanoseconds.
Definition: ptp_time.h:127
uint64_t second
Definition: ptp_time.h:123
Generic sockaddr struct.
Definition: net_ip.h:347
#define sys_cpu_to_le32(val)
Convert 32-bit integer from host endianness to little-endian.
Definition: byteorder.h:261
#define sys_cpu_to_le16(val)
Convert 16-bit integer from host endianness to little-endian.
Definition: byteorder.h:257