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

125
prometheus_multiproc_dir: tempfile.TemporaryDirectory
126

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

130
_running_tasks: set[asyncio.Task] = set()
131

132

133
@asynccontextmanager
134
async def lifespan(app: FastAPI):
135
136
    try:
        if app.state.log_stats:
137
            engine_client: EngineClient = app.state.engine_client
138
139
140

            async def _force_log():
                while True:
141
                    await asyncio.sleep(envs.VLLM_LOG_STATS_INTERVAL)
142
                    await engine_client.do_log_stats()
143
144
145
146
147
148

            task = asyncio.create_task(_force_log())
            _running_tasks.add(task)
            task.add_done_callback(_running_tasks.remove)
        else:
            task = None
149
150
151
152
153

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


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

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

188
    if disable_frontend_multiprocessing is None:
189
        disable_frontend_multiprocessing = bool(args.disable_frontend_multiprocessing)
190

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


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

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

216
217
218
219
    # Create the EngineConfig (determines if we can use V1).
    vllm_config = engine_args.create_engine_config(usage_context=usage_context)

    # V1 AsyncLLM.
220
    assert envs.VLLM_USE_V1
221

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

228
    from vllm.v1.engine.async_llm import AsyncLLM
229

230
    async_llm: AsyncLLM | None = None
231
232
233
234
235
236

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

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

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

        yield async_llm
    finally:
        if async_llm:
            async_llm.shutdown()
256
257


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


Ethan Xu's avatar
Ethan Xu committed
267
router = APIRouter()
Zhuohan Li's avatar
Zhuohan Li committed
268

269

270
271
272
273
class PrometheusResponse(Response):
    media_type = prometheus_client.CONTENT_TYPE_LATEST


274
def mount_metrics(app: FastAPI):
275
276
277
    """Mount prometheus metrics to a FastAPI app."""

    registry = get_prometheus_registry()
278

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

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

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


303
304
305
306
307
def base(request: Request) -> OpenAIServing:
    # Reuse the existing instance
    return tokenization(request)


308
309
310
311
def models(request: Request) -> OpenAIServingModels:
    return request.app.state.openai_serving_models


312
def responses(request: Request) -> OpenAIServingResponses | None:
313
314
315
    return request.app.state.openai_serving_responses


316
def chat(request: Request) -> OpenAIServingChat | None:
317
318
319
    return request.app.state.openai_serving_chat


320
def completion(request: Request) -> OpenAIServingCompletion | None:
321
322
323
    return request.app.state.openai_serving_completion


324
def pooling(request: Request) -> OpenAIServingPooling | None:
325
326
327
    return request.app.state.openai_serving_pooling


328
def embedding(request: Request) -> OpenAIServingEmbedding | None:
329
    return request.app.state.openai_serving_embedding
330
331


332
def score(request: Request) -> ServingScores | None:
333
334
335
    return request.app.state.openai_serving_scores


336
def classify(request: Request) -> ServingClassification | None:
337
338
339
    return request.app.state.openai_serving_classification


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


344
345
def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
346
347


348
349
350
351
def transcription(request: Request) -> OpenAIServingTranscription:
    return request.app.state.openai_serving_transcription


352
353
354
355
def translation(request: Request) -> OpenAIServingTranslation:
    return request.app.state.openai_serving_translation


356
def engine_client(request: Request) -> EngineClient:
357
358
359
    return request.app.state.engine_client


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


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


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


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

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

421
    if isinstance(generator, ErrorResponse):
422
423
424
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
425
    elif isinstance(generator, TokenizeResponse):
426
427
        return JSONResponse(content=generator.model_dump())

428
429
    assert_never(generator)

430

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

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

453
    if isinstance(generator, ErrorResponse):
454
455
456
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
457
    elif isinstance(generator, DetokenizeResponse):
458
459
        return JSONResponse(content=generator.model_dump())

460
461
    assert_never(generator)

462

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

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


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

483
484
    models_ = await handler.show_available_models()
    return JSONResponse(content=models_.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
485
486


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


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


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

    if isinstance(generator, ErrorResponse):
531
532
533
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
534
535
    elif isinstance(generator, ResponsesResponse):
        return JSONResponse(content=generator.model_dump())
536

537
538
539
    return StreamingResponse(
        content=_convert_stream_to_sse_events(generator), media_type="text/event-stream"
    )
540
541
542


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

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

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


@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(
582
583
            message="The model does not support Responses API"
        )
584

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

    if isinstance(response, ErrorResponse):
593
594
595
        return JSONResponse(
            content=response.model_dump(), status_code=response.error.code
        )
596
597
598
    return JSONResponse(content=response.model_dump())


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

628
    elif isinstance(generator, ChatCompletionResponse):
629
        return JSONResponse(content=generator.model_dump())
630

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

633

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

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

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

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

Zhuohan Li's avatar
Zhuohan Li committed
673

674
675
676
677
678
679
680
681
@router.post(
    "/v1/embeddings",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
682
@with_cancellation
683
@load_aware_call
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
704
        return JSONResponse(content=generator.model_dump())

705
706
    assert_never(generator)

707

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

    assert_never(generator)


740
741
742
@router.post("/classify", dependencies=[Depends(validate_json_request)])
@with_cancellation
@load_aware_call
743
async def create_classify(request: ClassificationRequest, raw_request: Request):
744
745
746
    handler = classify(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
747
748
            message="The model does not support Classification API"
        )
749

750
751
752
    try:
        generator = await handler.create_classify(request, raw_request)
    except Exception as e:
753
754
755
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
756
    if isinstance(generator, ErrorResponse):
757
758
759
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
760
761
762
763
764
765
766

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

    assert_never(generator)


767
768
769
770
771
772
773
774
@router.post(
    "/score",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
775
@with_cancellation
776
@load_aware_call
777
778
779
780
async def create_score(request: ScoreRequest, raw_request: Request):
    handler = score(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
781
782
            message="The model does not support Score API"
        )
783

784
785
786
    try:
        generator = await handler.create_score(request, raw_request)
    except Exception as e:
787
788
789
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
790
    if isinstance(generator, ErrorResponse):
791
792
793
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
794
795
796
797
798
799
    elif isinstance(generator, ScoreResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


800
801
802
803
804
805
806
807
@router.post(
    "/v1/score",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
808
@with_cancellation
809
@load_aware_call
810
811
812
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 "
813
814
        "have moved it to `/score`. Please update your client accordingly."
    )
815
816
817
818

    return await create_score(request, raw_request)


819
820
821
822
823
824
825
826
827
@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},
    },
)
828
@with_cancellation
829
@load_aware_call
830
831
832
async def create_transcriptions(
    raw_request: Request, request: Annotated[TranscriptionRequest, Form()]
):
833
834
835
    handler = transcription(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
836
837
            message="The model does not support Transcriptions API"
        )
838
839

    audio_data = await request.file.read()
840
    try:
841
        generator = await handler.create_transcription(audio_data, request, raw_request)
842
    except Exception as e:
843
844
845
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
846
847

    if isinstance(generator, ErrorResponse):
848
849
850
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
851
852
853
854
855
856
857

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

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


858
859
860
861
862
863
864
865
866
@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},
    },
)
867
868
@with_cancellation
@load_aware_call
869
870
871
async def create_translations(
    request: Annotated[TranslationRequest, Form()], raw_request: Request
):
872
873
874
    handler = translation(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
875
876
            message="The model does not support Translations API"
        )
877
878

    audio_data = await request.file.read()
879
    try:
880
        generator = await handler.create_translation(audio_data, request, raw_request)
881
    except Exception as e:
882
883
884
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
885
886

    if isinstance(generator, ErrorResponse):
887
888
889
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
890
891
892
893
894
895
896

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

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


897
898
899
900
901
902
903
904
@router.post(
    "/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
905
@with_cancellation
906
@load_aware_call
907
908
909
910
async def do_rerank(request: RerankRequest, raw_request: Request):
    handler = rerank(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
911
912
            message="The model does not support Rerank (Score) API"
        )
913
914
915
    try:
        generator = await handler.do_rerank(request, raw_request)
    except Exception as e:
916
917
918
        raise HTTPException(
            status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value, detail=str(e)
        ) from e
919
    if isinstance(generator, ErrorResponse):
920
921
922
        return JSONResponse(
            content=generator.model_dump(), status_code=generator.error.code
        )
923
924
925
926
927
928
    elif isinstance(generator, RerankResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


929
930
931
932
933
934
935
936
@router.post(
    "/v1/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
937
938
@with_cancellation
async def do_rerank_v1(request: RerankRequest, raw_request: Request):
939
    logger.warning_once(
940
        "To indicate that the rerank API is not part of the standard OpenAI"
941
        " API, we have located it at `/rerank`. Please update your client "
942
943
        "accordingly. (Note: Conforms to JinaAI rerank API)"
    )
944
945
946
947

    return await do_rerank(request, raw_request)


948
949
950
951
952
953
954
955
@router.post(
    "/v2/rerank",
    dependencies=[Depends(validate_json_request)],
    responses={
        HTTPStatus.BAD_REQUEST.value: {"model": ErrorResponse},
        HTTPStatus.INTERNAL_SERVER_ERROR.value: {"model": ErrorResponse},
    },
)
956
957
958
959
960
@with_cancellation
async def do_rerank_v2(request: RerankRequest, raw_request: Request):
    return await do_rerank(request, raw_request)


961
if envs.VLLM_SERVER_DEV_MODE:
962
963
964
965
    logger.warning(
        "SECURITY WARNING: Development endpoints are enabled! "
        "This should NOT be used in production!"
    )
966

967
968
    PydanticVllmConfig = pydantic.TypeAdapter(VllmConfig)

969
    @router.get("/server_info")
970
971
    async def show_server_info(
        raw_request: Request,
972
        config_format: Annotated[Literal["text", "json"], Query()] = "text",
973
974
975
    ):
        vllm_config: VllmConfig = raw_request.app.state.vllm_config
        server_info = {
976
977
978
            "vllm_config": str(vllm_config)
            if config_format == "text"
            else PydanticVllmConfig.dump_python(vllm_config, mode="json", fallback=str)
979
980
            # fallback=str is needed to handle e.g. torch.dtype
        }
981
982
        return JSONResponse(content=server_info)

983
984
985
986
987
988
    @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.
        """
989
990
991
992
993
994
        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)
995
996
        return Response(status_code=200)

997
998
999
1000
1001
1002
1003
1004
1005
1006
    @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)

1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
    @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):
1018
1019
1020
1021
1022
1023
        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)
1024
1025
1026
1027
        # 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)

1028
1029
1030
1031
1032
1033
    @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})

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

1067

1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
@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},
    },
)
1078
1079
1080
1081
async def scale_elastic_ep(raw_request: Request):
    try:
        body = await raw_request.json()
    except json.JSONDecodeError as e:
1082
        raise HTTPException(status_code=400, detail="Invalid JSON format") from e  # noqa: B904
1083
1084
1085
1086
1087

    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:
1088
1089
1090
        raise HTTPException(
            status_code=400, detail="new_data_parallel_size is required"
        )
1091

1092
    if not isinstance(new_data_parallel_size, int) or new_data_parallel_size <= 0:
1093
        raise HTTPException(
1094
1095
            status_code=400, detail="new_data_parallel_size must be a positive integer"
        )
1096
1097

    if not isinstance(drain_timeout, int) or drain_timeout <= 0:
1098
1099
1100
        raise HTTPException(
            status_code=400, detail="drain_timeout must be a positive integer"
        )
1101
1102
1103
1104
1105
1106
1107

    # 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)
1108
1109
1110
1111
1112
        return JSONResponse(
            {
                "message": f"Scaled to {new_data_parallel_size} data parallel engines",
            }
        )
1113
    except TimeoutError as e:
1114
1115
1116
1117
1118
        raise HTTPException(
            status_code=408,
            detail="Scale failed due to request drain timeout "
            f"after {drain_timeout} seconds",
        ) from e
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
    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})


1131
1132
1133
# TODO: RequestType = TypeForm[BaseModel] when recognized by type checkers
# (requires typing_extensions >= 4.13)
RequestType = Any
1134
GetHandlerFn = Callable[[Request], OpenAIServing | None]
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
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
]


1155
1156
1157
1158
1159
1160
1161
1162
1163
@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},
    },
)
1164
async def invocations(raw_request: Request):
1165
    """For SageMaker, routes requests based on the request type."""
1166
1167
    try:
        body = await raw_request.json()
1168
    except json.JSONDecodeError as e:
1169
1170
1171
        raise HTTPException(
            status_code=HTTPStatus.BAD_REQUEST.value, detail=f"JSON decode error: {e}"
        ) from e
1172

1173
1174
1175
1176
1177
    valid_endpoints = [
        (validator, endpoint)
        for validator, (get_handler, endpoint) in INVOCATION_VALIDATORS
        if get_handler(raw_request) is not None
    ]
1178

1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
    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
    ]
1191
    msg = f"Cannot find suitable handler for request. Expected one of: {type_names}"
1192
    res = base(raw_request).create_error_response(message=msg)
1193
    return JSONResponse(content=res.model_dump(), status_code=res.error.code)
1194
1195


1196
1197
1198
if envs.VLLM_TORCH_PROFILER_DIR:
    logger.warning(
        "Torch Profiler is enabled in the API server. This should ONLY be "
1199
1200
        "used for local development!"
    )
1201
1202

    @router.post("/start_profile")
1203
    async def start_profile(raw_request: Request):
1204
        logger.info("Starting profiler...")
1205
        await engine_client(raw_request).start_profile()
1206
1207
1208
1209
        logger.info("Profiler started.")
        return Response(status_code=200)

    @router.post("/stop_profile")
1210
    async def stop_profile(raw_request: Request):
1211
        logger.info("Stopping profiler...")
1212
        await engine_client(raw_request).stop_profile()
1213
1214
1215
1216
        logger.info("Profiler stopped.")
        return Response(status_code=200)


1217
1218
if envs.VLLM_ALLOW_RUNTIME_LORA_UPDATING:
    logger.warning(
1219
        "LoRA dynamic loading & unloading is enabled in the API server. "
1220
1221
        "This should ONLY be used for local development!"
    )
1222

1223
1224
    @router.post("/v1/load_lora_adapter", dependencies=[Depends(validate_json_request)])
    async def load_lora_adapter(request: LoadLoRAAdapterRequest, raw_request: Request):
1225
1226
1227
        handler = models(raw_request)
        response = await handler.load_lora_adapter(request)
        if isinstance(response, ErrorResponse):
1228
1229
1230
            return JSONResponse(
                content=response.model_dump(), status_code=response.error.code
            )
1231
1232
1233

        return Response(status_code=200, content=response)

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

        return Response(status_code=200, content=response)


1250
def load_log_config(log_config_file: str | None) -> dict | None:
1251
1252
1253
1254
1255
1256
    if not log_config_file:
        return None
    try:
        with open(log_config_file) as f:
            return json.load(f)
    except Exception as e:
1257
1258
1259
        logger.warning(
            "Failed to load log config from file %s: error %s", log_config_file, e
        )
1260
1261
1262
        return None


1263
1264
1265
class AuthenticationMiddleware:
    """
    Pure ASGI middleware that authenticates each request by checking
1266
    if the Authorization Bearer token exists and equals anyof "{api_key}".
1267
1268
1269
1270
1271
1272
1273
1274

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

1275
    def __init__(self, app: ASGIApp, tokens: list[str]) -> None:
1276
        self.app = app
1277
        self.api_tokens = [hashlib.sha256(t.encode("utf-8")).digest() for t in tokens]
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294

    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
1295

1296
1297
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
        if scope["type"] not in ("http", "websocket") or scope["method"] == "OPTIONS":
1298
1299
1300
1301
1302
1303
1304
            # 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.
1305
        if url_path.startswith("/v1") and not self.verify_token(headers):
1306
            response = JSONResponse(content={"error": "Unauthorized"}, status_code=401)
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
            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

1321
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
        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"])
1335
                request_id = request_headers.get("X-Request-Id", uuid.uuid4().hex)
1336
1337
1338
1339
1340
1341
                response_headers.append("X-Request-Id", request_id)
            await send(message)

        return self.app(scope, receive, send_with_request_id)


1342
1343
1344
1345
1346
1347
1348
1349
# 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.
1350

1351
1352
1353
1354
1355
1356
1357
    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

1358
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
1359
1360
1361
1362
1363
1364
1365
        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
1366
1367
1368
1369
1370
1371
            response = JSONResponse(
                content={
                    "error": "The model is currently scaling. Please try again later."
                },
                status_code=503,
            )
1372
1373
1374
1375
1376
            return response(scope, receive, send)

        return self.app(scope, receive, send)


1377
1378
1379
1380
def _extract_content_from_chunk(chunk_data: dict) -> str:
    """Extract content from a streaming response chunk."""
    try:
        from vllm.entrypoints.openai.protocol import (
1381
1382
1383
            ChatCompletionStreamResponse,
            CompletionStreamResponse,
        )
1384
1385

        # Try using Completion types for type-safe parsing
1386
1387
        if chunk_data.get("object") == "chat.completion.chunk":
            chat_response = ChatCompletionStreamResponse.model_validate(chunk_data)
1388
1389
            if chat_response.choices and chat_response.choices[0].delta.content:
                return chat_response.choices[0].delta.content
1390
1391
1392
        elif chunk_data.get("object") == "text_completion":
            completion_response = CompletionStreamResponse.model_validate(chunk_data)
            if completion_response.choices and completion_response.choices[0].text:
1393
1394
1395
                return completion_response.choices[0].text
    except pydantic.ValidationError:
        # Fallback to manual parsing
1396
1397
1398
1399
1400
1401
        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"]
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
    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:
1417
            chunk_str = chunk.decode("utf-8")
1418
1419
1420
1421
1422
1423
1424
1425
        except UnicodeDecodeError:
            # Skip malformed chunks
            return []

        self.buffer += chunk_str
        events = []

        # Process complete lines
1426
1427
1428
        while "\n" in self.buffer:
            line, self.buffer = self.buffer.split("\n", 1)
            line = line.rstrip("\r")  # Handle CRLF
1429

1430
            if line.startswith("data: "):
1431
                data_str = line[6:].strip()
1432
1433
                if data_str == "[DONE]":
                    events.append({"type": "done"})
1434
1435
1436
                elif data_str:
                    try:
                        event_data = json.loads(data_str)
1437
                        events.append({"type": "data", "data": event_data})
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
                    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."""
1455
        return "".join(self.content_buffer)
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475


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:
1476
1477
                if event["type"] == "data":
                    content = sse_decoder.extract_content(event["data"])
1478
                    sse_decoder.add_content(content)
1479
                elif event["type"] == "done":
1480
1481
1482
1483
1484
1485
1486
1487
                    # 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(
1488
                            "response_body={streaming_complete: "
1489
                            "content='%s', chunks=%d}",
1490
1491
1492
                            full_content,
                            chunk_count,
                        )
1493
1494
                    else:
                        logger.info(
1495
1496
1497
                            "response_body={streaming_complete: no_content, chunks=%d}",
                            chunk_count,
                        )
1498
1499
1500
                    return

    response.body_iterator = iterate_in_threadpool(buffered_iterator())
1501
    logger.info("response_body={streaming_started: chunks=%d}", len(response_body))
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512


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


1513
def build_app(args: Namespace) -> FastAPI:
1514
    if args.disable_fastapi_docs:
1515
1516
1517
        app = FastAPI(
            openapi_url=None, docs_url=None, redoc_url=None, lifespan=lifespan
        )
1518
1519
    else:
        app = FastAPI(lifespan=lifespan)
Ethan Xu's avatar
Ethan Xu committed
1520
1521
    app.include_router(router)
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
1522

1523
1524
    mount_metrics(app)

Zhuohan Li's avatar
Zhuohan Li committed
1525
1526
1527
1528
1529
1530
1531
1532
    app.add_middleware(
        CORSMiddleware,
        allow_origins=args.allowed_origins,
        allow_credentials=args.allow_credentials,
        allow_methods=args.allowed_methods,
        allow_headers=args.allowed_headers,
    )

1533
1534
    @app.exception_handler(HTTPException)
    async def http_exception_handler(_: Request, exc: HTTPException):
1535
        err = ErrorResponse(
1536
1537
1538
1539
1540
1541
            error=ErrorInfo(
                message=exc.detail,
                type=HTTPStatus(exc.status_code).phrase,
                code=exc.status_code,
            )
        )
1542
1543
        return JSONResponse(err.model_dump(), status_code=exc.status_code)

Ethan Xu's avatar
Ethan Xu committed
1544
    @app.exception_handler(RequestValidationError)
1545
    async def validation_exception_handler(_: Request, exc: RequestValidationError):
1546
1547
1548
1549
1550
1551
1552
1553
        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

1554
1555
1556
1557
1558
1559
1560
1561
        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
1562

1563
    # Ensure --api-key option from CLI takes precedence over VLLM_API_KEY
1564
1565
    if tokens := [key for key in (args.api_key or [envs.VLLM_API_KEY]) if key]:
        app.add_middleware(AuthenticationMiddleware, tokens=tokens)
1566

1567
    if args.enable_request_id_headers:
1568
        app.add_middleware(XRequestIdMiddleware)
1569

1570
1571
1572
    # Add scaling middleware to check for scaling state
    app.add_middleware(ScalingMiddleware)

1573
    if envs.VLLM_DEBUG_LOG_API_SERVER_RESPONSE:
1574
1575
1576
1577
1578
        logger.warning(
            "CAUTION: Enabling log response in the API Server. "
            "This can include sensitive information and should be "
            "avoided in production."
        )
1579
1580
1581
1582

        @app.middleware("http")
        async def log_response(request: Request, call_next):
            response = await call_next(request)
1583
            response_body = [section async for section in response.body_iterator]
1584
            response.body_iterator = iterate_in_threadpool(iter(response_body))
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
            # 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)
1596
            return response
1597

1598
1599
1600
1601
    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):
1602
            app.add_middleware(imported)  # type: ignore[arg-type]
1603
1604
1605
        elif inspect.iscoroutinefunction(imported):
            app.middleware("http")(imported)
        else:
1606
1607
1608
            raise ValueError(
                f"Invalid middleware {middleware}. Must be a function or a class."
            )
1609

Ethan Xu's avatar
Ethan Xu committed
1610
1611
1612
    return app


1613
async def init_app_state(
1614
    engine_client: EngineClient,
1615
    state: State,
1616
    args: Namespace,
1617
) -> None:
1618
1619
    vllm_config = engine_client.vllm_config

1620
    if args.served_model_name is not None:
1621
        served_model_names = args.served_model_name
1622
    else:
1623
        served_model_names = [args.model]
1624

1625
    if args.enable_log_requests:
1626
        request_logger = RequestLogger(max_log_len=args.max_log_len)
1627
1628
    else:
        request_logger = None
1629

1630
    base_model_paths = [
1631
        BaseModelPath(name=name, model_path=args.model) for name in served_model_names
1632
1633
    ]

1634
    state.engine_client = engine_client
1635
    state.log_stats = not args.disable_log_stats
1636
    state.vllm_config = vllm_config
Ethan Xu's avatar
Ethan Xu committed
1637

1638
    supported_tasks = await engine_client.get_supported_tasks()
1639
    logger.info("Supported tasks: %s", supported_tasks)
1640

1641
    resolved_chat_template = load_chat_template(args.chat_template)
1642
    if resolved_chat_template is not None:
1643
1644
1645
1646
1647
1648
        # Get the tokenizer to check official template
        tokenizer = await engine_client.get_tokenizer()

        if isinstance(tokenizer, MistralTokenizer):
            # The warning is logged in resolve_mistral_chat_template.
            resolved_chat_template = resolve_mistral_chat_template(
1649
1650
                chat_template=resolved_chat_template
            )
1651
1652
        else:
            hf_chat_template = resolve_hf_chat_template(
1653
                tokenizer=tokenizer,
1654
1655
                chat_template=None,
                tools=None,
1656
                model_config=vllm_config.model_config,
1657
            )
1658
1659
1660
1661
1662
1663

            if hf_chat_template != resolved_chat_template:
                logger.warning(
                    "Using supplied chat template: %s\n"
                    "It is different from official chat template '%s'. "
                    "This discrepancy may lead to performance degradation.",
1664
1665
1666
                    resolved_chat_template,
                    args.model,
                )
1667

1668
    if args.tool_server == "demo":
1669
        tool_server: ToolServer | None = DemoToolServer()
1670
1671
        assert isinstance(tool_server, DemoToolServer)
        await tool_server.init_and_validate()
1672
1673
1674
    elif args.tool_server:
        tool_server = MCPToolServer()
        await tool_server.add_tool_server(args.tool_server)
1675
1676
1677
    else:
        tool_server = None

1678
    # Merge default_mm_loras into the static lora_modules
1679
1680
1681
1682
1683
    default_mm_loras = (
        vllm_config.lora_config.default_mm_loras
        if vllm_config.lora_config is not None
        else {}
    )
1684
1685
1686
1687
1688
1689
1690

    lora_modules = args.lora_modules
    if default_mm_loras:
        default_mm_lora_paths = [
            LoRAModulePath(
                name=modality,
                path=lora_path,
1691
1692
            )
            for modality, lora_path in default_mm_loras.items()
1693
1694
1695
1696
1697
1698
        ]
        if args.lora_modules is None:
            lora_modules = default_mm_lora_paths
        else:
            lora_modules += default_mm_lora_paths

1699
    state.openai_serving_models = OpenAIServingModels(
1700
        engine_client=engine_client,
1701
        base_model_paths=base_model_paths,
1702
        lora_modules=lora_modules,
1703
    )
1704
    await state.openai_serving_models.init_static_loras()
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
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
    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 = (
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
        (
            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,
            )
1772
        )
1773
        if ("token_embed" in supported_tasks or "token_classify" in supported_tasks)
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
        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
    )
1809
    state.openai_serving_tokenization = OpenAIServingTokenization(
1810
        engine_client,
1811
        state.openai_serving_models,
1812
        request_logger=request_logger,
1813
1814
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
1815
        trust_request_chat_template=args.trust_request_chat_template,
1816
        log_error_stack=args.log_error_stack,
1817
    )
1818
1819
1820
1821
1822
1823
    state.openai_serving_transcription = (
        OpenAIServingTranscription(
            engine_client,
            state.openai_serving_models,
            request_logger=request_logger,
            log_error_stack=args.log_error_stack,
1824
            enable_force_include_usage=args.enable_force_include_usage,
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
        )
        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,
1835
            enable_force_include_usage=args.enable_force_include_usage,
1836
1837
1838
1839
        )
        if "transcription" in supported_tasks
        else None
    )
1840

1841
1842
1843
    state.enable_server_load_tracking = args.enable_server_load_tracking
    state.server_load_metrics = 0

1844

1845
def create_server_socket(addr: tuple[str, int]) -> socket.socket:
1846
1847
1848
1849
1850
1851
    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)
1852
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
1853
1854
1855
1856
1857
    sock.bind(addr)

    return sock


1858
1859
1860
1861
1862
1863
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


1864
def validate_api_server_args(args):
1865
    valid_tool_parses = ToolParserManager.tool_parsers.keys()
1866
1867
1868
1869
1870
    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)} }})"
        )
1871

1872
    valid_reasoning_parses = ReasoningParserManager.reasoning_parsers.keys()
1873
1874
1875
    if (
        reasoning_parser := args.structured_outputs_config.reasoning_parser
    ) and reasoning_parser not in valid_reasoning_parses:
1876
        raise KeyError(
1877
            f"invalid reasoning parser: {reasoning_parser} "
1878
1879
            f"(chose from {{ {','.join(valid_reasoning_parses)} }})"
        )
1880

1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893

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)

1894
1895
1896
    # 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
1897
1898
1899
1900
1901
    if args.uds:
        sock = create_server_unix_socket(args.uds)
    else:
        sock_addr = (args.host or "", args.port)
        sock = create_server_socket(sock_addr)
1902

1903
1904
1905
1906
    # workaround to avoid footguns where uvicorn drops requests with too
    # many concurrent requests active
    set_ulimit()

1907
1908
1909
1910
1911
1912
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

1913
1914
1915
1916
1917
    if args.uds:
        listen_address = f"unix:{args.uds}"
    else:
        addr, port = sock_addr
        is_ssl = args.ssl_keyfile and args.ssl_certfile
1918
        host_part = f"[{addr}]" if is_valid_ipv6_address(addr) else addr or "0.0.0.0"
1919
        listen_address = f"http{'s' if is_ssl else ''}://{host_part}:{port}"
1920
1921
1922
1923
1924
    return listen_address, sock


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

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

1929
1930
1931
1932
    listen_address, sock = setup_server(args)
    await run_server_worker(listen_address, sock, args, **uvicorn_kwargs)


1933
1934
1935
async def run_server_worker(
    listen_address, sock, args, client_config=None, **uvicorn_kwargs
) -> None:
1936
1937
1938
1939
1940
    """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)

1941
1942
1943
    # Load logging config for uvicorn if specified
    log_config = load_log_config(args.log_config_file)
    if log_config is not None:
1944
        uvicorn_kwargs["log_config"] = log_config
1945

1946
    async with build_async_engine_client(
1947
1948
        args,
        client_config=client_config,
1949
    ) as engine_client:
1950
        maybe_register_tokenizer_info_endpoint(args)
1951
1952
        app = build_app(args)

1953
        await init_app_state(engine_client, app.state, args)
1954

1955
1956
        logger.info(
            "Starting vLLM API server %d on %s",
1957
            engine_client.vllm_config.parallel_config._api_process_rank,
1958
1959
            listen_address,
        )
1960
1961
        shutdown_task = await serve_http(
            app,
1962
            sock=sock,
1963
            enable_ssl_refresh=args.enable_ssl_refresh,
1964
1965
1966
            host=args.host,
            port=args.port,
            log_level=args.uvicorn_log_level,
1967
1968
1969
            # NOTE: When the 'disable_uvicorn_access_log' value is True,
            # no access log will be output.
            access_log=not args.disable_uvicorn_access_log,
1970
            timeout_keep_alive=envs.VLLM_HTTP_TIMEOUT_KEEP_ALIVE,
1971
1972
1973
1974
            ssl_keyfile=args.ssl_keyfile,
            ssl_certfile=args.ssl_certfile,
            ssl_ca_certs=args.ssl_ca_certs,
            ssl_cert_reqs=args.ssl_cert_reqs,
1975
1976
            h11_max_incomplete_event_size=args.h11_max_incomplete_event_size,
            h11_max_header_count=args.h11_max_header_count,
1977
1978
1979
            **uvicorn_kwargs,
        )

1980
    # NB: Await server shutdown only after the backend context is exited
1981
1982
1983
1984
    try:
        await shutdown_task
    finally:
        sock.close()
1985

Ethan Xu's avatar
Ethan Xu committed
1986
1987
1988

if __name__ == "__main__":
    # NOTE(simon):
1989
1990
    # This section should be in sync with vllm/entrypoints/cli/main.py for CLI
    # entrypoints.
1991
    cli_env_setup()
Ethan Xu's avatar
Ethan Xu committed
1992
    parser = FlexibleArgumentParser(
1993
1994
        description="vLLM OpenAI-Compatible RESTful API server."
    )
Ethan Xu's avatar
Ethan Xu committed
1995
1996
    parser = make_arg_parser(parser)
    args = parser.parse_args()
1997
    validate_parsed_serve_args(args)
1998

1999
    uvloop.run(run_server(args))