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

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

import numpy as np
import torch
import torch.distributed
import torch.nn as nn
19
from tqdm import tqdm
20

21
import vllm.envs as envs
22
23
24
from vllm.attention.backends.abstract import (
    AttentionBackend,
    AttentionMetadata,
25
    AttentionType,
26
27
    MultipleOf,
)
28
from vllm.attention.layer import Attention, MLAAttention
29
from vllm.compilation.counter import compilation_counter
30
from vllm.compilation.cuda_graph import CUDAGraphStat, CUDAGraphWrapper
31
from vllm.compilation.monitor import set_cudagraph_capturing_enabled
32
from vllm.config import (
33
    CompilationMode,
34
35
36
37
38
    CUDAGraphMode,
    VllmConfig,
    get_layers_from_vllm_config,
    update_config,
)
39
from vllm.distributed.ec_transfer import get_ec_transfer, has_ec_transfer
40
from vllm.distributed.eplb.eplb_state import EplbState
41
from vllm.distributed.kv_transfer import get_kv_transfer_group, has_kv_transfer_group
42
from vllm.distributed.kv_transfer.kv_connector.utils import copy_kv_blocks
43
from vllm.distributed.parallel_state import (
44
    get_dcp_group,
45
46
47
48
49
50
    get_pp_group,
    get_tp_group,
    graph_capture,
    is_global_first_rank,
    prepare_communication_buffer_for_model,
)
51
52
53
54
from vllm.forward_context import (
    BatchDescriptor,
    set_forward_context,
)
55
from vllm.logger import init_logger
56
from vllm.model_executor.layers.attention_layer_base import AttentionLayerBase
57
58
59
60
from vllm.model_executor.layers.rotary_embedding import (
    MRotaryEmbedding,
    XDRotaryEmbedding,
)
61
from vllm.model_executor.model_loader import TensorizerLoader, get_model_loader
62
from vllm.model_executor.models.interfaces import (
63
    SupportsMRoPE,
64
    SupportsMultiModal,
65
    SupportsXDRoPE,
66
67
68
69
70
    is_mixture_of_experts,
    supports_eagle3,
    supports_mrope,
    supports_multimodal_pruning,
    supports_transcription,
71
    supports_xdrope,
72
)
73
from vllm.model_executor.models.interfaces_base import (
74
75
76
77
    VllmModelForPooling,
    is_pooling_model,
    is_text_generation_model,
)
78
from vllm.multimodal import MULTIMODAL_REGISTRY
79
80
81
82
83
from vllm.multimodal.inputs import (
    BatchedTensorInputs,
    MultiModalKwargsItem,
    PlaceholderRange,
)
84
from vllm.multimodal.utils import group_mm_kwargs_by_modality
85
from vllm.pooling_params import PoolingParams
86
from vllm.sampling_params import SamplingType
87
from vllm.sequence import IntermediateTensors
88
from vllm.tasks import GenerationTask, PoolingTask, SupportedTask
89
from vllm.utils import length_from_prompt_token_ids_or_embeds
90
from vllm.utils.jsontree import json_map_leaves
91
from vllm.utils.math_utils import cdiv, round_up
92
93
from vllm.utils.mem_constants import GiB_bytes
from vllm.utils.mem_utils import DeviceMemoryProfiler
94
from vllm.utils.nvtx_pytorch_hooks import PytHooks
95
from vllm.utils.platform_utils import is_pin_memory_available
96
97
98
99
100
from vllm.utils.torch_utils import (
    get_dtype_size,
    kv_cache_dtype_str_to_dtype,
    supports_dynamo,
)
101
from vllm.v1.attention.backends.gdn_attn import GDNAttentionMetadataBuilder
102
from vllm.v1.attention.backends.utils import (
103
104
105
    AttentionCGSupport,
    AttentionMetadataBuilder,
    CommonAttentionMetadata,
106
    create_fast_prefill_custom_backend,
107
    get_dcp_local_seq_lens,
108
109
110
    reorder_batch_to_split_decodes_and_prefills,
    split_attn_metadata,
)
111
from vllm.v1.cudagraph_dispatcher import CudagraphDispatcher
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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,
129
    ECConnectorOutput,
130
    KVConnectorOutput,
131
132
133
134
135
    LogprobsLists,
    LogprobsTensors,
    ModelRunnerOutput,
    PoolerOutput,
    SamplerOutput,
136
    make_empty_encoder_model_runner_output,
137
)
138
from vllm.v1.pool.metadata import PoolingMetadata, PoolingStates
139
from vllm.v1.sample.logits_processor import LogitsProcessors, build_logitsprocs
140
from vllm.v1.sample.logits_processor.interface import LogitsProcessor
141
from vllm.v1.sample.metadata import SamplingMetadata
142
from vllm.v1.sample.rejection_sampler import RejectionSampler
143
from vllm.v1.sample.sampler import Sampler
144
from vllm.v1.spec_decode.eagle import EagleProposer
145
from vllm.v1.spec_decode.medusa import MedusaProposer
146
from vllm.v1.spec_decode.metadata import SpecDecodeMetadata
147
from vllm.v1.spec_decode.ngram_proposer import NgramProposer
148
from vllm.v1.spec_decode.suffix_decoding import SuffixDecodingProposer
149
from vllm.v1.structured_output.utils import apply_grammar_bitmask
150
from vllm.v1.utils import CpuGpuBuffer, record_function_or_nullcontext
151
from vllm.v1.worker.cp_utils import check_attention_cp_compatibility
152
from vllm.v1.worker.dp_utils import coordinate_batch_across_dp
153
from vllm.v1.worker.ec_connector_model_runner_mixin import ECConnectorModelRunnerMixin
154
from vllm.v1.worker.gpu_input_batch import CachedRequestState, InputBatch
155
from vllm.v1.worker.gpu_ubatch_wrapper import UBatchWrapper
156
from vllm.v1.worker.kv_connector_model_runner_mixin import KVConnectorModelRunnerMixin
157
from vllm.v1.worker.lora_model_runner_mixin import LoRAModelRunnerMixin
158
159
160
from vllm.v1.worker.ubatch_utils import (
    UBatchSlices,
    check_ubatch_thresholds,
161
    maybe_create_ubatch_slices,
162
)
163
from vllm.v1.worker.utils import is_residual_scattered_for_sp
164

165
166
167
168
169
170
171
172
173
from .utils import (
    AttentionGroup,
    MultiModalBudget,
    add_kv_sharing_layers_to_kv_cache_groups,
    bind_kv_cache,
    gather_mm_placeholders,
    sanity_check_mm_encoder_outputs,
    scatter_mm_placeholders,
)
174

175
if TYPE_CHECKING:
176
    from vllm.model_executor.model_loader.tensorizer import TensorizerConfig
177
    from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
178
179
180

logger = init_logger(__name__)

181
182
AttnMetadataDict: TypeAlias = dict[str, AttentionMetadata]
# list when ubatching is enabled
183
PerLayerAttnMetadata: TypeAlias = list[AttnMetadataDict] | AttnMetadataDict
184

185

186
187
188
189
190
191
# Wrapper for ModelRunnerOutput to support overlapped execution.
class AsyncGPUModelRunnerOutput(AsyncModelRunnerOutput):
    def __init__(
        self,
        model_runner_output: ModelRunnerOutput,
        sampled_token_ids: torch.Tensor,
192
        logprobs_tensors: LogprobsTensors | None,
193
194
        invalid_req_indices: list[int],
        async_output_copy_stream: torch.cuda.Stream,
195
        vocab_size: int,
196
197
198
199
200
    ):
        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.
201
        self.async_copy_ready_event = torch.Event()
202
203
204
205

        # 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
206
        self.vocab_size = vocab_size
207
        self._logprobs_tensors = logprobs_tensors
208
209
210
211
212

        # 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)
213
            self.sampled_token_ids_cpu = self._sampled_token_ids.to(
214
215
                "cpu", non_blocking=True
            )
216
217
218
219
220
            self._logprobs_tensors_cpu = (
                self._logprobs_tensors.to_cpu_nonblocking()
                if self._logprobs_tensors
                else None
            )
221
            self.async_copy_ready_event.record()
222
223
224

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

226
227
        This function blocks until the copy is finished.
        """
228
        max_gen_len = self.sampled_token_ids_cpu.shape[-1]
229
        self.async_copy_ready_event.synchronize()
230

231
232
        # Release the device tensors once the copy has completed.
        del self._logprobs_tensors
233
        del self._sampled_token_ids
234
        if max_gen_len == 1:
235
            valid_sampled_token_ids = self.sampled_token_ids_cpu.tolist()
236
237
238
            for i in self._invalid_req_indices:
                valid_sampled_token_ids[i].clear()
            cu_num_tokens = None
239
        else:
240
            valid_sampled_token_ids, cu_num_tokens = RejectionSampler.parse_output(
241
242
                self.sampled_token_ids_cpu,
                self.vocab_size,
243
244
                self._invalid_req_indices,
                return_cu_num_tokens=self._logprobs_tensors_cpu is not None,
245
            )
246
247
248

        output = self._model_runner_output
        output.sampled_token_ids = valid_sampled_token_ids
249
        if self._logprobs_tensors_cpu:
250
            output.logprobs = self._logprobs_tensors_cpu.tolists(cu_num_tokens)
251
252
253
        return output


254
255
256
257
258
259
260
261
262
263
264
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
265
    ec_connector_output: ECConnectorOutput | None
266
    cudagraph_stats: CUDAGraphStat | None
267
268


269
270
271
class GPUModelRunner(
    LoRAModelRunnerMixin, KVConnectorModelRunnerMixin, ECConnectorModelRunnerMixin
):
272
273
    def __init__(
        self,
274
        vllm_config: VllmConfig,
275
        device: torch.device,
276
    ):
277
278
279
        self.vllm_config = vllm_config
        self.model_config = vllm_config.model_config
        self.cache_config = vllm_config.cache_config
280
        self.compilation_config = vllm_config.compilation_config
281
282
283
284
285
286
        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
287

288
        from vllm.model_executor.models.utils import set_cpu_offload_max_bytes
289
290

        set_cpu_offload_max_bytes(int(self.cache_config.cpu_offload_gb * 1024**3))
291

292
293
294
295
        model_config = self.model_config
        cache_config = self.cache_config
        scheduler_config = self.scheduler_config
        parallel_config = self.parallel_config
296
        self.device = device
297
298
        self.pin_memory = is_pin_memory_available()
        self.dtype = self.model_config.dtype
299
300
301
        self.kv_cache_dtype = kv_cache_dtype_str_to_dtype(
            cache_config.cache_dtype, self.model_config
        )
302

303
        self.is_pooling_model = model_config.runner_type == "pooling"
304
        self.enable_prompt_embeds = model_config.enable_prompt_embeds
305
        self.is_multimodal_raw_input_only_model = (
306
307
            model_config.is_multimodal_raw_input_only_model
        )
308
309
        # This will be overridden in load_model()
        self.is_multimodal_pruning_enabled = False
310
        self.max_model_len = model_config.max_model_len
311
312
313

        # Always set to false after the first forward pass
        self.calculate_kv_scales = self.cache_config.calculate_kv_scales
314
        self.dcp_world_size = self.parallel_config.decode_context_parallel_size
315
        self.dcp_rank = 0 if self.dcp_world_size <= 1 else get_dcp_group().rank_in_group
316
        self.max_num_tokens = scheduler_config.max_num_batched_tokens
317
        self.max_num_reqs = scheduler_config.max_num_seqs
318

319
320
321
322
323
        # Broadcast PP output for external_launcher (torchrun)
        # to make sure we are synced across pp ranks
        # TODO: Support overlapping mirco-batches
        # https://github.com/vllm-project/vllm/issues/18019
        self.broadcast_pp_output = (
324
325
326
            self.parallel_config.distributed_executor_backend == "external_launcher"
            and len(get_pp_group().ranks) > 0
        )
327

328
        # Model-related.
329
        self.num_query_heads = model_config.get_num_attention_heads(parallel_config)
330
        self.inputs_embeds_size = model_config.get_inputs_embeds_size()
331
        self.attention_chunk_size = model_config.attention_chunk_size
332
        # Only relevant for models using ALiBi (e.g, MPT)
333
        self.use_alibi = model_config.uses_alibi
334

335
        self.cascade_attn_enabled = not self.model_config.disable_cascade_attn
336
        self.is_mm_prefix_lm = self.model_config.is_mm_prefix_lm
337

338
        # Multi-modal data support
339
        self.mm_registry = MULTIMODAL_REGISTRY
340
        self.uses_mrope = model_config.uses_mrope
341
        self.uses_xdrope_dim = model_config.uses_xdrope_dim
342
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
343
            model_config
344
        )
345

346
347
348
        if self.model_config.is_encoder_decoder:
            # Maximum length of the encoder input, only for encoder-decoder
            # models.
349
            self.max_encoder_len = scheduler_config.max_num_encoder_input_tokens
350
351
352
        else:
            self.max_encoder_len = 0

353
        # Sampler
354
        self.sampler = Sampler(logprobs_mode=self.model_config.logprobs_mode)
355

356
        self.eplb_state: EplbState | None = None
357
358
359
360
361
362
        """
        State of the expert parallelism load balancer.

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

363
        # Lazy initializations
364
        # self.model: nn.Module  # Set after load_model
365
        # Initialize in initialize_kv_cache
366
        self.kv_caches: list[torch.Tensor] = []
367
368
369
        # Initialize in initialize_kv_cache_tensors
        self.cross_layers_kv_cache: torch.Tensor | None = None
        self.cross_layers_attn_backend: type[AttentionBackend] | None = None
370
371
        # indexes: [kv_cache_group_id][attn_group]
        self.attn_groups: list[list[AttentionGroup]] = []
372
373
        # self.kv_cache_config: KVCacheConfig

374
375
        # mm_hash ->  encoder_output
        self.encoder_cache: dict[str, torch.Tensor] = {}
376

377
        self.use_aux_hidden_state_outputs = False
378
379
380
381
382
        # 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:
383
384
385
            self.drafter: (
                NgramProposer | SuffixDecodingProposer | EagleProposer | MedusaProposer
            )
386
387
            if self.speculative_config.method == "ngram":
                self.drafter = NgramProposer(self.vllm_config)
388
389
            elif self.speculative_config.method == "suffix":
                self.drafter = SuffixDecodingProposer(self.vllm_config)
390
            elif self.speculative_config.use_eagle():
391
                self.drafter = EagleProposer(self.vllm_config, self.device, self)
392
                if self.speculative_config.method == "eagle3":
393
394
395
                    self.use_aux_hidden_state_outputs = (
                        self.drafter.eagle3_use_aux_hidden_state
                    )
396
397
            elif self.speculative_config.method == "medusa":
                self.drafter = MedusaProposer(
398
                    vllm_config=self.vllm_config, device=self.device
399
                )
400
            else:
401
402
403
404
                raise ValueError(
                    "Unknown speculative decoding method: "
                    f"{self.speculative_config.method}"
                )
405
            self.rejection_sampler = RejectionSampler(self.sampler)
406

407
408
409
410
        self.num_spec_tokens = 0
        if self.speculative_config:
            self.num_spec_tokens = self.speculative_config.num_speculative_tokens

411
        # Request states.
412
        self.requests: dict[str, CachedRequestState] = {}
413
414
415
        # NOTE(rob): num_prompt_logprobs only includes reqs
        # that are currently in the prefill phase.
        self.num_prompt_logprobs: dict[str, int] = {}
416
        self.comm_stream = torch.cuda.Stream()
417

418
419
420
421
422
423
424
425
426
        # 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.
427
428
429
430
        logits_processors = model_config.logits_processors
        custom_logitsprocs: Sequence[str | type[LogitsProcessor]] = (
            tuple(logits_processors) if logits_processors is not None else ()
        )
431
432
        self.input_batch = InputBatch(
            max_num_reqs=self.max_num_reqs,
433
434
435
            # We need to use the encoder length for encoder-decoer
            # because of KV cache for cross-attention.
            max_model_len=max(self.max_model_len, self.max_encoder_len),
436
437
438
            max_num_batched_tokens=self.max_num_tokens,
            device=self.device,
            pin_memory=self.pin_memory,
439
            vocab_size=self.model_config.get_vocab_size(),
440
            block_sizes=[self.cache_config.block_size],
441
            kernel_block_sizes=[self.cache_config.block_size],
442
            is_spec_decode=bool(self.vllm_config.speculative_config),
443
            logitsprocs=build_logitsprocs(
444
445
446
                self.vllm_config,
                self.device,
                self.pin_memory,
447
                self.is_pooling_model,
448
                custom_logitsprocs,
449
            ),
450
451
452
            # We currently don't know whether a particular custom logits processor
            # uses output token ids so we set this conservatively.
            logitsprocs_need_output_token_ids=bool(custom_logitsprocs),
453
            is_pooling_model=self.is_pooling_model,
454
            cp_kv_cache_interleave_size=self.parallel_config.cp_kv_cache_interleave_size,
455
        )
456

457
        self.use_async_scheduling = self.scheduler_config.async_scheduling
458
459
460
461
462
        # 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.
463
        self.prepare_inputs_event: torch.Event | None = None
464
465
        if self.use_async_scheduling:
            self.async_output_copy_stream = torch.cuda.Stream()
466
            self.prepare_inputs_event = torch.Event()
467

468
        # self.cudagraph_batch_sizes sorts in ascending order.
469
470
471
472
        if (
            self.compilation_config.cudagraph_capture_sizes
            and self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
        ):
473
474
            self.cudagraph_batch_sizes = sorted(
                self.compilation_config.cudagraph_capture_sizes
475
            )
476

477
        # Cache the device properties.
478
        self._init_device_properties()
479

480
        # Persistent buffers for CUDA graphs.
481
482
483
484
485
        self.input_ids = self._make_buffer(self.max_num_tokens, dtype=torch.int32)
        self.positions = self._make_buffer(self.max_num_tokens, dtype=torch.int64)
        self.query_start_loc = self._make_buffer(
            self.max_num_reqs + 1, dtype=torch.int32
        )
486
        self.seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
487
        self.encoder_seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
488
489
490
491
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens = self._make_buffer(
                self.max_num_reqs, dtype=torch.int32
            )
492
493
494
        # 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.
495
        self.inputs_embeds = self._make_buffer(
496
            self.max_num_tokens, self.inputs_embeds_size, dtype=self.dtype, numpy=False
497
498
        )
        self.is_token_ids = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
499
500
        self.discard_request_mask = self._make_buffer(
            self.max_num_reqs, dtype=torch.bool
501
502
503
504
505
506
507
        )
        self.num_decode_draft_tokens = self._make_buffer(
            self.max_num_reqs, dtype=torch.int32
        )
        self.num_accepted_tokens = self._make_buffer(
            self.max_num_reqs, dtype=torch.int64
        )
508

509
510
        # Only relevant for multimodal models
        if self.supports_mm_inputs:
511
            self.is_mm_embed = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
512

513
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
514
        if self.uses_mrope:
Roger Wang's avatar
Roger Wang committed
515
516
517
518
            # 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
519
520
521
522
523
524

            # 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
525
            self.mrope_positions = self._make_buffer(
526
527
                (3, self.max_num_tokens + 1), dtype=torch.int64
            )
528

529
530
531
532
533
534
535
        # 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
            )

536
        # None in the first PP rank. The rest are set after load_model.
537
        self.intermediate_tensors: IntermediateTensors | None = None
538

539
        # OPTIMIZATION: Cache the tensors rather than creating them every step.
540
        # Keep in int64 to avoid overflow with long context
541
542
543
544
        self.arange_np = np.arange(
            max(self.max_num_reqs + 1, self.max_model_len, self.max_num_tokens),
            dtype=np.int64,
        )
545

546
547
548
549
550
        # 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] = {}
551
552
553
554
555
        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(
556
557
                self.max_num_tokens, dtype=torch.int32, device=self.device
            )
558

559
        self.uniform_decode_query_len = 1 + self.num_spec_tokens
560
561
562
563

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

564
565
        self.mm_budget = (
            MultiModalBudget(
566
                self.model_config,
567
568
569
570
571
572
                self.scheduler_config,
                self.mm_registry,
            )
            if self.supports_mm_inputs
            else None
        )
573

574
        self.reorder_batch_threshold: int | None = None
575

576
577
578
579
580
        # 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()

581
        # Cached outputs.
582
        self._draft_token_ids: list[list[int]] | torch.Tensor | None = None
583
        self.transfer_event = torch.Event()
584
        self.sampled_token_ids_pinned_cpu = torch.empty(
585
            (self.max_num_reqs, 1),
586
587
            dtype=torch.int64,
            device="cpu",
588
589
            pin_memory=self.pin_memory,
        )
590

591
592
        # Pre-allocated tensor for copying valid sampled token counts to CPU,
        # with dedicated stream for overlapping and event for coordination.
593
        self.valid_sampled_token_count_event: torch.Event | None = None
594
595
        self.valid_sampled_token_count_copy_stream: torch.cuda.Stream | None = None
        if self.use_async_scheduling and self.num_spec_tokens:
596
            self.valid_sampled_token_count_event = torch.Event()
597
598
599
600
601
602
603
604
            self.valid_sampled_token_count_copy_stream = torch.cuda.Stream()
        self.valid_sampled_token_count_cpu = torch.empty(
            self.max_num_reqs,
            dtype=torch.int64,
            device="cpu",
            pin_memory=self.pin_memory,
        )

605
606
        # Ephemeral state transferred between execute_model() and sample_tokens().
        self.execute_model_state: ExecuteModelState | None = None
607
        self.kv_connector_output: KVConnectorOutput | None = None
608
        self.layerwise_nvtx_hooks_registered = False
609

610
611
612
613
    def reset_mm_cache(self) -> None:
        if self.mm_budget:
            self.mm_budget.reset_cache()

614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
    @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.
        """
        if not self.cache_config.cache_dtype.startswith("fp8"):
            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)

658
659
660
661
    def _get_positions(self, num_tokens: Any):
        if isinstance(num_tokens, int):
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, :num_tokens]
662
663
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, :num_tokens]
664
665
666
667
            return self.positions.gpu[:num_tokens]
        else:
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, num_tokens]
668
669
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, num_tokens]
670
671
            return self.positions.gpu[num_tokens]

672
    def _make_buffer(
673
        self, *size: int | torch.SymInt, dtype: torch.dtype, numpy: bool = True
674
675
676
677
678
679
680
681
    ) -> CpuGpuBuffer:
        return CpuGpuBuffer(
            *size,
            dtype=dtype,
            device=self.device,
            pin_memory=self.pin_memory,
            with_numpy=numpy,
        )
682

683
684
685
    def _init_model_kwargs(self, num_tokens: int):
        model_kwargs = dict[str, Any]()

686
        if not self.is_pooling_model:
687
688
            return model_kwargs

689
690
        num_reqs = self.input_batch.num_reqs
        pooling_params = self.input_batch.get_pooling_params()
691
692
693

        token_type_id_requests = dict[int, Any]()
        for i, param in enumerate(pooling_params):
694
695
696
697
698
            if (
                param.extra_kwargs is not None
                and (token_types := param.extra_kwargs.get("compressed_token_type_ids"))
                is not None
            ):
699
700
701
702
703
                token_type_id_requests[i] = token_types

        if len(token_type_id_requests) == 0:
            return model_kwargs

704
        seq_lens = self.seq_lens.gpu[:num_reqs]
705
706
707
708
709
710
711
712
        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(
713
714
            device=self.device
        )
715
716
        return model_kwargs

717
    def _may_reorder_batch(self, scheduler_output: "SchedulerOutput") -> None:
718
719
        """
        Update the order of requests in the batch based on the attention
720
        backend's needs. For example, some attention backends (namely MLA) may
721
722
723
724
725
726
        want to separate requests based on if the attention computation will be
        compute-bound or memory-bound.

        Args:
            scheduler_output: The scheduler output.
        """
727
728
729
730
731
732
733
734
        # Attention free models have zero kv_cache_goups, however models
        # 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

735
736
737
738
        if self.reorder_batch_threshold is not None:
            reorder_batch_to_split_decodes_and_prefills(
                self.input_batch,
                scheduler_output,
739
740
                decode_threshold=self.reorder_batch_threshold,
            )
741

742
743
    # Note: used for model runner override.
    def _init_device_properties(self) -> None:
744
        """Initialize attributes from torch.cuda.get_device_properties"""
745
746
747
748
749
750
751
        self.device_properties = torch.cuda.get_device_properties(self.device)
        self.num_sms = self.device_properties.multi_processor_count

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

752
    def _update_states(self, scheduler_output: "SchedulerOutput") -> None:
753
754
755
756
757
758
        """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.

759
760
        The SamplingMetadata is updated and copied to the GPU if there is a
        new/resumed/paused/finished request in the batch.
761
762
        """
        # Remove finished requests from the cached states.
763
764
        for req_id in scheduler_output.finished_req_ids:
            self.requests.pop(req_id, None)
765
            self.num_prompt_logprobs.pop(req_id, None)
766
767
768
769
770
771
772
        # 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:
773
            self.input_batch.remove_request(req_id)
774
775

        # Free the cached encoder outputs.
776
777
        for mm_hash in scheduler_output.free_encoder_mm_hashes:
            self.encoder_cache.pop(mm_hash, None)
778

779
780
781
782
783
784
785
        # 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()
786
787
788
789
790
791
792
793
        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)
794
795
796
797
798
        # 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:
799
            self.input_batch.remove_request(req_id)
800

801
        reqs_to_add: list[CachedRequestState] = []
802
        # Add new requests to the cached states.
803
804
805
        for new_req_data in scheduler_output.scheduled_new_reqs:
            req_id = new_req_data.req_id
            sampling_params = new_req_data.sampling_params
806
            pooling_params = new_req_data.pooling_params
807

808
809
810
811
            if (
                sampling_params
                and sampling_params.sampling_type == SamplingType.RANDOM_SEED
            ):
812
813
814
815
816
                generator = torch.Generator(device=self.device)
                generator.manual_seed(sampling_params.seed)
            else:
                generator = None

817
818
            if self.is_pooling_model:
                assert pooling_params is not None
819
820
                task = pooling_params.task
                assert task is not None, "You did not set `task` in the API"
821

822
                model = cast(VllmModelForPooling, self.get_model())
823
                to_update = model.pooler.get_pooling_updates(task)
824
825
                to_update.apply(pooling_params)

826
            req_state = CachedRequestState(
827
                req_id=req_id,
828
                prompt_token_ids=new_req_data.prompt_token_ids,
829
                prompt_embeds=new_req_data.prompt_embeds,
830
                mm_features=new_req_data.mm_features,
831
                sampling_params=sampling_params,
832
                pooling_params=pooling_params,
833
                generator=generator,
834
835
                block_ids=new_req_data.block_ids,
                num_computed_tokens=new_req_data.num_computed_tokens,
836
                output_token_ids=[],
837
                lora_request=new_req_data.lora_request,
838
            )
839
840
            self.requests[req_id] = req_state

841
842
843
844
845
846
847
            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
                )

848
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
849
            if self.uses_mrope:
850
                self._init_mrope_positions(req_state)
851

852
853
854
855
            # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
            if self.uses_xdrope_dim > 0:
                self._init_xdrope_positions(req_state)

856
            reqs_to_add.append(req_state)
857

858
        # Update the states of the running/resumed requests.
859
        is_last_rank = get_pp_group().is_last_rank
860
        req_data = scheduler_output.scheduled_cached_reqs
861
862
863
864
865

        # Wait until valid_sampled_tokens_count is copied to cpu,
        # then use it to update actual num_computed_tokens of each request.
        valid_sampled_token_count = self._get_valid_sampled_token_count()

866
        for i, req_id in enumerate(req_data.req_ids):
867
            req_state = self.requests[req_id]
868
869
            num_computed_tokens = req_data.num_computed_tokens[i]
            new_block_ids = req_data.new_block_ids[i]
870
            resumed_from_preemption = req_id in req_data.resumed_req_ids
871
            num_output_tokens = req_data.num_output_tokens[i]
872
            req_index = self.input_batch.req_id_to_index.get(req_id)
873

874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
            # 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:
            # fist step: num_computed_tokens = 0, spec_tokens = [],
            # prev_num_draft_len = 0.
            # second step: num_computed_tokens = 100(prompt lenth),
            # 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.
            # num_computed_tokens in first step and second step does't contain
            # 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.
            if req_state.prev_num_draft_len:
                if req_index is None:
                    req_state.prev_num_draft_len = 0
                else:
                    assert self.input_batch.prev_req_id_to_index is not None
                    prev_req_index = self.input_batch.prev_req_id_to_index[req_id]
                    num_accepted = valid_sampled_token_count[prev_req_index] - 1
                    num_rejected = req_state.prev_num_draft_len - num_accepted
                    num_computed_tokens -= num_rejected
                    req_state.output_token_ids.extend([-1] * num_accepted)
897

898
            # Update the cached states.
899
            req_state.num_computed_tokens = num_computed_tokens
900
901
902
903
904
905
906
907

            if not is_last_rank:
                # 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.
                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.
908
909
910
                num_new_tokens = (
                    num_computed_tokens + len(new_token_ids) - req_state.num_tokens
                )
911
912
913
914
                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:
915
                    req_state.output_token_ids.extend(new_token_ids[-num_new_tokens:])
916
917
918
919
920
            elif num_output_tokens < len(req_state.output_token_ids):
                # Some output tokens were discarded due to a sync-KV-load
                # failure. Align the cached state.
                del req_state.output_token_ids[num_output_tokens:]
                if req_index is not None:
921
922
923
924
                    end_idx = (
                        self.input_batch.num_prompt_tokens[req_index]
                        + num_output_tokens
                    )
925
926
                    self.input_batch.num_tokens[req_index] = end_idx
                    self.input_batch.num_tokens_no_spec[req_index] = end_idx
927

928
            # Update the block IDs.
929
            if not resumed_from_preemption:
930
931
                if new_block_ids is not None:
                    # Append the new blocks to the existing block IDs.
932
                    for block_ids, new_ids in zip(req_state.block_ids, new_block_ids):
933
                        block_ids.extend(new_ids)
934
            else:
935
                assert req_index is None
936
                assert new_block_ids is not None
937
938
                # The request is resumed from preemption.
                # Replace the existing block IDs with the new ones.
939
                req_state.block_ids = new_block_ids
940
941
942
943
944

            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.
945
946
947
948
949
950
951

                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:]

952
                reqs_to_add.append(req_state)
953
954
955
                continue

            # Update the persistent batch.
956
            self.input_batch.num_computed_tokens_cpu[req_index] = num_computed_tokens
957
            if new_block_ids is not None:
958
                self.input_batch.block_table.append_row(new_block_ids, req_index)
959
960
961
962
963
964
965

            # 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)
966
                self.input_batch.token_ids_cpu[
967
968
969
                    req_index, start_token_index:end_token_index
                ] = new_token_ids
                self.input_batch.num_tokens_no_spec[req_index] = end_token_index
970
                self.input_batch.num_tokens[req_index] = end_token_index
971

972
            # Add spec_token_ids to token_ids_cpu.
973
            spec_token_ids = scheduler_output.scheduled_spec_decode_tokens.get(
974
                req_id, []
975
            )
976
977
978
979
980
            num_spec_tokens = len(spec_token_ids)
            # For async scheduling, token_ids_cpu assigned from
            # spec_token_ids are placeholders and will be overwritten in
            # _prepare_input_ids.
            if num_spec_tokens:
981
982
983
                start_index = self.input_batch.num_tokens_no_spec[req_index]
                end_token_index = start_index + num_spec_tokens
                self.input_batch.token_ids_cpu[
984
985
                    req_index, start_index:end_token_index
                ] = spec_token_ids
986
987
                # NOTE(woosuk): `num_tokens` here may include spec tokens.
                self.input_batch.num_tokens[req_index] += num_spec_tokens
988
989
990
991
992
993

            # When speculative decoding is used with structured output,
            # the scheduler can drop draft tokens that do not
            # conform to the schema. This can result in
            # scheduler_output.scheduled_spec_decode_tokens being empty,
            # even when speculative decoding is enabled.
994
995
            self.input_batch.spec_token_ids[req_index].clear()
            self.input_batch.spec_token_ids[req_index].extend(spec_token_ids)
996

997
998
999
1000
1001
1002
1003
1004
1005
            # there are no draft tokens with async scheduling,
            # we clear the spec_decoding info in scheduler_output and
            # use normal sampling but rejection_sampling.
            if self.use_async_scheduling:
                req_state.prev_num_draft_len = num_spec_tokens
                if num_spec_tokens and self._draft_token_ids is None:
                    scheduler_output.total_num_scheduled_tokens -= num_spec_tokens
                    scheduler_output.num_scheduled_tokens[req_id] -= num_spec_tokens
                    scheduler_output.scheduled_spec_decode_tokens.pop(req_id, None)
1006
1007
        # Add the new or resumed requests to the persistent batch.
        # The smaller empty indices are filled first.
1008
1009
        for request in reqs_to_add:
            self.input_batch.add_request(request)
1010

1011
1012
1013
1014
1015
1016
        # 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()
1017

1018
    def _update_states_after_model_execute(
1019
1020
        self, output_token_ids: torch.Tensor
    ) -> None:
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
        """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.
        """
        if not self.model_config.is_hybrid or not self.speculative_config:
            return

        # Find the number of accepted tokens for each sequence.
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
        num_accepted_tokens = (
            (
                torch.cat(
                    [
                        output_token_ids,
                        torch.full(
                            (output_token_ids.size(0), 1),
                            -1,
                            device=output_token_ids.device,
                        ),
                    ],
                    dim=1,
                )
                == -1
            )
            .int()
            .argmax(-1)
            .cpu()
            .numpy()
        )
1053
1054
1055
        for i, num_tokens in enumerate(num_accepted_tokens):
            self.input_batch.num_accepted_tokens_cpu[i] = num_tokens

1056
    def _init_mrope_positions(self, req_state: CachedRequestState):
1057
1058
        model = self.get_model()
        assert supports_mrope(model), "M-RoPE support is not implemented."
1059
1060
1061
1062
        assert req_state.prompt_token_ids is not None, (
            "M-RoPE requires prompt_token_ids to be available."
        )
        mrope_model = cast(SupportsMRoPE, model)
1063
1064

        req_state.mrope_positions, req_state.mrope_position_delta = (
1065
            mrope_model.get_mrope_input_positions(
1066
                req_state.prompt_token_ids,
1067
                req_state.mm_features,
1068
            )
1069
        )
1070

1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
    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,
        )

1084
    def _extract_mm_kwargs(
1085
        self,
1086
1087
        scheduler_output: "SchedulerOutput",
    ) -> BatchedTensorInputs:
1088
        if not scheduler_output or not self.is_multimodal_raw_input_only_model:
1089
            return {}
1090

1091
1092
        mm_kwargs = list[MultiModalKwargsItem]()
        for req in scheduler_output.scheduled_new_reqs:
1093
1094
1095
            for feature in req.mm_features:
                if feature.data is not None:
                    mm_kwargs.append(feature.data)
1096

1097
        # Input all modalities at once
1098
        model = cast(SupportsMultiModal, self.model)
1099
1100
        mm_kwargs_combined: BatchedTensorInputs = {}
        for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
1101
1102
1103
1104
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
1105
1106
        ):
            mm_kwargs_combined.update(mm_kwargs_group)
1107

1108
        return mm_kwargs_combined
1109

1110
    def _dummy_mm_kwargs(self, num_seqs: int) -> BatchedTensorInputs:
1111
        if not self.is_multimodal_raw_input_only_model:
1112
            return {}
1113

1114
1115
1116
1117
1118
        mm_budget = self.mm_budget
        assert mm_budget is not None

        dummy_modality = mm_budget.get_modality_with_max_tokens()
        return self._get_mm_dummy_batch(dummy_modality, num_seqs)
1119

1120
1121
1122
    def _get_cumsum_and_arange(
        self,
        num_tokens: np.ndarray,
1123
        cumsum_dtype: np.dtype | None = None,
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
    ) -> tuple[np.ndarray, np.ndarray]:
        """Get the cumulative sum and batched arange of the given array.
        # E.g., [2, 5, 3] -> ([2, 7, 10], [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])
        """
        # 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]
        arange = self.arange_np[:total_num_tokens] - cumsums_offsets

        return cu_num_tokens, arange

1140
    def _prepare_input_ids(
1141
1142
1143
1144
        self,
        scheduler_output: "SchedulerOutput",
        total_num_scheduled_tokens: int,
        cu_num_tokens: np.ndarray,
1145
    ) -> None:
1146
        """Prepare the input IDs for the current batch.
1147

1148
1149
1150
1151
1152
1153
1154
        Carefully handles the `prev_sampled_token_ids` which can be cached
        from the previous engine iteration, in which case those tokens on the
        GPU need to be copied into the corresponding slots into input_ids."""

        if self.input_batch.prev_sampled_token_ids is None:
            # Normal scheduling case
            self.input_ids.copy_to_gpu(total_num_scheduled_tokens)
1155
1156
1157
            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)
1158
1159
1160
1161
1162
1163
1164
            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.
        prev_req_id_to_index = self.input_batch.prev_req_id_to_index
        assert prev_req_id_to_index is not None
1165
1166
1167
1168
        sample_flattened_indices: list[int] = []
        spec_flattened_indices: list[int] = []
        prev_common_req_indices: list[int] = []
        prev_draft_token_indices: list[int] = []
1169
1170
        indices_match = True
        max_flattened_index = -1
1171
1172
1173
        total_num_spec_tokens = 0
        scheduled_spec_tokens = scheduler_output.scheduled_spec_decode_tokens

1174
1175
1176
1177
1178
        for req_id, cur_index in self.input_batch.req_id_to_index.items():
            if (prev_index := prev_req_id_to_index.get(req_id)) is not None:
                prev_common_req_indices.append(prev_index)
                # We need to compute the flattened input_ids index of the
                # last token in each common request.
1179
1180
                draft_len = len(scheduled_spec_tokens.get(req_id, ()))
                total_num_spec_tokens += draft_len
1181
                flattened_index = cu_num_tokens[cur_index].item() - 1
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
                # 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))
1197
                indices_match &= prev_index == flattened_index
1198
                max_flattened_index = max(max_flattened_index, flattened_index)
1199
1200
1201
        num_commmon_tokens = len(sample_flattened_indices)
        total_without_spec = total_num_scheduled_tokens - total_num_spec_tokens
        if num_commmon_tokens < total_without_spec:
1202
1203
1204
            # If not all requests are decodes from the last iteration,
            # We need to copy the input_ids_cpu to the GPU first.
            self.input_ids.copy_to_gpu(total_num_scheduled_tokens)
1205
1206
1207
            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)
1208
1209
        if num_commmon_tokens == 0:
            # No requests in common with the previous iteration
1210
            # So input_ids.cpu will have all the input ids.
1211
1212
1213
1214
1215
1216
1217
            return
        if indices_match and max_flattened_index == (num_commmon_tokens - 1):
            # 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.
            self.input_ids.gpu[:num_commmon_tokens].copy_(
1218
1219
1220
                self.input_batch.prev_sampled_token_ids[:num_commmon_tokens, 0],
                non_blocking=True,
            )
1221
1222
            if self.enable_prompt_embeds:
                self.is_token_ids.gpu[:num_commmon_tokens] = True
1223
            return
1224
        # Upload the index tensors asynchronously so the scatter can be non-blocking.
1225
1226
        sampled_tokens_index_tensor = torch.tensor(
            sample_flattened_indices, dtype=torch.int64, pin_memory=self.pin_memory
1227
        ).to(self.device, non_blocking=True)
1228
        prev_common_req_indices_tensor = torch.tensor(
1229
1230
            prev_common_req_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)
1231
1232
        self.input_ids.gpu.scatter_(
            dim=0,
1233
            index=sampled_tokens_index_tensor,
1234
            src=self.input_batch.prev_sampled_token_ids[
1235
1236
1237
                prev_common_req_indices_tensor, 0
            ],
        )
1238

1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
        # 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._draft_token_ids = None

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

1262
1263
    def _get_encoder_seq_lens(
        self,
1264
        num_scheduled_tokens: dict[str, int],
1265
1266
        kv_cache_spec: KVCacheSpec,
        num_reqs: int,
1267
    ) -> tuple[torch.Tensor | None, np.ndarray | None]:
1268
        if not isinstance(kv_cache_spec, CrossAttentionSpec):
1269
            return None, None
1270

1271
1272
        # Zero out buffer for padding requests that are not actually scheduled (CGs)
        self.encoder_seq_lens.np[:num_reqs] = 0
1273
1274
        # Build encoder_seq_lens array mapping request indices to
        # encoder lengths for inputs scheduled in this batch
1275
        for req_id in num_scheduled_tokens:
1276
            req_index = self.input_batch.req_id_to_index[req_id]
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
            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

        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]
1293

1294
        return encoder_seq_lens, encoder_seq_lens_cpu
1295

1296
    def _prepare_inputs(
1297
1298
1299
        self,
        scheduler_output: "SchedulerOutput",
        num_scheduled_tokens: np.ndarray,
1300
1301
    ) -> tuple[
        torch.Tensor,
1302
        SpecDecodeMetadata | None,
1303
    ]:
1304
1305
        """
        :return: tuple[
1306
            logits_indices, spec_decode_metadata,
1307
1308
        ]
        """
1309
1310
1311
1312
1313
1314
1315
        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.
1316
        self.input_batch.block_table.commit_block_table(num_reqs)
1317
1318
1319

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

1322
1323
        # cu_num_tokens: [2, 5, 3] -> [2, 7, 10]
        # arange: [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
1324
        cu_num_tokens, arange = self._get_cumsum_and_arange(num_scheduled_tokens)
1325
1326

        # Get positions.
1327
        positions_np = self.positions.np[:total_num_scheduled_tokens]
1328
1329
1330
1331
1332
        np.add(
            self.input_batch.num_computed_tokens_cpu[req_indices],
            arange,
            out=positions_np,
        )
1333

1334
1335
        # Calculate M-RoPE positions.
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1336
        if self.uses_mrope:
1337
1338
            self._calc_mrope_positions(scheduler_output)

1339
1340
1341
1342
1343
        # 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)

1344
1345
1346
1347
        # 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.
1348
1349
1350
        token_indices = (
            positions_np + req_indices * self.input_batch.token_ids_cpu.shape[1]
        )
1351
        token_indices_tensor = torch.from_numpy(token_indices)
1352

1353
1354
1355
        # 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.
1356
1357
1358
1359
1360
1361
        torch.index_select(
            self.input_batch.token_ids_cpu_tensor.flatten(),
            0,
            token_indices_tensor,
            out=self.input_ids.cpu[:total_num_scheduled_tokens],
        )
1362
        if self.enable_prompt_embeds:
1363
            is_token_ids = self.input_batch.is_token_ids_tensor.flatten()
1364
1365
1366
1367
            torch.index_select(
                is_token_ids,
                0,
                token_indices_tensor,
1368
1369
                out=self.is_token_ids.cpu[:total_num_scheduled_tokens],
            )
1370
1371
1372
1373
1374
1375
1376
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

        # 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:
1403
1404
1405
                    self.inputs_embeds.cpu[
                        output_idx : output_idx + actual_num_sched
                    ].copy_(req_embeds[start_pos:actual_end])
1406
1407

                output_idx += num_sched
1408

1409
1410
        self.input_batch.block_table.compute_slot_mapping(req_indices, positions_np)
        self.input_batch.block_table.commit_slot_mapping(total_num_scheduled_tokens)
1411
1412

        # Prepare the attention metadata.
1413
        self.query_start_loc.np[0] = 0
1414
        self.query_start_loc.np[1 : num_reqs + 1] = cu_num_tokens
1415
1416
        # Note: pad query_start_loc to be non-decreasing, as kernels
        # like FlashAttention requires that
1417
        self.query_start_loc.np[num_reqs + 1 :].fill(cu_num_tokens[-1])
1418
        self.query_start_loc.copy_to_gpu()
1419
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1420

1421
        self.seq_lens.np[:num_reqs] = (
1422
1423
            self.input_batch.num_computed_tokens_cpu[:num_reqs] + num_scheduled_tokens
        )
1424
        # Fill unused with 0 for full cuda graph mode.
1425
1426
        self.seq_lens.np[num_reqs:].fill(0)
        self.seq_lens.copy_to_gpu()
1427

1428
        num_tokens = [self.requests[r].num_tokens for r in self.input_batch.req_ids]
1429
1430
        num_tokens_np = np.array(num_tokens, dtype=np.int32)

1431
        # Record which requests should not be sampled,
1432
        # so that we could clear the sampled tokens before returning
1433
1434
        self.discard_request_mask.np[:num_reqs] = (
            self.seq_lens.np[:num_reqs] < num_tokens_np
1435
        )
1436
        self.discard_request_mask.copy_to_gpu(num_reqs)
1437

1438
        # Copy the tensors to the GPU.
1439
1440
1441
1442
1443
        self._prepare_input_ids(
            scheduler_output,
            total_num_scheduled_tokens,
            cu_num_tokens,
        )
1444

1445
        if self.uses_mrope:
1446
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1447
1448
            self.mrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.mrope_positions.cpu[:, :total_num_scheduled_tokens],
1449
1450
                non_blocking=True,
            )
1451
1452
1453
1454
1455
1456
        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,
            )
1457
1458
        else:
            # Common case (1D positions)
1459
            self.positions.copy_to_gpu(total_num_scheduled_tokens)
1460

1461
        use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
1462
1463
1464
1465
1466
1467
1468
        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
1469
            num_draft_tokens = None
1470
            spec_decode_metadata = None
1471
            num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
1472
1473
1474
1475
1476
        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)
1477
1478
1479
            # 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)
1480
1481
1482
1483
            for (
                req_id,
                draft_token_ids,
            ) in scheduler_output.scheduled_spec_decode_tokens.items():
1484
1485
                req_idx = self.input_batch.req_id_to_index[req_id]
                num_draft_tokens[req_idx] = len(draft_token_ids)
1486
1487
1488
1489
1490
1491
1492
1493
                num_decode_draft_tokens[req_idx] = (
                    len(draft_token_ids)
                    if (
                        self.input_batch.num_computed_tokens_cpu[req_idx]
                        >= self.input_batch.num_prompt_tokens[req_idx]
                    )
                    else -1
                )
1494
            spec_decode_metadata = self._calc_spec_decode_metadata(
1495
1496
                num_draft_tokens, cu_num_tokens
            )
1497
            logits_indices = spec_decode_metadata.logits_indices
1498
            num_sampled_tokens = num_draft_tokens + 1
1499
            # For DECODE only cuda graph of some attention backends (e.g., GDN).
1500
            self.num_decode_draft_tokens.np[:num_reqs] = num_decode_draft_tokens
1501
1502
            self.num_decode_draft_tokens.np[num_reqs:].fill(-1)
            self.num_decode_draft_tokens.copy_to_gpu()
1503

1504
1505
1506
1507
1508
        # Hot-Swap lora model
        if self.lora_config:
            assert (
                np.sum(num_sampled_tokens)
                <= self.vllm_config.scheduler_config.max_num_batched_tokens
1509
            )
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
            self.set_active_loras(
                self.input_batch, num_scheduled_tokens, num_sampled_tokens
            )

        return (
            logits_indices,
            spec_decode_metadata,
        )

    def _build_attention_metadata(
        self,
1521
        num_tokens: int,
1522
        num_reqs: int,
1523
1524
1525
        max_query_len: int,
        num_tokens_padded: int | None = None,
        num_reqs_padded: int | None = None,
1526
1527
1528
1529
        ubatch_slices: UBatchSlices | None = None,
        logits_indices: torch.Tensor | None = None,
        use_spec_decode: bool = False,
        for_cudagraph_capture: bool = False,
1530
        num_scheduled_tokens: dict[str, int] | None = None,
1531
1532
1533
1534
1535
        cascade_attn_prefix_lens: list[list[int]] | None = None,
    ) -> tuple[PerLayerAttnMetadata, CommonAttentionMetadata | None]:
        """
        :return: tuple[attn_metadata, spec_decode_common_attn_metadata]
        """
1536
1537
1538
        num_tokens_padded = num_tokens_padded or num_tokens
        num_reqs_padded = num_reqs_padded or num_reqs

1539
        logits_indices_padded = None
1540
        num_logits_indices = None
1541
1542
1543
1544
1545
1546
        if logits_indices is not None:
            num_logits_indices = logits_indices.size(0)
            if self.cache_config.kv_sharing_fast_prefill:
                logits_indices_padded = self._prepare_kv_sharing_fast_prefill(
                    logits_indices
                )
1547

1548
1549
1550
1551
1552
1553
        # update seq_lens of decode reqs under DCP.
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens.cpu[:num_reqs] = get_dcp_local_seq_lens(
                self.seq_lens.cpu[:num_reqs],
                self.dcp_world_size,
                self.dcp_rank,
1554
                self.parallel_config.cp_kv_cache_interleave_size,
1555
            )
1556
1557
            self.dcp_local_seq_lens.cpu[num_reqs:].fill_(0)
            self.dcp_local_seq_lens.copy_to_gpu(num_reqs_padded)
1558

1559
1560
1561
        attn_metadata: PerLayerAttnMetadata = {}
        if ubatch_slices is not None:
            attn_metadata = [dict() for _ in range(len(ubatch_slices))]
1562

1563
1564
1565
1566
1567
1568
1569
1570
        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:
            max_seq_len = self.seq_lens.np[:num_reqs].max().item()

1571
1572
        if use_spec_decode:
            self.num_accepted_tokens.np[:num_reqs] = (
1573
1574
                self.input_batch.num_accepted_tokens_cpu[:num_reqs]
            )
1575
1576
            self.num_accepted_tokens.np[num_reqs:].fill(1)
            self.num_accepted_tokens.copy_to_gpu()
1577

1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
        # Used in the below loop, uses padded shapes
        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]
        seq_lens = self.seq_lens.gpu[:num_reqs_padded]
        seq_lens_cpu = self.seq_lens.cpu[:num_reqs_padded]
        num_computed_tokens_cpu = self.input_batch.num_computed_tokens_cpu_tensor[
            :num_reqs_padded
        ]

        dcp_local_seq_lens, dcp_local_seq_lens_cpu = None, None
        if self.dcp_world_size > 1:
            dcp_local_seq_lens = self.dcp_local_seq_lens.gpu[:num_reqs_padded]
            dcp_local_seq_lens_cpu = self.dcp_local_seq_lens.cpu[:num_reqs_padded]

        spec_decode_common_attn_metadata = None

1594
1595
        # Prepare the attention metadata for each KV cache group and make layers
        # in the same group share the same metadata.
1596
        for kv_cache_gid, kv_cache_group in enumerate(
1597
1598
            self.kv_cache_config.kv_cache_groups
        ):
1599
1600
            encoder_seq_lens, encoder_seq_lens_cpu = self._get_encoder_seq_lens(
                num_scheduled_tokens or {},
1601
                kv_cache_group.kv_cache_spec,
1602
                num_reqs_padded,
1603
            )
1604

1605
            if isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec):
1606
1607
1608
                # Encoder-only layers do not have KV cache, so we need to
                # create a dummy block table and slot mapping for them.
                blk_table_tensor = torch.zeros(
1609
                    (num_reqs_padded, 1),
1610
                    dtype=torch.int32,
1611
1612
1613
                    device=self.device,
                )
                slot_mapping = torch.zeros(
1614
                    (num_tokens_padded,),
1615
1616
1617
                    dtype=torch.int64,
                    device=self.device,
                )
1618
            else:
1619
                blk_table = self.input_batch.block_table[kv_cache_gid]
1620
1621
                blk_table_tensor = blk_table.get_device_tensor(num_reqs_padded)
                slot_mapping = blk_table.slot_mapping.gpu[:num_tokens_padded]
1622
1623

                # Fill unused with -1. Needed for reshape_and_cache in full cuda
1624
1625
1626
                # graph mode. `blk_table_tensor` -1 to match mamba PAD_SLOT_ID
                slot_mapping[num_tokens:num_tokens_padded].fill_(-1)
                blk_table_tensor[num_reqs:num_reqs_padded].fill_(-1)
1627

1628
            common_attn_metadata = CommonAttentionMetadata(
1629
1630
1631
                query_start_loc=query_start_loc,
                query_start_loc_cpu=query_start_loc_cpu,
                seq_lens=seq_lens,
1632
1633
                _seq_lens_cpu=seq_lens_cpu,
                _num_computed_tokens_cpu=num_computed_tokens_cpu,
1634
1635
1636
                num_actual_tokens=num_tokens_padded,
                num_reqs=num_reqs_padded,
                max_query_len=max_query_len,
1637
                max_seq_len=max_seq_len,
1638
1639
                block_table_tensor=blk_table_tensor,
                slot_mapping=slot_mapping,
1640
                logits_indices_padded=logits_indices_padded,
1641
                num_logits_indices=num_logits_indices,
1642
                causal=True,
1643
                encoder_seq_lens=encoder_seq_lens,
1644
                encoder_seq_lens_cpu=encoder_seq_lens_cpu,
1645
                dcp_local_seq_lens=dcp_local_seq_lens,
1646
                dcp_local_seq_lens_cpu=dcp_local_seq_lens_cpu,
1647
1648
            )

1649
            if self.speculative_config and spec_decode_common_attn_metadata is None:
1650
                if isinstance(self.drafter, EagleProposer):
1651
                    if self.drafter.attn_layer_names[0] in kv_cache_group.layer_names:
1652
1653
1654
                        spec_decode_common_attn_metadata = common_attn_metadata
                else:
                    spec_decode_common_attn_metadata = common_attn_metadata
1655

1656
1657
1658
1659
1660
1661
            for attn_gid, attn_group in enumerate(self.attn_groups[kv_cache_gid]):
                cascade_attn_prefix_len = (
                    cascade_attn_prefix_lens[kv_cache_gid][attn_gid]
                    if cascade_attn_prefix_lens
                    else 0
                )
1662
                builder = attn_group.get_metadata_builder()
1663

1664
                extra_attn_metadata_args = {}
1665
                if use_spec_decode and isinstance(builder, GDNAttentionMetadataBuilder):
1666
                    extra_attn_metadata_args = dict(
1667
1668
1669
                        num_accepted_tokens=self.num_accepted_tokens.gpu[
                            :num_reqs_padded
                        ],
1670
                        num_decode_draft_tokens_cpu=self.num_decode_draft_tokens.cpu[
1671
                            :num_reqs_padded
1672
                        ],
1673
1674
                    )

1675
1676
                if ubatch_slices is not None:
                    common_attn_metadata_list = split_attn_metadata(
1677
1678
                        ubatch_slices, common_attn_metadata
                    )
1679
                    for ubid, common_attn_metadata in enumerate(
1680
1681
                        common_attn_metadata_list
                    ):
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
                        builder = attn_group.get_metadata_builder(ubatch_id=ubid)
                        if for_cudagraph_capture:
                            attn_metadata_i = builder.build_for_cudagraph_capture(
                                common_attn_metadata
                            )
                        else:
                            attn_metadata_i = builder.build(
                                common_prefix_len=cascade_attn_prefix_len,
                                common_attn_metadata=common_attn_metadata,
                            )
                        for layer_name in kv_cache_group.layer_names:
1693
1694
1695
1696
                            assert type(attn_metadata) is list
                            attn_metadata[ubid][layer_name] = attn_metadata_i
                else:
                    assert isinstance(attn_metadata, dict)
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
                    if for_cudagraph_capture:
                        attn_metadata_i = builder.build_for_cudagraph_capture(
                            common_attn_metadata
                        )
                    else:
                        attn_metadata_i = builder.build(
                            common_prefix_len=cascade_attn_prefix_len,
                            common_attn_metadata=common_attn_metadata,
                            **extra_attn_metadata_args,
                        )
1707
1708
                    for layer_name in attn_group.layer_names:
                        attn_metadata[layer_name] = attn_metadata_i
1709

1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
        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

            if isinstance(attn_metadata, list):
                for ub_metadata in attn_metadata:
                    for _metadata in ub_metadata.values():
                        _metadata.mm_prefix_range = req_doc_ranges  # type: ignore[attr-defined]
            else:
                for _metadata in attn_metadata.values():
                    _metadata.mm_prefix_range = req_doc_ranges  # type: ignore[attr-defined]

1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
        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)
            )

1740
        return attn_metadata, spec_decode_common_attn_metadata
1741

1742
1743
1744
    def _compute_cascade_attn_prefix_lens(
        self,
        num_scheduled_tokens: np.ndarray,
1745
        num_computed_tokens: np.ndarray,
1746
1747
1748
1749
1750
1751
1752
        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
        """
1753

1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
        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,
1768
                        num_computed_tokens,
1769
1770
1771
1772
1773
1774
1775
1776
                        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
1777

1778
1779
1780
    def _compute_cascade_attn_prefix_len(
        self,
        num_scheduled_tokens: np.ndarray,
1781
        num_computed_tokens: np.ndarray,
1782
        num_common_prefix_blocks: int,
1783
1784
        kv_cache_spec: KVCacheSpec,
        attn_metadata_builder: AttentionMetadataBuilder,
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
    ) -> 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.
        """
1803

1804
        common_prefix_len = num_common_prefix_blocks * kv_cache_spec.block_size
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
        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]
1842
        # Request 3's num_computed_tokens: 3 (i.e., [A, B, C])
1843
1844
1845
1846
1847
        # 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.
1848
        common_prefix_len = min(common_prefix_len, num_computed_tokens.min())
1849
        # common_prefix_len should be a multiple of the block size.
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
        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
        )
1861
1862
        assert isinstance(kv_cache_spec, AttentionSpec)
        use_cascade = attn_metadata_builder.use_cascade_attention(
1863
1864
1865
            common_prefix_len=common_prefix_len,
            query_lens=num_scheduled_tokens,
            num_query_heads=self.num_query_heads,
1866
            num_kv_heads=kv_cache_spec.num_kv_heads,
1867
            use_alibi=self.use_alibi,
1868
            use_sliding_window=use_sliding_window,
1869
            use_local_attention=use_local_attention,
1870
            num_sms=self.num_sms,
1871
            dcp_world_size=self.dcp_world_size,
1872
1873
1874
        )
        return common_prefix_len if use_cascade else 0

1875
1876
    def _calc_mrope_positions(self, scheduler_output: "SchedulerOutput"):
        mrope_pos_ptr = 0
1877
        for index, req_id in enumerate(self.input_batch.req_ids):
1878
1879
1880
            req = self.requests[req_id]
            assert req.mrope_positions is not None

1881
1882
            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
1883
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
1884
1885
                req.prompt_token_ids, req.prompt_embeds
            )
1886
1887

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
1888
1889
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
            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

1903
1904
1905
                self.mrope_positions.cpu[:, dst_start:dst_end] = req.mrope_positions[
                    :, src_start:src_end
                ]
1906
1907
1908
1909
1910
1911
1912
                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

1913
                assert req.mrope_position_delta is not None
1914
                MRotaryEmbedding.get_next_input_positions_tensor(
1915
                    out=self.mrope_positions.np,
1916
1917
1918
1919
1920
                    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,
                )
1921
1922
1923

                mrope_pos_ptr += completion_part_len

1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
    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

1971
1972
    def _calc_spec_decode_metadata(
        self,
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
        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
1989
1990
1991
1992

        # Step 1. cu_num_sampled_tokens: [4, 5, 8, 9, 11]
        # arange: [0, 1, 2, 3, 0, 0, 1, 2, 0, 0, 1]
        cu_num_sampled_tokens, arange = self._get_cumsum_and_arange(
1993
1994
            num_sampled_tokens, cumsum_dtype=np.int32
        )
1995
        # Step 2. [0, 0, 0, 0, 103, 104, 104, 104, 206, 207, 207]
1996
        logits_indices = np.repeat(
1997
1998
            cu_num_scheduled_tokens - num_sampled_tokens, num_sampled_tokens
        )
1999
        # Step 3. [0, 1, 2, 3, 103, 104, 105, 106, 206, 207, 208]
2000
2001
2002
2003
2004
2005
        logits_indices += arange

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

        # Compute the draft logits indices.
2006
2007
2008
        # cu_num_draft_tokens: [3, 3, 5, 5, 6]
        # arange: [0, 1, 2, 0, 1, 0]
        cu_num_draft_tokens, arange = self._get_cumsum_and_arange(
2009
2010
            num_draft_tokens, cumsum_dtype=np.int32
        )
2011
2012
        # [0, 0, 0, 5, 5, 9]
        target_logits_indices = np.repeat(
2013
2014
            cu_num_sampled_tokens - num_sampled_tokens, num_draft_tokens
        )
2015
2016
2017
2018
2019
        # [0, 1, 2, 5, 6, 9]
        target_logits_indices += arange

        # TODO: Optimize the CPU -> GPU copy.
        cu_num_draft_tokens = torch.from_numpy(cu_num_draft_tokens).to(
2020
2021
            self.device, non_blocking=True
        )
2022
2023
2024
        cu_num_sampled_tokens = torch.from_numpy(cu_num_sampled_tokens).to(
            self.device, non_blocking=True
        )
2025
2026
2027
        logits_indices = torch.from_numpy(logits_indices).to(
            self.device, non_blocking=True
        )
2028
        target_logits_indices = torch.from_numpy(target_logits_indices).to(
2029
2030
            self.device, non_blocking=True
        )
2031
        bonus_logits_indices = torch.from_numpy(bonus_logits_indices).to(
2032
2033
            self.device, non_blocking=True
        )
2034

2035
2036
        # Compute the draft token ids.
        # draft_token_indices:      [  1,   2,   3, 105, 106, 208]
2037
        draft_token_ids = self.input_ids.gpu[logits_indices]
2038
2039
        draft_token_ids = draft_token_ids[target_logits_indices + 1]

2040
        return SpecDecodeMetadata(
2041
2042
2043
            draft_token_ids=draft_token_ids,
            num_draft_tokens=num_draft_tokens.tolist(),
            cu_num_draft_tokens=cu_num_draft_tokens,
2044
            cu_num_sampled_tokens=cu_num_sampled_tokens,
2045
2046
2047
2048
2049
            target_logits_indices=target_logits_indices,
            bonus_logits_indices=bonus_logits_indices,
            logits_indices=logits_indices,
        )

2050
2051
2052
2053
2054
2055
2056
    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
2057
        self.kv_sharing_fast_prefill_logits_indices[:num_logits].copy_(logits_indices)
2058
2059
2060
2061
2062
        # 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_(
2063
2064
2065
2066
2067
2068
            logits_indices[-1].item()
        )
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and num_logits <= self.cudagraph_batch_sizes[-1]
        ):
2069
2070
2071
2072
2073
            # Use piecewise CUDA graphs.
            # Add padding to the batch size.
            num_logits_padded = self.vllm_config.pad_for_cudagraph(num_logits)
        else:
            num_logits_padded = num_logits
2074
2075
2076
        logits_indices_padded = self.kv_sharing_fast_prefill_logits_indices[
            :num_logits_padded
        ]
2077
2078
        return logits_indices_padded

2079
2080
2081
2082
2083
2084
2085
2086
    def _batch_mm_kwargs_from_scheduler(
        self,
        scheduler_output: "SchedulerOutput",
    ) -> tuple[list[MultiModalKwargsItem], list[tuple[str, PlaceholderRange]]]:
        """Batch multimodal kwargs from scheduled encoder inputs.

        Args:
            scheduler_output: The scheduler output containing scheduled encoder
2087
                inputs.
2088
2089
2090
2091
2092
2093

        Returns:
            A tuple of (mm_kwargs, req_ids_pos) where:
            - mm_kwargs: List of multimodal kwargs items to be batched
            - mm_hashes_pos: List of (mm_hash, position_info) tuples
        """
2094
2095
        scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
        if not scheduled_encoder_inputs:
2096
            return [], []
2097
        # Batch the multi-modal inputs.
2098
        mm_kwargs = list[MultiModalKwargsItem]()
2099
2100
        # list of tuple (mm_hash, position_info)
        mm_hashes_pos = list[tuple[str, PlaceholderRange]]()
2101
2102
        for req_id, encoder_input_ids in scheduled_encoder_inputs.items():
            req_state = self.requests[req_id]
2103
2104

            for mm_input_id in encoder_input_ids:
2105
                mm_feature = req_state.mm_features[mm_input_id]
2106
2107
                if mm_feature.data is None:
                    continue
2108
2109
2110
                mm_hash = mm_feature.identifier
                mm_kwargs.append(mm_feature.data)
                mm_hashes_pos.append((mm_hash, mm_feature.mm_position))
2111

2112
2113
        return mm_kwargs, mm_hashes_pos

2114
2115
2116
    def _execute_mm_encoder(
        self, scheduler_output: "SchedulerOutput"
    ) -> list[torch.Tensor]:
2117
2118
        # Batch the multi-modal inputs using the helper method.
        mm_kwargs, mm_hashes_pos = self._batch_mm_kwargs_from_scheduler(
2119
2120
            scheduler_output
        )
2121
2122

        if not mm_kwargs:
2123
            return []
2124

2125
2126
2127
2128
2129
2130
2131
        # 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.
2132
        model = cast(SupportsMultiModal, self.model)
2133
        encoder_outputs: list[torch.Tensor] = []
2134
        for modality, num_items, mm_kwargs_group in group_mm_kwargs_by_modality(
2135
2136
2137
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
2138
        ):
2139
            curr_group_outputs: list[torch.Tensor] = []
2140
2141

            # EVS-related change.
2142
            # (ekhvedchenia): Temporary hack to limit peak memory usage when
2143
            # processing multimodal data. This solves the issue with scheduler
2144
2145
2146
2147
            # 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)
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
            # TODO(ywang96): Fix memory profiling to take EVS into account and
            # remove this hack.
            if (
                self.is_multimodal_pruning_enabled
                and modality == "video"
                and num_items > 1
            ):
                for video_mm_kwargs_item in filter(
                    lambda item: item.modality == "video", mm_kwargs
                ):
                    _, _, micro_batch_mm_inputs = next(
                        group_mm_kwargs_by_modality(
                            [video_mm_kwargs_item],
                            device=self.device,
                            pin_memory=self.pin_memory,
                        )
2164
                    )
2165

2166
                    micro_batch_outputs = model.embed_multimodal(
2167
2168
                        **micro_batch_mm_inputs
                    )
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178

                    curr_group_outputs.extend(micro_batch_outputs)
            else:
                # Run the encoder.
                # `curr_group_outputs` is either of the following:
                # 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.
2179
                curr_group_outputs = model.embed_multimodal(**mm_kwargs_group)  # type: ignore[assignment]
2180

2181
2182
            sanity_check_mm_encoder_outputs(
                curr_group_outputs,
2183
                expected_num_items=num_items,
2184
            )
2185
            encoder_outputs.extend(curr_group_outputs)
2186

2187
2188
2189
        # Cache the encoder outputs by mm_hash
        for (mm_hash, pos_info), output in zip(mm_hashes_pos, encoder_outputs):
            self.encoder_cache[mm_hash] = scatter_mm_placeholders(
2190
2191
2192
                output,
                is_embed=pos_info.is_embed,
            )
2193
2194
            logger.debug("Finish execute for mm hash %s", mm_hash)
            self.maybe_save_ec_to_connector(self.encoder_cache, mm_hash)
2195

2196
2197
        return encoder_outputs

2198
    def _gather_mm_embeddings(
2199
2200
        self,
        scheduler_output: "SchedulerOutput",
2201
        shift_computed_tokens: int = 0,
2202
2203
2204
2205
2206
2207
2208
2209
    ) -> tuple[list[torch.Tensor], torch.Tensor]:
        total_num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens

        mm_embeds = list[torch.Tensor]()
        is_mm_embed = self.is_mm_embed.cpu
        is_mm_embed[:total_num_scheduled_tokens] = False

        req_start_idx = 0
2210
        should_sync_mrope_positions = False
2211
        should_sync_xdrope_positions = False
2212

2213
        for req_id in self.input_batch.req_ids:
2214
2215
            mm_embeds_req: list[torch.Tensor] = []

2216
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2217
            req_state = self.requests[req_id]
2218
            num_computed_tokens = req_state.num_computed_tokens + shift_computed_tokens
2219

2220
2221
            for mm_feature in req_state.mm_features:
                pos_info = mm_feature.mm_position
2222
2223
                start_pos = pos_info.offset
                num_encoder_tokens = pos_info.length
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239

                # 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,
2240
2241
                    num_encoder_tokens,
                )
2242
                assert start_idx < end_idx
2243

2244
                mm_hash = mm_feature.identifier
2245
                encoder_output = self.encoder_cache.get(mm_hash, None)
2246
                assert encoder_output is not None, f"Encoder cache miss for {mm_hash}."
2247
2248
2249
2250

                if (is_embed := pos_info.is_embed) is not None:
                    is_embed = is_embed[start_idx:end_idx]

2251
                req_start_pos = req_start_idx + start_pos - num_computed_tokens
2252
2253
2254
                is_mm_embed[req_start_pos + start_idx : req_start_pos + end_idx] = (
                    True if is_embed is None else is_embed
                )
2255

2256
2257
2258
2259
                mm_embeds_item = gather_mm_placeholders(
                    encoder_output[start_idx:end_idx],
                    is_embed=is_embed,
                )
2260
2261
2262
                mm_embeds_req.append(mm_embeds_item)

            if self.is_multimodal_pruning_enabled and self.uses_mrope:
2263
                assert req_state.mrope_positions is not None
2264
2265
2266
2267
2268
2269
2270
                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,
2271
2272
                    )
                )
2273
2274
2275
2276
                req_state.mrope_positions.copy_(new_mrope_positions)
                req_state.mrope_position_delta = new_delta

            mm_embeds.extend(mm_embeds_req)
2277
2278
2279
            req_start_idx += num_scheduled_tokens

        is_mm_embed = self.is_mm_embed.copy_to_gpu(total_num_scheduled_tokens)
2280
2281
2282

        if should_sync_mrope_positions:
            self._calc_mrope_positions(scheduler_output)
2283
            self.mrope_positions.copy_to_gpu(total_num_scheduled_tokens)
2284

2285
2286
2287
2288
        if should_sync_xdrope_positions:
            self._calc_xdrope_positions(scheduler_output)
            self.xdrope_positions.copy_to_gpu(total_num_scheduled_tokens)

2289
        return mm_embeds, is_mm_embed
2290

2291
    def get_model(self) -> nn.Module:
2292
        # get raw model out of the cudagraph wrapper.
2293
        if isinstance(self.model, (CUDAGraphWrapper, UBatchWrapper)):
2294
            return self.model.unwrap()
2295
2296
        return self.model

2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
    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")

        return supported_tasks

2312
2313
2314
2315
2316
    def get_supported_pooling_tasks(self) -> list[PoolingTask]:
        model = self.get_model()
        if not is_pooling_model(model):
            return []

2317
2318
        supported_tasks = list(model.pooler.get_supported_tasks())

2319
2320
2321
2322
        if "score" in supported_tasks:
            num_labels = getattr(self.model_config.hf_config, "num_labels", 0)
            if num_labels != 1:
                supported_tasks.remove("score")
2323
                logger.debug_once("Score API is only enabled for num_labels == 1.")
2324
2325

        return supported_tasks
2326

2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
    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)

2337
    def sync_and_slice_intermediate_tensors(
2338
2339
        self,
        num_tokens: int,
2340
        intermediate_tensors: IntermediateTensors | None,
2341
2342
        sync_self: bool,
    ) -> IntermediateTensors:
2343
2344
2345
        assert self.intermediate_tensors is not None

        tp = self.vllm_config.parallel_config.tensor_parallel_size
2346
        is_rs = is_residual_scattered_for_sp(self.vllm_config, num_tokens)
2347
2348
2349
2350
2351
2352

        # 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():
2353
                is_scattered = k == "residual" and is_rs
2354
                copy_len = num_tokens // tp if is_scattered else num_tokens
2355
                self.intermediate_tensors[k][:copy_len].copy_(
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
                    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:
2369
2370
2371
2372
2373
2374
2375
        """
        Step for the EPLB (Expert Parallelism Load Balancing) state.
        """
        if not self.parallel_config.enable_eplb:
            return

        assert self.eplb_state is not None
2376
2377
        model = self.get_model()
        assert is_mixture_of_experts(model)
2378
2379
2380
        self.eplb_state.step(
            is_dummy,
            is_profile,
2381
            log_stats=self.parallel_config.eplb_config.log_balancedness,
2382
2383
        )

2384
2385
2386
2387
2388
2389
    def _pool(
        self,
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
        num_scheduled_tokens_np: np.ndarray,
    ) -> ModelRunnerOutput:
2390
2391
2392
        assert self.input_batch.num_reqs == len(self.input_batch.pooling_params), (
            "Either all or none of the requests in a batch must be pooling request"
        )
2393

2394
        hidden_states = hidden_states[:num_scheduled_tokens]
2395
2396
        seq_lens_cpu = self.seq_lens.cpu[: self.input_batch.num_reqs]

2397
        pooling_metadata = self.input_batch.get_pooling_metadata()
2398
        pooling_metadata.build_pooling_cursor(
2399
            num_scheduled_tokens_np.tolist(), seq_lens_cpu, device=hidden_states.device
2400
        )
2401

2402
2403
2404
2405
2406
2407
        model = cast(VllmModelForPooling, self.model)
        raw_pooler_output: PoolerOutput = model.pooler(
            hidden_states=hidden_states,
            pooling_metadata=pooling_metadata,
        )
        raw_pooler_output = json_map_leaves(
2408
            lambda x: x.to("cpu", non_blocking=True) if x is not None else x,
2409
2410
2411
            raw_pooler_output,
        )
        self._sync_device()
2412

2413
        pooler_output: list[torch.Tensor | None] = []
2414
        for raw_output, seq_len, prompt_len in zip(
2415
2416
            raw_pooler_output, seq_lens_cpu, pooling_metadata.prompt_lens
        ):
2417
            output = raw_output if seq_len == prompt_len else None
2418
            pooler_output.append(output)
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428

        return ModelRunnerOutput(
            req_ids=self.input_batch.req_ids,
            req_id_to_index=self.input_batch.req_id_to_index,
            sampled_token_ids=[],
            logprobs=None,
            prompt_logprobs_dict={},
            pooler_output=pooler_output,
        )

2429
    def _pad_for_sequence_parallelism(self, num_scheduled_tokens: int) -> int:
2430
2431
2432
        # Pad tokens to multiple of tensor_parallel_size when
        # enabled collective fusion for SP
        tp_size = self.vllm_config.parallel_config.tensor_parallel_size
2433
        if self.compilation_config.pass_config.enable_sp and tp_size > 1:
2434
2435
2436
            return round_up(num_scheduled_tokens, tp_size)
        return num_scheduled_tokens

2437
    def _preprocess(
2438
2439
        self,
        scheduler_output: "SchedulerOutput",
2440
        num_input_tokens: int,  # Padded
2441
        intermediate_tensors: IntermediateTensors | None = None,
2442
    ) -> tuple[
2443
2444
        torch.Tensor | None,
        torch.Tensor | None,
2445
        torch.Tensor,
2446
        IntermediateTensors | None,
2447
        dict[str, Any],
2448
        ECConnectorOutput | None,
2449
    ]:
2450
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2451
        is_first_rank = get_pp_group().is_first_rank
2452
        is_encoder_decoder = self.model_config.is_encoder_decoder
2453

2454
2455
        # _prepare_inputs may reorder the batch, so we must gather multi
        # modal outputs after that to ensure the correct order
2456
2457
        ec_connector_output = None

2458
        if self.supports_mm_inputs and is_first_rank and not is_encoder_decoder:
2459
            # Run the multimodal encoder if any.
2460
2461
2462
2463
2464
2465
            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)
2466

2467
2468
2469
            # 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.
2470
            inputs_embeds_scheduled = self.model.embed_input_ids(
2471
2472
2473
                self.input_ids.gpu[:num_scheduled_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
2474
            )
2475

2476
            # TODO(woosuk): Avoid the copy. Optimize.
2477
            self.inputs_embeds.gpu[:num_scheduled_tokens].copy_(inputs_embeds_scheduled)
2478

2479
            input_ids = None
2480
            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
2481
2482
2483
2484
            model_kwargs = {
                **self._init_model_kwargs(num_scheduled_tokens),
                **self._extract_mm_kwargs(scheduler_output),
            }
2485
        elif self.enable_prompt_embeds and is_first_rank:
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
            # 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).
2498
2499
2500
            token_ids_idx = (
                self.is_token_ids.gpu[:num_scheduled_tokens]
                .nonzero(as_tuple=False)
2501
                .squeeze(1)
2502
            )
2503
2504
2505
            # Some tokens ids may need to become embeds
            if token_ids_idx.numel() > 0:
                token_ids = self.input_ids.gpu[token_ids_idx]
2506
                tokens_to_embeds = self.model.embed_input_ids(input_ids=token_ids)
2507
2508
2509
2510
2511
                self.inputs_embeds.gpu[token_ids_idx] = tokens_to_embeds

            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
            model_kwargs = self._init_model_kwargs(num_input_tokens)
            input_ids = None
2512
        else:
2513
2514
2515
2516
            # 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.
2517
            input_ids = self.input_ids.gpu[:num_input_tokens]
2518
            inputs_embeds = None
2519
            model_kwargs = self._init_model_kwargs(num_input_tokens)
2520

2521
        if self.uses_mrope:
2522
            positions = self.mrope_positions.gpu[:, :num_input_tokens]
2523
2524
        elif self.uses_xdrope_dim > 0:
            positions = self.xdrope_positions.gpu[:, :num_input_tokens]
2525
        else:
2526
            positions = self.positions.gpu[:num_input_tokens]
2527

2528
        if is_first_rank:
2529
2530
            intermediate_tensors = None
        else:
2531
            assert intermediate_tensors is not None
2532
            intermediate_tensors = self.sync_and_slice_intermediate_tensors(
2533
2534
                num_input_tokens, intermediate_tensors, True
            )
2535

2536
        if is_encoder_decoder and scheduler_output.scheduled_encoder_inputs:
2537
2538
2539
2540
2541
2542
2543
            # 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})
2544

2545
2546
2547
2548
2549
2550
        return (
            input_ids,
            inputs_embeds,
            positions,
            intermediate_tensors,
            model_kwargs,
2551
            ec_connector_output,
2552
        )
2553

2554
    def _sample(
2555
        self,
2556
2557
        logits: torch.Tensor | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
2558
    ) -> SamplerOutput:
2559
        # Sample the next token and get logprobs if needed.
2560
        sampling_metadata = self.input_batch.sampling_metadata
2561
        if spec_decode_metadata is None:
2562
2563
2564
            # 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()
2565
            return self.sampler(
2566
2567
2568
                logits=logits,
                sampling_metadata=sampling_metadata,
            )
2569

2570
        sampler_output = self.rejection_sampler(
2571
2572
            spec_decode_metadata,
            None,  # draft_probs
2573
            logits,
2574
2575
            sampling_metadata,
        )
2576
        self._update_states_after_model_execute(sampler_output.sampled_token_ids)
2577
2578
2579
        return sampler_output

    def _bookkeeping_sync(
2580
2581
2582
        self,
        scheduler_output: "SchedulerOutput",
        sampler_output: SamplerOutput,
2583
        logits: torch.Tensor | None,
2584
2585
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
2586
        spec_decode_metadata: SpecDecodeMetadata | None,
2587
    ) -> tuple[
2588
        dict[str, int],
2589
        LogprobsLists | None,
2590
        list[list[int]],
2591
        dict[str, LogprobsTensors | None],
2592
2593
2594
        list[str],
        dict[str, int],
        list[int],
2595
    ]:
2596
2597
2598
2599
        num_nans_in_logits = {}
        if envs.VLLM_COMPUTE_NANS_IN_LOGITS:
            num_nans_in_logits = self._get_nans_in_logits(logits)

2600
2601
2602
2603
        num_reqs = self.input_batch.num_reqs
        discard_sampled_tokens_req_indices = np.nonzero(
            self.discard_request_mask.np[:num_reqs]
        )[0]
2604
2605
2606
2607
        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)
2608

2609
2610
2611
        # 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()
2612
        req_id_to_index_output_copy = self.input_batch.req_id_to_index.copy()
2613
2614

        num_sampled_tokens = sampler_output.sampled_token_ids.shape[0]
2615
        sampled_token_ids = sampler_output.sampled_token_ids
2616
        logprobs_tensors = sampler_output.logprobs_tensors
2617
        invalid_req_indices = []
2618
        cu_num_tokens: list[int] | None = None
2619
2620
2621
2622
2623
2624
        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)
2625
2626
2627
                # 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()
2628
2629
            else:
                # Includes spec decode tokens.
2630
                valid_sampled_token_ids, cu_num_tokens = RejectionSampler.parse_output(
2631
2632
                    sampled_token_ids,
                    self.input_batch.vocab_size,
2633
2634
                    discard_sampled_tokens_req_indices,
                    return_cu_num_tokens=logprobs_tensors is not None,
2635
                )
2636
        else:
2637
            valid_sampled_token_ids = []
2638
            invalid_req_indices = discard_sampled_tokens_req_indices.tolist()
2639
2640
2641
2642
2643
            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.
2644
2645
2646
2647
            # 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
2648
2649
2650
2651
2652
            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
            }
2653

2654
2655
2656
2657
2658
        # 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.
2659
        req_ids = self.input_batch.req_ids
2660
2661
        for req_idx in range(num_sampled_tokens):
            if self.use_async_scheduling:
2662
                sampled_ids = [-1] if req_idx not in invalid_req_indices_set else None
2663
2664
            else:
                sampled_ids = valid_sampled_token_ids[req_idx]
2665

2666
            num_sampled_ids: int = len(sampled_ids) if sampled_ids else 0
2667

2668
            if not sampled_ids:
2669
2670
2671
                continue

            start_idx = self.input_batch.num_tokens_no_spec[req_idx]
2672
            end_idx = start_idx + num_sampled_ids
2673
2674
2675
2676
            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}"
2677
            )
2678

2679
2680
            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
2681
2682
            self.input_batch.num_tokens_no_spec[req_idx] = end_idx
            self.input_batch.num_tokens[req_idx] = end_idx
2683

2684
            req_id = req_ids[req_idx]
2685
2686
2687
            req_state = self.requests[req_id]
            req_state.output_token_ids.extend(sampled_ids)

2688
        logprobs_lists = (
2689
            logprobs_tensors.tolists(cu_num_tokens)
2690
            if not self.use_async_scheduling and logprobs_tensors is not None
2691
2692
2693
2694
2695
2696
2697
2698
2699
            else None
        )

        # Compute prompt logprobs if needed.
        prompt_logprobs_dict = self._get_prompt_logprobs_dict(
            hidden_states[:num_scheduled_tokens],
            scheduler_output.num_scheduled_tokens,
        )

2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
        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,
        )

2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
    @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()

2725
2726
    def _model_forward(
        self,
2727
2728
2729
2730
        input_ids: torch.Tensor | None = None,
        positions: torch.Tensor | None = None,
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
2731
2732
2733
2734
2735
        **model_kwargs: dict[str, Any],
    ) -> Any:
        """Helper method to call the model forward pass.

        This method can be overridden by subclasses for model execution.
2736
        Motivation: We can inspect only this method versus
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
        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,
        )

2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
    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,
2770
        num_encoder_reqs: int = 0,
2771
    ) -> tuple[
2772
2773
        CUDAGraphMode,
        BatchDescriptor,
2774
        bool,
2775
2776
        torch.Tensor | None,
        CUDAGraphStat | None,
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
    ]:
        num_tokens_padded = self._pad_for_sequence_parallelism(num_tokens)
        uniform_decode = (
            (
                (max_num_scheduled_tokens == self.uniform_decode_query_len)
                and (num_tokens_padded == max_num_scheduled_tokens * num_reqs)
            )
            if force_uniform_decode is None
            else force_uniform_decode
        )
2787
2788
2789
2790
2791
        # 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
        )
2792
2793
2794
2795
2796
2797
2798
2799

        has_lora = (
            len(self.input_batch.lora_id_to_lora_request) > 0
            if force_has_lora is None
            else force_has_lora
        )

        dispatch_cudagraph = (
2800
            lambda num_tokens, disable_full: self.cudagraph_dispatcher.dispatch(
2801
2802
2803
                num_tokens=num_tokens,
                has_lora=has_lora,
                uniform_decode=uniform_decode,
2804
                disable_full=disable_full,
2805
2806
2807
2808
2809
            )
            if not force_eager
            else (CUDAGraphMode.NONE, BatchDescriptor(num_tokens_padded))
        )

2810
        cudagraph_mode, batch_descriptor = dispatch_cudagraph(
2811
            num_tokens_padded, use_cascade_attn or has_encoder_output
2812
        )
2813
2814
2815
2816
        num_tokens_padded = batch_descriptor.num_tokens

        # Extra coordination when running data-parallel since we need to coordinate
        # across ranks
2817
        should_ubatch, num_tokens_across_dp = False, None
2818
2819
2820
2821
2822
2823
2824
2825
2826
        if self.vllm_config.parallel_config.data_parallel_size > 1:
            # Disable DP padding when running eager to avoid excessive padding when
            # running prefills. This lets us set cudagraph_mode="NONE" on the prefiller
            # in a P/D setup and still use CUDA graphs (enabled by this padding) on the
            # decoder.
            allow_dp_padding = (
                self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            )

2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
            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,
                    allow_dp_padding=allow_dp_padding,
                    num_tokens_padded=num_tokens_padded,
                    uniform_decode=uniform_decode,
                    num_scheduled_tokens_per_request=num_scheduled_tokens_np,
                    cudagraph_mode=cudagraph_mode.value,
                )
2838
2839
            )

2840
            # Extract DP-synced values
2841
2842
2843
            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())
2844
2845
2846
2847
2848
                # Re-dispatch with DP padding so we have the correct batch_descriptor
                cudagraph_mode, batch_descriptor = dispatch_cudagraph(
                    num_tokens_padded,
                    disable_full=synced_cudagraph_mode <= CUDAGraphMode.PIECEWISE.value,
                )
2849
2850
2851
2852
                # 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

2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
        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,
2865
            should_ubatch,
2866
2867
2868
            num_tokens_across_dp,
            cudagraph_stats,
        )
2869

2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
    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

2906
2907
2908
2909
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: "SchedulerOutput",
2910
        intermediate_tensors: IntermediateTensors | None = None,
2911
2912
2913
2914
2915
2916
    ) -> ModelRunnerOutput | IntermediateTensors | None:
        if self.execute_model_state is not None:
            raise RuntimeError(
                "State error: sample_tokens() must be called "
                "after execute_model() returns None."
            )
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931

        # self._draft_token_ids is None when `input_fits_in_drafter=False`
        # and there is no draft tokens scheduled. so it need to update the
        # spec_decoding info in scheduler_output with async_scheduling.
        # use deepcopy to avoid the modification has influence on the
        # scheduler_output in engine core process.
        # TODO(Ronald1995): deepcopy is expensive when there is a large
        # number of requests, optimize it later.
        if (
            self.use_async_scheduling
            and self.num_spec_tokens
            and self._draft_token_ids is None
        ):
            scheduler_output = deepcopy(scheduler_output)

2932
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2933
        with record_function_or_nullcontext("gpu_model_runner: preprocess"):
2934
2935
2936
2937
            with self.synchronize_input_prep():
                # Update persistent batch states.
                self._update_states(scheduler_output)

2938
2939
2940
2941
2942
2943
2944
2945
                if has_ec_transfer() and get_ec_transfer().is_producer:
                    with self.maybe_get_ec_connector_output(
                        scheduler_output,
                        encoder_cache=self.encoder_cache,
                    ) as ec_connector_output:
                        self._execute_mm_encoder(scheduler_output)
                        return make_empty_encoder_model_runner_output(scheduler_output)

2946
                if not num_scheduled_tokens:
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
                    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.
2958
                        self._dummy_run(1)
2959
2960
2961
2962
                    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(
2963
2964
                        scheduler_output, self.vllm_config
                    )
2965
                if self.cache_config.kv_sharing_fast_prefill:
2966
                    assert not self.num_prompt_logprobs, (
2967
2968
                        "--kv-sharing-fast-prefill produces incorrect "
                        "logprobs for prompt tokens, tokens, please disable "
2969
2970
                        "it when the requests need prompt logprobs"
                    )
2971

2972
2973
2974
2975
2976
                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())
2977
                num_tokens_unpadded = scheduler_output.total_num_scheduled_tokens
2978

2979
2980
2981
                (
                    logits_indices,
                    spec_decode_metadata,
2982
                ) = self._prepare_inputs(
2983
2984
                    scheduler_output,
                    num_scheduled_tokens_np,
2985
2986
2987
2988
                )

                cascade_attn_prefix_lens = None
                # Disable cascade attention when using microbatching (DBO)
2989
                if self.cascade_attn_enabled and not self.parallel_config.enable_dbo:
2990
2991
2992
                    # Pre-compute cascade attention prefix lengths
                    cascade_attn_prefix_lens = self._compute_cascade_attn_prefix_lens(
                        num_scheduled_tokens_np,
2993
                        self.input_batch.num_computed_tokens_cpu[:num_reqs],
2994
2995
2996
                        scheduler_output.num_common_prefix_blocks,
                    )

2997
2998
2999
                (
                    cudagraph_mode,
                    batch_desc,
3000
                    should_ubatch,
3001
                    num_tokens_across_dp,
3002
                    cudagraph_stats,
3003
3004
3005
3006
3007
3008
                ) = 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,
3009
                    num_encoder_reqs=len(scheduler_output.scheduled_encoder_inputs),
3010
3011
3012
3013
                )

                logger.debug(
                    "Running batch with cudagraph_mode: %s, batch_descriptor: %s, "
3014
                    "should_ubatch: %s, num_tokens_across_dp: %s",
3015
3016
                    cudagraph_mode,
                    batch_desc,
3017
                    should_ubatch,
3018
3019
3020
3021
3022
3023
3024
                    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
                )
3025
3026
3027
3028
3029
3030
                ubatch_slices, ubatch_slices_padded = maybe_create_ubatch_slices(
                    should_ubatch,
                    num_scheduled_tokens_np,
                    num_tokens_padded,
                    num_reqs_padded,
                )
3031

3032
3033
                pad_attn = cudagraph_mode == CUDAGraphMode.FULL

3034
3035
3036
                use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
                ubatch_slices_attn = ubatch_slices_padded if pad_attn else ubatch_slices

3037
                (attn_metadata, spec_decode_common_attn_metadata) = (
3038
                    self._build_attention_metadata(
3039
3040
                        num_tokens=num_tokens_unpadded,
                        num_tokens_padded=num_tokens_padded if pad_attn else None,
3041
                        num_reqs=num_reqs,
3042
3043
                        num_reqs_padded=num_reqs_padded if pad_attn else None,
                        max_query_len=max_num_scheduled_tokens,
3044
                        ubatch_slices=ubatch_slices_attn,
3045
3046
                        logits_indices=logits_indices,
                        use_spec_decode=use_spec_decode,
3047
                        num_scheduled_tokens=scheduler_output.num_scheduled_tokens,
3048
3049
3050
                        cascade_attn_prefix_lens=cascade_attn_prefix_lens,
                    )
                )
3051

3052
3053
3054
3055
3056
3057
3058
3059
3060
            (
                input_ids,
                inputs_embeds,
                positions,
                intermediate_tensors,
                model_kwargs,
                ec_connector_output,
            ) = self._preprocess(
                scheduler_output, num_tokens_padded, intermediate_tensors
3061
            )
3062

3063
        # Set cudagraph mode to none if calc_kv_scales is true.
3064
3065
3066
        # KV scales calculation involves dynamic operations that are incompatible
        # with CUDA graph capture.
        if self.calculate_kv_scales:
3067
            cudagraph_mode = CUDAGraphMode.NONE
3068
3069
            # Mark KV scales as calculated after the first forward pass
            self.calculate_kv_scales = False
3070

3071
3072
        # Run the model.
        # Use persistent buffers for CUDA graphs.
3073
3074
        with (
            set_forward_context(
3075
3076
                attn_metadata,
                self.vllm_config,
3077
                num_tokens=num_tokens_padded,
3078
                num_tokens_across_dp=num_tokens_across_dp,
3079
3080
                cudagraph_runtime_mode=cudagraph_mode,
                batch_descriptor=batch_desc,
3081
                ubatch_slices=ubatch_slices_padded,
3082
            ),
3083
            record_function_or_nullcontext("gpu_model_runner: forward"),
3084
3085
            self.maybe_get_kv_connector_output(scheduler_output) as kv_connector_output,
        ):
3086
            model_output = self._model_forward(
3087
3088
3089
3090
3091
3092
3093
                input_ids=input_ids,
                positions=positions,
                intermediate_tensors=intermediate_tensors,
                inputs_embeds=inputs_embeds,
                **model_kwargs,
            )

3094
        with record_function_or_nullcontext("gpu_model_runner: postprocess"):
3095
            if self.use_aux_hidden_state_outputs:
3096
                # True when EAGLE 3 is used.
3097
3098
                hidden_states, aux_hidden_states = model_output
            else:
3099
                # Common case.
3100
3101
3102
                hidden_states = model_output
                aux_hidden_states = None

3103
3104
3105
3106
3107
            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)
3108
                    hidden_states.kv_connector_output = kv_connector_output
3109
                    self.kv_connector_output = kv_connector_output
3110
                    return hidden_states
3111

3112
                if self.is_pooling_model:
3113
                    # Return the pooling output.
3114
3115
3116
                    output = self._pool(
                        hidden_states, num_scheduled_tokens, num_scheduled_tokens_np
                    )
3117
3118
                    output.kv_connector_output = kv_connector_output
                    return output
3119
3120

                sample_hidden_states = hidden_states[logits_indices]
3121
                logits = self.model.compute_logits(sample_hidden_states)
3122
3123
3124
3125
            else:
                # Rare case.
                assert not self.is_pooling_model

3126
                sample_hidden_states = hidden_states[logits_indices]
3127
                if not get_pp_group().is_last_rank:
3128
                    all_gather_tensors = {
3129
                        "residual": not is_residual_scattered_for_sp(
3130
                            self.vllm_config, num_tokens_padded
3131
                        )
3132
                    }
3133
                    get_pp_group().send_tensor_dict(
3134
3135
                        hidden_states.tensors,
                        all_gather_group=get_tp_group(),
3136
3137
                        all_gather_tensors=all_gather_tensors,
                    )
3138
3139
                    logits = None
                else:
3140
                    logits = self.model.compute_logits(sample_hidden_states)
3141

3142
                model_output_broadcast_data: dict[str, Any] = {}
3143
3144
3145
                if logits is not None:
                    model_output_broadcast_data["logits"] = logits.contiguous()

3146
                broadcasted = get_pp_group().broadcast_tensor_dict(
3147
3148
                    model_output_broadcast_data, src=len(get_pp_group().ranks) - 1
                )
3149
3150
                assert broadcasted is not None
                logits = broadcasted["logits"]
3151

3152
3153
3154
3155
3156
3157
3158
3159
        self.execute_model_state = ExecuteModelState(
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
3160
            ec_connector_output,
3161
            cudagraph_stats,
3162
        )
3163
        self.kv_connector_output = kv_connector_output
3164
3165
3166
3167
3168
3169
        return None

    @torch.inference_mode
    def sample_tokens(
        self, grammar_output: "GrammarOutput | None"
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors:
3170
3171
3172
        kv_connector_output = self.kv_connector_output
        self.kv_connector_output = None

3173
3174
        if self.execute_model_state is None:
            # Nothing to do (PP non-final rank case), output isn't used.
3175
            if not kv_connector_output:
3176
                return None  # type: ignore[return-value]
3177
3178
3179
3180
3181
3182
3183
3184
3185

            # 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
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195

        # Unpack ephemeral state.
        (
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
3196
            ec_connector_output,
3197
            cudagraph_stats,
3198
3199
3200
3201
3202
3203
3204
3205
3206
        ) = 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
            )
3207

3208
        with record_function_or_nullcontext("gpu_model_runner: sample"):
3209
3210
            sampler_output = self._sample(logits, spec_decode_metadata)

3211
3212
        self.input_batch.prev_sampled_token_ids = None

3213
        def propose_draft_token_ids(sampled_token_ids):
3214
            assert spec_decode_common_attn_metadata is not None
3215
            with record_function_or_nullcontext("gpu_model_runner: draft"):
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
                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,
                )

3227
        spec_config = self.speculative_config
3228
        use_padded_batch_for_eagle = (
3229
3230
3231
            spec_config is not None
            and spec_config.use_eagle()
            and not spec_config.disable_padded_drafter_batch
3232
        )
3233
3234
3235
        effective_drafter_max_model_len = self.max_model_len
        if effective_drafter_max_model_len is None:
            effective_drafter_max_model_len = self.model_config.max_model_len
3236
        if (
3237
3238
3239
            spec_config is not None
            and spec_config.draft_model_config is not None
            and spec_config.draft_model_config.max_model_len is not None
3240
        ):
3241
            effective_drafter_max_model_len = (
3242
                spec_config.draft_model_config.max_model_len
3243
            )
3244
        input_fits_in_drafter = spec_decode_common_attn_metadata and (
3245
            spec_decode_common_attn_metadata.max_seq_len + self.num_spec_tokens
3246
3247
            <= effective_drafter_max_model_len
        )
3248
        if use_padded_batch_for_eagle:
3249
3250
            assert self.speculative_config is not None
            assert isinstance(self.drafter, EagleProposer)
3251
3252
3253
3254
3255
3256
            sampled_token_ids = sampler_output.sampled_token_ids
            if input_fits_in_drafter:
                # EAGLE speculative decoding can use the GPU sampled tokens
                # as inputs, and does not need to wait for bookkeeping to finish.
                propose_draft_token_ids(sampled_token_ids)
            elif self.valid_sampled_token_count_event is not None:
3257
                assert spec_decode_common_attn_metadata is not None
3258
3259
3260
3261
3262
3263
                next_token_ids, valid_sampled_tokens_count = (
                    self.drafter.prepare_next_token_ids_padded(
                        spec_decode_common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
3264
                        self.discard_request_mask.gpu,
3265
3266
3267
3268
3269
                    )
                )
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
3270

3271
        with record_function_or_nullcontext("gpu_model_runner: bookkeep"):
3272
3273
3274
3275
3276
3277
3278
3279
            (
                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,
3280
3281
3282
3283
3284
            ) = self._bookkeeping_sync(
                scheduler_output,
                sampler_output,
                logits,
                hidden_states,
3285
                scheduler_output.total_num_scheduled_tokens,
3286
                spec_decode_metadata,
3287
            )
3288

3289
3290
3291
3292
3293
        if (
            self.speculative_config
            and not use_padded_batch_for_eagle
            and input_fits_in_drafter
        ):
3294
3295
3296
            # 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)
3297

3298
        with record_function_or_nullcontext("gpu_model_runner: eplb"):
3299
            self.eplb_step()
3300
3301
3302
3303
3304
3305
3306
3307
3308
        with record_function_or_nullcontext("gpu_model_runner: ModelRunnerOutput"):
            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,
                pooler_output=[],
                kv_connector_output=kv_connector_output,
3309
3310
3311
                ec_connector_output=ec_connector_output
                if self.supports_mm_inputs
                else None,
3312
                num_nans_in_logits=num_nans_in_logits,
3313
                cudagraph_stats=cudagraph_stats,
3314
            )
3315

3316
3317
        if not self.use_async_scheduling:
            return output
3318
3319
3320
3321
3322
3323
3324
3325
3326
        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,
                async_output_copy_stream=self.async_output_copy_stream,
3327
                vocab_size=self.input_batch.vocab_size,
3328
3329
3330
3331
3332
            )
        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
3333
            # any requests with sampling params that require output ids.
3334
3335
3336
3337
            self.input_batch.set_async_sampled_token_ids(
                async_output.sampled_token_ids_cpu,
                async_output.async_copy_ready_event,
            )
3338
3339
3340

        return async_output

3341
    def take_draft_token_ids(self) -> DraftTokenIds | None:
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
        if self._draft_token_ids is None:
            return None
        req_ids = self.input_batch.req_ids
        if isinstance(self._draft_token_ids, torch.Tensor):
            draft_token_ids = self._draft_token_ids.tolist()
        else:
            draft_token_ids = self._draft_token_ids
        self._draft_token_ids = None
        return DraftTokenIds(req_ids, draft_token_ids)

3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
    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
            counts_cpu[: counts.shape[0]].copy_(counts, non_blocking=True)
            self.valid_sampled_token_count_event.record()

        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
        if (
            self.valid_sampled_token_count_event is None
            or prev_sampled_token_ids is None
        ):
            return []

        counts_cpu = self.valid_sampled_token_count_cpu
        self.valid_sampled_token_count_event.synchronize()
        return counts_cpu[: prev_sampled_token_ids.shape[0]].tolist()

3383
3384
3385
    def propose_draft_token_ids(
        self,
        scheduler_output: "SchedulerOutput",
3386
        sampled_token_ids: torch.Tensor | list[list[int]],
3387
3388
3389
        sampling_metadata: SamplingMetadata,
        hidden_states: torch.Tensor,
        sample_hidden_states: torch.Tensor,
3390
3391
        aux_hidden_states: list[torch.Tensor] | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
3392
        common_attn_metadata: CommonAttentionMetadata,
3393
    ) -> list[list[int]] | torch.Tensor:
3394
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
3395
3396
3397
        spec_config = self.speculative_config
        assert spec_config is not None
        if spec_config.method == "ngram":
3398
            assert isinstance(sampled_token_ids, list)
3399
            assert isinstance(self.drafter, NgramProposer)
3400
            draft_token_ids = self.drafter.propose(
3401
3402
                sampled_token_ids,
                self.input_batch.req_ids,
3403
3404
                self.input_batch.num_tokens_no_spec,
                self.input_batch.token_ids_cpu,
3405
3406
                self.input_batch.spec_decode_unsupported_reqs,
            )
3407
        elif spec_config.method == "suffix":
3408
3409
3410
            assert isinstance(sampled_token_ids, list)
            assert isinstance(self.drafter, SuffixDecodingProposer)
            draft_token_ids = self.drafter.propose(self.input_batch, sampled_token_ids)
3411
        elif spec_config.method == "medusa":
3412
            assert isinstance(sampled_token_ids, list)
3413
            assert isinstance(self.drafter, MedusaProposer)
3414

3415
3416
            if sample_hidden_states.shape[0] == len(sampled_token_ids):
                # The input to the target model does not include draft tokens.
3417
3418
3419
3420
                hidden_states = sample_hidden_states
            else:
                indices = []
                offset = 0
3421
3422
3423
                assert spec_decode_metadata is not None, (
                    "No spec decode metadata for medusa"
                )
3424
                for num_draft, tokens in zip(
3425
3426
                    spec_decode_metadata.num_draft_tokens, sampled_token_ids
                ):
3427
                    indices.append(offset + len(tokens) - 1)
3428
                    offset += num_draft + 1
3429
                indices = torch.tensor(indices, device=self.device)
3430
3431
                hidden_states = sample_hidden_states[indices]

3432
            draft_token_ids = self.drafter.propose(
3433
3434
3435
                target_hidden_states=hidden_states,
                sampling_metadata=sampling_metadata,
            )
3436
        elif spec_config.use_eagle():
3437
            assert isinstance(self.drafter, EagleProposer)
3438

3439
            if spec_config.disable_padded_drafter_batch:
3440
3441
3442
                # 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.
3443
3444
                assert isinstance(sampled_token_ids, list), (
                    "sampled_token_ids should be a python list when"
3445
                    "padded-batch is disabled."
3446
                )
3447
                next_token_ids = self.drafter.prepare_next_token_ids_cpu(
3448
3449
3450
3451
3452
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    scheduler_output.num_scheduled_tokens,
                )
3453
3454
3455
3456
3457
            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.
3458
3459
                assert isinstance(sampled_token_ids, torch.Tensor), (
                    "sampled_token_ids should be a torch.Tensor when"
3460
                    "padded-batch is enabled."
3461
3462
                )
                next_token_ids, valid_sampled_tokens_count = (
3463
3464
3465
3466
3467
                    self.drafter.prepare_next_token_ids_padded(
                        common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
3468
                        self.discard_request_mask.gpu,
3469
                    )
3470
                )
3471
3472
3473
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
Jiayi Yao's avatar
Jiayi Yao committed
3474

3475
            if spec_decode_metadata is None:
3476
                token_indices_to_sample = None
3477
                # input_ids can be None for multimodal models.
3478
                target_token_ids = self.input_ids.gpu[:num_scheduled_tokens]
3479
                target_positions = self._get_positions(num_scheduled_tokens)
3480
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
3481
                    assert aux_hidden_states is not None
3482
                    target_hidden_states = torch.cat(
3483
3484
                        [h[:num_scheduled_tokens] for h in aux_hidden_states], dim=-1
                    )
3485
3486
                else:
                    target_hidden_states = hidden_states[:num_scheduled_tokens]
3487
            else:
3488
                if spec_config.disable_padded_drafter_batch:
3489
                    token_indices_to_sample = None
3490
3491
3492
3493
3494
                    common_attn_metadata, token_indices = self.drafter.prepare_inputs(
                        common_attn_metadata,
                        sampled_token_ids,
                        spec_decode_metadata.num_draft_tokens,
                    )
3495
3496
3497
3498
3499
3500
3501
3502
3503
                    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]
3504
                else:
3505
                    common_attn_metadata, token_indices_to_sample = (
3506
3507
3508
                        self.drafter.prepare_inputs_padded(
                            common_attn_metadata,
                            spec_decode_metadata,
3509
3510
3511
                            valid_sampled_tokens_count,
                        )
                    )
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
                    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]
3523

3524
            if self.supports_mm_inputs:
3525
3526
3527
3528
3529
3530
                mm_embed_inputs = self._gather_mm_embeddings(
                    scheduler_output,
                    shift_computed_tokens=1,
                )
            else:
                mm_embed_inputs = None
3531

3532
            draft_token_ids = self.drafter.propose(
3533
3534
3535
3536
                target_token_ids=target_token_ids,
                target_positions=target_positions,
                target_hidden_states=target_hidden_states,
                next_token_ids=next_token_ids,
3537
                last_token_indices=token_indices_to_sample,
3538
                sampling_metadata=sampling_metadata,
3539
                common_attn_metadata=common_attn_metadata,
3540
                mm_embed_inputs=mm_embed_inputs,
3541
            )
3542

3543
        return draft_token_ids
3544

3545
3546
3547
    def update_config(self, overrides: dict[str, Any]) -> None:
        allowed_config_names = {"load_config", "model_config"}
        for config_name, config_overrides in overrides.items():
3548
3549
            assert config_name in allowed_config_names, (
                f"Config `{config_name}` not supported. "
3550
                f"Allowed configs: {allowed_config_names}"
3551
            )
3552
3553
3554
3555
            config = getattr(self, config_name)
            new_config = update_config(config, config_overrides)
            setattr(self, config_name, new_config)

3556
3557
3558
3559
3560
    def load_model(self, eep_scale_up: bool = False) -> None:
        """
        Args:
            eep_scale_up: the model loading is for elastic EP scale up.
        """
3561
3562
3563
3564
3565
        logger.info_once(
            "Starting to load model %s...",
            self.model_config.model,
            scope="global",
        )
3566
3567
3568
3569
3570
        global_expert_loads, old_global_expert_indices_per_model, rank_mapping = (
            EplbState.get_eep_state(self.parallel_config)
            if eep_scale_up
            else (None, None, None)
        )
3571

3572
3573
3574
3575
        if self.parallel_config.enable_eplb:
            self.eplb_state = EplbState(self.parallel_config, self.device)
            eplb_models = 0

3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
        try:
            with DeviceMemoryProfiler() as m:
                time_before_load = time.perf_counter()
                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
3586
                    )
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
                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
                    ):
                        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,
                        )
3602

3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
                        global_expert_load = (
                            global_expert_loads[eplb_models]
                            if global_expert_loads
                            else None
                        )
                        old_global_expert_indices = (
                            old_global_expert_indices_per_model[eplb_models]
                            if old_global_expert_indices_per_model
                            else None
                        )
                        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,
                            global_expert_load,
                            old_global_expert_indices,
                            rank_mapping,
                        )
                        eplb_models += 1
3625

3626
3627
3628
3629
3630
3631
                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"
                        )
3632

3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
                    # 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:
                        aux_layers = self.model.get_eagle3_aux_hidden_state_layers()

                    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
3658
        logger.info_once(
3659
            "Model loading took %.4f GiB memory and %.6f seconds",
3660
3661
            self.model_memory_usage / GiB_bytes,
            time_after_load - time_before_load,
3662
            scope="local",
3663
        )
3664
        prepare_communication_buffer_for_model(self.model)
3665
3666
3667
3668
        if (drafter := getattr(self, "drafter", None)) and (
            drafter_model := getattr(drafter, "model", None)
        ):
            prepare_communication_buffer_for_model(drafter_model)
3669
        mm_config = self.model_config.multimodal_config
3670
        self.is_multimodal_pruning_enabled = (
3671
            supports_multimodal_pruning(self.get_model())
3672
3673
            and mm_config is not None
            and mm_config.is_multimodal_pruning_enabled()
3674
        )
3675

3676
        if is_mixture_of_experts(self.model) and self.parallel_config.enable_eplb:
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
            logger.info_once("EPLB is enabled for model %s.", self.model_config.model)
            global_expert_load = (
                global_expert_loads[eplb_models] if global_expert_loads else None
            )
            old_global_expert_indices = (
                old_global_expert_indices_per_model[eplb_models]
                if old_global_expert_indices_per_model
                else None
            )
            assert self.eplb_state is not None
            self.eplb_state.add_model(
3688
                self.model,
3689
                self.model_config,
3690
3691
3692
                global_expert_load,
                old_global_expert_indices,
                rank_mapping,
3693
            )
3694
3695
            if self.eplb_state.is_async:
                self.eplb_state.start_async_loop(rank_mapping=rank_mapping)
3696

3697
        if (
3698
3699
            self.vllm_config.compilation_config.mode
            == CompilationMode.STOCK_TORCH_COMPILE
3700
            and supports_dynamo()
3701
        ):
3702
            backend = self.vllm_config.compilation_config.init_backend(self.vllm_config)
3703
            compilation_counter.stock_torch_compile_count += 1
3704
            self.model.compile(fullgraph=True, backend=backend)
3705
            return
3706
        # for other compilation modes, cudagraph behavior is controlled by
3707
3708
3709
        # CudagraphWraper and CudagraphDispatcher of vllm.

        # wrap the model with full cudagraph wrapper if needed.
3710
3711
3712
        cudagraph_mode = self.compilation_config.cudagraph_mode
        assert cudagraph_mode is not None
        if cudagraph_mode.has_full_cudagraphs() and not self.parallel_config.enable_dbo:
3713
3714
3715
            self.model = CUDAGraphWrapper(
                self.model, self.vllm_config, runtime_mode=CUDAGraphMode.FULL
            )
3716
        elif self.parallel_config.enable_dbo:
3717
            if cudagraph_mode.has_full_cudagraphs():
3718
3719
3720
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.FULL, self.device
                )
3721
            else:
3722
3723
3724
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.NONE, self.device
                )
3725

3726
    def _get_eagle3_aux_layers_from_config(self) -> tuple[int, ...] | None:
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
        """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
        if not hasattr(hf_config, "eagle_aux_hidden_state_layer_ids"):
            return None

        layer_ids = hf_config.eagle_aux_hidden_state_layer_ids
        if layer_ids and isinstance(layer_ids, (list, tuple)):
            return tuple(layer_ids)

        return None

3750
    def reload_weights(self) -> None:
3751
        assert getattr(self, "model", None) is not None, (
3752
            "Cannot reload weights before model is loaded."
3753
        )
3754
3755
        model_loader = get_model_loader(self.load_config)
        logger.info("Reloading weights inplace...")
3756
        model_loader.load_weights(self.get_model(), model_config=self.model_config)
3757

3758
3759
3760
3761
3762
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        TensorizerLoader.save_model(
3763
            self.get_model(),
3764
            tensorizer_config=tensorizer_config,
3765
            model_config=self.model_config,
3766
3767
        )

3768
3769
3770
    def _get_prompt_logprobs_dict(
        self,
        hidden_states: torch.Tensor,
3771
        num_scheduled_tokens: dict[str, int],
3772
    ) -> dict[str, LogprobsTensors | None]:
3773
        num_prompt_logprobs_dict = self.num_prompt_logprobs
3774
3775
3776
        if not num_prompt_logprobs_dict:
            return {}

3777
        in_progress_dict = self.input_batch.in_progress_prompt_logprobs_cpu
3778
        prompt_logprobs_dict: dict[str, LogprobsTensors | None] = {}
3779
3780
3781
3782
3783

        # 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():
3784
3785
3786
3787
            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
3788
3789
3790

            # Get metadata for this request.
            request = self.requests[req_id]
3791
3792
3793
3794
            if request.prompt_token_ids is None:
                # Prompt logprobs is incompatible with prompt embeddings
                continue

3795
3796
            num_prompt_tokens = len(request.prompt_token_ids)
            prompt_token_ids = torch.tensor(request.prompt_token_ids).to(
3797
3798
                self.device, non_blocking=True
            )
3799

3800
3801
3802
3803
3804
3805
            # 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(
3806
3807
                    num_prompt_tokens - 1, num_prompt_logprobs + 1
                )
3808
3809
                in_progress_dict[req_id] = logprobs_tensors

3810
            # Determine number of logits to retrieve.
3811
3812
            start_idx = request.num_computed_tokens
            start_tok = start_idx + 1
3813
            num_remaining_tokens = num_prompt_tokens - start_tok
3814
            if num_tokens <= num_remaining_tokens:
3815
                # This is a chunk, more tokens remain.
3816
3817
3818
                # 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.
3819
3820
3821
3822
3823
                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)
3824
3825
3826
3827
3828
3829
3830
                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
3831
3832
3833
3834
3835

            # 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]
3836
            offset = self.query_start_loc.np[req_idx].item()
3837
            prompt_hidden_states = hidden_states[offset : offset + num_logits]
3838
            logits = self.model.compute_logits(prompt_hidden_states)
3839
3840
3841
3842

            # 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.
3843
            tgt_token_ids = prompt_token_ids[start_tok : start_tok + num_logits]
3844
3845

            # Compute prompt logprobs.
3846
3847
            logprobs = self.sampler.compute_logprobs(logits)
            token_ids, logprobs, ranks = self.sampler.gather_logprobs(
3848
3849
                logprobs, num_prompt_logprobs, tgt_token_ids
            )
3850
3851

            # Transfer GPU->CPU async.
3852
3853
            chunk_slice = slice(start_idx, start_idx + num_logits)
            logprobs_tensors.logprob_token_ids[chunk_slice].copy_(
3854
3855
3856
                token_ids, non_blocking=True
            )
            logprobs_tensors.logprobs[chunk_slice].copy_(logprobs, non_blocking=True)
3857
            logprobs_tensors.selected_token_ranks[chunk_slice].copy_(
3858
3859
                ranks, non_blocking=True
            )
3860
3861
3862
3863
3864

        # 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]
3865
            del in_progress_dict[req_id]
3866
3867

        # Must synchronize the non-blocking GPU->CPU transfers.
3868
        if prompt_logprobs_dict:
3869
            self._sync_device()
3870
3871
3872

        return prompt_logprobs_dict

3873
3874
    def _get_nans_in_logits(
        self,
3875
        logits: torch.Tensor | None,
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
    ) -> 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])
3887
3888
3889
                    if num_nans_for_index is not None and req_index < logits.shape[0]
                    else 0
                )
3890
3891
3892
3893
            return num_nans_in_logits
        except IndexError:
            return {}

3894
3895
3896
3897
3898
3899
    @contextmanager
    def maybe_randomize_inputs(self, input_ids: torch.Tensor):
        """
        Randomize input_ids if VLLM_RANDOMIZE_DP_DUMMY_INPUTS is set.
        This is to help balance expert-selection
         - during profile_run
3900
         - during DP rank dummy run
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
        """
        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
        else:
            import functools

            @functools.cache
            def rand_input_ids() -> torch.Tensor:
                return torch.randint_like(
3912
                    self.input_ids.gpu,
3913
3914
                    low=0,
                    high=self.model_config.get_vocab_size(),
3915
3916
                    dtype=input_ids.dtype,
                )
3917

3918
            logger.debug_once("Randomizing dummy data for DP Rank")
3919
            input_ids.copy_(rand_input_ids()[: input_ids.size(0)], non_blocking=True)
3920
3921
3922
            yield
            input_ids.fill_(0)

3923
3924
3925
3926
3927
3928
    def _get_mm_dummy_batch(
        self,
        modality: str,
        max_items_per_batch: int,
    ) -> BatchedTensorInputs:
        """Dummy data for profiling and precompiling multimodal models."""
3929
3930
        assert self.mm_budget is not None

3931
        dummy_decoder_data = self.mm_registry.get_decoder_dummy_data(
3932
            model_config=self.model_config,
3933
            seq_len=self.max_model_len,
3934
            mm_counts={modality: 1},
3935
            cache=self.mm_budget.cache,
3936
3937
3938
3939
        )
        dummy_mm_data = dummy_decoder_data.multi_modal_data

        # Result in the maximum GPU consumption of the model
3940
3941
        dummy_mm_item = dummy_mm_data[modality][0]
        dummy_mm_items = [dummy_mm_item] * max_items_per_batch
3942

3943
3944
3945
3946
3947
3948
3949
3950
        return next(
            mm_kwargs_group
            for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
                dummy_mm_items,
                device=self.device,
                pin_memory=self.pin_memory,
            )
        )
3951

3952
3953
3954
3955
    @torch.inference_mode()
    def _dummy_run(
        self,
        num_tokens: int,
3956
        cudagraph_runtime_mode: CUDAGraphMode | None = None,
3957
3958
        force_attention: bool = False,
        uniform_decode: bool = False,
3959
        allow_microbatching: bool = True,
3960
3961
        skip_eplb: bool = False,
        is_profile: bool = False,
3962
        create_mixed_batch: bool = False,
3963
        remove_lora: bool = True,
3964
        activate_lora: bool = False,
Rémi Delacourt's avatar
Rémi Delacourt committed
3965
        is_graph_capturing: bool = False,
3966
    ) -> tuple[torch.Tensor, torch.Tensor]:
3967
3968
3969
3970
3971
3972
3973
        """
        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.
3974
                - if not set will determine the cudagraph mode based on using
3975
                    the self.cudagraph_dispatcher.
3976
3977
3978
3979
                - CUDAGraphMode.NONE: No cudagraph, for warm up and profile run
                - CUDAGraphMode.PIECEWISE: Piecewise cudagraph.
                - CUDAGraphMode.FULL: Full cudagraph, attention metadata is
                    needed.
3980
            force_attention: If True, always create attention metadata. Used to
3981
3982
3983
3984
                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.
3985
3986
            create_mixed_batch: If True, create a mixed batch with both decode
                (1 token) and prefill (multiple tokens) requests.
3987
            remove_lora: If False, dummy LoRAs are not destroyed after the run
3988
            activate_lora: If False, dummy_run is performed without LoRAs.
3989
        """
3990
3991
3992
3993
        assert (
            cudagraph_runtime_mode is None
            or cudagraph_runtime_mode.valid_runtime_modes()
        )
3994

3995
        # If cudagraph_mode.decode_mode() == FULL and
3996
        # cudagraph_mode.separate_routine(). This means that we are using
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
        # 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.
4008
        max_query_len = self.uniform_decode_query_len if uniform_decode else num_tokens
4009

4010
4011
4012
4013
4014
        # 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.
        assert num_tokens <= self.scheduler_config.max_num_batched_tokens
        max_num_reqs = self.scheduler_config.max_num_seqs
4015
4016
4017
4018
        if create_mixed_batch:
            assert not uniform_decode
            # Create mixed batch:
            # first half decode tokens, second half one prefill
4019
            num_decode_tokens = min(max_num_reqs - 1, num_tokens // 2)
4020
4021
4022
4023
            num_prefill_tokens = num_tokens - num_decode_tokens
            num_reqs = num_decode_tokens + 1

            # Create decode requests (1 token each) followed by prefill request
4024
            num_scheduled_tokens_list = [1] * num_decode_tokens + [num_prefill_tokens]
4025
4026
4027
            # Note: Overriding max_query_len to be the prefill tokens
            max_query_len = num_prefill_tokens
        elif uniform_decode:
4028
            assert not create_mixed_batch
4029
            num_reqs = min(max_num_reqs, cdiv(num_tokens, max_query_len))
4030
4031
            num_scheduled_tokens_list = [max_query_len] * num_reqs
            if num_tokens % max_query_len != 0:
4032
                num_scheduled_tokens_list[-1] = num_tokens % max_query_len
4033
4034
4035
4036
4037
4038
        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

4039
4040
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs
4041
        num_scheduled_tokens = np.array(num_scheduled_tokens_list, dtype=np.int32)
4042
4043
        num_tokens_unpadded = int(num_scheduled_tokens.sum())

4044
        num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
4045

4046
        _cudagraph_mode, batch_desc, should_ubatch, num_tokens_across_dp, _ = (
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
            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
                force_has_lora=activate_lora,
4065
4066
            )
        )
4067
4068
4069

        if cudagraph_runtime_mode is None:
            cudagraph_runtime_mode = _cudagraph_mode
4070
        else:
4071
4072
4073
4074
4075
4076
4077
4078
4079
            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
        )
4080
4081
4082
        ubatch_slices, ubatch_slices_padded = maybe_create_ubatch_slices(
            should_ubatch, num_scheduled_tokens, num_tokens_padded, num_reqs_padded
        )
4083

4084
        attn_metadata: PerLayerAttnMetadata | None = None
4085
4086
4087

        # If force_attention is True, we always capture attention. Otherwise,
        # it only happens for cudagraph_runtime_mode=FULL.
4088
        if force_attention or cudagraph_runtime_mode == CUDAGraphMode.FULL:
4089
4090
4091
4092
4093
4094
            if create_mixed_batch:
                # 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
                seq_lens = [1] * num_decode_tokens + [num_prefill_tokens + 1]
            else:
4095
                seq_lens = max_query_len  # type: ignore[assignment]
4096
            self.seq_lens.np[:num_reqs] = seq_lens
4097
4098
            self.seq_lens.np[num_reqs:] = 0
            self.seq_lens.copy_to_gpu()
4099

4100
4101
            cum_num_tokens, _ = self._get_cumsum_and_arange(num_scheduled_tokens)
            self.query_start_loc.np[1 : num_reqs + 1] = cum_num_tokens
4102
4103
            self.query_start_loc.copy_to_gpu()

4104
            pad_attn = cudagraph_runtime_mode == CUDAGraphMode.FULL
4105
            attn_metadata, _ = self._build_attention_metadata(
4106
4107
4108
                num_tokens=num_tokens_unpadded,
                num_reqs=num_reqs_padded,
                max_query_len=max_query_len,
4109
                ubatch_slices=ubatch_slices_padded if pad_attn else ubatch_slices,
4110
                for_cudagraph_capture=is_graph_capturing,
4111
            )
4112

4113
        with self.maybe_dummy_run_with_lora(
4114
4115
4116
4117
4118
            self.lora_config,
            num_scheduled_tokens,
            num_sampled_tokens,
            activate_lora,
            remove_lora,
4119
        ):
4120
            # Make sure padding doesn't exceed max_num_tokens
4121
4122
            assert num_tokens_padded <= self.max_num_tokens
            model_kwargs = self._init_model_kwargs(num_tokens_padded)
4123
            if self.supports_mm_inputs and not self.model_config.is_encoder_decoder:
4124
                input_ids = None
4125
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_padded]
4126
                model_kwargs = {
4127
                    **model_kwargs,
4128
4129
                    **self._dummy_mm_kwargs(num_reqs),
                }
4130
4131
            elif self.enable_prompt_embeds:
                input_ids = None
4132
4133
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_padded]
                model_kwargs = self._init_model_kwargs(num_tokens_padded)
4134
            else:
4135
                input_ids = self.input_ids.gpu[:num_tokens_padded]
4136
                inputs_embeds = None
4137

4138
            if self.uses_mrope:
4139
                positions = self.mrope_positions.gpu[:, :num_tokens_padded]
4140
            elif self.uses_xdrope_dim > 0:
4141
                positions = self.xdrope_positions.gpu[:, :num_tokens_padded]
4142
            else:
4143
                positions = self.positions.gpu[:num_tokens_padded]
4144
4145
4146
4147
4148
4149
4150
4151
4152

            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,
4153
4154
4155
                            device=self.device,
                        )
                    )
4156
4157

                intermediate_tensors = self.sync_and_slice_intermediate_tensors(
4158
                    num_tokens_padded, None, False
4159
                )
4160

4161
            if ubatch_slices_padded is not None:
4162
4163
4164
                # Adjust values to reflect a single ubatch.
                # TODO(sage,lucas): this is cruft that should be addressed in
                #  the padding refactor.
4165
                num_tokens_padded = ubatch_slices_padded[0].num_tokens
4166
                if num_tokens_across_dp is not None:
4167
                    num_tokens_across_dp[:] = num_tokens_padded
4168

4169
4170
4171
            with (
                self.maybe_randomize_inputs(input_ids),
                set_forward_context(
4172
4173
                    attn_metadata,
                    self.vllm_config,
4174
                    num_tokens=num_tokens_padded,
4175
4176
                    num_tokens_across_dp=num_tokens_across_dp,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
4177
                    batch_descriptor=batch_desc,
4178
                    ubatch_slices=ubatch_slices_padded,
4179
4180
                ),
            ):
4181
                outputs = self.model(
4182
4183
4184
4185
                    input_ids=input_ids,
                    positions=positions,
                    intermediate_tensors=intermediate_tensors,
                    inputs_embeds=inputs_embeds,
4186
                    **model_kwargs,
4187
                )
4188

4189
4190
4191
4192
            if self.use_aux_hidden_state_outputs:
                hidden_states, _ = outputs
            else:
                hidden_states = outputs
4193

4194
            if self.speculative_config and self.speculative_config.use_eagle():
4195
                assert isinstance(self.drafter, EagleProposer)
4196
4197
4198
                # 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.
4199
                use_cudagraphs = (
4200
4201
4202
4203
4204
4205
4206
4207
4208
                    (
                        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
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219

                # 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
                if self.compilation_config.cudagraph_specialize_lora and activate_lora:
                    use_cudagraphs = False

                self.drafter.dummy_run(
                    num_tokens,
                    use_cudagraphs=use_cudagraphs,
Rémi Delacourt's avatar
Rémi Delacourt committed
4220
                    is_graph_capturing=is_graph_capturing,
4221
                )
4222

4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
        # 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()

4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
        # 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)

4244
        logit_indices = np.cumsum(num_scheduled_tokens) - 1
4245
4246
4247
4248
        logit_indices_device = torch.from_numpy(logit_indices).to(
            self.device, non_blocking=True
        )
        return hidden_states, hidden_states[logit_indices_device]
4249
4250
4251
4252
4253
4254

    @torch.inference_mode()
    def _dummy_sampler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> torch.Tensor:
4255
4256
4257
4258
        # The dummy hidden states may contain special values,
        # like `inf` or `nan`.
        # To avoid breaking the sampler, we use a random tensor here instead.
        hidden_states = torch.rand_like(hidden_states)
4259

4260
        logits = self.model.compute_logits(hidden_states)
4261
4262
        num_reqs = logits.size(0)

4263
        dummy_tensors = lambda v: torch.full((num_reqs,), v, device=self.device)
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278

        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,
            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)],
4279
            spec_token_ids=[[] for _ in range(num_reqs)],
4280
4281
            allowed_token_ids_mask=None,
            bad_words_token_ids={},
4282
            logitsprocs=LogitsProcessors(),
4283
        )
4284
        try:
4285
4286
4287
            sampler_output = self.sampler(
                logits=logits, sampling_metadata=dummy_metadata
            )
4288
        except RuntimeError as e:
4289
            if "out of memory" in str(e):
4290
4291
4292
4293
                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 "
4294
4295
                    "initializing the engine."
                ) from e
4296
4297
            else:
                raise e
4298
        if self.speculative_config:
4299
4300
            draft_token_ids = [[0] for _ in range(num_reqs)]
            dummy_spec_decode_metadata = SpecDecodeMetadata.make_dummy(
4301
4302
                draft_token_ids, self.device
            )
4303
4304
4305
4306
4307
4308

            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
4309
4310
4311
4312
4313
            logits = torch.randn(
                num_tokens + num_reqs,
                logits.shape[-1],
                device=self.device,
                dtype=logits.dtype,
4314
            )
4315
4316
4317
            self.rejection_sampler(
                dummy_spec_decode_metadata,
                draft_probs,
4318
                logits,
4319
4320
                dummy_metadata,
            )
4321
        return sampler_output
4322

4323
    def _dummy_pooler_run_task(
4324
4325
        self,
        hidden_states: torch.Tensor,
4326
4327
        task: PoolingTask,
    ) -> PoolerOutput:
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
        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
        num_scheduled_tokens_list = [min_tokens_per_req] * num_reqs
        num_scheduled_tokens_list[-1] += num_tokens % num_reqs
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs

        req_num_tokens = num_tokens // num_reqs

4339
        dummy_prompt_lens = torch.tensor(
4340
4341
            num_scheduled_tokens_list,
            device="cpu",
4342
        )
4343
4344
4345
        dummy_token_ids = torch.zeros(
            (num_reqs, req_num_tokens), dtype=torch.int32, device=self.device
        )
4346

4347
        model = cast(VllmModelForPooling, self.get_model())
4348
        dummy_pooling_params = PoolingParams(task=task)
4349
        dummy_pooling_params.verify(task=task, model_config=self.model_config)
4350
        to_update = model.pooler.get_pooling_updates(task)
4351
4352
        to_update.apply(dummy_pooling_params)

4353
        dummy_metadata = PoolingMetadata(
4354
4355
4356
            prompt_lens=dummy_prompt_lens,
            prompt_token_ids=dummy_token_ids,
            pooling_params=[dummy_pooling_params] * num_reqs,
4357
            pooling_states=[PoolingStates() for i in range(num_reqs)],
4358
        )
4359

4360
        dummy_metadata.build_pooling_cursor(
4361
4362
4363
            num_scheduled_tokens_list,
            seq_lens_cpu=dummy_prompt_lens,
            device=hidden_states.device,
4364
        )
4365

4366
        try:
4367
4368
4369
            return model.pooler(
                hidden_states=hidden_states, pooling_metadata=dummy_metadata
            )
4370
        except RuntimeError as e:
4371
            if "out of memory" in str(e):
4372
                raise RuntimeError(
4373
4374
4375
                    "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 "
4376
4377
                    "initializing the engine."
                ) from e
4378
4379
            else:
                raise e
4380
4381
4382
4383
4384
4385
4386

    @torch.inference_mode()
    def _dummy_pooler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> PoolerOutput:
        # Find the task that has the largest output for subsequent steps
4387
4388
4389
        supported_pooling_tasks = self.get_supported_pooling_tasks()

        if not supported_pooling_tasks:
4390
4391
4392
4393
4394
4395
            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."
            )
4396

4397
        output_size = dict[PoolingTask, float]()
4398
        for task in supported_pooling_tasks:
4399
4400
            # Run a full batch with each task to ensure none of them OOMs
            output = self._dummy_pooler_run_task(hidden_states, task)
4401
            output_size[task] = sum(o.nbytes for o in output)
4402
4403
4404
4405
            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)
4406

4407
    def profile_run(self) -> None:
4408
        # Profile with multimodal encoder & encoder cache.
4409
        if self.supports_mm_inputs:
4410
4411
            mm_config = self.model_config.multimodal_config
            if mm_config is not None and mm_config.skip_mm_profiling:
4412
                logger.info(
4413
                    "Skipping memory profiling for multimodal encoder and "
4414
4415
                    "encoder cache."
                )
4416
4417
4418
4419
4420
4421
4422
4423
            else:
                mm_budget = self.mm_budget
                assert mm_budget is not None

                if (encoder_budget := mm_budget.get_encoder_budget()) > 0:
                    # NOTE: Currently model is profiled with a single non-text
                    # modality with the max possible input tokens even when
                    # it supports multiple.
4424
                    dummy_modality = mm_budget.get_modality_with_max_tokens()
4425
4426
4427
                    max_mm_items_per_batch = mm_budget.max_items_per_batch_by_modality[
                        dummy_modality
                    ]
4428
4429
4430
4431
4432
4433
4434
4435
4436

                    logger.info(
                        "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,
                    )
4437

4438
4439
4440
4441
4442
                    # Create dummy batch of multimodal inputs.
                    batched_dummy_mm_inputs = self._get_mm_dummy_batch(
                        dummy_modality,
                        max_mm_items_per_batch,
                    )
4443

4444
                    # Run multimodal encoder.
4445
                    dummy_encoder_outputs = self.model.embed_multimodal(
4446
4447
                        **batched_dummy_mm_inputs
                    )
4448

4449
4450
4451
4452
                    sanity_check_mm_encoder_outputs(
                        dummy_encoder_outputs,
                        expected_num_items=max_mm_items_per_batch,
                    )
4453

4454
4455
4456
                    # NOTE: This happens when encoder cache needs to store
                    # the embeddings that encoder outputs are scattered onto.
                    # In this case we create dummy embeddings of size
4457
4458
                    # (max_tokens_for_modality, hidden_size) and scatter
                    # encoder output into it.
4459
                    encoder_output_shape = dummy_encoder_outputs[0].shape
4460
4461
4462
4463
4464
                    max_mm_tokens_per_item = mm_budget.max_tokens_by_modality[
                        dummy_modality
                    ]
                    if encoder_output_shape[0] < max_mm_tokens_per_item:
                        encoder_hidden_size = encoder_output_shape[-1]
4465
4466
4467
                        expanded_outputs = []
                        for output in dummy_encoder_outputs:
                            expanded = output.new_zeros(
4468
                                (max_mm_tokens_per_item, encoder_hidden_size)
4469
                            )
4470
4471
4472
4473
4474
4475
                            num_tokens = output.shape[0]
                            expanded[:num_tokens].copy_(output)
                            expanded_outputs.append(expanded)

                        dummy_encoder_outputs = expanded_outputs

4476
                    # Cache the dummy encoder outputs.
4477
                    self.encoder_cache["tmp"] = dict(enumerate(dummy_encoder_outputs))
4478

4479
        # Add `is_profile` here to pre-allocate communication buffers
4480
4481
4482
        hidden_states, last_hidden_states = self._dummy_run(
            self.max_num_tokens, is_profile=True
        )
4483
        if get_pp_group().is_last_rank:
4484
4485
4486
4487
            if self.is_pooling_model:
                output = self._dummy_pooler_run(hidden_states)
            else:
                output = self._dummy_sampler_run(last_hidden_states)
4488
        else:
4489
            output = None
4490
        self._sync_device()
4491
        del hidden_states, output
4492
        self.encoder_cache.clear()
4493
        gc.collect()
4494

4495
    def capture_model(self) -> int:
4496
        if self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE:
4497
            logger.warning(
4498
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
4499
4500
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
4501
            return 0
4502

4503
4504
        compilation_counter.num_gpu_runner_capture_triggers += 1

4505
4506
        start_time = time.perf_counter()

4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
        @contextmanager
        def freeze_gc():
            # Optimize garbage collection during CUDA graph capture.
            # Clean up, then freeze all remaining objects from being included
            # in future collections.
            gc.collect()
            should_freeze = not envs.VLLM_ENABLE_CUDAGRAPH_GC
            if should_freeze:
                gc.freeze()
            try:
                yield
            finally:
                if should_freeze:
                    gc.unfreeze()
4521
                    gc.collect()
4522

4523
4524
4525
        # 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.
4526
        set_cudagraph_capturing_enabled(True)
4527
        with freeze_gc(), graph_capture(device=self.device):
4528
            start_free_gpu_memory = torch.cuda.mem_get_info()[0]
4529
            cudagraph_mode = self.compilation_config.cudagraph_mode
4530
            assert cudagraph_mode is not None
4531
4532
4533
4534
4535
4536
4537
4538
4539

            if self.lora_config:
                if self.compilation_config.cudagraph_specialize_lora:
                    lora_cases = [True, False]
                else:
                    lora_cases = [True]
            else:
                lora_cases = [False]

4540
4541
            if cudagraph_mode.mixed_mode() != CUDAGraphMode.NONE:
                cudagraph_runtime_mode = cudagraph_mode.mixed_mode()
4542
                # make sure we capture the largest batch size first
4543
4544
4545
                compilation_cases = list(
                    product(reversed(self.cudagraph_batch_sizes), lora_cases)
                )
4546
4547
4548
                self._capture_cudagraphs(
                    compilation_cases,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
4549
4550
                    uniform_decode=False,
                )
4551

4552
4553
            # Capture full cudagraph for uniform decode batches if we
            # don't already have full mixed prefill-decode cudagraphs.
4554
4555
4556
4557
4558
4559
4560
            if (
                cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
                and cudagraph_mode.separate_routine()
            ):
                max_num_tokens = (
                    self.scheduler_config.max_num_seqs * self.uniform_decode_query_len
                )
4561
                decode_cudagraph_batch_sizes = [
4562
4563
                    x
                    for x in self.cudagraph_batch_sizes
4564
                    if max_num_tokens >= x >= self.uniform_decode_query_len
4565
                ]
4566
4567
4568
                compilation_cases_decode = list(
                    product(reversed(decode_cudagraph_batch_sizes), lora_cases)
                )
4569
4570
4571
                self._capture_cudagraphs(
                    compilation_cases=compilation_cases_decode,
                    cudagraph_runtime_mode=CUDAGraphMode.FULL,
4572
4573
                    uniform_decode=True,
                )
4574

4575
4576
4577
            torch.cuda.synchronize()
            end_free_gpu_memory = torch.cuda.mem_get_info()[0]

4578
4579
4580
        # 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
4581
        # we may do lazy capturing in future that still allows capturing
4582
4583
        # after here.
        set_cudagraph_capturing_enabled(False)
4584
4585
4586
4587
4588

        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.
4589
        logger.info_once(
4590
4591
4592
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
4593
            scope="local",
4594
        )
4595
        return cuda_graph_size
4596

4597
4598
    def _capture_cudagraphs(
        self,
4599
        compilation_cases: list[tuple[int, bool]],
4600
4601
4602
4603
4604
4605
4606
        cudagraph_runtime_mode: CUDAGraphMode,
        uniform_decode: bool,
    ):
        assert (
            cudagraph_runtime_mode != CUDAGraphMode.NONE
            and cudagraph_runtime_mode.valid_runtime_modes()
        ), f"Invalid cudagraph runtime mode: {cudagraph_runtime_mode}"
4607
4608
4609
4610
4611
4612
4613
4614

        # Only rank 0 should print progress bar during capture
        if is_global_first_rank():
            compilation_cases = tqdm(
                compilation_cases,
                disable=not self.load_config.use_tqdm_on_load,
                desc="Capturing CUDA graphs ({}, {})".format(
                    "decode" if uniform_decode else "mixed prefill-decode",
4615
4616
4617
                    cudagraph_runtime_mode.name,
                ),
            )
4618

4619
        # We skip EPLB here since we don't want to record dummy metrics
4620
        for num_tokens, activate_lora in compilation_cases:
4621
            # We currently only capture ubatched graphs when its a FULL
4622
4623
4624
            # 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
4625
4626
4627
4628
            allow_microbatching = (
                self.parallel_config.enable_dbo
                and cudagraph_runtime_mode == CUDAGraphMode.FULL
                and uniform_decode
4629
4630
4631
4632
4633
                and check_ubatch_thresholds(
                    config=self.vllm_config.parallel_config,
                    num_tokens=num_tokens,
                    uniform_decode=uniform_decode,
                )
4634
            )
4635

4636
4637
4638
4639
4640
4641
            for _ in range(self.compilation_config.cudagraph_num_of_warmups):
                # Use CUDAGraphRuntimeStyle.NONE (default) for warmup.
                # But be careful, warm up with `NONE`is orthogonal to
                # if we want to warm up attention or not. This is
                # different from the case where `FULL` implies capture
                # attention while `PIECEWISE` implies no attention.
4642
4643
4644
4645
4646
4647
4648
4649
4650
                force_attention = cudagraph_runtime_mode == CUDAGraphMode.FULL
                self._dummy_run(
                    num_tokens,
                    cudagraph_runtime_mode=CUDAGraphMode.NONE,
                    force_attention=force_attention,
                    uniform_decode=uniform_decode,
                    allow_microbatching=allow_microbatching,
                    skip_eplb=True,
                    remove_lora=False,
4651
                    activate_lora=activate_lora,
4652
4653
4654
4655
4656
4657
4658
4659
                )
            self._dummy_run(
                num_tokens,
                cudagraph_runtime_mode=cudagraph_runtime_mode,
                uniform_decode=uniform_decode,
                allow_microbatching=allow_microbatching,
                skip_eplb=True,
                remove_lora=False,
4660
                activate_lora=activate_lora,
Rémi Delacourt's avatar
Rémi Delacourt committed
4661
                is_graph_capturing=True,
4662
            )
4663
        self.maybe_remove_all_loras(self.lora_config)
4664

4665
4666
4667
4668
    def initialize_attn_backend(self, kv_cache_config: KVCacheConfig) -> None:
        """
        Initialize the attention backends and attention metadata builders.
        """
4669
        assert len(self.attn_groups) == 0, "Attention backends are already initialized"
4670

4671
4672
4673
4674
4675
4676
        class AttentionGroupKey(NamedTuple):
            attn_backend: type[AttentionBackend]
            kv_cache_spec: KVCacheSpec

        def get_attn_backends_for_group(
            kv_cache_group_spec: KVCacheGroupSpec,
4677
        ) -> tuple[dict[AttentionGroupKey, list[str]], set[type[AttentionBackend]]]:
4678
            layer_type = cast(type[Any], AttentionLayerBase)
4679
            layers = get_layers_from_vllm_config(
4680
                self.vllm_config, layer_type, kv_cache_group_spec.layer_names
4681
            )
4682
4683
            attn_backends = {}
            attn_backend_layers = defaultdict(list)
4684
            # Dedupe based on full class name; this is a bit safer than
4685
4686
4687
4688
            # 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.
4689
            for layer_name in kv_cache_group_spec.layer_names:
4690
                attn_backend = layers[layer_name].get_attn_backend()
4691
4692
4693
4694

                if layer_name in self.kv_sharing_fast_prefill_eligible_layers:
                    attn_backend = create_fast_prefill_custom_backend(
                        "FastPrefill",
4695
                        attn_backend,  # type: ignore[arg-type]
4696
4697
                    )

4698
4699
4700
                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):
4701
                    layer_kv_cache_spec = layer_kv_cache_spec.kv_cache_specs[layer_name]
4702
                key = (full_cls_name, layer_kv_cache_spec)
4703
4704
4705
                attn_backends[key] = AttentionGroupKey(
                    attn_backend, layer_kv_cache_spec
                )
4706
                attn_backend_layers[key].append(layer_name)
4707
4708
4709
4710
            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()),
            )
4711
4712

        def create_attn_groups(
4713
            attn_backends_map: dict[AttentionGroupKey, list[str]],
4714
            kv_cache_group_id: int,
4715
4716
        ) -> list[AttentionGroup]:
            attn_groups: list[AttentionGroup] = []
4717
            for (attn_backend, kv_cache_spec), layer_names in attn_backends_map.items():
4718
                attn_group = AttentionGroup(
4719
                    attn_backend,
4720
                    layer_names,
4721
                    kv_cache_spec,
4722
                    kv_cache_group_id,
4723
4724
                )

4725
4726
4727
                attn_groups.append(attn_group)
            return attn_groups

4728
        attention_backend_maps = []
4729
        attention_backend_list = []
4730
        for kv_cache_group_spec in kv_cache_config.kv_cache_groups:
4731
            attn_backends = get_attn_backends_for_group(kv_cache_group_spec)
4732
            attention_backend_maps.append(attn_backends[0])
4733
            attention_backend_list.append(attn_backends[1])
4734
4735

        # Resolve cudagraph_mode before actually initialize metadata_builders
4736
4737
4738
        self._check_and_update_cudagraph_mode(
            attention_backend_list, kv_cache_config.kv_cache_groups
        )
4739

4740
4741
4742
        # Check if attention backend supports PCP&DCP and related features.
        check_attention_cp_compatibility(self.vllm_config)

4743
4744
        for i, attn_backend_map in enumerate(attention_backend_maps):
            self.attn_groups.append(create_attn_groups(attn_backend_map, i))
4745

4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
    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
                    if not self.parallel_config.enable_dbo
                    else 2,
                )
co63oc's avatar
co63oc committed
4764
        # Calculate reorder batch threshold (if needed)
4765
4766
        # Note (tdoublep): do this *after* constructing builders,
        # because some of them change the threshold at init time.
4767
4768
        self.calculate_reorder_batch_threshold()

4769
    def _check_and_update_cudagraph_mode(
4770
4771
4772
        self,
        attention_backends: list[set[type[AttentionBackend]]],
        kv_cache_groups: list[KVCacheGroupSpec],
4773
    ) -> None:
4774
        """
4775
        Resolve the cudagraph_mode when there are multiple attention
4776
        groups with potential conflicting CUDA graph support.
4777
4778
4779
        Then initialize the cudagraph_dispatcher based on the resolved
        cudagraph_mode.
        """
4780
        min_cg_support = AttentionCGSupport.ALWAYS
4781
        min_cg_backend_name = None
4782

4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
        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
                    min_cg_backend_name = attn_backend.__name__
4795
4796
        # Flexible resolve the cudagraph mode
        cudagraph_mode = self.compilation_config.cudagraph_mode
4797
        assert cudagraph_mode is not None
4798
        # check cudagraph for mixed batch is supported
4799
4800
4801
4802
4803
4804
        if (
            cudagraph_mode.mixed_mode() == CUDAGraphMode.FULL
            and min_cg_support != AttentionCGSupport.ALWAYS
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4805
                f"with {min_cg_backend_name} backend (support: "
4806
4807
                f"{min_cg_support})"
            )
4808
4809
            if min_cg_support == AttentionCGSupport.NEVER:
                # if not supported any full cudagraphs, just raise it.
4810
4811
                msg += (
                    "; please try cudagraph_mode=PIECEWISE, and "
4812
                    "make sure compilation mode is VLLM_COMPILE"
4813
                )
4814
4815
4816
4817
4818
                raise ValueError(msg)

            # attempt to resolve the full cudagraph related mode
            if self.compilation_config.splitting_ops_contain_attention():
                msg += "; setting cudagraph_mode=FULL_AND_PIECEWISE"
4819
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4820
                    CUDAGraphMode.FULL_AND_PIECEWISE
4821
                )
4822
4823
            else:
                msg += "; setting cudagraph_mode=FULL_DECODE_ONLY"
4824
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4825
                    CUDAGraphMode.FULL_DECODE_ONLY
4826
                )
4827
4828
            logger.warning(msg)

4829
        # check that if we are doing decode full-cudagraphs it is supported
4830
4831
4832
4833
4834
4835
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4836
                f"with {min_cg_backend_name} backend (support: "
4837
4838
                f"{min_cg_support})"
            )
4839
            if self.compilation_config.mode == CompilationMode.VLLM_COMPILE and (
4840
4841
4842
4843
4844
                self.compilation_config.splitting_ops_contain_attention()
                or self.compilation_config.use_inductor_graph_partition
            ):
                msg += (
                    "; setting cudagraph_mode=PIECEWISE because "
4845
                    "attention is compiled piecewise"
4846
4847
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4848
                    CUDAGraphMode.PIECEWISE
4849
                )
4850
            else:
4851
4852
                msg += (
                    "; setting cudagraph_mode=NONE because "
4853
                    "attention is not compiled piecewise"
4854
4855
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4856
                    CUDAGraphMode.NONE
4857
                )
4858
4859
            logger.warning(msg)

4860
4861
        # check that if we are doing spec-decode + decode full-cudagraphs it is
        # supported
4862
4863
4864
4865
4866
4867
4868
4869
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and self.uniform_decode_query_len > 1
            and min_cg_support.value < AttentionCGSupport.UNIFORM_BATCH.value
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported"
                f" with spec-decode for attention backend "
4870
                f"{min_cg_backend_name} (support: {min_cg_support})"
4871
            )
4872
4873
            if self.compilation_config.splitting_ops_contain_attention():
                msg += "; setting cudagraph_mode=PIECEWISE"
4874
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4875
                    CUDAGraphMode.PIECEWISE
4876
                )
4877
4878
            else:
                msg += "; setting cudagraph_mode=NONE"
4879
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4880
                    CUDAGraphMode.NONE
4881
                )
4882
4883
4884
4885
            logger.warning(msg)

        # double check that we can support full cudagraph if they are requested
        # even after automatic downgrades
4886
4887
4888
4889
4890
4891
        if (
            cudagraph_mode.has_full_cudagraphs()
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            raise ValueError(
                f"CUDAGraphMode.{cudagraph_mode.name} is not "
4892
                f"supported with {min_cg_backend_name} backend ("
4893
4894
                f"support:{min_cg_support}) "
                "; please try cudagraph_mode=PIECEWISE, "
4895
                "and make sure compilation mode is VLLM_COMPILE"
4896
            )
4897

4898
4899
4900
4901
        # if we have dedicated decode cudagraphs, and spec-decode is enabled,
        # we need to adjust the cudagraph sizes to be a multiple of the uniform
        # decode query length to avoid: https://github.com/vllm-project/vllm/issues/28207
        # temp-fix: https://github.com/vllm-project/vllm/issues/28207#issuecomment-3504004536
4902
        # Will be removed in the near future when we have separate cudagraph capture
4903
4904
4905
4906
4907
4908
4909
4910
4911
        # sizes for decode and mixed prefill-decode.
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and cudagraph_mode.separate_routine()
            and self.uniform_decode_query_len > 1
        ):
            self.compilation_config.adjust_cudagraph_sizes_for_spec_decode(
                self.uniform_decode_query_len, self.parallel_config.tensor_parallel_size
            )
4912
4913
4914
4915
            capture_sizes = self.compilation_config.cudagraph_capture_sizes
            self.cudagraph_batch_sizes = (
                capture_sizes if capture_sizes is not None else []
            )
4916

4917
4918
        # Trigger cudagraph dispatching keys initialization after
        # resolved cudagraph mode.
4919
        self.compilation_config.cudagraph_mode = cudagraph_mode
4920
        self.cudagraph_dispatcher.initialize_cudagraph_keys(
4921
            cudagraph_mode, self.uniform_decode_query_len
4922
        )
4923

4924
4925
    def calculate_reorder_batch_threshold(self) -> None:
        """
4926
4927
4928
4929
        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.
4930
        """
4931
4932
        min_none_high = lambda a, b: a if b is None else b if a is None else min(a, b)

4933
        reorder_batch_thresholds: list[int | None] = [
4934
4935
4936
            group.get_metadata_builder().reorder_batch_threshold
            for group in self._attn_group_iterator()
        ]
4937
4938
4939
4940
4941
        # 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
4942
        self.reorder_batch_threshold = reduce(min_none_high, reorder_batch_thresholds)  # type: ignore[assignment]
4943

4944
4945
4946
    @staticmethod
    def select_common_block_size(
        kv_manager_block_size: int, attn_groups: list[AttentionGroup]
4947
4948
    ) -> int:
        """
4949
4950
4951
4952
4953
        Select a block size that is supported by all backends and is a factor of
        kv_manager_block_size.

        If kv_manager_block_size is supported by all backends, return it directly.
        Otherwise, return the max supported size.
4954
4955
4956
4957
4958
4959

        Args:
            kv_manager_block_size: Block size of KV cache
            attn_groups: List of attention groups

        Returns:
4960
            The selected block size
4961
4962

        Raises:
4963
            ValueError: If no valid block size found
4964
4965
        """

4966
4967
4968
4969
4970
4971
4972
4973
        def block_size_is_supported(
            backends: list[type[AttentionBackend]], block_size: int
        ) -> bool:
            """
            Check if the block size is supported by all backends.
            """
            for backend in backends:
                is_supported = False
4974
                for supported_size in backend.get_supported_kernel_block_sizes():
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
                    if isinstance(supported_size, int):
                        if block_size == supported_size:
                            is_supported = True
                    elif isinstance(supported_size, MultipleOf):
                        if block_size % supported_size.base == 0:
                            is_supported = True
                    else:
                        raise ValueError(f"Unknown supported size: {supported_size}")
                if not is_supported:
                    return False
            return True

        backends = [group.backend for group in attn_groups]

        # Case 1: if the block_size of kv cache manager is supported by all backends,
        # return it directly
        if block_size_is_supported(backends, kv_manager_block_size):
            return kv_manager_block_size

        # Case 2: otherwise, the block_size must be an `int`-format supported size of
        # at least one backend. Iterate over all `int`-format supported sizes in
        # descending order and return the first one that is supported by all backends.
        # Simple proof:
        # If the supported size b is in MultipleOf(x_i) format for all attention
        # backends i, and b a factor of kv_manager_block_size, then
        # kv_manager_block_size also satisfies MultipleOf(x_i) for all i. We will
        # return kv_manager_block_size in case 1.
        all_int_supported_sizes = set(
            supported_size
            for backend in backends
5005
            for supported_size in backend.get_supported_kernel_block_sizes()
5006
5007
            if isinstance(supported_size, int)
        )
5008

5009
5010
5011
5012
5013
5014
        for supported_size in sorted(all_int_supported_sizes, reverse=True):
            if kv_manager_block_size % supported_size != 0:
                continue
            if block_size_is_supported(backends, supported_size):
                return supported_size
        raise ValueError(f"No common block size for {kv_manager_block_size}. ")
5015

5016
5017
5018
    def may_reinitialize_input_batch(
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
    ) -> None:
5019
5020
5021
5022
5023
5024
5025
        """
        Re-initialize the input batch if the block sizes are different from
        `[self.cache_config.block_size]`. This usually happens when there
        are multiple KV cache groups.

        Args:
            kv_cache_config: The KV cache configuration.
5026
            kernel_block_sizes: The kernel block sizes for each KV cache group.
5027
5028
5029
5030
        """
        block_sizes = [
            kv_cache_group.kv_cache_spec.block_size
            for kv_cache_group in kv_cache_config.kv_cache_groups
5031
            if not isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec)
5032
        ]
5033
5034
5035
5036

        if block_sizes != [self.cache_config.block_size] or kernel_block_sizes != [
            self.cache_config.block_size
        ]:
5037
5038
5039
            assert self.cache_config.cpu_offload_gb == 0, (
                "Cannot re-initialize the input batch when CPU weight "
                "offloading is enabled. See https://github.com/vllm-project/vllm/pull/18298 "  # noqa: E501
5040
5041
                "for more details."
            )
5042
5043
            self.input_batch = InputBatch(
                max_num_reqs=self.max_num_reqs,
5044
                max_model_len=max(self.max_model_len, self.max_encoder_len),
5045
5046
5047
5048
5049
                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,
5050
                kernel_block_sizes=kernel_block_sizes,
5051
                is_spec_decode=bool(self.vllm_config.speculative_config),
5052
                logitsprocs=self.input_batch.logitsprocs,
5053
                logitsprocs_need_output_token_ids=self.input_batch.logitsprocs_need_output_token_ids,
5054
                is_pooling_model=self.is_pooling_model,
5055
                num_speculative_tokens=self.num_spec_tokens,
5056
5057
            )

5058
    def _allocate_kv_cache_tensors(
5059
5060
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
5061
        """
5062
5063
5064
        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.

5065
        Args:
5066
            kv_cache_config: The KV cache config
5067
        Returns:
5068
            dict[str, torch.Tensor]: A map between layer names to their
5069
            corresponding memory buffer for KV cache.
5070
        """
5071
5072
        kv_cache_raw_tensors: dict[str, torch.Tensor] = {}
        for kv_cache_tensor in kv_cache_config.kv_cache_tensors:
5073
5074
5075
            tensor = torch.zeros(
                kv_cache_tensor.size, dtype=torch.int8, device=self.device
            )
5076
5077
5078
5079
5080
            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:
5081
5082
5083
5084
            for layer_name in group.layer_names:
                if layer_name in self.runner_only_attn_layers:
                    continue
                layer_names.add(layer_name)
5085
5086
5087
        assert layer_names == set(kv_cache_raw_tensors.keys()), (
            "Some layers are not correctly initialized"
        )
5088
5089
        return kv_cache_raw_tensors

5090
5091
5092
    def _attn_group_iterator(self) -> Iterator[AttentionGroup]:
        return itertools.chain.from_iterable(self.attn_groups)

5093
    def _kv_cache_spec_attn_group_iterator(self) -> Iterator[AttentionGroup]:
5094
5095
        if not self.kv_cache_config.kv_cache_groups:
            return
5096
5097
        for attn_groups in self.attn_groups:
            yield from attn_groups
5098

5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
    def _prepare_kernel_block_sizes(self, kv_cache_config: KVCacheConfig) -> list[int]:
        """
        Generate kernel_block_sizes that matches each block_size.

        For attention backends that support virtual block splitting,
        use the supported block sizes from the backend.
        For other backends (like Mamba), use the same block size (no splitting).

        Args:
            kv_cache_config: The KV cache configuration.

        Returns:
            list[int]: List of kernel block sizes for each cache group.
        """
        kernel_block_sizes = []
5114
        for kv_cache_gid, kv_cache_group in enumerate(kv_cache_config.kv_cache_groups):
5115
5116
5117
5118
5119
5120
            kv_cache_spec = kv_cache_group.kv_cache_spec
            if isinstance(kv_cache_spec, UniformTypeKVCacheSpecs):
                # All layers in the UniformTypeKVCacheSpecs have the same type,
                # Pick an arbitrary one to dispatch.
                kv_cache_spec = next(iter(kv_cache_spec.kv_cache_specs.values()))
            if isinstance(kv_cache_spec, EncoderOnlyAttentionSpec):
5121
                continue
5122
            elif isinstance(kv_cache_spec, AttentionSpec):
5123
5124
5125
                # This is an attention backend that supports virtual
                # block splitting. Get the supported block sizes from
                # all backends in the group.
5126
                attn_groups = self.attn_groups[kv_cache_gid]
5127
                kv_manager_block_size = kv_cache_group.kv_cache_spec.block_size
5128
                selected_kernel_size = self.select_common_block_size(
5129
5130
5131
                    kv_manager_block_size, attn_groups
                )
                kernel_block_sizes.append(selected_kernel_size)
5132
            elif isinstance(kv_cache_spec, MambaSpec):
5133
5134
                # This is likely Mamba or other non-attention cache,
                # no splitting.
5135
                kernel_block_sizes.append(kv_cache_spec.block_size)
5136
5137
5138
5139
5140
5141
            else:
                raise NotImplementedError(
                    f"unknown kv cache spec {kv_cache_group.kv_cache_spec}"
                )
        return kernel_block_sizes

5142
5143
5144
5145
    def _reshape_kv_cache_tensors(
        self,
        kv_cache_config: KVCacheConfig,
        kv_cache_raw_tensors: dict[str, torch.Tensor],
5146
        kernel_block_sizes: list[int],
5147
    ) -> dict[str, torch.Tensor]:
5148
        """
5149
        Reshape the KV cache tensors to the desired shape and dtype.
5150

5151
        Args:
5152
5153
            kv_cache_config: The KV cache config
            kv_cache_raw_tensors: The KV cache buffer of each layer, with
5154
                correct size but uninitialized shape.
5155
            kernel_block_sizes: The kernel block sizes for each KV cache group.
5156
        Returns:
5157
            Dict[str, torch.Tensor]: A map between layer names to their
5158
5159
            corresponding memory buffer for KV cache.
        """
5160
        kv_caches: dict[str, torch.Tensor] = {}
5161
        has_attn, has_mamba = False, False
5162
5163
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
5164
            attn_backend = group.backend
5165
5166
5167
5168
            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]
5169
            for layer_name in group.layer_names:
5170
5171
                if layer_name in self.runner_only_attn_layers:
                    continue
5172
5173
                raw_tensor = kv_cache_raw_tensors[layer_name]
                assert raw_tensor.numel() % kv_cache_spec.page_size_bytes == 0
5174
                num_blocks = raw_tensor.numel() // kv_cache_spec.page_size_bytes
5175
                if isinstance(kv_cache_spec, AttentionSpec):
5176
                    has_attn = True
5177
5178
                    num_blocks_per_kv_block = (
                        kv_cache_spec.block_size // kernel_block_size
5179
5180
5181
                    )
                    kernel_num_blocks = num_blocks * num_blocks_per_kv_block

5182
                    kv_cache_shape = attn_backend.get_kv_cache_shape(
5183
                        kernel_num_blocks,
5184
                        kernel_block_size,
5185
5186
                        kv_cache_spec.num_kv_heads,
                        kv_cache_spec.head_size,
5187
5188
                        cache_dtype_str=self.cache_config.cache_dtype,
                    )
5189
                    dtype = kv_cache_spec.dtype
5190
                    try:
5191
                        kv_cache_stride_order = attn_backend.get_kv_cache_stride_order()
5192
                        assert len(kv_cache_stride_order) == len(kv_cache_shape)
5193
                    except (AttributeError, NotImplementedError):
5194
                        kv_cache_stride_order = tuple(range(len(kv_cache_shape)))
5195
5196
5197
5198
5199
                    # 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.
5200
5201
5202
                    kv_cache_shape = tuple(
                        kv_cache_shape[i] for i in kv_cache_stride_order
                    )
5203
5204
5205
5206
5207
                    # Maintain original KV shape view.
                    inv_order = [
                        kv_cache_stride_order.index(i)
                        for i in range(len(kv_cache_stride_order))
                    ]
5208
5209
5210
5211
5212
5213
                    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
5214
                elif isinstance(kv_cache_spec, MambaSpec):
5215
                    has_mamba = True
Chen Zhang's avatar
Chen Zhang committed
5216
5217
                    raw_tensor = kv_cache_raw_tensors[layer_name]
                    state_tensors = []
5218
                    storage_offset_bytes = 0
5219
                    for shape, dtype in zip(kv_cache_spec.shapes, kv_cache_spec.dtypes):
5220
5221
                        dtype_size = get_dtype_size(dtype)
                        num_element_per_page = (
5222
5223
                            kv_cache_spec.page_size_bytes // dtype_size
                        )
Chen Zhang's avatar
Chen Zhang committed
5224
                        target_shape = (num_blocks, *shape)
5225
5226
                        stride = torch.empty(target_shape).stride()
                        target_stride = (num_element_per_page, *stride[1:])
5227
                        assert storage_offset_bytes % dtype_size == 0
5228
5229
5230
5231
                        tensor = torch.as_strided(
                            raw_tensor.view(dtype),
                            size=target_shape,
                            stride=target_stride,
5232
                            storage_offset=storage_offset_bytes // dtype_size,
5233
                        )
Chen Zhang's avatar
Chen Zhang committed
5234
                        state_tensors.append(tensor)
5235
                        storage_offset_bytes += stride[0] * dtype_size
5236
5237

                    kv_caches[layer_name] = state_tensors
5238
                else:
5239
                    raise NotImplementedError
5240
5241

        if has_attn and has_mamba:
5242
            self._update_hybrid_attention_mamba_layout(kv_caches)
5243

5244
5245
        return kv_caches

5246
    def _update_hybrid_attention_mamba_layout(
5247
5248
        self, kv_caches: dict[str, torch.Tensor]
    ) -> None:
5249
        """
5250
5251
        Update the layout of attention layers from (2, num_blocks, ...) to
        (num_blocks, 2, ...).
5252
5253

        Args:
5254
            kv_caches: The KV cache buffer of each layer.
5255
5256
        """

5257
5258
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
5259
            for layer_name in group.layer_names:
5260
                kv_cache = kv_caches[layer_name]
5261
5262
5263
5264
                if isinstance(kv_cache_spec, AttentionSpec) and kv_cache.shape[0] == 2:
                    assert kv_cache.shape[1] != 2, (
                        "Fail to determine whether the layout is "
                        "(2, num_blocks, ...) or (num_blocks, 2, ...) for "
5265
                        f"a tensor of shape {kv_cache.shape}"
5266
                    )
5267
                    hidden_size = kv_cache.shape[2:].numel()
5268
5269
5270
5271
                    kv_cache.as_strided_(
                        size=kv_cache.shape,
                        stride=(hidden_size, 2 * hidden_size, *kv_cache.stride()[2:]),
                    )
5272

5273
    def initialize_kv_cache_tensors(
5274
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
5275
    ) -> dict[str, torch.Tensor]:
5276
5277
5278
5279
5280
        """
        Initialize the memory buffer for KV cache.

        Args:
            kv_cache_config: The KV cache config
5281
5282
            kernel_block_sizes: The kernel block sizes for each KV cache group.

5283
        Returns:
5284
            Dict[str, torch.Tensor]: A map between layer names to their
5285
5286
            corresponding memory buffer for KV cache.
        """
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310

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

5312
        # Set up cross-layer KV cache sharing
5313
5314
        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)
5315
5316
            kv_caches[layer_name] = kv_caches[target_layer_name]

5317
5318
5319
5320
5321
5322
5323
5324
5325
        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,
        )
5326
5327
5328
        return kv_caches

    def maybe_add_kv_sharing_layers_to_kv_cache_groups(
5329
5330
        self, kv_cache_config: KVCacheConfig
    ) -> None:
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
        """
        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.
5349
            attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
5350
5351
            for layer_name in reversed(attn_layers):
                if layer_name in self.shared_kv_cache_layers:
5352
                    self.kv_sharing_fast_prefill_eligible_layers.add(layer_name)
5353
5354
                else:
                    break
5355

5356
5357
5358
5359
5360
5361
5362
    def initialize_kv_cache(self, kv_cache_config: KVCacheConfig) -> None:
        """
        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
        """
5363
        kv_cache_config = deepcopy(kv_cache_config)
5364
        self.kv_cache_config = kv_cache_config
5365
        self.may_add_encoder_only_layers_to_kv_cache_config()
5366
        self.maybe_add_kv_sharing_layers_to_kv_cache_groups(kv_cache_config)
5367
        self.initialize_attn_backend(kv_cache_config)
5368
5369
5370
5371
5372
5373
        # 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.
        kernel_block_sizes = self._prepare_kernel_block_sizes(kv_cache_config)
5374
5375
5376
5377

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

5378
        # Reinitialize need to after initialize_attn_backend
5379
5380
5381
5382
        self.may_reinitialize_input_batch(kv_cache_config, kernel_block_sizes)
        kv_caches = self.initialize_kv_cache_tensors(
            kv_cache_config, kernel_block_sizes
        )
5383

5384
5385
5386
5387
5388
5389
        if self.speculative_config and self.speculative_config.use_eagle():
            assert isinstance(self.drafter, EagleProposer)
            # validate all draft model layers belong to the same kv cache
            # group
            self.drafter.validate_same_kv_cache_group(kv_cache_config)

Robert Shaw's avatar
Robert Shaw committed
5390
        if has_kv_transfer_group():
5391
            kv_transfer_group = get_kv_transfer_group()
5392
5393
5394
5395
5396
5397
5398
            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)
5399
            kv_transfer_group.set_host_xfer_buffer_ops(copy_kv_blocks)
Robert Shaw's avatar
Robert Shaw committed
5400

5401
5402
5403
5404
5405
    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
5406
        encoder_only_attn_specs: dict[AttentionSpec, list[str]] = defaultdict(list)
5407
5408
5409
        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:
5410
                attn_spec: AttentionSpec = EncoderOnlyAttentionSpec(
5411
5412
5413
                    block_size=block_size,
                    num_kv_heads=attn_module.num_kv_heads,
                    head_size=attn_module.head_size,
5414
5415
                    dtype=self.kv_cache_dtype,
                )
5416
5417
5418
                encoder_only_attn_specs[attn_spec].append(layer_name)
                self.runner_only_attn_layers.add(layer_name)
        if len(encoder_only_attn_specs) > 0:
5419
5420
5421
            assert len(encoder_only_attn_specs) == 1, (
                "Only support one encoder-only attention spec now"
            )
5422
5423
            spec, layer_names = encoder_only_attn_specs.popitem()
            self.kv_cache_config.kv_cache_groups.append(
5424
5425
                KVCacheGroupSpec(layer_names=layer_names, kv_cache_spec=spec)
            )
5426

5427
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
5428
        """
5429
        Generates the KVCacheSpec by parsing the kv cache format from each
5430
5431
        Attention module in the static forward context.
        Returns:
5432
            KVCacheSpec: A dictionary mapping layer names to their KV cache
5433
5434
            format. Layers that do not need KV cache are not included.
        """
5435
5436
        if has_ec_transfer() and get_ec_transfer().is_producer:
            return {}
5437
        kv_cache_spec: dict[str, KVCacheSpec] = {}
5438
5439
        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
5440
        for layer_name, attn_module in attn_layers.items():
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
            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
5456

5457
        return kv_cache_spec
5458

5459
    def _to_list(self, sampled_token_ids: torch.Tensor) -> list[list[int]]:
5460
5461
5462
5463
5464
5465
5466
5467
        # 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.
5468
        pinned = self.sampled_token_ids_pinned_cpu[: sampled_token_ids.shape[0]]
5469
5470
5471
        pinned.copy_(sampled_token_ids, non_blocking=True)
        self.transfer_event.record()
        self.transfer_event.synchronize()
5472
        return pinned.tolist()