Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make semaphores visible from MSG
authorMartin Quinson <martin.quinson@loria.fr>
Thu, 6 Jun 2013 16:21:24 +0000 (18:21 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Thu, 6 Jun 2013 16:21:38 +0000 (18:21 +0200)
ChangeLog
buildtools/Cmake/DefinePackages.cmake
doc/doxygen/module-msg.doc
include/msg/msg.h
src/msg/msg_synchro.c [new file with mode: 0644]
src/surf/surf_routing_dijkstra.c
src/xbt/log.c

index 5a6b8c6..42fc2cb 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -14,7 +14,8 @@ SimGrid (3.10) NOT RELEASED; urgency=low
 
  MSG:
  * Dramatically change the way files are handled. API and internals changed, but
-   this part of MSG was not considered as production grade either. 
+   this part of MSG was not considered as production grade either.
+ * Add explicit synchronization facilities through semaphores
 
  SMPI:
  * SMPI is now included directly in the libsimgrid as the windows
index 9f79fec..74adcb8 100644 (file)
@@ -330,6 +330,7 @@ set(MSG_SRC
   src/msg/msg_io.c
   src/msg/msg_mailbox.c
   src/msg/msg_process.c
+  src/msg/msg_synchro.c
   src/msg/msg_task.c
   src/msg/msg_vm.c
   )
index 2241a15..d652b97 100644 (file)
@@ -29,6 +29,7 @@ us before digging into these badly documented internal modules).
    - \ref msg_file_management
    - \ref msg_task_usage
    - \ref msg_VMs
+   - \ref msg_synchro
    - \ref msg_trace_driven
    - \ref MSG_examples
    - \ref msg_deprecated_functions
@@ -92,6 +93,14 @@ details).
  *         by a process to execute, communicate or otherwise handle some task.
  */
 
+/** @defgroup msg_synchro Explicit Synchronization Functions
+ *  @ingroup MSG_API
+ *  @brief This section describes several explicit synchronization
+ *         mechanisms existing in MSG: semaphores (#msg_sem_t) and friends.
+ *
+ * In some situations, these things are very helpful to synchronize processes without message exchanges.
+ */
+
 /** @defgroup msg_VMs VMs
  *  @ingroup MSG_API
  *  @brief This section describes the interface created to mimic IaaS clouds.
index 891eb33..9a5aa26 100644 (file)
@@ -351,6 +351,19 @@ XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
 XBT_PUBLIC(int) MSG_get_channel_number(void);
 #endif
 
+/** @brief Opaque type representing a semaphore
+ *  @ingroup msg_synchro
+ *  @hideinitializer
+ */
+typedef struct s_smx_sem *msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be declared here
+XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
+XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
+XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
+XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
+XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
+XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
+XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
+
 /** @brief Opaque type describing a Virtual Machine.
  *  @ingroup msg_VMs
  *
diff --git a/src/msg/msg_synchro.c b/src/msg/msg_synchro.c
new file mode 100644 (file)
index 0000000..f06e6bb
--- /dev/null
@@ -0,0 +1,66 @@
+/* Copyright (c) 2013 Da SimGrid Team. 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. */
+
+#include "msg_private.h"
+#include "xbt/sysdep.h"
+#include "xbt/log.h"
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_synchro, msg,
+                                "Logging specific to MSG (synchro)");
+
+
+/** @addtogroup msg_synchro
+ *
+ *  @{
+ */
+
+/********************************* Host **************************************/
+
+/** @brief creates a semaphore object of the given initial capacity */
+msg_sem_t MSG_sem_init(int initial_value) {
+  return simcall_sem_init(initial_value);
+}
+
+/** @brief locks on a semaphore object */
+void MSG_sem_acquire(msg_sem_t sem) {
+  simcall_sem_acquire(sem);
+}
+/** @brief locks on a semaphore object up until the provided timeout expires */
+msg_error_t MSG_sem_acquire_timeout(msg_sem_t sem, double timeout) {
+  xbt_ex_t e;
+  msg_error_t res = MSG_OK;
+  TRY {
+    simcall_sem_acquire_timeout(sem,timeout);
+  } CATCH(e) {
+    if (e.category == timeout_error) {
+      res = MSG_TIMEOUT;
+      xbt_ex_free(e);
+    } else {
+      RETHROW;
+    }
+  }
+  return res;
+}
+/** @brief releases the semaphore object */
+void MSG_sem_release(msg_sem_t sem) {
+  simcall_sem_release(sem);
+}
+void MSG_sem_get_capacity(msg_sem_t sem) {
+  simcall_sem_get_capacity(sem);
+}
+
+void MSG_sem_destroy(msg_sem_t sem) {
+  simcall_sem_destroy(sem);
+}
+/** @brief returns a boolean indicating it this semaphore would block at this very specific time
+ *
+ * Note that the returned value may be wrong right after the function call, when you try to use it...
+ * But that's a classical semaphore issue, and SimGrid's semaphore are not different to usual ones here.
+ */
+int MSG_sem_would_block(msg_sem_t sem) {
+  return simcall_sem_would_block(sem);
+}
+
+/**@}*/
index 4b0d4c9..d225cd4 100644 (file)
@@ -51,7 +51,7 @@ static void graph_node_map_elem_free(void *e)
   xbt_free(elm);
 }
 
-static void graph_edge_data_free(void *e) // FIXME: useless code dupplication
+static void graph_edge_data_free(void *e) // FIXME: useless code duplication
 {
   sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t) e;
   if (e_route) {
index 2bcb103..c560de6 100644 (file)
@@ -638,6 +638,7 @@ static void xbt_log_connect_categories(void)
   XBT_LOG_CONNECT(msg_mailbox);
   XBT_LOG_CONNECT(msg_new_API);
   XBT_LOG_CONNECT(msg_process);
+  XBT_LOG_CONNECT(msg_synchro);
   XBT_LOG_CONNECT(msg_task);
   XBT_LOG_CONNECT(msg_vm);