api_server.py 30.9 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
import asyncio
4
import hashlib
5
6
import importlib
import inspect
7
import json
8
import multiprocessing
9
import multiprocessing.forkserver as forkserver
10
import os
11
import secrets
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 http import HTTPStatus
20
from typing import Any
21

22
import model_hosting_container_standards.sagemaker as sagemaker_standards
23
import pydantic
24
import uvloop
25
from fastapi import APIRouter, FastAPI, HTTPException, Request
Zhuohan Li's avatar
Zhuohan Li committed
26
27
from fastapi.exceptions import RequestValidationError
from fastapi.middleware.cors import CORSMiddleware
28
from fastapi.responses import JSONResponse
29
from starlette.concurrency import iterate_in_threadpool
30
31
from starlette.datastructures import URL, Headers, MutableHeaders, State
from starlette.types import ASGIApp, Message, Receive, Scope, Send
Zhuohan Li's avatar
Zhuohan Li committed
32

33
import vllm.envs as envs
Woosuk Kwon's avatar
Woosuk Kwon committed
34
from vllm.engine.arg_utils import AsyncEngineArgs
35
from vllm.engine.protocol import EngineClient
36
from vllm.entrypoints.chat_utils import load_chat_template
37
from vllm.entrypoints.launcher import serve_http
38
from vllm.entrypoints.logger import RequestLogger
39
from vllm.entrypoints.openai.cli_args import make_arg_parser, validate_parsed_serve_args
40
from vllm.entrypoints.openai.engine.protocol import (
41
42
43
    ErrorInfo,
    ErrorResponse,
)
44
from vllm.entrypoints.openai.engine.serving import OpenAIServing
45
46
from vllm.entrypoints.openai.models.protocol import BaseModelPath
from vllm.entrypoints.openai.models.serving import (
47
48
    OpenAIServingModels,
)
49
50
51
52
from vllm.entrypoints.serve.elastic_ep.middleware import (
    ScalingMiddleware,
)
from vllm.entrypoints.serve.tokenize.serving import OpenAIServingTokenization
53
54
55
from vllm.entrypoints.utils import (
    cli_env_setup,
    log_non_default_args,
56
    log_version_and_model,
57
    process_lora_modules,
58
    sanitize_message,
59
)
60
from vllm.exceptions import VLLMValidationError
61
from vllm.logger import init_logger
62
from vllm.reasoning import ReasoningParserManager
63
from vllm.tasks import POOLING_TASKS, SupportedTask
64
from vllm.tool_parsers import ToolParserManager
yhu422's avatar
yhu422 committed
65
from vllm.usage.usage_lib import UsageContext
Cyrus Leung's avatar
Cyrus Leung committed
66
from vllm.utils.argparse_utils import FlexibleArgumentParser
67
from vllm.utils.gc_utils import freeze_gc_heap
68
from vllm.utils.network_utils import is_valid_ipv6_address
69
from vllm.utils.system_utils import decorate_logs, set_ulimit
70
from vllm.version import __version__ as VLLM_VERSION
Zhuohan Li's avatar
Zhuohan Li committed
71

72
prometheus_multiproc_dir: tempfile.TemporaryDirectory
73

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

77

78
_running_tasks: set[asyncio.Task] = set()
79

80

81
@asynccontextmanager
82
async def lifespan(app: FastAPI):
83
84
    try:
        if app.state.log_stats:
85
            engine_client: EngineClient = app.state.engine_client
86
87
88

            async def _force_log():
                while True:
89
                    await asyncio.sleep(envs.VLLM_LOG_STATS_INTERVAL)
90
                    await engine_client.do_log_stats()
91
92
93
94
95
96

            task = asyncio.create_task(_force_log())
            _running_tasks.add(task)
            task.add_done_callback(_running_tasks.remove)
        else:
            task = None
97
98
99

        # Mark the startup heap as static so that it's ignored by GC.
        # Reduces pause times of oldest generation collections.
100
        freeze_gc_heap()
101
102
103
104
105
106
107
108
        try:
            yield
        finally:
            if task is not None:
                task.cancel()
    finally:
        # Ensure app state including engine ref is gc'd
        del app.state
109
110


111
@asynccontextmanager
112
async def build_async_engine_client(
113
    args: Namespace,
114
115
    *,
    usage_context: UsageContext = UsageContext.OPENAI_API_SERVER,
116
117
    disable_frontend_multiprocessing: bool | None = None,
    client_config: dict[str, Any] | None = None,
118
) -> AsyncIterator[EngineClient]:
119
120
121
122
    if os.getenv("VLLM_WORKER_MULTIPROC_METHOD") == "forkserver":
        # The executor is expected to be mp.
        # Pre-import heavy modules in the forkserver process
        logger.debug("Setup forkserver with pre-imports")
123
        multiprocessing.set_start_method("forkserver")
124
125
126
127
        multiprocessing.set_forkserver_preload(["vllm.v1.engine.async_llm"])
        forkserver.ensure_running()
        logger.debug("Forkserver setup complete!")

128
    # Context manager to handle engine_client lifecycle
129
130
    # Ensures everything is shutdown and cleaned up on error/exit
    engine_args = AsyncEngineArgs.from_cli_args(args)
131
132
133
    if client_config:
        engine_args._api_process_count = client_config.get("client_count", 1)
        engine_args._api_process_rank = client_config.get("client_index", 0)
134

135
    if disable_frontend_multiprocessing is None:
136
        disable_frontend_multiprocessing = bool(args.disable_frontend_multiprocessing)
137

138
    async with build_async_engine_client_from_engine_args(
139
140
141
142
        engine_args,
        usage_context=usage_context,
        disable_frontend_multiprocessing=disable_frontend_multiprocessing,
        client_config=client_config,
143
    ) as engine:
144
145
146
147
148
149
        yield engine


@asynccontextmanager
async def build_async_engine_client_from_engine_args(
    engine_args: AsyncEngineArgs,
150
151
    *,
    usage_context: UsageContext = UsageContext.OPENAI_API_SERVER,
152
    disable_frontend_multiprocessing: bool = False,
153
    client_config: dict[str, Any] | None = None,
154
) -> AsyncIterator[EngineClient]:
155
    """
156
    Create EngineClient, either:
157
158
159
160
161
162
        - in-process using the AsyncLLMEngine Directly
        - multiprocess using AsyncLLMEngine RPC

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

163
164
165
    # Create the EngineConfig (determines if we can use V1).
    vllm_config = engine_args.create_engine_config(usage_context=usage_context)

166
    if disable_frontend_multiprocessing:
167
        logger.warning("V1 is enabled, but got --disable-frontend-multiprocessing.")
168

169
    from vllm.v1.engine.async_llm import AsyncLLM
170

171
    async_llm: AsyncLLM | None = None
172
173
174
175
176
177

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

178
179
180
181
182
    try:
        async_llm = AsyncLLM.from_vllm_config(
            vllm_config=vllm_config,
            usage_context=usage_context,
            enable_log_requests=engine_args.enable_log_requests,
183
            aggregate_engine_logging=engine_args.aggregate_engine_logging,
184
185
186
            disable_log_stats=engine_args.disable_log_stats,
            client_addresses=client_config,
            client_count=client_count,
187
188
            client_index=client_index,
        )
189
190

        # Don't keep the dummy data in memory
191
        assert async_llm is not None
192
193
194
195
196
197
        await async_llm.reset_mm_cache()

        yield async_llm
    finally:
        if async_llm:
            async_llm.shutdown()
198
199


Ethan Xu's avatar
Ethan Xu committed
200
router = APIRouter()
Zhuohan Li's avatar
Zhuohan Li committed
201

202

203
204
205
206
207
208
209
def base(request: Request) -> OpenAIServing:
    # Reuse the existing instance
    return tokenization(request)


def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
210
211


212
def engine_client(request: Request) -> EngineClient:
213
214
215
    return request.app.state.engine_client


216
217
218
219
@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:
220
221
222
223
    # - /v1/responses
    # - /v1/responses/{response_id}
    # - /v1/responses/{response_id}/cancel
    # - /v1/messages
224
225
226
    # - /v1/chat/completions
    # - /v1/completions
    # - /v1/audio/transcriptions
227
    # - /v1/audio/translations
228
229
    # - /v1/embeddings
    # - /pooling
230
    # - /classify
231
232
233
234
235
    # - /score
    # - /v1/score
    # - /rerank
    # - /v1/rerank
    # - /v2/rerank
236
    return JSONResponse(content={"server_load": request.app.state.server_load_metrics})
237
238


Ethan Xu's avatar
Ethan Xu committed
239
@router.get("/version")
240
async def show_version():
241
    ver = {"version": VLLM_VERSION}
242
243
244
    return JSONResponse(content=ver)


245
def load_log_config(log_config_file: str | None) -> dict | None:
246
247
248
249
250
251
    if not log_config_file:
        return None
    try:
        with open(log_config_file) as f:
            return json.load(f)
    except Exception as e:
252
253
254
        logger.warning(
            "Failed to load log config from file %s: error %s", log_config_file, e
        )
255
256
257
        return None


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
def get_uvicorn_log_config(args: Namespace) -> dict | None:
    """
    Get the uvicorn log config based on the provided arguments.

    Priority:
    1. If log_config_file is specified, use it
    2. If disable_access_log_for_endpoints is specified, create a config with
       the access log filter
    3. Otherwise, return None (use uvicorn defaults)
    """
    # First, try to load from file if specified
    log_config = load_log_config(args.log_config_file)
    if log_config is not None:
        return log_config

    # If endpoints to filter are specified, create a config with the filter
    if args.disable_access_log_for_endpoints:
        from vllm.logging_utils import create_uvicorn_log_config

        # Parse comma-separated string into list
        excluded_paths = [
            p.strip()
            for p in args.disable_access_log_for_endpoints.split(",")
            if p.strip()
        ]
        return create_uvicorn_log_config(
            excluded_paths=excluded_paths,
            log_level=args.uvicorn_log_level,
        )

    return None


291
292
293
class AuthenticationMiddleware:
    """
    Pure ASGI middleware that authenticates each request by checking
294
    if the Authorization Bearer token exists and equals anyof "{api_key}".
295
296
297
298
299
300
301
302

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

303
    def __init__(self, app: ASGIApp, tokens: list[str]) -> None:
304
        self.app = app
305
        self.api_tokens = [hashlib.sha256(t.encode("utf-8")).digest() for t in tokens]
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322

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

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

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

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

        return token_match
323

324
325
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
        if scope["type"] not in ("http", "websocket") or scope["method"] == "OPTIONS":
326
327
328
329
330
331
332
            # 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.
333
        if url_path.startswith("/v1") and not self.verify_token(headers):
334
            response = JSONResponse(content={"error": "Unauthorized"}, status_code=401)
335
336
337
338
339
340
341
342
343
344
345
346
347
348
            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

349
    def __call__(self, scope: Scope, receive: Receive, send: Send) -> Awaitable[None]:
350
351
352
353
354
355
356
357
358
359
360
361
362
        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"])
363
                request_id = request_headers.get("X-Request-Id", uuid.uuid4().hex)
364
365
366
367
368
369
                response_headers.append("X-Request-Id", request_id)
            await send(message)

        return self.app(scope, receive, send_with_request_id)


370
371
372
def _extract_content_from_chunk(chunk_data: dict) -> str:
    """Extract content from a streaming response chunk."""
    try:
373
        from vllm.entrypoints.openai.chat_completion.protocol import (
374
            ChatCompletionStreamResponse,
375
        )
376
        from vllm.entrypoints.openai.completion.protocol import (
377
378
            CompletionStreamResponse,
        )
379
380

        # Try using Completion types for type-safe parsing
381
382
        if chunk_data.get("object") == "chat.completion.chunk":
            chat_response = ChatCompletionStreamResponse.model_validate(chunk_data)
383
384
            if chat_response.choices and chat_response.choices[0].delta.content:
                return chat_response.choices[0].delta.content
385
386
387
        elif chunk_data.get("object") == "text_completion":
            completion_response = CompletionStreamResponse.model_validate(chunk_data)
            if completion_response.choices and completion_response.choices[0].text:
388
389
390
                return completion_response.choices[0].text
    except pydantic.ValidationError:
        # Fallback to manual parsing
391
392
393
394
395
396
        if "choices" in chunk_data and chunk_data["choices"]:
            choice = chunk_data["choices"][0]
            if "delta" in choice and choice["delta"].get("content"):
                return choice["delta"]["content"]
            elif choice.get("text"):
                return choice["text"]
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
    return ""


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

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

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

        try:
412
            chunk_str = chunk.decode("utf-8")
413
414
415
416
417
418
419
420
        except UnicodeDecodeError:
            # Skip malformed chunks
            return []

        self.buffer += chunk_str
        events = []

        # Process complete lines
421
422
423
        while "\n" in self.buffer:
            line, self.buffer = self.buffer.split("\n", 1)
            line = line.rstrip("\r")  # Handle CRLF
424

425
            if line.startswith("data: "):
426
                data_str = line[6:].strip()
427
428
                if data_str == "[DONE]":
                    events.append({"type": "done"})
429
430
431
                elif data_str:
                    try:
                        event_data = json.loads(data_str)
432
                        events.append({"type": "data", "data": event_data})
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
                    except json.JSONDecodeError:
                        # Skip malformed JSON
                        continue

        return events

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

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

    def get_complete_content(self) -> str:
        """Get the complete buffered content."""
450
        return "".join(self.content_buffer)
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470


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

    sse_decoder = SSEDecoder()
    chunk_count = 0

    def buffered_iterator():
        nonlocal chunk_count

        for chunk in response_body:
            chunk_count += 1
            yield chunk

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

            for event in events:
471
472
                if event["type"] == "data":
                    content = sse_decoder.extract_content(event["data"])
473
                    sse_decoder.add_content(content)
474
                elif event["type"] == "done":
475
476
477
478
479
480
481
482
                    # Log complete content when done
                    full_content = sse_decoder.get_complete_content()
                    if full_content:
                        # Truncate if too long
                        if len(full_content) > 2048:
                            full_content = full_content[:2048] + ""
                            "...[truncated]"
                        logger.info(
483
                            "response_body={streaming_complete: content=%r, chunks=%d}",
484
485
486
                            full_content,
                            chunk_count,
                        )
487
488
                    else:
                        logger.info(
489
490
491
                            "response_body={streaming_complete: no_content, chunks=%d}",
                            chunk_count,
                        )
492
493
494
                    return

    response.body_iterator = iterate_in_threadpool(buffered_iterator())
495
    logger.info("response_body={streaming_started: chunks=%d}", len(response_body))
496
497
498
499
500
501
502
503
504
505
506


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


507
def build_app(args: Namespace, supported_tasks: tuple["SupportedTask", ...]) -> FastAPI:
508
    if args.disable_fastapi_docs:
509
510
511
        app = FastAPI(
            openapi_url=None, docs_url=None, redoc_url=None, lifespan=lifespan
        )
512
513
    elif args.enable_offline_docs:
        app = FastAPI(docs_url=None, redoc_url=None, lifespan=lifespan)
514
515
    else:
        app = FastAPI(lifespan=lifespan)
516
    app.state.args = args
517
518
    app.include_router(router)

519
    from vllm.entrypoints.serve import register_vllm_serve_api_routers
520

521
    register_vllm_serve_api_routers(app)
522

523
524
    from vllm.entrypoints.openai.models.api_router import (
        attach_router as register_models_api_router,
525
526
    )

527
    register_models_api_router(app)
528

529
530
    from vllm.entrypoints.sagemaker.api_router import (
        attach_router as register_sagemaker_api_router,
531
532
    )

533
    register_sagemaker_api_router(app, supported_tasks)
534

535
536
537
538
    if "generate" in supported_tasks:
        from vllm.entrypoints.openai.generate.api_router import (
            register_generate_api_routers,
        )
539

540
        register_generate_api_routers(app)
541

542
543
544
545
    if "transcription" in supported_tasks:
        from vllm.entrypoints.openai.translations.api_router import (
            attach_router as register_translations_api_router,
        )
546

547
        register_translations_api_router(app)
Zhuohan Li's avatar
Zhuohan Li committed
548

549
550
    if any(task in POOLING_TASKS for task in supported_tasks):
        from vllm.entrypoints.pooling import register_pooling_api_routers
551

552
        register_pooling_api_routers(app, supported_tasks)
553

554
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
555
556
557
558
559
560
561
562
    app.add_middleware(
        CORSMiddleware,
        allow_origins=args.allowed_origins,
        allow_credentials=args.allow_credentials,
        allow_methods=args.allowed_methods,
        allow_headers=args.allowed_headers,
    )

563
564
    @app.exception_handler(HTTPException)
    async def http_exception_handler(_: Request, exc: HTTPException):
565
        err = ErrorResponse(
566
            error=ErrorInfo(
567
                message=sanitize_message(exc.detail),
568
569
570
571
                type=HTTPStatus(exc.status_code).phrase,
                code=exc.status_code,
            )
        )
572
573
        return JSONResponse(err.model_dump(), status_code=exc.status_code)

Ethan Xu's avatar
Ethan Xu committed
574
    @app.exception_handler(RequestValidationError)
575
    async def validation_exception_handler(_: Request, exc: RequestValidationError):
576
        param = None
577
578
        errors = exc.errors()
        for error in errors:
579
580
581
582
583
584
            if "ctx" in error and "error" in error["ctx"]:
                ctx_error = error["ctx"]["error"]
                if isinstance(ctx_error, VLLMValidationError):
                    param = ctx_error.parameter
                    break

585
        exc_str = str(exc)
586
        errors_str = str(errors)
587

588
        if errors and errors_str and errors_str != exc_str:
589
590
591
592
            message = f"{exc_str} {errors_str}"
        else:
            message = exc_str

593
594
        err = ErrorResponse(
            error=ErrorInfo(
595
                message=sanitize_message(message),
596
597
                type=HTTPStatus.BAD_REQUEST.phrase,
                code=HTTPStatus.BAD_REQUEST,
598
                param=param,
599
600
601
            )
        )
        return JSONResponse(err.model_dump(), status_code=HTTPStatus.BAD_REQUEST)
Ethan Xu's avatar
Ethan Xu committed
602

603
    # Ensure --api-key option from CLI takes precedence over VLLM_API_KEY
604
605
    if tokens := [key for key in (args.api_key or [envs.VLLM_API_KEY]) if key]:
        app.add_middleware(AuthenticationMiddleware, tokens=tokens)
606

607
    if args.enable_request_id_headers:
608
        app.add_middleware(XRequestIdMiddleware)
609

610
611
612
    # Add scaling middleware to check for scaling state
    app.add_middleware(ScalingMiddleware)

613
    if envs.VLLM_DEBUG_LOG_API_SERVER_RESPONSE:
614
615
616
617
618
        logger.warning(
            "CAUTION: Enabling log response in the API Server. "
            "This can include sensitive information and should be "
            "avoided in production."
        )
619
620
621
622

        @app.middleware("http")
        async def log_response(request: Request, call_next):
            response = await call_next(request)
623
            response_body = [section async for section in response.body_iterator]
624
            response.body_iterator = iterate_in_threadpool(iter(response_body))
625
626
627
628
629
630
631
632
633
634
635
            # Check if this is a streaming response by looking at content-type
            content_type = response.headers.get("content-type", "")
            is_streaming = content_type == "text/event-stream; charset=utf-8"

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

638
639
640
641
    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):
642
            app.add_middleware(imported)  # type: ignore[arg-type]
643
644
645
        elif inspect.iscoroutinefunction(imported):
            app.middleware("http")(imported)
        else:
646
647
648
            raise ValueError(
                f"Invalid middleware {middleware}. Must be a function or a class."
            )
649

650
651
    app = sagemaker_standards.bootstrap(app)

Ethan Xu's avatar
Ethan Xu committed
652
653
654
    return app


655
async def init_app_state(
656
    engine_client: EngineClient,
657
    state: State,
658
    args: Namespace,
659
    supported_tasks: tuple["SupportedTask", ...],
660
) -> None:
661
662
    vllm_config = engine_client.vllm_config

663
    if args.served_model_name is not None:
664
        served_model_names = args.served_model_name
665
    else:
666
        served_model_names = [args.model]
667

668
    if args.enable_log_requests:
669
        request_logger = RequestLogger(max_log_len=args.max_log_len)
670
671
    else:
        request_logger = None
672

673
    base_model_paths = [
674
        BaseModelPath(name=name, model_path=args.model) for name in served_model_names
675
676
    ]

677
    state.engine_client = engine_client
678
    state.log_stats = not args.disable_log_stats
679
    state.vllm_config = vllm_config
680
    state.args = args
681
    resolved_chat_template = load_chat_template(args.chat_template)
682

683
    # Merge default_mm_loras into the static lora_modules
684
685
686
687
688
689
    default_mm_loras = (
        vllm_config.lora_config.default_mm_loras
        if vllm_config.lora_config is not None
        else {}
    )
    lora_modules = process_lora_modules(args.lora_modules, default_mm_loras)
690

691
    state.openai_serving_models = OpenAIServingModels(
692
        engine_client=engine_client,
693
        base_model_paths=base_model_paths,
694
        lora_modules=lora_modules,
695
    )
696
    await state.openai_serving_models.init_static_loras()
697
    state.openai_serving_tokenization = OpenAIServingTokenization(
698
        engine_client,
699
        state.openai_serving_models,
700
        request_logger=request_logger,
701
702
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
703
        trust_request_chat_template=args.trust_request_chat_template,
704
        log_error_stack=args.log_error_stack,
705
    )
706
707
708
709
710
711

    if "generate" in supported_tasks:
        from vllm.entrypoints.openai.generate.api_router import init_generate_state

        await init_generate_state(
            engine_client, state, args, request_logger, supported_tasks
712
        )
713
714
715
716

    if "transcription" in supported_tasks:
        from vllm.entrypoints.openai.translations.api_router import (
            init_transcription_state,
717
        )
718
719
720

        init_transcription_state(
            engine_client, state, args, request_logger, supported_tasks
721
        )
722

723
724
    if any(task in POOLING_TASKS for task in supported_tasks):
        from vllm.entrypoints.pooling import init_pooling_state
725

726
        init_pooling_state(engine_client, state, args, request_logger, supported_tasks)
727

728
729
730
    state.enable_server_load_tracking = args.enable_server_load_tracking
    state.server_load_metrics = 0

731

732
def create_server_socket(addr: tuple[str, int]) -> socket.socket:
733
734
735
736
737
738
    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)
739
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
740
741
742
743
744
    sock.bind(addr)

    return sock


745
746
747
748
749
750
def create_server_unix_socket(path: str) -> socket.socket:
    sock = socket.socket(family=socket.AF_UNIX, type=socket.SOCK_STREAM)
    sock.bind(path)
    return sock


751
def validate_api_server_args(args):
752
    valid_tool_parses = ToolParserManager.list_registered()
753
754
755
756
757
    if args.enable_auto_tool_choice and args.tool_call_parser not in valid_tool_parses:
        raise KeyError(
            f"invalid tool call parser: {args.tool_call_parser} "
            f"(chose from {{ {','.join(valid_tool_parses)} }})"
        )
758

759
    valid_reasoning_parsers = ReasoningParserManager.list_registered()
760
761
    if (
        reasoning_parser := args.structured_outputs_config.reasoning_parser
762
    ) and reasoning_parser not in valid_reasoning_parsers:
763
        raise KeyError(
764
            f"invalid reasoning parser: {reasoning_parser} "
765
            f"(chose from {{ {','.join(valid_reasoning_parsers)} }})"
766
        )
767

768
769
770
771
772

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

773
    log_version_and_model(logger, VLLM_VERSION, args.model)
774
775
776
777
778
    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)

779
780
781
    if args.reasoning_parser_plugin and len(args.reasoning_parser_plugin) > 3:
        ReasoningParserManager.import_reasoning_parser(args.reasoning_parser_plugin)

782
783
    validate_api_server_args(args)

784
785
786
    # 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
787
788
789
790
791
    if args.uds:
        sock = create_server_unix_socket(args.uds)
    else:
        sock_addr = (args.host or "", args.port)
        sock = create_server_socket(sock_addr)
792

793
794
795
796
    # workaround to avoid footguns where uvicorn drops requests with too
    # many concurrent requests active
    set_ulimit()

797
798
799
800
801
802
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

803
804
805
806
807
    if args.uds:
        listen_address = f"unix:{args.uds}"
    else:
        addr, port = sock_addr
        is_ssl = args.ssl_keyfile and args.ssl_certfile
808
        host_part = f"[{addr}]" if is_valid_ipv6_address(addr) else addr or "0.0.0.0"
809
        listen_address = f"http{'s' if is_ssl else ''}://{host_part}:{port}"
810
811
812
813
814
    return listen_address, sock


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

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

819
820
821
822
    listen_address, sock = setup_server(args)
    await run_server_worker(listen_address, sock, args, **uvicorn_kwargs)


823
824
825
async def run_server_worker(
    listen_address, sock, args, client_config=None, **uvicorn_kwargs
) -> None:
826
827
828
829
830
    """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)

831
832
833
    if args.reasoning_parser_plugin and len(args.reasoning_parser_plugin) > 3:
        ReasoningParserManager.import_reasoning_parser(args.reasoning_parser_plugin)

834
835
    # Get uvicorn log config (from file or with endpoint filter)
    log_config = get_uvicorn_log_config(args)
836
    if log_config is not None:
837
        uvicorn_kwargs["log_config"] = log_config
838

839
    async with build_async_engine_client(
840
841
        args,
        client_config=client_config,
842
    ) as engine_client:
843
844
        supported_tasks = await engine_client.get_supported_tasks()
        logger.info("Supported tasks: %s", supported_tasks)
845

846
847
        app = build_app(args, supported_tasks)
        await init_app_state(engine_client, app.state, args, supported_tasks)
848

849
850
        logger.info(
            "Starting vLLM API server %d on %s",
851
            engine_client.vllm_config.parallel_config._api_process_rank,
852
853
            listen_address,
        )
854
855
        shutdown_task = await serve_http(
            app,
856
            sock=sock,
857
            enable_ssl_refresh=args.enable_ssl_refresh,
858
859
860
            host=args.host,
            port=args.port,
            log_level=args.uvicorn_log_level,
861
862
863
            # NOTE: When the 'disable_uvicorn_access_log' value is True,
            # no access log will be output.
            access_log=not args.disable_uvicorn_access_log,
864
            timeout_keep_alive=envs.VLLM_HTTP_TIMEOUT_KEEP_ALIVE,
865
866
867
868
            ssl_keyfile=args.ssl_keyfile,
            ssl_certfile=args.ssl_certfile,
            ssl_ca_certs=args.ssl_ca_certs,
            ssl_cert_reqs=args.ssl_cert_reqs,
869
            ssl_ciphers=args.ssl_ciphers,
870
871
            h11_max_incomplete_event_size=args.h11_max_incomplete_event_size,
            h11_max_header_count=args.h11_max_header_count,
872
873
874
            **uvicorn_kwargs,
        )

875
    # NB: Await server shutdown only after the backend context is exited
876
877
878
879
    try:
        await shutdown_task
    finally:
        sock.close()
880

Ethan Xu's avatar
Ethan Xu committed
881
882
883

if __name__ == "__main__":
    # NOTE(simon):
884
885
    # This section should be in sync with vllm/entrypoints/cli/main.py for CLI
    # entrypoints.
886
    cli_env_setup()
Ethan Xu's avatar
Ethan Xu committed
887
    parser = FlexibleArgumentParser(
888
889
        description="vLLM OpenAI-Compatible RESTful API server."
    )
Ethan Xu's avatar
Ethan Xu committed
890
891
    parser = make_arg_parser(parser)
    args = parser.parse_args()
892
    validate_parsed_serve_args(args)
893

894
    uvloop.run(run_server(args))