doubango/tinySAK/src/tsk_condwait.c
c732d49e
 #if HAVE_CRT
 #define _CRTDBG_MAP_ALLOC 
 #include <stdlib.h> 
 #include <crtdbg.h>
 #endif //HAVE_CRT
 /*
 * Copyright (C) 2017, University of the Basque Country (UPV/EHU)
 * Contact for licensing options: <licensing-mcpttclient(at)mcopenplatform(dot)com>
 *
 * The original file was part of Open Source Doubango Framework
 * Copyright (C) 2010-2011 Mamadou Diop.
 * Copyright (C) 2012 Doubango Telecom <http://doubango.org>
 *
 * This file is part of Open Source Doubango Framework.
 *
 * DOUBANGO is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * DOUBANGO is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with DOUBANGO.
 *
 */
 
 
 /**@file tsk_condwait.c
  * @brief Pthread/Windows functions for waiting an signaling on condition variables.
  *
  * @author Mamadou Diop <diopmamadou(at)doubango[dot]org>
  *
 
  */
 
 #include "tsk_condwait.h"
 #include "tsk_memory.h"
 #include "tsk_debug.h"
 #include "tsk_time.h"
 #include <time.h>
 
 #if TSK_UNDER_WINDOWS
 #	include <windows.h>
 #	include "tsk_errno.h"
 #	define CONDWAIT_S void
 	typedef HANDLE	CONDWAIT_T;
 #	define TIMED_OUT	WAIT_TIMEOUT
 #else
 #	include <sys/time.h>
 #	include <pthread.h>
 #	define CONDWAIT_S pthread_cond_t
 	typedef CONDWAIT_S* CONDWAIT_T;
 #	define TIMED_OUT	ETIMEDOUT
 #endif
 
 #if defined(__GNUC__) || defined (__SYMBIAN32__)
 #	include <errno.h>
 #endif
 
 /**@defgroup tsk_condwait_group Pthread/Windows functions for waiting and signaling on condition variables (conwait).
 * @code
 * tsk_condwait_handle_t *condwait = tsk_condwait_create();
 * @endcode
 *
 * In thread-1:
 * @code
 * // Bock the current thread until the condition is opened or until 1000ms have passed.
 * int ret = tsk_condwait_timedwait(condwait, 1000);
 * @endcode
 *
 * In thread-2:
 * @code
 * // Wakes up
 * int ret = tsk_condwait_signal(condwait);
 * // or tsk_condwait_broadcast(condwait)
 * @endcode
 *
 * To free the condwait object:
 * @code
 * tsk_condwait_destroy(&condwait);
 * @endcode
 */
 
 /**@ingroup tsk_condwait_group
 * Represents both PThread an Windows condwait object.
 */
 typedef struct tsk_condwait_s
 {
 	CONDWAIT_T pcond; /**< Pthread handle pointing to the internal condwait object. */
 #if !TSK_UNDER_WINDOWS
 	tsk_mutex_handle_t* mutex;  /**< Locker. */
 #endif
 }
 tsk_condwait_t;
 
 /**@ingroup tsk_condwait_group
 * Creates new conwait handle. You MUST call @ref tsk_condwait_destroy to free the handle.
 * @retval New condwait handle.
 * @sa @ref tsk_condwait_destroy.
 */
 tsk_condwait_handle_t* tsk_condwait_create()
 {
 	#if HAVE_CRT //Debug memory
 	tsk_condwait_t *condwait = (tsk_condwait_t*)calloc(1, sizeof(tsk_condwait_t));
 		
 	#else
 	tsk_condwait_t *condwait = (tsk_condwait_t*)tsk_calloc(1, sizeof(tsk_condwait_t));
 		
 	#endif //HAVE_CRT
 
 	if(condwait)
 	{
 #if TSK_UNDER_WINDOWS
 #	if TSK_UNDER_WINDOWS_RT
 		condwait->pcond = CreateEventEx(NULL, NULL, CREATE_EVENT_MANUAL_RESET, EVENT_ALL_ACCESS);
 	#else
 		condwait->pcond = CreateEvent(NULL, TRUE, FALSE, NULL);
 #	endif
 		if(!condwait->pcond)
 		{
 			TSK_FREE(condwait);
 		}
 #else
 		#if HAVE_CRT //Debug memory
 		condwait->pcond = (CONDWAIT_T)calloc(1, sizeof(CONDWAIT_S));
 		
 	#else
 		condwait->pcond = (CONDWAIT_T)tsk_calloc(1, sizeof(CONDWAIT_S));
 		
 	#endif //HAVE_CRT
 		if(pthread_cond_init(condwait->pcond, 0))
 		{
 			TSK_DEBUG_ERROR("Failed to initialize the new conwait.");
 		}
 
 		if(!(condwait->mutex = tsk_mutex_create()))
 		{
 			pthread_cond_destroy(condwait->pcond);
 
 			TSK_FREE(condwait);
 			TSK_DEBUG_ERROR("Failed to initialize the internal mutex.");
 		}
 #endif
 	}
 
 	if(!condwait)
 	{
 		TSK_DEBUG_ERROR("Failed to create new conwait.");
 	}
 	return condwait;
 }
 
 /**@ingroup tsk_condwait_group
 * Block the current thread until the condition is opened. 
 * @param handle CondWait handle created using @ref tsk_condwait_create.
 * @retval Zero if succeed and non-zero otherwise.
 * @sa @ref tsk_condwait_timedwait.
 */
 int tsk_condwait_wait(tsk_condwait_handle_t* handle)
 {
 	int ret = EINVAL;
 	tsk_condwait_t *condwait = (tsk_condwait_t*)handle;
 	if(!condwait){
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 
 #if TSK_UNDER_WINDOWS
 #	if TSK_UNDER_WINDOWS_RT
 	if((ret = (WaitForSingleObjectEx(condwait->pcond, INFINITE, TRUE) == WAIT_FAILED) ? -1 : 0)){
 #	else
 	if((ret = (WaitForSingleObject(condwait->pcond, INFINITE) == WAIT_FAILED) ? -1 : 0)){
 #endif
 		TSK_DEBUG_ERROR("WaitForSingleObject function failed: %d", ret);
 	}
 #else
 	if(condwait && condwait->mutex){
 		tsk_mutex_lock(condwait->mutex);
 		if((ret = pthread_cond_wait(condwait->pcond, (pthread_mutex_t*)condwait->mutex)))
 		{
 			TSK_DEBUG_ERROR("pthread_cond_wait function failed: %d", ret);
 		}
 		tsk_mutex_unlock(condwait->mutex);
 	}
 #endif
 	return ret;
 }
 
 /**@ingroup tsk_condwait_group
 * Block the current thread until the condition is opened or until @a ms milliseconds have passed. 
 * @param handle condwait handle created using @ref tsk_condwait_create.
 * @param ms The number of milliseconds to wait for a given condition.
 * @retval Zero if succeed and non-zero error code otherwise.
 * @sa @ref tsk_condwait_wait.
 */
 int tsk_condwait_timedwait(tsk_condwait_handle_t* handle, uint64_t ms)
 {
 #if TSK_UNDER_WINDOWS
 	DWORD ret = WAIT_FAILED;
 #else
 	int ret = EINVAL;
 #endif
 	tsk_condwait_t *condwait = (tsk_condwait_t*)handle;
 
 #if TSK_UNDER_WINDOWS
 #	   if TSK_UNDER_WINDOWS_RT
 	   if((ret = WaitForSingleObjectEx(condwait->pcond, (DWORD)ms, TRUE)) != WAIT_OBJECT_0){
 #	   else
 	   if((ret = WaitForSingleObject(condwait->pcond, (DWORD)ms)) != WAIT_OBJECT_0){
 #endif
 		if(ret == TIMED_OUT){
 			/* TSK_DEBUG_INFO("WaitForSingleObject function timedout: %d", ret); */
 		}
 		else{
 			TSK_DEBUG_ERROR("WaitForSingleObject function failed: %d", ret);
 		}
 		return ((ret == TIMED_OUT) ? 0 : ret);
 	}
 #else
 	if(condwait && condwait->mutex){
 		struct timespec   ts = {0, 0};
 		struct timeval    tv = {0, 0};
 		/*int rc =*/  tsk_gettimeofday(&tv, 0);
 
 		ts.tv_sec  = ( tv.tv_sec + ((long)ms/1000) );
 		ts.tv_nsec += ( (tv.tv_usec * 1000) + ((long)ms % 1000 * 1000000) );
 		if(ts.tv_nsec > 999999999) ts.tv_sec+=1, ts.tv_nsec = ts.tv_nsec % 1000000000;
 		
 		tsk_mutex_lock(condwait->mutex);
 		if((ret = pthread_cond_timedwait(condwait->pcond, (pthread_mutex_t*)condwait->mutex, &ts))){
 			if(ret == TIMED_OUT){
 				/* TSK_DEBUG_INFO("pthread_cond_timedwait function timedout: %d", ret); */
 			}
 			else{
 				TSK_DEBUG_ERROR("pthread_cond_timedwait function failed: %d", ret);
 			}
 		}
 
 		tsk_mutex_unlock(condwait->mutex);
 
 		return ((ret == TIMED_OUT) ? 0 : ret);
 	}
 #endif
 
 	return ret;
 }
 
 /**@ingroup tsk_condwait_group
 * Wakes up at least one thread that is currently waiting.
 * @param handle CondWait handle created using @ref tsk_condwait_create.
 * @retval Zero if succeed and non-zero otherwise.
 * @sa @ref tsk_condwait_broadcast.
 */
 int tsk_condwait_signal(tsk_condwait_handle_t* handle)
 {
 	int ret = EINVAL;
 	tsk_condwait_t *condwait = (tsk_condwait_t*)handle;
 	if(!condwait){
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 
 #if TSK_UNDER_WINDOWS
 	if(ret = ((SetEvent(condwait->pcond) && ResetEvent(condwait->pcond)) ? 0 : -1)){
 		ret = GetLastError();
 		TSK_DEBUG_ERROR("SetEvent/ResetEvent function failed: %d", ret);
 	}
 #else
 	if(condwait && condwait->mutex){
 		tsk_mutex_lock(condwait->mutex);
 
 		if((ret = pthread_cond_signal(condwait->pcond))){
 			TSK_DEBUG_ERROR("pthread_cond_signal function failed: %d", ret);
 		}
 		tsk_mutex_unlock(condwait->mutex);
 	}
 #endif
 	return ret;
 }
 
 
 /**@ingroup tsk_condwait_group
 * Wakes up all threads that are currently waiting for the condition.
 * @param handle CondWait handle created using @ref tsk_condwait_create.
 * @retval Zero if succeed and non-zero otherwise.
 * @sa @ref tsk_condwait_signal.
 */
 int tsk_condwait_broadcast(tsk_condwait_handle_t* handle)
 {
 	int ret = EINVAL;
 	tsk_condwait_t *condwait = (tsk_condwait_t*)handle;
 	if(!condwait){
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 
 #if TSK_UNDER_WINDOWS
 	if(ret = ((SetEvent(condwait->pcond) && ResetEvent(condwait->pcond)) ? 0 : -1)){
 		ret = GetLastError();
 		TSK_DEBUG_ERROR("SetEvent function failed: %d", ret);
 	}
 #else
 	if(condwait && condwait->mutex){
 		tsk_mutex_lock(condwait->mutex);
 		if((ret = pthread_cond_broadcast(condwait->pcond))){
 			TSK_DEBUG_ERROR("pthread_cond_broadcast function failed: %d", ret);
 		}
 		tsk_mutex_unlock(condwait->mutex);
 	}
 #endif
 
 	return ret;
 }
 
 /**@ingroup tsk_condwait_group
 * Safely free a condwait variable previously created using @ref tsk_condwait_create.
 * @param handle The condwait handle to free.
 * @sa @ref tsk_condwait_create
 */
 void tsk_condwait_destroy(tsk_condwait_handle_t** handle)
 {
 	tsk_condwait_t **condwait = (tsk_condwait_t**)handle;
 	
 	if(condwait && *condwait){
 #if TSK_UNDER_WINDOWS
 		CloseHandle((*condwait)->pcond);
 #else
 		tsk_mutex_destroy(&((*condwait)->mutex));
 		pthread_cond_destroy((*condwait)->pcond);
 		TSK_FREE((*condwait)->pcond);
 #endif
 		tsk_free((void**)condwait);
 	}
 	else{
 		TSK_DEBUG_WARN("Cannot free an uninitialized condwait object");
 	}
 }