# tikv/yatp architecture

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

- Interactive diagram: https://gitdiagram.com/tikv/yatp
- Repository: https://github.com/tikv/yatp

## Overview

##### Project type and purpose
- This is a Rust library crate (“yatp”) that implements a generic, adaptive, responsive thread‐pool.
- It is meant to be embedded in other Rust projects to schedule and execute tasks (callbacks or futures) across a dynamically adjusted set of worker threads.

##### File structure
- Top‐level:
- Cargo.toml, src/, benches/, README.md, CI configs.
- src/
- lib.rs: public API entrypoint.
- pool/: core thread‐pool implementation
– builder.rs: pool configuration and construction
– runner.rs: main scheduler loop
– spawn.rs: task submission logic
– worker.rs: worker‐thread lifecycle
– tests.rs: unit and integration tests for pool
- queue/: pluggable scheduling queues
– single_level.rs: simple FIFO queue
– priority.rs: priority‐based queue
– multilevel.rs: multi‐level feedback queue (MLFQ)
– extras.rs: other helper functions
- task/: task‐abstraction layer
– callback.rs: synchronous callback tasks
– future.rs: async Future support
- metrics.rs: runtime instrumentation and metrics collection
- pool.rs, queue.rs, task.rs: re‐exports and high‐level facades
- benches/: performance benchmarks showing usage patterns

##### README for additional insights
- Emphasis on three principles: Adaptive, Responsive, Generic
- Highlights MLFQ for advanced scheduling and built‐in Future support

##### Elements
- Clear labels for: PoolBuilder, Scheduler, Worker, Queue types, Task types, Metrics.
– API calls → PoolBuilder → Scheduler → Queue → Worker
– Worker → Metrics reporting
– Scheduler ↔ Worker (monitoring & scaling)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Public API
    subgraph "Public API"
        API["lib.rs"]:::api
    end

    %% Facades
    subgraph "High-Level Facades"
        PoolFacade["pool.rs"]:::core
        QueueFacade["queue.rs"]:::core
        TaskFacade["task.rs"]:::core
        MetricsFacade["metrics.rs"]:::metrics
    end

    %% Core Pool Module
    subgraph "Pool Module"
        Builder["builder.rs"]:::core
        Runner["runner.rs"]:::core
        Spawn["spawn.rs"]:::core
        Worker["worker.rs"]:::core
        Tests["tests.rs"]:::tests
    end

    %% Queue Strategies
    subgraph "Queue Strategy"
        FIFO["single_level.rs"]:::queue
        Priority["priority.rs"]:::queue
        MLFQ["multilevel.rs"]:::queue
        Extras["extras.rs"]:::queue
    end

    %% Task Types
    subgraph "Task Types"
        Callback["callback.rs"]:::task
        FutureType["future.rs"]:::task
    end

    %% Supporting Files
    subgraph "Supporting"
        Benches["benches/"]:::support
        Manifest["Cargo.toml"]:::support
        Readme["README.md"]:::support
        CI[".github/workflows/"]:::support
    end

    %% Relationships
    API --> PoolFacade
    API --> QueueFacade
    API --> TaskFacade
    API --> MetricsFacade

    PoolFacade --> Builder
    PoolFacade --> Runner
    PoolFacade --> Spawn
    PoolFacade --> Worker

    Spawn --> FIFO
    Spawn --> Priority
    Spawn --> MLFQ

    Runner --> FIFO
    Runner --> Worker
    Runner --> MetricsFacade
    Runner -->|"monitor"| MetricsFacade

    Worker --> Callback
    Worker --> FutureType
    Worker --> MetricsFacade

    MetricsFacade -->|"data"| Runner

    Benches --> PoolFacade
    Benches --> FIFO
    Benches --> Callback

    Tests --> Runner

    %% Click Events
    click API "https://github.com/tikv/yatp/blob/master/src/lib.rs"
    click PoolFacade "https://github.com/tikv/yatp/blob/master/src/pool.rs"
    click QueueFacade "https://github.com/tikv/yatp/blob/master/src/queue.rs"
    click TaskFacade "https://github.com/tikv/yatp/blob/master/src/task.rs"
    click MetricsFacade "https://github.com/tikv/yatp/blob/master/src/metrics.rs"
    click Builder "https://github.com/tikv/yatp/blob/master/src/pool/builder.rs"
    click Runner "https://github.com/tikv/yatp/blob/master/src/pool/runner.rs"
    click Spawn "https://github.com/tikv/yatp/blob/master/src/pool/spawn.rs"
    click Worker "https://github.com/tikv/yatp/blob/master/src/pool/worker.rs"
    click Tests "https://github.com/tikv/yatp/blob/master/src/pool/tests.rs"
    click FIFO "https://github.com/tikv/yatp/blob/master/src/queue/single_level.rs"
    click Priority "https://github.com/tikv/yatp/blob/master/src/queue/priority.rs"
    click MLFQ "https://github.com/tikv/yatp/blob/master/src/queue/multilevel.rs"
    click Extras "https://github.com/tikv/yatp/blob/master/src/queue/extras.rs"
    click Callback "https://github.com/tikv/yatp/blob/master/src/task/callback.rs"
    click FutureType "https://github.com/tikv/yatp/blob/master/src/task/future.rs"
    click Benches "https://github.com/tikv/yatp/tree/master/benches/"
    click Manifest "https://github.com/tikv/yatp/blob/master/Cargo.toml"
    click Readme "https://github.com/tikv/yatp/blob/master/README.md"
    click CI "https://github.com/tikv/yatp/tree/master/.github/workflows/"

    %% Styles
    classDef core fill:#D0E1F9,stroke:#1F4E79
    classDef api fill:#B3CDE0,stroke:#03396C
    classDef queue fill:#C7E9B4,stroke:#238b45
    classDef task fill:#FDD0A2,stroke:#e6550d
    classDef metrics fill:#FFFFB3,stroke:#ffbf00
    classDef tests fill:#F4C7C3,stroke:#c9302c
    classDef support fill:#E2E2E2,stroke:#666
```
