X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f906123b75e746c913ebc0c9bddeac87d76f27e2..e71a2a302d28430dc1bfee906f842f5f3d0fa3ce:/include/xbt/synchro.h diff --git a/include/xbt/synchro.h b/include/xbt/synchro.h index 265f5b8a66..62f34ec19f 100644 --- a/include/xbt/synchro.h +++ b/include/xbt/synchro.h @@ -1,76 +1,117 @@ -/* $Id$ */ +/* xbt/synchro.h -- Simulated synchronization */ -/* xbt/synchro.h -- Synchronization tools */ -/* Usable in simulator, (or in real life when mixing with GRAS) */ - -/* Copyright (c) 2007 Martin Quinson. All rights reserved. */ +/* Copyright (c) 2009-2021. The SimGrid Team. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ +#ifndef XBT_SYNCHRO_H +#define XBT_SYNCHRO_H -#ifndef _XBT_THREAD_H -#define _XBT_THREAD_H +#include "simgrid/cond.h" +#include "simgrid/mutex.h" +#include /* SG_BEGIN_DECL */ -#include "xbt/misc.h" /* SG_BEGIN_DECL */ -#include "xbt/function_types.h" +#warning xbt/synchro.h is deprecated and will be removed in v3.28. -SG_BEGIN_DECL() +SG_BEGIN_DECL /** @addtogroup XBT_synchro * @brief XBT synchronization tools - * - * This section describes the XBT synchronization tools. It defines types and - * functions very close to the pthread API, but widly usable. When used from - * the simulator, you will lock simulated processes as expected. When used - * from GRAS programs compiled for in-situ execution, you have synchronization - * mecanism portable to windows and UNIX. Nice, isn't it? - * + * + * This section describes the simulated synchronization mechanisms, + * that you can use in your simulation without deadlocks. See @ref + * faq_MIA_thread_synchronization for details. + * * @{ */ - /** \brief Thread data type (opaque structure) */ - typedef struct s_xbt_thread_ *xbt_thread_t; - - XBT_PUBLIC(xbt_thread_t) xbt_thread_create(const char *name, void_fp_pvoid_t start_routine,void* param); - XBT_PUBLIC(void) xbt_thread_exit(); - XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void); - XBT_PUBLIC(const char*) xbt_thread_name(xbt_thread_t t); - XBT_PUBLIC(const char*) xbt_thread_self_name(void); - /* xbt_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */ - XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread); - /* Ends the life of the poor victim (not always working if it's computing, but working if it's blocked in the OS) */ - XBT_PUBLIC(void) xbt_thread_cancel(xbt_thread_t thread); - /* suicide */ - XBT_PUBLIC(void) xbt_thread_exit(void); - /* current thread pass control to any possible thread wanting it */ - XBT_PUBLIC(void) xbt_thread_yield(void); - - - /** \brief Thread mutex data type (opaque structure) */ - typedef struct s_xbt_mutex_ *xbt_mutex_t; - - XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void); - XBT_PUBLIC(void) xbt_mutex_lock(xbt_mutex_t mutex); - XBT_PUBLIC(void) xbt_mutex_unlock(xbt_mutex_t mutex); - XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex); - - - /** \brief Thread condition data type (opaque structure) */ - typedef struct s_xbt_cond_ *xbt_cond_t; - - XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void); - XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, - xbt_mutex_t mutex); - XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond, - xbt_mutex_t mutex, - double delay); - XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond); - XBT_PUBLIC(void) xbt_cond_broadcast(xbt_cond_t cond); - XBT_PUBLIC(void) xbt_cond_destroy(xbt_cond_t cond); +/** @brief Thread mutex data type (opaque object) + * @hideinitializer + */ +typedef sg_mutex_t xbt_mutex_t; + +/** @brief Creates a new mutex variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_init") static inline xbt_mutex_t xbt_mutex_init(void) +{ + return sg_mutex_init(); +} + +/** @brief Blocks onto the given mutex variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_lock") static inline void xbt_mutex_acquire(xbt_mutex_t mutex) +{ + sg_mutex_lock(mutex); +} + +/** @brief Tries to block onto the given mutex variable + * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0. + * This function does not block and wait for the mutex to be unlocked. + * @param mutex The mutex + * @return 1 - mutex free, 0 - mutex used + */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_try_lock") static inline int xbt_mutex_try_acquire(xbt_mutex_t mutex) +{ + return sg_mutex_try_lock(mutex); +} + +/** @brief Releases the given mutex variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_unlock") static inline void xbt_mutex_release(xbt_mutex_t mutex) +{ + sg_mutex_unlock(mutex); +} + +/** @brief Destroys the given mutex variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_destroy") static inline void xbt_mutex_destroy(xbt_mutex_t mutex) +{ + sg_mutex_destroy(mutex); +} + +/** @brief Thread condition data type (opaque object) + * @hideinitializer + */ +typedef sg_cond_t xbt_cond_t; + +/** @brief Creates a condition variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_init") static inline xbt_cond_t xbt_cond_init(void) +{ + return sg_cond_init(); +} + +/** @brief Blocks onto the given condition variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_wait") static inline void xbt_cond_wait(xbt_cond_t cond, + xbt_mutex_t mutex) +{ + sg_cond_wait(cond, mutex); +} + +/** @brief Blocks onto the given condition variable, but only for the given amount of time. + * @return 0 on success, 1 on timeout */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_wait_for") static inline int xbt_cond_timedwait(xbt_cond_t cond, + xbt_mutex_t mutex, + double delay) +{ + return sg_cond_wait_for(cond, mutex, delay); +} + +/** @brief Signals the given mutex variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_notify_one") static inline void xbt_cond_signal(xbt_cond_t cond) +{ + sg_cond_notify_one(cond); +} + +/** @brief Broadcasts the given mutex variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_notify_all") static inline void xbt_cond_broadcast(xbt_cond_t cond) +{ + sg_cond_notify_all(cond); +} + +/** @brief Destroys the given mutex variable */ +XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_destroy") static inline void xbt_cond_destroy(xbt_cond_t cond) +{ + sg_cond_destroy(cond); +} /** @} */ -SG_END_DECL() - -#endif /* _XBT_THREAD_H */ +SG_END_DECL +#endif /* XBT_SYNCHRO_H */