rte_flow.h

Go to the documentation of this file.

#ifndef RTE_OAL_FLOW_H
#define RTE_OAL_FLOW_H
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

RTE_DECLARE_STORAGE(rte_flow_storage_t, 64U);

typedef struct rte_flow_impl_s *rte_flow_handle_t;

typedef enum rte_flow_oflag_e
{
    RTE_FLOW_O_REQUESTER = 1, 
    RTE_FLOW_O_RESPONDER = 2, 
    RTE_FLOW_O_PUBLISHER = 4, 
    RTE_FLOW_O_SUBSCRIBER = 8, 
    RTE_FLOW_O_NONBLOCK  = 16  
} rte_flow_oflag_t;

typedef enum rte_flow_channel_e
{
    RTE_FLOW_CHANNEL_USER = 1, 
    RTE_FLOW_CHANNEL_CTRL = 2  
} rte_flow_channel_t;

typedef struct rte_flow_attr_s
{
    size_t   message_size; 
    uint32_t oflags;       
    bool     is_connected; 
} rte_flow_attr_t;

typedef struct rte_flow_config_s
{
    const char *name;
    uint32_t    oflags;
    size_t      message_size;
    rte_duration_ms_t open_timeout_ms;
} rte_flow_config_t;

rte_status_t rte_flow_open(rte_flow_storage_t *storage,
                              const rte_flow_config_t *config,
                              rte_flow_handle_t *out_handle);

rte_status_t rte_flow_close(rte_flow_handle_t handle);

rte_status_t rte_flow_send(rte_flow_handle_t handle,
                              const void *data,
                              size_t data_size,
                              rte_flow_channel_t channel,
                              rte_duration_ms_t timeout_ms);

rte_status_t rte_flow_receive(rte_flow_handle_t handle,
                                 void *out_data,
                                 size_t buffer_size,
                                 rte_flow_channel_t *out_channel,
                                 rte_duration_ms_t timeout_ms);

rte_status_t rte_flow_getattr(rte_flow_handle_t handle, rte_flow_attr_t *out_attr);

rte_status_t rte_flow_setattr(rte_flow_handle_t handle,
                                 const rte_flow_attr_t *new_attr,
                                 rte_flow_attr_t *out_old_attr);
 
/*
 * The OSAdapter vtable (rte_osadapter_flow_t) and
 * rte_osadapter_flow_register() live in
 * rte_osadapter/flow/rte_osadapter_flow.h, not here (ADR-021 seam,
 * same posture as rte_netlink). This header is the consumer-facing
 * surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_OAL_FLOW_H */
 /* FLOW */