# sumiiesque/mini-redis architecture

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

- Interactive diagram: https://gitdiagram.com/sumiiesque/mini-redis
- Repository: https://github.com/sumiiesque/mini-redis

## Overview

Mini-Redis is documented as a multithreaded RESP-compatible in-memory key-value server. Its intended client workflow is network event handling, worker dispatch, RESP parsing, command routing, and backend storage, with locking and MVCC implementations behind a shared interface. The source excerpts confirm the server entry point and locking backend, but the shown TCP server uses kqueue and only logs received bytes; parser, router, worker-pool, and MVCC wiring is not established by those excerpts. Documented relationships for those capabilities are therefore cited to the README.

Main entry points: [`src/network/tcp_server.cpp`](https://github.com/sumiiesque/mini-redis/blob/main/src/network/tcp_server.cpp) (TCP server), [`src/router/command_router.cpp`](https://github.com/sumiiesque/mini-redis/blob/main/src/router/command_router.cpp) (Command router), [`include/kv_backend.h`](https://github.com/sumiiesque/mini-redis/blob/main/include/kv_backend.h) (KV backend API), [`src/backend/mvcc_backend.h`](https://github.com/sumiiesque/mini-redis/blob/main/src/backend/mvcc_backend.h) (MVCC storage)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_network["Network runtime"]
  node_entry["Server entry<br/>[main.cpp]"]
  node_tcp["TCP server<br/>[tcp_server.cpp]"]
  node_reactor["Epoll reactor<br/>[epoll_reactor.cpp]"]
  node_pool["Worker pool<br/>[thread_pool.cpp]"]
  node_affinity["CPU affinity<br/>[cpu_affinity.cpp]"]
end

subgraph group_protocol["Protocol and commands"]
  node_parser["RESP parser<br/>[resp_parser.cpp]"]
  node_encoder["RESP encoder<br/>[resp_encoder.cpp]"]
  node_router["Command router<br/>[command_router.cpp]"]
  node_command["Command model<br/>[command.h]"]
  node_response["Response model<br/>[response.h]"]
end

subgraph group_storage["Storage interface"]
  node_backend_api["KV backend API<br/>[kv_backend.h]"]
end

subgraph group_locking["Locking engine"]
  node_locking["Striped locking"]
end

subgraph group_mvcc["MVCC engine"]
  node_mvcc["MVCC storage<br/>[mvcc_backend.h]"]
  node_mvcc_reclaim["Epoch reclamation<br/>[mvcc_backend.h]"]
end

node_clients(("Redis clients"))

node_entry -->|"starts"| node_tcp
node_clients -.->|"connects"| node_tcp
node_tcp -.->|"multiplexes events"| node_reactor
node_tcp -.->|"dispatches work"| node_pool
node_pool -.->|"pins threads"| node_affinity
node_tcp -.->|"receives RESP"| node_parser
node_parser -.->|"passes commands"| node_router
node_router -.->|"uses"| node_command
node_router -.->|"executes commands"| node_backend_api
node_backend_api -.->|"returns results"| node_response
node_router -.->|"encodes replies"| node_encoder
node_encoder -.->|"sends RESP"| node_clients
node_locking -->|"implements"| node_backend_api
node_mvcc -.->|"implements"| node_backend_api
node_mvcc -.->|"reclaims versions"| node_mvcc_reclaim
node_tcp -->|"accepts connections"| node_clients

click node_entry "https://github.com/sumiiesque/mini-redis/blob/main/src/main.cpp"
click node_tcp "https://github.com/sumiiesque/mini-redis/blob/main/src/network/tcp_server.cpp"
click node_reactor "https://github.com/sumiiesque/mini-redis/blob/main/src/network/epoll_reactor.cpp"
click node_pool "https://github.com/sumiiesque/mini-redis/blob/main/src/thread/thread_pool.cpp"
click node_affinity "https://github.com/sumiiesque/mini-redis/blob/main/src/thread/cpu_affinity.cpp"
click node_parser "https://github.com/sumiiesque/mini-redis/blob/main/src/protocol/resp_parser.cpp"
click node_encoder "https://github.com/sumiiesque/mini-redis/blob/main/src/protocol/resp_encoder.cpp"
click node_router "https://github.com/sumiiesque/mini-redis/blob/main/src/router/command_router.cpp"
click node_command "https://github.com/sumiiesque/mini-redis/blob/main/src/common/command.h"
click node_response "https://github.com/sumiiesque/mini-redis/blob/main/src/common/response.h"
click node_backend_api "https://github.com/sumiiesque/mini-redis/blob/main/include/kv_backend.h"
click node_locking "https://github.com/sumiiesque/mini-redis/blob/main/src/backends/locking_backend.cpp"
click node_mvcc "https://github.com/sumiiesque/mini-redis/blob/main/src/backend/mvcc_backend.h"
click node_mvcc_reclaim "https://github.com/sumiiesque/mini-redis/blob/main/src/backend/mvcc_backend.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_tcp,node_reactor,node_pool,node_affinity toneBlue
class node_parser,node_encoder,node_router,node_command,node_response,node_clients toneAmber
class node_backend_api toneMint
class node_locking toneRose
class node_mvcc,node_mvcc_reclaim toneIndigo
```

## Components

### Network runtime

- [Server entry](https://github.com/sumiiesque/mini-redis/blob/main/src/main.cpp): `src/main.cpp`
- [TCP server](https://github.com/sumiiesque/mini-redis/blob/main/src/network/tcp_server.cpp): `src/network/tcp_server.cpp`
- [Epoll reactor](https://github.com/sumiiesque/mini-redis/blob/main/src/network/epoll_reactor.cpp): `src/network/epoll_reactor.cpp`
- [Worker pool](https://github.com/sumiiesque/mini-redis/blob/main/src/thread/thread_pool.cpp): `src/thread/thread_pool.cpp`
- [CPU affinity](https://github.com/sumiiesque/mini-redis/blob/main/src/thread/cpu_affinity.cpp): `src/thread/cpu_affinity.cpp`

### Protocol and commands

- [RESP parser](https://github.com/sumiiesque/mini-redis/blob/main/src/protocol/resp_parser.cpp): `src/protocol/resp_parser.cpp`
- [RESP encoder](https://github.com/sumiiesque/mini-redis/blob/main/src/protocol/resp_encoder.cpp): `src/protocol/resp_encoder.cpp`
- [Command router](https://github.com/sumiiesque/mini-redis/blob/main/src/router/command_router.cpp): `src/router/command_router.cpp`
- [Command model](https://github.com/sumiiesque/mini-redis/blob/main/src/common/command.h): `src/common/command.h`
- [Response model](https://github.com/sumiiesque/mini-redis/blob/main/src/common/response.h): `src/common/response.h`

### Storage interface

- [KV backend API](https://github.com/sumiiesque/mini-redis/blob/main/include/kv_backend.h): `include/kv_backend.h`

### Locking engine

- [Striped locking](https://github.com/sumiiesque/mini-redis/blob/main/src/backends/locking_backend.cpp): `src/backends/locking_backend.cpp`

### MVCC engine

- [MVCC storage](https://github.com/sumiiesque/mini-redis/blob/main/src/backend/mvcc_backend.h): `src/backend/mvcc_backend.h`
- [Epoch reclamation](https://github.com/sumiiesque/mini-redis/blob/main/src/backend/mvcc_backend.h): `src/backend/mvcc_backend.h`

### Other components

- **Redis clients**

## Connections

- Server entry → TCP server: starts (evidence: `src/main.cpp`)
- Redis clients → TCP server: connects (evidence: `README.md`)
- TCP server → Epoll reactor: multiplexes events (evidence: `README.md`)
- TCP server → Worker pool: dispatches work (evidence: `README.md`)
- Worker pool → CPU affinity: pins threads (evidence: `README.md`)
- TCP server → RESP parser: receives RESP (evidence: `README.md`)
- RESP parser → Command router: passes commands (evidence: `README.md`)
- Command router → Command model: uses (evidence: `README.md`)
- Command router → KV backend API: executes commands (evidence: `README.md`)
- KV backend API → Response model: returns results (evidence: `README.md`)
- Command router → RESP encoder: encodes replies (evidence: `README.md`)
- RESP encoder → Redis clients: sends RESP (evidence: `README.md`)
- Striped locking → KV backend API: implements
- MVCC storage → KV backend API: implements (evidence: `README.md`)
- MVCC storage → Epoch reclamation: reclaims versions (evidence: `README.md`)
- TCP server → Redis clients: accepts connections (evidence: `src/network/tcp_server.cpp`)
