# xmrig/xmrig-amd architecture

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

- Interactive diagram: https://gitdiagram.com/xmrig/xmrig-amd
- Repository: https://github.com/xmrig/xmrig-amd

## Overview

##### Project type and purpose
- This is an open-source, high-performance Monero (XMR) miner targeting AMD GPUs via OpenCL. It provides a command-line interface (CLI), automatic GPU configuration, failover mining server support, and an HTTP API for remote control.

##### File structure
- Top-level files:
- CMakeLists.txt, cmake/… → build and platform configuration
- README.md, LICENSE, CHANGELOG.md
- config.json → default JSON configuration
- src/… directories (all C++ source):
- src/App*.cpp, src/Mem*.cpp, src/Summary.cpp → application entry points, platform abstractions
- src/core → Config loader, Controller orchestrator
- src/api → HTTP API server, router, network state
- src/net & src/common/net → mining-pool TCP/TLS client, job submission, strategies (failover, single-pool)
- src/amd → AMD-specific OpenCL context, kernel compilation, cache, GPU threads
- src/crypto → CryptoNight implementations (CPU asm, GPU OpenCL .cl files), soft AES, hash libraries
- src/workers → thread and worker abstractions, CPU & OpenCL worker threads, hashrate reporting
- src/base, src/common → I/O, JSON parsing (rapidjson), logging backends, filesystem watchers, argument parsing, platform utilities
- src/interfaces → core interface definitions (IConfig, IWorker, IJobResultListener, etc.)

##### README for additional insights
- Confirms use of OpenCL, microhttpd for HTTP API, JSON config, TLS support, NiceHash compatibility, failover pool support.
- No built-in database—configuration and state are in memory or file‐based.

##### Elements
- from CLI to Config Loader
- Config Loader → Controller → Modules
- Worker → Crypto Engine → OpenCL Manager / CPU Kernels → result flows back to Worker → Network Client
- HTTP API → Controller / NetworkState
- Events flow to Logger

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Core Modules
    CLI["CLI Entry"]:::core
    Config["Configuration Subsystem"]:::core
    Controller["Controller (Orchestrator)"]:::core
    Workers["Worker Pool"]:::core
    Crypto["Crypto Engine"]:::core

    %% I/O Modules
    Network["Network Client"]:::io
    API["HTTP API Server"]:::io
    Logger["Logging Subsystem"]:::io

    %% OpenCL Manager
    OpenCL["AMD OpenCL Manager"]:::opencl

    %% External Services
    subgraph "External Services"
        Pools["Mining Pools"]:::external
        Clients["API Clients"]:::external
    end

    %% Platform Abstraction
    subgraph "Platform Abstraction"
        AppCPP["App*.cpp / xmrig.cpp / Summary.cpp"]:::platform
        MemCPP["Mem*.cpp"]:::platform
    end

    %% Relationships
    AppCPP -->|uses| CLI
    MemCPP -->|uses| CLI
    CLI -->|loads args| Config
    Config -->|provides settings| Controller
    Controller -->|initializes| Network
    Controller -->|launches| Workers
    Workers -->|fetch jobs| Network
    Workers -->|compute hashes| Crypto
    Crypto -->|delegates GPU| OpenCL
    API -->|queries stats| Controller
    API -->|queries state| Network
    Network -->|submits results| Pools
    Clients -->|calls API| API

    %% Logging events
    CLI -->|logs events| Logger
    Config -->|logs events| Logger
    Controller -->|logs events| Logger
    Network -->|logs events| Logger
    Workers -->|logs events| Logger
    Crypto -->|logs events| Logger
    OpenCL -->|logs events| Logger
    API -->|logs events| Logger

    %% Click Events
    click CLI "https://github.com/xmrig/xmrig-amd/blob/master/src/App.cpp"
    click Config "https://github.com/xmrig/xmrig-amd/blob/master/src/core/Config.cpp"
    click Controller "https://github.com/xmrig/xmrig-amd/blob/master/src/core/Controller.cpp"
    click Network "https://github.com/xmrig/xmrig-amd/blob/master/src/net/Network.cpp"
    click Workers "https://github.com/xmrig/xmrig-amd/blob/master/src/workers/Workers.cpp"
    click Crypto "https://github.com/xmrig/xmrig-amd/blob/master/src/crypto/CryptoNight.cpp"
    click OpenCL "https://github.com/xmrig/xmrig-amd/blob/master/src/amd/OclGPU.cpp"
    click API "https://github.com/xmrig/xmrig-amd/blob/master/src/api/Api.cpp"
    click Logger "https://github.com/xmrig/xmrig-amd/blob/master/src/common/log/Log.cpp"
    click AppCPP "https://github.com/xmrig/xmrig-amd/blob/master/src/App_unix.cpp"
    click MemCPP "https://github.com/xmrig/xmrig-amd/blob/master/src/Mem_unix.cpp"

    %% Styles
    classDef core fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef io fill:#90EE90,stroke:#333,stroke-width:1px
    classDef opencl fill:#FFD700,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef platform fill:#FFB6C1,stroke:#333,stroke-width:1px
```
