# errornointernet/overmask architecture

> Architecture diagram of the GitHub repository errornointernet/overmask, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/errornointernet/overmask
- Repository: https://github.com/errornointernet/overmask

## Overview

Key Components to Include:

##### Core Components
- Input Block Device (e.g., /dev/sda)
- Overlay File Storage
- Mask File Storage
- NBD (Network Block Device) Interface
- Overmask Core Logic

##### Data Flow Architecture

a) Physical Layer:
- Overlay and mask files on the same level

b) Overmask Core Layer:
- Following modules (based on src/modes):
- Device Mode Handler
- Apply Mode Handler
- Clean Mode Handler
- Block Device Manager (from block_device.rs)

c) Interface Layer:
- NBD device interface (/dev/nbd*)
- CLI argument parser (from arguments.rs)

##### Interaction Flows

- Read Operations:
- Check mask file → If masked, read from overlay → If not masked, read from source
- Write Operations:
- Write to overlay file
- Update mask file
- NBD Interface:
- Connection to kernel NBD module
- Virtual device exposure

##### Design Elements

Use the following visual elements:
- Blue rectangles for storage components (block device, overlay file, mask file)
- Green rectangles for processing components (overmask core logic)
- Yellow rectangles for interface components (NBD, CLI)

##### Additional Details

Annotations for:
- Required kernel module (nbd)
- File permissions and system requirements
- Key configuration points

Example Layout:
**[User/System] ←→ [CLI Interface]**
- ↕
**[NBD Device (/dev/nbd*)]**
- ↕
**[Overmask Core Logic]**
- ↙     ↓     ↘
**[Mask] [Overlay] [Source Block Device]**

##### Implementation Notes

- The non-destructive nature of the overlay system
- The separation between source device and overlay storage
- The role of the mask file in tracking modifications
- The virtual device interface provided by NBD

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Layer"
        User((User/System))
        CLI["CLI Interface"]:::cli
    end

    subgraph "Interface Layer"
        NBD["NBD Device\n(/dev/nbd*)"]:::interface
    end

    subgraph "Core Layer"
        OvmCore["Overmask Core Logic"]:::core
        
        subgraph "Mode Handlers"
            DevMode["Device Mode\nHandler"]:::handler
            AppMode["Apply Mode\nHandler"]:::handler
            ClnMode["Clean Mode\nHandler"]:::handler
        end
        
        BlkMgr["Block Device\nManager"]:::manager
    end

    subgraph "Storage Layer"
        MaskFile[("Mask File")]:::storage
        OvlFile[("Overlay File")]:::storage
        SrcDev[("Source Block Device\n/dev/sda")]:::storage
    end

    %% Connections
    User --> CLI
    CLI --> OvmCore
    OvmCore --> NBD
    
    OvmCore --> DevMode
    OvmCore --> AppMode
    OvmCore --> ClnMode
    
    DevMode --> BlkMgr
    AppMode --> BlkMgr
    ClnMode --> BlkMgr
    
    BlkMgr --> MaskFile
    BlkMgr --> OvlFile
    BlkMgr --> SrcDev

    %% Styles
    classDef storage fill:#3498db,stroke:#2980b9,color:white
    classDef core fill:#2ecc71,stroke:#27ae60,color:white
    classDef interface fill:#f1c40f,stroke:#f39c12,color:black
    classDef handler fill:#e74c3c,stroke:#c0392b,color:white
    classDef manager fill:#9b59b6,stroke:#8e44ad,color:white
    classDef cli fill:#34495e,stroke:#2c3e50,color:white

    %% Click Events
    click CLI "https://github.com/ErrorNoInternet/overmask/blob/main/src/arguments.rs"
    click DevMode "https://github.com/ErrorNoInternet/overmask/blob/main/src/modes/device.rs"
    click AppMode "https://github.com/ErrorNoInternet/overmask/blob/main/src/modes/apply.rs"
    click ClnMode "https://github.com/ErrorNoInternet/overmask/blob/main/src/modes/clean.rs"
    click BlkMgr "https://github.com/ErrorNoInternet/overmask/blob/main/src/block_device.rs"
    click OvmCore "https://github.com/ErrorNoInternet/overmask/blob/main/src/main.rs"

    %% Legend
    subgraph Legend
        L1["Storage"]:::storage
        L2["Core Logic"]:::core
        L3["Interface"]:::interface
        L4["Mode Handler"]:::handler
        L5["Manager"]:::manager
        L6["CLI"]:::cli
    end
```
