rte_ipc.c

Go to the documentation of this file.

#include "rte/oal/ipc/rte_ipc.h"
#include "rte/utils/lifecycle/rte_lifecycle.h"
#include "rte_osadapter/ipc/rte_osadapter_ipc.h"



static const rte_osadapter_ipc_t *s_osadapter = NULL;


 

rte_status_t rte_osadapter_ipc_register(const rte_osadapter_ipc_t *osadapter)
{
    rte_status_t lifecycle_status;
 
    if (osadapter == NULL)
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    /* REQ-LIFECYCLE-001 (ADR-026): registering an OSAdapter is a setup-only
     * action - refuse once the application's setup phase has been locked. */
    lifecycle_status = rte_lifecycle_check_setup_allowed();
    if (lifecycle_status != RTE_STATUS_OK)
    {
        return lifecycle_status;
    }
    s_osadapter = osadapter;
    return RTE_STATUS_OK;
}
 
rte_status_t rte_ipc_create(rte_ipc_storage_t *storage,
                               const rte_ipc_config_t *config,
                               rte_ipc_handle_t *out_handle)
{
    if ((storage == NULL) || (config == NULL) || (out_handle == NULL))
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    if ((config->message_size == 0U) || (config->queue_depth == 0U))
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    *out_handle = NULL;
    /* REQ-LIFECYCLE-001/003 (ADR-026, OSA rules): setup-only - refused and reported once the setup phase is locked. */
    {
        rte_status_t lifecycle_status = rte_lifecycle_check_setup_allowed();
 
        if (lifecycle_status != RTE_STATUS_OK)
        {
            return lifecycle_status;
        }
    }
    if (s_osadapter == NULL)
    {
        return RTE_STATUS_NOT_INITIALIZED;
    }
    if (s_osadapter->create == NULL)
    {
        return RTE_STATUS_NOT_SUPPORTED;
    }
    return s_osadapter->create(storage, config, out_handle);
}
 
rte_status_t rte_ipc_send(rte_ipc_handle_t handle,
                             const void *message,
                             size_t message_size,
                             rte_duration_ms_t timeout_ms)
{
    if ((handle == NULL) || (message == NULL) || (message_size == 0U))
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    if (s_osadapter == NULL)
    {
        return RTE_STATUS_NOT_INITIALIZED;
    }
    if (s_osadapter->send == NULL)
    {
        return RTE_STATUS_NOT_SUPPORTED;
    }
    return s_osadapter->send(handle, message, message_size, timeout_ms);
}
 
rte_status_t rte_ipc_receive(rte_ipc_handle_t handle,
                                void *out_message,
                                size_t buffer_size,
                                rte_duration_ms_t timeout_ms)
{
    if ((handle == NULL) || (out_message == NULL) || (buffer_size == 0U))
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    if (s_osadapter == NULL)
    {
        return RTE_STATUS_NOT_INITIALIZED;
    }
    if (s_osadapter->receive == NULL)
    {
        return RTE_STATUS_NOT_SUPPORTED;
    }
    return s_osadapter->receive(handle, out_message, buffer_size, timeout_ms);
}
 
rte_status_t rte_ipc_destroy(rte_ipc_handle_t handle)
{
    if (handle == NULL)
    {
        return RTE_STATUS_INVALID_PARAM;
    }
    if (s_osadapter == NULL)
    {
        return RTE_STATUS_NOT_INITIALIZED;
    }
    if (s_osadapter->destroy == NULL)
    {
        return RTE_STATUS_NOT_SUPPORTED;
    }
    return s_osadapter->destroy(handle);
}