|
| 1 | +# SPDX-License-Identifier: Apache-2.0 |
| 2 | +# SPDX-FileCopyrightText: Copyright contributors to the vLLM project |
| 3 | +# SPDX-FileCopyrightText: Copyright 2026 InfiniLM Contributors |
| 4 | + |
| 5 | +import uuid |
| 6 | +from dataclasses import dataclass, field |
| 7 | +from typing import Optional |
| 8 | +import os |
| 9 | + |
| 10 | +KV_ROLE_CHOICES = frozenset({"kv_producer", "kv_consumer"}) |
| 11 | + |
| 12 | + |
| 13 | +@dataclass |
| 14 | +class KVTransferConfig: |
| 15 | + """Configuration for KV cache transfer in prefill/decode (P/D) separation. |
| 16 | +
|
| 17 | + Attributes: |
| 18 | + kv_connector: Name of the KV connector to use (e.g. 'MooncakeConnector'). |
| 19 | + None disables KV transfer. |
| 20 | + kv_role: Role of this node: 'kv_producer' (prefill) or 'kv_consumer' (decode). |
| 21 | + engine_id: Unique identifier for this engine instance used in KV transfers. |
| 22 | + Auto-generated (UUID) if not provided. |
| 23 | + kv_connector_extra_config: Extra configuration dict passed to the connector backend. |
| 24 | + """ |
| 25 | + |
| 26 | + kv_connector: Optional[str] = None |
| 27 | + kv_role: Optional[str] = None |
| 28 | + engine_id: Optional[str] = None |
| 29 | + kv_connector_extra_config: Optional[dict] = field(default_factory=dict) |
| 30 | + |
| 31 | + def __post_init__(self) -> None: |
| 32 | + if self.kv_connector is not None and self.kv_role is None: |
| 33 | + raise ValueError("Please specify kv_role when kv_connector is set.") |
| 34 | + |
| 35 | + if self.kv_role is not None and self.kv_role not in KV_ROLE_CHOICES: |
| 36 | + raise ValueError( |
| 37 | + f"Unsupported kv_role: {self.kv_role!r}. " |
| 38 | + f"Supported roles are {sorted(KV_ROLE_CHOICES)}" |
| 39 | + ) |
| 40 | + |
| 41 | + if self.engine_id is None: |
| 42 | + self.engine_id = f"{self.kv_role}_" + str(uuid.uuid4()) |
| 43 | + |
| 44 | + self.kv_connector_extra_config = dict(self.kv_connector_extra_config or {}) |
| 45 | + self.kv_connector_extra_config.setdefault("mooncake_protocol", "rdma") |
| 46 | + |
| 47 | + allowed_extra_config_keys = frozenset({"mooncake_protocol", "num_workers"}) |
| 48 | + unknown_keys = set(self.kv_connector_extra_config.keys()) - allowed_extra_config_keys |
| 49 | + if unknown_keys: |
| 50 | + raise ValueError( |
| 51 | + f"Unsupported kv_connector_extra_config keys: {sorted(unknown_keys)}. " |
| 52 | + f"Supported keys are {sorted(allowed_extra_config_keys)}" |
| 53 | + ) |
| 54 | + |
| 55 | + mooncake_protocol = self.kv_connector_extra_config["mooncake_protocol"] |
| 56 | + if mooncake_protocol not in ["tcp", "rdma"]: |
| 57 | + raise ValueError(f"only support tcp or rdma, but got {mooncake_protocol}") |
| 58 | + |
| 59 | + if mooncake_protocol == "tcp": |
| 60 | + # NOTE: force use tcp for Mooncake |
| 61 | + os.environ["MC_FORCE_TCP"] = "true" |
0 commit comments