3 /* xbt/synchro.h -- Synchronization tools */
4 /* Usable in simulator, (or in real life when mixing with GRAS) */
6 /* Copyright (c) 2007 Martin Quinson. All rights reserved. */
8 /* This program is free software; you can redistribute it and/or modify it
9 * under the terms of the license (GNU LGPL) which comes with this package. */
15 #include "xbt/misc.h" /* SG_BEGIN_DECL */
16 #include "xbt/function_types.h"
20 /** @addtogroup XBT_synchro
21 * @brief XBT synchronization tools
23 * This section describes the XBT synchronization tools. It defines types and
24 * functions very close to the pthread API, but widly usable. When used from
25 * the simulator, you will lock simulated processes as expected. When used
26 * from GRAS programs compiled for in-situ execution, you have synchronization
27 * mecanism portable to windows and UNIX. Nice, isn't it?
32 /** \brief Thread data type (opaque structure) */
33 typedef struct s_xbt_thread_ *xbt_thread_t;
35 XBT_PUBLIC(xbt_thread_t) xbt_thread_create(const char *name, void_f_pvoid_t start_routine,void* param);
36 XBT_PUBLIC(void) xbt_thread_exit();
37 XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void);
38 XBT_PUBLIC(const char*) xbt_thread_name(xbt_thread_t t);
39 XBT_PUBLIC(const char*) xbt_thread_self_name(void);
40 /* xbt_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
41 XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread);
42 /* Ends the life of the poor victim (not always working if it's computing, but working if it's blocked in the OS) */
43 XBT_PUBLIC(void) xbt_thread_cancel(xbt_thread_t thread);
45 XBT_PUBLIC(void) xbt_thread_exit(void);
46 /* current thread pass control to any possible thread wanting it */
47 XBT_PUBLIC(void) xbt_thread_yield(void);
50 /** \brief Thread mutex data type (opaque structure) */
51 typedef struct s_xbt_mutex_ *xbt_mutex_t;
53 XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
54 XBT_PUBLIC(void) xbt_mutex_lock(xbt_mutex_t mutex);
55 XBT_PUBLIC(void) xbt_mutex_unlock(xbt_mutex_t mutex);
56 XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex);
59 /** \brief Thread condition data type (opaque structure) */
60 typedef struct s_xbt_cond_ *xbt_cond_t;
62 XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
63 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond,
65 XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond,
68 XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond);
69 XBT_PUBLIC(void) xbt_cond_broadcast(xbt_cond_t cond);
70 XBT_PUBLIC(void) xbt_cond_destroy(xbt_cond_t cond);
76 #endif /* _XBT_THREAD_H */