api_server.py 55.2 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 atexit
6
import gc
7
8
import importlib
import inspect
9
import json
10
import multiprocessing
11
import os
12
import signal
13
import socket
14
import tempfile
15
import uuid
16
from argparse import Namespace
17
from collections.abc import AsyncIterator, Awaitable
18
from contextlib import asynccontextmanager
19
from functools import partial
20
from http import HTTPStatus
21
from typing import Annotated, Any, Optional
22

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

38
import vllm.envs as envs
39
from vllm.config import VllmConfig
Woosuk Kwon's avatar
Woosuk Kwon committed
40
from vllm.engine.arg_utils import AsyncEngineArgs
41
from vllm.engine.async_llm_engine import AsyncLLMEngine  # type: ignore
42
43
44
from vllm.engine.multiprocessing.client import MQLLMEngineClient
from vllm.engine.multiprocessing.engine import run_mp_engine
from vllm.engine.protocol import EngineClient
45
46
47
from vllm.entrypoints.chat_utils import (load_chat_template,
                                         resolve_hf_chat_template,
                                         resolve_mistral_chat_template)
48
from vllm.entrypoints.launcher import serve_http
49
from vllm.entrypoints.logger import RequestLogger
50
51
from vllm.entrypoints.openai.cli_args import (log_non_default_args,
                                              make_arg_parser,
52
                                              validate_parsed_serve_args)
53
54
# yapf conflicts with isort for this block
# yapf: disable
55
from vllm.entrypoints.openai.protocol import (ChatCompletionRequest,
56
                                              ChatCompletionResponse,
57
58
                                              ClassificationRequest,
                                              ClassificationResponse,
59
                                              CompletionRequest,
60
                                              CompletionResponse,
61
62
                                              DetokenizeRequest,
                                              DetokenizeResponse,
63
64
                                              EmbeddingChatRequest,
                                              EmbeddingCompletionRequest,
65
                                              EmbeddingRequest,
66
                                              EmbeddingResponse, ErrorResponse,
67
                                              LoadLoRAAdapterRequest,
68
69
                                              PoolingChatRequest,
                                              PoolingCompletionRequest,
70
                                              PoolingRequest, PoolingResponse,
71
                                              RerankRequest, RerankResponse,
72
                                              ScoreRequest, ScoreResponse,
73
                                              TokenizeRequest,
74
                                              TokenizeResponse,
75
76
                                              TranscriptionRequest,
                                              TranscriptionResponse,
77
78
                                              TranslationRequest,
                                              TranslationResponse,
79
                                              UnloadLoRAAdapterRequest)
80
# yapf: enable
81
from vllm.entrypoints.openai.serving_chat import OpenAIServingChat
82
83
from vllm.entrypoints.openai.serving_classification import (
    ServingClassification)
84
from vllm.entrypoints.openai.serving_completion import OpenAIServingCompletion
85
from vllm.entrypoints.openai.serving_embedding import OpenAIServingEmbedding
86
87
88
from vllm.entrypoints.openai.serving_engine import OpenAIServing
from vllm.entrypoints.openai.serving_models import (BaseModelPath,
                                                    OpenAIServingModels)
89
from vllm.entrypoints.openai.serving_pooling import OpenAIServingPooling
90
from vllm.entrypoints.openai.serving_score import ServingScores
91
92
from vllm.entrypoints.openai.serving_tokenization import (
    OpenAIServingTokenization)
93
from vllm.entrypoints.openai.serving_transcription import (
94
    OpenAIServingTranscription, OpenAIServingTranslation)
95
from vllm.entrypoints.openai.tool_parsers import ToolParserManager
96
97
from vllm.entrypoints.utils import (cli_env_setup, load_aware_call,
                                    with_cancellation)
98
from vllm.logger import init_logger
99
from vllm.reasoning import ReasoningParserManager
100
101
from vllm.transformers_utils.config import (
    maybe_register_config_serialize_by_value)
102
from vllm.transformers_utils.tokenizer import MistralTokenizer
yhu422's avatar
yhu422 committed
103
from vllm.usage.usage_lib import UsageContext
104
from vllm.utils import (Device, FlexibleArgumentParser, get_open_zmq_ipc_path,
105
                        is_valid_ipv6_address, set_ulimit)
106
from vllm.v1.metrics.prometheus import get_prometheus_registry
107
from vllm.version import __version__ as VLLM_VERSION
Zhuohan Li's avatar
Zhuohan Li committed
108

109
prometheus_multiproc_dir: tempfile.TemporaryDirectory
110

111
# Cannot use __name__ (https://github.com/vllm-project/vllm/pull/4765)
112
logger = init_logger('vllm.entrypoints.openai.api_server')
113

114
_running_tasks: set[asyncio.Task] = set()
115

116

117
@asynccontextmanager
118
async def lifespan(app: FastAPI):
119
120
    try:
        if app.state.log_stats:
121
            engine_client: EngineClient = app.state.engine_client
122
123
124

            async def _force_log():
                while True:
125
126
                    await asyncio.sleep(10.)
                    await engine_client.do_log_stats()
127
128
129
130
131
132

            task = asyncio.create_task(_force_log())
            _running_tasks.add(task)
            task.add_done_callback(_running_tasks.remove)
        else:
            task = None
133
134
135
136
137

        # Mark the startup heap as static so that it's ignored by GC.
        # Reduces pause times of oldest generation collections.
        gc.collect()
        gc.freeze()
138
139
140
141
142
143
144
145
        try:
            yield
        finally:
            if task is not None:
                task.cancel()
    finally:
        # Ensure app state including engine ref is gc'd
        del app.state
146
147


148
@asynccontextmanager
149
async def build_async_engine_client(
150
151
152
    args: Namespace,
    client_config: Optional[dict[str, Any]] = None,
) -> AsyncIterator[EngineClient]:
153

154
    # Context manager to handle engine_client lifecycle
155
156
157
    # Ensures everything is shutdown and cleaned up on error/exit
    engine_args = AsyncEngineArgs.from_cli_args(args)

158
    async with build_async_engine_client_from_engine_args(
159
160
            engine_args, args.disable_frontend_multiprocessing,
            client_config) as engine:
161
162
163
164
165
166
167
        yield engine


@asynccontextmanager
async def build_async_engine_client_from_engine_args(
    engine_args: AsyncEngineArgs,
    disable_frontend_multiprocessing: bool = False,
168
    client_config: Optional[dict[str, Any]] = None,
169
) -> AsyncIterator[EngineClient]:
170
    """
171
    Create EngineClient, either:
172
173
174
175
176
177
        - in-process using the AsyncLLMEngine Directly
        - multiprocess using AsyncLLMEngine RPC

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

178
179
180
181
182
183
184
185
186
187
188
189
190
    # Create the EngineConfig (determines if we can use V1).
    usage_context = UsageContext.OPENAI_API_SERVER
    vllm_config = engine_args.create_engine_config(usage_context=usage_context)

    # V1 AsyncLLM.
    if envs.VLLM_USE_V1:
        if disable_frontend_multiprocessing:
            logger.warning(
                "V1 is enabled, but got --disable-frontend-multiprocessing. "
                "To disable frontend multiprocessing, set VLLM_USE_V1=0.")

        from vllm.v1.engine.async_llm import AsyncLLM
        async_llm: Optional[AsyncLLM] = None
191
192
        client_index = client_config.pop(
            "client_index") if client_config else 0
193
194
195
196
197
        try:
            async_llm = AsyncLLM.from_vllm_config(
                vllm_config=vllm_config,
                usage_context=usage_context,
                disable_log_requests=engine_args.disable_log_requests,
198
199
200
                disable_log_stats=engine_args.disable_log_stats,
                client_addresses=client_config,
                client_index=client_index)
201
202
203
204

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

205
206
207
208
209
210
211
212
            yield async_llm
        finally:
            if async_llm:
                async_llm.shutdown()

    # V0 AsyncLLM.
    elif (MQLLMEngineClient.is_unsupported_config(vllm_config)
          or disable_frontend_multiprocessing):
213

214
215
        engine_client: Optional[EngineClient] = None
        try:
216
217
218
219
220
            engine_client = AsyncLLMEngine.from_vllm_config(
                vllm_config=vllm_config,
                usage_context=usage_context,
                disable_log_requests=engine_args.disable_log_requests,
                disable_log_stats=engine_args.disable_log_stats)
221
222
223
224
            yield engine_client
        finally:
            if engine_client and hasattr(engine_client, "shutdown"):
                engine_client.shutdown()
225

226
    # V0MQLLMEngine.
227
    else:
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
        if "PROMETHEUS_MULTIPROC_DIR" not in os.environ:
            # Make TemporaryDirectory for prometheus multiprocessing
            # Note: global TemporaryDirectory will be automatically
            #   cleaned up upon exit.
            global prometheus_multiproc_dir
            prometheus_multiproc_dir = tempfile.TemporaryDirectory()
            os.environ[
                "PROMETHEUS_MULTIPROC_DIR"] = prometheus_multiproc_dir.name
        else:
            logger.warning(
                "Found PROMETHEUS_MULTIPROC_DIR was set by user. "
                "This directory must be wiped between vLLM runs or "
                "you will find inaccurate metrics. Unset the variable "
                "and vLLM will properly handle cleanup.")

243
        # Select random path for IPC.
244
        ipc_path = get_open_zmq_ipc_path()
245
246
        logger.debug("Multiprocessing frontend to use %s for IPC Path.",
                     ipc_path)
247

248
        # Start RPCServer in separate process (holds the LLMEngine).
249
250
        # the current process might have CUDA context,
        # so we need to spawn a new process
251
252
        context = multiprocessing.get_context("spawn")

253
254
255
        # Ensure we can serialize transformer config before spawning
        maybe_register_config_serialize_by_value()

256
257
258
259
        # The Process can raise an exception during startup, which may
        # not actually result in an exitcode being reported. As a result
        # we use a shared variable to communicate the information.
        engine_alive = multiprocessing.Value('b', True, lock=False)
260
261
262
263
264
        engine_process = context.Process(
            target=run_mp_engine,
            args=(vllm_config, UsageContext.OPENAI_API_SERVER, ipc_path,
                  engine_args.disable_log_stats,
                  engine_args.disable_log_requests, engine_alive))
265
        engine_process.start()
266
        engine_pid = engine_process.pid
267
        assert engine_pid is not None, "Engine process failed to start."
268
        logger.info("Started engine process with PID %d", engine_pid)
269

270
271
272
273
274
275
276
277
        def _cleanup_ipc_path():
            socket_path = ipc_path.replace("ipc://", "")
            if os.path.exists(socket_path):
                os.remove(socket_path)

        # Ensure we clean up the local IPC socket file on exit.
        atexit.register(_cleanup_ipc_path)

278
        # Build RPCClient, which conforms to EngineClient Protocol.
279
        build_client = partial(MQLLMEngineClient, ipc_path, vllm_config,
280
281
282
                               engine_pid)
        mq_engine_client = await asyncio.get_running_loop().run_in_executor(
            None, build_client)
283
        try:
284
285
            while True:
                try:
286
                    await mq_engine_client.setup()
287
                    break
288
                except TimeoutError:
289
290
                    if (not engine_process.is_alive()
                            or not engine_alive.value):
291
                        raise RuntimeError(
292
293
                            "Engine process failed to start. See stack "
                            "trace for the root cause.") from None
294

295
            yield mq_engine_client  # type: ignore[misc]
296
297
        finally:
            # Ensure rpc server process was terminated
298
            engine_process.terminate()
299
300

            # Close all open connections to the backend
301
            mq_engine_client.close()
302

303
304
305
306
307
            # Wait for engine process to join
            engine_process.join(4)
            if engine_process.exitcode is None:
                # Kill if taking longer than 5 seconds to stop
                engine_process.kill()
308

309
310
311
312
313
            # Lazy import for prometheus multiprocessing.
            # We need to set PROMETHEUS_MULTIPROC_DIR environment variable
            # before prometheus_client is imported.
            # See https://prometheus.github.io/client_python/multiprocess/
            from prometheus_client import multiprocess
314
            multiprocess.mark_process_dead(engine_process.pid)
315

316

317
318
async def validate_json_request(raw_request: Request):
    content_type = raw_request.headers.get("content-type", "").lower()
319
320
    media_type = content_type.split(";", maxsplit=1)[0]
    if media_type != "application/json":
321
322
323
        raise RequestValidationError(errors=[
            "Unsupported Media Type: Only 'application/json' is allowed"
        ])
324
325


Ethan Xu's avatar
Ethan Xu committed
326
router = APIRouter()
Zhuohan Li's avatar
Zhuohan Li committed
327

328

329
330
331
332
class PrometheusResponse(Response):
    media_type = prometheus_client.CONTENT_TYPE_LATEST


333
def mount_metrics(app: FastAPI):
334
335
336
    """Mount prometheus metrics to a FastAPI app."""

    registry = get_prometheus_registry()
337

338
339
340
341
    # `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
342
343
344
345
346
347
348
349
350
351
    Instrumentator(
        excluded_handlers=[
            "/metrics",
            "/health",
            "/load",
            "/ping",
            "/version",
            "/server_info",
        ],
        registry=registry,
352
    ).add().instrument(app).expose(app, response_class=PrometheusResponse)
353
354
355

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

357
    # Workaround for 307 Redirect for /metrics
358
    metrics_route.path_regex = re.compile("^/metrics(?P<path>.*)$")
359
    app.routes.append(metrics_route)
360
361


362
363
364
365
366
def base(request: Request) -> OpenAIServing:
    # Reuse the existing instance
    return tokenization(request)


367
368
369
370
def models(request: Request) -> OpenAIServingModels:
    return request.app.state.openai_serving_models


371
def chat(request: Request) -> Optional[OpenAIServingChat]:
372
373
374
    return request.app.state.openai_serving_chat


375
def completion(request: Request) -> Optional[OpenAIServingCompletion]:
376
377
378
    return request.app.state.openai_serving_completion


379
380
381
382
def pooling(request: Request) -> Optional[OpenAIServingPooling]:
    return request.app.state.openai_serving_pooling


383
384
def embedding(request: Request) -> Optional[OpenAIServingEmbedding]:
    return request.app.state.openai_serving_embedding
385
386


387
def score(request: Request) -> Optional[ServingScores]:
388
389
390
    return request.app.state.openai_serving_scores


391
392
393
394
def classify(request: Request) -> Optional[ServingClassification]:
    return request.app.state.openai_serving_classification


395
396
def rerank(request: Request) -> Optional[ServingScores]:
    return request.app.state.openai_serving_scores
397
398


399
400
def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
401
402


403
404
405
406
def transcription(request: Request) -> OpenAIServingTranscription:
    return request.app.state.openai_serving_transcription


407
408
409
410
def translation(request: Request) -> OpenAIServingTranslation:
    return request.app.state.openai_serving_translation


411
def engine_client(request: Request) -> EngineClient:
412
413
414
    return request.app.state.engine_client


415
416
@router.get("/health", response_class=Response)
async def health(raw_request: Request) -> Response:
417
    """Health check."""
418
    await engine_client(raw_request).check_health()
419
    return Response(status_code=200)
420
421


422
423
424
425
426
427
428
429
430
@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
    # - /v1/embeddings
    # - /pooling
431
    # - /classify
432
433
434
435
436
437
438
439
440
    # - /score
    # - /v1/score
    # - /rerank
    # - /v1/rerank
    # - /v2/rerank
    return JSONResponse(
        content={'server_load': request.app.state.server_load_metrics})


441
442
443
@router.get("/ping", response_class=Response)
@router.post("/ping", response_class=Response)
async def ping(raw_request: Request) -> Response:
444
445
446
447
    """Ping check. Endpoint required for SageMaker"""
    return await health(raw_request)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
@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
                 },
             })
464
@with_cancellation
465
async def tokenize(request: TokenizeRequest, raw_request: Request):
466
467
    handler = tokenization(raw_request)

468
469
470
471
472
473
474
475
476
    try:
        generator = await handler.create_tokenize(request, raw_request)
    except NotImplementedError as e:
        raise HTTPException(status_code=HTTPStatus.NOT_IMPLEMENTED.value,
                            detail=str(e)) from e
    except Exception as e:
        raise HTTPException(status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value,
                            detail=str(e)) from e

477
478
479
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
480
    elif isinstance(generator, TokenizeResponse):
481
482
        return JSONResponse(content=generator.model_dump())

483
484
    assert_never(generator)

485

486
487
488
489
490
491
492
493
494
495
496
497
498
@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
                 },
             })
499
@with_cancellation
500
async def detokenize(request: DetokenizeRequest, raw_request: Request):
501
502
    handler = tokenization(raw_request)

503
504
505
506
507
508
509
510
    try:
        generator = await handler.create_detokenize(request, raw_request)
    except OverflowError as e:
        raise RequestValidationError(errors=[str(e)]) from e
    except Exception as e:
        raise HTTPException(status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value,
                            detail=str(e)) from e

511
512
513
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
514
    elif isinstance(generator, DetokenizeResponse):
515
516
        return JSONResponse(content=generator.model_dump())

517
518
    assert_never(generator)

519

Ethan Xu's avatar
Ethan Xu committed
520
@router.get("/v1/models")
521
async def show_available_models(raw_request: Request):
522
    handler = models(raw_request)
523

524
525
    models_ = await handler.show_available_models()
    return JSONResponse(content=models_.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
526
527


Ethan Xu's avatar
Ethan Xu committed
528
@router.get("/version")
529
async def show_version():
530
    ver = {"version": VLLM_VERSION}
531
532
533
    return JSONResponse(content=ver)


534
@router.post("/v1/chat/completions",
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
             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
                 }
             })
552
@with_cancellation
553
@load_aware_call
554
555
async def create_chat_completion(request: ChatCompletionRequest,
                                 raw_request: Request):
556
557
558
559
    handler = chat(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Chat Completions API")
560

561
    generator = await handler.create_chat_completion(request, raw_request)
562

563
564
565
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
566

567
    elif isinstance(generator, ChatCompletionResponse):
568
        return JSONResponse(content=generator.model_dump())
569

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

572

573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
@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
                 },
             })
591
@with_cancellation
592
@load_aware_call
593
async def create_completion(request: CompletionRequest, raw_request: Request):
594
595
596
597
598
    handler = completion(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Completions API")

599
600
601
602
603
604
605
606
607
    try:
        generator = await handler.create_completion(request, raw_request)
    except OverflowError as e:
        raise HTTPException(status_code=HTTPStatus.BAD_REQUEST.value,
                            detail=str(e)) from e
    except Exception as e:
        raise HTTPException(status_code=HTTPStatus.INTERNAL_SERVER_ERROR.value,
                            detail=str(e)) from e

608
609
610
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
611
    elif isinstance(generator, CompletionResponse):
612
        return JSONResponse(content=generator.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
613

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

Zhuohan Li's avatar
Zhuohan Li committed
616

617
618
619
620
621
622
623
624
625
626
@router.post("/v1/embeddings",
             dependencies=[Depends(validate_json_request)],
             responses={
                 HTTPStatus.BAD_REQUEST.value: {
                     "model": ErrorResponse
                 },
                 HTTPStatus.INTERNAL_SERVER_ERROR.value: {
                     "model": ErrorResponse
                 },
             })
627
@with_cancellation
628
@load_aware_call
629
async def create_embedding(request: EmbeddingRequest, raw_request: Request):
630
631
    handler = embedding(raw_request)
    if handler is None:
632
633
634
635
        return base(raw_request).create_error_response(
            message="The model does not support Embeddings API")

    generator = await handler.create_embedding(request, raw_request)
636

637
638
639
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
640
    elif isinstance(generator, EmbeddingResponse):
641
642
        return JSONResponse(content=generator.model_dump())

643
644
    assert_never(generator)

645

646
647
648
649
650
651
652
653
654
655
@router.post("/pooling",
             dependencies=[Depends(validate_json_request)],
             responses={
                 HTTPStatus.BAD_REQUEST.value: {
                     "model": ErrorResponse
                 },
                 HTTPStatus.INTERNAL_SERVER_ERROR.value: {
                     "model": ErrorResponse
                 },
             })
656
@with_cancellation
657
@load_aware_call
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
async def create_pooling(request: PoolingRequest, raw_request: Request):
    handler = pooling(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Pooling API")

    generator = await handler.create_pooling(request, raw_request)
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
    elif isinstance(generator, PoolingResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
@router.post("/classify", dependencies=[Depends(validate_json_request)])
@with_cancellation
@load_aware_call
async def create_classify(request: ClassificationRequest,
                          raw_request: Request):
    handler = classify(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Classification API")

    generator = await handler.create_classify(request, raw_request)
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)

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

    assert_never(generator)


695
696
697
698
699
700
701
702
703
704
@router.post("/score",
             dependencies=[Depends(validate_json_request)],
             responses={
                 HTTPStatus.BAD_REQUEST.value: {
                     "model": ErrorResponse
                 },
                 HTTPStatus.INTERNAL_SERVER_ERROR.value: {
                     "model": ErrorResponse
                 },
             })
705
@with_cancellation
706
@load_aware_call
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
async def create_score(request: ScoreRequest, raw_request: Request):
    handler = score(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Score API")

    generator = await handler.create_score(request, raw_request)
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
    elif isinstance(generator, ScoreResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


723
724
725
726
727
728
729
730
731
732
@router.post("/v1/score",
             dependencies=[Depends(validate_json_request)],
             responses={
                 HTTPStatus.BAD_REQUEST.value: {
                     "model": ErrorResponse
                 },
                 HTTPStatus.INTERNAL_SERVER_ERROR.value: {
                     "model": ErrorResponse
                 },
             })
733
@with_cancellation
734
@load_aware_call
735
736
737
738
739
740
741
742
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 "
        "have moved it to `/score`. Please update your client accordingly.")

    return await create_score(request, raw_request)


743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
@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
                 },
             })
760
@with_cancellation
761
@load_aware_call
762
763
764
async def create_transcriptions(raw_request: Request,
                                request: Annotated[TranscriptionRequest,
                                                   Form()]):
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
    handler = transcription(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Transcriptions API")

    audio_data = await request.file.read()
    generator = await handler.create_transcription(audio_data, request,
                                                   raw_request)

    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)

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

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


784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
@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
                 },
             })
@with_cancellation
@load_aware_call
async def create_translations(request: Annotated[TranslationRequest,
                                                 Form()],
                              raw_request: Request):
    handler = translation(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Translations API")

    audio_data = await request.file.read()
    generator = await handler.create_translation(audio_data, request,
                                                 raw_request)

    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)

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

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


825
826
827
828
829
830
831
832
833
834
@router.post("/rerank",
             dependencies=[Depends(validate_json_request)],
             responses={
                 HTTPStatus.BAD_REQUEST.value: {
                     "model": ErrorResponse
                 },
                 HTTPStatus.INTERNAL_SERVER_ERROR.value: {
                     "model": ErrorResponse
                 },
             })
835
@with_cancellation
836
@load_aware_call
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
async def do_rerank(request: RerankRequest, raw_request: Request):
    handler = rerank(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Rerank (Score) API")
    generator = await handler.do_rerank(request, raw_request)
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
    elif isinstance(generator, RerankResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


852
853
854
855
856
857
858
859
860
861
@router.post("/v1/rerank",
             dependencies=[Depends(validate_json_request)],
             responses={
                 HTTPStatus.BAD_REQUEST.value: {
                     "model": ErrorResponse
                 },
                 HTTPStatus.INTERNAL_SERVER_ERROR.value: {
                     "model": ErrorResponse
                 },
             })
862
863
@with_cancellation
async def do_rerank_v1(request: RerankRequest, raw_request: Request):
864
    logger.warning_once(
865
        "To indicate that the rerank API is not part of the standard OpenAI"
866
        " API, we have located it at `/rerank`. Please update your client "
867
868
869
870
871
        "accordingly. (Note: Conforms to JinaAI rerank API)")

    return await do_rerank(request, raw_request)


872
873
874
875
876
877
878
879
880
881
@router.post("/v2/rerank",
             dependencies=[Depends(validate_json_request)],
             responses={
                 HTTPStatus.BAD_REQUEST.value: {
                     "model": ErrorResponse
                 },
                 HTTPStatus.INTERNAL_SERVER_ERROR.value: {
                     "model": ErrorResponse
                 },
             })
882
883
884
885
886
@with_cancellation
async def do_rerank_v2(request: RerankRequest, raw_request: Request):
    return await do_rerank(request, raw_request)


887
TASK_HANDLERS: dict[str, dict[str, tuple]] = {
888
889
890
891
892
893
894
895
896
    "generate": {
        "messages": (ChatCompletionRequest, create_chat_completion),
        "default": (CompletionRequest, create_completion),
    },
    "embed": {
        "messages": (EmbeddingChatRequest, create_embedding),
        "default": (EmbeddingCompletionRequest, create_embedding),
    },
    "score": {
897
898
899
900
        "default": (RerankRequest, do_rerank)
    },
    "rerank": {
        "default": (RerankRequest, do_rerank)
901
902
903
904
905
906
907
908
909
910
911
    },
    "reward": {
        "messages": (PoolingChatRequest, create_pooling),
        "default": (PoolingCompletionRequest, create_pooling),
    },
    "classify": {
        "messages": (PoolingChatRequest, create_pooling),
        "default": (PoolingCompletionRequest, create_pooling),
    },
}

912
913
if envs.VLLM_SERVER_DEV_MODE:

914
915
916
917
918
    @router.get("/server_info")
    async def show_server_info(raw_request: Request):
        server_info = {"vllm_config": str(raw_request.app.state.vllm_config)}
        return JSONResponse(content=server_info)

919
920
921
922
923
924
    @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.
        """
925
926
927
928
929
930
        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)
931
932
        return Response(status_code=200)

933
934
935
936
937
938
939
940
941
942
943
    @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):
944
945
946
947
948
949
        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)
950
951
952
953
        # 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)

954
955
956
957
958
959
    @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})

960

961
962
963
964
965
966
967
968
969
970
971
972
973
@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
                 },
             })
974
975
976
977
async def invocations(raw_request: Request):
    """
    For SageMaker, routes requests to other handlers based on model `task`.
    """
978
979
    try:
        body = await raw_request.json()
980
    except json.JSONDecodeError as e:
981
982
983
        raise HTTPException(status_code=HTTPStatus.BAD_REQUEST.value,
                            detail=f"JSON decode error: {e}") from e

984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
    task = raw_request.app.state.task

    if task not in TASK_HANDLERS:
        raise HTTPException(
            status_code=400,
            detail=f"Unsupported task: '{task}' for '/invocations'. "
            f"Expected one of {set(TASK_HANDLERS.keys())}")

    handler_config = TASK_HANDLERS[task]
    if "messages" in body:
        request_model, handler = handler_config["messages"]
    else:
        request_model, handler = handler_config["default"]

    # this is required since we lose the FastAPI automatic casting
    request = request_model.model_validate(body)
    return await handler(request, raw_request)


1003
1004
1005
1006
1007
1008
if envs.VLLM_TORCH_PROFILER_DIR:
    logger.warning(
        "Torch Profiler is enabled in the API server. This should ONLY be "
        "used for local development!")

    @router.post("/start_profile")
1009
    async def start_profile(raw_request: Request):
1010
        logger.info("Starting profiler...")
1011
        await engine_client(raw_request).start_profile()
1012
1013
1014
1015
        logger.info("Profiler started.")
        return Response(status_code=200)

    @router.post("/stop_profile")
1016
    async def stop_profile(raw_request: Request):
1017
        logger.info("Stopping profiler...")
1018
        await engine_client(raw_request).stop_profile()
1019
1020
1021
1022
        logger.info("Profiler stopped.")
        return Response(status_code=200)


1023
1024
if envs.VLLM_ALLOW_RUNTIME_LORA_UPDATING:
    logger.warning(
1025
        "LoRA dynamic loading & unloading is enabled in the API server. "
1026
1027
        "This should ONLY be used for local development!")

1028
1029
    @router.post("/v1/load_lora_adapter",
                 dependencies=[Depends(validate_json_request)])
1030
    async def load_lora_adapter(request: LoadLoRAAdapterRequest,
1031
                                raw_request: Request):
1032
1033
1034
1035
1036
        handler = models(raw_request)
        response = await handler.load_lora_adapter(request)
        if isinstance(response, ErrorResponse):
            return JSONResponse(content=response.model_dump(),
                                status_code=response.code)
1037
1038
1039

        return Response(status_code=200, content=response)

1040
1041
    @router.post("/v1/unload_lora_adapter",
                 dependencies=[Depends(validate_json_request)])
1042
    async def unload_lora_adapter(request: UnloadLoRAAdapterRequest,
1043
                                  raw_request: Request):
1044
1045
1046
1047
1048
        handler = models(raw_request)
        response = await handler.unload_lora_adapter(request)
        if isinstance(response, ErrorResponse):
            return JSONResponse(content=response.model_dump(),
                                status_code=response.code)
1049
1050
1051
1052

        return Response(status_code=200, content=response)


1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
def load_log_config(log_config_file: Optional[str]) -> Optional[dict]:
    if not log_config_file:
        return None
    try:
        with open(log_config_file) as f:
            return json.load(f)
    except Exception as e:
        logger.warning("Failed to load log config from file %s: error %s",
                       log_config_file, e)
        return None


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
class AuthenticationMiddleware:
    """
    Pure ASGI middleware that authenticates each request by checking
    if the Authorization header exists and equals "Bearer {api_key}".

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

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

    def __call__(self, scope: Scope, receive: Receive,
                 send: Send) -> Awaitable[None]:
        if scope["type"] not in ("http",
                                 "websocket") or scope["method"] == "OPTIONS":
            # 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.
        if url_path.startswith("/v1") and headers.get(
                "Authorization") != f"Bearer {self.api_token}":
            response = JSONResponse(content={"error": "Unauthorized"},
                                    status_code=401)
            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

    def __call__(self, scope: Scope, receive: Receive,
                 send: Send) -> Awaitable[None]:
        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"])
                request_id = request_headers.get("X-Request-Id",
                                                 uuid.uuid4().hex)
                response_headers.append("X-Request-Id", request_id)
            await send(message)

        return self.app(scope, receive, send_with_request_id)


1133
def build_app(args: Namespace) -> FastAPI:
1134
1135
1136
1137
1138
1139
1140
    if args.disable_fastapi_docs:
        app = FastAPI(openapi_url=None,
                      docs_url=None,
                      redoc_url=None,
                      lifespan=lifespan)
    else:
        app = FastAPI(lifespan=lifespan)
Ethan Xu's avatar
Ethan Xu committed
1141
1142
    app.include_router(router)
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
1143

1144
1145
    mount_metrics(app)

Zhuohan Li's avatar
Zhuohan Li committed
1146
1147
1148
1149
1150
1151
1152
1153
    app.add_middleware(
        CORSMiddleware,
        allow_origins=args.allowed_origins,
        allow_credentials=args.allow_credentials,
        allow_methods=args.allowed_methods,
        allow_headers=args.allowed_headers,
    )

1154
1155
1156
1157
1158
1159
1160
    @app.exception_handler(HTTPException)
    async def http_exception_handler(_: Request, exc: HTTPException):
        err = ErrorResponse(message=exc.detail,
                            type=HTTPStatus(exc.status_code).phrase,
                            code=exc.status_code)
        return JSONResponse(err.model_dump(), status_code=exc.status_code)

Ethan Xu's avatar
Ethan Xu committed
1161
    @app.exception_handler(RequestValidationError)
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
    async def validation_exception_handler(_: Request,
                                           exc: RequestValidationError):
        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

        err = ErrorResponse(message=message,
                            type=HTTPStatus.BAD_REQUEST.phrase,
1174
                            code=HTTPStatus.BAD_REQUEST)
Ethan Xu's avatar
Ethan Xu committed
1175
1176
1177
        return JSONResponse(err.model_dump(),
                            status_code=HTTPStatus.BAD_REQUEST)

1178
1179
    # Ensure --api-key option from CLI takes precedence over VLLM_API_KEY
    if token := args.api_key or envs.VLLM_API_KEY:
1180
        app.add_middleware(AuthenticationMiddleware, api_token=token)
1181

1182
    if args.enable_request_id_headers:
1183
        app.add_middleware(XRequestIdMiddleware)
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196

    if envs.VLLM_DEBUG_LOG_API_SERVER_RESPONSE:
        logger.warning("CAUTION: Enabling log response in the API Server. "
                       "This can include sensitive information and should be "
                       "avoided in production.")

        @app.middleware("http")
        async def log_response(request: Request, call_next):
            response = await call_next(request)
            response_body = [
                section async for section in response.body_iterator
            ]
            response.body_iterator = iterate_in_threadpool(iter(response_body))
1197
1198
            logger.info("response_body={%s}",
                        response_body[0].decode() if response_body else None)
1199
            return response
1200

1201
1202
1203
1204
    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):
1205
            app.add_middleware(imported)  # type: ignore[arg-type]
1206
1207
1208
        elif inspect.iscoroutinefunction(imported):
            app.middleware("http")(imported)
        else:
1209
1210
            raise ValueError(f"Invalid middleware {middleware}. "
                             f"Must be a function or a class.")
1211

Ethan Xu's avatar
Ethan Xu committed
1212
1213
1214
    return app


1215
async def init_app_state(
1216
    engine_client: EngineClient,
1217
    vllm_config: VllmConfig,
1218
    state: State,
1219
    args: Namespace,
1220
) -> None:
1221
    if args.served_model_name is not None:
1222
        served_model_names = args.served_model_name
1223
    else:
1224
        served_model_names = [args.model]
1225

1226
1227
1228
1229
1230
    if args.disable_log_requests:
        request_logger = None
    else:
        request_logger = RequestLogger(max_log_len=args.max_log_len)

1231
1232
1233
1234
1235
    base_model_paths = [
        BaseModelPath(name=name, model_path=args.model)
        for name in served_model_names
    ]

1236
    state.engine_client = engine_client
1237
    state.log_stats = not args.disable_log_stats
1238
1239
    state.vllm_config = vllm_config
    model_config = vllm_config.model_config
Ethan Xu's avatar
Ethan Xu committed
1240

1241
    resolved_chat_template = load_chat_template(args.chat_template)
1242
    if resolved_chat_template is not None:
1243
1244
1245
1246
1247
1248
1249
1250
1251
        # 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(
                chat_template=resolved_chat_template)
        else:
            hf_chat_template = resolve_hf_chat_template(
1252
                tokenizer=tokenizer,
1253
1254
                chat_template=None,
                tools=None,
1255
                model_config=vllm_config.model_config,
1256
            )
1257
1258
1259
1260
1261
1262
1263

            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.",
                    resolved_chat_template, args.model)
1264

1265
    state.openai_serving_models = OpenAIServingModels(
1266
        engine_client=engine_client,
1267
1268
1269
1270
1271
        model_config=model_config,
        base_model_paths=base_model_paths,
        lora_modules=args.lora_modules,
        prompt_adapters=args.prompt_adapters,
    )
1272
    await state.openai_serving_models.init_static_loras()
1273
    state.openai_serving_chat = OpenAIServingChat(
1274
        engine_client,
1275
        model_config,
1276
        state.openai_serving_models,
1277
1278
        args.response_role,
        request_logger=request_logger,
1279
1280
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
1281
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
1282
        enable_auto_tools=args.enable_auto_tool_choice,
1283
        tool_parser=args.tool_call_parser,
1284
        reasoning_parser=args.reasoning_parser,
1285
        enable_prompt_tokens_details=args.enable_prompt_tokens_details,
1286
        enable_force_include_usage=args.enable_force_include_usage,
1287
    ) if model_config.runner_type == "generate" else None
1288
    state.openai_serving_completion = OpenAIServingCompletion(
1289
        engine_client,
1290
        model_config,
1291
        state.openai_serving_models,
1292
        request_logger=request_logger,
1293
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
1294
        enable_force_include_usage=args.enable_force_include_usage,
1295
    ) if model_config.runner_type == "generate" else None
1296
    state.openai_serving_pooling = OpenAIServingPooling(
1297
        engine_client,
1298
        model_config,
1299
        state.openai_serving_models,
1300
        request_logger=request_logger,
1301
1302
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
1303
    ) if model_config.runner_type == "pooling" else None
1304
1305
1306
    state.openai_serving_embedding = OpenAIServingEmbedding(
        engine_client,
        model_config,
1307
        state.openai_serving_models,
1308
1309
1310
1311
        request_logger=request_logger,
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
    ) if model_config.task == "embed" else None
1312
    state.openai_serving_scores = ServingScores(
1313
1314
        engine_client,
        model_config,
1315
        state.openai_serving_models,
1316
1317
        request_logger=request_logger) if model_config.task in (
            "score", "embed", "pooling") else None
1318
1319
1320
1321
1322
1323
    state.openai_serving_classification = ServingClassification(
        engine_client,
        model_config,
        state.openai_serving_models,
        request_logger=request_logger,
    ) if model_config.task == "classify" else None
1324
    state.jinaai_serving_reranking = ServingScores(
1325
1326
1327
1328
1329
        engine_client,
        model_config,
        state.openai_serving_models,
        request_logger=request_logger
    ) if model_config.task == "score" else None
1330
    state.openai_serving_tokenization = OpenAIServingTokenization(
1331
        engine_client,
1332
        model_config,
1333
        state.openai_serving_models,
1334
        request_logger=request_logger,
1335
1336
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
1337
    )
1338
1339
1340
    state.openai_serving_transcription = OpenAIServingTranscription(
        engine_client,
        model_config,
1341
1342
1343
1344
1345
1346
        state.openai_serving_models,
        request_logger=request_logger,
    ) if model_config.runner_type == "transcription" else None
    state.openai_serving_translation = OpenAIServingTranslation(
        engine_client,
        model_config,
1347
1348
1349
        state.openai_serving_models,
        request_logger=request_logger,
    ) if model_config.runner_type == "transcription" else None
1350
    state.task = model_config.task
1351

1352
1353
1354
    state.enable_server_load_tracking = args.enable_server_load_tracking
    state.server_load_metrics = 0

1355

1356
def create_server_socket(addr: tuple[str, int]) -> socket.socket:
1357
1358
1359
1360
1361
1362
    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)
1363
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
1364
1365
1366
1367
1368
    sock.bind(addr)

    return sock


1369
def validate_api_server_args(args):
1370
    valid_tool_parses = ToolParserManager.tool_parsers.keys()
1371
    if args.enable_auto_tool_choice \
1372
            and args.tool_call_parser not in valid_tool_parses:
1373
        raise KeyError(f"invalid tool call parser: {args.tool_call_parser} "
1374
                       f"(chose from {{ {','.join(valid_tool_parses)} }})")
1375

1376
    valid_reasoning_parses = ReasoningParserManager.reasoning_parsers.keys()
1377
    if args.reasoning_parser \
1378
1379
1380
1381
1382
        and args.reasoning_parser not in valid_reasoning_parses:
        raise KeyError(
            f"invalid reasoning parser: {args.reasoning_parser} "
            f"(chose from {{ {','.join(valid_reasoning_parses)} }})")

1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395

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)

1396
1397
1398
    # 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
1399
1400
    sock_addr = (args.host or "", args.port)
    sock = create_server_socket(sock_addr)
1401

1402
1403
1404
1405
    # workaround to avoid footguns where uvicorn drops requests with too
    # many concurrent requests active
    set_ulimit()

1406
1407
1408
1409
1410
1411
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
    addr, port = sock_addr
    is_ssl = args.ssl_keyfile and args.ssl_certfile
    host_part = f"[{addr}]" if is_valid_ipv6_address(
        addr) else addr or "0.0.0.0"
    listen_address = f"http{'s' if is_ssl else ''}://{host_part}:{port}"

    return listen_address, sock


async def run_server(args, **uvicorn_kwargs) -> None:
    """Run a single-worker API server."""
    listen_address, sock = setup_server(args)
    await run_server_worker(listen_address, sock, args, **uvicorn_kwargs)


async def run_server_worker(listen_address,
                            sock,
                            args,
                            client_config=None,
                            **uvicorn_kwargs) -> None:
    """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)

    server_index = client_config.get("client_index", 0) if client_config else 0

1439
1440
1441
1442
1443
    # Load logging config for uvicorn if specified
    log_config = load_log_config(args.log_config_file)
    if log_config is not None:
        uvicorn_kwargs['log_config'] = log_config

1444
    async with build_async_engine_client(args, client_config) as engine_client:
1445
1446
        app = build_app(args)

1447
1448
        vllm_config = await engine_client.get_vllm_config()
        await init_app_state(engine_client, vllm_config, app.state, args)
1449

1450
1451
        logger.info("Starting vLLM API server %d on %s", server_index,
                    listen_address)
1452
1453
        shutdown_task = await serve_http(
            app,
1454
            sock=sock,
1455
            enable_ssl_refresh=args.enable_ssl_refresh,
1456
1457
1458
            host=args.host,
            port=args.port,
            log_level=args.uvicorn_log_level,
1459
1460
1461
            # NOTE: When the 'disable_uvicorn_access_log' value is True,
            # no access log will be output.
            access_log=not args.disable_uvicorn_access_log,
1462
            timeout_keep_alive=envs.VLLM_HTTP_TIMEOUT_KEEP_ALIVE,
1463
1464
1465
1466
            ssl_keyfile=args.ssl_keyfile,
            ssl_certfile=args.ssl_certfile,
            ssl_ca_certs=args.ssl_ca_certs,
            ssl_cert_reqs=args.ssl_cert_reqs,
1467
1468
1469
            **uvicorn_kwargs,
        )

1470
    # NB: Await server shutdown only after the backend context is exited
1471
1472
1473
1474
    try:
        await shutdown_task
    finally:
        sock.close()
1475

Ethan Xu's avatar
Ethan Xu committed
1476
1477
1478

if __name__ == "__main__":
    # NOTE(simon):
1479
1480
    # This section should be in sync with vllm/entrypoints/cli/main.py for CLI
    # entrypoints.
1481
    cli_env_setup()
Ethan Xu's avatar
Ethan Xu committed
1482
1483
1484
1485
    parser = FlexibleArgumentParser(
        description="vLLM OpenAI-Compatible RESTful API server.")
    parser = make_arg_parser(parser)
    args = parser.parse_args()
1486
    validate_parsed_serve_args(args)
1487

1488
    uvloop.run(run_server(args))