|
| 1 | +# SPDX-License-Identifier: Apache-2.0 |
| 2 | +# SPDX-FileCopyrightText: Copyright contributors to the vLLM project |
| 3 | + |
| 4 | +import asyncio |
| 5 | +import threading |
| 6 | +from typing import Any, Optional |
| 7 | + |
| 8 | +import uvicorn |
| 9 | +from fastapi import FastAPI |
| 10 | + |
| 11 | +from vllm import envs |
| 12 | +from vllm.config import VllmConfig |
| 13 | +from vllm.entrypoints.launcher import serve_http |
| 14 | +from vllm.logger import init_logger |
| 15 | + |
| 16 | +logger = init_logger(__name__) |
| 17 | + |
| 18 | + |
| 19 | +class NixlSideChannelServer: |
| 20 | + |
| 21 | + def __init__(self, vllm_config: VllmConfig, host: str, port: int): |
| 22 | + self.vllm_config = vllm_config |
| 23 | + self.host = host |
| 24 | + self.port = port |
| 25 | + self.app = FastAPI(title="vLLM NIXL Side Channel Server") |
| 26 | + self.server = None |
| 27 | + self.server_thread = None |
| 28 | + self._setup_routes() |
| 29 | + |
| 30 | + def _setup_routes(self): |
| 31 | + |
| 32 | + @self.app.get("/get_kv_connector_metadata") |
| 33 | + @self.app.get("/get_kv_connector_metadata/{dp_rank}") |
| 34 | + @self.app.get("/get_kv_connector_metadata/{dp_rank}/{tp_rank}") |
| 35 | + async def get_kv_connector_metadata(dp_rank: Optional[int] = None, |
| 36 | + tp_rank: Optional[int] = None): |
| 37 | + kv_meta: Optional[dict[str, dict[str, dict[str, Any]]]] = ( |
| 38 | + self.vllm_config.cache_config.transfer_handshake_metadata) |
| 39 | + |
| 40 | + if kv_meta is None: |
| 41 | + return None |
| 42 | + |
| 43 | + if dp_rank is not None: |
| 44 | + if dp_rank not in kv_meta: |
| 45 | + return {} |
| 46 | + dp_data = kv_meta[dp_rank] |
| 47 | + |
| 48 | + if tp_rank is not None: |
| 49 | + if tp_rank not in dp_data: |
| 50 | + return {} |
| 51 | + return {dp_rank: {tp_rank: dp_data[tp_rank]}} |
| 52 | + else: |
| 53 | + return {dp_rank: dp_data} |
| 54 | + |
| 55 | + return kv_meta |
| 56 | + |
| 57 | + async def start_async(self): |
| 58 | + if self.server is not None: |
| 59 | + logger.warning("Side channel server is already running") |
| 60 | + return |
| 61 | + |
| 62 | + logger.info("Starting NIXL side channel server on %s:%s", |
| 63 | + self.host, self.port) |
| 64 | + |
| 65 | + # use uvicorn directly to avoid dependency on engine_client |
| 66 | + config = uvicorn.Config( |
| 67 | + app=self.app, |
| 68 | + host=self.host, |
| 69 | + port=self.port, |
| 70 | + log_level="info", |
| 71 | + access_log=True, |
| 72 | + ) |
| 73 | + self.server = uvicorn.Server(config) |
| 74 | + |
| 75 | + # start the server in a background task |
| 76 | + asyncio.create_task(self.server.serve()) |
| 77 | + logger.info("NIXL side channel server started successfully") |
| 78 | + |
| 79 | + async def stop_async(self): |
| 80 | + if self.server is not None: |
| 81 | + logger.info("Stopping NIXL side channel server") |
| 82 | + try: |
| 83 | + self.server.should_exit = True |
| 84 | + await asyncio.sleep(1) # give it time to shutdown |
| 85 | + except Exception as e: |
| 86 | + logger.warning("Error during side channel server shutdown: %s", e) |
| 87 | + self.server = None |
| 88 | + logger.info("NIXL side channel server stopped") |
| 89 | + |
| 90 | + |
| 91 | +def should_start_nixl_side_channel_server(vllm_config: VllmConfig) -> bool: |
| 92 | + if vllm_config.kv_transfer_config is None: |
| 93 | + return False |
| 94 | + |
| 95 | + return vllm_config.kv_transfer_config.kv_connector == "NixlConnector" |
| 96 | + |
| 97 | + |
| 98 | +async def start_nixl_side_channel_server_if_needed( |
| 99 | + vllm_config: VllmConfig) -> Optional[NixlSideChannelServer]: |
| 100 | + if not should_start_nixl_side_channel_server(vllm_config): |
| 101 | + return None |
| 102 | + |
| 103 | + side_channel_host = envs.VLLM_NIXL_SIDE_CHANNEL_HOST |
| 104 | + side_channel_port = envs.VLLM_NIXL_SIDE_CHANNEL_PORT |
| 105 | + |
| 106 | + logger.info("Starting NIXL side channel metadata server on %s:%d", |
| 107 | + side_channel_host, side_channel_port) |
| 108 | + |
| 109 | + server = NixlSideChannelServer( |
| 110 | + vllm_config, side_channel_host, side_channel_port) |
| 111 | + await server.start_async() |
| 112 | + return server |
0 commit comments