2011-04-22 14:26:36 -07:00
|
|
|
/* EINA - EFL data type library
|
|
|
|
* Copyright (C) 2011 Vincent Torri
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library 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
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library;
|
|
|
|
* if not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2011-04-24 08:54:09 -07:00
|
|
|
#ifndef EINA_LOCK_H_
|
|
|
|
#define EINA_LOCK_H_
|
2011-04-22 14:26:36 -07:00
|
|
|
|
|
|
|
#include "eina_config.h"
|
2011-05-02 04:25:35 -07:00
|
|
|
#include "eina_types.h"
|
2011-08-09 01:48:57 -07:00
|
|
|
#include "eina_error.h"
|
2011-04-22 14:26:36 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup Eina_Tools_Group Tools
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2011-08-03 12:13:18 -07:00
|
|
|
* @defgroup Eina_Lock_Group Lock
|
2011-04-22 14:26:36 -07:00
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2011-05-02 04:25:35 -07:00
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
EINA_LOCK_FAIL = EINA_FALSE,
|
|
|
|
EINA_LOCK_SUCCEED = EINA_TRUE,
|
|
|
|
EINA_LOCK_DEADLOCK
|
|
|
|
} Eina_Lock_Result;
|
|
|
|
|
2012-10-10 13:24:45 -07:00
|
|
|
#ifdef _WIN32_WCE
|
|
|
|
# include "eina_inline_lock_wince.x"
|
|
|
|
#elif defined(_WIN32)
|
|
|
|
# include "eina_inline_lock_win32.x"
|
2011-04-22 14:26:36 -07:00
|
|
|
#else
|
2012-10-10 13:24:45 -07:00
|
|
|
# include "eina_inline_lock_posix.x"
|
2011-04-22 14:26:36 -07:00
|
|
|
#endif
|
|
|
|
|
2011-08-09 01:48:57 -07:00
|
|
|
EAPI extern Eina_Error EINA_ERROR_NOT_MAIN_LOOP;
|
|
|
|
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_lock_new(_Eina_Lock *mutex) */
|
2011-05-02 06:52:34 -07:00
|
|
|
static inline Eina_Bool eina_lock_new(Eina_Lock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static void eina_lock_free(_Eina_Lock *mutex) */
|
2011-05-02 04:25:35 -07:00
|
|
|
static inline void eina_lock_free(Eina_Lock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Lock_Result eina_lock_take(_Eina_Lock *mutex) */
|
2011-05-02 04:25:35 -07:00
|
|
|
static inline Eina_Lock_Result eina_lock_take(Eina_Lock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Lock_Result eina_lock_take_try(_Eina_Lock *mutex) */
|
2011-05-02 04:25:35 -07:00
|
|
|
static inline Eina_Lock_Result eina_lock_take_try(Eina_Lock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Lock_Result eina_lock_release(_Eina_Lock *mutex) */
|
2011-05-02 04:25:35 -07:00
|
|
|
static inline Eina_Lock_Result eina_lock_release(Eina_Lock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static void eina_lock_debug(const _Eina_Lock *mutex) */
|
2011-05-04 06:53:22 -07:00
|
|
|
static inline void eina_lock_debug(const Eina_Lock *mutex);
|
2011-05-02 04:25:35 -07:00
|
|
|
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_condition_new(_Eina_Condition *cond, _Eina_Lock *mutex) */
|
2011-05-09 03:32:56 -07:00
|
|
|
static inline Eina_Bool eina_condition_new(Eina_Condition *cond, Eina_Lock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static void eina_condition_free(_Eina_Condition *cond) */
|
2011-05-09 03:32:56 -07:00
|
|
|
static inline void eina_condition_free(Eina_Condition *cond);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_condition_wait(_Eina_Condition *cond) */
|
2011-05-09 03:32:56 -07:00
|
|
|
static inline Eina_Bool eina_condition_wait(Eina_Condition *cond);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_condition_timedwait(_Eina_Condition *cond, double t) */
|
2011-05-30 08:24:06 -07:00
|
|
|
static inline Eina_Bool eina_condition_timedwait(Eina_Condition *cond, double t);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_condition_broadcast(_Eina_Condition *cond) */
|
2011-05-09 03:32:56 -07:00
|
|
|
static inline Eina_Bool eina_condition_broadcast(Eina_Condition *cond);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_condition_signal(_Eina_Condition *cond) */
|
2011-05-09 03:32:56 -07:00
|
|
|
static inline Eina_Bool eina_condition_signal(Eina_Condition *cond);
|
|
|
|
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_rwlock_new(_Eina_RWLock *mutex) */
|
2011-06-23 02:58:54 -07:00
|
|
|
static inline Eina_Bool eina_rwlock_new(Eina_RWLock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static void eina_rwlock_free(_Eina_RWLock *mutex) */
|
2011-06-23 02:58:54 -07:00
|
|
|
static inline void eina_rwlock_free(Eina_RWLock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Lock_Result eina_rwlock_take_read(_Eina_RWLock *mutex) */
|
2011-06-23 02:58:54 -07:00
|
|
|
static inline Eina_Lock_Result eina_rwlock_take_read(Eina_RWLock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Lock_Result eina_rwlock_take_write(_Eina_RWLock *mutex) */
|
2011-06-23 02:58:54 -07:00
|
|
|
static inline Eina_Lock_Result eina_rwlock_take_write(Eina_RWLock *mutex);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Lock_Result eina_rwlock_release(_Eina_RWLock *mutex) */
|
2011-06-23 02:58:54 -07:00
|
|
|
static inline Eina_Lock_Result eina_rwlock_release(Eina_RWLock *mutex);
|
|
|
|
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_tls_new(pthread_key_t *key) */
|
2011-10-16 22:06:01 -07:00
|
|
|
static inline Eina_Bool eina_tls_new(Eina_TLS *key);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static void eina_tls_free(pthread_key_t key) */
|
2011-10-16 22:06:01 -07:00
|
|
|
static inline void eina_tls_free(Eina_TLS key);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static void eina_tls_get(pthread_key_t key) */
|
2011-10-16 22:06:01 -07:00
|
|
|
static inline void *eina_tls_get(Eina_TLS key);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_tls_set(pthread_key_t key, const void *data) */
|
2011-10-16 22:06:01 -07:00
|
|
|
static inline Eina_Bool eina_tls_set(Eina_TLS key, const void *data);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_semaphore_new(sem_t *sem, int count_init) */
|
2011-12-30 05:38:53 -08:00
|
|
|
static inline Eina_Bool eina_semaphore_new(Eina_Semaphore *sem, int count_init);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_semaphore_free(sem_t *sem) */
|
2011-12-30 05:38:53 -08:00
|
|
|
static inline Eina_Bool eina_semaphore_free(Eina_Semaphore *sem);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_semaphore_lock(sem_t *sem) */
|
2011-12-30 05:38:53 -08:00
|
|
|
static inline Eina_Bool eina_semaphore_lock(Eina_Semaphore *sem);
|
2012-04-10 11:16:09 -07:00
|
|
|
/** @relates static Eina_Bool eina_semaphore_release(sem_t *sem, int count_release) */
|
2011-12-30 05:38:53 -08:00
|
|
|
static inline Eina_Bool eina_semaphore_release(Eina_Semaphore *sem, int count_release);
|
2011-10-16 22:06:01 -07:00
|
|
|
|
2011-08-09 01:48:57 -07:00
|
|
|
#ifdef EINA_HAVE_DEBUG_THREADS
|
|
|
|
# define EINA_MAIN_LOOP_CHECK_RETURN_VAL(val) \
|
|
|
|
do { \
|
2011-09-07 01:06:42 -07:00
|
|
|
if (EINA_UNLIKELY(!eina_main_loop_is())) \
|
2011-08-09 01:48:57 -07:00
|
|
|
{ \
|
|
|
|
eina_error_set(EINA_ERROR_NOT_MAIN_LOOP); \
|
|
|
|
EINA_LOG_ERR("You are calling %s from outside" \
|
|
|
|
"of the main loop threads in %s at line %i", \
|
|
|
|
__FUNCTION__, \
|
|
|
|
__FILE__, \
|
|
|
|
__LINE__); \
|
|
|
|
return val; \
|
|
|
|
} \
|
|
|
|
} while (0)
|
|
|
|
# define EINA_MAIN_LOOP_CHECK_RETURN \
|
|
|
|
do { \
|
2011-09-07 01:06:42 -07:00
|
|
|
if (EINA_UNLIKELY(!eina_main_loop_is())) \
|
2011-08-09 01:48:57 -07:00
|
|
|
{ \
|
|
|
|
eina_error_set(EINA_ERROR_NOT_MAIN_LOOP); \
|
|
|
|
EINA_LOG_ERR("You are calling %s from outside" \
|
|
|
|
"of the main loop threads in %s at line %i", \
|
|
|
|
__FUNCTION__, \
|
|
|
|
__FILE__, \
|
|
|
|
__LINE__); \
|
|
|
|
return ; \
|
|
|
|
} \
|
|
|
|
} while (0)
|
|
|
|
#else
|
2012-04-12 10:44:45 -07:00
|
|
|
/**
|
|
|
|
* @def EINA_MAIN_LOOP_CHECK_RETURN_VAL
|
|
|
|
* @brief The macro doesn't do anything unless EINA_HAVE_DEBUG_THREADS is defined.
|
|
|
|
* @param val The value to be returned.
|
|
|
|
*/
|
2011-08-09 01:48:57 -07:00
|
|
|
# define EINA_MAIN_LOOP_CHECK_RETURN_VAL(val)
|
2012-04-12 10:44:45 -07:00
|
|
|
/**
|
|
|
|
* @def EINA_MAIN_LOOP_CHECK_RETURN
|
|
|
|
* @brief The macro doesn't do anything unless EINA_HAVE_DEBUG_THREADS is defined.
|
|
|
|
*/
|
2011-08-09 01:48:57 -07:00
|
|
|
# define EINA_MAIN_LOOP_CHECK_RETURN
|
|
|
|
#endif
|
|
|
|
|
2011-04-22 14:26:36 -07:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|
|
|
|
|
|
|
|
#endif
|