gpu_worker.py 36.9 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
"""A GPU worker class."""
4

5
6
import gc
import os
7
from contextlib import AbstractContextManager, nullcontext
8
from types import NoneType
9
from typing import TYPE_CHECKING, Any, cast
10

11
import numpy as np
12
13
import torch
import torch.distributed
14
import torch.nn as nn
15

16
import vllm.envs as envs
17
from vllm.config import CUDAGraphMode, VllmConfig
18
19
20
21
22
from vllm.distributed import (
    ensure_model_parallel_initialized,
    init_distributed_environment,
    set_custom_all_reduce,
)
23
from vllm.distributed.ec_transfer import ensure_ec_transfer_initialized
24
25
26
27
28
from vllm.distributed.kv_transfer import (
    ensure_kv_transfer_initialized,
    get_kv_transfer_group,
    has_kv_transfer_group,
)
29
from vllm.distributed.parallel_state import (
30
    get_pcp_group,
31
32
33
    get_pp_group,
    get_tp_group,
)
34
from vllm.logger import init_logger
35
from vllm.lora.request import LoRARequest
36
from vllm.model_executor import set_random_seed
37
from vllm.model_executor.models.interfaces import is_mixture_of_experts
38
from vllm.model_executor.warmup.kernel_warmup import kernel_warmup
39
from vllm.platforms import current_platform
40
from vllm.profiler.gpu_profiler import CudaProfilerWrapper, TorchProfilerWrapper
41
from vllm.sequence import IntermediateTensors
42
from vllm.tasks import SupportedTask
43
44
from vllm.utils.mem_constants import GiB_bytes
from vllm.utils.mem_utils import MemorySnapshot, memory_profiling
Woosuk Kwon's avatar
Woosuk Kwon committed
45
from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
46
from vllm.v1.engine import ReconfigureDistributedRequest, ReconfigureRankType
47
from vllm.v1.kv_cache_interface import KVCacheConfig, KVCacheSpec
48
49
50
51
52
from vllm.v1.outputs import (
    AsyncModelRunnerOutput,
    DraftTokenIds,
    ModelRunnerOutput,
)
53
from vllm.v1.utils import report_usage_stats
54
from vllm.v1.worker.gpu_model_runner import GPUModelRunner
55
from vllm.v1.worker.utils import is_residual_scattered_for_sp
56
from vllm.v1.worker.worker_base import WorkerBase
57
58
59
60

logger = init_logger(__name__)

if TYPE_CHECKING:
61
    from vllm.model_executor.model_loader.tensorizer import TensorizerConfig
62
63


64
class Worker(WorkerBase):
65
66
    def __init__(
        self,
67
        vllm_config: VllmConfig,
68
69
70
        local_rank: int,
        rank: int,
        distributed_init_method: str,
71
        is_driver_worker: bool = False,
72
    ):
73
74
75
76
77
78
79
        super().__init__(
            vllm_config=vllm_config,
            local_rank=local_rank,
            rank=rank,
            distributed_init_method=distributed_init_method,
            is_driver_worker=is_driver_worker,
        )
80
81
82

        if self.model_config.trust_remote_code:
            # note: lazy import to avoid importing torch before initializing
83
            from vllm.utils.import_utils import init_cached_hf_modules
84

85
86
            init_cached_hf_modules()

87
88
89
        # Buffers saved before sleep
        self._sleep_saved_buffers: dict[str, torch.Tensor] = {}

90
        # Torch/CUDA profiler. Enabled and configured through env vars:
91
        # VLLM_TORCH_PROFILER_DIR=/path/to/save/trace
92
93
        # VLLM_TORCH_CUDA_PROFILE=1
        self.profiler: Any | None = None
94
        if envs.VLLM_TORCH_PROFILER_DIR:
95
            worker_name = f"{vllm_config.instance_id}-rank-{self.rank}"
96
97
            self.profiler = TorchProfilerWrapper(
                worker_name=worker_name, local_rank=self.local_rank
98
            )
99
100
        elif envs.VLLM_TORCH_CUDA_PROFILE:
            self.profiler = CudaProfilerWrapper()
101
102
        else:
            self.profiler = None
103

Woosuk Kwon's avatar
Woosuk Kwon committed
104
105
        self.use_v2_model_runner = envs.VLLM_USE_V2_MODEL_RUNNER

106
    def sleep(self, level: int = 1) -> None:
107
108
        from vllm.device_allocator.cumem import CuMemAllocator

109
        free_bytes_before_sleep = torch.cuda.mem_get_info()[0]
110
111
112
113
114

        # Save the buffers before level 2 sleep
        if level == 2:
            model = self.model_runner.model
            self._sleep_saved_buffers = {
115
                name: buffer.cpu().clone() for name, buffer in model.named_buffers()
116
117
            }

118
        allocator = CuMemAllocator.get_instance()
119
        allocator.sleep(offload_tags=("weights",) if level == 1 else tuple())
120
121
122
123
124
        free_bytes_after_sleep, total = torch.cuda.mem_get_info()
        freed_bytes = free_bytes_after_sleep - free_bytes_before_sleep
        used_bytes = total - free_bytes_after_sleep
        assert freed_bytes >= 0, "Memory usage increased after sleeping."
        logger.info(
125
126
127
128
            "Sleep mode freed %.2f GiB memory, %.2f GiB memory is still in use.",
            freed_bytes / GiB_bytes,
            used_bytes / GiB_bytes,
        )
129

130
    def wake_up(self, tags: list[str] | None = None) -> None:
131
132
        from vllm.device_allocator.cumem import CuMemAllocator

133
        allocator = CuMemAllocator.get_instance()
134
        allocator.wake_up(tags)
135

136
137
138
139
140
141
142
143
        # Restore the buffers after level 2 sleep
        if len(self._sleep_saved_buffers):
            model = self.model_runner.model
            for name, buffer in model.named_buffers():
                if name in self._sleep_saved_buffers:
                    buffer.data.copy_(self._sleep_saved_buffers[name].data)
            self._sleep_saved_buffers = {}

144
    def _maybe_get_memory_pool_context(self, tag: str) -> AbstractContextManager:
145
146
147
148
149
150
        if self.vllm_config.model_config.enable_sleep_mode:
            from vllm.device_allocator.cumem import CuMemAllocator

            allocator = CuMemAllocator.get_instance()
            if tag == "weights":
                assert allocator.get_current_usage() == 0, (
151
152
                    "Sleep mode can only be used for one instance per process."
                )
153
            return allocator.use_memory_pool(tag=tag)
154
        else:
155
            return nullcontext()
156

157
    def initialize_cache(self, num_gpu_blocks: int, num_cpu_blocks: int) -> None:
158
159
160
        self.cache_config.num_gpu_blocks = num_gpu_blocks
        self.cache_config.num_cpu_blocks = num_cpu_blocks

161
    def init_device(self):
162
163
        device = self.device_config.device
        if isinstance(device, torch.device) and device.type == "cuda":
164
165
            # This env var set by Ray causes exceptions with graph building.
            os.environ.pop("NCCL_ASYNC_ERROR_HANDLING", None)
166
167
168
169
170
171
            if (
                self.parallel_config.data_parallel_size > 1
                and self.parallel_config.data_parallel_size_local > 0
                and self.parallel_config.distributed_executor_backend
                not in ["ray", "external_launcher"]
                and self.vllm_config.parallel_config.data_parallel_backend != "ray"
172
                and self.vllm_config.parallel_config.nnodes_within_dp == 1
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
            ):
                # Use local DP rank if available, otherwise use global DP rank.
                dp_local_rank = self.parallel_config.data_parallel_rank_local
                if dp_local_rank is None:
                    dp_local_rank = self.parallel_config.data_parallel_rank

                tp_pp_world_size = (
                    self.parallel_config.pipeline_parallel_size
                    * self.parallel_config.tensor_parallel_size
                )

                # DP_LOCAL_RANK * TP_PP_WORLD_SIZE + TP_LOCAL_RANK
                self.local_rank += dp_local_rank * tp_pp_world_size
                assert self.local_rank < torch.cuda.device_count(), (
                    f"DP adjusted local rank {self.local_rank} is out of bounds. "
                )
189
190
191
192
193
194
195
196
                visible_device_count = (
                    torch.cuda.device_count() if torch.cuda.is_available() else 0
                )
                assert self.parallel_config.local_world_size <= visible_device_count, (
                    f"local_world_size ({self.parallel_config.local_world_size}) must "
                    f"be less than or equal to the number of visible devices "
                    f"({visible_device_count})."
                )
197
            self.device = torch.device(f"cuda:{self.local_rank}")
198
            current_platform.set_device(self.device)
199

200
            current_platform.check_if_supports_dtype(self.model_config.dtype)
201
202
203
204
205

            # Initialize the distributed environment BEFORE taking
            # memory snapshot
            # This ensures NCCL buffers are allocated before we measure
            # available memory
206
207
208
209
210
211
212
            init_worker_distributed_environment(
                self.vllm_config,
                self.rank,
                self.distributed_init_method,
                self.local_rank,
                current_platform.dist_backend,
            )
213
214
215
216
217

            # Set random seed.
            set_random_seed(self.model_config.seed)

            # Now take memory snapshot after NCCL is initialized
218
219
            gc.collect()
            torch.cuda.empty_cache()
220
221
222

            # take current memory snapshot
            self.init_snapshot = MemorySnapshot()
223
224
225
226
            self.requested_memory = (
                self.init_snapshot.total_memory
                * self.cache_config.gpu_memory_utilization
            )
227
            if self.init_snapshot.free_memory < self.requested_memory:
228
229
                GiB = lambda b: round(b / GiB_bytes, 2)
                raise ValueError(
230
231
232
233
                    f"Free memory on device "
                    f"({GiB(self.init_snapshot.free_memory)}/"
                    f"{GiB(self.init_snapshot.total_memory)} GiB) on startup "
                    f"is less than desired GPU memory utilization "
234
                    f"({self.cache_config.gpu_memory_utilization}, "
235
                    f"{GiB(self.requested_memory)} GiB). Decrease GPU memory "
236
237
                    f"utilization or reduce GPU memory used by other processes."
                )
238
        else:
239
            raise RuntimeError(f"Not support device type: {self.device_config.device}")
240

241
        # Construct the model runner
Woosuk Kwon's avatar
Woosuk Kwon committed
242
243
244
245
246
247
248
249
250
251
252
        if self.use_v2_model_runner:
            from vllm.v1.worker.gpu.model_runner import (
                GPUModelRunner as GPUModelRunnerV2,
            )

            # HACK(woosuk): This is a temporary fix to avoid type errors.
            self.model_runner: GPUModelRunner = GPUModelRunnerV2(  # type: ignore
                self.vllm_config, self.device
            )
        else:
            self.model_runner = GPUModelRunner(self.vllm_config, self.device)
253

254
255
256
257
        if self.rank == 0:
            # If usage stat is enabled, collect relevant info.
            report_usage_stats(self.vllm_config)

258
259
    # FIXME(youkaichao & ywang96): Use TorchDispatchMode instead of memory pool
    # to hijack tensor allocation.
260
    def load_model(self) -> None:
261
        eep_scale_up = os.environ.get("VLLM_ELASTIC_EP_SCALE_UP_LAUNCH") == "1"
262
        with self._maybe_get_memory_pool_context(tag="weights"):
263
            self.model_runner.load_model(eep_scale_up=eep_scale_up)
264

265
266
267
    def update_config(self, overrides: dict[str, Any]) -> None:
        self.model_runner.update_config(overrides)

268
    def reload_weights(self) -> None:
269
        self.model_runner.reload_weights()
270

271
    @torch.inference_mode()
272
    def determine_available_memory(self) -> int:
273
        """Profiles the peak memory usage of the model to determine how much
274
        memory can be used for KV cache without OOMs.
275
276

        The engine will first conduct a profiling of the existing memory usage.
277
        Then, it calculates the free memory that can be used for KV cache in
278
        bytes.
279

280
281
282
        Tip:
            You may limit the usage of GPU memory
            by adjusting the `gpu_memory_utilization` parameter.
283
        """
284
285
286
287
288
289
290
        GiB = lambda b: b / GiB_bytes
        if kv_cache_memory_bytes := self.cache_config.kv_cache_memory_bytes:
            # still need a profile run which compiles the model for
            # max_num_batched_tokens
            self.model_runner.profile_run()

            msg = (
291
292
                f"Initial free memory {GiB(self.init_snapshot.free_memory):.2f} "
                f"GiB, reserved {GiB(kv_cache_memory_bytes):.2f} GiB memory for "
293
                "KV Cache as specified by kv_cache_memory_bytes config and "
294
                "skipped memory profiling. This does not respect the "
295
296
297
298
299
                "gpu_memory_utilization config. Only use kv_cache_memory_bytes "
                "config when you want manual control of KV cache memory "
                "size. If OOM'ed, check the difference of initial free "
                "memory between the current run and the previous run "
                "where kv_cache_memory_bytes is suggested and update it "
300
301
                "correspondingly."
            )
302
303
304
            logger.info(msg)
            return kv_cache_memory_bytes

305
        torch.cuda.empty_cache()
306
        torch.cuda.reset_peak_memory_stats()
307
308
309

        # Execute a forward pass with dummy inputs to profile the memory usage
        # of the model.
310
        with memory_profiling(
311
312
            self.init_snapshot,
            weights_memory=int(self.model_runner.model_memory_usage),
313
        ) as profile_result:
314
            self.model_runner.profile_run()
315

316
317
318
        self.non_torch_memory = profile_result.non_torch_increase
        self.peak_activation_memory = profile_result.torch_peak_increase

319
        free_gpu_memory = profile_result.after_profile.free_memory
320
321
        # NOTE(woosuk): Here we assume that the other processes using the same
        # GPU did not change their memory usage during the profiling.
322
        assert self.init_snapshot.free_memory > free_gpu_memory, (
323
            "Error in memory profiling. "
324
325
326
327
328
            f"Initial free memory {GiB(self.init_snapshot.free_memory)} GiB, "
            f"current free memory {GiB(free_gpu_memory)} GiB. "
            "This happens when other processes sharing the same container "
            "release GPU memory while vLLM is profiling during initialization. "
            "To fix this, ensure consistent GPU memory allocation or "
329
330
331
332
333
            "isolate vLLM in its own container."
        )
        self.available_kv_cache_memory_bytes = (
            self.requested_memory - profile_result.non_kv_cache_memory
        )
334

335
        unrequested_memory = self.init_snapshot.free_memory - self.requested_memory
336
        logger.debug(
337
            "Initial free memory: %.2f GiB; Requested memory: %.2f (util), %.2f GiB",
338
339
340
341
342
343
344
345
346
347
            GiB(self.init_snapshot.free_memory),
            self.cache_config.gpu_memory_utilization,
            GiB(self.requested_memory),
        )
        logger.debug(
            "Free memory after profiling: %.2f GiB (total), "
            "%.2f GiB (within requested)",
            GiB(free_gpu_memory),
            GiB(free_gpu_memory - unrequested_memory),
        )
348
        logger.debug(profile_result)
349
        logger.info_once(
350
351
            "Available KV cache memory: %.2f GiB",
            GiB(self.available_kv_cache_memory_bytes),
352
            scope="local",
353
        )
354
        gc.collect()
355

356
        return int(self.available_kv_cache_memory_bytes)
357

358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
    def get_kv_connector_handshake_metadata(self) -> dict | None:
        """Get KV connector metadata from this worker if available."""

        if not has_kv_transfer_group():
            return None

        connector = get_kv_transfer_group()
        # Return None for connectors that don't need to exchange handshake
        # metadata across workers.
        if (metadata := connector.get_handshake_metadata()) is None:
            return None

        tp_rank = get_tp_group().rank_in_group
        return {tp_rank: metadata}

373
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
374
375
        return self.model_runner.get_kv_cache_spec()

376
    def initialize_from_config(self, kv_cache_config: KVCacheConfig) -> None:
377
        """Allocate GPU KV cache with the specified kv_cache_config."""
378

379
380
381
382
383
        # Init kv cache connector here, because it requires
        # `kv_cache_config`.
        # NOTE(Kuntai): This need to be done before `initialize_kv_cache`,
        # because `initialize_kv_cache` will inject kv cache groups not
        # related to kv cache connector (e.g. kv cache sharing layers).
384
        ensure_kv_transfer_initialized(self.vllm_config, kv_cache_config)
385

386
        if self.vllm_config.model_config.enable_sleep_mode:
387
388
            from vllm.device_allocator.cumem import CuMemAllocator

389
            allocator = CuMemAllocator.get_instance()
390
391
            with allocator.use_memory_pool(tag="kv_cache"):
                self.model_runner.initialize_kv_cache(kv_cache_config)
392
393
        else:
            self.model_runner.initialize_kv_cache(kv_cache_config)
394
395

    def compile_or_warm_up_model(self) -> None:
396
397
398
        # warm up sizes that are not in cudagraph capture sizes,
        # but users still want to compile for better performance,
        # e.g. for the max-num-batched token size in chunked prefill.
399
400
        compile_sizes = self.vllm_config.compilation_config.compile_sizes
        warmup_sizes = compile_sizes.copy() if compile_sizes is not None else []
401
        if not self.model_config.enforce_eager:
402
403
404
            capture_sizes = self.vllm_config.compilation_config.cudagraph_capture_sizes
            if capture_sizes is not None:
                warmup_sizes = [x for x in warmup_sizes if x not in capture_sizes]
405
        # We skip EPLB here since we don't want to record dummy metrics
406
407
        for size in sorted(warmup_sizes, reverse=True):
            logger.info("Compile and warming up model for size %d", size)
408
            self.model_runner._dummy_run(size, skip_eplb=True, remove_lora=False)
409
        self.model_runner.maybe_remove_all_loras(self.model_runner.lora_config)
410

411
412
413
414
        # Warmup and tune the kernels used during model execution before
        # cuda graph capture.
        kernel_warmup(self)

415
        cuda_graph_memory_bytes = 0
416
        if not self.model_config.enforce_eager:
417
418
            cuda_graph_memory_bytes = self.model_runner.capture_model()

419
420
421
        if self.cache_config.kv_cache_memory_bytes is None and hasattr(
            self, "peak_activation_memory"
        ):
422
423
424
425
426
427
428
429
430
431
432
433
434
            # Suggests optimal kv cache memory size if we rely on
            # memory_profiling to guess the kv cache memory size which
            # provides peak_activation_memory and a few other memory
            # consumption. `memory_profiling` does not consider
            # CUDAGraph memory size and may not utilize all gpu memory.
            # Users may want fine-grained control to specify kv cache
            # memory size.
            GiB = lambda b: round(b / GiB_bytes, 2)

            # empirically observed that the memory profiling may
            # slightly underestimate the memory consumption.
            # So leave a small buffer (=150MiB) to avoid OOM.
            redundancy_buffer_memory = 150 * (1 << 20)
435
436
437
438
439
440
            non_kv_cache_memory = (
                self.model_runner.model_memory_usage
                + self.peak_activation_memory
                + self.non_torch_memory
                + cuda_graph_memory_bytes
            )
441
            kv_cache_memory_bytes_to_gpu_limit = (
442
443
444
445
                self.init_snapshot.free_memory
                - non_kv_cache_memory
                - redundancy_buffer_memory
            )
446
            kv_cache_memory_bytes_to_requested_limit = (
447
448
449
450
                int(self.requested_memory)
                - non_kv_cache_memory
                - redundancy_buffer_memory
            )
451
452
453
454
455
456
457
458
459
460
461
462
463
464

            msg = (
                f"Free memory on device "
                f"({GiB(self.init_snapshot.free_memory)}/"
                f"{GiB(self.init_snapshot.total_memory)} GiB) on startup. "
                f"Desired GPU memory utilization is "
                f"({self.cache_config.gpu_memory_utilization}, "
                f"{GiB(self.requested_memory)} GiB). "
                f"Actual usage is {GiB(self.model_runner.model_memory_usage)} "
                f"GiB for weight, {GiB(self.peak_activation_memory)} GiB "
                f"for peak activation, {GiB(self.non_torch_memory)} GiB "
                f"for non-torch memory, and {GiB(cuda_graph_memory_bytes)} "
                f"GiB for CUDAGraph memory. Replace gpu_memory_utilization "
                f"config with `--kv-cache-memory="
465
466
467
468
469
                f"{kv_cache_memory_bytes_to_requested_limit}` "
                f"({GiB(kv_cache_memory_bytes_to_requested_limit)} GiB) to fit "
                f"into requested memory, or `--kv-cache-memory="
                f"{kv_cache_memory_bytes_to_gpu_limit}` "
                f"({GiB(kv_cache_memory_bytes_to_gpu_limit)} GiB) to fully "
470
                f"utilize gpu memory. Current kv cache memory in use is "
471
472
                f"{GiB(self.available_kv_cache_memory_bytes)} GiB."
            )
473

474
            logger.debug(msg)
475
476
477
478
479
480

        # Warm up sampler and preallocate memory buffer for logits and other
        # sampling related tensors of max possible shape to avoid memory
        # fragmentation issue.
        # NOTE: This is called after `capture_model` on purpose to prevent
        # memory buffers from being cleared by `torch.cuda.empty_cache`.
481
        if get_pp_group().is_last_rank:
482
483
484
485
            max_num_reqs = min(
                self.scheduler_config.max_num_seqs,
                self.scheduler_config.max_num_batched_tokens,
            )
486

487
            # We skip EPLB here since we don't want to record dummy metrics
488
489
490
            hidden_states, last_hidden_states = self.model_runner._dummy_run(
                num_tokens=max_num_reqs,
                skip_eplb=True,
491
                cudagraph_runtime_mode=CUDAGraphMode.NONE,
492
            )
493
494
495
            if self.model_runner.is_pooling_model:
                self.model_runner._dummy_pooler_run(hidden_states)
            else:
496
                self.model_runner._dummy_sampler_run(hidden_states=last_hidden_states)
497

498
499
500
501
        # Reset the seed to ensure that the random state is not affected by
        # the model initialization and profiling.
        set_random_seed(self.model_config.seed)

502
503
504
    def reset_mm_cache(self) -> None:
        self.model_runner.reset_mm_cache()

505
506
507
    def get_model(self) -> nn.Module:
        return self.model_runner.get_model()

508
509
    def get_supported_tasks(self) -> tuple[SupportedTask, ...]:
        return self.model_runner.get_supported_tasks()
510

511
512
513
514
515
516
    def annotate_profile(self, scheduler_output):
        # add trace annotation so that we can easily distinguish
        # new/cached request numbers in each iteration
        if not self.profiler:
            return nullcontext()

517
518
        self.profiler.step()

519
520
521
        num_new = len(scheduler_output.scheduled_new_reqs)
        num_cached = len(scheduler_output.scheduled_cached_reqs.req_ids)

522
        return self.profiler.annotate_context_manager(
523
524
525
            f"execute_new_{num_new}_cached_{num_cached}"
        )

526
527
    @torch.inference_mode()
    def sample_tokens(
528
        self, grammar_output: "GrammarOutput | None"
529
530
531
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput:
        return self.model_runner.sample_tokens(grammar_output)

532
533
    @torch.inference_mode()
    def execute_model(
534
535
        self, scheduler_output: "SchedulerOutput"
    ) -> ModelRunnerOutput | None:
536
        intermediate_tensors = None
537
        forward_pass = scheduler_output.total_num_scheduled_tokens > 0
538
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
        all_gather_tensors = {}
        compilation_config = self.vllm_config.compilation_config
        parallel_config = self.vllm_config.parallel_config

        if (
            parallel_config.pipeline_parallel_size > 1
            and compilation_config.pass_config.enable_sequence_parallelism
            and forward_pass
        ):
            # currently only supported by V1 GPUModelRunner
            assert isinstance(self.model_runner, GPUModelRunner)
            num_scheduled_tokens_np = np.array(
                list(scheduler_output.num_scheduled_tokens.values()),
                dtype=np.int32,
            )
            # TODO(lucas): This is pretty gross; ideally we should only ever call
            # `_determine_batch_execution_and_padding` once (will get called again
            # in `execute_model`) but this requires a larger refactor of PP.
            _, batch_desc, _, _ = (
                self.model_runner._determine_batch_execution_and_padding(
                    num_tokens=num_scheduled_tokens,
                    num_reqs=len(num_scheduled_tokens_np),
                    num_scheduled_tokens_np=num_scheduled_tokens_np,
                    max_num_scheduled_tokens=num_scheduled_tokens_np.max(),
                    use_cascade_attn=False,  # TODO(lucas): Handle cascade attention
                )
565
            )
566
567
568
569
570
571
            all_gather_tensors = {
                "residual": not is_residual_scattered_for_sp(
                    self.vllm_config, batch_desc.num_tokens
                )
            }

572
        if forward_pass and not get_pp_group().is_first_rank:
573
574
575
            tensor_dict = get_pp_group().recv_tensor_dict(
                all_gather_group=get_tp_group(),
                all_gather_tensors=all_gather_tensors,
576
            )
577
578
            assert tensor_dict is not None
            intermediate_tensors = IntermediateTensors(tensor_dict)
579

580
581
582
583
584
585
        with self.annotate_profile(scheduler_output):
            output = self.model_runner.execute_model(
                scheduler_output, intermediate_tensors
            )
            if isinstance(output, (ModelRunnerOutput, NoneType)):
                return output
586

587
        assert isinstance(output, IntermediateTensors)
588
        parallel_config = self.vllm_config.parallel_config
589
        assert (
590
            parallel_config.distributed_executor_backend != "external_launcher"
591
592
            and not get_pp_group().is_last_rank
        )
593

594
595
596
597
598
        get_pp_group().send_tensor_dict(
            output.tensors,
            all_gather_group=get_tp_group(),
            all_gather_tensors=all_gather_tensors,
        )
599

600
        return None
601

602
    def take_draft_token_ids(self) -> DraftTokenIds | None:
603
604
        return self.model_runner.take_draft_token_ids()

605
    def profile(self, is_start: bool = True):
606
        if self.profiler is None:
607
            raise RuntimeError("Profiling is not enabled.")
608
609
610
611
612
        if is_start:
            self.profiler.start()
        else:
            self.profiler.stop()

613
    def execute_dummy_batch(self) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
614
615
616
617
618
619
        if self.use_v2_model_runner:
            self.model_runner.execute_model(
                SchedulerOutput.make_empty(), dummy_run=True
            )
        else:
            self.model_runner._dummy_run(1, uniform_decode=True)
620

621
622
623
    def add_lora(self, lora_request: LoRARequest) -> bool:
        return self.model_runner.add_lora(lora_request)

624
625
626
    def remove_lora(self, lora_id: int) -> bool:
        return self.model_runner.remove_lora(lora_id)

627
    def list_loras(self) -> set[int]:
628
629
630
631
632
        return self.model_runner.list_loras()

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

633
634
635
636
    def check_health(self) -> None:
        # worker will always be healthy as long as it's running.
        return

637
    def _eplb_before_scale_down(self, old_ep_size: int, new_ep_size: int) -> None:
638
        from vllm.distributed.parallel_state import get_ep_group
639

640
        if get_ep_group().rank == 0:
641
642
643
            logger.info(
                "[Elastic EP] Starting expert resharding before scaling down..."
            )
644
645
646
647
648
        rank_mapping = {
            old_ep_rank: old_ep_rank if old_ep_rank < new_ep_size else -1
            for old_ep_rank in range(old_ep_size)
        }
        assert self.model_runner.eplb_state is not None
649
650
        self.model_runner.eplb_state.rearrange(
            execute_shuffle=True,
651
            global_expert_loads=None,
652
653
            rank_mapping=rank_mapping,
        )
654
655
656
657
658
        torch.cuda.synchronize()
        if get_ep_group().rank == 0:
            logger.info("[Elastic EP] Expert resharding completed!")

    def _eplb_after_scale_up(
659
660
661
        self,
        old_ep_size: int,
        new_ep_size: int,
662
        global_expert_loads: list[torch.Tensor] | None,
663
    ) -> None:
664
        from vllm.distributed.parallel_state import get_ep_group
665

666
        if get_ep_group().rank == 0:
667
668
            logger.info("[Elastic EP] Starting expert resharding after scaling up...")
        rank_mapping = {old_ep_rank: old_ep_rank for old_ep_rank in range(old_ep_size)}
669
670
671
        assert self.model_runner.eplb_state is not None
        self.model_runner.eplb_state.rearrange(
            execute_shuffle=True,
672
            global_expert_loads=global_expert_loads,
673
674
            rank_mapping=rank_mapping,
        )
675
676
677
678
        if get_ep_group().rank == 0:
            logger.info("[Elastic EP] Expert resharding completed!")

    def _reconfigure_parallel_config(
679
680
        self, reconfig_request: ReconfigureDistributedRequest
    ) -> None:
681
682
683
684
        """
        Update parallel config with provided reconfig_request
        """
        parallel_config = self.vllm_config.parallel_config
685
686
687
688
689
690
691
692
693
694
695
        parallel_config.data_parallel_size = reconfig_request.new_data_parallel_size
        if (
            reconfig_request.new_data_parallel_rank
            != ReconfigureRankType.KEEP_CURRENT_RANK
        ):
            parallel_config.data_parallel_rank = reconfig_request.new_data_parallel_rank
        if (
            reconfig_request.new_data_parallel_rank_local
            != ReconfigureRankType.KEEP_CURRENT_RANK
        ):
            parallel_config.data_parallel_rank_local = (
696
                reconfig_request.new_data_parallel_rank_local
697
698
            )
        parallel_config.data_parallel_master_ip = (
699
            reconfig_request.new_data_parallel_master_ip
700
701
        )
        parallel_config.data_parallel_master_port = (
702
            reconfig_request.new_data_parallel_master_port
703
        )
704

705
706
    def _reconfigure_moe(
        self, old_ep_size: int, new_ep_size: int
707
    ) -> list[torch.Tensor] | None:
708
709
710
711
712
713
714
        """
        Reconfigure MoE modules with provided reconfig_request

        Return the global expert load if new_ep_size > old_ep_size,
        otherwise None
        """
        from vllm.distributed.parallel_state import (
715
716
717
718
            get_dp_group,
            get_ep_group,
            prepare_communication_buffer_for_model,
        )
719
720
721
722
        from vllm.model_executor.layers.fused_moe.layer import (
            FusedMoE,
            FusedMoEParallelConfig,
        )
723
724

        parallel_config = self.vllm_config.parallel_config
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745

        def get_moe_modules(model: torch.nn.Module) -> list[FusedMoE]:
            return [
                module
                for module in model.modules()
                if (
                    module.__class__.__name__ == "FusedMoE"
                    or module.__class__.__name__ == "SharedFusedMoE"
                )
            ]

        def update_moe_modules(moe_modules: list[FusedMoE], num_local_experts: int):
            assert all(
                module.moe_config.num_local_experts == num_local_experts
                for module in moe_modules
            ), "All MoE modules must have the same number of experts"
            for module in moe_modules:
                module.moe_config.num_experts = num_local_experts * new_ep_size
                module.global_num_experts = module.moe_config.num_experts
                module.moe_parallel_config = FusedMoEParallelConfig.make(
                    tp_size_=get_tp_group().world_size,
746
                    pcp_size_=get_pcp_group().world_size,
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
                    dp_size_=get_dp_group().world_size,
                    vllm_parallel_config=parallel_config,
                )
                module.moe_config.moe_parallel_config = module.moe_parallel_config
            return moe_modules

        model_moe_modules = get_moe_modules(self.model_runner.model)
        num_local_experts = model_moe_modules[0].moe_config.num_local_experts

        update_moe_modules(model_moe_modules, num_local_experts)
        drafter_model = None
        if hasattr(self.model_runner, "drafter") and hasattr(
            self.model_runner.drafter, "model"
        ):
            drafter_model = self.model_runner.drafter.model
        if drafter_model is not None and is_mixture_of_experts(drafter_model):
            drafter_moe_modules = get_moe_modules(drafter_model)
            # Check if drafter and model have matching configs
            assert (
                drafter_moe_modules[0].moe_config.num_local_experts == num_local_experts
            ), "Drafter and model configs should be the same"
            update_moe_modules(drafter_moe_modules, num_local_experts)

770
771
772
        if new_ep_size < old_ep_size:
            num_local_physical_experts = num_local_experts
            assert self.model_runner.eplb_state is not None
773
            new_physical_experts = (
774
                self.model_runner.eplb_state.physical_to_logical_map.shape[1]  # type: ignore[attr-defined]
775
            )
776
            parallel_config.eplb_config.num_redundant_experts = (
777
                new_physical_experts
778
                - self.model_runner.eplb_state.logical_replica_count.shape[1]  # type: ignore[attr-defined]
779
            )
780
            global_expert_loads = None
781
        else:
782
            num_local_physical_experts_tensor = torch.tensor(
783
784
785
                [num_local_experts], dtype=torch.int32, device="cpu"
            )
            torch.distributed.broadcast(
786
787
788
                num_local_physical_experts_tensor,
                group=get_ep_group().cpu_group,
                group_src=0,
789
            )
790
            num_local_physical_experts = int(num_local_physical_experts_tensor.item())
791
792
            new_physical_experts = num_local_physical_experts * new_ep_size
            assert self.model_runner.eplb_state is not None
793
            global_expert_loads_any = self.model_runner.eplb_state.rearrange(
794
                execute_shuffle=False
795
            )
796
            global_expert_loads = cast(list[torch.Tensor], global_expert_loads_any)
797
            parallel_config.eplb_config.num_redundant_experts = (
798
                new_physical_experts - global_expert_loads[0].shape[1]
799
            )
800
        prepare_communication_buffer_for_model(self.model_runner.model)
801
802
        if drafter_model is not None:
            prepare_communication_buffer_for_model(drafter_model)
803
804
        self.model_runner.model.update_physical_experts_metadata(
            num_physical_experts=new_physical_experts,
805
806
            num_local_physical_experts=num_local_physical_experts,
        )
807
        return global_expert_loads
808
809

    def reinitialize_distributed(
810
811
        self, reconfig_request: ReconfigureDistributedRequest
    ) -> None:
812
813
        from vllm.config import set_current_vllm_config
        from vllm.distributed.parallel_state import (
814
815
816
            cleanup_dist_env_and_memory,
            get_ep_group,
        )
817
818
819

        old_ep_size = get_ep_group().world_size
        old_ep_rank = get_ep_group().rank
820
821
822
823
824
        new_ep_size = (
            reconfig_request.new_data_parallel_size
            * get_tp_group().world_size
            * get_pp_group().world_size
        )
825
826
827
828
829
        if new_ep_size < old_ep_size:
            self._eplb_before_scale_down(old_ep_size, new_ep_size)

        cleanup_dist_env_and_memory()

830
831
832
833
        if (
            reconfig_request.new_data_parallel_rank
            == ReconfigureRankType.SHUTDOWN_CURRENT_RANK
        ):
834
835
836
837
838
839
840
            assert old_ep_rank >= new_ep_size
            # shutdown
            return

        self._reconfigure_parallel_config(reconfig_request)

        with set_current_vllm_config(self.vllm_config):
841
842
843
844
845
846
            init_worker_distributed_environment(
                self.vllm_config,
                self.rank,
                self.distributed_init_method,
                self.local_rank,
            )
847

848
        global_expert_loads = self._reconfigure_moe(old_ep_size, new_ep_size)
849
850

        if new_ep_size > old_ep_size:
851
852
            assert global_expert_loads is not None
            self._eplb_after_scale_up(old_ep_size, new_ep_size, global_expert_loads)
853

854
855
856
    def save_sharded_state(
        self,
        path: str,
857
858
        pattern: str | None = None,
        max_size: int | None = None,
859
    ) -> None:
860
        from vllm.model_executor.model_loader import ShardedStateLoader
861

862
863
864
865
866
867
868
        ShardedStateLoader.save_model(
            self.model_runner.model,
            path,
            pattern=pattern,
            max_size=max_size,
        )

869
870
871
872
873
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        self.model_runner.save_tensorized_model(
874
875
            tensorizer_config=tensorizer_config,
        )
876

877
    def shutdown(self) -> None:
878
879
        if runner := getattr(self, "model_runner", None):
            runner.ensure_kv_transfer_shutdown()
880
881
        if self.profiler is not None:
            self.profiler.shutdown()
882

883
884

def init_worker_distributed_environment(
885
    vllm_config: VllmConfig,
886
    rank: int,
887
    distributed_init_method: str | None = None,
888
    local_rank: int = -1,
889
    backend: str = "nccl",
890
891
) -> None:
    """Initialize the distributed environment."""
892
    parallel_config = vllm_config.parallel_config
893
894
895
    from vllm.model_executor.layers.batch_invariant import init_batch_invariance

    init_batch_invariance()
896
897
    set_custom_all_reduce(not parallel_config.disable_custom_all_reduce)

898
    init_method = distributed_init_method or "env://"
899
    init_distributed_environment(
900
        parallel_config.world_size, rank, init_method, local_rank, backend
901
    )
902

903
904
905
    ensure_model_parallel_initialized(
        parallel_config.tensor_parallel_size,
        parallel_config.pipeline_parallel_size,
906
        parallel_config.prefill_context_parallel_size,
907
908
        parallel_config.decode_context_parallel_size,
    )
909
910
911
912

    # Init ec connector here before KV caches caches init
    # NOTE: We do not init KV caches for Encoder-only instance in EPD disagg mode
    ensure_ec_transfer_initialized(vllm_config)