How microsoft/garnet works
Garnet is a RESP-compatible remote cache-store. The principal workflow is: an application uses a Garnet client, the server accepts and parses RESP commands, authenticates and dispatches them, storage sessions execute operations against Tsavorite-backed databases, and responses return through the same network path. Major branches include transactions, durability and tiered devices, object/vector/range features, extensibility, and passive clustered sharding, migration, gossip, and replication. Some subsystem links reflect README capabilities because their implementations were not sampled directly.
Main entry points: RespServerSession.cs RESP Session · ClusterSession.cs Cluster Session · MultiDatabaseManager.cs Database Manager · GarnetClient.cs Garnet Client
Components 29
Client Access
- Garnet Client
libs/client/GarnetClient.cs
Server Runtime
- TCP Server
libs/server/Servers/GarnetServerTcp.cs - RESP Session
libs/server/Resp/RespServerSession.cs - Authentication ACL
libs/server/Auth/GarnetACLAuthenticator.cs - Storage Session
libs/server/Storage/Session/StorageSession.cs
Storage Durability
- Database Manager
libs/server/Databases/MultiDatabaseManager.cs - Garnet Database
libs/server/GarnetDatabase.cs - Tsavorite Provider
libs/server/Providers/GarnetProvider.cs - Checkpoint Manager
libs/server/GarnetCheckpointManager.cs - AOF Durability
libs/server/AOF/GarnetAppendOnlyFile.cs - Device Factory
libs/storage/Tsavorite/cs/src/core/Index/CheckpointManagement/LocalStorageNamedDeviceFactory.cs - Native File Device
libs/storage/Tsavorite/cs/src/core/Device/NativeStorageDevice.cs - Azure Device
libs/storage/Tsavorite/cs/src/devices/AzureStorageDevice/AzureStorageDevice.cs
Data Features
- Transaction Manager
libs/server/Transaction/TransactionManager.cs - Vector Manager
libs/server/Resp/Vector/VectorManager.cs - DiskANN Service
libs/server/Resp/Vector/DiskANNService.cs - Range Index
libs/server/Resp/RangeIndex/RangeIndexManager.cs - BfTree Native
libs/native/bftree-garnet/NativeBfTreeMethods.cs - Custom Commands
libs/server/Custom/CustomCommandManager.cs - Lua Runner
libs/server/Lua/LuaRunner.cs
Cluster Operations
- Cluster Session
libs/cluster/Session/ClusterSession.cs - Cluster Manager
libs/cluster/Server/ClusterManager.cs - Slot State
libs/cluster/Server/ClusterManagerSlotState.cs - Replication Manager
libs/cluster/Server/Replication/ReplicationManager.cs - Gossip Service
libs/cluster/Server/Gossip/Gossip.cs - Key Migration
libs/cluster/Session/MigrateCommand.cs
Other components
- Application
- Control Plane
- Azure Blob Storage
Connections 31
- Application → Garnet Client: uses client
- Garnet Client → TCP Server: sends RESP
- TCP Server → RESP Session: accepts sessions
- RESP Session → Authentication ACL: authenticates
- RESP Session → Storage Session: dispatches commands
- RESP Session → Transaction Manager: runs transactions
- RESP Session → Custom Commands: dispatches extensions
- RESP Session → Lua Runner: runs scripts
- RESP Session → Cluster Session: dispatches cluster
- Storage Session → Database Manager: selects database
- Database Manager → Garnet Database: retrieves database
- Garnet Database → Tsavorite Provider: uses stores
- Storage Session → Vector Manager: opens vector context
- Vector Manager → DiskANN Service: updates index
- RESP Session → Range Index: runs range queries
- Range Index → BfTree Native: uses index
- Transaction Manager → AOF Durability: logs transaction
- Database Manager → Checkpoint Manager: takes checkpoints
- Database Manager → AOF Durability: recovers AOF
- Device Factory → Native File Device: creates device
- Device Factory → Azure Device: selects cloud device
- Native File Device → Garnet Database: persists segments
- Azure Device → Azure Blob Storage: reads writes blobs
- Control Plane → Cluster Session: issues commands
- Cluster Session → Cluster Manager: manages cluster
- Cluster Manager → Slot State: updates slots
- Cluster Session → Key Migration: migrates keys
- Cluster Session → Replication Manager: controls replication
- Cluster Manager → Gossip Service: shares state
- RESP Session → Garnet Client: returns replies
- Garnet Client → Application: returns results