ab_gp_cycle_ticks.c

Go to the documentation of this file.

#include "ab_gp_cycle_ticks.h"
 
#include <stddef.h>
 
rte_status_t ab_gp_cycle_ticks_setup(ab_gp_cycle_ticks_t *ticks)
{
    rte_status_t status;
 
    if (ticks == NULL)
    {
        status = RTE_STATUS_INVALID_PARAM;
    }
    else
    {
        ticks->handle = NULL;
        ticks->count = 0U;
        status = rte_mutex_create(&ticks->storage, &ticks->handle);
        if (status != RTE_STATUS_OK)
        {
            ticks->handle = NULL;
        }
    }
    return status;
}
 
rte_status_t ab_gp_cycle_ticks_post(ab_gp_cycle_ticks_t *ticks)
{
    rte_status_t status;
 
    if (ticks == NULL)
    {
        status = RTE_STATUS_INVALID_PARAM;
    }
    else if (ticks->handle == NULL)
    {
        status = RTE_STATUS_INVALID_STATE;
    }
    else
    {
        status = rte_mutex_lock_timed(ticks->handle, (rte_duration_ms_t)AB_GP_CYCLE_TICKS_LOCK_TIMEOUT_MS);
        if (status == RTE_STATUS_OK)
        {
            if (ticks->count < UINT32_MAX)
            {
                ticks->count++;
            }
            status = rte_mutex_unlock(ticks->handle);
        }
    }
    return status;
}
 
rte_status_t ab_gp_cycle_ticks_take(ab_gp_cycle_ticks_t *ticks, uint32_t *out_pending)
{
    rte_status_t status;
 
    if ((ticks == NULL) || (out_pending == NULL))
    {
        status = RTE_STATUS_INVALID_PARAM;
    }
    else if (ticks->handle == NULL)
    {
        status = RTE_STATUS_INVALID_STATE;
    }
    else
    {
        status = rte_mutex_lock_timed(ticks->handle, (rte_duration_ms_t)AB_GP_CYCLE_TICKS_LOCK_TIMEOUT_MS);
        if (status == RTE_STATUS_OK)
        {
            /* Read and clear under one lock hold: a tick posted in between cannot exist. */
            *out_pending = ticks->count;
            ticks->count = 0U;
            status = rte_mutex_unlock(ticks->handle);
        }
    }
    return status;
}
 
rte_status_t ab_gp_cycle_ticks_teardown(ab_gp_cycle_ticks_t *ticks)
{
    rte_status_t status;
 
    if (ticks == NULL)
    {
        status = RTE_STATUS_INVALID_PARAM;
    }
    else if (ticks->handle == NULL)
    {
        status = RTE_STATUS_INVALID_STATE;
    }
    else
    {
        status = rte_mutex_destroy(ticks->handle);
        ticks->handle = NULL;
    }
    return status;
}