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

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

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

67
68
69
70
71
if envs.VLLM_USE_V1:
    from vllm.v1.engine.async_llm import AsyncLLMEngine  # type: ignore
else:
    from vllm.engine.async_llm_engine import AsyncLLMEngine  # type: ignore

72
TIMEOUT_KEEP_ALIVE = 5  # seconds
Zhuohan Li's avatar
Zhuohan Li committed
73

74
prometheus_multiproc_dir: tempfile.TemporaryDirectory
75

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

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

81

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

            async def _force_log():
                while True:
90
91
                    await asyncio.sleep(10.)
                    await engine_client.do_log_stats()
92
93
94
95
96
97
98
99
100
101
102
103
104
105

            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
106
107


108
@asynccontextmanager
109
async def build_async_engine_client(
110
        args: Namespace) -> AsyncIterator[EngineClient]:
111

112
    # Context manager to handle engine_client lifecycle
113
114
115
    # Ensures everything is shutdown and cleaned up on error/exit
    engine_args = AsyncEngineArgs.from_cli_args(args)

116
117
118
119
120
121
122
123
124
    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,
125
) -> AsyncIterator[EngineClient]:
126
    """
127
    Create EngineClient, either:
128
129
130
131
132
133
        - in-process using the AsyncLLMEngine Directly
        - multiprocess using AsyncLLMEngine RPC

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

134
135
136
    # Fall back
    # TODO: fill out feature matrix.
    if (MQLLMEngineClient.is_unsupported_config(engine_args)
137
            or envs.VLLM_USE_V1 or disable_frontend_multiprocessing):
138
139
        engine_config = engine_args.create_engine_config(
            UsageContext.OPENAI_API_SERVER)
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
        uses_ray = getattr(AsyncLLMEngine._get_executor_cls(engine_config),
                           "uses_ray", False)

        build_engine = partial(AsyncLLMEngine.from_engine_args,
                               engine_args=engine_args,
                               engine_config=engine_config,
                               usage_context=UsageContext.OPENAI_API_SERVER)
        if uses_ray:
            # Must run in main thread with ray for its signal handlers to work
            engine_client = build_engine()
        else:
            engine_client = await asyncio.get_running_loop().run_in_executor(
                None, build_engine)

        yield engine_client
155
156
        if hasattr(engine_client, "shutdown"):
            engine_client.shutdown()
157
158
159
160
        return

    # Otherwise, use the multiprocessing AsyncLLMEngine.
    else:
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
        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.")

176
        # Select random path for IPC.
177
178
179
        ipc_path = get_open_zmq_ipc_path()
        logger.info("Multiprocessing frontend to use %s for IPC Path.",
                    ipc_path)
180

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

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

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

217
            yield mq_engine_client  # type: ignore[misc]
218
219
        finally:
            # Ensure rpc server process was terminated
220
            engine_process.terminate()
221
222

            # Close all open connections to the backend
223
            mq_engine_client.close()
224

225
226
227
228
229
            # 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()
230

231
232
233
234
235
            # 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
236
            multiprocess.mark_process_dead(engine_process.pid)
237

238

Ethan Xu's avatar
Ethan Xu committed
239
router = APIRouter()
Zhuohan Li's avatar
Zhuohan Li committed
240

241

242
def mount_metrics(app: FastAPI):
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
    # 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:
        logger.info("vLLM to use %s as PROMETHEUS_MULTIPROC_DIR",
                    prometheus_multiproc_dir_path)
        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())

263
    # Workaround for 307 Redirect for /metrics
264
    metrics_route.path_regex = re.compile("^/metrics(?P<path>.*)$")
265
    app.routes.append(metrics_route)
266
267


268
269
270
271
272
273
def base(request: Request) -> OpenAIServing:
    # Reuse the existing instance
    return tokenization(request)


def chat(request: Request) -> Optional[OpenAIServingChat]:
274
275
276
    return request.app.state.openai_serving_chat


277
def completion(request: Request) -> Optional[OpenAIServingCompletion]:
278
279
280
    return request.app.state.openai_serving_completion


281
282
def embedding(request: Request) -> Optional[OpenAIServingEmbedding]:
    return request.app.state.openai_serving_embedding
283
284


285
286
287
288
def score(request: Request) -> Optional[OpenAIServingScores]:
    return request.app.state.openai_serving_scores


289
290
def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
291
292


293
def engine_client(request: Request) -> EngineClient:
294
295
296
    return request.app.state.engine_client


Ethan Xu's avatar
Ethan Xu committed
297
@router.get("/health")
298
async def health(raw_request: Request) -> Response:
299
    """Health check."""
300
    await engine_client(raw_request).check_health()
301
302
303
    return Response(status_code=200)


Ethan Xu's avatar
Ethan Xu committed
304
@router.post("/tokenize")
305
async def tokenize(request: TokenizeRequest, raw_request: Request):
306
307
308
    handler = tokenization(raw_request)

    generator = await handler.create_tokenize(request)
309
310
311
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
312
    elif isinstance(generator, TokenizeResponse):
313
314
        return JSONResponse(content=generator.model_dump())

315
316
    assert_never(generator)

317

Ethan Xu's avatar
Ethan Xu committed
318
@router.post("/detokenize")
319
async def detokenize(request: DetokenizeRequest, raw_request: Request):
320
321
322
    handler = tokenization(raw_request)

    generator = await handler.create_detokenize(request)
323
324
325
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
326
    elif isinstance(generator, DetokenizeResponse):
327
328
        return JSONResponse(content=generator.model_dump())

329
330
    assert_never(generator)

331

Ethan Xu's avatar
Ethan Xu committed
332
@router.get("/v1/models")
333
async def show_available_models(raw_request: Request):
334
335
336
    handler = base(raw_request)

    models = await handler.show_available_models()
337
    return JSONResponse(content=models.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
338
339


Ethan Xu's avatar
Ethan Xu committed
340
@router.get("/version")
341
async def show_version():
342
    ver = {"version": VLLM_VERSION}
343
344
345
    return JSONResponse(content=ver)


Ethan Xu's avatar
Ethan Xu committed
346
@router.post("/v1/chat/completions")
347
348
async def create_chat_completion(request: ChatCompletionRequest,
                                 raw_request: Request):
349
350
351
352
    handler = chat(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Chat Completions API")
353

354
    generator = await handler.create_chat_completion(request, raw_request)
355

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

360
    elif isinstance(generator, ChatCompletionResponse):
361
        return JSONResponse(content=generator.model_dump())
362

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

365

Ethan Xu's avatar
Ethan Xu committed
366
@router.post("/v1/completions")
367
async def create_completion(request: CompletionRequest, raw_request: Request):
368
369
370
371
372
373
    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)
374
375
376
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
377
    elif isinstance(generator, CompletionResponse):
378
        return JSONResponse(content=generator.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
379

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

Zhuohan Li's avatar
Zhuohan Li committed
382

Ethan Xu's avatar
Ethan Xu committed
383
@router.post("/v1/embeddings")
384
async def create_embedding(request: EmbeddingRequest, raw_request: Request):
385
386
387
388
389
390
    handler = embedding(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Embeddings API")

    generator = await handler.create_embedding(request, raw_request)
391
392
393
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
394
    elif isinstance(generator, EmbeddingResponse):
395
396
        return JSONResponse(content=generator.model_dump())

397
398
    assert_never(generator)

399

400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
@router.post("/v1/score")
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)


417
418
419
420
421
422
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")
423
    async def start_profile(raw_request: Request):
424
        logger.info("Starting profiler...")
425
        await engine_client(raw_request).start_profile()
426
427
428
429
        logger.info("Profiler started.")
        return Response(status_code=200)

    @router.post("/stop_profile")
430
    async def stop_profile(raw_request: Request):
431
        logger.info("Stopping profiler...")
432
        await engine_client(raw_request).stop_profile()
433
434
435
436
        logger.info("Profiler stopped.")
        return Response(status_code=200)


437
438
439
440
441
442
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")
443
444
    async def load_lora_adapter(request: LoadLoraAdapterRequest,
                                raw_request: Request):
445
446
447
448
449
450
451
        for route in [chat, completion, embedding]:
            handler = route(raw_request)
            if handler is not None:
                response = await handler.load_lora_adapter(request)
                if isinstance(response, ErrorResponse):
                    return JSONResponse(content=response.model_dump(),
                                        status_code=response.code)
452
453
454
455

        return Response(status_code=200, content=response)

    @router.post("/v1/unload_lora_adapter")
456
457
    async def unload_lora_adapter(request: UnloadLoraAdapterRequest,
                                  raw_request: Request):
458
459
460
461
462
463
464
        for route in [chat, completion, embedding]:
            handler = route(raw_request)
            if handler is not None:
                response = await handler.unload_lora_adapter(request)
                if isinstance(response, ErrorResponse):
                    return JSONResponse(content=response.model_dump(),
                                        status_code=response.code)
465
466
467
468

        return Response(status_code=200, content=response)


469
def build_app(args: Namespace) -> FastAPI:
470
471
472
473
474
475
476
    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
477
478
    app.include_router(router)
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
479

480
481
    mount_metrics(app)

Zhuohan Li's avatar
Zhuohan Li committed
482
483
484
485
486
487
488
489
    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
490
491
    @app.exception_handler(RequestValidationError)
    async def validation_exception_handler(_, exc):
492
493
494
        err = ErrorResponse(message=str(exc),
                            type="BadRequestError",
                            code=HTTPStatus.BAD_REQUEST)
Ethan Xu's avatar
Ethan Xu committed
495
496
497
        return JSONResponse(err.model_dump(),
                            status_code=HTTPStatus.BAD_REQUEST)

498
    if token := envs.VLLM_API_KEY or args.api_key:
499
500
501

        @app.middleware("http")
        async def authentication(request: Request, call_next):
502
503
            if request.method == "OPTIONS":
                return await call_next(request)
504
505
506
507
            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"):
508
509
510
511
512
513
                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)

514
515
516
517
518
519
520
    @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

521
522
523
524
525
526
527
528
    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:
529
530
            raise ValueError(f"Invalid middleware {middleware}. "
                             f"Must be a function or a class.")
531

Ethan Xu's avatar
Ethan Xu committed
532
533
534
    return app


535
def init_app_state(
536
    engine_client: EngineClient,
537
538
    model_config: ModelConfig,
    state: State,
539
    args: Namespace,
540
) -> None:
541
    if args.served_model_name is not None:
542
        served_model_names = args.served_model_name
543
    else:
544
        served_model_names = [args.model]
545

546
547
548
549
550
    if args.disable_log_requests:
        request_logger = None
    else:
        request_logger = RequestLogger(max_log_len=args.max_log_len)

551
552
553
554
555
    base_model_paths = [
        BaseModelPath(name=name, model_path=args.model)
        for name in served_model_names
    ]

556
    state.engine_client = engine_client
557
    state.log_stats = not args.disable_log_stats
Ethan Xu's avatar
Ethan Xu committed
558

559
560
561
    resolved_chat_template = load_chat_template(args.chat_template)
    logger.info("Using supplied chat template:\n%s", resolved_chat_template)

562
    state.openai_serving_chat = OpenAIServingChat(
563
        engine_client,
564
        model_config,
565
        base_model_paths,
566
567
568
569
        args.response_role,
        lora_modules=args.lora_modules,
        prompt_adapters=args.prompt_adapters,
        request_logger=request_logger,
570
571
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
572
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
573
        enable_auto_tools=args.enable_auto_tool_choice,
574
        tool_parser=args.tool_call_parser,
575
        enable_prompt_tokens_details=args.enable_prompt_tokens_details,
576
    ) if model_config.task == "generate" else None
577
    state.openai_serving_completion = OpenAIServingCompletion(
578
        engine_client,
579
        model_config,
580
        base_model_paths,
581
582
583
        lora_modules=args.lora_modules,
        prompt_adapters=args.prompt_adapters,
        request_logger=request_logger,
584
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
585
    ) if model_config.task == "generate" else None
586
    state.openai_serving_embedding = OpenAIServingEmbedding(
587
        engine_client,
588
        model_config,
589
        base_model_paths,
590
        request_logger=request_logger,
591
592
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
593
    ) if model_config.task == "embedding" else None
594
595
596
597
598
599
600
    state.openai_serving_scores = OpenAIServingScores(
        engine_client,
        model_config,
        base_model_paths,
        request_logger=request_logger
    ) if (model_config.task == "embedding" \
          and model_config.is_cross_encoder) else None
601
    state.openai_serving_tokenization = OpenAIServingTokenization(
602
        engine_client,
603
        model_config,
604
        base_model_paths,
605
606
        lora_modules=args.lora_modules,
        request_logger=request_logger,
607
608
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
609
    )
610
611


612
613
614
615
616
617
618
619
620
621
622
623
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


624
async def run_server(args, **uvicorn_kwargs) -> None:
625
626
627
    logger.info("vLLM API server version %s", VLLM_VERSION)
    logger.info("args: %s", args)

628
629
630
631
632
633
634
635
636
    if args.tool_parser_plugin and len(args.tool_parser_plugin) > 3:
        ToolParserManager.import_tool_parser(args.tool_parser_plugin)

    valide_tool_parses = ToolParserManager.tool_parsers.keys()
    if args.enable_auto_tool_choice \
        and args.tool_call_parser not in valide_tool_parses:
        raise KeyError(f"invalid tool call parser: {args.tool_call_parser} "
                       f"(chose from {{ {','.join(valide_tool_parses)} }})")

637
638
639
    # 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
640
641
    sock_addr = (args.host or "", args.port)
    sock = create_server_socket(sock_addr)
642

643
644
645
646
647
648
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

649
    async with build_async_engine_client(args) as engine_client:
650
651
        app = build_app(args)

652
653
        model_config = await engine_client.get_model_config()
        init_app_state(engine_client, model_config, app.state, args)
654
655
656
657
658
659
660
661
662
663
664

        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,
665
666
667
            **uvicorn_kwargs,
        )

668
669
    # NB: Await server shutdown only after the backend context is exited
    await shutdown_task
670

671
672
    sock.close()

Ethan Xu's avatar
Ethan Xu committed
673
674
675
676
677
678
679
680

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()
681
    validate_parsed_serve_args(args)
682

683
    uvloop.run(run_server(args))