api_server.py 28.3 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, 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
                                              EmbeddingRequest,
48
49
50
                                              EmbeddingResponse,
                                              EmbeddingResponseData,
                                              ErrorResponse,
51
                                              LoadLoraAdapterRequest,
52
                                              PoolingRequest, PoolingResponse,
53
                                              ScoreRequest, ScoreResponse,
54
                                              TokenizeRequest,
55
56
57
                                              TokenizeResponse,
                                              UnloadLoraAdapterRequest)
# yapf: enable
58
59
from vllm.entrypoints.openai.serving_chat import OpenAIServingChat
from vllm.entrypoints.openai.serving_completion import OpenAIServingCompletion
60
from vllm.entrypoints.openai.serving_embedding import OpenAIServingEmbedding
61
from vllm.entrypoints.openai.serving_engine import BaseModelPath, OpenAIServing
62
from vllm.entrypoints.openai.serving_pooling import OpenAIServingPooling
63
from vllm.entrypoints.openai.serving_score import OpenAIServingScores
64
65
from vllm.entrypoints.openai.serving_tokenization import (
    OpenAIServingTokenization)
66
from vllm.entrypoints.openai.tool_parsers import ToolParserManager
67
from vllm.entrypoints.utils import with_cancellation
68
from vllm.logger import init_logger
yhu422's avatar
yhu422 committed
69
from vllm.usage.usage_lib import UsageContext
70
from vllm.utils import (FlexibleArgumentParser, get_open_zmq_ipc_path,
71
                        is_valid_ipv6_address, set_ulimit)
72
from vllm.version import __version__ as VLLM_VERSION
Zhuohan Li's avatar
Zhuohan Li committed
73

74
TIMEOUT_KEEP_ALIVE = 5  # seconds
Zhuohan Li's avatar
Zhuohan Li committed
75

76
prometheus_multiproc_dir: tempfile.TemporaryDirectory
77

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

81
_running_tasks: Set[asyncio.Task] = set()
82

83

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

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

            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
108
109


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

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

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

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

136
    # AsyncLLMEngine.
137
    if (MQLLMEngineClient.is_unsupported_config(engine_args)
138
            or envs.VLLM_USE_V1 or disable_frontend_multiprocessing):
139

140
141
142
143
144
145
146
147
148
        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()
149

150
    # MQLLMEngine.
151
    else:
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
        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.")

167
        # Select random path for IPC.
168
        ipc_path = get_open_zmq_ipc_path()
169
170
        logger.debug("Multiprocessing frontend to use %s for IPC Path.",
                     ipc_path)
171

172
        # Start RPCServer in separate process (holds the LLMEngine).
173
174
        # the current process might have CUDA context,
        # so we need to spawn a new process
175
176
        context = multiprocessing.get_context("spawn")

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

190
191
192
193
194
195
196
197
        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)

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

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

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

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

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

237

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

240

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

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


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


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


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


280
281
282
283
def pooling(request: Request) -> Optional[OpenAIServingPooling]:
    return request.app.state.openai_serving_pooling


284
285
def embedding(request: Request) -> Optional[OpenAIServingEmbedding]:
    return request.app.state.openai_serving_embedding
286
287


288
289
290
291
def score(request: Request) -> Optional[OpenAIServingScores]:
    return request.app.state.openai_serving_scores


292
293
def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
294
295


296
def engine_client(request: Request) -> EngineClient:
297
298
299
    return request.app.state.engine_client


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


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

312
    generator = await handler.create_tokenize(request, raw_request)
313
314
315
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
316
    elif isinstance(generator, TokenizeResponse):
317
318
        return JSONResponse(content=generator.model_dump())

319
320
    assert_never(generator)

321

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

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

334
335
    assert_never(generator)

336

Ethan Xu's avatar
Ethan Xu committed
337
@router.get("/v1/models")
338
async def show_available_models(raw_request: Request):
339
340
341
    handler = base(raw_request)

    models = await handler.show_available_models()
342
    return JSONResponse(content=models.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
343
344


Ethan Xu's avatar
Ethan Xu committed
345
@router.get("/version")
346
async def show_version():
347
    ver = {"version": VLLM_VERSION}
348
349
350
    return JSONResponse(content=ver)


Ethan Xu's avatar
Ethan Xu committed
351
@router.post("/v1/chat/completions")
352
@with_cancellation
353
354
async def create_chat_completion(request: ChatCompletionRequest,
                                 raw_request: Request):
355
356
357
358
    handler = chat(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Chat Completions API")
359

360
    generator = await handler.create_chat_completion(request, raw_request)
361

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

366
    elif isinstance(generator, ChatCompletionResponse):
367
        return JSONResponse(content=generator.model_dump())
368

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

371

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

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

Zhuohan Li's avatar
Zhuohan Li committed
389

Ethan Xu's avatar
Ethan Xu committed
390
@router.post("/v1/embeddings")
391
@with_cancellation
392
async def create_embedding(request: EmbeddingRequest, raw_request: Request):
393
394
    handler = embedding(raw_request)
    if handler is None:
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
        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)
424

425
426
427
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
428
    elif isinstance(generator, EmbeddingResponse):
429
430
        return JSONResponse(content=generator.model_dump())

431
432
    assert_never(generator)

433

434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
@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)


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


470
@router.post("/v1/score")
471
@with_cancellation
472
473
474
475
476
477
478
479
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)


480
481
482
483
484
485
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")
486
    async def start_profile(raw_request: Request):
487
        logger.info("Starting profiler...")
488
        await engine_client(raw_request).start_profile()
489
490
491
492
        logger.info("Profiler started.")
        return Response(status_code=200)

    @router.post("/stop_profile")
493
    async def stop_profile(raw_request: Request):
494
        logger.info("Stopping profiler...")
495
        await engine_client(raw_request).stop_profile()
496
497
498
499
        logger.info("Profiler stopped.")
        return Response(status_code=200)


500
501
502
503
504
505
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")
506
507
    async def load_lora_adapter(request: LoadLoraAdapterRequest,
                                raw_request: Request):
508
509
510
511
512
513
514
        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)
515
516
517
518

        return Response(status_code=200, content=response)

    @router.post("/v1/unload_lora_adapter")
519
520
    async def unload_lora_adapter(request: UnloadLoraAdapterRequest,
                                  raw_request: Request):
521
522
523
524
525
526
527
        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)
528
529
530
531

        return Response(status_code=200, content=response)


532
def build_app(args: Namespace) -> FastAPI:
533
534
535
536
537
538
539
    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
540
541
    app.include_router(router)
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
542

543
544
    mount_metrics(app)

Zhuohan Li's avatar
Zhuohan Li committed
545
546
547
548
549
550
551
552
    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
553
554
    @app.exception_handler(RequestValidationError)
    async def validation_exception_handler(_, exc):
555
556
557
        err = ErrorResponse(message=str(exc),
                            type="BadRequestError",
                            code=HTTPStatus.BAD_REQUEST)
Ethan Xu's avatar
Ethan Xu committed
558
559
560
        return JSONResponse(err.model_dump(),
                            status_code=HTTPStatus.BAD_REQUEST)

561
    if token := envs.VLLM_API_KEY or args.api_key:
562
563
564

        @app.middleware("http")
        async def authentication(request: Request, call_next):
565
566
            if request.method == "OPTIONS":
                return await call_next(request)
567
568
569
570
            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"):
571
572
573
574
575
576
                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)

577
578
579
580
581
582
583
584
585
586
587
588
    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
589

590
591
592
593
594
595
596
597
    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:
598
599
            raise ValueError(f"Invalid middleware {middleware}. "
                             f"Must be a function or a class.")
600

Ethan Xu's avatar
Ethan Xu committed
601
602
603
    return app


604
def init_app_state(
605
    engine_client: EngineClient,
606
607
    model_config: ModelConfig,
    state: State,
608
    args: Namespace,
609
) -> None:
610
    if args.served_model_name is not None:
611
        served_model_names = args.served_model_name
612
    else:
613
        served_model_names = [args.model]
614

615
616
617
618
619
    if args.disable_log_requests:
        request_logger = None
    else:
        request_logger = RequestLogger(max_log_len=args.max_log_len)

620
621
622
623
624
    base_model_paths = [
        BaseModelPath(name=name, model_path=args.model)
        for name in served_model_names
    ]

625
    state.engine_client = engine_client
626
    state.log_stats = not args.disable_log_stats
Ethan Xu's avatar
Ethan Xu committed
627

628
629
630
    resolved_chat_template = load_chat_template(args.chat_template)
    logger.info("Using supplied chat template:\n%s", resolved_chat_template)

631
    state.openai_serving_chat = OpenAIServingChat(
632
        engine_client,
633
        model_config,
634
        base_model_paths,
635
636
637
638
        args.response_role,
        lora_modules=args.lora_modules,
        prompt_adapters=args.prompt_adapters,
        request_logger=request_logger,
639
640
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
641
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
642
        enable_auto_tools=args.enable_auto_tool_choice,
643
        tool_parser=args.tool_call_parser,
644
        enable_prompt_tokens_details=args.enable_prompt_tokens_details,
645
    ) if model_config.runner_type == "generate" else None
646
    state.openai_serving_completion = OpenAIServingCompletion(
647
        engine_client,
648
        model_config,
649
        base_model_paths,
650
651
652
        lora_modules=args.lora_modules,
        prompt_adapters=args.prompt_adapters,
        request_logger=request_logger,
653
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
654
    ) if model_config.runner_type == "generate" else None
655
    state.openai_serving_pooling = OpenAIServingPooling(
656
        engine_client,
657
        model_config,
658
        base_model_paths,
659
        request_logger=request_logger,
660
661
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
662
    ) if model_config.runner_type == "pooling" else None
663
664
665
666
667
668
669
670
    state.openai_serving_embedding = OpenAIServingEmbedding(
        engine_client,
        model_config,
        base_model_paths,
        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
671
672
673
674
675
    state.openai_serving_scores = OpenAIServingScores(
        engine_client,
        model_config,
        base_model_paths,
        request_logger=request_logger
676
    ) if model_config.task == "score" else None
677
    state.openai_serving_tokenization = OpenAIServingTokenization(
678
        engine_client,
679
        model_config,
680
        base_model_paths,
681
682
        lora_modules=args.lora_modules,
        request_logger=request_logger,
683
684
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
685
    )
686
687


688
689
690
691
692
693
694
695
696
697
698
699
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


700
async def run_server(args, **uvicorn_kwargs) -> None:
701
702
703
    logger.info("vLLM API server version %s", VLLM_VERSION)
    logger.info("args: %s", args)

704
705
706
707
708
709
710
711
712
    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)} }})")

713
714
715
    # 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
716
717
    sock_addr = (args.host or "", args.port)
    sock = create_server_socket(sock_addr)
718

719
720
721
722
    # workaround to avoid footguns where uvicorn drops requests with too
    # many concurrent requests active
    set_ulimit()

723
724
725
726
727
728
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

729
    async with build_async_engine_client(args) as engine_client:
730
731
        app = build_app(args)

732
733
        model_config = await engine_client.get_model_config()
        init_app_state(engine_client, model_config, app.state, args)
734
735
736
737
738
739
740
741
742
743
744

        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,
745
746
747
            **uvicorn_kwargs,
        )

748
749
    # NB: Await server shutdown only after the backend context is exited
    await shutdown_task
750

751
752
    sock.close()

Ethan Xu's avatar
Ethan Xu committed
753
754
755
756
757
758
759
760

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()
761
    validate_parsed_serve_args(args)
762

763
    uvloop.run(run_server(args))