Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: // (C) Copyright Ion Gaztanaga 2011-2012. Distributed under the Boost
Chris@16: // Software License, Version 1.0. (See accompanying file
Chris@16: // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: // See http://www.boost.org/libs/interprocess for documentation.
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: #ifndef BOOST_INTERPROCESS_WINDOWS_NAMED_SYNC_HPP
Chris@16: #define BOOST_INTERPROCESS_WINDOWS_NAMED_SYNC_HPP
Chris@16: 
Chris@101: #ifndef BOOST_CONFIG_HPP
Chris@101: #  include <boost/config.hpp>
Chris@101: #endif
Chris@101: #
Chris@101: #if defined(BOOST_HAS_PRAGMA_ONCE)
Chris@16: #  pragma once
Chris@16: #endif
Chris@16: 
Chris@16: #include <boost/interprocess/detail/config_begin.hpp>
Chris@16: #include <boost/interprocess/detail/workaround.hpp>
Chris@16: #include <boost/interprocess/creation_tags.hpp>
Chris@16: #include <boost/interprocess/permissions.hpp>
Chris@101: #include <boost/interprocess/detail/shared_dir_helpers.hpp>
Chris@16: #include <boost/interprocess/sync/windows/sync_utils.hpp>
Chris@16: #include <boost/interprocess/errors.hpp>
Chris@16: #include <boost/interprocess/exceptions.hpp>
Chris@16: #include <string>
Chris@16: #include <boost/assert.hpp>
Chris@16: 
Chris@16: namespace boost {
Chris@16: namespace interprocess {
Chris@16: namespace ipcdetail {
Chris@16: 
Chris@16: class windows_named_sync_interface
Chris@16: {
Chris@16:    public:
Chris@16:    virtual std::size_t get_data_size() const = 0;
Chris@16:    virtual const void *buffer_with_final_data_to_file() = 0;
Chris@16:    virtual const void *buffer_with_init_data_to_file() = 0;
Chris@16:    virtual void *buffer_to_store_init_data_from_file() = 0;
Chris@16:    virtual bool open(create_enum_t creation_type, const char *id_name) = 0;
Chris@16:    virtual void close() = 0;
Chris@16:    virtual ~windows_named_sync_interface() = 0;
Chris@16: };
Chris@16: 
Chris@16: inline windows_named_sync_interface::~windows_named_sync_interface()
Chris@16: {}
Chris@16: 
Chris@16: class windows_named_sync
Chris@16: {
Chris@101:    #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
Chris@16: 
Chris@16:    //Non-copyable
Chris@16:    windows_named_sync(const windows_named_sync &);
Chris@16:    windows_named_sync &operator=(const windows_named_sync &);
Chris@101:    #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
Chris@16: 
Chris@16:    public:
Chris@16:    windows_named_sync();
Chris@16:    void open_or_create(create_enum_t creation_type, const char *name, const permissions &perm, windows_named_sync_interface &sync_interface);
Chris@16:    void close(windows_named_sync_interface &sync_interface);
Chris@16: 
Chris@16:    static bool remove(const char *name);
Chris@16: 
Chris@101:    #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
Chris@16:    private:
Chris@16:    void *m_file_hnd;
Chris@16: 
Chris@101:    #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
Chris@16: };
Chris@16: 
Chris@16: inline windows_named_sync::windows_named_sync()
Chris@16:    : m_file_hnd(winapi::invalid_handle_value)
Chris@16: {}
Chris@16: 
Chris@16: inline void windows_named_sync::close(windows_named_sync_interface &sync_interface)
Chris@16: {
Chris@16:    const std::size_t buflen = sync_interface.get_data_size();
Chris@16:    const std::size_t sizeof_file_info = sizeof(sync_id::internal_type) + buflen;
Chris@16:    winapi::interprocess_overlapped overlapped;
Chris@16:    if(winapi::lock_file_ex
Chris@16:       (m_file_hnd, winapi::lockfile_exclusive_lock, 0, sizeof_file_info, 0, &overlapped)){
Chris@16:       if(winapi::set_file_pointer_ex(m_file_hnd, sizeof(sync_id::internal_type), 0, winapi::file_begin)){
Chris@16:          const void *buf = sync_interface.buffer_with_final_data_to_file();
Chris@16: 
Chris@16:          unsigned long written_or_read = 0;
Chris@16:          if(winapi::write_file(m_file_hnd, buf, buflen, &written_or_read, 0)){
Chris@16:             //...
Chris@16:          }
Chris@16:       }
Chris@16:    }
Chris@16:    sync_interface.close();
Chris@16:    if(m_file_hnd != winapi::invalid_handle_value){
Chris@16:       winapi::close_handle(m_file_hnd);
Chris@16:       m_file_hnd = winapi::invalid_handle_value;
Chris@16:    }
Chris@16: }
Chris@16: 
Chris@16: inline void windows_named_sync::open_or_create
Chris@16:    ( create_enum_t creation_type
Chris@16:    , const char *name
Chris@16:    , const permissions &perm
Chris@16:    , windows_named_sync_interface &sync_interface)
Chris@16: {
Chris@16:    std::string aux_str(name);
Chris@16:    m_file_hnd  = winapi::invalid_handle_value;
Chris@16:    //Use a file to emulate POSIX lifetime semantics. After this logic
Chris@16:    //we'll obtain the ID of the native handle to open in aux_str
Chris@16:    {
Chris@101:       create_shared_dir_cleaning_old_and_get_filepath(name, aux_str);
Chris@16:       //Create a file with required permissions.
Chris@16:       m_file_hnd = winapi::create_file
Chris@16:          ( aux_str.c_str()
Chris@16:          , winapi::generic_read | winapi::generic_write
Chris@16:          , creation_type == DoOpen ? winapi::open_existing :
Chris@16:                (creation_type == DoCreate ? winapi::create_new : winapi::open_always)
Chris@16:          , 0
Chris@16:          , (winapi::interprocess_security_attributes*)perm.get_permissions());
Chris@16: 
Chris@16:       //Obtain OS error in case something has failed
Chris@16:       error_info err;
Chris@16:       bool success = false;
Chris@16:       if(m_file_hnd != winapi::invalid_handle_value){
Chris@16:          //Now lock the file
Chris@16:          const std::size_t buflen = sync_interface.get_data_size();
Chris@16:          typedef __int64 unique_id_type;
Chris@16:          const std::size_t sizeof_file_info = sizeof(unique_id_type) + buflen;
Chris@16:          winapi::interprocess_overlapped overlapped;
Chris@16:          if(winapi::lock_file_ex
Chris@16:             (m_file_hnd, winapi::lockfile_exclusive_lock, 0, sizeof_file_info, 0, &overlapped)){
Chris@16:             __int64 filesize = 0;
Chris@16:             //Obtain the unique id to open the native semaphore.
Chris@16:             //If file size was created
Chris@16:             if(winapi::get_file_size(m_file_hnd, filesize)){
Chris@16:                unsigned long written_or_read = 0;
Chris@16:                unique_id_type unique_id_val;
Chris@16:                if(static_cast<std::size_t>(filesize) != sizeof_file_info){
Chris@16:                   winapi::set_end_of_file(m_file_hnd);
Chris@16:                   winapi::query_performance_counter(&unique_id_val);
Chris@16:                   const void *buf = sync_interface.buffer_with_init_data_to_file();
Chris@16:                   //Write unique ID in file. This ID will be used to calculate the semaphore name
Chris@16:                   if(winapi::write_file(m_file_hnd, &unique_id_val, sizeof(unique_id_val), &written_or_read, 0)  &&
Chris@16:                      written_or_read == sizeof(unique_id_val) &&
Chris@16:                      winapi::write_file(m_file_hnd, buf, buflen, &written_or_read, 0) &&
Chris@16:                      written_or_read == buflen ){
Chris@16:                      success = true;
Chris@16:                   }
Chris@16:                   winapi::get_file_size(m_file_hnd, filesize);
Chris@16:                   BOOST_ASSERT(std::size_t(filesize) == sizeof_file_info);
Chris@16:                }
Chris@16:                else{
Chris@16:                   void *buf = sync_interface.buffer_to_store_init_data_from_file();
Chris@16:                   if(winapi::read_file(m_file_hnd, &unique_id_val, sizeof(unique_id_val), &written_or_read, 0)  &&
Chris@16:                      written_or_read == sizeof(unique_id_val) &&
Chris@16:                      winapi::read_file(m_file_hnd, buf, buflen, &written_or_read, 0)  &&
Chris@16:                      written_or_read == buflen   ){
Chris@16:                      success = true;
Chris@16:                   }
Chris@16:                }
Chris@16:                if(success){
Chris@16:                   //Now create a global semaphore name based on the unique id
Chris@16:                   char unique_id_name[sizeof(unique_id_val)*2+1];
Chris@16:                   std::size_t name_suffix_length = sizeof(unique_id_name);
Chris@16:                   bytes_to_str(&unique_id_val, sizeof(unique_id_val), &unique_id_name[0], name_suffix_length);
Chris@16:                   success = sync_interface.open(creation_type, unique_id_name);
Chris@16:                }
Chris@16:             }
Chris@16: 
Chris@16:             //Obtain OS error in case something has failed
Chris@16:             err = system_error_code();
Chris@16: 
Chris@16:             //If this fails we have no possible rollback so don't check the return
Chris@16:             if(!winapi::unlock_file_ex(m_file_hnd, 0, sizeof_file_info, 0, &overlapped)){
Chris@16:                err = system_error_code();
Chris@16:             }
Chris@16:          }
Chris@16:          else{
Chris@16:             //Obtain OS error in case something has failed
Chris@16:             err = system_error_code();
Chris@16:          }
Chris@16:       }
Chris@16:       else{
Chris@16:          err = system_error_code();
Chris@16:       }
Chris@16: 
Chris@16:       if(!success){
Chris@16:          if(m_file_hnd != winapi::invalid_handle_value){
Chris@16:             winapi::close_handle(m_file_hnd);
Chris@16:             m_file_hnd = winapi::invalid_handle_value;
Chris@16:          }
Chris@16:          //Throw as something went wrong
Chris@16:          throw interprocess_exception(err);
Chris@16:       }
Chris@16:    }
Chris@16: }
Chris@16: 
Chris@16: inline bool windows_named_sync::remove(const char *name)
Chris@16: {
Chris@16:    try{
Chris@16:       //Make sure a temporary path is created for shared memory
Chris@16:       std::string semfile;
Chris@101:       ipcdetail::shared_filepath(name, semfile);
Chris@16:       return winapi::unlink_file(semfile.c_str());
Chris@16:    }
Chris@16:    catch(...){
Chris@16:       return false;
Chris@16:    }
Chris@16: }
Chris@16: 
Chris@16: }  //namespace ipcdetail {
Chris@16: }  //namespace interprocess {
Chris@16: }  //namespace boost {
Chris@16: 
Chris@16: #include <boost/interprocess/detail/config_end.hpp>
Chris@16: 
Chris@16: #endif   //BOOST_INTERPROCESS_WINDOWS_NAMED_SYNC_HPP