-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2023. 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. */
#ifndef SIMGRID_S4U_MUTEX_HPP
#define SIMGRID_S4U_MUTEX_HPP
+#include "simgrid/s4u/Actor.hpp"
#include <simgrid/forward.h>
#include <xbt/asserts.h>
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
/** @brief A classical mutex, but blocking in the simulation world.
*
- * @rst
+ * S4U mutexes are not recursive. If an actor tries to lock the same object twice, it deadlocks with itself.
+ *
+ * @beginrst
* 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>`_,
* @endrst
*/
class XBT_PUBLIC Mutex {
+#ifndef DOXYGEN
friend ConditionVariable;
friend kernel::activity::MutexImpl;
+ friend XBT_PUBLIC void kernel::activity::intrusive_ptr_release(kernel::activity::MutexImpl* mutex);
+#endif
kernel::activity::MutexImpl* const pimpl_;
/* refcounting */
friend XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* mutex);
friend XBT_PUBLIC void intrusive_ptr_release(const Mutex* mutex);
-public:
explicit Mutex(kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
- ~Mutex();
+ ~Mutex() = default;
#ifndef DOXYGEN
Mutex(Mutex const&) = delete; // No copy constructor; Use MutexPtr instead
Mutex& operator=(Mutex const&) = delete; // No direct assignment either. Use MutexPtr instead
#endif
- /** Constructs a new mutex */
- static MutexPtr create();
+public:
+ /** \static Constructs a new mutex */
+ static MutexPtr create(bool recursive = false);
+
void lock();
void unlock();
bool try_lock();
+
+ Actor* get_owner();
};
-} // namespace s4u
-} // namespace simgrid
+} // namespace simgrid::s4u
#endif /* SIMGRID_S4U_MUTEX_HPP */