////////////////////////////////////////////////////////////////////////////// // // (C) Copyright Ion Gaztanaga 2005-2008. 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_DETAIL_OS_FILE_FUNCTIONS_HPP #define BOOST_INTERPROCESS_DETAIL_OS_FILE_FUNCTIONS_HPP #include #include //#include #if (defined BOOST_WINDOWS) && !(defined BOOST_DISABLE_WIN32) # include #else # ifdef BOOST_HAS_UNISTD_H # include # include # include # include # include # else # error Unknown platform # endif #endif #include #include namespace boost { namespace interprocess { #if (defined BOOST_WINDOWS) && !(defined BOOST_DISABLE_WIN32) typedef void * file_handle_t; typedef long long offset_t; typedef struct{ void * handle; bool is_shm; } mapping_handle_t; typedef enum { read_only = winapi::generic_read , read_write = winapi::generic_read | winapi::generic_write , copy_on_write , invalid_mode = 0xffff } mode_t; typedef enum { file_begin = winapi::file_begin , file_end = winapi::file_end , file_current = winapi::file_current } file_pos_t; namespace detail{ inline mapping_handle_t mapping_handle_from_file_handle(file_handle_t hnd) { mapping_handle_t ret; ret.handle = hnd; ret.is_shm = false; return ret; } inline file_handle_t file_handle_from_mapping_handle(mapping_handle_t hnd) { return hnd.handle; } inline bool create_directory(const char *path) { return winapi::create_directory(path, 0); } inline const char *get_temporary_path() { return std::getenv("TMP"); } inline file_handle_t create_new_file (const char *name, mode_t mode = read_write, bool temporary = false) { unsigned long attr = temporary ? winapi::file_attribute_temporary : 0; return winapi::create_file (name, (unsigned int)mode, winapi::create_new, attr); } inline file_handle_t create_or_open_file (const char *name, mode_t mode = read_write, bool temporary = false) { unsigned long attr = temporary ? winapi::file_attribute_temporary : 0; return winapi::create_file (name, (unsigned int)mode, winapi::open_always, attr); } inline file_handle_t open_existing_file (const char *name, mode_t mode = read_write, bool temporary = false) { unsigned long attr = temporary ? winapi::file_attribute_temporary : 0; return winapi::create_file (name, (unsigned int)mode, winapi::open_existing, attr); } inline bool delete_file(const char *name) { return winapi::delete_file(name); } inline bool truncate_file (file_handle_t hnd, std::size_t size) { if(!winapi::set_file_pointer_ex(hnd, size, 0, winapi::file_begin)){ return false; } if(!winapi::set_end_of_file(hnd)){ return false; } return true; } inline bool get_file_size(file_handle_t hnd, offset_t &size) { return winapi::get_file_size(hnd, size); } inline bool set_file_pointer(file_handle_t hnd, offset_t off, file_pos_t pos) { return winapi::set_file_pointer_ex(hnd, off, 0, (unsigned long) pos); } inline bool get_file_pointer(file_handle_t hnd, offset_t &off) { return winapi::set_file_pointer_ex(hnd, 0, &off, winapi::file_current); } inline bool write_file(file_handle_t hnd, const void *data, std::size_t numdata) { unsigned long written; return 0 != winapi::write_file(hnd, data, (unsigned long)numdata, &written, 0); } inline file_handle_t invalid_file() { return winapi::invalid_handle_value; } inline bool close_file(file_handle_t hnd) { return 0 != winapi::close_handle(hnd); } inline bool acquire_file_lock(file_handle_t hnd) { static winapi::interprocess_overlapped overlapped; const unsigned long len = 0xffffffff; // winapi::interprocess_overlapped overlapped; // std::memset(&overlapped, 0, sizeof(overlapped)); return winapi::lock_file_ex (hnd, winapi::lockfile_exclusive_lock, 0, len, len, &overlapped); } inline bool try_acquire_file_lock(file_handle_t hnd, bool &acquired) { const unsigned long len = 0xffffffff; winapi::interprocess_overlapped overlapped; std::memset(&overlapped, 0, sizeof(overlapped)); if(!winapi::lock_file_ex (hnd, winapi::lockfile_exclusive_lock | winapi::lockfile_fail_immediately, 0, len, len, &overlapped)){ return winapi::get_last_error() == winapi::error_lock_violation ? acquired = false, true : false; } return (acquired = true); } inline bool release_file_lock(file_handle_t hnd) { const unsigned long len = 0xffffffff; winapi::interprocess_overlapped overlapped; std::memset(&overlapped, 0, sizeof(overlapped)); return winapi::unlock_file_ex(hnd, 0, len, len, &overlapped); } inline bool acquire_file_lock_sharable(file_handle_t hnd) { const unsigned long len = 0xffffffff; winapi::interprocess_overlapped overlapped; std::memset(&overlapped, 0, sizeof(overlapped)); return winapi::lock_file_ex(hnd, 0, 0, len, len, &overlapped); } inline bool try_acquire_file_lock_sharable(file_handle_t hnd, bool &acquired) { const unsigned long len = 0xffffffff; winapi::interprocess_overlapped overlapped; std::memset(&overlapped, 0, sizeof(overlapped)); if(!winapi::lock_file_ex (hnd, winapi::lockfile_fail_immediately, 0, len, len, &overlapped)){ return winapi::get_last_error() == winapi::error_lock_violation ? acquired = false, true : false; } return (acquired = true); } inline bool release_file_lock_sharable(file_handle_t hnd) { return release_file_lock(hnd); } #else //#if (defined BOOST_WINDOWS) && !(defined BOOST_DISABLE_WIN32) typedef int file_handle_t; typedef off_t offset_t; typedef file_handle_t mapping_handle_t; typedef enum { read_only = O_RDONLY , read_write = O_RDWR , copy_on_write , invalid_mode = 0xffff } mode_t; typedef enum { file_begin = SEEK_SET , file_end = SEEK_END , file_current = SEEK_CUR } file_pos_t; namespace detail{ inline mapping_handle_t mapping_handle_from_file_handle(file_handle_t hnd) { return hnd; } inline file_handle_t file_handle_from_mapping_handle(mapping_handle_t hnd) { return hnd; } inline bool create_directory(const char *path) { return ::mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH) == 0; } inline const char *get_temporary_path() { const char *dir = std::getenv("TMPDIR"); if(!dir){ dir = std::getenv("TMP"); if(!dir){ dir = std::getenv("TEMP"); if(!dir){ dir = "/tmp"; } } } return dir; } inline file_handle_t create_new_file (const char *name, mode_t mode = read_write, bool temporary = false) { (void)temporary; return ::open(name, ((int)mode) | O_EXCL | O_CREAT, S_IRWXG | S_IRWXO | S_IRWXU); } inline file_handle_t create_or_open_file (const char *name, mode_t mode = read_write, bool temporary = false) { (void)temporary; return ::open(name, ((int)mode) | O_CREAT, S_IRWXG | S_IRWXO | S_IRWXU); } inline file_handle_t open_existing_file (const char *name, mode_t mode = read_write, bool temporary = false) { (void)temporary; return ::open(name, (int)mode, S_IRWXG | S_IRWXO | S_IRWXU); } inline bool delete_file(const char *name) { return ::unlink(name) == 0; } inline bool truncate_file (file_handle_t hnd, std::size_t size) { return 0 == ::ftruncate(hnd, size); } inline bool get_file_size(file_handle_t hnd, offset_t &size) { struct stat data; bool ret = 0 == ::fstat(hnd, &data); if(ret){ size = data.st_size; } return ret; } inline bool set_file_pointer(file_handle_t hnd, offset_t off, file_pos_t pos) { return off == lseek(hnd, off, (int)pos); } inline bool get_file_pointer(file_handle_t hnd, offset_t &off) { off = lseek(hnd, 0, SEEK_CUR); return off != ((off_t)-1); } inline bool write_file(file_handle_t hnd, const void *data, std::size_t numdata) { return (ssize_t(numdata)) == ::write(hnd, data, numdata); } inline file_handle_t invalid_file() { return -1; } inline bool close_file(file_handle_t hnd) { return ::close(hnd) == 0; } inline bool acquire_file_lock(file_handle_t hnd) { struct ::flock lock; lock.l_type = F_WRLCK; lock.l_whence = SEEK_SET; lock.l_start = 0; lock.l_len = 0; return -1 != ::fcntl(hnd, F_SETLKW, &lock); } inline bool try_acquire_file_lock(file_handle_t hnd, bool &acquired) { struct ::flock lock; lock.l_type = F_WRLCK; lock.l_whence = SEEK_SET; lock.l_start = 0; lock.l_len = 0; int ret = ::fcntl(hnd, F_SETLK, &lock); if(ret == -1){ return (errno != EAGAIN && errno != EACCES) ? acquired = false, true : false; } return (acquired = true); } inline bool release_file_lock(file_handle_t hnd) { struct ::flock lock; lock.l_type = F_UNLCK; lock.l_whence = SEEK_SET; lock.l_start = 0; lock.l_len = 0; return -1 != ::fcntl(hnd, F_SETLK, &lock); } inline bool acquire_file_lock_sharable(file_handle_t hnd) { struct ::flock lock; lock.l_type = F_RDLCK; lock.l_whence = SEEK_SET; lock.l_start = 0; lock.l_len = 0; return -1 != ::fcntl(hnd, F_SETLKW, &lock); } inline bool try_acquire_file_lock_sharable(file_handle_t hnd, bool &acquired) { struct flock lock; lock.l_type = F_RDLCK; lock.l_whence = SEEK_SET; lock.l_start = 0; lock.l_len = 0; int ret = ::fcntl(hnd, F_SETLK, &lock); if(ret == -1){ return (errno != EAGAIN && errno != EACCES) ? acquired = false, true : false; } return (acquired = true); } inline bool release_file_lock_sharable(file_handle_t hnd) { return release_file_lock(hnd); } #endif //#if (defined BOOST_WINDOWS) && !(defined BOOST_DISABLE_WIN32) } //namespace detail{ } //namespace interprocess { } //namespace boost { #include #endif //BOOST_INTERPROCESS_DETAIL_OS_FILE_FUNCTIONS_HPP