sync/windows/named_condition_any.hpp

0001  //////////////////////////////////////////////////////////////////////////////
0002 //
0003 // (C) Copyright Ion Gaztanaga 2011-2012. Distributed under the Boost
0004 // Software License, Version 1.0. (See accompanying file
0005 // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
0006 //
0007 // See http://www.boost.org/libs/interprocess for documentation.
0008 //
0009 //////////////////////////////////////////////////////////////////////////////
0010
0011 #ifndef BOOST_INTERPROCESS_WINDOWS_NAMED_CONDITION_ANY_HPP
0012 #define BOOST_INTERPROCESS_WINDOWS_NAMED_CONDITION_ANY_HPP
0013
0014 #ifndef BOOST_CONFIG_HPP
0015 #  include <boost/config.hpp>
0016 #endif
0017 #
0018 #if defined(BOOST_HAS_PRAGMA_ONCE)
0019 #  pragma once
0020 #endif
0021
0022 #include <boost/interprocess/detail/config_begin.hpp>
0023 #include <boost/interprocess/detail/workaround.hpp>
0024
0025 #include <boost/interprocess/sync/cv_status.hpp>
0026 #include <boost/interprocess/creation_tags.hpp>
0027 #include <boost/interprocess/permissions.hpp>
0028 #include <boost/interprocess/detail/interprocess_tester.hpp>
0029 #include <boost/interprocess/sync/windows/named_sync.hpp>
0030 #include <boost/interprocess/sync/windows/winapi_semaphore_wrapper.hpp>
0031 #include <boost/interprocess/sync/detail/condition_algorithm_8a.hpp>
0032 #include <boost/interprocess/timed_utils.hpp>
0033
0034 namespace boost {
0035 namespace interprocess {
0036 namespace ipcdetail {
0037
0038 template<class CharT>
0039 struct named_cond_callbacks_str;
0040
0041 template<>
0042 struct named_cond_callbacks_str<char>
0043 {
0044    static const char* ipc_cond()
0045    {  return "Global\\bipc.cond.";  }
0046
0047    static const char* bq()
0048    {  return "_bq";  }
0049
0050    static const char* bl()
0051    {  return "_bl";  }
0052
0053    static const char* ul()
0054    {  return "_ul";  }
0055 };
0056
0057 template<>
0058 struct named_cond_callbacks_str<wchar_t>
0059 {
0060    static const wchar_t* ipc_cond()
0061    {  return L"Global\\bipc.cond.";  }
0062
0063    static const wchar_t* bq()
0064    {  return L"_bq";  }
0065
0066    static const wchar_t* bl()
0067    {  return L"_bl";  }
0068
0069    static const wchar_t* ul()
0070    {  return L"_ul";  }
0071 };
0072
0073 class winapi_named_condition_any
0074 {
0075    #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
0076
0077    //Non-copyable
0078    winapi_named_condition_any();
0079    winapi_named_condition_any(const winapi_named_condition_any &);
0080    winapi_named_condition_any &operator=(const winapi_named_condition_any &);
0081    #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
0082
0083    public:
0084    winapi_named_condition_any
0085       (create_only_t, const char *name, const permissions &perm = permissions())
0086       : m_condition_data()
0087    {
0088       named_cond_callbacks callbacks(m_condition_data.get_members());
0089       m_named_sync.open_or_create(DoCreate, name, perm, callbacks);
0090    }
0091
0092    winapi_named_condition_any
0093       (open_or_create_t, const char *name, const permissions &perm = permissions())
0094       : m_condition_data()
0095    {
0096       named_cond_callbacks callbacks(m_condition_data.get_members());
0097       m_named_sync.open_or_create(DoOpenOrCreate, name, perm, callbacks);
0098    }
0099
0100    winapi_named_condition_any(open_only_t, const char *name)
0101       : m_condition_data()
0102    {
0103       named_cond_callbacks callbacks(m_condition_data.get_members());
0104       m_named_sync.open_or_create(DoOpen, name, permissions(), callbacks);
0105    }
0106
0107    #if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
0108
0109    winapi_named_condition_any
0110       (create_only_t, const wchar_t *name, const permissions &perm = permissions())
0111       : m_condition_data()
0112    {
0113       named_cond_callbacks callbacks(m_condition_data.get_members());
0114       m_named_sync.open_or_create(DoCreate, name, perm, callbacks);
0115    }
0116
0117    winapi_named_condition_any
0118       (open_or_create_t, const wchar_t *name, const permissions &perm = permissions())
0119       : m_condition_data()
0120    {
0121       named_cond_callbacks callbacks(m_condition_data.get_members());
0122       m_named_sync.open_or_create(DoOpenOrCreate, name, perm, callbacks);
0123    }
0124
0125    winapi_named_condition_any(open_only_t, const wchar_t *name)
0126       : m_condition_data()
0127    {
0128       named_cond_callbacks callbacks(m_condition_data.get_members());
0129       m_named_sync.open_or_create(DoOpen, name, permissions(), callbacks);
0130    }
0131
0132    #endif   //defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
0133
0134    ~winapi_named_condition_any()
0135    {
0136       named_cond_callbacks callbacks(m_condition_data.get_members());
0137       m_named_sync.close(callbacks);
0138    }
0139
0140    void notify_one()
0141    {  m_condition_data.notify_one();   }
0142
0143    void notify_all()
0144    {  m_condition_data.notify_all();   }
0145
0146    template <typename L, typename TimePoint>
0147    bool timed_wait(L& lock, const TimePoint &abs_time)
0148    {  return m_condition_data.timed_wait(lock, abs_time);   }
0149
0150    template <typename L, typename TimePoint, typename Pr>
0151    bool timed_wait(L& lock, const TimePoint &abs_time, Pr pred)
0152    {  return m_condition_data.timed_wait(lock, abs_time, pred);   }
0153
0154    template <typename L>
0155    void wait(L& lock)
0156    {  m_condition_data.wait(lock);   }
0157
0158    template <typename L, typename Pr>
0159    void wait(L& lock, Pr pred)
0160    {  m_condition_data.wait(lock, pred);   }
0161
0162    template <typename L, class TimePoint>
0163    cv_status wait_until(L& lock, const TimePoint &abs_time)
0164    {  return this->timed_wait(lock, abs_time) ? cv_status::no_timeout : cv_status::timeout; }
0165
0166    template <typename L, class TimePoint, typename Pr>
0167    bool wait_until(L& lock, const TimePoint &abs_time, Pr pred)
0168    {  return this->timed_wait(lock, abs_time, pred); }
0169
0170    template <typename L, class Duration>
0171    cv_status wait_for(L& lock, const Duration &dur)
0172    {  return this->wait_until(lock, ipcdetail::duration_to_ustime(dur)); }
0173
0174    template <typename L, class Duration, typename Pr>
0175    bool wait_for(L& lock, const Duration &dur, Pr pred)
0176    {  return this->wait_until(lock, ipcdetail::duration_to_ustime(dur), pred); }
0177
0178    static bool remove(const char *name)
0179    {  return windows_named_sync::remove(name);  }
0180
0181    static bool remove(const wchar_t *name)
0182    {  return windows_named_sync::remove(name);  }
0183
0184    #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
0185    private:
0186
0187    void dont_close_on_destruction()
0188    {}
0189
0190    friend class interprocess_tester;
0191
0192    struct condition_data
0193    {
0194       typedef boost::int32_t           integer_type;
0195       typedef winapi_semaphore_wrapper semaphore_type;
0196       typedef winapi_mutex_wrapper     mutex_type;
0197
0198       integer_type    &get_nwaiters_blocked()
0199       {  return m_nwaiters_blocked;  }
0200
0201       integer_type    &get_nwaiters_gone()
0202       {  return m_nwaiters_gone;  }
0203
0204       integer_type    &get_nwaiters_to_unblock()
0205       {  return m_nwaiters_to_unblock;  }
0206
0207       semaphore_type  &get_sem_block_queue()
0208       {  return m_sem_block_queue;  }
0209
0210       semaphore_type  &get_sem_block_lock()
0211       {  return m_sem_block_lock;  }
0212
0213       mutex_type      &get_mtx_unblock_lock()
0214       {  return m_mtx_unblock_lock;  }
0215
0216       integer_type               m_nwaiters_blocked;
0217       integer_type               m_nwaiters_gone;
0218       integer_type               m_nwaiters_to_unblock;
0219       winapi_semaphore_wrapper   m_sem_block_queue;
0220       winapi_semaphore_wrapper   m_sem_block_lock;
0221       winapi_mutex_wrapper       m_mtx_unblock_lock;
0222    };
0223
0224
0225    class named_cond_callbacks : public windows_named_sync_interface
0226    {
0227       typedef __int64 sem_count_t;
0228       mutable sem_count_t sem_counts [2];
0229
0230       public:
0231       named_cond_callbacks(condition_data &cond_data)
0232          : m_condition_data(cond_data)
0233       {}
0234
0235       virtual std::size_t get_data_size() const BOOST_OVERRIDE
0236       {  return sizeof(sem_counts);   }
0237
0238       virtual const void *buffer_with_final_data_to_file() BOOST_OVERRIDE
0239       {
0240          sem_counts[0] = m_condition_data.m_sem_block_queue.value();
0241          sem_counts[1] = m_condition_data.m_sem_block_lock.value();
0242          return &sem_counts;
0243       }
0244
0245       virtual const void *buffer_with_init_data_to_file() BOOST_OVERRIDE
0246       {
0247          sem_counts[0] = 0;
0248          sem_counts[1] = 1;
0249          return &sem_counts;
0250       }
0251
0252       virtual void *buffer_to_store_init_data_from_file() BOOST_OVERRIDE
0253       {  return &sem_counts; }
0254
0255       virtual bool open(create_enum_t op, const char *id_name) BOOST_OVERRIDE
0256       {  return this->open_impl(op, id_name);   }
0257
0258       virtual bool open(create_enum_t op, const wchar_t *id_name) BOOST_OVERRIDE
0259       {  return this->open_impl(op, id_name);   }
0260
0261       virtual void close() BOOST_OVERRIDE
0262       {
0263          m_condition_data.m_sem_block_queue.close();
0264          m_condition_data.m_sem_block_lock.close();
0265          m_condition_data.m_mtx_unblock_lock.close();
0266          m_condition_data.m_nwaiters_blocked = 0;
0267          m_condition_data.m_nwaiters_gone = 0;
0268          m_condition_data.m_nwaiters_to_unblock = 0;
0269       }
0270
0271       virtual ~named_cond_callbacks() BOOST_OVERRIDE
0272       {}
0273
0274       private:
0275
0276       template<class CharT>
0277       bool open_impl(create_enum_t, const CharT *id_name)
0278       {
0279          typedef named_cond_callbacks_str<CharT> str_t;
0280          m_condition_data.m_nwaiters_blocked = 0;
0281          m_condition_data.m_nwaiters_gone = 0;
0282          m_condition_data.m_nwaiters_to_unblock = 0;
0283
0284          //Now open semaphores and mutex.
0285          //Use local variables + swap to guarantee consistent
0286          //initialization and cleanup in case any opening fails
0287          permissions perm;
0288          perm.set_unrestricted();
0289          std::basic_string<CharT> aux_str  = str_t::ipc_cond();
0290          aux_str += id_name;
0291          std::size_t pos = aux_str.size();
0292
0293          //sem_block_queue
0294          aux_str += str_t::bq();
0295          winapi_semaphore_wrapper sem_block_queue;
0296          bool created;
0297          if(!sem_block_queue.open_or_create
0298             (aux_str.c_str(), static_cast<long>(sem_counts[0]), winapi_semaphore_wrapper::MaxCount, perm, created))
0299             return false;
0300          aux_str.erase(pos);
0301
0302          //sem_block_lock
0303          aux_str += str_t::bl();
0304          winapi_semaphore_wrapper sem_block_lock;
0305          if(!sem_block_lock.open_or_create
0306             (aux_str.c_str(), static_cast<long>(sem_counts[1]), winapi_semaphore_wrapper::MaxCount, perm, created))
0307             return false;
0308          aux_str.erase(pos);
0309
0310          //mtx_unblock_lock
0311          aux_str += str_t::ul();
0312          winapi_mutex_wrapper mtx_unblock_lock;
0313          if(!mtx_unblock_lock.open_or_create(aux_str.c_str(), perm))
0314             return false;
0315
0316          //All ok, commit data
0317          m_condition_data.m_sem_block_queue.swap(sem_block_queue);
0318          m_condition_data.m_sem_block_lock.swap(sem_block_lock);
0319          m_condition_data.m_mtx_unblock_lock.swap(mtx_unblock_lock);
0320          return true;
0321       }
0322
0323       condition_data &m_condition_data;
0324    };
0325
0326    windows_named_sync   m_named_sync;
0327    ipcdetail::condition_8a_wrapper<condition_data> m_condition_data;
0328    #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
0329 };
0330
0331 }  //namespace ipcdetail {
0332 }  //namespace interprocess {
0333 }  //namespace boost {
0334
0335 #include <boost/interprocess/detail/config_end.hpp>
0336
0337 #endif   //BOOST_INTERPROCESS_WINDOWS_NAMED_CONDITION_ANY_HPP