initial release

Author: j2doll

CMakeLists.txt

@@ -0,0 +1,33 @@
+cmake_minimum_required(VERSION 3.16)
+project(shared_memory_boost_ipc LANGUAGES CXX)
+
+if(NOT UNIX OR APPLE)
+  message(FATAL_ERROR "This project supports Linux only.")
+endif()
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+find_package(Boost REQUIRED COMPONENTS)
+
+add_subdirectory(writer)
+add_subdirectory(reader)
+
+###################################
+# Building commands (Case Rocky Linux)
+###################################
+# rm -rf build
+#
+# cmake -S . -B build -DBOOST_ROOT=/usr -DBOOST_INCLUDEDIR=/usr/include -DBOOST_LIBRARYDIR=/usr/lib64   -DBoost_NO_SYSTEM_PATHS=ON -DBoost_DEBUG=ON
+#
+# cmake --build build
+#
+
+####################################
+# NOTICE:
+####################################
+# Current shared memory is not erased automatically.
+#  For reader/writer running sequence.
+# If you remove shared memory, run writer with --remove option.
+#
+

README.ko.md

@@ -1,69 +1,68 @@
-# C++ 프로젝트용 .gitignore
+# 공유 메모리 Boost IPC
 
-[English](README.md)
+[English README](README.md)
 
----
+이 프로젝트는 [Boost.Interprocess](https://www.boost.org/doc/libs/release/doc/html/interprocess.html)를 활용한 공유 메모리 기반의 프로세스 간 통신(IPC) 예제를 제공합니다. 여러 프로세스가 공유 메모리를 통해 데이터를 효율적으로 교환하는 방법을 리더와 라이터 예제를 통해 보여줍니다.
 
-이 `.gitignore` 파일은 다양한 IDE, 에디터, 빌드 시스템을 포괄하는 **C++ 프로젝트 전용 종합 무시 목록**입니다.
+## 주요 특징
+- Boost.Interprocess를 이용한 공유 메모리 통신
+- 라이터 및 리더 예제 프로그램 제공
+- CMake 기반 빌드 시스템
+- 손쉬운 통합을 위한 헤더 전용 인터페이스
 
-## 포함된 환경
-
-- **IDE / 에디터**:
-  - Visual Studio 2019/2022
-  - Visual Studio Code (VSCode)
-  - CLion / JetBrains IDE
-  - Qt Creator
-  - Eclipse CDT
-  - Xcode
-  - Neovim / Vim
-  - Emacs
-  - Sublime Text
-  - Atom
-  - Code::Blocks
-  - CodeLite
-  - KDevelop
-  - NetBeans (C/C++)
-  - Geany
-  - Dev-C++
-  - JetBrains Fleet
-  - Kate
-
-- **빌드 시스템**:
-  - CMake
-  - Ninja
-  - Meson
-  - SCons
-
-- **패키지 관리자**:
-  - Conan
-  - vcpkg
-  - Hunter
-  - CPM.cmake
-
-- **언어 서버**:
-  - clangd
-  - ccls
-  - gtags / ctags
-
-## 목적
-
-이 `.gitignore`의 목적은 다음과 같습니다:
-- 빌드 과정에서 생성되는 임시 산출물을 저장소에서 제거
-- 로컬 IDE/에디터 설정 파일을 커밋하지 않도록 방지
-- 사용자/PC별로 달라지는 캐시 및 로그 파일 제외
-
-## 사용 방법
-
-C++ 프로젝트의 루트 디렉터리에 `.gitignore` 파일을 배치합니다:
-
-```bash
-curl -o .gitignore https://example.com/path/to/.gitignore
+## 프로젝트 구조
+```
+shared_memory_boost_ipc/
+├── include/
+│   └── shared_ipc.hpp      # 공유 메모리 IPC 인터페이스
+├── reader/
+│   ├── reader.cpp          # 리더 예제
+│   └── CMakeLists.txt      # 리더 빌드 설정
+├── writer/
+│   ├── writer.cpp          # 라이터 예제
+│   └── CMakeLists.txt      # 라이터 빌드 설정
+├── CMakeLists.txt          # 최상위 빌드 설정
+├── LICENSE                 # 라이선스 정보
+├── README.md               # 프로젝트 문서
 ```
 
-Git은 `.gitignore`에 명시된 패턴과 일치하는 파일/디렉터리를 자동으로 무시합니다.
-
-## 참고 사항
-
-- `.gitignore`에 포함되어 있어도 특정 파일을 강제로 추가하려면 `git add -f <file>` 명령을 사용하세요.
-- `Makefile`을 직접 관리하는 경우, `.gitignore`의 `Makefile` 항목을 삭제하세요.
+## 필요 환경
+- C++17 이상
+- [Boost](https://www.boost.org/) 라이브러리 (Interprocess 모듈)
+- CMake 3.10+
+
+## 빌드 방법
+1. Boost를 설치하세요 (`boost_system` 및 `boost_interprocess` 모듈 필요).
+2. 저장소를 클론합니다:
+   ```sh
+   git clone https://github.com/JayTwoLab/shared_memory_boost_ipc.git
+   cd shared_memory_boost_ipc
+   ```
+3. 빌드 디렉터리를 만들고 CMake를 실행합니다:
+   ```sh
+   mkdir build
+   cd build
+   cmake ..
+   cmake --build .
+   ```
+    - For fast search boost 
+    ```sh
+    cmake -S . -B build -DBOOST_ROOT=/usr -DBOOST_INCLUDEDIR=/usr/include -DBOOST_LIBRARYDIR=/usr/lib64   -DBoost_NO_SYSTEM_PATHS=ON -DBoost_DEBUG=ON
+    ```   
+4. 리더와 라이터 실행 파일이 각 폴더에 생성됩니다.
 
+## 사용 방법
+1. 라이터 프로세스를 실행하여 공유 메모리에 데이터를 작성합니다:
+   ```sh
+   ./writer/writer
+   ```
+2. 리더 프로세스를 실행하여 공유 메모리에서 데이터를 읽습니다:
+   ```sh
+   ./reader/reader
+   ```
+
+## 라이선스
+이 프로젝트는 저장소의 LICENSE 파일에 명시된 조건에 따라 라이선스가 적용됩니다.
+
+## 참고 자료
+- [Boost.Interprocess 공식 문서](https://www.boost.org/doc/libs/release/doc/html/interprocess.html)

README.md

@@ -1,70 +1,68 @@
-# C++ Project .gitignore
+# Shared Memory Boost IPC
 
+[Korean README](README.ko.md)
 
-[Korean](README.ko.md)
+This project demonstrates inter-process communication (IPC) using shared memory with [Boost.Interprocess](https://www.boost.org/doc/libs/release/doc/html/interprocess.html). It provides simple reader and writer examples to show how multiple processes can exchange data efficiently via shared memory.
 
----
+## Features
+- Shared memory communication using Boost.Interprocess
+- Example writer and reader applications
+- CMake-based build system
+- Header-only interface for easy integration
 
-This `.gitignore` file is a **comprehensive ignore list** for C++ projects, covering a wide range of IDEs, editors, and build systems.
-
-## Included Environments
-
-- **IDEs / Editors**:
-  - Visual Studio 2019/2022
-  - Visual Studio Code (VSCode)
-  - CLion / JetBrains IDEs
-  - Qt Creator
-  - Eclipse CDT
-  - Xcode
-  - Neovim / Vim
-  - Emacs
-  - Sublime Text
-  - Atom
-  - Code::Blocks
-  - CodeLite
-  - KDevelop
-  - NetBeans (C/C++)
-  - Geany
-  - Dev-C++
-  - JetBrains Fleet
-  - Kate
-
-- **Build systems**:
-  - CMake
-  - Ninja
-  - Meson
-  - SCons
-
-- **Package managers**:
-  - Conan
-  - vcpkg
-  - Hunter
-  - CPM.cmake
-
-- **Language servers**:
-  - clangd
-  - ccls
-  - gtags / ctags
-
-## Purpose
-
-This `.gitignore` aims to:
-- Keep repositories clean from temporary build outputs.
-- Avoid committing local IDE/editor configuration files.
-- Exclude cache and log files that are machine/user-specific.
-
-## Usage
-
-Place the `.gitignore` file in the root of your C++ project:
-
-```bash
-curl -o .gitignore https://example.com/path/to/.gitignore
+## Project Structure
+```
+shared_memory_boost_ipc/
+├── include/
+│   └── shared_ipc.hpp      # Shared memory IPC interface
+├── reader/
+│   ├── reader.cpp          # Reader example
+│   └── CMakeLists.txt      # Reader build config
+├── writer/
+│   ├── writer.cpp          # Writer example
+│   └── CMakeLists.txt      # Writer build config
+├── CMakeLists.txt          # Top-level build config
+├── LICENSE                 # License information
+├── README.md               # Project documentation
 ```
 
-Git will automatically ignore files and directories matching the patterns.
-
-## Notes
-
-- If you need to track some files listed in `.gitignore`, use `git add -f <file>` to force-add them.
-- If you are manually managing `Makefile`, remove the `Makefile` entry in this `.gitignore`.
+## Prerequisites
+- C++17 or later
+- [Boost](https://www.boost.org/) library (Interprocess module)
+- CMake 3.10+
+
+## Build Instructions
+1. Install Boost (ensure `boost_system` and `boost_interprocess` are available).
+2. Clone this repository:
+	```sh
+	git clone https://github.com/JayTwoLab/shared_memory_boost_ipc.git
+	cd shared_memory_boost_ipc
+	```
+3. Create a build directory and run CMake:
+	```sh
+	mkdir build
+	cd build
+	cmake ..
+	cmake --build .
+	```
+    - For fast search boost 
+    ```sh
+    cmake -S . -B build -DBOOST_ROOT=/usr -DBOOST_INCLUDEDIR=/usr/include -DBOOST_LIBRARYDIR=/usr/lib64   -DBoost_NO_SYSTEM_PATHS=ON -DBoost_DEBUG=ON
+    ```
+4. The executables for the reader and writer will be built in their respective folders.
 
+## Usage
+1. Start the writer process to create and write data to shared memory:
+	```sh
+	./writer/writer
+	```
+2. Start the reader process to read data from shared memory:
+	```sh
+	./reader/reader
+	```
+
+## License
+This project is licensed under the terms of the LICENSE file in this repository.
+
+## References
+- [Boost.Interprocess Documentation](https://www.boost.org/doc/libs/release/doc/html/interprocess.html)

include/shared_ipc.hpp

@@ -0,0 +1,90 @@
+#pragma once
+
+#include <boost/interprocess/managed_shared_memory.hpp>
+#include <boost/interprocess/shared_memory_object.hpp>
+#include <boost/interprocess/sync/interprocess_mutex.hpp>
+#include <boost/interprocess/sync/interprocess_condition.hpp>
+
+#include <atomic>
+#include <cstdint>
+#include <csignal>
+#include <cstring>
+#include <string>
+#include <thread>
+#include <chrono>
+
+namespace ipc
+{
+namespace bip = boost::interprocess;
+
+inline constexpr const char* k_segment_name = "demo_shared_segment"; // name of the shared memory segment
+inline constexpr const char* k_object_name  = "demo_shared_object"; // name of the shared object within the segment. sub object of shared memory segment. 
+inline constexpr std::size_t k_segment_size = 1 * 1024 * 1024; // 1 MB. you must ensure this is enough for your data. check sizeof(shared_payload).
+
+struct shared_payload
+{
+  std::uint32_t magic = 0xAABBCCDD; // unique identifier for the shared object
+  std::uint32_t version = 1; // version of the shared object structure
+
+  std::uint64_t sequence = 0; // incrementing sequence number
+  std::uint64_t unix_ms = 0; // timestamp in milliseconds since epoch
+
+  char message[256]{}; // user data. you can adjust size as needed.
+
+  bip::interprocess_mutex mutex; // mutex for synchronizing access
+  bip::interprocess_condition cond; // condition variable for signaling updates
+};
+
+inline void copy_cstr(char* dst, std::size_t dst_size, const char* src)
+{
+  if (!dst || dst_size == 0) return;
+  if (!src) { dst[0] = '\0'; return; }
+  std::strncpy(dst, src, dst_size - 1);
+  dst[dst_size - 1] = '\0';
+}
+
+class shutdown_flag
+{
+public:
+  shutdown_flag()
+  {
+    instance_ptr() = this;
+    std::signal(SIGINT, &shutdown_flag::signal_handler);
+    std::signal(SIGTERM, &shutdown_flag::signal_handler);
+  }
+
+  bool is_set() const
+  {
+    return stop_.load(std::memory_order_relaxed);
+  }
+
+private:
+  static shutdown_flag*& instance_ptr()
+  {
+    static shutdown_flag* ptr = nullptr;
+    return ptr;
+  }
+
+  static void signal_handler(int)
+  {
+    if (instance_ptr())
+      instance_ptr()->stop_.store(true, std::memory_order_relaxed);
+  }
+
+  std::atomic<bool> stop_{false};
+};
+
+inline std::uint64_t now_unix_ms()
+{
+  using namespace std::chrono;
+  return static_cast<std::uint64_t>(
+    duration_cast<milliseconds>(system_clock::now().time_since_epoch()).count()
+  );
+}
+
+inline void sleep_ms(int ms)
+{
+  std::this_thread::sleep_for(std::chrono::milliseconds(ms));
+}
+
+} // namespace ipc