1 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_S4U_MUTEX_HPP
7 #define SIMGRID_S4U_MUTEX_HPP
9 #include <simgrid/forward.h>
10 #include <xbt/asserts.h>
15 class ConditionVariable;
17 /** @brief A classical mutex, but blocking in the simulation world
20 * It is strictly impossible to use a real mutex, such as
21 * <a href="http://en.cppreference.com/w/cpp/thread/mutex">std::mutex</a>
22 * or <a href="http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html">pthread_mutex_t</a>,
23 * because it would block the whole simulation.
24 * Instead, you should use the present class, that is a drop-in replacement of
25 * <a href="http://en.cppreference.com/w/cpp/thread/mutex>std::mutex</a>.
27 * As for any S4U object, Mutexes are using the @ref s4u_raii "RAII idiom" for memory management.
28 * Use createMutex() to get a ::MutexPtr to a newly created mutex and only manipulate ::MutexPtr.
31 class XBT_PUBLIC Mutex {
33 friend ConditionVariable;
34 friend simgrid::kernel::activity::MutexImpl;
36 simgrid::kernel::activity::MutexImpl* pimpl_;
37 explicit Mutex(simgrid::kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
40 friend XBT_PUBLIC void intrusive_ptr_add_ref(Mutex* mutex);
41 friend XBT_PUBLIC void intrusive_ptr_release(Mutex* mutex);
44 using Ptr = boost::intrusive_ptr<Mutex>;
47 /** You cannot create a new mutex by copying an existing one. Use MutexPtr instead */
48 Mutex(Mutex const&) = delete;
49 /** You cannot create a new mutex by value assignment either. Use MutexPtr instead */
50 Mutex& operator=(Mutex const&) = delete;
52 /** Constructs a new mutex */
60 /** @deprecated Mutex::create() */
61 XBT_ATTRIB_DEPRECATED_v323("Please use Mutex::create()") static Ptr createMutex() { return create(); }
64 using MutexPtr = Mutex::Ptr;
66 }} // namespace simgrid::s4u
68 #endif /* SIMGRID_S4U_MUTEX_HPP */