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

122
prometheus_multiproc_dir: tempfile.TemporaryDirectory
123

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

127
_running_tasks: set[asyncio.Task] = set()
128

129

130
@asynccontextmanager
131
async def lifespan(app: FastAPI):
132
133
    try:
        if app.state.log_stats:
134
            engine_client: EngineClient = app.state.engine_client
135
136
137

            async def _force_log():
                while True:
138
                    await asyncio.sleep(envs.VLLM_LOG_STATS_INTERVAL)
139
                    await engine_client.do_log_stats()
140
141
142
143
144
145

            task = asyncio.create_task(_force_log())
            _running_tasks.add(task)
            task.add_done_callback(_running_tasks.remove)
        else:
            task = None
146
147
148
149
150

        # Mark the startup heap as static so that it's ignored by GC.
        # Reduces pause times of oldest generation collections.
        gc.collect()
        gc.freeze()
151
152
153
154
155
156
157
158
        try:
            yield
        finally:
            if task is not None:
                task.cancel()
    finally:
        # Ensure app state including engine ref is gc'd
        del app.state
159
160


161
@asynccontextmanager
162
async def build_async_engine_client(
163
    args: Namespace,
164
165
    *,
    usage_context: UsageContext = UsageContext.OPENAI_API_SERVER,
166
167
    disable_frontend_multiprocessing: bool | None = None,
    client_config: dict[str, Any] | None = None,
168
) -> AsyncIterator[EngineClient]:
169
170
171
172
    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")
173
        multiprocessing.set_start_method("forkserver")
174
175
176
177
        multiprocessing.set_forkserver_preload(["vllm.v1.engine.async_llm"])
        forkserver.ensure_running()
        logger.debug("Forkserver setup complete!")

178
    # Context manager to handle engine_client lifecycle
179
180
    # Ensures everything is shutdown and cleaned up on error/exit
    engine_args = AsyncEngineArgs.from_cli_args(args)
181
182
183
    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)
184

185
    if disable_frontend_multiprocessing is None:
186
        disable_frontend_multiprocessing = bool(args.disable_frontend_multiprocessing)
187

188
    async with build_async_engine_client_from_engine_args(
189
190
191
192
        engine_args,
        usage_context=usage_context,
        disable_frontend_multiprocessing=disable_frontend_multiprocessing,
        client_config=client_config,
193
    ) as engine:
194
195
196
197
198
199
        yield engine


@asynccontextmanager
async def build_async_engine_client_from_engine_args(
    engine_args: AsyncEngineArgs,
200
201
    *,
    usage_context: UsageContext = UsageContext.OPENAI_API_SERVER,
202
    disable_frontend_multiprocessing: bool = False,
203
    client_config: dict[str, Any] | None = None,
204
) -> AsyncIterator[EngineClient]:
205
    """
206
    Create EngineClient, either:
207
208
209
210
211
212
        - in-process using the AsyncLLMEngine Directly
        - multiprocess using AsyncLLMEngine RPC

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

213
214
215
216
    # Create the EngineConfig (determines if we can use V1).
    vllm_config = engine_args.create_engine_config(usage_context=usage_context)

    # V1 AsyncLLM.
217
    assert envs.VLLM_USE_V1
218

219
220
221
    if disable_frontend_multiprocessing:
        logger.warning(
            "V1 is enabled, but got --disable-frontend-multiprocessing. "
222
223
            "To disable frontend multiprocessing, set VLLM_USE_V1=0."
        )
224

225
    from vllm.v1.engine.async_llm import AsyncLLM
226

227
    async_llm: AsyncLLM | None = None
228
229
230
231
232
233

    # 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)

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

        # Don't keep the dummy data in memory
        await async_llm.reset_mm_cache()

        yield async_llm
    finally:
        if async_llm:
            async_llm.shutdown()
253
254


255
256
async def validate_json_request(raw_request: Request):
    content_type = raw_request.headers.get("content-type", "").lower()
257
258
    media_type = content_type.split(";", maxsplit=1)[0]
    if media_type != "application/json":
259
260
261
        raise RequestValidationError(
            errors=["Unsupported Media Type: Only 'application/json' is allowed"]
        )
262
263


Ethan Xu's avatar
Ethan Xu committed
264
router = APIRouter()
Zhuohan Li's avatar
Zhuohan Li committed
265

266

267
268
269
270
class PrometheusResponse(Response):
    media_type = prometheus_client.CONTENT_TYPE_LATEST


271
def mount_metrics(app: FastAPI):
272
273
274
    """Mount prometheus metrics to a FastAPI app."""

    registry = get_prometheus_registry()
275

276
277
278
279
    # `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
280
281
282
283
284
285
286
287
288
289
    Instrumentator(
        excluded_handlers=[
            "/metrics",
            "/health",
            "/load",
            "/ping",
            "/version",
            "/server_info",
        ],
        registry=registry,
290
    ).add().instrument(app).expose(app, response_class=PrometheusResponse)
291
292
293

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

295
    # Workaround for 307 Redirect for /metrics
296
    metrics_route.path_regex = re.compile("^/metrics(?P<path>.*)$")
297
    app.routes.append(metrics_route)
298
299


300
301
302
303
304
def base(request: Request) -> OpenAIServing:
    # Reuse the existing instance
    return tokenization(request)


305
306
307
308
def models(request: Request) -> OpenAIServingModels:
    return request.app.state.openai_serving_models


309
def responses(request: Request) -> OpenAIServingResponses | None:
310
311
312
    return request.app.state.openai_serving_responses


313
def chat(request: Request) -> OpenAIServingChat | None:
314
315
316
    return request.app.state.openai_serving_chat


317
def completion(request: Request) -> OpenAIServingCompletion | None:
318
319
320
    return request.app.state.openai_serving_completion


321
def pooling(request: Request) -> OpenAIServingPooling | None:
322
323
324
    return request.app.state.openai_serving_pooling


325
def embedding(request: Request) -> OpenAIServingEmbedding | None:
326
    return request.app.state.openai_serving_embedding
327
328


329
def score(request: Request) -> ServingScores | None:
330
331
332
    return request.app.state.openai_serving_scores


333
def classify(request: Request) -> ServingClassification | None:
334
335
336
    return request.app.state.openai_serving_classification


337
def rerank(request: Request) -> ServingScores | None:
338
    return request.app.state.openai_serving_scores
339
340


341
342
def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
343
344


345
346
347
348
def transcription(request: Request) -> OpenAIServingTranscription:
    return request.app.state.openai_serving_transcription


349
350
351
352
def translation(request: Request) -> OpenAIServingTranslation:
    return request.app.state.openai_serving_translation


353
def engine_client(request: Request) -> EngineClient:
354
355
356
    return request.app.state.engine_client


357
358
@router.get("/health", response_class=Response)
async def health(raw_request: Request) -> Response:
359
    """Health check."""
360
361
362
363
364
    try:
        await engine_client(raw_request).check_health()
        return Response(status_code=200)
    except EngineDeadError:
        return Response(status_code=503)
365
366


367
368
369
370
371
372
373
@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
374
    # - /v1/audio/translations
375
376
    # - /v1/embeddings
    # - /pooling
377
    # - /classify
378
379
380
381
382
    # - /score
    # - /v1/score
    # - /rerank
    # - /v1/rerank
    # - /v2/rerank
383
    return JSONResponse(content={"server_load": request.app.state.server_load_metrics})
384
385


386
387
388
@router.get("/ping", response_class=Response)
@router.post("/ping", response_class=Response)
async def ping(raw_request: Request) -> Response:
389
390
391
392
    """Ping check. Endpoint required for SageMaker"""
    return await health(raw_request)


393
394
395
396
397
398
399
400
401
402
@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},
    },
)
403
@with_cancellation
404
async def tokenize(request: TokenizeRequest, raw_request: Request):
405
406
    handler = tokenization(raw_request)

407
408
409
    try:
        generator = await handler.create_tokenize(request, raw_request)
    except NotImplementedError as e:
410
411
412
        raise HTTPException(
            status_code=HTTPStatus.NOT_IMPLEMENTED.value, detail=str(e)
        ) from e
413
    except Exception as e:
414
415
416
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
417

418
    if isinstance(generator, ErrorResponse):
419
420
421
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
422
    elif isinstance(generator, TokenizeResponse):
423
424
        return JSONResponse(content=generator.model_dump())

425
426
    assert_never(generator)

427

428
429
430
431
432
433
434
435
436
@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},
    },
)
437
@with_cancellation
438
async def detokenize(request: DetokenizeRequest, raw_request: Request):
439
440
    handler = tokenization(raw_request)

441
442
443
444
445
    try:
        generator = await handler.create_detokenize(request, raw_request)
    except OverflowError as e:
        raise RequestValidationError(errors=[str(e)]) from e
    except Exception as e:
446
447
448
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
449

450
    if isinstance(generator, ErrorResponse):
451
452
453
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
454
    elif isinstance(generator, DetokenizeResponse):
455
456
        return JSONResponse(content=generator.model_dump())

457
458
    assert_never(generator)

459

460
461
def maybe_register_tokenizer_info_endpoint(args):
    """Conditionally register the tokenizer info endpoint if enabled."""
462
    if getattr(args, "enable_tokenizer_info_endpoint", False):
463
464
465
466
467

        @router.get("/tokenizer_info")
        async def get_tokenizer_info(raw_request: Request):
            """Get comprehensive tokenizer information."""
            result = await tokenization(raw_request).get_tokenizer_info()
468
469
470
471
472
473
            return JSONResponse(
                content=result.model_dump(),
                status_code=result.error.code
                if isinstance(result, ErrorResponse)
                else 200,
            )
474
475


Ethan Xu's avatar
Ethan Xu committed
476
@router.get("/v1/models")
477
async def show_available_models(raw_request: Request):
478
    handler = models(raw_request)
479

480
481
    models_ = await handler.show_available_models()
    return JSONResponse(content=models_.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
482
483


Ethan Xu's avatar
Ethan Xu committed
484
@router.get("/version")
485
async def show_version():
486
    ver = {"version": VLLM_VERSION}
487
488
489
    return JSONResponse(content=ver)


490
async def _convert_stream_to_sse_events(
491
    generator: AsyncGenerator[StreamingResponsesResponse, None],
492
) -> AsyncGenerator[str, None]:
493
494
    """Convert the generator to a stream of events in SSE format"""
    async for event in generator:
495
        event_type = getattr(event, "type", "unknown")
496
        # https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event_stream_format
497
498
499
        event_data = (
            f"event: {event_type}\ndata: {event.model_dump_json(indent=None)}\n\n"
        )
500
501
502
        yield event_data


503
504
505
506
507
508
509
510
511
512
@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},
    },
)
513
514
515
516
517
@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(
518
519
            message="The model does not support Responses API"
        )
520
521
522
    try:
        generator = await handler.create_responses(request, raw_request)
    except Exception as e:
523
524
525
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
526
527

    if isinstance(generator, ErrorResponse):
528
529
530
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
531
532
    elif isinstance(generator, ResponsesResponse):
        return JSONResponse(content=generator.model_dump())
533

534
535
536
    return StreamingResponse(
        content=_convert_stream_to_sse_events(generator), media_type="text/event-stream"
    )
537
538
539


@router.get("/v1/responses/{response_id}")
540
541
542
async def retrieve_responses(
    response_id: str,
    raw_request: Request,
543
544
    starting_after: int | None = None,
    stream: bool | None = False,
545
):
546
547
548
    handler = responses(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
549
550
            message="The model does not support Responses API"
        )
551

552
    try:
553
554
555
556
557
        response = await handler.retrieve_responses(
            response_id,
            starting_after=starting_after,
            stream=stream,
        )
558
    except Exception as e:
559
560
561
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
562
563

    if isinstance(response, ErrorResponse):
564
565
566
        return JSONResponse(
            content=response.model_dump(), status_code=response.error.code
        )
567
568
    elif isinstance(response, ResponsesResponse):
        return JSONResponse(content=response.model_dump())
569
570
571
    return StreamingResponse(
        content=_convert_stream_to_sse_events(response), media_type="text/event-stream"
    )
572
573
574
575
576
577
578


@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(
579
580
            message="The model does not support Responses API"
        )
581

582
583
584
    try:
        response = await handler.cancel_responses(response_id)
    except Exception as e:
585
586
587
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
588
589

    if isinstance(response, ErrorResponse):
590
591
592
        return JSONResponse(
            content=response.model_dump(), status_code=response.error.code
        )
593
594
595
    return JSONResponse(content=response.model_dump())


596
597
598
599
600
601
602
603
604
605
@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},
    },
)
606
@with_cancellation
607
@load_aware_call
608
async def create_chat_completion(request: ChatCompletionRequest, raw_request: Request):
609
610
611
    handler = chat(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
612
613
            message="The model does not support Chat Completions API"
        )
614
615
616
    try:
        generator = await handler.create_chat_completion(request, raw_request)
    except Exception as e:
617
618
619
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
620
    if isinstance(generator, ErrorResponse):
621
622
623
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
624

625
    elif isinstance(generator, ChatCompletionResponse):
626
        return JSONResponse(content=generator.model_dump())
627

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

630

631
632
633
634
635
636
637
638
639
640
@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},
    },
)
641
@with_cancellation
642
@load_aware_call
643
async def create_completion(request: CompletionRequest, raw_request: Request):
644
645
646
    handler = completion(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
647
648
            message="The model does not support Completions API"
        )
649

650
651
652
    try:
        generator = await handler.create_completion(request, raw_request)
    except OverflowError as e:
653
654
655
        raise HTTPException(
            status_code=HTTPStatus.BAD_REQUEST.value, detail=str(e)
        ) from e
656
    except Exception as e:
657
658
659
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
660

661
    if isinstance(generator, ErrorResponse):
662
663
664
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
665
    elif isinstance(generator, CompletionResponse):
666
        return JSONResponse(content=generator.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
667

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

Zhuohan Li's avatar
Zhuohan Li committed
670

671
672
673
674
675
676
677
678
@router.post(
    "/v1/embeddings",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
679
@with_cancellation
680
@load_aware_call
681
682
683
684
async def create_embedding(
    request: EmbeddingRequest,
    raw_request: Request,
):
685
686
    handler = embedding(raw_request)
    if handler is None:
687
        return base(raw_request).create_error_response(
688
689
            message="The model does not support Embeddings API"
        )
690

691
692
693
    try:
        generator = await handler.create_embedding(request, raw_request)
    except Exception as e:
694
695
696
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
697

698
    if isinstance(generator, ErrorResponse):
699
700
701
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
702
    elif isinstance(generator, EmbeddingResponse):
703
        return JSONResponse(content=generator.model_dump())
704
705
706
707
708
709
    elif isinstance(generator, EmbeddingBytesResponse):
        return StreamingResponse(
            content=generator.body,
            headers={"metadata": generator.metadata},
            media_type=generator.media_type,
        )
710

711
712
    assert_never(generator)

713

714
715
716
717
718
719
720
721
@router.post(
    "/pooling",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
722
@with_cancellation
723
@load_aware_call
724
725
726
727
async def create_pooling(request: PoolingRequest, raw_request: Request):
    handler = pooling(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
728
729
            message="The model does not support Pooling API"
        )
730
731
732
    try:
        generator = await handler.create_pooling(request, raw_request)
    except Exception as e:
733
734
735
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
736
    if isinstance(generator, ErrorResponse):
737
738
739
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
740
    elif isinstance(generator, (PoolingResponse, IOProcessorResponse)):
741
        return JSONResponse(content=generator.model_dump())
742
743
744
745
746
747
    elif isinstance(generator, PoolingBytesResponse):
        return StreamingResponse(
            content=generator.body,
            headers={"metadata": generator.metadata},
            media_type=generator.media_type,
        )
748
749
750
751

    assert_never(generator)


752
753
754
@router.post("/classify", dependencies=[Depends(validate_json_request)])
@with_cancellation
@load_aware_call
755
async def create_classify(request: ClassificationRequest, raw_request: Request):
756
757
758
    handler = classify(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
759
760
            message="The model does not support Classification API"
        )
761

762
763
764
    try:
        generator = await handler.create_classify(request, raw_request)
    except Exception as e:
765
766
767
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
768
    if isinstance(generator, ErrorResponse):
769
770
771
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
772
773
774
775
776
777
778

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

    assert_never(generator)


779
780
781
782
783
784
785
786
@router.post(
    "/score",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
787
@with_cancellation
788
@load_aware_call
789
790
791
792
async def create_score(request: ScoreRequest, raw_request: Request):
    handler = score(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
793
794
            message="The model does not support Score API"
        )
795

796
797
798
    try:
        generator = await handler.create_score(request, raw_request)
    except Exception as e:
799
800
801
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
802
    if isinstance(generator, ErrorResponse):
803
804
805
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
806
807
808
809
810
811
    elif isinstance(generator, ScoreResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


812
813
814
815
816
817
818
819
@router.post(
    "/v1/score",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
820
@with_cancellation
821
@load_aware_call
822
823
824
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 "
825
826
        "have moved it to `/score`. Please update your client accordingly."
    )
827
828
829
830

    return await create_score(request, raw_request)


831
832
833
834
835
836
837
838
839
@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},
    },
)
840
@with_cancellation
841
@load_aware_call
842
843
844
async def create_transcriptions(
    raw_request: Request, request: Annotated[TranscriptionRequest, Form()]
):
845
846
847
    handler = transcription(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
848
849
            message="The model does not support Transcriptions API"
        )
850
851

    audio_data = await request.file.read()
852
    try:
853
        generator = await handler.create_transcription(audio_data, request, raw_request)
854
    except Exception as e:
855
856
857
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
858
859

    if isinstance(generator, ErrorResponse):
860
861
862
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
863
864
865
866
867
868
869

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

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


870
871
872
873
874
875
876
877
878
@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},
    },
)
879
880
@with_cancellation
@load_aware_call
881
882
883
async def create_translations(
    request: Annotated[TranslationRequest, Form()], raw_request: Request
):
884
885
886
    handler = translation(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
887
888
            message="The model does not support Translations API"
        )
889
890

    audio_data = await request.file.read()
891
    try:
892
        generator = await handler.create_translation(audio_data, request, raw_request)
893
    except Exception as e:
894
895
896
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
897
898

    if isinstance(generator, ErrorResponse):
899
900
901
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
902
903
904
905
906
907
908

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

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


909
910
911
912
913
914
915
916
@router.post(
    "/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
917
@with_cancellation
918
@load_aware_call
919
920
921
922
async def do_rerank(request: RerankRequest, raw_request: Request):
    handler = rerank(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
923
924
            message="The model does not support Rerank (Score) API"
        )
925
926
927
    try:
        generator = await handler.do_rerank(request, raw_request)
    except Exception as e:
928
929
930
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
931
    if isinstance(generator, ErrorResponse):
932
933
934
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
935
936
937
938
939
940
    elif isinstance(generator, RerankResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


941
942
943
944
945
946
947
948
@router.post(
    "/v1/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
949
950
@with_cancellation
async def do_rerank_v1(request: RerankRequest, raw_request: Request):
951
    logger.warning_once(
952
        "To indicate that the rerank API is not part of the standard OpenAI"
953
        " API, we have located it at `/rerank`. Please update your client "
954
955
        "accordingly. (Note: Conforms to JinaAI rerank API)"
    )
956
957
958
959

    return await do_rerank(request, raw_request)


960
961
962
963
964
965
966
967
@router.post(
    "/v2/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
968
969
970
971
972
@with_cancellation
async def do_rerank_v2(request: RerankRequest, raw_request: Request):
    return await do_rerank(request, raw_request)


973
if envs.VLLM_SERVER_DEV_MODE:
974
975
976
977
    logger.warning(
        "SECURITY WARNING: Development endpoints are enabled! "
        "This should NOT be used in production!"
    )
978

979
980
    PydanticVllmConfig = pydantic.TypeAdapter(VllmConfig)

981
    @router.get("/server_info")
982
983
    async def show_server_info(
        raw_request: Request,
984
        config_format: Annotated[Literal["text", "json"], Query()] = "text",
985
986
987
    ):
        vllm_config: VllmConfig = raw_request.app.state.vllm_config
        server_info = {
988
989
990
            "vllm_config": str(vllm_config)
            if config_format == "text"
            else PydanticVllmConfig.dump_python(vllm_config, mode="json", fallback=str)
991
992
            # fallback=str is needed to handle e.g. torch.dtype
        }
993
994
        return JSONResponse(content=server_info)

995
996
997
998
999
1000
    @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.
        """
1001
1002
1003
1004
1005
1006
        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)
1007
1008
        return Response(status_code=200)

1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
    @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)

1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
    @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):
1030
1031
1032
1033
1034
1035
        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)
1036
1037
1038
1039
        # 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)

1040
1041
1042
1043
1044
1045
    @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})

1046
1047
1048
1049
1050
    @router.post("/collective_rpc")
    async def collective_rpc(raw_request: Request):
        try:
            body = await raw_request.json()
        except json.JSONDecodeError as e:
1051
1052
1053
1054
            raise HTTPException(
                status_code=HTTPStatus.BAD_REQUEST.value,
                detail=f"JSON decode error: {e}",
            ) from e
1055
1056
        method = body.get("method")
        if method is None:
1057
1058
1059
1060
            raise HTTPException(
                status_code=HTTPStatus.BAD_REQUEST.value,
                detail="Missing 'method' in request body",
            )
1061
        # For security reason, only serialized string args/kwargs are passed.
1062
        # User-defined `method` is responsible for deserialization if needed.
1063
1064
        args: list[str] = body.get("args", [])
        kwargs: dict[str, str] = body.get("kwargs", {})
1065
        timeout: float | None = body.get("timeout")
1066
        results = await engine_client(raw_request).collective_rpc(
1067
1068
            method=method, timeout=timeout, args=tuple(args), kwargs=kwargs
        )
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
        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})

1079

1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
@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},
    },
)
1090
1091
1092
1093
async def scale_elastic_ep(raw_request: Request):
    try:
        body = await raw_request.json()
    except json.JSONDecodeError as e:
1094
        raise HTTPException(status_code=400, detail="Invalid JSON format") from e  # noqa: B904
1095
1096
1097
1098
1099

    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:
1100
1101
1102
        raise HTTPException(
            status_code=400, detail="new_data_parallel_size is required"
        )
1103

1104
    if not isinstance(new_data_parallel_size, int) or new_data_parallel_size <= 0:
1105
        raise HTTPException(
1106
1107
            status_code=400, detail="new_data_parallel_size must be a positive integer"
        )
1108
1109

    if not isinstance(drain_timeout, int) or drain_timeout <= 0:
1110
1111
1112
        raise HTTPException(
            status_code=400, detail="drain_timeout must be a positive integer"
        )
1113
1114
1115
1116
1117
1118
1119

    # 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)
1120
1121
1122
1123
1124
        return JSONResponse(
            {
                "message": f"Scaled to {new_data_parallel_size} data parallel engines",
            }
        )
1125
    except TimeoutError as e:
1126
1127
1128
1129
1130
        raise HTTPException(
            status_code=408,
            detail="Scale failed due to request drain timeout "
            f"after {drain_timeout} seconds",
        ) from e
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
    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})


1143
1144
1145
# TODO: RequestType = TypeForm[BaseModel] when recognized by type checkers
# (requires typing_extensions >= 4.13)
RequestType = Any
1146
GetHandlerFn = Callable[[Request], OpenAIServing | None]
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
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
]


1167
1168
1169
1170
1171
1172
1173
1174
1175
@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},
    },
)
1176
async def invocations(raw_request: Request):
1177
    """For SageMaker, routes requests based on the request type."""
1178
1179
    try:
        body = await raw_request.json()
1180
    except json.JSONDecodeError as e:
1181
1182
1183
        raise HTTPException(
            status_code=HTTPStatus.BAD_REQUEST.value, detail=f"JSON decode error: {e}"
        ) from e
1184

1185
1186
1187
1188
1189
    valid_endpoints = [
        (validator, endpoint)
        for validator, (get_handler, endpoint) in INVOCATION_VALIDATORS
        if get_handler(raw_request) is not None
    ]
1190

1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
    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
    ]
1203
    msg = f"Cannot find suitable handler for request. Expected one of: {type_names}"
1204
    res = base(raw_request).create_error_response(message=msg)
1205
    return JSONResponse(content=res.model_dump(), status_code=res.error.code)
1206
1207


1208
1209
1210
if envs.VLLM_TORCH_PROFILER_DIR:
    logger.warning(
        "Torch Profiler is enabled in the API server. This should ONLY be "
1211
1212
        "used for local development!"
    )
1213
1214

    @router.post("/start_profile")
1215
    async def start_profile(raw_request: Request):
1216
        logger.info("Starting profiler...")
1217
        await engine_client(raw_request).start_profile()
1218
1219
1220
1221
        logger.info("Profiler started.")
        return Response(status_code=200)

    @router.post("/stop_profile")
1222
    async def stop_profile(raw_request: Request):
1223
        logger.info("Stopping profiler...")
1224
        await engine_client(raw_request).stop_profile()
1225
1226
1227
1228
        logger.info("Profiler stopped.")
        return Response(status_code=200)


1229
1230
if envs.VLLM_ALLOW_RUNTIME_LORA_UPDATING:
    logger.warning(
1231
        "LoRA dynamic loading & unloading is enabled in the API server. "
1232
1233
        "This should ONLY be used for local development!"
    )
1234

1235
1236
    @router.post("/v1/load_lora_adapter", dependencies=[Depends(validate_json_request)])
    async def load_lora_adapter(request: LoadLoRAAdapterRequest, raw_request: Request):
1237
1238
1239
        handler = models(raw_request)
        response = await handler.load_lora_adapter(request)
        if isinstance(response, ErrorResponse):
1240
1241
1242
            return JSONResponse(
                content=response.model_dump(), status_code=response.error.code
            )
1243
1244
1245

        return Response(status_code=200, content=response)

1246
1247
1248
1249
1250
1251
    @router.post(
        "/v1/unload_lora_adapter", dependencies=[Depends(validate_json_request)]
    )
    async def unload_lora_adapter(
        request: UnloadLoRAAdapterRequest, raw_request: Request
    ):
1252
1253
1254
        handler = models(raw_request)
        response = await handler.unload_lora_adapter(request)
        if isinstance(response, ErrorResponse):
1255
1256
1257
            return JSONResponse(
                content=response.model_dump(), status_code=response.error.code
            )
1258
1259
1260
1261

        return Response(status_code=200, content=response)


1262
def load_log_config(log_config_file: str | None) -> dict | None:
1263
1264
1265
1266
1267
1268
    if not log_config_file:
        return None
    try:
        with open(log_config_file) as f:
            return json.load(f)
    except Exception as e:
1269
1270
1271
        logger.warning(
            "Failed to load log config from file %s: error %s", log_config_file, e
        )
1272
1273
1274
        return None


1275
1276
1277
class AuthenticationMiddleware:
    """
    Pure ASGI middleware that authenticates each request by checking
1278
    if the Authorization Bearer token exists and equals anyof "{api_key}".
1279
1280
1281
1282
1283
1284
1285
1286

    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).
    """

1287
    def __init__(self, app: ASGIApp, tokens: list[str]) -> None:
1288
        self.app = app
1289
        self.api_tokens = [hashlib.sha256(t.encode("utf-8")).digest() for t in tokens]
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306

    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
1307

1308
1309
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
        if scope["type"] not in ("http", "websocket") or scope["method"] == "OPTIONS":
1310
1311
1312
1313
1314
1315
1316
            # 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.
1317
        if url_path.startswith("/v1") and not self.verify_token(headers):
1318
            response = JSONResponse(content={"error": "Unauthorized"}, status_code=401)
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
            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

1333
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
        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"])
1347
                request_id = request_headers.get("X-Request-Id", uuid.uuid4().hex)
1348
1349
1350
1351
1352
1353
                response_headers.append("X-Request-Id", request_id)
            await send(message)

        return self.app(scope, receive, send_with_request_id)


1354
1355
1356
1357
1358
1359
1360
1361
# 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.
1362

1363
1364
1365
1366
1367
1368
1369
    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

1370
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
1371
1372
1373
1374
1375
1376
1377
        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
1378
1379
1380
1381
1382
1383
            response = JSONResponse(
                content={
                    "error": "The model is currently scaling. Please try again later."
                },
                status_code=503,
            )
1384
1385
1386
1387
1388
            return response(scope, receive, send)

        return self.app(scope, receive, send)


1389
1390
1391
1392
def _extract_content_from_chunk(chunk_data: dict) -> str:
    """Extract content from a streaming response chunk."""
    try:
        from vllm.entrypoints.openai.protocol import (
1393
1394
1395
            ChatCompletionStreamResponse,
            CompletionStreamResponse,
        )
1396
1397

        # Try using Completion types for type-safe parsing
1398
1399
        if chunk_data.get("object") == "chat.completion.chunk":
            chat_response = ChatCompletionStreamResponse.model_validate(chunk_data)
1400
1401
            if chat_response.choices and chat_response.choices[0].delta.content:
                return chat_response.choices[0].delta.content
1402
1403
1404
        elif chunk_data.get("object") == "text_completion":
            completion_response = CompletionStreamResponse.model_validate(chunk_data)
            if completion_response.choices and completion_response.choices[0].text:
1405
1406
1407
                return completion_response.choices[0].text
    except pydantic.ValidationError:
        # Fallback to manual parsing
1408
1409
1410
1411
1412
1413
        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"]
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
    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:
1429
            chunk_str = chunk.decode("utf-8")
1430
1431
1432
1433
1434
1435
1436
1437
        except UnicodeDecodeError:
            # Skip malformed chunks
            return []

        self.buffer += chunk_str
        events = []

        # Process complete lines
1438
1439
1440
        while "\n" in self.buffer:
            line, self.buffer = self.buffer.split("\n", 1)
            line = line.rstrip("\r")  # Handle CRLF
1441

1442
            if line.startswith("data: "):
1443
                data_str = line[6:].strip()
1444
1445
                if data_str == "[DONE]":
                    events.append({"type": "done"})
1446
1447
1448
                elif data_str:
                    try:
                        event_data = json.loads(data_str)
1449
                        events.append({"type": "data", "data": event_data})
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
                    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."""
1467
        return "".join(self.content_buffer)
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487


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:
1488
1489
                if event["type"] == "data":
                    content = sse_decoder.extract_content(event["data"])
1490
                    sse_decoder.add_content(content)
1491
                elif event["type"] == "done":
1492
1493
1494
1495
1496
1497
1498
1499
                    # 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(
1500
                            "response_body={streaming_complete: "
1501
                            "content='%s', chunks=%d}",
1502
1503
1504
                            full_content,
                            chunk_count,
                        )
1505
1506
                    else:
                        logger.info(
1507
1508
1509
                            "response_body={streaming_complete: no_content, chunks=%d}",
                            chunk_count,
                        )
1510
1511
1512
                    return

    response.body_iterator = iterate_in_threadpool(buffered_iterator())
1513
    logger.info("response_body={streaming_started: chunks=%d}", len(response_body))
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524


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>}")


1525
def build_app(args: Namespace) -> FastAPI:
1526
    if args.disable_fastapi_docs:
1527
1528
1529
        app = FastAPI(
            openapi_url=None, docs_url=None, redoc_url=None, lifespan=lifespan
        )
1530
1531
    else:
        app = FastAPI(lifespan=lifespan)
Ethan Xu's avatar
Ethan Xu committed
1532
1533
    app.include_router(router)
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
1534

1535
1536
    mount_metrics(app)

Zhuohan Li's avatar
Zhuohan Li committed
1537
1538
1539
1540
1541
1542
1543
1544
    app.add_middleware(
        CORSMiddleware,
        allow_origins=args.allowed_origins,
        allow_credentials=args.allow_credentials,
        allow_methods=args.allowed_methods,
        allow_headers=args.allowed_headers,
    )

1545
1546
    @app.exception_handler(HTTPException)
    async def http_exception_handler(_: Request, exc: HTTPException):
1547
        err = ErrorResponse(
1548
1549
1550
1551
1552
1553
            error=ErrorInfo(
                message=exc.detail,
                type=HTTPStatus(exc.status_code).phrase,
                code=exc.status_code,
            )
        )
1554
1555
        return JSONResponse(err.model_dump(), status_code=exc.status_code)

Ethan Xu's avatar
Ethan Xu committed
1556
    @app.exception_handler(RequestValidationError)
1557
    async def validation_exception_handler(_: Request, exc: RequestValidationError):
1558
1559
1560
1561
1562
1563
1564
1565
        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

1566
1567
1568
1569
1570
1571
1572
1573
        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
1574

1575
    # Ensure --api-key option from CLI takes precedence over VLLM_API_KEY
1576
1577
    if tokens := [key for key in (args.api_key or [envs.VLLM_API_KEY]) if key]:
        app.add_middleware(AuthenticationMiddleware, tokens=tokens)
1578

1579
    if args.enable_request_id_headers:
1580
        app.add_middleware(XRequestIdMiddleware)
1581

1582
1583
1584
    # Add scaling middleware to check for scaling state
    app.add_middleware(ScalingMiddleware)

1585
    if envs.VLLM_DEBUG_LOG_API_SERVER_RESPONSE:
1586
1587
1588
1589
1590
        logger.warning(
            "CAUTION: Enabling log response in the API Server. "
            "This can include sensitive information and should be "
            "avoided in production."
        )
1591
1592
1593
1594

        @app.middleware("http")
        async def log_response(request: Request, call_next):
            response = await call_next(request)
1595
            response_body = [section async for section in response.body_iterator]
1596
            response.body_iterator = iterate_in_threadpool(iter(response_body))
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
            # 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)
1608
            return response
1609

1610
1611
1612
1613
    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):
1614
            app.add_middleware(imported)  # type: ignore[arg-type]
1615
1616
1617
        elif inspect.iscoroutinefunction(imported):
            app.middleware("http")(imported)
        else:
1618
1619
1620
            raise ValueError(
                f"Invalid middleware {middleware}. Must be a function or a class."
            )
1621

Ethan Xu's avatar
Ethan Xu committed
1622
1623
1624
    return app


1625
async def init_app_state(
1626
    engine_client: EngineClient,
1627
    state: State,
1628
    args: Namespace,
1629
) -> None:
1630
1631
    vllm_config = engine_client.vllm_config

1632
    if args.served_model_name is not None:
1633
        served_model_names = args.served_model_name
1634
    else:
1635
        served_model_names = [args.model]
1636

1637
    if args.enable_log_requests:
1638
        request_logger = RequestLogger(max_log_len=args.max_log_len)
1639
1640
    else:
        request_logger = None
1641

1642
    base_model_paths = [
1643
        BaseModelPath(name=name, model_path=args.model) for name in served_model_names
1644
1645
    ]

1646
    state.engine_client = engine_client
1647
    state.log_stats = not args.disable_log_stats
1648
    state.vllm_config = vllm_config
Ethan Xu's avatar
Ethan Xu committed
1649

1650
    supported_tasks = await engine_client.get_supported_tasks()
1651
    logger.info("Supported tasks: %s", supported_tasks)
1652

1653
1654
1655
    resolved_chat_template = await process_chat_template(
        args.chat_template, engine_client, vllm_config.model_config
    )
1656

1657
    if args.tool_server == "demo":
1658
        tool_server: ToolServer | None = DemoToolServer()
1659
1660
        assert isinstance(tool_server, DemoToolServer)
        await tool_server.init_and_validate()
1661
1662
1663
    elif args.tool_server:
        tool_server = MCPToolServer()
        await tool_server.add_tool_server(args.tool_server)
1664
1665
1666
    else:
        tool_server = None

1667
    # Merge default_mm_loras into the static lora_modules
1668
1669
1670
1671
1672
    default_mm_loras = (
        vllm_config.lora_config.default_mm_loras
        if vllm_config.lora_config is not None
        else {}
    )
1673

1674
1675
1676
1677
1678
1679
    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)
1680

1681
    state.openai_serving_models = OpenAIServingModels(
1682
        engine_client=engine_client,
1683
        base_model_paths=base_model_paths,
1684
        lora_modules=lora_modules,
1685
    )
1686
    await state.openai_serving_models.init_static_loras()
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
    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 = (
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
        (
            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,
            )
1754
        )
1755
        if ("token_embed" in supported_tasks or "token_classify" in supported_tasks)
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
        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
    )
1791
    state.openai_serving_tokenization = OpenAIServingTokenization(
1792
        engine_client,
1793
        state.openai_serving_models,
1794
        request_logger=request_logger,
1795
1796
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
1797
        trust_request_chat_template=args.trust_request_chat_template,
1798
        log_error_stack=args.log_error_stack,
1799
    )
1800
1801
1802
1803
1804
1805
    state.openai_serving_transcription = (
        OpenAIServingTranscription(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            log_error_stack=args.log_error_stack,
1806
            enable_force_include_usage=args.enable_force_include_usage,
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
        )
        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,
1817
            enable_force_include_usage=args.enable_force_include_usage,
1818
1819
1820
1821
        )
        if "transcription" in supported_tasks
        else None
    )
1822

1823
1824
1825
    state.enable_server_load_tracking = args.enable_server_load_tracking
    state.server_load_metrics = 0

1826

1827
def create_server_socket(addr: tuple[str, int]) -> socket.socket:
1828
1829
1830
1831
1832
1833
    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)
1834
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
1835
1836
1837
1838
1839
    sock.bind(addr)

    return sock


1840
1841
1842
1843
1844
1845
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


1846
def validate_api_server_args(args):
1847
    valid_tool_parses = ToolParserManager.tool_parsers.keys()
1848
1849
1850
1851
1852
    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)} }})"
        )
1853

1854
    valid_reasoning_parses = ReasoningParserManager.reasoning_parsers.keys()
1855
1856
1857
    if (
        reasoning_parser := args.structured_outputs_config.reasoning_parser
    ) and reasoning_parser not in valid_reasoning_parses:
1858
        raise KeyError(
1859
            f"invalid reasoning parser: {reasoning_parser} "
1860
1861
            f"(chose from {{ {','.join(valid_reasoning_parses)} }})"
        )
1862

1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875

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)

1876
1877
1878
    # 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
1879
1880
1881
1882
1883
    if args.uds:
        sock = create_server_unix_socket(args.uds)
    else:
        sock_addr = (args.host or "", args.port)
        sock = create_server_socket(sock_addr)
1884

1885
1886
1887
1888
    # workaround to avoid footguns where uvicorn drops requests with too
    # many concurrent requests active
    set_ulimit()

1889
1890
1891
1892
1893
1894
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

1895
1896
1897
1898
1899
    if args.uds:
        listen_address = f"unix:{args.uds}"
    else:
        addr, port = sock_addr
        is_ssl = args.ssl_keyfile and args.ssl_certfile
1900
        host_part = f"[{addr}]" if is_valid_ipv6_address(addr) else addr or "0.0.0.0"
1901
        listen_address = f"http{'s' if is_ssl else ''}://{host_part}:{port}"
1902
1903
1904
1905
1906
    return listen_address, sock


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

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

1911
1912
1913
1914
    listen_address, sock = setup_server(args)
    await run_server_worker(listen_address, sock, args, **uvicorn_kwargs)


1915
1916
1917
async def run_server_worker(
    listen_address, sock, args, client_config=None, **uvicorn_kwargs
) -> None:
1918
1919
1920
1921
1922
    """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)

1923
1924
1925
    # Load logging config for uvicorn if specified
    log_config = load_log_config(args.log_config_file)
    if log_config is not None:
1926
        uvicorn_kwargs["log_config"] = log_config
1927

1928
    async with build_async_engine_client(
1929
1930
        args,
        client_config=client_config,
1931
    ) as engine_client:
1932
        maybe_register_tokenizer_info_endpoint(args)
1933
1934
        app = build_app(args)

1935
        await init_app_state(engine_client, app.state, args)
1936

1937
1938
        logger.info(
            "Starting vLLM API server %d on %s",
1939
            engine_client.vllm_config.parallel_config._api_process_rank,
1940
1941
            listen_address,
        )
1942
1943
        shutdown_task = await serve_http(
            app,
1944
            sock=sock,
1945
            enable_ssl_refresh=args.enable_ssl_refresh,
1946
1947
1948
            host=args.host,
            port=args.port,
            log_level=args.uvicorn_log_level,
1949
1950
1951
            # NOTE: When the 'disable_uvicorn_access_log' value is True,
            # no access log will be output.
            access_log=not args.disable_uvicorn_access_log,
1952
            timeout_keep_alive=envs.VLLM_HTTP_TIMEOUT_KEEP_ALIVE,
1953
1954
1955
1956
            ssl_keyfile=args.ssl_keyfile,
            ssl_certfile=args.ssl_certfile,
            ssl_ca_certs=args.ssl_ca_certs,
            ssl_cert_reqs=args.ssl_cert_reqs,
1957
1958
            h11_max_incomplete_event_size=args.h11_max_incomplete_event_size,
            h11_max_header_count=args.h11_max_header_count,
1959
1960
1961
            **uvicorn_kwargs,
        )

1962
    # NB: Await server shutdown only after the backend context is exited
1963
1964
1965
1966
    try:
        await shutdown_task
    finally:
        sock.close()
1967

Ethan Xu's avatar
Ethan Xu committed
1968
1969
1970

if __name__ == "__main__":
    # NOTE(simon):
1971
1972
    # This section should be in sync with vllm/entrypoints/cli/main.py for CLI
    # entrypoints.
1973
    cli_env_setup()
Ethan Xu's avatar
Ethan Xu committed
1974
    parser = FlexibleArgumentParser(
1975
1976
        description="vLLM OpenAI-Compatible RESTful API server."
    )
Ethan Xu's avatar
Ethan Xu committed
1977
1978
    parser = make_arg_parser(parser)
    args = parser.parse_args()
1979
    validate_parsed_serve_args(args)
1980

1981
    uvloop.run(run_server(args))