gpu_worker.py 38.5 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
from vllm.config.compilation import CompilationMode
19
20
21
22
23
from vllm.distributed import (
    ensure_model_parallel_initialized,
    init_distributed_environment,
    set_custom_all_reduce,
)
24
from vllm.distributed.ec_transfer import ensure_ec_transfer_initialized
25
26
27
28
29
from vllm.distributed.kv_transfer import (
    ensure_kv_transfer_initialized,
    get_kv_transfer_group,
    has_kv_transfer_group,
)
30
from vllm.distributed.parallel_state import (
31
    get_pcp_group,
32
33
34
    get_pp_group,
    get_tp_group,
)
35
from vllm.logger import init_logger
36
from vllm.lora.request import LoRARequest
37
from vllm.model_executor import set_random_seed
38
from vllm.model_executor.models.interfaces import is_mixture_of_experts
39
from vllm.model_executor.warmup.kernel_warmup import kernel_warmup
40
from vllm.platforms import current_platform
41
from vllm.profiler.wrapper import CudaProfilerWrapper, TorchProfilerWrapper
42
from vllm.sequence import IntermediateTensors
43
from vllm.tasks import SupportedTask
44
45
from vllm.utils.mem_constants import GiB_bytes
from vllm.utils.mem_utils import MemorySnapshot, memory_profiling
Woosuk Kwon's avatar
Woosuk Kwon committed
46
from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
47
from vllm.v1.engine import ReconfigureDistributedRequest, ReconfigureRankType
48
from vllm.v1.kv_cache_interface import KVCacheConfig, KVCacheSpec
49
50
51
52
53
from vllm.v1.outputs import (
    AsyncModelRunnerOutput,
    DraftTokenIds,
    ModelRunnerOutput,
)
54
from vllm.v1.utils import report_usage_stats
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
    from vllm.v1.worker.gpu_model_runner import GPUModelRunner
63
64


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

82
83
84
85
        # configure float32 matmul precision according to vLLM env.
        precision = envs.VLLM_FLOAT32_MATMUL_PRECISION
        torch.set_float32_matmul_precision(precision)

86
87
        if self.model_config.trust_remote_code:
            # note: lazy import to avoid importing torch before initializing
88
            from vllm.utils.import_utils import init_cached_hf_modules
89

90
91
            init_cached_hf_modules()

92
93
94
        # Buffers saved before sleep
        self._sleep_saved_buffers: dict[str, torch.Tensor] = {}

95
        # Torch/CUDA profiler. Enabled and configured through profiler_config.
96
        self.profiler: Any | None = None
97
98
        profiler_config = vllm_config.profiler_config
        if profiler_config.profiler == "torch":
99
            worker_name = f"{vllm_config.instance_id}-rank-{self.rank}"
100
            self.profiler = TorchProfilerWrapper(
101
102
103
104
                profiler_config,
                worker_name=worker_name,
                local_rank=self.local_rank,
                activities=["CPU", "CUDA"],
105
            )
106
107
        elif profiler_config.profiler == "cuda":
            self.profiler = CudaProfilerWrapper(profiler_config)
108
109
        else:
            self.profiler = None
110

Woosuk Kwon's avatar
Woosuk Kwon committed
111
112
        self.use_v2_model_runner = envs.VLLM_USE_V2_MODEL_RUNNER

113
    def sleep(self, level: int = 1) -> None:
114
115
        from vllm.device_allocator.cumem import CuMemAllocator

116
        free_bytes_before_sleep = torch.cuda.mem_get_info()[0]
117
118
119
120
121

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

125
        allocator = CuMemAllocator.get_instance()
126
        allocator.sleep(offload_tags=("weights",) if level == 1 else tuple())
127
128
129
130
131
        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(
132
133
134
135
            "Sleep mode freed %.2f GiB memory, %.2f GiB memory is still in use.",
            freed_bytes / GiB_bytes,
            used_bytes / GiB_bytes,
        )
136

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

140
        allocator = CuMemAllocator.get_instance()
141
        allocator.wake_up(tags)
142

143
144
145
146
147
148
149
150
        # 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 = {}

151
152
153
154
155
156
157
158
159
160
        # If the KV cache has just been woken up,
        # the internal state of cache_engine must be reset,
        # especially the FP8 scaling factor.
        if (
            (tags is None or "kv_cache" in tags)
            and self.cache_config.cache_dtype.startswith("fp8")
            and hasattr(self.model_runner, "init_fp8_kv_scales")
        ):
            self.model_runner.init_fp8_kv_scales()

161
    def _maybe_get_memory_pool_context(self, tag: str) -> AbstractContextManager:
162
163
164
165
166
167
        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, (
168
169
                    "Sleep mode can only be used for one instance per process."
                )
170
            return allocator.use_memory_pool(tag=tag)
171
        else:
172
            return nullcontext()
173

174
    def initialize_cache(self, num_gpu_blocks: int, num_cpu_blocks: int) -> None:
175
176
177
        self.cache_config.num_gpu_blocks = num_gpu_blocks
        self.cache_config.num_cpu_blocks = num_cpu_blocks

178
    def init_device(self):
179
180
        device = self.device_config.device
        if isinstance(device, torch.device) and device.type == "cuda":
181
182
            # This env var set by Ray causes exceptions with graph building.
            os.environ.pop("NCCL_ASYNC_ERROR_HANDLING", None)
183
184
185
186
187
188
            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"
189
                and self.vllm_config.parallel_config.nnodes_within_dp == 1
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
            ):
                # 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. "
                )
206
207
208
209
210
211
212
213
                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})."
                )
214
            self.device = torch.device(f"cuda:{self.local_rank}")
215
            current_platform.set_device(self.device)
216

217
            current_platform.check_if_supports_dtype(self.model_config.dtype)
218
219
220
221
222

            # Initialize the distributed environment BEFORE taking
            # memory snapshot
            # This ensures NCCL buffers are allocated before we measure
            # available memory
223
224
225
226
227
228
229
            init_worker_distributed_environment(
                self.vllm_config,
                self.rank,
                self.distributed_init_method,
                self.local_rank,
                current_platform.dist_backend,
            )
230
231
232
233
234

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

            # Now take memory snapshot after NCCL is initialized
235
236
            gc.collect()
            torch.cuda.empty_cache()
237
238
239

            # take current memory snapshot
            self.init_snapshot = MemorySnapshot()
240
241
242
243
            self.requested_memory = (
                self.init_snapshot.total_memory
                * self.cache_config.gpu_memory_utilization
            )
244
            if self.init_snapshot.free_memory < self.requested_memory:
245
246
                GiB = lambda b: round(b / GiB_bytes, 2)
                raise ValueError(
247
248
249
250
                    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 "
251
                    f"({self.cache_config.gpu_memory_utilization}, "
252
                    f"{GiB(self.requested_memory)} GiB). Decrease GPU memory "
253
254
                    f"utilization or reduce GPU memory used by other processes."
                )
255
        else:
256
            raise RuntimeError(f"Not support device type: {self.device_config.device}")
257

258
        # Construct the model runner
Woosuk Kwon's avatar
Woosuk Kwon committed
259
260
261
262
263
264
265
266
267
268
        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:
269
270
271
272
273
            from vllm.v1.worker.gpu_model_runner import (
                GPUModelRunner as GPUModelRunnerV1,
            )

            self.model_runner = GPUModelRunnerV1(self.vllm_config, self.device)
274

275
276
277
278
        if self.rank == 0:
            # If usage stat is enabled, collect relevant info.
            report_usage_stats(self.vllm_config)

279
280
    # FIXME(youkaichao & ywang96): Use TorchDispatchMode instead of memory pool
    # to hijack tensor allocation.
281
    def load_model(self) -> None:
282
        eep_scale_up = os.environ.get("VLLM_ELASTIC_EP_SCALE_UP_LAUNCH") == "1"
283
        with self._maybe_get_memory_pool_context(tag="weights"):
284
            self.model_runner.load_model(eep_scale_up=eep_scale_up)
285

286
287
288
    def update_config(self, overrides: dict[str, Any]) -> None:
        self.model_runner.update_config(overrides)

289
    def reload_weights(self) -> None:
290
        self.model_runner.reload_weights()
291

292
    @torch.inference_mode()
293
    def determine_available_memory(self) -> int:
294
        """Profiles the peak memory usage of the model to determine how much
295
        memory can be used for KV cache without OOMs.
296
297

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

301
302
303
        Tip:
            You may limit the usage of GPU memory
            by adjusting the `gpu_memory_utilization` parameter.
304
        """
305
306
307
308
309
310
311
        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 = (
312
313
                f"Initial free memory {GiB(self.init_snapshot.free_memory):.2f} "
                f"GiB, reserved {GiB(kv_cache_memory_bytes):.2f} GiB memory for "
314
                "KV Cache as specified by kv_cache_memory_bytes config and "
315
                "skipped memory profiling. This does not respect the "
316
317
318
319
320
                "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 "
321
322
                "correspondingly."
            )
323
324
325
            logger.info(msg)
            return kv_cache_memory_bytes

326
        torch.cuda.empty_cache()
327
        torch.cuda.reset_peak_memory_stats()
328
329
330

        # Execute a forward pass with dummy inputs to profile the memory usage
        # of the model.
331
        with memory_profiling(
332
333
            self.init_snapshot,
            weights_memory=int(self.model_runner.model_memory_usage),
334
        ) as profile_result:
335
            self.model_runner.profile_run()
336

337
338
339
        self.non_torch_memory = profile_result.non_torch_increase
        self.peak_activation_memory = profile_result.torch_peak_increase

340
        free_gpu_memory = profile_result.after_profile.free_memory
341
342
        # NOTE(woosuk): Here we assume that the other processes using the same
        # GPU did not change their memory usage during the profiling.
343
        assert self.init_snapshot.free_memory > free_gpu_memory, (
344
            "Error in memory profiling. "
345
346
347
348
349
            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 "
350
351
352
353
354
            "isolate vLLM in its own container."
        )
        self.available_kv_cache_memory_bytes = (
            self.requested_memory - profile_result.non_kv_cache_memory
        )
355

356
        unrequested_memory = self.init_snapshot.free_memory - self.requested_memory
357
        logger.debug(
358
            "Initial free memory: %.2f GiB; Requested memory: %.2f (util), %.2f GiB",
359
360
361
362
363
364
365
366
367
368
            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),
        )
369
        logger.debug(profile_result)
370
        logger.info_once(
371
372
            "Available KV cache memory: %.2f GiB",
            GiB(self.available_kv_cache_memory_bytes),
373
            scope="local",
374
        )
375
        gc.collect()
376

377
        return int(self.available_kv_cache_memory_bytes)
378

379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
    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}

394
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
395
396
        return self.model_runner.get_kv_cache_spec()

397
    def initialize_from_config(self, kv_cache_config: KVCacheConfig) -> None:
398
        """Allocate GPU KV cache with the specified kv_cache_config."""
399

400
401
402
403
404
        # 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).
405
        ensure_kv_transfer_initialized(self.vllm_config, kv_cache_config)
406

407
        if self.vllm_config.model_config.enable_sleep_mode:
408
409
            from vllm.device_allocator.cumem import CuMemAllocator

410
            allocator = CuMemAllocator.get_instance()
411
412
            with allocator.use_memory_pool(tag="kv_cache"):
                self.model_runner.initialize_kv_cache(kv_cache_config)
413
414
        else:
            self.model_runner.initialize_kv_cache(kv_cache_config)
415
416

    def compile_or_warm_up_model(self) -> None:
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
        warmup_sizes = []

        if self.vllm_config.compilation_config.mode == CompilationMode.VLLM_COMPILE:
            # 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.
            compile_sizes = self.vllm_config.compilation_config.compile_sizes
            warmup_sizes = compile_sizes.copy() if compile_sizes is not None else []
            cg_capture_sizes: list[int] = []

            if self.vllm_config.compilation_config.cudagraph_mode != CUDAGraphMode.NONE:
                cg_sizes = self.vllm_config.compilation_config.cudagraph_capture_sizes
                cg_capture_sizes = [] if cg_sizes is None else cg_sizes
                warmup_sizes = [x for x in warmup_sizes if x not in cg_capture_sizes]

            compile_ranges = self.vllm_config.compilation_config.get_compile_ranges()
            # For each compile_range, if none of the batch sizes
            # in warmup_sizes or cudagraph_capture_sizes are in the range,
            # add the end of the range to ensure compilation/warmup.
            all_sizes = set(cg_capture_sizes)
            all_sizes.update([x for x in warmup_sizes if isinstance(x, int)])
            for compile_range in compile_ranges:
                if not any(x in compile_range for x in all_sizes):
                    warmup_sizes.append(compile_range.end)

442
        # We skip EPLB here since we don't want to record dummy metrics
443
444
        for size in sorted(warmup_sizes, reverse=True):
            logger.info("Compile and warming up model for size %d", size)
445
            self.model_runner._dummy_run(size, skip_eplb=True, remove_lora=False)
446
        self.model_runner.maybe_remove_all_loras(self.model_runner.lora_config)
447

448
449
450
451
        # Warmup and tune the kernels used during model execution before
        # cuda graph capture.
        kernel_warmup(self)

452
        cuda_graph_memory_bytes = 0
453
        if not self.model_config.enforce_eager:
454
455
            cuda_graph_memory_bytes = self.model_runner.capture_model()

456
457
458
        if self.cache_config.kv_cache_memory_bytes is None and hasattr(
            self, "peak_activation_memory"
        ):
459
460
461
462
463
464
465
466
467
468
469
470
471
            # 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)
472
473
474
475
476
477
            non_kv_cache_memory = (
                self.model_runner.model_memory_usage
                + self.peak_activation_memory
                + self.non_torch_memory
                + cuda_graph_memory_bytes
            )
478
            kv_cache_memory_bytes_to_gpu_limit = (
479
480
481
482
                self.init_snapshot.free_memory
                - non_kv_cache_memory
                - redundancy_buffer_memory
            )
483
            kv_cache_memory_bytes_to_requested_limit = (
484
485
486
487
                int(self.requested_memory)
                - non_kv_cache_memory
                - redundancy_buffer_memory
            )
488
489
490
491
492
493
494
495
496
497
498
499
500
501

            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="
502
503
504
505
506
                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 "
507
                f"utilize gpu memory. Current kv cache memory in use is "
508
509
                f"{GiB(self.available_kv_cache_memory_bytes)} GiB."
            )
510

511
            logger.debug(msg)
512
513
514
515
516
517

        # 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`.
518
        if get_pp_group().is_last_rank:
519
520
521
522
            max_num_reqs = min(
                self.scheduler_config.max_num_seqs,
                self.scheduler_config.max_num_batched_tokens,
            )
523

524
            # We skip EPLB here since we don't want to record dummy metrics
525
526
527
            hidden_states, last_hidden_states = self.model_runner._dummy_run(
                num_tokens=max_num_reqs,
                skip_eplb=True,
528
                cudagraph_runtime_mode=CUDAGraphMode.NONE,
529
            )
530
531
532
            if self.model_runner.is_pooling_model:
                self.model_runner._dummy_pooler_run(hidden_states)
            else:
533
                self.model_runner._dummy_sampler_run(hidden_states=last_hidden_states)
534

535
536
537
538
        # 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)

539
540
541
    def reset_mm_cache(self) -> None:
        self.model_runner.reset_mm_cache()

542
543
544
    def get_model(self) -> nn.Module:
        return self.model_runner.get_model()

545
546
    def get_supported_tasks(self) -> tuple[SupportedTask, ...]:
        return self.model_runner.get_supported_tasks()
547

548
549
550
551
552
553
    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()

554
555
        self.profiler.step()

556
557
558
        num_new = len(scheduler_output.scheduled_new_reqs)
        num_cached = len(scheduler_output.scheduled_cached_reqs.req_ids)

559
        return self.profiler.annotate_context_manager(
560
561
562
            f"execute_new_{num_new}_cached_{num_cached}"
        )

563
564
    @torch.inference_mode()
    def sample_tokens(
565
        self, grammar_output: "GrammarOutput | None"
566
567
568
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput:
        return self.model_runner.sample_tokens(grammar_output)

569
570
    @torch.inference_mode()
    def execute_model(
571
572
        self, scheduler_output: "SchedulerOutput"
    ) -> ModelRunnerOutput | None:
573
        intermediate_tensors = None
574
        forward_pass = scheduler_output.total_num_scheduled_tokens > 0
575
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
576
577
578
579
580
581
        all_gather_tensors = {}
        compilation_config = self.vllm_config.compilation_config
        parallel_config = self.vllm_config.parallel_config

        if (
            parallel_config.pipeline_parallel_size > 1
582
            and compilation_config.pass_config.enable_sp
583
584
585
            and forward_pass
        ):
            # currently only supported by V1 GPUModelRunner
586
            assert not self.use_v2_model_runner
587
588
589
590
591
592
593
            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.
594
            _, batch_desc, _, _, _ = (
595
596
597
598
599
600
601
                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
                )
602
            )
603
604
605
606
607
608
            all_gather_tensors = {
                "residual": not is_residual_scattered_for_sp(
                    self.vllm_config, batch_desc.num_tokens
                )
            }

609
        if forward_pass and not get_pp_group().is_first_rank:
610
611
612
            tensor_dict = get_pp_group().recv_tensor_dict(
                all_gather_group=get_tp_group(),
                all_gather_tensors=all_gather_tensors,
613
            )
614
615
            assert tensor_dict is not None
            intermediate_tensors = IntermediateTensors(tensor_dict)
616

617
618
619
620
621
622
        with self.annotate_profile(scheduler_output):
            output = self.model_runner.execute_model(
                scheduler_output, intermediate_tensors
            )
            if isinstance(output, (ModelRunnerOutput, NoneType)):
                return output
623

624
        assert isinstance(output, IntermediateTensors)
625
        parallel_config = self.vllm_config.parallel_config
626
        assert (
627
            parallel_config.distributed_executor_backend != "external_launcher"
628
629
            and not get_pp_group().is_last_rank
        )
630

631
632
633
634
635
        get_pp_group().send_tensor_dict(
            output.tensors,
            all_gather_group=get_tp_group(),
            all_gather_tensors=all_gather_tensors,
        )
636

637
        return None
638

639
    def take_draft_token_ids(self) -> DraftTokenIds | None:
640
641
        return self.model_runner.take_draft_token_ids()

642
    def profile(self, is_start: bool = True):
643
        if self.profiler is None:
644
            raise RuntimeError("Profiling is not enabled.")
645
646
647
648
649
        if is_start:
            self.profiler.start()
        else:
            self.profiler.stop()

650
    def execute_dummy_batch(self) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
651
652
653
654
655
656
        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)
657

658
659
660
    def add_lora(self, lora_request: LoRARequest) -> bool:
        return self.model_runner.add_lora(lora_request)

661
662
663
    def remove_lora(self, lora_id: int) -> bool:
        return self.model_runner.remove_lora(lora_id)

664
    def list_loras(self) -> set[int]:
665
666
667
668
669
        return self.model_runner.list_loras()

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

670
671
672
673
    def check_health(self) -> None:
        # worker will always be healthy as long as it's running.
        return

674
    def _eplb_before_scale_down(self, old_ep_size: int, new_ep_size: int) -> None:
675
        from vllm.distributed.parallel_state import get_ep_group
676

677
        if get_ep_group().rank == 0:
678
679
680
            logger.info(
                "[Elastic EP] Starting expert resharding before scaling down..."
            )
681
682
683
684
685
        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
686
687
        self.model_runner.eplb_state.rearrange(
            execute_shuffle=True,
688
            global_expert_loads=None,
689
690
            rank_mapping=rank_mapping,
        )
691
692
693
694
695
        torch.cuda.synchronize()
        if get_ep_group().rank == 0:
            logger.info("[Elastic EP] Expert resharding completed!")

    def _eplb_after_scale_up(
696
697
698
        self,
        old_ep_size: int,
        new_ep_size: int,
699
        global_expert_loads: list[torch.Tensor] | None,
700
    ) -> None:
701
        from vllm.distributed.parallel_state import get_ep_group
702

703
        if get_ep_group().rank == 0:
704
705
            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)}
706
707
708
        assert self.model_runner.eplb_state is not None
        self.model_runner.eplb_state.rearrange(
            execute_shuffle=True,
709
            global_expert_loads=global_expert_loads,
710
711
            rank_mapping=rank_mapping,
        )
712
713
714
715
        if get_ep_group().rank == 0:
            logger.info("[Elastic EP] Expert resharding completed!")

    def _reconfigure_parallel_config(
716
717
        self, reconfig_request: ReconfigureDistributedRequest
    ) -> None:
718
719
720
721
        """
        Update parallel config with provided reconfig_request
        """
        parallel_config = self.vllm_config.parallel_config
722
723
724
725
726
727
728
729
730
731
732
        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 = (
733
                reconfig_request.new_data_parallel_rank_local
734
735
            )
        parallel_config.data_parallel_master_ip = (
736
            reconfig_request.new_data_parallel_master_ip
737
738
        )
        parallel_config.data_parallel_master_port = (
739
            reconfig_request.new_data_parallel_master_port
740
        )
741

742
743
    def _reconfigure_moe(
        self, old_ep_size: int, new_ep_size: int
744
    ) -> list[torch.Tensor] | None:
745
746
747
748
749
750
751
        """
        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 (
752
753
754
755
            get_dp_group,
            get_ep_group,
            prepare_communication_buffer_for_model,
        )
756
757
758
759
        from vllm.model_executor.layers.fused_moe.layer import (
            FusedMoE,
            FusedMoEParallelConfig,
        )
760
761

        parallel_config = self.vllm_config.parallel_config
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782

        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,
783
                    pcp_size_=get_pcp_group().world_size,
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
                    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)

807
808
809
        if new_ep_size < old_ep_size:
            num_local_physical_experts = num_local_experts
            assert self.model_runner.eplb_state is not None
810
            new_physical_experts = (
811
                self.model_runner.eplb_state.physical_to_logical_map.shape[1]  # type: ignore[attr-defined]
812
            )
813
            parallel_config.eplb_config.num_redundant_experts = (
814
                new_physical_experts
815
                - self.model_runner.eplb_state.logical_replica_count.shape[1]  # type: ignore[attr-defined]
816
            )
817
            global_expert_loads = None
818
        else:
819
            num_local_physical_experts_tensor = torch.tensor(
820
821
822
                [num_local_experts], dtype=torch.int32, device="cpu"
            )
            torch.distributed.broadcast(
823
824
825
                num_local_physical_experts_tensor,
                group=get_ep_group().cpu_group,
                group_src=0,
826
            )
827
            num_local_physical_experts = int(num_local_physical_experts_tensor.item())
828
829
            new_physical_experts = num_local_physical_experts * new_ep_size
            assert self.model_runner.eplb_state is not None
830
            global_expert_loads_any = self.model_runner.eplb_state.rearrange(
831
                execute_shuffle=False
832
            )
833
            global_expert_loads = cast(list[torch.Tensor], global_expert_loads_any)
834
            parallel_config.eplb_config.num_redundant_experts = (
835
                new_physical_experts - global_expert_loads[0].shape[1]
836
            )
837
        prepare_communication_buffer_for_model(self.model_runner.model)
838
839
        if drafter_model is not None:
            prepare_communication_buffer_for_model(drafter_model)
840
841
        self.model_runner.model.update_physical_experts_metadata(
            num_physical_experts=new_physical_experts,
842
843
            num_local_physical_experts=num_local_physical_experts,
        )
844
        return global_expert_loads
845
846

    def reinitialize_distributed(
847
848
        self, reconfig_request: ReconfigureDistributedRequest
    ) -> None:
849
850
        from vllm.config import set_current_vllm_config
        from vllm.distributed.parallel_state import (
851
852
853
            cleanup_dist_env_and_memory,
            get_ep_group,
        )
854
855
856

        old_ep_size = get_ep_group().world_size
        old_ep_rank = get_ep_group().rank
857
858
859
860
861
        new_ep_size = (
            reconfig_request.new_data_parallel_size
            * get_tp_group().world_size
            * get_pp_group().world_size
        )
862
863
864
865
866
        if new_ep_size < old_ep_size:
            self._eplb_before_scale_down(old_ep_size, new_ep_size)

        cleanup_dist_env_and_memory()

867
868
869
870
        if (
            reconfig_request.new_data_parallel_rank
            == ReconfigureRankType.SHUTDOWN_CURRENT_RANK
        ):
871
872
873
874
875
876
877
            assert old_ep_rank >= new_ep_size
            # shutdown
            return

        self._reconfigure_parallel_config(reconfig_request)

        with set_current_vllm_config(self.vllm_config):
878
879
880
881
882
883
            init_worker_distributed_environment(
                self.vllm_config,
                self.rank,
                self.distributed_init_method,
                self.local_rank,
            )
884

885
        global_expert_loads = self._reconfigure_moe(old_ep_size, new_ep_size)
886
887

        if new_ep_size > old_ep_size:
888
889
            assert global_expert_loads is not None
            self._eplb_after_scale_up(old_ep_size, new_ep_size, global_expert_loads)
890

891
892
893
    def save_sharded_state(
        self,
        path: str,
894
895
        pattern: str | None = None,
        max_size: int | None = None,
896
    ) -> None:
897
        from vllm.model_executor.model_loader import ShardedStateLoader
898

899
900
901
902
903
904
905
        ShardedStateLoader.save_model(
            self.model_runner.model,
            path,
            pattern=pattern,
            max_size=max_size,
        )

906
907
908
909
910
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        self.model_runner.save_tensorized_model(
911
912
            tensorizer_config=tensorizer_config,
        )
913

914
    def shutdown(self) -> None:
915
916
        if runner := getattr(self, "model_runner", None):
            runner.ensure_kv_transfer_shutdown()
917
918
        if self.profiler is not None:
            self.profiler.shutdown()
919

920
921

def init_worker_distributed_environment(
922
    vllm_config: VllmConfig,
923
    rank: int,
924
    distributed_init_method: str | None = None,
925
    local_rank: int = -1,
926
    backend: str = "nccl",
927
928
) -> None:
    """Initialize the distributed environment."""
929
    parallel_config = vllm_config.parallel_config
930
931
932
    from vllm.model_executor.layers.batch_invariant import init_batch_invariance

    init_batch_invariance()
933
934
    set_custom_all_reduce(not parallel_config.disable_custom_all_reduce)

935
    init_method = distributed_init_method or "env://"
936
    init_distributed_environment(
937
        parallel_config.world_size, rank, init_method, local_rank, backend
938
    )
939

940
941
942
    ensure_model_parallel_initialized(
        parallel_config.tensor_parallel_size,
        parallel_config.pipeline_parallel_size,
943
        parallel_config.prefill_context_parallel_size,
944
945
        parallel_config.decode_context_parallel_size,
    )
946
947
948
949

    # 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)