/**
 * @file OsalMutex.c (user space)
 *
 * @brief Implementation for Mutexes.
 *
 *
 * @par
 *   BSD LICENSE
 * 
 *   Copyright(c) 2007-2023 Intel Corporation. All rights reserved.
 *   All rights reserved.
 * 
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 * 
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 * 
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 *  version: QAT20.L.1.2.30-00078
 */

#include <time.h>
#include "Osal.h"

OSAL_PUBLIC OSAL_STATUS osalMutexInit(OsalMutex *mutex)
{
#ifndef ICP_WITHOUT_THREAD
    pthread_mutex_t *pMutex;
    if (NULL == mutex)
    {
        osalLog(OSAL_LOG_LVL_ERROR,
                OSAL_LOG_DEV_STDOUT,
                "OsalMutexInit: NULL Mutex handle \n");

        return OSAL_FAIL;
    }

    pMutex = (pthread_mutex_t *)osalMemAlloc(sizeof(pthread_mutex_t));

    if (!(pMutex))
    {
        osalLog(OSAL_LOG_LVL_ERROR,
                OSAL_LOG_DEV_STDOUT,
                "OsalMutexInit: fail to allocate for Mutex \n");

        return OSAL_FAIL;
    }

    if (pthread_mutex_init(pMutex, NULL) != 0)
    {
        osalLog(OSAL_LOG_LVL_ERROR,
                OSAL_LOG_DEV_STDOUT,
                "OsalMutexInit: mutex init failed\n");

        /* free the allocated pthread_mutex_t structure */
        osalMemFree((void *)pMutex);
        return OSAL_FAIL;
    }
    *mutex = pMutex;
#else
    *mutex = osalMemAlloc(sizeof(OsalMutex));
#endif
    return OSAL_SUCCESS;
}

/*
 * timeout expressed in milliseconds.
 */
OSAL_PUBLIC OSAL_STATUS osalMutexLock(OsalMutex *mutex, INT32 timeout)
{
#ifndef ICP_WITHOUT_THREAD
    OSAL_STATUS status;
    OsalTimeval timeoutVal;
    OsalTimeval currTime;
    struct timespec tspec;

    OSAL_PTR_ENSURE(mutex, "osalMutexLock():   Null mutex pointer", OSAL_FAIL);

    if ((timeout < 0) && (timeout != OSAL_WAIT_FOREVER))
    {
        osalLog(OSAL_LOG_LVL_ERROR,
                OSAL_LOG_DEV_STDOUT,
                "OsalMutexLock(): illegal timeout value \n");

        return OSAL_FAIL;
    }

    if (timeout == OSAL_WAIT_NONE)
    {
        status = pthread_mutex_trylock(*mutex);
        if (status)
        {
            osalLog(OSAL_LOG_LVL_ERROR,
                    OSAL_LOG_DEV_STDOUT,
                    "OsalMutexLock(): Failed to Lock Mutex \n");

            return OSAL_FAIL;
        }
    }
    else if (timeout == OSAL_WAIT_FOREVER)
    {
        status = pthread_mutex_lock(*mutex);
        if (status)
        {
            osalLog(OSAL_LOG_LVL_ERROR,
                    OSAL_LOG_DEV_STDOUT,
                    "OsalMutexLock(): Failed to Lock Mutex \n");

            return OSAL_FAIL;
        }
    }
    else /* Finite Timeout case */
    {
        /*
         * Convert the inputted time into appropriate timespec struct.
         * Since timespec and OSAL timeval are of the the same type.
         * Reuse the timeval to timespec macros.
         */
        OSAL_MS_TO_TIMEVAL(timeout, &timeoutVal);

        /* Get the current timestamp */
        if (OSAL_SUCCESS != osalTimeGet(&currTime))
        {
            return OSAL_FAIL;
        }

        /* Add this to the timeout so that it gives absolute
         * timeout value... */
        OSAL_TIME_ADD(timeoutVal, currTime);
        /* ...and assign it to the timespec structure */
        tspec.tv_sec = timeoutVal.secs;
        tspec.tv_nsec = timeoutVal.nsecs;
        status = pthread_mutex_timedlock(*mutex, &tspec);

        if (status)
        {
            osalLog(OSAL_LOG_LVL_ERROR,
                    OSAL_LOG_DEV_STDOUT,
                    "OsalMutexLock(): Failed to Lock Mutex \n");

            return OSAL_FAIL;
        }
    }
#endif
    return OSAL_SUCCESS;
}

OSAL_PUBLIC OSAL_STATUS osalMutexUnlock(OsalMutex *mutex)
{
#ifndef ICP_WITHOUT_THREAD
    OSAL_STATUS status;

    OSAL_PTR_ENSURE(
        mutex, "osalMutexUnlock():   Null mutex pointer", OSAL_FAIL);

    status = pthread_mutex_unlock(*mutex);
    if (status)
    {
        osalLog(OSAL_LOG_LVL_ERROR,
                OSAL_LOG_DEV_STDOUT,
                "OsalMutexUnlock(): Failed to Unlock Mutex \n");

        return OSAL_FAIL;
    }
#endif
    return OSAL_SUCCESS;
}

OSAL_PUBLIC OSAL_STATUS osalMutexDestroy(OsalMutex *mutex)
{
#ifndef ICP_WITHOUT_THREAD
    OSAL_STATUS status;

    OSAL_PTR_ENSURE(
        mutex, "osalMutexDestroy():   Null mutex pointer", OSAL_FAIL);

    status = pthread_mutex_destroy(*mutex);
    if (!status)
    {
        /* free the associated mutex structure */
        osalMemFree((void *)*mutex);
        *mutex = NULL;
    }
    else
    {
        osalLog(OSAL_LOG_LVL_ERROR,
                OSAL_LOG_DEV_STDOUT,
                "OsalMutexDestroy(): Failed to Destroy Mutex \n");
    }
    return (status ? OSAL_FAIL : OSAL_SUCCESS);
#else
    osalMemFree((void *)*mutex);
    return OSAL_SUCCESS;
#endif
}
