1 /* Copyright (c) 2006-2019. 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 /** @brief A classical mutex, but blocking in the simulation world
18 * It is strictly impossible to use a real mutex, such as
19 * <a href="http://en.cppreference.com/w/cpp/thread/mutex">std::mutex</a>
20 * or <a href="http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html">pthread_mutex_t</a>,
21 * because it would block the whole simulation.
22 * Instead, you should use the present class, that is a drop-in replacement of
23 * <a href="http://en.cppreference.com/w/cpp/thread/mutex>std::mutex</a>.
25 * As for any S4U object, Mutexes are using the @ref s4u_raii "RAII idiom" for memory management.
26 * Use create() to get a simgrid::s4u::MutexPtr to a newly created mutex and only manipulate simgrid::s4u::MutexPtr.
29 class XBT_PUBLIC Mutex {
30 friend simgrid::s4u::ConditionVariable;
31 friend simgrid::kernel::activity::MutexImpl;
33 simgrid::kernel::activity::MutexImpl* const pimpl_;
34 explicit Mutex(simgrid::kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
36 friend XBT_PUBLIC void intrusive_ptr_add_ref(Mutex* mutex);
37 friend XBT_PUBLIC void intrusive_ptr_release(Mutex* mutex);
42 /** You cannot create a new mutex by copying an existing one. Use MutexPtr instead */
43 Mutex(Mutex const&) = delete;
44 /** You cannot create a new mutex by value assignment either. Use MutexPtr instead */
45 Mutex& operator=(Mutex const&) = delete;
47 /** Constructs a new mutex */
48 static MutexPtr create();
55 /** @deprecated Mutex::create() */
56 XBT_ATTRIB_DEPRECATED_v323("Please use Mutex::create()") static MutexPtr createMutex() { return create(); }
60 }} // namespace simgrid::s4u
62 #endif /* SIMGRID_S4U_MUTEX_HPP */