TAPI for RTE FLOW API remote calls

Overview

// global functions

int rpc_rte_flow_validate(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, tarpc_rte_flow_error* error);
rpc_rte_flow_p rpc_rte_flow_create(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, tarpc_rte_flow_error* error);
int rpc_rte_flow_destroy(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_flow_p flow, tarpc_rte_flow_error* error);
int rpc_rte_flow_query(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_flow_p flow, rpc_rte_flow_action_p action, tarpc_rte_flow_query_data* data, tarpc_rte_flow_error* error);
int rpc_rte_flow_flush(rcf_rpc_server* rpcs, uint16_t port_id, tarpc_rte_flow_error* error);
int rpc_rte_flow_isolate(rcf_rpc_server* rpcs, uint16_t port_id, int set, struct tarpc_rte_flow_error* error);
int rpc_rte_flow_tunnel_decap_set(rcf_rpc_server* rpcs, uint16_t port_id, const struct tarpc_rte_flow_tunnel* tunnel, rpc_rte_flow_action_p* actions, uint32_t* num_of_actions, struct tarpc_rte_flow_error* error);
int rpc_rte_flow_tunnel_match(rcf_rpc_server* rpcs, uint16_t port_id, const struct tarpc_rte_flow_tunnel* tunnel, rpc_rte_flow_item_p* items, uint32_t* num_of_items, struct tarpc_rte_flow_error* error);
int rpc_rte_flow_get_restore_info(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_mbuf_p m, struct tarpc_rte_flow_restore_info* info, struct tarpc_rte_flow_error* error);
int rpc_rte_flow_tunnel_action_decap_release(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_flow_action_p actions, uint32_t num_of_actions, struct tarpc_rte_flow_error* error);
int rpc_rte_flow_tunnel_item_release(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_flow_item_p items, uint32_t num_of_items, struct tarpc_rte_flow_error* error);

Detailed Documentation

Global Functions

int rpc_rte_flow_validate(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, tarpc_rte_flow_error* error)

rte_flow_validate() RPC.

Parameters:

port_id

Port number

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

error

Perform verbose error reporting if not NULL

Returns:

0 on success; jumps out in case of failure

rpc_rte_flow_p rpc_rte_flow_create(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, tarpc_rte_flow_error* error)

rte_flow_create() RPC.

Parameters:

port_id

Port number

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

error

Perform verbose error reporting if not NULL

Returns:

RTE flow pointer on success; jumps out when pointer is NULL

int rpc_rte_flow_destroy(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_flow_p flow, tarpc_rte_flow_error* error)

rte_flow_destroy() RPC.

Parameters:

port_id

Port number

flow

RTE flow pointer

error

Perform verbose error reporting if not NULL

Returns:

0 on success; jumps out in case of failure

int rpc_rte_flow_query(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_flow_p flow, rpc_rte_flow_action_p action, tarpc_rte_flow_query_data* data, tarpc_rte_flow_error* error)

rte_flow_query() RPC.

Parameters:

port_id

Port number

flow

RTE flow pointer

action

Action definition as defined in original flow rule

data

Pointer to storage for the associated query data type

error

Perform verbose error reporting if not NULL

Returns:

0 on success; jumps out in case of failure

int rpc_rte_flow_flush(rcf_rpc_server* rpcs, uint16_t port_id, tarpc_rte_flow_error* error)

rte_flow_flush() RPC.

Parameters:

rpcs

RPC server handle

port_id

Port number

error

Perform verbose error reporting if not NULL

Returns:

0 on success; jumps out in case of failure

int rpc_rte_flow_isolate(rcf_rpc_server* rpcs, uint16_t port_id, int set, struct tarpc_rte_flow_error* error)

rte_flow_isolate() RPC

Parameters:

port_id

Port number

set

Non-zero to enter isolated mode, 0 to leave it

error

Perform verbose error reporting if not NULL

Returns:

0 on success; jumps out in case of failure

int rpc_rte_flow_tunnel_decap_set(rcf_rpc_server* rpcs, uint16_t port_id, const struct tarpc_rte_flow_tunnel* tunnel, rpc_rte_flow_action_p* actions, uint32_t* num_of_actions, struct tarpc_rte_flow_error* error)

rte_flow_tunnel_decap_set() RPC

Returns:

0 on success; jumps out on error (negative value)

int rpc_rte_flow_tunnel_match(rcf_rpc_server* rpcs, uint16_t port_id, const struct tarpc_rte_flow_tunnel* tunnel, rpc_rte_flow_item_p* items, uint32_t* num_of_items, struct tarpc_rte_flow_error* error)

rte_flow_tunnel_match() RPC

Returns:

0 on success; jumps out on error (negative value)

int rpc_rte_flow_get_restore_info(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_mbuf_p m, struct tarpc_rte_flow_restore_info* info, struct tarpc_rte_flow_error* error)

rte_flow_get_restore_info() RPC

Returns:

0 on success

int rpc_rte_flow_tunnel_action_decap_release(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_flow_action_p actions, uint32_t num_of_actions, struct tarpc_rte_flow_error* error)

rte_flow_tunnel_action_decap_release() RPC

Returns:

0 on success; jumps out on error (negative value)

int rpc_rte_flow_tunnel_item_release(rcf_rpc_server* rpcs, uint16_t port_id, rpc_rte_flow_item_p items, uint32_t num_of_items, struct tarpc_rte_flow_error* error)

rte_flow_tunnel_item_release() RPC

Returns:

0 on success; jumps out on error (negative value)