From: mquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Date: Mon, 9 Jul 2007 17:40:42 +0000 (+0000)
Subject: Hello xbt/synchro module (synchronization working both in simulation and real life... 
X-Git-Tag: v3.3~1661
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/b03617bf4f7a079013761ea9cd4697fb9ff08a11?hp=2c720b83e270f7078e3795144be9c461f62fcf2a

Hello xbt/synchro module (synchronization working both in simulation and real life, for use in GRAS mainly but not only)


git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@3699 48e7efb5-ca39-0410-a469-dd3cf9ba447f
---

diff --git a/include/Makefile.am b/include/Makefile.am
index bbc189369f..cdf7f474ea 100644
--- a/include/Makefile.am
+++ b/include/Makefile.am
@@ -21,6 +21,8 @@ nobase_include_HEADERS = \
 	xbt/graphxml_parse.h \
 	xbt/graphxml.h \
 	\
+	xbt/xbt_thread.h \
+	\
 	msg/msg.h \
 	msg/datatypes.h \
 	\
diff --git a/include/xbt/synchro.h b/include/xbt/synchro.h
new file mode 100644
index 0000000000..227f6781ea
--- /dev/null
+++ b/include/xbt/synchro.h
@@ -0,0 +1,66 @@
+/* $Id$ */
+
+/* xbt/synchro.h -- Synchronization tools                                   */
+/* Usable in simulator, (or in real life when mixing with GRAS)             */
+
+/* Copyright (c) 2007 Martin Quinson. All rights reserved.                  */
+
+/* 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_THREAD_H
+#define _XBT_THREAD_H
+
+#include "xbt/misc.h" /* SG_BEGIN_DECL */
+#include "xbt/function_types.h"
+
+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?
+ * 
+ *  @{
+ */
+
+  /** \brief Thread data type (opaque structure) */
+  typedef struct s_xbt_thread_ *xbt_thread_t;
+
+  XBT_PUBLIC(xbt_thread_t) xbt_thread_create(pvoid_f_pvoid_t start_routine,void* param);
+  XBT_PUBLIC(void) xbt_thread_exit(int *retcode);
+  XBT_PUBLIC(xbt_thread_t) xbt_thread_self(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,void ** thread_return);
+  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_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);
+
+/** @} */
+
+SG_END_DECL()
+
+#endif /* _XBT_THREAD_H */