api_server.py 72 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
import asyncio
5
import gc
6
import hashlib
7
8
import importlib
import inspect
9
import json
10
import multiprocessing
11
import multiprocessing.forkserver as forkserver
12
import os
13
import secrets
14
import signal
15
import socket
16
import tempfile
17
import uuid
18
from argparse import Namespace
19
from collections.abc import AsyncGenerator, AsyncIterator, Awaitable, Callable
20
from contextlib import asynccontextmanager
21
from http import HTTPStatus
22
from typing import Annotated, Any, Literal
23

24
import prometheus_client
25
import pydantic
26
import regex as re
27
import uvloop
28
from fastapi import APIRouter, Depends, FastAPI, Form, HTTPException, Query, Request
Zhuohan Li's avatar
Zhuohan Li committed
29
30
from fastapi.exceptions import RequestValidationError
from fastapi.middleware.cors import CORSMiddleware
31
from fastapi.responses import JSONResponse, Response, StreamingResponse
32
33
from prometheus_client import make_asgi_app
from prometheus_fastapi_instrumentator import Instrumentator
34
from starlette.concurrency import iterate_in_threadpool
35
from starlette.datastructures import URL, Headers, MutableHeaders, State
36
from starlette.routing import Mount
37
from starlette.types import ASGIApp, Message, Receive, Scope, Send
38
from typing_extensions import assert_never
Zhuohan Li's avatar
Zhuohan Li committed
39

40
import vllm.envs as envs
41
from vllm.config import VllmConfig
Woosuk Kwon's avatar
Woosuk Kwon committed
42
from vllm.engine.arg_utils import AsyncEngineArgs
43
from vllm.engine.protocol import Device, EngineClient
44
45
46
47
48
49
50
from vllm.entrypoints.anthropic.protocol import (
    AnthropicError,
    AnthropicErrorResponse,
    AnthropicMessagesRequest,
    AnthropicMessagesResponse,
)
from vllm.entrypoints.anthropic.serving_messages import AnthropicServingMessages
51
from vllm.entrypoints.launcher import serve_http
52
from vllm.entrypoints.logger import RequestLogger
53
from vllm.entrypoints.openai.cli_args import make_arg_parser, validate_parsed_serve_args
54
from vllm.entrypoints.openai.orca_metrics import metrics_header
55
56
57
58
59
60
61
62
63
from vllm.entrypoints.openai.protocol import (
    ChatCompletionRequest,
    ChatCompletionResponse,
    ClassificationRequest,
    ClassificationResponse,
    CompletionRequest,
    CompletionResponse,
    DetokenizeRequest,
    DetokenizeResponse,
64
    EmbeddingBytesResponse,
65
66
67
68
69
70
    EmbeddingRequest,
    EmbeddingResponse,
    ErrorInfo,
    ErrorResponse,
    IOProcessorResponse,
    LoadLoRAAdapterRequest,
71
    PoolingBytesResponse,
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
    PoolingRequest,
    PoolingResponse,
    RerankRequest,
    RerankResponse,
    ResponsesRequest,
    ResponsesResponse,
    ScoreRequest,
    ScoreResponse,
    StreamingResponsesResponse,
    TokenizeRequest,
    TokenizeResponse,
    TranscriptionRequest,
    TranscriptionResponse,
    TranslationRequest,
    TranslationResponse,
    UnloadLoRAAdapterRequest,
)
89
from vllm.entrypoints.openai.serving_chat import OpenAIServingChat
90
from vllm.entrypoints.openai.serving_classification import ServingClassification
91
from vllm.entrypoints.openai.serving_completion import OpenAIServingCompletion
92
from vllm.entrypoints.openai.serving_embedding import OpenAIServingEmbedding
93
from vllm.entrypoints.openai.serving_engine import OpenAIServing
94
95
96
97
from vllm.entrypoints.openai.serving_models import (
    BaseModelPath,
    OpenAIServingModels,
)
98
from vllm.entrypoints.openai.serving_pooling import OpenAIServingPooling
99
from vllm.entrypoints.openai.serving_responses import OpenAIServingResponses
100
from vllm.entrypoints.openai.serving_score import ServingScores
101
from vllm.entrypoints.openai.serving_tokenization import OpenAIServingTokenization
102
from vllm.entrypoints.openai.serving_transcription import (
103
104
105
    OpenAIServingTranscription,
    OpenAIServingTranslation,
)
106
from vllm.entrypoints.openai.tool_parsers import ToolParserManager
107
108
109
110
111
from vllm.entrypoints.tool_server import DemoToolServer, MCPToolServer, ToolServer
from vllm.entrypoints.utils import (
    cli_env_setup,
    load_aware_call,
    log_non_default_args,
112
113
    process_chat_template,
    process_lora_modules,
114
115
    with_cancellation,
)
116
from vllm.logger import init_logger
117
from vllm.reasoning import ReasoningParserManager
118
from vllm.tasks import POOLING_TASKS
yhu422's avatar
yhu422 committed
119
from vllm.usage.usage_lib import UsageContext
Cyrus Leung's avatar
Cyrus Leung committed
120
from vllm.utils.argparse_utils import FlexibleArgumentParser
121
from vllm.utils.network_utils import is_valid_ipv6_address
122
from vllm.utils.system_utils import decorate_logs, set_ulimit
123
from vllm.v1.engine.exceptions import EngineDeadError
124
from vllm.v1.metrics.prometheus import get_prometheus_registry
125
from vllm.version import __version__ as VLLM_VERSION
Zhuohan Li's avatar
Zhuohan Li committed
126

127
prometheus_multiproc_dir: tempfile.TemporaryDirectory
128

129
# Cannot use __name__ (https://github.com/vllm-project/vllm/pull/4765)
130
logger = init_logger("vllm.entrypoints.openai.api_server")
131

132
133
ENDPOINT_LOAD_METRICS_FORMAT_HEADER_LABEL = "endpoint-load-metrics-format"

134
_running_tasks: set[asyncio.Task] = set()
135

136

137
@asynccontextmanager
138
async def lifespan(app: FastAPI):
139
140
    try:
        if app.state.log_stats:
141
            engine_client: EngineClient = app.state.engine_client
142
143
144

            async def _force_log():
                while True:
145
                    await asyncio.sleep(envs.VLLM_LOG_STATS_INTERVAL)
146
                    await engine_client.do_log_stats()
147
148
149
150
151
152

            task = asyncio.create_task(_force_log())
            _running_tasks.add(task)
            task.add_done_callback(_running_tasks.remove)
        else:
            task = None
153
154
155
156
157

        # Mark the startup heap as static so that it's ignored by GC.
        # Reduces pause times of oldest generation collections.
        gc.collect()
        gc.freeze()
158
159
160
161
162
163
164
165
        try:
            yield
        finally:
            if task is not None:
                task.cancel()
    finally:
        # Ensure app state including engine ref is gc'd
        del app.state
166
167


168
@asynccontextmanager
169
async def build_async_engine_client(
170
    args: Namespace,
171
172
    *,
    usage_context: UsageContext = UsageContext.OPENAI_API_SERVER,
173
174
    disable_frontend_multiprocessing: bool | None = None,
    client_config: dict[str, Any] | None = None,
175
) -> AsyncIterator[EngineClient]:
176
177
178
179
    if os.getenv("VLLM_WORKER_MULTIPROC_METHOD") == "forkserver":
        # The executor is expected to be mp.
        # Pre-import heavy modules in the forkserver process
        logger.debug("Setup forkserver with pre-imports")
180
        multiprocessing.set_start_method("forkserver")
181
182
183
184
        multiprocessing.set_forkserver_preload(["vllm.v1.engine.async_llm"])
        forkserver.ensure_running()
        logger.debug("Forkserver setup complete!")

185
    # Context manager to handle engine_client lifecycle
186
187
    # Ensures everything is shutdown and cleaned up on error/exit
    engine_args = AsyncEngineArgs.from_cli_args(args)
188
189
190
    if client_config:
        engine_args._api_process_count = client_config.get("client_count", 1)
        engine_args._api_process_rank = client_config.get("client_index", 0)
191

192
    if disable_frontend_multiprocessing is None:
193
        disable_frontend_multiprocessing = bool(args.disable_frontend_multiprocessing)
194

195
    async with build_async_engine_client_from_engine_args(
196
197
198
199
        engine_args,
        usage_context=usage_context,
        disable_frontend_multiprocessing=disable_frontend_multiprocessing,
        client_config=client_config,
200
    ) as engine:
201
202
203
204
205
206
        yield engine


@asynccontextmanager
async def build_async_engine_client_from_engine_args(
    engine_args: AsyncEngineArgs,
207
208
    *,
    usage_context: UsageContext = UsageContext.OPENAI_API_SERVER,
209
    disable_frontend_multiprocessing: bool = False,
210
    client_config: dict[str, Any] | None = None,
211
) -> AsyncIterator[EngineClient]:
212
    """
213
    Create EngineClient, either:
214
215
216
217
218
219
        - in-process using the AsyncLLMEngine Directly
        - multiprocess using AsyncLLMEngine RPC

    Returns the Client or None if the creation failed.
    """

220
221
222
223
    # Create the EngineConfig (determines if we can use V1).
    vllm_config = engine_args.create_engine_config(usage_context=usage_context)

    # V1 AsyncLLM.
224
    assert envs.VLLM_USE_V1
225

226
227
228
    if disable_frontend_multiprocessing:
        logger.warning(
            "V1 is enabled, but got --disable-frontend-multiprocessing. "
229
230
            "To disable frontend multiprocessing, set VLLM_USE_V1=0."
        )
231

232
    from vllm.v1.engine.async_llm import AsyncLLM
233

234
    async_llm: AsyncLLM | None = None
235
236
237
238
239
240

    # Don't mutate the input client_config
    client_config = dict(client_config) if client_config else {}
    client_count = client_config.pop("client_count", 1)
    client_index = client_config.pop("client_index", 0)

241
242
243
244
245
    try:
        async_llm = AsyncLLM.from_vllm_config(
            vllm_config=vllm_config,
            usage_context=usage_context,
            enable_log_requests=engine_args.enable_log_requests,
246
            aggregate_engine_logging=engine_args.aggregate_engine_logging,
247
248
249
            disable_log_stats=engine_args.disable_log_stats,
            client_addresses=client_config,
            client_count=client_count,
250
251
            client_index=client_index,
        )
252
253

        # Don't keep the dummy data in memory
254
        assert async_llm is not None
255
256
257
258
259
260
        await async_llm.reset_mm_cache()

        yield async_llm
    finally:
        if async_llm:
            async_llm.shutdown()
261
262


263
264
async def validate_json_request(raw_request: Request):
    content_type = raw_request.headers.get("content-type", "").lower()
265
266
    media_type = content_type.split(";", maxsplit=1)[0]
    if media_type != "application/json":
267
268
269
        raise RequestValidationError(
            errors=["Unsupported Media Type: Only 'application/json' is allowed"]
        )
270
271


Ethan Xu's avatar
Ethan Xu committed
272
router = APIRouter()
Zhuohan Li's avatar
Zhuohan Li committed
273

274

275
276
277
278
class PrometheusResponse(Response):
    media_type = prometheus_client.CONTENT_TYPE_LATEST


279
def mount_metrics(app: FastAPI):
280
281
282
    """Mount prometheus metrics to a FastAPI app."""

    registry = get_prometheus_registry()
283

284
285
286
287
    # `response_class=PrometheusResponse` is needed to return an HTTP response
    # with header "Content-Type: text/plain; version=0.0.4; charset=utf-8"
    # instead of the default "application/json" which is incorrect.
    # See https://github.com/trallnag/prometheus-fastapi-instrumentator/issues/163#issue-1296092364
288
289
290
291
292
293
294
295
296
297
    Instrumentator(
        excluded_handlers=[
            "/metrics",
            "/health",
            "/load",
            "/ping",
            "/version",
            "/server_info",
        ],
        registry=registry,
298
    ).add().instrument(app).expose(app, response_class=PrometheusResponse)
299
300
301

    # Add prometheus asgi middleware to route /metrics requests
    metrics_route = Mount("/metrics", make_asgi_app(registry=registry))
302

303
    # Workaround for 307 Redirect for /metrics
304
    metrics_route.path_regex = re.compile("^/metrics(?P<path>.*)$")
305
    app.routes.append(metrics_route)
306
307


308
309
310
311
312
def base(request: Request) -> OpenAIServing:
    # Reuse the existing instance
    return tokenization(request)


313
314
315
316
def models(request: Request) -> OpenAIServingModels:
    return request.app.state.openai_serving_models


317
def responses(request: Request) -> OpenAIServingResponses | None:
318
319
320
    return request.app.state.openai_serving_responses


321
322
323
324
def messages(request: Request) -> AnthropicServingMessages:
    return request.app.state.anthropic_serving_messages


325
def chat(request: Request) -> OpenAIServingChat | None:
326
327
328
    return request.app.state.openai_serving_chat


329
def completion(request: Request) -> OpenAIServingCompletion | None:
330
331
332
    return request.app.state.openai_serving_completion


333
def pooling(request: Request) -> OpenAIServingPooling | None:
334
335
336
    return request.app.state.openai_serving_pooling


337
def embedding(request: Request) -> OpenAIServingEmbedding | None:
338
    return request.app.state.openai_serving_embedding
339
340


341
def score(request: Request) -> ServingScores | None:
342
343
344
    return request.app.state.openai_serving_scores


345
def classify(request: Request) -> ServingClassification | None:
346
347
348
    return request.app.state.openai_serving_classification


349
def rerank(request: Request) -> ServingScores | None:
350
    return request.app.state.openai_serving_scores
351
352


353
354
def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
355
356


357
358
359
360
def transcription(request: Request) -> OpenAIServingTranscription:
    return request.app.state.openai_serving_transcription


361
362
363
364
def translation(request: Request) -> OpenAIServingTranslation:
    return request.app.state.openai_serving_translation


365
def engine_client(request: Request) -> EngineClient:
366
367
368
    return request.app.state.engine_client


369
370
@router.get("/health", response_class=Response)
async def health(raw_request: Request) -> Response:
371
    """Health check."""
372
373
374
375
376
    try:
        await engine_client(raw_request).check_health()
        return Response(status_code=200)
    except EngineDeadError:
        return Response(status_code=503)
377
378


379
380
381
382
383
384
385
@router.get("/load")
async def get_server_load_metrics(request: Request):
    # This endpoint returns the current server load metrics.
    # It tracks requests utilizing the GPU from the following routes:
    # - /v1/chat/completions
    # - /v1/completions
    # - /v1/audio/transcriptions
386
    # - /v1/audio/translations
387
388
    # - /v1/embeddings
    # - /pooling
389
    # - /classify
390
391
392
393
394
    # - /score
    # - /v1/score
    # - /rerank
    # - /v1/rerank
    # - /v2/rerank
395
    return JSONResponse(content={"server_load": request.app.state.server_load_metrics})
396
397


398
399
400
@router.get("/ping", response_class=Response)
@router.post("/ping", response_class=Response)
async def ping(raw_request: Request) -> Response:
401
402
403
404
    """Ping check. Endpoint required for SageMaker"""
    return await health(raw_request)


405
406
407
408
409
410
411
412
413
414
@router.post(
    "/tokenize",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.NOT_FOUND.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
        HTTPStatus.NOT_IMPLEMENTED.value: {"model": ErrorResponse},
    },
)
415
@with_cancellation
416
async def tokenize(request: TokenizeRequest, raw_request: Request):
417
418
    handler = tokenization(raw_request)

419
420
421
    try:
        generator = await handler.create_tokenize(request, raw_request)
    except NotImplementedError as e:
422
423
424
        raise HTTPException(
            status_code=HTTPStatus.NOT_IMPLEMENTED.value, detail=str(e)
        ) from e
425
    except Exception as e:
426
427
428
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
429

430
    if isinstance(generator, ErrorResponse):
431
432
433
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
434
    elif isinstance(generator, TokenizeResponse):
435
436
        return JSONResponse(content=generator.model_dump())

437
438
    assert_never(generator)

439

440
441
442
443
444
445
446
447
448
@router.post(
    "/detokenize",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.NOT_FOUND.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
449
@with_cancellation
450
async def detokenize(request: DetokenizeRequest, raw_request: Request):
451
452
    handler = tokenization(raw_request)

453
454
455
456
457
    try:
        generator = await handler.create_detokenize(request, raw_request)
    except OverflowError as e:
        raise RequestValidationError(errors=[str(e)]) from e
    except Exception as e:
458
459
460
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
461

462
    if isinstance(generator, ErrorResponse):
463
464
465
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
466
    elif isinstance(generator, DetokenizeResponse):
467
468
        return JSONResponse(content=generator.model_dump())

469
470
    assert_never(generator)

471

472
473
def maybe_register_tokenizer_info_endpoint(args):
    """Conditionally register the tokenizer info endpoint if enabled."""
474
    if getattr(args, "enable_tokenizer_info_endpoint", False):
475
476
477
478
479

        @router.get("/tokenizer_info")
        async def get_tokenizer_info(raw_request: Request):
            """Get comprehensive tokenizer information."""
            result = await tokenization(raw_request).get_tokenizer_info()
480
481
482
483
484
485
            return JSONResponse(
                content=result.model_dump(),
                status_code=result.error.code
                if isinstance(result, ErrorResponse)
                else 200,
            )
486
487


Ethan Xu's avatar
Ethan Xu committed
488
@router.get("/v1/models")
489
async def show_available_models(raw_request: Request):
490
    handler = models(raw_request)
491

492
493
    models_ = await handler.show_available_models()
    return JSONResponse(content=models_.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
494
495


Ethan Xu's avatar
Ethan Xu committed
496
@router.get("/version")
497
async def show_version():
498
    ver = {"version": VLLM_VERSION}
499
500
501
    return JSONResponse(content=ver)


502
async def _convert_stream_to_sse_events(
503
    generator: AsyncGenerator[StreamingResponsesResponse, None],
504
) -> AsyncGenerator[str, None]:
505
506
    """Convert the generator to a stream of events in SSE format"""
    async for event in generator:
507
        event_type = getattr(event, "type", "unknown")
508
        # https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event_stream_format
509
510
511
        event_data = (
            f"event: {event_type}\ndata: {event.model_dump_json(indent=None)}\n\n"
        )
512
513
514
        yield event_data


515
516
517
518
519
520
521
522
523
524
@router.post(
    "/v1/responses",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.OK.value: {"content": {"text/event-stream": {}}},
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.NOT_FOUND.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
525
526
527
528
529
@with_cancellation
async def create_responses(request: ResponsesRequest, raw_request: Request):
    handler = responses(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
530
531
            message="The model does not support Responses API"
        )
532
533
534
    try:
        generator = await handler.create_responses(request, raw_request)
    except Exception as e:
535
536
537
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
538
539

    if isinstance(generator, ErrorResponse):
540
541
542
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
543
544
    elif isinstance(generator, ResponsesResponse):
        return JSONResponse(content=generator.model_dump())
545

546
547
548
    return StreamingResponse(
        content=_convert_stream_to_sse_events(generator), media_type="text/event-stream"
    )
549
550
551


@router.get("/v1/responses/{response_id}")
552
553
554
async def retrieve_responses(
    response_id: str,
    raw_request: Request,
555
556
    starting_after: int | None = None,
    stream: bool | None = False,
557
):
558
559
560
    handler = responses(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
561
562
            message="The model does not support Responses API"
        )
563

564
    try:
565
566
567
568
569
        response = await handler.retrieve_responses(
            response_id,
            starting_after=starting_after,
            stream=stream,
        )
570
    except Exception as e:
571
572
573
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
574
575

    if isinstance(response, ErrorResponse):
576
577
578
        return JSONResponse(
            content=response.model_dump(), status_code=response.error.code
        )
579
580
    elif isinstance(response, ResponsesResponse):
        return JSONResponse(content=response.model_dump())
581
582
583
    return StreamingResponse(
        content=_convert_stream_to_sse_events(response), media_type="text/event-stream"
    )
584
585
586
587
588
589
590


@router.post("/v1/responses/{response_id}/cancel")
async def cancel_responses(response_id: str, raw_request: Request):
    handler = responses(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
591
592
            message="The model does not support Responses API"
        )
593

594
595
596
    try:
        response = await handler.cancel_responses(response_id)
    except Exception as e:
597
598
599
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
600
601

    if isinstance(response, ErrorResponse):
602
603
604
        return JSONResponse(
            content=response.model_dump(), status_code=response.error.code
        )
605
606
607
    return JSONResponse(content=response.model_dump())


608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
@router.post(
    "/v1/messages",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.OK.value: {"content": {"text/event-stream": {}}},
        HTTPStatus.BAD_REQUEST.value: {"model": AnthropicErrorResponse},
        HTTPStatus.NOT_FOUND.value: {"model": AnthropicErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": AnthropicErrorResponse},
    },
)
@with_cancellation
@load_aware_call
async def create_messages(request: AnthropicMessagesRequest, raw_request: Request):
    def translate_error_response(response: ErrorResponse) -> JSONResponse:
        anthropic_error = AnthropicErrorResponse(
            error=AnthropicError(
                type=response.error.type,
                message=response.error.message,
            )
        )
        return JSONResponse(
            status_code=response.error.code, content=anthropic_error.model_dump()
        )

    handler = messages(raw_request)
    if handler is None:
        error = base(raw_request).create_error_response(
            message="The model does not support Messages API"
        )
        return translate_error_response(error)

    try:
        generator = await handler.create_messages(request, raw_request)
    except Exception as e:
        logger.exception("Error in create_messages: %s", e)
        return JSONResponse(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value,
            content=AnthropicErrorResponse(
                error=AnthropicError(
                    type="internal_error",
                    message=str(e),
                )
            ).model_dump(),
        )

    if isinstance(generator, ErrorResponse):
        return translate_error_response(generator)

    elif isinstance(generator, AnthropicMessagesResponse):
        logger.debug(
            "Anthropic Messages Response: %s", generator.model_dump(exclude_none=True)
        )
        return JSONResponse(content=generator.model_dump(exclude_none=True))

    return StreamingResponse(content=generator, media_type="text/event-stream")


665
666
667
668
669
670
671
672
673
674
@router.post(
    "/v1/chat/completions",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.OK.value: {"content": {"text/event-stream": {}}},
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.NOT_FOUND.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
675
@with_cancellation
676
@load_aware_call
677
async def create_chat_completion(request: ChatCompletionRequest, raw_request: Request):
678
679
680
    metrics_header_format = raw_request.headers.get(
        ENDPOINT_LOAD_METRICS_FORMAT_HEADER_LABEL, ""
    )
681
682
683
    handler = chat(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
684
685
            message="The model does not support Chat Completions API"
        )
686
687
688
    try:
        generator = await handler.create_chat_completion(request, raw_request)
    except Exception as e:
689
690
691
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
692
    if isinstance(generator, ErrorResponse):
693
694
695
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
696

697
    elif isinstance(generator, ChatCompletionResponse):
698
699
700
701
        return JSONResponse(
            content=generator.model_dump(),
            headers=metrics_header(metrics_header_format),
        )
702

703
704
    return StreamingResponse(content=generator, media_type="text/event-stream")

705

706
707
708
709
710
711
712
713
714
715
@router.post(
    "/v1/completions",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.OK.value: {"content": {"text/event-stream": {}}},
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.NOT_FOUND.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
716
@with_cancellation
717
@load_aware_call
718
async def create_completion(request: CompletionRequest, raw_request: Request):
719
720
721
    metrics_header_format = raw_request.headers.get(
        ENDPOINT_LOAD_METRICS_FORMAT_HEADER_LABEL, ""
    )
722
723
724
    handler = completion(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
725
726
            message="The model does not support Completions API"
        )
727

728
729
730
    try:
        generator = await handler.create_completion(request, raw_request)
    except OverflowError as e:
731
732
733
        raise HTTPException(
            status_code=HTTPStatus.BAD_REQUEST.value, detail=str(e)
        ) from e
734
    except Exception as e:
735
736
737
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
738

739
    if isinstance(generator, ErrorResponse):
740
741
742
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
743
    elif isinstance(generator, CompletionResponse):
744
745
746
747
        return JSONResponse(
            content=generator.model_dump(),
            headers=metrics_header(metrics_header_format),
        )
Zhuohan Li's avatar
Zhuohan Li committed
748

749
750
    return StreamingResponse(content=generator, media_type="text/event-stream")

Zhuohan Li's avatar
Zhuohan Li committed
751

752
753
754
755
756
757
758
759
@router.post(
    "/v1/embeddings",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
760
@with_cancellation
761
@load_aware_call
762
763
764
765
async def create_embedding(
    request: EmbeddingRequest,
    raw_request: Request,
):
766
767
    handler = embedding(raw_request)
    if handler is None:
768
        return base(raw_request).create_error_response(
769
770
            message="The model does not support Embeddings API"
        )
771

772
773
774
    try:
        generator = await handler.create_embedding(request, raw_request)
    except Exception as e:
775
776
777
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
778

779
    if isinstance(generator, ErrorResponse):
780
781
782
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
783
    elif isinstance(generator, EmbeddingResponse):
784
        return JSONResponse(content=generator.model_dump())
785
786
787
788
789
790
    elif isinstance(generator, EmbeddingBytesResponse):
        return StreamingResponse(
            content=generator.body,
            headers={"metadata": generator.metadata},
            media_type=generator.media_type,
        )
791

792
793
    assert_never(generator)

794

795
796
797
798
799
800
801
802
@router.post(
    "/pooling",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
803
@with_cancellation
804
@load_aware_call
805
806
807
808
async def create_pooling(request: PoolingRequest, raw_request: Request):
    handler = pooling(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
809
810
            message="The model does not support Pooling API"
        )
811
812
813
    try:
        generator = await handler.create_pooling(request, raw_request)
    except Exception as e:
814
815
816
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
817
    if isinstance(generator, ErrorResponse):
818
819
820
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
821
    elif isinstance(generator, (PoolingResponse, IOProcessorResponse)):
822
        return JSONResponse(content=generator.model_dump())
823
824
825
826
827
828
    elif isinstance(generator, PoolingBytesResponse):
        return StreamingResponse(
            content=generator.body,
            headers={"metadata": generator.metadata},
            media_type=generator.media_type,
        )
829
830
831
832

    assert_never(generator)


833
834
835
@router.post("/classify", dependencies=[Depends(validate_json_request)])
@with_cancellation
@load_aware_call
836
async def create_classify(request: ClassificationRequest, raw_request: Request):
837
838
839
    handler = classify(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
840
841
            message="The model does not support Classification API"
        )
842

843
844
845
    try:
        generator = await handler.create_classify(request, raw_request)
    except Exception as e:
846
847
848
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
849
    if isinstance(generator, ErrorResponse):
850
851
852
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
853
854
855
856
857
858
859

    elif isinstance(generator, ClassificationResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


860
861
862
863
864
865
866
867
@router.post(
    "/score",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
868
@with_cancellation
869
@load_aware_call
870
871
872
873
async def create_score(request: ScoreRequest, raw_request: Request):
    handler = score(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
874
875
            message="The model does not support Score API"
        )
876

877
878
879
    try:
        generator = await handler.create_score(request, raw_request)
    except Exception as e:
880
881
882
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
883
    if isinstance(generator, ErrorResponse):
884
885
886
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
887
888
889
890
891
892
    elif isinstance(generator, ScoreResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


893
894
895
896
897
898
899
900
@router.post(
    "/v1/score",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
901
@with_cancellation
902
@load_aware_call
903
904
905
async def create_score_v1(request: ScoreRequest, raw_request: Request):
    logger.warning(
        "To indicate that Score API is not part of standard OpenAI API, we "
906
907
        "have moved it to `/score`. Please update your client accordingly."
    )
908
909
910
911

    return await create_score(request, raw_request)


912
913
914
915
916
917
918
919
920
@router.post(
    "/v1/audio/transcriptions",
    responses={
        HTTPStatus.OK.value: {"content": {"text/event-stream": {}}},
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.UNPROCESSABLE_ENTITY.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
921
@with_cancellation
922
@load_aware_call
923
924
925
async def create_transcriptions(
    raw_request: Request, request: Annotated[TranscriptionRequest, Form()]
):
926
927
928
    handler = transcription(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
929
930
            message="The model does not support Transcriptions API"
        )
931
932

    audio_data = await request.file.read()
933
    try:
934
        generator = await handler.create_transcription(audio_data, request, raw_request)
935
    except Exception as e:
936
937
938
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
939
940

    if isinstance(generator, ErrorResponse):
941
942
943
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
944
945
946
947
948
949
950

    elif isinstance(generator, TranscriptionResponse):
        return JSONResponse(content=generator.model_dump())

    return StreamingResponse(content=generator, media_type="text/event-stream")


951
952
953
954
955
956
957
958
959
@router.post(
    "/v1/audio/translations",
    responses={
        HTTPStatus.OK.value: {"content": {"text/event-stream": {}}},
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.UNPROCESSABLE_ENTITY.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
960
961
@with_cancellation
@load_aware_call
962
963
964
async def create_translations(
    request: Annotated[TranslationRequest, Form()], raw_request: Request
):
965
966
967
    handler = translation(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
968
969
            message="The model does not support Translations API"
        )
970
971

    audio_data = await request.file.read()
972
    try:
973
        generator = await handler.create_translation(audio_data, request, raw_request)
974
    except Exception as e:
975
976
977
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
978
979

    if isinstance(generator, ErrorResponse):
980
981
982
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
983
984
985
986
987
988
989

    elif isinstance(generator, TranslationResponse):
        return JSONResponse(content=generator.model_dump())

    return StreamingResponse(content=generator, media_type="text/event-stream")


990
991
992
993
994
995
996
997
@router.post(
    "/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
998
@with_cancellation
999
@load_aware_call
1000
1001
1002
1003
async def do_rerank(request: RerankRequest, raw_request: Request):
    handler = rerank(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
1004
1005
            message="The model does not support Rerank (Score) API"
        )
1006
1007
1008
    try:
        generator = await handler.do_rerank(request, raw_request)
    except Exception as e:
1009
1010
1011
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
1012
    if isinstance(generator, ErrorResponse):
1013
1014
1015
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
1016
1017
1018
1019
1020
1021
    elif isinstance(generator, RerankResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


1022
1023
1024
1025
1026
1027
1028
1029
@router.post(
    "/v1/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
1030
1031
@with_cancellation
async def do_rerank_v1(request: RerankRequest, raw_request: Request):
1032
    logger.warning_once(
1033
        "To indicate that the rerank API is not part of the standard OpenAI"
1034
        " API, we have located it at `/rerank`. Please update your client "
1035
1036
        "accordingly. (Note: Conforms to JinaAI rerank API)"
    )
1037
1038
1039
1040

    return await do_rerank(request, raw_request)


1041
1042
1043
1044
1045
1046
1047
1048
@router.post(
    "/v2/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
1049
1050
1051
1052
1053
@with_cancellation
async def do_rerank_v2(request: RerankRequest, raw_request: Request):
    return await do_rerank(request, raw_request)


1054
if envs.VLLM_SERVER_DEV_MODE:
1055
1056
1057
1058
    logger.warning(
        "SECURITY WARNING: Development endpoints are enabled! "
        "This should NOT be used in production!"
    )
1059

1060
1061
    PydanticVllmConfig = pydantic.TypeAdapter(VllmConfig)

1062
    @router.get("/server_info")
1063
1064
    async def show_server_info(
        raw_request: Request,
1065
        config_format: Annotated[Literal["text", "json"], Query()] = "text",
1066
1067
1068
    ):
        vllm_config: VllmConfig = raw_request.app.state.vllm_config
        server_info = {
1069
1070
1071
            "vllm_config": str(vllm_config)
            if config_format == "text"
            else PydanticVllmConfig.dump_python(vllm_config, mode="json", fallback=str)
1072
1073
            # fallback=str is needed to handle e.g. torch.dtype
        }
1074
1075
        return JSONResponse(content=server_info)

1076
1077
1078
1079
1080
1081
    @router.post("/reset_prefix_cache")
    async def reset_prefix_cache(raw_request: Request):
        """
        Reset the prefix cache. Note that we currently do not check if the
        prefix cache is successfully reset in the API server.
        """
1082
1083
1084
1085
1086
1087
        device = None
        device_str = raw_request.query_params.get("device")
        if device_str is not None:
            device = Device[device_str.upper()]
        logger.info("Resetting prefix cache with specific %s...", str(device))
        await engine_client(raw_request).reset_prefix_cache(device)
1088
1089
        return Response(status_code=200)

1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
    @router.post("/reset_mm_cache")
    async def reset_mm_cache(raw_request: Request):
        """
        Reset the multi-modal cache. Note that we currently do not check if the
        multi-modal cache is successfully reset in the API server.
        """
        logger.info("Resetting multi-modal cache...")
        await engine_client(raw_request).reset_mm_cache()
        return Response(status_code=200)

1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
    @router.post("/sleep")
    async def sleep(raw_request: Request):
        # get POST params
        level = raw_request.query_params.get("level", "1")
        await engine_client(raw_request).sleep(int(level))
        # FIXME: in v0 with frontend multiprocessing, the sleep command
        # is sent but does not finish yet when we return a response.
        return Response(status_code=200)

    @router.post("/wake_up")
    async def wake_up(raw_request: Request):
1111
1112
1113
1114
1115
1116
        tags = raw_request.query_params.getlist("tags")
        if tags == []:
            # set to None to wake up all tags if no tags are provided
            tags = None
        logger.info("wake up the engine with tags: %s", tags)
        await engine_client(raw_request).wake_up(tags)
1117
1118
1119
1120
        # FIXME: in v0 with frontend multiprocessing, the wake-up command
        # is sent but does not finish yet when we return a response.
        return Response(status_code=200)

1121
1122
1123
1124
1125
1126
    @router.get("/is_sleeping")
    async def is_sleeping(raw_request: Request):
        logger.info("check whether the engine is sleeping")
        is_sleeping = await engine_client(raw_request).is_sleeping()
        return JSONResponse(content={"is_sleeping": is_sleeping})

1127
1128
1129
1130
1131
    @router.post("/collective_rpc")
    async def collective_rpc(raw_request: Request):
        try:
            body = await raw_request.json()
        except json.JSONDecodeError as e:
1132
1133
1134
1135
            raise HTTPException(
                status_code=HTTPStatus.BAD_REQUEST.value,
                detail=f"JSON decode error: {e}",
            ) from e
1136
1137
        method = body.get("method")
        if method is None:
1138
1139
1140
1141
            raise HTTPException(
                status_code=HTTPStatus.BAD_REQUEST.value,
                detail="Missing 'method' in request body",
            )
1142
        # For security reason, only serialized string args/kwargs are passed.
1143
        # User-defined `method` is responsible for deserialization if needed.
1144
1145
        args: list[str] = body.get("args", [])
        kwargs: dict[str, str] = body.get("kwargs", {})
1146
        timeout: float | None = body.get("timeout")
1147
        results = await engine_client(raw_request).collective_rpc(
1148
1149
            method=method, timeout=timeout, args=tuple(args), kwargs=kwargs
        )
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
        if results is None:
            return Response(status_code=200)
        response: list[Any] = []
        for result in results:
            if result is None or isinstance(result, (dict, list)):
                response.append(result)
            else:
                response.append(str(result))
        return JSONResponse(content={"results": response})

1160

1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
@router.post(
    "/scale_elastic_ep",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.OK.value: {"model": dict},
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.REQUEST_TIMEOUT.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
1171
1172
1173
1174
async def scale_elastic_ep(raw_request: Request):
    try:
        body = await raw_request.json()
    except json.JSONDecodeError as e:
1175
        raise HTTPException(status_code=400, detail="Invalid JSON format") from e  # noqa: B904
1176
1177
1178
1179
1180

    new_data_parallel_size = body.get("new_data_parallel_size")
    drain_timeout = body.get("drain_timeout", 120)  # Default 2 minutes

    if new_data_parallel_size is None:
1181
1182
1183
        raise HTTPException(
            status_code=400, detail="new_data_parallel_size is required"
        )
1184

1185
    if not isinstance(new_data_parallel_size, int) or new_data_parallel_size <= 0:
1186
        raise HTTPException(
1187
1188
            status_code=400, detail="new_data_parallel_size must be a positive integer"
        )
1189
1190

    if not isinstance(drain_timeout, int) or drain_timeout <= 0:
1191
1192
1193
        raise HTTPException(
            status_code=400, detail="drain_timeout must be a positive integer"
        )
1194
1195
1196
1197
1198
1199
1200

    # Set scaling flag to prevent new requests
    global _scaling_elastic_ep
    _scaling_elastic_ep = True
    client = engine_client(raw_request)
    try:
        await client.scale_elastic_ep(new_data_parallel_size, drain_timeout)
1201
1202
1203
1204
1205
        return JSONResponse(
            {
                "message": f"Scaled to {new_data_parallel_size} data parallel engines",
            }
        )
1206
    except TimeoutError as e:
1207
1208
1209
1210
1211
        raise HTTPException(
            status_code=408,
            detail="Scale failed due to request drain timeout "
            f"after {drain_timeout} seconds",
        ) from e
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
    except Exception as e:
        logger.error("Scale failed: %s", e)
        raise HTTPException(status_code=500, detail="Scale failed") from e
    finally:
        _scaling_elastic_ep = False


@router.post("/is_scaling_elastic_ep")
async def is_scaling_elastic_ep(raw_request: Request):
    return JSONResponse({"is_scaling_elastic_ep": _scaling_elastic_ep})


1224
1225
1226
# TODO: RequestType = TypeForm[BaseModel] when recognized by type checkers
# (requires typing_extensions >= 4.13)
RequestType = Any
1227
GetHandlerFn = Callable[[Request], OpenAIServing | None]
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
EndpointFn = Callable[[RequestType, Request], Awaitable[Any]]

# NOTE: Items defined earlier take higher priority
INVOCATION_TYPES: list[tuple[RequestType, tuple[GetHandlerFn, EndpointFn]]] = [
    (ChatCompletionRequest, (chat, create_chat_completion)),
    (CompletionRequest, (completion, create_completion)),
    (EmbeddingRequest, (embedding, create_embedding)),
    (ClassificationRequest, (classify, create_classify)),
    (ScoreRequest, (score, create_score)),
    (RerankRequest, (rerank, do_rerank)),
    (PoolingRequest, (pooling, create_pooling)),
]

# NOTE: Construct the TypeAdapters only once
INVOCATION_VALIDATORS = [
    (pydantic.TypeAdapter(request_type), (get_handler, endpoint))
    for request_type, (get_handler, endpoint) in INVOCATION_TYPES
]


1248
1249
1250
1251
1252
1253
1254
1255
1256
@router.post(
    "/invocations",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.UNSUPPORTED_MEDIA_TYPE.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
1257
async def invocations(raw_request: Request):
1258
    """For SageMaker, routes requests based on the request type."""
1259
1260
    try:
        body = await raw_request.json()
1261
    except json.JSONDecodeError as e:
1262
1263
1264
        raise HTTPException(
            status_code=HTTPStatus.BAD_REQUEST.value, detail=f"JSON decode error: {e}"
        ) from e
1265

1266
1267
1268
1269
1270
    valid_endpoints = [
        (validator, endpoint)
        for validator, (get_handler, endpoint) in INVOCATION_VALIDATORS
        if get_handler(raw_request) is not None
    ]
1271

1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
    for request_validator, endpoint in valid_endpoints:
        try:
            request = request_validator.validate_python(body)
        except pydantic.ValidationError:
            continue

        return await endpoint(request, raw_request)

    type_names = [
        t.__name__ if isinstance(t := validator._type, type) else str(t)
        for validator, _ in valid_endpoints
    ]
1284
    msg = f"Cannot find suitable handler for request. Expected one of: {type_names}"
1285
    res = base(raw_request).create_error_response(message=msg)
1286
    return JSONResponse(content=res.model_dump(), status_code=res.error.code)
1287
1288


1289
1290
1291
if envs.VLLM_TORCH_PROFILER_DIR:
    logger.warning(
        "Torch Profiler is enabled in the API server. This should ONLY be "
1292
1293
        "used for local development!"
    )
1294
1295

    @router.post("/start_profile")
1296
    async def start_profile(raw_request: Request):
1297
        logger.info("Starting profiler...")
1298
        await engine_client(raw_request).start_profile()
1299
1300
1301
1302
        logger.info("Profiler started.")
        return Response(status_code=200)

    @router.post("/stop_profile")
1303
    async def stop_profile(raw_request: Request):
1304
        logger.info("Stopping profiler...")
1305
        await engine_client(raw_request).stop_profile()
1306
1307
1308
1309
        logger.info("Profiler stopped.")
        return Response(status_code=200)


1310
1311
if envs.VLLM_ALLOW_RUNTIME_LORA_UPDATING:
    logger.warning(
1312
        "LoRA dynamic loading & unloading is enabled in the API server. "
1313
1314
        "This should ONLY be used for local development!"
    )
1315

1316
1317
    @router.post("/v1/load_lora_adapter", dependencies=[Depends(validate_json_request)])
    async def load_lora_adapter(request: LoadLoRAAdapterRequest, raw_request: Request):
1318
1319
1320
        handler = models(raw_request)
        response = await handler.load_lora_adapter(request)
        if isinstance(response, ErrorResponse):
1321
1322
1323
            return JSONResponse(
                content=response.model_dump(), status_code=response.error.code
            )
1324
1325
1326

        return Response(status_code=200, content=response)

1327
1328
1329
1330
1331
1332
    @router.post(
        "/v1/unload_lora_adapter", dependencies=[Depends(validate_json_request)]
    )
    async def unload_lora_adapter(
        request: UnloadLoRAAdapterRequest, raw_request: Request
    ):
1333
1334
1335
        handler = models(raw_request)
        response = await handler.unload_lora_adapter(request)
        if isinstance(response, ErrorResponse):
1336
1337
1338
            return JSONResponse(
                content=response.model_dump(), status_code=response.error.code
            )
1339
1340
1341
1342

        return Response(status_code=200, content=response)


1343
def load_log_config(log_config_file: str | None) -> dict | None:
1344
1345
1346
1347
1348
1349
    if not log_config_file:
        return None
    try:
        with open(log_config_file) as f:
            return json.load(f)
    except Exception as e:
1350
1351
1352
        logger.warning(
            "Failed to load log config from file %s: error %s", log_config_file, e
        )
1353
1354
1355
        return None


1356
1357
1358
class AuthenticationMiddleware:
    """
    Pure ASGI middleware that authenticates each request by checking
1359
    if the Authorization Bearer token exists and equals anyof "{api_key}".
1360
1361
1362
1363
1364
1365
1366
1367

    Notes
    -----
    There are two cases in which authentication is skipped:
        1. The HTTP method is OPTIONS.
        2. The request path doesn't start with /v1 (e.g. /health).
    """

1368
    def __init__(self, app: ASGIApp, tokens: list[str]) -> None:
1369
        self.app = app
1370
        self.api_tokens = [hashlib.sha256(t.encode("utf-8")).digest() for t in tokens]
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387

    def verify_token(self, headers: Headers) -> bool:
        authorization_header_value = headers.get("Authorization")
        if not authorization_header_value:
            return False

        scheme, _, param = authorization_header_value.partition(" ")
        if scheme.lower() != "bearer":
            return False

        param_hash = hashlib.sha256(param.encode("utf-8")).digest()

        token_match = False
        for token_hash in self.api_tokens:
            token_match |= secrets.compare_digest(param_hash, token_hash)

        return token_match
1388

1389
1390
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
        if scope["type"] not in ("http", "websocket") or scope["method"] == "OPTIONS":
1391
1392
1393
1394
1395
1396
1397
            # scope["type"] can be "lifespan" or "startup" for example,
            # in which case we don't need to do anything
            return self.app(scope, receive, send)
        root_path = scope.get("root_path", "")
        url_path = URL(scope=scope).path.removeprefix(root_path)
        headers = Headers(scope=scope)
        # Type narrow to satisfy mypy.
1398
        if url_path.startswith("/v1") and not self.verify_token(headers):
1399
            response = JSONResponse(content={"error": "Unauthorized"}, status_code=401)
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
            return response(scope, receive, send)
        return self.app(scope, receive, send)


class XRequestIdMiddleware:
    """
    Middleware the set's the X-Request-Id header for each response
    to a random uuid4 (hex) value if the header isn't already
    present in the request, otherwise use the provided request id.
    """

    def __init__(self, app: ASGIApp) -> None:
        self.app = app

1414
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
        if scope["type"] not in ("http", "websocket"):
            return self.app(scope, receive, send)

        # Extract the request headers.
        request_headers = Headers(scope=scope)

        async def send_with_request_id(message: Message) -> None:
            """
            Custom send function to mutate the response headers
            and append X-Request-Id to it.
            """
            if message["type"] == "http.response.start":
                response_headers = MutableHeaders(raw=message["headers"])
1428
                request_id = request_headers.get("X-Request-Id", uuid.uuid4().hex)
1429
1430
1431
1432
1433
1434
                response_headers.append("X-Request-Id", request_id)
            await send(message)

        return self.app(scope, receive, send_with_request_id)


1435
1436
1437
1438
1439
1440
1441
1442
# Global variable to track scaling state
_scaling_elastic_ep = False


class ScalingMiddleware:
    """
    Middleware that checks if the model is currently scaling and
    returns a 503 Service Unavailable response if it is.
1443

1444
1445
1446
1447
1448
1449
1450
    This middleware applies to all HTTP requests and prevents
    processing when the model is in a scaling state.
    """

    def __init__(self, app: ASGIApp) -> None:
        self.app = app

1451
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
1452
1453
1454
1455
1456
1457
1458
        if scope["type"] != "http":
            return self.app(scope, receive, send)

        # Check global scaling state
        global _scaling_elastic_ep
        if _scaling_elastic_ep:
            # Return 503 Service Unavailable response
1459
1460
1461
1462
1463
1464
            response = JSONResponse(
                content={
                    "error": "The model is currently scaling. Please try again later."
                },
                status_code=503,
            )
1465
1466
1467
1468
1469
            return response(scope, receive, send)

        return self.app(scope, receive, send)


1470
1471
1472
1473
def _extract_content_from_chunk(chunk_data: dict) -> str:
    """Extract content from a streaming response chunk."""
    try:
        from vllm.entrypoints.openai.protocol import (
1474
1475
1476
            ChatCompletionStreamResponse,
            CompletionStreamResponse,
        )
1477
1478

        # Try using Completion types for type-safe parsing
1479
1480
        if chunk_data.get("object") == "chat.completion.chunk":
            chat_response = ChatCompletionStreamResponse.model_validate(chunk_data)
1481
1482
            if chat_response.choices and chat_response.choices[0].delta.content:
                return chat_response.choices[0].delta.content
1483
1484
1485
        elif chunk_data.get("object") == "text_completion":
            completion_response = CompletionStreamResponse.model_validate(chunk_data)
            if completion_response.choices and completion_response.choices[0].text:
1486
1487
1488
                return completion_response.choices[0].text
    except pydantic.ValidationError:
        # Fallback to manual parsing
1489
1490
1491
1492
1493
1494
        if "choices" in chunk_data and chunk_data["choices"]:
            choice = chunk_data["choices"][0]
            if "delta" in choice and choice["delta"].get("content"):
                return choice["delta"]["content"]
            elif choice.get("text"):
                return choice["text"]
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
    return ""


class SSEDecoder:
    """Robust Server-Sent Events decoder for streaming responses."""

    def __init__(self):
        self.buffer = ""
        self.content_buffer = []

    def decode_chunk(self, chunk: bytes) -> list[dict]:
        """Decode a chunk of SSE data and return parsed events."""
        import json

        try:
1510
            chunk_str = chunk.decode("utf-8")
1511
1512
1513
1514
1515
1516
1517
1518
        except UnicodeDecodeError:
            # Skip malformed chunks
            return []

        self.buffer += chunk_str
        events = []

        # Process complete lines
1519
1520
1521
        while "\n" in self.buffer:
            line, self.buffer = self.buffer.split("\n", 1)
            line = line.rstrip("\r")  # Handle CRLF
1522

1523
            if line.startswith("data: "):
1524
                data_str = line[6:].strip()
1525
1526
                if data_str == "[DONE]":
                    events.append({"type": "done"})
1527
1528
1529
                elif data_str:
                    try:
                        event_data = json.loads(data_str)
1530
                        events.append({"type": "data", "data": event_data})
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
                    except json.JSONDecodeError:
                        # Skip malformed JSON
                        continue

        return events

    def extract_content(self, event_data: dict) -> str:
        """Extract content from event data."""
        return _extract_content_from_chunk(event_data)

    def add_content(self, content: str) -> None:
        """Add content to the buffer."""
        if content:
            self.content_buffer.append(content)

    def get_complete_content(self) -> str:
        """Get the complete buffered content."""
1548
        return "".join(self.content_buffer)
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568


def _log_streaming_response(response, response_body: list) -> None:
    """Log streaming response with robust SSE parsing."""
    from starlette.concurrency import iterate_in_threadpool

    sse_decoder = SSEDecoder()
    chunk_count = 0

    def buffered_iterator():
        nonlocal chunk_count

        for chunk in response_body:
            chunk_count += 1
            yield chunk

            # Parse SSE events from chunk
            events = sse_decoder.decode_chunk(chunk)

            for event in events:
1569
1570
                if event["type"] == "data":
                    content = sse_decoder.extract_content(event["data"])
1571
                    sse_decoder.add_content(content)
1572
                elif event["type"] == "done":
1573
1574
1575
1576
1577
1578
1579
1580
                    # Log complete content when done
                    full_content = sse_decoder.get_complete_content()
                    if full_content:
                        # Truncate if too long
                        if len(full_content) > 2048:
                            full_content = full_content[:2048] + ""
                            "...[truncated]"
                        logger.info(
1581
                            "response_body={streaming_complete: "
1582
                            "content='%s', chunks=%d}",
1583
1584
1585
                            full_content,
                            chunk_count,
                        )
1586
1587
                    else:
                        logger.info(
1588
1589
1590
                            "response_body={streaming_complete: no_content, chunks=%d}",
                            chunk_count,
                        )
1591
1592
1593
                    return

    response.body_iterator = iterate_in_threadpool(buffered_iterator())
1594
    logger.info("response_body={streaming_started: chunks=%d}", len(response_body))
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605


def _log_non_streaming_response(response_body: list) -> None:
    """Log non-streaming response."""
    try:
        decoded_body = response_body[0].decode()
        logger.info("response_body={%s}", decoded_body)
    except UnicodeDecodeError:
        logger.info("response_body={<binary_data>}")


1606
def build_app(args: Namespace) -> FastAPI:
1607
    if args.disable_fastapi_docs:
1608
1609
1610
        app = FastAPI(
            openapi_url=None, docs_url=None, redoc_url=None, lifespan=lifespan
        )
1611
1612
    else:
        app = FastAPI(lifespan=lifespan)
Ethan Xu's avatar
Ethan Xu committed
1613
1614
    app.include_router(router)
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
1615

1616
1617
    mount_metrics(app)

Zhuohan Li's avatar
Zhuohan Li committed
1618
1619
1620
1621
1622
1623
1624
1625
    app.add_middleware(
        CORSMiddleware,
        allow_origins=args.allowed_origins,
        allow_credentials=args.allow_credentials,
        allow_methods=args.allowed_methods,
        allow_headers=args.allowed_headers,
    )

1626
1627
    @app.exception_handler(HTTPException)
    async def http_exception_handler(_: Request, exc: HTTPException):
1628
        err = ErrorResponse(
1629
1630
1631
1632
1633
1634
            error=ErrorInfo(
                message=exc.detail,
                type=HTTPStatus(exc.status_code).phrase,
                code=exc.status_code,
            )
        )
1635
1636
        return JSONResponse(err.model_dump(), status_code=exc.status_code)

Ethan Xu's avatar
Ethan Xu committed
1637
    @app.exception_handler(RequestValidationError)
1638
    async def validation_exception_handler(_: Request, exc: RequestValidationError):
1639
1640
1641
1642
1643
1644
1645
1646
        exc_str = str(exc)
        errors_str = str(exc.errors())

        if exc.errors() and errors_str and errors_str != exc_str:
            message = f"{exc_str} {errors_str}"
        else:
            message = exc_str

1647
1648
1649
1650
1651
1652
1653
1654
        err = ErrorResponse(
            error=ErrorInfo(
                message=message,
                type=HTTPStatus.BAD_REQUEST.phrase,
                code=HTTPStatus.BAD_REQUEST,
            )
        )
        return JSONResponse(err.model_dump(), status_code=HTTPStatus.BAD_REQUEST)
Ethan Xu's avatar
Ethan Xu committed
1655

1656
    # Ensure --api-key option from CLI takes precedence over VLLM_API_KEY
1657
1658
    if tokens := [key for key in (args.api_key or [envs.VLLM_API_KEY]) if key]:
        app.add_middleware(AuthenticationMiddleware, tokens=tokens)
1659

1660
    if args.enable_request_id_headers:
1661
        app.add_middleware(XRequestIdMiddleware)
1662

1663
1664
1665
    # Add scaling middleware to check for scaling state
    app.add_middleware(ScalingMiddleware)

1666
    if envs.VLLM_DEBUG_LOG_API_SERVER_RESPONSE:
1667
1668
1669
1670
1671
        logger.warning(
            "CAUTION: Enabling log response in the API Server. "
            "This can include sensitive information and should be "
            "avoided in production."
        )
1672
1673
1674
1675

        @app.middleware("http")
        async def log_response(request: Request, call_next):
            response = await call_next(request)
1676
            response_body = [section async for section in response.body_iterator]
1677
            response.body_iterator = iterate_in_threadpool(iter(response_body))
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
            # Check if this is a streaming response by looking at content-type
            content_type = response.headers.get("content-type", "")
            is_streaming = content_type == "text/event-stream; charset=utf-8"

            # Log response body based on type
            if not response_body:
                logger.info("response_body={<empty>}")
            elif is_streaming:
                _log_streaming_response(response, response_body)
            else:
                _log_non_streaming_response(response_body)
1689
            return response
1690

1691
1692
1693
1694
    for middleware in args.middleware:
        module_path, object_name = middleware.rsplit(".", 1)
        imported = getattr(importlib.import_module(module_path), object_name)
        if inspect.isclass(imported):
1695
            app.add_middleware(imported)  # type: ignore[arg-type]
1696
1697
1698
        elif inspect.iscoroutinefunction(imported):
            app.middleware("http")(imported)
        else:
1699
1700
1701
            raise ValueError(
                f"Invalid middleware {middleware}. Must be a function or a class."
            )
1702

Ethan Xu's avatar
Ethan Xu committed
1703
1704
1705
    return app


1706
async def init_app_state(
1707
    engine_client: EngineClient,
1708
    state: State,
1709
    args: Namespace,
1710
) -> None:
1711
1712
    vllm_config = engine_client.vllm_config

1713
    if args.served_model_name is not None:
1714
        served_model_names = args.served_model_name
1715
    else:
1716
        served_model_names = [args.model]
1717

1718
    if args.enable_log_requests:
1719
        request_logger = RequestLogger(max_log_len=args.max_log_len)
1720
1721
    else:
        request_logger = None
1722

1723
    base_model_paths = [
1724
        BaseModelPath(name=name, model_path=args.model) for name in served_model_names
1725
1726
    ]

1727
    state.engine_client = engine_client
1728
    state.log_stats = not args.disable_log_stats
1729
    state.vllm_config = vllm_config
Ethan Xu's avatar
Ethan Xu committed
1730

1731
    supported_tasks = await engine_client.get_supported_tasks()
1732
    logger.info("Supported tasks: %s", supported_tasks)
1733

1734
1735
1736
    resolved_chat_template = await process_chat_template(
        args.chat_template, engine_client, vllm_config.model_config
    )
1737

1738
    if args.tool_server == "demo":
1739
        tool_server: ToolServer | None = DemoToolServer()
1740
1741
        assert isinstance(tool_server, DemoToolServer)
        await tool_server.init_and_validate()
1742
1743
1744
    elif args.tool_server:
        tool_server = MCPToolServer()
        await tool_server.add_tool_server(args.tool_server)
1745
1746
1747
    else:
        tool_server = None

1748
    # Merge default_mm_loras into the static lora_modules
1749
1750
1751
1752
1753
    default_mm_loras = (
        vllm_config.lora_config.default_mm_loras
        if vllm_config.lora_config is not None
        else {}
    )
1754

1755
1756
1757
1758
1759
1760
    default_mm_loras = (
        vllm_config.lora_config.default_mm_loras
        if vllm_config.lora_config is not None
        else {}
    )
    lora_modules = process_lora_modules(args.lora_modules, default_mm_loras)
1761

1762
    state.openai_serving_models = OpenAIServingModels(
1763
        engine_client=engine_client,
1764
        base_model_paths=base_model_paths,
1765
        lora_modules=lora_modules,
1766
    )
1767
    await state.openai_serving_models.init_static_loras()
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
    state.openai_serving_responses = (
        OpenAIServingResponses(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            chat_template=resolved_chat_template,
            chat_template_content_format=args.chat_template_content_format,
            return_tokens_as_token_ids=args.return_tokens_as_token_ids,
            enable_auto_tools=args.enable_auto_tool_choice,
            tool_parser=args.tool_call_parser,
            tool_server=tool_server,
            reasoning_parser=args.structured_outputs_config.reasoning_parser,
            enable_prompt_tokens_details=args.enable_prompt_tokens_details,
            enable_force_include_usage=args.enable_force_include_usage,
            enable_log_outputs=args.enable_log_outputs,
            log_error_stack=args.log_error_stack,
        )
        if "generate" in supported_tasks
        else None
    )
    state.openai_serving_chat = (
        OpenAIServingChat(
            engine_client,
            state.openai_serving_models,
            args.response_role,
            request_logger=request_logger,
            chat_template=resolved_chat_template,
            chat_template_content_format=args.chat_template_content_format,
            trust_request_chat_template=args.trust_request_chat_template,
            return_tokens_as_token_ids=args.return_tokens_as_token_ids,
            enable_auto_tools=args.enable_auto_tool_choice,
            exclude_tools_when_tool_choice_none=args.exclude_tools_when_tool_choice_none,
            tool_parser=args.tool_call_parser,
            reasoning_parser=args.structured_outputs_config.reasoning_parser,
            enable_prompt_tokens_details=args.enable_prompt_tokens_details,
            enable_force_include_usage=args.enable_force_include_usage,
            enable_log_outputs=args.enable_log_outputs,
            log_error_stack=args.log_error_stack,
        )
        if "generate" in supported_tasks
        else None
    )
    state.openai_serving_completion = (
        OpenAIServingCompletion(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            return_tokens_as_token_ids=args.return_tokens_as_token_ids,
            enable_prompt_tokens_details=args.enable_prompt_tokens_details,
            enable_force_include_usage=args.enable_force_include_usage,
            log_error_stack=args.log_error_stack,
        )
        if "generate" in supported_tasks
        else None
    )
    state.openai_serving_pooling = (
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
        (
            OpenAIServingPooling(
                engine_client,
                state.openai_serving_models,
                supported_tasks=supported_tasks,
                request_logger=request_logger,
                chat_template=resolved_chat_template,
                chat_template_content_format=args.chat_template_content_format,
                trust_request_chat_template=args.trust_request_chat_template,
                log_error_stack=args.log_error_stack,
            )
1835
        )
1836
        if any(task in POOLING_TASKS for task in supported_tasks)
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
        else None
    )
    state.openai_serving_embedding = (
        OpenAIServingEmbedding(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            chat_template=resolved_chat_template,
            chat_template_content_format=args.chat_template_content_format,
            trust_request_chat_template=args.trust_request_chat_template,
            log_error_stack=args.log_error_stack,
        )
        if "embed" in supported_tasks
        else None
    )
    state.openai_serving_classification = (
        ServingClassification(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            log_error_stack=args.log_error_stack,
        )
        if "classify" in supported_tasks
        else None
    )
    state.openai_serving_scores = (
        ServingScores(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            log_error_stack=args.log_error_stack,
        )
        if ("embed" in supported_tasks or "score" in supported_tasks)
        else None
    )
1872
    state.openai_serving_tokenization = OpenAIServingTokenization(
1873
        engine_client,
1874
        state.openai_serving_models,
1875
        request_logger=request_logger,
1876
1877
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
1878
        trust_request_chat_template=args.trust_request_chat_template,
1879
        log_error_stack=args.log_error_stack,
1880
    )
1881
1882
1883
1884
1885
1886
    state.openai_serving_transcription = (
        OpenAIServingTranscription(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            log_error_stack=args.log_error_stack,
1887
            enable_force_include_usage=args.enable_force_include_usage,
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
        )
        if "transcription" in supported_tasks
        else None
    )
    state.openai_serving_translation = (
        OpenAIServingTranslation(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            log_error_stack=args.log_error_stack,
1898
            enable_force_include_usage=args.enable_force_include_usage,
1899
1900
1901
1902
        )
        if "transcription" in supported_tasks
        else None
    )
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
    state.anthropic_serving_messages = (
        AnthropicServingMessages(
            engine_client,
            state.openai_serving_models,
            args.response_role,
            request_logger=request_logger,
            chat_template=resolved_chat_template,
            chat_template_content_format=args.chat_template_content_format,
            return_tokens_as_token_ids=args.return_tokens_as_token_ids,
            enable_auto_tools=args.enable_auto_tool_choice,
            tool_parser=args.tool_call_parser,
            reasoning_parser=args.structured_outputs_config.reasoning_parser,
            enable_prompt_tokens_details=args.enable_prompt_tokens_details,
            enable_force_include_usage=args.enable_force_include_usage,
        )
        if "generate" in supported_tasks
        else None
    )
1921

1922
1923
1924
    state.enable_server_load_tracking = args.enable_server_load_tracking
    state.server_load_metrics = 0

1925

1926
def create_server_socket(addr: tuple[str, int]) -> socket.socket:
1927
1928
1929
1930
1931
1932
    family = socket.AF_INET
    if is_valid_ipv6_address(addr[0]):
        family = socket.AF_INET6

    sock = socket.socket(family=family, type=socket.SOCK_STREAM)
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1933
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
1934
1935
1936
1937
1938
    sock.bind(addr)

    return sock


1939
1940
1941
1942
1943
1944
def create_server_unix_socket(path: str) -> socket.socket:
    sock = socket.socket(family=socket.AF_UNIX, type=socket.SOCK_STREAM)
    sock.bind(path)
    return sock


1945
def validate_api_server_args(args):
1946
    valid_tool_parses = ToolParserManager.list_registered()
1947
1948
1949
1950
1951
    if args.enable_auto_tool_choice and args.tool_call_parser not in valid_tool_parses:
        raise KeyError(
            f"invalid tool call parser: {args.tool_call_parser} "
            f"(chose from {{ {','.join(valid_tool_parses)} }})"
        )
1952

1953
    valid_reasoning_parses = ReasoningParserManager.reasoning_parsers.keys()
1954
1955
1956
    if (
        reasoning_parser := args.structured_outputs_config.reasoning_parser
    ) and reasoning_parser not in valid_reasoning_parses:
1957
        raise KeyError(
1958
            f"invalid reasoning parser: {reasoning_parser} "
1959
1960
            f"(chose from {{ {','.join(valid_reasoning_parses)} }})"
        )
1961

1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974

def setup_server(args):
    """Validate API server args, set up signal handler, create socket
    ready to serve."""

    logger.info("vLLM API server version %s", VLLM_VERSION)
    log_non_default_args(args)

    if args.tool_parser_plugin and len(args.tool_parser_plugin) > 3:
        ToolParserManager.import_tool_parser(args.tool_parser_plugin)

    validate_api_server_args(args)

1975
1976
1977
    # workaround to make sure that we bind the port before the engine is set up.
    # This avoids race conditions with ray.
    # see https://github.com/vllm-project/vllm/issues/8204
1978
1979
1980
1981
1982
    if args.uds:
        sock = create_server_unix_socket(args.uds)
    else:
        sock_addr = (args.host or "", args.port)
        sock = create_server_socket(sock_addr)
1983

1984
1985
1986
1987
    # workaround to avoid footguns where uvicorn drops requests with too
    # many concurrent requests active
    set_ulimit()

1988
1989
1990
1991
1992
1993
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

1994
1995
1996
1997
1998
    if args.uds:
        listen_address = f"unix:{args.uds}"
    else:
        addr, port = sock_addr
        is_ssl = args.ssl_keyfile and args.ssl_certfile
1999
        host_part = f"[{addr}]" if is_valid_ipv6_address(addr) else addr or "0.0.0.0"
2000
        listen_address = f"http{'s' if is_ssl else ''}://{host_part}:{port}"
2001
2002
2003
2004
2005
    return listen_address, sock


async def run_server(args, **uvicorn_kwargs) -> None:
    """Run a single-worker API server."""
2006
2007

    # Add process-specific prefix to stdout and stderr.
2008
    decorate_logs("APIServer")
2009

2010
2011
2012
2013
    listen_address, sock = setup_server(args)
    await run_server_worker(listen_address, sock, args, **uvicorn_kwargs)


2014
2015
2016
async def run_server_worker(
    listen_address, sock, args, client_config=None, **uvicorn_kwargs
) -> None:
2017
2018
2019
2020
2021
    """Run a single API server worker."""

    if args.tool_parser_plugin and len(args.tool_parser_plugin) > 3:
        ToolParserManager.import_tool_parser(args.tool_parser_plugin)

2022
2023
2024
    # Load logging config for uvicorn if specified
    log_config = load_log_config(args.log_config_file)
    if log_config is not None:
2025
        uvicorn_kwargs["log_config"] = log_config
2026

2027
    async with build_async_engine_client(
2028
2029
        args,
        client_config=client_config,
2030
    ) as engine_client:
2031
        maybe_register_tokenizer_info_endpoint(args)
2032
2033
        app = build_app(args)

2034
        await init_app_state(engine_client, app.state, args)
2035

2036
2037
        logger.info(
            "Starting vLLM API server %d on %s",
2038
            engine_client.vllm_config.parallel_config._api_process_rank,
2039
2040
            listen_address,
        )
2041
2042
        shutdown_task = await serve_http(
            app,
2043
            sock=sock,
2044
            enable_ssl_refresh=args.enable_ssl_refresh,
2045
2046
2047
            host=args.host,
            port=args.port,
            log_level=args.uvicorn_log_level,
2048
2049
2050
            # NOTE: When the 'disable_uvicorn_access_log' value is True,
            # no access log will be output.
            access_log=not args.disable_uvicorn_access_log,
2051
            timeout_keep_alive=envs.VLLM_HTTP_TIMEOUT_KEEP_ALIVE,
2052
2053
2054
2055
            ssl_keyfile=args.ssl_keyfile,
            ssl_certfile=args.ssl_certfile,
            ssl_ca_certs=args.ssl_ca_certs,
            ssl_cert_reqs=args.ssl_cert_reqs,
2056
2057
            h11_max_incomplete_event_size=args.h11_max_incomplete_event_size,
            h11_max_header_count=args.h11_max_header_count,
2058
2059
2060
            **uvicorn_kwargs,
        )

2061
    # NB: Await server shutdown only after the backend context is exited
2062
2063
2064
2065
    try:
        await shutdown_task
    finally:
        sock.close()
2066

Ethan Xu's avatar
Ethan Xu committed
2067
2068
2069

if __name__ == "__main__":
    # NOTE(simon):
2070
2071
    # This section should be in sync with vllm/entrypoints/cli/main.py for CLI
    # entrypoints.
2072
    cli_env_setup()
Ethan Xu's avatar
Ethan Xu committed
2073
    parser = FlexibleArgumentParser(
2074
2075
        description="vLLM OpenAI-Compatible RESTful API server."
    )
Ethan Xu's avatar
Ethan Xu committed
2076
2077
    parser = make_arg_parser(parser)
    args = parser.parse_args()
2078
    validate_parsed_serve_args(args)
2079

2080
    uvloop.run(run_server(args))