# sara-l-s-silva/ep-multithreaded-quicksort architecture

> Architecture diagram of the GitHub repository sara-l-s-silva/ep-multithreaded-quicksort, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sara-l-s-silva/ep-multithreaded-quicksort
- Repository: https://github.com/sara-l-s-silva/ep-multithreaded-quicksort

## Overview

##### Project type and purpose
- This is a standalone CLI tool written in C, implementing a multithreaded QuickSort over a binary file of fixed-size records.

##### File structure
- Top level files:
- Makefile – build automation
- ep_input_generator.c – binary-file generator
- ep.c – main program with multithreaded QuickSort logic
- ep_output_verificator.c – post-sort validator
- mapeamentoInput.c – memory-mapping helper (likely wraps mmap calls)
- 10_registros_ja_ordenados.dat, output/… – sample data and outputs
- No “frontend” or network layers – it’s purely a local, compute-bound tool.
- Relies on POSIX threads and mmap for performance.

##### README for insights
- Clearly outlines the three stages: generate, sort, verify
- Emphasizes user-controlled thread count and use of mmap
- Goal: demonstrate parallel sorting performance on large files

a. Main components
1. CLI / User Interface
2. Input Generator Module
3. Memory-Mapping Layer
4. Sorting Engine (Thread Pool + Quicksort)
5. Merge/Interleave Logic
6. Output Writer
7. Output Verifier Module
b. Relationships and data flow
- User invokes ep_input_generator → writes binary file
- User invokes ep with args → main() calls mmap helper to map input file
- Sorting Engine spawns N pthreads, each sorts a segment in‐memory
- Once all threads complete, merge logic interleaves sorted segments
- Sorted buffer is written back (msync or write) to output file
- ep_output_verificator reads output file (possibly via mmap) and checks order
c. Architectural patterns / design principles
- Pipeline pattern: generator → mapper → sorter → merger → verifier
- Worker-pool (thread pool) pattern for parallel sorting
- Shared-memory via mmap to avoid explicit read/write loops
- Separation of concerns: each C file is a self-contained module
d. Key technologies/libraries
- POSIX threads (pthread_create, pthread_join)
- Memory mapping (mmap, msync, munmap)
- Standard C I/O for file creation/verifier
- Makefile for build targets

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CLI and Utilities
    CLI["CLI / User Interface"]:::compute
    Logger["Color/Logging Utility"]:::util
    Makefile["Build Automation\n(Makefile)"]:::util
    README["Documentation / Usage Guide\n(README.md)"]:::util

    %% Sample and Output Files
    DiskFile["Sample Input File\n(10_registros_ja_ordenados.dat)"]:::io
    OutputDir["Output Directory\n(output/)"]:::io
    OutputFiles["Output Files\n(output/14677190, saida.txt)"]:::io

    %% Binaries and Modules
    subgraph "ep_input_generator"
        InputGen["Input Generator Module"]:::io
    end
    subgraph "ep"
        Mapper["Memory-Mapping Layer"]:::io
        SortEngine["Sorting Engine\n(Thread Pool + Quicksort)"]:::compute
        MergeWriter["Merge/Interleave & Output Writer"]:::compute
    end
    subgraph "ep_output_verificator"
        Verifier["Output Verifier Module"]:::io
    end

    %% Data and Control Flow
    CLI -->|"generate command"| InputGen
    InputGen -->|"binary file"| DiskFile
    CLI -->|"sort command\n(thread count)"| Mapper
    DiskFile -->|"mapped buffer"| Mapper
    Mapper -->|"buffer ptr"| SortEngine
    SortEngine -->|"sorted segments"| MergeWriter
    MergeWriter -->|"sorted file"| OutputFiles
    OutputFiles -->|"verify"| Verifier
    Verifier -->|"result"| CLI

    %% Logger Usage
    Logger -.-> InputGen
    Logger -.-> Mapper
    Logger -.-> SortEngine
    Logger -.-> MergeWriter
    Logger -.-> Verifier

    %% Build and Docs
    CLI -.-> Makefile
    CLI -.-> README

    %% Click Events
    click CLI "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/ep.c"
    click InputGen "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/ep_input_generator.c"
    click Mapper "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/mapeamentoInput.c"
    click SortEngine "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/ep.c"
    click MergeWriter "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/ep.c"
    click Verifier "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/ep_output_verificator.c"
    click Logger "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/color.c"
    click Makefile "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/tree/main/Makefile"
    click README "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/README.md"
    click DiskFile "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/blob/main/10_registros_ja_ordenados.dat"
    click OutputDir "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/tree/main/output/"
    click OutputFiles "https://github.com/sara-l-s-silva/ep-multithreaded-quicksort/tree/main/output/14677190"

    %% Styles
    classDef io fill:#AED6F1,stroke:#1F618D,color:#1B4F72;
    classDef compute fill:#ABEBC6,stroke:#27AE60,color:#145A32;
    classDef util fill:#E5E7E9,stroke:#566573,color:#2C3E50;
```
