391 lines
15 KiB
C++
391 lines
15 KiB
C++
//////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// (C) Copyright Ion Gaztanaga 2005-2012. Distributed under the Boost
|
|
// Software License, Version 1.0. (See accompanying file
|
|
// LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
//
|
|
// See http://www.boost.org/libs/interprocess for documentation.
|
|
//
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef BOOST_INTERPROCESS_NAMED_SHARABLE_MUTEX_HPP
|
|
#define BOOST_INTERPROCESS_NAMED_SHARABLE_MUTEX_HPP
|
|
|
|
#ifndef BOOST_CONFIG_HPP
|
|
# include <boost/config.hpp>
|
|
#endif
|
|
#
|
|
#if defined(BOOST_HAS_PRAGMA_ONCE)
|
|
# pragma once
|
|
#endif
|
|
|
|
#include <boost/interprocess/detail/config_begin.hpp>
|
|
#include <boost/interprocess/detail/workaround.hpp>
|
|
#include <boost/interprocess/creation_tags.hpp>
|
|
#include <boost/interprocess/exceptions.hpp>
|
|
#include <boost/interprocess/shared_memory_object.hpp>
|
|
#include <boost/interprocess/detail/managed_open_or_create_impl.hpp>
|
|
#include <boost/interprocess/sync/interprocess_sharable_mutex.hpp>
|
|
#include <boost/interprocess/sync/shm/named_creation_functor.hpp>
|
|
#include <boost/interprocess/permissions.hpp>
|
|
|
|
//!\file
|
|
//!Describes a named sharable mutex class for inter-process synchronization
|
|
|
|
namespace boost {
|
|
namespace interprocess {
|
|
|
|
#if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
namespace ipcdetail{ class interprocess_tester; }
|
|
#endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
|
|
|
|
class named_condition;
|
|
|
|
//!A sharable mutex with a global name, so it can be found from different
|
|
//!processes. This mutex can't be placed in shared memory, and
|
|
//!each process should have it's own named sharable mutex.
|
|
class named_sharable_mutex
|
|
{
|
|
#if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
//Non-copyable
|
|
named_sharable_mutex();
|
|
named_sharable_mutex(const named_sharable_mutex &);
|
|
named_sharable_mutex &operator=(const named_sharable_mutex &);
|
|
#endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
|
|
public:
|
|
|
|
//!Creates a global sharable mutex with a name.
|
|
//!If the sharable mutex can't be created throws interprocess_exception
|
|
named_sharable_mutex(create_only_t, const char *name, const permissions &perm = permissions());
|
|
|
|
//!Opens or creates a global sharable mutex with a name.
|
|
//!If the sharable mutex is created, this call is equivalent to
|
|
//!named_sharable_mutex(create_only_t, ...)
|
|
//!If the sharable mutex is already created, this call is equivalent to
|
|
//!named_sharable_mutex(open_only_t, ... ).
|
|
named_sharable_mutex(open_or_create_t, const char *name, const permissions &perm = permissions());
|
|
|
|
//!Opens a global sharable mutex with a name if that sharable mutex
|
|
//!is previously.
|
|
//!created. If it is not previously created this function throws
|
|
//!interprocess_exception.
|
|
named_sharable_mutex(open_only_t, const char *name);
|
|
|
|
#if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
|
|
//!Creates a global sharable mutex with a name.
|
|
//!If the sharable mutex can't be created throws interprocess_exception
|
|
//!
|
|
//!Note: This function is only available on operating systems with
|
|
//! native wchar_t APIs (e.g. Windows).
|
|
named_sharable_mutex(create_only_t, const wchar_t *name, const permissions &perm = permissions());
|
|
|
|
//!Opens or creates a global sharable mutex with a name.
|
|
//!If the sharable mutex is created, this call is equivalent to
|
|
//!named_sharable_mutex(create_only_t, ...)
|
|
//!If the sharable mutex is already created, this call is equivalent to
|
|
//!named_sharable_mutex(open_only_t, ... ).
|
|
//!
|
|
//!Note: This function is only available on operating systems with
|
|
//! native wchar_t APIs (e.g. Windows).
|
|
named_sharable_mutex(open_or_create_t, const wchar_t *name, const permissions &perm = permissions());
|
|
|
|
//!Opens a global sharable mutex with a name if that sharable mutex
|
|
//!is previously.
|
|
//!created. If it is not previously created this function throws
|
|
//!interprocess_exception.
|
|
//!
|
|
//!Note: This function is only available on operating systems with
|
|
//! native wchar_t APIs (e.g. Windows).
|
|
named_sharable_mutex(open_only_t, const wchar_t *name);
|
|
|
|
#endif //defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
|
|
//!Destroys *this and indicates that the calling process is finished using
|
|
//!the resource. The destructor function will deallocate
|
|
//!any system resources allocated by the system for use by this process for
|
|
//!this resource. The resource can still be opened again calling
|
|
//!the open constructor overload. To erase the resource from the system
|
|
//!use remove().
|
|
~named_sharable_mutex();
|
|
|
|
//Exclusive locking
|
|
|
|
//!Requires: The calling thread does not own the mutex.
|
|
//!
|
|
//!Effects: The calling thread tries to obtain exclusive ownership of the mutex,
|
|
//! and if another thread has exclusive or sharable ownership of
|
|
//! the mutex, it waits until it can obtain the ownership.
|
|
//!Throws: interprocess_exception on error.
|
|
//!
|
|
//!Note: A program may deadlock if the thread that has ownership calls
|
|
//! this function. If the implementation can detect the deadlock,
|
|
//! an exception could be thrown.
|
|
void lock();
|
|
|
|
//!Requires: The calling thread does not own the mutex.
|
|
//!
|
|
//!Effects: The calling thread tries to acquire exclusive ownership of the mutex
|
|
//! without waiting. If no other thread has exclusive or sharable
|
|
//! ownership of the mutex this succeeds.
|
|
//!Returns: If it can acquire exclusive ownership immediately returns true.
|
|
//! If it has to wait, returns false.
|
|
//!Throws: interprocess_exception on error.
|
|
//!
|
|
//!Note: A program may deadlock if the thread that has ownership calls
|
|
//! this function. If the implementation can detect the deadlock,
|
|
//! an exception could be thrown.
|
|
bool try_lock();
|
|
|
|
//!Requires: The calling thread does not own the mutex.
|
|
//!
|
|
//!Effects: The calling thread tries to acquire exclusive ownership of the mutex
|
|
//! waiting if necessary until no other thread has exclusive, or sharable
|
|
//! ownership of the mutex or abs_time is reached.
|
|
//!Returns: If acquires exclusive ownership, returns true. Otherwise returns false.
|
|
//!Throws: interprocess_exception on error.
|
|
//!
|
|
//!Note: A program may deadlock if the thread that has ownership calls
|
|
//! this function. If the implementation can detect the deadlock,
|
|
//! an exception could be thrown.
|
|
template<class TimePoint>
|
|
bool timed_lock(const TimePoint &abs_time);
|
|
|
|
//!Same as `timed_lock`, but this function is modeled after the
|
|
//!standard library interface.
|
|
template<class TimePoint> bool try_lock_until(const TimePoint &abs_time)
|
|
{ return this->timed_lock(abs_time); }
|
|
|
|
//!Same as `timed_lock`, but this function is modeled after the
|
|
//!standard library interface.
|
|
template<class Duration> bool try_lock_for(const Duration &dur)
|
|
{ return this->timed_lock(ipcdetail::duration_to_ustime(dur)); }
|
|
|
|
//!Precondition: The thread must have exclusive ownership of the mutex.
|
|
//!Effects: The calling thread releases the exclusive ownership of the mutex.
|
|
//!Throws: An exception derived from interprocess_exception on error.
|
|
void unlock();
|
|
|
|
//Sharable locking
|
|
|
|
//!Requires: The calling thread does not own the mutex.
|
|
//!
|
|
//!Effects: The calling thread tries to obtain sharable ownership of the mutex,
|
|
//! and if another thread has exclusive ownership of the mutex,
|
|
//! waits until it can obtain the ownership.
|
|
//!Throws: interprocess_exception on error.
|
|
//!
|
|
//!Note: A program may deadlock if the thread that has ownership calls
|
|
//! this function. If the implementation can detect the deadlock,
|
|
//! an exception could be thrown
|
|
void lock_sharable();
|
|
|
|
//!Same as `lock_sharable` but with a std-compatible interface
|
|
//!
|
|
void lock_shared()
|
|
{ this->lock_sharable(); }
|
|
|
|
//!Requires: The calling thread does not own the mutex.
|
|
//!
|
|
//!Effects: The calling thread tries to acquire sharable ownership of the mutex
|
|
//! without waiting. If no other thread has exclusive ownership
|
|
//! of the mutex this succeeds.
|
|
//!Returns: If it can acquire sharable ownership immediately returns true. If it
|
|
//! has to wait, returns false.
|
|
//!Throws: interprocess_exception on error.
|
|
//!
|
|
//!Note: A program may deadlock if the thread that has ownership calls
|
|
//! this function. If the implementation can detect the deadlock,
|
|
//! an exception could be thrown
|
|
bool try_lock_sharable();
|
|
|
|
//!Same as `try_lock_sharable` but with a std-compatible interface
|
|
//!
|
|
bool try_lock_shared()
|
|
{ return this->try_lock_sharable(); }
|
|
|
|
//!Requires: The calling thread does not own the mutex.
|
|
//!
|
|
//!Effects: The calling thread tries to acquire sharable ownership of the mutex
|
|
//! waiting if necessary until no other thread has exclusive
|
|
//! ownership of the mutex or abs_time is reached.
|
|
//!Returns: If acquires sharable ownership, returns true. Otherwise returns false.
|
|
//!Throws: interprocess_exception on error.
|
|
//!
|
|
//!Note: A program may deadlock if the thread that has ownership calls
|
|
//! this function. If the implementation can detect the deadlock,
|
|
//! an exception could be thrown
|
|
template<class TimePoint>
|
|
bool timed_lock_sharable(const TimePoint &abs_time);
|
|
|
|
//!Same as `timed_lock_sharable`, but this function is modeled after the
|
|
//!standard library interface.
|
|
template<class TimePoint> bool try_lock_shared_until(const TimePoint &abs_time)
|
|
{ return this->timed_lock_sharable(abs_time); }
|
|
|
|
//!Same as `timed_lock_sharable`, but this function is modeled after the
|
|
//!standard library interface.
|
|
template<class Duration> bool try_lock_shared_for(const Duration &dur)
|
|
{ return this->timed_lock_sharable(ipcdetail::duration_to_ustime(dur)); }
|
|
|
|
//!Precondition: The thread must have sharable ownership of the mutex.
|
|
//!Effects: The calling thread releases the sharable ownership of the mutex.
|
|
//!Throws: An exception derived from interprocess_exception on error.
|
|
void unlock_sharable();
|
|
|
|
//!Same as `unlock_sharable` but with a std-compatible interface
|
|
//!
|
|
void unlock_shared()
|
|
{ this->unlock_sharable(); }
|
|
|
|
//!Erases a named sharable mutex from the system.
|
|
//!Returns false on error. Never throws.
|
|
static bool remove(const char *name);
|
|
|
|
#if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
|
|
//!Erases a named sharable mutex from the system.
|
|
//!Returns false on error. Never throws.
|
|
static bool remove(const wchar_t *name);
|
|
|
|
#endif
|
|
|
|
#if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
private:
|
|
friend class ipcdetail::interprocess_tester;
|
|
void dont_close_on_destruction();
|
|
|
|
interprocess_sharable_mutex *mutex() const
|
|
{ return static_cast<interprocess_sharable_mutex*>(m_shmem.get_user_address()); }
|
|
|
|
typedef ipcdetail::managed_open_or_create_impl<shared_memory_object, 0, true, false> open_create_impl_t;
|
|
open_create_impl_t m_shmem;
|
|
typedef ipcdetail::named_creation_functor<interprocess_sharable_mutex> construct_func_t;
|
|
#endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
|
|
};
|
|
|
|
#if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
|
|
inline named_sharable_mutex::~named_sharable_mutex()
|
|
{}
|
|
|
|
inline named_sharable_mutex::named_sharable_mutex
|
|
(create_only_t, const char *name, const permissions &perm)
|
|
: m_shmem (create_only
|
|
,name
|
|
,sizeof(interprocess_sharable_mutex) +
|
|
open_create_impl_t::ManagedOpenOrCreateUserOffset
|
|
,read_write
|
|
,0
|
|
,construct_func_t(ipcdetail::DoCreate)
|
|
,perm)
|
|
{}
|
|
|
|
inline named_sharable_mutex::named_sharable_mutex
|
|
(open_or_create_t, const char *name, const permissions &perm)
|
|
: m_shmem (open_or_create
|
|
,name
|
|
,sizeof(interprocess_sharable_mutex) +
|
|
open_create_impl_t::ManagedOpenOrCreateUserOffset
|
|
,read_write
|
|
,0
|
|
,construct_func_t(ipcdetail::DoOpenOrCreate)
|
|
,perm)
|
|
{}
|
|
|
|
inline named_sharable_mutex::named_sharable_mutex
|
|
(open_only_t, const char *name)
|
|
: m_shmem (open_only
|
|
,name
|
|
,read_write
|
|
,0
|
|
,construct_func_t(ipcdetail::DoOpen))
|
|
{}
|
|
|
|
#if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
|
|
inline named_sharable_mutex::named_sharable_mutex
|
|
(create_only_t, const wchar_t *name, const permissions &perm)
|
|
: m_shmem (create_only
|
|
,name
|
|
,sizeof(interprocess_sharable_mutex) +
|
|
open_create_impl_t::ManagedOpenOrCreateUserOffset
|
|
,read_write
|
|
,0
|
|
,construct_func_t(ipcdetail::DoCreate)
|
|
,perm)
|
|
{}
|
|
|
|
inline named_sharable_mutex::named_sharable_mutex
|
|
(open_or_create_t, const wchar_t *name, const permissions &perm)
|
|
: m_shmem (open_or_create
|
|
,name
|
|
,sizeof(interprocess_sharable_mutex) +
|
|
open_create_impl_t::ManagedOpenOrCreateUserOffset
|
|
,read_write
|
|
,0
|
|
,construct_func_t(ipcdetail::DoOpenOrCreate)
|
|
,perm)
|
|
{}
|
|
|
|
inline named_sharable_mutex::named_sharable_mutex
|
|
(open_only_t, const wchar_t *name)
|
|
: m_shmem (open_only
|
|
,name
|
|
,read_write
|
|
,0
|
|
,construct_func_t(ipcdetail::DoOpen))
|
|
{}
|
|
|
|
#endif
|
|
|
|
inline void named_sharable_mutex::dont_close_on_destruction()
|
|
{ ipcdetail::interprocess_tester::dont_close_on_destruction(m_shmem); }
|
|
|
|
inline void named_sharable_mutex::lock()
|
|
{ this->mutex()->lock(); }
|
|
|
|
inline void named_sharable_mutex::unlock()
|
|
{ this->mutex()->unlock(); }
|
|
|
|
inline bool named_sharable_mutex::try_lock()
|
|
{ return this->mutex()->try_lock(); }
|
|
|
|
template<class TimePoint>
|
|
inline bool named_sharable_mutex::timed_lock
|
|
(const TimePoint &abs_time)
|
|
{ return this->mutex()->timed_lock(abs_time); }
|
|
|
|
inline void named_sharable_mutex::lock_sharable()
|
|
{ this->mutex()->lock_sharable(); }
|
|
|
|
inline void named_sharable_mutex::unlock_sharable()
|
|
{ this->mutex()->unlock_sharable(); }
|
|
|
|
inline bool named_sharable_mutex::try_lock_sharable()
|
|
{ return this->mutex()->try_lock_sharable(); }
|
|
|
|
template<class TimePoint>
|
|
inline bool named_sharable_mutex::timed_lock_sharable
|
|
(const TimePoint &abs_time)
|
|
{ return this->mutex()->timed_lock_sharable(abs_time); }
|
|
|
|
inline bool named_sharable_mutex::remove(const char *name)
|
|
{ return shared_memory_object::remove(name); }
|
|
|
|
#if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
|
|
inline bool named_sharable_mutex::remove(const wchar_t *name)
|
|
{ return shared_memory_object::remove(name); }
|
|
|
|
#endif //defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
|
|
|
|
#endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
|
|
|
|
} //namespace interprocess {
|
|
} //namespace boost {
|
|
|
|
#include <boost/interprocess/detail/config_end.hpp>
|
|
|
|
#endif //BOOST_INTERPROCESS_NAMED_SHARABLE_MUTEX_HPP
|