Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
rte_eth_hairpin_conf(3) 	      DPDK		 rte_eth_hairpin_conf(3)

NAME
     rte_eth_hairpin_conf

SYNOPSIS
     #include <rte_ethdev.h>

   Data Fields
     uint32_t peer_count:16
     uint32_t tx_explicit:1
     uint32_t manual_bind:1
     uint32_t use_locked_device_memory:1
     uint32_t use_rte_memory:1
     uint32_t force_memory:1
     uint32_t reserved:11

Detailed Description
     Warning
	 EXPERIMENTAL: this API may change, or be removed, without prior notice

     A structure used to configure hairpin binding.

     Definition at line 1291 of file rte_ethdev.h.

Field Documentation
   uint32_t peer_count
     The number of peers.

     Definition at line 1292 of file rte_ethdev.h.

   uint32_t tx_explicit
     Explicit Tx flow rule mode. One hairpin pair of queues should have the same
     attribute.

     * When  set,  the	user  should be responsible for inserting the hairpin Tx
       part flows and removing them.

     * When clear, the PMD will try to handle the Tx part of the flows, e.g., by
       splitting one flow into two parts.

     Definition at line 1303 of file rte_ethdev.h.

   uint32_t manual_bind
     Manually bind hairpin queues. One hairpin pair of queues  should  have  the
     same attribute.

     * When  set, to enable hairpin, the user should call the hairpin bind func-
       tion after all the queues are set up properly and the ports are	started.
       Also,  the  hairpin  unbind  function should be called accordingly before
       stopping a port that with hairpin configured.

     * When cleared, the PMD will try to enable the hairpin with the queues con-
       figured automatically during port start.

     Definition at line 1316 of file rte_ethdev.h.

   uint32_t use_locked_device_memory
     Use locked device memory as a backing storage.

     * When set, PMD will attempt place descriptors and/or data buffers in dedi-
       cated device memory.

     * When cleared, PMD will use default memory  type	as  a  backing	storage.
       Please refer to PMD documentation for details.

     API user should check if PMD supports this configuration flag using

     See also
	 rte_eth_dev_hairpin_capability_get.

     Definition at line 1329 of file rte_ethdev.h.

   uint32_t use_rte_memory
     Use DPDK memory as backing storage.

     * When  set, PMD will attempt place descriptors and/or data buffers in host
       memory managed by DPDK.

     * When cleared, PMD will use default memory  type	as  a  backing	storage.
       Please refer to PMD documentation for details.

     API user should check if PMD supports this configuration flag using

     See also
	 rte_eth_dev_hairpin_capability_get.

     Definition at line 1342 of file rte_ethdev.h.

   uint32_t force_memory
     Force usage of hairpin memory configuration.

     * When  set, PMD will attempt to use specified memory settings. If resource
       allocation fails, then hairpin queue allocation will result in an error.

     * When clear, PMD will attempt to use specified  memory  settings.  If  re-
       source allocation fails, then PMD will retry allocation with default con-
       figuration.

     Definition at line 1354 of file rte_ethdev.h.

   uint32_t reserved
     Reserved bits.

     Definition at line 1356 of file rte_ethdev.h.

Author
     Generated automatically by Doxygen for DPDK from the source code.

Version 25.11.0 		 Thu Aug 27 2026	 rte_eth_hairpin_conf(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=manual_bind&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help