Skip to main content

memkv-lmcache

LMCache StoragePluginInterface backend that persists KV chunks in a remote MemKV cluster. Loaded as a vendor plugin via LMCache's storage_plugins dynamic loader — no patches to LMCache's tree.

vLLM gets a MemKV-backed prefix KV-state path for free through vllm/distributed/kv_transfer/kv_connector/v1/lmcache_connector.py — no separate vLLM connector package is required.

Build

cd lmcache-plugin
pip install maturin
maturin develop --release      # local dev install
# or
maturin build --release        # wheel under target/wheels/
pip install target/wheels/memkv_lmcache-*.whl

The wheel bundles a native PyO3 extension built from the same memkv-client crate the NIXL plugin and the sglang plugin use, so RDMA/TCP transport selection works the same way across all three.

Configure the MemKV connection

The plugin reads the standard MemKV config chain — MEMKV_CONFIG yaml first, then MEMKV_* env vars:

export MEMKV_SERVERS="10.0.0.10:9900,10.0.0.11:9900"
export MEMKV_RDMA_DEVICES="mlx5_0,mlx5_1"
export MEMKV_AUTH_KEY="<64-hex>"
# optional:
# export MEMKV_TRANSPORT=auto
# export MEMKV_CONFIG=/etc/memkv.yaml

Configure LMCache

Add the plugin to your LMCache yaml. max_local_cpu_size must be > 0 because the plugin uses LocalCPUBackend's allocator to stage retrieved tensors:

chunk_size: 64
local_cpu: true
max_local_cpu_size: 5
storage_plugins: memkv
extra_config:
  storage_plugin.memkv.module_path: memkv_lmcache.backend
  storage_plugin.memkv.class_name: MemKVStorageBackend

Launch vLLM with LMCache + MemKV

LMCACHE_CONFIG_FILE=/etc/lmcache.yaml \
KV_TRANSFER_CONFIG='{"kv_connector":"LMCacheConnectorV1","kv_role":"kv_both"}' \
vllm serve meta-llama/Llama-3-8B \
    --tensor-parallel-size 1 \
    --kv-transfer-config "$KV_TRANSFER_CONFIG"

LMCache's connector picks the storage_plugins entry up at startup and routes prefix KV reads/writes through MemKVStorageBackend.

MP mode: MemKV as an L2 adapter

LMCache's multi-process mode (lmcache server + LMCacheMPConnector) — currently the only LMCache configuration that attaches to hybrid Mamba/attention models — persists L1 overflow through a different surface, the L2AdapterInterface. memkv_lmcache.l2_adapter implements it, loaded via LMCache's built-in plugin adapter type:

lmcache server --chunk-size <unified_block> --l1-size-gb 256 \
    --eviction-policy LRU \
    --l2-adapter '{"type":"plugin",
                   "module_path":"memkv_lmcache.l2_adapter",
                   "class_name":"MemKVL2Adapter",
                   "adapter_params":{"prefix":"fleet-a"}}'

The MemKV connection comes from the same MEMKV_CONFIG / MEMKV_* env chain; adapter_params carries only adapter tuning (prefix, num_workers, blocks_per_op, load_failure_grace_s — see the module docstring). Unlike the classic backend, the L2 port needs no shape sidecars (the controller owns every buffer), so values written by one server instance are readable by any other — including across lmcache server restarts.

What's implemented

Method Status
contains yes (in-process _meta check — a key only counts as present when its shape/dtype metadata is on file, so a fresh process reports miss for server-resident bytes it cannot reconstruct); batched_contains falls through to StoragePluginInterface's default loop
exists_in_put_tasks yes (in-process tracking set)
batched_submit_put_task yes (synchronous; returns None)
get_blocking yes (requires prior put in this process — see Caveats)
remove yes
pin / unpin yes (presence-check only — wire layer has no per-client retention)
get_allocator_backend yes (delegates to LocalCPUBackend)
close yes

Caveats

  • Cross-restart warm cache is limited. Each engine process keeps shape/dtype/fmt in an in-memory dict so get_blocking knows what MemoryObj to allocate. The wire bytes survive in MemKV across restarts; the local metadata does not. A fresh process therefore starts cold even when MemKV holds the chunks. This matches LMCache's LocalDiskBackend behavior. Encoding the shape header on the wire is a follow-up.
  • Key length cap. MemKV's protocol caps keys at 512 bytes, so a CacheEngineKey.to_string() value longer than 480 bytes collapses to a memkv-h2:<blake2b-256> digest.
  • Pin/unpin are local-only. MemKV has no per-client retention policy, so the methods are presence checks against the local meta dict. Server-side eviction is owned by the MemKV cluster.
  • Reads ride the server-driven chunked BatchRead. get_blocking uses batch_get_into, which streams the full value through the server's bounce buffers into per-thread staging with strict full-length-or-miss semantics. The single-key zero-copy get_into (client-driven RDMA READ) remains available but is not the LMCache default: under sustained burst load it saturated the per-connection RC send CQ tail and tripped vLLM's SPMD broadcast timeout, and it faults the value resident server-side.

Layout

lmcache-plugin/
├── Cargo.toml                      # cdylib + pyo3 + memkv-client
├── pyproject.toml                  # maturin
├── src/lib.rs                      # PyO3 wrapper around memkv-client::Engine
└── python/memkv_lmcache/
    ├── __init__.py                 # re-exports Client
    └── backend.py                  # MemKVStorageBackend(StoragePluginInterface)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

memkv_lmcache-1.0.5-cp38-abi3-manylinux_2_28_x86_64.whl (1.5 MB view details)

Uploaded CPython 3.8+manylinux: glibc 2.28+ x86-64

memkv_lmcache-1.0.5-cp38-abi3-manylinux_2_28_aarch64.whl (1.4 MB view details)

Uploaded CPython 3.8+manylinux: glibc 2.28+ ARM64

File details

Details for the file memkv_lmcache-1.0.5-cp38-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for memkv_lmcache-1.0.5-cp38-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 7c19d7c9d5bb334f146bf12733ac769cc9373a88e0b3e8b7c411230324a5b6a9
MD5 b2a0fb569444338a71edaf89936dc95b
BLAKE2b-256 a41cd7ec537b922b9adfa6699e052c5fbb5782f5f8afb711b22a07928340b19e

See more details on using hashes here.

File details

Details for the file memkv_lmcache-1.0.5-cp38-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for memkv_lmcache-1.0.5-cp38-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 7760d15e781b5425e84de5848daf7a63385a017756e05162a7dbf4742a0a32b4
MD5 e0b148fab267724415543879373e2d92
BLAKE2b-256 3746aaa07baa303090887824b360a8a72a4f5919871c6508bf983db99e620e1a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page