DPDK  24.03.0-rc1
Data Fields
rte_flow_action_rss Struct Reference

#include <rte_flow.h>

Data Fields

enum rte_eth_hash_function func
uint32_t level
uint64_t types
uint32_t key_len
uint32_t queue_num
const uint8_t * key
const uint16_t * queue

Detailed Description


Similar to QUEUE, except RSS is additionally performed on packets to spread them among several queues according to the provided parameters.

Unlike global RSS settings used by other DPDK APIs, unsetting the types field does not disable RSS in a flow rule. Doing so instead requests safe unspecified "best-effort" settings from the underlying PMD, which depending on the flow rule, may result in anything ranging from empty (single queue) to all-inclusive RSS.

Note: RSS hash result is stored in the hash.rss mbuf field which overlaps hash.fdir.lo. Since the MARK action sets the hash.fdir.hi field only, both can be requested simultaneously.


Definition at line 3466 of file rte_flow.h.

Field Documentation

◆ func

RSS hash function to apply.

Definition at line 3467 of file rte_flow.h.

◆ level

uint32_t level

Packet encapsulation level RSS hash types apply to.

  • 0 requests the default behavior. Depending on the packet type, it can mean outermost, innermost, anything in between or even no RSS.

    It basically stands for the innermost encapsulation level RSS can be performed on according to PMD and device capabilities.

  • 1 requests RSS to be performed on the outermost packet encapsulation level.
  • 2 and subsequent values request RSS to be performed on the specified inner packet encapsulation level, from outermost to innermost (lower to higher values).

Values other than 0 are not necessarily supported.

Requesting a specific RSS level on unrecognized traffic results in undefined behavior. For predictable results, it is recommended to make the flow rule pattern match packet headers up to the requested encapsulation level so that only matching traffic goes through.

Definition at line 3493 of file rte_flow.h.

◆ types

uint64_t types

Specific RSS hash types (see RTE_ETH_RSS_*).


Definition at line 3494 of file rte_flow.h.

◆ key_len

uint32_t key_len

Hash key length in bytes.

Definition at line 3495 of file rte_flow.h.

◆ queue_num

uint32_t queue_num

Number of entries in queue.

Definition at line 3496 of file rte_flow.h.

◆ key

const uint8_t* key

Hash key.

Definition at line 3497 of file rte_flow.h.

◆ queue

const uint16_t* queue

Queue indices to use.


Definition at line 3498 of file rte_flow.h.

The documentation for this struct was generated from the following file: