1 /* xbt/synchro.h -- Synchronization tools */
2 /* Usable in simulator, (or in real life when mixing with GRAS) */
4 /* Copyright (c) 2009, 2010. The SimGrid Team.
5 * All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
10 /* splited away from synchro.h since we areused by dynar.h, and synchro.h uses dynar */
16 #include "xbt/misc.h" /* SG_BEGIN_DECL */
17 #include "xbt/function_types.h"
21 /** @addtogroup XBT_synchro
22 * @brief XBT synchronization tools
24 * This section describes the XBT synchronization tools. It defines types and
25 * functions very close to the pthread API, but widly usable. When used from
26 * the simulator, you will lock simulated processes as expected. When used
27 * from GRAS programs compiled for in-situ execution, you have synchronization
28 * 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,
36 void_f_pvoid_t start_routine,
37 void *param,int joinable);
38 XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void);
39 XBT_PUBLIC(const char *) xbt_thread_name(xbt_thread_t t);
40 XBT_PUBLIC(const char *) xbt_thread_self_name(void);
41 /* xbt_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
42 XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread);
43 /* Ends the life of the poor victim (not always working if it's computing, but working if it's blocked in the OS) */
44 XBT_PUBLIC(void) xbt_thread_cancel(xbt_thread_t thread);
46 XBT_PUBLIC(void) xbt_thread_exit(void);
47 /* current thread pass control to any possible thread wanting it */
48 XBT_PUBLIC(void) xbt_thread_yield(void);
51 /** \brief Thread mutex data type (opaque structure) */
52 typedef struct s_xbt_mutex_ *xbt_mutex_t;
54 XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
55 XBT_PUBLIC(void) xbt_mutex_acquire(xbt_mutex_t mutex);
56 XBT_PUBLIC(void) xbt_mutex_release(xbt_mutex_t mutex);
57 XBT_PUBLIC(void) xbt_mutex_timedacquire(xbt_mutex_t mutex, double delay);
58 XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex);
61 /** \brief Thread condition data type (opaque structure) */
62 typedef struct s_xbt_cond_ *xbt_cond_t;
64 XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
65 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
66 XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond,
67 xbt_mutex_t mutex, double delay);
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);
75 #endif /* _XBT_THREAD_H */