# mikage-emu/mikage-dev architecture

> Architecture diagram of the GitHub repository mikage-emu/mikage-dev, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mikage-emu/mikage-dev
- Repository: https://github.com/mikage-emu/mikage-dev

## Overview

##### Main Components

a) Core Emulation Layer
- ARM CPU Emulation (/source/arm/)
- Memory Management (/source/memory.h)
- OS/Kernel Emulation (/source/os/)
- IPC System (/source/ipc/)

b) Hardware Emulation Layer
- GPU/PICA Emulation (/source/video_core/)
- DSP Audio (/source/hardware/dsp/)
- Input System (/source/input/)
- Controller (/source/display/)

c) Frontend Systems
- SDL-based GUI (/source/gui-sdl/)
- Audio Frontend
- Vulkan Renderer (/source/video_core/src/video_core/vulkan/)

d) Debug Infrastructure
- GDB Stub (/source/gdb_stub/)
- Debug Server (/source/debug_server/)
- Debug Console

e) System Services
- Multiple System Processes (/source/processes/)
- File System Services
- Network Services
- Hardware Interface Services

##### Component Relationships

**[Frontend Layer (SDL/Vulkan)] ↔**
- [Core Emulation Layer] ↔
- [Hardware Emulation Layer] ↔
- [System Services]

**[Debug Infrastructure] ← → [All Layers]**

##### Implementation Details to Highlight

- Video pipeline: Command Processor → Shader Processing → Rasterizer → Vulkan Backend
- Process management system with key system processes
- Memory management architecture
- How the ARM CPU emulation interfaces with other components

##### Normal operation mode

Remember to add notes about the key external dependencies:
- Boost
- SDL2
- Vulkan
- Crypto++
- Range-v3

This architectural representation should help developers understand both the overall structure and the specific implementation details of the Mikage emulator.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef core fill:#2ecc71,stroke:#27ae60,color:white
    classDef hardware fill:#f1c40f,stroke:#f39c12,color:black
    classDef services fill:#9b59b6,stroke:#8e44ad,color:white
    classDef debug fill:#e74c3c,stroke:#c0392b,color:white

    %% Frontend Layer
    subgraph Frontend
        GUI["SDL-based GUI"]
        VulkanRenderer["Vulkan Renderer"]
        AudioFrontend["Audio Frontend"]
    end

    %% Core Emulation Layer
    subgraph CoreEmulation
        ARM["ARM CPU Emulation"]
        Memory["Memory Management"]
        OS["OS/Kernel Emulation"]
        IPC["IPC System"]
    end

    %% Hardware Emulation Layer
    subgraph HardwareEmulation
        GPU["GPU/PICA Emulation"]
        DSP["DSP Audio"]
        Input["Input System"]
        Display["Display Controller"]
        
        subgraph VideoPipeline
            CmdProc["Command Processor"]
            Shader["Shader Processing"]
            Rasterizer["Rasterizer"]
        end
    end

    %% System Services Layer
    subgraph SystemServices
        Processes["System Processes"]
        FileSystem["File System Services"]
        Network["Network Services"]
        HWInterface["Hardware Interface Services"]
    end

    %% Debug Infrastructure
    subgraph DebugInfra
        GDBStub["GDB Stub"]
        DebugServer["Debug Server"]
        DebugConsole["Debug Console"]
    end

    %% Relationships
    GUI --> VulkanRenderer
    GUI --> AudioFrontend
    
    Frontend --> CoreEmulation
    CoreEmulation --> HardwareEmulation
    HardwareEmulation --> SystemServices

    CmdProc --> Shader
    Shader --> Rasterizer
    Rasterizer --> VulkanRenderer

    DebugInfra -.-> Frontend
    DebugInfra -.-> CoreEmulation
    DebugInfra -.-> HardwareEmulation
    DebugInfra -.-> SystemServices

    %% External Dependencies
    ExternalDeps["External Dependencies:|Boost|SDL2|Vulkan|Crypto++|Range-v3"]

    %% Styling
    class GUI,VulkanRenderer,AudioFrontend frontend
    class ARM,Memory,OS,IPC core
    class GPU,DSP,Input,Display,CmdProc,Shader,Rasterizer hardware
    class Processes,FileSystem,Network,HWInterface services
    class GDBStub,DebugServer,DebugConsole debug

    %% Click events
    click ARM "https://github.com/mikage-emu/mikage-dev/tree/main//source/arm/"
    click Memory "https://github.com/mikage-emu/mikage-dev/blob/main//source/memory.h"
    click OS "https://github.com/mikage-emu/mikage-dev/blob/main//source/os.hpp"
    click IPC "https://github.com/mikage-emu/mikage-dev/blob/main//source/ipc.hpp"
    click GPU "https://github.com/mikage-emu/mikage-dev/tree/main//source/video_core/src/video_core/"
    click DSP "https://github.com/mikage-emu/mikage-dev/blob/main//source/hardware/dsp.hpp"
    click Input "https://github.com/mikage-emu/mikage-dev/blob/main//source/input.hpp"
    click Display "https://github.com/mikage-emu/mikage-dev/blob/main//source/display.hpp"
    click GUI "https://github.com/mikage-emu/mikage-dev/tree/main//source/gui-sdl/"
    click VulkanRenderer "https://github.com/mikage-emu/mikage-dev/tree/main//source/video_core/src/video_core/vulkan/"
    click GDBStub "https://github.com/mikage-emu/mikage-dev/blob/main//source/gdb_stub.h"
    click DebugServer "https://github.com/mikage-emu/mikage-dev/blob/main//source/debug_server.hpp"
    click Processes "https://github.com/mikage-emu/mikage-dev/tree/main//source/processes/"
    click CmdProc "https://github.com/mikage-emu/mikage-dev/blob/main//source/video_core/src/video_core/command_processor.h"
    click Shader "https://github.com/mikage-emu/mikage-dev/blob/main//source/video_core/src/video_core/shader.hpp"
    click Rasterizer "https://github.com/mikage-emu/mikage-dev/blob/main//source/video_core/src/video_core/rasterizer.h"
```
