rte_protocol_adapter_tcp.c

Go to the documentation of this file.

 
#include "rte/oal/protocol/rte_protocol_adapter.h"
#include "rte/oal/memory/rte_mem_util.h"
 
typedef struct rte_protocol_tcp_state_s
{
    rte_os_socket_handle_t     sock;
    const rte_os_socket_ops_t *os_sockets;
    rte_protocol_config_t      config;
    bool                        is_connected;
} rte_protocol_tcp_state_t;
 
static rte_status_t tcp_adapter_open(void *storage, size_t storage_size,
                                      const rte_protocol_config_t *config,
                                      const rte_os_socket_ops_t *os_sockets,
                                      rte_protocol_handle_t *out_handle)
{
    rte_protocol_tcp_state_t *state = NULL;
    const rte_os_socket_ops_t *ops = os_sockets;
    rte_status_t status;
    rte_os_socket_handle_t sock = RTE_OS_SOCKET_INVALID_HANDLE;
 
    if ((storage == NULL) || (config == NULL) || (out_handle == NULL))
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    if (storage_size < sizeof(rte_protocol_tcp_state_t))
    {
        return RTE_STATUS_RESOURCE_EXHAUSTED;
    }
 
    if (ops == NULL)
    {
        ops = rte_osadapter_get_socket_ops();
    }
    if ((ops == NULL) || (ops->open == NULL) || (ops->close == NULL))
    {
        return RTE_STATUS_NOT_INITIALIZED;
    }
 
    state = (rte_protocol_tcp_state_t *)storage;
    rte_mem_set(state, 0, sizeof(*state));
    state->sock = RTE_OS_SOCKET_INVALID_HANDLE;
    state->os_sockets = ops;
    state->config = *config;
 
    status = ops->open(RTE_OS_SOCKET_TYPE_TCP, &sock);
    if (status != RTE_STATUS_OK)
    {
        return status;
    }
    state->sock = sock;
 
    /* REQ-OAL-SOCKET-002: a refused non-blocking request releases the socket. A NULL slot is accepted, open()
     * already delivers a non-blocking socket (REQ-OAL-SOCKET-001). */
    if (ops->set_nonblocking != NULL)
    {
        status = ops->set_nonblocking(sock, true);
        if (status != RTE_STATUS_OK)
        {
            (void)ops->close(sock);
            state->sock = RTE_OS_SOCKET_INVALID_HANDLE;
            return status;
        }
    }
 
    if (config->role == RTE_PROTOCOL_ROLE_LISTEN)
    {
        if (ops->bind == NULL)
        {
            (void)ops->close(sock);
            state->sock = RTE_OS_SOCKET_INVALID_HANDLE;
            return RTE_STATUS_NOT_SUPPORTED;
        }
        status = ops->bind(sock, config->host[0] != '\0' ? config->host : NULL, config->port);
        if (status != RTE_STATUS_OK)
        {
            (void)ops->close(sock);
            state->sock = RTE_OS_SOCKET_INVALID_HANDLE;
            return status;
        }
    }
    else if (config->role == RTE_PROTOCOL_ROLE_CONNECT)
    {
        if (ops->connect == NULL)
        {
            (void)ops->close(sock);
            state->sock = RTE_OS_SOCKET_INVALID_HANDLE;
            return RTE_STATUS_NOT_SUPPORTED;
        }
        status = ops->connect(sock, config->host, config->port);
        if (status == RTE_STATUS_OK)
        {
            state->is_connected = true;
        }
    }
 
    *out_handle = (rte_protocol_handle_t)(void *)state;
    return RTE_STATUS_OK;
}
 
static rte_status_t tcp_adapter_send(rte_protocol_handle_t handle, const void *data,
                                      size_t size, rte_duration_ms_t timeout_ms)
{
    rte_protocol_tcp_state_t *state = (rte_protocol_tcp_state_t *)(void *)handle;
    const rte_os_socket_ops_t *ops;
    rte_status_t status;
    uint32_t revents = 0U;
    size_t sent = 0U;
 
    if ((state == NULL) || (data == NULL) || (size == 0U))
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    if (state->sock == RTE_OS_SOCKET_INVALID_HANDLE)
    {
        return RTE_STATUS_INVALID_STATE;
    }
 
    ops = state->os_sockets;
    if ((ops == NULL) || (ops->send == NULL))
    {
        return RTE_STATUS_NOT_INITIALIZED;
    }
 
    if (ops->poll != NULL)
    {
        status = ops->poll(state->sock, RTE_OS_SOCKET_EVENT_WRITE, timeout_ms, &revents);
        if (status != RTE_STATUS_OK)
        {
            return status;
        }
        if ((revents & RTE_OS_SOCKET_EVENT_WRITE) == 0U)
        {
            return RTE_STATUS_TIMEOUT;
        }
    }
 
    return ops->send(state->sock, data, size, &sent);
}
 
static rte_status_t tcp_adapter_receive(rte_protocol_handle_t handle, void *out_buf,
                                         size_t buffer_size, rte_duration_ms_t timeout_ms)
{
    rte_protocol_tcp_state_t *state = (rte_protocol_tcp_state_t *)(void *)handle;
    const rte_os_socket_ops_t *ops;
    rte_status_t status;
    uint32_t revents = 0U;
    size_t recvd = 0U;
 
    if ((state == NULL) || (out_buf == NULL) || (buffer_size == 0U))
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    if (state->sock == RTE_OS_SOCKET_INVALID_HANDLE)
    {
        return RTE_STATUS_INVALID_STATE;
    }
 
    ops = state->os_sockets;
    if ((ops == NULL) || (ops->recv == NULL))
    {
        return RTE_STATUS_NOT_INITIALIZED;
    }
 
    if (ops->poll != NULL)
    {
        status = ops->poll(state->sock, RTE_OS_SOCKET_EVENT_READ, timeout_ms, &revents);
        if (status != RTE_STATUS_OK)
        {
            return status;
        }
        if ((revents & RTE_OS_SOCKET_EVENT_READ) == 0U)
        {
            return RTE_STATUS_TIMEOUT;
        }
    }
 
    return ops->recv(state->sock, out_buf, buffer_size, &recvd);
}
 
static rte_status_t tcp_adapter_close(rte_protocol_handle_t handle)
{
    rte_protocol_tcp_state_t *state = (rte_protocol_tcp_state_t *)(void *)handle;
    if ((state == NULL) || (state->sock == RTE_OS_SOCKET_INVALID_HANDLE))
    {
        return RTE_STATUS_OK;
    }
    if ((state->os_sockets != NULL) && (state->os_sockets->close != NULL))
    {
        (void)state->os_sockets->close(state->sock);
    }
    state->sock = RTE_OS_SOCKET_INVALID_HANDLE;
    state->is_connected = false;
    return RTE_STATUS_OK;
}
 
static const rte_protocol_adapter_ops_t s_tcp_ops = {
    tcp_adapter_open,
    tcp_adapter_send,
    tcp_adapter_receive,
    tcp_adapter_close
};
 
const rte_protocol_adapter_ops_t *rte_protocol_adapter_get_tcp(void)
{
    return &s_tcp_ops;
}