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_VPN)
131 union net_ip_header ip_hdr;
133 union net_proto_header proto_hdr;
139#if defined(CONFIG_NET_PKT_TIMESTAMP) || defined(CONFIG_NET_PKT_TXTIME)
161#if defined(CONFIG_NET_PKT_RXTIME_STATS) || defined(CONFIG_NET_PKT_TXTIME_STATS) || \
162 defined(CONFIG_TRACING_NET_CORE)
167#if defined(CONFIG_NET_PKT_TXTIME_STATS_DETAIL) || \
168 defined(CONFIG_NET_PKT_RXTIME_STATS_DETAIL)
183#if defined(CONFIG_NET_PKT_ALLOC_STATS)
184 struct net_pkt_alloc_stats_slab *alloc_stats;
195#if defined(CONFIG_NET_IP)
212#if defined(CONFIG_NET_IPV4_ACD)
219#if defined(CONFIG_NET_LLDP)
241#if defined(CONFIG_NET_IP_FRAGMENT)
244#if defined(CONFIG_NET_PKT_TIMESTAMP)
250#if defined(CONFIG_NET_IP)
255#if defined(CONFIG_NET_IPV6)
258#if defined(CONFIG_NET_IPV4)
264#if defined(CONFIG_NET_IPV4)
267#if defined(CONFIG_NET_IPV6)
272#if defined(CONFIG_NET_IP_FRAGMENT)
274#if defined(CONFIG_NET_IPV4_FRAGMENT)
280#if defined(CONFIG_NET_IPV6_FRAGMENT)
290#if defined(CONFIG_NET_IPV6)
302#if defined(CONFIG_NET_IP_DSCP_ECN)
311#if defined(CONFIG_NET_VLAN)
320#if defined(CONFIG_NET_PKT_CONTROL_BLOCK)
323 uint8_t cb[CONFIG_NET_PKT_CONTROL_BLOCK_SIZE];
324#if defined(CONFIG_IEEE802154)
328 struct net_pkt_cb_ieee802154 cb_ieee802154;
338#if defined(CONFIG_NET_OFFLOAD) || defined(CONFIG_NET_L2_IPIP)
350 struct sockaddr_storage remote_storage;
354#if defined(CONFIG_NET_CAPTURE_COOKED_MODE)
359#if defined(CONFIG_NET_IPV4_PMTU)
380static inline void net_pkt_set_context(
struct net_pkt *pkt,
386static inline struct net_if *net_pkt_iface(
struct net_pkt *pkt)
391static inline void net_pkt_set_iface(
struct net_pkt *pkt,
struct net_if *iface)
402 pkt->lladdr_src.type = type;
403 pkt->lladdr_dst.type = type;
407static inline struct net_if *net_pkt_orig_iface(
struct net_pkt *pkt)
409#if defined(CONFIG_NET_ROUTING) || defined(CONFIG_NET_ETHERNET_BRIDGE)
410 return pkt->orig_iface;
416static inline void net_pkt_set_orig_iface(
struct net_pkt *pkt,
419#if defined(CONFIG_NET_ROUTING) || defined(CONFIG_NET_ETHERNET_BRIDGE)
420 pkt->orig_iface = iface;
427#if defined(CONFIG_NET_VPN)
428static inline struct net_if *net_pkt_vpn_iface(
struct net_pkt *pkt)
430 return pkt->vpn.
iface;
433static inline void net_pkt_set_vpn_iface(
struct net_pkt *pkt,
436 pkt->vpn.
iface = iface;
439static inline union net_ip_header *net_pkt_vpn_ip_hdr(
struct net_pkt *pkt)
441 return &pkt->vpn.ip_hdr;
444static inline void net_pkt_set_vpn_ip_hdr(
struct net_pkt *pkt,
445 union net_ip_header *ip_hdr)
447 pkt->vpn.ip_hdr = *ip_hdr;
450static inline union net_proto_header *net_pkt_vpn_udp_hdr(
struct net_pkt *pkt)
452 return &pkt->vpn.proto_hdr;
455static inline void net_pkt_set_vpn_udp_hdr(
struct net_pkt *pkt,
456 union net_proto_header *proto_hdr)
458 pkt->vpn.proto_hdr = *proto_hdr;
461static inline int net_pkt_vpn_peer_id(
struct net_pkt *pkt)
463 return pkt->vpn.peer_id;
466static inline void net_pkt_set_vpn_peer_id(
struct net_pkt *pkt,
469 pkt->vpn.peer_id = peer_id;
478static inline void net_pkt_set_family(
struct net_pkt *pkt,
uint8_t family)
480 pkt->family = family;
483static inline bool net_pkt_is_ptp(
struct net_pkt *pkt)
485 return !!(pkt->ptp_pkt);
488static inline void net_pkt_set_ptp(
struct net_pkt *pkt,
bool is_ptp)
490 pkt->ptp_pkt = is_ptp;
493static inline bool net_pkt_is_tx_timestamping(
struct net_pkt *pkt)
495#if defined(CONFIG_NET_PKT_TIMESTAMP)
496 return !!(pkt->tx_timestamping);
504static inline void net_pkt_set_tx_timestamping(
struct net_pkt *pkt,
bool is_timestamping)
506#if defined(CONFIG_NET_PKT_TIMESTAMP)
507 pkt->tx_timestamping = is_timestamping;
510 ARG_UNUSED(is_timestamping);
514static inline bool net_pkt_is_rx_timestamping(
struct net_pkt *pkt)
516#if defined(CONFIG_NET_PKT_TIMESTAMP)
517 return !!(pkt->rx_timestamping);
525static inline void net_pkt_set_rx_timestamping(
struct net_pkt *pkt,
bool is_timestamping)
527#if defined(CONFIG_NET_PKT_TIMESTAMP)
528 pkt->rx_timestamping = is_timestamping;
531 ARG_UNUSED(is_timestamping);
535static inline bool net_pkt_is_captured(
struct net_pkt *pkt)
537 return !!(pkt->captured);
540static inline void net_pkt_set_captured(
struct net_pkt *pkt,
bool is_captured)
542 pkt->captured = is_captured;
545static inline bool net_pkt_is_l2_bridged(
struct net_pkt *pkt)
547 return IS_ENABLED(CONFIG_NET_ETHERNET_BRIDGE) ? !!(pkt->l2_bridged) : 0;
550static inline void net_pkt_set_l2_bridged(
struct net_pkt *pkt,
bool is_l2_bridged)
553 pkt->l2_bridged = is_l2_bridged;
557static inline bool net_pkt_is_l2_processed(
struct net_pkt *pkt)
559 return !!(pkt->l2_processed);
562static inline void net_pkt_set_l2_processed(
struct net_pkt *pkt,
563 bool is_l2_processed)
565 pkt->l2_processed = is_l2_processed;
568static inline bool net_pkt_is_chksum_done(
struct net_pkt *pkt)
570 return !!(pkt->chksum_done);
573static inline void net_pkt_set_chksum_done(
struct net_pkt *pkt,
576 pkt->chksum_done = is_chksum_done;
581#if defined(CONFIG_NET_IP)
582 return pkt->ip_hdr_len;
590static inline void net_pkt_set_ip_hdr_len(
struct net_pkt *pkt,
uint8_t len)
592#if defined(CONFIG_NET_IP)
593 pkt->ip_hdr_len = len;
602#if defined(CONFIG_NET_IP_DSCP_ECN)
611static inline void net_pkt_set_ip_dscp(
struct net_pkt *pkt,
uint8_t dscp)
613#if defined(CONFIG_NET_IP_DSCP_ECN)
623#if defined(CONFIG_NET_IP_DSCP_ECN)
632static inline void net_pkt_set_ip_ecn(
struct net_pkt *pkt,
uint8_t ecn)
634#if defined(CONFIG_NET_IP_DSCP_ECN)
647static inline void net_pkt_set_eof(
struct net_pkt *pkt,
bool eof)
652static inline bool net_pkt_forwarding(
struct net_pkt *pkt)
654 return !!(pkt->forwarding);
657static inline void net_pkt_set_forwarding(
struct net_pkt *pkt,
bool forward)
659 pkt->forwarding = forward;
662#if defined(CONFIG_NET_IPV4)
665 return pkt->ipv4_ttl;
668static inline void net_pkt_set_ipv4_ttl(
struct net_pkt *pkt,
676 return pkt->ipv4_opts_len;
679static inline void net_pkt_set_ipv4_opts_len(
struct net_pkt *pkt,
682 pkt->ipv4_opts_len = opts_len;
692static inline void net_pkt_set_ipv4_ttl(
struct net_pkt *pkt,
705static inline void net_pkt_set_ipv4_opts_len(
struct net_pkt *pkt,
709 ARG_UNUSED(opts_len);
713#if defined(CONFIG_NET_IPV6)
714static inline uint8_t net_pkt_ipv6_ext_opt_len(
struct net_pkt *pkt)
716 return pkt->ipv6_ext_opt_len;
719static inline void net_pkt_set_ipv6_ext_opt_len(
struct net_pkt *pkt,
722 pkt->ipv6_ext_opt_len = len;
727 return pkt->ipv6_next_hdr;
730static inline void net_pkt_set_ipv6_next_hdr(
struct net_pkt *pkt,
733 pkt->ipv6_next_hdr = next_hdr;
738 return pkt->ipv6_ext_len;
741static inline void net_pkt_set_ipv6_ext_len(
struct net_pkt *pkt,
uint16_t len)
743 pkt->ipv6_ext_len = len;
748 return pkt->ipv6_prev_hdr_start;
751static inline void net_pkt_set_ipv6_hdr_prev(
struct net_pkt *pkt,
754 pkt->ipv6_prev_hdr_start = offset;
759 return pkt->ipv6_hop_limit;
762static inline void net_pkt_set_ipv6_hop_limit(
struct net_pkt *pkt,
765 pkt->ipv6_hop_limit = hop_limit;
768static inline uint8_t net_pkt_ipv6_ext_opt_len(
struct net_pkt *pkt)
775static inline void net_pkt_set_ipv6_ext_opt_len(
struct net_pkt *pkt,
789static inline void net_pkt_set_ipv6_next_hdr(
struct net_pkt *pkt,
793 ARG_UNUSED(next_hdr);
803static inline void net_pkt_set_ipv6_ext_len(
struct net_pkt *pkt,
uint16_t len)
816static inline void net_pkt_set_ipv6_hdr_prev(
struct net_pkt *pkt,
830static inline void net_pkt_set_ipv6_hop_limit(
struct net_pkt *pkt,
834 ARG_UNUSED(hop_limit);
840#if defined(CONFIG_NET_IPV6)
841 return pkt->ipv6_ext_len;
842#elif defined(CONFIG_NET_IPV4)
843 return pkt->ipv4_opts_len;
851#if defined(CONFIG_NET_IPV4_PMTU)
852static inline bool net_pkt_ipv4_pmtu(
struct net_pkt *pkt)
854 return !!pkt->ipv4_pmtu;
857static inline void net_pkt_set_ipv4_pmtu(
struct net_pkt *pkt,
bool value)
859 pkt->ipv4_pmtu = value;
862static inline bool net_pkt_ipv4_pmtu(
struct net_pkt *pkt)
869static inline void net_pkt_set_ipv4_pmtu(
struct net_pkt *pkt,
bool value)
876#if defined(CONFIG_NET_IPV4_FRAGMENT)
877static inline uint16_t net_pkt_ipv4_fragment_offset(
struct net_pkt *pkt)
879 return (pkt->ipv4_fragment.flags & NET_IPV4_FRAGH_OFFSET_MASK) * 8;
882static inline bool net_pkt_ipv4_fragment_more(
struct net_pkt *pkt)
884 return (pkt->ipv4_fragment.flags & NET_IPV4_MORE_FRAG_MASK) != 0;
889 pkt->ipv4_fragment.flags =
flags;
894 return pkt->ipv4_fragment.id;
897static inline void net_pkt_set_ipv4_fragment_id(
struct net_pkt *pkt,
uint32_t id)
899 pkt->ipv4_fragment.id = id;
902static inline uint16_t net_pkt_ipv4_fragment_offset(
struct net_pkt *pkt)
909static inline bool net_pkt_ipv4_fragment_more(
struct net_pkt *pkt)
929static inline void net_pkt_set_ipv4_fragment_id(
struct net_pkt *pkt,
uint32_t id)
936#if defined(CONFIG_NET_IPV6_FRAGMENT)
939 return pkt->ipv6_fragment.hdr_start;
942static inline void net_pkt_set_ipv6_fragment_start(
struct net_pkt *pkt,
945 pkt->ipv6_fragment.hdr_start = start;
948static inline uint16_t net_pkt_ipv6_fragment_offset(
struct net_pkt *pkt)
950 return pkt->ipv6_fragment.flags & NET_IPV6_FRAGH_OFFSET_MASK;
952static inline bool net_pkt_ipv6_fragment_more(
struct net_pkt *pkt)
954 return (pkt->ipv6_fragment.flags & 0x01) != 0;
957static inline void net_pkt_set_ipv6_fragment_flags(
struct net_pkt *pkt,
960 pkt->ipv6_fragment.flags =
flags;
965 return pkt->ipv6_fragment.id;
968static inline void net_pkt_set_ipv6_fragment_id(
struct net_pkt *pkt,
971 pkt->ipv6_fragment.id = id;
981static inline void net_pkt_set_ipv6_fragment_start(
struct net_pkt *pkt,
988static inline uint16_t net_pkt_ipv6_fragment_offset(
struct net_pkt *pkt)
995static inline bool net_pkt_ipv6_fragment_more(
struct net_pkt *pkt)
1002static inline void net_pkt_set_ipv6_fragment_flags(
struct net_pkt *pkt,
1016static inline void net_pkt_set_ipv6_fragment_id(
struct net_pkt *pkt,
1024static inline bool net_pkt_is_loopback(
struct net_pkt *pkt)
1026 return !!(pkt->loopback);
1029static inline void net_pkt_set_loopback(
struct net_pkt *pkt,
1032 pkt->loopback = loopback;
1035#if defined(CONFIG_NET_IP_FRAGMENT)
1036static inline bool net_pkt_is_ip_reassembled(
struct net_pkt *pkt)
1038 return !!(pkt->ip_reassembled);
1041static inline void net_pkt_set_ip_reassembled(
struct net_pkt *pkt,
1044 pkt->ip_reassembled = reassembled;
1047static inline bool net_pkt_is_ip_reassembled(
struct net_pkt *pkt)
1054static inline void net_pkt_set_ip_reassembled(
struct net_pkt *pkt,
1058 ARG_UNUSED(reassembled);
1064 return pkt->priority;
1067static inline void net_pkt_set_priority(
struct net_pkt *pkt,
1070 pkt->priority = priority;
1073#if defined(CONFIG_NET_CAPTURE_COOKED_MODE)
1074static inline bool net_pkt_is_cooked_mode(
struct net_pkt *pkt)
1076 return pkt->cooked_mode_pkt;
1079static inline void net_pkt_set_cooked_mode(
struct net_pkt *pkt,
bool value)
1081 pkt->cooked_mode_pkt = value;
1084static inline bool net_pkt_is_cooked_mode(
struct net_pkt *pkt)
1091static inline void net_pkt_set_cooked_mode(
struct net_pkt *pkt,
bool value)
1098#if defined(CONFIG_NET_VLAN)
1104static inline void net_pkt_set_vlan_tag(
struct net_pkt *pkt,
uint16_t tag)
1114static inline void net_pkt_set_vlan_priority(
struct net_pkt *pkt,
1120static inline bool net_pkt_vlan_dei(
struct net_pkt *pkt)
1125static inline void net_pkt_set_vlan_dei(
struct net_pkt *pkt,
bool dei)
1130static inline void net_pkt_set_vlan_tci(
struct net_pkt *pkt,
uint16_t tci)
1132 pkt->vlan_tci = tci;
1137 return pkt->vlan_tci;
1147static inline void net_pkt_set_vlan_tag(
struct net_pkt *pkt,
uint16_t tag)
1160static inline bool net_pkt_vlan_dei(
struct net_pkt *pkt)
1167static inline void net_pkt_set_vlan_dei(
struct net_pkt *pkt,
bool dei)
1180static inline void net_pkt_set_vlan_tci(
struct net_pkt *pkt,
uint16_t tci)
1187#if defined(CONFIG_NET_PKT_TIMESTAMP) || defined(CONFIG_NET_PKT_TXTIME)
1190 return &pkt->timestamp;
1193static inline void net_pkt_set_timestamp(
struct net_pkt *pkt,
1196 pkt->timestamp.second = timestamp->
second;
1197 pkt->timestamp.nanosecond = timestamp->
nanosecond;
1205static inline void net_pkt_set_timestamp_ns(
struct net_pkt *pkt,
net_time_t timestamp)
1217static inline void net_pkt_set_timestamp(
struct net_pkt *pkt,
1221 ARG_UNUSED(timestamp);
1231static inline void net_pkt_set_timestamp_ns(
struct net_pkt *pkt,
net_time_t timestamp)
1234 ARG_UNUSED(timestamp);
1238#if defined(CONFIG_NET_PKT_RXTIME_STATS) || defined(CONFIG_NET_PKT_TXTIME_STATS) || \
1239 defined(CONFIG_TRACING_NET_CORE)
1243 return pkt->create_time;
1246static inline void net_pkt_set_create_time(
struct net_pkt *pkt,
1249 pkt->create_time = create_time;
1259static inline void net_pkt_set_create_time(
struct net_pkt *pkt,
1263 ARG_UNUSED(create_time);
1269#if defined(CONFIG_NET_PKT_TXTIME_STATS_DETAIL) || \
1270 defined(CONFIG_NET_PKT_RXTIME_STATS_DETAIL)
1273 return pkt->detail.stat;
1276static inline int net_pkt_stats_tick_count(
struct net_pkt *pkt)
1278 return pkt->detail.count;
1281static inline void net_pkt_stats_tick_reset(
struct net_pkt *pkt)
1283 memset(&pkt->detail, 0,
sizeof(pkt->detail));
1289 if (pkt->detail.count >= NET_PKT_DETAIL_STATS_COUNT) {
1290 NET_ERR(
"Detail stats count overflow (%d >= %d)",
1291 pkt->detail.count, NET_PKT_DETAIL_STATS_COUNT);
1295 pkt->detail.stat[pkt->detail.count++] = tick;
1298#define net_pkt_set_tx_stats_tick(pkt, tick) net_pkt_set_stats_tick(pkt, tick)
1299#define net_pkt_set_rx_stats_tick(pkt, tick) net_pkt_set_stats_tick(pkt, tick)
1308static inline int net_pkt_stats_tick_count(
struct net_pkt *pkt)
1315static inline void net_pkt_stats_tick_reset(
struct net_pkt *pkt)
1320static inline void net_pkt_set_stats_tick(
struct net_pkt *pkt,
uint32_t tick)
1326#define net_pkt_set_tx_stats_tick(pkt, tick)
1327#define net_pkt_set_rx_stats_tick(pkt, tick)
1341static inline bool net_pkt_is_empty(
struct net_pkt *pkt)
1348 return &pkt->lladdr_src;
1353 return &pkt->lladdr_dst;
1356static inline void net_pkt_lladdr_swap(
struct net_pkt *pkt)
1361 net_pkt_lladdr_src(pkt)->
addr,
1362 net_pkt_lladdr_src(pkt)->
len);
1364 net_pkt_lladdr_dst(pkt)->
addr,
1365 net_pkt_lladdr_dst(pkt)->
len);
1368 net_pkt_lladdr_src(pkt)->
len);
1371static inline void net_pkt_lladdr_clear(
struct net_pkt *pkt)
1379 return pkt->ll_proto_type;
1384 pkt->ll_proto_type =
type;
1387#if defined(CONFIG_NET_IPV4_ACD)
1388static inline bool net_pkt_ipv4_acd(
struct net_pkt *pkt)
1390 return !!(pkt->ipv4_acd_arp_msg);
1393static inline void net_pkt_set_ipv4_acd(
struct net_pkt *pkt,
1394 bool is_acd_arp_msg)
1396 pkt->ipv4_acd_arp_msg = is_acd_arp_msg;
1399static inline bool net_pkt_ipv4_acd(
struct net_pkt *pkt)
1406static inline void net_pkt_set_ipv4_acd(
struct net_pkt *pkt,
1407 bool is_acd_arp_msg)
1410 ARG_UNUSED(is_acd_arp_msg);
1414#if defined(CONFIG_NET_LLDP)
1415static inline bool net_pkt_is_lldp(
struct net_pkt *pkt)
1417 return !!(pkt->lldp_pkt);
1420static inline void net_pkt_set_lldp(
struct net_pkt *pkt,
bool is_lldp)
1422 pkt->lldp_pkt = is_lldp;
1425static inline bool net_pkt_is_lldp(
struct net_pkt *pkt)
1432static inline void net_pkt_set_lldp(
struct net_pkt *pkt,
bool is_lldp)
1435 ARG_UNUSED(is_lldp);
1439#if defined(CONFIG_NET_L2_PPP)
1440static inline bool net_pkt_is_ppp(
struct net_pkt *pkt)
1442 return !!(pkt->ppp_msg);
1445static inline void net_pkt_set_ppp(
struct net_pkt *pkt,
1448 pkt->ppp_msg = is_ppp_msg;
1451static inline bool net_pkt_is_ppp(
struct net_pkt *pkt)
1458static inline void net_pkt_set_ppp(
struct net_pkt *pkt,
1462 ARG_UNUSED(is_ppp_msg);
1466#if defined(CONFIG_NET_PKT_CONTROL_BLOCK)
1467static inline void *net_pkt_cb(
struct net_pkt *pkt)
1472static inline void *net_pkt_cb(
struct net_pkt *pkt)
1480#define NET_IPV6_HDR(pkt) ((struct net_ipv6_hdr *)net_pkt_ip_data(pkt))
1481#define NET_IPV4_HDR(pkt) ((struct net_ipv4_hdr *)net_pkt_ip_data(pkt))
1483static inline void net_pkt_set_src_ipv6_addr(
struct net_pkt *pkt)
1486 net_pkt_context(pkt)),
1487 (
struct in6_addr *)NET_IPV6_HDR(pkt)->src);
1490static inline void net_pkt_set_overwrite(
struct net_pkt *pkt,
bool overwrite)
1492 pkt->overwrite = overwrite;
1495static inline bool net_pkt_is_being_overwritten(
struct net_pkt *pkt)
1497 return !!(pkt->overwrite);
1500#ifdef CONFIG_NET_PKT_FILTER
1502bool net_pkt_filter_send_ok(
struct net_pkt *pkt);
1503bool net_pkt_filter_recv_ok(
struct net_pkt *pkt);
1507static inline bool net_pkt_filter_send_ok(
struct net_pkt *pkt)
1514static inline bool net_pkt_filter_recv_ok(
struct net_pkt *pkt)
1523#if defined(CONFIG_NET_PKT_FILTER) && \
1524 (defined(CONFIG_NET_PKT_FILTER_IPV4_HOOK) || defined(CONFIG_NET_PKT_FILTER_IPV6_HOOK))
1526bool net_pkt_filter_ip_recv_ok(
struct net_pkt *pkt);
1530static inline bool net_pkt_filter_ip_recv_ok(
struct net_pkt *pkt)
1539#if defined(CONFIG_NET_PKT_FILTER) && defined(CONFIG_NET_PKT_FILTER_LOCAL_IN_HOOK)
1541bool net_pkt_filter_local_in_recv_ok(
struct net_pkt *pkt);
1545static inline bool net_pkt_filter_local_in_recv_ok(
struct net_pkt *pkt)
1554#if defined(CONFIG_NET_OFFLOAD) || defined(CONFIG_NET_L2_IPIP)
1555static inline struct sockaddr *net_pkt_remote_address(
struct net_pkt *pkt)
1557 return &pkt->remote;
1560static inline void net_pkt_set_remote_address(
struct net_pkt *pkt,
1564 memcpy(&pkt->remote, address, len);
1583#define NET_PKT_SLAB_DEFINE(name, count) \
1584 K_MEM_SLAB_DEFINE(name, sizeof(struct net_pkt), count, 4); \
1585 NET_PKT_ALLOC_STATS_DEFINE(pkt_alloc_stats_##name, name)
1590#define NET_PKT_TX_SLAB_DEFINE(name, count) NET_PKT_SLAB_DEFINE(name, count)
1607#define NET_PKT_DATA_POOL_DEFINE(name, count) \
1608 NET_BUF_POOL_DEFINE(name, count, CONFIG_NET_BUF_DATA_SIZE, \
1613#if defined(CONFIG_NET_DEBUG_NET_PKT_ALLOC) || \
1614 (CONFIG_NET_PKT_LOG_LEVEL >= LOG_LEVEL_DBG)
1615#define NET_PKT_DEBUG_ENABLED
1618#if defined(NET_PKT_DEBUG_ENABLED)
1630#define net_pkt_get_reserve_data(pool, min_len, timeout) \
1631 net_pkt_get_reserve_data_debug(pool, min_len, timeout, __func__, __LINE__)
1633struct net_buf *net_pkt_get_reserve_rx_data_debug(
size_t min_len,
1637#define net_pkt_get_reserve_rx_data(min_len, timeout) \
1638 net_pkt_get_reserve_rx_data_debug(min_len, timeout, __func__, __LINE__)
1640struct net_buf *net_pkt_get_reserve_tx_data_debug(
size_t min_len,
1644#define net_pkt_get_reserve_tx_data(min_len, timeout) \
1645 net_pkt_get_reserve_tx_data_debug(min_len, timeout, __func__, __LINE__)
1647struct net_buf *net_pkt_get_frag_debug(
struct net_pkt *pkt,
size_t min_len,
1649 const char *caller,
int line);
1650#define net_pkt_get_frag(pkt, min_len, timeout) \
1651 net_pkt_get_frag_debug(pkt, min_len, timeout, __func__, __LINE__)
1653void net_pkt_unref_debug(
struct net_pkt *pkt,
const char *caller,
int line);
1654#define net_pkt_unref(pkt) net_pkt_unref_debug(pkt, __func__, __LINE__)
1656struct net_pkt *net_pkt_ref_debug(
struct net_pkt *pkt,
const char *caller,
1658#define net_pkt_ref(pkt) net_pkt_ref_debug(pkt, __func__, __LINE__)
1661 const char *caller,
int line);
1662#define net_pkt_frag_ref(frag) net_pkt_frag_ref_debug(frag, __func__, __LINE__)
1664void net_pkt_frag_unref_debug(
struct net_buf *frag,
1665 const char *caller,
int line);
1666#define net_pkt_frag_unref(frag) \
1667 net_pkt_frag_unref_debug(frag, __func__, __LINE__)
1672 const char *caller,
int line);
1673#define net_pkt_frag_del(pkt, parent, frag) \
1674 net_pkt_frag_del_debug(pkt, parent, frag, __func__, __LINE__)
1676void net_pkt_frag_add_debug(
struct net_pkt *pkt,
struct net_buf *frag,
1677 const char *caller,
int line);
1678#define net_pkt_frag_add(pkt, frag) \
1679 net_pkt_frag_add_debug(pkt, frag, __func__, __LINE__)
1681void net_pkt_frag_insert_debug(
struct net_pkt *pkt,
struct net_buf *frag,
1682 const char *caller,
int line);
1683#define net_pkt_frag_insert(pkt, frag) \
1684 net_pkt_frag_insert_debug(pkt, frag, __func__, __LINE__)
1690#if defined(NET_PKT_DEBUG_ENABLED)
1700#define net_pkt_print_frags(pkt)
1703#if !defined(NET_PKT_DEBUG_ENABLED)
1722#if !defined(NET_PKT_DEBUG_ENABLED)
1740#if !defined(NET_PKT_DEBUG_ENABLED)
1758#if !defined(NET_PKT_DEBUG_ENABLED)
1775#if !defined(NET_PKT_DEBUG_ENABLED)
1788#if !defined(NET_PKT_DEBUG_ENABLED)
1801#if !defined(NET_PKT_DEBUG_ENABLED)
1814#if !defined(NET_PKT_DEBUG_ENABLED)
1823#if !defined(NET_PKT_DEBUG_ENABLED)
1839#if !defined(NET_PKT_DEBUG_ENABLED)
1849#if !defined(NET_PKT_DEBUG_ENABLED)
1876 struct k_mem_slab **tx,
1882#if defined(CONFIG_NET_DEBUG_NET_PKT_ALLOC)
1886void net_pkt_print(
void);
1888typedef void (*net_pkt_allocs_cb_t)(
struct net_pkt *pkt,
1890 const char *func_alloc,
1892 const char *func_free,
1897void net_pkt_allocs_foreach(net_pkt_allocs_cb_t cb,
void *
user_data);
1899const char *net_pkt_slab2str(
struct k_mem_slab *slab);
1900const char *net_pkt_pool2str(
struct net_buf_pool *pool);
1903#define net_pkt_print(...)
1909#if defined(NET_PKT_DEBUG_ENABLED)
1912 const char *caller,
int line);
1913#define net_pkt_alloc(_timeout) \
1914 net_pkt_alloc_debug(_timeout, __func__, __LINE__)
1916struct net_pkt *net_pkt_alloc_from_slab_debug(
struct k_mem_slab *
slab,
1918 const char *caller,
int line);
1919#define net_pkt_alloc_from_slab(_slab, _timeout) \
1920 net_pkt_alloc_from_slab_debug(_slab, _timeout, __func__, __LINE__)
1923 const char *caller,
int line);
1924#define net_pkt_rx_alloc(_timeout) \
1925 net_pkt_rx_alloc_debug(_timeout, __func__, __LINE__)
1931#define net_pkt_alloc_on_iface(_iface, _timeout) \
1932 net_pkt_alloc_on_iface_debug(_iface, _timeout, __func__, __LINE__)
1938#define net_pkt_rx_alloc_on_iface(_iface, _timeout) \
1939 net_pkt_rx_alloc_on_iface_debug(_iface, _timeout, \
1942int net_pkt_alloc_buffer_debug(
struct net_pkt *pkt,
1946 const char *caller,
int line);
1947#define net_pkt_alloc_buffer(_pkt, _size, _proto, _timeout) \
1948 net_pkt_alloc_buffer_debug(_pkt, _size, _proto, _timeout, \
1951int net_pkt_alloc_buffer_raw_debug(
struct net_pkt *pkt,
size_t size,
1953 const char *caller,
int line);
1954#define net_pkt_alloc_buffer_raw(_pkt, _size, _timeout) \
1955 net_pkt_alloc_buffer_raw_debug(_pkt, _size, _timeout, \
1965#define net_pkt_alloc_with_buffer(_iface, _size, _family, \
1967 net_pkt_alloc_with_buffer_debug(_iface, _size, _family, \
1978#define net_pkt_rx_alloc_with_buffer(_iface, _size, _family, \
1980 net_pkt_rx_alloc_with_buffer_debug(_iface, _size, _family, \
1984int net_pkt_alloc_buffer_with_reserve_debug(
struct net_pkt *pkt,
1991#define net_pkt_alloc_buffer_with_reserve(_pkt, _size, _reserve, _proto, _timeout) \
1992 net_pkt_alloc_buffer_with_reserve_debug(_pkt, _size, _reserve, _proto, \
1993 _timeout, __func__, __LINE__)
1998#if !defined(NET_PKT_DEBUG_ENABLED)
2012#if !defined(NET_PKT_DEBUG_ENABLED)
2031#if !defined(NET_PKT_DEBUG_ENABLED)
2045#if !defined(NET_PKT_DEBUG_ENABLED)
2066#if !defined(NET_PKT_DEBUG_ENABLED)
2088#if !defined(NET_PKT_DEBUG_ENABLED)
2106#if !defined(NET_PKT_DEBUG_ENABLED)
2131#if !defined(NET_PKT_DEBUG_ENABLED)
2242 struct net_pkt_cursor *backup)
2244 backup->buf = pkt->
cursor.buf;
2245 backup->pos = pkt->
cursor.pos;
2255 struct net_pkt_cursor *backup)
2257 pkt->
cursor.buf = backup->buf;
2258 pkt->
cursor.pos = backup->pos;
2628struct net_pkt_data_access {
2629#if !defined(CONFIG_NET_HEADERS_ALWAYS_CONTIGUOUS)
2635#if defined(CONFIG_NET_HEADERS_ALWAYS_CONTIGUOUS)
2636#define NET_PKT_DATA_ACCESS_DEFINE(_name, _type) \
2637 struct net_pkt_data_access _name = { \
2638 .size = sizeof(_type), \
2641#define NET_PKT_DATA_ACCESS_CONTIGUOUS_DEFINE(_name, _type) \
2642 NET_PKT_DATA_ACCESS_DEFINE(_name, _type)
2645#define NET_PKT_DATA_ACCESS_DEFINE(_name, _type) \
2646 _type _hdr_##_name; \
2647 struct net_pkt_data_access _name = { \
2648 .data = &_hdr_##_name, \
2649 .size = sizeof(_type), \
2652#define NET_PKT_DATA_ACCESS_CONTIGUOUS_DEFINE(_name, _type) \
2653 struct net_pkt_data_access _name = { \
2655 .size = sizeof(_type), \
2676 struct net_pkt_data_access *access);
2692 struct net_pkt_data_access *access);
2699 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:168
#define htons(x)
Convert 16-bit value from host to network byte order.
Definition net_ip.h:124
size_t socklen_t
Length of a socket address.
Definition net_ip.h:172
#define htonl(x)
Convert 32-bit value from host to network byte order.
Definition net_ip.h:132
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:2713
static struct net_if * net_context_get_iface(struct net_context *context)
Get network interface for this context.
Definition net_context.h:752
static struct net_linkaddr * net_if_get_link_addr(struct net_if *iface)
Get an network interface's link address.
Definition net_if.h:1204
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:2212
static int net_linkaddr_clear(struct net_linkaddr *lladdr)
Clear link address.
Definition net_linkaddr.h:196
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:2498
int net_pkt_alloc_buffer_with_reserve(struct net_pkt *pkt, size_t size, size_t reserve, enum net_ip_protocol proto, k_timeout_t timeout)
Allocate buffer for a net_pkt and reserve some space in the first net_buf.
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:1700
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 start of the packet.
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:2479
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.
static size_t net_pkt_get_len(struct net_pkt *pkt)
Get the total amount of bytes stored in a packet.
Definition net_pkt.h:2559
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:2462
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:2268
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:2241
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:2698
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:2536
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:2254
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:2517
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:2388
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:148
static uint16_t net_eth_vlan_set_vid(uint16_t tci, uint16_t vid)
Set VLAN identifier to TCI.
Definition ethernet_vlan.h:81
static uint8_t net_eth_vlan_get_dei(uint16_t tci)
Get Drop Eligible Indicator from TCI.
Definition ethernet_vlan.h:56
#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:94
static uint16_t net_eth_vlan_get_vid(uint16_t tci)
Get VLAN identifier from TCI.
Definition ethernet_vlan.h:44
static uint16_t net_eth_vlan_set_pcp(uint16_t tci, uint8_t pcp)
Set Priority Code Point to TCI.
Definition ethernet_vlan.h:107
static uint8_t net_eth_vlan_get_pcp(uint16_t tci)
Get Priority Code Point from TCI.
Definition ethernet_vlan.h:68
#define NULL
Definition iar_missing_defs.h:20
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:97
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:143
Kernel timeout type.
Definition clock.h:65
Network buffer pool representation.
Definition net_buf.h:1079
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:209
Network Interface structure.
Definition net_if.h:726
Hardware link address structure.
Definition net_linkaddr.h:70
uint8_t addr[6]
The array of bytes representing the address.
Definition net_linkaddr.h:78
uint8_t type
What kind of address is this for.
Definition net_linkaddr.h:72
uint8_t len
The real length of the ll address.
Definition net_linkaddr.h:75
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:410
#define sys_cpu_to_le32(val)
Convert 32-bit integer from host endianness to little-endian.
Definition byteorder.h:272
#define sys_cpu_to_le16(val)
Convert 16-bit integer from host endianness to little-endian.
Definition byteorder.h:268