:orphan: .. index:: pair: group; DPDK RTE flow helper functions TAPI .. _doxid-group__tapi__rte__flow: DPDK RTE flow helper functions TAPI =================================== .. toctree:: :hidden: Overview ~~~~~~~~ RTE flow helper functions TAPI Copyright (C) 2019-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions void :ref:`tapi_rte_flow_add_ndn_action_queue`(:ref:`asn_value`* ndn_actions, int action_index, uint16_t queue); void :ref:`tapi_rte_flow_add_ndn_action_drop`(:ref:`asn_value`* ndn_actions, int action_index); void :ref:`tapi_rte_flow_add_ndn_action_count`(:ref:`asn_value`* ndn_actions, int action_index, uint32_t counter_id); void :ref:`tapi_rte_flow_add_ndn_action_encap`(:ref:`asn_value`* ndn_actions, int action_index, :ref:`tarpc_rte_eth_tunnel_type` type, const :ref:`asn_value`* encap_hdr); void :ref:`tapi_rte_flow_add_ndn_action_decap`(:ref:`asn_value`* ndn_actions, int action_index, :ref:`tarpc_rte_eth_tunnel_type` type); void :ref:`tapi_rte_flow_add_ndn_action_of_pop_vlan`(:ref:`asn_value`* ndn_actions, int action_index); void :ref:`tapi_rte_flow_add_ndn_action_of_push_vlan`(:ref:`asn_value`* ndn_actions, int action_index, uint16_t ethertype); void :ref:`tapi_rte_flow_add_ndn_action_of_set_vlan_vid`(:ref:`asn_value`* ndn_actions, int action_index, uint16_t vlan_vid); void :ref:`tapi_rte_flow_add_ndn_action_port`(ndn_rte_flow_action_type_t type, uint32_t ethdev_port_id, :ref:`asn_value`* actions, int entry_idx); void :ref:`tapi_rte_flow_add_ndn_action_jump`(:ref:`asn_value`* ndn_actions, int action_index, uint32_t group); void :ref:`tapi_rte_flow_add_ndn_action_dec_ttl`(:ref:`asn_value`* ndn_actions, int action_index); void :ref:`tapi_rte_flow_add_ndn_item_port`(ndn_rte_flow_item_type_t type, uint32_t ethdev_port_id, :ref:`asn_value`* items, int entry_idx); rpc_rte_flow_p :ref:`tapi_rte_flow_validate_and_create_rule`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_attr_p attr, rpc_rte_flow_item_p pattern, rpc_rte_flow_action_p actions); void :ref:`tapi_rte_flow_make_attr`(:ref:`rcf_rpc_server`* rpcs, uint32_t group, uint32_t priority, bool ingress, bool egress, bool transfer, rpc_rte_flow_attr_p* attr); void :ref:`tapi_rte_flow_isolate`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, int set); .. _details-group__tapi__rte__flow: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ RTE flow helper functions TAPI Copyright (C) 2019-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_rte_flow_add_ndn_action_queue .. _doxid-group__tapi__rte__flow_1gafc4341634f19250787b297bab053ca49: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_queue(:ref:`asn_value`* ndn_actions, int action_index, uint16_t queue) Add a QUEUE action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list * - queue - Queue index of the action .. index:: pair: function; tapi_rte_flow_add_ndn_action_drop .. _doxid-group__tapi__rte__flow_1ga5e46294fba43e4c9edc7d9c3d4e9eece: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_drop(:ref:`asn_value`* ndn_actions, int action_index) Add a DROP action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list .. index:: pair: function; tapi_rte_flow_add_ndn_action_count .. _doxid-group__tapi__rte__flow_1ga761d794e663970f19a3fa424f5cfca25: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_count(:ref:`asn_value`* ndn_actions, int action_index, uint32_t counter_id) Add a COUNT action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list * - counter_id - Counter index .. index:: pair: function; tapi_rte_flow_add_ndn_action_encap .. _doxid-group__tapi__rte__flow_1gac439e354f8970b5c1ea935669e1ebfd9: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_encap(:ref:`asn_value`* ndn_actions, int action_index, :ref:`tarpc_rte_eth_tunnel_type` type, const :ref:`asn_value`* encap_hdr) Add a encap action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list * - type - Type of the encapsulation * - encap_hdr - Flow rule pattern that is used as a encapsulated packet's header definition .. index:: pair: function; tapi_rte_flow_add_ndn_action_decap .. _doxid-group__tapi__rte__flow_1gaa1fc9da3f5dba41287a7870d917575ae: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_decap(:ref:`asn_value`* ndn_actions, int action_index, :ref:`tarpc_rte_eth_tunnel_type` type) Add a decap action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list * - type - Type of the encapsulation .. index:: pair: function; tapi_rte_flow_add_ndn_action_of_pop_vlan .. _doxid-group__tapi__rte__flow_1ga6fbae1bf0841a2d1e4dd35513801021a: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_of_pop_vlan(:ref:`asn_value`* ndn_actions, int action_index) Add a pop VLAN action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list .. index:: pair: function; tapi_rte_flow_add_ndn_action_of_push_vlan .. _doxid-group__tapi__rte__flow_1ga2d2a31308123fef39e4cde494b9b7883: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_of_push_vlan(:ref:`asn_value`* ndn_actions, int action_index, uint16_t ethertype) Add a push vlan action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list * - ethertype - VLAN EtherType .. index:: pair: function; tapi_rte_flow_add_ndn_action_of_set_vlan_vid .. _doxid-group__tapi__rte__flow_1gad8cc5fa21405da1dc47bef44f64a5437: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_of_set_vlan_vid(:ref:`asn_value`* ndn_actions, int action_index, uint16_t vlan_vid) Add a set vlan vid action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list * - vlan_vid - VLAN ID .. index:: pair: function; tapi_rte_flow_add_ndn_action_port .. _doxid-group__tapi__rte__flow_1gaec968545b67562abaf1fe918320b0b0e: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_port(ndn_rte_flow_action_type_t type, uint32_t ethdev_port_id, :ref:`asn_value`* actions, int entry_idx) Add an action of type PORT_REPRESENTOR / REPRESENTED_PORT to the action list. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - The action type * - ethdev_port_id - The representor's ethdev port ID * - actions - The list of actions * - entry_idx - The entry index .. index:: pair: function; tapi_rte_flow_add_ndn_action_jump .. _doxid-group__tapi__rte__flow_1gab5a458855fb269a0752c004994a1cd6b: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_jump(:ref:`asn_value`* ndn_actions, int action_index, uint32_t group) Add a JUMP action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list * - group - Group to redirect packets to .. index:: pair: function; tapi_rte_flow_add_ndn_action_dec_ttl .. _doxid-group__tapi__rte__flow_1ga8fc8239b253a7189202ee33f5fbc3c1a: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_action_dec_ttl(:ref:`asn_value`* ndn_actions, int action_index) Add a TTL decrease action to an action list at specified index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ndn_actions - Action list * - action_index - Index at which the action is put to list .. index:: pair: function; tapi_rte_flow_add_ndn_item_port .. _doxid-group__tapi__rte__flow_1ga2254311df0cbd8732d270457e19408ec: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_add_ndn_item_port(ndn_rte_flow_item_type_t type, uint32_t ethdev_port_id, :ref:`asn_value`* items, int entry_idx) Add an item of type PORT_REPRESENTOR / REPRESENTED_PORT to the item list. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - The item type * - ethdev_port_id - The representor's ethdev port ID * - items - The list of items * - entry_idx - The entry index .. index:: pair: function; tapi_rte_flow_validate_and_create_rule .. _doxid-group__tapi__rte__flow_1ga66be92eeecbd2bd9b55cee52fc88119a: .. ref-code-block:: cpp :class: doxyrest-title-code-block rpc_rte_flow_p tapi_rte_flow_validate_and_create_rule(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_attr_p attr, rpc_rte_flow_item_p pattern, rpc_rte_flow_action_p actions) Convert an ASN value representing a flow rule pattern into RTE flow rule pattern and a template that matches the pattern. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server handle * - port_id - The port identifier of the device * - attr - RTE flow attr pointer * - pattern - RTE flow item pointer to the array of items * - actions - RTE flow action pointer to the array of actions .. rubric:: Returns: RTE flow pointer on success; jumps out on failure .. index:: pair: function; tapi_rte_flow_make_attr .. _doxid-group__tapi__rte__flow_1gabdbf9c9439eb4592c8330357ddf38ee0: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_make_attr(:ref:`rcf_rpc_server`* rpcs, uint32_t group, uint32_t priority, bool ingress, bool egress, bool transfer, rpc_rte_flow_attr_p* attr) Make RTE flow rule attributes .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server handle * - group - Rule priority group * - priority - Rule priority level within group * - ingress - Rule applies to ingress traffic * - egress - Rule applies to egress traffic * - transfer - Transfer the rule to the lowest possible level of any device endpoints found in the pattern * - attr - RTE flow attr pointer * - TEST_FAIL - .. index:: pair: function; tapi_rte_flow_isolate .. _doxid-group__tapi__rte__flow_1gab65ccf2cf31e986e976bb9b4c0aba75b: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_rte_flow_isolate(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, int set) Isolate RTE flow .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server handle * - port_id - The port identifier of the device * - set - Nonzero to enter isolated mode, leave it otherwise * - TEST_FAIL -