Fix mingw builds (?)

[simgrid.git] / include / simgrid / s4u / Mutex.hpp

diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp
index 0b3ebc8..d52df2d 100644 (file)
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2018. The 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. */
@@ -6,13 +6,8 @@
 #ifndef SIMGRID_S4U_MUTEX_HPP
 #define SIMGRID_S4U_MUTEX_HPP
 
-#include <mutex>
-#include <utility>
-
-#include <boost/intrusive_ptr.hpp>
-
-#include <xbt/base.h>
-#include "simgrid/simix.h"
+#include <simgrid/forward.h>
+#include <xbt/asserts.h>
 
 namespace simgrid {
 namespace s4u {
@@ -20,33 +15,29 @@ namespace s4u {
 class ConditionVariable;
 
 /** @brief A classical mutex, but blocking in the simulation world
+ *  @ingroup s4u_api
  *
- * It is strictly impossible to use a real mutex (such as
- * [std::mutex](http://en.cppreference.com/w/cpp/thread/mutex)
- * or [pthread_mutex_t](http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html)),
+ * It is strictly impossible to use a real mutex, such as
+ * <a href="http://en.cppreference.com/w/cpp/thread/mutex">std::mutex</a>
+ * or <a href="http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html">pthread_mutex_t</a>,
  * because it would block the whole simulation.
  * Instead, you should use the present class, that is a drop-in replacement of
- * [std::mutex](http://en.cppreference.com/w/cpp/thread/mutex).
+ * <a href="http://en.cppreference.com/w/cpp/thread/mutex>std::mutex</a>.
+ *
+ * As for any S4U object, Mutexes are using the @ref s4u_raii "RAII idiom" for memory management.
+ * Use createMutex() to get a ::MutexPtr to a newly created mutex and only manipulate ::MutexPtr.
  *
  */
-XBT_PUBLIC_CLASS Mutex {
-friend ConditionVariable;
-private:
-  friend simgrid::simix::Mutex;
-  simgrid::simix::Mutex* mutex_;
-  Mutex(simgrid::simix::Mutex* mutex) : mutex_(mutex) {}
+class XBT_PUBLIC Mutex {
+  friend ConditionVariable;
+  friend simgrid::kernel::activity::MutexImpl;
+  simgrid::kernel::activity::MutexImpl* mutex_;
+  explicit Mutex(simgrid::kernel::activity::MutexImpl * mutex) : mutex_(mutex) {}
+
+  /* refcounting */
+  friend XBT_PUBLIC void intrusive_ptr_add_ref(Mutex* mutex);
+  friend XBT_PUBLIC void intrusive_ptr_release(Mutex* mutex);
 
-  /* refcounting of the intrusive_ptr is delegated to the implementation object */
-  friend void intrusive_ptr_add_ref(Mutex* mutex)
-  {
-    xbt_assert(mutex);
-    SIMIX_mutex_ref(mutex->mutex_);
-  }
-  friend void intrusive_ptr_release(Mutex* mutex)
-  {
-    xbt_assert(mutex);
-    SIMIX_mutex_unref(mutex->mutex_);
-  }
 public:
   using Ptr = boost::intrusive_ptr<Mutex>;
 
@@ -59,7 +50,6 @@ public:
   /** Constructs a new mutex */
   static Ptr createMutex();
 
-public:
   void lock();
   void unlock();
   bool try_lock();