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