core.py 52.3 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
import os
4
import queue
5
import signal
6
7
import threading
import time
8
from collections import deque
Rui Qiao's avatar
Rui Qiao committed
9
from collections.abc import Generator
10
from concurrent.futures import Future
Rui Qiao's avatar
Rui Qiao committed
11
from contextlib import ExitStack, contextmanager
12
from inspect import isclass, signature
13
from logging import DEBUG
14
from typing import Any, Callable, Optional, TypeVar, Union
15

16
import msgspec
17
18
import zmq

19
20
from vllm.config import ParallelConfig, VllmConfig
from vllm.distributed import stateless_destroy_torch_distributed_process_group
21
from vllm.logger import init_logger
22
from vllm.logging_utils.dump_input import dump_engine_exception
23
from vllm.lora.request import LoRARequest
24
from vllm.multimodal import MULTIMODAL_REGISTRY
25
from vllm.multimodal.cache import receiver_cache_from_config
26
from vllm.tasks import POOLING_TASKS, SupportedTask
27
28
from vllm.transformers_utils.config import (
    maybe_register_config_serialize_by_value)
29
from vllm.utils import (decorate_logs, get_hash_fn_by_name, make_zmq_socket,
30
                        resolve_obj_by_qualname, set_process_title)
31
32
33
from vllm.v1.core.kv_cache_utils import (BlockHash, get_kv_cache_config,
                                         get_request_block_hasher,
                                         init_none_hash,
34
                                         unify_kv_cache_configs)
35
from vllm.v1.core.sched.interface import SchedulerInterface
36
37
from vllm.v1.core.sched.output import SchedulerOutput
from vllm.v1.core.sched.scheduler import Scheduler as V1Scheduler
38
from vllm.v1.engine import (EngineCoreOutputs, EngineCoreRequest,
39
40
                            EngineCoreRequestType,
                            ReconfigureDistributedRequest, ReconfigureRankType,
41
                            UtilityOutput, UtilityResult)
42
from vllm.v1.engine.utils import EngineHandshakeMetadata, EngineZmqAddresses
43
from vllm.v1.executor.abstract import Executor
44
from vllm.v1.kv_cache_interface import KVCacheConfig
45
from vllm.v1.metrics.stats import SchedulerStats
46
from vllm.v1.outputs import ModelRunnerOutput
47
from vllm.v1.request import Request, RequestStatus
48
from vllm.v1.serial_utils import MsgpackDecoder, MsgpackEncoder
49
from vllm.v1.structured_output import StructuredOutputManager
50
51
52
53
from vllm.version import __version__ as VLLM_VERSION

logger = init_logger(__name__)

54
POLLING_TIMEOUT_S = 2.5
55
HANDSHAKE_TIMEOUT_MINS = 5
56

57
58
_R = TypeVar('_R')  # Return type for collective_rpc

59
60
61
62

class EngineCore:
    """Inner loop of vLLM's Engine."""

63
64
65
66
67
    def __init__(self,
                 vllm_config: VllmConfig,
                 executor_class: type[Executor],
                 log_stats: bool,
                 executor_fail_callback: Optional[Callable] = None):
68

69
70
71
72
        # plugins need to be loaded at the engine/scheduler level too
        from vllm.plugins import load_general_plugins
        load_general_plugins()

73
        self.vllm_config = vllm_config
74
        logger.info("Initializing a V1 LLM engine (v%s) with config: %s",
75
76
                    VLLM_VERSION, vllm_config)

77
78
        self.log_stats = log_stats

79
80
        # Setup Model.
        self.model_executor = executor_class(vllm_config)
81
82
83
        if executor_fail_callback is not None:
            self.model_executor.register_failure_callback(
                executor_fail_callback)
84

85
86
        self.available_gpu_memory_for_kv_cache = -1

87
        # Setup KV Caches and update CacheConfig after profiling.
88
89
90
        num_gpu_blocks, num_cpu_blocks, kv_cache_config = \
            self._initialize_kv_caches(vllm_config)

91
92
        vllm_config.cache_config.num_gpu_blocks = num_gpu_blocks
        vllm_config.cache_config.num_cpu_blocks = num_cpu_blocks
93
94
        self.collective_rpc("initialize_cache",
                            args=(num_gpu_blocks, num_cpu_blocks))
95

96
97
        self.structured_output_manager = StructuredOutputManager(vllm_config)

98
        # Setup scheduler.
99
        if isinstance(vllm_config.scheduler_config.scheduler_cls, str):
100
101
102
103
104
105
106
107
108
            Scheduler = resolve_obj_by_qualname(
                vllm_config.scheduler_config.scheduler_cls)
        else:
            Scheduler = vllm_config.scheduler_config.scheduler_cls

        # This warning can be removed once the V1 Scheduler interface is
        # finalized and we can maintain support for scheduler classes that
        # implement it
        if Scheduler is not V1Scheduler:
109
110
111
112
113
            logger.warning(
                "Using configured V1 scheduler class %s. "
                "This scheduler interface is not public and "
                "compatibility may not be maintained.",
                vllm_config.scheduler_config.scheduler_cls)
114

115
116
117
118
119
120
        if len(kv_cache_config.kv_cache_groups) == 0:
            # Encoder models without KV cache don't support
            # chunked prefill. But do SSM models?
            logger.info("Disabling chunked prefill for model without KVCache")
            vllm_config.scheduler_config.chunked_prefill_enabled = False

121
        self.scheduler: SchedulerInterface = Scheduler(
122
            vllm_config=vllm_config,
123
124
            kv_cache_config=kv_cache_config,
            structured_output_manager=self.structured_output_manager,
125
126
            include_finished_set=vllm_config.parallel_config.data_parallel_size
            > 1,
127
            log_stats=self.log_stats,
128
        )
129
        self.use_spec_decode = vllm_config.speculative_config is not None
130

131
132
133
        self.mm_registry = mm_registry = MULTIMODAL_REGISTRY
        self.mm_receiver_cache = receiver_cache_from_config(
            vllm_config, mm_registry)
134

135
136
137
138
139
        # Setup batch queue for pipeline parallelism.
        # Batch queue for scheduled batches. This enables us to asynchronously
        # schedule and execute batches, and is required by pipeline parallelism
        # to eliminate pipeline bubbles.
        self.batch_queue_size = self.model_executor.max_concurrent_batches
140
        self.batch_queue: Optional[queue.Queue[tuple[Future[ModelRunnerOutput],
141
142
143
144
145
146
                                                     SchedulerOutput]]] = None
        if self.batch_queue_size > 1:
            logger.info("Batch queue is enabled with size %d",
                        self.batch_queue_size)
            self.batch_queue = queue.Queue(self.batch_queue_size)

147
148
149
150
151
152
153
154
155
156
157
158
159
        self.request_block_hasher: Optional[Callable[[Request],
                                                     list[BlockHash]]] = None
        if (self.vllm_config.cache_config.enable_prefix_caching
                or self.scheduler.get_kv_connector() is not None):

            block_size = vllm_config.cache_config.block_size
            caching_hash_fn = get_hash_fn_by_name(
                vllm_config.cache_config.prefix_caching_hash_algo)
            init_none_hash(caching_hash_fn)

            self.request_block_hasher = get_request_block_hasher(
                block_size, caching_hash_fn)

160
161
    def _initialize_kv_caches(
            self, vllm_config: VllmConfig) -> tuple[int, int, KVCacheConfig]:
162
        start = time.time()
163

164
        # Get all kv cache needed by the model
165
        kv_cache_specs = self.model_executor.get_kv_cache_specs()
166

167
168
        has_kv_cache = any(kv_cache_spec for kv_cache_spec in kv_cache_specs)
        if has_kv_cache:
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
            if os.environ.get("VLLM_ELASTIC_EP_SCALE_UP_LAUNCH") == "1":
                dp_group = getattr(self, "dp_group", None)
                assert dp_group is not None
                self.available_gpu_memory_for_kv_cache = \
                    ParallelConfig.sync_kv_cache_memory_size(dp_group, -1)
                available_gpu_memory = [
                    self.available_gpu_memory_for_kv_cache
                ] * len(kv_cache_specs)
            else:
                # Profiles the peak memory usage of the model to determine how
                # much memory can be allocated for kv cache.
                available_gpu_memory = (
                    self.model_executor.determine_available_memory())
                self.available_gpu_memory_for_kv_cache = \
                    available_gpu_memory[0]
184
185
186
        else:
            # Attention free models don't need memory for kv cache
            available_gpu_memory = [0] * len(kv_cache_specs)
187

188
        assert len(kv_cache_specs) == len(available_gpu_memory)
189
        # Get the kv cache tensor size
190
191
192
193
194
195
196
197
198
199
200
201
202
        kv_cache_configs = [
            get_kv_cache_config(vllm_config, kv_cache_spec_one_worker,
                                available_gpu_memory_one_worker)
            for kv_cache_spec_one_worker, available_gpu_memory_one_worker in
            zip(kv_cache_specs, available_gpu_memory)
        ]

        # Since we use a shared centralized controller, we need the
        # `kv_cache_config` to be consistent across all workers to make sure
        # all the memory operators can be applied to all workers.
        unify_kv_cache_configs(kv_cache_configs)

        # All workers have the same kv_cache_config except layer names, so use
203
        # an arbitrary one to initialize the scheduler.
204
205
206
207
208
        assert all([
            cfg.num_blocks == kv_cache_configs[0].num_blocks
            for cfg in kv_cache_configs
        ])
        num_gpu_blocks = kv_cache_configs[0].num_blocks
209
        num_cpu_blocks = 0
210
        scheduler_kv_cache_config = kv_cache_configs[0]
211
212

        # Initialize kv cache and warmup the execution
213
        self.model_executor.initialize_from_config(kv_cache_configs)
214

215
216
217
        elapsed = time.time() - start
        logger.info(("init engine (profile, create kv cache, "
                     "warmup model) took %.2f seconds"), elapsed)
218
        return num_gpu_blocks, num_cpu_blocks, scheduler_kv_cache_config
219

220
221
222
    def get_supported_tasks(self) -> tuple[SupportedTask, ...]:
        return self.model_executor.supported_tasks

223
224
225
226
227
228
    def add_request(self, request: Request, request_wave: int = 0):
        """Add request to the scheduler.
        
        `request_wave`: indicate which wave of requests this is expected to
        belong to in DP case
        """
229
230
231
232
233
        # Validate the request_id type.
        if not isinstance(request.request_id, str):
            raise TypeError(
                f"request_id must be a string, got {type(request.request_id)}")

234
        if pooling_params := request.pooling_params:
235
236
237
238
239
            supported_pooling_tasks = [
                task for task in self.get_supported_tasks()
                if task in POOLING_TASKS
            ]

240
241
242
            if pooling_params.task not in supported_pooling_tasks:
                raise ValueError(f"Unsupported task: {pooling_params.task!r} "
                                 f"Supported tasks: {supported_pooling_tasks}")
243

244
        if request.kv_transfer_params is not None and (
245
246
247
                not self.scheduler.get_kv_connector()):
            logger.warning("Got kv_transfer_params, but no KVConnector found. "
                           "Disabling KVTransfer for this request.")
Robert Shaw's avatar
Robert Shaw committed
248

249
        self.scheduler.add_request(request)
250

251
    def abort_requests(self, request_ids: list[str]):
252
253
254
255
256
257
258
259
        """Abort requests from the scheduler."""

        # TODO: The scheduler doesn't really need to know the
        # specific finish reason, TBD whether we propagate that
        # (i.e. client-aborted vs stop criteria met).
        self.scheduler.finish_requests(request_ids,
                                       RequestStatus.FINISHED_ABORTED)

260
261
262
263
264
265
    def execute_model_with_error_logging(
        self,
        model_fn: Callable[[SchedulerOutput], ModelRunnerOutput],
        scheduler_output: SchedulerOutput,
    ) -> ModelRunnerOutput:
        """Execute the model and log detailed info on failure."""
266
        try:
267
            return model_fn(scheduler_output)
268
269
270
271
272
        except Exception as err:
            # We do not want to catch BaseException here since we're only
            # interested in dumping info when the exception is due to an
            # error from execute_model itself.

273
274
275
276
277
            # NOTE: This method is exception-free
            dump_engine_exception(self.vllm_config, scheduler_output,
                                  self.scheduler.make_stats())
            raise err

278
    def step(self) -> tuple[dict[int, EngineCoreOutputs], bool]:
279
280
281
282
283
        """Schedule, execute, and make output.

        Returns tuple of outputs and a flag indicating whether the model
        was executed.
        """
284

285
286
287
        # Check for any requests remaining in the scheduler - unfinished,
        # or finished and not yet removed from the batch.
        if not self.scheduler.has_requests():
288
            return {}, False
289
        scheduler_output = self.scheduler.schedule()
290
291
292
        model_output = self.execute_model_with_error_logging(
            self.model_executor.execute_model,  # type: ignore
            scheduler_output)
293
        engine_core_outputs = self.scheduler.update_from_output(
294
            scheduler_output, model_output)  # type: ignore
295

296
297
        return (engine_core_outputs,
                scheduler_output.total_num_scheduled_tokens > 0)
298

299
300
301
302
303
304
305
    def post_step(self, model_executed: bool) -> None:
        if self.use_spec_decode and model_executed:
            # Take the draft token ids.
            draft_token_ids = self.model_executor.take_draft_token_ids()
            if draft_token_ids is not None:
                self.scheduler.update_draft_token_ids(draft_token_ids)

306
    def step_with_batch_queue(
307
            self) -> tuple[Optional[dict[int, EngineCoreOutputs]], bool]:
308
309
310
311
        """Schedule and execute batches with the batch queue.
        Note that if nothing to output in this step, None is returned.

        The execution flow is as follows:
312
313
314
315
        1. Try to schedule a new batch if the batch queue is not full.
        If a new batch is scheduled, directly return an empty engine core
        output. In other words, fulfilling the batch queue has a higher priority
        than getting model outputs.
316
317
318
319
320
321
322
323
324
        2. If there is no new scheduled batch, meaning that the batch queue
        is full or no other requests can be scheduled, we block until the first
        batch in the job queue is finished.
        3. Update the scheduler from the output.
        """
        assert self.batch_queue is not None

        engine_core_outputs = None
        scheduler_output = None
325
326
327
328
        # Try to schedule a new batch if the batch queue is not full, but
        # the scheduler may return an empty batch if all requests are scheduled.
        # Note that this is not blocking.
        if not self.batch_queue.full():
329
330
331
332
333
334
            scheduler_output = self.scheduler.schedule()
            if scheduler_output.total_num_scheduled_tokens > 0:
                future = self.model_executor.execute_model(scheduler_output)
                self.batch_queue.put_nowait(
                    (future, scheduler_output))  # type: ignore

335
336
337
338
        scheduled_batch = (scheduler_output is not None
                           and scheduler_output.total_num_scheduled_tokens > 0)

        # If no more requests can be scheduled and the job queue is not empty,
339
        # block until the first batch in the job queue is finished.
340
341
342
343
        # TODO(comaniac): Ideally we should peek the first batch in the
        # job queue to check if it's finished before scheduling a new batch,
        # but peeking the first element in a queue is not thread-safe,
        # so we need more work.
344
345
        if not scheduled_batch and not self.batch_queue.empty():
            future, scheduler_output = self.batch_queue.get_nowait()
346

347
            # Blocking until the first result is available.
348
349
350
            model_output = self.execute_model_with_error_logging(
                lambda _: future.result(), scheduler_output)

351
            self.batch_queue.task_done()
352
353
            engine_core_outputs = (self.scheduler.update_from_output(
                scheduler_output, model_output))
354

355
        return engine_core_outputs, scheduled_batch
356

357
    def shutdown(self):
358
        self.structured_output_manager.clear_backend()
359
360
        if self.model_executor:
            self.model_executor.shutdown()
361
362
        if self.scheduler:
            self.scheduler.shutdown()
363

364
    def profile(self, is_start: bool = True):
365
        self.model_executor.profile(is_start)
366

367
368
369
    def reset_mm_cache(self):
        # NOTE: Since this is mainly for debugging, we don't attempt to
        # re-sync the internal caches (P0 processor, P0 mirror, P1 mirror)
370
        if self.scheduler.has_unfinished_requests():
371
372
373
            logger.warning("Resetting the multi-modal cache when requests are "
                           "in progress may lead to desynced internal caches.")

374
375
        if self.mm_receiver_cache is not None:
            self.mm_receiver_cache.clear_cache()
376

377
378
379
    def reset_prefix_cache(self):
        self.scheduler.reset_prefix_cache()

380
381
382
    def sleep(self, level: int = 1):
        self.model_executor.sleep(level)

383
384
    def wake_up(self, tags: Optional[list[str]] = None):
        self.model_executor.wake_up(tags)
385

386
387
388
    def is_sleeping(self) -> bool:
        return self.model_executor.is_sleeping

389
390
391
    def execute_dummy_batch(self):
        self.model_executor.collective_rpc("execute_dummy_batch")

392
393
394
395
396
397
    def add_lora(self, lora_request: LoRARequest) -> bool:
        return self.model_executor.add_lora(lora_request)

    def remove_lora(self, lora_id: int) -> bool:
        return self.model_executor.remove_lora(lora_id)

398
    def list_loras(self) -> set[int]:
399
400
401
402
        return self.model_executor.list_loras()

    def pin_lora(self, lora_id: int) -> bool:
        return self.model_executor.pin_lora(lora_id)
403

404
405
406
407
408
409
410
411
412
413
    def save_sharded_state(
        self,
        path: str,
        pattern: Optional[str] = None,
        max_size: Optional[int] = None,
    ) -> None:
        self.model_executor.save_sharded_state(path=path,
                                               pattern=pattern,
                                               max_size=max_size)

414
415
416
417
418
419
420
421
    def collective_rpc(self,
                       method: Union[str, Callable[..., _R]],
                       timeout: Optional[float] = None,
                       args: tuple = (),
                       kwargs: Optional[dict[str, Any]] = None) -> list[_R]:
        return self.model_executor.collective_rpc(method, timeout, args,
                                                  kwargs)

422
423
424
425
426
427
428
    def save_tensorized_model(
        self,
        tensorizer_config,
    ) -> None:
        self.model_executor.save_tensorized_model(
            tensorizer_config=tensorizer_config, )

429
430
431
432
433
434
435
436
    def preprocess_add_request(
            self, request: EngineCoreRequest) -> tuple[Request, int]:
        """Preprocess the request.
        
        This function could be directly used in input processing thread to allow
        request initialization running in parallel with Model forward
        """
        if request.mm_hashes is not None:
437
438
            assert request.mm_kwargs is not None

439
            # Note on thread safety: no race condition.
440
            # `mm_receiver_cache` is reset at the end of LLMEngine init,
441
            # and will only accessed in the input processing thread afterwards.
442
443
444
            if self.mm_receiver_cache is not None:
                request.mm_kwargs = self.mm_receiver_cache.get_and_update(
                    request.mm_kwargs, request.mm_hashes)
445

446
447
        req = Request.from_engine_core_request(request,
                                               self.request_block_hasher)
448
449
450
451
452
453
454
455
456
        if req.use_structured_output:
            # Note on thread safety: no race condition.
            # `grammar_init` is only invoked in input processing thread. For
            # `structured_output_manager`, each request is independent and
            # grammar compilation is async. Scheduler always checks grammar
            # compilation status before scheduling request.
            self.structured_output_manager.grammar_init(req)
        return req, request.current_wave

457
458
459
460

class EngineCoreProc(EngineCore):
    """ZMQ-wrapper for running EngineCore in background process."""

461
462
    ENGINE_CORE_DEAD = b'ENGINE_CORE_DEAD'

463
464
    def __init__(
        self,
465
        vllm_config: VllmConfig,
466
        local_client: bool,
467
        handshake_address: str,
468
        executor_class: type[Executor],
469
        log_stats: bool,
470
        client_handshake_address: Optional[str] = None,
471
        engine_index: int = 0,
472
    ):
Rui Qiao's avatar
Rui Qiao committed
473
474
475
476
        self.input_queue = queue.Queue[tuple[EngineCoreRequestType, Any]]()
        self.output_queue = queue.Queue[Union[tuple[int, EngineCoreOutputs],
                                              bytes]]()
        executor_fail_callback = lambda: self.input_queue.put_nowait(
477
478
            (EngineCoreRequestType.EXECUTOR_FAILED, b''))

Rui Qiao's avatar
Rui Qiao committed
479
480
481
        self.engine_index = engine_index
        identity = self.engine_index.to_bytes(length=2, byteorder="little")
        self.engines_running = False
482

483
484
485
        with self._perform_handshakes(handshake_address, identity,
                                      local_client, vllm_config,
                                      client_handshake_address) as addresses:
486
            self.client_count = len(addresses.outputs)
487
488

            # Set up data parallel environment.
489
            self.has_coordinator = addresses.coordinator_output is not None
490
491
            self.frontend_stats_publish_address = (
                addresses.frontend_stats_publish_address)
492
493
494
            logger.debug("Has DP Coordinator: %s, stats publish address: %s",
                         self.has_coordinator,
                         self.frontend_stats_publish_address)
495
            # Only publish request queue stats to coordinator for "internal"
496
            # and "hybrid" LB modes .
497
498
499
500
            self.publish_dp_lb_stats = (
                self.has_coordinator
                and not vllm_config.parallel_config.data_parallel_external_lb)

501
502
503
504
505
            self._init_data_parallel(vllm_config)

            super().__init__(vllm_config, executor_class, log_stats,
                             executor_fail_callback)

506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
            # Background Threads and Queues for IO. These enable us to
            # overlap ZMQ socket IO with GPU since they release the GIL,
            # and to overlap some serialization/deserialization with the
            # model forward pass.
            # Threads handle Socket <-> Queues and core_busy_loop uses Queue.
            ready_event = threading.Event()
            input_thread = threading.Thread(target=self.process_input_sockets,
                                            args=(addresses.inputs,
                                                  addresses.coordinator_input,
                                                  identity, ready_event),
                                            daemon=True)
            input_thread.start()

            self.output_thread = threading.Thread(
                target=self.process_output_sockets,
                args=(addresses.outputs, addresses.coordinator_output,
                      self.engine_index),
                daemon=True)
            self.output_thread.start()

            # Don't complete handshake until DP coordinator ready message is
            # received.
            while not ready_event.wait(timeout=10):
                if not input_thread.is_alive():
                    raise RuntimeError(
                        "Input socket thread died during startup")
                assert addresses.coordinator_input is not None
                logger.info("Waiting for READY message from DP Coordinator...")

Rui Qiao's avatar
Rui Qiao committed
535
536
        self.step_fn = (self.step if self.batch_queue is None else
                        self.step_with_batch_queue)
537

Rui Qiao's avatar
Rui Qiao committed
538
    @contextmanager
539
540
541
542
543
544
545
    def _perform_handshakes(
        self,
        handshake_address: str,
        identity: bytes,
        local_client: bool,
        vllm_config: VllmConfig,
        client_handshake_address: Optional[str],
Rui Qiao's avatar
Rui Qiao committed
546
    ) -> Generator[EngineZmqAddresses, None, None]:
547
548
549
550
551
        """
        Perform startup handshakes.

        For DP=1 or offline mode, this is with the colocated front-end process.

552
        For DP>1 with internal load-balancing this is with the shared front-end
553
554
        process which may reside on a different node.

555
        For DP>1 with external or hybrid load-balancing, two handshakes are
556
        performed:
557
558
559
560
            - With the rank 0 front-end process which retrieves the
              DP Coordinator ZMQ addresses and DP process group address.
            - With the colocated front-end process which retrieves the
              client input/output socket addresses.
561
562
        with the exception of the rank 0 and colocated engines themselves which
        don't require the second handshake.
563
564
565
566
567
568

        Here, "front-end" process can mean the process containing the engine
        core client (which is the API server process in the case the API
        server is not scaled out), OR the launcher process running the
        run_multi_api_server() function in serve.py.
        """
Rui Qiao's avatar
Rui Qiao committed
569
        input_ctx = zmq.Context()
570
        is_local = local_client and client_handshake_address is None
571
        headless = not local_client
572
        handshake = self._perform_handshake(input_ctx, handshake_address,
573
574
                                            identity, is_local, headless,
                                            vllm_config,
575
576
577
578
579
                                            vllm_config.parallel_config)
        if client_handshake_address is None:
            with handshake as addresses:
                yield addresses
        else:
580
            assert local_client
581
            local_handshake = self._perform_handshake(
582
                input_ctx, client_handshake_address, identity, True, False,
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
                vllm_config)
            with handshake as addresses, local_handshake as client_addresses:
                addresses.inputs = client_addresses.inputs
                addresses.outputs = client_addresses.outputs
                yield addresses

        # Update config which may have changed from the handshake
        vllm_config.__post_init__()

    @contextmanager
    def _perform_handshake(
        self,
        ctx: zmq.Context,
        handshake_address: str,
        identity: bytes,
        local_client: bool,
599
        headless: bool,
600
601
602
603
        vllm_config: VllmConfig,
        parallel_config_to_update: Optional[ParallelConfig] = None,
    ) -> Generator[EngineZmqAddresses, None, None]:
        with make_zmq_socket(ctx,
Rui Qiao's avatar
Rui Qiao committed
604
605
606
607
608
609
                             handshake_address,
                             zmq.DEALER,
                             identity=identity,
                             linger=5000,
                             bind=False) as handshake_socket:
            # Register engine with front-end.
610
            addresses = self.startup_handshake(handshake_socket, local_client,
611
                                               headless,
612
                                               parallel_config_to_update)
Rui Qiao's avatar
Rui Qiao committed
613
614
615
616
            yield addresses

            # Send ready message.
            num_gpu_blocks = vllm_config.cache_config.num_gpu_blocks
617
618
619
620
            # We pass back the coordinator stats update address here for the
            # external LB case for our colocated front-end to use (coordinator
            # only runs with rank 0).
            dp_stats_address = self.frontend_stats_publish_address
Rui Qiao's avatar
Rui Qiao committed
621
622
623
            handshake_socket.send(
                msgspec.msgpack.encode({
                    "status": "READY",
624
                    "local": local_client,
625
                    "headless": headless,
Rui Qiao's avatar
Rui Qiao committed
626
                    "num_gpu_blocks": num_gpu_blocks,
627
                    "dp_stats_address": dp_stats_address,
Rui Qiao's avatar
Rui Qiao committed
628
629
                }))

630
    @staticmethod
631
    def startup_handshake(
632
633
        handshake_socket: zmq.Socket,
        local_client: bool,
634
        headless: bool,
635
636
        parallel_config: Optional[ParallelConfig] = None,
    ) -> EngineZmqAddresses:
637
638

        # Send registration message.
639
        handshake_socket.send(
640
641
            msgspec.msgpack.encode({
                "status": "HELLO",
642
                "local": local_client,
643
                "headless": headless,
644
645
646
647
            }))

        # Receive initialization message.
        logger.info("Waiting for init message from front-end.")
648
        if not handshake_socket.poll(timeout=HANDSHAKE_TIMEOUT_MINS * 60_000):
649
650
651
            raise RuntimeError("Did not receive response from front-end "
                               f"process within {HANDSHAKE_TIMEOUT_MINS} "
                               f"minutes")
652
653
654
        init_bytes = handshake_socket.recv()
        init_message: EngineHandshakeMetadata = msgspec.msgpack.decode(
            init_bytes, type=EngineHandshakeMetadata)
655
656
        logger.debug("Received init message: %s", init_message)

657
658
659
        if parallel_config is not None:
            for key, value in init_message.parallel_config.items():
                setattr(parallel_config, key, value)
660

661
        return init_message.addresses
662
663

    @staticmethod
664
665
666
667
    def run_engine_core(*args,
                        dp_rank: int = 0,
                        local_dp_rank: int = 0,
                        **kwargs):
668
669
        """Launch EngineCore busy loop in background process."""

670
671
672
673
674
        # Signal handler used for graceful termination.
        # SystemExit exception is only raised once to allow this and worker
        # processes to terminate without error
        shutdown_requested = False

675
676
677
        # Ensure we can serialize transformer config after spawning
        maybe_register_config_serialize_by_value()

678
679
680
681
682
683
684
685
686
687
        def signal_handler(signum, frame):
            nonlocal shutdown_requested
            if not shutdown_requested:
                shutdown_requested = True
                raise SystemExit()

        # Either SIGTERM or SIGINT will terminate the engine_core
        signal.signal(signal.SIGTERM, signal_handler)
        signal.signal(signal.SIGINT, signal_handler)

688
        engine_core: Optional[EngineCoreProc] = None
689
        try:
690
691
            parallel_config: ParallelConfig = kwargs[
                "vllm_config"].parallel_config
692
            if parallel_config.data_parallel_size > 1 or dp_rank > 0:
693
                set_process_title("DPEngineCore", str(dp_rank))
694
                decorate_logs()
695
696
697
698
699
                # Set data parallel rank for this engine process.
                parallel_config.data_parallel_rank = dp_rank
                parallel_config.data_parallel_rank_local = local_dp_rank
                engine_core = DPEngineCoreProc(*args, **kwargs)
            else:
700
                set_process_title("EngineCore")
701
                decorate_logs()
702
703
                engine_core = EngineCoreProc(*args, **kwargs)

704
705
            engine_core.run_busy_loop()

706
        except SystemExit:
707
            logger.debug("EngineCore exiting.")
708
            raise
709
710
711
712
713
714
715
        except Exception as e:
            if engine_core is None:
                logger.exception("EngineCore failed to start.")
            else:
                logger.exception("EngineCore encountered a fatal error.")
                engine_core._send_engine_dead()
            raise e
716
717
718
719
        finally:
            if engine_core is not None:
                engine_core.shutdown()

720
721
722
    def _init_data_parallel(self, vllm_config: VllmConfig):
        pass

723
724
725
    def run_busy_loop(self):
        """Core busy loop of the EngineCore."""

726
727
        # Loop until process is sent a SIGINT or SIGTERM
        while True:
728
            # 1) Poll the input queue until there is work to do.
729
730
731
732
733
734
735
736
            self._process_input_queue()
            # 2) Step the engine core and return the outputs.
            self._process_engine_step()

    def _process_input_queue(self):
        """Exits when an engine step needs to be performed."""

        waited = False
737
        while not self.engines_running and not self.scheduler.has_requests():
738
739
740
741
742
743
744
            if logger.isEnabledFor(DEBUG) and self.input_queue.empty():
                logger.debug("EngineCore waiting for work.")
                waited = True
            req = self.input_queue.get()
            self._handle_client_request(*req)

        if waited:
745
            logger.debug("EngineCore loop active.")
746
747
748
749
750
751

        # Handle any more client requests.
        while not self.input_queue.empty():
            req = self.input_queue.get_nowait()
            self._handle_client_request(*req)

752
    def _process_engine_step(self) -> bool:
753
754
755
        """Called only when there are unfinished local requests."""

        # Step the engine core.
756
        outputs, model_executed = self.step_fn()
757
        # Put EngineCoreOutputs into the output queue.
758
759
        for output in (outputs.items() if outputs else ()):
            self.output_queue.put_nowait(output)
760
761
        # Post-step hook.
        self.post_step(model_executed)
762

763
764
        return model_executed

765
766
767
    def _handle_client_request(self, request_type: EngineCoreRequestType,
                               request: Any) -> None:
        """Dispatch request from client."""
768

769
        if request_type == EngineCoreRequestType.ADD:
770
771
            req, request_wave = request
            self.add_request(req, request_wave)
772
        elif request_type == EngineCoreRequestType.ABORT:
773
            self.abort_requests(request)
774
        elif request_type == EngineCoreRequestType.UTILITY:
775
            client_idx, call_id, method_name, args = request
776
777
778
            output = UtilityOutput(call_id)
            try:
                method = getattr(self, method_name)
779
780
                result = method(*self._convert_msgspec_args(method, args))
                output.result = UtilityResult(result)
781
782
783
784
785
            except BaseException as e:
                logger.exception("Invocation of %s method failed", method_name)
                output.failure_message = (f"Call to {method_name} method"
                                          f" failed: {str(e)}")
            self.output_queue.put_nowait(
786
                (client_idx, EngineCoreOutputs(utility_output=output)))
787
788
789
790
791
        elif request_type == EngineCoreRequestType.EXECUTOR_FAILED:
            raise RuntimeError("Executor failed.")
        else:
            logger.error("Unrecognized input request type encountered: %s",
                         request_type)
792
793
794
795
796
797
798
799
800
801
802
803
804
805

    @staticmethod
    def _convert_msgspec_args(method, args):
        """If a provided arg type doesn't match corresponding target method
         arg type, try converting to msgspec object."""
        if not args:
            return args
        arg_types = signature(method).parameters.values()
        assert len(args) <= len(arg_types)
        return tuple(
            msgspec.convert(v, type=p.annotation) if isclass(p.annotation)
            and issubclass(p.annotation, msgspec.Struct)
            and not isinstance(v, p.annotation) else v
            for v, p in zip(args, arg_types))
806

807
808
809
810
811
812
813
814
815
816
817
818
    def _send_engine_dead(self):
        """Send EngineDead status to the EngineCoreClient."""

        # Put ENGINE_CORE_DEAD in the queue.
        self.output_queue.put_nowait(EngineCoreProc.ENGINE_CORE_DEAD)

        # Wait until msg sent by the daemon before shutdown.
        self.output_thread.join(timeout=5.0)
        if self.output_thread.is_alive():
            logger.fatal("vLLM shutdown signal from EngineCore failed "
                         "to send. Please report this issue.")

819
820
    def process_input_sockets(self, input_addresses: list[str],
                              coord_input_address: Optional[str],
821
                              identity: bytes, ready_event: threading.Event):
822
823
824
        """Input socket IO thread."""

        # Msgpack serialization decoding.
825
826
        add_request_decoder = MsgpackDecoder(EngineCoreRequest)
        generic_decoder = MsgpackDecoder()
827

828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
        with ExitStack() as stack, zmq.Context() as ctx:
            input_sockets = [
                stack.enter_context(
                    make_zmq_socket(ctx,
                                    input_address,
                                    zmq.DEALER,
                                    identity=identity,
                                    bind=False))
                for input_address in input_addresses
            ]
            if coord_input_address is None:
                coord_socket = None
            else:
                coord_socket = stack.enter_context(
                    make_zmq_socket(ctx,
                                    coord_input_address,
                                    zmq.XSUB,
                                    identity=identity,
                                    bind=False))
                # Send subscription message to coordinator.
                coord_socket.send(b'\x01')

            # Register sockets with poller.
            poller = zmq.Poller()
            for input_socket in input_sockets:
                # Send initial message to each input socket - this is required
                # before the front-end ROUTER socket can send input messages
                # back to us.
                input_socket.send(b'')
                poller.register(input_socket, zmq.POLLIN)
858

859
            if coord_socket is not None:
860
861
                # Wait for ready message from coordinator.
                assert coord_socket.recv() == b"READY"
862
                poller.register(coord_socket, zmq.POLLIN)
863

864
865
            ready_event.set()
            del ready_event
866
867
868
869
870
871
872
873
874
            while True:
                for input_socket, _ in poller.poll():
                    # (RequestType, RequestData)
                    type_frame, *data_frames = input_socket.recv_multipart(
                        copy=False)
                    request_type = EngineCoreRequestType(
                        bytes(type_frame.buffer))

                    # Deserialize the request data.
875
876
877
878
879
                    if request_type == EngineCoreRequestType.ADD:
                        request = add_request_decoder.decode(data_frames)
                        request = self.preprocess_add_request(request)
                    else:
                        request = generic_decoder.decode(data_frames)
880
881
882
883
884
885
886

                    # Push to input queue for core busy loop.
                    self.input_queue.put_nowait((request_type, request))

    def process_output_sockets(self, output_paths: list[str],
                               coord_output_path: Optional[str],
                               engine_index: int):
887
888
889
        """Output socket IO thread."""

        # Msgpack serialization encoding.
890
        encoder = MsgpackEncoder()
891
892
893
894
895
896
        # Send buffers to reuse.
        reuse_buffers: list[bytearray] = []
        # Keep references to outputs and buffers until zmq is finished
        # with them (outputs may contain tensors/np arrays whose
        # backing buffers were extracted for zero-copy send).
        pending = deque[tuple[zmq.MessageTracker, Any, bytearray]]()
897

898
899
        # We must set linger to ensure the ENGINE_CORE_DEAD
        # message is sent prior to closing the socket.
900
901
902
903
904
905
906
907
908
909
910
911
        with ExitStack() as stack, zmq.Context() as ctx:
            sockets = [
                stack.enter_context(
                    make_zmq_socket(ctx, output_path, zmq.PUSH, linger=4000))
                for output_path in output_paths
            ]
            coord_socket = stack.enter_context(
                make_zmq_socket(
                    ctx, coord_output_path, zmq.PUSH, bind=False,
                    linger=4000)) if coord_output_path is not None else None
            max_reuse_bufs = len(sockets) + 1

912
            while True:
913
914
915
916
                output = self.output_queue.get()
                if output == EngineCoreProc.ENGINE_CORE_DEAD:
                    for socket in sockets:
                        socket.send(output)
917
                    break
918
919
                assert not isinstance(output, bytes)
                client_index, outputs = output
920
                outputs.engine_index = engine_index
921

922
923
924
925
926
927
928
                if client_index == -1:
                    # Don't reuse buffer for coordinator message
                    # which will be very small.
                    assert coord_socket is not None
                    coord_socket.send_multipart(encoder.encode(outputs))
                    continue

929
930
931
932
933
                # Reclaim buffers that zmq is finished with.
                while pending and pending[-1][0].done:
                    reuse_buffers.append(pending.pop()[2])

                buffer = reuse_buffers.pop() if reuse_buffers else bytearray()
934
                buffers = encoder.encode_into(outputs, buffer)
935
936
937
                tracker = sockets[client_index].send_multipart(buffers,
                                                               copy=False,
                                                               track=True)
938
939
940
                if not tracker.done:
                    ref = outputs if len(buffers) > 1 else None
                    pending.appendleft((tracker, ref, buffer))
941
942
                elif len(reuse_buffers) < max_reuse_bufs:
                    # Limit the number of buffers to reuse.
943
                    reuse_buffers.append(buffer)
944
945
946
947
948
949
950
951
952


class DPEngineCoreProc(EngineCoreProc):
    """ZMQ-wrapper for running EngineCore in background process
    in a data parallel context."""

    def __init__(
        self,
        vllm_config: VllmConfig,
953
        local_client: bool,
954
        handshake_address: str,
955
956
        executor_class: type[Executor],
        log_stats: bool,
957
        client_handshake_address: Optional[str] = None,
958
    ):
959
960
        # Counts forward-passes of the model so that we can synchronize
        # finished with DP peers every N steps.
961
        self.step_counter = 0
962
        self.current_wave = 0
Rui Qiao's avatar
Rui Qiao committed
963
        self.last_counts = (0, 0)
964
965
966

        # Initialize the engine.
        dp_rank = vllm_config.parallel_config.data_parallel_rank
967
968
969
        super().__init__(vllm_config, local_client, handshake_address,
                         executor_class, log_stats, client_handshake_address,
                         dp_rank)
970
971
972
973

    def _init_data_parallel(self, vllm_config: VllmConfig):

        # Configure GPUs and stateless process group for data parallel.
974
        dp_rank = vllm_config.parallel_config.data_parallel_rank
975
        dp_size = vllm_config.parallel_config.data_parallel_size
976
977
978
979
980
        local_dp_rank = vllm_config.parallel_config.data_parallel_rank_local

        assert dp_size > 1
        assert 0 <= local_dp_rank <= dp_rank < dp_size

981
982
983
984
985
986
987
988
989
        if vllm_config.kv_transfer_config is not None:
            # modify the engine_id and append the local_dp_rank to it to ensure
            # that the kv_transfer_config is unique for each DP rank.
            vllm_config.kv_transfer_config.engine_id = (
                f"{vllm_config.kv_transfer_config.engine_id}_dp{local_dp_rank}"
            )
            logger.debug("Setting kv_transfer_config.engine_id to %s",
                         vllm_config.kv_transfer_config.engine_id)

990
        self.dp_rank = dp_rank
991
992
993
994
995
996
997
        self.dp_group = vllm_config.parallel_config.stateless_init_dp_group()

    def shutdown(self):
        super().shutdown()
        if dp_group := getattr(self, "dp_group", None):
            stateless_destroy_torch_distributed_process_group(dp_group)

998
999
1000
1001
    def add_request(self, request: Request, request_wave: int = 0):
        if self.has_coordinator and request_wave != self.current_wave:
            if request_wave > self.current_wave:
                self.current_wave = request_wave
1002
1003
1004
1005
            elif not self.engines_running:
                # Request received for an already-completed wave, notify
                # front-end that we need to start the next one.
                self.output_queue.put_nowait(
1006
                    (-1, EngineCoreOutputs(start_wave=self.current_wave)))
1007

1008
        super().add_request(request, request_wave)
1009
1010
1011
1012

    def _handle_client_request(self, request_type: EngineCoreRequestType,
                               request: Any) -> None:
        if request_type == EngineCoreRequestType.START_DP_WAVE:
1013
1014
1015
            new_wave, exclude_eng_index = request
            if exclude_eng_index != self.engine_index and (
                    new_wave >= self.current_wave):
1016
1017
1018
1019
1020
1021
1022
1023
                self.current_wave = new_wave
                if not self.engines_running:
                    logger.debug("EngineCore starting idle loop for wave %d.",
                                 new_wave)
                    self.engines_running = True
        else:
            super()._handle_client_request(request_type, request)

1024
    def _maybe_publish_request_counts(self):
1025
        if not self.publish_dp_lb_stats:
1026
1027
1028
1029
1030
1031
            return

        # Publish our request counts (if they've changed).
        counts = self.scheduler.get_request_counts()
        if counts != self.last_counts:
            self.last_counts = counts
1032
1033
1034
            stats = SchedulerStats(*counts,
                                   step_counter=self.step_counter,
                                   current_wave=self.current_wave)
1035
1036
1037
            self.output_queue.put_nowait(
                (-1, EngineCoreOutputs(scheduler_stats=stats)))

1038
1039
1040
1041
1042
1043
1044
1045
    def run_busy_loop(self):
        """Core busy loop of the EngineCore for data parallel case."""

        # Loop until process is sent a SIGINT or SIGTERM
        while True:
            # 1) Poll the input queue until there is work to do.
            self._process_input_queue()

1046
1047
            # 2) Step the engine core.
            executed = self._process_engine_step()
1048
1049
            self._maybe_publish_request_counts()

1050
            local_unfinished_reqs = self.scheduler.has_unfinished_requests()
1051
1052
            if not executed:
                if not local_unfinished_reqs and not self.engines_running:
1053
1054
1055
                    # All engines are idle.
                    continue

1056
1057
                # We are in a running state and so must execute a dummy pass
                # if the model didn't execute any ready requests.
1058
1059
1060
                self.execute_dummy_batch()

            # 3) All-reduce operation to determine global unfinished reqs.
1061
            self.engines_running = self._has_global_unfinished_reqs(
1062
1063
                local_unfinished_reqs)

1064
            if not self.engines_running:
1065
                if self.dp_rank == 0 or not self.has_coordinator:
1066
1067
1068
                    # Notify client that we are pausing the loop.
                    logger.debug("Wave %d finished, pausing engine loop.",
                                 self.current_wave)
1069
1070
1071
1072
                    # In the coordinator case, dp rank 0 sends updates to the
                    # coordinator. Otherwise (offline spmd case), each rank
                    # sends the update to its colocated front-end process.
                    client_index = -1 if self.has_coordinator else 0
1073
                    self.output_queue.put_nowait(
1074
                        (client_index,
1075
                         EngineCoreOutputs(wave_complete=self.current_wave)))
1076
                # Increment wave count and reset step counter.
1077
                self.current_wave += 1
1078
                self.step_counter = 0
1079
1080
1081

    def _has_global_unfinished_reqs(self, local_unfinished: bool) -> bool:

1082
        # Optimization - only perform finish-sync all-reduce every 32 steps.
1083
1084
        self.step_counter += 1
        if self.step_counter % 32 != 0:
1085
1086
1087
1088
            return True

        return ParallelConfig.has_unfinished_dp(self.dp_group,
                                                local_unfinished)
Rui Qiao's avatar
Rui Qiao committed
1089

1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
    def reinitialize_distributed(
            self, reconfig_request: ReconfigureDistributedRequest) -> None:
        stateless_destroy_torch_distributed_process_group(self.dp_group)
        self.shutdown()

        parallel_config = self.vllm_config.parallel_config
        old_dp_size = parallel_config.data_parallel_size
        parallel_config.data_parallel_size = \
            reconfig_request.new_data_parallel_size
        if reconfig_request.new_data_parallel_rank != -1:
            parallel_config.data_parallel_rank = \
                reconfig_request.new_data_parallel_rank
        # local rank specifies device visibility, it should not be changed
        assert reconfig_request.new_data_parallel_rank_local == \
            ReconfigureRankType.KEEP_CURRENT_RANK
        parallel_config.data_parallel_master_ip = \
            reconfig_request.new_data_parallel_master_ip
        parallel_config.data_parallel_master_port = \
            reconfig_request.new_data_parallel_master_port
        if reconfig_request.new_data_parallel_rank != -2:
            self.dp_rank = parallel_config.data_parallel_rank
            self.dp_group = parallel_config.stateless_init_dp_group()
        reconfig_request.new_data_parallel_master_port = \
            parallel_config.data_parallel_master_port

        self.model_executor.reinitialize_distributed(reconfig_request)
        if reconfig_request.new_data_parallel_size > old_dp_size:
            assert self.available_gpu_memory_for_kv_cache > 0
            # pass available_gpu_memory_for_kv_cache from existing
            # engine-cores to new engine-cores so they can directly
            # use it in _initialize_kv_caches() rather than profiling.
            ParallelConfig.sync_kv_cache_memory_size(
                self.dp_group, self.available_gpu_memory_for_kv_cache)
            # NOTE(yongji): newly joined workers require dummy_run even
            # CUDA graph is not used
            self.model_executor.collective_rpc("compile_or_warm_up_model")
        if reconfig_request.new_data_parallel_rank == \
        ReconfigureRankType.SHUTDOWN_CURRENT_RANK:
            self.shutdown()
            logger.info("DPEngineCoreProc %s shutdown", self.dp_rank)
        else:
            logger.info("Distributed environment reinitialized for DP rank %s",
                        self.dp_rank)

Rui Qiao's avatar
Rui Qiao committed
1134
1135
1136
1137
1138
1139
1140
1141
1142

class DPEngineCoreActor(DPEngineCoreProc):
    """
    Ray actor for running EngineCore in a data parallel context
    """

    def __init__(
        self,
        vllm_config: VllmConfig,
1143
        local_client: bool,
Rui Qiao's avatar
Rui Qiao committed
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
        addresses: EngineZmqAddresses,
        executor_class: type[Executor],
        log_stats: bool,
        dp_rank: int = 0,
        local_dp_rank: int = 0,
    ):
        self.addresses = addresses
        vllm_config.parallel_config.data_parallel_rank = dp_rank
        vllm_config.parallel_config.data_parallel_rank_local = \
            local_dp_rank

1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
        # Set CUDA_VISIBLE_DEVICES as early as possible in actor life cycle
        # NOTE: in MP we set CUDA_VISIBLE_DEVICES at process creation time,
        # and this cannot be done in the same way for Ray because:
        # 1) Ray manages life cycle of all ray workers (including
        # DPEngineCoreActor)
        # 2) Ray sets CUDA_VISIBLE_DEVICES based on num_gpus configuration
        # To bypass 2, we need to also set
        # RAY_EXPERIMENTAL_NOSET_CUDA_VISIBLE_DEVICES, but vLLM workers created
        # thereafter would have CUDA_VISIBLE_DEVICES set, which is sticky:
        # https://github.com/ray-project/ray/blob/e752fc319ddedd9779a0989b6d3613909bad75c9/python/ray/_private/worker.py#L456 # noqa: E501
1165
1166
1167
1168
1169
1170
1171
        # This is problematic because when the vLLM worker (a Ray actor)
        # executes a task, it indexes into the sticky CUDA_VISIBLE_DEVICES
        # rather than directly using the GPU ID, potentially resulting in
        # index out of bounds error. See:
        # https://github.com/ray-project/ray/pull/40461/files#diff-31e8159767361e4bc259b6d9883d9c0d5e5db780fcea4a52ead4ee3ee4a59a78R1860 # noqa: E501
        # and get_accelerator_ids_for_accelerator_resource() in worker.py
        # of ray.
1172
        self._set_cuda_visible_devices(vllm_config, local_dp_rank)
Rui Qiao's avatar
Rui Qiao committed
1173

1174
        super().__init__(vllm_config, local_client, "", executor_class,
Rui Qiao's avatar
Rui Qiao committed
1175
1176
                         log_stats)

1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
    def _set_cuda_visible_devices(self, vllm_config: VllmConfig,
                                  local_dp_rank: int):
        from vllm.platforms import current_platform
        device_control_env_var = current_platform.device_control_env_var
        world_size = vllm_config.parallel_config.world_size
        # Set CUDA_VISIBLE_DEVICES or equivalent.
        try:
            os.environ[device_control_env_var] = ",".join(
                str(current_platform.device_id_to_physical_device_id(i))
                for i in range(local_dp_rank *
                               world_size, (local_dp_rank + 1) * world_size))
        except IndexError as e:
            raise Exception(
                f"Error setting {device_control_env_var}: "
                f"local range: [{local_dp_rank * world_size}, "
                f"{(local_dp_rank + 1) * world_size}) "
                f"base value: \"{os.getenv(device_control_env_var)}\"") from e

Rui Qiao's avatar
Rui Qiao committed
1195
    @contextmanager
1196
1197
1198
    def _perform_handshakes(self, handshake_address: str, identity: bytes,
                            local_client: bool, vllm_config: VllmConfig,
                            client_handshake_address: Optional[str]):
Rui Qiao's avatar
Rui Qiao committed
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
        """
        For Ray, we don't need to actually perform handshake.
        All addresses information is known before the actor creation.
        Therefore, we simply yield these addresses.
        """
        yield self.addresses

    def wait_for_init(self):
        """
        Wait until the engine core is initialized.

        This is just an empty method. When ray.get() on this method
        (or any other method of the actor) returns, it is guaranteed
        that actor creation (i.e., __init__) is complete.
        """
        pass

    def run(self):
        """
        Run the engine core busy loop.
        """
        try:
            self.run_busy_loop()
        except SystemExit:
            logger.debug("EngineCore exiting.")
            raise
        except Exception:
            logger.exception("EngineCore encountered a fatal error.")
            raise
        finally:
            self.shutdown()