#include <rte_mbuf.h>

Public Member Functions
union {
rte_iova_t buf_physaddr

}	__rte_aligned (sizeof(rte_iova_t))

Data Fields
void *	buf_addr

union {
rte_atomic16_t refcnt_atomic

uint16_t refcnt

}	__rte_aligned

uint16_t	nb_segs

uint16_t	port

uint64_t	ol_flags

uint32_t	pkt_len

uint16_t	data_len

uint16_t	vlan_tci

uint16_t	vlan_tci_outer

uint16_t	buf_len

uint64_t	timestamp

struct rte_mempool *	pool

struct rte_mbuf *	next

uint16_t	priv_size

uint16_t	timesync

uint32_t	seqn

struct rte_mbuf_ext_shared_info *	shinfo

uint32_t	packet_type

uint32_t	l2_type:4

uint32_t	l3_type:4

uint32_t	l4_type:4

uint32_t	tun_type:4

uint8_t	inner_esp_next_proto

uint8_t	inner_l2_type:4

uint8_t	inner_l3_type:4

uint32_t	inner_l4_type:4

uint32_t	rss

uint32_t	lo

uint32_t	hi

struct {
uint32_t hi

}	fdir

struct {
uint32_t hi

}	sched

union {
uint32_t rss

struct {
uint32_t hi

} fdir

struct {
uint32_t hi

} sched

}	hash

uint32_t	tx_metadata

void *	userdata

uint64_t	udata64

uint64_t	tx_offload

uint64_t	l2_len:7

uint64_t	l3_len:9

uint64_t	l4_len:8

uint64_t	tso_segsz:16

uint64_t	outer_l3_len:9

uint64_t	outer_l2_len:7

Detailed Description

The generic rte_mbuf, containing a packet mbuf.

Examples:: examples/bbdev_app/main.c, examples/bond/main.c, examples/distributor/main.c, examples/ethtool/ethtool-app/main.c, examples/exception_path/main.c, examples/fips_validation/main.c, examples/flow_classify/flow_classify.c, examples/flow_filtering/main.c, examples/ip_fragmentation/main.c, examples/ip_pipeline/mempool.c, examples/ip_pipeline/pipeline.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/esp.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipsec-secgw/ipsec.c, examples/ipsec-secgw/sa.c, examples/ipv4_multicast/main.c, examples/kni/main.c, examples/l2fwd-cat/l2fwd-cat.c, examples/l2fwd-crypto/main.c, examples/l2fwd-jobstats/main.c, examples/l2fwd-keepalive/main.c, examples/l2fwd/main.c, examples/l3fwd-acl/main.c, examples/l3fwd-power/main.c, examples/l3fwd-vf/main.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_lpm.c, examples/link_status_interrupt/main.c, examples/load_balancer/runtime.c, examples/multi_process/client_server_mp/mp_client/client.c, examples/multi_process/client_server_mp/mp_server/main.c, examples/multi_process/symmetric_mp/main.c, examples/netmap_compat/lib/compat_netmap.c, examples/packet_ordering/main.c, examples/performance-thread/l3fwd-thread/main.c, examples/ptpclient/ptpclient.c, examples/qos_meter/main.c, examples/qos_sched/app_thread.c, examples/qos_sched/main.c, examples/quota_watermark/qw/main.c, examples/rxtx_callbacks/main.c, examples/server_node_efd/node/node.c, examples/server_node_efd/server/main.c, examples/skeleton/basicfwd.c, examples/tep_termination/main.c, examples/tep_termination/vxlan.c, examples/tep_termination/vxlan_setup.c, examples/vhost/main.c, examples/vhost/virtio_net.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 478 of file rte_mbuf.h.

Member Function Documentation

RTE_STD_C11 union rte_mbuf::@172 __rte_aligned ( sizeof(rte_iova_t) )

Physical address of segment buffer. Force alignment to 8-bytes, so as to ensure we have the exact same mbuf cacheline0 layout for 32-bit and 64-bit. This makes working on vector drivers easier.

Field Documentation

void* buf_addr

Virtual address of segment buffer.

Definition at line 481 of file rte_mbuf.h.

rte_iova_t buf_physaddr

deprecated

Definition at line 491 of file rte_mbuf.h.

rte_atomic16_t refcnt_atomic

Atomically accessed refcnt

Definition at line 509 of file rte_mbuf.h.

uint16_t refcnt

Non-atomically accessed refcnt

Definition at line 510 of file rte_mbuf.h.

RTE_STD_C11 { ... } __rte_aligned

Reference counter. Its size should at least equal to the size of port field (16 bits), to support zero-copy broadcast. It should only be accessed using the following functions: rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and rte_mbuf_refcnt_set(). The functionality of these functions (atomic, or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC config option.

uint16_t nb_segs

Number of segments.

Examples:: examples/exception_path/main.c, examples/ipv4_multicast/main.c, and examples/vhost/virtio_net.c.

Definition at line 512 of file rte_mbuf.h.

uint16_t port

Input port (16 bits to support more than 256 virtual ports). The event eth Tx adapter uses this field to specify the output port.

Examples:: examples/distributor/main.c, examples/ip_fragmentation/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipv4_multicast/main.c, examples/l2fwd-crypto/main.c, examples/load_balancer/runtime.c, examples/multi_process/client_server_mp/mp_client/client.c, examples/packet_ordering/main.c, examples/performance-thread/l3fwd-thread/main.c, and examples/server_node_efd/node/node.c.

Definition at line 517 of file rte_mbuf.h.

uint64_t ol_flags

Offload features.

Examples:: examples/ipsec-secgw/esp.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ptpclient/ptpclient.c, examples/tep_termination/vxlan.c, examples/tep_termination/vxlan_setup.c, and examples/vhost/main.c.

Definition at line 519 of file rte_mbuf.h.

uint32_t packet_type

L2/L3/L4 and tunnel information.

Examples:: examples/ip_fragmentation/main.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/esp.c, examples/l3fwd-acl/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_lpm.c, examples/performance-thread/l3fwd-thread/main.c, and examples/tep_termination/vxlan.c.

Definition at line 533 of file rte_mbuf.h.

uint32_t l2_type

(Outer) L2 type.

Definition at line 535 of file rte_mbuf.h.

uint32_t l3_type

(Outer) L3 type.

Definition at line 536 of file rte_mbuf.h.

uint32_t l4_type

(Outer) L4 type.

Definition at line 537 of file rte_mbuf.h.

uint32_t tun_type

Tunnel type.

Definition at line 538 of file rte_mbuf.h.

uint8_t inner_esp_next_proto

ESP next protocol type, valid if RTE_PTYPE_TUNNEL_ESP tunnel type is set on both Tx and Rx.

Examples:: examples/ipsec-secgw/esp.c.

Definition at line 541 of file rte_mbuf.h.

uint8_t inner_l2_type

Inner L2 type.

Definition at line 548 of file rte_mbuf.h.

uint8_t inner_l3_type

Inner L3 type.

Definition at line 550 of file rte_mbuf.h.

uint32_t inner_l4_type

Inner L4 type.

Definition at line 554 of file rte_mbuf.h.

uint32_t pkt_len

Total pkt len: sum of all segments.

Examples:: examples/bond/main.c, examples/exception_path/main.c, examples/ip_fragmentation/main.c, examples/ipv4_multicast/main.c, examples/l3fwd-acl/main.c, examples/l3fwd-power/main.c, examples/l3fwd-vf/main.c, examples/performance-thread/l3fwd-thread/main.c, examples/ptpclient/ptpclient.c, examples/quota_watermark/qw/main.c, examples/tep_termination/vxlan.c, examples/vhost/main.c, and examples/vhost/virtio_net.c.

Definition at line 558 of file rte_mbuf.h.

uint16_t data_len

Amount of data in segment buffer.

Examples:: examples/bond/main.c, examples/exception_path/main.c, examples/ipv4_multicast/main.c, examples/ptpclient/ptpclient.c, examples/quota_watermark/qw/main.c, examples/vhost/main.c, and examples/vhost/virtio_net.c.

Definition at line 559 of file rte_mbuf.h.

uint16_t vlan_tci

VLAN TCI (CPU order), valid if PKT_RX_VLAN is set.

Examples:: examples/ipv4_multicast/main.c, and examples/vhost/main.c.

Definition at line 561 of file rte_mbuf.h.

uint32_t rss

RSS hash result if RSS enabled

Definition at line 566 of file rte_mbuf.h.

uint32_t lo

Second 4 flexible bytes

Definition at line 573 of file rte_mbuf.h.

uint32_t hi

First 4 flexible bytes or FD ID, dependent on PKT_RX_FDIR_* flag in ol_flags.

The event eth Tx adapter uses this field to store Tx queue id.

See also: rte_event_eth_tx_adapter_txq_set()

Definition at line 576 of file rte_mbuf.h.

struct { ... } fdir

Filter identifier if FDIR enabled

struct { ... } sched

Hierarchical scheduler User defined tags. See rte_distributor_process()

union { ... } hash

hash information

uint32_t tx_metadata

Application specific metadata value for egress flow rule match. Valid if PKT_TX_METADATA is set. Located here to allow conjunct use with hash.sched.hi.

Definition at line 600 of file rte_mbuf.h.

uint16_t vlan_tci_outer

Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set.