// Copyright(c) 2017-2020, Intel Corporation

//

// 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.

#ifdef HAVE_CONFIG_H

#include <config.h>

#endif // HAVE_CONFIG_H

#include "common_int.h"

#include <sys/mman.h>

#include <stdio.h>

#include <stdarg.h>

#include <stdlib.h>

/*

 * Check properties object for validity and lock its mutex

 * If prop_check_and_lock() returns FPGA_OK, assume the mutex to be locked.

 */

fpga_result prop_check_and_lock(struct _fpga_properties *prop)

{

	ASSERT_NOT_NULL(prop);

	if (pthread_mutex_lock(&prop->lock)) {

		OPAE_MSG("Failed to lock mutex");

		return FPGA_EXCEPTION;

	}

	if (prop->magic != FPGA_PROPERTY_MAGIC) {

		OPAE_MSG("Invalid properties object");

		int err = pthread_mutex_unlock(&prop->lock);

		if (err) {

			OPAE_ERR("pthread_mutex_unlock() failed: %S",

				 strerror(err));

		}

		return FPGA_INVALID_PARAM;

	}

	return FPGA_OK;

}

/*

 * Check handle object for validity and lock its mutex

 * If handle_check_and_lock() returns FPGA_OK, assume the mutex to be locked.

 */

fpga_result handle_check_and_lock(struct _fpga_handle *handle)

{

	ASSERT_NOT_NULL(handle);

	if (pthread_mutex_lock(&handle->lock)) {

		OPAE_MSG("Failed to lock mutex");

		return FPGA_EXCEPTION;

	}

	if (handle->magic != FPGA_HANDLE_MAGIC) {

		OPAE_MSG("Invalid handle object");

		int err = pthread_mutex_unlock(&handle->lock);

		if (err) {

			OPAE_ERR("pthread_mutex_unlock() failed: %S",

				 strerror(err));

		}

		return FPGA_INVALID_PARAM;

	}

	return FPGA_OK;

}

/*

 * Check event handle object for validity and lock its mutex

 * If event_handle_check_and_lock() returns FPGA_OK, assume the mutex to be

 * locked.

 */

fpga_result event_handle_check_and_lock(struct _fpga_event_handle *eh)

{

	ASSERT_NOT_NULL(eh);

	if (pthread_mutex_lock(&eh->lock)) {

		OPAE_MSG("Failed to lock mutex");

		return FPGA_EXCEPTION;

	}

	if (eh->magic != FPGA_EVENT_HANDLE_MAGIC) {

		OPAE_MSG("Invalid event handle object");

		int err = pthread_mutex_unlock(&eh->lock);

		if (err) {

			OPAE_ERR("pthread_mutex_unlock() failed: %S",

				 strerror(err));

		}

		return FPGA_INVALID_PARAM;

	}

	return FPGA_OK;

}

/* mutex to protect global data structures */

pthread_mutex_t global_lock = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;

const char __XFPGA_API__ *xfpga_fpgaErrStr(fpga_result e)

{

	switch (e) {

	case FPGA_OK:

		return "success";

	case FPGA_INVALID_PARAM:

		return "invalid parameter";

	case FPGA_BUSY:

		return "resource busy";

	case FPGA_EXCEPTION:

		return "exception";

	case FPGA_NOT_FOUND:

		return "not found";

	case FPGA_NO_MEMORY:

		return "no memory";

	case FPGA_NOT_SUPPORTED:

		return "not supported";

	case FPGA_NO_DRIVER:

		return "no driver available";

	case FPGA_NO_DAEMON:

		return "no fpga daemon running";

	case FPGA_NO_ACCESS:

		return "insufficient privileges";

	case FPGA_RECONF_ERROR:

		return "reconfiguration error";

	default:

		return "unknown error";

	}

}

/**

 * @brief Generate unique workspace ID number

 *

 * @return id identifier

 */

uint64_t wsid_gen(void)

{

	static uint64_t ctr;

	uint64_t id = __sync_fetch_and_add(&ctr, 1);

	id ^= ((unsigned long) getpid() % 16777216) << 40;

	return id;

}