api_server.py 30.4 KB
Newer Older
1
import asyncio
2
import atexit
3
4
import importlib
import inspect
5
import multiprocessing
6
import os
7
import re
8
import signal
9
import socket
10
import tempfile
11
import uuid
12
from argparse import Namespace
13
from contextlib import asynccontextmanager
14
from functools import partial
15
from http import HTTPStatus
16
from typing import AsyncIterator, Optional, Set, Tuple
17

18
import uvloop
19
from fastapi import APIRouter, FastAPI, HTTPException, Request
Zhuohan Li's avatar
Zhuohan Li committed
20
21
from fastapi.exceptions import RequestValidationError
from fastapi.middleware.cors import CORSMiddleware
22
from fastapi.responses import JSONResponse, Response, StreamingResponse
23
from starlette.datastructures import State
24
from starlette.routing import Mount
25
from typing_extensions import assert_never
Zhuohan Li's avatar
Zhuohan Li committed
26

27
import vllm.envs as envs
28
from vllm.config import ModelConfig
Woosuk Kwon's avatar
Woosuk Kwon committed
29
from vllm.engine.arg_utils import AsyncEngineArgs
30
from vllm.engine.async_llm_engine import AsyncLLMEngine  # type: ignore
31
32
33
from vllm.engine.multiprocessing.client import MQLLMEngineClient
from vllm.engine.multiprocessing.engine import run_mp_engine
from vllm.engine.protocol import EngineClient
34
from vllm.entrypoints.chat_utils import load_chat_template
35
from vllm.entrypoints.launcher import serve_http
36
from vllm.entrypoints.logger import RequestLogger
37
38
from vllm.entrypoints.openai.cli_args import (make_arg_parser,
                                              validate_parsed_serve_args)
39
40
# yapf conflicts with isort for this block
# yapf: disable
41
from vllm.entrypoints.openai.protocol import (ChatCompletionRequest,
42
                                              ChatCompletionResponse,
43
                                              CompletionRequest,
44
                                              CompletionResponse,
45
46
                                              DetokenizeRequest,
                                              DetokenizeResponse,
47
48
                                              EmbeddingChatRequest,
                                              EmbeddingCompletionRequest,
49
                                              EmbeddingRequest,
50
51
52
                                              EmbeddingResponse,
                                              EmbeddingResponseData,
                                              ErrorResponse,
53
                                              LoadLoraAdapterRequest,
54
55
                                              PoolingChatRequest,
                                              PoolingCompletionRequest,
56
                                              PoolingRequest, PoolingResponse,
57
                                              ScoreRequest, ScoreResponse,
58
                                              TokenizeRequest,
59
60
61
                                              TokenizeResponse,
                                              UnloadLoraAdapterRequest)
# yapf: enable
62
63
from vllm.entrypoints.openai.serving_chat import OpenAIServingChat
from vllm.entrypoints.openai.serving_completion import OpenAIServingCompletion
64
from vllm.entrypoints.openai.serving_embedding import OpenAIServingEmbedding
65
66
67
from vllm.entrypoints.openai.serving_engine import OpenAIServing
from vllm.entrypoints.openai.serving_models import (BaseModelPath,
                                                    OpenAIServingModels)
68
from vllm.entrypoints.openai.serving_pooling import OpenAIServingPooling
69
from vllm.entrypoints.openai.serving_score import OpenAIServingScores
70
71
from vllm.entrypoints.openai.serving_tokenization import (
    OpenAIServingTokenization)
72
from vllm.entrypoints.openai.tool_parsers import ToolParserManager
73
from vllm.entrypoints.utils import with_cancellation
74
from vllm.logger import init_logger
yhu422's avatar
yhu422 committed
75
from vllm.usage.usage_lib import UsageContext
76
from vllm.utils import (FlexibleArgumentParser, get_open_zmq_ipc_path,
77
                        is_valid_ipv6_address, set_ulimit)
78
from vllm.version import __version__ as VLLM_VERSION
Zhuohan Li's avatar
Zhuohan Li committed
79

80
TIMEOUT_KEEP_ALIVE = 5  # seconds
Zhuohan Li's avatar
Zhuohan Li committed
81

82
prometheus_multiproc_dir: tempfile.TemporaryDirectory
83

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

87
_running_tasks: Set[asyncio.Task] = set()
88

89

90
@asynccontextmanager
91
async def lifespan(app: FastAPI):
92
93
    try:
        if app.state.log_stats:
94
            engine_client: EngineClient = app.state.engine_client
95
96
97

            async def _force_log():
                while True:
98
99
                    await asyncio.sleep(10.)
                    await engine_client.do_log_stats()
100
101
102
103
104
105
106
107
108
109
110
111
112
113

            task = asyncio.create_task(_force_log())
            _running_tasks.add(task)
            task.add_done_callback(_running_tasks.remove)
        else:
            task = None
        try:
            yield
        finally:
            if task is not None:
                task.cancel()
    finally:
        # Ensure app state including engine ref is gc'd
        del app.state
114
115


116
@asynccontextmanager
117
async def build_async_engine_client(
118
        args: Namespace) -> AsyncIterator[EngineClient]:
119

120
    # Context manager to handle engine_client lifecycle
121
122
123
    # Ensures everything is shutdown and cleaned up on error/exit
    engine_args = AsyncEngineArgs.from_cli_args(args)

124
125
126
127
128
129
130
131
132
    async with build_async_engine_client_from_engine_args(
            engine_args, args.disable_frontend_multiprocessing) as engine:
        yield engine


@asynccontextmanager
async def build_async_engine_client_from_engine_args(
    engine_args: AsyncEngineArgs,
    disable_frontend_multiprocessing: bool = False,
133
) -> AsyncIterator[EngineClient]:
134
    """
135
    Create EngineClient, either:
136
137
138
139
140
141
        - in-process using the AsyncLLMEngine Directly
        - multiprocess using AsyncLLMEngine RPC

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

142
    # AsyncLLMEngine.
143
    if (MQLLMEngineClient.is_unsupported_config(engine_args)
144
            or envs.VLLM_USE_V1 or disable_frontend_multiprocessing):
145

146
147
148
149
150
151
152
153
154
        engine_client: Optional[EngineClient] = None
        try:
            engine_client = AsyncLLMEngine.from_engine_args(
                engine_args=engine_args,
                usage_context=UsageContext.OPENAI_API_SERVER)
            yield engine_client
        finally:
            if engine_client and hasattr(engine_client, "shutdown"):
                engine_client.shutdown()
155

156
    # MQLLMEngine.
157
    else:
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
        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.")

173
        # Select random path for IPC.
174
        ipc_path = get_open_zmq_ipc_path()
175
176
        logger.debug("Multiprocessing frontend to use %s for IPC Path.",
                     ipc_path)
177

178
        # Start RPCServer in separate process (holds the LLMEngine).
179
180
        # the current process might have CUDA context,
        # so we need to spawn a new process
181
182
        context = multiprocessing.get_context("spawn")

183
184
185
186
        # 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)
187
188
189
        engine_process = context.Process(target=run_mp_engine,
                                         args=(engine_args,
                                               UsageContext.OPENAI_API_SERVER,
190
                                               ipc_path, engine_alive))
191
        engine_process.start()
192
        engine_pid = engine_process.pid
193
        assert engine_pid is not None, "Engine process failed to start."
194
        logger.info("Started engine process with PID %d", engine_pid)
195

196
197
198
199
200
201
202
203
        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)

204
205
        # Build RPCClient, which conforms to EngineClient Protocol.
        engine_config = engine_args.create_engine_config()
206
207
208
209
        build_client = partial(MQLLMEngineClient, ipc_path, engine_config,
                               engine_pid)
        mq_engine_client = await asyncio.get_running_loop().run_in_executor(
            None, build_client)
210
        try:
211
212
            while True:
                try:
213
                    await mq_engine_client.setup()
214
                    break
215
                except TimeoutError:
216
217
                    if (not engine_process.is_alive()
                            or not engine_alive.value):
218
                        raise RuntimeError(
219
220
                            "Engine process failed to start. See stack "
                            "trace for the root cause.") from None
221

222
            yield mq_engine_client  # type: ignore[misc]
223
224
        finally:
            # Ensure rpc server process was terminated
225
            engine_process.terminate()
226
227

            # Close all open connections to the backend
228
            mq_engine_client.close()
229

230
231
232
233
234
            # 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()
235

236
237
238
239
240
            # 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
241
            multiprocess.mark_process_dead(engine_process.pid)
242

243

Ethan Xu's avatar
Ethan Xu committed
244
router = APIRouter()
Zhuohan Li's avatar
Zhuohan Li committed
245

246

247
def mount_metrics(app: FastAPI):
248
249
250
251
252
253
254
255
256
    # 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 (CollectorRegistry, make_asgi_app,
                                   multiprocess)

    prometheus_multiproc_dir_path = os.getenv("PROMETHEUS_MULTIPROC_DIR", None)
    if prometheus_multiproc_dir_path is not None:
257
258
        logger.debug("vLLM to use %s as PROMETHEUS_MULTIPROC_DIR",
                     prometheus_multiproc_dir_path)
259
260
261
262
263
264
265
266
267
        registry = CollectorRegistry()
        multiprocess.MultiProcessCollector(registry)

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

268
    # Workaround for 307 Redirect for /metrics
269
    metrics_route.path_regex = re.compile("^/metrics(?P<path>.*)$")
270
    app.routes.append(metrics_route)
271
272


273
274
275
276
277
def base(request: Request) -> OpenAIServing:
    # Reuse the existing instance
    return tokenization(request)


278
279
280
281
def models(request: Request) -> OpenAIServingModels:
    return request.app.state.openai_serving_models


282
def chat(request: Request) -> Optional[OpenAIServingChat]:
283
284
285
    return request.app.state.openai_serving_chat


286
def completion(request: Request) -> Optional[OpenAIServingCompletion]:
287
288
289
    return request.app.state.openai_serving_completion


290
291
292
293
def pooling(request: Request) -> Optional[OpenAIServingPooling]:
    return request.app.state.openai_serving_pooling


294
295
def embedding(request: Request) -> Optional[OpenAIServingEmbedding]:
    return request.app.state.openai_serving_embedding
296
297


298
299
300
301
def score(request: Request) -> Optional[OpenAIServingScores]:
    return request.app.state.openai_serving_scores


302
303
def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
304
305


306
def engine_client(request: Request) -> EngineClient:
307
308
309
    return request.app.state.engine_client


Ethan Xu's avatar
Ethan Xu committed
310
@router.get("/health")
311
async def health(raw_request: Request) -> Response:
312
    """Health check."""
313
    await engine_client(raw_request).check_health()
314
315
316
    return Response(status_code=200)


317
318
319
320
321
322
@router.api_route("/ping", methods=["GET", "POST"])
async def ping(raw_request: Request) -> Response:
    """Ping check. Endpoint required for SageMaker"""
    return await health(raw_request)


Ethan Xu's avatar
Ethan Xu committed
323
@router.post("/tokenize")
324
@with_cancellation
325
async def tokenize(request: TokenizeRequest, raw_request: Request):
326
327
    handler = tokenization(raw_request)

328
    generator = await handler.create_tokenize(request, raw_request)
329
330
331
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
332
    elif isinstance(generator, TokenizeResponse):
333
334
        return JSONResponse(content=generator.model_dump())

335
336
    assert_never(generator)

337

Ethan Xu's avatar
Ethan Xu committed
338
@router.post("/detokenize")
339
@with_cancellation
340
async def detokenize(request: DetokenizeRequest, raw_request: Request):
341
342
    handler = tokenization(raw_request)

343
    generator = await handler.create_detokenize(request, raw_request)
344
345
346
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
347
    elif isinstance(generator, DetokenizeResponse):
348
349
        return JSONResponse(content=generator.model_dump())

350
351
    assert_never(generator)

352

Ethan Xu's avatar
Ethan Xu committed
353
@router.get("/v1/models")
354
async def show_available_models(raw_request: Request):
355
    handler = models(raw_request)
356

357
358
    models_ = await handler.show_available_models()
    return JSONResponse(content=models_.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
359
360


Ethan Xu's avatar
Ethan Xu committed
361
@router.get("/version")
362
async def show_version():
363
    ver = {"version": VLLM_VERSION}
364
365
366
    return JSONResponse(content=ver)


Ethan Xu's avatar
Ethan Xu committed
367
@router.post("/v1/chat/completions")
368
@with_cancellation
369
370
async def create_chat_completion(request: ChatCompletionRequest,
                                 raw_request: Request):
371
372
373
374
    handler = chat(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Chat Completions API")
375

376
    generator = await handler.create_chat_completion(request, raw_request)
377

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

382
    elif isinstance(generator, ChatCompletionResponse):
383
        return JSONResponse(content=generator.model_dump())
384

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

387

Ethan Xu's avatar
Ethan Xu committed
388
@router.post("/v1/completions")
389
@with_cancellation
390
async def create_completion(request: CompletionRequest, raw_request: Request):
391
392
393
394
395
396
    handler = completion(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Completions API")

    generator = await handler.create_completion(request, raw_request)
397
398
399
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
400
    elif isinstance(generator, CompletionResponse):
401
        return JSONResponse(content=generator.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
402

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

Zhuohan Li's avatar
Zhuohan Li committed
405

Ethan Xu's avatar
Ethan Xu committed
406
@router.post("/v1/embeddings")
407
@with_cancellation
408
async def create_embedding(request: EmbeddingRequest, raw_request: Request):
409
410
    handler = embedding(raw_request)
    if handler is None:
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
        fallback_handler = pooling(raw_request)
        if fallback_handler is None:
            return base(raw_request).create_error_response(
                message="The model does not support Embeddings API")

        logger.warning(
            "Embeddings API will become exclusive to embedding models "
            "in a future release. To return the hidden states directly, "
            "use the Pooling API (`/pooling`) instead.")

        res = await fallback_handler.create_pooling(request, raw_request)
        if isinstance(res, PoolingResponse):
            generator = EmbeddingResponse(
                id=res.id,
                object=res.object,
                created=res.created,
                model=res.model,
                data=[
                    EmbeddingResponseData(
                        index=d.index,
                        embedding=d.data,  # type: ignore
                    ) for d in res.data
                ],
                usage=res.usage,
            )
        else:
            generator = res
    else:
        generator = await handler.create_embedding(request, raw_request)
440

441
442
443
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
444
    elif isinstance(generator, EmbeddingResponse):
445
446
        return JSONResponse(content=generator.model_dump())

447
448
    assert_never(generator)

449

450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
@router.post("/pooling")
@with_cancellation
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)


468
@router.post("/score")
469
@with_cancellation
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
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)


486
@router.post("/v1/score")
487
@with_cancellation
488
489
490
491
492
493
494
495
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)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
TASK_HANDLERS = {
    "generate": {
        "messages": (ChatCompletionRequest, create_chat_completion),
        "default": (CompletionRequest, create_completion),
    },
    "embed": {
        "messages": (EmbeddingChatRequest, create_embedding),
        "default": (EmbeddingCompletionRequest, create_embedding),
    },
    "score": {
        "default": (ScoreRequest, create_score),
    },
    "reward": {
        "messages": (PoolingChatRequest, create_pooling),
        "default": (PoolingCompletionRequest, create_pooling),
    },
    "classify": {
        "messages": (PoolingChatRequest, create_pooling),
        "default": (PoolingCompletionRequest, create_pooling),
    },
}


@router.post("/invocations")
async def invocations(raw_request: Request):
    """
    For SageMaker, routes requests to other handlers based on model `task`.
    """
    body = await raw_request.json()
    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)


544
545
546
547
548
549
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")
550
    async def start_profile(raw_request: Request):
551
        logger.info("Starting profiler...")
552
        await engine_client(raw_request).start_profile()
553
554
555
556
        logger.info("Profiler started.")
        return Response(status_code=200)

    @router.post("/stop_profile")
557
    async def stop_profile(raw_request: Request):
558
        logger.info("Stopping profiler...")
559
        await engine_client(raw_request).stop_profile()
560
561
562
563
        logger.info("Profiler stopped.")
        return Response(status_code=200)


564
565
566
567
568
569
if envs.VLLM_ALLOW_RUNTIME_LORA_UPDATING:
    logger.warning(
        "Lora dynamic loading & unloading is enabled in the API server. "
        "This should ONLY be used for local development!")

    @router.post("/v1/load_lora_adapter")
570
571
    async def load_lora_adapter(request: LoadLoraAdapterRequest,
                                raw_request: Request):
572
573
574
575
576
        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)
577
578
579
580

        return Response(status_code=200, content=response)

    @router.post("/v1/unload_lora_adapter")
581
582
    async def unload_lora_adapter(request: UnloadLoraAdapterRequest,
                                  raw_request: Request):
583
584
585
586
587
        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)
588
589
590
591

        return Response(status_code=200, content=response)


592
def build_app(args: Namespace) -> FastAPI:
593
594
595
596
597
598
599
    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
600
601
    app.include_router(router)
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
602

603
604
    mount_metrics(app)

Zhuohan Li's avatar
Zhuohan Li committed
605
606
607
608
609
610
611
612
    app.add_middleware(
        CORSMiddleware,
        allow_origins=args.allowed_origins,
        allow_credentials=args.allow_credentials,
        allow_methods=args.allowed_methods,
        allow_headers=args.allowed_headers,
    )

Ethan Xu's avatar
Ethan Xu committed
613
614
    @app.exception_handler(RequestValidationError)
    async def validation_exception_handler(_, exc):
615
616
617
        err = ErrorResponse(message=str(exc),
                            type="BadRequestError",
                            code=HTTPStatus.BAD_REQUEST)
Ethan Xu's avatar
Ethan Xu committed
618
619
620
        return JSONResponse(err.model_dump(),
                            status_code=HTTPStatus.BAD_REQUEST)

621
    if token := envs.VLLM_API_KEY or args.api_key:
622
623
624

        @app.middleware("http")
        async def authentication(request: Request, call_next):
625
626
            if request.method == "OPTIONS":
                return await call_next(request)
627
628
629
630
            url_path = request.url.path
            if app.root_path and url_path.startswith(app.root_path):
                url_path = url_path[len(app.root_path):]
            if not url_path.startswith("/v1"):
631
632
633
634
635
636
                return await call_next(request)
            if request.headers.get("Authorization") != "Bearer " + token:
                return JSONResponse(content={"error": "Unauthorized"},
                                    status_code=401)
            return await call_next(request)

637
638
639
640
641
642
643
644
645
646
647
648
    if args.enable_request_id_headers:
        logger.warning(
            "CAUTION: Enabling X-Request-Id headers in the API Server. "
            "This can harm performance at high QPS.")

        @app.middleware("http")
        async def add_request_id(request: Request, call_next):
            request_id = request.headers.get(
                "X-Request-Id") or uuid.uuid4().hex
            response = await call_next(request)
            response.headers["X-Request-Id"] = request_id
            return response
649

650
651
652
653
654
655
656
657
    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):
            app.add_middleware(imported)
        elif inspect.iscoroutinefunction(imported):
            app.middleware("http")(imported)
        else:
658
659
            raise ValueError(f"Invalid middleware {middleware}. "
                             f"Must be a function or a class.")
660

Ethan Xu's avatar
Ethan Xu committed
661
662
663
    return app


664
def init_app_state(
665
    engine_client: EngineClient,
666
667
    model_config: ModelConfig,
    state: State,
668
    args: Namespace,
669
) -> None:
670
    if args.served_model_name is not None:
671
        served_model_names = args.served_model_name
672
    else:
673
        served_model_names = [args.model]
674

675
676
677
678
679
    if args.disable_log_requests:
        request_logger = None
    else:
        request_logger = RequestLogger(max_log_len=args.max_log_len)

680
681
682
683
684
    base_model_paths = [
        BaseModelPath(name=name, model_path=args.model)
        for name in served_model_names
    ]

685
    state.engine_client = engine_client
686
    state.log_stats = not args.disable_log_stats
Ethan Xu's avatar
Ethan Xu committed
687

688
689
690
    resolved_chat_template = load_chat_template(args.chat_template)
    logger.info("Using supplied chat template:\n%s", resolved_chat_template)

691
692
693
694
695
696
697
    state.openai_serving_models = OpenAIServingModels(
        model_config=model_config,
        base_model_paths=base_model_paths,
        lora_modules=args.lora_modules,
        prompt_adapters=args.prompt_adapters,
    )
    # TODO: The chat template is now broken for lora adapters :(
698
    state.openai_serving_chat = OpenAIServingChat(
699
        engine_client,
700
        model_config,
701
        state.openai_serving_models,
702
703
        args.response_role,
        request_logger=request_logger,
704
705
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
706
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
707
        enable_auto_tools=args.enable_auto_tool_choice,
708
        tool_parser=args.tool_call_parser,
709
        enable_prompt_tokens_details=args.enable_prompt_tokens_details,
710
    ) if model_config.runner_type == "generate" else None
711
    state.openai_serving_completion = OpenAIServingCompletion(
712
        engine_client,
713
        model_config,
714
        state.openai_serving_models,
715
        request_logger=request_logger,
716
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
717
    ) if model_config.runner_type == "generate" else None
718
    state.openai_serving_pooling = OpenAIServingPooling(
719
        engine_client,
720
        model_config,
721
        state.openai_serving_models,
722
        request_logger=request_logger,
723
724
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
725
    ) if model_config.runner_type == "pooling" else None
726
727
728
    state.openai_serving_embedding = OpenAIServingEmbedding(
        engine_client,
        model_config,
729
        state.openai_serving_models,
730
731
732
733
        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
734
735
736
    state.openai_serving_scores = OpenAIServingScores(
        engine_client,
        model_config,
737
        state.openai_serving_models,
738
        request_logger=request_logger
739
    ) if model_config.task == "score" else None
740
    state.openai_serving_tokenization = OpenAIServingTokenization(
741
        engine_client,
742
        model_config,
743
        state.openai_serving_models,
744
        request_logger=request_logger,
745
746
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
747
    )
748
    state.task = model_config.task
749
750


751
752
753
754
755
756
757
758
759
760
761
762
def create_server_socket(addr: Tuple[str, int]) -> socket.socket:
    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)
    sock.bind(addr)

    return sock


763
async def run_server(args, **uvicorn_kwargs) -> None:
764
765
766
    logger.info("vLLM API server version %s", VLLM_VERSION)
    logger.info("args: %s", args)

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

770
    valid_tool_parses = ToolParserManager.tool_parsers.keys()
771
    if args.enable_auto_tool_choice \
772
        and args.tool_call_parser not in valid_tool_parses:
773
        raise KeyError(f"invalid tool call parser: {args.tool_call_parser} "
774
                       f"(chose from {{ {','.join(valid_tool_parses)} }})")
775

776
777
778
    # 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
779
780
    sock_addr = (args.host or "", args.port)
    sock = create_server_socket(sock_addr)
781

782
783
784
785
    # workaround to avoid footguns where uvicorn drops requests with too
    # many concurrent requests active
    set_ulimit()

786
787
788
789
790
791
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

792
    async with build_async_engine_client(args) as engine_client:
793
794
        app = build_app(args)

795
796
        model_config = await engine_client.get_model_config()
        init_app_state(engine_client, model_config, app.state, args)
797
798
799
800
801
802
803
804
805
806
807

        shutdown_task = await serve_http(
            app,
            host=args.host,
            port=args.port,
            log_level=args.uvicorn_log_level,
            timeout_keep_alive=TIMEOUT_KEEP_ALIVE,
            ssl_keyfile=args.ssl_keyfile,
            ssl_certfile=args.ssl_certfile,
            ssl_ca_certs=args.ssl_ca_certs,
            ssl_cert_reqs=args.ssl_cert_reqs,
808
809
810
            **uvicorn_kwargs,
        )

811
812
    # NB: Await server shutdown only after the backend context is exited
    await shutdown_task
813

814
815
    sock.close()

Ethan Xu's avatar
Ethan Xu committed
816
817
818
819
820
821
822
823

if __name__ == "__main__":
    # NOTE(simon):
    # This section should be in sync with vllm/scripts.py for CLI entrypoints.
    parser = FlexibleArgumentParser(
        description="vLLM OpenAI-Compatible RESTful API server.")
    parser = make_arg_parser(parser)
    args = parser.parse_args()
824
    validate_parsed_serve_args(args)
825

826
    uvloop.run(run_server(args))