/usr/include/simgrid/s4u/Mutex.hpp is in libsimgrid-dev 3.18+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 | /* Copyright (c) 2006-2015. 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 <mutex>
#include <utility>
#include <boost/intrusive_ptr.hpp>
#include <xbt/base.h>
#include "simgrid/simix.h"
namespace simgrid {
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
* <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
* <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;
friend simgrid::simix::MutexImpl;
simgrid::simix::MutexImpl* mutex_;
explicit Mutex(simgrid::simix::MutexImpl * mutex) : 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>;
// No copy:
/** You cannot create a new mutex by copying an existing one. Use MutexPtr instead */
Mutex(Mutex const&) = delete;
/** You cannot create a new mutex by value assignment either. Use MutexPtr instead */
Mutex& operator=(Mutex const&) = delete;
/** Constructs a new mutex */
static Ptr createMutex();
void lock();
void unlock();
bool try_lock();
};
using MutexPtr = Mutex::Ptr;
}} // namespace simgrid::s4u
#endif /* SIMGRID_S4U_MUTEX_HPP */
|