gpu_model_runner.py 300 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
import functools
5
import gc
6
import itertools
7
import threading
8
import time
9
from collections import defaultdict
10
from collections.abc import Callable, Iterable, Iterator, Sequence
11
from contextlib import contextmanager
12
from copy import copy, deepcopy
13
from dataclasses import dataclass, replace
14
from functools import reduce
15
from typing import TYPE_CHECKING, Any, NamedTuple, TypeAlias, cast
16
17
18
19
20

import numpy as np
import torch
import torch.distributed
import torch.nn as nn
21
from tqdm import tqdm
22

23
import vllm.envs as envs
24
from vllm.compilation.counter import compilation_counter
25
from vllm.compilation.cuda_graph import CUDAGraphStat, CUDAGraphWrapper
26
from vllm.compilation.monitor import set_cudagraph_capturing_enabled
27
from vllm.config import (
28
    CompilationMode,
29
30
31
    CUDAGraphMode,
    VllmConfig,
    get_layers_from_vllm_config,
32
    set_current_vllm_config,
33
34
    update_config,
)
35
from vllm.config.cache import CacheConfig
36
from vllm.distributed.ec_transfer import get_ec_transfer, has_ec_transfer
37
from vllm.distributed.eplb.eplb_state import EplbState
38
from vllm.distributed.kv_transfer import get_kv_transfer_group, has_kv_transfer_group
39
from vllm.distributed.kv_transfer.kv_connector.utils import copy_kv_blocks
40
from vllm.distributed.parallel_state import (
41
    get_dcp_group,
42
43
44
45
46
47
    get_pp_group,
    get_tp_group,
    graph_capture,
    is_global_first_rank,
    prepare_communication_buffer_for_model,
)
48
49
50
51
from vllm.forward_context import (
    BatchDescriptor,
    set_forward_context,
)
52
from vllm.logger import init_logger
53
from vllm.lora.layers import LoRAMapping, LoRAMappingType
54
from vllm.model_executor.layers.attention import Attention, MLAAttention
55
from vllm.model_executor.layers.attention_layer_base import AttentionLayerBase
56
57
58
from vllm.model_executor.layers.fused_moe.routed_experts_capturer import (
    RoutedExpertsCapturer,
)
59
60
61
62
from vllm.model_executor.layers.rotary_embedding import (
    MRotaryEmbedding,
    XDRotaryEmbedding,
)
63
from vllm.model_executor.model_loader import get_model_loader
64
65
66
67
from vllm.model_executor.model_loader.reload import (
    finalize_layerwise_reload,
    initialize_layerwise_reload,
)
68
from vllm.model_executor.models.interfaces import (
69
    MultiModalEmbeddings,
70
    SupportsMRoPE,
71
    SupportsMultiModal,
72
    SupportsXDRoPE,
73
74
75
76
    is_mixture_of_experts,
    supports_eagle3,
    supports_mrope,
    supports_multimodal_pruning,
77
    supports_realtime,
78
    supports_transcription,
79
    supports_xdrope,
80
)
81
from vllm.model_executor.models.interfaces_base import (
82
83
84
85
    VllmModelForPooling,
    is_pooling_model,
    is_text_generation_model,
)
86
87
88
89
90
from vllm.model_executor.offloader import (
    create_offloader,
    get_offloader,
    set_offloader,
)
91
from vllm.multimodal import MULTIMODAL_REGISTRY
92
from vllm.multimodal.encoder_budget import MultiModalBudget
93
94
95
96
97
from vllm.multimodal.inputs import (
    BatchedTensorInputs,
    MultiModalKwargsItem,
    PlaceholderRange,
)
98
from vllm.multimodal.utils import group_and_batch_mm_kwargs
99
from vllm.platforms import current_platform
100
from vllm.pooling_params import PoolingParams
101
from vllm.sampling_params import SamplingType
102
from vllm.sequence import IntermediateTensors
103
from vllm.tasks import GenerationTask, PoolingTask, SupportedTask
104
from vllm.tracing import instrument
105
from vllm.utils import length_from_prompt_token_ids_or_embeds
106
from vllm.utils.math_utils import cdiv, round_up
107
from vllm.utils.mem_utils import DeviceMemoryProfiler, format_gib
108
from vllm.utils.nvtx_pytorch_hooks import PytHooks
109
from vllm.utils.platform_utils import is_pin_memory_available, num_compute_units
110
111
from vllm.utils.torch_utils import (
    get_dtype_size,
112
    is_quantized_kv_cache,
113
114
    kv_cache_dtype_str_to_dtype,
)
115
116
from vllm.v1.attention.backend import (
    AttentionBackend,
117
    AttentionCGSupport,
118
    AttentionMetadata,
119
    AttentionMetadataBuilder,
120
    AttentionType,
121
    CommonAttentionMetadata,
122
)
123
from vllm.v1.attention.backends.gdn_attn import GDNAttentionMetadataBuilder
124
from vllm.v1.attention.backends.mamba2_attn import Mamba2AttentionMetadataBuilder
125
from vllm.v1.attention.backends.utils import (
126
    NULL_BLOCK_ID,
127
    create_fast_prefill_custom_backend,
128
    get_dcp_local_seq_lens,
129
130
    reorder_batch_to_split_decodes_and_prefills,
)
131
from vllm.v1.core.sched.output import NewRequestData
132
from vllm.v1.cudagraph_dispatcher import CudagraphDispatcher
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
from vllm.v1.kv_cache_interface import (
    AttentionSpec,
    ChunkedLocalAttentionSpec,
    CrossAttentionSpec,
    EncoderOnlyAttentionSpec,
    FullAttentionSpec,
    KVCacheConfig,
    KVCacheGroupSpec,
    KVCacheSpec,
    MambaSpec,
    SlidingWindowSpec,
    UniformTypeKVCacheSpecs,
)
from vllm.v1.outputs import (
    EMPTY_MODEL_RUNNER_OUTPUT,
    AsyncModelRunnerOutput,
    DraftTokenIds,
150
    ECConnectorOutput,
151
    KVConnectorOutput,
152
153
154
155
156
    LogprobsLists,
    LogprobsTensors,
    ModelRunnerOutput,
    PoolerOutput,
    SamplerOutput,
157
    make_empty_encoder_model_runner_output,
158
)
159
from vllm.v1.pool.metadata import PoolingMetadata, PoolingStates
160
from vllm.v1.sample.logits_processor import LogitsProcessors, build_logitsprocs
161
from vllm.v1.sample.logits_processor.interface import LogitsProcessor
162
from vllm.v1.sample.metadata import SamplingMetadata
163
from vllm.v1.sample.rejection_sampler import RejectionSampler
164
from vllm.v1.sample.sampler import Sampler
165
from vllm.v1.spec_decode.dflash import DFlashProposer
166
from vllm.v1.spec_decode.draft_model import DraftModelProposer
167
from vllm.v1.spec_decode.eagle import EagleProposer
168
from vllm.v1.spec_decode.extract_hidden_states import ExtractHiddenStatesProposer
169
from vllm.v1.spec_decode.medusa import MedusaProposer
170
from vllm.v1.spec_decode.metadata import SpecDecodeMetadata
171
172
173
174
175
176
from vllm.v1.spec_decode.ngram_proposer_gpu import (
    NgramProposerGPU,
    copy_num_valid_draft_tokens,
    update_ngram_gpu_tensors_incremental,
    update_scheduler_for_invalid_drafts,
)
177
from vllm.v1.spec_decode.suffix_decoding import SuffixDecodingProposer
178
from vllm.v1.spec_decode.utils import update_num_computed_tokens_for_batch_change
179
from vllm.v1.structured_output.utils import apply_grammar_bitmask
180
from vllm.v1.utils import CpuGpuBuffer, record_function_or_nullcontext
181
182
183
184
185
from vllm.v1.worker import mamba_utils
from vllm.v1.worker.cp_utils import (
    check_attention_cp_compatibility,
    get_total_cp_world_size,
)
186
from vllm.v1.worker.dp_utils import coordinate_batch_across_dp
187
from vllm.v1.worker.ec_connector_model_runner_mixin import ECConnectorModelRunnerMixin
188
from vllm.v1.worker.gpu.pool.late_interaction_runner import LateInteractionRunner
189
from vllm.v1.worker.gpu_input_batch import CachedRequestState, InputBatch
190
from vllm.v1.worker.gpu_ubatch_wrapper import UBatchWrapper
191
from vllm.v1.worker.kv_connector_model_runner_mixin import KVConnectorModelRunnerMixin
192
from vllm.v1.worker.lora_model_runner_mixin import LoRAModelRunnerMixin
193
194
195
from vllm.v1.worker.ubatch_utils import (
    UBatchSlices,
    check_ubatch_thresholds,
196
    maybe_create_ubatch_slices,
197
    split_attn_metadata,
198
)
199
from vllm.v1.worker.utils import is_residual_scattered_for_sp
200
from vllm.v1.worker.workspace import lock_workspace
201

202
203
from .utils import (
    AttentionGroup,
204
    KVBlockZeroer,
205
206
    add_kv_sharing_layers_to_kv_cache_groups,
    bind_kv_cache,
207
    prepare_kernel_block_sizes,
208
209
    sanity_check_mm_encoder_outputs,
)
210

211
if TYPE_CHECKING:
212
    from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
213
    from vllm.v1.spec_decode.ngram_proposer import NgramProposer
214
    from vllm.v1.worker.encoder_cudagraph import EncoderCudaGraphManager
215
216
217

logger = init_logger(__name__)

218
219
AttnMetadataDict: TypeAlias = dict[str, AttentionMetadata]
# list when ubatching is enabled
220
PerLayerAttnMetadata: TypeAlias = list[AttnMetadataDict] | AttnMetadataDict
221

222

223
224
225
226
227
228
# Wrapper for ModelRunnerOutput to support overlapped execution.
class AsyncGPUModelRunnerOutput(AsyncModelRunnerOutput):
    def __init__(
        self,
        model_runner_output: ModelRunnerOutput,
        sampled_token_ids: torch.Tensor,
229
        logprobs_tensors: LogprobsTensors | None,
230
231
        invalid_req_indices: list[int],
        async_output_copy_stream: torch.cuda.Stream,
232
        vocab_size: int,
233
234
235
236
237
    ):
        self._model_runner_output = model_runner_output
        self._invalid_req_indices = invalid_req_indices

        # Event on the copy stream so we can synchronize the non-blocking copy.
238
        self.async_copy_ready_event = torch.Event()
239
240
241
242

        # Keep a reference to the device tensor to avoid it being
        # deallocated until we finish copying it to the host.
        self._sampled_token_ids = sampled_token_ids
243
        self.vocab_size = vocab_size
244
        self._logprobs_tensors = logprobs_tensors
245
246
247
248
249

        # Initiate the copy on a separate stream, but do not synchronize it.
        default_stream = torch.cuda.current_stream()
        with torch.cuda.stream(async_output_copy_stream):
            async_output_copy_stream.wait_stream(default_stream)
250
            self.sampled_token_ids_cpu = self._sampled_token_ids.to(
251
252
                "cpu", non_blocking=True
            )
253
254
255
256
257
            self._logprobs_tensors_cpu = (
                self._logprobs_tensors.to_cpu_nonblocking()
                if self._logprobs_tensors
                else None
            )
258
            self.async_copy_ready_event.record()
259
260
261

    def get_output(self) -> ModelRunnerOutput:
        """Copy the device tensors to the host and return a ModelRunnerOutput.
262

263
264
        This function blocks until the copy is finished.
        """
265
        max_gen_len = self.sampled_token_ids_cpu.shape[-1]
266
        self.async_copy_ready_event.synchronize()
267

268
269
        # Release the device tensors once the copy has completed.
        del self._logprobs_tensors
270
        del self._sampled_token_ids
271
        if max_gen_len == 1:
272
            valid_sampled_token_ids = self.sampled_token_ids_cpu.tolist()
273
274
            for i in self._invalid_req_indices:
                valid_sampled_token_ids[i].clear()
275
276
277
            logprobs_lists = None
            if self._logprobs_tensors_cpu is not None:
                logprobs_lists = self._logprobs_tensors_cpu.tolists()
278
        else:
279
            valid_sampled_token_ids, logprobs_lists = RejectionSampler.parse_output(
280
281
                self.sampled_token_ids_cpu,
                self.vocab_size,
282
                self._invalid_req_indices,
283
                logprobs_tensors=self._logprobs_tensors_cpu,
284
            )
285
286
287

        output = self._model_runner_output
        output.sampled_token_ids = valid_sampled_token_ids
288
        output.logprobs = logprobs_lists
289
290
291
        return output


292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
def _copy_pooler_output_to_cpu(
    raw_pooler_output: PoolerOutput, finished_mask: list[bool]
) -> list[torch.Tensor | None]:
    num_reqs = len(finished_mask)

    if isinstance(raw_pooler_output, torch.Tensor):
        if raw_pooler_output.shape[0] != num_reqs:
            raise ValueError(
                "Pooler output batch size does not match finished mask size: "
                f"{raw_pooler_output.shape[0]} != {num_reqs}."
            )

        num_finished = sum(finished_mask)
        if num_finished == 0:
            return [None] * num_reqs
        if num_finished == num_reqs:
            return list(raw_pooler_output.to("cpu", non_blocking=True))

        # partial finished
        finished_indices = [i for i, include in enumerate(finished_mask) if include]
        index_tensor = torch.tensor(
            finished_indices, device=raw_pooler_output.device, dtype=torch.long
        )
        finished_outputs = raw_pooler_output.index_select(0, index_tensor).to(
            "cpu", non_blocking=True
        )
        partial_pooler_output: list[torch.Tensor | None] = [None] * num_reqs
        for i, out in zip(finished_indices, finished_outputs):
            partial_pooler_output[i] = out
        return partial_pooler_output

    assert isinstance(raw_pooler_output, list)
    if len(raw_pooler_output) != num_reqs:
        raise ValueError(
            "Pooler output batch size does not match finished mask size: "
            f"{len(raw_pooler_output)} != {num_reqs}."
        )

    pooler_output: list[torch.Tensor | None] = [None] * num_reqs
    for i, (out, include) in enumerate(zip(raw_pooler_output, finished_mask)):
        if include and out is not None:
            pooler_output[i] = out.to("cpu", non_blocking=True)
    return pooler_output


337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
class AsyncGPUPoolingModelRunnerOutput(AsyncModelRunnerOutput):
    def __init__(
        self,
        model_runner_output: ModelRunnerOutput,
        raw_pooler_output: PoolerOutput,
        finished_mask: list[bool],
        async_output_copy_stream: torch.cuda.Stream,
    ):
        self._model_runner_output = model_runner_output

        # Event on the copy stream so we can synchronize the non-blocking copy.
        self.async_copy_ready_event = torch.Event()

        # Keep a reference to the device tensors to avoid them being
        # deallocated until we finish copying it to the host.
        self._raw_pooler_output = raw_pooler_output

        # Initiate the copy on a separate stream, but do not synchronize it.
        default_stream = torch.cuda.current_stream()
        with torch.cuda.stream(async_output_copy_stream):
            async_output_copy_stream.wait_stream(default_stream)
358
359
360
            self._model_runner_output.pooler_output = _copy_pooler_output_to_cpu(
                raw_pooler_output=self._raw_pooler_output,
                finished_mask=finished_mask,
361
362
363
364
365
366
367
368
369
370
371
372
373
374
            )
            self.async_copy_ready_event.record()

    def get_output(self) -> ModelRunnerOutput:
        """Copy the device tensors to the host and return a ModelRunnerOutput.
        This function blocks until the copy is finished.
        """
        self.async_copy_ready_event.synchronize()

        # Release the device tensors once the copy has completed.
        del self._raw_pooler_output
        return self._model_runner_output


375
376
377
378
379
380
381
382
383
384
385
class ExecuteModelState(NamedTuple):
    """Ephemeral cached state transferred between execute_model() and
    sample_tokens(), after execute_model() returns None."""

    scheduler_output: "SchedulerOutput"
    logits: torch.Tensor
    spec_decode_metadata: SpecDecodeMetadata | None
    spec_decode_common_attn_metadata: CommonAttentionMetadata | None
    hidden_states: torch.Tensor
    sample_hidden_states: torch.Tensor
    aux_hidden_states: list[torch.Tensor] | None
386
    ec_connector_output: ECConnectorOutput | None
387
    cudagraph_stats: CUDAGraphStat | None
388
    slot_mappings: dict[str, torch.Tensor] | list[dict[str, torch.Tensor]] | None
389
390


391
392
393
class GPUModelRunner(
    LoRAModelRunnerMixin, KVConnectorModelRunnerMixin, ECConnectorModelRunnerMixin
):
394
395
    def __init__(
        self,
396
        vllm_config: VllmConfig,
397
        device: torch.device,
398
    ):
399
400
401
        self.vllm_config = vllm_config
        self.model_config = vllm_config.model_config
        self.cache_config = vllm_config.cache_config
402
        self.offload_config = vllm_config.offload_config
403
        self.compilation_config = vllm_config.compilation_config
404
405
406
407
408
409
        self.lora_config = vllm_config.lora_config
        self.load_config = vllm_config.load_config
        self.parallel_config = vllm_config.parallel_config
        self.scheduler_config = vllm_config.scheduler_config
        self.speculative_config = vllm_config.speculative_config
        self.observability_config = vllm_config.observability_config
410

411
412
413
414
        model_config = self.model_config
        cache_config = self.cache_config
        scheduler_config = self.scheduler_config
        parallel_config = self.parallel_config
415
        self.device = device
416
417
        self.pin_memory = is_pin_memory_available()
        self.dtype = self.model_config.dtype
418

419
420
421
        self.kv_cache_dtype = kv_cache_dtype_str_to_dtype(
            cache_config.cache_dtype, self.model_config
        )
422

423
        self.is_pooling_model = model_config.runner_type == "pooling"
424
        self.enable_prompt_embeds = model_config.enable_prompt_embeds
425
        self.is_multimodal_raw_input_only_model = (
426
427
            model_config.is_multimodal_raw_input_only_model
        )
428
        # These will be overridden in load_model()
429
        self.is_multimodal_pruning_enabled = False
430
        self.requires_sequential_video_encoding = False
431
432
433
        # Set to True after init_routed_experts_capturer() completes.
        # Prevents routed experts code from running during profiling/dummy run.
        self.routed_experts_initialized = False
434
        self.max_model_len = model_config.max_model_len
435
436
437

        # Always set to false after the first forward pass
        self.calculate_kv_scales = self.cache_config.calculate_kv_scales
438
        self.dcp_world_size = self.parallel_config.decode_context_parallel_size
439
        self.dcp_rank = 0 if self.dcp_world_size <= 1 else get_dcp_group().rank_in_group
440
        self.max_num_tokens = scheduler_config.max_num_batched_tokens
441
        self.max_num_reqs = scheduler_config.max_num_seqs
442

443
444
        # Broadcast PP output for external_launcher (torchrun)
        # to make sure we are synced across pp ranks
445
        # TODO: Support overlapping micro-batches
446
447
        # https://github.com/vllm-project/vllm/issues/18019
        self.broadcast_pp_output = (
448
            self.parallel_config.distributed_executor_backend == "external_launcher"
449
            and len(get_pp_group().ranks) > 1
450
        )
451

452
        # Model-related.
453
        self.num_query_heads = model_config.get_num_attention_heads(parallel_config)
454
        self.inputs_embeds_size = model_config.get_inputs_embeds_size()
455
        # Only relevant for models using ALiBi (e.g, MPT)
456
        self.use_alibi = model_config.uses_alibi
457

458
        self.cascade_attn_enabled = not self.model_config.disable_cascade_attn
459
        self.is_mm_prefix_lm = self.model_config.is_mm_prefix_lm
460

461
        # Multi-modal data support
462
        self.mm_registry = MULTIMODAL_REGISTRY
463
        self.uses_mrope = model_config.uses_mrope
464
        self.uses_xdrope_dim = model_config.uses_xdrope_dim
465
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
466
            model_config
467
        )
468

469
470
471
        if self.model_config.is_encoder_decoder:
            # Maximum length of the encoder input, only for encoder-decoder
            # models.
472
            self.max_encoder_len = scheduler_config.max_num_encoder_input_tokens
473
474
475
        else:
            self.max_encoder_len = 0

476
477
478
        # Async scheduling
        self.use_async_scheduling = self.scheduler_config.async_scheduling

479
        # Sampler
480
        self.sampler = Sampler(logprobs_mode=self.model_config.logprobs_mode)
481

482
        self.eplb_state: EplbState | None = None
483
484
        # NOTE(yongji): flag to temporarily disable EPLB during scaling up/down
        self.eep_eplb_suppressed = False
485
486
487
488
489
490
        """
        State of the expert parallelism load balancer.

        Will be lazily initialized when the model is loaded.
        """

491
        # Lazy initializations
492
        # self.model: nn.Module  # Set after load_model
493
        # Initialize in initialize_kv_cache
494
        self.kv_caches: list[torch.Tensor] = []
495
496
497
        # Initialize in initialize_kv_cache_tensors
        self.cross_layers_kv_cache: torch.Tensor | None = None
        self.cross_layers_attn_backend: type[AttentionBackend] | None = None
498
499
        # indexes: [kv_cache_group_id][attn_group]
        self.attn_groups: list[list[AttentionGroup]] = []
500
501
        # self.kv_cache_config: KVCacheConfig

502
503
        # mm_hash ->  encoder_output
        self.encoder_cache: dict[str, torch.Tensor] = {}
504
        self.late_interaction_runner = LateInteractionRunner()
505

506
507
508
        # Encoder CUDA graph manager (initialized after model load if enabled)
        self.encoder_cudagraph_manager: EncoderCudaGraphManager | None = None

509
        self.use_aux_hidden_state_outputs = False
510
511
512
513
514
        # Set up speculative decoding.
        # NOTE(Jiayi): currently we put the entire draft model on
        # the last PP rank. This is not ideal if there are many
        # layers in the draft model.
        if self.speculative_config and get_pp_group().is_last_rank:
515
            self.drafter: (
516
                NgramProposer  # noqa: F823
517
                | NgramProposerGPU
518
519
                | SuffixDecodingProposer
                | EagleProposer
520
                | DFlashProposer
521
522
                | DraftModelProposer
                | MedusaProposer
523
                | ExtractHiddenStatesProposer
524
            )
525
            if self.speculative_config.method == "ngram":
526
527
                from vllm.v1.spec_decode.ngram_proposer import NgramProposer

528
                self.drafter = NgramProposer(self.vllm_config)
529
530
531
532
533
534
            elif self.speculative_config.uses_draft_model():
                self.drafter = DraftModelProposer(
                    vllm_config=self.vllm_config,
                    device=self.device,
                    runner=self,
                )
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
            elif self.speculative_config.use_ngram_gpu():
                self.drafter = NgramProposerGPU(self.vllm_config, self.device, self)
                self.num_tokens_no_spec_gpu = torch.zeros(
                    self.max_num_reqs, dtype=torch.int32, device=device
                )
                self.token_ids_gpu_tensor = torch.zeros(
                    self.max_num_reqs,
                    self.max_model_len,
                    dtype=torch.int32,
                    device=device,
                )
                self._ngram_pinned_idx_buf = torch.zeros(
                    self.max_num_reqs, dtype=torch.long, pin_memory=True
                )
                self._ngram_pinned_val_buf = torch.zeros(
                    self.max_num_reqs, dtype=torch.int32, pin_memory=True
                )
552
553
554
            elif self.speculative_config.use_dflash():
                self.drafter = DFlashProposer(self.vllm_config, self.device, self)
                self.use_aux_hidden_state_outputs = True
555
556
            elif self.speculative_config.method == "suffix":
                self.drafter = SuffixDecodingProposer(self.vllm_config)
557
            elif self.speculative_config.use_eagle():
558
                self.drafter = EagleProposer(self.vllm_config, self.device, self)
559
                if self.speculative_config.method == "eagle3":
560
561
562
                    self.use_aux_hidden_state_outputs = (
                        self.drafter.eagle3_use_aux_hidden_state
                    )
563
564
            elif self.speculative_config.method == "medusa":
                self.drafter = MedusaProposer(
565
                    vllm_config=self.vllm_config, device=self.device
566
                )
567
568
569
570
571
            elif self.speculative_config.method == "extract_hidden_states":
                self.drafter = ExtractHiddenStatesProposer(
                    vllm_config=self.vllm_config, device=self.device
                )
                self.use_aux_hidden_state_outputs = True
572
            else:
573
574
575
576
                raise ValueError(
                    "Unknown speculative decoding method: "
                    f"{self.speculative_config.method}"
                )
577
            self.rejection_sampler = RejectionSampler(self.sampler)
578

579
        self.num_spec_tokens = 0
580
        self.valid_sampled_token_count_gpu: torch.Tensor | None = None
581
582
        if self.speculative_config:
            self.num_spec_tokens = self.speculative_config.num_speculative_tokens
583
584
585
586
587
            draft_config = self.speculative_config.draft_model_config
            if draft_config is not None and draft_config.max_model_len is not None:
                self.effective_drafter_max_model_len = draft_config.max_model_len
            else:
                self.effective_drafter_max_model_len = self.max_model_len
588
589
590
        self.use_async_spec_decode = (
            self.use_async_scheduling and self.num_spec_tokens > 0
        )
591

592
        # Request states.
593
        self.requests: dict[str, CachedRequestState] = {}
594
595
596
        # NOTE(rob): num_prompt_logprobs only includes reqs
        # that are currently in the prefill phase.
        self.num_prompt_logprobs: dict[str, int] = {}
597

598
599
600
601
602
603
604
605
606
        # Input Batch
        # NOTE(Chen): Ideally, we should initialize the input batch inside
        # `initialize_kv_cache` based on the kv cache config. However, as in
        # https://github.com/vllm-project/vllm/pull/18298, due to some unknown
        # reasons, we have to initialize the input batch before `load_model`,
        # quantization + weight offloading will fail otherwise. As a temporary
        # solution, we initialize the input batch here, and re-initialize it
        # in `initialize_kv_cache` if the block_sizes here is different from
        # the block_sizes in the kv cache config.
607
608
609
610
        logits_processors = model_config.logits_processors
        custom_logitsprocs: Sequence[str | type[LogitsProcessor]] = (
            tuple(logits_processors) if logits_processors is not None else ()
        )
611
612
613
614
615
        placeholder_block_size = (
            self.cache_config.block_size or CacheConfig.DEFAULT_BLOCK_SIZE
        )
        self._init_block_sizes = [placeholder_block_size]
        self._init_kernel_block_sizes = [placeholder_block_size]
616
617
        self.input_batch = InputBatch(
            max_num_reqs=self.max_num_reqs,
618
            # We need to use the encoder length for encoder-decoder
619
620
            # because of KV cache for cross-attention.
            max_model_len=max(self.max_model_len, self.max_encoder_len),
621
622
623
            max_num_batched_tokens=self.max_num_tokens,
            device=self.device,
            pin_memory=self.pin_memory,
624
            vocab_size=self.model_config.get_vocab_size(),
625
626
            block_sizes=[placeholder_block_size],
            kernel_block_sizes=[placeholder_block_size],
627
            is_spec_decode=bool(self.vllm_config.speculative_config),
628
            logitsprocs=build_logitsprocs(
629
630
631
                self.vllm_config,
                self.device,
                self.pin_memory,
632
                self.is_pooling_model,
633
                custom_logitsprocs,
634
            ),
635
636
            # We currently don't know whether a particular custom logits processor
            # uses output token ids so we set this conservatively.
637
638
639
640
            # ThinkingTokenBudgetLogitsProcessor also needs output token ids to
            # correctly track think start/end token sequences in async scheduling.
            logitsprocs_need_output_token_ids=bool(custom_logitsprocs)
            or self.vllm_config.reasoning_config is not None,
641
            is_pooling_model=self.is_pooling_model,
642
            cp_kv_cache_interleave_size=self.parallel_config.cp_kv_cache_interleave_size,
643
        )
644

645
646
647
648
649
        # Separate cuda stream for overlapping transfer of sampled token ids from
        # GPU to CPU when async scheduling is enabled.
        self.async_output_copy_stream: torch.cuda.Stream | None = None
        # cuda event to synchronize use of reused CPU tensors between steps
        # when async scheduling is enabled.
650
        self.prepare_inputs_event: torch.Event | None = None
651
652
        if self.use_async_scheduling:
            self.async_output_copy_stream = torch.cuda.Stream()
653
            self.prepare_inputs_event = torch.Event()
654

655
656
657
658
659
660
661
662
663
664
665
        # self.cudagraph_batch_sizes sorts in ascending order.
        if (
            self.compilation_config.cudagraph_capture_sizes
            and self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
        ):
            self.cudagraph_batch_sizes = sorted(
                self.compilation_config.cudagraph_capture_sizes
            )
        else:
            self.cudagraph_batch_sizes = []

666
        # Cache the device properties.
667
        self._init_device_properties()
668

669
670
671
672
        # Encoder timing registry for observability
        self.encoder_timing_registry: dict[str, EncoderTimingStats] = {}
        self._encoder_timing_lock = threading.Lock()

673
        # Persistent buffers for CUDA graphs.
674
        self.input_ids = self._make_buffer(self.max_num_tokens, dtype=torch.int32)
675
676
677
        self.positions = torch.zeros(
            self.max_num_tokens, dtype=torch.int64, device=self.device
        )
678
679
680
        self.query_start_loc = self._make_buffer(
            self.max_num_reqs + 1, dtype=torch.int32
        )
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
        self.seq_lens = torch.zeros(
            self.max_num_reqs, dtype=torch.int32, device=self.device
        )
        self.optimistic_seq_lens_cpu = torch.zeros(
            self.max_num_reqs, dtype=torch.int32, pin_memory=self.pin_memory
        )
        self.num_computed_tokens = torch.zeros(
            self.max_num_reqs, dtype=torch.int32, device=self.device
        )
        self.prev_num_draft_tokens = self._make_buffer(
            self.max_num_reqs, dtype=torch.int32
        )
        self.req_indices = self._make_buffer(self.max_num_tokens, dtype=torch.int64)
        # Maps current batch position -> previous batch position (-1 for new reqs)
        self.prev_positions = self._make_buffer(self.max_num_reqs, dtype=torch.int64)
        self.num_scheduled_tokens = self._make_buffer(
            self.max_num_reqs, dtype=torch.int32
        )

700
        self.encoder_seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
701
702
703
704
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens = self._make_buffer(
                self.max_num_reqs, dtype=torch.int32
            )
705
706
707
        # Because inputs_embeds may be bfloat16 and we don't need a numpy
        # version of this tensor, avoid a RuntimeError by not creating a
        # numpy buffer.
708
        self.inputs_embeds = self._make_buffer(
709
            self.max_num_tokens, self.inputs_embeds_size, dtype=self.dtype, numpy=False
710
711
        )
        self.is_token_ids = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
712
713
        self.discard_request_mask = self._make_buffer(
            self.max_num_reqs, dtype=torch.bool
714
715
716
717
718
        )
        self.num_decode_draft_tokens = self._make_buffer(
            self.max_num_reqs, dtype=torch.int32
        )
        self.num_accepted_tokens = self._make_buffer(
719
            self.max_num_reqs, dtype=torch.int32
720
        )
721
722

        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
723
        if self.uses_mrope:
Roger Wang's avatar
Roger Wang committed
724
725
726
727
            # NOTE: `mrope_positions` is implemented with one additional dummy
            # position on purpose to make it non-contiguous so that it can work
            # with torch compile.
            # See detailed explanation in https://github.com/vllm-project/vllm/pull/12128#discussion_r1926431923
728
729
730
731
732
733

            # NOTE: When M-RoPE is enabled, position ids are 3D regardless of
            # the modality of inputs. For text-only inputs, each dimension has
            # identical position IDs, making M-RoPE functionally equivalent to
            # 1D-RoPE.
            # See page 5 of https://arxiv.org/abs/2409.12191
734
            self.mrope_positions = self._make_buffer(
735
736
                (3, self.max_num_tokens + 1), dtype=torch.int64
            )
737

738
739
740
741
742
743
744
        # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
        if self.uses_xdrope_dim > 0:
            # Similar to mrope but use assigned dimension number for RoPE, 4 as default.
            self.xdrope_positions = self._make_buffer(
                (self.uses_xdrope_dim, self.max_num_tokens + 1), dtype=torch.int64
            )

745
        # None in the first PP rank. The rest are set after load_model.
746
        self.intermediate_tensors: IntermediateTensors | None = None
747

748
749
750
751
752
753
754
755
        # OPTIMIZATION: Cache the arange tensors rather than creating them
        # every step. Keep in int64 to avoid overflow with long context.
        # - arange_np: immutable [0, 1, 2, ...] used as source for batched computation
        # - query_pos: CpuGpuBuffer for the computed batched arange result
        arange_size = max(self.max_num_reqs + 1, self.max_num_tokens)
        self.arange_np = np.arange(arange_size, dtype=np.int64)
        self.query_pos = self._make_buffer(arange_size, dtype=torch.int64)
        self._arange_scratch = np.empty(arange_size, dtype=np.int64)
756

757
758
759
760
761
        # Layer pairings for cross-layer KV sharing.
        # If an Attention layer `layer_name` is in the keys of this dict, it
        # means this layer will perform attention using the keys and values
        # from the KV cache of `shared_kv_cache_layers[layer_name]`.
        self.shared_kv_cache_layers: dict[str, str] = {}
762
763
764
765
766
        self.kv_sharing_fast_prefill_eligible_layers: set[str] = set()

        self.kv_sharing_fast_prefill_logits_indices = None
        if self.cache_config.kv_sharing_fast_prefill:
            self.kv_sharing_fast_prefill_logits_indices = torch.zeros(
767
768
                self.max_num_tokens, dtype=torch.int32, device=self.device
            )
769

770
        self.uniform_decode_query_len = 1 + self.num_spec_tokens
771
772
773
774

        # Cudagraph dispatcher for runtime cudagraph dispatching.
        self.cudagraph_dispatcher = CudagraphDispatcher(self.vllm_config)

775
        self.mm_budget = (
776
            MultiModalBudget(self.vllm_config, self.mm_registry)
777
778
779
            if self.supports_mm_inputs
            else None
        )
780

781
        self.reorder_batch_threshold: int | None = None
782

783
784
785
786
787
        # Attention layers that are only in the KVCacheConfig of the runner
        # (e.g., KV sharing, encoder-only attention), but not in the
        # KVCacheConfig of the scheduler.
        self.runner_only_attn_layers: set[str] = set()

788
        # Cached outputs.
789
        self._draft_token_ids: list[list[int]] | torch.Tensor | None = None
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
        # N-gram GPU path: async D2H buffer/event for per-request valid draft counts.
        self._num_valid_draft_tokens: torch.Tensor | None = None
        self._num_valid_draft_tokens_cpu: torch.Tensor | None = None
        self._num_valid_draft_tokens_event: torch.cuda.Event | None = None
        self._num_valid_draft_tokens_copy_stream: torch.cuda.Stream | None = None
        if (
            self.speculative_config is not None
            and self.speculative_config.use_ngram_gpu()
        ):
            self._num_valid_draft_tokens_cpu = torch.empty(
                self.max_num_reqs, dtype=torch.int32, pin_memory=self.pin_memory
            )
            self._num_valid_draft_tokens_event = torch.cuda.Event()
            self._num_valid_draft_tokens_copy_stream = torch.cuda.Stream()

805
        self._draft_token_req_ids: list[str] | None = None
806
        self.transfer_event = torch.Event()
807
        self.sampled_token_ids_pinned_cpu = torch.empty(
808
            (self.max_num_reqs, 1),
809
810
            dtype=torch.int64,
            device="cpu",
811
812
            pin_memory=self.pin_memory,
        )
813

814
815
        # Pre-allocated tensor for copying valid sampled token counts to CPU,
        # with dedicated stream for overlapping and event for coordination.
816
        self.valid_sampled_token_count_event: torch.Event | None = None
817
        self.valid_sampled_token_count_copy_stream: torch.cuda.Stream | None = None
818
819
820
821
822
823
        # We also copy the drafted tokens to the CPU asynchronously,
        # in case we need them for structured outputs.
        self.draft_token_ids_event: torch.Event | None = None
        self.draft_token_ids_copy_stream: torch.cuda.Stream | None = None
        self.valid_sampled_token_count_cpu: torch.Tensor | None = None
        self.draft_token_ids_cpu: torch.Tensor | None = None
824
        self.num_accepted_tokens_event: torch.Event | None = None
825
826
        if self.num_spec_tokens:
            self.draft_token_ids_event = torch.Event()
827
            self.num_accepted_tokens_event = torch.Event()
828
829
830
831
832
833
834
835
836
837
838
839
            self.draft_token_ids_copy_stream = torch.cuda.Stream()
            self.draft_token_ids_cpu = torch.empty(
                (self.max_num_reqs, self.num_spec_tokens),
                dtype=torch.int64,
                device="cpu",
                pin_memory=self.pin_memory,
            )
            if self.use_async_scheduling:
                self.valid_sampled_token_count_event = torch.Event()
                self.valid_sampled_token_count_copy_stream = torch.cuda.Stream()
                self.valid_sampled_token_count_cpu = torch.empty(
                    self.max_num_reqs,
840
                    dtype=torch.int32,
841
842
843
                    device="cpu",
                    pin_memory=self.pin_memory,
                )
844

845
846
847
848
        # Model weight offloader
        # Make sure this is called before any get_offloader call
        set_offloader(create_offloader(self.offload_config))

849
850
        # Ephemeral state transferred between execute_model() and sample_tokens().
        self.execute_model_state: ExecuteModelState | None = None
851
        self.kv_connector_output: KVConnectorOutput | None = None
852
        self.mamba_state_idx: dict[str, int] = {}
853
        self._mamba_copy_bufs: mamba_utils.MambaCopyBuffers | None = None
854
        self.layerwise_nvtx_hooks_registered = False
855

856
857
858
859
860
861
862
    def update_max_model_len(self, max_model_len: int) -> None:
        self.max_model_len = max_model_len
        if self.speculative_config:
            draft_config = self.speculative_config.draft_model_config
            if draft_config is None or draft_config.max_model_len is None:
                self.effective_drafter_max_model_len = self.max_model_len

863
    def reset_mm_cache(self) -> None:
864
865
866
867
        """
        Clear the multi-modal cache that was used during profiling,
        but no longer needed during inference.
        """
868
869
        if self.mm_budget:
            self.mm_budget.reset_cache()
870
        self.late_interaction_runner.clear()
871

872
873
874
875
876
877
878
    def reset_encoder_cache(self) -> None:
        """Clear the GPU-side encoder cache storing vision embeddings.

        This should be called when model weights are updated to ensure
        stale embeddings computed with old weights are not reused.
        """
        self.encoder_cache.clear()
879
        self.late_interaction_runner.clear()
880

881
882
883
884
885
886
887
888
889
    @torch.inference_mode()
    def init_fp8_kv_scales(self) -> None:
        """
        Re-initialize the KV cache and FP8 scales after waking from sleep.
        1. Zero out the KV cache tensors to remove garbage data from re-allocation.
        2. Reset Attention layer scaling factors (_k_scale, _v_scale) to 1.0.
          If these are left at 0.0 (default after wake_up), all KV cache values
          become effectively zero, causing gibberish output.
        """
890
        if not is_quantized_kv_cache(self.cache_config.cache_dtype):
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
            return

        kv_caches = getattr(self, "kv_caches", [])
        for cache_tensor in kv_caches:
            if cache_tensor is not None:
                cache_tensor.zero_()

        k_attr_names = ("_k_scale", "k_scale")
        v_attr_names = ("_v_scale", "v_scale")

        attn_layers = self.compilation_config.static_forward_context
        for name, module in attn_layers.items():
            if isinstance(module, (Attention, MLAAttention)):
                # TODO: Generally, scale is 1.0 if user uses on-the-fly fp8
                # kvcache quant. However, to get better accuracy, compression
                # frameworks like llm-compressors allow users to tune the
                # scale. We may need to restore the specific calibrated scales
                # here in the future.
                k_scale_val, v_scale_val = 1.0, 1.0

                # Processing K Scale
                for attr in k_attr_names:
                    if hasattr(module, attr):
                        param = getattr(module, attr)
                        if isinstance(param, torch.Tensor):
                            param.fill_(k_scale_val)

                # Processing V Scale
                for attr in v_attr_names:
                    if hasattr(module, attr):
                        param = getattr(module, attr)
                        if isinstance(param, torch.Tensor):
                            param.fill_(v_scale_val)

925
926
927
928
    def _get_positions(self, num_tokens: Any):
        if isinstance(num_tokens, int):
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, :num_tokens]
929
930
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, :num_tokens]
931
            return self.positions[:num_tokens]
932
933
934
        else:
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, num_tokens]
935
936
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, num_tokens]
937
            return self.positions[num_tokens]
938

939
    def _make_buffer(
940
        self, *size: int | torch.SymInt, dtype: torch.dtype, numpy: bool = True
941
942
943
944
945
946
947
948
    ) -> CpuGpuBuffer:
        return CpuGpuBuffer(
            *size,
            dtype=dtype,
            device=self.device,
            pin_memory=self.pin_memory,
            with_numpy=numpy,
        )
949

950
951
952
953
954
955
956
957
958
959
    def _get_mamba_copy_bufs(self) -> mamba_utils.MambaCopyBuffers:
        if self._mamba_copy_bufs is None:
            self._mamba_copy_bufs = mamba_utils.MambaCopyBuffers.create(
                self.max_num_reqs,
                self.kv_cache_config,
                self.model.get_mamba_state_copy_func(),
                self._make_buffer,
            )
        return self._mamba_copy_bufs

960
    def _init_model_kwargs(self):
961
962
        model_kwargs = dict[str, Any]()

963
        if not self.is_pooling_model:
964
965
            return model_kwargs

966
967
        num_reqs = self.input_batch.num_reqs
        pooling_params = self.input_batch.get_pooling_params()
968
969
970

        token_type_id_requests = dict[int, Any]()
        for i, param in enumerate(pooling_params):
971
972
973
974
975
            if (
                param.extra_kwargs is not None
                and (token_types := param.extra_kwargs.get("compressed_token_type_ids"))
                is not None
            ):
976
977
978
979
980
                token_type_id_requests[i] = token_types

        if len(token_type_id_requests) == 0:
            return model_kwargs

981
        seq_lens = self.seq_lens[:num_reqs]
982
983
984
985
986
987
988
989
        token_type_ids = []

        for i in range(num_reqs):
            pos = token_type_id_requests.get(i, seq_lens[i])
            ids = (torch.arange(seq_lens[i]) >= pos).int()
            token_type_ids.append(ids)

        model_kwargs["token_type_ids"] = torch.concat(token_type_ids).to(
990
991
            device=self.device
        )
992
993
        return model_kwargs

994
    def _may_reorder_batch(self, scheduler_output: "SchedulerOutput") -> None:
995
996
        """
        Update the order of requests in the batch based on the attention
997
        backend's needs. For example, some attention backends (namely MLA) may
998
999
1000
1001
1002
1003
        want to separate requests based on if the attention computation will be
        compute-bound or memory-bound.

        Args:
            scheduler_output: The scheduler output.
        """
Jiayi Yan's avatar
Jiayi Yan committed
1004
        # Attention free models have zero kv_cache_groups, however models
1005
1006
1007
1008
1009
1010
1011
        # like Mamba are also attention free but use the kv_cache for
        # keeping its internal state. This is why we check the number
        # of kv_cache groups instead of solely checking
        # for self.model_config.is_attention_free.
        if len(self.kv_cache_config.kv_cache_groups) == 0:
            return

1012
1013
1014
1015
        if self.reorder_batch_threshold is not None:
            reorder_batch_to_split_decodes_and_prefills(
                self.input_batch,
                scheduler_output,
1016
1017
                decode_threshold=self.reorder_batch_threshold,
            )
1018

1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
    def _init_kv_zero_meta(self) -> None:
        """One-time precomputation for _zero_block_ids.

        Delegates to KVBlockZeroer.init_meta with the runner's state.
        Called from gpu_worker.py outside the CuMem pool context.
        """
        self._kv_block_zeroer = KVBlockZeroer(self.device, self.pin_memory)
        self._kv_block_zeroer.init_meta(
            attn_groups_iter=self._kv_cache_spec_attn_group_iterator(),
            kernel_block_sizes=self._kernel_block_sizes,
            cache_dtype=self.cache_config.cache_dtype,
            runner_only_attn_layers=self.runner_only_attn_layers,
            static_forward_context=(self.compilation_config.static_forward_context),
        )

    def _zero_block_ids(self, block_ids: list[int]) -> None:
        """Zero the KV cache memory for the given block IDs."""
        if hasattr(self, "_kv_block_zeroer"):
            self._kv_block_zeroer.zero_block_ids(block_ids)

1039
1040
    # Note: used for model runner override.
    def _init_device_properties(self) -> None:
1041
        """Initialize attributes from torch.cuda.get_device_properties"""
1042
1043

        self.num_sms = num_compute_units(self.device.index)
1044
1045
1046

    # Note: used for model runner override.
    def _sync_device(self) -> None:
1047
        torch.accelerator.synchronize()
1048

1049
1050
1051
1052
1053
1054
1055
    def _get_or_create_async_output_copy_stream(self) -> torch.cuda.Stream:
        stream = self.async_output_copy_stream
        if stream is None:
            stream = torch.cuda.Stream()
            self.async_output_copy_stream = stream
        return stream

1056
    def _update_states(self, scheduler_output: "SchedulerOutput") -> Callable | None:
1057
1058
1059
1060
1061
1062
        """Update the cached states and the persistent batch with the scheduler
        output.

        The updated states are used by the `_prepare_inputs` function to create
        the input GPU tensors for the model.

1063
1064
        The SamplingMetadata is updated and copied to the GPU if there is a
        new/resumed/paused/finished request in the batch.
1065
1066
        """
        # Remove finished requests from the cached states.
1067
1068
        for req_id in scheduler_output.finished_req_ids:
            self.requests.pop(req_id, None)
1069
            self.num_prompt_logprobs.pop(req_id, None)
1070
1071
1072
        self.late_interaction_runner.on_requests_finished(
            scheduler_output.finished_req_ids
        )
1073
1074
1075
1076
1077
1078
1079
        # Remove the finished requests from the persistent batch.
        # NOTE(woosuk): There could be an edge case where finished_req_ids and
        # scheduled_req_ids overlap. This happens when a request is aborted and
        # then resubmitted with the same ID. In this case, we treat them as two
        # distinct requests - clearing the cached states for the first request
        # and handling the second as a new request.
        for req_id in scheduler_output.finished_req_ids:
1080
            self.input_batch.remove_request(req_id)
1081

1082
1083
1084
1085
1086
        # Zero GPU memory for freshly allocated cache blocks to prevent
        # stale NaN/data from corrupting attention or SSM computation.
        if scheduler_output.new_block_ids_to_zero:
            self._zero_block_ids(scheduler_output.new_block_ids_to_zero)

1087
        # Free the cached encoder outputs.
1088
1089
        for mm_hash in scheduler_output.free_encoder_mm_hashes:
            self.encoder_cache.pop(mm_hash, None)
1090

1091
1092
1093
1094
1095
1096
1097
        # Remove the unscheduled requests from the persistent batch.
        # NOTE(woosuk): The unscheduled requests are either preempted requests
        # or running requests that are not scheduled in this step. We remove
        # them from the persistent batch but keep their cached states since
        # they will be scheduled again sometime in the future.
        scheduled_req_ids = scheduler_output.num_scheduled_tokens.keys()
        cached_req_ids = self.input_batch.req_id_to_index.keys()
1098
1099
1100
1101
1102
1103
1104
1105
        resumed_req_ids = scheduler_output.scheduled_cached_reqs.resumed_req_ids
        # NOTE(zhuohan): cached_req_ids and resumed_req_ids are usually disjoint,
        # so `(scheduled_req_ids - resumed_req_ids) == scheduled_req_ids` holds
        # apart from the forced-preemption case in reset_prefix_cache. And in
        # that case we include the resumed_req_ids in the unscheduled set so
        # that they get cleared from the persistent batch before being re-scheduled
        # in the normal resumed request path.
        unscheduled_req_ids = cached_req_ids - (scheduled_req_ids - resumed_req_ids)
1106
1107
1108
1109
1110
        # NOTE(woosuk): The persistent batch optimization assumes that
        # consecutive batches contain mostly the same requests. If batches
        # have low request overlap (e.g., alternating between two distinct
        # sets of requests), this optimization becomes very inefficient.
        for req_id in unscheduled_req_ids:
1111
            self.input_batch.remove_request(req_id)
1112

1113
1114
1115
1116
1117
1118
1119
        is_ngram_gpu = (
            self.speculative_config is not None
            and self.speculative_config.use_ngram_gpu()
        )
        if is_ngram_gpu:
            ngram_gpu_new_reqs: list[CachedRequestState] = []

1120
        reqs_to_add: list[CachedRequestState] = []
1121
1122
        deferred_spec_decode_corrections = []

1123
        # Add new requests to the cached states.
1124
1125
        for new_req_data in scheduler_output.scheduled_new_reqs:
            req_id = new_req_data.req_id
1126
1127
1128
1129
1130
1131
            if req_id in self.requests:
                # For streaming case only.
                req_state = self._update_streaming_request(req_id, new_req_data)
                reqs_to_add.append(req_state)
                continue

1132
            sampling_params = new_req_data.sampling_params
1133
            pooling_params = new_req_data.pooling_params
1134

1135
1136
1137
1138
            if (
                sampling_params
                and sampling_params.sampling_type == SamplingType.RANDOM_SEED
            ):
1139
1140
1141
1142
1143
                generator = torch.Generator(device=self.device)
                generator.manual_seed(sampling_params.seed)
            else:
                generator = None

1144
1145
            if self.is_pooling_model:
                assert pooling_params is not None
1146
1147
                task = pooling_params.task
                assert task is not None, "You did not set `task` in the API"
1148

1149
                model = cast(VllmModelForPooling, self.get_model())
1150
                to_update = model.pooler.get_pooling_updates(task)
1151
1152
                to_update.apply(pooling_params)

1153
            req_state = CachedRequestState(
1154
                req_id=req_id,
1155
                prompt_token_ids=new_req_data.prompt_token_ids,
1156
                prompt_embeds=new_req_data.prompt_embeds,
1157
                mm_features=new_req_data.mm_features,
1158
                sampling_params=sampling_params,
1159
                pooling_params=pooling_params,
1160
                generator=generator,
1161
1162
                block_ids=new_req_data.block_ids,
                num_computed_tokens=new_req_data.num_computed_tokens,
1163
                output_token_ids=[],
1164
                lora_request=new_req_data.lora_request,
1165
            )
1166
            self.requests[req_id] = req_state
1167
            self.late_interaction_runner.register_request(req_id, pooling_params)
1168

1169
1170
1171
1172
1173
1174
1175
            if sampling_params and sampling_params.prompt_logprobs is not None:
                self.num_prompt_logprobs[req_id] = (
                    self.input_batch.vocab_size
                    if sampling_params.prompt_logprobs == -1
                    else sampling_params.prompt_logprobs
                )

1176
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1177
            if self.uses_mrope:
1178
                self._init_mrope_positions(req_state)
1179

1180
1181
1182
1183
            # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
            if self.uses_xdrope_dim > 0:
                self._init_xdrope_positions(req_state)

1184
            reqs_to_add.append(req_state)
1185
1186
1187
            # Track new requests for ngram_gpu full tensor copy
            if is_ngram_gpu:
                ngram_gpu_new_reqs.append(req_state)
1188

1189
        # Update the states of the running/resumed requests.
1190
        is_last_rank = get_pp_group().is_last_rank
1191
        req_data = scheduler_output.scheduled_cached_reqs
1192
        scheduled_spec_tokens = scheduler_output.scheduled_spec_decode_tokens
1193

1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
        # Save scheduler-allocated spec lengths before trimming so
        # prev_num_draft_len keeps the optimistic count for rejection correction.
        original_num_spec_per_req: dict[str, int] = {}
        if (
            self.speculative_config is not None
            and self.speculative_config.use_ngram_gpu()
        ):
            for req_id, toks in scheduled_spec_tokens.items():
                original_num_spec_per_req[req_id] = len(toks)
            update_scheduler_for_invalid_drafts(
                self._num_valid_draft_tokens_event,
                self._num_valid_draft_tokens_cpu,
                scheduler_output,
                self.input_batch.req_id_to_index,
            )
1209
1210
        if self.use_async_spec_decode:
            self.prev_num_draft_tokens.np.fill(0)
1211

1212
        for i, req_id in enumerate(req_data.req_ids):
1213
            req_state = self.requests[req_id]
1214
1215
            num_computed_tokens = req_data.num_computed_tokens[i]
            new_block_ids = req_data.new_block_ids[i]
1216
            resumed_from_preemption = req_id in req_data.resumed_req_ids
1217
            num_output_tokens = req_data.num_output_tokens[i]
1218
            req_index = self.input_batch.req_id_to_index.get(req_id)
1219

1220
1221
1222
1223
            if req_state.prev_num_draft_len and self.use_async_scheduling:
                # prev_num_draft_len is used in async scheduling mode with
                # spec decode. it indicates if need to update num_computed_tokens
                # of the request. for example:
1224
                # first step: num_computed_tokens = 0, spec_tokens = [],
1225
                # prev_num_draft_len = 0.
Jiayi Yan's avatar
Jiayi Yan committed
1226
                # second step: num_computed_tokens = 100(prompt length),
1227
1228
1229
                # spec_tokens = [a,b], prev_num_draft_len = 0.
                # third step: num_computed_tokens = 100 + 2, spec_tokens = [c,d],
                # prev_num_draft_len = 2.
1230
                # num_computed_tokens in first step and second step doesn't contain
1231
1232
1233
                # the spec tokens length, but in third step it contains the
                # spec tokens length. we only need to update num_computed_tokens
                # when prev_num_draft_len > 0.
1234
1235
1236
                if req_index is None:
                    req_state.prev_num_draft_len = 0
                else:
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
                    # Optimistically assume all accepted; queue up a correction
                    # to be called after the model forward to preserve async
                    # scheduling. Corrected on GPU in _prepare_inputs.
                    optimistic_num_accepted = req_state.prev_num_draft_len
                    req_state.output_token_ids.extend([-1] * optimistic_num_accepted)

                    deferred_spec_decode_corrections.append(
                        (req_id, optimistic_num_accepted, req_state)
                    )

                    prev_req_index = (
                        self.input_batch.prev_req_id_to_index.get(req_id)
                        if self.input_batch.prev_req_id_to_index
                        else None
                    )
                    if prev_req_index is not None:
                        self.prev_num_draft_tokens.np[prev_req_index] = (
                            optimistic_num_accepted
                        )
1256

1257
1258
1259
1260
                    if is_ngram_gpu and optimistic_num_accepted > 0:
                        self.input_batch.num_tokens_no_spec[req_index] += (
                            optimistic_num_accepted
                        )
1261

1262
            # Update the cached states.
1263
            req_state.num_computed_tokens = num_computed_tokens
1264
1265

            if not is_last_rank:
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
                if not req_data.new_token_ids:
                    # Async scheduled PP: Sampled tokens propagated via GPU broadcast.
                    new_token_ids: list[int] = []
                else:
                    # Non-async scheduling with PP: The scheduler sends
                    # sampled token ids back because there's no direct communication
                    # between the first-stage worker and the last-stage worker.
                    new_token_ids = req_data.new_token_ids[i]
                    # Add the sampled token(s) from the previous step (if any).
                    # This doesn't include "unverified" tokens like spec tokens.
                    num_new_tokens = (
                        num_computed_tokens + len(new_token_ids) - req_state.num_tokens
                    )
                    if num_new_tokens == 1:
                        # Avoid slicing list in most common case.
                        req_state.output_token_ids.append(new_token_ids[-1])
                    elif num_new_tokens > 0:
                        req_state.output_token_ids.extend(
                            new_token_ids[-num_new_tokens:]
                        )
1286
1287
            elif num_output_tokens < len(req_state.output_token_ids):
                # Some output tokens were discarded due to a sync-KV-load
1288
1289
                # failure, or output_token_ids was inflated by the optimistic
                # extend above (async spec decode). Align the cached state.
1290
1291
                del req_state.output_token_ids[num_output_tokens:]
                if req_index is not None:
1292
1293
1294
1295
                    end_idx = (
                        self.input_batch.num_prompt_tokens[req_index]
                        + num_output_tokens
                    )
1296
                    self.input_batch.num_tokens_no_spec[req_index] = end_idx
1297

1298
            # Update the block IDs.
1299
            if not resumed_from_preemption:
1300
1301
                if new_block_ids is not None:
                    # Append the new blocks to the existing block IDs.
1302
                    for block_ids, new_ids in zip(req_state.block_ids, new_block_ids):
1303
                        block_ids.extend(new_ids)
1304
            else:
1305
                assert req_index is None
1306
                assert new_block_ids is not None
1307
1308
                # The request is resumed from preemption.
                # Replace the existing block IDs with the new ones.
1309
                req_state.block_ids = new_block_ids
1310
1311
1312
1313
1314

            if req_index is None:
                # The request is not in the persistent batch.
                # The request was either preempted and resumed later, or was not
                # scheduled in the previous step and needs to be added again.
1315
1316
1317
1318
1319
1320
1321

                if self.use_async_scheduling and num_output_tokens > 0:
                    # We must recover the output token ids for resumed requests in the
                    # async scheduling case, so that correct input_ids are obtained.
                    resumed_token_ids = req_data.all_token_ids[req_id]
                    req_state.output_token_ids = resumed_token_ids[-num_output_tokens:]

1322
                reqs_to_add.append(req_state)
1323
1324
1325
                # Track resumed requests for ngram_gpu full tensor copy
                if is_ngram_gpu:
                    ngram_gpu_new_reqs.append(req_state)
1326
1327
1328
                continue

            # Update the persistent batch.
1329
            self.input_batch.num_computed_tokens_cpu[req_index] = num_computed_tokens
1330
            if new_block_ids is not None:
1331
                self.input_batch.block_table.append_row(new_block_ids, req_index)
1332
1333
1334
1335
1336
1337
1338

            # For the last rank, we don't need to update the token_ids_cpu
            # because the sampled tokens are already cached.
            if not is_last_rank:
                # Add new_token_ids to token_ids_cpu.
                start_token_index = num_computed_tokens
                end_token_index = num_computed_tokens + len(new_token_ids)
1339
                self.input_batch.token_ids_cpu[
1340
1341
1342
                    req_index, start_token_index:end_token_index
                ] = new_token_ids
                self.input_batch.num_tokens_no_spec[req_index] = end_token_index
1343

1344
            # Add spec_token_ids to token_ids_cpu.
1345
            self.input_batch.update_req_spec_token_ids(req_state, scheduled_spec_tokens)
1346
1347
1348
1349
1350
            # Restore scheduler-side draft count after ngram trimming.
            if original_num_spec_per_req:
                orig = original_num_spec_per_req.get(req_id, 0)
                if orig != req_state.prev_num_draft_len:
                    req_state.prev_num_draft_len = orig
1351

1352
1353
        # Add the new or resumed requests to the persistent batch.
        # The smaller empty indices are filled first.
1354
1355
        for request in reqs_to_add:
            self.input_batch.add_request(request)
1356
            self.input_batch.update_req_spec_token_ids(request, scheduled_spec_tokens)
1357

1358
1359
1360
1361
1362
1363
        # Condense the batched states if there are gaps left by removed requests
        self.input_batch.condense()
        # Allow attention backend to reorder the batch, potentially
        self._may_reorder_batch(scheduler_output)
        # Refresh batch metadata with any pending updates.
        self.input_batch.refresh_metadata()
1364

1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
        # Incrementally update ngram_gpu tensors after batch is stable
        if is_ngram_gpu:
            update_ngram_gpu_tensors_incremental(
                self.input_batch,
                self.token_ids_gpu_tensor,
                self.num_tokens_no_spec_gpu,
                ngram_gpu_new_reqs,
                self.device,
                _pinned_idx_buf=self._ngram_pinned_idx_buf,
                _pinned_val_buf=self._ngram_pinned_val_buf,
            )

1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
        if deferred_spec_decode_corrections:

            def correct_spec_decode_token_counts():
                valid_sampled_token_count = self._get_valid_sampled_token_count()
                if not valid_sampled_token_count:
                    return
                prev_req_id_to_index = self.input_batch.prev_req_id_to_index
                if not prev_req_id_to_index:
                    return
                for (
                    req_id,
                    optimistic_num_accepted,
                    req_state,
                ) in deferred_spec_decode_corrections:
                    prev_req_index = prev_req_id_to_index.get(req_id)
                    if prev_req_index is None:
                        continue
                    num_accepted = valid_sampled_token_count[prev_req_index] - 1
                    correction = optimistic_num_accepted - num_accepted
                    req_state.num_computed_tokens -= correction
                    cur_req_index = self.input_batch.req_id_to_index.get(req_id)
                    if cur_req_index is None:
                        continue
                    self.input_batch.num_computed_tokens_cpu[cur_req_index] -= (
                        correction
                    )
                    if is_ngram_gpu and correction > 0:
                        self.input_batch.num_tokens_no_spec[cur_req_index] -= correction
                        self.num_tokens_no_spec_gpu[cur_req_index] -= correction

            return correct_spec_decode_token_counts
        else:
            return None

1411
    def _update_states_after_model_execute(
1412
        self, output_token_ids: torch.Tensor, scheduler_output: "SchedulerOutput"
1413
    ) -> None:
1414
1415
1416
1417
1418
1419
1420
1421
        """Update the cached states after model execution.

        This is used for MTP/EAGLE for hybrid models, as in linear attention,
        only the last token's state is kept. In MTP/EAGLE, for draft tokens
        the state are kept util we decide how many tokens are accepted for
        each sequence, and a shifting is done during the next iteration
        based on the number of accepted tokens.
        """
1422
        if not self.speculative_config or not self.model_config.is_hybrid:
1423
1424
            return

1425
1426
1427
        # TODO: Remove .cpu() sync to enable fully async for hybrid model;
        # Use num_computed_tokens.gpu instead of req.num_computed_tokens to
        # support aligned mamba cache mode.
1428
        # Find the number of accepted tokens for each sequence.
1429
1430
        num_reqs = output_token_ids.size(0)
        self.num_accepted_tokens.gpu[:num_reqs] = (
1431
1432
1433
1434
1435
            (
                torch.cat(
                    [
                        output_token_ids,
                        torch.full(
1436
                            (num_reqs, 1),
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
                            -1,
                            device=output_token_ids.device,
                        ),
                    ],
                    dim=1,
                )
                == -1
            )
            .int()
            .argmax(-1)
        )
1448

1449
        if self.cache_config.mamba_cache_mode == "align":
1450
1451
1452
1453
            for i, num_tokens in enumerate(
                self.num_accepted_tokens.gpu[:num_reqs].cpu().numpy()
            ):
                self.input_batch.num_accepted_tokens_cpu[i] = num_tokens
1454
1455
1456
1457
1458
1459
1460
1461
            mamba_utils.postprocess_mamba(
                scheduler_output,
                self.kv_cache_config,
                self.input_batch,
                self.requests,
                self.mamba_state_idx,
                self.compilation_config.static_forward_context,
                self.model.get_mamba_state_copy_func(),
1462
                self._get_mamba_copy_bufs(),
1463
            )
1464
1465
1466
1467
        else:
            self.input_batch.num_accepted_tokens_cpu_tensor[:num_reqs].copy_(
                self.num_accepted_tokens.gpu[:num_reqs], non_blocking=True
            )
1468
1469
            assert self.num_accepted_tokens_event is not None
            self.num_accepted_tokens_event.record()
1470

1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
    def _update_streaming_request(
        self, req_id: str, new_req_data: NewRequestData
    ) -> CachedRequestState:
        """Updates streaming session request from `scheduled_new_reqs`.

        Removes the request from InputBatch (if present), updates the cached
        state, and prepares it for re-addition to the batch.

        NOTE: prompt_token_ids includes intermediate output tokens - tokens
        previously generated but now are input context (part of the prompt).
        """
        self.input_batch.remove_request(req_id)
        req_state = self.requests[req_id]

        req_state.prompt_token_ids = new_req_data.prompt_token_ids
        req_state.mm_features = new_req_data.mm_features
        req_state.prompt_embeds = new_req_data.prompt_embeds
        req_state.sampling_params = new_req_data.sampling_params
        req_state.pooling_params = new_req_data.pooling_params
1490
        self.late_interaction_runner.register_request(req_id, req_state.pooling_params)
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
        req_state.block_ids = new_req_data.block_ids
        req_state.num_computed_tokens = new_req_data.num_computed_tokens
        req_state.num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
            req_state.prompt_token_ids, req_state.prompt_embeds
        )

        # Clear `output_token_ids` as previous output tokens are now part of
        # `prompt_token_ids`.
        req_state.output_token_ids.clear()

        if self.uses_mrope:
            self._init_mrope_positions(req_state)

        return req_state

1506
    def _init_mrope_positions(self, req_state: CachedRequestState):
1507
1508
        model = self.get_model()
        assert supports_mrope(model), "M-RoPE support is not implemented."
1509
1510
1511
1512
        assert req_state.prompt_token_ids is not None, (
            "M-RoPE requires prompt_token_ids to be available."
        )
        mrope_model = cast(SupportsMRoPE, model)
1513
1514

        req_state.mrope_positions, req_state.mrope_position_delta = (
1515
            mrope_model.get_mrope_input_positions(
1516
                req_state.prompt_token_ids,
1517
                req_state.mm_features,
1518
            )
1519
        )
1520

1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
    def _init_xdrope_positions(self, req_state: CachedRequestState):
        model = self.get_model()
        xdrope_model = cast(SupportsXDRoPE, model)
        assert req_state.prompt_token_ids is not None, (
            "XD-RoPE requires prompt_token_ids to be available."
        )
        assert supports_xdrope(model), "XD-RoPE support is not implemented."

        req_state.xdrope_positions = xdrope_model.get_xdrope_input_positions(
            req_state.prompt_token_ids,
            req_state.mm_features,
        )

1534
    def _extract_mm_kwargs(
1535
        self,
1536
1537
        scheduler_output: "SchedulerOutput",
    ) -> BatchedTensorInputs:
1538
        if not scheduler_output or not self.is_multimodal_raw_input_only_model:
1539
            return {}
1540

1541
        mm_kwargs = list[tuple[str, MultiModalKwargsItem]]()
1542
        for req in scheduler_output.scheduled_new_reqs:
1543
1544
            for feature in req.mm_features:
                if feature.data is not None:
1545
                    mm_kwargs.append((feature.modality, feature.data))
1546

1547
1548
        # Input all modalities at once
        mm_kwargs_combined: BatchedTensorInputs = {}
1549
        for _, _, mm_kwargs_batch in group_and_batch_mm_kwargs(
1550
1551
1552
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
1553
        ):
1554
            mm_kwargs_combined.update(mm_kwargs_batch)
1555

1556
        return mm_kwargs_combined
1557

1558
    def _dummy_mm_kwargs(self, num_seqs: int) -> BatchedTensorInputs:
1559
        if not self.is_multimodal_raw_input_only_model:
1560
            return {}
1561

1562
1563
1564
        mm_budget = self.mm_budget
        assert mm_budget is not None

1565
1566
1567
        if not mm_budget.mm_max_toks_per_item:
            return {}  # No tower modalities (embed-only mode)

1568
1569
        dummy_modality = mm_budget.get_modality_with_max_tokens()
        return self._get_mm_dummy_batch(dummy_modality, num_seqs)
1570

1571
1572
1573
    def _get_cumsum_and_arange(
        self,
        num_tokens: np.ndarray,
1574
        arange_out: np.ndarray,
1575
        cumsum_dtype: np.dtype | None = None,
1576
    ) -> np.ndarray:
1577
        """Get the cumulative sum and batched arange of the given array.
1578
1579
1580
1581
        E.g., [2, 5, 3] -> [2, 7, 10], arange written to
        arange_out[:10] as [0, 1, 0, 1, 2, 3, 4, 0, 1, 2].
        Equivalent to but faster than:
        np.concatenate([np.arange(n) for n in num_tokens])
1582
1583
1584
1585
1586
1587
1588
        """
        # Step 1. [2, 5, 3] -> [2, 7, 10]
        cu_num_tokens = np.cumsum(num_tokens, dtype=cumsum_dtype)
        total_num_tokens = cu_num_tokens[-1]
        # Step 2. [2, 7, 10] -> [0, 0, 2, 2, 2, 2, 2, 7, 7, 7]
        cumsums_offsets = np.repeat(cu_num_tokens - num_tokens, num_tokens)
        # Step 3. [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
        np.subtract(
            self.arange_np[:total_num_tokens],
            cumsums_offsets,
            out=arange_out[:total_num_tokens],
        )

        return cu_num_tokens

    def _compute_prev_positions(self, num_reqs: int) -> None:
        """Build prev_positions mapping: current pos -> previous pos (-1 if new).

        Populates self.prev_positions.np[:num_reqs] with the mapping.
        """
        prev_req_id_to_index = self.input_batch.prev_req_id_to_index
        prev_positions = self.prev_positions.np[:num_reqs]

        if not prev_req_id_to_index:
            prev_positions.fill(-1)
            return
1608

1609
1610
        for i, req_id in enumerate(self.input_batch.req_ids[:num_reqs]):
            prev_positions[i] = prev_req_id_to_index.get(req_id, -1)
1611

1612
    def _prepare_input_ids(
1613
1614
        self,
        scheduler_output: "SchedulerOutput",
1615
        num_reqs: int,
1616
1617
        total_num_scheduled_tokens: int,
        cu_num_tokens: np.ndarray,
1618
    ) -> None:
1619
        """Prepare the input IDs for the current batch.
1620

1621
1622
        Carefully handles the `prev_sampled_token_ids` which can be cached
        from the previous engine iteration, in which case those tokens on the
1623
1624
1625
1626
1627
        GPU need to be copied into the corresponding slots into input_ids.

        Uses self.prev_positions[:num_reqs] which maps current pos -> prev pos
        (-1 for new requests).
        """
1628
1629
1630
1631

        if self.input_batch.prev_sampled_token_ids is None:
            # Normal scheduling case
            self.input_ids.copy_to_gpu(total_num_scheduled_tokens)
1632
1633
1634
            if self.enable_prompt_embeds:
                self.inputs_embeds.copy_to_gpu(total_num_scheduled_tokens)
                self.is_token_ids.copy_to_gpu(total_num_scheduled_tokens)
1635
1636
1637
1638
1639
            return

        # Async scheduling case, where some decode requests from the previous
        # iteration won't have entries in input_ids_cpu and need to be copied
        # on the GPU from prev_sampled_token_ids.
1640
1641
        prev_positions = self.prev_positions.np[:num_reqs]
        scheduled_spec_tokens = scheduler_output.scheduled_spec_decode_tokens
1642
1643
1644
        sample_flattened_indices: list[int] = []
        spec_flattened_indices: list[int] = []
        prev_draft_token_indices: list[int] = []
1645
1646
        prev_indices: list[int] = []
        common_indices_match = True
1647
        max_flattened_index = -1
1648
1649
        total_num_spec_tokens = 0

1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
        for cur_index in range(num_reqs):
            prev_index = prev_positions[cur_index]
            if prev_index < 0:
                continue
            prev_indices.append(prev_index)
            req_id = self.input_batch.req_ids[cur_index]
            # We need to compute the flattened input_ids index of the
            # last token in each common request.
            draft_len = len(scheduled_spec_tokens.get(req_id, ()))
            total_num_spec_tokens += draft_len
            flattened_index = cu_num_tokens[cur_index].item() - 1
            # example: cu_num_tokens = [2, 5, 8], draft_tokens = [1, 2, 2]
            # sample_flattened_indices = [0, 2, 5]
            # spec_flattened_indices = [1,   3, 4,    6, 7]
            sample_flattened_indices.append(flattened_index - draft_len)
            spec_flattened_indices.extend(
                range(flattened_index - draft_len + 1, flattened_index + 1)
            )
            start = prev_index * self.num_spec_tokens
            # prev_draft_token_indices is used to find which draft_tokens_id
            # should be copied to input_ids
            # example: prev draft_tokens_id [[1,2], [3,4], [5, 6]]
            # flatten draft_tokens_id [1,2,3,4,5,6]
            # draft_len of each request [1, 2, 1]
            # then prev_draft_token_indices is [0,   2, 3,   4]
            prev_draft_token_indices.extend(range(start, start + draft_len))
            common_indices_match &= prev_index == flattened_index
            max_flattened_index = max(max_flattened_index, flattened_index)

Jiayi Yan's avatar
Jiayi Yan committed
1679
        num_common_tokens = len(sample_flattened_indices)
1680
        total_without_spec = total_num_scheduled_tokens - total_num_spec_tokens
Jiayi Yan's avatar
Jiayi Yan committed
1681
        if num_common_tokens < total_without_spec:
1682
            # If not all requests are decodes from the last iteration,
1683
            # we need to copy the input_ids_cpu to the GPU first.
1684
            self.input_ids.copy_to_gpu(total_num_scheduled_tokens)
1685
1686
1687
            if self.enable_prompt_embeds:
                self.inputs_embeds.copy_to_gpu(total_num_scheduled_tokens)
                self.is_token_ids.copy_to_gpu(total_num_scheduled_tokens)
Jiayi Yan's avatar
Jiayi Yan committed
1688
        if num_common_tokens == 0:
1689
            # No requests in common with the previous iteration
1690
            # So input_ids.cpu will have all the input ids.
1691
            return
1692
        if common_indices_match and max_flattened_index == (num_common_tokens - 1):
1693
1694
1695
1696
            # Common-case optimization: the batch is unchanged
            # and no reordering happened.
            # The indices are both the same permutation of 0..N-1 so
            # we can copy directly using a single slice.
Jiayi Yan's avatar
Jiayi Yan committed
1697
1698
            self.input_ids.gpu[:num_common_tokens].copy_(
                self.input_batch.prev_sampled_token_ids[:num_common_tokens, 0],
1699
1700
                non_blocking=True,
            )
1701
            if self.enable_prompt_embeds:
Jiayi Yan's avatar
Jiayi Yan committed
1702
                self.is_token_ids.gpu[:num_common_tokens] = True
1703
            return
1704
        # Upload the index tensors asynchronously so the scatter can be non-blocking.
1705
1706
        sampled_tokens_index_tensor = torch.tensor(
            sample_flattened_indices, dtype=torch.int64, pin_memory=self.pin_memory
1707
        ).to(self.device, non_blocking=True)
1708
        prev_common_req_indices_tensor = torch.tensor(
1709
            prev_indices, dtype=torch.int64, pin_memory=self.pin_memory
1710
        ).to(self.device, non_blocking=True)
1711
1712
        self.input_ids.gpu.scatter_(
            dim=0,
1713
            index=sampled_tokens_index_tensor,
1714
            src=self.input_batch.prev_sampled_token_ids[
1715
1716
1717
                prev_common_req_indices_tensor, 0
            ],
        )
1718

1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
        # Scatter the draft tokens after the sampled tokens are scattered.
        if self._draft_token_ids is None or not spec_flattened_indices:
            return

        assert isinstance(self._draft_token_ids, torch.Tensor)
        draft_tokens_index_tensor = torch.tensor(
            spec_flattened_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)
        prev_draft_token_indices_tensor = torch.tensor(
            prev_draft_token_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)

        # because input_ids dtype is torch.int32,
        # so convert draft_token_ids to torch.int32 here.
        draft_token_ids = self._draft_token_ids.to(dtype=torch.int32)

        self.input_ids.gpu.scatter_(
            dim=0,
            index=draft_tokens_index_tensor,
            src=draft_token_ids.flatten()[prev_draft_token_indices_tensor],
        )

1741
1742
    def _get_encoder_seq_lens(
        self,
1743
        num_scheduled_tokens: dict[str, int],
1744
1745
        kv_cache_spec: KVCacheSpec,
        num_reqs: int,
1746
        for_cudagraph_capture: bool = False,
1747
    ) -> tuple[torch.Tensor | None, np.ndarray | None]:
1748
        if not isinstance(kv_cache_spec, CrossAttentionSpec):
1749
            return None, None
1750

1751
1752
        # Zero out buffer for padding requests that are not actually scheduled (CGs)
        self.encoder_seq_lens.np[:num_reqs] = 0
1753

1754
1755
        # Build encoder_seq_lens array mapping request indices to
        # encoder lengths for inputs scheduled in this batch
1756
        for req_id in num_scheduled_tokens:
1757
            req_index = self.input_batch.req_id_to_index[req_id]
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
            req_state = self.requests[req_id]
            if req_state.mm_features is None:
                self.encoder_seq_lens.np[req_index] = 0
                continue

            # Get the total number of encoder input tokens for running encoder requests
            # whether encoding is finished or not so that cross-attention knows how
            # many encoder tokens to attend to.
            encoder_input_tokens = sum(
                feature.mm_position.length for feature in req_state.mm_features
            )
            self.encoder_seq_lens.np[req_index] = encoder_input_tokens
1770
1771
1772
1773
1774
1775
1776
1777
1778
        if for_cudagraph_capture:
            # During CUDA graph capture, we need to use realistic encoder lengths
            # so that max_seqlen_k is captured with the correct value.
            max_encoder_len = getattr(
                self.model_config.hf_config,
                "max_source_positions",
                self.max_encoder_len,
            )
            self.encoder_seq_lens.np[:num_reqs] = max_encoder_len
1779
1780
1781
1782

        self.encoder_seq_lens.copy_to_gpu(num_reqs)
        encoder_seq_lens = self.encoder_seq_lens.gpu[:num_reqs]
        encoder_seq_lens_cpu = self.encoder_seq_lens.np[:num_reqs]
1783

1784
        return encoder_seq_lens, encoder_seq_lens_cpu
1785

1786
    def _prepare_inputs(
1787
1788
1789
        self,
        scheduler_output: "SchedulerOutput",
        num_scheduled_tokens: np.ndarray,
1790
1791
    ) -> tuple[
        torch.Tensor,
1792
        SpecDecodeMetadata | None,
1793
    ]:
1794
1795
        """
        :return: tuple[
1796
            logits_indices, spec_decode_metadata,
1797
1798
        ]
        """
1799
1800
1801
1802
1803
1804
1805
        total_num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
        assert total_num_scheduled_tokens > 0
        num_reqs = self.input_batch.num_reqs
        assert num_reqs > 0

        # OPTIMIZATION: Start copying the block table first.
        # This way, we can overlap the copy with the following CPU operations.
1806
        self.input_batch.block_table.commit_block_table(num_reqs)
1807
1808
1809

        # Get request indices.
        # E.g., [2, 5, 3] -> [0, 0, 1, 1, 1, 1, 1, 2, 2, 2]
1810
        req_indices = np.repeat(self.arange_np[:num_reqs], num_scheduled_tokens)
1811

1812
        # cu_num_tokens: [2, 5, 3] -> [2, 7, 10]
1813
1814
1815
1816
        # self.query_pos.np[:10]: [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
        cu_num_tokens = self._get_cumsum_and_arange(
            num_scheduled_tokens, self.query_pos.np
        )
1817
1818

        # Get positions.
1819
1820
1821
        positions_np = (
            self.input_batch.num_computed_tokens_cpu[req_indices]
            + self.query_pos.np[: cu_num_tokens[-1]]
1822
        )
1823

1824
1825
        # Calculate M-RoPE positions.
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1826
        if self.uses_mrope:
1827
1828
            self._calc_mrope_positions(scheduler_output)

1829
1830
1831
1832
1833
        # Calculate XD-RoPE positions.
        # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
        if self.uses_xdrope_dim > 0:
            self._calc_xdrope_positions(scheduler_output)

1834
1835
1836
1837
        # Get token indices.
        # E.g., [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
        # -> [0, 1, M, M + 1, M + 2, M + 3, M + 4, 2 * M, 2 * M + 1, 2 * M + 2]
        # where M is the max_model_len.
1838
1839
1840
        token_indices = (
            positions_np + req_indices * self.input_batch.token_ids_cpu.shape[1]
        )
1841
        token_indices_tensor = torch.from_numpy(token_indices)
1842

1843
1844
1845
        # NOTE(woosuk): We use torch.index_select instead of np.take here
        # because torch.index_select is much faster than np.take for large
        # tensors.
1846
1847
1848
1849
1850
1851
        torch.index_select(
            self.input_batch.token_ids_cpu_tensor.flatten(),
            0,
            token_indices_tensor,
            out=self.input_ids.cpu[:total_num_scheduled_tokens],
        )
1852
        if self.enable_prompt_embeds:
1853
            is_token_ids = self.input_batch.is_token_ids_tensor.flatten()
1854
1855
1856
1857
            torch.index_select(
                is_token_ids,
                0,
                token_indices_tensor,
1858
1859
                out=self.is_token_ids.cpu[:total_num_scheduled_tokens],
            )
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892

        # Because we did not pre-allocate a massive prompt_embeds CPU tensor on
        # the InputBatch, we need to fill in the prompt embeds into the expected
        # spots in the GpuModelRunner's pre-allocated prompt_embeds tensor.
        if self.input_batch.req_prompt_embeds:
            output_idx = 0
            for req_idx in range(num_reqs):
                num_sched = num_scheduled_tokens[req_idx]

                # Skip if this request doesn't have embeddings
                if req_idx not in self.input_batch.req_prompt_embeds:
                    output_idx += num_sched
                    continue

                # Skip if no tokens scheduled
                if num_sched <= 0:
                    output_idx += num_sched
                    continue

                req_embeds = self.input_batch.req_prompt_embeds[req_idx]
                start_pos = self.input_batch.num_computed_tokens_cpu[req_idx]

                # Skip if trying to read beyond available embeddings
                if start_pos >= req_embeds.shape[0]:
                    output_idx += num_sched
                    continue

                # Copy available embeddings
                end_pos = start_pos + num_sched
                actual_end = min(end_pos, req_embeds.shape[0])
                actual_num_sched = actual_end - start_pos

                if actual_num_sched > 0:
1893
1894
1895
                    self.inputs_embeds.cpu[
                        output_idx : output_idx + actual_num_sched
                    ].copy_(req_embeds[start_pos:actual_end])
1896
1897

                output_idx += num_sched
1898
1899

        # Prepare the attention metadata.
1900
        self.query_start_loc.np[0] = 0
1901
        self.query_start_loc.np[1 : num_reqs + 1] = cu_num_tokens
1902
1903
        # Note: pad query_start_loc to be non-decreasing, as kernels
        # like FlashAttention requires that
1904
        self.query_start_loc.np[num_reqs + 1 :].fill(cu_num_tokens[-1])
1905
        self.query_start_loc.copy_to_gpu()
1906
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1907

1908
1909
1910
1911
1912
1913
1914
1915
        # Compute optimistic seq_lens (assumes all draft tokens from previous
        # iteration accepted). Store in optimistic_seq_lens_cpu for use by
        # _build_attention_metadata (max_seq_len) and discard_request_mask.
        # seq_lens (GPU) will be computed later using the same optimistic values.
        torch.add(
            self.input_batch.num_computed_tokens_cpu_tensor[:num_reqs],
            torch.from_numpy(num_scheduled_tokens),
            out=self.optimistic_seq_lens_cpu[:num_reqs],
1916
        )
1917
1918
1919
1920
1921
1922
        self.optimistic_seq_lens_cpu[num_reqs:].fill_(0)

        # Build prev_positions mapping: current pos -> prev pos (-1 if new).
        # Used for gathering from previous iteration's GPU tensors.
        prev_req_id_to_index = self.input_batch.prev_req_id_to_index
        self._compute_prev_positions(num_reqs)
1923

1924
        num_tokens = [self.requests[r].num_tokens for r in self.input_batch.req_ids]
1925
1926
        num_tokens_np = np.array(num_tokens, dtype=np.int32)

1927
        # Record which requests should not be sampled,
1928
        # so that we could clear the sampled tokens before returning
1929
        self.discard_request_mask.np[:num_reqs] = (
1930
            self.optimistic_seq_lens_cpu[:num_reqs].numpy() < num_tokens_np
1931
        )
1932
        self.discard_request_mask.copy_to_gpu(num_reqs)
1933

1934
1935
1936
1937
        # Sync num_accepted_tokens from CPU (set by
        # _update_states_after_model_execute for hybrid models).
        if self.num_accepted_tokens_event is not None:
            self.num_accepted_tokens_event.synchronize()
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
            # Async mode: condense() reordered indices, use prev_positions mapping
            if self.use_async_scheduling and prev_req_id_to_index:
                prev_idx = self.prev_positions.np[:num_reqs]
                new_mask = prev_idx < 0
                self.num_accepted_tokens.np[:num_reqs] = (
                    self.input_batch.num_accepted_tokens_cpu[
                        np.where(new_mask, 0, prev_idx)
                    ]
                )
                self.num_accepted_tokens.np[:num_reqs][new_mask] = 1
                self.input_batch.num_accepted_tokens_cpu[:num_reqs] = (
                    self.num_accepted_tokens.np[:num_reqs]
                )
            else:
                # Non-async mode: use values directly
                self.num_accepted_tokens.np[:num_reqs] = (
                    self.input_batch.num_accepted_tokens_cpu[:num_reqs]
                )
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
            self.num_accepted_tokens.np[num_reqs:].fill(1)
            self.num_accepted_tokens.copy_to_gpu()
        else:
            self.num_accepted_tokens.np.fill(1)
            self.num_accepted_tokens.gpu.fill_(1)

        # Update num_computed_tokens on GPU. In async spec decode,
        # CPU values are optimistic (all drafts accepted). The kernel
        # corrects on GPU using the previous step's
        # valid_sampled_token_count_gpu. Otherwise, just copy from CPU.
        if (
            self.use_async_spec_decode
            and self.valid_sampled_token_count_gpu is not None
            and prev_req_id_to_index
        ):
            self.prev_positions.copy_to_gpu(num_reqs)
            self.prev_num_draft_tokens.copy_to_gpu()
            cpu_values = self.input_batch.num_computed_tokens_cpu_tensor[:num_reqs].to(
                device=self.device, non_blocking=True
            )
            update_num_computed_tokens_for_batch_change(
                self.num_computed_tokens,
                self.num_accepted_tokens.gpu[:num_reqs],
                self.prev_positions.gpu[:num_reqs],
                self.valid_sampled_token_count_gpu,
                self.prev_num_draft_tokens.gpu,
                cpu_values,
            )
        else:
            self.num_computed_tokens[:num_reqs].copy_(
                self.input_batch.num_computed_tokens_cpu_tensor[:num_reqs],
                non_blocking=True,
            )

        self.req_indices.np[:total_num_scheduled_tokens] = req_indices
        self.req_indices.copy_to_gpu(total_num_scheduled_tokens)
        req_indices_gpu = self.req_indices.gpu[:total_num_scheduled_tokens]

        self.query_pos.copy_to_gpu(total_num_scheduled_tokens)
        self.num_scheduled_tokens.np[:num_reqs] = num_scheduled_tokens
        self.num_scheduled_tokens.copy_to_gpu(num_reqs)
        num_scheduled_tokens_gpu = self.num_scheduled_tokens.gpu[:num_reqs]
        self.positions[:total_num_scheduled_tokens] = (
            self.num_computed_tokens[req_indices_gpu].to(torch.int64)
            + self.query_pos.gpu[:total_num_scheduled_tokens]
        )
        self.seq_lens[:num_reqs] = (
            self.num_computed_tokens[:num_reqs] + num_scheduled_tokens_gpu
        )
        self.seq_lens[num_reqs:].fill_(0)

        self.input_batch.block_table.compute_slot_mapping(
            num_reqs,
            self.query_start_loc.gpu[: num_reqs + 1],
            self.positions[:total_num_scheduled_tokens],
        )

2013
        # Copy the tensors to the GPU.
2014
2015
        self._prepare_input_ids(
            scheduler_output,
2016
            num_reqs,
2017
2018
2019
            total_num_scheduled_tokens,
            cu_num_tokens,
        )
2020

2021
        if self.uses_mrope:
2022
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
2023
2024
            self.mrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.mrope_positions.cpu[:, :total_num_scheduled_tokens],
2025
2026
                non_blocking=True,
            )
2027
2028
2029
2030
2031
2032
        elif self.uses_xdrope_dim > 0:
            # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
            self.xdrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.xdrope_positions.cpu[:, :total_num_scheduled_tokens],
                non_blocking=True,
            )
2033
2034
2035
2036
2037
2038
2039
2040
        if self.use_async_spec_decode and (self.uses_mrope or self.uses_xdrope_dim > 0):
            drift = self.num_computed_tokens[req_indices_gpu].to(
                torch.int64
            ) - self.input_batch.num_computed_tokens_cpu_tensor[req_indices].to(
                device=self.device, dtype=torch.int64, non_blocking=True
            )
            target = self.mrope_positions if self.uses_mrope else self.xdrope_positions
            target.gpu[:, :total_num_scheduled_tokens] += drift
2041

2042
        use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
2043
2044
2045
2046
2047
2048
2049
2050
        if not use_spec_decode:
            # NOTE(woosuk): Due to chunked prefills, the batch may contain
            # partial requests. While we should not sample any token
            # from these partial requests, we do so for simplicity.
            # We will ignore the sampled tokens from the partial requests.
            # TODO: Support prompt logprobs.
            logits_indices = query_start_loc[1:] - 1
            spec_decode_metadata = None
2051
            num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
2052
2053
2054
2055
2056
        else:
            # Get the number of draft tokens for each request.
            # Iterate over the dictionary rather than all requests since not all
            # requests have draft tokens.
            num_draft_tokens = np.zeros(num_reqs, dtype=np.int32)
2057
2058
2059
            # For chunked prefills, use -1 as mask rather than 0, as guided
            # decoding may rollback speculative tokens.
            num_decode_draft_tokens = np.full(num_reqs, -1, dtype=np.int32)
2060
2061
2062
2063
            for (
                req_id,
                draft_token_ids,
            ) in scheduler_output.scheduled_spec_decode_tokens.items():
2064
                req_idx = self.input_batch.req_id_to_index[req_id]
2065
2066
                draft_len = len(draft_token_ids)
                num_draft_tokens[req_idx] = draft_len
2067
2068
2069
2070
                if (
                    self.input_batch.num_computed_tokens_cpu[req_idx]
                    >= self.input_batch.num_prompt_tokens[req_idx]
                ):
2071
                    num_decode_draft_tokens[req_idx] = draft_len
2072
            spec_decode_metadata = self._calc_spec_decode_metadata(
2073
2074
                num_draft_tokens, cu_num_tokens
            )
2075
            logits_indices = spec_decode_metadata.logits_indices
2076
            num_sampled_tokens = num_draft_tokens + 1
2077
            # For DECODE only cuda graph of some attention backends (e.g., GDN).
2078
            self.num_decode_draft_tokens.np[:num_reqs] = num_decode_draft_tokens
2079
2080
            self.num_decode_draft_tokens.np[num_reqs:].fill(-1)
            self.num_decode_draft_tokens.copy_to_gpu()
2081

2082
2083
2084
2085
2086
        # Hot-Swap lora model
        if self.lora_config:
            assert (
                np.sum(num_sampled_tokens)
                <= self.vllm_config.scheduler_config.max_num_batched_tokens
2087
            )
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
            self.set_active_loras(
                self.input_batch, num_scheduled_tokens, num_sampled_tokens
            )

        return (
            logits_indices,
            spec_decode_metadata,
        )

    def _build_attention_metadata(
        self,
2099
        num_tokens: int,
2100
        num_reqs: int,
2101
2102
2103
        max_query_len: int,
        num_tokens_padded: int | None = None,
        num_reqs_padded: int | None = None,
2104
2105
2106
2107
        ubatch_slices: UBatchSlices | None = None,
        logits_indices: torch.Tensor | None = None,
        use_spec_decode: bool = False,
        for_cudagraph_capture: bool = False,
2108
        num_scheduled_tokens: dict[str, int] | None = None,
2109
        cascade_attn_prefix_lens: list[list[int]] | None = None,
2110
        slot_mappings: dict[int, torch.Tensor] | None = None,
2111
2112
2113
2114
    ) -> tuple[PerLayerAttnMetadata, CommonAttentionMetadata | None]:
        """
        :return: tuple[attn_metadata, spec_decode_common_attn_metadata]
        """
2115
2116
2117
2118
        # Attention metadata is not needed for attention free models
        if len(self.kv_cache_config.kv_cache_groups) == 0:
            return {}, None

2119
2120
        num_tokens_padded = num_tokens_padded or num_tokens
        num_reqs_padded = num_reqs_padded or num_reqs
2121
        assert num_reqs_padded is not None and num_tokens_padded is not None
2122

2123
2124
2125
        attn_metadata: PerLayerAttnMetadata = {}
        if ubatch_slices is not None:
            attn_metadata = [dict() for _ in range(len(ubatch_slices))]
2126

2127
2128
2129
2130
2131
2132
        if for_cudagraph_capture:
            # For some attention backends (e.g. FA) with sliding window models we need
            # to make sure the backend see a max_seq_len that is larger to the sliding
            # window size when capturing to make sure the correct kernel is selected.
            max_seq_len = self.max_model_len
        else:
2133
            max_seq_len = self.optimistic_seq_lens_cpu.numpy()[:num_reqs].max().item()
2134

2135
        kv_cache_groups = self.kv_cache_config.kv_cache_groups
2136

2137
        def _get_block_table(kv_cache_gid: int):
2138
2139
2140
            assert num_reqs_padded is not None and num_tokens_padded is not None
            kv_cache_spec = kv_cache_groups[kv_cache_gid].kv_cache_spec
            if isinstance(kv_cache_spec, EncoderOnlyAttentionSpec):
2141
                blk_table_tensor = torch.zeros(
2142
                    (num_reqs_padded, 1),
2143
                    dtype=torch.int32,
2144
2145
                    device=self.device,
                )
2146
            else:
2147
                blk_table = self.input_batch.block_table[kv_cache_gid]
2148
                blk_table_tensor = blk_table.get_device_tensor(num_reqs_padded)
2149

2150
2151
2152
            # Fill unused block table entries with NULL_BLOCK_ID (null block)
            # for CUDAGraph padding. Block 0 is reserved for padding.
            blk_table_tensor[num_reqs:num_reqs_padded].fill_(NULL_BLOCK_ID)
2153
            return blk_table_tensor
2154

2155
2156
2157
        assert slot_mappings is not None
        block_table_gid_0 = _get_block_table(0)
        slot_mapping_gid_0 = slot_mappings[0]
2158

2159
2160
2161
2162
        if self.routed_experts_initialized:
            attn_gid = self.routed_experts_attn_gid
            slot_mapping_attn = slot_mappings[attn_gid]
            self.slot_mapping = slot_mapping_attn[:num_tokens].cpu().numpy()
2163
2164
2165
2166
2167
2168
        num_computed_tokens_cpu = self.input_batch.num_computed_tokens_cpu_tensor[
            :num_reqs_padded
        ]
        num_prompt_tokens_cpu = self.input_batch.num_prompt_tokens_cpu_tensor[
            :num_reqs_padded
        ]
2169
2170
2171
2172
2173
        seq_lens_cpu = self.optimistic_seq_lens_cpu[:num_reqs_padded]

        # is_prefilling: True if request is still in prefill phase.
        # Used by mamba backends to distinguish actual decodes from
        # short extends.
2174
2175
        is_prefilling = num_computed_tokens_cpu < num_prompt_tokens_cpu

2176
2177
2178
2179
2180
        if self.use_async_spec_decode:
            # GPU tensors are authoritative in async mode.
            seq_lens_cpu = None
            num_computed_tokens_cpu = None

2181
2182
2183
        cm_base = CommonAttentionMetadata(
            query_start_loc=self.query_start_loc.gpu[: num_reqs_padded + 1],
            query_start_loc_cpu=self.query_start_loc.cpu[: num_reqs_padded + 1],
2184
2185
            seq_lens=self.seq_lens[:num_reqs_padded],
            _seq_lens_cpu=seq_lens_cpu,
2186
            _num_computed_tokens_cpu=num_computed_tokens_cpu,
2187
2188
2189
2190
2191
2192
2193
            num_reqs=num_reqs_padded,
            num_actual_tokens=num_tokens_padded,
            max_query_len=max_query_len,
            max_seq_len=max_seq_len,
            block_table_tensor=block_table_gid_0,
            slot_mapping=slot_mapping_gid_0,
            causal=True,
2194
            is_prefilling=is_prefilling,
2195
2196
2197
2198
        )

        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens.cpu[:num_reqs] = get_dcp_local_seq_lens(
2199
                self.optimistic_seq_lens_cpu[:num_reqs],
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
                self.dcp_world_size,
                self.dcp_rank,
                self.parallel_config.cp_kv_cache_interleave_size,
            )
            self.dcp_local_seq_lens.cpu[num_reqs:].fill_(0)
            self.dcp_local_seq_lens.copy_to_gpu(num_reqs_padded)

            cm_base.dcp_local_seq_lens = self.dcp_local_seq_lens.gpu[:num_reqs_padded]
            cm_base.dcp_local_seq_lens_cpu = self.dcp_local_seq_lens.cpu[
                :num_reqs_padded
            ]

        if logits_indices is not None and self.cache_config.kv_sharing_fast_prefill:
            cm_base.num_logits_indices = logits_indices.size(0)
            cm_base.logits_indices_padded = self._prepare_kv_sharing_fast_prefill(
                logits_indices
            )

2218
2219
2220
2221
2222
2223
2224
2225
2226
        # Cache attention metadata builds across hybrid KV-cache groups
        # The only thing that changes between different hybrid KV-cache groups when the
        # same metadata builder and KVCacheSpec is the same is the block table, so we
        # can cache the attention metadata builds and just update the block table using
        # `builder.update_block_table` if the builder supports it.
        cached_attn_metadata: dict[
            tuple[KVCacheSpec, type[AttentionMetadataBuilder]], AttentionMetadata
        ] = {}

2227
2228
2229
2230
2231
2232
2233
        def _build_attn_group_metadata(
            kv_cache_gid: int,
            attn_gid: int,
            common_attn_metadata: CommonAttentionMetadata,
            ubid: int | None = None,
        ) -> None:
            attn_group = self.attn_groups[kv_cache_gid][attn_gid]
2234
            builder = attn_group.get_metadata_builder(ubid or 0)
2235
2236
2237
2238
            kv_cache_spec = kv_cache_groups[kv_cache_gid].kv_cache_spec
            if isinstance(kv_cache_spec, UniformTypeKVCacheSpecs):
                kv_cache_spec = kv_cache_spec.kv_cache_specs[attn_group.layer_names[0]]
            cache_key = (kv_cache_spec, type(builder))
2239

2240
2241
2242
2243
2244
2245
2246
            cascade_attn_prefix_len = (
                cascade_attn_prefix_lens[kv_cache_gid][attn_gid]
                if cascade_attn_prefix_lens
                else 0
            )

            extra_attn_metadata_args = {}
2247
2248
2249
            if use_spec_decode and isinstance(
                builder, (Mamba2AttentionMetadataBuilder, GDNAttentionMetadataBuilder)
            ):
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
                assert ubid is None, "UBatching not supported with GDN yet"
                extra_attn_metadata_args = dict(
                    num_accepted_tokens=self.num_accepted_tokens.gpu[:num_reqs_padded],
                    num_decode_draft_tokens_cpu=self.num_decode_draft_tokens.cpu[
                        :num_reqs_padded
                    ],
                )

            if for_cudagraph_capture:
                attn_metadata_i = builder.build_for_cudagraph_capture(
                    common_attn_metadata
                )
2262
2263
2264
2265
2266
2267
2268
2269
2270
            elif (
                cache_key in cached_attn_metadata
                and builder.supports_update_block_table
            ):
                attn_metadata_i = builder.update_block_table(
                    cached_attn_metadata[cache_key],
                    common_attn_metadata.block_table_tensor,
                    common_attn_metadata.slot_mapping,
                )
2271
2272
2273
2274
2275
2276
            else:
                attn_metadata_i = builder.build(
                    common_prefix_len=cascade_attn_prefix_len,
                    common_attn_metadata=common_attn_metadata,
                    **extra_attn_metadata_args,
                )
2277
2278
                if builder.supports_update_block_table:
                    cached_attn_metadata[cache_key] = attn_metadata_i
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301

            if ubid is None:
                assert isinstance(attn_metadata, dict)
                attn_metadata_dict = attn_metadata
            else:
                assert isinstance(attn_metadata, list)
                attn_metadata_dict = attn_metadata[ubid]

            for layer_name in attn_group.layer_names:
                attn_metadata_dict[layer_name] = attn_metadata_i

        # Prepare the attention metadata for each KV cache group and make layers
        # in the same group share the same metadata.
        spec_decode_common_attn_metadata = None
        for kv_cache_gid, kv_cache_group in enumerate(kv_cache_groups):
            cm = copy(cm_base)  # shallow copy

            # Basically only the encoder seq_lens, block_table and slot_mapping change
            # for each kv_cache_group.
            cm.encoder_seq_lens, cm.encoder_seq_lens_cpu = self._get_encoder_seq_lens(
                num_scheduled_tokens or {},
                kv_cache_group.kv_cache_spec,
                num_reqs_padded,
2302
                for_cudagraph_capture=for_cudagraph_capture,
2303
            )
2304
            if kv_cache_gid > 0:
2305
2306
                cm.block_table_tensor = _get_block_table(kv_cache_gid)
                cm.slot_mapping = slot_mappings[kv_cache_gid]
2307

2308
            if self.speculative_config and spec_decode_common_attn_metadata is None:
2309
                if isinstance(self.drafter, (EagleProposer, DFlashProposer)):
2310
                    if self.drafter.kv_cache_gid == kv_cache_gid:
2311
                        spec_decode_common_attn_metadata = cm
2312
                else:
2313
                    spec_decode_common_attn_metadata = cm
2314

2315
            for attn_gid in range(len(self.attn_groups[kv_cache_gid])):
2316
                if ubatch_slices is not None:
2317
2318
2319
                    for ubid, _cm in enumerate(split_attn_metadata(ubatch_slices, cm)):
                        _build_attn_group_metadata(kv_cache_gid, attn_gid, _cm, ubid)

2320
                else:
2321
                    _build_attn_group_metadata(kv_cache_gid, attn_gid, cm)
2322

2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
        if self.is_mm_prefix_lm:
            req_doc_ranges = {}
            for req_id in self.input_batch.req_ids:
                image_doc_ranges = []
                req_state = self.requests[req_id]
                for mm_feature in req_state.mm_features:
                    pos_info = mm_feature.mm_position
                    img_doc_range = pos_info.extract_embeds_range()
                    image_doc_ranges.extend(img_doc_range)
                req_idx = self.input_batch.req_id_to_index[req_id]
                req_doc_ranges[req_idx] = image_doc_ranges

2335
2336
            # Set mm_prefix_range for all attention metadata
            self._set_mm_prefix_range_for_metadata(attn_metadata, req_doc_ranges)
2337

2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
        if spec_decode_common_attn_metadata is not None and (
            num_reqs != num_reqs_padded or num_tokens != num_tokens_padded
        ):
            # Currently the drafter still only uses piecewise cudagraphs (and modifies
            # the attention metadata in directly), and therefore does not want to use
            # padded attention metadata.
            spec_decode_common_attn_metadata = (
                spec_decode_common_attn_metadata.unpadded(num_tokens, num_reqs)
            )

2348
        return attn_metadata, spec_decode_common_attn_metadata
2349

2350
2351
2352
    def _compute_cascade_attn_prefix_lens(
        self,
        num_scheduled_tokens: np.ndarray,
2353
        num_computed_tokens: np.ndarray,
2354
2355
2356
2357
2358
2359
2360
        num_common_prefix_blocks: list[int],
    ) -> list[list[int]] | None:
        """
        :return: Optional[cascade_attn_prefix_lens]
            cascade_attn_prefix_lens is 2D: ``[kv_cache_group_id][attn_group_idx]``,
            None if we should not use cascade attention
        """
2361

2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
        use_cascade_attn = False
        num_kv_cache_groups = len(self.kv_cache_config.kv_cache_groups)
        cascade_attn_prefix_lens: list[list[int]] = [
            [] for _ in range(num_kv_cache_groups)
        ]

        for kv_cache_gid in range(num_kv_cache_groups):
            for attn_group in self.attn_groups[kv_cache_gid]:
                if isinstance(attn_group.kv_cache_spec, EncoderOnlyAttentionSpec):
                    cascade_attn_prefix_len = 0
                else:
                    # 0 if cascade attention should not be used
                    cascade_attn_prefix_len = self._compute_cascade_attn_prefix_len(
                        num_scheduled_tokens,
2376
                        num_computed_tokens,
2377
2378
2379
2380
2381
2382
2383
2384
                        num_common_prefix_blocks[kv_cache_gid],
                        attn_group.kv_cache_spec,
                        attn_group.get_metadata_builder(),
                    )
                cascade_attn_prefix_lens[kv_cache_gid].append(cascade_attn_prefix_len)
                use_cascade_attn |= cascade_attn_prefix_len > 0

        return cascade_attn_prefix_lens if use_cascade_attn else None
2385

2386
2387
2388
    def _compute_cascade_attn_prefix_len(
        self,
        num_scheduled_tokens: np.ndarray,
2389
        num_computed_tokens: np.ndarray,
2390
        num_common_prefix_blocks: int,
2391
2392
        kv_cache_spec: KVCacheSpec,
        attn_metadata_builder: AttentionMetadataBuilder,
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
    ) -> int:
        """Compute the length of the common prefix for cascade attention.

        NOTE(woosuk): The common prefix length returned by this function
        represents the length used specifically for cascade attention, not the
        actual number of tokens shared between requests. When cascade attention
        is disabled (use_cascade=False), this function returns 0 even if
        requests share common tokens. Additionally, the common prefix length is
        truncated to a multiple of the block size and may be further truncated
        due to implementation details explained below.

        Args:
            num_scheduled_tokens: Number of tokens scheduled per request.
            num_common_prefix_blocks: Number of shared KV cache blocks.

        Returns:
            int: Length of common prefix in tokens.
        """
2411

2412
        common_prefix_len = num_common_prefix_blocks * kv_cache_spec.block_size
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
        if common_prefix_len == 0:
            # Common case.
            return 0

        # NOTE(woosuk): Cascade attention uses two attention kernels: one
        # for the common prefix and the other for the rest. For the first
        # kernel, we concatenate all the query tokens (possibly from
        # different requests) and treat them as if they are from the same
        # request. Then, we use bi-directional attention to process the
        # common prefix in the KV cache. Importantly, this means that the
        # first kernel does not do any masking.

        # Consider the following example:
        # Request 1's input query: [D, E, X]
        # Request 1's kv cache: [A, B, C, D, E, X]
        # Request 1's num_computed_tokens: 3 (i.e., [A, B, C])
        # Request 2's input query: [E, Y]
        # Request 2's kv cache: [A, B, C, D, E, Y]
        # Request 2's num_computed_tokens: 4 (i.e., [A, B, C, D])

        # If we use [A, B, C, D, E] as the common prefix, then the
        # first kernel will compute the bi-directional attention between
        # input query [D, E, X, E, Y] and common prefix [A, B, C, D, E].
        # However, this is wrong because D in Request 1 should not attend to
        # E in the common prefix (i.e., we need masking).
        # To avoid this, [A, B, C, D] should be the common prefix.
        # That is, the common prefix should be capped by the minimum
        # num_computed_tokens among the requests, and plus one to include
        # the first token of the query.

        # In practice, we use [A, B, C] as the common prefix, instead of
        # [A, B, C, D] (i.e., the common prefix is capped by the minimum
        # num_computed_tokens, without plus one).
        # This is because of an implementation detail: We want to always
        # use two kernels for cascade attention. Let's imagine:
        # Request 3's input query: [D]
        # Request 3's kv cache: [A, B, C, D]
2450
        # Request 3's num_computed_tokens: 3 (i.e., [A, B, C])
2451
2452
2453
2454
2455
        # If we use [A, B, C, D] as the common prefix for Request 1-3,
        # then Request 3 will be processed only by the first kernel,
        # and the second kernel will get an empty input. While this is not
        # a fundamental problem, our current implementation does not support
        # this case.
2456
        common_prefix_len = min(common_prefix_len, num_computed_tokens.min())
2457
        # common_prefix_len should be a multiple of the block size.
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
        common_prefix_len = (
            common_prefix_len // kv_cache_spec.block_size * kv_cache_spec.block_size
        )
        use_sliding_window = isinstance(kv_cache_spec, SlidingWindowSpec) or (
            isinstance(kv_cache_spec, FullAttentionSpec)
            and kv_cache_spec.sliding_window is not None
        )
        use_local_attention = isinstance(kv_cache_spec, ChunkedLocalAttentionSpec) or (
            isinstance(kv_cache_spec, FullAttentionSpec)
            and kv_cache_spec.attention_chunk_size is not None
        )
2469
2470
        assert isinstance(kv_cache_spec, AttentionSpec)
        use_cascade = attn_metadata_builder.use_cascade_attention(
2471
2472
2473
            common_prefix_len=common_prefix_len,
            query_lens=num_scheduled_tokens,
            num_query_heads=self.num_query_heads,
2474
            num_kv_heads=kv_cache_spec.num_kv_heads,
2475
            use_alibi=self.use_alibi,
2476
            use_sliding_window=use_sliding_window,
2477
            use_local_attention=use_local_attention,
2478
            num_sms=self.num_sms,
2479
            dcp_world_size=self.dcp_world_size,
2480
2481
2482
        )
        return common_prefix_len if use_cascade else 0

2483
2484
    def _calc_mrope_positions(self, scheduler_output: "SchedulerOutput"):
        mrope_pos_ptr = 0
2485
        for index, req_id in enumerate(self.input_batch.req_ids):
2486
2487
2488
            req = self.requests[req_id]
            assert req.mrope_positions is not None

2489
2490
            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2491
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
2492
2493
                req.prompt_token_ids, req.prompt_embeds
            )
2494
2495

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
2496
2497
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
            else:
                prompt_part_len = num_scheduled_tokens
                completion_part_len = 0

            assert num_scheduled_tokens == prompt_part_len + completion_part_len

            if prompt_part_len > 0:
                # prompt's mrope_positions are pre-computed
                dst_start = mrope_pos_ptr
                dst_end = mrope_pos_ptr + prompt_part_len
                src_start = num_computed_tokens
                src_end = num_computed_tokens + prompt_part_len

2511
2512
2513
                self.mrope_positions.cpu[:, dst_start:dst_end] = req.mrope_positions[
                    :, src_start:src_end
                ]
2514
2515
2516
2517
2518
2519
2520
                mrope_pos_ptr += prompt_part_len

            if completion_part_len > 0:
                # compute completion's mrope_positions on-the-fly
                dst_start = mrope_pos_ptr
                dst_end = mrope_pos_ptr + completion_part_len

2521
                assert req.mrope_position_delta is not None
2522
                MRotaryEmbedding.get_next_input_positions_tensor(
2523
                    out=self.mrope_positions.np,
2524
2525
2526
2527
2528
                    out_offset=dst_start,
                    mrope_position_delta=req.mrope_position_delta,
                    context_len=num_computed_tokens + prompt_part_len,
                    num_new_tokens=completion_part_len,
                )
2529
2530
2531

                mrope_pos_ptr += completion_part_len

2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
    def _calc_xdrope_positions(self, scheduler_output: "SchedulerOutput"):
        xdrope_pos_ptr = 0
        for index, req_id in enumerate(self.input_batch.req_ids):
            req = self.requests[req_id]
            assert req.xdrope_positions is not None

            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
                req.prompt_token_ids, req.prompt_embeds
            )

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
            else:
                prompt_part_len = num_scheduled_tokens
                completion_part_len = 0

            assert num_scheduled_tokens == prompt_part_len + completion_part_len

            if prompt_part_len > 0:
                # prompt's xdrope_positions are pre-computed
                dst_start = xdrope_pos_ptr
                dst_end = xdrope_pos_ptr + prompt_part_len
                src_start = num_computed_tokens
                src_end = num_computed_tokens + prompt_part_len

                self.xdrope_positions.cpu[:, dst_start:dst_end] = req.xdrope_positions[
                    :, src_start:src_end
                ]
                xdrope_pos_ptr += prompt_part_len

            if completion_part_len > 0:
                # compute completion's xdrope_positions on-the-fly
                dst_start = xdrope_pos_ptr
                dst_end = xdrope_pos_ptr + completion_part_len

                XDRotaryEmbedding.get_next_input_positions_tensor(
                    out=self.xdrope_positions.np,
                    out_offset=dst_start,
                    context_len=num_computed_tokens + prompt_part_len,
                    num_new_tokens=completion_part_len,
                )

                xdrope_pos_ptr += completion_part_len

2579
2580
    def _calc_spec_decode_metadata(
        self,
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
        num_draft_tokens: np.ndarray,
        cu_num_scheduled_tokens: np.ndarray,
    ) -> SpecDecodeMetadata:
        # Inputs:
        # cu_num_scheduled_tokens:  [  4, 104, 107, 207, 209]
        # num_draft_tokens:         [  3,   0,   2,   0,   1]
        # Outputs:
        # cu_num_draft_tokens:      [  3,   3,   5,   5,   6]
        # logits_indices:           [  0,   1,   2,   3, 103, 104, 105, 106,
        #                            206, 207, 208]
        # target_logits_indices:    [  0,   1,   2,   5,   6,   9]
        # bonus_logits_indices:     [  3,   4,   7,   8,  10]

        # Compute the logits indices.
        # [4, 1, 3, 1, 2]
        num_sampled_tokens = num_draft_tokens + 1
2597

2598
2599
2600
2601
2602
        # Step 1.
        # cu_num_sampled_tokens: [4, 5, 8, 9, 11]
        # _arange_scratch[:11]: [0, 1, 2, 3, 0, 0, 1, 2, 0, 0, 1]
        cu_num_sampled_tokens = self._get_cumsum_and_arange(
            num_sampled_tokens, self._arange_scratch, cumsum_dtype=np.int32
2603
        )
2604
        # Step 2. [0, 0, 0, 0, 103, 104, 104, 104, 206, 207, 207]
2605
        logits_indices = np.repeat(
2606
2607
            cu_num_scheduled_tokens - num_sampled_tokens, num_sampled_tokens
        )
2608
        # Step 3. [0, 1, 2, 3, 103, 104, 105, 106, 206, 207, 208]
2609
        logits_indices += self._arange_scratch[: cu_num_sampled_tokens[-1]]
2610
2611
2612
2613
2614

        # Compute the bonus logits indices.
        bonus_logits_indices = cu_num_sampled_tokens - 1

        # Compute the draft logits indices.
2615
        # cu_num_draft_tokens: [3, 3, 5, 5, 6]
2616
2617
2618
        # _arange_scratch[:6]: [0, 1, 2, 0, 1, 0]
        cu_num_draft_tokens = self._get_cumsum_and_arange(
            num_draft_tokens, self._arange_scratch, cumsum_dtype=np.int32
2619
        )
2620
2621
        # [0, 0, 0, 5, 5, 9]
        target_logits_indices = np.repeat(
2622
2623
            cu_num_sampled_tokens - num_sampled_tokens, num_draft_tokens
        )
2624
        # [0, 1, 2, 5, 6, 9]
2625
        target_logits_indices += self._arange_scratch[: cu_num_draft_tokens[-1]]
2626
2627
2628

        # TODO: Optimize the CPU -> GPU copy.
        cu_num_draft_tokens = torch.from_numpy(cu_num_draft_tokens).to(
2629
2630
            self.device, non_blocking=True
        )
2631
2632
2633
        cu_num_sampled_tokens = torch.from_numpy(cu_num_sampled_tokens).to(
            self.device, non_blocking=True
        )
2634
2635
2636
        logits_indices = torch.from_numpy(logits_indices).to(
            self.device, non_blocking=True
        )
2637
        target_logits_indices = torch.from_numpy(target_logits_indices).to(
2638
2639
            self.device, non_blocking=True
        )
2640
        bonus_logits_indices = torch.from_numpy(bonus_logits_indices).to(
2641
2642
            self.device, non_blocking=True
        )
2643

2644
2645
        # Compute the draft token ids.
        # draft_token_indices:      [  1,   2,   3, 105, 106, 208]
2646
        draft_token_ids = self.input_ids.gpu[logits_indices]
2647
2648
        draft_token_ids = draft_token_ids[target_logits_indices + 1]

2649
        return SpecDecodeMetadata(
2650
2651
2652
            draft_token_ids=draft_token_ids,
            num_draft_tokens=num_draft_tokens.tolist(),
            cu_num_draft_tokens=cu_num_draft_tokens,
2653
            cu_num_sampled_tokens=cu_num_sampled_tokens,
2654
2655
2656
2657
2658
            target_logits_indices=target_logits_indices,
            bonus_logits_indices=bonus_logits_indices,
            logits_indices=logits_indices,
        )

2659
2660
2661
2662
2663
2664
2665
    def _prepare_kv_sharing_fast_prefill(
        self,
        logits_indices: torch.Tensor,
    ) -> torch.Tensor:
        assert self.kv_sharing_fast_prefill_logits_indices is not None
        num_logits = logits_indices.shape[0]
        assert num_logits > 0
2666
        self.kv_sharing_fast_prefill_logits_indices[:num_logits].copy_(logits_indices)
2667
2668
2669
2670
2671
        # There might have leftover indices in logits_indices[num_logits:]
        # from previous iterations, whose values may be greater than the
        # batch size in the current iteration. To ensure indices are always
        # valid, we fill the padded indices with the last index.
        self.kv_sharing_fast_prefill_logits_indices[num_logits:].fill_(
2672
2673
            logits_indices[-1].item()
        )
2674
2675
        # Dispatch for the decoder portion of the model.
        _, batch_desc = self.cudagraph_dispatcher.dispatch(
2676
            num_logits, invalid_modes={CUDAGraphMode.FULL}
2677
2678
        )
        num_logits_padded = batch_desc.num_tokens
2679
2680
2681
        logits_indices_padded = self.kv_sharing_fast_prefill_logits_indices[
            :num_logits_padded
        ]
2682
2683
        return logits_indices_padded

2684
    def _batch_mm_inputs_from_scheduler(
2685
2686
        self,
        scheduler_output: "SchedulerOutput",
2687
2688
    ) -> tuple[
        list[str],
2689
        list[tuple[str, MultiModalKwargsItem]],
2690
2691
        list[tuple[str, PlaceholderRange]],
    ]:
2692
        """Batch multimodal inputs from scheduled encoder inputs.
2693
2694
2695

        Args:
            scheduler_output: The scheduler output containing scheduled encoder
2696
                inputs.
2697
2698

        Returns:
2699
            A tuple of (mm_hashes, mm_kwargs, mm_lora_refs) where:
2700
2701
            - mm_hashes: List of multimodal hashes for each item
            - mm_kwargs: List of multimodal kwargs for each item
2702
            - mm_lora_refs: List of (req_id, placeholder_range) for each item
2703
        """
2704
2705
        scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
        if not scheduled_encoder_inputs:
2706
            return [], [], []
2707
2708

        mm_hashes = list[str]()
2709
        mm_kwargs = list[tuple[str, MultiModalKwargsItem]]()
2710
2711
2712
        # Multimodal LoRA reference info to map each multimodal item
        # back to its request & position
        mm_lora_refs = list[tuple[str, PlaceholderRange]]()
2713
2714
        for req_id, encoder_input_ids in scheduled_encoder_inputs.items():
            req_state = self.requests[req_id]
2715
2716

            for mm_input_id in encoder_input_ids:
2717
                mm_feature = req_state.mm_features[mm_input_id]
2718
2719
                if mm_feature.data is None:
                    continue
2720
2721

                mm_hashes.append(mm_feature.identifier)
2722
                mm_kwargs.append((mm_feature.modality, mm_feature.data))
2723
                mm_lora_refs.append((req_id, mm_feature.mm_position))
2724

2725
        return mm_hashes, mm_kwargs, mm_lora_refs
2726

2727
2728
2729
    def _execute_mm_encoder(
        self, scheduler_output: "SchedulerOutput"
    ) -> list[torch.Tensor]:
2730
2731
2732
        mm_hashes, mm_kwargs, mm_lora_refs = self._batch_mm_inputs_from_scheduler(
            scheduler_output
        )
2733
2734

        if not mm_kwargs:
2735
            return []
2736

2737
2738
2739
2740
2741
2742
        should_time = bool(
            self.observability_config
            and self.observability_config.enable_mm_processor_stats
            and scheduler_output.scheduled_encoder_inputs
        )

2743
2744
2745
2746
2747
2748
2749
        # Batch mm inputs as much as we can: if a request in the batch has
        # multiple modalities or a different modality than the previous one,
        # we process it separately to preserve item order.
        # FIXME(ywang96): This is a hacky way to deal with multiple modalities
        # in the same batch while still being able to benefit from batching
        # multimodal inputs. The proper solution should be reordering the
        # encoder outputs.
2750
        model = cast(SupportsMultiModal, self.model)
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765

        if self.lora_config and self.lora_manager.supports_tower_connector_lora():
            # Build LoRA mappings independently for encoder inputs
            # (encoder batch structure is different from main batch)
            prompt_lora_mapping = []
            token_lora_mapping = []
            lora_requests = set()
            encoder_token_counts = []

            for req_id, pos_info in mm_lora_refs:
                req_idx = self.input_batch.req_id_to_index[req_id]
                lora_id = int(self.input_batch.request_lora_mapping[req_idx])

                # Prefer pos_info.get_num_embeds to count precise MM embedding tokens.
                num_tokens = self.model.get_num_mm_encoder_tokens(  # type: ignore[attr-defined]
2766
                    pos_info.get_num_embeds()
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
                )
                prompt_lora_mapping.append(lora_id)
                token_lora_mapping.extend([lora_id] * num_tokens)
                encoder_token_counts.append(num_tokens)

                if lora_id > 0:
                    lora_request = self.input_batch.lora_id_to_lora_request.get(lora_id)
                    if lora_request is not None:
                        lora_requests.add(lora_request)

            # Set tower adapter mapping
            tower_mapping = LoRAMapping(
                tuple(token_lora_mapping),
                tuple(prompt_lora_mapping),
                is_prefill=True,
                type=LoRAMappingType.TOWER,
            )
            self.lora_manager.set_active_adapters(lora_requests, tower_mapping)

2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
            # Only set connector mapping if the model actually has a connector.
            # Some multimodal models inherit a stub `get_num_mm_connector_tokens`
            # from `SupportsMultiModal`, which returns None and should not be
            # treated as a signal that connector LoRA is supported.
            mm_mapping = (
                self.model.get_mm_mapping()  # type: ignore[attr-defined]
                if hasattr(self.model, "get_mm_mapping")
                else None
            )
            if (
                mm_mapping is not None
                and mm_mapping.connector
                and hasattr(self.model, "get_num_mm_connector_tokens")
            ):
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
                post_op_counts = [
                    self.model.get_num_mm_connector_tokens(num_tokens)  # type: ignore[attr-defined]
                    for num_tokens in encoder_token_counts
                ]

                connector_token_mapping = np.repeat(
                    np.array(prompt_lora_mapping, dtype=np.int32),
                    np.array(post_op_counts, dtype=np.int32),
                )
                connector_mapping = LoRAMapping(
                    index_mapping=tuple(connector_token_mapping.tolist()),
                    prompt_mapping=tuple(prompt_lora_mapping),
                    is_prefill=True,
                    type=LoRAMappingType.CONNECTOR,
                )

                self.lora_manager.set_active_adapters(
                    lora_requests,
                    connector_mapping,
                )

2821
        encoder_outputs: list[torch.Tensor] = []
2822
2823
        # Track the current index in mm_kwargs/mm_lora_refs to map groups to request IDs
        current_item_idx = 0
2824
        for modality, num_items, mm_kwargs_batch in group_and_batch_mm_kwargs(
2825
2826
2827
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
2828
        ):
2829
            batch_outputs: MultiModalEmbeddings
2830

2831
            # EVS and dynamic res video related change.
2832
            # (ekhvedchenia): Temporary hack to limit peak memory usage when
2833
            # processing multimodal data. This solves the issue with scheduler
2834
2835
2836
2837
            # putting too many video samples into a single batch. Scheduler
            # uses pruned vision tokens count to compare it versus compute
            # budget which is incorrect (Either input media size or non-pruned
            # output vision tokens count should be considered)
2838
2839
2840
            # dynamic res video for nemotron temporarily uses this hack via
            # requires_sequential_video_encoding
            # because it doesn't yet support video batching.
2841
2842
2843
            # TODO(ywang96): Fix memory profiling to take EVS into account and
            # remove this hack.
            if (
2844
2845
2846
2847
                (
                    self.is_multimodal_pruning_enabled
                    or self.requires_sequential_video_encoding
                )
2848
2849
2850
                and modality == "video"
                and num_items > 1
            ):
2851
                batch_outputs_lst = list[torch.Tensor]()
2852
2853
2854
2855
2856
2857
                for video_idx in range(num_items):
                    video_mm_kwargs_item = mm_kwargs[current_item_idx + video_idx]
                    with self.timed_encoder_operation(
                        should_time, mm_lora_refs, current_item_idx + video_idx, 1
                    ):
                        _, _, micro_batch_mm_inputs = next(
2858
                            group_and_batch_mm_kwargs(
2859
2860
2861
2862
                                [video_mm_kwargs_item],
                                device=self.device,
                                pin_memory=self.pin_memory,
                            )
2863
                        )
2864

2865
2866
2867
                        micro_batch_outputs = model.embed_multimodal(
                            **micro_batch_mm_inputs
                        )
2868

2869
                        batch_outputs_lst.extend(micro_batch_outputs)
2870

2871
                batch_outputs = batch_outputs_lst
2872
2873
            else:
                # Run the encoder.
2874
                # `batch_outputs` is either of the following:
2875
2876
2877
2878
2879
                # 1. A tensor of shape (num_items, feature_size, hidden_size)
                # in case feature_size is fixed across all multimodal items.
                # 2. A list or tuple (length: num_items) of tensors,
                # each of shape (feature_size, hidden_size) in case the feature
                # size is dynamic depending on the input multimodal items.
2880
2881
2882
2883

                with self.timed_encoder_operation(
                    should_time, mm_lora_refs, current_item_idx, num_items
                ):
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
                    cudagraph_output = None
                    if (
                        self.encoder_cudagraph_manager is not None
                        and self.encoder_cudagraph_manager.supports_modality(modality)
                    ):
                        cudagraph_output = self.encoder_cudagraph_manager.execute(
                            mm_kwargs_batch,
                        )

                    if cudagraph_output is not None:
                        batch_outputs = cudagraph_output
                    else:
                        batch_outputs = model.embed_multimodal(**mm_kwargs_batch)
2897

2898
2899
            sanity_check_mm_encoder_outputs(batch_outputs, expected_num_items=num_items)
            encoder_outputs.extend(batch_outputs)
2900

2901
2902
            current_item_idx += num_items

2903
        # Cache the encoder outputs by mm_hash
2904
        for mm_hash, output in zip(mm_hashes, encoder_outputs):
2905
            self.encoder_cache[mm_hash] = output
2906
2907
            logger.debug("Finish execute for mm hash %s", mm_hash)
            self.maybe_save_ec_to_connector(self.encoder_cache, mm_hash)
2908

2909
2910
        return encoder_outputs

2911
    def _gather_mm_embeddings(
2912
2913
        self,
        scheduler_output: "SchedulerOutput",
2914
        shift_computed_tokens: int = 0,
2915
2916
2917
2918
    ) -> tuple[list[torch.Tensor], torch.Tensor]:
        total_num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens

        mm_embeds = list[torch.Tensor]()
2919
2920
2921
        is_mm_embed = torch.zeros(
            total_num_scheduled_tokens, dtype=torch.bool, device="cpu"
        )
2922
2923

        req_start_idx = 0
2924
        should_sync_mrope_positions = False
2925
        should_sync_xdrope_positions = False
2926

2927
        for req_id in self.input_batch.req_ids:
2928
2929
            mm_embeds_req: list[torch.Tensor] = []

2930
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2931
            req_state = self.requests[req_id]
2932
            num_computed_tokens = req_state.num_computed_tokens + shift_computed_tokens
2933

2934
2935
            for mm_feature in req_state.mm_features:
                pos_info = mm_feature.mm_position
2936
2937
                start_pos = pos_info.offset
                num_encoder_tokens = pos_info.length
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953

                # The encoder output is needed if the two ranges overlap:
                # [num_computed_tokens,
                #  num_computed_tokens + num_scheduled_tokens) and
                # [start_pos, start_pos + num_encoder_tokens)
                if start_pos >= num_computed_tokens + num_scheduled_tokens:
                    # The encoder output is not needed in this step.
                    break
                if start_pos + num_encoder_tokens <= num_computed_tokens:
                    # The encoder output is already processed and stored
                    # in the decoder's KV cache.
                    continue

                start_idx = max(num_computed_tokens - start_pos, 0)
                end_idx = min(
                    num_computed_tokens - start_pos + num_scheduled_tokens,
2954
2955
                    num_encoder_tokens,
                )
2956
                assert start_idx < end_idx
2957
2958
2959
2960
2961
2962
2963
                curr_embeds_start, curr_embeds_end = (
                    pos_info.get_embeds_indices_in_range(start_idx, end_idx)
                )
                # If there are no embeddings in the current range, we skip
                # gathering the embeddings.
                if curr_embeds_start == curr_embeds_end:
                    continue
2964

2965
                mm_hash = mm_feature.identifier
2966
                encoder_output = self.encoder_cache.get(mm_hash, None)
2967
                assert encoder_output is not None, f"Encoder cache miss for {mm_hash}."
2968
2969
2970

                if (is_embed := pos_info.is_embed) is not None:
                    is_embed = is_embed[start_idx:end_idx]
2971
2972
2973
                    mm_embeds_item = encoder_output[curr_embeds_start:curr_embeds_end]
                else:
                    mm_embeds_item = encoder_output[start_idx:end_idx]
2974

2975
                req_start_pos = req_start_idx + start_pos - num_computed_tokens
2976
2977
2978
2979
2980
2981
2982
2983
2984
                # OR mask for overlapping mm_features (use_audio_in_video)
                if is_embed is None:
                    is_mm_embed[req_start_pos + start_idx : req_start_pos + end_idx] = (
                        True
                    )
                else:
                    is_mm_embed[
                        req_start_pos + start_idx : req_start_pos + end_idx
                    ] |= is_embed
2985
2986
2987
                mm_embeds_req.append(mm_embeds_item)

            if self.is_multimodal_pruning_enabled and self.uses_mrope:
2988
                assert req_state.mrope_positions is not None
2989
2990
2991
2992
2993
2994
2995
                should_sync_mrope_positions = True
                mm_embeds_req, new_mrope_positions, new_delta = (
                    self.model.recompute_mrope_positions(
                        input_ids=req_state.prompt_token_ids,
                        multimodal_embeddings=mm_embeds_req,
                        mrope_positions=req_state.mrope_positions,
                        num_computed_tokens=req_state.num_computed_tokens,
2996
2997
                    )
                )
2998
2999
3000
3001
                req_state.mrope_positions.copy_(new_mrope_positions)
                req_state.mrope_position_delta = new_delta

            mm_embeds.extend(mm_embeds_req)
3002
3003
            req_start_idx += num_scheduled_tokens

3004
3005
        if should_sync_mrope_positions:
            self._calc_mrope_positions(scheduler_output)
3006
            self.mrope_positions.copy_to_gpu(total_num_scheduled_tokens)
3007

3008
3009
3010
3011
        if should_sync_xdrope_positions:
            self._calc_xdrope_positions(scheduler_output)
            self.xdrope_positions.copy_to_gpu(total_num_scheduled_tokens)

3012
        return mm_embeds, is_mm_embed
3013

3014
    def get_model(self) -> nn.Module:
3015
3016
        if not hasattr(self, "model"):
            raise ValueError("Cannot get model before model has been initialized")
3017
        if isinstance(self.model, (CUDAGraphWrapper, UBatchWrapper)):
3018
            # get raw model out of the cudagraph wrapper.
3019
            return self.model.unwrap()
3020
3021
        return self.model

3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
    def get_supported_generation_tasks(self) -> list[GenerationTask]:
        model = self.get_model()
        supported_tasks = list[GenerationTask]()

        if is_text_generation_model(model):
            supported_tasks.append("generate")

        if supports_transcription(model):
            if model.supports_transcription_only:
                return ["transcription"]

            supported_tasks.append("transcription")

3035
3036
3037
        if supports_realtime(model):
            supported_tasks.append("realtime")

3038
3039
        return supported_tasks

3040
3041
3042
3043
3044
    def get_supported_pooling_tasks(self) -> list[PoolingTask]:
        model = self.get_model()
        if not is_pooling_model(model):
            return []

3045
        return list(model.pooler.get_supported_tasks())
3046

3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
    def get_supported_tasks(self) -> tuple[SupportedTask, ...]:
        tasks = list[SupportedTask]()

        if self.model_config.runner_type == "generate":
            tasks.extend(self.get_supported_generation_tasks())
        if self.model_config.runner_type == "pooling":
            tasks.extend(self.get_supported_pooling_tasks())

        return tuple(tasks)

3057
    def sync_and_slice_intermediate_tensors(
3058
3059
        self,
        num_tokens: int,
3060
        intermediate_tensors: IntermediateTensors | None,
3061
3062
        sync_self: bool,
    ) -> IntermediateTensors:
3063
3064
3065
        assert self.intermediate_tensors is not None

        tp = self.vllm_config.parallel_config.tensor_parallel_size
3066
        is_rs = is_residual_scattered_for_sp(self.vllm_config, num_tokens)
3067
3068
3069
3070
3071
3072

        # When sequence parallelism is enabled, the "residual" tensor is sharded
        # across tensor parallel ranks, so each rank only needs its own slice.
        if sync_self:
            assert intermediate_tensors is not None
            for k, v in intermediate_tensors.items():
3073
                is_scattered = k == "residual" and is_rs
3074
                copy_len = num_tokens // tp if is_scattered else num_tokens
3075
                self.intermediate_tensors[k][:copy_len].copy_(
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
                    v[:copy_len], non_blocking=True
                )

        return IntermediateTensors(
            {
                k: v[: num_tokens // tp]
                if k == "residual" and is_rs
                else v[:num_tokens]
                for k, v in self.intermediate_tensors.items()
            }
        )

    def eplb_step(self, is_dummy: bool = False, is_profile: bool = False) -> None:
3089
3090
3091
        """
        Step for the EPLB (Expert Parallelism Load Balancing) state.
        """
3092
        if not self.parallel_config.enable_eplb or self.eep_eplb_suppressed:
3093
3094
3095
            return

        assert self.eplb_state is not None
3096
3097
        model = self.get_model()
        assert is_mixture_of_experts(model)
3098
3099
3100
        self.eplb_state.step(
            is_dummy,
            is_profile,
3101
            log_stats=self.parallel_config.eplb_config.log_balancedness,
3102
3103
        )

3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
    def setup_eplb_from_mapping(
        self,
        expanded_physical_to_logical: torch.Tensor,
        old_num_physical_experts: int,
    ) -> None:
        model = self.get_model()
        assert is_mixture_of_experts(model)

        self.eplb_state = EplbState.from_mapping(
            model=model,
            model_config=self.model_config,
            device=self.device,
            parallel_config=self.parallel_config,
            expanded_physical_to_logical=expanded_physical_to_logical,
            num_valid_physical_experts=old_num_physical_experts,
        )

3121
3122
3123
3124
3125
    def _pool(
        self,
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
        num_scheduled_tokens_np: np.ndarray,
3126
3127
3128
3129
        kv_connector_output: KVConnectorOutput | None,
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput:
        num_reqs = self.input_batch.num_reqs
        assert num_reqs == len(self.input_batch.pooling_params), (
3130
3131
            "Either all or none of the requests in a batch must be pooling request"
        )
3132

3133
        hidden_states = hidden_states[:num_scheduled_tokens]
3134
        seq_lens_cpu = self.optimistic_seq_lens_cpu[:num_reqs]
3135

3136
        pooling_metadata = self.input_batch.get_pooling_metadata()
3137
        pooling_metadata.build_pooling_cursor(
3138
3139
3140
3141
            num_scheduled_tokens_np,
            seq_lens_cpu,
            device=hidden_states.device,
            query_start_loc_gpu=self.query_start_loc.gpu[: num_reqs + 1],
3142
        )
3143

3144
3145
        model = cast(VllmModelForPooling, self.model)
        raw_pooler_output: PoolerOutput = model.pooler(
3146
            hidden_states=hidden_states, pooling_metadata=pooling_metadata
3147
        )
3148
3149
3150
3151
3152

        finished_mask = [
            seq_len == prompt_len
            for seq_len, prompt_len in zip(seq_lens_cpu, pooling_metadata.prompt_lens)
        ]
3153
3154
3155
3156
3157
3158
        raw_pooler_output = self.late_interaction_runner.postprocess_pooler_output(
            raw_pooler_output=raw_pooler_output,
            pooling_params=pooling_metadata.pooling_params,
            req_ids=self.input_batch.req_ids,
            finished_mask=finished_mask,
        )
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169

        model_runner_output = ModelRunnerOutput(
            req_ids=self.input_batch.req_ids.copy(),
            req_id_to_index=self.input_batch.req_id_to_index.copy(),
            kv_connector_output=kv_connector_output,
        )

        if raw_pooler_output is None or not any(finished_mask):
            model_runner_output.pooler_output = [None] * num_reqs
            return model_runner_output

3170
3171
3172
        if not current_platform.is_cuda_alike():
            # cpu/xpu runners cannot use the CUDA stream/event-based wrapper.
            model_runner_output.pooler_output = _copy_pooler_output_to_cpu(
3173
3174
3175
                raw_pooler_output=raw_pooler_output,
                finished_mask=finished_mask,
            )
3176
3177
            self._sync_device()
            return model_runner_output
3178

3179
3180
        return AsyncGPUPoolingModelRunnerOutput(
            model_runner_output=model_runner_output,
3181
3182
            raw_pooler_output=raw_pooler_output,
            finished_mask=finished_mask,
3183
            async_output_copy_stream=self._get_or_create_async_output_copy_stream(),
3184
        )
3185

3186
    def _pad_for_sequence_parallelism(self, num_scheduled_tokens: int) -> int:
3187
3188
3189
        # Pad tokens to multiple of tensor_parallel_size when
        # enabled collective fusion for SP
        tp_size = self.vllm_config.parallel_config.tensor_parallel_size
3190
        if self.compilation_config.pass_config.enable_sp and tp_size > 1:
3191
3192
3193
            return round_up(num_scheduled_tokens, tp_size)
        return num_scheduled_tokens

Patrick von Platen's avatar
Patrick von Platen committed
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
    def _prepare_mm_inputs(
        self, num_tokens: int
    ) -> tuple[torch.Tensor | None, torch.Tensor]:
        if self.model.requires_raw_input_tokens:
            input_ids = self.input_ids.gpu[:num_tokens]
        else:
            input_ids = None

        inputs_embeds = self.inputs_embeds.gpu[:num_tokens]
        return input_ids, inputs_embeds

3205
    def _preprocess(
3206
3207
        self,
        scheduler_output: "SchedulerOutput",
3208
        num_input_tokens: int,  # Padded
3209
        intermediate_tensors: IntermediateTensors | None = None,
3210
    ) -> tuple[
3211
3212
        torch.Tensor | None,
        torch.Tensor | None,
3213
        torch.Tensor,
3214
        IntermediateTensors | None,
3215
        dict[str, Any],
3216
        ECConnectorOutput | None,
3217
    ]:
3218
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
3219
        is_first_rank = get_pp_group().is_first_rank
3220
        is_encoder_decoder = self.model_config.is_encoder_decoder
3221

3222
3223
        # _prepare_inputs may reorder the batch, so we must gather multi
        # modal outputs after that to ensure the correct order
3224
3225
        ec_connector_output = None

3226
        if self.supports_mm_inputs and is_first_rank and not is_encoder_decoder:
3227
            # Run the multimodal encoder if any.
3228
3229
3230
3231
3232
3233
            with self.maybe_get_ec_connector_output(
                scheduler_output,
                encoder_cache=self.encoder_cache,
            ) as ec_connector_output:
                self._execute_mm_encoder(scheduler_output)
                mm_embeds, is_mm_embed = self._gather_mm_embeddings(scheduler_output)
3234

3235
3236
3237
            # NOTE(woosuk): To unify token ids and soft tokens (vision
            # embeddings), we always use embeddings (rather than token ids)
            # as input to the multimodal model, even when the input is text.
3238
            inputs_embeds_scheduled = self.model.embed_input_ids(
3239
3240
3241
                self.input_ids.gpu[:num_scheduled_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
3242
            )
3243

3244
            # TODO(woosuk): Avoid the copy. Optimize.
3245
            self.inputs_embeds.gpu[:num_scheduled_tokens].copy_(inputs_embeds_scheduled)
3246

Patrick von Platen's avatar
Patrick von Platen committed
3247
            input_ids, inputs_embeds = self._prepare_mm_inputs(num_input_tokens)
3248
            model_kwargs = {
3249
                **self._init_model_kwargs(),
3250
3251
                **self._extract_mm_kwargs(scheduler_output),
            }
3252
        elif self.enable_prompt_embeds and is_first_rank:
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
            # Get the input embeddings for the tokens that are not input embeds,
            # then put them into the appropriate positions.
            # TODO(qthequartermasterman): Since even when prompt embeds are
            # enabled, (a) not all requests will use prompt embeds, and (b)
            # after the initial prompt is processed, the rest of the generated
            # tokens will be token ids, it is not desirable to have the
            # embedding layer outside of the CUDA graph all the time. The v0
            # engine avoids this by "double compiling" the CUDA graph, once
            # with input_ids and again with inputs_embeds, for all num_tokens.
            # If a batch only has token ids, then including the embedding layer
            # in the CUDA graph will be more performant (like in the else case
            # below).
3265
3266
3267
            token_ids_idx = (
                self.is_token_ids.gpu[:num_scheduled_tokens]
                .nonzero(as_tuple=False)
3268
                .squeeze(1)
3269
            )
3270
3271
3272
            # Some tokens ids may need to become embeds
            if token_ids_idx.numel() > 0:
                token_ids = self.input_ids.gpu[token_ids_idx]
3273
                tokens_to_embeds = self.model.embed_input_ids(input_ids=token_ids)
3274
3275
3276
                self.inputs_embeds.gpu[token_ids_idx] = tokens_to_embeds

            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
3277
            model_kwargs = self._init_model_kwargs()
3278
            input_ids = None
3279
        else:
3280
3281
3282
3283
            # For text-only models, we use token ids as input.
            # While it is possible to use embeddings as input just like the
            # multimodal models, it is not desirable for performance since
            # then the embedding layer is not included in the CUDA graph.
3284
            input_ids = self.input_ids.gpu[:num_input_tokens]
3285
            inputs_embeds = None
3286
            model_kwargs = self._init_model_kwargs()
3287

3288
        if self.uses_mrope:
3289
            positions = self.mrope_positions.gpu[:, :num_input_tokens]
3290
3291
        elif self.uses_xdrope_dim > 0:
            positions = self.xdrope_positions.gpu[:, :num_input_tokens]
3292
        else:
3293
            positions = self.positions[:num_input_tokens]
3294
            if num_input_tokens > num_scheduled_tokens:
3295
                self.positions[num_scheduled_tokens:num_input_tokens].zero_()
3296

3297
        if is_first_rank:
3298
3299
            intermediate_tensors = None
        else:
3300
            assert intermediate_tensors is not None
3301
            intermediate_tensors = self.sync_and_slice_intermediate_tensors(
3302
3303
                num_input_tokens, intermediate_tensors, True
            )
3304

3305
        if is_encoder_decoder and scheduler_output.scheduled_encoder_inputs:
3306
3307
3308
3309
3310
3311
3312
            # Run the encoder, just like we do with other multimodal inputs.
            # For an encoder-decoder model, our processing here is a bit
            # simpler, because the outputs are just passed to the decoder.
            # We are not doing any prompt replacement. We also will only
            # ever have a single encoder input.
            encoder_outputs = self._execute_mm_encoder(scheduler_output)
            model_kwargs.update({"encoder_outputs": encoder_outputs})
3313

3314
3315
3316
3317
3318
3319
        return (
            input_ids,
            inputs_embeds,
            positions,
            intermediate_tensors,
            model_kwargs,
3320
            ec_connector_output,
3321
        )
3322

3323
    def _sample(
3324
        self,
3325
3326
        logits: torch.Tensor | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
3327
    ) -> SamplerOutput:
3328
        # Sample the next token and get logprobs if needed.
3329
        sampling_metadata = self.input_batch.sampling_metadata
3330
3331
3332
        # Update output token ids with tokens sampled in last step
        # if async scheduling and required by current sampling params.
        self.input_batch.update_async_output_token_ids()
3333
        if spec_decode_metadata is None:
3334
            return self.sampler(
3335
3336
3337
                logits=logits,
                sampling_metadata=sampling_metadata,
            )
3338

3339
3340
3341
3342
3343
3344
        # Update spec_token_ids with real draft tokens from pre step only when
        # output_token_ids is needed (penalties or bad_words are in use).
        if self.use_async_scheduling and self._draft_token_req_ids is not None:
            draft_token_ids_cpu, _ = self._get_draft_token_ids_cpu()
            self.input_batch.update_async_spec_token_ids(draft_token_ids_cpu)

3345
        sampler_output = self.rejection_sampler(
3346
3347
            spec_decode_metadata,
            None,  # draft_probs
3348
            logits,
3349
3350
            sampling_metadata,
        )
3351
3352
3353
        return sampler_output

    def _bookkeeping_sync(
3354
3355
3356
        self,
        scheduler_output: "SchedulerOutput",
        sampler_output: SamplerOutput,
3357
        logits: torch.Tensor | None,
3358
3359
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
3360
        spec_decode_metadata: SpecDecodeMetadata | None,
3361
    ) -> tuple[
3362
        dict[str, int],
3363
        LogprobsLists | None,
3364
        list[list[int]],
3365
        dict[str, LogprobsTensors | None],
3366
3367
3368
        list[str],
        dict[str, int],
        list[int],
3369
    ]:
3370
3371
3372
3373
        num_nans_in_logits = {}
        if envs.VLLM_COMPUTE_NANS_IN_LOGITS:
            num_nans_in_logits = self._get_nans_in_logits(logits)

3374
3375
3376
3377
        num_reqs = self.input_batch.num_reqs
        discard_sampled_tokens_req_indices = np.nonzero(
            self.discard_request_mask.np[:num_reqs]
        )[0]
3378
3379
3380
3381
        for i in discard_sampled_tokens_req_indices:
            gen = self.input_batch.generators.get(int(i))
            if gen is not None:
                gen.set_offset(gen.get_offset() - 4)
3382

3383
3384
3385
        # Copy some objects so they don't get modified after returning.
        # This is important when using async scheduling.
        req_ids_output_copy = self.input_batch.req_ids.copy()
3386
        req_id_to_index_output_copy = self.input_batch.req_id_to_index.copy()
3387
3388

        num_sampled_tokens = sampler_output.sampled_token_ids.shape[0]
3389
        sampled_token_ids = sampler_output.sampled_token_ids
3390
        logprobs_tensors = sampler_output.logprobs_tensors
3391
        invalid_req_indices = []
3392
        logprobs_lists = None
3393
3394
3395
3396
3397
3398
        if not self.use_async_scheduling:
            # Get the valid generated tokens.
            max_gen_len = sampled_token_ids.shape[-1]
            if max_gen_len == 1:
                # No spec decode tokens.
                valid_sampled_token_ids = self._to_list(sampled_token_ids)
3399
3400
3401
                # Mask out the sampled tokens that should not be sampled.
                for i in discard_sampled_tokens_req_indices:
                    valid_sampled_token_ids[int(i)].clear()
3402
3403
3404

                if logprobs_tensors is not None:
                    logprobs_lists = logprobs_tensors.tolists()
3405
3406
            else:
                # Includes spec decode tokens.
3407
                valid_sampled_token_ids, logprobs_lists = RejectionSampler.parse_output(
3408
3409
                    sampled_token_ids,
                    self.input_batch.vocab_size,
3410
                    discard_sampled_tokens_req_indices,
3411
                    logprobs_tensors=logprobs_tensors,
3412
                )
3413
        else:
3414
            valid_sampled_token_ids = []
3415
            invalid_req_indices = discard_sampled_tokens_req_indices.tolist()
3416
3417
3418
3419
3420
            invalid_req_indices_set = set(invalid_req_indices)

            # Cache the sampled tokens on the GPU and avoid CPU sync.
            # These will be copied into input_ids in the next step
            # when preparing inputs.
3421
3422
3423
3424
            # With spec decoding, this is done in propose_draft_token_ids().
            if self.input_batch.prev_sampled_token_ids is None:
                assert sampled_token_ids.shape[-1] == 1
                self.input_batch.prev_sampled_token_ids = sampled_token_ids
3425
3426
3427
3428
3429
            self.input_batch.prev_req_id_to_index = {
                req_id: i
                for i, req_id in enumerate(self.input_batch.req_ids)
                if i not in invalid_req_indices_set
            }
3430

3431
3432
3433
3434
3435
        # Cache the sampled tokens in the model runner, so that the scheduler
        # doesn't need to send them back.
        # NOTE(woosuk): As an exception, when using PP, the scheduler sends
        # the sampled tokens back, because there's no direct communication
        # between the first-stage worker and the last-stage worker.
3436
        req_ids = self.input_batch.req_ids
3437
3438
        for req_idx in range(num_sampled_tokens):
            if self.use_async_scheduling:
3439
                sampled_ids = [-1] if req_idx not in invalid_req_indices_set else None
3440
3441
            else:
                sampled_ids = valid_sampled_token_ids[req_idx]
3442

3443
            num_sampled_ids: int = len(sampled_ids) if sampled_ids else 0
3444

3445
            if not sampled_ids:
3446
3447
3448
                continue

            start_idx = self.input_batch.num_tokens_no_spec[req_idx]
3449
            end_idx = start_idx + num_sampled_ids
3450
3451
3452
3453
            assert end_idx <= self.max_model_len, (
                "Sampled token IDs exceed the max model length. "
                f"Total number of tokens: {end_idx} > max_model_len: "
                f"{self.max_model_len}"
3454
            )
3455

3456
3457
            self.input_batch.token_ids_cpu[req_idx, start_idx:end_idx] = sampled_ids
            self.input_batch.is_token_ids[req_idx, start_idx:end_idx] = True
3458
            self.input_batch.num_tokens_no_spec[req_idx] = end_idx
3459

3460
            req_id = req_ids[req_idx]
3461
3462
3463
            req_state = self.requests[req_id]
            req_state.output_token_ids.extend(sampled_ids)

3464
3465
3466
3467
3468
3469
        # Compute prompt logprobs if needed.
        prompt_logprobs_dict = self._get_prompt_logprobs_dict(
            hidden_states[:num_scheduled_tokens],
            scheduler_output.num_scheduled_tokens,
        )

3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
        return (
            num_nans_in_logits,
            logprobs_lists,
            valid_sampled_token_ids,
            prompt_logprobs_dict,
            req_ids_output_copy,
            req_id_to_index_output_copy,
            invalid_req_indices,
        )

3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
    @contextmanager
    def synchronize_input_prep(self):
        if self.prepare_inputs_event is None:
            yield
            return

        # Ensure prior step has finished with reused CPU tensors.
        # This is required in the async scheduling case because
        # the CPU->GPU transfer happens async.
        self.prepare_inputs_event.synchronize()
        try:
            yield
        finally:
            self.prepare_inputs_event.record()

3495
3496
    def _model_forward(
        self,
3497
3498
3499
3500
        input_ids: torch.Tensor | None = None,
        positions: torch.Tensor | None = None,
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
3501
3502
3503
3504
3505
        **model_kwargs: dict[str, Any],
    ) -> Any:
        """Helper method to call the model forward pass.

        This method can be overridden by subclasses for model execution.
3506
        Motivation: We can inspect only this method versus
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
        the whole execute_model, which has additional logic.

        Args:
            input_ids: Input token IDs
            positions: Token positions
            intermediate_tensors: Tensors from previous pipeline stages
            inputs_embeds: Input embeddings (alternative to input_ids)
            **model_kwargs: Additional model arguments

        Returns:
            Model output tensor
        """
        return self.model(
            input_ids=input_ids,
            positions=positions,
            intermediate_tensors=intermediate_tensors,
            inputs_embeds=inputs_embeds,
            **model_kwargs,
        )

3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
    @staticmethod
    def _is_uniform_decode(
        max_num_scheduled_tokens: int,
        uniform_decode_query_len: int,
        num_tokens: int,
        num_reqs: int,
        force_uniform_decode: bool | None = None,
    ) -> bool:
        """
        Checks if it's a decode batch with same amount scheduled tokens
        across all requests.
        """
        return (
            (
                (max_num_scheduled_tokens == uniform_decode_query_len)
                and (num_tokens == max_num_scheduled_tokens * num_reqs)
            )
            if force_uniform_decode is None
            else force_uniform_decode
        )

3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
    def _determine_batch_execution_and_padding(
        self,
        num_tokens: int,
        num_reqs: int,
        num_scheduled_tokens_np: np.ndarray,
        max_num_scheduled_tokens: int,
        use_cascade_attn: bool,
        allow_microbatching: bool = True,
        force_eager: bool = False,
        # For cudagraph capture TODO(lucas): Refactor how we capture cudagraphs (will
        # be improved in model runner v2)
        force_uniform_decode: bool | None = None,
        force_has_lora: bool | None = None,
3561
        force_num_active_loras: int | None = None,
3562
        num_encoder_reqs: int = 0,
3563
    ) -> tuple[
3564
3565
        CUDAGraphMode,
        BatchDescriptor,
3566
        bool,
3567
3568
        torch.Tensor | None,
        CUDAGraphStat | None,
3569
    ]:
3570
3571
3572
3573
3574
3575
        uniform_decode = self._is_uniform_decode(
            max_num_scheduled_tokens=max_num_scheduled_tokens,
            uniform_decode_query_len=self.uniform_decode_query_len,
            num_tokens=num_tokens,
            num_reqs=num_reqs,
            force_uniform_decode=force_uniform_decode,
3576
        )
3577
3578
3579
3580
3581
        # Encoder-decoder models only support CG for decoder_step > 0 (no enc_output
        # is present). Also, chunked-prefill is disabled, so batch are uniform.
        has_encoder_output = (
            self.model_config.is_encoder_decoder and num_encoder_reqs > 0
        )
3582

3583
3584
3585
3586
3587
        # Compute LoRA state for cudagraph dispatch
        num_active_loras = (
            force_num_active_loras
            if force_num_active_loras is not None
            else len(self.input_batch.lora_id_to_lora_request)
3588
        )
3589
        has_lora = num_active_loras > 0 if force_has_lora is None else force_has_lora
3590

3591
        num_tokens_padded = self._pad_for_sequence_parallelism(num_tokens)
3592
3593
3594

        def dispatch_cudagraph(num_tokens, disable_full=False, valid_modes=None):
            return self.cudagraph_dispatcher.dispatch(
3595
3596
3597
                num_tokens=num_tokens,
                has_lora=has_lora,
                uniform_decode=uniform_decode,
3598
                num_active_loras=num_active_loras,
3599
3600
                valid_modes={CUDAGraphMode.NONE} if force_eager else valid_modes,
                invalid_modes={CUDAGraphMode.FULL} if disable_full else None,
3601
3602
            )

3603
        cudagraph_mode, batch_descriptor = dispatch_cudagraph(
3604
            num_tokens_padded, disable_full=use_cascade_attn or has_encoder_output
3605
        )
3606
        num_tokens_padded = batch_descriptor.num_tokens
3607
3608
3609
3610
3611
3612
3613
3614
3615
        if self.compilation_config.pass_config.enable_sp:
            assert (
                batch_descriptor.num_tokens
                % self.vllm_config.parallel_config.tensor_parallel_size
                == 0
            ), (
                "Sequence parallelism requires num_tokens to be "
                "a multiple of tensor parallel size"
            )
3616
3617
3618

        # Extra coordination when running data-parallel since we need to coordinate
        # across ranks
3619
        should_ubatch, num_tokens_across_dp = False, None
3620
        if self.vllm_config.parallel_config.data_parallel_size > 1:
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
            should_ubatch, num_tokens_across_dp, synced_cudagraph_mode = (
                coordinate_batch_across_dp(
                    num_tokens_unpadded=num_tokens,
                    parallel_config=self.parallel_config,
                    allow_microbatching=allow_microbatching,
                    num_tokens_padded=num_tokens_padded,
                    uniform_decode=uniform_decode,
                    num_scheduled_tokens_per_request=num_scheduled_tokens_np,
                    cudagraph_mode=cudagraph_mode.value,
                )
3631
3632
            )

3633
            # Extract DP-synced values
3634
3635
3636
            if num_tokens_across_dp is not None:
                dp_rank = self.parallel_config.data_parallel_rank
                num_tokens_padded = int(num_tokens_across_dp[dp_rank].item())
3637
3638
3639
                # Re-dispatch with DP padding so we have the correct batch_descriptor
                cudagraph_mode, batch_descriptor = dispatch_cudagraph(
                    num_tokens_padded,
3640
                    valid_modes={CUDAGraphMode(synced_cudagraph_mode)},
3641
                )
3642
3643
3644
3645
                # Assert to make sure the agreed upon token count is correct otherwise
                # num_tokens_across_dp will no-longer be valid
                assert batch_descriptor.num_tokens == num_tokens_padded

3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
        cudagraph_stats = None
        if self.vllm_config.observability_config.cudagraph_metrics:
            cudagraph_stats = CUDAGraphStat(
                num_unpadded_tokens=num_tokens,
                num_padded_tokens=batch_descriptor.num_tokens,
                num_paddings=batch_descriptor.num_tokens - num_tokens,
                runtime_mode=str(cudagraph_mode),
            )

        return (
            cudagraph_mode,
            batch_descriptor,
3658
            should_ubatch,
3659
3660
3661
            num_tokens_across_dp,
            cudagraph_stats,
        )
3662

3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
    def _register_layerwise_nvtx_hooks(self) -> None:
        """
        Register layerwise NVTX hooks if --enable-layerwise-nvtx-tracing is enabled
        to trace detailed information of each layer or module in the model.
        """

        if (
            self.vllm_config.observability_config.enable_layerwise_nvtx_tracing
            and not self.layerwise_nvtx_hooks_registered
        ):
            if self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE:
                logger.debug_once(
                    "layerwise NVTX tracing is not supported when CUDA graph is "
                    "turned off; you may observe part or all of the model "
                    "missing NVTX markers"
                )

            # In STOCK_TORCH_COMPILE mode, after registering hooks here,
            # the __call__ function of nn.module will be recompiled with
            # fullgraph=True. Since nvtx.range_push/pop are not traceable
            # by torch dynamo, we can't register hook functions here
            # because hook functions will also be traced by torch dynamo.
            if (
                self.vllm_config.compilation_config.mode
                == CompilationMode.STOCK_TORCH_COMPILE
            ):
                logger.debug_once(
                    "layerwise NVTX tracing is not supported when "
                    "CompilationMode is STOCK_TORCH_COMPILE, skipping "
                    "function hooks registration"
                )
            else:
                pyt_hooks = PytHooks()
                pyt_hooks.register_hooks(self.model, self.model.__class__.__name__)
                self.layerwise_nvtx_hooks_registered = True

3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
    def _get_slot_mappings(
        self,
        num_tokens_padded: int,
        num_reqs_padded: int,
        num_tokens_unpadded: int,
        ubatch_slices: "UBatchSlices | None" = None,
    ) -> tuple[
        dict[int, torch.Tensor] | None,
        dict[str, torch.Tensor] | list[dict[str, torch.Tensor]] | None,
    ]:
        """
        Build slot mappings in both formats needed by the system.

        Args:
            num_tokens_padded: Total number of tokens (padded)
            num_reqs_padded: Total number of requests (padded)
            num_tokens_unpadded: Actual number of tokens (unpadded)
            ubatch_slices: Optional ubatch slicing info for DBO

        Returns:
            A tuple of:
            - slot_mappings_by_gid: dict[int, torch.Tensor] for attention metadata
            - slot_mappings_by_layer: dict[str, torch.Tensor] or list for ForwardContext
        """
        if not (
            hasattr(self, "kv_cache_config")
            and self.kv_cache_config is not None
            and len(self.kv_cache_config.kv_cache_groups) > 0
        ):
            return None, None

        def _get_slot_mapping(kv_cache_gid: int):
            assert num_reqs_padded is not None and num_tokens_padded is not None
            kv_cache_spec = self.kv_cache_config.kv_cache_groups[
                kv_cache_gid
            ].kv_cache_spec
            if isinstance(kv_cache_spec, EncoderOnlyAttentionSpec):
                slot_mapping = torch.zeros(
                    (num_tokens_padded,),
                    dtype=torch.int64,
                    device=self.device,
                )
            else:
                blk_table = self.input_batch.block_table[kv_cache_gid]
                slot_mapping = blk_table.slot_mapping.gpu[:num_tokens_padded]

            # Fill unused with -1. Needed for reshape_and_cache in full cuda
            # graph mode. `blk_table_tensor` -1 to match mamba PAD_SLOT_ID
            slot_mapping[num_tokens_unpadded:num_tokens_padded].fill_(-1)

            return slot_mapping

        slot_mappings_by_gid = {
            gid: _get_slot_mapping(gid)
            for gid, _ in enumerate(self.kv_cache_config.kv_cache_groups)
        }

        slot_mappings_by_layer: dict[str, torch.Tensor] = {}
        for gid, kv_cache_group in enumerate(self.kv_cache_config.kv_cache_groups):
            slot_mapping = slot_mappings_by_gid[gid]
            for layer_name in kv_cache_group.layer_names:
                slot_mappings_by_layer[layer_name] = slot_mapping

        if ubatch_slices is not None:
            result: list[dict[str, torch.Tensor]] = []
            for ubatch in ubatch_slices:
                sliced_mappings: dict[str, torch.Tensor] = {}
                for layer_name, slot_mapping in slot_mappings_by_layer.items():
                    sliced_mappings[layer_name] = slot_mapping[ubatch.token_slice]
                result.append(sliced_mappings)
            return slot_mappings_by_gid, result

        return slot_mappings_by_gid, slot_mappings_by_layer

3773
3774
3775
3776
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: "SchedulerOutput",
3777
        intermediate_tensors: IntermediateTensors | None = None,
3778
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors | None:
3779
3780
3781
3782
3783
        if self.execute_model_state is not None:
            raise RuntimeError(
                "State error: sample_tokens() must be called "
                "after execute_model() returns None."
            )
3784

3785
        if self.routed_experts_initialized:
3786
3787
3788
3789
3790
3791
            capturer = RoutedExpertsCapturer.get_instance()
            if capturer is not None:
                capturer.clear_buffer()  # noqa
            else:
                logger.error("RoutedExpertsCapturer not initialized.")

3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
        # If ngram_gpu is used, we need to copy the scheduler_output to avoid
        # the modification has influence on the scheduler_output in engine core process.
        # The replace is much faster than deepcopy.
        if (
            self.speculative_config is not None
            and self.speculative_config.use_ngram_gpu()
        ):
            num_scheduled_tokens_copy = scheduler_output.num_scheduled_tokens.copy()
            spec_decode_tokens_copy = (
                scheduler_output.scheduled_spec_decode_tokens.copy()
            )
            scheduler_output = replace(
                scheduler_output,
                num_scheduled_tokens=num_scheduled_tokens_copy,
                scheduled_spec_decode_tokens=spec_decode_tokens_copy,
            )

3809
3810
3811
3812
        if has_kv_transfer_group():
            kv_connector_metadata = scheduler_output.kv_connector_metadata
            assert kv_connector_metadata is not None
            get_kv_transfer_group().handle_preemptions(kv_connector_metadata)
3813

3814
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
3815
3816
3817
3818
3819
        with (
            record_function_or_nullcontext("gpu_model_runner: preprocess"),
            self.synchronize_input_prep(),
        ):
            # Update persistent batch states.
3820
            deferred_state_corrections_fn = self._update_states(scheduler_output)
3821

3822
            if has_ec_transfer() and not get_ec_transfer().is_consumer:
3823
                with self.maybe_get_ec_connector_output(
3824
                    scheduler_output,
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
                    encoder_cache=self.encoder_cache,
                ) as ec_connector_output:
                    self._execute_mm_encoder(scheduler_output)
                    return make_empty_encoder_model_runner_output(scheduler_output)

            if not num_scheduled_tokens:
                if (
                    self.parallel_config.distributed_executor_backend
                    == "external_launcher"
                    and self.parallel_config.data_parallel_size > 1
                ):
                    # this is a corner case when both external launcher
                    # and DP are enabled, num_scheduled_tokens could be
                    # 0, and has_unfinished_requests in the outer loop
                    # returns True. before returning early here we call
                    # dummy run to ensure coordinate_batch_across_dp
                    # is called into to avoid out of sync issues.
                    self._dummy_run(1)
                if not has_kv_transfer_group():
                    # Return empty ModelRunnerOutput if no work to do.
                    return EMPTY_MODEL_RUNNER_OUTPUT
                return self.kv_connector_no_forward(scheduler_output, self.vllm_config)

            if self.cache_config.kv_sharing_fast_prefill:
                assert not self.num_prompt_logprobs, (
                    "--kv-sharing-fast-prefill produces incorrect "
                    "logprobs for prompt tokens, tokens, please disable "
                    "it when the requests need prompt logprobs"
3853
3854
                )

3855
3856
3857
3858
3859
3860
            num_reqs = self.input_batch.num_reqs
            req_ids = self.input_batch.req_ids
            tokens = [scheduler_output.num_scheduled_tokens[i] for i in req_ids]
            num_scheduled_tokens_np = np.array(tokens, dtype=np.int32)
            max_num_scheduled_tokens = int(num_scheduled_tokens_np.max())
            num_tokens_unpadded = scheduler_output.total_num_scheduled_tokens
3861

3862
3863
3864
3865
            logits_indices, spec_decode_metadata = self._prepare_inputs(
                scheduler_output,
                num_scheduled_tokens_np,
            )
3866

3867
3868
3869
3870
3871
            cascade_attn_prefix_lens = None
            # Disable cascade attention when using microbatching (DBO)
            if self.cascade_attn_enabled and not self.parallel_config.use_ubatching:
                # Pre-compute cascade attention prefix lengths
                cascade_attn_prefix_lens = self._compute_cascade_attn_prefix_lens(
3872
                    num_scheduled_tokens_np,
3873
3874
                    self.input_batch.num_computed_tokens_cpu[:num_reqs],
                    scheduler_output.num_common_prefix_blocks,
3875
3876
                )

3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
            (
                cudagraph_mode,
                batch_desc,
                should_ubatch,
                num_tokens_across_dp,
                cudagraph_stats,
            ) = self._determine_batch_execution_and_padding(
                num_tokens=num_tokens_unpadded,
                num_reqs=num_reqs,
                num_scheduled_tokens_np=num_scheduled_tokens_np,
                max_num_scheduled_tokens=max_num_scheduled_tokens,
                use_cascade_attn=cascade_attn_prefix_lens is not None,
                num_encoder_reqs=len(scheduler_output.scheduled_encoder_inputs),
            )
3891

3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
            logger.debug(
                "Running batch with cudagraph_mode: %s, batch_descriptor: %s, "
                "should_ubatch: %s, num_tokens_across_dp: %s",
                cudagraph_mode,
                batch_desc,
                should_ubatch,
                num_tokens_across_dp,
            )

            num_tokens_padded = batch_desc.num_tokens
            num_reqs_padded = (
                batch_desc.num_reqs if batch_desc.num_reqs is not None else num_reqs
            )
            ubatch_slices, ubatch_slices_padded = maybe_create_ubatch_slices(
                should_ubatch,
                num_scheduled_tokens_np,
                num_tokens_padded,
                num_reqs_padded,
                self.parallel_config.num_ubatches,
            )

            logger.debug(
                "ubatch_slices: %s, ubatch_slices_padded: %s",
                ubatch_slices,
                ubatch_slices_padded,
            )

3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
            # True if any attention backend handles KV cache update separately
            # from forward() (i.e., forward_includes_kv_cache_update=False). When true,
            # slot_mappings must use padded dimensions to match the key/value tensors.
            has_separate_kv_update = not all(
                all(
                    g.backend.forward_includes_kv_cache_update
                    for g in self.attn_groups[id]
                )
                for id, spec in enumerate(self.kv_cache_config.kv_cache_groups)
                if not isinstance(spec.kv_cache_spec, EncoderOnlyAttentionSpec)
            )
3930
3931
            pad_attn = cudagraph_mode == CUDAGraphMode.FULL

3932
            if self.cache_config.mamba_cache_mode == "align":
3933
3934
3935
3936
3937
3938
                # preprocess_mamba reads req_state.num_computed_tokens (CPU)
                # to decide copy operations, so we must apply deferred
                # corrections before it runs.
                if deferred_state_corrections_fn:
                    deferred_state_corrections_fn()
                    deferred_state_corrections_fn = None
3939
3940
3941
3942
3943
3944
3945
3946
3947
                mamba_utils.preprocess_mamba(
                    scheduler_output,
                    self.kv_cache_config,
                    self.cache_config,
                    self.mamba_state_idx,
                    self.input_batch,
                    self.requests,
                    self.compilation_config.static_forward_context,
                    self.model.get_mamba_state_copy_func(),
3948
                    self._get_mamba_copy_bufs(),
3949
                )
3950
3951
3952
3953
3954
3955
3956
3957
                # preprocess_mamba resets num_accepted_tokens_cpu to 1
                # for requests whose state was copied to a new block.
                # Re-sync to GPU so the mamba kernel reads from the
                # correct initial state slot (init_token_idx = 0).
                self.num_accepted_tokens.np[:num_reqs] = (
                    self.input_batch.num_accepted_tokens_cpu[:num_reqs]
                )
                self.num_accepted_tokens.copy_to_gpu(num_reqs)
3958

3959
3960
3961
            use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
            ubatch_slices_attn = ubatch_slices_padded if pad_attn else ubatch_slices

3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
            slot_mappings_by_group, slot_mappings = self._get_slot_mappings(
                num_tokens_padded=num_tokens_padded
                if pad_attn or has_separate_kv_update
                else num_tokens_unpadded,
                num_reqs_padded=(
                    num_reqs_padded if pad_attn or has_separate_kv_update else num_reqs
                ),
                num_tokens_unpadded=num_tokens_unpadded,
                ubatch_slices=ubatch_slices_padded,
            )

3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
            attn_metadata, spec_decode_common_attn_metadata = (
                self._build_attention_metadata(
                    num_tokens=num_tokens_unpadded,
                    num_tokens_padded=num_tokens_padded if pad_attn else None,
                    num_reqs=num_reqs,
                    num_reqs_padded=num_reqs_padded if pad_attn else None,
                    max_query_len=max_num_scheduled_tokens,
                    ubatch_slices=ubatch_slices_attn,
                    logits_indices=logits_indices,
                    use_spec_decode=use_spec_decode,
                    num_scheduled_tokens=scheduler_output.num_scheduled_tokens,
                    cascade_attn_prefix_lens=cascade_attn_prefix_lens,
3985
                    slot_mappings=slot_mappings_by_group,
3986
                )
3987
            )
3988

3989
3990
3991
3992
3993
3994
3995
3996
3997
            (
                input_ids,
                inputs_embeds,
                positions,
                intermediate_tensors,
                model_kwargs,
                ec_connector_output,
            ) = self._preprocess(
                scheduler_output, num_tokens_padded, intermediate_tensors
3998
            )
3999

4000
        # Set cudagraph mode to none if calc_kv_scales is true.
4001
4002
4003
        # KV scales calculation involves dynamic operations that are incompatible
        # with CUDA graph capture.
        if self.calculate_kv_scales:
4004
            cudagraph_mode = CUDAGraphMode.NONE
4005
4006
            # Mark KV scales as calculated after the first forward pass
            self.calculate_kv_scales = False
4007

4008
4009
4010
4011
4012
4013
4014
        # Encoder-decoder models can only compile the pure decode steps where no
        # encoder inputs are present. Use eager for the first pass.
        num_encoder_reqs = len(scheduler_output.scheduled_encoder_inputs)
        has_encoder_input = (
            self.model_config.is_encoder_decoder and num_encoder_reqs > 0
        )

4015
4016
        # Run the model.
        # Use persistent buffers for CUDA graphs.
4017
4018
4019
        # When spec decode is enabled, defer connector finalization
        # (wait_for_save + clear metadata) until after draft model runs.
        defer_kv_connector_finalize = self.speculative_config is not None
4020
4021
        with (
            set_forward_context(
4022
4023
                attn_metadata,
                self.vllm_config,
4024
                num_tokens=num_tokens_padded,
4025
                num_tokens_across_dp=num_tokens_across_dp,
4026
4027
                cudagraph_runtime_mode=cudagraph_mode,
                batch_descriptor=batch_desc,
4028
                ubatch_slices=ubatch_slices_padded,
4029
                slot_mapping=slot_mappings,
4030
                skip_compiled=has_encoder_input,
4031
            ),
4032
            record_function_or_nullcontext("gpu_model_runner: forward"),
4033
            self.maybe_get_kv_connector_output(
4034
4035
                scheduler_output,
                defer_finalize=defer_kv_connector_finalize,
4036
            ) as kv_connector_output,
4037
        ):
4038
            model_output = self._model_forward(
4039
4040
4041
4042
4043
4044
4045
                input_ids=input_ids,
                positions=positions,
                intermediate_tensors=intermediate_tensors,
                inputs_embeds=inputs_embeds,
                **model_kwargs,
            )

4046
        with record_function_or_nullcontext("gpu_model_runner: postprocess"):
4047
            if self.use_aux_hidden_state_outputs:
4048
                # True when EAGLE 3 is used.
4049
4050
                hidden_states, aux_hidden_states = model_output
            else:
4051
                # Common case.
4052
4053
4054
                hidden_states = model_output
                aux_hidden_states = None

4055
4056
4057
4058
4059
            if not self.broadcast_pp_output:
                # Common case.
                if not get_pp_group().is_last_rank:
                    # Return the intermediate tensors.
                    assert isinstance(hidden_states, IntermediateTensors)
4060
                    hidden_states.kv_connector_output = kv_connector_output
4061
                    self.kv_connector_output = kv_connector_output
4062
                    return hidden_states
4063

4064
                if self.is_pooling_model:
4065
                    # Return the pooling output.
4066
4067
4068
4069
4070
                    return self._pool(
                        hidden_states,
                        num_scheduled_tokens,
                        num_scheduled_tokens_np,
                        kv_connector_output,
4071
                    )
4072
4073

                sample_hidden_states = hidden_states[logits_indices]
4074
                logits = self.model.compute_logits(sample_hidden_states)
4075
4076
4077
4078
            else:
                # Rare case.
                assert not self.is_pooling_model

4079
                sample_hidden_states = hidden_states[logits_indices]
4080
                if not get_pp_group().is_last_rank:
4081
                    all_gather_tensors = {
4082
                        "residual": not is_residual_scattered_for_sp(
4083
                            self.vllm_config, num_tokens_padded
4084
                        )
4085
                    }
4086
                    get_pp_group().send_tensor_dict(
4087
4088
                        hidden_states.tensors,
                        all_gather_group=get_tp_group(),
4089
4090
                        all_gather_tensors=all_gather_tensors,
                    )
4091
4092
                    logits = None
                else:
4093
                    logits = self.model.compute_logits(sample_hidden_states)
4094

4095
                model_output_broadcast_data: dict[str, Any] = {}
4096
4097
4098
                if logits is not None:
                    model_output_broadcast_data["logits"] = logits.contiguous()

4099
                broadcasted = get_pp_group().broadcast_tensor_dict(
4100
4101
                    model_output_broadcast_data, src=len(get_pp_group().ranks) - 1
                )
4102
4103
                assert broadcasted is not None
                logits = broadcasted["logits"]
4104

4105
4106
4107
4108
4109
4110
4111
4112
        self.execute_model_state = ExecuteModelState(
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
4113
            ec_connector_output,
4114
            cudagraph_stats,
4115
            slot_mappings,
4116
        )
4117
        self.kv_connector_output = kv_connector_output
4118
4119
4120
4121
4122
4123

        # Now the batch has been launched we can wait for corrections from the
        # previous model forward without breaking async scheduling.
        if deferred_state_corrections_fn:
            deferred_state_corrections_fn()

4124
4125
4126
4127
4128
4129
4130
        return None

    @torch.inference_mode
    def sample_tokens(
        self, grammar_output: "GrammarOutput | None"
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors:
        if self.execute_model_state is None:
4131
4132
            kv_connector_output = self.kv_connector_output
            self.kv_connector_output = None
4133
4134
4135
            # receive sampled token ids from the last PP rank.
            if self.use_async_scheduling and get_pp_group().world_size > 1:
                self._pp_receive_prev_sampled_token_ids_to_input_batch()
4136
            if not kv_connector_output:
4137
                return None  # type: ignore[return-value]
4138
4139
4140
4141
4142
4143
4144
4145
4146

            # In case of PP with kv transfer, we need to pass through the
            # kv_connector_output
            if kv_connector_output.is_empty():
                return EMPTY_MODEL_RUNNER_OUTPUT

            output = copy(EMPTY_MODEL_RUNNER_OUTPUT)
            output.kv_connector_output = kv_connector_output
            return output
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156

        # Unpack ephemeral state.
        (
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
4157
            ec_connector_output,
4158
            cudagraph_stats,
4159
            slot_mappings,
4160
4161
4162
4163
4164
4165
4166
4167
4168
        ) = self.execute_model_state
        # Clear ephemeral state.
        self.execute_model_state = None

        # Apply structured output bitmasks if present.
        if grammar_output is not None:
            apply_grammar_bitmask(
                scheduler_output, grammar_output, self.input_batch, logits
            )
4169

4170
        with record_function_or_nullcontext("gpu_model_runner: sample"):
4171
4172
            sampler_output = self._sample(logits, spec_decode_metadata)

4173
4174
4175
        self._update_states_after_model_execute(
            sampler_output.sampled_token_ids, scheduler_output
        )
4176
4177
        if self.use_async_scheduling:
            pp = get_pp_group()
4178
4179
4180
4181
            # For torchrun external_launcher PP mode with broadcast_pp_output=True,
            # PP outputs have been broadcasted to all ranks at logits computation.
            # Therefore, here is no need to send sampled token ids again in this case.
            if not self.broadcast_pp_output and pp.world_size > 1 and pp.is_last_rank:
4182
4183
4184
                self._pp_broadcast_prev_sampled_token_ids(
                    sampler_output.sampled_token_ids
                )
4185

4186
4187
        self._draft_token_ids = None
        self._draft_token_req_ids = None
4188
        self.valid_sampled_token_count_gpu = None
4189
4190
        self.input_batch.prev_sampled_token_ids = None

4191
        def propose_draft_token_ids(sampled_token_ids):
4192
            assert spec_decode_common_attn_metadata is not None
4193
            with record_function_or_nullcontext("gpu_model_runner: draft"):
4194
4195
4196
4197
4198
4199
4200
4201
4202
                self._draft_token_ids = self.propose_draft_token_ids(
                    scheduler_output,
                    sampled_token_ids,
                    self.input_batch.sampling_metadata,
                    hidden_states,
                    sample_hidden_states,
                    aux_hidden_states,
                    spec_decode_metadata,
                    spec_decode_common_attn_metadata,
4203
                    slot_mappings,
4204
                )
4205
                self._copy_draft_token_ids_to_cpu(scheduler_output)
4206

4207
        spec_config = self.speculative_config
4208
4209
        propose_drafts_after_bookkeeping = False
        if spec_config is not None:
4210
            # Decide whether to run the drafter or zero out draft tokens.
4211
4212
4213
            input_fits_in_drafter = spec_decode_common_attn_metadata is not None and (
                spec_decode_common_attn_metadata.max_seq_len + self.num_spec_tokens
                <= self.effective_drafter_max_model_len
4214
            )
4215
            use_gpu_toks = (
4216
4217
4218
                spec_config.use_eagle()
                or spec_config.uses_draft_model()
                or spec_config.uses_extract_hidden_states()
4219
4220
4221
            ) and not spec_config.disable_padded_drafter_batch
            if use_gpu_toks:
                # EAGLE/DraftModel speculative decoding can use the GPU sampled tokens
4222
                # as inputs, and does not need to wait for bookkeeping to finish.
4223
4224
                assert isinstance(
                    self.drafter,
4225
4226
4227
4228
                    EagleProposer
                    | DFlashProposer
                    | DraftModelProposer
                    | ExtractHiddenStatesProposer,
4229
                )
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
                sampled_token_ids = sampler_output.sampled_token_ids
                if input_fits_in_drafter:
                    propose_draft_token_ids(sampled_token_ids)
                elif self.valid_sampled_token_count_event is not None:
                    assert spec_decode_common_attn_metadata is not None
                    next_token_ids, valid_sampled_tokens_count = (
                        self.drafter.prepare_next_token_ids_padded(
                            sampled_token_ids,
                            self.requests,
                            self.input_batch,
                            self.discard_request_mask.gpu,
                        )
4242
                    )
4243
4244
4245
                    self._copy_valid_sampled_token_count(
                        next_token_ids, valid_sampled_tokens_count
                    )
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
            elif (
                spec_config.use_ngram_gpu()
                and not spec_config.disable_padded_drafter_batch
            ):
                assert isinstance(self.drafter, NgramProposerGPU)
                sampled_token_ids = sampler_output.sampled_token_ids
                if input_fits_in_drafter:
                    propose_draft_token_ids(sampled_token_ids)
                elif self.valid_sampled_token_count_event is not None:
                    assert spec_decode_common_attn_metadata is not None
                    next_token_ids, valid_sampled_tokens_count, _ = (
                        self.drafter.update_token_ids_ngram(
                            sampled_token_ids,
                            self.input_batch,
                            self.token_ids_gpu_tensor,
                            self.num_tokens_no_spec_gpu,
                            self.discard_request_mask.gpu,
                        )
                    )
                    self._copy_valid_sampled_token_count(
                        next_token_ids, valid_sampled_tokens_count
                    )
4268
4269
            else:
                propose_drafts_after_bookkeeping = input_fits_in_drafter
4270

4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
            if not input_fits_in_drafter:
                # Zero out draft tokens so the scheduler doesn't schedule
                # stale drafts from the previous step.
                # For Nemotron-H: it is necessary to zero out the draft tokens,
                # otherwise the stale tokens will corrupt Mamba recurrent
                # state and logprobs for sequences near max_model_len.
                self._draft_token_ids = torch.zeros(
                    1, device=self.device, dtype=torch.int32
                ).expand(len(self.input_batch.req_ids), self.num_spec_tokens)
                self._copy_draft_token_ids_to_cpu(scheduler_output, zeros_only=True)

4282
        with record_function_or_nullcontext("gpu_model_runner: bookkeep"):
4283
4284
4285
4286
4287
4288
4289
4290
            (
                num_nans_in_logits,
                logprobs_lists,
                valid_sampled_token_ids,
                prompt_logprobs_dict,
                req_ids_output_copy,
                req_id_to_index_output_copy,
                invalid_req_indices,
4291
4292
4293
4294
4295
            ) = self._bookkeeping_sync(
                scheduler_output,
                sampler_output,
                logits,
                hidden_states,
4296
                scheduler_output.total_num_scheduled_tokens,
4297
                spec_decode_metadata,
4298
            )
4299

4300
        if propose_drafts_after_bookkeeping:
4301
4302
4303
            # ngram and other speculative decoding methods use the sampled
            # tokens on the CPU, so they are run after bookkeeping.
            propose_draft_token_ids(valid_sampled_token_ids)
4304

4305
4306
4307
4308
4309
        # Finalize KV connector (wait_for_save + clear metadata) after
        # draft model runs. Deferred from target model forward to allow
        # draft model to also save its KV cache.
        if spec_config is not None:
            self.finalize_kv_connector()
4310

4311
        with record_function_or_nullcontext("gpu_model_runner: eplb"):
4312
            self.eplb_step()
4313

4314
4315
4316
4317
        # self.kv_connector_output may be modified during drafting
        kv_connector_output = self.kv_connector_output
        self.kv_connector_output = None

4318
        with record_function_or_nullcontext("gpu_model_runner: ModelRunnerOutput"):
4319
            if self.routed_experts_initialized:
4320
4321
4322
4323
4324
4325
                capturer = RoutedExpertsCapturer.get_instance()
                if capturer is not None:
                    capturer.save_captured_experts(indices=self.slot_mapping)  # noqa
                else:
                    logger.error("RoutedExpertsCapturer not initialized.")

4326
4327
4328
4329
4330
4331
4332
            output = ModelRunnerOutput(
                req_ids=req_ids_output_copy,
                req_id_to_index=req_id_to_index_output_copy,
                sampled_token_ids=valid_sampled_token_ids,
                logprobs=logprobs_lists,
                prompt_logprobs_dict=prompt_logprobs_dict,
                kv_connector_output=kv_connector_output,
4333
4334
4335
                ec_connector_output=ec_connector_output
                if self.supports_mm_inputs
                else None,
4336
                num_nans_in_logits=num_nans_in_logits,
4337
                cudagraph_stats=cudagraph_stats,
4338
            )
4339

4340
4341
        if not self.use_async_scheduling:
            return output
4342

4343
4344
4345
4346
4347
4348
4349
4350
        with record_function_or_nullcontext(
            "gpu_model_runner: AsyncGPUModelRunnerOutput"
        ):
            async_output = AsyncGPUModelRunnerOutput(
                model_runner_output=output,
                sampled_token_ids=sampler_output.sampled_token_ids,
                logprobs_tensors=sampler_output.logprobs_tensors,
                invalid_req_indices=invalid_req_indices,
4351
                async_output_copy_stream=self._get_or_create_async_output_copy_stream(),
4352
                vocab_size=self.input_batch.vocab_size,
4353
4354
4355
4356
4357
            )
        with record_function_or_nullcontext(
            "gpu_model_runner: set_async_sampled_token_ids"
        ):
            # Save ref of sampled_token_ids CPU tensor if the batch contains
4358
            # any requests with sampling params that require output ids.
4359
4360
4361
4362
            self.input_batch.set_async_sampled_token_ids(
                async_output.sampled_token_ids_cpu,
                async_output.async_copy_ready_event,
            )
4363
4364
4365

        return async_output

4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
    def _pp_broadcast_prev_sampled_token_ids(
        self, sampled_token_ids: torch.Tensor
    ) -> None:
        """Broadcast sampled token ids (GPU) from last PP stage"""
        pp = get_pp_group()
        assert pp.is_last_rank
        # `prev_sampled_token_ids` is expected to have shape [num_reqs, 1].
        assert sampled_token_ids.dim() == 2 and sampled_token_ids.shape[-1] == 1, (
            "PP+async expects sampled_token_ids to have shape [num_reqs, 1]"
        )
        torch.distributed.broadcast(
            sampled_token_ids, src=pp.rank, group=pp.device_group
        )

    def _pp_receive_prev_sampled_token_ids_to_input_batch(self) -> None:
        """Receive sampled token ids broadcast from last PP stage"""
        pp = get_pp_group()
        assert not pp.is_last_rank
        num_reqs = self.input_batch.num_reqs
        # `prev_sampled_token_ids` is expected to have shape [num_reqs, 1].
        recv = torch.empty((num_reqs, 1), dtype=torch.int32, device=self.device)
        torch.distributed.broadcast(recv, src=pp.last_rank, group=pp.device_group)
        self.input_batch.prev_sampled_token_ids = recv

        # construct `prev_req_id_to_index` here so `_prepare_input_ids`
        # can map req_id -> previous batch row
        discard_req_indices = np.nonzero(self.discard_request_mask.np[:num_reqs])[0]
        discard_req_indices_set = set(discard_req_indices)
        prev_req_id_to_index: dict[str, int] = {}
        for i, req_id in enumerate(self.input_batch.req_ids):
            if i in discard_req_indices_set:
                continue
            prev_req_id_to_index[req_id] = i
            # PP+async scheduling: advance per-request local cached output length by
            # appending a placeholder (-1) token id.
            if (req_state := self.requests.get(req_id)) is not None:
                req_state.output_token_ids.append(-1)
        self.input_batch.prev_req_id_to_index = prev_req_id_to_index

4405
    def take_draft_token_ids(self) -> DraftTokenIds | None:
4406
        if not self.num_spec_tokens or not self._draft_token_req_ids:
4407
            return None
4408
        draft_token_ids, req_ids = self._get_draft_token_ids_cpu()
4409
        return DraftTokenIds(req_ids, draft_token_ids)
4410

4411
4412
4413
    def _copy_draft_token_ids_to_cpu(
        self, scheduler_output: "SchedulerOutput", zeros_only: bool = False
    ) -> None:
4414
4415
4416
4417
4418
4419
        # Check if we need to copy draft tokens to CPU. In async scheduling,
        # we only copy when needed for structured output, penalties or bad_words.
        if self.use_async_scheduling and not (
            scheduler_output.has_structured_output_requests
            or self.input_batch.sampling_metadata.output_token_ids
        ):
4420
4421
4422
            return
        # We must also set the corresponding request ids.
        self._draft_token_req_ids = self.input_batch.req_ids.copy()
4423

4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
        draft_token_ids: torch.Tensor = self._draft_token_ids
        if not torch.is_tensor(draft_token_ids):
            return
        assert self.draft_token_ids_event is not None
        assert self.draft_token_ids_copy_stream is not None
        assert self.draft_token_ids_cpu is not None
        default_stream = torch.cuda.current_stream()
        num_reqs = draft_token_ids.shape[0]
        with torch.cuda.stream(self.draft_token_ids_copy_stream):
            if not zeros_only:
                # Trigger async copy of draft token ids to cpu.
                self.draft_token_ids_copy_stream.wait_stream(default_stream)
                self.draft_token_ids_cpu[:num_reqs].copy_(
                    draft_token_ids, non_blocking=True
                )
            else:
                # No copy needed, just zero-out cpu tensor.
                self.draft_token_ids_cpu[:num_reqs] = 0
            self.draft_token_ids_event.record()

4444
    def _get_draft_token_ids_cpu(self) -> tuple[list[list[int]], list[str]]:
4445
        if isinstance(self._draft_token_ids, list):
4446
4447
4448
4449
            return self._draft_token_ids, self.input_batch.req_ids
        req_ids = self._draft_token_req_ids
        if req_ids is None:
            return [], []
4450
4451
4452
        assert self.draft_token_ids_event is not None
        assert self.draft_token_ids_cpu is not None
        self.draft_token_ids_event.synchronize()
4453
        return self.draft_token_ids_cpu[: len(req_ids)].tolist(), req_ids
4454

4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
    def _copy_valid_sampled_token_count(
        self, next_token_ids: torch.Tensor, valid_sampled_tokens_count: torch.Tensor
    ) -> None:
        if self.valid_sampled_token_count_event is None:
            return

        default_stream = torch.cuda.current_stream()
        # Initialize a new stream to overlap the copy operation with
        # prepare_input of draft model.
        with torch.cuda.stream(self.valid_sampled_token_count_copy_stream):
            self.valid_sampled_token_count_copy_stream.wait_stream(default_stream)  # type: ignore
            counts = valid_sampled_tokens_count
            counts_cpu = self.valid_sampled_token_count_cpu
4468
            assert counts_cpu is not None
4469
4470
4471
            counts_cpu[: counts.shape[0]].copy_(counts, non_blocking=True)
            self.valid_sampled_token_count_event.record()

4472
4473
4474
        if self.use_async_spec_decode:
            # Stash for GPU-side correction in _prepare_inputs.
            self.valid_sampled_token_count_gpu = valid_sampled_tokens_count
4475
4476
4477
4478
4479
        self.input_batch.prev_sampled_token_ids = next_token_ids.unsqueeze(1)

    def _get_valid_sampled_token_count(self) -> list[int]:
        # Wait until valid_sampled_tokens_count is copied to cpu,
        prev_sampled_token_ids = self.input_batch.prev_sampled_token_ids
4480
4481
        sampled_count_event = self.valid_sampled_token_count_event
        if sampled_count_event is None or prev_sampled_token_ids is None:
4482
4483
4484
            return []

        counts_cpu = self.valid_sampled_token_count_cpu
4485
4486
        assert counts_cpu is not None
        sampled_count_event.synchronize()
4487
4488
        return counts_cpu[: prev_sampled_token_ids.shape[0]].tolist()

4489
4490
4491
    def propose_draft_token_ids(
        self,
        scheduler_output: "SchedulerOutput",
4492
        sampled_token_ids: torch.Tensor | list[list[int]],
4493
4494
4495
        sampling_metadata: SamplingMetadata,
        hidden_states: torch.Tensor,
        sample_hidden_states: torch.Tensor,
4496
4497
        aux_hidden_states: list[torch.Tensor] | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
4498
        common_attn_metadata: CommonAttentionMetadata,
4499
        slot_mappings: dict[str, torch.Tensor] | list[dict[str, torch.Tensor]] | None,
4500
    ) -> list[list[int]] | torch.Tensor:
4501
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
4502
4503
4504
        spec_config = self.speculative_config
        assert spec_config is not None
        if spec_config.method == "ngram":
4505
4506
            from vllm.v1.spec_decode.ngram_proposer import NgramProposer

4507
            assert isinstance(sampled_token_ids, list)
4508
            assert isinstance(self.drafter, NgramProposer)
4509
            draft_token_ids = self.drafter.propose(
4510
                sampled_token_ids,
4511
4512
                self.input_batch.num_tokens_no_spec,
                self.input_batch.token_ids_cpu,
4513
                slot_mappings=slot_mappings,
4514
            )
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
        elif spec_config.use_ngram_gpu():
            assert isinstance(self.drafter, NgramProposerGPU)
            (
                next_token_ids,
                valid_sampled_tokens_count,
                valid_sampled_token_ids_gpu,
            ) = self.drafter.update_token_ids_ngram(
                sampled_token_ids,
                self.input_batch,
                self.token_ids_gpu_tensor,
                self.num_tokens_no_spec_gpu,
                self.discard_request_mask.gpu,
            )
            self._copy_valid_sampled_token_count(
                next_token_ids, valid_sampled_tokens_count
            )

            batch_size = next_token_ids.shape[0]

            draft_token_ids, num_valid_draft_tokens = self.drafter.propose(
                self.num_tokens_no_spec_gpu[:batch_size],
                self.token_ids_gpu_tensor[:batch_size],
                valid_sampled_token_ids_gpu,
                valid_sampled_tokens_count,
            )

            # Cache valid draft counts for scheduler-side trimming.
            self._num_valid_draft_tokens = num_valid_draft_tokens

            # Async D2H copy on a dedicated stream.
            copy_num_valid_draft_tokens(
                self._num_valid_draft_tokens_cpu,
                self._num_valid_draft_tokens_copy_stream,
                self._num_valid_draft_tokens_event,
                self._num_valid_draft_tokens,
                self.input_batch.num_reqs,
            )
4552
        elif spec_config.method == "suffix":
4553
4554
            assert isinstance(sampled_token_ids, list)
            assert isinstance(self.drafter, SuffixDecodingProposer)
4555
4556
4557
            draft_token_ids = self.drafter.propose(
                self.input_batch, sampled_token_ids, slot_mappings=slot_mappings
            )
4558
        elif spec_config.method == "medusa":
4559
            assert isinstance(sampled_token_ids, list)
4560
            assert isinstance(self.drafter, MedusaProposer)
4561

4562
4563
            if sample_hidden_states.shape[0] == len(sampled_token_ids):
                # The input to the target model does not include draft tokens.
4564
4565
4566
4567
                hidden_states = sample_hidden_states
            else:
                indices = []
                offset = 0
4568
4569
4570
                assert spec_decode_metadata is not None, (
                    "No spec decode metadata for medusa"
                )
4571
                for num_draft, tokens in zip(
4572
4573
                    spec_decode_metadata.num_draft_tokens, sampled_token_ids
                ):
4574
                    indices.append(offset + len(tokens) - 1)
4575
                    offset += num_draft + 1
4576
                indices = torch.tensor(indices, device=self.device)
4577
4578
                hidden_states = sample_hidden_states[indices]

4579
            draft_token_ids = self.drafter.propose(
4580
4581
                target_hidden_states=hidden_states,
                sampling_metadata=sampling_metadata,
4582
                slot_mappings=slot_mappings,
4583
            )
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
        elif spec_config.uses_extract_hidden_states():
            assert isinstance(self.drafter, ExtractHiddenStatesProposer)
            assert isinstance(sampled_token_ids, torch.Tensor), (
                "sampled_token_ids should be a torch.Tensor for "
                "extract_hidden_states method."
            )
            if not self.use_aux_hidden_state_outputs or aux_hidden_states is None:
                raise ValueError(
                    "aux_hidden_states are required when using `extract_hidden_states`"
                )
            target_hidden_states = [h[:num_scheduled_tokens] for h in aux_hidden_states]

4596
            draft_token_ids = self.drafter.propose(
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
                sampled_token_ids=sampled_token_ids,
                target_hidden_states=target_hidden_states,
                common_attn_metadata=common_attn_metadata,
                slot_mappings=slot_mappings,
            )
            next_token_ids, valid_sampled_tokens_count = (
                self.drafter.prepare_next_token_ids_padded(
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    self.discard_request_mask.gpu,
                )
            )
            self._copy_valid_sampled_token_count(
                next_token_ids, valid_sampled_tokens_count
            )

4614
4615
4616
4617
4618
4619
4620
4621
        elif (
            spec_config.use_eagle()
            or spec_config.use_dflash()
            or spec_config.uses_draft_model()
        ):
            assert isinstance(
                self.drafter, EagleProposer | DFlashProposer | DraftModelProposer
            )
4622

4623
            if spec_config.disable_padded_drafter_batch:
4624
4625
4626
                # When padded-batch is disabled, the sampled_token_ids should be
                # the cpu-side list[list[int]] of valid sampled tokens for each
                # request, with invalid requests having empty lists.
4627
4628
                assert isinstance(sampled_token_ids, list), (
                    "sampled_token_ids should be a python list when"
4629
                    "padded-batch is disabled."
4630
                )
4631
                next_token_ids = self.drafter.prepare_next_token_ids_cpu(
4632
4633
4634
4635
4636
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    scheduler_output.num_scheduled_tokens,
                )
4637
4638
4639
4640
4641
            else:
                # When using padded-batch, the sampled_token_ids should be
                # the gpu tensor of sampled tokens for each request, of shape
                # (num_reqs, num_spec_tokens + 1) with rejected tokens having
                # value -1.
4642
4643
                assert isinstance(sampled_token_ids, torch.Tensor), (
                    "sampled_token_ids should be a torch.Tensor when"
4644
                    "padded-batch is enabled."
4645
4646
                )
                next_token_ids, valid_sampled_tokens_count = (
4647
4648
4649
4650
                    self.drafter.prepare_next_token_ids_padded(
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
4651
                        self.discard_request_mask.gpu,
4652
                    )
4653
                )
4654
4655
4656
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
Jiayi Yao's avatar
Jiayi Yao committed
4657

4658
            num_rejected_tokens_gpu = None
4659
            if spec_decode_metadata is None:
4660
                token_indices_to_sample = None
4661
                # input_ids can be None for multimodal models.
4662
                target_token_ids = self.input_ids.gpu[:num_scheduled_tokens]
4663
                target_positions = self._get_positions(num_scheduled_tokens)
4664
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
4665
                    assert aux_hidden_states is not None
4666
                    target_hidden_states = torch.cat(
4667
4668
                        [h[:num_scheduled_tokens] for h in aux_hidden_states], dim=-1
                    )
4669
4670
                else:
                    target_hidden_states = hidden_states[:num_scheduled_tokens]
4671
            else:
4672
                if spec_config.disable_padded_drafter_batch:
4673
                    token_indices_to_sample = None
4674
4675
4676
4677
4678
                    common_attn_metadata, token_indices = self.drafter.prepare_inputs(
                        common_attn_metadata,
                        sampled_token_ids,
                        spec_decode_metadata.num_draft_tokens,
                    )
4679
4680
4681
4682
4683
4684
4685
4686
4687
                    target_token_ids = self.input_ids.gpu[token_indices]
                    target_positions = self._get_positions(token_indices)
                    if self.use_aux_hidden_state_outputs:
                        assert aux_hidden_states is not None
                        target_hidden_states = torch.cat(
                            [h[token_indices] for h in aux_hidden_states], dim=-1
                        )
                    else:
                        target_hidden_states = hidden_states[token_indices]
4688
                else:
4689
4690
4691
4692
4693
4694
4695
4696
                    (
                        common_attn_metadata,
                        token_indices_to_sample,
                        num_rejected_tokens_gpu,
                    ) = self.drafter.prepare_inputs_padded(
                        common_attn_metadata,
                        spec_decode_metadata,
                        valid_sampled_tokens_count,
4697
                    )
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
                    total_num_tokens = common_attn_metadata.num_actual_tokens
                    # When padding the batch, token_indices is just a range
                    target_token_ids = self.input_ids.gpu[:total_num_tokens]
                    target_positions = self._get_positions(total_num_tokens)
                    if self.use_aux_hidden_state_outputs:
                        assert aux_hidden_states is not None
                        target_hidden_states = torch.cat(
                            [h[:total_num_tokens] for h in aux_hidden_states], dim=-1
                        )
                    else:
                        target_hidden_states = hidden_states[:total_num_tokens]
4709

4710
            if self.supports_mm_inputs and self.drafter.supports_mm_inputs:
4711
4712
4713
4714
4715
4716
                mm_embed_inputs = self._gather_mm_embeddings(
                    scheduler_output,
                    shift_computed_tokens=1,
                )
            else:
                mm_embed_inputs = None
4717

4718
            draft_token_ids = self.drafter.propose(
4719
4720
4721
4722
                target_token_ids=target_token_ids,
                target_positions=target_positions,
                target_hidden_states=target_hidden_states,
                next_token_ids=next_token_ids,
4723
                token_indices_to_sample=token_indices_to_sample,
4724
                sampling_metadata=sampling_metadata,
4725
                common_attn_metadata=common_attn_metadata,
4726
                mm_embed_inputs=mm_embed_inputs,
4727
                num_rejected_tokens_gpu=num_rejected_tokens_gpu,
4728
                slot_mappings=slot_mappings,
4729
            )
4730

4731
        return draft_token_ids
4732

4733
4734
4735
    def update_config(self, overrides: dict[str, Any]) -> None:
        allowed_config_names = {"load_config", "model_config"}
        for config_name, config_overrides in overrides.items():
4736
4737
            assert config_name in allowed_config_names, (
                f"Config `{config_name}` not supported. "
4738
                f"Allowed configs: {allowed_config_names}"
4739
            )
4740
4741
4742
4743
            config = getattr(self, config_name)
            new_config = update_config(config, config_overrides)
            setattr(self, config_name, new_config)

4744
    @instrument(span_name="Loading (GPU)")
4745
    def load_model(self, load_dummy_weights: bool = False) -> None:
4746
4747
        """
        Args:
4748
            load_dummy_weights: load dummy weights instead of real weights.
4749
        """
4750
4751
4752
4753
4754
        logger.info_once(
            "Starting to load model %s...",
            self.model_config.model,
            scope="global",
        )
4755

4756
4757
4758
4759
        if self.parallel_config.enable_eplb:
            self.eplb_state = EplbState(self.parallel_config, self.device)
            eplb_models = 0

4760
4761
4762
        try:
            with DeviceMemoryProfiler() as m:
                time_before_load = time.perf_counter()
4763
4764
                if load_dummy_weights:
                    self.load_config.load_format = "dummy"
4765
4766
4767
4768
4769
4770
4771
                model_loader = get_model_loader(self.load_config)
                self.model = model_loader.load_model(
                    vllm_config=self.vllm_config, model_config=self.model_config
                )
                if self.lora_config:
                    self.model = self.load_lora_model(
                        self.model, self.vllm_config, self.device
4772
                    )
4773
4774
4775
4776
4777
4778
4779
4780
                if hasattr(self, "drafter"):
                    logger.info_once("Loading drafter model...")
                    self.drafter.load_model(self.model)
                    if (
                        hasattr(self.drafter, "model")
                        and is_mixture_of_experts(self.drafter.model)
                        and self.parallel_config.enable_eplb
                    ):
4781
4782
4783
                        assert not self.parallel_config.enable_elastic_ep, (
                            "Elastic EP is not supported with drafter model."
                        )
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
                        spec_config = self.vllm_config.speculative_config
                        assert spec_config is not None
                        assert spec_config.draft_model_config is not None
                        logger.info_once(
                            "EPLB is enabled for drafter model %s.",
                            spec_config.draft_model_config.model,
                        )
                        if self.eplb_state is None:
                            self.eplb_state = EplbState(
                                self.parallel_config, self.device
                            )
                        self.eplb_state.add_model(
                            self.drafter.model,
                            spec_config.draft_model_config,
                        )
                        eplb_models += 1
4800

4801
4802
4803
4804
4805
4806
                if self.use_aux_hidden_state_outputs:
                    if not supports_eagle3(self.get_model()):
                        raise RuntimeError(
                            "Model does not support EAGLE3 interface but "
                            "aux_hidden_state_outputs was requested"
                        )
4807

4808
4809
4810
4811
4812
4813
4814
4815
4816
                    # Try to get auxiliary layers from speculative config,
                    # otherwise use model's default layers
                    aux_layers = self._get_eagle3_aux_layers_from_config()
                    if aux_layers:
                        logger.info(
                            "Using auxiliary layers from speculative config: %s",
                            aux_layers,
                        )
                    else:
4817
4818
4819
                        aux_layers = (
                            self.model.get_eagle3_default_aux_hidden_state_layers()
                        )
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834

                    self.model.set_aux_hidden_state_layers(aux_layers)
                time_after_load = time.perf_counter()
            self.model_memory_usage = m.consumed_memory
        except torch.cuda.OutOfMemoryError as e:
            msg = (
                "Failed to load model - not enough GPU memory. "
                "Try lowering --gpu-memory-utilization to free memory for weights, "
                "increasing --tensor-parallel-size, or using --quantization. "
                "See https://docs.vllm.ai/en/latest/configuration/conserving_memory/ "
                "for more tips."
            )
            combined_msg = f"{msg} (original error: {e})"
            logger.error(combined_msg)
            raise e
4835
        logger.info_once(
4836
4837
            "Model loading took %s GiB memory and %.6f seconds",
            format_gib(self.model_memory_usage),
4838
            time_after_load - time_before_load,
4839
            scope="local",
4840
        )
4841
4842
4843
4844
4845
4846
        if not load_dummy_weights:
            prepare_communication_buffer_for_model(self.model)
            if (drafter := getattr(self, "drafter", None)) and (
                drafter_model := getattr(drafter, "model", None)
            ):
                prepare_communication_buffer_for_model(drafter_model)
4847
        mm_config = self.model_config.multimodal_config
4848
        self.is_multimodal_pruning_enabled = (
4849
            supports_multimodal_pruning(self.get_model())
4850
4851
            and mm_config is not None
            and mm_config.is_multimodal_pruning_enabled()
4852
        )
4853
4854
4855
        self.requires_sequential_video_encoding = hasattr(
            self.get_model(), "requires_sequential_video_encoding"
        )  # Temporary hack for dynamic res video w/o support for bs>1 yet
4856

4857
4858
4859
4860
4861
        if (
            is_mixture_of_experts(self.model)
            and self.parallel_config.enable_eplb
            and not load_dummy_weights
        ):
4862
4863
4864
            logger.info_once("EPLB is enabled for model %s.", self.model_config.model)
            assert self.eplb_state is not None
            self.eplb_state.add_model(
4865
                self.model,
4866
                self.model_config,
4867
            )
4868
            if self.eplb_state.is_async:
4869
                self.eplb_state.start_async_loop()
4870

4871
        if (
4872
4873
            self.vllm_config.compilation_config.mode
            == CompilationMode.STOCK_TORCH_COMPILE
4874
        ):
4875
4876
4877
            from vllm.env_override import _apply_constrain_to_fx_strides_patch

            _apply_constrain_to_fx_strides_patch()
4878
            backend = self.vllm_config.compilation_config.init_backend(self.vllm_config)
4879
            compilation_counter.stock_torch_compile_count += 1
4880
            self.model.compile(fullgraph=True, backend=backend)
4881
            return
4882
        # for other compilation modes, cudagraph behavior is controlled by
Jiayi Yan's avatar
Jiayi Yan committed
4883
        # CudagraphWrapper and CudagraphDispatcher of vllm.
4884
4885

        # wrap the model with full cudagraph wrapper if needed.
4886
4887
        cudagraph_mode = self.compilation_config.cudagraph_mode
        assert cudagraph_mode is not None
4888
4889
4890
4891
        if (
            cudagraph_mode.has_full_cudagraphs()
            and not self.parallel_config.use_ubatching
        ):
4892
4893
4894
            self.model = CUDAGraphWrapper(
                self.model, self.vllm_config, runtime_mode=CUDAGraphMode.FULL
            )
4895
        elif self.parallel_config.use_ubatching:
4896
            if cudagraph_mode.has_full_cudagraphs():
4897
4898
4899
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.FULL, self.device
                )
4900
            else:
4901
4902
4903
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.NONE, self.device
                )
4904

4905
4906
        get_offloader().post_init()

4907
    def _get_eagle3_aux_layers_from_config(self) -> tuple[int, ...] | None:
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
        """Extract Eagle3 auxiliary layer indices from speculative config.

        These indices specify which hidden states from the base model should
        be used as auxiliary inputs for the Eagle3 drafter model during
        speculative decoding.

        Returns:
            Tuple of layer indices if found in draft model config,
            None otherwise.
        """
        if not (self.speculative_config and self.speculative_config.draft_model_config):
            return None

        hf_config = self.speculative_config.draft_model_config.hf_config

4923
4924
4925
4926
4927
4928
        layer_ids = getattr(hf_config, "eagle_aux_hidden_state_layer_ids", None)
        if not layer_ids:
            dflash_config = getattr(hf_config, "dflash_config", None)
            if dflash_config and isinstance(dflash_config, dict):
                layer_ids = dflash_config.get("target_layer_ids")

4929
4930
4931
4932
4933
        if layer_ids and isinstance(layer_ids, (list, tuple)):
            return tuple(layer_ids)

        return None

4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
    def reload_weights(
        self,
        weights_iterator: Iterable[tuple[str, torch.Tensor]] | None = None,
        weights_path: str | None = None,
        is_checkpoint_format: bool = True,
    ) -> None:
        """
        Reload weights from a weights iterator or from disk

        :param weights_iterator: weights to load into model
        :param weights_path: path to load weights from if weights_iterator is not
            provided. Use path of original model if neither is provided.
        :param is_checkpoint_format: set to False if weights have already been processed
Jiayi Yan's avatar
Jiayi Yan committed
4947
            into kernel format (repacking, renaming, etc.)
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
        """
        # TODO(@kylesayrs): generalize to all runners and loaders
        # argument validation
        if weights_iterator is None and not is_checkpoint_format:
            logger.warning(
                "Reloading from disk means that weights will be in checkpoint format. "
                "Please use `is_checkpoint_format=True` "
                "to avoid weight reloading errors"
            )

        model = self.get_model()
        weights_to_load = {name for name, _ in model.named_parameters()}
        counter_before_reloading = time.perf_counter()

        # load weights from disk if none are provided
        if weights_iterator is None:
            model_loader = get_model_loader(self.load_config)
            if not hasattr(model_loader, "get_all_weights"):
                raise NotImplementedError(
                    f"Model reloading with `{self.load_config.load_format}` format"
                )

            if weights_path is not None:
                self.model_config.model = weights_path
            weights_iterator = model_loader.get_all_weights(self.model_config, model)
            weights_iterator = cast(
                Iterable[tuple[str, torch.Tensor]], weights_iterator
            )

        # begin loading weights
        logger.info_once("Reloading weights inplace...", scope="local")
4979
4980
4981
4982
4983
        if is_checkpoint_format:
            # load weights from checkpoint/ original model format
            initialize_layerwise_reload(model)
            loaded_weights = model.load_weights(weights_iterator)
            finalize_layerwise_reload(model, self.model_config)
4984

4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
        else:
            # load weights from kernel format
            logger.warning_once(
                "Reloading with `is_checkpoint_format=True` requires that "
                "weights be in kernel format and already sharded",
                scope="local",
            )
            loaded_weights = set()
            for name, loaded_weight in weights_iterator:
                param = model.get_parameter(name)  # TODO: buffers?
                param.copy_(loaded_weight)
                loaded_weights.add(name)
4997
4998
4999
5000
5001
5002
5003
5004

        # logging and validation
        counter_after_reloading = time.perf_counter()
        diff_seconds = counter_after_reloading - counter_before_reloading
        logger.info_once(
            "Reloading and processing weights took %.2f seconds",
            diff_seconds,
            scope="local",
5005
        )
5006
5007
5008
5009
5010
5011
5012
        if self.model_config.quantization is None and loaded_weights is not None:
            weights_not_loaded = weights_to_load - loaded_weights
            if weights_not_loaded:
                logger.warning(
                    "Following weights were not loaded from checkpoint: %s",
                    weights_not_loaded,
                )
5013

5014
5015
5016
    def _get_prompt_logprobs_dict(
        self,
        hidden_states: torch.Tensor,
5017
        num_scheduled_tokens: dict[str, int],
5018
    ) -> dict[str, LogprobsTensors | None]:
5019
        num_prompt_logprobs_dict = self.num_prompt_logprobs
5020
5021
5022
        if not num_prompt_logprobs_dict:
            return {}

5023
        in_progress_dict = self.input_batch.in_progress_prompt_logprobs_cpu
5024
        prompt_logprobs_dict: dict[str, LogprobsTensors | None] = {}
5025
5026
5027
5028
5029

        # Since prompt logprobs are a rare feature, prioritize simple,
        # maintainable loop over optimal performance.
        completed_prefill_reqs = []
        for req_id, num_prompt_logprobs in num_prompt_logprobs_dict.items():
5030
5031
5032
5033
            num_tokens = num_scheduled_tokens.get(req_id)
            if num_tokens is None:
                # This can happen if the request was preempted in prefill stage.
                continue
5034
5035
5036

            # Get metadata for this request.
            request = self.requests[req_id]
5037
5038
5039
5040
            if request.prompt_token_ids is None:
                # Prompt logprobs is incompatible with prompt embeddings
                continue

5041
5042
            num_prompt_tokens = len(request.prompt_token_ids)
            prompt_token_ids = torch.tensor(request.prompt_token_ids).to(
5043
5044
                self.device, non_blocking=True
            )
5045

5046
5047
5048
5049
5050
5051
            # Set up target LogprobsTensors object.
            logprobs_tensors = in_progress_dict.get(req_id)
            if not logprobs_tensors:
                # Create empty logprobs CPU tensors for the entire prompt.
                # If chunked, we'll copy in slice by slice.
                logprobs_tensors = LogprobsTensors.empty_cpu(
5052
5053
                    num_prompt_tokens - 1, num_prompt_logprobs + 1
                )
5054
5055
                in_progress_dict[req_id] = logprobs_tensors

5056
            # Determine number of logits to retrieve.
5057
5058
            start_idx = request.num_computed_tokens
            start_tok = start_idx + 1
5059
            num_remaining_tokens = num_prompt_tokens - start_tok
5060
            if num_tokens <= num_remaining_tokens:
5061
                # This is a chunk, more tokens remain.
5062
5063
5064
                # In the == case, there are no more prompt logprobs to produce
                # but we want to defer returning them to the next step where we
                # have new generated tokens to return.
5065
5066
5067
5068
5069
                num_logits = num_tokens
            else:
                # This is the last chunk of prompt tokens to return.
                num_logits = num_remaining_tokens
                completed_prefill_reqs.append(req_id)
5070
5071
5072
5073
5074
5075
5076
                prompt_logprobs_dict[req_id] = logprobs_tensors

            if num_logits <= 0:
                # This can happen for the final chunk if we prefilled exactly
                # (num_prompt_tokens - 1) tokens for this request in the prior
                # step. There are no more prompt logprobs to produce.
                continue
5077
5078
5079
5080
5081

            # Get the logits corresponding to this req's prompt tokens.
            # If this is a partial request (i.e. chunked prefill),
            # then there is prompt logprob generated for each index.
            req_idx = self.input_batch.req_id_to_index[req_id]
5082
            offset = self.query_start_loc.np[req_idx].item()
5083
            prompt_hidden_states = hidden_states[offset : offset + num_logits]
5084
            logits = self.model.compute_logits(prompt_hidden_states)
5085
5086
5087
5088

            # Get the "target" tokens for each index. For prompt at index i,
            # the token at prompt index i+1 is the "sampled" token we want
            # to gather the logprob for.
5089
            tgt_token_ids = prompt_token_ids[start_tok : start_tok + num_logits]
5090
5091

            # Compute prompt logprobs.
5092
            logprobs = self.sampler.compute_logprobs(logits)
5093
            token_ids, logprobs, ranks, _ = self.sampler.gather_logprobs(
5094
5095
                logprobs, num_prompt_logprobs, tgt_token_ids
            )
5096
5097

            # Transfer GPU->CPU async.
5098
5099
            chunk_slice = slice(start_idx, start_idx + num_logits)
            logprobs_tensors.logprob_token_ids[chunk_slice].copy_(
5100
5101
5102
                token_ids, non_blocking=True
            )
            logprobs_tensors.logprobs[chunk_slice].copy_(logprobs, non_blocking=True)
5103
            logprobs_tensors.selected_token_ranks[chunk_slice].copy_(
5104
5105
                ranks, non_blocking=True
            )
5106
5107
5108
5109
5110

        # Remove requests that have completed prefill from the batch
        # num_prompt_logprobs_dict.
        for req_id in completed_prefill_reqs:
            del num_prompt_logprobs_dict[req_id]
5111
            del in_progress_dict[req_id]
5112
5113

        # Must synchronize the non-blocking GPU->CPU transfers.
5114
        if prompt_logprobs_dict:
5115
            self._sync_device()
5116
5117
5118

        return prompt_logprobs_dict

5119
5120
    def _get_nans_in_logits(
        self,
5121
        logits: torch.Tensor | None,
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
    ) -> dict[str, int]:
        try:
            if logits is None:
                return {req_id: 0 for req_id in self.input_batch.req_ids}

            num_nans_in_logits = {}
            num_nans_for_index = logits.isnan().sum(dim=-1).cpu().numpy()
            for req_id in self.input_batch.req_ids:
                req_index = self.input_batch.req_id_to_index[req_id]
                num_nans_in_logits[req_id] = (
                    int(num_nans_for_index[req_index])
5133
5134
5135
                    if num_nans_for_index is not None and req_index < logits.shape[0]
                    else 0
                )
5136
5137
5138
5139
            return num_nans_in_logits
        except IndexError:
            return {}

5140
    @contextmanager
5141
5142
5143
    def maybe_randomize_inputs(
        self, input_ids: torch.Tensor | None, inputs_embeds: torch.Tensor | None
    ):
5144
5145
5146
5147
        """
        Randomize input_ids if VLLM_RANDOMIZE_DP_DUMMY_INPUTS is set.
        This is to help balance expert-selection
         - during profile_run
5148
         - during DP rank dummy run
5149
        """
5150

5151
5152
5153
5154
        dp_size = self.vllm_config.parallel_config.data_parallel_size
        randomize_inputs = envs.VLLM_RANDOMIZE_DP_DUMMY_INPUTS and dp_size > 1
        if not randomize_inputs:
            yield
5155
        elif input_ids is not None:
5156
5157
5158
5159

            @functools.cache
            def rand_input_ids() -> torch.Tensor:
                return torch.randint_like(
5160
                    self.input_ids.gpu,
5161
5162
                    low=0,
                    high=self.model_config.get_vocab_size(),
5163
                )
5164

5165
            logger.debug_once("Randomizing dummy input_ids for DP Rank")
5166
            input_ids.copy_(rand_input_ids()[: input_ids.size(0)], non_blocking=True)
5167
5168
            yield
            input_ids.fill_(0)
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
        else:

            @functools.cache
            def rand_inputs_embeds() -> torch.Tensor:
                return torch.randn_like(
                    self.inputs_embeds.gpu,
                )

            assert inputs_embeds is not None
            logger.debug_once("Randomizing dummy inputs_embeds for DP Rank")
            inputs_embeds.copy_(
                rand_inputs_embeds()[: inputs_embeds.size(0)], non_blocking=True
            )
            yield
            inputs_embeds.fill_(0)
5184

5185
5186
5187
5188
5189
5190
    def _get_mm_dummy_batch(
        self,
        modality: str,
        max_items_per_batch: int,
    ) -> BatchedTensorInputs:
        """Dummy data for profiling and precompiling multimodal models."""
5191
5192
        assert self.mm_budget is not None

5193
5194
5195
        # Don't use `max_items_per_batch` here to avoid redundant computation
        dummy_mm_inputs = self.mm_registry.get_dummy_mm_inputs(
            self.model_config,
5196
            mm_counts={modality: 1},
5197
            cache=self.mm_budget.cache,
5198
        )
5199
5200
5201
5202
5203
        dummy_mm_item = dummy_mm_inputs["mm_kwargs"][modality][0]

        # We use the cache so that the item is saved to the cache,
        # but not read from the cache
        assert dummy_mm_item is not None, "Item should not already be cached"
5204

5205
        return next(
5206
5207
            mm_kwargs_batch
            for _, _, mm_kwargs_batch in group_and_batch_mm_kwargs(
5208
                [(modality, dummy_mm_item)] * max_items_per_batch,
5209
5210
5211
5212
                device=self.device,
                pin_memory=self.pin_memory,
            )
        )
5213

5214
5215
5216
5217
    @torch.inference_mode()
    def _dummy_run(
        self,
        num_tokens: int,
5218
        cudagraph_runtime_mode: CUDAGraphMode | None = None,
5219
5220
        force_attention: bool = False,
        uniform_decode: bool = False,
5221
        allow_microbatching: bool = True,
5222
5223
        skip_eplb: bool = False,
        is_profile: bool = False,
5224
        create_mixed_batch: bool = False,
5225
        remove_lora: bool = True,
Rémi Delacourt's avatar
Rémi Delacourt committed
5226
        is_graph_capturing: bool = False,
5227
        num_active_loras: int = 0,
5228
        profile_seq_lens: int | None = None,
5229
    ) -> tuple[torch.Tensor, torch.Tensor]:
5230
5231
5232
5233
5234
5235
5236
        """
        Run a dummy forward pass to warm up/profile run or capture the
        CUDA graph for the model.

        Args:
            num_tokens: Number of tokens to run the dummy forward pass.
            cudagraph_runtime_mode: used to control the behavior.
5237
                - if not set will determine the cudagraph mode based on using
5238
                    the self.cudagraph_dispatcher.
5239
5240
5241
5242
                - CUDAGraphMode.NONE: No cudagraph, for warm up and profile run
                - CUDAGraphMode.PIECEWISE: Piecewise cudagraph.
                - CUDAGraphMode.FULL: Full cudagraph, attention metadata is
                    needed.
5243
            force_attention: If True, always create attention metadata. Used to
5244
5245
5246
5247
                warm up attention backend when mode is NONE.
            uniform_decode: If True, the batch is a uniform decode batch.
            skip_eplb: If True, skip EPLB state update.
            is_profile: If True, this is a profile run.
5248
5249
            create_mixed_batch: If True, create a mixed batch with both decode
                (1 token) and prefill (multiple tokens) requests.
5250
            remove_lora: If False, dummy LoRAs are not destroyed after the run
5251
5252
            num_active_loras: Number of distinct active LoRAs to capture for.
                LoRA is activated when num_active_loras > 0.
5253
5254
5255
            profile_seq_lens: If provided, use this value for seq_lens instead
                of max_query_len. Used to profile attention workspace that
                scales with context length.
5256
        """
5257
5258
        mm_config = self.vllm_config.model_config.multimodal_config
        if mm_config and mm_config.mm_encoder_only:
5259
5260
5261
5262
            # The current dummy run only covers LM execution, so we can skip it.
            # mm encoder dummy run may need to add in the future.
            return torch.tensor([]), torch.tensor([])

5263
5264
        assert (
            cudagraph_runtime_mode is None
5265
            or cudagraph_runtime_mode.is_valid_runtime_mode()
5266
        )
5267

5268
        # If cudagraph_mode.decode_mode() == FULL and
5269
        # cudagraph_mode.separate_routine(). This means that we are using
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
        # different graphs and/or modes for mixed prefill-decode batches vs.
        # uniform decode batches. A uniform decode batch means that all
        # requests have identical query length, except a potential virtual
        # request (shorter) in the batch account for padding.
        # Uniform decode batch could either be common pure decode, where
        # max_query_len == 1, or speculative decode, where
        # max_query_len == 1 + num_spec_decode_tokens.

        # When setting max_query_len = 1, we switch to and capture the optimized
        # routine of FA2 for pure decode, i.e., Flashdecode + an optimization
        # for GQA/MQA.
5281
        max_query_len = self.uniform_decode_query_len if uniform_decode else num_tokens
5282

5283
5284
5285
        # Set num_scheduled_tokens based on num_tokens and max_num_seqs
        # for dummy run with LoRA so that the num_reqs collectively
        # has num_tokens in total.
5286
        assert num_tokens <= self.max_num_tokens
5287
        max_num_reqs = self.scheduler_config.max_num_seqs
5288
5289
5290
5291
        if create_mixed_batch:
            assert not uniform_decode
            # Create mixed batch:
            # first half decode tokens, second half one prefill
5292
            num_decode_tokens = min(max_num_reqs - 1, num_tokens // 2)
5293
5294
5295
5296
            num_prefill_tokens = num_tokens - num_decode_tokens
            num_reqs = num_decode_tokens + 1

            # Create decode requests (1 token each) followed by prefill request
5297
            num_scheduled_tokens_list = [1] * num_decode_tokens + [num_prefill_tokens]
5298
5299
5300
            # Note: Overriding max_query_len to be the prefill tokens
            max_query_len = num_prefill_tokens
        elif uniform_decode:
5301
            assert not create_mixed_batch
5302
            num_reqs = min(max_num_reqs, cdiv(num_tokens, max_query_len))
5303
5304
            num_scheduled_tokens_list = [max_query_len] * num_reqs
            if num_tokens % max_query_len != 0:
5305
                num_scheduled_tokens_list[-1] = num_tokens % max_query_len
5306
5307
5308
5309
5310
5311
        else:
            num_reqs = min(num_tokens, max_num_reqs)
            min_tokens_per_req = num_tokens // num_reqs
            num_scheduled_tokens_list = [min_tokens_per_req] * num_reqs
            num_scheduled_tokens_list[-1] += num_tokens % num_reqs

5312
5313
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs
5314
        num_scheduled_tokens = np.array(num_scheduled_tokens_list, dtype=np.int32)
5315
5316
        num_tokens_unpadded = int(num_scheduled_tokens.sum())

5317
        num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
5318

5319
        _cudagraph_mode, batch_desc, should_ubatch, num_tokens_across_dp, _ = (
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
            self._determine_batch_execution_and_padding(
                num_tokens=num_tokens_unpadded,
                num_reqs=num_reqs,
                num_scheduled_tokens_np=num_scheduled_tokens,
                max_num_scheduled_tokens=max_query_len,
                use_cascade_attn=False,
                allow_microbatching=allow_microbatching,
                force_eager=is_profile
                or (cudagraph_runtime_mode == CUDAGraphMode.NONE),
                # `force_uniform_decode` is used for cudagraph capture; because for
                # capturing mixed prefill-decode batches, we sometimes use
                # num_tokens == num_reqs which looks like a uniform decode batch to the
                # dispatcher; but we actually want to capture a piecewise cudagraph
                force_uniform_decode=uniform_decode,
                # `force_has_lora` is used for cudagraph capture; because LoRA is
                # activated later in the context manager, but we need to know the
                # LoRA state when determining the batch descriptor for capture
5337
5338
5339
5340
                force_has_lora=num_active_loras > 0,
                # `force_num_active_loras` is used for cudagraph capture; because we
                # need to capture graphs for specific num_active_loras counts
                force_num_active_loras=num_active_loras,
5341
5342
            )
        )
5343
5344
5345

        if cudagraph_runtime_mode is None:
            cudagraph_runtime_mode = _cudagraph_mode
5346
        else:
5347
5348
5349
5350
5351
5352
5353
5354
5355
            assert cudagraph_runtime_mode == _cudagraph_mode, (
                f"Cudagraph runtime mode mismatch in dummy_run. "
                f"Expected {_cudagraph_mode}, but got {cudagraph_runtime_mode}."
            )

        num_tokens_padded = batch_desc.num_tokens
        num_reqs_padded = (
            batch_desc.num_reqs if batch_desc.num_reqs is not None else num_reqs
        )
5356
        ubatch_slices, ubatch_slices_padded = maybe_create_ubatch_slices(
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
            should_ubatch,
            num_scheduled_tokens,
            num_tokens_padded,
            num_reqs_padded,
            self.vllm_config.parallel_config.num_ubatches,
        )
        logger.debug(
            "ubatch_slices: %s, ubatch_slices_padded: %s",
            ubatch_slices,
            ubatch_slices_padded,
5367
        )
5368

5369
        attn_metadata: PerLayerAttnMetadata | None = None
5370

5371
        slot_mappings_by_group, slot_mappings = self._get_slot_mappings(
5372
            num_tokens_padded=num_tokens_padded,
5373
5374
5375
5376
5377
            num_reqs_padded=num_reqs_padded,
            num_tokens_unpadded=num_tokens_unpadded,
            ubatch_slices=ubatch_slices_padded,
        )

5378
5379
5380
5381
5382
5383
        # Dummy runs have no real slot assignments — fill with -1 so
        # concat_and_cache kernels skip the KV write.
        if slot_mappings_by_group is not None:
            for sm in slot_mappings_by_group.values():
                sm.fill_(-1)

5384
5385
5386
5387
5388
5389
5390
5391
        # _dummy_run shares pinned CPU buffers (seq_lens, query_start_loc,
        # etc.) with execute_model.  It must participate in the same event
        # protocol so that back-to-back dummy/real steps don't overwrite
        # pinned memory while a prior non_blocking H2D DMA is still reading.
        with self.synchronize_input_prep():
            # If force_attention is True, we always capture attention.
            # Otherwise, it only happens for cudagraph_runtime_mode=FULL.
            if force_attention or cudagraph_runtime_mode == CUDAGraphMode.FULL:
5392
5393
5394
                if profile_seq_lens is not None:
                    seq_lens = profile_seq_lens  # type: ignore[assignment]
                elif create_mixed_batch:
5395
5396
5397
                    # In the mixed batch mode (used for FI warmup), we use
                    # shorter sequence lengths to run faster.
                    # TODO(luka) better system for describing dummy batches
5398
5399
5400
5401
                    seq_lens = torch.tensor(  # type: ignore[assignment]
                        [1] * num_decode_tokens + [num_prefill_tokens + 1],
                        dtype=torch.int,
                    )
5402
5403
                else:
                    seq_lens = max_query_len  # type: ignore[assignment]
5404
5405
5406
                self.optimistic_seq_lens_cpu[:num_reqs] = seq_lens
                self.optimistic_seq_lens_cpu[num_reqs:].fill_(0)
                self.seq_lens.copy_(self.optimistic_seq_lens_cpu, non_blocking=True)
5407

5408
5409
5410
                cum_num_tokens = self._get_cumsum_and_arange(
                    num_scheduled_tokens, self.query_pos.np
                )
5411
5412
                self.query_start_loc.np[1 : num_reqs + 1] = cum_num_tokens
                self.query_start_loc.copy_to_gpu()
5413

5414
5415
5416
5417
5418
5419
                # Sync block table CPU->GPU so cleared rows from
                # remove_request() are visible to the attention metadata
                # builder. Without this, stale block IDs from finished
                # requests can corrupt Mamba state.
                self.input_batch.block_table.commit_block_table(num_reqs_padded)

5420
5421
5422
5423
5424
5425
5426
5427
5428
                pad_attn = cudagraph_runtime_mode == CUDAGraphMode.FULL
                attn_metadata, _ = self._build_attention_metadata(
                    num_tokens=num_tokens_unpadded,
                    num_tokens_padded=num_tokens_padded if pad_attn else None,
                    num_reqs=num_reqs_padded,
                    max_query_len=max_query_len,
                    ubatch_slices=(ubatch_slices_padded if pad_attn else ubatch_slices),
                    for_cudagraph_capture=is_graph_capturing,
                    slot_mappings=slot_mappings_by_group,
5429
                    use_spec_decode=self.speculative_config is not None,
5430
                )
5431

5432
        with self.maybe_dummy_run_with_lora(
5433
5434
5435
5436
            self.lora_config,
            num_scheduled_tokens,
            num_sampled_tokens,
            remove_lora,
5437
            num_active_loras,
5438
        ):
5439
            # Make sure padding doesn't exceed max_num_tokens
5440
            assert num_tokens_padded <= self.max_num_tokens
5441
            model_kwargs = self._init_model_kwargs()
5442
            if self.supports_mm_inputs and not self.model_config.is_encoder_decoder:
Patrick von Platen's avatar
Patrick von Platen committed
5443
5444
                input_ids, inputs_embeds = self._prepare_mm_inputs(num_tokens_padded)

5445
                model_kwargs = {
5446
                    **model_kwargs,
5447
5448
                    **self._dummy_mm_kwargs(num_reqs),
                }
5449
5450
            elif self.enable_prompt_embeds:
                input_ids = None
5451
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_padded]
5452
                model_kwargs = self._init_model_kwargs()
5453
            else:
5454
                input_ids = self.input_ids.gpu[:num_tokens_padded]
5455
                inputs_embeds = None
5456

5457
            if self.uses_mrope:
5458
                positions = self.mrope_positions.gpu[:, :num_tokens_padded]
5459
            elif self.uses_xdrope_dim > 0:
5460
                positions = self.xdrope_positions.gpu[:, :num_tokens_padded]
5461
            else:
5462
                positions = self.positions[:num_tokens_padded]
5463
5464
5465
5466
5467
5468
5469
5470
5471

            if get_pp_group().is_first_rank:
                intermediate_tensors = None
            else:
                if self.intermediate_tensors is None:
                    self.intermediate_tensors = (
                        self.model.make_empty_intermediate_tensors(
                            batch_size=self.max_num_tokens,
                            dtype=self.model_config.dtype,
5472
5473
5474
                            device=self.device,
                        )
                    )
5475
5476

                intermediate_tensors = self.sync_and_slice_intermediate_tensors(
5477
                    num_tokens_padded, None, False
5478
                )
5479

5480
            if ubatch_slices_padded is not None:
5481
5482
5483
                # Adjust values to reflect a single ubatch.
                # TODO(sage,lucas): this is cruft that should be addressed in
                #  the padding refactor.
5484
                num_tokens_padded = ubatch_slices_padded[0].num_tokens
5485
                if num_tokens_across_dp is not None:
5486
                    num_tokens_across_dp[:] = num_tokens_padded
5487

5488
            with (
5489
                self.maybe_randomize_inputs(input_ids, inputs_embeds),
5490
                set_forward_context(
5491
5492
                    attn_metadata,
                    self.vllm_config,
5493
                    num_tokens=num_tokens_padded,
5494
5495
                    num_tokens_across_dp=num_tokens_across_dp,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
5496
                    batch_descriptor=batch_desc,
5497
                    ubatch_slices=ubatch_slices_padded,
5498
                    slot_mapping=slot_mappings,
5499
5500
                ),
            ):
5501
                outputs = self.model(
5502
5503
5504
5505
                    input_ids=input_ids,
                    positions=positions,
                    intermediate_tensors=intermediate_tensors,
                    inputs_embeds=inputs_embeds,
5506
                    **model_kwargs,
5507
                )
5508

5509
5510
5511
5512
            if self.use_aux_hidden_state_outputs:
                hidden_states, _ = outputs
            else:
                hidden_states = outputs
5513

5514
5515
5516
            if self.speculative_config and (
                self.speculative_config.use_eagle()
                or self.speculative_config.uses_draft_model()
5517
                or self.speculative_config.uses_extract_hidden_states()
5518
            ):
5519
5520
                assert isinstance(
                    self.drafter,
5521
5522
5523
5524
                    EagleProposer
                    | DFlashProposer
                    | DraftModelProposer
                    | ExtractHiddenStatesProposer,
5525
                )
5526
                assert self.speculative_config is not None
5527
5528
5529
                # Eagle currently only supports PIECEWISE cudagraphs.
                # Therefore only use cudagraphs if the main model uses PIECEWISE
                # NOTE(lucas): this is a hack, need to clean up.
5530
                use_cudagraphs = (
5531
5532
5533
5534
5535
5536
5537
5538
5539
                    (
                        is_graph_capturing
                        and cudagraph_runtime_mode == CUDAGraphMode.PIECEWISE
                    )
                    or (
                        not is_graph_capturing
                        and cudagraph_runtime_mode != CUDAGraphMode.NONE
                    )
                ) and not self.speculative_config.enforce_eager
5540
5541
5542
5543
5544

                # Note(gnovack) - We need to disable cudagraphs for one of the two
                # lora cases when cudagraph_specialize_lora is enabled. This is a
                # short term mitigation for issue mentioned in
                # https://github.com/vllm-project/vllm/issues/28334
5545
5546
5547
5548
                if (
                    self.compilation_config.cudagraph_specialize_lora
                    and num_active_loras > 0
                ):
5549
5550
5551
5552
5553
                    use_cudagraphs = False

                self.drafter.dummy_run(
                    num_tokens,
                    use_cudagraphs=use_cudagraphs,
Rémi Delacourt's avatar
Rémi Delacourt committed
5554
                    is_graph_capturing=is_graph_capturing,
5555
                    slot_mappings=slot_mappings,
5556
                )
5557

5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
        # We register layerwise NVTX hooks here after the first dynamo tracing is
        # done to avoid nvtx operations in hook functions being traced by
        # torch dynamo and causing graph breaks.
        # Note that for DYNAMO_ONCE and VLLM_COMPILE mode,
        # compiled model's dynamo tracing is only done once and the compiled model's
        # __call__ function is replaced by calling the compiled function.
        # So it's safe to register hooks here. Hooks will be registered to
        # both compiled and uncompiled models but they will never
        # be called on the compiled model execution path.
        self._register_layerwise_nvtx_hooks()

5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
        # This is necessary to avoid blocking DP.
        # For dummy runs, we typically skip EPLB since we don't have any real
        # requests to process.
        # However, in DP settings, there may be cases when some DP ranks do
        # not have any requests to process, so they're executing dummy batches.
        # In such cases, we still have to trigger EPLB to make sure
        # ranks execute the rearrangement in synchronization.
        if not skip_eplb:
            self.eplb_step(is_dummy=True, is_profile=is_profile)

5579
        logit_indices = np.cumsum(num_scheduled_tokens) - 1
5580
5581
5582
5583
        logit_indices_device = torch.from_numpy(logit_indices).to(
            self.device, non_blocking=True
        )
        return hidden_states, hidden_states[logit_indices_device]
5584
5585
5586
5587
5588
5589

    @torch.inference_mode()
    def _dummy_sampler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> torch.Tensor:
5590
5591
5592
        # The dummy hidden states may contain special values,
        # like `inf` or `nan`.
        # To avoid breaking the sampler, we use a random tensor here instead.
5593

5594
5595
        mm_config = self.vllm_config.model_config.multimodal_config
        if mm_config and mm_config.mm_encoder_only:
5596
5597
5598
            # MM Encoder only model no need to run sampler.
            return torch.tensor([])

5599
        hidden_states = torch.rand_like(hidden_states)
5600

5601
        logits = self.model.compute_logits(hidden_states)
5602
5603
        num_reqs = logits.size(0)

5604
        dummy_tensors = lambda v: torch.full((num_reqs,), v, device=self.device)
5605
5606
5607
5608
5609
5610
5611
5612
5613

        dummy_metadata = SamplingMetadata(
            temperature=dummy_tensors(0.5),
            all_greedy=False,
            all_random=False,
            top_p=dummy_tensors(0.9),
            top_k=dummy_tensors(logits.size(1) - 1),
            generators={},
            max_num_logprobs=None,
Vedant V Jhaveri's avatar
Vedant V Jhaveri committed
5614
            logprob_token_ids=None,
5615
5616
5617
5618
5619
5620
            no_penalties=True,
            prompt_token_ids=None,
            frequency_penalties=dummy_tensors(0.1),
            presence_penalties=dummy_tensors(0.1),
            repetition_penalties=dummy_tensors(0.1),
            output_token_ids=[[] for _ in range(num_reqs)],
5621
            spec_token_ids=[[] for _ in range(num_reqs)],
5622
5623
            allowed_token_ids_mask=None,
            bad_words_token_ids={},
5624
            logitsprocs=LogitsProcessors(),
5625
        )
5626
        try:
5627
5628
5629
            sampler_output = self.sampler(
                logits=logits, sampling_metadata=dummy_metadata
            )
5630
        except RuntimeError as e:
5631
            if "out of memory" in str(e):
5632
5633
5634
5635
                raise RuntimeError(
                    "CUDA out of memory occurred when warming up sampler with "
                    f"{num_reqs} dummy requests. Please try lowering "
                    "`max_num_seqs` or `gpu_memory_utilization` when "
5636
5637
                    "initializing the engine."
                ) from e
5638
5639
            else:
                raise e
5640
        if self.speculative_config:
5641
5642
            draft_token_ids = [[0] for _ in range(num_reqs)]
            dummy_spec_decode_metadata = SpecDecodeMetadata.make_dummy(
5643
5644
                draft_token_ids, self.device
            )
5645
5646
5647
5648
5649
5650

            num_tokens = sum(len(ids) for ids in draft_token_ids)
            # draft_probs = torch.randn(
            #     num_tokens, logits.shape[-1], device=self.device,
            #     dtype=logits.dtype)
            draft_probs = None
5651
5652
5653
5654
5655
            logits = torch.randn(
                num_tokens + num_reqs,
                logits.shape[-1],
                device=self.device,
                dtype=logits.dtype,
5656
            )
5657
5658
5659
            self.rejection_sampler(
                dummy_spec_decode_metadata,
                draft_probs,
5660
                logits,
5661
5662
                dummy_metadata,
            )
5663
        return sampler_output
5664

5665
    def _dummy_pooler_run_task(
5666
5667
        self,
        hidden_states: torch.Tensor,
5668
5669
        task: PoolingTask,
    ) -> PoolerOutput:
5670
5671
5672
5673
        num_tokens = hidden_states.shape[0]
        max_num_reqs = self.scheduler_config.max_num_seqs
        num_reqs = min(num_tokens, max_num_reqs)
        min_tokens_per_req = num_tokens // num_reqs
5674
5675
5676
5677
        num_scheduled_tokens_np = np.full(num_reqs, min_tokens_per_req)
        num_scheduled_tokens_np[-1] += num_tokens % num_reqs
        assert np.sum(num_scheduled_tokens_np) == num_tokens
        assert len(num_scheduled_tokens_np) == num_reqs
5678
5679
5680

        req_num_tokens = num_tokens // num_reqs

5681
        dummy_prompt_lens = torch.from_numpy(num_scheduled_tokens_np)
5682
5683
5684
        dummy_token_ids = torch.zeros(
            (num_reqs, req_num_tokens), dtype=torch.int32, device=self.device
        )
5685

5686
        model = cast(VllmModelForPooling, self.get_model())
5687
        dummy_pooling_params = PoolingParams(task=task)
5688
        dummy_pooling_params.verify(self.model_config)
5689
        to_update = model.pooler.get_pooling_updates(task)
5690
5691
        to_update.apply(dummy_pooling_params)

5692
        dummy_metadata = PoolingMetadata(
5693
5694
            prompt_lens=dummy_prompt_lens,
            prompt_token_ids=dummy_token_ids,
5695
            prompt_token_ids_cpu=dummy_token_ids.cpu(),
5696
            pooling_params=[dummy_pooling_params] * num_reqs,
5697
            pooling_states=[PoolingStates() for i in range(num_reqs)],
5698
        )
5699

5700
        dummy_metadata.build_pooling_cursor(
5701
            num_scheduled_tokens_np,
5702
5703
            seq_lens_cpu=dummy_prompt_lens,
            device=hidden_states.device,
5704
        )
5705

5706
        try:
5707
5708
5709
            return model.pooler(
                hidden_states=hidden_states, pooling_metadata=dummy_metadata
            )
5710
        except RuntimeError as e:
5711
            if "out of memory" in str(e):
5712
                raise RuntimeError(
5713
5714
5715
                    "CUDA out of memory occurred when warming up pooler "
                    f"({task=}) with {num_reqs} dummy requests. Please try "
                    "lowering `max_num_seqs` or `gpu_memory_utilization` when "
5716
5717
                    "initializing the engine."
                ) from e
5718
5719
            else:
                raise e
5720
5721
5722
5723
5724
5725

    @torch.inference_mode()
    def _dummy_pooler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> PoolerOutput:
5726
5727
        mm_config = self.vllm_config.model_config.multimodal_config
        if mm_config and mm_config.mm_encoder_only:
5728
5729
5730
            # MM Encoder only model not need to run pooler.
            return torch.tensor([])

5731
        # Find the task that has the largest output for subsequent steps
5732
5733
5734
        supported_pooling_tasks = self.get_supported_pooling_tasks()

        if not supported_pooling_tasks:
5735
5736
5737
5738
5739
5740
            raise RuntimeError(
                f"Model {self.model_config.model} does not support "
                "any pooling tasks. See "
                "https://docs.vllm.ai/en/latest/models/pooling_models.html "
                "to learn more."
            )
5741

5742
        output_size = dict[PoolingTask, float]()
5743
        for task in supported_pooling_tasks:
5744
5745
            # Run a full batch with each task to ensure none of them OOMs
            output = self._dummy_pooler_run_task(hidden_states, task)
5746
            output_size[task] = sum(o.nbytes for o in output if o is not None)
5747
5748
5749
5750
            del output  # Allow GC

        max_task = max(output_size.items(), key=lambda x: x[1])[0]
        return self._dummy_pooler_run_task(hidden_states, max_task)
5751

5752
    def profile_run(self) -> None:
5753
        # Profile with multimodal encoder & encoder cache.
5754
        if self.supports_mm_inputs:
5755
5756
            mm_config = self.model_config.multimodal_config
            if mm_config is not None and mm_config.skip_mm_profiling:
5757
                logger.info(
5758
                    "Skipping memory profiling for multimodal encoder and "
5759
5760
                    "encoder cache."
                )
5761
5762
5763
5764
5765
            else:
                mm_budget = self.mm_budget
                assert mm_budget is not None

                if (encoder_budget := mm_budget.get_encoder_budget()) > 0:
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
                    if not mm_budget.mm_max_toks_per_item:
                        # All modality limits are 0 — embedding-only mode.
                        # Budget is non-zero for embedding storage, but
                        # there's no encoder to profile.
                        logger.info(
                            "Skipping encoder profiling for embedding-only "
                            "mode (all modality limits=0 with "
                            "enable_mm_embeds=True).",
                        )
                    else:
                        # NOTE: Currently model is profiled with a single
                        # non-text modality with the max possible input
                        # tokens even when it supports multiple.
                        dummy_modality = mm_budget.get_modality_with_max_tokens()
                        max_mm_items_per_batch = mm_budget.mm_max_items_per_batch[
                            dummy_modality
                        ]
5783

5784
                        logger.info_once(
5785
5786
5787
5788
5789
5790
                            "Encoder cache will be initialized with a "
                            "budget of %s tokens, and profiled with "
                            "%s %s items of the maximum feature size.",
                            encoder_budget,
                            max_mm_items_per_batch,
                            dummy_modality,
5791
                            scope="local",
5792
                        )
5793

5794
5795
5796
5797
5798
                        # Create dummy batch of multimodal inputs.
                        batched_dummy_mm_inputs = self._get_mm_dummy_batch(
                            dummy_modality,
                            max_mm_items_per_batch,
                        )
5799

5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
                        # Run multimodal encoder.
                        dummy_encoder_outputs = self.model.embed_multimodal(
                            **batched_dummy_mm_inputs
                        )

                        sanity_check_mm_encoder_outputs(
                            dummy_encoder_outputs,
                            expected_num_items=max_mm_items_per_batch,
                        )
                        for i, output in enumerate(dummy_encoder_outputs):
                            self.encoder_cache[f"tmp_{i}"] = output
5811

5812
        # Add `is_profile` here to pre-allocate communication buffers
5813
5814
5815
        hidden_states, last_hidden_states = self._dummy_run(
            self.max_num_tokens, is_profile=True
        )
5816
        if get_pp_group().is_last_rank:
5817
5818
5819
5820
            if self.is_pooling_model:
                output = self._dummy_pooler_run(hidden_states)
            else:
                output = self._dummy_sampler_run(last_hidden_states)
5821
        else:
5822
            output = None
5823
        self._sync_device()
5824
        del hidden_states, output
5825
        self.encoder_cache.clear()
5826
        gc.collect()
5827

5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
    def _init_minimal_kv_cache_for_profiling(self) -> None:
        from vllm.v1.core.kv_cache_utils import (
            get_kv_cache_config_from_groups,
            get_kv_cache_groups,
        )

        kv_cache_spec = self.get_kv_cache_spec()
        kv_cache_groups = get_kv_cache_groups(self.vllm_config, kv_cache_spec)
        min_blocks = self.compilation_config.max_cudagraph_capture_size or 1

5838
5839
5840
        # Temporarily change num_gpu_blocks_override to allocate a minimal KV cache
        saved_override = self.cache_config.num_gpu_blocks_override
        self.cache_config.num_gpu_blocks_override = min_blocks
5841
        minimal_config = get_kv_cache_config_from_groups(
5842
            self.vllm_config, kv_cache_groups, available_memory=0
5843
        )
5844
        self.cache_config.num_gpu_blocks_override = saved_override
5845

5846
        self.initialize_kv_cache(minimal_config, is_profiling=True)
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
        self.cache_config.num_gpu_blocks = minimal_config.num_blocks

        logger.debug("Initialized minimal KV cache for CUDA graph profiling")

    @staticmethod
    @contextmanager
    def _freeze_gc():
        gc.collect()
        should_freeze = not envs.VLLM_ENABLE_CUDAGRAPH_GC
        if should_freeze:
            gc.freeze()
        try:
            yield
        finally:
            if should_freeze:
                gc.unfreeze()
                gc.collect()

    def _cleanup_profiling_kv_cache(self) -> None:
        torch.accelerator.synchronize()
        if hasattr(self, "kv_caches") and self.kv_caches:
            for i in range(len(self.kv_caches)):
                self.kv_caches[i] = None  # type: ignore
            self.kv_caches.clear()
        if hasattr(self, "cross_layers_kv_cache"):
            self.cross_layers_kv_cache = None
            self.cross_layers_attn_backend = None
        if hasattr(self, "attn_groups"):
            self.attn_groups.clear()
        if hasattr(self, "kv_cache_config"):
            delattr(self, "kv_cache_config")
        self.cache_config.num_gpu_blocks = None

        for layer in self.compilation_config.static_forward_context.values():
            if hasattr(layer, "kv_cache"):
5882
5883
5884
5885
                kv_cache = layer.kv_cache
                layer.kv_cache = (
                    torch.tensor([]) if isinstance(kv_cache, torch.Tensor) else []
                )
5886
5887
5888
5889
5890
5891
5892
            # Clean up quantized KV cache scale views
            # (int8_per_token_head, fp8_per_token_head)
            if hasattr(layer, "impl"):
                if hasattr(layer.impl, "_k_scale_cache"):
                    layer.impl._k_scale_cache = None
                if hasattr(layer.impl, "_v_scale_cache"):
                    layer.impl._v_scale_cache = None
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979

        gc.collect()
        torch.accelerator.empty_cache()

        logger.debug("Cleaned up profiling KV cache and CUDA graphs")

    @torch.inference_mode()
    def profile_cudagraph_memory(self) -> int:
        with set_current_vllm_config(self.vllm_config):
            self._init_minimal_kv_cache_for_profiling()

        saved_num_cudagraph_captured = compilation_counter.num_cudagraph_captured

        capture_descs = self.cudagraph_dispatcher.get_capture_descs()

        total_graphs = sum(len(descs) for _, descs in capture_descs)
        if total_graphs == 0:
            logger.debug("No CUDA graphs will be captured, skipping profiling")
            self._cleanup_profiling_kv_cache()
            return 0

        logger.info(
            "Profiling CUDA graph memory: %s",
            ", ".join(
                f"{mode.name}={len(descs)} (largest={descs[0].num_tokens})"
                for mode, descs in capture_descs
                if descs
            ),
        )

        # Use a temporary pool for profiling to avoid fragmentation in the main pool.
        profiling_pool = current_platform.graph_pool_handle()
        original_pools: dict[int, Any] = {}
        for instance in list(CUDAGraphWrapper._all_instances):
            original_pools[id(instance)] = instance.graph_pool
            instance.graph_pool = profiling_pool

        set_cudagraph_capturing_enabled(True)
        with self._freeze_gc(), graph_capture(device=self.device):
            shared_memory_estimate = {}
            per_graph_estimate = {}
            torch.accelerator.synchronize()
            torch.accelerator.empty_cache()

            for mode, descs in capture_descs:
                profile_descs = descs[:2]
                mem_samples: list[int] = []

                for i, desc in enumerate(profile_descs):
                    mem_before = torch.cuda.mem_get_info()[0]
                    self._warmup_and_capture(
                        desc,
                        cudagraph_runtime_mode=mode,
                        profile_seq_lens=(
                            min(
                                self.max_model_len,
                                self.max_num_tokens // desc.num_tokens,
                            )
                            if mode == CUDAGraphMode.FULL and i == 0
                            else None
                        ),
                    )
                    torch.accelerator.synchronize()
                    free_after = torch.cuda.mem_get_info()[0]
                    mem_samples.append(mem_before - free_after)

                first_capture = mem_samples[0]
                # Use at least 1 MiB per graph for driver overhead
                per_graph = max(mem_samples[1] if len(mem_samples) > 1 else 0, 1 << 20)

                shared_memory_estimate[mode] = first_capture
                per_graph_estimate[mode] = per_graph * (len(descs) - 1)

                logger.debug(
                    "Estimated %s CUDA graph memory: "
                    "%.2f MiB first-capture + (%d-1) × %.2f MiB per-graph",
                    mode.name,
                    first_capture / (1 << 20),
                    len(descs),
                    per_graph / (1 << 20),
                )

        set_cudagraph_capturing_enabled(False)
        CUDAGraphWrapper.clear_all_graphs()
        for instance in list(CUDAGraphWrapper._all_instances):
            if id(instance) in original_pools:
                instance.graph_pool = original_pools[id(instance)]
5980
5981
5982
        for key_set in self.cudagraph_dispatcher.cudagraph_keys.values():
            key_set.clear()
        self.cudagraph_dispatcher.keys_initialized = False
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
        self.maybe_remove_all_loras(self.lora_config)
        self._cleanup_profiling_kv_cache()
        compilation_counter.num_cudagraph_captured = saved_num_cudagraph_captured

        # FULL and PIECEWISE graphs share the global pool at runtime and are
        # never replayed concurrently, so the pool overlays their memory.
        # Take the max to avoid double-counting the overlap.
        total_estimate = max(shared_memory_estimate.values()) + sum(
            per_graph_estimate.values()
        )
        logger.info(
            "Estimated CUDA graph memory: %.2f GiB total",
            total_estimate / (1 << 30),
        )

        return int(total_estimate)

6000
    @instrument(span_name="Capture model")
6001
    def capture_model(self) -> int:
6002
        if self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE:
6003
            logger.warning(
6004
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
6005
6006
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
6007
            return 0
6008

6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
        # Initialize encoder CUDA graph manager if enabled.
        # Use get_model() to unwrap CUDAGraphWrapper/UBatchWrapper,
        # because @runtime_checkable Protocol isinstance() checks do not
        # work through __getattr__ forwarding.
        if (
            self.compilation_config.cudagraph_mm_encoder
            and self.supports_mm_inputs
            and self.encoder_cudagraph_manager is None
        ):
            from vllm.model_executor.models.interfaces import (
                SupportsEncoderCudaGraph,
                supports_encoder_cudagraph,
            )
6022
            from vllm.v1.worker.encoder_cudagraph import (
6023
6024
                EncoderCudaGraphManager,
            )
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035

            raw_model = self.get_model()
            if supports_encoder_cudagraph(raw_model):
                self.encoder_cudagraph_manager = EncoderCudaGraphManager(
                    vllm_config=self.vllm_config,
                    device=self.device,
                    dtype=self.dtype,
                    model=cast(SupportsEncoderCudaGraph, raw_model),
                )
                logger.info("Initialized EncoderCudaGraphManager for vision encoder")

6036
6037
        compilation_counter.num_gpu_runner_capture_triggers += 1

6038
6039
        start_time = time.perf_counter()

6040
6041
6042
        # Trigger CUDA graph capture for specific shapes.
        # Capture the large shapes first so that the smaller shapes
        # can reuse the memory pool allocated for the large shapes.
6043
        set_cudagraph_capturing_enabled(True)
6044
6045
6046
        with self._freeze_gc(), graph_capture(device=self.device):
            torch.accelerator.synchronize()
            torch.accelerator.empty_cache()
6047
            start_free_gpu_memory = torch.cuda.mem_get_info()[0]
6048

6049
6050
6051
6052
            for (
                runtime_mode,
                batch_descs,
            ) in self.cudagraph_dispatcher.get_capture_descs():
6053
                self._capture_cudagraphs(
6054
6055
                    batch_descriptors=batch_descs,
                    cudagraph_runtime_mode=runtime_mode,
6056
                )
6057
                torch.accelerator.synchronize()
6058

6059
6060
6061
6062
            # Capture encoder CUDA graphs if enabled
            if self.encoder_cudagraph_manager is not None:
                self.encoder_cudagraph_manager.capture()

6063
            torch.accelerator.synchronize()
6064
6065
            end_free_gpu_memory = torch.cuda.mem_get_info()[0]

6066
6067
6068
        # Disable cudagraph capturing globally, so any unexpected cudagraph
        # capturing will be detected and raise an error after here.
        # Note: We don't put it into graph_capture context manager because
6069
        # we may do lazy capturing in future that still allows capturing
6070
6071
        # after here.
        set_cudagraph_capturing_enabled(False)
6072

6073
6074
6075
        torch.accelerator.synchronize()
        torch.accelerator.empty_cache()

6076
6077
6078
6079
        # Lock workspace to prevent resizing during execution.
        # Max workspace sizes should have been captured during warmup/profiling.
        lock_workspace()

6080
6081
6082
6083
        end_time = time.perf_counter()
        elapsed_time = end_time - start_time
        cuda_graph_size = start_free_gpu_memory - end_free_gpu_memory
        # This usually takes 5~20 seconds.
6084
        logger.info_once(
6085
6086
6087
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
6088
            scope="local",
6089
        )
6090
        return cuda_graph_size
6091

6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
    def _warmup_and_capture(
        self,
        desc: BatchDescriptor,
        cudagraph_runtime_mode: CUDAGraphMode,
        profile_seq_lens: int | None = None,
        allow_microbatching: bool = False,
        num_warmups: int | None = None,
    ):
        if num_warmups is None:
            num_warmups = self.compilation_config.cudagraph_num_of_warmups
        force_attention = cudagraph_runtime_mode == CUDAGraphMode.FULL
        for _ in range(num_warmups):
            self._dummy_run(
                desc.num_tokens,
                cudagraph_runtime_mode=CUDAGraphMode.NONE,
                force_attention=force_attention,
                uniform_decode=desc.uniform,
                allow_microbatching=allow_microbatching,
                skip_eplb=True,
                remove_lora=False,
                num_active_loras=desc.num_active_loras,
6113
                profile_seq_lens=profile_seq_lens,
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
            )
        self._dummy_run(
            desc.num_tokens,
            cudagraph_runtime_mode=cudagraph_runtime_mode,
            uniform_decode=desc.uniform,
            allow_microbatching=allow_microbatching,
            skip_eplb=True,
            remove_lora=False,
            num_active_loras=desc.num_active_loras,
            is_graph_capturing=True,
            profile_seq_lens=profile_seq_lens,
        )

6127
6128
    def _capture_cudagraphs(
        self,
6129
        batch_descriptors: list[BatchDescriptor],
6130
6131
6132
6133
        cudagraph_runtime_mode: CUDAGraphMode,
    ):
        assert (
            cudagraph_runtime_mode != CUDAGraphMode.NONE
6134
            and cudagraph_runtime_mode.is_valid_runtime_mode()
6135
        ), f"Invalid cudagraph runtime mode: {cudagraph_runtime_mode}"
6136

6137
6138
6139
6140
6141
        if not batch_descriptors:
            return

        uniform_decode = batch_descriptors[0].uniform

6142
6143
        # Only rank 0 should print progress bar during capture
        if is_global_first_rank():
6144
6145
            batch_descriptors = tqdm(
                batch_descriptors,
6146
6147
6148
                disable=not self.load_config.use_tqdm_on_load,
                desc="Capturing CUDA graphs ({}, {})".format(
                    "decode" if uniform_decode else "mixed prefill-decode",
6149
6150
6151
                    cudagraph_runtime_mode.name,
                ),
            )
6152

6153
        # We skip EPLB here since we don't want to record dummy metrics
6154
        for batch_desc in batch_descriptors:
6155
            # We currently only capture ubatched graphs when its a FULL
6156
6157
6158
            # cudagraph, a uniform decode batch, and the number of tokens
            # is above the threshold. Otherwise we just capture a non-ubatched
            # version of the graph
6159
            allow_microbatching = (
6160
                self.parallel_config.use_ubatching
6161
6162
                and cudagraph_runtime_mode == CUDAGraphMode.FULL
                and uniform_decode
6163
6164
                and check_ubatch_thresholds(
                    config=self.vllm_config.parallel_config,
6165
                    num_tokens=batch_desc.num_tokens,
6166
6167
                    uniform_decode=uniform_decode,
                )
6168
            )
6169
6170
            self._warmup_and_capture(
                batch_desc,
6171
6172
6173
                cudagraph_runtime_mode=cudagraph_runtime_mode,
                allow_microbatching=allow_microbatching,
            )
6174
            torch.accelerator.synchronize()
6175
        self.maybe_remove_all_loras(self.lora_config)
6176

6177
6178
6179
6180
6181
    def initialize_attn_backend(
        self,
        kv_cache_config: KVCacheConfig,
        is_profiling: bool = False,
    ) -> None:
6182
6183
6184
        """
        Initialize the attention backends and attention metadata builders.
        """
6185
        assert len(self.attn_groups) == 0, "Attention backends are already initialized"
6186

6187
6188
6189
6190
6191
6192
        class AttentionGroupKey(NamedTuple):
            attn_backend: type[AttentionBackend]
            kv_cache_spec: KVCacheSpec

        def get_attn_backends_for_group(
            kv_cache_group_spec: KVCacheGroupSpec,
6193
        ) -> tuple[dict[AttentionGroupKey, list[str]], set[type[AttentionBackend]]]:
6194
            layer_type = cast(type[Any], AttentionLayerBase)
6195
            layers = get_layers_from_vllm_config(
6196
                self.vllm_config, layer_type, kv_cache_group_spec.layer_names
6197
            )
6198
6199
            attn_backends = {}
            attn_backend_layers = defaultdict(list)
6200
            # Dedupe based on full class name; this is a bit safer than
6201
6202
6203
6204
            # using the class itself as the key because when we create dynamic
            # attention backend subclasses (e.g. ChunkedLocalAttention) unless
            # they are cached correctly, there will be different objects per
            # layer.
6205
            for layer_name in kv_cache_group_spec.layer_names:
6206
                attn_backend = layers[layer_name].get_attn_backend()
6207
6208
6209
6210

                if layer_name in self.kv_sharing_fast_prefill_eligible_layers:
                    attn_backend = create_fast_prefill_custom_backend(
                        "FastPrefill",
6211
                        attn_backend,  # type: ignore[arg-type]
6212
6213
                    )

6214
6215
6216
                full_cls_name = attn_backend.full_cls_name()
                layer_kv_cache_spec = kv_cache_group_spec.kv_cache_spec
                if isinstance(layer_kv_cache_spec, UniformTypeKVCacheSpecs):
6217
                    layer_kv_cache_spec = layer_kv_cache_spec.kv_cache_specs[layer_name]
6218
                key = (full_cls_name, layer_kv_cache_spec)
6219
6220
6221
                attn_backends[key] = AttentionGroupKey(
                    attn_backend, layer_kv_cache_spec
                )
6222
                attn_backend_layers[key].append(layer_name)
6223
6224
6225
6226
            return (
                {attn_backends[k]: v for k, v in attn_backend_layers.items()},
                set(group_key.attn_backend for group_key in attn_backends.values()),
            )
6227
6228

        def create_attn_groups(
6229
            attn_backends_map: dict[AttentionGroupKey, list[str]],
6230
            kv_cache_group_id: int,
6231
6232
        ) -> list[AttentionGroup]:
            attn_groups: list[AttentionGroup] = []
6233
            for (attn_backend, kv_cache_spec), layer_names in attn_backends_map.items():
6234
                attn_group = AttentionGroup(
6235
                    attn_backend,
6236
                    layer_names,
6237
                    kv_cache_spec,
6238
                    kv_cache_group_id,
6239
6240
                )

6241
6242
6243
                attn_groups.append(attn_group)
            return attn_groups

6244
        attention_backend_maps = []
6245
        attention_backend_list = []
6246
        for kv_cache_group_spec in kv_cache_config.kv_cache_groups:
6247
            attn_backends = get_attn_backends_for_group(kv_cache_group_spec)
6248
            attention_backend_maps.append(attn_backends[0])
6249
            attention_backend_list.append(attn_backends[1])
6250
6251

        # Resolve cudagraph_mode before actually initialize metadata_builders
6252
        self._check_and_update_cudagraph_mode(
6253
6254
6255
            attention_backend_list,
            kv_cache_config.kv_cache_groups,
            is_profiling=is_profiling,
6256
        )
6257

6258
6259
6260
        # Check if attention backend supports PCP&DCP and related features.
        check_attention_cp_compatibility(self.vllm_config)

6261
6262
        for i, attn_backend_map in enumerate(attention_backend_maps):
            self.attn_groups.append(create_attn_groups(attn_backend_map, i))
6263

6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
    def initialize_metadata_builders(
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
    ) -> None:
        """
        Create the metadata builders for all KV cache groups and attn groups.
        """
        for kv_cache_group_id in range(len(kv_cache_config.kv_cache_groups)):
            for attn_group in self.attn_groups[kv_cache_group_id]:
                attn_group.create_metadata_builders(
                    self.vllm_config,
                    self.device,
                    kernel_block_sizes[kv_cache_group_id]
                    if kv_cache_group_id < len(kernel_block_sizes)
                    else None,
                    num_metadata_builders=1
6279
6280
                    if not self.parallel_config.use_ubatching
                    else self.parallel_config.num_ubatches,
6281
                )
co63oc's avatar
co63oc committed
6282
        # Calculate reorder batch threshold (if needed)
6283
6284
        # Note (tdoublep): do this *after* constructing builders,
        # because some of them change the threshold at init time.
6285
6286
        self.calculate_reorder_batch_threshold()

6287
6288
6289
6290
6291
        # Initialize drafter attention backend
        if self.speculative_config and (
            self.speculative_config.use_eagle()
            or self.speculative_config.uses_draft_model()
        ):
6292
6293
6294
            assert isinstance(
                self.drafter, EagleProposer | DFlashProposer | DraftModelProposer
            )
6295
6296
            self.drafter.initialize_attn_backend(kv_cache_config, kernel_block_sizes)

6297
    def _check_and_update_cudagraph_mode(
6298
6299
6300
        self,
        attention_backends: list[set[type[AttentionBackend]]],
        kv_cache_groups: list[KVCacheGroupSpec],
6301
        is_profiling: bool = False,
6302
    ) -> None:
6303
        """
6304
        Resolve the cudagraph_mode when there are multiple attention
6305
        groups with potential conflicting CUDA graph support.
6306
6307
6308
        Then initialize the cudagraph_dispatcher based on the resolved
        cudagraph_mode.
        """
6309
        min_cg_support = AttentionCGSupport.ALWAYS
6310
        min_cg_attn_backend = None
6311

6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
        for attn_backend_set, kv_cache_group in zip(
            attention_backends, kv_cache_groups
        ):
            for attn_backend in attn_backend_set:
                builder_cls = attn_backend.get_builder_cls()

                cg_support = builder_cls.get_cudagraph_support(
                    self.vllm_config, kv_cache_group.kv_cache_spec
                )
                if cg_support.value < min_cg_support.value:
                    min_cg_support = cg_support
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
                    min_cg_attn_backend = attn_backend.__name__
        cudagraph_mode = self.compilation_config.resolve_cudagraph_mode_and_sizes(
            min_cg_support,
            min_cg_attn_backend,
            self.uniform_decode_query_len,
            self.parallel_config.tensor_parallel_size,
            self.kv_cache_config,
            self.max_num_reqs,
            is_profiling=is_profiling,
        )
6333
6334
        # Trigger cudagraph dispatching keys initialization after
        # resolved cudagraph mode.
6335
        self.cudagraph_dispatcher.initialize_cudagraph_keys(
6336
            cudagraph_mode, self.uniform_decode_query_len
6337
        )
6338

6339
6340
6341
6342
6343
        # Initialize drafter's cudagraph dispatcher if using spec decode.
        if self.speculative_config and (
            self.speculative_config.use_eagle()
            or self.speculative_config.uses_extract_hidden_states()
        ):
6344
6345
6346
6347
            assert isinstance(
                self.drafter,
                EagleProposer | DFlashProposer | ExtractHiddenStatesProposer,
            )
6348
6349
            self.drafter.initialize_cudagraph_keys(cudagraph_mode)

6350
6351
    def calculate_reorder_batch_threshold(self) -> None:
        """
6352
6353
6354
6355
        Choose the minimum reorder batch threshold from all attention groups.
        Backends should be able to support lower threshold then what they request
        just may have a performance penalty due to that backend treating decodes
        as prefills.
6356
        """
6357
6358
        min_none_high = lambda a, b: a if b is None else b if a is None else min(a, b)

6359
        reorder_batch_thresholds: list[int | None] = [
6360
6361
6362
            group.get_metadata_builder().reorder_batch_threshold
            for group in self._attn_group_iterator()
        ]
6363
6364
6365
6366
6367
        # If there are no attention groups (attention-free model) or no backend
        # reports a threshold, leave reordering disabled.
        if len(reorder_batch_thresholds) == 0:
            self.reorder_batch_threshold = None
            return
6368
        self.reorder_batch_threshold = reduce(min_none_high, reorder_batch_thresholds)  # type: ignore[assignment]
6369

6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
    def _set_mm_prefix_range_for_metadata(
        self,
        attn_metadata: Any,
        req_doc_ranges: dict[int, list[tuple[int, int]]],
    ) -> None:
        """Set mm_prefix_range for all attention metadata objects.

        This method handles both list and non-list attention metadata,
        computing mm_prefix_range_tensor once and sharing it across all
        metadata objects to avoid redundant host-to-device transfers.
        """
        from vllm.v1.attention.backends.triton_attn import (
            TritonAttentionMetadata,
        )

        # Get all metadata objects from either list or dict structure
        metadata_list = []
        if isinstance(attn_metadata, list):
            for ub_metadata in attn_metadata:
                metadata_list.extend(ub_metadata.values())
        else:
            metadata_list.extend(attn_metadata.values())

        # Set mm_prefix_range for all metadata and compute tensor once
        shared_tensor = None
        for metadata in metadata_list:
            metadata.mm_prefix_range = req_doc_ranges  # type: ignore[attr-defined]

            # Only compute tensor for TritonAttentionMetadata
            if isinstance(metadata, TritonAttentionMetadata):
                if shared_tensor is None:
                    shared_tensor = (
                        TritonAttentionMetadata.compute_mm_prefix_range_tensor(
                            req_doc_ranges,
                            metadata.seq_lens.shape[0],  # type: ignore[attr-defined]
                            metadata.seq_lens.device,  # type: ignore[attr-defined]
                        )
                    )
                metadata.mm_prefix_range_tensor = shared_tensor

6410
6411
6412
    def may_reinitialize_input_batch(
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
    ) -> None:
6413
6414
        """
        Re-initialize the input batch if the block sizes are different from
6415
6416
6417
6418
        what it was originally created with. This happens when the final
        block size (determined after model loading) differs from the
        placeholder used during __init__, or when there are multiple
        KV cache groups.
6419
6420
6421

        Args:
            kv_cache_config: The KV cache configuration.
6422
            kernel_block_sizes: The kernel block sizes for each KV cache group.
6423
        """
6424
        block_sizes = []
6425
6426
        max_num_blocks = []
        max_model_len = max(self.max_model_len, self.max_encoder_len)
6427
        for kv_cache_group in kv_cache_config.kv_cache_groups:
6428
6429
            if isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec):
                continue
6430
6431
            block_size = kv_cache_group.kv_cache_spec.block_size
            block_sizes.append(block_size)
6432
            max_num_blocks_per_req = cdiv(
6433
                max_model_len, block_size * get_total_cp_world_size()
6434
6435
            )
            if isinstance(kv_cache_group.kv_cache_spec, MambaSpec):
6436
                max_num_blocks_per_req = (
6437
6438
6439
6440
6441
                    max_num_blocks_per_req
                    if self.cache_config.enable_prefix_caching
                    else 1
                ) + kv_cache_group.kv_cache_spec.num_speculative_blocks
            max_num_blocks.append(max_num_blocks_per_req)
6442

6443
6444
6445
6446
6447
6448
        if (
            block_sizes != self._init_block_sizes
            or kernel_block_sizes != self._init_kernel_block_sizes
        ):
            self._init_block_sizes = block_sizes
            self._init_kernel_block_sizes = kernel_block_sizes
6449
6450
            self.input_batch = InputBatch(
                max_num_reqs=self.max_num_reqs,
6451
                max_model_len=max_model_len,
6452
6453
6454
6455
6456
                max_num_batched_tokens=self.max_num_tokens,
                device=self.device,
                pin_memory=self.pin_memory,
                vocab_size=self.model_config.get_vocab_size(),
                block_sizes=block_sizes,
6457
                kernel_block_sizes=kernel_block_sizes,
6458
                max_num_blocks_per_req=max_num_blocks,
6459
                is_spec_decode=bool(self.vllm_config.speculative_config),
6460
                logitsprocs=self.input_batch.logitsprocs,
6461
                logitsprocs_need_output_token_ids=self.input_batch.logitsprocs_need_output_token_ids,
6462
                is_pooling_model=self.is_pooling_model,
6463
6464
            )

6465
6466
6467
6468
6469
6470
6471
6472
6473
        assert self._init_block_sizes == block_sizes, (
            f"InputBatch block_sizes {self._init_block_sizes} != "
            f"kv_cache block_sizes {block_sizes}"
        )
        assert self._init_kernel_block_sizes == kernel_block_sizes, (
            f"InputBatch kernel_block_sizes {self._init_kernel_block_sizes} "
            f"!= kv_cache kernel_block_sizes {kernel_block_sizes}"
        )

6474
    def _allocate_kv_cache_tensors(
6475
6476
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
6477
        """
6478
6479
6480
        Initializes the KV cache buffer with the correct size. The buffer needs
        to be reshaped to the desired shape before being used by the models.

6481
        Args:
6482
            kv_cache_config: The KV cache config
6483
        Returns:
6484
            dict[str, torch.Tensor]: A map between layer names to their
6485
            corresponding memory buffer for KV cache.
6486
        """
6487
6488
        kv_cache_raw_tensors: dict[str, torch.Tensor] = {}
        for kv_cache_tensor in kv_cache_config.kv_cache_tensors:
6489
6490
6491
            tensor = torch.zeros(
                kv_cache_tensor.size, dtype=torch.int8, device=self.device
            )
6492
6493
6494
6495
6496
            for layer_name in kv_cache_tensor.shared_by:
                kv_cache_raw_tensors[layer_name] = tensor

        layer_names = set()
        for group in kv_cache_config.kv_cache_groups:
6497
6498
6499
6500
            for layer_name in group.layer_names:
                if layer_name in self.runner_only_attn_layers:
                    continue
                layer_names.add(layer_name)
6501
6502
6503
        assert layer_names == set(kv_cache_raw_tensors.keys()), (
            "Some layers are not correctly initialized"
        )
6504
6505
        return kv_cache_raw_tensors

6506
6507
6508
    def _attn_group_iterator(self) -> Iterator[AttentionGroup]:
        return itertools.chain.from_iterable(self.attn_groups)

6509
    def _kv_cache_spec_attn_group_iterator(self) -> Iterator[AttentionGroup]:
6510
6511
        if not self.kv_cache_config.kv_cache_groups:
            return
6512
6513
        for attn_groups in self.attn_groups:
            yield from attn_groups
6514

6515
6516
6517
6518
    def _reshape_kv_cache_tensors(
        self,
        kv_cache_config: KVCacheConfig,
        kv_cache_raw_tensors: dict[str, torch.Tensor],
6519
        kernel_block_sizes: list[int],
6520
    ) -> dict[str, torch.Tensor]:
6521
        """
6522
        Reshape the KV cache tensors to the desired shape and dtype.
6523

6524
        Args:
6525
6526
            kv_cache_config: The KV cache config
            kv_cache_raw_tensors: The KV cache buffer of each layer, with
6527
                correct size but uninitialized shape.
6528
            kernel_block_sizes: The kernel block sizes for each KV cache group.
6529
        Returns:
6530
            Dict[str, torch.Tensor]: A map between layer names to their
6531
6532
            corresponding memory buffer for KV cache.
        """
6533
        kv_caches: dict[str, torch.Tensor] = {}
6534
        has_attn, has_mamba = False, False
6535
6536
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
6537
            attn_backend = group.backend
6538
6539
6540
6541
            if group.kv_cache_group_id == len(kernel_block_sizes):
                # There may be a last group for layers without kv cache.
                continue
            kernel_block_size = kernel_block_sizes[group.kv_cache_group_id]
6542
            for layer_name in group.layer_names:
6543
6544
                if layer_name in self.runner_only_attn_layers:
                    continue
6545
6546
                raw_tensor = kv_cache_raw_tensors[layer_name]
                assert raw_tensor.numel() % kv_cache_spec.page_size_bytes == 0
6547
                num_blocks = raw_tensor.numel() // kv_cache_spec.page_size_bytes
6548
                if isinstance(kv_cache_spec, AttentionSpec):
6549
                    has_attn = True
6550
6551
                    num_blocks_per_kv_block = (
                        kv_cache_spec.block_size // kernel_block_size
6552
6553
6554
                    )
                    kernel_num_blocks = num_blocks * num_blocks_per_kv_block

6555
                    kv_cache_shape = attn_backend.get_kv_cache_shape(
6556
                        kernel_num_blocks,
6557
                        kernel_block_size,
6558
6559
                        kv_cache_spec.num_kv_heads,
                        kv_cache_spec.head_size,
6560
6561
                        cache_dtype_str=self.cache_config.cache_dtype,
                    )
6562
                    dtype = kv_cache_spec.dtype
6563
                    try:
6564
                        kv_cache_stride_order = attn_backend.get_kv_cache_stride_order()
6565
                        assert len(kv_cache_stride_order) == len(kv_cache_shape)
6566
                    except (AttributeError, NotImplementedError):
6567
                        kv_cache_stride_order = tuple(range(len(kv_cache_shape)))
6568
6569
6570
6571
6572
                    # The allocation respects the backend-defined stride order
                    # to ensure the semantic remains consistent for each
                    # backend. We first obtain the generic kv cache shape and
                    # then permute it according to the stride order which could
                    # result in a non-contiguous tensor.
6573
6574
6575
                    kv_cache_shape = tuple(
                        kv_cache_shape[i] for i in kv_cache_stride_order
                    )
6576
6577
6578
6579
6580
                    # Maintain original KV shape view.
                    inv_order = [
                        kv_cache_stride_order.index(i)
                        for i in range(len(kv_cache_stride_order))
                    ]
6581
6582
6583
6584
6585
6586
                    kv_caches[layer_name] = (
                        kv_cache_raw_tensors[layer_name]
                        .view(dtype)
                        .view(kv_cache_shape)
                        .permute(*inv_order)
                    )
Chen Zhang's avatar
Chen Zhang committed
6587
                elif isinstance(kv_cache_spec, MambaSpec):
6588
                    has_mamba = True
Chen Zhang's avatar
Chen Zhang committed
6589
6590
                    raw_tensor = kv_cache_raw_tensors[layer_name]
                    state_tensors = []
6591
                    storage_offset_bytes = 0
6592
                    for shape, dtype in zip(kv_cache_spec.shapes, kv_cache_spec.dtypes):
6593
6594
                        dtype_size = get_dtype_size(dtype)
                        num_element_per_page = (
6595
6596
                            kv_cache_spec.page_size_bytes // dtype_size
                        )
Chen Zhang's avatar
Chen Zhang committed
6597
                        target_shape = (num_blocks, *shape)
6598
6599
                        stride = torch.empty(target_shape).stride()
                        target_stride = (num_element_per_page, *stride[1:])
6600
                        assert storage_offset_bytes % dtype_size == 0
6601
6602
6603
6604
                        tensor = torch.as_strided(
                            raw_tensor.view(dtype),
                            size=target_shape,
                            stride=target_stride,
6605
                            storage_offset=storage_offset_bytes // dtype_size,
6606
                        )
Chen Zhang's avatar
Chen Zhang committed
6607
                        state_tensors.append(tensor)
6608
                        storage_offset_bytes += stride[0] * dtype_size
6609
6610

                    kv_caches[layer_name] = state_tensors
6611
                else:
6612
                    raise NotImplementedError
6613
6614

        if has_attn and has_mamba:
6615
            self._update_hybrid_attention_mamba_layout(kv_caches, kernel_block_sizes)
6616

6617
6618
        return kv_caches

6619
    def _update_hybrid_attention_mamba_layout(
6620
        self, kv_caches: dict[str, torch.Tensor], kernel_block_sizes: list[int]
6621
    ) -> None:
6622
        """
6623
6624
        Update the layout of attention layers from (2, num_blocks, ...) to
        (num_blocks, 2, ...).
6625
6626

        Args:
6627
            kv_caches: The KV cache buffer of each layer.
6628
            kernel_block_sizes: The kernel block sizes for each KV cache group.
6629
6630
        """

6631
6632
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
            if not isinstance(kv_cache_spec, AttentionSpec):
                continue
            block_dim = group.backend.get_kv_cache_block_dim(
                kernel_block_sizes[group.kv_cache_group_id],
                kv_cache_spec.num_kv_heads,
                kv_cache_spec.head_size,
                cache_dtype_str=self.cache_config.cache_dtype,
            )
            # block_dim: 0 means (num_blocks, 2, ...); 1 means (2, num_blocks, ...).
            if block_dim == 0:
                continue
            assert block_dim == 1
6645
            for layer_name in group.layer_names:
6646
                kv_cache = kv_caches[layer_name]
6647
6648
6649
6650
6651
                hidden_size = kv_cache.shape[2:].numel()
                kv_cache.as_strided_(
                    size=kv_cache.shape,
                    stride=(hidden_size, 2 * hidden_size, *kv_cache.stride()[2:]),
                )
6652

6653
    def initialize_kv_cache_tensors(
6654
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
6655
    ) -> dict[str, torch.Tensor]:
6656
6657
6658
6659
6660
        """
        Initialize the memory buffer for KV cache.

        Args:
            kv_cache_config: The KV cache config
6661
6662
            kernel_block_sizes: The kernel block sizes for each KV cache group.

6663
        Returns:
6664
            Dict[str, torch.Tensor]: A map between layer names to their
6665
6666
            corresponding memory buffer for KV cache.
        """
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690

        # Try creating KV caches optimized for kv-connector transfers
        cache_dtype = self.cache_config.cache_dtype
        if self.use_uniform_kv_cache(self.attn_groups, cache_dtype):
            kv_caches, cross_layers_kv_cache, attn_backend = (
                self.allocate_uniform_kv_caches(
                    kv_cache_config,
                    self.attn_groups,
                    cache_dtype,
                    self.device,
                    kernel_block_sizes,
                )
            )
            self.cross_layers_kv_cache = cross_layers_kv_cache
            self.cross_layers_attn_backend = attn_backend
        else:
            # Fallback to the general case
            # Initialize the memory buffer for KV cache
            kv_cache_raw_tensors = self._allocate_kv_cache_tensors(kv_cache_config)

            # Change the memory buffer to the desired shape
            kv_caches = self._reshape_kv_cache_tensors(
                kv_cache_config, kv_cache_raw_tensors, kernel_block_sizes
            )
6691

6692
        # Set up cross-layer KV cache sharing
6693
6694
        for layer_name, target_layer_name in self.shared_kv_cache_layers.items():
            logger.debug("%s reuses KV cache of %s", layer_name, target_layer_name)
6695
6696
            kv_caches[layer_name] = kv_caches[target_layer_name]

6697
6698
6699
6700
6701
6702
6703
6704
6705
        num_attn_module = (
            2 if self.model_config.hf_config.model_type == "longcat_flash" else 1
        )
        bind_kv_cache(
            kv_caches,
            self.compilation_config.static_forward_context,
            self.kv_caches,
            num_attn_module,
        )
6706
6707
6708
        return kv_caches

    def maybe_add_kv_sharing_layers_to_kv_cache_groups(
6709
6710
        self, kv_cache_config: KVCacheConfig
    ) -> None:
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
        """
        Add layers that re-use KV cache to KV cache group of its target layer.
        Mapping of KV cache tensors happens in `initialize_kv_cache_tensors()`
        """
        if not self.shared_kv_cache_layers:
            # No cross-layer KV sharing, return
            return

        add_kv_sharing_layers_to_kv_cache_groups(
            self.shared_kv_cache_layers,
            kv_cache_config.kv_cache_groups,
            self.runner_only_attn_layers,
        )

        if self.cache_config.kv_sharing_fast_prefill:
            # In You Only Cache Once (https://arxiv.org/abs/2405.05254) or other
            # similar KV sharing setups, only the layers that generate KV caches
            # are involved in the prefill phase, enabling prefill to early exit.
6729
            attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
6730
6731
            for layer_name in reversed(attn_layers):
                if layer_name in self.shared_kv_cache_layers:
6732
                    self.kv_sharing_fast_prefill_eligible_layers.add(layer_name)
6733
6734
                else:
                    break
6735

6736
6737
6738
6739
6740
    def initialize_kv_cache(
        self,
        kv_cache_config: KVCacheConfig,
        is_profiling: bool = False,
    ) -> None:
6741
6742
6743
6744
6745
6746
        """
        Initialize KV cache based on `kv_cache_config`.
        Args:
            kv_cache_config: Configuration for the KV cache, including the KV
            cache size of each layer
        """
6747
        kv_cache_config = deepcopy(kv_cache_config)
6748
        self.kv_cache_config = kv_cache_config
6749
        self._mamba_copy_bufs = None
6750
        self.may_add_encoder_only_layers_to_kv_cache_config()
6751
        self.maybe_add_kv_sharing_layers_to_kv_cache_groups(kv_cache_config)
6752
        self.initialize_attn_backend(kv_cache_config, is_profiling=is_profiling)
6753
6754
6755
6756
6757
        # The kernel block size for all KV cache groups. For example, if
        # kv_cache_manager uses block_size 256 for a given group, but the attention
        # backends for that group only supports block_size 64, we will return
        # kernel_block_size 64 and split the 256-token-block to 4 blocks with 64
        # tokens each.
6758
6759
6760
        kernel_block_sizes = prepare_kernel_block_sizes(
            kv_cache_config, self.attn_groups
        )
6761
        self._kernel_block_sizes = kernel_block_sizes
6762
6763
6764
6765

        # create metadata builders
        self.initialize_metadata_builders(kv_cache_config, kernel_block_sizes)

6766
        # Reinitialize need to after initialize_attn_backend
6767
6768
6769
6770
        self.may_reinitialize_input_batch(kv_cache_config, kernel_block_sizes)
        kv_caches = self.initialize_kv_cache_tensors(
            kv_cache_config, kernel_block_sizes
        )
6771

6772
6773
6774
        if (
            self.speculative_config
            and self.speculative_config.uses_extract_hidden_states()
6775
        ):
6776
            assert isinstance(self.drafter, ExtractHiddenStatesProposer)
6777
6778
6779
6780
            # validate all draft model layers belong to the same kv cache
            # group
            self.drafter.validate_same_kv_cache_group(kv_cache_config)

6781
        if has_kv_transfer_group() and not is_profiling:
6782
            kv_transfer_group = get_kv_transfer_group()
6783
6784
6785
6786
6787
6788
6789
            if self.cross_layers_kv_cache is not None:
                assert self.cross_layers_attn_backend is not None
                kv_transfer_group.register_cross_layers_kv_cache(
                    self.cross_layers_kv_cache, self.cross_layers_attn_backend
                )
            else:
                kv_transfer_group.register_kv_caches(kv_caches)
6790
            kv_transfer_group.set_host_xfer_buffer_ops(copy_kv_blocks)
Robert Shaw's avatar
Robert Shaw committed
6791

6792
6793
6794
6795
6796
6797
    def _get_attention_kv_cache_gid(self) -> int:
        """Find the KV cache group index for attention layers."""
        for gid, group in enumerate(self.kv_cache_config.kv_cache_groups):
            if isinstance(group.kv_cache_spec, AttentionSpec):
                return gid
        return 0
6798
6799
6800
6801
6802
6803
6804

    def init_routed_experts_capturer(self):
        logger.info(
            "Initializing routed experts capturer, enable_return_routed_experts: %s",
            self.model_config.enable_return_routed_experts,
        )
        routed_experts_capturer = RoutedExpertsCapturer.create()
6805
6806
6807
6808
6809
6810
6811
6812
        self.routed_experts_attn_gid = self._get_attention_kv_cache_gid()
        min_block_size = min(
            [
                group.kv_cache_spec.block_size
                for group in self.kv_cache_config.kv_cache_groups
            ]
        )
        num_groups = len(self.kv_cache_config.kv_cache_groups)
6813
        self.max_num_kv_tokens = (
6814
6815
6816
6817
6818
6819
6820
            self.kv_cache_config.num_blocks // num_groups
        ) * min_block_size
        dcp_size = self.vllm_config.parallel_config.decode_context_parallel_size
        pcp_size = self.vllm_config.parallel_config.prefill_context_parallel_size
        if pcp_size * dcp_size > 1:
            self.max_num_kv_tokens *= pcp_size * dcp_size

6821
6822
6823
        routed_experts_capturer.init_buffer(
            max_num_batched_tokens=self.scheduler_config.max_num_batched_tokens,
            max_num_kv_tokens=self.max_num_kv_tokens,
6824
            vllm_config=self.vllm_config,
6825
        )
6826
        self._bind_routed_experts_capturer(routed_experts_capturer)
6827
        self.routed_experts_initialized = True
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842

    def _bind_routed_experts_capturer(self, capturer: RoutedExpertsCapturer) -> None:
        from vllm.model_executor.layers.fused_moe.layer import FusedMoE
        from vllm.model_executor.layers.fused_moe.router.base_router import (
            BaseRouter,
        )

        for module in self.compilation_config.static_forward_context.values():
            if isinstance(module, FusedMoE) and isinstance(module.router, BaseRouter):
                layer_id = module.layer_id

                def _capture_fn(topk_ids, _layer_id=layer_id, _capturer=capturer):
                    _capturer.capture(_layer_id, topk_ids)

                module.router.set_capture_fn(_capture_fn)
6843

6844
6845
6846
6847
6848
    def may_add_encoder_only_layers_to_kv_cache_config(self) -> None:
        """
        Add encoder-only layers to the KV cache config.
        """
        block_size = self.vllm_config.cache_config.block_size
6849
        encoder_only_attn_specs: dict[AttentionSpec, list[str]] = defaultdict(list)
6850
6851
6852
        attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
        for layer_name, attn_module in attn_layers.items():
            if attn_module.attn_type == AttentionType.ENCODER_ONLY:
6853
                attn_spec: AttentionSpec = EncoderOnlyAttentionSpec(
6854
6855
6856
                    block_size=block_size,
                    num_kv_heads=attn_module.num_kv_heads,
                    head_size=attn_module.head_size,
6857
6858
                    dtype=self.kv_cache_dtype,
                )
6859
6860
6861
                encoder_only_attn_specs[attn_spec].append(layer_name)
                self.runner_only_attn_layers.add(layer_name)
        if len(encoder_only_attn_specs) > 0:
6862
6863
6864
            assert len(encoder_only_attn_specs) == 1, (
                "Only support one encoder-only attention spec now"
            )
6865
6866
            spec, layer_names = encoder_only_attn_specs.popitem()
            self.kv_cache_config.kv_cache_groups.append(
6867
6868
                KVCacheGroupSpec(layer_names=layer_names, kv_cache_spec=spec)
            )
6869

6870
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
6871
        """
6872
        Generates the KVCacheSpec by parsing the kv cache format from each
6873
6874
        Attention module in the static forward context.
        Returns:
6875
            KVCacheSpec: A dictionary mapping layer names to their KV cache
6876
6877
            format. Layers that do not need KV cache are not included.
        """
6878
        if has_ec_transfer() and not get_ec_transfer().is_consumer:
6879
            return {}
6880
        kv_cache_spec: dict[str, KVCacheSpec] = {}
6881
6882
        layer_type = cast(type[Any], AttentionLayerBase)
        attn_layers = get_layers_from_vllm_config(self.vllm_config, layer_type)
Chen Zhang's avatar
Chen Zhang committed
6883
        for layer_name, attn_module in attn_layers.items():
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
            if isinstance(attn_module, Attention) and (
                kv_tgt_layer := attn_module.kv_sharing_target_layer_name
            ):
                # The layer doesn't need its own KV cache and will use that of
                # the target layer. We skip creating a KVCacheSpec for it, so
                # that KV cache management logic will act as this layer does
                # not exist, and doesn't allocate KV cache for the layer. This
                # enables the memory saving of cross-layer kv sharing, allowing
                # a given amount of memory to accommodate longer context lengths
                # or enable more requests to be processed simultaneously.
                self.shared_kv_cache_layers[layer_name] = kv_tgt_layer
                continue
            # Skip modules that don't need KV cache (eg encoder-only attention)
            if spec := attn_module.get_kv_cache_spec(self.vllm_config):
                kv_cache_spec[layer_name] = spec
6899

6900
        return kv_cache_spec
6901

6902
    def _to_list(self, sampled_token_ids: torch.Tensor) -> list[list[int]]:
6903
6904
6905
6906
6907
6908
6909
6910
        # This is a short term mitigation for issue mentioned in
        # https://github.com/vllm-project/vllm/issues/22754.
        # `tolist` would trigger a cuda wise stream sync, which
        # would block other copy ops from other cuda streams.
        # A cuda event sync would avoid such a situation. Since
        # this is in the critical path of every single model
        # forward loop, this has caused perf issue for a disagg
        # setup.
6911
        pinned = self.sampled_token_ids_pinned_cpu[: sampled_token_ids.shape[0]]
6912
6913
6914
        pinned.copy_(sampled_token_ids, non_blocking=True)
        self.transfer_event.record()
        self.transfer_event.synchronize()
6915
        return pinned.tolist()
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955

    def get_encoder_timing_stats(self) -> dict[str, dict[str, float | int]]:
        """
        Get encoder timing stats for all requests and clear the registry.

        Returns:
            Dictionary mapping request_id to stats dict.
        """
        with self._encoder_timing_lock:
            stats = {
                req_id: stats_obj.to_dict()
                for req_id, stats_obj in self.encoder_timing_registry.items()
            }
            self.encoder_timing_registry.clear()
            return stats

    @contextmanager
    def timed_encoder_operation(
        self,
        should_time: bool,
        group_lora_refs: list[tuple[str, Any]],
        current_item_idx: int,
        num_items: int,
    ):
        """
        Context manager to time encoder forward operations.

        Args:
            should_time: Whether timing is enabled
            group_lora_refs: Full list of (request_id, pos_info) tuples
            current_item_idx: Starting index for this group
            num_items: Number of items in this group
        """
        if not should_time:
            yield
            return

        group_refs = group_lora_refs[current_item_idx : current_item_idx + num_items]
        group_request_ids = {req_id for req_id, _ in group_refs}

6956
        torch.accelerator.synchronize()
6957
6958
6959
6960
6961
        start_time = time.perf_counter()

        try:
            yield
        finally:
6962
            torch.accelerator.synchronize()
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
            elapsed = time.perf_counter() - start_time

            per_request_time = elapsed / max(len(group_request_ids), 1)

            with self._encoder_timing_lock:
                for req_id in group_request_ids:
                    if req_id not in self.encoder_timing_registry:
                        self.encoder_timing_registry[req_id] = EncoderTimingStats()

                    stats = self.encoder_timing_registry[req_id]
6973
                    stats.encoder_forward_secs += per_request_time
6974
6975
6976
6977
6978
6979
6980
                    stats.num_encoder_calls += 1


@dataclass
class EncoderTimingStats:
    """Per-request timing statistics for encoder forward pass."""

6981
    encoder_forward_secs: float = 0.0
6982
6983
6984
6985
6986
6987
6988
    """Time spent in vision encoder forward pass (seconds)."""

    num_encoder_calls: int = 0
    """Number of times encoder was called for this request."""

    def to_dict(self) -> dict[str, float | int]:
        return {
6989
            "encoder_forward_secs": self.encoder_forward_secs,
6990
6991
            "num_encoder_calls": self.num_encoder_calls,
        }