Reader-Writer Synchronization

This project demonstrates the classical Reader-Writer problem using C++ threads, mutexes, and semaphores. The goal is to manage concurrent access to a shared resource by multiple readers and a single writer, ensuring data consistency and preventing race conditions.

Project Structure

• include/

  • reader.hpp: Header file for the Reader class.
  • writer.hpp: Header file for the Writer class.
  • shared_data.hpp: Header file for the SharedData class.

• src/

  • main.cpp: Entry point of the application.
  • reader.cpp: Implementation of the Reader class.
  • writer.cpp: Implementation of the Writer class.
  • shared_data.cpp: Implementation of the SharedData class.

• logs/

  • log.txt: Log file for application output.

• config files

  • ./compile_flags.txt: Compilation flags for the project.
  • ./secrets: Environment variable configuration file.

Getting Started

Prerequisites

• C++23 or later
• CMake
• Make

Building the Project

1. Clone the repository: sh git clone [email protected]:machine-moon/rw_sync.git cd rw_sync

2. Create a build directory: sh make cmake

3. Build the project using Ninja: sh make build

Other Make Commands

• clean: Remove the binary directory. sh make clean

• wipe: Remove the binary, build, and log directories. sh make wipe

• fresh: Clean the project and rebuild everything from scratch. sh make fresh

• run: Build the project and run the latest executable. sh make run

• log: Display the latest log file. sh make log

Running the Application

1. Set the environment variable for the number of readers: sh export READERS_COUNT=2 export WRITERS_COUNT=2

2. Run the application: sh ./rw_sync

Code Overview

Reader Class

The Reader class simulates a reader that periodically reads from a shared resource. It uses mutexes and semaphores to ensure safe concurrent access.

Writer Class

The Writer class simulates a writer that periodically writes to a shared resource. It uses a semaphore to ensure exclusive access to the resource.

SharedData Class

The SharedData class manages the shared resource accessed by readers and writers. It provides thread-safe methods to interact with the data.

Main Function

The main.cpp file initializes the readers and writer, starts their threads, and manages their lifecycle.

License

This project is licensed under the MIT License. See the LICENSE file for details.